Gondwana.Effects.WipeEffect Class Reference

Base implementation shared by directional fill and erase effects. More...

Inheritance diagram for Gondwana.Effects.WipeEffect:

Protected Member Functions
	WipeEffect (EffectDirection direction, float durationSeconds, EasingKind easing, bool isFill)
	Initializes a new instance of the WipeEffect 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
EffectDirection	Direction [get]
	Gets the direction in which the wipe travels.
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.

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.
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 directional fill and erase effects.

Definition at line 8 of file WipeEffects.cs.

Constructor & Destructor Documentation

WipeEffect()

Gondwana.Effects.WipeEffect.WipeEffect ( EffectDirection direction, float durationSeconds, EasingKind easing, bool isFill )

protected

Initializes a new instance of the WipeEffect class.

Parameters

direction	The direction.
durationSeconds	The duration in seconds.
easing	The easing function applied to progress.
isFill	Whether the effect fills the reveal area rather than clearing it.

Definition at line 23 of file WipeEffects.cs.

Member Function Documentation

ApplyProgress()

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

protected

OnStarting()

override void Gondwana.Effects.WipeEffect.OnStarting ( )

protectedvirtual

Captures or prepares target state before the effect starts.

Reimplemented from Gondwana.Effects.DisplayEffect.

Definition at line 46 of file WipeEffects.cs.

RestoreOriginalState()

override void Gondwana.Effects.WipeEffect.RestoreOriginalState ( )

protected

Property Documentation

Direction

EffectDirection Gondwana.Effects.WipeEffect.Direction

get

Gets the direction in which the wipe travels.

Definition at line 38 of file WipeEffects.cs.