Prs3d_TextAspect Class Reference

Defines the attributes when displaying a text.

#include <Prs3d_TextAspect.hxx>

Inheritance diagram for Prs3d_TextAspect:

Public Member Functions
	Prs3d_TextAspect ()
	Constructs an empty framework for defining display attributes of text.
void	SetColor (const Quantity_Color &aColor)
void	SetColor (const Quantity_NameOfColor aColor)
	Sets the color of the type used in text display.
void	SetFont (const Standard_CString aFont)
	Sets the font used in text display.
void	SetHeightWidthRatio (const Standard_Real aRatio)
	Returns the height-width ratio, also known as the expansion factor.
void	SetSpace (const Quantity_Length aSpace)
	Sets the length of the box which text will occupy.
void	SetHeight (const Standard_Real aHeight)
	Sets the height of the text.
void	SetAngle (const Quantity_PlaneAngle anAngle)
	Sets the angle
Standard_Real	Height () const
	Returns the height of the text box.
Quantity_PlaneAngle	Angle () const
	Returns the angle
void	SetHorizontalJustification (const Graphic3d_HorizontalTextAlignment aJustification)
	Sets horizontal alignment of text.
void	SetVerticalJustification (const Graphic3d_VerticalTextAlignment aJustification)
	Sets the vertical alignment of text.
void	SetOrientation (const Graphic3d_TextPath anOrientation)
	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:
Handle_Graphic3d_AspectText3d	Aspect () const
	Returns the purely textual attributes used in the display of text. These include:

---

Constructor & Destructor Documentation

Prs3d_TextAspect::Prs3d_TextAspect

(

)

---

Member Function Documentation

Quantity_PlaneAngle Prs3d_TextAspect::Angle

(

)

const

Handle_Graphic3d_AspectText3d Prs3d_TextAspect::Aspect

(

)

const

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

Standard_Real Prs3d_TextAspect::Height

(

)

const

Graphic3d_HorizontalTextAlignment Prs3d_TextAspect::HorizontalJustification

(

)

const

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

Graphic3d_TextPath Prs3d_TextAspect::Orientation

(

)

const

• up
  
• down
  
• left, or
  
• right
  

void Prs3d_TextAspect::SetAngle

(

const Quantity_PlaneAngle

anAngle

)

void Prs3d_TextAspect::SetColor

(

const Quantity_Color &

aColor

)

void Prs3d_TextAspect::SetColor

(

const Quantity_NameOfColor

aColor

)

void Prs3d_TextAspect::SetFont

(

const Standard_CString

aFont

)

void Prs3d_TextAspect::SetHeight

(

const Standard_Real

aHeight

)

void Prs3d_TextAspect::SetHeightWidthRatio

(

const Standard_Real

aRatio

)

void Prs3d_TextAspect::SetHorizontalJustification

(

const Graphic3d_HorizontalTextAlignment

aJustification

)

void Prs3d_TextAspect::SetOrientation

(

const Graphic3d_TextPath

anOrientation

)

void Prs3d_TextAspect::SetSpace

(

const Quantity_Length

aSpace

)

void Prs3d_TextAspect::SetVerticalJustification

(

const Graphic3d_VerticalTextAlignment

aJustification

)

Graphic3d_VerticalTextAlignment Prs3d_TextAspect::VerticalJustification

(

)

const

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

---

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

• Prs3d_TextAspect.hxx