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 Handle< MeshVS_Mesh > &Parent, const MeshVS_DisplayModeFlags &Flags=MeshVS_DMF_NodalColorDataPrs, const Handle< MeshVS_DataSource > &DS=0, const Standard_Integer Id=-1, const MeshVS_BuilderPriority &Priority=MeshVS_BP_NodalColor)

virtual void	Build (const Handle< Prs3d_Presentation > &Prs, const TColStd_PackedMapOfInteger &IDs, TColStd_PackedMapOfInteger &IDsToExclude, const Standard_Boolean IsElement, const Standard_Integer DisplayMode) const override
	Builds presentation of nodes with assigned color.

const MeshVS_DataMapOfIntegerColor &	GetColors () const
	Returns map of colors assigned to nodes.

void	SetColors (const MeshVS_DataMapOfIntegerColor &Map)
	Sets map of colors assigned to nodes.

Standard_Boolean	HasColors () const
	Returns true, if map isn't empty.

Standard_Boolean	GetColor (const Standard_Integer ID, Quantity_Color &theColor) const
	Returns color assigned to single node.

void	SetColor (const Standard_Integer ID, const Quantity_Color &theColor)
	Sets color assigned to single node.

void	UseTexture (const Standard_Boolean theToUse)
	Specify whether texture must be used to build presentation.

Standard_Boolean	IsUseTexture () const
	Verify whether texture is used to build presentation.

void	SetColorMap (const Aspect_SequenceOfColor &theColors)
	Set colors to be used for texrture presentation theColors - colors for valid coordinates (laying in range [0, 1])

const Aspect_SequenceOfColor &	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 TColStd_DataMapOfIntegerReal &theMap)
	Specify correspondence between node IDs and texture coordinates (range [0, 1])

const TColStd_DataMapOfIntegerReal &	GetTextureCoords () const
	Get correspondence between node IDs and texture coordinates (range [0, 1])

void	SetTextureCoord (const Standard_Integer theID, const Standard_Real theCoord)
	Specify correspondence between node ID and texture coordinate (range [0, 1])

Standard_Real	GetTextureCoord (const Standard_Integer theID)
	Return correspondence between node IDs and texture coordinate (range [0, 1])

void	AddVolumePrs (const Handle< MeshVS_HArray1OfSequenceOfInteger > &theTopo, const TColStd_Array1OfInteger &theNodes, const TColStd_Array1OfReal &theCoords, const Handle< Graphic3d_ArrayOfPrimitives > &theArray, const Standard_Boolean theIsShaded, const Standard_Integer theNbColors, const Standard_Integer theNbTexColors, const Standard_Real theColorRatio) const
	Add to array polygons or polylines representing volume.

Public Member Functions inherited from MeshVS_PrsBuilder
virtual void	CustomBuild (const Handle< Prs3d_Presentation > &Prs, const TColStd_PackedMapOfInteger &IDs, TColStd_PackedMapOfInteger &IDsToExclude, const Standard_Integer 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 Handle< Select3D_SensitiveEntity >	CustomSensitiveEntity (const Handle< SelectMgr_EntityOwner > &Owner, const Standard_Integer SelectMode) const
	This method is called to build sensitive of custom elements ( they have MeshVS_ET_0D type )

Standard_Integer	GetFlags () const
	Returns flags, assigned with builder during creation.

virtual Standard_Boolean	TestFlags (const Standard_Integer 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 Standard_True only if display mode is appropriate for this builder.

Standard_Integer	GetId () const
	Returns builder ID.

Standard_Integer	GetPriority () const
	Returns priority; as priority bigger, as soon builder will be called.

Handle< MeshVS_DataSource >	GetDataSource () const
	Returns custom data source or default ( from MeshVS_Mesh ) if custom is NULL.

void	SetDataSource (const Handle< MeshVS_DataSource > &newDS)
	Change custom data source.

Handle< MeshVS_Drawer >	GetDrawer () const
	Returns custom drawer or default ( from MeshVS_Mesh ) if custom is NULL.

void	SetDrawer (const Handle< MeshVS_Drawer > &newDr)
	Change custom drawer.

void	SetExcluding (const Standard_Boolean state)
	Set excluding state. If it is Standard_True, the nodes or elements, processed by current builder will be noted and next builder won't process its.

Standard_Boolean	IsExcludingOn () const
	Read excluding state.

void	SetPresentationManager (const Handle< PrsMgr_PresentationManager > &thePrsMgr)
	Set presentation manager for builder.

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

Protected Member Functions inherited from MeshVS_PrsBuilder
	MeshVS_PrsBuilder (const Handle< MeshVS_Mesh > &Parent, const MeshVS_DisplayModeFlags &Flags, const Handle< MeshVS_DataSource > &DS, const Standard_Integer 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.

Handle< MeshVS_DataSource >	DataSource () const
	Returns only custom data source.

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 Handle< MeshVS_Mesh > &	Parent,
		const MeshVS_DisplayModeFlags &	Flags = `MeshVS_DMF_NodalColorDataPrs`,
		const Handle< MeshVS_DataSource > &	DS = `0`,
		const Standard_Integer	Id = `-1`,
		const MeshVS_BuilderPriority &	Priority = `MeshVS_BP_NodalColor`
	)

Member Function Documentation

◆ AddVolumePrs()

void MeshVS_NodalColorPrsBuilder::AddVolumePrs	(	const Handle< MeshVS_HArray1OfSequenceOfInteger > &	theTopo,
		const TColStd_Array1OfInteger &	theNodes,
		const TColStd_Array1OfReal &	theCoords,
		const Handle< Graphic3d_ArrayOfPrimitives > &	theArray,
		const Standard_Boolean	theIsShaded,
		const Standard_Integer	theNbColors,
		const Standard_Integer	theNbTexColors,
		const Standard_Real	theColorRatio
	)		const

Add to array polygons or polylines representing volume.

◆ Build()

virtual void MeshVS_NodalColorPrsBuilder::Build	(	const Handle< Prs3d_Presentation > &	Prs,
		const TColStd_PackedMapOfInteger &	IDs,
		TColStd_PackedMapOfInteger &	IDsToExclude,
		const Standard_Boolean	IsElement,
		const Standard_Integer	DisplayMode
	)		const

overridevirtual

Builds presentation of nodes with assigned color.

Implements MeshVS_PrsBuilder.

◆ GetColor()

Standard_Boolean MeshVS_NodalColorPrsBuilder::GetColor	(	const Standard_Integer	ID,
		Quantity_Color &	theColor
	)		const

Returns color assigned to single node.

◆ GetColorMap()

const Aspect_SequenceOfColor & MeshVS_NodalColorPrsBuilder::GetColorMap ( ) const

Return colors used for texrture presentation.

◆ GetColors()

const MeshVS_DataMapOfIntegerColor & 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()

Standard_Real MeshVS_NodalColorPrsBuilder::GetTextureCoord ( const Standard_Integer theID )

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

◆ GetTextureCoords()

const TColStd_DataMapOfIntegerReal & MeshVS_NodalColorPrsBuilder::GetTextureCoords ( ) const

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

◆ HasColors()

Standard_Boolean MeshVS_NodalColorPrsBuilder::HasColors ( ) const

Returns true, if map isn't empty.

◆ IsUseTexture()

Standard_Boolean MeshVS_NodalColorPrsBuilder::IsUseTexture ( ) const

Verify whether texture is used to build presentation.

◆ SetColor()

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

Sets color assigned to single node.

◆ SetColorMap()

void MeshVS_NodalColorPrsBuilder::SetColorMap ( const Aspect_SequenceOfColor & 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 MeshVS_DataMapOfIntegerColor & 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 Standard_Integer	theID,
		const Standard_Real	theCoord
	)

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

◆ SetTextureCoords()

void MeshVS_NodalColorPrsBuilder::SetTextureCoords ( const TColStd_DataMapOfIntegerReal & theMap )

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

◆ UseTexture()

void MeshVS_NodalColorPrsBuilder::UseTexture ( const Standard_Boolean 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