MovieDef

Scaleform::GFx::FileTypeConstants
    Scaleform::GFx::StateBag
    Scaleform::GFx::Resource
        Scaleform::GFx::MovieDef

Declaration

class MovieDef : public Resource, public StateBag;

Description

MovieDef represents loaded shared data for an SWF movie file. These objects are normally created by Loader::CreateMovie and are shared by all movie instances. If the movie definition is registered in the library during load time (see Loader::LoadConstants flag), loading the same file again will return a pointer to the same cached MovieDef.

Individual movie instances can be created by CreateInstance. Once the instance is created, it is normally initialized with a renderer and used during playback.

Enumerations

Enumeration	Description
FileAttrFlags	SWF 8 File attributes, returned by GetFileAttributes.
VisitResourceMask	Defines a set of resource mask flag bits used by VisitResources.

Methods

Method	Description
CreateInstance	Creates a movie view instance that is used for playback. Each movie instance has its own timeline, animation and ActionScript state.
CreateMemoryContext	Creates a memory context to be passed into CreateInstance for the common movie view heap.
GetBindDataHeap	Gets a pointer to the memory heap used for the allocation of the bound movie data.
GetExporterInfo	Obtains information about the image extraction arguments passed to the 'GFxExport' tool when generating this '.gfx' file.
GetFileAttributes	Returns file attributes for SWF file version 8+, 0 for earlier versions.
GetFileURL	Obtains the file path from which this SWF was loaded.
GetFrameCount	Obtains the number of frames in the root timeline of the movie.
GetFrameRate	Obtains the SWF frame rate.
GetFrameRect	Obtains frame rectangle, in pixels.
GetHeight	Obtains the movie's desired stage height in pixels.
GetImageHeap	Gets a pointer to the memory heap used for images.
GetLoadDataHeap	Gets the pointer to the memory heap used for allocation of loaded movie data.
GetLoadingFrame	Obtains the loading frame of the movie.
GetMetadata	Obtains the metadata content that can be embedded into SWF 8+ files.
GetMovieDataResource	Obtains the movie resources used for the shared movie definition object.
GetResource	Obtains a resource pointer based on an export name; most commonly used to substitute textures.
GetSWFFlags	Obtains the SWF file flags defined by MovieInfo::SWFFlagConstants.
GetVersion	Obtains the SWF version of the movie.
GetWidth	Obtains the movies desired stage width in pixels.
VisitImportedMovies	Enumerates a list of names of external SWF files imported into this movie, calling ImportVisitor::Visit() for each import.
VisitResources	Enumerates resources such as fonts and images used within the MovieDef.
WaitForFrame	Waits until a specified frame of a movie is loaded.
WaitForLoadFinish	Waits until loading of a movie instance is completed.

Structures

Structure	Description
ImportVisitor	ImportVisitor interface class, used for movie enumeration through VisitImportedMovies.
ResourceVisitor	ResourceVisitor abstract class, used to support resource enumeration through VisitResources.

File

GFx_Player.h