Text Class Reference

Inheritance diagram for Text:

Public Types
enum	Justify_t {   LEFT ,   CENTER ,   RIGHT }
Public Types inherited from DisplayObject
enum	MemberAccess_e {   PUBLIC ,   PRIVATE ,   PROTECTED }
enum	PickableType_e {   UNPICKABLE ,   FIRST_PICK ,   BEST_PICK ,   ALWAYS_PICK }
enum	PolygonClose_e {   POLY_OPEN ,   POLY_CLOSED }
enum	PolygonMode_e {   POLY_MODE_UNDEFINED ,   POLY_MODE_POINTS ,   POLY_MODE_OUTLINE ,   POLY_MODE_FILLED ,   POLY_MODE_FILL_AND_OUTLINE }
enum	ShadingType_e {   SHADING_FLAT ,   SHADING_GOURAUD }
enum	TextureMap_e {   TEXTURE_MAP_MODULATE ,   TEXTURE_MAP_DECAL ,   TEXTURE_MAP_BLEND ,   TEXTURE_MAP_REPLACE }
enum	TextureFilter_e {   TEXTURE_FILTER_NEAREST ,   TEXTURE_FILTER_LINEAR ,   TEXTURE_FILTER_NEAREST_MIPMAP_NEAREST ,   TEXTURE_FILTER_LINEAR_MIPMAP_LINEAR ,   TEXTURE_FILTER_NEAREST_MIPMAP_LINEAR ,   TEXTURE_FILTER_LINEAR_MIPMAP_NEAREST }
enum	TessellateType_e {   TESSELLATE_UNION ,   TESSELLATE_INTERSECT ,   TESSELLATE_DIFFERENCE }
enum	RotationAxis_e {   X_AXIS ,   Y_AXIS ,   Z_AXIS }
enum	LineStyle_e {   SOLID_LINE_STYLE ,   SMALL_DOTTED_LINE_STYLE ,   DOTTED_LINE_STYLE ,   DASHED_LINE_STYLE ,   DOT_DASHED_LINE_STYLE ,   SMALL_DASHED_LINE_STYLE }
enum	AlphaMode_e {   ALPHA_MODE_UNDEFINED ,   ALPHA_MODE_OPAQUE ,   ALPHA_MODE_2_LEVEL ,   ALPHA_MODE_256_LEVEL }

Public Member Functions
float	Baseline ()
None	Baseline (float baselineShift)
GlsColor	BgColor ()
None	BgColor (GlsColor &color)
float	Border ()
None	Border (float units)
float	CellHeight ()
None	CellHeight (float height)
float	CellWidth ()
None	CellWidth (float width)
float	CharScaling ()
None	CharScaling (float newScale)
float	CharSpacing ()
None	CharSpacing (float horizontalSpacing)
bool	ConstrainCellRatio ()
None	ConstrainCellRatio (bool rainRatio)
bool	ControlCellSize ()
None	ControlCellSize (bool control)
bool	FauxBold ()
None	FauxBold (bool bold)
Font	Font ()
None	Font (Font &font)
bool	Halo ()
None	Halo (bool halo)
GlsColor	HaloColor ()
None	HaloColor (GlsColor &color)
bool	Inverse ()
None	Inverse (bool inverse)
Justify_t	Justify ()
None	Justify (Justify_t justification)
float	LineSpacing ()
None	LineSpacing (float spacing)
bool	LockCellSize ()
None	LockCellSize (bool lock)
bool	Shadow ()
None	Shadow (bool shadow)
GlsColor	ShadowColor ()
None	ShadowColor (GlsColor &color)
Vector	ShadowOffset ()
None	ShadowOffset (Vector &offset)
bool	StrikeThru ()
None	StrikeThru (bool strike)
str	str ()
None	str (str &s)
GlsColor	TextColor ()
None	TextColor (GlsColor &color)
bool	Underline ()
None	Underline (bool underline)
bool	Uppercase ()
None	Uppercase (bool uppercase)
bool	WrapText ()
None	WrapText (bool wrap)
None	ShadowDistance (float distance)
float	ShadowDistance ()
Public Member Functions inherited from GLPolygon
	GLPolygon (VertexArray &vertices)
	GLPolygon (VertexArray &vertices, Vector &location)
	GLPolygon (list vertices)
	GLPolygon (list vertices, Vector &location)
Public Member Functions inherited from DisplayObject
bool	isNULL ()
str	GetName ()
str	SetName (str name)
None	SetProtectionMode (DisplayObject::MemberAccess_e mode)
DisplayObject::MemberAccess_e	GetProtectionMode (None)
None	SetLocked (bool val)
bool	GetLocked (None)
bool	GetGenerateMemberVariable ()
None	SetGenerateMemberVariable (bool b)
bool	GetAntiAliasing ()
None	SetAntiAliasing (bool antiAliasing)
bool	GetBlinking ()
None	SetBlinking (bool blinking)
float	GetBlinkRate ()
None	SetBlinkRate (float rate)
int	GetAlphaMode ()
None	SetAlphaMode (int mode)
bool	GetCullBackFaces ()
None	SetCullBackFaces (bool cullFaces)
bool	GetZBufferTestedFlag ()
None	SetZBufferTestedFlag (bool tested)
bool	GetAffectZBufferFlag ()
None	SetAffectZBufferFlag (bool affect)
bool	GetLightingEnabledFlag ()
None	SetLightingEnabledFlag (bool enabled)
DisplayObject::PickableType_e	GetPickMode ()
None	SetPickMode (DisplayObject::PickableType_e mode)
bool	GetVisibilityFlag ()
None	SetVisibilityFlag (bool visible)
PolygonClose_e	GetClosePolygonFlag ()
None	SetClosePolygonFlag (PolygonClose_e closePolygon)
PolygonMode_e	GetPolygonMode ()
None	SetPolygonMode (PolygonMode_e polygonMode)
ShadingType_e	GetShadingMode ()
None	SetShadingMode (ShadingType_e shadingMode)
Vertex	GetLocation ()
None	SetLocation (Vertex loc)
Vertex	GetRotationPoint ()
None	SetRotationPoint (Vertex rotPoint)
GlsMatrixAffine *	GetDcsMatrix ()
None	SetDcsMatrix (GlsMatrixAffine *matrix)
int	GetMaterialIndex ()
None	SetMaterialIndex (int matIndex)
str	GetObjectClassName ()
int	GetTextureIndex ()
None	SetTextureIndex (int texIndex)
TextureMap_e	GetTextureMappingTechnique ()
None	SetTextureMappingTechnique (TextureMap_e mappingTechnique)
bool	GetTextureRepeat ()
None	SetTextureRepeat (bool repeat)
disti::GlsColor	GetBlendingColor ()
None	SetBlendingColor (GlsColor blendColor)
DisplayObject::TextureFilter_e	GetTextureMagnificationFilter ()
None	SetTextureMagnificationFilter (DisplayObject::TextureFilter_e filter)
DisplayObject::TextureFilter_e	GetTextureMinificationFilter ()
None	SetTextureMinificationFilter (DisplayObject::TextureFilter_e filter)
list	GetTextureCoordinates ()
None	SetTextureCoordinates (list &texVerts)
None	GetTextureCoordinates (VertexArray *texVerts)
None	SetTextureCoordinates (VertexArray &texVerts)
None	GetTexturePoints (VertexArray *texVerts)
None	SetTexturePoints (VertexArray &texVerts)
None	SetTexturePoints (list &texVerts)
list	GetTexturePoints ()
None	GetVertices (VertexArray *verts)
None	SetVertices (VertexArray &verts)
str	GetInitialization ()
None	SetInitialization (str initCode)
str	GetCallbackCode ()
None	SetCallbackCode (str cbCode)
DisplayObject *	DuplicateObject (Document *doc=NULL)
DisplayObject *	TessellateObject ()
DisplayObject *	ExtrudeObject (float amount)
None	RotateObject (float amount, RotationAxis_e axis)
None	TranslateObject (float x, float y, float z)
None	ScaleObject (float x, float y, float z, Vertex *anchor=NULL)
None	LineWidth (float width)
float	LineWidth ()
LineStyle_e	LineStyle ()
None	LineStyle (LineStyle_e style)
GlsColor	LineColor ()
None	LineColor (GlsColor color)
GlsColor	FillColor ()
None	FillColor (GlsColor color)
None	GetExtents (Vector &min, Vector &max)
bool	HasUserDefinedAttribute (str attribName)
std::map< str, str >	GetUserDefinedAttributes ()
UserDefinedValueAttributeList	GetAllUserDefinedAttributes ()
str	GetUserDefinedAttributeValue (str attribName)
	typemap (check) str attribName
None	SetUserDefinedAttributeValue (str attribName, str value)
DisplayObject *	GetParent ()
Document *	GetDocument ()
str	AlternateClassName ()
None	AlternateClassName (str name)
str	GetAlternateClassHeaderFile ()
None	SetAlternateClassHeaderFile (str name)
str	GetResources ()
str	GetRuntimeResources (bool recursive)
str	GetAttributeType (str attribName)
str	GetAttributeValuestr (str attribName)
None	SetAttributeValuestr (str attribName, str value)
int	RegisterObserver (str attribName, PyObject *pyfunc)
None	UnregisterObserver (str attribName, int id)
list	GetNormals ()
None	SetNormals (list &normals)
list	GetExtraAttributes ()
DisplayObject *	CloneObject ()
None	CopyProperties (DisplayObject *sourceObj)
None	SetLocation (Vector loc)
GlsMatrixAffine	GetObjectCoordinatesTransform (DisplayObject *targetObject)
None	CalculateParentBoundingBox ()
None	SetOrigin (Vertex &vert)

Additional Inherited Members
Static Public Member Functions inherited from GLPolygon
static GLPolygon *	CastToGLPolygon (DisplayObject *obj)
Static Public Attributes inherited from DisplayObject
static int	TEXTURE_INDEX_NONE = -1

Detailed Description

Common editor interface Text.

Member Enumeration Documentation

Justify_t

enum Text::Justify_t

Enumerator
LEFT	Left text justification.
CENTER	Center text justification.
RIGHT	Right text justification.

Member Function Documentation

Baseline() [1/2]

float Text::Baseline

(

)

Get baseline shift.

Baseline() [2/2]

None Text::Baseline

(

float

baselineShift

)

Set baseline shift.

BgColor() [1/2]

GlsColor Text::BgColor

(

)

Get background color.

BgColor() [2/2]

None Text::BgColor

(

GlsColor &

color

)

Set background color.

Border() [1/2]

float Text::Border

(

)

Get border width.

Border() [2/2]

None Text::Border

(

float

units

)

Set border width.

CellHeight() [1/2]

float Text::CellHeight

(

)

Get cell height.

CellHeight() [2/2]

None Text::CellHeight

(

float

height

)

Set cell height.

Since

GL Studio 6.0.1

CellWidth() [1/2]

float Text::CellWidth

(

)

Get cell width.

CellWidth() [2/2]

None Text::CellWidth

(

float

width

)

Set cell width.

Since

GL Studio 6.0.1

CharScaling() [1/2]

float Text::CharScaling

(

)

Get character scale.

CharScaling() [2/2]

None Text::CharScaling

(

float

newScale

)

Set character scale.

CharSpacing() [1/2]

float Text::CharSpacing

(

)

Get character spacing.

CharSpacing() [2/2]

None Text::CharSpacing

(

float

horizontalSpacing

)

Set character spacing.

ConstrainCellRatio() [1/2]

bool Text::ConstrainCellRatio

(

)

Get aspect rain flag.

ConstrainCellRatio() [2/2]

None Text::ConstrainCellRatio

(

bool

rainRatio

)

Set aspect rain flag.

ControlCellSize() [1/2]

bool Text::ControlCellSize

(

)

Get stretch to fit flag.

ControlCellSize() [2/2]

None Text::ControlCellSize

(

bool

control

)

Set stretch to fit flag.

FauxBold() [1/2]

bool Text::FauxBold

(

)

Get boldface flag.

FauxBold() [2/2]

None Text::FauxBold

(

bool

bold

)

Set boldface flag.

Font() [1/2]

Font Text::Font

(

)

Get current font.

Font() [2/2]

None Text::Font

(

Font &

font

)

Set boldface flag.

Halo() [1/2]

bool Text::Halo

(

)

Get text halo flag.

Halo() [2/2]

None Text::Halo

(

bool

halo

)

Set text halo flag.

HaloColor() [1/2]

GlsColor Text::HaloColor

(

)

Get text halo color.

HaloColor() [2/2]

None Text::HaloColor

(

GlsColor &

color

)

Set text halo color.

Inverse() [1/2]

bool Text::Inverse

(

)

Get inverse flag.

Inverse() [2/2]

None Text::Inverse

(

bool

inverse

)

Set inverse flag.

Justify() [1/2]

Justify_t Text::Justify

(

)

Get justification mode.

Justify() [2/2]

None Text::Justify

(

Justify_t

justification

)

Set justification mode.

LineSpacing() [1/2]

float Text::LineSpacing

(

)

Get line spacing.

LineSpacing() [2/2]

None Text::LineSpacing

(

float

spacing

)

Set line spacing.

LockCellSize() [1/2]

bool Text::LockCellSize

(

)

Get size lock flag.

LockCellSize() [2/2]

None Text::LockCellSize

(

bool

lock

)

Set size lock flag.

Shadow() [1/2]

bool Text::Shadow

(

)

Get text shadow flag.

Shadow() [2/2]

None Text::Shadow

(

bool

shadow

)

Set text shadow flag.

ShadowColor() [1/2]

GlsColor Text::ShadowColor

(

)

Get text shadow color.

ShadowColor() [2/2]

None Text::ShadowColor

(

GlsColor &

color

)

Set text shadow color.

ShadowDistance() [1/2]

float Text::ShadowDistance

(

)

Get the ShadowDistance.

Deprecated:

Use ShadowOffset().

ShadowDistance() [2/2]

None Text::ShadowDistance

(

float

distance

)

Sets the ShadowDistance.

Deprecated in favor of ShadowOffset. This property is here for backwards compatibility.

Parameters

distance

The new distance

Exceptions

Exception

relating to the bindings between Python and C++

Deprecated:

Use ShadowOffset(Vector& offset)

ShadowOffset() [1/2]

Vector Text::ShadowOffset

(

)

Gets text shadow offset.

Returns

The text shadow offset

Exceptions

Exception

relating to the bindings between Python and C++

ShadowOffset() [2/2]

None Text::ShadowOffset

(

Vector &

offset

)

Sets text shadow offset.

Parameters

offset

The text shadow offset

Exceptions

Exception

relating to the bindings between Python and C++

str() [1/2]

str Text::str

(

)

Get text characters.

str() [2/2]

None Text::str

(

str &

s

)

Set text characters.

StrikeThru() [1/2]

bool Text::StrikeThru

(

)

Get strike thru flag.

StrikeThru() [2/2]

None Text::StrikeThru

(

bool

strike

)

Set strike thru flag.

TextColor() [1/2]

GlsColor Text::TextColor

(

)

Get text color.

TextColor() [2/2]

None Text::TextColor

(

GlsColor &

color

)

Set text color.

Underline() [1/2]

bool Text::Underline

(

)

Get underline flag.

Underline() [2/2]

None Text::Underline

(

bool

underline

)

Set underline flag.

Uppercase() [1/2]

bool Text::Uppercase

(

)

Get uppercase flag.

Uppercase() [2/2]

None Text::Uppercase

(

bool

uppercase

)

Set uppercase flag.

WrapText() [1/2]

bool Text::WrapText

(

)

Get word wrap flag.

WrapText() [2/2]

None Text::WrapText

(

bool

wrap

)

Set word wrap flag.

---

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

• Text.i