simgear/scene/material/matmodel.hxx

   1 // matmodel.hxx -- class to handle models tied to a material property
   2 //
   3 // Written by David Megginson, December 2001
   4 //
   5 // Copyright (C) 1998 - 2003  Curtis L. Olson  - http://www.flightgear.org/~curt
   6 //
   7 // This program is free software; you can redistribute it and/or
   8 // modify it under the terms of the GNU General Public License as
   9 // published by the Free Software Foundation; either version 2 of the
  10 // License, or (at your option) any later version.
  11 //
  12 // This program is distributed in the hope that it will be useful, but
  13 // WITHOUT ANY WARRANTY; without even the implied warranty of
  14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 // General Public License for more details.
  16 //
  17 // You should have received a copy of the GNU General Public License
  18 // along with this program; if not, write to the Free Software
  19 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  20 //
  21 // $Id$
  22
  23
  24 #ifndef _SG_MAT_MODEL_HXX
  25 #define _SG_MAT_MODEL_HXX
  26
  27 #ifndef __cplusplus
  28 # error This library requires C++
  29 #endif
  30
  31 #include <simgear/compiler.h>
  32
  33 #include STL_STRING      // Standard C++ string library
  34
  35 #include <osg/ref_ptr>
  36 #include <osg/Node>
  37 #include <osg/NodeVisitor>
  38 #include <osg/Billboard>
  39
  40 #include <simgear/structure/SGReferenced.hxx>
  41 #include <simgear/structure/SGSharedPtr.hxx>
  42 #include <simgear/props/props.hxx>
  43 #include <simgear/math/sg_random.h>
  44
  45 SG_USING_STD(string);
  46
  47
  48 class SGMatModelGroup;
  49
  50
  51 /**
  52  * A randomly-placeable object.
  53  *
  54  * SGMaterial uses this class to keep track of the model(s) and
  55  * parameters for a single instance of a randomly-placeable object.
  56  * The object can have more than one variant model (i.e. slightly
  57  * different shapes of trees), but they are considered equivalent
  58  * and interchangeable.
  59  */
  60 class SGMatModel : public SGReferenced {
  61
  62 public:
  63
  64     /**
  65      * The heading type for a randomly-placed object.
  66      */
  67     enum HeadingType {
  68         HEADING_FIXED,
  69         HEADING_BILLBOARD,
  70         HEADING_RANDOM
  71     };
  72
  73     /**
  74      * Get the number of variant models available for the object.
  75      *
  76      * @return The number of variant models.
  77      */
  78     int get_model_count( SGPropertyNode *prop_root );
  79
  80
  81     /**
  82      * Get a specific variant model for the object.
  83      *
  84      * @param index The index of the model.
  85      * @return The model.
  86      */
  87      osg::Node *get_model( int index, SGPropertyNode *prop_root );
  88
  89
  90     /**
  91      * Get a randomly-selected variant model for the object.
  92      *
  93      * @return A randomly select model from the variants.
  94      */
  95     osg::Node *get_random_model( SGPropertyNode *prop_root );
  96
  97
  98     /**
  99      * Get the average number of meters^2 occupied by each instance.
 100      *
 101      * @return The coverage in meters^2.
 102      */
 103     double get_coverage_m2 () const;
 104
 105     /**
 106      * Get the visual range of the object in meters.
 107      *
 108      * @return The visual range.
 109      */
 110     double get_range_m () const;
 111
 112     /**
 113      * Get a randomized visual range
 114      *
 115      * @return a randomized visual range
 116      */
 117     double get_randomized_range_m(mt* seed) const;
 118
 119     /**
 120      * Get the heading type for the object.
 121      *
 122      * @return The heading type.
 123      */
 124     HeadingType get_heading_type () const;
 125
 126     virtual ~SGMatModel ();
 127
 128
 129 protected:
 130
 131     friend class SGMatModelGroup;
 132
 133     SGMatModel (const SGPropertyNode * node, double range_m);
 134
 135 private:
 136
 137     /**
 138      * Actually load the models.
 139      *
 140      * This class uses lazy loading so that models won't be held
 141      * in memory for materials that are never referenced.
 142      */
 143     void load_models( SGPropertyNode *prop_root );
 144
 145     vector<string> _paths;
 146     mutable vector<osg::ref_ptr<osg::Node> > _models;
 147     mutable bool _models_loaded;
 148     double _coverage_m2;
 149     double _range_m;
 150     HeadingType _heading_type;
 151 };
 152
 153
 154 /**
 155  * A collection of related objects with the same visual range.
 156  *
 157  * Grouping objects with the same range together significantly
 158  * reduces the memory requirements of randomly-placed objects.
 159  * Each SGMaterial instance keeps a (possibly-empty) list of
 160  * object groups for placing randomly on the scenery.
 161  */
 162 class SGMatModelGroup : public SGReferenced {
 163
 164 public:
 165
 166     virtual ~SGMatModelGroup ();
 167
 168
 169     /**
 170      * Get the visual range of the object in meters.
 171      *
 172      * @return The visual range.
 173      */
 174     double get_range_m () const;
 175
 176
 177     /**
 178      * Get the number of objects in the group.
 179      *
 180      * @return The number of objects.
 181      */
 182     int get_object_count () const;
 183
 184
 185     /**
 186      * Get a specific object.
 187      *
 188      * @param index The object's index, zero-based.
 189      * @return The object selected.
 190      */
 191     SGMatModel * get_object (int index) const;
 192
 193 protected:
 194
 195     friend class SGMaterial;
 196
 197     SGMatModelGroup (SGPropertyNode * node);
 198
 199 private:
 200
 201     double _range_m;
 202     vector<SGSharedPtr<SGMatModel> > _objects;
 203 };
 204
 205 #endif // _SG_MAT_MODEL_HXX