Gondwana.Effects.FadeOutEffect Class Reference

Fades a View or SceneLayer to fully transparent. More...

Inheritance diagram for Gondwana.Effects.FadeOutEffect:

Public Member Functions
	FadeOutEffect (float durationSeconds, EasingKind easing=EasingKind.Linear)
	Creates a fade-out effect.
Public Member Functions inherited from Gondwana.Effects.DisplayEffect
void	Cancel ()
	Cancels the effect and restores the presentation state that existed when it began.

Additional Inherited Members
Protected Member Functions inherited from Gondwana.Effects.FadeEffect
	FadeEffect (float targetOpacity, float durationSeconds, EasingKind easing, bool startTransparentWhenOpaque)
	Initializes a new instance of the FadeEffect class.
override void	OnStarting ()
	Captures or prepares target state before the effect starts.
override void	ApplyProgress (float progress)
override void	RestoreOriginalState ()
Protected Member Functions inherited from Gondwana.Effects.DisplayEffect
	DisplayEffect (float durationSeconds, EasingKind easing=EasingKind.Linear)
	Initializes a new instance of the DisplayEffect class.
TTarget	GetTarget< TTarget > ()
	Gets the effect target as the requested reference type.
void	ApplyProgress (float progress)
	Applies the eased effect progress to the target.
virtual void	OnCompleted ()
	Runs the effect-specific completion behavior.
void	RestoreOriginalState ()
	Restores the target state captured when the effect started.
Properties inherited from Gondwana.Effects.DisplayEffect
Guid	Id = Guid.NewGuid() [get]
	Gets the effect's unique identifier.
float	DurationSeconds [get]
	Gets the requested effect duration in seconds.
EasingKind	Easing [get]
	Gets the easing curve used to transform normalized progress.
EffectStatus	Status = EffectStatus.Pending [get]
	Gets the current lifecycle state.
float	Progress [get]
	Gets the normalized, uneased progress in the range 0 through 1.
Events inherited from Gondwana.Effects.DisplayEffect
Action< DisplayEffect >?	Completed
	Occurs when the effect reaches its requested duration.
Action< DisplayEffect >?	Cancelled
	Occurs when the effect is cancelled or replaced.

Detailed Description

Fades a View or SceneLayer to fully transparent.

Definition at line 75 of file FadeEffects.cs.

Constructor & Destructor Documentation

FadeOutEffect()

Gondwana.Effects.FadeOutEffect.FadeOutEffect	(	float	durationSeconds,
		EasingKind	easing = EasingKind::Linear )

Creates a fade-out effect.

Parameters

durationSeconds	The duration in seconds.
easing	The easing function applied to progress.

Definition at line 80 of file FadeEffects.cs.