Project::OSiRiON - Git repositories
Project::OSiRiON
News . About . Screenshots . Downloads . Forum . Wiki . Tracker . Git
summaryrefslogtreecommitdiff
blob: 94b44181134b936342c4423c3c2f049073ed4aec (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
/*
   model/material.h
   This file is part of the Osirion project and is distributed under
   the terms of the GNU General Public License version 2
*/

#ifndef __INCLUDED_MODEL_MATERIAL_H__
#define __INCLUDED_MODEL_MATERIAL_H__

#include <string>
#include <map>

#include "math/color.h"
#include "math/vector2f.h"

namespace model
{

/// fragment surface material parameters
class Material
{
public:
	/// function pointer type for local functions
	typedef void(* LoaderFuncPtr)(Material *);

	/// color types
	enum ColorType {ColorMaterial = 0, ColorPrimary = 1, ColorSecondary = 2, ColorTertiary = 3, ColorEngine = 4 };
	
	/// surface flags
	enum SurfaceFlags { FlagNone = 0, FlagBright = 1,FlagEnvironment = 2, FlagTexture = 4, FlagIgnore = 8, FlagClip = 16, FlagOrigin = 32, FlagDecal = 64, FlagBounds = 128 };

	/// type definition for the material registry
	typedef std::map<std::string, Material *> Registry;

	Material(const std::string &name);

	~Material();
	
	void print();

	/* ---- inspectors ----------------------------------------- */

	inline const std::string &name() const {
		return material_name;
	}

	inline const math::Color &color() const {
		return material_color;
	}

	inline const math::Color &specular() const {
		return material_specular;
	}

	inline const unsigned int flags() const {
		return material_flags;
	}
	
	inline const ColorType colortype() const {
		return material_colortype;
	}

	inline const std::string &texture() const {
		return material_texture;
	}

	inline const size_t texture_id() const {
		return material_texture_id;
	}

	/**
	 * @brief returns the material texture size
	 */
	inline const math::Vector2f & size() const {
		return material_size;
	}

	/**
	 * @brief returns true if the material has the requested flag set
	 * */
	inline bool has_flag(const SurfaceFlags surfaceflag) const {
		return (((int) material_flags & surfaceflag) == surfaceflag);
	}
	
	/**
	 * @brief returns true if the material has the Texture flag set
	 * @see flags()
	 * */
	inline bool has_flag_texture() const {
		return (has_flag(FlagTexture));
	}
	
	/**
	 * @brief returns true if the material has the Clip flag set
	 * @see flags()
	 * */
	inline bool has_flag_clip() const {
		return (has_flag(FlagClip));
	}
	
	/**
	 * @brief returns true if the material has the Ignore flag set
	 * @see flags()
	 * */
	inline bool has_flag_ignore() const {
		return (has_flag(FlagIgnore));
	}
	
	/**
	 * @brief returns true if the material has the Origin flag set
	 * @see flags()
	 * */
	inline bool has_flag_origin() const {
		return (has_flag(FlagOrigin));
	}
	
	/**
	 * @brief returns true if the material has the Origin flag set
	 * @see flags()
	 * */
	inline bool has_flag_bounds() const {
		return (has_flag(FlagBounds));
	}
		
	/* ---- mutators ------------------------------------------- */

	void set_color(const math::Color &color);
	
	void set_specular(const math::Color &specular);
	
	/**
	 * @brief set the material texture name
	 */
	void set_texture(const std::string &texture);

	/**
	 * @brief set the material texture id
	 */
	void set_texture_id(const size_t texture_id);

	/**
	 * @brief set the material texture size
	 */
	void set_size(const float width, const float height);

	/**
	 * @brief set the material texture size
	 */
	void set_size(const math::Vector2f &size);
	
	/**
	 * @brief set the color type
	 * */
	void set_colortype(ColorType colortype);
	

	/**
	 * @brief set a specified surface flag
	 * @see flags()
	 * */
	inline void set_flags(SurfaceFlags flags) {
		material_flags |= flags;
	}

	/**
	 * @brief clear a specified surface flag
	 * @see flags()
	 * */
	inline void unset_flags(SurfaceFlags flags) {
		material_flags &= ~flags;
	}

	/* ---- static ----------------------------------------------------- */

	/**
	 * @brief initialize material registry
	 * reads materials from the shader files listed in shaderlist.txt
	 */
	static void init();

	/**
	 * @brief shutdown material registry
	 */
	static void shutdown();

	/**
	 * @brief clear material registry
	 */
	static void clear();

	/**
	 * @brief print registered materials to the system console
	 */
	static void list();

	/**
	 * @brief add a material to the registry
	 */
	static void add(Material *material);

	/**
	 * @brief find a material in the registry
	 */
	static Material *find(const std::string &name);

	static void set_loader_func(LoaderFuncPtr func);

private:

	std::string		material_name;
	math::Color		material_color;
	math::Color		material_specular;
	unsigned int		material_flags;
	ColorType		material_colortype;
	std::string		material_texture;
	size_t			material_texture_id;

	/// size of the material
	math::Vector2f		material_size;

	/// the materials registry
	static Registry		material_registry;

	static void load_shader(const std::string &shadername);

	static LoaderFuncPtr	material_loaderfunc;
};

}

#endif // __INCLUDED_MODEL_MATERIAL_H__