Prs3d_ArrowAspect Class Reference

A framework for displaying arrows in representations of dimensions and relations. More...

#include <Prs3d_ArrowAspect.hxx>

Inheritance diagram for Prs3d_ArrowAspect:

Public Member Functions
	Prs3d_ArrowAspect ()
	Constructs an empty framework for displaying arrows in representations of lengths. The lengths displayed are either on their own or in chamfers, fillets, diameters and radii.
	Prs3d_ArrowAspect (const Standard_Real anAngle, const Standard_Real aLength)
	Constructs a framework to display an arrow with a shaft of the length aLength and having a head with sides at the angle anAngle from each other.
	Prs3d_ArrowAspect (const Handle< Graphic3d_AspectLine3d > &theAspect)
void	SetAngle (const Standard_Real anAngle)
	defines the angle of the arrows.
Standard_Real	Angle () const
	returns the current value of the angle used when drawing an arrow.
void	SetLength (const Standard_Real theLength)
	Defines the length of the arrows.
Standard_Real	Length () const
	Returns the current value of the length used when drawing an arrow.
void	SetZoomable (bool theIsZoomable)
	Turns usage of arrow zoomable on/off.
bool	IsZoomable () const
	Returns TRUE when the Arrow Zoomable is on; TRUE by default.
void	SetColor (const Quantity_Color &theColor)
const Handle< Graphic3d_AspectLine3d > &	Aspect () const
void	SetAspect (const Handle< Graphic3d_AspectLine3d > &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_AspectLine3d >	myArrowAspect
Standard_Real	myAngle
Standard_Real	myLength
Standard_Boolean	myIsZoomable

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 for displaying arrows in representations of dimensions and relations.

Constructor & Destructor Documentation

Prs3d_ArrowAspect() [1/3]

Prs3d_ArrowAspect::Prs3d_ArrowAspect

(

)

Constructs an empty framework for displaying arrows in representations of lengths. The lengths displayed are either on their own or in chamfers, fillets, diameters and radii.

Prs3d_ArrowAspect() [2/3]

Prs3d_ArrowAspect::Prs3d_ArrowAspect	(	const Standard_Real	anAngle,
		const Standard_Real	aLength
	)

Constructs a framework to display an arrow with a shaft of the length aLength and having a head with sides at the angle anAngle from each other.

Prs3d_ArrowAspect() [3/3]

Prs3d_ArrowAspect::Prs3d_ArrowAspect

(

const Handle< Graphic3d_AspectLine3d > &

theAspect

)

Member Function Documentation

Angle()

Standard_Real Prs3d_ArrowAspect::Angle ( ) const

inline

returns the current value of the angle used when drawing an arrow.

Aspect()

const Handle< Graphic3d_AspectLine3d > & Prs3d_ArrowAspect::Aspect ( ) const

inline

DumpJson()

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

overridevirtual

Dumps the content of me into the stream.

Implements Prs3d_BasicAspect.

IsZoomable()

bool Prs3d_ArrowAspect::IsZoomable ( ) const

inline

Returns TRUE when the Arrow Zoomable is on; TRUE by default.

Length()

Standard_Real Prs3d_ArrowAspect::Length ( ) const

inline

Returns the current value of the length used when drawing an arrow.

SetAngle()

void Prs3d_ArrowAspect::SetAngle

(

const Standard_Real

anAngle

)

defines the angle of the arrows.

SetAspect()

void Prs3d_ArrowAspect::SetAspect ( const Handle< Graphic3d_AspectLine3d > &  theAspect )

inline

SetColor()

void Prs3d_ArrowAspect::SetColor ( const Quantity_Color &  theColor )

inline

SetLength()

void Prs3d_ArrowAspect::SetLength ( const Standard_Real  theLength )

inline

Defines the length of the arrows.

SetZoomable()

void Prs3d_ArrowAspect::SetZoomable ( bool  theIsZoomable )

inline

Turns usage of arrow zoomable on/off.

Field Documentation

myAngle

Standard_Real Prs3d_ArrowAspect::myAngle

protected

myArrowAspect

Handle< Graphic3d_AspectLine3d > Prs3d_ArrowAspect::myArrowAspect

protected

myIsZoomable

Standard_Boolean Prs3d_ArrowAspect::myIsZoomable

protected

myLength

Standard_Real Prs3d_ArrowAspect::myLength

protected

---

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

• Prs3d_ArrowAspect.hxx