This class provides methods to create presentation of nodes with assigned color. There are two ways of presentation building. More...

#include <MeshVS_NodalColorPrsBuilder.hxx>

Inheritance diagram for MeshVS_NodalColorPrsBuilder:

[legend]

Public Member Functions
	MeshVS_NodalColorPrsBuilder (const occ::handle< MeshVS_Mesh > &Parent, const MeshVS_DisplayModeFlags &Flags=MeshVS_DMF_NodalColorDataPrs, const occ::handle< MeshVS_DataSource > &DS=nullptr, const int Id=-1, const MeshVS_BuilderPriority &Priority=MeshVS_BP_NodalColor)
void	Build (const occ::handle< Prs3d_Presentation > &Prs, const TColStd_PackedMapOfInteger &IDs, TColStd_PackedMapOfInteger &IDsToExclude, const bool IsElement, const int DisplayMode) const override
	Builds presentation of nodes with assigned color.
const NCollection_DataMap< int, Quantity_Color > &	GetColors () const
	Returns map of colors assigned to nodes.
void	SetColors (const NCollection_DataMap< int, Quantity_Color > &Map)
	Sets map of colors assigned to nodes.
bool	HasColors () const
	Returns true, if map isn't empty.
bool	GetColor (const int ID, Quantity_Color &theColor) const
	Returns color assigned to single node.
void	SetColor (const int ID, const Quantity_Color &theColor)
	Sets color assigned to single node.
void	UseTexture (const bool theToUse)
	Specify whether texture must be used to build presentation.
bool	IsUseTexture () const
	Verify whether texture is used to build presentation.
void	SetColorMap (const NCollection_Sequence< Quantity_Color > &theColors)
	Set colors to be used for texrture presentation theColors - colors for valid coordinates (laying in range [0, 1]).
const NCollection_Sequence< Quantity_Color > &	GetColorMap () const
	Return colors used for texrture presentation.
void	SetInvalidColor (const Quantity_Color &theInvalidColor)
	Set color representing invalid texture coordinate (laying outside range [0, 1]).
Quantity_Color	GetInvalidColor () const
	Return color representing invalid texture coordinate (laying outside range [0, 1]).
void	SetTextureCoords (const NCollection_DataMap< int, double > &theMap)
	Specify correspondence between node IDs and texture coordinates (range [0, 1]).
const NCollection_DataMap< int, double > &	GetTextureCoords () const
	Get correspondence between node IDs and texture coordinates (range [0, 1]).
void	SetTextureCoord (const int theID, const double theCoord)
	Specify correspondence between node ID and texture coordinate (range [0, 1]).
double	GetTextureCoord (const int theID)
	Return correspondence between node IDs and texture coordinate (range [0, 1]).
void	AddVolumePrs (const occ::handle< NCollection_HArray1< NCollection_Sequence< int > > > &theTopo, const NCollection_Array1< int > &theNodes, const NCollection_Array1< double > &theCoords, const occ::handle< Graphic3d_ArrayOfPrimitives > &theArray, const bool theIsShaded, const int theNbColors, const int theNbTexColors, const double theColorRatio) const
	Add to array polygons or polylines representing volume.
Public Member Functions inherited from MeshVS_PrsBuilder
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.

Additional Inherited Members
typedef void	base_type
	Returns a type descriptor about this object.
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.
Protected Member Functions inherited from 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)
	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 inherited from MeshVS_PrsBuilder
MeshVS_MeshPtr	myParentMesh

Detailed Description

This class provides methods to create presentation of nodes with assigned color. There are two ways of presentation building.

Without using texture. In this case colors of nodes are specified with DataMapOfIntegerColor and presentation is built with gradient fill between these nodes (default behaviour)
Using texture. In this case presentation is built with spectrum filling between nodes. For example, if one node has blue color and second one has violet color, parameters of this class may be set to fill presentation between nodes with solar spectrum. Methods: UseTexture - activates/deactivates this way SetColorMap - sets colors used for generation of texture SetColorindices - specifies correspondence between node IDs and indices of colors from color map

Constructor & Destructor Documentation

◆ MeshVS_NodalColorPrsBuilder()

MeshVS_NodalColorPrsBuilder::MeshVS_NodalColorPrsBuilder	(	const occ::handle< MeshVS_Mesh > &	Parent,
		const MeshVS_DisplayModeFlags &	Flags = MeshVS_DMF_NodalColorDataPrs,
		const occ::handle< MeshVS_DataSource > &	DS = nullptr,
		const int	Id = -1,
		const MeshVS_BuilderPriority &	Priority = MeshVS_BP_NodalColor )

Member Function Documentation

◆ AddVolumePrs()

void MeshVS_NodalColorPrsBuilder::AddVolumePrs	(	const occ::handle< NCollection_HArray1< NCollection_Sequence< int > > > &	theTopo,
		const NCollection_Array1< int > &	theNodes,
		const NCollection_Array1< double > &	theCoords,
		const occ::handle< Graphic3d_ArrayOfPrimitives > &	theArray,
		const bool	theIsShaded,
		const int	theNbColors,
		const int	theNbTexColors,
		const double	theColorRatio ) const

Add to array polygons or polylines representing volume.

◆ Build()

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

overridevirtual

Builds presentation of nodes with assigned color.

Implements MeshVS_PrsBuilder.

◆ GetColor()

bool MeshVS_NodalColorPrsBuilder::GetColor	(	const int	ID,
		Quantity_Color &	theColor ) const

Returns color assigned to single node.

◆ GetColorMap()

const NCollection_Sequence< Quantity_Color > & MeshVS_NodalColorPrsBuilder::GetColorMap ( ) const

Return colors used for texrture presentation.

◆ GetColors()

const NCollection_DataMap< int, Quantity_Color > & MeshVS_NodalColorPrsBuilder::GetColors ( ) const

Returns map of colors assigned to nodes.

◆ GetInvalidColor()

Quantity_Color MeshVS_NodalColorPrsBuilder::GetInvalidColor ( ) const

Return color representing invalid texture coordinate (laying outside range [0, 1]).

◆ GetTextureCoord()

double MeshVS_NodalColorPrsBuilder::GetTextureCoord ( const int theID )

Return correspondence between node IDs and texture coordinate (range [0, 1]).

◆ GetTextureCoords()

const NCollection_DataMap< int, double > & MeshVS_NodalColorPrsBuilder::GetTextureCoords ( ) const

Get correspondence between node IDs and texture coordinates (range [0, 1]).

◆ HasColors()

bool MeshVS_NodalColorPrsBuilder::HasColors ( ) const

Returns true, if map isn't empty.

◆ IsUseTexture()

bool MeshVS_NodalColorPrsBuilder::IsUseTexture ( ) const

Verify whether texture is used to build presentation.

◆ SetColor()

void MeshVS_NodalColorPrsBuilder::SetColor	(	const int	ID,
		const Quantity_Color &	theColor )

Sets color assigned to single node.

◆ SetColorMap()

void MeshVS_NodalColorPrsBuilder::SetColorMap ( const NCollection_Sequence< Quantity_Color > & theColors )

Set colors to be used for texrture presentation theColors - colors for valid coordinates (laying in range [0, 1]).

◆ SetColors()

void MeshVS_NodalColorPrsBuilder::SetColors ( const NCollection_DataMap< int, Quantity_Color > & Map )

Sets map of colors assigned to nodes.

◆ SetInvalidColor()

void MeshVS_NodalColorPrsBuilder::SetInvalidColor ( const Quantity_Color & theInvalidColor )

Set color representing invalid texture coordinate (laying outside range [0, 1]).

◆ SetTextureCoord()

void MeshVS_NodalColorPrsBuilder::SetTextureCoord	(	const int	theID,
		const double	theCoord )

Specify correspondence between node ID and texture coordinate (range [0, 1]).

◆ SetTextureCoords()

void MeshVS_NodalColorPrsBuilder::SetTextureCoords ( const NCollection_DataMap< int, double > & theMap )

Specify correspondence between node IDs and texture coordinates (range [0, 1]).

◆ UseTexture()

void MeshVS_NodalColorPrsBuilder::UseTexture ( const bool theToUse )

Specify whether texture must be used to build presentation.

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

MeshVS_NodalColorPrsBuilder.hxx

Public Member Functions

Additional Inherited Members