src/OpenGl/OpenGl_Group.hxx

   1 // Created on: 2011-08-01
   2 // Created by: Sergey ZERCHANINOV
   3 // Copyright (c) 2011-2014 OPEN CASCADE SAS
   4 //
   5 // This file is part of Open CASCADE Technology software library.
   6 //
   7 // This library is free software; you can redistribute it and/or modify it under
   8 // the terms of the GNU Lesser General Public License version 2.1 as published
   9 // by the Free Software Foundation, with special exception defined in the file
  10 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  11 // distribution for complete text of the license and disclaimer of any warranty.
  12 //
  13 // Alternatively, this file may be used under the terms of Open CASCADE
  14 // commercial license or contractual agreement.
  15
  16 #ifndef _OpenGl_Group_Header
  17 #define _OpenGl_Group_Header
  18
  19 #include <InterfaceGraphic_Graphic3d.hxx>
  20 #include <Graphic3d_Group.hxx>
  21 #include <Graphic3d_Structure.hxx>
  22
  23 #include <NCollection_List.hxx>
  24 #include <OpenGl_AspectLine.hxx>
  25 #include <OpenGl_AspectFace.hxx>
  26 #include <OpenGl_AspectMarker.hxx>
  27 #include <OpenGl_AspectText.hxx>
  28 #include <OpenGl_Element.hxx>
  29
  30 class OpenGl_Group;
  31 class OpenGl_Structure;
  32
  33 struct OpenGl_ElementNode
  34 {
  35   OpenGl_Element*     elem;
  36   OpenGl_ElementNode* next;
  37   DEFINE_STANDARD_ALLOC
  38 };
  39
  40 //! Implementation of low-level graphic group.
  41 class OpenGl_Group : public Graphic3d_Group
  42 {
  43 public:
  44
  45   //! Create empty group.
  46   //! Will throw exception if not created by OpenGl_Structure.
  47   Standard_EXPORT OpenGl_Group (const Handle(Graphic3d_Structure)& theStruct);
  48
  49   Standard_EXPORT virtual void Clear (const Standard_Boolean theToUpdateStructureMgr);
  50
  51   //! Update line aspect
  52   Standard_EXPORT virtual void UpdateAspectLine   (const Standard_Boolean theIsGlobal);
  53
  54   //! Update fill aspect
  55   Standard_EXPORT virtual void UpdateAspectFace   (const Standard_Boolean theIsGlobal);
  56
  57   //! Update marker aspect
  58   Standard_EXPORT virtual void UpdateAspectMarker (const Standard_Boolean theIsGlobal);
  59
  60   //! Update text aspect
  61   Standard_EXPORT virtual void UpdateAspectText   (const Standard_Boolean theIsGlobal);
  62
  63   //! Add primitive array element
  64   Standard_EXPORT virtual void AddPrimitiveArray (const Handle(Graphic3d_ArrayOfPrimitives)& thePrim,
  65                                                   const Standard_Boolean                     theToEvalMinMax);
  66
  67   //! Add text element
  68   Standard_EXPORT virtual void Text (const Standard_CString                  theTextUtf,
  69                                      const Graphic3d_Vertex&                 thePoint,
  70                                      const Standard_Real                     theHeight,
  71                                      const Quantity_PlaneAngle               theAngle,
  72                                      const Graphic3d_TextPath                theTp,
  73                                      const Graphic3d_HorizontalTextAlignment theHta,
  74                                      const Graphic3d_VerticalTextAlignment   theVta,
  75                                      const Standard_Boolean                  theToEvalMinMax);
  76
  77   //! Add UserDraw element using obsolete API
  78   Standard_EXPORT virtual void UserDraw (const Standard_Address theObject,
  79                                          const Standard_Boolean theToEvalMinMax,
  80                                          const Standard_Boolean theContainsFacet);
  81
  82   //! Add flipping element
  83   Standard_EXPORT virtual void SetFlippingOptions (const Standard_Boolean theIsEnabled,
  84                                                    const gp_Ax2&          theRefPlane);
  85
  86   //! Add stencil test element
  87   Standard_EXPORT virtual void SetStencilTestOptions (const Standard_Boolean theIsEnabled);
  88
  89 public:
  90
  91   OpenGl_Structure* GlStruct() const { return (OpenGl_Structure* )(myStructure->CStructure().operator->()); }
  92
  93   Standard_EXPORT void AddElement (OpenGl_Element* theElem);
  94
  95   Standard_EXPORT virtual void Render  (const Handle(OpenGl_Workspace)& theWorkspace) const;
  96   Standard_EXPORT virtual void Release (const Handle(OpenGl_Context)&   theGlCtx);
  97
  98   //! Returns first OpenGL element node of the group.
  99   const OpenGl_ElementNode* FirstNode() const { return myFirst; }
 100
 101   //! Returns OpenGL face aspect.
 102   const OpenGl_AspectFace* AspectFace() const { return myAspectFace; }
 103
 104   //! Returns modification state for ray-tracing.
 105   Standard_Size ModificationState() const { return myModificationState; }
 106
 107   //! Is the group ray-tracable (contains ray-tracable elements)?
 108   Standard_Boolean IsRaytracable() const { return myIsRaytracable; }
 109
 110   //! Accessor to line aspect (to be removed)
 111   CALL_DEF_CONTEXTLINE& ChangeContextLine() { return ContextLine; }
 112
 113 protected:
 114
 115   Standard_EXPORT virtual ~OpenGl_Group();
 116
 117 protected:
 118
 119   OpenGl_AspectLine*     myAspectLine;
 120   OpenGl_AspectFace*     myAspectFace;
 121   OpenGl_AspectMarker*   myAspectMarker;
 122   OpenGl_AspectText*     myAspectText;
 123
 124   OpenGl_ElementNode*    myFirst;
 125   OpenGl_ElementNode*    myLast;
 126
 127   Standard_Boolean       myIsRaytracable;
 128   Standard_Size          myModificationState;
 129
 130 public:
 131
 132   DEFINE_STANDARD_RTTI(OpenGl_Group) // Type definition
 133
 134 };
 135
 136 DEFINE_STANDARD_HANDLE(OpenGl_Group, Graphic3d_Group)
 137
 138 #endif // _OpenGl_Group_Header