1 // mat.hxx -- a material in the scene graph.
2 // TODO: this class needs to be renamed.
4 // Written by Curtis Olson, started May 1998.
5 // Overhauled by David Megginson, December 2001
7 // Copyright (C) 1998 - 2000 Curtis L. Olson - http://www.flightgear.org/~curt
9 // This program is free software; you can redistribute it and/or
10 // modify it under the terms of the GNU General Public License as
11 // published by the Free Software Foundation; either version 2 of the
12 // License, or (at your option) any later version.
14 // This program is distributed in the hope that it will be useful, but
15 // WITHOUT ANY WARRANTY; without even the implied warranty of
16 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 // General Public License for more details.
19 // You should have received a copy of the GNU General Public License
20 // along with this program; if not, write to the Free Software
21 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
30 # error This library requires C++
33 #include <simgear/compiler.h>
35 #include <string> // Standard C++ string library
39 #include <simgear/math/SGMath.hxx>
41 #include <osg/ref_ptr>
48 #include <simgear/scene/model/SGReaderWriterXMLOptions.hxx>
49 #include <simgear/props/props.hxx>
50 #include <simgear/structure/SGSharedPtr.hxx>
51 #include <simgear/scene/util/SGSceneFeatures.hxx>
53 #include "matmodel.hxx"
58 void reload_shaders();
61 class SGMaterialGlyph;
64 * A material in the scene graph.
66 * A material represents information about a single surface type
67 * in the 3D scene graph, including texture, colour, lighting,
68 * tiling, and so on; most of the materials in FlightGear are
69 * defined in the $FG_ROOT/materials.xml file, and can be changed
72 class SGMaterial : public SGReferenced {
77 ////////////////////////////////////////////////////////////////////
78 // Public Constructors.
79 ////////////////////////////////////////////////////////////////////
82 * Construct a material from a set of properties.
84 * @param props A property node containing subnodes with the
85 * state information for the material. This node is usually
86 * loaded from the $FG_ROOT/materials.xml file.
88 SGMaterial( const osgDB::ReaderWriter::Options*, const SGPropertyNode *props);
90 SGMaterial(const simgear::SGReaderWriterXMLOptions*,
91 const SGPropertyNode *props);
99 ////////////////////////////////////////////////////////////////////
101 ////////////////////////////////////////////////////////////////////
104 * Get the textured state.
106 simgear::Effect *get_effect(int n = -1);
109 * Get the number of textures assigned to this material.
111 inline int get_num() const { return _status.size(); }
115 * Get the xsize of the texture, in meters.
117 inline double get_xsize() const { return xsize; }
121 * Get the ysize of the texture, in meters.
123 inline double get_ysize() const { return ysize; }
127 * Get the light coverage.
129 * A smaller number means more generated night lighting.
131 * @return The area (m^2) covered by each light.
133 inline double get_light_coverage () const { return light_coverage; }
136 * Get the wood coverage.
138 * A smaller number means more generated woods within the forest.
140 * @return The area (m^2) covered by each wood.
142 inline double get_wood_coverage () const { return wood_coverage; }
145 * Get the density of the wood
147 * @return The area (m^2) covered by each tree in the wood.
149 inline double get_tree_density () const { return tree_density; }
152 * Get the size of each wood
154 * @return the average area (m^2) of each wood
156 inline double get_wood_size () const { return wood_size; }
159 * Get the tree height.
161 * @return The average height of the trees.
163 inline double get_tree_height () const { return tree_height; }
166 * Get the tree width.
168 * @return The average width of the trees.
170 inline double get_tree_width () const { return tree_width; }
173 * Get the forest LoD range.
175 * @return The LoD range for the trees.
177 inline double get_tree_range () const { return tree_range; }
180 * Get the number of tree varieties available
182 * @return the number of different trees defined in the texture strip
184 inline int get_tree_varieties () const { return tree_varieties; }
187 * Get the texture strip to use for trees
189 * @return the texture to use for trees.
191 inline std::string get_tree_texture () const { return tree_texture; }
194 * Return if the surface material is solid, if it is not solid, a fluid
195 * can be assumed, that is usually water.
197 bool get_solid () const { return solid; }
200 * Get the friction factor for that material
202 double get_friction_factor () const { return friction_factor; }
205 * Get the rolling friction for that material
207 double get_rolling_friction () const { return rolling_friction; }
210 * Get the bumpines for that material
212 double get_bumpiness () const { return bumpiness; }
215 * Get the load resistance
217 double get_load_resistance () const { return load_resistance; }
220 * Get the list of names for this material
222 const std::vector<std::string>& get_names() const { return _names; }
225 * add the given name to the list of names this material is known
227 void add_name(const std::string& name) { _names.push_back(name); }
230 * Get the number of randomly-placed objects defined for this material.
232 int get_object_group_count () const { return object_groups.size(); }
235 * Get a randomly-placed object for this material.
237 SGMatModelGroup * get_object_group (int index) const {
238 return object_groups[index];
242 * Return pointer to glyph class, or 0 if it doesn't exist.
244 SGMaterialGlyph * get_glyph (const std::string& name) const;
246 void set_light_color(const SGVec4f& color)
247 { emission = color; }
248 const SGVec4f& get_light_color() const
251 SGVec2f get_tex_coord_scale() const
253 float tex_width = get_xsize();
254 float tex_height = get_ysize();
256 return SGVec2f((0 < tex_width) ? 1000.0f/tex_width : 1.0f,
257 (0 < tex_height) ? 1000.0f/tex_height : 1.0f);
263 ////////////////////////////////////////////////////////////////////
264 // Protected methods.
265 ////////////////////////////////////////////////////////////////////
268 * Initialization method, invoked by all public constructors.
274 struct _internal_state {
275 _internal_state(simgear::Effect *e, bool l,
276 const simgear::SGReaderWriterXMLOptions *o);
277 _internal_state(simgear::Effect *e, const std::string &t, bool l,
278 const simgear::SGReaderWriterXMLOptions *o);
279 void add_texture(const std::string &t, int i);
280 osg::ref_ptr<simgear::Effect> effect;
281 std::vector<std::pair<std::string,int> > texture_paths;
282 bool effect_realized;
283 osg::ref_ptr<const simgear::SGReaderWriterXMLOptions> options;
289 ////////////////////////////////////////////////////////////////////
291 ////////////////////////////////////////////////////////////////////
294 std::vector<_internal_state> _status;
296 // Round-robin counter
297 mutable unsigned int _current_ptr;
308 // coverage of night lighting.
309 double light_coverage;
312 double wood_coverage;
314 // The size of each wood
317 // Tree density within the wood
320 // Range at which trees become visible
323 // Height of the tree
329 // Number of varieties of tree texture
332 // True if the material is solid, false if it is a fluid
335 // the friction factor of that surface material
336 double friction_factor;
338 // the rolling friction of that surface material
339 double rolling_friction;
341 // the bumpiness of that surface material
344 // the load resistance of that surface material
345 double load_resistance;
347 // material properties
348 SGVec4f ambient, diffuse, specular, emission;
351 // effect for this material
354 // the list of names for this material. May be empty.
355 std::vector<std::string> _names;
357 std::vector<SGSharedPtr<SGMatModelGroup> > object_groups;
359 // taxiway-/runway-sign texture elements
360 std::map<std::string, SGSharedPtr<SGMaterialGlyph> > glyphs;
362 // Tree texture, typically a strip of applicable tree textures
363 std::string tree_texture;
365 ////////////////////////////////////////////////////////////////////
366 // Internal constructors and methods.
367 ////////////////////////////////////////////////////////////////////
369 void read_properties(const simgear::SGReaderWriterXMLOptions* options,
370 const SGPropertyNode *props);
371 void buildEffectProperties(const simgear::SGReaderWriterXMLOptions* options);
375 class SGMaterialGlyph : public SGReferenced {
377 SGMaterialGlyph(SGPropertyNode *);
378 inline double get_left() const { return _left; }
379 inline double get_right() const { return _right; }
380 inline double get_width() const { return _right - _left; }
387 class SGMaterialUserData : public osg::Referenced {
389 SGMaterialUserData(const SGMaterial* material) :
392 const SGMaterial* getMaterial() const
393 { return mMaterial; }
395 // this cannot be an SGSharedPtr since that would create a cicrular reference
396 // making it impossible to ever free the space needed by SGMaterial
397 const SGMaterial* mMaterial;
401 SGSetTextureFilter( int max);
404 SGGetTextureFilter();
406 #endif // _SG_MAT_HXX