Python Script Engine  8.3
GL Studio Editor Python Script API
Public Types | Public Member Functions | Static Public Member Functions | List of all members
GlsCTLTextBox Class Reference
+ Inheritance diagram for GlsCTLTextBox:

Public Types

enum  VerticalAlignment_t {
  ALIGN_CENTER ,
  ALIGN_TOP ,
  ALIGN_BOTTOM
}
 
enum  EllipsizeMode_t {
  ELLIPSIZE_MODE_NONE ,
  ELLIPSIZE_MODE_START ,
  ELLIPSIZE_MODE_MIDDLE ,
  ELLIPSIZE_MODE_END
}
 
enum  TextDirection_t {
  TEXT_DIRECTION_LTR ,
  TEXT_DIRECTION_RTL ,
  TEXT_DIRECTION_AUTOMATIC ,
  TEXT_DIRECTION_AUTO_BY_LINE
}
 
enum  ResizeMode_t {
  RESIZE_MODE_FIXED ,
  RESIZE_MODE_AUTO_WIDTH ,
  RESIZE_MODE_AUTO_HEIGHT
}
 
- 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

 GlsCTLTextBox ()
 
 GlsCTLTextBox (GlsCTLTextBox &src)
 
VerticalAlignment_t VerticalAlignment ()
 
None VerticalAlignment (VerticalAlignment_t &verticalAlignment)
 
EllipsizeMode_t EllipsizeMode ()
 
None EllipsizeMode (EllipsizeMode_t &ellipsizeMode)
 
TextDirection_t TextDirection ()
 
None TextHorizontalScale (float &value)
 
float TextHorizontalScale ()
 
None TextVerticalScale (float &value)
 
float TextVerticalScale ()
 
None TextDirection (TextDirection_t &direction)
 
ResizeMode_t ResizeMode ()
 
None ResizeMode (ResizeMode_t &resizeMode)
 
float MaxWidth ()
 
None MaxWidth (float &maxWidth)
 
float MaxHeight ()
 
None MaxHeight (float &maxHeight)
 
None Rebuild ()
 
- 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 GlsCTLTextBox * CastToGlsCTLTextBox (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 create and modify CTL (complex text layout) text box editor objects.

Member Enumeration Documentation

◆ EllipsizeMode_t

enum GlsCTLTextBox::EllipsizeMode_t

The ellipsize mode types.

Enumerator
ELLIPSIZE_MODE_NONE 
ELLIPSIZE_MODE_START 
ELLIPSIZE_MODE_MIDDLE 
ELLIPSIZE_MODE_END 

◆ ResizeMode_t

enum GlsCTLTextBox::ResizeMode_t

Resize mode values.

Enumerator
RESIZE_MODE_FIXED 
RESIZE_MODE_AUTO_WIDTH 
RESIZE_MODE_AUTO_HEIGHT 

◆ TextDirection_t

enum GlsCTLTextBox::TextDirection_t

The text direction types.

TEXT_DIRECTION_LTR - Use Left to Right as the base direction for rendering text. TEXT_DIRECTION_RTL - Use Right to Left as the base direction for rendering text. TEXT_DIRECTION_AUTOMATIC - Determine the base direction for rendering text from the first strongly directioned character. TEXT_DIRECTION_AUTO_BY_LINE - Determine the base direction for rendering text for each individual EOL-seperated line in the text string.

Enumerator
TEXT_DIRECTION_LTR 
TEXT_DIRECTION_RTL 
TEXT_DIRECTION_AUTOMATIC 
TEXT_DIRECTION_AUTO_BY_LINE 

◆ VerticalAlignment_t

enum GlsCTLTextBox::VerticalAlignment_t

The vertical alignment types.

Enumerator
ALIGN_CENTER 
ALIGN_TOP 
ALIGN_BOTTOM 

Constructor & Destructor Documentation

◆ GlsCTLTextBox() [1/2]

GlsCTLTextBox::GlsCTLTextBox ( )

default ructor

◆ GlsCTLTextBox() [2/2]

GlsCTLTextBox::GlsCTLTextBox ( GlsCTLTextBox &  src)

copy ructor

Member Function Documentation

◆ CastToGlsCTLTextBox()

static GlsCTLTextBox * GlsCTLTextBox::CastToGlsCTLTextBox ( DisplayObject *  obj)
static

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

Parameters
objobject to cast
Returns
the GlsCTLTextBox
Exceptions
CEIException

◆ EllipsizeMode() [1/2]

EllipsizeMode_t GlsCTLTextBox::EllipsizeMode ( )

Gets the type of automatic ellipsize if the text does not fit in the boundary.

Returns
The type of automatic ellipsize if the text does not fit in the boundary.

◆ EllipsizeMode() [2/2]

None GlsCTLTextBox::EllipsizeMode ( EllipsizeMode_t &  ellipsizeMode)

Sets the type of automatic ellipsize if the text does not fit in the boundary.

Parameters
[in]ellipsizeModeThe type of automatic ellipsize if the text does not fit in the boundary.

◆ MaxHeight() [1/2]

float GlsCTLTextBox::MaxHeight ( )

Gets the text's maximum height.

Returns
The maximum height for this object's text.

◆ MaxHeight() [2/2]

None GlsCTLTextBox::MaxHeight ( float &  maxHeight)

Sets the text's maximum height.

Parameters
maxHeightThe maximum height to use

◆ MaxWidth() [1/2]

float GlsCTLTextBox::MaxWidth ( )

Gets the text's maximum width.

Returns
The maximum width for this object's text.

◆ MaxWidth() [2/2]

None GlsCTLTextBox::MaxWidth ( float &  maxWidth)

Sets the text's maximum width.

Parameters
maxWidthThe maximum width to use

◆ Rebuild()

None GlsCTLTextBox::Rebuild ( )

Calls Rebuild() on the text's runtime object, triggering resizing behavior.

◆ ResizeMode() [1/2]

ResizeMode_t GlsCTLTextBox::ResizeMode ( )

Gets the resize mode.

Returns
The resize mode for this object's text.

◆ ResizeMode() [2/2]

None GlsCTLTextBox::ResizeMode ( ResizeMode_t &  resizeMode)

Sets the resize mode.

Parameters
resizeModeThe resize mode to use (RESIZE_MODE_FIXED, RESIZE_MODE_AUTO_WIDTH, RESIZE_MODE_AUTO_HEIGHT).

◆ TextDirection() [1/2]

TextDirection_t GlsCTLTextBox::TextDirection ( )

Gets the direction to render the text in.

Returns
the direction to render the text in.

◆ TextDirection() [2/2]

None GlsCTLTextBox::TextDirection ( TextDirection_t &  direction)

Sets the direction to render the text in.

Parameters
[in]directionThe direction to render the text in.

◆ TextHorizontalScale() [1/2]

float GlsCTLTextBox::TextHorizontalScale ( )

Get the horizontal scale.

◆ TextHorizontalScale() [2/2]

None GlsCTLTextBox::TextHorizontalScale ( float &  value)

Scales the text horizontally by the given value.

Text is still clamped by the bounds of the text box

Parameters
valuethe horizontal scale

◆ TextVerticalScale() [1/2]

float GlsCTLTextBox::TextVerticalScale ( )

Get the vertical scale.

◆ TextVerticalScale() [2/2]

None GlsCTLTextBox::TextVerticalScale ( float &  value)

Scales the text vertically by the given value.

Text is still clamped by the bounds of the text box

Parameters
valuethe vertical scale

◆ VerticalAlignment() [1/2]

VerticalAlignment_t GlsCTLTextBox::VerticalAlignment ( )

Get the vertical alignment for this text object.

Returns
The vertical alignment type.

◆ VerticalAlignment() [2/2]

None GlsCTLTextBox::VerticalAlignment ( VerticalAlignment_t &  verticalAlignment)

Set the vertical alignment for this text object.

Parameters
[in]verticalAlignmentThe vertical alignment type.
The documentation for this class was generated from the following file: