Open CASCADE Technology
6.5.4
|
defines NewGeneralNote, Type <213> Form <0>
in package IGESDimen
Further attributes for formatting text strings
#include <IGESDimen_NewGeneralNote.hxx>
Public Member Functions | |
IGESDimen_NewGeneralNote () | |
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 | |
Standard_Real | TextWidth () const |
returns width of text containment area of all strings in the note | |
Standard_Real | TextHeight () const |
returns height of text containment area of all strings in the note | |
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 | |
gp_Pnt | AreaLocation () const |
returns Text containment area Location point | |
gp_Pnt | TransformedAreaLocation () const |
returns Text containment area Location point after Transformation | |
Standard_Real | ZDepthAreaLocation () const |
returns distance from the containment area plane | |
Standard_Real | AreaRotationAngle () const |
returns rotation angle of text containment area in radians | |
gp_Pnt | BaseLinePosition () const |
returns position of first base line | |
gp_Pnt | TransformedBaseLinePosition () const |
returns position of first base line after Transformation | |
Standard_Real | ZDepthBaseLinePosition () const |
returns distance from the Base line position plane | |
Standard_Real | NormalInterlineSpace () const |
returns Normal Interline Spacing | |
Standard_Integer | NbStrings () const |
returns number of text HAsciiStrings | |
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_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_Real | CharacterWidth (const Standard_Integer Index) const |
returns Character Width of string raises exception if Index <= 0 or Index > NbStrings() | |
Standard_Real | CharacterHeight (const Standard_Integer Index) const |
returns Character Height of string raises exception if Index <= 0 or Index > NbStrings() | |
Standard_Real | InterCharacterSpace (const Standard_Integer Index) const |
returns Inter-character spacing of string raises exception if Index <= 0 or Index > NbStrings() | |
Standard_Real | InterlineSpace (const Standard_Integer Index) const |
returns Interline spacing of string raises exception if Index <= 0 or Index > NbStrings() | |
Standard_Integer | FontStyle (const Standard_Integer Index) const |
returns FontStyle of string raises exception if Index <= 0 or Index > NbStrings() | |
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() | |
Handle_TCollection_HAsciiString | ControlCodeString (const Standard_Integer Index) const |
returns ControlCodeString of string raises exception if Index <= 0 or Index > NbStrings() | |
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_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 | IsCharSetEntity (const Standard_Integer Index) const |
returns False if Value, True if Pointer (Entity) raises exception if Index <= 0 or Index > NbStrings() | |
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() | |
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_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_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_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 string raises exception if Index <= 0 or Index > NbStrings() | |
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_Real | ZDepthStartPoint (const Standard_Integer Index) const |
returns distance from the start point plane 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() |
gp_Pnt IGESDimen_NewGeneralNote::AreaLocation | ( | ) | const |
Standard_Real IGESDimen_NewGeneralNote::BoxHeight | ( | const Standard_Integer | Index | ) | const |
Standard_Real IGESDimen_NewGeneralNote::BoxWidth | ( | const Standard_Integer | Index | ) | const |
Handle_IGESData_IGESEntity IGESDimen_NewGeneralNote::CharSetEntity | ( | const Standard_Integer | Index | ) | const |
Handle_TCollection_HAsciiString IGESDimen_NewGeneralNote::ControlCodeString | ( | const Standard_Integer | Index | ) | const |
Standard_Integer IGESDimen_NewGeneralNote::FontStyle | ( | const Standard_Integer | Index | ) | const |
- width : Width of text containment area <br> - height : Height of text containment area <br> - justifyCode : Justification code <br> - areaLoc : Text containment area location <br> - areaRotationAngle : Text containment area rotation <br> - baseLinePos : Base line position <br> - normalInterlineSpace : Normal interline spacing <br> - charDisplays : Character display type <br> - charWidths : Character width <br> - charHeights : Character height <br> - interCharSpc : Intercharacter spacing <br> - interLineSpc : Interline spacing <br> - fontStyles : Font style <br> - charAngles : Character angle <br> - controlCodeStrings : Control Code string <br> - nbChars : Number of characters in string <br> - boxWidths : Box width <br> - boxHeights : Box height <br> - charSetCodes : Character Set Interpretation <br> - charSetEntities : Character Set Font <br> - slAngles : Slant angle of text in radians <br> - rotAngles : Rotation angle of text in radians <br> - mirrorFlags : Type of mirroring <br> - rotateFlags : Rotate internal text flag <br> - startPoints : Text start point <br> - texts : Text strings <br>
raises exception if there is mismatch between the various
Array Lengths.
Standard_Real IGESDimen_NewGeneralNote::SlantAngle | ( | const Standard_Integer | Index | ) | const |
gp_Pnt IGESDimen_NewGeneralNote::StartPoint | ( | const Standard_Integer | Index | ) | const |
Handle_TCollection_HAsciiString IGESDimen_NewGeneralNote::Text | ( | const Standard_Integer | Index | ) | const |