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 <string>      // Standard C++ string library
  34 #include <vector>
  35
  36 #include <osg/ref_ptr>
  37 #include <osg/Node>
  38 #include <osg/NodeVisitor>
  39 #include <osg/Billboard>
  40
  41 #include <simgear/structure/SGReferenced.hxx>
  42 #include <simgear/structure/SGSharedPtr.hxx>
  43 #include <simgear/props/props.hxx>
  44 #include <simgear/math/sg_random.h>
  45
  46
  47 class SGMatModelGroup;
  48
  49
  50 /**
  51  * A randomly-placeable object.
  52  *
  53  * SGMaterial uses this class to keep track of the model(s) and
  54  * parameters for a single instance of a randomly-placeable object.
  55  * The object can have more than one variant model (i.e. slightly
  56  * different shapes of trees), but they are considered equivalent
  57  * and interchangeable.
  58  */
  59 class SGMatModel : public SGReferenced {
  60
  61 public:
  62
  63     /**
  64      * The heading type for a randomly-placed object.
  65      */
  66     enum HeadingType {
  67         HEADING_FIXED,
  68         HEADING_BILLBOARD,
  69         HEADING_RANDOM
  70     };
  71
  72     /**
  73      * Get the number of variant models available for the object.
  74      *
  75      * @return The number of variant models.
  76      */
  77     int get_model_count( SGPropertyNode *prop_root );
  78
  79
  80     /**
  81      * Get a randomly-selected variant model for the object.
  82      *
  83      * @return A randomly select model from the variants.
  84      */
  85     osg::Node *get_random_model( SGPropertyNode *prop_root, mt seed );
  86
  87
  88     /**
  89      * Get the average number of meters^2 occupied by each instance.
  90      *
  91      * @return The coverage in meters^2.
  92      */
  93     double get_coverage_m2 () const;
  94
  95     /**
  96      * Get the visual range of the object in meters.
  97      *
  98      * @return The visual range.
  99      */
 100     double get_range_m () const;
 101
 102     /**
 103      * Get a randomized visual range
 104      *
 105      * @return a randomized visual range
 106      */
 107     double get_randomized_range_m(mt* seed) const;
 108
 109     /**
 110      * Get the heading type for the object.
 111      *
 112      * @return The heading type.
 113      */
 114     HeadingType get_heading_type () const;
 115
 116     virtual ~SGMatModel ();
 117
 118
 119 protected:
 120
 121     friend class SGMatModelGroup;
 122
 123     SGMatModel (const SGPropertyNode * node, double range_m);
 124
 125 private:
 126
 127     /**
 128      * Actually load the models.
 129      *
 130      * This class uses lazy loading so that models won't be held
 131      * in memory for materials that are never referenced.
 132      */
 133     void load_models( SGPropertyNode *prop_root );
 134
 135     std::vector<std::string> _paths;
 136     mutable std::vector<osg::ref_ptr<osg::Node> > _models;
 137     mutable bool _models_loaded;
 138     double _coverage_m2;
 139     double _range_m;
 140     HeadingType _heading_type;
 141 };
 142
 143
 144 /**
 145  * A collection of related objects with the same visual range.
 146  *
 147  * Grouping objects with the same range together significantly
 148  * reduces the memory requirements of randomly-placed objects.
 149  * Each SGMaterial instance keeps a (possibly-empty) list of
 150  * object groups for placing randomly on the scenery.
 151  */
 152 class SGMatModelGroup : public SGReferenced {
 153
 154 public:
 155
 156     virtual ~SGMatModelGroup ();
 157
 158
 159     /**
 160      * Get the visual range of the object in meters.
 161      *
 162      * @return The visual range.
 163      */
 164     double get_range_m () const;
 165
 166
 167     /**
 168      * Get the number of objects in the group.
 169      *
 170      * @return The number of objects.
 171      */
 172     int get_object_count () const;
 173
 174
 175     /**
 176      * Get a specific object.
 177      *
 178      * @param index The object's index, zero-based.
 179      * @return The object selected.
 180      */
 181     SGMatModel * get_object (int index) const;
 182
 183 protected:
 184
 185     friend class SGMaterial;
 186
 187     SGMatModelGroup (SGPropertyNode * node);
 188
 189 private:
 190
 191     double _range_m;
 192     std::vector<SGSharedPtr<SGMatModel> > _objects;
 193 };
 194
 195 #endif // _SG_MAT_MODEL_HXX