0024131: TKOpenGL redesign GPU memory management for markers presentation
[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 class OpenGl_Structure;
35
36 typedef NCollection_List<const OpenGl_Structure* > OpenGl_ListOfStructure;
37 typedef NCollection_List<const OpenGl_Group*     > OpenGl_ListOfGroup;
38
39 class OpenGl_Structure : public OpenGl_Element
40 {
41
42 public:
43
44   OpenGl_Structure();
45
46   void SetTransformation (const float *AMatrix);
47
48   void SetTransformPersistence (const CALL_DEF_TRANSFORM_PERSISTENCE &ATransPers);
49
50   void SetAspectLine (const CALL_DEF_CONTEXTLINE &AContext);
51   void SetAspectFace (const Handle(OpenGl_Context)&   theCtx,
52                       const CALL_DEF_CONTEXTFILLAREA& theAspect);
53   void SetAspectMarker (const Handle(OpenGl_Context)& theCtx,
54                         const CALL_DEF_CONTEXTMARKER& theAspect);
55   void SetAspectText (const CALL_DEF_CONTEXTTEXT &AContext);
56
57   void SetHighlightBox (const Handle(OpenGl_Context)& theGlCtx,
58                         const CALL_DEF_BOUNDBOX&      theBoundBox);
59
60   void ClearHighlightBox (const Handle(OpenGl_Context)& theGlCtx);
61
62   void SetHighlightColor (const Handle(OpenGl_Context)& theGlCtx,
63                           const Standard_ShortReal R,
64                           const Standard_ShortReal G,
65                           const Standard_ShortReal B);
66
67   void ClearHighlightColor (const Handle(OpenGl_Context)& theGlCtx);
68
69   void SetNamedStatus (const Standard_Integer aStatus) { myNamedStatus = aStatus; }
70
71   void Connect (const OpenGl_Structure *astructure);
72   void Disconnect (const OpenGl_Structure *astructure);
73
74   OpenGl_Group* AddGroup();
75   void RemoveGroup (const Handle(OpenGl_Context)& theGlCtx,
76                     const OpenGl_Group*           theGroup);
77   void Clear (const Handle(OpenGl_Context)& theGlCtx);
78
79   //! Set z layer ID to display the structure in specified layer
80   void SetZLayer (const Standard_Integer theLayerIndex);
81
82   //! Get z layer ID
83   Standard_Integer GetZLayer () const;
84
85   virtual void Render  (const Handle(OpenGl_Workspace)& theWorkspace) const;
86   virtual void Release (const Handle(OpenGl_Context)&   theGlCtx);
87
88   //! This method releases GL resources without actual elements destruction.
89   //! As result structure could be correctly destroyed layter without GL context
90   //! (after last window was closed for example).
91   //!
92   //! Notice however that reusage of this structure after calling this method is incorrect
93   //! and will lead to broken visualization due to loosed data.
94   void ReleaseGlResources (const Handle(OpenGl_Context)& theGlCtx);
95
96 protected:
97
98   virtual ~OpenGl_Structure();
99
100 protected:
101
102   //Structure_LABBegin
103   OpenGl_Matrix*             myTransformation;
104   TEL_TRANSFORM_PERSISTENCE* myTransPers;
105   OpenGl_AspectLine*         myAspectLine;
106   OpenGl_AspectFace*         myAspectFace;
107   OpenGl_AspectMarker*       myAspectMarker;
108   OpenGl_AspectText*         myAspectText;
109   //Structure_LABHighlight
110   OpenGl_Group*              myHighlightBox;
111   TEL_COLOUR*                myHighlightColor;
112   //Structure_LABVisibility
113   //Structure_LABPick
114   int                        myNamedStatus; //Structure_LABNameSet
115   int                        myZLayer;
116
117   OpenGl_ListOfStructure     myConnected;
118   OpenGl_ListOfGroup         myGroups;
119
120 public:
121
122   DEFINE_STANDARD_ALLOC
123
124 };
125
126 #endif //OpenGl_Structure_Header