Prs3d_ShadingAspect Class Reference

A framework to define the display of shading. The attributes which make up this definition include: More...

#include <Prs3d_ShadingAspect.hxx>

Inheritance diagram for Prs3d_ShadingAspect:

Public Member Functions
	Prs3d_ShadingAspect ()
	Constructs an empty framework to display shading.
	Prs3d_ShadingAspect (const Handle< Graphic3d_AspectFillArea3d > &theAspect)
	Constructor with initialization.
void	SetColor (const Quantity_Color &aColor, const Aspect_TypeOfFacingModel aModel=Aspect_TOFM_BOTH_SIDE)
	Change the polygons interior color and material ambient color.
void	SetMaterial (const Graphic3d_MaterialAspect &aMaterial, const Aspect_TypeOfFacingModel aModel=Aspect_TOFM_BOTH_SIDE)
	Change the polygons material aspect.
void	SetTransparency (const Standard_Real aValue, const Aspect_TypeOfFacingModel aModel=Aspect_TOFM_BOTH_SIDE)
	Change the polygons transparency value. Warning : aValue must be in the range 0,1. 0 is the default (NO transparent)
const Quantity_Color &	Color (const Aspect_TypeOfFacingModel aModel=Aspect_TOFM_FRONT_SIDE) const
	Returns the polygons color.
const Graphic3d_MaterialAspect &	Material (const Aspect_TypeOfFacingModel aModel=Aspect_TOFM_FRONT_SIDE) const
	Returns the polygons material aspect.
Standard_Real	Transparency (const Aspect_TypeOfFacingModel aModel=Aspect_TOFM_FRONT_SIDE) const
	Returns the polygons transparency value.
const Handle< Graphic3d_AspectFillArea3d > &	Aspect () const
	Returns the polygons aspect properties.
void	SetAspect (const Handle< Graphic3d_AspectFillArea3d > &theAspect)
virtual void	DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const override
	Dumps the content of me into the stream.
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.

Protected Attributes
Handle< Graphic3d_AspectFillArea3d >	myAspect

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

A framework to define the display of shading. The attributes which make up this definition include:

• fill aspect
• color, and
• material

Constructor & Destructor Documentation

Prs3d_ShadingAspect() [1/2]

Prs3d_ShadingAspect::Prs3d_ShadingAspect

(

)

Constructs an empty framework to display shading.

Prs3d_ShadingAspect() [2/2]

Prs3d_ShadingAspect::Prs3d_ShadingAspect ( const Handle< Graphic3d_AspectFillArea3d > & theAspect )

inline

Constructor with initialization.

Member Function Documentation

Aspect()

const Handle< Graphic3d_AspectFillArea3d > & Prs3d_ShadingAspect::Aspect ( ) const

inline

Returns the polygons aspect properties.

Color()

const Quantity_Color & Prs3d_ShadingAspect::Color

(

const Aspect_TypeOfFacingModel

aModel = Aspect_TOFM_FRONT_SIDE

)

const

Returns the polygons color.

DumpJson()

virtual void Prs3d_ShadingAspect::DumpJson ( Standard_OStream & theOStream, Standard_Integer theDepth = -1 ) const

overridevirtual

Dumps the content of me into the stream.

Implements Prs3d_BasicAspect.

Material()

const Graphic3d_MaterialAspect & Prs3d_ShadingAspect::Material

(

const Aspect_TypeOfFacingModel

aModel = Aspect_TOFM_FRONT_SIDE

)

const

Returns the polygons material aspect.

SetAspect()

void Prs3d_ShadingAspect::SetAspect ( const Handle< Graphic3d_AspectFillArea3d > & theAspect )

inline

SetColor()

void Prs3d_ShadingAspect::SetColor	(	const Quantity_Color &	aColor,
		const Aspect_TypeOfFacingModel	aModel = Aspect_TOFM_BOTH_SIDE )

Change the polygons interior color and material ambient color.

SetMaterial()

void Prs3d_ShadingAspect::SetMaterial	(	const Graphic3d_MaterialAspect &	aMaterial,
		const Aspect_TypeOfFacingModel	aModel = Aspect_TOFM_BOTH_SIDE )

Change the polygons material aspect.

SetTransparency()

void Prs3d_ShadingAspect::SetTransparency	(	const Standard_Real	aValue,
		const Aspect_TypeOfFacingModel	aModel = Aspect_TOFM_BOTH_SIDE )

Change the polygons transparency value. Warning : aValue must be in the range 0,1. 0 is the default (NO transparent)

Transparency()

Standard_Real Prs3d_ShadingAspect::Transparency

(

const Aspect_TypeOfFacingModel

aModel = Aspect_TOFM_FRONT_SIDE

)

const

Returns the polygons transparency value.

Field Documentation

myAspect

Handle< Graphic3d_AspectFillArea3d > Prs3d_ShadingAspect::myAspect

protected

---

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

• Prs3d_ShadingAspect.hxx