Low-level graphic structure interface. More...

#include <Graphic3d_CStructure.hxx>

Inheritance diagram for Graphic3d_CStructure:

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

const Graphic3d_SequenceOfGroup &	Groups () const

const Graphic3d_SequenceOfHClipPlane &	ClipPlanes () const

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

const Graphic3d_BndBox4f &	BoundingBox () const

Graphic3d_BndBox4f &	ChangeBoundingBox ()

bool	IsVisible () const
	Return structure visibility flag. More...

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

Graphic3d_ZLayerId	ZLayer () const
	Get z layer ID. More...

virtual void	OnVisibilityChanged ()=0
	Update structure visibility state. More...

virtual void	Clear ()=0
	Clear graphic data. More...

virtual void	Connect (Graphic3d_CStructure &theStructure)=0
	Connect other structure to this one. More...

virtual void	Disconnect (Graphic3d_CStructure &theStructure)=0
	Disconnect other structure to this one. More...

virtual void	UpdateAspects ()=0
	Synchronize structure aspects. More...

virtual void	UpdateTransformation ()=0
	Synchronize structure transformation. More...

virtual void	HighlightWithColor (const Graphic3d_Vec3 &theColor, const Standard_Boolean theToCreate)=0
	Highlight entire structure with color. More...

virtual void	HighlightWithBndBox (const Handle< Graphic3d_Structure > &theStruct, const Standard_Boolean theToCreate)=0
	Highlight structure using boundary box. More...

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

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

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

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

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

Standard_Transient &	operator= (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_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. 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...

Data Fields
int	Id

Graphic3d_ZLayerId	myZLayer

int	Priority

int	PreviousPriority

CALL_DEF_CONTEXTLINE	ContextLine

CALL_DEF_CONTEXTFILLAREA	ContextFillArea

CALL_DEF_CONTEXTMARKER	ContextMarker

CALL_DEF_CONTEXTTEXT	ContextText

CALL_DEF_COLOR	HighlightColor

Graphic3d_Mat4	Transformation

int	ContainsFacet

Handle< Graphic3d_ViewAffinity >	ViewAffinity
	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

Graphic3d_TransformPers	TransformPersistence

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

Protected Attributes
Handle< Graphic3d_GraphicDriver >	myGraphicDriver

Graphic3d_SequenceOfGroup	myGroups

Graphic3d_BndBox4f	myBndBox

Graphic3d_SequenceOfHClipPlane	myClipPlanes

Additional Inherited Members
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...

Detailed Description

Low-level graphic structure interface.

Constructor & Destructor Documentation

Graphic3d_CStructure::Graphic3d_CStructure ( const Handle< Graphic3d_StructureManager > & theManager )

protected

Create empty structure.

Member Function Documentation

const Graphic3d_BndBox4f& Graphic3d_CStructure::BoundingBox ( ) const

inline

Returns: bounding box of this presentation

Graphic3d_BndBox4f& Graphic3d_CStructure::ChangeBoundingBox ( )

inline

Returns: bounding box of this presentation without transformation matrix applied

virtual void Graphic3d_CStructure::Clear ( )

pure virtual

Clear graphic data.

Implemented in OpenGl_Structure.

const Graphic3d_SequenceOfHClipPlane& Graphic3d_CStructure::ClipPlanes ( ) const

inline

Returns: associated clip planes

virtual void Graphic3d_CStructure::Connect ( Graphic3d_CStructure & theStructure )

pure virtual

Connect other structure to this one.

Implemented in OpenGl_Structure.

virtual void Graphic3d_CStructure::Disconnect ( Graphic3d_CStructure & theStructure )

pure virtual

Disconnect other structure to this one.

Implemented in OpenGl_Structure.

const Handle< Graphic3d_GraphicDriver >& Graphic3d_CStructure::GraphicDriver ( ) const

inline

Returns: graphic driver created this structure

const Graphic3d_SequenceOfGroup& Graphic3d_CStructure::Groups ( ) const

inline

Returns: graphic groups

virtual void Graphic3d_CStructure::HighlightWithBndBox	(	const Handle< Graphic3d_Structure > &	theStruct,
		const Standard_Boolean	theToCreate
	)

pure virtual

Highlight structure using boundary box.

Implemented in OpenGl_Structure.

virtual void Graphic3d_CStructure::HighlightWithColor	(	const Graphic3d_Vec3 &	theColor,
		const Standard_Boolean	theToCreate
	)

pure virtual

Highlight entire structure with color.

Implemented in OpenGl_Structure.

bool Graphic3d_CStructure::IsVisible ( ) const

inline

Return structure visibility flag.

virtual Handle< Graphic3d_Group > Graphic3d_CStructure::NewGroup ( const Handle< Graphic3d_Structure > & theStruct )

pure virtual

Create new group within this structure.

Implemented in OpenGl_Structure.

virtual void Graphic3d_CStructure::OnVisibilityChanged ( )

pure virtual

Update structure visibility state.

Implemented in OpenGl_Structure.

virtual void Graphic3d_CStructure::RemoveGroup ( const Handle< Graphic3d_Group > & theGroup )

pure virtual

Remove group from this structure.

Implemented in OpenGl_Structure.

void Graphic3d_CStructure::SetClipPlanes ( const Graphic3d_SequenceOfHClipPlane & thePlanes )

inline

Pass clip planes to the associated graphic driver structure.

void Graphic3d_CStructure::SetZLayer ( const Graphic3d_ZLayerId theLayerIndex )

inline

Set z layer ID to display the structure in specified layer.

virtual Handle< Graphic3d_CStructure > Graphic3d_CStructure::ShadowLink ( const Handle< Graphic3d_StructureManager > & theManager ) const

pure virtual

Create shadow link to this structure.

Implemented in OpenGl_Structure.

virtual void Graphic3d_CStructure::UpdateAspects ( )

pure virtual

Synchronize structure aspects.

Implemented in OpenGl_Structure.

virtual void Graphic3d_CStructure::UpdateTransformation ( )

pure virtual

Synchronize structure transformation.

Implemented in OpenGl_Structure.

Graphic3d_ZLayerId Graphic3d_CStructure::ZLayer ( ) const

inline

Get z layer ID.

Field Documentation

int Graphic3d_CStructure::ContainsFacet

CALL_DEF_CONTEXTFILLAREA Graphic3d_CStructure::ContextFillArea

CALL_DEF_CONTEXTLINE Graphic3d_CStructure::ContextLine

CALL_DEF_CONTEXTMARKER Graphic3d_CStructure::ContextMarker

CALL_DEF_CONTEXTTEXT Graphic3d_CStructure::ContextText

unsigned Graphic3d_CStructure::highlight

CALL_DEF_COLOR Graphic3d_CStructure::HighlightColor

unsigned Graphic3d_CStructure::HLRValidation

int Graphic3d_CStructure::Id

unsigned Graphic3d_CStructure::Is2dText

unsigned Graphic3d_CStructure::IsForHighlight

unsigned Graphic3d_CStructure::IsInfinite

unsigned Graphic3d_CStructure::IsMutable

Graphic3d_BndBox4f Graphic3d_CStructure::myBndBox

protected

Graphic3d_SequenceOfHClipPlane Graphic3d_CStructure::myClipPlanes

protected

Handle< Graphic3d_GraphicDriver > Graphic3d_CStructure::myGraphicDriver

protected

Graphic3d_SequenceOfGroup Graphic3d_CStructure::myGroups

protected

Graphic3d_ZLayerId Graphic3d_CStructure::myZLayer

int Graphic3d_CStructure::PreviousPriority

int Graphic3d_CStructure::Priority

unsigned Graphic3d_CStructure::stick

displaying state - should be set when structure has been added to scene graph (but can be in hidden state)

Graphic3d_Mat4 Graphic3d_CStructure::Transformation

Graphic3d_TransformPers Graphic3d_CStructure::TransformPersistence

Handle< Graphic3d_ViewAffinity > Graphic3d_CStructure::ViewAffinity

view affinity mask

unsigned Graphic3d_CStructure::visible

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

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

Graphic3d_CStructure.hxx

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation