Open CASCADE Technology 6.6.0
Public Member Functions
IGESDimen_GeneralNote Class Reference

defines GeneralNote, Type <212> Form <0-8, 100-200, 105>
in package IGESDimen
Used for formatting boxed text in different ways

#include <IGESDimen_GeneralNote.hxx>

Inheritance diagram for IGESDimen_GeneralNote:
Inheritance graph
[legend]

Public Member Functions

 IGESDimen_GeneralNote ()
void Init (const Handle< TColStd_HArray1OfInteger > &nbChars, const Handle< TColStd_HArray1OfReal > &widths, const Handle< TColStd_HArray1OfReal > &heights, const Handle< TColStd_HArray1OfInteger > &fontCodes, const Handle< IGESGraph_HArray1OfTextFontDef > &fonts, const Handle< TColStd_HArray1OfReal > &slants, const Handle< TColStd_HArray1OfReal > &rotations, const Handle< TColStd_HArray1OfInteger > &mirrorFlags, const Handle< TColStd_HArray1OfInteger > &rotFlags, const Handle< TColgp_HArray1OfXYZ > &start, const Handle< Interface_HArray1OfHAsciiString > &texts)
 This method is used to set the fields of the class
GeneralNote

void SetFormNumber (const Standard_Integer form)
 Changes FormNumber (indicates Graphical Representation)
Error if not in ranges [0-8] or [100-102] or 105

Standard_Integer NbStrings () const
 returns number of text strings in General Note

Standard_Integer NbCharacters (const Standard_Integer Index) const
 returns number of characters of string or zero
raises exception if Index <= 0 or Index > NbStrings()

Standard_Real BoxWidth (const Standard_Integer Index) const
 returns Box width of string
raises exception if Index <= 0 or Index > NbStrings()

Standard_Real BoxHeight (const Standard_Integer Index) const
 returns Box height of string
raises exception if Index <= 0 or Index > NbStrings()

Standard_Boolean IsFontEntity (const Standard_Integer Index) const
 returns False if Value, True if Entity
raises exception if Index <= 0 or Index > NbStrings()

Standard_Integer FontCode (const Standard_Integer Index) const
 returns Font code (default = 1) of string
returns 0 if IsFontEntity () is True
raises exception if Index <= 0 or Index > NbStrings()

Handle_IGESGraph_TextFontDef FontEntity (const Standard_Integer Index) const
 returns Text Font Definition Entity of string
returns a Null Handle if IsFontEntity () returns False
raises exception if Index <= 0 or Index > NbStrings()

Standard_Real SlantAngle (const Standard_Integer Index) const
 returns Slant angle of string in radians
default value = PI/2
raises exception if Index <= 0 or Index > NbStrings()

Standard_Real RotationAngle (const Standard_Integer Index) const
 returns Rotation angle of string in radians
raises exception if Index <= 0 or Index > NbStrings()

Standard_Integer MirrorFlag (const Standard_Integer Index) const
 returns Mirror Flag of string
0 = no mirroring
1 = mirror axis is perpendicular to the text base line
2 = mirror axis is text base line
raises exception if Index <= 0 or Index > NbStrings()

Standard_Integer RotateFlag (const Standard_Integer Index) const
 returns Rotate internal text Flag of string
0 = text horizontal
1 = text vertical
raises exception if Index <= 0 or Index > NbStrings()

gp_Pnt StartPoint (const Standard_Integer Index) const
 returns text start point of Index'th string
raises exception if Index <= 0 or Index > NbStrings()

gp_Pnt TransformedStartPoint (const Standard_Integer Index) const
 returns text start point of Index'th string after Transformation
raises exception if Index <= 0 or Index > NbStrings()

Standard_Real ZDepthStartPoint (const Standard_Integer Index) const
 returns distance from Start Point plane of string
raises exception if Index <= 0 or Index > NbStrings()

Handle_TCollection_HAsciiString Text (const Standard_Integer Index) const
 returns text string
raises exception if Index <= 0 or Index > NbStrings()


Constructor & Destructor Documentation

IGESDimen_GeneralNote::IGESDimen_GeneralNote ( )

Member Function Documentation

Standard_Real IGESDimen_GeneralNote::BoxHeight ( const Standard_Integer  Index) const
Standard_Real IGESDimen_GeneralNote::BoxWidth ( const Standard_Integer  Index) const
Standard_Integer IGESDimen_GeneralNote::FontCode ( const Standard_Integer  Index) const
Handle_IGESGraph_TextFontDef IGESDimen_GeneralNote::FontEntity ( const Standard_Integer  Index) const
void IGESDimen_GeneralNote::Init ( const Handle< TColStd_HArray1OfInteger > &  nbChars,
const Handle< TColStd_HArray1OfReal > &  widths,
const Handle< TColStd_HArray1OfReal > &  heights,
const Handle< TColStd_HArray1OfInteger > &  fontCodes,
const Handle< IGESGraph_HArray1OfTextFontDef > &  fonts,
const Handle< TColStd_HArray1OfReal > &  slants,
const Handle< TColStd_HArray1OfReal > &  rotations,
const Handle< TColStd_HArray1OfInteger > &  mirrorFlags,
const Handle< TColStd_HArray1OfInteger > &  rotFlags,
const Handle< TColgp_HArray1OfXYZ > &  start,
const Handle< Interface_HArray1OfHAsciiString > &  texts 
)
  • nNbChars : number of chars strings
  • widths : Box widths
  • heights : Box heights
  • fontCodes : Font codes, default = 1
  • fonts : Text Font Definition Entities
  • slants : Slant angles in radians
  • rotations : Rotation angles in radians
  • mirrorFlags : Mirror flags
  • rotFlags : Rotation internal text flags
  • start : Text start points
  • texts : Text strings
    raises exception if there is mismatch between the various
    Array Lengths.
Standard_Boolean IGESDimen_GeneralNote::IsFontEntity ( const Standard_Integer  Index) const
Standard_Integer IGESDimen_GeneralNote::MirrorFlag ( const Standard_Integer  Index) const
Standard_Integer IGESDimen_GeneralNote::NbCharacters ( const Standard_Integer  Index) const
Standard_Integer IGESDimen_GeneralNote::NbStrings ( ) const
Standard_Integer IGESDimen_GeneralNote::RotateFlag ( const Standard_Integer  Index) const
Standard_Real IGESDimen_GeneralNote::RotationAngle ( const Standard_Integer  Index) const
void IGESDimen_GeneralNote::SetFormNumber ( const Standard_Integer  form)
Standard_Real IGESDimen_GeneralNote::SlantAngle ( const Standard_Integer  Index) const
gp_Pnt IGESDimen_GeneralNote::StartPoint ( const Standard_Integer  Index) const
Handle_TCollection_HAsciiString IGESDimen_GeneralNote::Text ( const Standard_Integer  Index) const
gp_Pnt IGESDimen_GeneralNote::TransformedStartPoint ( const Standard_Integer  Index) const
Standard_Real IGESDimen_GeneralNote::ZDepthStartPoint ( const Standard_Integer  Index) const

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