Class OffsetTypePowerEnum

Namespace

TMPEffects.Parameters

[Serializable]
public class OffsetTypePowerEnum : PowerEnum<TMPParameterTypes.OffsetType, TMPOffsetProvider>, IEquatable<OffsetTypePowerEnum>, ITMPOffsetProvider

Inheritance

object

PowerEnum<TMPParameterTypes.OffsetType, TMPOffsetProvider>

OffsetTypePowerEnum

Implements

IEquatable<OffsetTypePowerEnum>

ITMPOffsetProvider

Inherited Members

PowerEnum<TMPParameterTypes.OffsetType, TMPOffsetProvider>.Value

PowerEnum<TMPParameterTypes.OffsetType, TMPOffsetProvider>.EnumValue

PowerEnum<TMPParameterTypes.OffsetType, TMPOffsetProvider>.UseCustom

PowerEnum<TMPParameterTypes.OffsetType, TMPOffsetProvider>.useCustom

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

OffsetTypePowerEnum()

public OffsetTypePowerEnum()

OffsetTypePowerEnum(OffsetType)

public OffsetTypePowerEnum(TMPParameterTypes.OffsetType offsetType)

Parameters

offsetType TMPParameterTypes.OffsetType

OffsetTypePowerEnum(OffsetType, TMPOffsetProvider)

public OffsetTypePowerEnum(TMPParameterTypes.OffsetType offsetType, TMPOffsetProvider customOffsetProvider)

Parameters

offsetType TMPParameterTypes.OffsetType

customOffsetProvider TMPOffsetProvider

OffsetTypePowerEnum(OffsetType, TMPOffsetProvider, bool)

public OffsetTypePowerEnum(TMPParameterTypes.OffsetType offsetType, TMPOffsetProvider customOffsetProvider, bool useCustom)

Parameters

offsetType TMPParameterTypes.OffsetType

customOffsetProvider TMPOffsetProvider

useCustom bool

Methods

Equals(object)

Determines whether the specified object is equal to the current object.

public override bool Equals(object obj)

Parameters

obj object

The object to compare with the current object.

Returns

bool

true if the specified object is equal to the current object; otherwise, false.

Equals(OffsetTypePowerEnum)

Indicates whether the current object is equal to another object of the same type.

public bool Equals(OffsetTypePowerEnum other)

Parameters

other OffsetTypePowerEnum

An object to compare with this object.

Returns

bool

true if the current object is equal to the other parameter; otherwise, false.

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int

A hash code for the current object.

GetMinMaxOffset(out float, out float, ITMPSegmentData, IAnimatorDataProvider, bool)

Get the minimum / maximum offset for the given segment.

public void GetMinMaxOffset(out float min, out float max, ITMPSegmentData segmentData, IAnimatorDataProvider animatorData, bool ignoreAnimatorScaling = false)

Parameters

min float

The output parameter that will contain the minimum offset.

max float

The output parameter that will contain the maximum offset.

segmentData ITMPSegmentData

The relevant segment data.

animatorData IAnimatorDataProvider

The relevant animator data.

ignoreAnimatorScaling bool

Whether to ignore the animator's scaling.

GetOffset(CharData, ITMPSegmentData, IAnimatorDataProvider, bool)

Get a timing offset for the given character.

public float GetOffset(CharData cData, ITMPSegmentData segmentData, IAnimatorDataProvider animatorData, bool ignoreAnimatorScaling = false)

Parameters

cData CharData

The character to get an offset for.

segmentData ITMPSegmentData

The relevant segment data.

animatorData IAnimatorDataProvider

The relevant animator data.

ignoreAnimatorScaling bool

Whether to ignore the animator's scaling.

Returns

float

A timing offset (to be used, for example, with Wave).