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