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

void	Baseline (float baselineShift)

GlsColor	BgColor ()

void	BgColor (GlsColor &color)

float	Border ()

void	Border (float units)

float	CellHeight ()

void	CellHeight (float height)

float	CellWidth ()

void	CellWidth (float width)

float	CharScaling ()

void	CharScaling (float newScale)

float	CharSpacing ()

void	CharSpacing (float horizontalSpacing)

bool	ConstrainCellRatio ()

void	ConstrainCellRatio (bool constrainRatio)

bool	ControlCellSize ()

void	ControlCellSize (bool control)

bool	FauxBold ()

void	FauxBold (bool bold)

Font	Font ()

void	Font (Font &font)

bool	Halo ()

void	Halo (bool halo)

GlsColor	HaloColor ()

void	HaloColor (GlsColor &color)

bool	Inverse ()

void	Inverse (bool inverse)

Justify_t	Justify ()

void	Justify (Justify_t justification)

float	LineSpacing ()

void	LineSpacing (float spacing)

bool	LockCellSize ()

void	LockCellSize (bool lock)

bool	Shadow ()

void	Shadow (bool shadow)

GlsColor	ShadowColor ()

void	ShadowColor (GlsColor &color)

Vector	ShadowOffset ()

void	ShadowOffset (Vector &offset)

bool	StrikeThru ()

void	StrikeThru (bool strike)

String	String ()

void	String (String &s)

GlsColor	TextColor ()

void	TextColor (GlsColor &color)

bool	Underline ()

void	Underline (bool underline)

bool	Uppercase ()

void	Uppercase (bool uppercase)

bool	WrapText ()

void	WrapText (bool wrap)

void	ShadowDistance (float distance)

float	ShadowDistance ()

Public Member Functions inherited from GLPolygon
	GLPolygon (VertexArray &vertices)

	GLPolygon (VertexArray &vertices, Vector &location)

	GLPolygon (std::vector< Vertex > vertices)

	GLPolygon (std::vector< Vertex > vertices, Vector &location)

Public Member Functions inherited from DisplayObject
bool	isNULL (void)

String	GetName ()

String	SetName (String name)

void	SetProtectionMode (DisplayObject::MemberAccess_e mode)

DisplayObject::MemberAccess_e	GetProtectionMode (void)

void	SetLocked (bool val)

bool	GetLocked (void)

bool	GetGenerateMemberVariable ()

void	SetGenerateMemberVariable (bool b)

bool	GetAntiAliasing ()

void	SetAntiAliasing (bool antiAliasing)

bool	GetBlinking ()

void	SetBlinking (bool blinking)

float	GetBlinkRate ()

void	SetBlinkRate (float rate)

int	GetAlphaMode ()

void	SetAlphaMode (int mode)

bool	GetCullBackFaces ()

void	SetCullBackFaces (bool cullFaces)

bool	GetZBufferTestedFlag ()

void	SetZBufferTestedFlag (bool tested)

bool	GetAffectZBufferFlag ()

void	SetAffectZBufferFlag (bool affect)

bool	GetLightingEnabledFlag ()

void	SetLightingEnabledFlag (bool enabled)

DisplayObject::PickableType_e	GetPickMode ()

void	SetPickMode (DisplayObject::PickableType_e mode)

bool	GetVisibilityFlag ()

void	SetVisibilityFlag (bool visible)

PolygonClose_e	GetClosePolygonFlag ()

void	SetClosePolygonFlag (PolygonClose_e closePolygon)

PolygonMode_e	GetPolygonMode ()

void	SetPolygonMode (PolygonMode_e polygonMode)

ShadingType_e	GetShadingMode ()

void	SetShadingMode (ShadingType_e shadingMode)

Vertex	GetLocation ()

void	SetLocation (Vertex loc)

Vertex	GetRotationPoint ()

void	SetRotationPoint (Vertex rotPoint)

GlsMatrixAffine *	GetDcsMatrix ()

void	SetDcsMatrix (GlsMatrixAffine *matrix)

int	GetMaterialIndex ()

void	SetMaterialIndex (int matIndex)

String	GetObjectClassName ()

int	GetTextureIndex ()

void	SetTextureIndex (int texIndex)

TextureMap_e	GetTextureMappingTechnique ()

void	SetTextureMappingTechnique (TextureMap_e mappingTechnique)

bool	GetTextureRepeat ()

void	SetTextureRepeat (bool repeat)

disti::GlsColor	GetBlendingColor ()

void	SetBlendingColor (GlsColor blendColor)

DisplayObject::TextureFilter_e	GetTextureMagnificationFilter ()

void	SetTextureMagnificationFilter (DisplayObject::TextureFilter_e filter)

DisplayObject::TextureFilter_e	GetTextureMinificationFilter ()

void	SetTextureMinificationFilter (DisplayObject::TextureFilter_e filter)

std::vector< Vector >	GetTextureCoordinates ()

void	SetTextureCoordinates (std::vector< Vector > &texVerts)

void	GetTextureCoordinates (VertexArray *texVerts)

void	SetTextureCoordinates (VertexArray &texVerts)

void	GetTexturePoints (VertexArray *texVerts)

void	SetTexturePoints (VertexArray &texVerts)

void	SetTexturePoints (std::vector< Vector > &texVerts)

std::vector< Vector >	GetTexturePoints ()

void	GetVertices (VertexArray *verts)

void	SetVertices (VertexArray &verts)

String	GetInitialization ()

void	SetInitialization (String initCode)

String	GetCallbackCode ()

void	SetCallbackCode (String cbCode)

DisplayObject *	DuplicateObject (Document *doc=NULL)

DisplayObject *	TessellateObject ()

DisplayObject *	ExtrudeObject (float amount)

void	RotateObject (float amount, RotationAxis_e axis)

void	TranslateObject (float x, float y, float z)

void	ScaleObject (float x, float y, float z, Vertex *anchor=NULL)

void	LineWidth (float width)

float	LineWidth ()

LineStyle_e	LineStyle ()

void	LineStyle (LineStyle_e style)

GlsColor	LineColor ()

void	LineColor (GlsColor color)

GlsColor	FillColor ()

void	FillColor (GlsColor color)

void	GetExtents (Vector &min, Vector &max)

bool	HasUserDefinedAttribute (String attribName)

std::map< String, String >	GetUserDefinedAttributes ()

String	GetUserDefinedAttributeValue (String attribName)

	typemap (check) String attribName

void	SetUserDefinedAttributeValue (String attribName, String value)

DisplayObject *	GetParent ()

Document *	GetDocument ()

String	AlternateClassName ()

void	AlternateClassName (String name)

String	GetAlternateClassHeaderFile ()

void	SetAlternateClassHeaderFile (String name)

String	GetResources ()

String	GetRuntimeResources (bool recursive)

String	GetAttributeValueString (String attribName)

void	SetAttributeValueString (String attribName, String value)

unsigned int	RegisterObserver (String attribName, PyObject *pyfunc)

void	UnregisterObserver (String attribName, unsigned int id)

std::vector< Vector >	GetNormals ()

void	SetNormals (std::vector< Vector > &normals)

std::vector< CustomAttributeInfo >	GetExtraAttributes ()

DisplayObject *	CloneObject ()

void	CopyProperties (DisplayObject *sourceObj)

void	SetLocation (Vector loc)

GlsMatrixAffine	GetObjectCoordinatesTransform (DisplayObject *targetObject)

void	CalculateParentBoundingBox ()

void	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

enum Text::Justify_t

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

Member Function Documentation

float Text::Baseline ( )

Get baseline shift.

void Text::Baseline ( float baselineShift )

Set baseline shift.

GlsColor Text::BgColor ( )

Get background color.

void Text::BgColor ( GlsColor & color )

Set background color.

float Text::Border ( )

Get border width.

void Text::Border ( float units )

Set border width.

float Text::CellHeight ( )

Get cell height.

void Text::CellHeight ( float height )

Set cell height.

Since: GL Studio 6.0.1

float Text::CellWidth ( )

Get cell width.

void Text::CellWidth ( float width )

Set cell width.

Since: GL Studio 6.0.1

float Text::CharScaling ( )

Get character scale.

void Text::CharScaling ( float newScale )

Set character scale.

float Text::CharSpacing ( )

Get character spacing.

void Text::CharSpacing ( float horizontalSpacing )

Set character spacing.

bool Text::ConstrainCellRatio ( )

Get aspect constrain flag.

void Text::ConstrainCellRatio ( bool constrainRatio )

Set aspect constrain flag.

bool Text::ControlCellSize ( )

Get stretch to fit flag.

void Text::ControlCellSize ( bool control )

Set stretch to fit flag.

bool Text::FauxBold ( )

Get boldface flag.

void Text::FauxBold ( bool bold )

Set boldface flag.

Font Text::Font ( )

Get current font.

void Text::Font ( Font & font )

Set boldface flag.

bool Text::Halo ( )

Get text halo flag.

void Text::Halo ( bool halo )

Set text halo flag.

GlsColor Text::HaloColor ( )

Get text halo color.

void Text::HaloColor ( GlsColor & color )

Set text halo color.

bool Text::Inverse ( )

Get inverse flag.

void Text::Inverse ( bool inverse )

Set inverse flag.

Justify_t Text::Justify ( )

Get justification mode.

void Text::Justify ( Justify_t justification )

Set justification mode.

float Text::LineSpacing ( )

Get line spacing.

void Text::LineSpacing ( float spacing )

Set line spacing.

bool Text::LockCellSize ( )

Get size lock flag.

void Text::LockCellSize ( bool lock )

Set size lock flag.

bool Text::Shadow ( )

Get text shadow flag.

void Text::Shadow ( bool shadow )

Set text shadow flag.

GlsColor Text::ShadowColor ( )

Get text shadow color.

void Text::ShadowColor ( GlsColor & color )

Set text shadow color.

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

float Text::ShadowDistance ( )

Get the ShadowDistance.

Deprecated:: Use ShadowOffset().

Vector Text::ShadowOffset ( )

Gets text shadow offset.

Returns: The text shadow offset

Exceptions

Exception relating to the bindings between Python and C++

void Text::ShadowOffset ( Vector & offset )

Sets text shadow offset.

Parameters

offset The text shadow offset

Exceptions

Exception relating to the bindings between Python and C++

bool Text::StrikeThru ( )

Get strike thru flag.

void Text::StrikeThru ( bool strike )

Set strike thru flag.

String Text::String ( )

Get text characters.

void Text::String ( String & s )

Set text characters.

GlsColor Text::TextColor ( )

Get text color.

void Text::TextColor ( GlsColor & color )

Set text color.

bool Text::Underline ( )

Get underline flag.

void Text::Underline ( bool underline )

Set underline flag.

bool Text::Uppercase ( )

Get uppercase flag.

void Text::Uppercase ( bool uppercase )

Set uppercase flag.

bool Text::WrapText ( )

Get word wrap flag.

void Text::WrapText ( bool wrap )

Set word wrap flag.

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

Text.i

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Member Function Documentation