]>
Commit | Line | Data |
---|---|---|
b311480e | 1 | // Created on: 2011-08-01 |
2 | // Created by: Sergey ZERCHANINOV | |
973c2be1 | 3 | // Copyright (c) 2011-2014 OPEN CASCADE SAS |
b311480e | 4 | // |
973c2be1 | 5 | // This file is part of Open CASCADE Technology software library. |
b311480e | 6 | // |
d5f74e42 | 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 | |
973c2be1 | 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. | |
b311480e | 12 | // |
973c2be1 | 13 | // Alternatively, this file may be used under the terms of Open CASCADE |
14 | // commercial license or contractual agreement. | |
b311480e | 15 | |
2166f0fa SK |
16 | #ifndef OpenGl_Structure_Header |
17 | #define OpenGl_Structure_Header | |
18 | ||
63bcc448 | 19 | #include <Graphic3d_CStructure.hxx> |
20 | #include <Graphic3d_SequenceOfHClipPlane.hxx> | |
2166f0fa SK |
21 | |
22 | #include <OpenGl_AspectLine.hxx> | |
23 | #include <OpenGl_AspectFace.hxx> | |
24 | #include <OpenGl_AspectMarker.hxx> | |
25 | #include <OpenGl_AspectText.hxx> | |
26 | ||
5b111128 | 27 | #include <OpenGl_GraphicDriver.hxx> |
2166f0fa SK |
28 | #include <OpenGl_Group.hxx> |
29 | #include <OpenGl_Matrix.hxx> | |
b7cd4ba7 | 30 | #include <OpenGl_Vec.hxx> |
31 | #include <OpenGl_Workspace.hxx> | |
2166f0fa | 32 | |
63bcc448 | 33 | #include <NCollection_List.hxx> |
34 | #include <InterfaceGraphic_Graphic3d.hxx> | |
4269bd1b | 35 | |
bf75be98 | 36 | class OpenGl_Structure; |
63bcc448 | 37 | class OpenGl_GraphicDriver; |
bf75be98 | 38 | |
39 | typedef NCollection_List<const OpenGl_Structure* > OpenGl_ListOfStructure; | |
2166f0fa | 40 | |
b64d84be | 41 | //! Implementation of low-level graphic structure. |
63bcc448 | 42 | class OpenGl_Structure : public Graphic3d_CStructure |
2166f0fa | 43 | { |
e276548b | 44 | friend class OpenGl_Group; |
5e27df78 | 45 | |
b64d84be | 46 | public: |
47 | ||
48 | //! Auxiliary wrapper to iterate OpenGl_Group sequence. | |
49 | class GroupIterator | |
50 | { | |
51 | ||
52 | public: | |
53 | GroupIterator (const Graphic3d_SequenceOfGroup& theGroups) : myIter (theGroups) {} | |
54 | Standard_Boolean More() const { return myIter.More(); } | |
55 | void Next() { myIter.Next(); } | |
56 | const OpenGl_Group* Value() const { return (const OpenGl_Group* )(myIter.Value().operator->()); } | |
57 | OpenGl_Group* ChangeValue() { return (OpenGl_Group* )(myIter.ChangeValue().operator->()); } | |
58 | ||
59 | private: | |
60 | Graphic3d_SequenceOfGroup::Iterator myIter; | |
61 | ||
62 | }; | |
63 | ||
5e27df78 | 64 | public: |
65 | ||
63bcc448 | 66 | //! Create empty structure |
b64d84be | 67 | Standard_EXPORT OpenGl_Structure (const Handle(Graphic3d_StructureManager)& theManager); |
63bcc448 | 68 | |
69 | //! Setup structure graphic state | |
a1954302 | 70 | Standard_EXPORT virtual void OnVisibilityChanged() Standard_OVERRIDE; |
63bcc448 | 71 | |
72 | //! Clear graphic data | |
79104795 | 73 | Standard_EXPORT virtual void Clear() Standard_OVERRIDE; |
63bcc448 | 74 | |
75 | //! Connect other structure to this one | |
79104795 | 76 | Standard_EXPORT virtual void Connect (Graphic3d_CStructure& theStructure) Standard_OVERRIDE; |
63bcc448 | 77 | |
78 | //! Disconnect other structure to this one | |
79104795 | 79 | Standard_EXPORT virtual void Disconnect (Graphic3d_CStructure& theStructure) Standard_OVERRIDE; |
63bcc448 | 80 | |
81 | //! Synchronize structure aspects | |
79104795 | 82 | Standard_EXPORT virtual void UpdateAspects() Standard_OVERRIDE; |
2166f0fa | 83 | |
63bcc448 | 84 | //! Synchronize structure transformation |
79104795 | 85 | Standard_EXPORT virtual void UpdateTransformation() Standard_OVERRIDE; |
63bcc448 | 86 | |
87 | //! Highlight entire structure with color | |
b64d84be | 88 | Standard_EXPORT virtual void HighlightWithColor (const Graphic3d_Vec3& theColor, |
79104795 | 89 | const Standard_Boolean theToCreate) Standard_OVERRIDE; |
63bcc448 | 90 | |
91 | //! Highlight structure using boundary box | |
b64d84be | 92 | Standard_EXPORT virtual void HighlightWithBndBox (const Handle(Graphic3d_Structure)& theStruct, |
79104795 | 93 | const Standard_Boolean theToCreate) Standard_OVERRIDE; |
63bcc448 | 94 | |
679ecdee | 95 | //! Create shadow link to this structure |
79104795 | 96 | Standard_EXPORT virtual Handle(Graphic3d_CStructure) ShadowLink (const Handle(Graphic3d_StructureManager)& theManager) const Standard_OVERRIDE; |
b64d84be | 97 | |
98 | //! Create new group within this structure | |
79104795 | 99 | Standard_EXPORT virtual Handle(Graphic3d_Group) NewGroup (const Handle(Graphic3d_Structure)& theStruct) Standard_OVERRIDE; |
b64d84be | 100 | |
101 | //! Remove group from this structure | |
79104795 | 102 | Standard_EXPORT virtual void RemoveGroup (const Handle(Graphic3d_Group)& theGroup) Standard_OVERRIDE; |
679ecdee | 103 | |
63bcc448 | 104 | public: |
105 | ||
b64d84be | 106 | //! @return graphic groups |
107 | virtual const Graphic3d_SequenceOfGroup& DrawGroups() const | |
108 | { | |
109 | return myGroups; | |
110 | } | |
111 | ||
63bcc448 | 112 | //! Access graphic driver |
113 | OpenGl_GraphicDriver* GlDriver() const | |
114 | { | |
115 | return (OpenGl_GraphicDriver* )myGraphicDriver.operator->(); | |
116 | } | |
2166f0fa | 117 | |
fd4a6963 | 118 | void SetAspectLine (const CALL_DEF_CONTEXTLINE &theAspect); |
119 | void SetAspectFace (const CALL_DEF_CONTEXTFILLAREA& theAspect); | |
120 | void SetAspectMarker (const CALL_DEF_CONTEXTMARKER& theAspect); | |
121 | void SetAspectText (const CALL_DEF_CONTEXTTEXT &theAspect); | |
2166f0fa | 122 | |
b64d84be | 123 | void clearHighlightBox (const Handle(OpenGl_Context)& theGlCtx); |
5e27df78 | 124 | |
b64d84be | 125 | void setHighlightColor (const Handle(OpenGl_Context)& theGlCtx, |
63bcc448 | 126 | const Graphic3d_Vec3& theColor); |
2166f0fa | 127 | |
b64d84be | 128 | void clearHighlightColor (const Handle(OpenGl_Context)& theGlCtx); |
2166f0fa | 129 | |
b64d84be | 130 | Standard_EXPORT void Clear (const Handle(OpenGl_Context)& theGlCtx); |
2166f0fa | 131 | |
0717ddc1 | 132 | //! Renders groups of structure without applying any attributes (i.e. transform, material etc). |
cc6852f3 | 133 | //! @param theWorkspace current workspace |
134 | //! @param theHasClosed flag will be set to TRUE if structure contains at least one group of closed primitives | |
135 | virtual void renderGeometry (const Handle(OpenGl_Workspace)& theWorkspace, | |
136 | bool& theHasClosed) const; | |
137 | ||
138 | //! Renders groups of closed primitives without applying any attributes (i.e. transform, material etc). | |
139 | virtual void renderClosedGeometry (const Handle(OpenGl_Workspace)& theWorkspace) const; | |
0717ddc1 | 140 | |
141 | //! Renders the structure. | |
5e27df78 | 142 | virtual void Render (const Handle(OpenGl_Workspace)& theWorkspace) const; |
0717ddc1 | 143 | |
144 | //! Releases structure resources. | |
145 | virtual void Release (const Handle(OpenGl_Context)& theGlCtx); | |
5e27df78 | 146 | |
b7cd4ba7 | 147 | //! Marks structure as not overlapping view volume (as it is by default). |
148 | void ResetCullingStatus() const | |
149 | { | |
150 | if (!IsAlwaysRendered()) | |
151 | { | |
152 | myIsCulled = Standard_True; | |
153 | } | |
154 | } | |
155 | ||
156 | //! Marks structure as overlapping the current view volume one. | |
157 | //! The method is called during traverse of BVH tree. | |
158 | void MarkAsNotCulled() const { myIsCulled = Standard_False; } | |
159 | ||
160 | //! Returns Standard_False if the structure hits the current view volume, otherwise | |
161 | //! returns Standard_True. The default value for all structures before each traverse | |
162 | //! of BVH tree is Standard_True. | |
163 | Standard_Boolean IsCulled() const { return myIsCulled; } | |
164 | ||
165 | //! Checks if the structure should be included into BVH tree or not. | |
487bf1ce | 166 | Standard_Boolean IsAlwaysRendered() const |
b7cd4ba7 | 167 | { |
168 | return IsInfinite | |
169 | || IsForHighlight | |
170 | || IsMutable | |
171 | || Is2dText | |
97f937cc | 172 | || (TransformPersistence.Flags & Graphic3d_TMF_2d) != 0 |
173 | || (TransformPersistence.Flags & Graphic3d_TMF_PanPers) != 0 | |
174 | || (TransformPersistence.Flags & Graphic3d_TMF_TriedronPers) != 0; | |
b7cd4ba7 | 175 | } |
176 | ||
dd8a4ce9 | 177 | //! This method releases GL resources without actual elements destruction. |
e276548b | 178 | //! As result structure could be correctly destroyed layer without GL context |
dd8a4ce9 | 179 | //! (after last window was closed for example). |
180 | //! | |
181 | //! Notice however that reusage of this structure after calling this method is incorrect | |
182 | //! and will lead to broken visualization due to loosed data. | |
b64d84be | 183 | Standard_EXPORT void ReleaseGlResources (const Handle(OpenGl_Context)& theGlCtx); |
e276548b | 184 | |
d4aaad5b | 185 | //! Returns instanced OpenGL structure. |
186 | const OpenGl_Structure* InstancedStructure() const { return myInstancedStructure; } | |
e276548b | 187 | |
188 | //! Returns OpenGL face aspect. | |
189 | const OpenGl_AspectFace* AspectFace() const { return myAspectFace; } | |
190 | ||
e276548b | 191 | //! Returns structure modification state (for ray-tracing). |
192 | Standard_Size ModificationState() const { return myModificationState; } | |
193 | ||
189f85a3 | 194 | //! Resets structure modification state (for ray-tracing). |
e276548b | 195 | void ResetModificationState() const { myModificationState = 0; } |
196 | ||
197 | //! Is the structure ray-tracable (contains ray-tracable elements)? | |
d4aaad5b | 198 | Standard_Boolean IsRaytracable() const; |
e276548b | 199 | |
5e27df78 | 200 | protected: |
201 | ||
b64d84be | 202 | Standard_EXPORT virtual ~OpenGl_Structure(); |
5e27df78 | 203 | |
e276548b | 204 | //! Updates ray-tracable status for structure and its parents. |
d4aaad5b | 205 | void UpdateStateIfRaytracable (const Standard_Boolean toCheck = Standard_True) const; |
e276548b | 206 | |
5e27df78 | 207 | protected: |
2166f0fa | 208 | |
5e27df78 | 209 | OpenGl_AspectLine* myAspectLine; |
210 | OpenGl_AspectFace* myAspectFace; | |
211 | OpenGl_AspectMarker* myAspectMarker; | |
212 | OpenGl_AspectText* myAspectText; | |
63bcc448 | 213 | |
b64d84be | 214 | Handle(OpenGl_Group) myHighlightBox; |
5e27df78 | 215 | TEL_COLOUR* myHighlightColor; |
63bcc448 | 216 | |
d4aaad5b | 217 | OpenGl_Structure* myInstancedStructure; |
2166f0fa | 218 | |
d4aaad5b | 219 | mutable Standard_Boolean myIsRaytracable; |
220 | mutable Standard_Size myModificationState; | |
e276548b | 221 | |
d4aaad5b | 222 | mutable Standard_Boolean myIsCulled; //!< A status specifying is structure needs to be rendered after BVH tree traverse. |
b7cd4ba7 | 223 | |
d4aaad5b | 224 | Standard_Boolean myIsMirrored; //!< Used to tell OpenGl to interpret polygons in clockwise order. |
7d9e854b | 225 | |
5e27df78 | 226 | public: |
2166f0fa | 227 | |
ec357c5c | 228 | DEFINE_STANDARD_RTTI(OpenGl_Structure, Graphic3d_CStructure) // Type definition |
5e27df78 | 229 | |
2166f0fa SK |
230 | }; |
231 | ||
63bcc448 | 232 | DEFINE_STANDARD_HANDLE(OpenGl_Structure, Graphic3d_CStructure) |
233 | ||
234 | #endif // OpenGl_Structure_Header |