1 // Created on: 2011-11-02
2 // Created by: Sergey ZERCHANINOV
3 // Copyright (c) 2011-2014 OPEN CASCADE SAS
5 // This file is part of Open CASCADE Technology software library.
7 // This library is free software; you can redistribute it and/or modify it under
8 // the terms of the GNU Lesser General Public License version 2.1 as published
9 // by the Free Software Foundation, with special exception defined in the file
10 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
11 // distribution for complete text of the license and disclaimer of any warranty.
13 // Alternatively, this file may be used under the terms of Open CASCADE
14 // commercial license or contractual agreement.
16 #ifndef _OpenGl_PriorityList_Header
17 #define _OpenGl_PriorityList_Header
19 #include <NCollection_Sequence.hxx>
20 #include <NCollection_Array1.hxx>
22 #include <InterfaceGraphic_telem.hxx>
24 #include <Handle_OpenGl_Workspace.hxx>
25 #include <OpenGl_BVHClipPrimitiveSet.hxx>
26 #include <OpenGl_BVHTreeSelector.hxx>
28 class OpenGl_Structure;
30 typedef NCollection_Sequence<const OpenGl_Structure*> OpenGl_SequenceOfStructure;
31 typedef NCollection_Array1<OpenGl_SequenceOfStructure> OpenGl_ArrayOfStructure;
33 class OpenGl_PriorityList
38 OpenGl_PriorityList (const Standard_Integer theNbPriorities = 11);
41 virtual ~OpenGl_PriorityList();
43 void Add (const OpenGl_Structure* theStructure,
44 const Standard_Integer thePriority,
45 Standard_Boolean isForChangePriority = Standard_False);
47 //! Remove structure and returns its priority, if the structure is not found, method returns negative value
48 Standard_Integer Remove (const OpenGl_Structure* theStructure,
49 Standard_Boolean isForChangePriority = Standard_False);
51 //! @return the number of structures
52 Standard_Integer NbStructures() const { return myNbStructures; }
54 // Render all structures.
55 void Render (const Handle(OpenGl_Workspace)& theWorkspace) const;
57 //! Returns the number of available priority levels
58 Standard_Integer NbPriorities() const;
60 //! Append priority list of acceptable type (with similar number of priorities
61 //! or less). Returns Standard_False if the list can not be accepted.
62 Standard_Boolean Append (const OpenGl_PriorityList& theOther);
64 //! Returns array of OpenGL structures.
65 const OpenGl_ArrayOfStructure& ArrayOfStructures() const { return myArray; }
67 //! Marks BVH tree for given priority list as dirty and
68 //! marks primitive set for rebuild.
69 void InvalidateBVHData();
73 //! Traverses through BVH tree to determine which structures are in view volume.
74 void traverse (OpenGl_BVHTreeSelector& theSelector) const;
76 //! Iterates through the hierarchical list of existing structures and renders them all.
77 void renderAll (const Handle(OpenGl_Workspace)& theWorkspace) const;
79 //! Iterates through the hierarchical list of existing structures and renders only overlapping ones.
80 void renderTraverse (const Handle(OpenGl_Workspace)& theWorkspace) const;
84 OpenGl_ArrayOfStructure myArray;
85 Standard_Integer myNbStructures;
86 mutable OpenGl_BVHClipPrimitiveSet myBVHPrimitives; //<! Set of OpenGl_Structures for building BVH tree
87 mutable Standard_Boolean myBVHIsLeftChildQueuedFirst; //<! Is needed for implementation of stochastic order of BVH traverse
88 mutable Standard_Boolean myIsBVHPrimitivesNeedsReset; //<! Defines if the primitive set for BVH is outdated
96 #endif // _OpenGl_PriorityList_Header