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

#include <OpenGl_StructureShadow.hxx>

Inheritance diagram for OpenGl_StructureShadow:

[legend]

Public Member Functions
	OpenGl_StructureShadow (const Handle< Graphic3d_StructureManager > &theManager, const Handle< OpenGl_Structure > &theStructure)
	Create empty structure.

virtual void	Connect (Graphic3d_CStructure &) override
	Raise exception on API misuse.

virtual void	Disconnect (Graphic3d_CStructure &) override
	Raise exception on API misuse.

Public Member Functions inherited from OpenGl_Structure
	OpenGl_Structure (const Handle< Graphic3d_StructureManager > &theManager)
	Create empty structure.

virtual void	OnVisibilityChanged () override
	Setup structure graphic state.

virtual void	Clear () override
	Clear graphic data.

virtual void	SetTransformation (const Handle< TopLoc_Datum3D > &theTrsf) override
	Synchronize structure transformation.

virtual void	SetTransformPersistence (const Handle< Graphic3d_TransformPers > &theTrsfPers) override
	Set transformation persistence.

virtual void	SetZLayer (const Graphic3d_ZLayerId theLayerIndex) override
	Set z layer ID to display the structure in specified layer.

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)

virtual void	GraphicUnhighlight () override
	Unighlights structure and updates corresponding class fields (highlight status and style)

virtual Handle< Graphic3d_CStructure >	ShadowLink (const Handle< Graphic3d_StructureManager > &theManager) const override
	Create shadow link to this structure.

virtual Handle< Graphic3d_Group >	NewGroup (const Handle< Graphic3d_Structure > &theStruct) override
	Create new group within this structure.

virtual void	RemoveGroup (const Handle< Graphic3d_Group > &theGroup) override
	Remove group from this structure.

OpenGl_GraphicDriver *	GlDriver () const
	Access graphic driver.

void	Clear (const Handle< OpenGl_Context > &theGlCtx)

virtual void	Render (const Handle< OpenGl_Workspace > &theWorkspace) const
	Renders the structure.

virtual void	Release (const Handle< OpenGl_Context > &theGlCtx)
	Releases structure resources.

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).

const OpenGl_Structure *	InstancedStructure () const
	Returns instanced OpenGL structure.

Standard_Size	ModificationState () const
	Returns structure modification state (for ray-tracing).

void	ResetModificationState () const
	Resets structure modification state (for ray-tracing).

Standard_Boolean	IsRaytracable () const
	Is the structure ray-tracable (contains ray-tracable elements)?

virtual void	updateLayerTransformation () override
	Update render transformation matrix.

virtual void	DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const override
	Dumps the content of me into the stream.

Public Member Functions inherited from Graphic3d_CStructure
const Handle< Graphic3d_GraphicDriver > &	GraphicDriver () const

const Graphic3d_SequenceOfGroup &	Groups () const

const Handle< TopLoc_Datum3D > &	Transformation () const
	Return transformation.

const Handle< Graphic3d_TransformPers > &	TransformPersistence () const
	Return transformation persistence.

bool	HasGroupTransformPersistence () const
	Return TRUE if some groups might have transform persistence; FALSE by default.

void	SetGroupTransformPersistence (bool theValue)
	Set if some groups might have transform persistence.

const Handle< Graphic3d_SequenceOfHClipPlane > &	ClipPlanes () const

void	SetClipPlanes (const Handle< Graphic3d_SequenceOfHClipPlane > &thePlanes)
	Pass clip planes to the associated graphic driver structure.

const Graphic3d_BndBox3d &	BoundingBox () const

Graphic3d_BndBox3d &	ChangeBoundingBox ()

bool	IsVisible () const
	Return structure visibility flag.

bool	IsVisible (const Standard_Integer theViewId) const
	Return structure visibility considering both View Affinity and global visibility state.

Graphic3d_ZLayerId	ZLayer () const
	Get z layer ID.

const Handle< Graphic3d_PresentationAttributes > &	HighlightStyle () const
	Returns valid handle to highlight style of the structure in case if highlight flag is set to true.

Standard_Integer	Identification () const
	Return structure id (generated by Graphic3d_GraphicDriver::NewIdentification() during structure construction).

Graphic3d_DisplayPriority	Priority () const
	Return structure display priority.

void	SetPriority (Graphic3d_DisplayPriority thePriority)
	Set structure display priority.

Graphic3d_DisplayPriority	PreviousPriority () const
	Return previous structure display priority.

void	SetPreviousPriority (Graphic3d_DisplayPriority thePriority)
	Set previous structure display priority.

Standard_Boolean	IsCulled () const
	Returns FALSE if the structure hits the current view volume, otherwise returns TRUE.

void	SetCulled (Standard_Boolean theIsCulled) const
	Marks structure as culled/not culled - note that IsAlwaysRendered() is ignored here!

void	MarkAsNotCulled () const
	Marks structure as overlapping the current view volume one. The method is called during traverse of BVH tree.

Standard_Boolean	BndBoxClipCheck () const
	Returns whether check of object's bounding box clipping is enabled before drawing of object; TRUE by default.

void	SetBndBoxClipCheck (Standard_Boolean theBndBoxClipCheck)
	Enable/disable check of object's bounding box clipping before drawing of object.

Standard_Boolean	IsAlwaysRendered () const
	Checks if the structure should be included into BVH tree or not.

Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.

	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.

Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter.

virtual	~Standard_Transient ()
	Destructor must be virtual.

virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.

Standard_Boolean	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.

Standard_Boolean	IsInstance (const Standard_CString theTypeName) const
	Returns a true value if this is an instance of TypeName.

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.

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.

Standard_Transient *	This () 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.

Standard_Integer	GetRefCount () const noexcept
	Get the reference counter of this object.

void	IncrementRefCounter () noexcept
	Increments the reference counter of this object.

Standard_Integer	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value.

virtual void	Delete () const
	Memory deallocator for transient classes.

Additional Inherited Members
Public Types inherited from OpenGl_Structure
typedef SubclassStructIterator< OpenGl_Structure >	StructIterator
	Auxiliary wrapper to iterate OpenGl_Structure sequence.

typedef SubclassGroupIterator< OpenGl_Group >	GroupIterator
	Auxiliary wrapper to iterate OpenGl_Group sequence.

Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object.

Static Public Member Functions inherited from Standard_Transient
static constexpr const char *	get_type_name ()
	Returns a type descriptor about this object.

static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class.

Data Fields inherited from Graphic3d_CStructure
Handle< Graphic3d_ViewAffinity >	ViewAffinity
	view affinity mask

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)

unsigned	highlight: 1

unsigned	visible: 1
	visibility flag - can be used to suppress structure while leaving it in the scene graph

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.

void	renderGeometry (const Handle< OpenGl_Workspace > &theWorkspace, bool &theHasClosed) const
	Renders groups of structure without applying any attributes (i.e. transform, material etc).

void	renderBoundingBox (const Handle< OpenGl_Workspace > &theWorkspace) const
	Render the bounding box.

void	applyPersistence (const Handle< OpenGl_Context > &theCtx, const Handle< Graphic3d_TransformPers > &theTrsfPersistence, const Standard_Boolean theIsLocal, Standard_Boolean &theOldCastShadows) const
	Apply transform persistence into context. It disables shadows on non-3d objects when toEnable is true and restores otherwise.

void	revertPersistence (const Handle< OpenGl_Context > &theCtx, const Handle< Graphic3d_TransformPers > &theTrsfPersistence, const Standard_Boolean theIsLocal, const Standard_Boolean theOldCastShadows) const
	Restore context from transform persistence changes.

Protected Member Functions inherited from Graphic3d_CStructure
	Graphic3d_CStructure (const Handle< Graphic3d_StructureManager > &theManager)
	Create empty structure.

Protected Attributes inherited from OpenGl_Structure
OpenGl_Structure *	myInstancedStructure

Graphic3d_Mat4	myRenderTrsf
	transformation, actually used for rendering (includes Local Origin shift)

Standard_Boolean	myIsRaytracable

Standard_Size	myModificationState

Standard_Boolean	myIsMirrored
	Used to tell OpenGl to interpret polygons in clockwise order.

Protected Attributes inherited from Graphic3d_CStructure
Handle< Graphic3d_GraphicDriver >	myGraphicDriver

Graphic3d_SequenceOfGroup	myGroups

Graphic3d_BndBox3d	myBndBox

Handle< TopLoc_Datum3D >	myTrsf

Handle< Graphic3d_TransformPers >	myTrsfPers

Handle< Graphic3d_SequenceOfHClipPlane >	myClipPlanes

Handle< Graphic3d_PresentationAttributes >	myHighlightStyle

Standard_Integer	myId
	Current highlight style; is set only if highlight flag is true.

Graphic3d_ZLayerId	myZLayer

Graphic3d_DisplayPriority	myPriority

Graphic3d_DisplayPriority	myPreviousPriority

Standard_Boolean	myIsCulled
	A status specifying is structure needs to be rendered after BVH tree traverse.

Standard_Boolean	myBndBoxClipCheck
	Flag responsible for checking of bounding box clipping before drawing of object.

Standard_Boolean	myHasGroupTrsf
	flag specifying that some groups might have transform persistence

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 & )