TreeFolderBrowserModel#
- class omni.kit.browser.asset.model.TreeFolderBrowserModel(*args, **kwargs)#
Bases:
FolderBrowserModelMethods
__init__(self)Constructs AbstractItemModel.
folder_changed(item)Notify folder or file changed.
get_category_items(item)Create category item for every root folder.
Override to get list of collection items
get_detail_items(item)Override to get list of detail items
process_root_folder(root_folder[, sync])Process a root folder name and url and add it to the list of root folders.
remove_collection(item)Remove a collection item.
Attributes
- __init__(
- self: omni.ui._ui.AbstractItemModel,
Constructs AbstractItemModel.
- `kwargsdict`
See below
### Keyword Arguments:
- folder_changed(
- item: AbstractBrowserFolder | BrowserFile | None,
Notify folder or file changed. :param item: Changed folder or file object. :type item: Union[AbstractBrowserFolder, BrowserFile]
- get_category_items(
- item: FolderCollectionItem,
Create category item for every root folder. Also create category items for sub folders as children of parent category item. Summary category item will be created if required.
- get_collection_items() List[FolderCollectionItem]#
Override to get list of collection items
- get_detail_items(
- item: CategoryItem,
Override to get list of detail items
- process_root_folder(
- root_folder: str,
- sync: bool = True,
Process a root folder name and url and add it to the list of root folders.
- Parameters:
root_folder – Name of root folder with optional prepended collection name.
- remove_collection(
- item: FolderCollectionItem,
Remove a collection item.
- Parameters:
item (CollectionItem) – Collection item to be removed.
- Returns:
True if removal succeeded.
- Return type:
bool