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