OCC Main Page | DataExchange | Toolkits | Packages | Class Hierarchy | Data Structures | File List | Data Fields | Globals

# DataExchange
TKIGES
IGESGraph

# IGESGraph_TextDisplayTemplate Class Reference

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

`#include <IGESGraph_TextDisplayTemplate.hxx>`

Inheritance diagram for IGESGraph_TextDisplayTemplate:

[legend]

## Public Member Functions
Standard_EXPORT | IGESGraph_TextDisplayTemplate ()
Standard_EXPORT 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 - 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_EXPORT void | SetIncremental (const Standard_Boolean mode)
| Sets <me> to be Incremental (Form 1) if <mode> is True, or Basolute (Form 0) else .
Standard_EXPORT Standard_Boolean | IsIncremental () const
| returns True if entity is Incremental (Form 1). False if entity is Absolute (Form 0).
Standard_EXPORT Standard_Real | BoxWidth () const
| returns Character Box Width.
Standard_EXPORT Standard_Real | BoxHeight () const
| returns Character Box Height.
Standard_EXPORT Standard_Boolean | IsFontEntity () const
| returns False if theFontEntity is Null, True otherwise.
Standard_EXPORT Standard_Integer | FontCode () const
| returns the font code.
Standard_EXPORT Handle_IGESGraph_TextFontDef | FontEntity () const
| returns Text Font Definition Entity used to define the font.
Standard_EXPORT Standard_Real | SlantAngle () const
| returns slant angle of character in radians.
Standard_EXPORT Standard_Real | RotationAngle () const
| returns Rotation angle of text block in radians.
Standard_EXPORT 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_EXPORT Standard_Integer | RotateFlag () const
| returns Rotate internal text flag. Rotate internal text flag : 0 = text horizontal. 1 = text vertical.
Standard_EXPORT 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. .
Standard_EXPORT 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. .
Standard_EXPORT const | Handle (Standard_Type)&DynamicType() const
## Private Attributes
Standard_Real | theBoxWidth
Standard_Real | theBoxHeight
Standard_Integer | theFontCode
Handle_IGESGraph_TextFontDef | theFontEntity
Standard_Real | theSlantAngle
Standard_Real | theRotationAngle
Standard_Integer | theMirrorFlag
Standard_Integer | theRotateFlag
gp_XYZ | theCorner

## Constructor & Destructor Documentation

Standard_EXPORT IGESGraph_TextDisplayTemplate::IGESGraph_TextDisplayTemplate | ( |  | ) |

## Member Function Documentation

Standard_EXPORT Standard_Real IGESGraph_TextDisplayTemplate::BoxHeight | ( |  | ) | const

Standard_EXPORT Standard_Real IGESGraph_TextDisplayTemplate::BoxWidth | ( |  | ) | const

Standard_EXPORT Standard_Integer IGESGraph_TextDisplayTemplate::FontCode | ( |  | ) | const

Standard_EXPORT Handle_IGESGraph_TextFontDef IGESGraph_TextDisplayTemplate::FontEntity | ( |  | ) | const

Standard_EXPORT const IGESGraph_TextDisplayTemplate::Handle | ( | Standard_Type |  | ) | const

| Reimplemented from IGESData_IGESEntity.

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

Standard_EXPORT Standard_Boolean IGESGraph_TextDisplayTemplate::IsFontEntity | ( |  | ) | const

Standard_EXPORT Standard_Boolean IGESGraph_TextDisplayTemplate::IsIncremental | ( |  | ) | const

Standard_EXPORT Standard_Integer IGESGraph_TextDisplayTemplate::MirrorFlag | ( |  | ) | const

Standard_EXPORT Standard_Integer IGESGraph_TextDisplayTemplate::RotateFlag | ( |  | ) | const

Standard_EXPORT Standard_Real IGESGraph_TextDisplayTemplate::RotationAngle | ( |  | ) | const

Standard_EXPORT void IGESGraph_TextDisplayTemplate::SetIncremental | ( | const Standard_Boolean | mode | ) |

Standard_EXPORT Standard_Real IGESGraph_TextDisplayTemplate::SlantAngle | ( |  | ) | const

Standard_EXPORT gp_Pnt IGESGraph_TextDisplayTemplate::StartingCorner | ( |  | ) | const

Standard_EXPORT gp_Pnt IGESGraph_TextDisplayTemplate::TransformedStartingCorner | ( |  | ) | const

## Field Documentation

Standard_Real IGESGraph_TextDisplayTemplate::theBoxHeight`[private]`

Standard_Real IGESGraph_TextDisplayTemplate::theBoxWidth`[private]`

gp_XYZ IGESGraph_TextDisplayTemplate::theCorner`[private]`

Standard_Integer IGESGraph_TextDisplayTemplate::theFontCode`[private]`

Handle_IGESGraph_TextFontDef IGESGraph_TextDisplayTemplate::theFontEntity`[private]`

Standard_Integer IGESGraph_TextDisplayTemplate::theMirrorFlag`[private]`

Standard_Integer IGESGraph_TextDisplayTemplate::theRotateFlag`[private]`

Standard_Real IGESGraph_TextDisplayTemplate::theRotationAngle`[private]`

Standard_Real IGESGraph_TextDisplayTemplate::theSlantAngle`[private]`

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

- IGESGraph_TextDisplayTemplate.hxx