1 // Copyright (c) 1995-1999 Matra Datavision
2 // Copyright (c) 1999-2014 OPEN CASCADE SAS
4 // This file is part of Open CASCADE Technology software library.
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.
12 // Alternatively, this file may be used under the terms of Open CASCADE
13 // commercial license or contractual agreement.
15 #ifndef _Graphic3d_CStructure_HeaderFile
16 #define _Graphic3d_CStructure_HeaderFile
18 #include <Graphic3d_BndBox4f.hxx>
19 #include <Graphic3d_CStructure_Handle.hxx>
20 #include <Graphic3d_Group.hxx>
21 #include <Graphic3d_SequenceOfGroup.hxx>
22 #include <Graphic3d_SequenceOfHClipPlane.hxx>
23 #include <Graphic3d_TypeOfComposition.hxx>
24 #include <Graphic3d_Vec3.hxx>
25 #include <Graphic3d_ZLayerId.hxx>
26 #include <Standard_Transient.hxx>
27 #include <Handle_Graphic3d_GraphicDriver.hxx>
29 class Handle(Graphic3d_StructureManager);
31 //! Low-level graphic structure interface
32 class Graphic3d_CStructure : public Standard_Transient
37 //! @return graphic driver created this structure
38 const Handle(Graphic3d_GraphicDriver)& GraphicDriver() const
40 return myGraphicDriver;
43 //! @return graphic groups
44 const Graphic3d_SequenceOfGroup& Groups() const
49 //! @return associated clip planes
50 const Graphic3d_SequenceOfHClipPlane& ClipPlanes() const
55 //! Pass clip planes to the associated graphic driver structure
56 void SetClipPlanes (const Graphic3d_SequenceOfHClipPlane& thePlanes) { myClipPlanes = thePlanes; }
58 //! @return bounding box of this presentation
59 const Graphic3d_BndBox4f& BoundingBox() const
64 //! @return bounding box of this presentation
65 //! without transformation matrix applied
66 Graphic3d_BndBox4f& ChangeBoundingBox()
71 //! Return structure visibility flag
72 bool IsVisible() const { return visible != 0; }
74 //! Set z layer ID to display the structure in specified layer
75 void SetZLayer (const Graphic3d_ZLayerId theLayerIndex) { myZLayer = theLayerIndex; }
78 Graphic3d_ZLayerId ZLayer() const { return myZLayer; }
82 //! Update structure visibility state
83 virtual void OnVisibilityChanged() = 0;
85 //! Clear graphic data
86 virtual void Clear() = 0;
88 //! Connect other structure to this one
89 virtual void Connect (Graphic3d_CStructure& theStructure) = 0;
91 //! Disconnect other structure to this one
92 virtual void Disconnect (Graphic3d_CStructure& theStructure) = 0;
94 //! Synchronize structure aspects
95 virtual void UpdateAspects() = 0;
97 //! Synchronize structure transformation
98 virtual void UpdateTransformation() = 0;
100 //! Highlight entire structure with color
101 virtual void HighlightWithColor (const Graphic3d_Vec3& theColor,
102 const Standard_Boolean theToCreate) = 0;
104 //! Highlight structure using boundary box
105 virtual void HighlightWithBndBox (const Handle(Graphic3d_Structure)& theStruct,
106 const Standard_Boolean theToCreate) = 0;
108 //! Create shadow link to this structure
109 virtual Handle(Graphic3d_CStructure) ShadowLink (const Handle(Graphic3d_StructureManager)& theManager) const = 0;
111 //! Create new group within this structure
112 virtual Handle(Graphic3d_Group) NewGroup (const Handle(Graphic3d_Structure)& theStruct) = 0;
114 //! Remove group from this structure
115 virtual void RemoveGroup (const Handle(Graphic3d_Group)& theGroup) = 0;
120 Graphic3d_ZLayerId myZLayer;
122 int PreviousPriority;
124 CALL_DEF_CONTEXTLINE ContextLine;
125 CALL_DEF_CONTEXTFILLAREA ContextFillArea;
126 CALL_DEF_CONTEXTMARKER ContextMarker;
127 CALL_DEF_CONTEXTTEXT ContextText;
129 CALL_DEF_COLOR HighlightColor;
131 float Transformation[4][4];
132 Graphic3d_TypeOfComposition Composition;
136 unsigned IsInfinite : 1;
137 unsigned stick : 1; //!< displaying state - should be set when structure has been added to scene graph (but can be in hidden state)
138 unsigned highlight : 1;
139 unsigned visible : 1; //!< visibility flag - can be used to suppress structure while leaving it in the scene graph
140 unsigned HLRValidation : 1;
141 unsigned IsForHighlight : 1;
142 unsigned IsMutable : 1;
143 unsigned Is2dText : 1;
145 CALL_DEF_TRANSFORM_PERSISTENCE TransformPersistence;
149 //! Create empty structure.
150 Standard_EXPORT Graphic3d_CStructure (const Handle(Graphic3d_StructureManager)& theManager);
154 Handle(Graphic3d_GraphicDriver) myGraphicDriver;
155 Graphic3d_SequenceOfGroup myGroups;
156 Graphic3d_BndBox4f myBndBox;
157 Graphic3d_SequenceOfHClipPlane myClipPlanes;
161 DEFINE_STANDARD_RTTI(Graphic3d_CStructure) // Type definition
165 #endif // _Graphic3d_CStructure_HeaderFile