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

DataExchange
TKIGES
IGESDimen


IGESDimen_NewGeneralNote Class Reference

defines NewGeneralNote, Type <213> Form <0>
in package IGESDimen
Further attributes for formatting text strings

#include <IGESDimen_NewGeneralNote.hxx>

Inheritance diagram for IGESDimen_NewGeneralNote:

Inheritance graph
[legend]

Public Member Functions

Standard_EXPORT IGESDimen_NewGeneralNote ()
Standard_EXPORT void Init (const Standard_Real width, const Standard_Real height, const Standard_Integer justifyCode, const gp_XYZ &areaLoc, const Standard_Real areaRotationAngle, const gp_XYZ &baseLinePos, const Standard_Real normalInterlineSpace, const Handle(TColStd_HArray1OfInteger)&charDisplays, const Handle(TColStd_HArray1OfReal)&charWidths, const Handle(TColStd_HArray1OfReal)&charHeights, const Handle(TColStd_HArray1OfReal)&interCharSpc, const Handle(TColStd_HArray1OfReal)&interLineSpc, const Handle(TColStd_HArray1OfInteger)&fontStyles, const Handle(TColStd_HArray1OfReal)&charAngles, const Handle(Interface_HArray1OfHAsciiString)&controlCodeStrings, const Handle(TColStd_HArray1OfInteger)&nbChars, const Handle(TColStd_HArray1OfReal)&boxWidths, const Handle(TColStd_HArray1OfReal)&boxHeights, const Handle(TColStd_HArray1OfInteger)&charSetCodes, const Handle(IGESData_HArray1OfIGESEntity)&charSetEntities, const Handle(TColStd_HArray1OfReal)&slAngles, const Handle(TColStd_HArray1OfReal)&rotAngles, const Handle(TColStd_HArray1OfInteger)&mirrorFlags, const Handle(TColStd_HArray1OfInteger)&rotateFlags, const Handle(TColgp_HArray1OfXYZ)&startPoints, const Handle(Interface_HArray1OfHAsciiString)&texts)
 This method is used to set the fields of the class
NewGeneralNote
- width : Width of text containment area
- height : Height of text containment area
- justifyCode : Justification code
- areaLoc : Text containment area location
- areaRotationAngle : Text containment area rotation
- baseLinePos : Base line position
- normalInterlineSpace : Normal interline spacing
- charDisplays : Character display type
- charWidths : Character width
- charHeights : Character height
- interCharSpc : Intercharacter spacing
- interLineSpc : Interline spacing
- fontStyles : Font style
- charAngles : Character angle
- controlCodeStrings : Control Code string
- nbChars : Number of characters in string
- boxWidths : Box width
- boxHeights : Box height
- charSetCodes : Character Set Interpretation
- charSetEntities : Character Set Font
- slAngles : Slant angle of text in radians
- rotAngles : Rotation angle of text in radians
- mirrorFlags : Type of mirroring
- rotateFlags : Rotate internal text flag
- startPoints : Text start point
- texts : Text strings
raises exception if there is mismatch between the various
Array Lengths.
.
Standard_EXPORT Standard_Real TextWidth () const
 returns width of text containment area of all strings in the note

Standard_EXPORT Standard_Real TextHeight () const
 returns height of text containment area of all strings in the note

Standard_EXPORT Standard_Integer JustifyCode () const
 returns Justification code of all strings within the note
0 = no justification
1 = right justified
2 = center justified
3 = left justified

Standard_EXPORT gp_Pnt AreaLocation () const
 returns Text containment area Location point

Standard_EXPORT gp_Pnt TransformedAreaLocation () const
 returns Text containment area Location point after Transformation

Standard_EXPORT Standard_Real ZDepthAreaLocation () const
 returns distance from the containment area plane

Standard_EXPORT Standard_Real AreaRotationAngle () const
 returns rotation angle of text containment area in radians

Standard_EXPORT gp_Pnt BaseLinePosition () const
 returns position of first base line

Standard_EXPORT gp_Pnt TransformedBaseLinePosition () const
 returns position of first base line after Transformation

Standard_EXPORT Standard_Real ZDepthBaseLinePosition () const
 returns distance from the Base line position plane

Standard_EXPORT Standard_Real NormalInterlineSpace () const
 returns Normal Interline Spacing

Standard_EXPORT Standard_Integer NbStrings () const
 returns number of text HAsciiStrings

Standard_EXPORT Standard_Integer CharacterDisplay (const Standard_Integer Index) const
 returns Fixed/Variable width character display of string
0 = Fixed
1 = Variable
raises exception if Index <= 0 or Index > NbStrings()

Standard_EXPORT Standard_Boolean IsVariable (const Standard_Integer Index) const
 returns False if Character display width is Fixed
optional method, if required
raises exception if Index <= 0 or Index > NbStrings()

Standard_EXPORT Standard_Real CharacterWidth (const Standard_Integer Index) const
 returns Character Width of string
raises exception if Index <= 0 or Index > NbStrings()

Standard_EXPORT Standard_Real CharacterHeight (const Standard_Integer Index) const
 returns Character Height of string
raises exception if Index <= 0 or Index > NbStrings()

Standard_EXPORT Standard_Real InterCharacterSpace (const Standard_Integer Index) const
 returns Inter-character spacing of string
raises exception if Index <= 0 or Index > NbStrings()

Standard_EXPORT Standard_Real InterlineSpace (const Standard_Integer Index) const
 returns Interline spacing of string
raises exception if Index <= 0 or Index > NbStrings()

Standard_EXPORT Standard_Integer FontStyle (const Standard_Integer Index) const
 returns FontStyle of string
raises exception if Index <= 0 or Index > NbStrings()

Standard_EXPORT Standard_Real CharacterAngle (const Standard_Integer Index) const
 returns CharacterAngle of string
Angle returned will be between 0 and 2PI
raises exception if Index <= 0 or Index > NbStrings()

Standard_EXPORT Handle_TCollection_HAsciiString ControlCodeString (const Standard_Integer Index) const
 returns ControlCodeString of string
raises exception if Index <= 0 or Index > NbStrings()

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

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

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

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

Standard_EXPORT Standard_Integer CharSetCode (const Standard_Integer Index) const
 returns Character Set Interpretation (default = 1) of string
returns 0 if IsCharSetEntity () is True
1 = Standard ASCII
1001 = Symbol Font1
1002 = Symbol Font2
1003 = Symbol Font3
raises exception if Index <= 0 or Index > NbStrings()

Standard_EXPORT Handle_IGESData_IGESEntity CharSetEntity (const Standard_Integer Index) const
 returns Character Set Interpretation of string
returns a Null Handle if IsCharSetEntity () is False
raises exception if Index <= 0 or Index > NbStrings()

Standard_EXPORT 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_EXPORT Standard_Real RotationAngle (const Standard_Integer Index) const
 returns Rotation angle of string in radians
raises exception if Index <= 0 or Index > NbStrings()

Standard_EXPORT 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_EXPORT Standard_Boolean IsMirrored (const Standard_Integer Index) const
 returns False if MirrorFlag = 0. ie. no mirroring
else returns True
raises exception if Index <= 0 or Index > NbStrings()

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

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

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

Standard_EXPORT Standard_Real ZDepthStartPoint (const Standard_Integer Index) const
 returns distance from the start point plane
raises exception if Index <= 0 or Index > NbStrings()

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

Standard_EXPORT const Handle (Standard_Type)&DynamicType() const

Private Attributes

Standard_Real theWidth
Standard_Real theHeight
Standard_Integer theJustifyCode
gp_XYZ theAreaLoc
Standard_Real theAreaRotationAngle
gp_XYZ theBaseLinePos
Standard_Real theNormalInterlineSpace
Handle_TColStd_HArray1OfInteger theCharDisplays
Handle_TColStd_HArray1OfReal theCharWidths
Handle_TColStd_HArray1OfReal theCharHeights
Handle_TColStd_HArray1OfReal theInterCharSpaces
Handle_TColStd_HArray1OfReal theInterlineSpaces
Handle_TColStd_HArray1OfInteger theFontStyles
Handle_TColStd_HArray1OfReal theCharAngles
Handle_Interface_HArray1OfHAsciiString theControlCodeStrings
Handle_TColStd_HArray1OfInteger theNbChars
Handle_TColStd_HArray1OfReal theBoxWidths
Handle_TColStd_HArray1OfReal theBoxHeights
Handle_TColStd_HArray1OfInteger theCharSetCodes
Handle_IGESData_HArray1OfIGESEntity theCharSetEntities
Handle_TColStd_HArray1OfReal theSlantAngles
Handle_TColStd_HArray1OfReal theRotationAngles
Handle_TColStd_HArray1OfInteger theMirrorFlags
Handle_TColStd_HArray1OfInteger theRotateFlags
Handle_TColgp_HArray1OfXYZ theStartPoints
Handle_Interface_HArray1OfHAsciiString theTexts

Constructor & Destructor Documentation

Standard_EXPORT IGESDimen_NewGeneralNote::IGESDimen_NewGeneralNote  ) 
 


Member Function Documentation

Standard_EXPORT gp_Pnt IGESDimen_NewGeneralNote::AreaLocation  )  const
 

Standard_EXPORT Standard_Real IGESDimen_NewGeneralNote::AreaRotationAngle  )  const
 

Standard_EXPORT gp_Pnt IGESDimen_NewGeneralNote::BaseLinePosition  )  const
 

Standard_EXPORT Standard_Real IGESDimen_NewGeneralNote::BoxHeight const Standard_Integer  Index  )  const
 

Standard_EXPORT Standard_Real IGESDimen_NewGeneralNote::BoxWidth const Standard_Integer  Index  )  const
 

Standard_EXPORT Standard_Real IGESDimen_NewGeneralNote::CharacterAngle const Standard_Integer  Index  )  const
 

Standard_EXPORT Standard_Integer IGESDimen_NewGeneralNote::CharacterDisplay const Standard_Integer  Index  )  const
 

Standard_EXPORT Standard_Real IGESDimen_NewGeneralNote::CharacterHeight const Standard_Integer  Index  )  const
 

Standard_EXPORT Standard_Real IGESDimen_NewGeneralNote::CharacterWidth const Standard_Integer  Index  )  const
 

Standard_EXPORT Standard_Integer IGESDimen_NewGeneralNote::CharSetCode const Standard_Integer  Index  )  const
 

Standard_EXPORT Handle_IGESData_IGESEntity IGESDimen_NewGeneralNote::CharSetEntity const Standard_Integer  Index  )  const
 

Standard_EXPORT Handle_TCollection_HAsciiString IGESDimen_NewGeneralNote::ControlCodeString const Standard_Integer  Index  )  const
 

Standard_EXPORT Standard_Integer IGESDimen_NewGeneralNote::FontStyle const Standard_Integer  Index  )  const
 

Standard_EXPORT const IGESDimen_NewGeneralNote::Handle Standard_Type   )  const
 

Reimplemented from IGESData_IGESEntity.

Standard_EXPORT void IGESDimen_NewGeneralNote::Init const Standard_Real  width,
const Standard_Real  height,
const Standard_Integer  justifyCode,
const gp_XYZ &  areaLoc,
const Standard_Real  areaRotationAngle,
const gp_XYZ &  baseLinePos,
const Standard_Real  normalInterlineSpace,
const Handle(TColStd_HArray1OfInteger)&  charDisplays,
const Handle(TColStd_HArray1OfReal)&  charWidths,
const Handle(TColStd_HArray1OfReal)&  charHeights,
const Handle(TColStd_HArray1OfReal)&  interCharSpc,
const Handle(TColStd_HArray1OfReal)&  interLineSpc,
const Handle(TColStd_HArray1OfInteger)&  fontStyles,
const Handle(TColStd_HArray1OfReal)&  charAngles,
const Handle(Interface_HArray1OfHAsciiString)&  controlCodeStrings,
const Handle(TColStd_HArray1OfInteger)&  nbChars,
const Handle(TColStd_HArray1OfReal)&  boxWidths,
const Handle(TColStd_HArray1OfReal)&  boxHeights,
const Handle(TColStd_HArray1OfInteger)&  charSetCodes,
const Handle(IGESData_HArray1OfIGESEntity)&  charSetEntities,
const Handle(TColStd_HArray1OfReal)&  slAngles,
const Handle(TColStd_HArray1OfReal)&  rotAngles,
const Handle(TColStd_HArray1OfInteger)&  mirrorFlags,
const Handle(TColStd_HArray1OfInteger)&  rotateFlags,
const Handle(TColgp_HArray1OfXYZ)&  startPoints,
const Handle(Interface_HArray1OfHAsciiString)&  texts
 

Standard_EXPORT Standard_Real IGESDimen_NewGeneralNote::InterCharacterSpace const Standard_Integer  Index  )  const
 

Standard_EXPORT Standard_Real IGESDimen_NewGeneralNote::InterlineSpace const Standard_Integer  Index  )  const
 

Standard_EXPORT Standard_Boolean IGESDimen_NewGeneralNote::IsCharSetEntity const Standard_Integer  Index  )  const
 

Standard_EXPORT Standard_Boolean IGESDimen_NewGeneralNote::IsMirrored const Standard_Integer  Index  )  const
 

Standard_EXPORT Standard_Boolean IGESDimen_NewGeneralNote::IsVariable const Standard_Integer  Index  )  const
 

Standard_EXPORT Standard_Integer IGESDimen_NewGeneralNote::JustifyCode  )  const
 

Standard_EXPORT Standard_Integer IGESDimen_NewGeneralNote::MirrorFlag const Standard_Integer  Index  )  const
 

Standard_EXPORT Standard_Integer IGESDimen_NewGeneralNote::NbCharacters const Standard_Integer  Index  )  const
 

Standard_EXPORT Standard_Integer IGESDimen_NewGeneralNote::NbStrings  )  const
 

Standard_EXPORT Standard_Real IGESDimen_NewGeneralNote::NormalInterlineSpace  )  const
 

Standard_EXPORT Standard_Integer IGESDimen_NewGeneralNote::RotateFlag const Standard_Integer  Index  )  const
 

Standard_EXPORT Standard_Real IGESDimen_NewGeneralNote::RotationAngle const Standard_Integer  Index  )  const
 

Standard_EXPORT Standard_Real IGESDimen_NewGeneralNote::SlantAngle const Standard_Integer  Index  )  const
 

Standard_EXPORT gp_Pnt IGESDimen_NewGeneralNote::StartPoint const Standard_Integer  Index  )  const
 

Standard_EXPORT Handle_TCollection_HAsciiString IGESDimen_NewGeneralNote::Text const Standard_Integer  Index  )  const
 

Standard_EXPORT Standard_Real IGESDimen_NewGeneralNote::TextHeight  )  const
 

Standard_EXPORT Standard_Real IGESDimen_NewGeneralNote::TextWidth  )  const
 

Standard_EXPORT gp_Pnt IGESDimen_NewGeneralNote::TransformedAreaLocation  )  const
 

Standard_EXPORT gp_Pnt IGESDimen_NewGeneralNote::TransformedBaseLinePosition  )  const
 

Standard_EXPORT gp_Pnt IGESDimen_NewGeneralNote::TransformedStartPoint const Standard_Integer  Index  )  const
 

Standard_EXPORT Standard_Real IGESDimen_NewGeneralNote::ZDepthAreaLocation  )  const
 

Standard_EXPORT Standard_Real IGESDimen_NewGeneralNote::ZDepthBaseLinePosition  )  const
 

Standard_EXPORT Standard_Real IGESDimen_NewGeneralNote::ZDepthStartPoint const Standard_Integer  Index  )  const
 


Field Documentation

gp_XYZ IGESDimen_NewGeneralNote::theAreaLoc [private]
 

Standard_Real IGESDimen_NewGeneralNote::theAreaRotationAngle [private]
 

gp_XYZ IGESDimen_NewGeneralNote::theBaseLinePos [private]
 

Handle_TColStd_HArray1OfReal IGESDimen_NewGeneralNote::theBoxHeights [private]
 

Handle_TColStd_HArray1OfReal IGESDimen_NewGeneralNote::theBoxWidths [private]
 

Handle_TColStd_HArray1OfReal IGESDimen_NewGeneralNote::theCharAngles [private]
 

Handle_TColStd_HArray1OfInteger IGESDimen_NewGeneralNote::theCharDisplays [private]
 

Handle_TColStd_HArray1OfReal IGESDimen_NewGeneralNote::theCharHeights [private]
 

Handle_TColStd_HArray1OfInteger IGESDimen_NewGeneralNote::theCharSetCodes [private]
 

Handle_IGESData_HArray1OfIGESEntity IGESDimen_NewGeneralNote::theCharSetEntities [private]
 

Handle_TColStd_HArray1OfReal IGESDimen_NewGeneralNote::theCharWidths [private]
 

Handle_Interface_HArray1OfHAsciiString IGESDimen_NewGeneralNote::theControlCodeStrings [private]
 

Handle_TColStd_HArray1OfInteger IGESDimen_NewGeneralNote::theFontStyles [private]
 

Standard_Real IGESDimen_NewGeneralNote::theHeight [private]
 

Handle_TColStd_HArray1OfReal IGESDimen_NewGeneralNote::theInterCharSpaces [private]
 

Handle_TColStd_HArray1OfReal IGESDimen_NewGeneralNote::theInterlineSpaces [private]
 

Standard_Integer IGESDimen_NewGeneralNote::theJustifyCode [private]
 

Handle_TColStd_HArray1OfInteger IGESDimen_NewGeneralNote::theMirrorFlags [private]
 

Handle_TColStd_HArray1OfInteger IGESDimen_NewGeneralNote::theNbChars [private]
 

Standard_Real IGESDimen_NewGeneralNote::theNormalInterlineSpace [private]
 

Handle_TColStd_HArray1OfInteger IGESDimen_NewGeneralNote::theRotateFlags [private]
 

Handle_TColStd_HArray1OfReal IGESDimen_NewGeneralNote::theRotationAngles [private]
 

Handle_TColStd_HArray1OfReal IGESDimen_NewGeneralNote::theSlantAngles [private]
 

Handle_TColgp_HArray1OfXYZ IGESDimen_NewGeneralNote::theStartPoints [private]
 

Handle_Interface_HArray1OfHAsciiString IGESDimen_NewGeneralNote::theTexts [private]
 

Standard_Real IGESDimen_NewGeneralNote::theWidth [private]
 


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