0027816: Visualization - provide an API for overriding clipping planes list
[occt.git] / 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 Handle(Graphic3d_SequenceOfHClipPlane)& ClipPlanes() const
51   {
52     return myClipPlanes;
53   }
54
55   //! Pass clip planes to the associated graphic driver structure
56   void SetClipPlanes (const Handle(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   //! Return structure visibility considering both View Affinity and global visibility state.
75   bool IsVisible (const Standard_Integer theViewId) const
76   {
77     return visible != 0
78         && (ViewAffinity.IsNull()
79          || ViewAffinity->IsVisible (theViewId));
80   }
81
82   //! Set z layer ID to display the structure in specified layer
83   void SetZLayer (const Graphic3d_ZLayerId theLayerIndex) { myZLayer = theLayerIndex; }
84
85   //! Get z layer ID
86   Graphic3d_ZLayerId ZLayer() const { return myZLayer; }
87
88 public:
89
90   //! Update structure visibility state
91   virtual void OnVisibilityChanged() = 0;
92
93   //! Clear graphic data
94   virtual void Clear() = 0;
95
96   //! Connect other structure to this one
97   virtual void Connect    (Graphic3d_CStructure& theStructure) = 0;
98
99   //! Disconnect other structure to this one
100   virtual void Disconnect (Graphic3d_CStructure& theStructure) = 0;
101
102   //! Synchronize structure transformation
103   virtual void UpdateTransformation() = 0;
104
105   //! Highlight entire structure with color
106   virtual void HighlightWithColor  (const Graphic3d_Vec3&  theColor,
107                                     const Standard_Boolean theToCreate) = 0;
108
109   //! Highlight structure using boundary box
110   virtual void HighlightWithBndBox (const Handle(Graphic3d_Structure)& theStruct,
111                                     const Standard_Boolean             theToCreate) = 0;
112
113   //! Create shadow link to this structure
114   virtual Handle(Graphic3d_CStructure) ShadowLink (const Handle(Graphic3d_StructureManager)& theManager) const = 0;
115
116   //! Create new group within this structure
117   virtual Handle(Graphic3d_Group) NewGroup (const Handle(Graphic3d_Structure)& theStruct) = 0;
118
119   //! Remove group from this structure
120   virtual void RemoveGroup (const Handle(Graphic3d_Group)& theGroup) = 0;
121
122 public:
123
124   int                      Id;
125   Graphic3d_ZLayerId       myZLayer;
126   int                      Priority;
127   int                      PreviousPriority;
128
129   Quantity_Color           HighlightColor;
130
131   Graphic3d_Mat4           Transformation;
132
133   int   ContainsFacet;
134
135   Handle(Graphic3d_ViewAffinity) ViewAffinity; //!< view affinity mask
136
137   unsigned IsInfinite     : 1;
138   unsigned stick          : 1; //!< displaying state - should be set when structure has been added to scene graph (but can be in hidden state)
139   unsigned highlight      : 1;
140   unsigned visible        : 1; //!< visibility flag - can be used to suppress structure while leaving it in the scene graph
141   unsigned HLRValidation  : 1;
142   unsigned IsForHighlight : 1;
143   unsigned IsMutable      : 1;
144   unsigned Is2dText       : 1;
145
146   Graphic3d_TransformPers TransformPersistence;
147
148 protected:
149
150   //! Create empty structure.
151   Standard_EXPORT Graphic3d_CStructure (const Handle(Graphic3d_StructureManager)& theManager);
152
153 protected:
154
155   Handle(Graphic3d_GraphicDriver) myGraphicDriver;
156   Graphic3d_SequenceOfGroup       myGroups;
157   Graphic3d_BndBox4f              myBndBox;
158   Handle(Graphic3d_SequenceOfHClipPlane) myClipPlanes;
159
160 public:
161
162   DEFINE_STANDARD_RTTIEXT(Graphic3d_CStructure,Standard_Transient) // Type definition
163
164 };
165
166 DEFINE_STANDARD_HANDLE (Graphic3d_CStructure, Standard_Transient)
167
168 #endif // _Graphic3d_CStructure_HeaderFile