Table of Contents

Class AnimationOptions

Namespace
OmegaEngine
Assembly
OmegaEngine.dll

Options controlling an animation.

public record AnimationOptions : IEquatable<AnimationOptions>
Inheritance
object
AnimationOptions
Implements
Derived

Constructors

AnimationOptions(AnimationOptions)

protected AnimationOptions(AnimationOptions original)

Parameters

original AnimationOptions

AnimationOptions(TimeSpan, EasingFunction, bool, bool)

Options controlling an animation.

public AnimationOptions(TimeSpan Duration, EasingFunction EasingFunction = EasingFunction.Sinusoidal, bool EaseIn = true, bool EaseOut = true)

Parameters

Duration TimeSpan

The duration of the complete animation.

EasingFunction EasingFunction

The kind of easing function to use.

EaseIn bool

Whether the animation should be eased in. I.e., start slowly and then speed up.

EaseOut bool

Whether the animation should be eased out. I.e., slow down at the end.

Properties

Duration

The duration of the complete animation.

public TimeSpan Duration { get; init; }

Property Value

TimeSpan

EaseIn

Whether the animation should be eased in. I.e., start slowly and then speed up.

public bool EaseIn { get; init; }

Property Value

bool

EaseOut

Whether the animation should be eased out. I.e., slow down at the end.

public bool EaseOut { get; init; }

Property Value

bool

EasingFunction

The kind of easing function to use.

public EasingFunction EasingFunction { get; init; }

Property Value

EasingFunction

EqualityContract

protected virtual Type EqualityContract { get; }

Property Value

Type

Methods

Deconstruct(out TimeSpan, out EasingFunction, out bool, out bool)

public void Deconstruct(out TimeSpan Duration, out EasingFunction EasingFunction, out bool EaseIn, out bool EaseOut)

Parameters

Duration TimeSpan
EasingFunction EasingFunction
EaseIn bool
EaseOut bool

Equals(AnimationOptions?)

public virtual bool Equals(AnimationOptions? other)

Parameters

other AnimationOptions

Returns

bool

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

PrintMembers(StringBuilder)

protected virtual bool PrintMembers(StringBuilder builder)

Parameters

builder StringBuilder

Returns

bool

ToString()

public override string ToString()

Returns

string

Operators

operator ==(AnimationOptions?, AnimationOptions?)

public static bool operator ==(AnimationOptions? left, AnimationOptions? right)

Parameters

left AnimationOptions
right AnimationOptions

Returns

bool

operator !=(AnimationOptions?, AnimationOptions?)

public static bool operator !=(AnimationOptions? left, AnimationOptions? right)

Parameters

left AnimationOptions
right AnimationOptions

Returns

bool