OmniGraph Node omni.graph.action.OnTick

omni.graph.action.OnTick Properties

Name

Value

Version

1

Extension

omni.graph.action

Has State?

False

Implementation Language

C++

Default Memory Type

cpu

Generated Code Exclusions

None

uiName

On Tick

__categories

graph:action,event

Generated Class Name

OgnOnTickDatabase

Python Module

omni.graph.action

omni.graph.action.OnTick Description

Executes an output execution pulse at a regular multiple of the refresh rate

omni.graph.action.OnTick Inputs

Name

Type

Default

Required?

Descripton

inputs:framePeriod

uint

0

Y

The number of updates between each output pulse. The default 0 means every update, 1 means every other update. This can be used to rate-limit updates.

literalOnly

1

uiName

Update Period (Ticks)

__default

0

inputs:onlyPlayback

bool

True

Y

When true, the node is only computed while Stage is being played.

literalOnly

1

uiName

Only Simulate On Play

__default

true

omni.graph.action.OnTick Outputs

Name

Type

Default

Required?

Descripton

outputs:absoluteSimTime

double

None

Y

The accumulated total of elapsed times between rendered frames

uiName

Absolute Simulation Time (Seconds)

outputs:deltaSeconds

double

None

Y

The number of seconds elapsed since the last output pulse

uiName

Delta (Seconds)

outputs:frame

double

None

Y

The global animation time in frames, equivalent to (time * fps), during playback

uiName

Animation Time (Frames)

outputs:isPlaying

bool

None

Y

True during global animation timeline playback

uiName

Is Playing

outputs:tick

execution

None

Y

The execution output

uiName

Tick

outputs:time

double

None

Y

The global animation time in seconds during playback

uiName

Animation Time (Seconds)

outputs:timeSinceStart

double

None

Y

Elapsed time since the App started

uiName

Time Since Start (Seconds)