AnimationContextEventBase

interludesoftware.tick

Interlude.Tick

AnimationContextEventBase Class

public abstract class AnimationContextEventBase

Inheritance System.Object → AnimationContextEventBase

Derived
↳ AnimationContextEnter
↳ AnimationContextEvent
↳ AnimationContextInit
↳ AnimationContextLeave

Constructors

AnimationContextEventBase(AnimationContext, bool) Constructor

Initializes the event with its owning context.

public AnimationContextEventBase(Interlude.Tick.AnimationContext context, bool shouldCreateProperties);

Parameters

context AnimationContext

The parent animation context.

shouldCreateProperties System.Boolean

When true, named property accessors create missing properties on demand (used by Init events).

Properties

AnimationContextEventBase.Context Property

The parent AnimationContext that owns this event.

public Interlude.Tick.AnimationContext Context { get; }

Property Value

AnimationContext

Methods

AnimationContextEventBase.Color() Method

Returns the primary color property of the parent context.

public Interlude.Tick.AnimationContextProperty<Color> Color();

Returns

Interlude.Tick.AnimationContextProperty<UnityEngine.Color>

AnimationContextEventBase.Color(string) Method

Returns the named color property, creating it when this is an Init event.

public Interlude.Tick.AnimationContextProperty<Color> Color(string id);

Parameters

id System.String

Name of the property; used as a dictionary key to retrieve or create it.

Returns

Interlude.Tick.AnimationContextProperty<UnityEngine.Color>

AnimationContextEventBase.Done() Method

Ends the fluent event chain and returns the parent AnimationContext.

public Interlude.Tick.AnimationContext Done();

Returns

AnimationContext

AnimationContextEventBase.Float() Method

Returns the primary float property of the parent context.

public Interlude.Tick.AnimationContextProperty<float> Float();

Returns

Interlude.Tick.AnimationContextProperty<System.Single>

AnimationContextEventBase.Float(string) Method

Returns the named float property, creating it when this is an Init event.

public Interlude.Tick.AnimationContextProperty<float> Float(string id);

Parameters

id System.String

Name of the property; used as a dictionary key to retrieve or create it.

Returns

Interlude.Tick.AnimationContextProperty<System.Single>

AnimationContextEventBase.GetActive() Method

Returns whether this event is currently active.

public bool GetActive();

Returns

System.Boolean

AnimationContextEventBase.GetLastActive() Method

Returns whether this event was active on the previous frame.

public bool GetLastActive();

Returns

System.Boolean

AnimationContextEventBase.GetTimeSince(InteractivityState) Method

Seconds elapsed since this event last became active, measured in scaled time. Override per event type.

public virtual float GetTimeSince(Interlude.Tick.InteractivityState state);

Parameters

state Interlude.Tick.InteractivityState

Returns

System.Single

AnimationContextEventBase.GetUnscaledTimeSince(InteractivityState) Method

Seconds elapsed since this event last became active, measured in unscaled time. Override per event type.

public virtual float GetUnscaledTimeSince(Interlude.Tick.InteractivityState state);

Parameters

state Interlude.Tick.InteractivityState

Returns

System.Single

AnimationContextEventBase.HasBecomeActive() Method

Returns true on the first frame the event transitions from inactive to active.

public bool HasBecomeActive();

Returns

System.Boolean

AnimationContextEventBase.HasBecomeInactive() Method

Returns true on the first frame the event transitions from active to inactive.

public bool HasBecomeInactive();

Returns

System.Boolean

AnimationContextEventBase.Int() Method

Returns the primary int property of the parent context.

public Interlude.Tick.AnimationContextProperty<int> Int();

Returns

Interlude.Tick.AnimationContextProperty<System.Int32>

AnimationContextEventBase.Int(string) Method

Returns the named int property, creating it when this is an Init event.

public Interlude.Tick.AnimationContextProperty<int> Int(string id);

Parameters

id System.String

Name of the property; used as a dictionary key to retrieve or create it.

Returns

Interlude.Tick.AnimationContextProperty<System.Int32>

AnimationContextEventBase.Rect() Method

Returns the primary rect property of the parent context.

public Interlude.Tick.AnimationContextProperty<Rect> Rect();

Returns

Interlude.Tick.AnimationContextProperty<UnityEngine.Rect>

AnimationContextEventBase.Rect(string) Method

Returns the named rect property, creating it when this is an Init event.

public Interlude.Tick.AnimationContextProperty<Rect> Rect(string id);

Parameters

id System.String

Name of the property; used as a dictionary key to retrieve or create it.

Returns

Interlude.Tick.AnimationContextProperty<UnityEngine.Rect>

AnimationContextEventBase.Rotate() Method

Returns the primary rotate property of the parent context.

public Interlude.Tick.AnimationContextProperty<float> Rotate();

Returns

Interlude.Tick.AnimationContextProperty<System.Single>

AnimationContextEventBase.Scale() Method

Returns the primary scale property of the parent context.

public Interlude.Tick.AnimationContextProperty<float> Scale();

Returns

Interlude.Tick.AnimationContextProperty<System.Single>

AnimationContextEventBase.SetActive(bool) Method

Records whether this event was active last frame and sets the current active state.

public void SetActive(bool active);

Parameters

active System.Boolean

AnimationContextEventBase.UpdateInteractivityState(InteractivityState) Method

Updates timing fields in state when the event transitions. Override per event type.

public virtual void UpdateInteractivityState(ref Interlude.Tick.InteractivityState state);

Parameters

state Interlude.Tick.InteractivityState