1 // Created on: 2011-08-01
2 // Created by: Sergey ZERCHANINOV
3 // Copyright (c) 2011-2012 OPEN CASCADE SAS
5 // The content of this file is subject to the Open CASCADE Technology Public
6 // License Version 6.5 (the "License"). You may not use the content of this file
7 // except in compliance with the License. Please obtain a copy of the License
8 // at http://www.opencascade.org and read it completely before using this file.
10 // The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
11 // main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
13 // The Original Code and all software distributed under the License is
14 // distributed on an "AS IS" basis, without warranty of any kind, and the
15 // Initial Developer hereby disclaims all such warranties, including without
16 // limitation, any warranties of merchantability, fitness for a particular
17 // purpose or non-infringement. Please see the License for the specific terms
18 // and conditions governing the rights and limitations under the License.
20 #ifndef OpenGl_Structure_Header
21 #define OpenGl_Structure_Header
23 #include <NCollection_List.hxx>
24 #include <InterfaceGraphic_Graphic3d.hxx>
26 #include <OpenGl_AspectLine.hxx>
27 #include <OpenGl_AspectFace.hxx>
28 #include <OpenGl_AspectMarker.hxx>
29 #include <OpenGl_AspectText.hxx>
31 #include <OpenGl_Group.hxx>
32 #include <OpenGl_Matrix.hxx>
33 #include <OpenGl_NamedStatus.hxx>
35 #include <Graphic3d_SetOfHClipPlane.hxx>
37 class OpenGl_Structure;
39 typedef NCollection_List<const OpenGl_Structure* > OpenGl_ListOfStructure;
41 class OpenGl_Structure : public OpenGl_Element
43 friend class OpenGl_Group;
49 void SetTransformation (const float *AMatrix);
51 void SetTransformPersistence (const CALL_DEF_TRANSFORM_PERSISTENCE &ATransPers);
53 void SetAspectLine (const CALL_DEF_CONTEXTLINE &theAspect);
54 void SetAspectFace (const CALL_DEF_CONTEXTFILLAREA& theAspect);
55 void SetAspectMarker (const CALL_DEF_CONTEXTMARKER& theAspect);
56 void SetAspectText (const CALL_DEF_CONTEXTTEXT &theAspect);
58 void SetHighlightBox (const Handle(OpenGl_Context)& theGlCtx,
59 const CALL_DEF_BOUNDBOX& theBoundBox);
61 void ClearHighlightBox (const Handle(OpenGl_Context)& theGlCtx);
63 void SetHighlightColor (const Handle(OpenGl_Context)& theGlCtx,
64 const Standard_ShortReal R,
65 const Standard_ShortReal G,
66 const Standard_ShortReal B);
68 void ClearHighlightColor (const Handle(OpenGl_Context)& theGlCtx);
70 void SetNamedStatus (const Standard_Integer aStatus);
72 Standard_Boolean IsVisible() const { return !(myNamedStatus & OPENGL_NS_HIDE); }
74 void SetClipPlanes (const Graphic3d_SetOfHClipPlane& thePlanes) { myClipPlanes = thePlanes; }
76 void Connect (const OpenGl_Structure *astructure);
77 void Disconnect (const OpenGl_Structure *astructure);
79 OpenGl_Group* AddGroup();
80 void RemoveGroup (const Handle(OpenGl_Context)& theGlCtx,
81 const OpenGl_Group* theGroup);
82 void Clear (const Handle(OpenGl_Context)& theGlCtx);
84 //! Set z layer ID to display the structure in specified layer
85 void SetZLayer (const Standard_Integer theLayerIndex);
88 Standard_Integer GetZLayer () const;
90 virtual void Render (const Handle(OpenGl_Workspace)& theWorkspace) const;
91 virtual void Release (const Handle(OpenGl_Context)& theGlCtx);
93 //! This method releases GL resources without actual elements destruction.
94 //! As result structure could be correctly destroyed layer without GL context
95 //! (after last window was closed for example).
97 //! Notice however that reusage of this structure after calling this method is incorrect
98 //! and will lead to broken visualization due to loosed data.
99 void ReleaseGlResources (const Handle(OpenGl_Context)& theGlCtx);
101 //! Returns list of OpenGL groups.
102 const OpenGl_ListOfGroup& Groups() const { return myGroups; }
104 //! Returns list of connected OpenGL structures.
105 const OpenGl_ListOfStructure& ConnectedStructures() const { return myConnected; }
107 //! Returns OpenGL face aspect.
108 const OpenGl_AspectFace* AspectFace() const { return myAspectFace; }
110 //! Returns OpenGL transformation matrix.
111 const OpenGl_Matrix* Transformation() const { return myTransformation; }
113 //! Returns OpenGL persistent translation.
114 const TEL_TRANSFORM_PERSISTENCE* PersistentTranslation() const { return myTransPers; }
118 //! Returns structure modification state (for ray-tracing).
119 Standard_Size ModificationState() const { return myModificationState; }
121 //! Resets structure modification state (for ray-tracing)
122 void ResetModificationState() const { myModificationState = 0; }
124 //! Is the structure ray-tracable (contains ray-tracable elements)?
125 Standard_Boolean IsRaytracable() const { return myIsRaytracable; }
131 virtual ~OpenGl_Structure();
135 //! Registers ancestor connected structure (for updating ray-tracing state).
136 void RegisterAncestorStructure (const OpenGl_Structure* theStructure) const;
138 //! Unregisters ancestor connected structure (for updating ray-tracing state).
139 void UnregisterAncestorStructure (const OpenGl_Structure* theStructure) const;
141 //! Updates modification state for structure and its parents.
142 void UpdateStateWithAncestorStructures() const;
144 //! Updates ray-tracable status for structure and its parents.
145 void UpdateRaytracableWithAncestorStructures() const;
147 //! Sets ray-tracable status for structure and its parents.
148 void SetRaytracableWithAncestorStructures() const;
155 OpenGl_Matrix* myTransformation;
156 TEL_TRANSFORM_PERSISTENCE* myTransPers;
157 OpenGl_AspectLine* myAspectLine;
158 OpenGl_AspectFace* myAspectFace;
159 OpenGl_AspectMarker* myAspectMarker;
160 OpenGl_AspectText* myAspectText;
161 //Structure_LABHighlight
162 OpenGl_Group* myHighlightBox;
163 TEL_COLOUR* myHighlightColor;
164 //Structure_LABVisibility
166 int myNamedStatus; //Structure_LABNameSet
169 OpenGl_ListOfStructure myConnected;
170 OpenGl_ListOfGroup myGroups;
171 Graphic3d_SetOfHClipPlane myClipPlanes;
174 mutable OpenGl_ListOfStructure myAncestorStructures;
175 mutable Standard_Boolean myIsRaytracable;
176 mutable Standard_Size myModificationState;
181 DEFINE_STANDARD_ALLOC
185 #endif //OpenGl_Structure_Header