TimeSamplesPlayer#

TimeSamplesPlayer Node plays back animation from a source prim tree on a target prim tree.

Installation#

To use this Node, you must enable omni.anim.time_samples_player in the Extension Manager.

Inputs#

Name

Type

Description

Default

targetPrim

target

The root prim of the hierarchy to be receive the sampled values

Start Time (startTime)

double

Start time of the source animation clip (in seconds)

0.0

End Time (endTime)

double

End time of the source animation clip (in seconds)

1.0

Start Range (startRange)

double

Start time of the play range (in seconds)

0.0

End Range (endRange)

double

End time of the play range (in seconds)

1.0

sourcePrim

target

The root prim of the hierarchy to be sampled

useFile

bool

When true, the inputs:filePath attribute is used; otherwise, it will look for the prim on the stage

False

File Path (filePath)

string

Path to USD file containing the source animation

File Source Prim (fileSourcePrim)

path

The root prim of the hierarchy to be sampled when using a source file (inputs:useFile is true)

Play (play)

execution

Resume play from current time

Play from Start (playFromStart)

execution

Play the clip from start

Stop (stop)

execution

Stop playback at current time

Reverse (reverse)

execution

Resume play backward from current time

Reverse from End (reverseFromEnd)

execution

Play the clip backward from the end

Set New Time (setNewTime)

execution

Set playback to the time defined by inputs:newTime

New Time (newTime)

double

New time to set when inputs:setNewTime is triggered (in seconds)

0.0

Repeat (repeat)

uint

Number of times to repeat the playback. 0 means infinite

1

playbackSpeedMultiplier

double

Playback speed multiplier

1.0

Outputs#

Name

Type

Description

Default

Started (started)

execution

The playback has started

Updated (updated)

execution

The node has updated one tick

Finished (finished)

execution

The playback has finished