Class StateNode

Namespace: ValveResourceFormat.Animation
Assembly: ValveResourceFormat.dll

public sealed class StateNode : PoseNode

Inheritance

object ← GraphNode ← PoseNode ← StateNode

Inherited Members

PoseNode.LoopCount, PoseNode.Duration, PoseNode.CurrentTime, PoseNode.PreviousTime, PoseNode.PoseTransforms, PoseNode.Instantiate(GraphContext), PoseNode.Initialize(GraphContext, SyncTrackTime), PoseNode.Initialize(GraphContext), PoseNode.IsValid, PoseNode.SyncTrack, PoseNode.Update(GraphContext, SyncTrackTimeRange?), GraphNode.NodeIdx, GraphNode.Instantiate(GraphContext), GraphNode.WasUpdated(GraphContext), GraphNode.MarkNodeActive(GraphContext), GraphNode.IsInitialized, GraphNode.Initialize(GraphContext), GraphNode.Shutdown(GraphContext)

Constructors

StateNode(KVObject)

Reads the StateNode from its KeyValues3 data.

public StateNode(KVObject data)

Parameters

data KVObject

Fields

ElapsedTimeInState

public TimeSpan ElapsedTimeInState

Field Value

TimeSpan

IsFirstStateUpdate

public bool IsFirstStateUpdate

Field Value

bool

Properties

ChildNodeIdx

public short ChildNodeIdx { get; }

Property Value

short

EntryEvents

public StringToken[] EntryEvents { get; }

Property Value

StringToken[]

ExecuteEvents

public StringToken[] ExecuteEvents { get; }

Property Value

StringToken[]

ExitEvents

public StringToken[] ExitEvents { get; }

Property Value

StringToken[]

IsOffState

public bool IsOffState { get; }

Property Value

bool

IsTransitioning

public bool IsTransitioning { get; }

Property Value

bool

IsValid

Whether the node can produce a pose.

public override bool IsValid { get; }

Property Value

bool

LayerBoneMaskNodeIdx

public short LayerBoneMaskNodeIdx { get; }

Property Value

short

LayerRootMotionWeightNodeIdx

public short LayerRootMotionWeightNodeIdx { get; }

Property Value

short

LayerWeightNodeIdx

public short LayerWeightNodeIdx { get; }

Property Value

short

SampledEventRange

The range of events this state appended to the buffer during the current update.

public SampledEventRange SampledEventRange { get; }

Property Value

SampledEventRange

SyncTrack

The sync track for this node's timeline; pass-through nodes forward their child's.

public override SyncTrack SyncTrack { get; }

Property Value

SyncTrack

TimedElapsedEvents

public StateNode.TimedEvent[] TimedElapsedEvents { get; }

Property Value

StateNode.TimedEvent[]

TimedRemainingEvents

public StateNode.TimedEvent[] TimedRemainingEvents { get; }

Property Value

StateNode.TimedEvent[]

TransitioningIn

public bool TransitioningIn { get; }

Property Value

bool

TransitioningOut

public bool TransitioningOut { get; }

Property Value

bool

UseActualElapsedTimeInStateForTimedEvents

public bool UseActualElapsedTimeInStateForTimedEvents { get; }

Property Value

bool

Methods

InitializeInternal(GraphContext, SyncTrackTime)

Resets the node state when it becomes active, starting at the given time.

protected override void InitializeInternal(GraphContext ctx, SyncTrackTime initialTime)

Parameters

ctx GraphContext

initialTime SyncTrackTime

Instantiate(GraphContext)

Wires child node references and definition-derived state. Runs once for every node in array order at graph construction.

public override void Instantiate(GraphContext ctx)

Parameters

ctx GraphContext

SampleStateEvents(GraphContext)

public void SampleStateEvents(GraphContext ctx)

Parameters

ctx GraphContext

SetTransitioningState(TransitionState)

public void SetTransitioningState(StateNode.TransitionState s)

Parameters

s StateNode.TransitionState

ShutdownInternal(GraphContext)

Clears the node state when it becomes inactive.

protected override void ShutdownInternal(GraphContext ctx)

Parameters

ctx GraphContext

StartTransitionIn(GraphContext)

public void StartTransitionIn(GraphContext ctx)

Parameters

ctx GraphContext

StartTransitionOut(GraphContext)

public void StartTransitionOut(GraphContext ctx)

Parameters

ctx GraphContext

StartTransitionOut(GraphContext, bool)

public void StartTransitionOut(GraphContext ctx, bool isZeroDurationTransition)

Parameters

ctx GraphContext

isZeroDurationTransition bool

Update(GraphContext, SyncTrackTimeRange?)

Advances the node and returns its pose, optionally over a sync track range.

public override GraphPoseNodeResult Update(GraphContext ctx, SyncTrackTimeRange? updateRange = null)

Parameters

ctx GraphContext

updateRange SyncTrackTimeRange?

Returns

GraphPoseNodeResult

UpdateLayerContext(GraphContext)

public void UpdateLayerContext(GraphContext ctx)

Parameters

ctx GraphContext