1 // Created on: 2012-02-02
2 // Created by: Anton POLETAEV
3 // Copyright (c) 2012-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_LayerList_Header
17 #define _OpenGl_LayerList_Header
19 #include <OpenGl_PriorityList.hxx>
20 #include <OpenGl_Layer.hxx>
22 #include <InterfaceGraphic_telem.hxx>
24 #include <NCollection_Sequence.hxx>
25 #include <NCollection_DataMap.hxx>
27 class OpenGl_Structure;
28 class Handle(OpenGl_Workspace);
30 typedef NCollection_Sequence<OpenGl_Layer> OpenGl_SequenceOfLayers;
31 typedef NCollection_DataMap<int, int> OpenGl_LayerSeqIds;
33 class OpenGl_LayerList
38 OpenGl_LayerList (const Standard_Integer theNbPriorities = 11);
41 virtual ~OpenGl_LayerList ();
43 //! Method returns the number of available priorities
44 Standard_Integer NbPriorities () const;
46 //! Number of displayed structures
47 Standard_Integer NbStructures () const;
49 //! Insert a new layer with id.
50 void AddLayer (const Standard_Integer theLayerId);
52 //! Check whether the layer with given id is already created.
53 Standard_Boolean HasLayer (const Standard_Integer theLayerId) const;
55 //! Remove layer by its id.
56 void RemoveLayer (const Standard_Integer theLayerId);
58 //! Add structure to list with given priority. The structure will be inserted
59 //! to specified layer. If the layer isn't found, the structure will be put
60 //! to default bottom-level layer.
61 void AddStructure (const OpenGl_Structure *theStructure,
62 const Standard_Integer theLayerId,
63 const Standard_Integer thePriority,
64 Standard_Boolean isForChangePriority = Standard_False);
66 //! Remove structure from structure list and return its previous priority
67 void RemoveStructure (const OpenGl_Structure *theStructure,
68 const Standard_Integer theZLayerId);
70 //! Change structure z layer
71 //! If the new layer is not presented, the structure will be displayed
72 //! in default z layer
73 void ChangeLayer (const OpenGl_Structure *theStructure,
74 const Standard_Integer theOldLayerId,
75 const Standard_Integer theNewLayerId);
77 //! Changes structure priority within its ZLayer
78 void ChangePriority (const OpenGl_Structure *theStructure,
79 const Standard_Integer theLayerId,
80 const Standard_Integer theNewPriority);
82 //! Returns reference to the layer with given ID.
83 OpenGl_Layer& Layer (const Standard_Integer theLayerId);
85 //! Returns reference to the layer with given ID.
86 const OpenGl_Layer& Layer (const Standard_Integer theLayerId) const;
88 //! Render this element
89 void Render (const Handle(OpenGl_Workspace) &theWorkspace) const;
91 //! Returns the set of OpenGL Z-layers.
92 const OpenGl_SequenceOfLayers& Layers() const { return myLayers; }
94 //! Marks BVH tree for given priority list as dirty and
95 //! marks primitive set for rebuild.
96 void InvalidateBVHData (const Standard_Integer theLayerId);
98 //! Returns structure modification state (for ray-tracing).
99 Standard_Size ModificationState() const { return myModificationState; }
103 //! Get default layer
104 OpenGl_Layer& defaultLayer ();
108 // number of structures temporary put to default layer
109 OpenGl_SequenceOfLayers myLayers;
110 OpenGl_LayerSeqIds myLayerIds;
111 Standard_Integer myNbPriorities;
112 Standard_Integer myNbStructures;
114 mutable Standard_Size myModificationState;
117 DEFINE_STANDARD_ALLOC
120 #endif //_OpenGl_LayerList_Header