simgear/scene/material/mat.hxx

   1 // mat.hxx -- a material in the scene graph.
   2 // TODO: this class needs to be renamed.
   3 //
   4 // Written by Curtis Olson, started May 1998.
   5 // Overhauled by David Megginson, December 2001
   6 //
   7 // Copyright (C) 1998 - 2000  Curtis L. Olson  - http://www.flightgear.org/~curt
   8 //
   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.
  13 //
  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.
  18 //
  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.
  22 //
  23 // $Id$
  24
  25
  26 #ifndef _SG_MAT_HXX
  27 #define _SG_MAT_HXX
  28
  29 #ifndef __cplusplus
  30 # error This library requires C++
  31 #endif
  32
  33 #include <simgear/compiler.h>
  34
  35 #include <string>      // Standard C++ string library
  36 #include <vector>
  37 #include <map>
  38
  39 #include <simgear/math/SGMath.hxx>
  40
  41 #include <osg/ref_ptr>
  42 #include <osgDB/ReaderWriter>
  43
  44 namespace osg
  45 {
  46 class StateSet;
  47 }
  48
  49 #include <simgear/props/props.hxx>
  50 #include <simgear/structure/SGSharedPtr.hxx>
  51 #include <simgear/scene/util/SGSceneFeatures.hxx>
  52
  53 #include "matmodel.hxx"
  54
  55 namespace simgear
  56 {
  57 class Effect;
  58 void reload_shaders();
  59 }
  60
  61 class SGMaterialGlyph;
  62
  63 /**
  64  * A material in the scene graph.
  65  *
  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
  70  * at runtime.
  71  */
  72 class SGMaterial : public SGReferenced {
  73
  74 public:
  75
  76 \f
  77   ////////////////////////////////////////////////////////////////////
  78   // Public Constructors.
  79   ////////////////////////////////////////////////////////////////////
  80
  81   /**
  82    * Construct a material from a set of properties.
  83    *
  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.
  87    */
  88   SGMaterial( const osgDB::ReaderWriter::Options*, const SGPropertyNode *props);
  89
  90   /**
  91    * Destructor.
  92    */
  93   ~SGMaterial( void );
  94
  95
  96 \f
  97   ////////////////////////////////////////////////////////////////////
  98   // Public methods.
  99   ////////////////////////////////////////////////////////////////////
 100
 101   /**
 102    * Get the textured state.
 103    */
 104   simgear::Effect *get_effect(int n = -1);
 105
 106   /**
 107    * Get the number of textures assigned to this material.
 108    */
 109   inline int get_num() const { return _status.size(); }
 110
 111
 112   /**
 113    * Get the xsize of the texture, in meters.
 114    */
 115   inline double get_xsize() const { return xsize; }
 116
 117
 118   /**
 119    * Get the ysize of the texture, in meters.
 120    */
 121   inline double get_ysize() const { return ysize; }
 122
 123
 124   /**
 125    * Get the light coverage.
 126    *
 127    * A smaller number means more generated night lighting.
 128    *
 129    * @return The area (m^2) covered by each light.
 130    */
 131   inline double get_light_coverage () const { return light_coverage; }
 132
 133   /**
 134    * Get the wood coverage.
 135    *
 136    * A smaller number means more generated woods within the forest.
 137    *
 138    * @return The area (m^2) covered by each wood.
 139    */
 140   inline double get_wood_coverage () const { return wood_coverage; }
 141
 142   /**
 143    * Get the density of the wood
 144    *
 145    * @return The area (m^2) covered by each tree in the wood.
 146    */
 147   inline double get_tree_density () const { return tree_density; }
 148
 149   /**
 150    * Get the size of each wood
 151    *
 152    * @return the average area (m^2) of each wood
 153    */
 154   inline double get_wood_size () const { return wood_size; }
 155
 156   /**
 157    * Get the tree height.
 158    *
 159    * @return The average height of the trees.
 160    */
 161   inline double get_tree_height () const { return tree_height; }
 162
 163   /**
 164    * Get the tree width.
 165    *
 166    * @return The average width of the trees.
 167    */
 168   inline double get_tree_width () const { return tree_width; }
 169
 170   /**
 171    * Get the forest LoD range.
 172    *
 173    * @return The LoD range for the trees.
 174    */
 175   inline double get_tree_range () const { return tree_range; }
 176
 177   /**
 178    * Get the number of tree varieties available
 179    *
 180    * @return the number of different trees defined in the texture strip
 181    */
 182   inline int get_tree_varieties () const { return tree_varieties; }
 183
 184   /**
 185    * Get the texture strip to use for trees
 186    *
 187    * @return the texture to use for trees.
 188    */
 189   inline std::string get_tree_texture () const { return  tree_texture; }
 190
 191   /**
 192    * Return if the surface material is solid, if it is not solid, a fluid
 193    * can be assumed, that is usually water.
 194    */
 195   bool get_solid () const { return solid; }
 196
 197   /**
 198    * Get the friction factor for that material
 199    */
 200   double get_friction_factor () const { return friction_factor; }
 201
 202   /**
 203    * Get the rolling friction for that material
 204    */
 205   double get_rolling_friction () const { return rolling_friction; }
 206
 207   /**
 208    * Get the bumpines for that material
 209    */
 210   double get_bumpiness () const { return bumpiness; }
 211
 212   /**
 213    * Get the load resistance
 214    */
 215   double get_load_resistance () const { return load_resistance; }
 216
 217   /**
 218    * Get the list of names for this material
 219    */
 220   const std::vector<std::string>& get_names() const { return _names; }
 221
 222   /**
 223    * add the given name to the list of names this material is known
 224    */
 225   void add_name(const std::string& name) { _names.push_back(name); }
 226
 227   /**
 228    * Get the number of randomly-placed objects defined for this material.
 229    */
 230   int get_object_group_count () const { return object_groups.size(); }
 231
 232   /**
 233    * Get a randomly-placed object for this material.
 234    */
 235   SGMatModelGroup * get_object_group (int index) const {
 236     return object_groups[index];
 237   }
 238
 239   /**
 240    * Return pointer to glyph class, or 0 if it doesn't exist.
 241    */
 242   SGMaterialGlyph * get_glyph (const std::string& name) const;
 243
 244   void set_light_color(const SGVec4f& color)
 245   { emission = color; }
 246   const SGVec4f& get_light_color() const
 247   { return emission; }
 248
 249   SGVec2f get_tex_coord_scale() const
 250   {
 251     float tex_width = get_xsize();
 252     float tex_height = get_ysize();
 253
 254     return SGVec2f((0 < tex_width) ? 1000.0f/tex_width : 1.0f,
 255                    (0 < tex_height) ? 1000.0f/tex_height : 1.0f);
 256   }
 257
 258 protected:
 259
 260 \f
 261   ////////////////////////////////////////////////////////////////////
 262   // Protected methods.
 263   ////////////////////////////////////////////////////////////////////
 264
 265   /**
 266    * Initialization method, invoked by all public constructors.
 267    */
 268   void init();
 269
 270 protected:
 271
 272   struct _internal_state {
 273       _internal_state(simgear::Effect *e, const std::string &t, bool l,
 274                       const osgDB::ReaderWriter::Options *o);
 275       osg::ref_ptr<simgear::Effect> effect;
 276       std::string texture_path;
 277       bool effect_realized;
 278       osg::ref_ptr<const osgDB::ReaderWriter::Options> options;
 279   };
 280
 281 private:
 282
 283 \f
 284   ////////////////////////////////////////////////////////////////////
 285   // Internal state.
 286   ////////////////////////////////////////////////////////////////////
 287
 288   // texture status
 289   std::vector<_internal_state> _status;
 290
 291   // Round-robin counter
 292   mutable unsigned int _current_ptr;
 293
 294   // texture size
 295   double xsize, ysize;
 296
 297   // wrap texture?
 298   bool wrapu, wrapv;
 299
 300   // use mipmapping?
 301   bool mipmap;
 302
 303   // coverage of night lighting.
 304   double light_coverage;
 305
 306   // coverage of woods
 307   double wood_coverage;
 308
 309   // The size of each wood
 310   double wood_size;
 311
 312   // Tree density within the wood
 313   double tree_density;
 314
 315   // Range at which trees become visible
 316   double tree_range;
 317
 318   // Height of the tree
 319   double tree_height;
 320
 321   // Width of the tree
 322   double tree_width;
 323
 324   // Number of varieties of tree texture
 325   int tree_varieties;
 326
 327   // True if the material is solid, false if it is a fluid
 328   bool solid;
 329
 330   // the friction factor of that surface material
 331   double friction_factor;
 332
 333   // the rolling friction of that surface material
 334   double rolling_friction;
 335
 336   // the bumpiness of that surface material
 337   double bumpiness;
 338
 339   // the load resistance of that surface material
 340   double load_resistance;
 341
 342   // material properties
 343   SGVec4f ambient, diffuse, specular, emission;
 344   double shininess;
 345
 346   // effect for this material
 347   std::string effect;
 348
 349   // the list of names for this material. May be empty.
 350   std::vector<std::string> _names;
 351
 352   std::vector<SGSharedPtr<SGMatModelGroup> > object_groups;
 353
 354   // taxiway-/runway-sign texture elements
 355   std::map<std::string, SGSharedPtr<SGMaterialGlyph> > glyphs;
 356
 357   // Tree texture, typically a strip of applicable tree textures
 358   std::string tree_texture;
 359 \f
 360   ////////////////////////////////////////////////////////////////////
 361   // Internal constructors and methods.
 362   ////////////////////////////////////////////////////////////////////
 363
 364   void read_properties(const osgDB::ReaderWriter::Options* options,
 365                         const SGPropertyNode *props);
 366   void buildEffectProperties(const osgDB::ReaderWriter::Options* options);
 367 };
 368
 369
 370 class SGMaterialGlyph : public SGReferenced {
 371 public:
 372   SGMaterialGlyph(SGPropertyNode *);
 373   inline double get_left() const { return _left; }
 374   inline double get_right() const { return _right; }
 375   inline double get_width() const { return _right - _left; }
 376
 377 protected:
 378   double _left;
 379   double _right;
 380 };
 381
 382 class SGMaterialUserData : public osg::Referenced {
 383 public:
 384   SGMaterialUserData(const SGMaterial* material) :
 385     mMaterial(material)
 386   {}
 387   const SGMaterial* getMaterial() const
 388   { return mMaterial; }
 389 private:
 390   // this cannot be an SGSharedPtr since that would create a cicrular reference
 391   // making it impossible to ever free the space needed by SGMaterial
 392   const SGMaterial* mMaterial;
 393 };
 394
 395 void
 396 SGSetTextureFilter( int max);
 397
 398 int
 399 SGGetTextureFilter();
 400
 401 #endif // _SG_MAT_HXX