0027670: Visualization - avoid duplication of structures defining primitive array...
[occt.git] / src / OpenGl / OpenGl_LayerList.hxx
1 // Created on: 2012-02-02
2 // Created by: Anton POLETAEV
3 // Copyright (c) 2012-2014 OPEN CASCADE SAS
4 //
5 // This file is part of Open CASCADE Technology software library.
6 //
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.
12 //
13 // Alternatively, this file may be used under the terms of Open CASCADE
14 // commercial license or contractual agreement.
15
16 #ifndef _OpenGl_LayerList_Header
17 #define _OpenGl_LayerList_Header
18
19 #include <OpenGl_Layer.hxx>
20 #include <OpenGl_LayerFilter.hxx>
21
22 #include <NCollection_Sequence.hxx>
23 #include <NCollection_DataMap.hxx>
24
25 class OpenGl_Structure;
26
27 typedef NCollection_Sequence<OpenGl_Layer> OpenGl_SequenceOfLayers;
28 typedef NCollection_DataMap<int, int> OpenGl_LayerSeqIds;
29
30 class OpenGl_LayerList
31 {
32 public:
33
34   //! Constructor
35   OpenGl_LayerList (const Standard_Integer theNbPriorities = 11);
36
37   //! Destructor
38   virtual ~OpenGl_LayerList();
39
40   //! Method returns the number of available priorities
41   Standard_Integer NbPriorities() const { return myNbPriorities; }
42
43   //! Number of displayed structures
44   Standard_Integer NbStructures() const { return myNbStructures; }
45
46   //! Return number of structures within immediate layers
47   Standard_Integer NbImmediateStructures() const { return myImmediateNbStructures; }
48
49   //! Insert a new layer with id.
50   void AddLayer (const Graphic3d_ZLayerId theLayerId);
51
52   //! Remove layer by its id.
53   void RemoveLayer (const Graphic3d_ZLayerId theLayerId);
54
55   //! Add structure to list with given priority. The structure will be inserted
56   //! to specified layer. If the layer isn't found, the structure will be put
57   //! to default bottom-level layer.
58   void AddStructure (const OpenGl_Structure*  theStruct,
59                      const Graphic3d_ZLayerId theLayerId,
60                      const Standard_Integer   thePriority,
61                      Standard_Boolean        isForChangePriority = Standard_False);
62
63   //! Remove structure from structure list and return its previous priority
64   void RemoveStructure (const OpenGl_Structure* theStructure);
65
66   //! Change structure z layer
67   //! If the new layer is not presented, the structure will be displayed
68   //! in default z layer
69   void ChangeLayer (const OpenGl_Structure*  theStructure,
70                     const Graphic3d_ZLayerId theOldLayerId,
71                     const Graphic3d_ZLayerId theNewLayerId);
72
73   //! Changes structure priority within its ZLayer
74   void ChangePriority (const OpenGl_Structure*  theStructure,
75                        const Graphic3d_ZLayerId theLayerId,
76                        const Standard_Integer   theNewPriority);
77
78   //! Returns reference to the layer with given ID.
79   OpenGl_Layer& Layer (const Graphic3d_ZLayerId theLayerId);
80
81   //! Returns reference to the layer with given ID.
82   const OpenGl_Layer& Layer (const Graphic3d_ZLayerId theLayerId) const;
83
84   //! Assign new settings to the layer.
85   void SetLayerSettings (const Graphic3d_ZLayerId        theLayerId,
86                          const Graphic3d_ZLayerSettings& theSettings);
87
88   //! Render this element
89   void Render (const Handle(OpenGl_Workspace)& theWorkspace,
90                const Standard_Boolean          theToDrawImmediate,
91                const OpenGl_LayerFilter        theLayersToProcess) const;
92
93   //! Returns the set of OpenGL Z-layers.
94   const OpenGl_SequenceOfLayers& Layers() const { return myLayers; }
95
96   //! Returns the map of Z-layer IDs to indexes.
97   const OpenGl_LayerSeqIds& LayerIDs() const { return myLayerIds; }
98
99   //! Marks BVH tree for given priority list as dirty and
100   //! marks primitive set for rebuild.
101   void InvalidateBVHData (const Graphic3d_ZLayerId theLayerId);
102
103   //! Returns structure modification state (for ray-tracing).
104   Standard_Size ModificationState() const { return myModificationState; }
105
106 protected:
107
108   // number of structures temporary put to default layer
109   OpenGl_SequenceOfLayers myLayers;
110   OpenGl_LayerSeqIds      myLayerIds;
111
112   Standard_Integer        myNbPriorities;
113   Standard_Integer        myNbStructures;
114   Standard_Integer        myImmediateNbStructures; //!< number of structures within immediate layers
115
116   mutable Standard_Size   myModificationState;
117
118 public:
119
120   DEFINE_STANDARD_ALLOC
121
122 };
123
124 #endif //_OpenGl_LayerList_Header