file_path
stringlengths 21
202
| content
stringlengths 12
1.02M
| size
int64 12
1.02M
| lang
stringclasses 9
values | avg_line_length
float64 3.33
100
| max_line_length
int64 10
993
| alphanum_fraction
float64 0.27
0.93
|
|---|---|---|---|---|---|---|
omniverse-code/kit/exts/omni.kit.extpath.git/docs/index.rst | omni.kit.extpath.git
###########################
Git Url as Extension Search Path Support.
Settings
***********
Refer to ``extension.toml`` file for settings.
| 164 | reStructuredText | 12.749999 | 46 | 0.573171 |
omniverse-code/kit/exts/omni.kit.menu.edit/omni/kit/menu/edit/scripts/edit.py | import os
import asyncio
import carb.input
import omni.ext
import omni.usd
import omni.ui as ui
import omni.kit.app
import omni.kit.menu.utils
import omni.kit.notification_manager as nm
import omni.kit.usd.layers as layers
from functools import partial
from omni.kit.menu.utils import MenuItemDescription
from .selection import Selection
from .selection_window import SelectionSetWindow
from .edit_actions import register_actions, deregister_actions
from pxr import Sdf, Usd, Kind, Tf
_extension_instance = None
_extension_path = None
PERSISTENT_SETTINGS_PREFIX = "/persistent"
KEEP_TRANSFORM_FOR_REPARENTING = "/persistent/app/stage/movePrimInPlace"
class EditMenuExtension(omni.ext.IExt):
def __init__(self):
super().__init__()
omni.kit.menu.utils.set_default_menu_proirity("Edit", -9)
self._select_recent_menu_list = [ MenuItemDescription(name="None", enabled=False) ]
self._selection_set_menu_list = [ MenuItemDescription(name="None", enabled=False) ]
self._selection_kind_menu_list = [ MenuItemDescription(name="None", enabled=False) ]
self._select_recent = []
self._selection_set = []
def on_startup(self, ext_id):
global _extension_instance
_extension_instance = self
global _extension_path
_extension_path = omni.kit.app.get_app_interface().get_extension_manager().get_extension_path(ext_id)
self._ext_name = omni.ext.get_extension_name(ext_id)
register_actions(self._ext_name, EditMenuExtension, lambda: _extension_instance)
self._select_recent_menu_list = [ MenuItemDescription(name="None", enabled=False) ]
self._selection_set_menu_list = [ MenuItemDescription(name="None", enabled=False) ]
self._selection_kind_menu_list = [ MenuItemDescription(name="None", enabled=False) ]
self._select_recent = []
self._selection_set = []
self._create_selection_window = None
self._edit_menu_list = None
self._build_edit_menu()
# self._stage_event_sub = omni.usd.get_context().get_stage_event_stream().create_subscription_to_pop(self._on_stage_event, name="omni.usd.menu.edit")
self._context_menus = []
manager = omni.kit.app.get_app().get_extension_manager()
self._cm_hooks = manager.subscribe_to_extension_enable(
lambda _: self._register_context_menu(),
lambda _: self._unregister_context_menu(),
ext_name="omni.kit.context_menu",
hook_name="menu edit listener",
)
def on_shutdown(self):
global _extension_instance
global _template_list
deregister_actions(self._ext_name)
self._unregister_context_menu()
self._cm_hooks = None
_extension_instance = None
_template_list = None
# self._stage_event_sub = None
self._select_recent_menu_list = []
self._selection_set_menu_list = []
self._selection_kind_menu_list = []
self._select_recent = []
self._selection_set = []
if self._create_selection_window:
self._create_selection_window.shutdown()
del self._create_selection_window
omni.kit.menu.utils.remove_menu_items(self._edit_menu_list, "Edit")
def post_notification(message: str, info: bool = False, duration: int = 3):
if info:
type = nm.NotificationStatus.INFO
else:
type = nm.NotificationStatus.WARNING
nm.post_notification(message, status=type, duration=duration)
def _usd_kinds(self):
return ["model", "assembly", "group", "component", "subcomponent"]
def _usd_kinds_display(self):
return self._usd_kinds()[1:]
def _plugin_kinds(self):
all_kinds = set(Kind.Registry.GetAllKinds())
return all_kinds - set(self._usd_kinds())
def _create_selection_set(self):
paths = omni.usd.get_context().get_selection().get_selected_prim_paths()
if not paths:
EditMenuExtension.post_notification("Cannot Create Selection Set as no prims are selected")
return
if self._create_selection_window:
self._create_selection_window.show()
else:
self._create_selection_window = SelectionSetWindow(self._add_to_selection_set)
def _build_recent_menu(self):
if self._select_recent:
self._select_recent_menu_list.clear()
self._select_recent.sort(reverse=True, key=lambda x: x.time)
del self._select_recent[5:]
for recent in self._select_recent:
index = self._select_recent.index(recent)
self._select_recent_menu_list.append(
MenuItemDescription(
name=recent.description, onclick_action=("omni.kit.menu.edit", "select_recent", index)
)
)
omni.kit.menu.utils.rebuild_menus()
def _on_select_recent(self, index):
async def select_func():
await omni.kit.app.get_app().next_update_async()
do_recent = self._select_recent[index]
omni.kit.commands.execute("SelectListCommand", selection=do_recent.selection)
do_recent.touch()
self._build_recent_menu()
asyncio.ensure_future(select_func())
def _add_to_selection_set(self, description):
new_selection = omni.usd.get_context().get_selection().get_selected_prim_paths()
for selection in self._selection_set:
if selection.description == description:
EditMenuExtension.post_notification(f"Selection set \"{description}\" already exists")
return
self._selection_set.append(Selection(description, new_selection))
self._build_selection_set_menu()
def _add_to_recent(self, description, selection):
found = False
for prev_selection in self._select_recent:
if prev_selection.description == description and prev_selection.selection == selection:
prev_selection.touch()
found = True
break
if not found:
self._select_recent.append(Selection(description, selection))
self._build_recent_menu()
def _on_select_selection_set(self, index):
async def select_func():
await omni.kit.app.get_app().next_update_async()
do_select = self._selection_set[index]
omni.kit.commands.execute("SelectListCommand", selection=do_select.selection)
asyncio.ensure_future(select_func())
def _build_selection_set_menu(self):
self._selection_set_menu_list.clear()
self._selection_set.sort(key=lambda x: x.description)
for recent in self._selection_set:
index=self._selection_set.index(recent)
self._selection_set_menu_list.append(MenuItemDescription(name=recent.description, onclick_action=("omni.kit.menu.edit", "select_selection_set", index)))
omni.kit.menu.utils.rebuild_menus()
def _on_select_by_kind(self, kind):
async def select_func():
await omni.kit.app.get_app().next_update_async()
omni.kit.commands.execute("SelectKindCommand", kind=kind)
asyncio.ensure_future(select_func())
def _build_selection_kind_menu(self):
self._selection_kind_menu_list.clear()
for kind in self._usd_kinds_display():
self._selection_kind_menu_list.append(MenuItemDescription(name=str(kind).capitalize(), onclick_action=("omni.kit.menu.edit", "select_by_kind", kind)))
for kind in self._plugin_kinds():
self._selection_kind_menu_list.append(MenuItemDescription(name=str(kind).capitalize(), onclick_action=("omni.kit.menu.edit", "select_by_kind", kind)))
def _build_edit_menu(self):
self._build_recent_menu()
self._build_selection_kind_menu()
# setup menus
self._edit_select_menu = [
MenuItemDescription(
name="Select Recent",
sub_menu=self._select_recent_menu_list
),
MenuItemDescription(
name="Select All",
onclick_action=("omni.kit.selection", "all"),
hotkey=(carb.input.KEYBOARD_MODIFIER_FLAG_CONTROL, carb.input.KeyboardInput.A),
),
MenuItemDescription(
name="Select None",
# enable_fn=EditMenuExtension.prim_selected,
onclick_action=("omni.kit.selection", "none"),
hotkey=(0, carb.input.KeyboardInput.ESCAPE),
),
MenuItemDescription(
name="Select Invert",
# enable_fn=EditMenuExtension.prim_selected,
onclick_action=("omni.kit.menu.edit", "selection_invert"),
hotkey=(carb.input.KEYBOARD_MODIFIER_FLAG_CONTROL, carb.input.KeyboardInput.I),
),
MenuItemDescription(
name="Select Parent",
# enable_fn=EditMenuExtension.prim_selected,
onclick_action=("omni.kit.menu.edit", "selection_parent"),
hotkey=(0, carb.input.KeyboardInput.UP),
),
MenuItemDescription(
name="Select Leaf",
# enable_fn=EditMenuExtension.prim_selected,
onclick_action=("omni.kit.menu.edit", "selection_leaf"),
),
MenuItemDescription(
name="Select Hierarchy",
onclick_action=("omni.kit.menu.edit", "selection_hierarchy"),
# enable_fn=EditMenuExtension.prim_selected,
),
MenuItemDescription(
name="Select Similar",
# enable_fn=EditMenuExtension.prim_selected,
onclick_action=("omni.kit.menu.edit", "selection_similar"),
),
MenuItemDescription(),
MenuItemDescription(
name="Create Selection Set",
# enable_fn=EditMenuExtension.prim_selected,
onclick_action=("omni.kit.menu.edit", "create_selection_set"),
),
MenuItemDescription(
name="Select Set",
sub_menu=self._selection_set_menu_list
),
MenuItemDescription(),
MenuItemDescription(
name="Select by Kind",
sub_menu=self._selection_kind_menu_list
)]
self._edit_menu_list = [
MenuItemDescription(
name="Undo",
glyph="none.svg",
onclick_action=("omni.kit.commands", "undo"),
hotkey=(carb.input.KEYBOARD_MODIFIER_FLAG_CONTROL, carb.input.KeyboardInput.Z),
),
MenuItemDescription(
name="Redo",
glyph="none.svg",
onclick_action=("omni.kit.commands", "redo"),
hotkey=(carb.input.KEYBOARD_MODIFIER_FLAG_CONTROL, carb.input.KeyboardInput.Y),
),
MenuItemDescription(
name="Repeat",
glyph="none.svg",
onclick_action=("omni.kit.commands", "repeat"),
hotkey=(carb.input.KEYBOARD_MODIFIER_FLAG_CONTROL, carb.input.KeyboardInput.R),
),
MenuItemDescription(
name="Select",
glyph="none.svg",
sub_menu=self._edit_select_menu
),
MenuItemDescription(),
MenuItemDescription(
name="Instance",
glyph="none.svg",
# enable_fn=[EditMenuExtension.prim_selected, EditMenuExtension.can_be_instanced],
onclick_action=("omni.kit.menu.edit", "instance_prim"),
hotkey=(
carb.input.KEYBOARD_MODIFIER_FLAG_CONTROL | carb.input.KEYBOARD_MODIFIER_FLAG_SHIFT,
carb.input.KeyboardInput.I,
),
),
MenuItemDescription(
name="Duplicate",
glyph="copy.svg",
# enable_fn=EditMenuExtension.prim_selected,
onclick_action=("omni.kit.menu.edit", "duplicate_prim"),
hotkey=(carb.input.KEYBOARD_MODIFIER_FLAG_CONTROL, carb.input.KeyboardInput.D),
),
MenuItemDescription(
name="Duplicate - All Layers",
glyph="copy.svg",
# enable_fn=[EditMenuExtension.prim_selected, EditMenuExtension.is_not_in_live_session],
onclick_action=("omni.kit.menu.edit", "duplicate_prim_and_layers"),
),
MenuItemDescription(
name="Duplicate - Collapsed",
glyph="copy.svg",
# enable_fn=EditMenuExtension.prim_selected,
onclick_action=("omni.kit.menu.edit", "duplicate_prim_and_combine_layers"),
),
MenuItemDescription(
name="Parent",
glyph="copy.svg",
# enable_fn=[EditMenuExtension.can_prims_parent, EditMenuExtension.is_not_in_live_session],
onclick_action=("omni.kit.menu.edit", "parent_prims"),
hotkey=(0, carb.input.KeyboardInput.P),
),
MenuItemDescription(
name="Unparent",
glyph="copy.svg",
# enable_fn=[EditMenuExtension.can_prims_unparent, EditMenuExtension.is_not_in_live_session],
onclick_action=("omni.kit.menu.edit", "unparent_prims"),
hotkey=(carb.input.KEYBOARD_MODIFIER_FLAG_SHIFT, carb.input.KeyboardInput.P),
),
MenuItemDescription(
name="Group",
glyph="none.svg",
# enable_fn=EditMenuExtension.prim_selected,
onclick_action=("omni.kit.menu.edit", "create_xform_to_group"),
hotkey=(carb.input.KEYBOARD_MODIFIER_FLAG_CONTROL, carb.input.KeyboardInput.G),
),
MenuItemDescription(
name="Ungroup",
glyph="none.svg",
# enable_fn=EditMenuExtension.prim_selected,
onclick_action=("omni.kit.menu.edit", "ungroup_prims"),
),
MenuItemDescription(
name="Toggle Visibility",
glyph="none.svg",
# enable_fn=EditMenuExtension.prim_selected,
onclick_action=("omni.kit.menu.edit", "toggle_visibillity"),
hotkey=(0, carb.input.KeyboardInput.H),
),
MenuItemDescription(),
MenuItemDescription(
name="Delete",
glyph="trash.svg",
# enable_fn=EditMenuExtension.prim_selected,
onclick_action=("omni.kit.menu.edit", "delete_prim"),
hotkey=(0, carb.input.KeyboardInput.DEL),
),
MenuItemDescription(
name="Delete - All Layers",
glyph="trash.svg",
# enable_fn=[EditMenuExtension.prim_selected, EditMenuExtension.is_not_in_live_session],
onclick_action=("omni.kit.menu.edit", "delete_prim_all_layers"),
),
MenuItemDescription(
name="Rename",
glyph="pencil.svg",
# enable_fn=[EditMenuExtension.prim_selected, EditMenuExtension.is_one_prim_selected, EditMenuExtension.can_delete],
onclick_action=("omni.kit.menu.edit", "menu_rename_prim_dialog"),
hotkey=(0, carb.input.KeyboardInput.F2),
appear_after="Delete - All Layers",
),
MenuItemDescription(),
MenuItemDescription(
name="Hide Unselected",
glyph="none.svg",
onclick_action=("omni.kit.selection", "HideUnselected"),
),
MenuItemDescription(
name="Unhide All",
glyph="none.svg",
onclick_action=("omni.kit.selection", "UnhideAllPrims"),
),
MenuItemDescription(),
MenuItemDescription(
name="Focus",
glyph="none.svg",
# enable_fn=EditMenuExtension.prim_selected,
onclick_action=("omni.kit.menu.edit", "focus_prim"),
hotkey=(0, carb.input.KeyboardInput.F),
),
MenuItemDescription(
name="Toggle Visualization Mode",
glyph="none.svg",
onclick_action=("omni.kit.viewport.actions", "toggle_global_visibility"),
),
MenuItemDescription(
name="Capture Screenshot",
glyph="none.svg",
onclick_action=("omni.kit.menu.edit", "capture_screenshot"),
hotkey=(0, carb.input.KeyboardInput.F10),
),
]
omni.kit.menu.utils.add_menu_items(self._edit_menu_list, "Edit", -9)
# def _on_stage_event(self, event):
# if event.type == int(omni.usd.StageEventType.SELECTION_CHANGED):
# async def refresh_menu_items():
# omni.kit.menu.utils.refresh_menu_items("Edit")
# asyncio.ensure_future(refresh_menu_items())
def _register_context_menu(self):
import omni.kit.context_menu
select_context_menu_dict = {
"name": {
"Select": [
{"name": {"Select Recent": self._select_recent_menu_list}},
{"name": "Select All", "onclick_action": ("omni.kit.selection", "all")},
{"name": "Select None", "onclick_action": ("omni.kit.selection", "none")},
{"name": "Select Invert", "onclick_action": ("omni.kit.menu.edit", "selection_invert")},
{"name": "Select Parent", "onclick_action": ("omni.kit.menu.edit", "selection_parent")},
{"name": "Select Leaf", "onclick_action": ("omni.kit.menu.edit", "selection_leaf")},
{"name": "Select Hierarchy", "onclick_action": ("omni.kit.menu.edit", "selection_hierarchy")},
{"name": "Select Similar", "onclick_action": ("omni.kit.menu.edit", "selection_similar")},
{"name": ""},
{"name": {"Select by Kind": self._selection_kind_menu_list}},
]
},
"glyph": "none.svg",
"appear_after": ""
}
self._context_menus.append(
omni.kit.context_menu.add_menu(select_context_menu_dict, "MENU", "omni.kit.window.viewport")
)
def _unregister_context_menu(self):
for menu in self._context_menus:
menu.release()
self._context_menus.clear()
def prim_selected():
paths = omni.usd.get_context().get_selection().get_selected_prim_paths()
return bool(paths)
def is_in_live_session():
usd_context = omni.usd.get_context()
live_syncing = layers.get_layers(usd_context).get_live_syncing()
return live_syncing.is_stage_in_live_session()
def is_not_in_live_session():
return not EditMenuExtension.is_stage_in_live_session()
def can_delete():
paths = omni.usd.get_context().get_selection().get_selected_prim_paths()
stage = omni.usd.get_context().get_stage()
if not stage:
return False
for path in paths:
prim = stage.GetPrimAtPath(path)
if not prim or not prim.IsValid():
return False
no_delete = prim.GetMetadata("no_delete")
if no_delete is not None and no_delete is True:
return False
return True
def is_one_prim_selected():
paths = omni.usd.get_context().get_selection().get_selected_prim_paths()
return len(paths) == 1
def can_prims_parent():
paths = omni.usd.get_context().get_selection().get_selected_prim_paths()
if paths:
return bool(len(paths)>1)
return False
def can_prims_unparent():
paths = omni.usd.get_context().get_selection().get_selected_prim_paths()
if paths:
return True
return False
def can_be_instanced():
allowed_types_for_instancing = ["Xform"]
stage = omni.usd.get_context().get_stage()
if not stage:
return False
paths = omni.usd.get_context().get_selection().get_selected_prim_paths()
for path in paths:
prim = stage.GetPrimAtPath(path)
if not prim or prim.GetTypeName() not in allowed_types_for_instancing:
return False
return True
def instance_prim():
usd_context = omni.usd.get_context()
paths = usd_context.get_selection().get_selected_prim_paths()
if not paths:
EditMenuExtension.post_notification("Cannot instance prim as no prims are selected")
return
with omni.kit.usd.layers.active_authoring_layer_context(usd_context):
paths = usd_context.get_selection().get_selected_prim_paths()
omni.kit.commands.execute("CreateInstances", paths_from=paths)
# When combine_layers is True, it means to duplicate with flattening references.
def duplicate_prim(duplicate_layers, combine_layers):
paths = omni.usd.get_context().get_selection().get_selected_prim_paths()
if not paths:
EditMenuExtension.post_notification("Cannot duplicate prim as no prims are selected")
return
if EditMenuExtension.is_in_live_session() and duplicate_layers and not combine_layers:
warn = "Destructive duplication is not supported in live-syncing."
carb.log_warn(warn)
EditMenuExtension.post_notification(warn)
return
paths = omni.usd.get_context().get_selection().get_selected_prim_paths()
usd_context = omni.usd.get_context()
with layers.active_authoring_layer_context(usd_context):
omni.kit.commands.execute(
"CopyPrims", paths_from=paths, duplicate_layers=duplicate_layers, combine_layers=combine_layers,
flatten_references=combine_layers
)
def parent_prims():
stage = omni.usd.get_context().get_stage()
if not stage:
EditMenuExtension.post_notification("Cannot parent prim as no stage is loaded")
return
if not EditMenuExtension.can_prims_parent():
EditMenuExtension.post_notification("Cannot parent prim as two or more prims are not selected")
return
if EditMenuExtension.is_in_live_session():
EditMenuExtension.post_notification("Parent is not supported in live-syncing.")
return
paths = omni.usd.get_context().get_selection().get_selected_prim_paths()
if paths:
def prim_renamed(old_prim_name: Sdf.Path, new_prim_name: Sdf.Path):
try:
index = paths.index(old_prim_name.pathString)
paths[index] = new_prim_name.pathString
except Exception as exc:
carb.log_warn(f"prim_renamed error {exc}")
parent_path = paths.pop()
prim = stage.GetPrimAtPath(parent_path)
if prim and prim.IsInstanceable():
EditMenuExtension.post_notification(f"{parent_path} cannot be parent as its Instanceable")
return
settings = carb.settings.get_settings()
keep_transform = settings.get(KEEP_TRANSFORM_FOR_REPARENTING)
if keep_transform is None:
keep_transform = True
omni.kit.commands.execute(
"ParentPrims",
parent_path=parent_path,
child_paths=paths,
on_move_fn=prim_renamed,
keep_world_transform=keep_transform
)
omni.usd.get_context().get_selection().set_selected_prim_paths(paths, True)
def unparent_prims():
stage = omni.usd.get_context().get_stage()
if not stage:
EditMenuExtension.post_notification("Cannot unparent prim as no stage is loaded")
return
if not EditMenuExtension.can_prims_unparent():
EditMenuExtension.post_notification("Cannot unparent prim as no prims are not selected")
return
if EditMenuExtension.is_in_live_session():
EditMenuExtension.post_notification("Unparent is not supported in live-syncing.")
return
paths = omni.usd.get_context().get_selection().get_selected_prim_paths()
if paths:
settings = carb.settings.get_settings()
keep_transform = settings.get(KEEP_TRANSFORM_FOR_REPARENTING)
if keep_transform is None:
keep_transform = True
omni.kit.commands.execute("UnparentPrims", paths=paths, keep_world_transform=keep_transform)
def create_xform_to_group():
usd_context = omni.usd.get_context()
paths = usd_context.get_selection().get_selected_prim_paths()
if not paths:
EditMenuExtension.post_notification("Cannot Group as no prims are selected")
return
stage = usd_context.get_stage()
if not stage:
EditMenuExtension.post_notification("Cannot Group prim as no stage is loaded")
return
if stage.HasDefaultPrim() and stage.GetDefaultPrim().GetPath().pathString in paths:
EditMenuExtension.post_notification("Cannot Group default prim")
return
with omni.kit.usd.layers.active_authoring_layer_context(usd_context):
omni.kit.commands.execute("GroupPrims", prim_paths=paths, destructive=False)
return True
def ungroup_prims():
usd_context = omni.usd.get_context()
paths = usd_context.get_selection().get_selected_prim_paths()
if not paths:
EditMenuExtension.post_notification("Cannot Ungroup as no prims are selected")
return
stage = usd_context.get_stage()
if not stage:
EditMenuExtension.post_notification("Cannot Ungroup prim as no stage is loaded")
return
with omni.kit.usd.layers.active_authoring_layer_context(usd_context):
omni.kit.commands.execute("UngroupPrims", prim_paths=paths, destructive=False)
return True
def delete_prim(destructive):
paths = omni.usd.get_context().get_selection().get_selected_prim_paths()
if not paths:
EditMenuExtension.post_notification("Cannot Delete as no prims are selected")
return
if destructive and EditMenuExtension.is_in_live_session():
EditMenuExtension.post_notification("Delete prims is not supported in live-syncing.")
return
omni.kit.commands.execute("DeletePrims", paths=paths, destructive=destructive)
def focus_prim():
from omni.kit.viewport.utility import frame_viewport_selection
frame_viewport_selection(force_legacy_api=True)
def toggle_visibillity():
paths = omni.usd.get_context().get_selection().get_selected_prim_paths()
if not paths:
EditMenuExtension.post_notification("Cannot Toggle Visibillity as no prims are selected")
return
omni.kit.commands.execute("ToggleVisibilitySelectedPrims", selected_paths=paths)
def toggle_global_visibility():
carb.log_error("omni.kit.menu.edit.toggle_global_visibility is deprecated, use omni.kit.viewport.actions.toggle_global_visibility")
action_registry = omni.kit.actions.core.get_action_registry()
exc_action = action_registry.get_action("omni.kit.viewport.actions", "toggle_global_visibility")
if exc_action:
return exc_action.execute()
carb.log_error("omni.kit.viewport.actions must be enabled")
def capture_screenshot(on_complete_fn: callable=None):
from datetime import datetime
now = datetime.now()
date_time = now.strftime("%Y-%m-%d %H.%M.%S")
capture_filename = "capture.%s.png" % (date_time)
# Check if the user specified the screenshots folder.
settings = carb.settings.get_settings()
screenshot_path = settings.get(PERSISTENT_SETTINGS_PREFIX + "/app/captureFrame/path")
if screenshot_path:
if os.path.isdir(screenshot_path):
capture_filename = os.path.join(screenshot_path, capture_filename)
else:
carb.log_error(f"Can't save screenshot to {str(screenshot_path)} because it is not a directory")
async def capture_frame(capture_filename: str, on_complete_fn: callable):
import omni.kit.app
carb.log_warn("Capturing %s" % (capture_filename))
# wait for next frame so menu has closed
await omni.kit.app.get_app().next_update_async()
capture_viewport = settings.get(PERSISTENT_SETTINGS_PREFIX + "/app/captureFrame/viewport")
success = False
try:
if not capture_viewport:
import omni.renderer_capture
renderer_capture = omni.renderer_capture.acquire_renderer_capture_interface()
renderer_capture.capture_next_frame_swapchain(capture_filename)
success = True
else:
from omni.kit.viewport.utility import get_active_viewport, capture_viewport_to_file
viewport = get_active_viewport()
if viewport:
capture_viewport_to_file(viewport, file_path=capture_filename, is_hdr=False)
success = True
except ImportError:
pass
if not success:
carb.log_error("Failed to capture " + ("viewport" if capture_viewport else "") + "screenshot")
if on_complete_fn:
# wait for screenshot to complete
await omni.kit.app.get_app().next_update_async()
await omni.kit.app.get_app().next_update_async()
on_complete_fn(success, capture_filename)
# wait for next frame so menu has closed
asyncio.ensure_future(capture_frame(capture_filename, on_complete_fn))
@staticmethod
def _rename_viewport_active_camera(old_prim_name: Sdf.Path, new_prim_name: Sdf.Path):
try:
from omni.kit.viewport.utility import get_active_viewport
viewport = get_active_viewport()
if viewport and viewport.camera_path == old_prim_name:
viewport.camera_path = new_prim_name or "/OmniverseKit_Persp"
except ImportError:
pass
@staticmethod
def rename_prim(stage, prim, window, field_widget):
if window:
window.visible = False
if field_widget:
def select_new_prim(old_prim_name: Sdf.Path, new_prim_name: Sdf.Path):
omni.usd.get_context().get_selection().set_selected_prim_paths([new_prim_name.pathString], True)
if prim.GetPath().name != field_widget.model.get_value_as_string():
old_prim_name = prim.GetPath()
new_prim_name = prim.GetPath().GetParentPath()
new_prim_name = new_prim_name.AppendChild(Tf.MakeValidIdentifier(field_widget.model.get_value_as_string()))
new_prim_name = omni.usd.get_stage_next_free_path(stage, new_prim_name.pathString, False)
on_move_fn = select_new_prim
if Sdf.Path.IsValidPathString(new_prim_name):
EditMenuExtension._rename_viewport_active_camera(old_prim_name, new_prim_name)
move_dict = {old_prim_name: new_prim_name}
omni.kit.commands.execute("MovePrims", paths_to_move=move_dict, on_move_fn=on_move_fn, destructive=False)
else:
EditMenuExtension.post_notification(f"Cannot rename {old_prim_name} to {new_prim_name} as its not a valid USD path")
def menu_rename_prim_dialog(self):
import omni.usd
paths = omni.usd.get_context().get_selection().get_selected_prim_paths()
if not paths:
EditMenuExtension.post_notification("Cannot Rename prim as no prims are selected")
return
if len(paths) != 1:
EditMenuExtension.post_notification("Cannot Rename more then one prim")
return
stage = omni.usd.get_context().get_stage()
if not stage or not paths:
return
# try to use omni.kit.widget.stage rename...
try:
import omni.kit.window.stage
window = ui.Workspace.get_window("Stage")
stage_widget = window.get_widget()
items = stage_widget.get_treeview().selection
if len(items) == 1:
return stage_widget.get_delegate().get_name_column_delegate().rename_item(items[0])
except Exception as exc:
carb.log_warn(f"stage window rename failed due to {exc}")
# do dialog rename
prim = stage.GetPrimAtPath(paths[0])
window = ui.Window(
"Rename " + prim.GetPath().name + "###context_menu_rename",
width=200,
height=0,
flags=ui.WINDOW_FLAGS_NO_RESIZE | ui.WINDOW_FLAGS_NO_SCROLLBAR | ui.WINDOW_FLAGS_MODAL,
)
with window.frame:
with ui.VStack(
height=0,
spacing=5,
name="top_level_stack",
style={"VStack::top_level_stack": {"margin": 5}, "Button": {"margin": 0}},
):
async def focus(field):
await omni.kit.app.get_app().next_update_async()
field.focus_keyboard()
new_name_widget = ui.StringField()
new_name_widget.model.set_value(prim.GetPath().name)
new_name_widget.focus_keyboard()
ui.Spacer(width=5, height=5)
with ui.HStack(spacing=5):
ui.Button(
"Ok",
clicked_fn=partial(EditMenuExtension.rename_prim, stage, prim, window, new_name_widget),
)
ui.Button(
"Cancel", clicked_fn=partial(EditMenuExtension.rename_prim, stage, prim, window, None)
)
editing_started = False
def on_begin():
nonlocal editing_started
editing_started = True
def on_end():
nonlocal editing_started
editing_started = False
def window_pressed_key(key_index, key_flags, key_down):
nonlocal editing_started
key_mod = key_flags & ~ui.Widget.FLAG_WANT_CAPTURE_KEYBOARD
if carb.input.KeyboardInput(key_index) in [carb.input.KeyboardInput.ENTER, carb.input.KeyboardInput.NUMPAD_ENTER] and key_mod == 0 and key_down and editing_started:
on_end()
EditMenuExtension.rename_prim(stage, prim, window, new_name_widget)
new_name_widget.model.add_begin_edit_fn(lambda m: on_begin())
new_name_widget.model.add_end_edit_fn(lambda m: on_end())
window.set_key_pressed_fn(window_pressed_key)
asyncio.ensure_future(focus(new_name_widget))
def get_extension_path(sub_directory):
global _extension_path
path = _extension_path
if sub_directory:
path = os.path.normpath(os.path.join(path, sub_directory))
return path
| 35,891 | Python | 41.526066 | 188 | 0.582542 |
omniverse-code/kit/exts/omni.kit.menu.edit/omni/kit/menu/edit/scripts/edit_actions.py | import carb
import asyncio
import omni.kit.actions.core
def register_actions(extension_id, cls, get_self_fn):
def select_prim(description: str, select_name: callable):
paths = omni.usd.get_context().get_selection().get_selected_prim_paths()
if not paths:
cls.post_notification(f"Cannot select \"{description}\" as no prims are selected")
return
return do_select(description, select_name, paths)
def add_to_recent(description: str, select_name: callable):
paths = omni.usd.get_context().get_selection().get_selected_prim_paths()
if not paths:
cls.post_notification("Cannot add to recent as no prims are selected")
return
return do_select(description, select_name, paths)
def do_select(description: str, select_name: callable, paths: list[str]):
old_selection = omni.usd.get_context().get_selection().get_selected_prim_paths()
async def select_func():
await omni.kit.app.get_app().next_update_async()
omni.kit.actions.core.execute_action("omni.kit.selection", select_name)
last_description = f"{description} {old_selection}"
new_selection = omni.usd.get_context().get_selection().get_selected_prim_paths()
if len(last_description) > 45:
last_description = last_description[:42] + "..."
get_self_fn()._add_to_recent(last_description, new_selection)
asyncio.ensure_future(select_func())
action_registry = omni.kit.actions.core.get_action_registry()
actions_tag = "Edit Menu Actions"
# actions
action_registry.register_action(
extension_id,
"select_recent",
get_self_fn()._on_select_recent,
display_name="Edit->Recent",
description="Recent",
tag=actions_tag,
)
action_registry.register_action(
extension_id,
"select_selection_set",
get_self_fn()._on_select_selection_set,
display_name="Edit->Selection Set",
description="Selection Set",
tag=actions_tag,
)
action_registry.register_action(
extension_id,
"select_by_kind",
get_self_fn()._on_select_by_kind,
display_name="Edit->Select By Kind",
description="Select By Kind",
tag=actions_tag,
)
action_registry.register_action(
extension_id,
"selection_invert",
lambda: select_prim(description="Inverse of", select_name="invert"),
display_name="Edit->Select Invert",
description="Select Invert",
tag=actions_tag,
)
action_registry.register_action(
extension_id,
"selection_parent",
lambda: select_prim(description="Parent of", select_name="parent"),
display_name="Edit->Select Parent",
description="Select Parent",
tag=actions_tag,
)
action_registry.register_action(
extension_id,
"selection_leaf",
lambda: select_prim(description="Leaves of", select_name="leaf"),
display_name="Edit->Select Leaf",
description="Select Leaf",
tag=actions_tag,
)
action_registry.register_action(
extension_id,
"selection_hierarchy",
lambda: select_prim(description="Hierarchy of", select_name="hierarchy"),
display_name="Edit->Select Hierarchy",
description="Select Hierarchy",
tag=actions_tag,
)
action_registry.register_action(
extension_id,
"selection_similar",
lambda: select_prim(description="Similar of", select_name="similar"),
display_name="Edit->Select Similar",
description="Select Similar",
tag=actions_tag,
)
action_registry.register_action(
extension_id,
"create_selection_set",
get_self_fn()._create_selection_set,
display_name="Edit->Create Selection Set",
description="Create Selection Set",
tag=actions_tag,
)
action_registry.register_action(
extension_id,
"instance_prim",
cls.instance_prim,
display_name="Edit->Instance Prim",
description="Instance Prim",
tag=actions_tag,
)
action_registry.register_action(
extension_id,
"duplicate_prim",
lambda: cls.duplicate_prim(duplicate_layers=False, combine_layers=False),
display_name="Edit->Duplicate Prim",
description="Duplicate Prim",
tag=actions_tag,
)
action_registry.register_action(
extension_id,
"duplicate_prim_and_layers",
lambda: cls.duplicate_prim(duplicate_layers=True, combine_layers=False),
display_name="Edit->Duplicate Prim & Duplicate Layers",
description="Duplicate Prim & Duplicate Layers",
tag=actions_tag,
)
action_registry.register_action(
extension_id,
"duplicate_prim_and_combine_layers",
lambda: cls.duplicate_prim(duplicate_layers=True, combine_layers=True),
display_name="Edit->Duplicate Prim & Combine Layers",
description="Duplicate Prim & Combine Layers",
tag=actions_tag,
)
action_registry.register_action(
extension_id,
"parent_prims",
cls.parent_prims,
display_name="Edit->Parent Prims",
description="Parent Prims",
tag=actions_tag,
)
action_registry.register_action(
extension_id,
"unparent_prims",
cls.unparent_prims,
display_name="Edit->Unparent Prims",
description="Unparent Prims",
tag=actions_tag,
)
action_registry.register_action(
extension_id,
"create_xform_to_group",
cls.create_xform_to_group,
display_name="Edit->Create XForm To Group",
description="Create XForm To Group",
tag=actions_tag,
)
action_registry.register_action(
extension_id,
"ungroup_prims",
cls.ungroup_prims,
display_name="Edit->Create XForm To Group",
description="Create XForm To Group",
tag=actions_tag,
)
action_registry.register_action(
extension_id,
"toggle_visibillity",
cls.toggle_visibillity,
display_name="Edit->Toggle Visibillity",
description="Toggle Visibillity",
tag=actions_tag,
)
action_registry.register_action(
extension_id,
"delete_prim",
lambda: cls.delete_prim(False),
display_name="Edit->Delete Prim",
description="Delete Prim",
tag=actions_tag,
)
action_registry.register_action(
extension_id,
"delete_prim_all_layers",
lambda: cls.delete_prim(True),
display_name="Edit->Delete Prim - All Layers",
description="Delete Prim - All Layers",
tag=actions_tag,
)
action_registry.register_action(
extension_id,
"menu_rename_prim_dialog",
get_self_fn().menu_rename_prim_dialog,
display_name="Edit->Rename Prim",
description="Rename Prim",
tag=actions_tag,
)
action_registry.register_action(
extension_id,
"focus_prim",
cls.focus_prim,
display_name="Edit->Focus Prim",
description="Focus Prim",
tag=actions_tag,
)
action_registry.register_action(
extension_id,
"toggle_global_visibility",
cls.toggle_global_visibility,
display_name="Edit->Toggle Global Visibility",
description="Toggle Global Visibility",
tag=actions_tag,
)
action_registry.register_action(
extension_id,
"capture_screenshot",
cls.capture_screenshot,
display_name="Edit->Capture Screenshot",
description="Capture Screenshot",
tag=actions_tag,
)
def deregister_actions(extension_id):
action_registry = omni.kit.actions.core.get_action_registry()
action_registry.deregister_all_actions_for_extension(extension_id)
| 8,022 | Python | 29.976834 | 94 | 0.614186 |
omniverse-code/kit/exts/omni.kit.menu.edit/omni/kit/menu/edit/scripts/__init__.py | from .edit import *
| 20 | Python | 9.499995 | 19 | 0.7 |
omniverse-code/kit/exts/omni.kit.menu.edit/omni/kit/menu/edit/scripts/selection.py | import time
class Selection():
def __init__(self, description, selection):
self.time = time.time()
self.description = description
self.selection = selection
def touch(self):
self.time = time.time()
| 240 | Python | 20.909089 | 47 | 0.6125 |
omniverse-code/kit/exts/omni.kit.menu.edit/omni/kit/menu/edit/scripts/selection_window.py | import omni.ui as ui
class SelectionSetWindow():
def __init__(self, callback):
self._callback = callback
window = ui.Window(
"Selection Set Name",
width=300,
height=110,
flags=ui.WINDOW_FLAGS_NO_RESIZE | ui.WINDOW_FLAGS_NO_SCROLLBAR | ui.WINDOW_FLAGS_MODAL
)
with window.frame:
def on_create(widget):
self._callback(widget.model.as_string)
window.visible = False
def on_cancel():
window.visible = False
with ui.VStack(
height=0,
spacing=5,
name="top_level_stack",
style={"VStack::top_level_stack": {"margin": 5}, "Button": {"margin": 0}},
):
ui.Label("New selection set name:")
widget = ui.StringField()
ui.Spacer(width=5, height=5)
with ui.HStack(spacing=5):
create_button = ui.Button("Create", enabled=False, clicked_fn=lambda w=widget: on_create(w))
ui.Button("Cancel", clicked_fn=lambda: on_cancel())
def window_pressed_key(key_index, key_flags, key_down):
import carb.input
create_button.enabled = bool(len(widget.model.as_string) > 0)
key_mod = key_flags & ~ui.Widget.FLAG_WANT_CAPTURE_KEYBOARD
if create_button.enabled and carb.input.KeyboardInput(key_index) in [carb.input.KeyboardInput.ENTER, carb.input.KeyboardInput.NUMPAD_ENTER] and key_mod == 0 and key_down:
on_create(widget)
widget.focus_keyboard()
window.set_key_pressed_fn(window_pressed_key)
self._window = window
self._widget = widget
def shutdown(self):
self._callback = None
del self._window
def show(self):
self._window.visible = True
self._widget.model.set_value("")
self._widget.focus_keyboard()
| 2,049 | Python | 34.964912 | 190 | 0.532455 |
omniverse-code/kit/exts/omni.kit.menu.edit/omni/kit/menu/edit/tests/test_func_edit_undo.py | import asyncio
import carb
import omni.usd
import omni.ui as ui
from omni.kit import ui_test
from omni.kit.menu.utils import MenuItemDescription, MenuLayout
async def edit_test_func_edit_undo(tester, menu_item: MenuItemDescription):
stage = omni.usd.get_context().get_stage()
menu_widget = ui_test.get_menubar()
# verify no prims
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == [])
## create prim
omni.kit.commands.execute("CreatePrimWithDefaultXform", prim_type="Sphere")
await ui_test.human_delay()
# verify prim created
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == ['/Sphere'])
# click undo
await menu_widget.find_menu("Edit").click()
await menu_widget.find_menu("Undo").click()
await ui_test.human_delay()
# verify no prims
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == [])
async def edit_test_hotkey_func_edit_undo(tester, menu_item: MenuItemDescription):
stage = omni.usd.get_context().get_stage()
# verify no prims
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == [])
## create prim
omni.kit.commands.execute("CreatePrimWithDefaultXform", prim_type="Sphere")
await ui_test.human_delay()
# verify prim created
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == ['/Sphere'])
# hotkey
await ui_test.emulate_keyboard_press(menu_item.hotkey[1], menu_item.hotkey[0])
# verify no prims
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == [])
async def edit_test_func_edit_redo(tester, menu_item: MenuItemDescription):
stage = omni.usd.get_context().get_stage()
menu_widget = ui_test.get_menubar()
# verify no prims
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == [])
# do/undo so redo will work
await edit_test_func_edit_undo(tester, None)
# click redo
await menu_widget.find_menu("Edit").click()
await menu_widget.find_menu("Redo").click()
await ui_test.human_delay()
# verify sphere re-created prims
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == ['/Sphere'])
async def edit_test_hotkey_func_edit_redo(tester, menu_item: MenuItemDescription):
stage = omni.usd.get_context().get_stage()
# verify no prims
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == [])
# do/undo so redo will work
await edit_test_func_edit_undo(tester, None)
# hotkey
await ui_test.emulate_keyboard_press(menu_item.hotkey[1], menu_item.hotkey[0])
# verify sphere re-created prims
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == ['/Sphere'])
async def edit_test_func_edit_repeat(tester, menu_item: MenuItemDescription):
menu_widget = ui_test.get_menubar()
# verify no prims
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == [])
## create prim
omni.kit.commands.execute("CreatePrimWithDefaultXform", prim_type="Sphere")
await ui_test.human_delay()
# verify prim created
prim_list = tester.get_stage_prims()
tester.assertListEqual(prim_list, ['/Sphere'])
# click repeat
await menu_widget.find_menu("Edit").click()
await menu_widget.find_menu("Repeat").click()
await ui_test.human_delay()
# verify prim was repeated
prim_list = tester.get_stage_prims()
tester.assertListEqual(prim_list, ['/Sphere', '/Sphere_01'])
async def edit_test_hotkey_func_edit_repeat(tester, menu_item: MenuItemDescription):
# verify no prims
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == [])
## create prim
omni.kit.commands.execute("CreatePrimWithDefaultXform", prim_type="Sphere")
await ui_test.human_delay()
# verify prim created
prim_list = tester.get_stage_prims()
tester.assertListEqual(prim_list, ['/Sphere'])
# hotkey
await ui_test.emulate_keyboard_press(menu_item.hotkey[1], menu_item.hotkey[0])
# verify prim was repeated
prim_list = tester.get_stage_prims()
tester.assertListEqual(prim_list, ['/Sphere', '/Sphere_01'])
| 4,210 | Python | 28.865248 | 84 | 0.677197 |
omniverse-code/kit/exts/omni.kit.menu.edit/omni/kit/menu/edit/tests/test_func_edit_misc.py | import asyncio
import carb
import omni.usd
import omni.ui as ui
from omni.kit import ui_test
from omni.kit.menu.utils import MenuItemDescription, MenuLayout
from omni.kit.viewport.utility.camera_state import ViewportCameraState
from pathlib import Path
async def edit_test_func_edit_focus(tester, menu_item: MenuItemDescription):
# get file path
extension_path = omni.kit.app.get_app().get_extension_manager().get_extension_path_by_module(__name__)
await omni.usd.get_context().open_stage_async(str(Path(extension_path).joinpath("data").joinpath("tests").joinpath("stages").joinpath("focus_prims.usda")))
# test focus
stage = omni.usd.get_context().get_stage()
prim_pos = ViewportCameraState().position_world
for prim_path in ['/World/Cone', '/World/Cube', '/World/Sphere', '/World/defaultLight']:
# select prim
omni.usd.get_context().get_selection().set_selected_prim_paths([prim_path], True)
# use menu
await ui_test.menu_click("Edit/Focus")
await ui_test.human_delay(50)
# verify camera has moved
pos = ViewportCameraState().position_world
tester.assertTrue(pos != prim_pos)
prim_pos = pos
async def edit_test_hotkey_func_edit_focus(tester, menu_item: MenuItemDescription):
# get file path
extension_path = omni.kit.app.get_app().get_extension_manager().get_extension_path_by_module(__name__)
await omni.usd.get_context().open_stage_async(str(Path(extension_path).joinpath("data").joinpath("tests").joinpath("stages").joinpath("focus_prims.usda")))
# test focus
stage = omni.usd.get_context().get_stage()
prim_pos = ViewportCameraState().position_world
for prim_path in ['/World/Cone', '/World/Cube', '/World/Sphere', '/World/defaultLight']:
# select prim
omni.usd.get_context().get_selection().set_selected_prim_paths([prim_path], True)
# hotkey
await ui_test.emulate_keyboard_press(menu_item.hotkey[1], menu_item.hotkey[0])
await ui_test.human_delay(50)
# verify camera has moved
pos = ViewportCameraState().position_world
tester.assertTrue(pos != prim_pos)
prim_pos = pos
async def edit_test_func_edit_toggle_visualization_mode(tester, menu_item: MenuItemDescription):
# this test is odd due to the way viewport changed grid/display state
# it is only tested on legacy Viewport as the test is against implememtation details / settings
from omni.kit.viewport.utility import get_active_viewport
if not hasattr(get_active_viewport(), "legacy_window"):
return
settings = carb.settings.get_settings()
def get_state():
return (settings.get("/app/viewport/grid/enabled"),
settings.get("/persistent/app/viewport/displayOptions"))
async def run_toggle():
# use menu item
await ui_test.menu_click("Edit/Toggle Visualization Mode")
await ui_test.human_delay(1)
return get_state()
# Grab state to restore to
grid_restore, display_restore = get_state()
try:
# Setup state to test against
grid_state_a, display_state_a = True, 32767
settings.set("/app/viewport/grid/enabled", grid_state_a)
settings.set("/persistent/app/viewport/displayOptions", display_state_a)
# run the menu item
grid_state_b, display_state_b = await run_toggle()
# values should not be equal fro mthe toggle
tester.assertNotEqual(grid_state_a, grid_state_b)
tester.assertNotEqual(display_state_a, display_state_b)
# run the menu item
grid_state_b, display_state_b = await run_toggle()
# verify state changed back to original
tester.assertEqual(grid_state_a, grid_state_b)
tester.assertEqual(display_state_a, display_state_b)
finally:
# Restore to incoming state for any other tests
settings.set("/app/viewport/grid/enabled", grid_restore)
settings.set("/persistent/app/viewport/displayOptions", display_restore)
async def edit_test_func_edit_capture_screenshot(tester, menu_item: MenuItemDescription):
warning_count = 0
def on_log_event(e):
if e.payload["level"] == carb.logging.LEVEL_WARN:
nonlocal warning_count
warning_count += 1
# log event, count number of warnings outputed - FIXME: can I parse log and get messages?
log_stream = omni.kit.app.get_app().get_log_event_stream()
log_sub = log_stream.create_subscription_to_pop(on_log_event, name="edit_test_func_edit_capture_screenshot log event")
# use menu
await ui_test.menu_click("Edit/Capture Screenshot")
# wait for screenshot to finish
await ui_test.human_delay(100)
log_stream = None
log_sub = None
tester.assertTrue(warning_count == 1)
async def edit_test_hotkey_func_edit_capture_screenshot(tester, menu_item: MenuItemDescription):
warning_count = 0
def on_log_event(e):
if e.payload["level"] == carb.logging.LEVEL_WARN:
nonlocal warning_count
warning_count += 1
# log event, count number of warnings outputed - FIXME: can I parse log and get messages?
log_stream = omni.kit.app.get_app().get_log_event_stream()
log_sub = log_stream.create_subscription_to_pop(on_log_event, name="edit_test_func_edit_capture_screenshot log event")
# hotkey
await ui_test.emulate_keyboard_press(menu_item.hotkey[1], menu_item.hotkey[0])
# wait for screenshot to finish
await ui_test.human_delay(100)
log_stream = None
log_sub = None
tester.assertTrue(warning_count == 1)
async def _edit_test_hotkey_func_edit_toggle_some_visibility(tester, menu_item: MenuItemDescription, setting_key: str):
settings = carb.settings.get_settings()
initial_state = settings.get(setting_key) or False
await ui_test.emulate_keyboard_press(menu_item.hotkey[1])
await ui_test.human_delay(2)
tester.assertNotEqual(settings.get(setting_key), initial_state)
await ui_test.emulate_keyboard_press(menu_item.hotkey[1])
await ui_test.human_delay(2)
tester.assertEqual(settings.get(setting_key), initial_state)
| 6,165 | Python | 38.025316 | 159 | 0.683536 |
omniverse-code/kit/exts/omni.kit.menu.edit/omni/kit/menu/edit/tests/__init__.py | from .edit_tests import *
from .rename_tests import *
| 54 | Python | 17.333328 | 27 | 0.740741 |
omniverse-code/kit/exts/omni.kit.menu.edit/omni/kit/menu/edit/tests/rename_tests.py | import sys
import re
import asyncio
import unittest
import carb
import omni.kit.test
import omni.kit.ui_test as ui_test
import omni.kit.commands
from carb.input import KeyboardInput
class TestMenuEditRename(omni.kit.test.AsyncTestCase):
async def setUp(self):
from omni.kit.test_suite.helpers import arrange_windows
await arrange_windows()
await omni.usd.get_context().new_stage_async()
async def tearDown(self):
pass
async def test_edit_menu_rename(self):
import omni.kit.material.library
from omni.kit.test_suite.helpers import get_test_data_path, wait_stage_loading, get_prims
# wait for material to be preloaded so create menu is complete & menus don't rebuild during tests
await omni.kit.material.library.get_mdl_list_async()
await ui_test.human_delay()
## create prim
omni.kit.commands.execute("CreatePrimWithDefaultXform", prim_type="Sphere")
await ui_test.human_delay()
# verify prims were created
stage = omni.usd.get_context().get_stage()
prim_list = [prim.GetPath().pathString for prim in get_prims(stage) if not omni.usd.is_hidden_type(prim)]
self.assertTrue(prim_list == ['/Sphere'])
# select prim
omni.usd.get_context().get_selection().set_selected_prim_paths(['/Sphere'], True)
await ui_test.human_delay()
# use menu - As omni.kit.window.stage is loaded then that should
# be used to rename, not dialog like in edit_test_func_edit_rename
await ui_test.menu_click("Edit/Rename")
# type new name
await ui_test.human_delay()
await ui_test.emulate_keyboard_press(KeyboardInput.DEL)
await ui_test.human_delay()
await ui_test.emulate_char_press("MyHovercraftISFullOfEels@@xx1/\!!")
await ui_test.human_delay()
await ui_test.emulate_keyboard_press(KeyboardInput.ENTER)
await ui_test.human_delay()
# verify rename worked and bad characters were handled
prim_list = [prim.GetPath().pathString for prim in get_prims(stage) if not omni.usd.is_hidden_type(prim)]
self.assertTrue(prim_list == ['/MyHovercraftISFullOfEels__xx1____'])
# test undo
omni.kit.undo.undo()
await ui_test.human_delay()
prim_list = [prim.GetPath().pathString for prim in get_prims(stage) if not omni.usd.is_hidden_type(prim)]
self.assertTrue(prim_list == ['/Sphere'])
| 2,477 | Python | 37.123076 | 113 | 0.666532 |
omniverse-code/kit/exts/omni.kit.menu.edit/omni/kit/menu/edit/tests/test_func_edit_select.py | import asyncio
import carb
import omni.usd
import omni.ui as ui
from omni.kit import ui_test
from omni.kit.menu.utils import MenuItemDescription, MenuLayout
async def edit_test_func_edit_select_select_all(tester, menu_item: MenuItemDescription):
stage = omni.usd.get_context().get_stage()
## create prim
omni.kit.commands.execute("CreatePrimWithDefaultXform", prim_type="Sphere")
omni.kit.commands.execute("CreatePrimWithDefaultXform", prim_type="Xform")
omni.kit.commands.execute("CreatePrimWithDefaultXform", prim_type="Cube")
await ui_test.human_delay()
# verify prims were created
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == ['/Sphere', '/Xform', '/Cube'])
# use menu
await ui_test.menu_click("Edit/Select/Select All")
# verify all prims are selected
tester.assertTrue(omni.usd.get_context().get_selection().get_selected_prim_paths() == prim_list)
async def edit_test_hotkey_func_edit_select_select_all(tester, menu_item: MenuItemDescription):
stage = omni.usd.get_context().get_stage()
## create prim
omni.kit.commands.execute("CreatePrimWithDefaultXform", prim_type="Sphere")
omni.kit.commands.execute("CreatePrimWithDefaultXform", prim_type="Xform")
omni.kit.commands.execute("CreatePrimWithDefaultXform", prim_type="Cube")
await ui_test.human_delay()
# verify prims were created
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == ['/Sphere', '/Xform', '/Cube'])
# hotkey
await ui_test.emulate_keyboard_press(menu_item.hotkey[1], menu_item.hotkey[0])
# verify all prims are selected
tester.assertTrue(omni.usd.get_context().get_selection().get_selected_prim_paths() == prim_list)
async def edit_test_func_edit_select_select_none(tester, menu_item: MenuItemDescription):
stage = omni.usd.get_context().get_stage()
## create prim
omni.kit.commands.execute("CreatePrimWithDefaultXform", prim_type="Sphere")
omni.kit.commands.execute("CreatePrimWithDefaultXform", prim_type="Xform")
omni.kit.commands.execute("CreatePrimWithDefaultXform", prim_type="Cube")
await ui_test.human_delay()
# verify prims were created
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == ['/Sphere', '/Xform', '/Cube'])
# select prims
omni.usd.get_context().get_selection().set_selected_prim_paths(prim_list, True)
await ui_test.human_delay()
# use menu
await ui_test.menu_click("Edit/Select/Select None")
# verify all prims are selected
tester.assertTrue(omni.usd.get_context().get_selection().get_selected_prim_paths() == [])
async def edit_test_hotkey_func_edit_select_select_none(tester, menu_item: MenuItemDescription):
stage = omni.usd.get_context().get_stage()
## create prim
omni.kit.commands.execute("CreatePrimWithDefaultXform", prim_type="Sphere")
omni.kit.commands.execute("CreatePrimWithDefaultXform", prim_type="Xform")
omni.kit.commands.execute("CreatePrimWithDefaultXform", prim_type="Cube")
await ui_test.human_delay()
# verify prims were created
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == ['/Sphere', '/Xform', '/Cube'])
# select prims
omni.usd.get_context().get_selection().set_selected_prim_paths(prim_list, True)
await ui_test.human_delay()
# hotkey
await ui_test.emulate_keyboard_press(menu_item.hotkey[1], menu_item.hotkey[0])
# verify all prims are selected
tester.assertTrue(omni.usd.get_context().get_selection().get_selected_prim_paths() == [])
async def edit_test_func_edit_select_select_invert(tester, menu_item: MenuItemDescription):
stage = omni.usd.get_context().get_stage()
## create prim
omni.kit.commands.execute("CreatePrimWithDefaultXform", prim_type="Sphere")
omni.kit.commands.execute("CreatePrimWithDefaultXform", prim_type="Xform")
omni.kit.commands.execute("CreatePrimWithDefaultXform", prim_type="Cube")
await ui_test.human_delay()
# verify prims were created
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == ['/Sphere', '/Xform', '/Cube'])
# select prims
omni.usd.get_context().get_selection().set_selected_prim_paths(['/Xform'], True)
await ui_test.human_delay()
# verify prim is selected
tester.assertTrue(omni.usd.get_context().get_selection().get_selected_prim_paths() == ['/Xform'])
# use menu
await ui_test.menu_click("Edit/Select/Select Invert")
# verify all prims are selected
tester.assertTrue(omni.usd.get_context().get_selection().get_selected_prim_paths() == ['/Sphere', '/Cube'])
async def edit_test_hotkey_func_edit_select_select_invert(tester, menu_item: MenuItemDescription):
stage = omni.usd.get_context().get_stage()
## create prim
omni.kit.commands.execute("CreatePrimWithDefaultXform", prim_type="Sphere")
omni.kit.commands.execute("CreatePrimWithDefaultXform", prim_type="Xform")
omni.kit.commands.execute("CreatePrimWithDefaultXform", prim_type="Cube")
await ui_test.human_delay()
# verify prims were created
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == ['/Sphere', '/Xform', '/Cube'])
# select prims
omni.usd.get_context().get_selection().set_selected_prim_paths(['/Xform'], True)
await ui_test.human_delay()
# verify prim is selected
tester.assertTrue(omni.usd.get_context().get_selection().get_selected_prim_paths() == ['/Xform'])
# hotkey
await ui_test.emulate_keyboard_press(menu_item.hotkey[1], menu_item.hotkey[0])
# verify all prims are selected
tester.assertTrue(omni.usd.get_context().get_selection().get_selected_prim_paths() == ['/Sphere', '/Cube'])
async def edit_test_func_edit_select_select_parent(tester, menu_item: MenuItemDescription):
stage = omni.usd.get_context().get_stage()
# verify no prims
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == [])
## create prim
omni.kit.commands.execute("CreatePrimWithDefaultXform", prim_type="Sphere")
await ui_test.human_delay()
# verify prims were created
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == ['/Sphere'])
# select prim
omni.usd.get_context().get_selection().set_selected_prim_paths(['/Sphere'], True)
await ui_test.human_delay()
# use menu
await ui_test.menu_click("Edit/Group")
omni.usd.get_context().get_selection().set_selected_prim_paths(['/Group/Sphere'], True)
# use menu
await ui_test.menu_click("Edit/Select/Select Parent")
# verify
tester.assertTrue(omni.usd.get_context().get_selection().get_selected_prim_paths() == ['/Group'])
async def edit_test_hotkey_func_edit_select_select_parent(tester, menu_item: MenuItemDescription):
stage = omni.usd.get_context().get_stage()
# verify no prims
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == [])
## create prim
omni.kit.commands.execute("CreatePrimWithDefaultXform", prim_type="Sphere")
await ui_test.human_delay()
# verify prims were created
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == ['/Sphere'])
# select prim
omni.usd.get_context().get_selection().set_selected_prim_paths(['/Sphere'], True)
await ui_test.human_delay()
# use menu
await ui_test.menu_click("Edit/Group")
omni.usd.get_context().get_selection().set_selected_prim_paths(['/Group/Sphere'], True)
# hotkey
await ui_test.emulate_keyboard_press(menu_item.hotkey[1], menu_item.hotkey[0])
tester.assertTrue(omni.usd.get_context().get_selection().get_selected_prim_paths() == ['/Group'])
async def edit_test_func_edit_select_select_leaf(tester, menu_item: MenuItemDescription):
from pathlib import Path
# get file path
extension_path = omni.kit.app.get_app().get_extension_manager().get_extension_path_by_module(__name__)
await omni.usd.get_context().open_stage_async(str(Path(extension_path).joinpath("data").joinpath("tests").joinpath("stages").joinpath("leaf_test.usda")))
stage = omni.usd.get_context().get_stage()
# select prim
omni.usd.get_context().get_selection().set_selected_prim_paths(['/World'], True)
await ui_test.human_delay()
# use menu
await ui_test.menu_click("Edit/Select/Select Leaf")
await ui_test.human_delay()
# verify world leafs
leafs = omni.usd.get_context().get_selection().get_selected_prim_paths()
tester.assertTrue(leafs == ['/World/Cone', '/World/Cube', '/World/Cylinder', '/World/Disk', '/World/Plane', '/World/Scope/Capsule', '/World/Scope/Cylinder', '/World/Sphere', '/World/Torus', '/World/defaultLight'])
# select prim
omni.usd.get_context().get_selection().set_selected_prim_paths(['/World/Scope'], True)
await ui_test.human_delay()
# use menu
await ui_test.menu_click("Edit/Select/Select Leaf")
await ui_test.human_delay()
# verify scope leafs
leafs = omni.usd.get_context().get_selection().get_selected_prim_paths()
tester.assertTrue(leafs == ['/World/Scope/Capsule', '/World/Scope/Cylinder'])
async def edit_test_func_edit_select_select_hierarchy(tester, menu_item: MenuItemDescription):
from pathlib import Path
# get file path
extension_path = omni.kit.app.get_app().get_extension_manager().get_extension_path_by_module(__name__)
await omni.usd.get_context().open_stage_async(str(Path(extension_path).joinpath("data").joinpath("tests").joinpath("stages").joinpath("leaf_test.usda")))
stage = omni.usd.get_context().get_stage()
# select prim
omni.usd.get_context().get_selection().set_selected_prim_paths(['/World'], True)
await ui_test.human_delay()
# use menu
await ui_test.menu_click("Edit/Select/Select Hierarchy")
await ui_test.human_delay()
# verify world leafs
hierarchy = omni.usd.get_context().get_selection().get_selected_prim_paths()
tester.assertTrue(hierarchy == ['/World', '/World/Cone', '/World/Cube', '/World/Cylinder', '/World/Disk', '/World/Plane', '/World/Scope', '/World/Scope/Capsule', '/World/Scope/Cylinder', '/World/Sphere', '/World/Torus', '/World/defaultLight'])
# select prim
omni.usd.get_context().get_selection().set_selected_prim_paths(['/World/Scope'], True)
await ui_test.human_delay()
# use menu
await ui_test.menu_click("Edit/Select/Select Hierarchy")
await ui_test.human_delay()
# verify scope leafs
hierarchy = omni.usd.get_context().get_selection().get_selected_prim_paths()
tester.assertTrue(hierarchy == ['/World/Scope', '/World/Scope/Capsule', '/World/Scope/Cylinder'])
async def edit_test_func_edit_select_select_similar(tester, menu_item: MenuItemDescription):
from pathlib import Path
# get file path
extension_path = omni.kit.app.get_app().get_extension_manager().get_extension_path_by_module(__name__)
await omni.usd.get_context().open_stage_async(str(Path(extension_path).joinpath("data").joinpath("tests").joinpath("stages").joinpath("leaf_test.usda")))
stage = omni.usd.get_context().get_stage()
# NOTE: prim names do not reflect prim types
expected = {
"/World": ['/World'],
"/World/defaultLight": ['/World/defaultLight'],
"/World/Cone": ['/World/Cone', '/World/Cylinder', '/World/Torus', '/World/Scope/Capsule'],
"/World/Cube": ['/World/Cube', '/World/Plane'],
"/World/Cylinder": ['/World/Cone', '/World/Cylinder', '/World/Torus', '/World/Scope/Capsule'],
"/World/Disk": ['/World/Disk', '/World/Sphere', '/World/Scope/Cylinder'],
"/World/Plane": ['/World/Cube', '/World/Plane'],
"/World/Sphere": ['/World/Disk', '/World/Sphere', '/World/Scope/Cylinder'],
"/World/Torus": ['/World/Cone', '/World/Cylinder', '/World/Torus', '/World/Scope/Capsule'],
"/World/Scope": ['/World/Scope'],
"/World/Scope/Capsule": ['/World/Cone', '/World/Cylinder', '/World/Torus', '/World/Scope/Capsule'],
"/World/Scope/Cylinder": ['/World/Disk', '/World/Sphere', '/World/Scope/Cylinder'],
}
for prim_name in tester.get_stage_prims():
# select prim
omni.usd.get_context().get_selection().set_selected_prim_paths([prim_name], True)
await ui_test.human_delay()
# use menu
await ui_test.menu_click("Edit/Select/Select Similar")
await ui_test.human_delay()
similar = omni.usd.get_context().get_selection().get_selected_prim_paths()
tester.assertTrue(expected[prim_name] == similar)
async def edit_test_func_edit_select_create_selection_set(tester, menu_item: MenuItemDescription):
from carb.input import KeyboardInput
stage = omni.usd.get_context().get_stage()
## create prim
omni.kit.commands.execute("CreatePrimWithDefaultXform", prim_type="Sphere")
omni.kit.commands.execute("CreatePrimWithDefaultXform", prim_type="Xform")
omni.kit.commands.execute("CreatePrimWithDefaultXform", prim_type="Cube")
await ui_test.human_delay()
# use menu
await ui_test.menu_click("Edit/Select/Select All")
await ui_test.human_delay()
await ui_test.menu_click("Edit/Select/Create Selection Set")
await ui_test.human_delay()
widget = ui_test.find("Selection Set Name//Frame/**/StringField[*]")
await widget.click(double=True)
await ui_test.human_delay()
await ui_test.emulate_keyboard_press(KeyboardInput.DEL)
await ui_test.human_delay()
await ui_test.emulate_char_press("All")
await ui_test.human_delay()
await ui_test.emulate_keyboard_press(KeyboardInput.ENTER)
await ui_test.human_delay()
# verify "All"
omni.usd.get_context().get_selection().set_selected_prim_paths([], True)
await ui_test.human_delay()
await ui_test.menu_click("Edit/Select/Select Set/All")
await ui_test.human_delay()
selected_prims = omni.usd.get_context().get_selection().get_selected_prim_paths()
tester.assertTrue(selected_prims == ['/Sphere', '/Xform', '/Cube'])
async def edit_test_func_edit_select_select_by_kind_subcomponent(tester, menu_item: MenuItemDescription):
from pathlib import Path
# get file path
extension_path = omni.kit.app.get_app().get_extension_manager().get_extension_path_by_module(__name__)
await omni.usd.get_context().open_stage_async(str(Path(extension_path).joinpath("data").joinpath("tests").joinpath("stages").joinpath("leaf_test.usda")))
stage = omni.usd.get_context().get_stage()
# use menu
await ui_test.menu_click("Edit/Select/Select by Kind/Subcomponent")
await ui_test.human_delay()
# verify world leafs
selection = omni.usd.get_context().get_selection().get_selected_prim_paths()
tester.assertEqual(selection, ['/World/Cone', '/World/Scope/Capsule'])
async def edit_test_func_edit_select_select_by_kind_component(tester, menu_item: MenuItemDescription):
from pathlib import Path
# get file path
extension_path = omni.kit.app.get_app().get_extension_manager().get_extension_path_by_module(__name__)
await omni.usd.get_context().open_stage_async(str(Path(extension_path).joinpath("data").joinpath("tests").joinpath("stages").joinpath("leaf_test.usda")))
stage = omni.usd.get_context().get_stage()
# use menu
await ui_test.menu_click("Edit/Select/Select by Kind/Component")
await ui_test.human_delay()
# verify world leafs
selection = omni.usd.get_context().get_selection().get_selected_prim_paths()
# The /OmniverseKit_* prims are added by Kit
tester.assertEqual(selection, ['/World/Cube', '/World/Disk', '/OmniverseKit_Persp', '/OmniverseKit_Front', '/OmniverseKit_Top', '/OmniverseKit_Right'])
async def edit_test_func_edit_select_select_by_kind_group(tester, menu_item: MenuItemDescription):
from pathlib import Path
# get file path
extension_path = omni.kit.app.get_app().get_extension_manager().get_extension_path_by_module(__name__)
await omni.usd.get_context().open_stage_async(str(Path(extension_path).joinpath("data").joinpath("tests").joinpath("stages").joinpath("leaf_test.usda")))
stage = omni.usd.get_context().get_stage()
# use menu
await ui_test.menu_click("Edit/Select/Select by Kind/Group")
await ui_test.human_delay()
# verify world leafs
selection = omni.usd.get_context().get_selection().get_selected_prim_paths()
tester.assertEqual(selection, ['/World/Cylinder', '/World/Plane', '/World/Sphere'])
async def edit_test_func_edit_select_select_by_kind_assembly(tester, menu_item: MenuItemDescription):
from pathlib import Path
# get file path
extension_path = omni.kit.app.get_app().get_extension_manager().get_extension_path_by_module(__name__)
await omni.usd.get_context().open_stage_async(str(Path(extension_path).joinpath("data").joinpath("tests").joinpath("stages").joinpath("leaf_test.usda")))
stage = omni.usd.get_context().get_stage()
# use menu
await ui_test.menu_click("Edit/Select/Select by Kind/Assembly")
await ui_test.human_delay()
# verify world leafs
selection = omni.usd.get_context().get_selection().get_selected_prim_paths()
tester.assertEqual(selection, ['/World/Plane'])
| 17,247 | Python | 39.872038 | 247 | 0.687424 |
omniverse-code/kit/exts/omni.kit.menu.edit/omni/kit/menu/edit/tests/test_func_edit_prims.py | import asyncio
import carb
import omni.usd
import omni.kit.undo
import omni.ui as ui
from pxr import UsdGeom
from omni.kit import ui_test
from carb.input import KeyboardInput
from omni.kit.menu.utils import MenuItemDescription, MenuLayout
async def verify_menu_item_greyed(tester, menu, state):
# open/close menu to ensure menu state is correct
menu_widget = ui_test.get_menubar()
edit_menu = menu_widget.find_menu("Edit")
await edit_menu.click()
await edit_menu.click()
# contextual menu enable/disable has been temportally removed
# check state
# widget = edit_menu.find_menu(menu.name if isinstance(menu, MenuItemDescription) else menu)
# tester.assertTrue(widget.widget.enabled == state)
async def edit_test_func_edit_instance(tester, menu_item: MenuItemDescription):
stage = omni.usd.get_context().get_stage()
# verify no prims
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == [])
## create prim
omni.kit.commands.execute("CreatePrimWithDefaultXform", prim_type="Sphere")
omni.kit.commands.execute("CreatePrimWithDefaultXform", prim_type="Xform")
await ui_test.human_delay()
# verify prims were created
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == ['/Sphere', '/Xform'])
# verify instance is grey with nothing selected
omni.usd.get_context().get_selection().set_selected_prim_paths([], True)
await verify_menu_item_greyed(tester, menu_item, False)
# verify instance is grey with sphere selected
omni.usd.get_context().get_selection().set_selected_prim_paths(['/Sphere'], True)
await ui_test.human_delay()
await verify_menu_item_greyed(tester, menu_item, False)
# verify instance is enabled with xform selected
omni.usd.get_context().get_selection().set_selected_prim_paths(['/Xform'], True)
await ui_test.human_delay()
await verify_menu_item_greyed(tester, menu_item, True)
# use menu
await ui_test.menu_click("Edit/Instance")
# verify prims
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == ['/Sphere', '/Xform', '/Xform_01'])
async def edit_test_hotkey_func_edit_instance(tester, menu_item: MenuItemDescription):
stage = omni.usd.get_context().get_stage()
# verify no prims
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == [])
## create prim
omni.kit.commands.execute("CreatePrimWithDefaultXform", prim_type="Xform")
await ui_test.human_delay()
# verify prims were created
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == ['/Xform'])
# select prims
omni.usd.get_context().get_selection().set_selected_prim_paths(['/Xform'], True)
await ui_test.human_delay()
# hotkey
await ui_test.emulate_keyboard_press(menu_item.hotkey[1], menu_item.hotkey[0])
# verify prims
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == ['/Xform', '/Xform_01'])
async def edit_test_func_edit_duplicate(tester, menu_item: MenuItemDescription):
stage = omni.usd.get_context().get_stage()
# verify no prims
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == [])
## create prim
omni.kit.commands.execute("CreatePrimWithDefaultXform", prim_type="Sphere")
await ui_test.human_delay()
# verify prims were created
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == ['/Sphere'])
# verify instance is grey with nothing selected
omni.usd.get_context().get_selection().set_selected_prim_paths([], True)
await verify_menu_item_greyed(tester, menu_item, False)
# verify instance is enabled with xform selected
omni.usd.get_context().get_selection().set_selected_prim_paths(['/Sphere'], True)
await ui_test.human_delay()
await verify_menu_item_greyed(tester, menu_item, True)
# use menu
await ui_test.menu_click("Edit/Duplicate")
# verify prims
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == ['/Sphere', '/Sphere_01'])
async def edit_test_hotkey_func_edit_duplicate(tester, menu_item: MenuItemDescription):
stage = omni.usd.get_context().get_stage()
# verify no prims
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == [])
## create prim
omni.kit.commands.execute("CreatePrimWithDefaultXform", prim_type="Sphere")
await ui_test.human_delay()
# verify prims were created
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == ['/Sphere'])
# select prims
omni.usd.get_context().get_selection().set_selected_prim_paths(['/Sphere'], True)
await ui_test.human_delay()
# hotkey
await ui_test.emulate_keyboard_press(menu_item.hotkey[1], menu_item.hotkey[0])
# verify prims
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == ['/Sphere', '/Sphere_01'])
async def edit_test_func_edit_duplicate___all_layers(tester, menu_item: MenuItemDescription):
stage = omni.usd.get_context().get_stage()
# verify no prims
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == [])
## create prim
omni.kit.commands.execute("CreatePrimWithDefaultXform", prim_type="Sphere")
await ui_test.human_delay()
# verify prims were created
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == ['/Sphere'])
# verify instance is grey with nothing selected
omni.usd.get_context().get_selection().set_selected_prim_paths([], True)
await verify_menu_item_greyed(tester, menu_item, False)
# verify instance is enabled with xform selected
omni.usd.get_context().get_selection().set_selected_prim_paths(['/Sphere'], True)
await ui_test.human_delay()
await verify_menu_item_greyed(tester, menu_item, True)
# use menu
await ui_test.menu_click("Edit/Duplicate - All Layers")
# verify prims
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == ['/Sphere', '/Sphere_01'])
async def edit_test_func_edit_duplicate___collapsed(tester, menu_item: MenuItemDescription):
stage = omni.usd.get_context().get_stage()
# verify no prims
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == [])
## create prim
omni.kit.commands.execute("CreatePrimWithDefaultXform", prim_type="Sphere")
await ui_test.human_delay()
# verify prims were created
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == ['/Sphere'])
# verify instance is grey with nothing selected
omni.usd.get_context().get_selection().set_selected_prim_paths([], True)
await verify_menu_item_greyed(tester, menu_item, False)
# verify instance is enabled with xform selected
omni.usd.get_context().get_selection().set_selected_prim_paths(['/Sphere'], True)
await ui_test.human_delay()
await verify_menu_item_greyed(tester, menu_item, True)
# use menu
await ui_test.menu_click("Edit/Duplicate - Collapsed")
# verify prims
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == ['/Sphere', '/Sphere_01'])
async def edit_test_func_edit_parent(tester, menu_item: MenuItemDescription):
stage = omni.usd.get_context().get_stage()
# verify no prims
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == [])
## create prim
omni.kit.commands.execute("CreatePrimWithDefaultXform", prim_type="Sphere")
omni.kit.commands.execute("CreatePrimWithDefaultXform", prim_type="Xform")
await ui_test.human_delay()
# verify prims were created
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == ['/Sphere', '/Xform'])
# verify instance is grey with nothing selected
omni.usd.get_context().get_selection().set_selected_prim_paths([], True)
await verify_menu_item_greyed(tester, menu_item, False)
# verify instance is grey with sphere selected
omni.usd.get_context().get_selection().set_selected_prim_paths(['/Sphere'], True)
await ui_test.human_delay()
await verify_menu_item_greyed(tester, menu_item, False)
# verify parent is enabled with prims selected
omni.usd.get_context().get_selection().set_selected_prim_paths(['/Sphere', '/Xform'], True)
await ui_test.human_delay()
await verify_menu_item_greyed(tester, menu_item, True)
# use menu
await ui_test.menu_click("Edit/Parent")
# verify prims
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == ['/Xform', '/Xform/Sphere'])
async def edit_test_hotkey_func_edit_parent(tester, menu_item: MenuItemDescription):
stage = omni.usd.get_context().get_stage()
# verify no prims
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == [])
## create prim
omni.kit.commands.execute("CreatePrimWithDefaultXform", prim_type="Sphere")
omni.kit.commands.execute("CreatePrimWithDefaultXform", prim_type="Xform")
await ui_test.human_delay()
# verify prims were created
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == ['/Sphere', '/Xform'])
# select prims
omni.usd.get_context().get_selection().set_selected_prim_paths(['/Sphere', '/Xform'], True)
await ui_test.human_delay()
await verify_menu_item_greyed(tester, menu_item, True)
# hotkey
await ui_test.emulate_keyboard_press(menu_item.hotkey[1], menu_item.hotkey[0])
# verify prims
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == ['/Xform', '/Xform/Sphere'])
async def edit_test_func_edit_unparent(tester, menu_item: MenuItemDescription):
stage = omni.usd.get_context().get_stage()
await edit_test_func_edit_parent(tester, "Parent")
# verify unparent is enabled with prims selected
omni.usd.get_context().get_selection().set_selected_prim_paths(['/Xform/Sphere'], True)
await ui_test.human_delay()
await verify_menu_item_greyed(tester, menu_item, True)
# use menu
await ui_test.menu_click("Edit/Unparent")
# verify prims
prim_list = tester.get_stage_prims()
tester.assertEqual(set(prim_list), set(['/Sphere', '/Xform']))
async def edit_test_hotkey_func_edit_unparent(tester, menu_item: MenuItemDescription):
stage = omni.usd.get_context().get_stage()
await edit_test_func_edit_parent(tester, "Parent")
# verify unparent is enabled with prims selected
omni.usd.get_context().get_selection().set_selected_prim_paths(['/Xform/Sphere'], True)
await ui_test.human_delay()
await verify_menu_item_greyed(tester, menu_item, True)
# hotkey
await ui_test.emulate_keyboard_press(menu_item.hotkey[1], menu_item.hotkey[0])
# verify prims
prim_list = tester.get_stage_prims()
tester.assertEqual(set(prim_list), set(['/Sphere', '/Xform']))
async def edit_test_func_edit_group(tester, menu_item: MenuItemDescription):
stage = omni.usd.get_context().get_stage()
# verify no prims
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == [])
## create prim
omni.kit.commands.execute("CreatePrimWithDefaultXform", prim_type="Sphere")
await ui_test.human_delay()
# verify prims were created
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == ['/Sphere'])
# verify group is grey with nothing selected
omni.usd.get_context().get_selection().set_selected_prim_paths([], True)
await verify_menu_item_greyed(tester, menu_item, False)
# verify group is enabled with xform selected
omni.usd.get_context().get_selection().set_selected_prim_paths(['/Sphere'], True)
await ui_test.human_delay()
await verify_menu_item_greyed(tester, menu_item, True)
# use menu
await ui_test.menu_click("Edit/Group")
# verify prims
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == ['/Group', '/Group/Sphere'])
# verify you cannot group DefaultPrim
omni.kit.undo.undo()
await ui_test.human_delay()
## create default prim
omni.kit.commands.execute("CreatePrimWithDefaultXform", prim_path="/World", prim_type="Scope")
await ui_test.human_delay()
prim = stage.GetPrimAtPath("/World")
stage.SetDefaultPrim(prim)
# verify prims
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == ['/Sphere', '/World'])
# group prims
omni.usd.get_context().get_selection().set_selected_prim_paths(['/Sphere', '/World'], True)
await ui_test.human_delay()
await verify_menu_item_greyed(tester, menu_item, True)
await ui_test.menu_click("Edit/Group")
# verify prims were not grouped
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == ['/Sphere', '/World'])
async def edit_test_hotkey_func_edit_group(tester, menu_item: MenuItemDescription):
stage = omni.usd.get_context().get_stage()
# verify no prims
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == [])
## create prim
omni.kit.commands.execute("CreatePrimWithDefaultXform", prim_type="Sphere")
await ui_test.human_delay()
# verify prims were created
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == ['/Sphere'])
# select prims
omni.usd.get_context().get_selection().set_selected_prim_paths(['/Sphere'], True)
await ui_test.human_delay()
# hotkey
await ui_test.emulate_keyboard_press(menu_item.hotkey[1], menu_item.hotkey[0])
# verify prims
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == ['/Group', '/Group/Sphere'])
# verify you cannot group DefaultPrim
omni.kit.undo.undo()
await ui_test.human_delay()
## create default prim
omni.kit.commands.execute("CreatePrimWithDefaultXform", prim_path="/World", prim_type="Scope")
await ui_test.human_delay()
prim = stage.GetPrimAtPath("/World")
stage.SetDefaultPrim(prim)
# verify prims
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == ['/Sphere', '/World'])
# group prims
omni.usd.get_context().get_selection().set_selected_prim_paths(['/Sphere', '/World'], True)
await ui_test.human_delay()
# hotkey
await ui_test.emulate_keyboard_press(menu_item.hotkey[1], menu_item.hotkey[0])
# verify prims were not grouped
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == ['/Sphere', '/World'])
async def edit_test_func_edit_ungroup(tester, menu_item: MenuItemDescription):
stage = omni.usd.get_context().get_stage()
# verify no prims
prim_list = tester.get_stage_prims()
tester.assertEqual(prim_list, [])
## create prim
omni.kit.commands.execute("CreatePrimWithDefaultXform", prim_type="Sphere")
await ui_test.human_delay()
# verify prims were created
prim_list = tester.get_stage_prims()
tester.assertEqual(prim_list, ['/Sphere'])
# verify ungroup is grey with nothing selected
omni.usd.get_context().get_selection().set_selected_prim_paths([], True)
await verify_menu_item_greyed(tester, menu_item, False)
# verify group is enabled with xform selected
omni.usd.get_context().get_selection().set_selected_prim_paths(['/Sphere'], True)
await ui_test.human_delay()
await verify_menu_item_greyed(tester, menu_item, True)
# use menu
await ui_test.menu_click("Edit/Group")
# verify prims
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == ['/Group', '/Group/Sphere'])
# verify ungroup is enabled with sphere selected
omni.usd.get_context().get_selection().set_selected_prim_paths(['/Group/Sphere'], True)
await ui_test.human_delay()
await verify_menu_item_greyed(tester, menu_item, True)
# ungroup prims
await verify_menu_item_greyed(tester, menu_item, True)
await ui_test.menu_click("Edit/Ungroup")
# verify prim are ungrouped
prim_list = tester.get_stage_prims()
tester.assertEqual(prim_list, ['/Sphere'])
async def edit_test_func_edit_toggle_visibility(tester, menu_item: MenuItemDescription):
stage = omni.usd.get_context().get_stage()
# verify no prims
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == [])
## create prim
omni.kit.commands.execute("CreatePrimWithDefaultXform", prim_type="Sphere")
await ui_test.human_delay()
# verify prims were created
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == ['/Sphere'])
# verify instance is grey with nothing selected
omni.usd.get_context().get_selection().set_selected_prim_paths([], True)
await verify_menu_item_greyed(tester, menu_item, False)
# verify instance is enabled with xform selected
omni.usd.get_context().get_selection().set_selected_prim_paths(['/Sphere'], True)
await ui_test.human_delay()
await verify_menu_item_greyed(tester, menu_item, True)
# verify prim inherited
tester.assertTrue(UsdGeom.Imageable(stage.GetPrimAtPath("/Sphere")).ComputeVisibility() == UsdGeom.Tokens.inherited)
# use menu
await ui_test.menu_click("Edit/Toggle Visibility")
# verify prim invisible
tester.assertTrue(UsdGeom.Imageable(stage.GetPrimAtPath("/Sphere")).ComputeVisibility() == UsdGeom.Tokens.invisible)
# use menu
await ui_test.menu_click("Edit/Toggle Visibility")
# verify prim inherited
tester.assertTrue(UsdGeom.Imageable(stage.GetPrimAtPath("/Sphere")).ComputeVisibility() == UsdGeom.Tokens.inherited)
async def edit_test_hotkey_func_edit_toggle_visibility(tester, menu_item: MenuItemDescription):
stage = omni.usd.get_context().get_stage()
# verify no prims
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == [])
## create prim
omni.kit.commands.execute("CreatePrimWithDefaultXform", prim_type="Sphere")
await ui_test.human_delay()
# verify prims were created
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == ['/Sphere'])
# select prim
omni.usd.get_context().get_selection().set_selected_prim_paths(['/Sphere'], True)
await ui_test.human_delay()
# verify prim inherited
tester.assertTrue(UsdGeom.Imageable(stage.GetPrimAtPath("/Sphere")).ComputeVisibility() == UsdGeom.Tokens.inherited)
# hotkey
await ui_test.emulate_keyboard_press(menu_item.hotkey[1], menu_item.hotkey[0])
# verify prim invisible
tester.assertTrue(UsdGeom.Imageable(stage.GetPrimAtPath("/Sphere")).ComputeVisibility() == UsdGeom.Tokens.invisible)
# hotkey
await ui_test.emulate_keyboard_press(menu_item.hotkey[1], menu_item.hotkey[0])
# verify prim inherited
tester.assertTrue(UsdGeom.Imageable(stage.GetPrimAtPath("/Sphere")).ComputeVisibility() == UsdGeom.Tokens.inherited)
async def edit_test_func_edit_delete(tester, menu_item: MenuItemDescription):
stage = omni.usd.get_context().get_stage()
# verify no prims
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == [])
## create prim
omni.kit.commands.execute("CreatePrimWithDefaultXform", prim_type="Sphere")
await ui_test.human_delay()
# verify prims were created
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == ['/Sphere'])
# verify instance is grey with nothing selected
omni.usd.get_context().get_selection().set_selected_prim_paths([], True)
await verify_menu_item_greyed(tester, menu_item, False)
# verify instance is enabled with xform selected
omni.usd.get_context().get_selection().set_selected_prim_paths(['/Sphere'], True)
await ui_test.human_delay()
await verify_menu_item_greyed(tester, menu_item, True)
# use menu
await ui_test.menu_click("Edit/Delete")
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == [])
async def edit_test_func_edit_delete___all_layers(tester, menu_item: MenuItemDescription):
stage = omni.usd.get_context().get_stage()
# verify no prims
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == [])
## create prim
omni.kit.commands.execute("CreatePrimWithDefaultXform", prim_type="Sphere")
await ui_test.human_delay()
# verify prims were created
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == ['/Sphere'])
# verify instance is grey with nothing selected
omni.usd.get_context().get_selection().set_selected_prim_paths([], True)
await verify_menu_item_greyed(tester, menu_item, False)
# verify instance is enabled with xform selected
omni.usd.get_context().get_selection().set_selected_prim_paths(['/Sphere'], True)
await ui_test.human_delay()
await verify_menu_item_greyed(tester, menu_item, True)
# use menu
await ui_test.menu_click("Edit/Delete - All Layers")
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == [])
async def edit_test_hotkey_func_edit_delete(tester, menu_item: MenuItemDescription):
stage = omni.usd.get_context().get_stage()
# verify no prims
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == [])
## create prim
omni.kit.commands.execute("CreatePrimWithDefaultXform", prim_type="Sphere")
await ui_test.human_delay()
# verify prims were created
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == ['/Sphere'])
# selected prim
omni.usd.get_context().get_selection().set_selected_prim_paths(['/Sphere'], True)
await ui_test.human_delay()
# hotkey
await ui_test.emulate_keyboard_press(menu_item.hotkey[1], menu_item.hotkey[0])
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == [])
async def edit_test_func_edit_rename(tester, menu_item: MenuItemDescription):
stage = omni.usd.get_context().get_stage()
# verify no prims
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == [])
## create prim
omni.kit.commands.execute("CreatePrimWithDefaultXform", prim_type="Sphere")
await ui_test.human_delay()
# verify prims were created
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == ['/Sphere'])
# verify instance is grey with nothing selected
omni.usd.get_context().get_selection().set_selected_prim_paths([], True)
await verify_menu_item_greyed(tester, menu_item, False)
# verify instance is enabled with xform selected
omni.usd.get_context().get_selection().set_selected_prim_paths(['/Sphere'], True)
await ui_test.human_delay()
await verify_menu_item_greyed(tester, menu_item, True)
# use menu
await ui_test.menu_click("Edit/Rename")
await ui_test.human_delay()
widget = ui_test.find("Rename Sphere###context_menu_rename//Frame/**/StringField[*]")
await widget.click(double=True)
await ui_test.human_delay()
await ui_test.emulate_keyboard_press(KeyboardInput.DEL)
await ui_test.human_delay()
await ui_test.emulate_char_press("MyPrim")
await ui_test.human_delay()
await ui_test.emulate_keyboard_press(KeyboardInput.ENTER)
await ui_test.human_delay()
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == ['/MyPrim'])
# again with bad characters
await ui_test.menu_click("Edit/Rename")
await ui_test.human_delay()
widget = ui_test.find("Rename Sphere###context_menu_rename//Frame/**/StringField[*]")
await widget.click(double=True)
await ui_test.human_delay()
await ui_test.emulate_keyboard_press(KeyboardInput.DEL)
await ui_test.human_delay()
await ui_test.emulate_char_press("MyPrim@@@xx/1")
await ui_test.human_delay()
await ui_test.emulate_keyboard_press(KeyboardInput.ENTER)
await ui_test.human_delay()
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == ['/MyPrim___xx_1'])
async def edit_test_hotkey_func_edit_rename(tester, menu_item: MenuItemDescription):
stage = omni.usd.get_context().get_stage()
# verify no prims
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == [])
## create prim
omni.kit.commands.execute("CreatePrimWithDefaultXform", prim_type="Sphere")
await ui_test.human_delay()
# verify prims were created
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == ['/Sphere'])
# select prim
omni.usd.get_context().get_selection().set_selected_prim_paths(['/Sphere'], True)
# hotkey
await ui_test.emulate_keyboard_press(menu_item.hotkey[1], menu_item.hotkey[0])
await ui_test.human_delay()
widget = ui_test.find("Rename Sphere###context_menu_rename//Frame/**/StringField[*]")
await widget.click(double=True)
await ui_test.human_delay()
await ui_test.emulate_keyboard_press(KeyboardInput.DEL)
await ui_test.human_delay()
await ui_test.emulate_char_press("MyPrim")
await ui_test.human_delay()
await ui_test.emulate_keyboard_press(KeyboardInput.ENTER)
await ui_test.human_delay()
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == ['/MyPrim'])
async def edit_test_func_edit_hide_unselected(tester, menu_item: MenuItemDescription):
stage = omni.usd.get_context().get_stage()
# verify no prims
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == [])
## create prim
omni.kit.commands.execute("CreatePrimWithDefaultXform", prim_type="Sphere")
omni.kit.commands.execute("CreatePrimWithDefaultXform", prim_type="Cube")
omni.kit.commands.execute("CreatePrimWithDefaultXform", prim_type="Xform")
await ui_test.human_delay()
# verify prims were created
prim_list = tester.get_stage_prims()
tester.assertTrue(prim_list == ['/Sphere', '/Cube', '/Xform'])
# verify prim invisible
tester.assertTrue(UsdGeom.Imageable(stage.GetPrimAtPath("/Sphere")).ComputeVisibility() == UsdGeom.Tokens.inherited)
tester.assertTrue(UsdGeom.Imageable(stage.GetPrimAtPath("/Cube")).ComputeVisibility() == UsdGeom.Tokens.inherited)
tester.assertTrue(UsdGeom.Imageable(stage.GetPrimAtPath("/Xform")).ComputeVisibility() == UsdGeom.Tokens.inherited)
# select prims
omni.usd.get_context().get_selection().set_selected_prim_paths(['/Cube'], True)
# use menu
await ui_test.menu_click("Edit/Hide Unselected")
# verify prims
tester.assertTrue(UsdGeom.Imageable(stage.GetPrimAtPath("/Sphere")).ComputeVisibility() == UsdGeom.Tokens.invisible)
tester.assertTrue(UsdGeom.Imageable(stage.GetPrimAtPath("/Cube")).ComputeVisibility() == UsdGeom.Tokens.inherited)
tester.assertTrue(UsdGeom.Imageable(stage.GetPrimAtPath("/Xform")).ComputeVisibility() == UsdGeom.Tokens.invisible)
async def edit_test_func_edit_unhide_all(tester, menu_item: MenuItemDescription):
stage = omni.usd.get_context().get_stage()
await edit_test_func_edit_hide_unselected(tester, None)
# use menu
await ui_test.menu_click("Edit/Unhide All")
# verify prims
tester.assertTrue(UsdGeom.Imageable(stage.GetPrimAtPath("/Sphere")).ComputeVisibility() == UsdGeom.Tokens.inherited)
tester.assertTrue(UsdGeom.Imageable(stage.GetPrimAtPath("/Cube")).ComputeVisibility() == UsdGeom.Tokens.inherited)
tester.assertTrue(UsdGeom.Imageable(stage.GetPrimAtPath("/Xform")).ComputeVisibility() == UsdGeom.Tokens.inherited)
| 27,409 | Python | 34.45925 | 120 | 0.690175 |
omniverse-code/kit/exts/omni.kit.menu.edit/docs/CHANGELOG.md | # Changelog
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
## [1.1.6] - 2022-11-29
### Changes
- Don't allow grouping of default prim
## [1.1.5] - 2022-07-28
### Changes
- Don't filter frame-command based on selection.
## [1.1.4] - 2022-07-27
### Changes
- Fix unparent regression.
## [1.1.3] - 2022-07-19
### Changes
- Disabled contextual greying of menu items
## [1.1.2] - 2022-07-08
### Added
- Hidden item for toggling Grid visibility
## [1.1.1] - 2022-06-27
### Changes
- Fixed HideUnselected & UnhideAllPrims
- Fixed menu_rename_prim_dialog
- Fixed recent menu updating
## [1.1.0] - 2022-06-08
### Changes
- Updated menus to use actions
## [1.0.8] - 2022-06-05
### Changes
- Pass tests on either Viewport
## [1.0.7] - 2022-05-24
### Changes
- Removed undo/redo greying. Menu items are always enabled
## [1.0.6] - 2022-05-23
### Changes
- Support legacy and new Viewport API
- Add dependency on omni.kit.viewport.utility
## [1.0.5] - 2021-10-27
### Changes
- Set menus default order
## [1.0.4] - 2021-10-27
### Changes
- Prevent crash in event callback
## [1.0.3] - 2021-06-11
### Changes
- Add auto-authoring mode support
## [1.0.2] - 2021-05-12
### Changes
- Added more select options
## [1.0.1] - 2021-03-15
### Changes
- Added prim parent/unparent
## [1.0.0] - 2020-12-15
### Changes
- Created
| 1,354 | Markdown | 18.084507 | 80 | 0.65288 |
omniverse-code/kit/exts/omni.kit.menu.edit/docs/index.rst | omni.kit.menu.edit
###########################
Edit Menu
.. toctree::
:maxdepth: 1
CHANGELOG
| 107 | reStructuredText | 6.2 | 27 | 0.448598 |
omniverse-code/kit/exts/omni.kit.usd.layers/config/extension.toml | [package]
version = "2.0.11"
title = "Layers Core"
description = "Layers core that extends vanilla USD and provides utilities and workflows around layers."
authors = ["NVIDIA"]
repository = ""
readme = "docs/README.md"
keywords = ["core", "layers", "usd"]
changelog = "docs/CHANGELOG.md"
icon = "data/icon.png"
[[python.module]]
name = "omni.kit.usd.layers"
[[native.plugin]]
path = "bin/*.plugin"
recursive = false
[dependencies]
"omni.usd" = {}
"omni.usd.libs" = {}
"omni.client" = {}
"omni.kit.commands" = {}
"omni.kit.collaboration.channel_manager" = {}
[[test]]
args = [
"--/app/asyncRendering=false",
"--/app/window/dpiScaleOverride=1.0",
"--/app/window/scaleToMonitor=false",
"--/persistent/app/stage/dragDropImport='reference'",
"--/persistent/app/material/dragDropMaterialPath='absolute'",
"--no-window"
]
dependencies = []
stdoutFailPatterns.include = []
stdoutFailPatterns.exclude = [
"*Cannot create session*",
"*Cannot join session*"
]
[settings]
exts."omni.kit.usd.layers".enable_server_tests = false
| 1,054 | TOML | 22.444444 | 104 | 0.674573 |
omniverse-code/kit/exts/omni.kit.usd.layers/omni/kit/usd/layers/tests/test_workflow_specs_locking.py | import asyncio
import carb
import os
import tempfile
import omni.kit.test
import omni.usd
import omni.client
from pxr import Sdf, Usd, UsdGeom, Gf
from omni.kit.usd.layers import get_layers, LayerUtils, get_layer_event_payload, LayerEventType
class TestSpecsLocking(omni.kit.test.AsyncTestCase):
# Before running each test
async def setUp(self):
self.usd_context = omni.usd.get_context()
await omni.usd.get_context().new_stage_async()
async def tearDown(self):
if omni.usd.get_context().get_stage():
await omni.usd.get_context().close_stage_async()
def __get_all_property_paths(self, prim):
paths = []
for p in prim.GetProperties():
paths.append(str(p.GetPath()))
return paths
def __get_all_prim_childrens(self, prim, hierarchy=False):
paths = [str(prim.GetPath())]
paths.extend(self.__get_all_property_paths(prim))
if hierarchy:
for child in prim.GetAllPrimChildren():
paths.append(str(child.GetPath()))
paths.extend(self.__get_all_property_paths(child))
return paths
def __get_all_stage_paths(self, stage):
paths = []
for prim in stage.TraverseAll():
paths.extend(self.__get_all_prim_childrens(prim))
return paths
async def test_lock_unlock_specs_and_events(self):
layers = get_layers()
specs_locking = layers.get_specs_locking()
event_stream = layers.get_event_stream()
payload = None
def _on_layer_event(event: carb.events.IEvent):
nonlocal payload
temp = get_layer_event_payload(event)
if temp.event_type == LayerEventType.SPECS_LOCKING_CHANGED:
payload = temp
subscription = event_stream.create_subscription_to_pop(_on_layer_event, name="layer events")
context = omni.usd.get_context()
stage = context.get_stage()
root_layer = stage.GetRootLayer()
layer0 = Sdf.Layer.CreateAnonymous()
layer1 = Sdf.Layer.CreateAnonymous()
root_layer.subLayerPaths.append(layer0.identifier)
root_layer.subLayerPaths.append(layer1.identifier)
asset_name = f"/root/test0/l1/l2/l3"
asset_prim = stage.DefinePrim(asset_name, "Xform")
UsdGeom.XformCommonAPI(asset_prim).SetTranslate(Gf.Vec3d(1.0))
all_spec_paths = set(self.__get_all_stage_paths(stage))
# Lock all
locked_paths = specs_locking.lock_spec("/", hierarchy=True)
self.assertEqual(set(locked_paths), set(all_spec_paths))
self.assertIsNotNone(payload)
self.assertEqual(payload.event_type, LayerEventType.SPECS_LOCKING_CHANGED)
self.assertEqual(set(payload.identifiers_or_spec_paths), set(all_spec_paths))
all_locked_paths = specs_locking.get_all_locked_specs()
self.assertEqual(set(all_locked_paths), set(all_spec_paths))
payload = None
unlocked_paths = specs_locking.unlock_spec("/", hierarchy=True)
self.assertEqual(set(unlocked_paths), set(locked_paths))
self.assertIsNotNone(payload)
self.assertEqual(payload.event_type, LayerEventType.SPECS_LOCKING_CHANGED)
self.assertEqual(set(payload.identifiers_or_spec_paths), set(locked_paths))
locked_paths = specs_locking.lock_spec("/root/test0", hierarchy=True)
specs_locking.unlock_all_specs()
all_unlocked_paths = specs_locking.get_all_locked_specs()
self.assertEqual(len(all_unlocked_paths), 0)
payload = None
locked_paths = specs_locking.lock_spec("/root", hierarchy=False)
self.assertEqual(locked_paths, ["/root"])
self.assertTrue(specs_locking.is_spec_locked("/root"))
self.assertFalse(specs_locking.is_spec_locked("/root/test0"))
self.assertIsNotNone(payload)
self.assertEqual(payload.event_type, LayerEventType.SPECS_LOCKING_CHANGED)
self.assertEqual(set(payload.identifiers_or_spec_paths), set(["/root"]))
payload = None
specs_locking.unlock_all_specs()
lock_single_attribute = asset_name + ".xformOp:translate"
attributes = specs_locking.lock_spec(lock_single_attribute, False)
self.assertEqual(set(attributes), set([lock_single_attribute]))
self.assertIsNotNone(payload)
self.assertEqual(payload.event_type, LayerEventType.SPECS_LOCKING_CHANGED)
self.assertEqual(set(payload.identifiers_or_spec_paths), set([lock_single_attribute]))
async def _try_to_edit_translate(self, xform_api, new_value, expected_value):
xform_api.SetTranslate(new_value)
await omni.kit.app.get_app().next_update_async()
await omni.kit.app.get_app().next_update_async()
xform_vectors = xform_api.GetXformVectors(Usd.TimeCode.Default())
self.assertEqual(xform_vectors[0], expected_value)
async def test_specs_locking_for_stage_edits(self):
layers = get_layers()
specs_locking = layers.get_specs_locking()
context = omni.usd.get_context()
root_layer = Sdf.Layer.CreateAnonymous()
stage = Usd.Stage.Open(root_layer)
# Initialize a prim and its translation
asset_name = f"/l3"
asset_prim = stage.DefinePrim(asset_name, "Xform")
xform_api = UsdGeom.XformCommonAPI(asset_prim)
# It can be changed if it's not locked.
await self._try_to_edit_translate(xform_api, Gf.Vec3d(1.0), Gf.Vec3d(1.0))
await context.attach_stage_async(stage)
layer0 = Sdf.Layer.CreateAnonymous()
root_layer.subLayerPaths.append(layer0.identifier)
locked_attribute = asset_name + ".xformOp:translate"
attributes = specs_locking.lock_spec(locked_attribute, False)
self.assertEqual(set(attributes), set([locked_attribute]))
await omni.kit.app.get_app().next_update_async()
# Try to modify translate will return to state before it's locked.
await self._try_to_edit_translate(xform_api, Gf.Vec3d(2.0), Gf.Vec3d(1.0))
# Try to modify translate to other sublayers will return to it's previous state also.
session_layer = stage.GetSessionLayer()
with Usd.EditContext(stage, session_layer):
await self._try_to_edit_translate(xform_api, Gf.Vec3d(2.0), Gf.Vec3d(1.0))
self.assertFalse(session_layer.GetPrimAtPath(locked_attribute))
self.assertFalse(session_layer.GetPrimAtPath(asset_name + ".xformOpOrder"))
with Usd.EditContext(stage, layer0):
await self._try_to_edit_translate(xform_api, Gf.Vec3d(2.0), Gf.Vec3d(1.0))
self.assertFalse(session_layer.GetPrimAtPath(locked_attribute))
self.assertFalse(session_layer.GetPrimAtPath(asset_name + ".xformOpOrder"))
async def add_reference_and_check(prim, identifier, expected):
prim.GetReferences().AddReference(identifier)
await omni.kit.app.get_app().next_update_async()
await omni.kit.app.get_app().next_update_async()
ref_and_layers = omni.usd.get_composed_references_from_prim(prim)
self.assertEqual(len(ref_and_layers), len(expected))
identifiers = [item[0].assetPath for item in ref_and_layers]
self.assertEqual(set(identifiers), set(expected))
# Locks whole prim and try to add reference
specs_locking.lock_spec(asset_name, True)
layer1 = Sdf.Layer.CreateAnonymous()
await add_reference_and_check(asset_prim, layer1.identifier, [])
# Unlock and see
attributes = specs_locking.unlock_spec(asset_name, False)
await add_reference_and_check(asset_prim, layer1.identifier, [layer1.identifier])
# Lock add and add another
layer2 = Sdf.Layer.CreateAnonymous()
attributes = specs_locking.lock_spec(asset_name, False)
await add_reference_and_check(asset_prim, layer2.identifier, [layer1.identifier])
| 7,976 | Python | 41.887097 | 100 | 0.659353 |
omniverse-code/kit/exts/omni.kit.usd.layers/omni/kit/usd/layers/tests/test_workflow_auto_authoring.py | import asyncio
from enum import auto
import carb
import os
import tempfile
import omni.kit.test
import omni.usd
import omni.client
from pxr import Sdf, Usd, UsdGeom, Gf
from omni.kit.usd.layers import get_layers, LayerUtils, get_layer_event_payload, LayerEventType, LayerEditMode
class TestAutoAuthoring(omni.kit.test.AsyncTestCase):
# Before running each test
async def setUp(self):
self.usd_context = omni.usd.get_context()
await omni.usd.get_context().new_stage_async()
async def tearDown(self):
if omni.usd.get_context().get_stage():
await omni.usd.get_context().close_stage_async()
async def test_edit_mode_switch(self):
layers = get_layers()
auto_authoring = layers.get_auto_authoring()
event_stream = layers.get_event_stream()
payload = None
def _on_layer_event(event: carb.events.IEvent):
nonlocal payload
temp = get_layer_event_payload(event)
if temp.event_type == LayerEventType.DEFAULT_LAYER_CHANGED:
payload = temp
subscription = event_stream.create_subscription_to_pop(_on_layer_event, name="layer events")
stage = self.usd_context.get_stage()
root_layer = stage.GetRootLayer()
layers.set_edit_mode(LayerEditMode.NORMAL)
self.assertEqual(layers.get_edit_mode(), LayerEditMode.NORMAL)
layers.set_edit_mode(LayerEditMode.AUTO_AUTHORING)
self.assertTrue(auto_authoring.is_enabled())
self.assertEqual(layers.get_edit_mode(), LayerEditMode.AUTO_AUTHORING)
self.assertEqual(auto_authoring.get_default_layer(), root_layer.identifier)
auto_authoring.set_default_layer(stage.GetSessionLayer().identifier)
# It cannot set session layer as edit layer.
self.assertEqual(auto_authoring.get_default_layer(), root_layer.identifier)
layer0 = Sdf.Layer.CreateAnonymous()
root_layer.subLayerPaths.append(layer0.identifier)
auto_authoring.set_default_layer(layer0.identifier)
self.assertEqual(auto_authoring.get_default_layer(), layer0.identifier)
# Set invalid edit layer will switch it to root layer
auto_authoring.set_default_layer("invalid_identifier.usd")
self.assertEqual(auto_authoring.get_default_layer(), layer0.identifier)
# Try to change edit target will fail
LayerUtils.set_edit_target(stage, root_layer.identifier)
await omni.kit.app.get_app().next_update_async()
await omni.kit.app.get_app().next_update_async()
edit_target_identifier = LayerUtils.get_edit_target(stage)
self.assertNotEqual(LayerUtils.get_edit_target(stage), root_layer.identifier)
self.assertIn("__DELTA_LAYER__", edit_target_identifier)
# Switch from no deltas mode to authoring mode will keep the current edit layer as edit target.
auto_authoring.set_default_layer(root_layer.identifier)
payload = None
auto_authoring.set_default_layer(layer0.identifier)
self.assertIsNotNone(payload)
self.assertEqual(payload.event_type, LayerEventType.DEFAULT_LAYER_CHANGED)
self.assertEqual(layer0.identifier, auto_authoring.get_default_layer())
layers.set_edit_mode(LayerEditMode.NORMAL)
self.assertEqual(layers.get_edit_mode(), LayerEditMode.NORMAL)
self.assertEqual(LayerUtils.get_edit_target(stage), layer0.identifier)
async def _wait(self):
await omni.kit.app.get_app().next_update_async()
await omni.kit.app.get_app().next_update_async()
async def test_deltas_merge_under_auto_authoring_mode(self):
layers = get_layers()
auto_authoring = layers.get_auto_authoring()
stage = self.usd_context.get_stage()
root = stage.GetRootLayer()
layer0 = Sdf.Layer.CreateAnonymous()
layer1 = Sdf.Layer.CreateAnonymous()
layer2 = Sdf.Layer.CreateAnonymous()
root.subLayerPaths.append(layer0.identifier)
root.subLayerPaths.append(layer1.identifier)
root.subLayerPaths.append(layer2.identifier)
translation = Gf.Vec3d(0.0, 0.0, 0.0)
rotation = Gf.Vec3f(0.0, 0.0, 0.0)
scale = Gf.Vec3f(1.0, 1.0, 1.0)
layers.set_edit_mode(LayerEditMode.NORMAL)
LayerUtils.set_edit_target(stage, layer1.identifier)
cube_prim = UsdGeom.Cube.Define(stage, "/cube")
UsdGeom.XformCommonAPI(cube_prim).SetTranslate(translation)
UsdGeom.XformCommonAPI(cube_prim).SetRotate(rotation)
UsdGeom.XformCommonAPI(cube_prim).SetScale(scale)
LayerUtils.set_edit_target(stage, layer2.identifier)
sphere_prim = UsdGeom.Sphere.Define(stage, "/sphere")
UsdGeom.XformCommonAPI(sphere_prim).SetTranslate(translation)
UsdGeom.XformCommonAPI(sphere_prim).SetRotate(rotation)
UsdGeom.XformCommonAPI(sphere_prim).SetScale(scale)
layers.set_edit_mode(LayerEditMode.AUTO_AUTHORING)
LayerUtils.set_edit_target(stage, layer0.identifier)
# It needs to wait for at least one frame so that it will not allow to change edit target.
await self._wait()
auto_authoring.set_default_layer(layer0.identifier)
translate = Gf.Vec3d(100.0, 100.0, 100.0)
UsdGeom.XformCommonAPI(cube_prim).SetTranslate(translate)
UsdGeom.XformCommonAPI(sphere_prim).SetTranslate(translate * 2)
await self._wait()
xform_vectors = UsdGeom.XformCommonAPI(cube_prim).GetXformVectors(Usd.TimeCode.Default())
self.assertFalse(layer0.GetPrimAtPath(cube_prim.GetPath()))
self.assertEqual(xform_vectors[0], translate)
# Make sure the authoring is merged
translate_property_path = cube_prim.GetPath().AppendProperty("xformOp:translate")
translate_property = layer1.GetPropertyAtPath(translate_property_path)
self.assertTrue(translate_property)
self.assertEqual(translate_property.default, translate)
xform_vectors = UsdGeom.XformCommonAPI(sphere_prim).GetXformVectors(Usd.TimeCode.Default())
self.assertFalse(layer0.GetPrimAtPath(sphere_prim.GetPath()))
self.assertEqual(xform_vectors[0], translate * 2)
# Make sure the authoring is merged
translate_property_path = sphere_prim.GetPath().AppendProperty("xformOp:translate")
translate_property = layer2.GetPropertyAtPath(translate_property_path)
self.assertTrue(translate_property)
self.assertEqual(translate_property.default, translate * 2)
# Switches to normal authoring mode and creates deltas there for cube
layers.set_edit_mode(LayerEditMode.NORMAL)
LayerUtils.set_edit_target(stage, layer0.identifier)
translate = Gf.Vec3d(1000.0, 1000.0, 1000.0)
UsdGeom.XformCommonAPI(cube_prim).SetTranslate(translate)
xform_vectors = UsdGeom.XformCommonAPI(cube_prim).GetXformVectors(Usd.TimeCode.Default())
self.assertTrue(layer0.GetPrimAtPath(cube_prim.GetPath()))
self.assertEqual(xform_vectors[0], translate)
# Then modify cube and sphere again, this time cube movement will go into layer0 instead
# of where its defined, which sphere will still be in its define layer.
layers.set_edit_mode(LayerEditMode.AUTO_AUTHORING)
auto_authoring.set_default_layer(layer0.identifier)
translate = Gf.Vec3d(200.0, 200.0, 200.0)
UsdGeom.XformCommonAPI(cube_prim).SetTranslate(translate)
UsdGeom.XformCommonAPI(sphere_prim).SetTranslate(translate * 2)
await self._wait()
# Check layer 0
xform_vectors = UsdGeom.XformCommonAPI(cube_prim).GetXformVectors(Usd.TimeCode.Default())
self.assertTrue(layer0.GetPrimAtPath(cube_prim.GetPath()))
self.assertEqual(xform_vectors[0], translate)
# Make sure the authoring is merged
translate_property_path = cube_prim.GetPath().AppendProperty("xformOp:translate")
translate_property = layer0.GetPropertyAtPath(translate_property_path)
self.assertTrue(translate_property)
self.assertEqual(translate_property.default, translate)
xform_vectors = UsdGeom.XformCommonAPI(sphere_prim).GetXformVectors(Usd.TimeCode.Default())
self.assertFalse(layer0.GetPrimAtPath(sphere_prim.GetPath()))
self.assertEqual(xform_vectors[0], translate * 2)
# Make sure the authoring is merged
translate_property_path = sphere_prim.GetPath().AppendProperty("xformOp:translate")
translate_property = layer2.GetPropertyAtPath(translate_property_path)
self.assertTrue(translate_property)
self.assertEqual(translate_property.default, translate * 2)
async def test_new_prim_create_under_auto_authoring_mode(self):
layers = get_layers()
auto_authoring = layers.get_auto_authoring()
stage = self.usd_context.get_stage()
root = stage.GetRootLayer()
layer0 = Sdf.Layer.CreateAnonymous()
layer1 = Sdf.Layer.CreateAnonymous()
layer2 = Sdf.Layer.CreateAnonymous()
root.subLayerPaths.append(layer0.identifier)
root.subLayerPaths.append(layer1.identifier)
root.subLayerPaths.append(layer2.identifier)
layers.set_edit_mode(LayerEditMode.AUTO_AUTHORING)
auto_authoring.set_default_layer(layer1.identifier)
# Making sure that layer1 is not edit target at this moment.
self.assertNotEqual(LayerUtils.get_edit_target(stage), layer1.identifier)
all_cube_prims = []
for i in range(1000):
cube_path = f"/cube{i}"
self.assertFalse(layer1.GetPrimAtPath(cube_path))
cube_prim = UsdGeom.Cube.Define(stage, cube_path)
# It's not in layer1 even after creation until it's moved in next frame.
self.assertFalse(layer1.GetPrimAtPath(cube_path))
self.assertTrue(cube_prim)
all_cube_prims.append(cube_prim)
# It needs to wait for prims move.
await self._wait()
for i in range(len(all_cube_prims)):
cube_path = f"/cube{i}"
cube_prim = all_cube_prims[i]
prim_stack = cube_prim.GetPrim().GetPrimStack()
# The first one is the auto authoring layer
cube_prim_spec = layer1.GetPrimAtPath(cube_prim.GetPath())
self.assertTrue(cube_prim_spec)
self.assertTrue(cube_prim_spec.path, cube_path)
self.assertTrue(cube_prim_spec)
self.assertEqual(cube_prim_spec.specifier, Sdf.SpecifierDef)
self.assertEqual(cube_prim_spec.typeName, "Cube")
async def test_correct_merge_layer_of_spec(self):
layers = get_layers()
auto_authoring = layers.get_auto_authoring()
stage = self.usd_context.get_stage()
root = stage.GetRootLayer()
session = stage.GetSessionLayer()
layer0 = Sdf.Layer.CreateAnonymous()
layer1 = Sdf.Layer.CreateAnonymous()
root.subLayerPaths.append(layer0.identifier)
root.subLayerPaths.append(layer1.identifier)
layers.set_edit_mode(LayerEditMode.AUTO_AUTHORING)
auto_authoring.set_default_layer(layer1.identifier)
# Making sure that layer1 is not edit target at this moment.
self.assertNotEqual(LayerUtils.get_edit_target(stage), layer1.identifier)
cube_path = f"/cube0"
with Usd.EditContext(stage, layer1):
cube_prim = UsdGeom.Cube.Define(stage, cube_path)
self.assertFalse(layer0.GetPrimAtPath(cube_path))
self.assertTrue(cube_prim)
# Authoring to auto authoring layer.
UsdGeom.XformCommonAPI(cube_prim.GetPrim()).SetTranslate(Gf.Vec3d(200.0, 200.0, 200.0))
await self._wait()
xform_vectors = UsdGeom.XformCommonAPI(cube_prim.GetPrim()).GetXformVectors(Usd.TimeCode.Default())
self.assertEqual(xform_vectors[0], Gf.Vec3d(200.0, 200.0, 200.0))
self.assertFalse(layer0.GetPrimAtPath(cube_path))
self.assertFalse(root.GetPrimAtPath(cube_path))
self.assertFalse(session.GetPrimAtPath(cube_path))
# Switch to normal mode to make sure it's saved to layer1.
layers.set_edit_mode(LayerEditMode.NORMAL)
xform_vectors = UsdGeom.XformCommonAPI(cube_prim.GetPrim()).GetXformVectors(Usd.TimeCode.Default())
self.assertEqual(xform_vectors[0], Gf.Vec3d(200.0, 200.0, 200.0))
# Switch to auto authoring mode again and try to edit weaker layers under auto authoring layer.
layers.set_edit_mode(LayerEditMode.AUTO_AUTHORING)
# Create a delta for cube_prim in layer 0
with Usd.EditContext(stage, layer0):
cube_prim.GetPrim().CreateAttribute("test_property", Sdf.ValueTypeNames.Bool, False).Set(False)
# Edit the translate again and check if the translate will be merged to layer1 instead of layer0
UsdGeom.XformCommonAPI(cube_prim.GetPrim()).SetTranslate(Gf.Vec3d(400.0, 400.0, 400.0))
await self._wait()
xform_vectors = UsdGeom.XformCommonAPI(cube_prim.GetPrim()).GetXformVectors(Usd.TimeCode.Default())
self.assertEqual(xform_vectors[0], Gf.Vec3d(400.0, 400.0, 400.0))
async def test_whole_stage_refresh(self):
stage = self.usd_context.get_stage()
layers = get_layers()
root = stage.GetRootLayer()
session = stage.GetSessionLayer()
layer0 = Sdf.Layer.CreateAnonymous()
layer1 = Sdf.Layer.CreateAnonymous()
root.subLayerPaths.append(layer0.identifier)
root.subLayerPaths.append(layer1.identifier)
layers.set_edit_mode(LayerEditMode.AUTO_AUTHORING)
cube_path = f"/cube0"
with Usd.EditContext(stage, layer1):
cube_prim = UsdGeom.Cube.Define(stage, cube_path)
self.assertFalse(layer0.GetPrimAtPath(cube_path))
self.assertTrue(cube_prim)
UsdGeom.XformCommonAPI(cube_prim.GetPrim()).SetTranslate(Gf.Vec3d(100.0, 100.0, 100.0))
identifier = session.subLayerPaths[0]
auto_authoring_layer = Sdf.Find(identifier)
self.assertTrue(auto_authoring_layer)
self.assertTrue(len(auto_authoring_layer.rootPrims) == 0)
# Creates a delta to auto authoring layer
UsdGeom.XformCommonAPI(cube_prim.GetPrim()).SetTranslate(Gf.Vec3d(200.0, 200.0, 200.0))
await self._wait()
self.assertTrue(len(auto_authoring_layer.rootPrims) > 0)
# Remove layer to trigger whole stage refresh
del root.subLayerPaths[1]
await self._wait()
# After that, the auto authoring layer will be cleared.
self.assertTrue(len(auto_authoring_layer.rootPrims) == 0)
async def test_weaker_layers_authoring(self):
stage = self.usd_context.get_stage()
layers = get_layers()
auto_authoring = layers.get_auto_authoring()
root = stage.GetRootLayer()
layer0 = Sdf.Layer.CreateAnonymous()
layer1 = Sdf.Layer.CreateAnonymous()
root.subLayerPaths.append(layer0.identifier)
root.subLayerPaths.append(layer1.identifier)
layers.set_edit_mode(LayerEditMode.AUTO_AUTHORING)
auto_authoring.set_default_layer(layer1.identifier)
# Making sure that layer1 is not edit target at this moment.
self.assertNotEqual(LayerUtils.get_edit_target(stage), layer1.identifier)
cube_path = f"/cube0"
with Usd.EditContext(stage, layer1):
cube_prim = UsdGeom.Cube.Define(stage, cube_path)
self.assertFalse(layer0.GetPrimAtPath(cube_path))
self.assertTrue(cube_prim)
UsdGeom.XformCommonAPI(cube_prim.GetPrim()).SetTranslate(Gf.Vec3d(100.0, 100.0, 100.0))
self.assertEqual(self._get_xform_translate(cube_prim.GetPrim()), Gf.Vec3d(100.0, 100.0, 100.0))
# Authoring to auto authoring layer.
UsdGeom.XformCommonAPI(cube_prim.GetPrim()).SetTranslate(Gf.Vec3d(200.0, 200.0, 200.0))
await self._wait()
self.assertEqual(self._get_xform_translate(cube_prim.GetPrim()), Gf.Vec3d(200.0, 200.0, 200.0))
self.assertFalse(layer0.GetPrimAtPath(cube_path))
# Switch to normal mode to make sure it's saved back.
layers.set_edit_mode(LayerEditMode.NORMAL)
self.assertEqual(self._get_xform_translate(cube_prim.GetPrim()), Gf.Vec3d(200.0, 200.0, 200.0))
# Switch to auto authoring mode again and try to edit weaker layers under auto authoring layer.
layers.set_edit_mode(LayerEditMode.AUTO_AUTHORING)
UsdGeom.XformCommonAPI(cube_prim.GetPrim()).SetTranslate(Gf.Vec3d(400.0, 400.0, 400.0))
await self._wait()
# Edit weaker layers
with Usd.EditContext(stage, layer0):
UsdGeom.XformCommonAPI(cube_prim.GetPrim()).SetTranslate(Gf.Vec3d(300.0, 300.0, 300.0))
# Wait until it's merge back to auto authoring layer
await self._wait()
self.assertEqual(self._get_xform_translate(cube_prim.GetPrim()), Gf.Vec3d(300.0, 300.0, 300.0))
# Edit weakest layer to make sure it will not be merged back to auto authoring layer
# since layer0 is stronger.
with Usd.EditContext(stage, layer1):
UsdGeom.XformCommonAPI(cube_prim.GetPrim()).SetTranslate(Gf.Vec3d(1000.0, 1000.0, 1000.0))
await self._wait()
self.assertEqual(self._get_xform_translate(cube_prim.GetPrim()), Gf.Vec3d(300.0, 300.0, 300.0))
def _get_xform_translate(self, prim):
xform_vectors = UsdGeom.XformCommonAPI(prim).GetXformVectors(Usd.TimeCode.Default())
return xform_vectors[0]
async def test_read_only_layer_edit(self):
# Test for OM-35472
stage = self.usd_context.get_stage()
root = stage.GetRootLayer()
layers = get_layers()
layer0 = Sdf.Layer.CreateAnonymous()
root.subLayerPaths.append(layer0.identifier)
layers.set_edit_mode(LayerEditMode.AUTO_AUTHORING)
with Usd.EditContext(stage, layer0):
cube_prim = UsdGeom.Cube.Define(stage, "/world/cube")
UsdGeom.XformCommonAPI(cube_prim.GetPrim()).SetTranslate(Gf.Vec3d(1000.0, 1000.0, 1000.0))
self.assertEqual(self._get_xform_translate(cube_prim.GetPrim()), Gf.Vec3d(1000, 1000, 1000))
LayerUtils.set_layer_lock_status(root, layer0.identifier, True)
UsdGeom.XformCommonAPI(cube_prim.GetPrim()).SetTranslate(Gf.Vec3d(100.0, 100.0, 100.0))
self.assertEqual(self._get_xform_translate(cube_prim.GetPrim()), Gf.Vec3d(100, 100, 100))
# It will return back to old value since it's read-only layer
await self._wait()
self.assertEqual(self._get_xform_translate(cube_prim.GetPrim()), Gf.Vec3d(1000, 1000, 1000))
# Make sure it can be edited again
LayerUtils.set_layer_lock_status(root, layer0.identifier, False)
UsdGeom.XformCommonAPI(cube_prim.GetPrim()).SetTranslate(Gf.Vec3d(100.0, 100.0, 100.0))
self.assertEqual(self._get_xform_translate(cube_prim.GetPrim()), Gf.Vec3d(100, 100, 100))
await self._wait()
self.assertEqual(self._get_xform_translate(cube_prim.GetPrim()), Gf.Vec3d(100, 100, 100))
| 19,148 | Python | 45.933823 | 110 | 0.678086 |
omniverse-code/kit/exts/omni.kit.usd.layers/omni/kit/usd/layers/tests/test_path_utils.py | import omni.kit.test
import omni.usd
from omni.kit.usd.layers.impl.path_utils import PathUtils
class TestPathUtils(omni.kit.test.AsyncTestCase):
def test_is_omni_path(self):
path = "omniverse://test-server/invalid_path"
self.assertTrue(PathUtils.is_omni_path(path))
path = "c:/file.usd"
self.assertFalse(PathUtils.is_omni_path(path))
| 373 | Python | 27.769229 | 57 | 0.702413 |
omniverse-code/kit/exts/omni.kit.usd.layers/omni/kit/usd/layers/tests/__init__.py | from .test_layers_interface import TestLayersInterface
from .test_layers_state import TestLayersState
from .test_layer_utils import TestLayerUtils
from .test_path_utils import TestPathUtils
from .test_commands import TestUsdCommands
from .test_workflow_specs_locking import TestSpecsLocking
from .test_workflow_auto_authoring import TestAutoAuthoring
from .test_workflow_specs_linking import TestSpecsLinking
from .test_workflow_live_syncing import TestLiveSyncing
| 465 | Python | 45.599995 | 59 | 0.858065 |
omniverse-code/kit/exts/omni.kit.usd.layers/omni/kit/usd/layers/tests/test_layers_interface.py | import asyncio
import carb
import os
import tempfile
import omni.kit.test
import omni.usd
import omni.client
from omni.kit.usd.layers import get_layers, LayerEditMode, get_layer_event_payload, LayerEventType
class TestLayersInterface(omni.kit.test.AsyncTestCase):
async def setUp(self):
self.usd_context = omni.usd.get_context()
await omni.usd.get_context().new_stage_async()
async def tearDown(self):
if omni.usd.get_context().get_stage():
await omni.usd.get_context().close_stage_async()
async def test_edit_mode_switch(self):
layers = get_layers()
event_stream = layers.get_event_stream()
payload = None
def _on_layer_event(event: carb.events.IEvent):
nonlocal payload
temp = get_layer_event_payload(event)
if temp.event_type == LayerEventType.EDIT_MODE_CHANGED:
payload = temp
subscription = event_stream.create_subscription_to_pop(_on_layer_event, name="Layers Interface Tests")
self.assertEqual(layers.get_edit_mode(), LayerEditMode.NORMAL)
def change_edit_mode_and_verify(edit_mode):
nonlocal payload
payload = None
layers.set_edit_mode(edit_mode)
self.assertIsNotNone(payload)
self.assertEqual(payload.event_type, LayerEventType.EDIT_MODE_CHANGED)
self.assertEqual(layers.get_edit_mode(), edit_mode)
change_edit_mode_and_verify(LayerEditMode.AUTO_AUTHORING)
change_edit_mode_and_verify(LayerEditMode.SPECS_LINKING)
change_edit_mode_and_verify(LayerEditMode.NORMAL)
| 1,636 | Python | 33.104166 | 110 | 0.668093 |
omniverse-code/kit/exts/omni.kit.usd.layers/omni/kit/usd/layers/tests/test_workflow_live_syncing.py | import carb
import omni.kit.test
import omni.usd
import omni.client
import unittest
import omni.kit.app
from omni.kit.usd.layers import get_layers, get_layer_event_payload, LayerEventType, LayerUtils
from .test_base import enable_server_tests
from pxr import Usd, Sdf
class TestLiveSyncing(omni.kit.test.AsyncTestCase):
# Before running each test
async def setUp(self):
self.app = omni.kit.app.get_app()
self.usd_context = omni.usd.get_context()
self.layers = get_layers(self.usd_context)
await omni.usd.get_context().new_stage_async()
if enable_server_tests():
self.test_folder = "omniverse://localhost/Projects/omni.kit.usd.layers/test_live_syncing/"
await omni.client.delete_async(self.test_folder)
self.stage_url = self.test_folder + "test.usd"
self.sublayer = self.test_folder + "test2.usd"
self.sublayer2 = self.test_folder + "test3.usd"
stage = Usd.Stage.CreateNew(self.stage_url)
sublayer = Sdf.Layer.CreateNew(self.sublayer)
stage.GetRootLayer().subLayerPaths.append(self.sublayer)
await self.usd_context.attach_stage_async(stage)
self.stage = self.usd_context.get_stage()
else:
self.test_folder = ""
self.stage_url = ""
self.stage = None
async def tearDown(self):
if omni.usd.get_context().get_stage():
await omni.usd.get_context().close_stage_async()
self.stage = None
if enable_server_tests():
await omni.client.delete_async(self.test_folder)
async def wait(self, frames=10):
for i in range(frames):
await self.app.next_update_async()
async def test_other_interfaces(self):
layers = get_layers()
live_syncing = layers.get_live_syncing()
live_syncing.mute_live_session_merge_notice("omniverse://fake-test-server/a.usd")
live_syncing.mute_live_session_merge_notice("omniverse://fake-test-server/b.usd")
self.assertTrue(live_syncing.is_live_session_merge_notice_muted("omniverse://fake-test-server/a.usd"))
self.assertTrue(live_syncing.is_live_session_merge_notice_muted("omniverse://fake-test-server/b.usd"))
live_syncing.unmute_live_session_merge_notice("omniverse://fake-test-server/a.usd")
self.assertFalse(live_syncing.is_live_session_merge_notice_muted("omniverse://fake-test-server/a.usd"))
self.assertTrue(live_syncing.is_live_session_merge_notice_muted("omniverse://fake-test-server/b.usd"))
@unittest.skipIf(not enable_server_tests(), "")
async def test_join_session_with_url(self):
layers = get_layers()
live_syncing = layers.get_live_syncing()
session_url = omni.client.combine_urls(self.stage_url, ".live/test.live/customized_session.live")
self.assertFalse(live_syncing.join_live_session_by_url(self.stage_url, session_url, False))
self.assertTrue(live_syncing.join_live_session_by_url(self.stage_url, session_url, True))
current_live_session = live_syncing.get_current_live_session()
self.assertTrue(current_live_session)
self.assertTrue(live_syncing.is_stage_in_live_session())
self.assertTrue(live_syncing.is_in_live_session())
self.assertTrue(live_syncing.is_layer_in_live_session(self.stage_url))
self.assertEqual(current_live_session.name, "customized_session")
self.assertEqual(current_live_session.url, session_url)
self.assertTrue(live_syncing.get_live_session_by_url(session_url))
live_syncing.stop_all_live_sessions()
@unittest.skipIf(not enable_server_tests(), "")
async def test_session_management(self):
for layer_identifier in [self.sublayer, self.stage_url]:
await self.__test_session_management_internal(layer_identifier, False)
@unittest.skipIf(not enable_server_tests(), "")
async def test_session_management_merge_to_new_layer(self):
await self.__test_session_management_internal(self.sublayer, True)
async def __test_session_management_internal(self, sublayer_identifier, merge_to_new_layer=False):
layers = get_layers()
live_syncing = layers.get_live_syncing()
is_root_layer = sublayer_identifier == self.usd_context.get_stage_url()
event_stream = layers.get_event_stream()
payload = None
merge_started = None
merge_ended = None
def _on_layer_event(event: carb.events.IEvent):
nonlocal payload
nonlocal merge_started
nonlocal merge_ended
temp = get_layer_event_payload(event)
if temp.event_type == LayerEventType.LIVE_SESSION_LIST_CHANGED or temp.event_type == LayerEventType.LIVE_SESSION_STATE_CHANGED:
payload = temp
elif temp.event_type == LayerEventType.LIVE_SESSION_MERGE_STARTED:
merge_started = temp
elif temp.event_type == LayerEventType.LIVE_SESSION_MERGE_ENDED:
merge_ended = temp
subscription = event_stream.create_subscription_to_pop(_on_layer_event, name="layer events")
self.assertEqual(len(live_syncing.get_all_live_sessions(sublayer_identifier)), 0)
live_session = live_syncing.create_live_session("test", layer_identifier=sublayer_identifier)
self.assertTrue(live_session)
self.assertEqual(live_session.name, "test")
self.assertTrue(live_session.merge_permission)
self.assertTrue(live_session.channel_url)
self.assertTrue(live_session.url)
self.assertTrue(live_session.root)
self.assertTrue(live_session.owner)
sessions = live_syncing.get_all_live_sessions(sublayer_identifier)
self.assertEqual(len(sessions), 1)
session = sessions[0]
self.assertEqual(live_session.name, session.name)
self.assertEqual(live_session.owner, session.owner)
self.assertEqual(live_session.url, session.url)
self.assertEqual(live_session.root, session.root)
self.assertEqual(live_session.channel_url, session.channel_url)
self.assertEqual(live_session.merge_permission, session.merge_permission)
await self.wait()
self.assertTrue(payload)
self.assertEqual(payload.event_type, LayerEventType.LIVE_SESSION_LIST_CHANGED)
live_session = live_syncing.create_live_session("test", layer_identifier=sublayer_identifier)
# Create session with the same name will fail.
self.assertFalse(live_session)
# Create session with empty name will fail.
live_session = live_syncing.create_live_session("", layer_identifier=sublayer_identifier)
self.assertFalse(live_session)
live_session = live_syncing.create_live_session("test2", layer_identifier=sublayer_identifier)
sessions = live_syncing.get_all_live_sessions(sublayer_identifier)
self.assertEqual(len(sessions), 2)
live_syncing.stop_live_session(sublayer_identifier)
await self.wait()
payload = None
self.assertTrue(live_syncing.join_live_session(live_session))
current_session = live_syncing.get_current_live_session(sublayer_identifier)
self.assertTrue(current_session)
self.assertTrue(current_session.name, live_session.name)
result, server_info = await omni.client.get_server_info_async(sublayer_identifier)
self.assertTrue(result == omni.client.Result.OK)
self.assertEqual(server_info.username, current_session.logged_user_name)
self.assertEqual(server_info.connection_id, current_session.logged_user_id)
self.assertTrue(live_syncing.is_layer_in_live_session(sublayer_identifier))
if is_root_layer:
self.assertTrue(self.usd_context.is_stage_live())
self.assertEqual(self.usd_context.get_stage_live_mode(), omni.usd.StageLiveModeType.ALWAYS_ON)
await self.wait()
self.assertTrue(payload)
self.assertEqual(payload.event_type, LayerEventType.LIVE_SESSION_STATE_CHANGED)
all_sublayers = set(LayerUtils.get_all_sublayers(self.stage, is_root_layer, True, False))
all_sublayers.discard(self.stage_url)
all_sublayers.discard(self.sublayer)
all_sublayers.discard(self.sublayer2)
for sublayer in all_sublayers:
self.assertTrue(live_syncing.is_live_session_layer(sublayer))
all_sublayers = set(live_syncing.get_current_live_session_layers(sublayer_identifier))
all_sublayers.discard(self.sublayer2)
self.assertEqual(len(all_sublayers), 1)
self.assertTrue(live_syncing.is_live_session_layer(all_sublayers.pop()))
# Makes some edits
root_live_layer = Sdf.Find(current_session.root)
self.assertTrue(root_live_layer)
layer_content = """\
#usda 1.0
(
subLayers = [
@omniverse://test-ov-fake-server/fake/path/sublayers/level2/sublayer2.usd@
]
)
over "root"
{
over "test_prim" (
prepend payload = @../invalid/payload2.usd@
prepend references = @../invalid/reference2.usd@
)
{
asset[] AssetArray = [@1.usd@, @2.usd@, @OmniPBR.mdl@]
bool[] BoolArray = [0, 1]
float[] FloatArray = [1, 2, 3]
int[] IntArray = [1, 2, 3]
string[] StringArray = ["string1", "string2", "string3"]
int test = 3
asset test2 = @../../invalid/path.usd@
asset test3 = @OmniPBR.mdl@
token[] TokenArray = ["token1", "token2", "token3"]
}
}
"""
if is_root_layer:
expected_string = """
#usda 1.0
(
customLayerData = {
dictionary omni_layer = {
dictionary locked = {
bool "./test2.usd" = 0
}
}
}
metersPerUnit = 0.01
subLayers = [
@omniverse://localhost/Projects/omni.kit.usd.layers/test_live_syncing/test2.usd@
]
)
over "root"
{
over "test_prim" (
prepend payload = @./.live/test.live/invalid/payload2.usd@
prepend references = @./.live/test.live/invalid/reference2.usd@
)
{
asset[] AssetArray = [@1.usd@, @2.usd@, @OmniPBR.mdl@]
bool[] BoolArray = [0, 1]
float[] FloatArray = [1, 2, 3]
int[] IntArray = [1, 2, 3]
string[] StringArray = ["string1", "string2", "string3"]
int test = 3
asset test2 = @./.live/invalid/path.usd@
asset test3 = @OmniPBR.mdl@
token[] TokenArray = ["token1", "token2", "token3"]
}
}
"""
else:
expected_string = """
#usda 1.0
over "root"
{
over "test_prim" (
prepend payload = @./.live/test2.live/invalid/payload2.usd@
prepend references = @./.live/test2.live/invalid/reference2.usd@
)
{
asset[] AssetArray = [@1.usd@, @2.usd@, @OmniPBR.mdl@]
bool[] BoolArray = [0, 1]
float[] FloatArray = [1, 2, 3]
int[] IntArray = [1, 2, 3]
string[] StringArray = ["string1", "string2", "string3"]
int test = 3
asset test2 = @./.live/invalid/path.usd@
asset test3 = @OmniPBR.mdl@
token[] TokenArray = ["token1", "token2", "token3"]
}
}
"""
root_live_layer.ImportFromString(layer_content)
payload = None
merge_started = None
merge_ended = None
if merge_to_new_layer:
new_sublayer = Sdf.Layer.CreateNew(self.sublayer2)
live_syncing.merge_live_session_changes_to_specific_layer(sublayer_identifier, self.sublayer2, True, True)
all_sublayers = set(LayerUtils.get_all_sublayers(self.stage, False, True, False))
self.assertIn(self.sublayer2, all_sublayers)
layer_identifier = sublayer_identifier
elif is_root_layer:
live_syncing.merge_changes_to_base_layers(True)
layer_identifier = self.stage.GetRootLayer().identifier
else:
live_syncing.merge_live_session_changes(sublayer_identifier, True)
layer_identifier = sublayer_identifier
self.assertTrue(merge_started)
self.assertTrue(merge_ended)
self.assertTrue(merge_started.layer_identifier == layer_identifier)
self.assertTrue(merge_ended.layer_identifier == layer_identifier)
self.assertTrue(merge_ended.success)
current_session = live_syncing.get_current_live_session(sublayer_identifier)
self.assertFalse(current_session)
if is_root_layer:
self.assertFalse(live_syncing.is_in_live_session())
else:
self.assertFalse(live_syncing.is_layer_in_live_session(sublayer_identifier))
await self.wait()
self.assertTrue(payload)
self.assertEqual(payload.event_type, LayerEventType.LIVE_SESSION_STATE_CHANGED)
if merge_to_new_layer:
layer = Sdf.Find(self.sublayer2)
elif is_root_layer:
layer = self.stage.GetRootLayer()
else:
layer = Sdf.Find(self.sublayer)
string = layer.ExportToString()
self.assertEqual(string.strip(), expected_string.strip())
if merge_to_new_layer:
LayerUtils.remove_sublayer(self.stage.GetRootLayer(), 0)
| 13,600 | Python | 41.636364 | 139 | 0.628382 |
omniverse-code/kit/exts/omni.kit.usd.layers/omni/kit/usd/layers/tests/test_workflow_specs_linking.py | import asyncio
import carb
import os
import tempfile
import omni.kit.test
import omni.usd
import omni.client
from pxr import Sdf, Usd, UsdGeom, Gf
from omni.kit.usd.layers import get_layers, LayerUtils, get_layer_event_payload, LayerEventType, LayerEditMode
class TestSpecsLinking(omni.kit.test.AsyncTestCase):
# Before running each test
async def setUp(self):
self.usd_context = omni.usd.get_context()
await omni.usd.get_context().new_stage_async()
async def tearDown(self):
if omni.usd.get_context().get_stage():
await omni.usd.get_context().close_stage_async()
def __get_all_property_paths(self, prim):
paths = []
for p in prim.GetProperties():
paths.append(str(p.GetPath()))
return paths
def __get_all_prim_childrens(self, prim, hierarchy=False):
paths = [str(prim.GetPath())]
paths.extend(self.__get_all_property_paths(prim))
if hierarchy:
for child in prim.GetAllPrimChildren():
paths.append(str(child.GetPath()))
paths.extend(self.__get_all_property_paths(child))
return paths
def __get_all_stage_paths(self, stage):
paths = []
for prim in stage.TraverseAll():
paths.extend(self.__get_all_prim_childrens(prim))
return paths
async def test_link_specs(self):
layers = get_layers()
specs_linking = layers.get_specs_linking()
event_stream = layers.get_event_stream()
payload = None
def _on_layer_event(event: carb.events.IEvent):
nonlocal payload
temp = get_layer_event_payload(event)
if temp.event_type == LayerEventType.SPECS_LINKING_CHANGED:
payload = temp
subscription = event_stream.create_subscription_to_pop(_on_layer_event, name="layer events")
layers.set_edit_mode(LayerEditMode.SPECS_LINKING)
context = omni.usd.get_context()
stage = context.get_stage()
root_layer = stage.GetRootLayer()
layer0 = Sdf.Layer.CreateAnonymous()
layer1 = Sdf.Layer.CreateAnonymous()
layer2 = Sdf.Layer.CreateAnonymous()
root_layer.subLayerPaths.append(layer0.identifier)
root_layer.subLayerPaths.append(layer1.identifier)
root_layer.subLayerPaths.append(layer2.identifier)
asset_name = f"/root/test0/l1/l2/l3"
asset_prim = stage.DefinePrim(asset_name, "Xform")
all_spec_paths = set(self.__get_all_stage_paths(stage))
# Invalid identifier or spec path will return empty result.
paths = specs_linking.link_spec("/", "")
self.assertEqual(len(paths), 0)
self.assertIsNone(payload)
paths = specs_linking.link_spec("", layer0.identifier)
self.assertEqual(len(paths), 0)
self.assertIsNone(payload)
# Links root prim to layer0 without hierarchy, root prim cannot be linked.
paths = specs_linking.link_spec("/", layer0.identifier, hierarchy=False)
self.assertEqual(len(paths), 0)
self.assertIsNone(payload)
# Links all prims in the prim tree.
paths = specs_linking.link_spec("/", layer0.identifier, hierarchy=True)
self.assertEqual(set(paths), all_spec_paths)
self.assertIsNotNone(payload)
self.assertEqual(payload.event_type, LayerEventType.SPECS_LINKING_CHANGED)
self.assertEqual(set([layer0.identifier]), set(payload.layer_spec_paths.keys()))
self.assertEqual(set(payload.layer_spec_paths[layer0.identifier]), set(all_spec_paths))
paths = specs_linking.get_spec_layer_links("/", hierarchy=False)
self.assertEqual(len(paths), 0)
paths = specs_linking.get_spec_layer_links("/", hierarchy=True)
for path, value in paths.items():
self.assertIn(path, all_spec_paths)
self.assertEqual(len(value), 1)
self.assertEqual(value[0], layer0.identifier)
self.assertTrue(specs_linking.is_spec_linked(path, layer0.identifier))
self.assertTrue(specs_linking.is_spec_linked(path))
self.assertFalse(specs_linking.is_spec_linked(path, layer1.identifier))
# Since it's prim is already linked, add properties will not change anything.
root_translate_path = "/root.xformOp:translate"
specs_linking.link_spec(root_translate_path, layer0.identifier)
paths = specs_linking.get_spec_layer_links("/", hierarchy=True)
for path, value in paths.items():
self.assertIn(path, all_spec_paths)
self.assertEqual(len(value), 1)
self.assertEqual(value[0], layer0.identifier)
self.assertTrue(specs_linking.is_spec_linked(root_translate_path, layer0.identifier))
self.assertTrue(specs_linking.is_spec_linked(root_translate_path))
self.assertFalse(specs_linking.is_spec_linked(root_translate_path, layer1.identifier))
# Links translate
specs_linking.unlink_all_specs()
payload = None
specs_linking.link_spec(root_translate_path, layer0.identifier, hierarchy=True)
paths = specs_linking.get_all_spec_links()
prims = ["/root.xformOp:translate"]
for path, value in paths.items():
self.assertIn(path, prims)
self.assertEqual(len(value), 1)
self.assertEqual(value[0], layer0.identifier)
self.assertIsNotNone(payload)
self.assertEqual(payload.event_type, LayerEventType.SPECS_LINKING_CHANGED)
self.assertEqual(set([layer0.identifier]), set(payload.layer_spec_paths.keys()))
self.assertEqual(set(payload.layer_spec_paths[layer0.identifier]), set(prims))
specs_linking.link_spec(root_translate_path, layer1.identifier, hierarchy=True)
paths = specs_linking.get_spec_layer_links(root_translate_path, hierarchy=True)
self.assertIn(root_translate_path, paths)
layers = paths[root_translate_path]
self.assertEqual(set([layer0.identifier, layer1.identifier]), set(layers))
# Links root translate to layer2 only.
paths = specs_linking.get_spec_layer_links(root_translate_path, hierarchy=True)
specs_linking.unlink_spec_from_all_layers(root_translate_path)
paths = specs_linking.get_spec_layer_links(root_translate_path, hierarchy=True)
specs_linking.link_spec(root_translate_path, layer2.identifier)
paths = specs_linking.get_spec_layer_links(root_translate_path, hierarchy=True)
self.assertIn(root_translate_path, paths)
layers = paths[root_translate_path]
self.assertEqual(set([layer2.identifier]), set(layers))
specs_linking.unlink_all_specs()
# Link all prims to layer 0
paths = specs_linking.link_spec("/", layer0.identifier, hierarchy=True)
# Link /root/test0/l1 and all its descendants to both layer0 and layer1
paths = specs_linking.link_spec("/root/test0/l1", layer1.identifier, hierarchy=True)
links = specs_linking.get_all_spec_links()
for path, layers in links.items():
if path.startswith("/root/test0/l1"):
self.assertEqual(set(layers), set([layer0.identifier, layer1.identifier]))
else:
self.assertEqual(set(layers), set([layer0.identifier]))
async def test_unlink_spec(self):
layers = get_layers()
specs_linking = layers.get_specs_linking()
event_stream = layers.get_event_stream()
payload = None
def _on_layer_event(event: carb.events.IEvent):
nonlocal payload
temp = get_layer_event_payload(event)
if temp.event_type == LayerEventType.SPECS_LINKING_CHANGED:
payload = temp
subscription = event_stream.create_subscription_to_pop(_on_layer_event, name="layer events")
context = omni.usd.get_context()
layers.set_edit_mode(LayerEditMode.SPECS_LINKING)
stage = context.get_stage()
root_layer = stage.GetRootLayer()
layer0 = Sdf.Layer.CreateAnonymous()
layer1 = Sdf.Layer.CreateAnonymous()
root_layer.subLayerPaths.append(layer0.identifier)
root_layer.subLayerPaths.append(layer1.identifier)
asset_name = f"/root/test0/l1/l2/l3"
asset_prim = stage.DefinePrim(asset_name, "Xform")
all_spec_paths = set(self.__get_all_stage_paths(stage))
# Links root prim to layer0 with hierarchy.
paths = specs_linking.link_spec("/", layer0.identifier, hierarchy=True)
self.assertEqual(set(paths), all_spec_paths)
links = specs_linking.get_all_spec_links()
self.assertEqual(set(links), all_spec_paths)
# Unlink absolute root path without hierarchy will unlink nothing
specs_linking.unlink_spec("/", layer0.identifier, hierarchy=False)
links = specs_linking.get_all_spec_links()
self.assertEqual(set(paths), all_spec_paths)
# Unlink all
unlinked_paths = specs_linking.unlink_spec("/", layer0.identifier, hierarchy=True)
links = specs_linking.get_all_spec_links()
self.assertEqual(set(unlinked_paths), all_spec_paths)
self.assertEqual(len(links), 0)
self.assertIsNotNone(payload)
self.assertEqual(payload.event_type, LayerEventType.SPECS_LINKING_CHANGED)
self.assertEqual(set([layer0.identifier]), set(payload.layer_spec_paths.keys()))
self.assertEqual(set(payload.layer_spec_paths[layer0.identifier]), set(all_spec_paths))
for path in unlinked_paths:
self.assertFalse(specs_linking.is_spec_linked(path))
self.assertFalse(specs_linking.is_spec_linked(path, layer0.identifier))
# Unlinks a subset of paths
paths = specs_linking.link_spec("/", layer0.identifier, hierarchy=True)
unlinked_paths = specs_linking.unlink_spec("/root/test0", layer0.identifier, hierarchy=True)
links = specs_linking.get_all_spec_links()
expected_unlinked_paths = all_spec_paths.difference(set(links))
self.assertEqual(set(unlinked_paths), set(expected_unlinked_paths))
# Unlinks single path
unlinked_paths = specs_linking.unlink_spec("/root", layer0.identifier, hierarchy=False)
new_links = specs_linking.get_all_spec_links()
expected_unlinked_paths = set(links).difference(set(new_links))
self.assertEqual(set(unlinked_paths), set(expected_unlinked_paths))
# Unlinks specs from subset of layers.
specs_linking.unlink_all_specs()
paths = specs_linking.link_spec("/", layer0.identifier, hierarchy=True)
paths.extend(specs_linking.link_spec("/", layer1.identifier, hierarchy=True))
unlinked_paths = specs_linking.unlink_spec("/", layer0.identifier, hierarchy=True)
links = specs_linking.get_all_spec_links()
self.assertEqual(set(paths), all_spec_paths)
self.assertEqual(set(unlinked_paths), all_spec_paths)
# Checkes if only layer1's link is existed.
for _, linked_layers in links.items():
self.assertEqual(linked_layers, [layer1.identifier])
# Unlinks all specs linked to specific layers
specs_linking.unlink_all_specs()
paths = specs_linking.link_spec("/", layer0.identifier, hierarchy=True)
paths.extend(specs_linking.link_spec("/", layer1.identifier, hierarchy=True))
unlinked_paths = specs_linking.unlink_specs_to_layer(layer0.identifier)
links = specs_linking.get_all_spec_links()
self.assertEqual(set(paths), all_spec_paths)
self.assertEqual(set(unlinked_paths), all_spec_paths)
for _, linked_layers in links.items():
self.assertEqual(linked_layers, [layer1.identifier])
# Unlinks specific specs from all layers
specs_linking.unlink_all_specs()
paths = specs_linking.link_spec("/", layer0.identifier, hierarchy=True)
paths.extend(specs_linking.link_spec("/", layer1.identifier, hierarchy=True))
unlinked_paths = specs_linking.unlink_spec_from_all_layers("/root/test0", hierarchy=True)
self.assertTrue(len(unlinked_paths) != 0)
links = specs_linking.get_all_spec_links()
self.assertTrue("/root/test0" not in links)
expected_unlinked_paths = all_spec_paths.difference(set(links))
self.assertEqual(set(unlinked_paths), set(expected_unlinked_paths))
async def test_stage_edits_for_spec_links(self):
layers = get_layers()
specs_linking = layers.get_specs_linking()
context = omni.usd.get_context()
layers.set_edit_mode(LayerEditMode.SPECS_LINKING)
stage = context.get_stage()
root_layer = stage.GetRootLayer()
layer0 = Sdf.Layer.CreateAnonymous()
layer1 = Sdf.Layer.CreateAnonymous()
layer2 = Sdf.Layer.CreateAnonymous()
root_layer.subLayerPaths.append(layer0.identifier)
root_layer.subLayerPaths.append(layer1.identifier)
root_layer.subLayerPaths.append(layer2.identifier)
asset_name = f"/root/test0/l1/l2/l3"
asset_prim = stage.DefinePrim(asset_name, "Xform")
await omni.kit.app.get_app().next_update_async()
specs_linking.link_spec("/", layer0.identifier, hierarchy=True)
specs_linking.link_spec("/", layer1.identifier, hierarchy=True)
# Create an attribute and make sure its edits are distributed to both layer0 and layer1
prim = stage.GetPrimAtPath("/root/test0/l1")
attr = prim.CreateAttribute("custom", Sdf.ValueTypeNames.Float)
attr.Set(1.0)
await omni.kit.app.get_app().next_update_async()
layer0_prim_spec = layer0.GetPrimAtPath("/root/test0/l1")
layer1_prim_spec = layer1.GetPrimAtPath("/root/test0/l1")
self.assertTrue(layer0_prim_spec)
self.assertTrue(layer1_prim_spec)
attr_spec0 = layer0.GetAttributeAtPath(attr.GetPath())
attr_spec1 = layer1.GetAttributeAtPath(attr.GetPath())
self.assertTrue(attr_spec0)
self.assertTrue(attr_spec1)
self.assertEqual(attr_spec0.default, 1.0)
self.assertEqual(attr_spec1.default, 1.0)
# Create an attribute and make sure its edits are distributed to layer0 only.
# Unlink it from layer1 firstly to leave layer0 only.
prim = stage.GetPrimAtPath("/root/test0/l1/l2")
paths = specs_linking.unlink_spec(prim.GetPath(), layer1.identifier, hierarchy=False)
attr = prim.CreateAttribute("custom", Sdf.ValueTypeNames.Float)
attr.Set(100.0)
await omni.kit.app.get_app().next_update_async()
layer0_prim_spec = layer0.GetPrimAtPath(prim.GetPath())
layer1_prim_spec = layer1.GetPrimAtPath(prim.GetPath())
self.assertTrue(layer0_prim_spec)
self.assertFalse(layer1_prim_spec)
attr_spec0 = layer0.GetAttributeAtPath(attr.GetPath())
self.assertTrue(attr_spec0)
self.assertEqual(attr_spec0.default, 100.0)
# Link rotate attr to layer2 only, and lock translate attr.
translate_attr = "/root/test0/l1/l2/l3.xformOp:translate"
rotate_attr = "/root/test0/l1/l2/l3.xformOp:rotateXYZ"
specs_linking.unlink_spec_from_all_layers(rotate_attr)
specs_linking.link_spec(rotate_attr, layer2.identifier, hierarchy=False)
xform_prim = stage.GetPrimAtPath("/root/test0/l1/l2/l3")
common_api = UsdGeom.XformCommonAPI(xform_prim)
common_api.SetRotate(Gf.Vec3f(200.0, 200.0, 200.0))
await omni.kit.app.get_app().next_update_async()
await omni.kit.app.get_app().next_update_async()
xform_vectors = common_api.GetXformVectors(Usd.TimeCode.Default())
# Translate does not change and rotation is changed.
self.assertEqual(xform_vectors[1], Gf.Vec3f(200.0, 200.0, 200.0))
layer0_translate_attr = layer0.GetAttributeAtPath(translate_attr)
layer1_translate_attr = layer1.GetAttributeAtPath(translate_attr)
layer2_translate_attr = layer2.GetAttributeAtPath(translate_attr)
root_layer_translate_attr = root_layer.GetAttributeAtPath(translate_attr)
self.assertFalse(root_layer_translate_attr)
self.assertFalse(layer0_translate_attr)
self.assertFalse(layer1_translate_attr)
self.assertFalse(layer2_translate_attr)
layer0_rotation_attr = layer0.GetAttributeAtPath(rotate_attr)
layer1_rotation_attr = layer1.GetAttributeAtPath(rotate_attr)
layer2_rotation_attr = layer2.GetAttributeAtPath(rotate_attr)
root_layer_rotation_attr = root_layer.GetAttributeAtPath(rotate_attr)
self.assertFalse(layer0_rotation_attr)
self.assertFalse(layer1_rotation_attr)
self.assertTrue(layer2_rotation_attr)
self.assertFalse(root_layer_rotation_attr)
| 16,812 | Python | 46.49435 | 110 | 0.666488 |
omniverse-code/kit/exts/omni.kit.usd.layers/omni/kit/usd/layers/tests/test_layer_utils.py | import os
import carb
import omni.kit.test
import omni.usd
from omni.kit.usd.layers import LayerUtils
from pxr import Sdf, Usd, UsdGeom, UsdShade, Vt
class TestLayerUtils(omni.kit.test.AsyncTestCase):
async def setUp(self):
self.usd_context = omni.usd.get_context()
await omni.usd.get_context().new_stage_async()
async def tearDown(self):
await omni.usd.get_context().close_stage_async()
def check_sublayers(self, layer, expected_layer_identifiers):
sublayers = layer.subLayerPaths
self.assertTrue(len(sublayers) == len(expected_layer_identifiers), "Sublayers count does not match")
sublayer_paths = []
for sublayer_path in sublayers:
sublayer_paths.append(sublayer_path)
self.assertTrue(
sublayer_paths == expected_layer_identifiers,
f"Sublayers array does not match, got: {sublayer_paths}, expected: {expected_layer_identifiers}",
)
async def test_create_sublayer(self):
layer = Sdf.Layer.CreateAnonymous()
layer0 = LayerUtils.create_sublayer(layer, 0, "")
layer1 = LayerUtils.create_sublayer(layer, 1, "")
layer2 = LayerUtils.create_sublayer(layer, 2, "")
self.check_sublayers(layer, [layer0.identifier, layer1.identifier, layer2.identifier])
layer3 = LayerUtils.create_sublayer(layer, 3, "")
self.check_sublayers(layer, [layer0.identifier, layer1.identifier, layer2.identifier, layer3.identifier])
layer4 = LayerUtils.create_sublayer(layer, 3, "")
self.check_sublayers(
layer, [layer0.identifier, layer1.identifier, layer2.identifier, layer4.identifier, layer3.identifier]
)
layer5 = LayerUtils.create_sublayer(layer, -1, "")
self.check_sublayers(
layer,
[
layer0.identifier,
layer1.identifier,
layer2.identifier,
layer4.identifier,
layer3.identifier,
layer5.identifier,
],
)
layer6 = LayerUtils.create_sublayer(layer, 100, "")
self.check_sublayers(
layer,
[
layer0.identifier,
layer1.identifier,
layer2.identifier,
layer4.identifier,
layer3.identifier,
layer5.identifier,
layer6.identifier,
],
)
layer7 = LayerUtils.create_sublayer(layer, -2, "")
self.check_sublayers(
layer,
[
layer0.identifier,
layer1.identifier,
layer2.identifier,
layer4.identifier,
layer3.identifier,
layer5.identifier,
layer6.identifier,
],
)
layer8 = LayerUtils.create_sublayer(layer, 0, "")
self.check_sublayers(
layer,
[
layer8.identifier,
layer0.identifier,
layer1.identifier,
layer2.identifier,
layer4.identifier,
layer3.identifier,
layer5.identifier,
layer6.identifier,
],
)
async def test_insert_sublayer(self):
layer = Sdf.Layer.CreateAnonymous()
all_layers = []
for i in range(9):
all_layers.append(Sdf.Layer.CreateAnonymous())
layer0 = LayerUtils.insert_sublayer(layer, 0, all_layers[0].identifier)
layer1 = LayerUtils.insert_sublayer(layer, 1, all_layers[1].identifier)
layer2 = LayerUtils.insert_sublayer(layer, 2, all_layers[2].identifier)
self.check_sublayers(layer, [all_layers[0].identifier, all_layers[1].identifier, all_layers[2].identifier])
layer3 = LayerUtils.insert_sublayer(layer, 3, all_layers[3].identifier)
self.check_sublayers(
layer,
[all_layers[0].identifier, all_layers[1].identifier, all_layers[2].identifier, all_layers[3].identifier],
)
layer4 = LayerUtils.insert_sublayer(layer, 3, all_layers[4].identifier)
self.check_sublayers(
layer,
[
all_layers[0].identifier,
all_layers[1].identifier,
all_layers[2].identifier,
all_layers[4].identifier,
all_layers[3].identifier,
],
)
layer5 = LayerUtils.insert_sublayer(layer, -1, all_layers[5].identifier)
self.check_sublayers(
layer,
[
all_layers[0].identifier,
all_layers[1].identifier,
all_layers[2].identifier,
all_layers[4].identifier,
all_layers[3].identifier,
all_layers[5].identifier,
],
)
layer6 = LayerUtils.insert_sublayer(layer, 100, all_layers[6].identifier)
self.check_sublayers(
layer,
[
all_layers[0].identifier,
all_layers[1].identifier,
all_layers[2].identifier,
all_layers[4].identifier,
all_layers[3].identifier,
all_layers[5].identifier,
all_layers[6].identifier,
],
)
layer7 = LayerUtils.insert_sublayer(layer, -2, all_layers[7].identifier)
self.check_sublayers(
layer,
[
all_layers[0].identifier,
all_layers[1].identifier,
all_layers[2].identifier,
all_layers[4].identifier,
all_layers[3].identifier,
all_layers[5].identifier,
all_layers[6].identifier,
],
)
layer8 = LayerUtils.insert_sublayer(layer, 0, all_layers[8].identifier)
self.check_sublayers(
layer,
[
all_layers[8].identifier,
all_layers[0].identifier,
all_layers[1].identifier,
all_layers[2].identifier,
all_layers[4].identifier,
all_layers[3].identifier,
all_layers[5].identifier,
all_layers[6].identifier,
],
)
async def test_replace_sublayer(self):
layer = Sdf.Layer.CreateAnonymous()
all_layers = []
for i in range(7):
all_layers.append(Sdf.Layer.CreateAnonymous())
layer0 = LayerUtils.insert_sublayer(layer, 0, all_layers[0].identifier)
layer1 = LayerUtils.insert_sublayer(layer, 1, all_layers[1].identifier)
layer2 = LayerUtils.insert_sublayer(layer, 2, all_layers[2].identifier)
self.check_sublayers(layer, [all_layers[0].identifier, all_layers[1].identifier, all_layers[2].identifier])
layer3 = LayerUtils.replace_sublayer(layer, 2, all_layers[3].identifier)
self.check_sublayers(layer, [all_layers[0].identifier, all_layers[1].identifier, all_layers[3].identifier])
layer4 = LayerUtils.replace_sublayer(layer, -1, all_layers[4].identifier)
self.check_sublayers(layer, [all_layers[0].identifier, all_layers[1].identifier, all_layers[3].identifier])
layer5 = LayerUtils.replace_sublayer(layer, 0, all_layers[5].identifier)
self.check_sublayers(layer, [all_layers[5].identifier, all_layers[1].identifier, all_layers[3].identifier])
layer6 = LayerUtils.replace_sublayer(layer, 100, all_layers[6].identifier)
self.check_sublayers(layer, [all_layers[5].identifier, all_layers[1].identifier, all_layers[3].identifier])
async def test_get_set_custom_name(self):
layer = Sdf.Layer.CreateAnonymous()
LayerUtils.set_custom_layer_name(layer, "name1")
self.assertTrue(LayerUtils.get_custom_layer_name(layer) == "name1")
LayerUtils.set_custom_layer_name(layer, "")
self.assertTrue(LayerUtils.get_custom_layer_name(layer) == "name1")
LayerUtils.set_custom_layer_name(layer, "name test with space")
self.assertTrue(LayerUtils.get_custom_layer_name(layer) == "name test with space")
def _create_material(self, stage, material_name, material_file_path):
materials_group = UsdGeom.Scope.Define(stage, "/root/materials")
material_path = materials_group.GetPath().AppendElementString(material_name)
shader_path = material_path.AppendElementString(material_name)
material = UsdShade.Material.Define(stage, material_path)
shader = UsdShade.Shader.Define(stage, shader_path)
shader.CreateOutput("out", Sdf.ValueTypeNames.Token)
material.CreateSurfaceOutput().ConnectToSource(shader, "out")
shader.SetSourceAsset(material_file_path, "mdl")
shader.SetSourceAssetSubIdentifier(material_name)
shader.GetImplementationSourceAttr().Set(UsdShade.Tokens.sourceAsset)
return material, shader
async def test_resolve_paths(self):
format = Sdf.FileFormat.FindByExtension(".usd")
layer = Sdf.Layer.New(format, "omniverse://test-ov-fake-server/fake/path/a.usd")
sublayer0 = Sdf.Layer.New(format, "omniverse://test-ov-fake-server/fake/path/sublayers/sublayer0.usd")
layer.subLayerPaths.insert(0, "./sublayers/sublayer0.usd")
layer.subLayerOffsets[0] = Sdf.LayerOffset(2.0, 3.0)
custom_data = layer.customLayerData
custom_data["path"] = Sdf.AssetPath("../test_path.usd")
layer.customLayerData = custom_data
stage = Usd.Stage.Open(layer)
mesh = UsdGeom.Mesh.Define(stage, "/root/test")
test_prim = mesh.GetPrim()
test_prim.GetReferences().AddReference("../b.usd")
test_prim.GetPayloads().AddPayload("../c.usd")
test_prim.CreateAttribute("Asset", Sdf.ValueTypeNames.Asset, False).Set("../d.usd")
test_prim.CreateAttribute("AssetArray", Sdf.ValueTypeNames.AssetArray, False).Set(
["../e.usd", "../f.usd", "OmniPBR.mdl"]
)
test_prim_spec = layer.GetPrimAtPath(test_prim.GetPath())
test_prim_spec.customData["path"] = Sdf.AssetPath("../test.usd")
omnipbr_mat, omnipbr_shader = self._create_material(stage, "omnipbr", "OmniPBR.mdl")
external_mat, external_shader = self._create_material(stage, "external_mat", "../invalid_path/external_mat.mdl")
# OM-42410: Paths without "./" are search paths
searchpath_mat, searchpath_shader = self._create_material(stage, "searchpath_mat", "nvidia/searchpath_mat.mdl")
material_binding = UsdShade.MaterialBindingAPI(test_prim)
material_binding.Bind(omnipbr_mat)
mesh = UsdGeom.Mesh.Define(stage, "/root/test2")
test2_prim = mesh.GetPrim()
material_binding = UsdShade.MaterialBindingAPI(test2_prim)
material_binding.Bind(external_mat)
mesh2 = UsdGeom.Mesh.Define(stage, "/root/test3")
test3_prim = mesh2.GetPrim()
material_binding = UsdShade.MaterialBindingAPI(test3_prim)
material_binding.Bind(searchpath_mat)
omni.usd.create_material_input(
external_mat.GetPrim(),
"diffuse_texture",
Sdf.AssetPath("../invalid_path/invalid.png"),
Sdf.ValueTypeNames.Asset,
)
target_layer = Sdf.Layer.New(format, "omniverse://test-ov-fake-server/fake/path/deep/level/a.usd")
target_layer.TransferContent(layer)
LayerUtils.resolve_paths(layer, target_layer, True, False, True)
# Make sure that layer offset and scale are not changed.
sublayer_offset = target_layer.subLayerOffsets[0]
self.assertTrue(float(sublayer_offset.offset) == 2.0 and float(sublayer_offset.scale) == 3.0)
string = target_layer.ExportToString()
# FIXME: Search string directly instead of using USD API since it will cause unknown crashes.
self.assertTrue(
string.find("@../../sublayers/sublayer0.usd@") != -1,
f"Sublayer repathing failed, expected: ../../sublayers/sublayer0.usd.",
)
self.assertTrue(string.find("@../../../b.usd@") != -1, f"Reference is not resolved, expected: ../../../b.usd.")
self.assertTrue(string.find("@../../../c.usd@") != -1, f"Payload is not resolved, expected: ../../../c.usd.")
self.assertTrue(
string.find("@OmniPBR.mdl@") != -1,
f"MDL from Core MDL Library should not be repathing, expected: OmniPBR.mdl.",
)
self.assertTrue(
string.find("@../../../invalid_path/external_mat.mdl@") != -1,
f"MDL repathing failed, expected: ../../../invalid_path/external_mat.mdl.",
)
self.assertTrue(
string.find("@../../../invalid_path/invalid.png@") != -1,
f"Material input repathing failed, expected: ../../../invalid_path/invalid.mdl.",
)
# Checks if all paths in target_path is re-pathing correctly.
custom_data = target_layer.customLayerData
self.assertTrue("path" in custom_data)
self.assertEqual(custom_data["path"], "../../../test_path.usd")
test_prim_spec = target_layer.GetPrimAtPath(test_prim.GetPath())
self.assertTrue("path" in test_prim_spec.customData)
self.assertEqual(test_prim_spec.customData["path"], "../../../test.usd")
references = test_prim_spec.referenceList.prependedItems
reference = references[0]
self.assertEqual(reference.assetPath, "../../../b.usd")
payloads = test_prim_spec.payloadList.prependedItems
payload = payloads[0]
self.assertEqual(payload.assetPath, "../../../c.usd")
new_stage = Usd.Stage.Open(target_layer)
test_prim = new_stage.GetPrimAtPath(test_prim.GetPath())
attribute = test_prim.GetAttribute("Asset")
self.assertEqual(attribute.GetTypeName(), Sdf.ValueTypeNames.Asset)
path = attribute.Get().path
self.assertEqual(path, "../../../d.usd")
attribute = test_prim.GetAttribute("AssetArray")
self.assertTrue(attribute.GetTypeName() == Sdf.ValueTypeNames.AssetArray)
asset_array = attribute.Get()
self.assertEqual
(asset_array, Vt.StringArray(3, ("../../../e.usd", "../../../f.usd", "OmniPBR.mdl")))
# MDL from core mdl library should stay untouched
target_stage = Usd.Stage.Open(target_layer)
target_omnipbr_shader = UsdShade.Shader.Get(target_stage, omnipbr_shader.GetPrim().GetPath())
mdl = target_omnipbr_shader.GetSourceAsset("mdl")
self.assertEqual(mdl.path, "OmniPBR.mdl")
# MDL from external should be repathing to be relative to target layer.
target_external_shader = UsdShade.Shader.Get(target_stage, external_shader.GetPrim().GetPath())
mdl = target_external_shader.GetSourceAsset("mdl")
self.assertEqual(mdl.path, "../../../invalid_path/external_mat.mdl")
# MDL from search path should stay untouched.
target_searchpath_shader = UsdShade.Shader.Get(target_stage, searchpath_shader.GetPrim().GetPath())
mdl = target_searchpath_shader.GetSourceAsset("mdl")
self.assertEqual(mdl.path, "nvidia/searchpath_mat.mdl")
texture_input = target_external_shader.GetInput("diffuse_texture")
path = texture_input.Get().path
self.assertEqual(path, "../../../invalid_path/invalid.png")
def test_get_sublayer_position_in_parent(self):
layer = Sdf.Layer.CreateAnonymous()
layer0 = LayerUtils.create_sublayer(layer, 0, "")
layer1 = LayerUtils.create_sublayer(layer, 1, "")
layer2 = LayerUtils.create_sublayer(layer, 2, "")
position = LayerUtils.get_sublayer_position_in_parent(layer.identifier, layer0.identifier)
self.assertTrue(position == 0)
position = LayerUtils.get_sublayer_position_in_parent(layer.identifier, layer1.identifier)
self.assertTrue(position == 1)
position = LayerUtils.get_sublayer_position_in_parent(layer.identifier, layer2.identifier)
self.assertTrue(position == 2)
position = LayerUtils.get_sublayer_position_in_parent(layer.identifier, "random")
self.assertTrue(position == -1)
position = LayerUtils.get_sublayer_position_in_parent(layer.identifier, "")
self.assertTrue(position == -1)
def test_get_set_layer_global_muteness(self):
layer = Sdf.Layer.CreateAnonymous()
LayerUtils.set_layer_global_muteness(layer, "c:/test/abcd/a.usd", True)
self.assertTrue(LayerUtils.get_layer_global_muteness(layer, "c:/test/abcd/a.usd"))
LayerUtils.set_layer_global_muteness(layer, "c:/random_string", True)
self.assertTrue(LayerUtils.get_layer_global_muteness(layer, "c:/random_string"))
LayerUtils.remove_layer_global_muteness(layer, "c:/random_string")
self.assertFalse(LayerUtils.get_layer_global_muteness(layer, "c:/random_string"))
def test_get_set_layer_lock_status(self):
layer = Sdf.Layer.CreateAnonymous()
LayerUtils.set_layer_lock_status(layer, "c:/test/abcd/a.usd", True)
self.assertTrue(LayerUtils.get_layer_lock_status(layer, "c:/test/abcd/a.usd"))
LayerUtils.set_layer_lock_status(layer, "c:/random_string", True)
self.assertTrue(LayerUtils.get_layer_lock_status(layer, "c:/random_string"))
LayerUtils.remove_layer_lock_status(layer, "c:/random_string")
self.assertFalse(LayerUtils.get_layer_lock_status(layer, "c:/random_string"))
def test_has_prim_spec(self):
layer = Sdf.Layer.CreateAnonymous()
stage = Usd.Stage.Open(layer)
stage.DefinePrim("/Root/TestPrim")
self.assertTrue(LayerUtils.has_prim_spec(layer.identifier, "/Root/TestPrim"))
self.assertTrue(LayerUtils.has_prim_spec(layer.identifier, "/"))
self.assertTrue(LayerUtils.has_prim_spec(layer.identifier, "/Root"))
self.assertFalse(LayerUtils.has_prim_spec(layer.identifier, "/Root/TestPrim2"))
self.assertFalse(LayerUtils.has_prim_spec(layer.identifier, ""))
def test_get_sublayer_identifier(self):
format = Sdf.FileFormat.FindByExtension(".usd")
layer = Sdf.Layer.New(format, "omniverse://test-ov-fake-server/fake/path/a.usd")
sublayer0 = Sdf.Layer.New(format, "omniverse://test-ov-fake-server/fake/path/sublayers/sublayer0.usd")
layer.subLayerPaths.insert(0, "./sublayers/sublayer0.usd")
identifier = LayerUtils.get_sublayer_identifier(layer.identifier, 0)
self.assertTrue(sublayer0.identifier == identifier)
def test_restore_muteness_from_custom_data(self):
format = Sdf.FileFormat.FindByExtension(".usd")
layer = Sdf.Layer.CreateAnonymous()
layer0 = Sdf.Layer.CreateAnonymous()
layer1 = Sdf.Layer.CreateAnonymous()
layer2 = Sdf.Layer.CreateAnonymous()
layer3 = Sdf.Layer.CreateAnonymous()
layer4 = Sdf.Layer.CreateAnonymous()
layer.subLayerPaths.append(layer0.identifier)
layer.subLayerPaths.append(layer1.identifier)
layer.subLayerPaths.append(layer2.identifier)
layer.subLayerPaths.append(layer3.identifier)
layer.subLayerPaths.append(layer4.identifier)
LayerUtils.set_layer_global_muteness(layer, layer0.identifier, True)
LayerUtils.set_layer_global_muteness(layer, layer1.identifier, False)
LayerUtils.set_layer_global_muteness(layer, layer2.identifier, True)
LayerUtils.set_layer_global_muteness(layer, layer3.identifier, False)
LayerUtils.set_layer_global_muteness(layer, layer4.identifier, True)
stage = Usd.Stage.Open(layer)
LayerUtils.restore_muteness_from_custom_data(stage)
self.assertTrue(stage.IsLayerMuted(layer0.identifier))
self.assertFalse(stage.IsLayerMuted(layer1.identifier))
self.assertTrue(stage.IsLayerMuted(layer2.identifier))
self.assertFalse(stage.IsLayerMuted(layer3.identifier))
self.assertTrue(stage.IsLayerMuted(layer4.identifier))
def test_set_get_global_muteness(self):
layer = Sdf.Layer.CreateAnonymous()
LayerUtils.set_layer_global_muteness(layer, "test_identifier", True)
LayerUtils.set_layer_global_muteness(layer, "", True)
self.assertTrue(LayerUtils.get_layer_global_muteness(layer, "test_identifier"))
self.assertFalse(LayerUtils.get_layer_global_muteness(layer, "test_identifier2"))
self.assertFalse(LayerUtils.get_layer_global_muteness(layer, ""))
LayerUtils.remove_layer_global_muteness(layer, "test_identifier")
self.assertFalse(LayerUtils.get_layer_global_muteness(layer, "test_identifier"))
def test_remove_sublayer(self):
format = Sdf.FileFormat.FindByExtension(".usd")
layer = Sdf.Layer.CreateAnonymous()
layer0 = Sdf.Layer.CreateAnonymous()
layer1 = Sdf.Layer.CreateAnonymous()
layer2 = Sdf.Layer.CreateAnonymous()
layer3 = Sdf.Layer.CreateAnonymous()
layer4 = Sdf.Layer.CreateAnonymous()
layer.subLayerPaths.append(layer0.identifier)
layer.subLayerPaths.append(layer1.identifier)
layer.subLayerPaths.append(layer2.identifier)
layer.subLayerPaths.append(layer3.identifier)
layer.subLayerPaths.append(layer4.identifier)
LayerUtils.remove_sublayer(layer, 0)
self.check_sublayers(layer, [layer1.identifier, layer2.identifier, layer3.identifier, layer4.identifier])
# -1 means the last element.
LayerUtils.remove_sublayer(layer, -1)
self.check_sublayers(layer, [layer1.identifier, layer2.identifier, layer3.identifier])
# Invalid index
LayerUtils.remove_sublayer(layer, 100)
self.check_sublayers(layer, [layer1.identifier, layer2.identifier, layer3.identifier])
# Invalid index
LayerUtils.remove_sublayer(layer, -2)
self.check_sublayers(layer, [layer1.identifier, layer2.identifier, layer3.identifier])
# clear it and try to remove an sublayer.
layer.subLayerPaths = []
LayerUtils.remove_sublayer(layer, 1)
self.check_sublayers(layer, [])
def test_remove_prim_spec(self):
layer = Sdf.Layer.CreateAnonymous()
stage = Usd.Stage.Open(layer)
mesh = UsdGeom.Mesh.Define(stage, "/root/test")
self.assertTrue(layer.GetPrimAtPath("/root/test"))
LayerUtils.remove_prim_spec(layer, "/root/test")
self.assertFalse(layer.GetPrimAtPath("/root/test"))
self.assertTrue(layer.GetPrimAtPath("/root"))
LayerUtils.remove_prim_spec(layer, "/root")
self.assertFalse(layer.GetPrimAtPath("/root"))
def test_get_all_sublayers(self):
layer = Sdf.Layer.CreateAnonymous()
layer0 = Sdf.Layer.CreateAnonymous()
layer1 = Sdf.Layer.CreateAnonymous()
layer2 = Sdf.Layer.CreateAnonymous()
layer3 = Sdf.Layer.CreateAnonymous()
layer4 = Sdf.Layer.CreateAnonymous()
layer5 = Sdf.Layer.CreateAnonymous()
layer.subLayerPaths.append(layer0.identifier)
layer.subLayerPaths.append(layer1.identifier)
layer.subLayerPaths.append(layer2.identifier)
layer.subLayerPaths.append(layer3.identifier)
# Creates a circular reference: layer -> layer0 -> layer
layer0.subLayerPaths.append(layer.identifier)
layer3.subLayerPaths.append(layer4.identifier)
layer4.subLayerPaths.append(layer5.identifier)
stage = Usd.Stage.Open(layer)
self.assertTrue(
LayerUtils.get_all_sublayers(stage),
[
layer0.identifier,
layer1.identifier,
layer2.identifier,
layer3.identifier,
layer4.identifier,
layer5.identifier,
],
)
def test_move_layer(self):
layer = Sdf.Layer.CreateAnonymous()
layer0 = Sdf.Layer.CreateAnonymous()
layer1 = Sdf.Layer.CreateAnonymous()
layer2 = Sdf.Layer.CreateAnonymous()
layer3 = Sdf.Layer.CreateAnonymous()
layer4 = Sdf.Layer.CreateAnonymous()
layer5 = Sdf.Layer.CreateAnonymous()
layer.subLayerPaths.append(layer0.identifier)
layer.subLayerPaths.append(layer1.identifier)
layer.subLayerPaths.append(layer2.identifier)
layer.subLayerPaths.append(layer3.identifier)
# Creates a circular reference: layer -> layer0 -> layer
layer0.subLayerPaths.append(layer.identifier)
layer3.subLayerPaths.append(layer4.identifier)
layer4.subLayerPaths.append(layer5.identifier)
LayerUtils.move_layer(layer.identifier, 0, layer.identifier, 1, True)
self.check_sublayers(layer, [layer1.identifier, layer0.identifier, layer2.identifier, layer3.identifier])
# Move to the end
LayerUtils.move_layer(layer.identifier, 0, layer.identifier, -1, True)
self.check_sublayers(layer, [layer0.identifier, layer2.identifier, layer3.identifier, layer1.identifier])
LayerUtils.move_layer(layer.identifier, 0, layer.identifier, 100, True)
self.check_sublayers(layer, [layer2.identifier, layer3.identifier, layer1.identifier, layer0.identifier])
# Invalid source
LayerUtils.move_layer(layer.identifier, -1, layer.identifier, 0, True)
self.check_sublayers(layer, [layer2.identifier, layer3.identifier, layer1.identifier, layer0.identifier])
# Invalid target
LayerUtils.move_layer(layer.identifier, 0, layer.identifier, -100, True)
self.check_sublayers(layer, [layer2.identifier, layer3.identifier, layer1.identifier, layer0.identifier])
# Move it to layer3 but not deletes it from source layer.
LayerUtils.move_layer(layer.identifier, 0, layer3.identifier, 0, False)
self.check_sublayers(layer, [layer2.identifier, layer3.identifier, layer1.identifier, layer0.identifier])
self.check_sublayers(layer3, [layer2.identifier, layer4.identifier])
LayerUtils.move_layer(layer.identifier, 0, layer1.identifier, 0, True)
self.check_sublayers(layer, [layer3.identifier, layer1.identifier, layer0.identifier])
self.check_sublayers(layer1, [layer2.identifier])
def test_stitch_prim_specs(self):
layer_content = """\
#usda 1.0
(
subLayers = [
@omniverse://test-ov-fake-server/fake/path/sublayers/sublayer0.usd@,
@omniverse://test-ov-fake-server/fake/path/sublayers/sublayer1.usd@
]
)
def "root"
{
def "test_prim"
{
int test = 1
def "test_prim2"
{
int test = 1
}
}
def "test_prim3"
{
int test = 1
}
}
"""
layer0_content = """\
#usda 1.0
over "root"
{
over "test_prim" (
prepend payload = @../invalid/payload1.usd@
prepend references = @../invalid/reference1.usd@
)
{
int test = 2
over "test_prim2" (
prepend payload = @../invalid/payload1.usd@
prepend references = @../invalid/reference1.usd@
)
{
int test = 2
}
}
over "test_prim3" (
prepend payload = @../invalid/payload1.usd@
prepend references = @../invalid/reference1.usd@
)
{
int test = 2
}
}
"""
layer1_content = """\
#usda 1.0
(
subLayers = [
@omniverse://test-ov-fake-server/fake/path/sublayers/level2/sublayer2.usd@
]
)
over "root"
{
over "test_prim" (
prepend payload = @../invalid/payload2.usd@
prepend references = @../invalid/reference2.usd@
)
{
asset[] AssetArray = [@1.usd@, @2.usd@, @OmniPBR.mdl@]
bool[] BoolArray = [0, 1]
float[] FloatArray = [1, 2, 3]
int[] IntArray = [1, 2, 3]
string[] StringArray = ["string1", "string2", "string3"]
int test = 3
asset test2 = @../../invalid/path.usd@
asset test3 = @OmniPBR.mdl@
token[] TokenArray = ["token1", "token2", "token3"]
}
}
"""
layer2_content = """\
#usda 1.0
over "root"
{
over "test_prim" (
prepend payload = @../invalid/payload2.usd@
prepend references = @../invalid/reference2.usd@
)
{
asset[] AssetArray = [@3.usd@, @4.usd@, @OmniPBR.mdl@]
bool[] BoolArray = [1, 0]
float[] FloatArray = [3, 2, 1]
int[] IntArray = [3, 2, 1]
string[] StringArray = ["string3", "string2", "string1"]
int test = 3
asset test2 = @../../invalid/path.usd@
asset test3 = @OmniPBR.mdl@
asset test4 = @./invalid.mdl@
asset test5 = @nvidia/invalid.mdl@
token[] TokenArray = ["token3", "token2", "token1"]
}
}
"""
format = Sdf.FileFormat.FindByExtension(".usd")
layer = Sdf.Layer.New(format, "omniverse://test-ov-fake-server/fake/path/a.usd")
layer0 = Sdf.Layer.New(format, "omniverse://test-ov-fake-server/fake/path/sublayers/sublayer0.usd")
layer1 = Sdf.Layer.New(format, "omniverse://test-ov-fake-server/fake/path/sublayers/sublayer1.usd")
layer2 = Sdf.Layer.New(format, "omniverse://test-ov-fake-server/fake/path/sublayers/level2/sublayer2.usd")
layer.ImportFromString(layer_content)
layer0.ImportFromString(layer0_content)
layer1.ImportFromString(layer1_content)
layer2.ImportFromString(layer2_content)
stage = Usd.Stage.Open(layer)
result_layer = Sdf.Layer.CreateAnonymous()
prim_paths = ["/root/test_prim", "/root/test_prim3"]
with Sdf.ChangeBlock():
for prim_path in prim_paths:
omni.usd.stitch_prim_specs(stage, prim_path, result_layer)
new_stage = Usd.Stage.Open(result_layer)
prim = new_stage.GetPrimAtPath("/root/test_prim")
prim_spec = result_layer.GetPrimAtPath("/root/test_prim")
references = prim_spec.referenceList.prependedItems
self.assertTrue(len(references), 3)
self.assertEqual(references[0].assetPath, "omniverse://test-ov-fake-server/fake/path/invalid/reference1.usd")
self.assertEqual(references[1].assetPath, "omniverse://test-ov-fake-server/fake/path/invalid/reference2.usd")
self.assertEqual(
references[2].assetPath, "omniverse://test-ov-fake-server/fake/path/sublayers/invalid/reference2.usd"
)
payloads = prim_spec.payloadList.prependedItems
self.assertTrue(len(payloads), 3)
self.assertEqual(payloads[0].assetPath, "omniverse://test-ov-fake-server/fake/path/invalid/payload1.usd")
self.assertEqual(payloads[1].assetPath, "omniverse://test-ov-fake-server/fake/path/invalid/payload2.usd")
self.assertEqual(
payloads[2].assetPath, "omniverse://test-ov-fake-server/fake/path/sublayers/invalid/payload2.usd"
)
self.assertTrue(not not prim)
attribute = prim.GetAttribute("test")
self.assertTrue(attribute.GetTypeName() == Sdf.ValueTypeNames.Int)
self.assertTrue(attribute.Get() == 1)
attribute = prim.GetAttribute("test2")
self.assertTrue(attribute.GetTypeName() == Sdf.ValueTypeNames.Asset)
path = attribute.Get().path
self.assertTrue(
path == "omniverse://test-ov-fake-server/fake/invalid/path.usd", f"Path resolved is not correct: {path}."
)
attribute = prim.GetAttribute("test3")
self.assertTrue(attribute.GetTypeName() == Sdf.ValueTypeNames.Asset)
path = attribute.Get().path
# For path from core mdl library, it should not be re-mapping.
self.assertTrue(path == "OmniPBR.mdl", f"Path resolved is not correct: {path}.")
attribute = prim.GetAttribute("test4")
self.assertTrue(attribute.GetTypeName() == Sdf.ValueTypeNames.Asset)
path = attribute.Get().path
self.assertTrue(
path == "omniverse://test-ov-fake-server/fake/path/sublayers/level2/invalid.mdl",
f"Path resolved is not correct: {path}.",
)
# Search path should stay untouched.
attribute = prim.GetAttribute("test5")
self.assertTrue(attribute.GetTypeName() == Sdf.ValueTypeNames.Asset)
path = attribute.Get().path
self.assertTrue(path == "nvidia/invalid.mdl", f"Path resolved is not correct: {path}.")
attribute = prim.GetAttribute("BoolArray")
self.assertTrue(attribute.GetTypeName() == Sdf.ValueTypeNames.BoolArray)
bool_array = attribute.Get()
self.assertTrue(len(bool_array) == 2)
self.assertEqual(bool_array, Vt.BoolArray(2, (False, True)))
attribute = prim.GetAttribute("IntArray")
self.assertTrue(attribute.GetTypeName() == Sdf.ValueTypeNames.IntArray)
int_array = attribute.Get()
self.assertEqual(int_array, Vt.IntArray(3, (1, 2, 3)))
attribute = prim.GetAttribute("FloatArray")
self.assertTrue(attribute.GetTypeName() == Sdf.ValueTypeNames.FloatArray)
float_array = attribute.Get()
self.assertEqual(float_array, Vt.FloatArray(3, (1.0, 2.0, 3.0)))
attribute = prim.GetAttribute("TokenArray")
self.assertTrue(attribute.GetTypeName() == Sdf.ValueTypeNames.TokenArray)
token_array = attribute.Get()
self.assertEqual(token_array, Vt.TokenArray(3, ("token1", "token2", "token3")))
attribute = prim.GetAttribute("StringArray")
self.assertTrue(attribute.GetTypeName() == Sdf.ValueTypeNames.StringArray)
string_array = attribute.Get()
self.assertEqual(string_array, Vt.StringArray(3, ("string1", "string2", "string3")))
attribute = prim.GetAttribute("AssetArray")
self.assertTrue(attribute.GetTypeName() == Sdf.ValueTypeNames.AssetArray)
asset_array = attribute.Get()
self.assertEqual
(
asset_array,
Vt.StringArray(
3,
(
"omniverse://test-ov-fake-server/fake/path/sublayers/1.usd",
"omniverse://test-ov-fake-server/fake/path/sublayers/2.usd",
"OmniPBR.mdl",
),
),
)
prim = new_stage.GetPrimAtPath("/root/test_prim/test_prim2")
prim_spec = result_layer.GetPrimAtPath("/root/test_prim/test_prim2")
references = prim_spec.referenceList.prependedItems
self.assertTrue(len(references), 1)
self.assertEqual(references[0].assetPath, "omniverse://test-ov-fake-server/fake/path/invalid/reference1.usd")
payloads = prim_spec.payloadList.prependedItems
self.assertTrue(len(payloads), 1)
self.assertEqual(payloads[0].assetPath, "omniverse://test-ov-fake-server/fake/path/invalid/payload1.usd")
self.assertTrue(not not prim)
attribute = prim.GetAttribute("test")
self.assertTrue(attribute.GetTypeName() == Sdf.ValueTypeNames.Int)
self.assertTrue(attribute.Get() == 1)
prim = new_stage.GetPrimAtPath("/root/test_prim3")
prim_spec = result_layer.GetPrimAtPath("/root/test_prim3")
references = prim_spec.referenceList.prependedItems
self.assertTrue(len(references), 1)
self.assertEqual(references[0].assetPath, "omniverse://test-ov-fake-server/fake/path/invalid/reference1.usd")
payloads = prim_spec.payloadList.prependedItems
self.assertTrue(len(payloads), 1)
self.assertEqual(payloads[0].assetPath, "omniverse://test-ov-fake-server/fake/path/invalid/payload1.usd")
self.assertTrue(not not prim)
attribute = prim.GetAttribute("test")
self.assertTrue(attribute.GetTypeName() == Sdf.ValueTypeNames.Int)
self.assertTrue(attribute.Get() == 1)
| 36,841 | Python | 43.495169 | 120 | 0.614234 |
omniverse-code/kit/exts/omni.kit.usd.layers/omni/kit/usd/layers/tests/test_commands.py | from pathlib import Path
import omni.kit.test
import omni.kit.undo
import omni.kit.commands
import omni.timeline
import omni.usd
from omni.kit.usd.layers import LayerUtils, get_layers, LayerEditMode
from pxr import Gf, Kind, Sdf, Usd, UsdGeom, UsdShade, UsdUtils
CURRENT_PATH = Path(__file__).parent.parent.parent.parent.parent.parent.joinpath("data")
FILE_PATH_OmniPBR = CURRENT_PATH.joinpath("material_OmniPBR.usda").as_posix()
FILE_PATH_OmniGlass = CURRENT_PATH.joinpath("material_OmniGlass.usda").as_posix()
def get_stage_default_prim_path(stage):
if stage.HasDefaultPrim():
return stage.GetDefaultPrim().GetPath()
else:
return Sdf.Path.absoluteRootPath
class TestUsdCommands(omni.kit.test.AsyncTestCase):
# Before running each test
async def setUp(self):
self.usd_context = omni.usd.get_context()
await omni.usd.get_context().new_stage_async()
async def tearDown(self):
if omni.usd.get_context().get_stage():
await omni.usd.get_context().close_stage_async()
async def test_create_layer(self):
usd_context = omni.usd.get_context()
stage = usd_context.get_stage()
default_prim_path = get_stage_default_prim_path(stage)
root_layer = stage.GetRootLayer()
metadata = {"upAxis": "Z", "metersPerUnit": 0.005, "timeCodesPerSecond": 32}
if stage.HasDefaultPrim():
metadata["defaultPrim"] = stage.GetDefaultPrim().GetName()
for key, val in metadata.items():
stage.SetMetadata(key, val)
# make a sphere in the root layer to test the transfer content feature
with Usd.EditContext(stage, root_layer):
omni.kit.commands.execute("CreatePrim", prim_type="Sphere")
prim = stage.GetPrimAtPath(default_prim_path.AppendChild("Sphere"))
def check_layers(layers_info):
for key, desired_val in metadata.items():
val = stage.GetMetadata(key)
self.assertTrue(val == desired_val, "stage metadata changed")
self.assertTrue(len(layers_info) == len(root_layer.subLayerPaths), "number of layers")
for layer_info in layers_info:
index, anon, transfered = layer_info
# check assumes we only transfered content 0-1 times
layer = Sdf.Find(root_layer.subLayerPaths[index])
self.assertTrue(layer is not None, "layer is found")
prim = layer.GetPrimAtPath(default_prim_path.AppendChild("Sphere"))
if transfered:
self.assertTrue(prim, "prim was transferred")
else:
self.assertFalse(prim, "prim wasn't transferred")
# test one layer - anonymous - no transfer
# position_before, anonymous, transfer_root_content
omni.kit.commands.execute(
"CreateSublayer",
layer_identifier=root_layer.identifier,
sublayer_position=0,
new_layer_path="",
transfer_root_content=False,
create_or_insert=True,
)
check_layers([(0, True, False)])
omni.kit.undo.undo()
check_layers([])
omni.kit.undo.redo()
check_layers([(0, True, False)])
omni.kit.undo.undo()
check_layers([])
# test one layer - anonymous - transfer
omni.kit.commands.execute(
"CreateSublayer",
layer_identifier=root_layer.identifier,
sublayer_position=0,
new_layer_path="",
transfer_root_content=True,
create_or_insert=True,
)
check_layers([(0, True, True)])
omni.kit.undo.undo()
check_layers([])
omni.kit.undo.redo()
check_layers([(0, True, True)])
omni.kit.undo.undo()
check_layers([])
# test multiple layers - anonymous - no transfer
omni.kit.commands.execute(
"CreateSublayer",
layer_identifier=root_layer.identifier,
sublayer_position=0,
new_layer_path="",
transfer_root_content=False,
create_or_insert=True,
)
omni.kit.commands.execute(
"CreateSublayer",
layer_identifier=root_layer.identifier,
sublayer_position=1,
new_layer_path="",
transfer_root_content=False,
create_or_insert=True,
)
omni.kit.commands.execute(
"CreateSublayer",
layer_identifier=root_layer.identifier,
sublayer_position=2,
new_layer_path="",
transfer_root_content=False,
create_or_insert=True,
)
check_layers([(0, True, False), (1, True, False), (2, True, False)])
omni.kit.undo.undo()
check_layers([(0, True, False), (1, True, False)])
omni.kit.undo.redo()
check_layers([(0, True, False), (1, True, False), (2, True, False)])
omni.kit.undo.undo()
omni.kit.undo.undo()
check_layers([(0, True, False)])
omni.kit.undo.redo()
check_layers([(0, True, False), (1, True, False)])
omni.kit.undo.undo()
omni.kit.undo.undo()
check_layers([])
omni.kit.undo.redo()
check_layers([(0, True, False)])
omni.kit.undo.undo()
check_layers([])
async def test_replace_sublayer(self):
usd_context = omni.usd.get_context()
stage = usd_context.get_stage()
root_layer = stage.GetRootLayer()
omni.kit.commands.execute(
"CreateSublayer",
layer_identifier=root_layer.identifier,
sublayer_position=1,
new_layer_path="",
transfer_root_content=False,
create_or_insert=True,
)
sublayer_paths = root_layer.subLayerPaths
self.assertTrue(len(sublayer_paths) == 1)
sublayer1 = Sdf.Layer.FindOrOpen(sublayer_paths[0])
sublayer2 = Sdf.Layer.CreateAnonymous()
edit_target_identifier = LayerUtils.get_edit_target(stage)
self.assertTrue(edit_target_identifier == root_layer.identifier)
# Replace layer and check if it's successfull and edit target does not change.
omni.kit.commands.execute(
"ReplaceSublayer",
layer_identifier=root_layer.identifier,
sublayer_position=0,
new_layer_path=sublayer2.identifier,
)
edit_target_identifier = LayerUtils.get_edit_target(stage)
self.assertTrue(edit_target_identifier == root_layer.identifier)
sublayer_paths = root_layer.subLayerPaths
self.assertTrue(len(sublayer_paths) == 1)
self.assertTrue(sublayer_paths[0] == sublayer2.identifier)
omni.kit.undo.undo()
self.assertTrue(len(sublayer_paths) == 1)
sublayer_paths = root_layer.subLayerPaths
self.assertTrue(sublayer_paths[0] == sublayer1.identifier)
omni.kit.undo.redo()
self.assertTrue(len(sublayer_paths) == 1)
sublayer_paths = root_layer.subLayerPaths
self.assertTrue(sublayer_paths[0] == sublayer2.identifier)
omni.kit.undo.undo()
# Sets sublayer as edit target and do the replacement to see if edit target is changed or not.
LayerUtils.set_edit_target(stage, sublayer1.identifier)
omni.kit.commands.execute(
"ReplaceSublayer",
layer_identifier=root_layer.identifier,
sublayer_position=0,
new_layer_path=sublayer2.identifier,
)
edit_target_identifier = LayerUtils.get_edit_target(stage)
self.assertTrue(edit_target_identifier == sublayer2.identifier)
sublayer_paths = root_layer.subLayerPaths
self.assertTrue(len(sublayer_paths) == 1)
self.assertTrue(sublayer_paths[0] == sublayer2.identifier)
omni.kit.undo.undo()
edit_target_identifier = LayerUtils.get_edit_target(stage)
self.assertTrue(edit_target_identifier == sublayer1.identifier)
# Replace a invalid index will fail.
omni.kit.commands.execute(
"ReplaceSublayer",
layer_identifier=root_layer.identifier,
sublayer_position=100,
new_layer_path=sublayer2.identifier,
)
self.assertTrue(len(sublayer_paths) == 1)
sublayer_paths = root_layer.subLayerPaths
self.assertEqual(sublayer_paths[0], sublayer1.identifier)
async def test_move_nodes(self):
# move nodes also uses merge nodes and remove nodes
usd_context = omni.usd.get_context()
stage = usd_context.get_stage()
default_prim_path = get_stage_default_prim_path(stage)
root_layer = stage.GetRootLayer()
# create anonymous layers
LayerUtils.create_sublayer(root_layer, 0, "")
LayerUtils.create_sublayer(root_layer, 1, "")
LayerUtils.create_sublayer(root_layer, 2, "")
strong_layer = Sdf.Find(root_layer.subLayerPaths[0])
intermediate_layer = Sdf.Find(root_layer.subLayerPaths[1])
weak_layer = Sdf.Find(root_layer.subLayerPaths[2])
# add some content
# root: stage/cone* height=0.7
# strong: stage/sphere* radius=0.5, stage/cone
# intermediate: empty
# weak: stage/sphere radius=1.234
with Usd.EditContext(stage, weak_layer):
omni.kit.commands.execute("CreatePrim", prim_type="Sphere")
prim = stage.GetPrimAtPath(default_prim_path.AppendChild("Sphere"))
sphere = UsdGeom.Sphere(prim)
with Usd.EditContext(stage, weak_layer):
sphere.CreateRadiusAttr(1.234)
with Usd.EditContext(stage, strong_layer):
sphere.CreateRadiusAttr(0.5)
with Usd.EditContext(stage, strong_layer):
omni.kit.commands.execute("CreatePrim", prim_type="Cone")
prim = stage.GetPrimAtPath(default_prim_path.AppendChild("Cone"))
cone = UsdGeom.Cone(prim)
with Usd.EditContext(stage, root_layer):
cone.CreateHeightAttr(0.7)
def everything_normal():
sphere = UsdGeom.Sphere(stage.GetPrimAtPath(default_prim_path.AppendChild("Sphere")))
cone = UsdGeom.Cone(stage.GetPrimAtPath(default_prim_path.AppendChild("Cone")))
self.assertTrue(
len(stage.GetRootLayer().subLayerPaths) == 3, "Three layers"
) # 3 sublayers of root plus root and session layer
self.assertTrue(sphere.GetRadiusAttr().Get() == 0.5)
layer_identifier = LayerUtils.get_sublayer_identifier(root_layer.identifier, 0)
stage.MuteLayer(layer_identifier) # mute the strongest layer
self.assertTrue(sphere.GetRadiusAttr().Get() == 1.234)
stage.UnmuteLayer(layer_identifier) # unmute the strongest layer
self.assertTrue(sphere.GetRadiusAttr().Get() == 0.5)
self.assertTrue(cone.GetHeightAttr().Get() == 0.7)
everything_normal()
omni.kit.commands.execute(
"MovePrimSpecsToLayer",
dst_layer_identifier=strong_layer.identifier,
src_layer_identifier=weak_layer.identifier,
prim_spec_path=default_prim_path.AppendChild("Sphere").pathString,
dst_stronger_than_src=True,
)
def check_1():
# check that Stage/Sphere is only in the strong layer with merged value
sphere = UsdGeom.Sphere(stage.GetPrimAtPath(default_prim_path.AppendChild("Sphere")))
self.assertEqual(sphere.GetRadiusAttr().Get(), 0.5)
layer_identifier = LayerUtils.get_sublayer_identifier(root_layer.identifier, 0)
stage.MuteLayer(layer_identifier) # mute the strongest layer
self.assertFalse(stage.GetPrimAtPath(default_prim_path.AppendChild("Sphere")))
stage.UnmuteLayer(layer_identifier) # unmute the strongest layer
check_1()
omni.kit.undo.undo()
everything_normal()
omni.kit.undo.redo()
check_1()
omni.kit.undo.undo()
everything_normal()
# Strong to weak
omni.kit.commands.execute(
"MovePrimSpecsToLayer",
dst_layer_identifier=weak_layer.identifier,
src_layer_identifier=strong_layer.identifier,
prim_spec_path=default_prim_path.AppendChild("Sphere").pathString,
dst_stronger_than_src=False,
)
def check_2():
# other layers [2, ROOT] should only contain stage. [0] should have cone and sphere
self.assertFalse(strong_layer.GetPrimAtPath(default_prim_path.AppendChild("Sphere")))
# Radius will be the strong one
sphere = UsdGeom.Sphere(stage.GetPrimAtPath(default_prim_path.AppendChild("Sphere")))
self.assertTrue(sphere.GetRadiusAttr().Get() == 0.5)
check_2()
omni.kit.undo.undo()
everything_normal()
omni.kit.undo.redo()
check_2()
omni.kit.undo.undo()
everything_normal()
async def test_flatten_layers(self):
# Note: FlattenLayers also uses MergeLayers and RemoveLayer
usd_context = omni.usd.get_context()
stage = usd_context.get_stage()
default_prim_path = get_stage_default_prim_path(stage)
root_layer = stage.GetRootLayer()
# When no layers are created, the total layers are 2 (root and session layer).
omni.kit.commands.execute("FlattenLayers")
self.assertTrue(len(root_layer.subLayerPaths) == 0)
omni.kit.undo.undo()
self.assertTrue(len(root_layer.subLayerPaths) == 0)
path = LayerUtils.create_sublayer(root_layer, 0, "").identifier # strong_layer
layer = Sdf.Layer.FindOrOpen(path)
self.assertTrue(layer, "layer is found before flatten")
omni.kit.commands.execute("FlattenLayers")
self.assertTrue(len(root_layer.subLayerPaths) == 0)
omni.kit.undo.undo()
self.assertTrue(len(root_layer.subLayerPaths) == 1)
self.assertTrue(Sdf.Find(path), "layer is found after undo")
LayerUtils.create_sublayer(root_layer, 1, "") # intermediate_layer
LayerUtils.create_sublayer(root_layer, 2, "") # weak_layer
self.assertTrue(len(root_layer.subLayerPaths) == 3)
strong_layer = Sdf.Find(root_layer.subLayerPaths[0])
intermediate_layer = Sdf.Find(root_layer.subLayerPaths[1])
weak_layer = Sdf.Find(root_layer.subLayerPaths[2])
self.assertTrue(strong_layer, "strong_layer")
self.assertTrue(intermediate_layer, "intermediate_layer")
self.assertTrue(weak_layer, "weak_layer")
with Usd.EditContext(stage, weak_layer):
omni.kit.commands.execute("CreatePrim", prim_type="Sphere")
prim = stage.GetPrimAtPath(default_prim_path.AppendChild("Sphere"))
self.assertTrue(prim, "Prim exists")
sphere = UsdGeom.Sphere(prim)
with Usd.EditContext(stage, intermediate_layer):
sphere.CreateRadiusAttr(0.987)
with Usd.EditContext(stage, strong_layer):
sphere.CreateRadiusAttr(1.234)
omni.kit.commands.execute("FlattenLayers")
self.assertTrue(len(root_layer.subLayerPaths) == 0)
prim = stage.GetPrimAtPath(default_prim_path.AppendChild("Sphere"))
self.assertTrue(prim)
sphere = UsdGeom.Sphere(prim)
self.assertTrue(sphere.GetRadiusAttr().Get() == 1.234)
omni.kit.undo.undo()
self.assertTrue(len(root_layer.subLayerPaths) == 3)
layer_identifier = LayerUtils.get_sublayer_identifier(root_layer.identifier, 0)
stage.MuteLayer(layer_identifier) # mute the strongest layer
prim = stage.GetPrimAtPath(default_prim_path.AppendChild("Sphere"))
self.assertTrue(prim)
sphere = UsdGeom.Sphere(prim)
self.assertTrue(sphere.GetRadiusAttr().Get() == 0.987)
# OM-77653: Test for making sure flattening will not retime timesamples.
await usd_context.new_stage_async()
layer = Sdf.Layer.CreateAnonymous()
layer_content = """#sdf 1.0
(
defaultPrim = "World"
endTimeCode = 100
metersPerUnit = 0.01
startTimeCode = 0
timeCodesPerSecond = 30
upAxis = "Y"
)
def Xform "World"
{
def Mesh "Cube_30"
{
float3[] extent = [(-50, -50, -50), (50, 50, 50)]
int[] faceVertexCounts = [4, 4, 4, 4, 4, 4]
int[] faceVertexIndices = [0, 1, 3, 2, 0, 4, 5, 1, 1, 5, 6, 3, 2, 3, 6, 7, 0, 2, 7, 4, 4, 7, 6, 5]
normal3f[] normals = [(0, -1, 0), (0, -1, 0), (0, -1, 0), (0, -1, 0), (0, 0, -1), (0, 0, -1), (0, 0, -1), (0, 0, -1), (1, 0, 0), (1, 0, 0), (1, 0, 0), (1, 0, 0), (0, 0, 1), (0, 0, 1), (0, 0, 1), (0, 0, 1), (-1, 0, 0), (-1, 0, 0), (-1, 0, 0), (-1, 0, 0), (0, 1, 0), (0, 1, 0), (0, 1, 0), (0, 1, 0)] (
interpolation = "faceVarying"
)
point3f[] points = [(-50, -50, -50), (50, -50, -50), (-50, -50, 50), (50, -50, 50), (-50, 50, -50), (50, 50, -50), (50, 50, 50), (-50, 50, 50)]
float2[] primvars:st = [(1, 0), (0, 0), (0, 1), (1, 1), (1, 0), (1, 1), (0, 1), (0, 0), (1, 0), (0, 0), (0, 1), (1, 1), (1, 0), (0, 0), (0, 1), (1, 1), (1, 0), (1, 1), (0, 1), (0, 0), (1, 0), (1, 1), (0, 1), (0, 0)] (
interpolation = "faceVarying"
)
uniform token subdivisionScheme = "none"
double3 xformOp:rotateXYZ = (0, 0, 0)
double3 xformOp:scale = (1, 1, 1)
double3 xformOp:translate = (0, 0, 0)
double3 xformOp:translate.timeSamples = {
0: (0, 0, 0),
100: (0, 100, 0),
}
uniform token[] xformOpOrder = ["xformOp:translate", "xformOp:rotateXYZ", "xformOp:scale"]
}
}
"""
layer.ImportFromString(layer_content)
stage = usd_context.get_stage()
stage.GetRootLayer().subLayerPaths.append(layer.identifier)
UsdUtils.CopyLayerMetadata(layer, stage.GetRootLayer(), True)
omni.kit.commands.execute("FlattenLayers")
expected_string = """#usda 1.0
(
defaultPrim = "World"
endTimeCode = 100
metersPerUnit = 0.01
startTimeCode = 0
timeCodesPerSecond = 30
upAxis = "Y"
)
def Xform "World"
{
def Mesh "Cube_30"
{
float3[] extent = [(-50, -50, -50), (50, 50, 50)]
int[] faceVertexCounts = [4, 4, 4, 4, 4, 4]
int[] faceVertexIndices = [0, 1, 3, 2, 0, 4, 5, 1, 1, 5, 6, 3, 2, 3, 6, 7, 0, 2, 7, 4, 4, 7, 6, 5]
normal3f[] normals = [(0, -1, 0), (0, -1, 0), (0, -1, 0), (0, -1, 0), (0, 0, -1), (0, 0, -1), (0, 0, -1), (0, 0, -1), (1, 0, 0), (1, 0, 0), (1, 0, 0), (1, 0, 0), (0, 0, 1), (0, 0, 1), (0, 0, 1), (0, 0, 1), (-1, 0, 0), (-1, 0, 0), (-1, 0, 0), (-1, 0, 0), (0, 1, 0), (0, 1, 0), (0, 1, 0), (0, 1, 0)] (
interpolation = "faceVarying"
)
point3f[] points = [(-50, -50, -50), (50, -50, -50), (-50, -50, 50), (50, -50, 50), (-50, 50, -50), (50, 50, -50), (50, 50, 50), (-50, 50, 50)]
float2[] primvars:st = [(1, 0), (0, 0), (0, 1), (1, 1), (1, 0), (1, 1), (0, 1), (0, 0), (1, 0), (0, 0), (0, 1), (1, 1), (1, 0), (0, 0), (0, 1), (1, 1), (1, 0), (1, 1), (0, 1), (0, 0), (1, 0), (1, 1), (0, 1), (0, 0)] (
interpolation = "faceVarying"
)
uniform token subdivisionScheme = "none"
double3 xformOp:rotateXYZ = (0, 0, 0)
double3 xformOp:scale = (1, 1, 1)
double3 xformOp:translate = (0, 0, 0)
double3 xformOp:translate.timeSamples = {
0: (0, 0, 0),
100: (0, 100, 0),
}
uniform token[] xformOpOrder = ["xformOp:translate", "xformOp:rotateXYZ", "xformOp:scale"]
}
}"""
self.assertEqual(stage.GetRootLayer().ExportToString().strip(), expected_string.strip())
async def test_merge_layers(self):
# Note: FlattenLayers also uses MergeLayers and RemoveLayer
usd_context = omni.usd.get_context()
stage = usd_context.get_stage()
default_prim_path = get_stage_default_prim_path(stage)
root_layer = stage.GetRootLayer()
path = LayerUtils.create_sublayer(root_layer, 0, "").identifier # strong_layer
self.assertTrue(Sdf.Find(path), "layer is found before merge")
LayerUtils.create_sublayer(root_layer, 1, "") # intermediate_layer
LayerUtils.create_sublayer(root_layer, 2, "") # weak_layer
self.assertTrue(len(root_layer.subLayerPaths) == 3)
strong_layer = Sdf.Find(root_layer.subLayerPaths[0])
intermediate_layer = Sdf.Find(root_layer.subLayerPaths[1])
weak_layer = Sdf.Find(root_layer.subLayerPaths[2])
self.assertTrue(strong_layer, "strong_layer")
self.assertTrue(intermediate_layer, "intermediate_layer")
self.assertTrue(weak_layer, "weak_layer")
with Usd.EditContext(stage, weak_layer):
omni.kit.commands.execute("CreatePrim", prim_type="Sphere")
prim = stage.GetPrimAtPath(default_prim_path.AppendChild("Sphere"))
self.assertTrue(prim, "Prim exists")
sphere = UsdGeom.Sphere(prim)
with Usd.EditContext(stage, intermediate_layer):
sphere.CreateRadiusAttr(0.987)
with Usd.EditContext(stage, strong_layer):
sphere.CreateRadiusAttr(1.234)
omni.kit.commands.execute(
"MergeLayers",
dst_parent_layer_identifier=root_layer.identifier,
dst_layer_identifier=strong_layer.identifier,
src_parent_layer_identifier=root_layer.identifier,
src_layer_identifier=intermediate_layer.identifier,
dst_stronger_than_src=True,
)
self.assertTrue(len(root_layer.subLayerPaths) == 2)
prim = stage.GetPrimAtPath(default_prim_path.AppendChild("Sphere"))
self.assertTrue(prim)
sphere = UsdGeom.Sphere(prim)
self.assertTrue(sphere.GetRadiusAttr().Get() == 1.234)
omni.kit.undo.undo()
self.assertTrue(len(root_layer.subLayerPaths) == 3)
layer_identifier = strong_layer.identifier
stage.MuteLayer(layer_identifier) # mute the strongest layer
prim = stage.GetPrimAtPath(default_prim_path.AppendChild("Sphere"))
self.assertTrue(prim)
sphere = UsdGeom.Sphere(prim)
self.assertTrue(sphere.GetRadiusAttr().Get() == 0.987)
stage.UnmuteLayer(layer_identifier)
# Assumes we want to overide strong layer's radius with intermediate one.
omni.kit.commands.execute(
"MergeLayers",
dst_parent_layer_identifier=root_layer.identifier,
dst_layer_identifier=strong_layer.identifier,
src_parent_layer_identifier=root_layer.identifier,
src_layer_identifier=intermediate_layer.identifier,
dst_stronger_than_src=False,
)
self.assertTrue(len(root_layer.subLayerPaths) == 2)
prim = stage.GetPrimAtPath(default_prim_path.AppendChild("Sphere"))
self.assertTrue(prim)
sphere = UsdGeom.Sphere(prim)
self.assertTrue(sphere.GetRadiusAttr().Get() == 0.987)
omni.kit.undo.undo()
prim = stage.GetPrimAtPath(default_prim_path.AppendChild("Sphere"))
self.assertTrue(prim)
sphere = UsdGeom.Sphere(prim)
self.assertTrue(sphere.GetRadiusAttr().Get() == 1.234)
layer_identifier = strong_layer.identifier
stage.MuteLayer(layer_identifier) # mute the strongest layer
prim = stage.GetPrimAtPath(default_prim_path.AppendChild("Sphere"))
self.assertTrue(prim)
sphere = UsdGeom.Sphere(prim)
self.assertTrue(sphere.GetRadiusAttr().Get() == 0.987)
stage.UnmuteLayer(layer_identifier)
async def test_remove_layer(self):
usd_context = omni.usd.get_context()
stage = usd_context.get_stage()
default_prim_path = get_stage_default_prim_path(stage)
root_layer = stage.GetRootLayer()
LayerUtils.create_sublayer(root_layer, 0, "")
LayerUtils.create_sublayer(root_layer, 1, "")
LayerUtils.create_sublayer(root_layer, 2, "")
layer = Sdf.Find(root_layer.subLayerPaths[2])
identifier = layer.identifier
sphere_path = default_prim_path.AppendChild("Sphere")
with Usd.EditContext(stage, layer):
omni.kit.commands.execute("CreatePrim", prim_type="Sphere")
with Usd.EditContext(stage, root_layer):
prim = stage.GetPrimAtPath(sphere_path)
sphere = UsdGeom.Sphere(prim)
sphere.CreateRadiusAttr(1.234)
def check_exists():
self.assertTrue(len(root_layer.subLayerPaths) == 3, "There are the correct number of sublayers")
self.assertTrue(stage.GetPrimAtPath(sphere_path), "The prim exists")
sphere = UsdGeom.Sphere(stage.GetPrimAtPath(sphere_path))
radius = sphere.GetRadiusAttr().Get()
self.assertTrue(radius == 1.234, "The sphere has the correct attr")
layer = Sdf.Find(root_layer.subLayerPaths[2])
self.assertTrue(identifier == layer.identifier, "{} should equal {}".format(identifier, layer.identifier))
def check_does_not_exist():
self.assertTrue(len(root_layer.subLayerPaths) == 2, "The layer was removed")
prim = stage.GetPrimAtPath(sphere_path)
self.assertFalse(prim.IsDefined(), "Prim is not removed")
check_exists()
omni.kit.commands.execute("RemoveSublayer", layer_identifier=root_layer.identifier, sublayer_position=2)
check_does_not_exist()
omni.kit.undo.undo()
check_exists()
async def test_move_layer(self):
usd_context = omni.usd.get_context()
stage = usd_context.get_stage()
root_layer = stage.GetRootLayer()
identifier1 = LayerUtils.create_sublayer(root_layer, 0, "").identifier
identifier2 = LayerUtils.create_sublayer(root_layer, 1, "").identifier
identifier3 = LayerUtils.create_sublayer(root_layer, 2, "").identifier
def check_layers(layers_info):
self.assertTrue(len(layers_info) == len(root_layer.subLayerPaths), "number of layers")
for layer_info in layers_info:
index, identifier = layer_info
layer_identifier = LayerUtils.get_sublayer_identifier(root_layer.identifier, index)
self.assertTrue(identifier == layer_identifier, "layer identifier")
layer = Sdf.Find(layer_identifier)
self.assertTrue(layer is not None, "layer is found")
check_layers([(0, identifier1), (1, identifier2), (2, identifier3)])
omni.kit.commands.execute(
"MoveSublayer",
from_parent_layer_identifier=root_layer.identifier,
from_sublayer_position=2,
to_parent_layer_identifier=root_layer.identifier,
to_sublayer_position=0,
remove_source=True,
)
check_layers([(0, identifier3), (1, identifier1), (2, identifier2)])
omni.kit.undo.undo()
check_layers([(0, identifier1), (1, identifier2), (2, identifier3)])
# Move invalid layer will fail to execute
omni.kit.commands.execute(
"MoveSublayer",
from_parent_layer_identifier=root_layer.identifier,
from_sublayer_position=-100,
to_parent_layer_identifier=root_layer.identifier,
to_sublayer_position=0,
remove_source=True,
)
check_layers([(0, identifier1), (1, identifier2), (2, identifier3)])
# Move layer outside of layer stack will fail to execute
omni.kit.commands.execute(
"MoveSublayer",
from_parent_layer_identifier=root_layer.identifier,
from_sublayer_position=100,
to_parent_layer_identifier=root_layer.identifier,
to_sublayer_position=0,
remove_source=True,
)
check_layers([(0, identifier1), (1, identifier2), (2, identifier3)])
# Move layer to position that passes the end of layer stack will move this layer to the end of the stack
omni.kit.commands.execute(
"MoveSublayer",
from_parent_layer_identifier=root_layer.identifier,
from_sublayer_position=0,
to_parent_layer_identifier=root_layer.identifier,
to_sublayer_position=100,
remove_source=True,
)
check_layers([(0, identifier2), (1, identifier3), (2, identifier1)])
omni.kit.undo.undo()
check_layers([(0, identifier1), (1, identifier2), (2, identifier3)])
# Move layer to position before the last layer
omni.kit.commands.execute(
"MoveSublayer",
from_parent_layer_identifier=root_layer.identifier,
from_sublayer_position=0,
to_parent_layer_identifier=root_layer.identifier,
to_sublayer_position=-1,
remove_source=True,
)
check_layers([(0, identifier2), (1, identifier3), (2, identifier1)])
omni.kit.undo.undo()
check_layers([(0, identifier1), (1, identifier2), (2, identifier3)])
async def test_select_layer(self):
usd_context = omni.usd.get_context()
stage = usd_context.get_stage()
root_layer = stage.GetRootLayer()
identifier1 = LayerUtils.create_sublayer(root_layer, 0, "").identifier
identifier2 = LayerUtils.create_sublayer(root_layer, 1, "").identifier
identifier3 = LayerUtils.create_sublayer(root_layer, 2, "").identifier
LayerUtils.set_edit_target(stage, identifier3)
edit_target = stage.GetEditTarget()
current_selected_layer = edit_target.GetLayer().identifier
self.assertTrue(current_selected_layer == identifier3) # root layer
omni.kit.commands.execute("SetEditTarget", layer_identifier=identifier1)
edit_target = stage.GetEditTarget()
current_selected_layer = edit_target.GetLayer().identifier
self.assertTrue(current_selected_layer == identifier1)
omni.kit.undo.undo()
edit_target = stage.GetEditTarget()
current_selected_layer = edit_target.GetLayer().identifier
self.assertTrue(current_selected_layer == identifier3)
# Select invalid layer will keep the current edit target not changed.
omni.kit.commands.execute("SetEditTarget", layer_identifier="")
edit_target = stage.GetEditTarget()
current_selected_layer = edit_target.GetLayer().identifier
self.assertTrue(current_selected_layer == identifier3)
omni.kit.undo.undo()
omni.kit.commands.execute("SetEditTarget", layer_identifier=identifier2)
edit_target = stage.GetEditTarget()
current_selected_layer = edit_target.GetLayer().identifier
self.assertTrue(current_selected_layer == identifier2)
omni.kit.undo.undo()
edit_target = stage.GetEditTarget()
current_selected_layer = edit_target.GetLayer().identifier
self.assertTrue(current_selected_layer == identifier3)
async def test_layer_lock(self):
usd_context = omni.usd.get_context()
stage = usd_context.get_stage()
root_layer = stage.GetRootLayer()
sublayer = LayerUtils.create_sublayer(root_layer, 0, "")
omni.kit.commands.execute("LockLayer", layer_identifier=root_layer.identifier, locked=True)
self.assertFalse(LayerUtils.get_layer_lock_status(root_layer, root_layer.identifier))
LayerUtils.set_edit_target(stage, sublayer.identifier)
self.assertEqual(LayerUtils.get_edit_target(stage), sublayer.identifier)
omni.kit.commands.execute("LockLayer", layer_identifier=sublayer.identifier, locked=True)
self.assertEqual(LayerUtils.get_edit_target(stage), root_layer.identifier)
self.assertTrue(LayerUtils.get_layer_lock_status(root_layer, sublayer.identifier))
omni.kit.undo.undo()
self.assertEqual(LayerUtils.get_edit_target(stage), sublayer.identifier)
self.assertFalse(LayerUtils.get_layer_lock_status(root_layer, sublayer.identifier))
async def test_unmute_layer(self):
usd_context = omni.usd.get_context()
stage = usd_context.get_stage()
root_layer = stage.GetRootLayer()
layer3 = LayerUtils.create_sublayer(root_layer, 2, "")
identifier3 = layer3.identifier
LayerUtils.set_edit_target(stage, identifier3)
current_selected_layer = LayerUtils.get_edit_target(stage)
self.assertTrue(current_selected_layer == identifier3)
# mute root layer will do nothing
omni.kit.commands.execute("SetLayerMuteness", layer_identifier=root_layer.identifier, muted=True)
current_selected_layer = LayerUtils.get_edit_target(stage)
self.assertEqual(current_selected_layer, identifier3)
# mute invalid layer will do nothing
omni.kit.commands.execute("SetLayerMuteness", layer_identifier="", muted=True)
current_selected_layer = LayerUtils.get_edit_target(stage)
self.assertEqual(current_selected_layer, identifier3)
# mute layer 2
omni.kit.commands.execute("SetLayerMuteness", layer_identifier=identifier3, muted=True)
self.assertTrue(stage.IsLayerMuted(identifier3))
current_selected_layer = LayerUtils.get_edit_target(stage)
self.assertNotEqual(current_selected_layer, identifier3)
omni.kit.undo.undo()
current_selected_layer = LayerUtils.get_edit_target(stage)
self.assertEqual(current_selected_layer, identifier3)
self.assertTrue(not stage.IsLayerMuted(identifier3))
# mute, then unmute
omni.kit.commands.execute("SetLayerMuteness", layer_identifier=identifier3, muted=True)
omni.kit.commands.execute("SetLayerMuteness", layer_identifier=identifier3, muted=False)
self.assertTrue(not stage.IsLayerMuted(identifier3))
omni.kit.undo.undo()
self.assertTrue(stage.IsLayerMuted(identifier3))
omni.kit.undo.undo()
self.assertTrue(not stage.IsLayerMuted(identifier3))
async def test_stitch_prim_specss_command(self):
# move nodes also uses merge nodes and remove nodes
usd_context = omni.usd.get_context()
stage = usd_context.get_stage()
default_prim_path = get_stage_default_prim_path(stage)
root_layer = stage.GetRootLayer()
# create anonymous layers
strong_layer = LayerUtils.create_sublayer(root_layer, 0, "")
intermediate_layer = LayerUtils.create_sublayer(root_layer, 1, "")
weak_layer = LayerUtils.create_sublayer(root_layer, 2, "")
# add some content
# root: stage/cone* height=0.7
# strong: stage/sphere* radius=0.5, stage/cone
# intermediate: empty
# weak: stage/sphere radius=1.234
with Usd.EditContext(stage, weak_layer):
omni.kit.commands.execute("CreatePrimCommand", prim_type="Sphere")
prim = stage.GetPrimAtPath(default_prim_path.AppendChild("Sphere"))
sphere = UsdGeom.Sphere(prim)
with Usd.EditContext(stage, weak_layer):
sphere.CreateRadiusAttr(1.234)
with Usd.EditContext(stage, strong_layer):
sphere.CreateRadiusAttr(0.5)
with Usd.EditContext(stage, strong_layer):
omni.kit.commands.execute("CreatePrimCommand", prim_type="Cone")
prim = stage.GetPrimAtPath(default_prim_path.AppendChild("Cone"))
cone = UsdGeom.Cone(prim)
with Usd.EditContext(stage, root_layer):
cone.CreateHeightAttr(0.7)
def everything_normal():
sphere = UsdGeom.Sphere(stage.GetPrimAtPath(default_prim_path.AppendChild("Sphere")))
cone = UsdGeom.Cone(stage.GetPrimAtPath(default_prim_path.AppendChild("Cone")))
self.assertTrue(
len(stage.GetRootLayer().subLayerPaths) == 3, "Three layers"
) # 3 sublayers of root plus root and session layer
self.assertTrue(sphere.GetRadiusAttr().Get() == 0.5)
layer_identifier = LayerUtils.get_sublayer_identifier(root_layer.identifier, 0)
stage.MuteLayer(layer_identifier) # mute the strongest layer
self.assertTrue(sphere.GetRadiusAttr().Get() == 1.234)
stage.UnmuteLayer(layer_identifier) # unmute the strongest layer
self.assertTrue(sphere.GetRadiusAttr().Get() == 0.5)
self.assertTrue(cone.GetHeightAttr().Get() == 0.7)
everything_normal()
omni.kit.commands.execute(
"StitchPrimSpecsToLayer",
prim_paths=[default_prim_path.AppendChild("Sphere").pathString],
target_layer_identifier=strong_layer.identifier,
)
def check_1():
# check that Stage/Sphere is only in the strong layer with merged value
sphere = UsdGeom.Sphere(stage.GetPrimAtPath(default_prim_path.AppendChild("Sphere")))
self.assertEqual(sphere.GetRadiusAttr().Get(), 0.5)
check_1()
omni.kit.undo.undo()
everything_normal()
omni.kit.undo.redo()
check_1()
omni.kit.undo.undo()
everything_normal()
# Strong to weak
omni.kit.commands.execute(
"StitchPrimSpecsToLayer",
prim_paths=[default_prim_path.AppendChild("Sphere").pathString],
target_layer_identifier=weak_layer.identifier,
)
check_1()
omni.kit.undo.undo()
everything_normal()
omni.kit.undo.redo()
check_1()
omni.kit.undo.undo()
everything_normal()
async def test_layer_removal_with_stage_update(self):
usd_context = omni.usd.get_context()
stage = usd_context.get_stage()
root_layer = stage.GetRootLayer()
# insert a subLayer with material.usda which contains just one material prim
omni.kit.commands.execute(
"CreateSublayer",
layer_identifier=root_layer.identifier,
sublayer_position=0,
new_layer_path=FILE_PATH_OmniPBR,
transfer_root_content=False,
create_or_insert=False,
)
await omni.kit.app.get_app().next_update_async()
# check the material prim is defined in the stage
material_prim = stage.GetPrimAtPath("/World/Looks/OmniPBR")
self.assertTrue(material_prim.IsDefined())
# remove the subLayer
omni.kit.commands.execute("RemoveSublayer", layer_identifier=root_layer.identifier, sublayer_position=0)
await omni.kit.app.get_app().next_update_async()
# check the material prim is not there anymore
material_prim = stage.GetPrimAtPath("/World/Looks/OmniPBR")
self.assertFalse(material_prim.IsValid())
# check the parent folder scope is removed too
scope_prim = stage.GetPrimAtPath("/World/Looks")
self.assertFalse(scope_prim.IsValid())
# insert the subLayer again
omni.kit.commands.execute(
"CreateSublayer",
layer_identifier=root_layer.identifier,
sublayer_position=0,
new_layer_path=FILE_PATH_OmniPBR,
transfer_root_content=False,
create_or_insert=False,
)
await omni.kit.app.get_app().next_update_async()
# check both material prims are defined in the stage
material_prim = stage.GetPrimAtPath("/World/Looks/OmniPBR")
self.assertTrue(material_prim.IsDefined())
# insert another subLayer
omni.kit.commands.execute(
"CreateSublayer",
layer_identifier=root_layer.identifier,
sublayer_position=1,
new_layer_path=FILE_PATH_OmniGlass,
transfer_root_content=False,
create_or_insert=False,
)
await omni.kit.app.get_app().next_update_async()
# check both material prims are defined in the stage
material_prim = stage.GetPrimAtPath("/World/Looks/OmniGlass")
self.assertTrue(material_prim.IsDefined())
# remove the first subLayer
omni.kit.commands.execute("RemoveSublayer", layer_identifier=root_layer.identifier, sublayer_position=0)
await omni.kit.app.get_app().next_update_async()
# check the material prim is not there anymore
material_prim = stage.GetPrimAtPath("/World/Looks/OmniPBR")
self.assertFalse(material_prim.IsValid())
# check the second sublayer is still there
scope_prim = stage.GetPrimAtPath("/World/Looks")
self.assertTrue(scope_prim.IsValid())
material_prim = stage.GetPrimAtPath("/World/Looks/OmniGlass")
self.assertTrue(material_prim.IsDefined())
def __get_all_property_paths(self, prim):
paths = []
for p in prim.GetProperties():
paths.append(str(p.GetPath()))
return paths
def __get_all_prim_childrens(self, prim, hierarchy=False):
paths = [str(prim.GetPath())]
paths.extend(self.__get_all_property_paths(prim))
if hierarchy:
for child in prim.GetAllPrimChildren():
paths.append(str(child.GetPath()))
paths.extend(self.__get_all_property_paths(child))
return paths
def __get_all_stage_paths(self, stage):
paths = []
for prim in stage.TraverseAll():
paths.extend(self.__get_all_prim_childrens(prim))
return paths
async def test_link_specs_command(self):
layers = get_layers()
specs_linking = layers.get_specs_linking()
context = omni.usd.get_context()
layers.set_edit_mode(LayerEditMode.SPECS_LINKING)
stage = context.get_stage()
root_layer = stage.GetRootLayer()
layer0 = Sdf.Layer.CreateAnonymous()
layer1 = Sdf.Layer.CreateAnonymous()
layer2 = Sdf.Layer.CreateAnonymous()
root_layer.subLayerPaths.append(layer0.identifier)
root_layer.subLayerPaths.append(layer1.identifier)
root_layer.subLayerPaths.append(layer2.identifier)
asset_name = f"/root/test0/l1/l2/l3"
asset_prim = stage.DefinePrim(asset_name, "Xform")
all_spec_paths = set(self.__get_all_stage_paths(stage))
await omni.kit.app.get_app().next_update_async()
specs_linking.link_spec("/root/test0", layer0.identifier, hierarchy=True)
old_links = specs_linking.get_all_spec_links()
for path in ["/", "/root", "/root/test0", "/root/test0/l1/l2/l3"]:
for hierarchy in [False, True]:
for additive in [False, True]:
omni.kit.commands.execute(
"LinkSpecs",
spec_paths=path,
layer_identifiers=layer1.identifier,
additive=additive,
hierarchy=hierarchy,
)
if path.startswith("/root/test0"):
base_path = path
else:
base_path = "/root/test0"
# Make sure it's linked successfully
links = specs_linking.get_all_spec_links()
for spec_path, layers in links.items():
if hierarchy:
if spec_path.startswith(base_path):
if not additive:
self.assertEqual(set(layers), set([layer1.identifier]))
else:
self.assertEqual(set(layers), set([layer0.identifier, layer1.identifier]))
else:
if spec_path.startswith("/root/test0"):
self.assertEqual(set(layers), set([layer0.identifier]))
else:
self.assertEqual(set(layers), set([layer1.identifier]))
else:
sdf_path = Sdf.Path(spec_path)
if str(sdf_path.GetPrimPath()) == path:
if spec_path.startswith(base_path):
if not additive:
self.assertEqual(set(layers), set([layer1.identifier]))
else:
self.assertEqual(set(layers), set([layer0.identifier, layer1.identifier]))
else:
if spec_path.startswith("/root/test0"):
self.assertEqual(set(layers), set([layer0.identifier]))
else:
self.assertEqual(set(layers), set([layer1.identifier]))
else:
self.assertEqual(set(layers), set([layer0.identifier]))
omni.kit.undo.undo()
# Make sure it's returned to old states.
new_links = specs_linking.get_all_spec_links()
self.__compare_links_map(old_links, new_links)
def __compare_links_map(self, old_links, new_links):
for path, layers in old_links.items():
self.assertTrue(path in new_links, f"Spec {path} is not existed in new links.")
new_layers = new_links.get(path)
self.assertEqual(set(layers), set(new_layers), f"Links spec {path} are different.")
async def test_unlink_specs_command(self):
layers = get_layers()
specs_linking = layers.get_specs_linking()
context = omni.usd.get_context()
layers.set_edit_mode(LayerEditMode.SPECS_LINKING)
stage = context.get_stage()
root_layer = stage.GetRootLayer()
layer0 = Sdf.Layer.CreateAnonymous()
layer1 = Sdf.Layer.CreateAnonymous()
layer2 = Sdf.Layer.CreateAnonymous()
root_layer.subLayerPaths.append(layer0.identifier)
root_layer.subLayerPaths.append(layer1.identifier)
root_layer.subLayerPaths.append(layer2.identifier)
asset_name = f"/root/test0/l1/l2/l3"
asset_prim = stage.DefinePrim(asset_name, "Xform")
all_spec_paths = set(self.__get_all_stage_paths(stage))
await omni.kit.app.get_app().next_update_async()
for layer_identifier in [layer0.identifier, layer1.identifier]:
specs_linking.link_spec("/root/test0", layer_identifier, hierarchy=True)
old_links = specs_linking.get_all_spec_links()
for path in ["/", "/root", "/root/test0", "/root/test0/l1/l2/l3"]:
for hierarchy in [False, True]:
omni.kit.commands.execute(
"UnlinkSpecs", spec_paths=path, layer_identifiers=layer1.identifier, hierarchy=hierarchy
)
if path.startswith("/root/test0"):
base_path = path
else:
base_path = "/root/test0"
# Make sure it's unlinked successfully
links = specs_linking.get_all_spec_links()
for spec_path, layers in links.items():
if hierarchy:
if spec_path.startswith(base_path):
self.assertEqual(set(layers), set([layer0.identifier]))
else:
self.assertEqual(set(layers), set([layer0.identifier, layer1.identifier]))
else:
sdf_path = Sdf.Path(spec_path)
if str(sdf_path.GetPrimPath()) == path and spec_path.startswith(base_path):
self.assertEqual(set(layers), set([layer0.identifier]))
else:
self.assertEqual(set(layers), set([layer0.identifier, layer1.identifier]))
omni.kit.undo.undo()
# Make sure it's returned to old states.
new_links = specs_linking.get_all_spec_links()
self.__compare_links_map(old_links, new_links)
async def test_lock_specs_command(self):
layers = get_layers()
specs_locking = layers.get_specs_locking()
context = omni.usd.get_context()
stage = context.get_stage()
root_layer = stage.GetRootLayer()
layer0 = Sdf.Layer.CreateAnonymous()
layer1 = Sdf.Layer.CreateAnonymous()
layer2 = Sdf.Layer.CreateAnonymous()
root_layer.subLayerPaths.append(layer0.identifier)
root_layer.subLayerPaths.append(layer1.identifier)
root_layer.subLayerPaths.append(layer2.identifier)
asset_name = f"/root/test0/l1/l2/l3"
asset_prim = stage.DefinePrim(asset_name, "Xform")
await omni.kit.app.get_app().next_update_async()
specs_locking.lock_spec("/root", hierarchy=False)
old_locks = specs_locking.get_all_locked_specs()
for path in ["/", "/root", "/root/test0", "/root/test0/l1/l2/l3"]:
for hierarchy in [False, True]:
omni.kit.commands.execute("LockSpecs", spec_paths=path, hierarchy=hierarchy)
omni.kit.undo.undo()
# Make sure it's returned to old states.
new_locks = specs_locking.get_all_locked_specs()
self.assertEqual(set(old_locks), set(new_locks))
async def test_unlock_specs_command(self):
layers = get_layers()
specs_locking = layers.get_specs_locking()
context = omni.usd.get_context()
stage = context.get_stage()
root_layer = stage.GetRootLayer()
layer0 = Sdf.Layer.CreateAnonymous()
layer1 = Sdf.Layer.CreateAnonymous()
layer2 = Sdf.Layer.CreateAnonymous()
root_layer.subLayerPaths.append(layer0.identifier)
root_layer.subLayerPaths.append(layer1.identifier)
root_layer.subLayerPaths.append(layer2.identifier)
asset_name = f"/root/test0/l1/l2/l3"
asset_prim = stage.DefinePrim(asset_name, "Xform")
await omni.kit.app.get_app().next_update_async()
specs_locking.lock_spec("/root", hierarchy=True)
old_locks = omni.kit.usd.layers.get_all_locked_specs(context)
for path in ["/", "/root", "/root/test0", "/root/test0/l1/l2/l3"]:
for hierarchy in [False, True]:
omni.kit.commands.execute("UnlockSpecs", spec_paths=path, hierarchy=hierarchy)
# Make sure it's locked successfully
locks = specs_locking.get_all_locked_specs()
for spec_path in locks:
if hierarchy:
self.assertFalse(spec_path.startswith(path))
else:
sdf_path = Sdf.Path(spec_path)
self.assertNotEqual(str(sdf_path.GetPrimPath()), path)
omni.kit.undo.undo()
new_locks = specs_locking.get_all_locked_specs()
self.assertEqual(set(old_locks), set(new_locks))
| 51,036 | Python | 44.937894 | 307 | 0.603809 |
omniverse-code/kit/exts/omni.kit.usd.layers/omni/kit/usd/layers/tests/test_layers_state.py | import asyncio
import carb
import os
import tempfile
import omni.kit.test
import omni.usd
import omni.client
import unittest
from stat import S_IREAD, S_IWRITE
from pxr import Sdf, Usd, UsdGeom, Gf
from .test_base import enable_server_tests
from omni.kit.usd.layers import get_layers, LayerUtils, get_layer_event_payload, LayerEventType
class TestLayersState(omni.kit.test.AsyncTestCase):
# Before running each test
async def setUp(self):
self.usd_context = omni.usd.get_context()
await omni.usd.get_context().new_stage_async()
async def tearDown(self):
if omni.usd.get_context().get_stage():
await omni.usd.get_context().close_stage_async()
async def test_layers_state_muteness_interfaces(self):
layers = get_layers()
layers_state = layers.get_layers_state()
stage = omni.usd.get_context().get_stage()
layer0 = Sdf.Layer.CreateAnonymous()
layer1 = Sdf.Layer.CreateAnonymous()
layer2 = Sdf.Layer.CreateAnonymous()
stage.GetRootLayer().subLayerPaths.append(layer0.identifier)
stage.GetRootLayer().subLayerPaths.append(layer1.identifier)
stage.GetRootLayer().subLayerPaths.append(layer2.identifier)
self.assertFalse(layers_state.is_muteness_global())
stage.MuteLayer(layer0.identifier)
await omni.kit.app.get_app().next_update_async()
self.assertTrue(layers_state.is_layer_locally_muted(layer0.identifier))
self.assertFalse(layers_state.is_layer_globally_muted(layer0.identifier))
self.assertFalse(layers_state.is_layer_locally_muted(layer1.identifier))
self.assertFalse(layers_state.is_layer_locally_muted(layer2.identifier))
stage.UnmuteLayer(layer0.identifier)
await omni.kit.app.get_app().next_update_async()
self.assertFalse(layers_state.is_layer_locally_muted(layer0.identifier))
# Mute layers before muteness scope switches.
stage.MuteLayer(layer0.identifier)
await omni.kit.app.get_app().next_update_async()
self.assertTrue(layers_state.is_layer_locally_muted(layer0.identifier))
layers_state.set_muteness_scope(True)
self.assertTrue(layers_state.is_muteness_global())
self.assertTrue(layers_state.is_layer_locally_muted(layer0.identifier))
self.assertFalse(layers_state.is_layer_globally_muted(layer0.identifier))
# Layer is not muted since it's muted in local mode.
self.assertFalse(stage.IsLayerMuted(layer0.identifier))
stage.MuteLayer(layer0.identifier)
await omni.kit.app.get_app().next_update_async()
# Local muteness flag is still true.
self.assertTrue(layers_state.is_layer_locally_muted(layer0.identifier))
self.assertTrue(layers_state.is_layer_globally_muted(layer0.identifier))
self.assertTrue(stage.IsLayerMuted(layer0.identifier))
stage.UnmuteLayer(layer0.identifier)
await omni.kit.app.get_app().next_update_async()
self.assertFalse(layers_state.is_layer_globally_muted(layer0.identifier))
self.assertFalse(stage.IsLayerMuted(layer0.identifier))
# Swiches back to local scope again.
layers_state.set_muteness_scope(False)
self.assertTrue(layers_state.is_layer_locally_muted(layer0.identifier))
self.assertFalse(layers_state.is_layer_globally_muted(layer0.identifier))
self.assertTrue(stage.IsLayerMuted(layer0.identifier))
# Pass None for identifier will not cause any issues
self.assertFalse(layers_state.is_layer_locally_muted(None))
async def test_live_update_muteness(self):
# The test is not to do real live update, but tries to simulate live update
# by changing the custom data of muteness directly.
layers = get_layers()
layers_state = layers.get_layers_state()
layers_state.set_muteness_scope(False)
stage = omni.usd.get_context().get_stage()
layer0 = Sdf.Layer.CreateAnonymous()
stage.GetRootLayer().subLayerPaths.append(layer0.identifier)
LayerUtils.set_layer_global_muteness(stage.GetRootLayer(), layer0.identifier, True)
await omni.kit.app.get_app().next_update_async()
self.assertTrue(layers_state.is_layer_globally_muted(layer0.identifier))
self.assertFalse(stage.IsLayerMuted(layer0.identifier))
layers_state.set_muteness_scope(True)
await omni.kit.app.get_app().next_update_async()
self.assertTrue(layers_state.is_layer_globally_muted(layer0.identifier))
self.assertTrue(stage.IsLayerMuted(layer0.identifier))
async def test_permissions_query_interface(self):
layers = get_layers()
layers_state = layers.get_layers_state()
with tempfile.TemporaryDirectory() as tempdir:
file = os.path.join(tempdir, "test.usd")
layer = Sdf.Layer.CreateNew(file)
layer.Save()
layer = None
os.chmod(file, S_IREAD)
await omni.usd.get_context().open_stage_async(file)
is_writable = layers_state.is_layer_writable(file)
is_read_only_on_disk = layers_state.is_layer_readonly_on_disk(file)
is_savable = layers_state.is_layer_savable(file)
await omni.usd.get_context().new_stage_async()
os.chmod(file, S_IWRITE)
self.assertFalse(is_writable)
self.assertTrue(is_read_only_on_disk)
self.assertFalse(is_savable)
self.assertFalse(layers_state.is_layer_locked(file))
stage = omni.usd.get_context().get_stage()
root_layer = stage.GetRootLayer()
LayerUtils.set_layer_lock_status(root_layer, root_layer.identifier, True)
# Root layer cannot be locked
self.assertTrue(layers_state.is_layer_writable(root_layer.identifier))
# Anonymous layer cannot be saved.
self.assertFalse(layers_state.is_layer_savable(root_layer.identifier))
self.assertFalse(layers_state.is_layer_locked(file))
with tempfile.TemporaryDirectory() as tempdir:
file = os.path.join(tempdir, "test.usd")
layer = Sdf.Layer.CreateNew(file)
root_layer.subLayerPaths.append(file)
LayerUtils.set_layer_lock_status(root_layer, file, True)
# Locked layer cannot be writable or savable.
self.assertFalse(layers_state.is_layer_writable(file))
# Even it's locked, it's still not readonly on disk.
self.assertFalse(layers_state.is_layer_readonly_on_disk(file))
self.assertFalse(layers_state.is_layer_savable(file))
self.assertTrue(layers_state.is_layer_locked(file))
# Close stage to release temp file
layer = None
stage = None
root_layer = None
await omni.usd.get_context().close_stage_async()
async def test_set_get_layer_names(self):
layers = get_layers()
layers_state = layers.get_layers_state()
stage = omni.usd.get_context().get_stage()
root_layer = stage.GetRootLayer()
session_layer = stage.GetSessionLayer()
self.assertEqual(layers_state.get_layer_name(root_layer.identifier), "Root Layer")
self.assertEqual(layers_state.get_layer_name(session_layer.identifier), "Session Layer")
sublayer = Sdf.Layer.CreateAnonymous()
root_layer.subLayerPaths.append(sublayer.identifier)
layers_state.set_layer_name(sublayer.identifier, "test")
self.assertEqual(layers_state.get_layer_name(sublayer.identifier), "test")
self.assertEqual("abc.usd", layers_state.get_layer_name("c:/a/b/abc.usd"))
self.assertEqual("abc.usda", layers_state.get_layer_name("c:/a/b/abc.usda"))
self.assertEqual("abc.usda", layers_state.get_layer_name("omniverse://ov-invalid-fake-server/a/b/abc.usda"))
layer = Sdf.Layer.CreateAnonymous()
self.assertEqual(layer.identifier, layers_state.get_layer_name(layer.identifier))
self.assertEqual("", layers_state.get_layer_name(""))
self.assertEqual(
"a b c.usda", layers_state.get_layer_name("omniverse://ov-invalid-fake-server/a/b/a%20b%20c.usda")
)
@unittest.skipIf(not enable_server_tests(), "")
async def test_layer_refresh(self):
layers = get_layers()
layers_state = layers.get_layers_state()
stage = omni.usd.get_context().get_stage()
file = "omniverse://localhost/Projects/tests/omni.kit.usd.layers/test_layer_refresh/test.usd"
layer = Sdf.Layer.FindOrOpen(file)
if not layer:
layer = Sdf.Layer.CreateNew(file)
layer.Save()
stage.GetRootLayer().subLayerPaths.append(layer.identifier)
self.assertFalse(layers_state.is_layer_outdated(layer.identifier))
custom_data = layer.customLayerData
custom_data['test'] = 1
layer.customLayerData = custom_data
layer.Save()
for i in range(100):
await omni.kit.app.get_app().next_update_async()
self.assertFalse(layers_state.is_layer_outdated(layer.identifier))
layer.Reload()
self.assertFalse(layers_state.is_layer_outdated(layer.identifier))
custom_data = layer.customLayerData
custom_data['test'] = 1
layer.customLayerData = custom_data
# Saves with customized interface will update latest state
layer.Save()
for i in range(100):
await omni.kit.app.get_app().next_update_async()
self.assertFalse(layers_state.is_layer_outdated(layer.identifier))
async def test_layer_edit_target_changed(self):
# Test layer edit target change if it's muted/locked/removed.
layers = get_layers()
layers_state = layers.get_layers_state()
stage = omni.usd.get_context().get_stage()
sublayer0 = Sdf.Layer.CreateAnonymous()
root_layer = stage.GetRootLayer()
LayerUtils.insert_sublayer(root_layer, 0, sublayer0.identifier, False)
# Mute/lock/remove current edit target will change its edit target to root layer.
LayerUtils.set_edit_target(stage, sublayer0.identifier)
self.assertEqual(sublayer0.identifier, LayerUtils.get_edit_target(stage))
stage.MuteLayer(sublayer0.identifier)
await omni.kit.app.get_app().next_update_async()
self.assertEqual(root_layer.identifier, LayerUtils.get_edit_target(stage))
stage.UnmuteLayer(sublayer0.identifier)
LayerUtils.set_edit_target(stage, sublayer0.identifier)
self.assertEqual(sublayer0.identifier, LayerUtils.get_edit_target(stage))
layers_state.set_layer_lock_state(sublayer0.identifier, True)
self.assertEqual(root_layer.identifier, LayerUtils.get_edit_target(stage))
layers_state.set_layer_lock_state(sublayer0.identifier, False)
LayerUtils.set_edit_target(stage, sublayer0.identifier)
self.assertEqual(sublayer0.identifier, LayerUtils.get_edit_target(stage))
LayerUtils.remove_sublayer(root_layer, 0)
self.assertEqual(root_layer.identifier, LayerUtils.get_edit_target(stage))
async def test_layer_muteness_events(self):
layers = get_layers()
layers_state = layers.get_layers_state()
event_stream = layers.get_event_stream()
payload = None
def _on_layer_event(event: carb.events.IEvent):
nonlocal payload
payload = get_layer_event_payload(event)
subscription = event_stream.create_subscription_to_pop(_on_layer_event, name="layer events")
layers_state = layers.get_layers_state()
layers_state.set_muteness_scope(True)
self.assertIsNotNone(payload)
self.assertEqual(payload.event_type, LayerEventType.MUTENESS_SCOPE_CHANGED)
stage = omni.usd.get_context().get_stage()
sublayer0 = Sdf.Layer.CreateAnonymous()
sublayer1 = Sdf.Layer.CreateAnonymous()
root_layer = stage.GetRootLayer()
LayerUtils.insert_sublayer(root_layer, 0, sublayer0.identifier, False)
LayerUtils.insert_sublayer(root_layer, 1, sublayer1.identifier, False)
await omni.kit.app.get_app().next_update_async()
stage.MuteAndUnmuteLayers([sublayer0.identifier, sublayer1.identifier], [])
await omni.kit.app.get_app().next_update_async()
await omni.kit.app.get_app().next_update_async()
self.assertIsNotNone(payload)
self.assertEqual(payload.event_type, LayerEventType.MUTENESS_STATE_CHANGED)
self.assertEqual(set(payload.identifiers_or_spec_paths), set([sublayer0.identifier, sublayer1.identifier]))
stage.UnmuteLayer(sublayer1.identifier)
await omni.kit.app.get_app().next_update_async()
await omni.kit.app.get_app().next_update_async()
self.assertIsNotNone(payload)
self.assertEqual(payload.event_type, LayerEventType.MUTENESS_STATE_CHANGED)
self.assertEqual(set(payload.identifiers_or_spec_paths), set([sublayer1.identifier]))
layers_state.set_muteness_scope(False)
# Switch scope will load local muteness.
self.assertIsNotNone(payload)
self.assertEqual(payload.event_type, LayerEventType.MUTENESS_STATE_CHANGED)
# Since only sublayer0's state is changed.
self.assertEqual(set(payload.identifiers_or_spec_paths), set([sublayer0.identifier]))
async def test_layer_lock_events(self):
layers = get_layers()
layers_state = layers.get_layers_state()
event_stream = layers.get_event_stream()
payload = None
def _on_layer_event(event: carb.events.IEvent):
nonlocal payload
payload = get_layer_event_payload(event)
stage = omni.usd.get_context().get_stage()
sublayer0 = Sdf.Layer.CreateAnonymous()
sublayer1 = Sdf.Layer.CreateAnonymous()
root_layer = stage.GetRootLayer()
LayerUtils.insert_sublayer(root_layer, 0, sublayer0.identifier, False)
LayerUtils.insert_sublayer(root_layer, 1, sublayer1.identifier, False)
subscription = event_stream.create_subscription_to_pop(_on_layer_event, name="layer events")
# Lock
layers_state.set_layer_lock_state(sublayer0.identifier, True)
await omni.kit.app.get_app().next_update_async()
await omni.kit.app.get_app().next_update_async()
self.assertIsNotNone(payload)
self.assertEqual(payload.event_type, LayerEventType.LOCK_STATE_CHANGED)
self.assertEqual(set(payload.identifiers_or_spec_paths), set([sublayer0.identifier]))
# Unlock
payload = None
await omni.kit.app.get_app().next_update_async()
await omni.kit.app.get_app().next_update_async()
layers_state.set_layer_lock_state(sublayer0.identifier, False)
await omni.kit.app.get_app().next_update_async()
await omni.kit.app.get_app().next_update_async()
self.assertIsNotNone(payload)
self.assertEqual(payload.event_type, LayerEventType.LOCK_STATE_CHANGED)
self.assertEqual(set(payload.identifiers_or_spec_paths), set([sublayer0.identifier]))
payload = None
with Sdf.ChangeBlock():
LayerUtils.set_layer_lock_status(root_layer, sublayer0.identifier, True)
LayerUtils.set_layer_lock_status(root_layer, sublayer1.identifier, True)
await omni.kit.app.get_app().next_update_async()
await omni.kit.app.get_app().next_update_async()
self.assertIsNotNone(payload)
self.assertEqual(payload.event_type, LayerEventType.LOCK_STATE_CHANGED)
self.assertEqual(set(payload.identifiers_or_spec_paths), set([sublayer0.identifier, sublayer1.identifier]))
async def test_layer_dirty_state_events(self):
layers = get_layers()
event_stream = layers.get_event_stream()
payload = None
def _on_layer_event(event: carb.events.IEvent):
nonlocal payload
temp = get_layer_event_payload(event)
if temp.event_type == LayerEventType.DIRTY_STATE_CHANGED:
payload = temp
with tempfile.TemporaryDirectory() as tempdir:
file = os.path.join(tempdir, "test.usd")
file1 = os.path.join(tempdir, "test1.usd")
layer = Sdf.Layer.CreateNew(file)
layer.Save()
layer1 = Sdf.Layer.CreateNew(file1)
layer1.Save()
stage = omni.usd.get_context().get_stage()
root_layer = stage.GetRootLayer()
LayerUtils.insert_sublayer(root_layer, 0, layer.identifier, False)
LayerUtils.insert_sublayer(root_layer, 1, layer1.identifier, False)
subscription = event_stream.create_subscription_to_pop(_on_layer_event, name="layer events")
# Change anonymous layer will not emit dirty event
with Usd.EditContext(stage, stage.GetRootLayer()):
stage.DefinePrim("/root/prim")
await omni.kit.app.get_app().next_update_async()
self.assertIsNone(payload)
with Usd.EditContext(stage, layer):
stage.DefinePrim("/root/prim2")
await omni.kit.app.get_app().next_update_async()
self.assertIsNotNone(payload)
self.assertEqual(payload.event_type, LayerEventType.DIRTY_STATE_CHANGED)
self.assertEqual(set(payload.identifiers_or_spec_paths), set([layer.identifier]))
self.assertTrue(layer.dirty)
# Change a dirty layer will not emit dirty event again
payload = None
stage.DefinePrim("/root/prim3")
self.assertIsNone(payload)
with Usd.EditContext(stage, layer1):
stage.DefinePrim("/root/prim4")
await omni.kit.app.get_app().next_update_async()
# Save dirty layers will emit dirty change event
payload = None
stage.Save()
await omni.kit.app.get_app().next_update_async()
self.assertIsNotNone(payload)
self.assertEqual(payload.event_type, LayerEventType.DIRTY_STATE_CHANGED)
self.assertEqual(set(payload.identifiers_or_spec_paths), set([layer.identifier, layer1.identifier]))
self.assertFalse(layer.dirty)
self.assertFalse(layer1.dirty)
layer = None
layer1 = None
root_layer = None
await omni.usd.get_context().new_stage_async()
async def test_layer_outdate_state_events(self):
pass
async def test_layer_prim_specs_events(self):
layers = get_layers()
event_stream = layers.get_event_stream()
payload = None
def _on_layer_event(event: carb.events.IEvent):
nonlocal payload
temp = get_layer_event_payload(event)
if temp.event_type == LayerEventType.PRIM_SPECS_CHANGED:
payload = temp
subscription = event_stream.create_subscription_to_pop(_on_layer_event, name="layer events")
stage = omni.usd.get_context().get_stage()
all_prims = []
for i in range(100):
prim = stage.DefinePrim(f"/test_{i}")
all_prims.append(str(prim.GetPath()))
await omni.kit.app.get_app().next_update_async()
self.assertIsNotNone(payload)
self.assertEqual(payload.event_type, LayerEventType.PRIM_SPECS_CHANGED)
root_layer_identifier = stage.GetRootLayer().identifier
self.assertIn(root_layer_identifier, payload.layer_spec_paths)
self.assertEqual(set(payload.layer_spec_paths[root_layer_identifier]), set(all_prims))
stage.GetRootLayer().Clear()
await omni.kit.app.get_app().next_update_async()
self.assertIsNotNone(payload)
self.assertEqual(payload.event_type, LayerEventType.PRIM_SPECS_CHANGED)
root_layer_identifier = stage.GetRootLayer().identifier
self.assertIn(root_layer_identifier, payload.layer_spec_paths)
self.assertEqual(set(payload.layer_spec_paths[root_layer_identifier]), set([str(Sdf.Path.absoluteRootPath)]))
async def test_sublayers_changed_events(self):
layers = get_layers()
event_stream = layers.get_event_stream()
payload = None
def _on_layer_event(event: carb.events.IEvent):
nonlocal payload
temp = get_layer_event_payload(event)
if temp.event_type == LayerEventType.SUBLAYERS_CHANGED:
payload = temp
subscription = event_stream.create_subscription_to_pop(_on_layer_event, name="layer events")
stage = omni.usd.get_context().get_stage()
root_layer = stage.GetRootLayer()
sublayer0 = Sdf.Layer.CreateAnonymous()
sublayer1 = Sdf.Layer.CreateAnonymous()
root_layer.subLayerPaths.append(sublayer0.identifier)
await omni.kit.app.get_app().next_update_async()
self.assertIsNotNone(payload)
self.assertEqual(payload.event_type, LayerEventType.SUBLAYERS_CHANGED)
payload = None
LayerUtils.remove_sublayer(root_layer, 0)
await omni.kit.app.get_app().next_update_async()
self.assertIsNotNone(payload)
self.assertEqual(payload.event_type, LayerEventType.SUBLAYERS_CHANGED)
root_layer.subLayerPaths.append(sublayer0.identifier)
root_layer.subLayerPaths.append(sublayer1.identifier)
# Layer move
payload = None
LayerUtils.move_layer(root_layer.identifier, 0, sublayer1.identifier, 0, True)
await omni.kit.app.get_app().next_update_async()
self.assertIsNotNone(payload)
self.assertEqual(payload.event_type, LayerEventType.SUBLAYERS_CHANGED)
# Not all edits will emit sublayer changes events.
payload = None
stage.DefinePrim("/root/test")
self.assertIsNone(payload)
async def test_layer_info_changed_events(self):
layers = get_layers()
event_stream = layers.get_event_stream()
payload = None
def _on_layer_event(event: carb.events.IEvent):
nonlocal payload
temp = get_layer_event_payload(event)
if temp.event_type == LayerEventType.INFO_CHANGED:
payload = temp
subscription = event_stream.create_subscription_to_pop(_on_layer_event, name="layer events")
stage = omni.usd.get_context().get_stage()
root_layer = stage.GetRootLayer()
sublayer0 = Sdf.Layer.CreateAnonymous()
root_layer.subLayerPaths.append(sublayer0.identifier)
root_layer.subLayerOffsets[0] = Sdf.LayerOffset(2.0, 3.0)
up_axis = UsdGeom.GetStageUpAxis(stage)
with Sdf.ChangeBlock():
if up_axis == UsdGeom.Tokens.z:
UsdGeom.SetStageUpAxis(stage, UsdGeom.Tokens.y)
else:
UsdGeom.SetStageUpAxis(stage, UsdGeom.Tokens.z)
root_layer.comment = "test"
root_layer.documentation = "test2"
UsdGeom.SetStageMetersPerUnit(stage, 100.0)
stage.SetStartTimeCode(100.99)
stage.SetEndTimeCode(1000.99)
root_layer.framesPerSecond = 100
stage.SetTimeCodesPerSecond(1000)
await omni.kit.app.get_app().next_update_async()
self.assertIsNotNone(payload)
self.assertEqual(payload.event_type, LayerEventType.INFO_CHANGED)
self.assertIn(root_layer.identifier, payload.layer_info_data)
expected_changes = (
"documentation",
"upAxis",
"comment",
"metersPerUnit",
"startTimeCode",
"framesPerSecond",
"endTimeCode",
"timeCodesPerSecond",
)
self.assertEqual(set(payload.layer_info_data[root_layer.identifier]), set(expected_changes))
async def test_edit_target_changed(self):
layers = get_layers()
event_stream = layers.get_event_stream()
payload = None
def _on_layer_event(event: carb.events.IEvent):
nonlocal payload
temp = get_layer_event_payload(event)
if temp.event_type == LayerEventType.EDIT_TARGET_CHANGED:
payload = temp
subscription = event_stream.create_subscription_to_pop(_on_layer_event, name="layer events")
stage = omni.usd.get_context().get_stage()
root_layer = stage.GetRootLayer()
sublayer0 = Sdf.Layer.CreateAnonymous()
root_layer.subLayerPaths.append(sublayer0.identifier)
edit_target = Usd.EditTarget(sublayer0)
stage.SetEditTarget(edit_target)
await omni.kit.app.get_app().next_update_async()
self.assertIsNotNone(payload)
self.assertEqual(payload.event_type, LayerEventType.EDIT_TARGET_CHANGED)
# Set the same edit target will not trigger any events
payload = None
stage.SetEditTarget(edit_target)
await omni.kit.app.get_app().next_update_async()
self.assertIsNone(payload)
def check_sublayers(self, sublayer_paths, expected_layer_identifiers):
sublayer_paths = sorted(sublayer_paths)
expected_layer_identifiers = sorted(expected_layer_identifiers)
self.assertTrue(
sublayer_paths == expected_layer_identifiers,
f"Sublayers array does not match, got: {sublayer_paths}, expected: {expected_layer_identifiers}",
)
async def test_get_used_sublayers(self):
layers = get_layers()
stage = self.usd_context.get_stage()
root_layer = stage.GetRootLayer()
sublayers = layers.get_layers_state().get_local_layer_identifiers()
self.check_sublayers(sublayers, [root_layer.identifier])
layer0 = Sdf.Layer.CreateAnonymous()
LayerUtils.insert_sublayer(root_layer, 0, layer0.identifier)
sublayers = layers.get_layers_state().get_local_layer_identifiers()
self.check_sublayers(sublayers, [root_layer.identifier, layer0.identifier])
layer1 = Sdf.Layer.CreateAnonymous()
LayerUtils.insert_sublayer(root_layer, 1, layer1.identifier)
sublayers = layers.get_layers_state().get_local_layer_identifiers()
self.check_sublayers(sublayers, [root_layer.identifier, layer0.identifier, layer1.identifier])
layer2 = Sdf.Layer.CreateAnonymous()
layer3 = Sdf.Layer.CreateAnonymous()
layer4 = Sdf.Layer.CreateAnonymous()
layer5 = Sdf.Layer.CreateAnonymous()
LayerUtils.insert_sublayer(layer2, 0, layer3.identifier)
LayerUtils.insert_sublayer(layer2, 1, layer4.identifier)
LayerUtils.insert_sublayer(layer4, 0, layer5.identifier)
LayerUtils.insert_sublayer(root_layer, 2, layer2.identifier)
sublayers = layers.get_layers_state().get_local_layer_identifiers()
self.check_sublayers(
sublayers,
[
root_layer.identifier,
layer0.identifier,
layer1.identifier,
layer2.identifier,
layer3.identifier,
layer4.identifier,
layer5.identifier,
],
)
# Removes layer0
LayerUtils.remove_sublayer(root_layer, 0)
sublayers = layers.get_layers_state().get_local_layer_identifiers()
self.check_sublayers(
sublayers,
[
root_layer.identifier,
layer1.identifier,
layer2.identifier,
layer3.identifier,
layer4.identifier,
layer5.identifier,
],
)
# Removes layer2 will remove layer2, layer3, layer4, layer5
LayerUtils.remove_sublayer(root_layer, 1)
sublayers = layers.get_layers_state().get_local_layer_identifiers()
self.check_sublayers(sublayers, [root_layer.identifier, layer1.identifier])
async def test_get_dirty_sublayers(self):
layers = get_layers()
stage = self.usd_context.get_stage()
root_layer = stage.GetRootLayer()
with tempfile.TemporaryDirectory() as tempdir:
format = Sdf.FileFormat.FindByExtension(".usd")
layer0 = Sdf.Layer.New(format, f"{tempdir}/1.usd")
layer1 = Sdf.Layer.New(format, f"{tempdir}/2.usd")
layer2 = Sdf.Layer.New(format, f"{tempdir}/3.usd")
layer3 = Sdf.Layer.New(format, f"{tempdir}/4.usd")
layer4 = Sdf.Layer.New(format, f"{tempdir}/5.usd")
layer5 = Sdf.Layer.New(format, f"{tempdir}/6.usd")
LayerUtils.insert_sublayer(root_layer, 0, layer0.identifier, False)
LayerUtils.insert_sublayer(root_layer, 0, layer1.identifier, False)
LayerUtils.insert_sublayer(layer2, 0, layer3.identifier, False)
LayerUtils.insert_sublayer(layer2, 0, layer4.identifier, False)
LayerUtils.insert_sublayer(layer4, 0, layer5.identifier, False)
LayerUtils.insert_sublayer(root_layer, 0, layer2.identifier, False)
sublayers = layers.get_layers_state().get_local_layer_identifiers()
self.check_sublayers(
sublayers,
[
root_layer.identifier,
layer0.identifier,
layer1.identifier,
layer2.identifier,
layer3.identifier,
layer4.identifier,
layer5.identifier,
],
)
# Checkes dirtiness of layers since layer2 and layer4 have been touched.
# They should be dirty at this moment
dirty_sublayers = layers.get_layers_state().get_dirty_layer_identifiers()
self.check_sublayers(dirty_sublayers, [layer2.identifier, layer4.identifier])
# Touches layer1
LayerUtils.set_edit_target(stage, layer1.identifier)
UsdGeom.Mesh.Define(stage, "/root/test")
dirty_sublayers = layers.get_layers_state().get_dirty_layer_identifiers()
self.check_sublayers(dirty_sublayers, [layer1.identifier, layer2.identifier, layer4.identifier])
| 30,154 | Python | 43.021898 | 117 | 0.649897 |
omniverse-code/kit/exts/omni.kit.usd.layers/omni/kit/usd/layers/tests/test_base.py | import carb.settings
def enable_server_tests():
settings = carb.settings.get_settings()
return settings.get_as_bool("/exts/omni.kit.usd.layers/enable_server_tests")
| 176 | Python | 21.124997 | 80 | 0.732955 |
omniverse-code/kit/exts/omni.kit.usd.layers/omni/kit/usd/layers/impl/layer_commands.py | import omni
import carb
import omni.kit.commands
from pxr import Usd, Sdf, UsdGeom
from .layer_utils import LayerUtils
from typing import Union, List
from .extension import get_layers
from .specs_linking_and_locking_utils import *
def _get_usd_context(context_name_or_instance: Union[str, omni.usd.UsdContext] = ""):
if not context_name_or_instance:
context_name_or_instance = ""
if isinstance(context_name_or_instance, str):
usd_context = omni.usd.get_context(context_name_or_instance)
elif isinstance(context_name_or_instance, omni.usd.UsdContext):
usd_context = context_name_or_instance
else:
usd_context = None
return usd_context
class AbstractLayerCommand(omni.kit.commands.Command):
"""
Abstract base class for layer commands.
It's mainly responsible to create a commmon class
to recover layer selection in layer window, and
edit target for USD Stage in undo.
"""
def __init__(self, context_name_or_instance: Union[str, omni.usd.UsdContext] = ""):
self._usd_context = _get_usd_context(context_name_or_instance)
self._selection = self._usd_context.get_selection()
def get_layers(self):
return get_layers(self._usd_context_name)
def get_specs_linking(self):
layers = self.get_layers()
if not layers:
return None
return layers.get_specs_linking()
def get_specs_locking(self):
layers = self.get_layers()
if not layers:
return None
return layers.get_specs_locking()
def _restore_spec_links_from_dict(self, spec_path_to_layers):
specs_linking = self.get_specs_linking()
for spec_path, _ in spec_path_to_layers.items():
specs_linking.unlink_spec_from_all_layers(spec_path, False)
for spec_path, layer_identifiers in spec_path_to_layers.items():
for layer_identifier in layer_identifiers:
specs_linking.link_spec(spec_path, layer_identifier, False)
def get_layers(self):
return get_layers(self._usd_context)
def get_specs_linking(self):
layers = self.get_layers()
if not layers:
return None
return layers.get_specs_linking()
def get_specs_locking(self):
layers = self.get_layers()
if not layers:
return None
return layers.get_specs_locking()
def _restore_spec_links_from_dict(self, spec_path_to_layers):
specs_linking = self.get_specs_linking()
for spec_path, _ in spec_path_to_layers.items():
specs_linking.unlink_spec_from_all_layers(spec_path, False)
for spec_path, layer_identifiers in spec_path_to_layers.items():
for layer_identifier in layer_identifiers:
specs_linking.link_spec(spec_path, layer_identifier, False)
def do(self):
stage = self._usd_context.get_stage()
if stage.GetEditTarget().GetLayer():
self._edit_target_identifier = stage.GetEditTarget().GetLayer().identifier
else:
self._edit_target_identifier = stage.GetRootLayer().identifier
self._prev_selected_paths = list(self._selection.get_selected_prim_paths())
self.do_impl()
def do_impl(self):
raise NotImplementedError("Method must be implemented")
def undo_impl(self):
raise NotImplementedError("Method must be implemented")
def undo(self):
self.undo_impl()
# restore selected prims and layer
self._selection.set_selected_prim_paths(self._prev_selected_paths, False)
stage = self._usd_context.get_stage()
layer = Sdf.Find(self._edit_target_identifier)
if layer and not stage.IsLayerMuted(layer.identifier):
edit_target_layer = layer
else:
edit_target_layer = stage.GetRootLayer()
if stage.HasLocalLayer(edit_target_layer):
edit_target = Usd.EditTarget(edit_target_layer)
stage.SetEditTarget(edit_target)
class SetEditTargetCommand(AbstractLayerCommand):
"""Select Layer as Edit Target undoable **Command**."""
def __init__(self, layer_identifier: str, usd_context: Union[str, omni.usd.UsdContext] = ""):
"""Constructor.
Keyword Arguments:
layer_identifier (str): Layer identifier.
usd_context (Union[str, omni.usd.UsdContext]): Usd context name or instance. It uses default context if it's empty.
"""
super().__init__(usd_context)
self._current_edit_target_identifier = layer_identifier
def do_impl(self):
layer = Sdf.Find(self._current_edit_target_identifier)
if not layer:
carb.log_warn(f"Set authoring command failed. Cannot find layer {self._current_edit_target_identifier}")
else:
edit_target = Usd.EditTarget(layer)
stage = self._usd_context.get_stage()
if not stage.IsLayerMuted(layer.identifier) and stage.HasLocalLayer(layer):
stage.SetEditTarget(edit_target)
def undo_impl(self):
pass
class CreateSublayerCommand(AbstractLayerCommand):
"""Create Sublayer undoable **Command**."""
def __init__(
self,
layer_identifier: str,
sublayer_position: int,
new_layer_path: str,
transfer_root_content: bool,
create_or_insert: bool,
layer_name: str = "",
usd_context: Union[str, omni.usd.UsdContext] = "",
):
"""Constructor.
Keyword arguments::
layer_identifier (str): The identifier of layer to create sublayer. It should be found by Sdf.Find.
sublayer_position (int): Sublayer position that the new sublayer is created before.
If position_before == -1, it will create layer at the end of sublayer list.
If position_before >= total_number_of_sublayers, it will create layer at the end of sublayer list.
new_layer_path (str): Absolute path of new layer. If it's empty, it will create anonymous layer if create_or_insert == True.
If create_or_insert == False and it's empty, it will fail to insert layer.
transfer_root_content (bool): True if we should move the root contents to the new layer.
create_or_insert (bool): If it's true, it will create layer from this path. It's insert, otherwise.
layer_name (str, optional): If it's to create anonymous layer (new_layer_path is empty), this name is used.
usd_context (Union[str, omni.usd.UsdContext]): Usd context name or instance. It uses default context if it's empty.
"""
super().__init__(usd_context)
self._layer_identifier = layer_identifier
self._sublayer_position = sublayer_position
self._new_layer_path = new_layer_path
self._create_or_insert = create_or_insert
if create_or_insert:
self._transfer_root_content = transfer_root_content
else:
self._transfer_root_content = False
self._new_layer_identifier = None
self._layer_name = layer_name
self._temp_layer = None
def do_impl(self):
stage = self._usd_context.get_stage()
root = stage.GetRootLayer()
parent_layer = Sdf.Find(self._layer_identifier)
if self._create_or_insert:
if self._transfer_root_content:
self._temp_layer = Sdf.Layer.CreateAnonymous()
self._temp_layer.TransferContent(root)
if parent_layer:
new_layer = LayerUtils.create_sublayer(parent_layer, self._sublayer_position, self._new_layer_path)
if new_layer:
# Copy stage axis
up_axis = UsdGeom.GetStageUpAxis(stage)
stage_hanlde = Usd.Stage.Open(new_layer)
UsdGeom.SetStageUpAxis(stage_hanlde, up_axis)
LayerUtils.set_custom_layer_name(new_layer, self._layer_name)
if self._transfer_root_content:
LayerUtils.transfer_layer_content(root, new_layer)
root.rootPrims.clear()
self._new_layer_identifier = new_layer.identifier
else:
self._new_layer_identifier = None
else:
layer = LayerUtils.insert_sublayer(parent_layer, self._sublayer_position, self._new_layer_path)
if layer:
self._new_layer_identifier = layer.identifier
def undo_impl(self):
if self._new_layer_identifier:
stage = self._usd_context.get_stage()
with Sdf.ChangeBlock():
if self._transfer_root_content and self._temp_layer:
root = stage.GetRootLayer()
root.TransferContent(self._temp_layer)
layer_position_in_parent = LayerUtils.get_sublayer_position_in_parent(
self._layer_identifier, self._new_layer_identifier
)
if layer_position_in_parent != -1:
layer = Sdf.Find(self._layer_identifier)
if not layer:
return
layer_identifier = LayerUtils.remove_sublayer(layer, layer_position_in_parent)
LayerUtils.remove_layer_global_muteness(layer, layer_identifier)
class RemoveSublayerCommand(AbstractLayerCommand):
"""Remove Sublayer undoable **Command**."""
def __init__(
self, layer_identifier: str, sublayer_position: int, usd_context: Union[str, omni.usd.UsdContext] = ""
):
"""Constructor.
Keyword Arguments:
layer_identifier (str): The identifier of layer to remove sublayer.
sublayer_position (int): The sublayer position to be removed.
usd_context (Union[str, omni.usd.UsdContext]): Usd context name or instance. It uses default context if it's empty.
"""
super().__init__(usd_context)
self._layer_identifier = layer_identifier
self._sublayer_position = sublayer_position
def do_impl(self):
stage = self._usd_context.get_stage()
root_layer = stage.GetRootLayer()
self._removed_layer_identifier = None
layer = Sdf.Find(self._layer_identifier)
sublayer_identifier = LayerUtils.get_sublayer_identifier(self._layer_identifier, self._sublayer_position)
if not layer or not sublayer_identifier:
return
self._old_layer_global_mute = LayerUtils.get_layer_global_muteness(root_layer, sublayer_identifier)
self._old_layer_local_mute = stage.IsLayerMuted(sublayer_identifier)
self._old_layer_lock_status = LayerUtils.get_layer_lock_status(root_layer, sublayer_identifier)
if Sdf.Layer.IsAnonymousLayerIdentifier(sublayer_identifier):
# Hold layer reference to avoid it's released for undo
self._removed_layer = Sdf.Layer.FindOrOpen(sublayer_identifier)
else:
self._removed_layer = None
edit_target_layer = stage.GetEditTarget().GetLayer()
if edit_target_layer:
current_edit_target = edit_target_layer.identifier
else:
current_edit_target = None
self._removed_layer_identifier = LayerUtils.remove_sublayer(layer, self._sublayer_position)
LayerUtils.remove_layer_global_muteness(root_layer, self._removed_layer_identifier)
LayerUtils.remove_layer_lock_status(root_layer, self._removed_layer_identifier)
if current_edit_target and current_edit_target == self._removed_layer_identifier:
edit_target = Usd.EditTarget(stage.GetRootLayer())
stage.SetEditTarget(edit_target)
elif not current_edit_target:
root_layer_target = Usd.EditTarget(stage.GetRootLayer())
stage.SetEditTarget(root_layer_target)
def undo_impl(self):
if self._removed_layer_identifier:
stage = self._usd_context.get_stage()
root_layer = stage.GetRootLayer()
layer = Sdf.Find(self._layer_identifier)
if layer:
position = self._sublayer_position
sublayer = LayerUtils.insert_sublayer(layer, position, self._removed_layer_identifier)
if sublayer:
if self._old_layer_local_mute:
stage.MuteLayer(sublayer.identifier)
else:
stage.UnmuteLayer(sublayer.identifier)
LayerUtils.set_layer_global_muteness(root_layer, sublayer.identifier, self._old_layer_global_mute)
LayerUtils.set_layer_lock_status(root_layer, sublayer.identifier, self._old_layer_lock_status)
class RemovePrimSpecCommand(omni.kit.commands.Command):
"""Remove Prim undoable **Command**."""
def __init__(
self,
layer_identifier: str,
prim_spec_path: Union[Sdf.Path, List[Sdf.Path]],
usd_context: Union[str, omni.usd.UsdContext] = "",
):
"""Constructor.
Keyword Arguments:
layer_identifier (str): The identifier of layer to remove prim.
prim_spec_path (Union[Sdf.Path, List[Sdf.Path]]): The prim paths to be removed.
usd_context (Union[str, omni.usd.UsdContext]): Usd context name or instance. It uses default context if it's empty.
"""
self._usd_context = _get_usd_context(usd_context)
self._layer_identifier = layer_identifier
self._anon_layer = None
if isinstance(prim_spec_path, Sdf.Path) or isinstance(prim_spec_path, str):
self._prim_spec_paths = [prim_spec_path]
else:
self._prim_spec_paths = prim_spec_path
def do(self):
layer = Sdf.Find(self._layer_identifier)
if layer:
with Sdf.ChangeBlock():
for prim_spec_path in self._prim_spec_paths:
prim_spec = layer.GetPrimAtPath(prim_spec_path)
if not prim_spec:
return
self._anon_layer = Sdf.Layer.CreateAnonymous()
Sdf.CreatePrimInLayer(self._anon_layer, prim_spec_path)
Sdf.CopySpec(layer, prim_spec_path, self._anon_layer, prim_spec_path)
LayerUtils.remove_prim_spec(layer, prim_spec_path)
else:
self._anon_layer = None
self._layer_identifier = None
def undo(self):
if self._anon_layer and self._layer_identifier:
layer = Sdf.Find(self._layer_identifier)
if layer:
with Sdf.ChangeBlock():
for prim_spec_path in self._prim_spec_paths:
Sdf.CreatePrimInLayer(self._anon_layer, prim_spec_path)
Sdf.CopySpec(self._anon_layer, prim_spec_path, layer, prim_spec_path)
self._anon_layer = None
class MergeLayersCommand(AbstractLayerCommand):
"""Merge Layers undoable **Command**."""
def __init__(
self,
dst_parent_layer_identifier: str,
dst_layer_identifier,
src_parent_layer_identifier: str,
src_layer_identifier: str,
dst_stronger_than_src: bool,
usd_context: Union[str, omni.usd.UsdContext] = "",
):
"""Constructor.
Keyword Arguments:
dst_parent_layer_identifier: The parent of target layer.
dst_layer_identifier: The target layer that source layer is merged to.
src_parent_layer_identifier: The parent of source layer.
src_layer_identifier: The source layer.
dst_stronger_than_src (bool): If target layer is stronger than source, which will decide
how to merge opinions that appear in both layers.
usd_context (Union[str, omni.usd.UsdContext]): Usd context name or instance. It uses default context if it's empty.
"""
super().__init__(usd_context)
self._merged = False
self._delete_cmds = []
self._dst_layer_identifier = dst_layer_identifier
self._src_layer_identifier = src_layer_identifier
self._dst_parent_layer_identifier = dst_parent_layer_identifier
self._src_parent_layer_identifier = src_parent_layer_identifier
self._dst_stronger_than_src = dst_stronger_than_src
def do_impl(self):
temp_layer = None
stage = self._usd_context.get_stage()
strong_muted = stage.IsLayerMuted(self._dst_layer_identifier)
weak_muted = stage.IsLayerMuted(self._src_layer_identifier)
strong_layer = Sdf.Layer.Find(self._dst_layer_identifier)
src_sublayer_position = LayerUtils.get_sublayer_position_in_parent(
self._src_parent_layer_identifier, self._src_layer_identifier
)
if strong_muted or not strong_layer:
# strong layer inactive - delete it
sublayer_position = LayerUtils.get_sublayer_position_in_parent(
self._dst_parent_layer_identifier, self._dst_layer_identifier
)
delete_cmd = RemoveSublayerCommand(self._dst_parent_layer_identifier, sublayer_position)
delete_cmd.do_impl()
self._delete_cmds.append(delete_cmd)
elif not weak_muted:
# both are not muted - merge
temp_layer = Sdf.Layer.CreateAnonymous()
temp_layer.TransferContent(strong_layer)
self._removed_layer = temp_layer
omni.usd.merge_layers(self._dst_layer_identifier, self._src_layer_identifier, self._dst_stronger_than_src)
self._merged = True
if self._merged or (not strong_muted and strong_layer):
# Since omni.usd.merge_layers will clear all sublayers, it needs to
# insert again to create a remove command if src layer is a sublayer of dst layer.
if self._merged and self._dst_layer_identifier == self._src_parent_layer_identifier:
LayerUtils.insert_sublayer(strong_layer, src_sublayer_position, self._src_layer_identifier)
delete_cmd = RemoveSublayerCommand(self._src_parent_layer_identifier, src_sublayer_position)
delete_cmd.do_impl()
self._delete_cmds.append(delete_cmd)
# FIXME: Remove this weak layer from temp layer also.
# This is not an issue for offline stage.
if temp_layer:
if self._dst_layer_identifier == self._src_parent_layer_identifier:
LayerUtils.remove_sublayer(temp_layer, src_sublayer_position)
def undo_impl(self):
if self._merged:
if self._dst_layer_identifier == self._src_parent_layer_identifier:
# transfering content here will invalidate prims in the deleted layer
dst_layer = Sdf.Find(self._dst_layer_identifier)
if dst_layer:
with Sdf.ChangeBlock():
Sdf.CopySpec(
self._removed_layer, Sdf.Path.absoluteRootPath, dst_layer, Sdf.Path.absoluteRootPath
)
for delete_cmd in reversed(self._delete_cmds):
delete_cmd.undo_impl()
else:
with Sdf.ChangeBlock():
for delete_cmd in reversed(self._delete_cmds):
delete_cmd.undo_impl()
layer = Sdf.Find(self._dst_layer_identifier)
if layer:
# FIXME: It cannot use TransferContent which does not notify anything
Sdf.CopySpec(self._removed_layer, Sdf.Path.absoluteRootPath, layer, Sdf.Path.absoluteRootPath)
for sublayer in self._removed_layer.subLayerPaths:
if sublayer not in layer.subLayerPaths:
layer.subLayerPaths.append(sublayer)
self._removed_layer = None
else:
with Sdf.ChangeBlock():
for delete_cmd in reversed(self._delete_cmds):
delete_cmd.undo_impl()
self._delete_cmds.clear()
class FlattenLayersCommand(AbstractLayerCommand):
"""Flatten Layers undoable **Command**."""
def __init__(self, usd_context: Union[str, omni.usd.UsdContext] = ""):
"""Constructor.
Keyword Arguments:
usd_context (Union[str, omni.usd.UsdContext]): Usd context name or instance. It uses default context if it's empty.
"""
super().__init__(usd_context)
self._merges = []
def _traverse(self, results, parent_layer_identifier, layer, layer_identifier, current_subtree_stack):
# It has circular sublayer tree, like sub1 -> sub2 -> sub1
if layer_identifier in current_subtree_stack:
return
results.append((parent_layer_identifier, layer_identifier))
current_subtree_stack.append(layer_identifier)
if not layer:
return
for sublayer in layer.subLayerPaths:
sublayer_identifier = layer.ComputeAbsolutePath(sublayer)
sublayer = Sdf.Find(sublayer_identifier)
self._traverse(results, layer.identifier, sublayer, sublayer_identifier, current_subtree_stack)
current_subtree_stack.pop()
def _get_sublayers_from_strongest_to_weakest(self):
stage = self._usd_context.get_stage()
root_layer = stage.GetRootLayer()
all_layers = []
current_subtree_stack = []
self._traverse(all_layers, None, root_layer, root_layer.identifier, current_subtree_stack)
return all_layers
def do_impl(self):
all_sublayers = self._get_sublayers_from_strongest_to_weakest()
mergable_parent_identifier = None
mergable_sublayer_identifier = None
for i in reversed(range(len(all_sublayers))):
parent_identifier = all_sublayers[i][0]
sublayer_identifier = all_sublayers[i][1]
if mergable_parent_identifier is not None:
merge = MergeLayersCommand(
parent_identifier,
sublayer_identifier,
mergable_parent_identifier,
mergable_sublayer_identifier,
True,
)
merge.do_impl()
self._merges.append(merge)
mergable_parent_identifier = parent_identifier
mergable_sublayer_identifier = sublayer_identifier
def undo_impl(self):
self._merges.reverse()
for m in self._merges:
m.undo_impl()
self._merges.clear()
class CreateLayerReferenceCommand(AbstractLayerCommand):
"""
Create reference in specific layer undoable **Command**.
It creates a new prim and adds the asset and path as references in specific layer.
Args:
layer_identifier: str: Layer identifier to create prim inside.
path_to (Sdf.Path): Path to create a new prim.
asset_path (str): The asset it's necessary to add to references.
prim_path (Sdf.Path): The prim in asset to reference.
usd_context (Union[str, omni.usd.UsdContext]): Usd context name or instance. It uses default context if it's empty.
"""
def __init__(
self,
layer_identifier: str,
path_to: Sdf.Path,
asset_path: str = None,
prim_path: Sdf.Path = None,
usd_context: Union[str, omni.usd.UsdContext] = "",
):
super().__init__(usd_context)
self._selection = self._usd_context.get_selection()
stage = self._usd_context.get_stage()
path_to = Sdf.Path(omni.usd.get_stage_next_free_path(stage, str(path_to), False))
self._layer_identifier = layer_identifier
self._asset_path = asset_path
self._prim_path = prim_path
self._path_to = path_to
def do_impl(self):
layer = Sdf.Find(self._layer_identifier)
if not layer:
return False
stage = self._usd_context.get_stage()
with Usd.EditContext(stage, layer):
prim_to = stage.DefinePrim(self._path_to)
with Sdf.ChangeBlock():
# Set inctanceable
if self._asset_path:
if self._prim_path:
prim_to.GetReferences().AddReference(self._asset_path, self._prim_path)
else:
prim_to.GetReferences().AddReference(self._asset_path)
elif self._prim_path:
prim_to.GetReferences().AddInternalReference(self._prim_path)
def undo_impl(self):
layer = Sdf.Find(self._layer_identifier)
if not layer:
return False
# Dereference this. Otherwise it fires error: Cannot remove ancestral prim
stage = self._usd_context.get_stage()
with Usd.EditContext(stage, layer):
prim_to = stage.GetPrimAtPath(self._path_to)
prim_to.GetReferences().ClearReferences()
# It would be better to use the following command, but it's in buildins and not available:
# delete_cmd = DeletePrimsCommand([self._path_to])
# delete_cmd.do()
for layer in stage.GetLayerStack():
edit = Sdf.BatchNamespaceEdit()
temp_layer = Sdf.Layer.CreateAnonymous()
prim_spec = layer.GetPrimAtPath(self._path_to)
if prim_spec is None:
continue
parent_spec = prim_spec.realNameParent
if parent_spec is not None:
Sdf.CreatePrimInLayer(temp_layer, self._path_to)
Sdf.CopySpec(layer, self._path_to, temp_layer, self._path_to)
edit.Add(self._path_to, Sdf.Path.emptyPath)
layer.Apply(edit)
class StitchPrimSpecsToLayer(AbstractLayerCommand):
"""Flatten specific prims in the stage.
It will remove original prim specs after flatten.
"""
def __init__(
self, prim_paths: List[str], target_layer_identifier: str, usd_context: Union[str, omni.usd.UsdContext] = ""
):
"""Constructor.
Keyword Arguments:
prim_paths (List[str]): A list of prim_paths to flatten with.
target_layer_identifier (str): The target layer to store the flatten results.
usd_context (Union[str, omni.usd.UsdContext]): Usd context name or instance. It uses default context if it's empty.
"""
super().__init__(usd_context)
self._prim_paths = prim_paths
self._target_layer_identifier = target_layer_identifier
self._to_recoverd_layers = {}
def do_impl(self):
self._to_recoverd_layers.clear()
target_layer = Sdf.Find(self._target_layer_identifier)
stage = self._usd_context.get_stage()
if stage and target_layer and self._prim_paths:
# Saves context before real flatten for undo.
all_sublayer_paths = LayerUtils.get_all_sublayers(stage)
if self._target_layer_identifier not in all_sublayer_paths:
all_sublayer_paths.append(self._target_layer_identifier)
with Sdf.ChangeBlock():
for sublayer_path in all_sublayer_paths:
sublayer = Sdf.Layer.Find(sublayer_path)
if not sublayer:
continue
for prim_spec_path in self._prim_paths:
recover_layer = self._to_recoverd_layers.get(sublayer_path, None)
if not recover_layer:
recover_layer = Sdf.Layer.CreateAnonymous()
self._to_recoverd_layers[sublayer_path] = recover_layer
prim_spec = sublayer.GetPrimAtPath(prim_spec_path)
if not prim_spec:
continue
Sdf.CreatePrimInLayer(recover_layer, prim_spec_path)
Sdf.CopySpec(sublayer, prim_spec_path, recover_layer, prim_spec_path)
for prim_path in self._prim_paths:
omni.usd.stitch_prim_specs(stage, prim_path, target_layer)
# Delete it from src layer
all_sublayer_paths.remove(self._target_layer_identifier)
for sublayer_path in all_sublayer_paths:
for prim_spec_path in self._prim_paths:
sublayer = Sdf.Layer.Find(sublayer_path)
if not sublayer:
continue
LayerUtils.remove_prim_spec(sublayer, prim_spec_path)
def undo_impl(self):
with Sdf.ChangeBlock():
for layer_identifier, layer_content in self._to_recoverd_layers.items():
original_layer = Sdf.Layer.Find(layer_identifier)
if not original_layer:
continue
for prim_spec_path in self._prim_paths:
if layer_content.GetPrimAtPath(prim_spec_path):
Sdf.CreatePrimInLayer(original_layer, prim_spec_path)
Sdf.CopySpec(layer_content, prim_spec_path, original_layer, prim_spec_path)
else:
LayerUtils.remove_prim_spec(original_layer, prim_spec_path)
self._to_recoverd_layers.clear()
class MovePrimSpecsToLayerCommand(AbstractLayerCommand):
"""Merge prim spec from src layer to dst layer and remove it from src layer."""
def __init__(
self,
dst_layer_identifier: str,
src_layer_identifier: str,
prim_spec_path: str,
dst_stronger_than_src: bool,
usd_context: Union[str, omni.usd.UsdContext] = "",
):
"""Constructor.
Keyword Arguments:
dst_layer_identifier (str): The identifier of target layer.
src_layer_identifier (str): The identifier of source layer.
prim_spec_path (str): The prim spec path to be merged.
dst_stronger_than_src (bool): Target layer is stronger than source layer in stage.
usd_context (Union[str, omni.usd.UsdContext]): Usd context name or instance. It uses default context if it's empty.
"""
super().__init__(usd_context)
self._dst_layer_identifier = dst_layer_identifier
self._src_layer_identifier = src_layer_identifier
self._prim_spec_path = prim_spec_path
self._dst_stronger_than_src = dst_stronger_than_src
def do_impl(self):
if self._dst_layer_identifier != self._src_layer_identifier:
dst_layer = Sdf.Find(self._dst_layer_identifier)
src_layer = Sdf.Find(self._src_layer_identifier)
if dst_layer and src_layer:
self._anon_dst_layer = Sdf.Layer.CreateAnonymous()
# backup dst node for undo if prim exists
prim_spec = dst_layer.GetPrimAtPath(self._prim_spec_path)
self._created_prim = None
if prim_spec is not None:
Sdf.CreatePrimInLayer(self._anon_dst_layer, self._prim_spec_path)
Sdf.CopySpec(dst_layer, self._prim_spec_path, self._anon_dst_layer, self._prim_spec_path)
else:
# prim doesnt exist in dst, so merge_prim_spec will create any missing parents in dst,
# and we will have to remove them during undo
prim_spec = src_layer.GetPrimAtPath(self._prim_spec_path)
parent = prim_spec.realNameParent
while (
parent is not None
and parent.realNameParent is not None
and dst_layer.GetPrimAtPath(parent.path) is None
):
self._created_prim = parent.path
parent = parent.realNameParent
# Create prim spec in dst if it's not existed.
omni.usd.merge_prim_spec(
self._dst_layer_identifier,
self._src_layer_identifier,
self._prim_spec_path,
self._dst_stronger_than_src,
)
# Delete it from src layer
self._delete_cmd = RemovePrimSpecCommand(self._src_layer_identifier, self._prim_spec_path)
self._delete_cmd.do()
self._dst_layer_path = self._dst_layer_identifier
else:
self._dst_layer_path = None
def undo_impl(self):
if self._dst_layer_identifier != self._src_layer_identifier:
self._delete_cmd.undo()
self._delete_cmd = None
if not self._dst_layer_path:
return
dst_layer = Sdf.Find(self._dst_layer_identifier)
if dst_layer:
prim_spec = self._anon_dst_layer.GetPrimAtPath(self._prim_spec_path)
if prim_spec is not None:
Sdf.CopySpec(self._anon_dst_layer, self._prim_spec_path, dst_layer, self._prim_spec_path)
else:
LayerUtils.remove_prim_spec(dst_layer, self._prim_spec_path)
if self._created_prim is not None:
LayerUtils.remove_prim_spec(dst_layer, self._created_prim.pathString)
self._anon_dst_layer = None
class MoveSublayerCommand(AbstractLayerCommand):
"""Move Sublayer undoable **Command**."""
def __init__(
self,
from_parent_layer_identifier: str,
from_sublayer_position: int,
to_parent_layer_identifier: str,
to_sublayer_position: int,
remove_source: bool = False,
usd_context: Union[str, omni.usd.UsdContext] = "",
):
"""Constructor.
Keyword Arguments:
from_parent_layer_identifier (str): The identifier of source parent layer.
from_sublayer_position (int): The sublayer position in source parent layer to move.
to_parent_layer_identifier (str): The identifier of target parent layer.
to_sublayer_position (int): The sublayer position in target parent layer that layers moves to.
If this position is -1, it means the last position of sublayer array.
If this position is beyond the end of sublayer array. It means to
move this layer to the end of that array.
Otherwise, it's invalid if it's below 0.
remove_source (bool): Remove source sublayer after moving to target or not.
usd_context (Union[str, omni.usd.UsdContext]): Usd context name or instance. It uses default context if it's empty.
"""
super().__init__(usd_context)
self._from_parent_layer_identifier = from_parent_layer_identifier
self._from_sublayer_position = from_sublayer_position
self._sublayer_identifier = LayerUtils.get_sublayer_identifier(
self._from_parent_layer_identifier, self._from_sublayer_position
)
if self._sublayer_identifier:
self._to_parent_layer_identifier = to_parent_layer_identifier
self._to_sublayer_position = to_sublayer_position
self._success = False
sublayer_position_in_target = LayerUtils.get_sublayer_position_in_parent(
self._to_parent_layer_identifier, self._sublayer_identifier
)
self._remove_source = remove_source
if self._from_parent_layer_identifier == self._to_parent_layer_identifier:
# It must remove source to move this layer.
self._remove_source = True
self._has_same_layer_in_target = False
else:
self._has_same_layer_in_target = sublayer_position_in_target != -1
def _move_layer(
self,
from_parent_layer_identifier,
sublayer_identifier,
to_parent_layer_identifier,
to_sublayer_position,
remove_source,
):
# Finds moved layer.
layer_position_in_parent = LayerUtils.get_sublayer_position_in_parent(
from_parent_layer_identifier, sublayer_identifier
)
# Cannot find moved layer
if layer_position_in_parent == -1:
carb.log_warn(
f"Cannot move layer from sublayer {sublayer_identifier} under parent {from_parent_layer_identifier} to "
f"sublayer at position {to_sublayer_position} under parent {to_parent_layer_identifier} "
f"since moved layer cannot be found."
)
return False
# Find target layer
return LayerUtils.move_layer(
from_parent_layer_identifier,
layer_position_in_parent,
to_parent_layer_identifier,
to_sublayer_position,
remove_source,
)
def do_impl(self):
if not self._sublayer_identifier:
return
self._move_layer(
self._from_parent_layer_identifier,
self._sublayer_identifier,
self._to_parent_layer_identifier,
self._to_sublayer_position,
self._remove_source,
)
def undo_impl(self):
if not self._sublayer_identifier:
return
self._move_layer(
self._to_parent_layer_identifier,
self._sublayer_identifier,
self._from_parent_layer_identifier,
self._from_sublayer_position,
not self._has_same_layer_in_target,
)
class ReplaceSublayerCommand(AbstractLayerCommand):
"""Replace Layer undoable **Command**."""
def __init__(
self,
layer_identifier: str,
sublayer_position: int,
new_layer_path: str,
usd_context: Union[str, omni.usd.UsdContext] = "",
):
"""Constructor.
Keyword Arguments:
layer_identifier (str): The identifier of layer to replace sublayer.
sublayer_position (int): The sublayer position to be replaced.
new_layer_path (str): The path of new layer.
usd_context (Union[str, omni.usd.UsdContext]): Usd context name or instance. It uses default context if it's empty.
"""
super().__init__(usd_context)
self._layer_identifier = layer_identifier
self._sublayer_position = sublayer_position
self._new_layer_path = new_layer_path
self._old_layer_identifier = None
self._new_layer_identifier = None
def do_impl(self):
self._old_layer_identifier = LayerUtils.get_sublayer_identifier(self._layer_identifier, self._sublayer_position)
if not self._old_layer_identifier:
carb.log_warn(f"Cannot replace sublayer with an invalid index {self._sublayer_position}.")
return
stage = self._usd_context.get_stage()
root_layer = stage.GetRootLayer()
self._old_layer_global_mute = LayerUtils.get_layer_global_muteness(root_layer, self._layer_identifier)
self._old_layer_local_mute = stage.IsLayerMuted(self._layer_identifier)
self._old_layer_lock_status = LayerUtils.get_layer_lock_status(root_layer, self._layer_identifier)
layer = Sdf.Find(self._layer_identifier)
if layer:
edit_target_identifier = LayerUtils.get_edit_target(stage)
new_layer = LayerUtils.replace_sublayer(layer, self._sublayer_position, self._new_layer_path)
if edit_target_identifier == self._old_layer_identifier:
LayerUtils.set_edit_target(stage, self._new_layer_path)
if new_layer:
LayerUtils.remove_layer_global_muteness(root_layer, self._layer_identifier)
LayerUtils.remove_layer_lock_status(root_layer, self._layer_identifier)
self._new_layer_identifier = new_layer.identifier
else:
self._new_layer_identifier = None
else:
self._new_layer_identifier = None
def undo_impl(self):
stage = self._usd_context.get_stage()
root_layer = stage.GetRootLayer()
if self._new_layer_identifier:
with Sdf.ChangeBlock():
new_layer_position_in_parent = LayerUtils.get_sublayer_position_in_parent(
self._layer_identifier, self._new_layer_identifier
)
if new_layer_position_in_parent != -1:
layer = Sdf.Find(self._layer_identifier)
if layer:
edit_target_identifier = LayerUtils.get_edit_target(stage)
LayerUtils.replace_sublayer(layer, new_layer_position_in_parent, self._old_layer_identifier)
if edit_target_identifier == self._old_layer_identifier:
LayerUtils.set_edit_target(stage, self._new_layer_path)
if self._old_layer_local_mute:
stage.MuteLayer(self._old_layer_identifier)
else:
stage.UnmuteLayer(self._old_layer_identifier)
LayerUtils.set_layer_global_muteness(
root_layer, self._old_layer_identifier, self._old_layer_global_mute
)
LayerUtils.set_layer_lock_status(
root_layer, self._old_layer_identifier, self._old_layer_lock_status
)
class SetLayerMutenessCommand(AbstractLayerCommand):
"""Set Layer's muteness undoable **Command**."""
def __init__(self, layer_identifier: str, muted: bool, usd_context: Union[str, omni.usd.UsdContext] = ""):
"""Constructor.
Keyword Arguments:
layer_identifier (str): The identifier of layer to be muted/unmuted.
muted (bool): Muted or not of this layer.
usd_context (Union[str, omni.usd.UsdContext]): Usd context name or instance. It uses default context if it's empty.
"""
super().__init__(usd_context)
self._layer_identifier = layer_identifier
self._muted = muted
def do_impl(self):
stage = self._usd_context.get_stage()
if not stage:
return False
session_layer_identifier = stage.GetSessionLayer().identifier
root_layer_identifier = stage.GetRootLayer().identifier
if self._layer_identifier == session_layer_identifier or self._layer_identifier == root_layer_identifier:
return False
edit_target_identifier = LayerUtils.get_edit_target(stage)
if self._muted:
stage.MuteLayer(self._layer_identifier)
if edit_target_identifier == self._layer_identifier:
stage.SetEditTarget(Usd.EditTarget(stage.GetRootLayer()))
else:
stage.UnmuteLayer(self._layer_identifier)
def undo_impl(self):
stage = self._usd_context.get_stage()
if not stage:
return False
edit_target_identifier = LayerUtils.get_edit_target(stage)
if not self._muted:
stage.MuteLayer(self._layer_identifier)
if edit_target_identifier == self._layer_identifier:
stage.SetEditTarget(Usd.EditTarget(stage.GetRootLayer()))
else:
stage.UnmuteLayer(self._layer_identifier)
class LockLayer(AbstractLayerCommand):
"""Set Layer's lock status undoable **Command**."""
def __init__(self, layer_identifier: str, locked: bool, usd_context: Union[str, omni.usd.UsdContext] = ""):
"""Constructor. REMINDER: Locking root layer is not permitted.
Keyword Arguments:
layer_identifier (str): The identifier of layer to be muted/unmuted.
locked (bool): Muted or not of this layer.
usd_context (Union[str, omni.usd.UsdContext]): Usd context name or instance. It uses default context if it's empty.
"""
super().__init__(usd_context)
self._layer_identifier = layer_identifier
self._locked = locked
def do_impl(self):
stage = self._usd_context.get_stage()
if not stage or self._layer_identifier == stage.GetRootLayer().identifier:
return False
root_layer = stage.GetRootLayer()
LayerUtils.set_layer_lock_status(root_layer, self._layer_identifier, self._locked)
if self._locked and LayerUtils.get_edit_target(stage) == self._layer_identifier:
LayerUtils.set_edit_target(stage, stage.GetRootLayer().identifier)
def undo_impl(self):
stage = self._usd_context.get_stage()
if not stage or self._layer_identifier == stage.GetRootLayer().identifier:
return False
root_layer = stage.GetRootLayer()
LayerUtils.set_layer_lock_status(root_layer, self._layer_identifier, not self._locked)
class LinkSpecsCommand(AbstractLayerCommand):
"""Links spec paths to layers undoable **Command**."""
def __init__(
self,
spec_paths: Union[str, List[str]],
layer_identifiers: Union[str, List[str]],
additive: bool = True,
hierarchy: bool = False,
usd_context: Union[str, omni.usd.UsdContext] = "",
):
"""Constructor.
Keyword Arguments:
spec_paths (Union[str, List[str]]): List of spec paths or single spec path to be linked.
layer_identifiers (Union[str, List[str]]): List of layer identifiers or single layer identifier.
additive (bool): Clearing exsiting links or not.
hierarchy (bool): Linking descendant specs or not.
usd_context (Union[str, omni.usd.UsdContext]): Usd context name or instance. It uses default context if it's empty.
"""
super().__init__(usd_context)
if isinstance(spec_paths, str) or isinstance(spec_paths, Sdf.Path):
self._paths = [spec_paths]
else:
self._paths = spec_paths
if isinstance(layer_identifiers, str):
self._layer_identifiers = [layer_identifiers]
else:
self._layer_identifiers = layer_identifiers
self._additive = additive
self._hierarchy = hierarchy
self._old_spec_links = {}
# TODO: Support transferring and discard edits
def do(self):
self._old_spec_links = get_spec_layer_links(self._usd_context, self._paths, self._hierarchy)
if not self._additive:
unlink_specs_from_all_layers(self._usd_context, self._paths, self._hierarchy)
link_specs(self._usd_context, self._paths, self._layer_identifiers, self._hierarchy)
def undo(self):
new_paths = []
for path in self._paths:
if path not in self._old_spec_links:
new_paths.append(path)
unlink_specs_from_all_layers(self._usd_context, self._paths, self._hierarchy)
self._restore_spec_links_from_dict(self._old_spec_links)
class UnlinkSpecsCommand(AbstractLayerCommand):
"""Unlinks spec paths to layers undoable **Command**."""
def __init__(
self,
spec_paths: Union[str, List[str]],
layer_identifiers: Union[str, List[str]],
hierarchy=False,
usd_context: Union[str, omni.usd.UsdContext] = "",
):
"""Constructor.
Keyword Arguments:
spec_paths (Union[str, List[str]]): List of spec paths or single spec path to be unlinked.
layer_identifiers (Union[str, List[str]]): List of layer identifiers or single layer identifier.
hierarchy (bool): Unlinking descendant specs or not.
usd_context (Union[str, omni.usd.UsdContext]): Usd context name or instance. It uses default context if it's empty.
"""
super().__init__(usd_context)
if isinstance(spec_paths, str) or isinstance(spec_paths, Sdf.Path):
self._paths = [spec_paths]
else:
self._paths = spec_paths
if isinstance(layer_identifiers, str):
self._layer_identifiers = [layer_identifiers]
else:
self._layer_identifiers = layer_identifiers
self._hierarchy = hierarchy
self._old_spec_links = {}
def do(self):
self._old_spec_links = get_spec_layer_links(self._usd_context, self._paths, self._hierarchy)
unlink_specs(self._usd_context, self._paths, self._layer_identifiers, self._hierarchy)
def undo(self):
self._restore_spec_links_from_dict(self._old_spec_links)
class LockSpecsCommand(AbstractLayerCommand):
"""Locks spec paths undoable **Command**."""
def __init__(
self, spec_paths: Union[str, List[str]], hierarchy=False, usd_context: Union[str, omni.usd.UsdContext] = ""
):
"""Constructor.
Keyword Arguments:
spec_paths (Union[str, List[str]]): List of spec paths or single spec path to be locked.
hierarchy (bool): Locking descendant specs or not.
usd_context (Union[str, omni.usd.UsdContext]): Usd context name or instance. It uses default context if it's empty.
"""
super().__init__(usd_context)
if isinstance(spec_paths, str) or isinstance(spec_paths, Sdf.Path):
self._paths = [spec_paths]
else:
self._paths = spec_paths
self._hierarchy = hierarchy
self._old_spec_locks = []
self._locked_specs = []
def do(self):
self._old_spec_locks = get_all_locked_specs(self._usd_context)
lock_specs(self._usd_context, self._paths, self._hierarchy)
self._locked_specs = get_all_locked_specs(self._usd_context)
def undo(self):
unlock_specs(self._usd_context, self._locked_specs, False)
self._locked_specs = []
lock_specs(self._usd_context, self._old_spec_locks, False)
self._old_spec_locks = []
class UnlockSpecsCommand(AbstractLayerCommand):
"""Unlocks spec paths undoable **Command**."""
def __init__(
self, spec_paths: Union[str, List[str]], hierarchy=False, usd_context: Union[str, omni.usd.UsdContext] = ""
):
"""Constructor.
Keyword Arguments:
spec_paths (Union[str, List[str]]): List of spec paths or single spec path to be unlocked.
hierarchy (bool): Unlocking descendant specs or not.
usd_context (Union[str, omni.usd.UsdContext]): Usd context name or instance. It uses default context if it's empty.
"""
super().__init__(usd_context)
if isinstance(spec_paths, str) or isinstance(spec_paths, Sdf.Path):
self._paths = [spec_paths]
else:
self._paths = spec_paths
self._hierarchy = hierarchy
self._old_spec_locks = []
def do(self):
self._old_spec_locks = get_all_locked_specs(self._usd_context)
unlock_specs(self._usd_context, self._paths, self._hierarchy)
def undo(self):
lock_specs(self._usd_context, self._old_spec_locks, False)
| 51,798 | Python | 40.045166 | 136 | 0.591702 |
omniverse-code/kit/exts/omni.kit.usd.layers/omni/kit/usd/layers/impl/layers_state.py | import carb
from pxr import Sdf
from urllib.parse import unquote
from .layer_utils import LayerUtils
from .._omni_kit_usd_layers import (
acquire_layers_state_interface,
release_layers_state_interface,
ILayersInstance,
)
class LayersState:
def __init__(self, layers_instance: ILayersInstance, usd_context) -> None:
self._layers_instance = layers_instance
self._layers_state_interface = acquire_layers_state_interface()
self._dictionary = carb.dictionary.get_dictionary()
self._usd_context = usd_context
@property
def usd_context(self):
return self._usd_context
def destroy(self):
self._layers_instance = None
release_layers_state_interface(self._layers_state_interface)
def set_muteness_scope(self, global_scope: bool):
self._layers_state_interface.set_muteness_scope(self._layers_instance, global_scope)
def is_muteness_global(self) -> bool:
"""
Global muteness is an extended concept for Omniverse so muteness can be authored into
USD for persistence. When you set muteness scope as global with set_muteness_scope,
all muteness of sublayers will be stored to root layer's custom data and it will be
loaded for next stage open.
"""
return self._layers_state_interface.is_muteness_global(self._layers_instance)
def is_layer_locally_muted(self, layer_identifier: str) -> bool:
return self._layers_state_interface.is_layer_locally_muted(self._layers_instance, layer_identifier)
def is_layer_globally_muted(self, layer_identifier: str) -> bool:
"""
Checkes if layer is globally muted or not in this usd context.
Global muteness is a customize concept in Kit that's not from USD. It's used for complement
the USD muteness, that works for two purposes:
1. It's stage bound. So a layer is globally muted in this stage will not influence others.
2. It's persistent. Right now, it's saved inside the custom data of root layer.
After stage load, it will be read to initialize the muteness of layers. Also, global muteness
only takes effective when it's in global state mode. See omni.usd.UsdContext.set_layer_muteness_scope
about how to switch muteness scope. When it's not in global state mode, authoring global
muteness will not incluence layer's muteness in stage.
"""
return self._layers_state_interface.is_layer_globally_muted(self._layers_instance, layer_identifier)
def is_layer_writable(self, layer_identifier: str) -> bool:
"""
Checkes if layer is writable. A layer is writable means it can be set as edit target, which should satisfy:
1. It's not read-only on disk.
2. It's not locked by set_layer_lock_state.
3. It's not muted.
It still can be set as edit target with scripts, while this can be used for guardrails.
"""
return self._layers_state_interface.is_layer_writable(self._layers_instance, layer_identifier)
def is_layer_readonly_on_disk(self, layer_identifier: str) -> bool:
"""
Checkes if this layer is physically read-only on disk.
"""
return self._layers_state_interface.is_layer_readonly_on_disk(self._layers_instance, layer_identifier)
def is_layer_savable(self, layer_identifier: str) -> bool:
"""
Checkes if this layer is savable. If it's savable means it's true by checking is_layer_writable and not anonymous.
"""
return self._layers_state_interface.is_layer_savable(self._layers_instance, layer_identifier)
def set_layer_lock_state(self, layer_identifier: str, locked: bool):
"""
Layer lock is an extended concept in Omniverse that works for lock this layer temporarily without real change
the file permission of this layer. It's just authored as a meta inside layer's custom data section, and read by
UI.
"""
self._layers_state_interface.set_layer_lock_state(self._layers_instance, layer_identifier, locked)
def is_layer_locked(self, layer_identifier: str) -> bool:
return self._layers_state_interface.is_layer_locked(self._layers_instance, layer_identifier)
def set_layer_name(self, layer_identifier: str, name: str):
self._layers_state_interface.set_layer_name(self._layers_instance, layer_identifier, name)
def get_layer_name(self, layer_identifier: str) -> str:
name = self._layers_state_interface.get_layer_name(self._layers_instance, layer_identifier)
if not name:
if Sdf.Layer.IsAnonymousLayerIdentifier(layer_identifier):
layer = Sdf.Find(layer_identifier)
if layer:
name = LayerUtils.get_custom_layer_name(layer)
else:
name = layer_identifier
else:
name = Sdf.Layer.GetDisplayNameFromIdentifier(layer_identifier)
return unquote(name)
def is_layer_outdated(self, layer_identifier: str) -> bool:
"""
If layer is out of sync. This only works for layer inside server.
"""
return self._layers_state_interface.is_layer_outdated(self._layers_instance, layer_identifier)
def _populate_all_identifiers(self, item: carb.dictionary.Item):
all_layer_identifiers = []
count = self._dictionary.get_item_child_count(item)
for i in range(count):
layer_item = self._dictionary.get_item_child_by_index(item, i)
layer_identifier = self._dictionary.get_as_string(layer_item)
all_layer_identifiers.append(layer_identifier)
return all_layer_identifiers
def get_local_layer_identifiers(self, include_session_layers=False, include_anonymous_layers=True, include_invalid_layers=False):
item = self._layers_state_interface.get_local_layer_identifiers(self._layers_instance, include_session_layers, include_anonymous_layers, include_invalid_layers)
if not item:
return []
all_layer_identifiers = self._populate_all_identifiers(item)
self._dictionary.destroy_item(item)
return all_layer_identifiers
def get_dirty_layer_identifiers(self):
"""Gets all layer identifiers that have pending edits that are not saved."""
item = self._layers_state_interface.get_dirty_layer_identifiers(self._layers_instance)
if not item:
return []
all_layer_identifiers = self._populate_all_identifiers(item)
self._dictionary.destroy_item(item)
return all_layer_identifiers
def has_local_layer(self, layer_identifier):
"""Layer is in the local layer stack of current stage."""
stage = self._usd_context.get_stage()
if not stage:
return False
layer = Sdf.Find(layer_identifier)
if not layer:
return False
return stage.HasLocalLayer(layer)
| 7,066 | Python | 41.572289 | 168 | 0.665016 |
omniverse-code/kit/exts/omni.kit.usd.layers/omni/kit/usd/layers/impl/interface_utils.py | import carb
from typing import List, Dict
from .._omni_kit_usd_layers import LayerEventType
class LayerEventPayload:
def __init__(self, event: carb.events.IEvent) -> None:
# It is non-empty if event_type is INFO_CHANGED, for which key is the layer identifier,
# and value is the set of strings that represent the info tokens.
self.layer_info_data: Dict[str, List[str]] = {}
# It's non-empty if event_type is DIRTY_STATE_CHANGED, OUTDATE_STATE_CHANGED
# LOCK_STATE_CHANGED, MUTENESS_STATE_CHANGED, SPECS_LOCKING_CHANGED, or
# LIVE_SESSION_STATE_CHANGED,
# which will include all influenced layer identifiers or spec paths.
self.identifiers_or_spec_paths: List[str] = []
# It's non-empty if event_type is PRIM_SPECS_CHANGED or SPECS_LINKING_CHANGED. For which, the key is the layer identifier,
# and value is the list of strings that represent spec paths.
self.layer_spec_paths: Dict[str, List[str]] = {}
# It's non-empty if event_type is LIVE_SESSION_USER_JOINED or LIVE_SESSION_USER_LEFT
self.user_name = None
# It's non-empty if event_type is LIVE_SESSION_USER_JOINED or LIVE_SESSION_USER_LEFT
self.user_id = None
# It's non-empty if event_type is LIVE_SESSION_MERGE_STARTED or LIVE_SESSION_MERGE_ENDED
self.layer_identifier = None
# It means if the merge of live session is successful or not.
self.success = True
self.event_type = LayerEventType(event.type)
if event.type == int(LayerEventType.INFO_CHANGED):
layer_identifier = event.payload["layer_identifier"]
info_data = event.payload["val"]
self.layer_info_data[layer_identifier] = list(info_data)
elif (
event.type == int(LayerEventType.DIRTY_STATE_CHANGED)
or event.type == int(LayerEventType.OUTDATE_STATE_CHANGED)
or event.type == int(LayerEventType.MUTENESS_STATE_CHANGED)
or event.type == int(LayerEventType.LOCK_STATE_CHANGED)
or event.type == int(LayerEventType.SPECS_LOCKING_CHANGED)
):
self.identifiers_or_spec_paths = list(event.payload["val"])
elif event.type == int(LayerEventType.PRIM_SPECS_CHANGED):
layer_identifier = event.payload["layer_identifier"]
prim_specs = event.payload["val"]
self.layer_spec_paths[layer_identifier] = list(prim_specs)
elif event.type == int(LayerEventType.SPECS_LINKING_CHANGED):
for _, value in event.payload["val"].items():
layer_identifier = value.get("key", "")
spec_paths = value.get("value", [])
if layer_identifier and spec_paths:
self.layer_spec_paths[layer_identifier] = spec_paths
elif (
event.type == int(LayerEventType.LIVE_SESSION_USER_JOINED)
or event.type == int(LayerEventType.LIVE_SESSION_USER_LEFT)
):
self.user_name = event.payload["user_name"]
self.user_id = event.payload["user_id"]
elif event.type == int(LayerEventType.LIVE_SESSION_STATE_CHANGED):
layer_identifiers = list(event.payload["val"])
if layer_identifiers:
self.identifiers_or_spec_paths = layer_identifiers
elif event.type == int(LayerEventType.LIVE_SESSION_LIST_CHANGED):
layer_identifier = event.payload["val"]
if layer_identifier:
self.identifiers_or_spec_paths = [layer_identifier]
elif (
event.type == int(LayerEventType.LIVE_SESSION_MERGE_STARTED) or
event.type == int(LayerEventType.LIVE_SESSION_MERGE_ENDED)
):
self.layer_identifier = event.payload["layer_identifier"]
self.success = event.payload["success"]
def get_layer_event_payload(event: carb.events.IEvent) -> LayerEventPayload:
try:
return LayerEventPayload(event)
except Exception as e:
carb.log_error(f"Failed to convert event: {str(e)}")
return None
def post_notification(message: str, info=True):
try:
import omni.kit.notification_manager as nm
if info:
status = nm.NotificationStatus.INFO
else:
status = nm.NotificationStatus.WARNING
nm.post_notification(message, status=status)
except Exception:
pass
| 4,426 | Python | 44.173469 | 130 | 0.633981 |
omniverse-code/kit/exts/omni.kit.usd.layers/omni/kit/usd/layers/impl/layers_interface.py | from .._omni_kit_usd_layers import LayerEditMode
from .layers_state import LayersState
from .specs_locking import SpecsLocking
from .auto_authoring import AutoAuthoring
from .specs_linking import SpecsLinking
from .live_syncing import LiveSyncing
class Layers:
def __init__(self, layers_instance, usd_context) -> None:
self._layers_instance = layers_instance
self._usd_context = usd_context
if self._layers_instance:
self._layers_state = LayersState(layers_instance, usd_context)
self._specs_locking = SpecsLocking(layers_instance, usd_context)
self._auto_authoring = AutoAuthoring(layers_instance, usd_context)
self._specs_linking = SpecsLinking(layers_instance, usd_context)
self._live_syncing = LiveSyncing(layers_instance, usd_context, self._layers_state)
else:
self._layers_state = None
self._specs_locking = None
self._auto_authoring = None
self._specs_linking = None
self._live_syncing = None
def destroy(self):
if self._specs_locking:
self._specs_locking.destroy()
self._specs_locking = None
if self._auto_authoring:
self._auto_authoring.destroy()
self._auto_authoring = None
if self._specs_linking:
self._specs_linking.destroy()
self._specs_linking = None
if self._live_syncing:
self._live_syncing.stop_all_live_sessions()
self._live_syncing.destroy()
self._live_syncing = None
if self._layers_state:
self._layers_state.destroy()
self._layers_state = None
self._usd_context = None
def get_layers_state(self) -> LayersState:
return self._layers_state
def get_specs_locking(self) -> SpecsLocking:
return self._specs_locking
def get_auto_authoring(self) -> AutoAuthoring:
return self._auto_authoring
def get_specs_linking(self) -> SpecsLinking:
return self._specs_linking
def get_live_syncing(self) -> LiveSyncing:
return self._live_syncing
def get_event_stream(self):
return self._layers_instance.get_event_stream()
def get_edit_mode(self) -> LayerEditMode:
return self._layers_instance.get_edit_mode()
def set_edit_mode(self, edit_mode: LayerEditMode):
self._layers_instance.set_edit_mode(edit_mode)
@property
def usd_context(self):
return self._usd_context
| 2,540 | Python | 33.337837 | 94 | 0.629921 |
omniverse-code/kit/exts/omni.kit.usd.layers/omni/kit/usd/layers/impl/extension.py | import carb
import omni.ext
import omni.usd
from typing import List, Union, Dict
from .layers_interface import Layers, LiveSyncing, LayersState, AutoAuthoring
from .._omni_kit_usd_layers import acquire_layers_interface, release_layers_interface, LayerEditMode
from pxr import Sdf, Usd
_all_layers_instances: Dict[omni.usd.UsdContext, Layers] = {}
_layers_interface = None
def get_layers_interface():
global _layers_interface
if not _layers_interface:
_layers_interface = acquire_layers_interface()
return _layers_interface
def get_layers(context_name_or_instance: Union[str, omni.usd.UsdContext] = "") -> Union[Layers, None]:
global _all_layers_instances
if not context_name_or_instance:
context_name_or_instance = ""
if isinstance(context_name_or_instance, str):
usd_context = omni.usd.get_context(context_name_or_instance)
elif isinstance(context_name_or_instance, omni.usd.UsdContext):
usd_context = context_name_or_instance
else:
carb.log_warn("Failed to get layers instance since the param must be name or instance of UsdContext.")
return None
if not usd_context:
carb.log_warn("Failed to query layers instance since UsdContext cannot be found.")
return None
layers_instance = _all_layers_instances.get(usd_context, None)
if not layers_instance:
instance_native = get_layers_interface().get_layers_instance_by_context(usd_context)
if instance_native:
layers_instance = Layers(instance_native, usd_context)
_all_layers_instances[usd_context] = layers_instance
else:
layers_instance = None
carb.log_warn("Failed to query layers instance.")
return layers_instance
def get_auto_authoring(context_name_or_instance: Union[str, omni.usd.UsdContext] = "") -> Union[AutoAuthoring, None]:
layers = get_layers(context_name_or_instance)
if layers:
return layers.get_auto_authoring()
return None
def get_layers_state(context_name_or_instance: Union[str, omni.usd.UsdContext] = "") -> Union[LayersState, None]:
layers = get_layers(context_name_or_instance)
if layers:
return layers.get_layers_state()
return None
def get_live_syncing(context_name_or_instance: Union[str, omni.usd.UsdContext] = "") -> Union[LiveSyncing, None]:
layers = get_layers(context_name_or_instance)
if layers:
return layers.get_live_syncing()
return None
def active_authoring_layer_context(usd_context) -> Usd.EditContext:
"""
Gets the edit context for edit target if it's in non-auto authoring mode,
or edit context for default edit layer if it's in auto authoring mode.
"""
stage = usd_context.get_stage()
layers = get_layers(usd_context)
auto_authoring = layers.get_auto_authoring()
edit_mode = layers.get_edit_mode()
if edit_mode == LayerEditMode.NORMAL:
edit_target_layer = stage.GetEditTarget().GetLayer()
else:
default_edit_layer_identifier = auto_authoring.get_default_layer()
edit_target_layer = Sdf.Find(default_edit_layer_identifier)
if not edit_target_layer:
edit_target_layer = stage.GetRootLayer()
return Usd.EditContext(stage, edit_target_layer)
# Use extension entry points to acquire and release interface.
class Extension(omni.ext.IExt):
def on_startup(self):
# Load layers for default context
get_layers()
def on_shutdown(self):
global _all_layers_instances
for _, instance in _all_layers_instances.items():
instance.destroy()
_all_layers_instances.clear()
global _layers_interface
if _layers_interface:
release_layers_interface(_layers_interface)
| 3,785 | Python | 32.504424 | 117 | 0.684016 |
omniverse-code/kit/exts/omni.kit.usd.layers/omni/kit/usd/layers/impl/__init__.py | from .extension import (
Extension, get_layers,
active_authoring_layer_context,
LayerEditMode, get_auto_authoring,
get_layers_state,
get_live_syncing
)
from .interface_utils import (
get_layer_event_payload, LayerEventPayload,
LayerEventType
)
from .layers_interface import Layers
from .layers_state import LayersState
from .specs_locking import SpecsLocking
from .auto_authoring import AutoAuthoring
from .specs_linking import SpecsLinking
from .live_syncing import LiveSyncing, LiveSession, MESSAGE_USER_NAME_KEY, MESSAGE_SESSION_URL_KEY, MESSAGE_USER_ID_KEY
from .layer_utils import LayerUtils
from .layer_commands import *
from .specs_linking_and_locking_utils import *
| 704 | Python | 31.045453 | 119 | 0.78125 |
omniverse-code/kit/exts/omni.kit.usd.layers/omni/kit/usd/layers/impl/specs_linking_and_locking_utils.py | import carb
from typing import Union, List, Dict
from pxr import Sdf
from .extension import get_layers
def __to_str_list(pathOrPaths: Union[Union[str, Sdf.Path], List[Union[str, Sdf.Path]]]):
paths = []
if pathOrPaths:
if isinstance(pathOrPaths, str) or isinstance(pathOrPaths, Sdf.Path):
paths = [str(pathOrPaths)]
else:
paths = [str(path) for path in pathOrPaths]
return paths
def link_specs(
usd_context,
spec_paths: Union[Union[str, Sdf.Path], List[Union[str, Sdf.Path]]],
layer_identifiers: Union[str, List[str]],
hierarchy=False,
) -> Dict[str, List[str]]:
paths = __to_str_list(spec_paths)
identifiers = __to_str_list(layer_identifiers)
layers = get_layers(usd_context)
if not layers:
carb.log_warn(f"Cannot link specs as corresponding layers instance cannot be found.")
return None
specs_linking = layers.get_specs_linking()
if not specs_linking.is_enabled():
carb.log_warn(f"Cannot link specs as it's not in SPECS_LINKING mode.")
return None
spec_path_to_layers: Dict[str, List[str]] = {}
for path in paths:
for identifier in identifiers:
linked_spec_paths = specs_linking.link_spec(path, identifier, hierarchy)
for spec_path in linked_spec_paths:
if spec_path not in spec_path_to_layers:
spec_path_to_layers[spec_path] = [identifier]
else:
spec_path_to_layers[spec_path].append(identifier)
return spec_path_to_layers
def unlink_specs(
usd_context,
spec_paths: Union[Union[str, Sdf.Path], List[Union[str, Sdf.Path]]],
layer_identifiers: Union[str, List[str]],
hierarchy=False,
) -> Dict[str, List[str]]:
paths = __to_str_list(spec_paths)
identifiers = __to_str_list(layer_identifiers)
layers = get_layers(usd_context)
if not layers:
carb.log_warn(f"Cannot unlink specs as corresponding layers instance cannot be found.")
return None
specs_linking = layers.get_specs_linking()
if not specs_linking.is_enabled():
carb.log_warn(f"Cannot unlink specs as it's not in SPECS_LINKING mode.")
return None
spec_path_to_layers: Dict[str, List[str]] = {}
for path in paths:
for identifier in identifiers:
unlinked_spec_paths = specs_linking.unlink_spec(path, identifier, hierarchy)
for spec_path in unlinked_spec_paths:
if spec_path not in spec_path_to_layers:
spec_path_to_layers[spec_path] = [identifier]
else:
spec_path_to_layers[spec_path].append(identifier)
return spec_path_to_layers
def unlink_specs_to_layers(usd_context, layer_identifiers: Union[str, List[str]]) -> Dict[str, List[str]]:
identifiers = __to_str_list(layer_identifiers)
layers = get_layers(usd_context)
if not layers:
carb.log_warn(f"Cannot unlink specs as corresponding layers instance cannot be found.")
return None
specs_linking = layers.get_specs_linking()
if not specs_linking.is_enabled():
carb.log_warn(f"Cannot unlink specs as it's not in SPECS_LINKING mode.")
return None
layer_to_spec_paths: Dict[str, List[str]] = {}
for identifier in identifiers:
spec_paths = specs_linking.unlink_specs_to_layer(identifier)
layer_to_spec_paths.update(spec_paths)
return layer_to_spec_paths
def unlink_specs_from_all_layers(
usd_context, spec_paths: Union[str, List[str]], hierarchy=False
) -> Dict[str, List[str]]:
paths = __to_str_list(spec_paths)
layers = get_layers(usd_context)
if not layers:
carb.log_warn(f"Cannot unlink specs as corresponding layers instance cannot be found.")
return None
specs_linking = layers.get_specs_linking()
if not specs_linking.is_enabled():
carb.log_warn(f"Cannot unlink specs as it's not in SPECS_LINKING mode.")
return None
spec_path_to_layers: Dict[str, List[str]] = {}
for path in paths:
spec_paths = specs_linking.unlink_spec_from_all_layers(path, hierarchy)
spec_path_to_layers.update(spec_paths)
return spec_path_to_layers
def unlink_all_specs(usd_context):
layers = get_layers(usd_context)
if not layers:
carb.log_warn(f"Cannot unlink specs as corresponding layers instance cannot be found.")
return None
specs_linking = layers.get_specs_linking()
if not specs_linking.is_enabled():
carb.log_warn(f"Cannot unlink specs as it's not in SPECS_LINKING mode.")
return None
specs_linking.unlink_all_specs()
def get_spec_layer_links(
usd_context, spec_paths: Union[Union[str, Sdf.Path], List[Union[str, Sdf.Path]]], hierarchy=False
) -> Dict[str, List[str]]:
paths = __to_str_list(spec_paths)
layers = get_layers(usd_context)
if not layers:
carb.log_warn(f"Cannot get links as corresponding layers instance cannot be found.")
return None
specs_linking = layers.get_specs_linking()
spec_path_to_layers = {}
for path in paths:
spec_path_to_layers.update(specs_linking.get_spec_layer_links(path, hierarchy))
return spec_path_to_layers
def get_spec_links_for_layers(usd_context, layer_identifiers: Union[str, List[str]]) -> Dict[str, List[str]]:
identifiers = __to_str_list(layer_identifiers)
layers = get_layers(usd_context)
if not layers:
carb.log_warn(f"Cannot get links as corresponding layers instance cannot be found.")
return None
specs_linking = layers.get_specs_linking()
layer_to_spec_paths: Dict[str, List[str]] = {}
for layer_identifier in identifiers:
spec_paths = specs_linking.get_spec_links_for_layer(layer_identifier)
if layer_identifier not in layer_to_spec_paths:
layer_to_spec_paths[layer_identifier] = spec_paths
else:
layer_to_spec_paths[layer_identifier].extend(spec_paths)
return layer_to_spec_paths
def get_all_spec_links(usd_context) -> Dict[str, List[str]]:
layers = get_layers(usd_context)
if not layers:
carb.log_warn(f"Cannot get links as corresponding layers instance cannot be found.")
return None
specs_linking = layers.get_specs_linking()
return specs_linking.get_all_spec_links()
def is_spec_linked(usd_context, spec_path: Union[str, Sdf.Path], layer_identifier: str = "") -> bool:
path = __to_str_list(spec_path)
if not path:
return False
layers = get_layers(usd_context)
if not layers:
carb.log_warn(f"Cannot check link state as corresponding layers instance cannot be found.")
return None
specs_linking = layers.get_specs_linking()
return specs_linking.is_spec_linked(path[0], layer_identifier)
def lock_specs(
usd_context, spec_paths: Union[Union[str, Sdf.Path], List[Union[str, Sdf.Path]]], hierarchy=False
) -> List[str]:
paths = __to_str_list(spec_paths)
layers = get_layers(usd_context)
if not layers:
carb.log_warn(f"Cannot lock specs as corresponding layers instance cannot be found.")
return None
locked_spec_paths = []
specs_locking = layers.get_specs_locking()
for path in paths:
locked_spec_paths.extend(specs_locking.lock_spec(path, hierarchy))
return locked_spec_paths
def unlock_specs(usd_context, spec_paths: Union[str, List[str]], hierarchy=False) -> List[str]:
paths = __to_str_list(spec_paths)
layers = get_layers(usd_context)
if not layers:
carb.log_warn(f"Cannot unlock specs as corresponding layers instance cannot be found.")
return None
unlocked_spec_paths = []
specs_locking = layers.get_specs_locking()
for path in paths:
unlocked_spec_paths.extend(specs_locking.unlock_spec(path, hierarchy))
return unlocked_spec_paths
def unlock_all_specs(usd_context):
layers = get_layers(usd_context)
if not layers:
carb.log_warn(f"Cannot unlock specs as corresponding layers instance cannot be found.")
return None
specs_locking = layers.get_specs_locking()
specs_locking.unlock_all_specs()
def get_all_locked_specs(usd_context) -> List[str]:
layers = get_layers(usd_context)
if not layers:
carb.log_warn(f"Cannot get lock states as corresponding layers instance cannot be found.")
return None
specs_locking = layers.get_specs_locking()
return specs_locking.get_all_locked_specs()
def is_spec_locked(usd_context, spec_path: Union[str, Sdf.Path]) -> bool:
path = __to_str_list(spec_path)
if not path:
return False
layers = get_layers(usd_context)
if not layers:
carb.log_warn(f"Cannot check lock state as corresponding layers instance cannot be found.")
return None
specs_locking = layers.get_specs_locking()
return specs_locking.is_spec_locked(path[0])
| 8,965 | Python | 32.084871 | 109 | 0.660234 |
omniverse-code/kit/exts/omni.kit.usd.layers/omni/kit/usd/layers/impl/specs_locking.py | from re import S
import carb.dictionary
from pxr import Sdf
from typing import Union, List
from .._omni_kit_usd_layers import acquire_specs_locking_interface, release_specs_locking_interface, ILayersInstance
class SpecsLocking:
def __init__(self, layers_instance: ILayersInstance, usd_context) -> None:
self._layers_instance = layers_instance
self._usd_context = usd_context
self._specs_locking_interface = acquire_specs_locking_interface()
self._dictionary = carb.dictionary.get_dictionary()
@property
def usd_context(self):
return self._usd_context
def destroy(self):
self._layers_instance = None
release_specs_locking_interface(self._specs_locking_interface)
def _populate_all_paths(self, item: carb.dictionary.Item):
all_locked_spec_paths = []
count = self._dictionary.get_item_child_count(item)
for i in range(count):
spec_path_item = self._dictionary.get_item_child_by_index(item, i)
spec_path = self._dictionary.get_as_string(spec_path_item)
all_locked_spec_paths.append(spec_path)
return all_locked_spec_paths
def lock_spec(self, spec_path: Union[str, Sdf.Path], hierarchy: bool = False) -> List[str]:
item = self._specs_locking_interface.lock_spec(self._layers_instance, str(spec_path), hierarchy)
if not item:
return []
all_locked_spec_paths = self._populate_all_paths(item)
self._dictionary.destroy_item(item)
return all_locked_spec_paths
def unlock_spec(self, spec_path: Union[str, Sdf.Path], hierarchy: bool = False) -> List[str]:
item = self._specs_locking_interface.unlock_spec(self._layers_instance, str(spec_path), hierarchy)
if not item:
return []
all_unlocked_spec_paths = self._populate_all_paths(item)
self._dictionary.destroy_item(item)
return all_unlocked_spec_paths
def unlock_all_specs(self):
self._specs_locking_interface.unlock_all_specs(self._layers_instance)
def get_all_locked_specs(self) -> List[str]:
item = self._specs_locking_interface.get_all_locked_specs(self._layers_instance)
if not item:
return []
all_locked_spec_paths = self._populate_all_paths(item)
self._dictionary.destroy_item(item)
return all_locked_spec_paths
def is_spec_locked(self, spec_path: Union[str, Sdf.Path]) -> bool:
return self._specs_locking_interface.is_spec_locked(self._layers_instance, str(spec_path))
| 2,573 | Python | 36.304347 | 116 | 0.661096 |
omniverse-code/kit/exts/omni.kit.usd.layers/omni/kit/usd/layers/impl/specs_linking.py | from re import S
import carb.dictionary
from pxr import Sdf
from typing import Union, List, Dict
from .._omni_kit_usd_layers import acquire_specs_linking_interface, release_specs_linking_interface, ILayersInstance
class SpecsLinking:
def __init__(self, layers_instance: ILayersInstance, usd_context) -> None:
self._layers_instance = layers_instance
self._usd_context = usd_context
self._specs_linking_interface = acquire_specs_linking_interface()
self._dictionary = carb.dictionary.get_dictionary()
@property
def usd_context(self):
return self._usd_context
def destroy(self):
self._layers_instance = None
release_specs_linking_interface(self._specs_linking_interface)
def _populate_all_paths(self, item: carb.dictionary.Item):
layer_spec_paths = {}
count = self._dictionary.get_item_child_count(item)
for i in range(count):
sub_item = self._dictionary.get_item_child_by_index(item, i)
identifier_item = self._dictionary.get_item(sub_item, "key")
spec_paths_item = self._dictionary.get_item(sub_item, "value")
identifier_or_spec_path = self._dictionary.get_as_string(identifier_item)
value_count = self._dictionary.get_item_child_count(spec_paths_item)
all_paths = []
for j in range(value_count):
spec_path_item = self._dictionary.get_item_child_by_index(spec_paths_item, j)
spec_path = self._dictionary.get_as_string(spec_path_item)
all_paths.append(spec_path)
layer_spec_paths[identifier_or_spec_path] = all_paths
return layer_spec_paths
def is_enabled(self) -> bool:
return self._specs_linking_interface.is_enabled(self._layers_instance)
def link_spec(self, spec_path: Union[str, Sdf.Path], layer_identifier: str, hierarchy: bool = False) -> List[str]:
item = self._specs_linking_interface.link_spec(
self._layers_instance, str(spec_path), layer_identifier, hierarchy
)
if not item:
return []
all_spec_paths = self._populate_all_paths(item)
self._dictionary.destroy_item(item)
return all_spec_paths.get(layer_identifier, [])
def unlink_spec(self, spec_path: Union[str, Sdf.Path], layer_identifier: str, hierarchy: bool = False) -> List[str]:
item = self._specs_linking_interface.unlink_spec(
self._layers_instance, str(spec_path), layer_identifier, hierarchy
)
if not item:
return []
all_spec_paths = self._populate_all_paths(item)
self._dictionary.destroy_item(item)
return all_spec_paths.get(layer_identifier, [])
def unlink_spec_from_all_layers(
self, spec_path: Union[str, Sdf.Path], hierarchy: bool = False
) -> Dict[str, List[str]]:
item = self._specs_linking_interface.unlink_spec_from_all_layers(
self._layers_instance, str(spec_path), hierarchy
)
if not item:
return {}
spec_to_layers = self._populate_all_paths(item)
self._dictionary.destroy_item(item)
return spec_to_layers
def unlink_specs_to_layer(self, layer_identifier: str) -> List[str]:
item = self._specs_linking_interface.unlink_specs_to_layer(self._layers_instance, layer_identifier)
if not item:
return []
all_spec_paths = self._populate_all_paths(item)
self._dictionary.destroy_item(item)
return all_spec_paths.get(layer_identifier, [])
def unlink_all_specs(self):
self._specs_linking_interface.unlink_all_specs(self._layers_instance)
def get_spec_layer_links(self, spec_path: Union[str, Sdf.Path], hierarchy: bool = False):
item = self._specs_linking_interface.get_spec_layer_links(self._layers_instance, str(spec_path), hierarchy)
if not item:
return {}
spec_to_layers = self._populate_all_paths(item)
self._dictionary.destroy_item(item)
return spec_to_layers
def get_spec_links_for_layer(self, layer_identifier: str) -> List[str]:
item = self._specs_linking_interface.get_spec_links_for_layer(self._layers_instance, layer_identifier)
if not item:
return []
result = self._populate_all_paths(item)
self._dictionary.destroy_item(item)
return result.get(layer_identifier, [])
def get_all_spec_links(self):
item = self._specs_linking_interface.get_all_spec_links(self._layers_instance)
if not item:
return {}
spec_to_layers = self._populate_all_paths(item)
self._dictionary.destroy_item(item)
return spec_to_layers
def is_spec_linked(self, spec_path: str, layer_identifier: str = ""):
return self._specs_linking_interface.is_spec_linked(self._layers_instance, spec_path, layer_identifier)
| 4,954 | Python | 37.410852 | 120 | 0.638474 |
omniverse-code/kit/exts/omni.kit.usd.layers/omni/kit/usd/layers/impl/live_session_channel_manager.py | import asyncio
import carb
import omni.kit.collaboration.channel_manager as cm
from typing import Dict, List
from .interface_utils import post_notification
from .._omni_kit_usd_layers import LayerEventType
SESSION_MANAGEMENT_VERSION_KEY = "version"
SESSION_MANAGEMENT_VERSION = "1.0"
MESSAGE_GROUP_KEY = "__SESSION_MANAGEMENT__"
MESSAGE_KEY = "message"
MESSAGE_MERGE_STARTED = "MERGE_STARTED"
MESSAGE_MERGE_FINISHED = "MERGE_FINISHED"
MESSAGE_USER_NAME_KEY = "user_name"
MESSAGE_USER_ID_KEY = "user_id"
MESSAGE_SESSION_URL_KEY = "session_url"
class LiveSessionChannelManager:
def __init__(self, current_session, live_syncing_interface):
self._base_layer_identifier: str = current_session.base_layer_identifier
self._session_url = current_session.url
self._session_name: str = current_session.name
self._channel_url = current_session.channel_url
self._channel: cm.Channel = None
self._channel_subscriber: cm.ChannelSubscriber = None
self._join_channel_future = None
self._live_syncing = live_syncing_interface
self._event_stream = live_syncing_interface._layers_instance.get_event_stream()
def destroy(self):
self._stop_channel()
self._live_syncing = None
self._event_stream = None
def start_async(self):
self._join_channel_future = asyncio.ensure_future(self._join_channel_async(self._channel_url))
return self._join_channel_future
def stop(self):
self._stop_channel()
@property
def stopped(self):
return self._channel and self._channel.stopped
@property
def logged_user_name(self):
return self._channel and self._channel.logged_user_name
@property
def logged_user_id(self):
return self._channel and self._channel.logged_user_id
def _send_layer_event(self, event_type: LayerEventType, payload={}):
payload[MESSAGE_SESSION_URL_KEY] = self._session_url
if payload:
self._event_stream.push(int(event_type), 0, payload)
else:
self._event_stream.push(int(event_type))
@property
def peer_users(self) -> List[cm.PeerUser]:
if self._channel:
return list(self._channel.peer_users.values())
return []
async def broadcast_merge_started_message_async(self):
if self._channel:
message = {
MESSAGE_GROUP_KEY: {
SESSION_MANAGEMENT_VERSION_KEY: SESSION_MANAGEMENT_VERSION,
MESSAGE_KEY: MESSAGE_MERGE_STARTED
}
}
await self._channel.send_message_async(message)
async def broadcast_merge_done_message_async(self):
if self._channel:
message = {
MESSAGE_GROUP_KEY: {
SESSION_MANAGEMENT_VERSION_KEY: SESSION_MANAGEMENT_VERSION,
MESSAGE_KEY: MESSAGE_MERGE_FINISHED
}
}
await self._channel.send_message_async(message)
async def _join_channel_async(self, url):
self._channel = await cm.join_channel_async(url)
if not self._channel:
post_notification(f"Failed to join channel {url}. Stopping session '{self._session_name}'...")
self._live_syncing.stop_live_session(self._base_layer_identifier)
return False
self._channel_subscriber = self._channel.add_subscriber(self._on_channel_message)
return True
def _on_channel_message(self, message: cm.Message):
info = None
from_user = message.from_user
if message.message_type == cm.MessageType.JOIN:
info = f"User {message.from_user.user_name} has joined the session '{self._session_name}'."
self._send_layer_event(
LayerEventType.LIVE_SESSION_USER_JOINED,
{
MESSAGE_USER_NAME_KEY: from_user.user_name,
MESSAGE_USER_ID_KEY: from_user.user_id,
}
)
elif message.message_type == cm.MessageType.LEFT:
info = f"User {message.from_user.user_name} has left the session '{self._session_name}."
self._send_layer_event(
LayerEventType.LIVE_SESSION_USER_LEFT,
{
MESSAGE_USER_NAME_KEY: from_user.user_name,
MESSAGE_USER_ID_KEY: from_user.user_id,
}
)
elif message.message_type == cm.MessageType.HELLO:
info = f"User {message.from_user.user_name} has joined the session '{self._session_name}'."
self._send_layer_event(
LayerEventType.LIVE_SESSION_USER_JOINED,
{
MESSAGE_USER_NAME_KEY: from_user.user_name,
MESSAGE_USER_ID_KEY: from_user.user_id,
}
)
elif message.message_type == cm.MessageType.MESSAGE:
content = message.content.get(MESSAGE_GROUP_KEY, None) or message.content.get(MESSAGE_GROUP_KEY.lower(), None)
if not content or not isinstance(content, dict):
return
message_type = content.get(MESSAGE_KEY, None) or content.get(MESSAGE_KEY.lower(), None)
if not message_type:
return
current_session = self._live_syncing.get_current_live_session(self._base_layer_identifier)
if not current_session:
carb.log_error("Invalid state. Live Session is not started but channel is still alive.")
return
if message_type.lower() == MESSAGE_MERGE_STARTED.lower():
if self._live_syncing.is_live_session_merge_notice_muted(self._base_layer_identifier):
self._live_syncing.stop_live_session(self._base_layer_identifier)
else:
try:
from omni.kit.widget.prompt import PromptButtonInfo, PromptManager
PromptManager.post_simple_prompt(
"Leave Session",
f"`{current_session.owner}' is ending the live session. "
"Stop all work and leave the session.",
PromptButtonInfo(
"LEAVE", lambda: self._live_syncing.stop_live_session(self._base_layer_identifier)
),
shortcut_keys=False
)
except Exception:
carb.log_warn("Cannot post prompt as omni.ui is not enabled, stopping live session forcely.")
self._live_syncing.stop_live_session(self._base_layer_identifier)
else:
return
# Don't explicitly make layers backend dependent on notification manager
if info:
post_notification(info)
carb.log_info(info)
def _stop_channel(self):
if self._channel_subscriber:
self._channel_subscriber.unsubscribe()
self._channel_subscriber = None
if self._channel:
self._channel.stop()
self._channel = None
try:
if self._join_channel_future and not self._join_channel_future.done():
self._join_channel_future.cancel()
except Exception:
pass
| 7,441 | Python | 39.010752 | 122 | 0.58003 |
omniverse-code/kit/exts/omni.kit.usd.layers/omni/kit/usd/layers/impl/live_syncing.py | import asyncio
import weakref
import carb
import carb.dictionary
import omni.kit.app
import omni.kit.collaboration.channel_manager as cm
import time
from typing import List, Callable, Awaitable, Dict
from .layer_utils import LayerUtils
from .interface_utils import get_layer_event_payload, post_notification
from .live_session_channel_manager import (
LiveSessionChannelManager, MESSAGE_SESSION_URL_KEY, MESSAGE_USER_ID_KEY, MESSAGE_USER_NAME_KEY
)
from pxr import Sdf
from .._omni_kit_usd_layers import (
acquire_live_syncing_interface,
release_live_syncing_interface,
ILayersInstance,
LayerEventType
)
class LiveSession:
def __init__(self, handle, session_channel, live_syncing):
self._session_handle = handle
if session_channel:
self._session_channel = weakref.ref(session_channel)
else:
self._session_channel = None
self._live_syncing = weakref.ref(live_syncing)
interface = self._live_syncing()._live_syncing_interface
layers_instance = self._live_syncing()._layers_instance
session_handle = self._session_handle
self._session_url = interface.get_live_session_url(layers_instance, session_handle)
self._session_name = interface.get_live_session_name(layers_instance, session_handle)
self._session_root = interface.get_live_session_root_identifier(layers_instance, session_handle)
self._merge_permission = interface.permission_to_merge_session_changes(layers_instance, session_handle)
self._owner = interface.get_live_session_owner(layers_instance, session_handle)
self._channel_url = interface.get_live_session_channel_url(layers_instance, session_handle)
self._base_layer_identifier = interface.get_live_session_base_layer_identifier(layers_instance, session_handle)
self._logged_user_name = interface.get_logged_in_user_name_for_layer(layers_instance, self._base_layer_identifier)
self._logged_user_id = interface.get_logged_in_user_id_for_layer(layers_instance, self._base_layer_identifier)
@property
def valid(self):
if (
not self._session_handle or
not self._session_channel or
not self._session_channel() or
not self._live_syncing()
):
return False
interface = self._live_syncing()._live_syncing_interface
layers_instance = self._live_syncing()._layers_instance
return interface.is_valid_live_session(layers_instance, self._session_handle)
@property
def channel_url(self):
return self._channel_url
@property
def base_layer_identifier(self):
return self._base_layer_identifier
@property
def name(self):
return self._session_name
@property
def url(self):
return self._session_url
@property
def owner(self):
return self._owner
@property
def merge_permission(self):
return self._merge_permission
@property
def root(self):
return self._session_root
@property
def peer_users(self) -> List[cm.PeerUser]:
if not self.valid:
return []
return list(self._session_channel().peer_users)
@property
def logged_user_name(self):
"""User name that joins this session."""
return self._logged_user_name
@property
def logged_user_id(self):
"""
User id that joins this session. User id can be used to uniquely identify
the user in a live session.
"""
return self._logged_user_id
def __str__(self) -> str:
return f"<root = {self._session_root}, name = {self._session_name}, url = {self._session_url}>"
class LiveSyncing:
def __init__(self, layers_instance: ILayersInstance, usd_context, layers_state) -> None:
self._layers_state = layers_state
self._layers_instance = layers_instance
self._usd_context = usd_context
self._live_syncing_interface = acquire_live_syncing_interface()
self._dictionary = carb.dictionary.get_dictionary()
self._layers_event_sub = self._layers_instance.get_event_stream().create_subscription_to_pop(
self._on_layer_event, name="omni.kit.usd.layers.LiveSyncing"
)
self._update_subscription = omni.kit.app.get_app().get_update_event_stream().create_subscription_to_pop(
self._on_update, name="omni.kit.usd.layers.LiveSyncing Update"
)
self._stage_event_sub = self._usd_context.get_stage_event_stream().create_subscription_to_pop(
self._on_stage_event, name="omni.kit.usd.layers Stage events"
)
self._session_channels = {}
self._merging_live_session = False
self._all_outdated_layers = set([])
self._outdate_notification = None
self._last_outdate_notification_time = 0
self._joining_session = False
self._silent_leave_layers = set([])
@property
def usd_context(self):
return self._usd_context
def _on_stage_event(self, event):
if event.type == int(omni.usd.StageEventType.CLOSING):
self._all_outdated_layers.clear()
self._last_outdate_notification_time = 0
self._silent_leave_layers.clear()
if self._outdate_notification:
self._outdate_notification.dismiss()
self._outdate_notification = None
def _on_update(self, dt):
if self._outdate_notification or not self._all_outdated_layers:
return
now = time.time()
# It will accumulate all changes in 2s.
if now - self._last_outdate_notification_time < 2:
return
self._last_outdate_notification_time = now
try:
import omni.kit.notification_manager as nm
def reload_all_outdated_layers():
outdated_layers, self._all_outdated_layers = self._all_outdated_layers, set([])
for outdate_layer in outdated_layers:
layer = Sdf.Find(outdate_layer)
if layer:
layer.Reload()
self._outdate_notification = None
self._outdate_notification = nm.post_notification(
"Base USD files have been changed, please fetch changes.",
hide_after_timeout=False,
button_infos=[
nm.NotificationButtonInfo("FETCH", on_complete=reload_all_outdated_layers),
nm.NotificationButtonInfo("CANCEL", on_complete=None),
]
)
except Exception:
pass
def _on_layer_event(self, event: carb.events.IEvent):
payload = get_layer_event_payload(event)
if not payload:
return
if payload.event_type == LayerEventType.LIVE_SESSION_STATE_CHANGED:
if self._joining_session or self._merging_live_session:
return
for layer_identifier in payload.identifiers_or_spec_paths:
current_live_session = self.get_current_live_session(layer_identifier)
if not current_live_session:
session_channel = self._session_channels.pop(layer_identifier, None)
if session_channel:
session_channel.destroy()
elif current_live_session and not self._session_channels.get(layer_identifier, None):
session_channel = LiveSessionChannelManager(current_live_session, self)
session_channel.start_async()
self._session_channels[layer_identifier] = session_channel
elif payload.event_type == LayerEventType.OUTDATE_STATE_CHANGED:
if not self._all_outdated_layers:
# Delays the notification
self._last_outdate_notification_time = time.time()
outdated_layer_identifiers = payload.identifiers_or_spec_paths
for layer_identifier in outdated_layer_identifiers:
if self._layers_state.is_layer_outdated(layer_identifier):
self._all_outdated_layers.add(layer_identifier)
else:
self._all_outdated_layers.discard(layer_identifier)
# Dismiss the notification if all layers are not outdated anymore.
if not self._all_outdated_layers and self._outdate_notification:
self._outdate_notification.dismiss()
self._outdate_notification = None
def destroy(self):
self._stage_event_sub = None
self._layers_event_sub = None
self._layers_instance = None
self._outdate_notification = None
self._update_subscription = None
self._layers_state = None
self._silent_leave_layers.clear()
for session_channel in self._session_channels.values():
session_channel.destroy()
self._session_channels.clear()
release_live_syncing_interface(self._live_syncing_interface)
def _to_live_session(self, session_handle, base_layer_identifier):
session_channel = self._session_channels.get(base_layer_identifier, None)
live_session = LiveSession(session_handle, session_channel, self)
return live_session
def get_all_live_sessions(self, layer_identifier: str = None) -> List[LiveSession]:
"""
Gets all existing live sessions for a specific layer.
Args:
layer_identifier (str): Layer identifier. If it's empty, it will be root layer by default.
Returns:
A list of live sessions.
"""
if not self.usd_context.get_stage():
return []
if not layer_identifier:
layer_identifier = self.usd_context.get_stage().GetRootLayer().identifier
total_live_sessions = self._live_syncing_interface.get_total_live_sessions(self._layers_instance, layer_identifier)
all_live_sessions = []
for i in range(total_live_sessions):
session_handle = self._live_syncing_interface.get_live_session_at_index(self._layers_instance, layer_identifier, i)
all_live_sessions.append(self._to_live_session(session_handle, layer_identifier))
return all_live_sessions
def create_live_session(self, name: str, layer_identifier: str = None):
"""
Creates a named live session.
Args:
name (str): Name of the session. Currently, name should be unique across all live sessions.
layer_identifier (str): The sublayer identifier to create live session. If it's not provided,
it will be root layer by default.
"""
if not self.usd_context.get_stage():
return None
# It's to be compatible with old interface. The second param
# of old interface is to enable auto_authoring, which is deprecated for now.
if not layer_identifier or isinstance(layer_identifier, bool):
layer_identifier = self.usd_context.get_stage().GetRootLayer().identifier
session_handle = self._live_syncing_interface.create_live_session(self._layers_instance, layer_identifier, name)
if not session_handle:
return None
live_session = self._to_live_session(session_handle, layer_identifier)
return live_session
def join_live_session(self, live_session: LiveSession):
"""Joins the live session."""
self._joining_session = True
session_handle = live_session._session_handle
success = self._live_syncing_interface.join_live_session(self._layers_instance, session_handle)
self._joining_session = False
if success:
session_channel = LiveSessionChannelManager(live_session, self)
session_channel.start_async()
self._session_channels[live_session.base_layer_identifier] = session_channel
return success
def join_live_session_by_url(self, layer_identifier: str, live_session_url: str, create_if_not_existed: bool=False):
"""
Joins the live session specified by the live session URL.
Args:
layer_identifier (str): The base layer of the live session.
live_session_url (str): The unique URL of the live session. The live session must be created against
with the base layer, otherwise, it will fail to join.
create_if_not_existed (bool): Creates the live session if it's not existed.
"""
self._joining_session = True
success = self._live_syncing_interface.join_live_session_by_url(self._layers_instance, layer_identifier, live_session_url, create_if_not_existed)
self._joining_session = False
if success:
live_session = self.get_current_live_session(layer_identifier)
session_channel = LiveSessionChannelManager(live_session, self)
session_channel.start_async()
self._session_channels[live_session.base_layer_identifier] = session_channel
return success
def stop_live_session(self, layer_identifier: str = None):
"""Stops the live session for specific layer."""
if not self.usd_context.get_stage():
return
if not layer_identifier or isinstance(layer_identifier, bool):
layer_identifier = self.usd_context.get_stage().GetRootLayer().identifier
self._joining_session = True
self._live_syncing_interface.stop_live_session(self._layers_instance, layer_identifier)
self._joining_session = False
session_channel = self._session_channels.pop(layer_identifier, None)
if session_channel:
session_channel.destroy()
def stop_all_live_sessions(self):
"""Stops all the live sessions that are enabled for the current stage."""
self._joining_session = True
self._live_syncing_interface.stop_all_live_sessions(self._layers_instance)
self._joining_session = False
for session_channel in self._session_channels.values():
session_channel.destroy()
self._session_channels.clear()
def is_stage_in_live_session(self):
return self._live_syncing_interface.is_stage_in_live_session(self._layers_instance)
def is_layer_in_live_session(self, layer_identifier):
return self._live_syncing_interface.is_layer_in_live_session(self._layers_instance, layer_identifier)
def is_in_live_session(self):
"""[DEPRECATED] If root layer is in a live session."""
if not self.usd_context.get_stage():
return False
layer_identifier = self.usd_context.get_stage().GetRootLayer().identifier
return self.is_layer_in_live_session(layer_identifier)
def is_live_session_layer(self, layer_identifier: str):
return self._live_syncing_interface.is_live_session_layer(self._layers_instance, layer_identifier)
def get_current_live_session_layers(self, layer_identifier: str = None):
"""
[DEPRECATED] Returns the live session layers attached to this live session of specifc base layer.
"""
current_live_session = self.get_current_live_session(layer_identifier)
if current_live_session:
return [current_live_session.root]
return []
def get_current_live_session_peer_users(self, layer_identifier: str = None) -> List[cm.PeerUser]:
"""
[DEPRECATED] Returns the live session layers attached to this live session of specifc base layer.
Args:
layer_identifier (str): It's root layer if it's not provided.
"""
current_live_session = self.get_current_live_session(layer_identifier)
if current_live_session:
return current_live_session.peer_users
return []
def get_live_session_for_live_layer(self, live_layer_identifier: str):
"""
Gets the live session that the live layer is attached to.
Args:
live_layer_identifier (str): The .live layer that's in the live session.
"""
session_handle = self._live_syncing_interface.get_live_session_for_live_layer(
self._layers_instance, live_layer_identifier
)
if not session_handle:
return None
base_layer_identifier = self._live_syncing_interface.get_live_session_base_layer_identifier(
self._layers_instance, session_handle
)
return self._to_live_session(session_handle, base_layer_identifier)
def get_current_live_session(self, layer_identifier: str = None) -> LiveSession:
"""
Gets the current live session of the base layer joined.
Args:
layer_identifier (str): Base layer identifier. It's root layer if it's not provided.
"""
if not self.usd_context.get_stage():
return None
if not layer_identifier:
layer_identifier = self.usd_context.get_stage().GetRootLayer().identifier
session_handle = self._live_syncing_interface.get_current_live_session(self._layers_instance, layer_identifier)
if not session_handle:
return None
return self._to_live_session(session_handle, layer_identifier)
def get_all_current_live_sessions(self) -> List[LiveSession]:
"""Gets all live sessions that are joined for the current stage."""
layer_identifiers = LayerUtils.get_all_sublayers(self.usd_context.get_stage(), True, True, False)
all_joined_sessions = []
for layer_identifier in layer_identifiers:
if layer_identifier.endswith(".live"):
continue
current_session = self.get_current_live_session(layer_identifier)
if current_session:
all_joined_sessions.append(current_session)
return all_joined_sessions
def get_live_session_by_url(self, session_url) -> LiveSession:
"""
Gets the live session by the url. It can only get the live session belongs to one of the sublayer
in the current stage.
"""
session_handle = self._live_syncing_interface.get_live_session_by_url(self._layers_instance, session_url)
base_layer_identifier = self._live_syncing_interface.get_live_session_base_layer_identifier(
self._layers_instance, session_handle
)
return self._to_live_session(session_handle, base_layer_identifier)
@property
def permission_to_merge_current_session(self, layer_identifier: str = None):
"""
[DEPRECATED] Checkes to see if it can merge the current live session of specified layer.
Args:
layer_identifier (str): It's root layer if it's not provided.
"""
current_session = self.get_current_live_session(layer_identifier)
if not current_session:
return False
return current_session.merge_permission
def merge_live_session_changes(self, layer_identifier: str, stop_session: bool):
return self._live_syncing_interface.merge_live_session_changes(
self._layers_instance, layer_identifier, stop_session
)
def merge_live_session_changes_to_specific_layer(
self, layer_identifier: str,
target_layer_identifier: str,
stop_session: bool, clear_target_layer: bool
):
return self._live_syncing_interface.merge_live_session_changes_to_specific_layer(
self._layers_instance,
layer_identifier,
target_layer_identifier,
stop_session,
clear_target_layer
)
def merge_changes_to_base_layers(self, stop_session: bool):
"""
[DEPRECATED] Merges changes of root layer's live session to its base layer.
"""
if not self.usd_context.get_stage():
return False
layer_identifier = self.usd_context.get_stage().GetRootLayer().identifier
return self.merge_live_session_changes(layer_identifier, stop_session)
def merge_changes_to_specific_layer(self, target_layer_identifier: str, stop_session: bool, clear_target_layer: bool):
"""
[DEPRECATED] Merges changes of root layer's live session to specified layer.
"""
if not self.usd_context.get_stage():
return False
base_layer_identifier = self.usd_context.get_stage().GetRootLayer().identifier
return self.merge_live_session_changes_to_specific_layer(
base_layer_identifier, target_layer_identifier, stop_session, clear_target_layer
)
async def broadcast_merge_started_message_async(self, layer_identifier: str = None):
"""
Broadcasts merge started message to other peer clients. This is normally
called before merging the live session to its base layer.
"""
if not self.usd_context.get_stage():
return
if not layer_identifier:
layer_identifier = self.usd_context.get_stage().GetRootLayer().identifier
session_channel = self._session_channels.get(layer_identifier, None)
if session_channel:
await session_channel.broadcast_merge_started_message_async()
async def broadcast_merge_done_message_async(self, destroy=True, layer_identifier: str = None):
"""
Broadcasts merge finished message to other peer clients. This is normally
called after merging the live session to its base layer.
"Args:
destroy (bool): If it needs to destroy the session channel after merging.
layer_identifier (str): The base layer of the live session.
"""
if not layer_identifier:
layer_identifier = self.usd_context.get_stage().GetRootLayer().identifier
session_channel = self._session_channels.get(layer_identifier, None)
if session_channel:
await session_channel.broadcast_merge_done_message_async()
if destroy:
session_channel.destroy()
self._session_channels.pop(layer_identifier, None)
async def merge_and_stop_live_session_async(
self, target_layer: str = None, comment="",
pre_merge: Callable[[LiveSession], Awaitable] = None,
post_merge: Callable[[bool], Awaitable] = None,
layer_identifier: str = None
):
"""Saves chagnes of live session to their base layer if it's in live mode.
Args:
target_layer (str): Target layer to merge all live changes to.
comment (str): The checkpoint comments.
pre_merge (Callable[[LiveSession], Awaitable]): It will be called before merge.
post_merge (Callable[[bool, str], Awaitable]): It will be called after merge is done. The first
param means if it's successful, and the second includes
the error message if it's not.
layer_identifier (str): The base layer of the live session. It's root layer if it's not provided.
"""
if not self.usd_context.get_stage():
return False
if not layer_identifier:
layer_identifier = self.usd_context.get_stage().GetRootLayer().identifier
current_session = self.get_current_live_session(layer_identifier)
if pre_merge:
await pre_merge(current_session)
error = None
success = True
try:
import omni.usd_resolver
if not self.is_layer_in_live_session(layer_identifier):
error = "Cannot merge live layers since it's not in live session."
success = False
return False
if not current_session.merge_permission:
error = f"Cannot merge live layers since only owner {current_session.owner} can merge them."
success = False
return False
if self._merging_live_session:
error = "Current session is already in progress of merging."
success = False
return False
self._merging_live_session = True
def report_checkpoint_errors(failed_layers):
nonlocal error
nonlocal success
success = False
if len(failed_layers) == 1:
error = f"Failed to create checkpoints for {failed_layers[0]}."
elif len(failed_layers) > 1:
error = "Failed to create checkpoints for several layers. Please check console for more details."
all_live_layers = [current_session.root]
_, failed_layers = await LayerUtils.create_checkpoint_async(all_live_layers, comment, True)
if failed_layers:
report_checkpoint_errors(failed_layers)
return False
comment = f"Merge changes from live {current_session.name}: {comment}"
omni.usd_resolver.set_checkpoint_message(comment)
# Clear checkpoint message to ensure comment is not used in future file operations.
if not target_layer:
success = self.merge_live_session_changes(layer_identifier, True)
if success:
dirty_layers = LayerUtils.get_dirty_layers(self.usd_context.get_stage(), True, True)
self._save_layers(dirty_layers)
else:
layer = Sdf.Find(target_layer)
success = self.merge_live_session_changes_to_specific_layer(layer_identifier, target_layer, True, True)
# It means it's existing layer, create a checkpoint firstly then save.
if layer and success:
self._save_layers([target_layer])
if not success:
error = "Failed to merge live changes due to permission issues."
finally:
omni.usd_resolver.set_checkpoint_message("")
if not success:
carb.log_error(error)
post_notification(error, False)
if post_merge:
await post_merge(success)
if not self.is_layer_in_live_session(layer_identifier):
session_channel = self._session_channels.pop(layer_identifier, None)
if session_channel:
session_channel.destroy()
self._merging_live_session = False
return success
def mute_live_session_merge_notice(self, layer_identifier):
"""
By default, when session owner merges the session, it will
notify peer clients to leave the session by showing a prompt.
This is used to disable the prompt and stop session directly
so it will not be disruptive especially for applications that
don't have layer window and manages all sublayer live sessions
with scripting and don't want to receive prompt for sublayer sessions.
"""
self._silent_leave_layers.add(layer_identifier)
def unmute_live_session_merge_notice(self, layer_identifier):
self._silent_leave_layers.discard(layer_identifier)
def is_live_session_merge_notice_muted(self, layer_identifier):
return layer_identifier in self._silent_leave_layers
def _save_layers(self, layer_identifiers):
success = True
for layer_identifier in layer_identifiers:
layer = Sdf.Find(layer_identifier)
if not layer:
carb.log_error(f"Failed to save layer {layer_identifier} as it cannot be found.")
continue
if not layer.Save():
carb.log_error(f"Failed to save layer {layer_identifier} because of permission issue.")
success = False
return success
| 28,500 | Python | 39.599715 | 153 | 0.616211 |
omniverse-code/kit/exts/omni.kit.usd.layers/omni/kit/usd/layers/impl/layer_utils.py | import asyncio
import os
import carb
import omni
import omni.client
from .path_utils import PathUtils
from pxr import Sdf, Usd, UsdUtils
from typing import List, Set, Union
class LayerUtils:
LAYER_OMNI_CUSTOM_KEY = "omni_layer"
LAYER_MUTENESS_CUSTOM_KEY = "muteness"
LAYER_LOCK_STATUS_CUSTOM_KEY = "locked"
LAYER_NAME_CUSTOM_KEY = "custom_name"
LAYER_AUTHORING_LAYER_CUSTOM_KEY = "authoring_layer"
@staticmethod
def create_sublayer(layer: Sdf.Layer, sublayer_position: int, layer_identifier: str):
"""Creates new sublayer at specific position.
Args:
layer (Sdf.Layer): Layer handle.
sublayer_position: Position to create the new layer.
Position should be -1 (the last position) or above 0.
If position == -1 or position > len(layer.subLayerPaths), it will create the sublayer at the end.
Any other position will be treated as invalid index.
layer_identifier: New layer path. If it's empty or None, it will create anonymous layer.
Return:
New sublayer handle or None if sublayer_position is not valid.
"""
if sublayer_position != -1 and sublayer_position < 0:
return None
if sublayer_position > len(layer.subLayerPaths) or sublayer_position == -1:
sublayer_position = len(layer.subLayerPaths)
if layer_identifier:
new_layer = Sdf.Layer.FindOrOpen(layer_identifier)
if new_layer:
new_layer.Clear()
else:
new_layer = Sdf.Layer.CreateNew(layer_identifier)
else:
new_layer = Sdf.Layer.CreateAnonymous()
if new_layer:
relative_path = PathUtils.compute_relative_path(layer.identifier, new_layer.identifier)
layer.subLayerPaths.insert(sublayer_position, relative_path)
return new_layer
@staticmethod
def insert_sublayer(layer: Sdf.Layer, sublayer_position: int, layer_identifier: str, check_empty_layer=True):
"""Inserts new sublayer at specific position.
Args:
layer (Sdf.Layer): Layer handle.
sublayer_position: Position to insert the new layer.
Position should be -1 (the last position) or above 0.
If position == -1 or position > len(layer.subLayerPaths), it will insert the sublayer at the end.
Any other position will be treated as invalid index.
layer_identifier: New layer path.
Return:
Sublayer handle or None if sublayer_position is not valid or layer_identifier is empty or inserted layer is not existed.
"""
if sublayer_position != -1 and sublayer_position < 0:
return None
if sublayer_position > len(layer.subLayerPaths) or sublayer_position == -1:
sublayer_position = len(layer.subLayerPaths)
new_layer = Sdf.Layer.FindOrOpen(layer_identifier)
if new_layer:
relative_path = PathUtils.compute_relative_path(layer.identifier, new_layer.identifier)
layer.subLayerPaths.insert(sublayer_position, relative_path)
else:
carb.log_error(f"Failed to insert sublayer {layer_identifier} since it cannot be opened.")
return new_layer
@staticmethod
def replace_sublayer(layer: Sdf.Layer, sublayer_position: int, layer_identifier: str):
"""Replaces new sublayer at specific position.
Args:
layer (Sdf.Layer): Layer handle.
sublayer_position: Position to insert the new layer.
Position should be less than len(layer.subLayerPaths).
Any other position will be treated as invalid index.
layer_identifier: New layer path.
Return:
Sublayer handle or None if sublayer_position is not valid or layer_identifier is empty or replaced layer is not existed.
"""
if sublayer_position < 0 or sublayer_position >= len(layer.subLayerPaths):
return None
new_layer = Sdf.Layer.FindOrOpen(layer_identifier)
if new_layer:
relative_path = PathUtils.compute_relative_path(layer.identifier, new_layer.identifier)
layer.subLayerPaths[sublayer_position] = relative_path
else:
carb.log_error(f"Failed to replace sublayer with {layer_identifier} since it cannot be opened.")
return new_layer
@staticmethod
def get_custom_layer_name(layer: Sdf.Layer):
"""Gets the custom name of layer. This name is saved inside the custom data of layer."""
custom_data = layer.customLayerData
name = None
if LayerUtils.LAYER_OMNI_CUSTOM_KEY in custom_data:
omni_data = custom_data[LayerUtils.LAYER_OMNI_CUSTOM_KEY]
if LayerUtils.LAYER_NAME_CUSTOM_KEY in omni_data:
name = omni_data[LayerUtils.LAYER_NAME_CUSTOM_KEY]
if not name:
name = os.path.basename(layer.identifier)
return name
@staticmethod
def set_custom_layer_name(layer: Sdf.Layer, name: str):
"""Sets the custom name of layer. This name is saved insdie the custom data of layer."""
if name:
custom_data = layer.customLayerData
if LayerUtils.LAYER_OMNI_CUSTOM_KEY not in custom_data:
custom_data[LayerUtils.LAYER_OMNI_CUSTOM_KEY] = {}
omni_data = custom_data[LayerUtils.LAYER_OMNI_CUSTOM_KEY]
omni_data[LayerUtils.LAYER_NAME_CUSTOM_KEY] = name
custom_data[LayerUtils.LAYER_OMNI_CUSTOM_KEY] = omni_data
layer.customLayerData = custom_data
@staticmethod
def transfer_layer_content(
source_layer: Sdf.Layer, target_layer: Sdf.Layer, copy_custom_data=True, skip_sublayers=True
):
for root_prim in source_layer.rootPrims:
Sdf.CopySpec(source_layer, root_prim.path, target_layer, root_prim.path)
if copy_custom_data:
UsdUtils.CopyLayerMetadata(source_layer, target_layer, skip_sublayers)
LayerUtils.resolve_paths(source_layer, target_layer)
@staticmethod
def resolve_paths(
base_layer: Sdf.Layer,
target_layer: Sdf.Layer,
store_relative_path=True,
relative_to_base_layer=False,
copy_sublayer_offsets=False,
):
"""Resolve all paths from References, Sublayers and AssetPaths of target layer based on source layer.
This function is used normally when you transfer the content from source layer to target layer that
are not in the same directory. So it needs to resolve all references so that they point to correct
location.
Args:
base_layer (Sdf.Layer): Source layer that references in target layer based on.
target_layer (Sdf.Layer): Target layer to resolve.
store_relative_path (bool): True to store relative path, or False to store absolute path.
if relative path cannot be computed (like source layer and
target are not in the same domain), it will save absolute paths.
relative_to_base_layer (bool): True if the relative path is computed against the target_layer.
False otherwise.
copy_sublayer_offsets (bool): True to copy sublayer offsets and scales from base to target.
"""
omni.usd.resolve_paths(
base_layer.identifier,
target_layer.identifier,
store_relative_path,
relative_to_base_layer,
copy_sublayer_offsets,
)
@staticmethod
def get_sublayer_position_in_parent(parent_layer_identifier, layer_identifier):
parent_layer = Sdf.Find(parent_layer_identifier)
if not parent_layer:
return -1
sublayer_paths = parent_layer.subLayerPaths
layer_identifier = parent_layer.ComputeAbsolutePath(layer_identifier)
for i in range(len(sublayer_paths)):
sublayer_path = sublayer_paths[i]
sublayer_identifier = parent_layer.ComputeAbsolutePath(sublayer_path)
if sublayer_identifier == layer_identifier:
return i
return -1
@staticmethod
def has_prim_spec(layer_identifier: str, prim_spec_path):
layer = Sdf.Find(layer_identifier)
if not layer:
return False
prim_spec = layer.GetPrimAtPath(prim_spec_path)
return not not prim_spec
@staticmethod
def get_sublayer_identifier(layer_identifier: str, sublayer_position: int):
parent_layer = Sdf.Find(layer_identifier)
if not parent_layer:
return None
sublayer_paths = parent_layer.subLayerPaths
if len(sublayer_paths) == 0:
return None
if sublayer_position >= len(sublayer_paths) or (sublayer_position != -1 and sublayer_position < 0):
return None
sublayer_identifier = parent_layer.ComputeAbsolutePath(sublayer_paths[sublayer_position])
return sublayer_identifier
@staticmethod
def restore_authoring_layer_from_custom_data(stage):
root_layer = stage.GetRootLayer()
try:
# OM-57080: it will through exception if meta includes invalid fields.
custom_data = root_layer.customLayerData
if LayerUtils.LAYER_OMNI_CUSTOM_KEY in custom_data:
omni_data = custom_data[LayerUtils.LAYER_OMNI_CUSTOM_KEY]
if LayerUtils.LAYER_AUTHORING_LAYER_CUSTOM_KEY in omni_data:
authoring_layer = omni_data[LayerUtils.LAYER_AUTHORING_LAYER_CUSTOM_KEY]
authoring_layer = root_layer.ComputeAbsolutePath(authoring_layer)
for layer in stage.GetLayerStack():
if layer.identifier == authoring_layer:
edit_target = Usd.EditTarget(layer)
stage.SetEditTarget(edit_target)
return
except Exception as e:
carb.log_error(f"Failed to restore authoring layer from custom data: {str(e)}.")
return
@staticmethod
def save_authoring_layer_to_custom_data(stage):
edit_target = stage.GetEditTarget()
if edit_target.GetLayer() and edit_target.GetLayer().anonymous:
return
root_layer = stage.GetRootLayer()
custom_data = root_layer.customLayerData
if LayerUtils.LAYER_OMNI_CUSTOM_KEY not in custom_data:
custom_data[LayerUtils.LAYER_OMNI_CUSTOM_KEY] = {}
omni_data = custom_data[LayerUtils.LAYER_OMNI_CUSTOM_KEY]
authoring_layer = edit_target.GetLayer().identifier
authoring_layer = PathUtils.compute_relative_path(root_layer.identifier, authoring_layer)
omni_data[LayerUtils.LAYER_AUTHORING_LAYER_CUSTOM_KEY] = authoring_layer
custom_data[LayerUtils.LAYER_OMNI_CUSTOM_KEY] = omni_data
root_layer.customLayerData = custom_data
@staticmethod
def _get_layer_custom_data_value(root_layer: Sdf.Layer, layer_identifier: str, key: str, default_value=None):
custom_data = root_layer.customLayerData
if LayerUtils.LAYER_OMNI_CUSTOM_KEY in custom_data:
omni_data = custom_data[LayerUtils.LAYER_OMNI_CUSTOM_KEY]
if key in omni_data:
data = omni_data[key]
layer_identifier = omni.client.normalize_url(layer_identifier)
for relatvie_path, value in data.items():
absolute_path = root_layer.ComputeAbsolutePath(relatvie_path)
if layer_identifier == absolute_path:
return value
return default_value
@staticmethod
def _set_layer_custom_data_value(root_layer: Sdf.Layer, layer_identifier: str, key: str, value):
if not layer_identifier:
return
custom_data = root_layer.customLayerData
if LayerUtils.LAYER_OMNI_CUSTOM_KEY not in custom_data:
custom_data[LayerUtils.LAYER_OMNI_CUSTOM_KEY] = {}
omni_data = custom_data[LayerUtils.LAYER_OMNI_CUSTOM_KEY]
relative_path = PathUtils.compute_relative_path(root_layer.identifier, layer_identifier)
if key in omni_data:
found = False
layer_identifier = omni.client.normalize_url(layer_identifier)
for path, _ in omni_data[key].items():
absolute_path = root_layer.ComputeAbsolutePath(path)
if layer_identifier == absolute_path:
omni_data[key][path] = value
found = True
break
if not found:
omni_data[key][relative_path] = value
else:
omni_data[key] = {relative_path: value}
custom_data[LayerUtils.LAYER_OMNI_CUSTOM_KEY] = omni_data
root_layer.customLayerData = custom_data
@staticmethod
def _remove_layer_custom_data_by_key(root_layer: Sdf.Layer, layer_identifier: str, key: str):
if not layer_identifier:
return
custom_data = root_layer.customLayerData
if LayerUtils.LAYER_OMNI_CUSTOM_KEY in custom_data:
omni_data = custom_data[LayerUtils.LAYER_OMNI_CUSTOM_KEY]
if key in omni_data:
data = omni_data[key]
layer_identifier = omni.client.normalize_url(layer_identifier)
for path, _ in data.items():
absolute_path = root_layer.ComputeAbsolutePath(path)
if layer_identifier == absolute_path:
del data[path]
omni_data[key] = data
custom_data[LayerUtils.LAYER_OMNI_CUSTOM_KEY] = omni_data
root_layer.customLayerData = custom_data
break
@staticmethod
def get_layer_global_muteness(root_layer: Sdf.Layer, layer_identifier: str):
return LayerUtils._get_layer_custom_data_value(
root_layer, layer_identifier, LayerUtils.LAYER_MUTENESS_CUSTOM_KEY, False
)
@staticmethod
def set_layer_global_muteness(root_layer: Sdf.Layer, layer_identifier: str, muted: bool):
return LayerUtils._set_layer_custom_data_value(
root_layer, layer_identifier, LayerUtils.LAYER_MUTENESS_CUSTOM_KEY, muted
)
@staticmethod
def remove_layer_global_muteness(root_layer: Sdf.Layer, layer_identifier: str):
return LayerUtils._remove_layer_custom_data_by_key(
root_layer, layer_identifier, LayerUtils.LAYER_MUTENESS_CUSTOM_KEY
)
@staticmethod
def get_layer_lock_status(root_layer: Sdf.Layer, layer_identifier: str):
return LayerUtils._get_layer_custom_data_value(
root_layer, layer_identifier, LayerUtils.LAYER_LOCK_STATUS_CUSTOM_KEY, False
)
@staticmethod
def set_layer_lock_status(root_layer: Sdf.Layer, layer_identifier: str, locked: bool):
if root_layer.identifier == layer_identifier:
return
LayerUtils._set_layer_custom_data_value(
root_layer, layer_identifier, LayerUtils.LAYER_LOCK_STATUS_CUSTOM_KEY, locked
)
@staticmethod
def remove_layer_lock_status(root_layer: Sdf.Layer, layer_identifier: str):
return LayerUtils._remove_layer_custom_data_by_key(
root_layer, layer_identifier, LayerUtils.LAYER_LOCK_STATUS_CUSTOM_KEY
)
@staticmethod
def restore_muteness_from_custom_data(stage):
muted_layer_identifiers = []
unmuted_layer_identifiers = []
sublayers = LayerUtils.get_all_sublayers(stage)
for sublayer_identifier in sublayers:
if LayerUtils.get_layer_global_muteness(stage.GetRootLayer(), sublayer_identifier):
muted_layer_identifiers.append(sublayer_identifier)
else:
unmuted_layer_identifiers.append(sublayer_identifier)
stage.MuteAndUnmuteLayers(muted_layer_identifiers, unmuted_layer_identifiers)
@staticmethod
def remove_sublayer(layer: Sdf.Layer, position):
if len(layer.subLayerPaths) == 0:
return None
if position < -1 or position >= len(layer.subLayerPaths):
return None
layer_identifier = layer.ComputeAbsolutePath(layer.subLayerPaths[position])
del layer.subLayerPaths[position]
return layer_identifier
@staticmethod
def is_read_only_prim(prim):
if not prim.IsValid():
return False
no_delete = prim.GetMetadata("no_delete")
if no_delete is not None and no_delete is True:
return True
return False
@staticmethod
def remove_prim_spec(layer: Sdf.Layer, prim_spec_path: str):
"""Removes prim spec from layer."""
prim_spec = layer.GetPrimAtPath(prim_spec_path)
if not prim_spec:
return False
if prim_spec.nameParent:
name_parent = prim_spec.nameParent
else:
name_parent = layer.pseudoRoot
if not name_parent:
return False
name = prim_spec.name
if name in name_parent.nameChildren:
del name_parent.nameChildren[name]
return True
@staticmethod
def move_layer(
from_parent_layer_identifier,
from_sublayer_position,
to_parent_layer_identifier,
to_sublayer_position,
remove_source=False,
):
"""Move sublayer from source parent to position of target parent.
Args:
from_parent_layer_identifier: The parent of source sublayer.
from_sublayer_position: The sublayer position to be moved.
to_parent_layer_identifier: The parent of target sublayer.
to_sublayer_position: The sublayer position in target parent that source moves to.
remove_source: Removes the source sublayer or not from source parent after move.
If from_parent_layer_identifier == to_parent_layer_layer_identifier,
it will always be True.
Return:
True if it's successful, False otherwise,
"""
if (
from_parent_layer_identifier == to_parent_layer_identifier
and from_sublayer_position == to_sublayer_position
):
return True
from_parent_layer = Sdf.Find(from_parent_layer_identifier)
to_parent_layer = Sdf.Find(to_parent_layer_identifier)
if not from_parent_layer or not to_parent_layer:
carb.log_warn(
f"Move layer failed as layer {from_parent_layer_identifier} or {to_parent_layer_identifier} cannot be found."
)
return False
if len(from_parent_layer.subLayerPaths) == 0:
carb.log_warn(
f"Failed to move layer at position {from_sublayer_position} of parent {from_parent_layer_identifier}"
f" as parent has no sublayers."
)
return False
if (
from_sublayer_position >= len(from_parent_layer.subLayerPaths)
or from_sublayer_position < 0
or (to_sublayer_position != -1 and to_sublayer_position < 0)
):
carb.log_warn(
f"Failed to move layer at position {from_sublayer_position} of parent {from_parent_layer_identifier} to"
f" layer at position {to_sublayer_position} of parent {to_parent_layer_identifier}"
)
return False
src_sublayer_paths = from_parent_layer.subLayerPaths
sublayer_path = src_sublayer_paths[from_sublayer_position]
sublayer_path = from_parent_layer.ComputeAbsolutePath(sublayer_path)
# Holds sublayer to avoid it to be released during delete/insert.
sublayer = LayerUtils.find_layer(sublayer_path)
if remove_source:
del src_sublayer_paths[from_sublayer_position]
# Source layer is not in target parent or they are in the same parent
target_position = LayerUtils.get_sublayer_position_in_parent(to_parent_layer_identifier, sublayer_path)
if target_position == -1:
sublayer_path = PathUtils.compute_relative_path(to_parent_layer_identifier, sublayer_path)
dst_sublayer_paths = to_parent_layer.subLayerPaths
if to_sublayer_position > len(dst_sublayer_paths) or to_sublayer_position == -1:
to_sublayer_position = len(dst_sublayer_paths)
dst_sublayer_paths.insert(to_sublayer_position, sublayer_path)
return True
@staticmethod
def get_edit_target(stage) -> str:
return omni.usd.get_edit_target_identifier(stage)
@staticmethod
def set_edit_target(stage, layer_identifier):
return omni.usd.set_edit_target_by_identifier(stage, layer_identifier)
@staticmethod
def get_all_sublayers(stage, include_session_layers=False, include_only_omni_layers=False, include_anonymous_layers=True) -> List[str]:
return omni.usd.get_all_sublayers(stage, include_session_layers, include_only_omni_layers, include_anonymous_layers)
@staticmethod
def is_layer_writable(layer_identifier) -> bool:
if Sdf.Layer.IsAnonymousLayerIdentifier(layer_identifier):
return True
if not omni.usd.is_usd_writable_filetype(layer_identifier):
return False
return omni.usd.is_layer_writable(layer_identifier)
@staticmethod
def get_dirty_layers(stage, include_root_layer=True, include_only_omni_layers=False) -> List[str]:
dirty_layers = []
root_layer_identifier = stage.GetRootLayer().identifier
all_sublayer_identifiers = LayerUtils.get_all_sublayers(stage, True, include_only_omni_layers, False)
for sublayer_identifier in all_sublayer_identifiers:
if not include_root_layer and sublayer_identifier == root_layer_identifier:
continue
if sublayer_identifier.endswith('.live'):
continue
layer = Sdf.Find(sublayer_identifier)
if layer and layer.dirty:
dirty_layers.append(sublayer_identifier)
return dirty_layers
@staticmethod
def find_layer(layer_identifier):
try:
if Sdf.Layer.IsAnonymousLayerIdentifier(layer_identifier):
return Sdf.Find(layer_identifier)
else:
return Sdf.Layer.FindOrOpen(layer_identifier)
except Exception:
return None
@staticmethod
def get_all_layers_existence(stage):
layer_existence_map = {}
accessed_layers = []
layer_queue = [stage.GetRootLayer().identifier]
while len(layer_queue) > 0:
layer_path = layer_queue.pop(0)
reference_layer = LayerUtils.find_layer(layer_path)
accessed_layers.append(layer_path)
if not reference_layer:
layer_existence_map[layer_path] = False
else:
layer_existence_map[layer_path] = True
for reference in reference_layer.externalReferences:
if len(reference) > 0:
absolute_path = reference_layer.ComputeAbsolutePath(reference)
if absolute_path not in accessed_layers:
layer_queue.append(absolute_path)
return layer_existence_map
@staticmethod
def get_layer_version(layer_identifier: str) -> str:
if PathUtils.is_omni_path(layer_identifier):
(result, entry) = omni.client.stat(layer_identifier)
if result == omni.client.Result.OK:
return entry.version
return ""
# TODO Move version related code out
@staticmethod
def _is_versioning_enabled():
try:
import omni.kit.widget.versioning
enable_versioning = True
except Exception:
enable_versioning = False
return enable_versioning
@staticmethod
async def create_checkpoint_async(layer_identifier: Union[str, List[str]], comment: str, force=False):
if not LayerUtils._is_versioning_enabled():
return
if isinstance(layer_identifier, list):
identifiers = layer_identifier
else:
identifiers = [layer_identifier]
success_layers = []
failed_layers = []
async def check_server_support_and_create_checkpoint(identifier):
result, server_info = await omni.client.get_server_info_async(identifier)
if result == omni.client.Result.OK and server_info and server_info.checkpoints_enabled:
result, _ = await omni.client.create_checkpoint_async(identifier, comment, force)
if result == omni.client.Result.OK or result == omni.client.Result.ERROR_ALREADY_EXISTS:
success_layers.append(identifier)
else:
failed_layers.append(identifier)
carb.log_error(f"Failed to create checkpoint for layer {identifier}: {result}.")
all_futures = []
for identifier in identifiers:
all_futures.append(asyncio.ensure_future(check_server_support_and_create_checkpoint(identifier)))
await asyncio.wait(all_futures)
return success_layers, failed_layers
@staticmethod
def create_checkpoint(layer_identifier: Union[str, List[str]], comment: str, force=False):
asyncio.ensure_future(LayerUtils.create_checkpoint_async(layer_identifier, comment, force))
@staticmethod
async def create_checkpoint_for_stage_async(stage, comment: str, only_dirty_layers=False, force=False):
if only_dirty_layers:
all_layers = LayerUtils.get_dirty_layers(stage, True)
else:
all_layers = LayerUtils.get_all_sublayers(stage, False, True, False)
return await LayerUtils.create_checkpoint_async(all_layers, comment, force)
| 26,301 | Python | 40.355346 | 139 | 0.624767 |
omniverse-code/kit/exts/omni.kit.usd.layers/omni/kit/usd/layers/impl/path_utils.py | import re
import traceback
import carb
import omni.client
from pxr import Sdf, Usd
class PathUtils:
@staticmethod
def is_omni_path(path: str):
return path.startswith("omniverse://")
@staticmethod
def compute_absolute_path(base_path, path):
"""Computes absolute path.
Args:
base_path (str): Absolute path that path will be based on.
path (str): Path to be combined.
"""
if Sdf.Layer.IsAnonymousLayerIdentifier(path) or Sdf.Layer.IsAnonymousLayerIdentifier(base_path):
return omni.client.normalize_url(path)
# If it's old path without server, it needs to strip omni prefix
if not path.startswith("omni://") and path.startswith("omni:/"):
path = path[5:]
return omni.client.combine_urls(base_path, path)
@staticmethod
def compute_relative_path(base_path, file_path):
"""Computes relative path given base path.
Args:
base_path (str): Absolute path that file path will be relative to.
file_path (str): Absolute path.
Return:
Relative path of file_path that is relative to base_path. If base_path
and file_path are not in the same domain or server, it will return file_path
directly.
"""
if Sdf.Layer.IsAnonymousLayerIdentifier(file_path) or Sdf.Layer.IsAnonymousLayerIdentifier(base_path):
return omni.client.normalize_url(file_path)
return omni.client.make_relative_url(base_path, file_path)
@staticmethod
async def exists_async(path):
try:
result, _ = await omni.client.stat_async(path)
return result == omni.client.Result.OK
except Exception as e:
traceback.print_exc()
carb.log_error(str(e))
return False
@staticmethod
def exists_sync(path):
try:
result, _ = omni.client.stat(path)
return result == omni.client.Result.OK
except Exception as e:
traceback.print_exc()
carb.log_error(str(e))
return False
| 2,154 | Python | 30.691176 | 110 | 0.608635 |
omniverse-code/kit/exts/omni.kit.usd.layers/omni/kit/usd/layers/impl/auto_authoring.py | from .._omni_kit_usd_layers import acquire_auto_authoring_interface, release_auto_authoring_interface, ILayersInstance
class AutoAuthoring:
def __init__(self, layers_instance: ILayersInstance, usd_context) -> None:
self._layers_instance = layers_instance
self._usd_context = usd_context
self._auto_authoring_interface = acquire_auto_authoring_interface()
@property
def usd_context(self):
return self._usd_context
def destroy(self):
self._layers_instance = None
release_auto_authoring_interface(self._auto_authoring_interface)
def is_enabled(self) -> bool:
return self._auto_authoring_interface.is_enabled(self._layers_instance)
def set_default_layer(self, layer_identifier: str):
self._auto_authoring_interface.set_default_layer(self._layers_instance, layer_identifier)
def get_default_layer(self) -> str:
return self._auto_authoring_interface.get_default_layer(self._layers_instance)
def is_auto_authoring_layer(self, layer_identifier: str) -> bool:
return self._auto_authoring_interface.is_auto_authoring_layer(self._layers_instance, layer_identifier)
| 1,182 | Python | 39.793102 | 118 | 0.70643 |
omniverse-code/kit/exts/omni.kit.usd.layers/docs/CHANGELOG.md | # Changelog
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
## [2.0.11] - 2023-02-16
- Only copy interested layer meta into live layer when it's in a live session.
## [2.0.10] - 2022-11-30
- Fix permission issue for sublayer live session if root layer is anonymous.
## [2.0.9] - 2022-11-09
- Fix flaky specs_locking test
- Fix unreliable tests for specs locking.
## [2.0.8] - 2022-11-02
- Add API for fetching logged-in user and id for layer.
- New events before/after merging live session.
## [2.0.7] - 2022-10-28
- Fix issue that session creates with different DNS alias cannot be found.
## [2.0.6] - 2022-10-27
- Fix UI issue that can show two sublayers as edit target.
## [2.0.5] - 2022-10-21
- Fix regression to merge live session to new layer.
## [2.0.4] - 2022-10-20
- Fix live session list refresh issue created by other connectors.
## [2.0.3] - 2022-10-15
- Fix issue to parse payload of LIVE_SESSION_LIST_CHANGED event.
## [2.0.2] - 2022-10-12
- Fix join live session by url that returns invalid session pointer.
## [2.0.1] - 2022-10-05
- Fix crash if a session is joined and it's removed from disk.
- Fix edit target switch issue after joining live session.
- Notification to remind saved session inside opened stage.
## [2.0.0] - 2022-09-29
- Re-work omni.kit.usd.layers to support sublayer live sesison.
## [1.1.8] - 2022-09-20
- Fix layer refresh if layer stack includes duplicate sublayer.
- Fix crash to switch muteness scope.
## [1.1.7] - 2022-09-13
- Ignore case for comparing session management message.
- Synchronize layer meta between root and live root layer in live session.
## [1.1.6] - 2022-08-09
- Fix layer version refresh
## [1.1.5] - 2022-08-05
- Add version safeguard for TOML file.
## [1.1.4] - 2022-07-25
- Fix duplicate outdate notification.
- Move outdate notification from layer view into this extension.
## [1.1.3] - 2022-07-20
- Add API to support link live layer to specific base layer for supporting projec workflow of other connectors.
## [1.1.2] - 2022-07-11
- Fix merge_changes_to_specific_layer and add tests.
## [1.1.1] - 2022-06-15
- Move channel management into this extension from layers view.
## [1.1.0] - 2022-05-31
- Supports new live workflow.
## [1.0.0] - 2022-03-31
- Initial extension.
- Refactoring omni.usd to move layers interface to this extension.
| 2,364 | Markdown | 28.936708 | 111 | 0.706853 |
omniverse-code/kit/exts/omni.kit.usd.layers/docs/README.md | # Omniverse Layers Extended Interfaces and Workflows
Extension omni.kit.usd.layers works to extend the USD to provide utilities and workflows around `sublayers` that are not provided by vanilla USD.
| 204 | Markdown | 24.624997 | 145 | 0.803922 |
omniverse-code/kit/exts/omni.kit.usd.layers/docs/index.rst | omni.kit.usd.layers
###########################
Introduction
************
Extension **omni.kit.usd.layers** works to extend the USD to provide utilities and workflows around **sublayers** that are not provided by vanilla USD. We extended several workflows on vanilla USD for working the the following purpose.
Layer State Management
======================
In Omniverse Kit, the following states are extended or encapsulated from vanilla USD for better access:
- **Writable or not**. USD only provides a runtime flag to make the layer read-only. It does not care about access permission from the file system. We extended this to include file system permissions.
- **Muteness**. Muteness in USD is not serialized. In Omniverse Kit, it defines the muteness scope so muteness will be serialized into USD based on the influence scope. It includes two scopes:
1. **Local**. Local scope is provided by vanilla USD, so all muteness operation will not be serialized.
2. **Global**. Global scope will serialize muteness for the next session and live update for multiple users.
- **Layer Lock**. Lock status is the concept to support locking layers so users cannot switch it as edit target nor it cannot be saved. It’s a flag saved inside the custom data of the layer to be locked. So it can be serialized and live updated. Lock is not like write permission, which only works during runtime, while write permission reflects the status of the filesystem.
- **Dirtiness**. If it has pending edits that are not saved yet.
- **Up-to-date or not**. If this layer in memory is out of sync with the version on the disk or Nucleus server.
Around those concepts, it provides APIs to query/change status, and provides event subscriptions for monitoring state updates.
Providing Extended Python APIs
==============================
It provides extended APIs for Python to access or subscribe states, which are not provided by vanilla USD. It includes:
- Subscriptions to filter interested custom data for Layer Property Window.
- Subscriptions to notify sublayer changes.
- Subscriptions to notify prim changes for a single layer.
New workflows
=============
Omniverse Kit also builds new workflows on top of vanilla USD, which includes:
- **Auto Authoring**. USD supports switching edit targets so that all authoring will take place in that specified layer. When it's working with multiple sublayers, this kind of freedom may cause experience issues. User has to be aware the changes made are not overridden in any stronger layer. We extend a new mode called **Auto Authoring** to improve it. In this mode, all changes will firstly go into a middle delegate layer and it will then distribute edits (per frame) into their corresponding layers where the edits have the strongest opinions. So it cannot switch edit targets freely, and users do not need to be aware of the existence of multi-sublayers and how USD will compose the changes.
- **Prim/Attributes Locking**. Omniverse Kit supports to lock prims/attributes. After locking, the prims/attributes cannot be edited.
- **Layer Linking (Experimental)**. Layer link is a concept to support linking prim changes to specific layers, and serialization of those links. So if the prims/attributes are linked, all the edits to those prims or attributes will be forwarded to the layers specified. `This is an experimental feature right now.`
Programming Guide
*****************
Currently, **omni.kit.usd.layers** is mainly used by **omni.kit.widget.layers** or **omni.kit.property.layer** for UI workflows. It supports both C++ and Python APIs to query layer states and control workflows.
Python
======
Here are the steps to use Python APIs for accessing different interfaces:
1. Imports package:
::
import omni.kit.usd.layers as layers
...
2. Gets layers instance to specific UsdContext:
::
layers_interface = layers.get_layers(usd_context_name or instance_of_usd_context)
...
3. Gets specific interfaces:
::
layers_state = layers_interface.get_layers_state()
specs_linking = layers_interface.get_specs_linking()
specs_locking = layers_interface.get_specs_locking()
...
4. If you want to subscribe states change from sublayers:
::
def on_events(events: carb.events.IEvent):
payload = layers.get_layer_event_payload(events)
if payload.event_type == layers.LayerEventType.XXXXXX:
...
...
subscription = layers.get_event_stream().create_subscription_to_pop(on_events, name="xxxx")
...
C++
===
C++ interfaces are exposed as pure Carbonite plugin, which you can refer to the headers **omni/kit/usd/layers/ILayers.h** and its helper **omni/kit/usd/layers/LayersHelper.hpp**.
.. toctree::
:maxdepth: 1
CHANGELOG
| 4,753 | reStructuredText | 46.069306 | 699 | 0.740375 |
omniverse-code/kit/exts/omni.iray.settings.core/config/extension.toml | [package]
# Semantic Versioning is used: https://semver.org/
version = "0.6.4"
# Lists people or organizations that are considered the "authors" of the package.
authors = ["NVIDIA"]
# The title and description fields are primarily for displaying extension info in UI
title = "Iray Renderer Settings"
description="All the settings to Control Iray"
# Path (relative to the root) or content of readme markdown file for UI.
readme = "docs/README.md"
# URL of the extension source repository.
repository = ""
# One of categories for UI.
category = "Rendering"
# Keywords for the extension
keywords = ["kit", "iray", "rendering"]
# Location of change log file in target (final) folder of extension, relative to the root. Can also be just a content
# of it instead of file path. More info on writing changelog: https://keepachangelog.com/en/1.0.0/
changelog="docs/CHANGELOG.md"
# Preview image and icon. Folder named "data" automatically goes in git lfs (see .gitattributes file).
# Preview image is shown in "Overview" of Extensions window. Screenshot of an extension might be a good preview image.
preview_image = "data/preview.png"
# Icon is shown in Extensions window, it is recommended to be square, of size 256x256.
icon = "data/icon.png"
# this need to be activated with iray on starup
toggleable = false
[dependencies]
"omni.kit.commands" = {}
"omni.ui" = {}
"omni.rtx.window.settings" = {}
# Should always load after omni.hydra.iray, but keep as an optional dependency
"omni.hydra.iray" = {optional = true}
# Main python module this extension provides, it will be publicly available as "import omni.example.hello".
[[python.module]]
name = "omni.iray.settings.core"
[[test]]
# Linux: rtx/iray/TexCopyIray.compute.hlsl issue
viewport_legacy_only = true
args = [
# OM-20773, OM-25786, OM-20773: Shutdown ordering of GPU foundation casuing issues.
"--/app/fastShutdown=true",
"--/app/window/dpiScaleOverride=1.0",
"--/app/window/scaleToMonitor=false",
"--/renderer/enabled=iray",
"--/renderer/active=iray",
"--/app/renderer/resolution/width=128",
"--/app/renderer/resolution/height=128",
"--no-window"
]
dependencies = [
"omni.kit.renderer.capture",
"omni.kit.mainwindow",
"omni.kit.ui_test",
"omni.hydra.iray",
"omni.kit.window.viewport",
]
stdoutFailPatterns.exclude = [
"*[Error] [gpu.foundation.plugin]*",
"*[Error] [carb.scenerenderer-iray.plugin] Failed to create rtx::postprocessing::TonemappingContext*"
]
unreliable = true # OM-54840
pythonTests.unreliable = [
"*test_combo_box_setting", # OM-53610
"*test_int_setting", # OM-53610
]
| 2,635 | TOML | 29.651162 | 118 | 0.713852 |
omniverse-code/kit/exts/omni.iray.settings.core/omni/iray/settings/core/extension.py | from typing import Union
import omni.ext
import omni.ui as ui
from omni.rtx.window.settings import RendererSettingsFactory
from .widgets.common_widgets import CommonIRaySettingStack
class IRaySettingsExtension(omni.ext.IExt):
"""The entry point for RTX - Accurate (Iray) Settings Window"""
MENU_PATH = "Rendering"
def on_startup(self):
RendererSettingsFactory.register_renderer("Accurate (Iray)", ["Common", "Accurate (Iray)", "Post Processing"])
RendererSettingsFactory.register_stack("Accurate (Iray)", CommonIRaySettingStack)
def on_shutdown(self):
RendererSettingsFactory.unregister_renderer("Accurate (Iray)")
RendererSettingsFactory.unregister_stack("Accurate (Iray)")
RendererSettingsFactory.build_ui()
| 773 | Python | 32.652172 | 118 | 0.742561 |
omniverse-code/kit/exts/omni.iray.settings.core/omni/iray/settings/core/widgets/common_widgets.py | from omni.kit.widget.settings import SettingType
import omni.ui as ui
import carb
import omni.kit.app
from omni.rtx.window.settings.rtx_settings_stack import RTXSettingsStack
from omni.rtx.window.settings.settings_collection_frame import SettingsCollectionFrame
from omni.rtx.window.settings.rendersettingsdefaults import SettingsDefaultHandler
from .heatmap_bar import *
class DeviceSettingsFrame(SettingsCollectionFrame):
def _build_ui(self):
""" RTX - Accurate (Iray) Device Settings """
# CPU
self._add_setting(
SettingType.BOOL, "CPU Enabled", "/iray/device/cpuEnabled", has_reset=False, tooltip="Enable/Disable CPU"
)
self._change_cb = omni.kit.app.SettingChangeSubscription("/iray/device/gpuCount", self._on_change)
# GPU selection
gpuCount = self._settings.get("/iray/device/gpuCount")
if gpuCount is not None and gpuCount > 0:
gpuCount = int(gpuCount)
for deviceIdx in range(0, gpuCount):
isAttachedToDisplay = self._settings.get("/iray/device/gpu" + str(deviceIdx) + "/isAttachedToDisplay")
name = self._settings.get("/iray/device/gpu" + str(deviceIdx) + "/name")
deviceName = "GPU " + str(deviceIdx) + " " + name + (" (display)" if isAttachedToDisplay else "")
self._add_setting(
SettingType.BOOL,
deviceName,
"/iray/device/gpu" + str(deviceIdx) + "/enabled",
has_reset=False,
tooltip="Enable/Disable GPU " + str(deviceIdx),
)
else:
ui.Label("GPU settings available when Iray is in use");
class SchedulerSettingsFrame(SettingsCollectionFrame):
def _build_ui(self):
iray_scheduler_mode_items = {"Interactive": "interactive", "Final Frame": "batch"}
schedulerModeCombo = self._add_setting_combo(
"Scheduler Mode",
"/rtx/iray/scheduler_mode",
iray_scheduler_mode_items,
tooltip="Optimize for interactivity or faster convergence",
)
self._add_setting(
SettingType.INT,
"Samples Limit",
"/rtx/iray/progressive_rendering_max_samples",
-1,
1048576,
1000,
tooltip="Stop rendering after this amount of samples (-1 means never stop)",
)
maxQualityEnabledWidget = self._add_setting(
SettingType.BOOL,
"Quality Limit Enabled",
"/rtx/iray/progressive_rendering_quality_enabled",
tooltip="Activate quality estimation (only available in Final Frame mode)",
)
maxQualityWidget = self._add_setting(
SettingType.FLOAT,
"Quality Limit",
"/rtx/iray/progressive_rendering_quality",
0.0,
1.0,
0.005,
tooltip="Stop rendering when the image has reached this quality threshold between 0.0 and 1.0 (fully converged)",
)
clampSpp = self._settings.get("/rtx/iray/max_min_samples_per_update")
if clampSpp is not None:
if clampSpp <= 1: # better 0, but setting range = (1,1) completely disables the UI control range
clampSpp = 512
self._add_setting(
SettingType.INT,
"Samples per Frame",
"/rtx/iray/min_samples_per_update",
1,
clampSpp,
tooltip="Render this many samples per frame",
)
class RenderSettingsFrame(SettingsCollectionFrame):
def _build_ui(self):
canvas_type_items = {
"Beauty": "result",
"Diffuse": "diffuse",
"Specular": "specular",
"Glossy": "glossy",
"Emission": "emission",
"Custom LPE": "custom_lpe",
"Alpha": "alpha",
"Illuminance": "irradiance",
"Luminance": "luminance",
"Ray Length": "ray_length",
"Depth": "depth",
"Normal": "normal",
"UVWs[0]": "texture_coordinate[0]",
"UVWs[1]": "texture_coordinate[1]",
"Material ID": "material_tag",
}
if self._settings.get("/rtx/iray/debugMotion") == True:
canvas_type_items["Motion Vectors"] = "motion_vector";
self._add_setting_combo(
"Canvas", "/rtx/iray/canvasType", canvas_type_items, tooltip="Render specified canvas type"
)
self._change_cb = omni.kit.app.SettingChangeSubscription("/rtx/iray/canvasType", self._on_change)
if self._settings.get("/rtx/iray/canvasType") == "diffuse":
self._add_setting(
SettingType.STRING,
"LPE",
"/rtx/iray/lpeDiffuse",
tooltip="Diffuse light path expression",
)
if self._settings.get("/rtx/iray/canvasType") == "glossy":
self._add_setting(
SettingType.STRING,
"LPE",
"/rtx/iray/lpeGlossy",
tooltip="Glossy light path expression",
)
if self._settings.get("/rtx/iray/canvasType") == "specular":
self._add_setting(
SettingType.STRING,
"LPE",
"/rtx/iray/lpeSpecular",
tooltip="Specular light path expression",
)
if self._settings.get("/rtx/iray/canvasType") == "emission":
self._add_setting(
SettingType.STRING,
"LPE",
"/rtx/iray/lpeEmission",
tooltip="Emissive light path expression",
)
if self._settings.get("/rtx/iray/canvasType") == "custom_lpe":
self._add_setting(
SettingType.STRING,
"LPE",
"/rtx/iray/lpeCustom",
tooltip="Custom light path expression",
)
if self._settings.get("/rtx/iray/canvasType") == "alpha":
self._add_setting(
SettingType.STRING,
"Alpha LPE",
"/rtx/iray/lpeAlpha",
tooltip="Alpha light path expression",
)
if self._settings.get("/rtx/iray/canvasType") == "irradiance":
self._add_setting(
SettingType.STRING,
"Illuminance Value",
"/iray/illuminanceVal",
tooltip="The Illuminance value at the last clicked position",)
self._add_setting(
SettingType.BOOL, "Auto Range", "/rtx/iray/illuminanceAutoRange", tooltip="Enable/disable auto range",)
self._change_cb_2 = omni.kit.app.SettingChangeSubscription("/rtx/iray/illuminanceAutoRange", self._on_change)
if self._settings.get("/rtx/iray/illuminanceAutoRange") == True:
self._add_setting(
SettingType.FLOAT,
" Range Min",
"/iray/illuminanceMin",
tooltip="Min illuminance range value", has_reset=False)
self._add_setting(
SettingType.FLOAT,
" Range Max",
"/iray/illuminanceMax",
tooltip="Max illuminance range value", has_reset=False)
else:
self._add_setting(
SettingType.FLOAT,
" User Range Min",
"/rtx/iray/illuminanceUserMin",
tooltip="User min illuminance range value")
self._add_setting(
SettingType.FLOAT,
" User Range Max",
"/rtx/iray/illuminanceUserMax",
tooltip="User max illuminance range value",)
with ui.HStack():
ui.Button("Show Illuminance Legend", clicked_fn=self._on_open_illuminance_bar)
if self._settings.get("/rtx/iray/canvasType") == "luminance":
self._add_setting(
SettingType.STRING,
"Luminance Value",
"/iray/luminanceVal",
tooltip="The luminance value at the last clicked position",)
self._add_setting(
SettingType.BOOL, "Auto Range", "/rtx/iray/luminanceAutoRange", tooltip="Enable/disable auto range",)
self._change_cb_3 = omni.kit.app.SettingChangeSubscription("/rtx/iray/luminanceAutoRange", self._on_change)
if self._settings.get("/rtx/iray/luminanceAutoRange") == True:
self._add_setting(
SettingType.FLOAT,
" Range Min",
"/iray/luminanceMin",
tooltip="Min luminance range value", has_reset=False)
self._add_setting(
SettingType.FLOAT,
" Range Max",
"/iray/luminanceMax",
tooltip="Max luminance range value", has_reset=False)
else:
self._add_setting(
SettingType.FLOAT,
" User Range Min",
"/rtx/iray/luminanceUserMin",
tooltip="User min luminance range value")
self._add_setting(
SettingType.FLOAT,
" User Range Max",
"/rtx/iray/luminanceUserMax",
tooltip="User max luminance range value",)
with ui.HStack():
ui.Button("Show Luminance Legend", clicked_fn=self._on_open_luminance_bar)
self._add_setting(
SettingType.BOOL, "Denoiser", "/rtx/iray/optixDenoiser/enabled", tooltip="Enable/Disable Denoising"
)
self._add_setting(
SettingType.BOOL,
"Caustic Sampler",
"/rtx/iray/iray_caustic_sampler",
tooltip="Enable to improve the quality of caustics (can impact performance)",
)
self._add_setting(
SettingType.BOOL,
"Guided Sampling",
"/rtx/iray/guided_sampling",
tooltip="Enable to improve overall convergence speed, especially for indoor scenes"
)
self._add_setting(
SettingType.BOOL,
"Backplate Refraction",
"/rtx/iray/refract_backplate",
tooltip="Forces perfectly specular materials to respect the virtual backplate (in addition to the environment)",
)
# see LightTypes.hlslh for enum
show_lights_settings = {
"Per-Light Enable": 0,
"Force Enable": 1,
"Force Disable": 2
}
self._add_setting_combo("Light Visibility In Primary Rays", "/rtx/iray/showLights", show_lights_settings, tooltip="Specify how lights are made visible in primary rays")
def _on_open_illuminance_bar(self):
if not hasattr(self, '_illuminance_legend') or self._illuminance_legend is None:
self._illuminance_legend = ui.Window("RTX - Accurate Illuminance Legend", width=400, height=100)
self._illuminance_legend.set_visibility_changed_fn(self._on_illum_window_visibility_changed)
with self._illuminance_legend.frame:
with ui.VStack():
IrayHeatmapBarWidget(self._illuminance_legend, 400, 100, 5, "illumination")
else:
self._illuminance_legend.visible = True
def _on_open_luminance_bar(self):
if not hasattr(self, '_luminance_legend') or self._luminance_legend is None:
self._luminance_legend = ui.Window("RTX - Accurate Luminance Legend", width=400, height=100)
self._luminance_legend.set_visibility_changed_fn(self._on_lum_window_visibility_changed)
with self._luminance_legend.frame:
with ui.VStack():
IrayHeatmapBarWidget(self._luminance_legend, 400, 100, 5, "lumination")
else:
self._luminance_legend.visible = True
def _on_illum_window_visibility_changed(self, val):
pass
def _on_lum_window_visibility_changed(self, val):
pass
def destroy(self):
if hasattr(self, '_illuminance_legend') and self._illuminance_legend:
self._illuminance_legend.destroy()
self._illuminance_legend = None
if hasattr(self, '_luminance_legend') and self._luminance_legend:
self._luminance_legend.destroy()
self._luminance_legend = None
super().destroy()
class SpectralRenderSettingsFrame(SettingsCollectionFrame):
def _build_ui(self):
""" Spectral Rendering """
self._add_setting(
SettingType.BOOL,
"Spectral Rendering",
"/rtx/iray/iray_spectral_rendering",
tooltip="Enable/Disable spectral rendering (light transport simulated on a continuous range of wavelengths)",
)
self._change_cb = omni.kit.app.SettingChangeSubscription("/rtx/iray/iray_spectral_rendering", self._on_change)
if self._settings.get("/rtx/iray/iray_spectral_rendering"):
iray_spectral_conversion_color_space_items = {
"CIE XYZ": "xyz",
"Rec.709/linear sRGB": "rec709",
"Rec.2020": "rec2020",
"ACES2065-1": "aces",
"ACEScg": "acescg",
}
self._add_setting_combo(
"Conversion Color Space",
"/rtx/iray/iray_spectral_conversion_color_space",
iray_spectral_conversion_color_space_items,
tooltip="The color space of the color data (also used without spectral rendering if spectral data is provided)",
)
iray_spectral_conversion_intent_items = {"Natural": "natural", "Faithful": "faithful"}
self._add_setting_combo(
"Conversion Intent",
"/rtx/iray/iray_spectral_conversion_intent",
iray_spectral_conversion_intent_items,
tooltip="Natural for more smoothness or Faithful for more compatibility with color rendering (only used with rec709 color space)",
)
iray_spectral_observer_items = {"CIE 1931 2 degree": "cie1931", "CIE 1964 10 degree": "cie1964"}
self._add_setting_combo(
"Color Matching",
"/rtx/iray/iray_spectral_observer",
iray_spectral_observer_items,
tooltip="Specifies the color matching function to use",
)
def destroy(self):
self._change_cb = None
super().destroy()
class GroundSettingsFrame(SettingsCollectionFrame):
def _build_ui(self):
self._add_setting(
SettingType.BOOL,
"Enable",
"/rtx/iray/environment_dome_ground",
tooltip="Enable/Disable an implicit ground plane to catch shadows (requires a dome light in the scene)",
)
self._change_cb = omni.kit.app.SettingChangeSubscription("/rtx/iray/environment_dome_ground", self._on_change)
if self._settings.get("/rtx/iray/environment_dome_ground"):
self._add_setting(
SettingType.COLOR3,
"Reflectivity",
"/rtx/iray/environment_dome_ground_reflectivity",
tooltip="The amount of reflectivity of the ground plane",
)
self._add_setting(
SettingType.FLOAT,
"Glossiness",
"/rtx/iray/environment_dome_ground_glossiness",
0,
10000000,
100,
tooltip="Sets the glossiness of the reflection from 0 (diffuse) to 10000000 (perfect mirror)",
)
self._add_setting(
SettingType.FLOAT,
"Shadow Intensity",
"/rtx/iray/environment_dome_ground_shadow_intensity",
0,
2,
0.01,
tooltip="Controls shadow intensity where 0.0 is no shadow, 1.0 is normal shadow, and 2.0 is very heavy shadow",
)
self._add_setting(
SettingType.DOUBLE3,
"Position",
"/rtx/iray/environment_dome_ground_position",
tooltip="The origin of the ground plane",
)
self._add_setting(
SettingType.DOUBLE3,
"Rotation Axis",
"/rtx/iray/environment_dome_rotation_axis",
tooltip="Defines rotation axis and up vector of the ground plane, (0,1,0) for y-up scenes and (0,0,1) for z-up scenes",
)
self._add_setting(
SettingType.FLOAT,
"Environment Rotation",
"/rtx/iray/environment_dome_rotation_angle",
0,
360,
tooltip="Inexpensive rotation of the dome around the specified rotation axis from 0 to 360 degrees",
)
def destroy(self):
self._change_cb = None
super().destroy()
class IrayServerSettingsFrame(SettingsCollectionFrame):
def _build_ui(self):
self._change_cb = omni.kit.app.SettingChangeSubscription("/iray/iray_server/state", self._on_change)
self._change_cb_2 = omni.kit.app.SettingChangeSubscription("/iray/iray_server/bridge_upload_message", self._on_change)
#self._change_cb_2 = omni.kit.app.SettingChangeSubscription("/iray/iray_server/queue_state", self._on_change)
#self._change_cb_3 = omni.kit.app.SettingChangeSubscription("/iray/iray_server/job_state", self._on_change)
def do_connect():
print("Connecting to server...")
self._settings.set("/iray/iray_server/state", "connecting")
self._settings.set("/iray/iray_server/connect", True)
def do_cancel_connect():
print("Cancelling connection to server...")
self._settings.set("/iray/iray_server/connect", False)
#self._settings.set("/iray/iray_server/state", "disconnected")
def do_disconnect():
print("Disconnecting from server...")
self._settings.set("/iray/iray_server/connect", False)
#self._settings.set("/iray/iray_server/state", "disconnected")
def do_queue_connect():
print("Connecting to Queue Manager...")
self._settings.set("/iray/iray_server/queue_state", "connecting")
self._settings.set("/iray/iray_server/queue_msg", "Connecting to server...")
self._settings.set("/iray/iray_server/queue_connect", "true")
def do_queue_disconnect():
print("Disconnecting from Queue Manager...")
self._settings.set("/iray/iray_server/queue_connect", "false")
self._settings.set("/iray/iray_server/queue_state", "disconnected")
self._settings.set("/iray/iray_server/queue_msg", "")
def do_add_job():
print("Adding server job...")
self._settings.set("/iray/iray_server/add_job", True)
self._settings.set("/iray/iray_server/queue_msg", "")
def do_cancel_job():
print("Cancling server job...")
self._settings.set("/iray/iray_server/job_state", "idle")
self._settings.set("/iray/iray_server/queue_msg", "")
state = self._settings.get("/iray/iray_server/state")
if state == "disconnected" or state == "error":
self._add_setting(
SettingType.STRING,
"Server Address",
"/rtx/iray/iray_server/address",
tooltip="The address to the Iray Server to connect to",
)
self._add_setting(
SettingType.INT,
"Server Port",
"/rtx/iray/iray_server/port",
0,
255,
tooltip="The Iray Server port to connect to",
)
self._add_setting(
SettingType.BOOL,
"Use Encryption",
"/rtx/iray/iray_server/ssl",
tooltip="Enable ssl encrytion. Note that the server must be set up to support this.",
)
self._add_setting(
SettingType.STRING,
"User Name",
"/rtx/iray/iray_server/user",
tooltip="Iray Server user",
)
self._add_setting(
SettingType.STRING,
"Password",
"/iray/iray_server/pwd",
tooltip="Iray Server user password",
)
# Bridge streaming options
#ui.Label("Streaming", alignment=ui.Alignment.CENTER)
if state == "connected":
ui.Label("Connected to " + self._settings.get("/rtx/iray/iray_server/user") + "@" + self._settings.get("/rtx/iray/iray_server/address") + ":" + str(self._settings.get("/rtx/iray/iray_server/port")), style={"color": 0xFFFFFFFF});
self._add_setting(SettingType.BOOL, "Cloud rendering","/iray/iray_server/cloud_rendering", tooltip="Enable cloud rendering.")
if self._settings.get("/iray/iray_server/bridge_upload_state") == "detecting":
ui.Label("Detecting changes...");
elif self._settings.get("/iray/iray_server/bridge_upload_state") == "calculating":
ui.Label("Calculating hashes...");
elif self._settings.get("/iray/iray_server/bridge_upload_state") == "cache_status":
ui.Label("Querying cache status...");
elif self._settings.get("/iray/iray_server/bridge_upload_state") == "uploading":
ui.Label("Uploading data...");
elif self._settings.get("/iray/iray_server/bridge_upload_state") == "waiting":
ui.Label("Server processing data...");
#else:
# ui.Label("Idle");
ui.Label(self._settings.get("/iray/iray_server/bridge_upload_message"));
ui.Button("Disconnect", tooltip="Disconnect from server", clicked_fn=do_disconnect, width=120)
elif state == "disconnected":
ui.Button("Connect", tooltip="Connect to server", clicked_fn=do_connect, width=120)
elif state == "connecting":
ui.Label("Connecting to server...");
ui.Button("Cancel", tooltip="Cancel connection", clicked_fn=do_cancel_connect, width=100)
elif state == None:
ui.Label("Switch to Accurate to connect to Iray Server", word_wrap=True);
else:
ui.Label("Failed to connect:", word_wrap=True, style={"color": 0xFF0000FF});
ui.Label(self._settings.get("/iray/iray_server/error_msg"));
ui.Button("Connect", tooltip="Connect to server", clicked_fn=do_connect, width=120)
# Queue manager options (currently not exposed)
if False:
ui.Label("Job Queue", alignment=ui.Alignment.CENTER)
if self._settings.get("/iray/iray_server/queue_state") == "disconnected":
ui.Button("Connect", tooltip="Connect to Queue Manager", clicked_fn=do_queue_connect, width=120)
ui.Label(self._settings.get("/iray/iray_server/queue_msg"));
elif self._settings.get("/iray/iray_server/queue_state") == "connected":
ui.Button("Disconnect", tooltip="Disconnect from Queue Manager", clicked_fn=do_queue_disconnect, width=120)
ui.Button("Add Job", tooltip="Add a job to the queue", clicked_fn=do_add_job, width=120)
ui.Label(self._settings.get("/iray/iray_server/queue_msg"));
else:
ui.Button("Connect", tooltip="Connect to Queue Manager", clicked_fn=do_queue_connect, width=120)
ui.Label(self._settings.get("/iray/iray_server/queue_msg"));
def destroy(self):
self._change_cb = None
super().destroy()
class AdvancedSettingsFrame(SettingsCollectionFrame):
def _build_ui(self):
self._add_setting(
SettingType.INT,
"Max Path Length",
"/rtx/iray/iray_max_path_length",
0,
500,
tooltip="Limits the number of light path bounces that contribute to the result (-1 means no limit)",
)
self._add_setting(
SettingType.BOOL,
"Firefly Filter",
"/rtx/iray/iray_firefly_filter",
tooltip="Enable/disable the firefly filter",
)
iray_instancing_items = {"On": "on", "Off": "off", "Auto": "auto"}
self._add_setting_combo(
"Instancing",
"/rtx/iray/iray_instancing",
iray_instancing_items,
tooltip="Off favors render speed, On favors interactivity when moving objects and saves memory when geometry is instanced, and Auto tries to balance this automatically",
)
self._add_setting(
SettingType.INT,
"Environment Resolution",
"/rtx/iray/environment_lighting_resolution",
64,
8192,
tooltip="The resolution to use for dome light baking",
)
self._add_setting(
SettingType.INT,
"Environment Sample Count",
"/rtx/iray/environment_lighting_shader_samples",
1,
1024,
tooltip="The sample count to use for dome light baking",
)
shadow_terminator_items = {"Off": "off", "On": "on", "Per Object" : "user"}
self._add_setting_combo(
"Smooth Shadow Terminator",
"/rtx/iray/shadow_terminator_offset_mode",
shadow_terminator_items,
tooltip="Enable/disable to override the per-object boolean attribute that controls if shading artifacts of curved surfaces with low detail shoud be reduced (can cause other problems, so more detail should always be preferred)",
)
self._add_setting(
SettingType.INT,
"Max value for \"Samples per Frame\"",
"/rtx/iray/max_min_samples_per_update",
2,
10240,
tooltip="Limits the maximum number of iterations per frame that can be set",
)
iray_texture_compression_items = {"None": "none", "Medium": "medium", "High": "high"}
self._add_setting_combo(
"Texture Compression",
"/rtx/iray/iray_texture_compression",
iray_texture_compression_items,
tooltip="Enable to reduces texture memory usage at the cost of visual quality",
)
self._add_setting(
SettingType.BOOL,
"Window Glass Optimization",
"/rtx/iray/windowGlassOptimization",
tooltip="Enable to get faster results when light is travelling through window panes, with the caveat of inconsistent shadowing in some corner cases",
)
self._add_setting(
SettingType.BOOL,
"Use Iray's built-in denoiser",
"/rtx/iray/useBuiltinDenoiser",
tooltip="When enabled, Iray's built-in denoiser is used. Temporal denoising is not available in this case.",
)
self._add_setting(
SettingType.BOOL,
"Temporal Denoising during Navigation",
"/rtx/iray/temporalDenoiser",
tooltip="When enabled, the temporal denoiser is used during navigation. The setting is ignored when denoising is disabled in the Rendering Options or Iray's built-in denoiser is used.",
)
self._add_setting(
SettingType.BOOL,
"Iray Selection Outline",
"/rtx/iray/selection_outline",
tooltip="Disable to skip rendering selection outlines for Iray.",
)
self._add_setting(
SettingType.STRING,
".mi File Path",
"/iray/export/exportFilename",
tooltip="Absolute path to the .mi file to export (for example c:\\scenes\\test.mi)",
)
def do_export():
print("Setting /iray/export/doExport=True setting for Iray..")
self._settings.set("/iray/export/doExport", True)
ui.Button("Export", tooltip="Export .mi file (experimental)", clicked_fn=do_export)
class CommonIRaySettingStack(RTXSettingsStack):
def __init__(self) -> None:
self._stack = ui.VStack(spacing=10, identifier=__class__.__name__)
self._settings = carb.settings.get_settings()
with self._stack:
gpuCount = None
if SettingsDefaultHandler().does_exist("/iray/device/gpuCount"):
gpuCount = self._settings.get("/iray/device/gpuCount")
if gpuCount is None:
ui.Label("Iray doesn't appear to be loaded....")
return
DeviceSettingsFrame("Device Settings", parent=self)
SchedulerSettingsFrame("Scheduler Settings", parent=self)
RenderSettingsFrame("Render Settings", parent=self)
SpectralRenderSettingsFrame("Spectral Rendering", parent=self)
GroundSettingsFrame("Matte Ground Plane Settings", parent=self)
IrayServerSettingsFrame("Iray Server Settings", parent=self)
AdvancedSettingsFrame("Advanced", parent=self)
ui.Spacer()
| 29,417 | Python | 41.328057 | 240 | 0.562634 |
omniverse-code/kit/exts/omni.iray.settings.core/omni/iray/settings/core/widgets/heatmap_bar.py | import omni.ui as ui
import carb.settings as settings
class IrayHeatmapBarWidget:
def __init__(self, parent_widget, width = 400, height = 20, steps = 4, type = "illumination"):
self._settings = settings.get_settings()
if type == "illumination":
self._unit = "Lux"
self._rangeMinSetting = "/iray/illuminanceMin"
self._rangeMaxSetting = "/iray/illuminanceMax"
self._rangeUserMinSetting = "/rtx/iray/illuminanceUserMin"
self._rangeUserMaxSetting = "/rtx/iray/illuminanceUserMax"
self._valueSetting = "/iray/illuminanceVal"
self._rangeAutoRangeSetting = "/rtx/iray/illuminanceAutoRange"
elif type == "lumination":
self._unit = "Nits"
self._rangeMinSetting = "/iray/luminanceMin"
self._rangeMaxSetting = "/iray/luminanceMax"
self._rangeUserMinSetting = "/rtx/iray/luminanceUserMin"
self._rangeUserMaxSetting = "/rtx/iray/luminanceUserMax"
self._valueSetting = "/iray/luminanceVal"
self._rangeAutoRangeSetting = "/rtx/iray/luminanceAutoRange"
else:
raise Exception("Unsupported heatmap type " + type)
self._parent_widget = parent_widget
self._width = width
self._height = height
self._labels = []
self._steps = steps
self._illum_min = 0.0
self._illum_max = 0.0
self._illum_value = 0.0
self._illum_value_str = "0.0 " + self._unit
self._illum_value_fraction = 0.0
self._update_values()
with ui.Frame():
with ui.VStack():
p = ui.Percent((100/self._steps) * 0.5)
# current illuminance value
with ui.HStack(height=20):
self._illum_value_spacer_l = ui.Spacer()
self._illum_value_label = ui.Label("0.0", alignment=ui.Alignment.CENTER, width=ui.Percent(p*2))
self._illum_value_spacer_r = ui.Spacer()
self._update_value()
# color bar
with ui.HStack(height=20):
ui.Spacer(width=ui.Percent(p))
pixels = [0] * width * height * 4
self._color_bar = ui.ByteImageProvider()
self._color_bar.set_bytes_data(pixels, [width, height])
ui.ImageWithProvider(self._color_bar, fill_policy=ui.IwpFillPolicy.IWP_STRETCH)
self._fill_color_bar(self._illum_value_fraction)
ui.Spacer(width=ui.Percent(p))
# ticks bar
with ui.HStack(height=10):
ui.Spacer(width=ui.Percent(p))
self._ticks_bar = ui.ByteImageProvider()
self._ticks_bar.set_bytes_data(pixels, [width, height])
ui.ImageWithProvider(self._ticks_bar,
fill_policy=ui.IwpFillPolicy.IWP_STRETCH,
)
self._fill_ticks_bar(0.0)
ui.Spacer(width=ui.Percent(p))
with ui.HStack(height=20):
for i in range(steps):
self._labels.append(ui.Label(str(i), alignment=ui.Alignment.CENTER))
self._update_legend()
self._settings.subscribe_to_node_change_events(self._rangeMinSetting, self._update_cb)
self._settings.subscribe_to_node_change_events(self._rangeMaxSetting, self._update_cb)
self._settings.subscribe_to_node_change_events(self._rangeUserMinSetting, self._update_cb)
self._settings.subscribe_to_node_change_events(self._rangeUserMaxSetting, self._update_cb)
self._settings.subscribe_to_node_change_events(self._rangeAutoRangeSetting,
self._update_cb)
self._settings.subscribe_to_node_change_events(self._valueSetting, self._update_cb)
def _fill_ticks_bar(self, val):
pixels = [0] * self._width * self._height * 4
l = int(self._width * val)
r = int((self._width) / (self._steps - 1))
for x in range(self._width):
for y in range(self._height):
p = y * self._width * 4 + x * 4
if x % r < 2 or x >= self._width - 2:
pixels[p + 0] = 255
pixels[p + 1] = 255
pixels[p + 2] = 255
pixels[p + 3] = 255
self._ticks_bar.set_bytes_data(pixels, [self._width, self._height])
def _fill_color_bar(self, val):
def get_color(t):
c = [255,255,255]
if t < 0.25:
c[0] = 0
c[1] = int(4.0 * t * 255)
elif t < 0.5:
c[0] = 0
c[2] = int((1.0 + 4.0 * (0.25 * 1.0 - t)) * 255)
elif t < 0.75:
c[0] = int(4.0 * (t - 0.5) * 255)
c[2] = 0
else:
c[1] = int((1.0 + 4.0 * (0.75 - t)) * 255)
c[2] = 0
return c
pixels = [255] * self._width * self._height * 4
l = int(self._width * val)
for x in range(self._width):
for y in range(self._height):
p = y * self._width * 4 + x * 4
if x >= l-1 and x <= l+1:
c = [255] * 4
else:
c = get_color(x / self._width)
pixels[p + 0] = c[0]
pixels[p + 1] = c[1]
pixels[p + 2] = c[2]
self._color_bar.set_bytes_data(pixels, [self._width, self._height])
def _update_values(self):
self._illum_min = float(self._settings.get(self._get_range_min_name()) or 0.0)
self._illum_max = float(self._settings.get(self._get_range_max_name()) or 10000.0)
if self._illum_max <= 0.0:
self._illum_max = 10000
self._illum_value_str = settings.get_settings().get(self._valueSetting) or "0.0 " + self._unit
try:
self._illum_value = float(self._illum_value_str.split()[0])
except:
self._illum_value = 0.0
d = self._illum_max - self._illum_min
if d == 0.0:
d = 1.0
if self._illum_value > self._illum_max:# can happen with user-range
self._illum_value = self._illum_max
if self._illum_value < self._illum_min:# can happen with user-range
self._illum_value = self._illum_min
self._illum_value_fraction = (self._illum_value - self._illum_min) / d
def _update_cb(self, item, event_type):
self._update_values()
self._update_legend()
self._update_value()
self._fill_color_bar(self._illum_value_fraction)
def _update_legend(self):
incr = (self._illum_max - self._illum_min) / (self._steps - 1)
for i in range(self._steps):
self._labels[i].text = "%.1f" % (self._illum_min + i * incr)
def _update_value(self):
w1 = 1/ (1 /self._steps + 1)
self._illum_value_label.text = self._illum_value_str
p = 0#ui.Percent((100/self._steps) * 0.5)
p0 = self._illum_value_fraction * w1 * 100
if p0-p <= 0:
p0 = 0
self._illum_value_spacer_l.width = ui.Percent(p0-p)
def _get_range_min_name(self):
auto_range = settings.get_settings().get(self._rangeAutoRangeSetting)
if auto_range:
return self._rangeMinSetting
return self._rangeUserMinSetting
def _get_range_max_name(self):
auto_range = settings.get_settings().get(self._rangeAutoRangeSetting)
if auto_range:
return self._rangeMaxSetting
return self._rangeUserMaxSetting
def __del__(self):
self._settings.unsubscribe_to_change_events(self._update_cb)
| 8,098 | Python | 39.90404 | 115 | 0.508644 |
omniverse-code/kit/exts/omni.iray.settings.core/omni/iray/settings/core/tests/__init__.py | from .test_settings import TestIRaySettingsUI | 45 | Python | 44.999955 | 45 | 0.888889 |
omniverse-code/kit/exts/omni.iray.settings.core/omni/iray/settings/core/tests/test_settings.py |
import carb
import omni.kit.test
import omni.usd
from omni.kit import ui_test
settings = carb.settings.get_settings()
class TestIRaySettingsUI(omni.kit.test.AsyncTestCase):
async def setUp(self):
super().setUp()
# We need to trigger Iray load to get the default render-settings values written to carb.settings
# Viewports state is valid without any open stage, and only loads renderer when stage is opened.
await omni.usd.get_context().new_stage_async()
await omni.kit.app.get_app().next_update_async()
def get_render_setings_window(self):
render_settings_window = ui_test.find("Render Settings")
render_settings_window.widget.height = 600
render_settings_window.widget.width = 600
render_settings_window.widget.visible = True
return render_settings_window
async def test_bool_checkbox_setting(self):
render_settings_window = self.get_render_setings_window()
self.assertTrue(render_settings_window)
setting_name = "/iray/device/cpuEnabled"
#We don't have to set the renderer as we assume only IRay is loaded
# Set initial value of the setting
settings.set(setting_name, False)
await omni.kit.app.get_app().next_update_async()
#choose the "Iray" tab in tthe render settings main combo
button = render_settings_window.find("Frame/VStack[0]/VStack[0]/ScrollingFrame[0]/ZStack[0]/CommonIRaySettingStack")
self.assertTrue(button)
await button.click()
#Get the collapsable frame for Device Settings and open it
collapsable_frame = render_settings_window.find("**/Device Settings")
self.assertTrue(collapsable_frame)
collapsable_frame.widget.collapsed = False
await omni.kit.app.get_app().next_update_async()
setting_hstack = collapsable_frame.find("/**/HStack_CPU_Enabled")
self.assertTrue(isinstance(setting_hstack.widget, omni.ui.HStack))
check_box = setting_hstack.find("**/CheckBox[0]")
self.assertTrue(isinstance(check_box.widget, omni.ui.CheckBox))
await check_box.click(human_delay_speed=10)
setting_value = settings.get(setting_name)
self.assertTrue(setting_value)
await check_box.click(human_delay_speed=10)
setting_value = settings.get(setting_name)
self.assertFalse(setting_value)
async def test_combo_box_setting(self):
render_settings_window = self.get_render_setings_window()
setting_name = "/rtx/iray/canvasType"
#We don't have to set the renderer as we assume only IRay is loaded
# Set initial value
settings.set(setting_name, "result")
await omni.kit.app.get_app().next_update_async()
#choose the "Iray" tab in each case
button = render_settings_window.find("Frame/VStack[0]/VStack[0]/ScrollingFrame[0]/ZStack[0]/CommonIRaySettingStack")
await button.click()
#Get the collapsable frame for Device Settings and open it
collapsable_frame = render_settings_window.find("**/Render Settings")
collapsable_frame.widget.collapsed = False
await omni.kit.app.get_app().next_update_async()
setting_hstack = collapsable_frame.find("/**/HStack_Canvas")
self.assertTrue(isinstance(setting_hstack.widget, omni.ui.HStack))
combo_box = setting_hstack.find("ComboBox[0]")
self.assertTrue(isinstance(combo_box.widget, omni.ui.ComboBox))
combo_box.model.get_item_value_model(None, 0).set_value(1)
await omni.kit.app.get_app().next_update_async()
await omni.kit.app.get_app().next_update_async()
await omni.kit.app.get_app().next_update_async()
await ui_test.human_delay(50)
value = settings.get(setting_name)
self.assertTrue(value == "diffuse", f"value is {value}")
async def test_int_setting(self):
render_settings_window = self.get_render_setings_window()
setting_name = "/rtx/iray/progressive_rendering_max_samples"
#We don't have to set the renderer as we assume only IRay is loaded
# Set initial value
settings.set(setting_name, 100)
await omni.kit.app.get_app().next_update_async()
await ui_test.human_delay(50)
#choose the "Iray" tab in each case
button = render_settings_window.find("Frame/VStack[0]/VStack[0]/ScrollingFrame[0]/ZStack[0]/CommonIRaySettingStack")
await button.click()
#Get the collapsable frame for Device Settings and open it
collapsable_frame = render_settings_window.find("**/Scheduler Settings")
collapsable_frame.widget.collapsed = False
await omni.kit.app.get_app().next_update_async()
setting_hstack = collapsable_frame.find("**/HStack_Samples_Limit")
self.assertTrue(isinstance(setting_hstack.widget, omni.ui.HStack))
slider = setting_hstack.find("IntDrag[0]")
self.assertTrue(slider)
self.assertTrue(isinstance(slider.widget, omni.ui.IntDrag))
await ui_test.human_delay(50)
await slider.input("200")
setting_value = settings.get(setting_name)
self.assertEqual(setting_value, 200)
| 5,220 | Python | 40.436508 | 124 | 0.67318 |
omniverse-code/kit/exts/omni.iray.settings.core/docs/CHANGELOG.md | # CHANGELOG
This document records all notable changes to ``omni.iray.settings.core`` extension.
This project adheres to `Semantic Versioning <https://semver.org/>`.
## [Unreleased]
### Added
### Changed
### Removed
## [0.6.4] - 2022-06-02
### Changed
- Fix issues when running tests without Viewport legacy.
## [0.6.3] - 2022-03-11
### Changed
- Rename from "Ground Truth" to "RTX - Accurate (Iray)"
## [0.6.2] - 2022-02-01
- Rename from "Iray" to "Ground Truth"
## [0.6.2] - 2020-11-27
### Changed
- Update to use new RenderSettingsFactory entry point in rtx.window.settings
## [0.6.1] - 2020-11-25
### Changed
- Fixed Bug in folder name
- Fixed core code which was early WIP
## [0.6.0] - 2020-11-05
### Changed
- initial release | 747 | Markdown | 17.243902 | 83 | 0.663989 |
omniverse-code/kit/exts/omni.iray.settings.core/docs/README.md | # Iray Settings [omni.iray.settings.core]
Iray Settings docs | 62 | Markdown | 19.999993 | 41 | 0.774194 |
omniverse-code/kit/exts/omni.stats/omni/stats/_stats.pyi | """
This module contains bindings to the C++ carb::stats::Istats interface.
This provides functionality to display various statistics through the editor UI.
"""
from __future__ import annotations
import omni.stats._stats
import typing
__all__ = [
"IStats",
"acquire_stats_interface",
"release_stats_interface"
]
class IStats():
def get_scope_count(self) -> int:
"""
Get the number of the scopes.
"""
def get_scopes(self) -> tuple:
"""
Get the scope nodes as tuple of dictionaries, which contains the information of all the scopes.
"""
def get_stats(self, scopeId: capsule) -> tuple:
"""
Get the stat nodes as tuple of dictionaries, which contains the information of all the stats within the specified scope.
"""
def get_stats_count(self, scopeId: capsule) -> int:
"""
Get the number of the stats within the specified scope.
"""
pass
def acquire_stats_interface(plugin_name: str = None, library_path: str = None) -> IStats:
pass
def release_stats_interface(arg0: IStats) -> None:
pass
| 1,147 | unknown | 29.210526 | 128 | 0.628596 |
omniverse-code/kit/exts/omni.stats/omni/stats/__init__.py | """This module contains bindings to C++ carb::stats::IStats interface.
All the function are in omni.stats.IStats class, to get it use get_editor_interface method, which caches
acquire interface call:
>>> import omni.stats
>>> e = omni.stats.get_stats_interface()
>>> print(f"Is UI hidden: {e.is_ui_hidden()}")
"""
from ._stats import *
# Cached stats instance pointer
def get_stats_interface() -> IStats:
"""Returns cached :class:` omni.stats.IStats` interface"""
if not hasattr(get_stats_interface, "stats"):
get_stats_interface.stats = acquire_stats_interface()
return get_stats_interface.stats
| 634 | Python | 30.749998 | 104 | 0.694006 |
omniverse-code/kit/exts/omni.kit.viewport.registry/omni/kit/viewport/registry/registry.py | # Copyright (c) 2021-2022, NVIDIA CORPORATION. All rights reserved.
#
# NVIDIA CORPORATION and its licensors retain all intellectual property
# and proprietary rights in and to this software, related documentation
# and any modifications thereto. Any use, reproduction, disclosure or
# distribution of this software and related documentation without an express
# license agreement from NVIDIA CORPORATION is strictly prohibited.
#
__all__ = ['_make_registry']
from typing import Callable, Sequence
class _Factory:
def __init__(self, factory: Callable, factory_id: str = None):
self.__factory = factory
self.__factory_id = factory_id if factory_id else factory.__class__.__name__
def __call__(self, *args, **kwargs):
return self.__factory(*args, **kwargs)
def __repr__(self) -> str:
return f'<class {self.__class__.__name__} {self.__factory_id}>'
@property
def factory_id(self):
return self.__factory_id
def _make_registry():
def invoke_load_callback(callback, recorded_known, factories):
for fac_object in factories:
if fac_object not in recorded_known:
recorded_known.add(fac_object)
callback(fac_object, True)
class _Registry():
"""Class to register and de-register viewport factories"""
__g_registered_factories = []
__g_registered_callbacks = {}
@classmethod
def add_notifier(cls, callback):
# Invoke the callback for all currently registered scenes
cls.__g_registered_callbacks[callback] = set()
invoke_load_callback(callback, cls.__g_registered_callbacks[callback], cls.__g_registered_factories)
@classmethod
def remove_notifier(cls, callback):
try:
del cls.__g_registered_callbacks[callback]
except KeyError:
pass
@classmethod
def ordered_factories(cls, order: Sequence[str], append_unkown: bool = True, ignore_unknown: Sequence[str] = tuple()):
ordered = []
known = set()
def find_factory(factory_id):
known.add(factory_id)
for fact_obj in cls.__g_registered_factories:
if fact_obj.factory_id == factory_id:
return fact_obj
return None
for factory_id in order:
ordered.append((factory_id, find_factory(factory_id)))
if append_unkown:
for fact_obj in cls.__g_registered_factories:
if (fact_obj.factory_id not in known) and (fact_obj.factory_id not in ignore_unknown):
ordered.append((fact_obj.factory_id, fact_obj))
return ordered
def __init__(self, factory, factory_id: str = None):
# Save the types for de-registration
self.__factory = _Factory(factory, factory_id)
# Record them in the global-list for notifiers registered later
self.__g_registered_factories.append(self.__factory)
# Invoke all callbacks for new items
for callback, recorded_known in self.__g_registered_callbacks.items():
invoke_load_callback(callback, recorded_known, [self.__factory])
def destroy(self):
fac_object = self.__factory
self.__factory = None
try:
self.__g_registered_factories.remove(fac_object)
except (ValueError, KeyError):
pass
for callback, recorded_known in self.__g_registered_callbacks.items():
if fac_object in recorded_known:
recorded_known.remove(fac_object)
try:
callback(fac_object, False)
except Exception:
import carb
import traceback
carb.log_error(f"Error unloading {fac_object.factory_id} with {callback}. Traceback:\n{traceback.format_exc()}")
def __del__(self):
self.destroy()
return _Registry
| 4,143 | Python | 38.094339 | 136 | 0.583635 |
omniverse-code/kit/exts/omni.kit.viewport.registry/omni/kit/viewport/registry/__init__.py | # Copyright (c) 2021-2022, NVIDIA CORPORATION. All rights reserved.
#
# NVIDIA CORPORATION and its licensors retain all intellectual property
# and proprietary rights in and to this software, related documentation
# and any modifications thereto. Any use, reproduction, disclosure or
# distribution of this software and related documentation without an express
# license agreement from NVIDIA CORPORATION is strictly prohibited.
#
__all__ = ['RegisterScene', 'RegisterViewportLayer']
from .registry import _make_registry
RegisterScene = _make_registry()
RegisterViewportLayer = _make_registry()
| 599 | Python | 38.999997 | 76 | 0.792988 |
omniverse-code/kit/exts/omni.kit.viewport.registry/omni/kit/viewport/registry/tests/__init__.py | ## Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.
##
## NVIDIA CORPORATION and its licensors retain all intellectual property
## and proprietary rights in and to this software, related documentation
## and any modifications thereto. Any use, reproduction, disclosure or
## distribution of this software and related documentation without an express
## license agreement from NVIDIA CORPORATION is strictly prohibited.
##
__all__ = ['TestRegistry']
import omni.kit.test
from omni.kit.test import AsyncTestCase
from .. import RegisterScene, RegisterViewportLayer
def _make_factory(id_str_in: str):
class _EmptyFactoy():
def __init__(self, id_str: str = id_str_in):
self.factory_id = id_str
return _EmptyFactoy
class TestRegistry(AsyncTestCase):
def setUp(self):
self.__scenes = {}
self.__layers = {}
super().setUp()
# After running each test
def tearDown(self):
self.__scenes = {}
self.__layers = {}
super().tearDown()
def ___scene_type_notification(self, factory, loading):
if loading:
self.__scenes[factory().factory_id] = None
else:
del self.__scenes[factory().factory_id]
def ___layer_type_notification(self, factory, loading):
if loading:
self.__layers[factory().factory_id] = None
else:
del self.__layers[factory().factory_id]
def __build_unique_ids(self, base_id: str, n: int = 10):
for i in range(n):
yield f'omni.kit.viewport.registry.{base_id}.factory_{i}'
async def test_add_remove_notifier(self):
RegisterScene.add_notifier(self.___scene_type_notification)
RegisterViewportLayer.add_notifier(self.___layer_type_notification)
RegisterScene.remove_notifier(self.___scene_type_notification)
RegisterViewportLayer.remove_notifier(self.___layer_type_notification)
async def test_factory_auto_destruct_scope(self):
RegisterScene.add_notifier(self.___scene_type_notification)
RegisterViewportLayer.add_notifier(self.___layer_type_notification)
# Register a bunch of factories
for sid in self.__build_unique_ids('scene'):
RegisterScene(_make_factory(sid), sid)
# Those factories are already out of scope, so they should have been de-regsitered
self.assertEqual(self.__scenes, {})
self.assertEqual(self.__layers, {})
# Register a bunch of factories
for lid in self.__build_unique_ids('layer'):
RegisterViewportLayer(_make_factory(lid), lid)
# Those factories are already out of scope, so they should have been de-regsitered
self.assertEqual(self.__scenes, {})
self.assertEqual(self.__layers, {})
RegisterScene.remove_notifier(self.___scene_type_notification)
RegisterViewportLayer.remove_notifier(self.___layer_type_notification)
async def test_factory_registration(self):
RegisterScene.add_notifier(self.___scene_type_notification)
RegisterViewportLayer.add_notifier(self.___layer_type_notification)
# Register a bunch of scene-factories, saving the returned subscription
scene_subs = {}
for sid in self.__build_unique_ids('scene'):
scene_subs[sid] = RegisterScene(_make_factory(sid), sid)
# Scenes should have been registered
self.assertEqual([sid for sid in self.__build_unique_ids('scene')], [sid for sid, fact in self.__scenes.items()])
# Layers should be empty
self.assertEqual([], [lid for lid, fact in self.__layers.items()])
# Register a bunch of layer-factories, saving the returned subscription
layer_subs = {}
for lid in self.__build_unique_ids('layer'):
layer_subs[lid] = RegisterViewportLayer(_make_factory(lid), lid)
# Layers should now have been registered
self.assertEqual([lid for lid in self.__build_unique_ids('layer')], [lid for lid, fact in self.__layers.items()])
# Scenes should have stayed the same
self.assertEqual([sid for sid in self.__build_unique_ids('scene')], [sid for sid, fact in self.__scenes.items()])
layer_subs = {}
# Layers should now have been all deregistered
self.assertEqual([], [lid for lid, fact in self.__layers.items()])
scene_subs = {}
# Scenes should now have been all deregistered
self.assertEqual([], [sid for sid, fact in self.__scenes.items()])
RegisterScene.remove_notifier(self.___scene_type_notification)
RegisterViewportLayer.remove_notifier(self.___layer_type_notification)
async def test_factory_ordering(self):
RegisterScene.add_notifier(self.___scene_type_notification)
# Register a bunch of scene-factories, saving the returned subscription
scene_subs = {}
for sid in self.__build_unique_ids('scene'):
scene_subs[sid] = RegisterScene(_make_factory(sid), sid)
# Scenes should have been registered
self.assertEqual([sid for sid in self.__build_unique_ids('scene')], [sid for sid, fact in self.__scenes.items()])
# Layers should be empty
self.assertEqual([], [lid for lid, fact in self.__layers.items()])
scene_ids = [sid for sid in self.__build_unique_ids('scene', 10)]
scene_ids_a = scene_ids[:5]
scene_ids_b = scene_ids[5:]
# Get ordered_factories, not including those not requested appened to end: [0-4]
self.assertEqual([sid for sid, fact in RegisterScene.ordered_factories(scene_ids_a, append_unkown=False)], scene_ids_a)
# Get ordered_factories, not including those not requested appened to end: [5-9]
self.assertEqual([sid for sid, fact in RegisterScene.ordered_factories(scene_ids_b, append_unkown=False)], scene_ids_b)
# Get ordered_factories, including those not requested appened to end: [0-4] + [5-9]
self.assertEqual([sid for sid, fact in RegisterScene.ordered_factories(scene_ids_a)], scene_ids_a + scene_ids_b)
# Get ordered_factories, including those not requested appened to end: [5-9] + [0-4]
self.assertEqual([sid for sid, fact in RegisterScene.ordered_factories(scene_ids_b)], scene_ids_b + scene_ids_a)
# Get ordered_factories, including those not requested appened to end, ignoring 9: [0-4] + [5-8]
self.assertEqual([sid for sid, fact in RegisterScene.ordered_factories(scene_ids_a, ignore_unknown=['omni.kit.viewport.registry.scene.factory_9'])], scene_ids_a + scene_ids_b[:-1])
# Get ordered_factories, including those not requested appened to end, ignoring 0: [5-9] + [1-4]
self.assertEqual([sid for sid, fact in RegisterScene.ordered_factories(scene_ids_b, ignore_unknown=['omni.kit.viewport.registry.scene.factory_0'])], scene_ids_b + scene_ids_a[1:])
RegisterScene.remove_notifier(self.___scene_type_notification)
| 6,950 | Python | 47.270833 | 188 | 0.662014 |
omniverse-code/kit/exts/omni.kit.test_suite.layer_window/omni/kit/test_suite/layer_window/tests/__init__.py | from .select_bound_objects_layer import *
| 43 | Python | 13.666662 | 41 | 0.767442 |
omniverse-code/kit/exts/omni.kit.test_suite.layer_window/omni/kit/test_suite/layer_window/tests/select_bound_objects_layer.py | ## Copyright (c) 2021, NVIDIA CORPORATION. All rights reserved.
##
## NVIDIA CORPORATION and its licensors retain all intellectual property
## and proprietary rights in and to this software, related documentation
## and any modifications thereto. Any use, reproduction, disclosure or
## distribution of this software and related documentation without an express
## license agreement from NVIDIA CORPORATION is strictly prohibited.
##
import omni.kit.test
import platform
import os
import unittest
import omni.kit.app
import omni.usd
from omni.kit.test.async_unittest import AsyncTestCase
from omni.kit import ui_test
from omni.kit.test_suite.helpers import open_stage, get_test_data_path, select_prims, wait_stage_loading, arrange_windows
class SelectBoundObjectsLayer(AsyncTestCase):
# Before running each test
async def setUp(self):
await arrange_windows("Layer")
await open_stage(get_test_data_path(__name__, "bound_shapes.usda"))
# After running each test
async def tearDown(self):
await wait_stage_loading()
DATA = [
("/World/Looks/OmniPBR", {"/World/Cone", "/World/Cylinder"}),
("/World/Looks/OmniGlass", {"/World/Cube", "/World/Sphere"}),
]
async def test_l1_select_bound_objects_layer(self):
await ui_test.find("Layer").focus()
usd_context = omni.usd.get_context()
for to_select, to_verify in self.DATA:
# select prim
await select_prims([to_select])
# wait for material to load & UI to refresh
await wait_stage_loading()
# right click on prim
await ui_test.find("Layer//Frame/**/TreeView[*]").find(f"**/Label[*].text=='{os.path.basename(to_select)}'").right_click()
# select context menu "Select Bound Objects"
await ui_test.select_context_menu("Select Bound Objects")
# get new selection
selected = usd_context.get_selection().get_selected_prim_paths()
# verify meshes are selected
self.assertSetEqual(set(selected), to_verify)
| 2,085 | Python | 36.249999 | 134 | 0.671463 |
omniverse-code/kit/exts/omni.kit.test_suite.layer_window/docs/README.md | # omni.kit.test_suite.layer_window
## omni.kit.test_suite.layer_window
Test Suite
| 86 | Markdown | 9.874999 | 35 | 0.732558 |
omniverse-code/kit/exts/omni.kit.test_suite.layer_window/docs/index.rst | omni.kit.test_suite.layer_window
################################
layer window tests
.. toctree::
:maxdepth: 1
CHANGELOG
| 130 | reStructuredText | 12.099999 | 32 | 0.523077 |
omniverse-code/kit/exts/omni.ui_query/omni/ui_query/query.py | from typing import Optional, Union, List, Tuple
import omni.ui as ui
import carb
class OmniUIQuery:
def __init__(self) -> None:
pass
@classmethod
def _child_widget(cls, widget: ui.Widget, path_segment: str, show_warnings=True) -> Union[ui.Widget, None]:
"""
Find a widget from a path given a starting widget
"""
# print ("looking for", path_segment, "child of, ", widget)
adjusted_path_segment = path_segment
# when we don't have index we assume it is the first one
index = None
if "[" in adjusted_path_segment:
index = int(adjusted_path_segment.split("[")[-1].split("]")[0])
adjusted_path_segment = adjusted_path_segment.split("[")[0]
children = ui.Inspector.get_children(widget)
counter = 0
for a_child in children:
if not a_child:
continue
# NOTE: Wait until we have identifier support before activating this
if adjusted_path_segment == a_child.identifier and index == None:
return a_child
elif adjusted_path_segment == a_child.__class__.__name__:
if index == counter:
return a_child
else:
counter += 1
if not widget.__class__.__name__ == adjusted_path_segment:
if show_warnings:
carb.log_warn(f"Widget {widget} does not match path segment {adjusted_path_segment}")
return None
if not index:
index = 0
if index >= len(children):
if show_warnings:
carb.log_warn(f"Widget {widget} only has {len(children)} children, asked for index {index}")
return None
return children[index]
@classmethod
def _find_children_by_type(cls, widget: ui.Widget, path_segment: str) -> List[ui.Widget]:
"""
given a starting widget, look at it's children to find the path segment requested, where
the path segment index has a wildcard (e.g [*])
Assumes input path_segment is like "Type[*]"
"""
adjusted_path_segment = path_segment[: path_segment.find("[")]
children = ui.Inspector.get_children(widget)
children_of_type = [c for c in children if c.__class__.__name__ == adjusted_path_segment]
return children_of_type
@classmethod
def get_widget_path(cls, window: ui.Window, widget: ui.Widget) -> Union[str, None]:
"""
given a Window and a Widget in that window, get it's path
"""
def traverse_widget_tree_for_match(
starting_widget: ui.Widget, current_path: str, searched_widget: ui.Widget
) -> Union[str, None]:
current_index = 0
current_children = ui.Inspector.get_children(starting_widget)
current_children = [c for c in current_children if c]
type_frequencies = dict(zip([a.__class__ for a in current_children], [0] * len(current_children)))
for a_child in current_children:
class_name = a_child.__class__.__name__
current_index = type_frequencies[a_child.__class__]
widget_name = a_child.identifier or f"{class_name}[{current_index}]"
type_frequencies[a_child.__class__] += 1
if a_child == searched_widget:
p = f"{current_path}/{widget_name}"
return p
if isinstance(a_child, ui.Container) or isinstance(a_child, ui.TreeView):
path = traverse_widget_tree_for_match(a_child, f"{current_path}/{widget_name}", searched_widget)
if path:
return path
return None
if window:
start_path = f"{window.title}//Frame"
return traverse_widget_tree_for_match(window.frame, start_path, widget)
else:
return None
@classmethod
def find_menu_item(cls, query: str) -> Optional[ui.Widget]:
"""
TODO: This may now be legacy functionality after https://gitlab-master.nvidia.com/omniverse/kit/-/merge_requests/10402
is merged so need to see if it's actually being used on 102 tests etc
"""
from omni.kit.mainwindow import get_main_window
main_menu_bar = get_main_window().get_main_menu_bar()
if not main_menu_bar:
carb.log_warn("Current App doesn't have a MainMenuBar")
return None
tokens = query.split("/")
print(tokens)
current_children = main_menu_bar
for i in range(1, len(tokens)):
last = i == len(tokens) - 1
print(tokens[i])
child = cls._child_widget(current_children, tokens[i])
if not child != 1:
carb.log_warn(f"find_menu_item: Failed to find Child Widget at level {tokens[i]}")
return None
current_children = child
return current_children
@classmethod
def _parse_input(cls, query: str) -> Tuple[bool, Union[ui.Widget, None], List[str], str]:
"""
parse and validate the input.
return widge tokens only ie sans window
"""
# TODO Replace w regex
tokens = query.split("//")
window_name = tokens[0] if len(tokens) > 1 else None
widget_predicate = ""
widget_part = tokens[1] if len(tokens) > 1 else tokens[0]
widget_part_list = widget_part.split(".", maxsplit=1)
widget_path = widget_part_list[0]
if len(widget_part_list) > 1:
widget_predicate = widget_part_list[1]
window = None
if window_name:
windows = ui.Workspace.get_windows()
window_list = []
for window in windows:
if window.title == window_name:
window_list.append(window)
if not window_list:
carb.log_warn(f'Failed to find window: "{window_name}"')
return False, None, [], widget_predicate
if len(window_list) == 1:
window = window_list[0]
else:
carb.log_warn(
f'found {len(window_list)} windows named "{window_name}". Using first visible window found'
)
window = None
for win in window_list:
if win.visible:
window = win
break
if not window:
carb.log_warn(f'Failed to find visible window: "{window_name}"')
return False, None, [], widget_predicate
if not isinstance(window, ui.Window) and not isinstance(window, ui.ToolBar):
carb.log_warn(f"window: {window_name} is not a ui.Window, query only works on ui.Window")
return False, None, [], widget_predicate
widget_tokens = widget_path.split("/")
if window and not (widget_tokens[0] == "Frame" or widget_tokens[0] == "Frame[0]"):
carb.log_warn("Query with a window currently only supports '<WindowName>//Frame/* type query")
return False, None, [], widget_predicate
if widget_tokens[-1] == "":
widget_tokens = widget_tokens[:-1]
return True, window, widget_tokens, widget_predicate
@classmethod
def find_widgets(cls, query: str, root_widgets=[]) -> List[ui.Widget]:
"""
find a set of widgets that match our query.
"""
def _get_descendants(widget: ui.Widget):
kids = []
local_kids = ui.Inspector.get_children(widget)
kids.extend(local_kids)
for k in local_kids:
child_kids = _get_descendants(k)
kids.extend(child_kids)
return kids
validate_status, window, widget_tokens, predicate = cls._parse_input(query)
if not validate_status:
return []
if root_widgets:
curr_kids = root_widgets
else:
curr_kids = [window.frame] if window else []
if not curr_kids:
return []
curr_kids_tmp = []
for i in range(0, len(widget_tokens)):
# Skip only parent frame
if widget_tokens[i] == "Frame":
continue
curr_kids_tmp = []
for current_child in curr_kids:
if isinstance(current_child, ui.Window):
current_child = current_child.frame
if widget_tokens[i] == "*":
curr_kids_tmp += ui.Inspector.get_children(current_child)
elif widget_tokens[i].find("[*]") != -1:
curr_kids_tmp += cls._find_children_by_type(current_child, widget_tokens[i])
elif widget_tokens[i] == "**":
curr_kids_tmp += _get_descendants(current_child)
else:
child = cls._child_widget(current_child, widget_tokens[i], show_warnings=False)
if child:
curr_kids_tmp += [child]
# Filter out any leaf node widgets as we're not on the last pass and last pass deals with them
curr_kids = [kid for kid in curr_kids_tmp if len(ui.Inspector.get_children(kid)) > 0]
# Remove None(s)
curr_kids_tmp = [w for w in curr_kids_tmp if w is not None]
if predicate:
curr_kids_tmp = [w for w in curr_kids_tmp if eval("w." + predicate)]
return curr_kids_tmp
@classmethod
def find_widget(cls, query: str) -> Union[ui.Widget, None]:
"""
find a single widget given a full widget path
"""
validate_status, window, widget_tokens, _ = cls._parse_input(query)
if not validate_status:
return None
if len(widget_tokens) == 1:
return window.frame
current_child = window.frame
for i in range(1, len(widget_tokens)):
child = cls._child_widget(current_child, widget_tokens[i])
if not child:
carb.log_warn(f'find_widget: from query "{query}" Failed to widget {widget_tokens[i]}')
actual_kids = ui.Inspector.get_children(current_child)
names = [a.identifier or f"{a.__class__.__name__}" for a in actual_kids]
carb.log_warn(f"find_widget: did find widgets {names}")
return None
current_child = child
return current_child
| 10,563 | Python | 36.863799 | 126 | 0.548802 |
omniverse-code/kit/exts/omni.ui_query/omni/ui_query/__init__.py | import omni.ui
from .query import OmniUIQuery
| 46 | Python | 14.666662 | 30 | 0.826087 |
omniverse-code/kit/exts/omni.ui_query/omni/ui_query/tests/__init__.py | from .test_query import TestQuery
| 34 | Python | 16.499992 | 33 | 0.823529 |
omniverse-code/kit/exts/omni.ui_query/omni/ui_query/tests/test_query.py | from ..query import OmniUIQuery
import omni.kit.test
import omni.ui
class TestQuery(omni.kit.test.AsyncTestCase):
def test_create_test_widget1(self):
_window = omni.ui.Window("the window with space")
button = None
with _window.frame: # the frame can only have 1 widget under it
with omni.ui.HStack():
with omni.ui.VStack():
omni.ui.Label("Test2")
with omni.ui.VStack(width=150):
with omni.ui.HStack(height=30):
omni.ui.Label("Test1")
omni.ui.StringField()
button = omni.ui.Button("TestButton")
button_path = OmniUIQuery.get_widget_path(_window, button)
self.assertTrue(
"the window with space//Frame/HStack[0]/VStack[1]/HStack[0]/Button[0]" == button_path,
"was actually %s" % (button_path),
)
def test_create_test_widget2(self):
_window = omni.ui.Window("the_window")
hstack1 = None
with _window.frame as frame1:
hstack1 = omni.ui.HStack()
with hstack1:
vstack1 = omni.ui.VStack()
with vstack1:
label1 = omni.ui.Label("Test2")
vstack2 = omni.ui.VStack(width=150)
with vstack2:
hstack2 = omni.ui.HStack(height=30)
with hstack2:
label2 = omni.ui.Label("Test1")
string1 = omni.ui.StringField()
button1 = omni.ui.Button()
button1.identifier = "The_Button1"
button2 = omni.ui.Button("TestButton")
button3 = omni.ui.Button(name="Button3")
# NOTE: we can't look for the frame..
# widget_path = OmniUIQuery.get_widget_path(_window, frame1)
# self.assertTrue('the_window//Frame'== widget_path, "was actually %s"%(widget_path))
widget_path = OmniUIQuery.get_widget_path(_window, hstack1)
self.assertTrue("the_window//Frame/HStack[0]" == widget_path, "was actually %s" % (widget_path))
found_widget = OmniUIQuery.find_widget(widget_path)
self.assertTrue(found_widget == hstack1)
widget_path = OmniUIQuery.get_widget_path(_window, vstack1)
self.assertTrue("the_window//Frame/HStack[0]/VStack[0]" == widget_path, "was actually %s" % (widget_path))
found_widget = OmniUIQuery.find_widget(widget_path)
self.assertTrue(found_widget == vstack1)
widget_path = OmniUIQuery.get_widget_path(_window, label1)
self.assertTrue(
"the_window//Frame/HStack[0]/VStack[0]/Label[0]" == widget_path, "was actually %s" % (widget_path)
)
found_widget = OmniUIQuery.find_widget(widget_path)
self.assertTrue(found_widget == label1)
widget_path = OmniUIQuery.get_widget_path(_window, vstack2)
self.assertTrue("the_window//Frame/HStack[0]/VStack[1]" == widget_path, "was actually %s" % (widget_path))
found_widget = OmniUIQuery.find_widget(widget_path)
self.assertTrue(found_widget == vstack2)
widget_path = OmniUIQuery.get_widget_path(_window, hstack2)
self.assertTrue(
"the_window//Frame/HStack[0]/VStack[1]/HStack[0]" == widget_path, "was actually %s" % (widget_path)
)
found_widget = OmniUIQuery.find_widget(widget_path)
self.assertTrue(found_widget == hstack2)
widget_path = OmniUIQuery.get_widget_path(_window, button2)
self.assertTrue(
"the_window//Frame/HStack[0]/VStack[1]/HStack[0]/Button[1]" == widget_path,
"was actually %s" % (widget_path),
)
found_widget = OmniUIQuery.find_widget(widget_path)
self.assertTrue(found_widget == button2)
# Test where we reference with a name rather than a type. #TODO: reactivate when we have identifier support
widget_path = OmniUIQuery.get_widget_path(_window, button1)
self.assertTrue(
"the_window//Frame/HStack[0]/VStack[1]/HStack[0]/The_Button1" == widget_path,
"was actually %s" % (widget_path),
)
found_widget = OmniUIQuery.find_widget(widget_path)
self.assertTrue(found_widget == button1)
def test_wildcards(self):
_window = omni.ui.Window("the_window")
hstack1 = None
with _window.frame as frame1:
hstack1 = omni.ui.HStack()
with hstack1:
vstack1 = omni.ui.VStack()
with vstack1:
label1 = omni.ui.Label("Test2")
vstack2 = omni.ui.VStack(width=150)
with vstack2:
hstack2 = omni.ui.HStack(height=30)
with hstack2:
label2 = omni.ui.Label("Test1")
string1 = omni.ui.StringField()
button1 = omni.ui.Button()
button1.identifier = "TheButton_1"
button2 = omni.ui.Button("TestButton")
button3 = omni.ui.Button(name="Button3.dot.separated")
# Run all tests in 2 modes:
# 1. Full path including window
# 2. Find subwidget first (Frame) and search from it
for full_path in [True, False]:
def find(path):
if full_path:
return OmniUIQuery.find_widgets(f"the_window//Frame/{path}")
else:
frame = OmniUIQuery.find_widget("the_window//Frame")
return OmniUIQuery.find_widgets(path, root_widgets=[frame])
# Find every immediate child beneath the first HStack
widgets = find("HStack[0]/*")
self.assertTrue(widgets[0] == vstack1)
self.assertTrue(widgets[1] == vstack2)
self.assertTrue(len(widgets) == 2)
# Find every immediate child beneath the first HStack Vstack combo
widgets = find("HStack[0]/VStack[0]/*")
self.assertTrue(len(widgets) == 1)
self.assertTrue(widgets[0] == label1)
# Index/Type - Find every immediate Vstack child
widgets = find("HStack[0]/VStack[*]")
self.assertTrue(widgets[0] == vstack1)
self.assertTrue(widgets[1] == vstack2)
self.assertTrue(len(widgets) == 2)
# Recursion - Find every child beneath the Frame - recursively
widgets = find("**")
self.assertTrue(len(widgets) == 10)
widgets = find("HStack[0]/**")
self.assertTrue(len(widgets) == 9)
# Recursion - with a specific type/indexed entry at the end
widgets = find("HStack[0]/**/Button[0]")
self.assertTrue(len(widgets) == 1)
self.assertTrue(button1 in widgets)
# Recursion - with a specific name at the end
widgets = find("HStack[0]/**/TheButton_1")
self.assertTrue(len(widgets) == 1, "actually %s" % (len(widgets)))
self.assertTrue(button1 in widgets)
# Recursion - find all the buttons
widgets = find("**/Button[*]")
self.assertTrue(len(widgets) == 3)
self.assertTrue(button1 in widgets)
self.assertTrue(button2 in widgets)
self.assertTrue(button3 in widgets)
widgets = find("*/VStack[*]")
self.assertTrue(len(widgets) == 2)
self.assertTrue(vstack1 in widgets)
self.assertTrue(vstack2 in widgets)
# Recursion - what's directly under the 2 vstacks vstack1 and vstack2?
widgets = find("HStack[0]/VStack[*]/*")
self.assertTrue(len(widgets) == 2)
self.assertTrue(label1 in widgets)
self.assertTrue(hstack2 in widgets)
# We should be able to get the same result using recursion and non-recursion on a set of leaf nodes
widgets = find("HStack[0]/VStack[1]/HStack[0]/*")
self.assertTrue(len(widgets) == 5)
widgets = find("HStack[0]/VStack[1]/HStack[0]/**")
self.assertTrue(len(widgets) == 5)
# Can we treat a standard path as am explicit query with no wildcard that returns a single result?
widgets = find("HStack[0]/VStack[1]/HStack[0]/Button[0]")
self.assertTrue(len(widgets) == 1)
self.assertTrue(button1 in widgets)
# #Can we treat a standard path as am explicit query with no wildcard that returns a single result?
widgets = find("HStack[0]/VStack[1]/HStack[0]/TheButton_1")
self.assertTrue(len(widgets) == 1)
self.assertTrue(button1 in widgets)
# Predicates
widgets = find("**/Button[*].text=='TestButton'")
self.assertTrue(button2 in widgets)
self.assertTrue(len(widgets) == 1)
widgets = find("**/Button[*].name=='Button3.dot.separated'")
self.assertTrue(button3 in widgets)
self.assertTrue(len(widgets) == 1)
def test_bad_inputs(self):
_window = omni.ui.Window("the_window2")
with _window.frame: # TODO Check - can the frame only have 1 widget under it?
with omni.ui.HStack():
with omni.ui.VStack():
omni.ui.Label("Test2")
# check bad window
widget_path = OmniUIQuery.find_widget("bad_window//Frame/HStack[0]/*")
self.assertTrue(widget_path == None)
# check pre-omniui window
widget_path = OmniUIQuery.find_widget("Viewport//Frame/HStack[0]/*")
self.assertTrue(widget_path == None)
# check bad frame
widget_path = OmniUIQuery.find_widget("the_window2//B/HStack[0]/*")
self.assertTrue(widget_path == None)
# bad first widget
widget_path = OmniUIQuery.find_widget("the_window2//Frame/GStack[0]")
self.assertTrue(widget_path == None)
# wildcard query
widgets = OmniUIQuery.find_widgets("blah")
self.assertTrue(widgets == [])
widgets = OmniUIQuery.find_widgets("blah/*")
self.assertTrue(widgets == [])
def test_with_real_widget(self):
"""
This introduces a dependency on render settings and the renderer core
We might want to abandon it if the dependency is too painful
"""
windows = omni.ui.Workspace.get_windows()
found_button = False
for w in windows:
if w.title == "Render Settings":
the_path = f"{w.title}//Frame/**"
widgets = OmniUIQuery.find_widgets(the_path)
for w in widgets:
if isinstance(w, omni.ui.Button):
found_button = True
self.assertTrue(found_button)
def test_frame_query(self):
# Test to validate whether we are able to query widget having Frames excludint parent frame in path
_window = omni.ui.Window("Window")
with _window.frame: # the frame can only have 1 widget under it
with omni.ui.HStack():
child_frame1 = omni.ui.Frame(name="Frame1")
child_frame2 = omni.ui.Frame()
with child_frame1:
label = omni.ui.Label("Label1")
with child_frame2:
button = omni.ui.Button()
single_frame_path = "Window//Frame/HStack[0]/Frame[0]"
multiple_frame_path = "Window//Frame/HStack[0]/Frame[*]"
widget_inside_frame_path = "Window//Frame/HStack[0]/Frame[1]/Button[0]"
frame_with_text_path = "Window//Frame/HStack[0]/Frame[*].name=='Frame1'"
# Finding a single frame
found_widget = OmniUIQuery.find_widgets(single_frame_path)[0]
self.assertTrue(found_widget == child_frame1)
# Finding multiple frames
found_widget = OmniUIQuery.find_widgets(multiple_frame_path)
self.assertTrue(found_widget[0] == child_frame1)
self.assertTrue(found_widget[1] == child_frame2)
# Finding widget inside Frame with multiple Frame[0] in query
found_widget = OmniUIQuery.find_widgets(widget_inside_frame_path)
self.assertTrue(found_widget[0] == button)
# Finding frame using the text
found_widget = OmniUIQuery.find_widgets(frame_with_text_path)
self.assertTrue(found_widget[0] == child_frame1)
| 12,479 | Python | 41.739726 | 115 | 0.573203 |
omniverse-code/kit/exts/omni.ui_query/docs/index.rst | omni.ui_query
###########################
Extension provides API to make omni.ui queries to find widgets using path.
.. toctree::
:maxdepth: 1
TUTORIAL.md
CHANGELOG.md
| 184 | reStructuredText | 14.416665 | 74 | 0.592391 |
omniverse-code/kit/exts/omni.hydra.scene_api/omni/hydra/scene_api/__init__.py | import omni.ext
from .bindings._omni_hydra_scene_api import *
| 62 | Python | 19.999993 | 45 | 0.774194 |
omniverse-code/kit/exts/omni.hydra.scene_api/omni/hydra/scene_api/tests/__init__.py | import sys
# Temporarily disable all omni.rtx.tests cases until they are stable on Linux with
# a driver common to all TC agents
if sys.platform == "win32":
from .test_backgroundloadingscenedelegate import TestBackgroundLoadingSceneDelegate
| 245 | Python | 39.999993 | 87 | 0.808163 |
omniverse-code/kit/exts/omni.hydra.scene_api/omni/hydra/scene_api/tests/test_backgroundloadingscenedelegate.py | ## Copyright (c) 2021, NVIDIA CORPORATION. All rights reserved.
##
## NVIDIA CORPORATION and its licensors retain all intellectual property
## and proprietary rights in and to this software, related documentation
## and any modifications thereto. Any use, reproduction, disclosure or
## distribution of this software and related documentation without an express
## license agreement from NVIDIA CORPORATION is strictly prohibited.
##
import omni.kit.test
from omni.hydra.scene_api import *
import omni.kit.app
import omni.kit.commands
import omni.kit.undo
from omni.rtx.tests import RtxTest, testSettings, postLoadTestSettings
from pxr import Gf, Usd, UsdGeom
import pathlib
EXTENSION_FOLDER_PATH = pathlib.Path(omni.kit.app.get_app().get_extension_manager().get_extension_path_by_module(__name__))
USD_DIR = EXTENSION_FOLDER_PATH.joinpath("omni/hydra/scene_api/tests/data/usd")
GOLDEN_DIR = EXTENSION_FOLDER_PATH.joinpath("omni/hydra/scene_api/tests/data/golden")
class TestBackgroundLoadingSceneDelegate(RtxTest):
"""
An RtxTest that verifies we can load several scene delegates and they are
all rendered.
"""
# override resolution
WINDOW_SIZE = (512, 512)
# override diff threshold. Seeing some lighting diffs on teamcity that trip the
# default threshold. All we care about is whether the item loaded, so we can have
# a pretty flexible threshold. The default is 1e-5 currently.
THRESHOLD = 1e-4
async def setUp(self):
await super().setUp()
self.set_settings(testSettings)
# Create a main stage in the usd_context. This is to be like a normal run,
# where there would be a stage. We'll also put a light on it.
omni.usd.get_context().new_stage()
self.add_dir_light()
await omni.kit.app.get_app().next_update_async() # Wait stage loading
self.set_settings(postLoadTestSettings)
async def _pause(self):
await omni.rtx.tests.test_common.wait_for_update(self.ctx, 5) # Wait 5 frames before capture.
async def test_addAndRemove(self):
path = USD_DIR.joinpath('wonky-cylinder.usda')
x = add_background_loading_hydra_scene_delegate('testDelegate', str(path))
self.assertTrue(x, f'Failed to add stage {path}')
await self._pause()
await self.screenshot_and_diff(GOLDEN_DIR, output_subdir="omni.hydra.scene_api",
golden_img_name="added_cylinder.png")
x = remove_hydra_scene_delegate('testDelegate')
self.assertTrue(x, f'Failed to remove delegate {path}')
await self._pause()
await self.screenshot_and_diff(GOLDEN_DIR, output_subdir="omni.hydra.scene_api",
golden_img_name="removed_cylinder.png")
async def test_addSameTwice(self):
path = USD_DIR.joinpath('bunny.obj.usda')
x = add_background_loading_hydra_scene_delegate('testDelegate', str(path))
self.assertTrue(x, f'Failed to add stage {path}')
x = add_background_loading_hydra_scene_delegate('testDelegate', str(path))
self.assertFalse(x, f'second add with the same name should fail')
x = remove_hydra_scene_delegate('testDelegate')
self.assertTrue(x, f'Failed to remove delegate {path}')
async def test_add_grid(self):
path00 = USD_DIR.joinpath('cylinder00.usda')
path01 = USD_DIR.joinpath('cylinder01.usda')
path10 = USD_DIR.joinpath('cylinder10.usda')
path11 = USD_DIR.joinpath('cylinder11.usda')
x = add_background_loading_hydra_scene_delegate('cylinder00', str(path00))
self.assertTrue(x, f'Failed to add stage {path00}')
await self._pause()
await self.screenshot_and_diff(GOLDEN_DIR, output_subdir="omni.hydra.scene_api",
golden_img_name="added_cylinder00.png")
x = add_background_loading_hydra_scene_delegate('cylinder01', str(path01))
self.assertTrue(x, f'Failed to add stage {path01}')
await self._pause()
await self.screenshot_and_diff(GOLDEN_DIR, output_subdir="omni.hydra.scene_api",
golden_img_name="added_cylinder01.png")
x = add_background_loading_hydra_scene_delegate('cylinder10', str(path10))
self.assertTrue(x, f'Failed to add stage {path10}')
await self._pause()
await self.screenshot_and_diff(GOLDEN_DIR, output_subdir="omni.hydra.scene_api",
golden_img_name="added_cylinder10.png")
x = add_background_loading_hydra_scene_delegate('cylinder11', str(path11))
self.assertTrue(x, f'Failed to add stage {path11}')
await self._pause()
await self.screenshot_and_diff(GOLDEN_DIR, output_subdir="omni.hydra.scene_api",
golden_img_name="added_cylinder11.png")
x = remove_hydra_scene_delegate('cylinder00')
self.assertTrue(x, f'Failed to remove delegate {path00}')
await self._pause()
await self.screenshot_and_diff(GOLDEN_DIR, output_subdir="omni.hydra.scene_api",
golden_img_name="removed_cylinder00.png")
x = remove_hydra_scene_delegate('cylinder01')
self.assertTrue(x, f'Failed to remove delegate {path01}')
await self._pause()
await self.screenshot_and_diff(GOLDEN_DIR, output_subdir="omni.hydra.scene_api",
golden_img_name="removed_cylinder01.png")
x = remove_hydra_scene_delegate('cylinder10')
self.assertTrue(x, f'Failed to remove delegate {path10}')
await self._pause()
await self.screenshot_and_diff(GOLDEN_DIR, output_subdir="omni.hydra.scene_api",
golden_img_name="removed_cylinder10.png")
x = remove_hydra_scene_delegate('cylinder11')
self.assertTrue(x, f'Failed to remove delegate {path11}')
await self._pause()
await self.screenshot_and_diff(GOLDEN_DIR, output_subdir="omni.hydra.scene_api",
golden_img_name="removed_cylinder11.png")
async def test_parallel_load(self):
path00 = USD_DIR.joinpath('cylinder00.usda')
path01 = USD_DIR.joinpath('cylinder01.usda')
path10 = USD_DIR.joinpath('cylinder10.usda')
path11 = USD_DIR.joinpath('cylinder11.usda')
add_background_loading_hydra_scene_delegate('cylinder00', str(path00))
add_background_loading_hydra_scene_delegate('cylinder01', str(path01))
add_background_loading_hydra_scene_delegate('cylinder10', str(path10))
add_background_loading_hydra_scene_delegate('cylinder11', str(path11))
await self._pause()
await self.screenshot_and_diff(GOLDEN_DIR, output_subdir="omni.hydra.scene_api",
golden_img_name="parallel_load.png", threshold=1e-4)
x = remove_hydra_scene_delegate('cylinder00')
x = remove_hydra_scene_delegate('cylinder01')
x = remove_hydra_scene_delegate('cylinder10')
x = remove_hydra_scene_delegate('cylinder11')
await self._pause()
await self.screenshot_and_diff(GOLDEN_DIR, output_subdir="omni.hydra.scene_api",
golden_img_name="parallel_unload.png")
def _convert_mat(self, xf):
"""Convert a Gf.Matrix4d into an array of row values"""
row0 = xf.GetRow(0)
row1 = xf.GetRow(1)
row2 = xf.GetRow(2)
row3 = xf.GetRow(3)
return [
row0[0], row0[1], row0[2], row0[3],
row1[0], row1[1], row1[2], row1[3],
row2[0], row2[1], row2[2], row2[3],
row3[0], row3[1], row3[2], row3[3],
]
async def test_set_root_transform(self):
path00 = USD_DIR.joinpath("cylinder00.usda")
path01 = USD_DIR.joinpath("cylinder01.usda")
add_background_loading_hydra_scene_delegate("cylinder00", str(path00))
add_background_loading_hydra_scene_delegate("cylinder01", str(path01))
# initial state
await self._pause()
await self.screenshot_and_diff(
GOLDEN_DIR, output_subdir="omni.hydra.scene_api", golden_img_name="transform_initial.png", threshold=1e-4
)
# move one cylinder over
xf = Gf.Matrix4d(1).SetTranslate(Gf.Vec3d(300, 200, 0))
x = set_scene_delegate_root_transform("cylinder00", self._convert_mat(xf))
self.assertTrue(x, f"Expected to set xform on cylinder00")
await self._pause()
await self.screenshot_and_diff(
GOLDEN_DIR, output_subdir="omni.hydra.scene_api", golden_img_name="transform_move.png", threshold=1e-4
)
# rotate and scale one cylinder, move the other a second time
xf = Gf.Matrix4d(1).SetScale(Gf.Vec3d(2.5, 2.5, 2.5)).SetRotateOnly(Gf.Rotation(Gf.Vec3d(0, 1, 0), 45.0))
x = set_scene_delegate_root_transform("cylinder01", self._convert_mat(xf))
self.assertTrue(x, f"Expected to set xform on cylinder01")
xf = Gf.Matrix4d(1).SetTranslate(Gf.Vec3d(0, 0, 300))
x = set_scene_delegate_root_transform("cylinder00", self._convert_mat(xf))
self.assertTrue(x, f"Expected to set xform on cylinder00")
await self._pause()
await self.screenshot_and_diff(
GOLDEN_DIR,
output_subdir="omni.hydra.scene_api",
golden_img_name="transform_scale_rotate_move.png",
threshold=1e-4,
)
# cleanup
x = remove_hydra_scene_delegate("cylinder00")
x = remove_hydra_scene_delegate("cylinder01")
await self._pause()
await self.screenshot_and_diff(
GOLDEN_DIR, output_subdir="omni.hydra.scene_api", golden_img_name="transform_unload.png"
)
async def test_set_bounding_box(self):
path = USD_DIR.joinpath("bbox.usda")
add_background_loading_hydra_scene_delegate("bbox", str(path))
set_scene_delegate_root_transform("bbox", (1.,0.,0.,0., 0.,1.,0.,0., 0.,0.,1.,0., 100.,0.,0.,0.))
await self._pause()
bbox = compute_scene_delegate_world_bounding_box("bbox")
compare_to = [50, -50, -50, 150, 50, 50, 100, 0, 0, 100, 100, 100]
for i in range(len(compare_to)):
self.assertEqual(compare_to[i], round(bbox[i]))
| 10,378 | Python | 50.128079 | 123 | 0.633648 |
omniverse-code/kit/exts/omni.kit.window.provide_feedback/config/extension.toml | [package]
# Semantic Versioning is used: https://semver.org/
version = "1.0.2"
# Lists people or organizations that are considered the "authors" of the package.
authors = ["NVIDIA"]
# The title and description fields are primarily for displaying extension info in UI
title = "Kit Provide Feedback Window"
description=""
# URL of the extension source repository.
repository = ""
# One of categories for UI.
category = "Internal"
# Keywords for the extension
keywords = ["kit"]
# https://keepachangelog.com/en/1.0.0/
changelog="docs/CHANGELOG.md"
[settings]
exts."omni.kit.window.provide_feedback".url = "https://forums.developer.nvidia.com/c/omniverse/apps/create/405"
[dependencies]
"omni.ui" = {}
"omni.kit.menu.utils" = {}
[[python.module]]
name = "omni.kit.window.provide_feedback"
[[test]]
waiver = "Too simple to test"
| 834 | TOML | 22.194444 | 111 | 0.72542 |
omniverse-code/kit/exts/omni.kit.window.provide_feedback/omni/kit/window/provide_feedback.py | import carb
import omni.ext
import webbrowser
class Extension(omni.ext.IExt):
def on_startup(self):
import omni.kit.ui
def provide_feedback_func(a, b):
url = carb.settings.get_settings().get(f"/exts/omni.kit.window.provide_feedback/url")
webbrowser.open(url)
self._menuEntry = omni.kit.ui.get_editor_menu().add_item(f'Help/Provide Feedback', provide_feedback_func)
omni.kit.ui.get_editor_menu().set_priority("Help/Provide Feedback", -11)
| 509 | Python | 30.874998 | 113 | 0.660118 |
omniverse-code/kit/exts/omni.kit.window.provide_feedback/docs/CHANGELOG.md | # CHANGELOG
## [1.0.2] - 2022-05-31
### Updated
- Moved URL into settings
## [1.0.1] - 2021-08-18
### Updated
- Updated menu to match other menu styling
## [1.0.0] - 2021-05-19
- Updated to open URL
## [0.1.0] - 2020-10-29
- Ported old version to extensions 2.0
| 267 | Markdown | 14.764705 | 42 | 0.625468 |
omniverse-code/kit/exts/omni.kit.viewport.menubar.core/omni/kit/viewport/menubar/core/viewport_layer.py | # Copyright (c) 2021-2022, NVIDIA CORPORATION. All rights reserved.
#
# NVIDIA CORPORATION and its licensors retain all intellectual property
# and proprietary rights in and to this software, related documentation
# and any modifications thereto. Any use, reproduction, disclosure or
# distribution of this software and related documentation without an express
# license agreement from NVIDIA CORPORATION is strictly prohibited.
#
__all__ = ["MenuBarViewportLayer"]
from .viewport_menu_model import ViewportMenuModel
from .menu_item.viewport_menu_item import ViewportMenuItem
from .menu_item.viewport_menubar_item import ViewportMenubar
from .style import VIEWPORT_MENUBAR_STYLE
import omni.ui as ui
import weakref
class MenuBarViewportLayer:
def __init__(self, factory_args, *ui_args, **ui_kwargs):
self._model = ViewportMenuModel()
self._sub = self._model.subscribe_item_changed_fn(self._menu_changed)
super().__init__()
# Store the factory arguments (we are passed a unique copy that is ours to mutate)
self.__factory_args = factory_args
ui_kwargs["build_fn"] = self._build_fn
# Remove height = 0 to make bottom alignment work
self.__ui_frame = ui.Frame(*ui_args, **ui_kwargs)
self.__factory_args['root_menu_layer'] = weakref.proxy(self.__ui_frame)
def destroy(self):
if self.__ui_frame:
self.__ui_frame.destroy()
self.__ui_frame = None
self._sub = None
def _build_fn(self):
menubar_items = self._model.get_item_children()
with ui.ZStack():
# Create menubars
for item in menubar_items:
if isinstance(item, ViewportMenubar):
if not item.visible_model.as_bool:
continue
menu_items = self._model.get_item_children(item)
item.build_fn(menu_items, self.__factory_args)
def _menu_changed(self, model: ViewportMenuModel, item: ViewportMenuItem) -> None:
if self.__ui_frame is not None:
self.__ui_frame.rebuild()
@property
def name(self):
return "Menubar"
@property
def categories(self):
return ("menubar", "menu")
@property
def layers(self):
return tuple()
@property
def visible(self):
return self.__ui_frame.visible if self.__ui_frame else False
@visible.setter
def visible(self, visible: bool):
if self.__ui_frame:
self.__ui_frame.visible = bool(visible)
| 2,549 | Python | 33 | 90 | 0.640643 |
omniverse-code/kit/exts/omni.kit.viewport.menubar.core/omni/kit/viewport/menubar/core/style.py | import omni.ui as ui
from omni.ui import color as cl, constant as fl
from pathlib import Path
__all__ = ["VIEWPORT_MENUBAR_STYLE", "VIEWPORT_PREFERENCE_STYLE"]
# Name of default menubar
DEFAULT_MENUBAR_NAME = "__DEFAULT__MENUBAR__"
CURRENT_PATH = Path(__file__).parent
ICON_PATH = CURRENT_PATH.parent.parent.parent.parent.parent.joinpath("data").joinpath("icons")
VIEWPORT_MENUBAR_STYLE = {
"Menu.Title": {"color": cl.viewport_menubar_title, "background_color": cl.viewport_menubar_title_background},
"Menu.Title:hovered": {
"background_color": cl.viewport_menubar_selection,
"border_width": 1,
"border_color": cl.viewport_menubar_selection_border,
},
"Menu.Title:pressed": {"background_color": cl.viewport_menubar_selection},
"Menu.Item": {
"color": cl.viewport_menubar_light,
"margin_width": fl.viewport_menubar_item_margin,
"margin_height": fl.viewport_menubar_item_margin_height,
},
"MenuBar.Window": {
"background_color": cl.viewport_menubar_background,
"border_width": 0,
"border_radius": 0,
},
"MenuBar.Item": {
"color": cl.viewport_menubar_light,
"padding": 0,
"margin_width": fl.viewport_menubar_item_margin,
"margin_height": fl.viewport_menubar_item_margin,
},
"MenuBar.Item::menubar": {
"color": cl.viewport_menubar_light,
"padding": 0,
"margin_width": 0,
"margin_height": 0,
},
"MenuBar.Item.Background": {
"background_color": cl.viewport_menubar_background,
"border_radius": cl.viewport_menubar_border_radius,
"padding": 1,
"margin": 2,
},
"Menu.Item.Background": {
"background_color": cl.viewport_menubar_background,
"border_radius": cl.viewport_menubar_border_radius,
"padding": 0,
"margin_width": 0,
"margin_height": 2,
},
"Menu.Item.CloseMark": {
"color": 0x0,
},
"Menu.Item.CloseMark:checked": {
"color": cl.viewport_menubar_light,
},
"MenuBar.Item.Triangle": {"background_color": cl.viewport_menubar_light},
"Menu.Separator": {
"color": cl.viewport_menubar_medium,
"margin_height": fl.viewport_menubar_item_margin_height,
"border_width": 1.5,
},
"Menu.Item.Separator": {
"color": cl.viewport_menubar_medium,
"margin_height": fl.viewport_menubar_item_margin_height,
"border_width": 20,
},
"Menu.Window": {
"background_color": cl.viewport_menubar_background,
"border_width": 0,
"border_radius": 0,
"background_selected_color": cl.viewport_menubar_selection,
"secondary_padding": 1,
"secondary_selected_color": cl.viewport_menubar_selection_border,
"margin": 2,
},
"MenuItem": {
"background_selected_color": cl.viewport_menubar_selection,
"secondary_padding": 1,
"secondary_selected_color": cl.viewport_menubar_selection_border,
},
"Slider": {
"border_radius": 100,
"border_width": 1,
"border_color": cl.viewport_menubar_medium,
"background_color": cl(1, 1, 1, 0),
"color": cl.viewport_menubar_light,
"secondary_color": cl.viewport_menubar_medium,
"draw_mode": ui.SliderDrawMode.FILLED,
"padding": 0,
},
"Slider:disabled": {"color": cl.viewport_menubar_medium},
"Menu.Item.Label": {"color": cl.viewport_menubar_light, "margin_width": fl.viewport_menubar_item_margin},
"Menu.Item.Label:disabled": {"color": cl.viewport_menubar_medium},
"Menu.Item.Text": {"color": cl.viewport_menubar_light},
"Menu.Item.Text:disabled": {"color": cl.viewport_menubar_medium},
"Menu.Item.Icon": {
"image_url": f"{ICON_PATH}/none.svg",
"color": 0xFFD6D6D6,
"padding": 0,
"margin_width": 2,
"margin_height": 2,
},
"Menu.Item.Icon:selected": {"image_url": f"{ICON_PATH}/check_solid.svg"},
"Menu.Item.RadioMark": {
"image_url": f"{ICON_PATH}/radiomark.svg",
"color": cl.viewport_menubar_selection_border,
"margin_width": fl.viewport_menubar_item_margin,
},
"Menu.Item.Status": {
"image_url": f"{ICON_PATH}/none.svg",
"color": cl.viewport_menubar_selection_border,
"margin_width": fl.viewport_menubar_item_margin,
},
"Menu.Item.Status:checked": {"image_url": f"{ICON_PATH}/radiomark.svg"},
"Menu.Item.Status:selected": {"image_url": f"{ICON_PATH}/check_solid.svg"},
"Menu.Item.Status::Category.None": {"image_url": f"{ICON_PATH}/none.svg"},
"Menu.Item.Status::Category.All": {"image_url": f"{ICON_PATH}/check_solid.svg"},
"Menu.Item.Status::Category.Mixed": {"image_url": f"{ICON_PATH}/mixed_checkbox.svg", "margin_width": 2},
"ComboBox": {
"background_color": 0x0,
"secondary_color": 0x0,
"color": cl.viewport_menubar_light,
"secondary_selected_color": cl.viewport_menubar_light,
"secondary_background_color": cl.viewport_menubar_background,
"selected_color": cl.viewport_menubar_selection,
"padding": 4,
"font_size": 14,
},
"ComboBox:disabled": {"color": cl.viewport_menubar_medium},
"CheckBox": {"border_radius": 1},
"CheckBox:disabled": {"background_color": cl.viewport_menubar_medium},
"Label": {"color": cl.viewport_menubar_light},
"Menu.Button": {
"color": cl.viewport_menubar_selection_border,
"background_color": 0,
"padding": 0,
"margin_width": fl.viewport_menubar_item_margin,
"margin_height": fl.viewport_menubar_item_margin_height,
"stack_direction": ui.Direction.LEFT_TO_RIGHT,
},
"Menubar.Hover": {
"background_color": 0,
"padding": 1,
"margin": 1,
},
"Menubar.Hover:hovered": {
"background_color": cl.viewport_menubar_selection,
"border_color": cl.viewport_menubar_selection_border_button,
"border_width": 1.5
},
"Menubar.Hover:pressed": {
"background_color": cl.viewport_menubar_selection,
"border_color": cl.viewport_menubar_selection_border_button,
"border_width": 1.5
},
"Rectangle::reset_invalid": {"background_color": 0xFF505050, "border_radius": 2},
"Rectangle::reset": {"background_color": 0xFFA07D4F, "border_radius": 2},
}
VIEWPORT_PREFERENCE_STYLE = {
"TreeView.Frame": {"background_color": 0xFF343432, "padding": 10},
"TreeView.Item.Label": {"color": 0xFF9E9E9E},
"TreeView.Item.Line": {"color": 0x338A8777},
"TreeView.Item.CheckBox": {"font_size": 10, "background_color": 0xFF9E9E9E, "color": 0xFF23211F, "border_radius": 0},
"TreeView.Item.ComboBox": {"color": 0xFF9E9E9E, "secondary_color": 0xFF23211F, "border_radius": 0},
"TreeView.Item.Alignment::left": {"image_url": f"{ICON_PATH}/align_left.svg"},
"TreeView.Item.Alignment::left:checked": {"image_url": f"{ICON_PATH}/align_disabled_left.svg"},
"TreeView.Item.Alignment::right": {"image_url": f"{ICON_PATH}/align_right.svg"},
"TreeView.Item.Alignment::right:checked": {"image_url": f"{ICON_PATH}/align_disabled_right.svg"},
"TreeView:drop": {"border_color": 0xFFC5911A, "background_selected_color": 0x0},
}
| 7,277 | Python | 38.770492 | 121 | 0.620036 |
omniverse-code/kit/exts/omni.kit.viewport.menubar.core/omni/kit/viewport/menubar/core/extension.py | # Copyright (c) 2021-2022, NVIDIA CORPORATION. All rights reserved.
#
# NVIDIA CORPORATION and its licensors retain all intellectual property
# and proprietary rights in and to this software, related documentation
# and any modifications thereto. Any use, reproduction, disclosure or
# distribution of this software and related documentation without an express
# license agreement from NVIDIA CORPORATION is strictly prohibited.
#
__all__ = ["ViewportMenuBarExtension"]
from .menu_item.viewport_menu_spacer import ViewportMenuSpacer
from .menu_item.viewport_menubar_item import ViewportMenubar
from .utils.usd_watch import start as usd_watch_start
from .utils.usd_watch import stop as usd_watch_stop
from .viewport_layer import MenuBarViewportLayer
from .viewport_menu_model import destroy as destroy_menu_model, ViewportMenuModel, AbstractViewportMenubarItem
from .preference.menubar_page import ViewportMenubarPage
from .style import DEFAULT_MENUBAR_NAME
from omni.kit.viewport.registry import RegisterViewportLayer
from omni.kit.window.preferences import register_page, unregister_page
from omni.ui import color as cl
from omni.ui import constant as fl
from typing import List, Optional
import omni.ext
_extension_instance = None
class ViewportMenuBarExtension(omni.ext.IExt):
"""The Entry Point for the Viewport Menu Bar"""
def init_shades(self):
"""Style colors"""
# https://confluence.nvidia.com/pages/viewpage.action?spaceKey=OMNIVERSE&title=Viewport+Toolbar
cl.viewport_menubar_title = cl.shade(cl("#25282A"))
cl.viewport_menubar_title_background = cl.shade(cl("#191A1B"))
cl.viewport_menubar_background = cl.shade(cl("#25282ACC"))
cl.viewport_menubar_medium = cl.shade(cl("#6E6E6E"))
cl.viewport_menubar_light = cl.shade(cl("#D6D6D6"))
cl.viewport_menubar_selection = cl.shade(cl("#34C7FF3B"))
cl.viewport_menubar_selection_border = cl.shade(cl("#34C7FF"))
cl.viewport_menubar_selection_border_button = cl.shade(cl("#2B87AA"))
fl.viewport_menubar_item_margin = fl.shade(5)
fl.viewport_menubar_item_margin_height = fl.shade(3)
fl.viewport_menubar_height = fl.shade(30)
fl.viewport_menubar_icon_size = fl.shade(30)
fl.viewport_menubar_control_height = fl.shade(18)
fl.viewport_menubar_border_radius = fl.shade(6)
def on_startup(self, ext_id):
self._model = ViewportMenuModel()
# Default menubar
self._top_bar_item = ViewportMenubar(DEFAULT_MENUBAR_NAME)
# Preference page
self._page = ViewportMenubarPage(self._model)
register_page(self._page)
# Start USD Watch
usd_watch_start()
self.init_shades()
# And then the viewport-layer itself (what will build all the menu-items / widgets above)
# Entry point for the custom widget in the viewport
self.__viewport_layer = RegisterViewportLayer(MenuBarViewportLayer, "omni.kit.viewport.menubar.MenuBarLayer")
# Register the menus
ViewportMenuSpacer()
global _extension_instance
_extension_instance = self
def on_shutdown(self):
global _extension_instance
_extension_instance = None
self._top_bar_item.destroy()
self._page.destroy()
unregister_page(self._page)
self._page = None
self._model.destroy()
# Destroy every item in the model and release them
destroy_menu_model()
self.__viewport_layer.destroy()
self.__viewport_layer = None
# Stop USD Watch
usd_watch_stop()
def get_menubars(self) -> List[AbstractViewportMenubarItem]:
return self._model.get_item_children()
def get_menubar(self, name: str) -> Optional[AbstractViewportMenubarItem]:
for item in self.get_menubars():
if item.name == name:
return item
else:
return None
def get_instance():
global _extension_instance
return _extension_instance
| 4,030 | Python | 36.324074 | 117 | 0.6933 |
omniverse-code/kit/exts/omni.kit.viewport.menubar.core/omni/kit/viewport/menubar/core/__init__.py | # Copyright (c) 2021-2022, NVIDIA CORPORATION. All rights reserved.
#
# NVIDIA CORPORATION and its licensors retain all intellectual property
# and proprietary rights in and to this software, related documentation
# and any modifications thereto. Any use, reproduction, disclosure or
# distribution of this software and related documentation without an express
# license agreement from NVIDIA CORPORATION is strictly prohibited.
#
'''
### WIP TBD ###
PROBLEM:
David has a very good menu::
self._edit_menu_list = [
MenuItemDescription(
name="Undo",
glyph="none.svg",
enable_fn=lambda: omni.kit.undo.can_undo(),
onclick_fn=omni.kit.undo.undo,
hotkey=(carb.input.KEYBOARD_MODIFIER_FLAG_CONTROL, carb.input.KeyboardInput.Z),
)
]
omni.kit.menu.utils.add_menu_items(self._edit_menu_list, "Edit", -9)
# Also: set_default_menu_proirity
# Also: remove_menu_items
# Also: add_hook
# Also: remove_hook
# Also: add_layout
# Also: remove_layout
# Pros:
# - Lots of features
# - Lots of callbacks
# - Easy to read
# Cons:
# - Limited with ImGui Menu
# - No support of widgets
# - MenuItemDescription per menu item
### GOAL ###
# https://confluence.nvidia.com/pages/viewpage.action?spaceKey=OMNIVERSE&title=Viewport+Toolbar
# - Reuse the MenuItemDescription experience
# - Leverage new menu
# - Flexibility
# - Decentralization
# - MVP: Viewport menu
# - Ability to evolve to the universal menu framework
### SIMPLE CASE EXAMPLE ###
Example::
class SliderMenuDelegate(ui.MenuDelegate):
"""A menu delegate that draws the Label and the Slider"""
def __init__(self, model):
self._model = model
def build_item(self, item):
ui.Label(item.text, width=200)
ui.FloatSlider(self._model)
# Put the menu item to the "Camera" menu
with omni.kit.viewport.menubar.get_menu_item("Camera"):
# Just declare, ViewportMenuItem will be stored in the model
ViewportMenuItem(name="Camera Speed", parent="Camera", delegate=SliderMenuDelegate(self._speed_model))
ViewportMenuItem(
name="Camera Speed Scaller", parent="Camera", delegate=SliderMenuDelegate(self._speed_scale_model)
)
ADVANCED CASE EXAMPLE::
class HudMenu(ViewportMenuItem):
def build_fn(self):
# Not limited with one item per class
with ui.Menu("Hud Status"):
ui.MenuItem("FPS", checkable=True, checked=fps_checked)
ui.MenuItem("GPU Memory", checkable=True, checked=gpu_checked)
ui.MenuItem("Host Memory", checkable=True, checked=host_checked)
ui.MenuItem("Resolution", checkable=True, checked=res_checked)
API::
class ViewportMenu:
def __init__(self,
name: str = "",
icon: str = "",
appear_after: Union[list, str] = "",
hotkey: Tuple[int, int] = None,
onclick_fn: Callable = None,
delegate: ui.MenuDelegate = None
#
):
# Adds self to the registry
...
def build_fn(self):
"""
Called by the parent. Everything that is here is added to the parent
ui.Menu.
"""
# Ability to reimplement
# By default it creates a single ui.MenuItem only
...
def invalidate(self):
...
'''
from .extension import ViewportMenuBarExtension, get_instance
from .viewport_menu_model import get_item as get_menu_item, MenuDisplayStatus
from .menu_item.viewport_menu_container import ViewportMenuContainer
from .menu_item.viewport_menu_item import ViewportMenuItem
from .menu_item.viewport_menu_separator import ViewportMenuSeparator
from .menu_item.color_menu_item import AbstractColorMenuItem, FloatArraySettingColorMenuItem
from .menu_item.radio_menu_collection import RadioMenuCollection
from .menu_item.selectable_menu_item import SelectableMenuItem
from .menu_item.category_menu_collection import CategoryMenuCollection, CategoryStatus
from .menu_item.category_menu_container import CategoryMenuContainer
from .menu_item.viewport_button_item import ViewportButtonItem
from .menu_item.viewport_menubar_item import ViewportMenubar
from .menu_item.viewport_menu_spacer import ViewportMenuSpacer
from .delegate.icon_menu_delegate import IconMenuDelegate
from .delegate.slider_menu_delegate import SliderMenuDelegate
from .delegate.checkbox_menu_delegate import CheckboxMenuDelegate
from .delegate.category_menu_delegate import CategoryMenuDelegate
from .delegate.color_menu_delegate import ColorMenuDelegate
from .delegate.combobox_menu_delegate import ComboBoxMenuDelegate
from .delegate.spinner_menu_delegate import SpinnerMenuDelegate
from .delegate.viewport_menu_delegate import ViewportMenuDelegate
from .delegate.category_menu_delegate import CategoryMenuDelegate
from .delegate.separator_menu_delegate import SeparatorDelegate
from .delegate.label_menu_delegate import LabelMenuDelegate
from .delegate.abstract_widget_menu_delegate import AbstractWidgetMenuDelegate
from .model.setting_model import SettingModel, SettingModelWithDefaultValue
from .model.usd_attribute_model import USDAttributeModel, USDBoolAttributeModel, USDIntAttributeModel, USDFloatAttributeModel, USDStringAttributeModel
from .model.usd_metadata_model import USDMetadataModel
from .model.combobox_model import ComboBoxItem, ComboBoxModel, SettingComboBoxModel
from .model.list_model import SimpleListItem, SimpleListModel
from .model.category_model import SimpleCategoryModel, CategoryCollectionItem, CategoryStateItem, CategoryCustomItem, BaseCategoryItem
from .model.reset_button import ResetButton, ResetHelper
from .utils import menu_is_tearable
from .style import DEFAULT_MENUBAR_NAME, VIEWPORT_MENUBAR_STYLE
| 5,907 | Python | 37.363636 | 150 | 0.716269 |
omniverse-code/kit/exts/omni.kit.viewport.menubar.core/omni/kit/viewport/menubar/core/viewport_menu_model.py | # Copyright (c) 2021-2022, NVIDIA CORPORATION. All rights reserved.
#
# NVIDIA CORPORATION and its licensors retain all intellectual property
# and proprietary rights in and to this software, related documentation
# and any modifications thereto. Any use, reproduction, disclosure or
# distribution of this software and related documentation without an express
# license agreement from NVIDIA CORPORATION is strictly prohibited.
#
__all__ = ["AbstractViewportMenuItem", "AbstractViewportMenubarItem", "ViewportMenuModel", "register", "deregister", "get_items", "get_item", "push_to_scope", "pop_from_scope", "destroy"]
from collections import defaultdict
from typing import Dict, List, Optional, Union, TYPE_CHECKING
import weakref
import abc
from numpy import isin
import carb
import omni.ui as ui
from .model.setting_model import SettingModelWithDefaultPath
from .style import DEFAULT_MENUBAR_NAME
class MenuDisplayStatus:
MIN = 0
LABEL = 1
EXPAND = 2
MAX = 3
def Singleton(class_):
"""A singleton decorator"""
instances = {}
def getinstance(*args, **kwargs):
if class_ not in instances:
instances[class_] = class_(*args, **kwargs)
return instances[class_]
return getinstance
class AbstractViewportMenuItem(ui.AbstractItem):
"""
Represent menu item.
Kwargs:
name (str): Name of menu item. Default "" to use self.
visible_setting_path (Optional[str]): Setting path for visibility. Default None.
order_setting_path (Optional[str]): Setting path for order. Default None. Order < 0 means in left of menubar. Order > 0 means in right of menubar.
exapnd_setting_path (Optional[str]): Setting path for expand status. Default None.
"""
def __init__(
self,
name: str = "",
visible_setting_path: Optional[str] = None,
order_setting_path: Optional[str] = None,
expand_setting_path: Optional[str] = None
):
self._name = name or str(self)
if visible_setting_path:
self.visible_model = SettingModelWithDefaultPath(visible_setting_path)
else:
self.visible_model = ui.SimpleBoolModel(True)
if order_setting_path:
self.order_model = SettingModelWithDefaultPath(order_setting_path)
else:
self.order_model = ui.SimpleIntModel(-1)
if expand_setting_path:
self.expand_model = SettingModelWithDefaultPath(expand_setting_path)
else:
self.expand_model = None
# Put it to registry
self._parent = register(self)
self.clip_level = MenuDisplayStatus.MIN
super().__init__()
def destroy(self):
# Remove from registry
deregister(self)
@property
def name(self):
"""Item name"""
return self._name
@property
def parent(self):
"""Parent item"""
return self._parent
def get_display_status(self, factory_args: dict) -> MenuDisplayStatus:
"""
Menu item display status.
"""
return MenuDisplayStatus.MIN
def get_require_size(self, factory_args: dict, expand: bool = False) -> float:
"""
Required size for menu item.
kwargs:
expand (bool): True for menu item to expand. False for menu item in current display status.
"""
return 0
def expand(self, factory_args: dict) -> None:
"""
Expand display of menu item.
"""
pass
def can_contract(self, factory_args: dict) -> bool:
"""
If menu item could contract to smaller size. Default False.
"""
return False
def contract(self, factory_args: dict) -> None:
"""
Contract menu item to smaller size.
"""
return
class AbstractViewportMenubarItem(AbstractViewportMenuItem):
"""
Represent a menubar.
"""
@abc.abstractmethod
def build_fn(self, menu_items: List[AbstractViewportMenuItem], factory: Dict):
"""
Build menubar.
Args:
menu_items (List[AbstractViewportMenuItem]): Menu items to display on the menubar
"""
pass
@Singleton
class ViewportMenuModel(ui.AbstractItemModel):
def __init__(self):
super().__init__()
def destroy(self):
pass
"""General functions of ui.AbstractItemMode"""
def get_item_children(self, parent_item: Union[AbstractViewportMenuItem, AbstractViewportMenubarItem, None] = None) -> List[AbstractViewportMenuItem]:
if parent_item is None:
# Retreive all menubar items
items = get_items()
elif isinstance(parent_item, AbstractViewportMenubarItem):
# Retreive menu items for a menubar
items = get_items(parent_item.name)
else:
items = []
if items:
items.sort(key=lambda item: item.order_model.as_int)
return items
else:
return []
def get_item_value_model_count(self, item: AbstractViewportMenuItem):
"""The number of columns"""
return 1
def get_item_value_model(self, item: AbstractViewportMenuItem, column_id: int):
if item and column_id == 0:
return ui.SimpleStringModel(item.name)
return ui.SimpleStringModel("")
"""Enable drag and drop"""
def get_drag_mime_data(self, item):
"""Returns Multipurpose Internet Mail Extensions (MIME) data for be able to drop this item somewhere"""
# As we don't do Drag and Drop to the operating system, we return the string.
return item.name
def drop_accepted(self, target_item, source, drop_location=-1):
"""Reimplemented from AbstractItemModel. Called to highlight target when drag and drop."""
if isinstance(source, AbstractViewportMenuItem) and target_item:
return True
else:
return False
def drop(self, target_item, source, drop_location=-1):
"""Reimplemented from AbstractItemModel. Called when dropping something to the item."""
if isinstance(source, AbstractViewportMenuItem):
self._drop_item(target_item, source, drop_location)
def _drop_item(self, target: AbstractViewportMenuItem, source: AbstractViewportMenuItem, drop_location=-1):
items = self.get_item_children()
source_index = items.index(source)
target_index = items.index(target)
if source_index > target_index:
# Drop forward, source in front of target
if target.order_model.as_int < 0:
# Left, make order of source smaller than target
source.order_model.set_value(target.order_model.as_int - 1)
# Make sure other items in front of source has smaller order
last = source
for item in reversed(items[0 : target_index]):
if item.order_model.as_int >= last.order_model.as_int:
item.order_model.set_value(last.order_model.as_int - 1)
last = item
else:
break
else:
# Right, replace order of source with target
source.order_model.set_value(target.order_model.as_int)
# Make sure other items behind source (include target) bas bigger order
last = source
for item in items[target_index:]:
if item.order_model.as_int <= last.order_model.as_int:
item.order_model.set_value(last.order_model.as_int + 1)
last = item
else:
break
else:
# Drop backward, source behind of target
if target.order_model.as_int < 0:
# Left, replace order of source with target
source.order_model.set_value(target.order_model.as_int)
# Make sure items bwtween source and target has smaller order
last = source
for item in reversed(items[source_index + 1 : target_index + 1]):
if item.order_model.as_int >= last.order_model.as_int:
item.order_model.set_value(last.order_model.as_int - 1)
break
else:
# Right, make order of next items bigger
source.order_model.set_value(target.order_model.as_int + 1)
last = source
for item in items[target_index + 1:]:
if item.order_model.as_int <= last.order_model.as_int:
item.order_model.set_value(last.order_model.as_int + 1)
last = item
else:
break
self._item_changed(source)
self._item_changed(None)
_parentname_to_name = defaultdict(list)
_name_to_menuitem: Dict[str, AbstractViewportMenuItem] = {}
_scope_stack: List[AbstractViewportMenuItem] = []
def register(menu_item: Union[AbstractViewportMenuItem, AbstractViewportMenubarItem]) -> "weakref.ProxyType[AbstractViewportMenuItem]":
"""
Register the item in the storage. It keeps the item, so to destroy it,
it's necessary to use `deregister` or `destroy`.
It's called in the constructor of `ViewportMenuItem`, so once the item is
created, it automatically registers here.
Returns the proxy with the parent, so the child stores it and avoids
circular reference.
"""
# Name is the unique identifier
name = menu_item.name
# Get parent
if _scope_stack:
parent = _scope_stack[-1]
parent_name = parent.name
elif isinstance(menu_item, AbstractViewportMenubarItem):
# For menubar, register to root by default
parent = None
parent_name = None
elif isinstance(menu_item, AbstractViewportMenuItem):
# For menu item, register to default menubar by default
parent = get_item(DEFAULT_MENUBAR_NAME)
parent_name = DEFAULT_MENUBAR_NAME
else:
parent = None
parent_name = None
carb.log_info(f"register {name}, order: {menu_item.order_model.as_int}, parent: {parent_name}")
# Save it. We keep the object, it means we need to explicitly delete it when
# shutdown.
_parentname_to_name[parent_name].append(name)
_name_to_menuitem[name] = menu_item
if parent is None or isinstance(parent, AbstractViewportMenubarItem):
# Now only care about root menus and menubar items
ViewportMenuModel()._item_changed(parent)
# Return parent proxy to avoid circular references.
if parent:
return weakref.proxy(parent)
else:
return None
def deregister(menu_item: AbstractViewportMenuItem):
"""Remove item from the storage"""
name = menu_item.name
parent = None
parent_name = None
# parent is weakref.proxy and underlying object may already not exists
import contextlib
with contextlib.suppress(ReferenceError):
if menu_item.parent:
parent = menu_item.parent
parent_name = parent.name
carb.log_info(f"deregister {name} from {parent_name}")
if parent_name in _parentname_to_name and name in _parentname_to_name[parent_name]:
_parentname_to_name[parent_name].remove(name)
if name in _parentname_to_name:
_parentname_to_name.pop(name)
if name in _name_to_menuitem:
_name_to_menuitem.pop(name)
if parent is None or isinstance(parent, AbstractViewportMenubarItem):
# Now only care about root menus and items in root menus
# Here parent maybe a weakproxy, always use None instead
ViewportMenuModel()._item_changed(None)
def get_items(parent_name: Optional[str] = None) -> List[AbstractViewportMenuItem]:
"""Get the list of items by parent name"""
return [_name_to_menuitem[name] for name in _parentname_to_name[parent_name]]
def get_item(name: Optional[str] = None) -> AbstractViewportMenuItem:
"""Get the items by name"""
return _name_to_menuitem.get(name, None)
def push_to_scope(menu_container: "ViewportMenuContainer"):
"""
Called from `__enter__` when using `with` statement. Puts the container
to the stack so the children know their parents.
"""
_scope_stack.append(menu_container)
def pop_from_scope():
"""Called from `__exit__` when using `with` statement."""
_scope_stack.pop()
def destroy():
"""Clear items"""
_parentname_to_name.clear()
_name_to_menuitem.clear()
_scope_stack.clear()
| 12,645 | Python | 34.030471 | 187 | 0.623013 |
omniverse-code/kit/exts/omni.kit.viewport.menubar.core/omni/kit/viewport/menubar/core/preference/model.py | import omni.ui as ui
from ..viewport_menu_model import ViewportMenuModel, AbstractViewportMenuItem
from ..menu_item.viewport_menubar_item import ViewportMenubar
from ..style import DEFAULT_MENUBAR_NAME
__all__ = ["PreferenceModel"]
class PreferenceModel(ui.AbstractItemModel):
"""
Wrapper model for preference page.
Only show default menubar in preference page. So using this wrapper to get menu items for default menubar only.
"""
def __init__(self, model: ViewportMenuModel):
self._model = model
self.__sub_menubar_changed = self._model.subscribe_item_changed_fn(self.__on_menuabr_changed)
super().__init__()
def destroy(self):
self.__sub_menubar_changed = None
def get_item_children(self, parent_item=None):
if parent_item is None:
for item in self._model.get_item_children():
if item.name == DEFAULT_MENUBAR_NAME:
# Only show default menubar
return self._model.get_item_children(item)
return []
def get_item_value_model_count(self, item: AbstractViewportMenuItem):
"""The number of columns"""
return 1
def get_item_value_model(self, item: AbstractViewportMenuItem, column_id: int):
if item and column_id == 0:
return ui.SimpleStringModel(item.name)
return ui.SimpleStringModel("")
"""Enable drag and drop"""
def get_drag_mime_data(self, item):
"""Returns Multipurpose Internet Mail Extensions (MIME) data for be able to drop this item somewhere"""
# As we don't do Drag and Drop to the operating system, we return the string.
return item.name
def drop_accepted(self, target_item, source, drop_location=-1):
"""Reimplemented from AbstractItemModel. Called to highlight target when drag and drop."""
if isinstance(source, AbstractViewportMenuItem) and target_item:
return True
else:
return False
def drop(self, target_item, source, drop_location=-1):
"""Reimplemented from AbstractItemModel. Called when dropping something to the item."""
if isinstance(source, AbstractViewportMenuItem):
self._drop_item(target_item, source, drop_location)
def _drop_item(self, target: AbstractViewportMenuItem, source: AbstractViewportMenuItem, drop_location=-1):
items = self.get_item_children()
source_index = items.index(source)
target_index = items.index(target)
if source_index > target_index:
# Drop forward, source in front of target
if target.order_model.as_int < 0:
# Left, make order of source smaller than target
source.order_model.set_value(target.order_model.as_int - 1)
# Make sure other items in front of source has smaller order
last = source
for item in reversed(items[0 : target_index]):
if item.order_model.as_int >= last.order_model.as_int:
item.order_model.set_value(last.order_model.as_int - 1)
last = item
else:
break
else:
# Right, replace order of source with target
source.order_model.set_value(target.order_model.as_int)
# Make sure other items behind source (include target) bas bigger order
last = source
for item in items[target_index:]:
if item.order_model.as_int <= last.order_model.as_int:
item.order_model.set_value(last.order_model.as_int + 1)
last = item
else:
break
else:
# Drop backward, source behind of target
if target.order_model.as_int < 0:
# Left, replace order of source with target
source.order_model.set_value(target.order_model.as_int)
# Make sure items bwtween source and target has smaller order
last = source
for item in reversed(items[source_index + 1 : target_index + 1]):
if item.order_model.as_int >= last.order_model.as_int:
item.order_model.set_value(last.order_model.as_int - 1)
break
else:
# Right, make order of next items bigger
source.order_model.set_value(target.order_model.as_int + 1)
last = source
for item in items[target_index + 1:]:
if item.order_model.as_int <= last.order_model.as_int:
item.order_model.set_value(last.order_model.as_int + 1)
last = item
else:
break
self._model._item_changed(source)
self._model._item_changed(None)
self._item_changed(source)
self._item_changed(None)
def __on_menuabr_changed(self, model: ui.AbstractItemModel, item: ui.AbstractItem):
# OM-77174: update preference treeview when
# menubar item changed
# Item is None means menubar item is removed
if item is None or isinstance(item, ViewportMenubar):
self._item_changed(None) | 5,347 | Python | 43.941176 | 115 | 0.588741 |
omniverse-code/kit/exts/omni.kit.viewport.menubar.core/omni/kit/viewport/menubar/core/preference/menubar_treeview_delegate.py | import omni.ui as ui
from typing import Dict, Callable
from ..menu_item.viewport_menu_item import ViewportMenuItem
from ..viewport_menu_model import ViewportMenuModel
from ..model.combobox_model import SettingComboBoxModel
from ..model.reset_button import ResetButton
__all__ = ["AlignmentImages", "MenubarTreeViewDelegate"]
class AlignmentImages():
def __init__(self, left: bool, on_alignment_changed: Callable[[bool], None], icon_size: int = 20):
self._on_alignment_clicked = on_alignment_changed
with ui.VStack(width=0):
ui.Spacer()
with ui.HStack(spacing=10, height=0):
self._left = ui.ImageWithProvider(width=icon_size, height=icon_size, style_type_name_override="TreeView.Item.Alignment", name="left", checked=not left)
self._right = ui.ImageWithProvider(width=icon_size, height=icon_size, style_type_name_override="TreeView.Item.Alignment", name="right", checked=left)
ui.Spacer()
if left:
self._right.set_mouse_pressed_fn(lambda x, y, b, a: on_alignment_changed(False))
else:
self._left.set_mouse_pressed_fn(lambda x, y, b, a: on_alignment_changed(True))
class MenubarTreeViewDelegate(ui.AbstractItemDelegate):
"""
Delegate is the representation layer. TreeView calls the methods
of the delegate to create custom widgets for each item.
"""
def __init__(self):
super().__init__()
self._widgets: Dict[ViewportMenuItem, ui.Widget] = {}
def destroy(self):
self._widgets.clear()
def build_branch(self, model, item, column_id, level, expanded):
"""Create a branch widget that opens or closes subtree"""
pass
def build_widget(self, model: ViewportMenuModel, item: ViewportMenuItem, column_id, level, expanded):
"""Create a widget per column per item"""
if "ViewportMenuSpacer" in item.name:
# Do not show spacer here
return
if column_id == 0:
self._widgets[item] = ui.HStack(height=20)
with self._widgets[item]:
# NAME
name_model = model.get_item_value_model(item, 0)
ui.Label(name_model.as_string, style_type_name_override="TreeView.Item.Label")
ui.Spacer()
with ui.HStack(spacing=10, width=ui.Percent(60)):
# Visible
with ui.VStack(width=0):
ui.Spacer()
ui.CheckBox(item.visible_model, width=10, height=0, style_type_name_override="TreeView.Item.CheckBox")
ui.Spacer()
# Alignment
AlignmentImages(item.order_model.as_int < 0, lambda l, m=model, i=item: self._on_alignment_changed(m, i, l))
# Expand
if item.expand_model:
expand_combox_model = SettingComboBoxModel(item.expand_model.path, ["Expanded", "Collapsed"], values=[True, False])
ui.ComboBox(expand_combox_model, style_type_name_override="TreeView.Item.ComboBox")
# Line
ui.Line(width=ui.Fraction(1), style_type_name_override="TreeView.Item.Line")
# Reset button
models = [item.visible_model, item.order_model]
if item.expand_model:
models.append(item.expand_model)
reset_btn = ResetButton(models, on_reset_fn=lambda m=model, i=item: self._on_reset(m, i))
item.visible_model.set_reset_button(reset_btn)
item.order_model.set_reset_button(reset_btn)
if item.expand_model:
item.expand_model.set_reset_button(reset_btn)
def _on_alignment_changed(self, model: ViewportMenuModel, item: ViewportMenuItem, left: bool):
item.order_model.set_value(-item.order_model.as_int)
# Need to update both item and whole treeview
model._item_changed(item)
model._item_changed(None)
def _on_reset(self, model: ViewportMenuModel, item: ViewportMenuItem):
# Need to update both item and whole treeview
model._item_changed(item)
model._item_changed(None)
| 4,296 | Python | 42.40404 | 167 | 0.600093 |
omniverse-code/kit/exts/omni.kit.viewport.menubar.core/omni/kit/viewport/menubar/core/preference/menubar_page.py | from omni.kit.window.preferences import PreferenceBuilder
import omni.ui as ui
from typing import Optional
from .menubar_treeview_delegate import MenubarTreeViewDelegate
from .model import PreferenceModel
from ..viewport_menu_model import ViewportMenuModel
from ..style import VIEWPORT_PREFERENCE_STYLE
__all__ = ["ViewportMenubarPage"]
class ViewportMenubarPage(PreferenceBuilder):
"""
Represent a pereference page to show and edit viewport menubar settings.
"""
def __init__(self, model: ViewportMenuModel):
super().__init__("Viewport")
self._model = PreferenceModel(model)
self._tree_view: Optional[ui.TreeView] = None
def destroy(self):
if self._tree_view:
self._delegate.destroy()
self._tree_view.destroy()
self._tree_view = None
self._model.destroy()
def build(self):
self._delegate = MenubarTreeViewDelegate()
with self.add_frame("Viewport Toolbar"):
with ui.ScrollingFrame(style_type_name_override="TreeView.Frame", style=VIEWPORT_PREFERENCE_STYLE):
self._tree_view = ui.TreeView(self._model, delegate=self._delegate, root_visible=False) | 1,196 | Python | 35.272726 | 111 | 0.686455 |
omniverse-code/kit/exts/omni.kit.viewport.menubar.core/omni/kit/viewport/menubar/core/menu_item/color_menu_item.py | from ..delegate.color_menu_delegate import ColorMenuDelegate
from ..model.list_model import ColorModel
from .viewport_menu_item import ViewportMenuItem
from typing import List, Optional
import carb.settings
import omni.kit.app
import omni.ui as ui
import asyncio
__all__ = ["AbstractColorMenuItem", "FloatArraySettingColorMenuItem"]
class AbstractColorMenuItem(ui.MenuItem):
def __init__(self, colors: List[float], name: str = "", default: Optional[List[float]] = None, has_reset: bool = False):
self.model = ColorModel(colors, default=default, on_color_changed_fn=self.on_color_changed)
super().__init__(name, delegate=ColorMenuDelegate(model=self.model, has_reset=has_reset), hide_on_click=False)
def destroy(self):
if self.model:
self.model.destroy()
self.model = None
def on_color_changed(self, colors: List[float]) -> None:
pass
def reset(self) -> None:
pass
class FloatArraySettingColorMenuItem(AbstractColorMenuItem):
def __init__(self, setting_path: str, default: List[float], name: str = "", start_index: int = 0, has_reset: bool = False):
self._settings = carb.settings.get_settings()
self.__path = setting_path
self.__start_index = start_index
self.__default = default
self.__color_size = len(default)
# Future used to collapse carb-settings change events for individual color components
self.__future = None
# Fill in default color if the setting key does not exists at all
color_array = self._settings.get(self.__path)
if color_array is None:
color_array = [0] * (start_index + self.__color_size)
for index, value in enumerate(self.__default):
color_array[start_index + index] = value
self._settings.set(self.__path, color_array)
self.__color_subs = None
self.__create_color_subs()
super().__init__(self._get_color(), default=self.__default, name=name, has_reset=has_reset)
def __del__(self):
self.destroy()
def destroy(self):
self.__color_subs = None
super().destroy()
def __get_color_paths(self):
for i in range(self.__start_index, self.__start_index + self.__color_size):
yield f"{self.__path}/{i}"
def __create_color_subs(self):
# Create the carb-settings event watchers on the individual color components
self.__color_subs = [omni.kit.app.SettingChangeSubscription(path, self.__on_change) for path in self.__get_color_paths()]
def __on_change(self, item: carb.dictionary.Item, event_type: carb.settings.ChangeEventType) -> None:
# Since the value is a color (3/4 elements), batch the model updated into a single call
# Skip any event thats not a change
if event_type != carb.settings.ChangeEventType.CHANGED:
return
# Check if an operation is already waiting to run
if self.__future and not self.__future.done():
return
# Create the Future to signal the model is up to date
self.__future = asyncio.Future()
async def update_model():
if not self.__future.done():
self.__future.set_result(True)
colors = self._get_color()
if colors != self.model.colors:
self.model.colors = colors
asyncio.ensure_future(update_model())
def _get_color(self) -> List[float]:
return [self._settings.get(path) for path in self.__get_color_paths()]
def destroy(self):
self.__color_subs = None
super().destroy()
def on_color_changed(self, colors: List[float]) -> None:
setting_colors = self._settings.get(self.__path)
if setting_colors is None:
# TODO: create default here? or required be filled outside
return
if setting_colors[self.__start_index : self.__start_index + self.__color_size] != colors:
for index, value in enumerate(colors):
setting_colors[self.__start_index + index] = value
# Kill the change subscription before the carb.settings.set call.
# This is to optimize the array change, which will delete and recreate elemetns individually.
# This is particularly noticable for large arrays (1000+), but since colors are arrays of 4 do it always.
try:
self.__color_subs = None
self._settings.set(self.__path, setting_colors)
finally:
self.__create_color_subs()
def reset(self) -> None:
self.model.restore_default()
| 4,660 | Python | 38.5 | 129 | 0.623176 |
omniverse-code/kit/exts/omni.kit.viewport.menubar.core/omni/kit/viewport/menubar/core/menu_item/viewport_menu_container.py | # Copyright (c) 2021-2022, NVIDIA CORPORATION. All rights reserved.
#
# NVIDIA CORPORATION and its licensors retain all intellectual property
# and proprietary rights in and to this software, related documentation
# and any modifications thereto. Any use, reproduction, disclosure or
# distribution of this software and related documentation without an express
# license agreement from NVIDIA CORPORATION is strictly prohibited.
#
__all__ = ["ViewportMenuContainer"]
from ..viewport_menu_model import get_items, deregister
from ..viewport_menu_model import pop_from_scope
from ..viewport_menu_model import push_to_scope
from ..viewport_menu_model import ViewportMenuModel
from .viewport_menu_item import ViewportMenuItem
from typing import Dict
import omni.ui as ui
class ViewportMenuContainer(ViewportMenuItem):
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
# When visible and order changed, trigger UI updates
self._visible_sub = self.visible_model.subscribe_value_changed_fn(lambda m: self._invalidate())
self._order_sub = self.order_model.subscribe_value_changed_fn(lambda m: self._invalidate())
def destroy(self):
self._visible_sub = None
self._order_sub = None
# Clean children
self._clean()
super().destroy()
def build_fn(self, factory: Dict):
"""Reimplement it to have own customized item"""
children = self._children
# TODO: Lazy menu
with ui.Menu(self.name, delegate=self._delegate, style=self._style):
for child in children:
child.build_fn(factory)
def __enter__(self):
# Clean all existing child items
# For multiple viewport window, menu contrainer may build multiple times
# Make sure child items not duplicated
self._clean()
push_to_scope(self)
def __exit__(self, exc_type, exc_value, traceback):
pop_from_scope()
@property
def _children(self):
# TODO: Sorting code
return get_items(self.name)
def _invalidate(self) -> None:
ViewportMenuModel()._item_changed(None)
def _clean(self):
for child in self._children:
child.destroy() | 2,244 | Python | 32.507462 | 103 | 0.67246 |
omniverse-code/kit/exts/omni.kit.viewport.menubar.core/omni/kit/viewport/menubar/core/menu_item/viewport_menu_item.py | # Copyright (c) 2021-2022, NVIDIA CORPORATION. All rights reserved.
#
# NVIDIA CORPORATION and its licensors retain all intellectual property
# and proprietary rights in and to this software, related documentation
# and any modifications thereto. Any use, reproduction, disclosure or
# distribution of this software and related documentation without an express
# license agreement from NVIDIA CORPORATION is strictly prohibited.
#
__all__ = ["ViewportMenuItem"]
from ..viewport_menu_model import AbstractViewportMenuItem
from typing import Callable, Dict, Optional
import omni.ui as ui
class ViewportMenuItem(AbstractViewportMenuItem):
def __init__(
self,
name: str = "",
icon: str = "", # glyph?
hide_on_click: bool = True,
appear_after: str = "", # order/priority?
onclick_fn: Callable = None,
delegate: ui.MenuDelegate = None,
visible_setting_path: Optional[str] = None,
order_setting_path: Optional[str] = None,
expand_setting_path: Optional[str] = None,
style: Dict = {},
order: int = None # deprecated legacy interface
):
self._icon = icon
self._hide_on_click = hide_on_click
self._appear_after = appear_after
self._onclick_fn = onclick_fn
self._delegate = delegate
self._style = style
self._menu_item: Optional[ui.MenuItem] = None
super().__init__(
name,
visible_setting_path=visible_setting_path,
order_setting_path=order_setting_path,
expand_setting_path=expand_setting_path,
)
if (order_setting_path is None) and (order is not None):
import carb
carb.log_warn(f"ViewportMenuItem order argument is deprecated, use order_setting_path")
self.order_model = ui.SimpleIntModel(order)
def destroy(self):
self._onclick_fn = None
self._delegate = None
super().destroy()
@property
def visible(self) -> bool:
return self.visible_model.as_bool
@visible.setter
def visible(self, value: bool) -> None:
self.visible_model.set_value(value)
if self._menu_item:
self._menu_item.visible = value
@property
def menu_item(self) -> ui.MenuItem:
return self._menu_item
def build_fn(self, factory: Dict):
"""Reimplement it to have own customized item"""
self._menu_item = ui.MenuItem(
self.name,
triggered_fn=self._onclick_fn,
delegate=self._delegate,
hide_on_click=self._hide_on_click,
visible=self.visible_model.as_bool,
style=self._style,
)
def invalidate(self):
pass
| 2,752 | Python | 31.773809 | 99 | 0.619549 |
omniverse-code/kit/exts/omni.kit.viewport.menubar.core/omni/kit/viewport/menubar/core/menu_item/selectable_menu_item.py | from typing import Callable
from ..delegate.viewport_menu_delegate import ViewportMenuDelegate
from omni import ui
__all__ = ["SelectableMenuItem"]
class SelectableMenuItem(ui.MenuItem):
"""Menu item could be selected and show icon when selected.
kwargs:
model (ui.AbstractValueModel): Model for selected status. Defaults to a ui.SimpleBoolModel when not provided.
toggle (bool): Whether this item can be toggled to (on/off) or always triggers on
For other kwargs, please refer to ui.MenuItem
"""
def __init__(self, name: str,
model: ui.AbstractValueModel = None,
delegate: ui.MenuDelegate = None,
hide_on_click: bool = False,
toggle: bool = True,
triggered_fn: Callable = None,
trigger_will_set_model: bool = False,
**kwargs):
if model is None:
model = ui.SimpleBoolModel()
if delegate is None:
delegate = ViewportMenuDelegate()
self._triggered_fn = triggered_fn
self.__trigger_will_set_model = trigger_will_set_model
kwargs['triggered_fn'] = self._on_triggered
if toggle:
kwargs['selected'] = kwargs.get('selected', model.as_bool)
else:
kwargs['checkable'] = kwargs.get('checkable', True)
kwargs['checked'] = kwargs.get('checked', model.as_bool)
super().__init__(
name,
delegate=delegate,
hide_on_click=hide_on_click,
**kwargs
)
self._sub = model.subscribe_value_changed_fn(self._on_value_changed)
self.model = model
self.__toggle = toggle
def __del__(self):
self.destroy()
def destroy(self) -> None:
self.set_triggered_fn(None)
model, self.model, self._sub = self.model, None, None
if model:
if hasattr(model, 'destroy'):
model.destroy()
super().destroy()
def _on_triggered(self) -> None:
if not self.__trigger_will_set_model:
if self.__toggle:
self.model.set_value(not self.model.as_bool)
else:
self.model.set_value(True)
if self._triggered_fn:
self._triggered_fn()
def _on_value_changed(self, model: ui.AbstractValueModel) -> None:
# When value changed, update selected status
value = model.as_bool
attr_name = 'selected' if self.__toggle else 'checked'
if getattr(self.delegate, attr_name) != value:
setattr(self.delegate, attr_name, value)
| 2,635 | Python | 33.233766 | 117 | 0.576471 |
omniverse-code/kit/exts/omni.kit.viewport.menubar.core/omni/kit/viewport/menubar/core/menu_item/viewport_menu_separator.py | # Copyright (c) 2021-2022, NVIDIA CORPORATION. All rights reserved.
#
# NVIDIA CORPORATION and its licensors retain all intellectual property
# and proprietary rights in and to this software, related documentation
# and any modifications thereto. Any use, reproduction, disclosure or
# distribution of this software and related documentation without an express
# license agreement from NVIDIA CORPORATION is strictly prohibited.
#
__all__ = ["ViewportMenuSeparator"]
from .viewport_menu_item import ViewportMenuItem
from typing import Dict
import omni.ui as ui
class ViewportMenuSeparator(ViewportMenuItem):
"""A simple separator"""
def build_fn(self, factory: Dict):
ui.Separator(
delegate=ui.MenuDelegate(
on_build_item=lambda _: ui.Line(
height=0, alignment=ui.Alignment.V_CENTER, style_type_name_override="Menu.Separator"
)
)
)
| 938 | Python | 33.777777 | 104 | 0.702559 |
omniverse-code/kit/exts/omni.kit.viewport.menubar.core/omni/kit/viewport/menubar/core/menu_item/category_menu_collection.py | import omni.kit.app
from omni import ui
from ..model.category_model import SimpleCategoryModel, CategoryStateItem, CategoryCollectionItem, CategoryCustomItem
from ..delegate.category_menu_delegate import CategoryMenuDelegate, CategoryStatus
from ..utils import menu_is_tearable
from .selectable_menu_item import SelectableMenuItem
from typing import Callable, Dict, Optional
__all__ = ["CategoryMenuCollection"]
class CategoryMenuCollection(ui.MenuItemCollection):
"""
A Menu with ratio sub menu items.
Args:
text (str): Menu text
model (SimpleCategoryModel): Model for sub menu items
item (CategoryCollectionItem): Item for this collection
"""
def __init__(self, model: SimpleCategoryModel, item: CategoryCollectionItem, identifier: str = None,
trigger_fns: Optional[Dict[str, Callable]] = None):
# XXX: trigger_fns is a workaround for omni.kit.viewport.menubar.display
# do not expect it will always exists!
self.__trigger_fns: Optional[Dict[str, Callable]] = trigger_fns
self.__identifier = identifier
self._model = model
self._item = item
self._delegate = CategoryMenuDelegate(item.status, icon_clicked_fn=self._on_icon_clicked)
self._sub = self._item.status_model.subscribe_value_changed_fn(self._on_status_changed)
super().__init__(item.text, delegate=self._delegate,
on_build_fn=self._build_menu_items,
hide_on_click=False,
tearable=menu_is_tearable(identifier),
shown_changed_fn=item.shown_changed_fn)
def destroy(self) -> None:
self._sub = None
if self._item:
self._item.destroy()
self._item = None
self.__trigger_fns = None
super().destroy()
def _build_menu_items(self):
custom_items = []
def attach_trigger_fn(item, name: str):
if self.__trigger_fns and item and name:
# Try to pull a triggered_fn from the ones provided
trigger_fn = self.__trigger_fns.get(name)
if trigger_fn:
item.set_triggered_fn(trigger_fn)
show_separator = False
for item in self._model.get_item_children(self._item):
name: str = getattr(item, "text", "")
if isinstance(item, CategoryStateItem):
item = SelectableMenuItem(item.text, model=item.value_model)
show_separator = True
if isinstance(item, CategoryCollectionItem):
item = CategoryMenuCollection(self._model, item)
show_separator = True
elif isinstance(item, CategoryCustomItem):
item = custom_items.append(item)
attach_trigger_fn(item, name)
if custom_items:
# Custom items have different states from other category items
# Show a separator here if required
if show_separator:
ui.Separator()
for item in custom_items:
name: str = getattr(item, "text", "")
item = item.build_fn()
attach_trigger_fn(item, name)
def _on_status_changed(self, model: ui.AbstractValueModel) -> None:
self._delegate.status = self._item.status
def _on_icon_clicked(self, x, y, button, modifiers) -> None:
import carb
if button != int(carb.input.MouseInput.LEFT_BUTTON):
return
# XXX: trigger_fns workaround to avoid status-model subscriptions firing multiple times.
#
# There is a checken-egg problem here, where if the trigger_fn is run first the it must know about
# all-items current state to follow the all, empty, mixed model...but if run after then, the trigger_fn
# has no idea of what item transitioned to what state. Opting to deal with the first issue as this is
# only used for "Show By Type" where the bigger win is performance from batching all state transition into
# one UsdStage Traversal.
# But that means the status must be saved first, as triggered_fn may change child item state, which would affect
# how the models urrent state is chosen when it is run afterward.
cur_status = self._delegate.status
if cur_status == CategoryStatus.EMPTY or cur_status == CategoryStatus.MIXED:
cur_status = CategoryStatus.ALL
else:
cur_status = CategoryStatus.EMPTY
if self.__trigger_fns:
trigger_fn = self.__trigger_fns.get(self.__identifier)
if trigger_fn:
trigger_fn()
self._item.status = cur_status
| 4,729 | Python | 42 | 120 | 0.621062 |
omniverse-code/kit/exts/omni.kit.viewport.menubar.core/omni/kit/viewport/menubar/core/menu_item/viewport_menu_spacer.py | # Copyright (c) 2021-2022, NVIDIA CORPORATION. All rights reserved.
#
# NVIDIA CORPORATION and its licensors retain all intellectual property
# and proprietary rights in and to this software, related documentation
# and any modifications thereto. Any use, reproduction, disclosure or
# distribution of this software and related documentation without an express
# license agreement from NVIDIA CORPORATION is strictly prohibited.
#
__all__ = ["ViewportMenuSpacer"]
from .viewport_menu_item import ViewportMenuItem
from typing import Dict
import omni.ui as ui
class ViewportMenuSpacer(ViewportMenuItem):
"""A simple spacer"""
def __init__(self):
self.__spacer: Dict[int, ui.Spacer] = {}
super().__init__(order_setting_path="/exts/omni.kit.viewport.menubar.core/spacer/order")
def build_fn(self, factory_args: Dict):
viewport_api_id = factory_args['viewport_api'].id
self.__spacer[viewport_api_id] = ui.Spacer()
def get_computed_width(self, factory_args: Dict) -> float:
viewport_api_id = factory_args['viewport_api'].id
return self.__spacer[viewport_api_id].computed_width if viewport_api_id in self.__spacer else 0
| 1,185 | Python | 39.89655 | 103 | 0.720675 |
omniverse-code/kit/exts/omni.kit.viewport.menubar.core/omni/kit/viewport/menubar/core/menu_item/category_menu_container.py | from ..model.category_model import CategoryCustomItem, SimpleCategoryModel, CategoryStateItem, CategoryCollectionItem, CategoryStatus
from .category_menu_collection import CategoryMenuCollection
from .selectable_menu_item import SelectableMenuItem
from typing import Callable, Dict, Optional
__all__ = ["CategoryMenuContainer"]
class CategoryMenuContainer:
def __init__(self, model: SimpleCategoryModel, identifier: Optional[str] = None,
trigger_fns: Optional[Dict[str, Callable]] = None):
self._model = model
self.__identifier = identifier
self.build(trigger_fns)
def build(self, trigger_fns: Optional[Dict[str, Callable]] = None):
# XXX: trigger_fns is a workaround for omni.kit.viewport.menubar.display
# do not expect it will always exists!
for item in self._model.get_item_children():
name: str = getattr(item, "text", "")
if isinstance(item, CategoryCollectionItem):
identifier = f"{self.__identifier}.{name}" if self.__identifier else None
item = CategoryMenuCollection(self._model, item, identifier=identifier, trigger_fns=trigger_fns)
elif isinstance(item, CategoryStateItem):
item = SelectableMenuItem(name=name, model=item.value_model)
elif isinstance(item, CategoryCustomItem):
item = item.build_fn()
# Try to pull a triggered_fn from the ones provided
if trigger_fns and item and name:
trigger_fn = trigger_fns.get(name)
if trigger_fn:
item.set_triggered_fn(trigger_fn)
| 1,650 | Python | 46.171427 | 133 | 0.65697 |
omniverse-code/kit/exts/omni.kit.viewport.menubar.core/omni/kit/viewport/menubar/core/menu_item/viewport_menubar_item.py | # Copyright (c) 2021-2022, NVIDIA CORPORATION. All rights reserved.
#
# NVIDIA CORPORATION and its licensors retain all intellectual property
# and proprietary rights in and to this software, related documentation
# and any modifications thereto. Any use, reproduction, disclosure or
# distribution of this software and related documentation without an express
# license agreement from NVIDIA CORPORATION is strictly prohibited.
#
__all__ = ["ViewportMenubar"]
import asyncio
from dataclasses import dataclass, fields, field
from functools import partial
from ..viewport_menu_model import AbstractViewportMenuItem, AbstractViewportMenubarItem, ViewportMenuModel, push_to_scope, pop_from_scope, MenuDisplayStatus
from .viewport_menu_spacer import ViewportMenuSpacer
from typing import Callable, Dict, Optional, List
import omni.kit.app
import omni.ui as ui
from ..style import VIEWPORT_MENUBAR_STYLE
@dataclass
class MenubarContext:
frame: ui.Frame = None
background_rectangle: ui.Rectangle = None
resize_future: asyncio.Future = None
spacer_width: float = -1
sub_menu_expand: Dict = field(default_factory=dict)
def __init__(self, **kwargs):
names = set([f.name for f in fields(self)])
for k, v in kwargs.items():
if k in names:
setattr(self, k, v)
if not hasattr(self, "sub_menu_expand"):
self.sub_menu_expand = {}
class ViewportMenubar(AbstractViewportMenubarItem):
""""
Default viewport menubar, at the top of viewport.
Args:
name (str): Name of viewport menubar.
direction (ui.Direction): Layout direction of menu items in this menubar. Default ui.Direction.LEFT_TO_RIGHT.
spacing (ui.Length): Spacing between items. Default 10 pixles.
background_visible (bool): Show background for menu bar. Default False.
"""
def __init__(self,
name: str="",
direction: ui.Direction=ui.Direction.LEFT_TO_RIGHT,
spacing: ui.Length = 10,
style: Dict = {},
background_visible: bool = False,
visible_setting_path: Optional[str] = None,
):
self._direction = direction
self.__spacing = spacing
self._style = VIEWPORT_MENUBAR_STYLE.copy()
self._style.update(style)
self.__background_visible: bool = background_visible
self.__show_separator: bool = False
self.__context: Dict[int, MenubarContext] = {}
super().__init__(name=name, visible_setting_path=visible_setting_path)
@property
def visible(self) -> bool:
return self.visible_model.as_bool
@visible.setter
def visible(self, value: bool) -> None:
old_value = self.visible_model.as_bool
if old_value != value:
self.visible_model.set_value(value)
ViewportMenuModel()._item_changed(None)
@property
def background_visible(self) -> bool:
return self.__background_visible
@background_visible.setter
def background_visible(self, visible: bool) -> None:
self.__background_visible = visible
for context in self.__context.values():
context.background_rectangle.visible = self.__background_visible
@property
def style(self) -> Dict:
return self._style
@property
def spacing(self) -> ui.Length:
return self.__spacing
@spacing.setter
def spacing(self, value: ui.Length) -> None:
self.__spacing == value
for context in self.__context.values():
context.frame.rebuild()
@property
def show_separator(self) -> bool:
return self.__show_separator
@show_separator.setter
def show_separator(self, visible: bool) -> None:
self.__show_separator = visible
for context in self.__context.values():
context.frame.rebuild()
def destroy(self):
for context in self.__context.values():
if context.resize_future and not context.resize_future.done():
context.resize_future.cancel()
self.__context = {}
super().destroy()
def build_fn(self, menu_items: List[AbstractViewportMenuItem], factory_args: Dict, content_clipping=True):
# Using Frame with horizontal_clipping to prevent expanding of widgets when the menu bar is big
extra_kwargs = {}
if self._direction == ui.Direction.LEFT_TO_RIGHT:
extra_kwargs = {"height": 0}
elif self._direction == ui.Direction.TOP_TO_BOTTOM:
extra_kwargs = {"width": 0}
viewport_api_id = factory_args['viewport_api'].id
self.__context[viewport_api_id] = MenubarContext()
with ui.ZStack(style=self._style, height=0):
self.__context[viewport_api_id].background_rectangle = ui.Rectangle(style_type_name_override="MenuBar.Window", visible=self.__background_visible)
self.__context[viewport_api_id].frame = ui.Frame(horizontal_clipping=True, **extra_kwargs)
with self.__context[viewport_api_id].frame:
self._build_menubar(menu_items, factory_args, content_clipping=content_clipping)
self.__menu_items = menu_items
self.__available_clip_levels = [MenuDisplayStatus.EXPAND, MenuDisplayStatus.LABEL]
self.__clip_level = MenuDisplayStatus.MIN
self.__clip_size = {}
for level in self.__available_clip_levels:
self.__clip_size[level] = {}
self.__context[viewport_api_id].frame.set_computed_content_size_changed_fn(partial(self.__resize_menubar, factory_args))
def _build_menubar(self, menu_items: List[AbstractViewportMenuItem], factory_args: Dict, content_clipping=True):
viewport_api_id = factory_args['viewport_api'].id
# Filter out all hidden children
visible_menu_items = [item for item in menu_items if item.visible_model.as_bool]
# If all that remains is an empty list or a list of only ViewportMenuSpacer, then no menu
if sum(1 for item in visible_menu_items if (not isinstance(item, ViewportMenuSpacer))) == 0:
self.__context[viewport_api_id].frame.clear()
return
with ui.Menu(direction=self._direction, menu_compatibility=False, content_clipping=content_clipping):
first = True
for item in visible_menu_items:
if not first:
if self.__show_separator:
ui.Separator(
delegate=ui.MenuDelegate(
on_build_item=lambda _: ui.Line(
width=0,
alignment=ui.Alignment.H_CENTER,
style_type_name_override="Menu.Separator",
)
)
)
else:
if self._direction == ui.Direction.LEFT_TO_RIGHT:
ui.Spacer(width=self.__spacing)
else:
ui.Spacer(height=self.__spacing)
first = False
item.build_fn(factory_args)
if item.expand_model:
self.__context[viewport_api_id].sub_menu_expand[item] = item.expand_model.subscribe_value_changed_fn(lambda _, f=factory_args: self.__on_menu_expand_changed(f))
def invalidate(self):
pass
def __enter__(self):
# Clean all existing child items
# For multiple viewport window, menu contrainer may build multiple times
# Make sure child items not duplicated
# self._clean()
push_to_scope(self)
def __exit__(self, exc_type, exc_value, traceback):
pop_from_scope()
def __resize_menubar(self, factory_args: dict) -> None:
viewport_api_id = factory_args['viewport_api'].id
if self.__context[viewport_api_id].resize_future and not self.__context[viewport_api_id].resize_future.done():
return
self.__context[viewport_api_id].resize_future = asyncio.ensure_future(self.__resize_menubar_async(factory_args))
async def __resize_menubar_async(self, factory_args: dict) -> None:
viewport_api_id = factory_args['viewport_api'].id
menu_items = [item for item in self.__menu_items if item.visible_model.as_bool and not isinstance(item, ViewportMenuSpacer)]
# We need to know spacer size to check if items need resize
# Here use the default spacer item
spacer_items = [item for item in self.__menu_items if isinstance(item, ViewportMenuSpacer) and item.order_model.as_int == 0]
if spacer_items:
spacer_item = spacer_items[0]
else:
return
resize_again = True
while resize_again:
spacer_width = spacer_item.get_computed_width(factory_args)
resize_again = False
if spacer_width == 0:
# No more space left, check if something need to contract
resize_again = self.__check_contract(menu_items, factory_args)
elif spacer_width < self.__context[viewport_api_id].spacer_width or self.__context[viewport_api_id].spacer_width < 0:
# Spacer becomes small, check contract
# Some menu items such as Camera settings, maybe not expanded but need to check if enough space for expand settings
# Otherwise need to hide expand button
require_size = 0
for item in menu_items:
require_size += item.get_require_size(factory_args, expand=False)
if require_size > spacer_width:
resize_again = self.__check_contract(menu_items, factory_args)
elif spacer_width > self.__context[viewport_api_id].spacer_width:
# Spacer becomes bigger, check if we can expand menu items
require_size = 0
expand_items: List[AbstractViewportMenuItem] = []
for item in menu_items:
require_size += item.get_require_size(factory_args, expand=True)
expand_items.append(item)
if require_size < spacer_width:
for item in expand_items:
item.expand(factory_args)
resize_again = True
self.__context[viewport_api_id].spacer_width = spacer_width
if resize_again:
# Already resized, wait for menubar updated
# Need at least 2 frames for a new Viewport window
for i in range(2):
await omni.kit.app.get_app().next_update_async()
def __check_contract(self, menu_items: List[AbstractViewportMenuItem], factory_args: dict) -> bool:
contract_items: Dict[MenuDisplayStatus, List[AbstractViewportMenuItem]] = {}
# Figure how to contract
# Since there are different display status for different menu items
# Contract expand first and lable next
max_contract_status = MenuDisplayStatus.MIN
for item in menu_items:
display_status = item.get_display_status(factory_args)
if display_status == MenuDisplayStatus.MIN:
# Already in min display status, nothing to contract
continue
else:
if item.can_contract(factory_args):
# Record items can contract here but contract later
if display_status not in contract_items:
contract_items[display_status] = []
contract_items[display_status].append(item)
max_contract_status = max(display_status, max_contract_status)
contracted = False
# Only contract for one status: expand or label
if max_contract_status != MenuDisplayStatus.MIN:
for item in contract_items[max_contract_status]:
item.contract(factory_args)
contracted = True
return contracted
def __on_menu_expand_changed(self, factory_args: Dict):
# OM-64798: Menu item expand status changed, need to reset saved spacer width
viewport_api_id = factory_args['viewport_api'].id
spacer_items = [item for item in self.__menu_items if isinstance(item, ViewportMenuSpacer) and item.order_model.as_int == 0]
if spacer_items:
spacer_item = spacer_items[0]
async def __update_spacer_width():
await omni.kit.app.get_app().next_update_async()
self.__context[viewport_api_id].spacer_width = spacer_item.get_computed_width(factory_args)
asyncio.ensure_future(__update_spacer_width())
else:
return
| 12,770 | Python | 42.736301 | 180 | 0.61206 |
omniverse-code/kit/exts/omni.kit.viewport.menubar.core/omni/kit/viewport/menubar/core/menu_item/radio_menu_collection.py | from omni import ui
from ..model.combobox_model import ComboBoxModel
from ..delegate.viewport_menu_delegate import ViewportMenuDelegate
from ..utils import menu_is_tearable
from .viewport_menu_separator import ViewportMenuSeparator
__all__ = ["RadioMenuCollection"]
class RadioMenuCollection(ui.MenuItemCollection):
"""
A Menu with ratio sub menu items.
Args:
text (str): Menu text
model (ComboBoxModel): Model for sub menu items
hide_on_click (bool): Whether to hide the menu when an item is clicked
can_toggle_off (bool): Whether clicking an already selected item will togle it to off
delegate (ui.MenuDelegate): Delegate to show this menu collection
"""
def __init__(
self,
text: str,
model: ComboBoxModel,
identifier: str = None,
hide_on_click: bool = False,
can_toggle_off: bool = False,
delegate: ui.MenuDelegate = None
):
self._model = model
self._hide_on_click = hide_on_click
self.__menu_items = []
self.__in_triggered = False
self.__can_toggle_off = can_toggle_off
super().__init__(text, delegate=delegate, on_build_fn=self._build_menu_items, tearable=menu_is_tearable(identifier))
def __destroy_menu_items(self, value=None):
if self.__menu_items:
for menu_item in self.__menu_items:
menu_item.destroy()
self.__menu_items = value
def destroy(self) -> None:
model, self._model, self._sub = self._model, None, None
if model and hasattr(model, 'destroy'):
model.destroy()
self.__destroy_menu_items(None)
super().destroy()
def _build_menu_items(self):
self.__destroy_menu_items([])
with self:
for index, item in enumerate(self._model.get_item_children(None)):
menu_item = self.build_menu_item(item)
if not isinstance(menu_item, ViewportMenuSeparator):
menu_item.checkable = True
menu_item.checked=index == self._model.current_index.as_int
menu_item.set_triggered_fn(lambda i=index: self._item_chosen(i))
menu_item.hide_on_click=self._hide_on_click
# Only need to save the menu-item if cannot toggle to off
if not bool(self.__can_toggle_off):
self.__menu_items.append(menu_item)
# When current is changed outside, update menu items
self._sub = self._model.current_index.subscribe_value_changed_fn(self._on_current_changed)
self._sub_model = self._model.subscribe_item_changed_fn(self._on_item_changed)
def build_menu_item(self, item: ui.AbstractItem) -> ui.MenuItem:
return ui.MenuItem(
item.model.as_string,
delegate=ViewportMenuDelegate(),
)
def _item_chosen(self, index: int):
try:
self.__in_triggered = True
# Set the current index if it has changed
current_index = self._model.current_index.as_int if (self._model and self._model.current_index) else None
if current_index != index:
self._model.current_index.set_value(index)
elif (not bool(self.__can_toggle_off)) and self.__menu_items and index < len(self.__menu_items):
# Force the check state on in the case that it hasn't
import asyncio
async def force_checked_state(index: int, checked: bool):
self.__menu_items[index].checked = checked
asyncio.ensure_future(force_checked_state(index, True))
finally:
self.__in_triggered = False
def _on_current_changed(self, model: ui.AbstractValueModel):
if not self.__in_triggered:
self.invalidate()
def _on_item_changed(self, model: ui.AbstractValueModel, item: ui.AbstractItem):
self.invalidate()
| 3,965 | Python | 40.3125 | 124 | 0.607818 |
omniverse-code/kit/exts/omni.kit.viewport.menubar.core/omni/kit/viewport/menubar/core/menu_item/viewport_button_item.py | # Copyright (c) 2021-2022, NVIDIA CORPORATION. All rights reserved.
#
# NVIDIA CORPORATION and its licensors retain all intellectual property
# and proprietary rights in and to this software, related documentation
# and any modifications thereto. Any use, reproduction, disclosure or
# distribution of this software and related documentation without an express
# license agreement from NVIDIA CORPORATION is strictly prohibited.
#
__all__ = ["ViewportButtonItem"]
from ..viewport_menu_model import AbstractViewportMenuItem, ViewportMenuModel
import asyncio
from typing import Callable, Dict, Optional, List
import omni.kit.app
import omni.ui as ui
from ..style import VIEWPORT_MENUBAR_STYLE
class ViewportButtonItem(AbstractViewportMenuItem):
"""
Build a button in viewport menubar:
Left click: toggle
Right click: flyout window or menu options
Kwargs:
build_menu_fn (Callable[[None], List[ui.MenuItem]]): Callback to create flyout menu when right click
build_window_fn (Callable[[None], ui.Window]): Callback to create flyout window when right click
alignment (ui.Alignment): How flyout window/menu align with button.
"""
def __init__(
self,
text: str = "",
name: str = "",
onclick_fn: Callable = None,
build_menu_fn: Callable[[None], List[ui.MenuItem]] = None,
build_window_fn: Callable[[None], ui.Window] = None,
visible_setting_path: Optional[str] = None,
order_setting_path: Optional[str] = None,
expand_setting_path: Optional[str] = None,
alignment: ui.Alignment = ui.Alignment.RIGHT_BOTTOM,
enabled: bool = True,
has_triangle: bool = False,
triangle_size: float = 6,
style: Dict = {},
):
self._text = text
self._onclick_fn = onclick_fn
self._build_menu_fn = build_menu_fn
self._build_window_fn = build_window_fn
self._style = style
self._alignment = alignment
self._enabled = enabled
self._selected = False
self._checked = False
self._has_triangle = has_triangle
self._triangle_size = triangle_size
self._menu: Optional[ui.MenuItem] = None
self._window: Optional[ui.Window] = None
self._button: Optional[ui.Button] = None
super().__init__(
name,
visible_setting_path=visible_setting_path,
order_setting_path=order_setting_path,
expand_setting_path=expand_setting_path,
)
# When visible and order changed, trigger UI updates
self._visible_sub = self.visible_model.subscribe_value_changed_fn(lambda m: self._invalidate())
self._order_sub = self.order_model.subscribe_value_changed_fn(lambda m: self._invalidate())
def destroy(self):
self._visible_sub = None
self._order_sub = None
self._onclick_fn = None
if self._menu:
self._menu.hide()
self._menu = None
if self._window:
self._window.visible = False
self._window = None
super().destroy()
@property
def visible(self) -> bool:
return self.visible_model.as_bool
@visible.setter
def visible(self, value: bool) -> None:
self.visible_model.set_value(value)
if self._menu:
self._menu.hide()
@property
def menu_item(self) -> ui.Menu:
return self._menu
@property
def window(self) -> ui.Window:
return self._window
@property
def name(self) -> str:
return self._name
@name.setter
def name(self, value: str) -> None:
self._name = value
if self._button:
self._button.name = value
@property
def enabled(self) -> bool:
return self._enabled
@enabled.setter
def enabled(self, value: bool) -> None:
self._enabled = value
if self._button:
self._button.enabled = value
@property
def selected(self) -> bool:
return self._selected
@selected.setter
def selected(self, value: bool) -> None:
self._selected = value
if self._button:
self._button.selected = value
@property
def checked(self) -> bool:
return self._checked
@checked.setter
def checked(self, value: bool) -> None:
self._checked = value
if self._button:
self._button.checked = value
def build_fn(self, factory: Dict):
"""Reimplement it to have own customized item"""
self._container = ui.ZStack(width=0)
with self._container:
if self._has_triangle:
with ui.VStack():
with ui.HStack():
ui.Spacer()
with ui.VStack(width=self._triangle_size):
ui.Spacer()
ui.Triangle(
width=self._triangle_size,
height=self._triangle_size,
alignment=ui.Alignment.RIGHT_TOP,
style_type_name_override="MenuBar.Item.Triangle",
)
ui.Spacer(width=2)
ui.Spacer(height=2)
ui.Rectangle(style_type_name_override="MenuBar.Item.Background")
self._button = ui.Button(
self._text,
name=self.name,
enabled=self._enabled,
selected=self._selected,
checked=self._checked,
width=0,
image_width=20,
visible=self.visible_model.as_bool,
style=self._style,
style_type_name_override="Menu.Button",
)
ui.Rectangle(style_type_name_override="Menubar.Hover")
self._container.set_mouse_pressed_fn(lambda x, y, b, a: self._on_mouse_clicked_fn(b))
def _build_menu(self):
style = VIEWPORT_MENUBAR_STYLE.copy()
style.update(self._style)
self._menu = ui.Menu("Button_Menu_" + str(hash(self)), menu_compatibility=False, style=style)
with self._menu:
self._menu_items = self._build_menu_fn()
def invalidate(self):
if self._menu:
self._menu.invalidate()
def _on_mouse_clicked_fn(self, button):
if button == 1:
self.on_right_clicked_fn()
elif button == 0:
if self._onclick_fn:
self._onclick_fn()
def on_right_clicked_fn(self):
"""Show flyout window/menu"""
if self._build_menu_fn:
self._show_menu()
elif self._build_window_fn:
self._show_window()
def _show_menu(self):
if self._menu is None:
self._build_menu()
(x, y) = (0, 0)
if self._alignment == ui.Alignment.RIGHT_BOTTOM:
x = self._container.screen_position_x + self._container.computed_content_width
y = self._container.screen_position_y + self._container.computed_content_height
if self._menu_items:
menu_window_width = self._menu_items[0].computed_content_width
if menu_window_width <= 0:
self._menu.show_at(-500, -100)
self._menu.hide()
async def __delay_change_menu_window_position(x, y):
await omni.kit.app.get_app().next_update_async()
x -= self._menu_items[0].computed_content_width
self._menu.show_at(x, y)
asyncio.ensure_future(__delay_change_menu_window_position(x, y))
return
else:
x -= self._menu_items[0].computed_content_width
elif self._alignment == ui.Alignment.LEFT_BOTTOM:
x = self._container.screen_position_x
y = self._container.screen_position_y + self._container.computed_content_height
self._menu.show_at(x, y)
def _show_window(self):
if self._window is None:
self._window = self._build_window_fn()
(x, y) = (0, 0)
if self._alignment == ui.Alignment.RIGHT_BOTTOM:
x = self._container.screen_position_x + self._container.computed_content_width
y = self._container.screen_position_y + self._container.computed_content_height
if self._window:
window_width = self._window.frame.computed_width
if window_width <= 0:
self._window.position_x = -500
self._window.position_y = -100
self._window.visible = True
async def __delay_change_window_position(x, y):
while self._window.frame.computed_width <= 0:
await omni.kit.app.get_app().next_update_async()
x -= self._window.frame.computed_width
self._window.position_x = x
self._window.position_y = y
self._window.visible = True
asyncio.ensure_future(__delay_change_window_position(x, y))
return
else:
x -= window_width
elif self._alignment == ui.Alignment.LEFT_BOTTOM:
x = self._container.screen_position_x
y = self._container.screen_position_y + self._container.computed_content_height
self._window.position_x = x
self._window.position_y = y
self._window.visible = True
def _invalidate(self) -> None:
ViewportMenuModel()._item_changed(None) | 9,718 | Python | 35.130111 | 108 | 0.557625 |
omniverse-code/kit/exts/omni.kit.viewport.menubar.core/omni/kit/viewport/menubar/core/delegate/spinner_menu_delegate.py | # Copyright (c) 2021-2022, NVIDIA CORPORATION. All rights reserved.
#
# NVIDIA CORPORATION and its licensors retain all intellectual property
# and proprietary rights in and to this software, related documentation
# and any modifications thereto. Any use, reproduction, disclosure or
# distribution of this software and related documentation without an express
# license agreement from NVIDIA CORPORATION is strictly prohibited.
#
__all__ = ["SpinnerMenuDelegate"]
from typing import Union, Optional
import omni.ui as ui
from omni.ui import color as cl, constant as fl
from omni.kit.widget.spinner import FloatSpinner
SPINNER_STYLE = {
"Spinner.Field": {"background_color": 0, "color": cl.viewport_menubar_light},
"Spinner.Field:disabled": {"color": cl.viewport_menubar_medium},
"Spinner.Arrow": {"background_color": cl.viewport_menubar_light},
"Spinner.Arrow:disabled": {"background_color": cl.viewport_menubar_medium},
}
class SpinnerMenuDelegate(ui.MenuDelegate):
"""Example of menu item with the spinner"""
def __init__(
self,
model=None,
tooltip=None,
width=ui.Fraction(1),
height=0,
min: Union[float, int, None] = None,
max: Union[float, int, None] = None,
step: Union[float, int] = 1,
enabled: bool = True,
text: bool = True,
icon_name: Optional[str] = None,
icon_width: ui.Length = 30,
icon_height: ui.Length = 30,
use_in_menubar: bool = False,
):
super().__init__()
self.__width = width
self.__height = height
self.__spinner_width = 60
self.__model = model
self.__tooltip = tooltip or ""
self._min = min
self._max = max
self._step = step
self.__enabled = enabled
self.__frame: Optional[ui.Widget] = None
self.__text = text
self.__icon_name = icon_name
self.__icon_width = icon_width
self.__icon_height = icon_height
self.__use_in_menubar = use_in_menubar
def __del__(self):
self.destroy()
def destroy(self):
self.__model = None
@property
def enabled(self) -> bool:
return self.__enabled
@enabled.setter
def enabled(self, value) -> None:
self.__enabled = value
if self.__frame:
self.__frame.enabled = value
self.__frame.enabled = value
def build_item(self, item):
extra_kwargs = {"style_type_name_override": "Menu.Item"} if not self.__use_in_menubar else {}
self.__frame = ui.Frame(width=self.__width, enabled=self.__enabled, **extra_kwargs)
with self.__frame:
with ui.HStack(height=self.__height):
if self.__icon_name:
ui.ImageWithProvider(style_type_name_override="Menu.Item.Icon", tooltip=self.__tooltip, name=self.__icon_name, width=self.__icon_width, height=self.__icon_height)
if self.__text:
ui.Label(item.text, tooltip=self.__tooltip, style_type_name_override="Menu.Item.Label")
with ui.VStack(width=self.__spinner_width):
ui.Spacer()
self.__spinner = FloatSpinner(
self.__model, min=self._min, max=self._max, step=self._step, style=SPINNER_STYLE
)
ui.Spacer()
ui.Spacer(width=5)
self.__spinner.enabled = self.__enabled
| 3,463 | Python | 34.71134 | 182 | 0.595437 |
omniverse-code/kit/exts/omni.kit.viewport.menubar.core/omni/kit/viewport/menubar/core/delegate/slider_menu_delegate.py | # Copyright (c) 2021-2022, NVIDIA CORPORATION. All rights reserved.
#
# NVIDIA CORPORATION and its licensors retain all intellectual property
# and proprietary rights in and to this software, related documentation
# and any modifications thereto. Any use, reproduction, disclosure or
# distribution of this software and related documentation without an express
# license agreement from NVIDIA CORPORATION is strictly prohibited.
#
__all__ = ["SliderMenuDelegate"]
from typing import Optional, Union
import omni.ui as ui
from .abstract_widget_menu_delegate import AbstractWidgetMenuDelegate
class SliderMenuDelegate(AbstractWidgetMenuDelegate):
"""
Example of menu item with the slider
kwargs:
model (Optional[ui.AbstractValueModel]): Slider data model, default None
min (Union[float, int, None]): Min value of slider, default None
max (Union[float, int, None]): Max value of slider, default None
tooltip (Optional[str]): Tooltip of slider, default None
width (int): Width of slider, in pixles, default 270
slider_class (Union[ui.FloatSlider, ui.IntSlider]): Slider class, default ui.FloatSlider
show_checkbox_if_min (bool): Show checkbox instead of slider if value == min.
default_value_on (Union[float, int, None]): When checkbox is ON, value to display in slider. Default None
"""
def __init__(
self,
model: Optional[ui.AbstractValueModel] = None,
min: Union[float, int, None] = None,
max: Union[float, int, None] = None,
tooltip: Optional[str] = None,
width: int = 300,
slider_class: Union[ui.FloatSlider, ui.IntSlider] = ui.FloatSlider,
show_checkbox_if_min: bool = False,
default_value_on: Union[float, int, None] = None,
enabled: bool = True,
reserve_status: bool = False,
has_reset: bool = False,
step: Union[float, int, None] = None,
):
super().__init__(model=model, enabled=enabled, reserve_status=reserve_status, has_reset=has_reset)
self.__width = width
self.__space = 5
self.__slider_width = 90
self.__min = min
self.__max = max
self.__tooltip = tooltip or ""
self.__slider_class = slider_class
self.__show_checkbox_if_min = show_checkbox_if_min
self.__default_value_on = default_value_on
self.__slider = None
self.__step = step
def __del__(self):
self.destroy()
def destroy(self):
self._model = None
def build_widget(self, item: ui.MenuHelper):
ui.Label(item.text, tooltip=self.__tooltip, style_type_name_override="Menu.Item.Label")
ui.Spacer(width=self.__space)
with ui.ZStack(content_clipping=True, width=0):
if self.__show_checkbox_if_min and self.__min is not None:
self.__checkbox = ui.CheckBox(width=self.__slider_width, visible=False)
self.__checkbox.model.add_value_changed_fn(self.__on_checkbox_changed)
self.__slider_container = ui.VStack(width=self.__slider_width)
with self.__slider_container:
ui.Spacer()
kwargs = {"height": 0}
use_drag = False
min_value, max_value = self.__min, self.__max
# If only one of min/max ws provided, warn as the slider might be odd
if (min_value is None) != (max_value is None):
import carb
carb.log_warn("SliderMenuDelegate with only one of min/max provided")
if min_value is not None and self.__max is not None:
kwargs["min"] = min_value
kwargs["max"] = max_value
if max_value - min_value > 100:
use_drag = True
else:
use_drag = True
if min_value is not None:
kwargs["min"] = min_value
if max_value is not None:
kwargs["max"] = max_value
if self.__step is not None:
kwargs["step"] = self.__step
elif (self.__slider_class == ui.FloatSlider) and (min_value is not None) and (max_value is not None):
kwargs["step"] = self.calculate_step(min_value, max_value, None)
kwargs["precision"] = 3
if use_drag:
if self.__slider_class == ui.FloatSlider:
slider_class = ui.FloatDrag
if self.__slider_class == ui.IntSlider:
slider_class = ui.IntDrag
else:
slider_class = self.__slider_class
self.__slider = slider_class(self._model, **kwargs)
if self.__show_checkbox_if_min and self.__min is not None:
self.__slider.model.add_value_changed_fn(self.__on_slider_changed)
value = self.__slider.model.as_float
if value == self.__min:
self.__checkbox.visible = True
self.__slider.visible = False
ui.Spacer()
@property
def min(self) -> Union[float, int]:
return self.__min
@min.setter
def min(self, value: Union[float, int]) -> None:
self.__min = value
if self.__slider:
self.__slider.min = value
@property
def max(self) -> Union[float, int]:
return self.__max
@max.setter
def max(self, value: Union[float, int]) -> None:
self.__max = value
if self.__slider:
self.__slider.max = value
def calculate_step(self, min: float, max: float, slider: ui.Widget):
# TODO: Flag to normalize against slider.computed_width
import math
exponent = math.floor(math.log10(abs(max - min)))
return (10 ** exponent) / 100
def set_range(self, min: float, max: float):
self.__min, self.__max = min, max
slider = self.__slider
if slider:
slider.min = self.__min
slider.max = self.__max
# Auto compute step based on range and width
if self.__step is None:
slider.step = self.calculate_step(min, max, slider)
def __on_checkbox_changed(self, model: ui.AbstractValueModel) -> None:
if model.as_bool:
self.__checkbox.visible = False
self.__slider.visible = True
if self.__default_value_on is not None:
self.__slider.model.set_value(self.__default_value_on)
def __on_slider_changed(self, model: ui.AbstractValueModel) -> None:
if self.__min is not None:
if model.as_float == self.__min:
self.__checkbox.visible = True
self.__checkbox.model.set_value(False)
self.__slider.visible = False
| 6,945 | Python | 38.465909 | 117 | 0.565731 |
omniverse-code/kit/exts/omni.kit.viewport.menubar.core/omni/kit/viewport/menubar/core/delegate/icon_menu_delegate.py | # Copyright (c) 2021-2022, NVIDIA CORPORATION. All rights reserved.
#
# NVIDIA CORPORATION and its licensors retain all intellectual property
# and proprietary rights in and to this software, related documentation
# and any modifications thereto. Any use, reproduction, disclosure or
# distribution of this software and related documentation without an express
# license agreement from NVIDIA CORPORATION is strictly prohibited.
#
__all__ = ["IconMenuDelegate"]
from typing import Optional, Callable
import omni.ui as ui
class IconMenuDelegate(ui.MenuDelegate):
"""
The menu delegate that draws in the menu bar the given icon and
optionally the text.
"""
def __init__(
self,
name: str,
text: bool = False,
width: ui.Length = 30,
height: ui.Length = 30,
has_triangle: bool = True,
triangle_size: float = 6,
checked: bool = False,
enabled: bool = True,
triggered_fn: Callable[[None], None] = None,
right_clicked_fn: Callable[[None], None] = None,
tooltip: Optional[str] = None,
build_custom_widgets: Callable[[ui.MenuItem], None] = None
):
super().__init__(propagate=False)
self._name = name
self._text = text
self._width = width
self._icon_width = width
self._height = height
self._has_triangle = has_triangle
self._triangle_size = triangle_size
self._checked = checked
self._enabled = enabled
self.__label = None
self.__tooltip = tooltip or ""
self._triggered_fn = triggered_fn
self._right_clicked_fn = right_clicked_fn
self._container: Optional[ui.Widget] = None
self.__label_size = 0
self.__build_custom_widgets = build_custom_widgets
def build_item(self, item: ui.MenuItem):
icon_type = "Menu.Item.Icon"
self._container = ui.ZStack(checked=self._checked, height=self._height)
with self._container:
if self._has_triangle:
with ui.VStack():
with ui.HStack():
ui.Spacer()
with ui.VStack(width=self._triangle_size):
ui.Spacer()
ui.Triangle(
width=self._triangle_size,
height=self._triangle_size,
alignment=ui.Alignment.RIGHT_TOP,
style_type_name_override="MenuBar.Item.Triangle",
)
ui.Spacer(width=2)
ui.Spacer(height=2)
ui.Rectangle(style_type_name_override="MenuBar.Item.Background")
spacer_width = 4
with ui.HStack(height=self._height, spacing=spacer_width):
self.icon = self._build_icon()
if self._text:
self.__label_container = ui.HStack(spacing=4)
with self.__label_container:
self.__label = ui.Label(item.text, height=self._height)
if self.__build_custom_widgets:
self.__build_custom_widgets(item)
ui.Spacer(width=4)
def __label_size_changed(menu_item):
if self.__label_container.computed_width + spacer_width > self.__label_size:
self.__label_size = self.__label_container.computed_width + spacer_width
self.__label_container.set_computed_content_size_changed_fn(lambda m=item: __label_size_changed(m))
ui.Rectangle(style_type_name_override="Menubar.Hover")
if self._triggered_fn or self._right_clicked_fn:
self._container.set_mouse_released_fn(lambda x, y, b, a: self._on_mouse_released(b))
@property
def text_size(self) -> float:
"""
Size of text displayed.
"""
return self.__label_size
@property
def text_visible(self) -> bool:
return self._text
@text_visible.setter
def text_visible(self, value: bool) -> None:
# Here only set status but need menu invilidate outside to refresh
self._text = value
@property
def checked(self) -> bool:
return self._container.checked if self._container else self._checked
@checked.setter
def checked(self, value) -> None:
self._checked = value
if self._container:
self._container.checked = value
@property
def enabled(self) -> bool:
return self._enabled
@enabled.setter
def enabled(self, value) -> None:
self._enabled = value
if self._container:
self._container.enabled = value
@property
def text(self):
return self.__label.text if self.__label else ''
@text.setter
def text(self, txt: str):
if self.__label:
self.__label.text = str(txt)
def destroy(self):
self.__build_custom_widgets = None
def _on_mouse_released(self, button: int) -> None:
if button == 0:
if self._triggered_fn:
self._triggered_fn()
elif button == 1:
if self._right_clicked_fn:
self._right_clicked_fn()
def _build_icon(self):
return ui.ImageWithProvider(
style_type_name_override="Menu.Item.Icon",
name=self._name,
width=self._icon_width,
height=self._height,
tooltip=self.__tooltip,
)
| 5,594 | Python | 33.96875 | 119 | 0.556489 |
omniverse-code/kit/exts/omni.kit.viewport.menubar.core/omni/kit/viewport/menubar/core/delegate/viewport_menu_delegate.py | from typing import Union, Optional, Callable, List
import omni.ui as ui
STATUS_ICON_WIDTH = 20
MENU_ARROW_SIZE = 8
__all__ = ["OptionBoxStyle", "ViewportMenuDelegate"]
class ViewportMenuDelegate(ui.MenuDelegate):
"""The menu delegate that draws in the menu or menuitem the given status.
kwargs:
icon_name (str): Show icon after menu text. Default "" to do not show.
icon_width (int): Menu icon width. Defautl 16
reserve_status (bool): Reserve space for status icon. Default True.
force_checked (bool): Force to show checked status. It is strange that when a menu is checked, sub menu items
checked flag will be cleared. Use this flag to show correct sub menu item status.
"""
def __init__(
self,
icon_name: str = "",
icon_width: int = 16,
reserve_status: bool = True,
force_checked: bool = False,
icon_clicked_fn: Callable[[None], None] = None,
build_custom_widgets: Callable[[ui.MenuDelegate, Union[ui.MenuItem, ui.Menu]], None] = None
):
self._icon_name = icon_name
self._icon_width = icon_width
self._reserve_status = reserve_status
self._force_checked = force_checked
self._icon_clicked_fn = icon_clicked_fn
self.icon: Optional[ui.Widget] = None
self._container: Optional[ui.Widget] = None
self._build_custom_widgets = build_custom_widgets
super().__init__(propagate=False)
def __icon_clicked(self, x, y, *arg, **kwargs):
if self._icon_clicked_fn is None or self.icon is None:
return
left = self.icon.screen_position_x
top = self.icon.screen_position_y
if (x < left) or (y < top):
return
right = left + self.icon.computed_width
bottom = top + self.icon.computed_height
if (x > right) or (y > bottom):
return
self._icon_clicked_fn(x, y, *arg, **kwargs)
def build_item(self, item: Union[ui.MenuItem, ui.Menu]):
icon_type = "Menu.Item.Status"
if self._force_checked:
item.checked = self._force_checked
self._container = ui.HStack(
style_type_name_override="MenuBar.Item", selected=item.selected, checked=(item.checkable and item.checked)
)
with self._container:
selected = item.selected or (item.checkable and item.checked)
# Status icon before menu text
if selected or self._reserve_status:
self.icon = ui.ImageWithProvider(style_type_name_override=icon_type, width=STATUS_ICON_WIDTH, mouse_released_fn=self.__icon_clicked)
# Text
ui.Label(item.text, style_type_name_override="Menu.Item.Text")
if self._icon_name or self._build_custom_widgets or isinstance(item, ui.Menu):
ui.Spacer()
# Icon after menu text
if self._icon_name:
ui.Spacer(width=10)
ui.ImageWithProvider(
style_type_name_override="Menu.Item.Icon", name=self._icon_name, width=self._icon_width
)
if self._build_custom_widgets:
self._build_custom_widgets(self, item)
if isinstance(item, ui.Menu):
# For menu, show arrow for children
ui.Spacer(width=10)
with ui.VStack(width=MENU_ARROW_SIZE / 2):
ui.Spacer()
ui.Triangle(
height=MENU_ARROW_SIZE,
alignment=ui.Alignment.RIGHT_CENTER,
style_type_name_override="MenuBar.Item.Triangle",
)
ui.Spacer()
ui.Spacer(width=3)
def get_selected(self) -> bool:
return self._container.selected if self._container else False
def set_selected(self, value: bool) -> bool:
'''Set the 'selected' state and return whether it changed or not.'''
value = bool(value)
if self._container and (self.get_selected() != value):
self._container.selected = value
return True
return False
def get_checked(self) -> bool:
return self._container.checked if self._container else False
def set_checked(self, value: bool) -> bool:
'''Set the 'checked' state and return whether it changed or not.'''
value = bool(value)
if self._container and (self.get_checked() != value):
self._container.checked = value
return True
return False
def __on_additional_btn_clicked(self, button: ui.Button) -> None:
if self._on_additional_btn_clicked_fn:
self._on_additional_btn_clicked_fn(button)
@property
def selected(self) -> bool:
return self.get_selected()
@selected.setter
def selected(self, value: bool) -> None:
self.set_selected(value)
@property
def checked(self) -> bool:
return self.get_checked()
@checked.setter
def checked(self, value: bool) -> None:
self.set_checked(value)
| 5,113 | Python | 36.057971 | 148 | 0.587326 |
omniverse-code/kit/exts/omni.kit.viewport.menubar.core/omni/kit/viewport/menubar/core/delegate/separator_menu_delegate.py | import omni.ui as ui
class SeparatorDelegate(ui.MenuDelegate):
"""Generic menu delegate with separator between menu items"""
def __init__(self):
super().__init__()
def __del__(self):
self.destroy()
def destroy(self):
pass
def build_item(self, item):
self.__frame = ui.Frame(style_type_name_override="Menu.Item")
with self.__frame:
ui.Line(width=2, alignment=ui.Alignment.V_CENTER, style_type_name_override="Menu.Item.Separator")
| 507 | Python | 24.399999 | 109 | 0.619329 |
omniverse-code/kit/exts/omni.kit.viewport.menubar.core/omni/kit/viewport/menubar/core/delegate/category_menu_delegate.py | from typing import Callable
from .viewport_menu_delegate import ViewportMenuDelegate
from ..model.category_model import CategoryStatus
import omni.ui as ui
import carb.windowing
__all__ = ["CategoryMenuDelegate"]
class CategoryMenuDelegate(ViewportMenuDelegate):
def __init__(self, status: CategoryStatus, icon_clicked_fn: Callable[[None], None]=None):
self._status = status
super().__init__(icon_clicked_fn=icon_clicked_fn)
def build_item(self, item: ui.MenuItem):
# icons required
super().build_item(item)
if self.icon:
self.icon.name = self._status
self.icon.set_mouse_hovered_fn(self._on_icon_hovered)
@property
def status(self) -> CategoryStatus:
return self._status
@status.setter
def status(self, value: CategoryStatus) -> None:
self._status = value
if self.icon:
self.icon.name = self._status
def _on_icon_hovered(self, hovered):
try:
import omni.kit.window.cursor
main_curosr = omni.kit.window.cursor.get_main_window_cursor()
if main_curosr:
if hovered:
main_curosr.override_cursor_shape(carb.windowing.CursorStandardShape.HAND)
else:
main_curosr.clear_overridden_cursor_shape()
except ImportError:
carb.log_info("omni.kit.window.cursor not available, omni.kit.viewport.menubar cursor won't be changed")
pass
| 1,500 | Python | 33.906976 | 116 | 0.632 |
omniverse-code/kit/exts/omni.kit.viewport.menubar.core/omni/kit/viewport/menubar/core/delegate/color_menu_delegate.py | # Copyright (c) 2021-2022, NVIDIA CORPORATION. All rights reserved.
#
# NVIDIA CORPORATION and its licensors retain all intellectual property
# and proprietary rights in and to this software, related documentation
# and any modifications thereto. Any use, reproduction, disclosure or
# distribution of this software and related documentation without an express
# license agreement from NVIDIA CORPORATION is strictly prohibited.
#
__all__ = ["ColorMenuDelegate"]
import omni.ui as ui
from .abstract_widget_menu_delegate import AbstractWidgetMenuDelegate
class ColorMenuDelegate(AbstractWidgetMenuDelegate):
"""Example of menu item with color widget"""
def __init__(self, model=None, tooltip=None, has_reset: bool = False):
super().__init__(model=model, width=210 + 90, has_reset=has_reset)
self.__color_widget_width = 20
self.__model = model
self.__tooltip = tooltip or ""
def __del__(self):
self.destroy()
def destroy(self):
self.__model = None
def build_widget(self, item: ui.MenuHelper):
ui.Label(item.text, tooltip=self.__tooltip, style_type_name_override="Menu.Item.Label")
ui.ColorWidget(self.__model, width=self.__color_widget_width, height=0)
ui.Spacer(width=70)
| 1,271 | Python | 37.545453 | 95 | 0.70417 |
omniverse-code/kit/exts/omni.kit.viewport.menubar.core/omni/kit/viewport/menubar/core/delegate/checkbox_menu_delegate.py | # Copyright (c) 2021-2022, NVIDIA CORPORATION. All rights reserved.
#
# NVIDIA CORPORATION and its licensors retain all intellectual property
# and proprietary rights in and to this software, related documentation
# and any modifications thereto. Any use, reproduction, disclosure or
# distribution of this software and related documentation without an express
# license agreement from NVIDIA CORPORATION is strictly prohibited.
#
__all__ = ["CheckboxMenuDelegate"]
from typing import Optional
import omni.ui as ui
from .abstract_widget_menu_delegate import AbstractWidgetMenuDelegate
class CheckboxMenuDelegate(AbstractWidgetMenuDelegate):
"""Example of menu item with the slider"""
def __init__(
self,
model=None,
tooltip=None,
width: int = 300,
height=0,
enabled: bool = True,
use_in_menubar: bool = False,
has_reset: bool = False,
):
super().__init__(model, width=width, height=height, enabled=enabled, has_reset=has_reset, use_in_menubar=use_in_menubar)
self.__checkbox_width = 90 if width > 90 else 0
self.__model = model
self.__tooltip = tooltip or ""
def __del__(self):
self.destroy()
def destroy(self):
self.__model = None
def build_widget(self, item: ui.MenuHelper):
ui.Label(item.text, tooltip=self.__tooltip, style_type_name_override="Menu.Item.Label")
with ui.VStack(width=self.__checkbox_width):
ui.Spacer()
ui.CheckBox(self.__model, height=0)
ui.Spacer()
| 1,568 | Python | 32.382978 | 128 | 0.663265 |
omniverse-code/kit/exts/omni.kit.viewport.menubar.core/omni/kit/viewport/menubar/core/delegate/abstract_widget_menu_delegate.py | import abc
import omni.ui as ui
from typing import Optional
from ..model.reset_button import ResetButton
MENU_ARROW_SIZE = 8
class AbstractWidgetMenuDelegate(ui.MenuDelegate):
def __init__(
self,
model = None,
width: ui.Length = ui.Fraction(1),
height: ui.Length = ui.Fraction(1),
enabled: bool = True,
has_reset: bool = False,
reserve_status: bool = False,
use_in_menubar: bool = False,
content_clipping: bool = True,
visible: bool = True,
):
super().__init__()
self._model = model
self.__width = width
self.__height = height
self.__enabled = enabled
self.__has_reset = has_reset
self.__reserve_status = reserve_status
self.__use_in_menubar = use_in_menubar
self.__content_clipping = content_clipping
self.__visible = visible
self.__frame: Optional[ui.Widget] = None
def destroy(self):
pass
def build_item(self, item):
extra_kwargs = {"style_type_name_override": "Menu.Item"} if not self.__use_in_menubar else {}
self.__frame = ui.Frame(width=self.__width, enabled=self.__enabled, visible=self.__visible, **extra_kwargs)
with self.__frame:
with ui.HStack(height=self.__height, content_clipping=self.__content_clipping):
if self.__reserve_status:
ui.Spacer(width=16)
self.build_widget(item)
if isinstance(item, ui.Menu):
# For menu, show arrow for children
ui.Spacer(width=10)
with ui.VStack(width=MENU_ARROW_SIZE / 2):
ui.Spacer()
ui.Triangle(
height=MENU_ARROW_SIZE,
alignment=ui.Alignment.RIGHT_CENTER,
style_type_name_override="MenuBar.Item.Triangle",
)
ui.Spacer()
ui.Spacer(width=3)
if self.__has_reset:
ui.Spacer(width=4)
with ui.VStack(width=0):
ui.Spacer(height=2)
self._reset_button = ResetButton([self._model])
self._model.set_reset_button(self._reset_button)
ui.Spacer()
@abc.abstractmethod
def build_widget(self, item: ui.MenuHelper):
pass
@property
def visible(self) -> bool:
return self.__frame.visible if self.__frame else self.__visible
@visible.setter
def visible(self, value: bool) -> None:
self.__visible = value
if self.__frame:
self.__frame.visible = value
@property
def enabled(self) -> bool:
return self.__enabled
@enabled.setter
def enabled(self, value) -> None:
self.__enabled = value
if self.__frame:
self.__frame.enabled = value
| 3,006 | Python | 32.043956 | 115 | 0.524285 |
omniverse-code/kit/exts/omni.kit.viewport.menubar.core/omni/kit/viewport/menubar/core/delegate/label_menu_delegate.py | import omni.ui as ui
class LabelMenuDelegate(ui.MenuDelegate):
"""
The menu delegate that show menu item text as a label.
kwargs:
enable (bool): Label enabled or not. Default True.
width (ui.Length): Label width. Default ui.Fraction(1).
height (ui.Length): Label height. Default 26 pixels.
alignment (ui.Alignment): Label alignment. Default ui.Alignment.CENTER.
"""
def __init__(
self,
enabled: bool = True,
width: ui.Length = ui.Fraction(1),
height: ui.Length = 26,
alignment: ui.Alignment = ui.Alignment.LEFT
):
super().__init__(propagate=False)
self.__enabled = enabled
self.__height = height
self.__width = width
self.__alignment = alignment
def build_item(self, item: ui.MenuItem):
self.__frame = ui.Frame(width=self.__width, height=self.__height, style_type_name_override="Menu.Item", enabled=self.__enabled)
with self.__frame:
ui.Label(item.text, style_type_name_override="Menu.Item.Label", alignment=self.__alignment) | 1,105 | Python | 35.866665 | 135 | 0.61448 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.