source: GTP/trunk/Lib/Vis/Preprocessing/src/BvHierarchy.h @ 1941

Revision 1941, 25.9 KB checked in by mattausch, 18 years ago (diff)
Line 
1#ifndef _BvHierarchy_H__
2#define _BvHierarchy_H__
3
4#include <stack>
5
6#include "Mesh.h"
7#include "Containers.h"
8#include "Statistics.h"
9#include "VssRay.h"
10#include "RayInfo.h"
11#include "gzstream.h"
12#include "SubdivisionCandidate.h"
13#include "AxisAlignedBox3.h"
14#include "IntersectableWrapper.h"
15#include "HierarchyManager.h"
16
17
18namespace GtpVisibilityPreprocessor {
19
20
21class ViewCellLeaf;
22class Plane3;
23class AxisAlignedBox3;
24class Ray;
25class ViewCellsStatistics;
26class ViewCellsManager;
27class MergeCandidate;
28class Beam;
29class ViewCellsTree;
30class Environment;
31class BvhInterior;
32class BvhLeaf;
33class BvhNode;
34class BvhTree;
35class VspTree;
36class ViewCellsContainer;
37class HierarchyManager;
38
39
40/** View space partition statistics.
41*/
42class BvhStatistics: public StatisticsBase
43{
44public:
45       
46        /// Constructor
47        BvhStatistics()
48        {
49                Reset();
50        }
51
52        int Nodes() const {return nodes;}
53        int Interior() const { return nodes / 2; }
54        int Leaves() const { return (nodes / 2) + 1; }
55       
56        double AvgDepth() const
57        { return accumDepth / (double)Leaves(); }
58
59        double AvgObjectRefs() const
60        { return objectRefs / (double)Leaves(); }
61
62        double AvgRayRefs() const
63        { return rayRefs / (double)Leaves(); }
64
65       
66        void Reset()
67        {
68                nodes = 0;
69                splits = 0;
70                maxDepth = 0;
71
72                minDepth = 99999;
73                accumDepth = 0;
74        maxDepthNodes = 0;
75                minProbabilityNodes = 0;
76                maxCostNodes = 0;
77                ///////////////////
78                minObjectsNodes = 0;
79                maxObjectRefs = 0;
80                minObjectRefs = 999999999;
81                objectRefs = 0;
82                emptyNodes = 0;
83
84                ///////////////////
85                minRaysNodes = 0;
86                maxRayRefs = 0;
87                minRayRefs = 999999999;
88                rayRefs = 0;
89                maxRayContriNodes = 0;
90                mGlobalCostMisses = 0;
91        }
92
93
94public:
95
96        // total number of nodes
97        int nodes;
98        // number of splits
99        int splits;
100        // maximal reached depth
101        int maxDepth;
102        // minimal depth
103        int minDepth;
104        // max depth nodes
105        int maxDepthNodes;
106        // accumulated depth (used to compute average)
107        int accumDepth;
108        // minimum area nodes
109        int minProbabilityNodes;
110        /// nodes termination because of max cost ratio;
111        int maxCostNodes;
112        // global cost ratio violations
113        int mGlobalCostMisses;
114
115        //////////////////
116        // nodes with minimum objects
117        int minObjectsNodes;
118        // max number of rays per node
119        int maxObjectRefs;
120        // min number of rays per node
121        int minObjectRefs;
122        /// object references
123        int objectRefs;
124        // leaves with no objects
125        int emptyNodes;
126
127        //////////////////////////
128        // nodes with minimum rays
129        int minRaysNodes;
130        // max number of rays per node
131        int maxRayRefs;
132        // min number of rays per node
133        int minRayRefs;
134        /// object references
135        int rayRefs;
136        /// nodes with max ray contribution
137        int maxRayContriNodes;
138
139        void Print(ostream &app) const;
140
141        friend ostream &operator<<(ostream &s, const BvhStatistics &stat)
142        {
143                stat.Print(s);
144                return s;
145        }
146};
147
148
149/**
150    VspNode abstract class serving for interior and leaf node implementation
151*/
152class BvhNode: public Intersectable
153{
154public:
155       
156        // types of vsp nodes
157        enum {Interior, Leaf};
158
159        BvhNode();
160        BvhNode(const AxisAlignedBox3 &bbox);
161        BvhNode(const AxisAlignedBox3 &bbox, BvhInterior *parent);
162
163        virtual ~BvhNode(){};
164
165        /** Determines whether this node is a leaf or not
166                @return true if leaf
167        */
168        virtual bool IsLeaf() const = 0;
169
170        /** Determines whether this node is a root
171                @return true if root
172        */
173        virtual bool IsRoot() const;
174
175        /** Returns parent node.
176        */
177        BvhInterior *GetParent();
178
179        /** Sets parent node.
180        */
181        void SetParent(BvhInterior *parent);
182
183        /** collects all objects under this node.
184        */
185        virtual void CollectObjects(ObjectContainer &objects) = 0;
186
187        /** The bounding box specifies the node extent.
188        */
189        inline
190        AxisAlignedBox3 GetBoundingBox() const
191        { return mBoundingBox; }
192
193        /** Sets bouding box of this node.
194        */
195        inline
196        void SetBoundingBox(const AxisAlignedBox3 &boundingBox)
197        { mBoundingBox = boundingBox; }
198
199        /** Cost of mergin this node.
200        */
201        float GetMergeCost() {return (float)-mTimeStamp; }
202
203        virtual int GetRandomEdgePoint(Vector3 &point,
204                                                                 Vector3 &normal);
205
206        inline int GetTimeStamp() const { return mTimeStamp; }
207        inline void SetTimeStamp(const int timeStamp) { mTimeStamp = timeStamp; };
208
209
210        ////////////////////////
211        //-- inherited functions from Intersectable
212
213        AxisAlignedBox3 GetBox() const { return mBoundingBox; }
214       
215        int CastRay(Ray &ray) { return 0; }
216       
217        bool IsConvex() const { return true; }
218        bool IsWatertight() const { return true; }
219        float IntersectionComplexity() { return 1; }
220 
221        int NumberOfFaces() const { return 6; };
222       
223  int GetRandomSurfacePoint(GtpVisibilityPreprocessor::Vector3 &point,
224                                                          GtpVisibilityPreprocessor::Vector3 &normal)
225        {
226                // TODO
227                return 0;
228        }
229
230        int GetRandomVisibleSurfacePoint(GtpVisibilityPreprocessor::Vector3 &point,
231                                                                         GtpVisibilityPreprocessor::Vector3 &normal,
232                                                                         const GtpVisibilityPreprocessor::Vector3 &viewpoint,
233                                                                         const int maxTries)
234        {
235                // TODO
236                return 0;
237        }
238 
239        int Type() const
240        {
241                return Intersectable::BVH_INTERSECTABLE;
242        }
243
244        ostream &Describe(ostream &s) { return s; }
245
246        ///////////////////////////////////
247
248        float mRenderCost;
249
250protected:
251       
252        /// the bounding box of the node
253        AxisAlignedBox3 mBoundingBox;
254        /// parent of this node
255        BvhInterior *mParent;
256        int mTimeStamp;
257};
258
259
260/** BSP interior node implementation
261*/
262class BvhInterior: public BvhNode
263{
264public:
265        /** Standard contructor taking a bounding box as argument.
266        */
267        BvhInterior(const AxisAlignedBox3 &bbox);
268        BvhInterior(const AxisAlignedBox3 &bbox, BvhInterior *parent);
269
270        ~BvhInterior();
271        /** @return false since it is an interior node
272        */
273        bool IsLeaf() const;
274       
275        BvhNode *GetBack() { return mBack; }
276        BvhNode *GetFront() { return mFront; }
277
278        /** Replace front or back child with new child.
279        */
280        void ReplaceChildLink(BvhNode *oldChild, BvhNode *newChild);
281
282        /** Replace front and back child.
283        */
284        void SetupChildLinks(BvhNode *front, BvhNode *back);
285
286        friend ostream &operator<<(ostream &s, const BvhInterior &A)
287        {
288                return s << A.mBoundingBox;
289        }
290
291        virtual void CollectObjects(ObjectContainer &objects);
292
293protected:
294
295        /// back node
296        BvhNode *mBack;
297        /// front node
298        BvhNode *mFront;
299};
300
301
302/** BSP leaf node implementation.
303*/
304class BvhLeaf: public BvhNode
305{
306public:
307        /** Standard contructor taking a bounding box as argument.
308        */
309        BvhLeaf(const AxisAlignedBox3 &bbox);
310        BvhLeaf(const AxisAlignedBox3 &bbox, BvhInterior *parent);
311        BvhLeaf(const AxisAlignedBox3 &bbox, BvhInterior *parent, const int numObjects);
312
313        ~BvhLeaf();
314
315        /** @return true since it is an interior node
316        */
317        bool IsLeaf() const;
318       
319        SubdivisionCandidate *GetSubdivisionCandidate()// const
320        {
321                return mSubdivisionCandidate;
322        }
323
324        void SetSubdivisionCandidate(SubdivisionCandidate *candidate)
325        {
326                mSubdivisionCandidate = candidate;
327        }
328       
329        virtual void CollectObjects(ObjectContainer &objects);
330
331        /** Returns level of the hierarchy that is "active" right now.
332        */
333        BvhNode *GetActiveNode()
334        {
335                return mActiveNode;
336        }
337
338        /** Returns level of the hierarchy that is "active" right now.
339        */
340        void SetActiveNode(BvhNode *node)
341        {
342                mActiveNode = node;
343        }
344
345public:
346  // gl list use to store the geometry on the gl server
347  int mGlList;
348 
349  /// objects
350  ObjectContainer mObjects;
351 
352 
353protected:
354 
355  /// pointer to a split plane candidate splitting this leaf
356  SubdivisionCandidate *mSubdivisionCandidate;
357 
358  /// the active node which will be accounted for in the pvs
359  BvhNode *mActiveNode;
360};
361
362
363/** View Space Partitioning tree.
364*/
365class BvHierarchy
366{
367        friend class ViewCellsParseHandlers;
368        friend class HierarchyManager;
369
370protected:
371        struct SortableEntry;
372        typedef vector<SortableEntry> SortableEntryContainer;
373
374public:
375       
376        /** Additional data which is passed down the BSP tree during traversal.
377        */
378        class BvhTraversalData
379        { 
380        public:
381               
382                BvhTraversalData():
383                mNode(NULL),
384                mDepth(0),
385                mMaxCostMisses(0),
386                mAxis(0),
387                mNumRays(0),
388                mCorrectedPvs(0),
389                mPvs(0),
390                mCorrectedVolume(0),
391                mVolume(0)
392                {
393                        for (int i = 0; i < 4; ++ i)
394                                mSortedObjects[i] = NULL;
395                }
396               
397                BvhTraversalData(BvhLeaf *node,
398                                                 const int depth,
399                                                 const float v,
400                                                 const int numRays):
401                mNode(node),
402                mDepth(depth),
403                mMaxCostMisses(0),
404                mAxis(0),
405                mNumRays(numRays),
406                mCorrectedPvs(0),
407                mPvs(0),
408                mCorrectedVolume(0),
409                mVolume(v)
410                {
411                        for (int i = 0; i < 4; ++ i)
412                                mSortedObjects[i] = NULL;
413                }
414
415                /** Deletes contents and sets them to NULL.
416                */
417                void Clear()
418                {
419                        DEL_PTR(mNode);
420                        for (int i = 0; i < 4; ++ i)
421                                DEL_PTR(mSortedObjects[i]);
422                }
423
424                /// the current node
425                BvhLeaf *mNode;
426                /// current depth
427                int mDepth;
428                /// the volume of the node
429                float mVolume;
430                /// the corrected volume
431                float mCorrectedVolume;
432                /// how often this branch has missed the max-cost ratio
433                int mMaxCostMisses;
434                /// current axis
435                int mAxis;
436                /// number of rays
437                int mNumRays;
438                /// parent Pvs;
439                float mPvs;
440                /// parent pvs correction factor
441                float mCorrectedPvs;
442
443                /// the sorted objects for the three dimensions
444                ObjectContainer *mSortedObjects[4];             
445    };
446
447
448        /** Candidate for a object space split.
449        */
450        class BvhSubdivisionCandidate: public SubdivisionCandidate
451        { 
452        public:
453
454        BvhSubdivisionCandidate(const BvhTraversalData &tData): mParentData(tData)
455                {};
456
457                ~BvhSubdivisionCandidate()
458                {
459                        mParentData.Clear();
460                }
461
462                int Type() const { return OBJECT_SPACE; }
463       
464                void EvalCandidate(bool computeSplitplane = true)
465                {
466            mDirty = false;
467                        sBvHierarchy->EvalSubdivisionCandidate(*this, computeSplitplane);
468                }
469
470                bool Apply(SplitQueue &splitQueue, bool terminationCriteriaMet)
471                {
472                        BvhNode *n = sBvHierarchy->Subdivide(splitQueue, this, terminationCriteriaMet);
473
474                        // local or global termination criteria failed
475                        return !n->IsLeaf();           
476                }
477
478                void CollectDirtyCandidates(SubdivisionCandidateContainer &dirtyList,
479                                                                        const bool onlyUnmailed)
480                {
481                        sBvHierarchy->CollectDirtyCandidates(this, dirtyList, onlyUnmailed);
482                }
483
484                bool GlobalTerminationCriteriaMet() const
485                {
486                        return sBvHierarchy->GlobalTerminationCriteriaMet(mParentData);
487                }
488
489                BvhSubdivisionCandidate(const ObjectContainer &frontObjects,
490                                                                const ObjectContainer &backObjects,
491                                                                const BvhTraversalData &tData):
492                mFrontObjects(frontObjects), mBackObjects(backObjects), mParentData(tData)
493                {}
494
495                float GetPriority() const
496                {
497                        return mPriority;
498                }
499
500                /////////////////////////////7
501
502                /// pointer to parent tree.
503                static BvHierarchy *sBvHierarchy;
504
505                /// parent data
506                BvhTraversalData mParentData;
507                /// the objects on the front of the potential split
508                ObjectContainer mFrontObjects;
509                /// the objects on the back of the potential split
510                ObjectContainer mBackObjects;
511                       
512                float mCorrectedFrontPvs;
513                float mCorrectedBackPvs;
514
515                float mCorrectedFrontVolume;
516                float mCorrectedBackVolume;
517        };
518
519        /** Struct for traversing line segment.
520        */
521        struct LineTraversalData
522        {
523                BvhNode *mNode;
524                Vector3 mExitPoint;
525               
526                float mMaxT;
527   
528                LineTraversalData () {}
529                LineTraversalData (BvhNode *n, const Vector3 &p, const float maxt):
530                mNode(n), mExitPoint(p), mMaxT(maxt) {}
531        };
532
533
534        /** Default constructor creating an empty tree.
535        */
536        BvHierarchy();
537
538        /** Default destructor.
539        */
540        ~BvHierarchy();
541
542        /** Returns tree statistics.
543        */
544        const BvhStatistics &GetStatistics() const;
545 
546        /** Returns bounding box of the specified node.
547        */
548        AxisAlignedBox3 GetBoundingBox(BvhNode *node) const;
549
550        /** Reads parameters from environment singleton.
551        */
552        void ReadEnvironment();
553
554        /** Evaluates candidate for splitting.
555        */
556        void EvalSubdivisionCandidate(BvhSubdivisionCandidate &splitData,
557                                                                  bool computeSplitPlane = true);
558
559        /** Returns vector of leaves.
560        */
561        void CollectLeaves(BvhNode *root, vector<BvhLeaf *> &leaves) const;
562
563        /** Returns bounding box of the whole tree (= bbox of root node)
564        */
565        AxisAlignedBox3 GetBoundingBox()const;
566
567        /** Returns root of the view space partitioning tree.
568        */
569        BvhNode *GetRoot() const;
570
571        /** finds neighbouring leaves of this tree node.
572        */
573        int FindNeighbors(BvhLeaf *n,
574                                          vector<BvhLeaf *> &neighbors,
575                                          const bool onlyUnmailed) const;
576
577        /** Returns random leaf of BSP tree.
578                @param halfspace defines the halfspace from which the leaf is taken.
579        */
580        BvhLeaf *GetRandomLeaf(const Plane3 &halfspace);
581
582        /** Returns random leaf of BSP tree.
583                @param onlyUnmailed if only unmailed leaves should be returned.
584        */
585        BvhLeaf *GetRandomLeaf(const bool onlyUnmailed = false);
586
587        /** Casts line segment into the tree.
588                @param origin the origin of the line segment
589                @param termination the end point of the line segment
590                @returns view cells intersecting the line segment.
591        */
592    int CastLineSegment(const Vector3 &origin,
593                                                const Vector3 &termination,
594                                                ViewCellContainer &viewcells);
595               
596        /** Sets pointer to view cells manager.
597        */
598        void SetViewCellsManager(ViewCellsManager *vcm);
599
600        float GetViewSpaceVolume() const;
601        /** Writes tree to output stream
602        */
603        bool Export(OUT_STREAM &stream);
604
605        /** Collects rays associated with the objects.
606        */
607        void CollectRays(const ObjectContainer &objects, VssRayContainer &rays) const;
608
609        /** Intersects box with the tree and returns the number of intersected boxes.
610                @returns number of view cells found
611        */
612        int ComputeBoxIntersections(const AxisAlignedBox3 &box,
613                                                                ViewCellContainer &viewCells) const;
614
615        /** Returns leaf the point pt lies in, starting from root.
616        */
617        BvhLeaf *GetLeaf(Intersectable *obj, BvhNode *root = NULL) const;
618
619        /** Sets a pointer to the view cells tree.
620        */
621        ViewCellsTree *GetViewCellsTree() const { return mViewCellsTree; }
622       
623        /** See Get
624        */
625        void SetViewCellsTree(ViewCellsTree *vt) { mViewCellsTree = vt; }
626
627        /** Returns estimated memory usage of tree.
628        */
629        float GetMemUsage() const;
630
631        /** Sets this node to be an active node.
632        */
633        void SetActive(BvhNode *node) const;
634
635
636        ///////////////////////////
637        // hacks in order to provide interleaved heurisitcs
638
639        BvhNode *SubdivideAndCopy(SplitQueue &tQueue, SubdivisionCandidate *splitCandidate);
640
641        /////////////////////////////////
642
643        static float EvalAbsCost(const ObjectContainer &objects);
644
645        float EvalProb(const ObjectContainer &objects) const;
646
647        void CollectObjects(const AxisAlignedBox3 &box, ObjectContainer &objects);
648
649        float GetRenderCostIncrementially(BvhNode *node) const;
650
651        void Compress();
652        void CreateUniqueObjectIds();
653
654protected:
655
656        /** Returns true if tree can be terminated.
657        */
658        bool LocalTerminationCriteriaMet(const BvhTraversalData &data) const;
659
660        /** Returns true if global tree can be terminated.
661        */
662        bool GlobalTerminationCriteriaMet(const BvhTraversalData &data) const;
663
664        /** For sorting the objects during the heuristics
665        */
666        struct SortableEntry
667        {
668                Intersectable *mObject;
669                float mPos;
670
671                SortableEntry() {}
672
673                SortableEntry(Intersectable *obj, const float pos):
674                mObject(obj), mPos(pos)
675                {}
676
677                bool operator<(const SortableEntry &b) const
678                {
679                        return mPos < b.mPos;
680                }
681        };
682
683        /** Evaluate balanced object partition.
684        */
685        float EvalLocalObjectPartition(const BvhTraversalData &tData,
686                                                                   const int axis,
687                                                                   ObjectContainer &objectsFront,
688                                                                   ObjectContainer &objectsBack);
689
690        /** Evaluate surface area heuristic for the node.
691        */
692        float EvalSah(const BvhTraversalData &tData,
693                                  const int axis,
694                                  ObjectContainer &objectsFront,
695                                  ObjectContainer &objectsBack);
696
697
698        /** Evaluates render cost of the bv induced by these objects
699        */
700        float EvalRenderCost(const ObjectContainer &objects) const;
701
702        /** Evaluates tree stats in the BSP tree leafs.
703        */
704        void EvaluateLeafStats(const BvhTraversalData &data);
705
706        /** Subdivides node using a best split priority queue.
707            @param tQueue the best split priority queue
708                @param splitCandidate the candidate for the next split
709                @param globalCriteriaMet if the global termination criteria were already met
710                @returns new root of the subtree
711        */
712        BvhNode *Subdivide(SplitQueue &tQueue,
713                                           SubdivisionCandidate *splitCandidate,
714                                           const bool globalCriteriaMet);
715       
716        /** Subdivides leaf.
717                @param sc the subdivisionCandidate holding all necessary data for subdivision           
718               
719                @param frontData returns the traversal data for the front node
720                @param backData returns the traversal data for the back node
721
722                @returns the new interior node = the of the subdivision
723        */
724        BvhInterior *SubdivideNode(const BvhSubdivisionCandidate &sc,
725                                                           BvhTraversalData &frontData,
726                                                           BvhTraversalData &backData);
727
728        /** Splits the objects for the next subdivision.
729                @returns cost for this split
730        */
731        float SelectObjectPartition(const BvhTraversalData &tData,
732                                                                ObjectContainer &frontObjects,
733                                                                ObjectContainer &backObjects,
734                                                                bool useVisibilityBasedHeuristics);
735       
736        /** Writes the node to disk
737                @note: should be implemented as visitor.
738        */
739        void ExportNode(BvhNode *node, OUT_STREAM &stream);
740
741        /** Exports objects associated with this leaf.
742        */
743        void ExportObjects(BvhLeaf *leaf, OUT_STREAM &stream);
744
745        /** Associates the objects with their bvh leaves.
746        */
747        static void AssociateObjectsWithLeaf(BvhLeaf *leaf);
748
749
750        /////////////////////////////
751        // Helper functions for local cost heuristics
752       
753        /** Prepare split candidates for cost heuristics using axis aligned splits.
754                @param node the current node
755                @param axis the current split axis
756        */
757        void PrepareLocalSubdivisionCandidates(const BvhTraversalData &tData,
758                                                                                   const int axis);
759
760        static void CreateLocalSubdivisionCandidates(const ObjectContainer &objects,
761                                                                                                 SortableEntryContainer **subdivisionCandidates,
762                                                                                                 const bool sort,
763                                                                                                 const int axis);
764
765        float EvalPriority(const BvhSubdivisionCandidate &splitCandidate,
766                                           const float renderCostDecr,
767                                           const float oldRenderCost) const;
768
769        /** Computes object partition with the best cost according to the heurisics.
770                @param tData the traversal data
771                @param axis the split axis
772                @param objectsFront the objects in the front child bv
773                @param objectsBack the objects in the back child bv
774                @param backObjectsStart the iterator marking the position where the back objects begin
775
776                @returns relative cost (relative to parent cost)
777        */
778        float EvalLocalCostHeuristics(const BvhTraversalData &tData,
779                                                                  const int axis,
780                                                                  ObjectContainer &objectsFront,
781                                                                  ObjectContainer &objectsBack);
782
783        /** Evaluates the contribution to the front and back volume
784                when this object is changing sides in the bvs.
785
786                @param object the object
787                @param volLeft updates the left pvs
788                @param volPvs updates the right pvs
789        */
790        void EvalHeuristicsContribution(Intersectable *obj,
791                                                                        float &volLeft,
792                                                                        float &volRight);
793
794        /** Prepares objects for the cost heuristics.
795                @returns sum of volume of associated view cells
796        */
797        float PrepareHeuristics(const BvhTraversalData &tData, const int axis);
798       
799        /** Evaluates cost for a leaf given the surface area heuristics.
800        */
801        float EvalSahCost(BvhLeaf *leaf) const;
802
803        ////////////////////////////////////////////////
804
805
806        /** Prepares construction for vsp and osp trees.
807        */
808        AxisAlignedBox3 EvalBoundingBox(const ObjectContainer &objects,
809                                                                        const AxisAlignedBox3 *parentBox = NULL) const;
810
811        /** Collects list of invalid candidates. Candidates
812                are invalidated by a view space subdivision step
813                that affects this candidate.
814        */
815        void CollectDirtyCandidates(BvhSubdivisionCandidate *sc,
816                                                                vector<SubdivisionCandidate *> &dirtyList,
817                                                                const bool onlyUnmailed);
818
819        /** Collect view cells which see this bvh leaf.
820        */
821        int CollectViewCells(const ObjectContainer &objects,
822                                                 ViewCellContainer &viewCells,
823                                                 const bool setCounter,
824                                                 const bool onlyUnmailedRays) const;
825
826        /** Collects view cells which see an object.
827                @param useMailBoxing if mailing should be used and
828                only unmailed object should pass
829                @param setCounter counter for the sweep algorithm
830                @param onlyUnmailedRays if only unmailed rays should be considered
831        */
832        int CollectViewCells(Intersectable *object,
833                                                 ViewCellContainer &viewCells,
834                                                 const bool useMailBoxing,
835                                                 const bool setCounter,
836                                                 const bool onlyUnmailedRays) const;
837
838        /** Counts the view cells of this object. note: only
839                counts unmailed objects.
840        */
841        int CountViewCells(Intersectable *obj) const;
842
843        /** Counts the view cells seen by this bvh leaf
844        */
845        int CountViewCells(const ObjectContainer &objects) const;
846
847        /** Evaluates increase in pvs size.
848        */
849        int EvalPvsEntriesIncr(BvhSubdivisionCandidate &splitCandidate, const float avgRayContri) const;
850
851        /** Rays will be clipped to the bounding box.
852        */
853        void PreprocessRays(BvhLeaf *root,
854                                                const VssRayContainer &sampleRays,
855                                                RayInfoContainer &rays);
856
857        /** Print the subdivision stats in the subdivison log.
858        */
859        void PrintSubdivisionStats(const SubdivisionCandidate &tData);
860
861        /** Prints out the stats for this subdivision.
862        */
863        void AddSubdivisionStats(const int viewCells,
864                                                         const float renderCostDecr,
865                                                         const float totalRenderCost);
866
867        /** Stores rays with objects that see the rays.
868        */
869        int AssociateObjectsWithRays(const VssRayContainer &rays) const;
870
871        /** Tests if object is in this leaf.
872                @note: assumes that objects are sorted by their id.
873        */
874        bool IsObjectInLeaf(BvhLeaf *, Intersectable *object) const;
875
876        /** Prepares the construction of the bv hierarchy and returns
877                the first subdivision candidate.
878        */
879        void PrepareConstruction(SplitQueue &tQueue,
880                                                         const VssRayContainer &sampleRays,
881                                                         const ObjectContainer &objects);
882
883        /** Resets bv hierarchy. E.g. deletes root and resets stats.
884        */
885        void Reset(SplitQueue &tQueue,
886                           const VssRayContainer &rays,
887                           const ObjectContainer &objects);
888
889        /** Evaluates volume of view cells that see the objects.
890        */
891        float EvalViewCellsVolume(const ObjectContainer &objects) const;
892
893        /** Assigns or newly creates initial list of sorted objects.
894        */
895        void AssignInitialSortedObjectList(BvhTraversalData &tData,
896                                                                           const ObjectContainer &objects);
897
898        /** Assigns sorted objects to front and back data.
899        */
900        void AssignSortedObjects(const BvhSubdivisionCandidate &sc,
901                                                         BvhTraversalData &frontData,
902                                                         BvhTraversalData &backData);
903       
904        /** Creates new root of hierarchy and computes bounding box.
905                Has to be called before the preparation of the subdivision.
906        */
907        void Initialise(const ObjectContainer &objects);
908
909
910        ////////////////////
911        // initial subdivision
912
913        /** Makes an initial parititon of the object space based on
914                some criteria (size, shader)
915        */
916        void ApplyInitialSubdivision(SubdivisionCandidate *firstCandidate,
917                                                                 vector<SubdivisionCandidate *> &candidateContainer);
918
919        void ApplyInitialSplit(const BvhTraversalData &tData,
920                                                   ObjectContainer &frontObjects,
921                                                   ObjectContainer &backObjects);
922
923        bool InitialTerminationCriteriaMet(const BvhTraversalData &tData) const;
924
925
926protected:
927       
928        /// pre-sorted subdivision candidtes for all three directions.
929        vector<SortableEntry> *mGlobalSubdivisionCandidates[3];
930        /// pointer to the hierarchy of view cells
931        ViewCellsTree *mViewCellsTree;
932        /// The view cells manager
933        ViewCellsManager *mViewCellsManager;
934        /// candidates for placing split planes during cost heuristics
935        vector<SortableEntry> *mSubdivisionCandidates;
936        /// Pointer to the root of the tree
937        BvhNode *mRoot;
938        /// Statistics for the object space partition
939        BvhStatistics mBvhStats;       
940        /// box around the whole view domain
941        AxisAlignedBox3 mBoundingBox;
942        /// the hierarchy manager
943        HierarchyManager *mHierarchyManager;
944
945
946        ////////////////////
947        //-- local termination criteria
948
949        /// maximal possible depth
950        int mTermMaxDepth;
951        /// mininum probability
952        float mTermMinProbability;
953        /// minimal number of objects
954        int mTermMinObjects;
955        /// maximal acceptable cost ratio
956        float mTermMaxCostRatio;
957        /// tolerance value indicating how often the max cost ratio can be failed
958        int mTermMissTolerance;
959        /// minimum number of rays
960        int mTermMinRays;
961
962
963        ////////////////////
964        //-- global termination criteria
965
966        /// the minimal accepted global cost ratio
967        float mTermMinGlobalCostRatio;
968        //// number of accepted misses of the global cost ratio
969        int mTermGlobalCostMissTolerance;
970        /// maximal number of view cells
971        int mTermMaxLeaves;
972        /// maximal tree memory
973        float mMaxMemory;
974        /// the tree is out of memory
975        bool mOutOfMemory;
976
977
978        ////////////////////////////////////////
979        //-- split heuristics based parameters
980       
981        /// if a heuristics should be used for finding a split plane
982    bool mUseCostHeuristics;
983        /// if sah heuristcs should be used for finding a split plane
984        bool mUseSah;
985    /// balancing factor for PVS criterium
986        float mCtDivCi;
987        /// if only driving axis should be used for split
988        bool mOnlyDrivingAxis;
989        /// current time stamp (used for keeping split history)
990        int mTimeStamp;
991        // if rays should be stored in leaves
992        bool mStoreRays;
993        // subdivision stats output file
994        ofstream  mSubdivisionStats;
995        /// keeps track of cost during subdivision
996        float mTotalCost;
997        int mPvsEntries;
998        /// keeps track of overall pvs size during subdivision
999        int mTotalPvsSize;
1000        /// number of currenly generated view cells
1001        int mCreatedLeaves;
1002        /// represents min and max band for sweep
1003        float mSplitBorder;
1004        /// weight between render cost decrease and node render cost
1005        float mRenderCostDecreaseWeight;
1006
1007        /// if the objects should be sorted in one global step
1008        bool mUseGlobalSorting;
1009
1010        bool mUseBboxAreaForSah;
1011
1012        //SortableEntryContainer *mSortedObjects[4];
1013
1014        int mMinRaysForVisibility;
1015
1016        /// constant value for driving the heuristics
1017        float mMemoryConst;
1018
1019        int mMaxTests;
1020
1021        bool mIsInitialSubdivision;
1022
1023        bool mApplyInitialPartition;
1024       
1025        int mInitialMinObjects;
1026        float mInitialMaxAreaRatio;
1027        float mInitialMinArea;
1028};
1029
1030}
1031
1032#endif
Note: See TracBrowser for help on using the repository browser.