Lots of comment updates

[libs/gl.git] / source / objectinstance.h

diff --git a/source/objectinstance.h b/source/objectinstance.h
index 459c2da3523b23ff84e2cd510e2cde05d0c5a154..3dc5da6a399432bafa62197b01ae0e19d7475f5f 100644 (file)
--- a/source/objectinstance.h
+++ b/source/objectinstance.h
@@ -1,10 +1,3 @@
-/* $Id$
-
-This file is part of libmspgl
-Copyright © 2007  Mikko Rasa, Mikkosoft Productions
-Distributed under the LGPL
-*/
-
 #ifndef MSP_GL_OBJETCINSTANCE_H_
 #define MSP_GL_OBJETCINSTANCE_H_
 
@@ -17,12 +10,13 @@ namespace GL {
 class Object;
 class ProgramData;
 
-class ObjectPass;
-
 /**
-Represents a single instance of an Object.  An application can derive another
-class from this and overload the hook functions to specify location and other
-instance-specific parameters for the rendered objects.
+Represents a single instance of an Object.  A derived class can overload the
+hook functions to specify a model matrix and other instance-specific parameters
+for the rendered objects.
+
+ObjectInstances can benefit from being put in an InstanceScene, which will
+render all instances of the same object consecutively.
 */
 class ObjectInstance: public Renderable
 {
@@ -33,21 +27,19 @@ public:
        ObjectInstance(const Object &);
 
        const Object &get_object() const { return object; }
+       virtual long get_instance_key() const { return reinterpret_cast<long>(&object); }
 
-       virtual bool has_pass(const std::string &) const;
-
-       virtual void render() const;
-       virtual void render(const std::string &) const;
+       virtual void render(const Tag &tag = Tag()) const;
+       virtual void render(Renderer &, const Tag & = Tag()) const;
 
-       /**
-       Hook function, called from Object just before rendering the mesh.
-       */
-       virtual void setup_render(const ObjectPass &) const { }
+       /** Hook function, called from Object just before rendering the mesh.
+       Renderer state will have been pushed before this is called. */
+       virtual void setup_render(Renderer &, const Tag &) const { }
 
-       /**
-       Hook function, called from Object right after rendering the mesh.
-       */
-       virtual void finish_render(const ObjectPass &) const { }
+       /** Hook function, called from Object right after rendering the mesh.  Since
+       Object takes care of pushing Renderer state, this rarely needs to do
+       anything. */
+       virtual void finish_render(Renderer &, const Tag &) const { }
 
        virtual unsigned get_level_of_detail() const { return 0; }
 };