Changeset 897 for GTP/trunk/Lib/Vis/OnlineCullingCHC/include/HierarchyInterface.h

Timestamp:

05/04/06 18:26:23 (18 years ago)

Author:

mattausch

Message:

updated to ogre 1.2

File:

• GTP/trunk/Lib/Vis/OnlineCullingCHC/include/HierarchyInterface.h (modified) (4 diffs)

GTP/trunk/Lib/Vis/OnlineCullingCHC/include/HierarchyInterface.h

@@ -19 +19 @@
 
 
-/**     Class which implements a hierarchy interface for a scene hierarchy.
+/**     Class which implements a hierarchy interface for a scene hierarchy. It has to be implemented
+        for any rendering engine to use the CHC algorithm.
 */
 class HierarchyInterface
@@ -33 +34 @@
         */
     virtual bool IsLeaf(HierarchyNode *node) const = 0;
-        /** Traverses and renders the given node. 
+        /** Traverses and renders the hierarchy from the given node. 
                 @param node the hierarchy node
         */
         virtual void TraverseNode(HierarchyNode *node) = 0;
-        /** Renders current hierarchy node.
+        /** Renders the given hierarchy node.
                 @param node current hierarchy node to be rendered
         */
@@ -47 +48 @@
         /** Issue a occlusion query for this node. 
                 @param node the current hierarchy node
+                @param wasVisible if the node was visible in the last frame: based
+                on this the method can decide on the way of querying
                 @returns occlusion query for this node
         */
         virtual OcclusionQuery *IssueNodeOcclusionQuery(HierarchyNode *node, 
-                const bool wasVisible = false) = 0;
+                                                                                                        const bool wasVisible = false) = 0;
         /** Sets the root of the scene hierarchy.
                 @param root the hierarchy root
@@ -122 +125 @@
 
         /** Visualization of a culled node, dependent on the culling type. 
+                @param node the hierarchy node to be visualized
                 @param type can be one of FRUSTUM_CULLED, QUERY_CULLED
         */
         virtual void VisualizeCulledNode(HierarchyNode *node, 
-                CullingType type) const = 0;
+                                                                         CullingType type) const = 0;
 
         /** Returns vector of visible hierarchy nodes from previous render.