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.videoencoding/video_encoding/impl/video_encoding.py | import os
import carb
import omni.ext
from .._video_encoding import *
# Put interface object publicly to use in our API.
_video_encoding_api = None
def get_video_encoding_interface() -> IVideoEncoding:
return _video_encoding_api
def encode_image_file_sequence(filename_pattern, start_number, frame_rate, output_file, overwrite_existing) -> bool:
video_encoding_api = get_video_encoding_interface()
if video_encoding_api is None:
carb.log_warn("Video encoding api not available; cannot encode video.")
return False
# acquire list of available frame image files, based on start_number and filename_pattern
next_frame = start_number
frame_filenames = []
while True:
frame_filename = filename_pattern % (next_frame)
if os.path.isfile(frame_filename) and os.access(frame_filename, os.R_OK):
frame_filenames.append(frame_filename)
next_frame += 1
else:
break
carb.log_warn(f"Found {len(frame_filenames)} frames to encode.")
if len(frame_filenames) == 0:
carb.log_warn(f"No frames to encode.")
return False
if not video_encoding_api.start_encoding(output_file, frame_rate, len(frame_filenames), overwrite_existing):
return
try:
for frame_filename in frame_filenames:
video_encoding_api.encode_next_frame_from_file(frame_filename)
except:
raise
finally:
video_encoding_api.finalize_encoding()
return True
# Use extension entry points to acquire and release interface.
class Extension(omni.ext.IExt):
def __init__(self):
pass
def on_startup(self, ext_id):
global _video_encoding_api
_video_encoding_api = acquire_video_encoding_interface()
# print(f"[video encoding] _video_encoding interface: {_video_encoding_api}")
def on_shutdown(self):
global _video_encoding_api
release_video_encoding_interface(_video_encoding_api)
_video_encoding_api = None
| 2,016 | Python | 29.560606 | 116 | 0.669147 |
omniverse-code/kit/exts/omni.kit.window.content_browser/scripts/demo_content_browser.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 os
import weakref
from omni.kit.window.content_browser import get_content_window
from omni.kit.window.filepicker import FilePickerDialog
class DemoContentBrowserClient:
"""
Example that demonstrates how to add custom actions to the content browser.
"""
def __init__(self):
# Get the Content extension object. Same as: omni.kit.window.content_browser.get_extension()
# Keep as weakref to guard against the extension being removed at any time. If it is removed,
# then invoke appropriate handler; in this case the destroy method.
self._content_browser_ref = weakref.ref(get_content_window(), lambda ref: self.destroy())
self._init_context_menu()
def _init_context_menu(self):
def file_extension_of(path: str, exts: [str]):
_, ext = os.path.splitext(path)
return ext in exts
content_browser = self._content_browser_ref()
if not content_browser:
return
# Add these items to the context menu and target to USD file types.
content_browser.add_context_menu(
"Collect Asset",
"spinner.svg",
lambda menu, path: self._collect_asset(path),
lambda path: file_extension_of(path, [".usd"]),
)
content_browser.add_context_menu(
"Convert Asset",
"menu_insert_sublayer.svg",
lambda menu, path: self._convert_asset(path),
lambda path: file_extension_of(path, [".usd"]),
)
# Add these items to the list view menu and target to USD file types.
content_browser.add_listview_menu(
"Echo Selected", "spinner.svg", lambda menu, path: self._echo_selected(path), None
)
# Add these items to the list view menu and target to USD file types.
content_browser.add_import_menu(
"My Custom Import", "spinner.svg", lambda menu, path: self._import_stuff(path), None
)
def _collect_asset(self, path: str):
print(f"Collecting asset {path}.")
def _convert_asset(self, path: str):
print(f"Converting asset {path}.")
def _echo_selected(self, path: str):
content_browser = self._content_browser_ref()
if content_browser:
print(f"Current directory is {path}.")
selections = content_browser.get_current_selections(pane=1)
print(f"TreeView selections = {selections}")
selections = content_browser.get_current_selections(pane=2)
print(f"ListView selections = {selections}")
def _import_stuff(self, path: str):
def on_apply(dialog: FilePickerDialog, filename: str, dirname: str):
dialog.hide()
print(f"Importing: {dirname}/{filename}")
dialog = FilePickerDialog(
"Download Files",
width=800,
height=400,
splitter_offset=260,
enable_filename_input=False,
current_directory="Downloads",
grid_view_scale=1,
apply_button_label="Import",
click_apply_handler=lambda filename, dirname: on_apply(dialog, filename, dirname),
click_cancel_handler=lambda filename, dirname: dialog.hide(),
)
dialog.show()
def destroy(self):
content_browser = self._content_browser_ref()
if content_browser:
content_browser.delete_context_menu("Collect Asset")
content_browser.delete_context_menu("Convert Asset")
content_browser.delete_listview_menu("Echo Selected")
content_browser.delete_import_menu("My Custom Import")
self._content_browser_ref = None
if __name__ == "__main__":
DemoContentBrowserClient()
| 4,188 | Python | 38.518868 | 101 | 0.63467 |
omniverse-code/kit/exts/omni.kit.window.content_browser/omni/kit/window/content_browser/external_drag_drop_helper.py | import os
import asyncio
import carb
import omni.client
import omni.appwindow
import omni.ui as ui
from typing import List, Tuple
from omni.kit.window.drop_support import ExternalDragDrop
external_drag_drop = None
def setup_external_drag_drop(window_name: str, browser_widget, window_frame: ui.Frame):
global external_drag_drop
destroy_external_drag_drop()
external_drag_drop = ExternalDragDrop(window_name=window_name,
drag_drop_fn=lambda e, p, a=browser_widget.api, f=window_frame: _on_ext_drag_drop(e, p, a, f))
def destroy_external_drag_drop():
global external_drag_drop
if external_drag_drop:
external_drag_drop.destroy()
external_drag_drop = None
def _cleanup_slashes(path: str, is_directory: bool = False) -> str:
"""
Makes path/slashes uniform
Args:
path: path
is_directory is path a directory, so final slash can be added
Returns:
path
"""
path = os.path.normpath(path)
path = path.replace("\\", "/")
if is_directory:
if path[-1] != "/":
path += "/"
return path
def _on_ext_drag_drop(edd: ExternalDragDrop, payload: List[str], api, frame: ui.Frame):
import omni.kit.notification_manager
def get_current_mouse_coords() -> Tuple[float, float]:
app_window = omni.appwindow.get_default_app_window()
input = carb.input.acquire_input_interface()
dpi_scale = ui.Workspace.get_dpi_scale()
pos_x, pos_y = input.get_mouse_coords_pixel(app_window.get_mouse())
return pos_x / dpi_scale, pos_y / dpi_scale
search_frame = api.tool_bar._search_frame
search_delegate = api.tool_bar._search_delegate
if search_delegate and search_frame and search_frame.visible:
pos_x, pos_y = get_current_mouse_coords()
if (pos_x > search_frame.screen_position_x and pos_y > search_frame.screen_position_y
and pos_x < search_frame.screen_position_x + search_frame.computed_width
and pos_y < search_frame.screen_position_y + search_frame.computed_height):
if hasattr(search_delegate, "handle_drag_drop"):
if search_delegate.handle_drag_drop(payload):
return
target_dir = api.get_current_directory()
if not target_dir:
omni.kit.notification_manager.post_notification("No target directory", hide_after_timeout=False)
return
# get common source path
common_path = ""
if len(payload) > 1:
common_path = os.path.commonpath(payload)
if not common_path:
common_path = os.path.dirname(payload[0])
common_path = _cleanup_slashes(common_path, True)
# get payload
payload = edd.expand_payload(payload)
# copy files
async def do_copy():
from .progress_popup import ProgressPopup
from .file_ops import copy_item_async
copy_cancelled = False
def do_cancel_copy():
nonlocal copy_cancelled
copy_cancelled = True
# show progress...
waiting_popup = ProgressPopup("Copying...", status_text="Copying...")
waiting_popup.status_text = "Copying..."
waiting_popup.progress = 0.0
waiting_popup.centre_in_window(frame)
waiting_popup.set_cancel_fn(do_cancel_copy)
waiting_popup.show()
try:
await omni.kit.app.get_app().next_update_async()
current_file = 0
total_files = len(payload)
for file_path in payload:
if copy_cancelled:
break
file_path = _cleanup_slashes(file_path)
target_path = target_dir.rstrip("/") + "/" + file_path.replace(common_path, "")
# update progress
waiting_popup.progress = float(current_file) / total_files
waiting_popup.status_text = f"Copying {os.path.basename(target_path)}..."
waiting_popup.centre_in_window(frame)
# copy file
# OM-90753: Route through same code path as normal copy item
await copy_item_async(file_path, target_path)
current_file += 1
except Exception as exc:
carb.log_error(f"error {exc}")
await omni.kit.app.get_app().next_update_async()
api.refresh_current_directory()
waiting_popup.hide()
del waiting_popup
asyncio.ensure_future(do_copy())
| 4,475 | Python | 32.654135 | 136 | 0.612291 |
omniverse-code/kit/exts/omni.kit.window.content_browser/omni/kit/window/content_browser/style.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 omni.ui as ui
from pathlib import Path
try:
THEME = carb.settings.get_settings().get_as_string("/persistent/app/window/uiStyle")
except Exception:
THEME = None
finally:
THEME = THEME or "NvidiaDark"
CURRENT_PATH = Path(__file__).parent.absolute()
ICON_PATH = CURRENT_PATH.parent.parent.parent.parent.joinpath(f"icons/{THEME}")
def get_style():
if THEME == "NvidiaLight":
style = {
"Rectangle": {"background_color": 0xFF535354},
"Splitter": {"background_color": 0x0, "margin_width": 0},
"Splitter:hovered": {"background_color": 0xFFB0703B},
"Splitter:pressed": {"background_color": 0xFFB0703B},
"ToolBar": {"alignment": ui.Alignment.CENTER, "margin_height": 2},
"ToolBar.Button": {"background_color": 0xFF535354, "color": 0xFF9E9E9E},
"ToolBar.Button::filter": {"background_color": 0x0, "color": 0xFF9E9E9E},
"ToolBar.Button::import": {
"background_color": 0xFFD6D6D6,
"color": 0xFF535354,
"stack_direction": ui.Direction.LEFT_TO_RIGHT,
"border_radius": 3,
},
"ToolBar.Button.Label": {"color": 0xFF535354, "alignment": ui.Alignment.LEFT_CENTER},
"ToolBar.Button.Image": {"background_color": 0x0, "color": 0xFFFFFFFF, "alignment": ui.Alignment.CENTER},
"ToolBar.Button:hovered": {"background_color": 0xFFB8B8B8},
"Recycle.Button.Label": {"color": 0xFF9E9E9E, "alignment": ui.Alignment.LEFT_CENTER},
"Recycle.Button.Image": {"image_url": "resources/glyphs/trash.svg", "background_color": 0x0, "color": 0xFFFFFFFF, "alignment": ui.Alignment.CENTER},
"Recycle.Button:hovered": {"background_color": 0xFF3A3A3A},
}
else:
style = {
"Splitter": {"background_color": 0x0, "margin_width": 0},
"Splitter:hovered": {"background_color": 0xFFB0703B},
"Splitter:pressed": {"background_color": 0xFFB0703B},
"ToolBar": {"alignment": ui.Alignment.CENTER, "margin_height": 2},
"ToolBar.Button": {"background_color": 0x0, "color": 0xFF9E9E9E},
"ToolBar.Button::import": {
"background_color": 0xFF23211F,
"color": 0xFF9E9E9E,
"stack_direction": ui.Direction.LEFT_TO_RIGHT,
"border_radius": 3,
},
"ToolBar.Button.Label": {"color": 0xFF9E9E9E, "alignment": ui.Alignment.LEFT_CENTER},
"ToolBar.Button.Image": {"background_color": 0x0, "color": 0xFFFFFFFF, "alignment": ui.Alignment.CENTER},
"ToolBar.Button:hovered": {"background_color": 0xFF3A3A3A},
"Recycle.Button.Label": {"color": 0xFF9E9E9E, "alignment": ui.Alignment.LEFT_CENTER},
"Recycle.Button.Image": {"image_url": "resources/glyphs/trash.svg", "background_color": 0x0, "color": 0xFFFFFFFF, "alignment": ui.Alignment.CENTER},
"Recycle.Button:hovered": {"background_color": 0xFF3A3A3A},
}
return style
| 3,527 | Python | 49.399999 | 160 | 0.620357 |
omniverse-code/kit/exts/omni.kit.window.content_browser/omni/kit/window/content_browser/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 os
import asyncio
import carb
import omni.ext
import omni.kit.ui
import omni.ui as ui
import omni.kit.window.content_browser_registry as registry
from functools import partial
from typing import Union, Callable, List
from omni.kit.helper.file_utils import FILE_OPENED_EVENT
from omni.kit.window.filepicker import SearchDelegate, UI_READY_EVENT
from omni.kit.widget.filebrowser import FileBrowserModel, FileBrowserItem
from omni.kit.menu.utils import MenuItemDescription
from .window import ContentBrowserWindow
from .api import ContentBrowserAPI
g_singleton = None
# Any class derived from `omni.ext.IExt` in top level module (defined in `python.modules` of `extension.toml`) will be
# instantiated when extension gets enabled and `on_startup(ext_id)` will be called. Later when extension gets disabled
# on_shutdown() is called.
class ContentBrowserExtension(omni.ext.IExt):
"""The Content Browser extension"""
WINDOW_NAME = "Content"
MENU_GROUP = "Window"
def __init__(self):
super().__init__()
self._window = None
def on_startup(self, ext_id):
# Save away this instance as singleton for the editor window
global g_singleton
g_singleton = self
ui.Workspace.set_show_window_fn(ContentBrowserExtension.WINDOW_NAME, partial(self.show_window, None))
self._menu = [MenuItemDescription(
name=ContentBrowserExtension.WINDOW_NAME,
ticked=True, # menu item is ticked
ticked_fn=self._is_visible, # gets called when the menu needs to get the state of the ticked menu
onclick_fn=self._toggle_window
)]
omni.kit.menu.utils.add_menu_items(self._menu, name=ContentBrowserExtension.MENU_GROUP)
ui.Workspace.show_window(ContentBrowserExtension.WINDOW_NAME, True)
# Listen for relevant event stream events
event_stream = omni.kit.app.get_app().get_message_bus_event_stream()
self._stage_event_subscription = event_stream.create_subscription_to_pop_by_type(
FILE_OPENED_EVENT, self._on_stage_event)
self._content_browser_inited_subscription = event_stream.create_subscription_to_pop_by_type(
UI_READY_EVENT, self.decorate_from_registry)
def _on_stage_event(self, stage_event):
if not stage_event:
return
if "url" in stage_event.payload:
stage_url = stage_event.payload["url"]
default_folder = os.path.dirname(stage_url)
self.navigate_to(default_folder)
async def _destroy_window_async(self):
# wait one frame, this is due to the one frame defer
# in Window::_moveToMainOSWindow()
await omni.kit.app.get_app().next_update_async()
if self._window:
self._window.destroy()
self._window = None
def _visibility_changed_fn(self, visible):
if not visible:
# Destroy the window, since we are creating new window
# in show_window
asyncio.ensure_future(self._destroy_window_async())
def show_window(self, menu, value):
"""Shows this window. Inputs are for backwards compatibility only and not used."""
if value:
self._window = ContentBrowserWindow()
self._window.set_visibility_changed_listener(self._visibility_changed_fn)
elif self._window:
self._window.set_visible(value)
# this only tags test menu to update when menu is opening, so it
# doesn't matter that is called before window has been destroyed
omni.kit.menu.utils.refresh_menu_items(ContentBrowserExtension.MENU_GROUP)
def _is_visible(self) -> bool:
return False if self._window is None else self._window.get_visible()
def _toggle_window(self):
if self._is_visible():
self.show_window(None, False)
else:
self.show_window(None, True)
def on_shutdown(self): # pragma: no cover
omni.kit.menu.utils.remove_menu_items(self._menu, name=ContentBrowserExtension.MENU_GROUP)
self._stage_event_subscription = None
if self._window:
self._window.destroy()
self._window = None
ui.Workspace.set_show_window_fn(ContentBrowserExtension.WINDOW_NAME, None)
global g_singleton
g_singleton = None
@property
def window(self) -> ui.Window:
"""ui.Window: Main dialog window for this extension."""
return self._window
@property
def api(self) -> ContentBrowserAPI:
if self._window:
return self._window.widget.api
return None
def add_connections(self, connections: dict):
"""
Adds specified server connections to the tree browser.
Args:
connections (dict): A dictionary of name, path pairs. For example:
{"C:": "C:", "ov-content": "omniverse://ov-content"}. Paths to Omniverse servers
should be prefixed with "omniverse://".
"""
if self.api:
self.api.add_connections(connections)
def set_current_directory(self, path: str):
"""
Procedurally sets the current directory path.
Args:
path (str): The full path name of the folder, e.g. "omniverse://ov-content/Users/me.
Raises:
RuntimeWarning: If path doesn't exist or is unreachable.
"""
if self.api:
try:
self.api.set_current_directory(path)
except Exception:
raise
def get_current_directory(self) -> str:
"""
Returns the current directory fom the browser bar.
Returns:
str: The system path, which may be different from the displayed path.
"""
if self.api:
return self.api.get_current_directory()
return None
def get_current_selections(self, pane: int = 2) -> List[str]:
"""
Returns current selected as list of system path names.
Args:
pane (int): Specifies pane to retrieve selections from, one of {TREEVIEW_PANE = 1, LISTVIEW_PANE = 2,
BOTH = None}. Default LISTVIEW_PANE.
Returns:
List[str]: List of system paths (which may be different from displayed paths, e.g. bookmarks)
"""
if self.api:
return self.api.get_current_selections(pane)
return []
def subscribe_selection_changed(self, fn: Callable):
"""
Subscribes to file selection changes.
Args:
fn (Callable): callback function when file selection changed.
"""
if self.api:
registry.register_selection_handler(fn)
self.api.subscribe_selection_changed(fn)
def unsubscribe_selection_changed(self, fn: Callable):
"""
Unsubscribes this callback from selection changes.
Args:
fn (Callable): callback function when file selection changed.
"""
if self.api:
registry.deregister_selection_handler(fn)
self.api.unsubscribe_selection_changed(fn)
def navigate_to(self, url: str):
"""
Navigates to the given url, expanding all parent directories along the path.
Args:
url (str): The path to navigate to.
"""
if self.api:
self.api.navigate_to(url)
async def navigate_to_async(self, url: str):
"""
Asynchronously navigates to the given url, expanding all parent directories along the path.
Args:
url (str): The url to navigate to.
"""
if self.api:
await self.api.navigate_to_async(url)
async def select_items_async(self, url: str, filenames: List[str] = []) -> List[FileBrowserItem]:
"""
Asynchronously selects display items by their names.
Args:
url (str): Url of the parent folder.
filenames (str): Names of items to select.
Returns:
List[FileBrowserItem]: List of selected items.
"""
if self.api:
return await self.api.select_items_async(url, filenames=filenames)
return []
def add_context_menu(self, name: str, glyph: str, click_fn: Callable, show_fn: Callable, index: int = 0, separator_name="_add_on_end_separator_") -> str:
"""
Add menu item, with corresponding callbacks, to the context menu.
Args:
name (str): Name of the menu item (e.g. 'Open'), this name must be unique across the context menu.
glyph (str): Associated glyph to display for this menu item.
click_fn (Callable): This callback function is executed when the menu item is clicked. Function signature is
void fn(name: str, path: str), where name is menu name and path is absolute path to clicked item.
show_fn (Callable): Returns True to display this menu item. Function signature - bool fn(path: str).
For example, test filename extension to decide whether to display a 'Play Sound' action.
index (int): The position that this menu item will be inserted to.
separator_name (str): The separator name of the separator menu item. Default to '_placeholder_'. When the
index is not explicitly set, or if the index is out of range, this will be used to locate where to add
the menu item; if specified, the index passed in will be counted from the saparator with the provided
name. This is for OM-86768 as part of the effort to match Navigator and Kit UX for Filepicker/Content Browser for context menus.
Returns:
str: Name of menu item if successful, None otherwise.
"""
if self.api:
registry.register_context_menu(name, glyph, click_fn, show_fn, index)
return self.api.add_context_menu(name, glyph, click_fn, show_fn, index, separator_name=separator_name)
return None
def delete_context_menu(self, name: str):
"""
Delete the menu item, with the given name, from the context menu.
Args:
name (str): Name of the menu item (e.g. 'Open').
"""
try:
registry.deregister_context_menu(name)
self.api.delete_context_menu(name)
except AttributeError:
# it can happen when content_browser is unloaded early. This way we don't need to unsubscribe
pass
def add_listview_menu(self, name: str, glyph: str, click_fn: Callable, show_fn: Callable, index: int = -1) -> str:
"""
Add menu item, with corresponding callbacks, to the list view menu.
Args:
name (str): Name of the menu item (e.g. 'Open'), this name must be unique across the list view menu.
glyph (str): Associated glyph to display for this menu item.
click_fn (Callable): This callback function is executed when the menu item is clicked. Function signature:
void fn(name: str, path: str), where name is menu name and path is absolute path to clicked item.
show_fn (Callable): Returns True to display this menu item. Function signature: bool fn(path: str).
For example, test filename extension to decide whether to display a 'Play Sound' action.
index (int): The position that this menu item will be inserted to.
Returns:
str: Name of menu item if successful, None otherwise.
"""
if self.api:
registry.register_listview_menu(name, glyph, click_fn, show_fn, index)
return self.api.add_listview_menu(name, glyph, click_fn, show_fn, index)
return None
def delete_listview_menu(self, name: str):
"""
Delete the menu item, with the given name, from the list view menu.
Args:
name (str) - Name of the menu item (e.g. 'Open').
"""
if self.api:
registry.deregister_listview_menu(name)
self.api.delete_listview_menu(name)
def add_import_menu(self, name: str, glyph: str, click_fn: Callable, show_fn: Callable) -> str:
"""
Add menu item, with corresponding callbacks, to the Import combo box.
Args:
name (str): Name of the menu item, this name must be unique across the menu.
glyph (str): Associated glyph to display for this menu item.
click_fn (Callable): This callback function is executed when the menu item is clicked. Function signature:
void fn(name: str, path: str), where name is menu name and path is absolute path to clicked item.
show_fn (Callable): Returns True to display this menu item. Function signature: bool fn(path: str).
For example, test filename extension to decide whether to display a 'Play Sound' action.
Returns:
str: Name of menu item if successful, None otherwise.
"""
if self.api:
registry.register_import_menu(name, glyph, click_fn, show_fn)
self.api.add_import_menu(name, glyph, click_fn, show_fn)
def delete_import_menu(self, name: str):
"""
Delete the menu item, with the given name, from the Import combo box.
Args:
name (str): Name of the menu item.
"""
if self.api:
registry.deregister_import_menu(name)
self.api.delete_import_menu(name)
def add_file_open_handler(self, name: str, open_fn: Callable, file_type: Union[int, Callable]) -> str:
"""
Registers callback/handler to open a file of matching type.
Args:
name (str): Unique name of handler.
open_fn (Callable): This function is executed when a matching file is selected for open, i.e. double clicked,
right mouse menu open, or path submitted to browser bar. Function signature:
void open_fn(full_path: str), full_path is the file's system path.
file_type (Union[int, func]): Can either be an enumerated int that is one of: [FILE_TYPE_USD,
FILE_TYPE_IMAGE, FILE_TYPE_SOUND, FILE_TYPE_TEXT, FILE_TYPE_VOLUME] or a more general boolean function
that returns True if this function should be activated on the given file. Function
signature: bool file_type(full_path: str).
Returns:
str - Name if successful, None otherwise.
"""
if self.api:
registry.register_file_open_handler(name, open_fn, file_type)
return self.api.add_file_open_handler(name, open_fn, file_type)
return None
def delete_file_open_handler(self, name: str):
"""
Unregisters the named file open handler.
Args:
name (str): Name of the handler.
"""
if self._window:
registry.deregister_file_open_handler(name)
self.api.delete_file_open_handler(name)
def get_file_open_handler(self, url: str) -> Callable:
"""
Returns the matching file open handler for the given file path.
Args:
url str: The url of the file to open.
"""
if self.api:
return self.api.get_file_open_handler(url)
def set_search_delegate(self, delegate: SearchDelegate):
"""
Sets a custom search delegate for the tool bar.
Args:
delegate (SearchDelegate): Object that creates the search widget.
"""
if self.api:
registry.register_search_delegate(delegate)
self.api.set_search_delegate(delegate)
def unset_search_delegate(self, delegate: SearchDelegate):
"""
Clears the custom search delegate for the tool bar.
Args:
delegate (:obj:`SearchDelegate`): Object that creates the search widget.
"""
if self.api:
registry.deregister_search_delegate(delegate)
self.api.set_search_delegate(None)
def decorate_from_registry(self, event: carb.events.IEvent):
if not self.api:
return
try:
# Ensure event is for the content window
payload = event.payload.get_dict()
if payload.get('title') != "Content":
return
except Exception as e:
return
# Add custom menu functions
for id, args in registry.custom_menus().items():
context, name = id.split('::')
if not context or not name:
continue
if context == "context":
self.api.add_context_menu(args['name'], args['glyph'], args['click_fn'], args['show_fn'], args['index'])
elif context == "listview":
self.api.add_listview_menu(args['name'], args['glyph'], args['click_fn'], args['show_fn'], args['index'])
elif context == "import":
self.api.add_import_menu(args['name'], args['glyph'], args['click_fn'], args['show_fn'])
elif context == "file_open":
self.api.add_file_open_handler(args['name'], args['click_fn'], args['show_fn'])
else:
pass
# Add custom selection handlers
for handler in registry.selection_handlers():
self.api.subscribe_selection_changed(handler)
# Set search delegate if any
if registry.search_delegate():
self.api.set_search_delegate(registry.search_delegate())
def show_model(self, model: FileBrowserModel):
"""
Displays the given model in the list view, overriding the default model. For example, this model
might be the result of a search.
Args:
model (FileBrowserModel): Model to display.
"""
if self.api:
self.api.show_model(model)
def toggle_grid_view(self, show_grid_view: bool):
"""
Toggles file picker between grid and list view.
Args:
show_grid_view (bool): True to show grid view, False to show list view.
"""
if self._window:
self._window.widget._view.toggle_grid_view(show_grid_view)
def toggle_bookmark_from_path(self, name: str, path: str, is_bookmark: bool, is_folder: bool = True) -> bool:
"""
Adds/deletes the given bookmark with the specified path. If deleting, then the path argument
is optional.
Args:
name (str): Name to call the bookmark or existing name if delete.
path (str): Path to the bookmark.
is_bookmark (bool): True to add, False to delete.
is_folder (bool): Whether the item to be bookmarked is a folder.
Returns:
bool: True if successful.
"""
if self.api:
self.api.toggle_bookmark_from_path(name, path, is_bookmark, is_folder=is_folder)
def refresh_current_directory(self):
"""Refreshes the current directory set in the browser bar."""
if self.api:
self.api.refresh_current_directory()
def get_checkpoint_widget(self) -> 'CheckpointWidget':
"""Returns the checkpoint widget"""
if self._window:
return self._window.widget._checkpoint_widget
return None
def get_timestamp_widget(self) -> 'TimestampWidget':
"""Returns the timestamp widget"""
if self._window:
return self._window.widget._timestamp_widget
return None
def get_instance():
global g_singleton
return g_singleton
| 20,089 | Python | 37.413002 | 157 | 0.616258 |
omniverse-code/kit/exts/omni.kit.window.content_browser/omni/kit/window/content_browser/__init__.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.
#
"""A window extension for browsing filesystem, including Nucleus, content"""
__all__ = ['ContentBrowserExtension', 'get_content_window']
FILE_TYPE_USD = 1
FILE_TYPE_IMAGE = 2
FILE_TYPE_SOUND = 3
FILE_TYPE_TEXT = 4
FILE_TYPE_VOLUME = 5
SETTING_ROOT = "/exts/omni.kit.window.content_browser/"
SETTING_PERSISTENT_ROOT = "/persistent" + SETTING_ROOT
SETTING_PERSISTENT_CURRENT_DIRECTORY = SETTING_PERSISTENT_ROOT + "current_directory"
from .extension import ContentBrowserExtension, get_instance
from .window import ContentBrowserWindow
from .widget import ContentBrowserWidget
def get_content_window() -> ContentBrowserExtension:
"""Returns the singleton content_browser extension instance"""
return get_instance()
| 1,158 | Python | 37.633332 | 84 | 0.784111 |
omniverse-code/kit/exts/omni.kit.window.content_browser/omni/kit/window/content_browser/test_helper.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.ui_test as ui_test
import omni.ui as ui
import omni.kit.app
from typing import List, Dict
from omni.kit.widget.filebrowser import FileBrowserItem
from .extension import get_instance
class ContentBrowserTestHelper:
"""Test helper for the content browser window"""
async def __aenter__(self):
return self
async def __aexit__(self, *args):
pass
async def toggle_grid_view_async(self, show_grid_view: bool):
"""
Toggles the list view between the grid and tree layouts.
Args:
show_grid_view (bool): If True, set the layout to grid, otherwise tree.
"""
content_browser = get_instance()
if content_browser:
content_browser.toggle_grid_view(show_grid_view)
await ui_test.human_delay(10)
async def navigate_to_async(self, url: str):
"""
Navigates to the given url, expanding all parent directories along the path.
Args:
url (str): The url to navigate to.
"""
content_browser = get_instance()
if content_browser:
await content_browser.navigate_to_async(url)
async def get_item_async(self, url: str) -> FileBrowserItem:
"""
Retrieves an item by its url.
Args:
url (str): Url of the item.
Returns:
FileBrowserItem
"""
content_browser = get_instance()
if content_browser:
return await content_browser.api.model.find_item_async(url)
return None
async def select_items_async(self, dir_url: str, names: List[str]) -> List[FileBrowserItem]:
"""
Selects display items by their names.
Args:
dir_url (str): Url of the parent folder.
names (List[str]): Names of items to select.
Returns:
List[FileBrowserItem]: List of selected items.
"""
content_browser = get_instance()
selections = []
if content_browser:
selections = await content_browser.select_items_async(dir_url, names)
await ui_test.human_delay(10)
return selections
async def get_treeview_item_async(self, name: str) -> ui_test.query.WidgetRef:
"""
Retrieves the ui_test widget of the tree view item by name.
Args:
name (str): Label name of the widget.
Returns:
ui_test.query.WidgetRef
"""
if name:
tree_view = ui_test.find("Content//Frame/**/TreeView[*].identifier=='content_browser_treeview'")
widget = tree_view.find(f"**/Label[*].text=='{name}'")
if widget:
widget.widget.scroll_here(0.5, 0.5)
await ui_test.human_delay(10)
return widget
return None
async def get_gridview_item_async(self, name: str):
# get content window widget ref in grid view
if name:
grid_view = ui_test.find("Content//Frame/**/VGrid[*].identifier=='content_browser_treeview_grid_view'")
widget = grid_view.find(f"**/Label[*].text=='{name}'")
if widget:
widget.widget.scroll_here(0.5, 0.5)
await ui_test.human_delay(10)
return widget
return None
async def drag_and_drop_tree_view(self, url: str, names: List[str] = [], drag_target: ui_test.Vec2 = (0,0)):
"""
Drag and drop items from the tree view.
Args:
url (str): Url of the parent folder.
names (List[str]): Names of items to drag.
drag_target (ui_test.Vec2): Screen location to drop the item.
"""
await self.toggle_grid_view_async(False)
selections = await self.select_items_async(url, names)
if selections:
item = selections[-1]
widget = await self.get_treeview_item_async(item.name)
if widget:
await widget.drag_and_drop(drag_target)
for i in range(10):
await omni.kit.app.get_app().next_update_async()
async def refresh_current_directory(self):
content_browser = get_instance()
if content_browser:
content_browser.refresh_current_directory()
async def get_config_menu_settings(self) -> Dict:
"""
Returns settings from the config menu as a dictionary.
Returns:
Dict
"""
content_browser = get_instance()
if content_browser:
widget = content_browser._window._widget
config_menu = widget._tool_bar._config_menu
return config_menu.get_values()
return {}
async def set_config_menu_settings(self, settings: Dict):
"""
Writes to settings of the config menu.
"""
content_browser = get_instance()
if content_browser:
widget = content_browser._window._widget
config_menu = widget._tool_bar._config_menu
for setting, value in settings.items():
config_menu.set_value(setting, value)
# wait for window to update
await ui_test.human_delay(50)
| 5,643 | Python | 31.813953 | 115 | 0.591707 |
omniverse-code/kit/exts/omni.kit.window.content_browser/omni/kit/window/content_browser/context_menu.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.settings
from omni.kit.window.filepicker.context_menu import UdimContextMenu, CollectionContextMenu, BookmarkContextMenu, ConnectionContextMenu
from omni.kit.window.filepicker.context_menu import ContextMenu as FilePickerContextMenu
from .file_ops import *
from omni.kit.widget.filebrowser import save_items_to_clipboard, get_clipboard_items
class ContextMenu(FilePickerContextMenu):
"""
Creates popup menu for the hovered FileBrowserItem. In addition to the set of default actions below,
users can add more via the add_menu_item API.
"""
def __init__(self, **kwargs):
super().__init__(**kwargs)
try:
import omni.usd
omni_usd_supported = True
except Exception:
omni_usd_supported = False
if omni_usd_supported:
self.add_menu_item(
"Open",
"show.svg",
lambda menu, url: open_file(url),
lambda url: get_file_open_handler(url) != None,
index=0,
)
self.add_menu_item(
"Open With Payloads Disabled",
"show.svg",
lambda menu, url: open_file(url, load_all=False),
lambda url: get_file_open_handler(url) != None,
index=1,
)
self.add_menu_item(
"Open With New Edit Layer",
"external_link.svg",
lambda menu, url: open_stage_with_new_edit_layer(url),
lambda url: omni.usd.is_usd_writable_filetype(url),
index=2,
)
self.add_menu_item(
"Copy",
"copy.svg",
lambda menu, _: save_items_to_clipboard(self._context["selected"]),
# OM-94626: can't copy when select nothing
lambda url: len(self._context["selected"]) >= 1,
index=-2,
)
self.add_menu_item(
"Cut",
"none.svg",
lambda menu, _: cut_items(self._context["selected"], self._view),
lambda url: self._context["item"].writeable and len(self._context["selected"]) >= 1,
)
self.add_menu_item(
"Paste",
"copy.svg",
lambda menu, url: paste_items(self._context["item"], get_clipboard_items(), view=self._view),
lambda url: self._context["item"].is_folder and self._context["item"].writeable and\
len(self._context["selected"]) <= 1 and len(get_clipboard_items()) > 0,
index=-2,
)
self.add_menu_item(
"Download",
"cloud_download.svg",
lambda menu, _: download_items(self._context["selected"]),
# OM-94626: can't download when select nothing
lambda url: len(self._context["selected"]) >= 1 and \
carb.settings.get_settings().get_as_bool("exts/omni.kit.window.content_browser/show_download_menuitem"),
index=3,
separator_name="_placeholder_"
)
| 3,480 | Python | 39.476744 | 134 | 0.582759 |
omniverse-code/kit/exts/omni.kit.window.content_browser/omni/kit/window/content_browser/model.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 omni.client
import asyncio
from typing import Union, Callable, List, Optional
from carb import log_error, log_info
from collections import OrderedDict, namedtuple
from omni.kit.widget.filebrowser import FileBrowserItem
from omni.kit.window.filepicker import FilePickerModel, asset_types
from . import FILE_TYPE_USD, FILE_TYPE_IMAGE, FILE_TYPE_SOUND, FILE_TYPE_TEXT, FILE_TYPE_VOLUME
FileOpenAction = namedtuple("FileOpenAction", "name open_fn matching_type")
class ContentBrowserModel(FilePickerModel):
"""The model class for :obj:`ContentBrowserWidget`."""
def __init__(self, item_filter_fn=None, timeout=3.0):
super().__init__(timeout=timeout)
self._file_open_dict = OrderedDict()
self._on_selection_changed_subs = set()
self._item_filter_fn = item_filter_fn
def add_file_open_handler(self, name: str, open_fn: Callable, file_type: Union[int, Callable]) -> str:
"""
Registers callback/handler to open a file of matching type.
Args:
name (str): Unique name of handler.
open_fn (Callable): This function is executed when a matching file is selected for open, i.e. double clicked,
right mouse menu open, or url submitted to browser bar. Function signature: void open_fn(url: str).
file_type (Union[int, func]): Can either be an enumerated int that is one of: [FILE_TYPE_USD,
FILE_TYPE_IMAGE, FILE_TYPE_SOUND, FILE_TYPE_TEXT, FILE_TYPE_VOLUME] or a more general boolean function
that returns True if this function should be activated on the given file. Function
signature: bool file_type(url: str).
Returns:
str: Name if successful, None otherwise.
"""
if name:
self._file_open_dict[name] = FileOpenAction(name, open_fn, file_type)
return name
else:
return None
def delete_file_open_handler(self, name: str):
"""
Unregisters the named file open handler.
Args:
name (str): Name of the handler.
"""
if name and name in self._file_open_dict:
self._file_open_dict.pop(name)
def get_file_open_handler(self, url: str) -> Callable:
"""
Returns the matching file open handler for the given item.
Args:
url str: The url of the item to open.
"""
if not url:
return None
broken_url = omni.client.break_url(url)
# Note: It's important that we use an ordered dict so that we can search by order
# of insertion.
for _, tup in self._file_open_dict.items():
_, open_fn, file_type = tup
if isinstance(file_type, Callable):
if file_type(broken_url.path):
return open_fn
else:
asset_type = {
FILE_TYPE_USD: asset_types.ASSET_TYPE_USD,
FILE_TYPE_IMAGE: asset_types.ASSET_TYPE_IMAGE,
FILE_TYPE_SOUND: asset_types.ASSET_TYPE_SOUND,
FILE_TYPE_TEXT: asset_types.ASSET_TYPE_SCRIPT,
FILE_TYPE_VOLUME: asset_types.ASSET_TYPE_VOLUME,
}.get(file_type, None)
if asset_type and asset_types.is_asset_type(broken_url.path, asset_type):
return open_fn
return None
async def open_stage_async(self, url: str, open_loadset=omni.usd.UsdContextInitialLoadSet.LOAD_ALL):
"""
Async function for opening a USD file.
Args:
url (str): Url to file.
"""
try:
import omni.kit.window.file
omni.kit.window.file.open_stage(url, open_loadset)
except Exception as e:
log_error(str(e))
else:
log_info(f"Success! Opened '{url}'.\n")
async def open_with_new_edit_layer(self, url: str, open_loadset=omni.usd.UsdContextInitialLoadSet.LOAD_ALL):
"""
Async function for opening a USD file, then creating a new layer.
Args:
url (str): Url to file.
"""
try:
import omni.kit.window.file
omni.kit.window.file.open_with_new_edit_layer(url, open_loadset)
except Exception as e:
log_error(str(e))
else:
log_info(f"Success! Opened '{url}' with new edit layer.\n")
def download_items_with_callback(self, src_urls: List[str], dst_urls: List[str], callback: Optional[Callable] = None):
"""
Downloads specified items. Upon success, executes the given callback.
Args:
src_urls (List[str]): Paths of items to download.
dst_urls (List[str]): Destination paths.
callback (Callable): Callback to execute upon success. Function signature is void callback([str]).
Raises:
:obj:`Exception`
"""
try:
self.copy_items_with_callback(src_urls, dst_urls, callback=callback)
except Exception:
raise
def subscribe_selection_changed(self, fn: Callable):
"""
Subscribes to file selection changes.
Args:
fn (Callable): callback function when file selection changed.
"""
self._on_selection_changed_subs.add(fn)
def unsubscribe_selection_changed(self, fn: Callable):
"""
Unsubscribes this callback from selection changes.
Args:
fn (Callable): callback function when file selection changed.
"""
if fn in self._on_selection_changed_subs:
self._on_selection_changed_subs.remove(fn)
def notify_selection_subs(self, pane: int, selected: [FileBrowserItem]):
for fn in self._on_selection_changed_subs or []:
async def async_cb(pane: int, selected: [FileBrowserItem]):
# Making sure callback was not removed between async schedule/execute
if fn in self._on_selection_changed_subs:
fn(pane, selected)
asyncio.ensure_future(async_cb(pane, selected))
def destroy(self):
super().destroy()
if self._file_open_dict:
self._file_open_dict.clear()
self._file_open_dict = None
if self._on_selection_changed_subs:
self._on_selection_changed_subs.clear()
self._on_selection_changed_subs = None
| 6,889 | Python | 35.455026 | 122 | 0.608797 |
omniverse-code/kit/exts/omni.kit.window.content_browser/omni/kit/window/content_browser/prompt.py | import omni
import omni.ui as ui
from .style import ICON_PATH
class Prompt:
def __init__(
self,
title,
text,
content_buttons,
modal=False,
):
self._title = title
self._text = text
self._content_buttons = content_buttons
self._modal = modal
self._buttons = []
self._build_ui()
def __del__(self):
for button in self._buttons:
button.set_clicked_fn(None)
self._buttons.clear()
def show(self):
self._window.visible = True
def hide(self):
self._window.visible = False
def is_visible(self):
return self._window.visible
def _build_ui(self):
import carb.settings
self._window = ui.Window(
self._title, visible=False, height=0, dockPreference=ui.DockPreference.DISABLED
)
self._window.flags = (
ui.WINDOW_FLAGS_NO_COLLAPSE
| ui.WINDOW_FLAGS_NO_RESIZE
| ui.WINDOW_FLAGS_NO_SCROLLBAR
| ui.WINDOW_FLAGS_NO_RESIZE
| ui.WINDOW_FLAGS_NO_MOVE
)
if self._modal:
self._window.flags = self._window.flags | ui.WINDOW_FLAGS_MODAL
theme = carb.settings.get_settings().get_as_string("/persistent/app/window/uiStyle") or "NvidiaDark"
button_style = {
"Button": {"stack_direction": ui.Direction.LEFT_TO_RIGHT},
"Button.Image": {"alignment": ui.Alignment.CENTER},
"Button.Label": {"alignment": ui.Alignment.LEFT_CENTER}
}
def button_cliked_fn(button_fn):
if button_fn:
button_fn()
self.hide()
with self._window.frame:
with ui.VStack(height=0):
ui.Spacer(width=0, height=10)
if self._text:
with ui.HStack(height=0):
ui.Spacer()
self._text_label = ui.Label(self._text, word_wrap=True, width=self._window.width - 80, height=0)
ui.Spacer()
ui.Spacer(width=0, height=10)
with ui.VStack(height=0):
ui.Spacer(height=0)
for button in self._content_buttons:
(button_text, button_icon, button_fn) = button
with ui.HStack():
ui.Spacer(width=40)
ui_button = ui.Button(
" " + button_text,
image_url=f"{ICON_PATH}/{button_icon}",
image_width=24,
height=40,
clicked_fn=lambda a=button_fn: button_cliked_fn(a),
style=button_style
)
ui.Spacer(width=40)
ui.Spacer(height=5)
self._buttons.append(ui_button)
ui.Spacer(height=5)
with ui.HStack():
ui.Spacer()
cancel_button = ui.Button("Cancel", width=80, height=0)
cancel_button.set_clicked_fn(lambda: self.hide())
self._buttons.append(cancel_button)
ui.Spacer(width=40)
ui.Spacer(height=0)
ui.Spacer(width=0, height=10)
| 3,461 | Python | 33.969697 | 120 | 0.469806 |
omniverse-code/kit/exts/omni.kit.window.content_browser/omni/kit/window/content_browser/api.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 asyncio
from typing import List, Callable, Union
from omni.kit.window.filepicker import FilePickerAPI
from omni.kit.widget.filebrowser import FileBrowserItem
from .file_ops import add_file_open_handler, delete_file_open_handler, get_file_open_handler
class ContentBrowserAPI(FilePickerAPI):
"""This class defines the API methods for :obj:`ContentBrowserWidget`."""
def __init__(self):
super().__init__()
self._on_selection_changed_subs = set()
def add_import_menu(self, name: str, glyph: str, click_fn: Callable, show_fn: Callable) -> str:
"""
Adds menu item, with corresponding callbacks, to the Import combo box.
Args:
name (str): Name of the menu item, this name must be unique across the menu.
glyph (str): Associated glyph to display for this menu item.
click_fn (Callable): This callback function is executed when the menu item is clicked. Function signature:
void fn(name: str, path: str), where name is menu name and path is absolute path to clicked item.
show_fn (Callable): Returns True to display this menu item. Function signature: bool fn(path: str).
For example, test filename extension to decide whether to display a 'Play Sound' action.
Returns:
str: Name of menu item if successful, None otherwise.
"""
if self.tool_bar:
import_menu = self.tool_bar.import_menu
if import_menu:
return import_menu.add_menu_item(name, glyph, click_fn, show_fn)
return None
def delete_import_menu(self, name: str):
"""
Deletes the menu item, with the given name, from the Import combo box.
Args:
name (str): Name of the menu item.
"""
if self.tool_bar:
import_menu = self.tool_bar.import_menu
if import_menu:
import_menu.delete_menu_item(name)
def add_file_open_handler(self, name: str, open_fn: Callable, file_type: Union[int, Callable]) -> str:
"""
Registers callback/handler to open a file of matching type.
Args:
name (str): Unique name of handler.
open_fn (Callable): This function is executed when a matching file is selected for open, i.e. double clicked,
right mouse menu open, or path submitted to browser bar. Function signature:
void open_fn(full_path: str), full_path is the file's system path.
file_type (Union[int, func]): Can either be an enumerated int that is one of: [FILE_TYPE_USD,
FILE_TYPE_IMAGE, FILE_TYPE_SOUND, FILE_TYPE_TEXT, FILE_TYPE_VOLUME] or a more general boolean function
that returns True if this function should be activated on the given file. Function
signature: bool file_type(full_path: str).
Returns:
str: Name if successful, None otherwise.
"""
return add_file_open_handler(name, open_fn, file_type)
def delete_file_open_handler(self, name: str):
"""
Unregisters the named file open handler.
Args:
name (str): Name of the handler.
"""
delete_file_open_handler(name)
def get_file_open_handler(self, url: str) -> Callable:
"""
Returns the matching file open handler for the given file path.
Args:
url str: The url of the file to open.
"""
return get_file_open_handler(url)
def subscribe_selection_changed(self, fn: Callable):
"""
Subscribes to file selection changes.
Args:
fn (Callable): callback function when file selection changed.
"""
self._on_selection_changed_subs.add(fn)
def unsubscribe_selection_changed(self, fn: Callable):
"""
Unsubscribe this callback from selection changes.
Args:
fn (Callable): callback function when file selection changed.
"""
if fn in self._on_selection_changed_subs:
self._on_selection_changed_subs.remove(fn)
def _notify_selection_subs(self, pane: int, selected: List[FileBrowserItem]):
for fn in self._on_selection_changed_subs or []:
async def async_cb(pane: int, selected: List[FileBrowserItem]):
# Making sure callback was not removed between async schedule/execute
if fn in self._on_selection_changed_subs:
fn(pane, selected)
asyncio.ensure_future(async_cb(pane, selected))
def destroy(self):
super().destroy()
if self._on_selection_changed_subs:
self._on_selection_changed_subs.clear()
| 5,183 | Python | 37.977443 | 121 | 0.634382 |
omniverse-code/kit/exts/omni.kit.window.content_browser/omni/kit/window/content_browser/tool_bar.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 Optional
import omni.ui as ui
from omni.kit.window.filepicker import ToolBar as FilePickerToolBar, BaseContextMenu
from omni.kit.widget.filebrowser import FileBrowserItem
from omni.kit.widget.options_menu import OptionsModel, OptionItem
from omni.kit.widget.filter import FilterButton
from .style import get_style, ICON_PATH
class ImportMenu(BaseContextMenu):
def __init__(self, **kwargs):
super().__init__(title="Import menu", **kwargs)
self._menu_dict = []
self._offset_x = kwargs.get("offset_x", -1)
self._offset_y = kwargs.get("offset_y", 1)
def show_relative(self, parent: ui.Widget, item: Optional[FileBrowserItem] = None):
if item and len(self._menu_dict) > 0:
self.show(item)
if parent:
self.menu.show_at(
parent.screen_position_x + self._offset_x,
parent.screen_position_y + parent.computed_height + self._offset_y,
)
def destroy(self):
super().destroy()
self._menu_dict = []
class ToolBar(FilePickerToolBar):
def __init__(self, **kwargs):
self._import_button = None
self._import_menu = None
self._filter_button = None
self._filter_values_changed_handler = kwargs.get("filter_values_changed_handler", None)
self._import_menu = kwargs.pop("import_menu", ImportMenu())
super().__init__(**kwargs)
def _build_ui(self):
with ui.HStack(height=0, style=get_style(), style_type_name_override="ToolBar"):
with ui.VStack(width=0):
ui.Spacer()
self._import_button = ui.Button(
"Import ",
image_url=f"{ICON_PATH}/plus.svg",
image_width=12,
height=24,
spacing=4,
style_type_name_override="ToolBar.Button",
name="import",
)
self._import_button.set_clicked_fn(
lambda: self._import_menu
and self._import_menu.show_relative(self._import_button, self._current_directory_provider())
)
ui.Spacer()
super()._build_ui()
def _build_widgets(self):
ui.Spacer(width=2)
self._build_filter_button()
def _build_filter_button(self):
filter_items = [
OptionItem("audio", text="Audio"),
OptionItem("materials", text="Materials"),
OptionItem("scripts", text="Scripts"),
OptionItem("textures", text="Textures"),
OptionItem("usd", text="USD"),
OptionItem("volumes", text="Volumes"),
]
with ui.VStack(width=0):
ui.Spacer()
self._filter_button = FilterButton(filter_items, menu_width=150)
ui.Spacer()
def on_filter_changed(model: OptionsModel, _):
if self._filter_values_changed_handler:
values = {}
for item in self._filter_button.model.get_item_children():
values[item.name] = item.value
self._filter_values_changed_handler(values)
self.__sub_filter = self._filter_button.model.subscribe_item_changed_fn(on_filter_changed)
@property
def import_menu(self):
return self._import_menu
@property
def filter_values(self):
if self._filter_button:
values = {}
for item in self._filter_button.model.get_item_children():
values[item.name] = item.value
return values
return {}
def destroy(self):
super().destroy()
self._import_button = None
if self._filter_button:
self.__sub_filter = None
self._filter_button.destroy()
self._filter_button = None
self._filter_values_changed_handler = None
| 4,393 | Python | 35.616666 | 112 | 0.581152 |
omniverse-code/kit/exts/omni.kit.window.content_browser/omni/kit/window/content_browser/widget.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 os
import omni.kit.app
import carb
import carb.settings
import omni.client
from typing import List, Dict
from omni.kit.helper.file_utils import asset_types
from omni.kit.window.filepicker import FilePickerWidget
from omni.kit.widget.filebrowser import FileBrowserItem, LISTVIEW_PANE
from omni.kit.widget.versioning import CheckpointModel, CheckpointItem
from .api import ContentBrowserAPI
from .context_menu import ContextMenu, UdimContextMenu, CollectionContextMenu, BookmarkContextMenu, ConnectionContextMenu
from .tool_bar import ToolBar
from .file_ops import get_file_open_handler, open_file, open_stage, drop_items
from . import FILE_TYPE_USD, SETTING_ROOT, SETTING_PERSISTENT_CURRENT_DIRECTORY
# Any class derived from `omni.ext.IExt` in top level module (defined in `python.modules` of `extension.toml`) will be
# instantiated when extension gets enabled and `on_startup(ext_id)` will be called. Later when extension gets disabled
# on_shutdown() is called.
class ContentBrowserWidget(FilePickerWidget):
"""The Content Browser widget"""
def __init__(self, **kwargs):
# Retrieve settings
settings = carb.settings.get_settings()
# OM-75244: Remember the last browsed directory upon Content Browser open
kwargs["treeview_identifier"] = kwargs.get('treeview_identifier', None)
kwargs["settings_root"] = SETTING_ROOT
kwargs["enable_checkpoints"] = settings.get_as_bool("exts/omni.kit.window.content_browser/enable_checkpoints")
kwargs["enable_timestamp"] = settings.get_as_bool("exts/omni.kit.window.content_browser/enable_timestamp")
kwargs["show_only_collections"] = settings.get("exts/omni.kit.window.content_browser/show_only_collections")
# Hard-coded configs
kwargs["allow_multi_selection"] = True
kwargs["enable_file_bar"] = False
kwargs["drop_handler"] = lambda dst, src: drop_items(dst, [src])
kwargs["item_filter_fn"] = self._item_filter_fn
# OM-77963: Make use of environment variable to disable check for soft-delete features in Content Browser
kwargs["enable_soft_delete"] = True if os.getenv("OMNI_FEATURE_SOFT_DELETE", "0") == "1" else False
# Additional fields
self._visible_asset_types = []
# Inject cusdtomized API
kwargs["api"] = ContentBrowserAPI()
# Initialize and build the widget
super().__init__("Content", **kwargs)
def destroy(self):
super().destroy()
if self._visible_asset_types:
self._visible_asset_types.clear()
self._visible_asset_types = None
def _build_tool_bar(self):
"""Overrides base builder, injects custom tool bar"""
self._tool_bar = ToolBar(
visited_history_size=20,
current_directory_provider=lambda: self._view.get_root(LISTVIEW_PANE),
branching_options_handler=self._api.find_subdirs_with_callback,
apply_path_handler=self._open_and_navigate_to,
toggle_bookmark_handler=self._api.toggle_bookmark_from_path,
config_values_changed_handler=lambda _: self._apply_config_options(),
filter_values_changed_handler=lambda _: self._apply_filter_options(),
begin_edit_handler=self._on_begin_edit,
prefix_separator="://",
search_delegate=self._default_search_delegate,
enable_soft_delete=self._enable_soft_delete,
)
def _build_checkpoint_widget(self):
"""Overrides base builder, adds items to context menu"""
super()._build_checkpoint_widget()
# Add context menu to checkpoints
def on_restore_checkpoint(cp: CheckpointItem, model: CheckpointModel):
path = model.get_url()
restore_path = path + "?" + cp.entry.relative_path
model.restore_checkpoint(path, restore_path)
# Create checkpoints context menu
self._checkpoint_widget.add_context_menu(
"Open",
"show.svg",
lambda menu, cp: (open_file(cp.get_full_url()) if cp else None),
None,
index=0,
)
self._checkpoint_widget.add_context_menu(
"Open With Payloads Disabled",
"show.svg",
lambda menu, cp: (open_file(cp.get_full_url(), load_all=False) if cp else None),
None,
index=1,
)
self._checkpoint_widget.add_context_menu(
"", "", None, None,
index=98,
)
self._checkpoint_widget.add_context_menu(
"Restore Checkpoint",
"restore.svg",
lambda menu, cp: on_restore_checkpoint(cp, self._checkpoint_widget._model),
lambda menu, cp: 1 if (cp and cp.get_relative_path()) else 0,
index=99,
)
# Open checkpoint file on double click
self._checkpoint_widget.set_mouse_double_clicked_fn(
lambda b, k, cp: (open_file(cp.get_full_url()) if cp else None))
def _build_context_menus(self):
"""Overrides base builder, injects custom context menus"""
self._context_menus = dict()
self._context_menus['item'] = ContextMenu(view=self._view, checkpoint=self._checkpoint_widget)
self._context_menus['list_view'] = ContextMenu(view=self._view, checkpoint=self._checkpoint_widget)
self._context_menus['collection'] = CollectionContextMenu(view=self._view)
self._context_menus['connection'] = ConnectionContextMenu(view=self._view)
self._context_menus['bookmark'] = BookmarkContextMenu(view=self._view)
self._context_menus['udim'] = UdimContextMenu(view=self._view)
# Register open handler for usd files
if self._api:
self._api.add_file_open_handler("usd", open_stage, FILE_TYPE_USD)
def _get_mounted_servers(self) -> Dict:
"""Overrides base getter, returns mounted server dict from settings"""
# OM-85963 Fixes flaky unittest: test_mount_default_servers. Purposely made this a function in order to inject test data.
settings = carb.settings.get_settings()
mounted_servers = {}
try:
mounted_servers = settings.get_settings_dictionary("exts/omni.kit.window.content_browser/mounted_servers").get_dict()
except Exception:
pass
# OM-71835: Auto-connect server specified in the setting. We normally don't make the connection on startup
# due to possible delays; however, we make this exception to facilitate the streaming workflows.
return mounted_servers, True
def _on_mouse_double_clicked(self, pane: int, button: int, key_mod: int, item: FileBrowserItem):
if not item:
return
if button == 0 and not item.is_folder:
if self._timestamp_widget:
url = self._timestamp_widget.get_timestamp_url(item.path)
else:
url = item.path
open_file(url)
def _on_selection_changed(self, pane: int, selected: List[FileBrowserItem] = []):
super()._on_selection_changed(pane, selected)
if self._api:
self._api._notify_selection_subs(pane, selected)
# OM-75244: record the last browsed directory
settings = carb.settings.get_settings()
settings.set(SETTING_PERSISTENT_CURRENT_DIRECTORY, self._current_directory)
def _open_and_navigate_to(self, url: str):
if not url:
return
# Make sure url is normalized before trying to open as file.
url = omni.client.normalize_url(url.strip())
if get_file_open_handler(url):
# If there's a suitable file open handler then execute in a separate thread
open_file(url)
# Navigate to the file location
self._api.navigate_to(url)
def _apply_filter_options(self):
map_filter_options = {
"audio": asset_types.ASSET_TYPE_SOUND,
"materials": asset_types.ASSET_TYPE_MATERIAL,
"scripts": asset_types.ASSET_TYPE_SCRIPT,
"textures": asset_types.ASSET_TYPE_IMAGE,
"usd": asset_types.ASSET_TYPE_USD,
"volumes": asset_types.ASSET_TYPE_VOLUME,
}
visible_types = []
settings = self._tool_bar.filter_values
for label, visible in settings.items():
if visible:
visible_types.append(map_filter_options[label])
self._visible_asset_types = visible_types
self._refresh_ui()
def _item_filter_fn(self, item: FileBrowserItem) -> bool:
"""
Default item filter callback. Returning True means the item is visible.
Args:
item (:obj:`FileBrowseritem`): Item in question.
Returns:
bool
"""
# Show items of unknown asset types?
asset_type = asset_types.get_asset_type(item.path)
if not self._visible_asset_types:
# Visible asset types not specified
if asset_type == asset_types.ASSET_TYPE_UNKNOWN:
return self._show_unknown_asset_types
else:
return True
return asset_type in self._visible_asset_types
| 9,631 | Python | 42.192825 | 130 | 0.643028 |
omniverse-code/kit/exts/omni.kit.window.content_browser/omni/kit/window/content_browser/file_ops.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 os
import asyncio
import omni.client
import carb.settings
import omni.kit.notification_manager
import omni.kit.app
from typing import Callable, List, Union
from datetime import datetime
from functools import lru_cache, partial
from collections import OrderedDict, namedtuple
from carb import log_warn, log_info
from typing import Callable, List
from omni.kit.helper.file_utils import asset_types
from omni.kit.widget.filebrowser import FileBrowserItem, is_clipboard_cut, save_items_to_clipboard, clear_clipboard
from omni.kit.widget.filebrowser.model import FileBrowserItemFields
from omni.kit.window.file_exporter import get_file_exporter
from omni.kit.window.filepicker.item_deletion_dialog import ConfirmItemDeletionDialog
from omni.kit.window.filepicker.utils import get_user_folders_dict
from omni.kit.window.filepicker.view import FilePickerView
from omni.kit.window.filepicker.file_ops import *
from .prompt import Prompt
from . import FILE_TYPE_USD, FILE_TYPE_IMAGE, FILE_TYPE_SOUND, FILE_TYPE_TEXT, FILE_TYPE_VOLUME
FileOpenAction = namedtuple("FileOpenAction", "name open_fn matching_type")
_file_open_dict = OrderedDict()
@lru_cache()
def __get_input() -> carb.input.IInput:
return carb.input.acquire_input_interface()
def _is_ctrl_down() -> bool:
input = __get_input()
return (
input.get_keyboard_value(None, carb.input.KeyboardInput.LEFT_CONTROL)
+ input.get_keyboard_value(None, carb.input.KeyboardInput.RIGHT_CONTROL)
> 0
)
def add_file_open_handler(name: str, open_fn: Callable, file_type: Union[int, Callable]) -> str:
"""
Registers callback/handler to open a file of matching type.
Args:
name (str): Unique name of handler.
open_fn (Callable): This function is executed when a matching file is selected for open, i.e. double clicked,
right mouse menu open, or url submitted to browser bar. Function signature: void open_fn(url: str).
file_type (Union[int, func]): Can either be an enumerated int that is one of: [FILE_TYPE_USD,
FILE_TYPE_IMAGE, FILE_TYPE_SOUND, FILE_TYPE_TEXT, FILE_TYPE_VOLUME] or a more general boolean function
that returns True if this function should be activated on the given file. Function
signature: bool file_type(url: str).
Returns:
str: Name if successful, None otherwise.
"""
global _file_open_dict
if name:
_file_open_dict[name] = FileOpenAction(name, open_fn, file_type)
return name
else:
return None
def delete_file_open_handler(name: str):
"""
Unregisters the named file open handler.
Args:
name (str): Name of the handler.
"""
global _file_open_dict
if name and name in _file_open_dict:
_file_open_dict.pop(name)
def get_file_open_handler(url: str) -> Callable:
"""
Returns the matching file open handler for the given item.
Args:
url str: The url of the item to open.
"""
if not url:
return None
broken_url = omni.client.break_url(url)
# Note: It's important that we use an ordered dict so that we can search by order
# of insertion.
global _file_open_dict
for _, tup in _file_open_dict.items():
_, open_fn, file_type = tup
if isinstance(file_type, Callable):
if file_type(broken_url.path):
return open_fn
else:
asset_type = {
FILE_TYPE_USD: asset_types.ASSET_TYPE_USD,
FILE_TYPE_IMAGE: asset_types.ASSET_TYPE_IMAGE,
FILE_TYPE_SOUND: asset_types.ASSET_TYPE_SOUND,
FILE_TYPE_TEXT: asset_types.ASSET_TYPE_SCRIPT,
FILE_TYPE_VOLUME: asset_types.ASSET_TYPE_VOLUME,
}.get(file_type, None)
if asset_type and asset_types.is_asset_type(broken_url.path, asset_type):
return open_fn
return None
def copy_items(dst_item: FileBrowserItem, src_paths: List[str]):
try:
from omni.kit.notification_manager import post_notification
except Exception:
post_notification = log_warn
if dst_item and src_paths:
try:
def on_copied(results):
for result in results:
if isinstance(result, Exception):
post_notification(str(result))
# prepare src_paths and dst_paths for copy items
dst_paths = []
dst_root = dst_item.path
for src_path in src_paths:
rel_path = os.path.basename(src_path)
dst_paths.append(f"{dst_root}/{rel_path}")
copy_items_with_callback(src_paths, dst_paths, on_copied)
except Exception as e:
log_warn(f"Error encountered during copy: {str(e)}")
def copy_items_with_callback(src_paths: List[str], dst_paths: List[str], callback: Callable = None, copy_callback: Callable[[str, str, omni.client.Result], None] = None):
"""
Copies items. Upon success, executes the given callback.
Args:
src_pathss ([str]): Paths of items to download.
dst_paths ([str]): Destination paths.
callback (func): Callback to execute upon success. Function signature is void callback(List[Union[Exception, str]).
copy_callback (func): Callback per every copy. Function signature is void callback([str, str, omni.client.Result]).
Raises:
:obj:`Exception`
"""
if not (dst_paths and src_paths):
return
tasks = []
# should not get here, but just to be safe, if src_paths and dst_paths are not of the same length, don't copy
if len(src_paths) != len(dst_paths):
carb.log_warn(
f"Cannot copy items from {src_paths} to {dst_paths}, source and destination paths should match in number.")
return
for src_path, dst_path in zip(src_paths, dst_paths):
tasks.append(copy_item_async(src_path, dst_path, callback=copy_callback))
try:
asyncio.ensure_future(exec_tasks_async(tasks, callback=callback))
except Exception:
raise
async def copy_item_async(src_path: str, dst_path: str, timeout: float = 300.0, callback: Callable[[str, str, omni.client.Result], None] = None) -> str:
"""
Async function. Copies item (recursively) from one path to another. Note: this function simply
uses the copy function from omni.client and makes no attempt to optimize for copying from one
Omniverse server to another. For that, use the Copy Service. Example usage:
await copy_item_async("my_file.usd", "C:/tmp", "omniverse://ov-content/Users/me")
Args:
src_path (str): Source path to item being copied.
dst_path (str): Destination path to copy the item.
timeout (float): Number of seconds to try before erroring out. Default 10.
callback (func): Callback to copy result.
Returns:
str: Destination path name
Raises:
:obj:`RuntimeWarning`: If error or timeout.
"""
if isinstance(timeout, (float, int)):
timeout = max(300, timeout)
try:
# OM-67900: add source url in copied item checkpoint
src_checkpoint = None
result, entries = await omni.client.list_checkpoints_async(src_path)
if result == omni.client.Result.OK and entries:
src_checkpoint = entries[-1].relative_path
checkpoint_msg = f"Copied from {src_path}"
if src_checkpoint:
checkpoint_msg = f"{checkpoint_msg}?{src_checkpoint}"
result, _ = await omni.client.stat_async(dst_path)
if result == omni.client.Result.OK:
dst_name = os.path.basename(dst_path)
async def on_overwrite(dialog):
result = await asyncio.wait_for(
omni.client.copy_async(
src_path,
dst_path,
behavior=omni.client.CopyBehavior.OVERWRITE,
message=checkpoint_msg),
timeout=timeout)
if callback:
callback(src_path, dst_path, result)
dialog.hide()
def on_cancel(dialog):
dialog.hide()
dialog = ConfirmItemDeletionDialog(
title="Confirm File Overwrite",
message="You are about to overwrite",
items=[FileBrowserItem(dst_path, FileBrowserItemFields(dst_name, datetime.now(), 0, 0), is_folder=False)],
ok_handler=lambda dialog: asyncio.ensure_future(on_overwrite(dialog)),
cancel_handler=lambda dialog: on_cancel(dialog),
)
dialog.show()
else:
result = await asyncio.wait_for(omni.client.copy_async(src_path, dst_path, message=checkpoint_msg), timeout=timeout)
if callback:
callback(src_path, dst_path, result)
except asyncio.TimeoutError:
raise RuntimeWarning(f"Error unable to copy '{src_path}' to '{dst_path}': Timed out after {timeout} secs.")
except Exception as e:
raise RuntimeWarning(f"Error copying '{src_path}' to '{dst_path}': {e}")
if result != omni.client.Result.OK:
raise RuntimeWarning(f"Error copying '{src_path}' to '{dst_path}': {result}")
return dst_path
def drop_items(dst_item: FileBrowserItem, src_paths: List[str], callback: Callable = None):
# src_paths is a list of str but when multiple items are selected, the str was a \n joined path string, so
# we need to re-construct the src_paths
paths = src_paths[0].split("\n")
# remove any udim_sequence as that are not real files
for path in paths.copy():
if asset_types.is_udim_sequence(path):
paths.remove(path)
if not paths:
return
# OM-52387: drag and drop is now move instead of copy;
# Additionally, drag with ctrl down would be copy similar to windows file explorer
if _is_ctrl_down():
copy_items(dst_item, paths)
else:
# warn user for move operation since it will overwrite items with the same name in the dst folder
from omni.kit.window.popup_dialog import MessageDialog
def on_okay(dialog: MessageDialog, dst_item: FileBrowserItem, paths: List[str], callback: Callable=None):
move_items(dst_item, paths, callback=callback)
dialog.hide()
warning_msg = f"This will replace any file with the same name in {dst_item.path}."
dialog = MessageDialog(
title="MOVE",
message="Do you really want to move these files?",
warning_message=warning_msg,
ok_handler=lambda dialog, dst_item=dst_item, paths=paths, callback=callback: on_okay(
dialog, dst_item, paths, callback),
ok_label="Confirm",
)
dialog.show()
def cut_items(src_items: List[FileBrowserItem], view: FilePickerView):
if not src_items:
return
save_items_to_clipboard(src_items, is_cut=True)
# to maintain the left treeview pane selection, only update listview for filebrowser
view._filebrowser.refresh_ui(listview_only=True)
def paste_items(dst_item: FileBrowserItem, src_items: List[FileBrowserItem], view: FilePickerView):
src_paths = [item.path for item in src_items]
# if currently the clipboard is for cut operation, then use move
if is_clipboard_cut():
def _on_cut_pasted(dst_item, src_items, view):
# sync up item changes for src and dst items
to_update = set([dst_item])
for item in src_items:
to_update.add(item.parent)
for item in to_update:
view._filebrowser._models.sync_up_item_changes(item)
# clear clipboard and update item style
clear_clipboard()
view._filebrowser.refresh_ui(listview_only=True)
drop_items(dst_item, ["\n".join(src_paths)], callback=lambda: _on_cut_pasted(dst_item, src_items, view))
# else use normal copy
else:
copy_items(dst_item, src_paths)
def open_file(url: str, load_all=True):
async def open_file_async(open_fn: Callable, url: str, load_all=True):
result, entry = await omni.client.stat_async(url)
if result == omni.client.Result.OK:
# OM-57423: Make sure this is not a folder
is_folder = (entry.flags & omni.client.ItemFlags.CAN_HAVE_CHILDREN) > 0
if is_folder:
return
if open_fn:
import inspect
sig = inspect.signature(open_fn)
if sig and "load_all" in sig.parameters:
if asyncio.iscoroutinefunction(open_fn):
await open_fn(url, load_all)
else:
open_fn(url, load_all)
return
if asyncio.iscoroutinefunction(open_fn):
await open_fn(url)
else:
open_fn(url)
open_fn = get_file_open_handler(url)
if open_fn:
asyncio.ensure_future(open_file_async(open_fn, url, load_all))
# Register file open handler for USD's
def open_stage(url, load_all=True):
result, entry = omni.client.stat(url)
if result == omni.client.Result.OK:
read_only = entry.access & omni.client.AccessFlags.WRITE == 0
else:
read_only = False
if read_only:
def _open_with_edit_layer():
open_stage_with_new_edit_layer(url, load_all)
def _open_original_stage():
asyncio.ensure_future(open_stage_async(url, load_all))
_show_readonly_usd_prompt(_open_with_edit_layer, _open_original_stage)
else:
asyncio.ensure_future(open_stage_async(url, load_all))
async def open_stage_async(url: str, load_all=True):
"""
Async function for opening a USD file.
Args:
url (str): Url to file.
"""
try:
import omni.kit.window.file
if load_all:
open_loadset = omni.usd.UsdContextInitialLoadSet.LOAD_ALL
else:
open_loadset = omni.usd.UsdContextInitialLoadSet.LOAD_NONE
omni.kit.window.file.open_stage(url, open_loadset)
except Exception as e:
log_warn(str(e))
else:
log_info(f"Success! Opened '{url}'.\n")
def open_stage_with_new_edit_layer(url: str, load_all=True):
"""
Async function for opening a USD file, then creating a new layer.
Args:
url (str): Url to file.
"""
try:
import omni.usd
import omni.kit.window.file
if load_all:
open_loadset = omni.usd.UsdContextInitialLoadSet.LOAD_ALL
else:
open_loadset = omni.usd.UsdContextInitialLoadSet.LOAD_NONE
omni.kit.window.file.open_with_new_edit_layer(url, open_loadset)
except Exception as e:
log_warn(str(e))
else:
log_info(f"Success! Opened '{url}' with new edit layer.\n")
def download_items(selections: List[FileBrowserItem]):
if not selections:
return
def on_download(src_items: List[FileBrowserItem], filename: str, dirname: str):
if ':/' in filename or filename.startswith('\\\\'):
# Filename is a pasted fullpath. The first test finds paths that start with 'C:/' or 'omniverse://';
# the second finds MS network paths that start like '\\analogfs\VENDORS\...'
dst_root = os.path.dirname(filename)
else:
dst_root = os.path.dirname(f"{(dirname or '').rstrip('/')}/{filename}")
# OM-65721: When downloading a single item, should use the filename provided
dst_name = None
# for single item, rename by user input
if len(src_items) == 1:
dst_name = os.path.basename(filename)
_, src_ext = os.path.splitext(src_items[0].path)
# make sure ext is included if user didn't input it
# TODO: here the assumption is that we don't want to download a file as another file format, so
# appending if the filename input didn't end with the current ext
if not dst_name.endswith(src_ext):
dst_name = dst_name + src_ext
if src_items and dst_root:
# prepare src_paths and dst_paths for download items
src_paths = []
dst_paths = []
for src_item in src_items:
src_paths.append(src_item.path)
dst_root = dst_root.rstrip("/")
if dst_name:
dst_path = f"{dst_root}/{dst_name}"
# if not specified, or user typed in an empty name, use the source path basename instead
else:
dst_path = f"{dst_root}/{os.path.basename(src_item.path)}"
dst_paths.append(dst_path)
try:
# Callback to handle exceptions
def __notify(results: List[Union[Exception, str]]):
for result in results:
if isinstance(result, Exception):
omni.kit.notification_manager.post_notification(str(result))
# Callback to handle copy result
def __copy_notify(src: str, dst: str, result: omni.client.Result):
if result == omni.client.Result.OK:
omni.kit.notification_manager.post_notification(f"{src} downloaded")
else:
omni.kit.notification_manager.post_notification(f"Error copying '{src}' to '{dst}': {result}")
copy_items_with_callback(src_paths, dst_paths, callback=__notify, copy_callback=__copy_notify)
except Exception as e:
log_warn(f"Error encountered during download: {str(e)}")
file_exporter = get_file_exporter()
if file_exporter:
# OM-65721: Pre-populate the filename field for download; use original file/folder name for single selection
# and "<multiple selected>" to indicate multiple items are selected (in this case downloaded item will use)
# their source names
# TODO: Is it worth creating a constant (either on this class or in this module) for this?
selected_filename = "<multiple selected>"
is_single_selection = len(selections) == 1
if is_single_selection:
_, selected_filename = os.path.split(selections[0].path)
# OM-73142: Resolve to the actual download directory
download_dir = get_user_folders_dict().get("Downloads", "")
file_exporter.show_window(
title="Download Files",
show_only_collections=["my-computer"],
file_postfix_options=[None],
file_extension_types=[("*", "All files")],
export_button_label="Save",
export_handler=lambda filename, dirname, **kwargs: on_download(selections, filename, dirname),
filename_url=f"{download_dir}/{selected_filename}",
enable_filename_input=is_single_selection,
# OM-99158: Fix issue with apply button disabled when multiple items are selected for download
show_only_folders=True,
)
_open_readonly_usd_prompt = None
def _show_readonly_usd_prompt(ok_fn, middle_fn):
global _open_readonly_usd_prompt
_open_readonly_usd_prompt = Prompt(
"Opening a Read Only File",
"",
[
("Open With New Edit Layer", "open_edit_layer.svg", ok_fn),
("Open Original File", "pencil.svg", middle_fn),
],
modal=False
)
_open_readonly_usd_prompt.show()
| 19,991 | Python | 37.819417 | 170 | 0.62148 |
omniverse-code/kit/exts/omni.kit.window.content_browser/omni/kit/window/content_browser/window.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 omni.ui as ui
import weakref
from .widget import ContentBrowserWidget
from .external_drag_drop_helper import setup_external_drag_drop, destroy_external_drag_drop
class ContentBrowserWindow:
"""The Content Browser window"""
def __init__(self):
self._title = "Content"
self._window = None
self._widget = None
self._visiblity_changed_listener = None
self._build_ui(self._title, 1000, 600)
def _build_ui(self, title, width, height):
window_flags = ui.WINDOW_FLAGS_NO_SCROLLBAR
self._window = ui.Window(
title, width=width, height=height, flags=window_flags, dockPreference=ui.DockPreference.LEFT_BOTTOM
)
self._window.set_visibility_changed_fn(self._visibility_changed_fn)
# Dock it to the same space where Console is docked, make it the first tab and the active tab.
self._window.deferred_dock_in("Console", ui.DockPolicy.CURRENT_WINDOW_IS_ACTIVE)
self._window.dock_order = 2
with self._window.frame:
# We are using `weakref.proxy` to avoid circular reference. The
# circular reference is made when calling `set_width_changed_fn`.
# `self._widget` is captured to the callable, and since the window
# keeps the callable, it keeps self._widget. At the same time,
# `self._widget` keeps the window because we pass it to the
# constructor. To break circular referencing, we use
# `weakref.proxy`.
self._widget = ContentBrowserWidget(
window=weakref.proxy(self._window),
treeview_identifier="content_browser_treeview",
)
self._window.set_width_changed_fn(self._widget._on_window_width_changed)
# External Drag & Drop
setup_external_drag_drop(title, self._widget, self._window.frame)
def _visibility_changed_fn(self, visible):
if self._visiblity_changed_listener:
self._visiblity_changed_listener(visible)
@property
def widget(self) -> ContentBrowserWidget:
return self._widget
def set_visibility_changed_listener(self, listener):
self._visiblity_changed_listener = listener
def destroy(self):
if self._widget:
self._widget.destroy()
self._widget = None
if self._window:
self._window.destroy()
self._window = None
self._visiblity_changed_listener = None
destroy_external_drag_drop()
def set_visible(self, value):
self._window.visible = value
def get_visible(self):
if self._window:
return self._window.visible
return False
| 3,143 | Python | 37.814814 | 111 | 0.655743 |
omniverse-code/kit/exts/omni.kit.window.content_browser/omni/kit/window/content_browser/tests/test_drag_drop.py | import omni.kit.test
import os
import random
import shutil
import tempfile
from unittest.mock import patch
from pathlib import Path
import omni.appwindow
from omni import ui
from carb.input import KeyboardInput
from omni.kit.test.async_unittest import AsyncTestCase
from omni.kit import ui_test
from ..test_helper import ContentBrowserTestHelper
from ..extension import get_instance
class TestDragDrog(AsyncTestCase):
"""Testing ContentBrowser drag and drop behavior"""
async def setUp(self):
await ui_test.find("Content").focus()
async def tearDown(self):
pass
def _prepare_test_dir(self, temp_dir):
# make sure we start off clean
if os.path.exists(temp_dir):
os.rmdir(temp_dir)
os.mkdir(temp_dir)
src_paths = []
# create a file under test dir, and a folder containg a file;
with open(os.path.join(temp_dir, "test.mdl"), "w") as _:
pass
src_paths.append("test.mdl")
test_folder_path = os.path.join(temp_dir, "src_folder")
os.mkdir(test_folder_path)
with open(os.path.join(test_folder_path, "test_infolder.usd"), "w") as _:
pass
src_paths.extend(["src_folder", "src_folder/test_infolder.usd"])
# create the destination folder
dst_folder_path = os.path.join(temp_dir, "dst_folder")
os.mkdir(dst_folder_path)
return src_paths, dst_folder_path
def _get_child_paths(self, root_dir):
paths = []
def _iter_listdir(root):
for p in os.listdir(root):
full_path = os.path.join(root, p)
if os.path.isdir(full_path):
yield full_path
for child in _iter_listdir(full_path):
yield child
else:
yield full_path
for p in _iter_listdir(root_dir):
paths.append(p.replace(root_dir, "").replace("\\", "/").lstrip("/"))
return paths
async def test_drop_to_move(self):
"""Testing drop items would move items inside the destination."""
temp_dir = os.path.join(tempfile.gettempdir(), f"tmp{random.randint(0, int('0xffff', 16))}")
temp_dir = str(Path(temp_dir).resolve())
src_paths, dst_path = self._prepare_test_dir(temp_dir)
async with ContentBrowserTestHelper() as content_browser_helper:
await content_browser_helper.toggle_grid_view_async(False)
await ui_test.human_delay(50)
await content_browser_helper.refresh_current_directory()
await ui_test.human_delay(100)
await content_browser_helper.navigate_to_async(dst_path)
await ui_test.human_delay(100)
await content_browser_helper.navigate_to_async(temp_dir)
await ui_test.human_delay(100)
await content_browser_helper.refresh_current_directory()
await ui_test.human_delay(100)
target_item = await content_browser_helper.get_treeview_item_async("dst_folder")
if not target_item:
return
await content_browser_helper.drag_and_drop_tree_view(
temp_dir, src_paths[:-1], drag_target=target_item.position)
await ui_test.human_delay(20)
window = ui_test.find("MOVE")
self.assertIsNotNone(window)
await ui_test.emulate_keyboard_press(KeyboardInput.ENTER)
await ui_test.human_delay(20)
# files should be moved inside dst folder
self.assertTrue(len(os.listdir(temp_dir)) == 1)
self.assertTrue(os.path.exists(dst_path))
results = self._get_child_paths(os.path.join(temp_dir, dst_path))
self.assertEqual(set(results), set(src_paths))
# Cleanup
shutil.rmtree(temp_dir)
async def test_drop_to_copy(self):
"""Testing drop with CTRL pressed copies items."""
temp_dir = os.path.join(tempfile.gettempdir(), f"tmp{random.randint(0, int('0xffff', 16))}")
temp_dir = str(Path(temp_dir).resolve())
src_paths, dst_path = self._prepare_test_dir(temp_dir)
async with ContentBrowserTestHelper() as content_browser_helper:
await content_browser_helper.toggle_grid_view_async(False)
await ui_test.human_delay(50)
await content_browser_helper.refresh_current_directory()
await ui_test.human_delay(100)
await content_browser_helper.navigate_to_async(dst_path)
await ui_test.human_delay(100)
await content_browser_helper.navigate_to_async(temp_dir)
await ui_test.human_delay(100)
await content_browser_helper.refresh_current_directory()
await ui_test.human_delay(100)
target_item = await content_browser_helper.get_treeview_item_async("dst_folder")
if not target_item:
return
async with ui_test.KeyDownScope(KeyboardInput.LEFT_CONTROL):
await content_browser_helper.drag_and_drop_tree_view(
temp_dir, src_paths[:-1], drag_target=target_item.position)
await ui_test.human_delay(10)
# files should be copied inside dst folder
self.assertTrue(len(os.listdir(temp_dir)) == 3)
# source paths should still exist
for src_path in src_paths:
self.assertTrue(os.path.exists(os.path.join(temp_dir, src_path)))
# source paths should also be copied in dst folder
self.assertTrue(os.path.exists(dst_path))
results = self._get_child_paths(os.path.join(temp_dir, dst_path))
self.assertEqual(set(results), set(src_paths))
# Cleanup
shutil.rmtree(temp_dir)
class TestExternalDragDrog(AsyncTestCase):
"""Testing ContentBrowser external drag and drop behavior"""
async def setUp(self):
await ui_test.find("Content").focus()
# hide viewport to avoid drop fn triggered for viewport
ui.Workspace.show_window("Viewport", False)
window = ui_test.find("Content")
await ui_test.emulate_mouse_move(window.center)
content_browser = get_instance()
content_browser.set_current_directory("/test/target")
async def tearDown(self):
pass
async def test_external_drop_copy(self):
"""Testing external drop triggers copy."""
with patch.object(omni.client, "copy_async", return_value=omni.client.Result.OK) as mock_client_copy:
# simulate drag/drop
omni.appwindow.get_default_app_window().get_window_drop_event_stream().push(0, 0, {'paths': ["dummy"]})
await ui_test.human_delay(20)
mock_client_copy.assert_called_once()
async def test_external_drop_existing_item(self):
"""Testing external drop with existing item prompts user for deletion."""
with patch.object(omni.client, "stat_async", return_value=(omni.client.Result.OK, None)) as mock_client_stat:
# simulate drag/drop
omni.appwindow.get_default_app_window().get_window_drop_event_stream().push(0, 0, {'paths': ["dummy"]})
await ui_test.human_delay(20)
mock_client_stat.assert_called_once()
confirm_deletion = ui_test.find("Confirm File Overwrite")
self.assertTrue(confirm_deletion.window.visible) | 7,427 | Python | 39.590164 | 117 | 0.620035 |
omniverse-code/kit/exts/omni.kit.window.content_browser/omni/kit/window/content_browser/tests/test_registry.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 unittest.mock import patch, Mock
from omni.kit.test.async_unittest import AsyncTestCase
from omni.kit import ui_test
from ..api import ContentBrowserAPI
from .. import get_instance
class TestRegistry(AsyncTestCase):
"""Testing Content Browser Registry"""
async def setUp(self):
pass
async def tearDown(self):
pass
async def test_custom_menus(self):
"""Test persisting custom menus"""
test_menus = {
"context": {
"name": "my context menu",
"glyph": "my glyph",
"click_fn": Mock(),
"show_fn": Mock(),
},
"listview": {
"name": "my listview menu",
"glyph": "my glyph",
"click_fn": Mock(),
"show_fn": Mock(),
},
"import": {
"name": "my import menu",
"glyph": None,
"click_fn": Mock(),
"show_fn": Mock(),
},
"file_open": {
"context": "file_open",
"name": "my file_open handler",
"glyph": None,
"click_fn": Mock(),
"show_fn": Mock(),
}
}
# Register menus
under_test = get_instance()
for context, test_menu in test_menus.items():
if context == "context":
under_test.add_context_menu(test_menu["name"], test_menu["glyph"], test_menu["click_fn"], test_menu["show_fn"])
elif context == "listview":
under_test.add_listview_menu(test_menu["name"], test_menu["glyph"], test_menu["click_fn"], test_menu["show_fn"])
elif context == "import":
under_test.add_import_menu(test_menu["name"], test_menu["glyph"], test_menu["click_fn"], test_menu["show_fn"])
elif context == "file_open":
under_test.add_file_open_handler(test_menu["name"], test_menu["click_fn"], test_menu["show_fn"])
else:
pass
with patch.object(ContentBrowserAPI, "add_context_menu") as mock_add_context_menu,\
patch.object(ContentBrowserAPI, "add_listview_menu") as mock_add_listview_menu,\
patch.object(ContentBrowserAPI, "add_import_menu") as mock_add_import_menu,\
patch.object(ContentBrowserAPI, "add_file_open_handler") as mock_add_file_open_handler:
# Hide then show window again
under_test.show_window(None, False)
await ui_test.human_delay(4)
under_test.show_window(None, True)
await ui_test.human_delay(4)
# Confirm all mocks got called with appropriate inputs
for context, test_menu in test_menus.items():
if context == "context":
mock_add_context_menu.assert_called_with(test_menu["name"], test_menu["glyph"], test_menu["click_fn"], test_menu["show_fn"], 0)
elif context == "listview":
mock_add_listview_menu.assert_called_with(test_menu["name"], test_menu["glyph"], test_menu["click_fn"], test_menu["show_fn"], -1)
elif context == "import":
mock_add_import_menu.assert_called_with(test_menu["name"], test_menu["glyph"], test_menu["click_fn"], test_menu["show_fn"])
elif context == "file_open":
mock_add_file_open_handler.assert_called_with(test_menu["name"], test_menu["click_fn"], test_menu["show_fn"])
else:
pass
async def test_selection_handlers(self):
"""Test persisting selection handlers"""
test_handler_1 = Mock()
test_handler_2 = Mock()
test_handlers = [test_handler_1, test_handler_2, test_handler_1]
under_test = get_instance()
for test_handler in test_handlers:
under_test.subscribe_selection_changed(test_handler)
with patch.object(ContentBrowserAPI, "subscribe_selection_changed") as mock_subscribe_selection_changed:
# Hide then show window again
under_test.show_window(None, False)
await ui_test.human_delay(4)
under_test.show_window(None, True)
await ui_test.human_delay(4)
self.assertEqual(mock_subscribe_selection_changed.call_count, 2)
async def test_search_delegate(self):
"""Test persisting search delegate"""
test_search_delegate = Mock()
under_test = get_instance()
under_test.set_search_delegate(test_search_delegate)
# Confirm search delegate restored from registry
with patch.object(ContentBrowserAPI, "set_search_delegate") as mock_set_search_delegate:
# Hide then show window again
under_test.show_window(None, False)
await ui_test.human_delay(4)
under_test.show_window(None, True)
await ui_test.human_delay(4)
mock_set_search_delegate.assert_called_with(test_search_delegate)
| 5,454 | Python | 42.29365 | 145 | 0.585075 |
omniverse-code/kit/exts/omni.kit.window.content_browser/omni/kit/window/content_browser/tests/test_widget.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 carb
import omni.kit.test
import omni.client
from omni.kit import ui_test
from unittest.mock import patch
from ..widget import ContentBrowserWidget
from ..api import ContentBrowserAPI
from .. import get_content_window, SETTING_PERSISTENT_CURRENT_DIRECTORY
class TestContentBrowserWidget(omni.kit.test.AsyncTestCase):
async def setUp(self):
await ui_test.find("Content").focus()
async def tearDown(self):
# Clear all bookmarks saved by omni.client, as a result of mounting test servers
pass
async def wait_for_update(self, wait_frames=20):
for _ in range(wait_frames):
await omni.kit.app.get_app().next_update_async()
async def test_mount_default_servers(self):
"""Testing that the widget mounts the server specified from the settings"""
content_browser = get_content_window()
under_test = content_browser.window.widget
test_servers = {"my-server": "omniverse://my-server", "her-server": "omniverse://her-server"}
# Re-run init_view to confirm that the the widget adds the servers specified in
# the settings. OM-85963: Mock out all the actual calls to connect the servers because
# they trigger a host of other actions, incl. callbacks on bookmarks changed, that make
# this test unreliable.
with patch.object(ContentBrowserWidget, "_get_mounted_servers", return_value=(test_servers, True)),\
patch.object(ContentBrowserAPI, "add_connections") as mock_add_connections,\
patch.object(ContentBrowserAPI, "connect_server") as mock_connect_server,\
patch.object(ContentBrowserAPI, "subscribe_client_bookmarks_changed"):
# Initialize the view and expect to mount servers
under_test._init_view(None, None)
# Check that widget attempted to add list of servers specified in settings
mock_add_connections.assert_called_once_with(test_servers)
# Check that widget attempted to connect to first server in list
mock_connect_server.assert_called_once_with(test_servers['my-server'])
| 2,552 | Python | 46.277777 | 108 | 0.716301 |
omniverse-code/kit/exts/omni.kit.window.content_browser/omni/kit/window/content_browser/tests/__init__.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 .test_extension import *
from .test_navigate import *
from .test_test_helper import *
from .test_registry import *
from .test_widget import *
from .test_download import *
from .test_drag_drop import *
from .test_rename import *
from .test_cut_paste import *
from .test_prompt import *
| 731 | Python | 37.526314 | 77 | 0.77565 |
omniverse-code/kit/exts/omni.kit.window.content_browser/omni/kit/window/content_browser/tests/test_prompt.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 omni.kit import ui_test
from ..prompt import Prompt
class TestPrompt(omni.kit.test.AsyncTestCase):
async def setUp(self):
pass
async def tearDown(self):
pass
async def test_prompt(self):
"""Testing Prompt window"""
prompt = Prompt(
"TestPrompt",
"TestLabel",
[
("test_button", "pencil.svg", None),
],
modal=False
)
prompt.hide()
self.assertFalse(prompt.is_visible())
prompt.show()
self.assertTrue(prompt.is_visible())
button = ui_test.find("TestPrompt//Frame/**/Button[*].text==' test_button'")
await button.click()
#self.assertFalse(prompt.is_visible())
del prompt | 1,228 | Python | 32.216215 | 85 | 0.640065 |
omniverse-code/kit/exts/omni.kit.window.content_browser/omni/kit/window/content_browser/tests/test_extension.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
import asyncio
import omni.kit.app
from unittest.mock import Mock, patch, ANY
from .. import get_content_window
from omni.kit import ui_test
from omni.kit.test_suite.helpers import open_stage, get_test_data_path
from omni.kit.helper.file_utils import FILE_OPENED_EVENT
from omni.kit.widget.filebrowser import is_clipboard_cut, get_clipboard_items, clear_clipboard
class MockItem:
def __init__(self, path: str):
self.name = path
self.path = path
self.writeable = True
self.is_folder = True
self.is_deleted = False
class TestContentBrowser(omni.kit.test.AsyncTestCase):
"""
Testing omni.kit.window.content_browser extension. NOTE that since the dialog is a singleton, we use an async
lock to ensure that only one test runs at a time. In practice, this is not a issue since there's only one instance
in the app.
"""
__lock = asyncio.Lock()
async def setUp(self):
pass
async def wait_for_update(self, wait_frames=20):
for _ in range(wait_frames):
await omni.kit.app.get_app().next_update_async()
async def tearDown(self):
pass
async def test_set_search_delegate(self):
"""Testing that hiding the window destroys it"""
mock_search_delegate = Mock()
async with self.__lock:
under_test = get_content_window()
await self.wait_for_update()
under_test.set_search_delegate(mock_search_delegate)
under_test.unset_search_delegate(mock_search_delegate)
mock_search_delegate.build_ui.assert_called_once()
async def test_open_event(self):
"""Testing that on open event should auto navigate"""
under_test = get_content_window()
event_stream = omni.kit.app.get_app().get_message_bus_event_stream()
event_stream.push(FILE_OPENED_EVENT, payload={"url": get_test_data_path(__name__, "bound_shapes.usda")})
with patch.object(under_test, "navigate_to") as mock:
await ui_test.human_delay(50)
mock.assert_called_once()
event_stream.push(FILE_OPENED_EVENT, payload={"url": get_test_data_path(__name__, "bound_shapes.usda")})
async def test_interface(self):
"""Testing all simple interface"""
under_test = get_content_window()
under_test.set_current_directory("omniverse:/")
self.assertEqual(under_test.get_current_directory(), "omniverse:/")
self.assertEqual(under_test.get_current_selections(), [])
under_test.show_model(None)
def dummy(*args, **kwargs):
pass
under_test.subscribe_selection_changed(dummy)
under_test.unsubscribe_selection_changed(dummy)
under_test.delete_context_menu("test")
under_test.toggle_bookmark_from_path("", "omniverse:/", False)
#under_test.add_checkpoint_menu("test", "", None, None)
#under_test.delete_checkpoint_menu("test")
under_test.add_listview_menu("test", "", None, None)
under_test.delete_listview_menu("test")
under_test.add_import_menu("test", "", None, None)
under_test.delete_import_menu("test")
self.assertEqual(under_test.get_file_open_handler("test"), None)
under_test.add_file_open_handler("test", dummy, None)
under_test.delete_file_open_handler("test")
self.assertIsNotNone(under_test.api)
self.assertIsNotNone(under_test.get_checkpoint_widget())
self.assertIsNone(under_test.get_timestamp_widget())
async def test_api(self):
"""Testing rest api interface"""
api = get_content_window().api
self.assertIsNotNone(api)
#api._post_warning("test")
def dummy(*args, **kwargs):
pass
api.subscribe_selection_changed(dummy)
api._notify_selection_subs(2, [])
return
mock_item_list = [MockItem(str(i)) for i in range(10)]
with patch.object(api.view, "get_selections", return_value=mock_item_list) as mock:
api.copy_selected_items()
mock.assert_called_once()
self.assertFalse(is_clipboard_cut())
mock.reset_mock()
api.cut_selected_items()
self.assertEqual(get_clipboard_items(), mock_item_list)
mock.assert_called_once()
with patch.object(api.view, "get_selections", return_value=mock_item_list) as mock:
api.delete_selected_items()
mock.assert_called_once()
mock_item_list1 = [MockItem("test")]
with patch("omni.kit.widget.filebrowser.get_clipboard_items", return_value=mock_item_list) as mock, \
patch.object(api.view, "get_selections", return_value=mock_item_list1) as mock2:
api.paste_items()
api.clear_clipboard()
mock2.assert_called_once()
| 5,291 | Python | 41.677419 | 119 | 0.650539 |
omniverse-code/kit/exts/omni.kit.window.content_browser/omni/kit/window/content_browser/tests/test_rename.py | import omni.kit.test
import os
import random
import shutil
import tempfile
from pathlib import Path
from unittest.mock import patch
from omni import ui
from carb.input import KeyboardInput
from omni.kit.test.async_unittest import AsyncTestCase
from omni.kit import ui_test
from ..test_helper import ContentBrowserTestHelper
# FIXME: Currently force this to run before test_navigate, since it was not easy to close out the
# "add neclues connection" window in test
class TestFileRename(AsyncTestCase):
"""Testing ContentBrowserWidget drag and drop behavior"""
async def setUp(self):
await ui_test.find("Content").focus()
async def tearDown(self):
pass
def _prepare_test_dir(self, temp_dir, temp_file):
# make sure we start off clean
if os.path.exists(temp_dir):
os.rmdir(temp_dir)
os.makedirs(temp_dir)
with open(os.path.join(temp_dir, temp_file), "w") as _:
pass
async def test_rename_file(self):
"""Testing renaming a file."""
temp_dir = os.path.join(tempfile.gettempdir(), f"tmp{random.randint(0, int('0xffff', 16))}")
temp_dir = str(Path(temp_dir).resolve())
filename = "temp.mdl"
self._prepare_test_dir(temp_dir, filename)
async with ContentBrowserTestHelper() as content_browser_helper:
await content_browser_helper.navigate_to_async("omniverse:/")
await ui_test.human_delay(50)
await content_browser_helper.refresh_current_directory()
await ui_test.human_delay(50)
await content_browser_helper.navigate_to_async(temp_dir)
await ui_test.human_delay(50)
await content_browser_helper.toggle_grid_view_async(True)
await ui_test.human_delay(50)
t = await content_browser_helper.get_item_async(temp_dir + "/" + filename)
await content_browser_helper.refresh_current_directory()
await ui_test.human_delay(50)
item = await content_browser_helper.get_gridview_item_async(filename)
if item is None:
return
await item.right_click()
await ui_test.human_delay()
return
await ui_test.select_context_menu("Rename")
popup = ui.Workspace.get_window(f"Rename {filename}")
self.assertIsNotNone(popup)
self.assertTrue(popup.visible)
def dummy(*args, **kwargs):
return "dummy.txt"
with patch(
"omni.kit.window.popup_dialog.InputDialog.get_value",
side_effect=dummy
):
await ui_test.emulate_keyboard_press(KeyboardInput.ENTER)
await ui_test.human_delay(10)
# file should have been renamed to dummy.txt now
self.assertFalse(os.path.exists(os.path.join(temp_dir, filename)))
self.assertTrue(os.path.exists(os.path.join(temp_dir, "dummy.txt")))
await content_browser_helper.navigate_to_async("omniverse:/")
await ui_test.human_delay(50)
# Cleanup
shutil.rmtree(temp_dir)
async def test_rename_folder(self):
"""Testing renaming a folder."""
temp_dir = os.path.join(tempfile.gettempdir(), f"tmp{random.randint(0, int('0xffff', 16))}")
temp_dir = str(Path(temp_dir).resolve())
src_folder = os.path.join(temp_dir, "test_folder")
filename = "temp.mdl"
self._prepare_test_dir(src_folder, filename)
async with ContentBrowserTestHelper() as content_browser_helper:
await content_browser_helper.navigate_to_async("omniverse:/")
await ui_test.human_delay(50)
await content_browser_helper.refresh_current_directory()
# TODO: need to refresh the browser item here, but why
await content_browser_helper.navigate_to_async(src_folder)
await content_browser_helper.navigate_to_async(temp_dir)
t = await content_browser_helper.get_item_async(src_folder)
await content_browser_helper.toggle_grid_view_async(True)
await content_browser_helper.refresh_current_directory()
await ui_test.human_delay(50)
item = await content_browser_helper.get_gridview_item_async("test_folder")
if item is None:
return
await item.right_click()
await ui_test.human_delay()
return
await ui_test.select_context_menu("Rename")
popup = ui.Workspace.get_window("Rename test_folder")
self.assertIsNotNone(popup)
self.assertTrue(popup.visible)
def dummy(*args, **kwargs):
return "renamed_folder"
with patch(
"omni.kit.window.popup_dialog.InputDialog.get_value",
side_effect=dummy
):
await ui_test.emulate_keyboard_press(KeyboardInput.ENTER)
await ui_test.human_delay(20)
# file should have been renamed to dummy.txt now
self.assertFalse(os.path.exists(src_folder))
renamed_folder = os.path.join(temp_dir, "renamed_folder")
self.assertTrue(os.path.exists(renamed_folder))
self.assertTrue(os.path.exists(os.path.join(renamed_folder, filename)))
await content_browser_helper.navigate_to_async("omniverse:/")
await ui_test.human_delay(50)
# Cleanup
shutil.rmtree(temp_dir)
| 5,535 | Python | 38.827338 | 100 | 0.618428 |
omniverse-code/kit/exts/omni.kit.window.content_browser/omni/kit/window/content_browser/tests/test_download.py | import omni.kit.test
import os
from pathlib import Path
from tempfile import TemporaryDirectory, NamedTemporaryFile
from unittest.mock import patch, Mock
import omni.ui as ui
import carb.settings
from omni.kit.test.async_unittest import AsyncTestCase
from omni.kit import ui_test
from omni.kit.window.file_exporter import get_file_exporter
from ..widget import ContentBrowserWidget
from ..test_helper import ContentBrowserTestHelper
from ..file_ops import download_items
from .. import get_content_window
from ..context_menu import ContextMenu
class TestDownload(AsyncTestCase):
"""Testing ContentBrowserWidget._download_items"""
async def setUp(self):
await ui_test.find("Content").focus()
async def tearDown(self):
# hide download window on test teardown
window = ui.Workspace.get_window("Download Files")
if window:
window.visible = False
async def test_no_selection(self):
"""Testing when nothing is selected, don't open up file exporter."""
# currently marking this as the first test to run since ui.Workspace.get_window result would not
# be None if other tests had shown the window once
download_items([])
await ui_test.human_delay()
window = ui.Workspace.get_window("Download Files")
try:
self.assertIsNone(window)
except AssertionError:
# in the case where the window is created, then the window should be invisible
self.assertFalse(window.visible)
async def test_single_selection(self):
"""Testing when downloading with a single item selected."""
with TemporaryDirectory() as tmpdir_fd:
# need to resolve to deal with the abbreviated user filename such as "LINE8~1"
tmpdir = Path(tmpdir_fd).resolve()
temp_fd = NamedTemporaryFile(dir=tmpdir, suffix=".mdl", delete=False)
temp_fd.close()
_, filename = os.path.split(temp_fd.name)
async with ContentBrowserTestHelper() as content_browser_helper:
await content_browser_helper.refresh_current_directory()
await content_browser_helper.navigate_to_async(str(tmpdir))
items = await content_browser_helper.select_items_async(str(tmpdir), [filename])
await ui_test.human_delay()
with patch("omni.kit.notification_manager.post_notification") as mock_post_notification:
self.assertEqual(len(items), 1)
download_items(items)
await ui_test.human_delay(10)
file_exporter = get_file_exporter()
self.assertIsNotNone(file_exporter)
# the filename for file exporter should be pre-filled (same as the source filename)
self.assertEqual(file_exporter._dialog.get_filename(), filename)
# the filename field should enable input
self.assertTrue(file_exporter._dialog._widget._enable_filename_input)
file_exporter._dialog.set_current_directory(str(tmpdir))
await ui_test.human_delay()
window = ui.Workspace.get_window("Download Files")
self.assertTrue(window.visible)
file_exporter._dialog.set_filename("dummy")
file_exporter.click_apply()
await ui_test.human_delay(10)
# should have created a downloaded file in the same directory, with the same extension
self.assertTrue(tmpdir.joinpath("dummy.mdl").exists)
mock_post_notification.assert_called_once()
async def test_multi_selection(self):
"""Testing when downloading with multiple items selected."""
with TemporaryDirectory() as tmpdir_fd:
# need to resolve to deal with the abbreviated user filename such as "LINE8~1"
tmpdir = Path(tmpdir_fd).resolve()
temp_files = []
for _ in range(2):
temp_fd = NamedTemporaryFile(dir=tmpdir, suffix=".mdl", delete=False)
temp_fd.close()
_, filename = os.path.split(temp_fd.name)
temp_files.append(filename)
async with ContentBrowserTestHelper() as content_browser_helper:
await content_browser_helper.refresh_current_directory()
await content_browser_helper.navigate_to_async(str(tmpdir))
items = await content_browser_helper.select_items_async(str(tmpdir), temp_files)
await ui_test.human_delay()
with patch("omni.kit.notification_manager.post_notification") as mock_post_notification:
self.assertEqual(len(items), len(temp_files))
download_items(items)
await ui_test.human_delay(10)
file_exporter = get_file_exporter()
self.assertIsNotNone(file_exporter)
window = ui.Workspace.get_window("Download Files")
self.assertTrue(window.visible)
# the filename field should disable input
self.assertFalse(file_exporter._dialog._widget._enable_filename_input)
with TemporaryDirectory() as another_tmpdir_fd:
dst_tmpdir = Path(another_tmpdir_fd)
file_exporter._dialog.set_current_directory(str(dst_tmpdir))
await ui_test.human_delay()
# OM-99158: Check that the apply button is not disabled
self.assertTrue(file_exporter._dialog._widget.file_bar._apply_button.enabled)
file_exporter.click_apply()
await ui_test.human_delay(10)
# should have created downloaded files in the dst directory
downloaded_files = [file for file in os.listdir(dst_tmpdir)]
self.assertEqual(set(temp_files), set(downloaded_files))
self.assertEqual(mock_post_notification.call_count, len(items))
async def test_multi_results(self):
"""Testing when downloading with multiple results."""
with TemporaryDirectory() as tmpdir_fd:
# need to resolve to deal with the abbreviated user filename such as "LINE8~1"
tmpdir = Path(tmpdir_fd).resolve()
temp_files = []
for _ in range(3):
temp_fd = NamedTemporaryFile(dir=tmpdir, suffix=".mdl", delete=False)
temp_fd.close()
_, filename = os.path.split(temp_fd.name)
temp_files.append(filename)
async with ContentBrowserTestHelper() as content_browser_helper:
await content_browser_helper.refresh_current_directory()
await content_browser_helper.navigate_to_async(str(tmpdir))
items = await content_browser_helper.select_items_async(str(tmpdir), temp_files)
await ui_test.human_delay()
with patch.object(omni.kit.window.content_browser.file_ops, "copy_items_with_callback", side_effect=self._mock_copy_items_with_callback),\
patch("omni.kit.notification_manager.post_notification") as mock_post_notification:
self.assertEqual(len(items), len(temp_files))
download_items(items)
await ui_test.human_delay(10)
file_exporter = get_file_exporter()
self.assertIsNotNone(file_exporter)
window = ui.Workspace.get_window("Download Files")
self.assertTrue(window.visible)
# the filename field should disable input
self.assertFalse(file_exporter._dialog._widget._enable_filename_input)
with TemporaryDirectory() as another_tmpdir_fd:
dst_tmpdir = Path(another_tmpdir_fd)
file_exporter._dialog.set_current_directory(str(dst_tmpdir))
await ui_test.human_delay()
# OM-99158: Check that the apply button is not disabled
self.assertTrue(file_exporter._dialog._widget.file_bar._apply_button.enabled)
file_exporter.click_apply()
await ui_test.human_delay(10)
self.assertEqual(mock_post_notification.call_count, len(items))
def _mock_copy_items_with_callback(self, src_paths, dst_paths, callback=None, copy_callback=None):
# Fist one succeeded on copy
# Second one failed on copy
# Thrid has exception during copy
copy_callback(src_paths[0], dst_paths[0], omni.client.Result.OK)
copy_callback(src_paths[1], dst_paths[1], omni.client.Result.ERROR_NOT_SUPPORTED)
expected_results = [dst_paths[0],dst_paths[1], Exception("Test Exception")]
callback(expected_results)
async def test_show_download_menuitem_setting(self):
"""Testing show download menuitem setting works as expect."""
old_setting_value = carb.settings.get_settings().get("exts/omni.kit.window.content_browser/show_download_menuitem")
item = Mock()
item.path = "test"
item.is_folder = False
item.writeable = True
carb.settings.get_settings().set("exts/omni.kit.window.content_browser/show_download_menuitem", True)
await ui_test.human_delay(10)
menu_with_download = ContextMenu()
menu_with_download.show(item, [item])
await ui_test.human_delay(30)
menu_dict = await ui_test.get_context_menu(menu_with_download.menu)
has_download_menuitem = False
for name in menu_dict["_"]:
if name == "Download":
has_download_menuitem = True
self.assertTrue(has_download_menuitem)
menu_with_download.destroy()
carb.settings.get_settings().set("exts/omni.kit.window.content_browser/show_download_menuitem", False)
await ui_test.human_delay(10)
menu_without_download = ContextMenu()
await ui_test.human_delay(10)
menu_without_download.show(item, [item])
menu_dict = await ui_test.get_context_menu(menu_without_download.menu)
has_download_menuitem = False
for name in menu_dict["_"]:
if name == "Download":
has_download_menuitem = True
self.assertFalse(has_download_menuitem)
menu_without_download.destroy()
carb.settings.get_settings().set("exts/omni.kit.window.content_browser/show_download_menuitem", old_setting_value)
| 10,524 | Python | 46.840909 | 150 | 0.624382 |
omniverse-code/kit/exts/omni.kit.window.content_browser/omni/kit/window/content_browser/tests/test_navigate.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
import omni.kit.app
import omni.client
from unittest.mock import patch, Mock
from omni.kit import ui_test
from omni.kit.test.async_unittest import AsyncTestCase
from omni.kit.test_suite.helpers import get_test_data_path
from .. import get_content_window
class TestNavigate(AsyncTestCase):
"""Testing ContentBrowserWidget.open_and_navigate_to"""
async def setUp(self):
await ui_test.find("Content").focus()
async def tearDown(self):
pass
async def test_file_found_and_opened(self):
"""Testing when navigating to USD file, opens it"""
content_browser = get_content_window()
under_test = content_browser.window.widget
url = get_test_data_path(__name__, "4Lights.usda")
mock_open_stage = Mock()
with patch("omni.kit.window.content_browser.file_ops.get_file_open_handler", return_value=mock_open_stage):
# patch("omni.kit.window.content_browser.widget.open_stage") as mock_open_stage:
under_test._open_and_navigate_to(url)
await ui_test.human_delay(4)
mock_open_stage.assert_called_once_with(omni.client.normalize_url(url))
async def test_file_with_spaces_found_and_opened(self):
"""Testing file with surrounding spaces is correctly found"""
content_browser = get_content_window()
under_test = content_browser.window.widget
url = " " + get_test_data_path(__name__, "4Lights.usda") + " "
mock_open_stage = Mock()
with patch("omni.kit.window.content_browser.file_ops.get_file_open_handler", return_value=mock_open_stage):
under_test._open_and_navigate_to(url)
await ui_test.human_delay(4)
mock_open_stage.assert_called_once_with(omni.client.normalize_url(url.strip()))
async def test_folder_found_not_opened(self):
"""Testing when navigating to folder with USD extension, doesn't open it"""
content_browser = get_content_window()
under_test = content_browser.window.widget
url = get_test_data_path(__name__, "folder.usda")
mock_open_stage = Mock()
with patch("omni.kit.window.content_browser.file_ops.get_file_open_handler", return_value=mock_open_stage):
under_test._open_and_navigate_to(url)
await ui_test.human_delay(4)
mock_open_stage.assert_not_called()
async def test_invalid_usd_path_still_opened(self):
"""Testing that even if a USD path is invalid, we still try to open it"""
content_browser = get_content_window()
under_test = content_browser.window.widget
url = get_test_data_path(__name__, "not-found.usda")
mock_open_stage = Mock()
with patch("omni.kit.window.content_browser.file_ops.get_file_open_handler", return_value=mock_open_stage):
under_test._open_and_navigate_to(url)
await ui_test.human_delay(4)
mock_open_stage.assert_called_once_with(omni.client.normalize_url(url.strip()))
| 3,449 | Python | 44.394736 | 115 | 0.679327 |
omniverse-code/kit/exts/omni.kit.window.content_browser/omni/kit/window/content_browser/tests/test_test_helper.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 omni.kit.app
import omni.usd
from omni.kit.test.async_unittest import AsyncTestCase
from omni.kit import ui_test
from omni.kit.test_suite.helpers import open_stage, get_test_data_path, get_prims, wait_stage_loading, arrange_windows
from ..test_helper import ContentBrowserTestHelper
class TestDragDropTreeView(AsyncTestCase):
# Before running each test
async def setUp(self):
await arrange_windows("Stage", 512)
# After running each test
async def tearDown(self):
await wait_stage_loading()
async def test_config_menu_setting(self):
await ui_test.find("Content").focus()
async with ContentBrowserTestHelper() as content_browser_helper:
old_setting = await content_browser_helper.get_config_menu_settings()
# TODO: Why this not works as expect?
await content_browser_helper.set_config_menu_settings({"test": "test"})
test_dict = await content_browser_helper.get_config_menu_settings()
standard_dict = {'hide_unknown': False, 'hide_thumbnails': True, 'show_details': True, 'show_udim_sequence': False}
self.assertEqual(test_dict,standard_dict)
await content_browser_helper.set_config_menu_settings(old_setting)
async def test_select_single_item(self):
await ui_test.find("Content").focus()
# select file to show info
usd_path = get_test_data_path(__name__)
async with ContentBrowserTestHelper() as content_browser_helper:
selections = await content_browser_helper.select_items_async(usd_path, names=["4Lights.usda"])
await ui_test.human_delay(4)
# Verify selections
self.assertEqual([sel.name for sel in selections], ['4Lights.usda'])
async def test_select_multiple_items(self):
await ui_test.find("Content").focus()
# select file to show info
usd_path = get_test_data_path(__name__)
filenames = ["4Lights.usda", "bound_shapes.usda", "quatCube.usda"]
async with ContentBrowserTestHelper() as content_browser_helper:
selections = await content_browser_helper.select_items_async(usd_path, names=filenames+["nonexistent.usda"])
await ui_test.human_delay(4)
# Verify selections
self.assertEqual(sorted([sel.name for sel in selections]), sorted(filenames))
async def test_drag_drop_single_item(self):
await open_stage(get_test_data_path(__name__, "bound_shapes.usda"))
await wait_stage_loading()
await ui_test.find("Content").focus()
await ui_test.find("Stage").focus()
# verify prims
usd_context = omni.usd.get_context()
stage = usd_context.get_stage()
paths = [prim.GetPath().pathString for prim in get_prims(stage) if not omni.usd.is_hidden_type(prim)]
self.assertEqual(paths, ['/World', '/World/defaultLight', '/World/Cone', '/World/Cube', '/World/Sphere', '/World/Cylinder', '/World/Looks', '/World/Looks/OmniPBR', '/World/Looks/OmniPBR/Shader', '/World/Looks/OmniGlass', '/World/Looks/OmniGlass/Shader', '/World/Looks/OmniSurface_Plastic', '/World/Looks/OmniSurface_Plastic/Shader'])
# drag/drop files to stage window
stage_window = ui_test.find("Stage")
drag_target = stage_window.position + ui_test.Vec2(stage_window.size.x / 2, stage_window.size.y - 32)
async with ContentBrowserTestHelper() as content_browser_helper:
for file_path in ["4Lights.usda", "quatCube.usda"]:
await content_browser_helper.drag_and_drop_tree_view(get_test_data_path(__name__, file_path), drag_target=drag_target)
# verify prims
paths = [prim.GetPath().pathString for prim in get_prims(stage) if not omni.usd.is_hidden_type(prim)]
self.assertEqual(paths, ['/World', '/World/defaultLight', '/World/Cone', '/World/Cube', '/World/Sphere', '/World/Cylinder', '/World/Looks', '/World/Looks/OmniPBR', '/World/Looks/OmniPBR/Shader', '/World/Looks/OmniGlass', '/World/Looks/OmniGlass/Shader', '/World/Looks/OmniSurface_Plastic', '/World/Looks/OmniSurface_Plastic/Shader', '/World/_Lights', '/World/_Lights/SphereLight_01', '/World/_Lights/SphereLight_02', '/World/_Lights/SphereLight_03', '/World/_Lights/SphereLight_00', '/World/_Lights/Cube', '/World/quatCube', '/World/quatCube/Cube'])
async def test_drag_drop_multiple_items(self):
await open_stage(get_test_data_path(__name__, "bound_shapes.usda"))
await wait_stage_loading()
await ui_test.find("Content").focus()
await ui_test.find("Stage").focus()
# verify prims
usd_context = omni.usd.get_context()
stage = usd_context.get_stage()
paths = [prim.GetPath().pathString for prim in get_prims(stage) if not omni.usd.is_hidden_type(prim)]
self.assertEqual(paths, ['/World', '/World/defaultLight', '/World/Cone', '/World/Cube', '/World/Sphere', '/World/Cylinder', '/World/Looks', '/World/Looks/OmniPBR', '/World/Looks/OmniPBR/Shader', '/World/Looks/OmniGlass', '/World/Looks/OmniGlass/Shader', '/World/Looks/OmniSurface_Plastic', '/World/Looks/OmniSurface_Plastic/Shader'])
# drag/drop files to stage window
stage_window = ui_test.find("Stage")
drag_target = stage_window.position + ui_test.Vec2(stage_window.size.x / 2, stage_window.size.y - 96)
async with ContentBrowserTestHelper() as content_browser_helper:
usd_path = get_test_data_path(__name__)
await content_browser_helper.drag_and_drop_tree_view(usd_path, names=["4Lights.usda", "quatCube.usda"], drag_target=drag_target)
# verify prims
paths = [prim.GetPath().pathString for prim in get_prims(stage) if not omni.usd.is_hidden_type(prim)]
self.assertEqual(paths, ['/World', '/World/defaultLight', '/World/Cone', '/World/Cube', '/World/Sphere', '/World/Cylinder', '/World/Looks', '/World/Looks/OmniPBR', '/World/Looks/OmniPBR/Shader', '/World/Looks/OmniGlass', '/World/Looks/OmniGlass/Shader', '/World/Looks/OmniSurface_Plastic', '/World/Looks/OmniSurface_Plastic/Shader', '/World/_Lights', '/World/_Lights/SphereLight_01', '/World/_Lights/SphereLight_02', '/World/_Lights/SphereLight_03', '/World/_Lights/SphereLight_00', '/World/_Lights/Cube', '/World/quatCube', '/World/quatCube/Cube'])
| 6,769 | Python | 58.385964 | 557 | 0.679864 |
omniverse-code/kit/exts/omni.kit.window.content_browser/omni/kit/window/content_browser/tests/test_cut_paste.py | import omni.kit.test
from unittest.mock import patch
import omni.client
from omni import ui
from carb.input import KeyboardInput
from omni.kit.test.async_unittest import AsyncTestCase
from omni.kit import ui_test
from omni.kit.test_suite.helpers import get_test_data_path
from omni.kit.widget.filebrowser import is_clipboard_cut, get_clipboard_items, clear_clipboard
from ..test_helper import ContentBrowserTestHelper
class TestCutPaste(AsyncTestCase):
"""Testing ContentBrowserWidget cut and paste behavior"""
async def setUp(self):
await ui_test.find("Content").focus()
async def tearDown(self):
pass
async def test_paste_availability(self):
"""Testing paste context menu shows up correctly."""
test_dir = get_test_data_path(__name__)
test_file = "4Lights.usda"
test_folder = "folder.usda"
async with ContentBrowserTestHelper() as content_browser_helper:
await content_browser_helper.navigate_to_async(test_dir)
await content_browser_helper.toggle_grid_view_async(True)
await ui_test.human_delay(100)
item = await content_browser_helper.get_gridview_item_async(test_file)
folder_item = await content_browser_helper.get_gridview_item_async(test_folder)
if not item:
return
await item.right_click()
await ui_test.human_delay()
context_menu = await ui_test.get_context_menu()
context_options = context_menu["_"]
self.assertIn("Cut", context_options)
self.assertNotIn("Paste", context_options)
await ui_test.select_context_menu("Cut")
# now paste should be available
await ui_test.human_delay()
await folder_item.right_click()
await ui_test.human_delay()
context_menu = await ui_test.get_context_menu()
context_options = context_menu["_"]
self.assertIn("Paste", context_options)
# paste will not be available if more than one item is selected, but Cut should
await content_browser_helper.select_items_async(test_dir, [test_file, test_folder])
await item.right_click()
await ui_test.human_delay()
context_menu = await ui_test.get_context_menu()
context_options = context_menu["_"]
self.assertNotIn("Paste", context_options)
self.assertIn("Cut", context_options)
clear_clipboard()
async def test_cut_and_paste(self):
"""Testing cut and paste."""
test_dir = get_test_data_path(__name__)
test_file = "4Lights.usda"
test_folder = "folder.usda"
async with ContentBrowserTestHelper() as content_browser_helper:
await content_browser_helper.navigate_to_async(test_dir)
await content_browser_helper.toggle_grid_view_async(True)
await ui_test.human_delay(100)
item = await content_browser_helper.get_gridview_item_async(test_file)
folder_item = await content_browser_helper.get_gridview_item_async(test_folder)
if not item:
return
if not folder_item:
return
await folder_item.right_click()
await ui_test.human_delay()
await ui_test.select_context_menu("Cut")
# cut clipboard should have one item in it
self.assertTrue(is_clipboard_cut())
self.assertEqual(1, len(get_clipboard_items()))
self.assertEqual(get_clipboard_items()[0].path.replace("\\", "/").lower(),
f"{test_dir}/{test_folder}".replace("\\", "/").lower())
# cut clipboard should still have one item in it, but updated
await item.right_click()
await ui_test.human_delay()
await ui_test.select_context_menu("Cut")
self.assertTrue(is_clipboard_cut())
self.assertEqual(1, len(get_clipboard_items()))
cut_path = get_clipboard_items()[0].path
self.assertEqual(cut_path.replace("\\", "/").lower(), f"{test_dir}/{test_file}".replace("\\", "/").lower())
with patch.object(omni.client, "move_async", return_value=(omni.client.Result.OK, None)) as mock_move:
await folder_item.right_click()
await ui_test.human_delay()
await ui_test.select_context_menu("Paste")
await ui_test.human_delay(10)
window = ui_test.find("MOVE")
self.assertIsNotNone(window)
await ui_test.emulate_keyboard_press(KeyboardInput.ENTER)
await ui_test.human_delay()
mock_move.assert_called_once()
# clipboard should be cleared now
self.assertEqual(get_clipboard_items(), [])
self.assertFalse(is_clipboard_cut())
| 4,918 | Python | 40.68644 | 119 | 0.610207 |
omniverse-code/kit/exts/omni.kit.window.content_browser/omni/kit/window/content_browser/tests/test_external_drag_drop.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 os
import tempfile
import omni.kit.app
import omni.usd
from omni.kit.test.async_unittest import AsyncTestCase
from omni.kit import ui_test
from omni.kit.test_suite.helpers import open_stage, get_test_data_path, get_prims, wait_stage_loading, arrange_windows
from omni.kit.window.content_browser import get_content_window
class TestExternalDragDrop(AsyncTestCase):
# Before running each test
async def setUp(self):
await arrange_windows("Stage", 512)
# After running each test
async def tearDown(self):
await wait_stage_loading()
async def test_external_drag_drop(self):
# position mouse
await ui_test.find("Content").click()
await ui_test.human_delay()
with tempfile.TemporaryDirectory() as tmpdir:
test_file = f"{tmpdir}/bound_shapes.usda"
# browse to tempdir
content_browser = get_content_window()
content_browser.navigate_to(str(tmpdir))
await ui_test.human_delay(50)
# if target file exists remove
if os.path.exists(test_file):
os.remove(test_file)
# simulate drag/drop
item_path = get_test_data_path(__name__, "bound_shapes.usda")
omni.appwindow.get_default_app_window().get_window_drop_event_stream().push(0, 0, {'paths': [item_path]})
await ui_test.human_delay(50)
# verify exists
self.assertTrue(os.path.exists(test_file))
| 1,924 | Python | 36.01923 | 118 | 0.678274 |
omniverse-code/kit/exts/omni.kit.filebrowser_column.acl/omni/kit/filebrowser_column/acl/__init__.py | from .acl_extension import AclExtension
| 40 | Python | 19.49999 | 39 | 0.85 |
omniverse-code/kit/exts/omni.kit.filebrowser_column.acl/omni/kit/filebrowser_column/acl/acl_delegate.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 omni.kit.widget.filebrowser import ColumnItem
from omni.kit.widget.filebrowser import AbstractColumnDelegate
import asyncio
import carb
import functools
import omni.client
import omni.ui as ui
import traceback
def handle_exception(func):
"""
Decorator to print exception in async functions
"""
@functools.wraps(func)
async def wrapper(*args, **kwargs):
try:
return await func(*args, **kwargs)
except asyncio.CancelledError:
pass
except Exception as e:
carb.log_error(f"Exception when async '{func}'")
carb.log_error(f"{e}")
carb.log_error(f"{traceback.format_exc()}")
return wrapper
class AclDelegate(AbstractColumnDelegate):
"""
The object that adds the new column "Access" to fileblowser. The columns
displays access flags.
"""
@property
def initial_width(self):
"""The width of the column"""
return ui.Pixel(40)
def build_header(self):
"""Build the header"""
ui.Label("ACL", style_type_name_override="TreeView.Header")
@handle_exception
async def build_widget(self, item: ColumnItem):
"""
Build the widget for the given item. Works inside Frame in async
mode. Once the widget is created, it will replace the content of the
frame. It allow to await something for a while and create the widget
when the result is available.
"""
result, entry = await omni.client.stat_async(item.path)
if result != omni.client.Result.OK:
ui.Label("Error", style_type_name_override="TreeView.Item")
return
flags = entry.access
text = ""
if flags & omni.client.AccessFlags.READ:
text += "R"
if flags & omni.client.AccessFlags.WRITE:
text += "W"
if flags & omni.client.AccessFlags.ADMIN:
text += "A"
text = text or "none"
ui.Label(text, style_type_name_override="TreeView.Item")
| 2,467 | Python | 29.85 | 76 | 0.653425 |
omniverse-code/kit/exts/omni.kit.filebrowser_column.acl/omni/kit/filebrowser_column/acl/tests/acl_test.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 ..acl_delegate import AclDelegate
from ..acl_delegate import ColumnItem
from omni.ui.tests.test_base import OmniUiTest
from pathlib import Path
import asyncio
import omni.kit.app
import omni.ui as ui
import tempfile
CURRENT_PATH = Path(__file__).parent.joinpath("../../../../../data")
class AwaitWithFrame:
"""
A future-like object that runs the given future and makes sure it's
always in the given frame's scope. It allows for creating widgets
asynchronously.
"""
def __init__(self, frame: ui.Frame, future: asyncio.Future):
self._frame = frame
self._future = future
def __await__(self):
# create an iterator object from that iterable
iter_obj = iter(self._future.__await__())
# infinite loop
while True:
try:
with self._frame:
yield next(iter_obj)
except StopIteration:
break
self._frame = None
self._future = None
class TestAcl(OmniUiTest):
# Before running each test
async def setUp(self):
await super().setUp()
self._golden_img_dir = CURRENT_PATH.absolute().resolve().joinpath("tests")
# After running each test
async def tearDown(self):
self._golden_img_dir = None
await super().tearDown()
async def test_general(self):
temp = tempfile.NamedTemporaryFile()
window = await self.create_test_window()
with window.frame:
frame = ui.Frame(style={"TreeView.Item": {"color": 0xFFFFFFFF}})
item = ColumnItem(temp.name)
delegate = AclDelegate()
await AwaitWithFrame(frame, delegate.build_widget(item))
await omni.kit.app.get_app().next_update_async()
await self.finalize_test(golden_img_dir=self._golden_img_dir)
temp.close() | 2,284 | Python | 29.466666 | 82 | 0.652364 |
omniverse-code/kit/exts/omni.kit.window.splash/omni/splash/__init__.py | from ._splash import *
| 23 | Python | 10.999995 | 22 | 0.695652 |
omniverse-code/kit/exts/omni.kit.window.splash/omni/splash/tests/__init__.py | from .test_splash import *
| 27 | Python | 12.999994 | 26 | 0.740741 |
omniverse-code/kit/exts/omni.kit.window.splash/omni/splash/tests/test_splash.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 omni.kit.app
from omni.kit.test import AsyncTestCase
import omni.splash
class TestSplash(AsyncTestCase):
async def setUp(self):
self._splash_iface = omni.splash.acquire_splash_screen_interface()
async def tearDown(self):
pass
async def test_001_close_autocreated(self):
# This test just closes the automatically created by the extension on startup
self._splash_iface.close_all()
async def test_002_create_destroy_splash(self):
splash = self._splash_iface.create("${resources}/splash/splash.png", 1.0)
self._splash_iface.show(splash)
for _ in range(3):
await omni.kit.app.get_app().next_update_async()
self.assertTrue(self._splash_iface.is_valid(splash))
for _ in range(3):
await omni.kit.app.get_app().next_update_async()
self._splash_iface.close(splash)
| 1,350 | Python | 31.951219 | 85 | 0.704444 |
omniverse-code/kit/exts/omni.kit.capture.viewport/omni/kit/capture/viewport/capture_progress.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 os
import asyncio
from enum import Enum, IntEnum
import datetime
import subprocess
import carb
import omni.ui as ui
import omni.kit.app
class CaptureStatus(IntEnum):
NONE = 0
CAPTURING = 1
PAUSED = 2
FINISHING = 3
TO_START_ENCODING = 4
ENCODING = 5
CANCELLED = 6
class CaptureProgress:
def __init__(self):
self._init_internal()
def _init_internal(self, total_frames=1):
self._total_frames = total_frames
# at least to capture 1 frame
if self._total_frames < 1:
self._total_frames = 1
self._capture_status = CaptureStatus.NONE
self._elapsed_time = 0.0
self._estimated_time_remaining = 0.0
self._current_frame_time = 0.0
self._average_time_per_frame = 0.0
self._encoding_time = 0.0
self._current_frame = 0
self._first_frame_num = 0
self._got_first_frame = False
self._progress = 0.0
self._current_subframe = -1
self._total_subframes = 1
self._subframe_time = 0.0
self._total_frame_time = 0.0
self._average_time_per_subframe = 0.0
self._total_preroll_frames = 0
self._prerolled_frames = 0
self._path_trace_iteration_num = 0
self._path_trace_subframe_num = 0
self._total_iterations = 0
self._average_time_per_iteration = 0.0
self._is_handling_settle_latency_frames = False
self._settle_latency_frames_done = 0
self._total_settle_latency_frames = 0
@property
def capture_status(self):
return self._capture_status
@capture_status.setter
def capture_status(self, value):
self._capture_status = value
@property
def elapsed_time(self):
return self._get_time_string(self._elapsed_time)
@property
def estimated_time_remaining(self):
return self._get_time_string(self._estimated_time_remaining)
@property
def current_frame_time(self):
return self._get_time_string(self._current_frame_time)
@property
def average_frame_time(self):
return self._get_time_string(self._average_time_per_frame)
@property
def encoding_time(self):
return self._get_time_string(self._encoding_time)
@property
def progress(self):
return self._progress
@property
def current_subframe(self):
return self._current_subframe if self._current_subframe >= 0 else 0
@property
def total_subframes(self):
return self._total_subframes
@property
def subframe_time(self):
return self._get_time_string(self._subframe_time)
@property
def average_time_per_subframe(self):
return self._get_time_string(self._average_time_per_subframe)
@property
def total_preroll_frames(self):
return self._total_preroll_frames
@total_preroll_frames.setter
def total_preroll_frames(self, value):
self._total_preroll_frames = value
@property
def prerolled_frames(self):
return self._prerolled_frames
@prerolled_frames.setter
def prerolled_frames(self, value):
self._prerolled_frames = value
@property
def path_trace_iteration_num(self):
return self._path_trace_iteration_num
@path_trace_iteration_num.setter
def path_trace_iteration_num(self, value):
self._path_trace_iteration_num = value
@property
def path_trace_subframe_num(self):
return self._path_trace_subframe_num
@path_trace_subframe_num.setter
def path_trace_subframe_num(self, value):
self._path_trace_subframe_num = value
@property
def total_iterations(self):
return self._total_iterations
@property
def average_time_per_iteration(self):
return self._get_time_string(self._average_time_per_iteration)
@property
def current_frame_count(self):
return self._current_frame - self._first_frame_num
@property
def total_frames(self):
return self._total_frames
@property
def is_handling_settle_latency_frames(self):
return self._is_handling_settle_latency_frames
@property
def settle_latency_frames_done(self):
return self._settle_latency_frames_done
@property
def total_settle_latency_frames(self):
return self._total_settle_latency_frames
def start_capturing(self, total_frames, preroll_frames=0):
self._init_internal(total_frames)
self._total_preroll_frames = preroll_frames
self._capture_status = CaptureStatus.CAPTURING
def finish_capturing(self):
self._init_internal()
def is_prerolling(self):
return (
(self._capture_status == CaptureStatus.CAPTURING or self._capture_status == CaptureStatus.PAUSED)
and self._total_preroll_frames > 0
and self._total_preroll_frames > self._prerolled_frames
)
def add_encoding_time(self, time):
if self._estimated_time_remaining > 0.0:
self._elapsed_time += self._estimated_time_remaining
self._estimated_time_remaining = 0.0
self._encoding_time += time
def add_frame_time(self, frame, time, pt_subframe_num=0, pt_total_subframes=0, pt_iteration_num=0, pt_iteration_per_subframe=0, \
handling_settle_latency_frames=False, settle_latency_frames_done=0, total_settle_latency_frames=0):
if not self._got_first_frame:
self._got_first_frame = True
self._first_frame_num = frame
self._current_frame = frame
self._path_trace_subframe_num = pt_subframe_num
self._path_trace_iteration_num = pt_iteration_num
self._total_subframes = pt_total_subframes
self._total_iterations = pt_iteration_per_subframe
self._elapsed_time += time
if self._current_frame != frame:
frames_captured = self._current_frame - self._first_frame_num + 1
self._average_time_per_frame = self._elapsed_time / frames_captured
self._current_frame = frame
self._current_frame_time = time
else:
self._current_frame_time += time
if frame == self._first_frame_num:
self._estimated_time_remaining = 0.0
self._progress = 0.0
else:
total_frame_time = self._average_time_per_frame * self._total_frames
# if users pause for long times, or there are skipped frames, it's possible that elapsed time will be greater than estimated total time
# if this happens, estimate it again
if self._elapsed_time >= total_frame_time:
if self._elapsed_time < time + self._average_time_per_frame:
total_frame_time += time + self._average_time_per_frame
else:
total_frame_time = self._elapsed_time + self._average_time_per_frame * (self._total_frames - self._current_frame + 1)
self._estimated_time_remaining = total_frame_time - self._elapsed_time
self._progress = self._elapsed_time / total_frame_time
self._is_handling_settle_latency_frames = handling_settle_latency_frames
self._settle_latency_frames_done = settle_latency_frames_done
self._total_settle_latency_frames = total_settle_latency_frames
def add_single_frame_capture_time_for_pt(self, subframe, total_subframes, time):
self._total_subframes = total_subframes
self._elapsed_time += time
if self._current_subframe != subframe:
self._subframe_time = time
if self._current_subframe == -1:
self._average_time_per_subframe = self._elapsed_time
else:
self._average_time_per_subframe = self._elapsed_time / subframe
self._total_frame_time = self._average_time_per_subframe * total_subframes
else:
self._subframe_time += time
self._current_subframe = subframe
if self._current_subframe == 0:
self._estimated_time_remaining = 0.0
self._progress = 0.0
else:
if self._elapsed_time >= self._total_frame_time:
self._total_frame_time += time + self._average_time_per_subframe
self._estimated_time_remaining = self._total_frame_time - self._elapsed_time
self._progress = self._elapsed_time / self._total_frame_time
def add_single_frame_capture_time_for_iray(self, subframe, total_subframes, iterations_done, iterations_per_subframe, time):
self._total_subframes = total_subframes
self._total_iterations = iterations_per_subframe
self._elapsed_time += time
self._path_trace_iteration_num = iterations_done
if self._current_subframe != subframe:
self._subframe_time = time
if self._current_subframe == -1:
self._average_time_per_subframe = self._elapsed_time
else:
self._average_time_per_subframe = self._elapsed_time / subframe
self._total_frame_time = self._average_time_per_subframe * total_subframes
else:
self._subframe_time += time
self._current_subframe = subframe
if self._current_subframe == 0:
self._estimated_time_remaining = 0.0
self._progress = 0.0
else:
if self._elapsed_time >= self._total_frame_time:
self._total_frame_time += time + self._average_time_per_subframe
self._estimated_time_remaining = self._total_frame_time - self._elapsed_time
self._progress = self._elapsed_time / self._total_frame_time
def _get_time_string(self, time_seconds):
hours = int(time_seconds / 3600)
minutes = int((time_seconds - hours*3600) / 60)
seconds = time_seconds - hours*3600 - minutes*60
time_string = ""
if hours > 0:
time_string += '{:d}h '.format(hours)
if minutes > 0:
time_string += '{:d}m '.format(minutes)
else:
if hours > 0:
time_string += "0m "
time_string += '{:.2f}s'.format(seconds)
return time_string
PROGRESS_WINDOW_WIDTH = 360
PROGRESS_WINDOW_HEIGHT = 280
PROGRESS_BAR_WIDTH = 216
PROGRESS_BAR_HEIGHT = 20
PROGRESS_BAR_HALF_HEIGHT = PROGRESS_BAR_HEIGHT / 2
TRIANGLE_WIDTH = 6
TRIANGLE_HEIGHT = 10
TRIANGLE_OFFSET_Y = 10
PROGRESS_WIN_DARK_STYLE = {
"Triangle::progress_marker": {"background_color": 0xFFD1981D},
"Rectangle::progress_bar_background": {
"border_width": 0.5,
"border_radius": PROGRESS_BAR_HALF_HEIGHT,
"background_color": 0xFF888888,
},
"Rectangle::progress_bar_full": {
"border_width": 0.5,
"border_radius": PROGRESS_BAR_HALF_HEIGHT,
"background_color": 0xFFD1981D,
},
"Rectangle::progress_bar": {
"background_color": 0xFFD1981D,
"border_radius": PROGRESS_BAR_HALF_HEIGHT,
"corner_flag": ui.CornerFlag.LEFT,
"alignment": ui.Alignment.LEFT,
},
}
PAUSE_BUTTON_STYLE = {
"NvidiaLight": {
"Button.Label::pause": {"color": 0xFF333333},
"Button.Label::pause:disabled": {"color": 0xFF666666},
},
"NvidiaDark": {
"Button.Label::pause": {"color": 0xFFCCCCCC},
"Button.Label::pause:disabled": {"color": 0xFF666666},
},
}
class CaptureProgressWindow:
def __init__(self):
self._app = omni.kit.app.get_app_interface()
self._update_sub = None
self._window_caption = "Capture Progress"
self._window = None
self._progress = None
self._progress_bar_len = PROGRESS_BAR_HALF_HEIGHT
self._progress_step = 0.5
self._is_single_frame_mode = False
self._show_pt_subframes = False
self._show_pt_iterations = False
self._support_pausing = True
self._is_external_window = False
def show(
self,
progress,
single_frame_mode: bool = False,
show_pt_subframes: bool = False,
show_pt_iterations: bool = False,
support_pausing: bool = True,
) -> None:
self._progress = progress
self._is_single_frame_mode = single_frame_mode
self._show_pt_subframes = show_pt_subframes
self._show_pt_iterations = show_pt_iterations
self._support_pausing = support_pausing
self._build_ui()
self._update_sub = self._app.get_update_event_stream().create_subscription_to_pop(
self._on_update, name="omni.kit.capure.viewport progress"
)
def close(self):
if self._is_external_window:
asyncio.ensure_future(self._move_back_to_main_window())
else:
self._window.destroy()
self._window = None
self._update_sub = None
def move_to_external_window(self):
self._window.move_to_new_os_window()
self._is_external_window = True
def move_to_main_window(self):
asyncio.ensure_future(self._move_back_to_main_window())
self._is_external_window = False
def is_external_window(self):
return self._is_external_window
async def _move_back_to_main_window(self):
self._window.move_to_main_os_window()
for i in range(2):
await omni.kit.app.get_app().next_update_async()
self._window.destroy()
self._window = None
self._is_external_window = False
def _build_progress_bar(self):
self._progress_bar_area.clear()
self._progress_bar_area.set_style(PROGRESS_WIN_DARK_STYLE)
with self._progress_bar_area:
with ui.Placer(offset_x=self._progress_bar_len - TRIANGLE_WIDTH / 2, offset_y=TRIANGLE_OFFSET_Y):
ui.Triangle(
name="progress_marker",
width=TRIANGLE_WIDTH,
height=TRIANGLE_HEIGHT,
alignment=ui.Alignment.CENTER_BOTTOM,
)
with ui.ZStack():
ui.Rectangle(name="progress_bar_background", width=PROGRESS_BAR_WIDTH, height=PROGRESS_BAR_HEIGHT)
ui.Rectangle(name="progress_bar", width=self._progress_bar_len, height=PROGRESS_BAR_HEIGHT)
def _build_ui_timer(self, text, init_value):
with ui.HStack():
with ui.HStack(width=ui.Percent(50)):
ui.Spacer()
ui.Label(text, width=0)
with ui.HStack(width=ui.Percent(50)):
ui.Spacer(width=15)
timer_label = ui.Label(init_value)
ui.Spacer()
return timer_label
def _build_multi_frames_capture_timers(self):
self._ui_elapsed_time = self._build_ui_timer("Elapsed time", self._progress.elapsed_time)
self._ui_remaining_time = self._build_ui_timer("Estimated time remaining", self._progress.estimated_time_remaining)
frame_count_str = f"{self._progress.current_frame_count}/{self._progress.total_frames}"
self._ui_frame_count = self._build_ui_timer("Current/Total frames", frame_count_str)
self._ui_current_frame_time = self._build_ui_timer("Current frame time", self._progress.current_frame_time)
if self._show_pt_subframes:
subframes_str = f"{self._progress.path_trace_subframe_num}/{self._progress.total_subframes}"
self._ui_pt_subframes = self._build_ui_timer("Subframe/Total subframes", subframes_str)
if self._show_pt_iterations:
subframes_str = f"{self._progress.path_trace_subframe_num}/{self._progress.total_subframes}"
self._ui_pt_subframes = self._build_ui_timer("Subframe/Total subframes", subframes_str)
iter_str = f"{self._progress.path_trace_iteration_num}/{self._progress.total_iterations}"
self._ui_pt_iterations = self._build_ui_timer("Iterations done/Total", iter_str)
self._ui_ave_frame_time = self._build_ui_timer("Average time per frame", self._progress.average_frame_time)
self._ui_encoding_time = self._build_ui_timer("Encoding", self._progress.encoding_time)
def _build_single_frame_capture_timers(self):
self._ui_elapsed_time = self._build_ui_timer("Elapsed time", self._progress.elapsed_time)
self._ui_remaining_time = self._build_ui_timer("Estimated time remaining", self._progress.estimated_time_remaining)
if self._show_pt_subframes:
subframe_count = f"{self._progress.current_subframe}/{self._progress.total_subframes}"
self._ui_subframe_count = self._build_ui_timer("Subframe/Total subframes", subframe_count)
self._ui_current_frame_time = self._build_ui_timer("Current subframe time", self._progress.subframe_time)
self._ui_ave_frame_time = self._build_ui_timer("Average time per subframe", self._progress.average_time_per_subframe)
if self._show_pt_iterations:
subframe_count = f"{self._progress.current_subframe}/{self._progress.total_subframes}"
self._ui_subframe_count = self._build_ui_timer("Subframe/Total subframes", subframe_count)
iteration_count = f"{self._progress.path_trace_iteration_num}/{self._progress.total_iterations}"
self._ui_iteration_count = self._build_ui_timer("Iterations done/Per subframe", iteration_count)
# self._ui_ave_iteration_time = self._build_ui_timer("Average time per iteration", self._progress.average_time_per_iteration)
self._ui_ave_frame_time = self._build_ui_timer("Average time per subframe", self._progress.average_time_per_subframe)
def _build_notification_area(self):
with ui.HStack():
ui.Spacer(width=ui.Percent(20))
self._notification = ui.Label("")
ui.Spacer(width=ui.Percent(10))
def _build_ui(self):
if self._window is None:
style_settings = carb.settings.get_settings().get("/persistent/app/window/uiStyle")
if not style_settings:
style_settings = "NvidiaDark"
self._window = ui.Window(
self._window_caption,
width=PROGRESS_WINDOW_WIDTH,
height=PROGRESS_WINDOW_HEIGHT,
style=PROGRESS_WIN_DARK_STYLE,
)
with self._window.frame:
with ui.VStack():
with ui.HStack():
ui.Spacer(width=ui.Percent(20))
self._progress_bar_area = ui.VStack()
self._build_progress_bar()
ui.Spacer(width=ui.Percent(20))
ui.Spacer(height=5)
if self._is_single_frame_mode:
self._build_single_frame_capture_timers()
else:
self._build_multi_frames_capture_timers()
self._build_notification_area()
with ui.HStack():
with ui.HStack(width=ui.Percent(50)):
ui.Spacer()
self._ui_pause_button = ui.Button(
"Pause",
height=0,
clicked_fn=self._on_pause_clicked,
enabled=self._support_pausing,
style=PAUSE_BUTTON_STYLE[style_settings],
name="pause",
)
with ui.HStack(width=ui.Percent(50)):
ui.Spacer(width=15)
ui.Button("Cancel", height=0, clicked_fn=self._on_cancel_clicked)
ui.Spacer()
ui.Spacer()
self._window.visible = True
self._update_timers()
def _on_pause_clicked(self):
if self._progress.capture_status == CaptureStatus.CAPTURING and self._ui_pause_button.text == "Pause":
self._progress.capture_status = CaptureStatus.PAUSED
self._ui_pause_button.text = "Resume"
elif self._progress.capture_status == CaptureStatus.PAUSED:
self._progress.capture_status = CaptureStatus.CAPTURING
self._ui_pause_button.text = "Pause"
def _on_cancel_clicked(self):
if (
self._progress.capture_status == CaptureStatus.CAPTURING
or self._progress.capture_status == CaptureStatus.PAUSED
):
self._progress.capture_status = CaptureStatus.CANCELLED
def _update_timers(self):
if self._is_single_frame_mode:
self._ui_elapsed_time.text = self._progress.elapsed_time
self._ui_remaining_time.text = self._progress.estimated_time_remaining
if self._show_pt_subframes:
subframe_count = f"{self._progress.current_subframe}/{self._progress.total_subframes}"
self._ui_subframe_count.text = subframe_count
self._ui_current_frame_time.text = self._progress.subframe_time
self._ui_ave_frame_time.text = self._progress.average_time_per_subframe
if self._show_pt_iterations:
subframe_count = f"{self._progress.current_subframe}/{self._progress.total_subframes}"
self._ui_subframe_count.text = subframe_count
iteration_count = f"{self._progress.path_trace_iteration_num}/{self._progress.total_iterations}"
self._ui_iteration_count.text = iteration_count
self._ui_ave_frame_time.text = self._progress.average_time_per_subframe
else:
self._ui_elapsed_time.text = self._progress.elapsed_time
self._ui_remaining_time.text = self._progress.estimated_time_remaining
frame_count_str = f"{self._progress.current_frame_count}/{self._progress.total_frames}"
self._ui_frame_count.text = frame_count_str
self._ui_current_frame_time.text = self._progress.current_frame_time
if self._show_pt_subframes:
subframes_str = f"{self._progress.path_trace_subframe_num}/{self._progress.total_subframes}"
self._ui_pt_subframes.text = subframes_str
if self._show_pt_iterations:
subframes_str = f"{self._progress.path_trace_subframe_num}/{self._progress.total_subframes}"
self._ui_pt_subframes.text = subframes_str
iter_str = f"{self._progress.path_trace_iteration_num}/{self._progress.total_iterations}"
self._ui_pt_iterations.text = iter_str
self._ui_ave_frame_time.text = self._progress.average_frame_time
self._ui_encoding_time.text = self._progress.encoding_time
def _update_notification(self):
if self._progress.capture_status == CaptureStatus.CAPTURING:
if self._progress.is_prerolling():
msg = 'Running preroll frames {}/{}, please wait...'.format(
self._progress.prerolled_frames,
self._progress.total_preroll_frames
)
self._notification.text = msg
elif not self._is_single_frame_mode:
if self._progress.is_handling_settle_latency_frames:
msg = 'Running settle latency frames {}/{}...'.format(
self._progress.settle_latency_frames_done,
self._progress.total_settle_latency_frames
)
self._notification.text = msg
else:
self._notification.text = f"Capturing frame {self._progress.current_frame_count}..."
elif self._progress.capture_status == CaptureStatus.ENCODING:
self._notification.text = "Encoding..."
else:
self._notification.text = ""
def _on_update(self, event):
self._update_notification()
self._update_timers()
self._progress_bar_len = (
PROGRESS_BAR_WIDTH - PROGRESS_BAR_HEIGHT
) * self._progress.progress + PROGRESS_BAR_HALF_HEIGHT
self._build_progress_bar()
| 24,530 | Python | 40.648557 | 147 | 0.605014 |
omniverse-code/kit/exts/omni.kit.capture.viewport/omni/kit/capture/viewport/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 os
import math
import time
import datetime
import asyncio
import omni.ext
import carb
import omni.kit.app
import omni.timeline
import omni.usd
import omni.ui
from pxr import Gf, Sdf
from .capture_options import *
from .capture_progress import *
from .video_generation import VideoGenerationHelper
from .helper import (
get_num_pattern_file_path,
check_render_product_ext_availability,
is_valid_render_product_prim_path,
RenderProductCaptureHelper,
is_kit_104_and_above, # TODO: Remove this as it is no longer used, but kept only if transitively depended on
get_vp_object_visibility,
set_vp_object_visibility,
)
from omni.kit.viewport.utility import get_active_viewport, capture_viewport_to_file
import omni.appwindow
PERSISTENT_SETTINGS_PREFIX = "/persistent"
FILL_VIEWPORT_SETTING = PERSISTENT_SETTINGS_PREFIX + "/app/viewport/{viewport_api_id}/fillViewport"
SEQUENCE_CAPTURE_WAIT = "/app/captureSequence/waitFrames"
MP4_ENCODING_BITRATE_SETTING = "/exts/omni.videoencoding/bitrate"
MP4_ENCODING_IFRAME_INTERVAL_SETTING = "/exts/omni.videoencoding/iframeinterval"
MP4_ENCODING_PRESET_SETTING = "/exts/omni.videoencoding/preset"
MP4_ENCODING_PROFILE_SETTING = "/exts/omni.videoencoding/profile"
MP4_ENCODING_RC_MODE_SETTING = "/exts/omni.videoencoding/rcMode"
MP4_ENCODING_RC_TARGET_QUALITY_SETTING = "/exts/omni.videoencoding/rcTargetQuality"
MP4_ENCODING_VIDEO_FULL_RANGE_SETTING = "/exts/omni.videoencoding/videoFullRangeFlag"
VIDEO_FRAMES_DIR_NAME = "frames"
DEFAULT_IMAGE_FRAME_TYPE_FOR_VIDEO = ".png"
capture_instance = None
class RenderStatus(IntEnum):
# Note render status values from rtx/hydra/HydraRenderResults.h
# Rendering was successful. A path tracer might not have reached a stopping criterion though.
eSuccess = 0
# Rendering was successful and the renderer has reached a stopping criterion on this iteration.
eStopCriterionJustReached = 1
# Rendering was successful and the renderer has reached a stopping criterion.
eStopCriterionReached = 2
# Rendering failed
eFailed = 3
class CaptureExtension(omni.ext.IExt):
def on_startup(self):
global capture_instance
capture_instance = self
self._options = CaptureOptions()
self._progress = CaptureProgress()
self._progress_window = CaptureProgressWindow()
import omni.renderer_capture
self._renderer = omni.renderer_capture.acquire_renderer_capture_interface()
self._viewport_api = None
self._app = omni.kit.app.get_app_interface()
self._timeline = omni.timeline.get_timeline_interface()
self._usd_context = omni.usd.get_context()
self._selection = self._usd_context.get_selection()
self._settings = carb.settings.get_settings()
self._show_default_progress_window = True
self._progress_update_fn = None
self._forward_one_frame_fn = None
self._capture_finished_fn = None
self._to_capture_render_product = False
self._render_product_path_for_capture = ""
self._is_adaptivesampling_stop_criterion_reached = False
class ReshadeUpdateState():
PRE_CAPTURE = 0
POST_CAPTURE = 1
POST_CAPTURE_READY = 3
def on_shutdown(self):
self._progress = None
self._progress_window = None
global capture_instance
capture_instance = None
@property
def options(self):
return self._options
@options.setter
def options(self, value):
self._options = value
@property
def progress(self):
return self._progress
@property
def show_default_progress_window(self):
return self._show_default_progress_window
@show_default_progress_window.setter
def show_default_progress_window(self, value):
self._show_default_progress_window = value
@property
def progress_update_fn(self):
return self._progress_update_fn
@progress_update_fn.setter
def progress_update_fn(self, value):
self._progress_update_fn = value
@property
def forward_one_frame_fn(self):
return self._forward_one_frame_fn
@forward_one_frame_fn.setter
def forward_one_frame_fn(self, value):
self._forward_one_frame_fn = value
@property
def capture_finished_fn(self):
return self._capture_finished_fn
@capture_finished_fn.setter
def capture_finished_fn(self, value):
self._capture_finished_fn = value
def start(self):
self._to_capture_render_product = self._check_if_to_capture_render_product()
if self._to_capture_render_product:
self._render_product_path_for_capture = RenderProductCaptureHelper.prepare_render_product_for_capture(
self._options.render_product,
self._options.camera,
Gf.Vec2i(self._options.res_width, self._options.res_height)
)
if len(self._render_product_path_for_capture) == 0:
carb.log_warn(f"Capture will use render product {self._options.render_product}'s original camera and resolution because it failed to make a copy of it for processing.")
self._render_product_path_for_capture = self._options.render_product
# use usd time code for animation play during capture, caption option's fps setting for movie encoding
if CaptureOptions.INVALID_ANIMATION_FPS == self._options.animation_fps:
self._capture_fps = self._timeline.get_time_codes_per_seconds()
else:
self._capture_fps = self._options.animation_fps
if not self._prepare_folder_and_counters():
if self._render_product_path_for_capture != self._options.render_product:
RenderProductCaptureHelper.remove_render_product_for_capture(self._render_product_path_for_capture)
self._render_product_path_for_capture = ""
return
if self._prepare_viewport():
self._start_internal()
def pause(self):
if self._progress.capture_status == CaptureStatus.CAPTURING and self._ui_pause_button.text == "Pause":
self._progress.capture_status = CaptureStatus.PAUSED
def resume(self):
if self._progress.capture_status == CaptureStatus.PAUSED:
self._progress.capture_status = CaptureStatus.CAPTURING
def cancel(self):
if (
self._progress.capture_status == CaptureStatus.CAPTURING
or self._progress.capture_status == CaptureStatus.PAUSED
):
self._progress.capture_status = CaptureStatus.CANCELLED
def _update_progress_hook(self):
if self._progress_update_fn is not None:
self._progress_update_fn(
self._progress.capture_status,
self._progress.progress,
self._progress.elapsed_time,
self._progress.estimated_time_remaining,
self._progress.current_frame_time,
self._progress.average_frame_time,
self._progress.encoding_time,
self._frame_counter,
self._total_frame_count,
)
def _get_index_for_image(self, dir, file_name, image_suffix):
def is_int(string_val):
try:
v = int(string_val)
return True
except:
return False
images = os.listdir(dir)
name_len = len(file_name)
suffix_len = len(image_suffix)
max_index = 0
for item in images:
if item.startswith(file_name) and item.endswith(image_suffix):
num_part = item[name_len : (len(item) - suffix_len)]
if is_int(num_part):
num = int(num_part)
if max_index < num:
max_index = num
return max_index + 1
def _float_to_time(self, ft):
hour = int(ft)
ft = (ft - hour) * 60
minute = int(ft)
ft = (ft - minute) * 60
second = int(ft)
ft = (ft - second) * 1000000
microsecond = int(ft)
return datetime.time(hour, minute, second, microsecond)
def _check_if_to_capture_render_product(self):
if len(self._options.render_product) == 0:
return False
omnigraph_exts_available = check_render_product_ext_availability()
if not omnigraph_exts_available:
carb.log_warn(f"Viewport Capture: unable to capture with render product {self._options.render_product} as it needs both omni.graph.nodes and omni.graph.examples.cpp enabled to work.")
return False
viewport_api = get_active_viewport()
render_product_name = viewport_api.render_product_path if viewport_api else None
if not render_product_name:
carb.log_warn(f"Viewport Capture: unable to capture with render product {self._options.render_product} as Kit SDK needs updating to support viewport window render product APIs: {e}")
return False
if is_valid_render_product_prim_path(self._options.render_product):
return True
else:
carb.log_warn(f"Viewport Capture: unable to capture with render product {self._options.render_product} as it's not a valid Render Product prim path")
return False
def _is_environment_sunstudy_player(self):
if self._options.sunstudy_player is not None:
return type(self._options.sunstudy_player).__module__ == "omni.kit.environment.core.sunstudy_player.player"
else:
carb.log_warn("Sunstudy player type check is valid only when the player is available.")
return False
def _update_sunstudy_player_time(self):
if self._is_environment_sunstudy_player():
self._options.sunstudy_player.current_time = self._sunstudy_current_time
else:
self._options.sunstudy_player.update_time(self._sunstudy_current_time)
def _set_sunstudy_player_time(self, current_time):
if self._is_environment_sunstudy_player():
self._options.sunstudy_player.current_time = current_time
else:
date_time = self._options.sunstudy_player.get_date_time()
time_to_set = self._float_to_time(current_time)
new_date_time = datetime.datetime(
date_time.year, date_time.month, date_time.day,
time_to_set.hour, time_to_set.minute, time_to_set.second
)
self._options.sunstudy_player.set_date_time(new_date_time)
def _prepare_sunstudy_counters(self):
self._total_frame_count = self._options.fps * self._options.sunstudy_movie_length_in_seconds
duration = self._options.sunstudy_end_time - self._options.sunstudy_start_time
self._sunstudy_iterations_per_frame = self._options.ptmb_subframes_per_frame
self._sunstudy_delta_time_per_iteration = duration / float(self._total_frame_count * self._sunstudy_iterations_per_frame)
self._sunstudy_current_time = self._options.sunstudy_start_time
self._set_sunstudy_player_time(self._sunstudy_current_time)
def _prepare_folder_and_counters(self):
self._workset_dir = self._options.output_folder
if not self._make_sure_directory_writeable(self._workset_dir):
carb.log_warn(f"Capture failed due to unable to create folder {self._workset_dir} or this folder is not writeable.")
self._finish()
return False
if self._options.is_capturing_nth_frames():
if self._options.capture_every_Nth_frames == 1:
frames_folder = self._options.file_name + "_frames"
else:
frames_folder = self._options.file_name + "_" + str(self._options.capture_every_Nth_frames) + "th_frames"
self._nth_frames_dir = os.path.join(self._workset_dir, frames_folder)
if not self._make_sure_directory_existed(self._nth_frames_dir):
carb.log_warn(f"Capture failed due to unable to create folder {self._nth_frames_dir}")
self._finish()
return False
if self._options.is_video():
self._frames_dir = os.path.join(self._workset_dir, self._options.file_name + "_" + VIDEO_FRAMES_DIR_NAME)
if not self._make_sure_directory_existed(self._frames_dir):
carb.log_warn(
f"Capture failed due to unable to create folder {self._workset_dir} to save frames of the video."
)
self._finish()
return False
self._video_name = self._options.get_full_path()
self._frame_pattern_prefix = os.path.join(self._frames_dir, self._options.file_name)
if self._options.is_capturing_frame():
self._start_time = float(self._options.start_frame) / self._capture_fps
self._end_time = float(self._options.end_frame + 1) / self._capture_fps
self._time = self._start_time
self._frame = self._options.start_frame
self._start_number = self._frame
self._total_frame_count = round((self._end_time - self._start_time) * self._capture_fps)
else:
self._start_time = self._options.start_time
self._end_time = self._options.end_time
self._time = self._options.start_time
self._frame = int(self._options.start_time * self._capture_fps)
self._start_number = self._frame
self._total_frame_count = math.ceil((self._end_time - self._start_time) * self._capture_fps)
if self._options.movie_type == CaptureMovieType.SUNSTUDY:
self._prepare_sunstudy_counters()
else:
if self._options.is_capturing_nth_frames():
self._frame_pattern_prefix = self._nth_frames_dir
if self._options.is_capturing_frame():
self._start_time = float(self._options.start_frame) / self._capture_fps
self._end_time = float(self._options.end_frame + 1) / self._capture_fps
self._time = self._start_time
self._frame = self._options.start_frame
self._start_number = self._frame
self._total_frame_count = round((self._end_time - self._start_time) * self._capture_fps)
else:
self._start_time = self._options.start_time
self._end_time = self._options.end_time
self._time = self._options.start_time
self._frame = int(self._options.start_time * self._capture_fps)
self._start_number = self._frame
self._total_frame_count = math.ceil((self._end_time - self._start_time) * self._capture_fps)
if self._options.movie_type == CaptureMovieType.SUNSTUDY:
self._prepare_sunstudy_counters()
else:
index = self._get_index_for_image(self._workset_dir, self._options.file_name, self._options.file_type)
self._frame_pattern_prefix = os.path.join(self._workset_dir, self._options.file_name + str(index))
self._start_time = self._timeline.get_current_time()
self._end_time = self._timeline.get_current_time()
self._time = self._timeline.get_current_time()
self._frame = 1
self._start_number = self._frame
self._total_frame_count = 1
self._subframe = 0
self._sample_count = 0
self._frame_counter = 0
self._real_time_settle_latency_frames_done = 0
self._settle_latency_frames = self._get_settle_latency_frames()
self._last_skipped_frame_path = ""
self._path_trace_iterations = 0
self._time_rate = 1.0 / self._capture_fps
self._time_subframe_rate = (
self._time_rate * (self._options.ptmb_fsc - self._options.ptmb_fso) / self._options.ptmb_subframes_per_frame
)
return True
def _prepare_viewport(self):
viewport_api = get_active_viewport()
if viewport_api is None:
return False
self._is_legacy_vp = hasattr(viewport_api, 'legacy_window')
self._record_current_window_status(viewport_api)
capture_camera = Sdf.Path(self._options.camera)
if capture_camera != self._saved_camera:
viewport_api.camera_path = capture_camera
if not self._is_legacy_vp:
viewport_api.updates_enabled = True
if self._saved_fill_viewport_option:
fv_setting_path = FILL_VIEWPORT_SETTING.format(viewport_api_id=viewport_api.id)
# for application level capture, we want it to fill the viewport to make the viewport resolution the same to application window resolution
# while for viewport capture, we can get images with the correct resolution so doesn't need it to fill viewport
self._settings.set(fv_setting_path, self._options.app_level_capture)
capture_resolution = (self._options.res_width, self._options.res_height)
if capture_resolution != (self._saved_resolution_width, self._saved_resolution_height):
viewport_api.resolution = capture_resolution
self._settings.set_bool("/persistent/app/captureFrame/viewport", True)
self._settings.set_bool("/app/captureFrame/setAlphaTo1", not self._options.save_alpha)
if self._options.file_type == ".exr":
self._settings.set_bool("/app/captureFrame/hdr", self._options.hdr_output)
else:
self._settings.set_bool("/app/captureFrame/hdr", False)
if self._options.save_alpha:
self._settings.set_bool("/rtx/post/backgroundZeroAlpha/enabled", True)
self._settings.set_bool("/rtx/post/backgroundZeroAlpha/backgroundComposite", False)
if self._options.hdr_output:
self._settings.set_bool("/rtx/post/backgroundZeroAlpha/ApplyAlphaZeroPassFirst", True)
if self._to_capture_render_product:
viewport_api.render_product_path = self._render_product_path_for_capture
# we only clear selection for non application level capture, other we will lose the ui.scene elemets during capture
if not self._options.app_level_capture:
self._selection.clear_selected_prim_paths()
if self._options.render_preset == CaptureRenderPreset.RAY_TRACE:
self._switch_renderer = self._saved_hd_engine != "rtx" or self._saved_render_mode != "RaytracedLighting"
if self._switch_renderer:
viewport_api.set_hd_engine("rtx", "RaytracedLighting")
carb.log_info("Switching to RayTracing Mode")
elif self._options.render_preset == CaptureRenderPreset.PATH_TRACE:
self._switch_renderer = self._saved_hd_engine != "rtx" or self._saved_render_mode != "PathTracing"
if self._switch_renderer:
viewport_api.set_hd_engine("rtx", "PathTracing")
carb.log_info("Switching to PathTracing Mode")
elif self._options.render_preset == CaptureRenderPreset.IRAY:
self._switch_renderer = self._saved_hd_engine != "iray" or self._saved_render_mode != "iray"
if self._switch_renderer:
viewport_api.set_hd_engine("iray", "iray")
carb.log_info("Switching to IRay Mode")
# now that Iray is not loaded automatically until renderer gets switched
# we have to save and set the Iray settings after the renderer switch
self._record_and_set_iray_settings()
else:
self._switch_renderer = False
carb.log_info("Keeping current Render Mode")
if self._options.debug_material_type == CaptureDebugMaterialType.SHADED:
self._settings.set_int("/rtx/debugMaterialType", -1)
elif self._options.debug_material_type == CaptureDebugMaterialType.WHITE:
self._settings.set_int("/rtx/debugMaterialType", 0)
else:
carb.log_info("Keeping current debug mateiral type")
# tell timeline window to stop force checks of end time so that it won't affect capture range
self._settings.set_bool("/exts/omni.anim.window.timeline/playinRange", False)
# set it to 0 to ensure we accumulate as many samples as requested even across subframes (for motion blur)
# for non-motion blur path trace capture, we now rely on adaptive sampling's return status to decide if it's still
# need to do more samples
if self._is_capturing_pt_mb():
self._settings.set_int("/rtx/pathtracing/totalSpp", 0)
# don't show light and grid during capturing
self._set_vp_object_settings(viewport_api)
# disable async rendering for capture, otherwise it won't capture images correctly
if self._saved_async_rendering:
self._settings.set_bool("/app/asyncRendering", False)
if self._saved_async_renderingLatency:
self._settings.set_bool("/app/asyncRenderingLowLatency", False)
# Rendering to some image buffers additionally require explicitly setting `set_capture_sync(True)`, on top of
# disabling the `/app/asyncRendering` setting. This can otherwise cause images to hold corrupted buffer
# information by erroneously assuming a complete image buffer is available when only a first partial subframe
# has been renderer (as in the case of EXR):
self._renderer.set_capture_sync( self._options.file_type == ".exr" )
# frames to wait for the async settings above to be ready, they will need to be detected by viewport, and
# then viewport will notify the renderer not to do async rendering
self._frames_to_disable_async_rendering = 2
# Normally avoid using a high /rtx/pathtracing/spp setting since it causes GPU
# timeouts for large sample counts. But a value larger than 1 can be useful in Multi-GPU setups
self._settings.set_int(
"/rtx/pathtracing/spp", min(self._options.spp_per_iteration, self._options.path_trace_spp)
)
# Setting resetPtAccumOnlyWhenExternalFrameCounterChanges ensures we control accumulation explicitly
# by simpling changing the /rtx/externalFrameCounter value
self._settings.set_bool("/rtx-transient/resetPtAccumOnlyWhenExternalFrameCounterChanges", True)
# Enable syncLoads in materialDB and Hydra. This is needed to make sure texture updates finish before we start the rendering
self._settings.set("/rtx/materialDb/syncLoads", True)
self._settings.set("/rtx/hydra/materialSyncLoads", True)
self._settings.set("/rtx-transient/resourcemanager/texturestreaming/async", False)
self._settings.set("/rtx-transient/resourcemanager/texturestreaming/streamingBudgetMB", 0)
self._settings.set("/rtx-transient/samplerFeedbackTileSize", 1)
self._settings.set("/rtx-transient/resourcemanager/texturestreaming/evictionFrameLatency", 0)
#for now, reshade needs to be turned off and on again to apply settings
self._settings.set_bool("/rtx/reshade/enable", False)
#need to skip several updates for reshade settings to apply:
self._frames_to_apply_reshade = 2
# these settings need to be True to ensure XR Output Alpha in composited image is right
if not self._saved_output_alpha_in_composite:
self._settings.set("/rtx/post/backgroundZeroAlpha/outputAlphaInComposite", True)
# do not show the minibar of timeline window
self._settings.set("/exts/omni.kit.timeline.minibar/stay_on_playing", False)
# enable sequencer camera
self._settings.set("/persistent/exts/omni.kit.window.sequencer/useSequencerCamera", True)
# set timeline animation fps
if self._capture_fps != self._saved_timeline_fps:
self._timeline.set_time_codes_per_second(self._capture_fps)
# return success
return True
def _show_progress_window(self):
return (
self._options.is_video() or self._options.is_capturing_nth_frames() or (self._options.show_single_frame_progress and self._options.is_capturing_pathtracing_single_frame())
) and self.show_default_progress_window
def _start_internal(self):
# if we want preroll, then set timeline's current time back with the preroll frames' time,
# and rely on timeline to do the preroll using the give timecode
if self._options.preroll_frames > 0:
self._timeline.set_current_time(self._start_time - self._options.preroll_frames / self._capture_fps)
else:
self._timeline.set_current_time(self._start_time)
# initialize Reshade state for update loop
self._reshade_switch_state = self.ReshadeUpdateState.PRE_CAPTURE
# change timeline to be in play state
self._timeline.play(start_timecode=self._start_time*self._capture_fps, end_timecode=self._end_time*self._capture_fps, looping=False)
# disable automatic time update in timeline so that movie capture tool can control time step
self._timeline.set_auto_update(False)
self._update_sub = (
omni.kit.app.get_app().get_update_event_stream().create_subscription_to_pop(self._on_update, order=1000000)
)
self._is_adaptivesampling_stop_criterion_reached = False
self._progress.start_capturing(self._total_frame_count, self._options.preroll_frames)
# always show single frame capture progress for PT mode
self._options.show_single_frame_progress = True
if self._show_progress_window():
self._progress_window.show(
self._progress,
self._options.is_capturing_pathtracing_single_frame(),
show_pt_subframes=self._options.render_preset == CaptureRenderPreset.PATH_TRACE,
show_pt_iterations=self._options.render_preset == CaptureRenderPreset.IRAY
)
# prepare for application level capture
if self._options.app_level_capture:
# move the progress window to external window, and then hide application UI
if self._show_progress_window():
self._progress_window.move_to_external_window()
self._settings.set("/app/window/hideUi", True)
def _record_and_set_iray_settings(self):
if self._options.render_preset == CaptureRenderPreset.IRAY:
self._saved_iray_sample_limit = self._settings.get_as_int("/rtx/iray/progressive_rendering_max_samples")
self._settings.set("/rtx/iray/progressive_rendering_max_samples", self._options.path_trace_spp)
self._saved_iray_render_sync_flag = self._settings.get_as_bool("/iray/render_synchronous")
if not self._saved_iray_render_sync_flag:
self._settings.set_bool("/iray/render_synchronous", True)
def _restore_iray_settings(self):
if self._options.render_preset == CaptureRenderPreset.IRAY:
self._settings.set_bool("/iray/render_synchronous", self._saved_iray_render_sync_flag)
self._settings.set("/rtx/iray/progressive_rendering_max_samples", self._saved_iray_sample_limit)
def __save_mp4_encoding_settings(self):
self._saved_mp4_encoding_bitrate = self._settings.get_as_int(MP4_ENCODING_BITRATE_SETTING)
self._saved_mp4_encoding_iframe_interval = self._settings.get_as_int(MP4_ENCODING_IFRAME_INTERVAL_SETTING)
self._saved_mp4_encoding_preset = self._settings.get(MP4_ENCODING_PRESET_SETTING)
self._saved_mp4_encoding_profile = self._settings.get(MP4_ENCODING_PROFILE_SETTING)
self._saved_mp4_encoding_rc_mode = self._settings.get(MP4_ENCODING_RC_MODE_SETTING)
self._saved_mp4_encoding_rc_target_quality = self._settings.get(MP4_ENCODING_RC_TARGET_QUALITY_SETTING)
self._saved_mp4_encoding_video_full_range_flag = self._settings.get(MP4_ENCODING_VIDEO_FULL_RANGE_SETTING)
def __set_mp4_encoding_settings(self):
self._settings.set(MP4_ENCODING_BITRATE_SETTING, self._options.mp4_encoding_bitrate)
self._settings.set(MP4_ENCODING_IFRAME_INTERVAL_SETTING, self._options.mp4_encoding_iframe_interval)
self._settings.set(MP4_ENCODING_PRESET_SETTING, self._options.mp4_encoding_preset)
self._settings.set(MP4_ENCODING_PROFILE_SETTING, self._options.mp4_encoding_profile)
self._settings.set(MP4_ENCODING_RC_MODE_SETTING, self._options.mp4_encoding_rc_mode)
self._settings.set(MP4_ENCODING_RC_TARGET_QUALITY_SETTING, self._options.mp4_encoding_rc_target_quality)
self._settings.set(MP4_ENCODING_VIDEO_FULL_RANGE_SETTING, self._options.mp4_encoding_video_full_range_flag)
def _save_and_set_mp4_encoding_settings(self):
if self._options.is_video():
self.__save_mp4_encoding_settings()
self.__set_mp4_encoding_settings()
def _restore_mp4_encoding_settings(self):
if self._options.is_video():
self._settings.set(MP4_ENCODING_BITRATE_SETTING, self._saved_mp4_encoding_bitrate)
self._settings.set(MP4_ENCODING_IFRAME_INTERVAL_SETTING, self._saved_mp4_encoding_iframe_interval)
self._settings.set(MP4_ENCODING_PRESET_SETTING, self._saved_mp4_encoding_preset)
self._settings.set(MP4_ENCODING_PROFILE_SETTING, self._saved_mp4_encoding_profile)
self._settings.set(MP4_ENCODING_RC_MODE_SETTING, self._saved_mp4_encoding_rc_mode)
self._settings.set(MP4_ENCODING_RC_TARGET_QUALITY_SETTING, self._saved_mp4_encoding_rc_target_quality)
self._settings.set(MP4_ENCODING_VIDEO_FULL_RANGE_SETTING, self._saved_mp4_encoding_video_full_range_flag)
def _save_and_set_application_capture_settings(self):
# as in application capture mode, we actually capture the window size instead of the renderer output, thus we do this with two steps:
# 1. set it to fill the viewport, and padding to (0, -1) to make viewport's size equals to application window size
# 2. resize application window to the resolution that users set in movie capture, so that we can save the images with the desired resolution
# this is not ideal because when we resize the application window, the size is actaully limited by the screen resolution so it's possible that
# the resulting window size could be smaller than what we want.
# also, it's more intuitive that padding should be (0, 0), but it has to be (0, -1) after tests as we still have 1 pixel left at top and bottom.
if self._options.app_level_capture:
vp_window = omni.ui.Workspace.get_window("Viewport")
self._saved_viewport_padding_x = vp_window.padding_x
self._saved_viewport_padding_y = vp_window.padding_y
vp_window.padding_x = 0
vp_window.padding_y = -1
app_window_factory = omni.appwindow.acquire_app_window_factory_interface()
app_window = app_window_factory.get_app_window()
self._saved_app_window_size = app_window.get_size()
app_window.resize(self._options.res_width, self._options._res_height)
def _restore_application_capture_settings(self):
if self._options.app_level_capture:
vp_window = omni.ui.Workspace.get_window("Viewport")
vp_window.padding_x = self._saved_viewport_padding_x
vp_window.padding_y = self._saved_viewport_padding_y
app_window_factory = omni.appwindow.acquire_app_window_factory_interface()
app_window = app_window_factory.get_app_window()
app_window.resize(self._saved_app_window_size[0], self._saved_app_window_size[1])
def _record_vp_object_settings(self, viewport_api) -> None:
self._saved_display_outline = get_vp_object_visibility(viewport_api, "guide/selection")
self._saved_display_lights = get_vp_object_visibility(viewport_api, "scene/lights")
self._saved_display_audio = get_vp_object_visibility(viewport_api, "scene/audio")
self._saved_display_camera = get_vp_object_visibility(viewport_api, "scene/cameras")
self._saved_display_grid = get_vp_object_visibility(viewport_api, "guide/grid")
def _set_vp_object_settings(self, viewport_api) -> None:
set_vp_object_visibility(viewport_api, "guide/selection", False)
set_vp_object_visibility(viewport_api, "scene/lights", False)
set_vp_object_visibility(viewport_api, "scene/audio", False)
set_vp_object_visibility(viewport_api, "scene/cameras", False)
set_vp_object_visibility(viewport_api, "guide/grid", False)
def _restore_vp_object_settings(self, viewport_api):
set_vp_object_visibility(viewport_api, "guide/selection", self._saved_display_outline)
set_vp_object_visibility(viewport_api, "scene/lights", self._saved_display_lights)
set_vp_object_visibility(viewport_api, "scene/audio", self._saved_display_audio)
set_vp_object_visibility(viewport_api, "scene/cameras", self._saved_display_camera)
set_vp_object_visibility(viewport_api, "guide/grid", self._saved_display_grid)
def _record_current_window_status(self, viewport_api):
assert viewport_api is not None, "No viewport to record to"
self._viewport_api = viewport_api
self._saved_camera = viewport_api.camera_path
self._saved_hydra_engine = viewport_api.hydra_engine
if not self._is_legacy_vp:
self._saved_vp_updates_enabled = self._viewport_api.updates_enabled
fv_setting_path = FILL_VIEWPORT_SETTING.format(viewport_api_id=self._viewport_api.id)
self._saved_fill_viewport_option = self._settings.get_as_bool(fv_setting_path)
resolution = viewport_api.resolution
self._saved_resolution_width = int(resolution[0])
self._saved_resolution_height = int(resolution[1])
self._saved_hd_engine = viewport_api.hydra_engine
self._saved_render_mode = viewport_api.render_mode
self._saved_capture_frame_viewport = self._settings.get("/persistent/app/captureFrame/viewport")
self._saved_debug_material_type = self._settings.get_as_int("/rtx/debugMaterialType")
self._saved_total_spp = self._settings.get_as_int("/rtx/pathtracing/totalSpp")
self._saved_spp = self._settings.get_as_int("/rtx/pathtracing/spp")
self._saved_reset_pt_accum_only = self._settings.get("/rtx-transient/resetPtAccumOnlyWhenExternalFrameCounterChanges")
self._record_vp_object_settings(viewport_api)
self._saved_async_rendering = self._settings.get("/app/asyncRendering")
self._saved_async_renderingLatency = self._settings.get("/app/asyncRenderingLowLatency")
self._saved_background_zero_alpha = self._settings.get("/rtx/post/backgroundZeroAlpha/enabled")
self._saved_background_zero_alpha_comp = self._settings.get("/rtx/post/backgroundZeroAlpha/backgroundComposite")
self._saved_background_zero_alpha_zp_first = self._settings.get(
"/rtx/post/backgroundZeroAlpha/ApplyAlphaZeroPassFirst"
)
if self._options.movie_type == CaptureMovieType.SUNSTUDY:
self._saved_sunstudy_current_time = self._options.sunstudy_current_time
self._saved_timeline_current_time = self._timeline.get_current_time()
self._saved_timeline_fps = self._timeline.get_time_codes_per_seconds()
self._saved_rtx_sync_load_setting = self._settings.get("/rtx/materialDb/syncLoads")
if self._to_capture_render_product:
self._saved_render_product = viewport_api.render_product_path
omnigraph_use_legacy_sim_setting = self._settings.get_as_bool("/persistent/omnigraph/useLegacySimulationPipeline")
if omnigraph_use_legacy_sim_setting is not None and omnigraph_use_legacy_sim_setting is True:
carb.log_warn("/persistent/omnigraph/useLegacySimulationPipeline setting is True, which might affect render product capture and cause the capture to have no output.")
self._saved_hydra_sync_load_setting = self._settings.get("/rtx/hydra/materialSyncLoads")
self._saved_async_texture_streaming = self._settings.get("/rtx-transient/resourcemanager/texturestreaming/async")
self._saved_texture_streaming_budget = self._settings.get("/rtx-transient/resourcemanager/texturestreaming/streamingBudgetMB")
self._saved_sampler_feedback_tile_size = self._settings.get_as_int("/rtx-transient/samplerFeedbackTileSize")
self._saved_texture_streaming_eviction_frame_latency = self._settings.get_as_int("/rtx-transient/resourcemanager/texturestreaming/evictionFrameLatency")
# save Reshade state in post process settings
self._saved_reshade_state = bool(self._settings.get("/rtx/reshade/enable"))
self._saved_output_alpha_in_composite = self._settings.get_as_bool("/rtx/post/backgroundZeroAlpha/outputAlphaInComposite")
# save the visibility status of timeline window's minibar added in OM-92643
self._saved_timeline_window_mimibar_visibility = self._settings.get_as_bool("/exts/omni.kit.timeline.minibar/stay_on_playing")
# save the setting for sequencer camera, we want to enable it during capture
self._saved_use_sequencer_camera = self._settings.get_as_bool("/persistent/exts/omni.kit.window.sequencer/useSequencerCamera")
# if to capture mp4, save encoding settings
self._save_and_set_mp4_encoding_settings()
# if to capture in application mode, save viewport's padding values as we will reset it to make resolution of final image match what users set as possible as we can
self._save_and_set_application_capture_settings()
def _restore_window_status(self):
viewport_api, self._viewport_api = self._viewport_api, None
assert viewport_api is not None, "No viewport to restore to"
if not self._is_legacy_vp and not self._saved_vp_updates_enabled:
viewport_api.updates_enabled = self._saved_vp_updates_enabled
if not self._is_legacy_vp and self._saved_fill_viewport_option:
fv_setting_path = FILL_VIEWPORT_SETTING.format(viewport_api_id=viewport_api.id)
self._settings.set(fv_setting_path, self._saved_fill_viewport_option)
viewport_api.camera_path = self._saved_camera
viewport_api.resolution = (self._saved_resolution_width, self._saved_resolution_height)
if self._switch_renderer:
viewport_api.set_hd_engine(self._saved_hydra_engine, self._saved_render_mode)
self._settings.set_bool("/persistent/app/captureFrame/viewport", self._saved_capture_frame_viewport)
self._settings.set_int("/rtx/debugMaterialType", self._saved_debug_material_type)
self._settings.set_int("/rtx/pathtracing/totalSpp", self._saved_total_spp)
self._settings.set_int("/rtx/pathtracing/spp", self._saved_spp)
self._settings.set_bool("/rtx-transient/resetPtAccumOnlyWhenExternalFrameCounterChanges", self._saved_reset_pt_accum_only)
self._restore_vp_object_settings(viewport_api)
self._settings.set_bool("/app/asyncRendering", self._saved_async_rendering)
self._settings.set_bool("/app/asyncRenderingLowLatency", self._saved_async_renderingLatency)
self._renderer.set_capture_sync(not self._saved_async_rendering)
self._settings.set_bool("/rtx/post/backgroundZeroAlpha/enabled", self._saved_background_zero_alpha)
self._settings.set_bool(
"/rtx/post/backgroundZeroAlpha/backgroundComposite", self._saved_background_zero_alpha_comp
)
self._settings.set_bool(
"/rtx/post/backgroundZeroAlpha/ApplyAlphaZeroPassFirst", self._saved_background_zero_alpha_zp_first
)
self._restore_iray_settings()
if self._options.movie_type == CaptureMovieType.SUNSTUDY:
self._set_sunstudy_player_time(self._saved_sunstudy_current_time)
self._settings.set("/rtx/materialDb/syncLoads", self._saved_rtx_sync_load_setting)
self._settings.set("/rtx/hydra/materialSyncLoads", self._saved_hydra_sync_load_setting)
self._settings.set("/rtx-transient/resourcemanager/texturestreaming/async", self._saved_async_texture_streaming)
self._settings.set("/rtx-transient/resourcemanager/texturestreaming/streamingBudgetMB", self._saved_texture_streaming_budget)
self._settings.set("/rtx-transient/samplerFeedbackTileSize", self._saved_sampler_feedback_tile_size)
self._settings.set("/rtx-transient/resourcemanager/texturestreaming/evictionFrameLatency", self._saved_texture_streaming_eviction_frame_latency)
self._settings.set("/app/captureFrame/hdr", False)
# tell timeline window it can restart force checks of end time
self._settings.set_bool("/exts/omni.anim.window.timeline/playinRange", True)
if self._to_capture_render_product:
viewport_api.render_product_path = self._saved_render_product
# set Reshade to its initial value it had before te capture:
self._settings.set("/rtx/reshade/enable", self._saved_reshade_state)
# set Reshade update loop state to initial value, so we're ready for the next run of the update loop:
self._reshade_switch_state = self.ReshadeUpdateState.PRE_CAPTURE
self._settings.set("/rtx/post/backgroundZeroAlpha/outputAlphaInComposite", self._saved_output_alpha_in_composite)
if self._saved_timeline_window_mimibar_visibility:
self._setting.set("/exts/omni.kit.timeline.minibar/stay_on_playing", self._saved_timeline_window_mimibar_visibility)
self._settings.set("/persistent/exts/omni.kit.window.sequencer/useSequencerCamera", self._saved_use_sequencer_camera)
# if to capture mp4, restore encoding settings
self._restore_mp4_encoding_settings()
# if to capture in application mode, restore viewport's padding values
self._restore_application_capture_settings()
def _clean_pngs_in_directory(self, directory):
self._clean_files_in_directory(directory, ".png")
def _clean_files_in_directory(self, directory, suffix):
images = os.listdir(directory)
for item in images:
if item.endswith(suffix):
os.remove(os.path.join(directory, item))
def _make_sure_directory_existed(self, directory):
if not os.path.exists(directory):
try:
os.makedirs(directory, exist_ok=True)
except OSError as error:
carb.log_warn(f"Directory cannot be created: {dir}")
return False
return True
def _make_sure_directory_writeable(self, directory):
if not self._make_sure_directory_existed(directory):
return False
# if the directory exists, try to create a test folder and then remove it to check if it's writeable
# Normally this should be done using omni.client.stat api, unfortunately it won't work well if the
# give folder is a read-only one mapped by O Drive.
try:
test_folder_name = "(@m#C$%^)((test^file$@@).testfile"
full_test_path = os.path.join(directory, test_folder_name)
f = open(full_test_path, "a")
f.close()
os.remove(full_test_path)
except OSError as error:
return False
return True
def _finish(self):
if (
self._progress.capture_status == CaptureStatus.FINISHING
or self._progress.capture_status == CaptureStatus.CANCELLED
):
self._update_sub = None
self._restore_window_status()
self._sample_count = 0
self._start_number = 0
self._frame_counter = 0
self._path_trace_iterations = 0
self._progress.capture_status = CaptureStatus.NONE
# restore timeline settings
# stop timeline, but re-enable auto update
timeline = self._timeline
timeline.set_auto_update(True)
timeline.stop()
self._timeline.set_current_time(self._saved_timeline_current_time)
if self._capture_fps != self._saved_timeline_fps:
self._timeline.set_time_codes_per_second(self._saved_timeline_fps)
if self._to_capture_render_product and (self._render_product_path_for_capture != self._options.render_product):
RenderProductCaptureHelper.remove_render_product_for_capture(self._render_product_path_for_capture)
# restore application ui if in application level capture mode
if self._options.app_level_capture:
self._settings.set("/app/window/hideUi", False)
if self._show_progress_window():
self._progress_window.close()
if self._capture_finished_fn is not None:
self._capture_finished_fn()
def _wait_for_image_writing(self, seconds_to_wait: float = 5, seconds_to_sleep: float = 0.1):
# wait for the last frame is written to disk
# my tests of scenes of different complexity show a range of 0.2 to 1 seconds wait time
# so 5 second max time should be enough and we can early quit by checking the last
# frame every 0.1 seconds.
seconds_tried = 0.0
carb.log_info("Waiting for frames to be ready for encoding.")
while seconds_tried < seconds_to_wait:
if os.path.isfile(self._frame_path) and os.access(self._frame_path, os.R_OK):
break
else:
time.sleep(seconds_to_sleep)
seconds_tried += seconds_to_sleep
if seconds_tried >= seconds_to_wait:
carb.log_warn(f"Wait time out. To start encoding with images already have.")
def _capture_image(self, frame_path: str):
if self._options.app_level_capture:
self._capture_application(frame_path)
else:
self._capture_viewport(frame_path)
def _capture_application(self, frame_path: str):
async def capture_frame(capture_filename: str):
try:
import omni.renderer_capture
renderer_capture = omni.renderer_capture.acquire_renderer_capture_interface()
renderer_capture.capture_next_frame_swapchain(capture_filename)
carb.log_info(f"Capturing {capture_filename} in application level.")
except ImportError:
carb.log_error(f"Failed to capture {capture_filename} due to unable to import omni.renderer_capture.")
await omni.kit.app.get_app().next_update_async()
asyncio.ensure_future(capture_frame(frame_path))
def _capture_viewport(self, frame_path: str):
is_hdr = self.options._hdr_output
render_product_path = self.options._render_product if self._to_capture_render_product else None
format_desc = None
if self._options.file_type == ".exr":
format_desc = {}
format_desc["format"] = "exr"
format_desc["compression"] = self._options.exr_compression_method
capture_viewport_to_file(
self._viewport_api,
file_path=frame_path,
is_hdr=is_hdr,
render_product_path=render_product_path,
format_desc=format_desc
)
carb.log_info(f"Capturing {frame_path}")
def _get_current_frame_output_path(self):
frame_path = ""
if self._options.is_video():
frame_path = get_num_pattern_file_path(
self._frames_dir,
self._options.file_name,
self._options.file_name_num_pattern,
self._frame,
DEFAULT_IMAGE_FRAME_TYPE_FOR_VIDEO,
self._options.renumber_negative_frame_number_from_0,
abs(self._start_number)
)
else:
if self._options.is_capturing_nth_frames():
if self._frame_counter % self._options.capture_every_Nth_frames == 0:
frame_path = get_num_pattern_file_path(
self._frame_pattern_prefix,
self._options.file_name,
self._options.file_name_num_pattern,
self._frame,
self._options.file_type,
self._options.renumber_negative_frame_number_from_0,
abs(self._start_number)
)
else:
frame_path = self._frame_pattern_prefix + self._options.file_type
return frame_path
def _handle_skipping_frame(self, dt):
if not self._options.overwrite_existing_frames:
if os.path.exists(self._frame_path):
carb.log_warn(f"Frame {self._frame_path} exists, skip it...")
self._settings.set_int("/rtx/pathtracing/spp", 1)
self._subframe = 0
self._sample_count = 0
self._path_trace_iterations = 0
can_continue = True
if self._forward_one_frame_fn is not None:
can_continue = self._forward_one_frame_fn(dt)
elif self._options.movie_type == CaptureMovieType.SUNSTUDY and \
(self._options.is_video() or self._options.is_capturing_nth_frames()):
self._sunstudy_current_time += self._sunstudy_delta_time_per_iteration * self._sunstudy_iterations_per_frame
self._update_sunstudy_player_time()
else: # movie type is SEQUENCE
self._time = self._start_time + (self._frame - self._start_number) * self._time_rate
self._timeline.set_current_time(self._time)
self._frame += 1
self._frame_counter += 1
# check if capture ends
if self._forward_one_frame_fn is not None:
if can_continue is False:
if self._options.is_video():
self._progress.capture_status = CaptureStatus.TO_START_ENCODING
elif self._options.is_capturing_nth_frames():
self._progress.capture_status = CaptureStatus.FINISHING
else:
if self._time >= self._end_time or self._frame_counter >= self._total_frame_count:
if self._options.is_video():
self._progress.capture_status = CaptureStatus.TO_START_ENCODING
elif self._options.is_capturing_nth_frames():
self._progress.capture_status = CaptureStatus.FINISHING
return True
else:
if os.path.exists(self._frame_path) and self._last_skipped_frame_path != self._frame_path:
carb.log_warn(f"Frame {self._frame_path} will be overwritten.")
self._last_skipped_frame_path = self._frame_path
return False
def _get_default_settle_lateny_frames(self):
# to workaround OM-40632, and OM-50514
FRAMES_TO_DELAY_FOR_FRAME_SKIPPING_HACK = 5
if self._options.render_preset == CaptureRenderPreset.RAY_TRACE:
return FRAMES_TO_DELAY_FOR_FRAME_SKIPPING_HACK
elif (
self._options.render_preset == CaptureRenderPreset.PATH_TRACE or
self._options.render_preset == CaptureRenderPreset.IRAY
):
pt_frames = self._options.ptmb_subframes_per_frame * self._options.path_trace_spp
if pt_frames >= FRAMES_TO_DELAY_FOR_FRAME_SKIPPING_HACK:
return 0
else:
return FRAMES_TO_DELAY_FOR_FRAME_SKIPPING_HACK - pt_frames
else:
return 0
def _is_using_default_settle_latency_frames(self):
return self._options.real_time_settle_latency_frames == 0 and self._settings.get(SEQUENCE_CAPTURE_WAIT) is None
def _get_settle_latency_frames(self):
settle_latency_frames = self._options.real_time_settle_latency_frames
# Force a delay when capturing a range of frames
if settle_latency_frames == 0 and (self._options.is_video() or self._options.is_capturing_nth_frames()):
# Allow an explicit default to delay in SEQUENCE_CAPTURE_WAIT, when unset use logic below
settle_latency_frames = self._settings.get(SEQUENCE_CAPTURE_WAIT)
if settle_latency_frames is None:
# Force a 4 frame delay when no sub-frames, otherwise account for sub-frames contributing to that 4
settle_latency_frames = self._get_default_settle_lateny_frames()
carb.log_info(f"Forcing {settle_latency_frames} frame delay per frame for sequence capture")
return settle_latency_frames
def _is_handling_settle_latency_frames(self):
return ((self._options.is_video() or self._options.is_capturing_nth_frames()) and
self._settle_latency_frames > 0 and
self._real_time_settle_latency_frames_done < self._settle_latency_frames
)
def _handle_real_time_capture_settle_latency(self):
# settle latency only works with sequence capture
if not (self._options.is_video() or self._options.is_capturing_nth_frames()):
return False
if self._settle_latency_frames > 0:
self._real_time_settle_latency_frames_done += 1
if self._real_time_settle_latency_frames_done > self._settle_latency_frames:
self._real_time_settle_latency_frames_done = 0
return False
else:
self._subframe = 0
self._sample_count = 0
return True
return False
def _is_capturing_pt_mb(self):
return CaptureRenderPreset.PATH_TRACE == self._options.render_preset and self._options.ptmb_subframes_per_frame > 1
def _is_capturing_pt_no_mb(self):
return CaptureRenderPreset.PATH_TRACE == self._options.render_preset and 1 == self._options.ptmb_subframes_per_frame
def _is_pt_adaptivesampling_stop_criterion_reached(self):
if self._viewport_api is None:
return False
else:
render_status = self._viewport_api.frame_info.get('status')
return (render_status is not None and
RenderStatus.eStopCriterionReached == render_status and
self._is_capturing_pt_no_mb()
)
def _on_update(self, e):
dt = e.payload["dt"]
if self._progress.capture_status == CaptureStatus.FINISHING:
# need to turn reshade off, update, and turn on again in _restore_window_status to apply pre-capture resolution
if self._reshade_switch_state == self.ReshadeUpdateState.POST_CAPTURE:
self._settings.set_bool("/rtx/reshade/enable", False)
self._reshade_switch_state = self.ReshadeUpdateState.POST_CAPTURE_READY
return
self._finish()
self._update_progress_hook()
elif self._progress.capture_status == CaptureStatus.CANCELLED:
# need to turn reshade off, update, and turn on again in _restore_window_status to apply pre-capture resolution
if self._reshade_switch_state == self.ReshadeUpdateState.POST_CAPTURE:
self._settings.set_bool("/rtx/reshade/enable", False)
self._reshade_switch_state = self.ReshadeUpdateState.POST_CAPTURE_READY
return
carb.log_warn("video recording cancelled")
self._update_progress_hook()
self._finish()
elif self._progress.capture_status == CaptureStatus.ENCODING:
if VideoGenerationHelper().encoding_done:
self._progress.capture_status = CaptureStatus.FINISHING
self._update_progress_hook()
self._progress.add_encoding_time(dt)
elif self._progress.capture_status == CaptureStatus.TO_START_ENCODING:
if VideoGenerationHelper().is_encoding is False:
self._wait_for_image_writing()
if self._options.renumber_negative_frame_number_from_0 is True and self._start_number < 0:
video_frame_start_num = 0
else:
video_frame_start_num = self._start_number
started = VideoGenerationHelper().generating_video(
self._video_name,
self._frames_dir,
self._options.file_name,
self._options.file_name_num_pattern,
video_frame_start_num,
self._total_frame_count,
self._options.fps,
)
if started:
self._progress.capture_status = CaptureStatus.ENCODING
self._update_progress_hook()
self._progress.add_encoding_time(dt)
else:
carb.log_warn("Movie capture failed to encode the capture images.")
self._progress.capture_status = CaptureStatus.FINISHING
elif self._progress.capture_status == CaptureStatus.CAPTURING:
if self._frames_to_disable_async_rendering >= 0:
self._frames_to_disable_async_rendering -= 1
return
#apply Reshade and skip frames to to pick up capturing resolution
if self._reshade_switch_state == self.ReshadeUpdateState.PRE_CAPTURE:
self._settings.set_bool("/rtx/reshade/enable", self._saved_reshade_state)
# need to skip a couple of updates for Reshade settings to apply:
if self._frames_to_apply_reshade>=0:
self._frames_to_apply_reshade=self._frames_to_apply_reshade-1
return
self._reshade_switch_state = self.ReshadeUpdateState.POST_CAPTURE
return
if self._progress.is_prerolling():
self._progress.prerolled_frames += 1
self._settings.set_int("/rtx/pathtracing/spp", 1)
left_preroll_frames = self._options.preroll_frames - self._progress.prerolled_frames
self._timeline.set_current_time(self._start_time - left_preroll_frames / self._capture_fps)
return
self._frame_path = self._get_current_frame_output_path()
if self._handle_skipping_frame(dt):
self._progress.add_frame_time(self._frame, dt)
self._update_progress_hook()
return
self._settings.set_int(
"/rtx/pathtracing/spp", min(self._options.spp_per_iteration, self._options.path_trace_spp)
)
if self._options.render_preset == CaptureRenderPreset.IRAY:
iterations_done = int(self._settings.get("/iray/progression"))
self._path_trace_iterations = iterations_done
self._sample_count = iterations_done
else:
self._sample_count += self._options.spp_per_iteration
self._path_trace_iterations = self._sample_count
self._timeline.set_prerolling(False)
self._settings.set_int("/rtx/externalFrameCounter", self._frame)
# update progress timers
if self._options.is_capturing_pathtracing_single_frame():
if self._options.render_preset == CaptureRenderPreset.PATH_TRACE:
self._progress.add_single_frame_capture_time_for_pt(self._subframe, self._options.ptmb_subframes_per_frame, dt)
elif self._options.render_preset == CaptureRenderPreset.IRAY:
self._progress.add_single_frame_capture_time_for_iray(
self._subframe, self._options.ptmb_subframes_per_frame,
self._path_trace_iterations, self._options.path_trace_spp,
dt
)
else:
carb.log_warn(f"Movie capture: we don't support progress for {self._options.render_preset} in single frame capture mode.")
else:
self._progress.add_frame_time(self._frame, dt,
self._subframe + 1, self._options.ptmb_subframes_per_frame,
self._path_trace_iterations, self._options.path_trace_spp,
self._is_handling_settle_latency_frames() and not self._is_using_default_settle_latency_frames(),
self._real_time_settle_latency_frames_done, self._settle_latency_frames
)
self._update_progress_hook()
# check if path trace and meet the samples per pixels stop criterion
render_status = self._viewport_api.frame_info.get('status')
if RenderStatus.eStopCriterionReached == render_status and self._is_adaptivesampling_stop_criterion_reached:
carb.log_info("Got continuous path tracing adaptive sampling stop criterion reached event, skip this frame for it to finish.")
return
self._is_adaptivesampling_stop_criterion_reached = self._is_pt_adaptivesampling_stop_criterion_reached()
# capture frame when we reach the sample count for this frame and are rendering the last subframe
# Note _sample_count can go over _samples_per_pixel when 'spp_per_iteration > 1'
# also handle the case when we have adaptive sampling enabled and it returns stop criterion reached
if (self._sample_count >= self._options.path_trace_spp) and \
(self._subframe == self._options.ptmb_subframes_per_frame - 1) or \
self._is_adaptivesampling_stop_criterion_reached:
if self._handle_real_time_capture_settle_latency():
return
if self._options.is_video():
self._capture_image(self._frame_path)
else:
if self._options.is_capturing_nth_frames():
if self._frame_counter % self._options.capture_every_Nth_frames == 0:
self._capture_image(self._frame_path)
else:
self._progress.capture_status = CaptureStatus.FINISHING
self._capture_image(self._frame_path)
# reset time the *next frame* (since otherwise we capture the first sample)
if self._sample_count >= self._options.path_trace_spp or self._is_adaptivesampling_stop_criterion_reached:
self._sample_count = 0
self._path_trace_iterations = 0
self._subframe += 1
if self._subframe == self._options.ptmb_subframes_per_frame:
self._subframe = 0
self._frame += 1
self._frame_counter += 1
self._time = self._start_time + (self._frame - self._start_number) * self._time_rate
can_continue = False
if self._forward_one_frame_fn is not None:
can_continue = self._forward_one_frame_fn(dt)
elif self._options.movie_type == CaptureMovieType.SUNSTUDY and \
(self._options.is_video() or self._options.is_capturing_nth_frames()):
self._sunstudy_current_time += self._sunstudy_delta_time_per_iteration
self._update_sunstudy_player_time()
else:
if self._options.is_video() or self._options.is_capturing_nth_frames():
cur_time = (
self._time + (self._options.ptmb_fso * self._time_rate) + self._time_subframe_rate * self._subframe
)
self._timeline.set_current_time(cur_time)
if self._forward_one_frame_fn is not None:
if can_continue == False:
if self._options.is_video():
self._progress.capture_status = CaptureStatus.TO_START_ENCODING
elif self._options.is_capturing_nth_frames():
self._progress.capture_status = CaptureStatus.FINISHING
else:
if self._time >= self._end_time or self._frame_counter >= self._total_frame_count:
if self._options.is_video():
self._progress.capture_status = CaptureStatus.TO_START_ENCODING
elif self._options.is_capturing_nth_frames():
self._progress.capture_status = CaptureStatus.FINISHING
@staticmethod
def get_instance():
global capture_instance
return capture_instance
| 65,590 | Python | 51.599038 | 195 | 0.63496 |
omniverse-code/kit/exts/omni.kit.capture.viewport/omni/kit/capture/viewport/video_generation.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 os
import threading
import carb
try:
from video_encoding import get_video_encoding_interface
except ImportError:
get_video_encoding_interface = lambda: None
from .singleton import Singleton
from .helper import get_num_pattern_file_path
g_video_encoding_api = get_video_encoding_interface()
@Singleton
class VideoGenerationHelper:
def __init__(self):
self._init_internal()
@property
def is_encoding(self):
return self._is_encoding
@property
def encoding_done(self):
return self._is_encoding == False and self._encoding_done == True
def generating_video(
self, video_name, frames_dir, filename_prefix, filename_num_pattern,
start_number, total_frames, frame_rate, image_type=".png"
):
carb.log_warn(f"Using videoencoding plugin to encode video ({video_name})")
global g_video_encoding_api
self._encoding_finished = False
if g_video_encoding_api is None:
carb.log_warn("Video encoding api not available; cannot encode video.")
return False
# acquire list of available frame image files, based on start_number and filename_pattern
next_frame = start_number
frame_count = 0
self._frame_filenames = []
while True:
frame_path = get_num_pattern_file_path(
frames_dir,
filename_prefix,
filename_num_pattern,
next_frame,
image_type
)
if os.path.isfile(frame_path) and os.access(frame_path, os.R_OK):
self._frame_filenames.append(frame_path)
next_frame += 1
frame_count += 1
if frame_count == total_frames:
break
else:
break
carb.log_warn(f"Found {len(self._frame_filenames)} frames to encode.")
if len(self._frame_filenames) == 0:
carb.log_warn(f"No frames to encode.")
return False
if not g_video_encoding_api.start_encoding(video_name, frame_rate, len(self._frame_filenames), True):
carb.log_warn(f"videoencoding plug failed to start encoding.")
return False
if self._encoding_thread == None:
self._encoding_thread = threading.Thread(target=self._encode_image_file_sequence, args=())
self._is_encoding = True
self._encoding_thread.start()
return True
def _init_internal(self):
self._video_generation_done_fn = None
self._frame_filenames = []
self._encoding_thread = None
self._is_encoding = False
self._encoding_done = False
def _encode_image_file_sequence(self):
global g_video_encoding_api
try:
for frame_filename in self._frame_filenames:
g_video_encoding_api.encode_next_frame_from_file(frame_filename)
except:
import traceback
carb.log_warn(traceback.format_exc())
finally:
g_video_encoding_api.finalize_encoding()
self._init_internal()
self._encoding_done = True
| 3,608 | Python | 33.701923 | 109 | 0.622228 |
omniverse-code/kit/exts/omni.kit.capture.viewport/omni/kit/capture/viewport/capture_options.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 os
from enum import Enum, IntEnum
import carb
class CaptureMovieType(IntEnum):
SEQUENCE = 0
SUNSTUDY = 1
PLAYLIST = 2
class CaptureRangeType(IntEnum):
FRAMES = 0
SECONDS = 1
class CaptureRenderPreset(IntEnum):
PATH_TRACE = 0
RAY_TRACE = 1
IRAY = 2
class CaptureDebugMaterialType(IntEnum):
SHADED = 0
WHITE = 1
EXR_COMPRESSION_METHODS = {"zip", "zips", "dwaa", "dwab", "piz", "rle", "b44", "b44a"}
MP4_ENCODING_PRESETS = {
"PRESET_DEFAULT",
"PRESET_HP",
"PRESET_HQ",
"PRESET_BD",
"PRESET_LOW_LATENCY_DEFAULT",
"PRESET_LOW_LATENCY_HQ",
"PRESET_LOW_LATENCY_HP",
"PRESET_LOSSLESS_DEFAULT",
"PRESET_LOSSLESS_HP"
}
MP4_ENCODING_PROFILES = {
"H264_PROFILE_BASELINE",
"H264_PROFILE_MAIN",
"H264_PROFILE_HIGH",
"H264_PROFILE_HIGH_444",
"H264_PROFILE_STEREO",
"H264_PROFILE_SVC_TEMPORAL_SCALABILITY",
"H264_PROFILE_PROGRESSIVE_HIGH",
"H264_PROFILE_CONSTRAINED_HIGH",
"HEVC_PROFILE_MAIN",
"HEVC_PROFILE_MAIN10",
"HEVC_PROFILE_FREXT"
}
MP4_ENCODING_RC_MODES = {
"RC_CONSTQP",
"RC_VBR",
"RC_CBR",
"RC_CBR_LOWDELAY_HQ",
"RC_CBR_HQ",
"RC_VBR_HQ"
}
class CaptureOptions:
""" All Capture options that will be used when capturing.
Note: When adding an attribute make sure it is exposed via the constructor.
Not doing this will cause erorrs when serializing and deserializing this object.
"""
INVALID_ANIMATION_FPS = -1
def __init__(
self,
camera="camera",
range_type=CaptureRangeType.FRAMES,
capture_every_nth_frames=-1,
fps=24,
start_frame=1,
end_frame=40,
start_time=0,
end_time=10,
res_width=1920,
res_height=1080,
render_preset=CaptureRenderPreset.PATH_TRACE,
debug_material_type=CaptureDebugMaterialType.SHADED,
spp_per_iteration=1,
path_trace_spp=1,
ptmb_subframes_per_frame=1,
ptmb_fso=0.0,
ptmb_fsc=1.0,
output_folder="",
file_name="Capture",
file_name_num_pattern=".####",
file_type=".tga",
save_alpha=False,
hdr_output=False,
show_pathtracing_single_frame_progress=False,
preroll_frames=0,
overwrite_existing_frames=False,
movie_type=CaptureMovieType.SEQUENCE,
sunstudy_start_time=0.0,
sunstudy_current_time=0.0,
sunstudy_end_time=0.0,
sunstudy_movie_length_in_seconds=0,
sunstudy_player=None,
real_time_settle_latency_frames=0,
renumber_negative_frame_number_from_0=False,
render_product="",
exr_compression_method="zips",
mp4_encoding_bitrate=16777216,
mp4_encoding_iframe_interval=60,
mp4_encoding_preset="PRESET_DEFAULT",
mp4_encoding_profile="H264_PROFILE_HIGH",
mp4_encoding_rc_mode="RC_VBR",
mp4_encoding_rc_target_quality=0,
mp4_encoding_video_full_range_flag=False,
app_level_capture=False,
animation_fps=INVALID_ANIMATION_FPS
):
self._camera = camera
self._range_type = range_type
self._capture_every_nth_frames = capture_every_nth_frames
self._fps = fps
self._start_frame = start_frame
self._end_frame = end_frame
self._start_time = start_time
self._end_time = end_time
self._res_width = res_width
self._res_height = res_height
self._render_preset = render_preset
self._debug_material_type = debug_material_type
self._spp_per_iteration = spp_per_iteration
self._path_trace_spp = path_trace_spp
self._ptmb_subframes_per_frame = ptmb_subframes_per_frame
self._ptmb_fso = ptmb_fso
self._ptmb_fsc = ptmb_fsc
self._output_folder = output_folder
self._file_name = file_name
self._file_name_num_pattern = file_name_num_pattern
self._file_type = file_type
self._save_alpha = save_alpha
self._hdr_output = hdr_output
self._show_pathtracing_single_frame_progress = show_pathtracing_single_frame_progress
self._preroll_frames = preroll_frames
self._overwrite_existing_frames = overwrite_existing_frames
self._movie_type = movie_type
self._sunstudy_start_time = sunstudy_start_time
self._sunstudy_current_time = sunstudy_current_time
self._sunstudy_end_time = sunstudy_end_time
self._sunstudy_movie_length_in_seconds = sunstudy_movie_length_in_seconds
self._sunstudy_player = sunstudy_player
self._real_time_settle_latency_frames = real_time_settle_latency_frames
self._renumber_negative_frame_number_from_0 = renumber_negative_frame_number_from_0
self._render_product = render_product
self.exr_compression_method = exr_compression_method
self.mp4_encoding_bitrate = mp4_encoding_bitrate
self.mp4_encoding_iframe_interval = mp4_encoding_iframe_interval
self.mp4_encoding_preset = mp4_encoding_preset
self.mp4_encoding_profile = mp4_encoding_profile
self.mp4_encoding_rc_mode = mp4_encoding_rc_mode
self.mp4_encoding_rc_target_quality = mp4_encoding_rc_target_quality
self.mp4_encoding_video_full_range_flag = mp4_encoding_video_full_range_flag
self._app_level_capture = app_level_capture
self.animation_fps = animation_fps
def to_dict(self):
data = vars(self)
return {key.lstrip("_"): value for key, value in data.items()}
@classmethod
def from_dict(cls, options):
return cls(**options)
@property
def camera(self):
return self._camera
@camera.setter
def camera(self, value):
self._camera = value
@property
def range_type(self):
return self._range_type
@range_type.setter
def range_type(self, value):
self._range_type = value
@property
def capture_every_Nth_frames(self):
return self._capture_every_nth_frames
@capture_every_Nth_frames.setter
def capture_every_Nth_frames(self, value):
self._capture_every_nth_frames = value
@property
def fps(self):
return self._fps
@fps.setter
def fps(self, value):
self._fps = value
@property
def start_frame(self):
return self._start_frame
@start_frame.setter
def start_frame(self, value):
self._start_frame = value
@property
def end_frame(self):
return self._end_frame
@end_frame.setter
def end_frame(self, value):
self._end_frame = value
@property
def start_time(self):
return self._start_time
@start_time.setter
def start_time(self, value):
self._start_time = value
@property
def end_time(self):
return self._end_time
@end_time.setter
def end_time(self, value):
self._end_time = value
@property
def res_width(self):
return self._res_width
@res_width.setter
def res_width(self, value):
self._res_width = value
@property
def res_height(self):
return self._res_height
@res_height.setter
def res_height(self, value):
self._res_height = value
@property
def render_preset(self):
return self._render_preset
@render_preset.setter
def render_preset(self, value):
self._render_preset = value
@property
def debug_material_type(self):
return self._debug_material_type
@debug_material_type.setter
def debug_material_type(self, value):
self._debug_material_type = value
@property
def spp_per_iteration(self):
return self._spp_per_iteration
@spp_per_iteration.setter
def spp_per_iteration(self, value):
self._spp_per_iteration = value
@property
def path_trace_spp(self):
return self._path_trace_spp
@path_trace_spp.setter
def path_trace_spp(self, value):
self._path_trace_spp = value
@property
def ptmb_subframes_per_frame(self):
return self._ptmb_subframes_per_frame
@ptmb_subframes_per_frame.setter
def ptmb_subframes_per_frame(self, value):
self._ptmb_subframes_per_frame = value
@property
def ptmb_fso(self):
return self._ptmb_fso
@ptmb_fso.setter
def ptmb_fso(self, value):
self._ptmb_fso = value
@property
def ptmb_fsc(self):
return self._ptmb_fsc
@ptmb_fsc.setter
def ptmb_fsc(self, value):
self._ptmb_fsc = value
@property
def output_folder(self):
return self._output_folder
@output_folder.setter
def output_folder(self, value):
self._output_folder = value
@property
def file_name(self):
return self._file_name
@file_name.setter
def file_name(self, value):
self._file_name = value
@property
def file_name_num_pattern(self):
return self._file_name_num_pattern
@file_name_num_pattern.setter
def file_name_num_pattern(self, value):
self._file_name_num_pattern = value
@property
def file_type(self):
return self._file_type
@file_type.setter
def file_type(self, value):
self._file_type = value
@property
def save_alpha(self):
return self._save_alpha
@save_alpha.setter
def save_alpha(self, value):
self._save_alpha = value
@property
def hdr_output(self):
return self._hdr_output
@hdr_output.setter
def hdr_output(self, value):
self._hdr_output = value
@property
def show_pathtracing_single_frame_progress(self):
return self._show_pathtracing_single_frame_progress
@show_pathtracing_single_frame_progress.setter
def show_pathtracing_single_frame_progress(self, value):
self._show_pathtracing_single_frame_progress = value
@property
def preroll_frames(self):
return self._preroll_frames
@preroll_frames.setter
def preroll_frames(self, value):
self._preroll_frames = value
@property
def overwrite_existing_frames(self):
return self._overwrite_existing_frames
@overwrite_existing_frames.setter
def overwrite_existing_frames(self, value):
self._overwrite_existing_frames = value
@property
def movie_type(self):
return self._movie_type
@movie_type.setter
def movie_type(self, value):
self._movie_type = value
@property
def sunstudy_start_time(self):
return self._sunstudy_start_time
@sunstudy_start_time.setter
def sunstudy_start_time(self, value):
self._sunstudy_start_time = value
@property
def sunstudy_current_time(self):
return self._sunstudy_current_time
@sunstudy_current_time.setter
def sunstudy_current_time(self, value):
self._sunstudy_current_time = value
@property
def sunstudy_end_time(self):
return self._sunstudy_end_time
@sunstudy_end_time.setter
def sunstudy_end_time(self, value):
self._sunstudy_end_time = value
@property
def sunstudy_movie_length_in_seconds(self):
return self._sunstudy_movie_length_in_seconds
@sunstudy_movie_length_in_seconds.setter
def sunstudy_movie_length_in_seconds(self, value):
self._sunstudy_movie_length_in_seconds = value
@property
def sunstudy_player(self):
return self._sunstudy_player
@sunstudy_player.setter
def sunstudy_player(self, value):
self._sunstudy_player = value
@property
def real_time_settle_latency_frames(self):
return self._real_time_settle_latency_frames
@real_time_settle_latency_frames.setter
def real_time_settle_latency_frames(self, value):
self._real_time_settle_latency_frames = value
@property
def renumber_negative_frame_number_from_0(self):
return self._renumber_negative_frame_number_from_0
@renumber_negative_frame_number_from_0.setter
def renumber_negative_frame_number_from_0(self, value):
self._renumber_negative_frame_number_from_0 = value
@property
def render_product(self):
return self._render_product
@render_product.setter
def render_product(self, value):
self._render_product = value
@property
def exr_compression_method(self):
return self._exr_compression_method
@exr_compression_method.setter
def exr_compression_method(self, value):
global EXR_COMPRESSION_METHODS
if value in EXR_COMPRESSION_METHODS:
self._exr_compression_method = value
else:
self._exr_compression_method = "zips"
carb.log_warn(f"Can't set unsupported compression method {value} for exr format, set to default zip16. Supported values are: {EXR_COMPRESSION_METHODS}")
@property
def mp4_encoding_bitrate(self):
return self._mp4_encoding_bitrate
@mp4_encoding_bitrate.setter
def mp4_encoding_bitrate(self, value):
self._mp4_encoding_bitrate = value
@property
def mp4_encoding_iframe_interval(self):
return self._mp4_encoding_iframe_interval
@mp4_encoding_iframe_interval.setter
def mp4_encoding_iframe_interval(self, value):
self._mp4_encoding_iframe_interval = value
@property
def mp4_encoding_preset(self):
return self._mp4_encoding_preset
@mp4_encoding_preset.setter
def mp4_encoding_preset(self, value):
global MP4_ENCODING_PRESETS
if value in MP4_ENCODING_PRESETS:
self._mp4_encoding_preset = value
else:
self._mp4_encoding_preset = "PRESET_DEFAULT"
carb.log_warn(f"Can't set unsupported mp4 encoding preset {value}, set to default {self._mp4_encoding_preset}. Supported values are: {MP4_ENCODING_PRESETS}")
@property
def mp4_encoding_profile(self):
return self._mp4_encoding_profile
@mp4_encoding_profile.setter
def mp4_encoding_profile(self, value):
global MP4_ENCODING_PROFILES
if value in MP4_ENCODING_PROFILES:
self._mp4_encoding_profile = value
else:
self._mp4_encoding_profile = "H264_PROFILE_HIGH"
carb.log_warn(f"Can't set unsupported mp4 encoding profile {value}, set to default {self._mp4_encoding_profile}. Supported values are: {MP4_ENCODING_PROFILES}")
@property
def mp4_encoding_rc_mode(self):
return self._mp4_encoding_rc_mode
@mp4_encoding_rc_mode.setter
def mp4_encoding_rc_mode(self, value):
global MP4_ENCODING_RC_MODES
if value in MP4_ENCODING_RC_MODES:
self._mp4_encoding_rc_mode = value
else:
self._mp4_encoding_rc_mode = "RC_VBR"
carb.log_warn(f"Can't set unsupported mp4 encoding rate control mode {value}, set to default {self._mp4_encoding_rc_mode}. Supported values are: {MP4_ENCODING_RC_MODES}")
@property
def mp4_encoding_rc_target_quality(self):
return self._mp4_encoding_rc_target_quality
@mp4_encoding_rc_target_quality.setter
def mp4_encoding_rc_target_quality(self, value):
if 0 <= value and value <= 51:
self._mp4_encoding_rc_target_quality = value
else:
self._mp4_encoding_rc_target_quality = 0
carb.log_warn(f"Can't set unsupported mp4 encoding rate control target quality {value}, set to default {self._mp4_encoding_rc_target_quality}. Supported range is [0, 51]")
@property
def mp4_encoding_video_full_range_flag(self):
return self._mp4_encoding_video_full_range_flag
@mp4_encoding_video_full_range_flag.setter
def mp4_encoding_video_full_range_flag(self, value):
self._mp4_encoding_video_full_range_flag = value
@property
def app_level_capture(self):
return self._app_level_capture
@app_level_capture.setter
def app_level_capture(self, value):
self._app_level_capture = value
@property
def animation_fps(self):
return self._animation_fps
@animation_fps.setter
def animation_fps(self, value):
self._animation_fps = value
def is_video(self):
return self.file_type == ".mp4"
def is_capturing_nth_frames(self):
return self._capture_every_nth_frames > 0
def is_capturing_pathtracing_single_frame(self):
return (
self.is_video() is False
and self.is_capturing_nth_frames() is False
and (self.render_preset == CaptureRenderPreset.PATH_TRACE or self.render_preset == CaptureRenderPreset.IRAY)
)
def is_capturing_frame(self):
return self._range_type == CaptureRangeType.FRAMES
def get_full_path(self):
return os.path.join(self._output_folder, self._file_name + self._file_type)
| 17,273 | Python | 28.629503 | 183 | 0.645632 |
omniverse-code/kit/exts/omni.kit.capture.viewport/omni/kit/capture/viewport/helper.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 os
import carb
import omni.kit.app
import omni.usd
from pxr import Sdf, UsdRender, Gf, Usd
ViewportObjectsSettingDict = {
"guide/selection": "/app/viewport/outline/enabled",
"scene/lights": "/app/viewport/show/lights",
"scene/audio": "/app/viewport/show/audio",
"scene/cameras": "/app/viewport/show/camera",
"guide/grid": "/app/viewport/grid/enabled"
}
def get_num_pattern_file_path(frames_dir, file_name, num_pattern, frame_num, file_type, renumber_frames=False, renumber_offset=0):
if renumber_frames:
renumbered_frames = frame_num + renumber_offset
else:
renumbered_frames = frame_num
abs_frame_num = abs(renumbered_frames)
padding_length = len(num_pattern.strip(".")[len(str(abs_frame_num)) :])
if renumbered_frames >= 0:
padded_string = "0" * padding_length + str(renumbered_frames)
else:
padded_string = "-" + "0" * padding_length + str(abs_frame_num)
filename = ".".join((file_name, padded_string, file_type.strip(".")))
frame_path = os.path.join(frames_dir, filename)
return frame_path
def is_ext_enabled(ext_name):
ext_manager = omni.kit.app.get_app().get_extension_manager()
return ext_manager.is_extension_enabled(ext_name)
# TODO: These version checks exists only in case down-stream movie-capture has imported them
# They should be removed for 105.2 and above.
#
def check_kit_major_version(version_num: int) -> bool:
kit_version = omni.kit.app.get_app().get_build_version().split(".")
try:
major_ver = int(kit_version[0])
return major_ver >= version_num
except Exception as e:
return False
def is_kit_104_and_above() -> bool:
return False
def is_kit_105_and_above() -> bool:
return True
def get_vp_object_setting_path(viewport_api, setting_key: str) -> str:
usd_context_name = viewport_api.usd_context_name
if setting_key.startswith("scene"):
setting_path = f"/app/viewport/usdcontext-{usd_context_name}/{setting_key}/visible"
else:
setting_path = f"/persistent/app/viewport/{viewport_api.id}/{setting_key}/visible"
return setting_path
def get_vp_object_visibility(viewport_api, setting_key: str) -> bool:
settings = carb.settings.get_settings()
setting_path = get_vp_object_setting_path(viewport_api, setting_key)
return settings.get_as_bool(setting_path)
def set_vp_object_visibility(viewport_api, setting_key: str, visible: bool) -> None:
if get_vp_object_visibility(viewport_api, setting_key) == visible:
return
settings = carb.settings.get_settings()
action_key = {
"guide/selection": "toggle_selection_hilight_visibility",
"scene/lights": "toggle_light_visibility",
"scene/audio": "toggle_audio_visibility",
"scene/cameras": "toggle_camera_visibility",
"guide/grid": "toggle_grid_visibility"
}.get(setting_key, None)
if not action_key:
carb.log_error(f"No mapping between {setting_key} and omni.kit.viewport.actions")
return
action_registry = omni.kit.actions.core.get_action_registry()
action = action_registry.get_action("omni.kit.viewport.actions", action_key)
if action:
action.execute(viewport_api=viewport_api, visible=visible)
else:
carb.log_error(f"Did not find action omni.kit.viewport.actions.{action_key}")
def check_render_product_ext_availability():
return is_ext_enabled("omni.graph.nodes") and is_ext_enabled("omni.graph.examples.cpp")
def is_valid_render_product_prim_path(prim_path):
try:
import omni.usd
from pxr import UsdRender
usd_context = omni.usd.get_context()
stage = usd_context.get_stage()
prim = stage.GetPrimAtPath(prim_path)
if prim:
return prim.IsA(UsdRender.Product)
else:
return False
except Exception as e:
return False
class RenderProductCaptureHelper:
@staticmethod
def prepare_render_product_for_capture(render_product_prim_path, new_camera, new_resolution):
usd_context = omni.usd.get_context()
stage = usd_context.get_stage()
working_layer = stage.GetSessionLayer()
prim = stage.GetPrimAtPath(render_product_prim_path)
path_new = omni.usd.get_stage_next_free_path(stage, render_product_prim_path, False)
if prim.IsA(UsdRender.Product):
with Usd.EditContext(stage, working_layer):
omni.kit.commands.execute("CopyPrim", path_from=render_product_prim_path, path_to=path_new, duplicate_layers=False, combine_layers=True,exclusive_select=True)
prim_new = stage.GetPrimAtPath(path_new)
if prim_new.IsA(UsdRender.Product):
omni.usd.editor.set_no_delete(prim_new, False)
prim_new.GetAttribute("resolution").Set(new_resolution)
prim_new.GetRelationship("camera").SetTargets([new_camera])
else:
path_new = ""
else:
path_new = ""
return path_new
@staticmethod
def remove_render_product_for_capture(render_product_prim_path):
usd_context = omni.usd.get_context()
stage = usd_context.get_stage()
working_layer = stage.GetSessionLayer()
prim = working_layer.GetPrimAtPath(render_product_prim_path)
if prim:
if prim.nameParent:
name_parent = prim.nameParent
else:
name_parent = working_layer.pseudoRoot
if not name_parent:
return
name = prim.name
if name in name_parent.nameChildren:
del name_parent.nameChildren[name]
| 6,149 | Python | 36.730061 | 174 | 0.660433 |
omniverse-code/kit/exts/omni.kit.capture.viewport/omni/kit/capture/viewport/tests/__init__.py | from .test_capture_options import TestCaptureOptions
from .test_capture_hdr import TestCaptureHdr
from .test_capture_png import TestCapturePng
from .test_capture_render_product import TestCaptureRenderProduct | 208 | Python | 51.249987 | 65 | 0.865385 |
omniverse-code/kit/exts/omni.kit.capture.viewport/omni/kit/capture/viewport/tests/test_helper.py | import os
import os.path
import asyncio
import carb
import omni.kit.app
def clean_files_in_directory(directory, suffix):
if not os.path.exists(directory):
return
images = os.listdir(directory)
for item in images:
if item.endswith(suffix):
os.remove(os.path.join(directory, item))
def make_sure_directory_existed(directory):
if not os.path.exists(directory):
try:
os.makedirs(directory, exist_ok=True)
except OSError as error:
carb.log_warn(f"Directory cannot be created: {dir}")
return False
return True
# TODO: Remove this as it is no longer used, but kept only if transitively depended on
#
def is_kit_104_and_above():
kit_version = omni.kit.app.get_app().get_build_version().split(".")
try:
major_ver = int(kit_version[0])
return major_ver >= 104
except Exception as e:
return False
async def wait_for_image_writing(image_path, seconds_to_wait: float = 30, seconds_to_sleep: float = 0.5):
seconds_tried = 0.0
carb.log_info(f"Waiting for {image_path} to be written to disk.")
while seconds_tried < seconds_to_wait:
if os.path.isfile(image_path) and os.access(image_path, os.R_OK):
carb.log_info(f"{image_path} is written to disk in {seconds_tried}s.")
break
else:
await asyncio.sleep(seconds_to_sleep)
seconds_tried += seconds_to_sleep
if seconds_tried >= seconds_to_wait:
carb.log_warn(f"Waiting for {image_path} timed out..")
| 1,562 | Python | 30.259999 | 105 | 0.638924 |
omniverse-code/kit/exts/omni.kit.capture.viewport/omni/kit/capture/viewport/tests/test_capture_hdr.py | from typing import Type
import os
import os.path
import omni.kit.test
import carb
import carb.settings
import carb.tokens
import pathlib
import gc
from omni.kit.capture.viewport import CaptureOptions, CaptureExtension
from omni.kit.viewport.utility import get_active_viewport, create_viewport_window, capture_viewport_to_file
from .test_helper import clean_files_in_directory, make_sure_directory_existed, wait_for_image_writing
KIT_ROOT = pathlib.Path(carb.tokens.acquire_tokens_interface().resolve("${kit}")).parent.parent.parent
OUTPUTS_DIR = KIT_ROOT.joinpath("_testoutput/omni.kit.capture.viewport.images")
class TestCaptureHdr(omni.kit.test.AsyncTestCase):
# Before running each test
async def setUp(self):
self._usd_context = ''
settings = carb.settings.get_settings()
self._frames_wait_for_capture_resource_ready = 6
await omni.usd.get_context(self._usd_context).new_stage_async()
async def test_hdr_capture(self):
viewport_api = get_active_viewport(self._usd_context)
# Wait until the viewport has valid resources
await viewport_api.wait_for_rendered_frames()
capture_filename = "capture_hdr_test"
filePath = pathlib.Path(OUTPUTS_DIR).joinpath(capture_filename)
options = CaptureOptions()
options.file_type = ".exr"
options.output_folder = str(filePath)
make_sure_directory_existed(options.output_folder)
clean_files_in_directory(options.output_folder, ".exr")
exr_path = os.path.join(options._output_folder, "Capture1.exr")
carb.log_warn(f"Capture image path: {exr_path}")
options.hdr_output = True
options.camera = viewport_api.camera_path.pathString
# to reduce memory consumption and save time
options.res_width = 600
options.res_height = 337
capture_instance = CaptureExtension().get_instance()
capture_instance.options = options
capture_instance.start()
await wait_for_image_writing(exr_path)
options = None
capture_instance = None
gc.collect()
assert os.path.isfile(exr_path)
async def _test_exr_compression_method(self, compression_method):
viewport_api = get_active_viewport(self._usd_context)
# Wait until the viewport has valid resources
await viewport_api.wait_for_rendered_frames()
capture_filename = "capture_exr_compression_method_test_" + compression_method
filePath = pathlib.Path(OUTPUTS_DIR).joinpath(capture_filename)
options = CaptureOptions()
options.file_type = ".exr"
options.exr_compression_method = compression_method
options.output_folder = str(filePath)
make_sure_directory_existed(options.output_folder)
clean_files_in_directory(options.output_folder, ".exr")
exr_path = os.path.join(options._output_folder, "Capture1.exr")
carb.log_warn(f"Capture image path: {exr_path}")
options.hdr_output = True
options.camera = viewport_api.camera_path.pathString
# to reduce memory consumption and save time
options.res_width = 600
options.res_height = 337
capture_instance = CaptureExtension().get_instance()
capture_instance.options = options
capture_instance.start()
await wait_for_image_writing(exr_path)
options = None
capture_instance = None
gc.collect()
assert os.path.isfile(exr_path)
async def test_exr_compression_method_rle(self):
await self._test_exr_compression_method("rle")
async def test_exr_compression_method_zip(self):
await self._test_exr_compression_method("zip")
async def test_exr_compression_method_dwaa(self):
await self._test_exr_compression_method("dwaa")
async def test_exr_compression_method_dwab(self):
await self._test_exr_compression_method("dwab")
async def test_exr_compression_method_piz(self):
await self._test_exr_compression_method("piz")
async def test_exr_compression_method_b44(self):
await self._test_exr_compression_method("b44")
async def test_exr_compression_method_b44a(self):
await self._test_exr_compression_method("b44a")
# Notes: The following multiple viewport tests will fail now and should be revisited after we confirm the
# multiple viewport capture support in new SRD.
# # Make sure we do not crash in the unsupported multi-view case
# async def test_hdr_multiview_capture(self):
# viewport_api = get_active_viewport(self._usd_context)
# # Wait until the viewport has valid resources
# await viewport_api.wait_for_rendered_frames()
# new_viewport = create_viewport_window("Viewport 2")
# capture_filename = "capture.hdr_test.multiview"
# filePath = pathlib.Path(OUTPUTS_DIR).joinpath(capture_filename)
# options = CaptureOptions()
# options.file_type = ".exr"
# options.output_folder = str(filePath)
# self._make_sure_directory_existed(options.output_folder)
# self._clean_files_in_directory(options.output_folder, ".exr")
# exr_path = os.path.join(options._output_folder, "Capture1.exr")
# carb.log_warn(f"Capture image path: {exr_path}")
# options.hdr_output = True
# options.camera = viewport_api.camera_path.pathString
# capture_instance = CaptureExtension().get_instance()
# capture_instance.options = options
# capture_instance.start()
# capture_viewport_to_file(new_viewport.viewport_api, file_path=exr_path)
# i = self._frames_wait_for_capture_resource_ready
# while i > 0:
# await omni.kit.app.get_app().next_update_async()
# i -= 1
# options = None
# capture_instance = None
# gc.collect()
# assert os.path.isfile(exr_path)
# if viewport_widget:
# viewport_widget.destroy()
# del viewport_widget
# async def test_hdr_multiview_capture_legacy(self):
# await self.do_test_hdr_multiview_capture(True)
# async def test_hdr_multiview_capture(self):
# await self.do_test_hdr_multiview_capture(False)
| 6,254 | Python | 38.588607 | 109 | 0.668372 |
omniverse-code/kit/exts/omni.kit.capture.viewport/omni/kit/capture/viewport/tests/test_capture_options.py | from typing import Type
import omni.kit.test
import omni.kit.capture.viewport.capture_options as _capture_options
class TestCaptureOptions(omni.kit.test.AsyncTestCase):
async def test_capture_options_serialisation(self):
options = _capture_options.CaptureOptions()
data_dict = options.to_dict()
self.assertIsInstance(data_dict, dict)
async def test_capture_options_deserialisation(self):
options = _capture_options.CaptureOptions()
data_dict = options.to_dict()
regenerated_options = _capture_options.CaptureOptions.from_dict(data_dict)
self.assertIsInstance(regenerated_options, _capture_options.CaptureOptions)
async def test_capture_options_values_persisted(self):
options = _capture_options.CaptureOptions(camera="my_camera")
data_dict = options.to_dict()
regenerated_options = _capture_options.CaptureOptions.from_dict(data_dict)
self.assertEqual(regenerated_options.camera, "my_camera")
async def test_adding_random_attribute_fails(self):
""" Test that adding new attributes without making them configurable via the __init__ will raise an exception
"""
options = _capture_options.CaptureOptions()
options._my_new_value = "foo"
data_dict = options.to_dict()
with self.assertRaises(TypeError, msg="__init__() got an unexpected keyword argument 'my_new_value'"):
regnerated = _capture_options.CaptureOptions.from_dict(data_dict)
async def test_capture_options_unsupported_exr_compression_method(self):
options = _capture_options.CaptureOptions(exr_compression_method="sth_wrong")
self.assertEqual(options.exr_compression_method, "zips")
async def test_capture_options_mp4_encoding_settings(self):
options = _capture_options.CaptureOptions(
mp4_encoding_bitrate=4194304,
mp4_encoding_iframe_interval=10,
mp4_encoding_preset="PRESET_LOSSLESS_HP",
mp4_encoding_profile="H264_PROFILE_PROGRESSIVE_HIGH",
mp4_encoding_rc_mode="RC_VBR_HQ",
mp4_encoding_rc_target_quality=51,
mp4_encoding_video_full_range_flag=True,
)
self.assertEqual(options.mp4_encoding_bitrate, 4194304)
self.assertEqual(options.mp4_encoding_iframe_interval, 10)
self.assertEqual(options.mp4_encoding_preset, "PRESET_LOSSLESS_HP")
self.assertEqual(options.mp4_encoding_profile, "H264_PROFILE_PROGRESSIVE_HIGH")
self.assertEqual(options._mp4_encoding_rc_mode, "RC_VBR_HQ")
self.assertEqual(options._mp4_encoding_rc_target_quality, 51)
self.assertEqual(options.mp4_encoding_video_full_range_flag, True)
async def test_capture_options_unsupported_mp4_encoding_settings(self):
options = _capture_options.CaptureOptions(
mp4_encoding_bitrate=4194304,
mp4_encoding_iframe_interval=10,
mp4_encoding_preset="PRESET_NOT_EXISTING",
mp4_encoding_profile="PROFILE_NOT_EXISTING",
mp4_encoding_rc_mode="RC_NOT_EXISTING",
mp4_encoding_rc_target_quality=52,
mp4_encoding_video_full_range_flag=True,
)
self.assertEqual(options.mp4_encoding_bitrate, 4194304)
self.assertEqual(options.mp4_encoding_iframe_interval, 10)
self.assertEqual(options.mp4_encoding_preset, "PRESET_DEFAULT")
self.assertEqual(options.mp4_encoding_profile, "H264_PROFILE_HIGH")
self.assertEqual(options._mp4_encoding_rc_mode, "RC_VBR")
self.assertEqual(options._mp4_encoding_rc_target_quality, 0)
self.assertEqual(options.mp4_encoding_video_full_range_flag, True)
| 3,701 | Python | 47.077921 | 117 | 0.690354 |
omniverse-code/kit/exts/omni.kit.capture.viewport/omni/kit/capture/viewport/tests/test_capture_render_product.py | import os
import os.path
import omni.kit.test
import omni.usd
import carb
import carb.settings
import carb.tokens
import pathlib
import gc
import unittest
from omni.kit.capture.viewport import CaptureOptions, CaptureExtension
from omni.kit.viewport.utility import get_active_viewport
from omni.kit.test_suite.helpers import wait_stage_loading
from .test_helper import clean_files_in_directory, make_sure_directory_existed, wait_for_image_writing
KIT_ROOT = pathlib.Path(carb.tokens.acquire_tokens_interface().resolve("${kit}")).parent.parent.parent
OUTPUTS_DIR = KIT_ROOT.joinpath("_testoutput/omni.kit.capture.viewport.images")
TEST_DIR = str(pathlib.Path(__file__).parent.parent.parent.parent.parent.parent)
class TestCaptureRenderProduct(omni.kit.test.AsyncTestCase):
# Before running each test
async def setUp(self):
self._usd_context = ''
self._frames_per_sec_to_wait_for_capture_resource_ready = 60
test_usd = TEST_DIR + "/data/tests/usd/PTAccumulateTest.usd"
carb.log_warn(f"testing capture with usd {test_usd}")
self._capture_folder_1spp = "rp_1spp"
self._capture_folder_32spp = "rp_32spp"
self._capture_folder_sequence = "rp_seq"
self._context = omni.usd.get_context()
self._capture_instance = CaptureExtension().get_instance()
await self._context.open_stage_async(test_usd)
await wait_stage_loading()
for _ in range(2):
await omni.kit.app.get_app().next_update_async()
async def tearDown(self) -> None:
self._capture_instance = None
async def _test_render_product_capture(self, image_folder, render_product_name, spp, enable_hdr=True, sequence_capture=False, start_frame=0, end_frame=10):
viewport_api = get_active_viewport(self._usd_context)
# Wait until the viewport has valid resources
await viewport_api.wait_for_rendered_frames()
# wait for PT to resolve after loading, otherwise it's easy to crash
i = self._frames_per_sec_to_wait_for_capture_resource_ready * 50
while i > 0:
await omni.kit.app.get_app().next_update_async()
i -= 1
# assert True
capture_folder_name = image_folder
filePath = pathlib.Path(OUTPUTS_DIR).joinpath(capture_folder_name)
options = CaptureOptions()
options.file_type = ".exr"
options.output_folder = str(filePath)
make_sure_directory_existed(options.output_folder)
clean_files_in_directory(options.output_folder, ".exr")
options.hdr_output = enable_hdr
options.camera = viewport_api.camera_path.pathString
options.render_preset = omni.kit.capture.viewport.CaptureRenderPreset.PATH_TRACE
options.render_product = render_product_name
options.path_trace_spp = spp
# to reduce memory consumption and save time
options.res_width = 600
options.res_height = 337
if sequence_capture:
options.capture_every_Nth_frames = 1
options.start_frame = start_frame
options.end_frame = end_frame
self._capture_instance.options = options
self._capture_instance.start()
options = None
async def _verify_file_exist(self, capture_folder_name, aov_channel):
exr_path = self._get_exr_path(capture_folder_name, aov_channel)
carb.log_warn(f"Verifying image: {exr_path}")
await wait_for_image_writing(exr_path, 40)
assert os.path.isfile(exr_path)
def _get_exr_path(self, capture_folder_name, aov_channel):
image_folder = pathlib.Path(OUTPUTS_DIR).joinpath(capture_folder_name)
exr_path = os.path.join(str(image_folder), "Capture1_" + aov_channel + ".exr")
return exr_path
def _get_captured_image_size(self, capture_folder_name, aov_channel):
image_folder = pathlib.Path(OUTPUTS_DIR).joinpath(capture_folder_name)
exr_path = os.path.join(str(image_folder), "Capture1_" + aov_channel + ".exr")
if os.path.isfile(exr_path):
return os.path.getsize(exr_path)
else:
return 0
async def test_capture_1_default_rp(self):
if True:
# skip the test for vp2 due to OM-77175: we know it will fail and have a bug for it so mark it true here
# and re-enable it after the bug gets fixed
image_folder_name = "vp2_default_rp"
default_rp_name = "/Render/RenderProduct_omni_kit_widget_viewport_ViewportTexture_0"
assert True
for _ in range(self._frames_per_sec_to_wait_for_capture_resource_ready * 10):
await omni.kit.app.get_app().next_update_async()
return
await self._test_render_product_capture(image_folder_name, default_rp_name, 16, enable_hdr=False)
exr_path = self._get_exr_path(image_folder_name, "LdrColor")
await wait_for_image_writing(exr_path)
await self._test_render_product_capture(image_folder_name, default_rp_name, 16)
await self._verify_file_exist(image_folder_name, "LdrColor")
for _ in range(self._frames_per_sec_to_wait_for_capture_resource_ready * 10):
await omni.kit.app.get_app().next_update_async()
async def test_capture_2_user_created_rp(self):
await self._test_render_product_capture(self._capture_folder_1spp, "/Render/RenderView", 1)
for _ in range(self._frames_per_sec_to_wait_for_capture_resource_ready * 10):
await omni.kit.app.get_app().next_update_async()
await self._verify_file_exist(self._capture_folder_1spp, "LdrColor")
await self._verify_file_exist(self._capture_folder_1spp, "HdrColor")
await self._verify_file_exist(self._capture_folder_1spp, "PtGlobalIllumination")
await self._verify_file_exist(self._capture_folder_1spp, "PtReflections")
await self._verify_file_exist(self._capture_folder_1spp, "PtWorldNormal")
# the render product capture process will write the image file multiple times during the capture
# so give it more cycles to settle down to check file size
for _ in range(self._frames_per_sec_to_wait_for_capture_resource_ready * 20):
await omni.kit.app.get_app().next_update_async()
async def test_capture_3_rp_accumulation(self):
await self._test_render_product_capture(self._capture_folder_32spp, "/Render/RenderView", 32)
for _ in range(self._frames_per_sec_to_wait_for_capture_resource_ready * 10):
await omni.kit.app.get_app().next_update_async()
await self._verify_file_exist(self._capture_folder_32spp, "LdrColor")
# the render product capture process will write the image file multiple times during the capture
# so give it more cycles to settle down to check file size
for _ in range(self._frames_per_sec_to_wait_for_capture_resource_ready * 20):
await omni.kit.app.get_app().next_update_async()
# compare result of test_capture_2_user_created_rp images to check accumulation works or not
# if it works, more spp will result in smaller file size
file_size_1spp = self._get_captured_image_size(self._capture_folder_1spp, "LdrColor")
file_size_32spp = self._get_captured_image_size(self._capture_folder_32spp, "LdrColor")
carb.log_warn(f"File size of 1spp capture is {file_size_1spp} bytes, and file size of 64spp capture is {file_size_32spp}")
expected_result = file_size_32spp != file_size_1spp
assert expected_result
async def test_capture_4_rp_sequence(self):
image_folder = pathlib.Path(OUTPUTS_DIR).joinpath(self._capture_folder_sequence, "Capture_frames")
clean_files_in_directory(image_folder, ".exr")
await self._test_render_product_capture(self._capture_folder_sequence, "/Render/RenderView", 1, True, True, 0, 10)
start_frame_exr_path_1 = os.path.join(str(image_folder), "Capture.0000_" + "LdrColor" + ".exr")
start_frame_exr_path_2 = os.path.join(str(image_folder), "Capture.0000_" + "PtGlobalIllumination" + ".exr")
end_frame_exr_path_1 = os.path.join(str(image_folder), "Capture.0010_" + "LdrColor" + ".exr")
end_frame_exr_path_2 = os.path.join(str(image_folder), "Capture.0010_" + "PtGlobalIllumination" + ".exr")
await wait_for_image_writing(end_frame_exr_path_2, 50)
assert os.path.isfile(start_frame_exr_path_1)
assert os.path.isfile(start_frame_exr_path_2)
assert os.path.isfile(end_frame_exr_path_1)
assert os.path.isfile(end_frame_exr_path_2)
| 8,586 | Python | 49.511764 | 159 | 0.669811 |
omniverse-code/kit/exts/omni.kit.capture.viewport/omni/kit/capture/viewport/tests/test_capture_png.py | from typing import Type
import os
import os.path
import omni.kit.test
import carb
import carb.settings
import carb.tokens
import pathlib
import gc
from omni.kit.capture.viewport import CaptureOptions, CaptureExtension
from omni.kit.viewport.utility import get_active_viewport, create_viewport_window, capture_viewport_to_file
from .test_helper import clean_files_in_directory, make_sure_directory_existed, wait_for_image_writing
KIT_ROOT = pathlib.Path(carb.tokens.acquire_tokens_interface().resolve("${kit}")).parent.parent.parent
OUTPUTS_DIR = KIT_ROOT.joinpath("_testoutput/omni.kit.capture.viewport.images")
class TestCapturePng(omni.kit.test.AsyncTestCase):
# Before running each test
async def setUp(self):
self._usd_context = ''
settings = carb.settings.get_settings()
self._frames_wait_for_capture_resource_ready = 6
await omni.usd.get_context(self._usd_context).new_stage_async()
async def test_png_capture(self):
viewport_api = get_active_viewport(self._usd_context)
# Wait until the viewport has valid resources
await viewport_api.wait_for_rendered_frames()
capture_filename = "capture_png_test"
filePath = pathlib.Path(OUTPUTS_DIR).joinpath(capture_filename)
options = CaptureOptions()
options.file_type = ".png"
options.output_folder = str(filePath)
make_sure_directory_existed(options.output_folder)
clean_files_in_directory(options.output_folder, ".png")
exr_path = os.path.join(options._output_folder, "Capture1.png")
carb.log_warn(f"Capture image path: {exr_path}")
options.hdr_output = False
options.camera = viewport_api.camera_path.pathString
capture_instance = CaptureExtension().get_instance()
capture_instance.options = options
capture_instance.start()
await wait_for_image_writing(exr_path)
options = None
capture_instance = None
gc.collect()
assert os.path.isfile(exr_path)
| 2,027 | Python | 37.26415 | 107 | 0.702023 |
omniverse-code/kit/exts/omni.hydra.ui/omni/hydra/ui/scripts/extension.py | import omni.ext
from .settings import OmniHydraSettings
class PublicExtension(omni.ext.IExt):
def on_startup(self):
self._settings = OmniHydraSettings()
def on_shutdown(self):
self._settings = None
| 225 | Python | 19.545453 | 44 | 0.697778 |
omniverse-code/kit/exts/omni.hydra.ui/omni/hydra/ui/scripts/settings.py | import asyncio
import omni.ui
import omni.kit.app
import omni.kit.commands
import carb.settings
### Copied from omni.phyx; Kit team will coalesce into omni.ui.settings module
class Model(omni.ui.AbstractValueModel):
def __init__(self, path):
super().__init__()
self._path = path
val = carb.settings.get_settings().get(path)
if val is None:
val = 0
self._value = val
def on_change(item, event_type, path=path):
self._value = carb.settings.get_settings().get(path)
self._value_changed()
self._sub = omni.kit.app.SettingChangeSubscription(path, on_change)
def get_value_as_bool(self):
return self._value
def get_value_as_int(self):
return self._value
def get_value_as_float(self):
return self._value
def get_value_as_string(self):
return self._value
def set_value(self, value):
omni.kit.commands.execute("ChangeSetting", path=self._path, value=value)
self._value = value
self._value_changed()
def create_setting_widget(setting_path, cls, **kwargs):
model = Model(setting_path)
widget = cls(model, **kwargs)
return (model, widget)
### end omni.physx boilerplate
class OmniHydraSettings(omni.ui.Window):
def __init__(self):
self._title = "OmniHydra Developer Settings"
super().__init__(self._title, omni.ui.DockPreference.LEFT_BOTTOM, width=800, height=600)
self._widgets = []
with self.frame:
self._build_ui()
asyncio.ensure_future(self._dock_window(self._title, omni.ui.DockPosition.SAME))
async def _dock_window(self, window_title: str, position: omni.ui.DockPosition, ratio: float = 1.0):
frames = 3
while frames > 0:
if omni.ui.Workspace.get_window(window_title):
break
frames = frames - 1
await omni.kit.app.get_app().next_update_async()
window = omni.ui.Workspace.get_window(window_title)
dockspace = omni.ui.Workspace.get_window("Property")
if window and dockspace:
window.dock_in(dockspace, position, ratio=ratio)
window.dock_tab_bar_visible = False
def on_shutdown(self):
self._widgets = []
def _add_setting_widget(self, name, path, cls, **kwargs):
with omni.ui.VStack():
omni.ui.Spacer(height=2)
with omni.ui.HStack(height=20):
self._widgets.append(create_setting_widget(path, cls, **kwargs))
omni.ui.Label(name)
def _build_settings_ui(self):
self._add_setting_widget("Use fast scene delegate", "/persistent/omnihydra/useFastSceneDelegate", omni.ui.CheckBox)
self._add_setting_widget("Use scene graph instancing", "/persistent/omnihydra/useSceneGraphInstancing", omni.ui.CheckBox)
self._add_setting_widget("Use skel adapter", "/persistent/omnihydra/useSkelAdapter", omni.ui.CheckBox)
self._add_setting_widget("Use skel adapter blendshape", "/persistent/omnihydra/useSkelAdapterBlendShape", omni.ui.CheckBox)
self._add_setting_widget("Use skel adapter deform graph", "/persistent/omnihydra/useSkelAdapterDeformGraph", omni.ui.CheckBox)
self._add_setting_widget("Use cached xform time samples", "/persistent/omnihydra/useCachedXformTimeSamples", omni.ui.CheckBox)
self._add_setting_widget("Use async RenderGraph in _PullFromRingBuffer", "/persistent/omnihydra/useAsyncRenderGraph", omni.ui.CheckBox)
self._add_setting_widget("Use fast xform path from Fabric to renderer", "/persistent/rtx/hydra/readTransformsFromFabricInRenderDelegate", omni.ui.CheckBox)
def _build_usdrt_settings_ui(self):
self._add_setting_widget("Use Fabric World Bounds", "/app/omni.usd/useFabricWorldBounds", omni.ui.CheckBox)
self._add_setting_widget("Use camera-based priority sorting", "/app/usdrt/scene_delegate/useWorldInterestBasedSorting", omni.ui.CheckBox)
self._add_setting_widget("GPU Memory Budget %", "/app/usdrt/scene_delegate/gpuMemoryBudgetPercent", omni.ui.FloatSlider, min=0., max=100.)
with omni.ui.CollapsableFrame("Geometry Streaming"):
with omni.ui.VStack():
self._add_setting_widget("Enable geometry streaming", "/app/usdrt/scene_delegate/geometryStreaming/enabled", omni.ui.CheckBox)
self._add_setting_widget("Enable proxy cubes for unloaded prims", "/app/usdrt/scene_delegate/enableProxyCubes", omni.ui.CheckBox)
self._add_setting_widget("Solid Angle Loading To Load in first batch", "/app/usdrt/scene_delegate/geometryStreaming/solidAngleToLoadInFirstChunk", omni.ui.FloatSlider, min=0, max=1, step=0.0001)
self._add_setting_widget("Solid Angle Loading Limit", "/app/usdrt/scene_delegate/geometryStreaming/solidAngleLimit", omni.ui.FloatSlider, min=0, max=1, step=0.0001)
self._add_setting_widget("Solid Angle Loading Limit Divider", "/app/usdrt/scene_delegate/geometryStreaming/solidAngleLimitDivider", omni.ui.FloatSlider, min=1, max=10000, step=100)
self._add_setting_widget("Number of frames between batches", "/app/usdrt/scene_delegate/numFramesBetweenLoadBatches", omni.ui.IntSlider, min=1, max=50)
self._add_setting_widget("Number of vertices to load per batch", "/app/usdrt/scene_delegate/geometryStreaming/numberOfVerticesToLoadPerChunk", omni.ui.IntSlider, min=1, max=5000000)
self._add_setting_widget("Number of vertices to unload per batch", "/app/usdrt/scene_delegate/geometryStreaming/numberOfVerticesToUnloadPerChunk", omni.ui.IntSlider, min=1, max=5000000)
self._add_setting_widget("Number of cubes proxy instances per instancer", "/app/usdrt/scene_delegate/proxyInstanceBucketSize", omni.ui.IntSlider, min=0, max=200000)
with omni.ui.CollapsableFrame("Memory Budget Experimental Stability Values"):
with omni.ui.VStack():
self._add_setting_widget("Update Delay in microseconds", "/app/usdrt/scene_delegate/updateDelayInMicroSeconds", omni.ui.IntSlider, min=0, max=1000000)
self._add_setting_widget("GPU Memory Deadzone %", "/app/usdrt/scene_delegate/gpuMemoryBudgetDeadZone", omni.ui.FloatSlider, min=0., max=50.)
self._add_setting_widget("GPU Memory Filter Damping", "/app/usdrt/scene_delegate/gpuMemoryFilterDamping", omni.ui.FloatSlider, min=0., max=2.)
with omni.ui.CollapsableFrame("Memory Limit Testing (pretend values)"):
with omni.ui.VStack():
self._add_setting_widget("Enable memory testing", "/app/usdrt/scene_delegate/testing/enableMemoryTesting", omni.ui.CheckBox)
self._add_setting_widget("GPU Memory Available", "/app/usdrt/scene_delegate/testing/availableDeviceMemory", omni.ui.FloatSlider, min=0., max=float(1024*1024*1024*8))
self._add_setting_widget("GPU Memory Total", "/app/usdrt/scene_delegate/testing/totalDeviceMemory", omni.ui.FloatSlider, min=0., max=float(1024*1024*1024*8))
with omni.ui.CollapsableFrame("USD Population (reload scene to see effect)"):
with omni.ui.VStack():
self._add_setting_widget("Read Curves", "/app/usdrt/population/utils/readCurves", omni.ui.CheckBox)
self._add_setting_widget("Read Materials", "/app/usdrt/population/utils/readMaterials", omni.ui.CheckBox)
self._add_setting_widget("Read Lights", "/app/usdrt/population/utils/readLights", omni.ui.CheckBox)
self._add_setting_widget("Read Primvars", "/app/usdrt/population/utils/readPrimvars", omni.ui.CheckBox)
self._add_setting_widget("Enable Subcomponent merging", "/app/usdrt/population/utils/mergeSubcomponents", omni.ui.CheckBox)
self._add_setting_widget("Enable Instance merging", "/app/usdrt/population/utils/mergeInstances", omni.ui.CheckBox)
self._add_setting_widget("Enable Material merging", "/app/usdrt/population/utils/mergeMaterials", omni.ui.CheckBox)
self._add_setting_widget("Single-threaded population", "/app/usdrt/population/utils/singleThreaded", omni.ui.CheckBox)
self._add_setting_widget("Disable Light Scaling (non-RTX delegates)", "/app/usdrt/scene_delegate/disableLightScaling", omni.ui.CheckBox)
self._add_setting_widget("Use Fabric Scene Graph Instancing", "/app/usdrt/population/utils/handleSceneGraphInstances", omni.ui.CheckBox)
self._add_setting_widget("Use Hydra BlendShape", "/app/usdrt/scene_delegate/useHydraBlendShape", omni.ui.CheckBox)
self._add_setting_widget("Number of IO threads", "/app/usdrt/population/utils/ioBoundThreadCount", omni.ui.IntSlider, min=1, max=16)
def _build_section(self, name, build_func):
with omni.ui.CollapsableFrame(name, height=0):
with omni.ui.HStack():
omni.ui.Spacer(width=20, height=5)
with omni.ui.VStack():
build_func()
def _build_ui(self):
with omni.ui.ScrollingFrame(horizontal_scrollbar_policy=omni.ui.ScrollBarPolicy.SCROLLBAR_ALWAYS_OFF,
vertical_scrollbar_policy=omni.ui.ScrollBarPolicy.SCROLLBAR_AS_NEEDED):
with omni.ui.VStack():
self._build_section("Settings (requires stage reload)", self._build_settings_ui)
self._build_section("USDRT Hydra Settings", self._build_usdrt_settings_ui)
| 9,531 | Python | 63.405405 | 210 | 0.676634 |
omniverse-code/kit/exts/omni.kit.window.extensions/omni/kit/window/extensions/common.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 asyncio
import os
import os.path
from enum import Enum
from functools import lru_cache
from string import Template
from typing import Callable, Dict, List, Tuple
import carb.events
import carb.settings
import carb.tokens
import omni.kit.app
from . import ext_controller
from .utils import get_ext_info_dict, get_extpath_git_ext, get_setting, set_default_and_get_setting, show_ok_popup
# Extension root path. Set when extension starts.
EXT_ROOT = None
REGISTRIES_CHANGED_EVENT = carb.events.type_from_string("omni.kit.registry.nucleus.REGISTRIES_CHANGED_EVENT")
REGISTRIES_SETTING = "/exts/omni.kit.registry.nucleus/registries"
USER_REGISTRIES_SETTING = "/persistent/exts/omni.kit.registry.nucleus/userRegistries"
EXTENSION_PULL_STARTED_EVENT = carb.events.type_from_string("omni.kit.window.extensions.EXTENSION_PULL_STARTED_EVENT")
COMMUNITY_TAB_TOGGLE_EVENT = carb.events.type_from_string("omni.kit.window.extensions.COMMUNITY_TAB_TOGGLE_EVENT")
REMOTE_IMAGE_SUPPORTED_EXTS = {".png"}
def path_is_parent(parent_path, child_path):
try:
return os.path.commonpath([parent_path]) == os.path.commonpath([parent_path, child_path])
except ValueError:
return False
def is_in_omni_documents(path):
return path_is_parent(get_omni_documents_path(), path)
@lru_cache()
def get_icons_path() -> str:
assert EXT_ROOT is not None, "This function should be called only after EXT_ROOT is set"
return f"{EXT_ROOT}/icons"
@lru_cache()
def get_omni_documents_path() -> str:
return os.path.abspath(carb.tokens.get_tokens_interface().resolve("${omni_documents}"))
@lru_cache()
def get_kit_path() -> str:
return os.path.abspath(carb.tokens.get_tokens_interface().resolve("${kit}"))
@lru_cache()
def get_categories() -> Dict:
icons_path = get_icons_path()
categories = {
"animation": {"name": "Animation", "image": f"{icons_path}/data/category-animation.png"},
"graph": {"name": "Graph", "image": f"{icons_path}/data/category-graph.png"},
"rendering": {"name": "Lighting & Rendering", "image": f"{icons_path}/data/category-rendering.png"},
"audio": {"name": "Audio", "image": f"{icons_path}/data/category-audio.png"},
"simulation": {"name": "Simulation", "image": f"{icons_path}/data/category-simulation.png"},
"services": {"name": "Services", "image": f"{icons_path}/data/category-internal.png"},
"core": {"name": "Core", "image": f"{icons_path}/data/category-core.png"},
"example": {"name": "Example", "image": f"{icons_path}/data/category-example.png"},
"internal": {"name": "Internal", "image": f"{icons_path}/data/category-internal.png", "hidden": False},
"legacy": {"name": "Legacy", "image": f"{icons_path}/data/category-legacy.png"},
"other": {"name": "Other", "image": f"{icons_path}/data/category-internal.png"},
}
return categories
class ExtSource(Enum):
NVIDIA = 0
THIRD_PARTY = 1
def get_ui_name(self):
return "NVIDIA" if self == ExtSource.NVIDIA else "THIRD PARTY"
class ExtAuthorGroup(Enum):
NVIDIA = 0
PARTNER = 1
COMMUNITY_VERIFIED = 2
COMMUNITY_UNVERIFIED = 3
USER = 4
def get_ui_name(self):
if self == ExtAuthorGroup.NVIDIA:
return "NVIDIA"
if self == ExtAuthorGroup.PARTNER:
return "PARTNER"
if self == ExtAuthorGroup.USER:
return "USER"
return "COMMUNITY"
def get_registries():
settings = carb.settings.get_settings()
settings_dict = settings.get_settings_dictionary("")
for key, is_user in [(REGISTRIES_SETTING, False), (USER_REGISTRIES_SETTING, True)]:
for r in settings_dict.get(key[1:], []):
name = r.get("name", "")
url = r.get("url", "")
url = carb.tokens.get_tokens_interface().resolve(url)
yield name, url, is_user
@lru_cache()
def get_registry_url(registry_name):
version = get_setting("/app/extensions/registryVersion", "NOT_SET")
for name, url, _ in get_registries():
if name == registry_name:
return f"{url}/{version}"
return None
class ExtensionCommonInfo:
def __init__(self, ext_id, ext_info, is_local):
self.id = ext_id
package_dict = ext_info.get("package", {})
self.fullname = package_dict["name"]
self.title = package_dict.get("title", "").upper() or self.fullname
self.name = self.title.lower() # used for sorting
self.description = package_dict.get("description", "") or "No Description"
self.version = package_dict.get("version", None)
self.keywords = package_dict.get("keywords", [])
self.toggleable = package_dict.get("toggleable", True)
self.feature = package_dict.get("feature", False)
self.authors = package_dict.get("authors", "")
self.repository = package_dict.get("repository", "")
self.package_id = package_dict.get("packageId", "")
self.is_kit_file = ext_info.get("isKitFile", False)
self.is_app = ("app" in self.keywords) or package_dict.get("app", self.is_kit_file)
self.is_startup = ext_controller.is_startup_ext(self.fullname)
self.is_startup_version = ext_controller.is_startup_ext(ext_id)
self.is_featured = ext_controller.is_featured_ext(self.fullname)
self.is_local = is_local
state_dict = ext_info.get("state", {})
self.failed = state_dict.get("failed", False)
self.enabled = state_dict.get("enabled", False)
self.reloadable = state_dict.get("reloadable", False)
self.is_pulled = state_dict.get("isPulled", False)
self.is_toggle_blocked = (self.enabled and not self.reloadable) or (not self.toggleable)
self.path = ext_info.get("path", "")
self.provider_name = None
# Only if solve_extensions is called
self.non_toggleable_deps = []
self.solver_error = ""
self.category = package_dict.get("category", "other").lower()
# Ext sources
if package_dict.get("exchange", False):
if package_dict.get("partner", False):
self.author_group = ExtAuthorGroup.PARTNER
else:
self.author_group = ExtAuthorGroup.COMMUNITY_VERIFIED
elif not package_dict.get("trusted", True):
self.author_group = ExtAuthorGroup.COMMUNITY_UNVERIFIED
else:
self.author_group = ExtAuthorGroup.NVIDIA
# Extension location tag for UI and user extensions
self.location_tag = ""
if is_local:
abs_path = os.path.abspath(self.path)
if ext_info.get("isInCache", False):
self.location_tag = "INSTALLED"
elif self.author_group == ExtAuthorGroup.NVIDIA and (
ext_info.get("isUser", False) or is_in_omni_documents(abs_path)
):
self.author_group = ExtAuthorGroup.USER
else:
git_ext = get_extpath_git_ext()
if git_ext and path_is_parent(git_ext.get_cache_path(), abs_path):
self.location_tag = "GIT"
# Finalize source
self.ext_source = ExtSource.NVIDIA if self.author_group == ExtAuthorGroup.NVIDIA else ExtSource.THIRD_PARTY
self.is_untrusted = self.author_group == ExtAuthorGroup.COMMUNITY_UNVERIFIED
# Remote exts
if not is_local:
self.location_tag = "REMOTE"
self.provider_name = ext_info.get("registryProviderName", None)
# If unknown category -> fallback to other
categories = get_categories()
if self.category not in categories:
self.category = "other"
# For icon by default use category icon, can be overriden with custom:
self.icon_path = self._build_image_resource_path(package_dict, "icon", categories[self.category]["image"])
# For preview image there is no default
self.preview_image_path = self._build_image_resource_path(package_dict, "preview_image")
def _build_image_resource_path(self, package_dict, key, default_path=None):
resource_path = default_path
if self.is_local:
path = package_dict.get(key, None)
if path:
icon_path = os.path.join(self.path, path)
if os.path.exists(icon_path):
resource_path = icon_path
else:
path = package_dict.get(key + "_remote", None)
if path:
if os.path.splitext(path)[1] not in REMOTE_IMAGE_SUPPORTED_EXTS:
return default_path
url = get_registry_url(self.provider_name)
if url:
resource_path = url + "/" + path
return resource_path
def solve_extensions(self):
# This function is costly, so we don't run it for each item. Only on demand when UI shows selected extension.
manager = omni.kit.app.get_app().get_extension_manager()
result, exts, err = manager.solve_extensions([self.id], add_enabled=True, return_only_disabled=True)
if not result:
self.failed = True
self.non_toggleable_deps = []
self.solver_error = err
if result:
for ext in exts:
ext_dict, _ = get_ext_info_dict(manager, ext)
if not ext_dict.get("package", {}).get("toggleable", True):
self.non_toggleable_deps.append(ext["id"])
def build_ext_info(ext_id, package_id=None) -> Tuple[ExtensionCommonInfo, dict]:
manager = omni.kit.app.get_app().get_extension_manager()
package_id = package_id or ext_id
ext_info_remote = manager.get_registry_extension_dict(package_id)
ext_info_local = manager.get_extension_dict(ext_id)
is_local = ext_info_local is not None
ext_info = ext_info_local or ext_info_remote
if not ext_info:
return None, None
ext_info = ext_info.get_dict() # convert to python dict to prolong lifetime
return ExtensionCommonInfo(ext_id, ext_info, is_local), ext_info
def check_can_be_toggled(ext_id: str, for_autoload=False):
ext_item, _ = build_ext_info(ext_id)
if ext_item:
ext_item.solve_extensions()
# Error to solve?
if ext_item.solver_error:
text = "Failed to solve all extension dependencies:"
text += f"\n{ext_item.solver_error}"
asyncio.ensure_future(show_ok_popup("Error", text))
return False
if not for_autoload and ext_item.non_toggleable_deps:
text = "This extension cannot be enabled at runtime.\n"
text += "Some of dependencies require an app restart to be enabled (toggleable=false):\n\n"
for ext in ext_item.non_toggleable_deps:
text += f" * {ext}"
text += "\n\n"
text += "Set this extension to autoload and restart an app to enable it."
asyncio.ensure_future(show_ok_popup("Warning", text))
return False
return True
def toggle_extension(ext_id: str, enable: bool):
if enable and not check_can_be_toggled(ext_id):
return False
omni.kit.commands.execute("ToggleExtension", ext_id=ext_id, enable=enable)
return True
async def pull_extension_async(ext_item: ExtensionCommonInfo, on_pull_started_fn: Callable = None):
if ext_item.is_untrusted:
cancel = False
def on_cancel(dialog):
nonlocal cancel
cancel = True
dialog.hide()
message = """
ATTENTION: UNVERIFIED COMMUNITY EXTENSION
This extension will be installed directly from the repository (see "Repo Url").
It is not verified by NVIDIA and may contain bugs or malicious code. Do you want to proceed?
"""
await show_ok_popup(
"Warning",
message,
ok_label="Install",
cancel_label="Cancel",
disable_cancel_button=False,
cancel_handler=on_cancel,
width=600,
)
if cancel:
return
ext_manager = omni.kit.app.get_app().get_extension_manager()
ext_manager.pull_extension_async(ext_item.id)
omni.kit.app.get_app().get_message_bus_event_stream().push(EXTENSION_PULL_STARTED_EVENT)
if on_pull_started_fn:
on_pull_started_fn()
class SettingBoolValue:
def __init__(self, path: str, default: bool):
self._path = path
self._value = set_default_and_get_setting(path, default)
def get(self) -> bool:
return self._value
def set_bool(self, value: bool):
self._value = value
carb.settings.get_settings().set(self._path, self._value)
def __bool__(self):
return self.get()
def build_doc_urls(ext_item: ExtensionCommonInfo) -> List[str]:
"""Produce possible candiates for doc urls"""
# Base url
if omni.kit.app.get_app().is_app_external():
doc_url = get_setting("/exts/omni.kit.window.extensions/docUrlExternal", "")
else:
doc_url = get_setting("/exts/omni.kit.window.extensions/docUrlInternal", "")
if not doc_url:
return []
# Build candidates. Prefer exact version, fallback to just a link to latest
candidates = []
for v in [ext_item.version, "latest", ""]:
candidates.append(Template(doc_url).safe_substitute({"version": v, "extName": ext_item.fullname}))
return candidates
@lru_cache()
def is_community_tab_always_enabled() -> bool:
return get_setting("/exts/omni.kit.window.extensions/communityTabEnabled", True)
def is_community_tab_enabled_as_option() -> bool:
if is_community_tab_always_enabled():
return False
return get_setting("/exts/omni.kit.window.extensions/communityTabOption", True)
class ExtOptions:
def __init__(self):
self.community_tab = None
if is_community_tab_enabled_as_option():
self.community_tab = SettingBoolValue(
"/persistent/exts/omni.kit.window.extensions/communityTabEnabled", default=False
)
self.publishing = SettingBoolValue(
"/persistent/exts/omni.kit.window.extensions/publishingEnabled", default=False
)
@lru_cache()
def get_options() -> ExtOptions:
return ExtOptions()
def is_community_tab_enabled() -> bool:
# Can be either always enabled, or as a toggleable preference
if is_community_tab_always_enabled():
return True
return get_options().community_tab is not None and get_options().community_tab
@lru_cache()
def get_open_example_links():
return get_setting("/exts/omni.kit.window.extensions/openExampleLinks", [])
| 15,092 | Python | 36.451613 | 118 | 0.633316 |
omniverse-code/kit/exts/omni.kit.window.extensions/omni/kit/window/extensions/exts_properties_paths.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 omni.kit.app
import omni.ui as ui
from .styles import get_style
from .utils import cleanup_folder, copy_text, get_extpath_git_ext
PATH_TYPE_TO_LABEL = {
omni.ext.ExtensionPathType.COLLECTION: "[dir]",
omni.ext.ExtensionPathType.COLLECTION_USER: "[user dir]",
omni.ext.ExtensionPathType.COLLECTION_CACHE: "[cache dir]",
omni.ext.ExtensionPathType.DIRECT_PATH: "[ext]",
omni.ext.ExtensionPathType.EXT_1_FOLDER: "[exts 1.0]",
}
PATH_TYPE_TO_COLOR = {
omni.ext.ExtensionPathType.COLLECTION: 0xFF29A9A9,
omni.ext.ExtensionPathType.COLLECTION_USER: 0xFF1989A9,
omni.ext.ExtensionPathType.COLLECTION_CACHE: 0xFFA9A929,
omni.ext.ExtensionPathType.DIRECT_PATH: 0xFF29A929,
omni.ext.ExtensionPathType.EXT_1_FOLDER: 0xFF2929A9,
}
PATHS_COLUMNS = ["", "name", "type", "edit"]
class PathItem(ui.AbstractItem):
def __init__(self, path, path_type: omni.ext.ExtensionPathType, add_dummy=False):
super().__init__()
self.path_model = ui.SimpleStringModel(path)
self.type = path_type
self.is_user = path_type == omni.ext.ExtensionPathType.COLLECTION_USER
self.is_cache = path_type == omni.ext.ExtensionPathType.COLLECTION_CACHE
self.add_dummy = add_dummy
git_ext = get_extpath_git_ext()
if git_ext and git_ext.is_git_path(path):
self.is_git = True
self.local_path = git_ext.get_local_path(path)
else:
self.is_git = False
self.local_path = path
class PathsModel(ui.AbstractItemModel):
def __init__(self):
super().__init__()
self._ext_manager = omni.kit.app.get_app().get_extension_manager()
self._children = []
self._load()
self._add_dummy = PathItem("", omni.ext.ExtensionPathType.COLLECTION_USER, add_dummy=True)
def destroy(self):
self._children = []
def get_item_children(self, item):
"""Returns all the children when the widget asks it."""
if item is not None:
return []
return self._children + [self._add_dummy]
def get_item_value_model_count(self, item):
"""The number of columns"""
return 4
def get_item_value_model(self, item, column_id):
if column_id == 1:
return item.path_model
return None
def _load(self):
self._children = []
folders = self._ext_manager.get_folders()
for folder in folders:
path = folder["path"]
path_type = folder["type"]
item = PathItem(path, path_type)
self._children.append(item)
self._item_changed(None)
def add_empty(self):
self._children.append(PathItem("", omni.ext.ExtensionPathType.COLLECTION_USER))
self._item_changed(None)
def remove_item(self, item):
self._children.remove(item)
self.save()
self._item_changed(None)
def clean_cache(self, item):
path = item.local_path
print(f"Cleaning up cache: {path}")
cleanup_folder(path)
def update_git(self, item):
path = item.path_model.as_string
get_extpath_git_ext().update_git_path(path)
def save(self):
current = [
folder["path"]
for folder in self._ext_manager.get_folders()
if folder["type"] == omni.ext.ExtensionPathType.COLLECTION_USER
]
paths = [c.path_model.as_string for c in self._children if c.is_user]
if current != paths:
# remove and add again. We can only apply diff here, but then it is impossible to preserve the order.
for p in current:
self._ext_manager.remove_path(p)
for p in paths:
self._ext_manager.add_path(p, omni.ext.ExtensionPathType.COLLECTION_USER)
get_extpath_git_ext.cache_clear()
class EditableDelegate(ui.AbstractItemDelegate):
def __init__(self):
super().__init__()
self._subscription = None
self._context_menu = ui.Menu("Context menu")
def destroy(self):
self._subscription = None
self._context_menu = None
def _show_copy_context_menu(self, x, y, button, modifier, text):
if button != 1:
return
self._context_menu.clear()
with self._context_menu:
ui.MenuItem("Copy", triggered_fn=lambda: copy_text(text))
self._context_menu.show()
def build_widget(self, model, item, column_id, level, expanded):
"""Create a widget per column per item"""
with ui.HStack(width=20):
if column_id == 0 and not item.add_dummy:
def open_path(item_=item):
# Import it here instead of on the file root because it has long import time.
path = item_.local_path
if path:
import webbrowser
webbrowser.open(path)
ui.Button("open", width=0, clicked_fn=open_path, tooltip="Open path using OS file explorer.")
elif column_id == 1 and not item.add_dummy:
value_model = model.get_item_value_model(item, column_id)
stack = ui.ZStack(height=20)
with stack:
label = ui.Label(value_model.as_string, width=500, name=("config" if item.is_user else "builtin"))
field = ui.StringField(value_model, visible=False)
# Start editing when double clicked
stack.set_mouse_double_clicked_fn(
lambda x, y, b, _, f=field, l=label, m=model, i=item: self.on_double_click(b, f, l, m, i)
)
# Right click is copy menu
stack.set_mouse_pressed_fn(
lambda x, y, b, m, t=value_model.as_string: self._show_copy_context_menu(x, y, b, m, t)
)
elif column_id == 2 and not item.add_dummy:
ui.Label(PATH_TYPE_TO_LABEL[item.type], style={"color": PATH_TYPE_TO_COLOR[item.type]})
elif column_id == 3:
if item.is_user:
def on_click(item_=item):
if item.add_dummy:
model.add_empty()
else:
model.remove_item(item_)
ui.Spacer(width=10)
ui.Button(
name=("add" if item.add_dummy else "remove"),
style_type_name_override="ItemButton",
width=20,
height=20,
clicked_fn=on_click,
)
ui.Spacer(width=4)
elif item.is_cache:
def clean_cache(item_=item):
model.clean_cache(item_)
ui.Spacer(width=10)
ui.Button(
name="clean",
style_type_name_override="ItemButton",
width=20,
height=20,
clicked_fn=clean_cache,
)
ui.Spacer(width=4)
if item.is_git:
def update_git(item_=item):
model.update_git(item_)
ui.Button(
name="update",
style_type_name_override="ItemButton",
width=20,
height=20,
clicked_fn=update_git,
)
ui.Spacer()
def on_double_click(self, button, field, label, model, item):
"""Called when the user double-clicked the item in TreeView"""
if button != 0:
return
if item.add_dummy:
return
if not item.is_user:
copy_text(field.model.as_string)
return
# Make Field visible when double clicked
field.visible = True
field.focus_keyboard()
# When editing is finished (enter pressed of mouse clicked outside of the viewport)
self._subscription = field.model.subscribe_end_edit_fn(
lambda m, f=field, l=label, md=model: self.on_end_edit(m.as_string, f, l, md)
)
def on_end_edit(self, text, field, label, model):
"""Called when the user is editing the item and pressed Enter or clicked outside of the item"""
field.visible = False
label.text = text
self._subscription = None
if text:
model.save()
def build_header(self, column_id):
with ui.HStack():
ui.Spacer(width=10)
ui.Label(PATHS_COLUMNS[column_id], name="header")
class ExtsPathsWidget:
def __init__(self):
self._model = PathsModel()
self._delegate = EditableDelegate()
with ui.VStack(style=get_style(self)):
ui.Spacer(height=20)
with ui.ScrollingFrame(
height=400,
horizontal_scrollbar_policy=ui.ScrollBarPolicy.SCROLLBAR_ALWAYS_OFF,
vertical_scrollbar_policy=ui.ScrollBarPolicy.SCROLLBAR_ALWAYS_OFF,
style_type_name_override="TreeView",
):
tree_view = ui.TreeView(
self._model,
delegate=self._delegate,
root_visible=False,
header_visible=True,
)
tree_view.column_widths = [ui.Pixel(46), ui.Fraction(1), ui.Pixel(70), ui.Pixel(60)]
ui.Spacer(height=10)
def destroy(self):
self._model.destroy()
self._model = None
self._delegate.destroy()
self._delegate = None
| 10,223 | Python | 35.127208 | 118 | 0.55023 |
omniverse-code/kit/exts/omni.kit.window.extensions/omni/kit/window/extensions/styles.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 functools import lru_cache
from typing import Dict
import omni.ui as ui
from omni.ui import color as cl
from .common import get_icons_path
# Common size constants:
EXT_ICON_SIZE = (70, 70)
EXT_ICON_SIZE_LARGE = (100, 100)
CATEGORY_ICON_SIZE = (70, 70)
EXT_LIST_ITEM_H = 106
EXT_LIST_ITEMS_MARGIN_H = 3
EXT_ITEM_TITLE_BAR_H = 27
EXT_LIST_ITEM_ICON_ZONE_W = 87
@lru_cache()
def get_styles() -> Dict:
icons_path = get_icons_path()
styles = {
"ExtensionToggle": {
"Image::Failed": {"image_url": f"{icons_path}/exclamation.svg", "color": 0xFF2222DD, "margin": 5},
"Button": {"margin": 0, "padding": 0, "background_color": 0x0},
"Button:checked": {"background_color": 0x0},
"Button.Image::nonclickable": {"color": 0x60FFFFFF, "image_url": f"{icons_path}/toggle-off.svg"},
"Button.Image::nonclickable:checked": {"color": 0x60FFFFFF, "image_url": f"{icons_path}/toggle-on.svg"},
"Button.Image::clickable": {"image_url": f"{icons_path}/toggle-off.svg", "color": 0xFFFFFFFF},
"Button.Image::clickable:checked": {"image_url": f"{icons_path}/toggle-on.svg"},
"Label::EnabledLabel": {"font_size": 16, "color": 0xFF71A376},
"Label::DisabledLabel": {"font_size": 16, "color": 0xFFB9B9B9},
"Button::InstallButton": {"background_color": 0xFF00B976, "border_radius": 4},
"Button::InstallButton:checked": {"background_color": 0xFF06A66B},
"Button.Label::InstallButton": {"color": 0xFF3E3E3E, "font_size": 14},
"Button::DownloadingButton": {"background_color": 0xFF008253, "border_radius": 4},
"Button.Label::DownloadingButton": {"color": 0xFF3E3E3E, "font_size": 8},
"Button::LaunchButton": {"background_color": 0xFF00B976, "border_radius": 4},
"Button.Label::LaunchButton": {"color": 0xFF3E3E3E, "font_size": 14},
},
"SimpleCheckBox": {
"Button": {"margin": 0, "padding": 0, "background_color": 0x0},
"Button:hovered": {"background_color": 0x0},
"Button:checked": {"background_color": 0x0},
"Button:pressed": {"background_color": 0x0},
"Button.Image": {"image_url": f"{icons_path}/checkbox-off.svg", "color": 0xFFA8A8A8},
"Button.Image:hovered": {"color": 0xFF929292},
"Button.Image:pressed": {"color": 0xFFA4A4A4},
"Button.Image:checked": {"image_url": f"{icons_path}/checkbox-on.svg", "color": 0xFFA8A8A8},
"Image::disabled_checked": {"image_url": f"{icons_path}/checkbox-on.svg", "color": 0x3FA8A8A8},
"Image::disabled_unchecked": {"image_url": f"{icons_path}/checkbox-off.svg", "color": 0x3FA8A8A8},
"Label::disabled": {"font_size": 12, "color": 0xFF444444},
"Label": {"font_size": 16, "color": 0xFFC4C4C4},
},
"SearchWidget": {
"SearchField": {
"background_color": 0xFF212121,
"color": 0xFFA2A2A2,
"border_radius": 0,
"font_size": 16,
"margin": 0,
"padding": 5,
},
"Image::SearchIcon": {"image_url": f"{icons_path}/search.svg", "color": 0xFF646464},
"Label::Search": {"color": 0xFF646464},
"Button.Image::ClearSearch": {
"image_url": f"{icons_path}/close.svg",
"color": 0xFF646464,
},
"Button.Image::ClearSearch:hovered": {
"image_url": f"{icons_path}/close.svg",
"color": 0xFF929292,
},
"Button.Image::ClearSearch:pressed": {
"image_url": f"{icons_path}/close.svg",
"color": 0xFFC4C4C4,
},
"Button::ClearSearch": {
"margin": 0,
"border_radius": 0,
"border_width": 0,
"padding": 3,
"background_color": 0x00000000,
},
"Button::ClearSearch:hovered": {
"background_color": 0x00000000,
},
"Button::ClearSearch:pressed": {
"background_color": 0x00000000,
},
},
"MarkdownText": {
"Label": {"font_size": 16, "color": 0xFFCCCCCC},
"Label::text": {"font_size": 16, "color": 0xFFCCCCCC},
"Label::H1": {"font_size": 32, "color": 0xFFCCCCCC},
"Label::H2": {"font_size": 28, "color": 0xFFCCCCCC},
"Label::H3": {"font_size": 24, "color": 0xFFCCCCCC},
"Label::H4": {"font_size": 20, "color": 0xFFCCCCCC},
},
"ExtsWindow": {
"ExtensionDescription.Button": {"background_color": 0xFF090969},
"ExtensionDescription.Title": {"font_size": 18, "color": 0xFFCCCCCC, "margin": 5},
"ExtensionDescription.Header": {"font_size": 20, "color": 0xFF409656},
"ExtensionDescription.Content": {"font_size": 16, "color": 0xFFCCCCCC, "margin": 5},
"ExtensionDescription.ContentError": {"font_size": 16, "color": 0xFF4056C6, "margin": 5},
"ExtensionDescription.ContentValue": {"font_size": 16, "color": 0xFF409656},
"ExtensionDescription.ContentLink": {"font_size": 16, "color": 0xFF82C994},
"ExtensionDescription.ContentLink:hovered": {"color": 0xFFB8E0C2},
"ExtensionList.Label::Description": {"font_size": 16},
"ExtensionList.Label::Name": {"font_size": 12},
"ExtensionDescription.Background": {"background_color": 0xFF363636, "border_radius": 4},
"ExtensionDescription.ContentBackground": {"background_color": 0xFF23211F},
"ExtensionList.Background": {
"background_color": 0xFF212121,
"border_radius": 0,
"corner_flag": ui.CornerFlag.BOTTOM,
},
"Rectangle::ExtensionListGroup": {
"background_color": 0xFF303030,
},
"Rectangle::ExtensionListGroup:hovered": {
"background_color": 0xFF404040,
},
"Rectangle::ExtensionListGroup:pressed": {
"background_color": 0xFF303030,
},
"ExtensionList.Group.Label": {"font_size": 16, "color": 0xFFC0C0C0},
"ExtensionList.Group.Icon::expanded": {"image_url": f"{icons_path}/expanded.svg"},
"ExtensionList.Group.Icon": {"image_url": f"{icons_path}/collapsed.svg"},
"ExtensionList.Separator": {"background_color": 0xFF000000},
# "ExtensionList.Background:hovered": {"background_color": 0xFF191919},
"ExtensionList.Background:selected": {"background_color": 0xFF8A8777},
"ExtensionList.Foreground": {
"background_color": 0xFF2F2F2F,
"border_width": 0,
"border_radius": 0,
"corner_flag": ui.CornerFlag.BOTTOM_RIGHT,
},
"ExtensionList.Foreground:selected": {"background_color": 0xFF9F9B8A},
"ExtensionList.Label": {"font_size": 16, "color": 0xFF878787},
"ExtensionList.Label:selected": {"color": 0xFF212121},
"ExtensionList.Label::Title": {"font_size": 20, "margin_width": 10},
"ExtensionList.Label::Title:selected": {"color": 0xFFE0E0E0},
"ExtensionList.Label::Category": {"font_size": 16, "margin_width": 10},
"ExtensionList.Label::Id": {"font_size": 16, "margin_width": 10},
"ExtensionList.Label::Version": {"font_size": 16, "margin_width": 10, "margin_height": 5},
"TreeView": {
"background_color": 0xFF23211F,
"background_selected_color": 0xFF23211F,
"secondary_color": 0xFF989898, # Scroll knob
"alignment": ui.Alignment.RIGHT,
},
"TreeView.ScrollingFrame": {"background_color": 0xFF4A4A4A},
"ComboBox": {
"background_color": 0xFF212121,
"border_radius": 0,
"font_size": 16,
"margin": 0,
"color": 0xFF929292,
"padding": 0,
},
"ComboBox:hovered": {"background_color": 0xFF2F2F2F},
"ComboBox:selected": {"background_color": 0xFF2F2F2F},
"ExtensionDescription.Label": {"color": 0xFFC4C4C4, "margin": 2, "font_size": 16},
"ExtensionDescription.Id::Name": {"background_color": 0xFF000000, "color": 0xFFC4C4C4, "font_size": 14},
"ExtensionDescription.Rectangle::Name": {"background_color": 0xFF24211F, "border_radius": 2},
"ExtensionDescription.UpdateButton": {"background_color": 0xFF00B976, "border_radius": 4},
"ExtensionDescription.UpdateButton.Label": {"color": 0xFF3E3E3E, "font_size": 18},
"ExtensionDescription.RestartButton": {"background_color": 0xFF00B976, "border_radius": 4},
"ExtensionDescription.RestartButton.Label": {"color": 0xFF3E3E3E, "font_size": 18},
"ExtensionDescription.UpToDateButton": {"background_color": 0xFF747474, "border_radius": 4},
"ExtensionDescription.UpToDateButton.Label": {"color": 0xFF3E3E3E, "font_size": 18},
"ExtensionDescription.InstallButton": {"background_color": 0xFF00B976, "border_radius": 4},
"ExtensionDescription.InstallButton.Label": {"color": 0xFF3E3E3E, "font_size": 18},
"ExtensionDescription.DownloadingButton": {"background_color": 0xFF00754A, "border_radius": 4},
"ExtensionDescription.DownloadingButton.Label": {"color": 0xFF3E3E3E, "font_size": 18},
"ExtensionDescription.CommunityRectangle": {"background_color": 0xFF1F1F1F, "border_radius": 2},
"ExtensionDescription.CommunityImage": {
"image_url": f"{icons_path}/community.svg",
"color": cl(180, 180, 180),
},
"ExtensionDescription.CommunityLabel": {"color": 0xFFA4A4A4, "font_size": 16},
"ExtensionDescription.UnverifiedRectangle": {"background_color": 0xFF000038, "border_radius": 2},
"ExtensionDescription.UnverifiedLabel": {"color": 0xFFC4C4C4, "margin_width": 30, "font_size": 16},
"Button::create": {"background_color": 0x0, "margin": 0},
"Button.Image::create": {"image_url": f"{icons_path}/plus.svg", "color": 0xFF00B976},
"Button.Image::create:hovered": {"color": 0xFF00D976},
"Button::options": {"background_color": 0x0, "margin": 0},
"Button.Image::options": {"image_url": f"{icons_path}/options.svg", "color": 0xFF989898},
"Button.Image::options:hovered": {"color": 0xFFC2C2C2},
"Button::filter": {"background_color": 0x0, "margin": 0},
"Button.Image::filter": {"image_url": f"{icons_path}/filter_grey.svg", "color": 0xFF989898},
"Button.Image::filter:hovered": {"color": 0xFFC2C2C2},
"Button::filter_on": {"background_color": 0x0, "margin": 0},
"Button.Image::filter_on": {"image_url": f"{icons_path}/filter.svg", "color": 0xFF989898},
"Button.Image::filter_on:hovered": {"color": 0xFFC2C2C2},
"Button::sortby": {"background_color": 0x0, "margin": 0},
"Button.Image::sortby": {"image_url": f"{icons_path}/sort_by_grey.svg", "color": 0xFF989898},
"Button.Image::sortby:hovered": {"color": 0xFFC2C2C2},
"Button::sortby_on": {"background_color": 0x0, "margin": 0},
"Button.Image::sortby_on": {"image_url": f"{icons_path}/sort_by.svg", "color": 0xFF989898},
"Button.Image::sortby_on:hovered": {"color": 0xFFC2C2C2},
"ExtensionDescription.Tab": {"background_color": 0x0},
"ExtensionDescription.Tab.Label": {"color": 0xFF8D8D8D, "font_size": 16},
"ExtensionDescription.Tab.Label:pressed": {"color": 0xFFF3F2EC},
"ExtensionDescription.Tab.Label:selected": {"color": 0xFFF3F2EC},
"ExtensionDescription.Tab.Label:hovered": {"color": 0xFFADADAD},
"ExtensionDescription.TabLine": {"color": 0xFF00B976, "border_width": 1},
"ExtensionDescription.TabLineFull": {"color": 0xFF707070},
"ExtensionVersionMenu.MenuItem": {"color": 0x0, "margin": 0},
"IconButton": {"margin": 0, "padding": 0, "background_color": 0x0},
"IconButton:hovered": {"background_color": 0x0},
"IconButton:checked": {"background_color": 0x0},
"IconButton:pressed": {"background_color": 0x0},
"IconButton.Image": {"color": 0xFFA8A8A8},
"IconButton.Image:hovered": {"color": 0xFF929292},
"IconButton.Image:pressed": {"color": 0xFFA4A4A4},
"IconButton.Image:checked": {"color": 0xFFFFFFFF},
"IconButton.Image::OpenDoc": {"image_url": f"{icons_path}/question.svg"},
"IconButton.Image::OpenFolder": {"image_url": f"{icons_path}/open-folder.svg"},
"IconButton.Image::OpenConfig": {"image_url": f"{icons_path}/open-config.svg"},
"IconButton.Image::OpenInVSCode": {"image_url": f"{icons_path}/vscode.svg"},
"IconButton.Image::Export": {"image_url": f"{icons_path}/export.svg"},
"Image::UpdateAvailable": {
"image_url": f"{icons_path}/update-available.svg",
"color": 0xFFFFFFFF,
"spacing": 50,
},
"Label::UpdateAvailable": {"color": 0xFF00B977, "margin": 10},
"Label::LocationTag": {"color": 0xFF00B977, "margin": 10, "font_size": 16},
"Image::Community": {"image_url": f"{icons_path}/community.svg", "color": cl(255, 255, 255)},
"Image::Community:selected": {"color": cl("#ddefff")},
"Label::Community": {"color": 0xFFA4A4A4, "margin": 10, "font_size": 16},
"Rectangle::Splitter": {"background_color": 0x0, "margin": 3, "border_radius": 2},
"Rectangle::Splitter:hovered": {"background_color": 0xFFB0703B},
"Rectangle::Splitter:pressed": {"background_color": 0xFFB0703B},
"Image::UNKNOWN": {"color": 0xFFFFFFFF, "image_url": f"{icons_path}/question.svg"},
"Image::RUNNING": {"color": 0xFFFF7D7D, "image_url": f"{icons_path}/spinner.svg"},
"Image::PASSED": {"color": 0xFF00FF00, "image_url": f"{icons_path}/check_solid.svg"},
"Image::FAILED": {"color": 0xFF0000FF, "image_url": f"{icons_path}/exclamation.svg"},
},
"ExtsPropertiesWidget": {
"Properies.Background": {"background_color": 0xFF24211F, "border_radius": 4},
},
"ExtsRegistriesWidget": {
"TreeView": {
"background_color": 0xFF23211F,
"background_selected_color": 0xFF444444,
},
"TreeView.Item": {"margin": 14, "color": 0xFF000055},
"Field": {"background_color": 0xFF333322},
"Label::header": {"margin": 4},
"Label": {"margin": 5},
"Label::builtin": {"color": 0xFF909090},
"Label::config": {"color": 0xFFDDDDDD},
"ItemButton": {"padding": 2, "background_color": 0xFF444444, "border_radius": 4},
"ItemButton.Image::add": {"image_url": f"{icons_path}/plus.svg", "color": 0xFF06C66B},
"ItemButton.Image::remove": {"image_url": f"{icons_path}/trash.svg", "color": 0xFF1010C6},
"ItemButton:hovered": {"background_color": 0xFF333333},
"ItemButton:pressed": {"background_color": 0xFF222222},
},
"ExtsPathsWidget": {
"TreeView": {
"background_color": 0xFF23211F,
"background_selected_color": 0xFF444444,
},
"TreeView.Item": {"margin": 14, "color": 0xFF000055},
"Field": {"background_color": 0xFF333322},
"Label::header": {"margin": 4},
"Label": {"margin": 5},
"Label::builtin": {"color": 0xFF909090},
"Label::config": {"color": 0xFFDDDDDD},
"ItemButton": {"padding": 2, "background_color": 0xFF444444, "border_radius": 4},
"ItemButton.Image::add": {"image_url": f"{icons_path}/plus.svg", "color": 0xFF06C66B},
"ItemButton.Image::remove": {"image_url": f"{icons_path}/trash.svg", "color": 0xFF1010C6},
"ItemButton.Image::clean": {"image_url": f"{icons_path}/broom.svg", "color": 0xFF5EDAFA},
"ItemButton.Image::update": {"image_url": f"{icons_path}/refresh.svg", "color": 0xFF5EDAFA},
"ItemButton:hovered": {"background_color": 0xFF333333},
"ItemButton:pressed": {"background_color": 0xFF222222},
},
}
return styles
def get_style(instance):
return get_styles()[instance.__class__.__name__]
| 17,286 | Python | 57.402027 | 116 | 0.571272 |
omniverse-code/kit/exts/omni.kit.window.extensions/omni/kit/window/extensions/ext_test_tab.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.settings
import omni.kit.app
import omni.ui as ui
from omni.kit.test import TestRunStatus
from .ext_components import SimpleCheckBox
DEFAULT_TEST_APP = "${kit}/apps/omni.app.test_ext.kit"
class ExtTestTab:
def __init__(self):
self.test_status = {}
# options
self.info_log = False
self.wait_for_debugger = False
self.python_debugger = False
self.wait_for_python_debugger = False
self.ui_mode = False
self.do_not_exit = False
self.coverage = False
self.tests_filter = ""
self._test_filter_model = None
self._app_combo = None
self.apps = [f"{DEFAULT_TEST_APP} (empty)"]
manager = omni.kit.app.get_app_interface().get_extension_manager()
all_exts = [(manager.get_extension_dict(e["id"]), e["id"]) for e in manager.get_extensions()]
self.apps += [ext_id for d, ext_id in all_exts if d.get("isKitFile", False)]
def destroy(self):
pass
def build_cb(self, attr, name):
SimpleCheckBox(
getattr(self, attr),
lambda v: setattr(self, attr, not getattr(self, attr)),
name,
)
def _update_test_args(self):
args = []
if self.info_log:
args += ["-v"]
if self.wait_for_debugger:
args += ["-d"]
if self.wait_for_python_debugger:
self.python_debugger = True
args += ["--/exts/omni.kit.debug.python/break=1"]
if self.python_debugger:
args += ["--enable", "omni.kit.debug.python"]
if self.do_not_exit:
args += ["--/exts/omni.kit.test/doNotQuit=1"]
self.tests_filter = self._test_filter_model.as_string
args += [f"--/exts/omni.kit.test/runTestsFilter='{self.tests_filter}'"]
settings = carb.settings.get_settings()
selected_app = self._app_combo.model.get_item_value_model().as_int
app = self.apps[selected_app] if selected_app > 0 else DEFAULT_TEST_APP
settings.set("/exts/omni.kit.test/testExtApp", app)
settings.set("/exts/omni.kit.test/testExtArgs", args)
settings.set("/exts/omni.kit.test/testExtUIMode", self.ui_mode)
settings.set("/exts/omni.kit.test/testExtGenerateCoverageReport", self.coverage)
settings.set("/exts/omni.kit.test/testExtCleanOutputPath", self.coverage)
# todo offer a way to pick reliable/unreliable/both
# settings.set("/exts/omni.kit.test/testExtRunUnreliableTests", 2)
def build(self, ext_info):
ext_id = ext_info.get("package").get("id")
with ui.VStack(height=0):
ui.Spacer(height=20)
ui.Label("Options:", height=0, width=50, style_type_name_override="ExtensionDescription.Label")
ui.Spacer(height=10)
self.build_cb("info_log", "info log")
self.build_cb("ui_mode", "ui mode (test selection)")
self.build_cb("coverage", "generate coverage report")
self.build_cb("wait_for_debugger", "wait for native debugger")
self.build_cb("python_debugger", "enable python debugger")
self.build_cb("wait_for_python_debugger", "enable python debugger and wait")
self.build_cb("do_not_exit", "do not exit after tests")
ui.Spacer(height=10)
with ui.HStack():
ui.Spacer(width=10)
ui.Label(
"filter (e.g.: *test_usd*):",
height=0,
width=50,
style_type_name_override="ExtensionDescription.Label",
)
self._test_filter_model = ui.StringField(width=250).model
self._test_filter_model.as_string = self.tests_filter
ui.Spacer(height=20)
with ui.HStack():
ui.Spacer(width=10)
ui.Label("app:", height=0, width=50, style_type_name_override="ExtensionDescription.Label")
self._app_combo = ui.ComboBox(0, *self.apps, style={"padding": 4}, width=400)
ui.Spacer(height=20)
with ui.HStack():
status_image = None
def _refresh_test_status():
status = self.test_status.get(ext_id, TestRunStatus.UNKNOWN)
status_image.name = str(status.name)
def on_status(test_id, status, **_):
self.test_status[ext_id] = status
_refresh_test_status()
def on_finish(status, *_):
if self.coverage:
omni.kit.test.generate_report()
def on_click(ext_id=ext_id):
self._update_test_args()
omni.kit.test.run_ext_tests([ext_id], on_finish, on_status)
ui.Button(
"RUN EXTENSION TESTS",
style_type_name_override="ExtensionDescription.InstallButton",
width=80,
height=20,
clicked_fn=on_click,
)
ui.Spacer(width=20)
ui.Label("Result:", width=0, style_type_name_override="ExtensionDescription.Label")
status_image = ui.Image(
name="TestStatus",
width=20,
height=20,
alignment=ui.Alignment.RIGHT_CENTER,
)
_refresh_test_status()
| 5,923 | Python | 36.025 | 107 | 0.564072 |
omniverse-code/kit/exts/omni.kit.window.extensions/omni/kit/window/extensions/ext_info_widget.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.
#
# pylint: disable=protected-access, access-member-before-definition
import abc
import asyncio
import contextlib
import os
import weakref
from datetime import datetime, timezone
from typing import Callable
import omni.kit.app
import omni.kit.commands
import omni.kit.test
import omni.ui as ui
from . import ext_controller
from .common import (
ExtAuthorGroup,
ExtensionCommonInfo,
build_ext_info,
check_can_be_toggled,
get_categories,
get_options,
pull_extension_async,
toggle_extension,
)
from .ext_components import ExtensionToggle, SimpleCheckBox, add_doc_link_button
from .ext_data_fetcher import get_ext_data_fetcher
from .ext_export_import import export_ext
from .ext_test_tab import ExtTestTab
from .exts_graph_window import ExtsGraphWidget
from .markdown_renderer import MarkdownText
from .styles import CATEGORY_ICON_SIZE, EXT_ICON_SIZE_LARGE
from .utils import clip_text, is_vscode_installed, open_in_vscode_if_enabled, version_to_str
ICON_ZONE_WIDTH = 120
CATEGORY_ZONE_WIDTH = 120
def get_ext_text_content(key: str, ext_info, ext_item: ExtensionCommonInfo):
"""Get extension readme/changelog from either local dict or registry extra data"""
content_str = ""
# Get the data
if ext_item.is_local:
content_str = ext_info.get("package", {}).get(key, "")
else:
fetcher = get_ext_data_fetcher()
ext_data = fetcher.get_ext_data(ext_item.package_id)
if ext_data:
content_str = ext_data.get("package", {}).get(key, "")
# Figure out if it is a path to a file or actual data
if content_str and "\n" not in content_str:
ext_path = ext_info.get("path", "")
# If it is a path -> load file content
readme_file = os.path.join(ext_path, content_str)
if os.path.exists(readme_file):
with open(readme_file, "r", encoding="utf-8") as f:
content_str = f.read()
return content_str
class PageBase:
"""
Interface for any classes adding Tabs to the Extension Manager UI
"""
@abc.abstractmethod
def build_tab(self, ext_info: dict, ext_item: ExtensionCommonInfo) -> None:
"""Build the Tab."""
@abc.abstractmethod
def destroy(self) -> None:
"""Teardown the Tab."""
@staticmethod
@abc.abstractmethod
def get_tab_name() -> str:
"""Get the name used for the tab name in the UI"""
def build_package_info(ext_info):
if ext_info is None:
return
package_dict = ext_info.get("package", {})
publish_dict = package_dict.get("publish", {})
def add_info(name, value):
if not value:
return
if isinstance(value, (tuple, list)):
value = ", ".join(value)
if isinstance(value, dict):
value = str(value)
with ui.HStack():
ui.Label(name, width=100, style_type_name_override="ExtensionDescription.Content")
if value.startswith("http://") or value.startswith("https://"):
def open_link():
import webbrowser
webbrowser.open(value)
ui.Label(
value,
style_type_name_override="ExtensionDescription.ContentLink",
mouse_pressed_fn=lambda x, y, b, a: b == 0 and open_link(),
)
else:
ui.Label(value, style_type_name_override="ExtensionDescription.ContentValue")
def add_package_info(name, key):
add_info(name, package_dict.get(key, None))
# Package info
add_package_info("Authors", "authors")
add_package_info("Keywords", "keywords")
add_info("Repo Name", publish_dict.get("repoName", None))
add_package_info("Repo Url", "repository")
add_package_info("Github Release", "githubRelease")
# Publish info
ts = publish_dict.get("date", None)
if not ts:
ts = package_dict.get("publishDate", None) # backward compatibility for deprecated key
if ts:
add_info("Publish Date", str(datetime.fromtimestamp(ts, tz=timezone.utc).astimezone()))
add_info("Build Number", publish_dict.get("buildNumber", None))
add_info("Kit Version", publish_dict.get("kitVersion", None))
add_package_info("Target", "target")
# Test info
test = ext_info.get("test", None)
if isinstance(test, (list, tuple)):
for t in test:
add_info("Test Waiver", t.get("waiver", None))
class OverviewPage(PageBase):
"""
Build a class with same interface and add it to ExtInfoWidget.pages
below to have it show up as a tab
"""
def build_tab(self, ext_info, ext_item: ExtensionCommonInfo):
def content_label(text):
ui.Label(text, style_type_name_override="ExtensionDescription.Content")
readme_str = get_ext_text_content("readme", ext_info, ext_item)
with ui.ScrollingFrame(
horizontal_scrollbar_policy=ui.ScrollBarPolicy.SCROLLBAR_AS_NEEDED,
vertical_scrollbar_policy=ui.ScrollBarPolicy.SCROLLBAR_ALWAYS_ON,
):
with ui.ZStack():
ui.Rectangle(style_type_name_override="ExtensionDescription.ContentBackground")
with ui.HStack():
ui.Spacer(width=10)
with ui.VStack(height=0):
ui.Spacer(height=10)
# All the meta info about the package (version, date, authors)
build_package_info(ext_info)
ui.Spacer(height=15)
# Readme
MarkdownText(readme_str)
# Preview ?
if ext_item.preview_image_path:
ui.Image(
ext_item.preview_image_path,
alignment=ui.Alignment.H_CENTER,
fill_policy=ui.FillPolicy.PRESERVE_ASPECT_FIT,
width=700,
height=700,
)
else:
content_label("Preview: 'package/preview_image' is not specified.")
def destroy(self):
pass
@staticmethod
def get_tab_name():
return "OVERVIEW"
class ChangelogPage(PageBase):
def build_tab(self, ext_info, ext_item: ExtensionCommonInfo):
changelog_str = get_ext_text_content("changelog", ext_info, ext_item)
if not changelog_str:
changelog_str = "[no changelog]"
# word_wrap is important here because changelog can
# be Markdown, and if word_wrap is defalut, Label
# ignores everything after double hash. word_wrap fixes it.
with ui.ScrollingFrame(
horizontal_scrollbar_policy=ui.ScrollBarPolicy.SCROLLBAR_ALWAYS_OFF,
vertical_scrollbar_policy=ui.ScrollBarPolicy.SCROLLBAR_ALWAYS_ON,
):
with ui.ZStack():
ui.Rectangle(style_type_name_override="ExtensionDescription.ContentBackground")
with ui.HStack():
ui.Spacer(width=10)
with ui.VStack(height=0):
ui.Spacer(height=10)
MarkdownText(changelog_str)
def destroy(self):
pass
@staticmethod
def get_tab_name():
return "CHANGELOG"
class DependenciesPage(PageBase):
def __init__(self):
self._ext_graph = None
def build_tab(self, ext_info, ext_item: ExtensionCommonInfo):
# Graph available if extension is enabled:
if ext_info.get("state", {}).get("enabled", False):
self._ext_graph = ExtsGraphWidget(ext_info.get("package").get("id"))
else:
with ui.VStack(height=0):
manager = omni.kit.app.get_app().get_extension_manager()
# Enable result
result, exts, err = manager.solve_extensions([ext_item.id], add_enabled=True, return_only_disabled=True)
if not result:
ui.Label(
"Enabling this extension will fail with the following error:",
style_type_name_override="ExtensionDescription.Header",
)
ui.Label(err, style_type_name_override="ExtensionDescription.ContentError")
else:
ui.Label(
"Enabling this extension will enable the following extensions in order:",
style_type_name_override="ExtensionDescription.Header",
)
ui.Label(
"".join(f"\n - {ext['id']}" for ext in exts),
style_type_name_override="ExtensionDescription.Content",
)
ui.Spacer(height=30)
# Dependencies
ui.Label("Dependencies (in config):", style_type_name_override="ExtensionDescription.Header")
ui.Spacer(height=4)
for k, v in ext_info.get("dependencies", {}).items():
label_text = f"{k}"
tag = v.get("tag", None)
if tag:
label_text += f"-{tag}"
version = v.get("version", "*.*.*")
if version:
label_text += f" | v{version}"
optional = v.get("optional", False)
if optional:
label_text += "(optional)"
ui.Label(label_text, style_type_name_override="ExtensionDescription.Content")
def destroy(self):
pass
@staticmethod
def get_tab_name():
return "DEPENDENCIES"
class PackagesPage(PageBase):
def build_tab(self, ext_info, ext_item: ExtensionCommonInfo):
manager = omni.kit.app.get_app().get_extension_manager()
package_info = ext_info.get("package")
packages = manager.fetch_extension_packages(package_info.get("id"))
with ui.VStack(height=0):
ui.Label(
"All available packages for version {} :".format(package_info["version"]),
style_type_name_override="ExtensionDescription.Title",
)
for p in packages:
package_id = p["package_id"]
with ui.CollapsableFrame(package_id, collapsed=True):
with ui.HStack():
ui.Spacer(width=20)
with ui.VStack():
build_package_info(manager.get_registry_extension_dict(package_id))
def destroy(self):
pass
@staticmethod
def get_tab_name():
return "PACKAGES"
class ExtTestPage(PageBase):
def __init__(self):
self.tab = ExtTestTab()
def build_tab(self, ext_info, ext_item: ExtensionCommonInfo):
self.tab.build(ext_info)
def destroy(self):
self.tab.destroy()
@staticmethod
def get_tab_name():
return "TESTS"
class ExtInfoWidget:
pages = [OverviewPage, ChangelogPage, DependenciesPage, PackagesPage, ExtTestPage]
current_page = 0
def __init__(self):
# Widgets for tabs
self.__tabs = []
self.__pages = []
# Put into frame to enable rebuilding of UI
self._frame = ui.Frame()
self._ext_manager = omni.kit.app.get_app().get_extension_manager()
self._ext_change_sub = self._ext_manager.get_change_event_stream().create_subscription_to_pop(
lambda *_: self._refresh_once_next_frame(), name="ExtInfoWidget"
)
self._ext_graph = None
self._version_menu = None
self._selected_version = None
self._selected_package_id = None
# Refresh when new ext data fetched
fetcher = get_ext_data_fetcher()
def on_data_fetched(package_id):
if self._selected_package_id == package_id:
self._refresh_once_next_frame()
fetcher.on_data_fetched_fn = on_data_fetched
self.select_ext(None)
self.page_tabs = []
self.update_tabs()
self.set_show_graph_fn(None)
def update_tabs(self):
self.page_tabs = []
for page in self.pages:
self.page_tabs.append(page())
def set_visible(self, visible):
self._frame.visible = visible
def select_ext(self, ext_summary):
"""Select extension to display info about. Can be None"""
self._ext_summary = ext_summary
self._selected_version = None
self._selected_package_id = None
self._refresh_once_next_frame()
def _refresh(self):
# Fetch all extensions for currently selected extension summary
extensions = (
self._ext_manager.fetch_extension_versions(self._ext_summary.fullname)
if self._ext_summary is not None
else []
)
def _draw_empty_page():
with self._frame:
ui.Label("Select an extension")
if len(extensions) == 0:
_draw_empty_page()
return
# If user hasn't yet changed the version to display summary advices which should be shown by default:
if self._selected_version is None:
self._selected_version = self._ext_summary.default_ext["version"]
# Now actual extension is selected (including version). Get all the info for it
selected_index = next(
(i for i, v in enumerate(extensions) if v["version"][:4] == self._selected_version[:4]), None
)
# If selected version is not available, select latest. That can happen if latest published is incompatible with
# current target. In summaries it will show later version than the one you can select by default.
if self._selected_version is not None and selected_index is None:
selected_index = 0
self._selected_version = extensions[selected_index]["version"]
if selected_index is None:
_draw_empty_page()
return
selected_ext = extensions[selected_index]
is_version_latest = selected_index == 0
ext_id = selected_ext["id"]
package_id = selected_ext["package_id"]
self._selected_package_id = package_id
# If this extension is enabled or other version of this extension is enabled:
any_version_enabled = any(ext["enabled"] for ext in extensions)
ext_item, ext_info = build_ext_info(ext_id, package_id) # -> Tuple[ExtensionCommonInfo, dict]:
# Get ext info either from local or remote index
if not ext_info:
_draw_empty_page()
return
# Gather more info by solving dependencies. When other version of this extension is already enabled solving is
# known to fail because of conflict. It will always display a red icon then.
# When we actually toggle it we will first turn off that version. So for that case do not solve extensions.
# An alternative solution might be to manually build a list of all enabled extensions, but exclude current one.
if not any_version_enabled:
ext_item.solve_extensions()
if not ext_item.is_local:
fetcher = get_ext_data_fetcher()
fetcher.fetch(ext_item)
ext_path = ext_info.get("path", "")
package_dict = ext_info.get("package", {})
docs_dict = ext_info.get("documentation", {})
if ext_item.is_local:
# For local extensions add version to ext_id to make it more concrete (for later enabling etc.)
name = package_dict.get("name")
version = package_dict.get("version", None)
ext_id = name + "-" + version if version else name
name = package_dict.get("name", "")
enabled = ext_item.enabled
category = get_categories().get(ext_item.category)
################################################################################################################
# Build version selector menu
def select_version(version):
self._selected_version = version
self._refresh_once_next_frame()
self._version_menu = ui.Menu("Version")
with self._version_menu:
ui.MenuItem("Version(s)", enabled=False)
ui.Separator()
for i, e in enumerate(extensions):
version = e["version"]
version_str = version_to_str(version[:4])
color = 0xFF76B900 if selected_index == i else 0xFFC0C0C0
ui.MenuItem(
version_str,
checked=selected_index == i,
checkable=True,
style={"color": color, "margin": 0},
triggered_fn=lambda v=version: select_version(v),
)
# Publish / Unpublish buttons
if get_options().publishing:
ui.Separator()
ui.MenuItem("Publishing", enabled=False)
ui.Separator()
if ext_item.is_local:
ui.MenuItem(
"PUBLISH", triggered_fn=lambda ext_id=ext_id: self._ext_manager.publish_extension(ext_id)
)
else:
ui.MenuItem(
"UNPUBLISH", triggered_fn=lambda ext_id=ext_id: self._ext_manager.unpublish_extension(ext_id)
)
# Uninstall
can_be_uninstalled = not ext_item.enabled and ext_item.location_tag == "INSTALLED"
if can_be_uninstalled:
ui.Separator()
ui.MenuItem(
"UNINSTALL", triggered_fn=lambda ext_id=ext_id: self._ext_manager.uninstall_extension(ext_id)
)
################################################################################################################
################################################################################################################
def draw_icon_block():
# Icon
with ui.HStack(width=ICON_ZONE_WIDTH):
ui.Spacer()
with ui.VStack(width=EXT_ICON_SIZE_LARGE[0]):
ui.Spacer()
ui.Image(ext_item.icon_path, height=EXT_ICON_SIZE_LARGE[1], style={"color": 0xFFFFFFFF})
ui.Spacer()
ui.Spacer()
################################################################################################################
def draw_top_row_block():
with ui.HStack():
# Big button
if not ext_item.is_local:
if ext_info.get("state", {}).get("isPulled", False):
ui.Button(
"INSTALLING...",
style_type_name_override="ExtensionDescription.DownloadingButton",
width=100,
height=30,
)
else:
def on_click(item=ext_item):
asyncio.ensure_future(pull_extension_async(item, self._refresh_once_next_frame))
ui.Button(
"INSTALL",
style_type_name_override="ExtensionDescription.InstallButton",
width=100,
height=30,
clicked_fn=on_click,
)
else:
can_update = not is_version_latest
is_autoload_enabled = ext_controller.is_autoload_enabled(ext_item.id)
if not ext_item.enabled and ext_item.is_toggle_blocked and is_autoload_enabled:
def on_click():
omni.kit.app.get_app().restart()
ui.Button(
"RESTART APP",
style_type_name_override="ExtensionDescription.RestartButton",
clicked_fn=on_click,
width=100,
height=30,
)
elif can_update:
def on_click(ext_id=ext_id, switch_off_on=(enabled and not ext_item.is_toggle_blocked)):
latest_ext = extensions[0]
latest_ext_id = latest_ext["id"]
latest_ext_version = latest_ext["version"]
# If autoload for that one is enabled, move it to latest:
if ext_controller.is_autoload_enabled(ext_id):
ext_controller.toggle_autoload(ext_id, False)
if check_can_be_toggled(latest_ext_id, for_autoload=True):
ext_controller.toggle_autoload(latest_ext_id, True)
# If extension is enabled, switch off to latest:
if switch_off_on:
toggle_extension(ext_id, False)
toggle_extension(latest_ext_id, True)
# Finally switch UI to show newest version
select_version(latest_ext_version)
ui.Button(
"UPDATE",
style_type_name_override="ExtensionDescription.UpdateButton",
clicked_fn=on_click,
width=100,
height=30,
)
else:
ui.Button(
"UP TO DATE",
style_type_name_override="ExtensionDescription.UpToDateButton",
width=100,
height=30,
)
# Version selector
with ui.VStack(width=0):
ui.Spacer()
ui.Button(name="options", width=40, height=22, clicked_fn=self._version_menu.show)
ui.Spacer()
# Toggle
ui.Spacer(width=15)
ExtensionToggle(ext_item, with_label=True, show_install_button=False)
# Autoload toggle
with ui.HStack():
ui.Spacer(width=20)
def toggle_autoload(value, ext_id=ext_id):
if check_can_be_toggled(ext_id, for_autoload=True):
ext_controller.toggle_autoload(ext_id, value)
self._refresh_once_next_frame()
SimpleCheckBox(
ext_controller.is_autoload_enabled(ext_id), toggle_autoload, "AUTOLOAD", enabled=True
)
ui.Spacer(width=20)
def add_icon_button(name, on_click, tooltip=None):
with ui.VStack(width=0):
ui.Spacer()
# cannot get style tooltip override to work, so force it here
b = ui.Button(
name=name,
style_type_name_override="IconButton",
width=23,
height=18,
clicked_fn=on_click,
style={"Label": {"color": 0xFF444444}},
)
if tooltip:
b.set_tooltip_fn(lambda *_: ui.Label(tooltip))
ui.Spacer()
return b
def add_open_button(url, name, prefer_vscode=False, tooltip=None):
def on_click(url=url):
open_in_vscode_if_enabled(url, prefer_vscode)
b = add_icon_button(name, on_click)
if not tooltip:
tooltip = url
b.set_tooltip_fn(lambda *_: ui.Label(tooltip))
# Doc button
add_doc_link_button(ext_item, package_dict, docs_dict)
ui.Spacer(width=8)
if ext_item.is_local:
# Extension "open folder" button
ext_folder = os.path.dirname(ext_path) if os.path.isfile(ext_path) else ext_path
add_open_button(ext_folder, name="OpenFolder")
ui.Spacer(width=8)
# Extension "open folder" button
if is_vscode_installed():
add_open_button(ext_folder, name="OpenInVSCode", prefer_vscode=True, tooltip="Open in VSCode")
ui.Spacer(width=8)
# Extension "open config" button
add_open_button(ext_info.get("configPath", ""), name="OpenConfig", prefer_vscode=True)
ui.Spacer(width=8)
# Extension export button
def on_export(ext_id=ext_id):
export_ext(ext_id)
add_icon_button("Export", on_export, tooltip=f"Export {ext_info['package']['packageId']}")
################################################################################################################
def draw_extension_name_block():
with ui.HStack():
# Extension id
ui.Label(
ext_item.title,
height=0,
width=0,
style_type_name_override="ExtensionDescription.Label",
tooltip=ext_id,
)
ui.Spacer()
# Remove that separate rect block with ext_id?
# with ui.ZStack(height=0, width=0):
# ui.Rectangle(style_type_name_override="ExtensionDescription.Rectangle", name="Name")
# ui.Label(ext_id, style_type_name_override="ExtensionDescription.Id", name="Name")
################################################################################################################
def draw_extension_description_block():
with ui.HStack():
ui.Label(
clip_text(ext_item.description),
height=0,
width=50,
style_type_name_override="ExtensionDescription.Label",
)
################################################################################################################
def draw_extension_version_block():
with ui.HStack():
if ext_item.version:
ui.Label(
"v" + ext_item.version,
style_type_name_override="ExtensionDescription.Label",
width=0,
name="Version",
)
def add_separator():
ui.Spacer(width=10)
ui.Line(alignment=ui.Alignment.LEFT, style_type_name_override="ExtensionDescription.Label", width=0)
ui.Spacer(width=10)
add_separator()
# Repository/Local
text = f"Registry: {ext_item.provider_name}" if ext_item.provider_name else "Local"
ui.Label(text, style_type_name_override="ExtensionDescription.Label", width=0)
ui.Spacer()
################################################################################################################
def draw_category_block():
# Categoty Info and Icon
with ui.HStack(width=CATEGORY_ZONE_WIDTH):
ui.Spacer()
with ui.VStack(width=CATEGORY_ICON_SIZE[0]):
ui.Spacer()
ui.Image(category["image"], width=CATEGORY_ICON_SIZE[0], height=CATEGORY_ICON_SIZE[1])
ui.Spacer(height=10)
ui.Label(category["name"], alignment=ui.Alignment.CENTER)
ui.Spacer()
ui.Spacer()
def draw_ext_source_block():
with ui.HStack(height=0):
with ui.ZStack(height=32, width=0):
ui.Image(style_type_name_override="ExtensionDescription.CommunityImage", width=148, height=32)
with ui.HStack(width=0):
ui.Spacer(width=52)
name = ext_item.author_group.get_ui_name()
ui.Label(name, style_type_name_override="ExtensionDescription.CommunityLabel")
ui.Spacer(width=2)
if ext_item.is_untrusted:
with ui.ZStack(height=30):
with ui.VStack():
ui.Spacer(height=2)
ui.Rectangle(style_type_name_override="ExtensionDescription.UnverifiedRectangle")
ui.Label(
"UNVERIFIED",
alignment=ui.Alignment.RIGHT_CENTER,
style_type_name_override="ExtensionDescription.UnverifiedLabel",
)
def draw_content_block():
def set_page(index):
for i in self.__tabs:
i.selected = False
for i in self.__pages:
i.visible = False
self.__tabs[index].selected = True
self.__pages[index].visible = True
ExtInfoWidget.current_page = index
ui.Spacer(height=10)
with ui.HStack(height=20):
tab_buttons = []
for index, page in enumerate(self.page_tabs):
tab_btn = ui.Button(
page.get_tab_name(),
width=0,
style_type_name_override="ExtensionDescription.Tab",
clicked_fn=lambda i=index: set_page(i),
)
tab_buttons.append(tab_btn)
if index < len(self.page_tabs) - 1:
ui.Line(
style_type_name_override="ExtensionDescription.TabLine",
alignment=ui.Alignment.H_CENTER,
height=20,
width=40,
)
ui.Spacer()
self.__tabs[:] = tab_buttons
ui.Spacer(height=8)
with ui.ZStack():
pages = []
for page_tab in self.page_tabs:
page = ui.Frame(build_fn=lambda i=ext_info, e=ext_item, page_tab=page_tab: page_tab.build_tab(i, e))
pages.append(page)
self.__pages[:] = pages
set_page(ExtInfoWidget.current_page) # Default page
################################################################################################################
################################################################################################################
# Build Actual UI Layout of all blocks
with self._frame:
with ui.ZStack():
ui.Rectangle(style_type_name_override="ExtensionDescription.Background")
with ui.VStack(spacing=4):
# Top Margin
ui.Spacer(height=15)
with ui.HStack(height=0, spacing=5):
draw_icon_block()
with ui.VStack():
draw_top_row_block()
ui.Spacer(height=10)
draw_extension_name_block()
draw_extension_description_block()
ui.Spacer(height=10)
draw_extension_version_block()
draw_category_block()
#
ui.Spacer(height=4)
if ext_item.author_group != ExtAuthorGroup.NVIDIA:
draw_ext_source_block()
with ui.HStack():
ui.Spacer(width=10)
# Content page
with ui.VStack():
# Separator line
ui.Line(
height=0,
alignment=ui.Alignment.BOTTOM,
style_type_name_override="ExtensionDescription.TabLineFull",
)
draw_content_block()
ui.Spacer(width=10)
ui.Spacer(height=5)
def _refresh_once_next_frame(self):
async def _delayed_refresh(weak_widget):
await omni.kit.app.get_app().next_update_async()
w = weak_widget()
if w:
w._refresh_task = None
w._refresh()
with contextlib.suppress(Exception):
self._refresh_task.cancel()
self._refresh_task = asyncio.ensure_future(_delayed_refresh(weakref.ref(self)))
def set_show_graph_fn(self, fn: Callable):
self._show_graph_fn = fn
def _show_graph(self, ext_id):
if self._show_graph_fn:
self._show_graph_fn(ext_id)
def destroy(self):
self._ext_change_sub = None
if self._ext_graph:
self._ext_graph.destroy()
self._ext_graph = None
for page in self.page_tabs:
page.destroy()
# We want to None the instances also
self._version_menu = None
self.__tabs = []
self.__pages = []
| 34,417 | Python | 36.988962 | 120 | 0.498097 |
omniverse-code/kit/exts/omni.kit.window.extensions/omni/kit/window/extensions/ext_export_import.py | import asyncio
import os
import carb
import carb.tokens
import omni.kit.app
from .common import get_omni_documents_path
from .utils import get_setting
# Store last user choosen folder for convenience between sessions
RECENT_EXPORT_PATH_KEY = "/persistent/exts/omni.kit.window.extensions/recentExportPath"
def _print_and_log(message):
carb.log_info(message)
print(message)
async def _ask_user_for_path(is_export: bool, apply_button_label="Choose", title=None):
app = omni.kit.app.get_app()
manager = app.get_extension_manager()
if not manager.is_extension_enabled("omni.kit.window.filepicker"):
manager.set_extension_enabled("omni.kit.window.filepicker", True)
await app.next_update_async()
await app.next_update_async()
from omni.kit.widget.filebrowser import FileBrowserItem
from omni.kit.window.filepicker import FilePickerDialog
done = False
choosen_path = None
def on_click_cancel(f, d):
nonlocal done
done = True
if is_export:
def on_click_open(f, d):
nonlocal done, choosen_path
choosen_path = d
done = True
filepicker = FilePickerDialog(
title or "Choose Folder",
allow_multi_selection=False,
apply_button_label=apply_button_label,
click_apply_handler=on_click_open,
click_cancel_handler=on_click_cancel,
enable_filename_input=False,
)
else:
def on_click_open(f, d):
nonlocal done, choosen_path
choosen_path = os.path.join(d, f)
done = True
def on_filter_zip_files(item: FileBrowserItem) -> bool:
if not item or item.is_folder:
return True
return os.path.splitext(item.path)[1] == ".zip"
filepicker = FilePickerDialog(
title or "Choose Extension Zip Archive",
allow_multi_selection=False,
apply_button_label="Import",
click_apply_handler=on_click_open,
click_cancel_handler=on_click_cancel,
item_filter_options=[("*.zip", ".zip Archives (*.zip)")],
item_filter_fn=on_filter_zip_files,
)
recent_path = get_setting(RECENT_EXPORT_PATH_KEY, None)
if not recent_path:
recent_path = get_omni_documents_path()
filepicker.show(path=recent_path)
while not done:
await app.next_update_async()
filepicker.hide()
filepicker.destroy()
if choosen_path:
recent_path = os.path.dirname(choosen_path) if os.path.isfile(choosen_path) else choosen_path
carb.settings.get_settings().set(RECENT_EXPORT_PATH_KEY, recent_path)
return choosen_path
async def _export(ext_id: str):
output = await _ask_user_for_path(is_export=True, apply_button_label="Export")
if output:
app = omni.kit.app.get_app()
manager = app.get_extension_manager()
archive_path = manager.pack_extension(ext_id, output)
app.print_and_log(f"Extension: '{ext_id}' was exported to: '{archive_path}'")
async def _import():
archive_path = await _ask_user_for_path(is_export=False, apply_button_label="Import")
# Registry Local Cache Folder
registry_cache = get_setting("/app/extensions/registryCacheFull", None)
if not registry_cache:
carb.log_error("Can't import extension, registry cache path is not set.")
return
if archive_path:
omni.ext.unpack_extension(archive_path, registry_cache)
omni.kit.app.get_app().print_and_log(f"Extension: '{archive_path}' was imported to: '{registry_cache}'")
def export_ext(ext_id: str):
asyncio.ensure_future(_export(ext_id))
def import_ext():
asyncio.ensure_future(_import())
| 3,771 | Python | 29.176 | 112 | 0.641474 |
omniverse-code/kit/exts/omni.kit.window.extensions/omni/kit/window/extensions/exts_graph_window.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 os
from collections import defaultdict
from typing import List, Tuple
import carb
import omni.kit.app
import omni.ui as ui
from omni.kit.widget.graph import GraphNodeDescription, GraphPortDescription
from omni.kit.widget.graph.abstract_graph_node_delegate import AbstractGraphNodeDelegate
from omni.kit.widget.graph.graph_model import GraphModel
from omni.kit.widget.graph.graph_view import GraphView
from .utils import ext_id_to_fullname
# pylint: disable=property-with-parameters
# Colors & Style
BACKGROUND_COLOR = 0xFF34302A
BORDER_DEFAULT = 0xFF232323
CONNECTION = 0xFF80C280
NODE_BACKGROUND = 0xFF141414
PLUGINS_COLOR = 0xFFFFE3C4
LIBRARIES_COLOR = 0xAA44EBE7
MODULES_COLOR = 0xFFAAE3C4
GRAPH_STYLE = {
"Graph": {"background_color": BACKGROUND_COLOR},
"Graph.Connection": {"color": CONNECTION, "background_color": CONNECTION, "border_width": 2.0},
# Node
"Graph.Node.Background": {"background_color": NODE_BACKGROUND},
"Graph.Node.Border": {"background_color": BORDER_DEFAULT},
# Header
"Graph.Node.Header.Label": {"color": 0xFFEEEEEE, "margin_height": 5.0, "font_size": 14.0},
}
# Constants
MARGIN_WIDTH = 7.5
MARGIN_TOP = 20.0
MARGIN_BOTTOM = 25.0
BORDER_THICKNESS = 3.0
HEADER_HEIGHT = 25.0
MIN_WIDTH = 180.0
CONNECTION_CURVE = 60
class GraphNodeDelegate(AbstractGraphNodeDelegate):
"""
The delegate with the Omniverse design.
"""
def __init__(self, scale_factor=1.0):
self._manager = omni.kit.app.get_app_interface().get_extension_manager()
self._scale_factor = scale_factor
def __scale(self, value):
"""Return the value multiplied by global scale multiplier"""
return value * self._scale_factor
def set_scale_factor(self, scale_factor):
"""Replace scale factor"""
self._scale_factor = scale_factor
def node_background(self, model, node_desc: GraphNodeDescription):
"""Called to create widgets of the node background"""
# Computed values
left_right_offset = MARGIN_WIDTH - BORDER_THICKNESS * 0.5
# Draw a rectangle and a top line
with ui.HStack():
# Left offset
ui.Spacer(width=self.__scale(left_right_offset))
with ui.VStack():
ui.Spacer(height=self.__scale(MARGIN_TOP))
# The node body
with ui.ZStack():
# This trick makes min width
ui.Spacer(width=self.__scale(MIN_WIDTH))
# Build outer rectangle
ui.Rectangle(style_type_name_override="Graph.Node.Border")
# Build inner rectangle
with ui.VStack():
ui.Spacer(height=self.__scale(HEADER_HEIGHT))
with ui.HStack():
ui.Spacer(width=self.__scale(BORDER_THICKNESS))
ui.Rectangle(style_type_name_override="Graph.Node.Background")
ui.Spacer(width=self.__scale(BORDER_THICKNESS))
ui.Spacer(height=self.__scale(BORDER_THICKNESS))
ui.Spacer(height=self.__scale(MARGIN_BOTTOM))
# Right offset
ui.Spacer(width=self.__scale(left_right_offset))
def node_header_input(self, model, node_desc: GraphNodeDescription):
"""Called to create the left part of the header that will be used as input when the node is collapsed"""
with ui.ZStack(width=self.__scale(8)):
if node_desc.connected_target:
# Circle that shows that the port is a target for the connection
ui.Circle(
radius=self.__scale(4),
size_policy=ui.CircleSizePolicy.FIXED,
style_type_name_override="Graph.Connection",
alignment=ui.Alignment.RIGHT_CENTER,
)
def node_header_output(self, model, node_desc: GraphNodeDescription):
"""Called to create the right part of the header that will be used as output when the node is collapsed"""
with ui.ZStack(width=self.__scale(8)):
if node_desc.connected_source:
# Circle that shows that the port is a source for the connection
ui.Circle(
radius=self.__scale(4),
size_policy=ui.CircleSizePolicy.FIXED,
style_type_name_override="Graph.Connection",
alignment=ui.Alignment.LEFT_CENTER,
)
def node_header(self, model, node_desc: GraphNodeDescription):
"""Called to create widgets of the top of the node"""
item = model[node_desc.node].item
def build_list(files, title, color):
if len(files) > 0:
style = {"CollapsableFrame": {"color": color, "background_color": NODE_BACKGROUND}}
with ui.CollapsableFrame(title, collapsed=False, style=style):
with ui.VStack(height=0):
for p in files:
ui.Label(" - " + os.path.basename(p), height=self.__scale(20)).set_tooltip(p)
# Draw the node name and a bit of space
with ui.VStack(height=0):
ui.Spacer(height=self.__scale(18))
with ui.HStack(height=0):
ui.Spacer(width=self.__scale(18))
title = item.id
ui.Label(title, style_type_name_override="Graph.Node.Header.Label")
build_list(item.plugins, "carb plugins", PLUGINS_COLOR)
build_list(item.libraries, "shared libraries", LIBRARIES_COLOR)
build_list(item.modules, "python modules", MODULES_COLOR)
ui.Spacer(height=self.__scale(55))
def node_footer(self, model, node_desc: GraphNodeDescription):
pass
def port_input(self, model, node_desc: GraphNodeDescription, port_desc: GraphPortDescription):
pass
def port_output(self, model, node_desc: GraphNodeDescription, port_desc: GraphPortDescription):
pass
def port(self, model, node_desc: GraphNodeDescription, port_desc: GraphPortDescription):
pass
def connection(self, model, source, target):
"""Called to create the connection between ports"""
# If the connection is reversed, we need to mirror tangents
connection_direction_is_same_as_flow = source.level >= target.level
reversed_tangent = -1.0 if connection_direction_is_same_as_flow else 1.0
ui.FreeBezierCurve(
target.widget,
source.widget,
start_tangent_width=ui.Percent(CONNECTION_CURVE * reversed_tangent),
end_tangent_width=ui.Percent(-CONNECTION_CURVE * reversed_tangent),
style_type_name_override="Graph.Connection",
)
class ExtGraphItem:
def __init__(self, manager, ext_id):
info = manager.get_extension_dict(ext_id)
# Extension dependencies:
self.deps = info.get("state/dependencies", [])
self.port_deps = [d + "/out" for d in self.deps]
# Extension useful info (id, version, plugins, modules etc)
state_dict = info.get("state", {})
native_dict = state_dict.get("native", {})
self.id = ext_id
self.plugins = native_dict.get("plugins", [])
self.libraries = native_dict.get("libraries", [])
self.modules = state_dict.get("python", {}).get("modules", [])
def __lt__(self, other):
return self.id < other.id
class Model(GraphModel):
def __init__(self, ext_id: str = None):
super().__init__()
# build graph out of enabled extensions
manager = omni.kit.app.get_app_interface().get_extension_manager()
exts = manager.get_extensions()
enabled_exts = [e["id"] for e in exts if e["enabled"]]
self._nodes = {ext_id: ExtGraphItem(manager, ext_id) for ext_id in enabled_exts}
# If ext_id was passed filter out extension that are not reachable from this one. To show only its graph:
self._root_ext_id = ext_id
if self._root_ext_id:
self._filter_out_unreachable_nodes(ext_id)
def _filter_out_unreachable_nodes(self, ext_id):
visited = set()
q = []
root = self._nodes.get(ext_id, None)
if not root:
carb.log_error(f"Failure to filter dep graph, can't find ext node: {ext_id}")
return
q.append(root)
visited.add(root)
while len(q) > 0:
node = q.pop()
for d in node.deps:
child = self._nodes[d]
if child not in visited:
visited.add(child)
q.append(child)
self._nodes = {ext_id: item for ext_id, item in self._nodes.items() if item in visited}
@property
def expansion_state(self, item=None):
return self.ExpansionState.CLOSED
@property
def nodes(self, item=None):
return {e.id for e in self._nodes.values()}
@property
def name(self, item=None):
return self._nodes[item].id
@property
def item(self, item=None):
return self._nodes[item]
@property
def ports(self, item=None):
return [item + "/in", item + "/out"]
@property
def inputs(self, item):
if item.endswith("/in"):
item = self._nodes.get(item[:-3], None)
return item.port_deps if item else []
return None
@property
def outputs(self, item):
outputs = [] if item.endswith("/out") else None
return outputs
def copy_as_graphviz(self):
output = ""
output += """
digraph Extensions {
graph [outputMode=nodesfirst rankdir=LR]
node [shape=box style=filled]
"""
for _, node in self._nodes.items():
label = node.id + "\\n-------------------\\n"
def gen(files, title):
if len(files) == 0:
return ""
return f"{title}:\\l" + "".join([f" * {os.path.basename(f)}\\l" for f in files])
label += gen(node.plugins, "plugins")
label += gen(node.libraries, "libraries")
label += gen(node.modules, "modules")
output += f'\t\t"{node.id}" [label="{label}"]\n'
for d in node.deps:
output += f'\t\t"{d}" -> "{node.id}"\n'
output += "}\n"
print(output)
omni.kit.clipboard.copy(output)
class ExtsListView:
def __init__(self, model, ext_id):
self._model = model
self._ext_id = ext_id
# gather reverse dependencies from both local extensions and registry extensions
registry_exts = []
unique_registry_exts = set()
manager = omni.kit.app.get_app_interface().get_extension_manager()
for ext in manager.get_extensions():
ext_name = ext["name"]
registry_exts.append(ext)
unique_registry_exts.add(ext_name)
for ext in manager.get_registry_extensions():
ext_id = ext["id"]
ext_name = ext["name"]
if ext_name not in unique_registry_exts:
# grab latest version of each extension
versions = manager.fetch_extension_versions(ext_name)
if len(versions) > 0 and versions[0]["id"] == ext_id:
registry_exts.append(ext)
unique_registry_exts.add(ext_name)
self._reverse_dep = self._get_reverse_dependencies(manager, registry_exts)
with ui.ScrollingFrame(
horizontal_scrollbar_policy=ui.ScrollBarPolicy.SCROLLBAR_ALWAYS_OFF,
vertical_scrollbar_policy=ui.ScrollBarPolicy.SCROLLBAR_ALWAYS_ON,
):
with ui.ZStack():
ui.Rectangle(style_type_name_override="ExtensionDescription.ContentBackground")
with ui.HStack():
ui.Spacer(width=10)
with ui.VStack(height=0):
ui.Spacer(height=10)
direct = self._model._nodes[self._ext_id].deps if self._ext_id else ()
ui.Label(f"- Direct Dependencies ({len(direct)}):", height=20)
for ext in sorted(direct):
ui.Label(ext)
ui.Spacer(height=10)
indirect = [
node
for node in self._model._nodes.values()
if node.id not in direct and node.id != self._ext_id
]
ui.Label(f"- All Indirect Dependencies ({len(indirect)}):", height=20)
for node in sorted(indirect):
ui.Label(node.id)
ui.Spacer(width=10)
with ui.VStack(height=10):
ui.Spacer(height=10)
direct = self._reverse_dep[0]
ui.Label(f"- Direct Reverse Dependencies ({len(direct)}):", height=20)
for item in sorted(direct):
ui.Label(item)
ui.Spacer(height=10)
indirect = [
ext
for ext in self._reverse_dep[1]
if ext not in direct and ext != ext_id_to_fullname(self._ext_id)
]
ui.Label(f"- All Indirect Reverse Dependencies ({len(indirect)}):", height=20)
for item in sorted(indirect):
ui.Label(item)
def _get_reverse_dependencies(self, manager, exts) -> Tuple[List, List]:
dependents = defaultdict(set)
unique_exts_first_order = set()
unique_exts = set()
max_depth = 40
for ext in exts:
ext_id = ext["id"]
ext_name = ext["name"]
info = manager.get_extension_dict(ext_id)
if not info:
info = manager.get_registry_extension_dict(ext_id)
if info:
deps = info.get("dependencies", [])
for dep_name in deps:
dependents[dep_name].add(ext_name)
def recurse(ext_name: str, cur_depth: int):
if cur_depth < max_depth:
if cur_depth == 1:
unique_exts_first_order.add(ext_name)
unique_exts.add(ext_name)
for dep_name in dependents[ext_name]:
recurse(dep_name, cur_depth + 1)
if self._ext_id:
info = manager.get_extension_dict(self._ext_id)
ext_name = info.get("package/name", "")
recurse(ext_name, 0)
# returns a tuple, 1st order deps only and all reverse deps
return list(unique_exts_first_order), list(unique_exts)
class ExtsGraphWidget:
"""Extensions graph window"""
def __init__(self, ext_id):
self._ext_id = ext_id
self._view_index = 0
with ui.ZStack():
self._delegate = GraphNodeDelegate()
self._model = Model(self._ext_id)
# TODO(anov): remove pan_x, pan_y hardcoded after graph auto align fixed.
self._graph_frame = ui.Frame()
raster_nodes = carb.settings.get_settings().get("/exts/omni.kit.window.extensions/raster_nodes")
with self._graph_frame:
self._graph_view = GraphView(
delegate=self._delegate,
model=self._model,
style=GRAPH_STYLE,
zoom=0.5,
pan_x=1000,
pan_y=400,
raster_nodes=raster_nodes,
)
self._list_frame = ui.Frame()
with self._list_frame:
self._list_view = ExtsListView(self._model, self._ext_id)
self._list_frame.visible = False
with ui.VStack():
ui.Spacer()
with ui.HStack(height=0):
ui.Spacer()
with ui.VStack(width=200, height=0, content_clipping=True):
ui.Button(
"Toggle View",
width=200,
height=20,
mouse_pressed_fn=lambda *_: self._toggle_view(),
)
ui.Button(
"Copy as Graphviz .dot",
width=200,
height=20,
mouse_pressed_fn=lambda *_: self._model.copy_as_graphviz(),
)
ui.Spacer(width=10)
ui.Spacer(height=10)
def _toggle_view(self):
self._view_index = (self._view_index + 1) % 2
self._list_frame.visible = self._view_index == 1
self._graph_frame.visible = self._view_index == 0
def destroy(self):
self._delegate = None
self._model = None
self._list_frame = None
self._list_view = None
self._graph_frame = None
self._graph_view = None
class ExtsGraphWindow:
"""Extensions graph window"""
def __init__(self):
self._frame = ui.Frame()
self._frame.visible = False
self._graph_widget = None
self.select_ext(None)
manager = omni.kit.app.get_app_interface().get_extension_manager()
change_stream = manager.get_change_event_stream()
self._change_script_sub = change_stream.create_subscription_to_pop(
lambda _: self._refresh(), name="ExtsGraphWindow watch for exts"
)
def destroy(self):
self._frame = None
if self._graph_widget:
self._graph_widget.destroy()
self._change_script_sub = None
def _refresh(self):
self.set_visible(self._frame.visible)
def select_ext(self, ext_id):
self._ext_id = ext_id
def set_visible(self, visible: bool):
if self._frame.visible == visible:
if visible:
# recreate if already shown
self.set_visible(False)
else:
# if not shown already -> do nothing.
return
if not visible:
self._frame.visible = False
else:
self._build()
self._frame.visible = True
def _build(self):
with self._frame:
if self._graph_widget:
self._graph_widget.destroy()
self._graph_widget = ExtsGraphWidget(self._ext_id)
| 19,076 | Python | 35.89942 | 114 | 0.551478 |
omniverse-code/kit/exts/omni.kit.window.extensions/omni/kit/window/extensions/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.
#
# pylint: disable=attribute-defined-outside-init, protected-access
import asyncio
import contextlib
import weakref
from typing import Callable
import omni.ext
import omni.kit.app
import omni.kit.ui
import omni.ui as ui
from . import common, ext_controller, ext_info_widget
from .exts_list_widget import ExtsListWidget
from .utils import get_setting
from .window import ExtsWindow
MENU_PATH = "Window/Extensions"
_ext_instance = None
def show_window(value: bool):
"""Show/Hide Extensions window"""
if _ext_instance:
_ext_instance.show_window(value)
def get_instance() -> "weakref.ReferenceType[ExtsWindowExtension]":
return weakref.ref(_ext_instance)
class ExtsWindowExtension(omni.ext.IExt):
"""The entry point exts 2.0 window"""
def on_startup(self, ext_id):
global _ext_instance
_ext_instance = self
app = omni.kit.app.get_app()
common.EXT_ROOT = app.get_extension_manager().get_extension_path(ext_id)
self._window = None
# # Add to menu - will fail if the editor is not loaded
self._menu = None # Throwing is ok, but leaves self._menu undefined
with contextlib.suppress(Exception):
self._menu = omni.kit.ui.get_editor_menu().add_item(
MENU_PATH, lambda _, v: self.show_window(v), toggle=True, value=False, priority=100
)
ui.Workspace.set_show_window_fn(
"Extensions",
lambda value: self.show_window(value), # pylint: disable=unnecessary-lambda
)
# Start enabling autoloadable extensions:
asyncio.ensure_future(ext_controller.autoload_extensions())
# Auto show window, for convenience
show = get_setting("/exts/omni.kit.window.extensions/showWindow", False)
if self._menu:
omni.kit.ui.get_editor_menu().set_value(MENU_PATH, show)
if show:
self.show_window(True)
# Some events trigger rebuild of a whole window
bus = app.get_message_bus_event_stream()
self._subs = []
def on_rebuild(_):
if self._window:
self.show_window(False)
self.show_window(True)
self._subs.append(bus.create_subscription_to_pop_by_type(common.COMMUNITY_TAB_TOGGLE_EVENT, on_rebuild))
def on_shutdown(self):
global _ext_instance
_ext_instance = None
self.show_window(False)
self._menu = None
self._subs = 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 = ExtsWindow(on_visibility_changed if self._menu else None)
else:
if self._window:
self._window.destroy()
self._window = None
# --------------------------------------------------------------------------------------------------------------
# API to add a new tab to the extension info pane
@classmethod
def refresh_extension_info_widget(cls):
if _ext_instance._window and _ext_instance._window._ext_info_widget:
_ext_instance._window._ext_info_widget.update_tabs()
_ext_instance._window._ext_info_widget._refresh()
@classmethod
def add_tab_to_info_widget(cls, tab: ext_info_widget.PageBase):
ext_info_widget.ExtInfoWidget.pages.append(tab)
cls.refresh_extension_info_widget()
@classmethod
def remove_tab_from_info_widget(cls, tab: ext_info_widget.PageBase):
if tab in ext_info_widget.ExtInfoWidget.pages:
ext_info_widget.ExtInfoWidget.pages.remove(tab)
ext_info_widget.ExtInfoWidget.current_page = 0
cls.refresh_extension_info_widget()
# --------------------------------------------------------------------------------------------------------------
# API to add a searchable keyword
@classmethod
def refresh_search_items(cls):
if _ext_instance._window and _ext_instance._window._exts_list_widget:
_ext_instance._window._exts_list_widget.rebuild_filter_menu()
_ext_instance._window._exts_list_widget._model.refresh_all()
@classmethod
def add_searchable_keyword(cls, keyword: str, description: str, filter_on_keyword: Callable, clear_cache: Callable):
ExtsListWidget.searches[keyword] = (description, filter_on_keyword, clear_cache)
cls.refresh_search_items()
@classmethod
def remove_searchable_keyword(cls, keyword_to_remove: str):
if keyword_to_remove in ExtsListWidget.searches:
del ExtsListWidget.searches[keyword_to_remove]
cls.refresh_search_items()
| 5,156 | Python | 34.565517 | 120 | 0.63014 |
omniverse-code/kit/exts/omni.kit.window.extensions/omni/kit/window/extensions/__init__.py | # flake8: noqa
from .ext_commands import ToggleExtension
from .ext_components import SimpleCheckBox
from .extension import ExtsWindowExtension, get_instance
| 157 | Python | 30.599994 | 56 | 0.840764 |
omniverse-code/kit/exts/omni.kit.window.extensions/omni/kit/window/extensions/ext_controller.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 functools import lru_cache
import carb
import carb.settings
import omni.kit.app
from .utils import ext_id_to_fullname, set_default_and_get_setting
DEFERRED_LOAD_SETTING_KEY = "/exts/omni.kit.window.extensions/deferredLoadExts"
AUTOLOAD_SETTING_KEY = "/persistent/app/exts/enabled"
FEATURED_EXT_SETTING_KEY = "/exts/omni.kit.window.extensions/featuredExts"
WAIT_FRAMES_SETTING_KEY = "/exts/omni.kit.window.extensions/waitFramesBetweenEnable"
_autoload_exts = None
_startup_exts = set()
_startup_ext_ids = set()
def _get_autoload_exts():
global _autoload_exts
if _autoload_exts is None:
_autoload_exts = set(set_default_and_get_setting(AUTOLOAD_SETTING_KEY, []))
return _autoload_exts
@lru_cache()
def _get_featured_exts():
return set(set_default_and_get_setting(FEATURED_EXT_SETTING_KEY, []))
def _save():
exts = _get_autoload_exts()
carb.settings.get_settings().set(AUTOLOAD_SETTING_KEY, list(exts))
def toggle_autoload(ext_id: str, toggle: bool):
exts = _get_autoload_exts()
if toggle:
# Disable all other versions
ext_manager = omni.kit.app.get_app().get_extension_manager()
extensions = ext_manager.fetch_extension_versions(ext_id_to_fullname(ext_id))
for e in extensions:
exts.discard(e["id"])
exts.add(ext_id)
else:
exts.discard(ext_id)
_save()
def is_autoload_enabled(ext_id: str) -> bool:
exts = _get_autoload_exts()
return ext_id in exts
def is_startup_ext(ext_name: str) -> bool:
return ext_name in _startup_exts
def is_startup_ext_id(ext_id: str) -> bool:
return ext_id in _startup_ext_ids
def is_featured_ext(ext_name: str) -> bool:
return ext_name in _get_featured_exts()
def are_featured_exts_enabled() -> bool:
return len(_get_featured_exts()) > 0
async def autoload_extensions():
# Delay for one update until everything else of a core app is loaded
await omni.kit.app.get_app().next_update_async()
ext_manager = omni.kit.app.get_app().get_extension_manager()
wait_frames = set_default_and_get_setting(WAIT_FRAMES_SETTING_KEY, 1)
# Enable all deferered extension, one by one. Wait for next frame inbetween each.
for ext_id in set_default_and_get_setting(DEFERRED_LOAD_SETTING_KEY, []):
ext_manager.set_extension_enabled_immediate(ext_id, True)
for _ in range(wait_frames):
await omni.kit.app.get_app().next_update_async()
# Build list of startup extensions (those that were started by this point)
_autoload_exts = _get_autoload_exts()
for ext_info in ext_manager.get_extensions():
if ext_info["enabled"] and ext_info["id"] not in _autoload_exts:
_startup_exts.add(ext_info["name"])
_startup_ext_ids.add(ext_info["id"])
| 3,228 | Python | 31.29 | 85 | 0.696097 |
omniverse-code/kit/exts/omni.kit.window.extensions/omni/kit/window/extensions/utils.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.
#
# pylint: disable=protected-access, access-member-before-definition
import asyncio
import contextlib
import glob
import os
import platform
import shutil
import subprocess
from functools import lru_cache
from typing import Callable, Tuple
import carb
import carb.dictionary
import carb.settings
import omni.kit.commands
def call_once_with_delay(fn: Callable, delay: float):
"""Call function once after `delay` seconds.
If this function called again before `delay` is passed the timer gets reset."""
async def _delayed_refresh():
await asyncio.sleep(delay)
fn()
with contextlib.suppress(Exception):
fn._delay_call_task.cancel()
fn._delay_call_task = asyncio.ensure_future(_delayed_refresh())
@lru_cache()
def is_windows():
return platform.system().lower() == "windows"
def run_process(args):
print(f"running process: {args}")
kwargs = {"close_fds": False}
if is_windows():
kwargs["creationflags"] = subprocess.CREATE_NEW_CONSOLE | subprocess.CREATE_NEW_PROCESS_GROUP
subprocess.Popen(args, **kwargs) # pylint: disable=consider-using-with
def version_to_str(version: Tuple[int, int, int, str, str]) -> str:
"""Generate string `0.0.0-tag+tag`"""
delimiters = ("", ".", ".", "-", "+")
return "".join(f"{d}{v}" for d, v in zip(delimiters, version) if str(v) and v is not None)
def ext_id_to_fullname(ext_id: str) -> str:
return omni.ext.get_extension_name(ext_id)
def ext_id_to_name_version(ext_id: str) -> Tuple[str, str]:
"""Convert 'omni.foo-tag-1.2.3' to 'omni.foo-tag' and '1.2.3'"""
a, b, *rest = ext_id.split("-")
if b:
if not b[0:1].isdigit():
return f"{a}-{b}", "-".join(rest)
return a, "-".join([b] + rest)
return a, ""
def get_ext_info_dict(ext_manager, ext_info) -> Tuple[carb.dictionary.Item, bool]:
ext_dict = ext_manager.get_extension_dict(ext_info["id"])
if ext_dict is not None:
return (ext_dict, True)
return (ext_manager.get_registry_extension_dict(ext_info["package_id"]), False)
def get_setting(path, default=None):
setting = carb.settings.get_settings().get(path)
return setting if setting is not None else default
def set_default_and_get_setting(path, default=None):
settings = carb.settings.get_settings()
settings.set_default(path, default)
return settings.get(path)
def clip_text(s, max_count=80):
return s[:max_count] + ("..." if len(s) > max_count else "")
def open_file_using_os_default(path: str):
if platform.system() == "Darwin": # macOS
subprocess.call(("open", path))
elif platform.system() == "Windows": # Windows
os.startfile(path) # noqa: PLE1101
else: # linux variants
subprocess.call(("xdg-open", path))
def open_url(url):
import webbrowser
webbrowser.open(url)
def open_using_os_default(path: str):
if os.path.isfile(path):
open_file_using_os_default(path)
else:
# open dir
import webbrowser
webbrowser.open(path)
def open_in_vscode(path: str):
subprocess.call(["code", path], shell=is_windows())
@lru_cache()
def is_vscode_installed():
try:
cmd = ["code", "--version"]
return subprocess.call(cmd, shell=is_windows(), stdout=subprocess.DEVNULL, stderr=subprocess.STDOUT) == 0
except FileNotFoundError:
return False
def _search_path_entry_up(path, entry, max_steps_up=3):
for _ in range(0, max_steps_up + 1):
if os.path.exists(os.path.join(path, entry)):
return os.path.normpath(path)
new_path = os.path.normpath(os.path.join(path, ".."))
if new_path == path:
break
path = new_path
return None
def open_in_vscode_if_enabled(path: str, prefer_vscode: bool = True):
if prefer_vscode and is_vscode_installed():
# Search for .vscode folder few folders up to open project instead of just extension
# 5 steps is enough for '_build/window/release/exts/omni.foo' for instance
if os.path.isdir(path):
path = _search_path_entry_up(path, ".vscode", max_steps_up=5) or path
open_in_vscode(path)
else:
open_using_os_default(path)
def copy_text(text):
omni.kit.clipboard.copy(text)
def cleanup_folder(path):
try:
for p in glob.glob(f"{path}/*"):
if os.path.isdir(p):
if omni.ext.is_link(p):
omni.ext.destroy_link(p)
else:
shutil.rmtree(p)
else:
os.remove(p)
except Exception as exc: # pylint: disable=broad-except
carb.log_warn(f"Unable to clean up files: {path}: {exc}")
@lru_cache()
def get_extpath_git_ext():
try:
import omni.kit.extpath.git as git_ext
return git_ext
except ImportError:
return None
async def _load_popup_dialog_ext():
app = omni.kit.app.get_app()
manager = app.get_extension_manager()
if not manager.is_extension_enabled("omni.kit.window.popup_dialog"):
manager.set_extension_enabled("omni.kit.window.popup_dialog", True)
await app.next_update_async()
await app.next_update_async()
async def show_ok_popup(title, message, **dialog_kwargs):
await _load_popup_dialog_ext()
from omni.kit.window.popup_dialog import MessageDialog
app = omni.kit.app.get_app()
done = False
def on_click(d):
nonlocal done
done = True
dialog_kwargs.setdefault("disable_cancel_button", True)
dialog = MessageDialog(title=title, message=message, ok_handler=on_click, **dialog_kwargs)
dialog.show()
while not done:
await app.next_update_async()
dialog.destroy()
async def show_user_input_popup(title, label, default):
await _load_popup_dialog_ext()
from omni.kit.window.popup_dialog import InputDialog
app = omni.kit.app.get_app()
value = None
def on_click(dialog: InputDialog):
nonlocal value
value = dialog.get_value()
dialog = InputDialog(
message=title,
pre_label=label,
post_label="",
default_value=default,
ok_handler=on_click,
ok_label="Ok",
)
dialog.show()
while not value:
await app.next_update_async()
dialog.destroy()
return value
| 6,773 | Python | 26.425101 | 113 | 0.641223 |
omniverse-code/kit/exts/omni.kit.window.extensions/omni/kit/window/extensions/ext_components.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 asyncio
import sys
from typing import Callable, Dict
import omni.kit.app
import omni.ui as ui
from .common import ExtensionCommonInfo, ExtSource, build_doc_urls, pull_extension_async, toggle_extension
from .styles import get_style
from .utils import get_setting, open_url, run_process
class ExtensionToggle:
def __init__(self, item: ExtensionCommonInfo, with_label=False, show_install_button=True, refresh_cb=None):
with ui.HStack(width=0, style=get_style(self)):
if item.is_app:
def on_click(is_local=item.is_local, ext_id=item.id):
manager = omni.kit.app.get_app().get_extension_manager()
if not is_local:
manager.pull_extension(ext_id)
args = [sys.argv[0]]
ext_info = manager.get_extension_dict(ext_id)
if ext_info.get("isKitFile", False):
args.append(ext_info["path"])
else:
args.extend(["--enable", ext_id])
# Pass all exts folders
for folder in get_setting("/app/exts/folders", default=[]):
args.extend(["--ext-folder", folder])
run_process(args)
with ui.VStack():
ui.Spacer()
ui.Button("LAUNCH", name="LaunchButton", width=60, height=20, clicked_fn=on_click)
ui.Spacer()
elif not item.is_local:
if not show_install_button:
return
with ui.VStack():
ui.Spacer()
if item.is_pulled:
ui.Button("INSTALLING...", name="DownloadingButton", width=60, height=20)
else:
def on_click(item=item):
asyncio.ensure_future(pull_extension_async(item))
ui.Button("INSTALL", name="InstallButton", width=60, height=20, clicked_fn=on_click)
ui.Spacer()
else:
if item.failed:
with ui.VStack():
ui.Spacer()
# OM-90861: Add tooltip for extension depdency solve failure
tooltip = "Failed to solve extension dependency."
if item.solver_error:
tooltip += f"\nError: {item.solver_error}"
ui.Image(name="Failed", width=26, height=26, tooltip=tooltip)
ui.Spacer()
with ui.VStack():
ui.Spacer()
name = "clickable"
tb = ui.ToolButton(image_width=39, image_height=18, height=0, name=name)
tb.model.as_bool = item.enabled
def toggle(model, ext_id=item.id, fullname=item.fullname):
enable = model.get_value_as_bool()
# If we about to enable, toggle other versions if enabled
if enable:
manager = omni.kit.app.get_app().get_extension_manager()
extensions = manager.fetch_extension_versions(fullname)
for e in extensions:
if e["enabled"] and e["id"] != ext_id:
toggle_extension(e["id"], False)
if not toggle_extension(ext_id, enable=enable):
model.as_bool = not enable
if item.is_toggle_blocked:
tb.name = "nonclickable"
# TODO(anov): how to make ToolButton disabled?
def block_change(model, enabled=item.enabled):
model.as_bool = enabled
tb.model.add_value_changed_fn(block_change)
else:
tb.model.add_value_changed_fn(toggle)
ui.Spacer()
if with_label:
ui.Spacer(width=8)
if item.enabled:
ui.Label("ENABLED", name="EnabledLabel")
else:
ui.Label("DISABLED", name="DisabledLabel")
class SimpleCheckBox:
def __init__(self, checked: bool, on_checked_fn: Callable, text: str = None, model=None, enabled=True):
with ui.HStack(width=0, style=get_style(self)):
with ui.VStack(width=0):
ui.Spacer()
if enabled:
tb = ui.ToolButton(image_width=39, image_height=18, height=0, model=model)
tb.model.as_bool = checked
tb.model.add_value_changed_fn(lambda model: on_checked_fn(model.get_value_as_bool()))
else:
name = "disabled_checked" if checked else "disabled_unchecked"
ui.Image(width=39, height=18, name=name)
ui.Spacer()
if text:
ui.Label(text)
class SearchWidget:
"""String field with a label overlay to type search string into."""
def __init__(self, on_search_fn: Callable[[str], None]):
def clear_text(widget):
widget.model.set_value("")
widget.focus_keyboard()
def field_changed(field_string):
self._clear_button.visible = len(field_string) > 0
on_search_fn(field_string)
self.clear_filters()
with ui.ZStack(height=0, style=get_style(self)):
# Search filed
with ui.HStack():
field_widget = ui.StringField(style_type_name_override="SearchField")
self._search = field_widget.model
ui.Rectangle(width=20, style={"background_color": 0xFF212121, "border_radius": 0.0})
with ui.HStack():
ui.Spacer()
self._clear_button = ui.Button(
"",
name="ClearSearch",
width=16,
alignment=ui.Alignment.CENTER,
clicked_fn=lambda w=field_widget: clear_text(w),
visible=False,
)
# The label on the top of the search field
with ui.HStack():
ui.Spacer(width=5)
with ui.VStack(width=0):
ui.Spacer()
self._search_icon = ui.Image(name="SearchIcon", width=12, height=13)
ui.Spacer()
self._search_label = ui.Label("Search", style={"margin_width": 4}, name="Search")
# The filtering logic
self._begin_filter_sub = self._search.subscribe_begin_edit_fn(lambda _: self._toggle_visible(False))
self._edit_filter_sub = self._search.subscribe_value_changed_fn(lambda m: field_changed(m.as_string))
self._end_filter_sub = self._search.subscribe_end_edit_fn(lambda m: self._toggle_visible(not m.as_string))
def _toggle_visible(self, visible):
self._search_label.visible = visible
self._search_icon.visible = visible
def set_text(self, text):
self._search.as_string = text
self._toggle_visible(False)
def get_text(self):
return self._search.as_string
def get_filters(self):
return self._filters
def toggle_filter(self, filter_to_toggle):
if filter_to_toggle in self._filters:
self._filters.remove(filter_to_toggle)
else:
self._filters.append(filter_to_toggle)
def clear_filters(self):
self._filters = []
def destroy(self):
self._begin_filter_sub = None
self._edit_filter_sub = None
self._end_filter_sub = None
class ExtSourceSelector:
def __init__(self, on_selected_fn):
self._on_selected_fn = None
self._buttons = {}
with ui.HStack(height=20):
for index, source in enumerate(ExtSource):
ui.Spacer()
tab_btn = ui.Button(
source.get_ui_name(),
width=0,
style_type_name_override="ExtensionDescription.Tab",
clicked_fn=lambda s=source: self.set_tab(s),
)
self._buttons[source] = tab_btn
if index < len(ExtSource) - 1:
ui.Spacer()
ui.Line(
style_type_name_override="ExtensionDescription.TabLine",
alignment=ui.Alignment.H_CENTER,
height=20,
width=40,
)
ui.Spacer()
self.set_tab(ExtSource.NVIDIA)
self._on_selected_fn = on_selected_fn
def set_badge_number(self, source, number):
self._buttons[source].text = source.get_ui_name() + f" ({number})"
def set_tab(self, source):
for b in self._buttons.values():
b.selected = False
self._buttons[source].selected = True
if self._on_selected_fn:
self._on_selected_fn(source)
def add_icon_button(name, on_click):
with ui.VStack(width=0):
ui.Spacer()
b = ui.Button(name=name, style_type_name_override="IconButton", width=23, height=18, clicked_fn=on_click)
ui.Spacer()
return b
def add_doc_link_button(ext_item: ExtensionCommonInfo, package_dict: Dict, docs_dict: Dict):
# Create a button, but hide.
button = None
with ui.VStack(width=0):
ui.Spacer()
button = ui.Button(
name="OpenDoc",
style_type_name_override="IconButton",
width=23,
height=18,
style={"Label": {"color": 0xFF444444}},
)
ui.Spacer()
button.visible = False
def check_url_sync(url):
import urllib
try:
return urllib.request.urlopen(url).getcode() == 200
except urllib.error.HTTPError:
return False
async def check_urls(doc_urls):
for doc_url in doc_urls:
# run sync code on other thread not to block
if await asyncio.get_event_loop().run_in_executor(None, check_url_sync, doc_url):
button.visible = True
def on_click(url=doc_url):
open_url(url)
button.set_clicked_fn(on_click)
button.set_tooltip_fn(lambda url=doc_url: ui.Label(url))
break
# Async check for URLs and if valid show the button
doc_urls = build_doc_urls(ext_item)
if doc_urls:
asyncio.ensure_future(check_urls(doc_urls))
| 11,164 | Python | 35.848185 | 114 | 0.523647 |
omniverse-code/kit/exts/omni.kit.window.extensions/omni/kit/window/extensions/ext_data_fetcher.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 asyncio
import json
import logging
import os
from functools import lru_cache
from typing import Callable, List
import omni.kit.app
from .common import ExtensionCommonInfo, get_registry_url
logger = logging.getLogger(__name__)
class ExtDataFetcher:
"""Fetches json files near extension archives from the registry and caches them"""
def __init__(self):
# Notify when anything new fetched
self.on_data_fetched_fn: Callable = None
# Cached data
self._data = {}
def get_ext_data(self, package_id) -> dict:
return self._data.get(package_id, None)
def fetch(self, ext_item: ExtensionCommonInfo):
if self.get_ext_data(ext_item.package_id):
return
json_data_urls = self._build_json_data_urls(ext_item)
if json_data_urls:
async def read_data():
for json_data_url in json_data_urls:
result, _, content = await omni.client.read_file_async(json_data_url)
if result == omni.client.Result.OK:
try:
content = memoryview(content).tobytes().decode("utf-8")
self._data[ext_item.package_id] = json.loads(content)
if self.on_data_fetched_fn:
self.on_data_fetched_fn(ext_item.package_id) # noqa
break
except Exception as e: # noqa
logger.error("Error reading extra registry data from: %s. Error: %s", json_data_url, e)
asyncio.ensure_future(read_data())
def _build_json_data_urls(self, ext_item: ExtensionCommonInfo) -> List[str]:
ext_manager = omni.kit.app.get_app().get_extension_manager()
ext_remote_info = ext_manager.get_registry_extension_dict(ext_item.package_id)
registry_url = get_registry_url(ext_item.provider_name)
if not registry_url:
return None
# Same as archive path, but extension is `.json`:
archive_path = ext_remote_info.get("package", {}).get("archivePath", None)
if archive_path:
# build url relative to the registry url
archive_path = archive_path.replace("\\", "/")
archive_path = omni.client.combine_urls(registry_url + "/index.zip", archive_path)
archive_path = omni.client.normalize_url(archive_path)
archive_path = os.path.splitext(archive_path)[0] + ".json"
if omni.client.break_url(archive_path).host == omni.client.break_url(registry_url).host:
return [archive_path]
# that means archive path is on different host (like packman). Do the best guess using registry url.
# Old format is one big folder, new format is a subfolder for each extension
data_filename = os.path.basename(archive_path)
return [
"{}/archives/{}".format(registry_url, data_filename),
"{}/archives/{}/{}".format(registry_url, ext_item.fullname, data_filename),
]
return None
@lru_cache()
def get_ext_data_fetcher():
return ExtDataFetcher()
| 3,635 | Python | 39.4 | 115 | 0.616506 |
omniverse-code/kit/exts/omni.kit.window.extensions/omni/kit/window/extensions/markdown_renderer.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 omni.ui as ui
from .styles import get_style
class MarkdownText:
def __init__(self, content):
with ui.VStack(height=0, style=get_style(self)):
def consume_heading(s):
heading = 0
while s.startswith("#"):
s = s[1:]
heading += 1
return heading, s.lstrip()
for line in content.splitlines():
line = line.lstrip()
heading, line = consume_heading(line)
style_name = "text"
if heading > 0:
style_name = f"H{heading}"
ui.Label(line, name=style_name, height=0, word_wrap=True)
| 1,138 | Python | 32.499999 | 76 | 0.603691 |
omniverse-code/kit/exts/omni.kit.window.extensions/omni/kit/window/extensions/exts_list_widget.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.
#
# pylint: disable=attribute-defined-outside-init, protected-access,
# pylint: disable=access-member-before-definition, unnecessary-lambda-assignment
import asyncio
import contextlib
import fnmatch
from collections import OrderedDict, defaultdict
from enum import IntFlag
from functools import lru_cache
from typing import Callable, List, Optional
import carb
import carb.events
import carb.settings
import omni.kit.app
import omni.kit.commands
import omni.ui as ui
from omni.kit.widget.filter import FilterButton
from omni.kit.widget.options_menu import OptionItem
from omni.ui import color as cl
from .common import (
EXTENSION_PULL_STARTED_EVENT,
REGISTRIES_CHANGED_EVENT,
ExtAuthorGroup,
ExtensionCommonInfo,
ExtSource,
get_categories,
get_open_example_links,
is_community_tab_enabled,
)
from .ext_components import ExtensionToggle, ExtSourceSelector, SearchWidget
from .ext_controller import are_featured_exts_enabled
from .ext_export_import import import_ext
from .ext_template import create_new_extension_template
from .styles import (
EXT_ICON_SIZE,
EXT_ITEM_TITLE_BAR_H,
EXT_LIST_ITEM_H,
EXT_LIST_ITEM_ICON_ZONE_W,
EXT_LIST_ITEMS_MARGIN_H,
)
from .utils import get_ext_info_dict, get_extpath_git_ext
ext_manager = None
# Sync only once for now
@lru_cache()
def _sync_registry():
ext_manager.refresh_registry()
class ExtGroupItem(ui.AbstractItem):
def __init__(self, name):
super().__init__()
self.name = name
self.total_count = 0
self.items = []
self.ext_source = ExtSource.NVIDIA
def contains(self, ext_summary):
return True
def is_expanded_by_default(self):
return True
class ExtFeatureGroupItem(ExtGroupItem):
def contains(self, ext_summary):
return ext_summary.feature
class ExtToggleableGroupItem(ExtGroupItem):
def contains(self, ext_summary):
return ext_summary.toggleable
class ExtNonToggleableGroupItem(ExtGroupItem):
def contains(self, ext_summary):
return not ext_summary.toggleable
def is_expanded_by_default(self):
return False
class ExtAuthorGroupItem(ExtGroupItem):
def __init__(self, name, author_group: ExtAuthorGroup):
super().__init__(name)
self.author_group = author_group
self.ext_source = ExtSource.THIRD_PARTY
def contains(self, ext_summary):
return ext_summary.author_group == self.author_group
def is_expanded_by_default(self):
return True
class ExtSummaryItem(ui.AbstractItem):
"""An abstract item that represents an extension summary"""
def refresh(self, ext_summary):
self.fullname = ext_summary["fullname"]
self.flags = ext_summary["flags"]
self.enabled_ext = ext_summary["enabled_version"]
self.latest_ext = ext_summary["latest_version"]
self.default_ext = self.latest_ext
self.enabled = bool(self.flags & omni.ext.EXTENSION_SUMMARY_FLAG_ANY_ENABLED)
if self.enabled:
self.default_ext = self.enabled_ext
self.id = self.default_ext["id"]
is_latest = self.enabled_ext["id"] == self.latest_ext["id"]
self.can_update = self.enabled and not is_latest
# Query more info
ext_info, is_local = get_ext_info_dict(ext_manager, self.default_ext)
# Take latest version (in terms of semver) and grab publish date from it if any, for sorting invert it.
latest_info = ext_info if is_latest else get_ext_info_dict(ext_manager, self.latest_ext)[0]
publish_date = latest_info.get("package", {}).get("publish", {}).get("date", 0)
self.publish_date_rev = -publish_date
# Move all attributes from ExtensionCommonInfo class to this class
self.__dict__.update(ExtensionCommonInfo(self.id, ext_info, is_local).__dict__)
class ExtSummariesModel(ui.AbstractItemModel):
"""Extension summary model that watches the changes in ext manager"""
class SortDirection(IntFlag):
NONE = 0
Ascending = 1
Descending = 2
def __init__(self, flat=None):
super().__init__()
global ext_manager
app = omni.kit.app.get_app()
ext_manager = app.get_extension_manager()
self._ext_summaries = {}
# Order matters here, because contains() matches first group
self._groups = [
ExtAuthorGroupItem("User", ExtAuthorGroup.USER),
ExtAuthorGroupItem("Partner", ExtAuthorGroup.PARTNER),
ExtAuthorGroupItem("Community - Verified", ExtAuthorGroup.COMMUNITY_VERIFIED),
ExtAuthorGroupItem("Community - Unverified", ExtAuthorGroup.COMMUNITY_UNVERIFIED),
ExtFeatureGroupItem("Feature"),
ExtToggleableGroupItem("General"),
ExtNonToggleableGroupItem("Non-Toggleable"),
]
# Attribute in ExtSummaryItem to sort by. For each attribute store order of sort in a dict (can be toggled)
self._sort_attr = "name"
self._sort_direction = ExtSummariesModel.SortDirection.Ascending
# exscribe for ext manager changes and generic event
def on_change(*_):
self._resync_exts()
self._subs = []
self._subs.append(
ext_manager.get_change_event_stream().create_subscription_to_pop(
on_change, name="ExtSummariesModel watch for exts"
)
)
bus = app.get_message_bus_event_stream()
self._subs.append(bus.create_subscription_to_pop_by_type(REGISTRIES_CHANGED_EVENT, on_change))
self._subs.append(bus.create_subscription_to_pop_by_type(EXTENSION_PULL_STARTED_EVENT, on_change))
# Current name filter
self._filter_name_text = []
# Current category filter
self._filter_category = ""
# Current ext source
self._filter_ext_source = ExtSource.NVIDIA
# Hacky link back to tree view to be able to update expanded state
self.tree_view = None
# on refresh callback
self.on_refresh_cb = None
# Builds a list
self._resync_exts()
def resync_registry(self):
ext_manager.refresh_registry()
def refresh_all(self):
self._resync_exts()
def _resync_exts(self):
get_extpath_git_ext.cache_clear()
for (_, _, clear_cache) in ExtsListWidget.searches.values():
if clear_cache is not None:
clear_cache()
_sync_registry()
ext_summaries = ext_manager.fetch_extension_summaries()
# groups
for g in self._groups:
g.total_count = 0
self._ext_summaries = {}
for ext_s in ext_summaries:
item = ExtSummaryItem()
item.refresh(ext_s)
# assign group
item.group = next(x for x in self._groups if x.contains(item))
item.group.total_count += 1
self._item_changed(item)
self._ext_summaries[ext_s["fullname"]] = item
self._item_changed(None)
# Update expanded state after tree was built and rendered
async def _delayed_expand():
await omni.kit.app.get_app().next_update_async()
if self.tree_view:
for g in self._groups:
self.tree_view.set_expanded(g, g.is_expanded_by_default(), False)
if self.tree_view:
asyncio.ensure_future(_delayed_expand())
self._sorted_summaries = list(self._ext_summaries.values())
self._make_sure_sorted()
def _refresh_item_group_lists(self):
# Filtering logic here:
matching_fns = []
# Split text in words and look for @keywords. Add matching functions and remove from the list.
# To remove from list while iterating use backward iteration trick.
parts = self._filter_name_text.copy()
for i in range(len(parts) - 1, -1, -1):
w = parts[i]
if w.startswith("@"):
# Predefined keywords or use default ones
fn = ExtsListWidget.searches.get(w, [None, None, None])[1]
if fn is None:
fn = lambda item, w=w: w[1:] in item.keywords
matching_fns.append(fn)
del parts[i]
# Whatever left just use as wildcard search:
if len(parts) > 0:
for part in parts:
filter_str = f"*{part.lower()}*"
matching_fns.append(
lambda item, filter_str=filter_str: fnmatch.fnmatch(item.name.lower(), filter_str)
or fnmatch.fnmatch(item.fullname.lower(), filter_str)
)
# If category filter enabled, add matching function for it
if len(self._filter_category) != 0:
matching_fns.append(lambda item: self._filter_category == item.category)
else:
hidden_categories = [c for c, v in get_categories().items() if v.get("hidden", False)]
matching_fns.append(lambda item: item.category not in hidden_categories)
# Show item only if it matches all matching functions
for group in self._groups:
group.items = [v for v in self._sorted_summaries if v.group == group and all(f(v) for f in matching_fns)]
self._item_changed(group)
# callback
if self.on_refresh_cb:
self.on_refresh_cb()
def get_item_children(self, item):
"""Reimplemented from AbstractItemModel"""
if item is None:
self._refresh_item_group_lists()
return [g for g in self._groups if g.total_count and g.ext_source == self._filter_ext_source]
if isinstance(item, ExtGroupItem):
return item.items
return []
def get_item_value_model_count(self, item):
"""Reimplemented from AbstractItemModel"""
return 1
def get_item_value_model(self, item, column_id):
"""Reimplemented from AbstractItemModel"""
return
def filter_by_text(self, filter_name_text, filters):
"""Specify the filter string that is used to reduce the model"""
new_list = filters + [filter_name_text]
if self._filter_name_text == new_list and not new_list:
return
self._filter_name_text = new_list
# Avoid refreshing on every key typed, as it can be slow. Add delay:
self._refresh_once_with_delay(delay=0.3)
def select_category(self, filter_category):
# Special case for "All" => ""
if self._filter_category == filter_category:
return
self._filter_category = filter_category
self._refresh_once_with_delay(delay=0.1)
def select_ext_source(self, ext_source):
if self._filter_ext_source == ext_source:
return False
self._filter_ext_source = ext_source
self._resync_exts()
return True
def _refresh_once_with_delay(self, delay: float):
"""Call refresh once after `delay` seconds. If called again before `delay` is passed the timer gets reset."""
async def _delayed_refresh():
await asyncio.sleep(delay)
self._item_changed(None)
with contextlib.suppress(Exception):
self._refresh_task.cancel()
self._refresh_task = asyncio.ensure_future(_delayed_refresh())
def sort_by_attr(self, attr: str):
"""Sort by item attribute."""
if attr is None:
return
if self._sort_attr != attr:
self._sort_attr = attr
self._make_sure_sorted()
def sort_direction(self, direction: SortDirection):
"""Sort by direction."""
if direction is None:
return
self._sort_direction = direction
self._make_sure_sorted()
def _make_sure_sorted(self):
# Sort order setting is global
reverse = self._sort_direction == ExtSummariesModel.SortDirection.Descending
# Attribute value getter
key_fn = lambda x: getattr(x, self._sort_attr)
cmp_fn = (lambda x, y: x >= y) if reverse else (lambda x, y: x <= y)
# Check that it is already sorted to avoid list rebuild
is_sorted_fn = lambda l: all(cmp_fn(key_fn(l[i]), key_fn(l[i + 1])) for i in range(len(l) - 1))
if not is_sorted_fn(self._sorted_summaries):
self._sorted_summaries = sorted(self._sorted_summaries, key=key_fn, reverse=reverse)
self._item_changed(None)
def destroy(self):
self._ext_summaries = {}
self._sorted_summaries = []
self._subs = None
self.tree_view = None
self.on_refresh_cb = None
class ExtsDelegate(ui.AbstractItemDelegate):
def build_branch(self, model, item, column_id, level, expanded):
"""ui.AbstractItemDelegate API: Create a branch widget that opens or closes subtree"""
return
def build_widget(self, model, item, column_id, level, expanded):
"""ui.AbstractItemDelegate API: Create a widget per column"""
if isinstance(item, ExtGroupItem):
with ui.ZStack():
with ui.VStack():
ui.Spacer(height=1)
ui.Rectangle(height=30, name="ExtensionListGroup")
with ui.HStack():
image_name = "expanded" if expanded else ""
ui.Image(
style_type_name_override="ExtensionList.Group.Icon",
name=image_name,
width=31,
height=31,
alignment=ui.Alignment.LEFT_CENTER,
)
ui.Label(
"{} ({}/{})".format(item.name, len(item.items), item.total_count),
style_type_name_override="ExtensionList.Group.Label",
)
return
h = EXT_LIST_ITEM_H - EXT_ITEM_TITLE_BAR_H
with ui.VStack(height=EXT_LIST_ITEM_H + EXT_LIST_ITEMS_MARGIN_H):
with ui.ZStack():
with ui.VStack(height=0):
ui.Rectangle(height=EXT_LIST_ITEM_H, style_type_name_override="ExtensionList.Background")
ui.Rectangle(height=EXT_LIST_ITEMS_MARGIN_H, style_type_name_override="ExtensionList.Separator")
with ui.VStack():
# Top row
with ui.HStack(height=EXT_ITEM_TITLE_BAR_H):
# Title
ui.Label(
item.title, style_type_name_override="ExtensionList.Label", name="Title", elided_text=True
)
# Toggle
ExtensionToggle(item, show_install_button=not item.is_untrusted)
ui.Spacer(width=5)
with ui.HStack():
with ui.HStack(width=EXT_LIST_ITEM_ICON_ZONE_W):
ui.Spacer()
with ui.VStack(width=EXT_ICON_SIZE[0]):
ui.Spacer()
ui.Image(item.icon_path, height=EXT_ICON_SIZE[1], style={"color": 0xFFFFFFFF})
ui.Spacer()
ui.Spacer()
with ui.ZStack():
ui.Rectangle(height=h, style_type_name_override="ExtensionList.Foreground")
with ui.VStack():
ui.Spacer(height=5)
# Category name
category = get_categories().get(item.category)
ui.Label(
category["name"],
height=0,
style_type_name_override="ExtensionList.Label",
name="Category",
)
# Extension id
ui.Label(
item.fullname,
height=0,
style_type_name_override="ExtensionList.Label",
name="Id",
elided_text=True,
)
# Version
if item.version and item.version[0:3] != (0, 0, 0):
ui.Label(
"v" + item.version,
style_type_name_override="ExtensionList.Label",
name="Version",
alignment=ui.Alignment.BOTTOM,
)
# Update available?
# if item.can_update:
with ui.VStack():
ui.Spacer(height=10)
with ui.HStack():
ui.Spacer()
if item.can_update:
ui.Image(
name="UpdateAvailable",
width=28,
height=31,
alignment=ui.Alignment.RIGHT_CENTER,
)
ui.Spacer(width=10)
if item.can_update:
ui.Label(
"UPDATE AVAILABLE", alignment=ui.Alignment.RIGHT_CENTER, name="UpdateAvailable"
)
elif item.author_group != ExtAuthorGroup.NVIDIA:
with ui.HStack():
ui.Spacer()
with ui.VStack(width=148, height=0):
ui.Spacer()
with ui.ZStack():
ui.Image(
name="Community",
width=148,
height=32,
alignment=ui.Alignment.RIGHT_BOTTOM,
)
name = item.author_group.get_ui_name()
ui.Label(name, alignment=ui.Alignment.RIGHT_CENTER, name="Community")
elif item.location_tag:
ui.Label(item.location_tag, alignment=ui.Alignment.RIGHT_CENTER, name="LocationTag")
ui.Spacer()
def build_header(self, column_id):
pass
class ExtsListWidget:
# Search configuration information as SearchKey:(SearchUiName, FilterBySearchKey, ClearSearchCache)
searches = OrderedDict(
{
"@startup": ("Startup", lambda item: item.is_startup, None),
"@featured": ("Featured", lambda item: item.is_featured or item.ext_source == ExtSource.THIRD_PARTY, None),
"@bundled": ("Bundled", lambda item: bool(item.flags & omni.ext.EXTENSION_SUMMARY_FLAG_BUILTIN), None),
"@user": ("User", lambda item: item.author_group == ExtAuthorGroup.USER, None),
"@app": ("App", lambda item: item.is_app, None),
"@enabled": ("Enabled", lambda item: bool(item.flags & omni.ext.EXTENSION_SUMMARY_FLAG_ANY_ENABLED), None),
"@update": ("Update Available", lambda item: item.can_update, None),
"@installed": (
"Installed",
lambda item: bool(item.flags & omni.ext.EXTENSION_SUMMARY_FLAG_INSTALLED),
None,
),
"@remote": ("Remote", lambda item: not bool(item.flags & omni.ext.EXTENSION_SUMMARY_FLAG_BUILTIN), None),
}
)
# remove "Featured" when not in use
if not are_featured_exts_enabled():
del searches["@featured"]
def __init__(self):
# Extensions List Data Model
self._model = ExtSummariesModel()
self._model.on_refresh_cb = self._on_ext_list_refresh
menu_style = {
"padding": 2,
"Menu.Item.CheckMark": {"color": cl.shade(cl("#34C7FF"))},
"Titlebar.Background": {"background_color": cl.shade(cl("#1F2123"))},
"Titlebar.Title": {"color": cl.shade(cl("#848484"))},
"Titlebar.Reset": {"background_color": 0},
"Titlebar.Reset.Label": {"color": cl.shade(cl("#2E86A9"))},
"Titlebar.Reset.Label:hovered": {"color": cl.shade(cl("#34C7FF"))},
}
# Delegate to build list rows.
self._delegate = ExtsDelegate()
self.set_show_graph_fn(None)
self.set_show_properties_fn(None)
# Filter button
self._filter_button: Optional[FilterButton] = None
# Sort menu. One day it will be a hamburger. One can dream.
self._sortby_menu = ui.Menu("Sort By", style=menu_style, menu_compatibility=False, tearable=False)
self.rebuild_sortby_menu()
self._options_menu = ui.Menu("Options", style=menu_style, menu_compatibility=False, tearable=False)
self.rebuild_options_menu()
# Extension creation menu
self._create_menu = ui.Menu("Create", style=menu_style, menu_compatibility=False, tearable=False)
self.rebuild_create_menu()
def _menu_header(self, title, clicked_fn):
with ui.ZStack(height=0):
ui.Rectangle(style_type_name_override="Titlebar.Background")
with ui.VStack():
ui.Spacer(height=3)
with ui.HStack():
ui.Spacer(width=10)
ui.Label(title, style_type_name_override="Titlebar.Title")
ui.Spacer()
ui.Button(
"Reset all" if clicked_fn else " ",
style_type_name_override="Titlebar.Reset",
clicked_fn=clicked_fn,
)
ui.Spacer(width=10)
ui.Spacer(height=2)
def rebuild_filter_menu(self):
if self._filter_button:
option_items = self._build_filter_items()
self._filter_button.model.rebuild_items(option_items)
def rebuild_sortby_menu(self):
def reset_sort():
asyncio.ensure_future(update_sort("name", ExtSummariesModel.SortDirection.Ascending))
async def update_sort(sb: str, sd: ExtSummariesModel.SortDirection):
if sb:
await omni.kit.app.get_app().next_update_async()
self._model.sort_by_attr(sb)
if sd is not ExtSummariesModel.SortDirection.NONE:
await omni.kit.app.get_app().next_update_async()
self._model.sort_direction(sd)
sort_by = self._model._sort_attr
sort_direction = self._model._sort_direction
# change button color
self._sortby_button.name = (
"sortby"
if sort_by == "name" and sort_direction == ExtSummariesModel.SortDirection.Ascending
else "sortby_on"
)
self._sortby_menu.clear()
with self._sortby_menu:
self._menu_header("Sort", reset_sort)
ui.MenuItem(
"Name",
triggered_fn=lambda: asyncio.ensure_future(
update_sort("name", ExtSummariesModel.SortDirection.NONE)
),
checkable=True,
checked=sort_by == "name",
)
ui.MenuItem(
"Enabled",
triggered_fn=lambda: asyncio.ensure_future(
update_sort("enabled", ExtSummariesModel.SortDirection.NONE)
),
checkable=True,
checked=sort_by == "enabled",
)
ui.MenuItem(
"Publish Date",
triggered_fn=lambda: asyncio.ensure_future(
update_sort("publish_date_rev", ExtSummariesModel.SortDirection.NONE)
),
checkable=True,
checked=sort_by == "publish_date_rev",
)
ui.Separator()
ui.MenuItem(
"Ascending",
triggered_fn=lambda: asyncio.ensure_future(
update_sort(None, ExtSummariesModel.SortDirection.Ascending)
),
checkable=True,
checked=sort_direction == ExtSummariesModel.SortDirection.Ascending,
)
ui.MenuItem(
"Descending",
triggered_fn=lambda: asyncio.ensure_future(
update_sort(None, ExtSummariesModel.SortDirection.Descending)
),
checkable=True,
checked=sort_direction == ExtSummariesModel.SortDirection.Descending,
)
asyncio.ensure_future(update_sort(None, ExtSummariesModel.SortDirection.NONE))
def rebuild_options_menu(self):
self._options_menu.clear()
with self._options_menu:
self._menu_header("Options", None)
ui.MenuItem("Settings", triggered_fn=self._show_properties)
ui.MenuItem("Refresh", triggered_fn=self._model.refresh_all)
ui.MenuItem("Resync Registry", triggered_fn=self._resync_registry)
ui.MenuItem("Show Extension Graph", triggered_fn=self._show_graph)
ui.MenuItem("Import Extension", triggered_fn=import_ext)
def rebuild_create_menu(self):
def open_url(url):
import webbrowser
webbrowser.open(url)
self._create_menu.clear()
with self._create_menu:
self._menu_header("Create Extension", None)
ui.MenuItem("New Extension Template Project", triggered_fn=create_new_extension_template)
for name, url in get_open_example_links():
ui.MenuItem(name, triggered_fn=lambda u=url: open_url(u))
def _on_key_pressed(self, key, mod, pressed):
"""Allow up/down arrow to be used to select prev/next extension"""
def _select_next(treeview: ui.TreeView, model: ui.AbstractItemModel, after=True):
full_list = model.get_item_children(None)
selection = treeview.selection
if not selection:
treeview.selection = [full_list[0]]
else:
index = full_list.index(selection[0])
index += 1 if after else -1
if index < 0 or index >= len(full_list):
return
treeview.selection = [full_list[index]]
if not pressed:
return
if mod == 0 and key == int(carb.input.KeyboardInput.DOWN):
_select_next(self.tree_view, self._model, after=True)
elif mod == 0 and key == int(carb.input.KeyboardInput.UP):
_select_next(self.tree_view, self._model, after=False)
def _on_selection_changed(self, selection):
item = selection[0] if len(selection) > 0 else None
if item and isinstance(item, ExtGroupItem):
self.tree_view.set_expanded(item, not self.tree_view.is_expanded(item), False)
self.tree_view.clear_selection()
else:
self._ext_selected_fn(item)
def _on_ext_list_refresh(self):
cnt = defaultdict(int)
for group in self._model._groups:
cnt[group.ext_source] += len(group.items)
for source, value in cnt.items():
self._ext_source_selector.set_badge_number(source, value)
async def __update_filter(self, search_key: str) -> None:
if search_key:
self._search.toggle_filter(search_key)
await omni.kit.app.get_app().next_update_async()
self._filter_by_text(self._search.get_text(), self._search.get_filters())
def _build_filter_items(self) -> List[OptionItem]:
option_items = []
filters = self._search.get_filters()
for search_key, (search_description, _, _) in self.searches.items():
option_item = OptionItem(
search_description,
on_value_changed_fn=lambda m, sk=search_key: asyncio.ensure_future(self.__update_filter(sk)),
)
option_item.model.set_value(search_key in filters)
option_items.append(option_item)
return option_items
def _build_filter_button(self):
option_items = self._build_filter_items()
self._filter_button = FilterButton(option_items)
def build(self):
with ui.VStack(spacing=3):
with ui.HStack(height=0):
# Create button
ui.Button(name="create", width=22, height=22, clicked_fn=self._create_menu.show)
# Search field
with ui.HStack(width=ui.Fraction(2)):
self._search = SearchWidget(
on_search_fn=lambda t: self._filter_by_text(t, self._search.get_filters())
)
if are_featured_exts_enabled():
self._search.toggle_filter("@featured")
ui.Spacer(width=10)
# Category selector
category_list = [("All", "")] + [(v["name"], c) for c, v in get_categories().items()]
self._category_combo = ui.ComboBox(0, *[c[0] for c in category_list], style={"padding": 4})
self._category_combo.model.add_item_changed_fn(
lambda model, item: self._select_category(category_list[model.get_item_value_model(item).as_int][1])
)
ui.Spacer(width=5)
# Filter button
self._build_filter_button()
# Sort-By button
self._sortby_button = ui.Button(name="sortby", width=24, height=24, clicked_fn=self._sortby_menu.show)
# Properies
ui.Button(name="options", width=24, height=24, clicked_fn=self._options_menu.show)
# Source selector (community tab)
self._ext_source_selector = None
if is_community_tab_enabled():
self._ext_source_selector = ExtSourceSelector(self._select_ext_source)
frame = ui.ScrollingFrame(
horizontal_scrollbar_policy=ui.ScrollBarPolicy.SCROLLBAR_ALWAYS_OFF,
vertical_scrollbar_policy=ui.ScrollBarPolicy.SCROLLBAR_ALWAYS_ON,
style_type_name_override="TreeView",
)
with frame:
with ui.ZStack():
self.tree_view = ui.TreeView(
self._model,
header_visible=False,
delegate=self._delegate,
column_widths=[ui.Fraction(1)],
root_visible=False,
keep_expanded=False,
)
self._model.tree_view = self.tree_view
self.tree_view.set_selection_changed_fn(self._on_selection_changed)
# make that public
self.clear_selection = self.tree_view.clear_selection
frame.set_key_pressed_fn(self._on_key_pressed)
def set_show_graph_fn(self, fn: Callable):
self._show_graph_fn = fn
def set_ext_selected_fn(self, fn: Callable):
self._ext_selected_fn = fn
def _resync_registry(self):
self._model.resync_registry()
def _show_graph(self):
if self._show_graph_fn:
self._show_graph_fn()
def set_show_properties_fn(self, fn: Callable):
self._show_properties_fn = fn
def _show_properties(self):
if self._show_properties_fn:
self._show_properties_fn()
def _filter_by_text(self, filter_text: str, filters: list):
"""Set the search filter string to the models and widgets"""
self._model.filter_by_text(filter_text, filters)
def _select_category(self, category: str):
"""Set the category to show"""
self._model.select_category(category)
def _select_ext_source(self, ext_source):
self._model.select_ext_source(ext_source)
def destroy(self):
self._delegate = None
if self._filter_button:
self._filter_button.destroy()
self._filter_button = None
self._sortby_menu = None
self._options_menu = None
self._search.destroy()
self._search = None
self._category_combo = None
self._model.destroy()
self._model = None
| 33,624 | Python | 38.235706 | 120 | 0.545444 |
omniverse-code/kit/exts/omni.kit.window.extensions/omni/kit/window/extensions/ext_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.
#
import omni.kit.app
import omni.kit.commands
class ToggleExtension(omni.kit.commands.Command):
"""
Toggle extension **Command**. Enables/disables an extension.
Args:
ext_id(str): Extension id.
enable(bool): Enable or disable.
"""
def __init__(self, ext_id: str, enable: bool):
self._ext_id = ext_id
self._enable = enable
self._ext_manager = omni.kit.app.get_app().get_extension_manager()
def do(self):
manager = omni.kit.app.get_app().get_extension_manager()
manager.set_extension_enabled_immediate(self._ext_id, self._enable)
omni.kit.app.send_telemetry_event(
"omni.kit.window.extensions@enable_ext", data1=self._ext_id, value1=float(self._enable)
)
| 1,199 | Python | 35.363635 | 99 | 0.694746 |
omniverse-code/kit/exts/omni.kit.window.extensions/omni/kit/window/extensions/ext_template.py | # pylint: disable=protected-access
import asyncio
import glob
import os
import re
import sys
from datetime import datetime
from itertools import chain
from pathlib import Path
from string import Template
import carb.tokens
import omni.ext
import omni.kit.app
from . import ext_controller
from .ext_export_import import _ask_user_for_path
from .utils import open_in_vscode_if_enabled, show_ok_popup, show_user_input_popup
def substitute_tokens_in_file(path, tokens):
try:
with open(path, "r", encoding="utf-8") as f:
content = Template(f.read()).safe_substitute(tokens)
except UnicodeDecodeError:
# Non-text file, ignore
return
with open(path, "w", encoding="utf-8") as f:
f.write(content)
def is_subpath(path, root):
return root in path.parents
def _copy_template(src, dst, ext_id, python_module_path):
import shutil
from distutils.dir_util import copy_tree # noqa: PLW0612, PLW4901
from os.path import join
copy_tree(join(src, "tools"), join(dst, "tools"))
copy_tree(join(src, "vscode"), join(dst, ".vscode"))
shutil.copy(join(src, "README.md"), join(dst, "README.md"))
shutil.copy(join(src, "gitignore"), join(dst, ".gitignore"))
shutil.copy(join(src, "link_app.bat"), join(dst, "link_app.bat"))
shutil.copy(join(src, "link_app.sh"), join(dst, "link_app.sh"))
copy_tree(join(src, "exts", "[ext_id]", "[python_module]"), join(dst, "exts", ext_id, python_module_path))
copy_tree(join(src, "exts", "[ext_id]", "config"), join(dst, "exts", ext_id, "config"))
copy_tree(join(src, "exts", "[ext_id]", "docs"), join(dst, "exts", ext_id, "docs"))
copy_tree(join(src, "exts", "[ext_id]", "data"), join(dst, "exts", ext_id, "data"))
async def _create_new_extension_template():
export_path = await _ask_user_for_path(
is_export=True, apply_button_label="Select", title="Choose a location for your extension project"
)
if not export_path:
return
project_folder = await show_user_input_popup(
"Name the extension project. This is the root folder of the repository.", "Project Name: ", "kit-exts-project"
)
export_path = os.path.join(export_path, project_folder)
# Create folder
os.makedirs(export_path, exist_ok=True)
if len(os.listdir(export_path)) > 0:
await show_ok_popup("Error", f"Folder already exist: {export_path}")
return
template_path = carb.tokens.get_tokens_interface().resolve("${omni.kit.window.extensions}/ext_template")
if sys.platform == "win32":
kit_exec = "kit.exe"
python_exe = "python.exe"
else:
kit_exec = "kit"
python_exe = "bin/python3"
ext_id = await show_user_input_popup("Choose Extension Name:", "ext_id: ", "company.hello.world")
ext_name = "".join([token.capitalize() for token in ext_id.split(".")])
ext_title = " ".join(ext_id.split("."))
ext_id_pattern = r"^[a-zA-Z0-9._]+$"
if not re.match(ext_id_pattern, ext_id):
await show_ok_popup("Error", f"Invalid extension name: {ext_id}. Supported chars: {ext_id_pattern}")
return
python_module = ext_id
python_module_path = ext_id.replace(".", "/")
# copy template folder
_copy_template(template_path, export_path, ext_id, python_module_path)
# Find app root
def _look_for_app_root(path):
path = Path(path)
for p in chain([path], path.parents):
for kit_subpath in ["", "kit"]:
if p.joinpath(kit_subpath, kit_exec).is_file():
return str(p), str(kit_subpath)
return None, None
app_path = carb.tokens.get_tokens_interface().resolve("${app}")
app_root_path, kit_subpath = _look_for_app_root(app_path)
if not app_root_path:
await show_ok_popup("Error", f"Can't find app root in {app_root_path}")
return
# build vscode exts search paths:
ext_relative_paths = []
app = omni.kit.app.get_app()
manager = app.get_extension_manager()
for folder in manager.get_folders():
path_type = folder["type"]
if path_type == omni.ext.ExtensionPathType.COLLECTION:
path = Path(folder["path"])
if is_subpath(path, Path(app_root_path)):
for p in glob.glob(f"{path}/*"):
if os.path.isdir(p):
s = ' "${{workspaceFolder}}/app/{}",'.format(
Path(p).relative_to(app_root_path).as_posix()
)
ext_relative_paths.append(s)
export_exts_path = f"{export_path}/exts"
export_app_path = f"{export_path}/app"
# substitute all tokens
tokens = {
"ext_id": ext_id,
"ext_name": ext_name,
"ext_title": ext_title,
"kit_subpath": kit_subpath + "/" if kit_subpath else "",
"python_exe": python_exe,
"python_module": python_module,
"ext_search_paths": "\n".join(ext_relative_paths),
"export_path": export_path,
"export_exts_path": export_exts_path,
"export_app_path": export_app_path,
"author": os.environ.get("USERNAME", "please fill in author information"),
"today": datetime.today().strftime("%Y-%m-%d"),
}
for folder, _, files in os.walk(export_path):
for filename in files:
substitute_tokens_in_file(os.path.join(folder, filename), tokens)
# create link
omni.ext.create_link(export_app_path, app_root_path)
# try open in vscode:
open_in_vscode_if_enabled(export_path, prefer_vscode=True)
# add new search path (remove + add will trigger fs search for sure)
manager.remove_path(export_exts_path)
manager.add_path(export_exts_path, omni.ext.ExtensionPathType.COLLECTION_USER)
await app.next_update_async()
# Enable that one ext and make it autoload
manager.set_extension_enabled(ext_id, True)
ext_controller.toggle_autoload(f"{ext_id}-1.0.0", True)
# Focus on it
from .extension import get_instance
instance = get_instance()()
instance._window._ext_info_widget._refresh_once_next_frame()
instance._window._exts_list_widget._search.set_text(ext_id)
def create_new_extension_template():
asyncio.ensure_future(_create_new_extension_template())
| 6,299 | Python | 35 | 118 | 0.622003 |
omniverse-code/kit/exts/omni.kit.window.extensions/omni/kit/window/extensions/exts_properties_registries.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 carb.dictionary
import carb.settings
import omni.kit.app
import omni.ui as ui
from .common import REGISTRIES_CHANGED_EVENT, USER_REGISTRIES_SETTING, get_registries
from .ext_components import SimpleCheckBox
from .styles import get_style
from .utils import copy_text, get_setting
DEFAUT_PUBLISH_SETTING = "app/extensions/registryPublishDefault"
EMPTY_REGISTRY_NAME = "[enter_name]"
REGISTRIES_COLUMNS = ["name", "url", "default", "user"]
class RegistryItem(ui.AbstractItem):
def __init__(self, name, url, is_user=True, is_default=False, add_dummy=False):
super().__init__()
self.name_model = ui.SimpleStringModel(name)
self.url_model = ui.SimpleStringModel(url)
self.default_model = ui.SimpleBoolModel(is_default)
self.is_user = is_user
self.add_dummy = add_dummy
class RegistriesModel(ui.AbstractItemModel):
def __init__(self):
super().__init__()
self._children = []
self._load()
self._add_dummy = RegistryItem("", "", add_dummy=True)
self._default_changing = False
def destroy(self):
self._children = []
def get_item_children(self, item):
"""Returns all the children when the widget asks it."""
if item is not None:
return []
return self._children + [self._add_dummy]
def get_item_value_model_count(self, item):
"""The number of columns"""
return 4
def get_item_value_model(self, item, column_id):
if column_id == 0:
return item.name_model
if column_id == 1:
return item.url_model
return None
def _load(self):
self._children = []
default_registry = get_setting(DEFAUT_PUBLISH_SETTING, "")
# Registries
ui.Label("Registries:")
for name, url, is_user in get_registries():
self._children.append(RegistryItem(name, url, is_user, is_default=(name == default_registry)))
self._item_changed(None)
def add_empty(self):
self._children.append(RegistryItem(EMPTY_REGISTRY_NAME, "", is_user=True))
self._item_changed(None)
def remove_item(self, item):
self._children.remove(item)
self._item_changed(None)
self.save()
def save(self):
registries = []
for child in self._children:
if child.is_user:
name = child.name_model.as_string
url = child.url_model.as_string
if name and url:
# Auto fill name?
if name == EMPTY_REGISTRY_NAME:
name = "/".join(url.split("/")[-2:]) # Take last 2
child.name_model.as_string = name
registries.append({"name": name, "url": url})
settings_dict = carb.settings.get_settings().get_settings_dictionary("")
settings_dict[USER_REGISTRIES_SETTING[1:]] = registries
# Notify registry
omni.kit.app.get_app().get_message_bus_event_stream().push(REGISTRIES_CHANGED_EVENT)
def set_default(self, item, value):
# to avoid recursion
if self._default_changing:
return
self._default_changing = True
for c in self._children:
c.default_model.as_bool = False
item.default_model.as_bool = value
carb.settings.get_settings().set(DEFAUT_PUBLISH_SETTING, item.name_model.as_string if value else "")
self._default_changing = False
class EditableDelegate(ui.AbstractItemDelegate):
def __init__(self):
super().__init__()
self._subscription = None
self._context_menu = ui.Menu("Context menu")
def destroy(self):
self._subscription = None
self._context_menu = None
def _show_copy_context_menu(self, x, y, button, modifier, text):
if button != 1:
return
self._context_menu.clear()
with self._context_menu:
ui.MenuItem("Copy", triggered_fn=lambda: copy_text(text))
self._context_menu.show()
def build_widget(self, model, item, column_id, level, expanded):
"""Create a widget per column per item"""
with ui.HStack(width=20):
value_model = model.get_item_value_model(item, column_id)
if column_id in (0, 1):
stack = ui.ZStack(height=20)
with stack:
label = ui.Label(value_model.as_string, width=500, name=("config" if item.is_user else "builtin"))
field = ui.StringField(value_model, visible=False)
# Start editing when double clicked
stack.set_mouse_double_clicked_fn(
lambda x, y, b, _, f=field, l=label, m=model, i=item: self.on_double_click(b, f, l, m, i)
)
# Right click is copy menu
stack.set_mouse_pressed_fn(
lambda x, y, b, m, t=value_model.as_string: self._show_copy_context_menu(x, y, b, m, t)
)
elif column_id == 2:
if not item.add_dummy:
with ui.HStack():
ui.Spacer(width=10)
SimpleCheckBox(
item.default_model.as_bool,
lambda value, item=item: model.set_default(item, value),
model=item.default_model,
text="",
)
ui.Spacer(width=20)
else:
if item.is_user:
def on_click():
if item.add_dummy:
model.add_empty()
else:
model.remove_item(item)
with ui.HStack():
ui.Spacer(width=10)
ui.Button(
name=("add" if item.add_dummy else "remove"),
style_type_name_override="ItemButton",
width=20,
height=20,
clicked_fn=on_click,
)
ui.Spacer()
def on_double_click(self, button, field, label, model, item):
"""Called when the user double-clicked the item in TreeView"""
if button != 0:
return
if item.add_dummy:
return
if not item.is_user:
copy_text(field.model.as_string)
return
# Make Field visible when double clicked
field.visible = True
field.focus_keyboard()
# When editing is finished (enter pressed of mouse clicked outside of the viewport)
self._subscription = field.model.subscribe_end_edit_fn(
lambda m, f=field, l=label, md=model: self.on_end_edit(m.as_string, f, l, md)
)
def on_end_edit(self, text, field, label, model):
"""Called when the user is editing the item and pressed Enter or clicked outside of the item"""
field.visible = False
label.text = text
self._subscription = None
if text:
model.save()
def build_header(self, column_id):
with ui.HStack():
ui.Spacer(width=10)
ui.Label(REGISTRIES_COLUMNS[column_id], name="header")
class ExtsRegistriesWidget:
def __init__(self):
self._model = RegistriesModel()
self._delegate = EditableDelegate()
with ui.VStack(style=get_style(self)):
ui.Spacer(height=20)
with ui.ScrollingFrame(
height=200,
horizontal_scrollbar_policy=ui.ScrollBarPolicy.SCROLLBAR_ALWAYS_OFF,
vertical_scrollbar_policy=ui.ScrollBarPolicy.SCROLLBAR_ALWAYS_OFF,
style_type_name_override="TreeView",
):
tree_view = ui.TreeView(
self._model,
delegate=self._delegate,
root_visible=False,
header_visible=True,
)
tree_view.column_widths = [ui.Fraction(1), ui.Fraction(4), ui.Pixel(60), ui.Pixel(40)]
ui.Spacer(height=10)
def destroy(self):
self._model.destroy()
self._model = None
self._delegate.destroy()
self._delegate = None
| 8,863 | Python | 35.03252 | 118 | 0.55207 |
omniverse-code/kit/exts/omni.kit.window.extensions/omni/kit/window/extensions/ext_status_bar.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 datetime import datetime
import omni.ext
import omni.kit.app
import omni.ui as ui
from omni.ui import color as cl
NEUTRAL = cl("#FFFFFF")
SUCCESS = cl("#3794ff")
FAILURE = cl("#CC0000")
class ExtStatusBar:
def __init__(self):
self._label = ui.Label("", height=8)
app = omni.kit.app.get_app()
bus = app.get_message_bus_event_stream()
self._subs = []
self._set_status("")
def sub(e, message, color):
self._subs.append(bus.create_subscription_to_pop_by_type(e, lambda e: self._set_status(message, color, e)))
sub(omni.ext.EVENT_REGISTRY_REFRESH_BEGIN, "Syncing Registry...", NEUTRAL)
sub(
omni.ext.EVENT_REGISTRY_REFRESH_END_SUCCESS,
"Registry Synced: " + datetime.now().strftime("%H:%M:%S"),
SUCCESS,
)
sub(omni.ext.EVENT_REGISTRY_REFRESH_END_FAILURE, "Registry Sync Failed.", FAILURE)
sub(omni.ext.EVENT_EXTENSION_PULL_BEGIN, "Installing: {}...", NEUTRAL)
sub(omni.ext.EVENT_EXTENSION_PULL_END_SUCCESS, "Installed successfully: {}", SUCCESS)
sub(omni.ext.EVENT_EXTENSION_PULL_END_FAILURE, "Install failed: {}", FAILURE)
def _set_status(self, status, color=NEUTRAL, evt=None):
if evt and evt.payload["packageId"]:
status = status.format(evt.payload["packageId"])
self._status = status
self._status_color = color
self._refresh_ui()
def _refresh_ui(self):
self._label.style = {"font_size": 14, "color": self._status_color}
self._label.text = self._status
| 2,023 | Python | 35.799999 | 119 | 0.655956 |
omniverse-code/kit/exts/omni.kit.window.extensions/omni/kit/window/extensions/exts_properties_widget.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 carb.dictionary
import carb.settings
import carb.tokens
import omni.kit.app
import omni.ui as ui
from .common import COMMUNITY_TAB_TOGGLE_EVENT, SettingBoolValue, get_options
from .exts_list_widget import ExtSummaryItem
from .exts_properties_paths import ExtsPathsWidget
from .exts_properties_registries import ExtsRegistriesWidget
from .styles import get_style
from .utils import cleanup_folder, copy_text, ext_id_to_name_version, get_setting, version_to_str
class ExtsPropertiesWidget:
def __init__(self):
self._ext_manager = omni.kit.app.get_app().get_extension_manager()
self._ext_change_sub = self._ext_manager.get_change_event_stream().create_subscription_to_pop(
lambda *_: self._refresh(), name="ExtPropertiesWidget"
)
self._registries_widget = None
self._paths_widget = None
self._frame = ui.Frame()
def destroy(self):
self._clean_widgets()
self._ext_change_sub = None
self._frame = None
def set_visible(self, visible):
self._frame.visible = visible
self._refresh()
def _clean_widgets(self):
if self._registries_widget:
self._registries_widget.destroy()
self._registries_widget = None
if self._paths_widget:
self._paths_widget.destroy()
self._paths_widget = None
def _refresh(self):
if not self._frame.visible:
return
self._clean_widgets()
# Build UI
with self._frame:
with ui.ScrollingFrame(
horizontal_scrollbar_policy=ui.ScrollBarPolicy.SCROLLBAR_ALWAYS_OFF,
vertical_scrollbar_policy=ui.ScrollBarPolicy.SCROLLBAR_ALWAYS_ON,
):
with ui.ZStack(style=get_style(self)):
ui.Rectangle(style_type_name_override="Properies.Background")
with ui.HStack():
ui.Spacer(width=20)
with ui.VStack(spacing=4, height=0):
def add_open_button(text, url):
def open_url(url_=url):
# Import it here instead of on the file root because it has long import time.
import webbrowser
webbrowser.open(url_)
ui.Button(text, width=0, clicked_fn=open_url, tooltip=url)
ui.Spacer(height=10)
# Extension Search Paths
with ui.CollapsableFrame("Extension Search Paths", collapsed=False):
self._paths_widget = ExtsPathsWidget()
# Registries
with ui.CollapsableFrame("Extension Registries", collapsed=False):
self._registries_widget = ExtsRegistriesWidget()
with ui.CollapsableFrame("Extension System Cache", collapsed=True):
with ui.VStack():
ui.Spacer(height=10)
cache_path = get_setting("/exts/omni.kit.registry.nucleus/cachePath", None)
if cache_path:
cache_path = carb.tokens.get_tokens_interface().resolve(cache_path)
with ui.HStack():
add_open_button("Open", cache_path)
def clean(p_=cache_path):
cleanup_folder(p_)
ui.Button(
"Clean",
width=0,
clicked_fn=clean,
tooltip="Remove all downloaded extensions",
)
ui.Label(f"Path: {cache_path}")
ui.Spacer(height=10)
with ui.CollapsableFrame("Options", collapsed=True):
with ui.VStack():
ui.Spacer(height=10)
def add_option(option: SettingBoolValue, name: str, evt: int = None):
# Publishing enabled
with ui.HStack(width=60):
cb = ui.CheckBox()
def on_change(model):
option.set_bool(model.get_value_as_bool())
if evt:
omni.kit.app.get_app().get_message_bus_event_stream().push(evt)
cb.model.set_value(option.get())
cb.model.add_value_changed_fn(on_change)
ui.Label(name)
options = get_options()
add_option(options.publishing, "Publishing Enabled")
if options.community_tab is not None:
ui.Spacer(height=10)
add_option(
options.community_tab,
"Show Community Extensions",
COMMUNITY_TAB_TOGGLE_EVENT,
)
ui.Spacer(height=10)
# Export all exts data
with ui.CollapsableFrame("Miscellaneous", collapsed=True):
with ui.VStack():
ui.Spacer(height=10)
ext_summaries = self._ext_manager.fetch_extension_summaries()
total_cnt = len(ext_summaries)
builtin_cnt = sum(
bool(e["flags"] & omni.ext.EXTENSION_SUMMARY_FLAG_BUILTIN)
for e in ext_summaries
)
installed_cnt = sum(
bool(e["flags"] & omni.ext.EXTENSION_SUMMARY_FLAG_INSTALLED)
for e in ext_summaries
)
ui.Label(f"Total Extensions: {total_cnt}", height=20)
ui.Label(f"Bultin Extensions: {builtin_cnt}", height=20)
ui.Label(f"Installed Extensions: {installed_cnt}", height=20)
registry_count = len(self._ext_manager.get_registry_extensions())
ui.Label(f"Registry Packages: {registry_count}", height=20)
ui.Spacer(height=10)
ui.Button(
"Copy all exts as CSV",
width=100,
height=30,
clicked_fn=lambda: self.export_all_exts(ext_summaries),
)
# Export all exts data
ui.Button(
"Copy enabled exts as .kit file (top level)",
width=100,
height=30,
clicked_fn=lambda: self.export_enabled_exts_as_kit_file(only_top_level=True),
)
# Export all exts data
ui.Button(
"Copy enabled exts as .kit file (all)",
width=100,
height=30,
clicked_fn=lambda: self.export_enabled_exts_as_kit_file(only_top_level=False),
)
ui.Spacer()
ui.Spacer(width=20)
def export_all_exts(self, ext_summaries):
"""Export all exts in CSV format with some of config params. print and copy result."""
ext_sum_dict = {}
for ext_s in ext_summaries:
item = ExtSummaryItem()
item.refresh(ext_s)
ext_sum_dict[ext_s["fullname"]] = item
fields_to_export = [
"package/name",
"package/version",
"can_update,latest_version", # special case
"state/enabled",
"isKitFile",
"package/category",
"package/title",
"package/description",
"package/authors",
"package/repository",
"package/keywords",
"package/readme",
"package/changelog",
"package/preview_image",
"package/icon",
"core/reloadable",
]
# Header
output = ",".join(["id"] + fields_to_export) + "\n"
# Per ext row data
for ext in self._ext_manager.get_extensions():
d = self._ext_manager.get_extension_dict(ext["id"])
row = ext["id"] + ","
for f in fields_to_export:
if f.startswith("can_update"): # special case, do both rows at once
item = ext_sum_dict.get(ext["name"], None)
if item:
latest_version = version_to_str(item.latest_ext["version"][:4])
row += f'"{item.can_update}",'
row += f'"{latest_version}",'
else:
row += ",,"
else:
row += f'"{str(d.get(f, ""))}",'
row = row.replace("\n", r"\n")
output += row + "\n"
print(output)
copy_text(output)
def export_enabled_exts_as_kit_file(self, only_top_level=True):
"""Export all topmost exts in .kit format. print and copy result."""
excludes = {"omni.kit.registry.nucleus", "omni.kit.profile_python"}
all_deps = set()
all_exts = set()
for ext in self._ext_manager.get_extensions():
if ext["enabled"]:
ext_id = ext["id"]
info = self._ext_manager.get_extension_dict(ext_id)
deps = info.get("state/dependencies", [])
all_exts.add(ext_id)
all_deps.update(deps)
output = "[dependencies]\n"
exported_exts = (all_exts - all_deps) if only_top_level else all_exts
for e in exported_exts:
if "-" not in e:
print(f"skipping ext 1.0: {e}")
continue
name, version = ext_id_to_name_version(e)
if name in excludes:
continue
output += '"{0}" = {{ version = "{1}", exact = true }}\n'.format(name, version)
print(output)
copy_text(output)
| 12,066 | Python | 42.88 | 118 | 0.436184 |
omniverse-code/kit/exts/omni.kit.window.extensions/omni/kit/window/extensions/window.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 Callable
import omni.ui as ui
from .ext_info_widget import ExtInfoWidget
from .ext_status_bar import ExtStatusBar
from .exts_graph_window import ExtsGraphWindow
from .exts_list_widget import ExtsListWidget
from .exts_properties_widget import ExtsPropertiesWidget
from .styles import get_style
class PageSwitcher:
def __init__(self):
self._main_pages = {}
self._selected_page = None
def add_page(self, name, widget):
widget.set_visible(False)
self._main_pages[name] = widget
def select_page(self, name, force=False):
if self._selected_page == name and not force:
return
# Set previous inviisible
selected_page = self._main_pages.get(self._selected_page, None)
if selected_page:
selected_page.set_visible(False)
# Set new and make visible
self._selected_page = name
selected_page = self._main_pages.get(self._selected_page, None)
if selected_page:
selected_page.set_visible(True)
def destroy(self):
self._main_pages = {}
PAGE_GRAPH = "graph"
PAGE_INFO = "info"
PAGE_PROPERTIES = "properties"
class ExtsWindow:
"""Extensions window"""
def __init__(self, on_visibility_changed_fn: Callable):
self._window = ui.Window("Extensions", width=1300, height=800, flags=ui.WINDOW_FLAGS_NO_SCROLLBAR)
self._window.set_visibility_changed_fn(on_visibility_changed_fn)
# Tree view style
self._exts_list_widget = ExtsListWidget()
self._page_switcher = PageSwitcher()
# Build UI
with self._window.frame:
with ui.HStack(style=get_style(self)):
with ui.ZStack(width=0):
# Draggable splitter
with ui.Placer(offset_x=392, draggable=True, drag_axis=ui.Axis.X):
ui.Rectangle(width=10, name="Splitter")
with ui.HStack():
with ui.VStack():
# Extensions List Widget (on the left)
self._exts_list_widget.build()
# Status bar
self._status_bar = ExtStatusBar()
ui.Spacer(width=10)
with ui.ScrollingFrame(vertical_scrollbar_policy=ui.ScrollBarPolicy.SCROLLBAR_ALWAYS_OFF):
with ui.HStack():
# Selected Extension info
self._ext_info_widget = ExtInfoWidget()
self._page_switcher.add_page(PAGE_INFO, self._ext_info_widget)
# Graph
self._exts_graph = ExtsGraphWindow()
self._page_switcher.add_page(PAGE_GRAPH, self._exts_graph)
# Properties
self._exts_properties = ExtsPropertiesWidget()
self._page_switcher.add_page(PAGE_PROPERTIES, self._exts_properties)
# Setup show graph callback
self._exts_list_widget.set_show_graph_fn(lambda: self._show_graph(None))
self._exts_list_widget.set_show_properties_fn(self._show_properties)
self._exts_list_widget.set_ext_selected_fn(self._select_ext)
self._ext_info_widget.set_show_graph_fn(self._show_graph)
self._select_ext(None)
def _show_graph(self, ext_id: str):
self._exts_list_widget.clear_selection()
self._exts_graph.select_ext(ext_id)
self._page_switcher.select_page(PAGE_GRAPH, force=True)
def _show_properties(self):
self._exts_list_widget.clear_selection()
self._page_switcher.select_page(PAGE_PROPERTIES)
def _select_ext(self, ext_summary):
self._page_switcher.select_page(PAGE_INFO)
self._ext_info_widget.select_ext(ext_summary)
def destroy(self):
"""
Called by extension before destroying this object. It doesn't happen automatically.
Without this hot reloading doesn't work.
"""
self._exts_graph.destroy()
self._exts_graph = None
self._ext_info_widget.destroy()
self._ext_info_widget = None
self._exts_list_widget.destroy()
self._exts_list_widget = None
self._exts_properties.destroy()
self._exts_properties = None
self._page_switcher.destroy()
self._page_switcher = None
self._window = None
| 4,868 | Python | 37.039062 | 106 | 0.609901 |
omniverse-code/kit/exts/omni.kit.window.extensions/omni/kit/window/extensions/tests/test_properties_paths.py | import os
import tempfile
import omni.kit.app
import omni.kit.test
import omni.kit.window.extensions
# pylint: disable=protected-access
class TestPaths(omni.kit.test.AsyncTestCase):
async def test_add_remove_user_path(self):
manager = omni.kit.app.get_app().get_extension_manager()
def get_paths():
return {p["path"] for p in manager.get_folders()}
async def wait():
await omni.kit.app.get_app().next_update_async()
await omni.kit.app.get_app().next_update_async()
def get_model():
omni.kit.window.extensions.get_instance()()
return instance._window._exts_properties._paths_widget._model
instance = omni.kit.window.extensions.get_instance()()
instance.show_window(True)
instance._window._show_properties()
await wait()
paths_before = get_paths()
with tempfile.TemporaryDirectory() as tmp_dir:
p0 = f"{tmp_dir}/0"
p1 = f"{tmp_dir}/1"
# Add new path using model
get_model().add_empty()
last = get_model()._children[-1]
last.path_model.as_string = p0
get_model().save()
# Ext manager creates it automatically
self.assertTrue(os.path.exists(p0))
self.assertEqual(len(get_paths()) - len(paths_before), 1)
# Add new path using model
get_model().add_empty()
last = get_model()._children[-1]
last.path_model.as_string = p1
get_model().save()
await wait()
# Ext manager creates it automatically
self.assertTrue(os.path.exists(p1))
self.assertEqual(len(get_paths()) - len(paths_before), 2)
# Remove!
get_model().remove_item(get_model()._children[-1])
await wait()
self.assertEqual(len(get_paths()) - len(paths_before), 1)
# Remove!
get_model().remove_item(get_model()._children[-1])
await wait()
self.assertEqual(get_paths(), paths_before)
| 2,114 | Python | 30.567164 | 73 | 0.566225 |
omniverse-code/kit/exts/omni.kit.window.extensions/omni/kit/window/extensions/tests/__init__.py | # flake8: noqa
from .test_properties_paths import *
from .test_properties_registries import *
| 94 | Python | 22.749994 | 41 | 0.776596 |
omniverse-code/kit/exts/omni.kit.window.extensions/omni/kit/window/extensions/tests/test_properties_registries.py | import carb.settings
import omni.kit.app
import omni.kit.test
import omni.kit.window.extensions
# pylint: disable=protected-access
class TestRegistries(omni.kit.test.AsyncTestCase):
async def test_add_remove_registry_UNRELIABLE(self): # noqa
manager = omni.kit.app.get_app().get_extension_manager()
settings = carb.settings.get_settings()
def get_default():
return settings.get("/app/extensions/registryPublishDefault")
def get_providers():
return {p["name"] for p in manager.get_registry_providers()}
instance = omni.kit.window.extensions.get_instance()()
instance.show_window(True)
instance._window._show_properties()
await omni.kit.app.get_app().next_update_async()
def get_model():
widget = instance._window._exts_properties._registries_widget
return widget._model
model = get_model()
model.set_default(model._children[0], True)
providers_before = get_providers()
default_before = get_default()
self.assertEqual(model._children[0].name_model.as_string, default_before)
# Add new registry using model
model.add_empty()
last = model._children[-1]
last.url_model.as_string = "omniverse://kit-extensions.ov.nvidia.com/exts/kit/debug"
# name is set automatically
model.save()
model = None
# Wait to propagate and check
await omni.kit.app.get_app().next_update_async()
await omni.kit.app.get_app().next_update_async()
self.assertEqual(get_providers() - providers_before, {"kit/debug"})
# Make it default now
get_model().set_default(get_model()._children[-1], True)
await omni.kit.app.get_app().next_update_async()
self.assertEqual(get_default(), "kit/debug")
# Remove!
get_model().remove_item(get_model()._children[-1])
await omni.kit.app.get_app().next_update_async()
await omni.kit.app.get_app().next_update_async()
self.assertEqual(get_providers(), providers_before)
# get back default:
get_model()._children[0].default_model.as_bool = True
await omni.kit.app.get_app().next_update_async()
self.assertEqual(get_default(), default_before)
| 2,310 | Python | 35.109374 | 92 | 0.635065 |
omniverse-code/kit/exts/omni.kit.test_helpers_gfx/omni/kit/test_helpers_gfx/__init__.py | from .compare_utils import * | 28 | Python | 27.999972 | 28 | 0.785714 |
omniverse-code/kit/exts/omni.kit.test_helpers_gfx/omni/kit/test_helpers_gfx/compare_utils.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.
##
"""The utilities for image comparison"""
import pathlib
import sys
import traceback
import math
from enum import Enum
import numpy as np
import carb
import carb.tokens
import omni.appwindow
from omni.kit.test.teamcity import teamcity_publish_image_artifact
class CompareError(Exception):
pass
class ComparisonMetric(Enum):
MAX_DIFFERENCE = 0 # the maximum differrence between pixels. 0 is no difference. In the range [0-255].
PIXEL_COUNT = 1 # the total number of pixels that is not the same for two images
MEAN_ERROR_SQUARED = 2 # Mean root square difference between pixels of two images
PEAK_SIGNAL_TO_NOISE_RATIO = 3
def computeMSE(difference):
components = len(difference.getpixel((0, 0)))
errors = np.asarray(difference) / 255
return sum(np.mean(np.square(errors), axis = (0, 1))) / components
def compare(image1: pathlib.Path, image2: pathlib.Path, image_diffmap: pathlib.Path,
metric: ComparisonMetric = ComparisonMetric.MAX_DIFFERENCE):
"""
Compares two images and return a value that indicates the maximum differrence between pixels. 0 is no difference
in the range [0-255].
It uses Pillow for image read.
Args:
image1, image2: images to compare
image_diffmap: the difference map image will be saved if there is any difference between given images
"""
if not image1.exists():
raise CompareError(f"File image1 {image1} does not exist")
if not image2.exists():
raise CompareError(f"File image2 {image2} does not exist")
if "PIL" not in sys.modules.keys():
# Checking if we have Pillow imported
try:
from PIL import Image
except ImportError:
# Install Pillow if it's not installed
import omni.kit.pipapi
omni.kit.pipapi.install("Pillow", module="PIL")
from PIL import Image
from PIL import ImageChops
original = Image.open(str(image1))
contrast = Image.open(str(image2))
if original.size != contrast.size:
raise CompareError(
f"[omni.ui.test] Can't compare different resolutions\n\n"
f"{image1} {original.size[0]}x{original.size[1]}\n"
f"{image2} {contrast.size[0]}x{contrast.size[1]}\n\n"
f"It's possible that your monitor DPI is not 100%.\n\n"
)
difference = ImageChops.difference(original, contrast)
metric_value = 0.0
try:
if metric is ComparisonMetric.MAX_DIFFERENCE:
metric_value = sum([sum(i) for i in difference.convert("RGB").getextrema()])
if metric is ComparisonMetric.PIXEL_COUNT:
metric_value = sum([sum(
difference.getpixel((j, i))) > 0 for i in range(difference.height) for j in range(difference.width)])
if metric is ComparisonMetric.MEAN_ERROR_SQUARED:
metric_value = computeMSE(difference)
if metric is ComparisonMetric.PEAK_SIGNAL_TO_NOISE_RATIO:
metric_value = computeMSE(difference)
if metric_value < sys.float_info.epsilon:
metric_value = math.inf
metric_value = 10 * math.log10(1 / metric_value)
except():
raise CompareError(f"[omni.ui.test] Can't compute metric {metric} \n\n")
if metric_value > 0:
# Images are different
# Multiply image by 255
difference = difference.convert("RGB").point(lambda i: min(i * 255, 255))
difference.save(str(image_diffmap))
return metric_value
def capture(image_name: str, output_img_dir: str, app_window: omni.appwindow.IAppWindow = None, use_log: bool = True):
"""
Captures frame.
Args:
image_name: the image name of the image and golden image.
output_img_dir: the directory path that the capture will be saved to.
golden_img_dir: the directory path that stores the golden image. Leave it to None to use default dir.
"""
image1 = pathlib.Path(output_img_dir).joinpath(image_name)
if use_log:
carb.log_info(f"[tests.compare] Capturing {image1}")
import omni.renderer_capture
capture_interface = omni.renderer_capture.acquire_renderer_capture_interface()
capture_interface.capture_next_frame_swapchain(str(image1), app_window)
def finalize_capture_and_compare(image_name: str, threshold: float, output_img_dir: str, golden_img_dir: str,
app_window: omni.appwindow.IAppWindow = None,
metric: ComparisonMetric = ComparisonMetric.MAX_DIFFERENCE):
"""
Finalizes capture and compares it with the golden image.
Args:
image_name: the image name of the image and golden image.
threshold: the max threshold to collect TC artifacts.
output_img_dir: the directory path that the capture will be saved to.
golden_img_dir: the directory path that stores the golden image. Leave it to None to use default dir.
app_window: IAppWindow instance for which the capture will happen, use None to capture default app window.
Returns:
A value that indicates the maximum difference between pixels. 0 is no difference
in the range [0-255].
"""
image1 = pathlib.Path(output_img_dir).joinpath(image_name)
image2 = pathlib.Path(golden_img_dir).joinpath(image_name)
image_diffmap = pathlib.Path(output_img_dir).joinpath(f"{pathlib.Path(image_name).stem}.diffmap.png")
import omni.renderer_capture
capture_interface = omni.renderer_capture.acquire_renderer_capture_interface()
capture_interface.wait_async_capture(app_window)
carb.log_info(f"[tests.compare] Comparing {image1} to {image2}")
try:
diff = compare(image1, image2, image_diffmap, metric)
if diff >= threshold:
teamcity_publish_image_artifact(image2, "golden", "Reference")
teamcity_publish_image_artifact(image1, "results", "Generated")
teamcity_publish_image_artifact(image_diffmap, "results", "Diff")
return diff
except CompareError as e:
carb.log_error(f"[tests.compare] Failed to compare images for {image_name}. Error: {e}")
exc = traceback.format_exc()
carb.log_error(f"[tests.compare] Traceback:\n{exc}")
async def capture_and_compare(image_name: str, threshold, output_img_dir: str, golden_img_dir: str,
app_window: omni.appwindow.IAppWindow = None, use_log: bool = True,
metric: ComparisonMetric = ComparisonMetric.MAX_DIFFERENCE):
"""
Captures frame and compares it with the golden image.
Args:
image_name: the image name of the image and golden image.
threshold: the max threshold to collect TC artifacts.
golden_img_dir: the directory path that stores the golden image. Leave it to None to use default dir.
Returns:
A value that indicates the maximum difference between pixels. 0 is no difference
in the range [0-255].
"""
capture(image_name, output_img_dir, app_window, use_log=use_log)
await omni.kit.app.get_app().next_update_async()
return finalize_capture_and_compare(image_name, threshold, output_img_dir, golden_img_dir, app_window, metric)
| 7,732 | Python | 38.454081 | 119 | 0.66865 |
omniverse-code/kit/exts/omni.kit.window.usd_paths/omni/kit/window/usd_paths/scripts/__init__.py | from .usd_paths import *
| 25 | Python | 11.999994 | 24 | 0.72 |
omniverse-code/kit/exts/omni.kit.window.usd_paths/omni/kit/window/usd_paths/scripts/usd_paths.py | import re
import os
import asyncio
import carb
import omni.ext
import omni.kit.ui
import omni.ui as ui
from pxr import Usd, UsdGeom, UsdShade, UsdUtils, Ar, Sdf
_extension_instance = None
_extension_path = None
class UsdPathsExtension(omni.ext.IExt):
def __init__(self):
self.USD_PATHS_TOOL_MENU = "Window/USD Paths"
self._use_regex = False
self._regex_button = None
self._regex_button_style = {
"Button.Label":{"font_size": 12.0},
"Button":{"margin": 2, "padding": 2},
"Button:checked":{"background_color": 0xFF114411},
"Button:hovered":{"background_color": 0xFF444444},
"Button:pressed":{"background_color": 0xFF111111},
}
self._action_button_style = {
"Button.Label:disabled":{"color": 0xFF666666},
"Button:disabled": {"background_color": 0xFF222222}
}
super().__init__()
def on_startup(self, ext_id):
global _extension_instance
_extension_instance = self
global _extension_path
_extension_path = omni.kit.app.get_app_interface().get_extension_manager().get_extension_path(ext_id)
self._unique_paths = {}
self._window = None
editor_menu = omni.kit.ui.get_editor_menu()
if editor_menu:
self._menu = editor_menu.add_item(self.USD_PATHS_TOOL_MENU, self._show_ui, True, 10)
editor_menu.set_value(self.USD_PATHS_TOOL_MENU, False)
def on_shutdown(self):
global _extension_instance
global _template_list
_extension_instance = None
_template_list = None
def _clean_up_paths_ui(self):
if hasattr(self, "_scrollable") and self._scrollable is not None:
self._window.layout.remove_child(self._scrollable)
self._scrollable = None
def _list_all_paths(self, path):
if path not in self._scrollable_pending:
self._scrollable_pending.append(path)
return path
def _modify_path(self, path):
if path in self._unique_paths:
return self._unique_paths[path].model.get_value_as_string()
def _apply_path_edits(self, btn_widget=None):
stage = omni.usd.get_context().get_stage()
if not stage:
carb.log_error("stage not found")
return
(all_layers, all_assets, unresolved_paths) = UsdUtils.ComputeAllDependencies(stage.GetRootLayer().identifier)
if not all_layers:
all_layers = stage.GetLayerStack()
for layer in all_layers:
UsdUtils.ModifyAssetPaths(layer, self._modify_path)
self._traverse()
self._btn_apply.enabled = False
def _replace(self, btn_widget=None):
if not self._unique_paths:
self._traverse()
for path in self._unique_paths:
mdl_path = self._unique_paths[path].model.get_value_as_string()
if self._use_regex:
mdl_path = re.sub(
self._txt_search.model.get_value_as_string(),
self._txt_replace.model.get_value_as_string(),
mdl_path,
)
else:
mdl_path = mdl_path.replace(
self._txt_search.model.get_value_as_string(), self._txt_replace.model.get_value_as_string()
)
self._unique_paths[path].model.set_value(mdl_path)
self._btn_apply.enabled = True
self._btn_replace.enabled = False
def _toggle_block(self, is_enabled):
self._txt_search.enabled = is_enabled
self._txt_replace.enabled = is_enabled
self._btn_replace.enabled = is_enabled
if is_enabled:
return
self._btn_apply.enabled = False
async def _wait_frame_finished(self, finish_fn):
await omni.kit.app.get_app_interface().next_update_async()
finish_fn()
async def _preload_materials_from_stage(self, on_complete_fn):
shaders = []
stage = omni.usd.get_context().get_stage()
if not stage:
carb.log_error("stage not found")
return
for p in stage.Traverse():
if p.IsA(UsdShade.Material):
if not p.GetMetadata("ignore_material_updates"):
material = UsdShade.Material(p)
shader = material.ComputeSurfaceSource("mdl")[0]
shaders.append(shader.GetPath().pathString)
old_paths = omni.usd.get_context().get_selection().get_selected_prim_paths()
omni.usd.get_context().get_selection().set_selected_prim_paths(shaders, True)
await omni.kit.app.get_app_interface().next_update_async()
await omni.kit.app.get_app_interface().next_update_async()
def reload_old_paths():
omni.usd.get_context().get_selection().set_selected_prim_paths(old_paths, True)
on_complete_fn()
asyncio.ensure_future(self._wait_frame_finished(finish_fn=reload_old_paths))
def _traverse(self, btn_widget=None):
self._unique_paths = {}
self._scrollable.clear()
self._scrollable_pending = []
self._toggle_block(False)
def on_preload_complete():
with self._scrollable:
with ui.VStack(spacing=2, height=0):
self._scrollable_pending.sort()
for path in self._scrollable_pending:
text_box = ui.StringField(skip_draw_when_clipped=True)
text_box.model.set_value(path)
self._unique_paths[path] = text_box
self._scrollable_pending = None
if len(self._unique_paths) > 0:
self._toggle_block(True)
asyncio.ensure_future(self.get_asset_paths(on_preload_complete, self._list_all_paths))
def _build_ui(self):
with self._window.frame:
with ui.VStack(spacing=4):
with ui.VStack(spacing=2, height=0):
ui.Spacer(height=4)
with ui.HStack(spacing=10, height=0):
ui.Label("Search", width=60, alignment=ui.Alignment.RIGHT_CENTER)
with ui.ZStack(height=0):
self._txt_search = ui.StringField()
with ui.HStack():
ui.Spacer(height=0)
def toggle_regex(button):
self._use_regex = not self._use_regex
button.checked = self._use_regex
def on_mouse_hover(hover_state):
self._txt_search.enabled = not hover_state
self._regex_button = ui.Button(width=0, text="Regex", style=self._regex_button_style)
self._regex_button.set_clicked_fn(lambda b=self._regex_button: toggle_regex(b))
self._regex_button.set_mouse_hovered_fn(on_mouse_hover)
ui.Spacer(width=10)
ui.Spacer()
with ui.HStack(spacing=10, height=0):
ui.Label("Replace", width=60, alignment=ui.Alignment.RIGHT_CENTER)
self._txt_replace = ui.StringField(height=0)
ui.Spacer(width=10)
ui.Spacer()
with ui.HStack(spacing=10):
ui.Spacer(width=56)
ui.Button(
width=0,
style=self._action_button_style,
clicked_fn=self._traverse,
text=" Reload paths ")
ui.Spacer()
self._btn_replace = ui.Button(
width=0,
style=self._action_button_style,
clicked_fn=self._replace,
text=" Preview ",
enabled=False)
self._btn_apply = ui.Button(
width=0,
style=self._action_button_style,
clicked_fn=self._apply_path_edits,
text=" Apply ",
enabled=False
)
ui.Spacer()
ui.Spacer(width=100)
def on_text_changed(model):
if self._btn_apply.enabled:
self._btn_apply.enabled = False
if not self._btn_replace.enabled:
self._btn_replace.enabled = True
self._txt_search.model.add_value_changed_fn(on_text_changed)
self._txt_replace.model.add_value_changed_fn(on_text_changed)
ui.Spacer(width=14)
self._scrollable = ui.ScrollingFrame(
text="ScrollingFrame", vertical_scrollbar_policy=omni.ui.ScrollBarPolicy.SCROLLBAR_ALWAYS_ON
)
def _show_ui(self, menu, value):
if self._window is None:
window_flags = ui.WINDOW_FLAGS_NO_SCROLLBAR
self._window = ui.Window(
"USD Paths",
width=400,
height=400,
flags=window_flags,
dockPreference=omni.ui.DockPreference.LEFT_BOTTOM,
)
self._window.set_visibility_changed_fn(self._on_visibility_changed)
self._window.deferred_dock_in("Console", ui.DockPolicy.CURRENT_WINDOW_IS_ACTIVE)
self._window.dock_order = 99
self._build_ui()
if self._window:
if value:
self._window.visible = True
else:
self._window.visible = False
def _on_visibility_changed(self, visible):
omni.kit.ui.get_editor_menu().set_value(self.USD_PATHS_TOOL_MENU, visible)
async def get_asset_paths(self, on_complete_fn, get_path_fn):
stage = omni.usd.get_context().get_stage()
if not stage:
carb.log_error("stage not found")
return
def on_preload_complete():
(all_layers, all_assets, unresolved_paths) = UsdUtils.ComputeAllDependencies(
stage.GetRootLayer().identifier
)
if not all_layers:
all_layers = stage.GetLayerStack()
# all_layers doesn't include session layer, use that too
session_layer = stage.GetSessionLayer()
if not session_layer in all_layers:
all_layers.append(session_layer)
for layer in all_layers:
UsdUtils.ModifyAssetPaths(layer, get_path_fn)
on_complete_fn()
await self._preload_materials_from_stage(on_preload_complete)
def get_extension():
return Extension()
def get_instance():
return _extension_instance
def get_extension_path(sub_directory):
global _extension_path
path = _extension_path
if sub_directory:
path = os.path.normpath(os.path.join(path, sub_directory))
return path
| 11,339 | Python | 37.835616 | 117 | 0.529676 |
omniverse-code/kit/exts/omni.kit.window.usd_paths/omni/kit/window/usd_paths/tests/create_prims.py | import os
import carb
import omni.kit.commands
from pxr import Usd, Sdf, UsdGeom, Gf, Tf, UsdShade, UsdLux
def create_test_stage():
settings = carb.settings.get_settings()
default_prim_name = settings.get("/persistent/app/stage/defaultPrimName")
rootname = f"/{default_prim_name}"
stage = omni.usd.get_context().get_stage()
kit_folder = carb.tokens.get_tokens_interface().resolve("${kit}")
omni_pbr_mtl = os.path.normpath(kit_folder + "/mdl/core/Base/OmniPBR.mdl")
sunflower_hdr = omni.kit.window.usd_paths.get_extension_path("data/sunflowers.hdr")
lenna_dds = omni.kit.window.usd_paths.get_extension_path("textures/lenna.dds")
lenna_gif = omni.kit.window.usd_paths.get_extension_path("textures/lenna.gif")
lenna_jpg = omni.kit.window.usd_paths.get_extension_path("textures/lenna.jpg")
lenna_png = omni.kit.window.usd_paths.get_extension_path("textures/lenna.png")
lenna_tga = omni.kit.window.usd_paths.get_extension_path("textures/lenna.tga")
# create Looks folder
omni.kit.commands.execute(
"CreatePrim",
prim_path=omni.usd.get_stage_next_free_path(stage, "{}/Looks".format(rootname), False),
prim_type="Scope",
select_new_prim=False,
)
# create GroundMat material
mtl_name = "GroundMat"
mtl_path = omni.usd.get_stage_next_free_path(
stage, "{}/Looks/{}".format(rootname, Tf.MakeValidIdentifier(mtl_name)), False
)
omni.kit.commands.execute(
"CreateMdlMaterialPrim", mtl_url=omni_pbr_mtl, mtl_name=mtl_name, mtl_path=mtl_path
)
ground_mat_prim = stage.GetPrimAtPath(mtl_path)
shader = UsdShade.Material(ground_mat_prim).ComputeSurfaceSource("mdl")[0]
shader.SetSourceAssetSubIdentifier("OmniPBR", "mdl")
omni.usd.create_material_input(ground_mat_prim, "reflection_roughness_constant", 0.36, Sdf.ValueTypeNames.Float)
omni.usd.create_material_input(ground_mat_prim, "specular_level", 0.25, Sdf.ValueTypeNames.Float)
omni.usd.create_material_input(
ground_mat_prim, "diffuse_color_constant", Gf.Vec3f(0.08, 0.08, 0.08), Sdf.ValueTypeNames.Color3f
)
omni.usd.create_material_input(ground_mat_prim, "diffuse_tint", Gf.Vec3f(1, 1, 1), Sdf.ValueTypeNames.Color3f)
omni.usd.create_material_input(ground_mat_prim, "diffuse_tint", Gf.Vec3f(1, 1, 1), Sdf.ValueTypeNames.Color3f)
omni.usd.create_material_input(ground_mat_prim, "metallic_constant", 0.0, Sdf.ValueTypeNames.Float)
omni.usd.create_material_input(ground_mat_prim, "reflection_roughness_constant", 0.36, Sdf.ValueTypeNames.Float)
# add additional files to shader
omni.usd.create_material_input(
ground_mat_prim, "diffuse_texture", Sdf.AssetPath(lenna_dds), Sdf.ValueTypeNames.Asset
)
omni.usd.create_material_input(ground_mat_prim, "ao_texture", Sdf.AssetPath(lenna_gif), Sdf.ValueTypeNames.Asset)
omni.usd.create_material_input(
ground_mat_prim, "normalmap_texture", Sdf.AssetPath(lenna_jpg), Sdf.ValueTypeNames.Asset
)
omni.usd.create_material_input(
ground_mat_prim, "reflectionroughness_texture", Sdf.AssetPath(lenna_png), Sdf.ValueTypeNames.Asset
)
omni.usd.create_material_input(
ground_mat_prim, "metallic_texture", Sdf.AssetPath(lenna_tga), Sdf.ValueTypeNames.Asset
)
# create GroundCube
ground_cube_path = omni.usd.get_stage_next_free_path(stage, "{}/GroundCube".format(rootname), False)
omni.kit.commands.execute(
"CreatePrim",
prim_path=ground_cube_path,
prim_type="Cube",
select_new_prim=False,
attributes={UsdGeom.Tokens.size: 100, UsdGeom.Tokens.extent: [(-50, -50, -50), (50, 50, 50)]},
)
ground_cube_prim = stage.GetPrimAtPath(ground_cube_path)
# set transform
ground_cube_prim.CreateAttribute("xformOp:translate", Sdf.ValueTypeNames.Double3, False).Set(Gf.Vec3d(0, -50, 0))
ground_cube_prim.CreateAttribute("xformOp:scale", Sdf.ValueTypeNames.Double3, False).Set(Gf.Vec3d(2000, 1, 2000))
ground_cube_prim.CreateAttribute("xformOpOrder", Sdf.ValueTypeNames.String, False).Set(
["xformOp:translate", "xformOp:scale"]
)
# set doNotCastShadows
primvars_api = UsdGeom.PrimvarsAPI(ground_cube_prim)
primvars_api.CreatePrimvar("doNotCastShadows", Sdf.ValueTypeNames.Bool).Set(True)
# set misc
omni.kit.commands.execute(
"BindMaterial",
prim_path=ground_cube_path,
material_path=mtl_path,
strength=UsdShade.Tokens.strongerThanDescendants,
)
# create DistantLight
distant_light_path = omni.usd.get_stage_next_free_path(stage, "{}/DistantLight".format(rootname), False)
omni.kit.commands.execute(
"CreatePrim",
prim_path=distant_light_path,
prim_type="DistantLight",
select_new_prim=False,
# https://github.com/PixarAnimationStudios/USD/commit/b5d3809c943950cd3ff6be0467858a3297df0bb7
attributes={UsdLux.Tokens.inputsAngle: 1.0, UsdLux.Tokens.inputsColor: Gf.Vec3f(1, 1, 1), UsdLux.Tokens.inputsIntensity: 2000} if hasattr(UsdLux.Tokens, 'inputsIntensity') else \
{UsdLux.Tokens.angle: 1.0, UsdLux.Tokens.color: Gf.Vec3f(1, 1, 1), UsdLux.Tokens.intensity: 2000},
)
distant_light_prim = stage.GetPrimAtPath(distant_light_path)
# set transform
distant_light_prim.CreateAttribute("xformOp:scale", Sdf.ValueTypeNames.Double3, False).Set(
Gf.Vec3d(1, 1.0000004, 1.0000004)
)
distant_light_prim.CreateAttribute("xformOp:rotateZYX", Sdf.ValueTypeNames.Double3, False).Set(
Gf.Vec3d(242.08, 327.06, 0)
)
distant_light_prim.CreateAttribute("xformOp:translate", Sdf.ValueTypeNames.Double3, False).Set(Gf.Vec3d(0, 0, 0))
distant_light_prim.CreateAttribute("xformOpOrder", Sdf.ValueTypeNames.String, False).Set(
["xformOp:translate", "xformOp:rotateZYX", "xformOp:scale"]
)
# create DomeLight
dome_light_path = omni.usd.get_stage_next_free_path(stage, "{}/DomeLight".format(rootname), False)
omni.kit.commands.execute(
"CreatePrim",
prim_path=dome_light_path,
prim_type="DomeLight",
select_new_prim=False,
# https://github.com/PixarAnimationStudios/USD/commit/b5d3809c943950cd3ff6be0467858a3297df0bb7
attributes={
UsdLux.Tokens.inputsIntensity: 1000,
UsdLux.Tokens.inputsSpecular: 1,
UsdLux.Tokens.inputsTextureFile: sunflower_hdr,
UsdLux.Tokens.inputsTextureFormat: UsdLux.Tokens.latlong,
UsdGeom.Tokens.visibility: UsdGeom.Tokens.inherited,
} if hasattr(UsdLux.Tokens, 'inputsIntensity') else \
{
UsdLux.Tokens.intensity: 1000,
UsdLux.Tokens.specular: 1,
UsdLux.Tokens.textureFile: sunflower_hdr,
UsdLux.Tokens.textureFormat: UsdLux.Tokens.latlong,
UsdGeom.Tokens.visibility: UsdGeom.Tokens.inherited,
},
)
dome_light_prim = stage.GetPrimAtPath(dome_light_path)
# set misc
# https://github.com/PixarAnimationStudios/USD/commit/3738719d72e60fb78d1cd18100768a7dda7340a4
if hasattr(UsdLux.Tokens, 'inputsShapingFocusTint'):
dome_light_prim.GetAttribute(UsdLux.Tokens.inputsShapingFocusTint).Set(Gf.Vec3f(0, 0, 0))
dome_light_prim.GetAttribute(UsdLux.Tokens.inputsShapingFocus).Set(0)
else:
dome_light_prim.GetAttribute(UsdLux.Tokens.shapingFocusTint).Set(Gf.Vec3f(0, 0, 0))
dome_light_prim.GetAttribute(UsdLux.Tokens.shapingFocus).Set(0)
| 7,497 | Python | 47.374193 | 186 | 0.696012 |
omniverse-code/kit/exts/omni.kit.window.usd_paths/omni/kit/window/usd_paths/tests/__init__.py | from .test_usd_paths import *
from .create_prims import *
| 58 | Python | 18.66666 | 29 | 0.741379 |
omniverse-code/kit/exts/omni.kit.window.usd_paths/omni/kit/window/usd_paths/tests/test_usd_paths.py | import os
import unittest
import carb
import omni.kit.test
class TestUsdPaths(omni.kit.test.AsyncTestCase):
async def setUp(self):
# Disable logging for the time of tests to avoid spewing errors
await omni.usd.get_context().new_stage_async()
omni.kit.window.usd_paths.tests.create_test_stage()
async def tearDown(self):
pass
async def test_paths(self):
found_paths = []
def get_all_paths(path):
if path not in found_paths:
found_paths.append(os.path.basename(path).lower())
return path
def on_preload_complete():
paths = sorted(
[
path
for path in found_paths
if path.endswith(".hdr") or path.endswith(".mdl") or path.find("lenna.") != -1
]
)
self.assertListEqual(
paths,
["canary_wharf_4k.hdr", "lenna.dds", "lenna.gif", "lenna.jpg", "lenna.png", "lenna.tga", "omnipbr.mdl"],
)
await omni.kit.window.usd_paths.get_instance().get_asset_paths(on_preload_complete, get_all_paths)
| 1,173 | Python | 29.894736 | 120 | 0.553282 |
omniverse-code/kit/exts/omni.kit.tagging/omni/tagging_client/__init__.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.
from idl.connection.transport.ws import WebSocketClient
from omni.discovery import DiscoverySearch
from ._generated.client import *
import asyncio
class TaggingClientHelper:
default_fb: str = "localhost:3020"
def __init__(self, nucleus_server: str,
tagging_fallback: str = default_fb,
subscription_fallback: str = default_fb,
suggestions_fallback: str = default_fb,
discovery_timeout: float = 10):
self.server = nucleus_server
self.tagging_fallback = tagging_fallback
self.subscription_fallback = subscription_fallback
self.suggestions_fallback = suggestions_fallback
self.transports = {}
self.interfaces = {}
self.timeout = discovery_timeout
async def __aenter__(self):
return self
async def __aexit__(self, *args, **kwargs):
await self.close()
async def close(self):
try:
for i in self.interfaces.values():
await i.transport.close()
for t in self.transports.values():
await t.close()
except BaseException as e:
print(e)
async def get_tagging_service(self) -> TaggingService:
return await self._get_service(TaggingService, self.tagging_fallback)
async def get_tag_subscription_service(self) -> TagSubscription:
return await self._get_service(TagSubscription, self.subscription_fallback)
async def get_tag_suggestions_service(self) -> TagSuggestions:
return await self._get_service(TagSuggestions, self.suggestions_fallback)
async def _get_transport(self, fallback):
if fallback in self.transports:
return self.transports[fallback]
else:
print(f'discovery failed, trying fallback connection to {fallback}')
transport = WebSocketClient(uri=f'ws://{fallback}')
await transport.prepare()
self.transports[fallback] = transport
return transport
async def _find_service(self, interface):
async with DiscoverySearch(self.server) as search:
return await search.find(interface, meta={"deployment": "external"})
async def _get_service(self, interface, fallback):
if interface in self.interfaces:
return self.interfaces[interface]
else:
instance = await self._create_interface(interface, fallback)
self.interfaces[interface] = instance
return instance
async def _create_interface(self, interface, fallback):
try:
return await asyncio.wait_for(self._find_service(interface), timeout=self.timeout)
except Exception:
transport = await self._get_transport(fallback)
return interface(transport) if transport else None
| 3,275 | Python | 38.469879 | 94 | 0.661374 |
omniverse-code/kit/exts/omni.kit.tagging/omni/discovery/__init__.py | import asyncio
import logging
import os
import ssl
import urllib.parse
from typing import Callable, Optional, Awaitable, List, Dict
from idl.connection.marshallers import Marshaller
from idl.connection.transport import Client, TransportSettings, TransportError
from idl.connection.transport.http import HttpClient
from idl.connection.transport.http_file import HttpFileClient
from idl.connection.transport.omni import OmniClientTransport
from idl.connection.transport.ws import WebSocketClient
from idl.data.serializers import Serializer
from idl.data.serializers.json import JSONSerializer
from idl.types import Record
from omni.discovery.client import (
DiscoveryRegistration as DiscoveryRegistrationClient,
DiscoverySearch as DiscoverySearchClient
)
from omni.discovery.data import (
Manifest, HealthStatus, Meta, HealthCheck, DiscoverInterfaceQuery, ServiceInterface, SupportedTransport,
)
logger = logging.getLogger("omni.discovery")
sentinel = object()
Stop = bool
DISCOVERY_ENDPOINT = "/omni/discovery"
class DiscoveryManifest(Record):
token: str
interfaces: list
transport: TransportSettings
meta: Optional[Meta]
class DiscoveryRegistration:
def __init__(self, uri: str, ssl_context: ssl.SSLContext = None, *, conn_timeout: float = 5.0):
self.uri = uri
self.ssl_context = ssl_context
self.conn_timeout = conn_timeout
async def register(self, manifest: DiscoveryManifest,
on_check: Callable[[HealthCheck], Awaitable[Optional[Stop]]] = None,
retry_timeout: float = 5.0):
registered_manifest = Manifest(
token=manifest.token,
transport=manifest.transport,
meta=manifest.meta,
interfaces={
interface.__interface_name__: ServiceInterface(
origin=interface.__interface_origin__,
name=interface.__interface_name__,
capabilities=getattr(interface, "__interface_capabilities__", None)
)
for interface in manifest.interfaces
}
)
info = "\n".join([
f" Discovery URI: {self.uri}",
f" Transport settings: {registered_manifest.transport}",
f" Meta: {registered_manifest.meta}"
])
logger.info(f"Registering the service in the discovery with these parameters:\n{info}")
running = True
while running:
try:
registering = True
ws = await connect(self.uri, self.ssl_context, timeout=self.conn_timeout)
if ws is None:
raise ConnectionError(f"Failed to connect to the discovery service {self.uri}")
async with DiscoveryRegistrationClient(ws) as discovery:
async for health_check in discovery.register(registered_manifest):
if on_check:
stop = await on_check(health_check)
if stop:
break
if health_check.status == HealthStatus.OK:
if registering:
if manifest.meta:
logger.info(f"Registered in {self.uri} with {manifest.meta} meta.")
else:
logger.info(f"Registered in {self.uri}.")
registering = False
else:
logger.error(
f"Can't register the service: {health_check.message or health_check.status}.\n"
f"Info:\n{info}"
)
if registering:
running = False
break
except asyncio.CancelledError:
return
except Exception as exc:
logger.exception(
f"An error has occurred while registering the service in the discovery.\n"
f"Info:\n{info}",
exc_info=exc
)
try:
loop = asyncio.get_event_loop()
except RuntimeError:
break
else:
if loop.is_closed():
break
await asyncio.sleep(retry_timeout)
class DiscoverySearch:
def __init__(self, uri: str, ssl_context: ssl.SSLContext = None):
self._uri = uri
self._ssl_context = ssl_context
self._ws: Optional[WebSocketClient] = None
self._closing: Optional[asyncio.Task] = None
async def __aenter__(self):
return self
async def __aexit__(self, exc_type, exc_val, exc_tb):
await self.close()
async def find(
self,
interface,
meta: Meta = None,
supported_transport: Optional[List[SupportedTransport]] = sentinel,
capabilities: Dict[str, int] = None,
*,
timeout: float = 5.0
):
if supported_transport is sentinel:
supported_transport = list(Client.get_supported())
ws = await self._connect(timeout)
discovery = DiscoverySearchClient(ws)
origin = interface.__interface_origin__
interface_name = interface.__interface_name__
if capabilities is None:
capabilities = getattr(interface, "__interface_capabilities__", None)
try:
response = await discovery.find(DiscoverInterfaceQuery(
service_interface=ServiceInterface(
origin=origin,
name=interface_name,
capabilities=capabilities
),
supported_transport=supported_transport,
meta=meta
))
except TransportError as exc:
raise ConnectionError(f"Failed to communicate with the discovery service {self._uri}.") from exc
if not response.found:
raise ConnectionError(
f"Interface {interface_name!r} from {origin!r} has not been found."
)
transport = Client.create(response.transport)
try:
await transport.prepare()
except Exception as exc:
msg = "\n".join([
f"An error has occurred when tried to establish a connection to {interface.__name__}.",
f"Info: ",
f" Discovery URI: {self._uri}",
f" Interface: {interface_name}",
f" Meta: {meta}",
f" Response: {response}",
])
raise ConnectionError(msg) from exc
return interface(transport)
async def close(self):
if self._closing:
self._closing.cancel()
if self._ws:
await self._ws.close()
async def _connect(self, timeout: float = 5.0):
if self._ws is not None:
return self._ws
ws = await connect(self._uri, self._ssl_context, timeout=timeout)
if ws is None:
raise ConnectionError(f"Failed to connect to the discovery service {self._uri}.")
loop = asyncio.get_event_loop()
if self._closing:
self._closing.cancel()
self._ws = ws
self._closing = loop.create_task(self._wait_closed())
return self._ws
async def _wait_closed(self):
if self._ws is not None:
await self._ws.closed.wait()
self._ws = None
async def connect(uri: str, ssl_context: ssl.SSLContext, *, timeout: float = 5.0) -> Optional[WebSocketClient]:
loop = asyncio.get_event_loop()
url = parse_url(uri)
hostname = url.hostname
# Path-based routing is not used on Workstation setup:
# https://nvidia-omniverse.atlassian.net/browse/OM-32965
force_pbr = int(os.getenv("OMNI_DISCOVERY_FORCE_PBR", "0"))
if hostname in ("localhost", "127.0.0.1", "::1") and not force_pbr:
ws_port_based_client_task = loop.create_task(create_port_based_client(uri, ssl_context=ssl_context))
done, pending = await asyncio.wait({ws_port_based_client_task}, timeout=timeout)
if ws_port_based_client_task in done:
return ws_port_based_client_task.result()
else:
ws_port_based_client_task.cancel()
else:
wss_path_based_client_task = loop.create_task(
create_path_based_client(uri, scheme="wss", ssl_context=ssl_context)
)
ws_path_based_client_task = loop.create_task(
create_path_based_client(uri, scheme="ws", ssl_context=ssl_context)
)
ws_port_based_client_task = loop.create_task(
create_port_based_client(uri, ssl_context=ssl_context)
)
tasks = [
wss_path_based_client_task,
ws_path_based_client_task,
ws_port_based_client_task,
]
done = []
try:
ws_timeout = loop.create_task(asyncio.sleep(timeout))
done, pending = await asyncio.wait(
{wss_path_based_client_task, ws_timeout},
return_when=asyncio.FIRST_COMPLETED,
)
if wss_path_based_client_task in done:
ws = wss_path_based_client_task.result()
if ws:
return ws
done, pending = await asyncio.wait(
{ws_path_based_client_task, ws_timeout},
return_when=asyncio.FIRST_COMPLETED
)
if ws_path_based_client_task in done:
ws = ws_path_based_client_task.result()
if ws:
return ws
done, pending = await asyncio.wait(
{ws_port_based_client_task, ws_timeout},
return_when=asyncio.FIRST_COMPLETED
)
if ws_port_based_client_task in done:
ws = ws_port_based_client_task.result()
if ws:
return ws
finally:
for task in tasks:
if task not in done:
if task.done():
ws: WebSocketClient = task.result()
if ws:
try:
await ws.close()
except:
pass
else:
task.cancel()
async def create_path_based_client(uri: str, scheme: str = "wss", ssl_context: ssl.SSLContext = None) -> Optional[WebSocketClient]:
url = parse_url(uri, default_scheme=scheme)
path = url.path.rstrip("/") + DISCOVERY_ENDPOINT
hostname = url.hostname
port = url.port
scheme = url.scheme
if port:
uri = f"{scheme}://{hostname}:{port}{path}"
else:
uri = f"{scheme}://{hostname}{path}"
try:
ws = WebSocketClient(uri=uri, ssl_context=ssl_context)
await ws.prepare()
return ws
except Exception as exc:
msg = f"Failed to connect to the discovery service using path-based routing ({uri})."
logger.debug(msg, exc_info=exc)
return None
async def create_port_based_client(uri: str, ssl_context: ssl.SSLContext = None) -> Optional[WebSocketClient]:
url = parse_url(uri, default_scheme="ws")
hostname = url.hostname
port = url.port
scheme = url.scheme
if not port:
port = "3333"
uri = f"{scheme}://{hostname}:{port}"
try:
ws = WebSocketClient(uri=uri, ssl_context=ssl_context)
await ws.prepare()
return ws
except Exception as exc:
msg = f"Failed to connect to the discovery service using port-based routing ({uri})."
logger.debug(msg, exc_info=exc)
return None
def parse_url(value: str, default_scheme: str = "ws") -> urllib.parse.ParseResult:
url = urllib.parse.urlparse(value)
if not url.scheme:
url = urllib.parse.urlparse(f"{default_scheme}://{value}")
return url
Serializer.register(JSONSerializer)
Marshaller.register(Marshaller)
Client.register(HttpClient)
Client.register(HttpFileClient)
Client.register(WebSocketClient)
Client.register(OmniClientTransport)
| 12,344 | Python | 35.308823 | 131 | 0.559786 |
omniverse-code/kit/exts/omni.kit.tagging/omni/discovery/data.py | from typing import List, Optional, Dict, AsyncIterator
from idl.types import Enum, Record, Literal
Capabilities = Dict[str, int]
DiscoverySearchServerRemoteCapabilities = Capabilities
DiscoverySearchServerLocalCapabilities = {'find': 2, 'find_all': 2}
DiscoverySearchServerCapabilities = DiscoverySearchServerRemoteCapabilities
DiscoverySearchClientRemoteCapabilities = Capabilities
DiscoverySearchClientLocalCapabilities = {'find': 2, 'find_all': 2}
DiscoverySearchClientCapabilities = DiscoverySearchClientLocalCapabilities
DiscoverySearchFindAllServerRemoteVersion = int
DiscoverySearchFindAllServerLocalVersion = 2
DiscoverySearchFindAllServerVersion = DiscoverySearchFindAllServerRemoteVersion
DiscoverySearchFindAllClientRemoteVersion = int
DiscoverySearchFindAllClientLocalVersion = 2
DiscoverySearchFindServerRemoteVersion = int
DiscoverySearchFindServerLocalVersion = 2
DiscoverySearchFindServerVersion = DiscoverySearchFindServerRemoteVersion
DiscoverySearchFindClientRemoteVersion = int
DiscoverySearchFindClientLocalVersion = 2
DiscoveryRegistrationServerRemoteCapabilities = Capabilities
DiscoveryRegistrationServerLocalCapabilities = {'register': 2, 'register_unsafe': 2, 'unregister_unsafe': 2}
DiscoveryRegistrationServerCapabilities = DiscoveryRegistrationServerRemoteCapabilities
DiscoveryRegistrationClientRemoteCapabilities = Capabilities
DiscoveryRegistrationClientLocalCapabilities = {'register': 2, 'register_unsafe': 2, 'unregister_unsafe': 2}
DiscoveryRegistrationClientCapabilities = DiscoveryRegistrationClientLocalCapabilities
DiscoveryRegistrationUnregisterUnsafeServerRemoteVersion = int
DiscoveryRegistrationUnregisterUnsafeServerLocalVersion = 2
DiscoveryRegistrationUnregisterUnsafeServerVersion = DiscoveryRegistrationUnregisterUnsafeServerRemoteVersion
DiscoveryRegistrationUnregisterUnsafeClientRemoteVersion = int
DiscoveryRegistrationUnregisterUnsafeClientLocalVersion = 2
DiscoveryRegistrationRegisterUnsafeServerRemoteVersion = int
DiscoveryRegistrationRegisterUnsafeServerLocalVersion = 2
DiscoveryRegistrationRegisterUnsafeServerVersion = DiscoveryRegistrationRegisterUnsafeServerRemoteVersion
DiscoveryRegistrationRegisterUnsafeClientRemoteVersion = int
DiscoveryRegistrationRegisterUnsafeClientLocalVersion = 2
DiscoveryRegistrationRegisterServerRemoteVersion = int
DiscoveryRegistrationRegisterServerLocalVersion = 2
DiscoveryRegistrationRegisterServerVersion = DiscoveryRegistrationRegisterServerRemoteVersion
DiscoveryRegistrationRegisterClientRemoteVersion = int
DiscoveryRegistrationRegisterClientLocalVersion = 2
Meta = Dict[str, str]
class HealthStatus(metaclass=Enum):
OK = "OK"
Closed = "CLOSED"
Denied = "DENIED"
AlreadyExists = "ALREADY_EXISTS"
InvalidSettings = "INVALID_SETTINGS"
InvalidCapabilities = "INVALID_CAPABILITIES"
class ServiceInterface(Record):
origin: str
name: str
capabilities: Optional[Capabilities]
class TransportSettings(Record):
name: str
params: str
meta: Meta
ServiceInterfaceMap = Dict[str, ServiceInterface]
class SupportedTransport(Record):
name: str
meta: Optional[Meta]
class SearchResult(Record):
found: bool
version: Optional[int]
service_interface: Optional[ServiceInterface]
transport: Optional[TransportSettings]
meta: Optional[Meta]
DiscoverySearchFindAllClientVersion = DiscoverySearchFindAllClientLocalVersion
DiscoverySearchFindClientVersion = DiscoverySearchFindClientLocalVersion
class DiscoverInterfaceQuery(Record):
service_interface: ServiceInterface
supported_transport: Optional[List[SupportedTransport]]
meta: Optional[Meta]
class HealthCheck(Record):
status: HealthStatus
time: str
version: Optional[int]
message: Optional[str]
meta: Optional[Meta]
DiscoveryRegistrationUnregisterUnsafeClientVersion = DiscoveryRegistrationUnregisterUnsafeClientLocalVersion
class Manifest(Record):
interfaces: ServiceInterfaceMap
transport: TransportSettings
token: str
meta: Optional[Meta]
DiscoveryRegistrationRegisterUnsafeClientVersion = DiscoveryRegistrationRegisterUnsafeClientLocalVersion
DiscoveryRegistrationRegisterClientVersion = DiscoveryRegistrationRegisterClientLocalVersion | 4,228 | Python | 35.456896 | 109 | 0.854778 |
omniverse-code/kit/exts/omni.kit.tagging/omni/discovery/client.py | from typing import AsyncIterator, Dict, List, Optional
from idl.connection.transport import Client
from idl.types import Literal, Record
from .data import *
class DiscoverySearch:
def __init__(self, transport: Client):
self.transport = transport
async def __aenter__(self) -> 'DiscoverySearch':
await self.transport.prepare()
return self
async def __aexit__(self, exc_type, exc_val, exc_tb):
await self.transport.close()
async def find(self, query: DiscoverInterfaceQuery) -> SearchResult:
"""
Finds an entry for specified origin and interface.
A query can specify the required capabilities, connection settings and
other metadata.
"""
_request = {}
_request["query"] = query
_request["version"] = DiscoverySearchFindClientVersion
_response = await self.transport.call("DiscoverySearch", "find", _request, request_type=DiscoverySearchFindArgs, return_type=SearchResult)
return _response
async def find_all(self, ) -> AsyncIterator[SearchResult]:
"""
Retrieves all registered interfaces for this discovery service.
"""
_request = {}
_request["version"] = DiscoverySearchFindAllClientVersion
agen = self.transport.call_many("DiscoverySearch", "find_all", _request, request_type=DiscoverySearchFindAllArgs, return_type=SearchResult)
try:
async for _response in agen:
yield _response
finally:
await agen.aclose()
__interface_name__ = "DiscoverySearch"
__interface_origin__ = "Discovery.idl.ts"
__interface_capabilities__ = DiscoverySearchClientLocalCapabilities
class DiscoveryRegistration:
def __init__(self, transport: Client):
self.transport = transport
async def __aenter__(self) -> 'DiscoveryRegistration':
await self.transport.prepare()
return self
async def __aexit__(self, exc_type, exc_val, exc_tb):
await self.transport.close()
async def register(self, manifest: Manifest) -> AsyncIterator[HealthCheck]:
"""
Registers a new service with specified connection settings and
interfaces.
The discovery keeps a subscription to ensure that registered service is
still available.
The service is removed from discovery as soon as it stops receiving
health checks from the subscription.
You can use `register_unsafe` to register a service without a
subscription and health checks.
"""
_request = {}
_request["manifest"] = manifest
_request["version"] = DiscoveryRegistrationRegisterClientVersion
agen = self.transport.call_many("DiscoveryRegistration", "register", _request, request_type=DiscoveryRegistrationRegisterArgs, return_type=HealthCheck)
try:
async for _response in agen:
yield _response
finally:
await agen.aclose()
async def register_unsafe(self, manifest: Manifest) -> HealthCheck:
"""
Registers a new service without a health checking.
It's a service responsibility to call `unregister_unsafe` when the
provided functions become not available.
"""
_request = {}
_request["manifest"] = manifest
_request["version"] = DiscoveryRegistrationRegisterUnsafeClientVersion
_response = await self.transport.call("DiscoveryRegistration", "register_unsafe", _request, request_type=DiscoveryRegistrationRegisterUnsafeArgs, return_type=HealthCheck)
return _response
async def unregister_unsafe(self, manifest: Manifest) -> HealthCheck:
"""
Removes the service registered with `register_unsafe` from the
discovery.
"""
_request = {}
_request["manifest"] = manifest
_request["version"] = DiscoveryRegistrationUnregisterUnsafeClientVersion
_response = await self.transport.call("DiscoveryRegistration", "unregister_unsafe", _request, request_type=DiscoveryRegistrationUnregisterUnsafeArgs, return_type=HealthCheck)
return _response
__interface_name__ = "DiscoveryRegistration"
__interface_origin__ = "Discovery.idl.ts"
__interface_capabilities__ = DiscoveryRegistrationClientLocalCapabilities
class DiscoverySearchFindArgs(Record):
query: DiscoverInterfaceQuery
version: Optional[Literal(DiscoverySearchFindClientVersion)] = DiscoverySearchFindClientVersion
class DiscoverySearchFindAllArgs(Record):
version: Optional[Literal(DiscoverySearchFindAllClientVersion)] = DiscoverySearchFindAllClientVersion
class DiscoveryRegistrationRegisterArgs(Record):
manifest: Manifest
version: Optional[Literal(DiscoveryRegistrationRegisterClientVersion)] = DiscoveryRegistrationRegisterClientVersion
class DiscoveryRegistrationRegisterUnsafeArgs(Record):
manifest: Manifest
version: Optional[Literal(DiscoveryRegistrationRegisterUnsafeClientVersion)] = DiscoveryRegistrationRegisterUnsafeClientVersion
class DiscoveryRegistrationUnregisterUnsafeArgs(Record):
manifest: Manifest
version: Optional[Literal(DiscoveryRegistrationUnregisterUnsafeClientVersion)] = DiscoveryRegistrationUnregisterUnsafeClientVersion
| 5,323 | Python | 38.731343 | 182 | 0.698854 |
omniverse-code/kit/exts/omni.kit.tagging/omni/kit/tagging/__init__.py | from .scripts.taggingservice import *
| 38 | Python | 18.499991 | 37 | 0.815789 |
omniverse-code/kit/exts/omni.kit.tagging/omni/kit/tagging/scripts/taggingservice.py | import carb
import carb.events
import asyncio
import omni.client
import omni.kit.tagging
from idl.connection.transport import TransportError
# rename this to omni.tagging.client after omni.tagging is deprecated
import omni.tagging_client as tagging_client
class TaggingClientContextAsync:
"""Create a tag client context."""
def __init__(self, ov_server, **kwargs):
self.ov_server = ov_server
async def init_client(self):
"""Create tagging client."""
self._helper = tagging_client.TaggingClientHelper(self.ov_server)
# connect to the tagging service
self.service = await self._helper.get_tagging_service()
# check that tagging server is responding
res = await self.service.generate_client_id()
# get the ID of the client (this will likely be deprecated)
self.client_id = res.client_id
async def close_client(self, client_msg: str = None, *args, **kwargs):
"""Close tagging client."""
await self._helper.__aexit__(*args, **kwargs)
# log the given message on success
if client_msg is not None:
tag_utils_logger.debug(client_msg)
class OmniKitTaggingDelegate:
"""Delegate that handles when async tagging events are finished.
"""
def updated_tags_for_url(self, url: str):
pass
def finished_getting_tags(self, urls: str):
pass
class OmniKitTagging(omni.ext.IExt):
"""The Tagging plugin. This plugin holds tagging client contexts."""
static_instance = None
def on_startup(self):
OmniKitTagging.static_instance = self
self._connections = {}
self._auth_tokens = {}
self._path_results = {}
self._tagging_clients = {}
self._conn_subscription = omni.client.register_connection_status_callback(self._server_status_changed)
self._delegate = None
self._initializing = False
def on_shutdown(self):
for client in self._tagging_clients:
asyncio.ensure_future(self._tagging_clients[client].close_client())
self._tagging_clients = None
self._conn_subscription = None
self._auth_subscription = None
self._delegate = None
OmniKitTagging.static_instance = None
def set_delegate(self, delegate: OmniKitTaggingDelegate):
self._delegate = delegate
def _server_status_changed(self, url, status):
def _server_info_callback(result, server_info):
nonlocal url
broken_url = omni.client.break_url(url)
if result == omni.client.Result.OK:
self._auth_tokens[broken_url.host] = server_info.auth_token
else:
carb.log_error(f"Server info error: {str(result)}")
broken_url = omni.client.break_url(url)
if status == omni.client.ConnectionStatus.CONNECTED:
self._connections[broken_url.host] = True
omni.client.get_server_info_with_callback(url, _server_info_callback)
else:
self._connections[broken_url.host] = False
async def _verify_connection(self, host):
if host is None:
return False
if host not in self._connections:
carb.log_warn(f"Unable to get tags. Not connected to host: {host}")
return False
if host not in self._auth_tokens:
carb.log_error(f"Error getting auth token for host: {host}")
return False
if host not in self._tagging_clients:
self._initializing = True
self._tagging_clients[host] = TaggingClientContextAsync(ov_server=host)
await self._tagging_clients[host].init_client()
self._initializing = False
if self._tagging_clients[host].service is None:
carb.log_error(f"Error creating tagging client service on {host}")
return False
return True
def tags_action(self, url, new_tag, action="add", old_tag=None):
if action.lower() == "add":
modify_type = tagging_client.TagModifyType.Add
elif action.lower() == "set":
modify_type = tagging_client.TagModifyType.Set
elif action.lower() == "reset":
modify_type = tagging_client.TagModifyType.Reset
elif action.lower() == "remove":
modify_type = tagging_client.TagModifyType.Remove
elif action.lower() == "update":
modify_type = tagging_client.TagModifyType.Remove
asyncio.ensure_future(self.tags_action_async(url, old_tag, modify_type))
modify_type = tagging_client.TagModifyType.Add
else:
carb.log_error(f"provided action is currently not supported: ({action})")
asyncio.ensure_future(self.tags_action_async(url, new_tag, modify_type))
async def tags_action_async(self, url, tag, modify_type):
broken_url = omni.client.break_url(url)
host = broken_url.host
if not await self._verify_connection(host):
return
tag_dict = self.validate_tag(tag)
if tag_dict:
# 5 second timout for service initialization.
timeout = 5.0
while self._initializing and timeout > 0:
await asyncio.sleep(0.5)
timeout -= 0.5
constructed_tag = tagging_client.Tag(
name=tag_dict["key"], tag_namespace=tag_dict["full_namespace"], value=tag_dict["value"]
)
try:
# get the tags
results = await self._tagging_clients[host].service.modify_tags(
auth_token=self._auth_tokens[host],
client_id=self._tagging_clients[host].client_id,
paths=[broken_url.path],
tags=[constructed_tag],
modify_type=modify_type,
)
except AttributeError:
# service is still being initialized
carb.log_warn("Timeout waiting for tagging service initialization")
return
except TransportError as msg:
# lost connection to tagging service
carb.log_warn(f"TransportError: {msg}")
self._tagging_clients = {}
return
if self._delegate:
self._delegate.updated_tags_for_url(url)
def get_tags(self, urls, callback):
asyncio.ensure_future(self.get_tags_async(urls, callback))
async def get_tags_async(self, urls, callback=None):
paths = {}
for url in urls:
broken_url = omni.client.break_url(url)
host = broken_url.host
if not await self._verify_connection(host):
return
# 5 second timout for service initialization.
timeout = 5.0
while self._initializing and timeout > 0:
await asyncio.sleep(0.5)
timeout -= 0.5
if host not in paths:
paths[host] = [broken_url.path]
else:
paths[host].append(broken_url.path)
for host in paths:
try:
# get the tags
results = await self._tagging_clients[host].service.get_tags(
auth_token=self._auth_tokens[host], paths=paths[host]
)
except AttributeError as msg:
# service is still being initialized
carb.log_warn(f"Timeout waiting for tagging service initialization: {msg}")
return
except TransportError as msg:
# lost connection to tagging service
self._tagging_clients = {}
return
for i, result in enumerate(results["path_result"]):
if result["connection_status"] != 1: # OmniTaggingStatusCodeOk
carb.log_warn(f"Tagging Connection Error Code: {result['connection_status']}")
self._tagging_clients = {}
return
# TODO check connection status
if host not in self._path_results:
self._path_results[host] = {}
self._path_results[host][paths[host][i]] = result["tags"]
if callback is not None:
callback()
if self._delegate:
self._delegate.finished_getting_tags(urls)
return self.tags_for_url(urls[0])
def tags_for_url(self, url):
broken_url = omni.client.break_url(url)
host = broken_url.host
path = broken_url.path
if host in self._path_results and path in self._path_results[host]:
return self._path_results[host][path]
def pack_tag(self, namespace, hidden_label, kv_pair=None, key=None, value=None):
""" Changes a keyvalue pair tag into a string like "namespace.key=value"
Adds a leading . when the namespace has one, and ommits the =value when no value is present.
Format of tags:
[namespace].[key]{=value}
.[namespace].[label].[key]{=value}
For Example:
appearance.car
.appearance.generated.truck=60
.appearance.excluded.banana
tag_without_namespace
.excluded.tag_without_namespace
"""
if kv_pair is None:
if not value:
kv_pair = key
else:
kv_pair = key + "=" + value
if hidden_label and len(hidden_label) > 0:
if namespace == "":
return ".".join(["", hidden_label, kv_pair])
return ".".join(["", namespace, hidden_label, kv_pair])
if namespace == "":
return kv_pair
return ".".join([namespace, kv_pair])
def validate_tag(self, tag, allow_hidden_tags=True):
""" Validate the tag, make sure there is a category, namespace, and key,
and return the dict if valid.
"""
is_hidden = False
namespace = None
hidden_label = None
kv_split = tag.split("=")
full_key = kv_split[0]
val = ""
if len(kv_split) > 2:
carb.log_warn(f"Too many '=' characters in tag: {tag}")
return False
if ".." in full_key:
carb.log_warn(f"Invalid tag (too many consecutive .'s): {tag}")
return False
if len(kv_split) > 1:
val = kv_split[1]
dot_split = full_key.split(".")
# the full_namespace combines the hidden/system namespace with the normal one.
if len(dot_split) <= 1:
key = full_key
full_namespace = ""
else:
key = dot_split[-1]
full_namespace = ".".join(dot_split[:-1])
# remove the key
dot_split = dot_split[:-1]
if len(dot_split) >= 1 and dot_split[0] == "":
# a hidden/system namespace begins with a .
is_hidden = True
# remove the empty string
dot_split = dot_split[1:]
if len(dot_split) == 0:
carb.log_warn(f"Tag has an empty system namespace: {tag}")
return False
elif len(dot_split) == 1:
namespace = ""
hidden_label = "." + dot_split[0]
else:
# a namespace may contain multiple .'s, but the system namespace may not
hidden_label = "." + dot_split[-1]
namespace = ".".join(dot_split[:-1])
else:
if full_namespace == "":
namespace = ""
else:
namespace = ".".join(dot_split)
if not key:
return False
if is_hidden and not allow_hidden_tags:
return False
return {
"hidden_label": hidden_label,
"namespace": namespace,
"key": key,
"value": val,
"full_namespace": full_namespace,
}
def ordered_tag_list(self, tag_dict_list):
""" Returns a sorted (user tags, then generated in order of value) list of unique tags.
"""
tag_tuples = []
namespaces = list(set([d["tag_namespace"] for d in tag_dict_list]))
user_namespaces = []
generated_namespaces = []
excluded_namespaces = []
for n in namespaces:
if n[0] != ".":
user_namespaces.append(n)
elif n[0] == "." and n.split(".")[-1] == "generated":
generated_namespaces.append(n)
elif n[0] == "." and n.split(".")[-1] == "excluded":
excluded_namespaces.append(n)
user_namespaces.sort()
generated_namespaces.sort()
for gen_namespace in generated_namespaces:
stripped = gen_namespace[1 : -(1 + len("generated"))]
if stripped not in user_namespaces:
user_namespaces.append(stripped)
def safe_int(value):
try:
return int(value)
except ValueError:
return 0
# for each namespace, add user tags
# then add generated tags (if they are not already added or excluded) sorted by value
for n in user_namespaces:
g = "." + n + ".generated"
e = "." + n + ".excluded"
# tags will contain tuples (name, value)
tags = []
excluded = []
for tag_dict in tag_dict_list:
if tag_dict["tag_namespace"] == n:
tags.append((tag_dict["name"], 100))
elif tag_dict["tag_namespace"] == e and tag_dict["name"] not in tags:
excluded.append(tag_dict["name"])
for tag_dict in tag_dict_list:
if tag_dict["tag_namespace"] == g:
if tag_dict["name"] not in tags and tag_dict["name"] not in excluded:
tags.append((tag_dict["name"], safe_int(tag_dict["value"])))
if len(tags) > 0:
# sort by name, then by value descending
tags.sort(key=lambda x: x[0])
tag_tuples += sorted(tags, key=lambda x: -x[1])
tags = []
for t in tag_tuples:
# prevent duplicates
if t[0] not in tags:
tags.append(t[0])
return tags
def unpack_raw_tags(self, tag_dict_list):
""" Changes a list of strings into a dictionary.
Example tag: {'name': 'notebook', 'tag_namespace': 'appearance', 'value': ''}
Example tag: {'name': 'book', 'tag_namespace': 'appearance.generated', 'value': '50'}
Returns a dictionary like:
{
"appearance": {
"car": "",
".generated": { "truck": 99 },
".excluded": { "banana": "" }
}
}
"""
tags = {}
namespace = None
for tag_dict in tag_dict_list:
# join the namespace to the name and value of the tag.
# Examples: appearance.notebook, appearance.generated.book=10
if tag_dict["tag_namespace"] == "":
tag = tag_dict["name"]
else:
tag = ".".join([tag_dict["tag_namespace"], tag_dict["name"]])
if "value" in tag_dict and tag_dict["value"]:
tag = f"{tag}={tag_dict['value']}"
# recover namespace, key, value from single string
tag = self.validate_tag(tag)
if tag:
hidden_label = tag["hidden_label"]
namespace = tag["namespace"]
key = tag["key"]
val = tag["value"]
if len(val) > 50:
val = "(value too long to display)"
if namespace not in tags:
tags[namespace] = {}
if hidden_label and hidden_label not in tags[namespace]:
tags[namespace][hidden_label] = {}
if hidden_label:
tags[namespace][hidden_label][key] = val
else:
tags[namespace][key] = val
return tags
def get_tagging_instance():
return OmniKitTagging.static_instance
| 16,316 | Python | 35.179601 | 110 | 0.53898 |
omniverse-code/kit/exts/omni.kit.tagging/omni/kit/tagging/tests/test_tagging_plugin.py | import asyncio
import math
import unittest
import omni.kit.test
from omni.kit.tagging import get_tagging_instance
class TestTaggingPlugin(omni.kit.test.AsyncTestCase):
async def test_tagging_plugin_load(self):
tagging_interface = get_tagging_instance()
self.assertTrue(tagging_interface is not None)
async def test_tagging_validation(self):
tagging_interface = get_tagging_instance()
valid_tags = [
"book",
"book=10",
"appearance.book",
"appearance.book=10",
"appearance.generated.book",
"appearance.generated.book=10",
"visual.appearance.generated.book",
"visual.appearance.generated.book=10",
".appearance.generated.book",
".appearance.generated.book=10",
".generated.book",
".generated.book=10",
]
invalid_tags = ["", ".", "a=b=c", "...", ".test", "test.", "test.=1", "test..test", "test..test=10"]
for tag in valid_tags:
self.assertTrue(tagging_interface.validate_tag(tag))
for tag in invalid_tags:
self.assertFalse(tagging_interface.validate_tag(tag))
async def test_sorted_tags(self):
expected_dict = [
{"name": "binder", "tag_namespace": ".appearance.generated", "value": "50"},
{"name": "notebook", "tag_namespace": "appearance", "value": ""},
{"name": "book", "tag_namespace": "appearance", "value": ""},
{"name": "book", "tag_namespace": ".appearance.generated", "value": "80"},
{"name": "Lighter", "tag_namespace": ".ImageNet.generated", "value": "36"},
{"name": "Wafer", "tag_namespace": ".ImageNet.generated", "value": "47"},
{"name": "Knife", "tag_namespace": ".ImageNet.generated", "value": "2"},
{"name": "Knife", "tag_namespace": ".ImageNet.excluded", "value": ""},
]
sorted_tags = ["book", "notebook", "binder", "Wafer", "Lighter"]
tagging_interface = get_tagging_instance()
ordered_tags = tagging_interface.ordered_tag_list(expected_dict)
self.assertEqual(ordered_tags, sorted_tags)
| 2,201 | Python | 37.631578 | 108 | 0.574739 |
omniverse-code/kit/exts/omni.kit.window.toolbar/omni/kit/window/toolbar/simple_tool_button.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 omni.kit.app
omni.kit.app.log_deprecation(
'"import omni.kit.window.toolbar.simple_tool_button" is deprecated. '
'Please use "import omni.kit.widget.toolbar.simple_tool_button"'
)
try: # pragma: no cover
import inspect
for stackframe in inspect.stack():
if stackframe.code_context is None:
continue
code = stackframe.code_context[0]
if code and code.startswith(("import", "from")):
# name of importing file
omni.kit.app.log_deprecation(f"Imported from {stackframe.filename}")
break
except: # pragma: no cover
pass
from omni.kit.widget.toolbar.simple_tool_button import * # backward compatible
| 1,125 | Python | 37.827585 | 80 | 0.719111 |
omniverse-code/kit/exts/omni.kit.window.toolbar/omni/kit/window/toolbar/__init__.py | from .toolbar import *
from omni.kit.widget.toolbar.simple_tool_button import * # backward compatible
| 103 | Python | 33.666655 | 79 | 0.786408 |
omniverse-code/kit/exts/omni.kit.window.toolbar/omni/kit/window/toolbar/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 omni.kit.app # pragma: no cover
omni.kit.app.log_deprecation(
'"import omni.kit.window.toolbar.context_menu" is deprecated. '
'Please use "import omni.kit.widget.toolbar.context_menu"'
) # pragma: no cover
from omni.kit.widget.toolbar.context_menu import * # backward compatible # pragma: no cover
| 744 | Python | 48.666663 | 92 | 0.778226 |
omniverse-code/kit/exts/omni.kit.window.toolbar/omni/kit/window/toolbar/toolbar.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 weakref
from functools import lru_cache, partial
from pathlib import Path
import omni.kit.context_menu
import omni.ext
import omni.kit.app
import omni.ui as ui
from omni.kit.widget.toolbar.builtin_tools.builtin_tools import BuiltinTools # backward compatible
from omni.kit.widget.toolbar.commands import * # backward compatible
from omni.kit.widget.toolbar.context_menu import *
from omni.kit.widget.toolbar.widget_group import WidgetGroup # backward compatible
from omni.kit.widget.toolbar import get_instance as _get_widget_instance
DATA_PATH = Path()
_toolbar_instance = None
@lru_cache()
def get_data_path() -> Path:
return DATA_PATH
def get_instance():
return _toolbar_instance
# Any class derived from `omni.ext.IExt` in top level module (defined in `python.modules` of `extension.toml`) will be
# instantiated when extension gets enabled and `on_startup(ext_id)` will be called. Later when extension gets disabled
# on_shutdown() is called.
class Toolbar(omni.ext.IExt):
WINDOW_NAME = "Main ToolBar"
MENU_PATH = "Window/ToolBar"
def __init__(self):
self._main_toolbar = None
super().__init__()
# ext_id is current extension id. It can be used with extension manager to query additional information, like where
# this extension is located on filesystem.
def on_startup(self, ext_id):
import omni.kit.app
manager = omni.kit.app.get_app().get_extension_manager()
extension_path = manager.get_extension_path(ext_id)
global DATA_PATH
DATA_PATH = Path(extension_path).joinpath("data")
ui.Workspace.set_show_window_fn(Toolbar.WINDOW_NAME, partial(self._show_hide_window, None))
self._sub_grab_mouse_pressed = None
self._show_hide_menu_entry = None
self._widget_instance = _get_widget_instance()
self._main_toolbar = None
self._dock_task = None
self.create_main_toolbar()
try:
import omni.kit.ui
self._menu = omni.kit.ui.get_editor_menu().add_item(
self.MENU_PATH, self._show_hide_window, toggle=True, value=self._main_toolbar.visible
)
except ImportError: # pragma: no cover
pass
global _toolbar_instance
_toolbar_instance = self
def on_shutdown(self):
global _toolbar_instance
_toolbar_instance = None
if self._dock_task is not None: # pragma: no cover
self._dock_task.cancel()
try:
import omni.kit.ui
omni.kit.ui.get_editor_menu().remove_item(self.MENU_PATH)
except ImportError: # pragma: no cover
pass
self._show_hide_menu_entry = None
self._widget_instance = None
self._menu = None
if self._main_toolbar:
self._main_toolbar.destroy()
self._main_toolbar = None
self._sub_grab_mouse_pressed = None
ui.Workspace.set_show_window_fn(Toolbar.WINDOW_NAME, None)
@property
def context_menu(self):
return self._widget_instance.context_menu
def create_main_toolbar(self):
self._main_toolbar = ui.ToolBar(Toolbar.WINDOW_NAME, noTabBar=False, padding_x=3, padding_y=3, margin=5)
self._main_toolbar.set_axis_changed_fn(self._on_axis_changed)
self._rebuild_toolbar()
self._register_context_menu()
self._dock_task = asyncio.ensure_future(Toolbar._dock())
def add_widget(self, widget_group: "WidgetGroup", priority: int, context: str = ""):
self._widget_instance.add_widget(widget_group, priority, context=context)
def remove_widget(self, widget_group: "WidgetGroup"):
self._widget_instance.remove_widget(widget_group)
def get_widget(self, name: str):
return self._widget_instance.get_widget(name)
def acquire_toolbar_context(self, context: str):
"""
Request toolbar to switch to given context.
It takes the context preemptively even if previous context owner has not release the context.
Args:
context (str): Context to switch to.
Returns:
A token to be used to release_toolbar_context
"""
return self._widget_instance.acquire_toolbar_context(context)
def release_toolbar_context(self, token: int):
"""
Request toolbar to release context associated with token.
If token is expired (already released or context ownership taken by others), this function does nothing.
Args:
token (int): Context token to release.
"""
self._widget_instance.release_toolbar_context(token)
def get_context(self):
return self._widget_instance.get_context()
def _on_axis_changed(self, axis):
self._widget_instance.set_axis(axis)
self._rebuild_toolbar()
def _rebuild_toolbar(self):
self._main_toolbar.frame.clear()
self._widget_instance.rebuild_toolbar(root_frame=self._main_toolbar.frame)
self._sub_grab_mouse_pressed = self._widget_instance.subscribe_grab_mouse_pressed(
self.__on_grab_mouse_pressed
)
# Toolbar context menu on the grab area
def __on_grab_mouse_pressed(self, x, y, button, *args, **kwargs):
if button == 1: # Right click, show immediately
event = ContextMenuEvent()
event.payload["widget_name"] = "grab"
self.context_menu.on_mouse_event(event)
def _register_context_menu(self):
context_menu = omni.kit.context_menu.get_instance()
def is_button(objects: dict, button_name: str):
return objects.get("widget_name", None) == button_name
if context_menu:
menu = {
"name": "Hide",
"show_fn": [lambda obj: is_button(obj, "grab")],
"onclick_fn": self._menu_hide_toolbar,
}
self._show_hide_menu_entry = omni.kit.context_menu.add_menu(menu, "grab", "omni.kit.window.toolbar")
def _show_hide_window(self, menu, value): # pragma: no cover
self._main_toolbar.visible = value
@staticmethod
async def _dock():
frame = 3
while frame > 0:
viewport = ui.Workspace.get_window("Viewport")
if viewport: # pragma: no cover
await omni.kit.app.get_app().next_update_async()
break
await omni.kit.app.get_app().next_update_async()
frame -= 1
toolbar = ui.Workspace.get_window(Toolbar.WINDOW_NAME)
if viewport and toolbar: # pragma: no cover
toolbar.dock_in(viewport, ui.DockPosition.LEFT)
_toolbar_instance._dock_task = None
def _menu_hide_toolbar(self, objects): # pragma: no cover
if self._main_toolbar is not None:
self._main_toolbar.visible = False
import omni.kit.ui
omni.kit.ui.get_editor_menu().set_value("Window/ToolBar", False)
def add_custom_select_type(self, entry_name: str, selection_types: list):
self._widget_instance.add_custom_select_type(entry_name, selection_types)
def remove_custom_select(self, entry_name):
self._widget_instance.remove_custom_select(entry_name)
| 7,683 | Python | 34.086758 | 119 | 0.645451 |
omniverse-code/kit/exts/omni.kit.window.toolbar/omni/kit/window/toolbar/builtin_tools/play_button_group.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 omni.kit.app
omni.kit.app.log_deprecation(
'"import omni.kit.window.toolbar.builtin_tools.play_button_group" is deprecated. '
'Please use "import omni.kit.widget.toolbar.builtin_tools.play_button_group"'
)
from omni.kit.widget.toolbar.builtin_tools.play_button_group import * # backward compatible
| 742 | Python | 48.53333 | 92 | 0.792453 |
omniverse-code/kit/exts/omni.kit.window.toolbar/omni/kit/window/toolbar/tests/__init__.py | from .test_docking import *
| 28 | Python | 13.499993 | 27 | 0.75 |
omniverse-code/kit/exts/omni.kit.window.toolbar/omni/kit/window/toolbar/tests/test_docking.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 asyncio
import carb.input
import omni.appwindow
import omni.kit.app
import omni.kit.test
import omni.kit.window.toolbar
import omni.ui as ui
import omni.kit.ui_test as ui_test
from omni.ui.tests.test_base import OmniUiTest
from omni.kit.ui_test import emulate_mouse_move, emulate_mouse_move_and_click, Vec2
from omni.kit.ui_test.input import emulate_mouse
from carb.input import MouseEventType
from omni.kit.widget.toolbar.tests.helpers import reset_toolbar_settings
from omni.kit.widget.toolbar import WidgetGroup
GOLDEN_IMAGE_DIR = omni.kit.window.toolbar.get_data_path().joinpath("test", "golden_img").absolute()
class ToolbarDockingTest(OmniUiTest):
async def setUp(self):
await super().setUp()
reset_toolbar_settings()
self._main_dockspace = ui.Workspace.get_window("DockSpace")
self._toolbar_handle = ui.Workspace.get_window(omni.kit.window.toolbar.Toolbar.WINDOW_NAME)
self._toolbar_handle.undock()
# Move mouse to origin
await emulate_mouse_move(Vec2(0, 0))
await ui_test.human_delay(10)
async def test_docking_vertical(self):
"""Test vertical docking behavior."""
self._toolbar_handle.dock_in(self._main_dockspace, ui.DockPosition.LEFT)
await ui_test.human_delay(10)
await self.finalize_test(golden_img_dir=GOLDEN_IMAGE_DIR, golden_img_name="v_dock.png")
async def test_docking_horizontal(self):
"""Test horizontal docking behavior."""
self._toolbar_handle.dock_in(self._main_dockspace, ui.DockPosition.TOP)
await ui_test.human_delay(10)
await self.finalize_test(golden_img_dir=GOLDEN_IMAGE_DIR, golden_img_name="h_dock.png")
async def test_docking_vertical_context_menu(self):
"""Test vertical docking behavior showing context menu."""
self._toolbar_handle.dock_in(self._main_dockspace, ui.DockPosition.LEFT)
await ui_test.human_delay(10)
await emulate_mouse_move_and_click(Vec2(35, 135), right_click=True)
await ui_test.human_delay(10)
await self.finalize_test(golden_img_dir=GOLDEN_IMAGE_DIR, golden_img_name="v_dock_menu.png")
async def test_docking_horizontal_context_menu(self):
"""Test horizontal docking behavior showing context menu."""
self._toolbar_handle.dock_in(self._main_dockspace, ui.DockPosition.TOP)
await ui_test.human_delay(10)
await emulate_mouse_move_and_click(Vec2(125, 35), right_click=True)
await ui_test.human_delay(10)
await self.finalize_test(golden_img_dir=GOLDEN_IMAGE_DIR, golden_img_name="h_dock_menu.png")
async def test_docking_vertical_grab_context_menu(self):
"""Test vertical docking behavior showing grabber context menu."""
self._toolbar_handle.dock_in(self._main_dockspace, ui.DockPosition.LEFT)
await ui_test.human_delay(10)
await emulate_mouse_move_and_click(Vec2(15, 35), right_click=True)
await ui_test.human_delay(10)
# sometimes the menu appears 1 pixel lower than expected
await self.finalize_test(golden_img_dir=GOLDEN_IMAGE_DIR, golden_img_name="v_dock_grab_menu.png", threshold=0.07)
async def test_adding_widget(self):
class TestToolButtonGroup(WidgetGroup):
"""
Test of how to create two ToolButton in one WidgetGroup
"""
def __init__(self):
super().__init__()
def get_style(self):
return {}
def create(self, default_size):
button1 = ui.ToolButton(
name="test1",
width=default_size,
height=default_size,
)
button2 = ui.ToolButton(
name="test2",
width=default_size,
height=default_size,
)
# return a dictionary of name -> widget if you want to expose it to other widget_group
return {"test1": button1, "test2": button2}
widget_group = TestToolButtonGroup()
toolbar = omni.kit.window.toolbar.get_instance()
context = toolbar.acquire_toolbar_context('test')
toolbar.add_widget(widget_group, 100)
await ui_test.human_delay()
self.assertIsNotNone(toolbar.get_widget('test1'))
toolbar.remove_widget(widget_group)
toolbar.add_custom_select_type('test', ['test'])
toolbar.remove_custom_select('test')
self.assertEqual(toolbar.get_context(), 'test')
toolbar.release_toolbar_context(context)
| 5,035 | Python | 37.151515 | 121 | 0.662761 |
omniverse-code/kit/exts/usdrt.gf/python/usdrt/Gf/__init__.py | __copyright__ = "Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved."
__license__ = """
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 ._Gf import *
| 470 | Python | 41.818178 | 78 | 0.795745 |
omniverse-code/kit/exts/usdrt.gf/python/usdrt/Gf/tests/testGfRect.py | #!/pxrpythonsubst
#
# Copyright 2016 Pixar
#
# Licensed under the Apache License, Version 2.0 (the "Apache License")
# with the following modification; you may not use this file except in
# compliance with the Apache License and the following modification to it:
# Section 6. Trademarks. is deleted and replaced with:
#
# 6. Trademarks. This License does not grant permission to use the trade
# names, trademarks, service marks, or product names of the Licensor
# and its affiliates, except as required to comply with Section 4(c) of
# the License and to reproduce the content of the NOTICE file.
#
# You may obtain a copy of the Apache License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the Apache License with the above modification is
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the Apache License for the specific
# language governing permissions and limitations under the Apache License.
#
# Note: This is just pulled directly from USD and modified.
# https://github.com/PixarAnimationStudios/USD/blob/release/pxr/base/gf/testenv/testGfRect2i.py
from __future__ import division
import math
import sys
import unittest
def setUpModule():
# pre-load USD before anything else to prevent crash
# from weird carb conflict
# FIXME ^^^
try:
from . import update_path_and_load_usd
update_path_and_load_usd()
except ImportError:
# not needed in Kit
pass
try:
import omni.kit.test
TestClass = omni.kit.test.AsyncTestCase
except ImportError:
TestClass = unittest.TestCase
from usdrt import Gf
class TestGfRect2i(TestClass):
def test_Constructor(self):
self.assertIsInstance(Gf.Rect2i(), Gf.Rect2i)
self.assertIsInstance(Gf.Rect2i(Gf.Vec2i(), Gf.Vec2i()), Gf.Rect2i)
self.assertIsInstance(Gf.Rect2i(Gf.Vec2i(), 1, 1), Gf.Rect2i)
self.assertTrue(Gf.Rect2i().IsNull())
self.assertTrue(Gf.Rect2i().IsEmpty())
self.assertFalse(Gf.Rect2i().IsValid())
# further test of above.
r = Gf.Rect2i(Gf.Vec2i(), Gf.Vec2i(-1, 0))
self.assertTrue(not r.IsNull() and r.IsEmpty())
self.assertEqual(
Gf.Rect2i(Gf.Vec2i(-1, 1), Gf.Vec2i(1, -1)).GetNormalized(), Gf.Rect2i(Gf.Vec2i(-1, -1), Gf.Vec2i(1, 1))
)
def test_Properties(self):
r = Gf.Rect2i()
r.max = Gf.Vec2i()
r.min = Gf.Vec2i(1, 1)
r.GetNormalized()
r.max = Gf.Vec2i(1, 1)
r.min = Gf.Vec2i()
r.GetNormalized()
r.min = Gf.Vec2i(3, 1)
self.assertEqual(r.min, Gf.Vec2i(3, 1))
r.max = Gf.Vec2i(4, 5)
self.assertEqual(r.max, Gf.Vec2i(4, 5))
r.minX = 10
self.assertEqual(r.minX, 10)
r.maxX = 20
self.assertEqual(r.maxX, 20)
r.minY = 30
self.assertEqual(r.minY, 30)
r.maxY = 40
self.assertEqual(r.maxY, 40)
r = Gf.Rect2i(Gf.Vec2i(), Gf.Vec2i(10, 10))
self.assertEqual(r.GetCenter(), Gf.Vec2i(5, 5))
self.assertEqual(r.GetArea(), 121)
self.assertEqual(r.GetHeight(), 11)
self.assertEqual(r.GetWidth(), 11)
self.assertEqual(r.GetSize(), Gf.Vec2i(11, 11))
r.Translate(Gf.Vec2i(10, 10))
self.assertEqual(r, Gf.Rect2i(Gf.Vec2i(10, 10), Gf.Vec2i(20, 20)))
r1 = Gf.Rect2i()
r2 = Gf.Rect2i(Gf.Vec2i(), Gf.Vec2i(1, 1))
r1.GetIntersection(r2)
r2.GetIntersection(r1)
r1.GetIntersection(r1)
r1.GetUnion(r2)
r2.GetUnion(r1)
r1.GetUnion(r1)
r1 = Gf.Rect2i(Gf.Vec2i(0, 0), Gf.Vec2i(10, 10))
r2 = Gf.Rect2i(Gf.Vec2i(5, 5), Gf.Vec2i(15, 15))
self.assertEqual(r1.GetIntersection(r2), Gf.Rect2i(Gf.Vec2i(5, 5), Gf.Vec2i(10, 10)))
self.assertEqual(r1.GetUnion(r2), Gf.Rect2i(Gf.Vec2i(0, 0), Gf.Vec2i(15, 15)))
tmp = Gf.Rect2i(r1)
tmp += r2
self.assertEqual(tmp, Gf.Rect2i(Gf.Vec2i(0, 0), Gf.Vec2i(15, 15)))
self.assertTrue(r1.Contains(Gf.Vec2i(3, 3)) and not r1.Contains(Gf.Vec2i(11, 11)))
self.assertEqual(r1, Gf.Rect2i(Gf.Vec2i(0, 0), Gf.Vec2i(10, 10)))
self.assertTrue(r1 != r2)
self.assertEqual(r1, eval(repr(r1)))
self.assertTrue(len(str(Gf.Rect2i())))
if __name__ == "__main__":
unittest.main()
| 4,475 | Python | 29.657534 | 116 | 0.631732 |
omniverse-code/kit/exts/usdrt.gf/python/usdrt/Gf/tests/test_gf_quat_extras.py | __copyright__ = "Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved."
__license__ = """
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 copy
import math
import os
import platform
import sys
import time
import unittest
from . import TestRtScenegraph, tc_logger, update_path_and_load_usd
def setUpModule():
# pre-load USD before anything else to prevent crash
# from weird carb conflict
# FIXME ^^^
update_path_and_load_usd()
def get_quat_info():
"""Return list of tuples of class, scalar size, and format string"""
from usdrt import Gf
quat_info = [
(Gf.Quatd, 8, "d"),
(Gf.Quatf, 4, "f"),
(Gf.Quath, 2, "e"),
]
return quat_info
def get_quat_numpy_types():
import numpy
import usdrt
equivalent_types = {
usdrt.Gf.Quatd: numpy.double,
usdrt.Gf.Quatf: numpy.single,
usdrt.Gf.Quath: numpy.half,
}
return equivalent_types
class TestGfQuatBuffer(TestRtScenegraph):
"""Test buffer protocol for usdrt.Gf.Quat* classes"""
@tc_logger
def test_buffer_inspect(self):
"""Use memoryview to validate that buffer protocol is implemented"""
quat_info = get_quat_info()
test_values = [9, 8, 7, 1]
for Quat, size, fmt in quat_info:
q = Quat(test_values[3], test_values[0], test_values[1], test_values[2])
view = memoryview(q)
self.assertEquals(view.itemsize, size)
self.assertEquals(view.ndim, 1)
self.assertEquals(view.shape, (4,))
self.assertEquals(view.format, fmt)
self.assertEquals(view.obj, Quat(test_values[3], test_values[0], test_values[1], test_values[2]))
@tc_logger
def test_buffer_init(self):
"""Validate initialization from an array using buffer protocol"""
import array
quat_info = get_quat_info()
test_values = [9, 8, 7, 1]
for Quat, size, fmt in quat_info:
if fmt == "e":
# GfHalf not supported with array.array
continue
test_array = array.array(fmt, test_values)
test_quat = Quat(test_array)
self.assertEquals(test_quat, Quat(test_values[3], test_values[0], test_values[1], test_values[2]))
@tc_logger
def test_buffer_init_from_numpy_type(self):
"""Test initialization from numpy types"""
import numpy
quat_info = get_quat_info()
equivalent_types = get_quat_numpy_types()
test_values = [9, 8, 7, 1]
for Quat, size, fmt in quat_info:
test_numpy_type = numpy.array(test_values, dtype=equivalent_types[Quat])
test_quat = Quat(test_numpy_type)
self.assertEquals(test_quat, Quat(test_values[3], test_values[0], test_values[1], test_values[2]))
@tc_logger
def test_buffer_init_wrong_type(self):
"""Verify that an exception is raised with initializing via buffer with different data type"""
import array
quat_info = get_quat_info()
test_values = [9, 8, 7, 1]
for Quat, size, fmt in quat_info:
test_array = array.array("h", test_values)
with self.assertRaises(ValueError):
test_quat = Quat(test_array)
@tc_logger
def test_buffer_init_wrong_size(self):
"""Verify that an exception is raised with initializing via buffer with different data array length"""
import array
quat_info = get_quat_info()
test_values = [9, 8, 7, 6, 1]
for Quat, size, fmt in quat_info:
if fmt == "e":
# GfHalf not supported with array.array
continue
test_array = array.array(fmt, test_values)
with self.assertRaises(ValueError):
test_vec = Quat(test_array)
@tc_logger
def test_buffer_init_wrong_dimension(self):
"""Verify that an exception is raised with initializing via buffer with different data dimensions"""
import numpy
quat_info = get_quat_info()
equivalent_types = get_quat_numpy_types()
test_values = [9, 8, 7, 1]
for Quat, size, fmt in quat_info:
test_array = numpy.array([test_values, test_values], dtype=equivalent_types[Quat])
with self.assertRaises(ValueError):
test_quat = Quat(test_array)
class TestGfQuatGetSetItem(TestRtScenegraph):
"""Test item accessors for usdrt.Gf.Quat* classes"""
@tc_logger
def test_get_item(self):
"""Validate __getitem__ on GfQuat"""
from usdrt import Gf
for Quat in [Gf.Quatf, Gf.Quatd, Gf.Quath]:
q = Quat(0.5, 1, 2, 3)
# Note that these are in memory layout order,
# which is different from constructor order
self.assertEqual(q[0], 1)
self.assertEqual(q[1], 2)
self.assertEqual(q[2], 3)
self.assertEqual(q[3], 0.5)
self.assertEqual(q[-4], 1)
self.assertEqual(q[-3], 2)
self.assertEqual(q[-2], 3)
self.assertEqual(q[-1], 0.5)
@tc_logger
def test_set_item(self):
"""Validate __setitem__ on GfQuat"""
from usdrt import Gf
for Quat in [Gf.Quatf, Gf.Quatd, Gf.Quath]:
q = Quat()
self.assertEqual(q.imaginary[0], 0)
self.assertEqual(q.imaginary[1], 0)
self.assertEqual(q.imaginary[2], 0)
self.assertEqual(q.real, 0)
q[0] = 1
q[1] = 2
q[2] = 3
q[3] = 0.5
self.assertEqual(q.imaginary[0], 1)
self.assertEqual(q.imaginary[1], 2)
self.assertEqual(q.imaginary[2], 3)
self.assertEqual(q.real, 0.5)
@tc_logger
def test_get_item_slice(self):
"""Validate __getitem__ with a slice on GfQuat"""
from usdrt import Gf
for Quat in [Gf.Quatf, Gf.Quatd, Gf.Quath]:
q = Quat(0.5, 1, 2, 3)
self.assertEqual(q[1:], [2, 3, 0.5])
@tc_logger
def test_set_item_slice(self):
"""Validate __setitem__ with a slice on GfQuat"""
from usdrt import Gf
for Quat in [Gf.Quatf, Gf.Quatd, Gf.Quath]:
q = Quat(0.5, 1, 2, 3)
self.assertEqual(q.imaginary[0], 1)
self.assertEqual(q.imaginary[1], 2)
self.assertEqual(q.imaginary[2], 3)
self.assertEqual(q.real, 0.5)
q[1:] = [5, 6, 7]
self.assertEqual(q.imaginary[0], 1)
self.assertEqual(q.imaginary[1], 5)
self.assertEqual(q.imaginary[2], 6)
self.assertEqual(q.real, 7)
class TestGfQuatCopy(TestRtScenegraph):
"""Test copy and deepcopy support for Gf.Quat* classes"""
@tc_logger
def test_copy(self):
"""Test __copy__"""
quat_info = get_quat_info()
for Quat, size, fmt in quat_info:
x = Quat()
y = x
self.assertTrue(y is x)
y[0] = 10
self.assertEqual(x[0], 10)
z = copy.copy(y)
self.assertFalse(z is y)
y[0] = 100
self.assertEqual(z[0], 10)
@tc_logger
def test_deepcopy(self):
"""Test __deepcopy__"""
quat_info = get_quat_info()
for Quat, size, fmt in quat_info:
x = Quat()
y = x
self.assertTrue(y is x)
y[0] = 10
self.assertEqual(x[0], 10)
z = copy.deepcopy(y)
self.assertFalse(z is y)
y[0] = 100
self.assertEqual(z[0], 10)
class TestGfQuatDebugging(TestRtScenegraph):
"""Test human readable output functions for debugging"""
@tc_logger
def test_repr_representation(self):
"""Test __repr__"""
from usdrt import Gf
test_quat = Gf.Quatf(0.5, 1, 2, 3)
expected = "Gf.Quatf(0.5, Gf.Vec3f(1.0, 2.0, 3.0))"
self.assertEqual(repr(test_quat), expected)
| 8,350 | Python | 27.796552 | 110 | 0.572455 |
omniverse-code/kit/exts/usdrt.gf/python/usdrt/Gf/tests/testGfVec.py | # Copyright 2016 Pixar
#
# Licensed under the Apache License, Version 2.0 (the "Apache License")
# with the following modification; you may not use this file except in
# compliance with the Apache License and the following modification to it:
# Section 6. Trademarks. is deleted and replaced with:
#
# 6. Trademarks. This License does not grant permission to use the trade
# names, trademarks, service marks, or product names of the Licensor
# and its affiliates, except as required to comply with Section 4(c) of
# the License and to reproduce the content of the NOTICE file.
#
# You may obtain a copy of the Apache License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the Apache License with the above modification is
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the Apache License for the specific
# language governing permissions and limitations under the Apache License.
#
# Note: This is just pulled directly from USD and lightly modified
# https://github.com/PixarAnimationStudios/USD/blob/release/pxr/base/gf/testenv/testGfVec.py
from __future__ import division
__copyright__ = "Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved."
__license__ = """
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 os
import platform
import sys
import time
import unittest
##### Uncomment for better assert messages
# if 'unittest.util' in __import__('sys').modules:
# # Show full diff in self.assertEqual.
# __import__('sys').modules['unittest.util']._MAX_LENGTH = 999999999
def setUpModule():
# pre-load USD before anything else to prevent crash
# from weird carb conflict
# FIXME ^^^
try:
from . import update_path_and_load_usd
update_path_and_load_usd()
except ImportError:
# not needed in Kit
pass
try:
import omni.kit.test
TestClass = omni.kit.test.AsyncTestCase
except ImportError:
TestClass = unittest.TestCase
import math
import sys
import unittest
def floatTypeRank(vec):
from usdrt import Gf
vecIntTypes = [Gf.Vec2i, Gf.Vec3i, Gf.Vec4i]
vecDoubleTypes = [Gf.Vec2d, Gf.Vec3d, Gf.Vec4d]
vecFloatTypes = [Gf.Vec2f, Gf.Vec3f, Gf.Vec4f]
vecHalfTypes = [Gf.Vec2h, Gf.Vec3h, Gf.Vec4h]
if vec in vecDoubleTypes:
return 3
elif vec in vecFloatTypes:
return 2
elif vec in vecHalfTypes:
return 1
def isFloatingPoint(vec):
from usdrt import Gf
vecIntTypes = [Gf.Vec2i, Gf.Vec3i, Gf.Vec4i]
vecDoubleTypes = [Gf.Vec2d, Gf.Vec3d, Gf.Vec4d]
vecFloatTypes = [Gf.Vec2f, Gf.Vec3f, Gf.Vec4f]
vecHalfTypes = [Gf.Vec2h, Gf.Vec3h, Gf.Vec4h]
return (vec in vecDoubleTypes) or (vec in vecFloatTypes) or (vec in vecHalfTypes)
def getEps(vec):
rank = floatTypeRank(vec)
if rank == 1:
return 1e-2
elif rank == 2:
return 1e-3
elif rank == 3:
return 1e-4
def vecWithType(vecType, type):
from usdrt import Gf
if vecType.dimension == 2:
if type == "d":
return Gf.Vec2d
elif type == "f":
return Gf.Vec2f
elif type == "h":
return Gf.Vec2h
elif type == "i":
return Gf.Vec2i
elif vecType.dimension == 3:
if type == "d":
return Gf.Vec3d
elif type == "f":
return Gf.Vec3f
elif type == "h":
return Gf.Vec3h
elif type == "i":
return Gf.Vec3i
elif vecType.dimension == 4:
if type == "d":
return Gf.Vec4d
elif type == "f":
return Gf.Vec4f
elif type == "h":
return Gf.Vec4h
elif type == "i":
return Gf.Vec4i
assert False, "No valid conversion for " + vecType + " to type " + type
return None
def checkVec(vec, values):
for i in range(len(vec)):
if vec[i] != values[i]:
return False
return True
def checkVecDot(v1, v2, dp):
if len(v1) != len(v2):
return False
checkdp = 0
for i in range(len(v1)):
checkdp += v1[i] * v2[i]
return checkdp == dp
def SetVec(vec, values):
for i in range(len(vec)):
vec[i] = values[i]
class TestGfVec(TestClass):
def ConstructorsTest(self, Vec):
# no arg constructor
self.assertIsInstance(Vec(), Vec)
# default constructor
v = Vec()
for x in v:
self.assertEqual(0, x)
# copy constructor
v = Vec()
for i in range(len(v)):
v[i] = i
v2 = Vec(v)
for i in range(len(v2)):
self.assertEqual(v[i], v2[i])
# explicit constructor
values = [3, 1, 4, 1]
if Vec.dimension == 2:
v = Vec(3, 1)
self.assertTrue(checkVec(v, values))
elif Vec.dimension == 3:
v = Vec(3, 1, 4)
self.assertTrue(checkVec(v, values))
elif Vec.dimension == 4:
v = Vec(3, 1, 4, 1)
self.assertTrue(checkVec(v, values))
else:
self.assertTrue(False, "No explicit constructor check for " + Vec)
# constructor taking single scalar value.
v = Vec(0)
self.assertTrue(all([x == 0 for x in v]))
v = Vec(1)
self.assertTrue(all([x == 1 for x in v]))
v = Vec(2)
self.assertTrue(all([x == 2 for x in v]))
# conversion from other types to this float type.
if isFloatingPoint(Vec):
for t in "dfih":
V = vecWithType(Vec, t)
self.assertTrue(Vec(V()))
# comparison to int type
Veci = vecWithType(Vec, "i")
vi = Veci()
SetVec(vi, (3, 1, 4, 1))
self.assertEqual(Vec(vi), vi)
if isFloatingPoint(Vec):
# Comparison to float type
for t in "dfh":
V = vecWithType(Vec, t)
v = V()
SetVec(v, (0.3, 0.1, 0.4, 0.1))
if floatTypeRank(Vec) >= floatTypeRank(V):
self.assertEqual(Vec(v), v)
else:
self.assertNotEqual(Vec(v), v)
def OperatorsTest(self, Vec):
from usdrt import Gf
v1 = Vec()
v2 = Vec()
# equality
SetVec(v1, [3, 1, 4, 1])
SetVec(v2, [3, 1, 4, 1])
self.assertEqual(v1, v2)
# inequality
SetVec(v1, [3, 1, 4, 1])
SetVec(v2, [5, 9, 2, 6])
self.assertNotEqual(v1, v2)
# component-wise addition
SetVec(v1, [3, 1, 4, 1])
SetVec(v2, [5, 9, 2, 6])
v3 = v1 + v2
v1 += v2
self.assertTrue(checkVec(v1, [8, 10, 6, 7]))
self.assertTrue(checkVec(v3, [8, 10, 6, 7]))
# component-wise subtraction
SetVec(v1, [3, 1, 4, 1])
SetVec(v2, [5, 9, 2, 6])
v3 = v1 - v2
v1 -= v2
self.assertTrue(checkVec(v1, [-2, -8, 2, -5]))
self.assertTrue(checkVec(v3, [-2, -8, 2, -5]))
# component-wise multiplication
SetVec(v1, [3, 1, 4, 1])
SetVec(v2, [5, 9, 2, 6])
v4 = v1 * 10
v5 = 10 * v1
v1 *= 10
self.assertTrue(checkVec(v1, [30, 10, 40, 10]))
self.assertTrue(checkVec(v4, [30, 10, 40, 10]))
self.assertTrue(checkVec(v5, [30, 10, 40, 10]))
# component-wise division
SetVec(v1, [3, 6, 9, 12])
v3 = v1 / 3
v1 /= 3
self.assertTrue(checkVec(v1, [1, 2, 3, 4]))
self.assertTrue(checkVec(v3, [1, 2, 3, 4]))
# dot product
SetVec(v1, [3, 1, 4, 1])
SetVec(v2, [5, 9, 2, 6])
dp = v1 * v2
dp2 = Gf.Dot(v1, v2)
dp3 = v1.GetDot(v2) # 2x compatibility
self.assertTrue(checkVecDot(v1, v2, dp))
self.assertTrue(checkVecDot(v1, v2, dp2))
self.assertTrue(checkVecDot(v1, v2, dp3))
# unary minus (negation)
SetVec(v1, [3, 1, 4, 1])
self.assertTrue(checkVec(-v1, [-3, -1, -4, -1]))
# repr
self.assertEqual(v1, eval(repr(v1)))
# string
self.assertTrue(len(str(Vec())) > 0)
# indexing
v = Vec()
for i in range(Vec.dimension):
v[i] = i + 1
self.assertEqual(v[-1], v[v.dimension - 1])
self.assertEqual(v[0], 1)
self.assertIn(v.dimension, v)
self.assertNotIn(v.dimension + 1, v)
with self.assertRaises(IndexError):
v[v.dimension + 1] = v.dimension + 1
# slicing
v = Vec()
value = [3, 1, 4, 1]
SetVec(v, value)
value = v[0 : v.dimension]
self.assertEqual(v[:], value)
self.assertEqual(v[:2], value[:2])
self.assertEqual(v[0:2], value[0:2])
self.assertEqual(v[-2:], value[-2:])
self.assertEqual(v[1:1], [])
if v.dimension > 2:
self.assertEqual(v[0:3:2], [3, 4])
v[:2] = (8, 9)
checkVec(v, [8, 9, 4, 1])
if v.dimension > 2:
v[:3:2] = [0, 1]
checkVec(v, [0, 9, 1, 1])
with self.assertRaises(ValueError):
# This should fail. Wrong length sequence
#
v[:2] = [1, 2, 3]
with self.assertRaises(TypeError):
# This should fail. Cannot use floats for indices
v[0.0:2.0] = [7, 7]
with self.assertRaises(TypeError):
# This should fail. Cannot convert None to vector data
#
v[:2] = [None, None]
def MethodsTest(self, Vec):
from usdrt import Gf
v1 = Vec()
v2 = Vec()
if isFloatingPoint(Vec):
eps = getEps(Vec)
# length
SetVec(v1, [3, 1, 4, 1])
l = Gf.GetLength(v1)
l2 = v1.GetLength()
self.assertTrue(Gf.IsClose(l, l2, eps), repr(l) + " " + repr(l2))
self.assertTrue(
Gf.IsClose(l, math.sqrt(Gf.Dot(v1, v1)), eps),
" ".join([repr(x) for x in [l, v1, math.sqrt(Gf.Dot(v1, v1))]]),
)
# Normalize...
SetVec(v1, [3, 1, 4, 1])
v2 = Vec(v1)
v2.Normalize()
nv = Gf.GetNormalized(v1)
nv2 = v1.GetNormalized()
nvcheck = v1 / Gf.GetLength(v1)
self.assertTrue(Gf.IsClose(nv, nvcheck, eps))
self.assertTrue(Gf.IsClose(nv2, nvcheck, eps))
self.assertTrue(Gf.IsClose(v2, nvcheck, eps))
SetVec(v1, [3, 1, 4, 1])
nv = v1.GetNormalized()
nvcheck = v1 / Gf.GetLength(v1)
self.assertTrue(Gf.IsClose(nv, nvcheck, eps)) # nv edit - linalg implementation not exactly equal
SetVec(v1, [0, 0, 0, 0])
v1.Normalize()
self.assertTrue(checkVec(v1, [0, 0, 0, 0]))
SetVec(v1, [2, 0, 0, 0])
Gf.Normalize(v1)
self.assertTrue(checkVec(v1, [1, 0, 0, 0]))
# projection
SetVec(v1, [3, 1, 4, 1])
SetVec(v2, [5, 9, 2, 6])
p1 = Gf.GetProjection(v1, v2)
p2 = v1.GetProjection(v2)
check = (v1 * v2) * v2
self.assertEqual(p1, check)
self.assertEqual(p2, check)
# complement
SetVec(v1, [3, 1, 4, 1])
SetVec(v2, [5, 9, 2, 6])
p1 = Gf.GetComplement(v1, v2)
p2 = v1.GetComplement(v2)
check = v1 - (v1 * v2) * v2
self.assertTrue((p1 == check) and (p2 == check))
# component-wise multiplication
SetVec(v1, [3, 1, 4, 1])
SetVec(v2, [5, 9, 2, 6])
v3 = Gf.CompMult(v1, v2)
self.assertTrue(checkVec(v3, [15, 9, 8, 6]))
# component-wise division
SetVec(v1, [3, 9, 18, 21])
SetVec(v2, [3, 3, 9, 7])
v3 = Gf.CompDiv(v1, v2)
self.assertTrue(checkVec(v3, [1, 3, 2, 3]))
# is close
SetVec(v1, [3, 1, 4, 1])
SetVec(v2, [5, 9, 2, 6])
self.assertTrue(Gf.IsClose(v1, v1, 0.1))
self.assertFalse(Gf.IsClose(v1, v2, 0.1))
# static Axis methods
for i in range(Vec.dimension):
v1 = Vec.Axis(i)
v2 = Vec()
v2[i] = 1
self.assertEqual(v1, v2)
v1 = Vec.XAxis()
self.assertTrue(checkVec(v1, [1, 0, 0, 0]))
v1 = Vec.YAxis()
self.assertTrue(checkVec(v1, [0, 1, 0, 0]))
if Vec.dimension != 2:
v1 = Vec.ZAxis()
self.assertTrue(checkVec(v1, [0, 0, 1, 0]))
if Vec.dimension == 3:
# cross product
SetVec(v1, [3, 1, 4, 0])
SetVec(v2, [5, 9, 2, 0])
v3 = Vec(Gf.Cross(v1, v2))
v4 = v1 ^ v2
v5 = v1.GetCross(v2) # 2x compatibility
check = Vec()
SetVec(check, [1 * 2 - 4 * 9, 4 * 5 - 3 * 2, 3 * 9 - 1 * 5, 0])
self.assertTrue(v3 == check and v4 == check and v5 == check)
# orthogonalize basis
# case 1: close to orthogonal, don't normalize
SetVec(v1, [1, 0, 0.1])
SetVec(v2, [0.1, 1, 0])
SetVec(v3, [0, 0.1, 1])
self.assertTrue(Vec.OrthogonalizeBasis(v1, v2, v3, False))
self.assertTrue(Gf.IsClose(Gf.Dot(v2, v1), 0, eps))
self.assertTrue(Gf.IsClose(Gf.Dot(v3, v1), 0, eps))
self.assertTrue(Gf.IsClose(Gf.Dot(v2, v3), 0, eps))
# case 2: far from orthogonal, normalize
SetVec(v1, [1, 2, 3])
SetVec(v2, [-1, 2, 3])
SetVec(v3, [-1, -2, 3])
self.assertTrue(Vec.OrthogonalizeBasis(v1, v2, v3, True))
self.assertTrue(Gf.IsClose(Gf.Dot(v2, v1), 0, eps))
self.assertTrue(Gf.IsClose(Gf.Dot(v3, v1), 0, eps))
self.assertTrue(Gf.IsClose(Gf.Dot(v2, v3), 0, eps))
self.assertTrue(Gf.IsClose(v1.GetLength(), 1, eps))
self.assertTrue(Gf.IsClose(v2.GetLength(), 1, eps))
self.assertTrue(Gf.IsClose(v3.GetLength(), 1, eps))
# case 3: already orthogonal - shouldn't change, even with large
# tolerance
SetVec(v1, [1, 0, 0])
SetVec(v2, [0, 1, 0])
SetVec(v3, [0, 0, 1])
vt1 = v1
vt2 = v2
vt3 = v3
self.assertTrue(Vec.OrthogonalizeBasis(v1, v2, v3, False)) # nv edit - no epsilon parameter
self.assertTrue(v1 == vt1)
self.assertTrue(v2 == vt2)
self.assertTrue(v3 == vt3)
# case 4: co-linear input vectors - should do nothing
SetVec(v1, [1, 0, 0])
SetVec(v2, [1, 0, 0])
SetVec(v3, [0, 0, 1])
vt1 = v1
vt2 = v2
vt3 = v3
self.assertFalse(Vec.OrthogonalizeBasis(v1, v2, v3, False)) # nv edit - no epsilon parameter
self.assertEqual(v1, vt1)
self.assertEqual(v2, vt2)
self.assertEqual(v3, vt3)
# build orthonormal frame
SetVec(v1, [1, 1, 1, 1])
(v2, v3) = v1.BuildOrthonormalFrame()
self.assertTrue(Gf.IsClose(Gf.Dot(v2, v1), 0, eps))
self.assertTrue(Gf.IsClose(Gf.Dot(v3, v1), 0, eps))
self.assertTrue(Gf.IsClose(Gf.Dot(v2, v3), 0, eps))
SetVec(v1, [0, 0, 0, 0])
(v2, v3) = v1.BuildOrthonormalFrame()
self.assertTrue(Gf.IsClose(v2, Vec(), eps))
self.assertTrue(Gf.IsClose(v3, Vec(), eps))
SetVec(v1, [1, 0, 0, 0])
(v2, v3) = v1.BuildOrthonormalFrame()
self.assertTrue(Gf.IsClose(Gf.Dot(v2, v1), 0, eps))
self.assertTrue(Gf.IsClose(Gf.Dot(v3, v1), 0, eps))
self.assertTrue(Gf.IsClose(Gf.Dot(v2, v3), 0, eps))
SetVec(v1, [1, 0, 0, 0])
(v2, v3) = v1.BuildOrthonormalFrame()
self.assertTrue(Gf.IsClose(Gf.Dot(v2, v1), 0, eps))
self.assertTrue(Gf.IsClose(Gf.Dot(v3, v1), 0, eps))
self.assertTrue(Gf.IsClose(Gf.Dot(v2, v3), 0, eps))
SetVec(v1, [1, 0, 0, 0])
(v2, v3) = v1.BuildOrthonormalFrame(2)
self.assertTrue(Gf.IsClose(Gf.Dot(v2, v1), 0, eps))
self.assertTrue(Gf.IsClose(Gf.Dot(v3, v1), 0, eps))
self.assertTrue(Gf.IsClose(Gf.Dot(v2, v3), 0, eps))
# test Slerp w/ orthogonal vectors
SetVec(v1, [1, 0, 0])
SetVec(v2, [0, 1, 0])
v3 = Gf.Slerp(0, v1, v2)
self.assertTrue(Gf.IsClose(v3, v1, eps))
v3 = Gf.Slerp(1, v1, v2)
self.assertTrue(Gf.IsClose(v3, v3, eps))
v3 = Gf.Slerp(0.5, v1, v2)
self.assertTrue(Gf.IsClose(v3, Vec(0.7071, 0.7071, 0), eps))
# test Slerp w/ nearly parallel vectors
SetVec(v1, [1, 0, 0])
SetVec(v2, [1.001, 0.0001, 0])
v2.Normalize()
v3 = Gf.Slerp(0, v1, v2)
self.assertTrue(Gf.IsClose(v3, v1, eps))
v3 = Gf.Slerp(1, v1, v2)
self.assertTrue(Gf.IsClose(v3, v3, eps))
v3 = Gf.Slerp(0.5, v1, v2)
self.assertTrue(Gf.IsClose(v3, v1, eps), [v3, v1, eps])
self.assertTrue(Gf.IsClose(v3, v2, eps))
# test Slerp w/ opposing vectors
SetVec(v1, [1, 0, 0])
SetVec(v2, [-1, 0, 0])
v3 = Gf.Slerp(0, v1, v2)
self.assertTrue(Gf.IsClose(v3, v1, eps))
v3 = Gf.Slerp(0.25, v1, v2)
self.assertTrue(Gf.IsClose(v3, Vec(0.70711, 0, -0.70711), eps))
v3 = Gf.Slerp(0.5, v1, v2)
self.assertTrue(Gf.IsClose(v3, Vec(0, 0, -1), eps))
v3 = Gf.Slerp(0.75, v1, v2)
self.assertTrue(Gf.IsClose(v3, Vec(-0.70711, 0, -0.70711), eps))
v3 = Gf.Slerp(1, v1, v2)
self.assertTrue(Gf.IsClose(v3, v3, eps))
# test Slerp w/ opposing vectors
SetVec(v1, [0, 1, 0])
SetVec(v2, [0, -1, 0])
v3 = Gf.Slerp(0, v1, v2)
self.assertTrue(Gf.IsClose(v3, v1, eps))
v3 = Gf.Slerp(0.25, v1, v2)
self.assertTrue(Gf.IsClose(v3, Vec(0, 0.70711, 0.70711), eps))
v3 = Gf.Slerp(0.5, v1, v2)
self.assertTrue(Gf.IsClose(v3, Vec(0, 0, 1), eps))
v3 = Gf.Slerp(0.75, v1, v2)
self.assertTrue(Gf.IsClose(v3, Vec(0, -0.70711, 0.70711), eps))
v3 = Gf.Slerp(1, v1, v2)
self.assertTrue(Gf.IsClose(v3, v3, eps))
def test_Types(self):
from usdrt import Gf
vecTypes = [
Gf.Vec2d,
Gf.Vec2f,
Gf.Vec2h,
Gf.Vec2i,
Gf.Vec3d,
Gf.Vec3f,
Gf.Vec3h,
Gf.Vec3i,
Gf.Vec4d,
Gf.Vec4f,
Gf.Vec4h,
Gf.Vec4i,
]
for Vec in vecTypes:
self.ConstructorsTest(Vec)
self.OperatorsTest(Vec)
self.MethodsTest(Vec)
def test_TupleToVec(self):
from usdrt import Gf
# Test passing tuples for vecs.
self.assertEqual(Gf.Dot((1, 1), (1, 1)), 2)
self.assertEqual(Gf.Dot((1, 1, 1), (1, 1, 1)), 3)
self.assertEqual(Gf.Dot((1, 1, 1, 1), (1, 1, 1, 1)), 4)
self.assertEqual(Gf.Dot((1.0,1.0), (1.0,1.0)), 2.0)
self.assertEqual(Gf.Dot((1.0,1.0,1.0), (1.0,1.0,1.0)), 3.0)
self.assertEqual(Gf.Dot((1.0,1.0,1.0,1.0), (1.0,1.0,1.0,1.0)), 4.0)
self.assertEqual(Gf.Vec2f((1, 1)), Gf.Vec2f(1, 1))
self.assertEqual(Gf.Vec3f((1, 1, 1)), Gf.Vec3f(1, 1, 1))
self.assertEqual(Gf.Vec4f((1, 1, 1, 1)), Gf.Vec4f(1, 1, 1, 1))
# Test passing lists for vecs.
self.assertEqual(Gf.Dot([1, 1], [1, 1]), 2)
self.assertEqual(Gf.Dot([1, 1, 1], [1, 1, 1]), 3)
self.assertEqual(Gf.Dot([1, 1, 1, 1], [1, 1, 1, 1]), 4)
self.assertEqual(Gf.Dot([1.0, 1.0], [1.0, 1.0]), 2.0)
self.assertEqual(Gf.Dot([1.0, 1.0, 1.0], [1.0, 1.0, 1.0]), 3.0)
self.assertEqual(Gf.Dot([1.0, 1.0, 1.0, 1.0], [1.0, 1.0, 1.0, 1.0]), 4.0)
self.assertEqual(Gf.Vec2f([1, 1]), Gf.Vec2f(1, 1))
self.assertEqual(Gf.Vec3f([1, 1, 1]), Gf.Vec3f(1, 1, 1))
self.assertEqual(Gf.Vec4f([1, 1, 1, 1]), Gf.Vec4f(1, 1, 1, 1))
# Test passing both for vecs.
self.assertEqual(Gf.Dot((1,1), [1,1]), 2)
self.assertEqual(Gf.Dot((1, 1, 1), (1, 1, 1)), 3)
self.assertEqual(Gf.Dot((1,1,1,1), [1,1,1,1]), 4)
self.assertEqual(Gf.Dot((1.0,1.0), [1.0,1.0]), 2.0)
self.assertEqual(Gf.Dot((1.0,1.0,1.0), [1.0,1.0,1.0]), 3.0)
self.assertEqual(Gf.Dot((1.0,1.0,1.0,1.0), [1.0,1.0,1.0,1.0]), 4.0)
self.assertEqual(Gf.Vec2f([1,1]), Gf.Vec2f(1,1))
self.assertEqual(Gf.Vec3f([1,1,1]), Gf.Vec3f(1,1,1))
self.assertEqual(Gf.Vec4f([1,1,1,1]), Gf.Vec4f(1,1,1,1))
def test_Exceptions(self):
from usdrt import Gf
with self.assertRaises(TypeError):
Gf.Dot("monkey", (1, 1))
with self.assertRaises(TypeError):
Gf.Dot("monkey", (1, 1, 1))
with self.assertRaises(TypeError):
Gf.Dot("monkey", (1, 1, 1, 1))
with self.assertRaises(TypeError):
Gf.Dot("monkey", (1.0, 1.0))
with self.assertRaises(TypeError):
Gf.Dot("monkey", (1.0, 1.0, 1.0))
with self.assertRaises(TypeError):
Gf.Dot("monkey", (1.0, 1.0, 1.0, 1.0))
with self.assertRaises(TypeError):
Gf.Dot((1, 1, 1, 1, 1, 1), (1, 1))
with self.assertRaises(TypeError):
Gf.Dot((1, 1, 1, 1, 1, 1), (1, 1, 1))
with self.assertRaises(TypeError):
Gf.Dot((1, 1, 1, 1, 1, 1), (1, 1, 1, 1))
with self.assertRaises(TypeError):
Gf.Dot((1.0, 1.0, 1.0, 1.0, 1.0, 1.0), (1.0, 1.0))
with self.assertRaises(TypeError):
Gf.Dot((1.0, 1.0, 1.0, 1.0, 1.0, 1.0), (1.0, 1.0, 1.0))
with self.assertRaises(TypeError):
Gf.Dot((1.0, 1.0, 1.0, 1.0, 1.0, 1.0), (1.0, 1.0, 1.0, 1.0))
with self.assertRaises(TypeError):
Gf.Dot(("a", "b"), (1, 1))
with self.assertRaises(TypeError):
Gf.Dot(("a", "b", "c"), (1, 1, 1))
with self.assertRaises(TypeError):
Gf.Dot(("a", "b", "c", "d"), (1, 1, 1, 1))
with self.assertRaises(TypeError):
Gf.Dot(("a", "b"), (1.0, 1.0))
with self.assertRaises(TypeError):
Gf.Dot(("a", "b", "c"), (1.0, 1.0, 1.0))
with self.assertRaises(TypeError):
Gf.Dot(("a", "b", "c", "d"), (1.0, 1.0, 1.0, 1.0))
| 23,665 | Python | 33.002874 | 110 | 0.503697 |
omniverse-code/kit/exts/usdrt.gf/python/usdrt/Gf/tests/test_gf_vec_extras.py | __copyright__ = "Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved."
__license__ = """
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 copy
import math
import os
import platform
import sys
import time
import unittest
from . import TestRtScenegraph, tc_logger, update_path_and_load_usd
def setUpModule():
# pre-load USD before anything else to prevent crash
# from weird carb conflict
# FIXME ^^^
update_path_and_load_usd()
def get_vec_info():
"""Return list of tuples of class, scalar size, item count, and format string"""
from usdrt import Gf
vec_info = [
(Gf.Vec2d, 8, 2, "d"),
(Gf.Vec2f, 4, 2, "f"),
(Gf.Vec2h, 2, 2, "e"),
(Gf.Vec2i, 4, 2, "i"),
(Gf.Vec3d, 8, 3, "d"),
(Gf.Vec3f, 4, 3, "f"),
(Gf.Vec3h, 2, 3, "e"),
(Gf.Vec3i, 4, 3, "i"),
(Gf.Vec4d, 8, 4, "d"),
(Gf.Vec4f, 4, 4, "f"),
(Gf.Vec4h, 2, 4, "e"),
(Gf.Vec4i, 4, 4, "i"),
]
return vec_info
def get_vec_numpy_types():
import numpy
import usdrt
equivalent_types = {
usdrt.Gf.Vec2d: numpy.double,
usdrt.Gf.Vec2f: numpy.single,
usdrt.Gf.Vec2h: numpy.half,
usdrt.Gf.Vec2i: numpy.int,
usdrt.Gf.Vec3d: numpy.double,
usdrt.Gf.Vec3f: numpy.single,
usdrt.Gf.Vec3h: numpy.half,
usdrt.Gf.Vec3i: numpy.int,
usdrt.Gf.Vec4d: numpy.double,
usdrt.Gf.Vec4f: numpy.single,
usdrt.Gf.Vec4h: numpy.half,
usdrt.Gf.Vec4i: numpy.int,
}
return equivalent_types
class TestGfVecBuffer(TestRtScenegraph):
"""Test buffer protocol for usdrt.Gf.Vec* classes"""
@tc_logger
def test_buffer_inspect(self):
"""Use memoryview to validate that buffer protocol is implemented"""
vec_info = get_vec_info()
test_values = [9, 8, 7, 6]
for Vec, size, count, fmt in vec_info:
v = Vec(*test_values[:count])
view = memoryview(v)
self.assertEquals(view.itemsize, size)
self.assertEquals(view.ndim, 1)
self.assertEquals(view.shape, (count,))
self.assertEquals(view.format, fmt)
self.assertEquals(view.obj, Vec(*test_values[:count]))
@tc_logger
def test_buffer_init(self):
"""Validate initialization from an array using buffer protocol"""
import array
vec_info = get_vec_info()
test_values = [9, 8, 7, 6]
for Vec, size, count, fmt in vec_info:
if fmt == "e":
# GfHalf not supported with array.array
continue
test_array = array.array(fmt, test_values[:count])
test_vec = Vec(test_array)
self.assertEquals(test_vec, Vec(*test_values[:count]))
@tc_logger
def test_buffer_init_from_pxr_type(self):
"""Validate initialization from equivalent Pixar types"""
import pxr.Gf
import usdrt
vec_info = get_vec_info()
equivalent_types = {
usdrt.Gf.Vec2d: pxr.Gf.Vec2d,
usdrt.Gf.Vec2f: pxr.Gf.Vec2f,
usdrt.Gf.Vec2h: pxr.Gf.Vec2h,
usdrt.Gf.Vec2i: pxr.Gf.Vec2i,
usdrt.Gf.Vec3d: pxr.Gf.Vec3d,
usdrt.Gf.Vec3f: pxr.Gf.Vec3f,
usdrt.Gf.Vec3h: pxr.Gf.Vec3h,
usdrt.Gf.Vec3i: pxr.Gf.Vec3i,
usdrt.Gf.Vec4d: pxr.Gf.Vec4d,
usdrt.Gf.Vec4f: pxr.Gf.Vec4f,
usdrt.Gf.Vec4h: pxr.Gf.Vec4h,
usdrt.Gf.Vec4i: pxr.Gf.Vec4i,
}
test_values = [9, 8, 7, 6]
for Vec, size, count, fmt in vec_info:
test_pxr_type = equivalent_types[Vec](test_values[:count])
# Note that in all cases pybind choses the tuple initializer and
# not the buffer initializer. Oh well.
test_vec = Vec(test_pxr_type)
self.assertEquals(test_vec, Vec(*test_values[:count]))
@tc_logger
def test_buffer_init_from_numpy_type(self):
"""Test initialization from numpy types"""
import numpy
vec_info = get_vec_info()
equivalent_types = get_vec_numpy_types()
test_values = [9, 8, 7, 6]
for Vec, size, count, fmt in vec_info:
test_numpy_type = numpy.array(test_values[:count], dtype=equivalent_types[Vec])
# Note that in all cases except half pybind choses the tuple initializer and
# not the buffer initializer. Oh well.
test_vec = Vec(test_numpy_type)
self.assertEquals(test_vec, Vec(*test_values[:count]))
@tc_logger
def test_buffer_init_wrong_type(self):
"""Verify that an exception is raised with initializing via buffer with different data type"""
import array
vec_info = get_vec_info()
test_values = [9, 8, 7, 6]
for Vec, size, count, fmt in vec_info:
if fmt in ["e"]:
# GfHalf is tricky because it will cast from any
# numeric type, which pybind too-helpfully interprets
# into a tuple of GfHalf
continue
# Here, pybind will convert arrays of similar types to tuples
# which is fine I guess but makes testing harder to validate
# type correctness with buffer support
test_array = array.array("d" if fmt == "i" else "h", test_values[:count])
with self.assertRaises(ValueError):
test_vec = Vec(test_array)
@tc_logger
def test_buffer_init_wrong_size(self):
"""Verify that an exception is raised with initializing via buffer with different data array length"""
import array
vec_info = get_vec_info()
test_values = [9, 8, 7, 6, 5]
for Vec, size, count, fmt in vec_info:
if fmt in ["e"]:
# GfHalf not supported with array.array
continue
# Here, pybind will convert arrays of similar types to tuples
# which is fine I guess but makes testing harder to validate
# type correctness with buffer support
test_array = array.array(fmt, test_values)
with self.assertRaises(ValueError):
test_vec = Vec(test_array)
@tc_logger
def test_buffer_init_wrong_dimension(self):
"""Verify that an exception is raised with initializing via buffer with different data dimensions"""
import numpy
vec_info = get_vec_info()
equivalent_types = get_vec_numpy_types()
test_values = [9, 8, 7, 6]
for Vec, size, count, fmt in vec_info:
test_array = numpy.array([test_values[:count], test_values[:count]], dtype=equivalent_types[Vec])
with self.assertRaises(ValueError):
test_vec = Vec(test_array)
class TestGfVecCopy(TestRtScenegraph):
"""Test copy and deepcopy support for Gf.Vec* classes"""
@tc_logger
def test_copy(self):
"""Test __copy__"""
vec_info = get_vec_info()
for Vec, size, count, fmt in vec_info:
x = Vec()
y = x
self.assertTrue(y is x)
y[0] = 10
self.assertEqual(x[0], 10)
z = copy.copy(y)
self.assertFalse(z is y)
y[0] = 100
self.assertEqual(z[0], 10)
@tc_logger
def test_deepcopy(self):
"""Test __deepcopy__"""
vec_info = get_vec_info()
for Vec, size, count, fmt in vec_info:
x = Vec()
y = x
self.assertTrue(y is x)
y[0] = 10
self.assertEqual(x[0], 10)
z = copy.deepcopy(y)
self.assertFalse(z is y)
y[0] = 100
self.assertEqual(z[0], 10)
class TestGfVecDebugging(TestRtScenegraph):
"""Test human readable output functions for debugging"""
@tc_logger
def test_repr_representation(self):
"""Test __repr__"""
from usdrt import Gf
test_values = [9, 8, 7, 6]
test_vec = Gf.Vec4d(test_values)
expected = "Gf.Vec4d(9.0, 8.0, 7.0, 6.0)"
self.assertEqual(repr(test_vec), expected)
| 8,512 | Python | 28.975352 | 110 | 0.574836 |
omniverse-code/kit/exts/usdrt.gf/python/usdrt/Gf/tests/__init__.py | __copyright__ = "Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved."
__license__ = """
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
TestRtScenegraph = omni.kit.test.AsyncTestCase
def tc_logger(func):
"""
Print TC macros about the test when running on TC
(unneeded in kit)
"""
return func
def update_path_and_load_usd():
"""
Stub to help load USD before USDRT
(unneeded in kit)
"""
pass
from .test_gf_matrix_extras import *
from .test_gf_quat_extras import *
from .test_gf_range_extras import *
from .test_gf_vec_extras import *
from .testGfMath import *
from .testGfMatrix import *
from .testGfQuat import *
from .testGfRange import *
from .testGfRect import *
from .testGfVec import *
| 1,075 | Python | 24.023255 | 78 | 0.737674 |
omniverse-code/kit/exts/usdrt.gf/python/usdrt/Gf/tests/testGfMath.py | #!/pxrpythonsubst
#
# Copyright 2016 Pixar
#
# Licensed under the Apache License, Version 2.0 (the "Apache License")
# with the following modification; you may not use this file except in
# compliance with the Apache License and the following modification to it:
# Section 6. Trademarks. is deleted and replaced with:
#
# 6. Trademarks. This License does not grant permission to use the trade
# names, trademarks, service marks, or product names of the Licensor
# and its affiliates, except as required to comply with Section 4(c) of
# the License and to reproduce the content of the NOTICE file.
#
# You may obtain a copy of the Apache License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the Apache License with the above modification is
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the Apache License for the specific
# language governing permissions and limitations under the Apache License.
#
from __future__ import division
# Note: This is just pulled directly from USD and lightly modified
# https://github.com/PixarAnimationStudios/USD/blob/release/pxr/base/gf/testenv/testGfMath.py
__copyright__ = "Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved."
__license__ = """
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
import sys
import unittest
# In python 3 there is no type called "long", but a regular int is backed by
# a long. Fake it here so we can keep test coverage working for the types
# available in python 2, where there are separate int and long types
if sys.version_info.major >= 3:
long = int
def err(msg):
return "ERROR: " + msg + " failed"
def setUpModule():
# pre-load USD before anything else to prevent crash
# from weird carb conflict
# FIXME ^^^
try:
from . import update_path_and_load_usd
update_path_and_load_usd()
except ImportError:
# not needed in Kit
pass
try:
import omni.kit.test
TestClass = omni.kit.test.AsyncTestCase
except ImportError:
TestClass = unittest.TestCase
class TestGfMath(TestClass):
def _AssertListIsClose(self, first, second, delta=1e-6):
self.assertTrue(len(first) == len(second))
for (f, s) in zip(first, second):
self.assertAlmostEqual(f, s, delta=delta)
""" nv edit - no _HalfRoundTrip
def test_HalfRoundTrip(self):
from pxr.Gf import _HalfRoundTrip
self.assertEqual(1.0, _HalfRoundTrip(1.0))
self.assertEqual(1.0, _HalfRoundTrip(1))
self.assertEqual(2.0, _HalfRoundTrip(2))
self.assertEqual(3.0, _HalfRoundTrip(long(3)))
with self.assertRaises(TypeError):
_HalfRoundTrip([])
"""
def test_RadiansDegrees(self):
from usdrt.Gf import DegreesToRadians, RadiansToDegrees
self.assertEqual(0, RadiansToDegrees(0))
self.assertEqual(180, RadiansToDegrees(math.pi))
self.assertEqual(720, RadiansToDegrees(4 * math.pi))
self.assertEqual(0, DegreesToRadians(0))
self.assertEqual(math.pi, DegreesToRadians(180))
self.assertEqual(8 * math.pi, DegreesToRadians(4 * 360))
""" nv edit - not supporting some basic math stuff for now
def test_Sqr(self):
self.assertEqual(9, Sqr(3))
self.assertAlmostEqual(Sqr(math.sqrt(2)), 2, delta=1e-7)
self.assertEqual(5, Sqr(Vec2i(1,2)))
self.assertEqual(14, Sqr(Vec3i(1,2,3)))
self.assertEqual(5, Sqr(Vec2d(1,2)))
self.assertEqual(14, Sqr(Vec3d(1,2,3)))
self.assertEqual(30, Sqr(Vec4d(1,2,3,4)))
self.assertEqual(5, Sqr(Vec2f(1,2)))
self.assertEqual(14, Sqr(Vec3f(1,2,3)))
self.assertEqual(30, Sqr(Vec4f(1,2,3,4)))
def test_Sgn(self):
self.assertEqual(-1, Sgn(-3))
self.assertEqual(1, Sgn(3))
self.assertEqual(0, Sgn(0))
self.assertEqual(-1, Sgn(-3.3))
self.assertEqual(1, Sgn(3.3))
self.assertEqual(0, Sgn(0.0))
def test_Sqrt(self):
self.assertAlmostEqual( Sqrt(2), math.sqrt(2), delta=1e-5 )
self.assertAlmostEqual( Sqrtf(2), math.sqrt(2), delta=1e-5 )
def test_Exp(self):
self.assertAlmostEqual( Sqr(math.e), Exp(2), delta=1e-5 )
self.assertAlmostEqual( Sqr(math.e), Expf(2), delta=1e-5 )
def test_Log(self):
self.assertEqual(1, Log(math.e))
self.assertAlmostEqual(Log(Exp(math.e)), math.e, delta=1e-5)
self.assertAlmostEqual(Logf(math.e), 1, delta=1e-5)
self.assertAlmostEqual(Logf(Expf(math.e)), math.e, delta=1e-5)
def test_Floor(self):
self.assertEqual(3, Floor(3.141))
self.assertEqual(-4, Floor(-3.141))
self.assertEqual(3, Floorf(3.141))
self.assertEqual(-4, Floorf(-3.141))
def test_Ceil(self):
self.assertEqual(4, Ceil(3.141))
self.assertEqual(-3, Ceil(-3.141))
self.assertEqual(4, Ceilf(3.141))
self.assertEqual(-3, Ceilf(-3.141))
def test_Abs(self):
self.assertAlmostEqual(Abs(-3.141), 3.141, delta=1e-6)
self.assertAlmostEqual(Abs(3.141), 3.141, delta=1e-6)
self.assertAlmostEqual(Absf(-3.141), 3.141, delta=1e-6)
self.assertAlmostEqual(Absf(3.141), 3.141, delta=1e-6)
def test_Round(self):
self.assertEqual(3, Round(3.1))
self.assertEqual(4, Round(3.5))
self.assertEqual(-3, Round(-3.1))
self.assertEqual(-4, Round(-3.6))
self.assertEqual(3, Roundf(3.1))
self.assertEqual(4, Roundf(3.5))
self.assertEqual(-3, Roundf(-3.1))
self.assertEqual(-4, Roundf(-3.6))
def test_Pow(self):
self.assertEqual(16, Pow(2, 4))
self.assertEqual(16, Powf(2, 4))
def test_Clamp(self):
self.assertAlmostEqual(Clamp(3.141, 3.1, 3.2), 3.141, delta=1e-5)
self.assertAlmostEqual(Clamp(2.141, 3.1, 3.2), 3.1, delta=1e-5)
self.assertAlmostEqual(Clamp(4.141, 3.1, 3.2), 3.2, delta=1e-5)
self.assertAlmostEqual(Clampf(3.141, 3.1, 3.2), 3.141, delta=1e-5)
self.assertAlmostEqual(Clampf(2.141, 3.1, 3.2), 3.1, delta=1e-5)
self.assertAlmostEqual(Clampf(4.141, 3.1, 3.2), 3.2, delta=1e-5)
def test_Mod(self):
self.assertEqual(2, Mod(5, 3))
self.assertEqual(1, Mod(-5, 3))
self.assertEqual(2, Modf(5, 3))
self.assertEqual(1, Modf(-5, 3))
"""
""" nv edit - not supporting these for scalars
def test_Dot(self):
from usdrt.Gf import Dot
self.assertEqual(Dot(2.0, 3.0), 6.0)
self.assertEqual(Dot(-2.0, 3.0), -6.0)
def test_CompMult(self):
from usdrt.Gf import CompMult
self.assertEqual(CompMult(2.0, 3.0), 6.0)
self.assertEqual(CompMult(-2.0, 3.0), -6.0)
def test_CompDiv(self):
from usdrt.Gf import CompDiv
self.assertEqual(CompDiv(6.0, 3.0), 2.0)
self.assertEqual(CompDiv(-6.0, 3.0), -2.0)
"""
if __name__ == "__main__":
unittest.main()
| 7,375 | Python | 34.805825 | 93 | 0.650847 |
omniverse-code/kit/exts/usdrt.gf/python/usdrt/Gf/tests/test_gf_matrix_extras.py | __copyright__ = "Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved."
__license__ = """
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 copy
import math
import os
import platform
import sys
import time
import unittest
from . import TestRtScenegraph, tc_logger, update_path_and_load_usd
def setUpModule():
# pre-load USD before anything else to prevent crash
# from weird carb conflict
# FIXME ^^^
update_path_and_load_usd()
def get_mat_info():
"""Return list of tuples of class, scalar size, item count, and format string"""
from usdrt import Gf
mat_info = [
(Gf.Matrix3d, 8, 9, "d"),
(Gf.Matrix3f, 4, 9, "f"),
(Gf.Matrix4d, 8, 16, "d"),
(Gf.Matrix4f, 4, 16, "f"),
]
return mat_info
def get_mat_numpy_types():
import numpy
import usdrt
equivalent_types = {
usdrt.Gf.Matrix3d: numpy.double,
usdrt.Gf.Matrix3f: numpy.single,
usdrt.Gf.Matrix4d: numpy.double,
usdrt.Gf.Matrix4f: numpy.single,
}
return equivalent_types
class TestGfMatBuffer(TestRtScenegraph):
"""Test buffer protocol for usdrt.Gf.Matrix* classes"""
@tc_logger
def test_buffer_inspect(self):
"""Use memoryview to validate that buffer protocol is implemented"""
mat_info = get_mat_info()
test_values = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15]
for Mat, size, count, fmt in mat_info:
v = Mat(*test_values[:count])
view = memoryview(v)
self.assertEquals(view.itemsize, size)
self.assertEquals(view.ndim, 2)
self.assertEquals(view.shape, (math.sqrt(count), math.sqrt(count)))
self.assertEquals(view.format, fmt)
self.assertEquals(view.obj, Mat(*test_values[:count]))
@tc_logger
def test_buffer_init_from_pxr_type(self):
"""Validate initialization from equivalent Pixar types"""
import pxr.Gf
import usdrt
mat_info = get_mat_info()
equivalent_types = {
usdrt.Gf.Matrix3d: pxr.Gf.Matrix3d,
usdrt.Gf.Matrix3f: pxr.Gf.Matrix3f,
usdrt.Gf.Matrix4d: pxr.Gf.Matrix4d,
usdrt.Gf.Matrix4f: pxr.Gf.Matrix4f,
}
test_values = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15]
for Mat, size, count, fmt in mat_info:
test_pxr_type = equivalent_types[Mat](*test_values[:count])
test_mat = Mat(test_pxr_type)
self.assertEquals(test_mat, Mat(*test_values[:count]))
@tc_logger
def test_buffer_init_from_numpy_type(self):
"""Test initialization from numpy types"""
import numpy
mat_info = get_mat_info()
equivalent_types = get_mat_numpy_types()
test_values = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15]
for Mat, size, count, fmt in mat_info:
py_mat = []
stride = int(math.sqrt(count))
for i in range(stride):
py_mat.append(test_values[i * stride : i * stride + stride])
test_numpy_type = numpy.array(py_mat, dtype=equivalent_types[Mat])
test_mat = Mat(test_numpy_type)
self.assertEquals(test_mat, Mat(*test_values[:count]))
@tc_logger
def test_buffer_init_wrong_type(self):
"""Verify that an exception is raised with initializing via buffer with different data type"""
import numpy
mat_info = get_mat_info()
equivalent_types = get_mat_numpy_types()
test_values = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15]
for Mat, size, count, fmt in mat_info:
py_mat = []
stride = int(math.sqrt(count))
for i in range(stride):
py_mat.append(test_values[i * stride : i * stride + stride])
test_numpy_type = numpy.array(py_mat, dtype=numpy.int_)
with self.assertRaises(ValueError):
test_mat = Mat(test_numpy_type)
@tc_logger
def test_buffer_init_wrong_size(self):
"""Verify that an exception is raised with initializing via buffer with different data array length"""
import numpy
mat_info = get_mat_info()
equivalent_types = get_mat_numpy_types()
test_values = [[0, 1], [2, 3]]
for Mat, size, count, fmt in mat_info:
test_numpy_type = numpy.array(test_values, dtype=equivalent_types[Mat])
with self.assertRaises(ValueError):
test_mat = Mat(test_numpy_type)
@tc_logger
def test_buffer_init_wrong_dimension(self):
"""Verify that an exception is raised with initializing via buffer with different data dimensions"""
import numpy
mat_info = get_mat_info()
equivalent_types = get_mat_numpy_types()
test_values = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15]
for Mat, size, count, fmt in mat_info:
test_array = numpy.array(test_values[:count], dtype=equivalent_types[Mat])
with self.assertRaises(ValueError):
test_mat = Mat(test_array)
class TestGfMatrixGetSetItem(TestRtScenegraph):
"""Test single-item accessors for usdrt.Gf.Matrix* classes"""
@tc_logger
def test_get_item(self):
"""Validate GetArrayItem on GfMatrix"""
from usdrt import Gf
for Mat in [Gf.Matrix3d, Gf.Matrix3f, Gf.Matrix4d, Gf.Matrix4f]:
items = Mat.dimension[0] * Mat.dimension[1]
m = Mat(*[i for i in range(items)])
for i in range(items):
self.assertTrue(m.GetArrayItem(i) == i)
@tc_logger
def test_set_item(self):
"""Validate SetArrayItem on GfMatrix"""
from usdrt import Gf
for Mat in [Gf.Matrix3d, Gf.Matrix3f, Gf.Matrix4d, Gf.Matrix4f]:
m = Mat()
self.assertEqual(m, Mat(1))
items = Mat.dimension[0] * Mat.dimension[1]
expected = Mat(*[i for i in range(items)])
for i in range(items):
m.SetArrayItem(i, i)
self.assertNotEqual(m, Mat(1))
self.assertEqual(m, expected)
class TestGfMatrixCopy(TestRtScenegraph):
"""Test copy and deepcopy support for Gf.Mat* classes"""
@tc_logger
def test_copy(self):
"""Test __copy__"""
mat_info = get_mat_info()
for Mat, size, count, fmt in mat_info:
x = Mat()
y = x
self.assertTrue(y is x)
y[0, 0] = 10
self.assertEqual(x[0, 0], 10)
z = copy.copy(y)
self.assertFalse(z is y)
y[0, 0] = 100
self.assertEqual(z[0, 0], 10)
@tc_logger
def test_deepcopy(self):
"""Test __deepcopy__"""
mat_info = get_mat_info()
for Mat, size, count, fmt in mat_info:
x = Mat()
y = x
self.assertTrue(y is x)
y[0, 0] = 10
self.assertEqual(x[0, 0], 10)
z = copy.deepcopy(y)
self.assertFalse(z is y)
y[0, 0] = 100
self.assertEqual(z[0, 0], 10)
class TestGfMatrixDebugging(TestRtScenegraph):
"""Test human readable output functions for debugging"""
@tc_logger
def test_repr_representation(self):
"""Test __repr__"""
from usdrt import Gf
test_vec = Gf.Vec4d(9, 8, 7, 6)
test_matrix = Gf.Matrix4d(test_vec) # Sets matrix to diagonal form (ith element on the diagonal set to vec[i])
expected = "Gf.Matrix4d(9.0, 0.0, 0.0, 0.0, 0.0, 8.0, 0.0, 0.0, 0.0, 0.0, 7.0, 0.0, 0.0, 0.0, 0.0, 6.0)"
self.assertEqual(repr(test_matrix), expected)
class TestGfMatrixSetLookAtExtras(TestRtScenegraph):
"""More tests to validate SetLookAt"""
@tc_logger
def test_set_look_at_extras(self):
"""Test more points to ensure behavior match to Pixar implementation"""
from pxr import Gf
from usdrt import Gf as RtGf
target = [(0, 0, -20), (0, 0, -30), (0, 0, -40), (-10, 0, -40), (-20, 0, -40), (-30, 0, -40)]
eye = [(0, 0, 0), (0, 1, 0), (0, 2, 0), (0, 3, 0), (1, 3, 0), (2, 3, 0), (3, 3, 0)]
for eye_pos in eye:
for target_pos in target:
pxr_result = Gf.Matrix4d(1).SetLookAt(Gf.Vec3d(*eye_pos), Gf.Vec3d(*target_pos), Gf.Vec3d(0, 1, 0))
rt_result = RtGf.Matrix4d(1).SetLookAt(
RtGf.Vec3d(*eye_pos), RtGf.Vec3d(*target_pos), RtGf.Vec3d(0, 1, 0)
)
self.assertTrue(RtGf.IsClose(RtGf.Matrix4d(pxr_result), rt_result, 0.0001))
| 8,982 | Python | 29.763699 | 119 | 0.575707 |
omniverse-code/kit/exts/usdrt.gf/python/usdrt/Gf/tests/testGfMatrix.py | # Copyright 2016 Pixar
#
# Licensed under the Apache License, Version 2.0 (the "Apache License")
# with the following modification; you may not use this file except in
# compliance with the Apache License and the following modification to it:
# Section 6. Trademarks. is deleted and replaced with:
#
# 6. Trademarks. This License does not grant permission to use the trade
# names, trademarks, service marks, or product names of the Licensor
# and its affiliates, except as required to comply with Section 4(c) of
# the License and to reproduce the content of the NOTICE file.
#
# You may obtain a copy of the Apache License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the Apache License with the above modification is
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the Apache License for the specific
# language governing permissions and limitations under the Apache License.
#
# Note: This is just pulled directly from USD and lightly modified
# https://github.com/PixarAnimationStudios/USD/blob/release/pxr/base/gf/testenv/testGfMatrix.py
from __future__ import division, print_function
__copyright__ = "Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved."
__license__ = """
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
import sys
import unittest
##### Uncomment for better assert messages
# if 'unittest.util' in __import__('sys').modules:
# # Show full diff in self.assertEqual.
# __import__('sys').modules['unittest.util']._MAX_LENGTH = 999999999
def setUpModule():
# pre-load USD before anything else to prevent crash
# from weird carb conflict
# FIXME ^^^
try:
from . import update_path_and_load_usd
update_path_and_load_usd()
except ImportError:
# not needed in Kit
pass
try:
import omni.kit.test
TestClass = omni.kit.test.AsyncTestCase
except ImportError:
TestClass = unittest.TestCase
try:
import numpy
hasNumpy = True
except ImportError:
print("numpy not available, skipping buffer protocol tests")
hasNumpy = False
def makeValue(Value, vals):
if Value == float:
return Value(vals[0])
else:
v = Value()
for i in range(v.dimension):
v[i] = vals[i]
return v
class TestGfMatrix(TestClass):
def test_Basic(self):
from usdrt import Gf
Matrices = [ # (Gf.Matrix2d, Gf.Vec2d),
# (Gf.Matrix2f, Gf.Vec2f),
(Gf.Matrix3d, Gf.Vec3d),
(Gf.Matrix3f, Gf.Vec3f),
(Gf.Matrix4d, Gf.Vec4d),
(Gf.Matrix4f, Gf.Vec4f),
]
for (Matrix, Vec) in Matrices:
# constructors
self.assertIsInstance(Matrix(), Matrix)
self.assertIsInstance(Matrix(1), Matrix)
self.assertIsInstance(Matrix(Vec()), Matrix)
# python default constructor produces identity.
self.assertEqual(Matrix(), Matrix(1))
if hasNumpy:
# Verify population of numpy arrays.
emptyNumpyArray = numpy.empty((1, Matrix.dimension[0], Matrix.dimension[1]), dtype="float32")
emptyNumpyArray[0] = Matrix(1)
if Matrix.dimension == (2, 2):
self.assertIsInstance(Matrix(1, 2, 3, 4), Matrix)
self.assertEqual(Matrix().Set(1, 2, 3, 4), Matrix(1, 2, 3, 4))
array = numpy.array(Matrix(1, 2, 3, 4))
self.assertEqual(array.shape, (2, 2))
# XXX: Currently cannot round-trip Gf.Matrix*f through
# numpy.array
if Matrix != Gf.Matrix2f:
self.assertEqual(Matrix(array), Matrix(1, 2, 3, 4))
elif Matrix.dimension == (3, 3):
self.assertIsInstance(Matrix(1, 2, 3, 4, 5, 6, 7, 8, 9), Matrix)
self.assertEqual(Matrix().Set(1, 2, 3, 4, 5, 6, 7, 8, 9), Matrix(1, 2, 3, 4, 5, 6, 7, 8, 9))
array = numpy.array(Matrix(1, 2, 3, 4, 5, 6, 7, 8, 9))
self.assertEqual(array.shape, (3, 3))
# XXX: Currently cannot round-trip Gf.Matrix*f through
# numpy.array
if Matrix != Gf.Matrix3f:
self.assertEqual(Matrix(array), Matrix(1, 2, 3, 4, 5, 6, 7, 8, 9))
elif Matrix.dimension == (4, 4):
self.assertIsInstance(Matrix(1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16), Matrix)
self.assertEqual(
Matrix().Set(1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16),
Matrix(1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16),
)
array = numpy.array(Matrix(1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16))
self.assertEqual(array.shape, (4, 4))
# XXX: Currently cannot round-trip Gf.Matrix*f through
# numpy.array
if Matrix != Gf.Matrix4f:
self.assertEqual(Matrix(array), Matrix(1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16))
else:
self.fail()
self.assertEqual(Matrix().SetIdentity(), Matrix(1))
self.assertEqual(Matrix().SetZero(), Matrix(0))
self.assertEqual(Matrix().SetDiagonal(0), Matrix().SetZero())
self.assertEqual(Matrix().SetDiagonal(1), Matrix().SetIdentity())
def test_Comparisons(self):
from usdrt import Gf
Matrices = [(Gf.Matrix3d, Gf.Matrix3f), (Gf.Matrix4d, Gf.Matrix4f)] # (Gf.Matrix2d, Gf.Matrix2f),
for (Matrix, Matrixf) in Matrices:
# Test comparison of Matrix and Matrixf
#
size = Matrix.dimension[0] * Matrix.dimension[1]
contents = list(range(1, size + 1))
md = Matrix(*contents)
mf = Matrixf(*contents)
self.assertEqual(md, mf)
contents.reverse()
md.Set(*contents)
mf.Set(*contents)
self.assertEqual(md, mf)
# Convert to double precision floating point values
contents = [1.0 / x for x in contents]
mf.Set(*contents)
md.Set(*contents)
# These should *NOT* be equal due to roundoff errors in the floats.
self.assertNotEqual(md, mf)
def test_Other(self):
from usdrt import Gf
Matrices = [ # (Gf.Matrix2d, Gf.Vec2d),
# (Gf.Matrix2f, Gf.Vec2f),
(Gf.Matrix3d, Gf.Vec3d),
(Gf.Matrix3f, Gf.Vec3f),
(Gf.Matrix4d, Gf.Vec4d),
(Gf.Matrix4f, Gf.Vec4f),
]
for (Matrix, Vec) in Matrices:
v = Vec()
for i in range(v.dimension):
v[i] = i
m1 = Matrix().SetDiagonal(v)
m2 = Matrix(0)
for i in range(m2.dimension[0]):
m2[i, i] = i
self.assertEqual(m1, m2)
v = Vec()
for i in range(v.dimension):
v[i] = 10
self.assertEqual(Matrix().SetDiagonal(v), Matrix().SetDiagonal(10))
self.assertEqual(type(Matrix()[0]), Vec)
m = Matrix()
m[0] = makeValue(Vec, (3, 1, 4, 1))
self.assertEqual(m[0], makeValue(Vec, (3, 1, 4, 1)))
m = Matrix()
m[-1] = makeValue(Vec, (3, 1, 4, 1))
self.assertEqual(m[-1], makeValue(Vec, (3, 1, 4, 1)))
m = Matrix()
m[0, 0] = 1
m[1, 0] = 2
m[0, 1] = 3
m[1, 1] = 4
self.assertTrue(m[0, 0] == 1 and m[1, 0] == 2 and m[0, 1] == 3 and m[1, 1] == 4)
m = Matrix()
m[-1, -1] = 1
m[-2, -1] = 2
m[-1, -2] = 3
m[-2, -2] = 4
self.assertTrue(m[-1, -1] == 1 and m[-2, -1] == 2 and m[-1, -2] == 3 and m[-2, -2] == 4)
m = Matrix()
for i in range(m.dimension[0]):
for j in range(m.dimension[1]):
m[i, j] = i * m.dimension[1] + j
m = m.GetTranspose()
for i in range(m.dimension[0]):
for j in range(m.dimension[1]):
self.assertEqual(m[j, i], i * m.dimension[1] + j)
self.assertEqual(Matrix(1).GetInverse(), Matrix(1))
self.assertEqual(Matrix(4).GetInverse() * Matrix(4), Matrix(1))
# nv edit - intentionally diverge from pixar's implementation
# GetInverse for zero matrix returns zero matrix instead of max float scale matrix
# "so that multiplying by this is less likely to be catastrophic."
self.assertEqual(Matrix(0).GetInverse(), Matrix(0))
self.assertEqual(Matrix(3).GetDeterminant(), 3 ** Matrix.dimension[0])
self.assertEqual(len(Matrix()), Matrix.dimension[0])
# Test GetRow, GetRow3, GetColumn
m = Matrix(1)
for i in range(m.dimension[0]):
for j in range(m.dimension[1]):
m[i, j] = i * m.dimension[1] + j
for i in range(m.dimension[0]):
j0 = i * m.dimension[1]
self.assertEqual(m.GetRow(i), makeValue(Vec, tuple(range(j0, j0 + m.dimension[1]))))
if Matrix == Gf.Matrix4d:
self.assertEqual(m.GetRow3(i), Gf.Vec3d(j0, j0 + 1, j0 + 2))
for j in range(m.dimension[1]):
self.assertEqual(
m.GetColumn(j), makeValue(Vec, tuple(j + x * m.dimension[0] for x in range(m.dimension[0])))
)
# Test SetRow, SetRow3, SetColumn
m = Matrix(1)
for i in range(m.dimension[0]):
j0 = i * m.dimension[1]
v = makeValue(Vec, tuple(range(j0, j0 + m.dimension[1])))
m.SetRow(i, v)
self.assertEqual(v, m.GetRow(i))
m = Matrix(1)
if Matrix == Gf.Matrix4d:
for i in range(m.dimension[0]):
j0 = i * m.dimension[1]
v = Gf.Vec3d(j0, j0 + 1, j0 + 2)
m.SetRow3(i, v)
self.assertEqual(v, m.GetRow3(i))
m = Matrix(1)
for j in range(m.dimension[0]):
v = makeValue(Vec, tuple(j + x * m.dimension[0] for x in range(m.dimension[0])))
m.SetColumn(i, v)
self.assertEqual(v, m.GetColumn(i))
m = Matrix(4)
m *= Matrix(1.0 / 4)
self.assertEqual(m, Matrix(1))
m = Matrix(4)
self.assertEqual(m * Matrix(1.0 / 4), Matrix(1))
self.assertEqual(Matrix(4) * 2, Matrix(8))
self.assertEqual(2 * Matrix(4), Matrix(8))
m = Matrix(4)
m *= 2
self.assertEqual(m, Matrix(8))
m = Matrix(3)
m += Matrix(2)
self.assertEqual(m, Matrix(5))
m = Matrix(3)
m -= Matrix(2)
self.assertEqual(m, Matrix(1))
self.assertEqual(Matrix(2) + Matrix(3), Matrix(5))
self.assertEqual(Matrix(4) - Matrix(4), Matrix(0))
self.assertEqual(-Matrix(-1), Matrix(1))
self.assertEqual(Matrix(3) / Matrix(2), Matrix(3) * Matrix(2).GetInverse())
self.assertEqual(Matrix(2) * makeValue(Vec, (3, 1, 4, 1)), makeValue(Vec, (6, 2, 8, 2)))
self.assertEqual(makeValue(Vec, (3, 1, 4, 1)) * Matrix(2), makeValue(Vec, (6, 2, 8, 2)))
Vecf = {Gf.Vec2d: Gf.Vec2f, Gf.Vec3d: Gf.Vec3f, Gf.Vec4d: Gf.Vec4f}.get(Vec)
if Vecf is not None:
self.assertEqual(Matrix(2) * makeValue(Vecf, (3, 1, 4, 1)), makeValue(Vecf, (6, 2, 8, 2)))
self.assertEqual(makeValue(Vecf, (3, 1, 4, 1)) * Matrix(2), makeValue(Vecf, (6, 2, 8, 2)))
self.assertTrue(2 in Matrix(2) and not 4 in Matrix(2))
m = Matrix(1)
try:
m[m.dimension[0] + 1] = Vec()
except:
pass
else:
self.fail()
m = Matrix(1)
try:
m[m.dimension[0] + 1, m.dimension[1] + 1] = 10
except:
pass
else:
self.fail()
m = Matrix(1)
try:
m[1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1] = 3
self.fail()
except:
pass
try:
x = m[1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1]
self.fail()
except:
pass
m = Matrix(1)
try:
m["foo"] = 3
except:
pass
else:
self.fail()
self.assertEqual(m, eval(repr(m)))
self.assertTrue(len(str(Matrix())))
def test_Matrix3Transforms(self):
from usdrt import Gf
# TODO - Gf.Rotation not supported,
# so this test is currently a noop
Matrices = [ # (Gf.Matrix3d, Gf.Vec3d, Gf.Quatd),
# (Gf.Matrix3f, Gf.Vec3f, Gf.Quatf)
]
for (Matrix, Vec, Quat) in Matrices:
def _VerifyOrthonormVecs(mat):
v0 = Vec(mat[0][0], mat[0][1], mat[0][2])
v1 = Vec(mat[1][0], mat[1][1], mat[1][2])
v2 = Vec(mat[2][0], mat[2][1], mat[2][2])
self.assertTrue(
Gf.IsClose(Gf.Dot(v0, v1), 0, 0.0001)
and Gf.IsClose(Gf.Dot(v0, v2), 0, 0.0001)
and Gf.IsClose(Gf.Dot(v1, v2), 0, 0.0001)
)
m = Matrix()
m.SetRotate(Gf.Rotation(Gf.Vec3d(1, 0, 0), 30))
m2 = Matrix(m)
m_o = m.GetOrthonormalized()
self.assertEqual(m_o, m2)
m.Orthonormalize()
self.assertEqual(m, m2)
m = Matrix(3)
m_o = m.GetOrthonormalized()
# GetOrthonormalized() should not mutate m
self.assertNotEqual(m, m_o)
self.assertEqual(m_o, Matrix(1))
m.Orthonormalize()
self.assertEqual(m, Matrix(1))
m = Matrix(1, 0, 0, 1, 0, 0, 1, 0, 0)
# should print a warning
print("expect a warning about failed convergence in OrthogonalizeBasis:")
m.Orthonormalize()
m = Matrix(1, 0, 0, 1, 0, 0.0001, 0, 1, 0)
m_o = m.GetOrthonormalized()
_VerifyOrthonormVecs(m_o)
m.Orthonormalize()
_VerifyOrthonormVecs(m)
r = Matrix().SetRotate(Gf.Rotation(Gf.Vec3d(1, 0, 0), 30)).ExtractRotation()
r2 = Gf.Rotation(Gf.Vec3d(1, 0, 0), 30)
self.assertTrue(Gf.IsClose(r.axis, r2.axis, 0.0001) and Gf.IsClose(r.angle, r2.angle, 0.0001))
r = Matrix().SetRotate(Gf.Rotation(Gf.Vec3d(1, 1, 1), 60)).ExtractRotation()
r2 = Gf.Rotation(Gf.Vec3d(1, 1, 1), 60)
self.assertTrue(Gf.IsClose(r.axis, r2.axis, 0.0001) and Gf.IsClose(r.angle, r2.angle, 0.0001))
r = Matrix().SetRotate(Gf.Rotation(Gf.Vec3d(1, 1, 1), 90)).ExtractRotation()
r2 = Gf.Rotation(Gf.Vec3d(1, 1, 1), 90)
self.assertTrue(Gf.IsClose(r.axis, r2.axis, 0.0001) and Gf.IsClose(r.angle, r2.angle, 0.0001))
r = Matrix().SetRotate(Gf.Rotation(Gf.Vec3d(1, 1, 1), 120)).ExtractRotation()
r2 = Gf.Rotation(Gf.Vec3d(1, 1, 1), 120)
self.assertTrue(Gf.IsClose(r.axis, r2.axis, 0.0001) and Gf.IsClose(r.angle, r2.angle, 0.0001))
# Setting rotation using a quaternion should give the same results
# as setting a GfRotation.
rot = Gf.Rotation(Gf.Vec3d(1, 1, 1), 120)
quat = Quat(rot.GetQuaternion().GetReal(), Vec(rot.GetQuaternion().GetImaginary()))
r = Matrix().SetRotate(rot).ExtractRotation()
r2 = Matrix().SetRotate(quat).ExtractRotation()
self.assertTrue(Gf.IsClose(r.axis, r2.axis, 0.0001) and Gf.IsClose(r.angle, r2.angle, 0.0001))
self.assertEqual(Matrix().SetScale(10), Matrix(10))
m = Matrix().SetScale(Vec(1, 2, 3))
self.assertTrue(m[0, 0] == 1 and m[1, 1] == 2 and m[2, 2] == 3)
# Initializing with GfRotation should give same results as SetRotate.
r = Matrix().SetRotate(Gf.Rotation(Gf.Vec3d(1, 0, 0), 30)).ExtractRotation()
r2 = Matrix(Gf.Rotation(Gf.Vec3d(1, 0, 0), 30)).ExtractRotation()
self.assertTrue(Gf.IsClose(r.axis, r2.axis, 0.0001) and Gf.IsClose(r.angle, r2.angle, 0.0001))
# Initializing with a quaternion should give same results as SetRotate.
rot = Gf.Rotation(Gf.Vec3d(1, 1, 1), 120)
quat = Quat(rot.GetQuaternion().GetReal(), Vec(rot.GetQuaternion().GetImaginary()))
r = Matrix().SetRotate(quat).ExtractRotation()
r2 = Matrix(quat).ExtractRotation()
self.assertTrue(Gf.IsClose(r.axis, r2.axis, 0.0001) and Gf.IsClose(r.angle, r2.angle, 0.0001))
self.assertEqual(Matrix(1, 0, 0, 0, 1, 0, 0, 0, 1).GetHandedness(), 1.0)
self.assertEqual(Matrix(-1, 0, 0, 0, 1, 0, 0, 0, 1).GetHandedness(), -1.0)
self.assertEqual(Matrix(0, 0, 0, 0, 0, 0, 0, 0, 0).GetHandedness(), 0.0)
self.assertTrue(Matrix(1, 0, 0, 0, 1, 0, 0, 0, 1).IsRightHanded())
self.assertTrue(Matrix(-1, 0, 0, 0, 1, 0, 0, 0, 1).IsLeftHanded())
# Test that this does not generate a nan in the angle (bug #12744)
mx = Gf.Matrix3d(
0.999999999982236,
-5.00662622471027e-06,
2.07636574601397e-06,
5.00666175191934e-06,
1.0000000000332,
-2.19113616402155e-07,
-2.07635686422463e-06,
2.19131379884019e-07,
1,
)
r = mx.ExtractRotation()
# math.isnan won't be available until python 2.6
if sys.version_info[0] >= 2 and sys.version_info[1] >= 6:
self.assertFalse(math.isnan(r.angle))
else:
# If this fails, then r.angle is Nan. Works on linux, may not be portable.
self.assertEqual(r.angle, r.angle)
def test_Matrix4Transforms(self):
from usdrt import Gf
# nv edit - TODO support Quatd and Quatf
Matrices = [
(Gf.Matrix4d, Gf.Vec4d, Gf.Matrix3d, Gf.Vec3d), # , Gf.Quatd),
(Gf.Matrix4f, Gf.Vec4f, Gf.Matrix3f, Gf.Vec3f),
] # , Gf.Quatf)]
# for (Matrix, Vec, Matrix3, Vec3, Quat) in Matrices:
for (Matrix, Vec, Matrix3, Vec3) in Matrices:
def _VerifyOrthonormVecs(mat):
v0 = Vec3(mat[0][0], mat[0][1], mat[0][2])
v1 = Vec3(mat[1][0], mat[1][1], mat[1][2])
v2 = Vec3(mat[2][0], mat[2][1], mat[2][2])
self.assertTrue(
Gf.IsClose(Gf.Dot(v0, v1), 0, 0.0001)
and Gf.IsClose(Gf.Dot(v0, v2), 0, 0.0001)
and Gf.IsClose(Gf.Dot(v1, v2), 0, 0.0001)
)
m = Matrix()
m.SetLookAt(Vec3(1, 0, 0), Vec3(0, 0, 1), Vec3(0, 1, 0))
# nv edit - break this across multiple statements
self.assertTrue(Gf.IsClose(m[0], Vec(-0.707107, 0, 0.707107, 0), 0.0001))
self.assertTrue(Gf.IsClose(m[1], Vec(0, 1, 0, 0), 0.0001))
self.assertTrue(Gf.IsClose(m[2], Vec(-0.707107, 0, -0.707107, 0), 0.0001))
self.assertTrue(Gf.IsClose(m[3], Vec(0.707107, 0, -0.707107, 1), 0.0001))
# Transform
v = Gf.Vec3f(1, 1, 1)
v2 = Matrix(3).Transform(v)
self.assertEqual(v2, Gf.Vec3f(1, 1, 1))
self.assertEqual(type(v2), Gf.Vec3f)
v = Gf.Vec3d(1, 1, 1)
v2 = Matrix(3).Transform(v)
self.assertEqual(v2, Gf.Vec3d(1, 1, 1))
self.assertEqual(type(v2), Gf.Vec3d)
# TransformDir
v = Gf.Vec3f(1, 1, 1)
v2 = Matrix(3).TransformDir(v)
self.assertEqual(v2, Gf.Vec3f(3, 3, 3))
self.assertEqual(type(v2), Gf.Vec3f)
v = Gf.Vec3d(1, 1, 1)
v2 = Matrix(3).TransformDir(v)
self.assertEqual(v2, Gf.Vec3d(3, 3, 3))
self.assertEqual(type(v2), Gf.Vec3d)
# TransformAffine
v = Gf.Vec3f(1, 1, 1)
# nv edit - no implict conversion from tuple yet
v2 = Matrix(3).SetTranslateOnly(Vec3(1, 2, 3)).TransformAffine(v)
self.assertEqual(v2, Gf.Vec3f(4, 5, 6))
self.assertEqual(type(v2), Gf.Vec3f)
v = Gf.Vec3d(1, 1, 1)
# nv edit - no implict conversion from tuple yet
v2 = Matrix(3).SetTranslateOnly(Vec3(1, 2, 3)).TransformAffine(v)
self.assertEqual(v2, Gf.Vec3d(4, 5, 6))
self.assertEqual(type(v2), Gf.Vec3d)
# Constructor, SetRotate, and SetRotateOnly w/GfQuaternion
""" nv edit Gf.Rotation not supported
m = Matrix()
r = Gf.Rotation(Gf.Vec3d(1,0,0), 30)
quat = r.GetQuaternion()
m.SetRotate(Quat(quat.GetReal(), Vec3(quat.GetImaginary())))
m2 = Matrix(r, Vec3(0,0,0))
m_o = m.GetOrthonormalized()
self.assertEqual(m_o, m2)
m.Orthonormalize()
self.assertEqual(m, m2)
m3 = Matrix(1)
m3.SetRotateOnly(Quat(quat.GetReal(), Vec3(quat.GetImaginary())))
self.assertEqual(m2, m3)
# Constructor, SetRotate, and SetRotateOnly w/GfRotation
m = Matrix()
r = Gf.Rotation(Gf.Vec3d(1,0,0), 30)
m.SetRotate(r)
m2 = Matrix(r, Vec3(0,0,0))
m_o = m.GetOrthonormalized()
self.assertEqual(m_o, m2)
m.Orthonormalize()
self.assertEqual(m, m2)
m3 = Matrix(1)
m3.SetRotateOnly(r)
self.assertEqual(m2, m3)
# Constructor, SetRotate, and SetRotateOnly w/mx
m3d = Matrix3()
m3d.SetRotate(Gf.Rotation(Gf.Vec3d(1,0,0), 30))
m = Matrix(m3d, Vec3(0,0,0))
m2 = Matrix()
m2 = m2.SetRotate(m3d)
m3 = Matrix()
m3 = m2.SetRotateOnly(m3d)
self.assertEqual(m, m2)
self.assertEqual(m2, m3)
"""
m = Matrix().SetTranslate(Vec3(12, 13, 14)) * Matrix(3)
m.Orthonormalize()
t = Matrix().SetTranslate(m.ExtractTranslation())
mnot = m * t.GetInverse()
self.assertEqual(mnot, Matrix(1))
m = Matrix()
m.SetTranslate(Vec3(1, 2, 3))
m2 = Matrix(m)
m3 = Matrix(1)
m3.SetTranslateOnly(Vec3(1, 2, 3))
m_o = m.GetOrthonormalized()
self.assertEqual(m_o, m2)
self.assertEqual(m_o, m3)
m.Orthonormalize()
self.assertEqual(m, m2)
self.assertEqual(m, m3)
v = Vec3(11, 22, 33)
m = Matrix(1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16).SetTranslateOnly(v)
self.assertEqual(m.ExtractTranslation(), v)
# Initializing with GfRotation should give same results as SetRotate
# and SetTransform
""" nv edit TODO
r = Matrix().SetRotate(Gf.Rotation(Gf.Vec3d(1,0,0),30)).ExtractRotation()
r2 = Matrix(Gf.Rotation(Gf.Vec3d(1,0,0),30), Vec3(1,2,3)).ExtractRotation()
r3 = Matrix().SetTransform(Gf.Rotation(Gf.Vec3d(1,0,0),30), Vec3(1,2,3)).ExtractRotation()
self.assertTrue(Gf.IsClose(r.axis, r2.axis, 0.0001) and \
Gf.IsClose(r.angle, r2.angle, 0.0001))
self.assertTrue(Gf.IsClose(r3.axis, r2.axis, 0.0001) and \
Gf.IsClose(r3.angle, r2.angle, 0.0001))
# Initializing with GfRotation should give same results as
# SetRotate(quaternion) and SetTransform
rot = Gf.Rotation(Gf.Vec3d(1,0,0),30)
quat = Quat(rot.GetQuaternion().GetReal(),
Vec3(rot.GetQuaternion().GetImaginary()))
r = Matrix().SetRotate(quat).ExtractRotation()
r2 = Matrix(rot, Vec3(1,2,3)).ExtractRotation()
r3 = Matrix().SetTransform(rot, Vec3(1,2,3)).ExtractRotation()
self.assertTrue(Gf.IsClose(r.axis, r2.axis, 0.0001) and \
Gf.IsClose(r.angle, r2.angle, 0.0001))
self.assertTrue(Gf.IsClose(r3.axis, r2.axis, 0.0001) and \
Gf.IsClose(r3.angle, r2.angle, 0.0001))
# Same test w/mx instead of GfRotation
mx3d = Matrix3(Gf.Rotation(Gf.Vec3d(1,0,0),30))
r4 = Matrix().SetTransform(mx3d, Vec3(1,2,3)).ExtractRotation()
r5 = Matrix(mx3d, Vec3(1,2,3)).ExtractRotation()
self.assertTrue(Gf.IsClose(r4.axis, r2.axis, 0.0001) and \
Gf.IsClose(r4.angle, r2.angle, 0.0001))
self.assertTrue(Gf.IsClose(r4.axis, r5.axis, 0.0001) and \
Gf.IsClose(r4.angle, r5.angle, 0.0001))
# ExtractQuat() and ExtractRotation() should yield
# equivalent rotations.
m = Matrix(mx3d, Vec3(1,2,3))
r1 = m.ExtractRotation()
r2 = Gf.Rotation(m.ExtractRotationQuat())
self.assertTrue(Gf.IsClose(r1.axis, r2.axis, 0.0001) and \
Gf.IsClose(r2.angle, r2.angle, 0.0001))
m4 = Matrix(mx3d, Vec3(1,2,3)).ExtractRotationMatrix()
self.assertEqual(m4, mx3d)
"""
# Initializing with GfMatrix3d
# nv edit - dumb, not supported
# m = Matrix(1,2,3,0,4,5,6,0,7,8,9,0,10,11,12,1)
# m2 = Matrix(Matrix3(1,2,3,4,5,6,7,8,9), Vec3(10, 11, 12))
# assert(m == m2)
m = Matrix(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0, 1)
# should print a warning - nv edit - our implementation doesn't
# print("expect a warning about failed convergence in OrthogonalizeBasis:")
m.Orthonormalize()
m = Matrix(1, 0, 0, 0, 1, 0, 0.0001, 0, 0, 1, 0, 0, 0, 0, 0, 1)
m_o = m.GetOrthonormalized()
_VerifyOrthonormVecs(m_o)
m.Orthonormalize()
_VerifyOrthonormVecs(m)
m = Matrix()
m[3, 0] = 4
m[3, 1] = 5
m[3, 2] = 6
self.assertEqual(m.ExtractTranslation(), Vec3(4, 5, 6))
self.assertEqual(Matrix(1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1).GetHandedness(), 1.0)
self.assertEqual(Matrix(-1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1).GetHandedness(), -1.0)
self.assertEqual(Matrix(0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0).GetHandedness(), 0.0)
self.assertTrue(Matrix(1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1).IsRightHanded())
self.assertTrue(Matrix(-1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1).IsLeftHanded())
# RemoveScaleShear
""" nv edit Gf.Rotation not supported
m = Matrix().SetRotate(Gf.Rotation(Gf.Vec3d(0,0,1), 45))
m = Matrix().SetScale(Vec3(3,4,2)) * m
m = Matrix().SetRotate(Gf.Rotation(Gf.Vec3d(1,0,0), -30)) * m
r = m.RemoveScaleShear()
ro = r
ro.Orthonormalize()
self.assertEqual(ro, r)
shear = Matrix(1,0,1,0, 0,1,0,0, 0,0,1,0, 0,0,0,1)
r = shear.RemoveScaleShear()
ro = r
ro.Orthonormalize()
self.assertEqual(ro, r)
m = Matrix().SetRotate(Gf.Rotation(Gf.Vec3d(0,0,1), 45))
m = Matrix().SetRotate(Gf.Rotation(Gf.Vec3d(1,0,0), -30)) * m
m = Matrix().SetRotate(Gf.Rotation(Gf.Vec3d(0,1,0), 59)) * m
r = m.RemoveScaleShear()
maxEltErr = 0
for i in range(4):
for j in range(4):
maxEltErr = max(maxEltErr, abs(r[i][j] - m[i][j]))
self.assertTrue(Gf.IsClose(maxEltErr, 0.0, 1e-5))
# IsClose
self.assertFalse(Gf.IsClose(Matrix(1), Matrix(1.0001), 1e-5))
self.assertTrue(Gf.IsClose(Matrix(1), Matrix(1.000001), 1e-5))
"""
def test_Matrix4Factoring(self):
from usdrt import Gf
""" nv edit Gf.Rotation not supported
Matrices = [(Gf.Matrix4d, Gf.Vec3d),
(Gf.Matrix4f, Gf.Vec3f)]
for (Matrix, Vec3) in Matrices:
def testFactor(m, expectSuccess, eps=None):
factor = lambda m : m.Factor()
if eps is not None:
factor = lambda m : m.Factor(eps)
(success, scaleOrientation, scale, rotation, \
translation, projection) = factor(m)
self.assertEqual(success, expectSuccess)
factorProduct = scaleOrientation * \
Matrix().SetScale(scale) * \
scaleOrientation.GetInverse() * \
rotation * \
Matrix().SetTranslate(translation) * \
projection
maxEltErr = 0
for i in range(4):
for j in range(4):
maxEltErr = max(maxEltErr, abs(factorProduct[i][j] - m[i][j]))
self.assertTrue(Gf.IsClose(maxEltErr, 0.0, 1e-5), maxEltErr)
# A rotate
m = Matrix().SetRotate(Gf.Rotation(Gf.Vec3d(1,0,0), 45))
testFactor(m,True)
# A couple of rotates
m = Matrix().SetRotate(Gf.Rotation(Gf.Vec3d(0,0,1), -45))
m = Matrix().SetRotate(Gf.Rotation(Gf.Vec3d(1,0,0), 45)) * m
testFactor(m,True)
# A scale
m = Matrix().SetScale(Vec3(3,1,4))
testFactor(m,True)
# A scale in a rotated space
m = Matrix().SetRotate(Gf.Rotation(Gf.Vec3d(0,0,1), 45))
m = Matrix().SetScale(Vec3(3,4,2)) * m
m = Matrix().SetRotate(Gf.Rotation(Gf.Vec3d(0,0,1), -45)) * m
testFactor(m,True)
# A nearly degenerate scale
if Matrix == Gf.Matrix4d:
eps = 1e-10
elif Matrix == Gf.Matrix4f:
eps = 1e-5
m = Matrix().SetScale((eps*2, 1, 1))
testFactor(m,True)
# Test with epsilon.
m = Matrix().SetScale((eps*2, 1, 1))
testFactor(m,False,eps*3)
# A singular (1) scale in a rotated space
m = Matrix().SetRotate(Gf.Rotation(Gf.Vec3d(1,1,1), Gf.Vec3d(1,0,0) ))
m = m * Matrix().SetScale(Vec3(0,1,1))
m = m * Matrix().SetRotate(Gf.Rotation(Gf.Vec3d(1,0,0), Gf.Vec3d(1,1,1) ))
testFactor(m,False)
# A singular (2) scale in a rotated space
m = Matrix().SetRotate(Gf.Rotation(Gf.Vec3d(1,1,1), Gf.Vec3d(1,0,0) ))
m = m * Matrix().SetScale(Vec3(0,0,1))
m = m * Matrix().SetRotate(Gf.Rotation(Gf.Vec3d(1,0,0), Gf.Vec3d(1,1,1) ))
testFactor(m,False)
# A scale in a sheared space
shear = Matrix(1)
shear.SetRow3(0, Vec3(1, 1, 1).GetNormalized())
m = shear.GetInverse() * Matrix().SetScale(Vec3(2,3,4)) * shear
testFactor(m,True)
# A singular (1) scale in a sheared space
shear = Matrix(1)
shear.SetRow3(0, Vec3(1, 1, 1).GetNormalized())
m = shear.GetInverse() * Matrix().SetScale(Vec3(2,0,4)) * shear
testFactor(m,False)
# A singular (2) scale in a sheared space
shear = Matrix(1)
shear.SetRow3(0, Vec3(1, 1, 1).GetNormalized())
m = shear.GetInverse() * Matrix().SetScale(Vec3(0,3,0)) * shear
testFactor(m,False)
# A scale and a rotate
m = Matrix().SetRotate(Gf.Rotation(Gf.Vec3d(0,0,1), Gf.Vec3d(1,1,-1) ))
m = Matrix().SetScale(Vec3(1,2,3)) * m
testFactor(m,True)
# A singular (1) scale and a rotate
m = Matrix().SetRotate(Gf.Rotation(Gf.Vec3d(0,0,1), Gf.Vec3d(1,1,-1) ))
m = Matrix().SetScale(Vec3(0,2,3)) * m
testFactor(m,False)
# A singular (2) scale and a rotate
m = Matrix().SetRotate(Gf.Rotation(Gf.Vec3d(0,0,1), Gf.Vec3d(1,1,-1) ))
m = Matrix().SetScale(Vec3(0,0,3)) * m
testFactor(m,False)
# A singular scale (1), rotate, translate
m = Matrix().SetTranslate(Vec3(3,1,4))
m = Matrix().SetRotate(Gf.Rotation(Gf.Vec3d(0,0,1), Gf.Vec3d(1,1,-1) )) * m
m = Matrix().SetScale(Vec3(0,2,3)) * m
testFactor(m,False)
# A translate, rotate, singular scale (1), translate
m = Matrix().SetTranslate(Vec3(3,1,4))
m = Matrix().SetRotate(Gf.Rotation(Gf.Vec3d(0,0,1), Gf.Vec3d(1,1,-1) )) * m
m = Matrix().SetScale(Vec3(0,2,3)) * m
m = Matrix().SetTranslate(Vec3(-10,-20,-30)) * m
testFactor(m,False)
"""
def test_Matrix4Determinant(self):
from usdrt import Gf
Matrices = [Gf.Matrix4d, Gf.Matrix4f]
for Matrix in Matrices:
# Test GetDeterminant and GetInverse on Matrix4
def AssertDeterminant(m, det):
# Unfortunately, we don't have an override of Gf.IsClose
# for Gf.Matrix4*
for row1, row2 in zip(m * m.GetInverse(), Matrix()):
self.assertTrue(Gf.IsClose(row1, row2, 1e-5))
self.assertTrue(Gf.IsClose(m.GetDeterminant(), det, 1e-5))
m1 = Matrix(0.0, 1.0, 0.0, 0.0, 1.0, 0.0, 0.0, 0.0, 0.0, 0.0, 1.0, 0.0, 0.0, 0.0, 0.0, 1.0)
det1 = -1.0
m2 = Matrix(0.0, 0.0, 1.0, 0.0, 0.0, 1.0, 0.0, 0.0, 1.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 1.0)
det2 = -1.0
m3 = Matrix(0.0, 0.0, 0.0, 1.0, 0.0, 1.0, 0.0, 0.0, 0.0, 0.0, 1.0, 0.0, 1.0, 0.0, 0.0, 0.0)
det3 = -1.0
m4 = Matrix(1.0, 2.0, -1.0, 3.0, 2.0, 1.0, 4.0, 5.1, 2.0, 3.0, 1.0, 6.0, 3.0, 2.0, 1.0, 1.0)
det4 = 16.8
AssertDeterminant(m1, det1)
AssertDeterminant(m2, det2)
AssertDeterminant(m3, det3)
AssertDeterminant(m4, det4)
AssertDeterminant(m1 * m1, det1 * det1)
AssertDeterminant(m1 * m4, det1 * det4)
AssertDeterminant(m1 * m3 * m4, det1 * det3 * det4)
AssertDeterminant(m1 * m3 * m4 * m2, det1 * det3 * det4 * det2)
AssertDeterminant(m2 * m3 * m4 * m2, det2 * det3 * det4 * det2)
| 35,494 | Python | 40.369464 | 118 | 0.514509 |
Subsets and Splits
No saved queries yet
Save your SQL queries to embed, download, and access them later. Queries will appear here once saved.