Class AnimatorContext

Namespace

TMPEffects.Components.Animator

Assembly

TMPEffects.dll

To be used with TMPAnimator.
Contains context data of the respective TMPAnimator.

[Serializable]
public class AnimatorContext : IAnimatorContext

Inheritance

object

AnimatorContext

Implements

IAnimatorContext

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

AnimatorContext()

public AnimatorContext()

AnimatorContext(TMPAnimator)

public AnimatorContext(TMPAnimator animator)

Parameters

animator TMPAnimator

AnimatorContext(TMPAnimator, bool, bool, bool, Func<int, float>, Func<int, float>)

public AnimatorContext(TMPAnimator animator, bool scaleAnimations, bool useScaledTime, bool scaleUniformly, Func<int, float> getVisibleTime, Func<int, float> getStateTime)

Parameters

animator TMPAnimator

scaleAnimations bool

useScaledTime bool

scaleUniformly bool

getVisibleTime Func<int, float>

getStateTime Func<int, float>

Fields

_StateTime

[NonSerialized]
[HideInInspector]
public Func<int, float> _StateTime

Field Value

Func<int, float>

_VisibleTime

[NonSerialized]
[HideInInspector]
public Func<int, float> _VisibleTime

Field Value

Func<int, float>

deltaTime

[NonSerialized]
[HideInInspector]
public float deltaTime

Field Value

float

passed

[NonSerialized]
[HideInInspector]
public float passed

Field Value

float

Properties

Animator

The animating TMPAnimator.

public TMPAnimator Animator { get; set; }

Property Value

TMPAnimator

DeltaTime

The current delta time (=> time since last animation update).

public float DeltaTime { get; set; }

Property Value

float

PassedTime

The time that has passed since the animator began animating.

public float PassedTime { get; set; }

Property Value

float

ScaleAnimations

Whether animations are scaled.

public bool ScaleAnimations { get; set; }

Property Value

bool

ScaleUniformly

Whether to scale animations uniformly (based on the default font size of the animator) or on a per character basis.
Ignored if ScaleAnimations is false.

public bool ScaleUniformly { get; set; }

Property Value

bool

UseScaledTime

Whether animations use scaled time.

public bool UseScaledTime { get; set; }

Property Value

bool

Methods

StateTime(int)

Check how long the CharData at the given index has been in its current VisibilityState.
Generally, to be used with show and hide animations.

public float StateTime(int index)

Parameters

index int

The index of the character to check.

Returns

float

How long the CharData at the given index has been in its current VisibilityState.

StateTime(CharData)

Check how long the passed CharData has been in its current VisibilityState.
Generally, to be used with show and hide animations.

public float StateTime(CharData cData)

Parameters

cData CharData

The character to check.

Returns

float

How long the passed CharData has been in its current VisibilityState.

VisibleTime(int)

Check how long the CharData at the given index has been visible.

public float VisibleTime(int index)

Parameters

index int

Returns

float

How long the CharData at the given index has been visible.

VisibleTime(CharData)

Check how long the passed CharData has been visible.

public float VisibleTime(CharData cData)

Parameters

cData CharData

The character to check.

Returns

float

How long the passed CharData has been visible.