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

DataExchange
TKIGES
IGESGraph


IGESGraph_TextFontDef Class Reference

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

#include <IGESGraph_TextFontDef.hxx>

Inheritance diagram for IGESGraph_TextFontDef:

Inheritance graph
[legend]

Public Member Functions

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

Standard_EXPORT Handle_TCollection_HAsciiString FontName () const
 returns the font name.

Standard_EXPORT Standard_Boolean IsSupersededFontEntity () const
 True if this definition supersedes another
TextFontDefinition Entity,
False if it supersedes value.
.
Standard_EXPORT Standard_Integer SupersededFontCode () const
 returns the font number which this entity modifies.

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

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

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

Standard_EXPORT 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

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

Standard_EXPORT void NextPenPosition (const Standard_Integer Chnum, const Standard_Integer Motionnum, Standard_Integer &IX, Standard_Integer &IY) const
Standard_EXPORT const Handle (Standard_Type)&DynamicType() const

Private Attributes

Standard_Integer theFontCode
Handle_TCollection_HAsciiString theFontName
Standard_Integer theSupersededFontCode
Handle_IGESGraph_TextFontDef theSupersededFontEntity
Standard_Integer theScale
Handle_TColStd_HArray1OfInteger theASCIICodes
Handle_TColStd_HArray1OfInteger theNextCharOriginX
Handle_TColStd_HArray1OfInteger theNextCharOriginY
Handle_TColStd_HArray1OfInteger theNbPenMotions
Handle_IGESBasic_HArray1OfHArray1OfInteger thePenMotions
Handle_IGESBasic_HArray1OfHArray1OfInteger thePenMovesToX
Handle_IGESBasic_HArray1OfHArray1OfInteger thePenMovesToY

Constructor & Destructor Documentation

Standard_EXPORT IGESGraph_TextFontDef::IGESGraph_TextFontDef  ) 
 


Member Function Documentation

Standard_EXPORT Standard_Integer IGESGraph_TextFontDef::ASCIICode const Standard_Integer  Chnum  )  const
 

Standard_EXPORT Standard_Integer IGESGraph_TextFontDef::FontCode  )  const
 

Standard_EXPORT Handle_TCollection_HAsciiString IGESGraph_TextFontDef::FontName  )  const
 

Standard_EXPORT const IGESGraph_TextFontDef::Handle Standard_Type   )  const
 

Reimplemented from IGESData_IGESEntity.

Standard_EXPORT void IGESGraph_TextFontDef::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
 

Standard_EXPORT Standard_Boolean IGESGraph_TextFontDef::IsPenUp const Standard_Integer  Chnum,
const Standard_Integer  Motionnum
const
 

Standard_EXPORT Standard_Boolean IGESGraph_TextFontDef::IsSupersededFontEntity  )  const
 

Standard_EXPORT Standard_Integer IGESGraph_TextFontDef::NbCharacters  )  const
 

Standard_EXPORT Standard_Integer IGESGraph_TextFontDef::NbPenMotions const Standard_Integer  Chnum  )  const
 

Standard_EXPORT void IGESGraph_TextFontDef::NextCharOrigin const Standard_Integer  Chnum,
Standard_Integer &  NX,
Standard_Integer &  NY
const
 

Standard_EXPORT void IGESGraph_TextFontDef::NextPenPosition const Standard_Integer  Chnum,
const Standard_Integer  Motionnum,
Standard_Integer &  IX,
Standard_Integer &  IY
const
 

Standard_EXPORT Standard_Integer IGESGraph_TextFontDef::Scale  )  const
 

Standard_EXPORT Standard_Integer IGESGraph_TextFontDef::SupersededFontCode  )  const
 

Standard_EXPORT Handle_IGESGraph_TextFontDef IGESGraph_TextFontDef::SupersededFontEntity  )  const
 


Field Documentation

Handle_TColStd_HArray1OfInteger IGESGraph_TextFontDef::theASCIICodes [private]
 

Standard_Integer IGESGraph_TextFontDef::theFontCode [private]
 

Handle_TCollection_HAsciiString IGESGraph_TextFontDef::theFontName [private]
 

Handle_TColStd_HArray1OfInteger IGESGraph_TextFontDef::theNbPenMotions [private]
 

Handle_TColStd_HArray1OfInteger IGESGraph_TextFontDef::theNextCharOriginX [private]
 

Handle_TColStd_HArray1OfInteger IGESGraph_TextFontDef::theNextCharOriginY [private]
 

Handle_IGESBasic_HArray1OfHArray1OfInteger IGESGraph_TextFontDef::thePenMotions [private]
 

Handle_IGESBasic_HArray1OfHArray1OfInteger IGESGraph_TextFontDef::thePenMovesToX [private]
 

Handle_IGESBasic_HArray1OfHArray1OfInteger IGESGraph_TextFontDef::thePenMovesToY [private]
 

Standard_Integer IGESGraph_TextFontDef::theScale [private]
 

Standard_Integer IGESGraph_TextFontDef::theSupersededFontCode [private]
 

Handle_IGESGraph_TextFontDef IGESGraph_TextFontDef::theSupersededFontEntity [private]
 


The documentation for this class was generated from the following file:
Generated on Mon Aug 25 14:41:04 2008 for OpenCASCADE by  doxygen 1.4.1