src/Graphic3d/Graphic3d_CStructure.hxx

   1 // Copyright (c) 1995-1999 Matra Datavision
   2 // Copyright (c) 1999-2014 OPEN CASCADE SAS
   3 //
   4 // This file is part of Open CASCADE Technology software library.
   5 //
   6 // This library is free software; you can redistribute it and/or modify it under
   7 // the terms of the GNU Lesser General Public License version 2.1 as published
   8 // by the Free Software Foundation, with special exception defined in the file
   9 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  10 // distribution for complete text of the license and disclaimer of any warranty.
  11 //
  12 // Alternatively, this file may be used under the terms of Open CASCADE
  13 // commercial license or contractual agreement.
  14
  15 #ifndef _Graphic3d_CStructure_HeaderFile
  16 #define _Graphic3d_CStructure_HeaderFile
  17
  18 #include <Graphic3d_BndBox4f.hxx>
  19 #include <Graphic3d_Group.hxx>
  20 #include <Graphic3d_SequenceOfGroup.hxx>
  21 #include <Graphic3d_SequenceOfHClipPlane.hxx>
  22 #include <Graphic3d_TypeOfComposition.hxx>
  23 #include <Graphic3d_ViewAffinity.hxx>
  24 #include <Graphic3d_StructureManager.hxx>
  25 #include <Graphic3d_Vec3.hxx>
  26 #include <Graphic3d_ZLayerId.hxx>
  27 #include <Standard_Transient.hxx>
  28 #include <Handle_Graphic3d_GraphicDriver.hxx>
  29
  30 //! Forward declaration.
  31 class Handle(Graphic3d_StructureManager);
  32 class Handle(Graphic3d_CStructure);
  33
  34 //! Low-level graphic structure interface
  35 class Graphic3d_CStructure : public Standard_Transient
  36 {
  37
  38 public:
  39
  40   //! @return graphic driver created this structure
  41   const Handle(Graphic3d_GraphicDriver)& GraphicDriver() const
  42   {
  43     return myGraphicDriver;
  44   }
  45
  46   //! @return graphic groups
  47   const Graphic3d_SequenceOfGroup& Groups() const
  48   {
  49     return myGroups;
  50   }
  51
  52   //! @return associated clip planes
  53   const Graphic3d_SequenceOfHClipPlane& ClipPlanes() const
  54   {
  55     return myClipPlanes;
  56   }
  57
  58   //! Pass clip planes to the associated graphic driver structure
  59   void SetClipPlanes (const Graphic3d_SequenceOfHClipPlane& thePlanes) { myClipPlanes = thePlanes; }
  60
  61   //! @return bounding box of this presentation
  62   const Graphic3d_BndBox4f& BoundingBox() const
  63   {
  64     return myBndBox;
  65   }
  66
  67   //! @return bounding box of this presentation
  68   //! without transformation matrix applied
  69   Graphic3d_BndBox4f& ChangeBoundingBox()
  70   {
  71     return myBndBox;
  72   }
  73
  74   //! Return structure visibility flag
  75   bool IsVisible() const { return visible != 0; }
  76
  77   //! Set z layer ID to display the structure in specified layer
  78   void SetZLayer (const Graphic3d_ZLayerId theLayerIndex) { myZLayer = theLayerIndex; }
  79
  80   //! Get z layer ID
  81   Graphic3d_ZLayerId ZLayer() const { return myZLayer; }
  82
  83 public:
  84
  85   //! Update structure visibility state
  86   virtual void OnVisibilityChanged() = 0;
  87
  88   //! Clear graphic data
  89   virtual void Clear() = 0;
  90
  91   //! Connect other structure to this one
  92   virtual void Connect    (Graphic3d_CStructure& theStructure) = 0;
  93
  94   //! Disconnect other structure to this one
  95   virtual void Disconnect (Graphic3d_CStructure& theStructure) = 0;
  96
  97   //! Synchronize structure aspects
  98   virtual void UpdateAspects() = 0;
  99
 100   //! Synchronize structure transformation
 101   virtual void UpdateTransformation() = 0;
 102
 103   //! Highlight entire structure with color
 104   virtual void HighlightWithColor  (const Graphic3d_Vec3&  theColor,
 105                                     const Standard_Boolean theToCreate) = 0;
 106
 107   //! Highlight structure using boundary box
 108   virtual void HighlightWithBndBox (const Handle(Graphic3d_Structure)& theStruct,
 109                                     const Standard_Boolean             theToCreate) = 0;
 110
 111   //! Create shadow link to this structure
 112   virtual Handle(Graphic3d_CStructure) ShadowLink (const Handle(Graphic3d_StructureManager)& theManager) const = 0;
 113
 114   //! Create new group within this structure
 115   virtual Handle(Graphic3d_Group) NewGroup (const Handle(Graphic3d_Structure)& theStruct) = 0;
 116
 117   //! Remove group from this structure
 118   virtual void RemoveGroup (const Handle(Graphic3d_Group)& theGroup) = 0;
 119
 120 public:
 121
 122   int                      Id;
 123   Graphic3d_ZLayerId       myZLayer;
 124   int                      Priority;
 125   int                      PreviousPriority;
 126
 127   CALL_DEF_CONTEXTLINE     ContextLine;
 128   CALL_DEF_CONTEXTFILLAREA ContextFillArea;
 129   CALL_DEF_CONTEXTMARKER   ContextMarker;
 130   CALL_DEF_CONTEXTTEXT     ContextText;
 131
 132   CALL_DEF_COLOR HighlightColor;
 133
 134   float Transformation[4][4];
 135   Graphic3d_TypeOfComposition Composition;
 136
 137   int   ContainsFacet;
 138
 139   Handle(Graphic3d_ViewAffinity) ViewAffinity; //!< view affinity mask
 140
 141   unsigned IsInfinite     : 1;
 142   unsigned stick          : 1; //!< displaying state - should be set when structure has been added to scene graph (but can be in hidden state)
 143   unsigned highlight      : 1;
 144   unsigned visible        : 1; //!< visibility flag - can be used to suppress structure while leaving it in the scene graph
 145   unsigned HLRValidation  : 1;
 146   unsigned IsForHighlight : 1;
 147   unsigned IsMutable      : 1;
 148   unsigned Is2dText       : 1;
 149
 150   CALL_DEF_TRANSFORM_PERSISTENCE TransformPersistence;
 151
 152 protected:
 153
 154   //! Create empty structure.
 155   Standard_EXPORT Graphic3d_CStructure (const Handle(Graphic3d_StructureManager)& theManager);
 156
 157 protected:
 158
 159   Handle(Graphic3d_GraphicDriver) myGraphicDriver;
 160   Graphic3d_SequenceOfGroup       myGroups;
 161   Graphic3d_BndBox4f              myBndBox;
 162   Graphic3d_SequenceOfHClipPlane  myClipPlanes;
 163
 164 public:
 165
 166   DEFINE_STANDARD_RTTI(Graphic3d_CStructure, Standard_Transient) // Type definition
 167
 168 };
 169
 170 DEFINE_STANDARD_HANDLE (Graphic3d_CStructure, Standard_Transient)
 171
 172 #endif // _Graphic3d_CStructure_HeaderFile