Lots of comment updates

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

diff --git a/source/object.h b/source/object.h
index 52338a1657b7af5cc0f2df7bd1c989ac224ecb42..8a707665c8871132e4c555f8a9fc88b5108a10c6 100644 (file)
--- a/source/object.h
+++ b/source/object.h
@@ -1,10 +1,3 @@
-/* $Id$
-
-This file is part of libmspgl
-Copyright © 2007-2008, 2010-2011  Mikko Rasa, Mikkosoft Productions
-Distributed under the LGPL
-*/
-
 #ifndef MSP_GL_OBJECT_H_
 #define MSP_GL_OBJECT_H_
 
@@ -23,17 +16,15 @@ class Technique;
 class Texture;
 
 /**
-Stores a Mesh together with a Technique to determine its appearance.
+Combines a Mesh with a Technique to give it an appearance.  The Technique will
+define which render passes the Object supports.
 
-It is possible to use a single Object for rendering multiple identical or
-similar objects.  See class ObjectInstance.
+In many cases, it's desirable to include multiple copies of an Object in a
+Scene, with different model matrices.  ObjectInstances can be used to alter the
+rendering of an object on a per-instance basis.
 */
 class Object: public Renderable
 {
-private:
-       std::vector<RefPtr<const Mesh> > meshes;
-       RefPtr<const Technique> technique;
-
 public:
        class Loader: public DataFile::CollectionObjectLoader<Object>
        {
@@ -52,26 +43,27 @@ public:
                void technique(const std::string &);
        };
 
+private:
+       std::vector<RefPtr<const Mesh> > meshes;
+       RefPtr<const Technique> technique;
+
+public:
        Object();
+       Object(const Mesh *, const Technique *);
        ~Object();
 
        void set_mesh(const Mesh *m) { set_mesh(0, m); }
        void set_mesh(unsigned, const Mesh *);
+       const Mesh *get_mesh(unsigned = 0) const;
        void set_technique(const Technique *);
        const Technique *get_technique() const { return technique.get(); }
 
-       /**
-       Renders the object.  A tag can be provided to render a non-default pass.
-       */
        virtual void render(const Tag &tag = Tag()) const;
 
        virtual void render(Renderer &, const Tag & = Tag()) const;
 
-       /**
-       Renders the object with an instance.  The instance's hook functions are
-       called before and after drawing the mesh.  A tag may also be given to render
-       a non-default pass.
-       */
+       /** Renders an instance of the object.  The instance's hook functions are
+       called before and after drawing the mesh. */
        virtual void render(Renderer &, const ObjectInstance &, const Tag & = Tag()) const;
 
 private: