Gondwana.Effects.FadeEffect Class Reference

Base implementation shared by fade-in and fade-out effects. More...

Inheritance diagram for Gondwana.Effects.FadeEffect:

Protected Member Functions
	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.

Additional Inherited Members
Public Member Functions inherited from Gondwana.Effects.DisplayEffect
void	Cancel ()
	Cancels the effect and restores the presentation state that existed when it began.
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

Base implementation shared by fade-in and fade-out effects.

Definition at line 8 of file FadeEffects.cs.

Constructor & Destructor Documentation

FadeEffect()

Gondwana.Effects.FadeEffect.FadeEffect ( float targetOpacity, float durationSeconds, EasingKind easing, bool startTransparentWhenOpaque )

protected

Initializes a new instance of the FadeEffect class.

Parameters

targetOpacity	The opacity to reach when the effect completes.
durationSeconds	The duration in seconds.
easing	The easing function applied to progress.
startTransparentWhenOpaque	Whether an initially opaque target starts the effect transparent.

Definition at line 22 of file FadeEffects.cs.

Member Function Documentation

ApplyProgress()

override void Gondwana.Effects.FadeEffect.ApplyProgress ( float progress )

protected

OnStarting()

override void Gondwana.Effects.FadeEffect.OnStarting ( )

protectedvirtual

Captures or prepares target state before the effect starts.

Reimplemented from Gondwana.Effects.DisplayEffect.

Definition at line 39 of file FadeEffects.cs.

RestoreOriginalState()

override void Gondwana.Effects.FadeEffect.RestoreOriginalState ( )

protected