GlsTextGrid Class Reference

Inheritance diagram for GlsTextGrid:

Public Types
typedef Text	BaseClass
Public Types inherited from Text
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
	GlsTextGrid ()
	GlsTextGrid (GlsTextGrid &src)
None	Char (int col, int row, int code)
None	Char (int startCol, int startRow, int len, int code)
int	Columns ()
None	Columns (int newCols)
None	Erase (int col, int row)
None	Erase (int startCol, int startRow, int rows)
bool	LeftToRight ()
None	LeftToRight (bool leftToRight)
int	LineLength (int row)
int	Rows ()
None	Rows (int newRows)
None	Size (int cols, int rows)
None	str (int startCol, int startRow, str s)
str	str ()
None	str (str &s)
Public Member Functions inherited from Text
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)

Static Public Member Functions
static GlsTextGrid *	CastToGlsTextGrid (DisplayObject *obj)
Static Public Member Functions inherited from GLPolygon
static GLPolygon *	CastToGLPolygon (DisplayObject *obj)

Additional Inherited Members
Static Public Attributes inherited from DisplayObject
static int	TEXTURE_INDEX_NONE = -1

Detailed Description

Python extension used to modify and create GlsTextGrid editor objects.

Member Typedef Documentation

BaseClass

typedef Text GlsTextGrid::BaseClass

Constructor & Destructor Documentation

GlsTextGrid() [1/2]

GlsTextGrid::GlsTextGrid

(

)

default ructor

GlsTextGrid() [2/2]

GlsTextGrid::GlsTextGrid

(

GlsTextGrid &

src

)

copy ructor

Member Function Documentation

CastToGlsTextGrid()

static GlsTextGrid * GlsTextGrid::CastToGlsTextGrid ( DisplayObject *  obj )

static

Casts the Display Object as a GlsTextGrid NOTE: perform an isNULL check on the returned value to ensure the cast was accomplished.

Parameters

obj	objects to cast

Returns

GlsTextGrid the GlsTextGrid

Exceptions

CEIException

Char() [1/2]

None GlsTextGrid::Char	(	int	col,
		int	row,
		int	code
	)

Sets the character code for one character.

Parameters

col	X coordinate of the character to set.
row	Y coordinate of the character to set.
code	The ASCII character code to set.

Char() [2/2]

None GlsTextGrid::Char	(	int	startCol,
		int	startRow,
		int	len,
		int	code
	)

Sets the character code for a range of characters.

Parameters

startCol	X coordinate of the first character to set.
startRow	Y coordinate of the first character to set.
len	Number of characters to set.
code	The ASCII character code to set.

Columns() [1/2]

int GlsTextGrid::Columns

(

)

Gets the number of columns in text grid.

Returns

The number of columns in the grid.

Columns() [2/2]

None GlsTextGrid::Columns

(

int

newCols

)

Sets the number of columns in text grid.

Parameters

newCols

New number of columns in the grid.

Erase() [1/2]

None GlsTextGrid::Erase	(	int	col,
		int	row
	)

Erase one character.

Parameters

col	X coordinate of the character to erase.
row	Y coordinate of the character to erase.

Erase() [2/2]

None GlsTextGrid::Erase	(	int	startCol,
		int	startRow,
		int	rows
	)

Erase a range of characters.

Parameters

startCol	X coordinate of the first character to erase.
startRow	Y coordinate of the first character to erase.
rows	Number of rows to erase.

LeftToRight() [1/2]

bool GlsTextGrid::LeftToRight

(

)

Gets the text direction.

Returns

True if the text direction is set to left-to-right, else false for right-to-left.

LeftToRight() [2/2]

None GlsTextGrid::LeftToRight

(

bool

leftToRight

)

Sets the text direction.

Parameters

leftToRight

True for left-to-right, false for right-to-left.

LineLength()

int GlsTextGrid::LineLength

(

int

row

)

Gets the character length of a row This will search the specified row until a
or NULL is encountered or until it reaches the end of the row (number of columns in the grid).

Parameters

row	The row to return the length of.

Returns

The length of the specified row in characters.

Rows() [1/2]

int GlsTextGrid::Rows

(

)

Gets the number of rows in this text grid.

Returns

The number of rows in this text grid.

Rows() [2/2]

None GlsTextGrid::Rows

(

int

newRows

)

Sets the number of rows in this text grid.

Parameters

newRows

New number of rows in the grid.

Size()

None GlsTextGrid::Size	(	int	cols,
		int	rows
	)

Sets the number of rows and columns for this grid.

Parameters

cols	The new number of columns.
rows	The new number of rows.

str() [1/3]

str Text::str

(

)

Get text characters.

str() [2/3]

None GlsTextGrid::str	(	int	startCol,
		int	startRow,
		str	s
	)

Sets the string to be displayed Starts at the [column,row] coordinate and wraps at newlines and on column boundary.

Parameters

startCol	X coordinate (column) to start at
startRow	Y coordinate (row) to start at
s	STL string to print

str() [3/3]

None Text::str

(

str &

s

)

Set text characters.

---

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

• GlsTextGrid.i