Class ClipNode

Namespace: ValveResourceFormat.Animation
Assembly: ValveResourceFormat.dll

public class ClipNode : ClipReferenceNode

Inheritance

object ← GraphNode ← PoseNode ← ClipReferenceNode ← ClipNode

Inherited Members

ClipReferenceNode.GetClip(GraphContext), ClipReferenceNode.IsLooping, ClipReferenceNode.DisableRootMotionSampling(), ClipReferenceNode.SelectedOption, ClipReferenceNode.UpdateSelection(GraphContext), ClipReferenceNode.InitializeSelection(GraphContext, SyncTrackTime), ClipReferenceNode.ShutdownSelection(GraphContext), ClipReferenceNode.Update(GraphContext, SyncTrackTimeRange?), PoseNode.UpdateSourceOrDefault(GraphContext, PoseNode, SyncTrackTimeRange?), PoseNode.LoopCount, PoseNode.Duration, PoseNode.CurrentTime, PoseNode.PreviousTime, PoseNode.PoseTransforms, PoseNode.Instantiate(GraphContext), PoseNode.Initialize(GraphContext, SyncTrackTime), PoseNode.Initialize(GraphContext), PoseNode.InitializeInternal(GraphContext), PoseNode.InitializeInternal(GraphContext, SyncTrackTime), 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), GraphNode.InitializeInternal(GraphContext), GraphNode.ShutdownInternal(GraphContext)

Constructors

ClipNode(KVObject)

Reads the ClipNode from its KeyValues3 data.

public ClipNode(KVObject data)

Parameters

data KVObject

Fields

Clip

public GraphClip? Clip

Field Value

GraphClip?

PlayInReverseValueNode

public BoolValueNode? PlayInReverseValueNode

Field Value

BoolValueNode?

ResetTimeValueNode

public BoolValueNode? ResetTimeValueNode

Field Value

BoolValueNode?

Properties

AllowLooping

public bool AllowLooping { get; }

Property Value

bool

DataSlotIdx

public short DataSlotIdx { get; }

Property Value

short

GraphEvents

public StringToken[] GraphEvents { get; }

Property Value

StringToken[]

IsLooping

public override bool IsLooping { get; }

Property Value

bool

IsValid

Whether the node can produce a pose.

public override bool IsValid { get; }

Property Value

bool

PlayInReverseValueNodeIdx

public short PlayInReverseValueNodeIdx { get; }

Property Value

short

ResetTimeValueNodeIdx

public short ResetTimeValueNodeIdx { get; }

Property Value

short

SampleRootMotion

public bool SampleRootMotion { get; }

Property Value

bool

SpeedMultiplier

public float SpeedMultiplier { get; }

Property Value

float

StartSyncEventOffset

public int StartSyncEventOffset { get; }

Property Value

int

SyncTrack

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

public override SyncTrack SyncTrack { get; }

Property Value

SyncTrack

Methods

DisableRootMotionSampling()

public override void DisableRootMotionSampling()

GetClip(GraphContext)

public override GraphClip? GetClip(GraphContext ctx)

Parameters

ctx GraphContext

Returns

GraphClip?

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

SampleEventsInRange(GraphContext, short, GraphClip, float, float, bool, float, bool, bool)

Samples every clip event whose time range overlaps [rangeFrom, rangeTo), with the trailing edge included at the very end of the clip.

public static void SampleEventsInRange(GraphContext ctx, short nodeIdx, GraphClip clip, float rangeFrom, float rangeTo, bool includeEnd, float sampleEndTime, bool playInReverse, bool isFromActiveBranch)

Parameters

ctx GraphContext

nodeIdx short

clip GraphClip

rangeFrom float

rangeTo float

includeEnd bool

sampleEndTime float

playInReverse bool

isFromActiveBranch bool

ShutdownInternal(GraphContext)

Clears the node state when it becomes inactive.

protected override void ShutdownInternal(GraphContext ctx)

Parameters

ctx GraphContext

TryGetFrameSnapMode(in SampledEvent, out FrameSnapEventMode)

public static bool TryGetFrameSnapMode(in SampledEvent sampledEvent, out FrameSnapEventMode mode)

Parameters

sampledEvent SampledEvent

mode FrameSnapEventMode

Returns

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

UpdateSelection(GraphContext)

public override void UpdateSelection(GraphContext ctx)

Parameters

ctx GraphContext