GO2SText Class Reference

Text object. More...

Inheritance diagram for GO2SText:

Public Member Functions
	GO2SText (String text, GO2SXYZ pos, Number height, GO2SEnum::GO2SAnchor anchor=GO2SEnum::GO2SAnchor::Center, String police="arial", Boolean bold=false, Boolean italic=false, Boolean mirror=false)
GO2SEnum::GO2SError	SetAnchor (GO2SEnum::GO2SAnchor anchor)
GO2SEnum::GO2SError	SetAngle (Number angle)
GO2SEnum::GO2SError	SetBold (Boolean bold)
GO2SEnum::GO2SError	SetFilled (Boolean filled)
GO2SEnum::GO2SError	SetHeight (Number height)
GO2SEnum::GO2SError	SetHorSpacing (Number spacing)
GO2SEnum::GO2SError	SetItalic (Boolean italic)
GO2SEnum::GO2SError	SetMirror (Boolean mirror)
GO2SEnum::GO2SError	SetPolice (String police)
GO2SEnum::GO2SError	SetPosition (GO2SXYZ pos)
GO2SEnum::GO2SError	SetText (String text)
GO2SEnum::GO2SError	SetVerSpacing (Number spacing)
Public Member Functions inherited from GO2SMultipleGeometry
Array< GO2SGeometry >	Explode ()
Number	GetElementCount ()
GO2SXYZ	GetFirstPoint () override
GO2SXYZ	GetLastPoint () override
Number	GetLength () override
GO2SXYZ	GetNormalOnCurve (Number t) override
GO2SXYZ	GetPositionOnCurve (Number t) override
GO2SXYZ	GetProjPoint (GO2SXYZ point) override
Number	GetT (GO2SXYZ point) override
GO2SXYZ	GetTangentOnCurve (Number t) override
Boolean	IsClose () override
Public Member Functions inherited from GO2SGeometry
GO2SEnum::GO2SError	ChangePlane (Number plane)
GO2SGeometry	Copy ()
GO2SEnum::GO2SError	Delete ()
Array< GO2SXYZ >	Discretize (Number accuracy=0.01)
Boolean	Equals (GO2SGeometry other)
Array< GO2SXYZ >	GetBoundingBox ()
Number	GetColor ()
Array< GO2SEnum::GO2SParam >	GetEditableParams ()
Number	GetLayer ()
Number	GetLineType ()
Number	GetLineWidth ()
String	GetName ()
Number	GetParam (GO2SEnum::GO2SParam param)
GO2SGeometry	GetParent ()
Number	GetPlane ()
GO2SXYZ	GetPosition ()
Boolean	IsCircular ()
Boolean	IsLinear ()
Boolean	IsParamEditable (GO2SEnum::GO2SParam param)
Boolean	IsPoint ()
Boolean	IsPositionEditable ()
Boolean	IsSolid ()
Boolean	IsValid ()
Boolean	IsVisible ()
Boolean	IsWireframe ()
GO2SGeometry	Rotated (GO2SXYZ xyz, Number angle, Boolean xyzDir)
GO2SEnum::GO2SError	SetColor (Number color)
GO2SEnum::GO2SError	SetLayer (Number layer)
GO2SEnum::GO2SError	SetLineType (ELineType type)
GO2SEnum::GO2SError	SetLineWidth (Number width)
GO2SEnum::GO2SError	SetName (String p1)
GO2SEnum::GO2SError	SetParam (GO2SEnum::GO2SParam param, Number value)
GO2SEnum::GO2SError	SetPlane (Number plane)
GO2SEnum::GO2SError	SetPolarPosition (Number radius, Number angle, Number altitude=0)
GO2SEnum::GO2SError	SetPosition (GO2SXYZpos)
GO2SEnum::GO2SError	SetPosition (Number x, Number y, Number z)
GO2SEnum::GO2SError	SetVisible (Boolean visibility)
String	toString ()
GO2SEnum::GO2SError	Transform (GO2SMatrix matrix)
GO2SGeometry	Transformed (GO2SMatrix matrix)
GO2SGeometry	Translated (GO2SXYZ origin, GO2SXYZ p)

Detailed Description

Text object.

Constructor & Destructor Documentation

GO2SText()

GO2SText::GO2SText	(	String	text,
		GO2SXYZ	pos,
		Number	height,
		GO2SEnum::GO2SAnchor	anchor = GO2SEnum::GO2SAnchor::Center,
		String	police = "arial",
		Boolean	bold = false,
		Boolean	italic = false,
		Boolean	mirror = false )

Create a text at a specific position

GO2SText("Hello world!", new GO2SXYZ(0, 10, 0), 12);

Member Function Documentation

SetAnchor()

GO2SEnum::GO2SError GO2SText::SetAnchor

(

GO2SEnum::GO2SAnchor

anchor

)

Set the anchor point

Returns

GO2SError.success (0) if success, see GO2SError otherwise

Parameters

[in]

anchor

new anchor point

SetAngle()

GO2SEnum::GO2SError GO2SText::SetAngle

(

Number

angle

)

Set the text angle

Returns

GO2SError.success (0) if success, see GO2SError otherwise

Parameters

[in]

angle

new text angle

SetBold()

GO2SEnum::GO2SError GO2SText::SetBold

(

Boolean

bold

)

Set the bold attribute

Returns

GO2SError.success (0) if success, see GO2SError otherwise

Parameters

[in]

bold

if true, build bold text

SetFilled()

GO2SEnum::GO2SError GO2SText::SetFilled

(

Boolean

filled

)

Set the filled attribute

Returns

GO2SError.success (0) if success, see GO2SError otherwise

Parameters

[in]

filled

if true, text will be filled

SetHeight()

GO2SEnum::GO2SError GO2SText::SetHeight

(

Number

height

)

Set the height of a text line

Returns

GO2SError.success (0) if success, see GO2SError otherwise

Parameters

[in]

height

height of text line

SetHorSpacing()

GO2SEnum::GO2SError GO2SText::SetHorSpacing

(

Number

spacing

)

Set the minimum spacing between 2 characters

Returns

GO2SError.success (0) if success, see GO2SError otherwise

Parameters

[in]

spacing

spacing between 2 characters

SetItalic()

GO2SEnum::GO2SError GO2SText::SetItalic

(

Boolean

italic

)

Set the italic attribute

Returns

GO2SError.success (0) if success, see GO2SError otherwise

Parameters

[in]

italic

if true, build italic text

SetMirror()

GO2SEnum::GO2SError GO2SText::SetMirror

(

Boolean

mirror

)

Set the mirror attributes

Returns

GO2SError.success (0) if success, see GO2SError otherwise

SetPolice()

GO2SEnum::GO2SError GO2SText::SetPolice

(

String

police

)

Set the text police

Returns

GO2SError.success (0) if success, see GO2SError otherwise

Parameters

[in]

police

new police

SetPosition()

GO2SEnum::GO2SError GO2SText::SetPosition

(

GO2SXYZ

pos

)

Set the text position

Returns

GO2SError.success (0) if success, see GO2SError otherwise

Parameters

[in]

pos

new text position

SetText()

GO2SEnum::GO2SError GO2SText::SetText

(

String

text

)

Set the text itself

Returns

GO2SError.success (0) if success, see GO2SError otherwise

Parameters

[in]

text

new text

SetVerSpacing()

GO2SEnum::GO2SError GO2SText::SetVerSpacing

(

Number

spacing

)

Set minimum spacing between 2 lines

Returns

GO2SError.success (0) if success, see GO2SError otherwise

Parameters

[in]

spacing

spacing between 2 lines