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

#include <Prs3d_DimensionAspect.hxx>

Inheritance diagram for Prs3d_DimensionAspect:

[legend]

Public Member Functions
	Prs3d_DimensionAspect ()
	Constructs an empty framework to define the display of dimensions.

const Handle< Prs3d_LineAspect > &	LineAspect () const
	Returns the settings for the display of lines used in presentation of dimensions.

void	SetLineAspect (const Handle< Prs3d_LineAspect > &theAspect)
	Sets the display attributes of lines used in presentation of dimensions.

const Handle< Prs3d_TextAspect > &	TextAspect () const
	Returns the settings for the display of text used in presentation of dimensions.

void	SetTextAspect (const Handle< Prs3d_TextAspect > &theAspect)
	Sets the display attributes of text used in presentation of dimensions.

Standard_Boolean	IsText3d () const
	Check if text for dimension label is 3d.

void	MakeText3d (const Standard_Boolean isText3d)
	Sets type of text.

Standard_Boolean	IsTextShaded () const
	Check if 3d text for dimension label is shaded.

void	MakeTextShaded (const Standard_Boolean theIsTextShaded)
	Turns on/off text shading for 3d text.

Standard_Boolean	IsArrows3d () const
	Gets type of arrows.

void	MakeArrows3d (const Standard_Boolean theIsArrows3d)
	Sets type of arrows.

Standard_Boolean	IsUnitsDisplayed () const
	Shows if Units are to be displayed along with dimension value.

void	MakeUnitsDisplayed (const Standard_Boolean 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 Handle< Prs3d_ArrowAspect > &	ArrowAspect () const
	Returns the settings for displaying arrows.

void	SetArrowAspect (const 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 Standard_Real theSize)
	Sets extension size.

Standard_Real	ExtensionSize () const
	Returns extension size.

void	SetArrowTailSize (const Standard_Real theSize)
	Set size for arrow tail (extension without text).

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

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.

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

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 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()

Standard_Real Prs3d_DimensionAspect::ArrowTailSize ( ) const

inline

Returns arrow tail size.

◆ DumpJson()

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

overridevirtual

Dumps the content of me into the stream.

Implements Prs3d_BasicAspect.

◆ ExtensionSize()

Standard_Real Prs3d_DimensionAspect::ExtensionSize ( ) const

inline

Returns extension size.

◆ IsArrows3d()

Standard_Boolean Prs3d_DimensionAspect::IsArrows3d ( ) const

inline

Gets type of arrows.

◆ IsText3d()

Standard_Boolean Prs3d_DimensionAspect::IsText3d ( ) const

inline

Check if text for dimension label is 3d.

◆ IsTextShaded()

Standard_Boolean Prs3d_DimensionAspect::IsTextShaded ( ) const

inline

Check if 3d text for dimension label is shaded.

◆ IsUnitsDisplayed()

Standard_Boolean Prs3d_DimensionAspect::IsUnitsDisplayed ( ) const

inline

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

◆ LineAspect()

const 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 Standard_Boolean theIsArrows3d )

inline

Sets type of arrows.

◆ MakeText3d()

void Prs3d_DimensionAspect::MakeText3d ( const Standard_Boolean isText3d )

inline

Sets type of text.

◆ MakeTextShaded()

void Prs3d_DimensionAspect::MakeTextShaded ( const Standard_Boolean theIsTextShaded )

inline

Turns on/off text shading for 3d text.

◆ MakeUnitsDisplayed()

void Prs3d_DimensionAspect::MakeUnitsDisplayed ( const Standard_Boolean theIsDisplayed )

inline

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

◆ SetArrowAspect()

void Prs3d_DimensionAspect::SetArrowAspect ( const 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 Standard_Real 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 Standard_Real theSize )

inline

Sets extension size.

◆ SetLineAspect()

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

inline

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

◆ SetTextAspect()

void Prs3d_DimensionAspect::SetTextAspect ( const 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 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

Handle< Prs3d_ArrowAspect > Prs3d_DimensionAspect::myArrowAspect

protected

◆ myArrowOrientation

Prs3d_DimensionArrowOrientation Prs3d_DimensionAspect::myArrowOrientation

protected

◆ myArrowTailSize

Standard_Real Prs3d_DimensionAspect::myArrowTailSize

protected

◆ myExtensionSize

Standard_Real Prs3d_DimensionAspect::myExtensionSize

protected

◆ myIsArrows3d

Standard_Boolean Prs3d_DimensionAspect::myIsArrows3d

protected

◆ myIsText3d

Standard_Boolean Prs3d_DimensionAspect::myIsText3d

protected

◆ myIsTextShaded

Standard_Boolean Prs3d_DimensionAspect::myIsTextShaded

protected

◆ myLineAspect

Handle< Prs3d_LineAspect > Prs3d_DimensionAspect::myLineAspect

protected

◆ myTextAspect

Handle< Prs3d_TextAspect > Prs3d_DimensionAspect::myTextAspect

protected

◆ myTextHPosition

Prs3d_DimensionTextHorizontalPosition Prs3d_DimensionAspect::myTextHPosition

protected

◆ myTextVPosition

Prs3d_DimensionTextVerticalPosition Prs3d_DimensionAspect::myTextVPosition

protected

◆ myToDisplayUnits

Standard_Boolean 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

Protected Attributes
Handle< Prs3d_LineAspect >	myLineAspect

Handle< Prs3d_TextAspect >	myTextAspect

Handle< Prs3d_ArrowAspect >	myArrowAspect

TCollection_AsciiString	myValueStringFormat

Standard_Real	myExtensionSize

Standard_Real	myArrowTailSize

Prs3d_DimensionArrowOrientation	myArrowOrientation

Prs3d_DimensionTextHorizontalPosition	myTextHPosition

Prs3d_DimensionTextVerticalPosition	myTextVPosition

Standard_Boolean	myToDisplayUnits

Standard_Boolean	myIsText3d

Standard_Boolean	myIsTextShaded

Standard_Boolean	myIsArrows3d

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Prs3d_DimensionAspect()

Member Function Documentation

◆ ArrowAspect()

◆ ArrowOrientation()

◆ ArrowTailSize()

◆ DumpJson()

◆ ExtensionSize()

◆ IsArrows3d()

◆ IsText3d()

◆ IsTextShaded()

◆ IsUnitsDisplayed()

◆ LineAspect()

◆ MakeArrows3d()

◆ MakeText3d()

◆ MakeTextShaded()

◆ MakeUnitsDisplayed()

◆ SetArrowAspect()

◆ SetArrowOrientation()

◆ SetArrowTailSize()

◆ SetCommonColor()

◆ SetExtensionSize()

◆ SetLineAspect()

◆ SetTextAspect()

◆ SetTextHorizontalPosition()

◆ SetTextVerticalPosition()

◆ SetValueStringFormat()

◆ TextAspect()

◆ TextHorizontalPosition()

◆ TextVerticalPosition()

◆ ValueStringFormat()

Field Documentation

◆ myArrowAspect

◆ myArrowOrientation

◆ myArrowTailSize

◆ myExtensionSize

◆ myIsArrows3d

◆ myIsText3d

◆ myIsTextShaded

◆ myLineAspect

◆ myTextAspect

◆ myTextHPosition

◆ myTextVPosition

◆ myToDisplayUnits

◆ myValueStringFormat