Open CASCADE Technology 6.6.0
Public Member Functions
IGESGraph_TextDisplayTemplate Class Reference

defines IGES TextDisplayTemplate Entity,
Type <312>, form <0, 1> in package IGESGraph

Used to set parameters for display of information
which has been logically included in another entity
as a parameter value

#include <IGESGraph_TextDisplayTemplate.hxx>

Inheritance diagram for IGESGraph_TextDisplayTemplate:
Inheritance graph
[legend]

Public Member Functions

 IGESGraph_TextDisplayTemplate ()
void Init (const Standard_Real aWidth, const Standard_Real aHeight, const Standard_Integer aFontCode, const Handle< IGESGraph_TextFontDef > &aFontEntity, const Standard_Real aSlantAngle, const Standard_Real aRotationAngle, const Standard_Integer aMirrorFlag, const Standard_Integer aRotationFlag, const gp_XYZ &aCorner)
 This method is used to set the fields of the class
TextDisplayTemplate

void SetIncremental (const Standard_Boolean mode)
 Sets <me> to be Incremental (Form 1) if <mode> is True,
or Basolute (Form 0) else

Standard_Boolean IsIncremental () const
 returns True if entity is Incremental (Form 1).
False if entity is Absolute (Form 0).

Standard_Real BoxWidth () const
 returns Character Box Width.

Standard_Real BoxHeight () const
 returns Character Box Height.

Standard_Boolean IsFontEntity () const
 returns False if theFontEntity is Null, True otherwise.

Standard_Integer FontCode () const
 returns the font code.

Handle_IGESGraph_TextFontDef FontEntity () const
 returns Text Font Definition Entity used to define the font.

Standard_Real SlantAngle () const
 returns slant angle of character in radians.

Standard_Real RotationAngle () const
 returns Rotation angle of text block in radians.

Standard_Integer MirrorFlag () const
 returns Mirror flag
Mirror flag : 0 = no mirroring.
1 = mirror axis perpendicular to text base line.
2 = mirror axis is text base line.

Standard_Integer RotateFlag () const
 returns Rotate internal text flag.
Rotate internal text flag : 0 = text horizontal.
1 = text vertical.

gp_Pnt StartingCorner () const
 If IsIncremental() returns False,
gets coordinates of lower left corner
of first character box.
If IsIncremental() returns True,
gets increments from X, Y, Z coordinates
found in parent entity.

gp_Pnt TransformedStartingCorner () const
 If IsIncremental() returns False,
gets coordinates of lower left corner
of first character box.
If IsIncremental() returns True,
gets increments from X, Y, Z coordinates
found in parent entity.


Constructor & Destructor Documentation

IGESGraph_TextDisplayTemplate::IGESGraph_TextDisplayTemplate ( )

Member Function Documentation

Standard_Real IGESGraph_TextDisplayTemplate::BoxHeight ( ) const
Standard_Real IGESGraph_TextDisplayTemplate::BoxWidth ( ) const
Standard_Integer IGESGraph_TextDisplayTemplate::FontCode ( ) const
Handle_IGESGraph_TextFontDef IGESGraph_TextDisplayTemplate::FontEntity ( ) const
void IGESGraph_TextDisplayTemplate::Init ( const Standard_Real  aWidth,
const Standard_Real  aHeight,
const Standard_Integer  aFontCode,
const Handle< IGESGraph_TextFontDef > &  aFontEntity,
const Standard_Real  aSlantAngle,
const Standard_Real  aRotationAngle,
const Standard_Integer  aMirrorFlag,
const Standard_Integer  aRotationFlag,
const gp_XYZ aCorner 
)
  • aWidth : Character box width
  • aHeight : Character box height
  • afontCode : Font code
  • aFontEntity : Text Font Definition Entity
  • aSlantAngle : Slant angle
  • aRotationAngle : Rotation angle
  • aMirrorFlag : Mirror Flag
  • aRotationFlag : Rotate internal text flag
  • aCorner : Lower left corner coordinates(Form No. 0),
    Increments from coordinates (Form No. 1)
Standard_Boolean IGESGraph_TextDisplayTemplate::IsFontEntity ( ) const
Standard_Boolean IGESGraph_TextDisplayTemplate::IsIncremental ( ) const
Standard_Integer IGESGraph_TextDisplayTemplate::MirrorFlag ( ) const
Standard_Integer IGESGraph_TextDisplayTemplate::RotateFlag ( ) const
Standard_Real IGESGraph_TextDisplayTemplate::RotationAngle ( ) const
void IGESGraph_TextDisplayTemplate::SetIncremental ( const Standard_Boolean  mode)
Standard_Real IGESGraph_TextDisplayTemplate::SlantAngle ( ) const
gp_Pnt IGESGraph_TextDisplayTemplate::StartingCorner ( ) const
gp_Pnt IGESGraph_TextDisplayTemplate::TransformedStartingCorner ( ) const

The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines