source/object.h

   1 #ifndef MSP_GL_OBJECT_H_
   2 #define MSP_GL_OBJECT_H_
   3
   4 #include <vector>
   5 #include "bindable.h"
   6 #include "renderable.h"
   7 #include "renderpass.h"
   8 #include "resourcewatcher.h"
   9
  10 namespace Msp {
  11 namespace GL {
  12
  13 class Material;
  14 class Mesh;
  15 class ObjectInstance;
  16 class Technique;
  17 class Texture;
  18
  19 /**
  20 Combines a Mesh with a Technique to give it an appearance.  The Technique will
  21 define which render passes the Object supports.
  22
  23 In many cases, it's desirable to include multiple copies of an Object in a
  24 Scene, with different model matrices.  ObjectInstances can be used to alter the
  25 rendering of an object on a per-instance basis.
  26
  27 Objects can have multiple levels of detail.  The most detailed level has index
  28 0, with increasing indices having less detail.  When rendering an instance, the
  29 instance's get_level_of_detail method is called to determine which LoD to use.
  30 */
  31 class Object: public Renderable, private ResourceWatcher
  32 {
  33 private:
  34         struct LevelOfDetail;
  35
  36         class LodLoader: public DataFile::CollectionObjectLoader<Object>
  37         {
  38         private:
  39                 unsigned index;
  40                 LevelOfDetail &lod;
  41
  42         public:
  43                 LodLoader(Object &, unsigned, Collection *);
  44
  45         private:
  46                 void mesh(const std::string &);
  47                 void mesh_inline();
  48                 void technique(const std::string &);
  49                 void technique_inline();
  50         };
  51
  52 public:
  53         class Loader: public LodLoader
  54         {
  55         public:
  56                 Loader(Object &);
  57                 Loader(Object &, Collection &);
  58         private:
  59                 void init();
  60                 virtual void finish();
  61
  62                 void level_of_detail(unsigned);
  63         };
  64
  65 private:
  66         struct LevelOfDetail
  67         {
  68                 RefPtr<const Mesh> mesh;
  69                 RefPtr<const Technique> technique;
  70         };
  71
  72         std::vector<LevelOfDetail> lods;
  73         Geometry::BoundingSphere<float, 3> bounding_sphere;
  74
  75 public:
  76         Object();
  77         Object(const Mesh *, const Technique *);
  78         ~Object();
  79
  80 private:
  81         LevelOfDetail &get_lod(unsigned, const char *);
  82
  83 public:
  84         /** Sets the mesh for the highest level of detail (index 0). */
  85         void set_mesh(const Mesh *m) { set_mesh(0, m); }
  86
  87         /** Sets the mesh for a given level of detail.  Previous LoDs must have been
  88         defined. */
  89         void set_mesh(unsigned, const Mesh *);
  90
  91 private:
  92         void update_bounding_sphere();
  93 public:
  94         const Mesh *get_mesh(unsigned = 0) const;
  95
  96         /** Sets the technique for the highest level of detail (index 0). */
  97         void set_technique(const Technique *t) { set_technique(0, t); }
  98
  99         /** Sets the technique for a given level of detail.  Previous LoDs must have
 100         been defined. */
 101         void set_technique(unsigned, const Technique *);
 102
 103         const Technique *get_technique(unsigned = 0) const;
 104
 105         virtual const Geometry::BoundingSphere<float, 3> *get_bounding_sphere() const { return &bounding_sphere; }
 106
 107         virtual void render(const Tag &tag = Tag()) const;
 108
 109         virtual void render(Renderer &, const Tag & = Tag()) const;
 110
 111         /** Renders an instance of the object.  The instance's hook functions are
 112         called before and after drawing the mesh. */
 113         virtual void render(Renderer &, const ObjectInstance &, const Tag & = Tag()) const;
 114
 115 protected:
 116         virtual void setup_render(Renderer &, const Tag &) const { }
 117         virtual void finish_render(Renderer &, const Tag &) const { }
 118
 119 private:
 120         const RenderPass *get_pass(const Tag &, unsigned) const;
 121
 122         virtual void resource_loaded(Resource &);
 123 };
 124
 125 } // namespace GL
 126 } // namespace Msp
 127
 128 #endif