summaryrefslogtreecommitdiff
path: root/inc/IGESDimen_NewGeneralNote.hxx
blob: 8fe2ef0ca87c4b65a93aa7ec072a081aad8c5aaa (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
// This file is generated by WOK (CPPExt).
// Please do not edit this file; modify original file instead.
// The copyright and license terms as defined for the original file apply to 
// this header file considered to be the "object code" form of the original source.

#ifndef _IGESDimen_NewGeneralNote_HeaderFile
#define _IGESDimen_NewGeneralNote_HeaderFile

#ifndef _Standard_HeaderFile
#include <Standard.hxx>
#endif
#ifndef _Standard_DefineHandle_HeaderFile
#include <Standard_DefineHandle.hxx>
#endif
#ifndef _Handle_IGESDimen_NewGeneralNote_HeaderFile
#include <Handle_IGESDimen_NewGeneralNote.hxx>
#endif

#ifndef _Standard_Real_HeaderFile
#include <Standard_Real.hxx>
#endif
#ifndef _Standard_Integer_HeaderFile
#include <Standard_Integer.hxx>
#endif
#ifndef _gp_XYZ_HeaderFile
#include <gp_XYZ.hxx>
#endif
#ifndef _Handle_TColStd_HArray1OfInteger_HeaderFile
#include <Handle_TColStd_HArray1OfInteger.hxx>
#endif
#ifndef _Handle_TColStd_HArray1OfReal_HeaderFile
#include <Handle_TColStd_HArray1OfReal.hxx>
#endif
#ifndef _Handle_Interface_HArray1OfHAsciiString_HeaderFile
#include <Handle_Interface_HArray1OfHAsciiString.hxx>
#endif
#ifndef _Handle_IGESData_HArray1OfIGESEntity_HeaderFile
#include <Handle_IGESData_HArray1OfIGESEntity.hxx>
#endif
#ifndef _Handle_TColgp_HArray1OfXYZ_HeaderFile
#include <Handle_TColgp_HArray1OfXYZ.hxx>
#endif
#ifndef _IGESData_IGESEntity_HeaderFile
#include <IGESData_IGESEntity.hxx>
#endif
#ifndef _Standard_Boolean_HeaderFile
#include <Standard_Boolean.hxx>
#endif
#ifndef _Handle_TCollection_HAsciiString_HeaderFile
#include <Handle_TCollection_HAsciiString.hxx>
#endif
#ifndef _Handle_IGESData_IGESEntity_HeaderFile
#include <Handle_IGESData_IGESEntity.hxx>
#endif
class TColStd_HArray1OfInteger;
class TColStd_HArray1OfReal;
class Interface_HArray1OfHAsciiString;
class IGESData_HArray1OfIGESEntity;
class TColgp_HArray1OfXYZ;
class Standard_DimensionMismatch;
class Standard_OutOfRange;
class gp_XYZ;
class gp_Pnt;
class TCollection_HAsciiString;
class IGESData_IGESEntity;


//! defines NewGeneralNote, Type <213> Form <0> <br>
//!          in package IGESDimen <br>
//!          Further attributes for formatting text strings <br>
class IGESDimen_NewGeneralNote : public IGESData_IGESEntity {

public:

  
  Standard_EXPORT   IGESDimen_NewGeneralNote();
  //! This method is used to set the fields of the class <br>
//!           NewGeneralNote <br>
//!       - 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 <br>
//! Array Lengths. <br>
  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) ;
  //! returns width of text containment area of all strings in the note <br>
  Standard_EXPORT     Standard_Real TextWidth() const;
  //! returns height of text containment area of all strings in the note <br>
  Standard_EXPORT     Standard_Real TextHeight() const;
  //! returns Justification code of all strings within the note <br>
//!      0 = no justification <br>
//!      1 = right justified <br>
//!      2 = center justified <br>
//!      3 = left justified <br>
  Standard_EXPORT     Standard_Integer JustifyCode() const;
  //! returns Text containment area Location point <br>
  Standard_EXPORT     gp_Pnt AreaLocation() const;
  //! returns Text containment area Location point after Transformation <br>
  Standard_EXPORT     gp_Pnt TransformedAreaLocation() const;
  //! returns distance from the containment area plane <br>
  Standard_EXPORT     Standard_Real ZDepthAreaLocation() const;
  //! returns rotation angle of text containment area in radians <br>
  Standard_EXPORT     Standard_Real AreaRotationAngle() const;
  //! returns position of first base line <br>
  Standard_EXPORT     gp_Pnt BaseLinePosition() const;
  //! returns position of first base line after Transformation <br>
  Standard_EXPORT     gp_Pnt TransformedBaseLinePosition() const;
  //! returns distance from the Base line position plane <br>
  Standard_EXPORT     Standard_Real ZDepthBaseLinePosition() const;
  //! returns Normal Interline Spacing <br>
  Standard_EXPORT     Standard_Real NormalInterlineSpace() const;
  //! returns number of text HAsciiStrings <br>
  Standard_EXPORT     Standard_Integer NbStrings() const;
  //! returns Fixed/Variable width character display of string <br>
//!      0 = Fixed <br>
//!      1 = Variable <br>
//! raises exception if Index <= 0 or Index > NbStrings() <br>
  Standard_EXPORT     Standard_Integer CharacterDisplay(const Standard_Integer Index) const;
  //! returns False if Character display width is Fixed <br>
//! optional method, if required <br>
//! raises exception if Index <= 0 or Index > NbStrings() <br>
  Standard_EXPORT     Standard_Boolean IsVariable(const Standard_Integer Index) const;
  //! returns Character Width of string <br>
//! raises exception if Index <= 0 or Index > NbStrings() <br>
  Standard_EXPORT     Standard_Real CharacterWidth(const Standard_Integer Index) const;
  //! returns Character Height of string <br>
//! raises exception if Index <= 0 or Index > NbStrings() <br>
  Standard_EXPORT     Standard_Real CharacterHeight(const Standard_Integer Index) const;
  //! returns Inter-character spacing of string <br>
//! raises exception if Index <= 0 or Index > NbStrings() <br>
  Standard_EXPORT     Standard_Real InterCharacterSpace(const Standard_Integer Index) const;
  //! returns Interline spacing of string <br>
//! raises exception if Index <= 0 or Index > NbStrings() <br>
  Standard_EXPORT     Standard_Real InterlineSpace(const Standard_Integer Index) const;
  //! returns FontStyle of string <br>
//! raises exception if Index <= 0 or Index > NbStrings() <br>
  Standard_EXPORT     Standard_Integer FontStyle(const Standard_Integer Index) const;
  //! returns CharacterAngle of string <br>
//! Angle returned will be between 0 and 2PI <br>
//! raises exception if Index <= 0 or Index > NbStrings() <br>
  Standard_EXPORT     Standard_Real CharacterAngle(const Standard_Integer Index) const;
  //! returns ControlCodeString of string <br>
//! raises exception if Index <= 0 or Index > NbStrings() <br>
  Standard_EXPORT     Handle_TCollection_HAsciiString ControlCodeString(const Standard_Integer Index) const;
  //! returns number of characters in string or zero <br>
//! raises exception if Index <= 0 or Index > NbStrings() <br>
  Standard_EXPORT     Standard_Integer NbCharacters(const Standard_Integer Index) const;
  //! returns Box width of string <br>
//! raises exception if Index <= 0 or Index > NbStrings() <br>
  Standard_EXPORT     Standard_Real BoxWidth(const Standard_Integer Index) const;
  //! returns Box height of string <br>
//! raises exception if Index <= 0 or Index > NbStrings() <br>
  Standard_EXPORT     Standard_Real BoxHeight(const Standard_Integer Index) const;
  //! returns False if Value, True if Pointer (Entity) <br>
//! raises exception if Index <= 0 or Index > NbStrings() <br>
  Standard_EXPORT     Standard_Boolean IsCharSetEntity(const Standard_Integer Index) const;
  //! returns Character Set Interpretation (default = 1) of string <br>
//! returns 0 if IsCharSetEntity () is True <br>
//!      1 = Standard ASCII <br>
//!      1001 = Symbol Font1 <br>
//!      1002 = Symbol Font2 <br>
//!      1003 = Symbol Font3 <br>
//! raises exception if Index <= 0 or Index > NbStrings() <br>
  Standard_EXPORT     Standard_Integer CharSetCode(const Standard_Integer Index) const;
  //! returns Character Set Interpretation of string <br>
//! returns a Null Handle if IsCharSetEntity () is False <br>
//! raises exception if Index <= 0 or Index > NbStrings() <br>
  Standard_EXPORT     Handle_IGESData_IGESEntity CharSetEntity(const Standard_Integer Index) const;
  //! returns Slant angle of string in radians <br>
//! default value = PI/2 <br>
//! raises exception if Index <= 0 or Index > NbStrings() <br>
  Standard_EXPORT     Standard_Real SlantAngle(const Standard_Integer Index) const;
  //! returns Rotation angle of string in radians <br>
//! raises exception if Index <= 0 or Index > NbStrings() <br>
  Standard_EXPORT     Standard_Real RotationAngle(const Standard_Integer Index) const;
  //! returns Mirror Flag of string <br>
//!      0 = no mirroring <br>
//!      1 = mirror axis is perpendicular to the text base line <br>
//!      2 = mirror axis is text base line <br>
//! raises exception if Index <= 0 or Index > NbStrings() <br>
  Standard_EXPORT     Standard_Integer MirrorFlag(const Standard_Integer Index) const;
  //! returns False if MirrorFlag = 0. ie. no mirroring <br>
//! else returns True <br>
//! raises exception if Index <= 0 or Index > NbStrings() <br>
  Standard_EXPORT     Standard_Boolean IsMirrored(const Standard_Integer Index) const;
  //! returns Rotate internal text Flag of string <br>
//!      0 = text horizontal <br>
//!      1 = text vertical <br>
//! raises exception if Index <= 0 or Index > NbStrings() <br>
  Standard_EXPORT     Standard_Integer RotateFlag(const Standard_Integer Index) const;
  //! returns text start point of string <br>
//! raises exception if Index <= 0 or Index > NbStrings() <br>
  Standard_EXPORT     gp_Pnt StartPoint(const Standard_Integer Index) const;
  //! returns text start point of string after Transformation <br>
//! raises exception if Index <= 0 or Index > NbStrings() <br>
  Standard_EXPORT     gp_Pnt TransformedStartPoint(const Standard_Integer Index) const;
  //! returns distance from the start point plane <br>
//! raises exception if Index <= 0 or Index > NbStrings() <br>
  Standard_EXPORT     Standard_Real ZDepthStartPoint(const Standard_Integer Index) const;
  //! returns text string <br>
//! raises exception if Index <= 0 or Index > NbStrings() <br>
  Standard_EXPORT     Handle_TCollection_HAsciiString Text(const Standard_Integer Index) const;




  DEFINE_STANDARD_RTTI(IGESDimen_NewGeneralNote)

protected:




private: 


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;


};





// other Inline functions and methods (like "C++: function call" methods)


#endif