MeshVS_Drawer Class Reference

This class provided the common interface to share between classes big set of constants affecting to object appearance. By default, this class can store integers, doubles, OCC colors, OCC materials. Each of OCC enum members can be stored as integers. More...

#include <MeshVS_Drawer.hxx>

Inheritance diagram for MeshVS_Drawer:

Public Member Functions
virtual void	Assign (const Handle< MeshVS_Drawer > &aDrawer)
	This method copies other drawer contents to this.
void	SetInteger (const Standard_Integer Key, const Standard_Integer Value)
void	SetDouble (const Standard_Integer Key, const Standard_Real Value)
void	SetBoolean (const Standard_Integer Key, const Standard_Boolean Value)
void	SetColor (const Standard_Integer Key, const Quantity_Color &Value)
void	SetMaterial (const Standard_Integer Key, const Graphic3d_MaterialAspect &Value)
void	SetAsciiString (const Standard_Integer Key, const TCollection_AsciiString &Value)
Standard_Boolean	GetInteger (const Standard_Integer Key, Standard_Integer &Value) const
Standard_Boolean	GetDouble (const Standard_Integer Key, Standard_Real &Value) const
Standard_Boolean	GetBoolean (const Standard_Integer Key, Standard_Boolean &Value) const
Standard_Boolean	GetColor (const Standard_Integer Key, Quantity_Color &Value) const
Standard_Boolean	GetMaterial (const Standard_Integer Key, Graphic3d_MaterialAspect &Value) const
Standard_Boolean	GetAsciiString (const Standard_Integer Key, TCollection_AsciiString &Value) const
Standard_Boolean	RemoveInteger (const Standard_Integer Key)
Standard_Boolean	RemoveDouble (const Standard_Integer Key)
Standard_Boolean	RemoveBoolean (const Standard_Integer Key)
Standard_Boolean	RemoveColor (const Standard_Integer Key)
Standard_Boolean	RemoveMaterial (const Standard_Integer Key)
Standard_Boolean	RemoveAsciiString (const Standard_Integer Key)
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.

Detailed Description

This class provided the common interface to share between classes big set of constants affecting to object appearance. By default, this class can store integers, doubles, OCC colors, OCC materials. Each of OCC enum members can be stored as integers.

Member Function Documentation

Assign()

virtual void MeshVS_Drawer::Assign ( const Handle< MeshVS_Drawer > &  aDrawer )

virtual

This method copies other drawer contents to this.

GetAsciiString()

Standard_Boolean MeshVS_Drawer::GetAsciiString	(	const Standard_Integer	Key,
		TCollection_AsciiString &	Value
	)		const

GetBoolean()

Standard_Boolean MeshVS_Drawer::GetBoolean	(	const Standard_Integer	Key,
		Standard_Boolean &	Value
	)		const

GetColor()

Standard_Boolean MeshVS_Drawer::GetColor	(	const Standard_Integer	Key,
		Quantity_Color &	Value
	)		const

GetDouble()

Standard_Boolean MeshVS_Drawer::GetDouble	(	const Standard_Integer	Key,
		Standard_Real &	Value
	)		const

GetInteger()

Standard_Boolean MeshVS_Drawer::GetInteger	(	const Standard_Integer	Key,
		Standard_Integer &	Value
	)		const

GetMaterial()

Standard_Boolean MeshVS_Drawer::GetMaterial	(	const Standard_Integer	Key,
		Graphic3d_MaterialAspect &	Value
	)		const

RemoveAsciiString()

Standard_Boolean MeshVS_Drawer::RemoveAsciiString

(

const Standard_Integer

Key

)

RemoveBoolean()

Standard_Boolean MeshVS_Drawer::RemoveBoolean

(

const Standard_Integer

Key

)

RemoveColor()

Standard_Boolean MeshVS_Drawer::RemoveColor

(

const Standard_Integer

Key

)

RemoveDouble()

Standard_Boolean MeshVS_Drawer::RemoveDouble

(

const Standard_Integer

Key

)

RemoveInteger()

Standard_Boolean MeshVS_Drawer::RemoveInteger

(

const Standard_Integer

Key

)

RemoveMaterial()

Standard_Boolean MeshVS_Drawer::RemoveMaterial

(

const Standard_Integer

Key

)

SetAsciiString()

void MeshVS_Drawer::SetAsciiString	(	const Standard_Integer	Key,
		const TCollection_AsciiString &	Value
	)

SetBoolean()

void MeshVS_Drawer::SetBoolean	(	const Standard_Integer	Key,
		const Standard_Boolean	Value
	)

SetColor()

void MeshVS_Drawer::SetColor	(	const Standard_Integer	Key,
		const Quantity_Color &	Value
	)

SetDouble()

void MeshVS_Drawer::SetDouble	(	const Standard_Integer	Key,
		const Standard_Real	Value
	)

SetInteger()

void MeshVS_Drawer::SetInteger	(	const Standard_Integer	Key,
		const Standard_Integer	Value
	)

SetMaterial()

void MeshVS_Drawer::SetMaterial	(	const Standard_Integer	Key,
		const Graphic3d_MaterialAspect &	Value
	)

---

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

• MeshVS_Drawer.hxx