0024192: Adding support for shaders to OCCT visualization toolkit
[occt.git] / src / OpenGl / OpenGl_Structure.hxx
1 // Created on: 2011-08-01
2 // Created by: Sergey ZERCHANINOV
3 // Copyright (c) 2011-2012 OPEN CASCADE SAS
4 //
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.
9 //
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.
12 //
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.
19
20 #ifndef OpenGl_Structure_Header
21 #define OpenGl_Structure_Header
22
23 #include <NCollection_List.hxx>
24 #include <InterfaceGraphic_Graphic3d.hxx>
25
26 #include <OpenGl_AspectLine.hxx>
27 #include <OpenGl_AspectFace.hxx>
28 #include <OpenGl_AspectMarker.hxx>
29 #include <OpenGl_AspectText.hxx>
30
31 #include <OpenGl_Group.hxx>
32 #include <OpenGl_Matrix.hxx>
33
34 #include <Graphic3d_SetOfHClipPlane.hxx>
35
36 class OpenGl_Structure;
37
38 typedef NCollection_List<const OpenGl_Structure* > OpenGl_ListOfStructure;
39
40 class OpenGl_Structure : public OpenGl_Element
41 {
42
43 public:
44
45   OpenGl_Structure();
46
47   void SetTransformation (const float *AMatrix);
48
49   void SetTransformPersistence (const CALL_DEF_TRANSFORM_PERSISTENCE &ATransPers);
50
51   void SetAspectLine   (const CALL_DEF_CONTEXTLINE &theAspect);
52   void SetAspectFace   (const CALL_DEF_CONTEXTFILLAREA& theAspect);
53   void SetAspectMarker (const CALL_DEF_CONTEXTMARKER& theAspect);
54   void SetAspectText   (const CALL_DEF_CONTEXTTEXT &theAspect);
55
56   void SetHighlightBox (const Handle(OpenGl_Context)& theGlCtx,
57                         const CALL_DEF_BOUNDBOX& theBoundBox);
58
59   void ClearHighlightBox (const Handle(OpenGl_Context)& theGlCtx);
60
61   void SetHighlightColor (const Handle(OpenGl_Context)& theGlCtx,
62                           const Standard_ShortReal R,
63                           const Standard_ShortReal G,
64                           const Standard_ShortReal B);
65
66   void ClearHighlightColor (const Handle(OpenGl_Context)& theGlCtx);
67
68   void SetNamedStatus (const Standard_Integer aStatus) { myNamedStatus = aStatus; }
69
70   void SetClipPlanes (const Graphic3d_SetOfHClipPlane& thePlanes) { myClipPlanes = thePlanes; }
71
72   void Connect (const OpenGl_Structure *astructure);
73   void Disconnect (const OpenGl_Structure *astructure);
74
75   OpenGl_Group* AddGroup();
76   void RemoveGroup (const Handle(OpenGl_Context)& theGlCtx,
77                     const OpenGl_Group*           theGroup);
78   void Clear (const Handle(OpenGl_Context)& theGlCtx);
79
80   //! Set z layer ID to display the structure in specified layer
81   void SetZLayer (const Standard_Integer theLayerIndex);
82
83   //! Get z layer ID
84   Standard_Integer GetZLayer () const;
85
86   virtual void Render  (const Handle(OpenGl_Workspace)& theWorkspace) const;
87   virtual void Release (const Handle(OpenGl_Context)&   theGlCtx);
88
89   //! This method releases GL resources without actual elements destruction.
90   //! As result structure could be correctly destroyed layter without GL context
91   //! (after last window was closed for example).
92   //!
93   //! Notice however that reusage of this structure after calling this method is incorrect
94   //! and will lead to broken visualization due to loosed data.
95   void ReleaseGlResources (const Handle(OpenGl_Context)& theGlCtx);
96
97 protected:
98
99   virtual ~OpenGl_Structure();
100
101 protected:
102
103   //Structure_LABBegin
104   OpenGl_Matrix*             myTransformation;
105   TEL_TRANSFORM_PERSISTENCE* myTransPers;
106   OpenGl_AspectLine*         myAspectLine;
107   OpenGl_AspectFace*         myAspectFace;
108   OpenGl_AspectMarker*       myAspectMarker;
109   OpenGl_AspectText*         myAspectText;
110   //Structure_LABHighlight
111   OpenGl_Group*              myHighlightBox;
112   TEL_COLOUR*                myHighlightColor;
113   //Structure_LABVisibility
114   //Structure_LABPick
115   int                        myNamedStatus; //Structure_LABNameSet
116   int                        myZLayer;
117
118   OpenGl_ListOfStructure     myConnected;
119   OpenGl_ListOfGroup         myGroups;
120   Graphic3d_SetOfHClipPlane  myClipPlanes;
121
122 public:
123
124   DEFINE_STANDARD_ALLOC
125
126 };
127
128 #endif //OpenGl_Structure_Header