This is the old Animancer v7.4 documentation. Click here for the latest version.

MixerParameterTween<TParameter> Class

Summary

A system which interpolates a Animancer.MixerState`1.Parameter over time.
Assembly
Animancer.dll
Namespace
Animancer
Interfaces
Base Types
Derived Types
graph BT Type-->Base0["Key"] click Base0 "/animancer-v7-4/api/Animancer/Key" Base0-->Base1["Object"] Type-.->Interface0["IUpdatable"] click Interface0 "/animancer-v7-4/api/Animancer/IUpdatable" Type-.->Interface1["Key.IListItem"] click Interface1 "/animancer-v7-4/api/Animancer/IListItem" Type["MixerParameterTween<TParameter>"] class Type type-node Derived0["MixerParameterTweenVector2"]-->Type click Derived0 "/animancer-v7-4/api/Animancer/MixerParameterTweenVector2" Derived1["MixerParameterTweenFloat"]-->Type click Derived1 "/animancer-v7-4/api/Animancer/MixerParameterTweenFloat"

Syntax

public abstract class MixerParameterTween<TParameter> : Key, IUpdatable, Key.IListItem

Examples

See Animancer.MixerParameterTweenFloat.

Type Parameters

Name Description
TParameter

Constructors

Name Summary
MixerParameterTween() Creates a new Animancer.MixerParameterTween`1.
MixerParameterTween(MixerState<TParameter>) Creates a new Animancer.MixerParameterTween`1 and sets the Animancer.MixerParameterTween`1.Mixer.

Fields

Name Constant Value Summary
NotInList -1
The Animancer.Key._Index which indicates that an item isn't in a list.
Inherited from Key
static

Properties

Name Value Summary
Duration float
The amount of time this tween will take (in seconds).
EndValue TParameter
The target value this tween is moving the Animancer.MixerState`1.Parameter towards.
IsActive bool
Is this tween currently being updated?
Mixer MixerState<TParameter>
The target Animancer.MixerState`1.
Progress float
The normalized progress (0 to 1) of this tween towards its goal.
StartValue TParameter
The value of the Animancer.MixerState`1.Parameter when this tween started.
Time float
The amount of time that has passed since the Animancer.MixerParameterTween`1.Start(`0,System.Single) (in seconds).

Methods

Name Value Summary
CalculateCurrentValue() TParameter
Called every update while this tween is active to calculate the what value to set the Animancer.MixerState`1.Parameter to. Usually based on the Animancer.MixerParameterTween`1.StartValue, Animancer.MixerParameterTween`1.EndValue, and Animancer.MixerParameterTween`1.Progress.
IndexOf(Key) int
Returns location of this object in the list (or -1 if it is not currently in a keyed list).
Inherited from Key
static
IsInList(Key) bool
Is the `key` currently in a keyed list?
Inherited from Key
static
Start(TParameter, float) void
Sets the details of this tween and registers it to be updated so that it can apply its effects every frame.
Stop() void
Stops this tween from updating.