source/objectinstance.h

   1 /* $Id$
   2
   3 This file is part of libmspgl
   4 Copyright © 2007  Mikko Rasa, Mikkosoft Productions
   5 Distributed under the LGPL
   6 */
   7
   8 #ifndef MSP_GL_OBJETCINSTANCE_H_
   9 #define MSP_GL_OBJETCINSTANCE_H_
  10
  11 #include <string>
  12 #include "renderable.h"
  13
  14 namespace Msp {
  15 namespace GL {
  16
  17 class Object;
  18 class ProgramData;
  19
  20 class ObjectPass;
  21
  22 /**
  23 Represents a single instance of an Object.  An application can derive another
  24 class from this and overload the hook functions to specify location and other
  25 instance-specific parameters for the rendered objects.
  26
  27 The finish_render function generally should clean up everything done by
  28 setup_render, unless the rendering sequence is known to allow otherwise.
  29 */
  30 class ObjectInstance: public Renderable
  31 {
  32 protected:
  33         const Object &object;
  34
  35 public:
  36         ObjectInstance(const Object &);
  37
  38         const Object &get_object() const { return object; }
  39
  40         virtual bool has_pass(const Tag &tag) const;
  41
  42         virtual void render(const Tag &tag=Tag()) const;
  43
  44         /**
  45         Hook function, called from Object just before rendering the mesh.
  46         */
  47         virtual void setup_render(const ObjectPass &) const { }
  48
  49         /**
  50         Hook function, called from Object right after rendering the mesh.
  51         */
  52         virtual void finish_render(const ObjectPass &) const { }
  53
  54         virtual unsigned get_level_of_detail() const { return 0; }
  55 };
  56
  57 } // namespace GL
  58 } // namespaec Msp
  59
  60 #endif