Prs3d_DimensionAspect Class Reference

defines the attributes when drawing a Length Presentation. More...

#include <Prs3d_DimensionAspect.hxx>

Inheritance diagram for Prs3d_DimensionAspect:

Public Member Functions
	Prs3d_DimensionAspect ()
	Constructs an empty framework to define the display of dimensions.
const occ::handle< Prs3d_LineAspect > &	LineAspect () const
	Returns the settings for the display of lines used in presentation of dimensions.
void	SetLineAspect (const occ::handle< Prs3d_LineAspect > &theAspect)
	Sets the display attributes of lines used in presentation of dimensions.
const occ::handle< Prs3d_TextAspect > &	TextAspect () const
	Returns the settings for the display of text used in presentation of dimensions.
void	SetTextAspect (const occ::handle< Prs3d_TextAspect > &theAspect)
	Sets the display attributes of text used in presentation of dimensions.
bool	IsText3d () const
	Check if text for dimension label is 3d.
void	MakeText3d (const bool isText3d)
	Sets type of text.
bool	IsTextShaded () const
	Check if 3d text for dimension label is shaded.
void	MakeTextShaded (const bool theIsTextShaded)
	Turns on/off text shading for 3d text.
bool	IsArrows3d () const
	Gets type of arrows.
void	MakeArrows3d (const bool theIsArrows3d)
	Sets type of arrows.
bool	IsUnitsDisplayed () const
	Shows if Units are to be displayed along with dimension value.
void	MakeUnitsDisplayed (const bool theIsDisplayed)
	Specifies whether the units string should be displayed along with value label or not.
void	SetArrowOrientation (const Prs3d_DimensionArrowOrientation theArrowOrient)
	Sets orientation of arrows (external or internal). By default orientation is chosen automatically according to situation and text label size.
Prs3d_DimensionArrowOrientation	ArrowOrientation () const
	Gets orientation of arrows (external or internal).
void	SetTextVerticalPosition (const Prs3d_DimensionTextVerticalPosition thePosition)
	Sets vertical text alignment for text label.
Prs3d_DimensionTextVerticalPosition	TextVerticalPosition () const
	Gets vertical text alignment for text label.
void	SetTextHorizontalPosition (const Prs3d_DimensionTextHorizontalPosition thePosition)
	Sets horizontal text alignment for text label.
Prs3d_DimensionTextHorizontalPosition	TextHorizontalPosition () const
	Gets horizontal text alignment for text label.
const occ::handle< Prs3d_ArrowAspect > &	ArrowAspect () const
	Returns the settings for displaying arrows.
void	SetArrowAspect (const occ::handle< Prs3d_ArrowAspect > &theAspect)
	Sets the display attributes of arrows used in presentation of dimensions.
void	SetCommonColor (const Quantity_Color &theColor)
	Sets the same color for all parts of dimension: lines, arrows and text.
void	SetExtensionSize (const double theSize)
	Sets extension size.
double	ExtensionSize () const
	Returns extension size.
void	SetArrowTailSize (const double theSize)
	Set size for arrow tail (extension without text).
double	ArrowTailSize () const
	Returns arrow tail size.
void	SetValueStringFormat (const TCollection_AsciiString &theFormat)
	Sets "Sprintf"-syntax format for formatting dimension value labels.
const TCollection_AsciiString &	ValueStringFormat () const
	Returns format.
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< Prs3d_LineAspect >	myLineAspect
occ::handle< Prs3d_TextAspect >	myTextAspect
occ::handle< Prs3d_ArrowAspect >	myArrowAspect
TCollection_AsciiString	myValueStringFormat
double	myExtensionSize
double	myArrowTailSize
Prs3d_DimensionArrowOrientation	myArrowOrientation
Prs3d_DimensionTextHorizontalPosition	myTextHPosition
Prs3d_DimensionTextVerticalPosition	myTextVPosition
bool	myToDisplayUnits
bool	myIsText3d
bool	myIsTextShaded
bool	myIsArrows3d

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

defines the attributes when drawing a Length Presentation.

Constructor & Destructor Documentation

Prs3d_DimensionAspect()

Prs3d_DimensionAspect::Prs3d_DimensionAspect

(

)

Constructs an empty framework to define the display of dimensions.

Member Function Documentation

ArrowAspect()

const occ::handle< Prs3d_ArrowAspect > & Prs3d_DimensionAspect::ArrowAspect ( ) const

inline

Returns the settings for displaying arrows.

ArrowOrientation()

Prs3d_DimensionArrowOrientation Prs3d_DimensionAspect::ArrowOrientation ( ) const

inline

Gets orientation of arrows (external or internal).

ArrowTailSize()

double Prs3d_DimensionAspect::ArrowTailSize ( ) const

inline

Returns arrow tail size.

DumpJson()

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

overridevirtual

Dumps the content of me into the stream.

Implements Prs3d_BasicAspect.

ExtensionSize()

double Prs3d_DimensionAspect::ExtensionSize ( ) const

inline

Returns extension size.

IsArrows3d()

bool Prs3d_DimensionAspect::IsArrows3d ( ) const

inline

Gets type of arrows.

IsText3d()

bool Prs3d_DimensionAspect::IsText3d ( ) const

inline

Check if text for dimension label is 3d.

IsTextShaded()

bool Prs3d_DimensionAspect::IsTextShaded ( ) const

inline

Check if 3d text for dimension label is shaded.

IsUnitsDisplayed()

bool Prs3d_DimensionAspect::IsUnitsDisplayed ( ) const

inline

Shows if Units are to be displayed along with dimension value.

LineAspect()

const occ::handle< Prs3d_LineAspect > & Prs3d_DimensionAspect::LineAspect ( ) const

inline

Returns the settings for the display of lines used in presentation of dimensions.

MakeArrows3d()

void Prs3d_DimensionAspect::MakeArrows3d ( const bool theIsArrows3d )

inline

Sets type of arrows.

MakeText3d()

void Prs3d_DimensionAspect::MakeText3d ( const bool isText3d )

inline

Sets type of text.

MakeTextShaded()

void Prs3d_DimensionAspect::MakeTextShaded ( const bool theIsTextShaded )

inline

Turns on/off text shading for 3d text.

MakeUnitsDisplayed()

void Prs3d_DimensionAspect::MakeUnitsDisplayed ( const bool theIsDisplayed )

inline

Specifies whether the units string should be displayed along with value label or not.

SetArrowAspect()

void Prs3d_DimensionAspect::SetArrowAspect ( const occ::handle< Prs3d_ArrowAspect > & theAspect )

inline

Sets the display attributes of arrows used in presentation of dimensions.

SetArrowOrientation()

void Prs3d_DimensionAspect::SetArrowOrientation ( const Prs3d_DimensionArrowOrientation theArrowOrient )

inline

Sets orientation of arrows (external or internal). By default orientation is chosen automatically according to situation and text label size.

SetArrowTailSize()

void Prs3d_DimensionAspect::SetArrowTailSize ( const double theSize )

inline

Set size for arrow tail (extension without text).

SetCommonColor()

void Prs3d_DimensionAspect::SetCommonColor

(

const Quantity_Color &

theColor

)

Sets the same color for all parts of dimension: lines, arrows and text.

SetExtensionSize()

void Prs3d_DimensionAspect::SetExtensionSize ( const double theSize )

inline

Sets extension size.

SetLineAspect()

void Prs3d_DimensionAspect::SetLineAspect ( const occ::handle< Prs3d_LineAspect > & theAspect )

inline

Sets the display attributes of lines used in presentation of dimensions.

SetTextAspect()

void Prs3d_DimensionAspect::SetTextAspect ( const occ::handle< Prs3d_TextAspect > & theAspect )

inline

Sets the display attributes of text used in presentation of dimensions.

SetTextHorizontalPosition()

void Prs3d_DimensionAspect::SetTextHorizontalPosition ( const Prs3d_DimensionTextHorizontalPosition thePosition )

inline

Sets horizontal text alignment for text label.

SetTextVerticalPosition()

void Prs3d_DimensionAspect::SetTextVerticalPosition ( const Prs3d_DimensionTextVerticalPosition thePosition )

inline

Sets vertical text alignment for text label.

SetValueStringFormat()

void Prs3d_DimensionAspect::SetValueStringFormat ( const TCollection_AsciiString & theFormat )

inline

Sets "Sprintf"-syntax format for formatting dimension value labels.

TextAspect()

const occ::handle< Prs3d_TextAspect > & Prs3d_DimensionAspect::TextAspect ( ) const

inline

Returns the settings for the display of text used in presentation of dimensions.

TextHorizontalPosition()

Prs3d_DimensionTextHorizontalPosition Prs3d_DimensionAspect::TextHorizontalPosition ( ) const

inline

Gets horizontal text alignment for text label.

TextVerticalPosition()

Prs3d_DimensionTextVerticalPosition Prs3d_DimensionAspect::TextVerticalPosition ( ) const

inline

Gets vertical text alignment for text label.

ValueStringFormat()

const TCollection_AsciiString & Prs3d_DimensionAspect::ValueStringFormat ( ) const

inline

Returns format.

Field Documentation

myArrowAspect

occ::handle<Prs3d_ArrowAspect> Prs3d_DimensionAspect::myArrowAspect

protected

myArrowOrientation

Prs3d_DimensionArrowOrientation Prs3d_DimensionAspect::myArrowOrientation

protected

myArrowTailSize

double Prs3d_DimensionAspect::myArrowTailSize

protected

myExtensionSize

double Prs3d_DimensionAspect::myExtensionSize

protected

myIsArrows3d

bool Prs3d_DimensionAspect::myIsArrows3d

protected

myIsText3d

bool Prs3d_DimensionAspect::myIsText3d

protected

myIsTextShaded

bool Prs3d_DimensionAspect::myIsTextShaded

protected

myLineAspect

occ::handle<Prs3d_LineAspect> Prs3d_DimensionAspect::myLineAspect

protected

myTextAspect

occ::handle<Prs3d_TextAspect> Prs3d_DimensionAspect::myTextAspect

protected

myTextHPosition

Prs3d_DimensionTextHorizontalPosition Prs3d_DimensionAspect::myTextHPosition

protected

myTextVPosition

Prs3d_DimensionTextVerticalPosition Prs3d_DimensionAspect::myTextVPosition

protected

myToDisplayUnits

bool Prs3d_DimensionAspect::myToDisplayUnits

protected

myValueStringFormat

TCollection_AsciiString Prs3d_DimensionAspect::myValueStringFormat

protected

---

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

• Prs3d_DimensionAspect.hxx