Prs3d_LineAspect Class Reference

A framework for defining how a line will be displayed in a presentation. Aspects of line display include width, color and type of line. The definition set by this class is then passed to the attribute manager Prs3d_Drawer. Any object which requires a value for line aspect as an argument may then be given the attribute manager as a substitute argument in the form of a field such as myDrawer for example. More...

#include <Prs3d_LineAspect.hxx>

Inheritance diagram for Prs3d_LineAspect:

Public Member Functions
	Prs3d_LineAspect (const Quantity_Color &theColor, const Aspect_TypeOfLine theType, const double theWidth)
	Constructs a framework for line aspect defined by.
	Prs3d_LineAspect (const occ::handle< Graphic3d_AspectLine3d > &theAspect)
void	SetColor (const Quantity_Color &theColor)
	Sets the line color defined at the time of construction. Default value: Quantity_NOC_YELLOW.
void	SetTypeOfLine (const Aspect_TypeOfLine theType)
	Sets the type of line defined at the time of construction. This could, for example, be solid, dotted or made up of dashes. Default value: Aspect_TOL_SOLID.
void	SetWidth (const double theWidth)
	Sets the line width defined at the time of construction. Default value: 1.
const occ::handle< Graphic3d_AspectLine3d > &	Aspect () const
	Returns the line aspect. This is defined as the set of color, type and thickness attributes.
void	SetAspect (const occ::handle< Graphic3d_AspectLine3d > &theAspect)
void	DumpJson (Standard_OStream &theOStream, int 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 ()=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 Attributes
occ::handle< Graphic3d_AspectLine3d >	myAspect

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.

Detailed Description

A framework for defining how a line will be displayed in a presentation. Aspects of line display include width, color and type of line. The definition set by this class is then passed to the attribute manager Prs3d_Drawer. Any object which requires a value for line aspect as an argument may then be given the attribute manager as a substitute argument in the form of a field such as myDrawer for example.

Constructor & Destructor Documentation

Prs3d_LineAspect() [1/2]

Prs3d_LineAspect::Prs3d_LineAspect	(	const Quantity_Color &	theColor,
		const Aspect_TypeOfLine	theType,
		const double	theWidth )

Constructs a framework for line aspect defined by.

• the color aColor
• the type of line aType and
• the line thickness aWidth. Type of line refers to whether the line is solid or dotted, for example.

Prs3d_LineAspect() [2/2]

Prs3d_LineAspect::Prs3d_LineAspect ( const occ::handle< Graphic3d_AspectLine3d > & theAspect )

inline

Member Function Documentation

Aspect()

const occ::handle< Graphic3d_AspectLine3d > & Prs3d_LineAspect::Aspect ( ) const

inline

Returns the line aspect. This is defined as the set of color, type and thickness attributes.

DumpJson()

void Prs3d_LineAspect::DumpJson ( Standard_OStream & theOStream, int theDepth = -1 ) const

overridevirtual

Dumps the content of me into the stream.

Implements Prs3d_BasicAspect.

SetAspect()

void Prs3d_LineAspect::SetAspect ( const occ::handle< Graphic3d_AspectLine3d > & theAspect )

inline

SetColor()

void Prs3d_LineAspect::SetColor ( const Quantity_Color & theColor )

inline

Sets the line color defined at the time of construction. Default value: Quantity_NOC_YELLOW.

SetTypeOfLine()

void Prs3d_LineAspect::SetTypeOfLine ( const Aspect_TypeOfLine theType )

inline

Sets the type of line defined at the time of construction. This could, for example, be solid, dotted or made up of dashes. Default value: Aspect_TOL_SOLID.

SetWidth()

void Prs3d_LineAspect::SetWidth ( const double theWidth )

inline

Sets the line width defined at the time of construction. Default value: 1.

Field Documentation

myAspect

occ::handle<Graphic3d_AspectLine3d> Prs3d_LineAspect::myAspect

protected

---

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

• Prs3d_LineAspect.hxx