DrawTextManager

Scaleform::GFx::FileTypeConstants
    Scaleform::GFx::StateBag
        Scaleform::GFx::DrawTextManager

Declaration

class DrawTextManager : public RefCountBaseNTS<DrawTextManager, Stat_Default_Mem>, public StateBag;

Description

DrawTextManager class manages the DrawText objects. DrawTextManager should be used for creation of DrawText objects. It also may be used to measure text extents.

One DrawTextManager instance may be used to manage (create, measure, render) multiple DrawText instances.

There are 3 ways to create DrawTextManager: using default constructor, passing pointer on MovieDef, and passing pointer on Loader /GFxStateBag:

 Ptr<DrawTextManager> pdtm = *new DrawTextManager();

Loader loader;
...
Ptr<MovieDef> pmd = *loader.CreateMovie("fonts.swf");
Ptr<DrawTextManager> pdtm = *new DrawTextManager(pmd);

Loader loader;
...
Ptr<DrawTextManager> pdtm = *new DrawTextManager(&loader);

In the case #2 all created DrawText instances will be able to use all fonts defined by the loaded "fonts.swf".

In the case #3 DrawTextManager will inherit all states (log, font cache manager, etc) from the loader.

Methods

Method	Description
Capture	Captures the current DrawText state.
CreateHtmlText	Creates and initializes a DrawText object using the specified HTML.
CreateText	Creates an empty DrawText object.
CreateText	Creates and initializes a DrawText object using plain text.
SetCaptureThread	Sets the expected thread the Capture function will be called from.
DrawTextManager	DrawTextManager constructor.
GetDisplayHandle	Returns a display handle that should be passed to the render thread and used for text rendering.
GetDefaultTextParams	Returns the currently set default text parameters.
GetHtmlTextExtent	Returns size of the text rectangle that would be necessary to render the specified HTML text.
GetTextExtent	Returns the size of the text rectangle that would be necessary to render the specified text.
IsShutdownRenderingComplete	Returns true once rendering has been shut down after ShutdownRendering call.
SetDefaultTextParams	Sets default text parameters. If optional 'ptxtParams' parameter for CreateText is not specified, then these default parameters will be used.
SetViewport	Sets the viewport dimensions for DrawText instances being displayed.
ShutdownRendering	Shuts down rendering of the movie.
SwapDepths	Swaps the depth of the current text with the depth of another text.

Structures

Structure	Description
TextParams	A structure which defines the parameters of the newly created text.

File

GFx_DrawText.h