UsdUIBackdropWidget

class omni.kit.property.material.scripts.widgets.UsdUIBackdropWidget(title: str = 'Backdrop')

Bases: UsdPropertiesWidget

A widget representing a USD UI Backdrop within a properties panel.

This widget extends the UsdPropertiesWidget to specifically handle the display and interaction with USD UI Backdrop elements. It provides a custom property layout and integrates with the material adapter settings. The widget is initialized with a title and configures itself based on the application settings.

Parameters: title (str) – The title of the backdrop widget. Defaults to ‘Backdrop’.

Methods

`__init__`([title])	Initializes the backdrop widget with optional title.
`on_new_payload`(payload)	Handles a new payload for the widget.

Attributes

MATERIAL_ADAPTER_SETTING_PATH

Path to material adapter settings.

__init__(title: str = 'Backdrop'): Initializes the backdrop widget with optional title.

on_new_payload(payload: PrimSelectionPayload) → bool

Handles a new payload for the widget.

Parameters: payload (PrimSelectionPayload) – The new payload to be handled by the widget.
Returns: True if the payload is processed successfully, otherwise False.
Return type: bool

MATERIAL_ADAPTER_SETTING_PATH = '/ext/omni.kit.property.material/enableAdapter'

Path to material adapter settings.

Type: str