Transition Class Reference

Base class of animation to be applied to scene. More...

Inheritance diagram for Transition:

List of all members.

Public Member Functions
	Transition ()
	Constructor.
Protected Member Functions
abstract void	OnStart ()
	Start processing.
abstract TransitionUpdateResponse	OnUpdate (float elapsedTime)
	Update processing.
abstract void	OnStop ()
	Stop processing.
ImageAsset	GetCurrentSceneRenderedImage ()
	Generates ImageAsset used for offscreen rendering of CurrentScene.
ImageAsset	GetNextSceneRenderedImage ()
	Generates ImageAsset used for offscreen rendering of NextScene.
Properties
float	TotalElapsedTime [get, set]
	Obtains the time elapsed from the start of the transition.
TransitionDrawOrder	DrawOrder [get, set]
	Obtains and sets the rendering order during a transition.
Scene	NextScene [get]
	Obtains the next scene to be displayed.
RootUIElement	TransitionUIElement [get]
	Obtains the root of the element tree that can only be used during a transition.
Events
EventHandler< EventArgs >	TransitionStopped
	Handler called when a transition ends.

---

Detailed Description

Base class of animation to be applied to scene.

---

Member Function Documentation

ImageAsset GetCurrentSceneRenderedImage

(

)

[protected]

Generates ImageAsset used for offscreen rendering of CurrentScene.

Returns:

Offscreen rendered ImageAsset

ImageAsset GetNextSceneRenderedImage

(

)

[protected]

Generates ImageAsset used for offscreen rendering of NextScene.

Returns:

Offscreen rendered ImageAsset

abstract void OnStart

(

)

[protected, pure virtual]

Start processing.

Implements the start processing with the derived class.

Implemented in CrossFadeTransition, FlipBoardTransition, JumpFlipTransition, PushTransition, SlideTransition, and TiltDropTransition.

abstract void OnStop

(

)

[protected, pure virtual]

Stop processing.

Implements the stop processing with the derived class.

Implemented in CrossFadeTransition, FlipBoardTransition, JumpFlipTransition, PushTransition, SlideTransition, and TiltDropTransition.

abstract TransitionUpdateResponse OnUpdate

(

float

elapsedTime

)

[protected, pure virtual]

Update processing.

Parameters:

elapsedTime

Elapsed time from previous update (ms)

Returns:

Response of transition update

Implements the update processing with the derived class.

Implemented in CrossFadeTransition, FlipBoardTransition, JumpFlipTransition, PushTransition, SlideTransition, and TiltDropTransition.

---

Property Documentation

float TotalElapsedTime [get, set]

Obtains the time elapsed from the start of the transition.

(ms)