PropertySchemeDelegate

class omni.kit.window.property.property_scheme_delegate.PropertySchemeDelegate

Bases: object

PropertySchemeDelegate is a class to test given payload and determine what widgets to be drawn in what order.

Methods

`get_unwanted_widgets`(payload)	Tests the payload and returns a list of widget names which this delegate does not want to include.
`get_widgets`(payload)	Tests the payload and gathers widgets in interest to be drawn in specific order.

__init__()

get_unwanted_widgets(payload) → List[str]

Tests the payload and returns a list of widget names which this delegate does not want to include. Note that if there is another PropertySchemeDelegate returning widget in its get_widgets that conflicts with names in get_unwanted_widgets, get_widgets always wins (i.e. the Widget will be drawn).

This function is optional.

Parameters: payload (PrimSelectionPayload) – payload.
Returns: list of unwanted widgets.
Return type: list

abstract get_widgets(payload) → List[str]

Tests the payload and gathers widgets in interest to be drawn in specific order.

Parameters: payload (PrimSelectionPayload) – payload.
Returns: list of widgets to build.
Return type: list