SelectionWatch#

class omni.kit.property.usd.SelectionWatch(
stage,
on_selection_changed_fn,
filter_type_list,
filter_lambda,
tree_view=None,
)#

Bases: object

SelectionWatch is used to watch the selection of the stage.

Methods

__init__(stage, on_selection_changed_fn, ...)

clear_selection()

Clear the selection.

enable_filtering_checking(enable)

It is used to prevent selecting the prims that are filtered out but still displayed when such prims have filtered children.

reset(targets_limit)

Reset the targets limit.

set_filtering(filter_string)

Set the filtering.

set_tree_view(tree_view)

Set the tree view.

__init__(
stage,
on_selection_changed_fn,
filter_type_list,
filter_lambda,
tree_view=None,
)#
clear_selection()#

Clear the selection.

enable_filtering_checking(enable: bool)#

It is used to prevent selecting the prims that are filtered out but still displayed when such prims have filtered children. When `enable` is True, SelectionWatch should consider filtering when changing Kit’s selection.

reset(targets_limit)#

Reset the targets limit.

Parameters:

targets_limit (int) – The targets limit.

set_filtering(filter_string: str | None)#

Set the filtering.

Parameters:

filter_string (Optional[str]) – The filter string.

set_tree_view(tree_view)#

Set the tree view.

Parameters:

tree_view (TreeView) – The tree view.