Movie

Scaleform::GFx

Scaleform::GFx::FileTypeConstants
    Scaleform::GFx::StateBag
        Scaleform::GFx::Movie

Declaration

class Movie : public RefCountBase<Movie, StatMV_Other_Mem>, public StateBag;

Description

Movie class provides the client program's interface to a playing instance of a movie clip; i.e., an independent movie with a separate timeline animation state. Movie is created by the MovieDef::CreateInstance function and is a primary user interface to a movie instance. After being created, Movie is normally configured by setting the renderer, viewport, and fscommand callback, if necessary.

After such setup the movie is ready for playback. Its animation state can be advanced by calling Advance and it can be rendered at by calling GetDisplayHandle.

In GFx, a movie snapshot is a captured state of a movie at a given point in time. By default, a snapshot is captured automatically at the end of the GFx::Movie::Advance call; it can also be captured explicitly by calling GFx::Movie::Capture. Once a snapshot is captured, its frame state becomes available for the render thread, while being stored separately from the dynamic state of the movie. When drawing a frame, the render thread calls NextCapture on a movie handle to grab the most recent snapshot and use it in rendering.

Enumerations

Enumeration	Description
AlignType	Alignment type used for the SWF file stage, corresponds to Stage.align property in ActionScript.
HE_ReturnValueType	An enumeration that defines bits in the returning value from HandleEvent method.
HitTestType	HitTestType describes the type of hit testing performed by the HitTest function.
GCFlags	Flags used to control the speed of GC.
ReportFlags	Flags used for the objects report.
ScaleModeType	Scaling mode used for the SWF file stage, corresponds to Stage.scaleMode property in ActionScript.
SetArrayType	Type of array being set.
SetVarType	Describes the delayed assignment queuing behavior within SetVariable calls.

Methods

Method	Description
Advance	Advances the movie based on the time that has passed since the last advance call.
Capture	Explicitly forces a render tree Capture, making it available for the render thread.
CreateArray	Creates an instance of an ActionScript Array object.
CreateFunction	Creates a function object that wraps a C++ function.
CreateObject	Creates an instance of ActionScript Object.
CreateString	Creates strings that are managed by ActionScript runtime.
CreateStringW	Creates wide character strings that are managed by ActionScript runtime.
ForceCollectGarbage	Used to force garbage collector execution by the user's application.
ForceUpdateImages	Forces render tree to be updated in order to apply all possible changes related to images and/or textures.
GetASTimerMs	Returns timer value, in milliseconds.
GetAVMVersion	Returns the version number of the AVM used in the movie clip.
GetBackgroundAlpha	Obtains the background color alpha applied to the movie clip.
GetControllerCount	Returns the number of controllers in the application for input and layout management.
GetControllerFocusGroup	Returns the focus group index associated with the specified controller.
GetCurrentFrame	Obtains the currently active frame of the movie, starting with 0.
GetDirtyFlag	Returns and optionally resets the "dirty flag" that indicates whether anything was changed on the stage (and needs to be re-rendered) or not.
GetDisplayHandle	Returns a display handle that should be passed to the render thread and used for movie rendering.
GetEdgeAAMode	Returns the configured EdgeAA mode used for the root of the render tree, which typically controls all of the movie.
GetFPS
GetFrameCount	Obtains the total number of frames in this movie clip.
GetFrameRate	Obtains the frame rate of the movie clip.
GetHeap	Obtains the memory heap allocated for the movie view object.
GetMouseCursorCount	Gets the number of supported mouse cursors.
GetMouseState	Retrieves the mouse state, such as coordinates and buttons state.
GetMovieDef	Obtains the movie definition that created this instance.
GetPlayState	Obtains the play state of the movie clip, currently either Playing or Stopped.
GetProjectionMatrix3D	Obtains the projection matrix set on a 3D movieclip.
GetRenderPixelScale	Describes the scale of a single pixel to the renderer.
GetSafeRect	Obtains the safe rectangle, in pixels.
GetStats	Obtains statistics for the movie view and performs a reset for tracked counters.
GetUserData	Obtains the user data handle set on the movie view.
GetVariable	Obtains the value of an ActionScript variable based on its path.
GetVariableArray	Populates a buffer with results from an ActionScript array.
GetVariableArraySize	Returns the size of array buffer necessary for GetVariableArray.
GetVariableDouble	Obtains the value of an ActionScript variable as a Double based on its path.
GetViewAlignment	Gets the current alignment mode for the movie.
GetViewMatrix3D	Obtains the view matrix set on a 3D movieclip.
GetViewport	Obtains the render-target surface viewport to which the movie is scaled.
GetViewScaleMode	Obtains the current scale mode for the movie.
GetVisible	Obtains the visibility state of a movie clip.
GetVisibleFrameRect	Obtains the currently visible rectangle.
GotoFrame	Moves a playhead to a specified frame.
GotoLabeledFrame	Moves a playhead to a specified frame identified by a label.
HandleEvent	Notifies the movie view that a certain event, such as input action, character event etc has occured.
HasLooped	Determines whether the movie clip has looped past its last frame.
HitTest	Determines whether a given viewport coordinate falls within a SWF file drawn component or not.
Invoke	Calls an ActionScript method on the movie clip.
InvokeArgs	Invokes an ActionScript method on the movie clip using a format string followed by a variable argument list.
IsAvailable	Checks for availability of a field, method, or nested clip.
IsExitRequested	Determines whether exit was requested by ActionScript.
IsMovieFocused	Determines if the movie has focus or not.
IsPaused	Determines if the movie is paused or not.
IsShutdownRenderingComplete	Returns true once rendering has been shut down after ShutdownRendering call.
IsValid	Returns whether or not the movie was instantiated by a correctly-licensed Scaleform instance.
MakeAreaVisible	Scrolls viewport to make 'box' fully visible inside the 'screenRect'.
Movie	Initializes Movie instance.
NotifyMouseState	Notifies the movie view that a mouse state has changed.
PrintObjectsReport	Prints out a report about objects and links between them.
Release	Releases the heap and the resources allocated for movie views.
ResetInputFocus	Resets input focus the the specified controller.
Restart	Restarts the movie from the beginning.
RestoreViewport	Restores viewport matrix changed by MakeAreaVisible to its original state.
ScheduleGC	Schedules garbage collection.
SetBackgroundAlpha	Sets the background color alpha applied to the movie clip.
SetBackgroundColor	Sets the background color drawn underneath the movie clip.
SetCaptureThread	Sets the expected thread the Capture function will be called from.
SetControllerCount	Sets the number of keyboard/controllers used in the application for input and layout management.
SetControllerFocusGroup	Associates a controller with a focus group.
SetEdgeAAMode	Configures the EdgeAA mode used for the root of the render tree, which typically controls all of the movie.
SetExternalInterfaceRetVal	Sets where to return a Value from an External Interface call.
SetMouseCursorCount	Sets the number of supported mouse cursors.
SetFPS
SetPause	Pauses/resumes the playback of the movie.
SetPlayState	Changes playback state of the movie, allowing animation to be paused and resumed.
SetProjectionMatrix3D	Sets the projection matrix for a 3D movieclip.
SetSafeRect	Sets the safe rectangle, in pixels.
SetStageAutoOrients	Sets the stage orientation flag.
SetUserData	Sets the user data handle for the movie view.
SetVariable	Sets a variable identified by a path to a new value, specified in UTF-8 encoding.
SetVariableArray	Sets array elements in specified range to data items of specified type.
SetVariableArraySize	Sets the size of the array.
SetVariableDouble	Sets a variable identified by a path to a new value, specified as a Double.
SetViewAlignment	Sets the current alignment mode for the movie.
SetViewMatrix3D	Sets the view matrix for a 3D movie clip.
SetViewport	Sets the render-target surface viewport to which the movie is scaled.
SetViewScaleMode	Sets the current scale mode for the movie.
SetVisible	Sets the visibility state of a movie clip.
ShutdownRendering	Shuts down rendering of the movie
SuspendGC	Suspends/resumes garbage collection.
TranslateLocalToScreen	Translates the point in character's coordinate space to the point on screen (window).
TranslateToScreen	Translates the point/rectangle in Flash coordinates to screen (window) coordinates.

Topics

Topic	Description
BitFlags	BitFlags used in MakeAreaVisible method.

File

GFx_Player.h