file_path
stringlengths 22
162
| content
stringlengths 19
501k
| size
int64 19
501k
| lang
stringclasses 1
value | avg_line_length
float64 6.33
100
| max_line_length
int64 18
935
| alphanum_fraction
float64 0.34
0.93
|
|---|---|---|---|---|---|---|
omniverse-code/kit/exts/omni.kit.welcome.extensions/omni/kit/welcome/extensions/tests/__init__.py | from .test_page import * | 24 | Python | 23.999976 | 24 | 0.75 |
omniverse-code/kit/exts/omni.kit.manipulator.prim2.core/omni/kit/manipulator/prim2/core/tools.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.
#
from pathlib import Path
from typing import List
import traceback
import carb
import carb.dictionary
import carb.events
import carb.settings
import omni.kit.app
import omni.kit.context_menu
import omni.usd
from omni.kit.manipulator.tool.snap import SnapToolButton
from omni.kit.manipulator.transform.manipulator import TransformManipulator
from omni.kit.manipulator.transform.toolbar_tool import SimpleToolButton
from omni.kit.manipulator.transform.types import Operation
from .settings_constants import Constants as prim_c
from .tool_models import LocalGlobalModeModel
from .toolbar_registry import get_toolbar_registry
ICON_FOLDER_PATH = Path(
f"{omni.kit.app.get_app().get_extension_manager().get_extension_path_by_module(__name__)}/data/icons"
)
TOOLS_ENABLED_SETTING_PATH = "/exts/omni.kit.manipulator.prim2.core/tools/enabled"
class SelectionPivotTool(SimpleToolButton):
# menu entry only needs to register once
__menu_entries = []
@classmethod
def register_menu(cls):
def build_placement_setting_entry(setting: str):
menu = {
"name": setting,
"checked_fn": lambda _: carb.settings.get_settings().get(prim_c.MANIPULATOR_PLACEMENT_SETTING)
== setting,
"onclick_fn": lambda _: carb.settings.get_settings().set(prim_c.MANIPULATOR_PLACEMENT_SETTING, setting),
}
return menu
menu = [
build_placement_setting_entry(s)
for s in [
prim_c.MANIPULATOR_PLACEMENT_LAST_PRIM_PIVOT,
prim_c.MANIPULATOR_PLACEMENT_BBOX_BASE,
prim_c.MANIPULATOR_PLACEMENT_BBOX_CENTER,
prim_c.MANIPULATOR_PLACEMENT_SELECTION_CENTER,
prim_c.MANIPULATOR_PLACEMENT_PICK_REF_PRIM,
]
]
for item in menu:
cls.__menu_entries.append(omni.kit.context_menu.add_menu(item, "sel_pivot", "omni.kit.manipulator.prim"))
@classmethod
def unregister_menu(cls):
for sub in cls.__menu_entries:
sub.release()
cls.__menu_entries.clear()
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
# TODO assume the context is "" for VP1
self._usd_context = omni.usd.get_context(self._toolbar_payload.get("usd_context_name", ""))
self._selection = self._usd_context.get_selection()
enabled_img_url = f"{ICON_FOLDER_PATH}/pivot_location.svg"
self._build_widget(
button_name="sel_pivot",
enabled_img_url=enabled_img_url,
model=None,
menu_index="sel_pivot",
menu_extension_id="omni.kit.manipulator.prim",
no_toggle=True,
menu_on_left_click=True,
tooltip="Selection Pivot Placement",
)
# order=1 to register after prim manipulator so _on_selection_changed gets updated len of xformable_prim_paths
self._stage_event_sub = self._usd_context.get_stage_event_stream().create_subscription_to_pop_by_type(
int(omni.usd.StageEventType.SELECTION_CHANGED),
self._on_stage_selection_event,
name="SelectionPivotTool stage event",
order=1,
)
if self._usd_context.get_stage_state() == omni.usd.StageState.OPENED:
self._on_selection_changed()
def destroy(self):
super().destroy()
self._stage_event_sub = None
if self._model:
self._model.destroy()
self._model = None
@classmethod
def can_build(cls, manipulator: TransformManipulator, operation: Operation) -> bool:
return operation == Operation.TRANSLATE or operation == Operation.ROTATE or operation == Operation.SCALE
def _on_stage_selection_event(self, event: carb.events.IEvent):
self._on_selection_changed()
def _on_selection_changed(self):
selected_xformable_paths_count = (
len(self._manipulator.model.xformable_prim_paths) if self._manipulator.model else 0
)
if self._stack:
visible = selected_xformable_paths_count > 0
if self._stack.visible != visible:
self._stack.visible = visible
self._manipulator.refresh_toolbar()
class LocalGlobalTool(SimpleToolButton):
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
if self._operation == Operation.TRANSLATE:
setting_path = "/app/transform/moveMode"
elif self._operation == Operation.ROTATE:
setting_path = "/app/transform/rotateMode"
else:
raise RuntimeError("Invalid operation")
self._model = LocalGlobalModeModel(setting_path)
enabled_img_url = f"{ICON_FOLDER_PATH}/transformspace_global_dark.svg"
disabled_img_url = f"{ICON_FOLDER_PATH}/transformspace_local_dark.svg"
self._build_widget(
button_name="local_global",
enabled_img_url=enabled_img_url,
disabled_img_url=disabled_img_url,
model=self._model,
tooltip="Current Transform Space: World",
disabled_tooltip="Current Transform Space: Local"
)
def destroy(self):
super().destroy()
if self._model:
self._model.destroy()
self._model = None
@classmethod
def can_build(cls, manipulator: TransformManipulator, operation: Operation) -> bool:
return operation == Operation.TRANSLATE or operation == Operation.ROTATE
class PrimManipTools:
def __init__(self):
self._settings = carb.settings.get_settings()
self._dict = carb.dictionary.get_dictionary()
self._toolbar_reg = get_toolbar_registry()
SelectionPivotTool.register_menu() # one time startup
self._builtin_tool_classes = {
"prim:1space": LocalGlobalTool,
"prim:2snap": SnapToolButton,
"prim:3sel_pivot": SelectionPivotTool,
}
self._registered_tool_ids: List[str] = []
self._sub = self._settings.subscribe_to_node_change_events(TOOLS_ENABLED_SETTING_PATH, self._on_setting_changed)
if self._settings.get(TOOLS_ENABLED_SETTING_PATH) is True:
self._register_tools()
self._pivot_button_group = None
# register pivot placement to "factory explorer" toolbar
app_name = omni.kit.app.get_app().get_app_filename()
if "omni.factory_explorer" in app_name:
# add manu entry to factory explorer toolbar
manager = omni.kit.app.get_app().get_extension_manager()
self._hooks = manager.subscribe_to_extension_enable(
lambda _: self._register_main_toolbar_button(),
lambda _: self._unregister_main_toolbar_button(),
ext_name="omni.explore.toolbar",
hook_name="omni.kit.manipulator.prim.pivot_placement listener",
)
def __del__(self):
self.destroy()
def destroy(self):
self._hooks = None
if self._pivot_button_group is not None:
self._unregister_main_toolbar_button()
self._unregister_tools()
if self._sub is not None:
self._settings.unsubscribe_to_change_events(self._sub)
self._sub = None
SelectionPivotTool.unregister_menu() # one time shutdown
def _register_tools(self):
for id, tool_class in self._builtin_tool_classes.items():
self._toolbar_reg.register_tool(tool_class, id)
self._registered_tool_ids.append(id)
def _unregister_tools(self):
for id in self._registered_tool_ids:
self._toolbar_reg.unregister_tool(id)
self._registered_tool_ids.clear()
def _on_setting_changed(self, item, event_type):
enabled = self._dict.get(item)
if enabled and not self._registered_tool_ids:
self._register_tools()
elif not enabled:
self._unregister_tools()
def _register_main_toolbar_button(self):
try:
if not self._pivot_button_group:
import omni.explore.toolbar
from .pivot_button_group import PivotButtonGroup
self._pivot_button_group = PivotButtonGroup()
explorer_toolbar_ext = omni.explore.toolbar.get_toolbar_instance()
explorer_toolbar_ext.toolbar.add_widget_group(self._pivot_button_group, 1)
# also add to MODIFY_TOOLS list, when menu Modify is selected
# all items in toolbar will be cleared and re-added from MODIFY_TOOLS list
explorer_tools = omni.explore.toolbar.groups.MODIFY_TOOLS
explorer_tools.append(self._pivot_button_group)
except Exception:
carb.log_warn(traceback.format_exc())
def _unregister_main_toolbar_button(self):
try:
if self._pivot_button_group:
import omni.explore.toolbar
explorer_toolbar_ext = omni.explore.toolbar.get_toolbar_instance()
explorer_toolbar_ext.toolbar.remove_widget_group(self._pivot_button_group)
# remove from MODIFY_TOOLS list as well
explorer_tools = omni.explore.toolbar.groups.MODIFY_TOOLS
if self._pivot_button_group in explorer_tools:
explorer_tools.remove(self._pivot_button_group)
self._pivot_button_group.clean()
self._pivot_button_group = None
except Exception:
carb.log_warn(traceback.format_exc())
| 10,032 | Python | 36.576779 | 120 | 0.627691 |
omniverse-code/kit/exts/omni.kit.manipulator.prim2.core/omni/kit/manipulator/prim2/core/extension.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.
#
import omni.ext
from omni.kit.manipulator.viewport import ManipulatorFactory
from .prim_transform_manipulator import PrimTransformManipulator
from .prim_transform_manipulator_registry import TransformManipulatorRegistry
from .reference_prim_marker import ReferencePrimMarker
from .tools import PrimManipTools
class ManipulatorPrim(omni.ext.IExt):
def on_startup(self, ext_id):
self._tools = PrimManipTools()
# For VP1
self._legacy_manipulator = PrimTransformManipulator()
self._legacy_marker = ManipulatorFactory.create_manipulator(
ReferencePrimMarker, usd_context_name="", manipulator_model=self._legacy_manipulator.model, legacy=True
)
# For VP2
self._manipulator_registry = TransformManipulatorRegistry()
def on_shutdown(self):
if self._legacy_manipulator is not None:
self._legacy_manipulator.destroy()
self._legacy_manipulator = None
if self._legacy_marker is not None:
ManipulatorFactory.destroy_manipulator(self._legacy_marker)
self._legacy_marker = None
if self._manipulator_registry is not None:
self._manipulator_registry.destroy()
self._manipulator_registry = None
if self._tools is not None:
self._tools.destroy()
self._tools = None
| 1,788 | Python | 36.270833 | 115 | 0.714765 |
omniverse-code/kit/exts/omni.kit.manipulator.prim2.core/omni/kit/manipulator/prim2/core/__init__.py | from .extension import *
from .model import *
from .toolbar_registry import *
| 78 | Python | 18.749995 | 31 | 0.75641 |
omniverse-code/kit/exts/omni.kit.manipulator.prim2.core/omni/kit/manipulator/prim2/core/prim_transform_manipulator.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 copy
from typing import List, Union
import carb.dictionary
import carb.events
import carb.settings
import omni.ext
import omni.usd
from omni.kit.manipulator.selector import ManipulatorBase
from omni.kit.manipulator.tool.snap import SnapProviderManager
from omni.kit.manipulator.tool.snap import settings_constants as snap_c
from omni.kit.manipulator.transform import get_default_style
from omni.kit.manipulator.transform.manipulator import TransformManipulator
from omni.kit.manipulator.transform.settings_constants import c
from omni.kit.manipulator.transform.settings_listener import OpSettingsListener, SnapSettingsListener
from omni.kit.manipulator.viewport import ManipulatorFactory
from pxr import Sdf, Usd, UsdGeom
from .model import PrimRotateChangedGesture, PrimScaleChangedGesture, PrimTransformModel, PrimTranslateChangedGesture
from .toolbar_registry import get_toolbar_registry
TRANSFORM_GIZMO_HIDDEN_OVERRIDE = "/app/transform/gizmoHiddenOverride"
class PrimTransformManipulator(ManipulatorBase):
def __init__(
self,
usd_context_name: str = "",
viewport_api=None,
name="omni.kit.manipulator.prim2.core",
model: PrimTransformModel = None,
size: float = 1.0,
):
super().__init__(name=name, usd_context_name=usd_context_name)
self._dict = carb.dictionary.get_dictionary()
self._settings = carb.settings.get_settings()
self._usd_context = omni.usd.get_context(usd_context_name)
self._selection = self._usd_context.get_selection()
self._model_is_external = model is not None
self._model = model if self._model_is_external else PrimTransformModel(usd_context_name, viewport_api)
self._legacy_mode = viewport_api is None # if no viewport_api is supplied, it is from VP1
self._snap_manager = SnapProviderManager(viewport_api=viewport_api)
if self._legacy_mode:
self._manipulator = ManipulatorFactory.create_manipulator(
TransformManipulator,
size=size,
model=self._model,
enabled=False,
gestures=[
PrimTranslateChangedGesture(
self._snap_manager, usd_context_name=usd_context_name, viewport_api=viewport_api
),
PrimRotateChangedGesture(usd_context_name=usd_context_name, viewport_api=viewport_api),
PrimScaleChangedGesture(usd_context_name=usd_context_name, viewport_api=viewport_api),
],
tool_registry=get_toolbar_registry(),
)
else:
self._manipulator = TransformManipulator(
size=size,
model=self._model,
enabled=False,
gestures=[
PrimTranslateChangedGesture(
self._snap_manager, usd_context_name=usd_context_name, viewport_api=viewport_api
),
PrimRotateChangedGesture(usd_context_name=usd_context_name, viewport_api=viewport_api),
PrimScaleChangedGesture(usd_context_name=usd_context_name, viewport_api=viewport_api),
],
tool_registry=get_toolbar_registry(),
tool_button_additional_payload={"viewport_api": viewport_api, "usd_context_name": usd_context_name},
)
# Hide the old C++ imguizmo when omni.ui.scene manipulator is enabled
self._prev_transform_hidden_override = self._settings.get(TRANSFORM_GIZMO_HIDDEN_OVERRIDE)
self._settings.set(TRANSFORM_GIZMO_HIDDEN_OVERRIDE, True)
self._set_default_settings()
self._create_local_global_styles()
self._op_settings_listener = OpSettingsListener()
self._op_settings_listener_sub = self._op_settings_listener.subscribe_listener(self._on_op_listener_changed)
self._snap_settings_listener = SnapSettingsListener(
enabled_setting_path=None,
move_x_setting_path=snap_c.SNAP_TRANSLATE_SETTING_PATH,
move_y_setting_path=snap_c.SNAP_TRANSLATE_SETTING_PATH,
move_z_setting_path=snap_c.SNAP_TRANSLATE_SETTING_PATH,
rotate_setting_path=snap_c.SNAP_ROTATE_SETTING_PATH,
scale_setting_path=snap_c.SNAP_SCALE_SETTING_PATH,
provider_setting_path=snap_c.SNAP_PROVIDER_NAME_SETTING_PATH,
)
self._snap_settings_listener_sub = self._snap_settings_listener.subscribe_listener(
self._on_snap_listener_changed
)
self._enabled: bool = self._manipulator.enabled
self._prim_style_applied: bool = False
self._set_style()
def __del__(self):
self.destroy()
def destroy(self):
super().destroy()
self._op_settings_listener_sub = None
self._snap_settings_listener_sub = None
if self._op_settings_listener:
self._op_settings_listener.destroy()
self._op_settings_listener = None
if self._manipulator:
if self._legacy_mode:
ManipulatorFactory.destroy_manipulator(self._manipulator)
else:
self._manipulator.destroy()
self._manipulator = None
if self._model and not self._model_is_external:
self._model.destroy()
self._model = None
if self._snap_manager:
self._snap_manager.destroy()
self._snap_manager = None
# restore imguizmo visibility
self._settings.set(TRANSFORM_GIZMO_HIDDEN_OVERRIDE, self._prev_transform_hidden_override)
@property
def model(self) -> PrimTransformModel:
return self._model
@property
def snap_manager(self) -> SnapProviderManager:
return self._snap_manager
@property
def enabled(self):
return self._manipulator.enabled
@enabled.setter
def enabled(self, value: bool):
if value != self._enabled:
self._enabled = value
self._update_manipulator_enable()
def _set_default_settings(self):
self._settings.set_default_string(c.TRANSFORM_OP_SETTING, c.TRANSFORM_OP_MOVE)
self._settings.set_default_string(c.TRANSFORM_MOVE_MODE_SETTING, c.TRANSFORM_MODE_GLOBAL)
self._settings.set_default_string(c.TRANSFORM_ROTATE_MODE_SETTING, c.TRANSFORM_MODE_GLOBAL)
def _create_local_global_styles(self):
COLOR_LOCAL = 0x8A248AE3
local_style = get_default_style()
local_style["Translate.Point"]["color"] = COLOR_LOCAL
local_style["Rotate.Arc::screen"]["color"] = COLOR_LOCAL
local_style["Scale.Point"]["color"] = COLOR_LOCAL
self._styles = {c.TRANSFORM_MODE_GLOBAL: get_default_style(), c.TRANSFORM_MODE_LOCAL: local_style}
self._snap_styles = copy.deepcopy(self._styles)
self._snap_styles[c.TRANSFORM_MODE_GLOBAL]["Translate.Focal"]["visible"] = True
self._snap_styles[c.TRANSFORM_MODE_LOCAL]["Translate.Focal"]["visible"] = True
def on_selection_changed(self, stage: Usd.Stage, selection: Union[List[Sdf.Path], None], *args, **kwargs) -> bool:
if selection is None:
if self.model:
self.model.on_selection_changed([])
return False
if self.model:
self.model.on_selection_changed(selection)
for path in selection:
prim = stage.GetPrimAtPath(path)
if prim.IsA(UsdGeom.Xformable):
return True
return False
def _update_manipulator_enable(self) -> None:
if not self._manipulator:
return
is_enabled: bool = self._prim_style_applied and self._enabled
if not self._manipulator.enabled and is_enabled:
self._manipulator.enabled = True
elif self._manipulator.enabled and not is_enabled:
self._manipulator.enabled = False
def _set_style(self) -> None:
def set_manipulator_style(styles, mode: str):
# An unknown style will return false here.
if mode in styles:
self._manipulator.style = styles[mode]
return True
else:
return False
if self._op_settings_listener.selected_op == c.TRANSFORM_OP_MOVE:
styles = (
self._snap_styles
if self._snap_settings_listener.snap_enabled and self._snap_settings_listener.snap_to_surface
else self._styles
)
self._prim_style_applied = set_manipulator_style(styles, self._op_settings_listener.translation_mode)
elif self._op_settings_listener.selected_op == c.TRANSFORM_OP_ROTATE:
self._prim_style_applied = set_manipulator_style(self._styles, self._op_settings_listener.rotation_mode)
elif self._op_settings_listener.selected_op == c.TRANSFORM_OP_SCALE:
self._prim_style_applied = set_manipulator_style(self._styles, c.TRANSFORM_MODE_LOCAL)
else:
# unknown op disables.
self._prim_style_applied = False
self._update_manipulator_enable()
def _on_op_listener_changed(self, type: OpSettingsListener.CallbackType, value: str):
if (
type == OpSettingsListener.CallbackType.OP_CHANGED
or type == OpSettingsListener.CallbackType.TRANSLATION_MODE_CHANGED
or type == OpSettingsListener.CallbackType.ROTATION_MODE_CHANGED
):
self._set_style()
def _on_snap_listener_changed(self, setting_val_name: str, value: str):
if setting_val_name == "snap_enabled" or setting_val_name == "snap_to_surface":
self._set_style()
| 10,126 | Python | 41.372385 | 118 | 0.644381 |
omniverse-code/kit/exts/omni.kit.manipulator.prim2.core/omni/kit/manipulator/prim2/core/tool_models.py | # Copyright (c) 2020, 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 carb
import carb.dictionary
import carb.settings
import omni.ui as ui
class LocalGlobalModeModel(ui.AbstractValueModel):
TRANSFORM_MODE_GLOBAL = "global"
TRANSFORM_MODE_LOCAL = "local"
def __init__(self, op_space_setting_path):
super().__init__()
self._settings = carb.settings.get_settings()
self._dict = carb.dictionary.get_dictionary()
self._setting_path = op_space_setting_path
self._op_space_sub = self._settings.subscribe_to_node_change_events(
self._setting_path, self._on_op_space_changed
)
self._op_space = self._settings.get(self._setting_path)
def __del__(self):
self.destroy()
def destroy(self):
if self._op_space_sub is not None:
self._settings.unsubscribe_to_change_events(self._op_space_sub)
self._op_space_sub = None
def _on_op_space_changed(self, item, event_type):
self._op_space = self._dict.get(item)
self._value_changed()
def get_value_as_bool(self):
return self._op_space != self.TRANSFORM_MODE_LOCAL
def set_value(self, value):
self._settings.set(
self._setting_path,
self.TRANSFORM_MODE_LOCAL if value == False else self.TRANSFORM_MODE_GLOBAL,
)
| 1,719 | Python | 32.72549 | 88 | 0.669575 |
omniverse-code/kit/exts/omni.kit.manipulator.prim2.core/omni/kit/manipulator/prim2/core/settings_constants.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.
#
class Constants:
MANIPULATOR_PLACEMENT_SETTING = "/persistent/exts/omni.kit.manipulator.prim2.core/manipulator/placement"
MANIPULATOR_PLACEMENT_LAST_PRIM_PIVOT = "Authored Pivot"
MANIPULATOR_PLACEMENT_SELECTION_CENTER = "Selection Center"
MANIPULATOR_PLACEMENT_BBOX_BASE = "Bounding Box Base"
MANIPULATOR_PLACEMENT_BBOX_CENTER = "Bounding Box Center"
MANIPULATOR_PLACEMENT_PICK_REF_PRIM = "Pick Reference Prim"
| 865 | Python | 47.111108 | 108 | 0.788439 |
omniverse-code/kit/exts/omni.kit.manipulator.prim2.core/omni/kit/manipulator/prim2/core/utils.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 math
from typing import List
import carb
import carb.profiler
import carb.settings
from pxr import Gf, Usd, UsdGeom
@carb.profiler.profile
def flatten(transform):
"""Convert array[4][4] to array[16]"""
# flatten the matrix by hand
# USING LIST COMPREHENSION IS VERY SLOW (e.g. return [item for sublist in transform for item in sublist]), which takes around 10ms.
m0, m1, m2, m3 = transform[0], transform[1], transform[2], transform[3]
return [
m0[0],
m0[1],
m0[2],
m0[3],
m1[0],
m1[1],
m1[2],
m1[3],
m2[0],
m2[1],
m2[2],
m2[3],
m3[0],
m3[1],
m3[2],
m3[3],
]
@carb.profiler.profile
def get_local_transform_pivot_inv(prim: Usd.Prim, time: Usd.TimeCode = Usd.TimeCode):
xform = UsdGeom.Xformable(prim)
xform_ops = xform.GetOrderedXformOps()
if len(xform_ops):
pivot_op_inv = xform_ops[-1]
if (
pivot_op_inv.GetOpType() == UsdGeom.XformOp.TypeTranslate
and pivot_op_inv.IsInverseOp()
and pivot_op_inv.GetName().endswith("pivot")
):
return pivot_op_inv.GetOpTransform(time)
return Gf.Matrix4d(1.0)
def compose_transform_ops_to_matrix(
translation: Gf.Vec3d, rotation: Gf.Vec3d, rotation_order: Gf.Vec3i, scale: Gf.Vec3d
):
axes = [Gf.Vec3d.XAxis(), Gf.Vec3d.YAxis(), Gf.Vec3d.ZAxis()]
rot = []
for i in range(3):
axis_idx = rotation_order[i]
rot.append(Gf.Rotation(axes[axis_idx], rotation[axis_idx]))
rotation_mtx = Gf.Matrix4d(1.0)
rotation_mtx.SetRotate(rot[0] * rot[1] * rot[2])
valid_scale = Gf.Vec3d(0.0)
for i in range(3):
if abs(scale[i]) == 0:
valid_scale[i] = 0.001
else:
valid_scale[i] = scale[i]
scale_mtx = Gf.Matrix4d(1.0)
scale_mtx.SetScale(valid_scale)
translate_mtx = Gf.Matrix4d(1.0)
translate_mtx.SetTranslate(translation)
return scale_mtx * rotation_mtx * translate_mtx
def repeat(t: float, length: float) -> float:
return t - (math.floor(t / length) * length)
def generate_compatible_euler_angles(euler: Gf.Vec3d, rotation_order: Gf.Vec3i) -> List[Gf.Vec3d]:
equal_eulers = [euler]
mid_order = rotation_order[1]
equal = Gf.Vec3d()
for i in range(3):
if i == mid_order:
equal[i] = 180 - euler[i]
else:
equal[i] = euler[i] + 180
equal_eulers.append(equal)
for i in range(3):
equal[i] -= 360
equal_eulers.append(equal)
return equal_eulers
def find_best_euler_angles(old_rot_vec: Gf.Vec3d, new_rot_vec: Gf.Vec3d, rotation_order: Gf.Vec3i) -> Gf.Vec3d:
equal_eulers = generate_compatible_euler_angles(new_rot_vec, rotation_order)
nearest_euler = None
for euler in equal_eulers:
for i in range(3):
euler[i] = repeat(euler[i] - old_rot_vec[i] + 180.0, 360.0) + old_rot_vec[i] - 180.0
if nearest_euler is None:
nearest_euler = euler
else:
distance_1 = (nearest_euler - old_rot_vec).GetLength()
distance_2 = (euler - old_rot_vec).GetLength()
if distance_2 < distance_1:
nearest_euler = euler
return nearest_euler
| 3,734 | Python | 26.873134 | 135 | 0.61248 |
omniverse-code/kit/exts/omni.kit.manipulator.prim2.core/omni/kit/manipulator/prim2/core/reference_prim_marker.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.
#
from __future__ import annotations
import asyncio
import colorsys
import weakref
from collections import defaultdict
from typing import DefaultDict, Dict, Set, Union
from weakref import ProxyType
import concurrent.futures
import carb
import carb.dictionary
import carb.events
import carb.profiler
import carb.settings
import omni.timeline
import omni.usd
from omni.kit.async_engine import run_coroutine
from omni.kit.manipulator.transform.style import COLOR_X, COLOR_Y, COLOR_Z, abgr_to_color
from omni.kit.manipulator.transform.settings_constants import Constants as TrCon
from omni.ui import color as cl
from omni.ui import scene as sc
from pxr import Sdf, Tf, Usd, UsdGeom
from .model import PrimTransformModel
from omni.kit.viewport.manipulator.transform import Viewport1WindowState
from .settings_constants import Constants
from .utils import flatten, get_local_transform_pivot_inv
LARGE_SELECTION_CAP = 20
class PreventViewportOthers(sc.GestureManager):
def can_be_prevented(self, gesture):
return True
def should_prevent(self, gesture, preventer):
if preventer.state == sc.GestureState.BEGAN or preventer.state == sc.GestureState.CHANGED:
if issubclass(type(preventer), ClickMarkerGesture):
if issubclass(type(gesture), ClickMarkerGesture):
return gesture.gesture_payload.ray_distance > preventer.gesture_payload.ray_distance
elif isinstance(gesture, ClickMarkerGesture):
return False
else:
return True
else:
return True
return super().should_prevent(gesture, preventer)
class ClickMarkerGesture(sc.DragGesture):
def __init__(
self,
prim_path: Sdf.Path,
marker: ProxyType[ReferencePrimMarker],
):
super().__init__(manager=PreventViewportOthers())
self._prim_path = prim_path
self._marker = marker
self._vp1_window_state = None
def on_began(self):
self._viewport_on_began()
def on_canceled(self):
self._viewport_on_ended()
def on_ended(self):
self._viewport_on_ended()
self._marker.on_pivot_marker_picked(self._prim_path)
def _viewport_on_began(self):
self._viewport_on_ended()
if self._marker.legacy:
self._vp1_window_state = Viewport1WindowState()
def _viewport_on_ended(self):
if self._vp1_window_state:
self._vp1_window_state.destroy()
self._vp1_window_state = None
class MarkerHoverGesture(sc.HoverGesture):
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self.items = []
self._began_count = 0
self._original_colors = []
self._original_ends = []
def on_began(self):
self._began_count += 1
if self._began_count == 1:
self._original_colors = [None] * len(self.items)
self._original_ends = [None] * len(self.items)
for i, item in enumerate(self.items):
self._original_colors[i] = item.color
item.color = self._make_brighter(item.color)
if isinstance(item, sc.Line):
self._original_ends[i] = item.end
end = [dim * 1.2 for dim in item.end]
item.end = end
if isinstance(item, sc.Arc):
... # TODO change color to white, blocked by OM-56044
def on_ended(self):
self._began_count -= 1
if self._began_count <= 0:
self._began_count = 0
for i, item in enumerate(self.items):
item.color = self._original_colors[i]
if isinstance(item, sc.Line):
item.end = self._original_ends[i]
if isinstance(item, sc.Arc):
... # TODO change color back, blocked by OM-56044
def _make_brighter(self, color):
hsv = colorsys.rgb_to_hsv(color[0], color[1], color[2])
rgb = colorsys.hsv_to_rgb(hsv[0], hsv[1], hsv[2] * 1.2)
return cl(rgb[0], rgb[1], rgb[2], color[3])
class ReferencePrimMarker(sc.Manipulator):
def __init__(
self, usd_context_name: str = "", manipulator_model: ProxyType[PrimTransformModel] = None, legacy: bool = False
):
super().__init__()
self._settings = carb.settings.get_settings()
self._dict = carb.dictionary.get_dictionary()
self._usd_context_name = usd_context_name
self._usd_context = omni.usd.get_context(self._usd_context_name)
self._manipulator_model = manipulator_model
self._legacy = legacy
self._selection = self._usd_context.get_selection()
self._timeline = omni.timeline.get_timeline_interface()
self._current_time = self._timeline.get_current_time()
# dict from prefixes -> dict of affected markers.
self._markers: DefaultDict[Dict] = defaultdict(dict)
self._stage_listener = None
self._pending_changed_paths: Set[Sdf.Path] = set()
self._process_pending_change_task_or_future: Union[asyncio.Task, concurrent.futures.Future, None] = None
# order=1 to ensure the event handler is called after prim manipulator
self._stage_event_sub = self._usd_context.get_stage_event_stream().create_subscription_to_pop(
self._on_stage_event, name="ReferencePrimMarker stage event", order=1
)
self._placement_sub = self._settings.subscribe_to_node_change_events(
Constants.MANIPULATOR_PLACEMENT_SETTING, self._on_placement_changed
)
self._placement = self._settings.get(Constants.MANIPULATOR_PLACEMENT_SETTING)
self._op_sub = self._settings.subscribe_to_node_change_events(TrCon.TRANSFORM_OP_SETTING, self._on_op_changed)
self._selected_op = self._settings.get(TrCon.TRANSFORM_OP_SETTING)
def destroy(self):
self._stage_event_sub = None
if self._placement_sub:
self._settings.unsubscribe_to_change_events(self._placement_sub)
self._placement_sub = None
if self._op_sub:
self._settings.unsubscribe_to_change_events(self._op_sub)
self._op_sub = None
if self._stage_listener:
self._stage_listener.Revoke()
self._stage_listener = None
if self._process_pending_change_task_or_future and not self._process_pending_change_task_or_future.done():
self._process_pending_change_task_or_future.cancel()
self._process_pending_change_task_or_future = None
self._timeline_sub = None
@property
def usd_context_name(self) -> str:
return self._usd_context_name
@usd_context_name.setter
def usd_context_name(self, value: str):
if value != self._usd_context_name:
new_usd_context = omni.usd.get_context(value)
if not new_usd_context:
carb.log_error(f"Invalid usd context name {value}")
return
if self._stage_listener:
self._stage_listener.Revoke()
self._stage_listener = None
self._usd_context_name = value
self._usd_context = new_usd_context
# order=1 to ensure the event handler is called after prim manipulator
self._stage_event_sub = self._usd_context.get_stage_event_stream().create_subscription_to_pop(
self._on_stage_event, name="ReferencePrimMarker stage event", order=1
)
self.invalidate()
@property
def manipulator_model(self) -> ProxyType[PrimTransformModel]:
return self._manipulator_model
@manipulator_model.setter
def manipulator_model(self, value):
if value != self._manipulator_model:
self._manipulator_model = value
self.invalidate()
@property
def legacy(self) -> bool:
return self._legacy
@legacy.setter
def legacy(self, value):
self._legacy = value
def on_pivot_marker_picked(self, path: Sdf.Path):
if self._manipulator_model.set_pivot_prim_path(path):
# Hide marker on the new pivot prim and show marker on old pivot prim
old_pivot_marker = self._markers.get(self._pivot_prim_path, {}).get(self._pivot_prim_path, None)
if old_pivot_marker:
old_pivot_marker.visible = True
self._pivot_prim_path = self._manipulator_model.get_pivot_prim_path()
new_pivot_marker = self._markers.get(self._pivot_prim_path, {}).get(self._pivot_prim_path, None)
if new_pivot_marker:
new_pivot_marker.visible = False
def on_build(self):
if self._stage_listener:
self._stage_listener.Revoke()
self._stage_listener = None
self._timeline_sub = None
self._markers.clear()
if self._placement != Constants.MANIPULATOR_PLACEMENT_PICK_REF_PRIM:
return
# don't build marker on "select" mode
if self._selected_op == TrCon.TRANSFORM_OP_SELECT:
return
selected_xformable_paths = self._manipulator_model.xformable_prim_paths
stage = self._usd_context.get_stage()
self._current_time = self._timeline.get_current_time()
selection_count = len(selected_xformable_paths)
# skip if there's only one xformable
if selection_count <= 1:
return
if selection_count > LARGE_SELECTION_CAP:
carb.log_warn(
f"{selection_count} is greater than the maximum selection cap {LARGE_SELECTION_CAP}, "
f"{Constants.MANIPULATOR_PLACEMENT_PICK_REF_PRIM} mode will be disabled and fallback to "
f"{Constants.MANIPULATOR_PLACEMENT_LAST_PRIM_PIVOT} due to performance concern."
)
return
timecode = self._get_current_time_code()
self._pivot_prim_path = self._manipulator_model.get_pivot_prim_path()
xform_cache = UsdGeom.XformCache(timecode)
for path in selected_xformable_paths:
prim = stage.GetPrimAtPath(path)
pivot_inv = get_local_transform_pivot_inv(prim, timecode)
transform = pivot_inv.GetInverse() * xform_cache.GetLocalToWorldTransform(prim)
transform.Orthonormalize() # in case of a none uniform scale
marker_transform = sc.Transform(transform=flatten(transform), visible=self._pivot_prim_path != path)
with marker_transform:
with sc.Transform(scale_to=sc.Space.SCREEN):
gesture = ClickMarkerGesture(path, marker=weakref.proxy(self))
hover_gesture = MarkerHoverGesture()
x_line = sc.Line(
(0, 0, 0),
(50, 0, 0),
color=abgr_to_color(COLOR_X),
thickness=2,
intersection_thickness=8,
gestures=[gesture, hover_gesture],
)
y_line = sc.Line(
(0, 0, 0),
(0, 50, 0),
color=abgr_to_color(COLOR_Y),
thickness=2,
intersection_thickness=8,
gestures=[gesture, hover_gesture],
)
z_line = sc.Line(
(0, 0, 0),
(0, 0, 50),
color=abgr_to_color(COLOR_Z),
thickness=2,
intersection_thickness=8,
gestures=[gesture, hover_gesture],
)
with sc.Transform(look_at=sc.Transform.LookAt.CAMERA):
point = sc.Arc(
radius=6,
wireframe=False,
tesselation=8,
color=cl.white, # TODO default color grey, blocked by OM-56044
)
hover_gesture.items = [x_line, y_line, z_line, point]
prefixes = path.GetPrefixes()
for prefix in prefixes:
self._markers[prefix][path] = marker_transform
if self._markers:
self._stage_listener = Tf.Notice.Register(Usd.Notice.ObjectsChanged, self._on_objects_changed, stage)
self._timeline_sub = self._timeline.get_timeline_event_stream().create_subscription_to_pop(
self._on_timeline_event
)
def _on_stage_event(self, event: carb.events.IEvent):
if event.type == int(omni.usd.StageEventType.SELECTION_CHANGED):
self._on_selection_changed()
def _on_selection_changed(self):
if self._placement == Constants.MANIPULATOR_PLACEMENT_PICK_REF_PRIM:
self.invalidate()
def _on_placement_changed(self, item, event_type):
placement = self._dict.get(item)
if placement != self._placement:
self._placement = placement
self.invalidate()
def _on_op_changed(self, item, event_type):
selected_op = self._dict.get(item)
if selected_op != self._selected_op:
if selected_op == TrCon.TRANSFORM_OP_SELECT or self._selected_op == TrCon.TRANSFORM_OP_SELECT:
self.invalidate()
self._selected_op = selected_op
def _on_timeline_event(self, e: carb.events.IEvent):
if e.type == int(omni.timeline.TimelineEventType.CURRENT_TIME_TICKED):
current_time = e.payload["currentTime"]
if current_time != self._current_time:
self._current_time = current_time
if self._placement != Constants.MANIPULATOR_PLACEMENT_PICK_REF_PRIM:
# TODO only invalidate transform if this prim or ancestors transforms are time varying?
self.invalidate()
@carb.profiler.profile
async def _process_pending_change(self):
processed_transforms = set()
timecode = self._get_current_time_code()
xform_cache = UsdGeom.XformCache(timecode)
stage = self._usd_context.get_stage()
for path in self._pending_changed_paths:
prim_path = path.GetPrimPath()
affected_transforms = self._markers.get(prim_path, {})
if affected_transforms:
if not UsdGeom.Xformable.IsTransformationAffectedByAttrNamed(path.name):
continue
for path, transform in affected_transforms.items():
if transform in processed_transforms:
continue
prim = stage.GetPrimAtPath(path)
if not prim:
continue
pivot_inv = get_local_transform_pivot_inv(prim, timecode)
xform = pivot_inv.GetInverse() * xform_cache.GetLocalToWorldTransform(prim)
xform.Orthonormalize() # in case of a none uniform scale
transform_value = flatten(xform)
transform.transform = transform_value
processed_transforms.add(transform)
self._pending_changed_paths.clear()
@carb.profiler.profile
def _on_objects_changed(self, notice, sender):
self._pending_changed_paths.update(notice.GetChangedInfoOnlyPaths())
if self._process_pending_change_task_or_future is None or self._process_pending_change_task_or_future.done():
self._process_pending_change_task_or_future = run_coroutine(self._process_pending_change())
def _get_current_time_code(self):
return Usd.TimeCode(
omni.usd.get_frame_time_code(self._current_time, self._usd_context.get_stage().GetTimeCodesPerSecond())
)
| 16,316 | Python | 38.70073 | 119 | 0.59647 |
omniverse-code/kit/exts/omni.kit.manipulator.prim2.core/omni/kit/manipulator/prim2/core/model.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.
#
from __future__ import annotations
import asyncio
import math
import traceback
from enum import Enum, Flag, IntEnum, auto
from typing import Dict, List, Sequence, Set, Tuple, Union
import concurrent.futures
import carb
import carb.dictionary
import carb.events
import carb.profiler
import carb.settings
import omni.kit.app
from omni.kit.async_engine import run_coroutine
import omni.kit.commands
import omni.kit.undo
import omni.timeline
from omni.kit.manipulator.tool.snap import SnapProviderManager
from omni.kit.manipulator.tool.snap import settings_constants as snap_c
from omni.kit.manipulator.transform import AbstractTransformManipulatorModel, Operation
from omni.kit.viewport.manipulator.transform import (
ViewportTransformModel,
DataAccessor,
DataAccessorRegistry,
ManipulationMode,
)
from omni.kit.viewport.manipulator.transform.gestures import (
ViewportTranslateChangedGesture,
ViewportRotateChangedGesture,
ViewportScaleChangedGesture,
)
from omni.kit.manipulator.transform.settings_constants import c
from omni.kit.manipulator.transform.settings_listener import OpSettingsListener, SnapSettingsListener
from omni.ui import scene as sc
from pxr import Gf, Sdf, Tf, Usd, UsdGeom, UsdUtils
from .settings_constants import Constants as prim_c
from .utils import *
# Settings needed for zero-gravity
TRANSFORM_GIZMO_CUSTOM_MANIPULATOR_ENABLED = "/app/transform/gizmoCustomManipulatorEnabled"
TRANSFORM_GIZMO_CUSTOM_MANIPULATOR_PRIMS = "/app/transform/gizmoCustomManipulatorPrims"
TRANSFORM_GIZMO_IS_USING = "/app/transform/gizmoIsUsing"
TRANSFORM_GIZMO_TRANSLATE_DELTA_XYZ = "/app/transform/gizmoTranslateDeltaXYZ"
TRANSFORM_GIZMO_PIVOT_WORLD_POSITION = "/app/transform/tempPivotWorldPosition"
TRANSFORM_GIZMO_ROTATE_DELTA_XYZW = "/app/transform/gizmoRotateDeltaXYZW"
TRANSFORM_GIZMO_SCALE_DELTA_XYZ = "/app/transform/gizmoScaleDeltaXYZ"
TRANSLATE_DELAY_FRAME_SETTING = "/exts/omni.kit.manipulator.prim2.core/visual/delayFrame"
class OpFlag(Flag):
TRANSLATE = auto()
ROTATE = auto()
SCALE = auto()
class Placement(Enum):
LAST_PRIM_PIVOT = auto()
SELECTION_CENTER = auto()
BBOX_CENTER = auto()
REF_PRIM = auto()
BBOX_BASE = auto()
class PrimTranslateChangedGesture(ViewportTranslateChangedGesture):
def _get_model(self, payload_type) -> PrimTransformModel:
if not self.gesture_payload or not self.sender or not isinstance(self.gesture_payload, payload_type):
return None
return self.sender.model
class PrimRotateChangedGesture(ViewportRotateChangedGesture):
...
class PrimScaleChangedGesture(ViewportScaleChangedGesture):
...
class PrimTransformModel(ViewportTransformModel):
def __init__(self, usd_context_name: str = "", viewport_api=None):
ViewportTransformModel.__init__(self, usd_context_name=usd_context_name, viewport_api=viewport_api)
self._dataAccessor = None
self._transform = [1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1] # visual transform of manipulator
self._no_scale_transform_manipulator = Gf.Matrix4d(1.0) # transform of manipulator without scale
self._scale_manipulator = Gf.Vec3d(1.0) # scale of manipulator
self._settings = carb.settings.get_settings()
self._dict = carb.dictionary.get_dictionary()
self._timeline = omni.timeline.get_timeline_interface()
self._app = omni.kit.app.get_app()
self._usd_context_name = usd_context_name
self._usd_context = omni.usd.get_context(usd_context_name)
self.dataAccessorRegistry = PrimDataAccessorRegistry(dataType = "USD")
self._dataAccessor = self.dataAccessorRegistry.getDataAccessor(model = self)
self._enabled_hosting_widget_count: int = 0
self._stage_listener = None
self._xformable_prim_paths: List[Sdf.Path] = []
self._xformable_prim_paths_sorted: List[Sdf.Path] = []
self._xformable_prim_paths_set: Set[Sdf.Path] = set()
self._xformable_prim_paths_prefix_set: Set[Sdf.Path] = set()
self._consolidated_xformable_prim_paths: List[Sdf.Path] = []
self._pending_changed_paths_for_xform_data: Set[Sdf.Path] = set()
self._pivot_prim: Usd.Prim = None
self._update_prim_xform_from_prim_task_or_future: Union[asyncio.Task, concurrent.futures.Future, None] = None
self._current_editing_op: Operation = None
self._ignore_xform_data_change = False
self._timeline_sub = None
self._pending_changed_paths: Dict[Sdf.Path, bool] = {}
self._mode = ManipulationMode.PIVOT
self._viewport_fps: float = 0.0 # needed this as heuristic for delaying the visual update of manipulator to match rendering
self._viewport_api = viewport_api
self._delay_dirty_tasks_or_futures: Dict[int, Union[asyncio.Task, concurrent.futures.Future]] = {}
self._no_scale_transform_manipulator_item = sc.AbstractManipulatorItem()
self._items["no_scale_transform_manipulator"] = self._no_scale_transform_manipulator_item
self._scale_manipulator_item = sc.AbstractManipulatorItem()
self._items["scale_manipulator"] = self._scale_manipulator_item
self._transform_manipulator_item = sc.AbstractManipulatorItem()
self._items["transform_manipulator"] = self._transform_manipulator_item
self._manipulator_mode_item = sc.AbstractManipulatorItem()
self._items["manipulator_mode"] = self._manipulator_mode_item
self._viewport_fps_item = sc.AbstractManipulatorItem()
self._items["viewport_fps"] = self._viewport_fps_item
self._set_default_settings()
# subscribe to snap events
self._snap_settings_listener = SnapSettingsListener(
enabled_setting_path=None,
move_x_setting_path=snap_c.SNAP_TRANSLATE_SETTING_PATH,
move_y_setting_path=snap_c.SNAP_TRANSLATE_SETTING_PATH,
move_z_setting_path=snap_c.SNAP_TRANSLATE_SETTING_PATH,
rotate_setting_path=snap_c.SNAP_ROTATE_SETTING_PATH,
scale_setting_path=snap_c.SNAP_SCALE_SETTING_PATH,
provider_setting_path=snap_c.SNAP_PROVIDER_NAME_SETTING_PATH,
)
# subscribe to operation/mode events
self._op_settings_listener = OpSettingsListener()
self._op_settings_listener_sub = self._op_settings_listener.subscribe_listener(self._on_op_listener_changed)
self._placement_sub = self._settings.subscribe_to_node_change_events(
prim_c.MANIPULATOR_PLACEMENT_SETTING, self._on_placement_setting_changed
)
self._placement = Placement.LAST_PRIM_PIVOT
placement = self._settings.get(prim_c.MANIPULATOR_PLACEMENT_SETTING)
self._update_placement(placement)
# cache unique setting path for selection pivot position
# vp1 default
self._selection_pivot_position_path = TRANSFORM_GIZMO_PIVOT_WORLD_POSITION + "/Viewport"
# vp2
if self._viewport_api:
self._selection_pivot_position_path = (
TRANSFORM_GIZMO_PIVOT_WORLD_POSITION + "/" + self._viewport_api.id.split("/")[0]
)
# update setting with pivot placement position on init
self._update_temp_pivot_world_position()
def subscribe_to_value_and_get_current(setting_val_name: str, setting_path: str):
sub = self._settings.subscribe_to_node_change_events(
setting_path, lambda item, type: setattr(self, setting_val_name, self._dict.get(item))
)
setattr(self, setting_val_name, self._settings.get(setting_path))
return sub
# subscribe to zero-gravity settings
self._custom_manipulator_enabled_sub = subscribe_to_value_and_get_current(
"_custom_manipulator_enabled", TRANSFORM_GIZMO_CUSTOM_MANIPULATOR_ENABLED
)
self._warning_notification = None
self._selected_instance_proxy_paths = set()
# subscribe to USD related events
self._stage_event_sub = self._usd_context.get_stage_event_stream().create_subscription_to_pop(
self._on_stage_event, name="PrimTransformModel stage event"
)
if self._usd_context.get_stage_state() == omni.usd.StageState.OPENED:
self._on_stage_opened()
def _on_timeline_event(self, e: carb.events.IEvent):
if e.type == int(omni.timeline.TimelineEventType.CURRENT_TIME_TICKED):
current_time = e.payload["currentTime"]
if current_time != self._current_time:
self._current_time = current_time
self._dataAccessor.xform_set_time()
# TODO only update transform if this prim or ancestors transforms are time varying?
if self._update_transform_from_prims():
self._item_changed(self._transform_item)
def _on_stage_event(self, event: carb.events.IEvent):
if event.type == int(omni.usd.StageEventType.OPENED):
self._on_stage_opened()
elif event.type == int(omni.usd.StageEventType.CLOSING):
self._on_stage_closing()
def _on_stage_opened(self):
self._dataAccessor._stage = self._usd_context.get_stage()
self._timeline_sub = self._timeline.get_timeline_event_stream().create_subscription_to_pop(
self._on_timeline_event
)
self._current_time = self._timeline.get_current_time()
self._dataAccessor.update_xform_cache()
#commands
def _on_ended_transform(
self,
paths: List[str],
new_translations: List[float],
new_rotation_eulers: List[float],
new_rotation_orders: List[int],
new_scales: List[float],
old_translations: List[float],
old_rotation_eulers: List[float],
old_rotation_orders: List[int],
old_scales: List[float],
):
self._alert_if_selection_has_instance_proxies()
self._dataAccessor._on_ended_transform(
paths,
new_translations,
new_rotation_eulers,
new_rotation_orders,
new_scales,
old_translations,
old_rotation_eulers,
old_rotation_orders,
old_scales,
)
def _do_transform_selected_prims(
self,
paths: List[str],
new_translations: List[float],
new_rotation_eulers: List[float],
new_rotation_orders: List[int],
new_scales: List[float],
):
"""Function ran by _transform_selected_prims(). Can be overridden to change the behavior
Do not remove this function: can be used outside of this code"""
self._alert_if_selection_has_instance_proxies()
self._dataAccessor._do_transform_selected_prims(
paths,
new_translations,
new_rotation_eulers,
new_rotation_orders,
new_scales
)
def _do_transform_all_selected_prims_to_manipulator_pivot(
self,
paths: List[str],
new_translations: List[float],
new_rotation_eulers: List[float],
new_rotation_orders: List[int],
new_scales: List[float],
):
"""Function ran by _transform_all_selected_prims_to_manipulator_pivot().
Can be overridden to change the behavior. Do not remove this function: can be used outside of this code"""
self._alert_if_selection_has_instance_proxies()
self._dataAccessor._do_transform_all_selected_prims_to_manipulator_pivot(
paths,
new_translations,
new_rotation_eulers,
new_rotation_orders,
new_scales
)
def __del__(self):
self.destroy()
def destroy(self):
if self._warning_notification:
self._warning_notification.dismiss()
self._warning_notification= None
self._op_settings_listener_sub = None
if self._op_settings_listener:
self._op_settings_listener.destroy()
self._op_settings_listener = None
self._stage_event_sub = None
if self._stage_listener:
self._stage_listener = self._dataAccessor.remove_update_callback(self._stage_listener)
# if self._usd_context.get_stage_state() == omni.usd.StageState.OPENED:
self._on_stage_closing()
self._timeline_sub = None
if self._snap_settings_listener:
self._snap_settings_listener.destroy()
self._snap_settings_listener = None
if self._custom_manipulator_enabled_sub:
self._settings.unsubscribe_to_change_events(self._custom_manipulator_enabled_sub)
self._custom_manipulator_enabled_sub = None
if self._placement_sub:
self._settings.unsubscribe_to_change_events(self._placement_sub)
self._placement_sub = None
for task_or_future in self._delay_dirty_tasks_or_futures.values():
task_or_future.cancel()
self._delay_dirty_tasks_or_futures.clear()
def set_pivot_prim_path(self, path: Sdf.Path) -> bool:
if path not in self._xformable_prim_paths_set:
carb.log_warn(f"Cannot set pivot prim path to {path}")
return False
if not self._pivot_prim or self._pivot_prim.GetPath() != path:
self._pivot_prim = self._dataAccessor.get_prim_at_path(path)
else:
return False
if self._update_transform_from_prims():
self._item_changed(self._transform_item)
return True
def get_pivot_prim_path(self) -> Sdf.Path:
if self._pivot_prim:
return self._pivot_prim.GetPath()
return None
def _update_xform_data_from_dirty_paths(self):
for p in self._pending_changed_paths_for_xform_data:
prim_path = p.GetPrimPath()
if prim_path in self.all_xformable_prim_data_curr and self._path_may_affect_transform(p):
prim = self._dataAccessor.get_prim_at_path(prim_path)
xform_tuple = self._dataAccessor.get_local_transform_SRT(prim, self._dataAccessor.get_current_time_code(self._current_time))
pivot = get_local_transform_pivot_inv(prim, self._dataAccessor.get_current_time_code(self._current_time)).GetInverse()
self.all_xformable_prim_data_curr[prim_path] = xform_tuple + (pivot,)
if prim_path in self._consolidated_xformable_prim_paths:
self.consolidated_xformable_prim_data_curr[prim_path] = xform_tuple + (pivot,)
self._pending_changed_paths_for_xform_data.clear()
def on_began(self, payload):
item = payload.changing_item
self._current_editing_op = item.operation
# All selected xformable prims' transforms. Store this for when `Keep Spacing` option is off during snapping,
# because it can modify parent's and child're transform differently.
self._all_xformable_prim_data_prev: Dict[Sdf.Path, Tuple[Gf.Vec3d, Gf.Vec3d, Gf.Vec3i, Gf.Vec3d, Gf.Vec3d]] = {}
# consolidated xformable prims' transforms. If parent is in the dict, child will be excluded.
self._consolidated_xformable_prim_data_prev: Dict[Sdf.Path, Tuple[Gf.Vec3d, Gf.Vec3d, Gf.Vec3i, Gf.Vec3d]] = {}
for path in self._xformable_prim_paths:
prim = self._dataAccessor.get_prim_at_path(path)
xform_tuple = self._dataAccessor.get_local_transform_SRT(prim, self._dataAccessor.get_current_time_code(self._current_time))
pivot = get_local_transform_pivot_inv(prim, self._dataAccessor.get_current_time_code(self._current_time)).GetInverse()
self._all_xformable_prim_data_prev[path] = xform_tuple + (pivot,)
if path in self._consolidated_xformable_prim_paths:
self._consolidated_xformable_prim_data_prev[path] = xform_tuple + (pivot,)
self.all_xformable_prim_data_curr = self._all_xformable_prim_data_prev.copy()
self.consolidated_xformable_prim_data_curr = self._consolidated_xformable_prim_data_prev.copy()
self._pending_changed_paths_for_xform_data.clear()
if self.custom_manipulator_enabled:
self._settings.set(TRANSFORM_GIZMO_IS_USING, True)
def on_changed(self, payload):
# Always re-fetch the changed transform on_changed. Although it might not be manipulated by manipulator,
# prim's transform can be modified by other runtime (e.g. omnigraph), and we always want the latest.
self._update_xform_data_from_dirty_paths()
def on_ended(self, payload):
# Always re-fetch the changed transform on_changed. Although it might not be manipulated by manipulator,
# prim's transform can be modified by other runtime (e.g. omnigraph), and we always want the latest.
self._update_xform_data_from_dirty_paths()
carb.profiler.begin(1, "PrimTransformChangedGestureBase.TransformPrimSRT.all")
paths = []
new_translations = []
new_rotation_eulers = []
new_rotation_orders = []
new_scales = []
old_translations = []
old_rotation_eulers = []
old_rotation_orders = []
old_scales = []
for path, (s, r, ro, t, pivot) in self.all_xformable_prim_data_curr.items():
# Data didn't change
if self._all_xformable_prim_data_prev[path] == self.all_xformable_prim_data_curr[path]:
# carb.log_info(f"Skip {path}")
continue
(old_s, old_r, old_ro, old_t, old_pivot) = self._all_xformable_prim_data_prev[path]
paths.append(path.pathString)
new_translations += [t[0], t[1], t[2]]
new_rotation_eulers += [r[0], r[1], r[2]]
new_rotation_orders += [ro[0], ro[1], ro[2]]
new_scales += [s[0], s[1], s[2]]
old_translations += [old_t[0], old_t[1], old_t[2]]
old_rotation_eulers += [old_r[0], old_r[1], old_r[2]]
old_rotation_orders += [old_ro[0], old_ro[1], old_ro[2]]
old_scales += [old_s[0], old_s[1], old_s[2]]
self._ignore_xform_data_change = True
self._on_ended_transform(
paths,
new_translations,
new_rotation_eulers,
new_rotation_orders,
new_scales,
old_translations,
old_rotation_eulers,
old_rotation_orders,
old_scales,
)
self._ignore_xform_data_change = False
carb.profiler.end(1)
if self.custom_manipulator_enabled:
self._settings.set(TRANSFORM_GIZMO_IS_USING, False)
# if the manipulator was locked to orientation or translation,
# refresh it on_ended so the transform is up to date
mode = self._get_transform_mode_for_current_op()
if self._should_keep_manipulator_orientation_unchanged(
mode
) or self._should_keep_manipulator_translation_unchanged(mode):
# set editing op to None AFTER _should_keep_manipulator_*_unchanged but
# BEFORE self._update_transform_from_prims
self._current_editing_op = None
if self._update_transform_from_prims():
self._item_changed(self._transform_item)
self._current_editing_op = None
def on_canceled(self, payload):
if self.custom_manipulator_enabled:
self._settings.set(TRANSFORM_GIZMO_IS_USING, False)
self._current_editing_op = None
def widget_enabled(self):
self._enabled_hosting_widget_count += 1
# just changed from no active widget to 1 active widget
if self._enabled_hosting_widget_count == 1:
# listener only needs to be activated if manipulator is visible
if self._consolidated_xformable_prim_paths:
assert self._stage_listener is None
self._stage_listener = self._dataAccessor.setup_update_callback(self._on_objects_changed)
def _clear_temp_pivot_position_setting(self):
if self._settings.get(self._selection_pivot_position_path):
self._settings.destroy_item(self._selection_pivot_position_path)
def widget_disabled(self):
self._enabled_hosting_widget_count -= 1
self._clear_temp_pivot_position_setting()
assert self._enabled_hosting_widget_count >= 0
if self._enabled_hosting_widget_count < 0:
carb.log_error(f"manipulator enabled widget tracker out of sync: {self._enabled_hosting_widget_count}")
self._enabled_hosting_widget_count = 0
# If no hosting manipulator is active, revoke the listener since there's no need to sync Transform
if self._enabled_hosting_widget_count == 0:
if self._stage_listener:
self._stage_listener = self._dataAccessor.remove_update_callback(self._stage_listener)
for task_or_future in self._delay_dirty_tasks_or_futures.values():
task_or_future.cancel()
self._delay_dirty_tasks_or_futures.clear()
def set_floats(self, item: sc.AbstractManipulatorItem, value: Sequence[float]):
if item == self._viewport_fps_item:
self._viewport_fps = value[0]
return
flag = None
if issubclass(type(item), AbstractTransformManipulatorModel.OperationItem):
if (
item.operation == Operation.TRANSLATE_DELTA
or item.operation == Operation.ROTATE_DELTA
or item.operation == Operation.SCALE_DELTA
):
return
if item.operation == Operation.TRANSLATE:
flag = OpFlag.TRANSLATE
elif item.operation == Operation.ROTATE:
flag = OpFlag.ROTATE
elif item.operation == Operation.SCALE:
flag = OpFlag.SCALE
transform = Gf.Matrix4d(*value)
elif item == self._transform_manipulator_item:
flag = OpFlag.TRANSLATE | OpFlag.ROTATE | OpFlag.SCALE
transform = Gf.Matrix4d(*value)
elif item == self._no_scale_transform_manipulator_item:
flag = OpFlag.TRANSLATE | OpFlag.ROTATE
old_manipulator_scale_mtx = Gf.Matrix4d(1.0)
old_manipulator_scale_mtx.SetScale(self._scale_manipulator)
transform = old_manipulator_scale_mtx * Gf.Matrix4d(*value)
if flag is not None:
if self._mode == ManipulationMode.PIVOT:
self._transform_selected_prims(
transform, self._no_scale_transform_manipulator, self._scale_manipulator, flag
)
elif self._mode == ManipulationMode.UNIFORM:
self._transform_all_selected_prims_to_manipulator_pivot(transform, flag)
else:
carb.log_warn(f"Unsupported item {item}")
def set_ints(self, item: sc.AbstractManipulatorItem, value: Sequence[int]):
if item == self._manipulator_mode_item:
try:
self._mode = ManipulationMode(value[0])
except:
carb.log_error(traceback.format_exc())
else:
carb.log_warn(f"unsupported item {item}")
return None
def get_as_floats(self, item: sc.AbstractManipulatorItem):
if item == self._transform_item:
return self._transform
elif item == self._no_scale_transform_manipulator_item:
return flatten(self._no_scale_transform_manipulator)
elif item == self._scale_manipulator_item:
return [self._scale_manipulator[0], self._scale_manipulator[1], self._scale_manipulator[2]]
elif item == self._transform_manipulator_item:
scale_mtx = Gf.Matrix4d(1)
scale_mtx.SetScale(self._scale_manipulator)
return flatten(scale_mtx * self._no_scale_transform_manipulator)
else:
carb.log_warn(f"unsupported item {item}")
return None
def get_as_ints(self, item: sc.AbstractManipulatorItem):
if item == self._manipulator_mode_item:
return [int(self._mode)]
else:
carb.log_warn(f"unsupported item {item}")
return None
def get_operation(self) -> Operation:
if self._op_settings_listener.selected_op == c.TRANSFORM_OP_MOVE:
return Operation.TRANSLATE
elif self._op_settings_listener.selected_op == c.TRANSFORM_OP_ROTATE:
return Operation.ROTATE
elif self._op_settings_listener.selected_op == c.TRANSFORM_OP_SCALE:
return Operation.SCALE
return Operation.NONE
def get_snap(self, item: AbstractTransformManipulatorModel.OperationItem):
if not self._snap_settings_listener.snap_enabled:
return None
if item.operation == Operation.TRANSLATE:
if self._snap_settings_listener.snap_provider:
return None
return (
self._snap_settings_listener.snap_move_x,
self._snap_settings_listener.snap_move_y,
self._snap_settings_listener.snap_move_z,
)
elif item.operation == Operation.ROTATE:
return self._snap_settings_listener.snap_rotate
elif item.operation == Operation.SCALE:
return self._snap_settings_listener.snap_scale
return None
@carb.profiler.profile
def _transform_selected_prims(
self,
new_manipulator_transform: Gf.Matrix4d,
old_manipulator_transform_no_scale: Gf.Matrix4d,
old_manipulator_scale: Gf.Vec3d,
dirty_ops: OpFlag,
):
carb.profiler.begin(1, "omni.kit.manipulator.prim2.core.model._transform_selected_prims.prepare_data")
paths = []
new_translations = []
new_rotation_eulers = []
new_rotation_orders = []
new_scales = []
self._dataAccessor.clear_xform_cache()
# any op may trigger a translation change if multi-manipulating
should_update_translate = dirty_ops & OpFlag.TRANSLATE or len(self._xformable_prim_paths) > 1 or self._placement != Placement.LAST_PRIM_PIVOT
should_update_rotate = dirty_ops & OpFlag.ROTATE
should_update_scale = dirty_ops & OpFlag.SCALE
old_manipulator_scale_mtx = Gf.Matrix4d(1.0)
old_manipulator_scale_mtx.SetScale(old_manipulator_scale)
old_manipulator_transform_inv = (old_manipulator_scale_mtx * old_manipulator_transform_no_scale).GetInverse()
for path in self._consolidated_xformable_prim_paths:
if self._custom_manipulator_enabled and self._should_skip_custom_manipulator_path(path.pathString):
continue
selected_prim = self._dataAccessor.get_prim_at_path(path)
# We check whether path is in consolidated_xformable_prim_data_curr because it may have not made it the dictionary if an error occured
if not selected_prim or path not in self.consolidated_xformable_prim_data_curr:
continue
(s, r, ro, t, selected_pivot) = self.consolidated_xformable_prim_data_curr[path]
selected_pivot_inv = selected_pivot.GetInverse()
selected_local_to_world_mtx = self._dataAccessor.get_local_to_world_transform(selected_prim)
selected_parent_to_world_mtx = self._dataAccessor.get_parent_to_world_transform(selected_prim)
# Transform the prim from world space to pivot's space
# Then apply the new pivotPrim-to-world-space transform matrix
selected_local_to_world_pivot_mtx = (
selected_pivot * selected_local_to_world_mtx * old_manipulator_transform_inv * new_manipulator_transform
)
world_to_parent_mtx = selected_parent_to_world_mtx.GetInverse()
selected_local_mtx_new = selected_local_to_world_pivot_mtx * world_to_parent_mtx * selected_pivot_inv
if should_update_translate:
translation = selected_local_mtx_new.ExtractTranslation()
if should_update_rotate:
# Construct the new rotation from old scale and translation.
# Don't use Factor because it won't be able to tell if scale is positive or negative and can result in flipped rotation
old_s_mtx = Gf.Matrix4d(1.0)
old_s_mtx.SetScale(Gf.Vec3d(s))
old_t_mtx = Gf.Matrix4d(1.0)
old_t_mtx.SetTranslate(Gf.Vec3d(t))
rot_new = (old_s_mtx.GetInverse() * selected_local_mtx_new * old_t_mtx.GetInverse()).ExtractRotation()
axes = [Gf.Vec3d.XAxis(), Gf.Vec3d.YAxis(), Gf.Vec3d.ZAxis()]
decomp_rot = rot_new.Decompose(axes[ro[2]], axes[ro[1]], axes[ro[0]])
index_order = Gf.Vec3i()
for i in range(3):
index_order[ro[i]] = 2 - i
rotation = Gf.Vec3d(decomp_rot[index_order[0]], decomp_rot[index_order[1]], decomp_rot[index_order[2]])
rotation = find_best_euler_angles(Gf.Vec3d(r), rotation, ro)
if should_update_scale:
# Construct the new scale from old rotation and translation.
# Don't use Factor because it won't be able to tell if scale is positive or negative and can result in flipped rotation
old_rt_mtx = compose_transform_ops_to_matrix(t, r, ro, Gf.Vec3d(1))
new_s_mtx = selected_local_mtx_new * old_rt_mtx.GetInverse()
scale = Gf.Vec3d(new_s_mtx[0][0], new_s_mtx[1][1], new_s_mtx[2][2])
translation = translation if should_update_translate else t
rotation = rotation if should_update_rotate else r
scale = scale if should_update_scale else s
paths.append(path.pathString)
new_translations += [translation[0], translation[1], translation[2]]
new_rotation_eulers += [rotation[0], rotation[1], rotation[2]]
new_rotation_orders += [ro[0], ro[1], ro[2]]
new_scales += [scale[0], scale[1], scale[2]]
xform_tuple = (scale, rotation, ro, translation, selected_pivot)
self.consolidated_xformable_prim_data_curr[path] = xform_tuple
self.all_xformable_prim_data_curr[path] = xform_tuple
carb.profiler.end(1)
self._ignore_xform_data_change = True
self._do_transform_selected_prims(paths, new_translations, new_rotation_eulers, new_rotation_orders, new_scales)
self._ignore_xform_data_change = False
@carb.profiler.profile
def _transform_all_selected_prims_to_manipulator_pivot(
self,
new_manipulator_transform: Gf.Matrix4d,
dirty_ops: OpFlag,
):
paths = []
new_translations = []
new_rotation_eulers = []
new_rotation_orders = []
new_scales = []
old_translations = []
old_rotation_eulers = []
old_rotation_orders = []
old_scales = []
self._dataAccessor.clear_xform_cache()
# any op may trigger a translation change if multi-manipulating
should_update_translate = dirty_ops & OpFlag.TRANSLATE or len(self._xformable_prim_paths) > 1
should_update_rotate = dirty_ops & OpFlag.ROTATE
should_update_scale = dirty_ops & OpFlag.SCALE
for path in self._xformable_prim_paths_sorted:
if self._custom_manipulator_enabled and self._should_skip_custom_manipulator_path(path.pathString):
continue
selected_prim = self._dataAccessor.get_prim_at_path(path)
# We check whether path is in all_xformable_prim_data_curr because it may have not made it the dictionary if an error occured
if not selected_prim or path not in self.all_xformable_prim_data_curr:
continue
(s, r, ro, t, selected_pivot) = self.all_xformable_prim_data_curr[path]
selected_parent_to_world_mtx = self._dataAccessor.get_parent_to_world_transform(selected_prim)
world_to_parent_mtx = selected_parent_to_world_mtx.GetInverse()
selected_local_mtx_new = new_manipulator_transform * world_to_parent_mtx * selected_pivot.GetInverse()
if should_update_translate:
translation = selected_local_mtx_new.ExtractTranslation()
if should_update_rotate:
# Construct the new rotation from old scale and translation.
# Don't use Factor because it won't be able to tell if scale is positive or negative and can result in flipped rotation
old_s_mtx = Gf.Matrix4d(1.0)
old_s_mtx.SetScale(Gf.Vec3d(s))
old_t_mtx = Gf.Matrix4d(1.0)
old_t_mtx.SetTranslate(Gf.Vec3d(t))
rot_new = (old_s_mtx.GetInverse() * selected_local_mtx_new * old_t_mtx.GetInverse()).ExtractRotation()
axes = [Gf.Vec3d.XAxis(), Gf.Vec3d.YAxis(), Gf.Vec3d.ZAxis()]
decomp_rot = rot_new.Decompose(axes[ro[2]], axes[ro[1]], axes[ro[0]])
index_order = Gf.Vec3i()
for i in range(3):
index_order[ro[i]] = 2 - i
rotation = Gf.Vec3d(decomp_rot[index_order[0]], decomp_rot[index_order[1]], decomp_rot[index_order[2]])
rotation = find_best_euler_angles(Gf.Vec3d(r), rotation, ro)
if should_update_scale:
# Construct the new scale from old rotation and translation.
# Don't use Factor because it won't be able to tell if scale is positive or negative and can result in flipped rotation
old_rt_mtx = compose_transform_ops_to_matrix(t, r, ro, Gf.Vec3d(1))
new_s_mtx = selected_local_mtx_new * old_rt_mtx.GetInverse()
scale = Gf.Vec3d(new_s_mtx[0][0], new_s_mtx[1][1], new_s_mtx[2][2])
# any op may trigger a translation change if multi-manipulating
translation = translation if should_update_translate else t
rotation = rotation if should_update_rotate else r
scale = scale if should_update_scale else s
paths.append(path.pathString)
new_translations += [translation[0], translation[1], translation[2]]
new_rotation_eulers += [rotation[0], rotation[1], rotation[2]]
new_rotation_orders += [ro[0], ro[1], ro[2]]
new_scales += [scale[0], scale[1], scale[2]]
old_translations += [t[0], t[1], t[2]]
old_rotation_eulers += [r[0], r[1], r[2]]
old_rotation_orders += [ro[0], ro[1], ro[2]]
old_scales += [s[0], s[1], s[2]]
xform_tuple = (scale, rotation, ro, translation, selected_pivot)
self.all_xformable_prim_data_curr[path] = xform_tuple
if path in self.consolidated_xformable_prim_data_curr:
self.consolidated_xformable_prim_data_curr[path] = xform_tuple
self._ignore_xform_data_change = True
self._do_transform_all_selected_prims_to_manipulator_pivot(
paths, new_translations, new_rotation_eulers, new_rotation_orders, new_scales
)
self._ignore_xform_data_change = False
def _alert_if_selection_has_instance_proxies(self):
if self._selected_instance_proxy_paths and (not self._warning_notification or self._warning_notification.dismissed):
try:
import omni.kit.notification_manager as nm
self._warning_notification = nm.post_notification(
"Children of an instanced prim cannot be modified, uncheck Instanceable on the instanced prim to modify child prims.",
status=nm.NotificationStatus.WARNING
)
except ImportError:
pass
def _on_stage_closing(self):
self._dataAccessor.free_stage()
self._dataAccessor.free_xform_cache()
self._xformable_prim_paths.clear()
self._xformable_prim_paths_sorted.clear()
self._xformable_prim_paths_set.clear()
self._xformable_prim_paths_prefix_set.clear()
self._consolidated_xformable_prim_paths.clear()
self._pivot_prim = None
self._timeline_sub = None
if self._stage_listener:
self._stage_listener = self._dataAccessor.remove_update_callback(self._stage_listener)
self._pending_changed_paths.clear()
if self._update_prim_xform_from_prim_task_or_future is not None:
self._update_prim_xform_from_prim_task_or_future.cancel()
self._update_prim_xform_from_prim_task_or_future = None
def on_selection_changed(self, selection: List[Sdf.Path]):
if self._update_prim_xform_from_prim_task_or_future is not None:
self._update_prim_xform_from_prim_task_or_future.cancel()
self._update_prim_xform_from_prim_task_or_future = None
self._selected_instance_proxy_paths.clear()
self._xformable_prim_paths.clear()
self._xformable_prim_paths_set.clear()
self._xformable_prim_paths_prefix_set.clear()
self._consolidated_xformable_prim_paths.clear()
self._pivot_prim = None
for sdf_path in selection:
prim = self._dataAccessor.get_prim_at_path(sdf_path)
if prim and prim.IsA(UsdGeom.Xformable) and prim.IsActive():
self._xformable_prim_paths.append(sdf_path)
if self._xformable_prim_paths:
# Make a sorted list so parents always appears before child
self._xformable_prim_paths_sorted = self._xformable_prim_paths.copy()
self._xformable_prim_paths_sorted.sort()
# Find the most recently selected valid xformable prim as the pivot prim where the transform gizmo is located at.
self._pivot_prim = self._dataAccessor.get_prim_at_path(self._xformable_prim_paths[-1])
# Get least common prims ancestors.
# We do this so that if one selected prim is a descendant of other selected prim, the descendant prim won't be
# transformed twice.
self._consolidated_xformable_prim_paths = Sdf.Path.RemoveDescendentPaths(self._xformable_prim_paths)
# Filter all instance proxy paths.
for path in self._consolidated_xformable_prim_paths:
prim = self._dataAccessor.get_prim_at_path(path)
if prim.IsInstanceProxy():
self._selected_instance_proxy_paths.add(sdf_path)
self._xformable_prim_paths_set.update(self._xformable_prim_paths)
for path in self._xformable_prim_paths_set:
self._xformable_prim_paths_prefix_set.update(path.GetPrefixes())
if self._update_transform_from_prims():
self._item_changed(self._transform_item)
# Happens when host widget is already enabled and first selection in a new stage
if self._enabled_hosting_widget_count > 0 and self._stage_listener is None:
self._stage_listener = self._dataAccessor.setup_update_callback(self._on_objects_changed)
def _should_keep_manipulator_orientation_unchanged(self, mode: str) -> bool:
# Exclude snap_to_face. During snap_to_face operation, it may modify the orientation of object to confrom to surface
# normal and the `new_manipulator_transform` param for `_transform_selected_prims` is set to the final transform
# of the manipulated prim. However, if we use old rotation in the condition below, _no_scale_transform_manipulator
# will not confrom to the new orientation, and _transform_selected_prims would double rotate the prims because it
# sees the rotation diff between the old prim orientation (captured at on_began) vs new normal orient, instead of
# current prim orientation vs new normal orientation.
# Plus, it is nice to see the normal of the object changing while snapping.
snap_provider_enabled = self.snap_settings_listener.snap_enabled and self.snap_settings_listener.snap_provider
# When the manipulator is being manipulated as local translate or scale, we do not want to change the rotation of
# the manipulator even if it's rotated, otherwise the direction of moving or scaling will change and can be very hard to control.
# It can happen when you move a prim that has a constraint on it (e.g. lookAt)
# In this case keep the rotation the same as on_began
return (
mode == c.TRANSFORM_MODE_LOCAL
and (self._current_editing_op == Operation.TRANSLATE or self._current_editing_op == Operation.SCALE)
and not snap_provider_enabled
)
def _should_keep_manipulator_translation_unchanged(self, mode: str) -> bool:
# When the pivot placement is BBOX_CENTER and multiple prims being rotated, the bbox center may shifts, and the
# rotation center will shift with them. This causes weird user experience. So we pin the rotation center until
# mouse is released.
return (
self._current_editing_op == Operation.ROTATE
and (self._placement == Placement.BBOX_CENTER or self._placement == Placement.BBOX_BASE)
)
def _get_transform_mode_for_current_op(self) -> str:
mode = c.TRANSFORM_MODE_LOCAL
if self._op_settings_listener.selected_op == c.TRANSFORM_OP_ROTATE:
mode = self._op_settings_listener.rotation_mode
elif self._op_settings_listener.selected_op == c.TRANSFORM_OP_MOVE:
mode = self._op_settings_listener.translation_mode
return mode
# Adds a delay to the visual update during translate (only) manipulation
# It's due to the renderer having a delay of rendering the mesh and the manipulator appears to drift apart.
# It's only an estimation and may varying from scene/renderer setup.
async def _delay_dirty(self, transform, id):
if self._viewport_fps:
render_frame_time = 1.0 / self._viewport_fps * self._settings.get(TRANSLATE_DELAY_FRAME_SETTING)
while True:
dt = await self._app.next_update_async()
render_frame_time -= dt
# break a frame early
if render_frame_time < dt:
break
# cancel earlier job if a later one catches up (fps suddenly changed?)
earlier_tasks_or_futures = []
for key, task_or_future in self._delay_dirty_tasks_or_futures.items():
if key < id:
earlier_tasks_or_futures.append(key)
task_or_future.cancel()
else:
break
for key in earlier_tasks_or_futures:
self._delay_dirty_tasks_or_futures.pop(key)
self._transform = transform
self._item_changed(self._transform_item)
self._delay_dirty_tasks_or_futures.pop(id)
def _update_temp_pivot_world_position(self):
if type(self._transform) is not list:
return
new_world_position = self._transform[12:15]
self._settings.set_float_array(
self._selection_pivot_position_path,
new_world_position
)
@carb.profiler.profile
def _update_transform_from_prims(self):
xform_flattened = self._calculate_transform_from_prim()
if self._transform != xform_flattened:
self._transform = xform_flattened
# update setting with new pivot placement position
self._update_temp_pivot_world_position()
return True
return False
#def _calculate_transform_from_obj(self):
def _calculate_transform_from_prim(self):
if not self._dataAccessor.get_stage():
return False
if not self._pivot_prim:
return False
self._dataAccessor.clear_xform_cache()
cur_time = self._dataAccessor.get_current_time_code(self._current_time)
mode = self._get_transform_mode_for_current_op()
pivot_inv = get_local_transform_pivot_inv(self._pivot_prim, cur_time)
if self._should_keep_manipulator_orientation_unchanged(mode):
pivot_prim_path = self._pivot_prim.GetPath()
(s, r, ro, t) = self._dataAccessor.get_local_transform_SRT(self._pivot_prim, cur_time)
pivot = get_local_transform_pivot_inv(self._pivot_prim, self._dataAccessor.get_current_time_code(self._current_time)).GetInverse()
self.all_xformable_prim_data_curr[pivot_prim_path] = (s, r, ro, t) + (pivot,)
# This method may be called from _on_op_listener_changed, before any gesture has started
# in which case _all_xformable_prim_data_prev would be empty
piv_xf_tuple = self._all_xformable_prim_data_prev.get(pivot_prim_path, False)
if not piv_xf_tuple:
piv_xf_tuple = self._dataAccessor.get_local_transform_SRT(self._pivot_prim, cur_time)
pv_xf_pivot = get_local_transform_pivot_inv(
self._pivot_prim, self._dataAccessor.get_current_time_code(self._current_time)
).GetInverse()
self._all_xformable_prim_data_prev[self._pivot_prim.GetPath()] = piv_xf_tuple + (pv_xf_pivot,)
(s_p, r_p, ro_p, t_p, t_piv) = piv_xf_tuple
xform = self._construct_transform_matrix_from_SRT(t, r_p, ro_p, s, pivot_inv)
parent = self._dataAccessor.get_local_to_world_transform(self._pivot_prim.GetParent())
xform *= parent
else:
xform = self._dataAccessor.get_local_to_world_transform(self._pivot_prim)
xform = pivot_inv.GetInverse() * xform
if self._should_keep_manipulator_translation_unchanged(mode):
xform.SetTranslateOnly((self._transform[12], self._transform[13], self._transform[14]))
else:
# if there's only one selection, we always use LAST_PRIM_PIVOT though
if (
self._placement != Placement.LAST_PRIM_PIVOT
and self._placement != Placement.REF_PRIM
):
average_translation = Gf.Vec3d(0.0)
if self._placement == Placement.BBOX_CENTER or self._placement == Placement.BBOX_BASE:
world_bound = Gf.Range3d()
def get_prim_translation(xformable):
xformable_world_mtx = self._dataAccessor.get_local_to_world_transform(xformable)
xformable_pivot_inv = get_local_transform_pivot_inv(xformable, cur_time)
xformable_world_mtx = xformable_pivot_inv.GetInverse() * xformable_world_mtx
return xformable_world_mtx.ExtractTranslation()
for path in self._xformable_prim_paths:
xformable = self._dataAccessor.get_prim_at_path(path)
if self._placement == Placement.SELECTION_CENTER:
average_translation += get_prim_translation(xformable)
elif self._placement == Placement.BBOX_CENTER or Placement.BBOX_BASE:
bound_range = self._usd_context.compute_path_world_bounding_box(path.pathString)
bound_range = Gf.Range3d(Gf.Vec3d(*bound_range[0]), Gf.Vec3d(*bound_range[1]))
if not bound_range.IsEmpty():
world_bound = Gf.Range3d.GetUnion(world_bound, bound_range)
else:
# extend world bound with tranlation for prims with zero bbox, e.g. Xform, Camera
prim_translation = get_prim_translation(xformable)
world_bound.UnionWith(prim_translation)
if self._placement == Placement.SELECTION_CENTER:
average_translation /= len(self._xformable_prim_paths)
elif self._placement == Placement.BBOX_CENTER:
average_translation = world_bound.GetMidpoint()
elif self._placement == Placement.BBOX_BASE:
# xform may not have bbox but its descendants may have, exclude cases that only xform are selected
if not world_bound.IsEmpty():
bbox_center = world_bound.GetMidpoint()
bbox_size = world_bound.GetSize()
if UsdGeom.GetStageUpAxis(self._dataAccessor.get_stage()) == UsdGeom.Tokens.y:
# Y-up world
average_translation = bbox_center - Gf.Vec3d(0.0, bbox_size[1]/2.0, 0.0)
else:
# Z-up world
average_translation = bbox_center - Gf.Vec3d(0.0, 0.0, bbox_size[2]/2.0)
else:
# fallback to SELECTION_CENTER
average_translation /= len(self._xformable_prim_paths)
# Only take the translate from selected prim average.
# The rotation and scale still comes from pivot prim
xform.SetTranslateOnly(average_translation)
# instead of using RemoveScaleShear, additional steps made to handle negative scale properly
scale, _, _, _ = self._dataAccessor.get_local_transform_SRT(self._pivot_prim, cur_time)
scale_epsilon = 1e-6
for i in range(3):
if Gf.IsClose(scale[i], 0.0, scale_epsilon):
scale[i] = -scale_epsilon if scale[i] < 0 else scale_epsilon
inverse_scale = Gf.Matrix4d().SetScale(Gf.Vec3d(1.0 / scale[0], 1.0 / scale[1], 1.0 / scale[2]))
xform = inverse_scale * xform
# this is the average xform without scale
self._no_scale_transform_manipulator = Gf.Matrix4d(xform)
# store the scale separately
self._scale_manipulator = Gf.Vec3d(scale)
# Visual transform of the manipulator
xform = xform.RemoveScaleShear()
if mode == c.TRANSFORM_MODE_GLOBAL:
xform = xform.SetTranslate(xform.ExtractTranslation())
return flatten(xform)
def _construct_transform_matrix_from_SRT(
self,
translation: Gf.Vec3d,
rotation_euler: Gf.Vec3d,
rotation_order: Gf.Vec3i,
scale: Gf.Vec3d,
pivot_inv: Gf.Matrix4d,
):
trans_mtx = Gf.Matrix4d()
rot_mtx = Gf.Matrix4d()
scale_mtx = Gf.Matrix4d()
trans_mtx.SetTranslate(Gf.Vec3d(translation))
axes = [Gf.Vec3d.XAxis(), Gf.Vec3d.YAxis(), Gf.Vec3d.ZAxis()]
rotation = (
Gf.Rotation(axes[rotation_order[0]], rotation_euler[rotation_order[0]])
* Gf.Rotation(axes[rotation_order[1]], rotation_euler[rotation_order[1]])
* Gf.Rotation(axes[rotation_order[2]], rotation_euler[rotation_order[2]])
)
rot_mtx.SetRotate(rotation)
scale_mtx.SetScale(Gf.Vec3d(scale))
return pivot_inv * scale_mtx * rot_mtx * pivot_inv.GetInverse() * trans_mtx
def _on_op_listener_changed(self, type: OpSettingsListener.CallbackType, value: str):
if type == OpSettingsListener.CallbackType.OP_CHANGED:
# cancel all delayed tasks
for task_or_future in self._delay_dirty_tasks_or_futures.values():
task_or_future.cancel()
self._delay_dirty_tasks_or_futures.clear()
self._update_transform_from_prims()
self._item_changed(self._transform_item)
elif type == OpSettingsListener.CallbackType.TRANSLATION_MODE_CHANGED:
if self._op_settings_listener.selected_op == c.TRANSFORM_OP_MOVE:
if self._update_transform_from_prims():
self._item_changed(self._transform_item)
elif type == OpSettingsListener.CallbackType.ROTATION_MODE_CHANGED:
if self._op_settings_listener.selected_op == c.TRANSFORM_OP_ROTATE:
if self._update_transform_from_prims():
self._item_changed(self._transform_item)
def _update_placement(self, placement_str: str):
if placement_str == prim_c.MANIPULATOR_PLACEMENT_SELECTION_CENTER:
placement = Placement.SELECTION_CENTER
elif placement_str == prim_c.MANIPULATOR_PLACEMENT_BBOX_CENTER:
placement = Placement.BBOX_CENTER
elif placement_str == prim_c.MANIPULATOR_PLACEMENT_PICK_REF_PRIM:
placement = Placement.REF_PRIM
elif placement_str == prim_c.MANIPULATOR_PLACEMENT_BBOX_BASE:
placement = Placement.BBOX_BASE
else: # placement == prim_c.MANIPULATOR_PLACEMENT_LAST_PRIM_PIVOT or bad values
placement = Placement.LAST_PRIM_PIVOT
if placement != self._placement:
if placement == Placement.LAST_PRIM_PIVOT and self._placement == Placement.REF_PRIM:
# reset the pivot prim in case it was changed by MANIPULATOR_PLACEMENT_PICK_REF_PRIM
if self._xformable_prim_paths:
self._pivot_prim = self._dataAccessor.get_prim_at_path(self._xformable_prim_paths[-1])
self._placement = placement
if self._update_transform_from_prims():
self._item_changed(self._transform_item)
def _on_placement_setting_changed(self, item, event_type):
placement_str = self._dict.get(item)
self._update_placement(placement_str)
def _check_update_selected_instance_proxy_list(self, path: Sdf.Path, resynced):
def track_or_remove_from_instance_proxy_list(prim):
valid_proxy = prim and prim.IsActive() and prim.IsInstanceProxy()
if valid_proxy:
self._selected_instance_proxy_paths.add(prim.GetPath())
else:
self._selected_instance_proxy_paths.discard(prim.GetPath())
prim_path = path.GetPrimPath()
changed_prim = self._dataAccessor.get_prim_at_path(prim_path)
# Update list of instance proxy paths.
if resynced and path.IsPrimPath():
if prim_path in self._consolidated_xformable_prim_paths:
# Quick path if it's selected already.
track_or_remove_from_instance_proxy_list(changed_prim)
else:
# Slow path to verify if any of its ancestors are changed.
for path in self._consolidated_xformable_prim_paths:
if not path.HasPrefix(prim_path):
continue
prim = self._dataAccessor.get_prim_at_path(path)
track_or_remove_from_instance_proxy_list(prim)
@carb.profiler.profile
async def _update_transform_from_prims_async(self):
try:
check_all_prims = (
self._placement != Placement.LAST_PRIM_PIVOT
and self._placement != Placement.REF_PRIM
and len(self._xformable_prim_paths) > 1
)
pivot_prim_path = self._pivot_prim.GetPath()
for p, resynced in self._pending_changed_paths.items():
self._check_update_selected_instance_proxy_list(p, resynced)
prim_path = p.GetPrimPath()
# Update either check_all_prims
# or prim_path is a prefix of pivot_prim_path (pivot prim's parent affect pivot prim transform)
# Note: If you move the manipulator and the prim flies away while manipulator stays in place, check this
# condition!
if (
# check _xformable_prim_paths_prefix_set so that if the parent path of selected prim(s) changed, it
# can still update manipulator transform
prim_path in self._xformable_prim_paths_prefix_set
if check_all_prims
else pivot_prim_path.HasPrefix(prim_path)
):
if self._path_may_affect_transform(p):
# only delay the visual update in translate mode.
should_delay_frame = self._settings.get(TRANSLATE_DELAY_FRAME_SETTING) > 0
if self._op_settings_listener.selected_op == c.TRANSFORM_OP_MOVE and should_delay_frame:
xform = self._calculate_transform_from_prim()
id = self._app.get_update_number()
self._delay_dirty_tasks_or_futures[id] = run_coroutine(self._delay_dirty(xform, id))
else:
if self._update_transform_from_prims():
self._item_changed(self._transform_item)
break
except Exception as e:
carb.log_error(traceback.format_exc())
finally:
self._pending_changed_paths.clear()
self._update_prim_xform_from_prim_task_or_future = None
@carb.profiler.profile
def _on_objects_changed(self, notice, sender):
if not self._pivot_prim:
return
# collect resynced paths so that removed/added xformOps triggers refresh
for path in notice.GetResyncedPaths():
self._pending_changed_paths[path] = True
# collect changed only paths
for path in notice.GetChangedInfoOnlyPaths():
self._pending_changed_paths[path] = False
# if an operation is in progess, record all dirty xform path
if self._current_editing_op is not None and not self._ignore_xform_data_change:
self._pending_changed_paths_for_xform_data.update(notice.GetChangedInfoOnlyPaths())
if self._update_prim_xform_from_prim_task_or_future is None or self._update_prim_xform_from_prim_task_or_future.done():
self._update_prim_xform_from_prim_task_or_future = run_coroutine(self._update_transform_from_prims_async())
def _set_default_settings(self):
self._settings.set_default(TRANSFORM_GIZMO_CUSTOM_MANIPULATOR_ENABLED, False)
self._settings.set_default(TRANSFORM_GIZMO_IS_USING, False)
self._settings.set_default(TRANSFORM_GIZMO_TRANSLATE_DELTA_XYZ, [0, 0, 0])
self._settings.set_default(TRANSFORM_GIZMO_ROTATE_DELTA_XYZW, [0, 0, 0, 1])
self._settings.set_default(TRANSFORM_GIZMO_SCALE_DELTA_XYZ, [0, 0, 0])
def _should_skip_custom_manipulator_path(self, path: str) -> bool:
custom_manipulator_path_prims_settings_path = TRANSFORM_GIZMO_CUSTOM_MANIPULATOR_PRIMS + path
return self._settings.get(custom_manipulator_path_prims_settings_path)
def _path_may_affect_transform(self, path: Sdf.Path) -> bool:
# Batched changes sent in a SdfChangeBlock may not have property name but only the prim path
return not path.ContainsPropertyElements() or UsdGeom.Xformable.IsTransformationAffectedByAttrNamed(path.name)
@property
def stage(self):
return self._dataAccessor.get_stage()
@property
def custom_manipulator_enabled(self):
return self._custom_manipulator_enabled
@property
def snap_settings_listener(self):
return self._snap_settings_listener
@property
def op_settings_listener(self):
return self._op_settings_listener
@property
def usd_context(self) -> omni.usd.UsdContext:
return self._usd_context
@property
def xformable_prim_paths(self) -> List[Sdf.Path]:
return self._xformable_prim_paths
class PrimDataAccessorRegistry(DataAccessorRegistry):
def __init__(self, dataType = "USD"):
self._dataType = dataType
def getDataAccessor(self, model):
if self._dataType == "USD":
self.dataAccessor = UsdDataAccessor(model = model)
elif self._dataType == "Fabric":
self.dataAccessor = FabricDataAccessor(model = model)
else:
self.dataAccessor = None
#self.dataAccessor = FabricDataAccessor()
return self.dataAccessor
#to be moved to omni.kit.manipulator.prim2.usd
class UsdDataAccessor(DataAccessor):
def __init__(self, usd_context_name: str = "", model = None):
super().__init__()
self._model = model
self._xform_cache = None
self._stage: Usd.Stage = None
def _update_transform_from_prims(self):
...
def _update_xform_data_from_dirty_paths(self):
...
def get_prim_at_path(self, path):
return self._stage.GetPrimAtPath(path)
def get_current_time_code(self, currentTime):
return Usd.TimeCode(omni.usd.get_frame_time_code(currentTime, self._stage.GetTimeCodesPerSecond()))
def get_local_transform_SRT(self, prim, time):
return omni.usd.get_local_transform_SRT(prim, time)
#xform cache
def get_local_to_world_transform(self, obj):
return self._xform_cache.GetLocalToWorldTransform(obj)
def get_parent_to_world_transform(self, obj):
return self._xform_cache.GetParentToWorldTransform(obj)
def clear_xform_cache(self):
self._xform_cache.Clear()
def free_xform_cache(self):
self._xform_cache = None
def xform_set_time(self):
self._xform_cache.SetTime(self.get_current_time_code(self._model._current_time))
def update_xform_cache(self):
self._xform_cache = UsdGeom.XformCache(self.get_current_time_code(self._model._current_time))
#stage
def free_stage(self):
self._stage = None
def get_stage(self):
return self._stage
#callbacks
def setup_update_callback(self, function):
res = Tf.Notice.Register(Usd.Notice.ObjectsChanged, function, self._stage)
carb.log_info("Tf.Notice.Register in PrimTransformModel")
return res
def remove_update_callback(self, listener): #removeUpdateCallback
listener.Revoke()
carb.log_info("Tf.Notice.Revoke in PrimTransformModel")
return None
#USD specific commands
def _do_transform_all_selected_prims_to_manipulator_pivot(
self,
paths: List[str],
new_translations: List[float],
new_rotation_eulers: List[float],
new_rotation_orders: List[int],
new_scales: List[float],
):
omni.kit.commands.create(
"TransformMultiPrimsSRTCpp",
count=len(paths),
no_undo=True,
paths=paths,
new_translations=new_translations,
new_rotation_eulers=new_rotation_eulers,
new_rotation_orders=new_rotation_orders,
new_scales=new_scales,
usd_context_name=self._model._usd_context_name,
time_code=self.get_current_time_code(self._model._current_time).GetValue(),
).do()
def _do_transform_selected_prims(
self,
paths: List[str],
new_translations: List[float],
new_rotation_eulers: List[float],
new_rotation_orders: List[int],
new_scales: List[float],
):
omni.kit.commands.create(
"TransformMultiPrimsSRTCpp",
count=len(paths),
no_undo=True,
paths=paths,
new_translations=new_translations,
new_rotation_eulers=new_rotation_eulers,
new_rotation_orders=new_rotation_orders,
new_scales=new_scales,
usd_context_name=self._model._usd_context_name,
time_code=self.get_current_time_code(self._model._current_time).GetValue(),
).do()
def _on_ended_transform(
self,
paths: List[str],
new_translations: List[float],
new_rotation_eulers: List[float],
new_rotation_orders: List[int],
new_scales: List[float],
old_translations: List[float],
old_rotation_eulers: List[float],
old_rotation_orders: List[int],
old_scales: List[float],
):
omni.kit.commands.execute(
"TransformMultiPrimsSRTCpp",
count=len(paths),
paths=paths,
new_translations=new_translations,
new_rotation_eulers=new_rotation_eulers,
new_rotation_orders=new_rotation_orders,
new_scales=new_scales,
old_translations=old_translations,
old_rotation_eulers=old_rotation_eulers,
old_rotation_orders=old_rotation_orders,
old_scales=old_scales,
usd_context_name=self._model._usd_context_name,
time_code=self.get_current_time_code(self._model._current_time).GetValue(),
)
#to be moved to omni.kit.manipulator.prim2.fabric
class FabricDataAccessor(DataAccessor):
#TODO
def __init__(self, usd_context_name: str = "", model = None):
...
| 64,918 | Python | 45.140014 | 149 | 0.627191 |
omniverse-code/kit/exts/omni.kit.manipulator.prim2.core/omni/kit/manipulator/prim2/core/pivot_button_group.py | # Copyright (c) 2023, 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.
#
from pathlib import Path
import carb.input
import carb.settings
import omni.kit.context_menu
import omni.ui as ui
from omni.kit.widget.toolbar.widget_group import WidgetGroup
ICON_FOLDER_PATH = Path(
f"{omni.kit.app.get_app().get_extension_manager().get_extension_path_by_module(__name__)}/data/icons"
)
class PivotButtonGroup(WidgetGroup):
"""
Toolbar entry for pivot placement
"""
def __init__(self):
super().__init__()
self._input = carb.input.acquire_input_interface()
self._settings = carb.settings.get_settings()
def clean(self):
super().clean()
def __del__(self):
self.clean()
def get_style(self):
style = {
"Button.Image::pivot_placement": {"image_url": f"{ICON_FOLDER_PATH}/pivot_location.svg"}
}
return style
def get_button(self) -> ui.ToolButton:
return self._button
def create(self, default_size):
self._button = ui.Button(
name="pivot_placement",
width=default_size,
height=default_size,
tooltip="Pivot Placement",
mouse_pressed_fn=lambda x, y, b, _: self._on_mouse_pressed(b, "multi_sel_pivot", min_menu_entries=1),
mouse_released_fn=lambda x, y, b, _: self._on_mouse_released(b)
)
return {"pivot": self._button}
def _on_mouse_pressed(self, button, button_id: str, min_menu_entries: int = 2):
# override default behavior, left or right click will show menu without delay
self._acquire_toolbar_context()
if button == 0 or button == 1:
self._invoke_context_menu(button_id, min_menu_entries)
def _invoke_context_menu(self, button_id: str, min_menu_entries: int = 1):
"""
Function to invoke context menu.
Args:
button_id: button_id of the context menu to be invoked.
min_menu_entries: minimal number of menu entries required for menu to be visible (default 1).
"""
button_id = "multi_sel_pivot"
context_menu = omni.kit.context_menu.get_instance()
objects = {"widget_name": button_id, "main_toolbar": True}
menu_list = omni.kit.context_menu.get_menu_dict(button_id, "omni.kit.manipulator.prim2.core")
context_menu.show_context_menu(
button_id,
objects,
menu_list,
min_menu_entries,
delegate=ui.MenuDelegate()
)
| 2,892 | Python | 32.639535 | 113 | 0.633126 |
omniverse-code/kit/exts/omni.kit.manipulator.prim2.core/omni/kit/manipulator/prim2/core/prim_transform_manipulator_registry.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__ = ["TransformManipulatorRegistry"]
import weakref
from omni.kit.viewport.registry import RegisterScene
from .prim_transform_manipulator import PrimTransformManipulator
from .reference_prim_marker import ReferencePrimMarker
class PrimTransformManipulatorScene:
def __init__(self, desc: dict):
usd_context_name = desc.get("usd_context_name")
self.__transform_manip = PrimTransformManipulator(
usd_context_name=usd_context_name, viewport_api=desc.get("viewport_api")
)
self.__reference_prim_marker = ReferencePrimMarker(
usd_context_name=usd_context_name, manipulator_model=weakref.proxy(self.__transform_manip.model)
)
def destroy(self):
if self.__transform_manip:
self.__transform_manip.destroy()
self.__transform_manip = None
if self.__reference_prim_marker:
self.__reference_prim_marker.destroy()
self.__reference_prim_marker = None
# PrimTransformManipulator & TransformManipulator don't have their own visibility
@property
def visible(self):
return True
@visible.setter
def visible(self, value):
pass
@property
def categories(self):
return ("manipulator",)
@property
def name(self):
return "Prim Transform"
class TransformManipulatorRegistry:
def __init__(self):
self._scene = RegisterScene(PrimTransformManipulatorScene, "omni.kit.manipulator.prim2.core")
def __del__(self):
self.destroy()
def destroy(self):
self._scene = None
| 2,024 | Python | 29.681818 | 108 | 0.692194 |
omniverse-code/kit/exts/omni.kit.manipulator.prim2.core/omni/kit/manipulator/prim2/core/tests/test_manipulator_prim.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.
#
import omni.kit.test
import inspect
import logging
import math
import os
from pathlib import Path
from typing import Awaitable, Callable, List
import carb
import carb.input
import carb.settings
import omni.kit.commands
import omni.kit.ui_test as ui_test
import omni.kit.undo
import omni.usd
from carb.input import MouseEventType
from omni.kit.manipulator.prim2.core.settings_constants import Constants as prim_c
from omni.kit.manipulator.tool.snap import settings_constants as snap_c
from omni.kit.manipulator.tool.snap.builtin_snap_tools import SURFACE_SNAP_NAME
from omni.kit.manipulator.transform.settings_constants import c
from omni.kit.ui_test import Vec2
from omni.ui.tests.test_base import OmniUiTest
from omni.kit.test_helpers_gfx.compare_utils import capture_and_compare, ComparisonMetric
from pxr import UsdGeom, Gf
CURRENT_PATH = Path(carb.tokens.get_tokens_interface().resolve("${omni.kit.manipulator.prim2.core}/data"))
OUTPUTS_DIR = Path(omni.kit.test.get_test_output_path()).resolve().absolute()
logger = logging.getLogger(__name__)
class TestTransform(OmniUiTest):
# Before running each test
async def setUp(self):
await super().setUp()
self._context = omni.usd.get_context()
self._selection = self._context.get_selection()
self._settings = carb.settings.get_settings()
self._golden_img_dir = CURRENT_PATH.absolute().resolve().joinpath("tests").joinpath("golden")
self._usd_scene_dir = CURRENT_PATH.absolute().resolve().joinpath("tests").joinpath("usd")
self._window_width = self._settings.get("/app/window/width")
self._window_height = self._settings.get("/app/window/height")
# Load renderer before USD is loaded
await self._context.new_stage_async()
# After running each test
async def tearDown(self):
# Move and close the stage so selections are reset to avoid triggering ghost gestures.
await ui_test.emulate_mouse_move(Vec2(0, 0))
await ui_test.human_delay()
await self._context.close_stage_async()
self._golden_img_dir = None
await super().tearDown()
async def _snapshot(self, golden_img_name: str = "", threshold: float = 2e-4):
await ui_test.human_delay()
test_fn_name = ""
for frame_info in inspect.stack():
if os.path.samefile(frame_info[1], __file__):
test_fn_name = frame_info[3]
golden_img_name = f"{test_fn_name}.{golden_img_name}.png"
# Because we're testing RTX renderered pixels, use a better threshold filter for differences
diff = await capture_and_compare(
golden_img_name,
threshold=threshold,
output_img_dir=OUTPUTS_DIR,
golden_img_dir=self._golden_img_dir,
metric=ComparisonMetric.MEAN_ERROR_SQUARED,
)
self.assertLessEqual(
diff,
threshold,
f"The generated image {golden_img_name} has a difference of {diff}, but max difference is {threshold}",
)
async def _setup_global(
self,
op: str,
enable_toolbar: bool = False,
file_name: str = "test_scene.usda",
prims_to_select=["/World/Cube", "/World/Xform", "/World/Xform/Cube_01"],
placement=prim_c.MANIPULATOR_PLACEMENT_LAST_PRIM_PIVOT,
):
await self._setup(file_name, c.TRANSFORM_MODE_GLOBAL, op, enable_toolbar, prims_to_select, placement)
async def _setup_local(
self,
op: str,
enable_toolbar: bool = False,
file_name: str = "test_scene.usda",
prims_to_select=["/World/Cube", "/World/Xform", "/World/Xform/Cube_01"],
placement=prim_c.MANIPULATOR_PLACEMENT_LAST_PRIM_PIVOT,
):
await self._setup(file_name, c.TRANSFORM_MODE_LOCAL, op, enable_toolbar, prims_to_select, placement)
async def _setup(
self,
scene_file: str,
mode: str,
op: str,
enable_toolbar: bool = False,
prims_to_select=["/World/Cube", "/World/Xform", "/World/Xform/Cube_01"],
placement=prim_c.MANIPULATOR_PLACEMENT_LAST_PRIM_PIVOT,
):
usd_path = self._usd_scene_dir.joinpath(scene_file)
success, error = await self._context.open_stage_async(str(usd_path))
self.assertTrue(success, error)
# move the mouse out of the way
await ui_test.emulate_mouse_move(Vec2(0, 0))
await ui_test.human_delay()
self._settings.set(prim_c.MANIPULATOR_PLACEMENT_SETTING, placement)
self._settings.set(c.TRANSFORM_MOVE_MODE_SETTING, mode)
self._settings.set(c.TRANSFORM_ROTATE_MODE_SETTING, mode)
self._settings.set(c.TRANSFORM_OP_SETTING, op)
self._settings.set("/app/viewport/snapEnabled", False)
self._settings.set("/persistent/app/viewport/snapToSurface", False)
self._settings.set("/exts/omni.kit.manipulator.prim2.core/tools/enabled", enable_toolbar)
self._selection.set_selected_prim_paths([], True)
await ui_test.human_delay(human_delay_speed=10)
self._selection.set_selected_prim_paths(prims_to_select, True)
await ui_test.human_delay(human_delay_speed=10)
# Save prims initial state to restore to.
stage = self._context.get_stage()
self._restore_transform = {}
for prim_path in prims_to_select:
xform_ops = []
for xform_op in UsdGeom.Xformable(stage.GetPrimAtPath(prim_path)).GetOrderedXformOps():
if not xform_op.IsInverseOp():
xform_ops.append((xform_op, xform_op.Get()))
self._restore_transform[prim_path] = xform_ops
async def _restore_initial_state(self):
for xform_op_list in self._restore_transform.values():
for xform_op_tuple in xform_op_list:
xform_op, start_value = xform_op_tuple[0], xform_op_tuple[1]
xform_op.Set(start_value)
async def _emulate_mouse_drag_and_drop_multiple_waypoints(
self,
waypoints: List[Vec2],
right_click=False,
human_delay_speed: int = 4,
num_steps: int = 8,
on_before_drop: Callable[[int], Awaitable[None]] = None,
):
"""Emulate Mouse Drag & Drop. Click at start position and slowly move to end position."""
logger.info(f"emulate_mouse_drag_and_drop poses: {waypoints} (right_click: {right_click})")
count = len(waypoints)
if count < 2:
return
await ui_test.input.emulate_mouse(MouseEventType.MOVE, waypoints[0])
await ui_test.human_delay(human_delay_speed)
await ui_test.input.emulate_mouse(
MouseEventType.RIGHT_BUTTON_DOWN if right_click else MouseEventType.LEFT_BUTTON_DOWN
)
await ui_test.human_delay(human_delay_speed)
for i in range(1, count):
await ui_test.input.emulate_mouse_slow_move(
waypoints[i - 1], waypoints[i], num_steps=num_steps, human_delay_speed=human_delay_speed
)
if on_before_drop:
await ui_test.human_delay(human_delay_speed)
await on_before_drop()
await ui_test.input.emulate_mouse(
MouseEventType.RIGHT_BUTTON_UP if right_click else MouseEventType.LEFT_BUTTON_UP
)
await ui_test.human_delay(human_delay_speed)
################################################################
################## test manipulator placement ##################
################################################################
async def test_placement(self):
await self._setup_global(c.TRANSFORM_OP_MOVE)
PLACEMENTS = {
"placement_selection_center": prim_c.MANIPULATOR_PLACEMENT_SELECTION_CENTER,
"placement_bbox_center": prim_c.MANIPULATOR_PLACEMENT_BBOX_CENTER,
"placement_authored_pivot": prim_c.MANIPULATOR_PLACEMENT_LAST_PRIM_PIVOT,
"placement_bbox_base": prim_c.MANIPULATOR_PLACEMENT_BBOX_BASE
}
for test_name, val in PLACEMENTS.items():
self._settings.set(prim_c.MANIPULATOR_PLACEMENT_SETTING, val)
await ui_test.human_delay()
await self._snapshot(test_name)
async def test_tmp_placement(self):
await self._setup_global(c.TRANSFORM_OP_MOVE, prims_to_select=["/World/Xform/Cube_01", "/World/Cube"])
self._settings.set(prim_c.MANIPULATOR_PLACEMENT_SETTING, prim_c.MANIPULATOR_PLACEMENT_PICK_REF_PRIM)
await ui_test.human_delay()
await self._snapshot("pick_default")
center = Vec2(self._window_width, self._window_height) / 2
# pick the other prim as tmp pivot prim
await ui_test.emulate_mouse_move_and_click(center)
await ui_test.human_delay()
await self._snapshot("pick")
# reset placement to last prim, the manipulator should go to last prim and marker disappears
self._settings.set(prim_c.MANIPULATOR_PLACEMENT_SETTING, prim_c.MANIPULATOR_PLACEMENT_LAST_PRIM_PIVOT)
await ui_test.human_delay()
await self._snapshot("last_selected")
async def test_bbox_placement_for_xform(self):
await self._setup_global(c.TRANSFORM_OP_MOVE, file_name="test_pivot_with_invalid_bbox.usda", prims_to_select=["/World/Xform"])
self._settings.set(prim_c.MANIPULATOR_PLACEMENT_SETTING, prim_c.MANIPULATOR_PLACEMENT_BBOX_CENTER)
await ui_test.human_delay()
await self._snapshot("placement_bbox_center")
self._settings.set(prim_c.MANIPULATOR_PLACEMENT_SETTING, prim_c.MANIPULATOR_PLACEMENT_BBOX_BASE)
await ui_test.human_delay()
await self._snapshot("placement_bbox_base")
################################################################
####################### test translation #######################
################################################################
################## test manipulator move axis ##################
async def test_move_global_axis(self):
await self._setup_global(c.TRANSFORM_OP_MOVE)
await self._test_move_axis()
async def test_move_local_axis(self):
await self._setup_local(c.TRANSFORM_OP_MOVE)
await self._test_move_axis(180)
async def _test_move_axis(self, angle_offset: float = 0, distance: float = 50):
OFFSET = 50
MOVEMENT = ["x", "y", "z"]
center = Vec2(self._window_width, self._window_height) / 2
for i, test_name in enumerate(MOVEMENT):
await ui_test.human_delay()
dir = Vec2(
math.cos(math.radians(-i * 120 + 30 + angle_offset)),
math.sin(math.radians(-i * 120 + 30 + angle_offset)),
)
try:
await ui_test.emulate_mouse_drag_and_drop(center + dir * OFFSET, center + dir * (OFFSET + distance))
await self._snapshot(f"{test_name}.{angle_offset}.{distance}")
finally:
await self._restore_initial_state()
################## test manipulator move plane ##################
async def test_move_global_plane(self):
await self._setup_global(c.TRANSFORM_OP_MOVE)
await self._test_move_plane()
async def test_move_local_plane(self):
await self._setup_local(c.TRANSFORM_OP_MOVE)
await self._test_move_plane(180)
async def _test_move_plane(self, angle_offset: float = 0, distance=75):
OFFSET = 50
MOVEMENT = ["xz", "zy", "yx"]
center = Vec2(self._window_width, self._window_height) / 2
for i, test_name in enumerate(MOVEMENT):
await ui_test.human_delay()
dir = Vec2(
math.cos(math.radians(-i * 120 + 90 + angle_offset)),
math.sin(math.radians(-i * 120 + 90 + angle_offset)),
)
try:
await ui_test.emulate_mouse_drag_and_drop(center + dir * OFFSET, center + dir * (OFFSET + distance))
await self._snapshot(f"{test_name}.{angle_offset}.{distance}")
finally:
await self._restore_initial_state()
################## test manipulator move center ##################
async def test_move_global_center(self):
await self._setup_global(c.TRANSFORM_OP_MOVE)
await self._test_move_center()
await self._test_move_center(
modifier=carb.input.KeyboardInput.LEFT_ALT
) # with alt down, transform is not changed
async def test_move_local_center(self):
await self._setup_local(c.TRANSFORM_OP_MOVE)
await self._test_move_center()
async def _test_move_center(self, dirs=[Vec2(50, 0)], modifier: carb.input.KeyboardInput = None):
try:
center = Vec2(self._window_width, self._window_height) / 2
waypoints = [center]
for dir in dirs:
waypoints.append(center + dir)
if modifier:
await ui_test.input.emulate_keyboard(carb.input.KeyboardEventType.KEY_PRESS, modifier)
await ui_test.human_delay()
await self._emulate_mouse_drag_and_drop_multiple_waypoints(waypoints)
if modifier:
await ui_test.input.emulate_keyboard(carb.input.KeyboardEventType.KEY_RELEASE, modifier)
await ui_test.human_delay()
test_name = f"xyz.{len(dirs)}"
if modifier:
test_name += str(modifier).split(".")[-1]
await self._snapshot(test_name) # todo better hash name?
finally:
await self._restore_initial_state()
# Test manipulator is placed correctly if the selected prim's parent is moved
async def test_move_selected_parent(self):
await self._setup_global(c.TRANSFORM_OP_MOVE, prims_to_select=["/World/Xform/Cube_01"])
stage = self._context.get_stage()
parent_translate_attr = stage.GetAttributeAtPath("/World/Xform.xformOp:translate")
try:
parent_translate_attr.Set((0, 100, -100))
await ui_test.human_delay(4)
await self._snapshot()
finally:
await self._restore_initial_state()
################################################################
######################## test rotation #########################
################################################################
################## test manipulator rotate arc ##################
async def test_rotate_global_arc(self):
await self._setup_global(c.TRANSFORM_OP_ROTATE)
await self._test_rotate_arc()
# add a test to only select prims in the same hierarchy and pivot prim being the child
# to cover the bug when consolidated prim path has one entry and is not the pivot prim
async def test_rotate_global_arc_single_hierarchy(self):
await self._setup_global(c.TRANSFORM_OP_ROTATE, prims_to_select=["/World/Xform", "/World/Xform/Cube_01"])
await self._test_rotate_arc()
async def test_rotate_local_arc(self):
await self._setup_local(c.TRANSFORM_OP_ROTATE)
await self._test_rotate_arc(180)
async def test_free_rotation_clamped(self):
await self._setup_global(c.TRANSFORM_OP_ROTATE)
self._settings.set(c.FREE_ROTATION_TYPE_SETTING, c.FREE_ROTATION_TYPE_CLAMPED)
await self._test_move_center(dirs=[Vec2(100, 100)])
async def test_free_rotation_continuous(self):
await self._setup_global(c.TRANSFORM_OP_ROTATE)
self._settings.set(c.FREE_ROTATION_TYPE_SETTING, c.FREE_ROTATION_TYPE_CONTINUOUS)
await self._test_move_center(dirs=[Vec2(100, 100)])
async def test_bbox_center_multi_prim_rotate_global(self):
await self._test_bbox_center_multi_prim_rotate(self._setup_global)
async def test_bbox_center_multi_prim_rotate_local(self):
await self._test_bbox_center_multi_prim_rotate(self._setup_local)
async def _test_bbox_center_multi_prim_rotate(self, test_fn):
await test_fn(
c.TRANSFORM_OP_ROTATE,
file_name="test_bbox_rotation.usda",
prims_to_select=["/World/Cube", "/World/Cube_01", "/World/Cube_02"],
placement=prim_c.MANIPULATOR_PLACEMENT_BBOX_CENTER,
)
await self._test_rotate_arc(post_snap=True)
async def _test_rotate_arc(self, offset: float = 0, post_snap=False):
OFFSET = 45
MOVEMENT = ["x", "y", "z", "screen"]
SEGMENT_COUNT = 12
center = Vec2(self._window_width, self._window_height) / 2
for i, test_name in enumerate(MOVEMENT):
await ui_test.human_delay()
waypoints = []
step = 360 / SEGMENT_COUNT
for wi in range(int(SEGMENT_COUNT * 1.5)):
dir = Vec2(
math.cos(math.radians(-i * 120 - 30 + wi * step + offset)),
math.sin(math.radians(-i * 120 - 30 + wi * step + offset)),
)
waypoints.append(center + dir * (OFFSET if i < 3 else 80))
try:
async def before_drop():
await self._snapshot(test_name)
await self._emulate_mouse_drag_and_drop_multiple_waypoints(waypoints, on_before_drop=before_drop)
if post_snap:
await ui_test.human_delay(human_delay_speed=4)
await self._snapshot(f"{test_name}.post")
finally:
await self._restore_initial_state()
################################################################
########################## test scale ##########################
################################################################
# Given the complexity of multi-manipulating with non-uniform scale and potential shear from parents,
# we reduce the test complexity using a simpler manipulating case.
# Revisit when there's more complicated scaling needs.
################## test manipulator scale axis ##################
async def test_scale_local_axis(self):
await self._setup_local(c.TRANSFORM_OP_SCALE)
self._selection.set_selected_prim_paths(["/World/Xform/Cube_01"], True)
await ui_test.human_delay()
# test scale up
await self._test_move_axis(180)
# test scale down
await self._test_move_axis(180, distance=-100)
################## test manipulator move plane ##################
async def test_scale_local_plane(self):
await self._setup_local(c.TRANSFORM_OP_SCALE)
self._selection.set_selected_prim_paths(["/World/Xform/Cube_01"], True)
await ui_test.human_delay()
# test scale up
await self._test_move_plane(180)
# test scale down
await self._test_move_plane(180, distance=-100)
################## test manipulator move center ##################
async def test_scale_local_center(self):
await self._setup_local(c.TRANSFORM_OP_SCALE)
self._selection.set_selected_prim_paths(["/World/Xform/Cube_01"], True)
await ui_test.human_delay()
await self._test_move_center()
await ui_test.human_delay()
await self._test_move_center(dirs=[Vec2(50, 0), Vec2(-100, 0)])
################################################################
################### test manipulator toolbar ###################
################################################################
async def test_toolbar(self):
await self._setup_global(c.TRANSFORM_OP_MOVE, True)
await ui_test.human_delay(30)
await ui_test.emulate_mouse_move_and_click(Vec2(210, 340), human_delay_speed=20)
# expand the toolbar and take a snapshot to make sure the render/layout is correct.
# if you changed the look of toolbar button or toolbar layout, update the golden image for this test.
# added since OM-65012 for a broken button image
await self._snapshot("visual")
# Test the local/global button
await ui_test.human_delay(30)
await ui_test.emulate_mouse_move_and_click(Vec2(215, 365), human_delay_speed=20)
self.assertEqual(self._settings.get(c.TRANSFORM_MOVE_MODE_SETTING), c.TRANSFORM_MODE_LOCAL)
await ui_test.human_delay(30)
await ui_test.emulate_mouse_move_and_click(Vec2(215, 365), human_delay_speed=20)
self.assertEqual(self._settings.get(c.TRANSFORM_MOVE_MODE_SETTING), c.TRANSFORM_MODE_GLOBAL)
################################################################
#################### test manipulator snap #####################
################################################################
async def _run_snap_test(self, keep_spacing: bool):
await self._setup_global(c.TRANSFORM_OP_MOVE, True, "test_snap.usda", ["/World/Cube", "/World/Cube_01"])
stage = self._context.get_stage()
cube_prim = stage.GetPrimAtPath("/World/Cube")
cube01_prim = stage.GetPrimAtPath("/World/Cube_01")
_, _, _, translate_cube_original = omni.usd.get_local_transform_SRT(cube_prim)
_, _, _, translate_cube01_original = omni.usd.get_local_transform_SRT(cube01_prim)
self._settings.set(prim_c.MANIPULATOR_PLACEMENT_SETTING, prim_c.MANIPULATOR_PLACEMENT_SELECTION_CENTER)
self._settings.set(snap_c.SNAP_PROVIDER_NAME_SETTING_PATH, [SURFACE_SNAP_NAME])
self._settings.set(snap_c.CONFORM_TO_TARGET_SETTING_PATH, True)
self._settings.set(snap_c.KEEP_SPACING_SETTING_PATH, keep_spacing)
self._settings.set("/app/viewport/snapEnabled", True)
center = Vec2(self._window_width, self._window_height) / 2
await ui_test.human_delay()
await ui_test.emulate_mouse_move(center, 10)
await self._emulate_mouse_drag_and_drop_multiple_waypoints(
[center, center / 1.5], human_delay_speed=1, num_steps=50
)
_, _, _, translate_cube = omni.usd.get_local_transform_SRT(cube_prim)
_, _, _, translate_cube01 = omni.usd.get_local_transform_SRT(cube01_prim)
self._settings.set("/app/viewport/snapEnabled", False)
return translate_cube, translate_cube_original, translate_cube01, translate_cube01_original
async def test_snap_keep_spacing(self):
(
translate_cube,
translate_cube_original,
translate_cube01,
translate_cube01_original,
) = await self._run_snap_test(True)
# Make sure start conditions aren't already on Plane
self.assertFalse(Gf.IsClose(translate_cube_original[1], -100, 0.02))
self.assertFalse(Gf.IsClose(translate_cube01_original[1], -100, 0.02))
# Y position should be snapped to surface at -100 Y (within a tolerance for Storm)
self.assertTrue(Gf.IsClose(translate_cube[1], -100, 0.02))
self.assertTrue(Gf.IsClose(translate_cube01[1], -100, 0.02))
# X and Z should be greater than original
self.assertTrue(translate_cube[0] > translate_cube_original[0])
self.assertTrue(translate_cube[2] > translate_cube_original[2])
# X and Z should be greater than original
self.assertTrue(translate_cube01[2] > translate_cube01_original[2])
self.assertTrue(translate_cube01[0] > translate_cube01_original[0])
# Workaround for testing on new Viewport, needs delay before running test_snap_no_keep_spacing test.
self._selection.set_selected_prim_paths([], True)
await ui_test.human_delay(10)
async def test_snap_no_keep_spacing(self):
(
translate_cube,
translate_cube_original,
translate_cube01,
translate_cube01_original,
) = await self._run_snap_test(False)
self.assertFalse(Gf.IsClose(translate_cube_original[1], -100, 0.02))
self.assertFalse(Gf.IsClose(translate_cube01_original[1], -100, 0.02))
# cube and cube01 should be at same location since keep spacing is off
self.assertTrue(Gf.IsClose(translate_cube, translate_cube01, 1e-6))
# Y position should be snapped to surface at -100 Y
self.assertTrue(Gf.IsClose(translate_cube[1], -100, 0.02))
# X and Z should be greater than original
self.assertTrue(translate_cube[0] > translate_cube_original[0])
self.assertTrue(translate_cube[2] > translate_cube_original[2])
# Workaround for testing on new Viewport, needs delay before running test_snap_no_keep_spacing test.
self._selection.set_selected_prim_paths([], True)
await ui_test.human_delay(10)
################################################################
##################### test prim with pivot #####################
################################################################
async def _test_move_axis_one_dir(self, dir: Vec2 = Vec2(0, 1), distance: float = 50):
OFFSET = 50
center = Vec2(self._window_width, self._window_height) / 2
try:
await ui_test.emulate_mouse_drag_and_drop(center + dir * OFFSET, center + dir * (OFFSET + distance))
await self._snapshot(f"{distance}")
finally:
await self._restore_initial_state()
async def test_move_local_axis_with_pivot(self):
# tests for when _should_keep_manipulator_orientation_unchanged is true
await self._setup_local(c.TRANSFORM_OP_MOVE, file_name="test_pivot.usda", prims_to_select=["/World/Cube"])
await self._test_move_axis_one_dir()
async def test_scale_local_axis_with_pivot(self):
# tests for when _should_keep_manipulator_orientation_unchanged is true
await self._setup_local(c.TRANSFORM_OP_SCALE, file_name="test_pivot.usda", prims_to_select=["/World/Cube"])
await self._test_move_axis_one_dir()
################################################################
##################### test remove xformOps #####################
################################################################
async def test_remove_xform_ops_pivot(self):
# remove the xformOps attributes, the manipulator position should update
await self._setup_local(
c.TRANSFORM_OP_MOVE, file_name="test_remove_xformOps.usda", prims_to_select=["/World/Cube"]
)
stage = self._context.get_stage()
cube_prim = stage.GetPrimAtPath("/World/Cube")
attrs_to_remove = ["xformOp:translate", "xformOp:rotateXYZ", "xformOp:scale"]
for attr in attrs_to_remove:
cube_prim.RemoveProperty(attr)
await ui_test.human_delay(10)
await self._snapshot()
async def test_remove_xform_op_order_pivot(self):
# remove the xformOpOrder attribute, the manipulator position should update
await self._setup_local(
c.TRANSFORM_OP_MOVE, file_name="test_remove_xformOps.usda", prims_to_select=["/World/Cube"]
)
stage = self._context.get_stage()
cube_prim = stage.GetPrimAtPath("/World/Cube")
cube_prim.RemoveProperty("xformOpOrder")
await ui_test.human_delay(10)
await self._snapshot()
################################################################
################### test unknown op & modes ####################
################################################################
async def test_unknown_move_mode(self):
await self._setup_global(c.TRANSFORM_OP_MOVE, prims_to_select=["/World/Xform/Cube_01"])
await self._snapshot("pre-unknown-mode")
self._settings.set(c.TRANSFORM_MOVE_MODE_SETTING, "UNKNOWN")
await self._snapshot("post-unknown-mode")
self._settings.set(c.TRANSFORM_MOVE_MODE_SETTING, c.TRANSFORM_MODE_LOCAL)
await self._snapshot("reset-known-mode")
async def test_unknown_rotate_mode(self):
await self._setup_global(c.TRANSFORM_OP_ROTATE, prims_to_select=["/World/Xform/Cube_01"])
await self._snapshot("pre-unknown-mode")
self._settings.set(c.TRANSFORM_ROTATE_MODE_SETTING, "UNKNOWN")
await self._snapshot("post-unknown-mode")
self._settings.set(c.TRANSFORM_ROTATE_MODE_SETTING, c.TRANSFORM_MODE_LOCAL)
await self._snapshot("reset-known-mode")
async def test_unknown_mode_enabled(self):
await self._setup_global(c.TRANSFORM_OP_MOVE, prims_to_select=[])
await self._snapshot("known-mode-unselected")
self._settings.set(c.TRANSFORM_MOVE_MODE_SETTING, "UNKNOWN")
await self._snapshot("unknown-mode-unselected")
self._selection.set_selected_prim_paths(["/World/Xform/Cube_01"], True)
await self._snapshot("unknown-mode-selected")
self._settings.set(c.TRANSFORM_MOVE_MODE_SETTING, c.TRANSFORM_MODE_GLOBAL)
await self._snapshot("known-mode-selected")
async def test_unknown_op_enabled(self):
await self._setup_global(c.TRANSFORM_OP_MOVE, prims_to_select=[])
await self._snapshot("move-op-unselected")
self._settings.set(c.TRANSFORM_OP_SETTING, "UNKNOWN")
await self._snapshot("unknown-op-selected")
self._selection.set_selected_prim_paths(["/World/Xform/Cube_01"], True)
await self._snapshot("unknown-op-selected")
self._settings.set(c.TRANSFORM_OP_SETTING, c.TRANSFORM_OP_ROTATE)
await self._snapshot("rotate-op-selected")
| 29,723 | Python | 42.711765 | 134 | 0.600949 |
omniverse-code/kit/exts/omni.hydra.pxr/omni/hydra/pxr/engine/tests/__init__.py | from .render_test import *
| 27 | Python | 12.999994 | 26 | 0.740741 |
omniverse-code/kit/exts/omni.hydra.pxr/omni/hydra/pxr/engine/tests/render_test.py |
import omni.kit.test
import omni.usd
import carb
from omni.kit.viewport.utility.tests import capture_viewport_and_compare
from omni.kit.test.teamcity import is_running_in_teamcity
import sys
import unittest
from pathlib import Path
EXTENSION_ROOT = Path(carb.tokens.get_tokens_interface().resolve("${omni.hydra.pxr}")).resolve().absolute()
TESTS_ROOT = EXTENSION_ROOT.joinpath("data", "tests")
USD_SCENES = TESTS_ROOT.joinpath("usd")
GOLDEN_IMAGES = TESTS_ROOT.joinpath("images")
OUTPUTS_DIR = Path(omni.kit.test.get_test_output_path())
class HydraTextureTest(omni.kit.test.AsyncTestCase):
async def setUp(self):
self.usd_context = omni.usd.get_context()
await self.usd_context.new_stage_async()
async def tearDown(self):
await self.usd_context.new_stage_async()
async def run_imge_test(self, usd_file: str, image_name: str, fn = None, wait_iterations: int = 5, threshold: int = 10):
await self.usd_context.open_stage_async(str(USD_SCENES.joinpath(usd_file)))
app = omni.kit.app.get_app()
for i in range(wait_iterations):
await app.next_update_async()
if fn:
fn()
for i in range(wait_iterations):
await app.next_update_async()
passed, fail_msg = await capture_viewport_and_compare(image_name, threshold=threshold, output_img_dir=OUTPUTS_DIR, golden_img_dir=GOLDEN_IMAGES)
self.assertTrue(passed, msg=fail_msg)
@unittest.skipIf(is_running_in_teamcity() and sys.platform.startswith("linux"), "OM-84020")
async def test_render_cube(self):
"""Test rendering produces an image"""
await self.run_imge_test('cube.usda', 'render_cube.png')
@unittest.skipIf(is_running_in_teamcity() and sys.platform.startswith("linux"), "OM-84020")
async def test_render_cubes(self):
"""Test rendering produces an image after re-open"""
await self.run_imge_test('cubes.usda', 'render_cubes.png')
@unittest.skipIf(is_running_in_teamcity() and sys.platform.startswith("linux"), "OM-84020")
async def test_select_cube_x(self):
"""Test selection on cube_x hilights correct prim"""
await self.run_imge_test('cubes.usda', 'select_cube_x.png',
lambda: self.usd_context.get_selection().set_selected_prim_paths(['/World/cube_x'], True)
)
@unittest.skipIf(is_running_in_teamcity() and sys.platform.startswith("linux"), "OM-84020")
async def test_select_cube_y(self):
"""Test selection on cube_y hilights correct prim"""
await self.run_imge_test('cubes.usda', 'select_cube_y.png',
lambda: self.usd_context.get_selection().set_selected_prim_paths(['/World/cube_y'], True)
)
@unittest.skipIf(is_running_in_teamcity() and sys.platform.startswith("linux"), "OM-84020")
async def test_select_cube_z(self):
"""Test selection on cube_z hilights correct prim"""
await self.run_imge_test('cubes.usda', 'select_cube_z.png',
lambda: self.usd_context.get_selection().set_selected_prim_paths(['/World/cube_z'], True)
)
@unittest.skipIf(is_running_in_teamcity() and sys.platform.startswith("linux"), "OM-84020")
async def test_display_purpose(self):
"""Test the carb display purpose settings"""
def set_puposes(guide: bool, proxy: bool, render: bool):
settings = carb.settings.get_settings()
settings.set('/persistent/app/hydra/displayPurpose/guide', guide)
settings.set('/persistent/app/hydra/displayPurpose/proxy', proxy)
settings.set('/persistent/app/hydra/displayPurpose/render', render)
try:
# Test, guide, proxy, and render purposes render by default
await self.run_imge_test('purpose.usda', 'all_purposes.png')
# Test with proxy purpose disabled
set_puposes(False, True, True)
await self.run_imge_test('purpose.usda', 'proxy_purposes.png')
# Test with guide purpose disabled
set_puposes(True, False, True)
await self.run_imge_test('purpose.usda', 'guide_purposes.png')
# Test with render purpose disabled
set_puposes(True, True, False)
await self.run_imge_test('purpose.usda', 'render_purposes.png')
finally:
set_puposes(True, True, True)
# Run the all purpose test once more now that all have been re-enabled
await self.run_imge_test('purpose.usda', 'all_purposes.png')
@unittest.skipIf(is_running_in_teamcity() and sys.platform.startswith("linux"), "OM-84020")
async def test_rtx_render_modes(self):
"""Test some RTX render settings are honored"""
settings = carb.settings.get_settings()
settings.set("/rtx/debugMaterialType", -1)
settings.set("/rtx/wireframe/mode", 0)
try:
# Test, guide, proxy, and render purposes render by default
await self.run_imge_test('render_modes.usda', 'render_modes_default.png')
settings.set("/rtx/debugMaterialType", 0)
await self.run_imge_test('render_modes.usda', 'render_modes_no_material.png')
# Tests below create images that are outside a meaningful range/image test on Windows with Vulkan
# Since they are highly specific test of wireframe rendering, just skip them in that case
import sys
if sys.platform.startswith('win') and ("--vulkan" in sys.argv):
return
settings.set("/rtx/wireframe/mode", 2)
await self.run_imge_test('render_modes.usda', 'render_modes_no_material_wire.png')
settings.set("/rtx/debugMaterialType", -1)
await self.run_imge_test('render_modes.usda', 'render_modes_wire_material.png')
finally:
settings.set("/rtx/debugMaterialType", -1)
settings.set("/rtx/wireframe/mode", 0)
| 5,984 | Python | 43.333333 | 152 | 0.642714 |
omniverse-code/kit/exts/omni.kit.window.reshade_editor/omni/kit/window/reshade_editor/reshade_window.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.
import omni.ui as ui
import rtx.reshade
from typing import Callable
reshade = rtx.reshade.acquire_reshade_interface()
class ComboListItem(ui.AbstractItem):
def __init__(self, text):
super().__init__()
self.model = ui.SimpleStringModel(text)
class ComboListModel(ui.AbstractItemModel):
def __init__(self, parent_model, items):
super().__init__()
self._current_index = parent_model
self._current_index.add_value_changed_fn(lambda a: self._item_changed(None))
self._items = [ComboListItem(item) for item in items]
def get_item_children(self, item):
return self._items
def get_item_value_model(self, item, column_id):
if item is None:
return self._current_index
return item.model
class ReshadeUniformValue(ui.AbstractItem, ui.AbstractValueModel):
def __init__(self, handle, component: int, reshade_ctx):
ui.AbstractItem.__init__(self)
ui.AbstractValueModel.__init__(self)
self._handle = handle
self._component = component
self._reshade_ctx = reshade_ctx
def get_value_as_int(self) -> int:
return reshade.get_uniform_value_as_int(self._reshade_ctx, self._handle, self._component)
def get_value_as_bool(self) -> bool:
return reshade.get_uniform_value_as_bool(self._reshade_ctx, self._handle, self._component)
def get_value_as_float(self) -> float:
return reshade.get_uniform_value_as_float(self._reshade_ctx, self._handle, self._component)
def set_value(self, value):
if isinstance(value, int):
reshade.set_uniform_value_as_int(self._reshade_ctx, self._handle, self._component, value)
else:
reshade.set_uniform_value_as_float(self._reshade_ctx, self._handle, self._component, float(value))
self._value_changed()
class ReshadeUniformVectorValue(ui.AbstractItemModel):
def __init__(self, handle, component_count: int, reshade_ctx):
super().__init__()
self._items = [ ReshadeUniformValue(handle, component, reshade_ctx) for component in range(component_count) ]
for item in self._items:
item.add_value_changed_fn(lambda a, item=item: self._item_changed(item))
def get_item_children(self, item):
return self._items
def get_item_value_model(self, item, column_id):
return item
def begin_edit(self, item):
pass # Crashes without this
def end_edit(self, item):
pass # Crashes without this
class ReshadeUniformItem(ui.AbstractItem):
def __init__(self, handle, reshade_ctx):
super().__init__()
type_info = reshade.get_uniform_type(handle)
self._name = reshade.get_uniform_name(handle)
self._base_type = type_info[0]
self._components = type_info[1]
self._ui_type = reshade.get_uniform_annotation_as_string(handle, "ui_type")
self._ui_label = reshade.get_uniform_annotation_as_string(handle, "ui_label")
self._ui_tooltip = reshade.get_uniform_annotation_as_string(handle, "ui_tooltip")
ui_min = reshade.get_uniform_annotation_as_float(handle, "ui_min")
ui_max = reshade.get_uniform_annotation_as_float(handle, "ui_max")
if (ui_min == ui_max):
self._ui_min = 0
self._ui_max = 1
else:
self._ui_min = ui_min
self._ui_max = ui_max
self._ui_step = reshade.get_uniform_annotation_as_float(handle, "ui_step")
ui_items = reshade.get_uniform_annotation_as_string(handle, "ui_items")
self._ui_items = ui_items.split(';') if ui_items else []
if self._ui_items and not self._ui_items[-1]: # Delete last item if empty
del self._ui_items[-1]
self.model = ReshadeUniformValue(handle, 0, reshade_ctx) if self._components == 1 else ReshadeUniformVectorValue(handle, self._components, reshade_ctx)
class ReshadeEffectListItem(ui.AbstractItem):
def __init__(self, effect, reshade_ctx):
super().__init__()
self._name = reshade.get_effect_name(effect)
self._uniforms = []
for handle in reshade.get_uniform_list(reshade_ctx, effect):
if reshade.get_uniform_annotation_as_string(handle, "source"):
continue # Skip uniforms that have a custom source
self._uniforms.append(ReshadeUniformItem(handle, reshade_ctx))
class ReshadeVariableEditorModel(ui.AbstractItemModel):
def __init__(self, reshade_ctx):
super().__init__()
self._effects = []
for handle in reshade.get_effect_list(reshade_ctx):
effect = ReshadeEffectListItem(handle, reshade_ctx)
if not effect._uniforms:
continue # Skip effects that have not configurable uniforms
self._effects.append(effect)
def get_item_children(self, item):
if item is None:
return self._effects
elif isinstance(item, ReshadeEffectListItem):
return item._uniforms
def get_item_value_model(self, item, column_id):
if item is None:
return None
else:
return item.model
def get_item_value_model_count(self, item):
return 1
class ReshadeVariableEditorDelegate(ui.AbstractItemDelegate):
def build_branch(self, model, item, column_id, level, expanded):
with ui.HStack(width=20*level, height=0):
if level == 0:
triangle_alignment = ui.Alignment.RIGHT_CENTER
if expanded:
triangle_alignment = ui.Alignment.CENTER_BOTTOM
ui.Spacer(width=3)
ui.Triangle(alignment=triangle_alignment, width=10, height=10, style={"background_color": 0xFFFFFFFF})
ui.Spacer(width=7)
else:
ui.Spacer()
def build_widget(self, model, item, column_id, level, expanded):
with ui.VStack():
ui.Spacer(height=2.5)
if level == 1: # Effect list level
ui.Label(item._name)
else: # Uniform list level
with ui.HStack(width=500, spacing=5):
if item._base_type == 1:
self.create_bool_widget(item)
elif item._base_type >= 2 and item._base_type <= 5:
self.create_int_widget(item)
elif item._base_type >= 6 and item._base_type <= 7:
self.create_float_widget(item)
else:
return
label = ui.Label(item._ui_label if item._ui_label else item._name)
if item._ui_tooltip:
label.set_tooltip(item._ui_tooltip)
ui.Spacer(height=2.5)
def create_bool_widget(self, uniform):
if uniform._components != 1:
return
if uniform._ui_type == "combo":
return ui.ComboBox(ComboListModel(uniform.model, ["False", "True"]))
else:
return ui.CheckBox(uniform.model)
def create_int_widget(self, uniform):
if uniform._components == 1:
return self.create_int_widget_scalar(uniform)
else:
return self.create_int_widget_vector(uniform)
def create_int_widget_scalar(self, uniform):
if uniform._ui_type == "combo" or uniform._ui_type == "list" or uniform._ui_type == "radio":
return ui.ComboBox(ComboListModel(uniform.model, uniform._ui_items))
if uniform._ui_type == "slider":
return ui.IntSlider(uniform.model, min=int(uniform._ui_min), max=int(uniform._ui_max), step=int(uniform._ui_step))
elif uniform._ui_type == "drag":
return ui.IntDrag(uniform.model, min=int(uniform._ui_min), max=int(uniform._ui_max))
else:
return ui.IntField(uniform.model)
def create_int_widget_vector(self, uniform):
if uniform._ui_type == "drag":
return ui.MultiIntDragField(uniform.model, min=int(uniform._ui_min), max=int(uniform._ui_max), h_spacing=2)
else:
return ui.MultiIntField(uniform.model, h_spacing=2)
def create_float_widget(self, uniform):
if uniform._components == 1:
return self.create_float_widget_scalar(uniform)
else:
return self.create_float_widget_vector(uniform)
def create_float_widget_scalar(self, uniform):
if uniform._ui_type == "slider":
return ui.FloatSlider(uniform.model, min=float(uniform._ui_min), max=float(uniform._ui_max), step=float(uniform._ui_step))
elif uniform._ui_type == "drag":
return ui.FloatDrag(uniform.model, min=float(uniform._ui_min), max=float(uniform._ui_max))
else:
return ui.FloatField(uniform.model)
def create_float_widget_vector(self, uniform):
if uniform._ui_type == "drag":
return ui.MultiFloatDragField(uniform.model, min=float(uniform._ui_min), max=float(uniform._ui_max), h_spacing=2)
elif uniform._ui_type == "color":
with ui.HStack(spacing=2):
widget = ui.MultiFloatDragField(uniform.model, min=float(uniform._ui_min), max=float(uniform._ui_max), h_spacing=2)
ui.ColorWidget(uniform.model, width=0, height=0)
return widget
else:
return ui.MultiFloatField(uniform.model, h_spacing=2)
class ReshadeTechniqueModel(ui.AbstractValueModel):
def __init__(self, handle, reshade_ctx):
super().__init__()
self._handle = handle
self._reshade_ctx = reshade_ctx
def get_value_as_bool(self) -> bool:
return reshade.get_technique_enabled(self._reshade_ctx, self._handle)
def set_value(self, value: bool):
reshade.set_technique_enabled(self._reshade_ctx, self._handle, value)
self._value_changed()
class ReshadeTechniqueListItem(ui.AbstractItem):
def __init__(self, handle, reshade_ctx):
super().__init__()
self._name = reshade.get_technique_name(handle)
self._ui_label = reshade.get_technique_annotation_as_string(handle, "ui_label")
self._ui_tooltip = reshade.get_technique_annotation_as_string(handle, "ui_tooltip")
self.model = ReshadeTechniqueModel(handle, reshade_ctx)
class ReshadeTechniqueEditorModel(ui.AbstractItemModel):
def __init__(self, reshade_ctx):
super().__init__()
self._techniques = [ ReshadeTechniqueListItem(handle, reshade_ctx) for handle in reshade.get_technique_list(reshade_ctx) ]
def get_item_children(self, item):
if item is not None:
return []
return self._techniques
def get_item_value_model(self, item, column_id):
if item is None:
return None
return item.model
def get_item_value_model_count(self, item):
return 1
class ReshadeTechniqueEditorDelegate(ui.AbstractItemDelegate):
def build_branch(self, model, item, column_id, level, expanded):
pass
def build_widget(self, model, item, column_id, level, expanded):
with ui.VStack():
ui.Spacer(height=2.5)
with ui.HStack(width=0, height=0, spacing=5):
ui.CheckBox(item.model)
label = ui.Label(item._ui_label if item._ui_label else item._name)
if item._ui_tooltip:
label.set_tooltip(item._ui_tooltip)
ui.Spacer(height=2.5)
class ReshadeWindow:
def __init__(self, on_visibility_changed_fn: Callable):
self._window = ui.Window("ReShade", width=500, height=500)
self._window.set_visibility_changed_fn(on_visibility_changed_fn)
self._reshade_ctx = None
try:
from omni.kit.viewport.utility import get_active_viewport
viewport = get_active_viewport()
self._reshade_ctx = reshade.get_context(viewport.usd_context_name)
except (ImportError, AttributeError):
pass
if self._reshade_ctx is None:
with self._window.frame:
with ui.VStack():
ui.Spacer()
ui.Label("ReShade context not available", alignment=ui.Alignment.CENTER, style={"font_size": 48})
ui.Spacer()
import carb
carb.log_error(f"ReShade context not available for Viewport {viewport}")
return
self._update_sub = reshade.subscribe_to_update_events(self._reshade_ctx, self._on_update)
self._build_ui()
def destroy(self):
self._window = None
self._update_sub = None
def _build_ui(self):
reshade_ctx = self._reshade_ctx
self._tmodel = ReshadeTechniqueEditorModel(reshade_ctx)
self._tdelegate = ReshadeTechniqueEditorDelegate()
self._vmodel = ReshadeVariableEditorModel(reshade_ctx)
self._vdelegate = ReshadeVariableEditorDelegate()
with self._window.frame:
with ui.VStack(height=0, spacing=5):
self._tview = ui.TreeView(
self._tmodel,
delegate=self._tdelegate,
root_visible=False,
header_visible=False)
ui.Line()
self._vview = ui.TreeView(
self._vmodel,
delegate=self._vdelegate,
root_visible=False,
header_visible=False,
expand_on_branch_click=True)
def _on_update(self):
self._build_ui()
| 13,948 | Python | 38.854286 | 159 | 0.610984 |
omniverse-code/kit/exts/omni.kit.window.reshade_editor/omni/kit/window/reshade_editor/extension.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.
import omni.ext
import omni.kit.ui
from .reshade_window import ReshadeWindow
MENU_PATH = "Window/ReShade Editor"
class ReshadeWindowExtension(omni.ext.IExt):
def on_startup(self):
self._window = None
try:
self._menu = omni.kit.ui.get_editor_menu().add_item(
MENU_PATH, lambda m, v: self.show_window(v), toggle=True, value=False
)
except:
pass
def on_shutdown(self):
self._menu = None
def show_window(self, value):
if value:
def on_visibility_changed(visible):
omni.kit.ui.get_editor_menu().set_value(MENU_PATH, visible)
self._window = ReshadeWindow(on_visibility_changed if self._menu else None)
else:
if self._window:
self._window.destroy()
self._window = None
| 1,291 | Python | 32.128204 | 87 | 0.654531 |
omniverse-code/kit/exts/omni.kit.window.reshade_editor/omni/kit/window/reshade_editor/__init__.py | from .extension import ReshadeWindowExtension
| 46 | Python | 22.499989 | 45 | 0.891304 |
omniverse-code/kit/exts/omni.kit.window.reshade_editor/omni/kit/window/reshade_editor/tests/__init__.py | from .test_extension import *
| 30 | Python | 14.499993 | 29 | 0.766667 |
omniverse-code/kit/exts/omni.kit.window.reshade_editor/omni/kit/window/reshade_editor/tests/test_extension.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.
import omni.kit.test
import pathlib
import carb
import omni.usd
import omni.kit.app
from omni.kit.test import AsyncTestCase
from omni.kit.window.reshade_editor.reshade_window import ReshadeWindow
EXTENSION_FOLDER_PATH = pathlib.Path(omni.kit.app.get_app().get_extension_manager().get_extension_path_by_module(__name__))
TESTS_PATH = EXTENSION_FOLDER_PATH.joinpath("data/tests")
class TestReshadeEditor(AsyncTestCase):
async def setUp(self):
super().setUp()
await omni.usd.get_context().new_stage_async()
settings = carb.settings.get_settings()
settings.set("/rtx/reshade/enable", "true")
settings.set("/rtx/reshade/presetFilePath", f"{TESTS_PATH}/preset.ini")
settings.set("/rtx/reshade/effectSearchDirPath", f"{TESTS_PATH}")
# Update app a few times for effects to load and compile
for i in range(20):
await omni.kit.app.get_app().next_update_async()
async def test_variable_list(self):
w = ReshadeWindow(None)
self.assertIsNotNone(w._window)
effects = w._vmodel.get_item_children(None)
self.assertIsNotNone(effects)
self.assertTrue(len(effects) == 1) # data/tests/simple.fx
variables = w._vmodel.get_item_children(effects[0])
self.assertIsNotNone(effects)
self.assertTrue(len(variables) == 1) # "fill_color" in data/tests/simple.fx
async def test_technique_list(self):
w = ReshadeWindow(None)
self.assertIsNotNone(w._window)
techniques = w._tmodel.get_item_children(None)
self.assertIsNotNone(techniques)
self.assertTrue(len(techniques) == 1) # technique "simple" in data/tests/simple.fx
| 2,119 | Python | 40.568627 | 123 | 0.706937 |
omniverse-code/kit/exts/omni.kit.hotkeys.window/omni/kit/hotkeys/window/style.py | __all__ = ["HOTKEYS_WINDOW_STYLE", "FILTER_WINDOW_STYLE", "WARNING_WINDOW_STYLE", "WINDOW_PICK_STYLE", "CONTEXT_MENU_STYLE"]
from pathlib import Path
import omni.ui as ui
from omni.ui import color as cl
# OM-63810: Happens in Create only which has different font from Kit.
# Must set height to big enough for Add Actions button
VIEW_ROW_HEIGHT = 28
CURRENT_PATH = Path(__file__).parent.absolute()
ICON_PATH = CURRENT_PATH.parent.parent.parent.parent.joinpath("data").joinpath("icons")
"""Style colors"""
# https://confluence.nvidia.com/pages/viewpage.action?pageId=1218553472&preview=/1218553472/1359943485/image2022-6-7_13-20-4.png
cl.hotkey_edit_icon = cl.shade(cl('#9E9E9E'))
cl.hotkey_hint = cl.shade(cl('#5A5A5A'))
cl.hotkey_warning = cl.shade(cl('#DFCB4A'))
cl.hotkey_text_active = cl.shade(cl('#CCCCCC'))
cl.hotkey_text_user = cl.shade(cl('#F2F2F2'))
HOTKEYS_WINDOW_STYLE = {
"TreeView.Item:selected": {"color": 0xFF8A8777},
"ActionsView.Window.Text": {"color": cl.actions_text, "margin": 4},
"ActionsView.Item.Text::warning": {"color": cl.hotkey_warning},
"Button.Background": {"background_color": 0x0},
"Button::add": {"background_color": cl.actions_background, "stack_direction": ui.Direction.LEFT_TO_RIGHT, "border_radius": 4},
"Button::add:hovered": {"background_color": cl.actions_background_hovered},
"Button.Label::add": {"alignment": ui.Alignment.LEFT, "color": cl.actions_text},
"Button.Image::add": {"image_url": f"{ICON_PATH}/add.svg", "color": 0xFF5E6C5F, "alignment": ui.Alignment.LEFT},
"ComboBox": {
"color": cl.actions_text,
"secondary_color": cl.actions_background,
"border_radius": 4,
"margin": 1
},
"Image": {"border_radius": 4},
"Field": {"border_radius": 4, "margin": 1},
"Image::delete": {"image_url": f"{ICON_PATH}/delete.svg", "color": cl.hotkey_edit_icon},
"Image::edit": {"image_url": f"{ICON_PATH}/edit.svg", "color": cl.hotkey_edit_icon},
"Image::cancel": {"image_url": f"{ICON_PATH}/cancel.svg", "color": cl.hotkey_edit_icon},
"Image::save": {"image_url": f"{ICON_PATH}/save.svg", "color": cl.hotkey_edit_icon},
"Image::remove": {"image_url": f"{ICON_PATH}/remove.svg", "margin": 4},
"Image::remove:hovered": {"image_url": f"{ICON_PATH}/remove-hovered.svg"},
"DropDownArrow.background": {"border_radius": 4, "background_color": cl.actions_background, "margin_height": 1.5},
"DropDownArrow": {"background_color": cl.hotkey_edit_icon, "margin": 4, "border_radius": 4},
"Action.Input": {"color": cl.actions_text, "margin": 4},
"Action.Input::hint": {"color": cl.hotkey_hint},
"TriggerPressOption": {
"background_color": 0x0,
"margin_width": 2,
"padding": 1,
"stack_direction": ui.Direction.LEFT_TO_RIGHT,
"spacing": 10
},
"TriggerPressOption.Label": {
"alignment": ui.Alignment.LEFT,
},
"TriggerPressOption.Image": {
"image_url": f"{ICON_PATH}/radio_off.svg",
},
"TriggerPressOption.Image:checked": {
"image_url": f"{ICON_PATH}/radio_on.svg"
},
"TriggerPressOption.Background": {"background_color": 0x0},
"TriggerPressOption.Background:hovered": {"background_color": cl.hotkey_background_hovered},
"ResetButton.Invalid": {"background_color": 0xFF505050, "border_radius": 2},
"ResetButton": {"background_color": 0xFFA07D4F, "border_radius": 2},
"SearchBar.Filter": {
"image_url": f"{ICON_PATH}/filter.svg",
"margin": 4,
},
"SearchBar.Options": {
"image_url": f"{ICON_PATH}/settings.svg",
"color": cl.hotkey_edit_icon,
"margin": 5,
},
}
FILTER_WINDOW_STYLE = {
"Window": {"padding": 0, "margin": 0},
"Titlebar.Background": {"background_color": cl.actions_background},
"Titlebar.Title": {"color": cl.actions_text},
"Titlebar.Reset": {"background_color": 0},
"Titlebar.Reset.Label": {"color": 0xFFB0703B},
"CheckBox": {"background_color": cl.actions_text, "color": cl.actions_background},
"FilterFlag.Text": {"color": cl.actions_text},
}
WARNING_WINDOW_STYLE = {
"Window": {"secondary_background_color": 0x0},
"Titlebar.Background": {"background_color": cl.actions_background},
"Titlebar.Title": {"color": cl.actions_text},
"Titlebar.Image": {"image_url": f"{ICON_PATH}/warning.svg"},
"Warning.Text": {"color": cl.actions_text},
"Warning.Text::highlight": {"color": cl.hotkey_text_active},
"Warning.Button": {"background_color": cl.actions_background},
"Warning.Button.Label": {"color": cl.hotkey_text_active},
}
WINDOW_PICK_STYLE = {
"TreeView.Item": {
"color": cl.actions_text, "margin": 4
},
"TreeView.Item:selected": {
"color": cl.actions_background
},
}
CONTEXT_MENU_STYLE = {
"MenuItem": {"color": cl.actions_text},
}
HIGHLIGHT_LABEL_STYLE = {
"HStack": {"margin": 4},
"Label": {"color": cl.actions_text},
"Label:selected": {"color": cl.actions_background},
}
HIGHLIGHT_LABEL_STYLE_USER = {
"HStack": {"margin": 4},
"Label": {"color": cl.hotkey_text_user},
"Label:selected": {"color": cl.actions_background},
}
| 5,170 | Python | 39.085271 | 130 | 0.635783 |
omniverse-code/kit/exts/omni.kit.hotkeys.window/omni/kit/hotkeys/window/extension.py | # pylint: disable=attribute-defined-outside-init
__all__ = ["HotkeysExtension"]
from functools import partial
import carb.settings
import omni.ext
import omni.ui as ui
import omni.kit.ui
from .window.hotkeys_window import HotkeysWindow
SETTING_SHOW_STARTUP = "/exts/omni.kit.hotkeys.window/showStartup"
class HotkeysExtension(omni.ext.IExt):
WINDOW_NAME = "Hotkeys"
MENU_PATH = f"Window/{WINDOW_NAME}"
def on_startup(self):
self._window = None
ui.Workspace.set_show_window_fn(
HotkeysExtension.WINDOW_NAME,
partial(self.show_window, HotkeysExtension.MENU_PATH),
)
show_startup = carb.settings.get_settings().get(SETTING_SHOW_STARTUP)
editor_menu = omni.kit.ui.get_editor_menu()
if editor_menu:
self._menu = editor_menu.add_item(HotkeysExtension.MENU_PATH, self.show_window, toggle=True, value=show_startup)
if show_startup:
ui.Workspace.show_window(HotkeysExtension.WINDOW_NAME)
def on_shutdown(self):
ui.Workspace.set_show_window_fn(HotkeysExtension.WINDOW_NAME, None)
if self._window:
self._window.destroy()
self._window = None
def show_window(self, menu_path: str, visible: bool):
if visible:
self._window = HotkeysWindow(HotkeysExtension.WINDOW_NAME)
self._window.set_visibility_changed_fn(self._visiblity_changed_fn)
elif self._window:
self._window.visible = False
def _set_menu(self, checked: bool):
"""Set the menu to create this window on and off"""
editor_menu = omni.kit.ui.get_editor_menu()
if editor_menu:
editor_menu.set_value(HotkeysExtension.MENU_PATH, checked)
def _visiblity_changed_fn(self, visible):
self._set_menu(visible)
if self._window and not visible:
self._window.stop_key_capture()
| 1,908 | Python | 32.491228 | 124 | 0.653564 |
omniverse-code/kit/exts/omni.kit.hotkeys.window/omni/kit/hotkeys/window/view/hotkeys_view.py | # pylint: disable=relative-beyond-top-level
__all__ = ["HotkeysView"]
import asyncio
from omni.kit.actions.window import ActionsView
import omni.ui as ui
import omni.kit.app
from ..model.hotkeys_model import HotkeysModel
from .hotkeys_delegate import HotkeysDelegate
class HotkeysView(ActionsView):
def __init__(self, model: HotkeysModel, delegate: HotkeysDelegate):
self.__delegate = delegate
super().__init__(model, delegate)
self.model.add_item_changed_fn(self.__model_changed)
self.set_selection_changed_fn(self.__delegate.on_selection_changed)
self.set_hover_changed_fn(self.__delegate.on_hover_changed)
def __model_changed(self, model: HotkeysModel, item: ui.AbstractItem):
if model.next_select_hotkey:
# Select expect item
async def __force_select_hotkey_async(select_hotkey):
await omni.kit.app.get_app().next_update_async()
for ext_item in self.model.get_item_children(None):
for hotkey_item in self.model.get_item_children(ext_item):
if hotkey_item.hotkey == select_hotkey:
self.set_expanded(ext_item, True, True)
self.selection = [hotkey_item] # pylint: disable=attribute-defined-outside-init
return
(saved_select_hotkey, model.next_select_hotkey) = (model.next_select_hotkey, None)
asyncio.ensure_future(__force_select_hotkey_async(saved_select_hotkey))
if model.search_done:
# Auto expand on searching
async def __force_expand_async():
await omni.kit.app.get_app().next_update_async()
self.set_expanded(None, True, True)
model.search_done = False
asyncio.ensure_future(__force_expand_async())
| 1,870 | Python | 42.511627 | 108 | 0.62246 |
omniverse-code/kit/exts/omni.kit.hotkeys.window/omni/kit/hotkeys/window/view/hotkeys_delegate.py | # pylint: disable=relative-beyond-top-level
__all__ = ["HotkeysDelegate"]
from typing import List
from omni.kit.actions.window import ActionsDelegate, AbstractColumnDelegate
import omni.ui as ui
from ..model.hotkey_item import EmptyFilterWindowItem, AddWindowItem, ActionExtItem
from ..style import VIEW_ROW_HEIGHT
class HotkeysDelegate(ActionsDelegate):
def build_branch(
self,
model: ui.AbstractItemModel,
item: ui.AbstractItem,
column_id: int = 0,
level: int = 0,
expanded: bool = False
):
if isinstance(item, AddWindowItem):
return
if isinstance(item, EmptyFilterWindowItem):
return
if model.can_item_have_children(item):
super().build_branch(model, item, column_id, level, expanded)
else:
if column_id == 0 and isinstance(item, ActionExtItem):
# Show background rectangle here when no sub hotkeys found for search/filter
# Otherwise here will be blank but name with background next
with ui.VStack(height=VIEW_ROW_HEIGHT):
ui.Spacer()
ui.Rectangle(width=20, height=26, style_type_name_override="ActionsView.Row.Background")
ui.Spacer()
else:
super().build_branch(model, item, column_id, level, expanded)
def on_mouse_double_click(self, button: int, item: ui.AbstractItem, column_delegate: AbstractColumnDelegate):
# No execute when double click
pass
def on_mouse_pressed(self, button: int, item: ui.AbstractItem, column_delegate: AbstractColumnDelegate):
# No context menu
pass
def on_selection_changed(self, selections: List[ui.AbstractItem]):
for i in range(self._column_registry.max_column_id + 1):
delegate = self._column_registry.get_delegate(i)
if delegate and hasattr(delegate, "on_selection_changed"):
delegate.on_selection_changed(selections)
def on_hover_changed(self, item, hovered) -> None:
for i in range(self._column_registry.max_column_id + 1):
delegate = self._column_registry.get_delegate(i)
if delegate and hasattr(delegate, "on_hover_changed"):
delegate.on_hover_changed(item, hovered)
| 2,333 | Python | 39.947368 | 113 | 0.638234 |
omniverse-code/kit/exts/omni.kit.hotkeys.window/omni/kit/hotkeys/window/window/warning_window.py | # pylint: disable=relative-beyond-top-level, attribute-defined-outside-init
__all__ = ["WarningMessage", "WarningWindow"]
from dataclasses import dataclass
from typing import List, Tuple, Callable, Union, Optional
import omni.ui as ui
from ..style import WARNING_WINDOW_STYLE
@dataclass
class WarningMessage:
message: str
highlight: bool = False
class WarningWindow(ui.Window):
r"""
Window Show warning message.
Args:
title (str): Warning title.
messages (List[Union[str, WarningMessage]]): Message list. Use a single '\n' for a new line.
buttons (List[Tuple[str, Callable[[None], None]]): Button list. Default 'OK' to close.
width (ui.Length): Window width. Default 360 pixels.
button_width (ui.Length): Width of a single button. Default 60 pixels.
visible (bool): Visible after created. Default True.
"""
PADDING = 4
def __init__(
self,
title: str,
messages: Optional[List[Union[str, WarningMessage]]] = None,
buttons: Optional[List[Tuple[str, Callable[[None], None]]]] = None,
width: ui.Length = 360,
button_width=60,
visible=True
):
self.__title = title
self.__messages = messages if messages else []
self.__buttons = buttons if buttons else []
self.__button_width = button_width
self.__width = width
flags = ui.WINDOW_FLAGS_NO_TITLE_BAR | ui.WINDOW_FLAGS_NO_RESIZE | ui.WINDOW_FLAGS_NO_MOVE | ui.WINDOW_FLAGS_MODAL
super().__init__(f"###Hotkey_WARNING_{title}", width=width, visible=visible, flags=flags, auto_resize=True, padding_x=0, padding_y=0)
self.frame.set_style(WARNING_WINDOW_STYLE)
self.frame.set_build_fn(self.__build_ui)
def __del__(self):
self.destroy()
def __build_ui(self):
with self.frame:
with ui.VStack(width=self.__width, height=0):
self._build_titlebar()
ui.Spacer(height=15)
self._build_message()
ui.Spacer(height=15)
self._build_buttons()
ui.Spacer(height=15)
def _build_titlebar(self):
with ui.ZStack(height=0):
ui.Rectangle(style_tyle_name_override="Titlebar.Background")
with ui.VStack():
ui.Spacer(height=self.PADDING)
with ui.HStack():
ui.Spacer(width=self.PADDING)
ui.Image(width=16, style_type_name_override="Titlebar.Image")
ui.Spacer(width=8)
ui.Label(self.__title, width=0, style_tyle_name_override="Titlebar.Title")
ui.Spacer(width=self.PADDING)
ui.Spacer(height=self.PADDING)
def _build_message(self):
message_lines = []
message_lines.append([])
for message in self.__messages:
if isinstance(message, str):
if message == "\n":
message_lines.append([])
message_lines[len(message_lines) - 1].append(WarningMessage(message))
elif isinstance(message, WarningMessage):
message_lines[len(message_lines) - 1].append(message)
with ui.VStack(spacing=6, height=0):
for messages in message_lines:
with ui.HStack():
ui.Spacer(width=self.PADDING)
ui.Spacer()
for message in messages:
ui.Label(
message.message,
width=0,
alignment=ui.Alignment.CENTER,
style_type_name_override="Warning.Text",
name="highlight" if message.highlight else ""
)
ui.Spacer()
ui.Spacer(width=self.PADDING)
def _build_buttons(self):
if self.__buttons:
with ui.HStack():
ui.Spacer()
for index, button in enumerate(self.__buttons):
if index > 0:
ui.Spacer(width=20)
ui.Button(button[0], width=self.__button_width, clicked_fn=lambda fn=button[1]: self.__on_button_click(fn), style_type_name_override="Warning.Button")
ui.Spacer(width=self.PADDING)
else:
with ui.HStack():
ui.Spacer()
ui.Button("OK", width=self.__button_width, clicked_fn=self.__on_button_click, style_type_name_override="Warning.Button")
ui.Spacer(width=self.PADDING)
def __on_button_click(self, clicked_fn: Callable[[None], bool] = None) -> None:
keep_open = False
if clicked_fn:
keep_open = clicked_fn()
if not keep_open:
self.visible = False
| 4,854 | Python | 37.84 | 170 | 0.550474 |
omniverse-code/kit/exts/omni.kit.hotkeys.window/omni/kit/hotkeys/window/window/hotkeys_window.py | # pylint: disable=unused-private-member, relative-beyond-top-level, attribute-defined-outside-init
__all__ = ["HotkeysWindow"]
from typing import Optional
from omni.kit.actions.window import ColumnRegistry, ACTIONS_WINDOW_STYLE
import omni.ui as ui
from ..model.hotkeys_model import HotkeysModel
from ..column_delegate.hotkey_column_delegate import HotkeyColumnDelegate
from ..column_delegate.action_column_delegate import ActionColumnDelegate
from ..column_delegate.window_column_delegate import WindowColumnDelegate
from ..view.hotkeys_view import HotkeysView
from ..view.hotkeys_delegate import HotkeysDelegate
from ..style import HOTKEYS_WINDOW_STYLE
from .search_bar import SearchBar
class HotkeysWindow(ui.Window):
def __init__(self, title):
super().__init__(title, width=1000, height=600)
self._hotkeys_model: Optional[HotkeysModel] = None
self.__hotkey_column_delegate: Optional[HotkeyColumnDelegate] = None
self._search_bar: Optional[SearchBar] = None
self._column_registry: Optional[ColumnRegistry] = None
self._hotkeys_view: Optional[HotkeysView] = None
self._actions_delegate: Optional[HotkeysDelegate] = None
self.__sub_model = None
style = ACTIONS_WINDOW_STYLE.copy()
style.update(HOTKEYS_WINDOW_STYLE)
self.frame.set_style(style)
self.frame.set_build_fn(self._build_ui)
def destroy(self):
self.visible = False
self.__sub_model = None
if self.__hotkey_column_delegate:
self.__hotkey_column_delegate.destroy()
if self._hotkeys_model:
self._hotkeys_model.destroy()
self._hotkeys_model = None
super().destroy()
def stop_key_capture(self):
if self.__hotkey_column_delegate:
self.__hotkey_column_delegate.stop_key_capture()
def _build_ui(self):
self.__hotkey_column_delegate = HotkeyColumnDelegate("Hotkey")
self._column_registry = ColumnRegistry()
self._column_registry.register_delegate(WindowColumnDelegate("Window", width=200))
self._column_registry.register_delegate(ActionColumnDelegate("Action", width=400))
self._column_registry.register_delegate(self.__hotkey_column_delegate)
self._hotkeys_model = HotkeysModel(self._column_registry)
self._actions_delegate = HotkeysDelegate(self._hotkeys_model, self._column_registry)
self.__sub_model = self._hotkeys_model.subscribe_item_changed_fn(self.__on_model_changed)
with self.frame:
with ui.VStack(spacing=4):
self._search_bar = SearchBar(self._hotkeys_model)
with ui.ScrollingFrame(
horizontal_scrollbar_policy=ui.ScrollBarPolicy.SCROLLBAR_AS_NEEDED,
vertical_scrollbar_policy=ui.ScrollBarPolicy.SCROLLBAR_ALWAYS_ON,
style_type_name_override="ActionsView",
):
self._hotkeys_view = HotkeysView(self._hotkeys_model, self._actions_delegate)
def __on_model_changed(self, model: HotkeysModel, item: ui.AbstractItem) -> None:
if self.__hotkey_column_delegate:
# Here need to clean key capture since the whole tree view is refreshed
self.__hotkey_column_delegate.stop_key_capture()
| 3,307 | Python | 43.106666 | 98 | 0.677653 |
omniverse-code/kit/exts/omni.kit.hotkeys.window/omni/kit/hotkeys/window/window/windows_picker.py | # pylint: disable=relative-beyond-top-level
__all__ = ["WindowsPicker"]
from typing import List, Callable, Optional
import omni.ui as ui
from omni.kit.actions.window import ACTIONS_WINDOW_STYLE
from ..model.windows_model import WindowsModel, WindowItem
from ..style import WINDOW_PICK_STYLE
class WindowsPicker(ui.Window):
def __init__(
self,
width=0,
height=600,
on_selected_fn: Callable[[str], None] = None,
expand_all: bool = True,
focus_search: bool = True,
):
super().__init__("###WINDOW_PICKER", width=width, height=height)
self.flags = ui.WINDOW_FLAGS_NO_TITLE_BAR | ui.WINDOW_FLAGS_NO_RESIZE | ui.WINDOW_FLAGS_NO_MOVE | ui.WINDOW_FLAGS_POPUP
self.__on_selected_fn = on_selected_fn
self.__expand_all = expand_all
self.__focus_search = focus_search
self._actions_view: Optional[ui.TreeView] = None
self._search_field = None
self._windows_model: Optional[WindowsModel] = None
style = ACTIONS_WINDOW_STYLE.copy()
style.update(WINDOW_PICK_STYLE)
self.frame.set_style(style)
self.frame.set_build_fn(self._build_ui)
def _build_ui(self):
self._windows_model = WindowsModel("")
with self.frame:
with ui.VStack(spacing=4):
try:
from omni.kit.widget.searchfield import SearchField
self._search_field = SearchField(
on_search_fn=self._on_search,
subscribe_edit_changed=True,
style=ACTIONS_WINDOW_STYLE,
)
except ImportError:
self._search_field = None
with ui.ScrollingFrame(
horizontal_scrollbar_policy=ui.ScrollBarPolicy.SCROLLBAR_AS_NEEDED,
vertical_scrollbar_policy=ui.ScrollBarPolicy.SCROLLBAR_ALWAYS_ON,
style_type_name_override="ActionsView",
):
self._actions_view = ui.TreeView(
self._windows_model, root_visible=False, header_visible=False,
)
self._actions_view.set_selection_changed_fn(self._on_selection_changed)
if self.__expand_all:
self._actions_view.set_expanded(None, True, True)
if self.__focus_search and self._search_field:
self._search_field._search_field.focus_keyboard() # pylint: disable=protected-access
def _on_search(self, search_words: Optional[List[str]]) -> None:
self._windows_model.search(search_words)
# Auto expand on searching
self._actions_view.set_expanded(None, True, True)
def _on_selection_changed(self, selections: List[WindowItem]):
for item in selections:
if isinstance(item, WindowItem) and self.__on_selected_fn:
self.__on_selected_fn(item.window_title)
| 2,943 | Python | 39.888888 | 127 | 0.594631 |
omniverse-code/kit/exts/omni.kit.hotkeys.window/omni/kit/hotkeys/window/window/options_menu.py | # pylint: disable=relative-beyond-top-level
__all__ = ["OptionsMenu"]
from typing import Optional, Callable
import carb
import omni.ui as ui
import omni.client
from omni.kit.notification_manager import post_notification, NotificationStatus
from omni.kit.hotkeys.core import get_hotkey_registry, KeyboardLayoutDelegate
from .warning_window import WarningWindow
from ..model.hotkeys_model import HotkeysModel
class LayoutMenu(ui.MenuItemCollection):
def __init__(self):
super().__init__("Keyboard Layouts")
self.__build_layout_items()
def __build_layout_items(self):
current_layout = get_hotkey_registry().keyboard_layout
with self:
for layout in KeyboardLayoutDelegate.get_instances():
name = layout.get_name()
checked = current_layout == layout
menu_item = ui.MenuItem(
name,
checkable=True,
checked=checked,
)
menu_item.set_triggered_fn(lambda m=menu_item, n=name: self.__switch_keyboard_layput(m, n))
def __switch_keyboard_layput(self, menu_item: ui.MenuItem, name: str) -> None:
get_hotkey_registry().switch_layout(name)
menu_item.checked = True
class OptionsMenu:
def __init__(self, model: HotkeysModel, widget: ui.Widget):
self.__model = model
self.__widget = widget
self.__context_menu: Optional[ui.Menu] = None
self.__last_dir: Optional[str] = None
self.__export_dialog = None
self.__import_dialog = None
def show(self):
if self.__context_menu is None:
self.__context_menu = ui.Menu(f"Hotkeys window Context Menu##{hash(self)}")
with self.__context_menu:
ui.MenuItem("Import Preset", triggered_fn=self.__import_preset)
ui.MenuItem("Export Preset", triggered_fn=self.__export_preset)
ui.MenuItem("Restore Defaults", triggered_fn=self.__restore_defaults)
LayoutMenu()
# Right-bottom allign to the widget
# 120 is the menu width
position_x = self.__widget.screen_position_x + self.__widget.computed_width - 120
position_y = self.__widget.screen_position_y + self.__widget.computed_height
self.__context_menu.show_at(position_x, position_y)
def __import_preset(self):
try:
import omni.kit.window.filepicker # pylint: disable=redefined-outer-name
self.__import_dialog = omni.kit.window.filepicker.FilePickerDialog(
"Import",
apply_button_label="import",
current_directory=self.__last_dir,
click_apply_handler=self.__on_import,
item_filter_options=["Hotkey preset file (*.json)", "All Files (*)"],
# item_filter_fn=self.__on_filter_item,
)
except ImportError:
carb.log_info("Failed to import omni.kit.window.filepicker")
def __export_preset(self):
try:
import omni.kit.window.filepicker # pylint: disable=redefined-outer-name
self.__export_dialog = omni.kit.window.filepicker.FilePickerDialog(
"Export As",
apply_button_label="Export",
current_directory=self.__last_dir,
click_apply_handler=self.__on_export,
item_filter_options=["Hotkey preset file (*.json)", "All Files (*)"],
# item_filter_fn=self.__on_filter_item,
)
except ImportError:
carb.log_info("Failed to import omni.kit.window.filepicker")
def __on_export(self, filename: str, path: str, callback: Callable[[str], None] = None):
"""Called when the user presses the Save button in the dialog"""
if path:
self.__last_dir = path
if not filename:
return
# Get the file extension from the filter
if not filename.lower().endswith(".json") and self.__export_dialog.current_filter_option < 1:
filename += ".json"
if path:
path = omni.client.combine_urls(path + "/", filename)
else:
path = filename
self.__export_dialog.hide()
# check dest file
(result, list_entry) = omni.client.stat(path)
if result == omni.client.Result.OK and not list_entry.access & omni.client.AccessFlags.WRITE:
post_notification(
f"Hotkey preset '{path}' is readonly, save to another one!",
hide_after_timeout=True,
status=NotificationStatus.WARNING,
)
return
self.__export(path)
def __export(self, url: str) -> None:
get_hotkey_registry().export_storage(url)
def __on_import(self, filename: str, path: str, callback: Callable[[str], None] = None):
"""Called when the user presses the Save button in the dialog"""
self.__last_dir = path
if not filename:
return
# Get the file extension from the filter
if not filename.lower().endswith(".json") and self.__import_dialog.current_filter_option < 1:
filename += ".json"
url = omni.client.combine_urls(path + "/", filename)
self.__import_dialog.hide()
# check dest file
(result, _) = omni.client.stat(url)
if result != omni.client.Result.OK:
post_notification(
f"Hotkey preset '{url}' does not exists!",
hide_after_timeout=True,
status=NotificationStatus.WARNING,
)
return
self.__import(url)
def __import(self, url: str) -> None:
get_hotkey_registry().import_storage(url)
self.__model._item_changed(None) # pylint: disable=protected-access
def __restore_defaults(self) -> None:
def __restore():
get_hotkey_registry().restore_defaults()
self.__model._item_changed(None) # pylint: disable=protected-access
warn_window = WarningWindow(
"Restore Defaults",
messages=[
"Are you sure you want to restore all hotkeys to their defaults?",
"\n",
"This will also remove any user added hotkeys.",
],
buttons=[
("Yes", __restore),
("No", None)
]
)
warn_window.position_x = self.__widget.screen_position_x + self.__widget.computed_width - warn_window.width
warn_window.position_y = self.__widget.screen_position_y + self.__widget.computed_height
| 6,657 | Python | 37.045714 | 115 | 0.579991 |
omniverse-code/kit/exts/omni.kit.hotkeys.window/omni/kit/hotkeys/window/window/search_bar.py | # pylint: disable=relative-beyond-top-level
__all__ = ["SearchBar"]
from typing import Optional, List
import omni.ui as ui
from omni.kit.actions.window import ACTIONS_WINDOW_STYLE
from omni.kit.widget.filter import FilterButton
from ..model.hotkeys_model import HotkeysModel
from .options_menu import OptionsMenu
class SearchBar:
"""
Search bar, includes a search field and a filter button.
Args:
model (HotkeysModel): Hotkeys model.
"""
def __init__(self, model: HotkeysModel):
self.__model = model
self.__container: Optional[ui.HStack] = None
self.__filter_button: Optional[FilterButton] = None
self.__options_menu: Optional[OptionsMenu] = None
self.__build_ui()
def destroy(self):
if self.__filter_button:
self.__filter_button.destroy()
self.__filter_button = None
@property
def visible(self) -> bool:
return self.__container.visible if self.__container else False
@visible.setter
def visible(self, value) -> None:
if self.__container:
self.__container.visible = False
def __build_ui(self):
try:
from omni.kit.widget.searchfield import SearchField
self.__container = ui.HStack(height=0)
with self.__container:
self._search_field = SearchField(
on_search_fn=self.__on_search,
subscribe_edit_changed=True,
style=ACTIONS_WINDOW_STYLE,
show_tokens=False,
)
self.__filter_button = FilterButton(self.__model.search_filter_flags, width=26, height=26)
with ui.VStack(width=26):
self.__options_image = ui.ImageWithProvider(
width=26,
height=26,
mouse_pressed_fn=lambda x, y, b, f: self.__show_options(),
style_type_name_override="SearchBar.Options",
)
ui.Spacer()
except ImportError:
self._search_field = None
def __on_search(self, search_words: Optional[List[str]]) -> None:
self.__model.search(search_words)
def __show_options(self):
if self.__options_menu is None:
self.__options_menu = OptionsMenu(self.__model, self.__options_image)
self.__options_menu.show()
| 2,432 | Python | 32.328767 | 106 | 0.571957 |
omniverse-code/kit/exts/omni.kit.hotkeys.window/omni/kit/hotkeys/window/column_delegate/key_editor.py | # pylint: disable=attribute-defined-outside-init, unused-private-member, relative-beyond-top-level
__all__ = ["TriggerPressOption", "TriggerPressWindow", "KeyEditor"]
import asyncio
from typing import Optional, Union, Callable
import carb
import carb.input
import omni.kit.app
import omni.ui as ui
from omni.kit.hotkeys.core import Hotkey, HotkeyRegistry, KeyCombination, get_hotkey_registry
from ..model.hotkey_item import HotkeyDetailItem, EmptyHotkeyItem
from ..model.hotkeys_model import HotkeysModel
from ..window.warning_window import WarningWindow, WarningMessage
from ..style import HOTKEYS_WINDOW_STYLE
_key_capture_instances = 0
class TriggerPressOption:
def __init__(self, collection: ui.RadioCollection, text):
with ui.ZStack(width=0):
ui.Rectangle(style_type_name_override="TriggerPressOption.Background")
ui.RadioButton(
text=text,
radio_collection=collection,
width=100,
height=24,
image_width=14,
spacing=4,
alignment=ui.Alignment.LEFT,
style_type_name_override="TriggerPressOption",
)
class TriggerPressWindow(ui.Window):
PADDING = 4
def __init__(self, model: ui.SimpleIntModel):
self.__model = model
flags = ui.WINDOW_FLAGS_NO_TITLE_BAR | ui.WINDOW_FLAGS_NO_RESIZE | ui.WINDOW_FLAGS_NO_MOVE | ui.WINDOW_FLAGS_POPUP
super().__init__("Hotkey Trigger", flags=flags, auto_resize=True)
self.frame.set_style(HOTKEYS_WINDOW_STYLE)
self.frame.set_build_fn(self.__build_ui)
def destroy(self):
self.__sub = None
def __del__(self):
self.destroy()
def __build_ui(self):
collection = ui.RadioCollection(self.__model)
with self.frame:
with ui.VStack(style={"padding": self.PADDING}):
TriggerPressOption(collection, "On Press")
TriggerPressOption(collection, "On Release")
self.__sub = collection.model.add_value_changed_fn(self.__on_value_changed)
def __on_value_changed(self, model: ui.AbstractValueModel):
self.visible = False
class KeyEditor:
def __init__(
self,
model: HotkeysModel,
item: Union[HotkeyDetailItem, EmptyHotkeyItem],
visible: bool = True,
on_edit_cancelled_fn: Callable[[str], None] = None
):
self.__model = model
self.__item = item
self.__on_edit_cancelled_fn = on_edit_cancelled_fn
self.__key_text_model = ui.SimpleStringModel(item.hotkey.key_text if item.hotkey else "")
self.__key_press_model = ui.SimpleIntModel(0 if item.hotkey.key_combination.trigger_press else 1)
self.__sub_key_text = self.__key_text_model.add_value_changed_fn(self.__on_key_text_changed)
self.__trigger_window: Optional[TriggerPressWindow] = None
self.__input_field: Optional[ui.StringField] = None
self.__input_hint: Optional[ui.Label] = None
self.__remove_container: Optional[ui.HStack] = None
self.__input = carb.input.acquire_input_interface()
self.__input_sub_id = None
self.__build_ui(visible)
def __del__(self):
self.visible = False
def __build_ui(self, visible):
# Double click to clean the key input to empty
self.__container = ui.HStack(visible=visible)
with self.__container:
ui.Spacer(width=4)
with ui.ZStack(width=ui.Fraction(1)):
self.__input_field = ui.StringField(self.__key_text_model, enabled=False)
self.__input_hint = ui.Label("Begin Typing to Capture Key Bindings", name="hint", style_type_name_override="Action.Input")
self.__remove_container = ui.HStack()
with self.__remove_container:
ui.Spacer()
ui.Image(name="remove", width=20, mouse_released_fn=lambda x, y, b, f: self.__key_text_model.set_value(""))
ui.Spacer(width=4)
ui.Spacer(width=8)
ui.Image(name="cancel", width=20, mouse_released_fn=lambda x, y, b, f: self.__hide())
ui.Spacer(width=4)
ui.Image(name="save", width=20, mouse_released_fn=lambda x, y, b, f: self.__save())
ui.Spacer(width=4)
with ui.ZStack(width=0):
ui.Rectangle(style_type_name_override="DropDownArrow.background")
with ui.VStack(width=0):
ui.Spacer()
self.__arrow = ui.Triangle(
width=20,
height=16,
alignment=ui.Alignment.CENTER_BOTTOM,
style_type_name_override="DropDownArrow",
mouse_released_fn=lambda x, y, b, f: self.__edit_press()
)
ui.Spacer()
ui.Spacer(width=1)
if visible:
carb.log_info(f"[Hotkey Editor] Show editor for {self.__item}")
self.__start_key_capture()
self.__on_key_text_changed(self.__key_text_model)
@property
def visible(self) -> bool:
return self.__container.visible
@visible.setter
def visible(self, value: bool) -> None:
self.__container.visible = value
self.__sub_key_text = False
carb.log_info(f"[Hotkey Editor] Visible change to {value} for {self.__item}")
if value:
# Default to capture keyboard for key input
self.__key_text_model.set_value(self.__item.hotkey.key_text if self.__item.hotkey else "")
self.__start_key_capture()
else:
self.__stop_key_capture()
def __start_key_capture(self):
global _key_capture_instances
_key_capture_instances += 1
carb.log_info(f"[Hotkey Editor] [{_key_capture_instances}] Start key capture for {self.__item}")
self.__input_sub_id = self.__input.subscribe_to_input_events(self._on_input_event, order=-100000)
def __stop_key_capture(self):
if self.__input_sub_id is not None:
global _key_capture_instances
_key_capture_instances -= 1
carb.log_info(f"[Hotkey Editor] [{_key_capture_instances}] Stop key capture for {self.__item}")
self.__input.unsubscribe_to_input_events(self.__input_sub_id)
self.__input_sub_id = None
def _on_input_event(self, event, *_):
if event.deviceType == carb.input.DeviceType.KEYBOARD:
is_down = event.event.type == carb.input.KeyboardEventType.KEY_PRESS
if is_down:
key_combination = KeyCombination(event.event.input, modifiers=event.event.modifiers)
self.__key_text_model.set_value(key_combination.as_string)
# Return False to block key input
return False
def __hide(self):
carb.log_info("[Hotkey Editor] Cancel edit")
self.visible = False
if isinstance(self.__item, EmptyHotkeyItem):
async def __clear_empty_async():
await omni.kit.app.get_app().next_update_async()
self.__model.clear_empty_hotkey()
asyncio.ensure_future(__clear_empty_async())
if self.__on_edit_cancelled_fn:
self.__on_edit_cancelled_fn(self.__item.hotkey.key_text)
def __save(self):
try:
result = self.__model.edit_hotkey_item(
self.__item,
key_text=self.__key_text_model.as_string,
trigger_press=self.__key_press_model.as_int == 0
)
if result == HotkeyRegistry.Result.OK:
carb.log_info(f"[Hotkey Editor] Save for {self.__item}")
self.visible = False
else:
if result == HotkeyRegistry.Result.ERROR_NO_ACTION:
warn_window = WarningWindow("Action required", ["Please select an action before saving hotkey!"])
elif result == HotkeyRegistry.Result.ERROR_KEY_INVALID:
warn_window = WarningWindow("Key required", ["Please input a valid key binding before saving the hotkey!"])
elif result == HotkeyRegistry.Result.ERROR_KEY_DUPLICATED:
key_combination = KeyCombination(self.__key_text_model.as_string, trigger_press=self.__item.hotkey.key_combination.trigger_press)
duplicated_key = get_hotkey_registry().get_hotkey_for_filter(key_combination, self.__item.hotkey.filter)
action_display = duplicated_key.action.display_name if duplicated_key.action else "Unknown Action"
warn_window = WarningWindow(
"Hotkey Conflict Warning",
messages=[
WarningMessage(f"'{key_combination.id}'", highlight=True),
WarningMessage(" is already assigned to "),
WarningMessage(f"'{action_display}'", highlight=True),
'\n',
"Do you want to replace this exising hotkey with your new one?"
],
buttons=[
("Replace", lambda k=key_combination, n=self.__item, o=duplicated_key: self.__replace_key(k, n, o)),
("Cancel", None)
]
)
elif result == HotkeyRegistry.Result.ERROR_ACTION_DUPLICATED:
action_display = self.__item.action_display
warn_window = WarningWindow(
"Action Conflict Warning",
messages=[
WarningMessage(f"'{action_display}'", highlight=True),
WarningMessage(" is already defined."),
]
)
else:
warn_window = WarningWindow("Unkown Error", [f"Error code: {result}"])
warn_window.position_x = self.__container.screen_position_x + 4
warn_window.position_y = self.__container.screen_position_y + self.__container.computed_height + 4
except Exception as e: # pylint: disable=broad-except
carb.log_error(f"Exception when save hotkey: {e}")
def __edit_press(self):
if self.__trigger_window is None:
self.__trigger_window = TriggerPressWindow(self.__key_press_model)
async def __update_position():
while self.__trigger_window.width < 10 or self.__trigger_window.width == 400:
await omni.kit.app.get_app().next_update_async()
self.__trigger_window.position_x = self.__arrow.screen_position_x + self.__arrow.computed_width - self.__trigger_window.width
self.__trigger_window.position_y = self.__arrow.screen_position_y + self.__arrow.computed_height + 4
self.__trigger_window.visible = True
asyncio.ensure_future(__update_position())
def __replace_key(self, key_combination: KeyCombination, item: HotkeyDetailItem, duplicated_key: Hotkey):
carb.log_info(f"[Hotkey Editor] Replace hotkey for {self.__item}")
self.visible = False
self.__model.replace_item_key(key_combination, item, duplicated_key)
def __on_key_text_changed(self, model: ui.SimpleStringModel) -> None:
if self.__remove_container:
self.__remove_container.visible = (model.as_string != "")
if self.__input_hint:
self.__input_hint.visible = (model.as_string == "")
| 11,587 | Python | 44.802371 | 149 | 0.579788 |
omniverse-code/kit/exts/omni.kit.hotkeys.window/omni/kit/hotkeys/window/column_delegate/action_column_delegate.py | # pylint: disable=relative-beyond-top-level
__all__ = ["ActionColumnDelegate"]
import asyncio
from typing import Optional
from omni.kit.actions.window import AbstractActionItem, ActionExtItem, StringColumnDelegate, ActionsPicker
from omni.kit.widget.highlight_label import HighlightLabel
import omni.ui as ui
import omni.kit.app
from ..model.hotkeys_model import HotkeyDetailItem, HotkeysModel, EmptyHotkeyItem
from ..model.hotkey_item import AbstractFilterItem, AddWindowItem, FilterContextItem, FilterWindowItem
from ..window.warning_window import WarningWindow
from ..style import HIGHLIGHT_LABEL_STYLE, HIGHLIGHT_LABEL_STYLE_USER
class ActionColumnDelegate(StringColumnDelegate):
"""
A simple delegate to display/add action in column.
Kwargs:
name (str): Column name.
width (ui.Length): Column width. Default ui.Fraction(1).
"""
def __init__(self, name: str, width: ui.Length = None):
width = ui.Fraction(1) if width is None else width
super().__init__(name, width=width)
self.__actions_picker: Optional[ActionsPicker] = None
self.__auto_show_picker = False
def build_widget(self, model: HotkeysModel, item: AbstractActionItem, level: int, expand: bool):
if isinstance(item, AddWindowItem):
return None
if isinstance(item, HotkeyDetailItem):
if item.hotkey.action:
label = HighlightLabel(item.hotkey.action.display_name, highlight=item.highlight, style=HIGHLIGHT_LABEL_STYLE_USER if item.user_defined else HIGHLIGHT_LABEL_STYLE)
label.widget.set_tooltip(f"{item.hotkey.action_text}\n{item.hotkey.action.description}")
return label.widget
return ui.Label(item.hotkey.action_text, name="warning", style_type_name_override="ActionsView.Item.Text")
if isinstance(item, ActionExtItem):
container = ui.ZStack()
with container:
# Background rectangle
with ui.VStack():
ui.Spacer()
ui.Rectangle(height=26, style_type_name_override="ActionsView.Row.Background")
ui.Spacer()
filter_type = "Global"
if isinstance(item, FilterWindowItem):
filter_type = "Window"
elif isinstance(item, FilterContextItem):
filter_type = "Context"
button = ui.Button(
f"Add New {filter_type} Hotkey",
name="add",
image_width=20,
visible=True,
)
button.set_clicked_fn(lambda m=model, i=item, b=button: self.__add_action(m, i, b))
return container
if isinstance(item, EmptyHotkeyItem):
container = ui.ZStack()
with container:
ui.Rectangle(style_type_name_override="DropDownArrow.background")
with ui.HStack():
action_label = ui.Label("Select An Action", name="hint", style_type_name_override="Action.Input")
with ui.VStack(width=0):
ui.Spacer()
ui.Triangle(
width=20,
height=16,
alignment=ui.Alignment.CENTER_BOTTOM,
style_type_name_override="DropDownArrow",
)
ui.Spacer()
container.set_mouse_released_fn(lambda x, y, b, f, m=model, c=container, l=action_label: self.__show_action_picker(m, c, l))
if self.__auto_show_picker:
self.__show_action_picker(model, container, action_label)
self.__auto_show_picker = False
return container
def __add_action(self, model: HotkeysModel, item: AbstractFilterItem, button: ui.Button):
if isinstance(item, FilterContextItem):
if not item.id:
warn_window = WarningWindow("Context required", ["Please select a context first before adding new context hotkey!"])
warn_window.position_x = button.screen_position_x + 4
warn_window.position_y = button.screen_position_y
return
elif isinstance(item, FilterWindowItem) and not item.id:
warn_window = WarningWindow("Window required", ["Please select a window first before adding new window hotkey!"])
warn_window.position_x = button.screen_position_x + 4
warn_window.position_y = button.screen_position_y
return
async def __add_action_async():
await omni.kit.app.get_app().next_update_async()
self.__auto_show_picker = True
model.add_empty_hotkey(item)
asyncio.ensure_future(__add_action_async())
def __show_action_picker(self, model: HotkeysModel, container: ui.Stack, label: ui.Label) -> None:
if self.__actions_picker is not None:
if self.__actions_picker.visible:
# Just hide actions picker if it already visible
self.__actions_picker.visible = False
return
self.__actions_picker = None
# Refresh actions list every time
def __on_action_selected(action):
item = model.save_empty_action(action)
label.text = item.action_display
label.name = ""
self.__actions_picker.visible = False
async def __update_position():
if container.computed_width == 0:
await omni.kit.app.get_app().next_update_async()
self.__actions_picker = ActionsPicker(width=container.computed_width, height=500, on_selected_fn=__on_action_selected)
self.__actions_picker.visible = True
self.__actions_picker.position_x = container.screen_position_x
self.__actions_picker.position_y = container.screen_position_y + container.computed_height
asyncio.ensure_future(__update_position())
| 6,038 | Python | 46.179687 | 179 | 0.601358 |
omniverse-code/kit/exts/omni.kit.hotkeys.window/omni/kit/hotkeys/window/column_delegate/reset_button.py | __all__ = ["ResetHelper", "ResetButton"]
import abc
from typing import Callable, List
import carb.settings
import omni.ui as ui
class ResetHelper:
def __init__(self, reset_button=None):
self._reset_button = None
@abc.abstractmethod
def can_reset(self) -> bool:
return False
@abc.abstractmethod
def reset(self) -> bool:
return True
def set_reset_button(self, button: "ResetButton"):
self._reset_button = button
self._update_reset_button()
def _update_reset_button(self):
if self._reset_button is None:
return
self._reset_button.refresh()
class ResetButton:
def __init__(self, helpers: List[ResetHelper] = None, on_reset_fn: Callable[[None], None] = None):
self._helpers = helpers if helpers else []
self._settings = carb.settings.get_settings()
self._on_reset_fn = on_reset_fn
self._build_ui()
def add_setting_model(self, helper: ResetHelper):
if helper not in self._helpers:
self._helpers.append(helper)
self.refresh()
def refresh(self):
visible = False
for helper in self._helpers:
if helper.can_reset():
visible = True
break
self._reset_button.visible = visible
def _build_ui(self):
with ui.HStack(width=0):
ui.Spacer()
with ui.VStack(width=0):
ui.Spacer()
with ui.ZStack(width=15, height=12):
with ui.HStack(style={"margin_width": 0}):
ui.Spacer()
with ui.VStack(width=0):
ui.Spacer()
ui.Rectangle(width=5, height=5, style_type_name_override="ResetButton.Invalid")
ui.Spacer()
ui.Spacer()
with ui.HStack():
ui.Spacer()
self._reset_button = ui.Rectangle(width=12, height=12, style_type_name_override="ResetButton", tooltip="Click to reset value")
ui.Spacer()
self._reset_button.set_mouse_pressed_fn(lambda x, y, m, w: self._restore_defaults())
ui.Spacer()
ui.Spacer()
def _restore_defaults(self):
for helper in self._helpers:
if helper.can_reset() and not helper.reset():
return
self._reset_button.visible = False
if self._on_reset_fn:
self._on_reset_fn()
| 2,559 | Python | 31.405063 | 150 | 0.533021 |
omniverse-code/kit/exts/omni.kit.hotkeys.window/omni/kit/hotkeys/window/column_delegate/window_column_delegate.py | # pylint: disable=relative-beyond-top-level
__all__ = ["WindowColumnDelegate"]
import asyncio
from typing import Optional
from omni.kit.actions.window import AbstractActionItem, ActionExtItem, StringColumnDelegate
from omni.kit.widget.highlight_label import HighlightLabel
import omni.ui as ui
import omni.kit.app
from ..model.hotkeys_model import HotkeysModel, EmptyFilterWindowItem, AddWindowItem
from ..window.windows_picker import WindowsPicker
from ..style import VIEW_ROW_HEIGHT, HIGHLIGHT_LABEL_STYLE
class WindowColumnDelegate(StringColumnDelegate):
"""
A simple delegate to display/add action in column.
Kwargs:
name (str): Column name.
width (ui.Length): Column width. Default None means ui.Fraction(1).
"""
def __init__(self, name: str, width: Optional[ui.Length] = None):
width = ui.Fraction(1) if width is None else width
super().__init__(name, width=width)
self.__windows_picker: Optional[WindowsPicker] = None
self.__auto_show_picker = False
def build_widget(self, model: HotkeysModel, item: AbstractActionItem, level: int, expand: bool):
if isinstance(item, AddWindowItem):
container = ui.ZStack(width=self._width)
with container:
# Background rectangle to keep get hovered when button invisible
ui.Rectangle(height=26, style_type_name_override="Button.Background")
def __add_window_filter():
self.__auto_show_picker = True
model.add_window_filter()
ui.Button(
"Add Window",
name="add",
image_width=20,
visible=True,
clicked_fn=__add_window_filter
)
return container
if isinstance(item, EmptyFilterWindowItem):
container = ui.HStack(width=self._width, height=VIEW_ROW_HEIGHT)
with container:
ui.Spacer(width=4)
with ui.ZStack():
ui.Rectangle(style_type_name_override="DropDownArrow.background")
with ui.HStack():
if item.id:
action_label = ui.Label(item.id, name="", style_type_name_override="Action.Input")
else:
action_label = ui.Label("Select A Window", name="hint", style_type_name_override="Action.Input")
with ui.VStack(width=0):
ui.Spacer()
ui.Triangle(
width=20,
height=16,
alignment=ui.Alignment.CENTER_BOTTOM,
style_type_name_override="DropDownArrow",
)
ui.Spacer()
ui.Spacer(width=4)
container.set_mouse_released_fn(lambda x, y, b, f, m=model, i=item, c=container, l=action_label: self.__show_window_picker(m, i, c, l))
if self.__auto_show_picker:
self.__show_window_picker(model, item, container, action_label)
self.__auto_show_picker = False
return container
if isinstance(item, ActionExtItem):
container = ui.ZStack(height=VIEW_ROW_HEIGHT)
with container:
with ui.VStack():
ui.Spacer()
ui.Rectangle(height=26, style_type_name_override="ActionsView.Row.Background")
ui.Spacer()
HighlightLabel(item.id, height=VIEW_ROW_HEIGHT, highlight=item.highlight, style=HIGHLIGHT_LABEL_STYLE)
return container
return None
def __show_window_picker(self, model: HotkeysModel, item: EmptyFilterWindowItem, container: ui.Stack, label: ui.Label) -> None:
if self.__windows_picker is not None:
if self.__windows_picker.visible:
# Just hide windows picker if it already visible
self.__windows_picker.visible = False
return
self.__windows_picker = None
# Refresh windows list every time
def __on_window_selected(item, title):
item = model.edit_hotkey_filter_item(item, window_title=title)
label.text = title
label.name = ""
self.__windows_picker.visible = False
async def __update_position():
if container.computed_width == 0:
await omni.kit.app.get_app().next_update_async()
self.__windows_picker = WindowsPicker(width=container.computed_content_width, height=500, on_selected_fn=lambda t, i=item: __on_window_selected(i, t))
self.__windows_picker.visible = True
await omni.kit.app.get_app().next_update_async()
self.__windows_picker.position_x = container.screen_position_x
self.__windows_picker.position_y = container.screen_position_y + container.computed_height
asyncio.ensure_future(__update_position())
| 5,119 | Python | 45.126126 | 162 | 0.572377 |
omniverse-code/kit/exts/omni.kit.hotkeys.window/omni/kit/hotkeys/window/column_delegate/hotkey_column_delegate.py | # pylint: disable=unused-private-member, relative-beyond-top-level
__all__ = ["KeyResetHelper", "HotkeyColumnDelegate"]
import asyncio
from typing import Dict, List
from omni.kit.actions.window import AbstractActionItem, StringColumnDelegate
from omni.kit.hotkeys.core import KeyCombination, HOTKEY_CHANGED_EVENT, HotkeyRegistry, get_hotkey_registry
from omni.kit.widget.highlight_label import HighlightLabel
import omni.ui as ui
import omni.kit.app
import carb.events
from ..model.hotkeys_model import EmptyHotkeyItem, HotkeyDetailItem, HotkeysModel, AddWindowItem
from ..model.hotkey_item import USER_HOTKEY_EXT_ID
from ..window.warning_window import WarningWindow, WarningMessage
from ..style import VIEW_ROW_HEIGHT, HIGHLIGHT_LABEL_STYLE, HIGHLIGHT_LABEL_STYLE_USER
from .reset_button import ResetButton, ResetHelper
from .key_editor import KeyEditor
class KeyResetHelper(ResetHelper):
def __init__(self, model: HotkeysModel, item: HotkeyDetailItem, container: ui.Widget):
self.__model = model
self.__item = item
self.__container = container
def can_reset(self) -> bool:
return self.__item.is_modified()
def reset(self) -> bool:
result = self.__model.restore_item_key(self.__item)
if result != HotkeyRegistry.Result.OK:
if result == HotkeyRegistry.Result.ERROR_KEY_DUPLICATED:
key_combination = KeyCombination(self.__item.default_key_id)
duplicated_key = get_hotkey_registry().get_hotkey_for_filter(key_combination, self.__item.hotkey.filter)
action_display = duplicated_key.action.display_name if duplicated_key.action else "Unknown Action"
warn_window = WarningWindow(
"Hotkey Conflict Warning",
messages=[
"The default for this action is ",
WarningMessage(f"'{key_combination.id}'", highlight=True),
"\n",
"It is already assigned to ",
WarningMessage(f"'{action_display}'", highlight=True),
'\n',
"Do you want to replace this exising hotkey with your new one?"
],
buttons=[
("Replace", lambda k=key_combination, n=self.__item, o=duplicated_key: self.__model.replace_item_key(k, n, o)),
("Cancel", None)
],
)
else:
warn_window = WarningWindow("Unkown Error", [f"Error code: {result}"])
warn_window.position_x = self.__container.screen_position_x + 4
warn_window.position_y = self.__container.screen_position_y + self.__container.computed_height + 4
return False
return True
def filter_payload(self, payload: Dict) -> bool:
hotkey = self.__item.hotkey
if (
payload["hotkey_ext_id"] == hotkey.hotkey_ext_id
and payload["action_ext_id"] == hotkey.action_ext_id
and payload["action_id"] == hotkey.action_id
):
self._update_reset_button()
return True
return False
class HotkeyColumnDelegate(StringColumnDelegate):
"""
A simple delegate to display a editable hotkey in column.
Kwargs:
name (str): Column name.
width (ui.Length): Column width. Default None means ui.Fraction(1).
"""
def __init__(self, name: str, width: ui.Length = None):
width = ui.Fraction(1) if width is None else width
super().__init__(name, width=width)
self.__reset_helpers: Dict[HotkeyDetailItem, KeyResetHelper] = {}
self.__key_editors: Dict[HotkeyDetailItem, KeyEditor] = {}
self.__edit_containers: Dict[HotkeyDetailItem, ui.HStack] = {}
self.__last_selections: List[AbstractActionItem] = []
event_stream = omni.kit.app.get_app().get_message_bus_event_stream()
self.__change_event_sub = event_stream.create_subscription_to_pop_by_type(
HOTKEY_CHANGED_EVENT, self.__on_hotkey_changed)
def destroy(self):
self.__reset_helpers = {}
self.stop_key_capture()
self.__key_editors = {}
self.__change_event_sub = None
def stop_key_capture(self):
for item in self.__key_editors.values():
item.visible = False
def build_widget(self, model: HotkeysModel, item: AbstractActionItem, level: int, expand: bool):
if isinstance(item, (HotkeyDetailItem, EmptyHotkeyItem)):
is_empty_hotkey = isinstance(item, EmptyHotkeyItem)
container = ui.ZStack()
with container:
tool_container = ui.HStack(visible=not is_empty_hotkey, content_clipping=True)
with tool_container:
key_label = HighlightLabel(item.hotkey.key_text, highlight=item.highlight, style=HIGHLIGHT_LABEL_STYLE_USER if item.user_defined else HIGHLIGHT_LABEL_STYLE)
ui.Spacer()
edit_container = ui.HStack(width=0, visible=item in self.__last_selections)
with edit_container:
if item.hotkey.hotkey_ext_id == USER_HOTKEY_EXT_ID:
ui.Image(name="delete", width=20, mouse_pressed_fn=lambda x, y, b, f, m=model, i=item: self.__on_delete(m, i))
ui.Spacer(width=4)
edit_image = ui.Image(name="edit", width=20)
if isinstance(item, HotkeyDetailItem):
ui.Spacer(width=4)
self.__reset_helpers[item] = KeyResetHelper(model, item, container)
reset_button = ResetButton([self.__reset_helpers[item]])
self.__reset_helpers[item].set_reset_button(reset_button)
ui.Spacer(width=1)
key_editor = KeyEditor(model, item, visible=is_empty_hotkey, on_edit_cancelled_fn=lambda v, k=key_label, t=tool_container: self.__on_key_cancelled(v, k, t))
self.__key_editors[item] = key_editor
self.__edit_containers[item] = edit_container
tool_container.set_mouse_double_clicked_fn(lambda x, y, b, f, t=tool_container, k=key_editor: self.__show_key_editor(t, k))
edit_image.set_mouse_pressed_fn(lambda x, y, b, f, t=tool_container, k=key_editor: self.__show_key_editor(t, k))
return container
if isinstance(item, AddWindowItem):
return None
container = ui.VStack(height=VIEW_ROW_HEIGHT)
with container:
ui.Spacer()
ui.Rectangle(height=26, style_type_name_override="ActionsView.Row.Background")
ui.Spacer()
return container
def on_selection_changed(self, selections: List[ui.AbstractItem]):
for item in self.__last_selections:
if item in self.__edit_containers and not self.__key_editors[item].visible:
self.__edit_containers[item].visible = False
for item in selections:
if item in self.__edit_containers and not self.__key_editors[item].visible:
self.__edit_containers[item].visible = True
self.__last_selections = selections
def on_hover_changed(self, item: ui.AbstractItem, hovered: bool) -> None:
if not isinstance(item, HotkeyDetailItem):
return
if item in self.__edit_containers and not self.__key_editors[item].visible:
self.__edit_containers[item].visible = hovered or item in self.__last_selections
def __show_key_editor(self, tool_container: ui.HStack, key_editor: KeyEditor) -> None:
async def __show_editor():
# Wait a frame to not trigger show editor and drop down arrow at one click
await omni.kit.app.get_app().next_update_async()
key_editor.visible = True
tool_container.visible = False
asyncio.ensure_future(__show_editor())
def __on_key_cancelled(self, value: str, key_label: ui.Label, tool_container: ui.HStack):
key_label.text = value if value is not None else ""
tool_container.visible = True
def __on_delete(self, model: HotkeysModel, item: HotkeyDetailItem) -> None:
model.delete_hotkey_item(item)
def __on_hotkey_changed(self, event: carb.events.IEvent):
for helper in self.__reset_helpers.values():
if helper.filter_payload(event.payload):
break
| 8,512 | Python | 46.825842 | 176 | 0.607965 |
omniverse-code/kit/exts/omni.kit.hotkeys.window/omni/kit/hotkeys/window/tests/test_hotkeys_model.py | # pylint: disable=protected-access
from pathlib import Path
from typing import Tuple
from omni.ui.tests.test_base import OmniUiTest
import omni.kit.app
import omni.kit.test
import omni.ui as ui
from omni.kit.actions.core import get_action_registry
from omni.kit.hotkeys.core import get_hotkey_registry, KeyCombination, HotkeyRegistry
from ..window.hotkeys_window import HotkeysWindow
from ..model.hotkey_item import USER_HOTKEY_EXT_ID, HotkeyDetailItem
TEST_ACTION_EXT_ID = "test.hotkey.model"
TEST_ACTION_ID = "new"
TEST_ANOTHER_ACTION_ID = "another"
CURRENT_PATH = Path(__file__).parent
TEST_DATA_PATH = CURRENT_PATH.parent.parent.parent.parent.parent.joinpath("data").joinpath("tests")
class TestHotkeysModel(OmniUiTest):
async def setUp(self):
await super().setUp()
self._golden_img_dir = TEST_DATA_PATH.absolute().joinpath("golden_img").absolute()
# Hide original hotkeys window
self.__origin_hotkeys_window = ui.Workspace.get_window("Hotkeys")
self.__origin_hotkeys_window.visible = False
await omni.kit.app.get_app().next_update_async()
# Create new hotkeys window
self.__window = HotkeysWindow("Model")
await self.docked_test_window(window=self.__window, width=1280, height=400, block_devices=False)
self.__window._search_bar.visible = False
self._model = self.__window._hotkeys_model
self.__register_actions()
self.__action_executed = 0
self.__model_changed = 0
async def tearDown(self):
self._action_registry.deregister_all_actions_for_extension(TEST_ACTION_EXT_ID)
self._hotkey_registry.deregister_all_hotkeys_for_extension(USER_HOTKEY_EXT_ID)
self._hotkey_registry.clear_storage()
self.__window.visible = False
self.__window.destroy()
self.__window = None
self.__origin_hotkeys_window.visible = True
await super().tearDown()
async def test_1_add_global_empty_hotkey(self):
await self.__add_empty_global_hotkey()
# Wait for icons loaded
for _ in range(10):
await omni.kit.app.get_app().next_update_async()
await self.finalize_test(golden_img_dir=self._golden_img_dir, golden_img_name="hotkeys_model_add_global_empty.png", threshold=.03)
async def test_2_save_global_empty_hotkey(self):
(item, _) = await self.__add_save_empty_global_hotkey(KeyCombination("N"))
await self.__wait_for_icons()
self._model.execute(item)
self.assertEqual(self.__action_executed, 1)
self.assertEqual(self._model.get_item_by_key(KeyCombination("N"), None).hotkey, item.hotkey)
self.assertIsNone(self._model.get_item_by_key(KeyCombination("A"), None))
await self.finalize_test(golden_img_dir=self._golden_img_dir, golden_img_name="hotkeys_model_save_global_empty.png", threshold=.03)
async def test_3_delete_global_hotkey(self):
await self.__add_save_empty_global_hotkey(KeyCombination("N"))
filter_items = self._model.get_item_children(None)
global_filter_item = filter_items[0]
hotkey_items = self._model.get_item_children(global_filter_item)
self._model.delete_hotkey_item(hotkey_items[0])
await omni.kit.app.get_app().next_update_async()
await self.finalize_test(golden_img_dir=self._golden_img_dir, golden_img_name="hotkeys_model_delete_global_empty.png", threshold=.03)
async def test_4_edit_global_hotkey(self):
await self.__add_save_edit_empty_global_hotkey(KeyCombination("N"))
# Wait for icons loaded
for _ in range(10):
await omni.kit.app.get_app().next_update_async()
await self.finalize_test(golden_img_dir=self._golden_img_dir, golden_img_name="hotkeys_model_edit_global_empty.png", threshold=.03)
async def test_5_retore_global_hotkey(self):
await self.__add_save_edit_empty_global_hotkey(KeyCombination("N"))
model = self.__window._hotkeys_model
filter_items = model.get_item_children(None)
global_filter_item = filter_items[0]
hotkey_items = model.get_item_children(global_filter_item)
model.restore_item_key(hotkey_items[0])
await self.__wait_for_icons()
await self.finalize_test(golden_img_dir=self._golden_img_dir, golden_img_name="hotkeys_model_restore_global_hotkey.png", threshold=.03)
async def test_6_add_window_filter(self):
await self.__add_window_filter()
await self.finalize_test(golden_img_dir=self._golden_img_dir, golden_img_name="hotkeys_model_add_window_filter.png", threshold=.03)
async def test_7_edit_window_filter(self):
result = await self.__add_save_window_filter(KeyCombination("T"))
self.assertEqual(result, HotkeyRegistry.Result.OK)
await self.__wait_for_icons()
await self.finalize_test(golden_img_dir=self._golden_img_dir, golden_img_name="hotkeys_model_edit_window_filter.png", threshold=.03)
async def test_8_save_global_duplicated(self):
key_combination = KeyCombination("T")
(_, result) = await self.__add_save_empty_global_hotkey(key_combination)
self.assertEqual(result, HotkeyRegistry.Result.OK)
(item, result) = await self.__add_save_empty_global_hotkey(key_combination, action=self._another_action)
self.assertEqual(result, HotkeyRegistry.Result.ERROR_KEY_DUPLICATED)
model = self.__window._hotkeys_model
duplicated_key = self._hotkey_registry.get_hotkey_for_filter(key_combination, item.hotkey.filter)
model.replace_item_key(key_combination, item, duplicated_key)
await self.__wait_for_icons()
await self.finalize_test(golden_img_dir=self._golden_img_dir, golden_img_name="hotkeys_model_save_global_duplicated.png", threshold=.03)
async def test_clear_empty_hotkey(self):
def __on_model_changed(m, i):
self.__model_changed += 1
sub = self._model.subscribe_item_changed_fn(__on_model_changed) # noqa: PLW0612
# No empty hotkey, nothing happens
self._model.clear_empty_hotkey()
self.assertEqual(self.__model_changed, 0)
# Add a empty hotkey then clear
filter_items = self._model.get_item_children(None)
window_filter_item = filter_items[1]
added_item = self._model.add_empty_hotkey(window_filter_item)
self.assertIsNotNone(added_item)
self.assertEqual(self.__model_changed, 1)
await omni.kit.app.get_app().next_update_async()
self._model.clear_empty_hotkey()
await omni.kit.app.get_app().next_update_async()
self.assertEqual(self.__model_changed, 2)
sub = None # noqa: F841
async def __add_window_filter(self):
model = self.__window._hotkeys_model
model.add_window_filter()
await omni.kit.app.get_app().next_update_async()
async def __add_save_window_filter(self, key_combination) -> HotkeyRegistry.Result:
await self.__add_window_filter()
model = self.__window._hotkeys_model
filter_items = model.get_item_children(None)
window_filter_item = filter_items[1]
model.edit_hotkey_filter_item(window_filter_item, window_title="Hotkeys")
model.add_empty_hotkey(window_filter_item)
model.save_empty_action(self._new_action)
result = model.save_empty_hotkey(key_combination)
await omni.kit.app.get_app().next_update_async()
return result
async def __add_empty_global_hotkey(self) -> HotkeyDetailItem:
model = self.__window._hotkeys_model
filter_items = model.get_item_children(None)
global_filter_item = filter_items[0]
item = model.add_empty_hotkey(global_filter_item)
await omni.kit.app.get_app().next_update_async()
return item
async def __add_save_empty_global_hotkey(self, key_combination, action=None) -> Tuple[HotkeyDetailItem, HotkeyRegistry.Result]:
item = await self.__add_empty_global_hotkey()
model = self.__window._hotkeys_model
if action is None:
action = self._new_action
model.save_empty_action(action)
result = model.save_empty_hotkey(key_combination)
await omni.kit.app.get_app().next_update_async()
return (item, result)
async def __add_save_edit_empty_global_hotkey(self, key_combination) -> Tuple[HotkeyDetailItem, HotkeyRegistry.Result]:
(item, result) = await self.__add_save_empty_global_hotkey(key_combination)
model = self.__window._hotkeys_model
filter_items = model.get_item_children(None)
global_filter_item = filter_items[0]
hotkey_items = model.get_item_children(global_filter_item)
result = model.edit_hotkey_item(hotkey_items[0], key_text="P")
await omni.kit.app.get_app().next_update_async()
return (item, result)
def __register_actions(self):
self._action_registry = get_action_registry()
self._new_action = self._action_registry.register_action(
TEST_ACTION_EXT_ID,
TEST_ACTION_ID,
self._test_action,
display_name="Model test",
description="MODEL TEST",
tag="Actions",
)
self._another_action = self._action_registry.register_action(
TEST_ACTION_EXT_ID,
TEST_ANOTHER_ACTION_ID,
lambda: None,
display_name="Another model test",
description="ANOTHER MODEL TEST",
tag="Actions",
)
self._hotkey_registry = get_hotkey_registry()
async def __wait_for_icons(self):
for _ in range(10):
await omni.kit.app.get_app().next_update_async()
def _test_action(self):
self.__action_executed += 1
| 9,783 | Python | 42.292035 | 144 | 0.660125 |
omniverse-code/kit/exts/omni.kit.hotkeys.window/omni/kit/hotkeys/window/tests/test_windows_picker.py | import omni.kit.app
from omni.kit.test import AsyncTestCase
from ..window.windows_picker import WindowsPicker
class TestWindowsPicker(AsyncTestCase):
async def setUp(self):
self._selected_title = ""
async def test_general(self):
def on_selected(window_title: str):
self._selected_title = window_title
window = WindowsPicker(width=800, height=600, on_selected_fn=on_selected)
for _ in range(4):
await omni.kit.app.get_app().next_update_async()
window._search_field.search_words = ["hot"] # noqa: PLW0212
await omni.kit.app.get_app().next_update_async()
items = window._windows_model.get_item_children() # noqa: PLW0212
window._actions_view.selection = [item for item in items if item.window_title == "Hotkeys"] # noqa: PLW0212
await omni.kit.app.get_app().next_update_async()
self.assertEqual(self._selected_title, "Hotkeys")
| 953 | Python | 35.692306 | 118 | 0.655824 |
omniverse-code/kit/exts/omni.kit.hotkeys.window/omni/kit/hotkeys/window/tests/__init__.py | from .test_hotkeys_window import *
from .test_hotkeys_model import *
from .test_options_menu import *
from .test_warning_window import *
from .test_windows_model import *
from .test_windows_picker import *
| 206 | Python | 28.571424 | 34 | 0.76699 |
omniverse-code/kit/exts/omni.kit.hotkeys.window/omni/kit/hotkeys/window/tests/test_windows_model.py | from omni.kit.test import AsyncTestCase
from ..model.windows_model import WindowsModel
class TestWindowsModel(AsyncTestCase):
async def setUp(self):
pass
async def tearDown(self):
pass
async def test_model(self):
model = WindowsModel("Hotkeys")
self.assertEqual(model.get_item_value_model_count(), 1)
items = model.get_item_children()
self.assertEqual(model.get_item_value_model(None), "")
self.assertEqual(model.get_item_value_model(items[1]).as_string, items[1].window_title)
self.assertEqual(model.get_item_children(items[0]), [])
self.assertTrue("Hotkeys" in [item.window_title for item in items])
self.assertEqual(model.selected_windows, ["Hotkeys"])
# Note, there will always be "" as first item
# Search a window
model.search(["hot"])
items = model.get_item_children()
print([w.window_title for w in items])
self.assertEqual(len(items), 2)
# Search a un-exist window
model.search(["un-exist"])
items = model.get_item_children()
self.assertEqual(len(items), 1)
| 1,146 | Python | 32.735293 | 95 | 0.638743 |
omniverse-code/kit/exts/omni.kit.hotkeys.window/omni/kit/hotkeys/window/tests/test_options_menu.py | from unittest.mock import patch
import omni.kit.app
import omni.ui as ui
from omni.kit.ui_test.query import MenuRef, WindowRef
import omni.kit.ui_test as ui_test
from omni.ui.tests.test_base import OmniUiTest
class TestOptionsMenu(OmniUiTest):
async def setUp(self):
await super().setUp()
window = ui.Workspace.get_window("Hotkeys")
window.visible = True # just in case another test has turned it off
await self.docked_test_window(window=window, width=1280, height=800, block_devices=False)
window._search_bar._SearchBar__show_options() # noqa: PLW0212
self._menu = window._search_bar._SearchBar__options_menu # noqa: PLW0212
await omni.kit.app.get_app().next_update_async()
menu_ref = MenuRef(self._menu._OptionsMenu__context_menu, "") # noqa: PLW0212
self._menu_items = menu_ref.find_all("**/")
async def test_import(self):
"""Test import hotkey preset"""
self.assertEqual(self._menu_items[0].widget.text, "Import Preset")
await self._menu_items[0].click()
for _ in range(4):
await omni.kit.app.get_app().next_update_async()
dialog = self._menu._OptionsMenu__import_dialog # noqa: PLW0212
self.assertIsNotNone(dialog)
dialog.set_current_directory("test")
dialog.set_filename("test_import.json")
import_window = ui.Workspace.get_window("Import")
window_ref = WindowRef(import_window, "")
import_btn_ref = window_ref.find_all("**/Button[*].text=='import'")[0]
with (
patch("omni.client.stat", side_effect=self._mock_stat_file_impl),
patch("omni.kit.hotkeys.core.HotkeyRegistry.import_storage") as mock_import
):
await import_btn_ref.click()
mock_import.assert_called_once()
async def test_export(self):
"""Test export hotkey presets"""
self.assertEqual(self._menu_items[1].widget.text, "Export Preset")
await self._menu_items[1].click()
for _ in range(4):
await omni.kit.app.get_app().next_update_async()
dialog = self._menu._OptionsMenu__export_dialog # noqa: PLW0212
self.assertIsNotNone(dialog)
dialog.set_current_directory("test")
dialog.set_filename("test_import.json")
export_window = ui.Workspace.get_window("Export As")
window_ref = WindowRef(export_window, "")
export_btn_ref = window_ref.find_all("**/Button[*].text=='Export'")[0]
with (
patch("omni.client.stat", side_effect=self._mock_stat_file_not_found_impl),
patch("omni.kit.hotkeys.core.HotkeyRegistry.export_storage") as mock_export
):
await export_btn_ref.click()
mock_export.assert_called_once()
async def test_restore(self):
"""Test restore hotkeys defaults"""
self.assertEqual(self._menu_items[2].widget.text, "Restore Defaults")
await self._menu_items[2].click()
for _ in range(4):
await omni.kit.app.get_app().next_update_async()
warning_window = ui.Workspace.get_window("###Hotkey_WARNING_Restore Defaults")
window_ref = WindowRef(warning_window, "")
for _ in range(10):
await omni.kit.app.get_app().next_update_async()
btn_ref = window_ref.find_all("**/Button[*].text=='Yes'")[0]
with patch("omni.kit.hotkeys.core.HotkeyRegistry.restore_defaults") as mock_restore:
await btn_ref.click()
mock_restore.assert_called_once()
async def test_layout(self):
"""Test switching keyboard layout"""
self.assertEqual(self._menu_items[3].widget.text, "Keyboard Layouts")
await ui_test.emulate_mouse_move(self._menu_items[3].center)
layout_menu_items = self._menu_items[3].find_all("**/")
with patch("omni.kit.hotkeys.core.HotkeyRegistry.switch_layout") as mock_switch_layout:
await layout_menu_items[0].click()
mock_switch_layout.assert_called_once()
def _mock_stat_file_impl(self, url: str):
return (omni.client.Result.OK, None)
def _mock_stat_file_not_found_impl(self, url: str):
return (omni.client.Result.ERROR_NOT_FOUND, None)
| 4,268 | Python | 36.778761 | 97 | 0.627226 |
omniverse-code/kit/exts/omni.kit.hotkeys.window/omni/kit/hotkeys/window/tests/test_hotkeys_window.py | from pathlib import Path
from omni.kit.actions.core import get_action_registry
import omni.kit.app
import omni.kit.test
from omni.ui.tests.test_base import OmniUiTest
from omni.kit.hotkeys.core import get_hotkey_registry, HotkeyFilter
import omni.ui as ui
import omni.kit.ui_test as ui_test
from omni.kit.ui_test import Vec2
CURRENT_PATH = Path(__file__).parent
TEST_DATA_PATH = CURRENT_PATH.parent.parent.parent.parent.parent.joinpath("data").joinpath("tests")
ACTION_SHOW_WINDOW = "Show"
ACTION_HIDE_WINDOW = "Hide"
class TestHotkeysWindow(OmniUiTest):
async def setUp(self):
await super().setUp()
self._golden_img_dir = TEST_DATA_PATH.absolute().joinpath("golden_img").absolute()
self._action_registry = None
self._ext_id = "hotkeys"
self.__register_test_hotkeys()
window = ui.Workspace.get_window("Hotkeys")
window.visible = True # just in case another test has turned it off
await self.docked_test_window(window=window, width=1280, height=400, block_devices=False)
async def tearDown(self):
# Deregister all the test hotkeys
self._hotkey_registry.deregister_hotkey(self._ext_id, "CTL+S")
self._hotkey_registry.deregister_hotkey(self._ext_id, "ALT+H")
# Deregister all the test actions.
self._action_registry.deregister_action(self._ext_id, ACTION_SHOW_WINDOW)
self._action_registry.deregister_action(self._ext_id, ACTION_HIDE_WINDOW)
self._action_registry = None
async def test_1_general_window(self):
# When startup, no actions loaded
# Expand
await ui_test.emulate_mouse_move_and_click(Vec2(13, 67))
for _ in range(10):
await omni.kit.app.get_app().next_update_async()
await self.finalize_test(golden_img_dir=self._golden_img_dir, golden_img_name="test_hotkey_window_general_with_search.png")
async def test_2_search(self):
# Actions reloaded, we can see register actions now
# Focus on search bar
await ui_test.emulate_mouse_move_and_click(Vec2(50, 17))
# Search "Show"
await ui_test.emulate_char_press("Show\n")
await ui_test.emulate_mouse_move_and_click(Vec2(0, 0))
await self.finalize_test(golden_img_dir=self._golden_img_dir, golden_img_name="test_hotkey_window_search.png")
async def test_3_search_clean(self):
# Focus on search bar
await ui_test.emulate_mouse_move_and_click(Vec2(50, 17))
# Clean search
await ui_test.emulate_mouse_move_and_click(Vec2(1214, 17))
await ui_test.emulate_mouse_move_and_click(Vec2(0, 0))
await self.finalize_test(golden_img_dir=self._golden_img_dir, golden_img_name="test_hotkey_window_search_clean.png")
def __register_test_hotkeys(self):
self._action_registry = get_action_registry()
self._action_registry.register_action(
self._ext_id,
ACTION_SHOW_WINDOW,
lambda: None,
display_name=ACTION_SHOW_WINDOW,
description=ACTION_SHOW_WINDOW,
tag="Actions",
)
self._action_registry.register_action(
self._ext_id,
ACTION_HIDE_WINDOW,
lambda: None,
display_name=ACTION_HIDE_WINDOW,
description=ACTION_HIDE_WINDOW,
tag="Actions",
)
self._context_filter = HotkeyFilter(context="Test Context")
self._window_filter = HotkeyFilter(windows=["Viewport"])
self._hotkey_registry = get_hotkey_registry()
self._hotkey_registry.register_hotkey(self._ext_id, "CTL+S", self._ext_id, ACTION_SHOW_WINDOW)
self._hotkey_registry.register_hotkey(self._ext_id, "ALT+H", self._ext_id, ACTION_HIDE_WINDOW)
self._hotkey_registry.register_hotkey(self._ext_id, "H", self._ext_id, ACTION_HIDE_WINDOW, filter=self._context_filter)
self._hotkey_registry.register_hotkey(self._ext_id, "S", self._ext_id, ACTION_SHOW_WINDOW, filter=self._context_filter)
self._hotkey_registry.register_hotkey(self._ext_id, "H", self._ext_id, ACTION_HIDE_WINDOW, filter=self._window_filter)
self._hotkey_registry.register_hotkey(self._ext_id, "S", self._ext_id, ACTION_SHOW_WINDOW, filter=self._window_filter)
| 4,275 | Python | 41.76 | 131 | 0.660819 |
omniverse-code/kit/exts/omni.kit.hotkeys.window/omni/kit/hotkeys/window/tests/test_warning_window.py | from pathlib import Path
from omni.ui.tests.test_base import OmniUiTest
import omni.kit.app
import omni.kit.test
import omni.ui as ui
from ..window.warning_window import WarningWindow, WarningMessage
CURRENT_PATH = Path(__file__).parent
TEST_DATA_PATH = CURRENT_PATH.parent.parent.parent.parent.parent.joinpath("data").joinpath("tests")
class TestWarningWindow(OmniUiTest):
async def setUp(self):
await super().setUp()
self._golden_img_dir = TEST_DATA_PATH.absolute().joinpath("golden_img").absolute()
self.__window = None
# Hide hotkeys window
window = ui.Workspace.get_window("Hotkeys")
window.visible = False
await omni.kit.app.get_app().next_update_async()
async def tearDown(self):
self.__window.visible = False
self.__window = None
await super().tearDown()
async def test_simple(self):
self.__window = WarningWindow("Test", messages=["This is a simple test menssage."])
await omni.kit.app.get_app().next_update_async()
await self.docked_test_window(window=self.__window, width=self.__window.width + 10, height=100, block_devices=False)
await self.finalize_test(golden_img_dir=self._golden_img_dir, golden_img_name="warning_simple.png")
async def test_advanced(self):
self.__window = WarningWindow(
"Test",
messages=[
WarningMessage("'CTRL + O (On Press_'", highlight=True),
WarningMessage(" is already assigned to "),
WarningMessage("'Open'", highlight=True),
"\n",
"Do you want to replace this existing hotkey with your new one?"
],
buttons=[
("Replace", lambda: print("Replace")),
("Cancel", lambda: print("Cancel"))
]
)
await omni.kit.app.get_app().next_update_async()
await self.docked_test_window(window=self.__window, width=self.__window.width + 10, height=160, block_devices=False)
# Because it takes time to load the icon in the warning window
for _ in range(5):
await omni.kit.app.get_app().next_update_async()
await self.finalize_test(golden_img_dir=self._golden_img_dir, golden_img_name="warning_advanced.png")
| 2,307 | Python | 38.118643 | 124 | 0.623754 |
omniverse-code/kit/exts/omni.kit.stage.copypaste/omni/kit/stage/copypaste/prim_serializer.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.
#
__all__ = ["update_property_paths", "get_prim_as_text", "text_to_stage"]
import sys
from typing import Callable
from typing import List
from typing import Optional
from typing import Tuple
from omni.kit.commands import execute
from pxr import Sdf
from pxr import Tf
from pxr import Usd
import omni.usd
POS_ATTR_NAME = 'ui:nodegraph:node:pos'
SMALL_OFFSET = 40
def _to_layer(text: str, keep_inputs=True, position=None) -> Optional[Sdf.Layer]:
"""Create an sdf layer from the given text"""
if not text.startswith("#usda 1.0\n"):
text = "#usda 1.0\n" + text
anonymous_layer = Sdf.Layer.CreateAnonymous("clipboard.usda")
try:
if not anonymous_layer.ImportFromString(text):
return None
except Tf.ErrorException:
return None
if not keep_inputs or position is not None:
graph_node_processing(anonymous_layer, keep_inputs=keep_inputs, position=position)
return anonymous_layer
def graph_node_processing(layer: Sdf.Layer, keep_inputs=True, position=None):
all_prims = []
min_x, min_y = sys.maxsize, sys.maxsize
offset = None
root_prims = layer.rootPrims
for prim_spec in root_prims:
root_spec = prim_spec.nameChildren[0]
all_prims.append(root_spec.path)
if position is not None and POS_ATTR_NAME in root_spec.attributes:
# Keep top left of bounding box of nodes
pos = root_spec.attributes[POS_ATTR_NAME].default
if pos[0] < min_x:
min_x = pos[0]
if pos[1] < min_y:
min_y = pos[1]
if position is not None:
offset = (position[0] - min_x, position[1] - min_y)
for prim_path in all_prims:
prim_spec = layer.GetPrimAtPath(prim_path)
attrs = prim_spec.attributes
if POS_ATTR_NAME in attrs:
offset_node_position(attrs[POS_ATTR_NAME], offset=offset)
if not keep_inputs:
for attr in attrs:
connections = attr.connectionPathList.explicitItems
if connections:
attr.connectionPathList.explicitItems = [
path for path in attr.connectionPathList.explicitItems
if connections[0].GetPrimPath() in all_prims
]
def offset_node_position(pos_attr: Sdf.AttributeSpec, offset: Optional[Tuple[float, float]] = None):
"""Shift the nodes to be pasted, by the offset parameter, or if no offset is
passed in, by a small offset, so pasted nodes are not exactly on top of the originals.
Args:
pos_attr (Sdf.AttributeSpec): AttributeSpec to get the existing position from.
offset (Tuple[float, float], optional): Offset to place at mouse position. Defaults to None.
"""
cur_position = pos_attr.default
if offset is not None:
pos_attr.default = (cur_position[0] + offset[0], cur_position[1] + offset[1])
else:
pos_attr.default = (cur_position[0] + SMALL_OFFSET, cur_position[1] + SMALL_OFFSET)
def update_property_paths(prim_spec, old_path, new_path):
if not prim_spec:
return
for rel in prim_spec.relationships:
rel.targetPathList.explicitItems = [
path.ReplacePrefix(old_path, new_path) for path in rel.targetPathList.explicitItems
]
for attr in prim_spec.attributes:
attr.connectionPathList.explicitItems = [
path.ReplacePrefix(old_path, new_path) for path in attr.connectionPathList.explicitItems
]
for child in prim_spec.nameChildren:
update_property_paths(child, old_path, new_path)
def get_prim_as_text(stage: Usd.Stage, prim_paths: List[Sdf.Path]) -> Optional[str]:
"""Generate a text representation from the stage and prim path"""
if not prim_paths:
return None
prim_paths = [Sdf.Path(path) for path in prim_paths]
prim_paths = Sdf.Path.RemoveDescendentPaths(prim_paths)
# flatten_layer = stage.Flatten()
# Stitches prims instead of flattening to avoid flattening references and payloads.
flatten_layer = Sdf.Layer.CreateAnonymous()
for prim_path in prim_paths:
omni.usd.stitch_prim_specs(stage, prim_path, flatten_layer)
paths_map = {}
anonymous_layer = Sdf.Layer.CreateAnonymous(prim_paths[0].name + ".usda")
for i, prim_path in enumerate(prim_paths):
item_name = str.format("Item_{:02d}", i)
Sdf.PrimSpec(anonymous_layer, item_name, Sdf.SpecifierDef)
anonymous_path = Sdf.Path.absoluteRootPath.AppendChild(item_name).AppendChild(prim_path.name)
# Copy
Sdf.CopySpec(flatten_layer, prim_path, anonymous_layer, anonymous_path)
paths_map[prim_path] = anonymous_path
for prim in anonymous_layer.rootPrims:
for source_path, target_path in paths_map.items():
update_property_paths(prim, source_path, target_path)
return anonymous_layer.ExportToString()
def text_to_stage(stage: Usd.Stage, text: str, root: Sdf.Path = Sdf.Path.absoluteRootPath,
keep_inputs=True, position=None, filter_fn: Optional[Callable] = None) -> bool:
"""
Convert the given text to prims and place them on the stage under the
given root.
"""
source_layer = _to_layer(text, keep_inputs=keep_inputs, position=position)
if not source_layer:
return False
execute("ImportLayer", layer=source_layer, stage=stage, root=root,
filter_fn=filter_fn)
return True
| 5,899 | Python | 34.329341 | 101 | 0.666045 |
omniverse-code/kit/exts/omni.kit.stage.copypaste/omni/kit/stage/copypaste/usdstage_helper.py | # Copyright (c) 2018-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.
#
__all__ = ["UsdStageHelper"]
from typing import Optional
from pxr import Usd
from pxr import UsdUtils
class UsdStageHelper:
"""Keeps the stage ID or returns the stage from the current context"""
def __init__(self, stage: Usd.Stage):
if stage:
# Keep ID so the command doesn't prevent the stage from closing.
self.__stage_id = UsdUtils.StageCache.Get().GetId(stage).ToLongInt()
else:
self.__stage_id = None
def _get_stage(self) -> Optional[Usd.Stage]:
if self.__stage_id:
# Get the stage from ID
cache = UsdUtils.StageCache.Get()
stage = cache.Find(Usd.StageCache.Id.FromLongInt(self.__stage_id))
return stage
# Get the stage from the context
import omni.usd
return omni.usd.get_context().get_stage()
| 1,285 | Python | 32.842104 | 80 | 0.676265 |
omniverse-code/kit/exts/omni.kit.stage.copypaste/omni/kit/stage/copypaste/stage_copypaste_extension.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.
#
__all__ = ["StageCopypasteExtension"]
from typing import Optional
# from carb.input import KEYBOARD_MODIFIER_FLAG_CONTROL as CTRL
# from carb.input import KeyboardInput as Key
from pxr import Sdf
import carb
import omni.ext
import omni.kit.context_menu
import omni.usd
from omni.kit.actions.core import get_action_registry
# from .hotkey import Hotkey
from .prim_serializer import get_prim_as_text, text_to_stage
_HOTKEYS_EXT = "omni.kit.hotkeys.core"
_DEFAULT_HOTKEY_MAP = {
"stage_copy": "CTRL+C",
"stage_paste": "CTRL+V",
}
class StageCopypasteExtension(omni.ext.IExt):
def __init__(self):
super().__init__()
self._ext_name = None
self._stage_menu = None
self._stage_context_menu_copy = None
self._stage_context_menu_paste = None
self._hotkey_extension_enabled_hook = None
self._hotkey_extension_disabled_hook = None
def on_startup(self, ext_id):
self._ext_name = omni.ext.get_extension_name(ext_id)
# Hooks to hotkey extension enable/disable
app = omni.kit.app.get_app_interface()
ext_manager = app.get_extension_manager()
hooks: omni.ext.IExtensionManagerHooks = ext_manager.get_hooks()
self._hotkey_extension_enabled_hook = hooks.create_extension_state_change_hook(
self._on_hotkey_ext_changed,
omni.ext.ExtensionStateChangeType.AFTER_EXTENSION_ENABLE,
ext_name="omni.kit.hotkeys.core",
)
self._hotkey_extension_disabled_hook = hooks.create_extension_state_change_hook(
self._on_hotkey_ext_changed,
omni.ext.ExtensionStateChangeType.AFTER_EXTENSION_DISABLE,
ext_name="omni.kit.hotkeys.core",
)
self.register_actions(self._ext_name)
self.register_hotkeys(self._ext_name)
self._stage_menu = ext_manager.subscribe_to_extension_enable(
on_enable_fn=lambda _: self._register_stage_menu(),
on_disable_fn=lambda _: self._unregister_stage_menu(),
ext_name="omni.kit.widget.stage",
hook_name="omni.kit.stage.copypaste",
)
def on_shutdown(self):
self._stage_menu = None
self._stage_context_menu_copy = None
self._stage_context_menu_paste = None
self._hotkey_extension_enabled_hook = None
self._hotkey_extension_disabled_hook = None
self.deregister_hotkeys(self._ext_name)
self.deregister_actions(self._ext_name)
def register_actions(self, extension_id: str):
action_registry = get_action_registry()
actions_tag = "Stage Copy/Paste Actions"
action_registry.register_action(
extension_id,
"stage_copy",
self._on_copy,
display_name="Copy",
description="Copy objects in the stage",
tag=actions_tag,
)
action_registry.register_action(
extension_id,
"stage_paste",
self._on_paste,
display_name="Paste",
description="Paste objects in the stage",
tag=actions_tag,
)
def deregister_actions(self, extension_id):
action_registry = get_action_registry()
action_registry.deregister_all_actions_for_extension(extension_id)
def register_hotkeys(self, extension_id: str, window_name: Optional[str] = None):
ext_manager = omni.kit.app.get_app_interface().get_extension_manager()
if not ext_manager.is_extension_enabled(_HOTKEYS_EXT):
carb.log_info(f"{_HOTKEYS_EXT} is not enabled. Cannot register hotkeys.")
return
import omni.kit.hotkeys.core as hotkeys
hotkey_registry = hotkeys.get_hotkey_registry()
action_registry = get_action_registry()
ext_actions = action_registry.get_all_actions_for_extension(extension_id)
hotkey_filter = hotkeys.HotkeyFilter(windows=[window_name]) if window_name else None
for action in ext_actions:
key = _DEFAULT_HOTKEY_MAP.get(action.id, None)
# Not all Actions will have default hotkeys
if not key:
continue
hotkey_registry.register_hotkey(
hotkey_ext_id=extension_id,
key=key,
action_ext_id=action.extension_id,
action_id=action.id,
filter=hotkey_filter,
)
def deregister_hotkeys(self, extension_id: str):
ext_manager = omni.kit.app.get_app_interface().get_extension_manager()
if not ext_manager.is_extension_enabled(_HOTKEYS_EXT):
carb.log_info(f"{_HOTKEYS_EXT} is not enabled. No hotkeys to deregister.")
return
import omni.kit.hotkeys.core as hotkeys
hotkey_registry = hotkeys.get_hotkey_registry()
hotkey_registry.deregister_all_hotkeys_for_extension(extension_id)
def _on_hotkey_ext_changed(self, ext_id: str, ext_change_type: omni.ext.ExtensionStateChangeType):
if ext_change_type == omni.ext.ExtensionStateChangeType.AFTER_EXTENSION_ENABLE:
self.register_hotkeys(self._ext_name)
if ext_change_type == omni.ext.ExtensionStateChangeType.AFTER_EXTENSION_DISABLE:
self.deregister_hotkeys(self._ext_name)
def _on_copy(self):
"""Called when the user pressed Ctrl-C"""
# Get the selected paths
usd_context = omni.usd.get_context()
stage = usd_context.get_stage()
selection = usd_context.get_selection()
paths = [Sdf.Path(name) for name in selection.get_selected_prim_paths()]
prim_as_text = get_prim_as_text(stage, paths)
if prim_as_text:
omni.kit.clipboard.copy(prim_as_text)
def _on_paste(self, keep_inputs=True, root=None, position=None, filter_fn=None):
"""Called when the user pressed Ctrl-V"""
def get_root_prims(stage):
"""Get the root layer prims visible in the stage window"""
all_roots = stage.GetPseudoRoot().GetChildren()
return [p for p in all_roots if p.GetMetadata("hide_in_stage_window") is not True]
text = omni.kit.clipboard.paste()
if not text:
# Silent return
return
usd_context = omni.usd.get_context()
stage = usd_context.get_stage()
if not root:
# Pick the root. If we have the only root prim and it's the default
# one, we need to paste in this prim. For example "/World".
root = Sdf.Path.absoluteRootPath
if len(get_root_prims(stage)) == 1:
default_prim = stage.GetDefaultPrim()
if default_prim:
root = default_prim.GetPath()
if not text_to_stage(stage, text, root, keep_inputs=keep_inputs, position=position,
filter_fn=filter_fn):
carb.log_warn("The clipboard doesn't have usda")
def _register_stage_menu(self):
"""Called when "omni.kit.widget.stage" is loaded"""
def on_copy(objects: dict):
"""Called from the context menu"""
prims = objects.get("prim_list", None)
stage = objects.get("stage", None)
if not prims or not stage:
return
paths = [p.GetPath() for p in prims]
prim_as_text = get_prim_as_text(stage, paths)
if prim_as_text:
omni.kit.clipboard.copy(prim_as_text)
def on_paste(objects: dict):
"""Called from the context menu"""
text = omni.kit.clipboard.paste()
if not text:
# Silent return
return
stage = objects.get("stage", None)
if not stage:
return
prims = objects.get("prim_list", None)
if not prims:
root = Sdf.Path.absoluteRootPath
elif len(prims) == 1:
root = prims[0].GetPath()
else:
carb.log_warn("Can't paste to multiple locations")
return
if not text_to_stage(stage, text, root):
carb.log_warn("The clipboard doesn't have usda")
# Add context menu to omni.kit.widget.stage
context_menu = omni.kit.context_menu.get_instance()
if context_menu:
menu = {
"name": "Copy Prim",
"glyph": "menu_link.svg",
"show_fn": [context_menu.is_prim_selected],
"onclick_fn": on_copy,
"appear_after": "Copy Prim Path",
}
self._stage_context_menu_copy = omni.kit.context_menu.add_menu(menu, "MENU", "omni.kit.widget.stage")
menu = {"name": "Paste Prim", "glyph": "menu_link.svg", "onclick_fn": on_paste, "appear_after": "Copy Prim"}
self._stage_context_menu_paste = omni.kit.context_menu.add_menu(menu, "MENU", "omni.kit.widget.stage")
def _unregister_stage_menu(self):
"""Called when "omni.kit.widget.stage" is unloaded"""
self._stage_context_menu_copy = None
self._stage_context_menu_paste = None
| 9,582 | Python | 36.580392 | 120 | 0.605823 |
omniverse-code/kit/exts/omni.kit.stage.copypaste/omni/kit/stage/copypaste/hotkey.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.
#
__all__ = ["Hotkey"]
from functools import partial
import carb.input
import omni.appwindow
class Hotkey:
"""
Bind a hotkey to the given callback. The hotkey is active while the
object is alive.
"""
def __init__(self, action_name, hotkey, modifier, on_action_fn):
self._input = carb.input.acquire_input_interface()
settings = carb.settings.get_settings()
# TODO: bind to all app windows
appwindow = omni.appwindow.get_default_app_window()
action_mapping_set_path = appwindow.get_action_mapping_set_path()
action_mapping_set = self._input.get_action_mapping_set_by_path(action_mapping_set_path)
input_string = carb.input.get_string_from_action_mapping_desc(hotkey, modifier)
input_path = action_mapping_set_path + "/" + action_name + "/0"
settings.set_default_string(input_path, input_string)
def action_trigger(on_action_fn, evt, *_):
if not evt.flags & carb.input.BUTTON_FLAG_PRESSED:
return
on_action_fn()
self._sub = self._input.subscribe_to_action_events(
action_mapping_set, action_name, partial(action_trigger, on_action_fn)
)
def __del__(self):
self._input.unsubscribe_to_action_events(self._sub)
| 1,721 | Python | 35.638297 | 96 | 0.680999 |
omniverse-code/kit/exts/omni.kit.stage.copypaste/omni/kit/stage/copypaste/stage_copypaste_commands.py | # Copyright (c) 2018-2020, 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__ = ["ImportLayerCommand"]
import re
from typing import Callable
from typing import List
from typing import Optional
import carb
from omni.usd.commands import DeletePrimsCommand
from pxr import Sdf
from pxr import Usd
import omni.kit.commands
import omni.usd
from .usdstage_helper import UsdStageHelper
from .prim_serializer import update_property_paths
class ImportLayerCommand(omni.kit.commands.Command, UsdStageHelper):
"""
Import given layer to the given stage under the specific root.
### Arguments:
`layer : Sdf.Layer`
All the prims from this layer will be imported to the stage.
`root : Sdf.Path`
The new prims will be placed under this path.
`stage : Optional[int]`
The stage it's necessary to add the new prims. If None, it takes
the stage from the USD Context.
"""
def __init__(
self,
layer: Sdf.Layer,
root: Sdf.Path = Sdf.Path.absoluteRootPath,
stage: Optional[Usd.Stage] = None,
filter_fn: Optional[Callable] = None,
):
UsdStageHelper.__init__(self, stage)
self._layer = layer
self._root = root
self._created_paths: List[str] = []
self._selection: List[str] = []
self._filter_fn: Optional[Callable] = filter_fn
def do(self):
# Save selection
self._selection = omni.usd.get_context().get_selection().get_selected_prim_paths()
stage = self._get_stage()
target_layer = stage.GetEditTarget().GetLayer()
paths_map = {}
with Sdf.ChangeBlock():
for prim_spec in self._layer.rootPrims:
root_spec = prim_spec.nameChildren[0]
if self._filter_fn and not self._filter_fn(root_spec):
carb.log_warn(f"{root_spec.name} is not a valid prim type to paste here, ignoring.")
continue
prim_path = root_spec.path
prim_name = root_spec.name
target_path = get_layer_next_free_path(
stage, self._root.AppendChild(prim_name).pathString, False
)
# Copy to stage
Sdf.CopySpec(self._layer, prim_path, target_layer, target_path)
paths_map[prim_path] = target_path
self._created_paths.append(target_path)
for path in self._created_paths:
for source_path, target_path in paths_map.items():
update_property_paths(target_layer.GetPrimAtPath(path), source_path, target_path)
omni.usd.get_context().get_selection().set_selected_prim_paths(self._created_paths, True)
self._layer = None
def undo(self):
# Delete created
DeletePrimsCommand(self._created_paths).do()
# Restore selection
omni.usd.get_context().get_selection().set_selected_prim_paths(self._selection, False)
def get_layer_next_free_path(stage, path, prepend_default_prim, is_batch_editing=True):
"""This checks both in the stage and in the current edit target layer, since during
batch editing, the changes won't have made it to the usd stage yet."""
if prepend_default_prim and stage.HasDefaultPrim():
default_prim = stage.GetDefaultPrim()
if default_prim:
path = default_prim.GetPath().pathString + path
def increment_path(path):
match = re.search(r"_(\d+)$", path)
if match:
new_num = int(match.group(1)) + 1
ret = re.sub(r"_(\d+)$", str.format("_{:02d}", new_num), path)
else:
ret = path + "_01"
return ret
while stage.GetPrimAtPath(path):
path = increment_path(path)
if is_batch_editing:
layer = stage.GetEditTarget().GetLayer()
while layer.GetPrimAtPath(path):
path = increment_path(path)
return path
| 4,341 | Python | 33.188976 | 104 | 0.62451 |
omniverse-code/kit/exts/omni.kit.stage.copypaste/omni/kit/stage/copypaste/tests/test_copypaste.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.
#
from pxr import Sdf
from pxr import Usd
from pxr import UsdGeom
import omni.kit.test
import omni.usd
import omni.kit.undo
from ..prim_serializer import get_prim_as_text, _to_layer, text_to_stage
sdf_prim_to_text = """#usda 1.0
def "Item_00"
{
def Sphere "Sphere01"
{
}
}
"""
sdf_duplicate_name = """#usda 1.0
def "Item_00"
{
def Sphere "Sphere01"
{
}
}
def "Item_01"
{
def Sphere "Sphere01"
{
}
}
"""
sdf_preserve_relationships = """#usda 1.0
def "Item_00"
{
def Sphere "Sphere01"
{
custom rel test = </Item_01/Sphere02>
}
}
def "Item_01"
{
def Sphere "Sphere02"
{
}
}
"""
# This usda has 2 incoming connections on the first node, and an internal
# connection between the 2 nodes on the 2nd node.
delete_external_connections = """#usda 1.0
def "Item_00"
{
def OmniGraphNode "add_01" (
apiSchemas = ["NodeGraphNodeAPI"]
)
{
custom token inputs:a
token inputs:a.connect = </World/ActionGraph/add.outputs:sum>
custom token inputs:b
token inputs:b.connect = </World/ActionGraph/read_time.outputs:frame>
token node:type = "omni.graph.nodes.Add"
int node:typeVersion = 1
custom token outputs:sum
uniform float2 ui:nodegraph:node:pos = (617.9488, -19.670042)
}
}
def "Item_01"
{
def OmniGraphNode "scale_to_size_01" (
apiSchemas = ["NodeGraphNodeAPI"]
)
{
custom double inputs:speed = 1
double inputs:speed.connect = </Item_00/add_01.outputs:sum>
token node:type = "omni.graph.nodes.ScaleToSize"
uniform float2 ui:nodegraph:node:pos = (882.75476, 398.3356)
}
}
"""
class TestStageCopyPaste(omni.kit.test.AsyncTestCase):
async def test_prim_to_text(self):
"""Testing how only one prim can be converted to text"""
stage = Usd.Stage.CreateInMemory()
path = Sdf.Path("/Sphere01")
UsdGeom.Sphere.Define(stage, path)
UsdGeom.Sphere.Define(stage, "/Sphere02")
# Extract only one prim
result = get_prim_as_text(stage, [path])
# Linux line endings
result = "\n".join(result.splitlines())
self.assertEqual(result, sdf_prim_to_text)
async def test_text_to_stage(self):
"""Testing converting text to layer and import to stage"""
await omni.usd.get_context().new_stage_async()
stage = omni.usd.get_context().get_stage()
path = Sdf.Path("/Sphere01")
UsdGeom.Sphere.Define(stage, path)
UsdGeom.Xform.Define(stage, "/root_for_import")
import_root_prim = stage.GetPrimAtPath("/root_for_import")
# test that invalid text returns False
self.assertFalse(text_to_stage(stage, "asdf", root=import_root_prim.GetPath()))
self.assertFalse(import_root_prim.GetChildren())
# test import to specific root
text_to_stage(stage, sdf_prim_to_text, root=import_root_prim.GetPath())
self.assertEqual(len(import_root_prim.GetChildren()), 1)
child = import_root_prim.GetChildren()[0]
self.assertEqual(child.GetName(), "Sphere01")
omni.kit.undo.undo()
# test import to default root
text_to_stage(stage, sdf_prim_to_text)
self.assertFalse(import_root_prim.GetChildren())
imported = stage.GetPrimAtPath("/Item_00")
self.assertIsNotNone(imported)
omni.kit.undo.undo()
async def test_duplicate_name(self):
"""Testing the ability to copy two prims with the same name and different paths"""
stage = Usd.Stage.CreateInMemory()
path1 = Sdf.Path("/Sphere01")
UsdGeom.Sphere.Define(stage, path1)
path2 = Sdf.Path("/Parent/Sphere01")
UsdGeom.Sphere.Define(stage, path2)
# Serialize prims
result = get_prim_as_text(stage, [path1, path2])
# Linux line endings
result = "\n".join(result.splitlines())
self.assertEqual(result, sdf_duplicate_name)
async def test_preserve_relationships(self):
"""Testing relationship target updates when copying multiple prims"""
stage = Usd.Stage.CreateInMemory()
path1 = Sdf.Path("/Sphere01")
sphere1 = UsdGeom.Sphere.Define(stage, path1)
path2 = Sdf.Path("/Sphere02")
UsdGeom.Sphere.Define(stage, path2)
rel = sphere1.GetPrim().CreateRelationship("test")
rel.SetTargets([path2])
# Serialize prims
result = get_prim_as_text(stage, [path1, path2])
# Linux line endings
result = "\n".join(result.splitlines())
self.assertEqual(result, sdf_preserve_relationships)
async def test_delete_external_connections(self):
"""Testing that external connections are removed, but internal connections remain"""
layer = _to_layer(delete_external_connections, keep_inputs=False)
root_prims = layer.rootPrims
self.assertIsNotNone(root_prims)
# Check to make sure the incoming connections are gone
prim_spec = root_prims[0].nameChildren[0]
num_connections = 0
for attr in prim_spec.attributes:
connections = attr.connectionPathList.explicitItems
if connections:
num_connections += len(connections)
self.assertEqual(num_connections, 0)
# Check to make sure the internal connection is there still
prim_spec = root_prims[1].nameChildren[0]
num_connections = 0
for attr in prim_spec.attributes:
connections = attr.connectionPathList.explicitItems
if connections:
num_connections += len(connections)
self.assertEqual(num_connections, 1)
| 6,126 | Python | 28.887805 | 92 | 0.64365 |
omniverse-code/kit/exts/omni.kit.stage.copypaste/omni/kit/stage/copypaste/tests/test_context_menu.py | # Copyright (c) 2023, 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.
#
from pxr import UsdGeom
import omni.kit.test
from omni.kit.test_suite.helpers import arrange_windows
import omni.kit.ui_test as ui_test
class TestContextMenu(omni.kit.test.AsyncTestCase):
async def setUp(self):
await arrange_windows("Stage", 800, 600)
await omni.usd.get_context().new_stage_async()
self.stage = omni.usd.get_context().get_stage()
async def tearDown(self):
await omni.usd.get_context().close_stage_async()
def _find_prim_item(self, text):
# TODO: not sure why there's two items with the same realpath in the stage window, for now pick the first one
item = ui_test.find_all(f"Stage//Frame/**/Label[*].text=='{text}'")[0]
self.assertTrue(item)
return item
async def test_copy_prim(self):
"""Test that copy prim context menu copies selected prims."""
from .test_copypaste import sdf_prim_to_text
UsdGeom.Sphere.Define(self.stage, "/Sphere01")
await ui_test.human_delay(20)
sphere = self._find_prim_item("Sphere01")
await sphere.right_click()
context_menu = await ui_test.get_context_menu()
context_options = context_menu["_"]
self.assertTrue("Copy Prim" in context_options)
await ui_test.select_context_menu("Copy Prim")
text = omni.kit.clipboard.paste()
# Linux line endings
result = "\n".join(text.splitlines())
self.assertEqual(result, sdf_prim_to_text)
async def test_paste_prim(self):
"""Test that paste prim context menu pastes copied prims."""
from .test_copypaste import sdf_prim_to_text
UsdGeom.Xform.Define(self.stage, "/root")
await ui_test.human_delay(20)
# prepare the clipboard with invalid content
omni.kit.clipboard.copy("dummy")
root = self._find_prim_item("root")
await root.right_click()
context_menu = await ui_test.get_context_menu()
context_options = context_menu["_"]
self.assertTrue("Paste Prim" in context_options)
# test that pasting invalid content doesn't error
await ui_test.select_context_menu("Paste Prim")
self.assertFalse(self.stage.GetPrimAtPath("/root").GetChildren())
# prepare valid clipboard content
omni.kit.clipboard.copy(sdf_prim_to_text)
# test that pasting valid content works as expected
await root.right_click()
await ui_test.select_context_menu("Paste Prim")
self.assertEqual(len(self.stage.GetPrimAtPath("/root").GetChildren()), 1)
self.assertIsNotNone(self.stage.GetPrimAtPath("/root/Sphere01"))
| 3,062 | Python | 39.839999 | 117 | 0.674069 |
omniverse-code/kit/exts/omni.kit.stage.copypaste/omni/kit/stage/copypaste/tests/test_hot_key.py | # Copyright (c) 2023, 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.
#
from pxr import UsdGeom
import omni.kit.test
import omni.usd
import omni.kit.clipboard
import omni.kit.ui_test as ui_test
class TestHotKey(omni.kit.test.AsyncTestCase):
async def setUp(self):
await omni.usd.get_context().new_stage_async()
self.stage = omni.usd.get_context().get_stage()
async def tearDown(self):
await omni.usd.get_context().close_stage_async()
async def _test_copy(self, prim_paths, text_to_compare):
"""Utility for testing copy."""
usd_context = omni.usd.get_context()
selection = usd_context.get_selection()
selection.set_selected_prim_paths(prim_paths, True)
await ui_test.emulate_key_combo("CTRL+C")
await ui_test.human_delay()
text = omni.kit.clipboard.paste()
# Linux line endings
result = "\n".join(text.splitlines())
self.assertEqual(result, text_to_compare)
async def test_copy(self):
"""Testing CTRL+C for copy"""
from .test_copypaste import sdf_prim_to_text
UsdGeom.Sphere.Define(self.stage, "/Sphere01")
UsdGeom.Sphere.Define(self.stage, "/Sphere02")
await self._test_copy(["/Sphere01"], sdf_prim_to_text)
async def test_paste(self):
"""Testing CTRL+V for paste"""
UsdGeom.Sphere.Define(self.stage, "/Sphere01")
omni.kit.clipboard.copy("dummy")
# test that when invalid string is in the clipboard, paste doesn't do anything
await ui_test.emulate_key_combo("CTRL+V")
await ui_test.human_delay()
self.assertEqual(len(self.stage.GetPseudoRoot().GetChildren()), 1)
# select prim and copy
usd_context = omni.usd.get_context()
selection = usd_context.get_selection()
selection.set_selected_prim_paths(["/Sphere01"], True)
await ui_test.emulate_key_combo("CTRL+C")
await ui_test.human_delay()
# test that prim is pasted
await ui_test.emulate_key_combo("CTRL+V")
await ui_test.human_delay()
self.assertEqual(len(self.stage.GetPseudoRoot().GetChildren()), 2)
# when pasted with a duplicated name, it will be suffixed with a number
self.assertIsNotNone(self.stage.GetPrimAtPath("/Sphere01_01"))
| 2,675 | Python | 35.657534 | 86 | 0.670654 |
omniverse-code/kit/exts/omni.kit.window.images/omni/kit/window/images/scripts/extension.py | import os
import carb
import carb.profiler
import omni.ext
import omni.ui
WINDOW_NAME = "Images testing"
class ImagesWindow:
def _update_byte_image(self):
import math
size_increase = max(16.0 * math.sin(self._time), 0.0)
size_x = (int)(32 + size_increase)
size_y = (int)(32 + size_increase)
byte_data = []
byte_data_float = []
for x in range(size_x):
for y in range(size_y):
color = int(255 * (math.sin(self._time + 0.01 * (x * x + y * y)) * 0.4 + 0.6))
color_float = math.sin(self._time + 0.01 * (x * x + y * y)) * 0.4 + 0.6
byte_data.extend([0, color, 0, color])
byte_data_float.extend([color_float, color_float, 0, color_float])
self._time += 100.0
# This will call version that uses byte array, and has a default format omni.ui.TextureFormat.RGBA8_UNORM
self._byte_provider.set_bytes_data(byte_data, [size_x, size_y])
# This will call version that uses array of floating point numbers, and has a default format omni.ui.TextureFormat.RGBA32_SFLOAT
self._byte_provider_float.set_bytes_data(byte_data_float, [size_x, size_y])
def _update_dynamic_frame(self):
self._raster_provider_dynamic = omni.ui.RasterImageProvider()
self._raster_provider_dynamic.source_url = r"${exe-path}/resources/icons/material.png"
with self._dynamic_frame:
self._img2_dynamic = omni.ui.ImageWithProvider(self._raster_provider_dynamic)
def startup(self):
carb.profiler.begin(1, "Creating explicit image providers")
self._window = omni.ui.Window(WINDOW_NAME, width=600, height=340)
self._time = 0.0
self._byte_provider = omni.ui.ByteImageProvider()
self._byte_provider_float = omni.ui.ByteImageProvider()
self._update_byte_image()
self._raster_provider = omni.ui.RasterImageProvider()
self._raster_provider.source_url = r"${exe-path}/resources/icons/material.png"
self._vector_provider = omni.ui.VectorImageProvider()
self._vector_provider.source_url = r"${exe-path}/resources/glyphs/toolbar_select_prim.svg"
carb.log_warn("image: %dx%d" % (self._vector_provider.width, self._vector_provider.height))
carb.profiler.end(1)
styles = [
{
"": {"image_url": "resources/icons/Nav_Walkmode.png"},
":hovered": {"image_url": "resources/icons/Nav_Flymode.png"},
},
{
"": {"image_url": "resources/icons/Move_local_64.png"},
":hovered": {"image_url": "resources/icons/Move_64.png"},
},
{
"": {"image_url": "resources/icons/Rotate_local_64.png"},
":hovered": {"image_url": "resources/icons/Rotate_global.png"},
},
]
carb.profiler.begin(1, "Building UI")
def set_image(model, image):
value = model.get_item_value_model().get_value_as_int()
image.set_style(styles[value])
with self._window.frame:
with omni.ui.VStack():
with omni.ui.HStack():
with omni.ui.HStack():
self._img1 = omni.ui.ImageWithProvider(self._byte_provider)
self._img1_float = omni.ui.ImageWithProvider(self._byte_provider_float)
self._btn1update = omni.ui.Button(text="Update")
self._btn1update.set_clicked_fn(self._update_byte_image)
with omni.ui.HStack():
self._img2 = omni.ui.ImageWithProvider(self._raster_provider)
self._dynamic_frame = omni.ui.Frame(width=100, height=100)
self._btn2refresh = omni.ui.Button(text="Refresh")
self._btn2refresh.set_clicked_fn(self._update_dynamic_frame)
self._img3 = omni.ui.ImageWithProvider(self._vector_provider)
self._img4 = omni.ui.ImageWithProvider(r"${exe-path}/resources/glyphs/timeline_loop.svg")
self._img6 = omni.ui.ImageWithProvider(width=64, height=64, style=styles[0])
with omni.ui.HStack(width=omni.ui.Percent(50)):
omni.ui.Label("Select a texture to display", name="text")
model = omni.ui.ComboBox(0, "Navigation", "Move", "Rotate").model
model.add_item_changed_fn(lambda m, i, im=self._img6: set_image(m, im))
carb.profiler.end(1)
def shutdown(self):
self._img1 = None
self._img1_float = None
self._img2 = None
self._img3 = None
self._img4 = None
self._img6 = None
self._byte_provider = None
self._raster_provider = None
self._vector_provider = None
self._window = None
class Extension(omni.ext.IExt):
def __init__(self):
super().__init__()
pass
def on_startup(self):
self._ext_window = ImagesWindow()
self._ext_window.startup()
def on_shutdown(self):
self._ext_window.shutdown()
self._ext_window = None
| 5,170 | Python | 38.776923 | 136 | 0.573501 |
omniverse-code/kit/exts/omni.kit.widget.filter/omni/kit/widget/filter/style.py | from pathlib import Path
from omni import ui
from omni.ui import color as cl
CURRENT_PATH = Path(__file__).parent.absolute()
ICON_PATH = CURRENT_PATH.parent.parent.parent.parent.joinpath(f"data/icons")
UI_STYLE = {
"FilterButton": {"background_color": 0, "margin_width": 0, "padding": 2, "border_radius": 2},
"FilterButton:selected": {"background_color": cl.shade(cl('#23211F'))},
"FilterButton.Image": {
"background_color": 0x0,
"color": cl.shade(cl('#A8A8A8')),
"image_url": f"{ICON_PATH}/filter_tint.svg",
"alignment": ui.Alignment.CENTER,
},
"FilterButton.Image:selected": {
"color": cl.shade(cl('#34C7FF')),
},
"FilterButton:hovered": {"background_color": 0xFF6E6E6E},
"FilterButton.Carot": {"background_color": cl.shade(cl('#A8A8A8'))},
"FilterButton.Carot:selected": {"background_color": cl.shade(cl('#34C7FF'))},
}
| 902 | Python | 35.119999 | 97 | 0.638581 |
omniverse-code/kit/exts/omni.kit.widget.filter/omni/kit/widget/filter/__init__.py | from .filter import FilterButton, FilterModel
| 46 | Python | 22.499989 | 45 | 0.847826 |
omniverse-code/kit/exts/omni.kit.widget.filter/omni/kit/widget/filter/filter.py | import asyncio
from typing import Optional, Dict, List
import carb.events
import omni.kit.app
from omni.kit.widget.options_menu import OptionsMenu, OptionsModel, OptionItem
import omni.ui as ui
from .style import UI_STYLE
TIME_HOLD_SHOW_MENU = 0.08
class FilterModel(OptionsModel):
"""
Filter model.
"""
def __init__(self, option_items: List[OptionItem]):
super().__init__("Filter", option_items)
class FilterButton:
"""
A Filter button includes a popup menu for filter options.
Kwargs:
option_items (List[OptionItem]): Option items.
width (ui.Length): Button width. Default ui.Pixel(24).
height (ui.Length): Button height. Default ui.Pixel(24).
hide_on_click (bool): Hide popup menu if menu item clicked. Default False.
menu_width (ui.Length): Width of popup menu item. Default ui.Fraction(1).
style (dict): External widget style. Default empty.
"""
def __init__(
self,
option_items: List[OptionItem],
width: ui.Length = ui.Pixel(24),
height: ui.Length = ui.Pixel(24),
hide_on_click: bool = False,
menu_width: ui.Length = ui.Fraction(1),
carot_size: ui.Length = ui.Pixel(3),
style: Dict = {},
):
self._options_model = FilterModel(option_items)
self._width = width
self._height = height
self._hide_on_click = hide_on_click
self._menu_width = menu_width
self._carot_size = carot_size
self._style = UI_STYLE.copy()
self._style.update(style)
self._options_menu: Optional[OptionsMenu] = None
self._ignore_next_mouse_release = False
self._show_menu_task = None
self._saved_options: Dict[OptionItem, bool] = {}
self._build_ui()
def destroy(self) -> None:
self.__sub = None
self._options_model.destroy()
self._options_model = None
if self._options_menu:
self._options_menu.destroy()
self._options_menu = None
@property
def model(self) -> FilterModel:
"""Filter options model"""
return self._options_model
@property
def button(self) -> ui.Button:
"""FIlter button widget"""
return self._button
def _build_ui(self) -> None:
self._container = ui.ZStack(width=0, height=0, style=self._style)
with self._container:
self._button = ui.Button(
width=self._width,
height=self._height,
checked=self._options_model.dirty,
style_type_name_override="FilterButton",
# clicked_fn=lambda: self._show_options_menu(),
mouse_pressed_fn=lambda x, y, b, a: self._on_mouse_pressed(b),
mouse_released_fn=lambda x, y, b, a: self._on_mouse_released(b),
mouse_double_clicked_fn=lambda x, y, b, a: self._on_mouse_double_clicked(b),
)
with ui.VStack():
with ui.HStack():
ui.Spacer()
with ui.VStack(width=self._carot_size):
ui.Spacer()
ui.Triangle(
width=self._carot_size,
height=self._carot_size,
alignment=ui.Alignment.RIGHT_TOP,
style_type_name_override="FilterButton.Carot",
)
ui.Spacer(width=2)
ui.Spacer(height=2)
self.__sub = self._options_model.subscribe_item_changed_fn(self._on_item_changed)
def _on_mouse_pressed(self, btn) -> None:
# If options menu already show, just hide
self._ignore_next_mouse_release = False
if self._options_menu and self._options_menu.shown:
self._ignore_next_mouse_release = True
else:
self._ignore_next_mouse_release = False
return
def _on_mouse_released(self, btn) -> None:
if self._ignore_next_mouse_release:
return
if btn == 1 or btn == 0:
# Schedule a task so double click will interrupt
self._show_menu_task = asyncio.ensure_future(self._schedule_show_menu())
elif btn == 2:
# Middle button
self._toggle_filter()
return
def _on_mouse_double_clicked(self, btn) -> None:
self._ignore_next_mouse_release = True
if self._show_menu_task:
self._show_menu_task.cancel()
self._toggle_filter()
def _show_options_menu(self):
if self._options_menu is None:
self._options_menu = OptionsMenu(self._options_model, hide_on_click=self._hide_on_click, width=self._menu_width)
self._options_menu.show_by_widget(self._button)
async def _schedule_show_menu(self, ):
await asyncio.sleep(TIME_HOLD_SHOW_MENU)
self._show_options_menu()
self._show_menu_task = None
self._ignore_next_mouse_release = True
def _toggle_filter(self):
if self._container.selected:
for item in self._options_model.get_item_children():
self._saved_options[item] = item.value
self._options_model.reset()
else:
for item, value in self._saved_options.items():
item.value = value
def _on_item_changed(self, model: OptionsModel, item: OptionItem) -> None:
self._container.selected = model.dirty
| 5,522 | Python | 33.955696 | 124 | 0.566099 |
omniverse-code/kit/exts/omni.kit.widget.filter/omni/kit/widget/filter/tests/__init__.py | from .test_filter import *
| 27 | Python | 12.999994 | 26 | 0.740741 |
omniverse-code/kit/exts/omni.kit.widget.filter/omni/kit/widget/filter/tests/test_filter.py | import asyncio
from pathlib import Path
from carb.input import MouseEventType
import omni.kit.ui_test as ui_test
from omni.kit.ui_test.input import emulate_mouse, emulate_mouse_click
from omni.ui.tests.test_base import OmniUiTest
from omni.kit.widget.options_menu import OptionItem
from ..filter import FilterButton, FilterModel
CURRENT_PATH = Path(__file__).parent.absolute()
TEST_DATA_PATH = CURRENT_PATH.parent.parent.parent.parent.parent.joinpath("data/tests")
class TestFilter(OmniUiTest):
# Before running each test
async def setUp(self):
self._items = [
OptionItem("audio", text="Audio"),
OptionItem("materials", text="Materials"),
OptionItem("scripts", text="Scripts"),
OptionItem("textures", text="Textures"),
OptionItem("usd", text="USD"),
]
self._golden_img_dir = TEST_DATA_PATH.absolute().joinpath("golden")
await super().setUp()
# After running each test
async def tearDown(self):
await super().tearDown()
async def finalize_test(self, golden_img_name: str):
await self.wait_n_updates()
await super().finalize_test(golden_img_dir=self._golden_img_dir, golden_img_name=golden_img_name)
await self.wait_n_updates()
async def test_ui(self):
"""Test initial UI"""
window = await self.create_test_window(block_devices=False)
with window.frame:
FilterButton(self._items)
await ui_test.human_delay()
await ui_test.emulate_mouse_move_and_click(ui_test.Vec2(20, 20), right_click=False)
await asyncio.sleep(0.5)
await ui_test.human_delay()
await self.finalize_test("filter_initial_ui.png")
async def test_dirty_toggle(self):
"""Test filter settings are dirty"""
window = await self.create_test_window(block_devices=False)
with window.frame:
self._button = FilterButton(self._items)
try:
# click on first item
await ui_test.human_delay()
await self.__show_menu(right_click=True)
await ui_test.human_delay()
await ui_test.emulate_mouse_move_and_click(ui_test.Vec2(60, 72))
await ui_test.human_delay()
await self.finalize_test("filter_dirty_ui.png")
# hide menu
await self.__hide_menu()
# Double click to toggle
await ui_test.emulate_mouse_move_and_click(ui_test.Vec2(20, 20), double=True)
await ui_test.human_delay()
items = self._button.model.get_item_children()
for item in items:
self.assertFalse(item.value)
# Middle click to toggle again
await ui_test.emulate_mouse_move(ui_test.Vec2(20, 20))
await emulate_mouse(MouseEventType.MIDDLE_BUTTON_DOWN)
await ui_test.human_delay()
await emulate_mouse(MouseEventType.MIDDLE_BUTTON_UP)
await ui_test.human_delay()
items = self._button.model.get_item_children()
for index, item in enumerate(items):
if index == 0:
self.assertTrue(item.value)
else:
self.assertFalse(item.value)
finally:
await self.__hide_menu()
self._button.model.reset()
async def __show_menu(self, right_click: bool=False):
await ui_test.emulate_mouse_move_and_click(ui_test.Vec2(20, 20), right_click=right_click)
await asyncio.sleep(0.1)
async def __hide_menu(self):
await ui_test.emulate_mouse_move_and_click(ui_test.Vec2(0, 0))
await ui_test.human_delay()
await asyncio.sleep(1)
| 3,721 | Python | 35.490196 | 105 | 0.613545 |
omniverse-code/kit/exts/omni.kit.viewport_widgets_manager/omni/kit/viewport_widgets_manager/widget_provider.py | class WidgetProvider:
def build_widget(self, window):
raise NotImplementedError("This function needs to be implemented.")
| 134 | Python | 32.749992 | 75 | 0.738806 |
omniverse-code/kit/exts/omni.kit.viewport_widgets_manager/omni/kit/viewport_widgets_manager/extension.py | # Copyright (c) 2018-2020, 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 carb
import omni.ext
from typing import Union
from pxr import Sdf
from .manager import ViewportWidgetsManager, WidgetAlignment
from .widget_provider import WidgetProvider
_global_instance = None
class ViewportWidgetsManagerExtension(omni.ext.IExt):
def on_startup(self):
global _global_instance
_global_instance = self
self._widgets_manager = ViewportWidgetsManager()
self._widgets_manager.start()
def on_shutdown(self):
global _global_instance
_global_instance = None
self._widgets_manager.stop()
@staticmethod
def _get_instance():
global _global_instance
return _global_instance
def add_widget(self, prim_path: Sdf.Path, widget: WidgetProvider, alignment=WidgetAlignment.CENTER):
return self._widgets_manager.add_widget(prim_path, widget, alignment)
def remove_widget(self, widget_id):
self._widgets_manager.remove_widget(widget_id)
def add_widget(prim_path: Union[str, Sdf.Path], widget: WidgetProvider, alignment=WidgetAlignment.CENTER):
"""Add widget to viewport, which is positioned to the screen pos
of prim on the viewport.
REMINDER: Currently, it's possible that a prim
may includes multiple widgets, and they will be overlapped to each
other.
Args:
prim_path (Union[str, Sdf.Path]): The prim you want to add the widget to.
widget (WidgetProvider): The widget provider that you can override
to customize the UI layout.
alignment: The anchor point of the widget. By default, it will be
the calculated by the position of prim.
Returns:
widget id, which you can use it for widget remove. Or None if prim
cannot be found.
"""
instance = ViewportWidgetsManagerExtension._get_instance()
if not instance:
carb.log_warn("Extension omni.kit.viewport_widgets_manager is not enabled.")
return None
return ViewportWidgetsManagerExtension._get_instance().add_widget(Sdf.Path(prim_path), widget, alignment)
def remove_widget(widget_id):
"""
Remove widget with id.
Args:
widget_id: The widget id returned with add_widget.
"""
instance = ViewportWidgetsManagerExtension._get_instance()
if not instance:
carb.log_warn("Extension omni.kit.viewport_widgets_manager is not enabled.")
return None
return ViewportWidgetsManagerExtension._get_instance().remove_widget(widget_id)
| 2,954 | Python | 32.965517 | 109 | 0.702776 |
omniverse-code/kit/exts/omni.kit.viewport_widgets_manager/omni/kit/viewport_widgets_manager/manager.py | import asyncio
import carb
import weakref
import omni.usd
import omni.timeline
import omni.ui as ui
import omni.kit.app as app
from omni.kit.viewport.utility import (
get_active_viewport_window,
get_ui_position_for_prim,
ViewportPrimReferencePoint
)
from typing import List
from pxr import Tf, Usd, Sdf, UsdGeom, Trace
from .widget_provider import WidgetProvider
class WidgetAlignment:
CENTER = 0
BOTTOM = 1
TOP = 2
class WidgetWrapper:
def __init__(
self, usd_context, viewport_window, viewport_canvas, prim_path: Sdf.Path, widget_provider: WidgetProvider,
alignment=WidgetAlignment.CENTER
):
self._prim_path = prim_path
self._widget_provider = widget_provider
self._window = viewport_window
self._canvas = viewport_canvas
self._viewport_placer = None
self._alignment = alignment
self._layout = None
self._anchoring = True
self._usd_context = usd_context
self._timeline = omni.timeline.get_timeline_interface()
@property
def alignment(self):
return self._alignment
@property
def prim_path(self) -> Sdf.Path:
return self._prim_path
@property
def visible(self):
return self._viewport_placer and self._viewport_placer.visible
@visible.setter
def visible(self, value):
if self._viewport_placer:
self._viewport_placer.visible = value
def clear(self):
self._anchoring = False
if self._layout:
self._layout.clear()
self._layout.destroy()
self._layout = None
if self._viewport_placer:
self._viewport_placer.clear()
self._viewport_placer.destroy()
self._viewport_placer = None
@Trace.TraceFunction
def update_widget_position(self, cached_position=None):
viewport_window = self._window
if not viewport_window:
return False
alignment = {
WidgetAlignment.TOP: ViewportPrimReferencePoint.BOUND_BOX_TOP,
WidgetAlignment.BOTTOM: ViewportPrimReferencePoint.BOUND_BOX_BOTTOM
}.get(self._alignment, ViewportPrimReferencePoint.BOUND_BOX_CENTER)
if cached_position:
ui_pos, in_viewport = cached_position
else:
ui_pos, in_viewport = get_ui_position_for_prim(viewport_window, str(self.prim_path), alignment=alignment)
if not in_viewport:
return False
dpi = ui.Workspace.get_dpi_scale()
dpi = dpi if (dpi > 0) else 1.0
prim_window_pos_x, prim_window_pos_y = ui_pos
self._viewport_placer.offset_x = prim_window_pos_x / dpi - self._window.position_x
self._viewport_placer.offset_y = prim_window_pos_y / dpi - self._window.position_y
computed_width = self._layout.computed_width
comuted_height = self._layout.computed_height
offset_x = -float(computed_width) * 0.5
offset_y = -float(comuted_height) * 0.5
self._viewport_placer.offset_x += offset_x
self._viewport_placer.offset_y += offset_y
return True
def create_or_update_widget(self, cached_position=None):
viewport_window = self._window
if (viewport_window is None) or (not viewport_window.visible):
self.clear()
return
stage = viewport_window.viewport_api.stage
if not stage:
self.clear()
return
prim = stage.GetPrimAtPath(self.prim_path)
if not prim:
self.clear()
return
# If prim is hidden, clearing the widget.
if (
not self._is_prim_visible(stage, prim) or
not self._is_camera_mesh_visible(stage, prim)
):
self.clear()
return
if not self._viewport_placer:
self._anchoring = True
with self._canvas:
self._viewport_placer = ui.Placer()
with self._viewport_placer:
self._layout = ui.HStack(width=0, height=0)
with self._layout:
self._widget_provider.build_widget(viewport_window)
elif not self.update_widget_position(cached_position):
self.clear()
def _is_prim_visible(self, stage, prim):
imageable = UsdGeom.Imageable(prim)
if not imageable:
return False
visibility_attr = imageable.GetVisibilityAttr()
time_sampled = visibility_attr.GetNumTimeSamples() > 1
curr_time = self._timeline.get_current_time()
if time_sampled:
curr_time_code = curr_time * stage.GetTimeCodesPerSecond()
else:
curr_time_code = Usd.TimeCode.Default()
visibility = imageable.ComputeVisibility(curr_time_code)
return visibility != UsdGeom.Tokens.invisible
def _is_camera_mesh_visible(self, stage, prim):
# Only handle camera prim, as camera prim except builtin ones will
# include a mesh.
if not prim.IsA(UsdGeom.Camera):
return True
display_predicate = Usd.TraverseInstanceProxies(Usd.PrimAllPrimsPredicate)
for prim in Usd.PrimRange(prim, display_predicate):
if prim.IsA(UsdGeom.Mesh):
return self._is_prim_visible(stage, prim)
return False
def try_anchoring(self):
if not self._window or not self._anchoring:
return
computed_width = self._layout.computed_width
comuted_height = self._layout.computed_height
if computed_width == 0 or comuted_height == 0:
return False
self._anchoring = False
self.update_widget_position()
class ViewportWidgetsManager:
def __init__(self, usd_context_name=""):
self._stage_event_subscription = None
self._update_subscription = None
self._last_active_camera_path = None
self._stage_changed_subscription = None
self._all_widgets: List[WidgetWrapper] = []
self._usd_context = omni.usd.get_context(usd_context_name)
self._pending_update_all = False
self._pending_update_prim_paths = set([])
self._viewport_frame = None
self._viewport_window = None
self._frame_canvas = None
self._current_wait_frames = 0
self._all_widgets_hidden = False
def _initialize(self):
self._viewport_window = get_active_viewport_window(window_name="Viewport")
self._viewport_frame = self._viewport_window.get_frame(f"omni.kit.viewport_widgets_manager")
self._viewport_frame.set_computed_content_size_changed_fn(self._update_all_widgets)
# Stores position and size for comparing.
if self._viewport_window:
self._last_active_camera_path = self._viewport_window.viewport_api.camera_path
with self._viewport_frame:
self._frame_canvas = ui.ZStack()
else:
self._last_active_camera_path = None
def _reset(self):
if self._viewport_frame:
self._viewport_frame.set_computed_content_size_changed_fn(None)
self._viewport_frame.clear()
self._viewport_frame = None
self._frame_canvas.clear()
self._frame_canvas = None
self._viewport_window = None
self._last_active_camera_path = None
for widget in self._all_widgets:
widget.clear()
self._all_widgets.clear()
def start(self):
self._initialize()
events = self._usd_context.get_stage_event_stream()
self._stage_event_subscription = events.create_subscription_to_pop(
self._on_stage_event, name="Viewport Widgets Manager Watch"
)
self._start_update_subscription()
def stop(self):
self._stage_event_subscription = None
self._stop_update_subscrioption()
self._reset()
@Trace.TraceFunction
def _on_objects_changed(self, notice, stage):
if stage != self._usd_context.get_stage():
return
for path in notice.GetResyncedPaths():
if path == Sdf.Path.absoluteRootPath:
self._pending_update_all = True
self._current_wait_frames = 0
# TRICK: Hides all widgets to delay the refresh
# to avoid let user be aware of the delay.
self._hide_all_widgets()
else:
self._pending_update_prim_paths.add(path)
for path in notice.GetChangedInfoOnlyPaths():
prim_path = path.GetPrimPath()
# self._last_active_camera_path may be None, so make sure an
# implicit Sdf.Path isn't constructed for equality comparison
if (
prim_path == Sdf.Path.absoluteRootPath or
(
self._last_active_camera_path and
prim_path == self._last_active_camera_path
)
):
self._pending_update_all = True
self._current_wait_frames = 0
self._hide_all_widgets()
else:
self._pending_update_prim_paths.add(prim_path)
def _handle_pending_updates(self):
if self._pending_update_all:
self._update_all_widgets()
elif self._pending_update_prim_paths:
update_widgets = []
for prim_path in self._pending_update_prim_paths:
for widget in self._all_widgets:
if prim_path.HasPrefix(widget.prim_path):
update_widgets.append(widget)
self._update_all_widgets_internal(update_widgets)
self._pending_update_all = False
self._pending_update_prim_paths.clear()
def _update_all_widgets_internal(self, widgets: List[WidgetWrapper]):
# TODO: How to speed up this to batch the ui pos calculation.
def get_ui_position(widget: WidgetWrapper):
alignment = {
WidgetAlignment.TOP: ViewportPrimReferencePoint.BOUND_BOX_TOP,
WidgetAlignment.BOTTOM: ViewportPrimReferencePoint.BOUND_BOX_BOTTOM
}.get(widget.alignment, ViewportPrimReferencePoint.BOUND_BOX_CENTER)
return get_ui_position_for_prim(
self._viewport_window,
str(widget.prim_path),
alignment=alignment
)
for widget in widgets:
ui_pos = get_ui_position(widget)
widget.create_or_update_widget(ui_pos)
def _update_all_widgets(self):
update_widgets = []
for widget in self._all_widgets:
# Don't draw widget for current active camera path.
if not self._last_active_camera_path or widget.prim_path != self._last_active_camera_path:
update_widgets.append(widget)
else:
widget.clear()
self._update_all_widgets_internal(update_widgets)
def _trying_anchoring_all_widgets(self):
for widget in self._all_widgets:
widget.try_anchoring()
def _on_stage_event(self, event):
if event.type == int(omni.usd.StageEventType.OPENED):
self._start_update_subscription()
elif event.type == int(omni.usd.StageEventType.CLOSED):
self._stop_update_subscrioption()
def _stop_update_subscrioption(self):
self._update_subscription = None
self._last_active_camera_path = None
for widget in self._all_widgets:
widget.clear()
self._all_widgets.clear()
if self._stage_changed_subscription:
self._stage_changed_subscription.Revoke()
self._stage_changed_subscription = None
def _start_update_subscription(self):
self._update_subscription = app.get_app().get_update_event_stream().create_subscription_to_pop(
self._on_update, name="omni.kit.viewport_widgets_manager update"
)
self._stage_changed_subscription = Tf.Notice.Register(
Usd.Notice.ObjectsChanged, self._on_objects_changed, self._usd_context.get_stage()
)
def _hide_all_widgets(self):
for widget in self._all_widgets:
widget.visible = False
self._all_widgets_hidden = True
def _show_all_widgets(self):
if not self._all_widgets_hidden:
return
self._all_widgets_hidden = False
for widget in self._all_widgets:
widget.visible = True
def _on_update(self, dt):
# Puts some delay to avoid refreshing prims frequently
self._current_wait_frames += 1
if self._current_wait_frames <= 3:
return
else:
self._current_wait_frames = 0
self._show_all_widgets()
viewport_window = get_active_viewport_window()
if not viewport_window and self._viewport_window:
self._reset()
return
elif viewport_window and not self._viewport_window:
self._initialize()
self._trying_anchoring_all_widgets()
# Handle pending updates
self._handle_pending_updates()
# Checks changed camera
active_camera_path = viewport_window.viewport_api.camera_path
if (not active_camera_path) or (not self._last_active_camera_path) or (self._last_active_camera_path != active_camera_path):
self._last_active_camera_path = active_camera_path
self._update_all_widgets()
def add_widget(self, prim_path: Sdf.Path, widget: WidgetProvider, alignment=WidgetAlignment.CENTER):
usd_context = self._viewport_window.viewport_api.usd_context
stage = usd_context.get_stage()
usd_prim = stage.GetPrimAtPath(prim_path) if stage else False
if usd_prim:
xformable_prim = UsdGeom.Xformable(usd_prim)
else:
xformable_prim = None
if not xformable_prim:
carb.warn(f"Cannot add viewport widget for non-xformable prim.")
return None
carb.log_info(f"Adding prim widget for {prim_path}")
widget_wrapper = WidgetWrapper(
self._usd_context,
self._viewport_window,
self._frame_canvas,
prim_path,
widget,
alignment
)
self._all_widgets.append(widget_wrapper)
if not self._last_active_camera_path or prim_path != self._last_active_camera_path:
widget_wrapper.create_or_update_widget()
return weakref.ref(widget_wrapper)
def remove_widget(self, widget_id):
if not widget_id:
return
try:
local_wiget = widget_id()
if widget_id and local_wiget:
if local_wiget in self._all_widgets:
local_wiget.clear()
self._all_widgets.remove(local_wiget)
except Exception:
pass
| 15,018 | Python | 33.685912 | 132 | 0.596085 |
omniverse-code/kit/exts/omni.kit.viewport_widgets_manager/omni/kit/viewport_widgets_manager/tests/__init__.py | from .test_widgets_manager import TestWidgetsManagerUI
| 55 | Python | 26.999987 | 54 | 0.872727 |
omniverse-code/kit/exts/omni.kit.viewport_widgets_manager/omni/kit/viewport_widgets_manager/tests/test_widgets_manager.py | import asyncio
import os
import carb.settings
import omni.usd
import omni.kit.commands
import omni.client
import omni.kit.test
import omni.ui as ui
import omni.kit.viewport_widgets_manager as wm
from omni.kit.viewport.utility.tests import setup_viewport_test_window
from omni.kit.test.teamcity import is_running_in_teamcity
import sys
import unittest
from omni.ui.tests.test_base import OmniUiTest
from pathlib import Path
from pxr import Usd, UsdGeom, Gf
CURRENT_PATH = Path(__file__).parent.joinpath("../../../../data")
CAMERA_WIDGET_STYLING = {
"Rectangle::background": {"background_color": 0x7F808080, "border_radius": 5}
}
class LabelWidget(wm.WidgetProvider):
def __init__(self, text):
self._text = text
def build_widget(self, window):
with ui.ZStack(width=0, height=0, style=CAMERA_WIDGET_STYLING):
ui.Rectangle(name="background")
with ui.VStack(width=0, height=0):
ui.Spacer(height=4)
with ui.HStack(width=0, height=0):
ui.Spacer(width=4)
ui.Label(self._text, width=0, height=0, name="user_name")
ui.Spacer(width=4)
ui.Spacer(height=4)
class TestWidgetsManagerUI(OmniUiTest):
async def setUp(self):
await super().setUp()
self._golden_img_dir = CURRENT_PATH.absolute().resolve().joinpath("tests")
# viewport_next golden images are different
vp_window_name = carb.settings.get_settings().get('/exts/omni.kit.viewport.window/startup/windowName')
if not (vp_window_name and (vp_window_name == 'Viewport')):
self._golden_img_dir = self._golden_img_dir.joinpath("viewport_1")
self._all_widgets = []
await omni.usd.get_context().new_stage_async()
await self.wait_frames()
# After running each test
async def tearDown(self):
self._golden_img_dir = None
for widget_id in self._all_widgets:
wm.remove_widget(widget_id)
await super().tearDown()
async def wait_frames(self, n_frame: int = 10):
app = omni.kit.app.get_app()
while n_frame > 0:
await app.next_update_async()
n_frame = n_frame - 1
async def create_text_widget(self, text, alignment, width: int = 320, height: int = 240):
try:
from omni.kit.mainwindow import get_main_window
get_main_window().get_main_menu_bar().visible = False
except (ImportError, AttributeError):
pass
# Create test area
await self.create_test_area(width, height)
# Fill the area with the Viewport
viewport_window = await setup_viewport_test_window(width, height)
# Add scene objects
usd_context = viewport_window.viewport_api.usd_context
stage = usd_context.get_stage()
prim_path = "/World/widget_prim"
prim = UsdGeom.Xform.Define(stage, prim_path)
await self.wait_frames()
usd_context.get_selection().clear_selected_prim_paths()
self._all_widgets.append(wm.add_widget(prim_path, LabelWidget(text), alignment))
# Sleep 1s to wait for drawing
await asyncio.sleep(1.0)
return prim
@unittest.skipIf(is_running_in_teamcity() and sys.platform.startswith("linux"), "OM-84020")
async def test_create_widget_top(self):
await self.create_text_widget("Sphere", wm.WidgetAlignment.TOP)
await self.finalize_test(golden_img_dir=self._golden_img_dir, golden_img_name="test_create_widget_top.png")
@unittest.skipIf(is_running_in_teamcity() and sys.platform.startswith("linux"), "OM-84020")
async def test_create_widget_bottom(self):
await self.create_text_widget("Cone", wm.WidgetAlignment.BOTTOM)
await self.finalize_test(golden_img_dir=self._golden_img_dir, golden_img_name="test_create_widget_bottom.png")
@unittest.skipIf(is_running_in_teamcity() and sys.platform.startswith("linux"), "OM-84020")
async def test_create_widget_center(self):
await self.create_text_widget("Cube", wm.WidgetAlignment.CENTER)
await self.finalize_test(golden_img_dir=self._golden_img_dir, golden_img_name="test_create_widget_center.png")
@unittest.skipIf(is_running_in_teamcity() and sys.platform.startswith("linux"), "OM-84020")
async def test_widget_translate(self):
prim = await self.create_text_widget("Sphere", wm.WidgetAlignment.TOP)
translation = Gf.Vec3d(-200, 0.0, 0.0)
common_api = UsdGeom.XformCommonAPI(prim)
common_api.SetTranslate(translation)
await self.wait_frames()
await self.finalize_test(golden_img_dir=self._golden_img_dir, golden_img_name="test_widget_translate.png")
@unittest.skipIf(is_running_in_teamcity() and sys.platform.startswith("linux"), "OM-84020")
async def test_widget_out_of_viewport(self):
prim = await self.create_text_widget("Sphere", wm.WidgetAlignment.TOP)
translation = Gf.Vec3d(-200000, 0.0, 0.0)
common_api = UsdGeom.XformCommonAPI(prim)
common_api.SetTranslate(translation)
await self.wait_frames()
await self.finalize_test(golden_img_dir=self._golden_img_dir, golden_img_name="test_widget_out_of_viewport.png")
| 5,263 | Python | 40.448819 | 120 | 0.6597 |
omniverse-code/kit/exts/omni.kit.window.title/omni/kit/window/title/title.py | # Copyright (c) 2020, 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 carb.events
import carb.settings
import carb.windowing
import omni.appwindow
import omni.ext
import omni.kit.app
import omni.usd
import time
import urllib.parse
main_window_title = None
def get_main_window_title():
return main_window_title
class WindowTitle(omni.ext.IExt):
def on_startup(self, ext_id):
self._app_name = ""
self._app_version = ""
self._title = ""
self._title_decor = ""
self._full_title = ""
self._listener = None
self._app = omni.kit.app.get_app()
# We don't have a way to acquire interface without throwing on missing implementation in Carbonite,
# so for now we have to work this around with try/except block.
try:
self._windowing = carb.windowing.acquire_windowing_interface()
except:
self._windowing = None
self._settings = carb.settings.get_settings()
self._window = omni.appwindow.get_default_app_window().get_window()
self._usd_context = omni.usd.get_context()
self._stage_event_sub = self._usd_context.get_stage_event_stream().create_subscription_to_pop(
self._on_stage_event, name="Window title bar"
)
if self._usd_context.get_stage_state() == omni.usd.StageState.OPENED:
self._update_title()
# default value
self._app_name = self._settings.get("/app/window/title")
self._app_version = self._app.get_build_version()
self._apply()
# Default polling interval is 500ms (or 0.5s)
self._settings.set_default("/exts/omni.kit.window.title/pollIntervalMS", 500.0)
self._poll_interval_s = self._settings.get("/exts/omni.kit.window.title/pollIntervalMS") / 1000.0
global main_window_title
main_window_title = self
def on_shutdown(self):
global main_window_title
main_window_title = None
self._stage_event_sub = None
def set_app_name(self, name: str):
"""
Sets app name on title bar. This is the first element on the title bar string.
Args:
name: app name to be set to.
"""
if self._app_name != name:
self._app_name = name
self._apply()
def set_app_version(self, version: str):
"""
Sets app version on title bar. This is the second element on the title bar string, after app name.
Args:
version: app version to be set to.
"""
if self._app_version != version:
self._app_version = version
self._apply()
def set_title(self, title: str):
"""
Sets title text on title bar. This is the third element on the title bar string, after app name and version.
Args:
title: app title to be set to.
"""
# OM-64018: need to unquote the chars in the title string
title = urllib.parse.unquote(title)
if self._title != title:
self._title = title
self._apply()
def set_title_decor(self, title_decor: str):
"""
Sets title decor on title bar. This is at the end of the title string.
Args:
title_decor: title decor to be set to.
"""
if self._title_decor != title_decor:
self._title_decor = title_decor
self._apply()
def get_full_title(self):
"""
Gets the full title.
"""
return self._full_title
def _apply(self):
self._full_title = f"{self._app_name} {self._app_version}"
if len(self._title) > 0:
self._full_title += f" - {self._title}{self._title_decor}"
if self._window is not None:
self._windowing.set_window_title(self._window, self._full_title)
def _on_stage_event(self, event: carb.events.IEvent):
if event.type == int(omni.usd.StageEventType.OPENED):
self._update_title()
elif event.type == int(omni.usd.StageEventType.CLOSING):
self._on_stage_closing()
elif event.type == int(omni.usd.StageEventType.DIRTY_STATE_CHANGED):
self._update_title()
def set_title_url(self):
title = "New Stage" if self._usd_context.is_new_stage() else self._usd_context.get_stage_url()
if not self._usd_context.is_writable():
title += " (read-only)"
self.set_title(title)
def _on_stage_closing(self):
self.set_title("")
self.set_title_decor("")
def _update_title(self):
self.set_title_url()
dirty = self._usd_context.has_pending_edit()
if dirty and self._title_decor != "*":
self.set_title_decor("*")
elif not dirty and self._title_decor == "*":
self.set_title_decor("")
| 5,213 | Python | 32.210191 | 116 | 0.603108 |
omniverse-code/kit/exts/omni.kit.window.title/omni/kit/window/title/__init__.py | from .title import *
| 21 | Python | 9.999995 | 20 | 0.714286 |
omniverse-code/kit/exts/omni.kit.window.title/omni/kit/window/title/tests/tests.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 os
import stat
import tempfile
import carb.settings
import omni.kit.app
import omni.kit.commands
import omni.kit.window.title
import omni.usd
class TestTitleBar(omni.kit.test.AsyncTestCase):
async def test_title(self):
import omni.kit.stage_templates
title_bar = omni.kit.window.title.get_main_window_title()
settings = carb.settings.get_settings()
app = omni.kit.app.get_app()
usd_context = omni.usd.get_context()
## Test new stage title
await omni.kit.stage_templates.new_stage_async()
# make sure new stage event is handled by title extension
await app.next_update_async()
# Ideally we should get title from OS Window, but GLFW does not have getter for window title.
title = title_bar.get_full_title()
app_name = settings.get("/app/window/title")
app_version = app.get_build_version()
new_stage_title = f"{app_name} {app_version} - New Stage"
self.assertTrue(title == new_stage_title)
## Test set app name and version
test_app_name = "title extension test"
test_version = "1.0"
title_bar.set_app_name(test_app_name)
title_bar.set_app_version(test_version)
title = title_bar.get_full_title()
self.assertTrue(title == f"{test_app_name} {test_version} - New Stage")
## Restore app name and version
title_bar.set_app_name(app_name)
title_bar.set_app_version(app_version)
## Test open USD file
with tempfile.TemporaryDirectory() as dir_name:
tmp_file_path = os.path.join(dir_name, "tmp.usda")
await usd_context.save_as_stage_async(tmp_file_path)
# make sure new stage event is handled by title extension
await app.next_update_async()
title = title_bar.get_full_title()
title = os.path.normpath(title)
tmp_file_path = os.path.normpath(tmp_file_path)
# Save As should not result in dirty mark (*) on the title
self.assertEqual(title, f"{app_name} {app_version} - {tmp_file_path}")
## Make an edit
stage = usd_context.get_stage()
stage.DefinePrim("/test")
# make sure new stage event is handled by title extension
await app.next_update_async()
await app.next_update_async()
# check the dirty mark (*)
title = title_bar.get_full_title()
title = os.path.normpath(title)
self.assertEqual(title, f"{app_name} {app_version} - {tmp_file_path}*")
## Save the stage
await usd_context.save_stage_async()
await app.next_update_async()
# check the dirty mark (*) is removed
title = title_bar.get_full_title()
title = os.path.normpath(title)
self.assertEqual(title, f"{app_name} {app_version} - {tmp_file_path}")
## Make read-only
await usd_context.close_stage_async()
mode = os.stat(tmp_file_path).st_mode
os.chmod(tmp_file_path, stat.S_IREAD | stat.S_IRGRP | stat.S_IROTH)
await usd_context.open_stage_async(tmp_file_path)
await app.next_update_async()
await app.next_update_async()
title = title_bar.get_full_title()
title = os.path.normpath(title)
self.assertEqual(title, f"{app_name} {app_version} - {tmp_file_path} (read-only)")
await usd_context.close_stage_async()
# restore file permission so it can be cleaned up
os.chmod(tmp_file_path, mode)
| 4,103 | Python | 36.651376 | 101 | 0.622959 |
omniverse-code/kit/exts/omni.kit.helper.file_utils/omni/kit/helper/file_utils/extension.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.ext
import omni.client
import carb.settings
import pydantic
from typing import List, Tuple, Optional
from datetime import datetime
from urllib import parse
from carb import events, log_warn
from collections import OrderedDict
from omni.kit.helper.file_utils import asset_types
from . import FILE_OPENED_EVENT, FILE_SAVED_EVENT, FILE_EVENT_QUEUE_UPDATED
g_singleton = None
class FileEventModel(pydantic.BaseModel):
url: str
asset_type: Optional[str]
is_folder: Optional[bool] = False
event_type: Optional[int]
tag: Optional[str]
datetime: Optional[datetime]
class FileEventHistoryExtension(omni.ext.IExt):
FILE_EVENT_QUEUE_SETTING = "/persistent/app/omniverse/fileEventHistory"
def __init__(self, max_queue_size: int = 100):
super().__init__()
self._event_subs = []
self._event_queue = None
self._max_queue_size = max_queue_size
# set up singleton
global g_singleton
g_singleton = self
def on_startup(self, ext_id: str):
# Listen for file open and file save events
import omni.kit.app
event_stream = omni.kit.app.get_app().get_message_bus_event_stream()
self._event_subs = [
event_stream.create_subscription_to_pop_by_type(FILE_OPENED_EVENT, self._on_file_event),
event_stream.create_subscription_to_pop_by_type(FILE_SAVED_EVENT, self._on_file_event)
]
@property
def event_queue(self):
if self._event_queue is None:
self._event_queue = self._load_queue_from_settings()
return self._event_queue
def _load_queue_from_settings(self) -> OrderedDict:
queue = OrderedDict()
settings = carb.settings.get_settings()
for uri in settings.get(self.FILE_EVENT_QUEUE_SETTING) or []:
url, file_event = self._deserialize_uri(uri)
if url and file_event:
queue[url] = file_event
queue.move_to_end(url, last=True)
self._adjust_queue_size(queue)
return queue
def _save_queue_to_settings(self, queue: OrderedDict):
uris = []
for url, file_event in queue.items():
uri = self._serialize_uri(file_event)
if not uri in uris:
uris.append(uri)
settings = carb.settings.get_settings()
if settings:
settings.set_string_array(self.FILE_EVENT_QUEUE_SETTING, uris)
def _serialize_uri(self, file_event: FileEventModel) -> str:
url_parts = omni.client.break_url(file_event.url)
params = {
'is_folder': file_event.is_folder,
'event_type': file_event.event_type,
'tag': file_event.tag or ""
}
uri = omni.client.make_url(
scheme=url_parts.scheme or "file",
host=url_parts.host,
path=url_parts.path,
query=parse.urlencode(params))
return uri
def _deserialize_uri(self, uri: str) -> Tuple[str, FileEventModel]:
url_parts = omni.client.break_url(uri)
url = omni.client.make_url(
scheme=url_parts.scheme,
host=url_parts.host,
path=url_parts.path
)
file_event = None
try:
params = parse.parse_qs(url_parts.query, strict_parsing=False, keep_blank_values=False)
file_event = FileEventModel(
url=url,
asset_type=asset_types.get_asset_type(url),
is_folder=params.get('is_folder', ["False"])[0] == "True",
event_type=int(params.get('event_type', ["0"])[0]),
tag=params.get('tag', [None])[0],
datetime=datetime.utcnow(),
)
except pydantic.ValidationError as e:
log_warn(f"Error parsing file event payload: {str(e)}")
except Exception as e:
log_warn(f"Failed to deserialize file event uri: {str(e)}")
return url, file_event
def _adjust_queue_size(self, queue: OrderedDict):
while len(queue) > self._max_queue_size:
# Delete items from the tail end
queue.popitem(last=True)
def _on_file_event(self, event: events.IEvent):
if event.type != FILE_OPENED_EVENT and event.type != FILE_SAVED_EVENT:
# Sanity check
return
event_queue = self.event_queue
try:
# Ensure payload fits expected data model
payload = event.payload.get_dict()
url = payload.get('url')
file_event = FileEventModel(
url=url,
asset_type=asset_types.get_asset_type(url),
is_folder=payload.get('is_folder', False),
event_type=event.type,
tag=payload.get('tag', None),
datetime=datetime.utcnow(),
)
except (pydantic.ValidationError, Exception) as e:
log_warn(f"Error parsing file event payload: {str(e)}")
return
# Insert at head of queue
event_queue[url] = file_event
event_queue.move_to_end(url, last=False)
self._adjust_queue_size(event_queue)
self._save_queue_to_settings(event_queue)
omni.kit.app.get_app().get_message_bus_event_stream().push(FILE_EVENT_QUEUE_UPDATED)
def get_latest_urls_from_event_queue(self,
num_latest: int = 1, asset_type: str = None, event_type: int = 0, tag: str = None) -> List[str]:
urls = []
for url, file_event in self.event_queue.items():
if asset_type and file_event.asset_type != asset_type:
continue
elif event_type and file_event.event_type != event_type:
continue
elif tag and file_event.tag != tag:
continue
urls.append(url)
if len(urls) >= num_latest:
break
return urls
def clear_event_queue(self):
queue = self.event_queue
queue.clear()
self._save_queue_to_settings(queue)
omni.kit.app.get_app().get_message_bus_event_stream().push(FILE_EVENT_QUEUE_UPDATED)
def on_shutdown(self):
self._save_queue_to_settings(self.event_queue)
self._event_queue = None
self._event_subs.clear()
global g_singleton
g_singleton = None
def get_instance():
return g_singleton
| 6,817 | Python | 35.459893 | 104 | 0.601878 |
omniverse-code/kit/exts/omni.kit.helper.file_utils/omni/kit/helper/file_utils/__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.
#
"""Keeps a history of file events that is made available via an API to other extensions"""
__all__ = [
"FileEventHistoryExtension", "FileEventModel",
"get_latest_urls_from_event_queue", "get_last_url_visited", "get_last_url_opened", "get_last_url_saved"
]
import carb.events
FILE_OPENED_EVENT: int = carb.events.type_from_string("omni.kit.helper.file_utils.FILE_OPENED")
FILE_SAVED_EVENT: int = carb.events.type_from_string("omni.kit.helper.file_utils.FILE_SAVED")
FILE_EVENT_QUEUE_UPDATED: int = carb.events.type_from_string("omni.kit.helper.file_utils.FILE_EVENT_QUEUE_UPDATED")
from typing import List
from .extension import get_instance, FileEventHistoryExtension, FileEventModel
def get_latest_urls_from_event_queue(num_latest: int = 1, asset_type: str = None, event_type: int = 0, tag: str = None) -> List[str]:
ext = get_instance()
if ext:
return ext.get_latest_urls_from_event_queue(num_latest=num_latest, asset_type=asset_type, event_type=event_type, tag=tag)
return []
def get_last_url_visited(asset_type: str = None, tag: str = None) -> str:
urls = get_latest_urls_from_event_queue(num_latest=1, asset_type=asset_type, tag=tag)
if urls:
return urls[0]
else:
return None
def get_last_url_opened(asset_type: str = None, tag: str = None) -> str:
urls = get_latest_urls_from_event_queue(num_latest=1, asset_type=asset_type, event_type=FILE_OPENED_EVENT, tag=tag)
if urls:
return urls[0]
else:
return None
def get_last_url_saved(asset_type: str = None, tag: str = None) -> str:
urls = get_latest_urls_from_event_queue(num_latest=1, asset_type=asset_type, event_type=FILE_SAVED_EVENT, tag=tag)
if urls:
return urls[0]
else:
return None
def reset_file_event_queue():
ext = get_instance()
if ext:
return ext.clear_event_queue()
| 2,300 | Python | 40.836363 | 133 | 0.709565 |
omniverse-code/kit/exts/omni.kit.helper.file_utils/omni/kit/helper/file_utils/asset_types.py | # Copyright (c) 2018-2020, 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.
#
from typing import Dict, List
from collections import namedtuple
from pathlib import Path
AssetTypeDef = namedtuple("AssetTypeDef", "glyph thumbnail matching_exts")
# The known list of asset types, stored in this singleton variable
_known_asset_types: Dict = None
# Default Asset types
ASSET_TYPE_ANIM_USD = "anim_usd"
ASSET_TYPE_CACHE_USD = "cache_usd"
ASSET_TYPE_CURVE_ANIM_USD = "curve_anim_usd"
ASSET_TYPE_GEO_USD = "geo_usd"
ASSET_TYPE_MATERIAL_USD = "material_usd"
ASSET_TYPE_PROJECT_USD = "project_usd"
ASSET_TYPE_SEQ_USD = "seq_usd"
ASSET_TYPE_SKEL_USD = "skel_usd"
ASSET_TYPE_SKEL_ANIM_USD = "skel_anim_usd"
ASSET_TYPE_USD_SETTINGS = "settings_usd"
ASSET_TYPE_USD = "usd"
ASSET_TYPE_FBX = "fbx"
ASSET_TYPE_OBJ = "obj"
ASSET_TYPE_MATERIAL = "material"
ASSET_TYPE_IMAGE = "image"
ASSET_TYPE_SOUND = "sound"
ASSET_TYPE_SCRIPT = "script"
ASSET_TYPE_VOLUME = "volume"
ASSET_TYPE_FOLDER = "folder"
ASSET_TYPE_ICON = "icon"
ASSET_TYPE_HIDDEN = "hidden"
ASSET_TYPE_UNKNOWN = "unknown"
def init_asset_types():
global _known_asset_types
_known_asset_types = {}
try:
import carb.settings
theme = carb.settings.get_settings().get_as_string("/persistent/app/window/uiStyle")
except Exception:
theme = None
finally:
theme = theme or "NvidiaDark"
import omni.kit.app
ext_path = omni.kit.app.get_app().get_extension_manager().get_extension_path_by_module(__name__)
icon_path = Path(ext_path).joinpath("icons").joinpath(theme).absolute()
thumbnail_path = Path(ext_path).joinpath(f"data").joinpath("thumbnails").absolute()
_known_asset_types[ASSET_TYPE_USD_SETTINGS] = AssetTypeDef(
f"{icon_path}/settings_usd.svg",
f"{thumbnail_path}/settings_usd_256.png",
[".settings.usd", ".settings.usda", ".settings.usdc", ".settings.usdz"],
)
_known_asset_types[ASSET_TYPE_ANIM_USD] = AssetTypeDef(
f"{icon_path}/anim_usd.svg",
f"{thumbnail_path}/anim_usd_256.png",
[".anim.usd", ".anim.usda", ".anim.usdc", ".anim.usdz"],
)
_known_asset_types[ASSET_TYPE_CACHE_USD] = AssetTypeDef(
f"{icon_path}/cache_usd.svg",
f"{thumbnail_path}/cache_usd_256.png",
[".cache.usd", ".cache.usda", ".cache.usdc", ".cache.usdz"],
)
_known_asset_types[ASSET_TYPE_CURVE_ANIM_USD] = AssetTypeDef(
f"{icon_path}/anim_usd.svg",
f"{thumbnail_path}/curve_anim_usd_256.png",
[".curveanim.usd", ".curveanim.usda", ".curveanim.usdc", ".curveanim.usdz"],
)
_known_asset_types[ASSET_TYPE_GEO_USD] = AssetTypeDef(
f"{icon_path}/geo_usd.svg",
f"{thumbnail_path}/geo_usd_256.png",
[".geo.usd", ".geo.usda", ".geo.usdc", ".geo.usdz"],
)
_known_asset_types[ASSET_TYPE_MATERIAL_USD] = AssetTypeDef(
f"{icon_path}/material_usd.png",
f"{thumbnail_path}/material_usd_256.png",
[".material.usd", ".material.usda", ".material.usdc", ".material.usdz"],
)
_known_asset_types[ASSET_TYPE_PROJECT_USD] = AssetTypeDef(
f"{icon_path}/project_usd.svg",
f"{thumbnail_path}/project_usd_256.png",
[".project.usd", ".project.usda", ".project.usdc", ".project.usdz"],
)
_known_asset_types[ASSET_TYPE_SEQ_USD] = AssetTypeDef(
f"{icon_path}/sequence_usd.svg",
f"{thumbnail_path}/sequence_usd_256.png",
[".seq.usd", ".seq.usda", ".seq.usdc", ".seq.usdz"],
)
_known_asset_types[ASSET_TYPE_SKEL_USD] = AssetTypeDef(
f"{icon_path}/skel_usd.svg",
f"{thumbnail_path}/skel_usd_256.png",
[".skel.usd", ".skel.usda", ".skel.usdc", ".skel.usdz"],
)
_known_asset_types[ASSET_TYPE_SKEL_ANIM_USD] = AssetTypeDef(
f"{icon_path}/anim_usd.svg",
f"{thumbnail_path}/skel_anim_usd_256.png",
[".skelanim.usd", ".skelanim.usda", ".skelanim.usdc", ".skelanim.usdz"],
)
_known_asset_types[ASSET_TYPE_FBX] = AssetTypeDef(
f"{icon_path}/usd_stage.svg", f"{thumbnail_path}/fbx_256.png", [".fbx"]
)
_known_asset_types[ASSET_TYPE_OBJ] = AssetTypeDef(
f"{icon_path}/usd_stage.svg", f"{thumbnail_path}/obj_256.png", [".obj"]
)
_known_asset_types[ASSET_TYPE_MATERIAL] = AssetTypeDef(
f"{icon_path}/mdl.svg", f"{thumbnail_path}/mdl_256.png", [".mdl", ".mtlx"]
)
_known_asset_types[ASSET_TYPE_IMAGE] = AssetTypeDef(
f"{icon_path}/image.svg",
f"{thumbnail_path}/image_256.png",
[".bmp", ".gif", ".jpg", ".jpeg", ".png", ".tga", ".tif", ".tiff", ".hdr", ".dds", ".exr", ".psd", ".ies", ".tx"],
)
_known_asset_types[ASSET_TYPE_SOUND] = AssetTypeDef(
f"{icon_path}/sound.svg",
f"{thumbnail_path}/sound_256.png",
[".wav", ".wave", ".ogg", ".oga", ".flac", ".fla", ".mp3", ".m4a", ".spx", ".opus", ".adpcm"],
)
_known_asset_types[ASSET_TYPE_SCRIPT] = AssetTypeDef(
f"{icon_path}/script.svg", f"{thumbnail_path}/script_256.png", [".py"]
)
_known_asset_types[ASSET_TYPE_VOLUME] = AssetTypeDef(
f"{icon_path}/volume.svg",
f"{thumbnail_path}/volume_256.png",
[".nvdb", ".vdb"],
)
_known_asset_types[ASSET_TYPE_ICON] = AssetTypeDef(None, None, [".svg"])
_known_asset_types[ASSET_TYPE_HIDDEN] = AssetTypeDef(None, None, [".thumbs"])
try:
# avoid dependency on USD in this extension and only use it when available
import omni.usd
usd_exts = omni.usd.readable_usd_dotted_file_exts()
except ImportError:
usd_exts = ('.live', '.omni', '.usd', '.usda', '.usdc', '.usdz')
# readable_usd_dotted_file_exts() is auto-generated by querying USD;
# however, it includes some items that we've assigned more specific
# roles (ie, .mdl). So do this last, and subtract out any already-
# known types.
known_exts = set()
for asset_type_def in _known_asset_types.values():
known_exts.update(asset_type_def.matching_exts)
usd_exts = [
x for x in usd_exts
if x not in known_exts
]
_known_asset_types[ASSET_TYPE_USD] = AssetTypeDef(
f"{icon_path}/usd_stage.svg",
f"{thumbnail_path}/usd_stage_256.png",
usd_exts,
)
def known_asset_types():
global _known_asset_types
if _known_asset_types is None:
init_asset_types()
return _known_asset_types
def clear_asset_types():
known_asset_types().clear()
def register_file_extensions(asset_type: str, exts: [str], replace: bool = False):
"""
Adds an asset type to the recognized list.
Args:
asset_type (str): Name of asset type.
exts ([str]): List of extensions to associate with this asset type, e.g. [".usd", ".usda"].
replace (bool): If True, replaces extensions in the existing definition. Otherwise, append
to the existing list.
"""
if not asset_type or exts == None:
return
asset_types = known_asset_types()
if asset_type in asset_types:
glyph = asset_types[asset_type].glyph
thumbnail = asset_types[asset_type].thumbnail
if replace:
asset_types[asset_type] = AssetTypeDef(glyph, thumbnail, exts)
else:
exts.extend(asset_types[asset_type].matching_exts)
asset_types[asset_type] = AssetTypeDef(glyph, thumbnail, exts)
else:
asset_types[asset_type] = AssetTypeDef(None, None, exts)
def asset_type_exts(asset_type: str) -> List[str]:
asset_types = known_asset_types()
return asset_types[asset_type].matching_exts
def is_asset_type(filename: str, asset_type: str) -> bool:
"""
Returns True if given filename is of specified type.
Args:
filename (str)
asset_type (str): Tested type name.
Returns:
bool
"""
asset_types = known_asset_types()
if not (filename and asset_type):
return False
elif asset_type not in asset_types:
return False
return any([filename.lower().endswith(ext.lower()) for ext in asset_types[asset_type].matching_exts])
def is_udim_sequence(filename: str):
return "<UDIM>" in filename and is_asset_type(filename, ASSET_TYPE_IMAGE)
def get_asset_type(filename: str) -> str:
"""
Returns asset type, based on extension of given filename.
Args:
filename (str)
Returns:
str
"""
if not filename:
return None
asset_types = known_asset_types()
for asset_type in asset_types:
if is_asset_type(filename, asset_type):
return asset_type
return ASSET_TYPE_UNKNOWN
def get_icon(filename: str) -> str:
"""
Returns icon for specified file.
Args:
filename (str)
Returns:
str: Fullpath to the icon file, None if not found.
"""
if not filename:
return None
icon = None
asset_type = get_asset_type(filename)
asset_types = known_asset_types()
if asset_type in asset_types:
icon = asset_types[asset_type].glyph
return icon
def get_thumbnail(filename: str) -> str:
"""
Returns thumbnail for specified file.
Args:
filename (str)
Returns:
str: Fullpath to the thumbnail file, None if not found.
"""
if not filename:
return None
thumbnail = None
asset_type = get_asset_type(filename)
asset_types = known_asset_types()
if asset_type == ASSET_TYPE_ICON:
thumbnail = filename
else:
if asset_type in asset_types:
thumbnail = asset_types[asset_type].thumbnail
import omni.kit.app
ext_path = omni.kit.app.get_app().get_extension_manager().get_extension_path_by_module(__name__)
thumbnail_path = Path(ext_path).joinpath(f"data").joinpath("thumbnails").absolute()
return thumbnail or f"{thumbnail_path}/unknown_file_256.png"
| 10,207 | Python | 33.140468 | 122 | 0.627902 |
omniverse-code/kit/exts/omni.kit.helper.file_utils/omni/kit/helper/file_utils/tests/test_event_queue.py | ## Copyright (c) 2018-2019, 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.app
from unittest.mock import Mock
from omni.kit.test.async_unittest import AsyncTestCase
from omni.kit.helper.file_utils import asset_types
from .. import (
FILE_OPENED_EVENT, FILE_SAVED_EVENT, FileEventModel,
get_instance, get_latest_urls_from_event_queue, get_last_url_opened, get_last_url_saved
)
class TestOpenedQueue(AsyncTestCase):
"""Testing Opened Queue"""
async def setUp(self):
pass
async def tearDown(self):
get_instance().clear_event_queue()
async def test_get_latest_urls_opened_succeeds(self):
"""Test saving and retrieving url's from the saved queue"""
test_events = [
(FILE_OPENED_EVENT, "omniverse://ov-test/stage.usd", "tag-1"),
(FILE_OPENED_EVENT, "omniverse://ov-test/image.jpg", None),
(FILE_SAVED_EVENT, "omniverse://ov-baz/folder/", "tag-1"),
(FILE_SAVED_EVENT, "omniverse://ov-foo/last_image.png", None),
(FILE_OPENED_EVENT, "omniverse://ov-bar/last_material.mdl", "tag-1"),
(FILE_OPENED_EVENT, "omniverse://ov-baz/last_url.usd", "tag-2"),
]
under_test = get_instance()
under_test.clear_event_queue()
# Add test urls to queue via event stream
event_stream = omni.kit.app.get_app().get_message_bus_event_stream()
for event_type, url, tag in test_events:
file_event = FileEventModel(url=url, is_folder=url.endswith('/'), tag=tag)
event_stream.push(event_type, payload=file_event.dict())
for _ in range(10):
await omni.kit.app.get_app().next_update_async()
self.assertEqual(len(test_events), len(under_test._event_queue))
self.assertEqual(4, len(get_latest_urls_from_event_queue(num_latest=10, event_type=FILE_OPENED_EVENT)))
self.assertEqual(2, len(get_latest_urls_from_event_queue(num_latest=10, event_type=FILE_SAVED_EVENT)))
self.assertEqual(3, len(get_latest_urls_from_event_queue(num_latest=10, tag="tag-1")))
self.assertEqual(1, len(get_latest_urls_from_event_queue(num_latest=10, asset_type=asset_types.ASSET_TYPE_USD, tag="tag-1")))
self.assertTrue("last_url" in get_last_url_opened())
self.assertTrue("last_material" in get_last_url_opened(asset_type=asset_types.ASSET_TYPE_MATERIAL))
self.assertTrue("last_image" in get_last_url_saved(asset_type=asset_types.ASSET_TYPE_IMAGE))
# Confirm queue was properly saved into user settings
expected = test_events[::-1] # LIFO list matches the order of the event queue
self._event_queue = under_test._load_queue_from_settings() # Reload queue from settings
self.assertEqual(len(under_test.event_queue), len(expected))
for i, entry in enumerate(under_test.event_queue.items()):
file_event = entry[1]
test_url = expected[i]
self.assertEqual(file_event.url, test_url[1])
self.assertEqual(file_event.tag, test_url[2])
self.assertEqual(file_event.is_folder, test_url[1].endswith('/'))
| 3,506 | Python | 47.708333 | 133 | 0.669994 |
omniverse-code/kit/exts/omni.kit.helper.file_utils/omni/kit/helper/file_utils/tests/test_asset_types.py | ## Copyright (c) 2018-2019, 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 .. import asset_types
class TestAssetTypes(omni.kit.test.AsyncTestCase):
"""Testing FilePickerModel.*asset_type"""
async def setUp(self):
self.test_filenames = [
("test.settings.usd", asset_types.ASSET_TYPE_USD_SETTINGS),
("test.settings.usda", asset_types.ASSET_TYPE_USD_SETTINGS),
("test.settings.usdc", asset_types.ASSET_TYPE_USD_SETTINGS),
("test.settings.usdz", asset_types.ASSET_TYPE_USD_SETTINGS),
("test.fbx", asset_types.ASSET_TYPE_FBX),
("test.obj", asset_types.ASSET_TYPE_OBJ),
("test.mdl", asset_types.ASSET_TYPE_MATERIAL),
("test.mtlx", asset_types.ASSET_TYPE_MATERIAL),
("test.bmp", asset_types.ASSET_TYPE_IMAGE),
("test.gif", asset_types.ASSET_TYPE_IMAGE),
("test.jpg", asset_types.ASSET_TYPE_IMAGE),
("test.jpeg", asset_types.ASSET_TYPE_IMAGE),
("test.png", asset_types.ASSET_TYPE_IMAGE),
("test.tga", asset_types.ASSET_TYPE_IMAGE),
("test.tif", asset_types.ASSET_TYPE_IMAGE),
("test.tiff", asset_types.ASSET_TYPE_IMAGE),
("test.hdr", asset_types.ASSET_TYPE_IMAGE),
("test.dds", asset_types.ASSET_TYPE_IMAGE),
("test.exr", asset_types.ASSET_TYPE_IMAGE),
("test.psd", asset_types.ASSET_TYPE_IMAGE),
("test.ies", asset_types.ASSET_TYPE_IMAGE),
("test.wav", asset_types.ASSET_TYPE_SOUND),
("test.wav", asset_types.ASSET_TYPE_SOUND),
("test.wave", asset_types.ASSET_TYPE_SOUND),
("test.ogg", asset_types.ASSET_TYPE_SOUND),
("test.oga", asset_types.ASSET_TYPE_SOUND),
("test.flac", asset_types.ASSET_TYPE_SOUND),
("test.fla", asset_types.ASSET_TYPE_SOUND),
("test.mp3", asset_types.ASSET_TYPE_SOUND),
("test.m4a", asset_types.ASSET_TYPE_SOUND),
("test.spx", asset_types.ASSET_TYPE_SOUND),
("test.opus", asset_types.ASSET_TYPE_SOUND),
("test.adpcm", asset_types.ASSET_TYPE_SOUND),
("test.py", asset_types.ASSET_TYPE_SCRIPT),
("test.nvdb", asset_types.ASSET_TYPE_VOLUME),
("test.vdb", asset_types.ASSET_TYPE_VOLUME),
("test.svg", asset_types.ASSET_TYPE_ICON),
(".thumbs", asset_types.ASSET_TYPE_HIDDEN),
("test.usd", asset_types.ASSET_TYPE_USD),
("test.usda", asset_types.ASSET_TYPE_USD),
("test.usdc", asset_types.ASSET_TYPE_USD),
("test.usdz", asset_types.ASSET_TYPE_USD),
("test.live", asset_types.ASSET_TYPE_USD),
]
async def tearDown(self):
pass
async def test_is_asset_type(self):
"""Testing asset_types.is_asset_type returns expected result"""
for test_filename in self.test_filenames:
filename, expected = test_filename
self.assertTrue(asset_types.is_asset_type(filename, expected))
async def test_get_asset_type(self):
"""Testing asset_types.get_asset_type returns expected result"""
for test_filename in self.test_filenames:
filename, expected = test_filename
self.assertEqual(asset_types.get_asset_type(filename), expected)
# Test unknown file type
self.assertEqual(asset_types.get_asset_type("test.unknown"), asset_types.ASSET_TYPE_UNKNOWN)
async def test_get_icon(self):
"""Testing asset_types.get_icon returns expected icon for asset type"""
for test_filename in self.test_filenames:
filename, asset_type = test_filename
if asset_type not in [asset_types.ASSET_TYPE_ICON, asset_types.ASSET_TYPE_HIDDEN]:
expected = asset_types._known_asset_types[asset_type].glyph
self.assertEqual(asset_types.get_icon(filename), expected)
async def test_get_thumbnail(self):
"""Testing FilePickerModel.get_thumbnail returns correct thumbnail for asset type"""
for test_filename in self.test_filenames:
filename, asset_type = test_filename
if asset_type not in [asset_types.ASSET_TYPE_ICON, asset_types.ASSET_TYPE_HIDDEN]:
expected = asset_types._known_asset_types[asset_type].thumbnail
self.assertEqual(asset_types.get_thumbnail(filename), expected)
async def test_register_file_extensions(self):
"""Testing FilePickerModel.register_file_extensions"""
# Add to existing type
asset_types.register_file_extensions("usd", [".test", "testz"])
self.assertTrue(asset_types.is_asset_type("file.testz", "usd"))
# Register new type
test_type = "test"
asset_types.register_file_extensions(test_type, [".test", "testz"])
self.assertTrue(asset_types.is_asset_type("file.test", test_type))
self.assertTrue(asset_types.is_asset_type("file.testz", test_type))
| 5,417 | Python | 49.635514 | 100 | 0.625623 |
omniverse-code/kit/exts/omni.kit.actions.window/omni/kit/actions/window/style.py | __all__ = ["ActionsWindowStyle"]
from omni.ui import color as cl
from pathlib import Path
CURRENT_PATH = Path(__file__).parent
ICON_PATH = CURRENT_PATH.parent.parent.parent.parent.joinpath("data").joinpath("icons")
VIEW_ROW_HEIGHT = 28
"""Style colors"""
# https://confluence.nvidia.com/pages/viewpage.action?pageId=1218553472&preview=/1218553472/1359943485/image2022-6-7_13-20-4.png
cl.actions_column_header_background = cl.shade(cl("#323434"))
cl.actions_text = cl.shade(cl("#848484"))
cl.actions_background = cl.shade(cl("#1F2123"))
cl.actions_background_hovered = cl.shade(cl("#2A2B2C"))
cl.actions_background_selected = cl.shade(cl("#77878A"))
cl.actions_item_icon_expand_background = cl.shade(cl('#9E9E9E'))
cl.actions_row_background = cl.shade(cl('#444444'))
ACTIONS_WINDOW_STYLE = {
"ActionsView": {
"background_color": cl.actions_background,
"scrollbar_size": 10,
"background_selected_color": 0x109D905C, # Same in stage window
"secondary_selected_color": 0xFFB0703B, # column resize
"secondary_color": cl.actions_text, # column splitter
},
"ActionsView:selected": {
"background_color": cl.actions_background_selected,
},
"ActionsView.Row.Background": {"background_color": cl.actions_row_background},
"ActionsView.Header.Background": {"background_color": cl.actions_column_header_background},
"ActionsView.Header.Text": {"color": cl.actions_text, "margin": 4},
"ActionsView.Item.Text": {"color": cl.actions_text, "margin": 4},
"ActionsView.Item.Text:selected": {"color": cl.actions_background},
"ActionsView.Item.Icon.Background": {"background_color": cl.actions_item_icon_expand_background, "border_radius": 2},
"ActionsView.Item.Icon.Background:selected": {"background_color": cl.actions_background},
"ActionsView.Item.Icon.Text": {"color": cl.actions_background},
"ActionsView.Item.Icon.Text:selected": {"color": cl.actions_text},
}
HIGHLIGHT_LABEL_STYLE = {
"HStack": {"margin": 4},
"Label": {"color": cl.actions_text},
"Label:selected": {"color": cl.actions_background},
}
| 2,104 | Python | 43.787233 | 128 | 0.696293 |
omniverse-code/kit/exts/omni.kit.actions.window/omni/kit/actions/window/extension.py | __all__ = ["ActionsExtension"]
from functools import partial
import carb.settings
import omni.ext
import omni.ui as ui
import omni.kit.ui
from omni.kit.actions.core import get_action_registry
from .window import ActionsWindow
SETTING_SHOW_STARTUP = "/exts/omni.kit.actions.window/showStartup"
class ActionsExtension(omni.ext.IExt):
WINDOW_NAME = "Actions"
MENU_PATH = f"Window/{WINDOW_NAME}"
def on_startup(self):
self._actions_window = None
ui.Workspace.set_show_window_fn(
ActionsExtension.WINDOW_NAME,
partial(self.show_window, ActionsExtension.MENU_PATH),
)
show_startup = carb.settings.get_settings().get(SETTING_SHOW_STARTUP)
editor_menu = omni.kit.ui.get_editor_menu()
if editor_menu:
self._menu = editor_menu.add_item(ActionsExtension.MENU_PATH, self.show_window, toggle=True, value=show_startup)
if show_startup:
ui.Workspace.show_window(ActionsExtension.WINDOW_NAME)
def on_shutdown(self):
if self._actions_window:
self._actions_window.destroy()
self._actions_window = None
ui.Workspace.set_show_window_fn(ActionsExtension.WINDOW_NAME, None)
def show_window(self, menu_path: str, visible: bool):
if visible:
self._actions_window = ActionsWindow(ActionsExtension.WINDOW_NAME)
self._actions_window.set_visibility_changed_fn(self._visiblity_changed_fn)
elif self._actions_window:
self._actions_window.visible = False
def _set_menu(self, checked: bool):
"""Set the menu to create this window on and off"""
editor_menu = omni.kit.ui.get_editor_menu()
if editor_menu:
editor_menu.set_value(ActionsExtension.MENU_PATH, checked)
def _visiblity_changed_fn(self, visible):
self._set_menu(visible)
| 1,887 | Python | 32.122806 | 124 | 0.660307 |
omniverse-code/kit/exts/omni.kit.actions.window/omni/kit/actions/window/__init__.py | __all__ = [
"ActionsExtension",
"AbstractActionItem",
"ActionExtItem",
"AbstractActionsModel",
"ColumnRegistry",
"ActionsView",
"AbstractColumnDelegate",
"StringColumnDelegate",
"ActionsDelegate",
"ActionsPicker",
"ACTIONS_WINDOW_STYLE",
]
from .extension import *
from .model.abstract_actions_model import AbstractActionItem, ActionExtItem, AbstractActionsModel
from .column_registry import ColumnRegistry
from .widget.actions_view import ActionsView
from .delegate.abstract_column_delegate import AbstractColumnDelegate
from .delegate.string_column_delegate import StringColumnDelegate
from .delegate.actions_delegate import ActionsDelegate
from .picker import ActionsPicker
from .style import ACTIONS_WINDOW_STYLE
| 761 | Python | 32.130433 | 97 | 0.780552 |
omniverse-code/kit/exts/omni.kit.actions.window/omni/kit/actions/window/picker.py | __all__ = ["ActionColumnDelegate", "ActionsPicker"]
import omni.ui as ui
from typing import List, Callable
from omni.kit.actions.core import Action
from .window import ActionsWindow
from .model.actions_item import AbstractActionItem, ActionDetailItem
from .delegate.string_column_delegate import StringColumnDelegate
class ActionColumnDelegate(StringColumnDelegate):
"""
A simple delegate to display a action in column.
Kwargs:
get_value_fn (Callable[[ui.AbstractItem], str]): Callback function to get item display string. Default using item.id
width (ui.Length): Column width. Default ui.Fraction(1).
"""
def get_value(self, item: ActionDetailItem):
if self._get_value_fn:
return self._get_value_fn(item)
else:
if isinstance(item, ActionDetailItem):
# Show action display name instead action id
return item.action.display_name
else:
return item.id
class ActionsPicker(ActionsWindow):
def __init__(self,
width=0,
height=600,
on_selected_fn: Callable[[Action],None]=None,
expand_all: bool=True,
focus_search: bool=True
):
super().__init__("###ACTION_PICKER", width=width, height=height)
self.flags = ui.WINDOW_FLAGS_NO_TITLE_BAR | ui.WINDOW_FLAGS_NO_RESIZE | ui.WINDOW_FLAGS_NO_MOVE | ui.WINDOW_FLAGS_POPUP
self.__on_selected_fn = on_selected_fn
self.__expand_all = expand_all
self.__focus_search = focus_search
def _register_column_delegates(self):
self._column_registry.register_delegate(ActionColumnDelegate("Action", width=200))
def _build_ui(self):
super()._build_ui()
self._actions_view.set_selection_changed_fn(self._on_selection_changed)
if self.__expand_all:
self._actions_view.set_expanded(None, True, True)
if self.__focus_search and self._search_field:
self._search_field._search_field.focus_keyboard()
def _on_selection_changed(self, selections: List[AbstractActionItem]):
for item in selections:
if isinstance(item, ActionDetailItem):
if self.__on_selected_fn:
self.__on_selected_fn(item.action)
def _on_search_action(self, action: Action, word: str) -> bool:
# In pick mode, only display extension id and display name
# So we only search in these two fields
if word.lower() in action.extension_id.lower() \
or word.lower() in action.display_name.lower():
return True
return False | 2,623 | Python | 38.164179 | 127 | 0.64125 |
omniverse-code/kit/exts/omni.kit.actions.window/omni/kit/actions/window/column_registry.py | __all__ = ["ColumnRegistry"]
from typing import Optional, Dict
import carb
from .delegate.abstract_column_delegate import AbstractColumnDelegate
class ColumnRegistry:
"""
Registry for action columns.
"""
def __init__(self):
self._max_column_id = -1
self._delegates: Dict[int, AbstractColumnDelegate] = {}
@property
def max_column_id(self) -> int:
"""
Max column id registered.
"""
return self._max_column_id
def register_delegate(self, delegate: AbstractColumnDelegate, column_id: int=-1, overwrite_if_exists: bool=True) -> bool:
"""
Register a delegate for a column.
Args:
delegate (AbstractColumnDelegate): Delegate to show a column.
Kwargs:
column_id (int): Column id. Default -1 means auto generation.
overwrite_if_exists (bool): Overwrite exising delegate if True. Otherwise False.
"""
if column_id < 0:
column_id = self._max_column_id + 1
if column_id in self._delegates:
if not overwrite_if_exists:
carb.log_warn(f"A delegate already registered for column {column_id}!")
return False
self._delegates[column_id] = delegate
self._max_column_id = column_id
return True
def unregister_delegate(self, column_id: int) -> bool:
"""
Unregister a delegate for a column.
Args:
column_id (int): Column id to unregister.
"""
if column_id in self._delegates:
self._delegates.pop(column_id)
if column_id == self._max_column_id:
self._max_column_id -= 1
def get_delegate(self, column_id: int) -> Optional[AbstractColumnDelegate]:
"""
Retrieve a delegate for a column.
Args:
column_id (int): Column id.
"""
if column_id in self._delegates:
return self._delegates[column_id]
else:
return None
| 2,034 | Python | 29.833333 | 126 | 0.576205 |
omniverse-code/kit/exts/omni.kit.actions.window/omni/kit/actions/window/window.py | __all__ = ["ActionsWindow"]
from .model.actions_model import ActionsModel, ActionDetailItem
from .column_registry import ColumnRegistry
from .widget.actions_view import ActionsView
from .delegate.actions_delegate import ActionsDelegate
from .delegate.string_column_delegate import StringColumnDelegate
from .style import ACTIONS_WINDOW_STYLE
import omni.ui as ui
from omni.kit.actions.core import Action
from typing import List, Optional
class ActionsWindow(ui.Window):
"""
Window to show registered actions.
"""
def __init__(self, title: str, width=1200, height=600):
self._search_field = None
super().__init__(title, width=width, height=height)
self.frame.set_style(ACTIONS_WINDOW_STYLE)
self.frame.set_build_fn(self._build_ui)
def destroy(self):
self.visible = False
if self._search_field:
self._search_field.destroy()
self._actions_view = None
def _register_column_delegates(self):
self._column_registry.register_delegate(StringColumnDelegate("Action", width=200))
self._column_registry.register_delegate(
StringColumnDelegate(
"Display Name",
get_value_fn=lambda item: item.action.display_name if isinstance(item, ActionDetailItem) else "",
width=300
)
)
self._column_registry.register_delegate(
StringColumnDelegate(
"Tag",
get_value_fn=lambda item: item.action.tag if isinstance(item, ActionDetailItem) else "",
width=160,
)
)
self._column_registry.register_delegate(
StringColumnDelegate(
"Icon Url",
lambda item: item.action.icon_url if isinstance(item, ActionDetailItem) else "",
width=120,
)
)
self._column_registry.register_delegate(
StringColumnDelegate(
"Description",
lambda item: item.action.description if isinstance(item, ActionDetailItem) else "",
width=200,
)
)
def _build_ui(self):
self._column_registry = ColumnRegistry()
self._register_column_delegates()
self._actions_model = ActionsModel(self._column_registry, on_search_action_fn=self._on_search_action)
self._actions_delegate = ActionsDelegate(self._actions_model, self._column_registry)
with self.frame:
with ui.VStack(spacing=4):
try:
from omni.kit.widget.searchfield import SearchField
self._search_field = SearchField(
on_search_fn=self._on_search,
subscribe_edit_changed=True,
style=ACTIONS_WINDOW_STYLE,
show_tokens=False,
)
except ImportError:
self._search_field = None
with ui.ScrollingFrame(
horizontal_scrollbar_policy=ui.ScrollBarPolicy.SCROLLBAR_AS_NEEDED,
vertical_scrollbar_policy=ui.ScrollBarPolicy.SCROLLBAR_ALWAYS_ON,
style_type_name_override="ActionsView",
):
self._actions_view = ActionsView(self._actions_model, self._actions_delegate)
def _on_search(self, search_words: Optional[List[str]]) -> None:
self._actions_model.search(search_words)
# Auto expand on searching
self._actions_view.set_expanded(None, True, True)
def _on_search_action(self, action: Action, word: str) -> bool:
if word.lower() in action.extension_id.lower() \
or word.lower() in action.id.lower() \
or word.lower() in action.display_name.lower() \
or word.lower() in action.description.lower() \
or word.lower() in action.tag.lower() \
or word.lower() in action.icon_url.lower():
return True
return False
| 4,048 | Python | 37.932692 | 113 | 0.589427 |
omniverse-code/kit/exts/omni.kit.actions.window/omni/kit/actions/window/widget/actions_view.py | __all__ = ["ActionsView"]
import omni.ui as ui
from ..model.abstract_actions_model import AbstractActionsModel
from ..delegate.actions_delegate import ActionsDelegate
class ActionsView(ui.TreeView):
def __init__(self, model: AbstractActionsModel, delegate: ActionsDelegate):
super().__init__(
model,
delegate=delegate,
root_visible=False,
header_visible=True,
columns_resizable=True,
style_type_name_override="ActionsView"
)
self.column_widths = delegate.column_widths
| 571 | Python | 30.777776 | 79 | 0.646235 |
omniverse-code/kit/exts/omni.kit.actions.window/omni/kit/actions/window/delegate/actions_delegate.py | __all__ = ["ActionsDelegate"]
from typing import List
import omni.ui as ui
from typing import Optional
from .abstract_column_delegate import AbstractColumnDelegate
from ..model.abstract_actions_model import AbstractActionsModel
from ..column_registry import ColumnRegistry
from ..style import ICON_PATH, VIEW_ROW_HEIGHT
class ActionsDelegate(ui.AbstractItemDelegate):
"""
General action delegate to show action item in treeview.
Args:
column_registry (ColumnRegistry): Registry to get column delegate.
"""
def __init__(self, model: AbstractActionsModel, column_registry: ColumnRegistry):
self._model = model
self._column_registry = column_registry
self.__context_menu: Optional[ui.Menu] = None
self.__execute_menuitem: Optional[ui.MenuItem] = None
super().__init__()
@property
def column_widths(self) -> List[ui.Length]:
"""
Column widths for treeview.
"""
widths = []
for i in range(self._column_registry.max_column_id):
delegate = self._column_registry.get_delegate(i)
if delegate:
widths.append(delegate.width)
return widths
def build_branch(self, model: ui.AbstractItemModel, item: ui.AbstractItem, column_id: int=0, level: int = 0, expanded: bool = False):
"""
Build branch for column.
Refer to ui.AbstractItemDelegate.build_branch for detail.
"""
if column_id == 0:
with ui.HStack(width=20 * (level + 1), height=0):
if model.can_item_have_children(item):
with ui.ZStack():
with ui.VStack(height=VIEW_ROW_HEIGHT):
ui.Spacer()
ui.Rectangle(height=26, style_type_name_override="ActionsView.Row.Background")
ui.Spacer()
with ui.VStack():
ui.Spacer()
self.__build_expand_icon(expanded)
super().build_branch(model, item, column_id, level, expanded)
ui.Spacer()
else:
ui.Spacer()
def build_widget(self, model: ui.AbstractItemModel, item: ui.AbstractItem, column_id: int=0, level: int=0, expanded: bool=False):
"""
Build widget for column.
Refer to ui.AbstractItemDelegate.build_widget for detail.
"""
delegate = self._column_registry.get_delegate(column_id)
if delegate:
widget = delegate.build_widget(model, item, level, expanded)
if widget:
widget.set_mouse_pressed_fn(lambda x, t, b, f, i=item, d=delegate: self.on_mouse_pressed(b, i, d))
widget.set_mouse_double_clicked_fn(lambda x, y, b, f, i=item, d=delegate: self.on_mouse_double_click(b, i, d))
def build_header(self, column_id):
"""
Build header for column.
Refer to ui.AbstractItemDelegate.build_header for detail.
"""
delegate = self._column_registry.get_delegate(column_id)
if delegate:
delegate.build_header()
def on_mouse_double_click(self, button: int, item: ui.AbstractItem, column_delegate: AbstractColumnDelegate):
if button == 0:
self._model.execute(item)
def on_mouse_pressed(self, button: int, item: ui.AbstractItem, column_delegate: AbstractColumnDelegate):
if button == 1:
if self.__context_menu is None:
self.__context_menu = ui.Menu(f"ACTION CONTEXT MENU##{hash(self)}")
with self.__context_menu:
self.__execute_menuitem = ui.MenuItem("Execute")
self.__execute_menuitem.set_triggered_fn(lambda i=item: self._model.execute(item))
self.__context_menu.show()
def __build_expand_icon(self, expanded: bool):
# Draw the +/- icon
with ui.HStack():
ui.Spacer()
image_name = "Minus" if expanded else "Plus"
ui.Image(
f"{ICON_PATH}/{image_name}.svg", width=10, height=10, style_type_name_override="TreeView.Item"
)
ui.Spacer(width=5)
| 4,241 | Python | 40.588235 | 137 | 0.581938 |
omniverse-code/kit/exts/omni.kit.actions.window/omni/kit/actions/window/delegate/string_column_delegate.py | __all__ = ["StringColumnDelegate"]
from .abstract_column_delegate import AbstractColumnDelegate
from ..model.actions_item import ActionExtItem, AbstractActionItem
from ..model.abstract_actions_model import AbstractActionsModel
from ..style import HIGHLIGHT_LABEL_STYLE
import omni.ui as ui
from omni.kit.widget.highlight_label import HighlightLabel
from typing import Callable
class StringColumnDelegate(AbstractColumnDelegate):
"""
A simple delegate to display a string in column.
Kwargs:
get_value_fn (Callable[[ui.AbstractItem], str]): Callback function to get item display string. Default using item.id
width (ui.Length): Column width. Default ui.Fraction(1).
"""
def __init__(self, name: str, get_value_fn: Callable[[AbstractActionItem], str]=None, width: ui.Length=ui.Fraction(1)):
self._get_value_fn = get_value_fn
super().__init__(name, width=width)
def build_widget(self, model: AbstractActionsModel, item: AbstractActionItem, level: int, expand: bool):
if isinstance(item, ActionExtItem):
container = ui.ZStack()
with container:
with ui.VStack():
ui.Spacer()
ui.Rectangle(height=26, style_type_name_override="ActionsView.Row.Background")
ui.Spacer()
HighlightLabel(self.get_value(item), highlight=item.highlight, style=HIGHLIGHT_LABEL_STYLE, alignment=ui.Alignment.LEFT_TOP)
return container
if isinstance(item, ActionExtItem) or isinstance(item, AbstractActionItem):
label = HighlightLabel(self.get_value(item), highlight=item.highlight, style=HIGHLIGHT_LABEL_STYLE)
return label.widget
else:
return None
def get_value(self, item: AbstractActionItem):
if self._get_value_fn:
return self._get_value_fn(item)
else:
return item.id
| 1,932 | Python | 42.931817 | 140 | 0.668219 |
omniverse-code/kit/exts/omni.kit.actions.window/omni/kit/actions/window/delegate/abstract_column_delegate.py | __all__ = ["AbstractColumnDelegate"]
import omni.ui as ui
import abc
class AbstractColumnDelegate:
"""
Represent a column delegate in actions Treeview.
Args:
name (str): Column name.
width (ui.Length): Column width. Default ui.Fraction(1).
"""
def __init__(self, name: str, width: ui.Length=ui.Fraction(1)):
self._name = name
if isinstance(width, int) or isinstance(width, float):
width = ui.Pixel(width)
self._width = width
@property
def width(self) -> ui.Length:
"""
Column width.
"""
return self._width
def execute(self, item: ui.AbstractItem):
"""
Execute model item.
Args:
item (ui.AbstractItem): Item to show.
"""
pass
@abc.abstractmethod
def build_widget(self, model: ui.AbstractItemModel, item: ui.AbstractItem, level: int, expand: bool) -> ui.Widget:
"""
Build a custom column widget in TreeView.
Return created widget.
Args:
model (ui.AbstractItemModel): Actions model.
item (ui.AbstractItem): Item to show.
level (int): Level in treeview.
expand (bool): Iten expand or not.
"""
return None
def build_header(self):
"""
Build header widget in TreeView, default ui.Label(name)
"""
with ui.ZStack():
ui.Rectangle(style_type_name_override="ActionsView.Header.Background")
ui.Label(self._name, style_type_name_override="ActionsView.Header.Text")
| 1,593 | Python | 26.482758 | 118 | 0.576899 |
omniverse-code/kit/exts/omni.kit.actions.window/omni/kit/actions/window/tests/__init__.py | from .test_actions_window import *
| 35 | Python | 16.999992 | 34 | 0.771429 |
omniverse-code/kit/exts/omni.kit.actions.window/omni/kit/actions/window/tests/test_actions_window.py | from ast import Import
import omni.kit.test
import omni.kit.app
from omni.ui.tests.test_base import OmniUiTest
from omni.kit.actions.core import get_action_registry
import omni.ui as ui
import omni.kit.ui_test as ui_test
from omni.kit.ui_test import Vec2
from pathlib import Path
CURRENT_PATH = Path(__file__).parent
TEST_DATA_PATH = CURRENT_PATH.parent.parent.parent.parent.parent.joinpath("data").joinpath("tests")
ACTION_SHOW_WINDOW = "Show Actions Window"
ACTION_HIDE_WINDOW = "Hide Actions Window"
class TestActionsWindow(OmniUiTest):
async def setUp(self):
await super().setUp()
self._golden_img_dir = TEST_DATA_PATH.absolute().joinpath("golden_img").absolute()
self._ext_id = "omni.kit.actions.window.tests"
self.__register_test_actions()
window = ui.Workspace.get_window("Actions")
await self.docked_test_window(window=window, width=1280, height=400, block_devices=False)
async def tearDown(self):
# Deregister all the test actions.
self._action_registry.deregister_action(self._ext_id, ACTION_SHOW_WINDOW)
self._action_registry.deregister_action(self._ext_id, ACTION_HIDE_WINDOW)
self._action_registry = None
async def test_1_general_window(self):
# When startup, no actions loaded
result_name = "test_action_window_general"
try:
from omni.kit.widget.searchfield import SearchField
result_name += "_with_search"
# Wait for serach icon loaded
for i in range(5):
await omni.kit.app.get_app().next_update_async()
except ImportError:
pass
await self.finalize_test(golden_img_dir=self._golden_img_dir, golden_img_name=f"{result_name}.png")
async def test_2_search(self):
try:
from omni.kit.widget.searchfield import SearchField
# Actions reloaded, we can see register actions now
# Focus on search bar
await ui_test.emulate_mouse_move_and_click(Vec2(50, 17))
# Search "Show"
await ui_test.emulate_char_press("Show\n")
await ui_test.emulate_mouse_move_and_click(Vec2(0, 0))
await self.finalize_test(golden_img_dir=self._golden_img_dir, golden_img_name="test_action_window_search.png")
except ImportError:
pass
async def test_3_search_clean(self):
try:
from omni.kit.widget.searchfield import SearchField
# Focus on search bar
await ui_test.emulate_mouse_move_and_click(Vec2(50, 17))
# Clean search
await ui_test.emulate_mouse_move_and_click(Vec2(1263, 17))
await ui_test.emulate_mouse_move_and_click(Vec2(0, 0))
await self.finalize_test(golden_img_dir=self._golden_img_dir, golden_img_name="test_action_window_search_clean.png")
except ImportError:
pass
def __register_test_actions(self):
self._action_registry = get_action_registry()
self._action_registry.register_action(
self._ext_id,
ACTION_SHOW_WINDOW,
lambda: None,
display_name=ACTION_SHOW_WINDOW,
description=ACTION_SHOW_WINDOW,
tag="Actions",
)
self._action_registry.register_action(
self._ext_id,
ACTION_HIDE_WINDOW,
lambda: None,
display_name=ACTION_HIDE_WINDOW,
description=ACTION_HIDE_WINDOW,
tag="Actions",
) | 3,530 | Python | 36.563829 | 128 | 0.630312 |
omniverse-code/kit/exts/omni.kit.property.transform/omni/kit/property/transform/scripts/xform_op_utils.py | from pxr import Usd, Tf, Sdf, Gf, UsdGeom
import carb
from omni.kit.property.usd.prim_selection_payload import PrimSelectionPayload
import omni.kit
XFROM_OP_PREFIX = "xformOp:"
INVERSE_PREFIX = "!invert!"
INVERSE_XFORM_OP_PREFIX = "!invert!xformOp:"
RESET_XFORM_STACK = UsdGeom.XformOpTypes.resetXformStack
XFROM_OP_TYPE_NAME = [
"translate",
"scale",
"rotateX",
"rotateY",
"rotateZ",
"rotateXYZ",
"rotateXZY",
"rotateYXZ",
"rotateYZX",
"rotateZXY",
"rotateZYX",
"orient",
"transform",
]
XFROM_OP_TYPE = [
UsdGeom.XformOp.TypeTranslate,
UsdGeom.XformOp.TypeScale,
UsdGeom.XformOp.TypeRotateX,
UsdGeom.XformOp.TypeRotateY,
UsdGeom.XformOp.TypeRotateZ,
UsdGeom.XformOp.TypeRotateXYZ,
UsdGeom.XformOp.TypeRotateXZY,
UsdGeom.XformOp.TypeRotateYXZ,
UsdGeom.XformOp.TypeRotateYZX,
UsdGeom.XformOp.TypeRotateZXY,
UsdGeom.XformOp.TypeRotateZYX,
UsdGeom.XformOp.TypeOrient,
UsdGeom.XformOp.TypeTransform,
]
def is_inverse_op(op_name: str):
return op_name.startswith(INVERSE_XFORM_OP_PREFIX)
def is_reset_xform_stack_op(op_name: str):
return op_name == RESET_XFORM_STACK
def get_op_type_name(op_name: str):
test_name = op_name
if is_inverse_op(op_name):
test_name = op_name.split(INVERSE_PREFIX, 1)[1]
if test_name.startswith(XFROM_OP_PREFIX):
names = test_name.split(":")
if len(names) >= 2 and names[1] in XFROM_OP_TYPE_NAME:
return names[1]
return None
def get_op_type(op_name: str):
op_type_name = get_op_type_name(op_name)
return XFROM_OP_TYPE[XFROM_OP_TYPE_NAME.index(op_type_name)]
def get_op_name_suffix(op_name: str):
test_name = op_name
if is_inverse_op(op_name):
test_name = op_name.split(INVERSE_PREFIX, 1)[1]
if test_name.startswith(XFROM_OP_PREFIX):
names = test_name.split(":", 2)
if len(names) >= 3:
return names[2]
return None
def is_pivot_op(op_name: str):
op_suffix = get_op_name_suffix(op_name)
if op_suffix != None:
if op_suffix == "pivot":
return True
return False
def is_valid_op_name(op_name: str):
if is_reset_xform_stack_op(op_name):
return True
if get_op_type_name(op_name) is not None:
return True
return False
def get_op_attr_name(op_name: str):
if not is_valid_op_name(op_name):
return None
if is_reset_xform_stack_op(op_name):
return None
if is_inverse_op(op_name):
return op_name.split(INVERSE_PREFIX, 1)[1]
return op_name
def get_inverse_op_Name(ori_op_name, desired_invert):
if is_reset_xform_stack_op(ori_op_name):
return ori_op_name
if desired_invert and not is_inverse_op(ori_op_name):
return INVERSE_PREFIX + ori_op_name
if not desired_invert and is_inverse_op(ori_op_name):
return ori_op_name.split(INVERSE_PREFIX, 1)[1]
return ori_op_name
def get_op_precision(attr_type_name: Sdf.ValueTypeName):
if attr_type_name in [Sdf.ValueTypeNames.Float3, Sdf.ValueTypeNames.Quatf, Sdf.ValueTypeNames.Float]:
return UsdGeom.XformOp.PrecisionFloat
if attr_type_name in [
Sdf.ValueTypeNames.Double3,
Sdf.ValueTypeNames.Quatd,
Sdf.ValueTypeNames.Double,
Sdf.ValueTypeNames.Matrix4d,
]:
return UsdGeom.XformOp.PrecisionDouble
if attr_type_name in [Sdf.ValueTypeNames.Half3, Sdf.ValueTypeNames.Quath, Sdf.ValueTypeNames.Half]:
return UsdGeom.XformOp.PrecisionHalf
return UsdGeom.XformOp.PrecisionDouble
def _add_trs_op(
payload: PrimSelectionPayload
):
settings = carb.settings.get_settings()
# Retrieve the default precision
default_xform_op_precision = settings.get("/persistent/app/primCreation/DefaultXformOpPrecision")
if default_xform_op_precision is None:
settings.set_default_string(
"/persistent/app/primCreation/DefaultXformOpPrecision", "Double"
)
default_xform_op_precision = "Double"
_precision = UsdGeom.XformOp.PrecisionDouble
if default_xform_op_precision == "Double":
_precision = UsdGeom.XformOp.PrecisionDouble
elif default_xform_op_precision == "Float":
_precision = UsdGeom.XformOp.PrecisionFloat
elif default_xform_op_precision == "Half":
_precision = UsdGeom.XformOp.PrecisionHalf
# Retrieve the default rotation order
default_rotation_order = settings.get("/persistent/app/primCreation/DefaultRotationOrder")
if default_rotation_order is None:
settings.set_default_string("/persistent/app/primCreation/DefaultRotationOrder", "XYZ")
default_rotation_order = "XYZ"
omni.kit.commands.execute("AddXformOp", payload=payload, precision=_precision, rotation_order = default_rotation_order, add_translate_op = True,
add_rotateXYZ_op = True, add_orient_op=False, add_scale_op = True, add_transform_op = False, add_pivot_op = False)
| 4,957 | Python | 31.194805 | 148 | 0.680048 |
omniverse-code/kit/exts/omni.kit.property.transform/omni/kit/property/transform/scripts/transform_model.py | from typing import Callable
import weakref
import carb
import omni.timeline
import omni.ui as ui
import omni.usd
from pxr import Usd, Sdf, Tf, Gf
from omni.kit.property.usd.usd_attribute_model import (
FloatModel,
UsdBase,
UsdAttributeModel,
GfVecAttributeModel,
)
# TODO: will add controlstate
class VecAttributeModel(ui.AbstractItemModel):
def __init__(self, default_value, begin_edit_callback: Callable[[None], None] = None, end_edit_callback: Callable[[Gf.Vec3d], None] = None):
super().__init__()
# We want to parse the values of this model to look for math operations,
# so its items need to use string models instead of float models
class StringModel(ui.SimpleStringModel):
def __init__(self, parent, index):
super().__init__()
self._parent = weakref.ref(parent)
self.index = index
def begin_edit(self):
parent = self._parent()
parent.begin_edit(self)
def end_edit(self):
parent = self._parent()
parent.end_edit(self)
class VectorItem(ui.AbstractItem):
def __init__(self, model):
super().__init__()
self.model = model
dimension = 3
self._items = [VectorItem(StringModel(self, i)) for i in range(dimension)]
self._default_value = default_value
self._begin_edit_callback = begin_edit_callback
self._end_edit_callback = end_edit_callback
for item in self._items:
item.model.set_value(self._default_value)
self._root_model = ui.SimpleStringModel()
self._root_model.add_value_changed_fn(lambda a: self._item_changed(None))
def get_item_children(self, item):
return self._items
def get_item_value_model(self, item, column_id):
if item is None:
return self._root_model
return item.model
def _on_value_changed(self, item):
pass
def begin_edit(self, item):
index = item.index
if self._begin_edit_callback:
self._begin_edit_callback(index)
def end_edit(self, model):
text = model.get_value_as_string()
index = model.index
for item in self._items:
item.model.set_value(self._default_value)
if self._end_edit_callback:
self._end_edit_callback(text, index)
| 2,443 | Python | 29.936708 | 144 | 0.598854 |
omniverse-code/kit/exts/omni.kit.property.transform/omni/kit/property/transform/scripts/transform_widget.py | import traceback
import carb
import omni.usd
import omni.ui as ui
from functools import lru_cache
from pxr import UsdGeom, Tf, Usd, Sdf
from pxr import Trace
from collections import defaultdict
from typing import Any, DefaultDict, Dict, List, Sequence, Set, Tuple
from .transform_builder import TransformWidgets
from omni.kit.property.usd import ADDITIONAL_CHANGED_PATH_EVENT_TYPE
from omni.kit.property.usd.usd_property_widget import UsdPropertiesWidget, get_group_properties_clipboard, set_group_properties_clipboard
from omni.kit.property.usd.usd_attribute_model import GfVecAttributeSingleChannelModel
from omni.kit.window.property.templates import GroupHeaderContextMenuEvent, GroupHeaderContextMenu
from omni.kit.widget.settings import get_style
from .xform_op_utils import _add_trs_op
@lru_cache()
def _get_plus_glyph():
return ui.get_custom_glyph_code("${glyphs}/menu_context.svg")
class TransformAttributeWidget(UsdPropertiesWidget):
def __init__(self, title: str, collapsed: bool):
super().__init__(title="Transform", collapsed=False)
self._transform_widget = TransformWidgets(self)
self._listener = None
self._models = defaultdict(list)
self._offset_mode = False
self._link_scale = False
def on_new_payload(self, payload):
if not super().on_new_payload(payload):
return False
stage = self._payload.get_stage()
if not stage or not len(self._payload):
return False
for path in self._payload:
prim = stage.GetPrimAtPath(path)
if not prim.IsA(UsdGeom.Xformable):
return False
return True
def clean(self):
"""
See PropertyWidget.clean
"""
if self._transform_widget:
self._transform_widget._clear_widgets()
self._transform_widget = None
super().clean()
def build_items(self):
self.reset()
if len(self._payload) == 0:
return
last_prim = self._get_prim(self._payload[-1])
if not last_prim:
return
stage = last_prim.GetStage()
if not stage:
return
self._listener = Tf.Notice.Register(Usd.Notice.ObjectsChanged, self._on_usd_changed, stage)
self._bus_sub = self._message_bus.create_subscription_to_pop_by_type(ADDITIONAL_CHANGED_PATH_EVENT_TYPE, self._on_bus_event)
# for prim_path in self._payload:
if self._payload is not None:
if self._offset_mode:
self._models = self._transform_widget.build_transform_offset_frame(self._payload, self._collapsable_frame, stage)
else:
self._models, all_empty_xformop = self._transform_widget.build_transform_frame(self._payload, self._collapsable_frame, stage)
if len(self._transform_widget._widgets) > 0:
self._any_item_visible = True
else:
# OM-51604 When no xformOpOrder element nor xformOp attributes, a special widget and button for it
label_style = {"font_size":18}
with ui.VStack(spacing=8):
if len(self._payload) == 1:
ui.Label("This prim has no transforms", style=label_style, alignment=ui.Alignment.CENTER)
ui.Button(f'{_get_plus_glyph()} Add Transforms', clicked_fn=self._on_add_transform)
elif all_empty_xformop == False:
ui.Label("The selected prims have no common transforms to display", style=label_style, alignment=ui.Alignment.CENTER)
else:
ui.Label("None of the selected prims has transforms", style=label_style, alignment=ui.Alignment.CENTER)
ui.Button(f'{_get_plus_glyph()} Add Transforms', clicked_fn=self._on_add_transform)
if self._models is None:
self._models = defaultdict(list)
# Register the Copy/Paste/Reset All content context menu
self._build_header_context_menu('Tranform')
@Trace.TraceFunction
def _on_usd_changed(self, notice, stage):
if stage != self._payload.get_stage():
return
for path in notice.GetChangedInfoOnlyPaths():
# if anyone changes the xformOpOrder of the current prim rebuild the collapsable frame
if str(path).split(".")[-1] == "xformOpOrder" and path.GetPrimPath() in self._payload:
super().request_rebuild()
return
super()._on_usd_changed(notice, stage)
def _build_frame_header(self, collapsed, text: str, id: str = None):
"""Custom header for CollapsableFrame"""
if id is None:
id = text
if collapsed:
alignment = ui.Alignment.RIGHT_CENTER
width = 5
height = 7
else:
alignment = ui.Alignment.CENTER_BOTTOM
width = 7
height = 5
header_stack = ui.HStack(spacing=8)
with header_stack:
with ui.VStack(width=0):
ui.Spacer()
ui.Triangle(
style_type_name_override="CollapsableFrame.Header", width=width, height=height, alignment=alignment
)
ui.Spacer()
ui.Label(text, style_type_name_override="CollapsableFrame.Header", width = ui.Fraction(1))
button_style = {
"Button.Image": {
"color": 0xFFFFFFFF,
"alignment": ui.Alignment.CENTER,
},
}
if self._offset_mode:
defaultStyle = get_style()
label_style = defaultStyle.get("CollapsableFrame.Header", {})
label_style.update({"color": 0xFFFFC734})
ui.Label("Offset", style=label_style, width = ui.Fraction(1))
ui.Spacer(width = ui.Fraction(5))
button_style["Button.Image"]["image_url"] = "${glyphs}/offset_active_dark.svg"
else:
ui.Spacer(width = ui.Fraction(6))
button_style["Button.Image"]["image_url"] = "${glyphs}/offset_dark.svg"
with ui.ZStack(content_clipping = True, width=25, height=25):
ui.Button("",
style = button_style,
clicked_fn = self._toggle_offset_mode,
identifier = "offset_mode_toggle",
tooltip = "Toggle offset mode")
def show_attribute_context_menu(b):
if b != 1:
return
event = GroupHeaderContextMenuEvent(group_id=id, payload=[])
GroupHeaderContextMenu.on_mouse_event(event)
header_stack.set_mouse_pressed_fn(lambda x, y, b, _: show_attribute_context_menu(b))
def _toggle_offset_mode(self):
self._offset_mode = not self._offset_mode
self.request_rebuild()
def _toggle_link_scale(self):
self._link_scale = not self._link_scale
self.request_rebuild()
def _on_add_transform(self):
_add_trs_op(self._payload)
self.request_rebuild()
def _build_header_context_menu(self, group_id: str):
#------Copy All Context Menu--------
def can_copy(object):
# Only support single selection copy
return len(self._payload) == 1
def on_copy(object):
prim = self._get_prim(self._payload[-1])
xformOpOrderAttr = prim.GetAttribute("xformOpOrder")
if not xformOpOrderAttr:
return
xformOpOrder = xformOpOrderAttr.Get()
visited_models = set()
properties_to_copy: Dict[Sdf.Path, Any] = dict()
for models in self._models.values():
for model in models:
if model in visited_models:
continue
visited_models.add(model)
# Skip "Mixed"
if model.is_ambiguous():
continue
paths = model.get_property_paths()
if paths:
# No need to copy single channel model. Each vector attribute also has a GfVecAttributeModel
if isinstance(model, GfVecAttributeSingleChannelModel):
continue
properties_to_copy[paths[-1]] = model.get_value()
if properties_to_copy:
properties_to_copy[Sdf.Path(xformOpOrderAttr.GetName())] = xformOpOrder
set_group_properties_clipboard(properties_to_copy)
menu = {
"name": f'Copy All Property Values in Transform',
"show_fn": lambda object: True,
"enabled_fn": can_copy,
"onclick_fn": on_copy,
}
self._group_menu_entries.append(self._register_header_context_menu_entry(menu, 'Transform'))
#------Paste All Context Menu--------
def can_paste(object):
# Only support single selection copy
properties_to_paste = get_group_properties_clipboard()
if not properties_to_paste:
return False
# Can't paste if the copied content doesn't have xformOpOrder key
sourceXformOpOrderValue = properties_to_paste[Sdf.Path("xformOpOrder")]
if sourceXformOpOrderValue is None:
return False
prim = self._get_prim(self._payload[-1])
if not prim:
return False
xformOpOrderAttr = prim.GetAttribute("xformOpOrder")
# Can't paste if the target prim doesn't have xformOpOrder
if not xformOpOrderAttr:
return False
targetXformOpOrderValue = xformOpOrderAttr.Get()
# Can't paste if the copied content and target prim's xformOpOrder doesn't match
if not targetXformOpOrderValue or sourceXformOpOrderValue != targetXformOpOrderValue:
return False
return True
def on_paste(object):
properties_to_copy = get_group_properties_clipboard()
if not properties_to_copy:
return
unique_model_prim_paths: Set[Sdf.Path] = set()
for prop_path in self._models:
unique_model_prim_paths.add(prop_path.GetPrimPath())
with omni.kit.undo.group():
try:
for path, value in properties_to_copy.items():
for prim_path in unique_model_prim_paths:
paste_to_model_path = prim_path.AppendProperty(path.name)
models = self._models.get(paste_to_model_path, [])
for model in models:
# No need to paste single channel model. Each vector attribute also has a GfVecAttributeModel
if isinstance(model, GfVecAttributeSingleChannelModel):
continue
else:
model.set_value(value)
except Exception as e:
carb.log_error(f"on_paste error:{traceback.format_exc()}")
menu = {
"name": f'Paste All Property Values to Transform',
"show_fn": lambda object: True,
"enabled_fn": can_paste,
"onclick_fn": on_paste,
}
self._group_menu_entries.append(self._register_header_context_menu_entry(menu, 'Transform'))
#------Reset All Context Menu------
def can_reset(object):
for models in self._models.values():
for model in models:
if model.is_different_from_default():
return True
return False
def on_reset(object):
for models in self._models.values():
for model in models:
model.set_default()
menu = {
"name": f'Reset All Property Values in Transform',
"show_fn": lambda object: True,
"enabled_fn": can_reset,
"onclick_fn": on_reset,
}
self._group_menu_entries.append(self._register_header_context_menu_entry(menu, 'Transform'))
| 12,429 | Python | 39.357143 | 145 | 0.561107 |
omniverse-code/kit/exts/omni.kit.property.transform/omni/kit/property/transform/scripts/transform_builder.py | from queue import Empty
from re import T
from typing import Any
import weakref
import asyncio
import os, functools, sys
from abc import ABC, abstractmethod
from enum import Enum
from functools import partial
import carb
import omni.ui as ui
import omni.ext
import omni.usd
import omni.timeline
import omni.kit.commands
import carb.settings
from omni.hydra.scene_api import *
from pxr import Gf, Tf, Vt, Usd, Sdf, UsdGeom
from pathlib import Path
from collections import defaultdict
from omni.kit.property.usd.usd_attribute_model import (
FloatModel,
UsdBase,
UsdAttributeModel,
GfVecAttributeModel,
GfVecAttributeSingleChannelModel,
GfMatrixAttributeModel,
GfQuatAttributeModel,
GfQuatEulerAttributeModel,
)
from .transform_model import VecAttributeModel
from omni.kit.widget.highlight_label import HighlightLabel
from omni.kit.property.usd.usd_property_widget_builder import UsdPropertiesWidgetBuilder
from omni.kit.context_menu import *
from .transform_commands import *
from . import xform_op_utils
# Settings constants from omni.kit.window.toolbar
TRANSFORM_OP_SETTING = "/app/transform/operation"
TRANSFORM_OP_MOVE = "move"
TRANSFORM_OP_ROTATE = "rotate"
TRANSFORM_OP_SCALE = "scale"
TRANSFORM_MOVE_MODE_SETTING = "/app/transform/moveMode"
TRANSFORM_ROTATE_MODE_SETTING = "/app/transform/rotateMode"
TRANSFORM_MODE_GLOBAL = "global"
TRANSFORM_MODE_LOCAL = "local"
LABEL_PADDING = 128
ICON_PATH = ""
quat_view_button_style = {
"Button:hovered": {"background_color": 0xFF575757},
"Button": {"background_color": 0xFF333333, "padding": 0, "stack_direction": ui.Direction.RIGHT_TO_LEFT},
"Button.Label": {"color": 0xFF9E9E9E, "alignment": ui.Alignment.LEFT_CENTER},
"Button.Tooltip": {"color": 0xFF9E9E9E},
"Button.Image": {"color": 0xFFFFCC99, "alignment": ui.Alignment.CENTER},
}
euler_view_button_style = {
"Button:hovered": {"background_color": 0xFF23211F},
"Button": {"background_color": 0xFF23211F, "padding": 0, "stack_direction": ui.Direction.RIGHT_TO_LEFT},
"Button.Label": {"color": 0xFFA07D4F, "alignment": ui.Alignment.LEFT_CENTER},
"Button.Tooltip": {"color": 0xFF9E9E9E},
"Button.Image": {"color": 0xFFFFCC99, "alignment": ui.Alignment.CENTER},
}
class USDXformOpWidget:
def __init__(
self, prim_paths, collapsable_frame, stage, attr_path, op_name, is_valid_op, op_order_attr_path, op_order_index,
label_kwargs=None,
):
self._prim_paths = prim_paths
self._collapsable_frame = collapsable_frame
self._stage = stage
self._attr_path = attr_path
self._op_name = op_name
self._is_valid_op = is_valid_op
self._op_order_attr_path = op_order_attr_path
self._op_order_index = op_order_index
self._model = None
self._right_click_menu = None
self._label_kwargs = label_kwargs if label_kwargs is not None else {}
self.rebuild()
def __del__(self):
self._prim_paths = None
self._collapsable_frame = None
self._stage = None
self._attr_path = None
self._op_name = None
self._is_valid_op = False
self._op_order_attr_path = None
self._op_order_index = -1
if self._model is not None:
if isinstance(self._model, list):
for model in self._model:
model.clean()
else:
self._model.clean()
self._model = None
self._right_click_menu = None
def rebuild(self):
pass
def _create_inverse_widgets(self):
# Not create inverse widgets for non-op attribute.
if self._op_name is None:
return
is_inverse_op = False if self._op_name is None else xform_op_utils.is_inverse_op(self._op_name)
if is_inverse_op:
ui.Label("¯¹")
''' I don't think this is used
def _inverse_op(self):
if self._op_order_attr_path is not None and self._op_order_index > -1:
order_attr = self._stage.GetObjectAtPath(self._op_order_attr_path)
if order_attr:
with Sdf.ChangeBlock():
op_order = order_attr.Get()
if self._op_order_index < len(op_order):
op_name = op_order.__getitem__(self._op_order_index)
if op_name == self._op_name:
is_inverse_op = xform_op_utils.is_inverse_op(op_name)
inverse_op_name = xform_op_utils.get_inverse_op_Name(op_name, not is_inverse_op)
self._op_name = inverse_op_name
op_order.__setitem__(self._op_order_index, inverse_op_name)
order_attr.Set(op_order)
# self._window().rebuild_window()
self._collapsable_frame.rebuild()
'''
def _add_key(self):
if self._attr_path is None or self._stage is None:
return
attr = self._stage.GetObjectAtPath(self._attr_path)
if attr:
timeline = omni.timeline.get_timeline_interface()
current_time = timeline.get_current_time()
current_time_code = Usd.TimeCode(
omni.usd.get_frame_time_code(current_time, self._stage.GetTimeCodesPerSecond())
)
if omni.usd.attr_has_timesample_on_key(attr, current_time_code):
return
if attr:
omni.usd.copy_timesamples_from_weaker_layer(self._stage, attr)
curr_value = attr.Get(current_time_code)
if not curr_value:
type_name = attr.GetTypeName()
value_type = type(type_name.defaultValue)
curr_value = value_type(attr_default_value)
new_target = self._stage.GetEditTargetForLocalLayer(self._stage.GetEditTarget().GetLayer())
with Usd.EditContext(self._stage, new_target):
attr.Set(curr_value, current_time_code)
def _delete_op_only(self):
if self._op_order_attr_path is not None and self._op_order_index > -1:
omni.kit.commands.execute(
"RemoveXformOp",
op_order_attr_path=self._op_order_attr_path,
op_name=self._op_name,
op_order_index=self._op_order_index,
)
def _delete_op_and_attribute(self):
if self._op_order_attr_path is not None and self._op_order_index > -1:
omni.kit.commands.execute(
"RemoveXformOpAndAttrbute",
op_order_attr_path=self._op_order_attr_path,
op_name=self._op_name,
op_order_index=self._op_order_index,
)
omni.kit.window.property.get_window()._window.frame.rebuild()
def _delete_non_op_attribute(self):
if self._stage is not None and self._op_name is None and self._attr_path is not None:
omni.kit.commands.execute("RemoveProperty", prop_path=self._attr_path.pathString)
omni.kit.window.property.get_window()._window.frame.rebuild()
def _add_non_op_attribute_to_op(self):
if self._stage is not None and self._op_name is None and self._attr_path is not None:
omni.kit.commands.execute("EnableXformOp", op_attr_path=self._attr_path)
# This is to toggle the value widgets for quaternion or euler angle
def _on_display_orient_as_rotate(self):
self._display_orient_as_rotate = not self._display_orient_as_rotate
if self._settings:
self._settings.set("/persistent/app/uiSettings/DisplayOrientAsRotate", self._display_orient_as_rotate)
if self._display_orient_as_rotate is True:
self._quat_view.visible = False
self._euler_view.visible = True
else:
self._quat_view.visible = True
self._euler_view.visible = False
# The orient label(button) has a different style for two modes
def _toggle_orient_button_style(self, button):
# About to switch to raw mode
if self._display_orient_as_rotate is True:
button.set_style(euler_view_button_style)
else:
button.set_style(quat_view_button_style)
def _on_orient_button_clicked(self, mouse_button, widget):
if mouse_button != 0:
return
self._on_display_orient_as_rotate()
self._toggle_orient_button_style(widget)
def _show_right_click_menu(self, button):
if button != 1:
return
if self._right_click_menu is None:
self._right_click_menu = ui.Menu("Right Menu")
self._right_click_menu.clear()
with self._right_click_menu:
# ResetXformStack
if xform_op_utils.is_reset_xform_stack_op(self._op_name):
text = "Disable" if self._is_valid_op else "Disable Invalid Op"
ui.MenuItem(text, triggered_fn=lambda: self._delete_op_only())
# valid/invalid Op
elif self._op_name is not None and self._attr_path is not None:
# ui.MenuItem("Inverse", triggered_fn=lambda: self._inverse_op())
text_op_only = "Disable" if self._is_valid_op else "Disable Invalid Op"
text_op_attr = "Delete" if self._is_valid_op else "Delete Invalid Op"
ui.MenuItem(text_op_only, triggered_fn=lambda: self._delete_op_only())
ui.MenuItem(text_op_attr, triggered_fn=lambda: self._delete_op_and_attribute())
# non-op attribute
elif self._op_name is None and self._attr_path is not None:
ui.MenuItem("Delete", triggered_fn=lambda: self._delete_non_op_attribute())
ui.MenuItem("Enable", triggered_fn=lambda: self._add_non_op_attribute_to_op())
# no-attribute op
elif self._op_name is not None and self._attr_path is None:
ui.MenuItem("Disable Invalid Op", triggered_fn=lambda: self._delete_op_only())
self._right_click_menu.show()
def _create_multi_float_drag_matrix_with_labels(self, model, comp_count, min, max, step, labels): #
RECT_WIDTH = 13
SPACING = 4
with ui.ZStack():
with ui.HStack():
ui.Spacer(width=RECT_WIDTH)
value_widget = ui.MultiFloatDragField(
model, name="multivalue", min=min, max=max, step=step, h_spacing=RECT_WIDTH + SPACING, v_spacing=2
)
with ui.HStack():
for i in range(comp_count):
if i != 0:
ui.Spacer(width=SPACING)
label = labels[i]
with ui.ZStack(width=RECT_WIDTH + 1):
ui.Rectangle(name="vector_label", style={"background_color": label[1]})
ui.Label(label[0], name="vector_label", alignment=ui.Alignment.CENTER)
ui.Spacer()
mixed_overlay = []
with ui.VStack():
for i in range(comp_count):
with ui.HStack():
for i in range(comp_count):
ui.Spacer(width=RECT_WIDTH)
mixed_overlay.append(UsdPropertiesWidgetBuilder._create_mixed_text_overlay())
UsdPropertiesWidgetBuilder._create_control_state(model, value_widget, mixed_overlay)
class TransformWatchModel(ui.AbstractValueModel):
def __init__(self, component_index, stage):
super(TransformWatchModel, self).__init__()
self._usd_context = omni.usd.get_context()
self._component_index = component_index
self._value = 0.0
self._selection = self._usd_context.get_selection()
self._prim_paths = self._selection.get_selected_prim_paths()
self._on_usd_changed()
self.usd_watcher = omni.usd.get_watcher()
self._subscription = self.usd_watcher.subscribe_to_change_info_path(
self._prim_paths[0], self._on_usd_changed
)
def clean(self):
"""Should be called when the extension is unloaded or reloaded"""
self._usd_context = None
self._selection = None
self._prim_paths = None
self._subscription.unsubscribe()
self._subscription = None
def _on_usd_changed(self, path=None): #pragma no cover
wgs_coords = get_wgs84_coords("", self._prim_paths[0])
if len(wgs_coords) > 0:
self.set_value(wgs_coords[self._component_index])
def get_value_as_float(self) -> float:
'''
Returns the value as a float
'''
return self._value or 0.0
def get_value_as_string(self) -> str:
'''
Returns the float value as a string
'''
if self._value is None:
return ""
# General format. This prints the number as a fixed-point
# number, unless the number is too large, in which case it
# switches to 'e' exponent notation.
return "{0:g}".format(self._value)
def set_value(self, new_value: Any) -> None:
'''
Attempts to cast new_value to a float and set it to the
internal value
'''
try:
value = float(new_value)
except ValueError:
value = 0.0
if value != self._value:
self._value = value
self._value_changed()
class USDXformOpTranslateWidget(USDXformOpWidget):
@classmethod
def display_name(cls, attr_name: str) -> str:
suffix = xform_op_utils.get_op_name_suffix(attr_name)
label_name = "Translate"
if suffix:
label_name = label_name + ":" + suffix
return label_name
def rebuild(self):
attr = self._stage.GetObjectAtPath(self._attr_path)
attr_name = attr.GetName()
if not attr_name.startswith("xformOp:translate"):
carb.log_warn(f"Object {self._path} is not an xformOp:translate attribute ")
return
is_inverse_op = False if self._op_name is None else xform_op_utils.is_inverse_op(self._op_name)
suffix = xform_op_utils.get_op_name_suffix(attr_name)
if is_inverse_op and suffix == "pivot":
return
label_name = self.display_name(attr_name)
# label_tooltip = get_attribute_type_tooltip(attr) + " " + attr.GetName()
metadata = attr.GetAllMetadata()
type_name = Sdf.ValueTypeNames.Find(metadata.get(Sdf.PrimSpec.TypeNameKey))
label_tooltip = UsdPropertiesWidgetBuilder._generate_tooltip_string(attr.GetName(), metadata)
self._model = []
for i in range(3):
self._model.append(
GfVecAttributeSingleChannelModel(
self._stage,
[path.AppendProperty(attr_name) for path in self._prim_paths],
i,
False,
metadata,
False,
)
)
vec_model = GfVecAttributeModel(
self._stage,
[path.AppendProperty(attr_name) for path in self._prim_paths],
3,
type_name.type,
False,
metadata,
)
if len(self._prim_paths) == 1:
setattr(vec_model,'transform_widget', self)
label = None
with ui.HStack():
with ui.HStack(width=LABEL_PADDING):
if len(self._prim_paths) == 1:
with ui.ZStack():
label_tooltip = label_tooltip + "\nRight click it to disable or delete it."
# This rectangle is act as a hover hint helper
ui.Rectangle(
style={":hovered": {"background_color": 0xFF444444}, "background_color": 0xFF333333},
mouse_pressed_fn=(lambda x, y, b, m: self._show_right_click_menu(b)),
)
label = HighlightLabel(label_name, name="title", tooltip=label_tooltip, **self._label_kwargs)
else:
label = HighlightLabel(label_name, name="title", tooltip=label_tooltip, **self._label_kwargs)
ui.Spacer(width=2)
self._create_inverse_widgets()
with ui.HStack():
range_min, range_max = UsdPropertiesWidgetBuilder._get_attr_value_range(metadata)
kwargs = {"min": range_min, "max": range_max, "step": 1.0}
UsdPropertiesWidgetBuilder._create_float_drag_per_channel_with_labels_and_control(
models = self._model,
metadata = metadata,
labels = [("X", 0xFF5555AA), ("Y", 0xFF76A371), ("Z", 0xFFA07D4F)],
kwargs = kwargs
)
#The vec_model is useful when we set the key for all three components together
self._model.append(vec_model)
UsdPropertiesWidgetBuilder._create_attribute_context_menu(label, vec_model)
wgs_coord = get_wgs84_coords("", self._prim_paths[0].pathString)
if len(wgs_coord) > 0: #pragma no cover OM-112507
with ui.HStack():
with ui.HStack(width=LABEL_PADDING):
label = ui.Label("WGS84", name="title", tooltip=label_tooltip)
ui.Spacer(width=2)
with ui.HStack():
with ui.VStack():
all_axis = ["Lat", "Lon", "Alt"]
colors = {"Lat": 0xFF5555AA, "Lon": 0xFF76A371, "Alt": 0xFFA07D4F}
component_index = 0
for axis in all_axis:
with ui.HStack():
with ui.HStack(width=LABEL_PADDING):
label = ui.Label("", name="title", tooltip=label_tooltip)
with ui.ZStack(width=20):
ui.Rectangle(
width=20,
height=20,
style={
"background_color": colors[axis],
"border_radius": 3,
"corner_flag": ui.CornerFlag.LEFT,
},
)
ui.Label(axis, name="wgs84_label", alignment=ui.Alignment.CENTER)
# NOTE: Updating the WGS84 values does not update the transform translation,
# so make the input fields read-only for now.
# See https://nvidia-omniverse.atlassian.net/browse/OM-64348
ui.FloatDrag(TransformWatchModel(component_index, self._stage), enabled=False)
component_index = component_index + 1
super().rebuild()
class USDXformOpRotateWidget(USDXformOpWidget):
ROTATE_AXIS_ORDER_MAP = {
"xformOp:rotateXYZ": ["X", "Y", "Z"],
"xformOp:rotateXZY": ["X", "Z", "Y"],
"xformOp:rotateYXZ": ["Y", "X", "Z"],
"xformOp:rotateYZX": ["Y", "Z", "X"],
"xformOp:rotateZXY": ["Z", "X", "Y"],
"xformOp:rotateZYX": ["Z", "Y", "X"],
}
ROTATE_ORDERS = ["XYZ", "XZY", "YXZ", "YZX", "ZXY", "ZYX"]
@classmethod
def display_name(cls, attr_name: str) -> str:
suffix = xform_op_utils.get_op_name_suffix(attr_name)
label_name = "Rotate"
if suffix:
label_name = label_name + ":" + suffix
return label_name
def __init__(self, prim_paths, collapsable_frame, stage, attr_path, op_name, is_valid_op, op_order_attr_path, op_order_index, label_kwargs=None):
self._rotate_order_drop_down_menu = None
super().__init__(prim_paths, collapsable_frame, stage, attr_path, op_name, is_valid_op, op_order_attr_path, op_order_index, label_kwargs)
def __del__(self):
super().__del__()
self._rotate_order_drop_down_menu = None
def get_rotation_order_index(order):
return USDXformOpRotateWidget.ROTATE_ORDERS.index(order)
def _change_rotation_order(self, desired_order_index):
attr = self._stage.GetObjectAtPath(self._attr_path)
attr_name = attr.GetName()
if not attr_name.startswith("xformOp:rotate"):
carb.log_warn(f"Object {self._path} is not an xformOp:rotate attribute ")
return
is_inverse_op = False if self._op_name is None else xform_op_utils.is_inverse_op(self._op_name)
suffix = xform_op_utils.get_op_name_suffix(attr_name)
current_order_index = 5
rotate_names = attr.SplitName()
if len(rotate_names) > 1:
rotate_order = rotate_names[1].split("rotate", 1)[1]
current_order_index = USDXformOpRotateWidget.get_rotation_order_index(rotate_order)
if current_order_index == desired_order_index:
return
# desired_order = "XYZ"
desired_order = USDXformOpRotateWidget.ROTATE_ORDERS[desired_order_index]
desired_attr_name = "xformOp:rotate" + desired_order
if suffix is not None:
desired_attr_name += ":" + suffix
desired_op_name = desired_attr_name if not is_inverse_op else "!invert!" + desired_attr_name
omni.kit.commands.execute(
"ChangeRotationOp",
src_op_attr_path=self._attr_path,
op_name=self._op_name,
dst_op_attr_name=desired_attr_name,
is_inverse_op=is_inverse_op,
auto_target_layer = True
)
# after we finish the rotation change "close" the rotation drop-down menu
if self._rotate_order_drop_down_menu:
self._rotate_order_drop_down_menu.visible = False
# A callback to generate a drop-down-menu-like popup window i.e. self._rotate_order_drop_down_menu
# it is used to select & update the rotation order, e.g. XYZ, XZY, ZYX etc.
def _on_mouse_click(self,button,parent, order):
#only suitable for mouse left click
if button != 0:
return
#Use a popup window to act as a drop-down menu
self._rotate_order_drop_down_menu = ui.Window("RotationOrder", width=60, height=130, position_x=parent.screen_position_x, position_y=parent.screen_position_y+parent.computed_height,flags = ui.WINDOW_FLAGS_POPUP | ui.WINDOW_FLAGS_NO_TITLE_BAR | ui.WINDOW_FLAGS_NO_RESIZE | ui.WINDOW_FLAGS_NO_SCROLLBAR)
rotate_check_box_style = {
"": {"background_color": 0x0, "image_url": f"{ICON_PATH}/radio_off.svg", "image_width":32, "image_height":32},
":checked": {"image_url": f"{ICON_PATH}/radio_on.svg"}
}
with self._rotate_order_drop_down_menu.frame:
collection = ui.RadioCollection()
with ui.VStack():
for index in range(len(USDXformOpRotateWidget.ROTATE_ORDERS)):
rotate_order = USDXformOpRotateWidget.ROTATE_ORDERS[index]
#OM-94393 let the radio button decide the height and style
with ui.HStack(mouse_pressed_fn=(lambda x, y, b, m, index=index: self._change_rotation_order(index)), height=0):
ui.RadioButton(style=rotate_check_box_style, radio_collection=collection, aligment=ui.Alignment.LEFT, height=20)
ui.Label(rotate_order)
if rotate_order == order:
collection.model.set_value(index)
def rebuild(self):
attr = self._stage.GetObjectAtPath(self._attr_path)
# if attr.GetResolveInfo().ValueIsBlocked():
# return
attr_name = attr.GetName()
if not attr_name.startswith("xformOp:rotate"):
carb.log_warn(f"Object {self._path} is not an xformOp:rotate attribute ")
return
# is_inverse_op = False if self._op_name is None else xform_op_utils.is_inverse_op(self._op_name)
label_name = self.display_name(attr_name)
rotate_names = attr.SplitName()
rotate_order = "ZYX"
if len(rotate_names) > 1:
rotate_order = rotate_names[1].split("rotate", 1)[1]
# label_tooltip = get_attribute_type_tooltip(attr) + " " + attr.GetName()
metadata = attr.GetAllMetadata()
type_name = Sdf.ValueTypeNames.Find(metadata.get(Sdf.PrimSpec.TypeNameKey))
self._model = []
for i in range(3):
self._model.append(
GfVecAttributeSingleChannelModel(
self._stage,
[path.AppendProperty(attr_name) for path in self._prim_paths],
i,
False,
metadata,
False,
)
)
vec_model = GfVecAttributeModel(
self._stage,
[path.AppendProperty(attr_name) for path in self._prim_paths],
3,
type_name.type,
False,
metadata,
)
if len(self._prim_paths) == 1:
setattr(vec_model,'transform_widget', self)
label_tooltip = UsdPropertiesWidgetBuilder._generate_tooltip_string(attr.GetName(), metadata)
label = None
with ui.HStack():
if len(self._prim_paths) == 1:
with ui.ZStack(width=LABEL_PADDING):
label_tooltip = label_tooltip + "\nRight click it to disable or delete it. \nLeft click it to change the rotate order, default is XYZ."
# This rectangle is act as a hover hint helper
ui.Rectangle(
style={":hovered": {"background_color": 0xFF444444}, "background_color": 0xFF333333},
mouse_pressed_fn=(lambda x, y, b, m: self._show_right_click_menu(b)),
)
# We use a label + a triangle to hack a combo box that are closer to the design
label_h_stack = ui.HStack(width=LABEL_PADDING)
label_h_stack.set_mouse_pressed_fn(lambda x, y, b, m, order=rotate_order, parent_widget=label_h_stack: self._on_mouse_click(b,parent_widget,order))
with label_h_stack:
label = HighlightLabel(
label_name,
name="title",
tooltip=label_tooltip,
width = 35,
**self._label_kwargs,
)
self._create_inverse_widgets()
ui.Spacer(width=5)
# use this triangle to simulate a combo box
with ui.VStack():
ui.Spacer(height=10)
ui.Triangle(name="default",width=8,height=6,style={"background_color":0xFF9E9E9E},alignment=ui.Alignment.CENTER_BOTTOM)
else:
with ui.HStack(width=LABEL_PADDING):
label = HighlightLabel(label_name, name="title", tooltip=label_tooltip, **self._label_kwargs)
ui.Spacer()
self._create_inverse_widgets()
with ui.HStack():
range_min, range_max = UsdPropertiesWidgetBuilder._get_attr_value_range(metadata)
kwargs = {"min": range_min, "max": range_max, "step": 1.0}
UsdPropertiesWidgetBuilder._create_float_drag_per_channel_with_labels_and_control(
models = self._model,
metadata = metadata,
labels = [("X", 0xFF5555AA), ("Y", 0xFF76A371), ("Z", 0xFFA07D4F)],
kwargs = kwargs
)
#The vec_model is useful when we set the key for all three components together
self._model.append(vec_model)
UsdPropertiesWidgetBuilder._create_attribute_context_menu(label, vec_model)
#this class is used for rotateX, rotateY, rotateZ, but it's not working properly, and produce error when displayed.
# https://omniverse-jirasw.nvidia.com/browse/OMFP-2491
#disabling coverage for this code
class USDXformOpRotateScalarWidget(USDXformOpWidget): # pragma: no cover
@classmethod
def display_name(cls, attr_name: str) -> str:
suffix = xform_op_utils.get_op_name_suffix(attr_name)
label_name = "Rotate"
if suffix:
label_name = label_name + ":" + suffix
return label_name
def rebuild(self):
attr = self._stage.GetObjectAtPath(self._attr_path)
# if attr.GetResolveInfo().ValueIsBlocked():
# return
attr_name = attr.GetName()
if not attr_name.startswith("xformOp:rotate"):
carb.log_warn(f"Object {self._path} is not an xformOp:rotate attribute ")
return
# is_inverse_op = False if self._op_name is None else xform_op_utils.is_inverse_op(self._op_name)
label_name = self.display_name(attr_name)
rotate_names = attr.SplitName()
rotate_order = "X"
if len(rotate_names) > 1:
rotate_order = rotate_names[1].split("rotate", 1)[1]
# label_tooltip = get_attribute_type_tooltip(attr) + " " + attr.GetName()
metadata = attr.GetAllMetadata()
type_name = Sdf.ValueTypeNames.Find(metadata.get(Sdf.PrimSpec.TypeNameKey))
self._model = UsdAttributeModel(
self._stage, [path.AppendProperty(attr_name) for path in self._prim_paths], False, metadata
)
label_tooltip = UsdPropertiesWidgetBuilder._generate_tooltip_string(attr.GetName(), metadata)
with ui.HStack():
with ui.HStack(width=LABEL_PADDING):
if len(self._prim_paths) == 1:
with ui.ZStack():
label_tooltip = label_tooltip + "\nRight click it to disable or delete it. "
# This rectangle is act as a hover hint helper
ui.Rectangle(
style={":hovered": {"background_color": 0xFF444444}, "background_color": 0xFF333333},
mouse_pressed_fn=(lambda x, y, b, m: self._show_right_click_menu(b)),
)
HighlightLabel(label_name, name="title", tooltip=label_tooltip, **self._label_kwargs)
else:
HighlightLabel(label_name, name="title", tooltip=label_tooltip, **self._label_kwargs)
self._create_inverse_widgets()
ui.Spacer(width=2)
stack_names = {"X":"rotate_scalar_stack_x", "Y":"rotate_scalar_stack_y", "Z":"rotate_scalar_stack_z"}
rotate_scalar_stack = ui.HStack(identifier = stack_names[rotate_order])
with rotate_scalar_stack:
colors = {"X": 0xFF5555AA, "Y": 0xFF76A371, "Z": 0xFFA07D4F}
with ui.ZStack():
with ui.HStack():
range_min, range_max = UsdPropertiesWidgetBuilder._get_attr_value_range(metadata)
widget_kwargs = {"model": self._model, "step": 1}
if range_min < range_max:
widget_kwargs["min"] = range_min
widget_kwargs["max"] = range_max
UsdPropertiesWidgetBuilder._create_drag_or_slider(ui.FloatDrag, ui.FloatSlider, **widget_kwargs)
UsdPropertiesWidgetBuilder._create_control_state(self._model)
with ui.HStack():
with ui.ZStack(width=14):
ui.Rectangle(
name="vector_label",
style={
"background_color": colors[rotate_order],
"border_radius": 3,
"corner_flag": ui.CornerFlag.LEFT,
},
)
ui.Label(rotate_order, name="vector_label", alignment=ui.Alignment.CENTER)
class USDXformOpScaleWidget(USDXformOpWidget):
@classmethod
def display_name(cls, attr_name: str) -> str:
suffix = xform_op_utils.get_op_name_suffix(attr_name)
label_name = "Scale"
if suffix:
label_name = label_name + ":" + suffix
return label_name
def __init__(
self, prim_paths, collapsable_frame, stage, attr_path, op_name, is_valid_op, op_order_attr_path, op_order_index,
parent_widget, label_kwargs=None
):
self._parent_widget = parent_widget
super().__init__(
prim_paths, collapsable_frame, stage, attr_path, op_name, is_valid_op, op_order_attr_path, op_order_index,
label_kwargs
)
def rebuild(self):
# The scale widget uses a modified version of the single channel model that supports
# scaling each component of the vector uniformly.
# If link_channels is False, the single channel model behaves as usual.
class GfVecLinkableModel(GfVecAttributeSingleChannelModel):
def __init__(
self,
stage: Usd.Stage,
attribute_paths: List[Sdf.Path],
channel_index: int,
self_refresh: bool,
metadata: dict,
change_on_edit_end=False,
link_channels=False,
**kwargs
):
self._link_channels = link_channels
super().__init__(stage, attribute_paths, channel_index, self_refresh, metadata, change_on_edit_end, **kwargs)
def set_value(self, value):
if self._link_channels:
vec_value = copy.copy(self._value)
for i in range(3):
vec_value[i] = value
if UsdBase.set_value(self, vec_value, -1):
self._value_changed()
else:
super().set_value(value)
def set_default(self, comp=-1):
if self._link_channels:
value = self._default_value[self._channel_index]
vec_value = copy.copy(self._value)
for i in range(3):
vec_value[i] = value
if UsdBase.set_value(self, vec_value, -1):
self._value_changed()
else:
super().set_default(comp)
attr = self._stage.GetObjectAtPath(self._attr_path)
attr_name = attr.GetName()
if not attr_name.startswith("xformOp:scale"):
carb.log_warn(f"Object {self._path} is not an xformOp:scale attribute ")
return
# is_inverse_op = False if self._op_name is None else xform_op_utils.is_inverse_op(self._op_name)
label_name = self.display_name(attr_name)
# label_tooltip = get_attribute_type_tooltip(attr) + " " + attr.GetName()
metadata = attr.GetAllMetadata()
type_name = Sdf.ValueTypeNames.Find(metadata.get(Sdf.PrimSpec.TypeNameKey))
self._model = []
for i in range(3):
self._model.append(
GfVecLinkableModel(
self._stage,
[path.AppendProperty(attr_name) for path in self._prim_paths],
i,
False,
metadata,
False,
self._parent_widget._link_scale
)
)
vec_model = GfVecAttributeModel(
self._stage,
[path.AppendProperty(attr_name) for path in self._prim_paths],
3,
type_name.type,
False,
metadata,
)
if len(self._prim_paths) == 1:
setattr(vec_model,'transform_widget', self)
label_tooltip = UsdPropertiesWidgetBuilder._generate_tooltip_string(attr.GetName(), metadata)
label = None
with ui.HStack():
with ui.HStack(width=LABEL_PADDING):
if len(self._prim_paths) == 1:
with ui.ZStack():
label_tooltip = label_tooltip + "\nRight click it for more options."
# This rectangle is act as a hover hint helper
ui.Rectangle(
style={":hovered": {"background_color": 0xFF444444}, "background_color": 0xFF333333},
mouse_pressed_fn=(lambda x, y, b, m: self._show_right_click_menu(b)),
)
label = HighlightLabel(label_name, name="title", tooltip=label_tooltip, **self._label_kwargs)
else:
label = HighlightLabel(label_name, name="title", tooltip=label_tooltip, **self._label_kwargs)
self._create_inverse_widgets()
if self._parent_widget._link_scale:
button_style = {
"color": 0xFF34B5FF,
"background_color": 0x0,
"Button.Image": {"image_url": f"{ICON_PATH}/link_on.svg"},
":hovered": {"color": 0xFFACDCF9}
}
else:
button_style = {
"color": 0x66FFFFFF,
"background_color": 0x0,
"Button.Image": {"image_url": f"{ICON_PATH}/link_off.svg"},
":hovered": {"color": 0xFFFFFFFF}
}
with ui.ZStack(content_clipping = True, width=25, height=25):
ui.Button("",
style = button_style,
clicked_fn = self._parent_widget._toggle_link_scale,
identifier = "toggle_link_scale",
tooltip = "Toggle link scale")
ui.Spacer(width=70)
scale_stack = ui.HStack(identifier = "scale_t_stack")
with scale_stack:
range_min, range_max = UsdPropertiesWidgetBuilder._get_attr_value_range(metadata)
kwargs = {"min": range_min, "max": range_max, "step": 1.0}
UsdPropertiesWidgetBuilder._create_float_drag_per_channel_with_labels_and_control(
models = self._model,
metadata = metadata,
labels = [("X", 0xFF5555AA), ("Y", 0xFF76A371), ("Z", 0xFFA07D4F)],
kwargs = kwargs
)
#The vec_model is useful when we set the key for all three components together
self._model.append(vec_model)
UsdPropertiesWidgetBuilder._create_attribute_context_menu(label, vec_model)
class USDXformOpOrientWidget(USDXformOpWidget):
@classmethod
def display_name(cls, attr_name: str) -> str:
suffix = xform_op_utils.get_op_name_suffix(attr_name)
label_name = "Orient"
if suffix:
label_name = label_name + ":" + suffix
return label_name
def __init__(
self, prim_paths, collapsable_frame, stage, attr_path, op_name, is_valid_op, op_order_attr_path, op_order_index,
label_kwargs=None,
):
self._settings = carb.settings.get_settings()
if self._settings:
if self._settings.get("/persistent/app/uiSettings/DisplayOrientAsRotate") is None:
self._settings.set_default_bool("/persistent/app/uiSettings/DisplayOrientAsRotate", True)
self._display_orient_as_rotate = self._settings.get_as_bool(
"/persistent/app/uiSettings/DisplayOrientAsRotate"
)
super().__init__(
prim_paths, collapsable_frame, stage, attr_path, op_name, is_valid_op, op_order_attr_path, op_order_index,
label_kwargs,
)
def _build_orient_widgets(self, attr, attr_name, type_name, label_name, label_tooltip, metadata):
self._model = GfQuatAttributeModel(
self._stage, [path.AppendProperty(attr_name) for path in self._prim_paths], type_name.type, False, metadata
)
with ui.HStack():
kwargs = {"min": -1, "max": 1, "step": 0.01}
value_widget, mixed_overlay = UsdPropertiesWidgetBuilder._create_multi_float_drag_with_labels(
self._model,
comp_count=4,
labels=[("W", 0xFFAA5555), ("X", 0xFF5555AA), ("Y", 0xFF76A371), ("Z", 0xFFA07D4F)],
**kwargs,
)
value_widget.identifier = f"orient_{attr_name}"
UsdPropertiesWidgetBuilder._create_control_state(self._model, value_widget, mixed_overlay)
def _build_euler_widgets(self, attr, attr_name, type_name, label_name, label_tooltip, metadata):
self._euler_model = GfQuatEulerAttributeModel(
self._stage, [path.AppendProperty(attr_name) for path in self._prim_paths], type_name.type, False, metadata
)
with ui.HStack():
kwargs = {"min": -360, "max": 360, "step": 1}
value_widget, mixed_overlay = UsdPropertiesWidgetBuilder._create_multi_float_drag_with_labels(
self._euler_model,
comp_count=3,
labels=[("X", 0xFF5555AA), ("Y", 0xFF76A371), ("Z", 0xFFA07D4F)],
**kwargs,
)
value_widget.identifier = f"euler_{attr_name}"
UsdPropertiesWidgetBuilder._create_control_state(self._euler_model, value_widget, mixed_overlay)
def _build_header(self, attr, attr_name, type_name, label_name, label_tooltip, metadata):
with ui.ZStack(width=LABEL_PADDING):
if len(self._prim_paths) == 1:
label_tooltip = label_tooltip + "\nDisplay Orient As Euler Angles. \nRight click to disable or delete it. \nLeft click to switch between Orient & Euler Angles."
# A black rect background indicates the Orient is not original data format
_rect = ui.Rectangle(
style={
"Rectangle:hovered": {"background_color": 0xFF444444},
"Rectangle": {"background_color": 0xFF333333},
},
tooltip=label_tooltip,
)
# _rect = ui.Rectangle(tooltip=label_tooltip)
_rect.set_mouse_pressed_fn(lambda x, y, b, m: self._show_right_click_menu(b))
# TODO: Replace this hack when OM-24290 is fixed
with ui.ZStack():
_button = ui.Button(
label_name,
name="title",
width=50,
tooltip=label_tooltip if len(self._prim_paths) > 1 else "",
style=euler_view_button_style if self._display_orient_as_rotate else quat_view_button_style,
)
_button.set_mouse_pressed_fn(
lambda x, y, b, m, widget=_button: self._on_orient_button_clicked(b, widget)
)
self._create_inverse_widgets()
with ui.HStack():
ui.Spacer(width=35)
ui.Image(f"{ICON_PATH}/orient_button.svg", width=10, alignment=ui.Alignment.CENTER)
def rebuild(self):
# attr & attr_name
attr = self._stage.GetObjectAtPath(self._attr_path)
attr_name = attr.GetName()
if not attr_name.startswith("xformOp:orient"):
carb.log_warn(f"Object {self._path} is not an xformOp:orient attribute ")
return
# metadata
metadata = attr.GetAllMetadata()
# type_name
type_name = Sdf.ValueTypeNames.Find(metadata.get(Sdf.PrimSpec.TypeNameKey))
# label_name
label_name = self.display_name(attr_name)
# label_tooltip
label_tooltip = UsdPropertiesWidgetBuilder._generate_tooltip_string(attr.GetName(), metadata)
with ui.HStack():
self._build_header(attr, attr_name, type_name, label_name, label_tooltip, metadata)
# Create two views, Quaternion view & Euler Angle view
# self._display_orient_as_rotate True: Euler Angle view, False: Quaternion view
with ui.ZStack():
# Quaternion view is default on
self._quat_view = ui.Frame(visible=False if self._display_orient_as_rotate else True)
with self._quat_view:
self._build_orient_widgets(attr, attr_name, type_name, label_name, label_tooltip, metadata)
# Euler view is default off
self._euler_view = ui.Frame(visible=True if self._display_orient_as_rotate else False)
with self._euler_view:
self._build_euler_widgets(attr, attr_name, type_name, label_name, label_tooltip, metadata)
class USDXformOpTransformWidget(USDXformOpWidget):
@classmethod
def display_name(cls, attr_name: str) -> str:
suffix = xform_op_utils.get_op_name_suffix(attr_name)
label_name = "Transform"
if suffix:
label_name = label_name + ":" + suffix
return label_name
def rebuild(self):
attr = self._stage.GetObjectAtPath(self._attr_path)
attr_name = attr.GetName()
if not attr_name.startswith("xformOp:transform"):
carb.log_warn(f"Object {self._path} is not an xformOp:transform attribute ")
return
# is_inverse_op = False if self._op_name is None else xform_op_utils.is_inverse_op(self._op_name)
label_name = self.display_name(attr_name)
# label_tooltip = get_attribute_type_tooltip(attr) + " " + attr.GetName()
metadata = attr.GetAllMetadata()
type_name = Sdf.ValueTypeNames.Find(metadata.get(Sdf.PrimSpec.TypeNameKey))
self._model = GfMatrixAttributeModel(
self._stage,
[path.AppendProperty(attr_name) for path in self._prim_paths],
4,
type_name.type,
False,
metadata,
)
label_tooltip = UsdPropertiesWidgetBuilder._generate_tooltip_string(attr.GetName(), metadata)
with ui.HStack():
with ui.HStack(width=LABEL_PADDING):
if len(self._prim_paths) == 1:
with ui.ZStack():
label_tooltip = label_tooltip + "\nRight click it to disable or delete it."
# This rectangle is act as a hover hint helper
ui.Rectangle(
style={":hovered": {"background_color": 0xFF444444}, "background_color": 0xFF333333},
mouse_pressed_fn=(lambda x, y, b, m: self._show_right_click_menu(b)),
)
HighlightLabel(label_name, name="title", tooltip=label_tooltip, **self._label_kwargs)
else:
HighlightLabel(label_name, name="title", tooltip=label_tooltip, **self._label_kwargs)
self._create_inverse_widgets()
ui.Spacer(width=2)
with ui.HStack():
range_min, range_max = UsdPropertiesWidgetBuilder._get_attr_value_range(metadata)
# TODO: make step default to 1.0 before the adaptive stepping solution is available
step = 1.0
self._create_multi_float_drag_matrix_with_labels(
self._model,
4,
range_min,
range_max,
step,
[("X", 0xFF5555AA), ("Y", 0xFF76A371), ("Z", 0xFFA07D4F), ("W", 0xFFAA5555)],
)
wgs_coord = get_wgs84_coords("", self._prim_paths[0].pathString)
if len(wgs_coord) > 0: #pragma no cover OM-112507
with ui.HStack():
with ui.HStack(width=LABEL_PADDING):
label = ui.Label("WGS84", name="title", tooltip=label_tooltip)
ui.Spacer(width=2)
with ui.HStack():
with ui.VStack():
all_axis = ["Lat", "Lon", "Alt"]
colors = {"Lat": 0xFF5555AA, "Lon": 0xFF76A371, "Alt": 0xFFA07D4F}
component_index = 0
for axis in all_axis:
with ui.HStack():
with ui.HStack(width=LABEL_PADDING):
label = ui.Label("", name="title", tooltip=label_tooltip)
with ui.ZStack(width=20):
ui.Rectangle(
width=20,
height=20,
style={
"background_color": colors[axis],
"border_radius": 3,
"corner_flag": ui.CornerFlag.LEFT,
},
)
ui.Label(axis, name="wgs84_label", alignment=ui.Alignment.CENTER)
# NOTE: Updating the WGS84 values does not update the transform translation,
# so make the input fields read-only for now.
# See https://nvidia-omniverse.atlassian.net/browse/OM-64348
ui.FloatDrag(TransformWatchModel(component_index, self._stage), enabled=False)
component_index = component_index + 1
class USDResetXformStackWidget(USDXformOpWidget):
def rebuild(self):
is_reset_xform_stack_op = xform_op_utils.is_reset_xform_stack_op(self._op_name)
if not is_reset_xform_stack_op:
return
label_name = "ResetXformStack"
label_tooltip = "Invalid all above xformOp and parent transform. Calulate world transform from the op below."
self._model = None
with ui.HStack():
with ui.HStack(width=LABEL_PADDING):
ui.Label(
label_name,
name="title",
tooltip=label_tooltip,
mouse_pressed_fn=(lambda x, y, b, m: self._show_right_click_menu(b)),
)
ui.Spacer(width=5)
with ui.HStack():
with ui.VStack():
ui.Spacer()
color = 0xFF888888 if self._is_valid_op else 0xFF444444
ui.Line(
name="ResetXformStack",
height=2,
style={"color": color, "border_width": 0.5, "alignment": ui.Alignment.BOTTOM},
alignment=ui.Alignment.BOTTOM,
)
ui.Spacer()
class USDNoAttributeOpWidget(USDXformOpWidget):
def rebuild(self):
if self._op_name is None:
return
label_name = self._op_name
self._model = None
is_valid_op_name = xform_op_utils.is_valid_op_name(self._op_name)
op_attr_name = xform_op_utils.get_op_attr_name(self._op_name)
label_error = (
f"Could not find attribute {op_attr_name} for this xformOp."
if is_valid_op_name
else "Invalid xformOp name!"
)
with ui.HStack():
with ui.HStack(width=LABEL_PADDING):
ui.Label(label_name, name="title", mouse_pressed_fn=(lambda x, y, b, m: self._show_right_click_menu(b)))
ui.Spacer(width=5)
with ui.HStack():
ui.Label(label_error, name="title")
class OperationTypes(Enum):
ADD = 0
MULTIPLY = 1
INVALID = 2
class TransformWidgets:
def __init__(self, parent_widget):
self._settings = carb.settings.get_settings()
self._clear_widgets()
self._parent_widget = parent_widget
self._offset_index = -1
self._old_transform = ""
self._active_fields = 0
self._dragging = False
self._tab_swap = 0
def __del__(self):
self._clear_widgets()
def _clear_widgets(self):
self._stage = None
self._widgets = []
self._models = defaultdict(list)
def _create_xform_op_widget(
self,
prim_paths,
collapsable_frame,
stage,
attr,
op_name=None,
is_valid_op=False,
op_order_attr=None,
op_order_index=-1,
):
op_order_path = op_order_attr.GetPath() if op_order_attr is not None and op_order_attr else None
if xform_op_utils.is_reset_xform_stack_op(op_name):
return USDResetXformStackWidget(
prim_paths, collapsable_frame, stage, None, op_name, is_valid_op, op_order_path, op_order_index
)
if not attr:
return USDNoAttributeOpWidget(
prim_paths, collapsable_frame, stage, None, op_name, is_valid_op, op_order_path, op_order_index
)
attr_name = attr.GetName()
def match(label):
return self._parent_widget._filter.matches(label)
highlight = self._parent_widget._filter.name
label_kwargs = {"highlight": highlight}
if attr_name.startswith("xformOp:translate") and match(USDXformOpTranslateWidget.display_name(attr_name)):
return USDXformOpTranslateWidget(
prim_paths,
collapsable_frame,
stage,
attr.GetPath(),
op_name,
is_valid_op,
op_order_path,
op_order_index,
label_kwargs,
)
elif attr_name.startswith("xformOp:rotate") and match(USDXformOpRotateWidget.display_name(attr_name)):
op_type_name = xform_op_utils.get_op_type_name(attr_name)
if len(op_type_name.split("rotate", 1)[1]) == 3:
return USDXformOpRotateWidget(
prim_paths,
collapsable_frame,
stage,
attr.GetPath(),
op_name,
is_valid_op,
op_order_path,
op_order_index,
label_kwargs,
)
elif len(op_type_name.split("rotate", 1)[1]) == 1:
return USDXformOpRotateScalarWidget(
prim_paths,
collapsable_frame,
stage,
attr.GetPath(),
op_name,
is_valid_op,
op_order_path,
op_order_index,
label_kwargs,
)
elif attr_name.startswith("xformOp:orient") and match(USDXformOpOrientWidget.display_name(attr_name)):
return USDXformOpOrientWidget(
prim_paths,
collapsable_frame,
stage,
attr.GetPath(),
op_name,
is_valid_op,
op_order_path,
op_order_index,
label_kwargs,
)
elif attr_name.startswith("xformOp:scale") and match(USDXformOpScaleWidget.display_name(attr_name)):
return USDXformOpScaleWidget(
prim_paths,
collapsable_frame,
stage,
attr.GetPath(),
op_name,
is_valid_op,
op_order_path,
op_order_index,
self._parent_widget,
label_kwargs,
)
elif attr_name.startswith("xformOp:transform") and match(USDXformOpTransformWidget.display_name(attr_name)):
return USDXformOpTransformWidget(
prim_paths,
collapsable_frame,
stage,
attr.GetPath(),
op_name,
is_valid_op,
op_order_path,
op_order_index,
label_kwargs,
)
return None
def _get_common_xformop(self, prim_paths):
def _get_xformop_order(stage, prim_path):
prim = stage.GetPrimAtPath(prim_path)
if not prim:
return []
order_attr = prim.GetAttribute("xformOpOrder")
if not order_attr:
return []
xform_op_order = order_attr.Get()
if not xform_op_order:
return []
return xform_op_order
common_xformOp_order = [ \
"xformOp:translate","xformOp:scale","xformOp:rotateX", \
"xformOp:rotateY","xformOp:rotateZ","xformOp:rotateXYZ", \
"xformOp:rotateXZY","xformOp:rotateYXZ","xformOp:rotateYZX", \
"xformOp:rotateZXY","xformOp:rotateZYX","xformOp:orient","xformOp:transform"
]
all_empty_xformOp = True
for prim_path in prim_paths:
xformOp_order = _get_xformop_order(self._stage, prim_path)
common_xformOp_order = list(set(common_xformOp_order) & set(xformOp_order))
all_empty_xformOp &= (len(xformOp_order) == 0)
return common_xformOp_order, all_empty_xformOp
def _create_multi_string_with_labels(self, ui_widget, model, labels, comp_count):
# This is similar to the multi_float_drag function above, but without USD backing and using a given single
# field (draggable float and string, for offset mode we need to do some string parsing to look for math operations)
RECT_WIDTH = 13
SPACING = 4
value_widget = []
with ui.ZStack():
with ui.HStack():
ui.Spacer(width=RECT_WIDTH)
items = model.get_item_children(self)
for i in range(comp_count):
if i !=0:
ui.Spacer(width=RECT_WIDTH)
field = model.get_item_value_model(items[i], i)
value_widget.append(ui_widget(field))
with ui.HStack():
for i in range(comp_count):
if i != 0:
ui.Spacer(width=SPACING)
label = labels[i]
with ui.ZStack(width=RECT_WIDTH + 1):
ui.Rectangle(name="vector_label", style={"background_color": label[1]})
ui.Label(label[0], name="vector_label", alignment=ui.Alignment.CENTER)
ui.Spacer()
return value_widget
# Two sets of fields are generated, FloatDrags are visible dragging and StringFields are visible during keyboard input
# These functions ensure the correct fields are visible and active when single clicking, double clicking, and tab selecting
def _on_double_click(self, transform):
self._dragging = False
float_widget = self._get_widget(transform)[0]
string_widget = self._get_widget(transform)[1]
for widget in float_widget:
widget.visible = False
for widget in string_widget:
widget.visible = True
async def focus(field):
await omni.kit.app.get_app().next_update_async()
field.focus_keyboard()
string_widget[self._offset_index].focus_keyboard()
asyncio.ensure_future(focus(string_widget[self._offset_index]))
if self._tab_swap == 1:
self._active_fields -= 1
def _on_press(self):
self._dragging = True
self._tab_swap = 0
if self._active_fields < 0:
self._active_fields = 0
def _start_field_edit(self, index, transform):
self._offset_index = index
self._active_fields += 1
self._old_transform = transform
self._settings.set(TRANSFORM_OP_SETTING, transform)
float_widget = self._get_widget(transform)[0]
if float_widget[index].visible == True and self._dragging == False:
self._tab_swap += 1
self._on_double_click(transform)
def _swapping(self, transform):
if transform == self._old_transform:
return False
else:
return True
async def _end_string_edit(self, transform):
self._active_fields -= 1
if self._swapping(transform):
if self._get_widget(transform)[0][0].visible == False:
for widget in self._get_widget(transform)[1]:
widget.visible = False
for widget in self._get_widget(transform)[0]:
widget.visible = True
# Swap back to FloatDrag fields if the user clicks off
await asyncio.sleep(.3)
if self._active_fields < 1:
if self._get_widget(transform)[0][0].visible == False:
for widget in self._get_widget(transform)[1]:
widget.visible = False
for widget in self._get_widget(transform)[0]:
widget.visible = True
def _get_widget(self, transform):
if transform == TRANSFORM_OP_MOVE:
return self._float_translate_widget, self._string_translate_widget
elif transform == TRANSFORM_OP_ROTATE:
return self._float_rotate_widget, self._string_rotate_widget
else:
return self._float_scale_widget, self._string_scale_widget
def _get_offset_data(self, text: str):
# See if input looks like "[op] [number]", for the four supported operations
try:
text = text.replace(" ", "")
if len(text) > 0:
operator = text[0]
value = float(text[1:])
if operator == '*':
return OperationTypes.MULTIPLY, value
elif operator == '/':
return OperationTypes.MULTIPLY, 1.0 / value
elif operator == '+':
return OperationTypes.ADD, value
elif operator == '-':
return OperationTypes.ADD, -value
except ValueError:
pass
# If we didn't find an operation, see if the input is just a number
try:
value = float(text)
return OperationTypes.ADD, value
except ValueError:
return OperationTypes.INVALID, 0.0
def _on_translate_offset(self, offset_text: str, index: int, stage: Usd.Stage, prim_paths: List[Sdf.Path]):
operation, offset_value = self._get_offset_data(offset_text)
if operation is OperationTypes.INVALID:
carb.log_warn("Unrecognized input provided to offset field. No operation will be applied.")
elif stage:
with omni.kit.undo.group():
for path in prim_paths:
prim = stage.GetPrimAtPath(path)
prim_world_xform = omni.usd.get_world_transform_matrix(prim)
success, scale_orient_mat, scale, rotation_mat, translation, persp_mat = prim_world_xform.Factor()
scale_mat = Gf.Matrix4d().SetScale(scale)
local = self._settings.get(TRANSFORM_MOVE_MODE_SETTING) is None or \
self._settings.get_as_string(TRANSFORM_MOVE_MODE_SETTING) != TRANSFORM_MODE_GLOBAL
if operation is OperationTypes.ADD:
if local:
offset_vec = Gf.Vec3d([offset_value if i == index else 0 for i in range(3)])
offset_mat = Gf.Matrix4d().SetTranslate(offset_vec)
translation_mat = Gf.Matrix4d().SetTranslate(translation)
translation = (offset_mat * rotation_mat * translation_mat).ExtractTranslation()
else:
translation[index] += offset_value
elif operation is OperationTypes.MULTIPLY:
if local:
offset_vec = Gf.Vec3d([offset_value if i == index else 1 for i in range(3)])
offset_mat = Gf.Matrix4d().SetScale(offset_vec)
translation_mat = Gf.Matrix4d().SetTranslate(translation)
# Rotate translation into local frame, apply the scale there, rotate back out
translation = (translation_mat * rotation_mat.GetTranspose() * offset_mat * rotation_mat).ExtractTranslation()
else:
translation[index] *= offset_value
translation_mat = Gf.Matrix4d().SetTranslate(translation)
prim_world_xform = scale_orient_mat * scale_mat * scale_orient_mat.GetTranspose() * rotation_mat * translation_mat
parent_world_xform = omni.usd.get_world_transform_matrix(prim.GetParent())
prim_local_xform = prim_world_xform * parent_world_xform.GetInverse()
omni.kit.commands.execute("TransformPrimCommand", path = path, new_transform_matrix = prim_local_xform)
asyncio.ensure_future(self._end_string_edit(TRANSFORM_OP_MOVE))
def _on_rotate_offset(self, offset_text: str, index: int, stage: Usd.Stage, prim_paths: List[Sdf.Path]):
operation, offset_value = self._get_offset_data(offset_text)
if operation is OperationTypes.INVALID:
carb.log_warn("Unrecognized input provided to offset field. No operation will be applied.")
elif stage:
with omni.kit.undo.group():
for path in prim_paths:
prim = stage.GetPrimAtPath(path)
prim_world_xform = omni.usd.get_world_transform_matrix(prim)
success, scale_orient_mat, scale, rotation_mat, translation, persp_mat = prim_world_xform.Factor()
scale_mat = Gf.Matrix4d().SetScale(scale)
local = self._settings.get(TRANSFORM_ROTATE_MODE_SETTING) is None or \
self._settings.get_as_string(TRANSFORM_ROTATE_MODE_SETTING) != TRANSFORM_MODE_GLOBAL
if operation is OperationTypes.ADD:
axis = Gf.Vec3d([1 if i == index else 0 for i in range(3)])
offset_r = Gf.Rotation(axis, offset_value)
offset_mat = Gf.Matrix4d().SetRotate(offset_r.GetQuat())
if local:
rotation_mat = offset_mat * rotation_mat
else:
rotation_mat = rotation_mat * offset_mat
translation_mat = Gf.Matrix4d().SetTranslate(translation)
prim_world_xform = scale_orient_mat * scale_mat * scale_orient_mat.GetTranspose() * rotation_mat * translation_mat
parent_world_xform = omni.usd.get_world_transform_matrix(prim.GetParent())
prim_local_xform = prim_world_xform * parent_world_xform.GetInverse()
omni.kit.commands.execute("TransformPrimCommand", path = path, new_transform_matrix = prim_local_xform)
elif operation is OperationTypes.MULTIPLY:
# rotation-multiply is unlike the other offsets because it we need to know the component of the
# current rotation about a particular axis in order to scale it, but a rotation's component along
# one axis can be different depending on the representation (e.g. different euler angle orderings).
# Rather than deal with that, we'll just look for the prim's current rotation values
# and scale the specified component.
scale, rotation, order, translation = omni.usd.get_local_transform_SRT(prim)
rotation[index] *= offset_value
omni.kit.commands.execute("TransformPrimSRTCommand", path = path, new_rotation_euler = rotation)
asyncio.ensure_future(self._end_string_edit(TRANSFORM_OP_ROTATE))
def _on_scale_offset(self, offset_text: str, index: int, stage: Usd.Stage, prim_paths: List[Sdf.Path]):
operation, offset_value = self._get_offset_data(offset_text)
if operation is OperationTypes.INVALID:
carb.log_warn("Unrecognized input provided to offset field. No operation will be applied.")
elif stage:
with omni.kit.undo.group():
for path in prim_paths:
prim = stage.GetPrimAtPath(path)
prim_world_xform = omni.usd.get_world_transform_matrix(prim)
success, scale_orient_mat, scale, rotation_mat, translation, persp_mat = prim_world_xform.Factor()
if operation is OperationTypes.ADD:
if self._parent_widget._link_scale:
scale = ((scale[index] + offset_value) / scale[index]) * scale
else:
scale[index] += offset_value
elif operation is OperationTypes.MULTIPLY:
if self._parent_widget._link_scale:
scale = offset_value * scale
else:
scale[index] *= offset_value
scale_mat = Gf.Matrix4d().SetScale(scale)
translation_mat = Gf.Matrix4d().SetTranslate(translation)
prim_world_xform = scale_orient_mat * scale_mat * scale_orient_mat.GetTranspose() * rotation_mat * translation_mat
parent_world_xform = omni.usd.get_world_transform_matrix(prim.GetParent())
prim_local_xform = prim_world_xform * parent_world_xform.GetInverse()
omni.kit.commands.execute("TransformPrimCommand", path = path, new_transform_matrix = prim_local_xform)
asyncio.ensure_future(self._end_string_edit(TRANSFORM_OP_SCALE))
def build_transform_frame(self, prim_paths, collapsable_frame, stage):
self._clear_widgets()
# Transform Frame
if stage is None or len(prim_paths) <= 0 or prim_paths is None:
return None, False
prim_path = prim_paths[0]
prim = stage.GetPrimAtPath(prim_path)
if not prim or not prim.IsA(UsdGeom.Xformable):
return None, False
self._stage = stage
xform = UsdGeom.Xformable(prim)
# if xformOpOrder is absent or an empty array don't return
# we may still have xformOp that are not listed in the xformOpOrder
order_attr = prim.GetAttribute("xformOpOrder")
if not order_attr:
xform_op_order = []
xform_op_order = order_attr.Get()
if xform_op_order is None:
xform_op_order = []
# when select more than two prim, get common xformop to show
if len(prim_paths) > 1:
common_xformop, all_empty_xformop = self._get_common_xformop(prim_paths)
for index, op_name in enumerate(common_xformop):
attr_name = xform_op_utils.get_op_attr_name(op_name)
attr = Usd.Attribute()
if attr_name is not None:
attr = prim.GetAttribute(attr_name)
widget = self._create_xform_op_widget(
prim_paths, collapsable_frame, stage, attr, op_name, True, order_attr, index
)
if widget is not None:
self._widgets.append(widget)
model = widget._model
#if it is a list the last one is the vector model
if isinstance(model, list):
for m in model:
if m is not None:
for sdf_path in m.get_attribute_paths():
self._models[sdf_path].append(m)
elif model is not None:
for sdf_path in model.get_attribute_paths():
self._models[sdf_path].append(model)
if isinstance(widget, USDXformOpOrientWidget):
if widget._euler_model is not None:
for sdf_path in widget._euler_model.get_attribute_paths():
self._models[sdf_path].append(widget._euler_model)
return self._models, all_empty_xformop
attr_xform_op_order = xform.GetXformOpOrderAttr()
xform_ops = xform.GetOrderedXformOps()
has_reset_xform_stack = xform.GetResetXformStack()
reset_index = -1
if has_reset_xform_stack:
for i in range(len(xform_op_order) - 1, -1, -1):
if xform_op_utils.is_reset_xform_stack_op(xform_op_order.__getitem__(i)):
reset_index = i
break
attr_xform_ops = []
for index, op_name in enumerate(xform_op_order):
attr_name = xform_op_utils.get_op_attr_name(op_name)
if attr_name is not None:
attr = prim.GetAttribute(attr_name)
if attr:
attr_xform_ops.append(attr)
attrs_all = [attr for attr in prim.GetAttributes() if not attr.IsHidden()]
attr_not_in_order_xform_ops = list(
attr for attr in attrs_all if (attr.GetName().startswith("xformOp:") and not attr in attr_xform_ops)
)
if len(xform_op_order) + len(attr_not_in_order_xform_ops) > 0:
with ui.VStack(spacing=8, name="frame_v_stack"):
ui.Spacer(height=0)
for index, op_name in enumerate(xform_op_order):
is_valid_op = index >= reset_index and xform_op_utils.is_valid_op_name(op_name)
attr_name = xform_op_utils.get_op_attr_name(op_name)
attr = Usd.Attribute()
if attr_name is not None:
attr = prim.GetAttribute(attr_name)
widget = self._create_xform_op_widget(
prim_paths, collapsable_frame, stage, attr, op_name, is_valid_op, order_attr, index
)
if widget is not None:
self._widgets.append(widget)
# self._models.append(widget._model)
model = widget._model
if isinstance(model, list):
for m in model:
if m is not None:
for sdf_path in m.get_attribute_paths():
self._models[sdf_path].append(m)
elif model is not None:
for sdf_path in model.get_attribute_paths():
self._models[sdf_path].append(model)
if isinstance(widget, USDXformOpOrientWidget):
if widget._euler_model is not None:
for sdf_path in widget._euler_model.get_attribute_paths():
self._models[sdf_path].append(widget._euler_model)
if len(attr_not_in_order_xform_ops) > 0:
ui.Separator()
for attr in attr_not_in_order_xform_ops:
widget = self._create_xform_op_widget(prim_paths, collapsable_frame, stage, attr)
if widget is not None:
self._widgets.append(widget)
ui.Spacer(height=0)
return self._models, False
def build_transform_offset_frame(self, prim_paths, collapsable_frame, stage):
self._clear_widgets()
translate_model = VecAttributeModel(
default_value = "0.0",
begin_edit_callback = functools.partial(self._start_field_edit, transform=TRANSFORM_OP_MOVE),
end_edit_callback = functools.partial(self._on_translate_offset, stage=stage, prim_paths=prim_paths)
)
rotate_model = VecAttributeModel(
default_value = "0.0",
begin_edit_callback = functools.partial(self._start_field_edit, transform=TRANSFORM_OP_ROTATE),
end_edit_callback = functools.partial(self._on_rotate_offset, stage=stage, prim_paths=prim_paths)
)
scale_model = VecAttributeModel(
default_value = "0.0",
begin_edit_callback = functools.partial(self._start_field_edit, transform=TRANSFORM_OP_SCALE),
end_edit_callback = functools.partial(self._on_scale_offset, stage=stage, prim_paths=prim_paths)
)
def match(label):
return self._parent_widget._filter.matches(label)
highlight = self._parent_widget._filter.name
label_kwargs = {"highlight": highlight}
HEIGHT_SPACE = 8
with ui.VStack():
if match("Translate"):
self._parent_widget._any_item_visible = True
ui.Spacer(height = HEIGHT_SPACE)
with ui.HStack():
with ui.HStack(width=LABEL_PADDING):
HighlightLabel("Translate", name="title", **label_kwargs)
ui.Spacer(width=2)
translate_stack = ui.HStack(identifier = "translate_stack")
with translate_stack:
with ui.ZStack():
kwargs = {"step": 1.0}
self._string_translate_widget = self._create_multi_string_with_labels(
ui_widget = ui.StringField,
model = translate_model,
labels = [("X", 0xFF5555AA), ("Y", 0xFF76A371), ("Z", 0xFFA07D4F)],
comp_count = 3
)
for widget in self._string_translate_widget:
widget.visible = False
self._float_translate_widget = self._create_multi_string_with_labels(
ui_widget = ui.FloatDrag,
model = translate_model,
labels = [("X", 0xFF5555AA), ("Y", 0xFF76A371), ("Z", 0xFFA07D4F)],
comp_count = 3
)
translate_stack.set_mouse_double_clicked_fn(lambda x, y, b, m: self._on_double_click(TRANSFORM_OP_MOVE))
translate_stack.set_mouse_pressed_fn(lambda x, y, b, m: self._on_press())
if match("Rotate"):
self._parent_widget._any_item_visible = True
ui.Spacer(height = HEIGHT_SPACE)
with ui.HStack():
with ui.HStack(width=LABEL_PADDING):
HighlightLabel("Rotate", name="title", **label_kwargs)
ui.Spacer(width=2)
rotate_stack = ui.HStack(identifier = "rotate_stack")
with rotate_stack:
with ui.ZStack():
kwargs = {"step": 1.0}
self._string_rotate_widget = self._create_multi_string_with_labels(
ui_widget = ui.StringField,
model = rotate_model,
labels = [("X", 0xFF5555AA), ("Y", 0xFF76A371), ("Z", 0xFFA07D4F)],
comp_count = 3
)
for widget in self._string_rotate_widget:
widget.visible = False
self._float_rotate_widget = self._create_multi_string_with_labels(
ui_widget = ui.FloatDrag,
model = rotate_model,
labels = [("X", 0xFF5555AA), ("Y", 0xFF76A371), ("Z", 0xFFA07D4F)],
comp_count = 3
)
rotate_stack.set_mouse_double_clicked_fn(lambda x, y, b, m: self._on_double_click(TRANSFORM_OP_ROTATE))
rotate_stack.set_mouse_pressed_fn(lambda x, y, b, m: self._on_press())
if match("Scale"):
self._parent_widget._any_item_visible = True
ui.Spacer(height = HEIGHT_SPACE)
with ui.HStack():
with ui.HStack(width=LABEL_PADDING):
HighlightLabel("Scale", name="title", **label_kwargs)
if self._parent_widget._link_scale:
button_style = {
"color": 0xFF34B5FF,
"background_color": 0x0,
"Button.Image": {"image_url": f"{ICON_PATH}/link_on.svg"},
":hovered": {"color": 0xFFACDCF9}
}
else:
button_style = {
"color": 0x66FFFFFF,
"background_color": 0x0,
"Button.Image": {"image_url": f"{ICON_PATH}/link_off.svg"},
":hovered": {"color": 0xFFFFFFFF}
}
with ui.ZStack(content_clipping = True, width=25, height=25):
ui.Button("",
style = button_style,
clicked_fn = self._parent_widget._toggle_link_scale,
identifier = "toggle_link_offset_scale",
tooltip = "Toggle link scale")
ui.Spacer(width=70)
scale_stack = ui.HStack(identifier = "scale_stack")
with scale_stack:
with ui.ZStack():
kwargs = {"step": 1.0}
self._string_scale_widget = self._create_multi_string_with_labels(
ui_widget = ui.StringField,
model = scale_model,
labels = [("X", 0xFF5555AA), ("Y", 0xFF76A371), ("Z", 0xFFA07D4F)],
comp_count = 3
)
for widget in self._string_scale_widget:
widget.visible = False
self._float_scale_widget = self._create_multi_string_with_labels(
ui_widget = ui.FloatDrag,
model = scale_model,
labels = [("X", 0xFF5555AA), ("Y", 0xFF76A371), ("Z", 0xFFA07D4F)],
comp_count = 3
)
scale_stack.set_mouse_double_clicked_fn(lambda x, y, b, m: self._on_double_click(TRANSFORM_OP_SCALE))
scale_stack.set_mouse_pressed_fn(lambda x, y, b, m: self._on_press())
return None
| 83,413 | Python | 46.71968 | 309 | 0.534593 |
omniverse-code/kit/exts/omni.kit.property.transform/omni/kit/property/transform/scripts/__init__.py | from .transform_properties import *
| 36 | Python | 17.499991 | 35 | 0.805556 |
omniverse-code/kit/exts/omni.kit.property.transform/omni/kit/property/transform/scripts/transform_properties.py | import os
import carb
import omni.ext
from pxr import Sdf, UsdLux, UsdGeom, Gf
from pathlib import Path
from functools import partial
from .transform_widget import TransformAttributeWidget
from omni.kit.property.usd.prim_selection_payload import PrimSelectionPayload
from . import transform_builder
import omni.ui as ui
from .transform_commands import *
from . import xform_op_utils
TEST_DATA_PATH = ""
g_ext = None
class TransformPropertyExtension(omni.ext.IExt):
def __init__(self):
self._registered = False
super().__init__()
def on_startup(self, ext_id):
manager = omni.kit.app.get_app().get_extension_manager()
extension_path = manager.get_extension_path(ext_id)
transform_builder.ICON_PATH = Path(extension_path).joinpath("data").joinpath("icons")
global TEST_DATA_PATH
TEST_DATA_PATH = Path(extension_path).joinpath("data").joinpath("test_data")
self._register_widget()
self._register_context_menu()
from omni.kit.property.usd import PrimPathWidget
self._add_button_menu = []
context_menu = omni.kit.context_menu.get_instance()
if context_menu is None:
carb.log_error("context_menu is disabled!")
return None
self._settings = carb.settings.get_settings()
self._add_button_menu.append(
PrimPathWidget.add_button_menu_entry(
"TransformOp/Translate, Rotate, Scale",
show_fn=partial(context_menu.prim_is_type, type=UsdGeom.Xformable),
onclick_fn=partial(self._add_xform_op, add_translate_op=True,
add_rotateXYZ_op=True, add_orient_op=False, add_scale_op=True, add_transform_op=False)
)
)
self._add_button_menu.append(
PrimPathWidget.add_button_menu_entry(
"TransformOp/Translate, Orient, Scale",
show_fn=partial(context_menu.prim_is_type, type=UsdGeom.Xformable),
onclick_fn=partial(self._add_xform_op, add_translate_op=True,
add_rotateXYZ_op=False, add_orient_op=True, add_scale_op=True, add_transform_op=False)
)
)
self._add_button_menu.append(
PrimPathWidget.add_button_menu_entry(
"TransformOp/Transform",
show_fn=partial(context_menu.prim_is_type, type=UsdGeom.Xformable),
onclick_fn=partial(self._add_xform_op, add_translate_op=False,
add_rotateXYZ_op=False, add_orient_op=False, add_scale_op=False, add_transform_op=True)
)
)
self._add_button_menu.append(
PrimPathWidget.add_button_menu_entry(
"TransformOp/Pivot",
show_fn=partial(context_menu.prim_is_type, type=UsdGeom.Xformable),
onclick_fn=partial(self._add_xform_op, add_translate_op=False,
add_rotateXYZ_op=False, add_orient_op=False, add_scale_op=False, add_transform_op=False, add_pivot=True)
)
)
self._add_button_menu.append(
PrimPathWidget.add_button_menu_entry(
"TransformOp/",
show_fn=partial(context_menu.prim_is_type, type=UsdGeom.Xformable),
)
)
self._add_button_menu.append(
PrimPathWidget.add_button_menu_entry(
"TransformOp/Translate",
show_fn=partial(context_menu.prim_is_type, type=UsdGeom.Xformable),
onclick_fn=partial(self._add_xform_op, add_translate_op=True,
add_rotateXYZ_op=False, add_orient_op=False, add_scale_op=False, add_transform_op=False)
)
)
self._add_button_menu.append(
PrimPathWidget.add_button_menu_entry(
"TransformOp/Rotate",
show_fn=partial(context_menu.prim_is_type, type=UsdGeom.Xformable),
onclick_fn=partial(self._add_xform_op, add_translate_op=False,
add_rotateXYZ_op=True, add_orient_op=False, add_scale_op=False, add_transform_op=False)
)
)
self._add_button_menu.append(
PrimPathWidget.add_button_menu_entry(
"TransformOp/Orient",
show_fn=partial(context_menu.prim_is_type, type=UsdGeom.Xformable),
onclick_fn=partial(self._add_xform_op, add_translate_op=False,
add_rotateXYZ_op=False, add_orient_op=True, add_scale_op=False, add_transform_op=False)
)
)
self._add_button_menu.append(
PrimPathWidget.add_button_menu_entry(
"TransformOp/Scale",
show_fn=partial(context_menu.prim_is_type, type=UsdGeom.Xformable),
onclick_fn=partial(self._add_xform_op, add_translate_op=False,
add_rotateXYZ_op=False, add_orient_op=False, add_scale_op=True, add_transform_op=False)
)
)
# set ext
global g_ext
g_ext = self
def on_shutdown(self): # pragma: no cover
if self._registered:
self._unregister_widget()
# release menu item(s)
from omni.kit.property.usd import PrimPathWidget
for item in self._add_button_menu:
PrimPathWidget.remove_button_menu_entry(item)
# release context menu items
self._unregister_context_menu()
#clear
global g_ext
g_ext = None
def _add_xform_op(
self, payload: PrimSelectionPayload, add_translate_op: bool, add_rotateXYZ_op: bool,
add_orient_op: bool, add_scale_op: bool, add_transform_op: bool, add_pivot = False
):
# Retrieve the default precision
default_xform_op_precision = self._settings.get("/persistent/app/primCreation/DefaultXformOpPrecision")
if default_xform_op_precision is None:
self._settings.set_default_string(
"/persistent/app/primCreation/DefaultXformOpPrecision", "Double"
)
default_xform_op_precision = "Double"
_precision = None
if default_xform_op_precision == "Double":
_precision = UsdGeom.XformOp.PrecisionDouble
elif default_xform_op_precision == "Float":
_precision = UsdGeom.XformOp.PrecisionFloat
elif default_xform_op_precision == "Half":
_precision = UsdGeom.XformOp.PrecisionHalf
# No operation is carried out if precision is not properly set
if _precision is None:
carb.log_error("The default xform op precision is not properly set! Please set it in the Edit/Preferences/Stage window!")
return
# Retrieve the default rotation order
default_rotation_order = self._settings.get("/persistent/app/primCreation/DefaultRotationOrder")
if default_rotation_order is None:
self._settings.set_default_string("persistent/app/primCreation/DefaultRotationOrder", "XYZ")
default_rotation_order = "XYZ"
omni.kit.commands.execute("AddXformOp", payload=payload, precision=_precision, rotation_order = default_rotation_order, add_translate_op = add_translate_op,
add_rotateXYZ_op = add_rotateXYZ_op, add_orient_op=add_orient_op, add_scale_op = add_scale_op, add_transform_op = add_transform_op, add_pivot_op = add_pivot)
import omni.kit.window.property as p
p.get_window()._window.frame.rebuild()
def _register_widget(self):
import omni.kit.window.property as p
from omni.kit.window.property.property_scheme_delegate import PropertySchemeDelegate
from omni.kit.property.usd.usd_property_widget import SchemaPropertiesWidget, MultiSchemaPropertiesWidget
w = p.get_window()
if w:
w.register_widget("prim", "transform", TransformAttributeWidget(title="Transform", collapsed=False))
self._registered = True
def _unregister_widget(self):
import omni.kit.window.property as p
w = p.get_window()
if w:
w.unregister_widget("prim", "transform")
self._registered = False
#Context menu to Disable/Delete/Enable transform widgets
def _register_context_menu(self):
import omni.kit.context_menu
menu_sep = {
"name": "",
}
self._separator_menu = omni.kit.context_menu.add_menu(menu_sep, "attribute", "omni.kit.property.usd")
# Disable Menu
def _can_show_disable(object):
model = object.get("model", None)
if hasattr(model, "transform_widget"):
builder_widget = getattr(model, "transform_widget")
if builder_widget:
if xform_op_utils.is_reset_xform_stack_op(builder_widget._op_name):
return True
elif builder_widget._op_name is not None and builder_widget._attr_path is not None:
return True
#This must be a Disalbe Invalid Op menu, a bug if not the case
elif builder_widget._op_name is not None and builder_widget._attr_path is None:
return True
return False
def _on_disable(object):
model = object.get("model", None)
if model:
if hasattr(model, "transform_widget"):
builder_widget = getattr(model, "transform_widget")
if builder_widget:
builder_widget._delete_op_only()
menu_disable = {
"name": "Disable",
"show_fn": _can_show_disable,
"onclick_fn": _on_disable
}
self._on_disable_menu = omni.kit.context_menu.add_menu(menu_disable, "attribute", "omni.kit.property.usd")
#Delete Menu
def _can_show_delete(object):
model = object.get("model", None)
if model:
if hasattr(model, "transform_widget"):
builder_widget = getattr(model, "transform_widget")
if builder_widget:
if xform_op_utils.is_reset_xform_stack_op(builder_widget._op_name):
return False
elif builder_widget._attr_path is not None:
return True
return False
def _on_delete(object):
model = object.get("model", None)
if model:
if hasattr(model, "transform_widget"):
builder_widget = getattr(model, "transform_widget")
if builder_widget:
if builder_widget._op_name is not None:
builder_widget._delete_op_and_attribute()
else:
builder_widget._delete_non_op_attribute()
menu_delete = {
"name": "Delete",
"show_fn": _can_show_delete,
"onclick_fn": _on_delete
}
self._on_delete_menu = omni.kit.context_menu.add_menu(menu_delete, "attribute", "omni.kit.property.usd")
#Enable Menu
def _can_show_enable(object):
model = object.get("model", None)
if model:
if hasattr(model, "transform_widget"):
builder_widget = getattr(model, "transform_widget")
if builder_widget:
if builder_widget._op_name is None and builder_widget._attr_path is not None:
return True
return False
def _on_enable(object):
model = object.get("model", None)
if model:
if hasattr(model, "transform_widget"):
builder_widget = getattr(model, "transform_widget")
if builder_widget:
builder_widget._add_non_op_attribute_to_op()
menu_enable = {
"name": "Enable",
"show_fn": _can_show_enable,
"onclick_fn": _on_enable
}
self._on_enable_menu = omni.kit.context_menu.add_menu(menu_enable, "attribute", "omni.kit.property.usd")
def _unregister_context_menu(self):
self._separator_menu = None
self._on_disable_menu = None
self._on_delete_menu = None
self._on_enable_menu = None
| 12,530 | Python | 41.767918 | 165 | 0.575499 |
omniverse-code/kit/exts/omni.kit.property.transform/omni/kit/property/transform/scripts/transform_commands.py | import carb
import omni.kit.commands
import omni.usd
from omni.kit.usd_undo import *
from pxr import Gf, Vt, Sdf, Usd, UsdGeom, UsdUtils
from . import xform_op_utils
class EnableXformOpCommand(omni.kit.commands.Command):
"""
Add and attritube's corresponding XformOp to xformOpOrder **Command**.
Args:
op_attr_path (str): path of the xformOp attribute.
Example:
We might want to add xformOp:translate to the xformOpOrder token array
Provided that xformOp:translate attribute exists and xformOp:translate is no in xformOpOrder
"""
def __init__(self, op_attr_path: str, enable=True):
self._op_attr_path = Sdf.Path(op_attr_path)
self._usd_context = omni.usd.get_context()
self._prev_xform_ops = None
self._layer_op_order_map = {}
def do(self):
stage = self._usd_context.get_stage()
if stage:
op_attr = stage.GetObjectAtPath(self._op_attr_path)
if not op_attr:
return
precision = xform_op_utils.get_op_precision(op_attr.GetTypeName())
op_name = op_attr.GetName()
op_type = xform_op_utils.get_op_type(op_name)
if op_type is None:
return
prim = op_attr.GetPrim()
if not prim.IsA(UsdGeom.Xformable):
return
op_suffix = xform_op_utils.get_op_name_suffix(op_name)
if op_suffix == None:
op_suffix = ""
xform = UsdGeom.Xformable(prim)
self._prev_xform_ops = xform.GetOrderedXformOps()
new_target = stage.GetEditTargetForLocalLayer(stage.GetEditTarget().GetLayer())
with Usd.EditContext(stage, new_target):
with Sdf.ChangeBlock():
added_op = xform.AddXformOp(opType=op_type, precision = precision, opSuffix=op_suffix)
#for pivot, we should add its inverse op as well
#
if xform_op_utils.is_pivot_op(op_name):
pivot_op = added_op
#Assume that !invert!xformOp:translate:pivot is always a trailing op
xform.AddTranslateOp(precision = precision, opSuffix="pivot", isInverseOp=True)
#Move the pivot op infront of the transform op as a special case
xform_ops = xform.GetOrderedXformOps()
new_xform_ops = []
found_transform_op = False
for op in xform_ops:
#wrap the transform op with pivot op
if op.GetOpType() == UsdGeom.XformOp.TypeTransform:
new_xform_ops.append(pivot_op)
new_xform_ops.append(op)
found_transform_op = True
continue
# skip the pivot op if we insert it in front of transform op
if found_transform_op and op.GetOpType() == UsdGeom.XformOp.TypeTranslate \
and xform_op_utils.is_pivot_op(str(op.GetOpName())) \
and not xform_op_utils.is_inverse_op(str(op.GetOpName())):
continue
new_xform_ops.append(op)
xform.SetXformOpOrder(new_xform_ops, xform.GetResetXformStack())
def undo(self):
stage = self._usd_context.get_stage()
op_attr = stage.GetObjectAtPath(self._op_attr_path)
if not op_attr:
return
prim = op_attr.GetPrim()
if not prim.IsA(UsdGeom.Xformable):
return
xform = UsdGeom.Xformable(prim)
with Sdf.ChangeBlock():
new_target = stage.GetEditTargetForLocalLayer(stage.GetEditTarget().GetLayer())
with Usd.EditContext(stage, new_target):
xform.SetXformOpOrder(self._prev_xform_ops)
class ChangeRotationOpCommand(omni.kit.commands.Command):
"""
Change the Rotation XformOp **Command**.
Args:
src_op_attr_path (str): path of the source xformOp attribute.
dst_op_attr_name (str): path of the destination xformOp attribute
is_inverse_op (bool): if it is an inverse op, add an !invert! in the xformOpOrder
Example:
We may want to change from xformOp:rotateZYX to xformOp:rotateXYZ. It will
1) update the xformOpOrder
2) delete xformOp:rotateZYX attribute
3) create xformOp:rotateXYZ attribute
4) copy the xformOp:rotateZYX to xfomOp:rotateXYZ
"""
def __init__(self, src_op_attr_path: str, op_name: str, dst_op_attr_name: str, is_inverse_op: bool, auto_target_layer: bool = True):
self._src_op_attr_path = Sdf.Path(src_op_attr_path)
self._op_name = op_name
self._dst_op_attr_name = dst_op_attr_name
self._is_inverse_op = is_inverse_op
self._auto_target_layer = auto_target_layer
self._usd_context = omni.usd.get_context()
self._usd_undos = dict()
def _get_undo(self, layer):
if layer is not None:
undo = self._usd_undos.get(layer)
if undo is not None:
return undo
self._usd_undos[layer] = UsdLayerUndo(layer)
return self._usd_undos[layer]
def _change_rotation_op(self):
stage = self._usd_context.get_stage()
src_op_attr = stage.GetObjectAtPath(self._src_op_attr_path)
if src_op_attr == None or not src_op_attr.IsValid():
return
src_op_attr_name = src_op_attr.GetName()
if src_op_attr_name is None or self._dst_op_attr_name is None or src_op_attr_name == self._dst_op_attr_name:
return
prim = src_op_attr.GetPrim()
if not prim:
return
op_order_attr = prim.GetAttribute("xformOpOrder")
if not op_order_attr:
return
with Sdf.ChangeBlock():
current_authoring_layer = stage.GetEditTarget().GetLayer()
# change xforpOpOrder
layer_info, layer = omni.usd.get_attribute_effective_defaultvalue_layer_info(stage, op_order_attr)
auto_target_session_layer = omni.usd.get_prop_auto_target_session_layer(stage, op_order_attr.GetPath()) if self._auto_target_layer else None
if (layer_info == omni.usd.Value_On_Layer.ON_CURRENT_LAYER
or layer_info == omni.usd.Value_On_Layer.ON_WEAKER_LAYER
or (layer_info == omni.usd.Value_On_Layer.ON_STRONGER_LAYER and auto_target_session_layer is not None and self._auto_target_layer == True )
):
if self._op_name:
order = op_order_attr.Get()
old_op_name = self._op_name
new_op_name = self._dst_op_attr_name = (
self._dst_op_attr_name
if not self._is_inverse_op
else "!invert!" + self._dst_op_attr_name
)
for i in range(len(order)):
if order.__getitem__(i) == old_op_name:
order.__setitem__(i, new_op_name)
break
if auto_target_session_layer:
undo = self._get_undo(auto_target_session_layer)
undo.reserve(op_order_attr.GetPath())
with Usd.EditContext(stage, auto_target_session_layer):
op_order_attr.Set(order)
else:
undo = self._get_undo(current_authoring_layer)
undo.reserve(op_order_attr.GetPath())
op_order_attr.Set(order)
# copy to new attribute
old_dst_op_attr = prim.GetAttribute(self._dst_op_attr_name)
# the dst_op_attr may already exist
if old_dst_op_attr:
layer_info, layer = omni.usd.get_attribute_effective_value_layer_info(stage, old_dst_op_attr)
auto_target_session_layer = omni.usd.get_prop_auto_target_session_layer(stage, old_dst_op_attr.GetPath()) if self._auto_target_layer else None
value_on_session_OK = layer_info == omni.usd.Value_On_Layer.ON_STRONGER_LAYER and self._auto_target_layer == True and auto_target_session_layer is not None
value_update_OK = (layer_info == omni.usd.Value_On_Layer.ON_CURRENT_LAYER
or layer_info == omni.usd.Value_On_Layer.ON_WEAKER_LAYER
or value_on_session_OK)
if value_update_OK:
if auto_target_session_layer is not None:
undo = self._get_undo(auto_target_session_layer)
undo.reserve(old_dst_op_attr.GetPath())
with Usd.EditContext(stage, auto_target_session_layer):
src_op_attr.FlattenTo(prim, self._dst_op_attr_name)
else:
undo = self._get_undo(current_authoring_layer)
undo.reserve(old_dst_op_attr.GetPath())
src_op_attr.FlattenTo(prim, self._dst_op_attr_name)
source_auto_target_sessiolayer = omni.usd.get_prop_auto_target_session_layer(stage, self._src_op_attr_path) if self._auto_target_layer else None
if source_auto_target_sessiolayer is not None:
undo = self._get_undo(source_auto_target_sessiolayer)
undo.reserve(self._src_op_attr_path)
with Usd.EditContext(stage, source_auto_target_sessiolayer):
prim.RemoveProperty(src_op_attr_name)
else:
undo = self._get_undo(current_authoring_layer)
undo.reserve(self._src_op_attr_path)
prim.RemoveProperty(src_op_attr_name)
else:
carb.log_warn(f"{self._dst_op_attr_name} has value authoring in stronger layer, cannot overwrite it! ")
else:
dst_op_attr_path = prim.GetPath().AppendProperty(self._dst_op_attr_name)
if dst_op_attr_path:
auto_target_session_layer = omni.usd.get_prop_auto_target_session_layer(stage, old_dst_op_attr.GetPath()) if self._auto_target_layer else None
if auto_target_session_layer is not None:
undo = self._get_undo(auto_target_session_layer)
undo.reserve(dst_op_attr_path)
with Usd.EditContext(stage, auto_target_session_layer):
src_op_attr.FlattenTo(prim, self._dst_op_attr_name)
else:
undo = self._get_undo(current_authoring_layer)
undo.reserve(dst_op_attr_path)
src_op_attr.FlattenTo(prim, self._dst_op_attr_name)
source_auto_target_sessiolayer = omni.usd.get_prop_auto_target_session_layer(stage, self._src_op_attr_path) if self._auto_target_layer else None
if source_auto_target_sessiolayer is not None:
undo = self._get_undo(source_auto_target_sessiolayer)
undo.reserve(self._src_op_attr_path)
with Usd.EditContext(stage, source_auto_target_sessiolayer):
prim.RemoveProperty(src_op_attr_name)
else:
undo = self._get_undo(current_authoring_layer)
undo.reserve(self._src_op_attr_path)
prim.RemoveProperty(src_op_attr_name)
else:
carb.log_error(f"Invalid dst_op_attr_name {self._dst_op_attr_name}. Note this is the attribute name.")
else:
carb.log_warn("xformOpOrder has value authoring a stronger persistent layer, cannot authoring rotate order! ")
def do(self):
stage = self._usd_context.get_stage()
if not stage:
return
self._change_rotation_op()
def undo(self):
for undo in self._usd_undos.values():
undo.undo()
class RemoveXformOpCommand(omni.kit.commands.Command):
"""
Remove XformOp Only **Command**.
Args:
op_order_attr_path (str): path of the xformOpOrder attribute.
op_name (str): name of the xformOp to be removed
Example:
We might want to remove xformOp:translate from the xformOpOrder token array
But we still keep the xformOp:translate attribute itself
"""
def __init__(self, op_order_attr_path: str, op_name: str, op_order_index: int):
self._op_order_attr_path = Sdf.Path(op_order_attr_path)
self._op_order_index = op_order_index
self._op_name = op_name
self._usd_context = omni.usd.get_context()
self._usd_undo = None
def do(self):
stage = self._usd_context.get_stage()
if not stage:
return
usd_undo = UsdLayerUndo(stage.GetEditTarget().GetLayer())
usd_undo.reserve(self._op_order_attr_path)
order_attr = stage.GetObjectAtPath(self._op_order_attr_path)
if order_attr:
with Sdf.ChangeBlock():
op_order = order_attr.Get()
if self._op_order_index < len(op_order):
op_name = op_order.__getitem__(self._op_order_index)
# when remove pivot op also need to remove invert pivot op
is_pivot_op = xform_op_utils.is_pivot_op(op_name)
inv_op_name = xform_op_utils.get_inverse_op_Name(op_name, True) if is_pivot_op else None
if op_name == self._op_name:
new_order = []
for i in range(len(op_order)):
if i != self._op_order_index:
if is_pivot_op and inv_op_name == op_order.__getitem__(i):
continue
new_order.append(op_order.__getitem__(i))
order_attr.Set(new_order)
self._usd_undo = usd_undo
def undo(self):
if self._usd_undo is None:
return
self._usd_undo.undo()
class RemoveXformOpAndAttrbuteCommand(omni.kit.commands.Command):
"""
Remove XformOp And Attribute **Command**.
Args:
op_order_attr_path (str): path of the xformOpOrder attribute.
op_name (str): name of the xformOp to be removed
Example:
We might want to remove xformOp:translate from the xformOpOrder token array
But we still keep the xformOp:translate attribute itself
"""
def __init__(self, op_order_attr_path: str, op_name: str, op_order_index: int):
self._op_order_attr_path = Sdf.Path(op_order_attr_path) # the xformOpOrder attribute path
self._op_name = op_name # xformOpName
self._op_order_index = op_order_index
self._usd_context = omni.usd.get_context()
self._usd_undo = None
def do(self):
stage = omni.usd.get_context().get_stage()
if stage:
usd_undo = UsdLayerUndo(stage.GetEditTarget().GetLayer())
self._usd_undo = usd_undo
order_attr = stage.GetObjectAtPath(self._op_order_attr_path)
if order_attr:
with Sdf.ChangeBlock():
op_order = order_attr.Get()
if self._op_order_index < len(op_order):
op_name = op_order.__getitem__(self._op_order_index)
if op_name == self._op_name:
# if it is an pivot op to remove, we'd also remove it's companion inverse pivot op
is_pivot_op = xform_op_utils.is_pivot_op(op_name)
inverse_pivot_op_name = xform_op_utils.get_inverse_op_Name(op_name, True) if is_pivot_op else None
attr_name = xform_op_utils.get_op_attr_name(op_name)
can_delete_attr = True
new_order = []
for i in range(len(op_order)):
#exclude the op
if i != self._op_order_index:
#if it is a pivot also exclude the inverse op
if is_pivot_op and op_order.__getitem__(i) == inverse_pivot_op_name:
continue
other_op_name = op_order.__getitem__(i)
new_order.append(other_op_name)
if attr_name == xform_op_utils.get_op_attr_name(other_op_name):
can_delete_attr = False
new_token_order = Vt.TokenArray(new_order)
usd_undo.reserve(self._op_order_attr_path)
order_attr.Set(new_order)
if can_delete_attr:
prim = order_attr.GetPrim()
if prim:
usd_undo.reserve(prim.GetPath().AppendProperty(attr_name))
prim.RemoveProperty(attr_name)
def undo(self):
if self._usd_undo is None:
return
self._usd_undo.undo()
class AddXformOpCommand(omni.kit.commands.Command):
"""
Add and attritube's corresponding XformOp to xformOpOrder **Command**.
Args:
op_attr_path (str): path of the xformOp attribute.
Example:
We might want to add xformOp:translate to the xformOpOrder token array
Provided that xformOp:translate attribute exists and xformOp:translate is no in xformOpOrder
"""
def __init__(self, payload, precision, rotation_order, add_translate_op,
add_rotateXYZ_op, add_orient_op, add_scale_op, add_transform_op, add_pivot_op):
self._payload = payload
self._precision = precision
self._rotation_op_name = "xformOp:rotate" + rotation_order
self._add_translate_op = add_translate_op
self._add_rotate_op = add_rotateXYZ_op
self._add_orient_op=add_orient_op
self._add_scale_op = add_scale_op
self._add_transform_op = add_transform_op
self._add_pivot_op = add_pivot_op
self._usd_undo = None
self._prv_xform_op_order = {}
self._translate_attr_added = {}
self._rotate_attr_added = {}
self._orient_attr_added = {}
self._scale_attr_added = {}
self._transform_attr_added = {}
self._pivot_attr_added = {}
def do(self):
stage = self._payload.get_stage()
if not stage:
return
# check precision first and return
if self._precision != UsdGeom.XformOp.PrecisionHalf and self._precision != UsdGeom.XformOp.PrecisionDouble and self._precision != UsdGeom.XformOp.PrecisionFloat:
carb.log_error("Illegal value precision setting! Precision setting can be UsdGeom.XformOp.PrecisionDouble OR UsdGeom.XformOp.PrecisionFloat OR UsdGeom.XformOp.PrecisionHalf.")
return
for path in self._payload:
if path:
selected_prim = stage.GetPrimAtPath(path)
selected_xformable = UsdGeom.Xformable(selected_prim)
# if not xform, skip
if not selected_xformable:
carb.log_error(f"Illegal prim {path}: this is not an UsdGeom.Xformable prim.")
continue
path_string = path.pathString
translate_attr = selected_prim.GetAttribute("xformOp:translate")
rotate_attr = selected_prim.GetAttribute(self._rotation_op_name)
scale_attr = selected_prim.GetAttribute("xformOp:scale")
orient_attr = selected_prim.GetAttribute("xformOp:orient")
transform_attr = selected_prim.GetAttribute("xformOp:transform")
pivot_attr = selected_prim.GetAttribute("xformOp:translate:pivot")
translate_attr_exist = True if translate_attr.IsValid() else False
rotate_attr_exist = True if rotate_attr.IsValid() else False
scale_attr_exist = True if scale_attr.IsValid() else False
orient_attr_exist = True if orient_attr.IsValid() else False
transform_attr_exist = True if transform_attr.IsValid() else False
pivot_attr_exist = True if pivot_attr.IsValid() else False
translate_attr_type = xform_op_utils.get_op_precision(translate_attr.GetTypeName()) if translate_attr_exist else None
rotate_attr_type = xform_op_utils.get_op_precision(rotate_attr.GetTypeName()) if rotate_attr_exist else None
scale_attr_type = xform_op_utils.get_op_precision(scale_attr.GetTypeName()) if scale_attr_exist else None
orient_attr_type = xform_op_utils.get_op_precision(orient_attr.GetTypeName()) if orient_attr_exist else None
pivot_attr_type = xform_op_utils.get_op_precision(pivot_attr.GetTypeName()) if pivot_attr_exist else None
def does_match_precision(self, attr_type):
if attr_type and self._precision != attr_type:
return False
return True
xform_op_order_attr = selected_xformable.GetXformOpOrderAttr()
translate_op_exist = rotate_op_exist = scale_op_exist = orient_op_exist = transform_op_exist = pivot_op_exist = False
self._translate_attr_added[path_string] = self._rotate_attr_added[path_string] = False
self._orient_attr_added[path_string] = self._scale_attr_added[path_string] = self._transform_attr_added[path_string] = False
self._pivot_attr_added[path_string] = False
with Sdf.ChangeBlock():
#In a rare case, there is no xformOpOrder attribute
if not xform_op_order_attr:
xform_op_order_attr = selected_xformable.CreateXformOpOrderAttr()
xform_op_order = xform_op_order_attr.Get()
ordered_xform_op = selected_xformable.GetOrderedXformOps()
for op in ordered_xform_op:
if op.GetOpName() == 'xformOp:translate':
translate_op_exist = True
elif op.GetOpName() == self._rotation_op_name:
rotate_op_exist = True
elif op.GetOpName() == 'xformOp:scale':
scale_op_exist = True
elif op.GetOpName() == 'xformOp:orient':
orient_op_exist = True
elif op.GetOpName() == 'xformOp:transform':
transform_op_exist = True
elif op.GetOpType() == UsdGeom.XformOp.TypeTranslate and "pivot" in op.SplitName():
pivot_op_exist = True
self._prv_xform_op_order[path_string] = xform_op_order
#Translate Op
if self._add_translate_op == True:
if translate_attr_exist and translate_op_exist:
carb.log_warn(f"The translate Op in prim {path} already exist!")
# There is already translate attribute exist
elif translate_op_exist == False:
if does_match_precision(self, translate_attr_type):
selected_xformable.AddTranslateOp(precision = self._precision)
if translate_attr_exist == False:
if self._precision == UsdGeom.XformOp.PrecisionDouble:
selected_prim.CreateAttribute("xformOp:translate", Sdf.ValueTypeNames.Double3,False).Set(Gf.Vec3d(0, 0, 0))
elif self._precision == UsdGeom.XformOp.PrecisionFloat:
selected_prim.CreateAttribute("xformOp:translate", Sdf.ValueTypeNames.Float3,False).Set(Gf.Vec3f(0, 0, 0))
elif self._precision == UsdGeom.XformOp.PrecisionHalf:
selected_prim.CreateAttribute("xformOp:translate", Sdf.ValueTypeNames.Half3,False).Set(Gf.Vec3h(0, 0, 0))
self._translate_attr_added[path_string] = True
else:
carb.log_error("Illegal translate value precision setting!")
#Rotate Op
if self._add_rotate_op == True:
if rotate_attr_exist and rotate_op_exist:
carb.log_warn(f"The rotate Op in prim {path} already exist!")
# There is already translate attribute exist
elif rotate_op_exist == False:
if does_match_precision(self, rotate_attr_type):
rotation_op_type = xform_op_utils.get_op_type(self._rotation_op_name)
if rotation_op_type:
selected_xformable.AddXformOp(rotation_op_type,precision = self._precision)
if rotate_attr_exist == False:
if self._precision == UsdGeom.XformOp.PrecisionDouble:
selected_prim.CreateAttribute(self._rotation_op_name, Sdf.ValueTypeNames.Double3,False).Set(Gf.Vec3d(0, 0, 0))
elif self._precision == UsdGeom.XformOp.PrecisionFloat:
selected_prim.CreateAttribute(self._rotation_op_name, Sdf.ValueTypeNames.Float3,False).Set(Gf.Vec3f(0, 0, 0))
elif self._precision == UsdGeom.XformOp.PrecisionHalf:
selected_prim.CreateAttribute(self._rotation_op_name, Sdf.ValueTypeNames.Half3,False).Set(Gf.Vec3h(0, 0, 0))
self._rotate_attr_added[path_string] = True
else:
carb.log_error("Illegal rotate value precision setting!")
#Orient Op
if self._add_orient_op == True:
if orient_attr_exist and orient_op_exist:
carb.log_warn(f"The orient Op in prim {path} already exist!")
# There is already translate attribute exist
elif orient_op_exist == False:
if does_match_precision(self, orient_attr_type):
selected_xformable.AddOrientOp(precision = self._precision)
if orient_attr_exist == False:
if self._precision == UsdGeom.XformOp.PrecisionDouble:
selected_prim.CreateAttribute("xformOp:orient", Sdf.ValueTypeNames.Quatd,False).Set(Gf.Quatd(1.0))
elif self._precision == UsdGeom.XformOp.PrecisionFloat:
selected_prim.CreateAttribute("xformOp:orient", Sdf.ValueTypeNames.Quatf,False).Set(Gf.Quatf(1.0))
elif self._precision == UsdGeom.XformOp.PrecisionHalf:
selected_prim.CreateAttribute("xformOp:orient", Sdf.ValueTypeNames.Quath,False).Set(Gf.Quath(1.0))
self._orient_attr_added[path_string] = True
else:
carb.log_error("Illegal orient value precision setting!")
#Scale Op
if self._add_scale_op == True:
if scale_attr_exist and scale_op_exist:
carb.log_warn(f"The scale Op in prim {path} already exist!")
# There is already translate attribute exist
elif scale_op_exist == False:
if does_match_precision(self, scale_attr_type):
selected_xformable.AddScaleOp(precision = self._precision)
if scale_attr_exist == False:
if self._precision == UsdGeom.XformOp.PrecisionDouble:
selected_prim.CreateAttribute("xformOp:scale", Sdf.ValueTypeNames.Double3,False).Set(Gf.Vec3d(1.0, 1.0, 1.0))
elif self._precision == UsdGeom.XformOp.PrecisionFloat:
selected_prim.CreateAttribute("xformOp:scale", Sdf.ValueTypeNames.Float3,False).Set(Gf.Vec3f(1.0, 1.0, 1.0))
elif self._precision == UsdGeom.XformOp.PrecisionHalf:
selected_prim.CreateAttribute("xformOp:scale", Sdf.ValueTypeNames.Half3,False).Set(Gf.Vec3h(1.0, 1.0, 1.0))
self._scale_attr_added[path_string] = True
else:
carb.log_error("Illegal scale value precision setting!")
#Transform Op
if self._add_transform_op == True:
if transform_attr_exist and transform_op_exist:
carb.log_warn(f"The transform Op in prim {path} already exist!")
# There is already transform attribute exist
elif transform_op_exist == False:
#'Matrix transformations can only be encoded in double precision. Overriding precision to double.'
#transform has to be double
selected_xformable.AddTransformOp(UsdGeom.XformOp.PrecisionDouble)
if transform_attr_exist == False:
# there is only Matrix4d type
selected_prim.CreateAttribute("xformOp:transform", Sdf.ValueTypeNames.Matrix4d,False).Set(Gf.Matrix4d(1.0))
self._transform_attr_added[path_string] = True
#refresh to make sure pivot is inserted in the right place
ordered_xform_op = selected_xformable.GetOrderedXformOps()
#Pivot Op
if self._add_pivot_op == True:
if pivot_attr_exist and pivot_op_exist:
carb.log_warn(f"The pivot Op in the prim {path} already exist!")
elif pivot_op_exist == False:
if does_match_precision(self, pivot_attr_type):
# Parse the xformOpOrder to find out the rotateion-related & scale-related op's index
# there might be multiple rotation & scale op to consider
xform_op_size = len(ordered_xform_op)
rotate_or_transform_start_index = rotate_or_transform_end_index = scale_start_index = scale_end_index = xform_op_size
for index in range(xform_op_size):
op = ordered_xform_op[index]
op_type = op.GetOpType()
# Suffixed op doesn't count
if op_type > UsdGeom.XformOp.TypeInvalid and \
len(op.GetOpName().split(":"))>2:
continue
if op_type >= UsdGeom.XformOp.TypeRotateX \
and op_type <= UsdGeom.XformOp.TypeTransform:
rotate_or_transform_end_index = index
if rotate_or_transform_start_index == xform_op_size:
rotate_or_transform_start_index = index
elif op_type == UsdGeom.XformOp.TypeScale:
scale_end_index = index
if scale_start_index == xform_op_size:
scale_start_index = index
if rotate_or_transform_start_index == xform_op_size and scale_start_index == xform_op_size:
carb.log_warn("There is no rotate, orient, transform or scale Op for this prim. No rotation Pivot is added.")
return
#Add the pivot op and invert pivot op and then reorder it
pivot_op = selected_xformable.AddTranslateOp(precision = self._precision, opSuffix="pivot")
inv_pivot_op = selected_xformable.AddTranslateOp(precision = self._precision, opSuffix="pivot", isInverseOp=True)
#pivot and inv pivot to wrap the rotate & scale op. pivot heading inv pivot trailing
pivot_index = min(rotate_or_transform_start_index, scale_start_index)
inv_pivot_index = max(rotate_or_transform_end_index, scale_end_index)
inv_pivot_index = inv_pivot_index + 1 #insert after
# if the inverse pivot op is at the tail, just append it
if inv_pivot_index >= len(ordered_xform_op):
ordered_xform_op.append(inv_pivot_op)
else:
ordered_xform_op.insert(inv_pivot_index, inv_pivot_op)
#It is important to insert pivot_op after inv_pivot_op
ordered_xform_op.insert(pivot_index, pivot_op)
selected_xformable.SetXformOpOrder(ordered_xform_op, selected_xformable.GetResetXformStack())
#Create xformOp:translate:pivot attribute
if pivot_attr_exist == False:
if self._precision == UsdGeom.XformOp.PrecisionDouble:
selected_prim.CreateAttribute("xformOp:translate:pivot", Sdf.ValueTypeNames.Double3,False).Set(Gf.Vec3d(0.0, 0.0, 0.0))
elif self._precision == UsdGeom.XformOp.PrecisionFloat:
selected_prim.CreateAttribute("xformOp:translate:pivot", Sdf.ValueTypeNames.Float3,False).Set(Gf.Vec3f(0.0, 0.0, 0.0))
elif self._precision == UsdGeom.XformOp.PrecisionHalf:
selected_prim.CreateAttribute("xformOp:translate:pivot", Sdf.ValueTypeNames.Half3,False).Set(Gf.Vec3h(0.0, 0.0, 0.0))
self._pivot_attr_added[path_string] = True
else:
carb.log_error("Illegal pivot value precision setting!")
def undo(self):
stage = self._payload.get_stage()
if not stage:
return
for path in self._payload:
if path:
selected_prim = stage.GetPrimAtPath(path)
selected_xformable = UsdGeom.Xformable(selected_prim)
path_string = path.pathString
with Sdf.ChangeBlock():
xform_op_order_attr = selected_xformable.GetXformOpOrderAttr()
if xform_op_order_attr:
xform_op_order_attr.Set(self._prv_xform_op_order[path_string])
if self._translate_attr_added[path_string]:
selected_prim.RemoveProperty("xformOp:translate")
self._translate_attr_added[path_string] = False
if self._rotate_attr_added[path_string]:
selected_prim.RemoveProperty(self._rotation_op_name)
self._rotate_attr_added[path_string] = False
if self._orient_attr_added[path_string]:
selected_prim.RemoveProperty("xformOp:orient")
self._orient_attr_added[path_string] = False
if self._scale_attr_added[path_string]:
selected_prim.RemoveProperty("xformOp:scale")
self._scale_attr_added[path_string] = False
if self._transform_attr_added[path_string]:
selected_prim.RemoveProperty("xformOp:transform")
self._transform_attr_added[path_string] = False
if self._pivot_attr_added[path_string]:
selected_prim.RemoveProperty("xformOp:translate:pivot")
self._pivot_attr_added[path_string] = False
omni.kit.commands.register_all_commands_in_module(__name__)
| 37,809 | Python | 55.181278 | 187 | 0.525536 |
omniverse-code/kit/exts/omni.kit.property.transform/omni/kit/property/transform/tests/test_builder.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 weakref
import omni.kit.app
import omni.kit.test
import omni.kit.commands
import omni.ui as ui
from omni.kit import ui_test
from omni.kit.test_suite.helpers import wait_stage_loading, select_prims
from omni.ui.tests.test_base import OmniUiTest
from omni.kit.property.usd.prim_selection_payload import PrimSelectionPayload
from pathlib import Path
from pxr import UsdGeom, Sdf
from ..scripts.transform_builder import TransformWidgets, TransformWatchModel, USDXformOpWidget
from ..scripts.transform_widget import TransformAttributeWidget
from ..scripts.transform_properties import g_ext
class TestTransformBuilder(OmniUiTest):
xform_op_names = ["xformOp:translate", "xformOp:rotateXYZ", "xformOp:orient", "xformOp:scale", "xformOp:translate:pivot", "xformOp:transform"]
# Before running each test
async def setUp(self):
await super().setUp()
extension_root_folder = Path(omni.kit.app.get_app().get_extension_manager().get_extension_path_by_module(__name__))
self._usd_path = extension_root_folder.joinpath("data/test_data/test_map")
# After running each test
async def tearDown(self):
await super().tearDown()
def get_index_op_code(self, xform : UsdGeom.Xformable, op_name):
xform_ops = xform.GetOrderedXformOps()
for i, op in enumerate(xform_ops):
if op.GetOpName() == op_name:
return i
return -1
async def test_builder_widgets(self):
usd_context = omni.usd.get_context()
test_file_path = self._usd_path.joinpath("test_transform_property.usda").absolute()
await usd_context.open_stage_async(str(test_file_path))
await wait_stage_loading()
#get prim for sphere
stage = usd_context.get_stage()
prim_path = '/World/Capsule'
prim = stage.GetPrimAtPath(prim_path)
xform = UsdGeom.Xformable(prim)
transformWidget = TransformAttributeWidget("Test", True)
await select_prims([prim_path])
collapsable_frame = ui.Frame(height=0, style={"Frame": {"padding": 0}})
# widget delete test
widgets = []
op_order_attr = prim.GetAttribute('XformOpOrder')
for op_name in self.xform_op_names:
#valid means disabled or not
widget = transformWidget._transform_widget._create_xform_op_widget(
[Sdf.Path(prim_path)], collapsable_frame, stage, prim.GetAttribute(op_name), op_name,
True, op_order_attr, self.get_index_op_code(xform, op_name)
)
widgets.append(widget)
await ui_test.human_delay(3)
transformWidget = None
widgets = []
transformWidget = TransformAttributeWidget("Test2", True)
collapsable_frame = ui.Frame(height=0, style={"Frame": {"padding": 0}})
widgets = []
op_order_attr = prim.GetAttribute('XformOpOrder')
for op_name in self.xform_op_names:
#valid means disabled or not
widget = transformWidget._transform_widget._create_xform_op_widget(
[Sdf.Path(prim_path)], collapsable_frame, stage, prim.GetAttribute(op_name), op_name,
False, op_order_attr, self.get_index_op_code(xform, op_name)
)
widgets.append(widget)
await ui_test.human_delay(3)
transformWidget = None
widgets = []
#watch model
watch_model = TransformWatchModel(0, stage)
await ui_test.human_delay(3)
watch_model.set_value(0.3)
self.assertTrue(watch_model.get_value_as_float() == 0.3)
self.assertTrue(watch_model.get_value_as_string() == "0.3")
watch_model.clean()
watch_model = None
# USD Xform Op Widget
for op_name in self.xform_op_names:
#valid means disabled or not
widget = USDXformOpWidget(
[Sdf.Path(prim_path)], collapsable_frame, stage, prim.GetAttribute(op_name).GetPath(), op_name,
True, op_order_attr, self.get_index_op_code(xform, op_name))
#widget._inverse_op()
widget._add_key()
widget._show_right_click_menu(button=1)
async def test_add_buttons(self):
usd_context = omni.usd.get_context()
test_file_path = self._usd_path.joinpath("test_transform_property.usda").absolute()
await usd_context.open_stage_async(str(test_file_path))
await wait_stage_loading()
#get prim for sphere
stage = usd_context.get_stage()
prim_paths =["/World/Capsule", "/World/Sphere", "/World/Cube", "/World/Cylinder", "/World/Cone"]
for prim_path in prim_paths:
await select_prims([prim_path])
prim = stage.GetObjectAtPath(prim_path)
payload = PrimSelectionPayload( weakref.ref(stage), [prim.GetPath()])
for button_menu in g_ext._add_button_menu:
if button_menu.onclick_fn:
button_menu.onclick_fn(payload)
await ui_test.human_delay(2)
| 5,548 | Python | 37.534722 | 146 | 0.637167 |
omniverse-code/kit/exts/omni.kit.property.transform/omni/kit/property/transform/tests/test_transform.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.app
import omni.kit.commands
import omni.kit.test
import omni.ui as ui
from omni.kit import ui_test
from omni.kit.test_suite.helpers import wait_stage_loading
from omni.ui.tests.test_base import OmniUiTest
from pxr import Kind, Sdf, Gf, UsdGeom
from pathlib import Path
import carb
from carb.input import KeyboardInput
def equal_eps(a, b, esp = 0.0001):
return abs(a - b) < esp
def equal_scale_eps(t, s):
m = Gf.Vec3d(0.0)
m[0] = t.GetRow(0).GetLength()
m[1] = t.GetRow(1).GetLength()
m[2] = t.GetRow(2).GetLength()
#print (m)
return equal_eps(m[0], s[0]) and equal_eps(m[1], s[1]) and equal_eps(m[2], s[2])
class TestTransformWidget(OmniUiTest):
# Before running each test
async def setUp(self):
await super().setUp()
extension_root_folder = Path(omni.kit.app.get_app().get_extension_manager().get_extension_path_by_module(__name__))
self._golden_img_dir = extension_root_folder.joinpath("data/test_data/golden_img")
self._usd_path = extension_root_folder.joinpath("data/test_data/test_map")
from omni.kit.property.usd.usd_attribute_widget import UsdPropertiesWidget
import omni.kit.window.property as p
self._w = p.get_window()
# After running each test
async def tearDown(self):
await super().tearDown()
async def test_transform_property_srt(self):
usd_context = omni.usd.get_context()
await self.docked_test_window(
window=self._w._window,
width=450,
height=250,
restore_window = ui.Workspace.get_window("Layer") or ui.Workspace.get_window("Stage"),
restore_position = ui.DockPosition.BOTTOM)
test_file_path = self._usd_path.joinpath("test_transform_property.usda").absolute()
await usd_context.open_stage_async(str(test_file_path))
await wait_stage_loading()
# Select the prim.
usd_context.get_selection().set_selected_prim_paths(["/World/Cube"], True)
# Need to wait for an additional frames for omni.ui rebuild to take effect
await ui_test.human_delay(10)
await self.finalize_test(golden_img_dir=self._golden_img_dir, golden_img_name="test_transform_property_srt.png")
async def test_transform_property_srt_filter(self):
usd_context = omni.usd.get_context()
await self.docked_test_window(
window=self._w._window,
width=450,
height=250,
restore_window = ui.Workspace.get_window("Layer") or ui.Workspace.get_window("Stage"),
restore_position = ui.DockPosition.BOTTOM)
test_file_path = self._usd_path.joinpath("test_transform_property.usda").absolute()
await usd_context.open_stage_async(str(test_file_path))
await wait_stage_loading()
# Select the prim.
usd_context.get_selection().set_selected_prim_paths(["/World/Cube"], True)
try:
self._w._searchfield._search_field.model.as_string = "tr"
self._w._searchfield._set_in_searching(True)
# Need to wait for an additional frames for omni.ui rebuild to take effect
await ui_test.human_delay(10)
await self.finalize_test(golden_img_dir=self._golden_img_dir, golden_img_name="test_transform_property_srt_filter.png")
finally:
self._w._searchfield._search_field.model.as_string = ""
self._w._searchfield._set_in_searching(False)
async def test_transform_property_sqt(self):
usd_context = omni.usd.get_context()
# golden image expects the UI to be switched to "orient as rotate"
settings = carb.settings.get_settings()
doar_path = "/persistent/app/uiSettings/DisplayOrientAsRotate"
doar_val = settings.get_as_bool(doar_path)
settings.set(doar_path, True)
try:
await self.docked_test_window(
window=self._w._window,
width=450,
height=250,
restore_window = ui.Workspace.get_window("Layer") or ui.Workspace.get_window("Stage"),
restore_position = ui.DockPosition.BOTTOM)
test_file_path = self._usd_path.joinpath("test_transform_property.usda").absolute()
await usd_context.open_stage_async(str(test_file_path))
await wait_stage_loading()
# Select the prim.
usd_context.get_selection().set_selected_prim_paths(["/World/Capsule"], True)
# Need to wait for an additional frames for omni.ui rebuild to take effect
await ui_test.human_delay(10)
finally:
carb.settings.get_settings().set(doar_path, doar_val)
await self.finalize_test(golden_img_dir=self._golden_img_dir, golden_img_name="test_transform_property_sqt.png")
async def test_transform_property_sqt2(self):
usd_context = omni.usd.get_context()
# golden image expects the UI to be switched to "orient as rotate"
settings = carb.settings.get_settings()
doar_path = "/persistent/app/uiSettings/DisplayOrientAsRotate"
doar_val = settings.get_as_bool(doar_path)
settings.set(doar_path, True)
try:
await self.docked_test_window(
window=self._w._window,
width=450,
height=250,
restore_window = ui.Workspace.get_window("Layer") or ui.Workspace.get_window("Stage"),
restore_position = ui.DockPosition.BOTTOM,
block_devices=False)
test_file_path = self._usd_path.joinpath("test_transform_property.usda").absolute()
await usd_context.open_stage_async(str(test_file_path))
await wait_stage_loading()
# Select the prim.
usd_context.get_selection().set_selected_prim_paths(["/World/Capsule"], True)
# Need to wait for an additional frames for omni.ui rebuild to take effect
await ui_test.human_delay(10)
#now find a button for orient and click it to swap to test swapping
widget = ui_test.find("Property//Frame/**/CollapsableFrame[*]/**/Button[*].text=='Orient'")
await widget.click(pos=widget.position+ui_test.Vec2(widget.widget.computed_content_width/2, 10))
finally:
await self.capture_and_compare(golden_img_dir=self._golden_img_dir, golden_img_name="test_transform_property_sqt2.png")
# add another test to click it back
widget = ui_test.find("Property//Frame/**/CollapsableFrame[*]/**/Button[*].text=='Orient'")
await widget.click(pos=widget.position+ui_test.Vec2(widget.widget.computed_content_width/2, 10))
await self.finalize_test(golden_img_dir=self._golden_img_dir, golden_img_name="test_transform_property_sqt3.png")
carb.settings.get_settings().set(doar_path, doar_val)
async def test_transform_property_matrix(self):
usd_context = omni.usd.get_context()
await self.docked_test_window(
window=self._w._window,
width=450,
height=250,
restore_window = ui.Workspace.get_window("Layer") or ui.Workspace.get_window("Stage"),
restore_position = ui.DockPosition.BOTTOM)
test_file_path = self._usd_path.joinpath("test_transform_property.usda").absolute()
await usd_context.open_stage_async(str(test_file_path))
await wait_stage_loading()
# Select the prim.
usd_context.get_selection().set_selected_prim_paths(["/World/Cylinder"], True)
# Need to wait for an additional frames for omni.ui rebuild to take effect
await ui_test.human_delay(10)
await self.finalize_test(golden_img_dir=self._golden_img_dir, golden_img_name="test_transform_property_matrix.png")
async def test_transform_property_pivot(self):
usd_context = omni.usd.get_context()
await self.docked_test_window(
window=self._w._window,
width=450,
height=280,
restore_window = ui.Workspace.get_window("Layer") or ui.Workspace.get_window("Stage"),
restore_position = ui.DockPosition.BOTTOM)
test_file_path = self._usd_path.joinpath("test_transform_property.usda").absolute()
await usd_context.open_stage_async(str(test_file_path))
await wait_stage_loading()
# Select the prim.
usd_context.get_selection().set_selected_prim_paths(["/World/Cone"], True)
# Need to wait for an additional frames for omni.ui rebuild to take effect
await ui_test.human_delay(10)
await self.finalize_test(golden_img_dir=self._golden_img_dir, golden_img_name="test_transform_property_pivot.png")
async def test_transform_property_disabled_translate_op(self):
usd_context = omni.usd.get_context()
await self.docked_test_window(
window=self._w._window,
width=450,
height=260,
restore_window = ui.Workspace.get_window("Layer") or ui.Workspace.get_window("Stage"),
restore_position = ui.DockPosition.BOTTOM)
test_file_path = self._usd_path.joinpath("test_transform_property.usda").absolute()
await usd_context.open_stage_async(str(test_file_path))
await wait_stage_loading()
# Select the prim.
usd_context.get_selection().set_selected_prim_paths(["/World/Sphere"], True)
# Need to wait for an additional frames for omni.ui rebuild to take effect
await ui_test.human_delay(10)
await self.finalize_test(golden_img_dir=self._golden_img_dir, golden_img_name="test_transform_property_disabled_translate_op.png")
async def test_transform_property_euler_to_quat_sync(self):
usd_context = omni.usd.get_context()
usd_context.new_stage()
settings = carb.settings.get_settings()
doar_path = "/persistent/app/uiSettings/DisplayOrientAsRotate"
doar_val = settings.get_as_bool(doar_path)
carb.settings.get_settings().set(doar_path, True)
try:
await self.docked_test_window(
window=self._w._window,
width=640,
height=480,
restore_window = ui.Workspace.get_window("Layer") or ui.Workspace.get_window("Stage"),
restore_position = ui.DockPosition.BOTTOM)
# we actually want mouse and keyboard to be active
omni.appwindow.get_default_app_window().set_input_blocking_state(carb.input.DeviceType.MOUSE, False)
omni.appwindow.get_default_app_window().set_input_blocking_state(carb.input.DeviceType.KEYBOARD, False)
await ui_test.wait_n_updates(10)
path = "/Cube"
cube_geom = UsdGeom.Cube.Define(usd_context.get_stage(), path)
cube_geom.AddOrientOp().Set(Gf.Quatf(1.0))
usd_context.get_selection().set_selected_prim_paths([path], False)
await ui_test.find("Property").focus()
transform_euler = ui_test.find("Property//Frame/**/*.identifier=='euler_xformOp:orient'")
# change Y axis to 180 digit by digit as a user would do
await transform_euler.double_click(human_delay_speed=10)
for s in "180":
await ui_test.emulate_char_press(s)
await ui_test.wait_n_updates(10)
await ui_test.emulate_keyboard_press(carb.input.KeyboardInput.ENTER)
finally:
await self.finalize_test_no_image()
carb.settings.get_settings().set(doar_path, doar_val)
orient = Gf.Quatf(1.0)
for op in cube_geom.GetOrderedXformOps():
if op.GetOpType() == UsdGeom.XformOp.TypeOrient:
orient = op.Get()
self.assertTrue(orient.imaginary[1] != 0)
async def test_transform_property_multi(self):
usd_context = omni.usd.get_context()
# golden image expects the UI to be switched to "orient as rotate"
try:
await self.docked_test_window(
window=self._w._window,
width=450,
height=250,
restore_window = ui.Workspace.get_window("Layer") or ui.Workspace.get_window("Stage"),
restore_position = ui.DockPosition.BOTTOM)
test_file_path = self._usd_path.joinpath("test_transform_property.usda").absolute()
await usd_context.open_stage_async(str(test_file_path))
await wait_stage_loading()
# Select the prim.
usd_context.get_selection().set_selected_prim_paths(["/World/Capsule", "/World/Cube", "/World/Cylinder"], True)
# Need to wait for an additional frames for omni.ui rebuild to take effect
await ui_test.human_delay(10)
finally:
await self.capture_and_compare(golden_img_dir=self._golden_img_dir, golden_img_name="test_transform_property_multi.png")
# Select the prim.
usd_context.get_selection().set_selected_prim_paths(["/World/Capsule", "/World/Cube"], True)
# Need to wait for an additional frames for omni.ui rebuild to take effect
await ui_test.human_delay(10)
#text of mixed is moving and it's causing very unstable result for testing, so increasing threshold to be 2.
await self.finalize_test(golden_img_dir=self._golden_img_dir, golden_img_name="test_transform_property_multi2.png", threshold=2)
async def test_transform_scale(self):
usd_context = omni.usd.get_context()
test_file_path = self._usd_path.joinpath("test_transform_property.usda").absolute()
await usd_context.open_stage_async(str(test_file_path))
await omni.kit.app.get_app().next_update_async()
stage = usd_context.get_stage()
# Select the prim.
usd_context.get_selection().set_selected_prim_paths(["/World/Cube"], True)
prim = stage.GetPrimAtPath("/World/Cube")
# Let UI build
# (Note: I'm not sure why we need to wait more than a few frames, but empirically
# this seems to be the case. So just wait 20 frames to make sure UI is there.)
await ui_test.wait_n_updates(20)
# Now we're in offset mode.
stack = ui_test.find("Property//Frame/**/HStack[*].identifier=='scale_t_stack'")
self.assertIsNotNone(stack)
# Here's a funny thing -- the double-click clicks the center of the ui element by default.
# That amounts to setting offsets in Y.
# Rather than work around that, we're just going to use the Y component for our offset.
# XXX for some reason, using field.input doesn't give the desired results here --
# the field's text isn't selected after double-clicking, so we end up entering
# "0.0100" instead of "100".
# As a workaround, we'll just break input down into its components (double-click, enter characters,
# hit enter), with the addition of three backspaces to clear the field's default "0.0"
await stack.click()
await stack.double_click()
await ui_test.human_delay(10)
for _ in range(3):
await ui_test.emulate_keyboard_press(KeyboardInput.BACKSPACE)
await ui_test.emulate_char_press("2")
await ui_test.emulate_keyboard_press(KeyboardInput.ENTER)
transform = omni.usd.get_world_transform_matrix(prim)
self.assertTrue(equal_scale_eps(transform, Gf.Vec3d(1.0, 2.0, 1.0)))
# Apply another offset, then check the prim's translation
await stack.double_click()
await ui_test.human_delay(10)
for _ in range(3):
await ui_test.emulate_keyboard_press(KeyboardInput.BACKSPACE)
await ui_test.emulate_char_press("*2")
await ui_test.emulate_keyboard_press(KeyboardInput.ENTER)
transform = omni.usd.get_world_transform_matrix(prim)
self.assertTrue(equal_scale_eps(transform, Gf.Vec3d(1.0, 4.0, 1.0)))
# Click and drag field, the check the prim's translation
drag_vector = stack.center
drag_vector.x = drag_vector.x + 30
await ui_test.human_delay(30)
await ui_test.emulate_mouse_drag_and_drop(stack.center, drag_vector)
await ui_test.wait_n_updates(2)
transform = omni.usd.get_world_transform_matrix(prim)
self.assertTrue(equal_scale_eps(transform, Gf.Vec3d(1.0, 7.0, 1.0)))
await self.finalize_test_no_image()
await ui_test.wait_n_updates(20)
async def test_transform_toggle_scale(self):
usd_context = omni.usd.get_context()
test_file_path = self._usd_path.joinpath("test_transform_property.usda").absolute()
await usd_context.open_stage_async(str(test_file_path))
await omni.kit.app.get_app().next_update_async()
stage = usd_context.get_stage()
# Select the prim.
usd_context.get_selection().set_selected_prim_paths(["/World/Cube"], True)
prim = stage.GetPrimAtPath("/World/Cube")
# Let UI build
# (Note: I'm not sure why we need to wait more than a few frames, but empirically
# this seems to be the case. So just wait 20 frames to make sure UI is there.)
await ui_test.wait_n_updates(20)
button = ui_test.find("Property//Frame/**/CollapsableFrame[*]/**/Button[*].identifier=='toggle_link_scale'")
# We should be able to find the mode toggle button,
# but until we're in offset mode we should not have any offset fields
self.assertIsNotNone(button)
#enable toggle mode
await button.click(pos=button.position+ui_test.Vec2(button.widget.computed_content_width/2, 5))
await ui_test.wait_n_updates(20)
# Now we're in offset mode.
stack = ui_test.find("Property//Frame/**/HStack[*].identifier=='scale_t_stack'")
self.assertIsNotNone(stack)
# Here's a funny thing -- the double-click clicks the center of the ui element by default.
# That amounts to setting offsets in Y.
# Rather than work around that, we're just going to use the Y component for our offset.
# XXX for some reason, using field.input doesn't give the desired results here --
# the field's text isn't selected after double-clicking, so we end up entering
# "0.0100" instead of "100".
# As a workaround, we'll just break input down into its components (double-click, enter characters,
# hit enter), with the addition of three backspaces to clear the field's default "0.0"
await stack.click()
await stack.double_click()
await ui_test.human_delay(10)
for _ in range(3):
await ui_test.emulate_keyboard_press(KeyboardInput.BACKSPACE)
await ui_test.emulate_char_press("2")
await ui_test.emulate_keyboard_press(KeyboardInput.ENTER)
transform = omni.usd.get_world_transform_matrix(prim)
self.assertTrue(equal_scale_eps(transform, Gf.Vec3d(2.0, 2.0, 2.0)))
await self.finalize_test_no_image()
await ui_test.wait_n_updates(20)
async def test_transform_reset_stack(self):
usd_context = omni.usd.get_context()
await self.docked_test_window(
window=self._w._window,
width=450,
height=280,
restore_window = ui.Workspace.get_window("Layer") or ui.Workspace.get_window("Stage"),
restore_position = ui.DockPosition.BOTTOM)
test_file_path = self._usd_path.joinpath("test_transform_property.usda").absolute()
await usd_context.open_stage_async(str(test_file_path))
await omni.kit.app.get_app().next_update_async()
stage = omni.usd.get_context().get_stage()
prim = stage.GetPrimAtPath("/World/Cube")
# Get the XformCommonAPI
xform_api = UsdGeom.XformCommonAPI(prim)
#Set the ResetXformStack. UI should responds accordingly
xform_api.SetResetXformStack(True)
usd_context.get_selection().set_selected_prim_paths(["/World/Cube"], True)
# Need to wait for an additional frames for omni.ui rebuild to take effect
await ui_test.human_delay(10)
await self.finalize_test(golden_img_dir=self._golden_img_dir, golden_img_name="test_transform_property_reset.png")
async def test_transform_rotate_scalar(self):
usd_context = omni.usd.get_context()
test_file_path = self._usd_path.joinpath("test_transform_property.usda").absolute()
await usd_context.open_stage_async(str(test_file_path))
await omni.kit.app.get_app().next_update_async()
stage = usd_context.get_stage()
# Select the prim.
usd_context.get_selection().set_selected_prim_paths(["/World/Cube_2"], True)
prim = stage.GetPrimAtPath("/World/Cube_2")
# Let UI build
# (Note: I'm not sure why we need to wait more than a few frames, but empirically
# this seems to be the case. So just wait 20 frames to make sure UI is there.)
await ui_test.wait_n_updates(20)
# Now we're in offset mode.
x_stack = ui_test.find("Property//Frame/**/HStack[*].identifier=='rotate_scalar_stack_x'")
self.assertIsNotNone(x_stack)
# Here's a funny thing -- the double-click clicks the center of the ui element by default.
# That amounts to setting offsets in Y.
# Rather than work around that, we're just going to use the Y component for our offset.
rotate_attr = prim.GetAttribute("xformOp:rotateX")
self.assertIsNotNone(rotate_attr)
self.assertTrue(rotate_attr.Get() == -30.0)
# XXX for some reason, using field.input doesn't give the desired results here --
# the field's text isn't selected after double-clicking, so we end up entering
# "0.0100" instead of "100".
# As a workaround, we'll just break input down into its components (double-click, enter characters,
# hit enter), with the addition of three backspaces to clear the field's default "0.0"
await x_stack.click()
await x_stack.double_click()
await ui_test.human_delay(10)
for _ in range(5):
await ui_test.emulate_keyboard_press(KeyboardInput.BACKSPACE)
await ui_test.emulate_char_press("20")
await ui_test.emulate_keyboard_press(KeyboardInput.ENTER)
self.assertTrue(rotate_attr.Get() == 20.0)
y_stack = ui_test.find("Property//Frame/**/HStack[*].identifier=='rotate_scalar_stack_y'")
self.assertIsNotNone(y_stack)
# Here's a funny thing -- the double-click clicks the center of the ui element by default.
# That amounts to setting offsets in Y.
# Rather than work around that, we're just going to use the Y component for our offset.
rotate_attr = prim.GetAttribute("xformOp:rotateY")
self.assertIsNotNone(rotate_attr)
self.assertTrue(rotate_attr.Get() == 0.0)
# XXX for some reason, using field.input doesn't give the desired results here --
# the field's text isn't selected after double-clicking, so we end up entering
# "0.0100" instead of "100".
# As a workaround, we'll just break input down into its components (double-click, enter characters,
# hit enter), with the addition of three backspaces to clear the field's default "0.0"
await y_stack.click()
await y_stack.double_click()
await ui_test.human_delay(10)
for _ in range(5):
await ui_test.emulate_keyboard_press(KeyboardInput.BACKSPACE)
await ui_test.emulate_char_press("30")
await ui_test.emulate_keyboard_press(KeyboardInput.ENTER)
self.assertTrue(rotate_attr.Get() == 30.0)
transform = omni.usd.get_world_transform_matrix(prim)
self.assertTrue(equal_eps(transform.ExtractRotation().GetAngle(), 35.92772))
#test transform
await self.finalize_test_no_image()
await ui_test.wait_n_updates(20)
'''
#this test doesn't work because the kit has a way to enter xformOp:translate to trigger
#build widget, where test won't be able to do this. OM-112507
#https://nvidia.slack.com/archives/CURCH7KU2/p1697658671468429?thread_ts=1697204512.040859&cid=CURCH7KU2
async def test_transform_property_wgs84(self):
usd_context = omni.usd.get_context()
await self.docked_test_window(
window=self._w._window,
width=640,
height=480,
restore_window = ui.Workspace.get_window("Layer") or ui.Workspace.get_window("Stage"),
restore_position = ui.DockPosition.BOTTOM)
test_file_path = self._usd_path.joinpath("wgs84/deutschebahn-rails.usda").absolute()
await usd_context.open_stage_async(str(test_file_path))
await wait_stage_loading()
# Select the prim.
usd_context.get_selection().set_selected_prim_paths(["/RootGeoReference/World/CurveXform26Geo"], True)
# Need to wait for an additional frames for omni.ui rebuild to take effect
await ui_test.human_delay(10)
try:
self._w._searchfield._search_field.model.as_string = "tr"
self._w._searchfield._set_in_searching(True)
# Need to wait for an additional frames for omni.ui rebuild to take effect
await ui_test.human_delay(10)
await self.finalize_test(golden_img_dir=self._golden_img_dir, golden_img_name="test_transform_property_wgs84.png")
finally:
self._w._searchfield._search_field.model.as_string = ""
self._w._searchfield._set_in_searching(False)
''' | 26,141 | Python | 43.84048 | 140 | 0.642669 |
omniverse-code/kit/exts/omni.kit.property.transform/omni/kit/property/transform/tests/__init__.py | from .test_transform import *
from .test_offset import *
from .test_transform_context_menu import *
from .test_commands import *
from .test_builder import *
| 157 | Python | 25.333329 | 42 | 0.764331 |
omniverse-code/kit/exts/omni.kit.property.transform/omni/kit/property/transform/tests/test_offset.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.
##
from carb.input import KeyboardInput
import omni.kit.test
import omni.kit.ui_test as ui_test
import omni.ui as ui
import omni.usd
from omni.ui.tests.test_base import OmniUiTest
from pxr import Gf
def equal_eps(a, b, esp = 0.0001):
return abs(a - b) < esp
class TestTransformOffset(OmniUiTest):
async def setUp(self):
await super().setUp()
from omni.kit.property.transform.scripts.transform_properties import TEST_DATA_PATH
self._usd_path = TEST_DATA_PATH.absolute()
from omni.kit.property.usd.usd_attribute_widget import UsdPropertiesWidget
import omni.kit.window.property as p
self._w = p.get_window()
async def tearDown(self):
await super().tearDown()
async def test_offset_mode_rotate(self):
usd_context = omni.usd.get_context()
test_file_path = self._usd_path.joinpath("offset_test.usda").absolute()
await usd_context.open_stage_async(str(test_file_path))
await omni.kit.app.get_app().next_update_async()
stage = usd_context.get_stage()
self.assertIsNotNone(stage)
prim = stage.GetPrimAtPath(f"{stage.GetDefaultPrim().GetPath()}/Cube")
self.assertTrue(prim.IsValid())
# Select the prim.
usd_context.get_selection().set_selected_prim_paths([str(prim.GetPath())], True)
# Let UI build
# (Note: I'm not sure why we need to wait more than a few frames, but empirically
# this seems to be the case. So just wait 20 frames to make sure UI is there.)
await ui_test.wait_n_updates(20)
button = ui_test.find("Property//Frame/**/Button[*].identifier=='offset_mode_toggle'")
# We should be able to find the mode toggle button,
# but until we're in offset mode we should not have any offset fields
self.assertIsNotNone(button)
await button.click()
await ui_test.wait_n_updates(20)
# Now we're in offset mode.
stack = ui_test.find("Property//Frame/**/HStack[*].identifier=='rotate_stack'")
self.assertIsNotNone(stack)
# Here's a funny thing -- the double-click clicks the center of the ui element by default.
# That amounts to setting offsets in Y.
# Rather than work around that, we're just going to use the Y component for our offset.
# XXX for some reason, using field.input doesn't give the desired results here --
# the field's text isn't selected after double-clicking, so we end up entering
# "0.0100" instead of "100".
# As a workaround, we'll just break input down into its components (double-click, enter characters,
# hit enter), with the addition of three backspaces to clear the field's default "0.0"
await stack.click()
await stack.double_click()
await ui_test.human_delay(10)
for _ in range(3):
await ui_test.emulate_keyboard_press(KeyboardInput.BACKSPACE)
await ui_test.emulate_char_press("10")
await ui_test.emulate_keyboard_press(KeyboardInput.ENTER)
transform = omni.usd.get_world_transform_matrix(prim)
self.assertTrue(equal_eps(transform.ExtractRotation().GetAngle(), 10.0))
# Apply another offset, then check the prim's translation
await stack.double_click()
await ui_test.human_delay(10)
for _ in range(3):
await ui_test.emulate_keyboard_press(KeyboardInput.BACKSPACE)
await ui_test.emulate_char_press("*2")
await ui_test.emulate_keyboard_press(KeyboardInput.ENTER)
transform = omni.usd.get_world_transform_matrix(prim)
self.assertTrue(equal_eps(transform.ExtractRotation().GetAngle(), 20.0))
# Click and drag field, the check the prim's translation
drag_vector = stack.center
drag_vector.x = drag_vector.x + 100
await ui_test.human_delay(30)
await ui_test.emulate_mouse_drag_and_drop(stack.center, drag_vector)
await ui_test.wait_n_updates(2)
transform = omni.usd.get_world_transform_matrix(prim)
self.assertTrue(equal_eps(transform.ExtractRotation().GetAngle(), 21.0))
await self.finalize_test_no_image()
# Finally, toggle offset mode again so subsequent tests will not start in offset mode
await button.click()
await ui_test.wait_n_updates(20)
async def test_offset_mode_translate(self):
usd_context = omni.usd.get_context()
test_file_path = self._usd_path.joinpath("offset_test.usda").absolute()
await usd_context.open_stage_async(str(test_file_path))
await omni.kit.app.get_app().next_update_async()
stage = usd_context.get_stage()
self.assertIsNotNone(stage)
prim = stage.GetPrimAtPath(f"{stage.GetDefaultPrim().GetPath()}/Cube")
self.assertTrue(prim.IsValid())
# Select the prim.
usd_context.get_selection().set_selected_prim_paths([str(prim.GetPath())], True)
# Let UI build
# (Note: I'm not sure why we need to wait more than a few frames, but empirically
# this seems to be the case. So just wait 20 frames to make sure UI is there.)
await ui_test.wait_n_updates(20)
button = ui_test.find("Property//Frame/**/Button[*].identifier=='offset_mode_toggle'")
stack = ui_test.find("Property//Frame/**/HStack[*].identifier=='translate_stack'")
# We should be able to find the mode toggle button,
# but until we're in offset mode we should not have any offset fields
self.assertIsNotNone(button)
self.assertIsNone(stack)
await button.click()
await ui_test.wait_n_updates(20)
# Now we're in offset mode.
stack = ui_test.find("Property//Frame/**/HStack[*].identifier=='translate_stack'")
self.assertIsNotNone(stack)
# Here's a funny thing -- the double-click clicks the center of the ui element by default.
# That amounts to setting offsets in Y.
# Rather than work around that, we're just going to use the Y component for our offset.
# XXX for some reason, using field.input doesn't give the desired results here --
# the field's text isn't selected after double-clicking, so we end up entering
# "0.0100" instead of "100".
# As a workaround, we'll just break input down into its components (double-click, enter characters,
# hit enter), with the addition of three backspaces to clear the field's default "0.0"
await stack.click()
await stack.double_click()
await ui_test.human_delay(10)
for _ in range(3):
await ui_test.emulate_keyboard_press(KeyboardInput.BACKSPACE)
await ui_test.emulate_char_press("100")
await ui_test.emulate_keyboard_press(KeyboardInput.ENTER)
transform = omni.usd.get_world_transform_matrix(prim)
self.assertTrue(transform.ExtractTranslation() == Gf.Vec3d(0.0, 100.0, 0.0))
# Apply another offset, then check the prim's translation
await stack.double_click()
await ui_test.human_delay(10)
for _ in range(3):
await ui_test.emulate_keyboard_press(KeyboardInput.BACKSPACE)
await ui_test.emulate_char_press("*2")
await ui_test.emulate_keyboard_press(KeyboardInput.ENTER)
transform = omni.usd.get_world_transform_matrix(prim)
self.assertTrue(transform.ExtractTranslation() == Gf.Vec3d(0.0, 200.0, 0.0))
# Click and drag field, the check the prim's translation
drag_vector = stack.center
drag_vector.x = drag_vector.x + 100
await ui_test.human_delay(30)
await ui_test.emulate_mouse_drag_and_drop(stack.center, drag_vector)
await ui_test.wait_n_updates(2)
transform = omni.usd.get_world_transform_matrix(prim)
self.assertTrue(transform.ExtractTranslation() == Gf.Vec3d(0.0, 201.0, 0.0))
await self.finalize_test_no_image()
# Finally, toggle offset mode again so subsequent tests will not start in offset mode
await button.click()
await ui_test.wait_n_updates(20)
async def test_offset_mode_scale(self):
usd_context = omni.usd.get_context()
test_file_path = self._usd_path.joinpath("offset_test.usda").absolute()
await usd_context.open_stage_async(str(test_file_path))
await omni.kit.app.get_app().next_update_async()
stage = usd_context.get_stage()
self.assertIsNotNone(stage)
prim = stage.GetPrimAtPath(f"{stage.GetDefaultPrim().GetPath()}/Cube")
self.assertTrue(prim.IsValid())
# Select the prim.
usd_context.get_selection().set_selected_prim_paths([str(prim.GetPath())], True)
# Let UI build
# (Note: I'm not sure why we need to wait more than a few frames, but empirically
# this seems to be the case. So just wait 20 frames to make sure UI is there.)
await ui_test.wait_n_updates(20)
button = ui_test.find("Property//Frame/**/Button[*].identifier=='offset_mode_toggle'")
# We should be able to find the mode toggle button,
# but until we're in offset mode we should not have any offset fields
self.assertIsNotNone(button)
await button.click()
await ui_test.wait_n_updates(20)
# Now we're in offset mode.
stack = ui_test.find("Property//Frame/**/HStack[*].identifier=='scale_stack'")
self.assertIsNotNone(stack)
# Here's a funny thing -- the double-click clicks the center of the ui element by default.
# That amounts to setting offsets in Y.
# Rather than work around that, we're just going to use the Y component for our offset.
# XXX for some reason, using field.input doesn't give the desired results here --
# the field's text isn't selected after double-clicking, so we end up entering
# "0.0100" instead of "100".
# As a workaround, we'll just break input down into its components (double-click, enter characters,
# hit enter), with the addition of three backspaces to clear the field's default "0.0"
await stack.click()
await stack.double_click()
await ui_test.human_delay(10)
for _ in range(3):
await ui_test.emulate_keyboard_press(KeyboardInput.BACKSPACE)
await ui_test.emulate_char_press("2")
await ui_test.emulate_keyboard_press(KeyboardInput.ENTER)
def equal_scale_eps(t, s):
m = Gf.Vec3d(0.0)
m[0] = t.GetRow(0).GetLength()
m[1] = t.GetRow(1).GetLength()
m[2] = t.GetRow(2).GetLength()
#print (m)
return equal_eps(m[0], s[0]) and equal_eps(m[1], s[1]) and equal_eps(m[2], s[2])
transform = omni.usd.get_world_transform_matrix(prim)
self.assertTrue(equal_scale_eps(transform, Gf.Vec3d(1.0, 3.0, 1.0)))
# Apply another offset, then check the prim's translation
await stack.double_click()
await ui_test.human_delay(10)
for _ in range(3):
await ui_test.emulate_keyboard_press(KeyboardInput.BACKSPACE)
await ui_test.emulate_char_press("*2")
await ui_test.emulate_keyboard_press(KeyboardInput.ENTER)
transform = omni.usd.get_world_transform_matrix(prim)
self.assertTrue(equal_scale_eps(transform, Gf.Vec3d(1.0, 6.0, 1.0)))
# Click and drag field, the check the prim's translation
drag_vector = stack.center
drag_vector.x = drag_vector.x + 100
await ui_test.human_delay(30)
await ui_test.emulate_mouse_drag_and_drop(stack.center, drag_vector)
await ui_test.wait_n_updates(2)
transform = omni.usd.get_world_transform_matrix(prim)
self.assertTrue(equal_scale_eps(transform, Gf.Vec3d(1.0, 7.0, 1.0)))
await self.finalize_test_no_image()
# Finally, toggle offset mode again so subsequent tests will not start in offset mode
await button.click()
await ui_test.wait_n_updates(20)
| 12,486 | Python | 41.763698 | 107 | 0.653692 |
omniverse-code/kit/exts/omni.kit.property.transform/omni/kit/property/transform/tests/test_commands.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 weakref
import omni.kit.app
import omni.kit.commands
import omni.kit.test
from omni.kit import ui_test
from omni.kit.test_suite.helpers import wait_stage_loading
from omni.ui.tests.test_base import OmniUiTest
from pathlib import Path
from pxr import UsdGeom, Sdf, Gf
from omni.kit.property.usd.prim_selection_payload import PrimSelectionPayload
from ..scripts.xform_op_utils import get_op_type_name, _add_trs_op, get_op_name_suffix, get_op_precision, get_inverse_op_Name, RESET_XFORM_STACK, get_op_attr_name
import carb
import carb.settings
class TestTransformCommands(OmniUiTest):
xform_op_names = ["xformOp:translate", "xformOp:rotateXYZ", "xformOp:orient", "xformOp:scale", "xformOp:translate:pivot", "xformOp:transform"]
prim_paths =["/World/Capsule", "/World/Cube", "/World/Cylinder", "/World/Cone"]
# Before running each test
async def setUp(self):
await super().setUp()
extension_root_folder = Path(omni.kit.app.get_app().get_extension_manager().get_extension_path_by_module(__name__))
self._usd_path = extension_root_folder.joinpath("data/test_data/test_map")
# After running each test
async def tearDown(self):
await super().tearDown()
def include_op_code(self, xform : UsdGeom.Xformable, op_name):
return self.get_index_op_code(xform, op_name) != -1
def get_index_op_code(self, xform : UsdGeom.Xformable, op_name):
xform_ops = xform.GetOrderedXformOps()
for i, op in enumerate(xform_ops):
if op.GetOpName() == op_name:
return i
return -1
async def add_xform_ops_test(self, stage, prim_path, precision, undo_after=True):
prim = stage.GetObjectAtPath(prim_path)
xform = UsdGeom.Xformable(prim)
usd_context = omni.usd.get_context()
usd_context.get_selection().set_selected_prim_paths([prim_path], True)
await ui_test.human_delay(3)
ops_exists = []
attr_exists = []
for op_name in self.xform_op_names:
ops_exists.append(self.include_op_code(xform, op_name))
attr_exists.append(stage.GetObjectAtPath(prim_path + "." + op_name) != None)
payload = PrimSelectionPayload( weakref.ref(stage), [prim.GetPath()])
omni.kit.commands.execute('AddXformOp',
payload=payload,
precision=precision,
rotation_order='XYZ',
add_translate_op=True,
add_rotateXYZ_op=True,
add_orient_op=True,
add_scale_op=True,
add_transform_op=True,
add_pivot_op=True)
await ui_test.human_delay(3)
xform_ops = xform.GetOrderedXformOps()
for op_name in self.xform_op_names:
#make sure rotation order XYZ ops_exists
self.assertTrue(self.include_op_code(xform, op_name))
attr = stage.GetObjectAtPath(prim_path + "." + op_name)
self.assertTrue(attr)
if undo_after:
#undo
omni.kit.commands.execute("Undo")
await ui_test.human_delay(3)
for i, op_name in enumerate(self.xform_op_names):
if not ops_exists[i]:
self.assertTrue(not self.include_op_code(xform, op_name))
async def remove_xform_ops_test(self, stage, prim_path):
prim = stage.GetObjectAtPath(prim_path)
xform = UsdGeom.Xformable(prim)
usd_context = omni.usd.get_context()
usd_context.get_selection().set_selected_prim_paths([prim_path], True)
await ui_test.human_delay(3)
for op_name in self.xform_op_names:
index = self.get_index_op_code(xform, op_name)
omni.kit.commands.execute('RemoveXformOpAndAttrbute',
op_order_attr_path=Sdf.Path(prim_path + '.xformOpOrder'),
op_name=op_name,
op_order_index=index)
await ui_test.human_delay(3)
self.assertTrue(not self.include_op_code(xform, op_name))
for op_name in self.xform_op_names:
omni.kit.commands.execute("Undo")
for op_name in self.xform_op_names:
self.assertTrue(self.include_op_code(xform, op_name))
async def test_transform_add_remove_commands(self):
usd_context = omni.usd.get_context()
test_file_path = self._usd_path.joinpath("test_transform_property.usda").absolute()
await usd_context.open_stage_async(str(test_file_path))
await wait_stage_loading()
#get prim for sphere
stage = usd_context.get_stage()
precision_types = [UsdGeom.XformOp.PrecisionDouble, UsdGeom.XformOp.PrecisionFloat, UsdGeom.XformOp.PrecisionHalf]
for prim_path in self.prim_paths:
for precision in precision_types:
await self.add_xform_ops_test(stage, prim_path, precision)
for prim_path in self.prim_paths:
for precision in precision_types:
await self.add_xform_ops_test(stage, prim_path, precision, False)
await self.remove_xform_ops_test(stage, prim_path)
async def test_transform_add_remove_xformops_commands(self):
usd_context = omni.usd.get_context()
test_file_path = self._usd_path.joinpath("test_transform_property.usda").absolute()
await usd_context.open_stage_async(str(test_file_path))
await wait_stage_loading()
#get prim for sphere
stage = usd_context.get_stage()
#ops_exists = []
#for op_name in self.xform_op_names:
# ops_exists.append(self.include_op_code(xform, op_name))
usd_context.get_selection().set_selected_prim_paths(["/World/Sphere"], True)
await ui_test.human_delay(3)
await self.add_xform_ops_test(stage, "/World/Sphere", UsdGeom.XformOp.PrecisionDouble, False)
prim = stage.GetObjectAtPath("/World/Sphere")
xform = UsdGeom.Xformable(prim)
#disable all properties
for op in self.xform_op_names:
index = self.get_index_op_code(xform, op)
omni.kit.commands.execute("RemoveXformOpCommand", op_order_attr_path="/World/Sphere.xformOpOrder", op_name=op, op_order_index=index)
await ui_test.human_delay(3)
self.assertTrue(not self.include_op_code(xform, op))
#enable all properties
for op in self.xform_op_names:
omni.kit.commands.execute("EnableXformOpCommand", op_attr_path="/World/Sphere." + op)
await ui_test.human_delay(3)
self.assertTrue(self.include_op_code(xform, op))
#undo
omni.kit.commands.execute("Undo")
await ui_test.human_delay(3)
self.assertTrue(not self.include_op_code(xform, op))
#disable all properties
for op in self.xform_op_names:
omni.kit.commands.execute("EnableXformOpCommand", op_attr_path="/World/Sphere." + op)
await ui_test.human_delay(3)
self.assertTrue(self.include_op_code(xform, op))
index = self.get_index_op_code(xform, op)
omni.kit.commands.execute("RemoveXformOpCommand", op_order_attr_path="/World/Sphere.xformOpOrder", op_name=op, op_order_index=index)
await ui_test.human_delay(3)
self.assertTrue(not self.include_op_code(xform, op))
#undo
omni.kit.commands.execute("Undo")
await ui_test.human_delay(3)
self.assertTrue(self.include_op_code(xform, op))
async def test_chate_rotation_ops(self):
usd_context = omni.usd.get_context()
test_file_path = self._usd_path.joinpath("test_transform_property.usda").absolute()
await usd_context.open_stage_async(str(test_file_path))
await wait_stage_loading()
#get prim for sphere
stage = usd_context.get_stage()
usd_context.get_selection().set_selected_prim_paths(["/World/Cube"], True)
await ui_test.human_delay(3)
command_rotation_ops = ["rotateX", "rotateY", "rotateZ", "rotateXYZ", "rotateXZY", "rotateYXZ", "rotateYZX", "rotateZXY", "rotateZYX", "rotateXYZ"]
rotation_ops = ["rotateXZY", "rotateYXZ", "rotateYZX", "rotateZXY", "rotateZYX", "rotateXYZ"]
#FIXME: if you fix rotateX, rotateY, rotateZ UI issue, uncomment below
#rotation_ops = ["rotateX", "rotateY", "rotateZ", "rotateXYZ", "rotateXZY", "rotateYXZ", "rotateYZX", "rotateZXY", "rotateZYX", "rotateXYZ"]
sphere_prim = stage.GetObjectAtPath("/World/Sphere")
sphere_xform = UsdGeom.Xformable(sphere_prim)
current = "rotateXYZ"
for rotation_op in command_rotation_ops:
omni.kit.commands.execute('ChangeRotationOp',
src_op_attr_path=Sdf.Path('/World/Sphere.xformOp:'+current),
op_name='xformOp:' + current,
dst_op_attr_name='xformOp:' + rotation_op,
is_inverse_op=False,
auto_target_layer=True)
self.assertTrue(self.include_op_code(sphere_xform, "xformOp:" + rotation_op))
self.assertTrue(not self.include_op_code(sphere_xform, "xformOp:" + current))
current = rotation_op
#change rotation ops
cube_prim = stage.GetObjectAtPath("/World/Cube")
cube_xform = UsdGeom.Xformable(cube_prim)
current = "rotateXYZ"
for rotation_op in rotation_ops:
omni.kit.commands.execute('ChangeRotationOp',
src_op_attr_path=Sdf.Path('/World/Cube.xformOp:'+current),
op_name='xformOp:' + current,
dst_op_attr_name='xformOp:' + rotation_op,
is_inverse_op=False,
auto_target_layer=True)
await ui_test.human_delay(3)
self.assertTrue(self.include_op_code(cube_xform, "xformOp:" + rotation_op))
self.assertTrue(not self.include_op_code(cube_xform, "xformOp:" + current))
current = rotation_op
#first set current value first
test_value = Gf.Vec3d(30, 60, 90)
attr_name ='xformOp:' + current
attr = cube_prim.GetAttribute(attr_name)
attr.Set(test_value)
for rotation_op in rotation_ops:
#create dest attribute first
#and set it
dest_attr_name = 'xformOp:' + rotation_op
cube_prim.CreateAttribute(dest_attr_name, Sdf.ValueTypeNames.Double3,False).Set(Gf.Vec3d(0, 0, 180))
omni.kit.commands.execute('ChangeRotationOp',
src_op_attr_path=Sdf.Path('/World/Cube.xformOp:'+current),
op_name='xformOp:' + current,
dst_op_attr_name='xformOp:' + rotation_op,
is_inverse_op=False,
auto_target_layer=True)
dest_attr = cube_prim.GetAttribute(dest_attr_name)
# confirm the value is transferred
diff = test_value - dest_attr.Get()
self.assertTrue(diff.GetLength() < 0.1)
# set new test value
dest_attr.Set(test_value)
current = rotation_op
async def test_invalid_commands(self):
usd_context = omni.usd.get_context()
test_file_path = self._usd_path.joinpath("test_transform_property.usda").absolute()
await usd_context.open_stage_async(str(test_file_path))
await wait_stage_loading()
#get prim for sphere
stage = usd_context.get_stage()
usd_context.get_selection().set_selected_prim_paths(["/World/Cube"], True)
await ui_test.human_delay(3)
#rotation_ops = ["rotateX", "rotateY", "rotateZ", "rotateXYZ", "rotateXZY", "rotateYXZ", "rotateYZX", "rotateZXY", "rotateZYX"]
rotation_ops = ["rotateXZY", "rotateYXZ", "rotateYZX", "rotateZXY", "rotateZYX", "rotateXYZ"]
#change rotation ops
cube_prim = stage.GetObjectAtPath("/World/Cube")
cube_xform = UsdGeom.Xformable(cube_prim)
current = "rotateXYZ"
#now test failing cases below
for rotation_op in rotation_ops:
omni.kit.commands.execute('ChangeRotationOp',
src_op_attr_path=Sdf.Path('/World/Cube.xformOp:'+current),
op_name='xformOp:' + current,
dst_op_attr_name='xformOp:' + rotation_op,
is_inverse_op=True,
auto_target_layer=False)
omni.kit.commands.execute('ChangeRotationOp',
src_op_attr_path=Sdf.Path('/World/Cube.xformOp:rotateXYZ'),
op_name='xformOp:rotateXYZ',
dst_op_attr_name='/World/Cube.xformOp:rotateZYX',
is_inverse_op=False,
auto_target_layer=True)
omni.kit.commands.execute('ChangeRotationOp',
src_op_attr_path=Sdf.Path('/World/Cube.xformOp:rotateZYX'),
op_name='xformOp:rotateZYX',
dst_op_attr_name='xformOp:rotateXYZ',
is_inverse_op=True,
auto_target_layer=True)
omni.kit.commands.execute("EnableXformOpCommand", op_attr_path="/World/Sphere.testAttribute")
omni.kit.commands.execute('ChangeRotationOp',
src_op_attr_path=Sdf.Path('/World/testAttribute.xformOp:rotateZYX'),
op_name='xformOp:rotateG',
dst_op_attr_name='xformOp:rotateL',
is_inverse_op=False,
auto_target_layer=False)
payload = PrimSelectionPayload( weakref.ref(stage), [Sdf.Path("/World/Sphere")])
omni.kit.commands.execute('AddXformOp',
payload=payload,
precision=UsdGeom.XformOp.TypeInvalid,
rotation_order='XYZ',
add_translate_op=True,
add_rotateXYZ_op=True,
add_orient_op=True,
add_scale_op=True,
add_transform_op=True,
add_pivot_op=True)
async def test_xform_op_utils(self):
usd_context = omni.usd.get_context()
test_file_path = self._usd_path.joinpath("test_transform_property.usda").absolute()
await usd_context.open_stage_async(str(test_file_path))
await wait_stage_loading()
#get prim for sphere
stage = usd_context.get_stage()
usd_context.get_selection().set_selected_prim_paths(["/World/Sphere"], True)
await ui_test.human_delay(3)
self.assertTrue(get_op_type_name("Dummy") == None)
# test _add_trs_op
payload = PrimSelectionPayload( weakref.ref(stage), [Sdf.Path("/World/Sphere")])
settings = carb.settings.get_settings()
default_xform_op_precision = settings.get("/persistent/app/primCreation/DefaultXformOpPrecision")
default_rotation_order = settings.get("/persistent/app/primCreation/DefaultRotationOrder")
# set to double
settings.set("/persistent/app/primCreation/DefaultXformOpPrecision", "Double")
_add_trs_op(payload)
omni.kit.commands.execute('Undo')
settings.set("/persistent/app/primCreation/DefaultXformOpPrecision", "Float")
_add_trs_op(payload)
omni.kit.commands.execute('Undo')
settings.set("/persistent/app/primCreation/DefaultXformOpPrecision", "Half")
_add_trs_op(payload)
omni.kit.commands.execute('Undo')
#fail test
settings.destroy_item("/persistent/app/primCreation/DefaultXformOpPrecision")
settings.destroy_item("/persistent/app/primCreation/DefaultRotationOrder")
_add_trs_op(payload)
omni.kit.commands.execute('Undo')
#recover default
settings.set("/persistent/app/primCreation/DefaultXformOpPrecision", default_xform_op_precision)
settings.set("/persistent/app/primCreation/DefaultRotationOrder", default_rotation_order)
#get_op_precision
self.assertTrue(get_op_precision(Sdf.ValueTypeNames.Quatf) == UsdGeom.XformOp.PrecisionFloat)
self.assertTrue(get_op_precision(Sdf.ValueTypeNames.Matrix4d) == UsdGeom.XformOp.PrecisionDouble)
self.assertTrue(get_op_precision(Sdf.ValueTypeNames.Half3) == UsdGeom.XformOp.PrecisionHalf)
self.assertTrue(get_op_precision(Sdf.ValueTypeNames.Color3d) == UsdGeom.XformOp.PrecisionDouble)
self.assertTrue(get_inverse_op_Name(RESET_XFORM_STACK, True) == RESET_XFORM_STACK)
self.assertTrue(get_inverse_op_Name("Dummy", True) == "!invert!Dummy")
self.assertTrue(get_inverse_op_Name("!invert!xformOp:Dummy", False) == "xformOp:Dummy")
self.assertTrue(get_op_attr_name(RESET_XFORM_STACK) == None) | 16,863 | Python | 41.910941 | 162 | 0.631264 |
omniverse-code/kit/exts/omni.kit.property.transform/omni/kit/property/transform/tests/test_transform_context_menu.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.
##
import omni.kit.test
import os
import sys
import unittest
import omni.kit.app
from omni.kit.test.async_unittest import AsyncTestCase
import omni.usd
from pathlib import Path
from omni.kit import ui_test
from pxr import Gf, UsdGeom
from omni.kit.test_suite.helpers import (
open_stage,
get_test_data_path,
select_prims,
wait_stage_loading,
arrange_windows
)
def include_op_code(xform : UsdGeom.Xformable, op_name):
xform_ops = xform.GetOrderedXformOps()
for op in xform_ops:
print(op.GetOpName())
if op.GetOpName() == op_name:
return True
return False
class TransformContextMenu(AsyncTestCase):
# Before running each test
async def setUp(self):
await arrange_windows("Stage", 64)
extension_root_folder = Path(omni.kit.app.get_app().get_extension_manager().get_extension_path_by_module(__name__))
self._usd_path = extension_root_folder.joinpath("data/test_data/test_map")
# After running each test
async def tearDown(self):
await wait_stage_loading()
@unittest.skipIf(sys.platform.startswith("linux"), "Pyperclip fails on some TeamCity agents")
async def test_transform_context_menu(self):
await open_stage(get_test_data_path(__name__, "usd/bound_shapes.usda"))
await wait_stage_loading()
usd_context = omni.usd.get_context()
stage = usd_context.get_stage()
# get prim attributes
torus_translate = stage.GetPrimAtPath("/World/Torus").GetAttribute('xformOp:translate')
cone_translate = stage.GetPrimAtPath("/World/Cone").GetAttribute('xformOp:translate')
torus_rotate = stage.GetPrimAtPath("/World/Torus").GetAttribute('xformOp:rotateXYZ')
cone_rotate = stage.GetPrimAtPath("/World/Cone").GetAttribute('xformOp:rotateXYZ')
torus_scale = stage.GetPrimAtPath("/World/Torus").GetAttribute('xformOp:scale')
cone_scale = stage.GetPrimAtPath("/World/Cone").GetAttribute('xformOp:scale')
# verify transforms different
self.assertNotEqual(torus_translate.Get(), cone_translate.Get())
self.assertNotEqual(torus_rotate.Get(), cone_rotate.Get())
self.assertNotEqual(torus_scale.Get(), cone_scale.Get())
# select torus
await select_prims(["/World/Torus"])
await ui_test.human_delay()
# right click on transform header
widget = ui_test.find("Property//Frame/**/CollapsableFrame[*].title=='Transform'")
await widget.click(pos=widget.position+ui_test.Vec2(widget.widget.computed_content_width/2, 10), right_click=True)
# context menu copy
await ui_test.select_context_menu("Copy All Property Values in Transform", offset=ui_test.Vec2(10, 10))
# select cone
await select_prims(["/World/Cone"])
await ui_test.human_delay()
# right click on Transform header
widget = ui_test.find("Property//Frame/**/CollapsableFrame[*].title=='Transform'")
await widget.click(pos=widget.position+ui_test.Vec2(widget.widget.computed_content_width/2, 10), right_click=True)
# context menu paste
await ui_test.select_context_menu("Paste All Property Values to Transform", offset=ui_test.Vec2(10, 10))
# verify transforms same
self.assertEqual(torus_translate.Get(), cone_translate.Get())
self.assertEqual(torus_rotate.Get(), cone_rotate.Get())
self.assertEqual(torus_scale.Get(), cone_scale.Get())
# select torus
await select_prims(["/World/Torus"])
await ui_test.human_delay()
# right click on Transform header
widget = ui_test.find("Property//Frame/**/CollapsableFrame[*].title=='Transform'")
await widget.click(pos=widget.position+ui_test.Vec2(widget.widget.computed_content_width/2, 10), right_click=True)
# context menu reset
await ui_test.select_context_menu("Reset All Property Values in Transform", offset=ui_test.Vec2(10, 10))
# verify transforms reset
self.assertEqual(torus_translate.Get(), Gf.Vec3d(0, 0, 0))
self.assertEqual(torus_rotate.Get(), Gf.Vec3d(0, 0, 0))
self.assertEqual(torus_scale.Get(), Gf.Vec3d(1, 1, 1))
async def open_property_map(self):
usd_context = omni.usd.get_context()
test_file_path = self._usd_path.joinpath("test_transform_property.usda").absolute()
await usd_context.open_stage_async(str(test_file_path))
await wait_stage_loading()
async def test_translate_context_menu(self):
await self.open_property_map()
usd_context = omni.usd.get_context()
stage = usd_context.get_stage()
#test disable/delete
#right click on translate
#select cone
await select_prims(["/World/Cone"])
await ui_test.human_delay()
prim = stage.GetObjectAtPath("/World/Cone")
xform = UsdGeom.Xformable(prim)
#test translate disable/enable/delete
widget = ui_test.find("Property//Frame/**/CollapsableFrame[*]/**/Label[*].text=='Translate'")
await widget.click(pos=widget.position+ui_test.Vec2(widget.widget.computed_content_width/2, 10), right_click=True)
# context menu reset
await ui_test.select_context_menu("Disable", offset=ui_test.Vec2(10, 10))
await ui_test.human_delay()
#make sure transslate is gone
self.assertTrue(not include_op_code(xform, "xformOp:translate"))
widget = ui_test.find("Property//Frame/**/CollapsableFrame[*]/**/Label[*].text=='Translate'")
await widget.click(pos=widget.position+ui_test.Vec2(widget.widget.computed_content_width/2, 10), right_click=True)
# context menu reset
await ui_test.select_context_menu("Enable", offset=ui_test.Vec2(10, 10))
await ui_test.human_delay()
#make sure transslate is gone
self.assertTrue(include_op_code(xform, "xformOp:translate"))
widget = ui_test.find("Property//Frame/**/CollapsableFrame[*]/**/Label[*].text=='Translate'")
#now test delete
await widget.click(pos=widget.position+ui_test.Vec2(widget.widget.computed_content_width/2, 10), right_click=True)
await ui_test.select_context_menu("Delete", offset=ui_test.Vec2(10, 10))
await ui_test.human_delay()
#make sure transslate is gone
attr = prim.GetAttribute("xformOp:translate")
self.assertTrue(not attr)
async def test_pivot_context_menu(self):
await self.open_property_map()
usd_context = omni.usd.get_context()
stage = usd_context.get_stage()
#test disable/delete
#right click on translate
#select cone
await select_prims(["/World/Cone"])
await ui_test.human_delay()
prim = stage.GetObjectAtPath("/World/Cone")
xform = UsdGeom.Xformable(prim)
#test translate:pivot disable/enable/delete
widget = ui_test.find("Property//Frame/**/CollapsableFrame[*]/**/Label[*].text=='Translate:pivot'")
await widget.click(pos=widget.position+ui_test.Vec2(widget.widget.computed_content_width/2, 10), right_click=True)
# context menu reset
await ui_test.select_context_menu("Disable", offset=ui_test.Vec2(10, 10))
await ui_test.human_delay()
#make sure transslate is gone
self.assertTrue(not include_op_code(xform, "xformOp:translate:pivot"))
widget = ui_test.find("Property//Frame/**/CollapsableFrame[*]/**/Label[*].text=='Translate:pivot'")
await widget.click(pos=widget.position+ui_test.Vec2(widget.widget.computed_content_width/2, 10), right_click=True)
# context menu resety
await ui_test.select_context_menu("Enable", offset=ui_test.Vec2(10, 10))
await ui_test.human_delay()
#make sure transslate is gone
self.assertTrue(include_op_code(xform, "xformOp:translate:pivot"))
widget = ui_test.find("Property//Frame/**/CollapsableFrame[*]/**/Label[*].text=='Translate:pivot'")
#now test delete
await widget.click(pos=widget.position+ui_test.Vec2(widget.widget.computed_content_width/2, 10), right_click=True)
await ui_test.select_context_menu("Delete", offset=ui_test.Vec2(10, 10))
await ui_test.human_delay()
#make sure transslate is gone
attr = prim.GetAttribute("xformOp:translate:pivot")
self.assertTrue(not attr)
async def test_scale_context_menu(self):
await self.open_property_map()
usd_context = omni.usd.get_context()
stage = usd_context.get_stage()
#test disable/delete
#right click on translate
#select cone
await select_prims(["/World/Cone"])
await ui_test.human_delay()
prim = stage.GetObjectAtPath("/World/Cone")
xform = UsdGeom.Xformable(prim)
#test translate:pivot disable/enable/delete
widget = ui_test.find("Property//Frame/**/CollapsableFrame[*]/**/Label[*].text=='Scale'")
await widget.click(pos=widget.position+ui_test.Vec2(widget.widget.computed_content_width/2, 10), right_click=True)
# context menu reset
await ui_test.select_context_menu("Disable", offset=ui_test.Vec2(10, 10))
await ui_test.human_delay()
#make sure transslate is gone
self.assertTrue(not include_op_code(xform, "xformOp:scale"))
widget = ui_test.find("Property//Frame/**/CollapsableFrame[*]/**/Label[*].text=='Scale'")
await widget.click(pos=widget.position+ui_test.Vec2(widget.widget.computed_content_width/2, 10), right_click=True)
# context menu resety
await ui_test.select_context_menu("Enable", offset=ui_test.Vec2(10, 10))
await ui_test.human_delay()
#make sure transslate is gone
self.assertTrue(include_op_code(xform, "xformOp:scale"))
widget = ui_test.find("Property//Frame/**/CollapsableFrame[*]/**/Label[*].text=='Scale'")
#now test delete
await widget.click(pos=widget.position+ui_test.Vec2(widget.widget.computed_content_width/2, 10), right_click=True)
await ui_test.select_context_menu("Delete", offset=ui_test.Vec2(10, 10))
await ui_test.human_delay()
#make sure transslate is gone
attr = prim.GetAttribute("xformOp:scale")
self.assertTrue(not attr)
async def test_rotate_context_menu(self):
await self.open_property_map()
usd_context = omni.usd.get_context()
stage = usd_context.get_stage()
#test disable/delete
#right click on translate
#select cone
await select_prims(["/World/Cone"])
await ui_test.human_delay()
prim = stage.GetObjectAtPath("/World/Cone")
xform = UsdGeom.Xformable(prim)
#test rotate rotation order change
widget = ui_test.find("Property//Frame/**/CollapsableFrame[*]/**/Label[*].text=='Rotate'")
await widget.click(pos=widget.position+ui_test.Vec2(widget.widget.computed_content_width/2, 10))
#find ZYX label
widget = ui_test.find("RotationOrder//Frame/**/Label[*].text=='ZYX'")
#switch and make sure it's changed
await widget.click(pos=widget.position+ui_test.Vec2(widget.widget.computed_content_width/2, 10))
self.assertTrue(not include_op_code(xform, "xformOp:rotateXYZ"))
self.assertTrue(include_op_code(xform, "xformOp:rotateZYX"))
#chgange it to YZX
widget = ui_test.find("Property//Frame/**/CollapsableFrame[*]/**/Label[*].text=='Rotate'")
await widget.click(pos=widget.position+ui_test.Vec2(widget.widget.computed_content_width/2, 10))
#find YZX label
widget = ui_test.find("RotationOrder//Frame/**/Label[*].text=='YZX'")
await widget.click(pos=widget.position+ui_test.Vec2(widget.widget.computed_content_width/2, 10))
self.assertTrue(not include_op_code(xform, "xformOp:rotateZYX"))
self.assertTrue(include_op_code(xform, "xformOp:rotateYZX")) | 12,428 | Python | 43.231317 | 123 | 0.661168 |
omniverse-code/kit/exts/omni.kit.window.viewport/omni/kit/viewport_legacy/__init__.py | from .scripts import *
def deferred_capture(viewport_window, callback, is_hdr=False, subscription_name=None):
def _get_subs_name():
import sys
frame = sys._getframe(1).f_back
f_code = frame.f_code
filepath = f_code.co_filename
lineno = frame.f_lineno
return "VP capt %s:%d" % (filepath[-40:], lineno)
class CaptureHelper:
def capture_function(self, event):
self.deferred_capture_subs = None
if is_hdr:
viewport_rp_resource = viewport_window.get_drawable_hdr_resource()
else:
viewport_rp_resource = viewport_window.get_drawable_ldr_resource()
callback(viewport_rp_resource)
if subscription_name is None:
subscription_name = _get_subs_name()
capture_helper = CaptureHelper()
capture_helper.deferred_capture_subs = viewport_window.get_ui_draw_event_stream().create_subscription_to_pop(
capture_helper.capture_function,
name=subscription_name
)
| 1,031 | Python | 32.290322 | 113 | 0.629486 |
omniverse-code/kit/exts/omni.kit.window.viewport/omni/kit/viewport_legacy/scripts/external_drag_drop_helper.py | import os
import re
import pathlib
from pxr import Sdf, Tf
from typing import List
from omni.kit.window.drop_support import ExternalDragDrop
external_drag_drop = None
def setup_external_drag_drop(window_name :str):
global external_drag_drop
destroy_external_drag_drop()
external_drag_drop = ExternalDragDrop(window_name=window_name, drag_drop_fn=_on_ext_drag_drop)
def destroy_external_drag_drop():
global external_drag_drop
if external_drag_drop:
external_drag_drop.destroy()
external_drag_drop = None
def _on_ext_drag_drop(edd: ExternalDragDrop, payload: List[str]):
import omni.usd
import omni.kit.undo
import omni.kit.commands
default_prim_path = Sdf.Path("/")
stage = omni.usd.get_context().get_stage()
if stage.HasDefaultPrim():
default_prim_path = stage.GetDefaultPrim().GetPath()
re_audio = re.compile(r"^.*\.(wav|wave|ogg|oga|flac|fla|mp3|m4a|spx|opus)(\?.*)?$", re.IGNORECASE)
re_usd = re.compile(r"^.*\.(usd|usda|usdc|usdz)(\?.*)?$", re.IGNORECASE)
for source_url in edd.expand_payload(payload):
if re_usd.match(source_url):
try:
import omni.kit.window.file
omni.kit.window.file.open_stage(source_url.replace(os.sep, '/'))
except ImportError:
import carb
carb.log_warn(f'Failed to import omni.kit.window.file - Cannot open stage {source_url}')
return
with omni.kit.undo.group():
for source_url in edd.expand_payload(payload):
if re_audio.match(source_url):
stem = pathlib.Path(source_url).stem
path = default_prim_path.AppendChild(Tf.MakeValidIdentifier(stem))
omni.kit.commands.execute(
"CreateAudioPrimFromAssetPath",
path_to=path,
asset_path=source_url,
usd_context=omni.usd.get_context(),
)
| 1,973 | Python | 33.034482 | 104 | 0.618348 |
omniverse-code/kit/exts/omni.kit.window.viewport/omni/kit/viewport_legacy/scripts/commands.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.commands
import omni.kit.viewport_legacy
import omni.usd
from pxr import Sdf, UsdGeom, Usd
from typing import Union
def get_viewport_window_from_name(viewport_name: str):
vp = omni.kit.viewport_legacy.get_viewport_interface()
instance = vp.get_instance(viewport_name)
if instance:
return vp.get_viewport_window(instance)
return None
class SetActiveViewportCameraCommand(omni.kit.commands.Command):
"""
Sets Viewport's actively bound camera to given camera at give path.
Args:
new_active_cam_path (Union[str, Sdf.Path): new camera path to bind to viewport.
viewport_name (str): name of the viewport to set active camera (for multi-viewport).
"""
def __init__(self, new_active_cam_path: Union[str, Sdf.Path], viewport_name: str = ""):
self._new_active_cam_path = str(new_active_cam_path)
self._viewport_window = get_viewport_window_from_name(viewport_name)
if not viewport_name and not self._viewport_window:
self._viewport_window = omni.kit.viewport_legacy.get_default_viewport_window()
self._prev_active_camera = None
def do(self):
if not self._viewport_window:
return
self._prev_active_camera = self._viewport_window.get_active_camera()
self._viewport_window.set_active_camera(self._new_active_cam_path)
def undo(self):
if not self._viewport_window:
return
self._viewport_window.set_active_camera(self._prev_active_camera)
class DuplicateFromActiveViewportCameraCommand(omni.kit.commands.Command):
"""
Duplicates Viewport's actively bound camera and bind active camera to the duplicated one.
Args:
viewport_name (str): name of the viewport to set active camera (for multi-viewport).
"""
def __init__(self, viewport_name: str = ""):
self._viewport_name = viewport_name
self._viewport_window = get_viewport_window_from_name(viewport_name)
if not viewport_name and not self._viewport_window:
self._viewport_window = omni.kit.viewport_legacy.get_default_viewport_window()
self._usd_context_name = ""
self._usd_context = omni.usd.get_context("") # TODO get associated usd_context from Viewport itself
self._prev_active_camera = None
def do(self):
if not self._viewport_window:
return
self._prev_active_camera = self._viewport_window.get_active_camera()
if self._prev_active_camera:
stage = self._usd_context.get_stage()
target_path = omni.usd.get_stage_next_free_path(stage, "/Camera", True)
old_prim = stage.GetPrimAtPath(self._prev_active_camera)
omni.kit.commands.execute("CreatePrim", prim_path=target_path, prim_type="Camera")
new_prim = stage.GetPrimAtPath(target_path)
if old_prim and new_prim:
# copy attributes
timeline = omni.timeline.get_timeline_interface()
timecode = timeline.get_current_time() * stage.GetTimeCodesPerSecond()
for attr in old_prim.GetAttributes():
value = attr.Get(timecode)
if value is not None:
new_prim.CreateAttribute(attr.GetName(), attr.GetTypeName()).Set(value)
default_prim = stage.GetDefaultPrim()
# OM-35156: It's possible that transform of default prim is not identity.
# And it tries to copy a camera that's outside of the default prim tree.
# It needs to be transformed to the default prim space.
if default_prim and default_prim.IsA(UsdGeom.Xformable):
default_prim_world_mtx = omni.usd.get_world_transform_matrix(default_prim, timecode)
old_camera_prim_world_mtx = omni.usd.get_world_transform_matrix(old_prim, timecode)
new_camera_prim_local_mtx = old_camera_prim_world_mtx * default_prim_world_mtx.GetInverse()
omni.kit.commands.execute(
"TransformPrim", path=new_prim.GetPath(),
new_transform_matrix=new_camera_prim_local_mtx
)
omni.usd.editor.set_no_delete(new_prim, False)
omni.kit.commands.execute(
"SetActiveViewportCamera", new_active_cam_path=target_path, viewport_name=self._viewport_name
)
def undo(self):
pass
omni.kit.commands.register_all_commands_in_module(__name__)
| 5,022 | Python | 42.301724 | 113 | 0.644166 |
omniverse-code/kit/exts/omni.kit.window.viewport/omni/kit/viewport_legacy/scripts/__init__.py | from .context_menu import *
from .viewport import *
from .commands import * | 75 | Python | 24.333325 | 27 | 0.76 |
omniverse-code/kit/exts/omni.kit.window.viewport/omni/kit/viewport_legacy/scripts/context_menu.py | # Copyright (c) 2020, 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 asyncio
import omni.ext
import carb
import carb.settings
import omni.kit.ui
from .viewport import get_viewport_interface
from .external_drag_drop_helper import setup_external_drag_drop, destroy_external_drag_drop
class Extension(omni.ext.IExt):
def on_startup(self):
# get window event stream
viewport_win = get_viewport_interface().get_viewport_window()
# on_mouse_event called when event dispatched
if viewport_win:
self._stage_event_sub = viewport_win.get_mouse_event_stream().create_subscription_to_pop(self.on_mouse_event)
self._menu_path = "Window/New Viewport Window"
self._editor_menu = omni.kit.ui.get_editor_menu()
if self._editor_menu is not None:
self._menu = self._editor_menu.add_item(self._menu_path, self._on_menu_click, False, priority=200)
# external drag/drop
if viewport_win:
setup_external_drag_drop("Viewport")
def on_shutdown(self):
# remove event
self._stage_event_sub = None
destroy_external_drag_drop()
def _on_menu_click(self, menu, toggled):
async def new_viewport():
await omni.kit.app.get_app().next_update_async()
viewportFactory = get_viewport_interface()
viewportHandle = viewportFactory.create_instance()
window = viewportFactory.get_viewport_window(viewportHandle)
window.set_window_size(350, 350)
asyncio.ensure_future(new_viewport())
def on_mouse_event(self, event):
# check its expected event
if event.type == int(omni.kit.ui.MenuEventType.ACTIVATE):
if carb.settings.get_settings().get("/exts/omni.kit.window.viewport/showContextMenu"):
self.show_context_menu(event.payload)
def show_context_menu(self, payload: dict):
viewport_win = get_viewport_interface().get_viewport_window()
usd_context_name = viewport_win.get_usd_context_name()
#This is actuall world-position !
world_position = payload.get('mouse_pos_x', None)
if world_position is not None:
world_position = (
world_position,
payload['mouse_pos_y'],
payload['mouse_pos_z']
)
try:
from omni.kit.context_menu import ViewportMenu
ViewportMenu.show_menu(
usd_context_name, payload.get('prim_path', None), world_position
)
except ImportError:
carb.log_error('omni.kit.context_menu must be loaded to use the context menu')
@staticmethod
def add_menu(menu_dict):
"""
Add the menu to the end of the context menu. Return the object that
should be alive all the time. Once the returned object is destroyed,
the added menu is destroyed as well.
"""
return omni.kit.context_menu.add_menu(menu_dict, "MENU", "omni.kit.window.viewport")
@staticmethod
def add_create_menu(menu_dict):
"""
Add the menu to the end of the stage context create menu. Return the object that
should be alive all the time. Once the returned object is destroyed,
the added menu is destroyed as well.
"""
return omni.kit.context_menu.add_menu(menu_dict, "CREATE", "omni.kit.window.viewport")
| 3,774 | Python | 39.159574 | 121 | 0.653683 |
omniverse-code/kit/exts/omni.kit.window.viewport/omni/kit/viewport_legacy/scripts/viewport.py | # Because ExtensionWindowHandle is used, we should get rid of it really:
import omni.kit.extensionwindow
import asyncio
import carb
import copy
from .._viewport_legacy import *
from omni.hydra.engine.stats import HydraEngineStats, get_mem_stats
import warnings
def get_viewport_interface():
"""Returns cached :class:`omni.kit.viewport_legacy.IViewport` interface"""
if not hasattr(get_viewport_interface, "viewport"):
get_viewport_interface.viewport = acquire_viewport_interface()
return get_viewport_interface.viewport
def get_default_viewport_window():
"""Returns default (first) Viewport Window if available"""
viewport = get_viewport_interface()
if viewport:
return viewport.get_viewport_window()
return None
def menu_update(menu_path, visible):
# get the correct viewport window as there can be multiple
vp_iface = omni.kit.viewport_legacy.get_viewport_interface()
viewports = vp_iface.get_instance_list()
for viewport in viewports:
if menu_path.endswith(vp_iface.get_viewport_window_name(viewport)):
viewport_window = vp_iface.get_viewport_window(viewport)
viewport_window.show_hide_window(visible)
omni.kit.ui.get_editor_menu().set_value(menu_path, visible)
async def _query_next_picked_world_position_async(self) -> carb.Double3:
"""Asynchronous version of :func:`IViewportWindow.query_next_picked_world_position`. Return a ``carb.Double3``. If
no position is sampled, the returned object is None."""
f = asyncio.Future()
def cb(pos):
f.set_result(copy.deepcopy(pos))
self.query_next_picked_world_position(cb)
return await f
IViewportWindow.query_next_picked_world_position_async = _query_next_picked_world_position_async
def get_nested_gpu_profiler_result(vw: IViewportWindow, max_indent: int = 1):
warnings.warn(
"IViewportWindow.get_nested_gpu_profiler_result is deprecated, use omni.hydra.engine.stats.HydraEngineStats instead",
DeprecationWarning
)
return HydraEngineStats(vw.get_usd_context_name(), vw.get_active_hydra_engine()).get_nested_gpu_profiler_result(max_indent)
def get_gpu_profiler_result(vw: IViewportWindow):
warnings.warn(
"IViewportWindow.get_gpu_profiler_result is deprecated, use omni.hydra.engine.stats.HydraEngineStats instead",
DeprecationWarning
)
return HydraEngineStats(vw.get_usd_context_name(), vw.get_active_hydra_engine()).get_gpu_profiler_result()
def save_gpu_profiler_result_to_json(vw: IViewportWindow, file_name: str):
warnings.warn(
"IViewportWindow.save_gpu_profiler_result_to_json is deprecated, use omni.hydra.engine.stats.HydraEngineStats instead",
DeprecationWarning
)
return HydraEngineStats(vw.get_usd_context_name(), vw.get_active_hydra_engine()).save_gpu_profiler_result_to_json(file_name)
def reset_gpu_profiler_containers(vw: IViewportWindow):
warnings.warn(
"IViewportWindow.reset_gpu_profiler_containers is deprecated, use omni.hydra.engine.stats.HydraEngineStats instead",
DeprecationWarning
)
return HydraEngineStats(vw.get_usd_context_name(), vw.get_active_hydra_engine()).reset_gpu_profiler_containers()
def get_mem_stats_result(vw: IViewportWindow, detailed: bool = False):
warnings.warn(
"IViewportWindow.get_mem_stats_result is deprecated, use omni.hydra.engine.stats.get_mem_stats instead",
DeprecationWarning
)
return get_mem_stats(detailed)
IViewportWindow.get_nested_gpu_profiler_result = get_nested_gpu_profiler_result
IViewportWindow.get_gpu_profiler_result = get_gpu_profiler_result
IViewportWindow.save_gpu_profiler_result_to_json = save_gpu_profiler_result_to_json
IViewportWindow.reset_gpu_profiler_containers = reset_gpu_profiler_containers
IViewportWindow.get_mem_stats_result = get_mem_stats_result
| 3,877 | Python | 40.255319 | 128 | 0.740005 |
omniverse-code/kit/exts/omni.kit.window.viewport/omni/kit/viewport_legacy/tests/camera_tests.py | # Copyright (c) 2020, 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 asyncio
import os
import tempfile
import uuid
import carb
import omni.kit.commands
import omni.kit.test
import omni.kit.viewport_legacy
from pxr import Gf, Usd, UsdGeom, Sdf
from omni.kit.test_suite.helpers import arrange_windows
class TestViewportWindowCamera(omni.kit.test.AsyncTestCase):
# Before running each test
async def setUp(self):
await arrange_windows()
# After running each test
async def tearDown(self):
pass
async def test_builtin_camera_settings(self):
async def test_builtin_camera_settings_inner(modify_camera=False):
await omni.usd.get_context().new_stage_async()
# Waiting one frame after the new stage, so in sync load cases
# the USD context had a chance to launch a preSync event
await omni.kit.app.get_app().next_update_async()
viewport_window = omni.kit.viewport_legacy.get_default_viewport_window()
omni.kit.commands.execute("CreatePrim", prim_type="Sphere")
camera_paths = ["/OmniverseKit_Persp", "/OmniverseKit_Front", "/OmniverseKit_Top", "/OmniverseKit_Right"]
camera_names = ["Perspective", "Front", "Top", "Right"]
positions = []
targets = []
if modify_camera:
viewport_window.set_camera_position("/OmniverseKit_Persp", 100, 200, 300, True)
viewport_window.set_camera_target("/OmniverseKit_Persp", 300, 200, 100, True)
viewport_window.set_active_camera("/OmniverseKit_Front")
for i in range(len(camera_paths)):
position = viewport_window.get_camera_position(camera_paths[i])
self.assertTrue(position[0])
positions.append(Gf.Vec3d(position[1], position[2], position[3]))
target = viewport_window.get_camera_target(camera_paths[i])
self.assertTrue(target[0])
targets.append(Gf.Vec3d(target[1], target[2], target[3]))
active_camera = viewport_window.get_active_camera()
with tempfile.TemporaryDirectory() as tmpdirname:
tmpfilename = os.path.join(tmpdirname, f"camTest_{str(uuid.uuid4())}.usda")
carb.log_info("Saving temp camera path as %s" % (tmpfilename))
await omni.usd.get_context().save_as_stage_async(tmpfilename)
await omni.usd.get_context().reopen_stage_async()
await omni.kit.app.get_app().next_update_async()
for i in range(len(camera_names)):
carb.log_info("Testing %s" % (camera_names[i]))
# Position only saved for Persp camera
if i == 0:
saved_position = viewport_window.get_camera_position(camera_paths[i])
self.assertTrue(saved_position[0])
saved_position = Gf.Vec3d(saved_position[1], saved_position[2], saved_position[3])
carb.log_info("Comparing Positions: (%f,%f,%f) to (%f,%f,%f)" % (positions[i][0], positions[i][1], positions[i][2], saved_position[0], saved_position[1], saved_position[2]))
self.assertTrue(
Gf.IsClose(positions[i], saved_position, 0.000001),
f"Camera position mismatched! {positions[i]} is not close to {saved_position}",
)
saved_target = viewport_window.get_camera_target(camera_paths[i])
self.assertTrue(saved_target[0])
saved_target = Gf.Vec3d(saved_target[1], saved_target[2], saved_target[3])
active_camera_saved = viewport_window.get_active_camera()
carb.log_info("Comparing Targets: (%f,%f,%f) to (%f,%f,%f)" % (targets[i][0], targets[i][1], targets[i][2], saved_target[0], saved_target[1], saved_target[2]))
self.assertTrue(
Gf.IsClose(targets[i], saved_target, 0.000001),
f"Camera target mismatched! {targets[i]} is not close to {saved_target}",
)
if modify_camera and i == 0:
self.assertTrue(Gf.IsClose(positions[i], Gf.Vec3d(100, 200, 300), 0.000001))
self.assertTrue(Gf.IsClose(targets[i], Gf.Vec3d(300, 200, 100), 0.000001))
self.assertTrue(
active_camera == active_camera_saved,
f"Active camera mismatched! {active_camera} is not equal to {active_camera_saved}",
)
# test default camera settings
carb.log_info("Testing default camera settings")
await test_builtin_camera_settings_inner()
# test modified camera settings
carb.log_info("Testing modified camera settings")
await test_builtin_camera_settings_inner(True)
async def test_camera_duplicate_from_static_active_camera(self):
# Test for OM-35156
await omni.usd.get_context().new_stage_async()
await omni.kit.app.get_app().next_update_async()
stage = omni.usd.get_context().get_stage()
prim = UsdGeom.Xform.Define(stage, "/World")
stage.SetDefaultPrim(prim.GetPrim())
default_prim = stage.GetDefaultPrim()
UsdGeom.XformCommonAPI(default_prim).SetTranslate(Gf.Vec3d(100, 0, 0))
perspective_camera = stage.GetPrimAtPath("/OmniverseKit_Persp")
persp_camera_world_mtx = omni.usd.get_world_transform_matrix(perspective_camera)
default_prim_world_mtx = omni.usd.get_world_transform_matrix(default_prim)
omni.kit.commands.execute(
"SetActiveViewportCamera", new_active_cam_path=perspective_camera.GetPath(), viewport_name=""
)
await omni.kit.app.get_app().next_update_async()
omni.kit.commands.execute("DuplicateFromActiveViewportCamera")
await omni.kit.app.get_app().next_update_async()
# The name of it will be Camera
new_camera_prim = stage.GetPrimAtPath(default_prim.GetPath().AppendElementString("Camera"))
new_camera_local_mtx = omni.usd.get_local_transform_matrix(new_camera_prim)
local_mtx = persp_camera_world_mtx * default_prim_world_mtx.GetInverse()
self.assertTrue(Gf.IsClose(new_camera_local_mtx, local_mtx, 0.000001))
async def test_camera_duplicate_from_animated_active_camera(self):
# Test for OM-33581
layer_with_animated_camera = """\
#usda 1.0
(
customLayerData = {
}
defaultPrim = "World"
endTimeCode = 619
framesPerSecond = 24
metersPerUnit = 0.01
startTimeCode = 90
timeCodesPerSecond = 24
upAxis = "Y"
)
def Xform "World" (
kind = "assembly"
)
{
def Camera "SHOTCAM"
{
float2 clippingRange = (10, 10000)
custom bool depthOfField = 0
float focalLength = 35
float focalLength.timeSamples = {
172: 35,
173: 34.650208
}
float focusDistance = 5
float fStop = 5.6
float horizontalAperture = 35.999928
float verticalAperture = 20.22853
float3 xformOp:rotateXYZ.timeSamples = {
90: (8.786562, -19.858515, -1.2905762),
91: (8.744475, -19.858515, -1.274945)
}
float3 xformOp:scale.timeSamples = {
90: (12.21508, 12.21508, 12.21508)
}
double3 xformOp:translate.timeSamples = {
90: (-462.44292428348126, 1734.9897515804505, -2997.4519412288555),
151: (-462.4429242834828, 1734.9897515804498, -2997.451941228857)
}
uniform token[] xformOpOrder = ["xformOp:translate", "xformOp:rotateXYZ", "xformOp:scale"]
}
}
"""
format = Sdf.FileFormat.FindByExtension(".usd")
root_layer = Sdf.Layer.CreateAnonymous("world.usd", format)
root_layer.ImportFromString(layer_with_animated_camera)
stage = Usd.Stage.Open(root_layer)
await omni.usd.get_context().attach_stage_async(stage)
await omni.kit.app.get_app().next_update_async()
old_camera = stage.GetPrimAtPath("/World/SHOTCAM")
omni.kit.commands.execute(
"SetActiveViewportCamera", new_active_cam_path="/World/SHOTCAM", viewport_name=""
)
await omni.kit.app.get_app().next_update_async()
await omni.kit.app.get_app().next_update_async()
omni.kit.commands.execute("DuplicateFromActiveViewportCamera")
await omni.kit.app.get_app().next_update_async()
new_camera = stage.GetPrimAtPath("/World/Camera")
self.assertTrue(new_camera)
timeline = omni.timeline.get_timeline_interface()
timecode = timeline.get_current_time() * stage.GetTimeCodesPerSecond()
old_matrix = omni.usd.get_world_transform_matrix(old_camera, timecode)
new_matrix = omni.usd.get_world_transform_matrix(new_camera)
self.assertTrue(Gf.IsClose(new_matrix, old_matrix, 0.000001))
# Set time code to the second timecode of rotateXYZ, so they are not equal.
timeline.set_current_time(float(91.0 / stage.GetTimeCodesPerSecond()))
timecode = timeline.get_current_time() * stage.GetTimeCodesPerSecond()
old_matrix = omni.usd.get_world_transform_matrix(old_camera, timecode)
self.assertFalse(Gf.IsClose(new_matrix, old_matrix, 0.000001))
# Make another duplicate that's duplicated from updated time.
omni.kit.commands.execute(
"SetActiveViewportCamera", new_active_cam_path="/World/SHOTCAM", viewport_name=""
)
await omni.kit.app.get_app().next_update_async()
await omni.kit.app.get_app().next_update_async()
omni.kit.commands.execute("DuplicateFromActiveViewportCamera")
await omni.kit.app.get_app().next_update_async()
new_camera = stage.GetPrimAtPath("/World/Camera_01")
self.assertTrue(new_camera)
old_matrix = omni.usd.get_world_transform_matrix(old_camera, timecode)
new_matrix = omni.usd.get_world_transform_matrix(new_camera)
self.assertTrue(Gf.IsClose(new_matrix, old_matrix, 0.000001))
async def test_layer_clear_to_remove_camera_deltas(self):
# Test for OM-47804
await omni.usd.get_context().new_stage_async()
for _ in range(10):
# Create anonymous layer and set edit target
stage = omni.usd.get_context().get_stage()
replicator_layer = None
for layer in stage.GetLayerStack():
if layer.GetDisplayName() == "Replicator":
replicator_layer = layer
break
if replicator_layer is None:
root = stage.GetRootLayer()
replicator_layer = Sdf.Layer.CreateAnonymous(tag="Replicator")
root.subLayerPaths.append(replicator_layer.identifier)
omni.usd.set_edit_target_by_identifier(stage, replicator_layer.identifier)
# Clear prim and assert not valid
replicator_layer.Clear()
self.assertFalse(stage.GetPrimAtPath("/ReplicatorPrim").IsValid())
# Define some prim on the layer
stage.DefinePrim("/ReplicatorPrim", "Camera")
| 12,035 | Python | 45.832685 | 197 | 0.602659 |
Subsets and Splits
No saved queries yet
Save your SQL queries to embed, download, and access them later. Queries will appear here once saved.