TransitionModifierDefinition Struct

Summary

[System.SerializableAttribute] Details about how to modify a transition when it comes from a specific source.
Assembly
Animancer.dll
Namespace
Animancer.TransitionLibraries
Interfaces
Base Types
  • ValueType
graph BT Type-->Base0["ValueType"] Type-.->Interface0["IEquatable<TransitionModifierDefinition>"] Type["TransitionModifierDefinition"] class Type type-node

Syntax

[Serializable]
public struct TransitionModifierDefinition : ValueType, IEquatable<TransitionModifierDefinition>

Remarks

Multiple of these can be used to build a Animancer.TransitionLibraries.TransitionModifierGroup at runtime.

Documentation: Transition Libraries

Attributes

Type Description
SerializableAttribute

Constructors

Name Summary
TransitionModifierDefinition(int, int, float, float) Creates a new Animancer.TransitionLibraries.TransitionModifierDefinition.

Properties

Name Value Summary
FadeDuration float
The fade duration for this modifier to use instead of the transition's default value.
FromIndex int
The index of the source transition in the Animancer.TransitionLibraries.TransitionLibraryDefinition.
NormalizedStartTime float
The normalized start time for this modifier to use instead of the transition's default value.
ToIndex int
The index of the destination transition in the Animancer.TransitionLibraries.TransitionLibraryDefinition.

Methods

Name Value Summary
Equals(Object) bool
Are all fields in this object equal to the equivalent in `obj`?
Equals(TransitionModifierDefinition) bool
Are all fields in this object equal to the equivalent fields in `other`?
GetHashCode() int
Returns a hash code based on the values of this object's fields.
ToString() string
Creates a new string describing this modifier.
ToTransitionDetails() TransitionDetails
Creates a new Animancer.TransitionLibraries.TransitionDetails from this modifier.
Validate() bool
Does this modifier contain valid values?
WithDetails(float, float) TransitionModifierDefinition
Creates a copy of this modifier with the specified Animancer.TransitionLibraries.TransitionModifierDefinition.FadeDuration and Animancer.TransitionLibraries.TransitionModifierDefinition.NormalizedStartTime.
WithFadeDuration(float) TransitionModifierDefinition
Creates a copy of this modifier with the specified Animancer.TransitionLibraries.TransitionModifierDefinition.FadeDuration.
WithIndices(int, int) TransitionModifierDefinition
Creates a copy of this modifier with the specified Animancer.TransitionLibraries.TransitionModifierDefinition.FromIndex and Animancer.TransitionLibraries.TransitionModifierDefinition.ToIndex.
WithNormalizedStartTime(float) TransitionModifierDefinition
Creates a copy of this modifier with the specified Animancer.TransitionLibraries.TransitionModifierDefinition.NormalizedStartTime.

Operators

Name Value Summary
operator !=(TransitionModifierDefinition, TransitionModifierDefinition) bool
operator ==(TransitionModifierDefinition, TransitionModifierDefinition) bool