Open CASCADE Technology  7.0.0
Public Member Functions
Prs3d_TextAspect Class Reference

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

#include <Prs3d_TextAspect.hxx>

Inheritance diagram for Prs3d_TextAspect:
Inheritance graph
[legend]

Public Member Functions

 Prs3d_TextAspect ()
 Constructs an empty framework for defining display attributes of text. More...
 
 Prs3d_TextAspect (const Handle< Graphic3d_AspectText3d > &theAspect)
 
void SetColor (const Quantity_Color &aColor)
 
void SetColor (const Quantity_NameOfColor aColor)
 Sets the color of the type used in text display. More...
 
void SetFont (const Standard_CString aFont)
 Sets the font used in text display. More...
 
void SetHeightWidthRatio (const Standard_Real aRatio)
 Returns the height-width ratio, also known as the expansion factor. More...
 
void SetSpace (const Quantity_Length aSpace)
 Sets the length of the box which text will occupy. More...
 
void SetHeight (const Standard_Real aHeight)
 Sets the height of the text. More...
 
void SetAngle (const Quantity_PlaneAngle anAngle)
 Sets the angle. More...
 
Standard_Real Height () const
 Returns the height of the text box. More...
 
Quantity_PlaneAngle Angle () const
 Returns the angle. More...
 
void SetHorizontalJustification (const Graphic3d_HorizontalTextAlignment aJustification)
 Sets horizontal alignment of text. More...
 
void SetVerticalJustification (const Graphic3d_VerticalTextAlignment aJustification)
 Sets the vertical alignment of text. More...
 
void SetOrientation (const Graphic3d_TextPath anOrientation)
 Sets the orientation of text. More...
 
Graphic3d_HorizontalTextAlignment HorizontalJustification () const
 Returns the horizontal alignment of the text. The range of values includes: More...
 
Graphic3d_VerticalTextAlignment VerticalJustification () const
 Returns the vertical alignment of the text. The range of values includes: More...
 
Graphic3d_TextPath Orientation () const
 Returns the orientation of the text. Text can be displayed in the following directions: More...
 
Handle< Graphic3d_AspectText3dAspect () const
 Returns the purely textual attributes used in the display of text. These include: More...
 
void SetAspect (const Handle< Graphic3d_AspectText3d > &theAspect)
 
- Public Member Functions inherited from MMgt_TShared
virtual void Delete () const override
 Memory deallocator for transient classes. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
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. More...
 
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. More...
 
Standard_TransientThis () 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. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 
- Static Public Member Functions inherited from Standard_Transient
static const char * get_type_name ()
 Returns a type descriptor about this object. More...
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class. More...
 

Detailed Description

Defines the attributes when displaying a text.

Constructor & Destructor Documentation

Prs3d_TextAspect::Prs3d_TextAspect ( )

Constructs an empty framework for defining display attributes of text.

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

Member Function Documentation

Quantity_PlaneAngle Prs3d_TextAspect::Angle ( ) const

Returns the angle.

Handle< Graphic3d_AspectText3d > Prs3d_TextAspect::Aspect ( ) const

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.
Standard_Real Prs3d_TextAspect::Height ( ) const

Returns the height of the text box.

Graphic3d_HorizontalTextAlignment Prs3d_TextAspect::HorizontalJustification ( ) const

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

  • left
  • center
  • right, and
  • normal (justified).
Graphic3d_TextPath Prs3d_TextAspect::Orientation ( ) const

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

  • up
  • down
  • left, or
  • right
void Prs3d_TextAspect::SetAngle ( const Quantity_PlaneAngle  anAngle)

Sets the angle.

void Prs3d_TextAspect::SetAspect ( const Handle< Graphic3d_AspectText3d > &  theAspect)
void Prs3d_TextAspect::SetColor ( const Quantity_Color aColor)
void Prs3d_TextAspect::SetColor ( const Quantity_NameOfColor  aColor)

Sets the color of the type used in text display.

void Prs3d_TextAspect::SetFont ( const Standard_CString  aFont)

Sets the font used in text display.

void Prs3d_TextAspect::SetHeight ( const Standard_Real  aHeight)

Sets the height of the text.

void Prs3d_TextAspect::SetHeightWidthRatio ( const Standard_Real  aRatio)

Returns the height-width ratio, also known as the expansion factor.

void Prs3d_TextAspect::SetHorizontalJustification ( const Graphic3d_HorizontalTextAlignment  aJustification)

Sets horizontal alignment of text.

void Prs3d_TextAspect::SetOrientation ( const Graphic3d_TextPath  anOrientation)

Sets the orientation of text.

void Prs3d_TextAspect::SetSpace ( const Quantity_Length  aSpace)

Sets the length of the box which text will occupy.

void Prs3d_TextAspect::SetVerticalJustification ( const Graphic3d_VerticalTextAlignment  aJustification)

Sets the vertical alignment of text.

Graphic3d_VerticalTextAlignment Prs3d_TextAspect::VerticalJustification ( ) const

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

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

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