CzXomlActions_Scene Class Reference

Implements actions that relate to scenes. More...

#include <CzActionsScene.h>

Inheritance diagram for CzXomlActions_Scene:

List of all members.

Public Types
enum	eActionType {   Action_CallActions = 0, Action_SetCurrentScene = 1, Action_BringtSceneToFront = 2, Action_ChangeScene = 3,   Action_SuspendScene = 4, Action_ResumeScene = 5, Action_HideScene = 6, Action_ShowScene = 7,   Action_KillScene = 8, Action_KillAllScenes = 9, Action_SetAllSceneTimelines = 10, Action_Max = 11 }
Public Member Functions
	CzXomlActions_Scene (eActionType type)
void	Execute (IzXomlResource *source, CzAction *action)
	The main actions executor for scene related actions. All scene specific actions such as SetCurrentScene are implemented by this method.
Protected Member Functions
	CzXomlActions_Scene ()
Protected Attributes
eActionType	Type

---

Detailed Description

Implements actions that relate to scenes.

The CzXomlActions_Scene class holds Actions (IzXomlAction) that deal with scenes such as ChangeScene

The following actions are supported:

• CallActions
• SetCurrentScene
• BringtSceneToFront
• ChangeScene
• SuspendScene
• ResumeScene
• HideScene
• ShowScene
• KillScene
• KillAllScenes
• SetAllSceneTimelines

The above actions have the following XOML prototypes:

• CallActions(actions-list-name, parent-actor-name (optional), parent-scene-name (optional))
  • actions-list-name - Name of actions list to call
  • parent-actor-name - Actor that contains the actions list, if left out then the actor that contains this action will be used
  • parent-scene-name - Scene that contains the actions list, if left out then the scene that contains this action will be used. If parent-actor-name is specified then parent-scene-name becomes the actors container scene. If parent-actor-name and parent-scene-name are not set then global actions list will be searched.
• SetCurrentScene(scene-name)
  • scene-name - Target scene name
• BringtSceneToFront(scene-name)
  • scene-name - Target scene name
• ChangeScene(scene-name)
  • scene-name - Target scene name
• SuspendScene(scene-name)
  • scene-name - Target scene name (uses container scene if not specified)
• ResumeScene(scene-name)
  • scene-name - Target scene name (uses container scene if not specified)
• HideScene(scene-name)
  • scene-name - Target scene name (uses container scene if not specified)
• ShowScene(scene-name)
  • scene-name - Target scene name (uses container scene if not specified)
• KillScene(scene-name)
  • scene-name - Target scene name (uses container scene if not specified)
• KillAllScenes(scene-name)
  • scene-name - Scene to exclude
• SetAllSceneTimelines(timeline-name)
  • timeline-name - Name of timeline to assign to all scenes

For more information on scenes see CzScene

---

Member Enumeration Documentation

enum CzXomlActions_Scene::eActionType

Enumerator:

Action_CallActions
Action_SetCurrentScene
Action_BringtSceneToFront
Action_ChangeScene
Action_SuspendScene
Action_ResumeScene
Action_HideScene
Action_ShowScene
Action_KillScene
Action_KillAllScenes
Action_SetAllSceneTimelines
Action_Max

---

Constructor & Destructor Documentation

CzXomlActions_Scene::CzXomlActions_Scene

(

)

[inline, protected]

CzXomlActions_Scene::CzXomlActions_Scene

(

eActionType

type

)

[inline]

---

Member Function Documentation

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

The main actions executor for scene related actions. All scene specific actions such as SetCurrentScene 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_Scene::Type [protected]

---

The documentation for this class was generated from the following files:

• CzActionsScene.h
• CzActionsScene.cpp