Generalize instancing to all Renderables

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

diff --git a/source/objectinstance.h b/source/objectinstance.h
index 602cbc24d80a50989a4faee48db6e0319bda9cdc..e7f85e3fbc4c3bc17bf3dbe12aa499cd5c6834b3 100644 (file)
--- a/source/objectinstance.h
+++ b/source/objectinstance.h
@@ -1,7 +1,7 @@
 /* $Id$
 
 This file is part of libmspgl
-Copyright © 2007  Mikko Rasa, Mikkosoft Productions
+Copyright © 2007-2008, 2010-2011  Mikko Rasa, Mikkosoft Productions
 Distributed under the LGPL
 */
 
@@ -21,9 +21,6 @@ class ProgramData;
 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.
-
-The finish_render function generally should clean up everything done by
-setup_render, unless the rendering sequence is known to allow otherwise.
 */
 class ObjectInstance: public Renderable
 {
@@ -34,18 +31,19 @@ public:
        ObjectInstance(const Object &);
 
        const Object &get_object() const { return object; }
+       virtual long get_instance_key() const { return reinterpret_cast<long>(&object); }
 
-       virtual void render(const Tag &tag=Tag()) 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 Tag &) 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 Tag &) 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; }
 };