Changeset 33 for trunk/VUT/OcclusionCullingSceneManager/include/OgreOcclusionCullingSceneTraverser.h

Timestamp:

03/30/05 11:36:07 (19 years ago)

Author:

Mattausch

Message:

 

File:

• trunk/VUT/OcclusionCullingSceneManager/include/OgreOcclusionCullingSceneTraverser.h (modified) (2 diffs)

trunk/VUT/OcclusionCullingSceneManager/include/OgreOcclusionCullingSceneTraverser.h

@@ -39 +39 @@
         {
         public:
-                OcclusionCullingSceneTraverser();
+                /** Construction taking the current scene manager and the current rendersystem as argument
+                @param sm current scene manager
+                @param rsys current render system 
+                */
+                OcclusionCullingSceneTraverser(SceneManager *sm, RenderSystem *rsys);
                 ~OcclusionCullingSceneTraverser();
         
                 enum {RENDER_CULL_FRUSTUM, RENDER_STOP_AND_WAIT, RENDER_COHERENT, NUM_RENDERMODES};
                 
-                /** Overriden from SceneManager. Renders the scene with the specified algorithm
-                /**
-                        The algorithm is one of
+                /** Renders the scene with the specified algorithm
+                        @comment 
+                        The algorithm type can be set with the parameter "Algorithm" and setOption.
+
+                        The algorithm is one of:
                         RENDER_CULL_FRUSTUM: renders the scene with view frustum culling only
                         RENDER_STOP_AND_WAIT: renders the scene with the hierarchical stop and wait algorithm
                         RENDER_COHERENT: renders the scene with the coherent hierarchical algorithm
+                        
+                        @param cam current camera
+                        @param root root of hierarchy 
                 */
+                void renderScene( Camera *cam, SceneNode *root );
+        
                 
-                /** Sets the given option for the SceneTraverser
+                /** Sets the given option for the scene traverser.
                                @remarks
                         Options are:
@@ -58 +69 @@
                 */
                 bool setOption( const String &, const void * );
-                /** Gets the given option for the SceneTraverser.
+                /** Gets the given option for the scene traverser.
                 @remarks
                     See setOption
                 */
                 bool getOption( const String &, void * );
-
-                /** Renders current scene 
-                @param cam current camera
-                @param root root of hierarchy */
-                void renderScene(  Camera *cam, SceneNode *root );
-
-                /** Sets the scene manager */
+                bool getOptionKeys( StringVector &refKeys );
+                
+                /** Sets pointer to the current scene manager.
+                @param the scene manager */
                 void setSceneManager( SceneManager *sm );
-                /** Sets the render system */
+                
+                /** Sets pointer to the current render system 
+                @param the rendersystem */
                 void setRenderSystem( RenderSystem *rsys );
-
+                
+                /** Doing some necessary preprocessing.
+                @comment e.g., initialises occlusion queries */
                 void preprocess( void );
 
+                /** Sets the current number of scene nodes in the scene.
+                @param num number of scene nodes
+                */
+                void setNumSceneNodes(int num );
+
         protected:
+                /** query mode (= without color) or RENDER_MODE */
                 enum {MODE_QUERY, MODE_RENDER};
                 /** returns true if node is leaf of the hierarchy */