Open CASCADE Technology  6.5.4
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions
IGESGraph_TextFontDef Class Reference

defines IGES Text Font Definition Entity, Type <310>
in package IGESGraph

Used to define the appearance of characters in a text font.
It may be used to describe a complete font or a
modification to a subset of characters in another font.

#include <IGESGraph_TextFontDef.hxx>

Inheritance diagram for IGESGraph_TextFontDef:
Inheritance graph
[legend]

Public Member Functions

 IGESGraph_TextFontDef ()
void Init (const Standard_Integer aFontCode, const Handle< TCollection_HAsciiString > &aFontName, const Standard_Integer aSupersededFont, const Handle< IGESGraph_TextFontDef > &aSupersededEntity, const Standard_Integer aScale, const Handle< TColStd_HArray1OfInteger > &allASCIICodes, const Handle< TColStd_HArray1OfInteger > &allNextCharX, const Handle< TColStd_HArray1OfInteger > &allNextCharY, const Handle< TColStd_HArray1OfInteger > &allPenMotions, const Handle< IGESBasic_HArray1OfHArray1OfInteger > &allPenFlags, const Handle< IGESBasic_HArray1OfHArray1OfInteger > &allMovePenToX, const Handle< IGESBasic_HArray1OfHArray1OfInteger > &allMovePenToY)
 This method is used to set the fields of the class
TextFontDef

Standard_Integer FontCode () const
 returns the font code.

Handle_TCollection_HAsciiString FontName () const
 returns the font name.

Standard_Boolean IsSupersededFontEntity () const
 True if this definition supersedes another
TextFontDefinition Entity,
False if it supersedes value.

Standard_Integer SupersededFontCode () const
 returns the font number which this entity modifies.

Handle_IGESGraph_TextFontDef SupersededFontEntity () const
 returns the font entity which this entity modifies.

Standard_Integer Scale () const
 returns the number of grid units which equal one text height unit.

Standard_Integer NbCharacters () const
 returns the number of characters in this definition.

Standard_Integer ASCIICode (const Standard_Integer Chnum) const
 returns the ASCII code of Chnum'th character.
Exception OutOfRange is raised if Chnum <= 0 or Chnum > NbCharacters

void NextCharOrigin (const Standard_Integer Chnum, Standard_Integer &NX, Standard_Integer &NY) const
 returns grid location of origin of character next to Chnum'th char.
Exception OutOfRange is raised if Chnum <= 0 or Chnum > NbCharacters

Standard_Integer NbPenMotions (const Standard_Integer Chnum) const
 returns number of pen motions for Chnum'th character.
Exception OutOfRange is raised if Chnum <= 0 or Chnum > NbCharacters

Standard_Boolean IsPenUp (const Standard_Integer Chnum, const Standard_Integer Motionnum) const
 returns pen status(True if 1, False if 0) of Motionnum'th motion
of Chnum'th character.
Exception raised if Chnum <= 0 or Chnum > NbCharacters or
Motionnum <= 0 or Motionnum > NbPenMotions

void NextPenPosition (const Standard_Integer Chnum, const Standard_Integer Motionnum, Standard_Integer &IX, Standard_Integer &IY) const

Constructor & Destructor Documentation


Member Function Documentation

Handle_TCollection_HAsciiString IGESGraph_TextFontDef::FontName ( ) const
 - aFontCode         : Font Code <br>
 - aFontName         : Font Name <br>
 - aSupersededFont   : Number of superseded font <br>
 - aSupersededEntity : Text Definition Entity <br>
 - aScale            : No. of grid units = 1 text height unit <br>
 - allASCIICodes     : ASCII codes for characters <br>
 - allNextCharX & Y  : Grid locations of the next <br>
                       character's origin (Integer vals) <br>
 - allPenMotions     : No. of pen motions for the characters <br>
 - allPenFlags       : Pen up/down flags, <br>
                       0 = Down (default), 1 = Up <br>
 - allMovePenToX & Y : Grid locations the pen will move to <br>

This method initializes the fields of the class TextFontDef.
An exception is raised if the lengths of allASCIICodes,
allNextChars, allPenMotions, allPenFlags and allMovePenTo
are not same.

Handle_IGESGraph_TextFontDef IGESGraph_TextFontDef::SupersededFontEntity ( ) const

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