Prs3d_TextAspect Class Reference

Defines the attributes when displaying a text. More...

#include <Prs3d_TextAspect.hxx>

Inheritance diagram for Prs3d_TextAspect:

Public Member Functions
	Prs3d_TextAspect ()
	Constructs an empty framework for defining display attributes of text.
	Prs3d_TextAspect (const Handle< Graphic3d_AspectText3d > &theAspect)
void	SetColor (const Quantity_Color &theColor)
	Sets the color of the type used in text display.
void	SetFont (const Standard_CString theFont)
	Sets the font used in text display.
void	SetHeight (const Standard_Real theHeight)
	Sets the height of the text.
void	SetAngle (const Standard_Real theAngle)
	Sets the angle.
Standard_Real	Height () const
	Returns the height of the text box.
Standard_Real	Angle () const
	Returns the angle.
void	SetHorizontalJustification (const Graphic3d_HorizontalTextAlignment theJustification)
	Sets horizontal alignment of text.
void	SetVerticalJustification (const Graphic3d_VerticalTextAlignment theJustification)
	Sets the vertical alignment of text.
void	SetOrientation (const Graphic3d_TextPath theOrientation)
	Sets the orientation of text.
Graphic3d_HorizontalTextAlignment	HorizontalJustification () const
	Returns the horizontal alignment of the text. The range of values includes:
Graphic3d_VerticalTextAlignment	VerticalJustification () const
	Returns the vertical alignment of the text. The range of values includes:
Graphic3d_TextPath	Orientation () const
	Returns the orientation of the text. Text can be displayed in the following directions:
const Handle< Graphic3d_AspectText3d > &	Aspect () const
	Returns the purely textual attributes used in the display of text. These include:
void	SetAspect (const Handle< Graphic3d_AspectText3d > &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_AspectText3d >	myTextAspect
Standard_Real	myHeight
Graphic3d_HorizontalTextAlignment	myHorizontalJustification
Graphic3d_VerticalTextAlignment	myVerticalJustification
Graphic3d_TextPath	myOrientation

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 displaying a text.

Constructor & Destructor Documentation

Prs3d_TextAspect() [1/2]

Prs3d_TextAspect::Prs3d_TextAspect

(

)

Constructs an empty framework for defining display attributes of text.

Prs3d_TextAspect() [2/2]

Prs3d_TextAspect::Prs3d_TextAspect

(

const Handle< Graphic3d_AspectText3d > &

theAspect

)

Member Function Documentation

Angle()

Standard_Real Prs3d_TextAspect::Angle ( ) const

inline

Returns the angle.

Aspect()

const Handle< Graphic3d_AspectText3d > & Prs3d_TextAspect::Aspect ( ) const

inline

Returns the purely textual attributes used in the display of text. These include:

• color
• font
• height/width ratio, that is, the expansion factor, and
• space between characters.

DumpJson()

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

overridevirtual

Dumps the content of me into the stream.

Implements Prs3d_BasicAspect.

Height()

Standard_Real Prs3d_TextAspect::Height ( ) const

inline

Returns the height of the text box.

HorizontalJustification()

Graphic3d_HorizontalTextAlignment Prs3d_TextAspect::HorizontalJustification ( ) const

inline

Returns the horizontal alignment of the text. The range of values includes:

• left
• center
• right, and
• normal (justified).

Orientation()

Graphic3d_TextPath Prs3d_TextAspect::Orientation ( ) const

inline

Returns the orientation of the text. Text can be displayed in the following directions:

• up
• down
• left, or
• right

SetAngle()

void Prs3d_TextAspect::SetAngle ( const Standard_Real  theAngle )

inline

Sets the angle.

SetAspect()

void Prs3d_TextAspect::SetAspect ( const Handle< Graphic3d_AspectText3d > &  theAspect )

inline

SetColor()

void Prs3d_TextAspect::SetColor ( const Quantity_Color &  theColor )

inline

Sets the color of the type used in text display.

SetFont()

void Prs3d_TextAspect::SetFont ( const Standard_CString  theFont )

inline

Sets the font used in text display.

SetHeight()

void Prs3d_TextAspect::SetHeight ( const Standard_Real  theHeight )

inline

Sets the height of the text.

SetHorizontalJustification()

void Prs3d_TextAspect::SetHorizontalJustification ( const Graphic3d_HorizontalTextAlignment  theJustification )

inline

Sets horizontal alignment of text.

SetOrientation()

void Prs3d_TextAspect::SetOrientation ( const Graphic3d_TextPath  theOrientation )

inline

Sets the orientation of text.

SetVerticalJustification()

void Prs3d_TextAspect::SetVerticalJustification ( const Graphic3d_VerticalTextAlignment  theJustification )

inline

Sets the vertical alignment of text.

VerticalJustification()

Graphic3d_VerticalTextAlignment Prs3d_TextAspect::VerticalJustification ( ) const

inline

Returns the vertical alignment of the text. The range of values includes:

• normal
• top
• cap
• half
• base
• bottom

Field Documentation

myHeight

Standard_Real Prs3d_TextAspect::myHeight

protected

myHorizontalJustification

Graphic3d_HorizontalTextAlignment Prs3d_TextAspect::myHorizontalJustification

protected

myOrientation

Graphic3d_TextPath Prs3d_TextAspect::myOrientation

protected

myTextAspect

Handle< Graphic3d_AspectText3d > Prs3d_TextAspect::myTextAspect

protected

myVerticalJustification

Graphic3d_VerticalTextAlignment Prs3d_TextAspect::myVerticalJustification

protected

---

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

• Prs3d_TextAspect.hxx