MeshVS_PrsBuilder Class Reference

This class is parent for all builders using in MeshVS_Mesh. It provides base fields and methods all buildes need. More...

#include <MeshVS_PrsBuilder.hxx>

Inheritance diagram for MeshVS_PrsBuilder:

Public Member Functions
virtual void	Build (const occ::handle< Prs3d_Presentation > &Prs, const TColStd_PackedMapOfInteger &IDs, TColStd_PackedMapOfInteger &IDsToExclude, const bool IsElement, const int DisplayMode) const =0
	Builds presentation of certain type of data. Prs is presentation object which this method constructs. IDs is set of numeric identificators forming object appearance. IDsToExclude is set of IDs to exclude from processing. If some entity has been excluded, it is not processed by other builders. IsElement indicates, IDs is identificators of nodes or elements. DisplayMode is numeric constant describing display mode (see MeshVS_DisplayModeFlags.hxx)
virtual void	CustomBuild (const occ::handle< Prs3d_Presentation > &Prs, const TColStd_PackedMapOfInteger &IDs, TColStd_PackedMapOfInteger &IDsToExclude, const int DisplayMode) const
	This method is called to build presentation of custom elements (they have MeshVS_ET_0D type). IDs is set of numeric identificators of elements for custom building. IDsToExclude is set of IDs to exclude from processing. If some entity has been excluded, it is not processed by other builders. DisplayMode is numeric constant describing display mode (see MeshVS_DisplayModeFlags.hxx)
virtual occ::handle< Select3D_SensitiveEntity >	CustomSensitiveEntity (const occ::handle< SelectMgr_EntityOwner > &Owner, const int SelectMode) const
	This method is called to build sensitive of custom elements ( they have MeshVS_ET_0D type )
int	GetFlags () const
	Returns flags, assigned with builder during creation.
virtual bool	TestFlags (const int DisplayMode) const
	Test whether display mode has flags assigned with this builder. This method has default implementation and can be redefined for advance behavior Returns true only if display mode is appropriate for this builder.
int	GetId () const
	Returns builder ID.
int	GetPriority () const
	Returns priority; as priority bigger, as soon builder will be called.
occ::handle< MeshVS_DataSource >	GetDataSource () const
	Returns custom data source or default ( from MeshVS_Mesh ) if custom is NULL.
void	SetDataSource (const occ::handle< MeshVS_DataSource > &newDS)
	Change custom data source.
occ::handle< MeshVS_Drawer >	GetDrawer () const
	Returns custom drawer or default ( from MeshVS_Mesh ) if custom is NULL.
void	SetDrawer (const occ::handle< MeshVS_Drawer > &newDr)
	Change custom drawer.
void	SetExcluding (const bool state)
	Set excluding state. If it is true, the nodes or elements, processed by current builder will be noted and next builder won't process its.
bool	IsExcludingOn () const
	Read excluding state.
void	SetPresentationManager (const occ::handle< PrsMgr_PresentationManager > &thePrsMgr)
	Set presentation manager for builder.
occ::handle< PrsMgr_PresentationManager >	GetPresentationManager () const
	Get presentation manager of builder.
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 ()=default
	Destructor must be virtual.
virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.
bool	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.
bool	IsInstance (const char *const theTypeName) const
	Returns a true value if this is an instance of TypeName.
bool	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.
bool	IsKind (const char *const 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.
int	GetRefCount () const noexcept
	Get the reference counter of this object.
void	IncrementRefCounter () noexcept
	Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.
int	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.
virtual void	Delete () const
	Memory deallocator for transient classes.

Protected Member Functions
	MeshVS_PrsBuilder (const occ::handle< MeshVS_Mesh > &Parent, const MeshVS_DisplayModeFlags &Flags, const occ::handle< MeshVS_DataSource > &DS, const int Id, const MeshVS_BuilderPriority &Priority=MeshVS_BP_Default)
	Constructor Parent is pointer to MeshVS_Mesh object Flags is set of display modes corresponding to this builder DS is data source object, from which builder will pick geometry and topological information Id is numeric identificator of builder. You must set it to positive integer, but if you set it to -1, constructor will select the smallest integer, not occupied by other builders Priority is numerical priority constant. As priority bigger, as sooner builder starts during presentation construction.
occ::handle< MeshVS_DataSource >	DataSource () const
	Returns only custom data source.
occ::handle< MeshVS_Drawer >	Drawer () const
	Returns only custom drawer.

Protected Attributes
MeshVS_MeshPtr	myParentMesh

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

Detailed Description

This class is parent for all builders using in MeshVS_Mesh. It provides base fields and methods all buildes need.

Constructor & Destructor Documentation

MeshVS_PrsBuilder()

MeshVS_PrsBuilder::MeshVS_PrsBuilder ( const occ::handle< MeshVS_Mesh > & Parent, const MeshVS_DisplayModeFlags & Flags, const occ::handle< MeshVS_DataSource > & DS, const int Id, const MeshVS_BuilderPriority & Priority = MeshVS_BP_Default )

protected

Constructor Parent is pointer to MeshVS_Mesh object Flags is set of display modes corresponding to this builder DS is data source object, from which builder will pick geometry and topological information Id is numeric identificator of builder. You must set it to positive integer, but if you set it to -1, constructor will select the smallest integer, not occupied by other builders Priority is numerical priority constant. As priority bigger, as sooner builder starts during presentation construction.

Member Function Documentation

Build()

virtual void MeshVS_PrsBuilder::Build ( const occ::handle< Prs3d_Presentation > & Prs, const TColStd_PackedMapOfInteger & IDs, TColStd_PackedMapOfInteger & IDsToExclude, const bool IsElement, const int DisplayMode ) const

pure virtual

Builds presentation of certain type of data. Prs is presentation object which this method constructs. IDs is set of numeric identificators forming object appearance. IDsToExclude is set of IDs to exclude from processing. If some entity has been excluded, it is not processed by other builders. IsElement indicates, IDs is identificators of nodes or elements. DisplayMode is numeric constant describing display mode (see MeshVS_DisplayModeFlags.hxx)

Implemented in MeshVS_ElementalColorPrsBuilder, MeshVS_MeshPrsBuilder, MeshVS_NodalColorPrsBuilder, MeshVS_TextPrsBuilder, and MeshVS_VectorPrsBuilder.

CustomBuild()

virtual void MeshVS_PrsBuilder::CustomBuild ( const occ::handle< Prs3d_Presentation > & Prs, const TColStd_PackedMapOfInteger & IDs, TColStd_PackedMapOfInteger & IDsToExclude, const int DisplayMode ) const

virtual

This method is called to build presentation of custom elements (they have MeshVS_ET_0D type). IDs is set of numeric identificators of elements for custom building. IDsToExclude is set of IDs to exclude from processing. If some entity has been excluded, it is not processed by other builders. DisplayMode is numeric constant describing display mode (see MeshVS_DisplayModeFlags.hxx)

CustomSensitiveEntity()

virtual occ::handle< Select3D_SensitiveEntity > MeshVS_PrsBuilder::CustomSensitiveEntity ( const occ::handle< SelectMgr_EntityOwner > & Owner, const int SelectMode ) const

virtual

This method is called to build sensitive of custom elements ( they have MeshVS_ET_0D type )

DataSource()

occ::handle< MeshVS_DataSource > MeshVS_PrsBuilder::DataSource ( ) const

protected

Returns only custom data source.

Drawer()

occ::handle< MeshVS_Drawer > MeshVS_PrsBuilder::Drawer ( ) const

protected

Returns only custom drawer.

GetDataSource()

occ::handle< MeshVS_DataSource > MeshVS_PrsBuilder::GetDataSource

(

)

const

Returns custom data source or default ( from MeshVS_Mesh ) if custom is NULL.

GetDrawer()

occ::handle< MeshVS_Drawer > MeshVS_PrsBuilder::GetDrawer

(

)

const

Returns custom drawer or default ( from MeshVS_Mesh ) if custom is NULL.

GetFlags()

int MeshVS_PrsBuilder::GetFlags

(

)

const

Returns flags, assigned with builder during creation.

GetId()

int MeshVS_PrsBuilder::GetId

(

)

const

Returns builder ID.

GetPresentationManager()

occ::handle< PrsMgr_PresentationManager > MeshVS_PrsBuilder::GetPresentationManager

(

)

const

Get presentation manager of builder.

GetPriority()

int MeshVS_PrsBuilder::GetPriority

(

)

const

Returns priority; as priority bigger, as soon builder will be called.

IsExcludingOn()

bool MeshVS_PrsBuilder::IsExcludingOn

(

)

const

Read excluding state.

SetDataSource()

void MeshVS_PrsBuilder::SetDataSource

(

const occ::handle< MeshVS_DataSource > &

newDS

)

Change custom data source.

SetDrawer()

void MeshVS_PrsBuilder::SetDrawer

(

const occ::handle< MeshVS_Drawer > &

newDr

)

Change custom drawer.

SetExcluding()

void MeshVS_PrsBuilder::SetExcluding

(

const bool

state

)

Set excluding state. If it is true, the nodes or elements, processed by current builder will be noted and next builder won't process its.

SetPresentationManager()

void MeshVS_PrsBuilder::SetPresentationManager

(

const occ::handle< PrsMgr_PresentationManager > &

thePrsMgr

)

Set presentation manager for builder.

TestFlags()

virtual bool MeshVS_PrsBuilder::TestFlags ( const int DisplayMode ) const

virtual

Test whether display mode has flags assigned with this builder. This method has default implementation and can be redefined for advance behavior Returns true only if display mode is appropriate for this builder.

Field Documentation

myParentMesh

MeshVS_MeshPtr MeshVS_PrsBuilder::myParentMesh

protected

---

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

• MeshVS_PrsBuilder.hxx