OmniGraph Node omni.graph.action.ForLoop

omni.graph.action.ForLoop Properties

Name

Value

Version

1

Extension

omni.graph.action

Icon

ogn/icons/omni.graph.action.ForLoop.svg

Has State?

True

Implementation Language

C++

Default Memory Type

cpu

Generated Code Exclusions

None

tags

range

uiName

For Loop

__categories

graph:action,flowControl

Generated Class Name

OgnForLoopDatabase

Python Module

omni.graph.action

omni.graph.action.ForLoop Description

Executes the a loop body once for each value within a range. When step is positive, the values in the range are determined by the formula:

r[i] = start + step*i, i >= 0 & r[i] < stop.

When step is negative the constraint is instead r[i] > stop. A step of zero is an error.

The break input can be used to break out of the loop before the last index. The finished output is executed after all iterations are complete, or when the loop was broken

omni.graph.action.ForLoop Inputs

Name

Type

Default

Required?

Descripton

inputs:breakLoop

execution

None

Y

Breaks out of the loop when the loop body traversal reaches it

uiName

Break

inputs:execIn

execution

None

Y

Input execution

uiName

In

inputs:start

int

0

Y

The first value in the range

uiName

Start

inputs:step

int

1

Y

The step size of the range

uiName

Step

__default

1

inputs:stop

int

0

Y

The limiting value of the range

uiName

Stop

omni.graph.action.ForLoop Outputs

Name

Type

Default

Required?

Descripton

outputs:finished

execution

None

Y

Executed when the loop is finished

outputs:index

int

None

Y

The current or last index within the range

outputs:loopBody

execution

None

Y

Executed for each index in the range

outputs:value

int

None

Y

The current or last value of the range

omni.graph.action.ForLoop State

Name

Type

Default

Required?

Descripton

state:i

int

-1

Y

The next position in the range or -1 when loop is not active

__default

-1