DrawText

Scaleform::GFx::DrawText

Declaration

class DrawText : public RefCountBaseNTS<DrawText, StatMV_Text_Mem>;

Description

DrawText provides external text drawing functionality in Scaleform. Users may use this class in conjunction with DrawTextManager to draw their own text without loading SWF/GFx files.

DrawTextManager::CreateText or DrawTextManager::CreateHtmlText should be used to create an instance of DrawText:

   Ptr<DrawText> ptxt = *pdm->CreateText("FHWEUHF!", RectF(20, 20, 500, 400));

   Ptr<DrawText> ptxt3 = *pdm->CreateHtmlText("<p><FONT size='20'>AB <b>singleline</b><i> CD</i>O", RectF(20, 300, 400, 700));

   Call pdm->Capture() after making the DrawText instance changes.

See DrawText sample for more details on the DrawText API.

Enumerations

Enumeration	Description
AAMode	Supported anti-alias mode types - Anti-alias mode for animation or Anti-alias mode for readability.
Alignment	The horizontal alignment type of the text object. The default alignment of the text is left.
FontStyle	The font style used for formatting the text object.
VAlignment	Vertical alignment type of the text object. The default text alignment is top.
FilterType	Enumeration of supported filters.
FilterFlagsType	Describes the bit flags for filters.

Methods

Method	Description
ClearFilters	Removes all filters from the text.
GetAAMode	Returns the currently set anti-aliasing mode for the text object.
GetAlignment	Returns horizontal text alignment.
GetBackgroundColor	Returns the currently set background color.
GetBorderColor	Returns the currently set border color.
GetDepth	Obtains the current depth of the text object.
GetCxform	Returns the current color transformation matrix used with the text object.
GetHtmlText	Returns currently set text in HTML format.
GetMatrix	Returns the current transformation matrix used with the text object.
GetRect	Returns current view rectangle used.
GetText	Returns currently set text in UTF-8 format.
GetVAlignment	Returns vertical text alignment.
IsMultiline	Determines whether the text is multi-line or single-line.
IsVisible	Determines whether the text is visible or invisible.
IsWordWrap	Determines whether the wordwrap feature is turned on/off for the text object.
SetAAMode	Sets the anti-alias mode for the text object.
SetAlignment	Sets horizontal text alignment.
SetBackgroundColor	Sets color of background under the text.
SetBorderColor	Sets color of border around the text.
SetColor	Sets color (R, G, B, A) to whole text or to a part of text.
SetCxform	Sets color transformation matrix to the text object.
SetDepth	Changes the draw order for the DrawText instance.
SetFont	Sets font to whole text or to a part of text.
SetFontSize	Sets font size to the whole text or to a part of text
SetFontStyle	Sets font style to the whole text or to a part of text.
SetFilters	Sets filters on the text.
SetHtmlText	Parses UTF-8, UCS-2 or String encoded HTML and initializes the text object by the parsed HTML text.
SetMatrix	Sets transformation matrix to the text object.
SetLetterSpacing	Sets letter spacing to whole text or to the part of text in interval [startPos..endPos].
SetMultiline	Sets multi-line or single-line type of the text.
SetRect	Sets view rectangle, coordinates are in pixels.
SetText	Sets the UTF-8, UCS-2, or String text value to the text object.
SetVisible	Sets the visibility property of the text object.
SetUnderline	Sets or clears underline to whole text or to a part of text.
SetVAlignment	Sets vertical text alignment.
SetWordWrap	Turns wordwrapping feature on/off for the text object.

Structures

Structure	Description
Filter	A structure defining a filter.

File

GFx_DrawText.h