OmniGraph Node omni.graph.ui.Button

omni.graph.ui.Button Properties

Name

Value

Version

1

Extension

omni.graph.ui

Has State?

False

Implementation Language

Python

Default Memory Type

cpu

Generated Code Exclusions

None

uiName

Button (BETA)

__categories

graph:action,ui

__language

Python

Generated Class Name

OgnButtonDatabase

Python Module

omni.graph.ui

omni.graph.ui.Button Description

Create a button widget on the Viewport

omni.graph.ui.Button Inputs

Name

Type

Default

Required?

Descripton

inputs:create

execution

None

Y

Input execution to create and show the widget

uiName

Create

inputs:parentWidgetPath

token

Y

The absolute path to the parent widget.

uiName

Parent Widget Path

inputs:size

double[2]

[0.0, 0.0]

Y

The width and height of the created widget. Value of 0 means the created widget will be just large enough to fit everything.

uiName

Size

inputs:startHidden

bool

False

Determines whether the button will initially be visible (False) or not (True).

uiName

Start Hidden

__default

false

inputs:style

string

None

Style to be applied to the button. This can later be changed with the WriteWidgetStyle node.

inputs:text

string

None

The text that is displayed on the button

uiName

Text

inputs:widgetIdentifier

token

None

An optional unique identifier for the widget. Can be used to refer to this widget in other places such as the OnWidgetClicked node.

uiName

Widget Identifier

omni.graph.ui.Button Outputs

Name

Type

Default

Required?

Descripton

outputs:created

execution

None

Y

Executed when the widget is created

uiName

Created

outputs:widgetPath

token

None

Y

The absolute path to the created widget

uiName

Widget Path