Gondwana.Effects.EffectsManager Class Reference

Owns and advances display effects for one RenderSurfaceHost. More...

Inheritance diagram for Gondwana.Effects.EffectsManager:

Public Member Functions
TEffect	Run< TEffect > (View target, TEffect effect)
	Starts an effect targeting a View owned by this render surface.
TEffect	Run< TEffect > (SceneLayer target, TEffect effect)
	Starts an effect targeting a SceneLayer in the currently bound Scene.
void	Cancel (DisplayEffect effect)
	Cancels a running effect and restores its original presentation state.
void	CancelAll ()
	Cancels every running effect owned by this manager.
void	Dispose ()

Properties
ReadOnlyCollection< DisplayEffect >	ActiveEffects [get]
	Gets a snapshot of the effects that are currently running.

Detailed Description

Owns and advances display effects for one RenderSurfaceHost.

Definition at line 12 of file EffectsManager.cs.

Member Function Documentation

Cancel()

void Gondwana.Effects.EffectsManager.Cancel

(

DisplayEffect

effect

)

Cancels a running effect and restores its original presentation state.

Parameters

effect

The effect.

Definition at line 51 of file EffectsManager.cs.

CancelAll()

void Gondwana.Effects.EffectsManager.CancelAll

(

)

Cancels every running effect owned by this manager.

Definition at line 67 of file EffectsManager.cs.

Dispose()

void Gondwana.Effects.EffectsManager.Dispose

(

)

Definition at line 206 of file EffectsManager.cs.

Run< TEffect >() [1/2]

TEffect Gondwana.Effects.EffectsManager.Run< TEffect >	(	SceneLayer	target,
		TEffect	effect )

Starts an effect targeting a SceneLayer in the currently bound Scene.

Template Parameters

TEffect

The type of effect.

Parameters

target	The target.
effect	The effect.

Returns

The supplied effect, registered with this manager and started on the target.

Type Constraints

TEffect

:

DisplayEffect

Run< TEffect >() [2/2]

TEffect Gondwana.Effects.EffectsManager.Run< TEffect >	(	View	target,
		TEffect	effect )

Starts an effect targeting a View owned by this render surface.

Template Parameters

TEffect

The type of effect.

Parameters

target	The target.
effect	The effect.

Returns

The supplied effect, registered with this manager and started on the target.

Type Constraints

TEffect

:

DisplayEffect

Property Documentation

ActiveEffects

ReadOnlyCollection<DisplayEffect> Gondwana.Effects.EffectsManager.ActiveEffects

get

Gets a snapshot of the effects that are currently running.

Definition at line 24 of file EffectsManager.cs.