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_TransformPers.hxx>
  25 #include <Graphic3d_Vec3.hxx>
  26 #include <Graphic3d_ZLayerId.hxx>
  27
  28 class Graphic3d_GraphicDriver;
  29 class Graphic3d_StructureManager;
  30
  31 //! Low-level graphic structure interface
  32 class Graphic3d_CStructure : public Standard_Transient
  33 {
  34
  35 public:
  36
  37   //! @return graphic driver created this structure
  38   const Handle(Graphic3d_GraphicDriver)& GraphicDriver() const
  39   {
  40     return myGraphicDriver;
  41   }
  42
  43   //! @return graphic groups
  44   const Graphic3d_SequenceOfGroup& Groups() const
  45   {
  46     return myGroups;
  47   }
  48
  49   //! @return associated clip planes
  50   const Graphic3d_SequenceOfHClipPlane& ClipPlanes() const
  51   {
  52     return myClipPlanes;
  53   }
  54
  55   //! Pass clip planes to the associated graphic driver structure
  56   void SetClipPlanes (const Graphic3d_SequenceOfHClipPlane& thePlanes) { myClipPlanes = thePlanes; }
  57
  58   //! @return bounding box of this presentation
  59   const Graphic3d_BndBox4f& BoundingBox() const
  60   {
  61     return myBndBox;
  62   }
  63
  64   //! @return bounding box of this presentation
  65   //! without transformation matrix applied
  66   Graphic3d_BndBox4f& ChangeBoundingBox()
  67   {
  68     return myBndBox;
  69   }
  70
  71   //! Return structure visibility flag
  72   bool IsVisible() const { return visible != 0; }
  73
  74   //! Set z layer ID to display the structure in specified layer
  75   void SetZLayer (const Graphic3d_ZLayerId theLayerIndex) { myZLayer = theLayerIndex; }
  76
  77   //! Get z layer ID
  78   Graphic3d_ZLayerId ZLayer() const { return myZLayer; }
  79
  80 public:
  81
  82   //! Update structure visibility state
  83   virtual void OnVisibilityChanged() = 0;
  84
  85   //! Clear graphic data
  86   virtual void Clear() = 0;
  87
  88   //! Connect other structure to this one
  89   virtual void Connect    (Graphic3d_CStructure& theStructure) = 0;
  90
  91   //! Disconnect other structure to this one
  92   virtual void Disconnect (Graphic3d_CStructure& theStructure) = 0;
  93
  94   //! Synchronize structure aspects
  95   virtual void UpdateAspects() = 0;
  96
  97   //! Synchronize structure transformation
  98   virtual void UpdateTransformation() = 0;
  99
 100   //! Highlight entire structure with color
 101   virtual void HighlightWithColor  (const Graphic3d_Vec3&  theColor,
 102                                     const Standard_Boolean theToCreate) = 0;
 103
 104   //! Highlight structure using boundary box
 105   virtual void HighlightWithBndBox (const Handle(Graphic3d_Structure)& theStruct,
 106                                     const Standard_Boolean             theToCreate) = 0;
 107
 108   //! Create shadow link to this structure
 109   virtual Handle(Graphic3d_CStructure) ShadowLink (const Handle(Graphic3d_StructureManager)& theManager) const = 0;
 110
 111   //! Create new group within this structure
 112   virtual Handle(Graphic3d_Group) NewGroup (const Handle(Graphic3d_Structure)& theStruct) = 0;
 113
 114   //! Remove group from this structure
 115   virtual void RemoveGroup (const Handle(Graphic3d_Group)& theGroup) = 0;
 116
 117 public:
 118
 119   int                      Id;
 120   Graphic3d_ZLayerId       myZLayer;
 121   int                      Priority;
 122   int                      PreviousPriority;
 123
 124   CALL_DEF_CONTEXTLINE     ContextLine;
 125   CALL_DEF_CONTEXTFILLAREA ContextFillArea;
 126   CALL_DEF_CONTEXTMARKER   ContextMarker;
 127   CALL_DEF_CONTEXTTEXT     ContextText;
 128
 129   CALL_DEF_COLOR HighlightColor;
 130
 131   float Transformation[4][4];
 132   Graphic3d_TypeOfComposition Composition;
 133
 134   int   ContainsFacet;
 135
 136   Handle(Graphic3d_ViewAffinity) ViewAffinity; //!< view affinity mask
 137
 138   unsigned IsInfinite     : 1;
 139   unsigned stick          : 1; //!< displaying state - should be set when structure has been added to scene graph (but can be in hidden state)
 140   unsigned highlight      : 1;
 141   unsigned visible        : 1; //!< visibility flag - can be used to suppress structure while leaving it in the scene graph
 142   unsigned HLRValidation  : 1;
 143   unsigned IsForHighlight : 1;
 144   unsigned IsMutable      : 1;
 145   unsigned Is2dText       : 1;
 146
 147   Graphic3d_TransformPers TransformPersistence;
 148
 149 protected:
 150
 151   //! Create empty structure.
 152   Standard_EXPORT Graphic3d_CStructure (const Handle(Graphic3d_StructureManager)& theManager);
 153
 154 protected:
 155
 156   Handle(Graphic3d_GraphicDriver) myGraphicDriver;
 157   Graphic3d_SequenceOfGroup       myGroups;
 158   Graphic3d_BndBox4f              myBndBox;
 159   Graphic3d_SequenceOfHClipPlane  myClipPlanes;
 160
 161 public:
 162
 163   DEFINE_STANDARD_RTTI(Graphic3d_CStructure, Standard_Transient) // Type definition
 164
 165 };
 166
 167 DEFINE_STANDARD_HANDLE (Graphic3d_CStructure, Standard_Transient)
 168
 169 #endif // _Graphic3d_CStructure_HeaderFile