A framework to define the display of planes. More...

#include <Prs3d_PlaneAspect.hxx>

Inheritance diagram for Prs3d_PlaneAspect:

[legend]

Public Member Functions
	Prs3d_PlaneAspect ()
	Constructs an empty framework for the display of planes.

const occ::handle< Prs3d_LineAspect > &	EdgesAspect () const
	Returns the attributes of displayed edges involved in the presentation of planes.

const occ::handle< Prs3d_LineAspect > &	IsoAspect () const
	Returns the attributes of displayed isoparameters involved in the presentation of planes.

const occ::handle< Prs3d_LineAspect > &	ArrowAspect () const
	Returns the settings for displaying an arrow.

void	SetArrowsLength (const double theLength)

double	ArrowsLength () const
	Returns the length of the arrow shaft used in the display of arrows.

void	SetArrowsSize (const double theSize)
	Sets the angle of the arrowhead used in the display of planes.

double	ArrowsSize () const
	Returns the size of arrows used in the display of planes.

void	SetArrowsAngle (const double theAngle)
	Sets the angle of the arrowhead used in the display of arrows involved in the presentation of planes.

double	ArrowsAngle () const
	Returns the angle of the arrowhead used in the display of arrows involved in the presentation of planes.

void	SetDisplayCenterArrow (const bool theToDraw)
	Sets the display attributes defined in DisplayCenterArrow to active.

bool	DisplayCenterArrow () const
	Returns true if the display of center arrows is allowed.

void	SetDisplayEdgesArrows (const bool theToDraw)
	Sets the display attributes defined in DisplayEdgesArrows to active.

bool	DisplayEdgesArrows () const
	Returns true if the display of edge arrows is allowed.

void	SetDisplayEdges (const bool theToDraw)

bool	DisplayEdges () const

void	SetDisplayIso (const bool theToDraw)
	Sets the display attributes defined in DisplayIso to active.

bool	DisplayIso () const
	Returns true if the display of isoparameters is allowed.

void	SetPlaneLength (const double theLX, const double theLY)

double	PlaneXLength () const
	Returns the length of the x axis used in the display of planes.

double	PlaneYLength () const
	Returns the length of the y axis used in the display of planes.

void	SetIsoDistance (const double theL)
	Sets the distance L between isoparameters used in the display of planes.

double	IsoDistance () const
	Returns the distance between isoparameters used in the display of planes.

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.

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 planes.

Constructor & Destructor Documentation

◆ Prs3d_PlaneAspect()

Prs3d_PlaneAspect::Prs3d_PlaneAspect ( )

Constructs an empty framework for the display of planes.

Member Function Documentation

◆ ArrowAspect()

const occ::handle< Prs3d_LineAspect > & Prs3d_PlaneAspect::ArrowAspect ( ) const

inline

Returns the settings for displaying an arrow.

◆ ArrowsAngle()

double Prs3d_PlaneAspect::ArrowsAngle ( ) const

inline

Returns the angle of the arrowhead used in the display of arrows involved in the presentation of planes.

◆ ArrowsLength()

double Prs3d_PlaneAspect::ArrowsLength ( ) const

inline

Returns the length of the arrow shaft used in the display of arrows.

◆ ArrowsSize()

double Prs3d_PlaneAspect::ArrowsSize ( ) const

inline

Returns the size of arrows used in the display of planes.

◆ DisplayCenterArrow()

bool Prs3d_PlaneAspect::DisplayCenterArrow ( ) const

inline

Returns true if the display of center arrows is allowed.

◆ DisplayEdges()

bool Prs3d_PlaneAspect::DisplayEdges ( ) const

inline

◆ DisplayEdgesArrows()

bool Prs3d_PlaneAspect::DisplayEdgesArrows ( ) const

inline

Returns true if the display of edge arrows is allowed.

◆ DisplayIso()

bool Prs3d_PlaneAspect::DisplayIso ( ) const

inline

Returns true if the display of isoparameters is allowed.

◆ DumpJson()

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

overridevirtual

Dumps the content of me into the stream.

Implements Prs3d_BasicAspect.

◆ EdgesAspect()

const occ::handle< Prs3d_LineAspect > & Prs3d_PlaneAspect::EdgesAspect ( ) const

inline

Returns the attributes of displayed edges involved in the presentation of planes.

◆ IsoAspect()

const occ::handle< Prs3d_LineAspect > & Prs3d_PlaneAspect::IsoAspect ( ) const

inline

Returns the attributes of displayed isoparameters involved in the presentation of planes.

◆ IsoDistance()

double Prs3d_PlaneAspect::IsoDistance ( ) const

inline

Returns the distance between isoparameters used in the display of planes.

◆ PlaneXLength()

double Prs3d_PlaneAspect::PlaneXLength ( ) const

inline

Returns the length of the x axis used in the display of planes.

◆ PlaneYLength()

double Prs3d_PlaneAspect::PlaneYLength ( ) const

inline

Returns the length of the y axis used in the display of planes.

◆ SetArrowsAngle()

void Prs3d_PlaneAspect::SetArrowsAngle ( const double theAngle )

inline

Sets the angle of the arrowhead used in the display of arrows involved in the presentation of planes.

◆ SetArrowsLength()

void Prs3d_PlaneAspect::SetArrowsLength ( const double theLength )

inline

◆ SetArrowsSize()

void Prs3d_PlaneAspect::SetArrowsSize ( const double theSize )

inline

Sets the angle of the arrowhead used in the display of planes.

◆ SetDisplayCenterArrow()

void Prs3d_PlaneAspect::SetDisplayCenterArrow ( const bool theToDraw )

inline

Sets the display attributes defined in DisplayCenterArrow to active.

◆ SetDisplayEdges()

void Prs3d_PlaneAspect::SetDisplayEdges ( const bool theToDraw )

inline

◆ SetDisplayEdgesArrows()

void Prs3d_PlaneAspect::SetDisplayEdgesArrows ( const bool theToDraw )

inline

Sets the display attributes defined in DisplayEdgesArrows to active.

◆ SetDisplayIso()

void Prs3d_PlaneAspect::SetDisplayIso ( const bool theToDraw )

inline

Sets the display attributes defined in DisplayIso to active.

◆ SetIsoDistance()

void Prs3d_PlaneAspect::SetIsoDistance ( const double theL )

inline

Sets the distance L between isoparameters used in the display of planes.

◆ SetPlaneLength()

void Prs3d_PlaneAspect::SetPlaneLength	(	const double	theLX,
		const double	theLY )

inline

Field Documentation

◆ myArrowAspect

occ::handle<Prs3d_LineAspect> Prs3d_PlaneAspect::myArrowAspect

protected

◆ myArrowsAngle

double Prs3d_PlaneAspect::myArrowsAngle

protected

◆ myArrowsLength

double Prs3d_PlaneAspect::myArrowsLength

protected

◆ myArrowsSize

double Prs3d_PlaneAspect::myArrowsSize

protected

◆ myDrawCenterArrow

bool Prs3d_PlaneAspect::myDrawCenterArrow

protected

◆ myDrawEdges

bool Prs3d_PlaneAspect::myDrawEdges

protected

◆ myDrawEdgesArrows

bool Prs3d_PlaneAspect::myDrawEdgesArrows

protected

◆ myDrawIso

bool Prs3d_PlaneAspect::myDrawIso

protected

◆ myEdgesAspect

occ::handle<Prs3d_LineAspect> Prs3d_PlaneAspect::myEdgesAspect

protected

◆ myIsoAspect

occ::handle<Prs3d_LineAspect> Prs3d_PlaneAspect::myIsoAspect

protected

◆ myIsoDistance

double Prs3d_PlaneAspect::myIsoDistance

protected

◆ myPlaneXLength

double Prs3d_PlaneAspect::myPlaneXLength

protected

◆ myPlaneYLength

double Prs3d_PlaneAspect::myPlaneYLength

protected

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

Prs3d_PlaneAspect.hxx

Protected Attributes
occ::handle< Prs3d_LineAspect >	myEdgesAspect

occ::handle< Prs3d_LineAspect >	myIsoAspect

occ::handle< Prs3d_LineAspect >	myArrowAspect

double	myArrowsLength

double	myArrowsSize

double	myArrowsAngle

double	myPlaneXLength

double	myPlaneYLength

double	myIsoDistance

bool	myDrawCenterArrow

bool	myDrawEdgesArrows

bool	myDrawEdges

bool	myDrawIso

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Prs3d_PlaneAspect()

Member Function Documentation

◆ ArrowAspect()

◆ ArrowsAngle()

◆ ArrowsLength()

◆ ArrowsSize()

◆ DisplayCenterArrow()

◆ DisplayEdges()

◆ DisplayEdgesArrows()

◆ DisplayIso()

◆ DumpJson()

◆ EdgesAspect()

◆ IsoAspect()

◆ IsoDistance()

◆ PlaneXLength()

◆ PlaneYLength()

◆ SetArrowsAngle()

◆ SetArrowsLength()

◆ SetArrowsSize()

◆ SetDisplayCenterArrow()

◆ SetDisplayEdges()

◆ SetDisplayEdgesArrows()

◆ SetDisplayIso()

◆ SetIsoDistance()

◆ SetPlaneLength()

Field Documentation

◆ myArrowAspect

◆ myArrowsAngle

◆ myArrowsLength

◆ myArrowsSize

◆ myDrawCenterArrow

◆ myDrawEdges

◆ myDrawEdgesArrows

◆ myDrawIso

◆ myEdgesAspect

◆ myIsoAspect

◆ myIsoDistance

◆ myPlaneXLength

◆ myPlaneYLength