GL Studio API
Classes | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
GlsTextGrid Class Reference

#include <gls_text_grid.h>

Inheritance diagram for GlsTextGrid:
GlsText GLPolygon DisplayObject AttributeChangedNotifier WeakReferenceableMixin WeakReferenceable

Classes

struct  RowInfo
 
class  UnderlineStrikeThruHelper
 

Public Member Functions

 GlsTextGrid ()
 
 GlsTextGrid (const GlsTextGrid &that, const bool generateNames)
 
virtual ~GlsTextGrid ()
 
virtual void SetAvailableAttributes (unsigned int value)
 
void Baseline (unsigned int col, unsigned int row, float baselineShift)
 
void Baseline (unsigned int startCol, unsigned int startRow, unsigned int len, float baselineShift)
 
void BgColor (unsigned int col, unsigned int row, const glsColor &color)
 
void BgColor (unsigned int startCol, unsigned int startRow, unsigned int len, const glsColor &color)
 
virtual void Calculate (double time)
 
void Char (unsigned int col, unsigned int row, Char_t code)
 
void Char (unsigned int startCol, unsigned int startRow, unsigned int len, Char_t code)
 
CharAttr_t CharAttr (unsigned int col, unsigned int row) const
 
void CharScaling (unsigned int col, unsigned int row, float newScale)
 
void CharScaling (unsigned int startCol, unsigned int startRow, unsigned int len, float newScale)
 
void CharSpacing (unsigned int col, unsigned int row, float horizontalSpacing)
 
void CharSpacing (unsigned int startCol, unsigned int startRow, unsigned int len, float horizontalSpacing)
 
virtual DisplayObjectCloneObject (bool generateNames=false)
 
unsigned int Columns () const
 
void Columns (unsigned int newCols)
 
virtual void CopyGeometry (DisplayObject *src)
 
virtual void CopyProperties (DisplayObject *src)
 
virtual void Draw (void)
 
void Erase (unsigned int col, unsigned int row)
 
void Erase (unsigned int startCol, unsigned int startRow, unsigned int rows)
 
void Erase (unsigned int startCol, unsigned int startRow, unsigned int endCol, unsigned int endRow)
 
void FauxBold (unsigned int col, unsigned int row, bool bold)
 
void FauxBold (unsigned int startCol, unsigned int startRow, unsigned int len, bool bold)
 
virtual InterfaceListTypeGetCppInterfaceDescription (InterfaceListType *addToThisList=NULL)
 
virtual void GetCppInterfaceDescriptionFree (InterfaceListType *array)
 
void Inverse (unsigned int col, unsigned int row, bool inverse)
 
void Inverse (unsigned int startCol, unsigned int startRow, unsigned int len, bool inverse)
 
unsigned int LineLength (unsigned int row) const
 
unsigned int Rows () const
 
void Rows (unsigned int newRows)
 
virtual void Scale (float px, float py, float pz, Vertex *anchor, int handleBar)
 
virtual void SetValue (int spec, va_list &args)
 
void Size (unsigned int cols, unsigned int rows)
 
void StrikeThru (unsigned int col, unsigned int row, bool strike)
 
void StrikeThru (unsigned int startCol, unsigned int startRow, unsigned int len, bool strike)
 
void String (unsigned int startCol, unsigned int startRow, const std::string &s)
 
void String (unsigned int startCol, unsigned int startRow, const char *s)
 
void TextColor (unsigned int col, unsigned int row, const glsColor &color)
 
void TextColor (unsigned int startCol, unsigned int startRow, unsigned int len, const glsColor &color)
 
glsColor TextColor (unsigned int col=0, unsigned int row=0) const
 
void Underline (unsigned int col, unsigned int row, bool underline)
 
void Underline (unsigned int startCol, unsigned int startRow, unsigned int len, bool underline)
 
void VaString (const char *format,...)
 
void VaString (unsigned int startCol, unsigned int startRow, const char *format,...)
 
void VaString (unsigned int col, unsigned int row, unsigned char rgba[], const char *format,...)
 
void Center (bool flag)
 
void Clear (void)
 
void ClearChars (void)
 
void SetChar (unsigned int col, unsigned int row, char ch)
 
void SetChar (unsigned int col, unsigned int row, char ch, unsigned char rgba[])
 
void SetString (const char *s)
 
void SetString (unsigned int col, unsigned int row, const char *s)
 
void SetString (unsigned int col, unsigned int row, unsigned char rgba[], const char *s)
 
void VaSetString (const char *format,...)
 
void VaSetString (unsigned int col, unsigned int row, const char *format,...)
 
void VaSetString (unsigned int col, unsigned int row, unsigned char rgba[], const char *format,...)
 
bool LeftToRight (void)
 
void LeftToRight (bool leftToRight)
 
- Public Member Functions inherited from GlsText
 GlsText ()
 
virtual ~GlsText ()
 
void Baseline (const float &baselineShift)
 
float Baseline ()
 
void BgColor (const glsColor &color)
 
glsColor BgColor ()
 
void Border (const float &units)
 
float Border () const
 
void CellHeight (float height)
 
float CellHeight () const
 
void CellWidth (float width)
 
float CellWidth () const
 
void Char (Char_t code)
 
CharAttr_t CharAttribs () const
 
CharAttr_t CharAttr (unsigned int index) const
 
void CharScaling (const float &newScale)
 
float CharScaling ()
 
void CharSpacing (const float &horizontalSpacing)
 
float CharSpacing ()
 
void ConstrainCellRatio (bool constrain)
 
bool ConstrainCellRatio () const
 
void ControlCellSize (bool control)
 
bool ControlCellSize () const
 
void Erase ()
 
void FauxBold (const bool &bold)
 
bool FauxBold ()
 
GlsFontBaseFont () const
 
void Font (GlsFontBase *font)
 
void Halo (bool halo)
 
void HaloColor (const glsColor &color)
 
void InvalidateFont ()
 
void Inverse (const bool &inverse)
 
bool Inverse ()
 
void Justify (Justify_t justification)
 
Justify_t Justify () const
 
void LineSpacing (float spacing)
 
float LineSpacing () const
 
void LockCellSize (bool lock)
 
bool LockCellSize () const
 
virtual void Rotate (const Vector &orig, float angle, const Vector &axis)
 
void Shadow (bool shadow)
 
void ShadowColor (const glsColor &color)
 
void ShadowDistance (const float &dist)
 
void ShadowOffset (const Vector &offset)
 
void StrikeThru (const bool &strike)
 
bool StrikeThru ()
 
void String (const std::string &s)
 
void String (const char *s)
 
std::string String () const
 
void TextColor (const glsColor &color)
 
glsColor TextColor ()
 
void Underline (const bool &underline)
 
bool Underline ()
 
void Uppercase (bool uppercase)
 
void WrapText (bool wrap)
 
bool WrapText () const
 
void SetRebuild ()
 
- Public Member Functions inherited from GLPolygon
 GLPolygon (unsigned int nPoints, Vertex *vertices)
 
 GLPolygon (unsigned int nPoints, Vertex *vertices, Vertex &location)
 
 GLPolygon (void)
 
 GLPolygon (const GLPolygon &polygon, const bool generateNames)
 
virtual ~GLPolygon (void)
 
void ConfigureMetaData (void)
 
virtual void CalculateTextureCoordinates (void)
 
virtual void CalcNormals (int windingOrder=1)
 
virtual void DeleteVertex (unsigned int index)
 
virtual DisplayObjectPick3D (const Vector &winLoc, const Vector &logicalCoords, float scale, const Vector &directionVector, Vector &collisionWinLoc, const OpenGLMatrices &parentDrawn)
 
- Public Member Functions inherited from DisplayObject
 DisplayObject (float x, float y, float z)
 
 DisplayObject (const DisplayObject &object, const bool generateNames)
 
virtual ~DisplayObject (void)
 
void Destroy ()
 
virtual void AlphaMode (int mode)
 
virtual int AlphaMode (void)
 
virtual bool AntiAlias (void)
 
virtual void AntiAlias (bool alias)
 
void ApplyTextureSettings (int textureIndex=-1)
 
DistiAttribDictAttributes ()
 
virtual void SetBlendColor (const glsColor &color)
 
void GetBlendColor (unsigned char color[])
 
void GetBlendColor (unsigned char &r, unsigned char &g, unsigned char &b, unsigned char &a)
 
virtual glsColor GetBlendColor ()
 
void SetBlendColor (unsigned char color[])
 
void SetBlendColor (unsigned char r, unsigned char g, unsigned char b, unsigned char a)
 
bool BlinkedOff (void)
 
virtual bool Blinking (void)
 
virtual void Blinking (const bool blink)
 
virtual float BlinkRate (void)
 
virtual void BlinkRate (const float rate)
 
const VectorBoundingVolumeCenter () const
 
void BoundingVolumeCenter (const Vector &center)
 
bool BoundingVolumeHit (const Vector &start, const Vector &direction)
 
float BoundingVolumeRadius () const
 
void BoundingVolumeRadius (float radius)
 
void CalculateCollisionPoint (const Vector &pickLoc, const Vector &directionVector, Vector *collisionPoint)
 
virtual void CalculateParentBoundingBox (void)
 
bool GetTexturePointTransformationMatrix (GlsMatrixType &world2tex)
 
CallbackMethodCallerBaseCallbackCaller () const
 
void CallbackCaller (CallbackMethodCallerBase *cb)
 
virtual void GetCenter (Vector &center)
 
virtual glsColor GetColor ()
 
void GetColor (unsigned char c4[])
 
void GetColor (unsigned char &r, unsigned char &g, unsigned char &b, unsigned char &a)
 
virtual void SetColor (const glsColor &color)
 
void SetColor (unsigned char c4[])
 
void SetColor (unsigned char r, unsigned char g, unsigned char b, unsigned char a)
 
virtual void CopyHierarchyProperties (DisplayObject *src, bool copyName)
 
virtual void CullBackFace (const bool val)
 
virtual bool CullBackFace (void)
 
bool Culled () const
 
bool CullTest (const GlsMatrixType *matrix, const Culler &culler)
 
GlsMatrixTypeDcsMatrix ()
 
void DcsMatrix (const GlsMatrixType &matrix)
 
virtual int DepthTest (void)
 
virtual void DepthTest (unsigned char zbuf)
 
const GlsMatrixTypeDrawMatrix ()
 
bool NeedCalcDrawMatrix ()
 
void DynamicRotate (float angle, int axis)
 
void DynamicRotate (const Vector &v)
 
void DynamicRotate (float angle[])
 
virtual void DynamicRotate (float x, float y, float z)
 
virtual void DynamicRotateRelative (float angle, int axis)
 
virtual float DynamicRotation (int axis)
 
virtual Vector DynamicScale ()
 
virtual void DynamicScale (float x, float y, float z)
 
void DynamicScale (const Vector &scale)
 
virtual void DynamicTranslate (float x, float y, float z, bool relative=false)
 
void DynamicTranslate (const Vertex &amount, bool relative)
 
void DynamicTranslate (const Vector &amount)
 
virtual void DynamicTranslate (float amount, int axis, bool relative=false)
 
virtual float DynamicTranslation (int axis)
 
virtual Vector DynamicTranslation ()
 
DisplayObjectEditor * Editor ()
 
const DisplayObjectEditor * Editor () const
 
void Editor (DisplayObjectEditor *editor)
 
virtual void GetExtents (float &x, float &y, float &z, float &x1, float &y1, float &z1)
 
void GetExtentsDCS (Vector &min, Vector &max)
 
void GetFillColor (unsigned char &r, unsigned char &g, unsigned char &b, unsigned char &a)
 
void GetFillColor (unsigned char c4[])
 
virtual glsColor GetFillColor (void)
 
void SetFillColor (unsigned char r, unsigned char g, unsigned char b, unsigned char a)
 
void SetFillColor (unsigned char c4[])
 
virtual void SetFillColor (const glsColor &color)
 
virtual DisplayObjecthandle (DisplayEvent *ev)
 
virtual bool Hit (float x, float y, float z, float scale, const Vector &directionVector, Vector *collisionPoint)
 
virtual bool HitUtil (float x, float y, float z, float scale, Vertex *vertices, unsigned int vertex_cnt, const Vector &directionVector, Vector *collisionPoint)
 
virtual void InsertVertex (unsigned int index)
 
char * InstanceName (void)
 
void InstanceName (const char *name)
 
virtual bool LightingEnabled ()
 
virtual void LightingEnabled (bool lighting)
 
virtual int LineStippleMultiplier (void)
 
virtual void LineStippleMultiplier (int mult)
 
virtual int LineStipplePattern (void)
 
virtual void LineStipplePattern (int pattern)
 
virtual float LineWidth (void)
 
virtual void LineWidth (float width)
 
virtual const VertexLocation (void) const
 
virtual void Location (const Vertex &v)
 
virtual void Location (float x, float y, float z)
 
virtual void GetLocation (Vertex &v)
 
virtual void GetLocation (float &x, float &y, float &z)
 
float X (void) const
 
float Y (void) const
 
float Z (void) const
 
void X (const float x)
 
void Y (const float y)
 
void Z (const float z)
 
virtual int MaterialIndex ()
 
virtual void MaterialIndex (int index)
 
virtual DynamicArray< int > & MaterialIndices ()
 
virtual void MaterialIndices (DynamicArray< int > indices)
 
GlsMatrixTypeModelMatrix ()
 
bool NeedCalculate ()
 
VectorNormals ()
 
virtual void SetNormals (unsigned int nPoints, Vector *vertices)
 
void VaSetNormals (unsigned int nPoints,...)
 
unsigned int NumberOfVertices () const
 
virtual float ObjectDepth (void)
 
virtual float ObjectHeight (void)
 
virtual float ObjectWidth (void)
 
virtual void SetOrigin (const Vertex &vert)
 
virtual void Parent (DisplayFrame *par)
 
DisplayFrameParent (void) const
 
virtual void ParentGroup (Group *group)
 
GroupParentGroup (void) const
 
unsigned char Pickable ()
 
virtual void Pickable (unsigned char pick)
 
virtual int PolygonEnd (void)
 
virtual void PolygonEnd (const int end)
 
virtual int PolygonMode (void)
 
virtual void PolygonMode (int mode)
 
virtual void PreDraw (const OpenGLMatrices &current, Culler &culler)
 
GlsMatrixTypeProjMatrix ()
 
virtual void ReallocateVertices (unsigned int numVertices, bool initializeNew, bool copyOld)
 
virtual float RelativeAngle (const float x, const float y)
 
virtual DistiAttributeBaseResource (const char *name)
 
virtual void GetResources (std::ostream &outstr, GlsResourceFilter *filter=NULL)
 
void RestoreAlpha (void)
 
void RestoreAntiAlias (void)
 
void RestoreLighting (void)
 
void RestoreLineStyle (void)
 
const VertexRotationPoint ()
 
virtual void RotationPoint (const Vertex &v)
 
virtual void RotationPoint (float x, float y, float z)
 
virtual void GetRotationPoint (Vertex &v)
 
virtual void Rotate (float angle, int axis=Z_AXIS)
 
virtual void Rotate (const Vector &origin, float angle, int axis=Z_AXIS)
 
void SaveMatrices ()
 
void Scale (int handleBar, float px, float py, Vertex *anchor=NULL)
 
void Set (int spec,...)
 
bool SetupAlpha (void)
 
bool SetupAntiAlias (void)
 
void SetupDepthTest (void)
 
void SetupLighting (void)
 
bool SetupLineStyle (void)
 
void SetupPolyDrawStyle (void)
 
void SetupShading (void)
 
bool SetupTexture (void)
 
virtual int Shading (void)
 
virtual void Shading (const int shading)
 
virtual void GetTransformedExtents (Vector &min, Vector &max, const GlsMatrixType &matrix, bool resetMinMax=true)
 
virtual void SetTexCoords (unsigned int nPoints, Vector *new_tex_coord, bool isVectorArray=true)
 
void SetTexCoords (unsigned int nPoints, Vertex *new_tex_coord)
 
void VaSetTexCoords (unsigned int nPoints,...)
 
VectorTextureCoordinates (void)
 
VectorGetTextureCoordinates (void)
 
virtual int TextureIndex (void)
 
virtual void TextureIndex (int textureIndex)
 
virtual VectorGetTexturePoints (void)
 
virtual bool TextureRepeat (void)
 
virtual void TextureRepeat (const int rep)
 
virtual int TextureMappingTechnique (void)
 
virtual void TextureMappingTechnique (const int map)
 
virtual int TextureMagnificationFilter (void)
 
virtual void TextureMagnificationFilter (const int filter)
 
virtual int TextureMinificationFilter (void)
 
virtual void TextureMinificationFilter (const int filter)
 
virtual void Translate (float tr[])
 
virtual void Translate (float x, float y, float z)
 
virtual void TranslateVertices (float x, float y, float z)
 
virtual void UpdateBoundingVolume (void)
 
void * UserData (void) const
 
void UserData (void *data)
 
virtual void SetVertexColor (unsigned int vertex, unsigned char CurrentFillColor[])
 
virtual VertexVertices ()
 
virtual void SetVertices (unsigned int nPoints, Vertex *vertices)
 
void VaSetVertices (unsigned int nPoints,...)
 
int * ViewMatrix ()
 
bool Visible (void) const
 
bool Visibility (void) const
 
virtual void Visibility (const bool vis)
 
virtual Vector WorldRotationPoint (void)
 
virtual void WorldRotationPoint (const Vector &vert)
 
virtual Vertex WorldVertex (unsigned int i)
 
virtual void WorldVertex (unsigned int i, const Vertex &vert)
 
bool LogicalToWindow (const Vector &logical, Vector &winLoc, const OpenGLMatrices &alternateMatrices=OpenGLMatrices())
 
bool WindowToLogical (const Vector &winLoc, Vector &logical, Vector *directionVector=NULL, const OpenGLMatrices &alternateMatrices=OpenGLMatrices())
 
void LogicalToDCS (Vector logicalPoint, Vector &objectLocal, const Vector *directionVector, const Vector &planeNormal=Vector(0, 0, 1), const Vector &planePoint=Vector(), const GlsMatrixType *dcsMatrix=NULL)
 
void DCSToLogical (Vector dcsPoint, Vector &logicalPoint, const GlsMatrixType *dcsMatrix=NULL)
 
virtual bool GetPlaneVectorPoints (Vertex &p1, Vertex &p2, Vertex &p3, Vertex &planeVector)
 
void NotifyAttributeChanged (const AttributeName &name)
 
- Public Member Functions inherited from AttributeChangedNotifier
virtual ~AttributeChangedNotifier ()
 
- Public Member Functions inherited from WeakReferenceableMixin
void AddWeakReference (WeakReference *weakRef)
 
void NotifyWeakReferenceDestroyed (WeakReference *ref)
 

Protected Member Functions

void EraseIndex (unsigned int textIndex)
 
void EnablePerCharAttribs (void)
 
char * FormatVarArgList (const char *format, va_list args)
 
unsigned int IndexOf (unsigned int col, unsigned int row) const
 
unsigned int TextIndexOf (unsigned int col, unsigned int row, unsigned int startRow=0) const
 
unsigned int GridIndexOf (unsigned int col, unsigned int row) const
 
virtual void CalculateRowData (void)
 
- Protected Member Functions inherited from GlsText
char * FormatVarArgList (const int initialBufferLength, const char *format, va_list args)
 
- Protected Member Functions inherited from DisplayObject
virtual void VaListSetVertices (unsigned int nPoints, va_list args)
 
virtual void VaListSetNormals (unsigned int nPoints, va_list args)
 
virtual void VaListSetTexCoords (unsigned int nPoints, va_list args)
 
void AllocateModelMatrix ()
 
bool ApplyDynamicRotation (void)
 
virtual void CalcDrawMatrix ()
 
void CalcDrawMatrixIfExists ()
 
virtual void CalculateMatrices (const OpenGLMatrices &newMatrices)
 
bool InsideVertexExtents (float x, float y, unsigned int nVerts, Vertex *verts, float tolerance)
 
void NeedCalculate (bool val)
 
void PickSetup (float x, float y, float z, Vertex *vertices, unsigned int vertex_cnt, const Vector &directionVector)
 
void PickCleanup (Vertex *vertices, unsigned int vertex_cnt)
 
int GetApplicableTextureIndex ()
 
int GetApplicableTextureRepeat ()
 
- Protected Member Functions inherited from WeakReferenceableMixin
 WeakReferenceableMixin (void)
 
virtual ~WeakReferenceableMixin ()
 

Protected Attributes

unsigned int _cols
 
unsigned int _rows
 
bool _perCharAttribs
 
RowInfo_rowInfo
 
bool _leftToRight
 
UnicodeString _unicodeText
 
- Protected Attributes inherited from GlsText
float _border
 
CharAttrCont_t _chars
 
float _cellHeight
 
float _cellWidth
 
bool _constrainRatio
 
bool _controlCellSize
 
GlsFontBase_font
 
glsColor _haloColor
 
Justify_t _justify
 
float _lineSpacing
 
bool _lockCellSize
 
bool _needToRebuild
 
glsColor _shadowColor
 
Vector _shadowOffset
 
std::string _text
 
bool _uppercase
 
Vector _vX
 
Vector _vY
 
Vector _vZ
 
bool _wrapText
 
ScopedPtr< RuntimeGlyphGenerationText > _runtimeGlyphGenerationText
 
- Protected Attributes inherited from DisplayObject
int _alphaMode
 
bool _antiAlias
 
bool _attributesAdded
 
bool _blinking
 
float _blinkRate
 
glsColor _color
 
bool _cullBackFace
 
GlsMatrixType _dcsMatrix
 
unsigned char _depthTest
 
GlsMatrixType_drawMatrix
 
unsigned char _lineStippleMultiplier
 
unsigned short _lineStipplePattern
 
float _lineWidth
 
Vertex _location
 
GlsMatrixType_modelMatrix
 
Vector_normals
 
unsigned int _nTex_vertices
 
unsigned int _nVertices
 
unsigned char _polygonEnd
 
unsigned char _polygonMode
 
int _polygonOffset
 
GlsMatrixType_projMatrix
 
unsigned char _shading
 
Vector_texCoord
 
glsColor _textureBlendColor
 
int _textureIndex
 
unsigned char _textureMagFilter
 
unsigned char _textureMinFilter
 
unsigned char _textureMap
 
Vector _texturePoints [4]
 
unsigned char _textureRepeat
 
void * _userData
 
Vertex_vertices
 
int * _viewMatrix
 
bool _visible
 
- Protected Attributes inherited from WeakReferenceableMixin
DynamicArray< WeakReference * > * _weakRefs
 

Additional Inherited Members

- Public Types inherited from GlsText
enum  Justify_t
 Different text justifications.
 
- Public Types inherited from DisplayObject
enum  AvailableAttributesEnum
 
- Static Public Member Functions inherited from GlsText
static void DrawScalableLine (GLfloat x1, GLfloat y1, GLfloat x2, GLfloat y2)
 
- Static Public Member Functions inherited from DisplayObject
static void UseManualBlinkElapsedTime (bool useManualTime)
 
static void SetManualBlinkElapsedTime (double elapsedTime)
 

Detailed Description

The GlsTextGrid

Constructor & Destructor Documentation

Class Constructor.

GlsTextGrid ( const GlsTextGrid that,
const bool  generateNames 
)

Copy Constructor.

virtual ~GlsTextGrid ( )
virtual

Class Deconstructor.

Member Function Documentation

void Baseline ( unsigned int  col,
unsigned int  row,
float  baselineShift 
)

Sets the baseline shift for one character

Parameters
colX coordinate of the character to set
rowY coordinate of the character to set
baselineShiftmultiplier used to shift the baseline.
void Baseline ( unsigned int  startCol,
unsigned int  startRow,
unsigned int  len,
float  baselineShift 
)

Sets the baseline shift for a range of characters

Parameters
startColX coordinate of the first character to set
startRowY coordinate of the first character to set
lenNumber of characters to set
baselineShiftmultiplier used to shift the baseline.
void BgColor ( unsigned int  col,
unsigned int  row,
const glsColor color 
)

Sets the cell background color for one character.

Parameters
colX coordinate of the character to set
rowY coordinate of the character to set
colorThe background color to set
void BgColor ( unsigned int  startCol,
unsigned int  startRow,
unsigned int  len,
const glsColor color 
)

Sets the cell background color for a range of characters.

Parameters
startColX coordinate of the first character to set
startRowY coordinate of the first character to set
lenNumber of characters to set
colorThe background color to set
virtual void Calculate ( double  time)
virtual

Provides a mechanism for performing regular calculations, seperate from drawing. In a standalone applicaton Calculate is recursively called by the main loop before the objects are drawn.

Parameters
timeThe elaspsed time in seconds since program start

Reimplemented from DisplayObject.

virtual void CalculateRowData ( void  )
protectedvirtual

Populate the _rowInfo array based on the current display string

Precondition
none
Postcondition
_rowInfo array is populated based on the current display string
void Center ( bool  flag)
inline

Enable/disable centering mode (TextDisplay compatability method)

Parameters
flagTrue if text should be centered, false if it should be left justified
Deprecated:
use Justify instead
void Char ( unsigned int  col,
unsigned int  row,
Char_t  code 
)

Sets the character code for one character

Parameters
colX coordinate of the character to set
rowY coordinate of the character to set
codeThe ASCII character code to set
void Char ( unsigned int  startCol,
unsigned int  startRow,
unsigned int  len,
Char_t  code 
)

Sets the character code for a range of characters

Parameters
startColX coordinate of the first character to set
startRowY coordinate of the first character to set
lenNumber of characters to set
codeThe ASCII character code to set
CharAttr_t CharAttr ( unsigned int  col,
unsigned int  row 
) const
inline
Returns
a particular cell's character attributes.
void CharScaling ( unsigned int  col,
unsigned int  row,
float  newScale 
)

Sets the scale factor of one character NOTE: This is the size of the character in its cell not the overall scale of the entire object

Parameters
colX coordinate of the character to set
rowY coordinate of the character to set
newScaleThe new scale factor of the characters (0.0 < newScale <= 1.0)
void CharScaling ( unsigned int  startCol,
unsigned int  startRow,
unsigned int  len,
float  newScale 
)

Sets the scale factor of a range of characters NOTE: This is the size of the character in its cell not the overall scale of the entire object

Parameters
startColX coordinate of the first character to set
startRowY coordinate of the first character to set
lenNumber of characters to set
newScaleThe new scale factor of the characters (0.0 < newScale <= 1.0)
void CharSpacing ( unsigned int  col,
unsigned int  row,
float  horizontalSpacing 
)

Sets the horizontal character spacing for one character 1.0 is the default spacing 2.0 would be twice the normal spacing

Parameters
colX coordinate of the character to set
rowY coordinate of the character to set
horizontalSpacingThe horizontalSpacing value
void CharSpacing ( unsigned int  startCol,
unsigned int  startRow,
unsigned int  len,
float  horizontalSpacing 
)

Sets the horizontal character spacing for a range of characters 1.0 is the default spacing 2.0 would be twice the normal spacing

Parameters
startColX coordinate of the first character to set
startRowY coordinate of the first character to set
lenNumber of characters to set
horizontalSpacingThe horizontalSpacing value
void Clear ( void  )
inline

Clears all of the characters and resets the attributes of all characters (TextDisplay compatability method)

Deprecated:
use Erase instead
void ClearChars ( void  )
inline

Clears all of the characters. Does NOT reset the attributes of the characters (TextDisplay compatability method)

Deprecated:
virtual DisplayObject* CloneObject ( bool  generateNames = false)
virtual

Copy+Create operation in one method. In derived classes, this method will create a new instance of the derived class and then copy the object into the new instance. The cut,copy,paste and undo operations use this method.

Parameters
generateNamesWhether or not to generate new names for cloned objects
Returns
A new object, identical to the original, except for the instance name

Reimplemented from GLPolygon.

unsigned int Columns ( ) const
inline

Gets the width of this object in characters

Returns
The width of this object in characters (number of columns)
void Columns ( unsigned int  newCols)
inline

Sets the number of columns the text grid contains.

Parameters
newColsnew number of columns to size the grid with.
virtual void CopyGeometry ( DisplayObject src)
virtual

Copies the geometry information from one object to another. Used by the undo mechanism to allow user to undo a geometry change.

Parameters
srcThe object to copy geometry from

Reimplemented from GlsText.

virtual void CopyProperties ( DisplayObject src)
virtual

Copies the attributes except for geometry attributes from one object to another. Used by the undo mechanism to undo most attribute change operations.

Parameters
srcThe object to copy properties from

Reimplemented from GlsText.

virtual void Draw ( void  )
virtual

Draws this object on the current display frame (_parent member).

Reimplemented from GLPolygon.

void EnablePerCharAttribs ( void  )
inlineprotected

Enable per character attribute drawing for this grid

void Erase ( unsigned int  col,
unsigned int  row 
)

Erase one character.

Parameters
colX coordinate of the character to erase
rowY coordinate of the character to erase
void Erase ( unsigned int  startCol,
unsigned int  startRow,
unsigned int  rows 
)

Erase all characters after a given position.

Parameters
startColX coordinate of the first character to erase
startRowY coordinate of the first character to erase
rowsNumber of rows to erase
void Erase ( unsigned int  startCol,
unsigned int  startRow,
unsigned int  endCol,
unsigned int  endRow 
)

Erase a range of characters.

Parameters
startColX coordinate of the first character to erase
startRowY coordinate of the first character to erase
endColX coordinate of the last character to erase
endRowY coordinate of the last character to erase.
void EraseIndex ( unsigned int  textIndex)
protected

Erase a single character at a given index. Use TextIndexOf to find the character using coordinates.

Parameters
textIndexindex of the character to erase
void FauxBold ( unsigned int  col,
unsigned int  row,
bool  bold 
)

Set the bold state on or off for one character

Parameters
colX coordinate of the character to set
rowY coordinate of the character to set
boldBold state
void FauxBold ( unsigned int  startCol,
unsigned int  startRow,
unsigned int  len,
bool  bold 
)

Set the bold state on or off for a range of characters

Parameters
startColX coordinate of the first character to set
startRowY coordinate of the first character to set
lenNumber of characters to set
boldBold state
char* FormatVarArgList ( const char *  format,
va_list  args 
)
protected

Allocate a text buffer of the appropriate size for this grid and output snprintf style format into the buffer

Parameters
formatsnprintf style format spec
argsarguments for sprintf style formatting
Returns
formatted textbuffer ( must be deleted by caller )
virtual InterfaceListType* GetCppInterfaceDescription ( InterfaceListType addToThisList = NULL)
virtual

Get the details of the Cpp Interface The actual interface is exposed in compiled code.

Parameters
addToThisListIf not NULL this list will be added to then returned. If NULL a new list will be created.
Returns
A templated list. The caller must call the corresponding free method to safely free the memory.

Reimplemented from GlsText.

virtual void GetCppInterfaceDescriptionFree ( InterfaceListType array)
virtual

Frees the memory allocated by a previous call to GetCppInterfaceDescription

Parameters
arrayMemory allocated by a previous call to GetCppInterfaceDescription

Reimplemented from GlsText.

unsigned int GridIndexOf ( unsigned int  col,
unsigned int  row 
) const
protected

Converts col,row into grid index returning the end of the string if this index would go outside the bounds of the grid

Parameters
colThe column number
rowThe line number (row)
Returns
The grid index of line & column
unsigned int IndexOf ( unsigned int  col,
unsigned int  row 
) const
inlineprotected

Converts col,row into linear index

Parameters
colThe column number
rowThe line number (row)
Returns
The linear index of line & column
void Inverse ( unsigned int  col,
unsigned int  row,
bool  inverse 
)

Set the inverse video state on or off for one character

Parameters
colX coordinate of the character to set
rowY coordinate of the character to set
inverseinverse video state
void Inverse ( unsigned int  startCol,
unsigned int  startRow,
unsigned int  len,
bool  inverse 
)

Set the inverse video state on or off for a range of characters

Parameters
startColX coordinate of the first character to set
startRowY coordinate of the first character to set
lenNumber of characters to set
inverseinverse video state
bool LeftToRight ( void  )

Determine if the text direction is set to left->right or right->left

Returns
true if if the text direction is set to left->right else false for right->left
void LeftToRight ( bool  leftToRight)

Set the text direction

Parameters
leftToRighttrue for left->right else false for right->left
unsigned int LineLength ( unsigned int  row) const
Returns
The length of a given line in characters. 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
rowThe row to return the length of
unsigned int Rows ( ) const
inline

The number of rows in this text grid

Returns
The number of rows in this text grid
void Rows ( unsigned int  newRows)
inline

Change the number of rows the text grid contains.

Parameters
newRowsnew number of rows to size the grid with.
virtual void Scale ( float  px,
float  py,
float  pz,
Vertex anchor,
int  handleBar 
)
virtual

Scales the object, either the handleBar, or the Anchor is used to translate the object, not both. Anchor takes presidence, if it is set HandleBar is ignored. The footprint is different from the 2D scale so the compiler can destinguish the two.

Parameters
pxValue of the percentage of scale in x-axis
pyValue of the percentage of scale in y-axis
pzValue of the percentage of scale in z-axis
anchorAnchor from which to scale object relative to
handleBarVertex that is being dragged

Reimplemented from DisplayObject.

virtual void SetAvailableAttributes ( unsigned int  value)
virtual

Specifies which attributes are available for the object. Currently the available attributes cannot be changed after they have been set. (Only the first call has an effect.)

Parameters
valueA bitfield specifying which types of attributes to make available.
See also
AvailableAttributesEnum

Reimplemented from GlsText.

void SetChar ( unsigned int  col,
unsigned int  row,
char  ch 
)
inline

Set an individual character at the given position Assumes current string does not contain newline characters. If a newline character is encountered in the current string it will be overwritten. (TextDisplay compatability method)

Parameters
colX position (column)
rowY position (row)
chASCII code of the character
Deprecated:
use Char instead
void SetChar ( unsigned int  col,
unsigned int  row,
char  ch,
unsigned char  rgba[] 
)
inline

Set an individual character at the given position. Also set its color. Assumes current string does not contain newline characters. If a newline character is encountered in the current string it will be overwritten. (TextDisplay compatability method)

Parameters
colX position (column)
rowY position (row)
chASCII code of the character
rgbaColor value for character
Deprecated:
use Char instead
void SetString ( const char *  s)
inline

SetColor() meaning has changed, now use TextColor Print a string into this text object starting at 0,0 and proceeding Left to right. Wraps at newline characters. Does not change the color or any other modes. Replaces the entire string. If substring replacement is desired, use String(col, row, s). (TextDisplay compatability method)

Parameters
sThe string to print
Deprecated:
use String instead
void SetString ( unsigned int  col,
unsigned int  row,
const char *  s 
)
inline

Print a string into this text object starting at col,row and proceeding Assumes current string does not contain newline characters. If a newline is encountered in the current string it will be overwritten. Does not change the color or any other modes. Just inserts/overwrites characters. This replaces a substring within the current string. If you want full string replacement use String(s) (TextDisplay compatability method)

Parameters
colX position (column)
rowY position (row)
sThe string to print
Deprecated:
use String instead
void SetString ( unsigned int  col,
unsigned int  row,
unsigned char  rgba[],
const char *  s 
)

Print a string into this text object starting at col,row and proceeding Assumes current string does not contain newline characters. If a newline is encountered in the current string it will be overwritten. Inserts/overwrites characters and changes the color. This replaces a substring within the current string. If you want full string replacement use String(s) (TextDisplay compatability method)

Parameters
colX position (column)
rowY position (row)
rgbaThe color to set
sThe string to print
Deprecated:
use String instead
virtual void SetValue ( int  spec,
va_list &  args 
)
virtual

Sets an attribute of this object using variable arguments

Parameters
specA GLS_Initializer tag
argsA variable argument list

Reimplemented from GlsText.

void Size ( unsigned int  cols,
unsigned int  rows 
)

Sets the number of rows and columns for this object

Parameters
colsThe new number of columns
rowsThe new number of rows
void StrikeThru ( unsigned int  col,
unsigned int  row,
bool  strike 
)

Sets the strikethru state for one character

Parameters
colX coordinate of the character to set
rowY coordinate of the character to set
strikeWhether or not set strike to fit
void StrikeThru ( unsigned int  startCol,
unsigned int  startRow,
unsigned int  len,
bool  strike 
)

Sets the strikethru state for a range of characters

Parameters
startColX coordinate of the first character to set
startRowY coordinate of the first character to set
lenNumber of characters to set
strikeWhether or not set strike to fit
void String ( unsigned int  startCol,
unsigned int  startRow,
const std::string &  s 
)

Sets the ASCII string to be displayed for this object starting at an col,row coordinate and wrapping on newlines and column count

Parameters
startColX coordinate (column) to start at
startRowY coordinate (row) to start at
sSTD Template Library string to print
void String ( unsigned int  startCol,
unsigned int  startRow,
const char *  s 
)
inline

Sets the ASCII string to be displayed for this object starting at an col,row coordinate and wrapping on newlines and column count

Parameters
startColX coordinate (column) to start at
startRowY coordinate (row) to start at
sC style string to print
void TextColor ( unsigned int  col,
unsigned int  row,
const glsColor color 
)

Sets the foreground color for one character

Parameters
colX coordinate of the character to set
rowY coordinate of the character to set
colorThe foreground color to set
void TextColor ( unsigned int  startCol,
unsigned int  startRow,
unsigned int  len,
const glsColor color 
)

Sets the foreground color for a range of characters

Parameters
startColX coordinate of the first character to set
startRowY coordinate of the first character to set
lenNumber of characters to set
colorThe foreground color to set
glsColor TextColor ( unsigned int  col = 0,
unsigned int  row = 0 
) const

Returns the foreground color for the specified character. If no character is specified, the color at 0,0 will be returned.

Parameters
colX coordinate of the character of interest
rowY coordinate of the character of interest
Returns
The requested color
unsigned int TextIndexOf ( unsigned int  col,
unsigned int  row,
unsigned int  startRow = 0 
) const
protected

Converts col,row into linear index returning the end of the string if this index would go beyond it

Parameters
colThe column number
rowThe line number (row)
startRowThe row to start the search from
Returns
The linear index of line & column
void Underline ( unsigned int  col,
unsigned int  row,
bool  underline 
)

Turns on/off underlines for one character

Parameters
colX coordinate of the character of interest
rowY coordinate of the character of interest
underlineWhether or not to enable underline
void Underline ( unsigned int  startCol,
unsigned int  startRow,
unsigned int  len,
bool  underline 
)

Turns on/off underlines for a range character

Parameters
startColX coordinate of the first character to set
startRowY coordinate of the first character to set
lenNumber of characters to set
underlineWhether or not to enable underline
void VaSetString ( const char *  format,
  ... 
)

Print a string into this text object starting at 0,0 and proceeding Left to right Assumes current string does not contain newline characters. If a newline is encountered in the current string it will be overwritten. Does not change the color or any other modes. Replaces the entire string. If substring replacement is desired, use VaString(col, row, format). (TextDisplay compatability method)

Parameters
formatprintf style varargs formatting string.
Deprecated:
use VaString instead
void VaSetString ( unsigned int  col,
unsigned int  row,
const char *  format,
  ... 
)

Print a string into this text object starting at col,row and proceeding Left to right Assumes current string does not contain newline characters. Does not change the color or any other modes. Just inserts/overwrites characters. This replaces a substring within the current string. If you want full string replacement use VaString(format) (TextDisplay compatability method)

Parameters
colX position (column)
rowY position (row)
formatprintf style varargs formatting string.
Deprecated:
use VaString instead
void VaSetString ( unsigned int  col,
unsigned int  row,
unsigned char  rgba[],
const char *  format,
  ... 
)

Print a string into this text object starting at col,row and proceeding Left to right Assumes current string does not contain newline characters. If a newline is encountered in the current string it will be overwritten. Inserts/overwrites characters and changes the color. This replaces a substring within the current string. If you want full string replacement use VaString(format) (TextDisplay compatability method)

Parameters
colX position (column)
rowY position (row)
rgbaThe color to set
formatprintf style varargs formatting string.
Deprecated:
use VaString instead
void VaString ( const char *  format,
  ... 
)

Print a string into this text object starting at 0,0 and proceeding Left to right. Wraps at newline characters. Does not change the color or any other modes. Replaces the entire string. If substring replacement is desired, use VaString(col, row, format) instead.

Parameters
formatprintf style varargs formatting string.
void VaString ( unsigned int  startCol,
unsigned int  startRow,
const char *  format,
  ... 
)

Print a string into this text object starting at col,row and proceeding Left to right. Assumes current string does not contain newline characters. If a newline is encountered it will be overwritten. Does not change the color or any other modes. Just inserts/overwrites characters. This replaces a substring within the current string. If you want full string replacement use VaString(format)

Parameters
startColX position (column)
startRowY position (row)
formatprintf style varargs formatting string.
void VaString ( unsigned int  col,
unsigned int  row,
unsigned char  rgba[],
const char *  format,
  ... 
)

Print a string into this text object starting at col,row and proceeding Left to right Assumes current string does not contain newline characters. If a newline is encountered it will be overwritten. Inserts/overwrites characters and changes the color. This replaces a substring within the current string. If you want full string replacement use VaString(format) (TextDisplay compatability method)

Parameters
colX position (column)
rowY position (row)
rgbaThe color to set
formatprintf style varargs formatting string.
Since
GL Studio 6.0.1

Member Data Documentation

unsigned int _cols
protected

Number of columns of characters in the text grid (line length)

bool _leftToRight
protected

true to render characters from left to right else false for right to left

bool _perCharAttribs
protected

true -> grid will draw characters using "per character attributes" else false -> all characters will be drawn using the first character's attribute NOTE: This defaults to false and automatically enables to true if the user calls a method that requires per character attributes

RowInfo* _rowInfo
protected

array ( _rows number of elements ) of RowInfo

unsigned int _rows
protected

Number of rows of characters in the text grid (number of lines)

UnicodeString _unicodeText
protected

unicode version of _text from base class, updated by CalculateRowData


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