IGESDimen_NewGeneralNote Class Reference

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

#include <IGESDimen_NewGeneralNote.hxx>

Inheritance diagram for IGESDimen_NewGeneralNote:

Public Member Functions
	IGESDimen_NewGeneralNote ()
void	Init (const double widthwidth, const double heightheight, const int justifyCode, const gp_XYZ &areaLoc, const double areaRotationAngle, const gp_XYZ &baseLinePos, const double normalInterlineSpace, const occ::handle< NCollection_HArray1< int > > &charDisplays, const occ::handle< NCollection_HArray1< double > > &charWidths, const occ::handle< NCollection_HArray1< double > > &charHeights, const occ::handle< NCollection_HArray1< double > > &interCharSpc, const occ::handle< NCollection_HArray1< double > > &interLineSpc, const occ::handle< NCollection_HArray1< int > > &fontStyles, const occ::handle< NCollection_HArray1< double > > &charAngles, const occ::handle< NCollection_HArray1< occ::handle< TCollection_HAsciiString > > > &controlCodeStrings, const occ::handle< NCollection_HArray1< int > > &nbChars, const occ::handle< NCollection_HArray1< double > > &boxWidths, const occ::handle< NCollection_HArray1< double > > &boxHeights, const occ::handle< NCollection_HArray1< int > > &charSetCodes, const occ::handle< NCollection_HArray1< occ::handle< IGESData_IGESEntity > > > &charSetEntities, const occ::handle< NCollection_HArray1< double > > &slAngles, const occ::handle< NCollection_HArray1< double > > &rotAngles, const occ::handle< NCollection_HArray1< int > > &mirrorFlags, const occ::handle< NCollection_HArray1< int > > &rotateFlags, const occ::handle< NCollection_HArray1< gp_XYZ > > &startPoints, const occ::handle< NCollection_HArray1< occ::handle< TCollection_HAsciiString > > > &texts)
	This method is used to set the fields of the class NewGeneralNote.
double	TextWidth () const
	returns width of text containment area of all strings in the note
double	TextHeight () const
	returns height of text containment area of all strings in the note
int	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
double	ZDepthAreaLocation () const
	returns distance from the containment area plane
double	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
double	ZDepthBaseLinePosition () const
	returns distance from the Base line position plane
double	NormalInterlineSpace () const
	returns Normal Interline Spacing
int	NbStrings () const
	returns number of text HAsciiStrings
int	CharacterDisplay (const int Index) const
	returns Fixed/Variable width character display of string 0 = Fixed 1 = Variable raises exception if Index <= 0 or Index > NbStrings()
bool	IsVariable (const int Index) const
	returns False if Character display width is Fixed optional method, if required raises exception if Index <= 0 or Index > NbStrings()
double	CharacterWidth (const int Index) const
	returns Character Width of string raises exception if Index <= 0 or Index > NbStrings()
double	CharacterHeight (const int Index) const
	returns Character Height of string raises exception if Index <= 0 or Index > NbStrings()
double	InterCharacterSpace (const int Index) const
	returns Inter-character spacing of string raises exception if Index <= 0 or Index > NbStrings()
double	InterlineSpace (const int Index) const
	returns Interline spacing of string raises exception if Index <= 0 or Index > NbStrings()
int	FontStyle (const int Index) const
	returns FontStyle of string raises exception if Index <= 0 or Index > NbStrings()
double	CharacterAngle (const int Index) const
	returns CharacterAngle of string Angle returned will be between 0 and 2PI raises exception if Index <= 0 or Index > NbStrings()
occ::handle< TCollection_HAsciiString >	ControlCodeString (const int Index) const
	returns ControlCodeString of string raises exception if Index <= 0 or Index > NbStrings()
int	NbCharacters (const int Index) const
	returns number of characters in string or zero raises exception if Index <= 0 or Index > NbStrings()
double	BoxWidth (const int Index) const
	returns Box width of string raises exception if Index <= 0 or Index > NbStrings()
double	BoxHeight (const int Index) const
	returns Box height of string raises exception if Index <= 0 or Index > NbStrings()
bool	IsCharSetEntity (const int Index) const
	returns False if Value, True if Pointer (Entity) raises exception if Index <= 0 or Index > NbStrings()
int	CharSetCode (const int 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()
occ::handle< IGESData_IGESEntity >	CharSetEntity (const int Index) const
	returns Character Set Interpretation of string returns a Null Handle if IsCharSetEntity () is False raises exception if Index <= 0 or Index > NbStrings()
double	SlantAngle (const int Index) const
	returns Slant angle of string in radians default value = PI/2 raises exception if Index <= 0 or Index > NbStrings()
double	RotationAngle (const int Index) const
	returns Rotation angle of string in radians raises exception if Index <= 0 or Index > NbStrings()
int	MirrorFlag (const int 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()
bool	IsMirrored (const int Index) const
	returns False if MirrorFlag = 0. ie. no mirroring else returns True raises exception if Index <= 0 or Index > NbStrings()
int	RotateFlag (const int 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 int Index) const
	returns text start point of string raises exception if Index <= 0 or Index > NbStrings()
gp_Pnt	TransformedStartPoint (const int Index) const
	returns text start point of string after Transformation raises exception if Index <= 0 or Index > NbStrings()
double	ZDepthStartPoint (const int Index) const
	returns distance from the start point plane raises exception if Index <= 0 or Index > NbStrings()
occ::handle< TCollection_HAsciiString >	Text (const int Index) const
	returns text string raises exception if Index <= 0 or Index > NbStrings()
Public Member Functions inherited from IGESData_IGESEntity
IGESData_IGESType	IGESType () const
	gives IGES typing info (includes "Type" and "Form" data)
int	TypeNumber () const
	gives IGES Type Number (often coupled with Form Number)
int	FormNumber () const
	Returns the form number for that type of an IGES entity. The default form number is 0.
occ::handle< IGESData_IGESEntity >	DirFieldEntity (const int fieldnum) const
	Returns the Entity which has been recorded for a given Field Number, i.e. without any cast. Maps with: 3 : Structure 4 : LineFont 5 : LevelList 6 : View 7 : Transf(ormation Matrix) 8 : LabelDisplay 13 : Color. Other values give a null handle It can then be of any kind, while specific items have a Type.
bool	HasStructure () const
	returns True if an IGESEntity is defined with a Structure (it is normally reserved for certain classes, such as Macros)
occ::handle< IGESData_IGESEntity >	Structure () const
	Returns Structure (used by some types of IGES Entities only) Returns a Null Handle if Structure is not defined.
virtual IGESData_DefType	DefLineFont () const
	Returns the definition status of LineFont.
int	RankLineFont () const
	Returns LineFont definition as an Integer (if defined as Rank) If LineFont is defined as an Entity, returns a negative value.
occ::handle< IGESData_LineFontEntity >	LineFont () const
	Returns LineFont as an Entity (if defined as Reference) Returns a Null Handle if DefLineFont is not "DefReference".
virtual IGESData_DefList	DefLevel () const
	Returns the definition status of Level.
int	Level () const
	Returns the level the entity belongs to. Returns -1 if the entity belongs to more than one level.
occ::handle< IGESData_LevelListEntity >	LevelList () const
	Returns LevelList if Level is defined as a list. Returns a null handle if DefLevel is not DefSeveral.
virtual IGESData_DefList	DefView () const
	Returns the definition status of the view. This can be: none, one or several.
occ::handle< IGESData_ViewKindEntity >	View () const
	Returns the view of this IGES entity. This view can be a single view or a list of views. Warning A null handle is returned if the view is not defined.
occ::handle< IGESData_ViewKindEntity >	SingleView () const
	Returns the view as a single view if it was defined as such and not as a list of views. Warning A null handle is returned if DefView does not have the value DefOne.
occ::handle< IGESData_ViewKindEntity >	ViewList () const
	Returns the view of this IGES entity as a list. Warning A null handle is returned if the definition status does not have the value DefSeveral.
bool	HasTransf () const
	Returns True if a Transformation Matrix is defined.
occ::handle< IGESData_TransfEntity >	Transf () const
	Returns the Transformation Matrix (under IGES definition) Returns a Null Handle if there is none for a more complete use, see Location & CompoundLocation.
bool	HasLabelDisplay () const
	Returns True if a LabelDisplay mode is defined for this entity.
occ::handle< IGESData_LabelDisplayEntity >	LabelDisplay () const
	Returns the Label Display Associativity Entity if there is one. Returns a null handle if there is none.
int	BlankStatus () const
	gives Blank Status (0 visible, 1 blanked)
int	SubordinateStatus () const
	gives Subordinate Switch (0-1-2-3)
int	UseFlag () const
	gives Entity's Use Flag (0 to 5)
int	HierarchyStatus () const
	gives Hierarchy status (0-1-2)
int	LineWeightNumber () const
	Returns the LineWeight Number (0 not defined), see also LineWeight.
double	LineWeight () const
	Returns the true Line Weight, computed from LineWeightNumber and Global Parameter in the Model by call to SetLineWeight.
virtual IGESData_DefType	DefColor () const
	Returns the definition status of Color.
int	RankColor () const
	Returns the color definition as an integer value if the color was defined as a rank. Warning A negative value is returned if the color was defined as an entity.
occ::handle< IGESData_ColorEntity >	Color () const
	Returns the IGES entity which describes the color of the entity. Returns a null handle if this entity was defined as an integer.
bool	CResValues (char *res1, char *res2) const
	returns "reserved" alphanumeric values res1 and res2 res1 and res2 have to be reserved as Character[9 at least] (remark : their content is changed) returned values are ended by null character in 9th returned Boolean is False if res1 and res2 are blank, true else
bool	HasShortLabel () const
	Returns true if a short label is defined. A short label is a non-blank 8-character string.
occ::handle< TCollection_HAsciiString >	ShortLabel () const
	Returns the label value for this IGES entity as a string. Warning If the label is blank, this string is null.
virtual bool	HasSubScriptNumber () const
	Returns true if a subscript number is defined. A subscript number is an integer used to identify a label.
int	SubScriptNumber () const
	Returns the integer subscript number used to identify this IGES entity. Warning 0 is returned if no subscript number is defined for this IGES entity.
void	InitDirFieldEntity (const int fieldnum, const occ::handle< IGESData_IGESEntity > &ent)
	Initializes a directory field as an Entity of any kind See DirFieldEntity for more details.
void	InitTransf (const occ::handle< IGESData_TransfEntity > &ent)
	Initializes Transf, or erases it if <ent> is given Null.
void	InitView (const occ::handle< IGESData_ViewKindEntity > &ent)
	Initializes View, or erases it if <ent> is given Null.
void	InitLineFont (const occ::handle< IGESData_LineFontEntity > &ent, const int rank=0)
	Initializes LineFont : if <ent> is not Null, it gives LineFont, else <rank> gives or erases (if zero) RankLineFont.
void	InitLevel (const occ::handle< IGESData_LevelListEntity > &ent, const int valval=0)
	Initializes Level : if <ent> is not Null, it gives LevelList, else <val> gives or erases (if zero) unique Level.
void	InitColor (const occ::handle< IGESData_ColorEntity > &ent, const int rank=0)
	Initializes Color data : if <ent> is not Null, it gives Color, else <rank> gives or erases (if zero) RankColor.
void	InitStatus (const int blank, const int subordinate, const int useflag, const int hierarchy)
	Initializes the Status of Directory Part.
void	SetLabel (const occ::handle< TCollection_HAsciiString > &labellabel, const int sub=-1)
	Sets a new Label to an IGES Entity If is given, it sets value of SubScriptNumber else, SubScriptNumber is erased.
void	InitMisc (const occ::handle< IGESData_IGESEntity > &str, const occ::handle< IGESData_LabelDisplayEntity > &lab, const int weightnum)
	Initializes various data (those not yet seen above), or erases them if they are given as Null (Zero for <weightnum>) : <str> for Structure, <lab> for LabelDisplay, and <weightnum> for WeightNumber.
bool	HasOneParent () const
	Returns True if an entity has one and only one parent, defined by a SingleParentEntity Type Associativity (explicit sharing). Thus, implicit sharing remains defined at model level (see class ToolLocation).
occ::handle< IGESData_IGESEntity >	UniqueParent () const
	Returns the Unique Parent (in the sense given by HasOneParent) Error if there is none or several.
gp_GTrsf	Location () const
	Returns Location given by Transf in Directory Part (see above) It must be considered for local definition : if the Entity is set in a "Parent", that one can add its one Location, but this is not taken in account here : see CompoundLocation for that. If no Transf is defined, returns Identity If Transf is itself compound, gives the final result.
gp_GTrsf	VectorLocation () const
	Returns Location considered for Vectors, i.e. without its Translation Part. As Location, it gives local definition.
gp_GTrsf	CompoundLocation () const
	Returns Location by taking in account a Parent which has its own Location : that one will be combined to that of <me> The Parent is considered only if HasOneParent is True, else it is ignored and CompoundLocation = Location.
bool	HasName () const
	says if a Name is defined, as Short Label or as Name Property (Property is looked first, else ShortLabel is considered)
occ::handle< TCollection_HAsciiString >	NameValue () const
	returns Name value as a String (Property Name or ShortLabel) if SubNumber is defined, it is concatenated after ShortLabel as follows label(number). Ignored with a Property Name
bool	ArePresentAssociativities () const
	Returns True if the Entity is defined with an Associativity list, even empty (that is, file contains its length 0) Else, the file contained NO idencation at all about this list.
int	NbAssociativities () const
	gives number of recorded associativities (0 no list defined)
Interface_EntityIterator	Associativities () const
	Returns the Associativity List under the form of an EntityIterator.
int	NbTypedAssociativities (const occ::handle< Standard_Type > &atype) const
	gives how many Associativities have a given type
occ::handle< IGESData_IGESEntity >	TypedAssociativity (const occ::handle< Standard_Type > &atype) const
	returns the Associativity of a given Type (if only one exists) Error if none or more than one
void	Associate (const occ::handle< IGESData_IGESEntity > &ent) const
	Sets "me" in the Associativity list of another Entity.
void	Dissociate (const occ::handle< IGESData_IGESEntity > &ent) const
	Resets "me" from the Associativity list of another Entity.
bool	ArePresentProperties () const
	Returns True if the Entity is defined with a Property list, even empty (that is, file contains its length 0) Else, the file contained NO idencation at all about this list.
int	NbProperties () const
	Gives number of recorded properties (0 no list defined).
Interface_EntityIterator	Properties () const
	Returns Property List under the form of an EntityIterator.
int	NbTypedProperties (const occ::handle< Standard_Type > &atype) const
	gives how many Properties have a given type
occ::handle< IGESData_IGESEntity >	TypedProperty (const occ::handle< Standard_Type > &atype, const int anum=0) const
	returns the Property of a given Type Error if none or more than one
void	AddProperty (const occ::handle< IGESData_IGESEntity > &ent)
	Adds a Property in the list.
void	RemoveProperty (const occ::handle< IGESData_IGESEntity > &ent)
	Removes a Property from the list.
void	SetLineWeight (const double defw, const double maxw, const int gradw)
	computes and sets "true" line weight according IGES rules from global data MaxLineWeight (maxv) and LineWeightGrad (gradw), or sets it to defw (Default) if LineWeightNumber is null
Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.
	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.
Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter.
virtual	~Standard_Transient ()=default
	Destructor must be virtual.
virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.
bool	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.
bool	IsInstance (const char *const theTypeName) const
	Returns a true value if this is an instance of TypeName.
bool	IsKind (const opencascade::handle< Standard_Type > &theType) const
	Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
bool	IsKind (const char *const theTypeName) const
	Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
Standard_Transient *	This () const
	Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.
int	GetRefCount () const noexcept
	Get the reference counter of this object.
void	IncrementRefCounter () noexcept
	Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.
int	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.
virtual void	Delete () const
	Memory deallocator for transient classes.

Additional Inherited Members
typedef void	base_type
	Returns a type descriptor about this object.
static constexpr const char *	get_type_name ()
	Returns a type descriptor about this object.
static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class.
Protected Member Functions inherited from IGESData_IGESEntity
	IGESData_IGESEntity ()
	prepares lists of optional data, set values to defaults
void	InitTypeAndForm (const int typenum, const int formnum)
	Initializes Type and Form Numbers to new values. Reserved for special uses.
void	LoadAssociativities (const Interface_EntityList &list)
	Loads a complete, already loaded, List of Asociativities (used during Read or Copy Operations).
void	LoadProperties (const Interface_EntityList &list)
	Loads a complete, already loaded, List of Properties (used during Read or Copy Operations).
void	ClearProperties ()
	Removes all properties in once.

Detailed Description

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

Constructor & Destructor Documentation

IGESDimen_NewGeneralNote()

IGESDimen_NewGeneralNote::IGESDimen_NewGeneralNote

(

)

Member Function Documentation

AreaLocation()

gp_Pnt IGESDimen_NewGeneralNote::AreaLocation

(

)

const

returns Text containment area Location point

AreaRotationAngle()

double IGESDimen_NewGeneralNote::AreaRotationAngle

(

)

const

returns rotation angle of text containment area in radians

BaseLinePosition()

gp_Pnt IGESDimen_NewGeneralNote::BaseLinePosition

(

)

const

returns position of first base line

BoxHeight()

double IGESDimen_NewGeneralNote::BoxHeight

(

const int

Index

)

const

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

BoxWidth()

double IGESDimen_NewGeneralNote::BoxWidth

(

const int

Index

)

const

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

CharacterAngle()

double IGESDimen_NewGeneralNote::CharacterAngle

(

const int

Index

)

const

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

CharacterDisplay()

int IGESDimen_NewGeneralNote::CharacterDisplay

(

const int

Index

)

const

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

CharacterHeight()

double IGESDimen_NewGeneralNote::CharacterHeight

(

const int

Index

)

const

returns Character Height of string raises exception if Index <= 0 or Index > NbStrings()

CharacterWidth()

double IGESDimen_NewGeneralNote::CharacterWidth

(

const int

Index

)

const

returns Character Width of string raises exception if Index <= 0 or Index > NbStrings()

CharSetCode()

int IGESDimen_NewGeneralNote::CharSetCode

(

const int

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

CharSetEntity()

occ::handle< IGESData_IGESEntity > IGESDimen_NewGeneralNote::CharSetEntity

(

const int

Index

)

const

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

ControlCodeString()

occ::handle< TCollection_HAsciiString > IGESDimen_NewGeneralNote::ControlCodeString

(

const int

Index

)

const

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

FontStyle()

int IGESDimen_NewGeneralNote::FontStyle

(

const int

Index

)

const

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

Init()

void IGESDimen_NewGeneralNote::Init	(	const double	width,
		const double	height,
		const int	justifyCode,
		const gp_XYZ &	areaLoc,
		const double	areaRotationAngle,
		const gp_XYZ &	baseLinePos,
		const double	normalInterlineSpace,
		const occ::handle< NCollection_HArray1< int > > &	charDisplays,
		const occ::handle< NCollection_HArray1< double > > &	charWidths,
		const occ::handle< NCollection_HArray1< double > > &	charHeights,
		const occ::handle< NCollection_HArray1< double > > &	interCharSpc,
		const occ::handle< NCollection_HArray1< double > > &	interLineSpc,
		const occ::handle< NCollection_HArray1< int > > &	fontStyles,
		const occ::handle< NCollection_HArray1< double > > &	charAngles,
		const occ::handle< NCollection_HArray1< occ::handle< TCollection_HAsciiString > > > &	controlCodeStrings,
		const occ::handle< NCollection_HArray1< int > > &	nbChars,
		const occ::handle< NCollection_HArray1< double > > &	boxWidths,
		const occ::handle< NCollection_HArray1< double > > &	boxHeights,
		const occ::handle< NCollection_HArray1< int > > &	charSetCodes,
		const occ::handle< NCollection_HArray1< occ::handle< IGESData_IGESEntity > > > &	charSetEntities,
		const occ::handle< NCollection_HArray1< double > > &	slAngles,
		const occ::handle< NCollection_HArray1< double > > &	rotAngles,
		const occ::handle< NCollection_HArray1< int > > &	mirrorFlags,
		const occ::handle< NCollection_HArray1< int > > &	rotateFlags,
		const occ::handle< NCollection_HArray1< gp_XYZ > > &	startPoints,
		const occ::handle< NCollection_HArray1< occ::handle< TCollection_HAsciiString > > > &	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.

InterCharacterSpace()

double IGESDimen_NewGeneralNote::InterCharacterSpace

(

const int

Index

)

const

returns Inter-character spacing of string raises exception if Index <= 0 or Index > NbStrings()

InterlineSpace()

double IGESDimen_NewGeneralNote::InterlineSpace

(

const int

Index

)

const

returns Interline spacing of string raises exception if Index <= 0 or Index > NbStrings()

IsCharSetEntity()

bool IGESDimen_NewGeneralNote::IsCharSetEntity

(

const int

Index

)

const

returns False if Value, True if Pointer (Entity) raises exception if Index <= 0 or Index > NbStrings()

IsMirrored()

bool IGESDimen_NewGeneralNote::IsMirrored

(

const int

Index

)

const

returns False if MirrorFlag = 0. ie. no mirroring else returns True raises exception if Index <= 0 or Index > NbStrings()

IsVariable()

bool IGESDimen_NewGeneralNote::IsVariable

(

const int

Index

)

const

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

JustifyCode()

int IGESDimen_NewGeneralNote::JustifyCode

(

)

const

returns Justification code of all strings within the note 0 = no justification 1 = right justified 2 = center justified 3 = left justified

MirrorFlag()

int IGESDimen_NewGeneralNote::MirrorFlag

(

const int

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

NbCharacters()

int IGESDimen_NewGeneralNote::NbCharacters

(

const int

Index

)

const

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

NbStrings()

int IGESDimen_NewGeneralNote::NbStrings

(

)

const

returns number of text HAsciiStrings

NormalInterlineSpace()

double IGESDimen_NewGeneralNote::NormalInterlineSpace

(

)

const

returns Normal Interline Spacing

RotateFlag()

int IGESDimen_NewGeneralNote::RotateFlag

(

const int

Index

)

const

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

RotationAngle()

double IGESDimen_NewGeneralNote::RotationAngle

(

const int

Index

)

const

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

SlantAngle()

double IGESDimen_NewGeneralNote::SlantAngle

(

const int

Index

)

const

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

StartPoint()

gp_Pnt IGESDimen_NewGeneralNote::StartPoint

(

const int

Index

)

const

returns text start point of string raises exception if Index <= 0 or Index > NbStrings()

Text()

occ::handle< TCollection_HAsciiString > IGESDimen_NewGeneralNote::Text

(

const int

Index

)

const

returns text string raises exception if Index <= 0 or Index > NbStrings()

TextHeight()

double IGESDimen_NewGeneralNote::TextHeight

(

)

const

returns height of text containment area of all strings in the note

TextWidth()

double IGESDimen_NewGeneralNote::TextWidth

(

)

const

returns width of text containment area of all strings in the note

TransformedAreaLocation()

gp_Pnt IGESDimen_NewGeneralNote::TransformedAreaLocation

(

)

const

returns Text containment area Location point after Transformation

TransformedBaseLinePosition()

gp_Pnt IGESDimen_NewGeneralNote::TransformedBaseLinePosition

(

)

const

returns position of first base line after Transformation

TransformedStartPoint()

gp_Pnt IGESDimen_NewGeneralNote::TransformedStartPoint

(

const int

Index

)

const

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

ZDepthAreaLocation()

double IGESDimen_NewGeneralNote::ZDepthAreaLocation

(

)

const

returns distance from the containment area plane

ZDepthBaseLinePosition()

double IGESDimen_NewGeneralNote::ZDepthBaseLinePosition

(

)

const

returns distance from the Base line position plane

ZDepthStartPoint()

double IGESDimen_NewGeneralNote::ZDepthStartPoint

(

const int

Index

)

const

returns distance from the start point plane raises exception if Index <= 0 or Index > NbStrings()

---

The documentation for this class was generated from the following file:

• IGESDimen_NewGeneralNote.hxx