PrimSpecItem#

class omni.kit.widget.layers.PrimSpecItem(usd_context, path: Path, layer_item)#

Bases: AbstractItem

A single AbstractItemModel item that represents a single prim

Methods

__init__(usd_context, path, layer_item)

Initializes a PrimSpecItem object.

destroy()

Destroys the item object.

get_item_value_model(column_id)

Retrieves the value of an item in the model based on the given column ID.

on_layer_edit_mode_changed()

Callback function for handling layer edit mode changes.

on_layer_muteness_changed()

Callback function for handling layer muteness changes.

update_flags()

Updates the flags for this item object.

Attributes

children

List of children.

filtered

If this prim spec is filtered in the search list.

has_children

If the object has children.

has_missing_reference

If this prim spec includes missing references.

instanceable

If this prim spec is instanceable.

layer

Handle of Sdf.Layer this prim spec resides in.

layer_item

Gets the relate layer item.

linked

If the object is linked.

locked

If the object is locked.

name

Name of this prim spec in stage.

parent

Parent spec.

path

Path of this prim spec in stage.

prim_spec

Handle of Sdf.PrimSpec.

specifier

Specifier of prim spec.

type_name

Type name of this prim spec in stage.

__init__(usd_context, path: Path, layer_item)#

Initializes a PrimSpecItem object.

Parameters:
  • usd_context (omni.usd.UsdContext) – The USD context.

  • path (Sdf.Path) – The path to the prim.

  • layer_item (LayerItem) – The layer item.

destroy()#

Destroys the item object.

get_item_value_model(column_id)#

Retrieves the value of an item in the model based on the given column ID.

Parameters:

column_id (int) – The ID of the column for which to retrieve the item value.

Returns:

The value of the item in the model.

Return type:

omni.ui.AbstractValueModel

on_layer_edit_mode_changed()#

Callback function for handling layer edit mode changes.

on_layer_muteness_changed()#

Callback function for handling layer muteness changes.

update_flags()#

Updates the flags for this item object.

property children#

List of children.

property filtered#

If this prim spec is filtered in the search list.

Returns:

bool

property has_children#

If the object has children.

Returns

bool

property has_missing_reference#

If this prim spec includes missing references.

property instanceable#

If this prim spec is instanceable.

Returns:

bool

property layer#

Handle of Sdf.Layer this prim spec resides in.

property layer_item#

Gets the relate layer item.

Returns:

obj:’LayerItem’

property linked#

If the object is linked.

Returns:

True if the object is linked, False otherwise.

Return type:

bool

property locked#

If the object is locked.

Returns:

True if the object is locked, False otherwise.

Return type:

bool

property name#

Name of this prim spec in stage.

property parent#

Parent spec.

property path#

Path of this prim spec in stage.

property prim_spec#

Handle of Sdf.PrimSpec.

property specifier#

Specifier of prim spec.

property type_name#

Type name of this prim spec in stage.