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 STL_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 <osg/StateSet>
  43
  44 #include <simgear/props/props.hxx>
  45 #include <simgear/structure/SGSharedPtr.hxx>
  46 #include <simgear/scene/util/SGSceneFeatures.hxx>
  47
  48 #include "matmodel.hxx"
  49
  50 SG_USING_STD(string);
  51 SG_USING_STD(vector);
  52 SG_USING_STD(map);
  53
  54
  55 class SGMaterialGlyph;
  56
  57 /**
  58  * A material in the scene graph.
  59  *
  60  * A material represents information about a single surface type
  61  * in the 3D scene graph, including texture, colour, lighting,
  62  * tiling, and so on; most of the materials in FlightGear are
  63  * defined in the $FG_ROOT/materials.xml file, and can be changed
  64  * at runtime.
  65  */
  66 class SGMaterial : public SGReferenced {
  67
  68 public:
  69
  70 \f
  71   ////////////////////////////////////////////////////////////////////
  72   // Public Constructors.
  73   ////////////////////////////////////////////////////////////////////
  74
  75   /**
  76    * Construct a material from a set of properties.
  77    *
  78    * @param props A property node containing subnodes with the
  79    * state information for the material.  This node is usually
  80    * loaded from the $FG_ROOT/materials.xml file.
  81    */
  82   SGMaterial( const string &fg_root, const SGPropertyNode *props, const char *season );
  83
  84
  85   /**
  86    * Construct a material from an absolute texture path.
  87    *
  88    * @param texture_path A string containing an absolute path
  89    * to a texture file (usually RGB).
  90    */
  91   SGMaterial( const string &texpath );
  92
  93
  94   /**
  95    * Construct a material around an existing state.
  96    *
  97    * This constructor allows the application to create a custom,
  98    * low-level state for the scene graph and wrap a material around
  99    * it.  Note: the pointer ownership is transferred to the material.
 100    *
 101    * @param s The state for this material.
 102    */
 103   SGMaterial( osg::StateSet *s );
 104
 105   /**
 106    * Destructor.
 107    */
 108   ~SGMaterial( void );
 109
 110
 111 \f
 112   ////////////////////////////////////////////////////////////////////
 113   // Public methods.
 114   ////////////////////////////////////////////////////////////////////
 115
 116   /**
 117    * Get the textured state.
 118    */
 119   osg::StateSet *get_state (int n = -1);
 120
 121
 122   /**
 123    * Get the number of textures assigned to this material.
 124    */
 125   inline int get_num() const { return _status.size(); }
 126
 127
 128   /**
 129    * Get the xsize of the texture, in meters.
 130    */
 131   inline double get_xsize() const { return xsize; }
 132
 133
 134   /**
 135    * Get the ysize of the texture, in meters.
 136    */
 137   inline double get_ysize() const { return ysize; }
 138
 139
 140   /**
 141    * Get the light coverage.
 142    *
 143    * A smaller number means more generated night lighting.
 144    *
 145    * @return The area (m^2?) covered by each light.
 146    */
 147   inline double get_light_coverage () const { return light_coverage; }
 148
 149   /**
 150    * Return if the surface material is solid, if it is not solid, a fluid
 151    * can be assumed, that is usually water.
 152    */
 153   bool get_solid () const { return solid; }
 154
 155   /**
 156    * Get the friction factor for that material
 157    */
 158   double get_friction_factor () const { return friction_factor; }
 159
 160   /**
 161    * Get the rolling friction for that material
 162    */
 163   double get_rolling_friction () const { return rolling_friction; }
 164
 165   /**
 166    * Get the bumpines for that material
 167    */
 168   double get_bumpiness () const { return bumpiness; }
 169
 170   /**
 171    * Get the load resistance
 172    */
 173   double get_load_resistance () const { return load_resistance; }
 174
 175   /**
 176    * Get the list of names for this material
 177    */
 178   const vector<string>& get_names() const { return _names; }
 179
 180   /**
 181    * add the given name to the list of names this material is known
 182    */
 183   void add_name(const string& name) { _names.push_back(name); }
 184
 185   /**
 186    * Get the number of randomly-placed objects defined for this material.
 187    */
 188   int get_object_group_count () const { return object_groups.size(); }
 189
 190   /**
 191    * Get a randomly-placed object for this material.
 192    */
 193   SGMatModelGroup * get_object_group (int index) const {
 194     return object_groups[index];
 195   }
 196
 197   /**
 198    * Return pointer to glyph class, or 0 if it doesn't exist.
 199    */
 200   SGMaterialGlyph * get_glyph (const string& name) const;
 201
 202   void set_light_color(const SGVec4f& color)
 203   { emission = color; }
 204   const SGVec4f& get_light_color() const
 205   { return emission; }
 206
 207   SGVec2f get_tex_coord_scale() const
 208   {
 209     float tex_width = get_xsize();
 210     float tex_height = get_ysize();
 211
 212     return SGVec2f((0 < tex_width) ? 1000.0f/tex_width : 1.0f,
 213                    (0 < tex_height) ? 1000.0f/tex_height : 1.0f);
 214   }
 215
 216 protected:
 217
 218 \f
 219   ////////////////////////////////////////////////////////////////////
 220   // Protected methods.
 221   ////////////////////////////////////////////////////////////////////
 222
 223   /**
 224    * Initialization method, invoked by all public constructors.
 225    */
 226   void init();
 227
 228 protected:
 229
 230   struct _internal_state {
 231       _internal_state( osg::StateSet *s, const string &t, bool l )
 232                   : state(s), texture_path(t), texture_loaded(l) {}
 233       osg::ref_ptr<osg::StateSet> state;
 234       string texture_path;
 235       bool texture_loaded;
 236   };
 237
 238 private:
 239
 240 \f
 241   ////////////////////////////////////////////////////////////////////
 242   // Internal state.
 243   ////////////////////////////////////////////////////////////////////
 244
 245   // texture status
 246   vector<_internal_state> _status;
 247
 248   // Round-robin counter
 249   mutable unsigned int _current_ptr;
 250
 251   // texture size
 252   double xsize, ysize;
 253
 254   // wrap texture?
 255   bool wrapu, wrapv;
 256
 257   // use mipmapping?
 258   int mipmap;
 259
 260   // coverage of night lighting.
 261   double light_coverage;
 262
 263   // True if the material is solid, false if it is a fluid
 264   bool solid;
 265
 266   // the friction factor of that surface material
 267   double friction_factor;
 268
 269   // the rolling friction of that surface material
 270   double rolling_friction;
 271
 272   // the bumpiness of that surface material
 273   double bumpiness;
 274
 275   // the load resistance of that surface material
 276   double load_resistance;
 277
 278   // material properties
 279   SGVec4f ambient, diffuse, specular, emission;
 280   double shininess;
 281
 282   // the list of names for this material. May be empty.
 283   vector<string> _names;
 284
 285   vector<SGSharedPtr<SGMatModelGroup> > object_groups;
 286
 287   // taxiway-/runway-sign texture elements
 288   map<string, SGSharedPtr<SGMaterialGlyph> > glyphs;
 289
 290 \f
 291   ////////////////////////////////////////////////////////////////////
 292   // Internal constructors and methods.
 293   ////////////////////////////////////////////////////////////////////
 294
 295   SGMaterial( const string &fg_root, const SGMaterial &mat ); // unimplemented
 296
 297   void read_properties( const string &fg_root, const SGPropertyNode *props, const char *season );
 298   void build_state( bool defer_tex_load );
 299   void set_state( osg::StateSet *s );
 300
 301   void assignTexture( osg::StateSet *state, const std::string &fname, int _wrapu = TRUE, int _wrapv = TRUE, int _mipmap = TRUE );
 302
 303 };
 304
 305
 306 class SGMaterialGlyph : public SGReferenced {
 307 public:
 308   SGMaterialGlyph(SGPropertyNode *);
 309   inline double get_left() const { return _left; }
 310   inline double get_right() const { return _right; }
 311   inline double get_width() const { return _right - _left; }
 312
 313 protected:
 314   double _left;
 315   double _right;
 316 };
 317
 318 class SGMaterialUserData : public osg::Referenced {
 319 public:
 320   SGMaterialUserData(const SGMaterial* material) :
 321     mMaterial(material)
 322   {}
 323   const SGMaterial* getMaterial() const
 324   { return mMaterial; }
 325 private:
 326   // this cannot be an SGSharedPtr since that would create a cicrular reference
 327   // making it impossible to ever free the space needed by SGMaterial
 328   const SGMaterial* mMaterial;
 329 };
 330
 331 void
 332 SGSetTextureFilter( int max);
 333
 334 int
 335 SGGetTextureFilter();
 336
 337 #endif // _SG_MAT_HXX