source: GTP/trunk/Lib/Vis/Preprocessing/src/ViewCellsManager.h @ 2542

Revision 2542, 38.6 KB checked in by mattausch, 17 years ago (diff)
Line 
1#ifndef _ViewCellsManager_H__
2#define _ViewCellsManager_H__
3
4#include "Ray.h"
5#include "SimpleRay.h"
6#include "VssRay.h"
7#include "Containers.h"
8#include "ViewCell.h"
9
10#define TEST_PACKETS 0
11
12namespace GtpVisibilityPreprocessor {
13
14class ViewCell;
15class Intersectable;
16class RenderSimulator;
17class Renderer;
18class Mesh;
19struct Triangle3;
20class SimulationStatistics;
21class BspTree;
22class KdTree;
23class VspOspTree;
24class VspBspTree;
25class KdNode;
26class KdLeaf;
27class AxisAlignedBox3;
28class BspLeaf;
29class ViewCellsStatistics;
30class Exporter;
31class Beam;
32class Preprocessor;
33class ViewCellsTree;
34class MergeCandidate;
35class BoundingBoxConverter;
36class VspTree;
37class OspTree;
38class VspNode;
39class HierarchyManager;
40class BvHierarchy;
41class ViewCellsTree;
42class ViewCell;
43class MixtureDistribution;
44struct AxisAlignedPlane;
45struct BspRay;
46class BspTree;
47
48
49
50struct PvsFilterStatistics
51{
52        PvsFilterStatistics():
53        mAvgFilterRadius(0.0f), mLocalFilterCount(0), mGlobalFilterCount(0) {}
54       
55        float mAvgFilterRadius;
56        int mLocalFilterCount;
57        int mGlobalFilterCount;
58};
59
60/** Probably Visible Set
61*/
62class PrVs
63{
64public:
65        /// root of view cells tree
66        ViewCell *mViewCell;
67        // input parameter is the render budget for the PrVs
68        float mRenderBudget;
69};
70
71
72class LocalMergeNode
73{
74public:
75        virtual ~LocalMergeNode() {};
76        virtual bool IsLeaf() const = 0;
77};
78
79typedef pair<ViewCell *, SimpleRayContainer> ViewCellPoints;
80
81/**     Manages different higher order operations on the view cells.
82*/
83class ViewCellsManager
84{
85public:
86
87        struct PerViewCellStat
88        {
89                float pvsSize;
90                float relPvsIncrease;
91        };
92
93        struct SamplesStatistics
94        {
95                int mRays;
96                int mViewCells;
97                int mContributingRays;
98                int mPvsContributions;
99                void Reset()
100                {
101                        mRays = 0;
102                        mViewCells = 0;
103                        mContributingRays = 0;
104                        mPvsContributions = 0;
105                };
106        };
107
108        struct PvsStatistics
109        {
110                float minPvs;
111                float maxPvs;
112                float avgPvs;
113                float renderCost;
114                float avgPvsEntries;
115
116                float avgFilteredPvs;
117                float avgFilteredPvsEntries;
118
119                float avgFilterContribution;
120                float avgFilterRadius;
121                float avgFilterRatio;
122                float avgRelPvsIncrease;
123                float devRelPvsIncrease;
124                int viewcells;
125
126                float mem;
127                float renderCostRatio;
128        };
129 
130        /// view cell container types
131        enum {BSP, KD, VSP_KD, VSP_BSP, VSP_OSP};
132 
133        /// render cost evaluation type
134        enum {PER_OBJECT, PER_TRIANGLE};
135
136        friend class X3dViewCellsParseHandlers;
137
138        /** Default constructor.
139        */
140        ViewCellsManager(ViewCellsTree *viewCellsTree);
141        /** Destructor.
142        */
143        virtual ~ViewCellsManager();
144        /** Constructs view cells container taking a preprocessor
145                @returns the output rays (if not null)
146        */
147        int Construct(Preprocessor *preprocessor, VssRayContainer *outRays = NULL);
148
149        /** Constructs view cell container with a given number of samples.
150        */
151        virtual int ConstructSubdivision(const ObjectContainer &objects,
152                                                                         const VssRayContainer &rays) = 0;
153
154        /** Computes sample contributions of the rays to the view cells PVS.
155       
156                @param rays bundle of rays used to find intersections with view cells and
157                adding the contribution
158                @param addRays true if rays should be added to the PVSs of the viewcells they
159                intersect
160                @param storeViewCells true if view cells should be stored in the ray
161        */
162        virtual float ComputeSampleContributions(const VssRayContainer &rays,
163                                                     const bool addContributions,
164                                                                                         const bool storeViewCells,
165                                                                                         const bool useHitObject = false);
166
167        /** Computes sample contribution of a simgle ray to the view cells PVS.
168                @param ray finds intersections with view cells and holds the contribution
169                @param addSample if sample should be added to the pvs
170                 
171                @returns number of sample contributions
172        */
173        virtual float ComputeSampleContribution(VssRay &ray,
174                                                                                        const bool addContributions,
175                                                                                        const bool storeViewCells,
176                                                                                        const bool useHitObject = false);
177        /** Compute sample contribution only for current view cell.
178        */
179        virtual float ComputeSampleContribution(VssRay &ray,
180                                                                                        const bool addContributions,
181                                                                                        ViewCell *currentViewCell,
182                                                                                        const bool useHitObject = false);
183        /** Prints out statistics of the view cells.
184        */
185        virtual void PrintStatistics(std::ostream &s) const;
186        /** Post processes view cells givemŽa number of rays.
187        */
188        virtual int PostProcess(const ObjectContainer &objects,
189                                                        const VssRayContainer &rays) = 0;
190        /** Show visualization of the view cells.
191        */
192        virtual void Visualize(const ObjectContainer &objects,
193                                                   const VssRayContainer &sampleRays) = 0;
194        /** collect objects intersecting a given spatial box.
195        */
196        virtual void CollectObjects(const AxisAlignedBox3 &box, ObjectContainer &objects);
197        /** type of the view cell container.
198        */
199        virtual int GetType() const = 0;
200        /** Load the input viewcells. The input viewcells should be given as a collection
201                of meshes. Each mesh is assume to form a bounded polyhedron
202                defining the interior of the viewcell. The view cells manager
203                is responsible for building a hierarchy over these view cells.
204               
205                @param filename file to load
206                @return true on success
207        */
208        virtual bool LoadViewCellsGeometry(const string filename, const bool extrudeBaseTriangle);
209        /** Merges two view cells.
210                @note the piercing rays of the front and back will be ordered   
211                @returns new view cell based on the merging.
212        */
213        ViewCellInterior *MergeViewCells(ViewCell *front, ViewCell *back) const;
214        /** Merges a container of view cells.
215                @returns new view cell based on the merging.
216        */
217        ViewCellInterior *MergeViewCells(ViewCellContainer &children) const;
218        /** Generates view cell of the type specified by this manager
219        */
220        virtual ViewCell *GenerateViewCell(Mesh *mesh = NULL) const = 0;
221        /** Constructs view cell from base triangle.
222                The view cell is extruded along the normal vector.
223                @param the base triangle
224                @param the height of the newly created view cell
225        */
226        ViewCell *ExtrudeViewCell(const Triangle3 &baseTri, const float height) const;
227        /** Returns the intersectable that was hit by the ray.
228        */
229        virtual Intersectable *GetIntersectable(const VssRay &ray, const bool isTermination) const;
230        /** Sets maximal number of samples used for the
231                construction of the view cells.
232        */
233        void SetVisualizationSamples(const int visSamples);
234        /** Sets maximal number of samples used for the construction of the view cells.
235        */
236        void SetConstructionSamples(const int constructionSamples);
237        /** Sets maximal number of samples used for the visualization of the view cells.
238        */
239        void SetInitialSamples(const int initialSamples);
240        /** Sets maximal number of samples used for the post processing of the view cells.
241        */
242        void SetPostProcessSamples(const int postProcessingSamples);
243        /** See set.
244        */
245        int GetVisualizationSamples() const;
246        /** See set.
247        */
248        int GetConstructionSamples() const;
249        /** See set.
250        */
251        int GetPostProcessSamples() const;
252        /** Returns true if view cells are already constructed.
253        */
254        virtual bool ViewCellsConstructed() const = 0;
255        /** cast line segment to get a list of unique viewcells which are intersected
256                by this line segment
257        */
258        virtual int CastLineSegment(const Vector3 &origin,
259                                                            const Vector3 &termination,
260                                                            ViewCellContainer &viewcells) = 0;
261        /** Tests if this line segment intersects a particular view cell.
262        */
263        virtual bool LineSegmentIntersects(const Vector3 &origin,
264                                                                           const Vector3 &termination,
265                                                                           ViewCell *viewCell) = 0;
266        /** Returns a stats about the global pvs.
267        */
268        virtual void GetPvsStatistics(PvsStatistics &stat);
269        /** Returns the probably visible set of the view space filtered pvs.
270        */
271        virtual void GetPrVS(const Vector3 &viewPoint, PrVs &prvs, const float filterWidth);
272        /** Get a viewcell containing the specified view point.
273                @param active if the active or elementary view cell should be returned.
274        */
275        virtual ViewCell *GetViewCell(const Vector3 &point, const bool active = false) const = 0;
276        /** Returns the view cell with the given index (different from the id).
277        */
278        ViewCell *GetViewCell(const int idx) const {return mViewCells[idx];}
279        /** Prints the statistics over the view cell pvss.
280        */
281        virtual void PrintPvsStatistics(std::ostream &s);
282        /** Updates pvs of the view cell hierarchy if necessary.
283        */
284        void UpdatePvs();
285        /** Returns probability that view point lies in one view cell.
286        */
287        virtual float GetProbability(ViewCell *viewCell) = 0;
288        /** Returns render cost of a single view cell given the render cost of an object.
289        */
290        float GetRendercost(ViewCell *viewCell) const;
291        /** Returns reference to container of loaded / generated view cells.
292        */
293        ViewCellContainer &GetViewCells();
294        /** Helper function used to split ray sets uniformly
295                into one that is currently used and the other that
296                is saved for later processing.
297                @param sourceRays the input ray set
298                @param maxSize the maximal number of rays that will be used
299                @param usedRays returns the used ray set
300                @param savedRays if not null, returns the saved ray set
301        */
302        void GetRaySets(const VssRayContainer &sourceRays,
303                                        const int maxSize,
304                                        VssRayContainer &usedRays,
305                                        VssRayContainer *savedRays = NULL) const;
306        /** Returns accumulated area of all view cells.
307        */
308        float GetAccVcArea();
309        /** Returns area of one view cell.
310        */
311        virtual float GetArea(ViewCell *viewCell) const;
312        /** Returns volume of view cell.
313        */
314        virtual float GetVolume(ViewCell *viewCell) const;
315        /** Sets the current renderer mainly for view cells statistics.
316        */
317        void SetRenderer(Renderer *renderer);
318        /** Computes a (random) view point in the valid view space.
319                @returns true if valid view point was found
320        */
321        virtual bool GetViewPoint(Vector3 &viewPoint) const;
322        /** Returns the current view point given a vector for activating the halton sequence.
323        */
324        virtual bool GetViewPoint(Vector3 &viewPoint, const Vector3 &params) const;
325        /** Returns true if this view point is in the valid view space.
326        */
327        virtual bool ViewPointValid(const Vector3 &viewPoint) const;
328        /** Sets a view space boundary.
329        */
330        void SetViewSpaceBox(const AxisAlignedBox3 &box);
331        /** Returns the boundaries of the view space.
332        */
333        AxisAlignedBox3 GetViewSpaceBox() const;
334        /** Creates mesh for this view cell.
335        */
336        virtual void CreateMesh(ViewCell *vc) = NULL;
337        /** Writes view cells to disc.
338        */
339        virtual bool ExportViewCells(const string filename,
340                                                                 const bool exportPvs,
341                                                                 const ObjectContainer &objects);
342        /** Casts beam to collect view cells.
343        */
344        virtual int CastBeam(Beam &beam);
345        /** Checks if view cell is considered as valid.
346        */
347        virtual bool CheckValidity(ViewCell *vc,
348                                                           int minPvsSize,
349                                                           int maxPvsSize) const;
350        /** Resort pvss after a pass of the algorithm.
351        */
352        void  SortViewCellPvs();
353        /** Map the ray intersection objects from triangles to high level objects.
354        */
355        void DeterminePvsObjects(VssRayContainer &rays,
356                                                         const bool useHitObjects = false);
357        /** Sets validity of view cell
358        */
359        virtual void SetValidity(ViewCell *vc,
360                                                         int minPvsSize,
361                                                         int maxPvsSize) const;
362        /** sets validy of all viewcells
363        */
364        virtual void SetValidity(int minPvsSize, int maxPvsSize) const;
365        /** Set valid viewcells in the range of pvs. sorts the viewcells
366                according to the pvs and then pickups those in the ranges
367        */
368        void SetValidityPercentage(const float minValid, const float maxValid);
369        /** Returns number of valid view cells.
370        */
371    int CountValidViewcells() const;
372        /** Returns maximal allowed pvs size.
373        */
374        int GetMaxPvsSize() const;
375        /** Returns maximal allowed pvs size.
376        */
377        int GetMinPvsSize() const;
378        /** Returns maximal ratio. i.e., currentPVs / maxPvs,
379                where pvs is still considered valid.
380        */
381        float GetMaxPvsRatio() const;
382        /** Exports view cell geometry.
383        */
384        virtual void ExportViewCellGeometry(Exporter *exporter,
385                                                                                ViewCell *vc,
386                                                                                const AxisAlignedBox3 *box,
387                                                                                const AxisAlignedPlane *clipPlane = NULL
388                                                                                ) const = 0;
389        /** Brings the view cells into their final state, computes meshes and volume.
390        */
391        virtual void FinalizeViewCells(const bool createMesh);
392        /** Evaluates statistics values on view cells.
393        */
394        void EvaluateRenderStatistics(float &totalRenderCost,
395                                                                  float &expectedRenderCost,
396                                                                  float &deviation,
397                                                                  float &variance,
398                                                                  float &totalPvs,
399                                                                  float &avgRenderCost);
400        /** Returns hierarchy of the view cells.
401        */
402        ViewCellsTree *GetViewCellsTree();
403        /** Collect candidates for the view cell merge.
404        */
405        virtual void CollectMergeCandidates(const VssRayContainer &rays,
406                                                                                vector<MergeCandidate> &candidates);
407        /** Collects n view cells and stores it as the active view cells.
408        */
409        void CollectViewCells(const int n);
410        /** Sets current view cells set to active,
411                i.e., the sampling is done in this view cell set.
412        */
413        void SetViewCellsActive();
414        /** Evaluates render cost statistics of current view cell hierarchy.
415        */
416        virtual void EvalViewCellPartition();
417        /** Sets maximal size of a view cell filter.
418        */
419        void SetMaxFilterSize(const int size);
420        /** Returns maximal filter size.
421        */
422        int GetMaxFilterSize() const;
423        /** Deletes interior nodes from the tree which have negative
424                merge cost set (local merge).
425        */ 
426        void DeleteLocalMergeTree(ViewCell *vc) const;
427        /** Evaluautes histogram for a given number of view cells.
428        */
429        void EvalViewCellHistogram(const string filename, const int nViewCells);
430        /** Evaluautes histogram for a given number of view cells.
431        */
432        void EvalViewCellHistogramForPvsSize(const string filename,
433                                                                                 const int nViewCells);
434        /** Evaluautes histogram for a given vector of view cells.
435        */
436        void EvalViewCellHistogramForPvsSize(const string filename,
437                                                                                 ViewCellContainer &viewCells);
438        float ComputeRenderCost(const int tri, const int obj); //const
439        /** Sets pvs size of view cell as a scalar. Used when storing pvs only in the leaves
440                of the hierarchy.
441        */
442        void UpdateScalarPvsSize(ViewCell *vc,
443                                                         const float pvsCost,
444                                                         const int entriesInPvs) const;
445        /** Returns bounding box of a view cell.
446        */
447        AxisAlignedBox3 GetViewCellBox(ViewCell *vc);
448        /** Exports bounding boxes of objects to file.
449        */
450        bool ExportBoundingBoxes(const string filename,
451                                                         const ObjectContainer &objects) const;
452        /** Load the bounding boxes into the container.
453        */
454        bool LoadBoundingBoxes(const string filename,
455                                                  IndexedBoundingBoxContainer &boxes) const;
456        /** Returns true if pvs should be exported together with the view cells.
457        */
458        bool GetExportPvs() const;
459        /** Efficiently merges the view cells in the container.
460        */
461        void MergeViewCellsRecursivly(ObjectPvs &pvs,
462                                                                  const ViewCellContainer &viewCells) const;
463        /** Compresses the view cells.
464        */
465        virtual void CompressViewCells();
466        /** Returns view cell with the given id.
467        */
468        ViewCell *GetViewCellById(const int id);
469        /** Returns number of view cells.
470        */
471        int GetNumViewCells() const;
472
473        bool GenerateRandomViewCells(ViewCellContainer &viewCells,
474                                                                 const int numViewCells);
475
476        bool GenerateRandomViewCells(vector<ViewCellPoints *> &viewCells,
477                                                                 const int nViewCells,
478                                                                 const int nViewPoints);
479
480
481        bool GenerateViewPoints(ViewCell *viewCell,
482                                                        const int numViewPoints,
483                                                        SimpleRayContainer &viewPoints);
484
485        bool ImportRandomViewCells(const string &filename,
486                                                           vector<ViewCellPoints *> &viewCells);
487
488        bool ImportRandomViewCells(const string &filename);
489
490        bool ExportRandomViewCells(const string &filename,
491                                                           const vector<ViewCellPoints *> &viewCells);
492
493        bool ExportRandomViewCells(const string &filename);
494
495        bool GenerateViewPoint(ViewCell *viewCell, SimpleRay &ray);
496
497        bool IsValidViewSpace(ViewCell *vc);
498
499
500        //////////////
501        // static members
502       
503        /** Loads view cells from file. The view cells manager is created with
504                respect to the loaded view cells.
505
506                @param filename the filename of the view cells
507                @param objects the scene objects
508                @param finalizeViewCells if the view cells should be post processed, i.e.,
509                           a mesh is created representing the geometry
510                @param bconverter a conversion routine working with the similarities of bounding
511                           boxes: if there is a certain similarity of overlap between
512                           bounding boxes, two tested candidate objects are considered
513                           to be the same objects
514                @returns the view cells manager if loading was successful, false otherwise
515        */
516        static ViewCellsManager *LoadViewCells(const string &filename,
517                                                                                   ObjectContainer &pvsObjects,
518                                                                                   ObjectContainer &preprocessorObjects,
519                                                                                   bool finalizeViewCells = false,
520                                                                                   BoundingBoxConverter *bconverter = NULL);
521
522        /** Convenience function assuming that there are no preprocessor objects.
523        */
524        static ViewCellsManager *LoadViewCells(const string &filename,
525                                                                                   ObjectContainer &pvsObjects,
526                                                                                   bool finalizeViewCells = false,
527                                                                                   BoundingBoxConverter *bconverter = NULL);
528
529        ViewCellsManager *LoadViewCellsBin(const string &filename,
530                                           ObjectContainer &pvsObjects,
531                                                                           ObjectContainer &preprocessorObjects,
532                                                                           bool finalizeViewCells,
533                                                                           BoundingBoxConverter *bconverter);
534
535
536        ///////////////////////
537        //-- visiblity filter options
538
539        // TODO: write own visibiltiy filter class
540        void ApplyFilter(KdTree *kdTree,
541                                         const float viewSpaceFilterSize,
542                                         const float spatialFilterSize);
543
544        // new adaptive version of the filter
545        PvsFilterStatistics ApplyFilter2(ViewCell *viewCell,
546                                                                         const bool useViewSpaceFilter,
547                                                                         const float filterSize,
548                                                                         ObjectPvs &pvs,
549                                                                         vector<AxisAlignedBox3> *filteredBoxes = NULL);
550
551        void ApplySpatialFilter(KdTree *kdTree,
552                                                        const float spatialFilterSize,
553                                                        ObjectPvs &pvs);
554
555         void ApplyFilter(ViewCell *viewCell,
556                                          KdTree *kdTree,
557                                          const float viewSpaceFilterSize,
558                                          const float spatialFilterSize,
559                                          ObjectPvs &pvs);
560
561        float GetFilterWidth();
562
563        float GetAbsFilterWidth();
564        /** Returns the bounding box of filter width.
565        */
566        AxisAlignedBox3 GetFilterBBox(const Vector3 &viewPoint,
567                                                                  const float width) const;
568
569
570
571        //////////////////////////////////////////////////////////////////
572
573
574        /** If true, the kd nodes are stored instead of the object pvs.
575        */
576        void SetStoreKdPvs(const bool storeKdPvs);
577
578        /** Returns true if the kd nodes are stored instead of the object pvs.
579        **/
580        bool GetStoreKdPVs() const;
581
582        /** Exports single view cells for visualization.
583                @param objects the scene objects
584                @param limit the maximal number of output view cells
585                @param sortViewCells if the view cells should be sorted by pvs size
586                @param exportPvs if the pvs should also be exported
587                @param exportRays if sample rays should be exported as well
588                @param maxRays maximum number of rays to export
589                @param prefix the prefix for the output file
590                @param visRays additional rays
591        */
592        virtual void ExportSingleViewCells(const ObjectContainer &objects,
593                                                                           const int maxViewCells,
594                                                                           const bool sortViewCells,
595                                                                           const bool exportPvs,
596                                                                           const bool exportRays,
597                                                                           const int maxRays,
598                                                                           const string &prefix,
599                                                                           VssRayContainer *visRays = NULL) = NULL;
600
601
602        void ResetPvs();
603
604        Preprocessor *GetPreprocessor() const {
605                return mPreprocessor;
606        }
607
608        void SetPreprocessor(Preprocessor *p) {
609                mPreprocessor = p;
610        }
611
612        vector<ViewCellPoints *> *GetViewCellPoints()
613        {
614                return &mViewCellPoints;
615        }
616
617        void UpdatePvsForEvaluation();
618
619protected:
620
621        void ComputeViewCellContribution(ViewCell *viewCell,
622                                                                         VssRay &ray,
623                                                                         Intersectable *obj,
624                                                                         const Vector3 &pt,
625                                                                         const bool addRays);
626
627        void MergeViewCellsRecursivly(ObjectPvs &pvs,
628                                                                  const ViewCellContainer &viewCells,
629                                                                  const int leftIdx,
630                                                                  const int rightIdx) const;
631        /** Intersects box with the tree and returns the number of intersected boxes.
632                @returns number of view cells found
633        */
634        virtual int ComputeBoxIntersections(const AxisAlignedBox3 &box,
635                                                                                ViewCellContainer &viewCells) const;
636        /** Tests the visibility filter functionality.
637        */
638        virtual void TestFilter(const ObjectContainer &objects) {};
639        /** If the view cells tree was already constructed or not.
640        */
641        bool ViewCellsTreeConstructed() const;
642        /** Requests preprocessor to cast samplesPerPass samples of a specific type.
643        */
644        int CastPassSamples(const int samplesPerPass,
645                                                const vector<int> &strategies,
646                                                VssRayContainer &vssRays) const;
647        /** cast samples for the purpose of evaluating the view cells solution
648        */
649        int CastEvaluationSamples(const int samplesPerPass,
650                                                          VssRayContainer &passSamples);// const;
651        /** Parse the options from the environment file.
652        */
653        void ParseEnvironment();
654        /** Creates unique view cell ids.
655        */
656        void CreateUniqueViewCellIds();
657        /** Finalizes, i.e., creates mesh, volume, area etc. for the view cell.
658        */
659        virtual void Finalize(ViewCell *viewCell, const bool createMesh);
660        /** Recollects view cells and resets statistics.
661        */
662        void ResetViewCells();
663        /** Sets this view cell to active.
664        */
665        void SetViewCellActive(ViewCell *vc) const;
666        /** Collects the view cells in the view cell container.
667        */
668        virtual void CollectViewCells() = 0;
669        /** Evaluates view cells statistics and stores it in mViewCellsStatistics.
670        */
671        void EvaluateViewCellsStats();
672        /** This helper function loads the bounding boxes for a binary solution.
673        */
674        void LoadIndexedBoundingBoxes(IN_STREAM &stream, IndexedBoundingBoxContainer &iboxes);
675
676
677        ///////////////////////
678        //-- helper functions for view cell visualization
679
680        /** Exports the view cell partition.
681        */
682        void ExportViewCellsForViz(Exporter *exporter,
683                                                           const AxisAlignedBox3 *box,
684                                                           const bool colorCode,
685                                                           const AxisAlignedPlane *clipPlane) const;
686        /** Sets exporter color.
687        */
688        virtual void ExportColor(Exporter *exporter,
689                                                         ViewCell *vc,
690                                                         const int colorCode) const;
691        /** Creates meshes from the view cells.
692        */
693        void CreateViewCellMeshes();
694        /** Creates clip plane for visualization.
695        */
696        void CreateClipPlane();
697
698        AxisAlignedPlane *GetClipPlane();
699
700        void ExportMergedViewCells(const ObjectContainer &objects);
701
702
703        ///////////////////////
704
705        /** Returns volume of the view space.
706        */
707        virtual float GetViewSpaceVolume();
708        /** Prepares the view cells for sampling after loading them from disc.
709        */
710        virtual void PrepareLoadedViewCells() {};
711        /** Constructs local view cell merge hierarchy.
712        */
713        ViewCell *ConstructLocalMergeTree(ViewCell *currentViewCell,
714                                          const ViewCellContainer &viewCells);
715        /** Constructs local view cell merge hierarchy based solely on similarity with the
716                current viewcell
717        */
718        ViewCell *ConstructLocalMergeTree2(ViewCell *currentViewCell,
719                                                                           const ViewCellContainer &viewCells);
720        /** Updates pvs of all view cells for statistical evaluation after some more sampling
721        */
722        void UpdatePvsForEvaluation(ViewCell *root, ObjectPvs &pvs);
723
724        virtual void ExportStats(const string &mergeStats);
725
726        friend ViewCellsManager *LoadViewCellsBinary(const string &filename,
727                                                                                                 ObjectContainer &pvsObjects,
728                                                                                                 bool finalizeViewCells,
729                                                 BoundingBoxConverter *bconverter);
730
731
732        ////////////////////////////////////////////////
733
734
735        ofstream mStats;
736        Preprocessor *mPreprocessor;
737        /// if bounding boxes should be exported together with the view cells
738        bool mExportBboxesForPvs;
739        /// the clip plane for visualization
740        AxisAlignedPlane mClipPlaneForViz;
741        /// if the visualization is using the clip plane
742        bool mUseClipPlaneForViz;
743        /// Renders the view cells.
744        Renderer *mRenderer;
745        /// Loaded view cells
746        ViewCellContainer mViewCells;
747        /// the view cell hierarchy (i.e., the logical description of view cells)
748        ViewCellsTree *mViewCellsTree;
749       
750        std::vector<int> mStrategies;
751
752        /** if the values in the view cell leaves and the interiors are up to date
753                this is meant for lazy storing of the pvs, where only a scalar indicating
754                pvs size is stored in interiors and not the pvs itself.
755        */
756        bool mViewCellPvsIsUpdated;
757
758        /// maximum number of samples for the view cell construction
759        int mConstructionSamples;
760        int mSamplesPerPass;
761        int mInitialSamples;
762        int mPostProcessSamples;
763        int mVisualizationSamples;
764
765        int mEvaluationSamples;
766
767        float mTotalAreaValid;
768        float mTotalArea;
769
770        int mMaxPvsSize;
771        int mMinPvsSize;
772        float mMaxPvsRatio;
773
774        int mSamplingType;
775        int mEvaluationSamplingType;
776        int mNumActiveViewCells;
777        bool mCompressViewCells;
778
779        vector<ViewCellPoints *> mViewCellPoints;
780
781        /// holds the current view cell statistics
782        ViewCellsStatistics mCurrentViewCellsStats;
783
784        /// the scene bounding box
785        AxisAlignedBox3 mViewSpaceBox;
786       
787        /// if view cells should be exported
788        bool mExportViewCells;
789        // if only valid view cells should be considered for processing
790        bool mOnlyValidViewCells;
791        /// if rays should be used to collect merge candidates
792        bool mUseRaysForMerge;
793        /// if there should be an additional merge step after the subdivision
794        bool mMergeViewCells;
795        /// the width of the box filter
796        float mFilterWidth;
797        /// Maximal size of the filter in terms of contributing view cells
798        int mMaxFilterSize;
799        /// only for debugging: stores some rays used during view cell construction
800        VssRayContainer storedRays;
801        /// if kd node based pvs is used for preprocessing
802        bool mUseKdPvs;
803        /// types of distributions used for sampling
804        MixtureDistribution *mMixtureDistribution;
805
806
807        //////////////////
808        //-- visualization options
809       
810        /// color code for view cells visualization
811        bool mShowVisualization;
812        int mColorCode;
813        bool mExportGeometry;
814        bool mExportRays;
815        bool mViewCellsFinished;
816        bool mEvaluateViewCells;
817
818        /// if pvs should be exported with view cells
819        bool mExportPvs;
820
821        /// if view cells geometry should be used from other sources
822        bool mUsePredefinedViewCells;
823        /// the weight for one triangle in the heuristics
824        float mTriangleWeight;
825        /// the weight for one object (= one entity issued with one draw call) in the heuristics
826        float mObjectWeight;
827
828        vector<PerViewCellStat> mPerViewCellStat;
829        SamplesStatistics mSamplesStat;
830};
831
832
833/** Manages different higher order operations on the view cells.
834*/
835class BspViewCellsManager: public ViewCellsManager
836{
837
838public:
839        /** Constructor taking the bsp tree and the number of samples
840                used to construct the bsp tree.
841        */
842        BspViewCellsManager(ViewCellsTree *viewCellsTree, BspTree *tree);
843
844        ~BspViewCellsManager();
845
846        int ConstructSubdivision(const ObjectContainer &objects,
847                                  const VssRayContainer &rays);
848
849        int PostProcess(const ObjectContainer &objects,
850                                        const VssRayContainer &rays);
851
852        void Visualize(const ObjectContainer &objects,
853                                   const VssRayContainer &sampleRays);
854
855        int GetType() const;
856       
857        ViewCell *GenerateViewCell(Mesh *mesh = NULL) const;
858
859        bool ViewCellsConstructed() const;
860
861        //void PrintStatistics(ostream &s) const;
862
863        int CastLineSegment(const Vector3 &origin,
864                                                const Vector3 &termination,
865                                                ViewCellContainer &viewcells);
866       
867        /** Returns the probability that the view point lies
868                in this view cells.
869        */
870        float GetProbability(ViewCell *viewCell);
871
872        /** Get a viewcell containing the specified point.
873        */
874        ViewCell *GetViewCell(const Vector3 &point, const bool active = false) const;
875
876        /** Creates mesh for this view cell.
877        */
878        void CreateMesh(ViewCell *vc);
879
880        void ExportViewCellGeometry(Exporter *exporter,
881                                                                ViewCell *vc,
882                                                                const AxisAlignedBox3 *box,
883                                                                const AxisAlignedPlane *clipPlane = NULL
884                                                                ) const;
885       
886        void CollectMergeCandidates(const VssRayContainer &rays,
887                                                                vector<MergeCandidate> &candidates);
888
889        void Finalize(ViewCell *viewCell, const bool createMesh);
890
891        bool ExportViewCells(const string filename,
892                                                 const bool exportPvs,
893                                                 const ObjectContainer &objects);
894
895        /** Constructs merge hierarchy which corresponds to the spatial hierarchy.
896        */
897        ViewCell *ConstructSpatialMergeTree(BspNode *root);
898
899        void ExportSingleViewCells(const ObjectContainer &objects,
900                                                           const int maxViewCells,
901                                                           const bool sortViewCells,
902                                                           const bool exportPvs,
903                                                           const bool exportRays,
904                                                           const int maxRays,
905                                                           const string &prefix,
906                                                           VssRayContainer *visRays = NULL);
907
908        bool LineSegmentIntersects(const Vector3 &origin,
909                                                           const Vector3 &termination,
910                                                           ViewCell *viewCell);
911
912protected:
913
914        void CollectViewCells();
915       
916        /// the BSP tree.
917        BspTree *mBspTree;
918        vector<BspRay *> mBspRays;
919
920private:
921
922        /** Constructs a spatial merge tree only 2 levels deep.
923        */
924        ViewCell *ConstructDummyMergeTree(BspNode *root);
925        /** Exports visualization of the BSP splits.
926        */
927        void ExportSplits(const ObjectContainer &objects);
928        /** test if subdivision is valid in terms of volume / area.
929        */
930        void TestSubdivision();
931};
932
933
934/**
935        Manages different higher order operations on the KD type view cells.
936*/
937class KdViewCellsManager: public ViewCellsManager
938{
939
940public:
941
942        KdViewCellsManager(ViewCellsTree *viewCellsTree, KdTree *tree);
943
944        int ConstructSubdivision(const ObjectContainer &objects,
945                                                         const VssRayContainer &rays);
946
947        int CastLineSegment(const Vector3 &origin,
948                                                const Vector3 &termination,
949                                                ViewCellContainer &viewcells);
950
951        int PostProcess(const ObjectContainer &objects,
952                                        const VssRayContainer &rays);
953
954        void Visualize(const ObjectContainer &objects,
955                                   const VssRayContainer &sampleRays);
956
957        int GetType() const;
958
959        bool ViewCellsConstructed() const;
960
961        ViewCell *GenerateViewCell(Mesh *mesh) const;
962
963        /** Prints out statistics of this approach.
964        */
965        //  virtual void PrintStatistics(ostream &s) const;
966        ViewCell *GetViewCell(const Vector3 &point, const bool active = false) const
967        { return NULL; }
968
969        float GetProbability(ViewCell *viewCell);
970       
971        void CreateMesh(ViewCell *vc);
972
973        void ExportViewCellGeometry(Exporter *exporter,
974                                                                ViewCell *vc,
975                                                                const AxisAlignedBox3 *box,
976                                                                const AxisAlignedPlane *clipPlane = NULL) const;
977
978
979        void CollectMergeCandidates(const VssRayContainer &rays,
980                                                                vector<MergeCandidate> &candidates);
981
982        void ExportSingleViewCells(const ObjectContainer &objects,
983                                                           const int maxViewCells,
984                                                           const bool sortViewCells,
985                                                           const bool exportPvs,
986                                                           const bool exportRays,
987                                                           const int maxRays,
988                                                           const string &prefix,
989                                                           VssRayContainer *visRays = NULL);
990
991        bool LineSegmentIntersects(const Vector3 &origin,
992                                                           const Vector3 &termination,
993                                                           ViewCell *viewCell);
994
995protected:
996
997        /** Collects view cells from a hierarchy.
998        */
999        void CollectViewCells();
1000
1001        KdNode *GetNodeForPvs(KdLeaf *leaf);
1002
1003        ////////////////////////////////////////
1004
1005        /// the BSP tree.
1006        KdTree *mKdTree;
1007
1008        /// depth of the KD tree nodes with represent the view cells
1009        int mKdPvsDepth;
1010
1011
1012};
1013
1014
1015/** Manages different higher order operations on the view cells.
1016*/
1017class VspBspViewCellsManager: public ViewCellsManager
1018{
1019
1020public:
1021
1022        VspBspViewCellsManager(ViewCellsTree *viewCellsTree, VspBspTree *tree);
1023        ~VspBspViewCellsManager();
1024
1025        int ConstructSubdivision(const ObjectContainer &objects,
1026                                                         const VssRayContainer &rays);
1027
1028        int PostProcess(const ObjectContainer &objects,
1029                                        const VssRayContainer &rays);
1030
1031        void Visualize(const ObjectContainer &objects,
1032                                   const VssRayContainer &sampleRays);
1033
1034        int GetType() const;
1035       
1036        ViewCell *GenerateViewCell(Mesh *mesh = NULL) const;
1037
1038        bool ViewCellsConstructed() const;
1039       
1040        int CastLineSegment(const Vector3 &origin,
1041                                                const Vector3 &termination,
1042                                                ViewCellContainer &viewcells);
1043
1044        float GetProbability(ViewCell *viewCell);
1045       
1046        ViewCell *GetViewCell(const Vector3 &point, const bool active = false) const;
1047
1048        bool GetViewPoint(Vector3 &viewPoint) const;
1049
1050        bool ViewPointValid(const Vector3 &viewPoint) const;
1051
1052        void CreateMesh(ViewCell *vc);
1053
1054        bool ExportViewCells(const string filename,
1055                                                 const bool exportPvs,
1056                                                 const ObjectContainer &objects);
1057
1058        int CastBeam(Beam &beam);
1059       
1060        void ExportViewCellGeometry(Exporter *exporter,
1061                                                                ViewCell *vc,
1062                                                                const AxisAlignedBox3 *box,
1063                                                                const AxisAlignedPlane *clipPlane = NULL) const;
1064
1065
1066        void Finalize(ViewCell *viewCell, const bool createMesh);
1067
1068        void CollectMergeCandidates(const VssRayContainer &rays,
1069                                                                vector<MergeCandidate> &candidates);
1070
1071        void ExportSingleViewCells(const ObjectContainer &objects,
1072                                                           const int maxViewCells,
1073                                                           const bool sortViewCells,
1074                                                           const bool exportPvs,
1075                                                           const bool exportRays,               
1076                                                           const int maxRays,
1077                                                           const string &prefix,
1078                                                           VssRayContainer *visRays = NULL);
1079
1080       
1081        bool LineSegmentIntersects(const Vector3 &origin,
1082                                                           const Vector3 &termination,
1083                                                           ViewCell *viewCell);
1084
1085protected:
1086
1087        int ComputeBoxIntersections(const AxisAlignedBox3 &box,
1088                                                                ViewCellContainer &viewCells) const;
1089       
1090        /** Merges view cells according to some criteria
1091        */
1092        void MergeViewCells(const VssRayContainer &rays,
1093                                                const ObjectContainer &objects);
1094       
1095        void RefineViewCells(const VssRayContainer &rays, const ObjectContainer &objects);
1096
1097        void CollectViewCells();
1098
1099        /** Returns maximal depth difference of view cell
1100                leaves in tree.
1101        */
1102        int GetMaxTreeDiff(ViewCell *vc) const;
1103
1104        /** Prepare view cells for use after loading them from disc.
1105        */
1106        void PrepareLoadedViewCells();
1107
1108        /** Constructs merge hierarchy which corresponds to the spatial hierarchy.
1109        */
1110        ViewCell *ConstructSpatialMergeTree(BspNode *root);
1111
1112        /// HACK for testing visibility filter functionality
1113        void TestFilter(const ObjectContainer &objects);
1114
1115        /** Visualization of the pvs difference to exact visubility using
1116                from point queries.
1117        */
1118        void VisualizeWithFromPointQueries();
1119
1120        /** Evaluate from point queries for the current scene.
1121        */
1122        void EvalFromPointQueries();
1123
1124        /** Exports visualization of the BSP splits.
1125        */
1126        void ExportSplits(const ObjectContainer &objects,
1127                                          const VssRayContainer &rays);
1128
1129
1130        /////////////////////////
1131
1132        /// the view space partition BSP tree.
1133        VspBspTree *mVspBspTree;
1134
1135
1136private:
1137
1138        /** test if subdivision is valid in terms of volume / area.
1139        */
1140        void TestSubdivision();
1141};
1142
1143
1144
1145/**     Manages different higher order operations on the view cells.
1146*/
1147class VspOspViewCellsManager: public ViewCellsManager
1148{
1149        friend class ViewCellsParseHandlers;
1150        friend class ViewCellsManager;
1151
1152public:
1153
1154        /** This version takes a view cells tree and a hierarchy
1155                as input.
1156        */
1157        VspOspViewCellsManager(ViewCellsTree *vcTree,
1158                                                   const string &hierarchyType);
1159       
1160        ~VspOspViewCellsManager();
1161
1162        int ConstructSubdivision(const ObjectContainer &objects,
1163                                                         const VssRayContainer &rays);
1164
1165        int PostProcess(const ObjectContainer &objects,
1166                                        const VssRayContainer &rays);
1167
1168        void Visualize(const ObjectContainer &objects,
1169                                   const VssRayContainer &sampleRays);
1170
1171        int GetType() const;
1172       
1173        ViewCell *GenerateViewCell(Mesh *mesh = NULL) const;
1174
1175        virtual Intersectable *GetIntersectable(const VssRay &ray,
1176                                                                                        const bool isTermination) const;
1177
1178        bool ViewCellsConstructed() const;
1179
1180        int CastLineSegment(const Vector3 &origin,
1181                                                const Vector3 &termination,
1182                                                ViewCellContainer &viewcells);
1183
1184        bool LineSegmentIntersects(const Vector3 &origin,
1185                                                           const Vector3 &termination,
1186                                                           ViewCell *viewCell);
1187
1188        float GetProbability(ViewCell *viewCell);
1189       
1190        ViewCell *GetViewCell(const Vector3 &point,
1191                                                  const bool active = false) const;
1192
1193        bool GetViewPoint(Vector3 &viewPoint) const;
1194
1195        bool ViewPointValid(const Vector3 &viewPoint) const;
1196
1197        void CreateMesh(ViewCell *vc);
1198
1199        bool ExportViewCells(const string filename,
1200                                                 const bool exportPvs,
1201                                                 const ObjectContainer &objects);
1202
1203        int CastBeam(Beam &beam);
1204
1205        void Finalize(ViewCell *viewCell, const bool createMesh);
1206
1207        void ExportSingleViewCells(const ObjectContainer &objects,
1208                                                           const int maxViewCells,
1209                                                           const bool sortViewCells,
1210                                                           const bool exportPvs,
1211                                                           const bool exportRays,
1212                                                           const int maxRays,
1213                                                           const string &prefix,
1214                                                           VssRayContainer *visRays = NULL);
1215        /** See parent class.
1216        */
1217        virtual void FinalizeViewCells(const bool createMesh);
1218
1219        bool ExportBinaryViewCells(const string filename,
1220                                                           const bool exportPvs,
1221                                                           const ObjectContainer &objects);
1222
1223#if TEST_PACKETS
1224
1225        float ComputeSampleContributions(const VssRayContainer &rays,
1226                                             const bool addContributions,
1227                                                                         const bool storeViewCells,
1228                                                                         const bool useHitObjects = false);
1229#endif
1230
1231
1232protected:
1233
1234        /** View cells manager taking a view cells tree and a hierarchy as input.
1235        */
1236        VspOspViewCellsManager(ViewCellsTree *vcTree, HierarchyManager *hm);
1237       
1238        virtual void EvalViewCellPartition();
1239        /** Exports view cell geometry.
1240        */
1241        void ExportViewCellGeometry(Exporter *exporter,
1242                                                                ViewCell *vc,
1243                                                                const AxisAlignedBox3 *box,
1244                                                                const AxisAlignedPlane *clipPlane = NULL) const;
1245
1246        int ComputeBoxIntersections(const AxisAlignedBox3 &box,
1247                                                                ViewCellContainer &viewCells) const;
1248       
1249        void CollectViewCells();
1250
1251        virtual void CompressViewCells();
1252        /** Prepare view cells for use after loading them from disc.
1253        */
1254        void PrepareLoadedViewCells();
1255        /** Constructs merge hierarchy which corresponds to the spatial hierarchy.
1256        */
1257        ViewCell *ConstructSpatialMergeTree(VspNode *root);
1258        /** Exports visualization of the PVS.
1259        */
1260        void ExportPvs(const ObjectContainer &objects, const VssRayContainer &rays);
1261        /** Returns a hierarchy manager of the given name.
1262        */
1263        static HierarchyManager *CreateHierarchyManager(const string &name);
1264        /** collect objects intersecting a given spatial box
1265        */
1266        virtual void CollectObjects(const AxisAlignedBox3 &box, ObjectContainer &objects);
1267        /** Update the cost of pvss for hierarchy objects.
1268        */
1269        float UpdateObjectCosts();
1270
1271
1272        ////////////////
1273
1274        /** Fast view cell loader in binary mode.
1275        */
1276        friend ViewCellsManager *LoadViewCellsBinary(const string &filename,
1277                                                                                                 ObjectContainer &pvsObjects,
1278                                                                                                 bool finalizeViewCells,
1279                                                                                                 BoundingBoxConverter *bconverter);
1280
1281        /** Print statistics about the view cells compression.
1282        */
1283        static void PrintCompressionStats(HierarchyManager *hm, const int pvsEntries);
1284
1285
1286        ////////////////////
1287
1288        /// if we should compress the objects after view cell evaluation: this makes
1289        /// only sense for testing purpose
1290        bool mCompressObjects;
1291        /// pointer to the hierarchy manager responsible for view space / object space subdivision.
1292        HierarchyManager *mHierarchyManager;
1293};
1294
1295
1296}
1297
1298#endif
Note: See TracBrowser for help on using the repository browser.