Open CASCADE Technology  7.4.1.dev
Public Member Functions
OpenGl_StructureShadow Class Reference

Dummy structure which just redirects to groups of another structure. More...

#include <OpenGl_StructureShadow.hxx>

Inheritance diagram for OpenGl_StructureShadow:
Inheritance graph
[legend]

Public Member Functions

 OpenGl_StructureShadow (const Handle< Graphic3d_StructureManager > &theManager, const Handle< OpenGl_Structure > &theStructure)
 Create empty structure. More...
 
virtual void Connect (Graphic3d_CStructure &) override
 Raise exception on API misuse. More...
 
virtual void Disconnect (Graphic3d_CStructure &) override
 Raise exception on API misuse. More...
 
- Public Member Functions inherited from OpenGl_Structure
 OpenGl_Structure (const Handle< Graphic3d_StructureManager > &theManager)
 Create empty structure. More...
 
virtual void OnVisibilityChanged () override
 Setup structure graphic state. More...
 
virtual void Clear () override
 Clear graphic data. More...
 
virtual void SetTransformation (const Handle< TopLoc_Datum3D > &theTrsf) override
 Synchronize structure transformation. More...
 
virtual void SetTransformPersistence (const Handle< Graphic3d_TransformPers > &theTrsfPers) override
 Set transformation persistence. More...
 
virtual void SetZLayer (const Graphic3d_ZLayerId theLayerIndex) override
 Set z layer ID to display the structure in specified layer. More...
 
virtual void GraphicHighlight (const Handle< Graphic3d_PresentationAttributes > &theStyle) override
 Highlights structure according to the given style and updates corresponding class fields (highlight status and style) More...
 
virtual void GraphicUnhighlight () override
 Unighlights structure and updates corresponding class fields (highlight status and style) More...
 
virtual Handle< Graphic3d_CStructureShadowLink (const Handle< Graphic3d_StructureManager > &theManager) const override
 Create shadow link to this structure. More...
 
virtual Handle< Graphic3d_GroupNewGroup (const Handle< Graphic3d_Structure > &theStruct) override
 Create new group within this structure. More...
 
virtual void RemoveGroup (const Handle< Graphic3d_Group > &theGroup) override
 Remove group from this structure. More...
 
OpenGl_GraphicDriverGlDriver () const
 Access graphic driver. More...
 
void Clear (const Handle< OpenGl_Context > &theGlCtx)
 
virtual void Render (const Handle< OpenGl_Workspace > &theWorkspace) const
 Renders the structure. More...
 
virtual void Release (const Handle< OpenGl_Context > &theGlCtx)
 Releases structure resources. More...
 
void ReleaseGlResources (const Handle< OpenGl_Context > &theGlCtx)
 This method releases GL resources without actual elements destruction. As result structure could be correctly destroyed layer without GL context (after last window was closed for example). More...
 
const OpenGl_StructureInstancedStructure () const
 Returns instanced OpenGL structure. More...
 
Standard_Size ModificationState () const
 Returns structure modification state (for ray-tracing). More...
 
void ResetModificationState () const
 Resets structure modification state (for ray-tracing). More...
 
Standard_Boolean IsRaytracable () const
 Is the structure ray-tracable (contains ray-tracable elements)? More...
 
virtual void updateLayerTransformation () override
 Update render transformation matrix. More...
 
virtual void DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const override
 Dumps the content of me into the stream. More...
 
- Public Member Functions inherited from Graphic3d_CStructure
const Handle< Graphic3d_GraphicDriver > & GraphicDriver () const
 
const Graphic3d_SequenceOfGroupGroups () const
 
const Handle< TopLoc_Datum3D > & Transformation () const
 Return transformation. More...
 
const Handle< Graphic3d_TransformPers > & TransformPersistence () const
 Return transformation persistence. More...
 
const Handle< Graphic3d_SequenceOfHClipPlane > & ClipPlanes () const
 
void SetClipPlanes (const Handle< Graphic3d_SequenceOfHClipPlane > &thePlanes)
 Pass clip planes to the associated graphic driver structure. More...
 
const Graphic3d_BndBox3dBoundingBox () const
 
Graphic3d_BndBox3dChangeBoundingBox ()
 
bool IsVisible () const
 Return structure visibility flag. More...
 
bool IsVisible (const Standard_Integer theViewId) const
 Return structure visibility considering both View Affinity and global visibility state. More...
 
Graphic3d_ZLayerId ZLayer () const
 Get z layer ID. More...
 
const Handle< Graphic3d_PresentationAttributes > & HighlightStyle () const
 Returns valid handle to highlight style of the structure in case if highlight flag is set to true. More...
 
Standard_Boolean IsCulled () const
 Returns FALSE if the structure hits the current view volume, otherwise returns TRUE. More...
 
void SetCulled (Standard_Boolean theIsCulled) const
 Marks structure as culled/not culled - note that IsAlwaysRendered() is ignored here! More...
 
void MarkAsNotCulled () const
 Marks structure as overlapping the current view volume one. The method is called during traverse of BVH tree. More...
 
Standard_Boolean BndBoxClipCheck () const
 Returns whether check of object's bounding box clipping is enabled before drawing of object; TRUE by default. More...
 
void SetBndBoxClipCheck (Standard_Boolean theBndBoxClipCheck)
 Enable/disable check of object's bounding box clipping before drawing of object. More...
 
Standard_Boolean IsAlwaysRendered () const
 Checks if the structure should be included into BVH tree or not. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
Standard_Boolean IsKind (const opencascade::handle< Standard_Type > &theType) const
 Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
Standard_Boolean IsKind (const Standard_CString theTypeName) const
 Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
Standard_TransientThis () const
 Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

Additional Inherited Members

- Public Types inherited from OpenGl_Structure
typedef SubclassStructIterator< OpenGl_StructureStructIterator
 Auxiliary wrapper to iterate OpenGl_Structure sequence. More...
 
typedef SubclassGroupIterator< OpenGl_GroupGroupIterator
 Auxiliary wrapper to iterate OpenGl_Group sequence. More...
 
- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 
- Static Public Member Functions inherited from Standard_Transient
static const char * get_type_name ()
 Returns a type descriptor about this object. More...
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class. More...
 
- Data Fields inherited from Graphic3d_CStructure
int Id
 
Graphic3d_ZLayerId myZLayer
 
int Priority
 
int PreviousPriority
 
int ContainsFacet
 
Handle< Graphic3d_ViewAffinityViewAffinity
 view affinity mask More...
 
unsigned IsInfinite: 1
 
unsigned stick: 1
 displaying state - should be set when structure has been added to scene graph (but can be in hidden state) More...
 
unsigned highlight: 1
 
unsigned visible: 1
 visibility flag - can be used to suppress structure while leaving it in the scene graph More...
 
unsigned HLRValidation: 1
 
unsigned IsForHighlight: 1
 
unsigned IsMutable: 1
 
unsigned Is2dText: 1
 
- Protected Member Functions inherited from OpenGl_Structure
virtual ~OpenGl_Structure ()
 
void UpdateStateIfRaytracable (const Standard_Boolean toCheck=Standard_True) const
 Updates ray-tracable status for structure and its parents. More...
 
void renderGeometry (const Handle< OpenGl_Workspace > &theWorkspace, bool &theHasClosed) const
 Renders groups of structure without applying any attributes (i.e. transform, material etc). More...
 
void renderBoundingBox (const Handle< OpenGl_Workspace > &theWorkspace) const
 Render the bounding box. More...
 
- Protected Member Functions inherited from Graphic3d_CStructure
 Graphic3d_CStructure (const Handle< Graphic3d_StructureManager > &theManager)
 Create empty structure. More...
 
- Protected Attributes inherited from OpenGl_Structure
OpenGl_StructuremyInstancedStructure
 
Graphic3d_Mat4 myRenderTrsf
 transformation, actually used for rendering (includes Local Origin shift) More...
 
Standard_Boolean myIsRaytracable
 
Standard_Size myModificationState
 
Standard_Boolean myIsMirrored
 Used to tell OpenGl to interpret polygons in clockwise order. More...
 
- Protected Attributes inherited from Graphic3d_CStructure
Handle< Graphic3d_GraphicDrivermyGraphicDriver
 
Graphic3d_SequenceOfGroup myGroups
 
Graphic3d_BndBox3d myBndBox
 
Handle< TopLoc_Datum3DmyTrsf
 
Handle< Graphic3d_TransformPersmyTrsfPers
 
Handle< Graphic3d_SequenceOfHClipPlanemyClipPlanes
 
Handle< Graphic3d_PresentationAttributesmyHighlightStyle
 
Standard_Boolean myIsCulled
 Current highlight style; is set only if highlight flag is true. More...
 
Standard_Boolean myBndBoxClipCheck
 Flag responsible for checking of bounding box clipping before drawing of object. More...
 

Detailed Description

Dummy structure which just redirects to groups of another structure.

Constructor & Destructor Documentation

◆ OpenGl_StructureShadow()

OpenGl_StructureShadow::OpenGl_StructureShadow ( const Handle< Graphic3d_StructureManager > &  theManager,
const Handle< OpenGl_Structure > &  theStructure 
)

Create empty structure.

Member Function Documentation

◆ Connect()

virtual void OpenGl_StructureShadow::Connect ( Graphic3d_CStructure )
overridevirtual

Raise exception on API misuse.

Reimplemented from OpenGl_Structure.

◆ Disconnect()

virtual void OpenGl_StructureShadow::Disconnect ( Graphic3d_CStructure )
overridevirtual

Raise exception on API misuse.

Reimplemented from OpenGl_Structure.


The documentation for this class was generated from the following file: