AppEasy Core SDK  1.5.0
Cross platform mobile and desktop app and game development SDK - The easy way to make apps
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Defines
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes
CzXomlActions_Animation Class Reference
Actions

Implements a collection of animation actions. More...

#include <CzActionsAnimation.h>

Inheritance diagram for CzXomlActions_Animation:
IzXomlAction

List of all members.

Public Types

enum  eActionType {
  Action_PlayTimeline = 0, Action_StopTimeline = 1, Action_PauseTimeline = 2, Action_SetTimeline = 3,
  Action_Max = 4
}

Public Member Functions

 CzXomlActions_Animation (eActionType type)
void Execute (IzXomlResource *source, CzAction *action)
 The main actions executor for animations. All animation specific actions are implemented by this method.

Protected Member Functions

 CzXomlActions_Animation ()

Protected Attributes

eActionType Type

Detailed Description

Implements a collection of animation actions.

The CzXomlActions_Animation class holds Actions (IzXomlAction) that can be carried out on Animation Timelines (CzAnimTimeline). An action is basically a command that tells the animation to do something such as play or pause. For example the PauseTimeline tells the animation timeline to pause playback.

The following actions are supported:

  • PlayTimeline - Plays a timeline
  • StopTimeline - Stops a timeline from playing
  • PauseTimeline - Pauses the timeline playback
  • SetTimeline - Assigns the timeline to an actor or scene

The above actions have the following XOML prototypes:

  • PlayTimeline(timeline-name, actor-or-scene-name(optional))
    • timeline-name - Name of timeline
    • actor-or-scene-name - Scene or actor that contains the timeline
  • StopTimeline(timeline-name, actor-or-scene-name(optional))
    • timeline-name - Name of timeline
    • actor-or-scene-name - Scene or actor that contains the timeline
  • PauseTimeline(timeline-name, actor-or-scene-name(optional))
    • timeline-name - Name of timeline
    • actor-or-scene-name - Scene or actor that contains the timeline
  • SetTimeline(timeline-name, actor-or-scene-name(optional))
    • timeline-name - Name of timeline
    • actor-or-scene-name - Scene or actor that contains the timeline

For more information on the animation system see CzAnim

Member Enumeration Documentation

enum CzXomlActions_Animation::eActionType
Enumerator:
Action_PlayTimeline 
Action_StopTimeline 
Action_PauseTimeline 
Action_SetTimeline 
Action_Max 

Constructor & Destructor Documentation

CzXomlActions_Animation::CzXomlActions_Animation ( ) [inline, protected]
CzXomlActions_Animation::CzXomlActions_Animation ( eActionType  type) [inline]

Member Function Documentation

void CzXomlActions_Animation::Execute ( IzXomlResource *  source,
CzAction *  action 
) [virtual]

The main actions executor for animations. All animation specific actions are implemented by this method.

Parameters:
[in]source- The source of the action
[in]action- The action to execute

Implements IzXomlAction.

Member Data Documentation

eActionType CzXomlActions_Animation::Type [protected]
The documentation for this class was generated from the following files: