3cbd249a66727cb52da8797a2d3680937b85193d
[occt.git] / src / Graphic3d / Graphic3d_CStructure.hxx
1 // Copyright (c) 1995-1999 Matra Datavision
2 // Copyright (c) 1999-2014 OPEN CASCADE SAS
3 //
4 // This file is part of Open CASCADE Technology software library.
5 //
6 // This library is free software; you can redistribute it and/or modify it under
7 // the terms of the GNU Lesser General Public License version 2.1 as published
8 // by the Free Software Foundation, with special exception defined in the file
9 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
10 // distribution for complete text of the license and disclaimer of any warranty.
11 //
12 // Alternatively, this file may be used under the terms of Open CASCADE
13 // commercial license or contractual agreement.
14
15 #ifndef _Graphic3d_CStructure_HeaderFile
16 #define _Graphic3d_CStructure_HeaderFile
17
18 #include <Graphic3d_BndBox3d.hxx>
19 #include <Graphic3d_Group.hxx>
20 #include <Graphic3d_PresentationAttributes.hxx>
21 #include <Graphic3d_SequenceOfGroup.hxx>
22 #include <Graphic3d_SequenceOfHClipPlane.hxx>
23 #include <Graphic3d_ViewAffinity.hxx>
24 #include <Graphic3d_TransformPers.hxx>
25 #include <Graphic3d_Vec3.hxx>
26 #include <Graphic3d_ZLayerId.hxx>
27 #include <TopLoc_Datum3D.hxx>
28 #include <NCollection_IndexedMap.hxx>
29
30 class Graphic3d_GraphicDriver;
31 class Graphic3d_StructureManager;
32
33 //! Low-level graphic structure interface
34 class Graphic3d_CStructure : public Standard_Transient
35 {
36 protected:
37
38   //! Auxiliary wrapper to iterate through structure list.
39   template<class Struct_t>
40   class SubclassStructIterator
41   {
42   public:
43     SubclassStructIterator (const NCollection_IndexedMap<const Graphic3d_CStructure*>& theStructs) : myIter (theStructs) {}
44     Standard_Boolean More() const  { return myIter.More(); }
45     void Next()                    { myIter.Next(); }
46     const Struct_t*  Value() const { return (const Struct_t* )(myIter.Value()); }
47     Struct_t*        ChangeValue() { return (Struct_t* )(myIter.Value()); }
48   private:
49     NCollection_IndexedMap<const Graphic3d_CStructure*>::Iterator myIter;
50   };
51
52   //! Auxiliary wrapper to iterate through group sequence.
53   template<class Group_t>
54   class SubclassGroupIterator
55   {
56   public:
57     SubclassGroupIterator (const Graphic3d_SequenceOfGroup& theGroups) : myIter (theGroups) {}
58     Standard_Boolean More() const  { return myIter.More(); }
59     void Next()                    { myIter.Next(); }
60     const Group_t*   Value() const { return (const Group_t* )(myIter.Value().get()); }
61     Group_t*         ChangeValue() { return (Group_t* )(myIter.ChangeValue().get()); }
62   private:
63     Graphic3d_SequenceOfGroup::Iterator myIter;
64   };
65
66 public:
67
68   //! @return graphic driver created this structure
69   const Handle(Graphic3d_GraphicDriver)& GraphicDriver() const
70   {
71     return myGraphicDriver;
72   }
73
74   //! @return graphic groups
75   const Graphic3d_SequenceOfGroup& Groups() const
76   {
77     return myGroups;
78   }
79
80   //! Return transformation.
81   const Handle(TopLoc_Datum3D)& Transformation() const { return myTrsf; }
82
83   //! Assign transformation.
84   virtual void SetTransformation (const Handle(TopLoc_Datum3D)& theTrsf) { myTrsf = theTrsf; }
85
86   //! Return transformation persistence.
87   const Handle(Graphic3d_TransformPers)& TransformPersistence() const { return myTrsfPers; }
88
89   //! Set transformation persistence.
90   virtual void SetTransformPersistence (const Handle(Graphic3d_TransformPers)& theTrsfPers) { myTrsfPers = theTrsfPers; }
91
92   //! @return associated clip planes
93   const Handle(Graphic3d_SequenceOfHClipPlane)& ClipPlanes() const
94   {
95     return myClipPlanes;
96   }
97
98   //! Pass clip planes to the associated graphic driver structure
99   void SetClipPlanes (const Handle(Graphic3d_SequenceOfHClipPlane)& thePlanes) { myClipPlanes = thePlanes; }
100
101   //! @return bounding box of this presentation
102   const Graphic3d_BndBox3d& BoundingBox() const
103   {
104     return myBndBox;
105   }
106
107   //! @return bounding box of this presentation
108   //! without transformation matrix applied
109   Graphic3d_BndBox3d& ChangeBoundingBox()
110   {
111     return myBndBox;
112   }
113
114   //! Return structure visibility flag
115   bool IsVisible() const { return visible != 0; }
116
117   //! Return structure visibility considering both View Affinity and global visibility state.
118   bool IsVisible (const Standard_Integer theViewId) const
119   {
120     return visible != 0
121         && (ViewAffinity.IsNull()
122          || ViewAffinity->IsVisible (theViewId));
123   }
124
125   //! Set z layer ID to display the structure in specified layer
126   virtual void SetZLayer (const Graphic3d_ZLayerId theLayerIndex) { myZLayer = theLayerIndex; }
127
128   //! Get z layer ID
129   Graphic3d_ZLayerId ZLayer() const { return myZLayer; }
130
131   //! Returns valid handle to highlight style of the structure in case if
132   //! highlight flag is set to true
133   const Handle(Graphic3d_PresentationAttributes)& HighlightStyle() const { return myHighlightStyle; }
134
135 public:
136
137   //! Returns FALSE if the structure hits the current view volume, otherwise returns TRUE.
138   Standard_Boolean IsCulled() const { return myIsCulled; }
139
140   //! Marks structure as culled/not culled - note that IsAlwaysRendered() is ignored here!
141   void SetCulled (Standard_Boolean theIsCulled) const { myIsCulled = theIsCulled; }
142
143   //! Marks structure as overlapping the current view volume one.
144   //! The method is called during traverse of BVH tree.
145   void MarkAsNotCulled() const { myIsCulled = Standard_False; }
146
147   //! Returns whether check of object's bounding box clipping is enabled before drawing of object; TRUE by default.
148   Standard_Boolean BndBoxClipCheck() const { return myBndBoxClipCheck; }
149
150   //! Enable/disable check of object's bounding box clipping before drawing of object.
151   void SetBndBoxClipCheck(Standard_Boolean theBndBoxClipCheck) { myBndBoxClipCheck = theBndBoxClipCheck; }
152
153   //! Checks if the structure should be included into BVH tree or not.
154   Standard_Boolean IsAlwaysRendered() const
155   {
156     return IsInfinite
157         || IsForHighlight
158         || IsMutable
159         || Is2dText
160         || (!myTrsfPers.IsNull() && myTrsfPers->IsTrihedronOr2d());
161   }
162
163 public:
164
165   //! Update structure visibility state
166   virtual void OnVisibilityChanged() = 0;
167
168   //! Clear graphic data
169   virtual void Clear() = 0;
170
171   //! Connect other structure to this one
172   virtual void Connect    (Graphic3d_CStructure& theStructure) = 0;
173
174   //! Disconnect other structure to this one
175   virtual void Disconnect (Graphic3d_CStructure& theStructure) = 0;
176
177   //! Highlights structure with the given style
178   virtual void GraphicHighlight (const Handle(Graphic3d_PresentationAttributes)& theStyle) = 0;
179
180   //! Unhighlights the structure and invalidates pointer to structure's highlight
181   //! style
182   virtual void GraphicUnhighlight() = 0;
183
184   //! Create shadow link to this structure
185   virtual Handle(Graphic3d_CStructure) ShadowLink (const Handle(Graphic3d_StructureManager)& theManager) const = 0;
186
187   //! Create new group within this structure
188   virtual Handle(Graphic3d_Group) NewGroup (const Handle(Graphic3d_Structure)& theStruct) = 0;
189
190   //! Remove group from this structure
191   virtual void RemoveGroup (const Handle(Graphic3d_Group)& theGroup) = 0;
192
193   //! Update render transformation matrix.
194   virtual void updateLayerTransformation() {}
195
196   //! Dumps the content of me into the stream
197   Standard_EXPORT virtual void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const;
198
199 public:
200
201   int                      Id;
202   Graphic3d_ZLayerId       myZLayer;
203   int                      Priority;
204   int                      PreviousPriority;
205
206   int   ContainsFacet;
207
208   Handle(Graphic3d_ViewAffinity) ViewAffinity; //!< view affinity mask
209
210   unsigned IsInfinite     : 1;
211   unsigned stick          : 1; //!< displaying state - should be set when structure has been added to scene graph (but can be in hidden state)
212   unsigned highlight      : 1;
213   unsigned visible        : 1; //!< visibility flag - can be used to suppress structure while leaving it in the scene graph
214   unsigned HLRValidation  : 1;
215   unsigned IsForHighlight : 1;
216   unsigned IsMutable      : 1;
217   unsigned Is2dText       : 1;
218
219 protected:
220
221   //! Create empty structure.
222   Standard_EXPORT Graphic3d_CStructure (const Handle(Graphic3d_StructureManager)& theManager);
223
224 protected:
225
226   Handle(Graphic3d_GraphicDriver) myGraphicDriver;
227   Graphic3d_SequenceOfGroup       myGroups;
228   Graphic3d_BndBox3d              myBndBox;
229   Handle(TopLoc_Datum3D)          myTrsf;
230   Handle(Graphic3d_TransformPers) myTrsfPers;
231   Handle(Graphic3d_SequenceOfHClipPlane) myClipPlanes;
232   Handle(Graphic3d_PresentationAttributes) myHighlightStyle; //! Current highlight style; is set only if highlight flag is true
233
234   mutable Standard_Boolean myIsCulled; //!< A status specifying is structure needs to be rendered after BVH tree traverse
235   Standard_Boolean myBndBoxClipCheck;  //!< Flag responsible for checking of bounding box clipping before drawing of object
236
237 public:
238
239   DEFINE_STANDARD_RTTIEXT(Graphic3d_CStructure,Standard_Transient) // Type definition
240
241 };
242
243 DEFINE_STANDARD_HANDLE (Graphic3d_CStructure, Standard_Transient)
244
245 #endif // _Graphic3d_CStructure_HeaderFile