Project::OSiRiON - Git repositories
Project::OSiRiON
News . About . Screenshots . Downloads . Forum . Wiki . Tracker . Git
summaryrefslogtreecommitdiff
blob: 52ab9d89f28aeadde5e9074b59fd185d08d6728d (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
/*
   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_LAYER_H__
#define __INCLUDED_MODEL_LAYER_H__

#include "math/color.h"

namespace model
{

/**
 * @brief a single layer within a material
 * */
class Layer {
public:
	/**
	 * @brief color generation type definition
	 * */
	enum RGBGen { 
		RGBGenIdentity = 1, 		// unmodified
		RGBGenColor = 2, 		// modified by layer color
		RGBGenEngine = 3, 		// modified by engine color
		RGBGenPrimary = 4, 		// modified by primary entity color
		RGBGenSecondary = 5, 		// modified by secondary entity color
		RGBGenTertiary = 6 		// modified by tertiary entity color
	};
	
	/**
	 * @brief texture coordinate generation type definition
	 * */
	enum TCGen {
		TCGenNone = 0, 			// no texture coordinate generation
		TCGenTexCoords = 1, 		// use texture coordinates from vertex array
		TCGenEnvironment = 2 		// texture coordinates generated by GL_SPHERE_MAP/GL_REFLECTION_MAP
	};
	
	/**
	 * @brief texture map type definition
	 * */
	enum TexMap {
		TexMapNone = 0,			// no texture map
		TexMapImage = 1,		// texture map from image
		TexMapEnvironment = 2,		// texture map with skybox
		TexMapLogo = 3			// use current logo texture
	};

	/**
	 * @brief default constructor
	 * */
	Layer();
	
	/**
	 * @brief default destructor
	 * */
	~Layer();
	
	/* ---- inspectors ----------------------------------------- */

	/**
	 * @brief rgb color generation source for this material layer
	 * */
	inline const RGBGen rgbgen() const
	{
		return layer_rgbgen;
	}
	
	/**
	 * @brief layer color
	 * The layer color is used if color source if rgbgen() is set to RGBGenColor
	 * */
	inline const math::Color & color() const
	{
		return layer_color;
	}

	/**
	 * @brief layer texture map
	 */
	const TexMap texmap() const
	{
		return layer_texmap;
	}
	
	/**
	 * @brief layer texture map name
	 * The layer texture mapa name is used if texmap() is set to TexMapTexture
	 * */
	inline const std::string &texture_name() const
	{
		return layer_texture_name;
	}

	/**
	 * @brief layer texture map renderer id
	 * */
	inline const size_t texture_id() const
	{
		return layer_texture_id;
	}

	/**
	 * @brief texture coordinates generation source for this material layer
	 * */
	inline const TCGen tcgen() const
	{
		return layer_tcgen;
	}
		
	/* ---- mutators ------------------------------------------- */
	
	/**
	 * @brief set rgb color generation source
	 * */
	void set_rgbgen(const RGBGen rgbgen);
	
	/**
	 * @brief set layer color
	 * */
	void set_color(const math::Color & color);
	
	/**
	 * @brief set texture coordinates generation source
	 * */
	void set_tcgen(const TCGen tcgen);

private:
	RGBGen		layer_rgbgen;
	math::Color	layer_color;
	
	TexMap		layer_texmap;
	std::string	layer_texture_name;
	size_t		layer_texture_id;
		
	TCGen		layer_tcgen;
};
	
} // namespace model

#endif // __INCLUDED_MODEL_LAYER_H__