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
time	`double`	Override the use of real time and use this value instead if there is a connection to it. If there is not a connection to this input, real time will be used. Either way time is used to compute how much time has elapsed since play began. The actual value does not matter. But the value must be increasing.
New Time (newTime)	`double`	Time to set when ‘applyNewTime’ is triggered
Source (source)	`token`	Option to select to use source prim from the USD stage or the USD file specified by ‘filePath’	USD File
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
Apply New Time (applyNewTime)	`execution`	Set playback to the time defined by inputs:time
Play Count (playCount)	`uint`	Number of times to play the time-samples animation. 0 means infinite	1
playbackSpeedMultiplier	`double`	Playback speed multiplier	1.0
Only Simulate On Play (onlyPlayback)	`bool`	When true, the node is only computed while Stage is being played	True
Write To (writeTo)	`token`	Whether to write values to fabric or the USD stage	USD Stage
Debug Mode (debugMode)	`bool`	Log debug information to the console	False
Smooth Rotation (smoothRotation)	`bool`	Whether to smooth discontinued euler rotations generated from matrix decomposition	True

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
Time (time)	`double`	Last time that was applied (in seconds)	0.0