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>
53 #include <simgear/props/props.hxx>
54 #include <simgear/structure/SGSharedPtr.hxx>
55 #include <simgear/scene/util/SGSceneFeatures.hxx>
57 #include "matmodel.hxx"
64 class SGMaterialGlyph;
67 * A material in the scene graph.
69 * A material represents information about a single surface type
70 * in the 3D scene graph, including texture, colour, lighting,
71 * tiling, and so on; most of the materials in FlightGear are
72 * defined in the $FG_ROOT/materials.xml file, and can be changed
75 class SGMaterial : public SGReferenced {
80 ////////////////////////////////////////////////////////////////////
81 // Public Constructors.
82 ////////////////////////////////////////////////////////////////////
85 * Construct a material from a set of properties.
87 * @param props A property node containing subnodes with the
88 * state information for the material. This node is usually
89 * loaded from the $FG_ROOT/materials.xml file.
91 SGMaterial( const osgDB::Options*, const SGPropertyNode *props);
100 ////////////////////////////////////////////////////////////////////
102 ////////////////////////////////////////////////////////////////////
105 * Get the textured state.
107 simgear::Effect *get_effect(int n = -1);
110 * Get the number of textures assigned to this material.
112 inline int get_num() const { return _status.size(); }
116 * Get the xsize of the texture, in meters.
118 inline double get_xsize() const { return xsize; }
122 * Get the ysize of the texture, in meters.
124 inline double get_ysize() const { return ysize; }
128 * Get the light coverage.
130 * A smaller number means more generated night lighting.
132 * @return The area (m^2) covered by each light.
134 inline double get_light_coverage () const { return light_coverage; }
137 * Get the forest coverage.
139 * A smaller number means more generated forest canopy.
141 * @return The area (m^2) covered by each canopy.
143 inline double get_tree_coverage () const { return tree_coverage; }
146 * Get the forest height.
148 * @return The average height of the trees.
150 inline double get_tree_height () const { return tree_height; }
153 * Get the forest width.
155 * @return The average width of the trees.
157 inline double get_tree_width () const { return tree_width; }
160 * Get the forest LoD range.
162 * @return The LoD range for the trees.
164 inline double get_tree_range () const { return tree_range; }
167 * Get the number of tree varieties available
169 * @return the number of different trees defined in the texture strip
171 inline int get_tree_varieties () const { return tree_varieties; }
174 * Get the texture strip to use for trees
176 * @return the texture to use for trees.
178 inline std::string get_tree_texture () const { return tree_texture; }
181 * Return if the surface material is solid, if it is not solid, a fluid
182 * can be assumed, that is usually water.
184 bool get_solid () const { return solid; }
187 * Get the friction factor for that material
189 double get_friction_factor () const { return friction_factor; }
192 * Get the rolling friction for that material
194 double get_rolling_friction () const { return rolling_friction; }
197 * Get the bumpines for that material
199 double get_bumpiness () const { return bumpiness; }
202 * Get the load resistance
204 double get_load_resistance () const { return load_resistance; }
207 * Get the list of names for this material
209 const std::vector<std::string>& get_names() const { return _names; }
212 * add the given name to the list of names this material is known
214 void add_name(const std::string& name) { _names.push_back(name); }
217 * Get the number of randomly-placed objects defined for this material.
219 int get_object_group_count () const { return object_groups.size(); }
222 * Get a randomly-placed object for this material.
224 SGMatModelGroup * get_object_group (int index) const {
225 return object_groups[index];
229 * Return pointer to glyph class, or 0 if it doesn't exist.
231 SGMaterialGlyph * get_glyph (const std::string& name) const;
233 void set_light_color(const SGVec4f& color)
234 { emission = color; }
235 const SGVec4f& get_light_color() const
238 SGVec2f get_tex_coord_scale() const
240 float tex_width = get_xsize();
241 float tex_height = get_ysize();
243 return SGVec2f((0 < tex_width) ? 1000.0f/tex_width : 1.0f,
244 (0 < tex_height) ? 1000.0f/tex_height : 1.0f);
250 ////////////////////////////////////////////////////////////////////
251 // Protected methods.
252 ////////////////////////////////////////////////////////////////////
255 * Initialization method, invoked by all public constructors.
261 struct _internal_state {
262 _internal_state(simgear::Effect *e, const std::string &t, bool l,
263 const osgDB::Options *o);
264 osg::ref_ptr<simgear::Effect> effect;
265 std::string texture_path;
266 bool effect_realized;
267 osg::ref_ptr<const osgDB::Options> options;
273 ////////////////////////////////////////////////////////////////////
275 ////////////////////////////////////////////////////////////////////
278 std::vector<_internal_state> _status;
280 // Round-robin counter
281 mutable unsigned int _current_ptr;
292 // coverage of night lighting.
293 double light_coverage;
296 double tree_coverage;
298 // Range at which trees become visible
301 // Height of the tree
307 // Number of varieties of tree texture
310 // True if the material is solid, false if it is a fluid
313 // the friction factor of that surface material
314 double friction_factor;
316 // the rolling friction of that surface material
317 double rolling_friction;
319 // the bumpiness of that surface material
322 // the load resistance of that surface material
323 double load_resistance;
325 // material properties
326 SGVec4f ambient, diffuse, specular, emission;
329 // effect for this material
332 // the list of names for this material. May be empty.
333 std::vector<std::string> _names;
335 std::vector<SGSharedPtr<SGMatModelGroup> > object_groups;
337 // taxiway-/runway-sign texture elements
338 std::map<std::string, SGSharedPtr<SGMaterialGlyph> > glyphs;
340 // Tree texture, typically a strip of applicable tree textures
341 std::string tree_texture;
343 ////////////////////////////////////////////////////////////////////
344 // Internal constructors and methods.
345 ////////////////////////////////////////////////////////////////////
347 void read_properties(const osgDB::Options* options,
348 const SGPropertyNode *props);
349 void buildEffectProperties(const osgDB::Options* options);
353 class SGMaterialGlyph : public SGReferenced {
355 SGMaterialGlyph(SGPropertyNode *);
356 inline double get_left() const { return _left; }
357 inline double get_right() const { return _right; }
358 inline double get_width() const { return _right - _left; }
365 class SGMaterialUserData : public osg::Referenced {
367 SGMaterialUserData(const SGMaterial* material) :
370 const SGMaterial* getMaterial() const
371 { return mMaterial; }
373 // this cannot be an SGSharedPtr since that would create a cicrular reference
374 // making it impossible to ever free the space needed by SGMaterial
375 const SGMaterial* mMaterial;
379 SGSetTextureFilter( int max);
382 SGGetTextureFilter();
384 #endif // _SG_MAT_HXX