Changeset 1580 for GTP/trunk/Lib/Vis/Preprocessing/src/HierarchyManager.h

Timestamp:

10/06/06 21:37:00 (18 years ago)

Author:

mattausch

Message:

 

File:

• GTP/trunk/Lib/Vis/Preprocessing/src/HierarchyManager.h (modified) (3 diffs)

GTP/trunk/Lib/Vis/Preprocessing/src/HierarchyManager.h

@@ -245 +245 @@
         void RunConstruction(const bool repairQueue);
                 
-        bool ApplySubdivisionCandidate(SubdivisionCandidate *sc);
+        /** Evaluates the subdivision candidate and executes the split.
+        */
+        bool ApplySubdivisionCandidate(SubdivisionCandidate *sc, const bool repairQueue);
 
         bool FinishedConstruction() const;
@@ -251 +253 @@
         SubdivisionCandidate *NextSubdivisionCandidate();
 
+        /** Repairs the dirty entries of the candidate queue.
+        */
         void RepairQueue();
 
+        /** Collect the list of dirty candidates after the current subdivision candidate
+                split.
+        */
         void CollectDirtyCandidates(vector<SubdivisionCandidate *> &dirtyList);
 
-        void EvalSubdivisionStats(const SubdivisionCandidate &tData);
+        /** Evaluate subdivision stats for log.
+        */
+        void EvalSubdivisionStats(const float renderCostDecr);
 
         void AddSubdivisionStats(
@@ -328 +337 @@
 
         enum {SEQUENTIAL, INTERLEAVED};
-        
+        /// type of hierarchy construction
+        int mConstructionType;
+
+        /// Type of object space partition
         int mObjectSpaceSubdivisionType;
+        /// Type of view space partition
     int mViewSpaceSubdivisionType;
 
-        /// the original osp type
+        ////////////
+        //-- helper variables
+        
+        // the original osp type
         int mSavedObjectSpaceSubdivisionType;
+        // the original vsp type
         int mSavedViewSpaceSubdivisionType;
-
-        int mConstructionType;
-
+        /// the current subdivision candidate
+        SubdivisionCandidate *mCurrentCandidate;
+
+        ///////////////////
+
+
+        ///////////////////
+        // Hierarchies
+
+        /// view space hierarchy
         VspTree *mVspTree;
+        /// object space partition kd tree
         OspTree *mOspTree;
+        /// bounding volume hierarchy
         BvHierarchy *mBvHierarchy;
 
-        AxisAlignedBox3 mBoundingBox;
-
+        //////////////////////
+        
+
+        /// the traversal queue
         SplitQueue mTQueue;
-
-        SubdivisionCandidate *mCurrentCandidate;
-
-        ////////
+        
+
+        //////////
         //-- global termination criteria
 
+        /// the mininal acceptable cost ratio for a split
         float mTermMinGlobalCostRatio;
+        /// the threshold for global cost miss tolerance
         int mTermGlobalCostMissTolerance;
-        
+        /// maximum number of leaves
+        int mTermMaxLeaves;
+
         ////////////////////
 
         /// keeps track of cost during subdivision
         float mTotalCost;
-
-        int mTotalPvsEntries;
+        /// statistics about the hierarchy
         HierarchyStatistics mHierarchyStats;
 
         int mMinDepthForObjectSpaceSubdivion;
         int mMinDepthForViewSpaceSubdivion;
-
-        int mTermMaxLeaves;
+        
         ofstream mSubdivisionStats;
 
+        /// if the queue should be repaired after a subdivision steps
         bool mRepairQueue;
 
         bool mStartWithObjectSpace;
-
+        /** if multi level construction method should be used
+                where we iterate over both hierarchies until we
+                converge to the optimum.
+        */
         bool mUseMultiLevelConstruction;
+        /// number of iteration steps for multilevel approach   
+        int mNumMultiLevels;
 };