MaterialBrowserModel#

class omni.kit.browser.material.MaterialBrowserModel(**kwargs)#

Bases: TreeFolderBrowserModel

Represent material browser model. Please reference FolderBrowserModel for args and keyword args.

Methods

__init__(self)

Constructs AbstractItemModel.

bind_material(material_prim_path, target_paths)

Bind material to target prims.

create_category_item(folder)

Create a category item from a folder.

create_detail_item(file)

Create detail item or list of detail items from a file.

create_folder_object(*args, **kwargs)

Create a folder object for material browser using provided arguments and keyword arguments.

create_material(item[, context_name])

Create material by invoking create_material_by_item.

create_material_by_item(item[, context_name])

Create material from a material detail item.

create_material_by_url(material_url, ...[, ...])

Create material.

execute(item)

Apply material to selected prims, add doNotCastShadows proprty to prims if it does not already exist.

Attributes

__init__(
self: omni.ui._ui.AbstractItemModel,
) → None#

Constructs AbstractItemModel.

`kwargsdict`

See below

### Keyword Arguments:

bind_material(
material_prim_path: str,
target_paths: List[str],
) → None#

Bind material to target prims. :param material_prim_path: Url of material prim. :type material_prim_path: str :param target_paths: List of target paths. :type target_paths: List[str]

create_category_item(
folder: MaterialFolder,
) → FolderCategoryItem#

Create a category item from a folder.

Parameters:

folder (MaterialFolder) – Folder used to create the category item.

Returns:

Category item with folder name and total file count.

Return type:

FolderCategoryItem

create_detail_item(
file: MaterialFile,
) → MaterialDetailItem | List[MaterialDetailItem]#

Create detail item or list of detail items from a file.

Parameters:

file (MaterialFile) – File used to create detail item(s).

Returns:

Created detail item instance(s) for the material file.

Return type:

Union[MaterialDetailItem, List[MaterialDetailItem]]

create_folder_object(*args, **kwargs)#

Create a folder object for material browser using provided arguments and keyword arguments.

Returns:

Created folder object.

Return type:

MaterialFolder

create_material(
item: MaterialDetailItem,
context_name: str = '',
) → str#

Create material by invoking create_material_by_item.

Parameters:

  • item (MaterialDetailItem) – Material detail item for creating material.

  • context_name (str) – USD context name for material creation.

Returns:

Path of the created material prim.

Return type:

str

static create_material_by_item(
item: MaterialDetailItem,
context_name: str = '',
) → str#

Create material from a material detail item.

Parameters:

  • item (MaterialDetailItem) – Material detail item for material creation.

  • context_name (str) – USD context name for material creation.

Returns:

Path of the created material prim.

Return type:

str

static create_material_by_url(
material_url: str,
sub_material_id: str | None,
context_name: str = '',
)#

Create material. :param material_url: Url of material. :type material_url: str :param sub_material_id: Id of sub material. Default None means no sub material. :type sub_material_id: str :param context_name: Name of usd context to create material in. :type context_name: str

Returns:

Path of created material prim

execute(
item: MaterialDetailItem,
) → None#

Apply material to selected prims, add doNotCastShadows proprty to prims if it does not already exist. :param item: Material item to assign. :type item: MaterialDetailItem