file_path
stringlengths 5
44
| content
stringlengths 75
400k
|
|---|---|
omni.ui.Shape.md | Shape — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
Shape
# Shape
class omni.ui.Shape
Bases: Widget
The Shape widget provides a base class for all the Shape Widget. Currently implemented are Rectangle, Circle, Triangle, Line, Ellipse and BezierCurve.
Methods
__init__(*args, **kwargs)
Attributes
__init__(*args, **kwargs)
© Copyright 2019-2024, NVIDIA.
Last updated on Mar 25, 2024. |
omni.ui.Circle.md | Circle — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
Circle
# Circle
class omni.ui.Circle
Bases: Shape
The Circle widget provides a colored circle to display.
Methods
__init__(self, **kwargs)
Constructs Circle.
Attributes
alignment
This property holds the alignment of the circle when the fill policy is ePreserveAspectFit or ePreserveAspectCrop.
arc
This property is the way to draw a half or a quarter of the circle.
radius
This property holds the radius of the circle when the fill policy is eFixed or eFixedCrop.
size_policy
Define what happens when the source image has a different size than the item.
__init__(self: omni.ui._ui.Circle, **kwargs) → None
Constructs Circle.
`kwargsdict`See below
### Keyword Arguments:
`alignment :`This property holds the alignment of the circle when the fill policy is ePreserveAspectFit or ePreserveAspectCrop. By default, the circle is centered.
`radius :`This property holds the radius of the circle when the fill policy is eFixed or eFixedCrop. By default, the circle radius is 0.
`arc :`This property is the way to draw a half or a quarter of the circle. When it’s eLeft, only left side of the circle is rendered. When it’s eLeftTop, only left top quarter is rendered.
`size_policy :`Define what happens when the source image has a different size than the item.
`widthui.Length`This property holds the width of the widget relative to its parent. Do not use this function to find the width of a screen.
`heightui.Length`This property holds the height of the widget relative to its parent. Do not use this function to find the height of a screen.
`namestr`The name of the widget that user can set.
`style_type_name_overridestr`By default, we use typeName to look up the style. But sometimes it’s necessary to use a custom name. For example, when a widget is a part of another widget. (Label is a part of Button) This property can override the name to use in style.
`identifierstr`An optional identifier of the widget we can use to refer to it in queries.
`visiblebool`This property holds whether the widget is visible.
`visibleMinfloat`If the current zoom factor and DPI is less than this value, the widget is not visible.
`visibleMaxfloat`If the current zoom factor and DPI is bigger than this value, the widget is not visible.
`tooltipstr`Set a basic tooltip for the widget, this will simply be a Label, it will follow the Tooltip style
`tooltip_fnCallable`Set dynamic tooltip that will be created dynamiclly the first time it is needed. the function is called inside a ui.Frame scope that the widget will be parented correctly.
`tooltip_offset_xfloat`Set the X tooltip offset in points. In a normal state, the tooltip position is linked to the mouse position. If the tooltip offset is non zero, the top left corner of the tooltip is linked to the top left corner of the widget, and this property defines the relative position the tooltip should be shown.
`tooltip_offset_yfloat`Set the Y tooltip offset in points. In a normal state, the tooltip position is linked to the mouse position. If the tooltip offset is non zero, the top left corner of the tooltip is linked to the top left corner of the widget, and this property defines the relative position the tooltip should be shown.
`enabledbool`This property holds whether the widget is enabled. In general an enabled widget handles keyboard and mouse events; a disabled widget does not. And widgets display themselves differently when they are disabled.
`selectedbool`This property holds a flag that specifies the widget has to use eSelected state of the style.
`checkedbool`This property holds a flag that specifies the widget has to use eChecked state of the style. It’s on the Widget level because the button can have sub-widgets that are also should be checked.
`draggingbool`This property holds if the widget is being dragged.
`opaque_for_mouse_eventsbool`If the widgets has callback functions it will by default not capture the events if it is the top most widget and setup this option to true, so they don’t get routed to the child widgets either
`skip_draw_when_clippedbool`The flag that specifies if it’s necessary to bypass the whole draw cycle if the bounding box is clipped with a scrolling frame. It’s needed to avoid the limitation of 65535 primitives in a single draw list.
`mouse_moved_fnCallable`Sets the function that will be called when the user moves the mouse inside the widget. Mouse move events only occur if a mouse button is pressed while the mouse is being moved. void onMouseMoved(float x, float y, int32_t modifier)
`mouse_pressed_fnCallable`Sets the function that will be called when the user presses the mouse button inside the widget. The function should be like this: void onMousePressed(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier) Where ‘button’ is the number of the mouse button pressed. ‘modifier’ is the flag for the keyboard modifier key.
`mouse_released_fnCallable`Sets the function that will be called when the user releases the mouse button if this button was pressed inside the widget. void onMouseReleased(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)
`mouse_double_clicked_fnCallable`Sets the function that will be called when the user presses the mouse button twice inside the widget. The function specification is the same as in setMousePressedFn. void onMouseDoubleClicked(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)
`mouse_wheel_fnCallable`Sets the function that will be called when the user uses mouse wheel on the focused window. The function specification is the same as in setMousePressedFn. void onMouseWheel(float x, float y, carb::input::KeyboardModifierFlags modifier)
`mouse_hovered_fnCallable`Sets the function that will be called when the user use mouse enter/leave on the focused window. function specification is the same as in setMouseHovedFn. void onMouseHovered(bool hovered)
`drag_fnCallable`Specify that this Widget is draggable, and set the callback that is attached to the drag operation.
`accept_drop_fnCallable`Specify that this Widget can accept specific drops and set the callback that is called to check if the drop can be accepted.
`drop_fnCallable`Specify that this Widget accepts drops and set the callback to the drop operation.
`computed_content_size_changed_fnCallable`Called when the size of the widget is changed.
property alignment
This property holds the alignment of the circle when the fill policy is ePreserveAspectFit or ePreserveAspectCrop. By default, the circle is centered.
property arc
This property is the way to draw a half or a quarter of the circle. When it’s eLeft, only left side of the circle is rendered. When it’s eLeftTop, only left top quarter is rendered.
property radius
This property holds the radius of the circle when the fill policy is eFixed or eFixedCrop. By default, the circle radius is 0.
property size_policy
Define what happens when the source image has a different size than the item.
© Copyright 2019-2024, NVIDIA.
Last updated on Mar 25, 2024. |
creating_kit_apps.md | Building an App — kit-manual 105.1 documentation
kit-manual
»
Building an App
# Building an App
A Kit file (ends in .kit) defines an Omniverse App. Kit files behave as a single-file extension. The format is the same as an extension.toml and all runtime behavior is the same. It can be published, downloaded, versioned, and it can have dependencies.
Building an Omniverse App is as simple as listing the extensions that it should contain (extension dependencies) and the default settings to apply.
## Simple App
Here is an example of a very simple app with a dependency and setting applied: repl.kit:
[dependencies]
"omni.kit.console" = {}
[settings]
exts."omni.kit.console".autoRunREPL = true
Pass the repl.kit file to the Kit executable:
> kit.exe repl.kit
and it will enable a few extensions (including dependencies) to run a simple REPL.
## Application Dependencies Management
There are conceptual differences when specifying dependencies for an extension vs an app, although the syntax is the same:
For extensions, dependencies are specified as broadly as possible. Versions describe compatibility with other extensions. Your extension can be used in many different apps with different extensions included.
An app is the final leaf on a dependency chain, and is an end-product. All versions of dependencies must be locked in the final package, and in the version control system. That helps to guarantee reproducible builds for end users and developers.
If you pass an app to the Kit executable, it will first resolve all extension versions (either locally or using the registry system), and will then enable the latest compatible versions. Next time you run the app, someone may have published a newer version of some extension and you may get a different result.
You also don’t often have a clear view of the versions chosen, because one extension brings in other extensions that they depend on, and so on. That builds a tree of N-order dependencies.
To lock all dependencies we want to write them back to the kit file. You can manually specify each version of each dependency with exact=true and lock all of them, but that would be very tedious to maintain. It would also make upgrading to newer versions very difficult.
To address this, Kit has a mode where it will write a dependency solution (of all the resolved versions) back to the tail of the kit file it was launched from.
It will look something like this:
########################################################################################################################
# BEGIN GENERATED PART (Remove from 'BEGIN' to 'END' to regenerate)
########################################################################################################################
# Date: 09/15/21 15:50:53 (UTC)
# Kit SDK Version: 103.0+master.58543.0643d57a.teamcity
# Kit SDK dependencies:
# carb.audio-0.1.0
# carb.windowing.plugins-1.0.0
# ...
# Version lock for all dependencies:
[settings.app.exts]
enabled = [
"omni.kit.asset_converter-1.1.36",
"omni.kit.tool.asset_importer-2.3.12",
"omni.kit.widget.timeline_standalone-103.0.7",
"omni.kit.window.timeline-103.0.7",
]
########################################################################################################################
# END GENERATED PART
########################################################################################################################
On top of that, we have a repo tool: repo_precache_exts. You specify a list of kit files in repo.toml to run Kit in that mode on:
[repo_precache_exts]
# Apps to run and precache
apps = [
"${root}/_build/$platform/$config/apps/omni.app.my_app.kit"
]
Besides locking the versions of all extensions, it will also download/precache them. It is then packaged together, and the final app package is deployed into the Launcher.
Usually, that tool runs as the final step of the build process. To run it explicitly call:
> repo.bat precache_exts -c release
By default, extensions are cached into the _build/$platform/$config/extscache folder.
The version-lock is written at the tail of the kit file and the changed kit file can then be committed to version-control.
### Updating Version Lock
Short version: run: build.bat with -u flag.
Longer explanation: You can remove the generated part of the kit file and run the build or precache tool. That will write it again. But if you did run it before you already downloaded extensions in _build/$platform/$config/extscache, then those local versions of extensions will still be selected again, because local versions are preferred. Before doing that, this folder needs to be cleared. To automate this process, the precache tool has a -u / --update flag:
$ repo precache_exts -h
usage: repo precache_exts [-h] [-c CONFIG] [-v] [-x] [-u]
Tool to precache kit apps. Downloads extensions without running.
optional arguments:
-h, --help show this help message and exit
-c CONFIG, --config CONFIG
-v, --info
-x, --clean Reset version lock and cache: remove generated part
from kit files, clean cache path and exit.
-u, --update Update version lock: remove generated part from kit
files, clean cache path, then run ext precaching.
The latest versions of repo_build and repo_kit_tools allow propagation of that flag to build.bat. So run build.bat -h to check if your project has the -u flag available. To use, run:
build.bat -u -r to build a new release with updated versions.
### Version Specification Recommendations
The general advice is to write the dependencies required-versions for apps the same way as for extensions, in an open-ended form, like:
[dependencies]
"omni.kit.tool.asset_importer" = {}
or say, locking only to a major-version (Semantic Versioning is used):
[dependencies]
"omni.kit.tool.asset_importer" = { version = "2.0.0" }
Then the automatic version lock will select 2.0.0, 2.0.1, 2.1.0, 2.99.99 for you, but never 3.0.0.
You can also review the git diff at that point, to see which versions actually changed when the selection process ran.
### Windows or Linux only dependencies
Version locks, and all versions, are by default defined as cross-platform. While we build them only on your current platform, we assume that the same app will run on other platforms. If you need to have an extension that is for a single platform only, you can explicitly specify the version in this way:
[dependencies."filter:platform"."windows-x86_64"]
"omni.kit.window.section" = { version = "102.1.6", exact = true }
Dependencies specified as exact are not written into an automatic version lock. This way, you lock the version manually, and only for the selected platform.
### Caching extensions disabled by default
Often an app has extensions that are brought into the Launcher, but disabled by default. Create is an example of that. We still want to lock all the versions, and download them, but we can’t put them into the main app kit file, as it will enable them on startup. The solution is simple: use a separate kit file, which includes the main one. For instance, the Create project has:
omni.create.kit and omni.create.full.kit. The latter includes the former in its dependencies, but adds extra extensions. Both kit files are passed to the precache tool (specified in repo.toml).
## Deploying an App
Kit files fully describe how to run an app, and also are interpreted as an extension. This means that it can be versioned and published into the registry like any other extension. Any Kit app can be found in the extension manager. Click Launch, and the app will be run.
It can also just be shared as a file, and anyone can pass it to kit.exe or associate it with Kit and just use a mouse double-click to open it.
In practice, we deploy apps into the launcher with both Kit and all of the dependent extensions downloaded ahead of time. So an app in the launcher basically is:
Kit file (1 or more)
Precached extensions
Kit SDK
The Kit SDK is already shared between apps using the thin-package feature of Omniverse Launcher (downloaded from packman). In the future, we can get to a point where you only need to publish a single Kit file to define an Omniverse App of any complexity. This goal guides and explains certain decisions described in the guide.
## Extensions without an App
Many repositories contain only extensions without publishing an app. However, all their dependencies should be downloaded at build time and version locked.
You don’t have to create a kit file for them, precache tool will do it by default using generated_app_path = "${root}/source/apps/exts.deps.generated.kit" setting. In this location, a kit file with all extensions will be automatically generated.
exts.deps.generated.kit - is an app, that contains all extensions from the repo as dependencies. It is used to:
Lock all versions of their dependencies (reproducible builds).
Precache (download) all dependencies before building.
This file is regenerated if:
Any extension is added or removed from the repo.
Any extension version is updated
This file is removed.
To update version lock the same repo build -u flag can be used.
The same other kit files with version lock, it should be version controlled to produce reproducible builds.
To disable this feature set a generated app path to empty generated_app_path = "".
## Other Precache Tool Settings
As with any repo tool, to find more settings available for the precache tool, look into its repo_tools.toml file. Since it comes with Kit, this file is a part of the kit-sdk package and can be found at: _build/$platform/$config/kit/dev/repo_tools.toml
© Copyright 2019-2023, NVIDIA.
Last updated on Nov 14, 2023. |
omni.ui.IntSlider.md | IntSlider — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
IntSlider
# IntSlider
class omni.ui.IntSlider
Bases: AbstractSlider
The slider is the classic widget for controlling a bounded value. It lets the user move a slider handle along a horizontal groove and translates the handle’s position into an integer value within the legal range.
Methods
__init__(self[, model])
Constructs IntSlider.
Attributes
max
This property holds the slider's maximum value.
min
This property holds the slider's minimum value.
__init__(self: omni.ui._ui.IntSlider, model: omni.ui._ui.AbstractValueModel = None, **kwargs) → None
Constructs IntSlider.
### Arguments:
`model :`The widget’s model. If the model is not assigned, the default model is created.
`kwargsdict`See below
### Keyword Arguments:
`min`This property holds the slider’s minimum value.
`max`This property holds the slider’s maximum value.
`widthui.Length`This property holds the width of the widget relative to its parent. Do not use this function to find the width of a screen.
`heightui.Length`This property holds the height of the widget relative to its parent. Do not use this function to find the height of a screen.
`namestr`The name of the widget that user can set.
`style_type_name_overridestr`By default, we use typeName to look up the style. But sometimes it’s necessary to use a custom name. For example, when a widget is a part of another widget. (Label is a part of Button) This property can override the name to use in style.
`identifierstr`An optional identifier of the widget we can use to refer to it in queries.
`visiblebool`This property holds whether the widget is visible.
`visibleMinfloat`If the current zoom factor and DPI is less than this value, the widget is not visible.
`visibleMaxfloat`If the current zoom factor and DPI is bigger than this value, the widget is not visible.
`tooltipstr`Set a basic tooltip for the widget, this will simply be a Label, it will follow the Tooltip style
`tooltip_fnCallable`Set dynamic tooltip that will be created dynamiclly the first time it is needed. the function is called inside a ui.Frame scope that the widget will be parented correctly.
`tooltip_offset_xfloat`Set the X tooltip offset in points. In a normal state, the tooltip position is linked to the mouse position. If the tooltip offset is non zero, the top left corner of the tooltip is linked to the top left corner of the widget, and this property defines the relative position the tooltip should be shown.
`tooltip_offset_yfloat`Set the Y tooltip offset in points. In a normal state, the tooltip position is linked to the mouse position. If the tooltip offset is non zero, the top left corner of the tooltip is linked to the top left corner of the widget, and this property defines the relative position the tooltip should be shown.
`enabledbool`This property holds whether the widget is enabled. In general an enabled widget handles keyboard and mouse events; a disabled widget does not. And widgets display themselves differently when they are disabled.
`selectedbool`This property holds a flag that specifies the widget has to use eSelected state of the style.
`checkedbool`This property holds a flag that specifies the widget has to use eChecked state of the style. It’s on the Widget level because the button can have sub-widgets that are also should be checked.
`draggingbool`This property holds if the widget is being dragged.
`opaque_for_mouse_eventsbool`If the widgets has callback functions it will by default not capture the events if it is the top most widget and setup this option to true, so they don’t get routed to the child widgets either
`skip_draw_when_clippedbool`The flag that specifies if it’s necessary to bypass the whole draw cycle if the bounding box is clipped with a scrolling frame. It’s needed to avoid the limitation of 65535 primitives in a single draw list.
`mouse_moved_fnCallable`Sets the function that will be called when the user moves the mouse inside the widget. Mouse move events only occur if a mouse button is pressed while the mouse is being moved. void onMouseMoved(float x, float y, int32_t modifier)
`mouse_pressed_fnCallable`Sets the function that will be called when the user presses the mouse button inside the widget. The function should be like this: void onMousePressed(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier) Where ‘button’ is the number of the mouse button pressed. ‘modifier’ is the flag for the keyboard modifier key.
`mouse_released_fnCallable`Sets the function that will be called when the user releases the mouse button if this button was pressed inside the widget. void onMouseReleased(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)
`mouse_double_clicked_fnCallable`Sets the function that will be called when the user presses the mouse button twice inside the widget. The function specification is the same as in setMousePressedFn. void onMouseDoubleClicked(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)
`mouse_wheel_fnCallable`Sets the function that will be called when the user uses mouse wheel on the focused window. The function specification is the same as in setMousePressedFn. void onMouseWheel(float x, float y, carb::input::KeyboardModifierFlags modifier)
`mouse_hovered_fnCallable`Sets the function that will be called when the user use mouse enter/leave on the focused window. function specification is the same as in setMouseHovedFn. void onMouseHovered(bool hovered)
`drag_fnCallable`Specify that this Widget is draggable, and set the callback that is attached to the drag operation.
`accept_drop_fnCallable`Specify that this Widget can accept specific drops and set the callback that is called to check if the drop can be accepted.
`drop_fnCallable`Specify that this Widget accepts drops and set the callback to the drop operation.
`computed_content_size_changed_fnCallable`Called when the size of the widget is changed.
property max
This property holds the slider’s maximum value.
property min
This property holds the slider’s minimum value.
© Copyright 2019-2024, NVIDIA.
Last updated on Mar 25, 2024. |
omni.ui.RasterPolicy.md | RasterPolicy — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
RasterPolicy
# RasterPolicy
class omni.ui.RasterPolicy
Bases: pybind11_object
Used to set the rasterization behaviour.
Members:
NEVER : Do not rasterize the widget at any time.
ON_DEMAND : Rasterize the widget as soon as possible and always use the rasterized version. This means that the widget will only be updated when the user called invalidateRaster.
AUTO : Automatically determine whether to rasterize the widget based on performance considerations. If necessary, the widget will be rasterized and updated when its content changes.
Methods
__init__(self, value)
Attributes
AUTO
NEVER
ON_DEMAND
name
value
__init__(self: omni.ui._ui.RasterPolicy, value: int) → None
property name
© Copyright 2019-2024, NVIDIA.
Last updated on Mar 25, 2024. |
omni.ui.dock_window_in_window.md | dock_window_in_window — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Functions »
dock_window_in_window
# dock_window_in_window
omni.ui.dock_window_in_window(arg0: str, arg1: str, arg2: omni.ui._ui.DockPosition, arg3: float) → bool
place a named window in a specific docking position based on a target window name. We will find the target window dock node and insert this named window in it, either by spliting on ratio or on top if the windows is not found false is return, otherwise true
© Copyright 2019-2024, NVIDIA.
Last updated on Mar 25, 2024. |
omni.ui.ScrollingFrame.md | ScrollingFrame — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
ScrollingFrame
# ScrollingFrame
class omni.ui.ScrollingFrame
Bases: Frame
The ScrollingFrame class provides the ability to scroll onto another widget.
ScrollingFrame is used to display the contents of a child widget within a frame. If the widget exceeds the size of the frame, the frame can provide scroll bars so that the entire area of the child widget can be viewed. The child widget must be specified with addChild().
Methods
__init__(self, **kwargs)
Construct ScrollingFrame.
set_scroll_x_changed_fn(self, arg0)
The horizontal position of the scroll bar.
set_scroll_y_changed_fn(self, arg0)
The vertical position of the scroll bar.
Attributes
horizontal_scrollbar_policy
This property holds the policy for the horizontal scroll bar.
scroll_x
The horizontal position of the scroll bar.
scroll_x_max
The max position of the horizontal scroll bar.
scroll_y
The vertical position of the scroll bar.
scroll_y_max
The max position of the vertical scroll bar.
vertical_scrollbar_policy
This property holds the policy for the vertical scroll bar.
__init__(self: omni.ui._ui.ScrollingFrame, **kwargs) → None
Construct ScrollingFrame.
`kwargsdict`See below
### Keyword Arguments:
`scroll_xfloat`The horizontal position of the scroll bar. When it’s changed, the contents will be scrolled accordingly.
`scroll_x_maxfloat`The max position of the horizontal scroll bar.
`scroll_x_changed_fnCallable[[float], None]`The horizontal position of the scroll bar. When it’s changed, the contents will be scrolled accordingly.
`scroll_yfloat`The vertical position of the scroll bar. When it’s changed, the contents will be scrolled accordingly.
`scroll_y_maxfloat`The max position of the vertical scroll bar.
`scroll_y_changed_fnCallable[[float], None]`The vertical position of the scroll bar. When it’s changed, the contents will be scrolled accordingly.
`horizontal_scrollbar_policyui.ScrollBarPolicy`This property holds the policy for the horizontal scroll bar.
`vertical_scrollbar_policyui.ScrollBarPolicy`This property holds the policy for the vertical scroll bar.
`horizontal_clipping`When the content of the frame is bigger than the frame the exceeding part is not drawn if the clipping is on. It only works for horizontal direction.
`vertical_clipping`When the content of the frame is bigger than the frame the exceeding part is not drawn if the clipping is on. It only works for vertial direction.
`separate_window`A special mode where the child is placed to the transparent borderless window. We need it to be able to place the UI to the exact stacking order between other windows.
`raster_policy`Determine how the content of the frame should be rasterized.
`build_fn`Set the callback that will be called once the frame is visible and the content of the callback will override the frame child. It’s useful for lazy load.
`widthui.Length`This property holds the width of the widget relative to its parent. Do not use this function to find the width of a screen.
`heightui.Length`This property holds the height of the widget relative to its parent. Do not use this function to find the height of a screen.
`namestr`The name of the widget that user can set.
`style_type_name_overridestr`By default, we use typeName to look up the style. But sometimes it’s necessary to use a custom name. For example, when a widget is a part of another widget. (Label is a part of Button) This property can override the name to use in style.
`identifierstr`An optional identifier of the widget we can use to refer to it in queries.
`visiblebool`This property holds whether the widget is visible.
`visibleMinfloat`If the current zoom factor and DPI is less than this value, the widget is not visible.
`visibleMaxfloat`If the current zoom factor and DPI is bigger than this value, the widget is not visible.
`tooltipstr`Set a basic tooltip for the widget, this will simply be a Label, it will follow the Tooltip style
`tooltip_fnCallable`Set dynamic tooltip that will be created dynamiclly the first time it is needed. the function is called inside a ui.Frame scope that the widget will be parented correctly.
`tooltip_offset_xfloat`Set the X tooltip offset in points. In a normal state, the tooltip position is linked to the mouse position. If the tooltip offset is non zero, the top left corner of the tooltip is linked to the top left corner of the widget, and this property defines the relative position the tooltip should be shown.
`tooltip_offset_yfloat`Set the Y tooltip offset in points. In a normal state, the tooltip position is linked to the mouse position. If the tooltip offset is non zero, the top left corner of the tooltip is linked to the top left corner of the widget, and this property defines the relative position the tooltip should be shown.
`enabledbool`This property holds whether the widget is enabled. In general an enabled widget handles keyboard and mouse events; a disabled widget does not. And widgets display themselves differently when they are disabled.
`selectedbool`This property holds a flag that specifies the widget has to use eSelected state of the style.
`checkedbool`This property holds a flag that specifies the widget has to use eChecked state of the style. It’s on the Widget level because the button can have sub-widgets that are also should be checked.
`draggingbool`This property holds if the widget is being dragged.
`opaque_for_mouse_eventsbool`If the widgets has callback functions it will by default not capture the events if it is the top most widget and setup this option to true, so they don’t get routed to the child widgets either
`skip_draw_when_clippedbool`The flag that specifies if it’s necessary to bypass the whole draw cycle if the bounding box is clipped with a scrolling frame. It’s needed to avoid the limitation of 65535 primitives in a single draw list.
`mouse_moved_fnCallable`Sets the function that will be called when the user moves the mouse inside the widget. Mouse move events only occur if a mouse button is pressed while the mouse is being moved. void onMouseMoved(float x, float y, int32_t modifier)
`mouse_pressed_fnCallable`Sets the function that will be called when the user presses the mouse button inside the widget. The function should be like this: void onMousePressed(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier) Where ‘button’ is the number of the mouse button pressed. ‘modifier’ is the flag for the keyboard modifier key.
`mouse_released_fnCallable`Sets the function that will be called when the user releases the mouse button if this button was pressed inside the widget. void onMouseReleased(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)
`mouse_double_clicked_fnCallable`Sets the function that will be called when the user presses the mouse button twice inside the widget. The function specification is the same as in setMousePressedFn. void onMouseDoubleClicked(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)
`mouse_wheel_fnCallable`Sets the function that will be called when the user uses mouse wheel on the focused window. The function specification is the same as in setMousePressedFn. void onMouseWheel(float x, float y, carb::input::KeyboardModifierFlags modifier)
`mouse_hovered_fnCallable`Sets the function that will be called when the user use mouse enter/leave on the focused window. function specification is the same as in setMouseHovedFn. void onMouseHovered(bool hovered)
`drag_fnCallable`Specify that this Widget is draggable, and set the callback that is attached to the drag operation.
`accept_drop_fnCallable`Specify that this Widget can accept specific drops and set the callback that is called to check if the drop can be accepted.
`drop_fnCallable`Specify that this Widget accepts drops and set the callback to the drop operation.
`computed_content_size_changed_fnCallable`Called when the size of the widget is changed.
set_scroll_x_changed_fn(self: omni.ui._ui.ScrollingFrame, arg0: Callable[[float], None]) → None
The horizontal position of the scroll bar. When it’s changed, the contents will be scrolled accordingly.
set_scroll_y_changed_fn(self: omni.ui._ui.ScrollingFrame, arg0: Callable[[float], None]) → None
The vertical position of the scroll bar. When it’s changed, the contents will be scrolled accordingly.
property horizontal_scrollbar_policy
This property holds the policy for the horizontal scroll bar.
property scroll_x
The horizontal position of the scroll bar. When it’s changed, the contents will be scrolled accordingly.
property scroll_x_max
The max position of the horizontal scroll bar.
property scroll_y
The vertical position of the scroll bar. When it’s changed, the contents will be scrolled accordingly.
property scroll_y_max
The max position of the vertical scroll bar.
property vertical_scrollbar_policy
This property holds the policy for the vertical scroll bar.
© Copyright 2019-2024, NVIDIA.
Last updated on Mar 25, 2024. |
omni.ui.Direction.md | Direction — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
Direction
# Direction
class omni.ui.Direction
Bases: pybind11_object
Members:
LEFT_TO_RIGHT
RIGHT_TO_LEFT
TOP_TO_BOTTOM
BOTTOM_TO_TOP
BACK_TO_FRONT
FRONT_TO_BACK
Methods
__init__(self, value)
Attributes
BACK_TO_FRONT
BOTTOM_TO_TOP
FRONT_TO_BACK
LEFT_TO_RIGHT
RIGHT_TO_LEFT
TOP_TO_BOTTOM
name
value
__init__(self: omni.ui._ui.Direction, value: int) → None
property name
© Copyright 2019-2024, NVIDIA.
Last updated on Mar 25, 2024. |
omni.ui.CircleSizePolicy.md | CircleSizePolicy — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
CircleSizePolicy
# CircleSizePolicy
class omni.ui.CircleSizePolicy
Bases: pybind11_object
Define what happens when the source image has a different size than the item.
Members:
STRETCH
FIXED
Methods
__init__(self, value)
Attributes
FIXED
STRETCH
name
value
__init__(self: omni.ui._ui.CircleSizePolicy, value: int) → None
property name
© Copyright 2019-2024, NVIDIA.
Last updated on Mar 25, 2024. |
it-managed-installation-overview.md | IT Managed Launcher Overview — Omniverse Launcher latest documentation
Omniverse Launcher
»
Omniverse Launcher »
IT Managed Launcher Overview
# IT Managed Launcher Overview
The IT Managed Launcher is an enterprise user’s front end to all of the Omniverse applications that their company makes available to them on their local workstation.
Its main use is to allow a company more control over deployment of Omniverse to its users. Some of the features included
Support for deployment tools such as PowerShell, Group Policy, SCCM, as well as Linux deployment tools.
Does not require an Nvidia Account login for the end users.
Can be used in an a firewalled environment.
End users cannot download, install, or update Apps.
It is designed to be installed by IT department personnel given many corporate networks have strict security policies in place. The IT Managed Launcher is available for both Windows and Linux operating systems.
IT Managed Launcher
Omniverse Workstation Launcher
This launcher and its interface differ from the standard Omniverse Workstation Launcher in that it is not designed to allow an end user to install anything directly on their own workstation or update installed applications themselves. It is therefore missing the top-level Exchange and Nucleus sections of the Workstation Launcher by design.
These sections are not present within the IT Managed Launcher as these elements are intended to be installed and configured by the IT Managers and Systems Administrators within your organization.
The other major difference between the IT Managed Launcher and the normal Workstation Launcher is that the IT Managed Launcher does not require a developer account login for it to function.
The IT Managed Launcher is a critical component for accessing the Omniverse foundation apps for your organization and users, so as a first step, your initial task is to install this component to your local users’ workstations.
## IT Managed Launcher components
### IT Managed Launcher Installer
This is the main application that will be installed on each users machine. Installers are available for Windows and Linux.
### TOML File
The TOML ml files control the setting for the install. There are three TOML files.
Omniverse.toml
Used to define all the main path and options for the launcher. file is the primary configuration file for the IT Managed Launcher. Within this configuration file, the following paths are described, and they should match the selections you made in step 1. Be aware that you can set these after the installation to different paths as needed for security policy at any time.
Path
Description
library_root = “C:\Omniverse\library”
Path where to install all Omniverse applications
data_root = “C:\Omniverse\data”
Folder where Launcher and Omniverse apps store their data files
cache_root = “C:\Omniverse\cache”
Folder where Omniverse apps store their cache and temporary files
logs_root = “C:\Users\[username]\.nvidia-omniverse\logs”
Folder where Launcher and Omniverse apps store their logs
content_root = “C:\Users\[username]\Downloads”
Folder where Launcher saves downloaded content packs
extension_root = “C:\Users\[username]\Documents\kit\shared\exts”
Folder where all Omniverse shared extensions are stored
confirmed = true
Confirmation that all paths are set correctly, must be set to true
Important
Also be aware that all paths on Windows require a double backslash (\) for proper operation.
Note
If a system administrator doesn’t want to allow users to change these paths, the omniverse.toml file can be marked as read-only. Also, if a System Administrator plans to install the IT Managed Launcher to a shared location like Program Files on Windows, they need to specify a shared folder for library_root and logs_root path in omniverse.toml file.
You’re now going to add two additional files to this /config folder in addition to the omniverse.toml file.
### Auth.toml
### License.toml
File to provide your license details and Customer ID.
[ovlicense]
org-name = "<organization_id>"
### Privacy.toml
file to record consent choices for data collection and capture of crash logs
Within the /config folder, then create a text file named privacy.toml. This is the configuration file for Omniverse telemetry. The file contains following information:
[privacy]
performance = true
personalization = true
usage = true
Important
By opting into telemetry within the privacy.toml, you can help improve the performance & stability of the software. For more details on what data is collected and how it is processed see this section.
### Packages
Packages are what get deployed to each user. The packages are available here (Omniverse Launcher - Exchange (nvidia.com)) . Applications and Contents Packs are vavaible to download for linux and windows to deploy to users.
© Copyright 2023-2024, NVIDIA.
Last updated on Apr 15, 2024. |
package.md | Package a Build — Omniverse Developer Guide latest documentation
Omniverse Developer Guide
»
Omniverse Developer Guide »
Package a Build
# Package a Build
At the conclusion of your development and testing phases, packaging your project is often necessary in preparation for publishing. While some extensions may not require this step, it becomes essential for applications and more complex extensions involving advanced features. The packaging process organizes and structures your project assets for delivery and deployment. The specifics of the packaging step depend on your desired method of distribution.
## Introduction
Please ensure that you are following the NVIDIA Omniverse License Agreement when developing your project. If you intend to distribute your project outside your company, it must use thin packaging.
Important Notes:
Packaging is OS dependent. Linux is required for Linux packages and Windows is required for Windows packages
Packaging requires a build of the desired Project. See Build a Project for additional details
Instructions provided here assume use of Repo tooling
Packages are a collection of all the files that compose your Project. Although it is possible to manually assemble your package by creating an archive with the necessary files and folders, Omniverse conveniently offers a more efficient alternative via the Repo Package tool. This tool verifies that you have all the essential config files and that your build folder is accurately configured.
## Packaging Extensions
It’s important to note that sometimes, specifically with simpler extensions, you may only need to manually copy the files into the destination directory for distribution. Generally, the repo package method is best used for projects that contain a premake5.lua file and result in a _build folder.
## Packaging Applications
### Lock Extension Versions
Before packaging, it is advised to lock your Extension versions. While iterative development typically benefits from using the latest versions without specifying one, it’s good practice to lock Extension versions for distributed Applications. This ensures that end users install and experience the fully tested and developed version.
The following steps apply if you’re working on a Kit project that includes the Repo tool, like the kit-app-template, for example.
To lock Extension versions:
Build the Project
Open the repo.toml file (most likely in the root directory of the project) and insert a reference to the application .kit file in the [repo_precache_exts] section:
[repo_precache_exts]
# Apps to run and precache
apps = [
"${root}/source/apps/my_company.my_app.kit",
]
Run the command repo precache_exts -u.
Open the .kit file. There should be a section labeled BEGIN GENERATED PART. This is where Extension versions have been locked.
### Warmup Script
When an end user installs an Application we can provide a warmup procedure that caches shaders and a does a few other things to improve the Application startup performance. This is an optional step and is most relevant to packages published via an Omniverse Launcher.
Open .\kit-app-template\premake5.lua.
Note this section:
-- App warmup script for the Launcher
create_app_warmup_script("omni.usd_explorer", {
args = "--exec \"open_stage.py ${SCRIPT_DIR}exts/omni.usd_explorer.setup/data/BuiltInMaterials.usda\" --/app/warmupMode=1 --no-window --/app/extensions/excluded/0='omni.kit.splash' --/app/extensions/excluded/1='omni.kit.splash.carousel' --/app/extensions/excluded/2='omni.kit.window.splash' --/app/settings/persistent=0 --/app/settings/loadUserConfig=0 --/structuredLog/enable=0 --/app/hangDetector/enabled=0 --/crashreporter/skipOldDumpUpload=1 --/app/content/emptyStageOnStart=1 --/app/window/showStartup=false --/rtx/materialDb/syncLoads=1 --/omni.kit.plugin/syncUsdLoads=1 --/rtx/hydra/materialSyncLoads=1 --/app/asyncRendering=0 --/app/file/ignoreUnsavedOnExit=1 --/renderer/multiGpu/enabled=0 --/app/quitAfter=10"
})
By including this section for the app, an additional [app name].warmup.bat\.sh is added in the build. Go ahead and change omni.usd_explorer to my_company.usd_explorer (there’s two places):
-- App warmup script for the Launcher
create_app_warmup_script("my_company.usd_explorer", {
args = "--exec \"open_stage.py ${SCRIPT_DIR}exts/my_company.usd_explorer.setup/data/BuiltInMaterials.usda\" --/app/warmupMode=1 --no-window --/app/extensions/excluded/0='omni.kit.splash' --/app/extensions/excluded/1='omni.kit.splash.carousel' --/app/extensions/excluded/2='omni.kit.window.splash' --/app/settings/persistent=0 --/app/settings/loadUserConfig=0 --/structuredLog/enable=0 --/app/hangDetector/enabled=0 --/crashreporter/skipOldDumpUpload=1 --/app/content/emptyStageOnStart=1 --/app/window/showStartup=false --/rtx/materialDb/syncLoads=1 --/omni.kit.plugin/syncUsdLoads=1 --/rtx/hydra/materialSyncLoads=1 --/app/asyncRendering=0 --/app/file/ignoreUnsavedOnExit=1 --/renderer/multiGpu/enabled=0 --/app/quitAfter=10"
})
Run a build.
A my_company.usd_explorer.warmup.bat.sh file was created in the build directory.
To prepare for a Launcher package, open .kit-app-templatesourcelauncherlauncher.toml.
Note the per platform post-install = “” entries. Edit these settings to provide the warmup script (the default has them commented out):
[defaults.windows-x86_64.install]
...
post-install = "${productRoot}/my_company.usd_explorer.warmup.bat"
...
[defaults.linux-x86_64.install]
...
post-install = "${productRoot}/my_company.usd_explorer.warmup.sh"
...
### Create the Package
There are primarily two types of packages: ‘Fat’ and ‘Thin’.
‘Fat’ Package
Includes all the necessary components to run the app, encompassing both the Kit Kernel and all Extensions. This is the package type you should opt for if you don’t want end users to download anything during installation. It is particularly useful in environments without access to public repositories, such as air-gapped organizations.
‘Thin’ Package
Contains the bare essentials needed for an installation, necessitating the download of the Kit Kernel and Extensions during app installation. Thin packages optimize the use of local storage by only downloading components that other thin packaged apps haven’t already downloaded. However, this package type isn’t suitable for air-gapped environments.
Both ‘fat’ and ‘thin’ packages come as zip-archives and can be directly shared with end users.
A variant is the ‘Launcher’ Package. This type includes either a ‘fat’ or ‘thin’ application package along with additional resources, enabling the application to be listed in the Omniverse Launcher.
Both fat and thin packages can be renamed - nothing inside the package depends on the package name.
#### Fat Package
Build the Project
Execute repo package.
Package is created in the .\_build\package directory.
#### Thin Package
Build the Project
Execute repo package --thin.
Package is created in the .\_build\package directory.
## Connectors
Note
There is no set method for packaging connectors. Please reference the Connect Sample and associated documentation for best practices
© Copyright 2023-2024, NVIDIA.
Last updated on Apr 15, 2024. |
omni.ui.BezierCurve.md | BezierCurve — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
BezierCurve
# BezierCurve
class omni.ui.BezierCurve
Bases: Shape, ArrowHelper, ShapeAnchorHelper
Smooth curve that can be scaled infinitely.
Methods
__init__(self, **kwargs)
Initialize the curve.
call_mouse_hovered_fn(self, arg0)
Sets the function that will be called when the user use mouse enter/leave on the line.
has_mouse_hovered_fn(self)
Sets the function that will be called when the user use mouse enter/leave on the line.
set_mouse_hovered_fn(self, fn)
Sets the function that will be called when the user use mouse enter/leave on the line.
Attributes
end_tangent_height
This property holds the Y coordinate of the end of the curve relative to the width bound of the curve.
end_tangent_width
This property holds the X coordinate of the end of the curve relative to the width bound of the curve.
start_tangent_height
This property holds the Y coordinate of the start of the curve relative to the width bound of the curve.
start_tangent_width
This property holds the X coordinate of the start of the curve relative to the width bound of the curve.
__init__(self: omni.ui._ui.BezierCurve, **kwargs) → None
Initialize the curve.
`kwargsdict`See below
### Keyword Arguments:
`start_tangent_width: `
This property holds the X coordinate of the start of the curve relative to the width bound of the curve.
`start_tangent_height: `
This property holds the Y coordinate of the start of the curve relative to the width bound of the curve.
`end_tangent_width: `
This property holds the X coordinate of the end of the curve relative to the width bound of the curve.
`end_tangent_height: `
This property holds the Y coordinate of the end of the curve relative to the width bound of the curve.
`set_mouse_hovered_fn: `
Sets the function that will be called when the user use mouse enter/leave on the line. It’s the override to prevent Widget from the bounding box logic. The function specification is: void onMouseHovered(bool hovered)
`widthui.Length`This property holds the width of the widget relative to its parent. Do not use this function to find the width of a screen.
`heightui.Length`This property holds the height of the widget relative to its parent. Do not use this function to find the height of a screen.
`namestr`The name of the widget that user can set.
`style_type_name_overridestr`By default, we use typeName to look up the style. But sometimes it’s necessary to use a custom name. For example, when a widget is a part of another widget. (Label is a part of Button) This property can override the name to use in style.
`identifierstr`An optional identifier of the widget we can use to refer to it in queries.
`visiblebool`This property holds whether the widget is visible.
`visibleMinfloat`If the current zoom factor and DPI is less than this value, the widget is not visible.
`visibleMaxfloat`If the current zoom factor and DPI is bigger than this value, the widget is not visible.
`tooltipstr`Set a basic tooltip for the widget, this will simply be a Label, it will follow the Tooltip style
`tooltip_fnCallable`Set dynamic tooltip that will be created dynamiclly the first time it is needed. the function is called inside a ui.Frame scope that the widget will be parented correctly.
`tooltip_offset_xfloat`Set the X tooltip offset in points. In a normal state, the tooltip position is linked to the mouse position. If the tooltip offset is non zero, the top left corner of the tooltip is linked to the top left corner of the widget, and this property defines the relative position the tooltip should be shown.
`tooltip_offset_yfloat`Set the Y tooltip offset in points. In a normal state, the tooltip position is linked to the mouse position. If the tooltip offset is non zero, the top left corner of the tooltip is linked to the top left corner of the widget, and this property defines the relative position the tooltip should be shown.
`enabledbool`This property holds whether the widget is enabled. In general an enabled widget handles keyboard and mouse events; a disabled widget does not. And widgets display themselves differently when they are disabled.
`selectedbool`This property holds a flag that specifies the widget has to use eSelected state of the style.
`checkedbool`This property holds a flag that specifies the widget has to use eChecked state of the style. It’s on the Widget level because the button can have sub-widgets that are also should be checked.
`draggingbool`This property holds if the widget is being dragged.
`opaque_for_mouse_eventsbool`If the widgets has callback functions it will by default not capture the events if it is the top most widget and setup this option to true, so they don’t get routed to the child widgets either
`skip_draw_when_clippedbool`The flag that specifies if it’s necessary to bypass the whole draw cycle if the bounding box is clipped with a scrolling frame. It’s needed to avoid the limitation of 65535 primitives in a single draw list.
`mouse_moved_fnCallable`Sets the function that will be called when the user moves the mouse inside the widget. Mouse move events only occur if a mouse button is pressed while the mouse is being moved. void onMouseMoved(float x, float y, int32_t modifier)
`mouse_pressed_fnCallable`Sets the function that will be called when the user presses the mouse button inside the widget. The function should be like this: void onMousePressed(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier) Where ‘button’ is the number of the mouse button pressed. ‘modifier’ is the flag for the keyboard modifier key.
`mouse_released_fnCallable`Sets the function that will be called when the user releases the mouse button if this button was pressed inside the widget. void onMouseReleased(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)
`mouse_double_clicked_fnCallable`Sets the function that will be called when the user presses the mouse button twice inside the widget. The function specification is the same as in setMousePressedFn. void onMouseDoubleClicked(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)
`mouse_wheel_fnCallable`Sets the function that will be called when the user uses mouse wheel on the focused window. The function specification is the same as in setMousePressedFn. void onMouseWheel(float x, float y, carb::input::KeyboardModifierFlags modifier)
`mouse_hovered_fnCallable`Sets the function that will be called when the user use mouse enter/leave on the focused window. function specification is the same as in setMouseHovedFn. void onMouseHovered(bool hovered)
`drag_fnCallable`Specify that this Widget is draggable, and set the callback that is attached to the drag operation.
`accept_drop_fnCallable`Specify that this Widget can accept specific drops and set the callback that is called to check if the drop can be accepted.
`drop_fnCallable`Specify that this Widget accepts drops and set the callback to the drop operation.
`computed_content_size_changed_fnCallable`Called when the size of the widget is changed.
`anchor_position: `This property holds the parametric value of the curve anchor.
`anchor_alignment: `This property holds the Alignment of the curve anchor.
`set_anchor_fn: Callable`Sets the function that will be called for the curve anchor.
`invalidate_anchor: `Function that causes the anchor frame to be redrawn.
`get_closest_parametric_position: `Function that returns the closest parametric T value to a given x,y position.
call_mouse_hovered_fn(self: omni.ui._ui.BezierCurve, arg0: bool) → None
Sets the function that will be called when the user use mouse enter/leave on the line. It’s the override to prevent Widget from the bounding box logic. The function specification is: void onMouseHovered(bool hovered)
has_mouse_hovered_fn(self: omni.ui._ui.BezierCurve) → bool
Sets the function that will be called when the user use mouse enter/leave on the line. It’s the override to prevent Widget from the bounding box logic. The function specification is: void onMouseHovered(bool hovered)
set_mouse_hovered_fn(self: omni.ui._ui.BezierCurve, fn: Callable[[bool], None]) → None
Sets the function that will be called when the user use mouse enter/leave on the line. It’s the override to prevent Widget from the bounding box logic. The function specification is: void onMouseHovered(bool hovered)
property end_tangent_height
This property holds the Y coordinate of the end of the curve relative to the width bound of the curve.
property end_tangent_width
This property holds the X coordinate of the end of the curve relative to the width bound of the curve.
property start_tangent_height
This property holds the Y coordinate of the start of the curve relative to the width bound of the curve.
property start_tangent_width
This property holds the X coordinate of the start of the curve relative to the width bound of the curve.
© Copyright 2019-2024, NVIDIA.
Last updated on Mar 25, 2024. |
UsdGeom.md | UsdGeom module — pxr-usd-api 105.1 documentation
pxr-usd-api
»
Modules »
UsdGeom module
# UsdGeom module
Summary: The UsdGeom module defines 3D graphics-related prim and property schemas that form a basis for geometry interchange.
Classes:
BBoxCache
Caches bounds by recursively computing and aggregating bounds of children in world space and aggregating the result back into local space.
BasisCurves
BasisCurves are a batched curve representation analogous to the classic RIB definition via Basis and Curves statements.
Boundable
Boundable introduces the ability for a prim to persistently cache a rectilinear, local-space, extent.
Camera
Transformable camera.
Capsule
Defines a primitive capsule, i.e. a cylinder capped by two half spheres, centered at the origin, whose spine is along the specified axis.
Cone
Defines a primitive cone, centered at the origin, whose spine is along the specified axis, with the apex of the cone pointing in the direction of the positive axis.
ConstraintTarget
Schema wrapper for UsdAttribute for authoring and introspecting attributes that are constraint targets.
Cube
Defines a primitive rectilinear cube centered at the origin.
Curves
Base class for UsdGeomBasisCurves, UsdGeomNurbsCurves, and UsdGeomHermiteCurves.
Cylinder
Defines a primitive cylinder with closed ends, centered at the origin, whose spine is along the specified axis.
Gprim
Base class for all geometric primitives.
HermiteCurves
This schema specifies a cubic hermite interpolated curve batch as sometimes used for defining guides for animation.
Imageable
Base class for all prims that may require rendering or visualization of some sort.
LinearUnits
Mesh
Encodes a mesh with optional subdivision properties and features.
ModelAPI
UsdGeomModelAPI extends the generic UsdModelAPI schema with geometry specific concepts such as cached extents for the entire model, constraint targets, and geometry-inspired extensions to the payload lofting process.
MotionAPI
UsdGeomMotionAPI encodes data that can live on any prim that may affect computations involving:
NurbsCurves
This schema is analagous to NURBS Curves in packages like Maya and Houdini, often used for interchange of rigging and modeling curves.
NurbsPatch
Encodes a rational or polynomial non-uniform B-spline surface, with optional trim curves.
Plane
Defines a primitive plane, centered at the origin, and is defined by a cardinal axis, width, and length.
PointBased
Base class for all UsdGeomGprims that possess points, providing common attributes such as normals and velocities.
PointInstancer
Encodes vectorized instancing of multiple, potentially animated, prototypes (object/instance masters), which can be arbitrary prims/subtrees on a UsdStage.
Points
Points are analogous to the RiPoints spec.
Primvar
Schema wrapper for UsdAttribute for authoring and introspecting attributes that are primvars.
PrimvarsAPI
UsdGeomPrimvarsAPI encodes geometric"primitive variables", as UsdGeomPrimvar, which interpolate across a primitive's topology, can override shader inputs, and inherit down namespace.
Scope
Scope is the simplest grouping primitive, and does not carry the baggage of transformability.
Sphere
Defines a primitive sphere centered at the origin.
Subset
Encodes a subset of a piece of geometry (i.e.
Tokens
VisibilityAPI
UsdGeomVisibilityAPI introduces properties that can be used to author visibility opinions.
Xform
Concrete prim schema for a transform, which implements Xformable
XformCache
A caching mechanism for transform matrices.
XformCommonAPI
This class provides API for authoring and retrieving a standard set of component transformations which include a scale, a rotation, a scale- rotate pivot and a translation.
XformOp
Schema wrapper for UsdAttribute for authoring and computing transformation operations, as consumed by UsdGeomXformable schema.
XformOpTypes
Xformable
Base class for all transformable prims, which allows arbitrary sequences of component affine transformations to be encoded.
class pxr.UsdGeom.BBoxCache
Caches bounds by recursively computing and aggregating bounds of
children in world space and aggregating the result back into local
space.
The cache is configured for a specific time and
UsdGeomImageable::GetPurposeAttr() set of purposes. When querying a
bound, transforms and extents are read either from the time specified
or UsdTimeCode::Default() , following TimeSamples, Defaults, and Value
Resolution standard time-sample value resolution. As noted in
SetIncludedPurposes() , changing the included purposes does not
invalidate the cache, because we cache purpose along with the
geometric data.
Child prims that are invisible at the requested time are excluded when
computing a prim’s bounds. However, if a bound is requested directly
for an excluded prim, it will be computed. Additionally, only prims
deriving from UsdGeomImageable are included in child bounds
computations.
Unlike standard UsdStage traversals, the traversal performed by the
UsdGeomBBoxCache includesprims that are unloaded (see
UsdPrim::IsLoaded() ). This makes it possible to fetch bounds for a
UsdStage that has been opened without forcePopulate, provided the
unloaded model prims have authored extent hints (see
UsdGeomModelAPI::GetExtentsHint() ).
This class is optimized for computing tight
untransformed”object”space bounds for component-models. In the
absence of component models, bounds are optimized for world-space,
since there is no other easily identifiable space for which to
optimize, and we cannot optimize for every prim’s local space without
performing quadratic work.
The TfDebug flag, USDGEOM_BBOX, is provided for debugging.
Warning
This class should only be used with valid UsdPrim objects.
This cache does not listen for change notifications; the user is
responsible for clearing the cache when changes occur.
Thread safety: instances of this class may not be used
concurrently.
Plugins may be loaded in order to compute extents for prim types
provided by that plugin. See
UsdGeomBoundable::ComputeExtentFromPlugins
Methods:
Clear()
Clears all pre-cached values.
ClearBaseTime()
Clear this cache's baseTime if one has been set.
ComputeLocalBound(prim)
Computes the oriented bounding box of the given prim, leveraging any pre-existing, cached bounds.
ComputePointInstanceLocalBound(instancer, ...)
Compute the oriented bounding boxes of the given point instances.
ComputePointInstanceLocalBounds(instancer, ...)
Compute the oriented bounding boxes of the given point instances.
ComputePointInstanceRelativeBound(instancer, ...)
Compute the bound of the given point instance in the space of an ancestor prim relativeToAncestorPrim .
ComputePointInstanceRelativeBounds(...)
Compute the bounds of the given point instances in the space of an ancestor prim relativeToAncestorPrim .
ComputePointInstanceUntransformedBound(...)
Computes the bound of the given point instances, but does not include the instancer's transform.
ComputePointInstanceUntransformedBounds(...)
Computes the bound of the given point instances, but does not include the transform (if any) authored on the instancer itself.
ComputePointInstanceWorldBound(instancer, ...)
Compute the bound of the given point instance in world space.
ComputePointInstanceWorldBounds(instancer, ...)
Compute the bound of the given point instances in world space.
ComputeRelativeBound(prim, ...)
Compute the bound of the given prim in the space of an ancestor prim, relativeToAncestorPrim , leveraging any pre-existing cached bounds.
ComputeUntransformedBound(prim)
Computes the bound of the prim's children leveraging any pre-existing, cached bounds, but does not include the transform (if any) authored on the prim itself.
ComputeWorldBound(prim)
Compute the bound of the given prim in world space, leveraging any pre-existing, cached bounds.
ComputeWorldBoundWithOverrides(prim, ...)
Computes the bound of the prim's descendents in world space while excluding the subtrees rooted at the paths in pathsToSkip .
GetBaseTime()
Return the base time if set, otherwise GetTime() .
GetIncludedPurposes()
Get the current set of included purposes.
GetTime()
Get the current time from which this cache is reading values.
GetUseExtentsHint()
Returns whether authored extent hints are used to compute bounding boxes.
HasBaseTime()
Return true if this cache has a baseTime that's been explicitly set, false otherwise.
SetBaseTime(baseTime)
Set the base time value for this bbox cache.
SetIncludedPurposes(includedPurposes)
Indicate the set of includedPurposes to use when resolving child bounds.
SetTime(time)
Use the new time when computing values and may clear any existing values cached for the previous time.
Clear() → None
Clears all pre-cached values.
ClearBaseTime() → None
Clear this cache’s baseTime if one has been set.
After calling this, the cache will use its time as the baseTime value.
ComputeLocalBound(prim) → BBox3d
Computes the oriented bounding box of the given prim, leveraging any
pre-existing, cached bounds.
The computed bound includes the transform authored on the prim itself,
but does not include any ancestor transforms (it does not include the
local-to-world transform).
See ComputeWorldBound() for notes on performance and error handling.
Parameters
prim (Prim) –
ComputePointInstanceLocalBound(instancer, instanceId) → BBox3d
Compute the oriented bounding boxes of the given point instances.
Parameters
instancer (PointInstancer) –
instanceId (int) –
ComputePointInstanceLocalBounds(instancer, instanceIdBegin, numIds, result) → bool
Compute the oriented bounding boxes of the given point instances.
The computed bounds include the transform authored on the instancer
itself, but does not include any ancestor transforms (it does not
include the local-to-world transform).
The result pointer must point to numIds GfBBox3d instances to
be filled.
Parameters
instancer (PointInstancer) –
instanceIdBegin (int) –
numIds (int) –
result (BBox3d) –
ComputePointInstanceRelativeBound(instancer, instanceId, relativeToAncestorPrim) → BBox3d
Compute the bound of the given point instance in the space of an
ancestor prim relativeToAncestorPrim .
Parameters
instancer (PointInstancer) –
instanceId (int) –
relativeToAncestorPrim (Prim) –
ComputePointInstanceRelativeBounds(instancer, instanceIdBegin, numIds, relativeToAncestorPrim, result) → bool
Compute the bounds of the given point instances in the space of an
ancestor prim relativeToAncestorPrim .
Write the results to result .
The computed bound excludes the local transform at
relativeToAncestorPrim . The computed bound may be incorrect if
relativeToAncestorPrim is not an ancestor of prim .
The result pointer must point to numIds GfBBox3d instances to
be filled.
Parameters
instancer (PointInstancer) –
instanceIdBegin (int) –
numIds (int) –
relativeToAncestorPrim (Prim) –
result (BBox3d) –
ComputePointInstanceUntransformedBound(instancer, instanceId) → BBox3d
Computes the bound of the given point instances, but does not include
the instancer’s transform.
Parameters
instancer (PointInstancer) –
instanceId (int) –
ComputePointInstanceUntransformedBounds(instancer, instanceIdBegin, numIds, result) → bool
Computes the bound of the given point instances, but does not include
the transform (if any) authored on the instancer itself.
IMPORTANT: while the BBox does not contain the local
transformation, in general it may still contain a non-identity
transformation matrix to put the bounds in the correct space.
Therefore, to obtain the correct axis-aligned bounding box, the client
must call ComputeAlignedRange().
The result pointer must point to numIds GfBBox3d instances to
be filled.
Parameters
instancer (PointInstancer) –
instanceIdBegin (int) –
numIds (int) –
result (BBox3d) –
ComputePointInstanceWorldBound(instancer, instanceId) → BBox3d
Compute the bound of the given point instance in world space.
Parameters
instancer (PointInstancer) –
instanceId (int) –
ComputePointInstanceWorldBounds(instancer, instanceIdBegin, numIds, result) → bool
Compute the bound of the given point instances in world space.
The bounds of each instance is computed and then transformed to world
space. The result pointer must point to numIds GfBBox3d
instances to be filled.
Parameters
instancer (PointInstancer) –
instanceIdBegin (int) –
numIds (int) –
result (BBox3d) –
ComputeRelativeBound(prim, relativeToAncestorPrim) → BBox3d
Compute the bound of the given prim in the space of an ancestor prim,
relativeToAncestorPrim , leveraging any pre-existing cached
bounds.
The computed bound excludes the local transform at
relativeToAncestorPrim . The computed bound may be incorrect if
relativeToAncestorPrim is not an ancestor of prim .
Parameters
prim (Prim) –
relativeToAncestorPrim (Prim) –
ComputeUntransformedBound(prim) → BBox3d
Computes the bound of the prim’s children leveraging any pre-existing,
cached bounds, but does not include the transform (if any) authored on
the prim itself.
IMPORTANT: while the BBox does not contain the local
transformation, in general it may still contain a non-identity
transformation matrix to put the bounds in the correct space.
Therefore, to obtain the correct axis-aligned bounding box, the client
must call ComputeAlignedRange().
See ComputeWorldBound() for notes on performance and error handling.
Parameters
prim (Prim) –
ComputeUntransformedBound(prim, pathsToSkip, ctmOverrides) -> BBox3d
This is an overloaded member function, provided for convenience. It
differs from the above function only in what argument(s) it accepts.
Computes the bound of the prim’s descendents while excluding the
subtrees rooted at the paths in pathsToSkip .
Additionally, the parameter ctmOverrides is used to specify
overrides to the CTM values of certain paths underneath the prim. The
CTM values in the ctmOverrides map are in the space of the given
prim, prim .
This leverages any pre-existing, cached bounds, but does not include
the transform (if any) authored on the prim itself.
IMPORTANT: while the BBox does not contain the local
transformation, in general it may still contain a non-identity
transformation matrix to put the bounds in the correct space.
Therefore, to obtain the correct axis-aligned bounding box, the client
must call ComputeAlignedRange().
See ComputeWorldBound() for notes on performance and error handling.
Parameters
prim (Prim) –
pathsToSkip (SdfPathSet) –
ctmOverrides (TfHashMap[Path, Matrix4d, Path.Hash]) –
ComputeWorldBound(prim) → BBox3d
Compute the bound of the given prim in world space, leveraging any
pre-existing, cached bounds.
The bound of the prim is computed, including the transform (if any)
authored on the node itself, and then transformed to world space.
Error handling note: No checking of prim validity is performed. If
prim is invalid, this method will abort the program; therefore it
is the client’s responsibility to ensure prim is valid.
Parameters
prim (Prim) –
ComputeWorldBoundWithOverrides(prim, pathsToSkip, primOverride, ctmOverrides) → BBox3d
Computes the bound of the prim’s descendents in world space while
excluding the subtrees rooted at the paths in pathsToSkip .
Additionally, the parameter primOverride overrides the local-to-
world transform of the prim and ctmOverrides is used to specify
overrides the local-to-world transforms of certain paths underneath
the prim.
This leverages any pre-existing, cached bounds, but does not include
the transform (if any) authored on the prim itself.
See ComputeWorldBound() for notes on performance and error handling.
Parameters
prim (Prim) –
pathsToSkip (SdfPathSet) –
primOverride (Matrix4d) –
ctmOverrides (TfHashMap[Path, Matrix4d, Path.Hash]) –
GetBaseTime() → TimeCode
Return the base time if set, otherwise GetTime() .
Use HasBaseTime() to observe if a base time has been set.
GetIncludedPurposes() → list[TfToken]
Get the current set of included purposes.
GetTime() → TimeCode
Get the current time from which this cache is reading values.
GetUseExtentsHint() → bool
Returns whether authored extent hints are used to compute bounding
boxes.
HasBaseTime() → bool
Return true if this cache has a baseTime that’s been explicitly set,
false otherwise.
SetBaseTime(baseTime) → None
Set the base time value for this bbox cache.
This value is used only when computing bboxes for point instancer
instances (see ComputePointInstanceWorldBounds() , for example). See
UsdGeomPointInstancer::ComputeExtentAtTime() for more information. If
unset, the bbox cache uses its time ( GetTime() / SetTime() ) for this
value.
Note that setting the base time does not invalidate any cache entries.
Parameters
baseTime (TimeCode) –
SetIncludedPurposes(includedPurposes) → None
Indicate the set of includedPurposes to use when resolving child
bounds.
Each child’s purpose must match one of the elements of this set to be
included in the computation; if it does not, child is excluded.
Note the use of child in the docs above, purpose is ignored for the
prim for whose bounds are directly queried.
Changing this value does not invalidate existing caches.
Parameters
includedPurposes (list[TfToken]) –
SetTime(time) → None
Use the new time when computing values and may clear any existing
values cached for the previous time.
Setting time to the current time is a no-op.
Parameters
time (TimeCode) –
class pxr.UsdGeom.BasisCurves
BasisCurves are a batched curve representation analogous to the
classic RIB definition via Basis and Curves statements. BasisCurves
are often used to render dense aggregate geometry like hair or grass.
A’matrix’and’vstep’associated with the basis are used to interpolate
the vertices of a cubic BasisCurves. (The basis attribute is unused
for linear BasisCurves.)
A single prim may have many curves whose count is determined
implicitly by the length of the curveVertexCounts vector. Each
individual curve is composed of one or more segments. Each segment is
defined by four vertices for cubic curves and two vertices for linear
curves. See the next section for more information on how to map curve
vertex counts to segment counts.
## Segment Indexing
Interpolating a curve requires knowing how to decompose it into its
individual segments.
The segments of a cubic curve are determined by the vertex count, the
wrap (periodicity), and the vstep of the basis. For linear curves,
the basis token is ignored and only the vertex count and wrap are
needed.
cubic basis
vstep
bezier
3
catmullRom
1
bspline
1
The first segment of a cubic (nonperiodic) curve is always defined by
its first four points. The vstep is the increment used to determine
what vertex indices define the next segment. For a two segment
(nonperiodic) bspline basis curve (vstep = 1), the first segment will
be defined by interpolating vertices [0, 1, 2, 3] and the second
segment will be defined by [1, 2, 3, 4]. For a two segment bezier
basis curve (vstep = 3), the first segment will be defined by
interpolating vertices [0, 1, 2, 3] and the second segment will be
defined by [3, 4, 5, 6]. If the vstep is not one, then you must take
special care to make sure that the number of cvs properly divides by
your vstep. (The indices described are relative to the initial vertex
index for a batched curve.)
For periodic curves, at least one of the curve’s initial vertices are
repeated to close the curve. For cubic curves, the number of vertices
repeated is’4 - vstep’. For linear curves, only one vertex is repeated
to close the loop.
Pinned curves are a special case of nonperiodic curves that only
affects the behavior of cubic Bspline and Catmull-Rom curves. To
evaluate or render pinned curves, a client must effectively
add’phantom points’at the beginning and end of every curve in a batch.
These phantom points are injected to ensure that the interpolated
curve begins at P[0] and ends at P[n-1].
For a curve with initial point P[0] and last point P[n-1], the phantom
points are defined as. P[-1] = 2 * P[0] - P[1] P[n] = 2 * P[n-1] -
P[n-2]
Pinned cubic curves will (usually) have to be unpacked into the
standard nonperiodic representation before rendering. This unpacking
can add some additional overhead. However, using pinned curves reduces
the amount of data recorded in a scene and (more importantly) better
records the authors’intent for interchange.
The additional phantom points mean that the minimum curve vertex count
for cubic bspline and catmullRom curves is 2. Linear curve segments
are defined by two vertices. A two segment linear curve’s first
segment would be defined by interpolating vertices [0, 1]. The second
segment would be defined by vertices [1, 2]. (Again, for a batched
curve, indices are relative to the initial vertex index.)
When validating curve topology, each renderable entry in the
curveVertexCounts vector must pass this check.
type
wrap
validitity
linear
nonperiodic
curveVertexCounts[i]>2
linear
periodic
curveVertexCounts[i]>3
cubic
nonperiodic
(curveVertexCounts[i] - 4) % vstep == 0
cubic
periodic
(curveVertexCounts[i]) % vstep == 0
cubic
pinned (catmullRom/bspline)
(curveVertexCounts[i] - 2)>= 0
## Cubic Vertex Interpolation
## Linear Vertex Interpolation
Linear interpolation is always used on curves of type linear.’t’with
domain [0, 1], the curve is defined by the equation P0 * (1-t) + P1
* t. t at 0 describes the first point and t at 1 describes the end
point.
## Primvar Interpolation
For cubic curves, primvar data can be either interpolated cubically
between vertices or linearly across segments. The corresponding token
for cubic interpolation is’vertex’and for linear interpolation
is’varying’. Per vertex data should be the same size as the number of
vertices in your curve. Segment varying data is dependent on the wrap
(periodicity) and number of segments in your curve. For linear curves,
varying and vertex data would be interpolated the same way. By
convention varying is the preferred interpolation because of the
association of varying with linear interpolation.
To convert an entry in the curveVertexCounts vector into a segment
count for an individual curve, apply these rules. Sum up all the
results in order to compute how many total segments all curves have.
The following tables describe the expected segment count for the’i’th
curve in a curve batch as well as the entire batch. Python syntax
like’[:]’(to describe all members of an array) and’len(...)’(to
describe the length of an array) are used.
type
wrap
curve segment count
batch segment count
linear
nonperiodic
curveVertexCounts[i] - 1
sum(curveVertexCounts[:]) - len(curveVertexCounts)
linear
periodic
curveVertexCounts[i]
sum(curveVertexCounts[:])
cubic
nonperiodic
(curveVertexCounts[i] - 4) / vstep + 1
sum(curveVertexCounts[:] - 4) / vstep + len(curveVertexCounts)
cubic
periodic
curveVertexCounts[i] / vstep
sum(curveVertexCounts[:]) / vstep
cubic
pinned (catmullRom/bspline)
(curveVertexCounts[i] - 2) + 1
sum(curveVertexCounts[:] - 2) + len(curveVertexCounts)
The following table descrives the expected size of varying (linearly
interpolated) data, derived from the segment counts computed above.
wrap
curve varying count
batch varying count
nonperiodic/pinned
segmentCounts[i] + 1
sum(segmentCounts[:]) + len(curveVertexCounts)
periodic
segmentCounts[i]
sum(segmentCounts[:])
Both curve types additionally define’constant’interpolation for the
entire prim and’uniform’interpolation as per curve data.
Take care when providing support for linearly interpolated data for
cubic curves. Its shape doesn’t provide a one to one mapping with
either the number of curves (like’uniform’) or the number of vertices
(like’vertex’) and so it is often overlooked. This is the only
primitive in UsdGeom (as of this writing) where this is true. For
meshes, while they use different interpolation
methods,’varying’and’vertex’are both specified per point. It’s common
to assume that curves follow a similar pattern and build in structures
and language for per primitive, per element, and per point data only
to come upon these arrays that don’t quite fit into either of those
categories. It is also common to conflate’varying’with being per
segment data and use the segmentCount rules table instead of its
neighboring varying data table rules. We suspect that this is because
for the common case of nonperiodic cubic curves, both the provided
segment count and varying data size formula end with’+ 1’. While
debugging, users may look at the double’+ 1’as a mistake and try to
remove it. We take this time to enumerate these issues because we’ve
fallen into them before and hope that we save others time in their own
implementations. As an example of deriving per curve segment and
varying primvar data counts from the wrap, type, basis, and
curveVertexCount, the following table is provided.
wrap
type
basis
curveVertexCount
curveSegmentCount
varyingDataCount
nonperiodic
linear
N/A
[2 3 2 5]
[1 2 1 4]
[2 3 2 5]
nonperiodic
cubic
bezier
[4 7 10 4 7]
[1 2 3 1 2]
[2 3 4 2 3]
nonperiodic
cubic
bspline
[5 4 6 7]
[2 1 3 4]
[3 2 4 5]
periodic
cubic
bezier
[6 9 6]
[2 3 2]
[2 3 2]
periodic
linear
N/A
[3 7]
[3 7]
[3 7]
## Tubes and Ribbons
The strictest definition of a curve as an infinitely thin wire is not
particularly useful for describing production scenes. The additional
widths and normals attributes can be used to describe cylindrical
tubes and or flat oriented ribbons.
Curves with only widths defined are imaged as tubes with radius’width
/ 2’. Curves with both widths and normals are imaged as ribbons
oriented in the direction of the interpolated normal vectors.
While not technically UsdGeomPrimvars, widths and normals also have
interpolation metadata. It’s common for authored widths to have
constant, varying, or vertex interpolation (see
UsdGeomCurves::GetWidthsInterpolation() ). It’s common for authored
normals to have varying interpolation (see
UsdGeomPointBased::GetNormalsInterpolation() ).
The file used to generate these curves can be found in
pxr/extras/examples/usdGeomExamples/basisCurves.usda. It’s provided as
a reference on how to properly image both tubes and ribbons. The first
row of curves are linear; the second are cubic bezier. (We aim in
future releases of HdSt to fix the discontinuity seen with broken
tangents to better match offline renderers like RenderMan.) The yellow
and violet cubic curves represent cubic vertex width interpolation for
which there is no equivalent for linear curves.
How did this prim type get its name? This prim is a portmanteau of two
different statements in the original RenderMan
specification:’Basis’and’Curves’. For any described attribute
Fallback Value or Allowed Values below that are text/tokens,
the actual token is published and defined in UsdGeomTokens. So to set
an attribute to the value”rightHanded”, use UsdGeomTokens->rightHanded
as the value.
Methods:
ComputeInterpolationForSize(n, timeCode, info)
Computes interpolation token for n .
ComputeUniformDataSize(timeCode)
Computes the expected size for data with"uniform"interpolation.
ComputeVaryingDataSize(timeCode)
Computes the expected size for data with"varying"interpolation.
ComputeVertexDataSize(timeCode)
Computes the expected size for data with"vertex"interpolation.
CreateBasisAttr(defaultValue, writeSparsely)
See GetBasisAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateTypeAttr(defaultValue, writeSparsely)
See GetTypeAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateWrapAttr(defaultValue, writeSparsely)
See GetWrapAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
Define
classmethod Define(stage, path) -> BasisCurves
Get
classmethod Get(stage, path) -> BasisCurves
GetBasisAttr()
The basis specifies the vstep and matrix used for cubic interpolation.
GetSchemaAttributeNames
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
GetTypeAttr()
Linear curves interpolate linearly between two vertices.
GetWrapAttr()
If wrap is set to periodic, the curve when rendered will repeat the initial vertices (dependent on the vstep) to close the curve.
ComputeInterpolationForSize(n, timeCode, info) → str
Computes interpolation token for n .
If this returns an empty token and info was non-None, it’ll
contain the expected value for each token.
The topology is determined using timeCode .
Parameters
n (int) –
timeCode (TimeCode) –
info (ComputeInterpolationInfo) –
ComputeUniformDataSize(timeCode) → int
Computes the expected size for data with”uniform”interpolation.
If you’re trying to determine what interpolation to use, it is more
efficient to use ComputeInterpolationForSize
Parameters
timeCode (TimeCode) –
ComputeVaryingDataSize(timeCode) → int
Computes the expected size for data with”varying”interpolation.
If you’re trying to determine what interpolation to use, it is more
efficient to use ComputeInterpolationForSize
Parameters
timeCode (TimeCode) –
ComputeVertexDataSize(timeCode) → int
Computes the expected size for data with”vertex”interpolation.
If you’re trying to determine what interpolation to use, it is more
efficient to use ComputeInterpolationForSize
Parameters
timeCode (TimeCode) –
CreateBasisAttr(defaultValue, writeSparsely) → Attribute
See GetBasisAttr() , and also Create vs Get Property Methods for when
to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateTypeAttr(defaultValue, writeSparsely) → Attribute
See GetTypeAttr() , and also Create vs Get Property Methods for when
to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateWrapAttr(defaultValue, writeSparsely) → Attribute
See GetWrapAttr() , and also Create vs Get Property Methods for when
to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
static Define()
classmethod Define(stage, path) -> BasisCurves
Attempt to ensure a UsdPrim adhering to this schema at path is
defined (according to UsdPrim::IsDefined() ) on this stage.
If a prim adhering to this schema at path is already defined on
this stage, return that prim. Otherwise author an SdfPrimSpec with
specifier == SdfSpecifierDef and this schema’s prim type name for
the prim at path at the current EditTarget. Author SdfPrimSpec s
with specifier == SdfSpecifierDef and empty typeName at the
current EditTarget for any nonexistent, or existing but not Defined
ancestors.
The given path must be an absolute prim path that does not contain
any variant selections.
If it is impossible to author any of the necessary PrimSpecs, (for
example, in case path cannot map to the current UsdEditTarget ‘s
namespace) issue an error and return an invalid UsdPrim.
Note that this method may return a defined prim whose typeName does
not specify this schema class, in case a stronger typeName opinion
overrides the opinion at the current EditTarget.
Parameters
stage (Stage) –
path (Path) –
static Get()
classmethod Get(stage, path) -> BasisCurves
Return a UsdGeomBasisCurves holding the prim adhering to this schema
at path on stage .
If no prim exists at path on stage , or if the prim at that
path does not adhere to this schema, return an invalid schema object.
This is shorthand for the following:
UsdGeomBasisCurves(stage->GetPrimAtPath(path));
Parameters
stage (Stage) –
path (Path) –
GetBasisAttr() → Attribute
The basis specifies the vstep and matrix used for cubic interpolation.
The’hermite’and’power’tokens have been removed. We’ve provided
UsdGeomHermiteCurves as an alternative for the’hermite’basis.
Declaration
uniform token basis ="bezier"
C++ Type
TfToken
Usd Type
SdfValueTypeNames->Token
Variability
SdfVariabilityUniform
Allowed Values
bezier, bspline, catmullRom
static GetSchemaAttributeNames()
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
Return a vector of names of all pre-declared attributes for this
schema class and all its ancestor classes.
Does not include attributes that may be authored by custom/extended
methods of the schemas involved.
Parameters
includeInherited (bool) –
GetTypeAttr() → Attribute
Linear curves interpolate linearly between two vertices.
Cubic curves use a basis matrix with four vertices to interpolate a
segment.
Declaration
uniform token type ="cubic"
C++ Type
TfToken
Usd Type
SdfValueTypeNames->Token
Variability
SdfVariabilityUniform
Allowed Values
linear, cubic
GetWrapAttr() → Attribute
If wrap is set to periodic, the curve when rendered will repeat the
initial vertices (dependent on the vstep) to close the curve.
If wrap is set to’pinned’, phantom points may be created to ensure
that the curve interpolation starts at P[0] and ends at P[n-1].
Declaration
uniform token wrap ="nonperiodic"
C++ Type
TfToken
Usd Type
SdfValueTypeNames->Token
Variability
SdfVariabilityUniform
Allowed Values
nonperiodic, periodic, pinned
class pxr.UsdGeom.Boundable
Boundable introduces the ability for a prim to persistently cache a
rectilinear, local-space, extent.
## Why Extent and not Bounds ?
Boundable introduces the notion of”extent”, which is a cached
computation of a prim’s local-space 3D range for its resolved
attributes at the layer and time in which extent is authored. We
have found that with composed scene description, attempting to cache
pre-computed bounds at interior prims in a scene graph is very
fragile, given the ease with which one can author a single attribute
in a stronger layer that can invalidate many authored caches - or with
which a re-published, referenced asset can do the same.
Therefore, we limit to precomputing (generally) leaf-prim extent,
which avoids the need to read in large point arrays to compute bounds,
and provides UsdGeomBBoxCache the means to efficiently compute and
(session-only) cache intermediate bounds. You are free to compute and
author intermediate bounds into your scenes, of course, which may work
well if you have sufficient locks on your pipeline to guarantee that
once authored, the geometry and transforms upon which they are based
will remain unchanged, or if accuracy of the bounds is not an ironclad
requisite.
When intermediate bounds are authored on Boundable parents, the child
prims will be pruned from BBox computation; the authored extent is
expected to incorporate all child bounds.
Methods:
ComputeExtent
classmethod ComputeExtent(radius, extent) -> bool
ComputeExtentFromPlugins
classmethod ComputeExtentFromPlugins(boundable, time, extent) -> bool
CreateExtentAttr(defaultValue, writeSparsely)
See GetExtentAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
Get
classmethod Get(stage, path) -> Boundable
GetExtentAttr()
Extent is a three dimensional range measuring the geometric extent of the authored gprim in its own local space (i.e.
GetSchemaAttributeNames
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
ComputeExtent()
classmethod ComputeExtent(radius, extent) -> bool
Compute the extent for the sphere defined by the radius.
true upon success, false if unable to calculate extent. On success,
extent will contain an approximate axis-aligned bounding box of the
sphere defined by the radius.
This function is to provide easy authoring of extent for usd authoring
tools, hence it is static and acts outside a specific prim (as in
attribute based methods).
Parameters
radius (float) –
extent (Vec3fArray) –
ComputeExtent(radius, transform, extent) -> bool
This is an overloaded member function, provided for convenience. It
differs from the above function only in what argument(s) it accepts.
Computes the extent as if the matrix transform was first applied.
Parameters
radius (float) –
transform (Matrix4d) –
extent (Vec3fArray) –
static ComputeExtentFromPlugins()
classmethod ComputeExtentFromPlugins(boundable, time, extent) -> bool
Compute the extent for the Boundable prim boundable at time
time .
If successful, populates extent with the result and returns
true , otherwise returns false .
The extent computation is based on the concrete type of the prim
represented by boundable . Plugins that provide a Boundable prim
type may implement and register an extent computation for that type
using UsdGeomRegisterComputeExtentFunction. ComputeExtentFromPlugins
will use this function to compute extents for all prims of that type.
If no function has been registered for a prim type, but a function has
been registered for one of its base types, that function will be used
instead.
This function may load plugins in order to access the extent
computation for a prim type.
Parameters
boundable (Boundable) –
time (TimeCode) –
extent (Vec3fArray) –
ComputeExtentFromPlugins(boundable, time, transform, extent) -> bool
This is an overloaded member function, provided for convenience. It
differs from the above function only in what argument(s) it accepts.
Computes the extent as if the matrix transform was first applied.
Parameters
boundable (Boundable) –
time (TimeCode) –
transform (Matrix4d) –
extent (Vec3fArray) –
CreateExtentAttr(defaultValue, writeSparsely) → Attribute
See GetExtentAttr() , and also Create vs Get Property Methods for when
to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
static Get()
classmethod Get(stage, path) -> Boundable
Return a UsdGeomBoundable holding the prim adhering to this schema at
path on stage .
If no prim exists at path on stage , or if the prim at that
path does not adhere to this schema, return an invalid schema object.
This is shorthand for the following:
UsdGeomBoundable(stage->GetPrimAtPath(path));
Parameters
stage (Stage) –
path (Path) –
GetExtentAttr() → Attribute
Extent is a three dimensional range measuring the geometric extent of
the authored gprim in its own local space (i.e.
its own transform not applied), without accounting for any shader-
induced displacement. If any extent value has been authored for a
given Boundable, then it should be authored at every timeSample at
which geometry-affecting properties are authored, to ensure correct
evaluation via ComputeExtent() . If no extent value has been
authored, then ComputeExtent() will call the Boundable’s registered
ComputeExtentFunction(), which may be expensive, which is why we
strongly encourage proper authoring of extent.
ComputeExtent()
Why Extent and not Bounds? . An authored extent on a prim which has
children is expected to include the extent of all children, as they
will be pruned from BBox computation during traversal.
Declaration
float3[] extent
C++ Type
VtArray<GfVec3f>
Usd Type
SdfValueTypeNames->Float3Array
static GetSchemaAttributeNames()
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
Return a vector of names of all pre-declared attributes for this
schema class and all its ancestor classes.
Does not include attributes that may be authored by custom/extended
methods of the schemas involved.
Parameters
includeInherited (bool) –
class pxr.UsdGeom.Camera
Transformable camera.
Describes optical properties of a camera via a common set of
attributes that provide control over the camera’s frustum as well as
its depth of field. For stereo, the left and right camera are
individual prims tagged through the stereoRole attribute.
There is a corresponding class GfCamera, which can hold the state of a
camera (at a particular time). UsdGeomCamera::GetCamera() and
UsdGeomCamera::SetFromCamera() convert between a USD camera prim and a
GfCamera.
To obtain the camera’s location in world space, call the following on
a UsdGeomCamera ‘camera’:
GfMatrix4d camXform = camera.ComputeLocalToWorldTransform(time);
Cameras in USD are always”Y up”, regardless of the stage’s
orientation (i.e. UsdGeomGetStageUpAxis() ). This means that the
inverse of’camXform’(the VIEW half of the MODELVIEW transform in
OpenGL parlance) will transform the world such that the camera is at
the origin, looking down the -Z axis, with +Y as the up axis, and +X
pointing to the right. This describes a right handed coordinate
system.
## Units of Measure for Camera Properties
Despite the familiarity of millimeters for specifying some physical
camera properties, UsdGeomCamera opts for greater consistency with all
other UsdGeom schemas, which measure geometric properties in scene
units, as determined by UsdGeomGetStageMetersPerUnit() . We do make a
concession, however, in that lens and filmback properties are measured
in tenths of a scene unit rather than”raw”scene units. This means
that with the fallback value of.01 for metersPerUnit - i.e. scene
unit of centimeters - then these”tenth of scene unit”properties are
effectively millimeters.
If one adds a Camera prim to a UsdStage whose scene unit is not
centimeters, the fallback values for filmback properties will be
incorrect (or at the least, unexpected) in an absolute sense; however,
proper imaging through a”default camera”with focusing disabled depends
only on ratios of the other properties, so the camera is still usable.
However, it follows that if even one property is authored in the
correct scene units, then they all must be.
Linear Algebra in UsdGeom For any described attribute Fallback
Value or Allowed Values below that are text/tokens, the actual
token is published and defined in UsdGeomTokens. So to set an
attribute to the value”rightHanded”, use UsdGeomTokens->rightHanded as
the value.
Methods:
CreateClippingPlanesAttr(defaultValue, ...)
See GetClippingPlanesAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateClippingRangeAttr(defaultValue, ...)
See GetClippingRangeAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateExposureAttr(defaultValue, writeSparsely)
See GetExposureAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateFStopAttr(defaultValue, writeSparsely)
See GetFStopAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateFocalLengthAttr(defaultValue, ...)
See GetFocalLengthAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateFocusDistanceAttr(defaultValue, ...)
See GetFocusDistanceAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateHorizontalApertureAttr(defaultValue, ...)
See GetHorizontalApertureAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateHorizontalApertureOffsetAttr(...)
See GetHorizontalApertureOffsetAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateProjectionAttr(defaultValue, writeSparsely)
See GetProjectionAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateShutterCloseAttr(defaultValue, ...)
See GetShutterCloseAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateShutterOpenAttr(defaultValue, ...)
See GetShutterOpenAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateStereoRoleAttr(defaultValue, writeSparsely)
See GetStereoRoleAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateVerticalApertureAttr(defaultValue, ...)
See GetVerticalApertureAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateVerticalApertureOffsetAttr(...)
See GetVerticalApertureOffsetAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
Define
classmethod Define(stage, path) -> Camera
Get
classmethod Get(stage, path) -> Camera
GetCamera(time)
Creates a GfCamera object from the attribute values at time .
GetClippingPlanesAttr()
Additional, arbitrarily oriented clipping planes.
GetClippingRangeAttr()
Near and far clipping distances in scene units; see Units of Measure for Camera Properties.
GetExposureAttr()
Exposure adjustment, as a log base-2 value.
GetFStopAttr()
Lens aperture.
GetFocalLengthAttr()
Perspective focal length in tenths of a scene unit; see Units of Measure for Camera Properties.
GetFocusDistanceAttr()
Distance from the camera to the focus plane in scene units; see Units of Measure for Camera Properties.
GetHorizontalApertureAttr()
Horizontal aperture in tenths of a scene unit; see Units of Measure for Camera Properties.
GetHorizontalApertureOffsetAttr()
Horizontal aperture offset in the same units as horizontalAperture.
GetProjectionAttr()
Declaration
GetSchemaAttributeNames
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
GetShutterCloseAttr()
Frame relative shutter close time, analogous comments from shutter:open apply.
GetShutterOpenAttr()
Frame relative shutter open time in UsdTimeCode units (negative value indicates that the shutter opens before the current frame time).
GetStereoRoleAttr()
If different from mono, the camera is intended to be the left or right camera of a stereo setup.
GetVerticalApertureAttr()
Vertical aperture in tenths of a scene unit; see Units of Measure for Camera Properties.
GetVerticalApertureOffsetAttr()
Vertical aperture offset in the same units as verticalAperture.
SetFromCamera(camera, time)
Write attribute values from camera for time .
CreateClippingPlanesAttr(defaultValue, writeSparsely) → Attribute
See GetClippingPlanesAttr() , and also Create vs Get Property Methods
for when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateClippingRangeAttr(defaultValue, writeSparsely) → Attribute
See GetClippingRangeAttr() , and also Create vs Get Property Methods
for when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateExposureAttr(defaultValue, writeSparsely) → Attribute
See GetExposureAttr() , and also Create vs Get Property Methods for
when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateFStopAttr(defaultValue, writeSparsely) → Attribute
See GetFStopAttr() , and also Create vs Get Property Methods for when
to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateFocalLengthAttr(defaultValue, writeSparsely) → Attribute
See GetFocalLengthAttr() , and also Create vs Get Property Methods for
when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateFocusDistanceAttr(defaultValue, writeSparsely) → Attribute
See GetFocusDistanceAttr() , and also Create vs Get Property Methods
for when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateHorizontalApertureAttr(defaultValue, writeSparsely) → Attribute
See GetHorizontalApertureAttr() , and also Create vs Get Property
Methods for when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateHorizontalApertureOffsetAttr(defaultValue, writeSparsely) → Attribute
See GetHorizontalApertureOffsetAttr() , and also Create vs Get
Property Methods for when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateProjectionAttr(defaultValue, writeSparsely) → Attribute
See GetProjectionAttr() , and also Create vs Get Property Methods for
when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateShutterCloseAttr(defaultValue, writeSparsely) → Attribute
See GetShutterCloseAttr() , and also Create vs Get Property Methods
for when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateShutterOpenAttr(defaultValue, writeSparsely) → Attribute
See GetShutterOpenAttr() , and also Create vs Get Property Methods for
when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateStereoRoleAttr(defaultValue, writeSparsely) → Attribute
See GetStereoRoleAttr() , and also Create vs Get Property Methods for
when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateVerticalApertureAttr(defaultValue, writeSparsely) → Attribute
See GetVerticalApertureAttr() , and also Create vs Get Property
Methods for when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateVerticalApertureOffsetAttr(defaultValue, writeSparsely) → Attribute
See GetVerticalApertureOffsetAttr() , and also Create vs Get Property
Methods for when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
static Define()
classmethod Define(stage, path) -> Camera
Attempt to ensure a UsdPrim adhering to this schema at path is
defined (according to UsdPrim::IsDefined() ) on this stage.
If a prim adhering to this schema at path is already defined on
this stage, return that prim. Otherwise author an SdfPrimSpec with
specifier == SdfSpecifierDef and this schema’s prim type name for
the prim at path at the current EditTarget. Author SdfPrimSpec s
with specifier == SdfSpecifierDef and empty typeName at the
current EditTarget for any nonexistent, or existing but not Defined
ancestors.
The given path must be an absolute prim path that does not contain
any variant selections.
If it is impossible to author any of the necessary PrimSpecs, (for
example, in case path cannot map to the current UsdEditTarget ‘s
namespace) issue an error and return an invalid UsdPrim.
Note that this method may return a defined prim whose typeName does
not specify this schema class, in case a stronger typeName opinion
overrides the opinion at the current EditTarget.
Parameters
stage (Stage) –
path (Path) –
static Get()
classmethod Get(stage, path) -> Camera
Return a UsdGeomCamera holding the prim adhering to this schema at
path on stage .
If no prim exists at path on stage , or if the prim at that
path does not adhere to this schema, return an invalid schema object.
This is shorthand for the following:
UsdGeomCamera(stage->GetPrimAtPath(path));
Parameters
stage (Stage) –
path (Path) –
GetCamera(time) → Camera
Creates a GfCamera object from the attribute values at time .
Parameters
time (TimeCode) –
GetClippingPlanesAttr() → Attribute
Additional, arbitrarily oriented clipping planes.
A vector (a,b,c,d) encodes a clipping plane that cuts off (x,y,z) with
a * x + b * y + c * z + d * 1<0 where (x,y,z) are the
coordinates in the camera’s space.
Declaration
float4[] clippingPlanes = []
C++ Type
VtArray<GfVec4f>
Usd Type
SdfValueTypeNames->Float4Array
GetClippingRangeAttr() → Attribute
Near and far clipping distances in scene units; see Units of Measure
for Camera Properties.
Declaration
float2 clippingRange = (1, 1000000)
C++ Type
GfVec2f
Usd Type
SdfValueTypeNames->Float2
GetExposureAttr() → Attribute
Exposure adjustment, as a log base-2 value.
The default of 0.0 has no effect. A value of 1.0 will double the
image-plane intensities in a rendered image; a value of -1.0 will
halve them.
Declaration
float exposure = 0
C++ Type
float
Usd Type
SdfValueTypeNames->Float
GetFStopAttr() → Attribute
Lens aperture.
Defaults to 0.0, which turns off focusing.
Declaration
float fStop = 0
C++ Type
float
Usd Type
SdfValueTypeNames->Float
GetFocalLengthAttr() → Attribute
Perspective focal length in tenths of a scene unit; see Units of
Measure for Camera Properties.
Declaration
float focalLength = 50
C++ Type
float
Usd Type
SdfValueTypeNames->Float
GetFocusDistanceAttr() → Attribute
Distance from the camera to the focus plane in scene units; see Units
of Measure for Camera Properties.
Declaration
float focusDistance = 0
C++ Type
float
Usd Type
SdfValueTypeNames->Float
GetHorizontalApertureAttr() → Attribute
Horizontal aperture in tenths of a scene unit; see Units of Measure
for Camera Properties.
Default is the equivalent of the standard 35mm spherical projector
aperture.
Declaration
float horizontalAperture = 20.955
C++ Type
float
Usd Type
SdfValueTypeNames->Float
GetHorizontalApertureOffsetAttr() → Attribute
Horizontal aperture offset in the same units as horizontalAperture.
Defaults to 0.
Declaration
float horizontalApertureOffset = 0
C++ Type
float
Usd Type
SdfValueTypeNames->Float
GetProjectionAttr() → Attribute
Declaration
token projection ="perspective"
C++ Type
TfToken
Usd Type
SdfValueTypeNames->Token
Allowed Values
perspective, orthographic
static GetSchemaAttributeNames()
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
Return a vector of names of all pre-declared attributes for this
schema class and all its ancestor classes.
Does not include attributes that may be authored by custom/extended
methods of the schemas involved.
Parameters
includeInherited (bool) –
GetShutterCloseAttr() → Attribute
Frame relative shutter close time, analogous comments from
shutter:open apply.
A value greater or equal to shutter:open should be authored, otherwise
there is no exposure and a renderer should produce a black image.
Declaration
double shutter:close = 0
C++ Type
double
Usd Type
SdfValueTypeNames->Double
GetShutterOpenAttr() → Attribute
Frame relative shutter open time in UsdTimeCode units (negative value
indicates that the shutter opens before the current frame time).
Used for motion blur.
Declaration
double shutter:open = 0
C++ Type
double
Usd Type
SdfValueTypeNames->Double
GetStereoRoleAttr() → Attribute
If different from mono, the camera is intended to be the left or right
camera of a stereo setup.
Declaration
uniform token stereoRole ="mono"
C++ Type
TfToken
Usd Type
SdfValueTypeNames->Token
Variability
SdfVariabilityUniform
Allowed Values
mono, left, right
GetVerticalApertureAttr() → Attribute
Vertical aperture in tenths of a scene unit; see Units of Measure for
Camera Properties.
Default is the equivalent of the standard 35mm spherical projector
aperture.
Declaration
float verticalAperture = 15.2908
C++ Type
float
Usd Type
SdfValueTypeNames->Float
GetVerticalApertureOffsetAttr() → Attribute
Vertical aperture offset in the same units as verticalAperture.
Defaults to 0.
Declaration
float verticalApertureOffset = 0
C++ Type
float
Usd Type
SdfValueTypeNames->Float
SetFromCamera(camera, time) → None
Write attribute values from camera for time .
These attributes will be updated:
projection
horizontalAperture
horizontalApertureOffset
verticalAperture
verticalApertureOffset
focalLength
clippingRange
clippingPlanes
fStop
focalDistance
xformOpOrder and xformOp:transform
This will clear any existing xformOpOrder and replace it with a single
xformOp:transform entry. The xformOp:transform property is created or
updated here to match the transform on camera . This operation
will fail if there are stronger xform op opinions in the composed
layer stack that are stronger than that of the current edit target.
Parameters
camera (Camera) –
time (TimeCode) –
class pxr.UsdGeom.Capsule
Defines a primitive capsule, i.e. a cylinder capped by two half
spheres, centered at the origin, whose spine is along the specified
axis.
For any described attribute Fallback Value or Allowed Values
below that are text/tokens, the actual token is published and defined
in UsdGeomTokens. So to set an attribute to the value”rightHanded”,
use UsdGeomTokens->rightHanded as the value.
Methods:
CreateAxisAttr(defaultValue, writeSparsely)
See GetAxisAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateExtentAttr(defaultValue, writeSparsely)
See GetExtentAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateHeightAttr(defaultValue, writeSparsely)
See GetHeightAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateRadiusAttr(defaultValue, writeSparsely)
See GetRadiusAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
Define
classmethod Define(stage, path) -> Capsule
Get
classmethod Get(stage, path) -> Capsule
GetAxisAttr()
The axis along which the spine of the capsule is aligned.
GetExtentAttr()
Extent is re-defined on Capsule only to provide a fallback value.
GetHeightAttr()
The size of the capsule's spine along the specified axis excluding the size of the two half spheres, i.e.
GetRadiusAttr()
The radius of the capsule.
GetSchemaAttributeNames
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
CreateAxisAttr(defaultValue, writeSparsely) → Attribute
See GetAxisAttr() , and also Create vs Get Property Methods for when
to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateExtentAttr(defaultValue, writeSparsely) → Attribute
See GetExtentAttr() , and also Create vs Get Property Methods for when
to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateHeightAttr(defaultValue, writeSparsely) → Attribute
See GetHeightAttr() , and also Create vs Get Property Methods for when
to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateRadiusAttr(defaultValue, writeSparsely) → Attribute
See GetRadiusAttr() , and also Create vs Get Property Methods for when
to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
static Define()
classmethod Define(stage, path) -> Capsule
Attempt to ensure a UsdPrim adhering to this schema at path is
defined (according to UsdPrim::IsDefined() ) on this stage.
If a prim adhering to this schema at path is already defined on
this stage, return that prim. Otherwise author an SdfPrimSpec with
specifier == SdfSpecifierDef and this schema’s prim type name for
the prim at path at the current EditTarget. Author SdfPrimSpec s
with specifier == SdfSpecifierDef and empty typeName at the
current EditTarget for any nonexistent, or existing but not Defined
ancestors.
The given path must be an absolute prim path that does not contain
any variant selections.
If it is impossible to author any of the necessary PrimSpecs, (for
example, in case path cannot map to the current UsdEditTarget ‘s
namespace) issue an error and return an invalid UsdPrim.
Note that this method may return a defined prim whose typeName does
not specify this schema class, in case a stronger typeName opinion
overrides the opinion at the current EditTarget.
Parameters
stage (Stage) –
path (Path) –
static Get()
classmethod Get(stage, path) -> Capsule
Return a UsdGeomCapsule holding the prim adhering to this schema at
path on stage .
If no prim exists at path on stage , or if the prim at that
path does not adhere to this schema, return an invalid schema object.
This is shorthand for the following:
UsdGeomCapsule(stage->GetPrimAtPath(path));
Parameters
stage (Stage) –
path (Path) –
GetAxisAttr() → Attribute
The axis along which the spine of the capsule is aligned.
Declaration
uniform token axis ="Z"
C++ Type
TfToken
Usd Type
SdfValueTypeNames->Token
Variability
SdfVariabilityUniform
Allowed Values
X, Y, Z
GetExtentAttr() → Attribute
Extent is re-defined on Capsule only to provide a fallback value.
UsdGeomGprim::GetExtentAttr() .
Declaration
float3[] extent = [(-0.5, -0.5, -1), (0.5, 0.5, 1)]
C++ Type
VtArray<GfVec3f>
Usd Type
SdfValueTypeNames->Float3Array
GetHeightAttr() → Attribute
The size of the capsule’s spine along the specified axis excluding
the size of the two half spheres, i.e.
the size of the cylinder portion of the capsule. If you author
height you must also author extent.
GetExtentAttr()
Declaration
double height = 1
C++ Type
double
Usd Type
SdfValueTypeNames->Double
GetRadiusAttr() → Attribute
The radius of the capsule.
If you author radius you must also author extent.
GetExtentAttr()
Declaration
double radius = 0.5
C++ Type
double
Usd Type
SdfValueTypeNames->Double
static GetSchemaAttributeNames()
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
Return a vector of names of all pre-declared attributes for this
schema class and all its ancestor classes.
Does not include attributes that may be authored by custom/extended
methods of the schemas involved.
Parameters
includeInherited (bool) –
class pxr.UsdGeom.Cone
Defines a primitive cone, centered at the origin, whose spine is along
the specified axis, with the apex of the cone pointing in the
direction of the positive axis.
The fallback values for Cube, Sphere, Cone, and Cylinder are set so
that they all pack into the same volume/bounds.
For any described attribute Fallback Value or Allowed Values
below that are text/tokens, the actual token is published and defined
in UsdGeomTokens. So to set an attribute to the value”rightHanded”,
use UsdGeomTokens->rightHanded as the value.
Methods:
CreateAxisAttr(defaultValue, writeSparsely)
See GetAxisAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateExtentAttr(defaultValue, writeSparsely)
See GetExtentAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateHeightAttr(defaultValue, writeSparsely)
See GetHeightAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateRadiusAttr(defaultValue, writeSparsely)
See GetRadiusAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
Define
classmethod Define(stage, path) -> Cone
Get
classmethod Get(stage, path) -> Cone
GetAxisAttr()
The axis along which the spine of the cone is aligned.
GetExtentAttr()
Extent is re-defined on Cone only to provide a fallback value.
GetHeightAttr()
The size of the cone's spine along the specified axis.
GetRadiusAttr()
The radius of the cone.
GetSchemaAttributeNames
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
CreateAxisAttr(defaultValue, writeSparsely) → Attribute
See GetAxisAttr() , and also Create vs Get Property Methods for when
to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateExtentAttr(defaultValue, writeSparsely) → Attribute
See GetExtentAttr() , and also Create vs Get Property Methods for when
to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateHeightAttr(defaultValue, writeSparsely) → Attribute
See GetHeightAttr() , and also Create vs Get Property Methods for when
to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateRadiusAttr(defaultValue, writeSparsely) → Attribute
See GetRadiusAttr() , and also Create vs Get Property Methods for when
to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
static Define()
classmethod Define(stage, path) -> Cone
Attempt to ensure a UsdPrim adhering to this schema at path is
defined (according to UsdPrim::IsDefined() ) on this stage.
If a prim adhering to this schema at path is already defined on
this stage, return that prim. Otherwise author an SdfPrimSpec with
specifier == SdfSpecifierDef and this schema’s prim type name for
the prim at path at the current EditTarget. Author SdfPrimSpec s
with specifier == SdfSpecifierDef and empty typeName at the
current EditTarget for any nonexistent, or existing but not Defined
ancestors.
The given path must be an absolute prim path that does not contain
any variant selections.
If it is impossible to author any of the necessary PrimSpecs, (for
example, in case path cannot map to the current UsdEditTarget ‘s
namespace) issue an error and return an invalid UsdPrim.
Note that this method may return a defined prim whose typeName does
not specify this schema class, in case a stronger typeName opinion
overrides the opinion at the current EditTarget.
Parameters
stage (Stage) –
path (Path) –
static Get()
classmethod Get(stage, path) -> Cone
Return a UsdGeomCone holding the prim adhering to this schema at
path on stage .
If no prim exists at path on stage , or if the prim at that
path does not adhere to this schema, return an invalid schema object.
This is shorthand for the following:
UsdGeomCone(stage->GetPrimAtPath(path));
Parameters
stage (Stage) –
path (Path) –
GetAxisAttr() → Attribute
The axis along which the spine of the cone is aligned.
Declaration
uniform token axis ="Z"
C++ Type
TfToken
Usd Type
SdfValueTypeNames->Token
Variability
SdfVariabilityUniform
Allowed Values
X, Y, Z
GetExtentAttr() → Attribute
Extent is re-defined on Cone only to provide a fallback value.
UsdGeomGprim::GetExtentAttr() .
Declaration
float3[] extent = [(-1, -1, -1), (1, 1, 1)]
C++ Type
VtArray<GfVec3f>
Usd Type
SdfValueTypeNames->Float3Array
GetHeightAttr() → Attribute
The size of the cone’s spine along the specified axis.
If you author height you must also author extent.
GetExtentAttr()
Declaration
double height = 2
C++ Type
double
Usd Type
SdfValueTypeNames->Double
GetRadiusAttr() → Attribute
The radius of the cone.
If you author radius you must also author extent.
GetExtentAttr()
Declaration
double radius = 1
C++ Type
double
Usd Type
SdfValueTypeNames->Double
static GetSchemaAttributeNames()
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
Return a vector of names of all pre-declared attributes for this
schema class and all its ancestor classes.
Does not include attributes that may be authored by custom/extended
methods of the schemas involved.
Parameters
includeInherited (bool) –
class pxr.UsdGeom.ConstraintTarget
Schema wrapper for UsdAttribute for authoring and introspecting
attributes that are constraint targets.
Constraint targets correspond roughly to what some DCC’s call
locators. They are coordinate frames, represented as (animated or
static) GfMatrix4d values. We represent them as attributes in USD
rather than transformable prims because generally we require no other
coordinated information about a constraint target other than its name
and its matrix value, and because attributes are more concise than
prims.
Because consumer clients often care only about the identity and value
of constraint targets and may be able to usefully consume them without
caring about the actual geometry with which they may logically
correspond, UsdGeom aggregates all constraint targets onto a model’s
root prim, assuming that an exporter will use property namespacing
within the constraint target attribute’s name to indicate a path to a
prim within the model with which the constraint target may correspond.
To facilitate instancing, and also position-tweaking of baked assets,
we stipulate that constraint target values always be recorded in
model-relative transformation space. In other words, to get the
world-space value of a constraint target, transform it by the local-
to-world transformation of the prim on which it is recorded.
ComputeInWorldSpace() will perform this calculation.
Methods:
ComputeInWorldSpace(time, xfCache)
Computes the value of the constraint target in world space.
Get(value, time)
Get the attribute value of the ConstraintTarget at time .
GetAttr()
Explicit UsdAttribute extractor.
GetConstraintAttrName
classmethod GetConstraintAttrName(constraintName) -> str
GetIdentifier()
Get the stored identifier unique to the enclosing model's namespace for this constraint target.
IsDefined()
Return true if the wrapped UsdAttribute::IsDefined() , and in addition the attribute is identified as a ConstraintTarget.
IsValid
classmethod IsValid(attr) -> bool
Set(value, time)
Set the attribute value of the ConstraintTarget at time .
SetIdentifier(identifier)
Explicitly sets the stored identifier to the given string.
ComputeInWorldSpace(time, xfCache) → Matrix4d
Computes the value of the constraint target in world space.
If a valid UsdGeomXformCache is provided in the argument xfCache ,
it is used to evaluate the CTM of the model to which the constraint
target belongs.
To get the constraint value in model-space (or local space), simply
use UsdGeomConstraintTarget::Get() , since the authored values must
already be in model-space.
Parameters
time (TimeCode) –
xfCache (XformCache) –
Get(value, time) → bool
Get the attribute value of the ConstraintTarget at time .
Parameters
value (Matrix4d) –
time (TimeCode) –
GetAttr() → Attribute
Explicit UsdAttribute extractor.
static GetConstraintAttrName()
classmethod GetConstraintAttrName(constraintName) -> str
Returns the fully namespaced constraint attribute name, given the
constraint name.
Parameters
constraintName (str) –
GetIdentifier() → str
Get the stored identifier unique to the enclosing model’s namespace
for this constraint target.
SetIdentifier()
IsDefined() → bool
Return true if the wrapped UsdAttribute::IsDefined() , and in addition
the attribute is identified as a ConstraintTarget.
IsValid()
classmethod IsValid(attr) -> bool
Test whether a given UsdAttribute represents valid ConstraintTarget,
which implies that creating a UsdGeomConstraintTarget from the
attribute will succeed.
Success implies that attr.IsDefined() is true.
Parameters
attr (Attribute) –
Set(value, time) → bool
Set the attribute value of the ConstraintTarget at time .
Parameters
value (Matrix4d) –
time (TimeCode) –
SetIdentifier(identifier) → None
Explicitly sets the stored identifier to the given string.
Clients are responsible for ensuring the uniqueness of this identifier
within the enclosing model’s namespace.
Parameters
identifier (str) –
class pxr.UsdGeom.Cube
Defines a primitive rectilinear cube centered at the origin.
The fallback values for Cube, Sphere, Cone, and Cylinder are set so
that they all pack into the same volume/bounds.
Methods:
CreateExtentAttr(defaultValue, writeSparsely)
See GetExtentAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateSizeAttr(defaultValue, writeSparsely)
See GetSizeAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
Define
classmethod Define(stage, path) -> Cube
Get
classmethod Get(stage, path) -> Cube
GetExtentAttr()
Extent is re-defined on Cube only to provide a fallback value.
GetSchemaAttributeNames
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
GetSizeAttr()
Indicates the length of each edge of the cube.
CreateExtentAttr(defaultValue, writeSparsely) → Attribute
See GetExtentAttr() , and also Create vs Get Property Methods for when
to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateSizeAttr(defaultValue, writeSparsely) → Attribute
See GetSizeAttr() , and also Create vs Get Property Methods for when
to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
static Define()
classmethod Define(stage, path) -> Cube
Attempt to ensure a UsdPrim adhering to this schema at path is
defined (according to UsdPrim::IsDefined() ) on this stage.
If a prim adhering to this schema at path is already defined on
this stage, return that prim. Otherwise author an SdfPrimSpec with
specifier == SdfSpecifierDef and this schema’s prim type name for
the prim at path at the current EditTarget. Author SdfPrimSpec s
with specifier == SdfSpecifierDef and empty typeName at the
current EditTarget for any nonexistent, or existing but not Defined
ancestors.
The given path must be an absolute prim path that does not contain
any variant selections.
If it is impossible to author any of the necessary PrimSpecs, (for
example, in case path cannot map to the current UsdEditTarget ‘s
namespace) issue an error and return an invalid UsdPrim.
Note that this method may return a defined prim whose typeName does
not specify this schema class, in case a stronger typeName opinion
overrides the opinion at the current EditTarget.
Parameters
stage (Stage) –
path (Path) –
static Get()
classmethod Get(stage, path) -> Cube
Return a UsdGeomCube holding the prim adhering to this schema at
path on stage .
If no prim exists at path on stage , or if the prim at that
path does not adhere to this schema, return an invalid schema object.
This is shorthand for the following:
UsdGeomCube(stage->GetPrimAtPath(path));
Parameters
stage (Stage) –
path (Path) –
GetExtentAttr() → Attribute
Extent is re-defined on Cube only to provide a fallback value.
UsdGeomGprim::GetExtentAttr() .
Declaration
float3[] extent = [(-1, -1, -1), (1, 1, 1)]
C++ Type
VtArray<GfVec3f>
Usd Type
SdfValueTypeNames->Float3Array
static GetSchemaAttributeNames()
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
Return a vector of names of all pre-declared attributes for this
schema class and all its ancestor classes.
Does not include attributes that may be authored by custom/extended
methods of the schemas involved.
Parameters
includeInherited (bool) –
GetSizeAttr() → Attribute
Indicates the length of each edge of the cube.
If you author size you must also author extent.
GetExtentAttr()
Declaration
double size = 2
C++ Type
double
Usd Type
SdfValueTypeNames->Double
class pxr.UsdGeom.Curves
Base class for UsdGeomBasisCurves, UsdGeomNurbsCurves, and
UsdGeomHermiteCurves. The BasisCurves schema is designed to be
analagous to offline renderers’notion of batched curves (such as the
classical RIB definition via Basis and Curves statements), while the
NurbsCurve schema is designed to be analgous to the NURBS curves found
in packages like Maya and Houdini while retaining their consistency
with the RenderMan specification for NURBS Patches. HermiteCurves are
useful for the interchange of animation guides and paths.
It is safe to use the length of the curve vertex count to derive the
number of curves and the number and layout of curve vertices, but this
schema should NOT be used to derive the number of curve points. While
vertex indices are implicit in all shipped descendent types of this
schema, one should not assume that all internal or future shipped
schemas will follow this pattern. Be sure to key any indexing behavior
off the concrete type, not this abstract type.
Methods:
ComputeExtent
classmethod ComputeExtent(points, widths, extent) -> bool
CreateCurveVertexCountsAttr(defaultValue, ...)
See GetCurveVertexCountsAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateWidthsAttr(defaultValue, writeSparsely)
See GetWidthsAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
Get
classmethod Get(stage, path) -> Curves
GetCurveCount(timeCode)
Returns the number of curves as defined by the size of the curveVertexCounts array at timeCode.
GetCurveVertexCountsAttr()
Curves-derived primitives can represent multiple distinct, potentially disconnected curves.
GetSchemaAttributeNames
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
GetWidthsAttr()
Provides width specification for the curves, whose application will depend on whether the curve is oriented (normals are defined for it), in which case widths are"ribbon width", or unoriented, in which case widths are cylinder width.
GetWidthsInterpolation()
Get the interpolation for the widths attribute.
SetWidthsInterpolation(interpolation)
Set the interpolation for the widths attribute.
static ComputeExtent()
classmethod ComputeExtent(points, widths, extent) -> bool
Compute the extent for the curves defined by points and widths.
true upon success, false if unable to calculate extent. On success,
extent will contain an approximate axis-aligned bounding box of the
curve defined by points with the given widths.
This function is to provide easy authoring of extent for usd authoring
tools, hence it is static and acts outside a specific prim (as in
attribute based methods).
Parameters
points (Vec3fArray) –
widths (FloatArray) –
extent (Vec3fArray) –
ComputeExtent(points, widths, transform, extent) -> bool
This is an overloaded member function, provided for convenience. It
differs from the above function only in what argument(s) it accepts.
Computes the extent as if the matrix transform was first applied.
Parameters
points (Vec3fArray) –
widths (FloatArray) –
transform (Matrix4d) –
extent (Vec3fArray) –
CreateCurveVertexCountsAttr(defaultValue, writeSparsely) → Attribute
See GetCurveVertexCountsAttr() , and also Create vs Get Property
Methods for when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateWidthsAttr(defaultValue, writeSparsely) → Attribute
See GetWidthsAttr() , and also Create vs Get Property Methods for when
to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
static Get()
classmethod Get(stage, path) -> Curves
Return a UsdGeomCurves holding the prim adhering to this schema at
path on stage .
If no prim exists at path on stage , or if the prim at that
path does not adhere to this schema, return an invalid schema object.
This is shorthand for the following:
UsdGeomCurves(stage->GetPrimAtPath(path));
Parameters
stage (Stage) –
path (Path) –
GetCurveCount(timeCode) → int
Returns the number of curves as defined by the size of the
curveVertexCounts array at timeCode.
For most code, this check will be performant. When using file formats
where the cost of attribute reading is high and the time sampled array
will be read into memory later, it may be better to explicitly read
the value once and check the size of the array directly.
GetCurveVertexCountsAttr()
Parameters
timeCode (TimeCode) –
GetCurveVertexCountsAttr() → Attribute
Curves-derived primitives can represent multiple distinct, potentially
disconnected curves.
The length of’curveVertexCounts’gives the number of such curves, and
each element describes the number of vertices in the corresponding
curve
Declaration
int[] curveVertexCounts
C++ Type
VtArray<int>
Usd Type
SdfValueTypeNames->IntArray
static GetSchemaAttributeNames()
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
Return a vector of names of all pre-declared attributes for this
schema class and all its ancestor classes.
Does not include attributes that may be authored by custom/extended
methods of the schemas involved.
Parameters
includeInherited (bool) –
GetWidthsAttr() → Attribute
Provides width specification for the curves, whose application will
depend on whether the curve is oriented (normals are defined for it),
in which case widths are”ribbon width”, or unoriented, in which case
widths are cylinder width.
‘widths’is not a generic Primvar, but the number of elements in this
attribute will be determined by its’interpolation’. See
SetWidthsInterpolation() . If’widths’and’primvars:widths’are both
specified, the latter has precedence.
Declaration
float[] widths
C++ Type
VtArray<float>
Usd Type
SdfValueTypeNames->FloatArray
GetWidthsInterpolation() → str
Get the interpolation for the widths attribute.
Although’widths’is not classified as a generic UsdGeomPrimvar (and
will not be included in the results of
UsdGeomPrimvarsAPI::GetPrimvars() ) it does require an interpolation
specification. The fallback interpolation, if left unspecified, is
UsdGeomTokens->vertex, which means a width value is specified at the
end of each curve segment.
SetWidthsInterpolation(interpolation) → bool
Set the interpolation for the widths attribute.
true upon success, false if interpolation is not a legal value as
defined by UsdPrimvar::IsValidInterpolation(), or if there was a
problem setting the value. No attempt is made to validate that the
widths attr’s value contains the right number of elements to match its
interpolation to its prim’s topology.
GetWidthsInterpolation()
Parameters
interpolation (str) –
class pxr.UsdGeom.Cylinder
Defines a primitive cylinder with closed ends, centered at the origin,
whose spine is along the specified axis.
The fallback values for Cube, Sphere, Cone, and Cylinder are set so
that they all pack into the same volume/bounds.
For any described attribute Fallback Value or Allowed Values
below that are text/tokens, the actual token is published and defined
in UsdGeomTokens. So to set an attribute to the value”rightHanded”,
use UsdGeomTokens->rightHanded as the value.
Methods:
CreateAxisAttr(defaultValue, writeSparsely)
See GetAxisAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateExtentAttr(defaultValue, writeSparsely)
See GetExtentAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateHeightAttr(defaultValue, writeSparsely)
See GetHeightAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateRadiusAttr(defaultValue, writeSparsely)
See GetRadiusAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
Define
classmethod Define(stage, path) -> Cylinder
Get
classmethod Get(stage, path) -> Cylinder
GetAxisAttr()
The axis along which the spine of the cylinder is aligned.
GetExtentAttr()
Extent is re-defined on Cylinder only to provide a fallback value.
GetHeightAttr()
The size of the cylinder's spine along the specified axis.
GetRadiusAttr()
The radius of the cylinder.
GetSchemaAttributeNames
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
CreateAxisAttr(defaultValue, writeSparsely) → Attribute
See GetAxisAttr() , and also Create vs Get Property Methods for when
to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateExtentAttr(defaultValue, writeSparsely) → Attribute
See GetExtentAttr() , and also Create vs Get Property Methods for when
to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateHeightAttr(defaultValue, writeSparsely) → Attribute
See GetHeightAttr() , and also Create vs Get Property Methods for when
to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateRadiusAttr(defaultValue, writeSparsely) → Attribute
See GetRadiusAttr() , and also Create vs Get Property Methods for when
to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
static Define()
classmethod Define(stage, path) -> Cylinder
Attempt to ensure a UsdPrim adhering to this schema at path is
defined (according to UsdPrim::IsDefined() ) on this stage.
If a prim adhering to this schema at path is already defined on
this stage, return that prim. Otherwise author an SdfPrimSpec with
specifier == SdfSpecifierDef and this schema’s prim type name for
the prim at path at the current EditTarget. Author SdfPrimSpec s
with specifier == SdfSpecifierDef and empty typeName at the
current EditTarget for any nonexistent, or existing but not Defined
ancestors.
The given path must be an absolute prim path that does not contain
any variant selections.
If it is impossible to author any of the necessary PrimSpecs, (for
example, in case path cannot map to the current UsdEditTarget ‘s
namespace) issue an error and return an invalid UsdPrim.
Note that this method may return a defined prim whose typeName does
not specify this schema class, in case a stronger typeName opinion
overrides the opinion at the current EditTarget.
Parameters
stage (Stage) –
path (Path) –
static Get()
classmethod Get(stage, path) -> Cylinder
Return a UsdGeomCylinder holding the prim adhering to this schema at
path on stage .
If no prim exists at path on stage , or if the prim at that
path does not adhere to this schema, return an invalid schema object.
This is shorthand for the following:
UsdGeomCylinder(stage->GetPrimAtPath(path));
Parameters
stage (Stage) –
path (Path) –
GetAxisAttr() → Attribute
The axis along which the spine of the cylinder is aligned.
Declaration
uniform token axis ="Z"
C++ Type
TfToken
Usd Type
SdfValueTypeNames->Token
Variability
SdfVariabilityUniform
Allowed Values
X, Y, Z
GetExtentAttr() → Attribute
Extent is re-defined on Cylinder only to provide a fallback value.
UsdGeomGprim::GetExtentAttr() .
Declaration
float3[] extent = [(-1, -1, -1), (1, 1, 1)]
C++ Type
VtArray<GfVec3f>
Usd Type
SdfValueTypeNames->Float3Array
GetHeightAttr() → Attribute
The size of the cylinder’s spine along the specified axis.
If you author height you must also author extent.
GetExtentAttr()
Declaration
double height = 2
C++ Type
double
Usd Type
SdfValueTypeNames->Double
GetRadiusAttr() → Attribute
The radius of the cylinder.
If you author radius you must also author extent.
GetExtentAttr()
Declaration
double radius = 1
C++ Type
double
Usd Type
SdfValueTypeNames->Double
static GetSchemaAttributeNames()
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
Return a vector of names of all pre-declared attributes for this
schema class and all its ancestor classes.
Does not include attributes that may be authored by custom/extended
methods of the schemas involved.
Parameters
includeInherited (bool) –
class pxr.UsdGeom.Gprim
Base class for all geometric primitives.
Gprim encodes basic graphical properties such as doubleSided and
orientation, and provides primvars for”display
color”and”displayopacity”that travel with geometry to be used as
shader overrides.
For any described attribute Fallback Value or Allowed Values
below that are text/tokens, the actual token is published and defined
in UsdGeomTokens. So to set an attribute to the value”rightHanded”,
use UsdGeomTokens->rightHanded as the value.
Methods:
CreateDisplayColorAttr(defaultValue, ...)
See GetDisplayColorAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateDisplayColorPrimvar(interpolation, ...)
Convenience function to create the displayColor primvar, optionally specifying interpolation and elementSize.
CreateDisplayOpacityAttr(defaultValue, ...)
See GetDisplayOpacityAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateDisplayOpacityPrimvar(interpolation, ...)
Convenience function to create the displayOpacity primvar, optionally specifying interpolation and elementSize.
CreateDoubleSidedAttr(defaultValue, ...)
See GetDoubleSidedAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateOrientationAttr(defaultValue, ...)
See GetOrientationAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
Get
classmethod Get(stage, path) -> Gprim
GetDisplayColorAttr()
It is useful to have an"official"colorSet that can be used as a display or modeling color, even in the absence of any specified shader for a gprim.
GetDisplayColorPrimvar()
Convenience function to get the displayColor Attribute as a Primvar.
GetDisplayOpacityAttr()
Companion to displayColor that specifies opacity, broken out as an independent attribute rather than an rgba color, both so that each can be independently overridden, and because shaders rarely consume rgba parameters.
GetDisplayOpacityPrimvar()
Convenience function to get the displayOpacity Attribute as a Primvar.
GetDoubleSidedAttr()
Although some renderers treat all parametric or polygonal surfaces as if they were effectively laminae with outward-facing normals on both sides, some renderers derive significant optimizations by considering these surfaces to have only a single outward side, typically determined by control-point winding order and/or orientation.
GetOrientationAttr()
Orientation specifies whether the gprim's surface normal should be computed using the right hand rule, or the left hand rule.
GetSchemaAttributeNames
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
CreateDisplayColorAttr(defaultValue, writeSparsely) → Attribute
See GetDisplayColorAttr() , and also Create vs Get Property Methods
for when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateDisplayColorPrimvar(interpolation, elementSize) → Primvar
Convenience function to create the displayColor primvar, optionally
specifying interpolation and elementSize.
CreateDisplayColorAttr() , GetDisplayColorPrimvar()
Parameters
interpolation (str) –
elementSize (int) –
CreateDisplayOpacityAttr(defaultValue, writeSparsely) → Attribute
See GetDisplayOpacityAttr() , and also Create vs Get Property Methods
for when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateDisplayOpacityPrimvar(interpolation, elementSize) → Primvar
Convenience function to create the displayOpacity primvar, optionally
specifying interpolation and elementSize.
CreateDisplayOpacityAttr() , GetDisplayOpacityPrimvar()
Parameters
interpolation (str) –
elementSize (int) –
CreateDoubleSidedAttr(defaultValue, writeSparsely) → Attribute
See GetDoubleSidedAttr() , and also Create vs Get Property Methods for
when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateOrientationAttr(defaultValue, writeSparsely) → Attribute
See GetOrientationAttr() , and also Create vs Get Property Methods for
when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
static Get()
classmethod Get(stage, path) -> Gprim
Return a UsdGeomGprim holding the prim adhering to this schema at
path on stage .
If no prim exists at path on stage , or if the prim at that
path does not adhere to this schema, return an invalid schema object.
This is shorthand for the following:
UsdGeomGprim(stage->GetPrimAtPath(path));
Parameters
stage (Stage) –
path (Path) –
GetDisplayColorAttr() → Attribute
It is useful to have an”official”colorSet that can be used as a
display or modeling color, even in the absence of any specified shader
for a gprim.
DisplayColor serves this role; because it is a UsdGeomPrimvar, it can
also be used as a gprim override for any shader that consumes a
displayColor parameter.
Declaration
color3f[] primvars:displayColor
C++ Type
VtArray<GfVec3f>
Usd Type
SdfValueTypeNames->Color3fArray
GetDisplayColorPrimvar() → Primvar
Convenience function to get the displayColor Attribute as a Primvar.
GetDisplayColorAttr() , CreateDisplayColorPrimvar()
GetDisplayOpacityAttr() → Attribute
Companion to displayColor that specifies opacity, broken out as an
independent attribute rather than an rgba color, both so that each can
be independently overridden, and because shaders rarely consume rgba
parameters.
Declaration
float[] primvars:displayOpacity
C++ Type
VtArray<float>
Usd Type
SdfValueTypeNames->FloatArray
GetDisplayOpacityPrimvar() → Primvar
Convenience function to get the displayOpacity Attribute as a Primvar.
GetDisplayOpacityAttr() , CreateDisplayOpacityPrimvar()
GetDoubleSidedAttr() → Attribute
Although some renderers treat all parametric or polygonal surfaces as
if they were effectively laminae with outward-facing normals on both
sides, some renderers derive significant optimizations by considering
these surfaces to have only a single outward side, typically
determined by control-point winding order and/or orientation.
By doing so they can perform”backface culling”to avoid drawing the
many polygons of most closed surfaces that face away from the viewer.
However, it is often advantageous to model thin objects such as paper
and cloth as single, open surfaces that must be viewable from both
sides, always. Setting a gprim’s doubleSided attribute to true
instructs all renderers to disable optimizations such as backface
culling for the gprim, and attempt (not all renderers are able to do
so, but the USD reference GL renderer always will) to provide forward-
facing normals on each side of the surface for lighting calculations.
Declaration
uniform bool doubleSided = 0
C++ Type
bool
Usd Type
SdfValueTypeNames->Bool
Variability
SdfVariabilityUniform
GetOrientationAttr() → Attribute
Orientation specifies whether the gprim’s surface normal should be
computed using the right hand rule, or the left hand rule.
Please see Coordinate System, Winding Order, Orientation, and Surface
Normals for a deeper explanation and generalization of orientation to
composed scenes with transformation hierarchies.
Declaration
uniform token orientation ="rightHanded"
C++ Type
TfToken
Usd Type
SdfValueTypeNames->Token
Variability
SdfVariabilityUniform
Allowed Values
rightHanded, leftHanded
static GetSchemaAttributeNames()
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
Return a vector of names of all pre-declared attributes for this
schema class and all its ancestor classes.
Does not include attributes that may be authored by custom/extended
methods of the schemas involved.
Parameters
includeInherited (bool) –
class pxr.UsdGeom.HermiteCurves
This schema specifies a cubic hermite interpolated curve batch as
sometimes used for defining guides for animation. While hermite curves
can be useful because they interpolate through their control points,
they are not well supported by high-end renderers for imaging.
Therefore, while we include this schema for interchange, we strongly
recommend the use of UsdGeomBasisCurves as the representation of
curves intended to be rendered (ie. hair or grass). Hermite curves can
be converted to a Bezier representation (though not from Bezier back
to Hermite in general).
## Point Interpolation
The initial cubic curve segment is defined by the first two points and
first two tangents. Additional segments are defined by additional
point / tangent pairs. The number of segments for each non-batched
hermite curve would be len(curve.points) - 1. The total number of
segments for the batched UsdGeomHermiteCurves representation is
len(points) - len(curveVertexCounts).
## Primvar, Width, and Normal Interpolation
Primvar interpolation is not well specified for this type as it is not
intended as a rendering representation. We suggest that per point
primvars would be linearly interpolated across each segment and should
be tagged as’varying’.
It is not immediately clear how to specify cubic
or’vertex’interpolation for this type, as we lack a specification for
primvar tangents. This also means that width and normal interpolation
should be restricted to varying (linear), uniform (per curve element),
or constant (per prim).
Classes:
PointAndTangentArrays
Methods:
CreateTangentsAttr(defaultValue, writeSparsely)
See GetTangentsAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
Define
classmethod Define(stage, path) -> HermiteCurves
Get
classmethod Get(stage, path) -> HermiteCurves
GetSchemaAttributeNames
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
GetTangentsAttr()
Defines the outgoing trajectory tangent for each point.
class PointAndTangentArrays
Methods:
GetPoints
GetTangents
Interleave
IsEmpty
Separate
GetPoints()
GetTangents()
Interleave()
IsEmpty()
static Separate()
CreateTangentsAttr(defaultValue, writeSparsely) → Attribute
See GetTangentsAttr() , and also Create vs Get Property Methods for
when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
static Define()
classmethod Define(stage, path) -> HermiteCurves
Attempt to ensure a UsdPrim adhering to this schema at path is
defined (according to UsdPrim::IsDefined() ) on this stage.
If a prim adhering to this schema at path is already defined on
this stage, return that prim. Otherwise author an SdfPrimSpec with
specifier == SdfSpecifierDef and this schema’s prim type name for
the prim at path at the current EditTarget. Author SdfPrimSpec s
with specifier == SdfSpecifierDef and empty typeName at the
current EditTarget for any nonexistent, or existing but not Defined
ancestors.
The given path must be an absolute prim path that does not contain
any variant selections.
If it is impossible to author any of the necessary PrimSpecs, (for
example, in case path cannot map to the current UsdEditTarget ‘s
namespace) issue an error and return an invalid UsdPrim.
Note that this method may return a defined prim whose typeName does
not specify this schema class, in case a stronger typeName opinion
overrides the opinion at the current EditTarget.
Parameters
stage (Stage) –
path (Path) –
static Get()
classmethod Get(stage, path) -> HermiteCurves
Return a UsdGeomHermiteCurves holding the prim adhering to this schema
at path on stage .
If no prim exists at path on stage , or if the prim at that
path does not adhere to this schema, return an invalid schema object.
This is shorthand for the following:
UsdGeomHermiteCurves(stage->GetPrimAtPath(path));
Parameters
stage (Stage) –
path (Path) –
static GetSchemaAttributeNames()
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
Return a vector of names of all pre-declared attributes for this
schema class and all its ancestor classes.
Does not include attributes that may be authored by custom/extended
methods of the schemas involved.
Parameters
includeInherited (bool) –
GetTangentsAttr() → Attribute
Defines the outgoing trajectory tangent for each point.
Tangents should be the same size as the points attribute.
Declaration
vector3f[] tangents = []
C++ Type
VtArray<GfVec3f>
Usd Type
SdfValueTypeNames->Vector3fArray
class pxr.UsdGeom.Imageable
Base class for all prims that may require rendering or visualization
of some sort. The primary attributes of Imageable are visibility and
purpose, which each provide instructions for what geometry should be
included for processing by rendering and other computations.
Deprecated
Imageable also provides API for accessing primvars, which has been
moved to the UsdGeomPrimvarsAPI schema, because primvars can now be
applied on non-Imageable prim types. This API is planned to be
removed, UsdGeomPrimvarsAPI should be used directly instead.
For any described attribute Fallback Value or Allowed Values
below that are text/tokens, the actual token is published and defined
in UsdGeomTokens. So to set an attribute to the value”rightHanded”,
use UsdGeomTokens->rightHanded as the value.
Classes:
PurposeInfo
Methods:
ComputeEffectiveVisibility(purpose, time)
Calculate the effective purpose visibility of this prim for the given purpose , taking into account opinions for the corresponding purpose attribute, along with overall visibility opinions.
ComputeLocalBound(time, purpose1, purpose2, ...)
Compute the bound of this prim in local space, at the specified time , and for the specified purposes.
ComputeLocalToWorldTransform(time)
Compute the transformation matrix for this prim at the given time, including the transform authored on the Prim itself, if present.
ComputeParentToWorldTransform(time)
Compute the transformation matrix for this prim at the given time, NOT including the transform authored on the prim itself.
ComputeProxyPrim
Returns None if neither this prim nor any of its ancestors has a valid renderProxy prim.
ComputePurpose()
Calculate the effective purpose information about this prim.
ComputePurposeInfo()
Calculate the effective purpose information about this prim which includes final computed purpose value of the prim as well as whether the purpose value should be inherited by namespace children without their own purpose opinions.
ComputeUntransformedBound(time, purpose1, ...)
Compute the untransformed bound of this prim, at the specified time , and for the specified purposes.
ComputeVisibility(time)
Calculate the effective visibility of this prim, as defined by its most ancestral authored"invisible"opinion, if any.
ComputeWorldBound(time, purpose1, purpose2, ...)
Compute the bound of this prim in world space, at the specified time , and for the specified purposes.
CreateProxyPrimRel()
See GetProxyPrimRel() , and also Create vs Get Property Methods for when to use Get vs Create.
CreatePurposeAttr(defaultValue, writeSparsely)
See GetPurposeAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateVisibilityAttr(defaultValue, writeSparsely)
See GetVisibilityAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
Get
classmethod Get(stage, path) -> Imageable
GetOrderedPurposeTokens
classmethod GetOrderedPurposeTokens() -> list[TfToken]
GetProxyPrimRel()
The proxyPrim relationship allows us to link a prim whose purpose is"render"to its (single target) purpose="proxy"prim.
GetPurposeAttr()
Purpose is a classification of geometry into categories that can each be independently included or excluded from traversals of prims on a stage, such as rendering or bounding-box computation traversals.
GetPurposeVisibilityAttr(purpose)
Return the attribute that is used for expressing visibility opinions for the given purpose .
GetSchemaAttributeNames
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
GetVisibilityAttr()
Visibility is meant to be the simplest form of"pruning"visibility that is supported by most DCC apps.
MakeInvisible(time)
Makes the imageable invisible if it is visible at the given time.
MakeVisible(time)
Make the imageable visible if it is invisible at the given time.
SetProxyPrim(proxy)
Convenience function for authoring the renderProxy rel on this prim to target the given proxy prim.
class PurposeInfo
Methods:
GetInheritablePurpose
Attributes:
isInheritable
purpose
GetInheritablePurpose()
property isInheritable
property purpose
ComputeEffectiveVisibility(purpose, time) → str
Calculate the effective purpose visibility of this prim for the given
purpose , taking into account opinions for the corresponding
purpose attribute, along with overall visibility opinions.
If ComputeVisibility() returns”invisible”, then
ComputeEffectiveVisibility() is”invisible”for all purpose values.
Otherwise, ComputeEffectiveVisibility() returns the value of the
nearest ancestral authored opinion for the corresponding purpose
visibility attribute, as retured by GetPurposeVisibilityAttr(purpose).
Note that the value returned here can be”invisible”(indicating the
prim is invisible for the given purpose),”visible”(indicating that
it’s visible), or”inherited”(indicating that the purpose visibility is
context-dependent and the fallback behavior must be determined by the
caller.
This function should be considered a reference implementation for
correctness. If called on each prim in the context of a traversal we
will perform massive overcomputation, because sibling prims share sub-
problems in the query that can be efficiently cached, but are not
(cannot be) by this simple implementation. If you have control of
your traversal, it will be far more efficient to manage visibility on
a stack as you traverse.
UsdGeomVisibilityAPI
GetPurposeVisibilityAttr()
ComputeVisibility()
Parameters
purpose (str) –
time (TimeCode) –
ComputeLocalBound(time, purpose1, purpose2, purpose3, purpose4) → BBox3d
Compute the bound of this prim in local space, at the specified
time , and for the specified purposes.
The bound of the prim is computed, including the transform (if any)
authored on the node itself.
It is an error to not specify any purposes, which will result in the
return of an empty box.
If you need to compute bounds for multiple prims on a stage, it will
be much, much more efficient to instantiate a UsdGeomBBoxCache and
query it directly; doing so will reuse sub-computations shared by the
prims.
Parameters
time (TimeCode) –
purpose1 (str) –
purpose2 (str) –
purpose3 (str) –
purpose4 (str) –
ComputeLocalToWorldTransform(time) → Matrix4d
Compute the transformation matrix for this prim at the given time,
including the transform authored on the Prim itself, if present.
If you need to compute the transform for multiple prims on a stage,
it will be much, much more efficient to instantiate a
UsdGeomXformCache and query it directly; doing so will reuse sub-
computations shared by the prims.
Parameters
time (TimeCode) –
ComputeParentToWorldTransform(time) → Matrix4d
Compute the transformation matrix for this prim at the given time,
NOT including the transform authored on the prim itself.
If you need to compute the transform for multiple prims on a stage,
it will be much, much more efficient to instantiate a
UsdGeomXformCache and query it directly; doing so will reuse sub-
computations shared by the prims.
Parameters
time (TimeCode) –
ComputeProxyPrim()
Returns None if neither this prim nor any of its ancestors has a valid renderProxy prim. Otherwise, returns a tuple of (proxyPrim, renderPrimWithAuthoredProxyPrimRel)
ComputePurpose() → str
Calculate the effective purpose information about this prim.
This is equivalent to extracting the purpose from the value returned
by ComputePurposeInfo() .
This function should be considered a reference implementation for
correctness. If called on each prim in the context of a traversal we
will perform massive overcomputation, because sibling prims share sub-
problems in the query that can be efficiently cached, but are not
(cannot be) by this simple implementation. If you have control of
your traversal, it will be far more efficient to manage purpose, along
with visibility, on a stack as you traverse.
GetPurposeAttr() , Imageable Purpose
ComputePurposeInfo() → PurposeInfo
Calculate the effective purpose information about this prim which
includes final computed purpose value of the prim as well as whether
the purpose value should be inherited by namespace children without
their own purpose opinions.
This function should be considered a reference implementation for
correctness. If called on each prim in the context of a traversal we
will perform massive overcomputation, because sibling prims share sub-
problems in the query that can be efficiently cached, but are not
(cannot be) by this simple implementation. If you have control of
your traversal, it will be far more efficient to manage purpose, along
with visibility, on a stack as you traverse.
GetPurposeAttr() , Imageable Purpose
ComputePurposeInfo(parentPurposeInfo) -> PurposeInfo
This is an overloaded member function, provided for convenience. It
differs from the above function only in what argument(s) it accepts.
Calculates the effective purpose information about this prim, given
the computed purpose information of its parent prim.
This can be much more efficient than using CommputePurposeInfo() when
PurposeInfo values are properly computed and cached for a hierarchy of
prims using this function.
GetPurposeAttr() , Imageable Purpose
Parameters
parentPurposeInfo (PurposeInfo) –
ComputeUntransformedBound(time, purpose1, purpose2, purpose3, purpose4) → BBox3d
Compute the untransformed bound of this prim, at the specified
time , and for the specified purposes.
The bound of the prim is computed in its object space, ignoring any
transforms authored on or above the prim.
It is an error to not specify any purposes, which will result in the
return of an empty box.
If you need to compute bounds for multiple prims on a stage, it will
be much, much more efficient to instantiate a UsdGeomBBoxCache and
query it directly; doing so will reuse sub-computations shared by the
prims.
Parameters
time (TimeCode) –
purpose1 (str) –
purpose2 (str) –
purpose3 (str) –
purpose4 (str) –
ComputeVisibility(time) → str
Calculate the effective visibility of this prim, as defined by its
most ancestral authored”invisible”opinion, if any.
A prim is considered visible at the current time if none of its
Imageable ancestors express an authored”invisible”opinion, which is
what leads to the”simple pruning”behavior described in
GetVisibilityAttr() .
This function should be considered a reference implementation for
correctness. If called on each prim in the context of a traversal we
will perform massive overcomputation, because sibling prims share sub-
problems in the query that can be efficiently cached, but are not
(cannot be) by this simple implementation. If you have control of
your traversal, it will be far more efficient to manage visibility on
a stack as you traverse.
GetVisibilityAttr()
Parameters
time (TimeCode) –
ComputeWorldBound(time, purpose1, purpose2, purpose3, purpose4) → BBox3d
Compute the bound of this prim in world space, at the specified
time , and for the specified purposes.
The bound of the prim is computed, including the transform (if any)
authored on the node itself, and then transformed to world space.
It is an error to not specify any purposes, which will result in the
return of an empty box.
If you need to compute bounds for multiple prims on a stage, it will
be much, much more efficient to instantiate a UsdGeomBBoxCache and
query it directly; doing so will reuse sub-computations shared by the
prims.
Parameters
time (TimeCode) –
purpose1 (str) –
purpose2 (str) –
purpose3 (str) –
purpose4 (str) –
CreateProxyPrimRel() → Relationship
See GetProxyPrimRel() , and also Create vs Get Property Methods for
when to use Get vs Create.
CreatePurposeAttr(defaultValue, writeSparsely) → Attribute
See GetPurposeAttr() , and also Create vs Get Property Methods for
when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateVisibilityAttr(defaultValue, writeSparsely) → Attribute
See GetVisibilityAttr() , and also Create vs Get Property Methods for
when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
static Get()
classmethod Get(stage, path) -> Imageable
Return a UsdGeomImageable holding the prim adhering to this schema at
path on stage .
If no prim exists at path on stage , or if the prim at that
path does not adhere to this schema, return an invalid schema object.
This is shorthand for the following:
UsdGeomImageable(stage->GetPrimAtPath(path));
Parameters
stage (Stage) –
path (Path) –
static GetOrderedPurposeTokens()
classmethod GetOrderedPurposeTokens() -> list[TfToken]
Returns an ordered list of allowed values of the purpose attribute.
The ordering is important because it defines the protocol between
UsdGeomModelAPI and UsdGeomBBoxCache for caching and retrieving
extents hints by purpose.
The order is: [default, render, proxy, guide]
See
UsdGeomModelAPI::GetExtentsHint() .
GetOrderedPurposeTokens()
GetProxyPrimRel() → Relationship
The proxyPrim relationship allows us to link a prim whose purpose
is”render”to its (single target) purpose=”proxy”prim.
This is entirely optional, but can be useful in several scenarios:
In a pipeline that does pruning (for complexity management) by
deactivating prims composed from asset references, when we deactivate
a purpose=”render”prim, we will be able to discover and additionally
deactivate its associated purpose=”proxy”prim, so that preview renders
reflect the pruning accurately.
DCC importers may be able to make more aggressive optimizations
for interactive processing and display if they can discover the proxy
for a given render prim.
With a little more work, a Hydra-based application will be able
to map a picked proxy prim back to its render geometry for selection.
It is only valid to author the proxyPrim relationship on prims whose
purpose is”render”.
GetPurposeAttr() → Attribute
Purpose is a classification of geometry into categories that can each
be independently included or excluded from traversals of prims on a
stage, such as rendering or bounding-box computation traversals.
See Imageable Purpose for more detail about how purpose is computed
and used.
Declaration
uniform token purpose ="default"
C++ Type
TfToken
Usd Type
SdfValueTypeNames->Token
Variability
SdfVariabilityUniform
Allowed Values
default, render, proxy, guide
GetPurposeVisibilityAttr(purpose) → Attribute
Return the attribute that is used for expressing visibility opinions
for the given purpose .
For”default”purpose, return the overall visibility attribute.
For”guide”,”proxy”, or”render”purpose, return guideVisibility,
proxyVisibility, or renderVisibility if UsdGeomVisibilityAPI is
applied to the prim. If UsdGeomvVisibiltyAPI is not applied, an empty
attribute is returned for purposes other than default.
UsdGeomVisibilityAPI::Apply
UsdGeomVisibilityAPI::GetPurposeVisibilityAttr
Parameters
purpose (str) –
static GetSchemaAttributeNames()
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
Return a vector of names of all pre-declared attributes for this
schema class and all its ancestor classes.
Does not include attributes that may be authored by custom/extended
methods of the schemas involved.
Parameters
includeInherited (bool) –
GetVisibilityAttr() → Attribute
Visibility is meant to be the simplest form of”pruning”visibility that
is supported by most DCC apps.
Visibility is animatable, allowing a sub-tree of geometry to be
present for some segment of a shot, and absent from others; unlike the
action of deactivating geometry prims, invisible geometry is still
available for inspection, for positioning, for defining volumes, etc.
Declaration
token visibility ="inherited"
C++ Type
TfToken
Usd Type
SdfValueTypeNames->Token
Allowed Values
inherited, invisible
MakeInvisible(time) → None
Makes the imageable invisible if it is visible at the given time.
When visibility is animated, this only works when it is invoked
sequentially at increasing time samples. If visibility is already
authored and animated in the scene, calling MakeVisible() at an
arbitrary (in-between) frame isn’t guaranteed to work.
Be sure to set the edit target to the layer containing the strongest
visibility opinion or to a stronger layer.
MakeVisible()
ComputeVisibility()
Parameters
time (TimeCode) –
MakeVisible(time) → None
Make the imageable visible if it is invisible at the given time.
Since visibility is pruning, this may need to override some ancestor’s
visibility and all-but-one of the ancestor’s children’s visibility,
for all the ancestors of this prim up to the highest ancestor that is
explicitly invisible, to preserve the visibility state.
If MakeVisible() (or MakeInvisible() ) is going to be applied to all
the prims on a stage, ancestors must be processed prior to descendants
to get the correct behavior.
When visibility is animated, this only works when it is invoked
sequentially at increasing time samples. If visibility is already
authored and animated in the scene, calling MakeVisible() at an
arbitrary (in-between) frame isn’t guaranteed to work.
This will only work properly if all ancestor prims of the imageable
are defined, as the imageable schema is only valid on defined
prims.
Be sure to set the edit target to the layer containing the strongest
visibility opinion or to a stronger layer.
MakeInvisible()
ComputeVisibility()
Parameters
time (TimeCode) –
SetProxyPrim(proxy) → bool
Convenience function for authoring the renderProxy rel on this prim
to target the given proxy prim.
To facilitate authoring on sparse or unloaded stages, we do not
perform any validation of this prim’s purpose or the type or purpose
of the specified prim.
ComputeProxyPrim() , GetProxyPrimRel()
Parameters
proxy (Prim) –
SetProxyPrim(proxy) -> bool
Parameters
proxy (SchemaBase) –
class pxr.UsdGeom.LinearUnits
Attributes:
centimeters
feet
inches
kilometers
lightYears
meters
micrometers
miles
millimeters
nanometers
yards
centimeters = 0.01
feet = 0.3048
inches = 0.0254
kilometers = 1000.0
lightYears = 9460730472580800.0
meters = 1.0
micrometers = 1e-06
miles = 1609.344
millimeters = 0.001
nanometers = 1e-09
yards = 0.9144
class pxr.UsdGeom.Mesh
Encodes a mesh with optional subdivision properties and features.
As a point-based primitive, meshes are defined in terms of points that
are connected into edges and faces. Many references to meshes use the
term’vertex’in place of or interchangeably with’points’, while some
use’vertex’to refer to the’face-vertices’that define a face. To avoid
confusion, the term’vertex’is intentionally avoided in favor
of’points’or’face-vertices’.
The connectivity between points, edges and faces is encoded using a
common minimal topological description of the faces of the mesh. Each
face is defined by a set of face-vertices using indices into the
Mesh’s points array (inherited from UsdGeomPointBased) and laid out
in a single linear faceVertexIndices array for efficiency. A
companion faceVertexCounts array provides, for each face, the number
of consecutive face-vertices in faceVertexIndices that define the
face. No additional connectivity information is required or
constructed, so no adjacency or neighborhood queries are available.
A key property of this mesh schema is that it encodes both subdivision
surfaces and simpler polygonal meshes. This is achieved by varying the
subdivisionScheme attribute, which is set to specify Catmull-Clark
subdivision by default, so polygonal meshes must always be explicitly
declared. The available subdivision schemes and additional subdivision
features encoded in optional attributes conform to the feature set of
OpenSubdiv (
https://graphics.pixar.com/opensubdiv/docs/subdivision_surfaces.html).
A Note About Primvars
The following list clarifies the number of elements for and the
interpolation behavior of the different primvar interpolation types
for meshes:
constant : One element for the entire mesh; no interpolation.
uniform : One element for each face of the mesh; elements are
typically not interpolated but are inherited by other faces derived
from a given face (via subdivision, tessellation, etc.).
varying : One element for each point of the mesh;
interpolation of point data is always linear.
vertex : One element for each point of the mesh;
interpolation of point data is applied according to the
subdivisionScheme attribute.
faceVarying : One element for each of the face-vertices that
define the mesh topology; interpolation of face-vertex data may be
smooth or linear, according to the subdivisionScheme and
faceVaryingLinearInterpolation attributes.
Primvar interpolation types and related utilities are described more
generally in Interpolation of Geometric Primitive Variables.
A Note About Normals
Normals should not be authored on a subdivision mesh, since
subdivision algorithms define their own normals. They should only be
authored for polygonal meshes ( subdivisionScheme =”none”).
The normals attribute inherited from UsdGeomPointBased is not a
generic primvar, but the number of elements in this attribute will be
determined by its interpolation. See
UsdGeomPointBased::GetNormalsInterpolation() . If normals and
primvars:normals are both specified, the latter has precedence. If a
polygonal mesh specifies neither normals nor primvars:normals,
then it should be treated and rendered as faceted, with no attempt to
compute smooth normals.
The normals generated for smooth subdivision schemes, e.g. Catmull-
Clark and Loop, will likewise be smooth, but others, e.g. Bilinear,
may be discontinuous between faces and/or within non-planar irregular
faces.
For any described attribute Fallback Value or Allowed Values
below that are text/tokens, the actual token is published and defined
in UsdGeomTokens. So to set an attribute to the value”rightHanded”,
use UsdGeomTokens->rightHanded as the value.
Methods:
CreateCornerIndicesAttr(defaultValue, ...)
See GetCornerIndicesAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateCornerSharpnessesAttr(defaultValue, ...)
See GetCornerSharpnessesAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateCreaseIndicesAttr(defaultValue, ...)
See GetCreaseIndicesAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateCreaseLengthsAttr(defaultValue, ...)
See GetCreaseLengthsAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateCreaseSharpnessesAttr(defaultValue, ...)
See GetCreaseSharpnessesAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateFaceVaryingLinearInterpolationAttr(...)
See GetFaceVaryingLinearInterpolationAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateFaceVertexCountsAttr(defaultValue, ...)
See GetFaceVertexCountsAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateFaceVertexIndicesAttr(defaultValue, ...)
See GetFaceVertexIndicesAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateHoleIndicesAttr(defaultValue, ...)
See GetHoleIndicesAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateInterpolateBoundaryAttr(defaultValue, ...)
See GetInterpolateBoundaryAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateSubdivisionSchemeAttr(defaultValue, ...)
See GetSubdivisionSchemeAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateTriangleSubdivisionRuleAttr(...)
See GetTriangleSubdivisionRuleAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
Define
classmethod Define(stage, path) -> Mesh
Get
classmethod Get(stage, path) -> Mesh
GetCornerIndicesAttr()
The indices of points for which a corresponding sharpness value is specified in cornerSharpnesses (so the size of this array must match that of cornerSharpnesses).
GetCornerSharpnessesAttr()
The sharpness values associated with a corresponding set of points specified in cornerIndices (so the size of this array must match that of cornerIndices).
GetCreaseIndicesAttr()
The indices of points grouped into sets of successive pairs that identify edges to be creased.
GetCreaseLengthsAttr()
The length of this array specifies the number of creases (sets of adjacent sharpened edges) on the mesh.
GetCreaseSharpnessesAttr()
The per-crease or per-edge sharpness values for all creases.
GetFaceCount(timeCode)
Returns the number of faces as defined by the size of the faceVertexCounts array at timeCode.
GetFaceVaryingLinearInterpolationAttr()
Specifies how elements of a primvar of interpolation type"faceVarying"are interpolated for subdivision surfaces.
GetFaceVertexCountsAttr()
Provides the number of vertices in each face of the mesh, which is also the number of consecutive indices in faceVertexIndices that define the face.
GetFaceVertexIndicesAttr()
Flat list of the index (into the points attribute) of each vertex of each face in the mesh.
GetHoleIndicesAttr()
The indices of all faces that should be treated as holes, i.e.
GetInterpolateBoundaryAttr()
Specifies how subdivision is applied for faces adjacent to boundary edges and boundary points.
GetSchemaAttributeNames
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
GetSubdivisionSchemeAttr()
The subdivision scheme to be applied to the surface.
GetTriangleSubdivisionRuleAttr()
Specifies an option to the subdivision rules for the Catmull-Clark scheme to try and improve undesirable artifacts when subdividing triangles.
ValidateTopology
classmethod ValidateTopology(faceVertexIndices, faceVertexCounts, numPoints, reason) -> bool
Attributes:
SHARPNESS_INFINITE
CreateCornerIndicesAttr(defaultValue, writeSparsely) → Attribute
See GetCornerIndicesAttr() , and also Create vs Get Property Methods
for when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateCornerSharpnessesAttr(defaultValue, writeSparsely) → Attribute
See GetCornerSharpnessesAttr() , and also Create vs Get Property
Methods for when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateCreaseIndicesAttr(defaultValue, writeSparsely) → Attribute
See GetCreaseIndicesAttr() , and also Create vs Get Property Methods
for when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateCreaseLengthsAttr(defaultValue, writeSparsely) → Attribute
See GetCreaseLengthsAttr() , and also Create vs Get Property Methods
for when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateCreaseSharpnessesAttr(defaultValue, writeSparsely) → Attribute
See GetCreaseSharpnessesAttr() , and also Create vs Get Property
Methods for when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateFaceVaryingLinearInterpolationAttr(defaultValue, writeSparsely) → Attribute
See GetFaceVaryingLinearInterpolationAttr() , and also Create vs Get
Property Methods for when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateFaceVertexCountsAttr(defaultValue, writeSparsely) → Attribute
See GetFaceVertexCountsAttr() , and also Create vs Get Property
Methods for when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateFaceVertexIndicesAttr(defaultValue, writeSparsely) → Attribute
See GetFaceVertexIndicesAttr() , and also Create vs Get Property
Methods for when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateHoleIndicesAttr(defaultValue, writeSparsely) → Attribute
See GetHoleIndicesAttr() , and also Create vs Get Property Methods for
when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateInterpolateBoundaryAttr(defaultValue, writeSparsely) → Attribute
See GetInterpolateBoundaryAttr() , and also Create vs Get Property
Methods for when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateSubdivisionSchemeAttr(defaultValue, writeSparsely) → Attribute
See GetSubdivisionSchemeAttr() , and also Create vs Get Property
Methods for when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateTriangleSubdivisionRuleAttr(defaultValue, writeSparsely) → Attribute
See GetTriangleSubdivisionRuleAttr() , and also Create vs Get Property
Methods for when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
static Define()
classmethod Define(stage, path) -> Mesh
Attempt to ensure a UsdPrim adhering to this schema at path is
defined (according to UsdPrim::IsDefined() ) on this stage.
If a prim adhering to this schema at path is already defined on
this stage, return that prim. Otherwise author an SdfPrimSpec with
specifier == SdfSpecifierDef and this schema’s prim type name for
the prim at path at the current EditTarget. Author SdfPrimSpec s
with specifier == SdfSpecifierDef and empty typeName at the
current EditTarget for any nonexistent, or existing but not Defined
ancestors.
The given path must be an absolute prim path that does not contain
any variant selections.
If it is impossible to author any of the necessary PrimSpecs, (for
example, in case path cannot map to the current UsdEditTarget ‘s
namespace) issue an error and return an invalid UsdPrim.
Note that this method may return a defined prim whose typeName does
not specify this schema class, in case a stronger typeName opinion
overrides the opinion at the current EditTarget.
Parameters
stage (Stage) –
path (Path) –
static Get()
classmethod Get(stage, path) -> Mesh
Return a UsdGeomMesh holding the prim adhering to this schema at
path on stage .
If no prim exists at path on stage , or if the prim at that
path does not adhere to this schema, return an invalid schema object.
This is shorthand for the following:
UsdGeomMesh(stage->GetPrimAtPath(path));
Parameters
stage (Stage) –
path (Path) –
GetCornerIndicesAttr() → Attribute
The indices of points for which a corresponding sharpness value is
specified in cornerSharpnesses (so the size of this array must match
that of cornerSharpnesses).
Declaration
int[] cornerIndices = []
C++ Type
VtArray<int>
Usd Type
SdfValueTypeNames->IntArray
GetCornerSharpnessesAttr() → Attribute
The sharpness values associated with a corresponding set of points
specified in cornerIndices (so the size of this array must match
that of cornerIndices).
Use the constant SHARPNESS_INFINITE for a perfectly sharp corner.
Declaration
float[] cornerSharpnesses = []
C++ Type
VtArray<float>
Usd Type
SdfValueTypeNames->FloatArray
GetCreaseIndicesAttr() → Attribute
The indices of points grouped into sets of successive pairs that
identify edges to be creased.
The size of this array must be equal to the sum of all elements of the
creaseLengths attribute.
Declaration
int[] creaseIndices = []
C++ Type
VtArray<int>
Usd Type
SdfValueTypeNames->IntArray
GetCreaseLengthsAttr() → Attribute
The length of this array specifies the number of creases (sets of
adjacent sharpened edges) on the mesh.
Each element gives the number of points of each crease, whose indices
are successively laid out in the creaseIndices attribute. Since each
crease must be at least one edge long, each element of this array must
be at least two.
Declaration
int[] creaseLengths = []
C++ Type
VtArray<int>
Usd Type
SdfValueTypeNames->IntArray
GetCreaseSharpnessesAttr() → Attribute
The per-crease or per-edge sharpness values for all creases.
Since creaseLengths encodes the number of points in each crease, the
number of elements in this array will be either len(creaseLengths) or
the sum over all X of (creaseLengths[X] - 1). Note that while the RI
spec allows each crease to have either a single sharpness or a value
per-edge, USD will encode either a single sharpness per crease on a
mesh, or sharpnesses for all edges making up the creases on a mesh.
Use the constant SHARPNESS_INFINITE for a perfectly sharp crease.
Declaration
float[] creaseSharpnesses = []
C++ Type
VtArray<float>
Usd Type
SdfValueTypeNames->FloatArray
GetFaceCount(timeCode) → int
Returns the number of faces as defined by the size of the
faceVertexCounts array at timeCode.
For most code, this check will be performant. When using file formats
where the cost of attribute reading is high and the time sampled array
will be read into memory later, it may be better to explicitly read
the value once and check the size of the array directly.
GetFaceVertexCountsAttr()
Parameters
timeCode (TimeCode) –
GetFaceVaryingLinearInterpolationAttr() → Attribute
Specifies how elements of a primvar of interpolation
type”faceVarying”are interpolated for subdivision surfaces.
Interpolation can be as smooth as a”vertex”primvar or constrained to
be linear at features specified by several options. Valid values
correspond to choices available in OpenSubdiv:
none : No linear constraints or sharpening, smooth everywhere
cornersOnly : Sharpen corners of discontinuous boundaries
only, smooth everywhere else
cornersPlus1 : The default, same as”cornersOnly”plus
additional sharpening at points where three or more distinct face-
varying values occur
cornersPlus2 : Same as”cornersPlus1”plus additional
sharpening at points with at least one discontinuous boundary corner
or only one discontinuous boundary edge (a dart)
boundaries : Piecewise linear along discontinuous boundaries,
smooth interior
all : Piecewise linear everywhere
These are illustrated and described in more detail in the OpenSubdiv
documentation:
https://graphics.pixar.com/opensubdiv/docs/subdivision_surfaces.html#face-
varying-interpolation-rules
Declaration
token faceVaryingLinearInterpolation ="cornersPlus1"
C++ Type
TfToken
Usd Type
SdfValueTypeNames->Token
Allowed Values
none, cornersOnly, cornersPlus1, cornersPlus2, boundaries, all
GetFaceVertexCountsAttr() → Attribute
Provides the number of vertices in each face of the mesh, which is
also the number of consecutive indices in faceVertexIndices that
define the face.
The length of this attribute is the number of faces in the mesh. If
this attribute has more than one timeSample, the mesh is considered to
be topologically varying.
Declaration
int[] faceVertexCounts
C++ Type
VtArray<int>
Usd Type
SdfValueTypeNames->IntArray
GetFaceVertexIndicesAttr() → Attribute
Flat list of the index (into the points attribute) of each vertex of
each face in the mesh.
If this attribute has more than one timeSample, the mesh is considered
to be topologically varying.
Declaration
int[] faceVertexIndices
C++ Type
VtArray<int>
Usd Type
SdfValueTypeNames->IntArray
GetHoleIndicesAttr() → Attribute
The indices of all faces that should be treated as holes, i.e.
made invisible. This is traditionally a feature of subdivision
surfaces and not generally applied to polygonal meshes.
Declaration
int[] holeIndices = []
C++ Type
VtArray<int>
Usd Type
SdfValueTypeNames->IntArray
GetInterpolateBoundaryAttr() → Attribute
Specifies how subdivision is applied for faces adjacent to boundary
edges and boundary points.
Valid values correspond to choices available in OpenSubdiv:
none : No boundary interpolation is applied and boundary
faces are effectively treated as holes
edgeOnly : A sequence of boundary edges defines a smooth
curve to which the edges of subdivided boundary faces converge
edgeAndCorner : The default, similar to”edgeOnly”but the
smooth boundary curve is made sharp at corner points
These are illustrated and described in more detail in the OpenSubdiv
documentation:
https://graphics.pixar.com/opensubdiv/docs/subdivision_surfaces.html#boundary-
interpolation-rules
Declaration
token interpolateBoundary ="edgeAndCorner"
C++ Type
TfToken
Usd Type
SdfValueTypeNames->Token
Allowed Values
none, edgeOnly, edgeAndCorner
static GetSchemaAttributeNames()
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
Return a vector of names of all pre-declared attributes for this
schema class and all its ancestor classes.
Does not include attributes that may be authored by custom/extended
methods of the schemas involved.
Parameters
includeInherited (bool) –
GetSubdivisionSchemeAttr() → Attribute
The subdivision scheme to be applied to the surface.
Valid values are:
catmullClark : The default, Catmull-Clark subdivision;
preferred for quad-dominant meshes (generalizes B-splines);
interpolation of point data is smooth (non-linear)
loop : Loop subdivision; preferred for purely triangular
meshes; interpolation of point data is smooth (non-linear)
bilinear : Subdivision reduces all faces to quads
(topologically similar to”catmullClark”); interpolation of point data
is bilinear
none : No subdivision, i.e. a simple polygonal mesh;
interpolation of point data is linear
Polygonal meshes are typically lighter weight and faster to render,
depending on renderer and render mode. Use of”bilinear”will produce a
similar shape to a polygonal mesh and may offer additional guarantees
of watertightness and additional subdivision features (e.g. holes) but
may also not respect authored normals.
Declaration
uniform token subdivisionScheme ="catmullClark"
C++ Type
TfToken
Usd Type
SdfValueTypeNames->Token
Variability
SdfVariabilityUniform
Allowed Values
catmullClark, loop, bilinear, none
GetTriangleSubdivisionRuleAttr() → Attribute
Specifies an option to the subdivision rules for the Catmull-Clark
scheme to try and improve undesirable artifacts when subdividing
triangles.
Valid values are”catmullClark”for the standard rules (the default)
and”smooth”for the improvement.
See
https://graphics.pixar.com/opensubdiv/docs/subdivision_surfaces.html#triangle-
subdivision-rule
Declaration
token triangleSubdivisionRule ="catmullClark"
C++ Type
TfToken
Usd Type
SdfValueTypeNames->Token
Allowed Values
catmullClark, smooth
static ValidateTopology()
classmethod ValidateTopology(faceVertexIndices, faceVertexCounts, numPoints, reason) -> bool
Validate the topology of a mesh.
This validates that the sum of faceVertexCounts is equal to the
size of the faceVertexIndices array, and that all face vertex
indices in the faceVertexIndices array are in the range [0,
numPoints). Returns true if the topology is valid, or false otherwise.
If the topology is invalid and reason is non-null, an error
message describing the validation error will be set.
Parameters
faceVertexIndices (IntArray) –
faceVertexCounts (IntArray) –
numPoints (int) –
reason (str) –
SHARPNESS_INFINITE = 10.0
class pxr.UsdGeom.ModelAPI
UsdGeomModelAPI extends the generic UsdModelAPI schema with geometry
specific concepts such as cached extents for the entire model,
constraint targets, and geometry-inspired extensions to the payload
lofting process.
As described in GetExtentsHint() below, it is useful to cache extents
at the model level. UsdGeomModelAPI provides schema for computing and
storing these cached extents, which can be consumed by
UsdGeomBBoxCache to provide fast access to precomputed extents that
will be used as the model’s bounds ( see
UsdGeomBBoxCache::UsdGeomBBoxCache() ).
## Draw Modes
Draw modes provide optional alternate imaging behavior for USD
subtrees with kind model. model:drawMode (which is inheritable) and
model:applyDrawMode (which is not) are resolved into a decision to
stop traversing the scene graph at a certain point, and replace a USD
subtree with proxy geometry.
The value of model:drawMode determines the type of proxy geometry:
origin - Draw the model-space basis vectors of the replaced
prim.
bounds - Draw the model-space bounding box of the replaced
prim.
cards - Draw textured quads as a placeholder for the replaced
prim.
default - An explicit opinion to draw the USD subtree as
normal.
inherited - Defer to the parent opinion.
model:drawMode falls back to inherited so that a whole scene, a
large group, or all prototypes of a model hierarchy PointInstancer can
be assigned a draw mode with a single attribute edit. If no draw mode
is explicitly set in a hierarchy, the resolved value is default.
model:applyDrawMode is meant to be written when an asset is
authored, and provides flexibility for different asset types. For
example, a character assembly (composed of character, clothes, etc)
might have model:applyDrawMode set at the top of the subtree so the
whole group can be drawn as a single card object. An effects subtree
might have model:applyDrawMode set at a lower level so each particle
group draws individually.
Models of kind component are treated as if model:applyDrawMode were
true. This means a prim is drawn with proxy geometry when: the prim
has kind component, and/or model:applyDrawMode is set; and the
prim’s resolved value for model:drawMode is not default.
## Cards Geometry
The specific geometry used in cards mode is controlled by the
model:cardGeometry attribute:
cross - Generate a quad normal to each basis direction and
negative. Locate each quad so that it bisects the model extents.
box - Generate a quad normal to each basis direction and
negative. Locate each quad on a face of the model extents, facing out.
fromTexture - Generate a quad for each supplied texture from
attributes stored in that texture’s metadata.
For cross and box mode, the extents are calculated for purposes
default, proxy, and render, at their earliest authored time. If
the model has no textures, all six card faces are rendered using
model:drawModeColor. If one or more textures are present, only axes
with one or more textures assigned are drawn. For each axis, if both
textures (positive and negative) are specified, they’ll be used on the
corresponding card faces; if only one texture is specified, it will be
mapped to the opposite card face after being flipped on the texture’s
s-axis. Any card faces with invalid asset paths will be drawn with
model:drawModeColor.
Both model:cardGeometry and model:drawModeColor should be authored
on the prim where the draw mode takes effect, since these attributes
are not inherited.
For fromTexture mode, only card faces with valid textures assigned
are drawn. The geometry is generated by pulling the worldtoscreen
attribute out of texture metadata. This is expected to be a 4x4 matrix
mapping the model-space position of the card quad to the clip-space
quad with corners (-1,-1,0) and (1,1,0). The card vertices are
generated by transforming the clip-space corners by the inverse of
worldtoscreen. Textures are mapped so that (s) and (t) map to (+x)
and (+y) in clip space. If the metadata cannot be read in the right
format, or the matrix can’t be inverted, the card face is not drawn.
All card faces are drawn and textured as single-sided.
For any described attribute Fallback Value or Allowed Values
below that are text/tokens, the actual token is published and defined
in UsdGeomTokens. So to set an attribute to the value”rightHanded”,
use UsdGeomTokens->rightHanded as the value.
Methods:
Apply
classmethod Apply(prim) -> ModelAPI
CanApply
classmethod CanApply(prim, whyNot) -> bool
ComputeExtentsHint(bboxCache)
For the given model, compute the value for the extents hint with the given bboxCache .
ComputeModelDrawMode(parentDrawMode)
Calculate the effective model:drawMode of this prim.
CreateConstraintTarget(constraintName)
Creates a new constraint target with the given name, constraintName .
CreateModelApplyDrawModeAttr(defaultValue, ...)
See GetModelApplyDrawModeAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateModelCardGeometryAttr(defaultValue, ...)
See GetModelCardGeometryAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateModelCardTextureXNegAttr(defaultValue, ...)
See GetModelCardTextureXNegAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateModelCardTextureXPosAttr(defaultValue, ...)
See GetModelCardTextureXPosAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateModelCardTextureYNegAttr(defaultValue, ...)
See GetModelCardTextureYNegAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateModelCardTextureYPosAttr(defaultValue, ...)
See GetModelCardTextureYPosAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateModelCardTextureZNegAttr(defaultValue, ...)
See GetModelCardTextureZNegAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateModelCardTextureZPosAttr(defaultValue, ...)
See GetModelCardTextureZPosAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateModelDrawModeAttr(defaultValue, ...)
See GetModelDrawModeAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateModelDrawModeColorAttr(defaultValue, ...)
See GetModelDrawModeColorAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
Get
classmethod Get(stage, path) -> ModelAPI
GetConstraintTarget(constraintName)
Get the constraint target with the given name, constraintName .
GetConstraintTargets()
Returns all the constraint targets belonging to the model.
GetExtentsHint(extents, time)
Retrieve the authored value (if any) of this model's"extentsHint".
GetExtentsHintAttr()
Returns the custom'extentsHint'attribute if it exits.
GetModelApplyDrawModeAttr()
If true, and the resolved value of model:drawMode is non-default, apply an alternate imaging mode to this prim.
GetModelCardGeometryAttr()
The geometry to generate for imaging prims inserted for cards imaging mode.
GetModelCardTextureXNegAttr()
In cards imaging mode, the texture applied to the X- quad.
GetModelCardTextureXPosAttr()
In cards imaging mode, the texture applied to the X+ quad.
GetModelCardTextureYNegAttr()
In cards imaging mode, the texture applied to the Y- quad.
GetModelCardTextureYPosAttr()
In cards imaging mode, the texture applied to the Y+ quad.
GetModelCardTextureZNegAttr()
In cards imaging mode, the texture applied to the Z- quad.
GetModelCardTextureZPosAttr()
In cards imaging mode, the texture applied to the Z+ quad.
GetModelDrawModeAttr()
Alternate imaging mode; applied to this prim or child prims where model:applyDrawMode is true, or where the prim has kind component.
GetModelDrawModeColorAttr()
The base color of imaging prims inserted for alternate imaging modes.
GetSchemaAttributeNames
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
SetExtentsHint(extents, time)
Authors the extentsHint array for this model at the given time.
static Apply()
classmethod Apply(prim) -> ModelAPI
Applies this single-apply API schema to the given prim .
This information is stored by adding”GeomModelAPI”to the token-valued,
listOp metadata apiSchemas on the prim.
A valid UsdGeomModelAPI object is returned upon success. An invalid
(or empty) UsdGeomModelAPI object is returned upon failure. See
UsdPrim::ApplyAPI() for conditions resulting in failure.
UsdPrim::GetAppliedSchemas()
UsdPrim::HasAPI()
UsdPrim::CanApplyAPI()
UsdPrim::ApplyAPI()
UsdPrim::RemoveAPI()
Parameters
prim (Prim) –
static CanApply()
classmethod CanApply(prim, whyNot) -> bool
Returns true if this single-apply API schema can be applied to the
given prim .
If this schema can not be a applied to the prim, this returns false
and, if provided, populates whyNot with the reason it can not be
applied.
Note that if CanApply returns false, that does not necessarily imply
that calling Apply will fail. Callers are expected to call CanApply
before calling Apply if they want to ensure that it is valid to apply
a schema.
UsdPrim::GetAppliedSchemas()
UsdPrim::HasAPI()
UsdPrim::CanApplyAPI()
UsdPrim::ApplyAPI()
UsdPrim::RemoveAPI()
Parameters
prim (Prim) –
whyNot (str) –
ComputeExtentsHint(bboxCache) → Vec3fArray
For the given model, compute the value for the extents hint with the
given bboxCache .
bboxCache should be setup with the appropriate time. After calling
this function, the bboxCache may have it’s included purposes
changed.
bboxCache should not be in use by any other thread while this
method is using it in a thread.
Parameters
bboxCache (BBoxCache) –
ComputeModelDrawMode(parentDrawMode) → str
Calculate the effective model:drawMode of this prim.
If the draw mode is authored on this prim, it’s used. Otherwise, the
fallback value is”inherited”, which defers to the parent opinion. The
first non-inherited opinion found walking from this prim towards the
root is used. If the attribute isn’t set on any ancestors, we
return”default”(meaning, disable”drawMode”geometry).
If this function is being called in a traversal context to compute the
draw mode of an entire hierarchy of prims, it would be beneficial to
cache and pass in the computed parent draw-mode via the
parentDrawMode parameter. This avoids repeated upward traversal to
look for ancestor opinions.
When parentDrawMode is empty (or unspecified), this function does
an upward traversal to find the closest ancestor with an authored
model:drawMode.
GetModelDrawModeAttr()
Parameters
parentDrawMode (str) –
CreateConstraintTarget(constraintName) → ConstraintTarget
Creates a new constraint target with the given name,
constraintName .
If the constraint target already exists, then the existing target is
returned. If it does not exist, a new one is created and returned.
Parameters
constraintName (str) –
CreateModelApplyDrawModeAttr(defaultValue, writeSparsely) → Attribute
See GetModelApplyDrawModeAttr() , and also Create vs Get Property
Methods for when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateModelCardGeometryAttr(defaultValue, writeSparsely) → Attribute
See GetModelCardGeometryAttr() , and also Create vs Get Property
Methods for when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateModelCardTextureXNegAttr(defaultValue, writeSparsely) → Attribute
See GetModelCardTextureXNegAttr() , and also Create vs Get Property
Methods for when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateModelCardTextureXPosAttr(defaultValue, writeSparsely) → Attribute
See GetModelCardTextureXPosAttr() , and also Create vs Get Property
Methods for when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateModelCardTextureYNegAttr(defaultValue, writeSparsely) → Attribute
See GetModelCardTextureYNegAttr() , and also Create vs Get Property
Methods for when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateModelCardTextureYPosAttr(defaultValue, writeSparsely) → Attribute
See GetModelCardTextureYPosAttr() , and also Create vs Get Property
Methods for when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateModelCardTextureZNegAttr(defaultValue, writeSparsely) → Attribute
See GetModelCardTextureZNegAttr() , and also Create vs Get Property
Methods for when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateModelCardTextureZPosAttr(defaultValue, writeSparsely) → Attribute
See GetModelCardTextureZPosAttr() , and also Create vs Get Property
Methods for when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateModelDrawModeAttr(defaultValue, writeSparsely) → Attribute
See GetModelDrawModeAttr() , and also Create vs Get Property Methods
for when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateModelDrawModeColorAttr(defaultValue, writeSparsely) → Attribute
See GetModelDrawModeColorAttr() , and also Create vs Get Property
Methods for when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
static Get()
classmethod Get(stage, path) -> ModelAPI
Return a UsdGeomModelAPI holding the prim adhering to this schema at
path on stage .
If no prim exists at path on stage , or if the prim at that
path does not adhere to this schema, return an invalid schema object.
This is shorthand for the following:
UsdGeomModelAPI(stage->GetPrimAtPath(path));
Parameters
stage (Stage) –
path (Path) –
GetConstraintTarget(constraintName) → ConstraintTarget
Get the constraint target with the given name, constraintName .
If the requested constraint target does not exist, then an invalid
UsdConstraintTarget object is returned.
Parameters
constraintName (str) –
GetConstraintTargets() → list[ConstraintTarget]
Returns all the constraint targets belonging to the model.
Only valid constraint targets in the”constraintTargets”namespace are
returned by this method.
GetExtentsHint(extents, time) → bool
Retrieve the authored value (if any) of this model’s”extentsHint”.
Persistent caching of bounds in USD is a potentially perilous
endeavor, given that:
It is very easy to add overrides in new super-layers that
invalidate the cached bounds, and no practical way to automatically
detect when this happens
It is possible for references to be allowed to”float”, so that
asset updates can flow directly into cached scenes. Such changes in
referenced scene description can also invalidate cached bounds in
referencing layers.
For these reasons, as a general rule, we only persistently cache leaf
gprim extents in object space. However, even with cached gprim
extents, computing bounds can be expensive. Since model-level bounds
are so useful to many graphics applications, we make an exception,
with some caveats. The”extentsHint”should be considered entirely
optional (whereas gprim extent is not); if authored, it should
contains the extents for various values of gprim purposes. The extents
for different values of purpose are stored in a linear Vec3f array as
pairs of GfVec3f values in the order specified by
UsdGeomImageable::GetOrderedPurposeTokens() . This list is trimmed to
only include non-empty extents. i.e., if a model has only default and
render geoms, then it will only have 4 GfVec3f values in its
extentsHint array. We do not skip over zero extents, so if a model has
only default and proxy geom, we will author six GfVec3f ‘s, the middle
two representing an zero extent for render geometry.
A UsdGeomBBoxCache can be configured to first consult the cached
extents when evaluating model roots, rather than descending into the
models for the full computation. This is not the default behavior, and
gives us a convenient way to validate that the cached extentsHint is
still valid.
true if a value was fetched; false if no value was authored,
or on error. It is an error to make this query of a prim that is not a
model root.
UsdGeomImageable::GetPurposeAttr() ,
UsdGeomImageable::GetOrderedPurposeTokens()
Parameters
extents (Vec3fArray) –
time (TimeCode) –
GetExtentsHintAttr() → Attribute
Returns the custom’extentsHint’attribute if it exits.
GetModelApplyDrawModeAttr() → Attribute
If true, and the resolved value of model:drawMode is non-default,
apply an alternate imaging mode to this prim.
See Draw Modes.
Declaration
uniform bool model:applyDrawMode = 0
C++ Type
bool
Usd Type
SdfValueTypeNames->Bool
Variability
SdfVariabilityUniform
GetModelCardGeometryAttr() → Attribute
The geometry to generate for imaging prims inserted for cards
imaging mode.
See Cards Geometry for geometry descriptions.
Declaration
uniform token model:cardGeometry ="cross"
C++ Type
TfToken
Usd Type
SdfValueTypeNames->Token
Variability
SdfVariabilityUniform
Allowed Values
cross, box, fromTexture
GetModelCardTextureXNegAttr() → Attribute
In cards imaging mode, the texture applied to the X- quad.
The texture axes (s,t) are mapped to model-space axes (y, -z).
Declaration
asset model:cardTextureXNeg
C++ Type
SdfAssetPath
Usd Type
SdfValueTypeNames->Asset
GetModelCardTextureXPosAttr() → Attribute
In cards imaging mode, the texture applied to the X+ quad.
The texture axes (s,t) are mapped to model-space axes (-y, -z).
Declaration
asset model:cardTextureXPos
C++ Type
SdfAssetPath
Usd Type
SdfValueTypeNames->Asset
GetModelCardTextureYNegAttr() → Attribute
In cards imaging mode, the texture applied to the Y- quad.
The texture axes (s,t) are mapped to model-space axes (-x, -z).
Declaration
asset model:cardTextureYNeg
C++ Type
SdfAssetPath
Usd Type
SdfValueTypeNames->Asset
GetModelCardTextureYPosAttr() → Attribute
In cards imaging mode, the texture applied to the Y+ quad.
The texture axes (s,t) are mapped to model-space axes (x, -z).
Declaration
asset model:cardTextureYPos
C++ Type
SdfAssetPath
Usd Type
SdfValueTypeNames->Asset
GetModelCardTextureZNegAttr() → Attribute
In cards imaging mode, the texture applied to the Z- quad.
The texture axes (s,t) are mapped to model-space axes (-x, -y).
Declaration
asset model:cardTextureZNeg
C++ Type
SdfAssetPath
Usd Type
SdfValueTypeNames->Asset
GetModelCardTextureZPosAttr() → Attribute
In cards imaging mode, the texture applied to the Z+ quad.
The texture axes (s,t) are mapped to model-space axes (x, -y).
Declaration
asset model:cardTextureZPos
C++ Type
SdfAssetPath
Usd Type
SdfValueTypeNames->Asset
GetModelDrawModeAttr() → Attribute
Alternate imaging mode; applied to this prim or child prims where
model:applyDrawMode is true, or where the prim has kind component.
See Draw Modes for mode descriptions.
Declaration
uniform token model:drawMode ="inherited"
C++ Type
TfToken
Usd Type
SdfValueTypeNames->Token
Variability
SdfVariabilityUniform
Allowed Values
origin, bounds, cards, default, inherited
GetModelDrawModeColorAttr() → Attribute
The base color of imaging prims inserted for alternate imaging modes.
For origin and bounds modes, this controls line color; for cards
mode, this controls the fallback quad color.
Declaration
uniform float3 model:drawModeColor = (0.18, 0.18, 0.18)
C++ Type
GfVec3f
Usd Type
SdfValueTypeNames->Float3
Variability
SdfVariabilityUniform
static GetSchemaAttributeNames()
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
Return a vector of names of all pre-declared attributes for this
schema class and all its ancestor classes.
Does not include attributes that may be authored by custom/extended
methods of the schemas involved.
Parameters
includeInherited (bool) –
SetExtentsHint(extents, time) → bool
Authors the extentsHint array for this model at the given time.
GetExtentsHint()
Parameters
extents (Vec3fArray) –
time (TimeCode) –
class pxr.UsdGeom.MotionAPI
UsdGeomMotionAPI encodes data that can live on any prim that may
affect computations involving:
computed motion for motion blur
sampling for motion blur
The motion:blurScale attribute allows artists to scale the amount
of motion blur to be rendered for parts of the scene without changing
the recorded animation. See Effectively Applying motion:blurScale for
use and implementation details.
Methods:
Apply
classmethod Apply(prim) -> MotionAPI
CanApply
classmethod CanApply(prim, whyNot) -> bool
ComputeMotionBlurScale(time)
Compute the inherited value of motion:blurScale at time , i.e.
ComputeNonlinearSampleCount(time)
Compute the inherited value of nonlinearSampleCount at time , i.e.
ComputeVelocityScale(time)
Deprecated
CreateMotionBlurScaleAttr(defaultValue, ...)
See GetMotionBlurScaleAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateNonlinearSampleCountAttr(defaultValue, ...)
See GetNonlinearSampleCountAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateVelocityScaleAttr(defaultValue, ...)
See GetVelocityScaleAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
Get
classmethod Get(stage, path) -> MotionAPI
GetMotionBlurScaleAttr()
BlurScale is an inherited float attribute that stipulates the rendered motion blur (as typically specified via UsdGeomCamera 's shutter:open and shutter:close properties) should be scaled for all objects at and beneath the prim in namespace on which the motion:blurScale value is specified.
GetNonlinearSampleCountAttr()
Determines the number of position or transformation samples created when motion is described by attributes contributing non-linear terms.
GetSchemaAttributeNames
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
GetVelocityScaleAttr()
Deprecated
static Apply()
classmethod Apply(prim) -> MotionAPI
Applies this single-apply API schema to the given prim .
This information is stored by adding”MotionAPI”to the token-valued,
listOp metadata apiSchemas on the prim.
A valid UsdGeomMotionAPI object is returned upon success. An invalid
(or empty) UsdGeomMotionAPI object is returned upon failure. See
UsdPrim::ApplyAPI() for conditions resulting in failure.
UsdPrim::GetAppliedSchemas()
UsdPrim::HasAPI()
UsdPrim::CanApplyAPI()
UsdPrim::ApplyAPI()
UsdPrim::RemoveAPI()
Parameters
prim (Prim) –
static CanApply()
classmethod CanApply(prim, whyNot) -> bool
Returns true if this single-apply API schema can be applied to the
given prim .
If this schema can not be a applied to the prim, this returns false
and, if provided, populates whyNot with the reason it can not be
applied.
Note that if CanApply returns false, that does not necessarily imply
that calling Apply will fail. Callers are expected to call CanApply
before calling Apply if they want to ensure that it is valid to apply
a schema.
UsdPrim::GetAppliedSchemas()
UsdPrim::HasAPI()
UsdPrim::CanApplyAPI()
UsdPrim::ApplyAPI()
UsdPrim::RemoveAPI()
Parameters
prim (Prim) –
whyNot (str) –
ComputeMotionBlurScale(time) → float
Compute the inherited value of motion:blurScale at time , i.e.
the authored value on the prim closest to this prim in namespace,
resolved upwards through its ancestors in namespace.
the inherited value, or 1.0 if neither the prim nor any of its
ancestors possesses an authored value.
this is a reference implementation that is not particularly efficient
if evaluating over many prims, because it does not share inherited
results.
Parameters
time (TimeCode) –
ComputeNonlinearSampleCount(time) → int
Compute the inherited value of nonlinearSampleCount at time ,
i.e.
the authored value on the prim closest to this prim in namespace,
resolved upwards through its ancestors in namespace.
the inherited value, or 3 if neither the prim nor any of its ancestors
possesses an authored value.
this is a reference implementation that is not particularly efficient
if evaluating over many prims, because it does not share inherited
results.
Parameters
time (TimeCode) –
ComputeVelocityScale(time) → float
Deprecated
Compute the inherited value of velocityScale at time , i.e. the
authored value on the prim closest to this prim in namespace, resolved
upwards through its ancestors in namespace.
the inherited value, or 1.0 if neither the prim nor any of its
ancestors possesses an authored value.
this is a reference implementation that is not particularly efficient
if evaluating over many prims, because it does not share inherited
results.
Parameters
time (TimeCode) –
CreateMotionBlurScaleAttr(defaultValue, writeSparsely) → Attribute
See GetMotionBlurScaleAttr() , and also Create vs Get Property Methods
for when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateNonlinearSampleCountAttr(defaultValue, writeSparsely) → Attribute
See GetNonlinearSampleCountAttr() , and also Create vs Get Property
Methods for when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateVelocityScaleAttr(defaultValue, writeSparsely) → Attribute
See GetVelocityScaleAttr() , and also Create vs Get Property Methods
for when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
static Get()
classmethod Get(stage, path) -> MotionAPI
Return a UsdGeomMotionAPI holding the prim adhering to this schema at
path on stage .
If no prim exists at path on stage , or if the prim at that
path does not adhere to this schema, return an invalid schema object.
This is shorthand for the following:
UsdGeomMotionAPI(stage->GetPrimAtPath(path));
Parameters
stage (Stage) –
path (Path) –
GetMotionBlurScaleAttr() → Attribute
BlurScale is an inherited float attribute that stipulates the
rendered motion blur (as typically specified via UsdGeomCamera ‘s
shutter:open and shutter:close properties) should be scaled for
all objects at and beneath the prim in namespace on which the
motion:blurScale value is specified.
Without changing any other data in the scene, blurScale allows
artists to”dial in”the amount of blur on a per-object basis. A
blurScale value of zero removes all blur, a value of 0.5 reduces
blur by half, and a value of 2.0 doubles the blur. The legal range for
blurScale is [0, inf), although very high values may result in
extremely expensive renders, and may exceed the capabilities of some
renderers.
Although renderers are free to implement this feature however they see
fit, see Effectively Applying motion:blurScale for our guidance on
implementing the feature universally and efficiently.
ComputeMotionBlurScale()
Declaration
float motion:blurScale = 1
C++ Type
float
Usd Type
SdfValueTypeNames->Float
GetNonlinearSampleCountAttr() → Attribute
Determines the number of position or transformation samples created
when motion is described by attributes contributing non-linear terms.
To give an example, imagine an application (such as a renderer)
consuming’points’and the USD document also contains’accelerations’for
the same prim. Unless the application can consume
these’accelerations’itself, an intermediate layer has to compute
samples within the sampling interval for the point positions based on
the value of’points’,’velocities’and’accelerations’. The number of
these samples is given by’nonlinearSampleCount’. The samples are
equally spaced within the sampling interval.
Another example involves the PointInstancer
where’nonlinearSampleCount’is relevant
when’angularVelocities’or’accelerations’are authored.
‘nonlinearSampleCount’is an inherited attribute, also see
ComputeNonlinearSampleCount()
Declaration
int motion:nonlinearSampleCount = 3
C++ Type
int
Usd Type
SdfValueTypeNames->Int
static GetSchemaAttributeNames()
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
Return a vector of names of all pre-declared attributes for this
schema class and all its ancestor classes.
Does not include attributes that may be authored by custom/extended
methods of the schemas involved.
Parameters
includeInherited (bool) –
GetVelocityScaleAttr() → Attribute
Deprecated
VelocityScale is an inherited float attribute that velocity-based
schemas (e.g. PointBased, PointInstancer) can consume to compute
interpolated positions and orientations by applying velocity and
angularVelocity, which is required for interpolating between samples
when topology is varying over time. Although these quantities are
generally physically computed by a simulator, sometimes we require
more or less motion-blur to achieve the desired look. VelocityScale
allows artists to dial-in, as a post-sim correction, a scale factor to
be applied to the velocity prior to computing interpolated positions
from it.
Declaration
float motion:velocityScale = 1
C++ Type
float
Usd Type
SdfValueTypeNames->Float
class pxr.UsdGeom.NurbsCurves
This schema is analagous to NURBS Curves in packages like Maya and
Houdini, often used for interchange of rigging and modeling curves.
Unlike Maya, this curve spec supports batching of multiple curves into
a single prim, widths, and normals in the schema. Additionally, we
require’numSegments + 2 * degree + 1’knots (2 more than maya does).
This is to be more consistent with RenderMan’s NURBS patch
specification.
To express a periodic curve:
knot[0] = knot[1] - (knots[-2] - knots[-3];
knot[-1] = knot[-2] + (knot[2] - knots[1]);
To express a nonperiodic curve:
knot[0] = knot[1];
knot[-1] = knot[-2];
In spite of these slight differences in the spec, curves generated in
Maya should be preserved when roundtripping.
order and range, when representing a batched NurbsCurve should be
authored one value per curve. knots should be the concatentation of
all batched curves.
NurbsCurve Form
Form is provided as an aid to interchange between modeling and
animation applications so that they can robustly identify the intent
with which the surface was modelled, and take measures (if they are
able) to preserve the continuity/concidence constraints as the surface
may be rigged or deformed.
An open-form NurbsCurve has no continuity constraints.
A closed-form NurbsCurve expects the first and last control
points to overlap
A periodic-form NurbsCurve expects the first and last order -
1 control points to overlap.
For any described attribute Fallback Value or Allowed Values
below that are text/tokens, the actual token is published and defined
in UsdGeomTokens. So to set an attribute to the value”rightHanded”,
use UsdGeomTokens->rightHanded as the value.
Methods:
CreateFormAttr(defaultValue, writeSparsely)
See GetFormAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateKnotsAttr(defaultValue, writeSparsely)
See GetKnotsAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateOrderAttr(defaultValue, writeSparsely)
See GetOrderAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreatePointWeightsAttr(defaultValue, ...)
See GetPointWeightsAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateRangesAttr(defaultValue, writeSparsely)
See GetRangesAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
Define
classmethod Define(stage, path) -> NurbsCurves
Get
classmethod Get(stage, path) -> NurbsCurves
GetFormAttr()
Interpret the control grid and knot vectors as representing an open, geometrically closed, or geometrically closed and C2 continuous curve.
GetKnotsAttr()
Knot vector providing curve parameterization.
GetOrderAttr()
Order of the curve.
GetPointWeightsAttr()
Optionally provides"w"components for each control point, thus must be the same length as the points attribute.
GetRangesAttr()
Provides the minimum and maximum parametric values (as defined by knots) over which the curve is actually defined.
GetSchemaAttributeNames
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
CreateFormAttr(defaultValue, writeSparsely) → Attribute
See GetFormAttr() , and also Create vs Get Property Methods for when
to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateKnotsAttr(defaultValue, writeSparsely) → Attribute
See GetKnotsAttr() , and also Create vs Get Property Methods for when
to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateOrderAttr(defaultValue, writeSparsely) → Attribute
See GetOrderAttr() , and also Create vs Get Property Methods for when
to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreatePointWeightsAttr(defaultValue, writeSparsely) → Attribute
See GetPointWeightsAttr() , and also Create vs Get Property Methods
for when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateRangesAttr(defaultValue, writeSparsely) → Attribute
See GetRangesAttr() , and also Create vs Get Property Methods for when
to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
static Define()
classmethod Define(stage, path) -> NurbsCurves
Attempt to ensure a UsdPrim adhering to this schema at path is
defined (according to UsdPrim::IsDefined() ) on this stage.
If a prim adhering to this schema at path is already defined on
this stage, return that prim. Otherwise author an SdfPrimSpec with
specifier == SdfSpecifierDef and this schema’s prim type name for
the prim at path at the current EditTarget. Author SdfPrimSpec s
with specifier == SdfSpecifierDef and empty typeName at the
current EditTarget for any nonexistent, or existing but not Defined
ancestors.
The given path must be an absolute prim path that does not contain
any variant selections.
If it is impossible to author any of the necessary PrimSpecs, (for
example, in case path cannot map to the current UsdEditTarget ‘s
namespace) issue an error and return an invalid UsdPrim.
Note that this method may return a defined prim whose typeName does
not specify this schema class, in case a stronger typeName opinion
overrides the opinion at the current EditTarget.
Parameters
stage (Stage) –
path (Path) –
static Get()
classmethod Get(stage, path) -> NurbsCurves
Return a UsdGeomNurbsCurves holding the prim adhering to this schema
at path on stage .
If no prim exists at path on stage , or if the prim at that
path does not adhere to this schema, return an invalid schema object.
This is shorthand for the following:
UsdGeomNurbsCurves(stage->GetPrimAtPath(path));
Parameters
stage (Stage) –
path (Path) –
GetFormAttr() → Attribute
Interpret the control grid and knot vectors as representing an open,
geometrically closed, or geometrically closed and C2 continuous curve.
NurbsCurve Form
Declaration
uniform token form ="open"
C++ Type
TfToken
Usd Type
SdfValueTypeNames->Token
Variability
SdfVariabilityUniform
Allowed Values
open, closed, periodic
GetKnotsAttr() → Attribute
Knot vector providing curve parameterization.
The length of the slice of the array for the ith curve must be (
curveVertexCount[i] + order[i] ), and its entries must take on
monotonically increasing values.
Declaration
double[] knots
C++ Type
VtArray<double>
Usd Type
SdfValueTypeNames->DoubleArray
GetOrderAttr() → Attribute
Order of the curve.
Order must be positive and is equal to the degree of the polynomial
basis to be evaluated, plus 1. Its value for the’i’th curve must be
less than or equal to curveVertexCount[i]
Declaration
int[] order = []
C++ Type
VtArray<int>
Usd Type
SdfValueTypeNames->IntArray
GetPointWeightsAttr() → Attribute
Optionally provides”w”components for each control point, thus must be
the same length as the points attribute.
If authored, the patch will be rational. If unauthored, the patch will
be polynomial, i.e. weight for all points is 1.0.
Some DCC’s pre-weight the points, but in this schema, points are
not pre-weighted.
Declaration
double[] pointWeights
C++ Type
VtArray<double>
Usd Type
SdfValueTypeNames->DoubleArray
GetRangesAttr() → Attribute
Provides the minimum and maximum parametric values (as defined by
knots) over which the curve is actually defined.
The minimum must be less than the maximum, and greater than or equal
to the value of the knots[‘i’th curve slice][order[i]-1]. The maxium
must be less than or equal to the last element’s value in knots[‘i’th
curve slice]. Range maps to (vmin, vmax) in the RenderMan spec.
Declaration
double2[] ranges
C++ Type
VtArray<GfVec2d>
Usd Type
SdfValueTypeNames->Double2Array
static GetSchemaAttributeNames()
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
Return a vector of names of all pre-declared attributes for this
schema class and all its ancestor classes.
Does not include attributes that may be authored by custom/extended
methods of the schemas involved.
Parameters
includeInherited (bool) –
class pxr.UsdGeom.NurbsPatch
Encodes a rational or polynomial non-uniform B-spline surface, with
optional trim curves.
The encoding mostly follows that of RiNuPatch and RiTrimCurve:
https://renderman.pixar.com/resources/current/RenderMan/geometricPrimitives.html#rinupatch,
with some minor renaming and coalescing for clarity.
The layout of control vertices in the points attribute inherited
from UsdGeomPointBased is row-major with U considered rows, and V
columns.
NurbsPatch Form
The authored points, orders, knots, weights, and ranges are all that
is required to render the nurbs patch. However, the only way to model
closed surfaces with nurbs is to ensure that the first and last
control points along the given axis are coincident. Similarly, to
ensure the surface is not only closed but also C2 continuous, the last
order - 1 control points must be (correspondingly) coincident with
the first order - 1 control points, and also the spacing of the last
corresponding knots must be the same as the first corresponding knots.
Form is provided as an aid to interchange between modeling and
animation applications so that they can robustly identify the intent
with which the surface was modelled, and take measures (if they are
able) to preserve the continuity/concidence constraints as the surface
may be rigged or deformed.
An open-form NurbsPatch has no continuity constraints.
A closed-form NurbsPatch expects the first and last control
points to overlap
A periodic-form NurbsPatch expects the first and last order -
1 control points to overlap.
Nurbs vs Subdivision Surfaces
Nurbs are an important modeling primitive in CAD/CAM tools and early
computer graphics DCC’s. Because they have a natural UV
parameterization they easily support”trim curves”, which allow smooth
shapes to be carved out of the surface.
However, the topology of the patch is always rectangular, and joining
two nurbs patches together (especially when they have differing
numbers of spans) is difficult to do smoothly. Also, nurbs are not
supported by the Ptex texturing technology ( http://ptex.us).
Neither of these limitations are shared by subdivision surfaces;
therefore, although they do not subscribe to trim-curve-based shaping,
subdivs are often considered a more flexible modeling primitive.
For any described attribute Fallback Value or Allowed Values
below that are text/tokens, the actual token is published and defined
in UsdGeomTokens. So to set an attribute to the value”rightHanded”,
use UsdGeomTokens->rightHanded as the value.
Methods:
CreatePointWeightsAttr(defaultValue, ...)
See GetPointWeightsAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateTrimCurveCountsAttr(defaultValue, ...)
See GetTrimCurveCountsAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateTrimCurveKnotsAttr(defaultValue, ...)
See GetTrimCurveKnotsAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateTrimCurveOrdersAttr(defaultValue, ...)
See GetTrimCurveOrdersAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateTrimCurvePointsAttr(defaultValue, ...)
See GetTrimCurvePointsAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateTrimCurveRangesAttr(defaultValue, ...)
See GetTrimCurveRangesAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateTrimCurveVertexCountsAttr(...)
See GetTrimCurveVertexCountsAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateUFormAttr(defaultValue, writeSparsely)
See GetUFormAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateUKnotsAttr(defaultValue, writeSparsely)
See GetUKnotsAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateUOrderAttr(defaultValue, writeSparsely)
See GetUOrderAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateURangeAttr(defaultValue, writeSparsely)
See GetURangeAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateUVertexCountAttr(defaultValue, ...)
See GetUVertexCountAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateVFormAttr(defaultValue, writeSparsely)
See GetVFormAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateVKnotsAttr(defaultValue, writeSparsely)
See GetVKnotsAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateVOrderAttr(defaultValue, writeSparsely)
See GetVOrderAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateVRangeAttr(defaultValue, writeSparsely)
See GetVRangeAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateVVertexCountAttr(defaultValue, ...)
See GetVVertexCountAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
Define
classmethod Define(stage, path) -> NurbsPatch
Get
classmethod Get(stage, path) -> NurbsPatch
GetPointWeightsAttr()
Optionally provides"w"components for each control point, thus must be the same length as the points attribute.
GetSchemaAttributeNames
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
GetTrimCurveCountsAttr()
Each element specifies how many curves are present in each"loop"of the trimCurve, and the length of the array determines how many loops the trimCurve contains.
GetTrimCurveKnotsAttr()
Flat list of parametric values for each of the nCurves curves.
GetTrimCurveOrdersAttr()
Flat list of orders for each of the nCurves curves.
GetTrimCurvePointsAttr()
Flat list of homogeneous 2D points (u, v, w) that comprise the nCurves curves.
GetTrimCurveRangesAttr()
Flat list of minimum and maximum parametric values (as defined by knots) for each of the nCurves curves.
GetTrimCurveVertexCountsAttr()
Flat list of number of vertices for each of the nCurves curves.
GetUFormAttr()
Interpret the control grid and knot vectors as representing an open, geometrically closed, or geometrically closed and C2 continuous surface along the U dimension.
GetUKnotsAttr()
Knot vector for U direction providing U parameterization.
GetUOrderAttr()
Order in the U direction.
GetURangeAttr()
Provides the minimum and maximum parametric values (as defined by uKnots) over which the surface is actually defined.
GetUVertexCountAttr()
Number of vertices in the U direction.
GetVFormAttr()
Interpret the control grid and knot vectors as representing an open, geometrically closed, or geometrically closed and C2 continuous surface along the V dimension.
GetVKnotsAttr()
Knot vector for V direction providing U parameterization.
GetVOrderAttr()
Order in the V direction.
GetVRangeAttr()
Provides the minimum and maximum parametric values (as defined by vKnots) over which the surface is actually defined.
GetVVertexCountAttr()
Number of vertices in the V direction.
CreatePointWeightsAttr(defaultValue, writeSparsely) → Attribute
See GetPointWeightsAttr() , and also Create vs Get Property Methods
for when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateTrimCurveCountsAttr(defaultValue, writeSparsely) → Attribute
See GetTrimCurveCountsAttr() , and also Create vs Get Property Methods
for when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateTrimCurveKnotsAttr(defaultValue, writeSparsely) → Attribute
See GetTrimCurveKnotsAttr() , and also Create vs Get Property Methods
for when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateTrimCurveOrdersAttr(defaultValue, writeSparsely) → Attribute
See GetTrimCurveOrdersAttr() , and also Create vs Get Property Methods
for when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateTrimCurvePointsAttr(defaultValue, writeSparsely) → Attribute
See GetTrimCurvePointsAttr() , and also Create vs Get Property Methods
for when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateTrimCurveRangesAttr(defaultValue, writeSparsely) → Attribute
See GetTrimCurveRangesAttr() , and also Create vs Get Property Methods
for when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateTrimCurveVertexCountsAttr(defaultValue, writeSparsely) → Attribute
See GetTrimCurveVertexCountsAttr() , and also Create vs Get Property
Methods for when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateUFormAttr(defaultValue, writeSparsely) → Attribute
See GetUFormAttr() , and also Create vs Get Property Methods for when
to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateUKnotsAttr(defaultValue, writeSparsely) → Attribute
See GetUKnotsAttr() , and also Create vs Get Property Methods for when
to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateUOrderAttr(defaultValue, writeSparsely) → Attribute
See GetUOrderAttr() , and also Create vs Get Property Methods for when
to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateURangeAttr(defaultValue, writeSparsely) → Attribute
See GetURangeAttr() , and also Create vs Get Property Methods for when
to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateUVertexCountAttr(defaultValue, writeSparsely) → Attribute
See GetUVertexCountAttr() , and also Create vs Get Property Methods
for when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateVFormAttr(defaultValue, writeSparsely) → Attribute
See GetVFormAttr() , and also Create vs Get Property Methods for when
to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateVKnotsAttr(defaultValue, writeSparsely) → Attribute
See GetVKnotsAttr() , and also Create vs Get Property Methods for when
to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateVOrderAttr(defaultValue, writeSparsely) → Attribute
See GetVOrderAttr() , and also Create vs Get Property Methods for when
to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateVRangeAttr(defaultValue, writeSparsely) → Attribute
See GetVRangeAttr() , and also Create vs Get Property Methods for when
to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateVVertexCountAttr(defaultValue, writeSparsely) → Attribute
See GetVVertexCountAttr() , and also Create vs Get Property Methods
for when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
static Define()
classmethod Define(stage, path) -> NurbsPatch
Attempt to ensure a UsdPrim adhering to this schema at path is
defined (according to UsdPrim::IsDefined() ) on this stage.
If a prim adhering to this schema at path is already defined on
this stage, return that prim. Otherwise author an SdfPrimSpec with
specifier == SdfSpecifierDef and this schema’s prim type name for
the prim at path at the current EditTarget. Author SdfPrimSpec s
with specifier == SdfSpecifierDef and empty typeName at the
current EditTarget for any nonexistent, or existing but not Defined
ancestors.
The given path must be an absolute prim path that does not contain
any variant selections.
If it is impossible to author any of the necessary PrimSpecs, (for
example, in case path cannot map to the current UsdEditTarget ‘s
namespace) issue an error and return an invalid UsdPrim.
Note that this method may return a defined prim whose typeName does
not specify this schema class, in case a stronger typeName opinion
overrides the opinion at the current EditTarget.
Parameters
stage (Stage) –
path (Path) –
static Get()
classmethod Get(stage, path) -> NurbsPatch
Return a UsdGeomNurbsPatch holding the prim adhering to this schema at
path on stage .
If no prim exists at path on stage , or if the prim at that
path does not adhere to this schema, return an invalid schema object.
This is shorthand for the following:
UsdGeomNurbsPatch(stage->GetPrimAtPath(path));
Parameters
stage (Stage) –
path (Path) –
GetPointWeightsAttr() → Attribute
Optionally provides”w”components for each control point, thus must be
the same length as the points attribute.
If authored, the patch will be rational. If unauthored, the patch will
be polynomial, i.e. weight for all points is 1.0.
Some DCC’s pre-weight the points, but in this schema, points are
not pre-weighted.
Declaration
double[] pointWeights
C++ Type
VtArray<double>
Usd Type
SdfValueTypeNames->DoubleArray
static GetSchemaAttributeNames()
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
Return a vector of names of all pre-declared attributes for this
schema class and all its ancestor classes.
Does not include attributes that may be authored by custom/extended
methods of the schemas involved.
Parameters
includeInherited (bool) –
GetTrimCurveCountsAttr() → Attribute
Each element specifies how many curves are present in each”loop”of the
trimCurve, and the length of the array determines how many loops the
trimCurve contains.
The sum of all elements is the total nuber of curves in the trim, to
which we will refer as nCurves in describing the other trim
attributes.
Declaration
int[] trimCurve:counts
C++ Type
VtArray<int>
Usd Type
SdfValueTypeNames->IntArray
GetTrimCurveKnotsAttr() → Attribute
Flat list of parametric values for each of the nCurves curves.
There will be as many knots as the sum over all elements of
vertexCounts plus the sum over all elements of orders.
Declaration
double[] trimCurve:knots
C++ Type
VtArray<double>
Usd Type
SdfValueTypeNames->DoubleArray
GetTrimCurveOrdersAttr() → Attribute
Flat list of orders for each of the nCurves curves.
Declaration
int[] trimCurve:orders
C++ Type
VtArray<int>
Usd Type
SdfValueTypeNames->IntArray
GetTrimCurvePointsAttr() → Attribute
Flat list of homogeneous 2D points (u, v, w) that comprise the
nCurves curves.
The number of points should be equal to the um over all elements of
vertexCounts.
Declaration
double3[] trimCurve:points
C++ Type
VtArray<GfVec3d>
Usd Type
SdfValueTypeNames->Double3Array
GetTrimCurveRangesAttr() → Attribute
Flat list of minimum and maximum parametric values (as defined by
knots) for each of the nCurves curves.
Declaration
double2[] trimCurve:ranges
C++ Type
VtArray<GfVec2d>
Usd Type
SdfValueTypeNames->Double2Array
GetTrimCurveVertexCountsAttr() → Attribute
Flat list of number of vertices for each of the nCurves curves.
Declaration
int[] trimCurve:vertexCounts
C++ Type
VtArray<int>
Usd Type
SdfValueTypeNames->IntArray
GetUFormAttr() → Attribute
Interpret the control grid and knot vectors as representing an open,
geometrically closed, or geometrically closed and C2 continuous
surface along the U dimension.
NurbsPatch Form
Declaration
uniform token uForm ="open"
C++ Type
TfToken
Usd Type
SdfValueTypeNames->Token
Variability
SdfVariabilityUniform
Allowed Values
open, closed, periodic
GetUKnotsAttr() → Attribute
Knot vector for U direction providing U parameterization.
The length of this array must be ( uVertexCount + uOrder), and its
entries must take on monotonically increasing values.
Declaration
double[] uKnots
C++ Type
VtArray<double>
Usd Type
SdfValueTypeNames->DoubleArray
GetUOrderAttr() → Attribute
Order in the U direction.
Order must be positive and is equal to the degree of the polynomial
basis to be evaluated, plus 1.
Declaration
int uOrder
C++ Type
int
Usd Type
SdfValueTypeNames->Int
GetURangeAttr() → Attribute
Provides the minimum and maximum parametric values (as defined by
uKnots) over which the surface is actually defined.
The minimum must be less than the maximum, and greater than or equal
to the value of uKnots[uOrder-1]. The maxium must be less than or
equal to the last element’s value in uKnots.
Declaration
double2 uRange
C++ Type
GfVec2d
Usd Type
SdfValueTypeNames->Double2
GetUVertexCountAttr() → Attribute
Number of vertices in the U direction.
Should be at least as large as uOrder.
Declaration
int uVertexCount
C++ Type
int
Usd Type
SdfValueTypeNames->Int
GetVFormAttr() → Attribute
Interpret the control grid and knot vectors as representing an open,
geometrically closed, or geometrically closed and C2 continuous
surface along the V dimension.
NurbsPatch Form
Declaration
uniform token vForm ="open"
C++ Type
TfToken
Usd Type
SdfValueTypeNames->Token
Variability
SdfVariabilityUniform
Allowed Values
open, closed, periodic
GetVKnotsAttr() → Attribute
Knot vector for V direction providing U parameterization.
The length of this array must be ( vVertexCount + vOrder), and its
entries must take on monotonically increasing values.
Declaration
double[] vKnots
C++ Type
VtArray<double>
Usd Type
SdfValueTypeNames->DoubleArray
GetVOrderAttr() → Attribute
Order in the V direction.
Order must be positive and is equal to the degree of the polynomial
basis to be evaluated, plus 1.
Declaration
int vOrder
C++ Type
int
Usd Type
SdfValueTypeNames->Int
GetVRangeAttr() → Attribute
Provides the minimum and maximum parametric values (as defined by
vKnots) over which the surface is actually defined.
The minimum must be less than the maximum, and greater than or equal
to the value of vKnots[vOrder-1]. The maxium must be less than or
equal to the last element’s value in vKnots.
Declaration
double2 vRange
C++ Type
GfVec2d
Usd Type
SdfValueTypeNames->Double2
GetVVertexCountAttr() → Attribute
Number of vertices in the V direction.
Should be at least as large as vOrder.
Declaration
int vVertexCount
C++ Type
int
Usd Type
SdfValueTypeNames->Int
class pxr.UsdGeom.Plane
Defines a primitive plane, centered at the origin, and is defined by a
cardinal axis, width, and length. The plane is double-sided by
default.
The axis of width and length are perpendicular to the plane’s axis:
axis
width
length
X
z-axis
y-axis
Y
x-axis
z-axis
Z
x-axis
y-axis
For any described attribute Fallback Value or Allowed Values
below that are text/tokens, the actual token is published and defined
in UsdGeomTokens. So to set an attribute to the value”rightHanded”,
use UsdGeomTokens->rightHanded as the value.
Methods:
CreateAxisAttr(defaultValue, writeSparsely)
See GetAxisAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateDoubleSidedAttr(defaultValue, ...)
See GetDoubleSidedAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateExtentAttr(defaultValue, writeSparsely)
See GetExtentAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateLengthAttr(defaultValue, writeSparsely)
See GetLengthAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateWidthAttr(defaultValue, writeSparsely)
See GetWidthAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
Define
classmethod Define(stage, path) -> Plane
Get
classmethod Get(stage, path) -> Plane
GetAxisAttr()
The axis along which the surface of the plane is aligned.
GetDoubleSidedAttr()
Planes are double-sided by default.
GetExtentAttr()
Extent is re-defined on Plane only to provide a fallback value.
GetLengthAttr()
The length of the plane, which aligns to the y-axis when axis is'Z'or'X', or to the z-axis when axis is'Y'.
GetSchemaAttributeNames
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
GetWidthAttr()
The width of the plane, which aligns to the x-axis when axis is'Z'or'Y', or to the z-axis when axis is'X'.
CreateAxisAttr(defaultValue, writeSparsely) → Attribute
See GetAxisAttr() , and also Create vs Get Property Methods for when
to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateDoubleSidedAttr(defaultValue, writeSparsely) → Attribute
See GetDoubleSidedAttr() , and also Create vs Get Property Methods for
when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateExtentAttr(defaultValue, writeSparsely) → Attribute
See GetExtentAttr() , and also Create vs Get Property Methods for when
to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateLengthAttr(defaultValue, writeSparsely) → Attribute
See GetLengthAttr() , and also Create vs Get Property Methods for when
to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateWidthAttr(defaultValue, writeSparsely) → Attribute
See GetWidthAttr() , and also Create vs Get Property Methods for when
to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
static Define()
classmethod Define(stage, path) -> Plane
Attempt to ensure a UsdPrim adhering to this schema at path is
defined (according to UsdPrim::IsDefined() ) on this stage.
If a prim adhering to this schema at path is already defined on
this stage, return that prim. Otherwise author an SdfPrimSpec with
specifier == SdfSpecifierDef and this schema’s prim type name for
the prim at path at the current EditTarget. Author SdfPrimSpec s
with specifier == SdfSpecifierDef and empty typeName at the
current EditTarget for any nonexistent, or existing but not Defined
ancestors.
The given path must be an absolute prim path that does not contain
any variant selections.
If it is impossible to author any of the necessary PrimSpecs, (for
example, in case path cannot map to the current UsdEditTarget ‘s
namespace) issue an error and return an invalid UsdPrim.
Note that this method may return a defined prim whose typeName does
not specify this schema class, in case a stronger typeName opinion
overrides the opinion at the current EditTarget.
Parameters
stage (Stage) –
path (Path) –
static Get()
classmethod Get(stage, path) -> Plane
Return a UsdGeomPlane holding the prim adhering to this schema at
path on stage .
If no prim exists at path on stage , or if the prim at that
path does not adhere to this schema, return an invalid schema object.
This is shorthand for the following:
UsdGeomPlane(stage->GetPrimAtPath(path));
Parameters
stage (Stage) –
path (Path) –
GetAxisAttr() → Attribute
The axis along which the surface of the plane is aligned.
When set to’Z’the plane is in the xy-plane; when axis is’X’the plane
is in the yz-plane, and when axis is’Y’the plane is in the xz-plane.
UsdGeomGprim::GetAxisAttr().
Declaration
uniform token axis ="Z"
C++ Type
TfToken
Usd Type
SdfValueTypeNames->Token
Variability
SdfVariabilityUniform
Allowed Values
X, Y, Z
GetDoubleSidedAttr() → Attribute
Planes are double-sided by default.
Clients may also support single-sided planes.
UsdGeomGprim::GetDoubleSidedAttr()
Declaration
uniform bool doubleSided = 1
C++ Type
bool
Usd Type
SdfValueTypeNames->Bool
Variability
SdfVariabilityUniform
GetExtentAttr() → Attribute
Extent is re-defined on Plane only to provide a fallback value.
UsdGeomGprim::GetExtentAttr() .
Declaration
float3[] extent = [(-1, -1, 0), (1, 1, 0)]
C++ Type
VtArray<GfVec3f>
Usd Type
SdfValueTypeNames->Float3Array
GetLengthAttr() → Attribute
The length of the plane, which aligns to the y-axis when axis
is’Z’or’X’, or to the z-axis when axis is’Y’.
If you author length you must also author extent.
UsdGeomGprim::GetExtentAttr()
Declaration
double length = 2
C++ Type
double
Usd Type
SdfValueTypeNames->Double
static GetSchemaAttributeNames()
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
Return a vector of names of all pre-declared attributes for this
schema class and all its ancestor classes.
Does not include attributes that may be authored by custom/extended
methods of the schemas involved.
Parameters
includeInherited (bool) –
GetWidthAttr() → Attribute
The width of the plane, which aligns to the x-axis when axis
is’Z’or’Y’, or to the z-axis when axis is’X’.
If you author width you must also author extent.
UsdGeomGprim::GetExtentAttr()
Declaration
double width = 2
C++ Type
double
Usd Type
SdfValueTypeNames->Double
class pxr.UsdGeom.PointBased
Base class for all UsdGeomGprims that possess points, providing common
attributes such as normals and velocities.
Methods:
ComputeExtent
classmethod ComputeExtent(points, extent) -> bool
ComputePointsAtTime
classmethod ComputePointsAtTime(points, time, baseTime) -> bool
ComputePointsAtTimes(pointsArray, times, ...)
Compute points as in ComputePointsAtTime, but using multiple sample times.
CreateAccelerationsAttr(defaultValue, ...)
See GetAccelerationsAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateNormalsAttr(defaultValue, writeSparsely)
See GetNormalsAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreatePointsAttr(defaultValue, writeSparsely)
See GetPointsAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateVelocitiesAttr(defaultValue, writeSparsely)
See GetVelocitiesAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
Get
classmethod Get(stage, path) -> PointBased
GetAccelerationsAttr()
If provided,'accelerations'should be used with velocities to compute positions between samples for the'points'attribute rather than interpolating between neighboring'points'samples.
GetNormalsAttr()
Provide an object-space orientation for individual points, which, depending on subclass, may define a surface, curve, or free points.
GetNormalsInterpolation()
Get the interpolation for the normals attribute.
GetPointsAttr()
The primary geometry attribute for all PointBased primitives, describes points in (local) space.
GetSchemaAttributeNames
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
GetVelocitiesAttr()
If provided,'velocities'should be used by renderers to.
SetNormalsInterpolation(interpolation)
Set the interpolation for the normals attribute.
static ComputeExtent()
classmethod ComputeExtent(points, extent) -> bool
Compute the extent for the point cloud defined by points.
true on success, false if extents was unable to be calculated. On
success, extent will contain the axis-aligned bounding box of the
point cloud defined by points.
This function is to provide easy authoring of extent for usd authoring
tools, hence it is static and acts outside a specific prim (as in
attribute based methods).
Parameters
points (Vec3fArray) –
extent (Vec3fArray) –
ComputeExtent(points, transform, extent) -> bool
This is an overloaded member function, provided for convenience. It
differs from the above function only in what argument(s) it accepts.
Computes the extent as if the matrix transform was first applied.
Parameters
points (Vec3fArray) –
transform (Matrix4d) –
extent (Vec3fArray) –
ComputePointsAtTime()
classmethod ComputePointsAtTime(points, time, baseTime) -> bool
Compute points given the positions, velocities and accelerations at
time .
This will return false and leave points untouched if:
points is None
one of time and baseTime is numeric and the other is
UsdTimeCode::Default() (they must either both be numeric or both be
default)
there is no authored points attribute
If there is no error, we will return true and points will
contain the computed points.
points
- the out parameter for the new points. Its size will depend on the
authored data. time
- UsdTimeCode at which we want to evaluate the transforms baseTime
- required for correct interpolation between samples when velocities
or accelerations are present. If there are samples for positions
and velocities at t1 and t2, normal value resolution would attempt
to interpolate between the two samples, and if they could not be
interpolated because they differ in size (common in cases where
velocity is authored), will choose the sample at t1. When sampling for
the purposes of motion-blur, for example, it is common, when rendering
the frame at t2, to sample at [ t2-shutter/2, t2+shutter/2 ] for a
shutter interval of shutter. The first sample falls between t1 and
t2, but we must sample at t2 and apply velocity-based interpolation
based on those samples to get a correct result. In such scenarios, one
should provide a baseTime of t2 when querying both samples. If
your application does not care about off-sample interpolation, it can
supply the same value for baseTime that it does for time .
When baseTime is less than or equal to time , we will choose
the lower bracketing timeSample.
Parameters
points (VtArray[Vec3f]) –
time (TimeCode) –
baseTime (TimeCode) –
ComputePointsAtTime(points, stage, time, positions, velocities, velocitiesSampleTime, accelerations, velocityScale) -> bool
This is an overloaded member function, provided for convenience. It
differs from the above function only in what argument(s) it accepts.
Perform the point computation.
This does the same computation as the non-static ComputePointsAtTime
method, but takes all data as parameters rather than accessing
authored data.
points
- the out parameter for the computed points. Its size will depend on
the given data. stage
- the UsdStage time
- time at which we want to evaluate the transforms positions
- array containing all current points. velocities
- array containing all velocities. This array must be either the same
size as positions or empty. If it is empty, points are computed as
if all velocities were zero in all dimensions. velocitiesSampleTime
- time at which the samples from velocities were taken.
accelerations
- array containing all accelerations. This array must be either the
same size as positions or empty. If it is empty, points are
computed as if all accelerations were zero in all dimensions.
velocityScale
- Deprecated
Parameters
points (VtArray[Vec3f]) –
stage (UsdStageWeak) –
time (TimeCode) –
positions (Vec3fArray) –
velocities (Vec3fArray) –
velocitiesSampleTime (TimeCode) –
accelerations (Vec3fArray) –
velocityScale (float) –
ComputePointsAtTimes(pointsArray, times, baseTime) → bool
Compute points as in ComputePointsAtTime, but using multiple sample
times.
An array of vector arrays is returned where each vector array contains
the points for the corresponding time in times .
times
- A vector containing the UsdTimeCodes at which we want to sample.
Parameters
pointsArray (list[VtArray[Vec3f]]) –
times (list[TimeCode]) –
baseTime (TimeCode) –
CreateAccelerationsAttr(defaultValue, writeSparsely) → Attribute
See GetAccelerationsAttr() , and also Create vs Get Property Methods
for when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateNormalsAttr(defaultValue, writeSparsely) → Attribute
See GetNormalsAttr() , and also Create vs Get Property Methods for
when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreatePointsAttr(defaultValue, writeSparsely) → Attribute
See GetPointsAttr() , and also Create vs Get Property Methods for when
to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateVelocitiesAttr(defaultValue, writeSparsely) → Attribute
See GetVelocitiesAttr() , and also Create vs Get Property Methods for
when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
static Get()
classmethod Get(stage, path) -> PointBased
Return a UsdGeomPointBased holding the prim adhering to this schema at
path on stage .
If no prim exists at path on stage , or if the prim at that
path does not adhere to this schema, return an invalid schema object.
This is shorthand for the following:
UsdGeomPointBased(stage->GetPrimAtPath(path));
Parameters
stage (Stage) –
path (Path) –
GetAccelerationsAttr() → Attribute
If provided,’accelerations’should be used with velocities to compute
positions between samples for the’points’attribute rather than
interpolating between neighboring’points’samples.
Acceleration is measured in position units per second-squared. To
convert to position units per squared UsdTimeCode, divide by the
square of UsdStage::GetTimeCodesPerSecond() .
Declaration
vector3f[] accelerations
C++ Type
VtArray<GfVec3f>
Usd Type
SdfValueTypeNames->Vector3fArray
GetNormalsAttr() → Attribute
Provide an object-space orientation for individual points, which,
depending on subclass, may define a surface, curve, or free points.
Note that’normals’should not be authored on any Mesh that is
subdivided, since the subdivision algorithm will define its own
normals.’normals’is not a generic primvar, but the number of elements
in this attribute will be determined by its’interpolation’. See
SetNormalsInterpolation() . If’normals’and’primvars:normals’are both
specified, the latter has precedence.
Declaration
normal3f[] normals
C++ Type
VtArray<GfVec3f>
Usd Type
SdfValueTypeNames->Normal3fArray
GetNormalsInterpolation() → str
Get the interpolation for the normals attribute.
Although’normals’is not classified as a generic UsdGeomPrimvar (and
will not be included in the results of
UsdGeomPrimvarsAPI::GetPrimvars() ) it does require an interpolation
specification. The fallback interpolation, if left unspecified, is
UsdGeomTokens->vertex, which will generally produce smooth shading on
a polygonal mesh. To achieve partial or fully faceted shading of a
polygonal mesh with normals, one should use UsdGeomTokens->faceVarying
or UsdGeomTokens->uniform interpolation.
GetPointsAttr() → Attribute
The primary geometry attribute for all PointBased primitives,
describes points in (local) space.
Declaration
point3f[] points
C++ Type
VtArray<GfVec3f>
Usd Type
SdfValueTypeNames->Point3fArray
static GetSchemaAttributeNames()
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
Return a vector of names of all pre-declared attributes for this
schema class and all its ancestor classes.
Does not include attributes that may be authored by custom/extended
methods of the schemas involved.
Parameters
includeInherited (bool) –
GetVelocitiesAttr() → Attribute
If provided,’velocities’should be used by renderers to.
compute positions between samples for the’points’attribute, rather
than interpolating between neighboring’points’samples. This is the
only reasonable means of computing motion blur for topologically
varying PointBased primitives. It follows that the length of
each’velocities’sample must match the length of the
corresponding’points’sample. Velocity is measured in position units
per second, as per most simulation software. To convert to position
units per UsdTimeCode, divide by UsdStage::GetTimeCodesPerSecond() .
See also Applying Timesampled Velocities to Geometry.
Declaration
vector3f[] velocities
C++ Type
VtArray<GfVec3f>
Usd Type
SdfValueTypeNames->Vector3fArray
SetNormalsInterpolation(interpolation) → bool
Set the interpolation for the normals attribute.
true upon success, false if interpolation is not a legal value as
defined by UsdGeomPrimvar::IsValidInterpolation() , or if there was a
problem setting the value. No attempt is made to validate that the
normals attr’s value contains the right number of elements to match
its interpolation to its prim’s topology.
GetNormalsInterpolation()
Parameters
interpolation (str) –
class pxr.UsdGeom.PointInstancer
Encodes vectorized instancing of multiple, potentially animated,
prototypes (object/instance masters), which can be arbitrary
prims/subtrees on a UsdStage.
PointInstancer is a”multi instancer”, as it allows multiple prototypes
to be scattered among its”points”. We use a UsdRelationship
prototypes to identify and order all of the possible prototypes, by
targeting the root prim of each prototype. The ordering imparted by
relationships associates a zero-based integer with each prototype, and
it is these integers we use to identify the prototype of each
instance, compactly, and allowing prototypes to be swapped out without
needing to reauthor all of the per-instance data.
The PointInstancer schema is designed to scale to billions of
instances, which motivates the choice to split the per-instance
transformation into position, (quaternion) orientation, and scales,
rather than a 4x4 matrix per-instance. In addition to requiring fewer
bytes even if all elements are authored (32 bytes vs 64 for a single-
precision 4x4 matrix), we can also be selective about which attributes
need to animate over time, for substantial data reduction in many
cases.
Note that PointInstancer is not a Gprim, since it is not a graphical
primitive by any stretch of the imagination. It is, however,
Boundable, since we will sometimes want to treat the entire
PointInstancer similarly to a procedural, from the perspective of
inclusion or framing.
## Varying Instance Identity over Time
PointInstancers originating from simulations often have the
characteristic that points/instances are”born”, move around for some
time period, and then die (or leave the area of interest). In such
cases, billions of instances may be birthed over time, while at any
specific time, only a much smaller number are actually alive. To
encode this situation efficiently, the simulator may re-use indices in
the instance arrays, when a particle dies, its index will be taken
over by a new particle that may be birthed in a much different
location. This presents challenges both for identity-tracking, and for
motion-blur.
We facilitate identity tracking by providing an optional, animatable
ids attribute, that specifies the 64 bit integer ID of the particle
at each index, at each point in time. If the simulator keeps
monotonically increasing a particle-count each time a new particle is
birthed, it will serve perfectly as particle ids.
We facilitate motion blur for varying-topology particle streams by
optionally allowing per-instance velocities and angularVelocities
to be authored. If instance transforms are requested at a time between
samples and either of the velocity attributes is authored, then we
will not attempt to interpolate samples of positions or
orientations. If not authored, and the bracketing samples have the
same length, then we will interpolate.
## Computing an Instance Transform
Each instance’s transformation is a combination of the SRT affine
transform described by its scale, orientation, and position, applied
after (i.e. less locally) than the transformation computed at the
root of the prototype it is instancing. In other words, to put an
instance of a PointInstancer into the space of the PointInstancer’s
parent prim:
Apply (most locally) the authored transformation for
prototypes[protoIndices[i]]
If scales is authored, next apply the scaling matrix from
scales[i]
If orientations is authored: if *angularVelocities* is
authored, first multiply orientations[i] by the unit quaternion
derived by scaling angularVelocities[i] by the time differential
from the left-bracketing timeSample for orientation to the requested
evaluation time t, storing the result in R, else assign R
directly from orientations[i]. Apply the rotation matrix derived
from R.
Apply the translation derived from positions[i]. If
velocities is authored, apply the translation deriving from
velocities[i] scaled by the time differential from the left-
bracketing timeSample for positions to the requested evaluation time
t.
Least locally, apply the transformation authored on the
PointInstancer prim itself (or the
UsdGeomImageable::ComputeLocalToWorldTransform() of the PointInstancer
to put the instance directly into world space)
If neither velocities nor angularVelocities are authored, we
fallback to standard position and orientation computation logic (using
linear interpolation between timeSamples) as described by Applying
Timesampled Velocities to Geometry.
Scaling Velocities for Interpolation
When computing time-differentials by which to apply velocity or
angularVelocity to positions or orientations, we must scale by ( 1.0 /
UsdStage::GetTimeCodesPerSecond() ), because velocities are recorded
in units/second, while we are interpolating in UsdTimeCode ordinates.
We provide both high and low-level API’s for dealing with the
transformation as a matrix, both will compute the instance matrices
using multiple threads; the low-level API allows the client to cache
unvarying inputs so that they need not be read duplicately when
computing over time.
See also Applying Timesampled Velocities to Geometry.
## Primvars on PointInstancer
Primvars authored on a PointInstancer prim should always be applied to
each instance with constant interpolation at the root of the
instance. When you are authoring primvars on a PointInstancer, think
about it as if you were authoring them on a point-cloud (e.g. a
UsdGeomPoints gprim). The same interpolation rules for points apply
here, substituting”instance”for”point”.
In other words, the (constant) value extracted for each instance from
the authored primvar value depends on the authored interpolation and
elementSize of the primvar, as follows:
constant or uniform : the entire authored value of the
primvar should be applied exactly to each instance.
varying, vertex, or faceVarying : the first
elementSize elements of the authored primvar array should be
assigned to instance zero, the second elementSize elements should be
assigned to instance one, and so forth.
## Masking Instances:”Deactivating”and Invising
Often a PointInstancer is created”upstream”in a graphics pipeline, and
the needs of”downstream”clients necessitate eliminating some of the
instances from further consideration. Accomplishing this pruning by
re-authoring all of the per-instance attributes is not very
attractive, since it may mean destructively editing a large quantity
of data. We therefore provide means of”masking”instances by ID, such
that the instance data is unmolested, but per-instance transform and
primvar data can be retrieved with the no-longer-desired instances
eliminated from the (smaller) arrays. PointInstancer allows two
independent means of masking instances by ID, each with different
features that meet the needs of various clients in a pipeline. Both
pruning features’lists of ID’s are combined to produce the mask
returned by ComputeMaskAtTime() .
If a PointInstancer has no authored ids attribute, the masking
features will still be available, with the integers specifying element
position in the protoIndices array rather than ID.
The first masking feature encodes a list of IDs in a list-editable
metadatum called inactiveIds, which, although it does not have any
similar impact to stage population as prim activation, it shares with
that feature that its application is uniform over all time. Because it
is list-editable, we can sparsely add and remove instances from it
in many layers.
This sparse application pattern makes inactiveIds a good choice when
further downstream clients may need to reverse masking decisions made
upstream, in a manner that is robust to many kinds of future changes
to the upstream data.
See ActivateId() , ActivateIds() , DeactivateId() , DeactivateIds() ,
ActivateAllIds()
The second masking feature encodes a list of IDs in a time-varying
Int64Array-valued UsdAttribute called invisibleIds, since it shares
with Imageable visibility the ability to animate object visibility.
Unlike inactiveIds, overriding a set of opinions for invisibleIds
is not at all straightforward, because one will, in general need to
reauthor (in the overriding layer) all timeSamples for the
attribute just to change one Id’s visibility state, so it cannot be
authored sparsely. But it can be a very useful tool for situations
like encoding pre-computed camera-frustum culling of geometry when
either or both of the instances or the camera is animated.
See VisId() , VisIds() , InvisId() , InvisIds() , VisAllIds()
## Processing and Not Processing Prototypes
Any prim in the scenegraph can be targeted as a prototype by the
prototypes relationship. We do not, however, provide a specific
mechanism for identifying prototypes as geometry that should not be
drawn (or processed) in their own, local spaces in the scenegraph. We
encourage organizing all prototypes as children of the PointInstancer
prim that consumes them, and pruning”raw”processing and drawing
traversals when they encounter a PointInstancer prim; this is what the
UsdGeomBBoxCache and UsdImaging engines do.
There is a pattern one can deploy for organizing the prototypes such
that they will automatically be skipped by basic
UsdPrim::GetChildren() or UsdPrimRange traversals. Usd prims each have
a specifier of”def”,”over”, or”class”. The default traversals skip
over prims that are”pure overs”or classes. So to protect prototypes
from all generic traversals and processing, place them under a prim
that is just an”over”. For example,
01 def PointInstancer "Crowd_Mid"
02 {
03 rel prototypes = [ </Crowd_Mid/Prototypes/MaleThin_Business>, </Crowd_Mid/Prototypes/MaleThin_Casual> ]
04
05 over "Prototypes"
06 {
07 def "MaleThin_Business" (
08 references = [@MaleGroupA/usd/MaleGroupA.usd@</MaleGroupA>]
09 variants = {
10 string modelingVariant = "Thin"
11 string costumeVariant = "BusinessAttire"
12 }
13 )
14 { \.\.\. }
15
16 def "MaleThin_Casual"
17 \.\.\.
18 }
19 }
Classes:
MaskApplication
Encodes whether to evaluate and apply the PointInstancer's mask to computed results.
ProtoXformInclusion
Encodes whether to include each prototype's root prim's transformation as the most-local component of computed instance transforms.
Methods:
ActivateAllIds()
Ensure that all instances are active over all time.
ActivateId(id)
Ensure that the instance identified by id is active over all time.
ActivateIds(ids)
Ensure that the instances identified by ids are active over all time.
ComputeExtentAtTime(extent, time, baseTime)
Compute the extent of the point instancer based on the per- instance,"PointInstancer relative"transforms at time , as described in Computing an Instance Transform.
ComputeExtentAtTimes(extents, times, baseTime)
Compute the extent of the point instancer as in ComputeExtentAtTime, but across multiple times .
ComputeInstanceTransformsAtTime
classmethod ComputeInstanceTransformsAtTime(xforms, time, baseTime, doProtoXforms, applyMask) -> bool
ComputeInstanceTransformsAtTimes(...)
Compute the per-instance transforms as in ComputeInstanceTransformsAtTime, but using multiple sample times.
ComputeMaskAtTime(time, ids)
Computes a presence mask to be applied to per-instance data arrays based on authored inactiveIds, invisibleIds, and ids.
CreateAccelerationsAttr(defaultValue, ...)
See GetAccelerationsAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateAngularVelocitiesAttr(defaultValue, ...)
See GetAngularVelocitiesAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateIdsAttr(defaultValue, writeSparsely)
See GetIdsAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateInvisibleIdsAttr(defaultValue, ...)
See GetInvisibleIdsAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateOrientationsAttr(defaultValue, ...)
See GetOrientationsAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreatePositionsAttr(defaultValue, writeSparsely)
See GetPositionsAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateProtoIndicesAttr(defaultValue, ...)
See GetProtoIndicesAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreatePrototypesRel()
See GetPrototypesRel() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateScalesAttr(defaultValue, writeSparsely)
See GetScalesAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateVelocitiesAttr(defaultValue, writeSparsely)
See GetVelocitiesAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
DeactivateId(id)
Ensure that the instance identified by id is inactive over all time.
DeactivateIds(ids)
Ensure that the instances identified by ids are inactive over all time.
Define
classmethod Define(stage, path) -> PointInstancer
Get
classmethod Get(stage, path) -> PointInstancer
GetAccelerationsAttr()
If authored, per-instance'accelerations'will be used with velocities to compute positions between samples for the'positions'attribute rather than interpolating between neighboring'positions'samples.
GetAngularVelocitiesAttr()
If authored, per-instance angular velocity vector to be used for interoplating orientations.
GetIdsAttr()
Ids are optional; if authored, the ids array should be the same length as the protoIndices array, specifying (at each timeSample if instance identities are changing) the id of each instance.
GetInstanceCount(timeCode)
Returns the number of instances as defined by the size of the protoIndices array at timeCode.
GetInvisibleIdsAttr()
A list of id's to make invisible at the evaluation time.
GetOrientationsAttr()
If authored, per-instance orientation of each instance about its prototype's origin, represented as a unit length quaternion, which allows us to encode it with sufficient precision in a compact GfQuath.
GetPositionsAttr()
Required property.
GetProtoIndicesAttr()
Required property.
GetPrototypesRel()
Required property.
GetScalesAttr()
If authored, per-instance scale to be applied to each instance, before any rotation is applied.
GetSchemaAttributeNames
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
GetVelocitiesAttr()
If provided, per-instance'velocities'will be used to compute positions between samples for the'positions'attribute, rather than interpolating between neighboring'positions'samples.
InvisId(id, time)
Ensure that the instance identified by id is invisible at time
InvisIds(ids, time)
Ensure that the instances identified by ids are invisible at time .
VisAllIds(time)
Ensure that all instances are visible at time .
VisId(id, time)
Ensure that the instance identified by id is visible at time .
VisIds(ids, time)
Ensure that the instances identified by ids are visible at time .
Attributes:
ApplyMask
ExcludeProtoXform
IgnoreMask
IncludeProtoXform
class MaskApplication
Encodes whether to evaluate and apply the PointInstancer’s mask to
computed results.
ComputeMaskAtTime()
Methods:
GetValueFromName
Attributes:
allValues
static GetValueFromName()
allValues = (UsdGeom.PointInstancer.ApplyMask, UsdGeom.PointInstancer.IgnoreMask)
class ProtoXformInclusion
Encodes whether to include each prototype’s root prim’s transformation
as the most-local component of computed instance transforms.
Methods:
GetValueFromName
Attributes:
allValues
static GetValueFromName()
allValues = (UsdGeom.PointInstancer.IncludeProtoXform, UsdGeom.PointInstancer.ExcludeProtoXform)
ActivateAllIds() → bool
Ensure that all instances are active over all time.
This does not guarantee that the instances will be rendered, because
each may still be”invisible”due to its presence in the invisibleIds
attribute (see VisId() , InvisId() )
ActivateId(id) → bool
Ensure that the instance identified by id is active over all time.
This activation is encoded sparsely, affecting no other instances.
This does not guarantee that the instance will be rendered, because it
may still be”invisible”due to id being present in the
invisibleIds attribute (see VisId() , InvisId() )
Parameters
id (int) –
ActivateIds(ids) → bool
Ensure that the instances identified by ids are active over all
time.
This activation is encoded sparsely, affecting no other instances.
This does not guarantee that the instances will be rendered, because
each may still be”invisible”due to its presence in the invisibleIds
attribute (see VisId() , InvisId() )
Parameters
ids (Int64Array) –
ComputeExtentAtTime(extent, time, baseTime) → bool
Compute the extent of the point instancer based on the per-
instance,”PointInstancer relative”transforms at time , as
described in Computing an Instance Transform.
If there is no error, we return true and extent will be the
tightest bounds we can compute efficiently. If an error occurs,
false will be returned and extent will be left untouched.
For now, this uses a UsdGeomBBoxCache with the”default”,”proxy”,
and”render”purposes.
extent
- the out parameter for the extent. On success, it will contain two
elements representing the min and max. time
- UsdTimeCode at which we want to evaluate the extent baseTime
- required for correct interpolation between samples when velocities
or angularVelocities are present. If there are samples for
positions and velocities at t1 and t2, normal value resolution
would attempt to interpolate between the two samples, and if they
could not be interpolated because they differ in size (common in cases
where velocity is authored), will choose the sample at t1. When
sampling for the purposes of motion-blur, for example, it is common,
when rendering the frame at t2, to sample at [ t2-shutter/2,
t2+shutter/2 ] for a shutter interval of shutter. The first sample
falls between t1 and t2, but we must sample at t2 and apply velocity-
based interpolation based on those samples to get a correct result. In
such scenarios, one should provide a baseTime of t2 when querying
both samples. If your application does not care about off-sample
interpolation, it can supply the same value for baseTime that it
does for time . When baseTime is less than or equal to
time , we will choose the lower bracketing timeSample.
Parameters
extent (Vec3fArray) –
time (TimeCode) –
baseTime (TimeCode) –
ComputeExtentAtTime(extent, time, baseTime, transform) -> bool
This is an overloaded member function, provided for convenience. It
differs from the above function only in what argument(s) it accepts.
Computes the extent as if the matrix transform was first applied.
Parameters
extent (Vec3fArray) –
time (TimeCode) –
baseTime (TimeCode) –
transform (Matrix4d) –
ComputeExtentAtTimes(extents, times, baseTime) → bool
Compute the extent of the point instancer as in ComputeExtentAtTime,
but across multiple times .
This is equivalent to, but more efficient than, calling
ComputeExtentAtTime several times. Each element in extents is the
computed extent at the corresponding time in times .
As in ComputeExtentAtTime, if there is no error, we return true
and extents will be the tightest bounds we can compute
efficiently. If an error occurs computing the extent at any time,
false will be returned and extents will be left untouched.
times
- A vector containing the UsdTimeCodes at which we want to sample.
Parameters
extents (list[Vec3fArray]) –
times (list[TimeCode]) –
baseTime (TimeCode) –
ComputeExtentAtTimes(extents, times, baseTime, transform) -> bool
This is an overloaded member function, provided for convenience. It
differs from the above function only in what argument(s) it accepts.
Computes the extent as if the matrix transform was first applied
at each time.
Parameters
extents (list[Vec3fArray]) –
times (list[TimeCode]) –
baseTime (TimeCode) –
transform (Matrix4d) –
ComputeInstanceTransformsAtTime()
classmethod ComputeInstanceTransformsAtTime(xforms, time, baseTime, doProtoXforms, applyMask) -> bool
Compute the per-instance,”PointInstancer relative”transforms given the
positions, scales, orientations, velocities and angularVelocities at
time , as described in Computing an Instance Transform.
This will return false and leave xforms untouched if:
xforms is None
one of time and baseTime is numeric and the other is
UsdTimeCode::Default() (they must either both be numeric or both be
default)
there is no authored protoIndices attribute or positions
attribute
the size of any of the per-instance attributes does not match the
size of protoIndices
doProtoXforms is IncludeProtoXform but an index value in
protoIndices is outside the range [0, prototypes.size())
applyMask is ApplyMask and a mask is set but the size of
the mask does not match the size of protoIndices.
If there is no error, we will return true and xforms will
contain the computed transformations.
xforms
- the out parameter for the transformations. Its size will depend on
the authored data and applyMask time
- UsdTimeCode at which we want to evaluate the transforms baseTime
- required for correct interpolation between samples when velocities
or angularVelocities are present. If there are samples for
positions and velocities at t1 and t2, normal value resolution
would attempt to interpolate between the two samples, and if they
could not be interpolated because they differ in size (common in cases
where velocity is authored), will choose the sample at t1. When
sampling for the purposes of motion-blur, for example, it is common,
when rendering the frame at t2, to sample at [ t2-shutter/2,
t2+shutter/2 ] for a shutter interval of shutter. The first sample
falls between t1 and t2, but we must sample at t2 and apply velocity-
based interpolation based on those samples to get a correct result. In
such scenarios, one should provide a baseTime of t2 when querying
both samples. If your application does not care about off-sample
interpolation, it can supply the same value for baseTime that it
does for time . When baseTime is less than or equal to
time , we will choose the lower bracketing timeSample. Selecting
sample times with respect to baseTime will be performed independently
for positions and orientations. doProtoXforms
- specifies whether to include the root transformation of each
instance’s prototype in the instance’s transform. Default is to
include it, but some clients may want to apply the proto transform as
part of the prototype itself, so they can specify
ExcludeProtoXform instead. applyMask
- specifies whether to apply ApplyMaskToArray() to the computed
result. The default is ApplyMask .
Parameters
xforms (VtArray[Matrix4d]) –
time (TimeCode) –
baseTime (TimeCode) –
doProtoXforms (ProtoXformInclusion) –
applyMask (MaskApplication) –
ComputeInstanceTransformsAtTime(xforms, stage, time, protoIndices, positions, velocities, velocitiesSampleTime, accelerations, scales, orientations, angularVelocities, angularVelocitiesSampleTime, protoPaths, mask, velocityScale) -> bool
This is an overloaded member function, provided for convenience. It
differs from the above function only in what argument(s) it accepts.
Perform the per-instance transform computation as described in
Computing an Instance Transform.
This does the same computation as the non-static
ComputeInstanceTransformsAtTime method, but takes all data as
parameters rather than accessing authored data.
xforms
- the out parameter for the transformations. Its size will depend on
the given data and applyMask stage
- the UsdStage time
- time at which we want to evaluate the transforms protoIndices
- array containing all instance prototype indices. positions
- array containing all instance positions. This array must be the same
size as protoIndices . velocities
- array containing all instance velocities. This array must be either
the same size as protoIndices or empty. If it is empty, transforms
are computed as if all velocities were zero in all dimensions.
velocitiesSampleTime
- time at which the samples from velocities were taken.
accelerations
- array containing all instance accelerations. This array must be
either the same size as protoIndicesor empty. If it is empty,
transforms are computed as if all accelerations were zero in all
dimensions. scales
- array containing all instance scales. This array must be either the
same size as protoIndices or empty. If it is empty, transforms are
computed with no change in scale. orientations
- array containing all instance orientations. This array must be
either the same size as protoIndices or empty. If it is empty,
transforms are computed with no change in orientation
angularVelocities
- array containing all instance angular velocities. This array must be
either the same size as protoIndices or empty. If it is empty,
transforms are computed as if all angular velocities were zero in all
dimensions. angularVelocitiesSampleTime
- time at which the samples from angularVelocities were taken.
protoPaths
- array containing the paths for all instance prototypes. If this
array is not empty, prototype transforms are applied to the instance
transforms. mask
- vector containing a mask to apply to the computed result. This
vector must be either the same size as protoIndices or empty. If
it is empty, no mask is applied. velocityScale
- Deprecated
Parameters
xforms (VtArray[Matrix4d]) –
stage (UsdStageWeak) –
time (TimeCode) –
protoIndices (IntArray) –
positions (Vec3fArray) –
velocities (Vec3fArray) –
velocitiesSampleTime (TimeCode) –
accelerations (Vec3fArray) –
scales (Vec3fArray) –
orientations (QuathArray) –
angularVelocities (Vec3fArray) –
angularVelocitiesSampleTime (TimeCode) –
protoPaths (list[SdfPath]) –
mask (list[bool]) –
velocityScale (float) –
ComputeInstanceTransformsAtTimes(xformsArray, times, baseTime, doProtoXforms, applyMask) → bool
Compute the per-instance transforms as in
ComputeInstanceTransformsAtTime, but using multiple sample times.
An array of matrix arrays is returned where each matrix array contains
the instance transforms for the corresponding time in times .
times
- A vector containing the UsdTimeCodes at which we want to sample.
Parameters
xformsArray (list[VtArray[Matrix4d]]) –
times (list[TimeCode]) –
baseTime (TimeCode) –
doProtoXforms (ProtoXformInclusion) –
applyMask (MaskApplication) –
ComputeMaskAtTime(time, ids) → list[bool]
Computes a presence mask to be applied to per-instance data arrays
based on authored inactiveIds, invisibleIds, and ids.
If no ids attribute has been authored, then the values in
inactiveIds and invisibleIds will be interpreted directly as
indices of protoIndices.
If ids is non-None, it is assumed to be the id-mapping to apply,
and must match the length of protoIndices at time . If None, we
will call GetIdsAttr() .Get(time)
If all”live”instances at UsdTimeCode time pass the mask, we will
return an empty mask so that clients can trivially recognize the
common”no masking”case. The returned mask can be used with
ApplyMaskToArray() , and will contain a true value for every
element that should survive.
Parameters
time (TimeCode) –
ids (Int64Array) –
CreateAccelerationsAttr(defaultValue, writeSparsely) → Attribute
See GetAccelerationsAttr() , and also Create vs Get Property Methods
for when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateAngularVelocitiesAttr(defaultValue, writeSparsely) → Attribute
See GetAngularVelocitiesAttr() , and also Create vs Get Property
Methods for when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateIdsAttr(defaultValue, writeSparsely) → Attribute
See GetIdsAttr() , and also Create vs Get Property Methods for when to
use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateInvisibleIdsAttr(defaultValue, writeSparsely) → Attribute
See GetInvisibleIdsAttr() , and also Create vs Get Property Methods
for when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateOrientationsAttr(defaultValue, writeSparsely) → Attribute
See GetOrientationsAttr() , and also Create vs Get Property Methods
for when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreatePositionsAttr(defaultValue, writeSparsely) → Attribute
See GetPositionsAttr() , and also Create vs Get Property Methods for
when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateProtoIndicesAttr(defaultValue, writeSparsely) → Attribute
See GetProtoIndicesAttr() , and also Create vs Get Property Methods
for when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreatePrototypesRel() → Relationship
See GetPrototypesRel() , and also Create vs Get Property Methods for
when to use Get vs Create.
CreateScalesAttr(defaultValue, writeSparsely) → Attribute
See GetScalesAttr() , and also Create vs Get Property Methods for when
to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateVelocitiesAttr(defaultValue, writeSparsely) → Attribute
See GetVelocitiesAttr() , and also Create vs Get Property Methods for
when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
DeactivateId(id) → bool
Ensure that the instance identified by id is inactive over all
time.
This deactivation is encoded sparsely, affecting no other instances.
A deactivated instance is guaranteed not to render if the renderer
honors masking.
Parameters
id (int) –
DeactivateIds(ids) → bool
Ensure that the instances identified by ids are inactive over all
time.
This deactivation is encoded sparsely, affecting no other instances.
A deactivated instance is guaranteed not to render if the renderer
honors masking.
Parameters
ids (Int64Array) –
static Define()
classmethod Define(stage, path) -> PointInstancer
Attempt to ensure a UsdPrim adhering to this schema at path is
defined (according to UsdPrim::IsDefined() ) on this stage.
If a prim adhering to this schema at path is already defined on
this stage, return that prim. Otherwise author an SdfPrimSpec with
specifier == SdfSpecifierDef and this schema’s prim type name for
the prim at path at the current EditTarget. Author SdfPrimSpec s
with specifier == SdfSpecifierDef and empty typeName at the
current EditTarget for any nonexistent, or existing but not Defined
ancestors.
The given path must be an absolute prim path that does not contain
any variant selections.
If it is impossible to author any of the necessary PrimSpecs, (for
example, in case path cannot map to the current UsdEditTarget ‘s
namespace) issue an error and return an invalid UsdPrim.
Note that this method may return a defined prim whose typeName does
not specify this schema class, in case a stronger typeName opinion
overrides the opinion at the current EditTarget.
Parameters
stage (Stage) –
path (Path) –
static Get()
classmethod Get(stage, path) -> PointInstancer
Return a UsdGeomPointInstancer holding the prim adhering to this
schema at path on stage .
If no prim exists at path on stage , or if the prim at that
path does not adhere to this schema, return an invalid schema object.
This is shorthand for the following:
UsdGeomPointInstancer(stage->GetPrimAtPath(path));
Parameters
stage (Stage) –
path (Path) –
GetAccelerationsAttr() → Attribute
If authored, per-instance’accelerations’will be used with velocities
to compute positions between samples for the’positions’attribute
rather than interpolating between neighboring’positions’samples.
Acceleration is measured in position units per second-squared. To
convert to position units per squared UsdTimeCode, divide by the
square of UsdStage::GetTimeCodesPerSecond() .
Declaration
vector3f[] accelerations
C++ Type
VtArray<GfVec3f>
Usd Type
SdfValueTypeNames->Vector3fArray
GetAngularVelocitiesAttr() → Attribute
If authored, per-instance angular velocity vector to be used for
interoplating orientations.
Angular velocities should be considered mandatory if both
protoIndices and orientations are animated. Angular velocity is
measured in degrees per second. To convert to degrees per
UsdTimeCode, divide by UsdStage::GetTimeCodesPerSecond() .
See also Computing an Instance Transform.
Declaration
vector3f[] angularVelocities
C++ Type
VtArray<GfVec3f>
Usd Type
SdfValueTypeNames->Vector3fArray
GetIdsAttr() → Attribute
Ids are optional; if authored, the ids array should be the same length
as the protoIndices array, specifying (at each timeSample if
instance identities are changing) the id of each instance.
The type is signed intentionally, so that clients can encode some
binary state on Id’d instances without adding a separate primvar. See
also Varying Instance Identity over Time
Declaration
int64[] ids
C++ Type
VtArray<int64_t>
Usd Type
SdfValueTypeNames->Int64Array
GetInstanceCount(timeCode) → int
Returns the number of instances as defined by the size of the
protoIndices array at timeCode.
For most code, this check will be performant. When using file formats
where the cost of attribute reading is high and the time sampled array
will be read into memory later, it may be better to explicitly read
the value once and check the size of the array directly.
GetProtoIndicesAttr()
Parameters
timeCode (TimeCode) –
GetInvisibleIdsAttr() → Attribute
A list of id’s to make invisible at the evaluation time.
See invisibleIds: Animatable Masking.
Declaration
int64[] invisibleIds = []
C++ Type
VtArray<int64_t>
Usd Type
SdfValueTypeNames->Int64Array
GetOrientationsAttr() → Attribute
If authored, per-instance orientation of each instance about its
prototype’s origin, represented as a unit length quaternion, which
allows us to encode it with sufficient precision in a compact GfQuath.
It is client’s responsibility to ensure that authored quaternions are
unit length; the convenience API below for authoring orientations from
rotation matrices will ensure that quaternions are unit length, though
it will not make any attempt to select the”better (for
interpolationwith respect to neighboring samples)”of the two possible
quaternions that encode the rotation.
See also Computing an Instance Transform.
Declaration
quath[] orientations
C++ Type
VtArray<GfQuath>
Usd Type
SdfValueTypeNames->QuathArray
GetPositionsAttr() → Attribute
Required property.
Per-instance position. See also Computing an Instance Transform.
Declaration
point3f[] positions
C++ Type
VtArray<GfVec3f>
Usd Type
SdfValueTypeNames->Point3fArray
GetProtoIndicesAttr() → Attribute
Required property.
Per-instance index into prototypes relationship that identifies what
geometry should be drawn for each instance. Topology attribute -
can be animated, but at a potential performance impact for streaming.
Declaration
int[] protoIndices
C++ Type
VtArray<int>
Usd Type
SdfValueTypeNames->IntArray
GetPrototypesRel() → Relationship
Required property.
Orders and targets the prototype root prims, which can be located
anywhere in the scenegraph that is convenient, although we promote
organizing prototypes as children of the PointInstancer. The position
of a prototype in this relationship defines the value an instance
would specify in the protoIndices attribute to instance that
prototype. Since relationships are uniform, this property cannot be
animated.
GetScalesAttr() → Attribute
If authored, per-instance scale to be applied to each instance, before
any rotation is applied.
See also Computing an Instance Transform.
Declaration
float3[] scales
C++ Type
VtArray<GfVec3f>
Usd Type
SdfValueTypeNames->Float3Array
static GetSchemaAttributeNames()
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
Return a vector of names of all pre-declared attributes for this
schema class and all its ancestor classes.
Does not include attributes that may be authored by custom/extended
methods of the schemas involved.
Parameters
includeInherited (bool) –
GetVelocitiesAttr() → Attribute
If provided, per-instance’velocities’will be used to compute positions
between samples for the’positions’attribute, rather than interpolating
between neighboring’positions’samples.
Velocities should be considered mandatory if both protoIndices and
positions are animated. Velocity is measured in position units per
second, as per most simulation software. To convert to position units
per UsdTimeCode, divide by UsdStage::GetTimeCodesPerSecond() .
See also Computing an Instance Transform, Applying Timesampled
Velocities to Geometry.
Declaration
vector3f[] velocities
C++ Type
VtArray<GfVec3f>
Usd Type
SdfValueTypeNames->Vector3fArray
InvisId(id, time) → bool
Ensure that the instance identified by id is invisible at time
.
This will cause invisibleIds to first be broken down (keyed) at
time , causing all animation in weaker layers that the current
UsdEditTarget to be overridden. Has no effect on any timeSamples other
than the one at time .
An invised instance is guaranteed not to render if the renderer honors
masking.
Parameters
id (int) –
time (TimeCode) –
InvisIds(ids, time) → bool
Ensure that the instances identified by ids are invisible at
time .
This will cause invisibleIds to first be broken down (keyed) at
time , causing all animation in weaker layers that the current
UsdEditTarget to be overridden. Has no effect on any timeSamples other
than the one at time .
An invised instance is guaranteed not to render if the renderer honors
masking.
Parameters
ids (Int64Array) –
time (TimeCode) –
VisAllIds(time) → bool
Ensure that all instances are visible at time .
Operates by authoring an empty array at time .
This does not guarantee that the instances will be rendered, because
each may still be”inactive”due to its id being present in the
inactivevIds metadata (see ActivateId() , DeactivateId() )
Parameters
time (TimeCode) –
VisId(id, time) → bool
Ensure that the instance identified by id is visible at time .
This will cause invisibleIds to first be broken down (keyed) at
time , causing all animation in weaker layers that the current
UsdEditTarget to be overridden. Has no effect on any timeSamples other
than the one at time . If the invisibleIds attribute is not
authored or is blocked, this operation is a no-op.
This does not guarantee that the instance will be rendered, because it
may still be”inactive”due to id being present in the
inactivevIds metadata (see ActivateId() , DeactivateId() )
Parameters
id (int) –
time (TimeCode) –
VisIds(ids, time) → bool
Ensure that the instances identified by ids are visible at
time .
This will cause invisibleIds to first be broken down (keyed) at
time , causing all animation in weaker layers that the current
UsdEditTarget to be overridden. Has no effect on any timeSamples other
than the one at time . If the invisibleIds attribute is not
authored or is blocked, this operation is a no-op.
This does not guarantee that the instances will be rendered, because
each may still be”inactive”due to id being present in the
inactivevIds metadata (see ActivateId() , DeactivateId() )
Parameters
ids (Int64Array) –
time (TimeCode) –
ApplyMask = UsdGeom.PointInstancer.ApplyMask
ExcludeProtoXform = UsdGeom.PointInstancer.ExcludeProtoXform
IgnoreMask = UsdGeom.PointInstancer.IgnoreMask
IncludeProtoXform = UsdGeom.PointInstancer.IncludeProtoXform
class pxr.UsdGeom.Points
Points are analogous to the RiPoints spec.
Points can be an efficient means of storing and rendering particle
effects comprised of thousands or millions of small particles. Points
generally receive a single shading sample each, which should take
normals into account, if present.
While not technically UsdGeomPrimvars, the widths and normals also
have interpolation metadata. It’s common for authored widths and
normals to have constant or varying interpolation.
Methods:
ComputeExtent
classmethod ComputeExtent(points, widths, extent) -> bool
CreateIdsAttr(defaultValue, writeSparsely)
See GetIdsAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateWidthsAttr(defaultValue, writeSparsely)
See GetWidthsAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
Define
classmethod Define(stage, path) -> Points
Get
classmethod Get(stage, path) -> Points
GetIdsAttr()
Ids are optional; if authored, the ids array should be the same length as the points array, specifying (at each timesample if point identities are changing) the id of each point.
GetPointCount(timeCode)
Returns the number of points as defined by the size of the points array at timeCode.
GetSchemaAttributeNames
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
GetWidthsAttr()
Widths are defined as the diameter of the points, in object space.
GetWidthsInterpolation()
Get the interpolation for the widths attribute.
SetWidthsInterpolation(interpolation)
Set the interpolation for the widths attribute.
static ComputeExtent()
classmethod ComputeExtent(points, widths, extent) -> bool
Compute the extent for the point cloud defined by points and widths.
true upon success, false if widths and points are different sized
arrays. On success, extent will contain the axis-aligned bounding box
of the point cloud defined by points with the given widths.
This function is to provide easy authoring of extent for usd authoring
tools, hence it is static and acts outside a specific prim (as in
attribute based methods).
Parameters
points (Vec3fArray) –
widths (FloatArray) –
extent (Vec3fArray) –
ComputeExtent(points, widths, transform, extent) -> bool
This is an overloaded member function, provided for convenience. It
differs from the above function only in what argument(s) it accepts.
Computes the extent as if the matrix transform was first applied.
Parameters
points (Vec3fArray) –
widths (FloatArray) –
transform (Matrix4d) –
extent (Vec3fArray) –
CreateIdsAttr(defaultValue, writeSparsely) → Attribute
See GetIdsAttr() , and also Create vs Get Property Methods for when to
use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateWidthsAttr(defaultValue, writeSparsely) → Attribute
See GetWidthsAttr() , and also Create vs Get Property Methods for when
to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
static Define()
classmethod Define(stage, path) -> Points
Attempt to ensure a UsdPrim adhering to this schema at path is
defined (according to UsdPrim::IsDefined() ) on this stage.
If a prim adhering to this schema at path is already defined on
this stage, return that prim. Otherwise author an SdfPrimSpec with
specifier == SdfSpecifierDef and this schema’s prim type name for
the prim at path at the current EditTarget. Author SdfPrimSpec s
with specifier == SdfSpecifierDef and empty typeName at the
current EditTarget for any nonexistent, or existing but not Defined
ancestors.
The given path must be an absolute prim path that does not contain
any variant selections.
If it is impossible to author any of the necessary PrimSpecs, (for
example, in case path cannot map to the current UsdEditTarget ‘s
namespace) issue an error and return an invalid UsdPrim.
Note that this method may return a defined prim whose typeName does
not specify this schema class, in case a stronger typeName opinion
overrides the opinion at the current EditTarget.
Parameters
stage (Stage) –
path (Path) –
static Get()
classmethod Get(stage, path) -> Points
Return a UsdGeomPoints holding the prim adhering to this schema at
path on stage .
If no prim exists at path on stage , or if the prim at that
path does not adhere to this schema, return an invalid schema object.
This is shorthand for the following:
UsdGeomPoints(stage->GetPrimAtPath(path));
Parameters
stage (Stage) –
path (Path) –
GetIdsAttr() → Attribute
Ids are optional; if authored, the ids array should be the same length
as the points array, specifying (at each timesample if point
identities are changing) the id of each point.
The type is signed intentionally, so that clients can encode some
binary state on Id’d points without adding a separate primvar.
Declaration
int64[] ids
C++ Type
VtArray<int64_t>
Usd Type
SdfValueTypeNames->Int64Array
GetPointCount(timeCode) → int
Returns the number of points as defined by the size of the points
array at timeCode.
For most code, this check will be performant. When using file formats
where the cost of attribute reading is high and the time sampled array
will be read into memory later, it may be better to explicitly read
the value once and check the size of the array directly.
GetPointsAttr()
Parameters
timeCode (TimeCode) –
static GetSchemaAttributeNames()
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
Return a vector of names of all pre-declared attributes for this
schema class and all its ancestor classes.
Does not include attributes that may be authored by custom/extended
methods of the schemas involved.
Parameters
includeInherited (bool) –
GetWidthsAttr() → Attribute
Widths are defined as the diameter of the points, in object space.
‘widths’is not a generic Primvar, but the number of elements in this
attribute will be determined by its’interpolation’. See
SetWidthsInterpolation() . If’widths’and’primvars:widths’are both
specified, the latter has precedence.
Declaration
float[] widths
C++ Type
VtArray<float>
Usd Type
SdfValueTypeNames->FloatArray
GetWidthsInterpolation() → str
Get the interpolation for the widths attribute.
Although’widths’is not classified as a generic UsdGeomPrimvar (and
will not be included in the results of
UsdGeomPrimvarsAPI::GetPrimvars() ) it does require an interpolation
specification. The fallback interpolation, if left unspecified, is
UsdGeomTokens->vertex, which means a width value is specified for each
point.
SetWidthsInterpolation(interpolation) → bool
Set the interpolation for the widths attribute.
true upon success, false if interpolation is not a legal value as
defined by UsdPrimvar::IsValidInterpolation(), or if there was a
problem setting the value. No attempt is made to validate that the
widths attr’s value contains the right number of elements to match its
interpolation to its prim’s topology.
GetWidthsInterpolation()
Parameters
interpolation (str) –
class pxr.UsdGeom.Primvar
Schema wrapper for UsdAttribute for authoring and introspecting
attributes that are primvars.
UsdGeomPrimvar provides API for authoring and retrieving the
additional data required to encode an attribute as a”Primvar”, which
is a convenient contraction of RenderMan’s”Primitive Variable”concept,
which is represented in Alembic as”arbitrary geometry
parameters”(arbGeomParams).
This includes the attribute’s interpolation across the primitive
(which RenderMan refers to as its class specifier and Alembic as its
“geometry scope” ); it also includes the attribute’s elementSize,
which states how many values in the value array must be aggregated for
each element on the primitive. An attribute’s TypeName also factors
into the encoding of Primvar.
## What is the Purpose of a Primvar?
There are three key aspects of Primvar identity:
Primvars define a value that can vary across the primitive on
which they are defined, via prescribed interpolation rules
Taken collectively on a prim, its Primvars describe the”per-
primitiveoverrides”to the material to which the prim is bound.
Different renderers may communicate the variables to the shaders using
different mechanisms over which Usd has no control; Primvars simply
provide the classification that any renderer should use to locate
potential overrides. Do please note that primvars override parameters
on UsdShadeShader objects, not Interface Attributes on
UsdShadeMaterial prims.
Primvars inherit down scene namespace. Regular USD attributes
only apply to the prim on which they are specified, but primvars
implicitly also apply to any child prims, unless those child prims
have their own opinions about those primvars. This capability
necessarily entails added cost to check for inherited values, but the
benefit is that it allows concise encoding of certain opinions that
broadly affect large amounts of geometry. See
UsdGeomImageable::FindInheritedPrimvars().
## Creating and Accessing Primvars
The UsdGeomPrimvarsAPI schema provides a complete interface for
creating and querying prims for primvars.
The only way to create a new Primvar in scene description is by
calling UsdGeomPrimvarsAPI::CreatePrimvar() . One
cannot”enhance”or”promote”an already existing attribute into a
Primvar, because doing so may require a namespace edit to rename the
attribute, which cannot, in general, be done within a single
UsdEditContext. Instead, create a new UsdGeomPrimvar of the desired
name using UsdGeomPrimvarsAPI::CreatePrimvar() , and then copy the
existing attribute onto the new UsdGeomPrimvar.
Primvar names can contain arbitrary sub-namespaces. The behavior of
UsdGeomImageable::GetPrimvar(TfToken const & name) is to
prepend”primvars:”onto’name’if it is not already a prefix, and return
the result, which means we do not have any ambiguity between the
primvars”primvars:nsA:foo”and”primvars:nsB:foo”. There are reserved
keywords that may not be used as the base names of primvars, and
attempting to create Primvars of these names will result in a coding
error. The reserved keywords are tokens the Primvar uses internally to
encode various features, such as the”indices”keyword used by Indexed
Primvars.
If a client wishes to access an already-extant attribute as a Primvar,
(which may or may not actually be valid Primvar), they can use the
speculative constructor; typically, a primvar is only”interesting”if
it additionally provides a value. This might look like:
UsdGeomPrimvar primvar = UsdGeomPrimvar(usdAttr);
if (primvar.HasValue()) {
VtValue values;
primvar.Get(&values, timeCode);
TfToken interpolation = primvar.GetInterpolation();
int elementSize = primvar.GetElementSize();
\.\.\.
}
or, because Get() returns true if and only if it found a value:
UsdGeomPrimvar primvar = UsdGeomPrimvar(usdAttr);
VtValue values;
if (primvar.Get(&values, timeCode)) {
TfToken interpolation = primvar.GetInterpolation();
int elementSize = primvar.GetElementSize();
\.\.\.
}
As discussed in greater detail in Indexed Primvars, primvars can
optionally contain a (possibly time-varying) indexing attribute that
establishes a sharing topology for elements of the primvar. Consumers
can always chose to ignore the possibility of indexed data by
exclusively using the ComputeFlattened() API. If a client wishes to
preserve indexing in their processing of a primvar, we suggest a
pattern like the following, which accounts for the fact that a
stronger layer can block a primvar’s indexing from a weaker layer, via
UsdGeomPrimvar::BlockIndices() :
VtValue values;
VtIntArray indices;
if (primvar.Get(&values, timeCode)){
if (primvar.GetIndices(&indices, timeCode)){
// primvar is indexed: validate/process values and indices together
}
else {
// primvar is not indexed: validate/process values as flat array
}
}
UsdGeomPrimvar presents a small slice of the UsdAttribute API - enough
to extract the data that comprises the”Declaration info”, and get/set
of the attribute value. A UsdGeomPrimvar also auto-converts to
UsdAttribute, so you can pass a UsdGeomPrimvar to any function that
accepts a UsdAttribute or const-ref thereto.
## Primvar Allowed Scene Description Types and Plurality
There are no limitations imposed on the allowable scene description
types for Primvars; it is the responsibility of each consuming client
to perform renderer-specific conversions, if need be (the USD
distribution will include reference RenderMan conversion utilities).
A note about type plurality of Primvars: It is legitimate for a
Primvar to be of scalar or array type, and again, consuming clients
must be prepared to accommodate both. However, while it is not
possible, in all cases, for USD to prevent one from changing the
type of an attribute in different layers or variants of an asset, it
is never a good idea to do so. This is relevant because, except in a
few special cases, it is not possible to encode an interpolation of
any value greater than constant without providing multiple (i.e.
array) data values. Therefore, if there is any possibility that
downstream clients might need to change a Primvar’s interpolation, the
Primvar-creator should encode it as an array rather than a scalar.
Why allow scalar values at all, then? First, sometimes it brings
clarity to (use of) a shader’s API to acknowledge that some parameters
are meant to be single-valued over a shaded primitive. Second, many
DCC’s provide far richer affordances for editing scalars than they do
array values, and we feel it is safer to let the content creator make
the decision/tradeoff of which kind of flexibility is more relevant,
rather than leaving it to an importer/exporter pair to interpret.
Also, like all attributes, Primvars can be time-sampled, and values
can be authored and consumed just as any other attribute. There is
currently no validation that the length of value arrays matches to the
size required by a gprim’s topology, interpolation, and elementSize.
For consumer convenience, we provide GetDeclarationInfo() , which
returns all the type information (other than topology) needed to
compute the required array size, which is also all the information
required to prepare the Primvar’s value for consumption by a renderer.
## Lifetime Management and Primvar Validity
UsdGeomPrimvar has an explicit bool operator that validates that the
attribute IsDefined() and thus valid for querying and authoring values
and metadata. This is a fairly expensive query that we do not
cache, so if client code retains UsdGeomPrimvar objects, it should
manage its object validity closely, for performance. An ideal pattern
is to listen for UsdNotice::StageContentsChanged notifications, and
revalidate/refetch its retained UsdGeomPrimvar s only then, and
otherwise use them without validity checking.
## Interpolation of Geometric Primitive Variables
In the following explanation of the meaning of the various
kinds/levels of Primvar interpolation, each bolded bullet gives the
name of the token in UsdGeomTokens that provides the value. So to set
a Primvar’s interpolation to”varying”, one would:
primvar.SetInterpolation(UsdGeomTokens->varying);
Reprinted and adapted from the RPS documentation, which contains
further details, interpolation describes how the Primvar will be
interpolated over the uv parameter space of a surface primitive (or
curve or pointcloud). The possible values are:
constant One value remains constant over the entire surface
primitive.
uniform One value remains constant for each uv patch segment
of the surface primitive (which is a face for meshes).
varying Four values are interpolated over each uv patch
segment of the surface. Bilinear interpolation is used for
interpolation between the four values.
vertex Values are interpolated between each vertex in the
surface primitive. The basis function of the surface is used for
interpolation between vertices.
faceVarying For polygons and subdivision surfaces, four
values are interpolated over each face of the mesh. Bilinear
interpolation is used for interpolation between the four values.
## UsdGeomPrimvar As Example of Attribute Schema
Just as UsdSchemaBase and its subclasses provide the pattern for how
to layer schema onto the generic UsdPrim object, UsdGeomPrimvar
provides an example of how to layer schema onto a generic UsdAttribute
object. In both cases, the schema object wraps and contains the
UsdObject.
## Primvar Namespace Inheritance
Constant interpolation primvar values can be inherited down namespace.
That is, a primvar value set on a prim will also apply to any child
prims, unless those children have their own opinions about those named
primvars. For complete details on how primvars inherit, see
usdGeom_PrimvarInheritance.
UsdGeomImageable::FindInheritablePrimvars().
Methods:
BlockIndices()
Block the indices that were previously set.
ComputeFlattened
classmethod ComputeFlattened(value, time) -> bool
CreateIndicesAttr()
Returns the existing indices attribute if the primvar is indexed or creates a new one.
Get(value, time)
Get the attribute value of the Primvar at time .
GetAttr()
Explicit UsdAttribute extractor.
GetBaseName()
UsdAttribute::GetBaseName()
GetDeclarationInfo(name, typeName, ...)
Convenience function for fetching all information required to properly declare this Primvar.
GetElementSize()
Return the"element size"for this Primvar, which is 1 if unauthored.
GetIndices(indices, time)
Returns the value of the indices array associated with the indexed primvar at time .
GetIndicesAttr()
Returns a valid indices attribute if the primvar is indexed.
GetInterpolation()
Return the Primvar's interpolation, which is UsdGeomTokens->constant if unauthored.
GetName()
UsdAttribute::GetName()
GetNamespace()
UsdAttribute::GetNamespace()
GetPrimvarName()
Returns the primvar's name, devoid of the"primvars:"namespace.
GetTimeSamples(times)
Populates a vector with authored sample times for this primvar.
GetTimeSamplesInInterval(interval, times)
Populates a vector with authored sample times in interval .
GetTypeName()
UsdAttribute::GetTypeName()
GetUnauthoredValuesIndex()
Returns the index that represents unauthored values in the indices array.
HasAuthoredElementSize()
Has elementSize been explicitly authored on this Primvar?
HasAuthoredInterpolation()
Has interpolation been explicitly authored on this Primvar?
HasAuthoredValue()
Return true if the underlying attribute has an unblocked, authored value.
HasValue()
Return true if the underlying attribute has a value, either from authored scene description or a fallback.
IsDefined()
Return true if the underlying UsdAttribute::IsDefined() , and in addition the attribute is identified as a Primvar.
IsIdTarget()
Returns true if the primvar is an Id primvar.
IsIndexed()
Returns true if the primvar is indexed, i.e., if it has an associated"indices"attribute.
IsPrimvar
classmethod IsPrimvar(attr) -> bool
IsValidInterpolation
classmethod IsValidInterpolation(interpolation) -> bool
IsValidPrimvarName
classmethod IsValidPrimvarName(name) -> bool
NameContainsNamespaces()
Does this primvar contain any namespaces other than the"primvars:"namespace?
Set(value, time)
Set the attribute value of the Primvar at time .
SetElementSize(eltSize)
Set the elementSize for this Primvar.
SetIdTarget(path)
This primvar must be of String or StringArray type for this method to succeed.
SetIndices(indices, time)
Sets the indices value of the indexed primvar at time .
SetInterpolation(interpolation)
Set the Primvar's interpolation.
SetUnauthoredValuesIndex(unauthoredValuesIndex)
Set the index that represents unauthored values in the indices array.
SplitName()
UsdAttribute::SplitName()
StripPrimvarsName
classmethod StripPrimvarsName(name) -> str
ValueMightBeTimeVarying()
Return true if it is possible, but not certain, that this primvar's value changes over time, false otherwise.
BlockIndices() → None
Block the indices that were previously set.
This effectively makes an indexed primvar no longer indexed. This is
useful when overriding an existing primvar.
ComputeFlattened()
classmethod ComputeFlattened(value, time) -> bool
Computes the flattened value of the primvar at time .
If the primvar is not indexed or if the value type of this primvar is
a scalar, this returns the authored value, which is the same as Get()
. Hence, it’s safe to call ComputeFlattened() on non-indexed primvars.
Parameters
value (VtArray[ScalarType]) –
time (TimeCode) –
ComputeFlattened(value, time) -> bool
This is an overloaded member function, provided for convenience. It
differs from the above function only in what argument(s) it accepts.
Computes the flattened value of the primvar at time as a VtValue.
If the primvar is not indexed or if the value type of this primvar is
a scalar, this returns the authored value, which is the same as Get()
. Hence, it’s safe to call ComputeFlattened() on non-indexed primvars.
Parameters
value (VtValue) –
time (TimeCode) –
ComputeFlattened(value, attrVal, indices, errString) -> bool
Computes the flattened value of attrValue given indices .
This method is a static convenience function that performs the main
work of ComputeFlattened above without needing an instance of a
UsdGeomPrimvar.
Returns false if the value contained in attrVal is not a
supported type for flattening. Otherwise returns true . The output
errString variable may be populated with an error string if an
error is encountered during flattening.
Parameters
value (VtValue) –
attrVal (VtValue) –
indices (IntArray) –
errString (str) –
CreateIndicesAttr() → Attribute
Returns the existing indices attribute if the primvar is indexed or
creates a new one.
Get(value, time) → bool
Get the attribute value of the Primvar at time .
Usd_Handling_Indexed_Primvars for proper handling of indexed primvars
Parameters
value (T) –
time (TimeCode) –
Get(value, time) -> bool
Parameters
value (str) –
time (TimeCode) –
Get(value, time) -> bool
Parameters
value (StringArray) –
time (TimeCode) –
Get(value, time) -> bool
Parameters
value (VtValue) –
time (TimeCode) –
GetAttr() → Attribute
Explicit UsdAttribute extractor.
GetBaseName() → str
UsdAttribute::GetBaseName()
GetDeclarationInfo(name, typeName, interpolation, elementSize) → None
Convenience function for fetching all information required to properly
declare this Primvar.
The name returned is the”client name”, stripped of
the”primvars”namespace, i.e. equivalent to GetPrimvarName()
May also be more efficient than querying key individually.
Parameters
name (str) –
typeName (ValueTypeName) –
interpolation (str) –
elementSize (int) –
GetElementSize() → int
Return the”element size”for this Primvar, which is 1 if unauthored.
If this Primvar’s type is not an array type, (e.g.”Vec3f[]”), then
elementSize is irrelevant.
ElementSize does not generally encode the length of an array-type
primvar, and rarely needs to be authored. ElementSize can be thought
of as a way to create an”aggregate interpolatable type”, by dictating
how many consecutive elements in the value array should be taken as an
atomic element to be interpolated over a gprim.
For example, spherical harmonics are often represented as a collection
of nine floating-point coefficients, and the coefficients need to be
sampled across a gprim’s surface: a perfect case for primvars.
However, USD has no float9 datatype. But we can communicate the
aggregation of nine floats successfully to renderers by declaring a
simple float-array valued primvar, and setting its elementSize to 9.
To author a uniform spherical harmonic primvar on a Mesh of 42
faces, the primvar’s array value would contain 9*42 = 378 float
elements.
GetIndices(indices, time) → bool
Returns the value of the indices array associated with the indexed
primvar at time .
SetIndices() , Proper Client Handling of”Indexed”Primvars
Parameters
indices (IntArray) –
time (TimeCode) –
GetIndicesAttr() → Attribute
Returns a valid indices attribute if the primvar is indexed.
Returns an invalid attribute otherwise.
GetInterpolation() → str
Return the Primvar’s interpolation, which is UsdGeomTokens->constant
if unauthored.
Interpolation determines how the Primvar interpolates over a geometric
primitive. See Interpolation of Geometric Primitive Variables
GetName() → str
UsdAttribute::GetName()
GetNamespace() → str
UsdAttribute::GetNamespace()
GetPrimvarName() → str
Returns the primvar’s name, devoid of the”primvars:”namespace.
This is the name by which clients should refer to the primvar, if not
by its full attribute name - i.e. they should not, in general, use
GetBaseName() . In the error condition in which this Primvar object is
not backed by a properly namespaced UsdAttribute, return an empty
TfToken.
GetTimeSamples(times) → bool
Populates a vector with authored sample times for this primvar.
Returns false on error.
This considers any timeSamples authored on the
associated”indices”attribute if the primvar is indexed.
UsdAttribute::GetTimeSamples
Parameters
times (list[float]) –
GetTimeSamplesInInterval(interval, times) → bool
Populates a vector with authored sample times in interval .
This considers any timeSamples authored on the
associated”indices”attribute if the primvar is indexed.
UsdAttribute::GetTimeSamplesInInterval
Parameters
interval (Interval) –
times (list[float]) –
GetTypeName() → ValueTypeName
UsdAttribute::GetTypeName()
GetUnauthoredValuesIndex() → int
Returns the index that represents unauthored values in the indices
array.
SetUnauthoredValuesIndex()
HasAuthoredElementSize() → bool
Has elementSize been explicitly authored on this Primvar?
GetElementSize()
HasAuthoredInterpolation() → bool
Has interpolation been explicitly authored on this Primvar?
GetInterpolationSize()
HasAuthoredValue() → bool
Return true if the underlying attribute has an unblocked, authored
value.
HasValue() → bool
Return true if the underlying attribute has a value, either from
authored scene description or a fallback.
IsDefined() → bool
Return true if the underlying UsdAttribute::IsDefined() , and in
addition the attribute is identified as a Primvar.
Does not imply that the primvar provides a value
IsIdTarget() → bool
Returns true if the primvar is an Id primvar.
UsdGeomPrimvar_Id_primvars
IsIndexed() → bool
Returns true if the primvar is indexed, i.e., if it has an
associated”indices”attribute.
If you are going to query the indices anyways, prefer to simply
consult the return-value of GetIndices() , which will be more
efficient.
static IsPrimvar()
classmethod IsPrimvar(attr) -> bool
Test whether a given UsdAttribute represents valid Primvar, which
implies that creating a UsdGeomPrimvar from the attribute will
succeed.
Success implies that attr.IsDefined() is true.
Parameters
attr (Attribute) –
static IsValidInterpolation()
classmethod IsValidInterpolation(interpolation) -> bool
Validate that the provided interpolation is a valid setting for
interpolation as defined by Interpolation of Geometric Primitive
Variables.
Parameters
interpolation (str) –
static IsValidPrimvarName()
classmethod IsValidPrimvarName(name) -> bool
Test whether a given name represents a valid name of a primvar,
which implies that creating a UsdGeomPrimvar with the given name will
succeed.
Parameters
name (str) –
NameContainsNamespaces() → bool
Does this primvar contain any namespaces other than
the”primvars:”namespace?
Some clients may only wish to consume primvars that have no extra
namespaces in their names, for ease of translating to other systems
that do not allow namespaces.
Set(value, time) → bool
Set the attribute value of the Primvar at time .
Parameters
value (T) –
time (TimeCode) –
SetElementSize(eltSize) → bool
Set the elementSize for this Primvar.
Errors and returns false if eltSize less than 1.
GetElementSize()
Parameters
eltSize (int) –
SetIdTarget(path) → bool
This primvar must be of String or StringArray type for this method to
succeed.
If not, a coding error is raised.
UsdGeomPrimvar_Id_primvars
Parameters
path (Path) –
SetIndices(indices, time) → bool
Sets the indices value of the indexed primvar at time .
The values in the indices array must be valid indices into the
authored array returned by Get() . The element numerality of the
primvar’s’interpolation’metadata applies to the”indices”array, not the
attribute value array (returned by Get() ).
Parameters
indices (IntArray) –
time (TimeCode) –
SetInterpolation(interpolation) → bool
Set the Primvar’s interpolation.
Errors and returns false if interpolation is out of range as
defined by IsValidInterpolation() . No attempt is made to validate
that the Primvar’s value contains the right number of elements to
match its interpolation to its topology.
GetInterpolation() , Interpolation of Geometric Primitive Variables
Parameters
interpolation (str) –
SetUnauthoredValuesIndex(unauthoredValuesIndex) → bool
Set the index that represents unauthored values in the indices array.
Some apps (like Maya) allow you to author primvars sparsely over a
surface. Since most apps can’t handle sparse primvars, Maya needs to
provide a value even for the elements it didn’t author. This metadatum
provides a way to recover the information in apps that do support
sparse authoring / representation of primvars.
The fallback value of unauthoredValuesIndex is -1, which indicates
that there are no unauthored values.
GetUnauthoredValuesIndex()
Parameters
unauthoredValuesIndex (int) –
SplitName() → list[str]
UsdAttribute::SplitName()
static StripPrimvarsName()
classmethod StripPrimvarsName(name) -> str
Returns the name , devoid of the”primvars:”token if present,
otherwise returns the name unchanged.
Parameters
name (str) –
ValueMightBeTimeVarying() → bool
Return true if it is possible, but not certain, that this primvar’s
value changes over time, false otherwise.
This considers time-varyingness of the associated”indices”attribute if
the primvar is indexed.
UsdAttribute::ValueMightBeTimeVarying
class pxr.UsdGeom.PrimvarsAPI
UsdGeomPrimvarsAPI encodes geometric”primitive variables”, as
UsdGeomPrimvar, which interpolate across a primitive’s topology, can
override shader inputs, and inherit down namespace.
## Which Method to Use to Retrieve Primvars
While creating primvars is unambiguous ( CreatePrimvar() ), there are
quite a few methods available for retrieving primvars, making it
potentially confusing knowing which one to use. Here are some
guidelines:
If you are populating a GUI with the primvars already available
for authoring values on a prim, use GetPrimvars() .
If you want all of the”useful”(e.g. to a renderer) primvars
available at a prim, including those inherited from ancestor prims,
use FindPrimvarsWithInheritance() . Note that doing so individually
for many prims will be inefficient.
To find a particular primvar defined directly on a prim, which
may or may not provide a value, use GetPrimvar() .
To find a particular primvar defined on a prim or inherited from
ancestors, which may or may not provide a value, use
FindPrimvarWithInheritance() .
To efficiently query for primvars using the overloads of
FindPrimvarWithInheritance() and FindPrimvarsWithInheritance() , one
must first cache the results of FindIncrementallyInheritablePrimvars()
for each non-leaf prim on the stage.
Methods:
BlockPrimvar(name)
Remove all time samples on the primvar and its associated indices attr, and author a block default value.
CanContainPropertyName
classmethod CanContainPropertyName(name) -> bool
CreateIndexedPrimvar(name, typeName, value, ...)
Author scene description to create an attribute and authoring a value on this prim that will be recognized as an indexed Primvar with indices appropriately set (i.e.
CreateNonIndexedPrimvar(name, typeName, ...)
Author scene description to create an attribute and authoring a value on this prim that will be recognized as a Primvar (i.e.
CreatePrimvar(name, typeName, interpolation, ...)
Author scene description to create an attribute on this prim that will be recognized as Primvar (i.e.
FindIncrementallyInheritablePrimvars(...)
Compute the primvars that can be inherited from this prim by its child prims, starting from the set of primvars inherited from this prim's ancestors.
FindInheritablePrimvars()
Compute the primvars that can be inherited from this prim by its child prims, including the primvars that this prim inherits from ancestor prims.
FindPrimvarWithInheritance(name)
Like GetPrimvar() , but if the named primvar does not exist or has no authored value on this prim, search for the named, value-producing primvar on ancestor prims.
FindPrimvarsWithInheritance()
Find all of the value-producing primvars either defined on this prim, or inherited from ancestor prims.
Get
classmethod Get(stage, path) -> PrimvarsAPI
GetAuthoredPrimvars()
Like GetPrimvars() , but include only primvars that have some authored scene description (though not necessarily a value).
GetPrimvar(name)
Return the Primvar object named by name , which will be valid if a Primvar attribute definition already exists.
GetPrimvars()
Return valid UsdGeomPrimvar objects for all defined Primvars on this prim, similarly to UsdPrim::GetAttributes() .
GetPrimvarsWithAuthoredValues()
Like GetPrimvars() , but include only primvars that have an authored value.
GetPrimvarsWithValues()
Like GetPrimvars() , but include only primvars that have some value, whether it comes from authored scene description or a schema fallback.
GetSchemaAttributeNames
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
HasPossiblyInheritedPrimvar(name)
Is there a Primvar named name with an authored value on this prim or any of its ancestors?
HasPrimvar(name)
Is there a defined Primvar name on this prim?
RemovePrimvar(name)
Author scene description to delete an attribute on this prim that was recognized as Primvar (i.e.
BlockPrimvar(name) → None
Remove all time samples on the primvar and its associated indices
attr, and author a block default value.
This will cause authored opinions in weaker layers to be ignored.
UsdAttribute::Block() , UsdGeomPrimvar::BlockIndices
Parameters
name (str) –
static CanContainPropertyName()
classmethod CanContainPropertyName(name) -> bool
Test whether a given name contains the”primvars:”prefix.
Parameters
name (str) –
CreateIndexedPrimvar(name, typeName, value, indices, interpolation, elementSize, time) → Primvar
Author scene description to create an attribute and authoring a
value on this prim that will be recognized as an indexed Primvar
with indices appropriately set (i.e.
will present as a valid UsdGeomPrimvar).
an invalid UsdGeomPrimvar on error, a valid UsdGeomPrimvar otherwise.
It is fine to call this method multiple times, and in different
UsdEditTargets, even if there is an existing primvar of the same name,
indexed or not.
CreatePrimvar() , CreateNonIndexedPrimvar() ,
UsdPrim::CreateAttribute() , UsdGeomPrimvar::IsPrimvar()
Parameters
name (str) –
typeName (ValueTypeName) –
value (T) –
indices (IntArray) –
interpolation (str) –
elementSize (int) –
time (TimeCode) –
CreateNonIndexedPrimvar(name, typeName, value, interpolation, elementSize, time) → Primvar
Author scene description to create an attribute and authoring a
value on this prim that will be recognized as a Primvar (i.e.
will present as a valid UsdGeomPrimvar). Note that unlike
CreatePrimvar using this API explicitly authors a block for the
indices attr associated with the primvar, thereby blocking any indices
set in any weaker layers.
an invalid UsdGeomPrimvar on error, a valid UsdGeomPrimvar otherwise.
It is fine to call this method multiple times, and in different
UsdEditTargets, even if there is an existing primvar of the same name,
indexed or not.
CreatePrimvar() , CreateIndexedPrimvar() , UsdPrim::CreateAttribute()
, UsdGeomPrimvar::IsPrimvar()
Parameters
name (str) –
typeName (ValueTypeName) –
value (T) –
interpolation (str) –
elementSize (int) –
time (TimeCode) –
CreatePrimvar(name, typeName, interpolation, elementSize) → Primvar
Author scene description to create an attribute on this prim that will
be recognized as Primvar (i.e.
will present as a valid UsdGeomPrimvar).
The name of the created attribute may or may not be the specified
name , due to the possible need to apply property namespacing for
primvars. See Creating and Accessing Primvars for more information.
Creation may fail and return an invalid Primvar if name contains a
reserved keyword, such as the”indices”suffix we use for indexed
primvars.
The behavior with respect to the provided typeName is the same as
for UsdAttributes::Create(), and interpolation and elementSize
are as described in UsdGeomPrimvar::GetInterpolation() and
UsdGeomPrimvar::GetElementSize() .
If interpolation and/or elementSize are left unspecified, we
will author no opinions for them, which means any (strongest) opinion
already authored in any contributing layer for these fields will
become the Primvar’s values, or the fallbacks if no opinions have been
authored.
an invalid UsdGeomPrimvar if we failed to create a valid attribute, a
valid UsdGeomPrimvar otherwise. It is not an error to create over an
existing, compatible attribute.
UsdPrim::CreateAttribute() , UsdGeomPrimvar::IsPrimvar()
Parameters
name (str) –
typeName (ValueTypeName) –
interpolation (str) –
elementSize (int) –
FindIncrementallyInheritablePrimvars(inheritedFromAncestors) → list[Primvar]
Compute the primvars that can be inherited from this prim by its child
prims, starting from the set of primvars inherited from this prim’s
ancestors.
If this method returns an empty vector, then this prim’s children
should inherit the same set of primvars available to this prim, i.e.
the input inheritedFromAncestors .
As opposed to FindInheritablePrimvars() , which always recurses up
through all of the prim’s ancestors, this method allows more efficient
computation of inheritable primvars by starting with the list of
primvars inherited from this prim’s ancestors, and returning a newly
allocated vector only when this prim makes a change to the set of
inherited primvars. This enables O(n) inherited primvar computation
for all prims on a Stage, with potential to share computed results
that are identical (i.e. when this method returns an empty vector, its
parent’s result can (and must!) be reused for all of the prim’s
children.
Which Method to Use to Retrieve Primvars
Parameters
inheritedFromAncestors (list[Primvar]) –
FindInheritablePrimvars() → list[Primvar]
Compute the primvars that can be inherited from this prim by its child
prims, including the primvars that this prim inherits from
ancestor prims.
Inherited primvars will be bound to attributes on the corresponding
ancestor prims.
Only primvars with authored, non-blocked, constant
interpolation values are inheritable; fallback values are not
inherited. The order of the returned primvars is undefined.
It is not generally useful to call this method on UsdGeomGprim leaf
prims, and furthermore likely to be expensive since most primvars
are defined on Gprims.
Which Method to Use to Retrieve Primvars
FindPrimvarWithInheritance(name) → Primvar
Like GetPrimvar() , but if the named primvar does not exist or has no
authored value on this prim, search for the named, value-producing
primvar on ancestor prims.
The returned primvar will be bound to the attribute on the
corresponding ancestor prim on which it was found (if any). If neither
this prim nor any ancestor contains a value-producing primvar, then
the returned primvar will be the same as that returned by GetPrimvar()
.
This is probably the method you want to call when needing to consume a
primvar of a particular name.
Which Method to Use to Retrieve Primvars
Parameters
name (str) –
FindPrimvarWithInheritance(name, inheritedFromAncestors) -> Primvar
This is an overloaded member function, provided for convenience. It
differs from the above function only in what argument(s) it accepts.
This version of FindPrimvarWithInheritance() takes the pre-computed
set of primvars inherited from this prim’s ancestors, as computed by
FindInheritablePrimvars() or FindIncrementallyInheritablePrimvars() on
the prim’s parent.
Which Method to Use to Retrieve Primvars
Parameters
name (str) –
inheritedFromAncestors (list[Primvar]) –
FindPrimvarsWithInheritance() → list[Primvar]
Find all of the value-producing primvars either defined on this prim,
or inherited from ancestor prims.
Which Method to Use to Retrieve Primvars
FindPrimvarsWithInheritance(inheritedFromAncestors) -> list[Primvar]
This is an overloaded member function, provided for convenience. It
differs from the above function only in what argument(s) it accepts.
This version of FindPrimvarsWithInheritance() takes the pre-computed
set of primvars inherited from this prim’s ancestors, as computed by
FindInheritablePrimvars() or FindIncrementallyInheritablePrimvars() on
the prim’s parent.
Which Method to Use to Retrieve Primvars
Parameters
inheritedFromAncestors (list[Primvar]) –
static Get()
classmethod Get(stage, path) -> PrimvarsAPI
Return a UsdGeomPrimvarsAPI holding the prim adhering to this schema
at path on stage .
If no prim exists at path on stage , or if the prim at that
path does not adhere to this schema, return an invalid schema object.
This is shorthand for the following:
UsdGeomPrimvarsAPI(stage->GetPrimAtPath(path));
Parameters
stage (Stage) –
path (Path) –
GetAuthoredPrimvars() → list[Primvar]
Like GetPrimvars() , but include only primvars that have some authored
scene description (though not necessarily a value).
Which Method to Use to Retrieve Primvars
GetPrimvar(name) → Primvar
Return the Primvar object named by name , which will be valid if a
Primvar attribute definition already exists.
Name lookup will account for Primvar namespacing, which means that
this method will succeed in some cases where
UsdGeomPrimvar(prim->GetAttribute(name))
will not, unless ``name`` is properly namespace prefixed.
Just because a Primvar is valid and defined, and even if its
underlying UsdAttribute (GetAttr()) answers HasValue() affirmatively,
one must still check the return value of Get() , due to the potential
of time-varying value blocks (see Attribute Value Blocking).
HasPrimvar() , Which Method to Use to Retrieve Primvars
Parameters
name (str) –
GetPrimvars() → list[Primvar]
Return valid UsdGeomPrimvar objects for all defined Primvars on this
prim, similarly to UsdPrim::GetAttributes() .
The returned primvars may not possess any values, and therefore not be
useful to some clients. For the primvars useful for inheritance
computations, see GetPrimvarsWithAuthoredValues() , and for primvars
useful for direct consumption, see GetPrimvarsWithValues() .
Which Method to Use to Retrieve Primvars
GetPrimvarsWithAuthoredValues() → list[Primvar]
Like GetPrimvars() , but include only primvars that have an
authored value.
This is the query used when computing inheritable primvars, and is
generally more useful than GetAuthoredPrimvars() .
Which Method to Use to Retrieve Primvars
GetPrimvarsWithValues() → list[Primvar]
Like GetPrimvars() , but include only primvars that have some value,
whether it comes from authored scene description or a schema fallback.
For most purposes, this method is more useful than GetPrimvars() .
Which Method to Use to Retrieve Primvars
static GetSchemaAttributeNames()
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
Return a vector of names of all pre-declared attributes for this
schema class and all its ancestor classes.
Does not include attributes that may be authored by custom/extended
methods of the schemas involved.
Parameters
includeInherited (bool) –
HasPossiblyInheritedPrimvar(name) → bool
Is there a Primvar named name with an authored value on this prim
or any of its ancestors?
This is probably the method you want to call when wanting to know
whether or not the prim”has”a primvar of a particular name.
FindPrimvarWithInheritance()
Parameters
name (str) –
HasPrimvar(name) → bool
Is there a defined Primvar name on this prim?
Name lookup will account for Primvar namespacing.
Like GetPrimvar() , a return value of true for HasPrimvar() does
not guarantee the primvar will produce a value.
Parameters
name (str) –
RemovePrimvar(name) → bool
Author scene description to delete an attribute on this prim that was
recognized as Primvar (i.e.
will present as a valid UsdGeomPrimvar), in the current
UsdEditTarget.
Because this method can only remove opinions about the primvar from
the current EditTarget, you may generally find it more useful to use
BlockPrimvar() which will ensure that all values from the EditTarget
and weaker layers for the primvar and its indices will be ignored.
Removal may fail and return false if name contains a reserved
keyword, such as the”indices”suffix we use for indexed primvars.
Note this will also remove the indices attribute associated with an
indiced primvar.
true if UsdGeomPrimvar and indices attribute was successfully removed,
false otherwise.
UsdPrim::RemoveProperty() )
Parameters
name (str) –
class pxr.UsdGeom.Scope
Scope is the simplest grouping primitive, and does not carry the
baggage of transformability. Note that transforms should inherit down
through a Scope successfully - it is just a guaranteed no-op from a
transformability perspective.
Methods:
Define
classmethod Define(stage, path) -> Scope
Get
classmethod Get(stage, path) -> Scope
GetSchemaAttributeNames
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
static Define()
classmethod Define(stage, path) -> Scope
Attempt to ensure a UsdPrim adhering to this schema at path is
defined (according to UsdPrim::IsDefined() ) on this stage.
If a prim adhering to this schema at path is already defined on
this stage, return that prim. Otherwise author an SdfPrimSpec with
specifier == SdfSpecifierDef and this schema’s prim type name for
the prim at path at the current EditTarget. Author SdfPrimSpec s
with specifier == SdfSpecifierDef and empty typeName at the
current EditTarget for any nonexistent, or existing but not Defined
ancestors.
The given path must be an absolute prim path that does not contain
any variant selections.
If it is impossible to author any of the necessary PrimSpecs, (for
example, in case path cannot map to the current UsdEditTarget ‘s
namespace) issue an error and return an invalid UsdPrim.
Note that this method may return a defined prim whose typeName does
not specify this schema class, in case a stronger typeName opinion
overrides the opinion at the current EditTarget.
Parameters
stage (Stage) –
path (Path) –
static Get()
classmethod Get(stage, path) -> Scope
Return a UsdGeomScope holding the prim adhering to this schema at
path on stage .
If no prim exists at path on stage , or if the prim at that
path does not adhere to this schema, return an invalid schema object.
This is shorthand for the following:
UsdGeomScope(stage->GetPrimAtPath(path));
Parameters
stage (Stage) –
path (Path) –
static GetSchemaAttributeNames()
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
Return a vector of names of all pre-declared attributes for this
schema class and all its ancestor classes.
Does not include attributes that may be authored by custom/extended
methods of the schemas involved.
Parameters
includeInherited (bool) –
class pxr.UsdGeom.Sphere
Defines a primitive sphere centered at the origin.
The fallback values for Cube, Sphere, Cone, and Cylinder are set so
that they all pack into the same volume/bounds.
Methods:
CreateExtentAttr(defaultValue, writeSparsely)
See GetExtentAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateRadiusAttr(defaultValue, writeSparsely)
See GetRadiusAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
Define
classmethod Define(stage, path) -> Sphere
Get
classmethod Get(stage, path) -> Sphere
GetExtentAttr()
Extent is re-defined on Sphere only to provide a fallback value.
GetRadiusAttr()
Indicates the sphere's radius.
GetSchemaAttributeNames
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
CreateExtentAttr(defaultValue, writeSparsely) → Attribute
See GetExtentAttr() , and also Create vs Get Property Methods for when
to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateRadiusAttr(defaultValue, writeSparsely) → Attribute
See GetRadiusAttr() , and also Create vs Get Property Methods for when
to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
static Define()
classmethod Define(stage, path) -> Sphere
Attempt to ensure a UsdPrim adhering to this schema at path is
defined (according to UsdPrim::IsDefined() ) on this stage.
If a prim adhering to this schema at path is already defined on
this stage, return that prim. Otherwise author an SdfPrimSpec with
specifier == SdfSpecifierDef and this schema’s prim type name for
the prim at path at the current EditTarget. Author SdfPrimSpec s
with specifier == SdfSpecifierDef and empty typeName at the
current EditTarget for any nonexistent, or existing but not Defined
ancestors.
The given path must be an absolute prim path that does not contain
any variant selections.
If it is impossible to author any of the necessary PrimSpecs, (for
example, in case path cannot map to the current UsdEditTarget ‘s
namespace) issue an error and return an invalid UsdPrim.
Note that this method may return a defined prim whose typeName does
not specify this schema class, in case a stronger typeName opinion
overrides the opinion at the current EditTarget.
Parameters
stage (Stage) –
path (Path) –
static Get()
classmethod Get(stage, path) -> Sphere
Return a UsdGeomSphere holding the prim adhering to this schema at
path on stage .
If no prim exists at path on stage , or if the prim at that
path does not adhere to this schema, return an invalid schema object.
This is shorthand for the following:
UsdGeomSphere(stage->GetPrimAtPath(path));
Parameters
stage (Stage) –
path (Path) –
GetExtentAttr() → Attribute
Extent is re-defined on Sphere only to provide a fallback value.
UsdGeomGprim::GetExtentAttr() .
Declaration
float3[] extent = [(-1, -1, -1), (1, 1, 1)]
C++ Type
VtArray<GfVec3f>
Usd Type
SdfValueTypeNames->Float3Array
GetRadiusAttr() → Attribute
Indicates the sphere’s radius.
If you author radius you must also author extent.
GetExtentAttr()
Declaration
double radius = 1
C++ Type
double
Usd Type
SdfValueTypeNames->Double
static GetSchemaAttributeNames()
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
Return a vector of names of all pre-declared attributes for this
schema class and all its ancestor classes.
Does not include attributes that may be authored by custom/extended
methods of the schemas involved.
Parameters
includeInherited (bool) –
class pxr.UsdGeom.Subset
Encodes a subset of a piece of geometry (i.e. a UsdGeomImageable) as a
set of indices. Currently only supports encoding of face-subsets, but
could be extended in the future to support subsets representing edges,
segments, points etc.
To apply to a geometric prim, a GeomSubset prim must be the prim’s
direct child in namespace, and possess a concrete defining specifier
(i.e. def). This restriction makes it easy and efficient to discover
subsets of a prim. We might want to relax this restriction if it’s
common to have multiple families of subsets on a gprim and if it’s
useful to be able to organize subsets belonging to a family under a
common scope. See’familyName’attribute for more info on defining a
family of subsets.
Note that a GeomSubset isn’t an imageable (i.e. doesn’t derive from
UsdGeomImageable). So, you can’t author visibility for it or
override its purpose.
Materials are bound to GeomSubsets just as they are for regular
geometry using API available in UsdShade (UsdShadeMaterial::Bind).
For any described attribute Fallback Value or Allowed Values
below that are text/tokens, the actual token is published and defined
in UsdGeomTokens. So to set an attribute to the value”rightHanded”,
use UsdGeomTokens->rightHanded as the value.
Methods:
CreateElementTypeAttr(defaultValue, ...)
See GetElementTypeAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateFamilyNameAttr(defaultValue, writeSparsely)
See GetFamilyNameAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateGeomSubset
classmethod CreateGeomSubset(geom, subsetName, elementType, indices, familyName, familyType) -> Subset
CreateIndicesAttr(defaultValue, writeSparsely)
See GetIndicesAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateUniqueGeomSubset
classmethod CreateUniqueGeomSubset(geom, subsetName, elementType, indices, familyName, familyType) -> Subset
Define
classmethod Define(stage, path) -> Subset
Get
classmethod Get(stage, path) -> Subset
GetAllGeomSubsetFamilyNames
classmethod GetAllGeomSubsetFamilyNames(geom) -> str.Set
GetAllGeomSubsets
classmethod GetAllGeomSubsets(geom) -> list[Subset]
GetElementTypeAttr()
The type of element that the indices target.
GetFamilyNameAttr()
The name of the family of subsets that this subset belongs to.
GetFamilyType
classmethod GetFamilyType(geom, familyName) -> str
GetGeomSubsets
classmethod GetGeomSubsets(geom, elementType, familyName) -> list[Subset]
GetIndicesAttr()
The set of indices included in this subset.
GetSchemaAttributeNames
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
GetUnassignedIndices
classmethod GetUnassignedIndices(subsets, elementCount, time) -> IntArray
SetFamilyType
classmethod SetFamilyType(geom, familyName, familyType) -> bool
ValidateFamily
classmethod ValidateFamily(geom, elementType, familyName, reason) -> bool
ValidateSubsets
classmethod ValidateSubsets(subsets, elementCount, familyType, reason) -> bool
CreateElementTypeAttr(defaultValue, writeSparsely) → Attribute
See GetElementTypeAttr() , and also Create vs Get Property Methods for
when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateFamilyNameAttr(defaultValue, writeSparsely) → Attribute
See GetFamilyNameAttr() , and also Create vs Get Property Methods for
when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
static CreateGeomSubset()
classmethod CreateGeomSubset(geom, subsetName, elementType, indices, familyName, familyType) -> Subset
Creates a new GeomSubset below the given geom with the given name,
subsetName , element type, elementType and indices .
If a subset named subsetName already exists below geom , then
this updates its attributes with the values of the provided arguments
(indices value at time’default’will be updated) and returns it.
The family type is set / updated on geom only if a non-empty value
is passed in for familyType and familyName .
Parameters
geom (Imageable) –
subsetName (str) –
elementType (str) –
indices (IntArray) –
familyName (str) –
familyType (str) –
CreateIndicesAttr(defaultValue, writeSparsely) → Attribute
See GetIndicesAttr() , and also Create vs Get Property Methods for
when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
static CreateUniqueGeomSubset()
classmethod CreateUniqueGeomSubset(geom, subsetName, elementType, indices, familyName, familyType) -> Subset
Creates a new GeomSubset below the given imageable, geom with the
given name, subsetName , element type, elementType and
indices .
If a subset named subsetName already exists below geom , then
this creates a new subset by appending a suitable index as suffix to
subsetName (eg, subsetName_1) to avoid name collisions.
The family type is set / updated on geom only if a non-empty value
is passed in for familyType and familyName .
Parameters
geom (Imageable) –
subsetName (str) –
elementType (str) –
indices (IntArray) –
familyName (str) –
familyType (str) –
static Define()
classmethod Define(stage, path) -> Subset
Attempt to ensure a UsdPrim adhering to this schema at path is
defined (according to UsdPrim::IsDefined() ) on this stage.
If a prim adhering to this schema at path is already defined on
this stage, return that prim. Otherwise author an SdfPrimSpec with
specifier == SdfSpecifierDef and this schema’s prim type name for
the prim at path at the current EditTarget. Author SdfPrimSpec s
with specifier == SdfSpecifierDef and empty typeName at the
current EditTarget for any nonexistent, or existing but not Defined
ancestors.
The given path must be an absolute prim path that does not contain
any variant selections.
If it is impossible to author any of the necessary PrimSpecs, (for
example, in case path cannot map to the current UsdEditTarget ‘s
namespace) issue an error and return an invalid UsdPrim.
Note that this method may return a defined prim whose typeName does
not specify this schema class, in case a stronger typeName opinion
overrides the opinion at the current EditTarget.
Parameters
stage (Stage) –
path (Path) –
static Get()
classmethod Get(stage, path) -> Subset
Return a UsdGeomSubset holding the prim adhering to this schema at
path on stage .
If no prim exists at path on stage , or if the prim at that
path does not adhere to this schema, return an invalid schema object.
This is shorthand for the following:
UsdGeomSubset(stage->GetPrimAtPath(path));
Parameters
stage (Stage) –
path (Path) –
static GetAllGeomSubsetFamilyNames()
classmethod GetAllGeomSubsetFamilyNames(geom) -> str.Set
Returns the names of all the families of GeomSubsets defined on the
given imageable, geom .
Parameters
geom (Imageable) –
static GetAllGeomSubsets()
classmethod GetAllGeomSubsets(geom) -> list[Subset]
Returns all the GeomSubsets defined on the given imageable, geom .
Parameters
geom (Imageable) –
GetElementTypeAttr() → Attribute
The type of element that the indices target.
Currently only allows”face”and defaults to it.
Declaration
uniform token elementType ="face"
C++ Type
TfToken
Usd Type
SdfValueTypeNames->Token
Variability
SdfVariabilityUniform
Allowed Values
face
GetFamilyNameAttr() → Attribute
The name of the family of subsets that this subset belongs to.
This is optional and is primarily useful when there are multiple
families of subsets under a geometric prim. In some cases, this could
also be used for achieving proper roundtripping of subset data between
DCC apps. When multiple subsets belonging to a prim have the same
familyName, they are said to belong to the family. A familyType
value can be encoded on the owner of a family of subsets as a token
using the static method UsdGeomSubset::SetFamilyType()
.”familyType”can have one of the following values:
UsdGeomTokens->partition : implies that every element of the
whole geometry appears exactly once in only one of the subsets
belonging to the family.
UsdGeomTokens->nonOverlapping : an element that appears in
one subset may not appear in any other subset belonging to the family.
UsdGeomTokens->unrestricted : implies that there are no
restrictions w.r.t. the membership of elements in the subsets. They
could be overlapping and the union of all subsets in the family may
not represent the whole.
The validity of subset data is not enforced by the authoring APIs,
however they can be checked using UsdGeomSubset::ValidateFamily() .
Declaration
uniform token familyName =""
C++ Type
TfToken
Usd Type
SdfValueTypeNames->Token
Variability
SdfVariabilityUniform
static GetFamilyType()
classmethod GetFamilyType(geom, familyName) -> str
Returns the type of family that the GeomSubsets on the given geometric
prim geom , with the given family name, familyName belong to.
This only returns the token that’s encoded on geom and does not
perform any actual validation on the family of GeomSubsets. Please use
ValidateFamily() for such validation.
When familyType is not set on geom , the fallback value
UsdTokens->unrestricted is returned.
Parameters
geom (Imageable) –
familyName (str) –
static GetGeomSubsets()
classmethod GetGeomSubsets(geom, elementType, familyName) -> list[Subset]
Returns all the GeomSubsets of the given elementType belonging to
the specified family, familyName on the given imageable, geom
.
If elementType is empty, then subsets containing all element types
are returned. If familyName is left empty, then all subsets of the
specified elementType will be returned.
Parameters
geom (Imageable) –
elementType (str) –
familyName (str) –
GetIndicesAttr() → Attribute
The set of indices included in this subset.
The indices need not be sorted, but the same index should not appear
more than once.
Declaration
int[] indices = []
C++ Type
VtArray<int>
Usd Type
SdfValueTypeNames->IntArray
static GetSchemaAttributeNames()
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
Return a vector of names of all pre-declared attributes for this
schema class and all its ancestor classes.
Does not include attributes that may be authored by custom/extended
methods of the schemas involved.
Parameters
includeInherited (bool) –
static GetUnassignedIndices()
classmethod GetUnassignedIndices(subsets, elementCount, time) -> IntArray
Utility for getting the list of indices that are not assigned to any
of the GeomSubsets in subsets at the timeCode, time , given
the element count (total number of indices in the array being
subdivided), elementCount .
Parameters
subsets (list[Subset]) –
elementCount (int) –
time (TimeCode) –
static SetFamilyType()
classmethod SetFamilyType(geom, familyName, familyType) -> bool
This method is used to encode the type of family that the GeomSubsets
on the given geometric prim geom , with the given family name,
familyName belong to.
See UsdGeomSubset::GetFamilyNameAttr for the possible values for
familyType .
When a family of GeomSubsets is tagged as a UsdGeomTokens->partition
or UsdGeomTokens->nonOverlapping, the validity of the data (i.e.
mutual exclusivity and/or wholeness) is not enforced by the authoring
APIs. Use ValidateFamily() to validate the data in a family of
GeomSubsets.
Returns false upon failure to create or set the appropriate attribute
on geom .
Parameters
geom (Imageable) –
familyName (str) –
familyType (str) –
static ValidateFamily()
classmethod ValidateFamily(geom, elementType, familyName, reason) -> bool
Validates whether the family of subsets identified by the given
familyName and elementType on the given imageable, geom
contain valid data.
If the family is designated as a partition or as non-overlapping using
SetFamilyType() , then the validity of the data is checked. If the
familyType is”unrestricted”, then this performs only bounds checking
of the values in the”indices”arrays.
If reason is not None, then it is populated with a string
explaining why the family is invalid, if it is invalid.
The python version of this method returns a tuple containing a (bool,
string), where the bool has the validity of the family and the string
contains the reason (if it’s invalid).
Parameters
geom (Imageable) –
elementType (str) –
familyName (str) –
reason (str) –
static ValidateSubsets()
classmethod ValidateSubsets(subsets, elementCount, familyType, reason) -> bool
Validates the data in the given set of GeomSubsets, subsets ,
given the total number of elements in the array being subdivided,
elementCount and the familyType that the subsets belong to.
For proper validation of indices in subsets , all of the
GeomSubsets must have the same’elementType’.
If one or more subsets contain invalid data, then false is returned
and reason is populated with a string explaining the reason why it
is invalid.
The python version of this method returns a tuple containing a (bool,
string), where the bool has the validity of the subsets and the string
contains the reason (if they’re invalid).
Parameters
subsets (list[Subset]) –
elementCount (int) –
familyType (str) –
reason (str) –
class pxr.UsdGeom.Tokens
Attributes:
accelerations
all
angularVelocities
axis
basis
bezier
bilinear
boundaries
bounds
box
bspline
cards
catmullClark
catmullRom
clippingPlanes
clippingRange
closed
constant
cornerIndices
cornerSharpnesses
cornersOnly
cornersPlus1
cornersPlus2
creaseIndices
creaseLengths
creaseSharpnesses
cross
cubic
curveVertexCounts
default_
doubleSided
edgeAndCorner
edgeOnly
elementSize
elementType
exposure
extent
extentsHint
fStop
face
faceVarying
faceVaryingLinearInterpolation
faceVertexCounts
faceVertexIndices
familyName
focalLength
focusDistance
form
fromTexture
guide
guideVisibility
height
hermite
holeIndices
horizontalAperture
horizontalApertureOffset
ids
inactiveIds
indices
inherited
interpolateBoundary
interpolation
invisible
invisibleIds
knots
left
leftHanded
length
linear
loop
metersPerUnit
modelApplyDrawMode
modelCardGeometry
modelCardTextureXNeg
modelCardTextureXPos
modelCardTextureYNeg
modelCardTextureYPos
modelCardTextureZNeg
modelCardTextureZPos
modelDrawMode
modelDrawModeColor
mono
motionBlurScale
motionNonlinearSampleCount
motionVelocityScale
nonOverlapping
none
nonperiodic
normals
open
order
orientation
orientations
origin
orthographic
partition
periodic
perspective
pinned
pivot
pointWeights
points
positions
power
primvarsDisplayColor
primvarsDisplayOpacity
projection
protoIndices
prototypes
proxy
proxyPrim
proxyVisibility
purpose
radius
ranges
render
renderVisibility
right
rightHanded
scales
shutterClose
shutterOpen
size
smooth
stereoRole
subdivisionScheme
tangents
triangleSubdivisionRule
trimCurveCounts
trimCurveKnots
trimCurveOrders
trimCurvePoints
trimCurveRanges
trimCurveVertexCounts
type
uForm
uKnots
uOrder
uRange
uVertexCount
unauthoredValuesIndex
uniform
unrestricted
upAxis
vForm
vKnots
vOrder
vRange
vVertexCount
varying
velocities
vertex
verticalAperture
verticalApertureOffset
visibility
visible
width
widths
wrap
x
xformOpOrder
y
z
accelerations = 'accelerations'
all = 'all'
angularVelocities = 'angularVelocities'
axis = 'axis'
basis = 'basis'
bezier = 'bezier'
bilinear = 'bilinear'
boundaries = 'boundaries'
bounds = 'bounds'
box = 'box'
bspline = 'bspline'
cards = 'cards'
catmullClark = 'catmullClark'
catmullRom = 'catmullRom'
clippingPlanes = 'clippingPlanes'
clippingRange = 'clippingRange'
closed = 'closed'
constant = 'constant'
cornerIndices = 'cornerIndices'
cornerSharpnesses = 'cornerSharpnesses'
cornersOnly = 'cornersOnly'
cornersPlus1 = 'cornersPlus1'
cornersPlus2 = 'cornersPlus2'
creaseIndices = 'creaseIndices'
creaseLengths = 'creaseLengths'
creaseSharpnesses = 'creaseSharpnesses'
cross = 'cross'
cubic = 'cubic'
curveVertexCounts = 'curveVertexCounts'
default_ = 'default'
doubleSided = 'doubleSided'
edgeAndCorner = 'edgeAndCorner'
edgeOnly = 'edgeOnly'
elementSize = 'elementSize'
elementType = 'elementType'
exposure = 'exposure'
extent = 'extent'
extentsHint = 'extentsHint'
fStop = 'fStop'
face = 'face'
faceVarying = 'faceVarying'
faceVaryingLinearInterpolation = 'faceVaryingLinearInterpolation'
faceVertexCounts = 'faceVertexCounts'
faceVertexIndices = 'faceVertexIndices'
familyName = 'familyName'
focalLength = 'focalLength'
focusDistance = 'focusDistance'
form = 'form'
fromTexture = 'fromTexture'
guide = 'guide'
guideVisibility = 'guideVisibility'
height = 'height'
hermite = 'hermite'
holeIndices = 'holeIndices'
horizontalAperture = 'horizontalAperture'
horizontalApertureOffset = 'horizontalApertureOffset'
ids = 'ids'
inactiveIds = 'inactiveIds'
indices = 'indices'
inherited = 'inherited'
interpolateBoundary = 'interpolateBoundary'
interpolation = 'interpolation'
invisible = 'invisible'
invisibleIds = 'invisibleIds'
knots = 'knots'
left = 'left'
leftHanded = 'leftHanded'
length = 'length'
linear = 'linear'
loop = 'loop'
metersPerUnit = 'metersPerUnit'
modelApplyDrawMode = 'model:applyDrawMode'
modelCardGeometry = 'model:cardGeometry'
modelCardTextureXNeg = 'model:cardTextureXNeg'
modelCardTextureXPos = 'model:cardTextureXPos'
modelCardTextureYNeg = 'model:cardTextureYNeg'
modelCardTextureYPos = 'model:cardTextureYPos'
modelCardTextureZNeg = 'model:cardTextureZNeg'
modelCardTextureZPos = 'model:cardTextureZPos'
modelDrawMode = 'model:drawMode'
modelDrawModeColor = 'model:drawModeColor'
mono = 'mono'
motionBlurScale = 'motion:blurScale'
motionNonlinearSampleCount = 'motion:nonlinearSampleCount'
motionVelocityScale = 'motion:velocityScale'
nonOverlapping = 'nonOverlapping'
none = 'none'
nonperiodic = 'nonperiodic'
normals = 'normals'
open = 'open'
order = 'order'
orientation = 'orientation'
orientations = 'orientations'
origin = 'origin'
orthographic = 'orthographic'
partition = 'partition'
periodic = 'periodic'
perspective = 'perspective'
pinned = 'pinned'
pivot = 'pivot'
pointWeights = 'pointWeights'
points = 'points'
positions = 'positions'
power = 'power'
primvarsDisplayColor = 'primvars:displayColor'
primvarsDisplayOpacity = 'primvars:displayOpacity'
projection = 'projection'
protoIndices = 'protoIndices'
prototypes = 'prototypes'
proxy = 'proxy'
proxyPrim = 'proxyPrim'
proxyVisibility = 'proxyVisibility'
purpose = 'purpose'
radius = 'radius'
ranges = 'ranges'
render = 'render'
renderVisibility = 'renderVisibility'
right = 'right'
rightHanded = 'rightHanded'
scales = 'scales'
shutterClose = 'shutter:close'
shutterOpen = 'shutter:open'
size = 'size'
smooth = 'smooth'
stereoRole = 'stereoRole'
subdivisionScheme = 'subdivisionScheme'
tangents = 'tangents'
triangleSubdivisionRule = 'triangleSubdivisionRule'
trimCurveCounts = 'trimCurve:counts'
trimCurveKnots = 'trimCurve:knots'
trimCurveOrders = 'trimCurve:orders'
trimCurvePoints = 'trimCurve:points'
trimCurveRanges = 'trimCurve:ranges'
trimCurveVertexCounts = 'trimCurve:vertexCounts'
type = 'type'
uForm = 'uForm'
uKnots = 'uKnots'
uOrder = 'uOrder'
uRange = 'uRange'
uVertexCount = 'uVertexCount'
unauthoredValuesIndex = 'unauthoredValuesIndex'
uniform = 'uniform'
unrestricted = 'unrestricted'
upAxis = 'upAxis'
vForm = 'vForm'
vKnots = 'vKnots'
vOrder = 'vOrder'
vRange = 'vRange'
vVertexCount = 'vVertexCount'
varying = 'varying'
velocities = 'velocities'
vertex = 'vertex'
verticalAperture = 'verticalAperture'
verticalApertureOffset = 'verticalApertureOffset'
visibility = 'visibility'
visible = 'visible'
width = 'width'
widths = 'widths'
wrap = 'wrap'
x = 'X'
xformOpOrder = 'xformOpOrder'
y = 'Y'
z = 'Z'
class pxr.UsdGeom.VisibilityAPI
UsdGeomVisibilityAPI introduces properties that can be used to author
visibility opinions.
Currently, this schema only introduces the attributes that are used to
control purpose visibility. Later, this schema will define all
visibility-related properties and UsdGeomImageable will no longer
define those properties. The purpose visibility attributes added by
this schema, guideVisibility, proxyVisibility, and
renderVisibility can each be used to control visibility for geometry
of the corresponding purpose values, with the overall visibility
attribute acting as an override. I.e., if visibility evaluates
to”invisible”, purpose visibility is invisible; otherwise, purpose
visibility is determined by the corresponding purpose visibility
attribute.
Note that the behavior of guideVisibility is subtly different from
the proxyVisibility and renderVisibility attributes, in
that”guide”purpose visibility always evaluates to
either”invisible”or”visible”, whereas the other attributes may yield
computed values of”inherited”if there is no authored opinion on the
attribute or inherited from an ancestor. This is motivated by the fact
that, in Pixar”s user workflows, we have never found a need to have
all guides visible in a scene by default, whereas we do find that
flexibility useful for”proxy”and”render”geometry.
This schema can only be applied to UsdGeomImageable prims. The
UseGeomImageable schema provides API for computing the purpose
visibility values that result from the attributes introduced by this
schema.
For any described attribute Fallback Value or Allowed Values
below that are text/tokens, the actual token is published and defined
in UsdGeomTokens. So to set an attribute to the value”rightHanded”,
use UsdGeomTokens->rightHanded as the value.
Methods:
Apply
classmethod Apply(prim) -> VisibilityAPI
CanApply
classmethod CanApply(prim, whyNot) -> bool
CreateGuideVisibilityAttr(defaultValue, ...)
See GetGuideVisibilityAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateProxyVisibilityAttr(defaultValue, ...)
See GetProxyVisibilityAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateRenderVisibilityAttr(defaultValue, ...)
See GetRenderVisibilityAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
Get
classmethod Get(stage, path) -> VisibilityAPI
GetGuideVisibilityAttr()
This attribute controls visibility for geometry with purpose"guide".
GetProxyVisibilityAttr()
This attribute controls visibility for geometry with purpose"proxy".
GetPurposeVisibilityAttr(purpose)
Return the attribute that is used for expressing visibility opinions for the given purpose .
GetRenderVisibilityAttr()
This attribute controls visibility for geometry with purpose"render".
GetSchemaAttributeNames
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
static Apply()
classmethod Apply(prim) -> VisibilityAPI
Applies this single-apply API schema to the given prim .
This information is stored by adding”VisibilityAPI”to the token-
valued, listOp metadata apiSchemas on the prim.
A valid UsdGeomVisibilityAPI object is returned upon success. An
invalid (or empty) UsdGeomVisibilityAPI object is returned upon
failure. See UsdPrim::ApplyAPI() for conditions resulting in failure.
UsdPrim::GetAppliedSchemas()
UsdPrim::HasAPI()
UsdPrim::CanApplyAPI()
UsdPrim::ApplyAPI()
UsdPrim::RemoveAPI()
Parameters
prim (Prim) –
static CanApply()
classmethod CanApply(prim, whyNot) -> bool
Returns true if this single-apply API schema can be applied to the
given prim .
If this schema can not be a applied to the prim, this returns false
and, if provided, populates whyNot with the reason it can not be
applied.
Note that if CanApply returns false, that does not necessarily imply
that calling Apply will fail. Callers are expected to call CanApply
before calling Apply if they want to ensure that it is valid to apply
a schema.
UsdPrim::GetAppliedSchemas()
UsdPrim::HasAPI()
UsdPrim::CanApplyAPI()
UsdPrim::ApplyAPI()
UsdPrim::RemoveAPI()
Parameters
prim (Prim) –
whyNot (str) –
CreateGuideVisibilityAttr(defaultValue, writeSparsely) → Attribute
See GetGuideVisibilityAttr() , and also Create vs Get Property Methods
for when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateProxyVisibilityAttr(defaultValue, writeSparsely) → Attribute
See GetProxyVisibilityAttr() , and also Create vs Get Property Methods
for when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateRenderVisibilityAttr(defaultValue, writeSparsely) → Attribute
See GetRenderVisibilityAttr() , and also Create vs Get Property
Methods for when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
static Get()
classmethod Get(stage, path) -> VisibilityAPI
Return a UsdGeomVisibilityAPI holding the prim adhering to this schema
at path on stage .
If no prim exists at path on stage , or if the prim at that
path does not adhere to this schema, return an invalid schema object.
This is shorthand for the following:
UsdGeomVisibilityAPI(stage->GetPrimAtPath(path));
Parameters
stage (Stage) –
path (Path) –
GetGuideVisibilityAttr() → Attribute
This attribute controls visibility for geometry with purpose”guide”.
Unlike overall visibility, guideVisibility is uniform, and
therefore cannot be animated.
Also unlike overall visibility, guideVisibility is tri-state, in
that a descendant with an opinion of”visible”overrides an ancestor
opinion of”invisible”.
The guideVisibility attribute works in concert with the overall
visibility attribute: The visibility of a prim with purpose”guide”is
determined by the inherited values it receives for the visibility
and guideVisibility attributes. If visibility evaluates
to”invisible”, the prim is invisible. If visibility evaluates
to”inherited”and guideVisibility evaluates to”visible”, then the
prim is visible. Otherwise, it is invisible.
Declaration
uniform token guideVisibility ="invisible"
C++ Type
TfToken
Usd Type
SdfValueTypeNames->Token
Variability
SdfVariabilityUniform
Allowed Values
inherited, invisible, visible
GetProxyVisibilityAttr() → Attribute
This attribute controls visibility for geometry with purpose”proxy”.
Unlike overall visibility, proxyVisibility is uniform, and
therefore cannot be animated.
Also unlike overall visibility, proxyVisibility is tri-state, in
that a descendant with an opinion of”visible”overrides an ancestor
opinion of”invisible”.
The proxyVisibility attribute works in concert with the overall
visibility attribute: The visibility of a prim with purpose”proxy”is
determined by the inherited values it receives for the visibility
and proxyVisibility attributes. If visibility evaluates
to”invisible”, the prim is invisible. If visibility evaluates
to”inherited”then: If proxyVisibility evaluates to”visible”, then
the prim is visible; if proxyVisibility evaluates to”invisible”,
then the prim is invisible; if proxyVisibility evaluates
to”inherited”, then the prim may either be visible or invisible,
depending on a fallback value determined by the calling context.
Declaration
uniform token proxyVisibility ="inherited"
C++ Type
TfToken
Usd Type
SdfValueTypeNames->Token
Variability
SdfVariabilityUniform
Allowed Values
inherited, invisible, visible
GetPurposeVisibilityAttr(purpose) → Attribute
Return the attribute that is used for expressing visibility opinions
for the given purpose .
The valid purpose tokens are”guide”,”proxy”, and”render”which return
the attributes guideVisibility, proxyVisibility, and
renderVisibility respectively.
Note that while”default”is a valid purpose token for
UsdGeomImageable::GetPurposeVisibilityAttr, it is not a valid purpose
for this function, as UsdGeomVisibilityAPI itself does not have a
default visibility attribute. Calling this function with “default will
result in a coding error.
Parameters
purpose (str) –
GetRenderVisibilityAttr() → Attribute
This attribute controls visibility for geometry with purpose”render”.
Unlike overall visibility, renderVisibility is uniform, and
therefore cannot be animated.
Also unlike overall visibility, renderVisibility is tri-state, in
that a descendant with an opinion of”visible”overrides an ancestor
opinion of”invisible”.
The renderVisibility attribute works in concert with the overall
visibility attribute: The visibility of a prim with
purpose”render”is determined by the inherited values it receives for
the visibility and renderVisibility attributes. If visibility
evaluates to”invisible”, the prim is invisible. If visibility
evaluates to”inherited”then: If renderVisibility evaluates
to”visible”, then the prim is visible; if renderVisibility evaluates
to”invisible”, then the prim is invisible; if renderVisibility
evaluates to”inherited”, then the prim may either be visible or
invisible, depending on a fallback value determined by the calling
context.
Declaration
uniform token renderVisibility ="inherited"
C++ Type
TfToken
Usd Type
SdfValueTypeNames->Token
Variability
SdfVariabilityUniform
Allowed Values
inherited, invisible, visible
static GetSchemaAttributeNames()
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
Return a vector of names of all pre-declared attributes for this
schema class and all its ancestor classes.
Does not include attributes that may be authored by custom/extended
methods of the schemas involved.
Parameters
includeInherited (bool) –
class pxr.UsdGeom.Xform
Concrete prim schema for a transform, which implements Xformable
Methods:
Define
classmethod Define(stage, path) -> Xform
Get
classmethod Get(stage, path) -> Xform
GetSchemaAttributeNames
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
static Define()
classmethod Define(stage, path) -> Xform
Attempt to ensure a UsdPrim adhering to this schema at path is
defined (according to UsdPrim::IsDefined() ) on this stage.
If a prim adhering to this schema at path is already defined on
this stage, return that prim. Otherwise author an SdfPrimSpec with
specifier == SdfSpecifierDef and this schema’s prim type name for
the prim at path at the current EditTarget. Author SdfPrimSpec s
with specifier == SdfSpecifierDef and empty typeName at the
current EditTarget for any nonexistent, or existing but not Defined
ancestors.
The given path must be an absolute prim path that does not contain
any variant selections.
If it is impossible to author any of the necessary PrimSpecs, (for
example, in case path cannot map to the current UsdEditTarget ‘s
namespace) issue an error and return an invalid UsdPrim.
Note that this method may return a defined prim whose typeName does
not specify this schema class, in case a stronger typeName opinion
overrides the opinion at the current EditTarget.
Parameters
stage (Stage) –
path (Path) –
static Get()
classmethod Get(stage, path) -> Xform
Return a UsdGeomXform holding the prim adhering to this schema at
path on stage .
If no prim exists at path on stage , or if the prim at that
path does not adhere to this schema, return an invalid schema object.
This is shorthand for the following:
UsdGeomXform(stage->GetPrimAtPath(path));
Parameters
stage (Stage) –
path (Path) –
static GetSchemaAttributeNames()
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
Return a vector of names of all pre-declared attributes for this
schema class and all its ancestor classes.
Does not include attributes that may be authored by custom/extended
methods of the schemas involved.
Parameters
includeInherited (bool) –
class pxr.UsdGeom.XformCache
A caching mechanism for transform matrices. For best performance, this
object should be reused for multiple CTM queries.
Instances of this type can be copied, though using Swap() may result
in better performance.
It is valid to cache prims from multiple stages in a single
XformCache.
WARNING: this class does not automatically invalidate cached values
based on changes to the stage from which values were cached.
Additionally, a separate instance of this class should be used per-
thread, calling the Get* methods from multiple threads is not safe,
as they mutate internal state.
Methods:
Clear()
Clears all pre-cached values.
ComputeRelativeTransform(prim, ancestor, ...)
Returns the result of concatenating all transforms beneath ancestor that affect prim .
GetLocalToWorldTransform(prim)
Compute the transformation matrix for the given prim , including the transform authored on the Prim itself, if present.
GetLocalTransformation(prim, resetsXformStack)
Returns the local transformation of the prim.
GetParentToWorldTransform(prim)
Compute the transformation matrix for the given prim , but do NOT include the transform authored on the prim itself.
GetTime()
Get the current time from which this cache is reading values.
SetTime(time)
Use the new time when computing values and may clear any existing values cached for the previous time.
Swap(other)
Swap the contents of this XformCache with other .
Clear() → None
Clears all pre-cached values.
ComputeRelativeTransform(prim, ancestor, resetXformStack) → Matrix4d
Returns the result of concatenating all transforms beneath
ancestor that affect prim .
This includes the local transform of prim itself, but not the
local transform of ancestor . If ancestor is not an ancestor
of prim , the resulting transform is the local-to-world
transformation of prim . The resetXformTsack pointer must be
valid. If any intermediate prims reset the transform stack,
resetXformStack will be set to true. Intermediate transforms are
cached, but the result of this call itself is not cached.
Parameters
prim (Prim) –
ancestor (Prim) –
resetXformStack (bool) –
GetLocalToWorldTransform(prim) → Matrix4d
Compute the transformation matrix for the given prim , including
the transform authored on the Prim itself, if present.
This method may mutate internal cache state and is not thread safe.
Parameters
prim (Prim) –
GetLocalTransformation(prim, resetsXformStack) → Matrix4d
Returns the local transformation of the prim.
Uses the cached XformQuery to compute the result quickly. The
resetsXformStack pointer must be valid. It will be set to true if
prim resets the transform stack. The result of this call is
cached.
Parameters
prim (Prim) –
resetsXformStack (bool) –
GetParentToWorldTransform(prim) → Matrix4d
Compute the transformation matrix for the given prim , but do NOT
include the transform authored on the prim itself.
This method may mutate internal cache state and is not thread safe.
Parameters
prim (Prim) –
GetTime() → TimeCode
Get the current time from which this cache is reading values.
SetTime(time) → None
Use the new time when computing values and may clear any existing
values cached for the previous time.
Setting time to the current time is a no-op.
Parameters
time (TimeCode) –
Swap(other) → None
Swap the contents of this XformCache with other .
Parameters
other (XformCache) –
class pxr.UsdGeom.XformCommonAPI
This class provides API for authoring and retrieving a standard set of
component transformations which include a scale, a rotation, a scale-
rotate pivot and a translation. The goal of the API is to enhance
component-wise interchange. It achieves this by limiting the set of
allowed basic ops and by specifying the order in which they are
applied. In addition to the basic set of ops, the’resetXformStack’bit
can also be set to indicate whether the underlying xformable resets
the parent transformation (i.e. does not inherit it’s parent’s
transformation).
UsdGeomXformCommonAPI::GetResetXformStack()
UsdGeomXformCommonAPI::SetResetXformStack() The operator-bool for the
class will inform you whether an existing xformable is compatible with
this API.
The scale-rotate pivot is represented by a pair of (translate,
inverse-translate) xformOps around the scale and rotate operations.
The rotation operation can be any of the six allowed Euler angle sets.
UsdGeomXformOp::Type. The xformOpOrder of an xformable that has all of
the supported basic ops is as follows:
[“xformOp:translate”,”xformOp:translate:pivot”,”xformOp:rotateXYZ”,”xformOp:scale”,”!invert!xformOp:translate:pivot”].
It is worth noting that all of the ops are optional. For example, an
xformable may have only a translate or a rotate. It would still be
considered as compatible with this API. Individual SetTranslate() ,
SetRotate() , SetScale() and SetPivot() methods are provided by this
API to allow such sparse authoring.
Classes:
OpFlags
Enumerates the categories of ops that can be handled by XformCommonAPI.
RotationOrder
Enumerates the rotation order of the 3-angle Euler rotation.
Methods:
CanConvertOpTypeToRotationOrder
classmethod CanConvertOpTypeToRotationOrder(opType) -> bool
ConvertOpTypeToRotationOrder
classmethod ConvertOpTypeToRotationOrder(opType) -> RotationOrder
ConvertRotationOrderToOpType
classmethod ConvertRotationOrderToOpType(rotOrder) -> XformOp.Type
CreateXformOps(rotOrder, op1, op2, op3, op4)
Creates the specified XformCommonAPI-compatible xform ops, or returns the existing ops if they already exist.
Get
classmethod Get(stage, path) -> XformCommonAPI
GetResetXformStack()
Returns whether the xformable resets the transform stack.
GetRotationTransform
classmethod GetRotationTransform(rotation, rotationOrder) -> Matrix4d
GetSchemaAttributeNames
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
GetXformVectors(translation, rotation, ...)
Retrieve values of the various component xformOps at a given time
GetXformVectorsByAccumulation(translation, ...)
Retrieve values of the various component xformOps at a given time
SetPivot(pivot, time)
Set pivot position at time to pivot .
SetResetXformStack(resetXformStack)
Set whether the xformable resets the transform stack.
SetRotate(rotation, rotOrder, time)
Set rotation at time to rotation .
SetScale(scale, time)
Set scale at time to scale .
SetTranslate(translation, time)
Set translation at time to translation .
SetXformVectors(translation, rotation, ...)
Set values for the various component xformOps at a given time .
Attributes:
OpPivot
OpRotate
OpScale
OpTranslate
RotationOrderXYZ
RotationOrderXZY
RotationOrderYXZ
RotationOrderYZX
RotationOrderZXY
RotationOrderZYX
class OpFlags
Enumerates the categories of ops that can be handled by
XformCommonAPI.
For use with CreateXformOps() .
Methods:
GetValueFromName
Attributes:
allValues
static GetValueFromName()
allValues = (UsdGeom.XformCommonAPI.OpTranslate, UsdGeom.XformCommonAPI.OpRotate, UsdGeom.XformCommonAPI.OpScale, UsdGeom.XformCommonAPI.OpPivot)
class RotationOrder
Enumerates the rotation order of the 3-angle Euler rotation.
Methods:
GetValueFromName
Attributes:
allValues
static GetValueFromName()
allValues = (UsdGeom.XformCommonAPI.RotationOrderXYZ, UsdGeom.XformCommonAPI.RotationOrderXZY, UsdGeom.XformCommonAPI.RotationOrderYXZ, UsdGeom.XformCommonAPI.RotationOrderYZX, UsdGeom.XformCommonAPI.RotationOrderZXY, UsdGeom.XformCommonAPI.RotationOrderZYX)
static CanConvertOpTypeToRotationOrder()
classmethod CanConvertOpTypeToRotationOrder(opType) -> bool
Whether the given opType has a corresponding value in the
UsdGeomXformCommonAPI::RotationOrder enum (i.e., whether it is a
three-axis rotation).
Parameters
opType (XformOp.Type) –
static ConvertOpTypeToRotationOrder()
classmethod ConvertOpTypeToRotationOrder(opType) -> RotationOrder
Converts the given opType to the corresponding value in the
UsdGeomXformCommonAPI::RotationOrder enum.
For example, TypeRotateYZX corresponds to RotationOrderYZX. Raises a
coding error if opType is not convertible to RotationOrder (i.e.,
if it isn’t a three-axis rotation) and returns the default
RotationOrderXYZ instead.
Parameters
opType (XformOp.Type) –
static ConvertRotationOrderToOpType()
classmethod ConvertRotationOrderToOpType(rotOrder) -> XformOp.Type
Converts the given rotOrder to the corresponding value in the
UsdGeomXformOp::Type enum.
For example, RotationOrderYZX corresponds to TypeRotateYZX. Raises a
coding error if rotOrder is not one of the named enumerators of
RotationOrder.
Parameters
rotOrder (RotationOrder) –
CreateXformOps(rotOrder, op1, op2, op3, op4) → Ops
Creates the specified XformCommonAPI-compatible xform ops, or returns
the existing ops if they already exist.
If successful, returns an Ops object with all the ops on this prim,
identified by type. If the requested xform ops couldn’t be created or
the prim is not XformCommonAPI-compatible, returns an Ops object with
all invalid ops.
The rotOrder is only used if OpRotate is specified. Otherwise, it
is ignored. (If you don’t need to create a rotate op, you might find
it helpful to use the other overload that takes no rotation order.)
Parameters
rotOrder (RotationOrder) –
op1 (OpFlags) –
op2 (OpFlags) –
op3 (OpFlags) –
op4 (OpFlags) –
CreateXformOps(op1, op2, op3, op4) -> Ops
This is an overloaded member function, provided for convenience. It
differs from the above function only in what argument(s) it accepts.
This overload does not take a rotation order.
If you specify OpRotate, then this overload assumes RotationOrderXYZ
or the previously-authored rotation order. (If you do need to create a
rotate op, you might find it helpful to use the other overload that
explicitly takes a rotation order.)
Parameters
op1 (OpFlags) –
op2 (OpFlags) –
op3 (OpFlags) –
op4 (OpFlags) –
static Get()
classmethod Get(stage, path) -> XformCommonAPI
Return a UsdGeomXformCommonAPI holding the prim adhering to this
schema at path on stage .
If no prim exists at path on stage , or if the prim at that
path does not adhere to this schema, return an invalid schema object.
This is shorthand for the following:
UsdGeomXformCommonAPI(stage->GetPrimAtPath(path));
Parameters
stage (Stage) –
path (Path) –
GetResetXformStack() → bool
Returns whether the xformable resets the transform stack.
i.e., does not inherit the parent transformation.
static GetRotationTransform()
classmethod GetRotationTransform(rotation, rotationOrder) -> Matrix4d
Return the 4x4 matrix that applies the rotation encoded by rotation
vector rotation using the rotation order rotationOrder .
Deprecated
Please use the result of ConvertRotationOrderToOpType() along with
UsdGeomXformOp::GetOpTransform() instead.
Parameters
rotation (Vec3f) –
rotationOrder (XformCommonAPI.RotationOrder) –
static GetSchemaAttributeNames()
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
Return a vector of names of all pre-declared attributes for this
schema class and all its ancestor classes.
Does not include attributes that may be authored by custom/extended
methods of the schemas involved.
Parameters
includeInherited (bool) –
GetXformVectors(translation, rotation, scale, pivot, rotOrder, time) → bool
Retrieve values of the various component xformOps at a given time
.
Identity values are filled in for the component xformOps that don’t
exist or don’t have an authored value.
This method works even on prims with an incompatible xform schema,
i.e. when the bool operator returns false. When the underlying
xformable has an incompatible xform schema, it performs a full-on
matrix decomposition to XYZ rotation order.
Parameters
translation (Vec3d) –
rotation (Vec3f) –
scale (Vec3f) –
pivot (Vec3f) –
rotOrder (RotationOrder) –
time (TimeCode) –
GetXformVectorsByAccumulation(translation, rotation, scale, pivot, rotOrder, time) → bool
Retrieve values of the various component xformOps at a given time
.
Identity values are filled in for the component xformOps that don’t
exist or don’t have an authored value.
This method allows some additional flexibility for xform schemas that
do not strictly adhere to the xformCommonAPI. For incompatible
schemas, this method will attempt to reduce the schema into one from
which component vectors can be extracted by accumulating xformOp
transforms of the common types.
When the underlying xformable has a compatible xform schema, the usual
component value extraction method is used instead. When the xform
schema is incompatible and it cannot be reduced by accumulating
transforms, it performs a full-on matrix decomposition to XYZ rotation
order.
Parameters
translation (Vec3d) –
rotation (Vec3f) –
scale (Vec3f) –
pivot (Vec3f) –
rotOrder (XformCommonAPI.RotationOrder) –
time (TimeCode) –
SetPivot(pivot, time) → bool
Set pivot position at time to pivot .
Parameters
pivot (Vec3f) –
time (TimeCode) –
SetResetXformStack(resetXformStack) → bool
Set whether the xformable resets the transform stack.
i.e., does not inherit the parent transformation.
Parameters
resetXformStack (bool) –
SetRotate(rotation, rotOrder, time) → bool
Set rotation at time to rotation .
Parameters
rotation (Vec3f) –
rotOrder (XformCommonAPI.RotationOrder) –
time (TimeCode) –
SetScale(scale, time) → bool
Set scale at time to scale .
Parameters
scale (Vec3f) –
time (TimeCode) –
SetTranslate(translation, time) → bool
Set translation at time to translation .
Parameters
translation (Vec3d) –
time (TimeCode) –
SetXformVectors(translation, rotation, scale, pivot, rotOrder, time) → bool
Set values for the various component xformOps at a given time .
Calling this method will call all of the supported ops to be created,
even if they only contain default (identity) values.
To author individual operations selectively, use the Set[OpType]()
API.
Once the rotation order has been established for a given xformable
(either because of an already defined (and compatible) rotate op or
from calling SetXformVectors() or SetRotate() ), it cannot be changed.
Parameters
translation (Vec3d) –
rotation (Vec3f) –
scale (Vec3f) –
pivot (Vec3f) –
rotOrder (RotationOrder) –
time (TimeCode) –
OpPivot = UsdGeom.XformCommonAPI.OpPivot
OpRotate = UsdGeom.XformCommonAPI.OpRotate
OpScale = UsdGeom.XformCommonAPI.OpScale
OpTranslate = UsdGeom.XformCommonAPI.OpTranslate
RotationOrderXYZ = UsdGeom.XformCommonAPI.RotationOrderXYZ
RotationOrderXZY = UsdGeom.XformCommonAPI.RotationOrderXZY
RotationOrderYXZ = UsdGeom.XformCommonAPI.RotationOrderYXZ
RotationOrderYZX = UsdGeom.XformCommonAPI.RotationOrderYZX
RotationOrderZXY = UsdGeom.XformCommonAPI.RotationOrderZXY
RotationOrderZYX = UsdGeom.XformCommonAPI.RotationOrderZYX
class pxr.UsdGeom.XformOp
Schema wrapper for UsdAttribute for authoring and computing
transformation operations, as consumed by UsdGeomXformable schema.
The semantics of an op are determined primarily by its name, which
allows us to decode an op very efficiently. All ops are independent
attributes, which must live in the”xformOp”property namespace. The
op’s primary name within the namespace must be one of
UsdGeomXformOpTypes, which determines the type of transformation
operation, and its secondary name (or suffix) within the namespace
(which is not required to exist), can be any name that distinguishes
it from other ops of the same type. Suffixes are generally imposed by
higer level xform API schemas.
On packing order of rotateABC triples The order in which the axis
rotations are recorded in a Vec3* for the six rotateABC Euler
triples is always the same: vec[0] = X, vec[1] = Y, vec[2] = Z.
The A, B, C in the op name dictate the order in which their
corresponding elements are consumed by the rotation, not how they are
laid out.
Classes:
Precision
Precision with which the value of the tranformation operation is encoded.
Type
Enumerates the set of all transformation operation types.
Methods:
Get(value, time)
Get the attribute value of the XformOp at time .
GetAttr()
Explicit UsdAttribute extractor.
GetBaseName()
UsdAttribute::GetBaseName()
GetName()
UsdAttribute::GetName()
GetNamespace()
UsdAttribute::GetNamespace()
GetNumTimeSamples()
Returns the number of time samples authored for this xformOp.
GetOpName
classmethod GetOpName(opType, opSuffix, inverse) -> str
GetOpTransform
classmethod GetOpTransform(time) -> Matrix4d
GetOpType()
Return the operation type of this op, one of UsdGeomXformOp::Type.
GetOpTypeEnum
classmethod GetOpTypeEnum(opTypeToken) -> Type
GetOpTypeToken
classmethod GetOpTypeToken(opType) -> str
GetPrecision()
Returns the precision level of the xform op.
GetTimeSamples(times)
Populates the list of time samples at which the associated attribute is authored.
GetTimeSamplesInInterval(interval, times)
Populates the list of time samples within the given interval , at which the associated attribute is authored.
GetTypeName()
UsdAttribute::GetTypeName()
IsDefined()
Return true if the wrapped UsdAttribute::IsDefined() , and in addition the attribute is identified as a XformOp.
IsInverseOp()
Returns whether the xformOp represents an inverse operation.
MightBeTimeVarying()
Determine whether there is any possibility that this op's value may vary over time.
Set(value, time)
Set the attribute value of the XformOp at time .
SplitName()
UsdAttribute::SplitName()
Attributes:
PrecisionDouble
PrecisionFloat
PrecisionHalf
TypeInvalid
TypeOrient
TypeRotateX
TypeRotateXYZ
TypeRotateXZY
TypeRotateY
TypeRotateYXZ
TypeRotateYZX
TypeRotateZ
TypeRotateZXY
TypeRotateZYX
TypeScale
TypeTransform
TypeTranslate
class Precision
Precision with which the value of the tranformation operation is
encoded.
Methods:
GetValueFromName
Attributes:
allValues
static GetValueFromName()
allValues = (UsdGeom.XformOp.PrecisionDouble, UsdGeom.XformOp.PrecisionFloat, UsdGeom.XformOp.PrecisionHalf)
class Type
Enumerates the set of all transformation operation types.
Methods:
GetValueFromName
Attributes:
allValues
static GetValueFromName()
allValues = (UsdGeom.XformOp.TypeInvalid, UsdGeom.XformOp.TypeTranslate, UsdGeom.XformOp.TypeScale, UsdGeom.XformOp.TypeRotateX, UsdGeom.XformOp.TypeRotateY, UsdGeom.XformOp.TypeRotateZ, UsdGeom.XformOp.TypeRotateXYZ, UsdGeom.XformOp.TypeRotateXZY, UsdGeom.XformOp.TypeRotateYXZ, UsdGeom.XformOp.TypeRotateYZX, UsdGeom.XformOp.TypeRotateZXY, UsdGeom.XformOp.TypeRotateZYX, UsdGeom.XformOp.TypeOrient, UsdGeom.XformOp.TypeTransform)
Get(value, time) → bool
Get the attribute value of the XformOp at time .
For inverted ops, this returns the raw, uninverted value.
Parameters
value (T) –
time (TimeCode) –
GetAttr() → Attribute
Explicit UsdAttribute extractor.
GetBaseName() → str
UsdAttribute::GetBaseName()
GetName() → str
UsdAttribute::GetName()
GetNamespace() → str
UsdAttribute::GetNamespace()
GetNumTimeSamples() → int
Returns the number of time samples authored for this xformOp.
GetOpName()
classmethod GetOpName(opType, opSuffix, inverse) -> str
Returns the xformOp’s name as it appears in xformOpOrder, given the
opType, the (optional) suffix and whether it is an inverse operation.
Parameters
opType (Type) –
opSuffix (str) –
inverse (bool) –
GetOpName() -> str
Returns the opName as it appears in the xformOpOrder attribute.
This will begin with”!invert!:xformOp:”if it is an inverse xform
operation. If it is not an inverse xformOp, it will begin
with’xformOp:’.
This will be empty for an invalid xformOp.
GetOpTransform()
classmethod GetOpTransform(time) -> Matrix4d
Return the 4x4 matrix that applies the transformation encoded in this
op at time .
Returns the identity matrix and issues a coding error if the op is
invalid.
If the op is valid, but has no authored value, the identity matrix is
returned and no error is issued.
Parameters
time (TimeCode) –
GetOpTransform(opType, opVal, isInverseOp) -> Matrix4d
Return the 4x4 matrix that applies the transformation encoded by op
opType and data value opVal .
If isInverseOp is true, then the inverse of the tranformation
represented by the op/value pair is returned.
An error will be issued if opType is not one of the values in the
enum UsdGeomXformOp::Type or if opVal cannot be converted to a
suitable input to opType
Parameters
opType (Type) –
opVal (VtValue) –
isInverseOp (bool) –
GetOpType() → Type
Return the operation type of this op, one of UsdGeomXformOp::Type.
static GetOpTypeEnum()
classmethod GetOpTypeEnum(opTypeToken) -> Type
Returns the Type enum associated with the given opTypeToken .
Parameters
opTypeToken (str) –
static GetOpTypeToken()
classmethod GetOpTypeToken(opType) -> str
Returns the TfToken used to encode the given opType .
Note that an empty TfToken is used to represent TypeInvalid
Parameters
opType (Type) –
GetPrecision() → Precision
Returns the precision level of the xform op.
GetTimeSamples(times) → bool
Populates the list of time samples at which the associated attribute
is authored.
Parameters
times (list[float]) –
GetTimeSamplesInInterval(interval, times) → bool
Populates the list of time samples within the given interval , at
which the associated attribute is authored.
Parameters
interval (Interval) –
times (list[float]) –
GetTypeName() → ValueTypeName
UsdAttribute::GetTypeName()
IsDefined() → bool
Return true if the wrapped UsdAttribute::IsDefined() , and in addition
the attribute is identified as a XformOp.
IsInverseOp() → bool
Returns whether the xformOp represents an inverse operation.
MightBeTimeVarying() → bool
Determine whether there is any possibility that this op’s value may
vary over time.
The determination is based on a snapshot of the authored state of the
op, and may become invalid in the face of further authoring.
Set(value, time) → bool
Set the attribute value of the XformOp at time .
This only works on non-inverse operations. If invoked on an inverse
xform operation, a coding error is issued and no value is authored.
Parameters
value (T) –
time (TimeCode) –
SplitName() → list[str]
UsdAttribute::SplitName()
PrecisionDouble = UsdGeom.XformOp.PrecisionDouble
PrecisionFloat = UsdGeom.XformOp.PrecisionFloat
PrecisionHalf = UsdGeom.XformOp.PrecisionHalf
TypeInvalid = UsdGeom.XformOp.TypeInvalid
TypeOrient = UsdGeom.XformOp.TypeOrient
TypeRotateX = UsdGeom.XformOp.TypeRotateX
TypeRotateXYZ = UsdGeom.XformOp.TypeRotateXYZ
TypeRotateXZY = UsdGeom.XformOp.TypeRotateXZY
TypeRotateY = UsdGeom.XformOp.TypeRotateY
TypeRotateYXZ = UsdGeom.XformOp.TypeRotateYXZ
TypeRotateYZX = UsdGeom.XformOp.TypeRotateYZX
TypeRotateZ = UsdGeom.XformOp.TypeRotateZ
TypeRotateZXY = UsdGeom.XformOp.TypeRotateZXY
TypeRotateZYX = UsdGeom.XformOp.TypeRotateZYX
TypeScale = UsdGeom.XformOp.TypeScale
TypeTransform = UsdGeom.XformOp.TypeTransform
TypeTranslate = UsdGeom.XformOp.TypeTranslate
class pxr.UsdGeom.XformOpTypes
Attributes:
orient
resetXformStack
rotateX
rotateXYZ
rotateXZY
rotateY
rotateYXZ
rotateYZX
rotateZ
rotateZXY
rotateZYX
scale
transform
translate
orient = 'orient'
resetXformStack = '!resetXformStack!'
rotateX = 'rotateX'
rotateXYZ = 'rotateXYZ'
rotateXZY = 'rotateXZY'
rotateY = 'rotateY'
rotateYXZ = 'rotateYXZ'
rotateYZX = 'rotateYZX'
rotateZ = 'rotateZ'
rotateZXY = 'rotateZXY'
rotateZYX = 'rotateZYX'
scale = 'scale'
transform = 'transform'
translate = 'translate'
class pxr.UsdGeom.Xformable
Base class for all transformable prims, which allows arbitrary
sequences of component affine transformations to be encoded.
You may find it useful to review Linear Algebra in UsdGeom while
reading this class description. Supported Component Transformation
Operations
UsdGeomXformable currently supports arbitrary sequences of the
following operations, each of which can be encoded in an attribute of
the proper shape in any supported precision:
translate - 3D
scale - 3D
rotateX - 1D angle in degrees
rotateY - 1D angle in degrees
rotateZ - 1D angle in degrees
rotateABC - 3D where ABC can be any combination of the six
principle Euler Angle sets: XYZ, XZY, YXZ, YZX, ZXY, ZYX. See note on
rotation packing order
orient - 4D (quaternion)
transform - 4x4D
Creating a Component Transformation
To add components to a UsdGeomXformable prim, simply call AddXformOp()
with the desired op type, as enumerated in UsdGeomXformOp::Type, and
the desired precision, which is one of UsdGeomXformOp::Precision.
Optionally, you can also provide an”op suffix”for the operator that
disambiguates it from other components of the same type on the same
prim. Application-specific transform schemas can use the suffixes to
fill a role similar to that played by AbcGeom::XformOp’s”Hint”enums
for their own round-tripping logic.
We also provide specific”Add”API for each type, for clarity and
conciseness, e.g. AddTranslateOp() , AddRotateXYZOp() etc.
AddXformOp() will return a UsdGeomXformOp object, which is a schema on
a newly created UsdAttribute that provides convenience API for
authoring and computing the component transformations. The
UsdGeomXformOp can then be used to author any number of timesamples
and default for the op.
Each successive call to AddXformOp() adds an operator that will be
applied”more locally”than the preceding operator, just as if we were
pushing transforms onto a transformation stack - which is precisely
what should happen when the operators are consumed by a reader.
If you can, please try to use the UsdGeomXformCommonAPI, which wraps
the UsdGeomXformable with an interface in which Op creation is taken
care of for you, and there is a much higher chance that the data you
author will be importable without flattening into other DCC’s, as it
conforms to a fixed set of Scale-Rotate-Translate Ops.
Using the Authoring API Data Encoding and Op Ordering
Because there is no”fixed schema”of operations, all of the attributes
that encode transform operations are dynamic, and are scoped in the
namespace”xformOp”. The second component of an attribute’s name
provides the type of operation, as listed above.
An”xformOp”attribute can have additional namespace components derived
from the opSuffix argument to the AddXformOp() suite of methods,
which provides a preferred way of naming the ops such that we can have
multiple”translate”ops with unique attribute names. For example, in
the attribute named”xformOp:translate:maya:pivot”,”translate”is the
type of operation and”maya:pivot”is the suffix.
The following ordered list of attribute declarations in usda define a
basic Scale-Rotate-Translate with XYZ Euler angles, wherein the
translation is double-precision, and the remainder of the ops are
single, in which we will:
Scale by 2.0 in each dimension
Rotate about the X, Y, and Z axes by 30, 60, and 90 degrees,
respectively
Translate by 100 units in the Y direction
float3 xformOp:rotateXYZ = (30, 60, 90)
float3 xformOp:scale = (2, 2, 2)
double3 xformOp:translate = (0, 100, 0)
uniform token[] xformOpOrder = [ "xformOp:translate", "xformOp:rotateXYZ", "xformOp:scale" ]
The attributes appear in the dictionary order in which USD, by
default, sorts them. To ensure the ops are recovered and evaluated in
the correct order, the schema introduces the xformOpOrder
attribute, which contains the names of the op attributes, in the
precise sequence in which they should be pushed onto a transform
stack. Note that the order is opposite to what you might expect,
given the matrix algebra described in Linear Algebra in UsdGeom. This
also dictates order of op creation, since each call to AddXformOp()
adds a new op to the end of the xformOpOrder array, as a new”most-
local”operation. See Example 2 below for C++ code that could have
produced this USD.
If it were important for the prim’s rotations to be independently
overridable, we could equivalently (at some performance cost) encode
the transformation also like so:
float xformOp:rotateX = 30
float xformOp:rotateY = 60
float xformOp:rotateZ = 90
float3 xformOp:scale = (2, 2, 2)
double3 xformOp:translate = (0, 100, 0)
uniform token[] xformOpOrder = [ "xformOp:translate", "xformOp:rotateZ", "xformOp:rotateY", "xformOp:rotateX", "xformOp:scale" ]
Again, note that although we are encoding an XYZ rotation, the three
rotations appear in the xformOpOrder in the opposite order, with
Z, followed, by Y, followed by X.
Were we to add a Maya-style scalePivot to the above example, it might
look like the following:
float3 xformOp:rotateXYZ = (30, 60, 90)
float3 xformOp:scale = (2, 2, 2)
double3 xformOp:translate = (0, 100, 0)
double3 xformOp:translate:scalePivot
uniform token[] xformOpOrder = [ "xformOp:translate", "xformOp:rotateXYZ", "xformOp:translate:scalePivot", "xformOp:scale" ]
Paired”Inverted”Ops
We have been claiming that the ordered list of ops serves as a set of
instructions to a transform stack, but you may have noticed in the
last example that there is a missing operation - the pivot for the
scale op needs to be applied in its inverse-form as a final (most
local) op! In the AbcGeom::Xform schema, we would have encoded an
actual”final”translation op whose value was authored by the exporter
as the negation of the pivot’s value. However, doing so would be
brittle in USD, given that each op can be independently overridden,
and the constraint that one attribute must be maintained as the
negation of the other in order for successful re-importation of the
schema cannot be expressed in USD.
Our solution leverages the xformOpOrder member of the schema,
which, in addition to ordering the ops, may also contain one of two
special tokens that address the paired op and”stack
resetting”behavior.
The”paired op”behavior is encoded as an”!invert!”prefix in
xformOpOrder, as the result of an AddXformOp(isInverseOp=True)
call. The xformOpOrder for the last example would look like:
uniform token[] xformOpOrder = [ "xformOp:translate", "xformOp:rotateXYZ", "xformOp:translate:scalePivot", "xformOp:scale", "!invert!xformOp:translate:scalePivot" ]
When asked for its value via UsdGeomXformOp::GetOpTransform() ,
an”inverted”Op (i.e. the”inverted”half of a set of paired Ops) will
fetch the value of its paired attribute and return its negation. This
works for all op types - an error will be issued if a”transform”type
op is singular and cannot be inverted. When getting the authored value
of an inverted op via UsdGeomXformOp::Get() , the raw, uninverted
value of the associated attribute is returned.
For the sake of robustness, setting a value on an inverted op is
disallowed. Attempting to set a value on an inverted op will result
in a coding error and no value being set.
Resetting the Transform Stack
The other special op/token that can appear in xformOpOrder is
“!resetXformStack!”, which, appearing as the first element of
xformOpOrder, indicates this prim should not inherit the
transformation of its namespace parent. See SetResetXformStack()
Expected Behavior for”Missing”Ops
If an importer expects Scale-Rotate-Translate operations, but a prim
has only translate and rotate ops authored, the importer should assume
an identity scale. This allows us to optimize the data a bit, if only
a few components of a very rich schema (like Maya’s) are authored in
the app.
Using the C++ API
#1. Creating a simple transform matrix encoding
#2. Creating the simple SRT from the example above
#3. Creating a parameterized SRT with pivot using
UsdGeomXformCommonAPI
#4. Creating a rotate-only pivot transform with animated rotation and
translation
Methods:
AddOrientOp(precision, opSuffix, isInverseOp)
Add a orient op (arbitrary axis/angle rotation) to the local stack represented by this xformable.
AddRotateXOp(precision, opSuffix, isInverseOp)
Add a rotation about the X-axis to the local stack represented by this xformable.
AddRotateXYZOp(precision, opSuffix, isInverseOp)
Add a rotation op with XYZ rotation order to the local stack represented by this xformable.
AddRotateXZYOp(precision, opSuffix, isInverseOp)
Add a rotation op with XZY rotation order to the local stack represented by this xformable.
AddRotateYOp(precision, opSuffix, isInverseOp)
Add a rotation about the YX-axis to the local stack represented by this xformable.
AddRotateYXZOp(precision, opSuffix, isInverseOp)
Add a rotation op with YXZ rotation order to the local stack represented by this xformable.
AddRotateYZXOp(precision, opSuffix, isInverseOp)
Add a rotation op with YZX rotation order to the local stack represented by this xformable.
AddRotateZOp(precision, opSuffix, isInverseOp)
Add a rotation about the Z-axis to the local stack represented by this xformable.
AddRotateZXYOp(precision, opSuffix, isInverseOp)
Add a rotation op with ZXY rotation order to the local stack represented by this xformable.
AddRotateZYXOp(precision, opSuffix, isInverseOp)
Add a rotation op with ZYX rotation order to the local stack represented by this xformable.
AddScaleOp(precision, opSuffix, isInverseOp)
Add a scale operation to the local stack represented by this xformable.
AddTransformOp(precision, opSuffix, isInverseOp)
Add a tranform op (4x4 matrix transformation) to the local stack represented by this xformable.
AddTranslateOp(precision, opSuffix, isInverseOp)
Add a translate operation to the local stack represented by this xformable.
AddXformOp(opType, precision, opSuffix, ...)
Add an affine transformation to the local stack represented by this Xformable.
ClearXformOpOrder()
Clears the local transform stack.
CreateXformOpOrderAttr(defaultValue, ...)
See GetXformOpOrderAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
Get
classmethod Get(stage, path) -> Xformable
GetLocalTransformation
Compute the fully-combined, local-to-parent transformation for this prim.
GetOrderedXformOps
Return the ordered list of transform operations to be applied to this prim, in least-to-most-local order.
GetResetXformStack()
Does this prim reset its parent's inherited transformation?
GetSchemaAttributeNames
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
GetTimeSamples
classmethod GetTimeSamples(times) -> bool
GetTimeSamplesInInterval
classmethod GetTimeSamplesInInterval(interval, times) -> bool
GetXformOpOrderAttr()
Encodes the sequence of transformation operations in the order in which they should be pushed onto a transform stack while visiting a UsdStage 's prims in a graph traversal that will effect the desired positioning for this prim and its descendant prims.
IsTransformationAffectedByAttrNamed
classmethod IsTransformationAffectedByAttrNamed(attrName) -> bool
MakeMatrixXform()
Clears the existing local transform stack and creates a new xform op of type'transform'.
SetResetXformStack(resetXform)
Specify whether this prim's transform should reset the transformation stack inherited from its parent prim.
SetXformOpOrder(orderedXformOps, resetXformStack)
Reorder the already-existing transform ops on this prim.
TransformMightBeTimeVarying()
Determine whether there is any possibility that this prim's local transformation may vary over time.
AddOrientOp(precision, opSuffix, isInverseOp) → XformOp
Add a orient op (arbitrary axis/angle rotation) to the local stack
represented by this xformable.
AddXformOp()
Parameters
precision (XformOp.Precision) –
opSuffix (str) –
isInverseOp (bool) –
AddRotateXOp(precision, opSuffix, isInverseOp) → XformOp
Add a rotation about the X-axis to the local stack represented by this
xformable.
Set the angle value of the resulting UsdGeomXformOp in degrees
AddXformOp()
Parameters
precision (XformOp.Precision) –
opSuffix (str) –
isInverseOp (bool) –
AddRotateXYZOp(precision, opSuffix, isInverseOp) → XformOp
Add a rotation op with XYZ rotation order to the local stack
represented by this xformable.
Set the angle value of the resulting UsdGeomXformOp in degrees
AddXformOp() , note on angle packing order
Parameters
precision (XformOp.Precision) –
opSuffix (str) –
isInverseOp (bool) –
AddRotateXZYOp(precision, opSuffix, isInverseOp) → XformOp
Add a rotation op with XZY rotation order to the local stack
represented by this xformable.
Set the angle values of the resulting UsdGeomXformOp in degrees
AddXformOp() , note on angle packing order
Parameters
precision (XformOp.Precision) –
opSuffix (str) –
isInverseOp (bool) –
AddRotateYOp(precision, opSuffix, isInverseOp) → XformOp
Add a rotation about the YX-axis to the local stack represented by
this xformable.
Set the angle value of the resulting UsdGeomXformOp in degrees
AddXformOp()
Parameters
precision (XformOp.Precision) –
opSuffix (str) –
isInverseOp (bool) –
AddRotateYXZOp(precision, opSuffix, isInverseOp) → XformOp
Add a rotation op with YXZ rotation order to the local stack
represented by this xformable.
Set the angle values of the resulting UsdGeomXformOp in degrees
AddXformOp() , note on angle packing order
Parameters
precision (XformOp.Precision) –
opSuffix (str) –
isInverseOp (bool) –
AddRotateYZXOp(precision, opSuffix, isInverseOp) → XformOp
Add a rotation op with YZX rotation order to the local stack
represented by this xformable.
Set the angle values of the resulting UsdGeomXformOp in degrees
AddXformOp() , note on angle packing order
Parameters
precision (XformOp.Precision) –
opSuffix (str) –
isInverseOp (bool) –
AddRotateZOp(precision, opSuffix, isInverseOp) → XformOp
Add a rotation about the Z-axis to the local stack represented by this
xformable.
AddXformOp()
Parameters
precision (XformOp.Precision) –
opSuffix (str) –
isInverseOp (bool) –
AddRotateZXYOp(precision, opSuffix, isInverseOp) → XformOp
Add a rotation op with ZXY rotation order to the local stack
represented by this xformable.
Set the angle values of the resulting UsdGeomXformOp in degrees
AddXformOp() , note on angle packing order
Parameters
precision (XformOp.Precision) –
opSuffix (str) –
isInverseOp (bool) –
AddRotateZYXOp(precision, opSuffix, isInverseOp) → XformOp
Add a rotation op with ZYX rotation order to the local stack
represented by this xformable.
Set the angle values of the resulting UsdGeomXformOp in degrees
AddXformOp() , note on angle packing order
Parameters
precision (XformOp.Precision) –
opSuffix (str) –
isInverseOp (bool) –
AddScaleOp(precision, opSuffix, isInverseOp) → XformOp
Add a scale operation to the local stack represented by this
xformable.
AddXformOp()
Parameters
precision (XformOp.Precision) –
opSuffix (str) –
isInverseOp (bool) –
AddTransformOp(precision, opSuffix, isInverseOp) → XformOp
Add a tranform op (4x4 matrix transformation) to the local stack
represented by this xformable.
AddXformOp() Note: This method takes a precision argument only to be
consistent with the other types of xformOps. The only valid precision
here is double since matrix values cannot be encoded in floating-pt
precision in Sdf.
Parameters
precision (XformOp.Precision) –
opSuffix (str) –
isInverseOp (bool) –
AddTranslateOp(precision, opSuffix, isInverseOp) → XformOp
Add a translate operation to the local stack represented by this
xformable.
AddXformOp()
Parameters
precision (XformOp.Precision) –
opSuffix (str) –
isInverseOp (bool) –
AddXformOp(opType, precision, opSuffix, isInverseOp) → XformOp
Add an affine transformation to the local stack represented by this
Xformable.
This will fail if there is already a transform operation of the same
name in the ordered ops on this prim (i.e. as returned by
GetOrderedXformOps() ), or if an op of the same name exists at all on
the prim with a different precision than that specified.
The newly created operation will become the most-locally applied
transformation on the prim, and will appear last in the list returned
by GetOrderedXformOps() . It is OK to begin authoring values to the
returned UsdGeomXformOp immediately, interspersed with subsequent
calls to AddXformOp() - just note the order of application, which
can be changed at any time (and in stronger layers) via
SetXformOpOrder() .
opType
is the type of transform operation, one of UsdGeomXformOp::Type.
precision
allows you to specify the precision with which you desire to encode
the data. This should be one of the values in the enum
UsdGeomXformOp::Precision. opSuffix
allows you to specify the purpose/meaning of the op in the stack. When
opSuffix is specified, the associated attribute’s name is set
to”xformOp:<opType>:<opSuffix>”. isInverseOp
is used to indicate an inverse transformation operation.
a UsdGeomXformOp that can be used to author to the operation. An error
is issued and the returned object will be invalid (evaluate to false)
if the op being added already exists in xformOpOrder or if the
arguments supplied are invalid.
If the attribute associated with the op already exists, but isn’t of
the requested precision, a coding error is issued, but a valid xformOp
is returned with the existing attribute.
Parameters
opType (XformOp.Type) –
precision (XformOp.Precision) –
opSuffix (str) –
isInverseOp (bool) –
ClearXformOpOrder() → bool
Clears the local transform stack.
CreateXformOpOrderAttr(defaultValue, writeSparsely) → Attribute
See GetXformOpOrderAttr() , and also Create vs Get Property Methods
for when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
static Get()
classmethod Get(stage, path) -> Xformable
Return a UsdGeomXformable holding the prim adhering to this schema at
path on stage .
If no prim exists at path on stage , or if the prim at that
path does not adhere to this schema, return an invalid schema object.
This is shorthand for the following:
UsdGeomXformable(stage->GetPrimAtPath(path));
Parameters
stage (Stage) –
path (Path) –
GetLocalTransformation()
Compute the fully-combined, local-to-parent transformation for this prim.
If a client does not need to manipulate the individual ops themselves, and requires only the combined transform on this prim, this method will take care of all the data marshalling and linear algebra needed to combine the ops into a 4x4 affine transformation matrix, in double-precision, regardless of the precision of the op inputs.
The python version of this function only returns the computed local-to-parent transformation. Clients must independently call GetResetXformStack() to be able to construct the local-to-world transformation.
Compute the fully-combined, local-to-parent transformation for this prim as efficiently as possible, using pre-fetched list of ordered xform ops supplied by the client.
The python version of this function only returns the computed local-to-parent transformation. Clients must independently call GetResetXformStack() to be able to construct the local-to-world transformation.
GetOrderedXformOps()
Return the ordered list of transform operations to be applied to this prim, in least-to-most-local order. This is determined by the intersection of authored op-attributes and the explicit ordering of those attributes encoded in the “xformOpOrder” attribute on this prim.
Any entries in “xformOpOrder” that do not correspond to valid attributes on the xformable prim are skipped and a warning is issued.
A UsdGeomTransformable that has not had any ops added via AddXformOp() will return an empty vector.
The python version of this function only returns the ordered list of xformOps. Clients must independently call GetResetXformStack() if they need the info.
GetResetXformStack() → bool
Does this prim reset its parent’s inherited transformation?
Returns true if”!resetXformStack!”appears anywhere in xformOpOrder.
When this returns true, all ops upto the last”!resetXformStack!”in
xformOpOrder are ignored when computing the local transformation.
static GetSchemaAttributeNames()
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
Return a vector of names of all pre-declared attributes for this
schema class and all its ancestor classes.
Does not include attributes that may be authored by custom/extended
methods of the schemas involved.
Parameters
includeInherited (bool) –
GetTimeSamples()
classmethod GetTimeSamples(times) -> bool
Sets times to the union of all the timesamples at which xformOps
that are included in the xformOpOrder attribute are authored.
This clears the times vector before accumulating sample times from
all the xformOps.
UsdAttribute::GetTimeSamples
Parameters
times (list[float]) –
GetTimeSamples(orderedXformOps, times) -> bool
Returns the union of all the timesamples at which the attributes
belonging to the given orderedXformOps are authored.
This clears the times vector before accumulating sample times from
orderedXformOps .
UsdGeomXformable::GetTimeSamples
Parameters
orderedXformOps (list[XformOp]) –
times (list[float]) –
GetTimeSamplesInInterval()
classmethod GetTimeSamplesInInterval(interval, times) -> bool
Sets times to the union of all the timesamples in the interval,
interval , at which xformOps that are included in the xformOpOrder
attribute are authored.
This clears the times vector before accumulating sample times from
all the xformOps.
UsdAttribute::GetTimeSamples
Parameters
interval (Interval) –
times (list[float]) –
GetTimeSamplesInInterval(orderedXformOps, interval, times) -> bool
Returns the union of all the timesamples in the interval at which
the attributes belonging to the given orderedXformOps are
authored.
This clears the times vector before accumulating sample times from
orderedXformOps .
UsdGeomXformable::GetTimeSamplesInInterval
Parameters
orderedXformOps (list[XformOp]) –
interval (Interval) –
times (list[float]) –
GetXformOpOrderAttr() → Attribute
Encodes the sequence of transformation operations in the order in
which they should be pushed onto a transform stack while visiting a
UsdStage ‘s prims in a graph traversal that will effect the desired
positioning for this prim and its descendant prims.
You should rarely, if ever, need to manipulate this attribute
directly. It is managed by the AddXformOp() , SetResetXformStack() ,
and SetXformOpOrder() , and consulted by GetOrderedXformOps() and
GetLocalTransformation() .
Declaration
uniform token[] xformOpOrder
C++ Type
VtArray<TfToken>
Usd Type
SdfValueTypeNames->TokenArray
Variability
SdfVariabilityUniform
static IsTransformationAffectedByAttrNamed()
classmethod IsTransformationAffectedByAttrNamed(attrName) -> bool
Returns true if the attribute named attrName could affect the
local transformation of an xformable prim.
Parameters
attrName (str) –
MakeMatrixXform() → XformOp
Clears the existing local transform stack and creates a new xform op
of type’transform’.
This API is provided for convenience since this is the most common
xform authoring operation.
ClearXformOpOrder()
AddTransformOp()
SetResetXformStack(resetXform) → bool
Specify whether this prim’s transform should reset the transformation
stack inherited from its parent prim.
By default, parent transforms are inherited. SetResetXformStack() can
be called at any time during authoring, but will always add
a’!resetXformStack!’op as the first op in the ordered list, if one
does not exist already. If one already exists, and resetXform is
false, it will remove all ops upto and including the
last”!resetXformStack!”op.
Parameters
resetXform (bool) –
SetXformOpOrder(orderedXformOps, resetXformStack) → bool
Reorder the already-existing transform ops on this prim.
All elements in orderedXformOps must be valid and represent
attributes on this prim. Note that it is not required that all the
existing operations be present in orderedXformOps , so this method
can be used to completely change the transformation structure applied
to the prim.
If resetXformStack is set to true, then “!resetXformOp! will be
set as the first op in xformOpOrder, to indicate that the prim does
not inherit its parent’s transformation.
If you wish to re-specify a prim’s transformation completely in a
stronger layer, you should first call this method with an empty
orderedXformOps vector. From there you can call AddXformOp() just
as if you were authoring to the prim from scratch.
false if any of the elements of orderedXformOps are not extant on
this prim, or if an error occurred while authoring the ordering
metadata. Under either condition, no scene description is authored.
GetOrderedXformOps()
Parameters
orderedXformOps (list[XformOp]) –
resetXformStack (bool) –
TransformMightBeTimeVarying() → bool
Determine whether there is any possibility that this prim’s local
transformation may vary over time.
The determination is based on a snapshot of the authored state of the
op attributes on the prim, and may become invalid in the face of
further authoring.
TransformMightBeTimeVarying(ops) -> bool
This is an overloaded member function, provided for convenience. It
differs from the above function only in what argument(s) it accepts.
Determine whether there is any possibility that this prim’s local
transformation may vary over time, using a pre-fetched (cached) list
of ordered xform ops supplied by the client.
The determination is based on a snapshot of the authored state of the
op attributes on the prim, and may become invalid in the face of
further authoring.
Parameters
ops (list[XformOp]) –
© Copyright 2019-2023, NVIDIA.
Last updated on Nov 14, 2023. |
omni.ui.AbstractItemModel.md | AbstractItemModel — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
AbstractItemModel
# AbstractItemModel
class omni.ui.AbstractItemModel
Bases: pybind11_object
The central component of the item widget. It is the application’s dynamic data structure, independent of the user interface, and it directly manages the nested data. It follows closely model-view pattern. It’s abstract, and it defines the standard interface to be able to interoperate with the components of the model-view architecture. It is not supposed to be instantiated directly. Instead, the user should subclass it to create a new model.
The item model doesn’t return the data itself. Instead, it returns the value model that can contain any data type and supports callbacks. Thus the client of the model can track the changes in both the item model and any value it holds.
From any item, the item model can get both the value model and the nested items. Therefore, the model is flexible to represent anything from color to complicated tree-table construction.
Methods
__init__(self)
Constructs AbstractItemModel.
add_begin_edit_fn(self, arg0)
Adds the function that will be called every time the user starts the editing.
add_end_edit_fn(self, arg0)
Adds the function that will be called every time the user finishes the editing.
add_item_changed_fn(self, arg0)
Adds the function that will be called every time the value changes.
append_child_item(self, parentItem, model)
Creates a new item from the value model and appends it to the list of the children of the given item.
begin_edit(self, item)
Called when the user starts the editing.
can_item_have_children(self[, parentItem])
Returns true if the item can have children.
drop(*args, **kwargs)
Overloaded function.
drop_accepted(*args, **kwargs)
Overloaded function.
end_edit(self, item)
Called when the user finishes the editing.
get_drag_mime_data(self[, item])
Returns Multipurpose Internet Mail Extensions (MIME) for drag and drop.
get_item_children(self[, parentItem])
Returns the vector of items that are nested to the given parent item.
get_item_value_model(self[, item, column_id])
Get the value model associated with this item.
get_item_value_model_count(self[, item])
Returns the number of columns this model item contains.
remove_begin_edit_fn(self, arg0)
Remove the callback by its id.
remove_end_edit_fn(self, arg0)
Remove the callback by its id.
remove_item(self, item)
Removes the item from the model.
remove_item_changed_fn(self, arg0)
Remove the callback by its id.
subscribe_begin_edit_fn(self, arg0)
Adds the function that will be called every time the user starts the editing.
subscribe_end_edit_fn(self, arg0)
Adds the function that will be called every time the user finishes the editing.
subscribe_item_changed_fn(self, arg0)
Adds the function that will be called every time the value changes.
__init__(self: omni.ui._ui.AbstractItemModel) → None
Constructs AbstractItemModel.
`kwargsdict`See below
### Keyword Arguments:
add_begin_edit_fn(self: omni.ui._ui.AbstractItemModel, arg0: Callable[[omni.ui._ui.AbstractItemModel, omni.ui._ui.AbstractItem], None]) → int
Adds the function that will be called every time the user starts the editing.
The id of the callback that is used to remove the callback.
add_end_edit_fn(self: omni.ui._ui.AbstractItemModel, arg0: Callable[[omni.ui._ui.AbstractItemModel, omni.ui._ui.AbstractItem], None]) → int
Adds the function that will be called every time the user finishes the editing.
The id of the callback that is used to remove the callback.
add_item_changed_fn(self: omni.ui._ui.AbstractItemModel, arg0: Callable[[omni.ui._ui.AbstractItemModel, omni.ui._ui.AbstractItem], None]) → int
Adds the function that will be called every time the value changes.
The id of the callback that is used to remove the callback.
append_child_item(self: omni.ui._ui.AbstractItemModel, parentItem: omni.ui._ui.AbstractItem, model: omni.ui._ui.AbstractValueModel) → omni.ui._ui.AbstractItem
Creates a new item from the value model and appends it to the list of the children of the given item.
begin_edit(self: omni.ui._ui.AbstractItemModel, item: omni.ui._ui.AbstractItem) → None
Called when the user starts the editing. If it’s a field, this method is called when the user activates the field and places the cursor inside.
can_item_have_children(self: omni.ui._ui.AbstractItemModel, parentItem: omni.ui._ui.AbstractItem = None) → bool
Returns true if the item can have children. In this way the delegate usually draws +/- icon.
### Arguments:
`id :`The item to request children from. If it’s null, the children of root will be returned.
drop(*args, **kwargs)
Overloaded function.
drop(self: omni.ui._ui.AbstractItemModel, item_tagget: omni.ui._ui.AbstractItem, item_source: omni.ui._ui.AbstractItem, drop_location: int = -1) -> None
Called when the user droped one item to another.
Small explanation why the same default value is declared in multiple places. We use the default value to be compatible with the previous API and especially with Stage 2.0. Thr signature in the old Python API is:
def drop(self, target_item, source)
drop(self, target_item, source)
PyAbstractItemModel::drop
AbstractItemModel.drop
pybind11::class_<AbstractItemModel>.def(“drop”)
AbstractItemModel
drop(self: omni.ui._ui.AbstractItemModel, item_tagget: omni.ui._ui.AbstractItem, source: str, drop_location: int = -1) -> None
Called when the user droped a string to the item.
drop_accepted(*args, **kwargs)
Overloaded function.
drop_accepted(self: omni.ui._ui.AbstractItemModel, item_tagget: omni.ui._ui.AbstractItem, item_source: omni.ui._ui.AbstractItem, drop_location: int = -1) -> bool
Called to determine if the model can perform drag and drop to the given item. If this method returns false, the widget shouldn’t highlight the visual element that represents this item.
drop_accepted(self: omni.ui._ui.AbstractItemModel, item_tagget: omni.ui._ui.AbstractItem, source: str, drop_location: int = -1) -> bool
Called to determine if the model can perform drag and drop of the given string to the given item. If this method returns false, the widget shouldn’t highlight the visual element that represents this item.
end_edit(self: omni.ui._ui.AbstractItemModel, item: omni.ui._ui.AbstractItem) → None
Called when the user finishes the editing. If it’s a field, this method is called when the user presses Enter or selects another field for editing. It’s useful for undo/redo.
get_drag_mime_data(self: omni.ui._ui.AbstractItemModel, item: omni.ui._ui.AbstractItem = None) → str
Returns Multipurpose Internet Mail Extensions (MIME) for drag and drop.
get_item_children(self: omni.ui._ui.AbstractItemModel, parentItem: omni.ui._ui.AbstractItem = None) → List[omni.ui._ui.AbstractItem]
Returns the vector of items that are nested to the given parent item.
### Arguments:
`id :`The item to request children from. If it’s null, the children of root will be returned.
get_item_value_model(self: omni.ui._ui.AbstractItemModel, item: omni.ui._ui.AbstractItem = None, column_id: int = 0) → omni.ui._ui.AbstractValueModel
Get the value model associated with this item.
### Arguments:
`item :`The item to request the value model from. If it’s null, the root value model will be returned.
`index :`The column number to get the value model.
get_item_value_model_count(self: omni.ui._ui.AbstractItemModel, item: omni.ui._ui.AbstractItem = None) → int
Returns the number of columns this model item contains.
remove_begin_edit_fn(self: omni.ui._ui.AbstractItemModel, arg0: int) → None
Remove the callback by its id.
### Arguments:
`id :`The id that addBeginEditFn returns.
remove_end_edit_fn(self: omni.ui._ui.AbstractItemModel, arg0: int) → None
Remove the callback by its id.
### Arguments:
`id :`The id that addEndEditFn returns.
remove_item(self: omni.ui._ui.AbstractItemModel, item: omni.ui._ui.AbstractItem) → None
Removes the item from the model.
There is no parent here because we assume that the reimplemented model deals with its data and can figure out how to remove this item.
remove_item_changed_fn(self: omni.ui._ui.AbstractItemModel, arg0: int) → None
Remove the callback by its id.
### Arguments:
`id :`The id that addValueChangedFn returns.
subscribe_begin_edit_fn(self: omni.ui._ui.AbstractItemModel, arg0: Callable[[omni.ui._ui.AbstractItemModel, omni.ui._ui.AbstractItem], None]) → carb._carb.Subscription
Adds the function that will be called every time the user starts the editing.
The id of the callback that is used to remove the callback.
subscribe_end_edit_fn(self: omni.ui._ui.AbstractItemModel, arg0: Callable[[omni.ui._ui.AbstractItemModel, omni.ui._ui.AbstractItem], None]) → carb._carb.Subscription
Adds the function that will be called every time the user finishes the editing.
The id of the callback that is used to remove the callback.
subscribe_item_changed_fn(self: omni.ui._ui.AbstractItemModel, arg0: Callable[[omni.ui._ui.AbstractItemModel, omni.ui._ui.AbstractItem], None]) → carb._carb.Subscription
Adds the function that will be called every time the value changes.
The id of the callback that is used to remove the callback.
© Copyright 2019-2024, NVIDIA.
Last updated on Mar 25, 2024. |
release-notes.md | Release Notes — Omniverse Launcher latest documentation
Omniverse Launcher
»
Omniverse Launcher »
Release Notes
# Release Notes
Note
For Release Notes related to features in the Nucleus tab, please review the Omniverse Nucleus Navigator Release Notes.
## Current Release
### 1.9.11
Release Date: April 2024
### Fixed
Fixed an issue where Launcher was minimized to the system tray instead of exiting when users clicked on Exit option in user settings menu.
Fixed a race condition that could cause settings reset. [OM-118568]
Fixed gallery positioning for content packs. [OM-118695]
Fixed beta banner positioning on the Exchange tab. [OM-119105]
Fixed an issue on the Hub page settings that caused showing “infinity” in disk chart for Linux. [HUB-965]
Fixed cache size max validations on Hub page settings tab. [OM-119136]
Fixed cache size decimal points validations on Hub page settings tab. [OM-119335]
Fixed Hub Total Disk Space chart to not allow available disk space to become negative. [HUB-966]
Fixed an issue on the Hub page settings that caused showing “infinity” in disk chart for Linux. [HUB-965]
Fixed an issue on the Hub page settings that cause cache size not to be displayed. [HUB-960]
Fixed an issue on the Hub page settings preventing editing Cleanup Threshold. [OM-119137]
Fixed Hub page settings chart drive/mount detection size based on cache path. [HUB-970]
Replace Omniverse Beta license agreement text with NVIDIA License and add license agreement link in the About dialog. [OM-120991]
## All Release Notes
1.9.8
1.9.11
Fixed
1.9.10
1.8.7
1.8.2
1.8.11
1.7.1
1.6.10
1.5.7
1.5.5
1.5.4
1.5.3
1.5.1
1.4.0
1.3.4
1.3.3
1.2.8
1.1.2
1.0.50
1.0.42
1.00.48
© Copyright 2023-2024, NVIDIA.
Last updated on Apr 15, 2024. |
omni.ui.WidgetMouseDropEvent.md | WidgetMouseDropEvent — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
WidgetMouseDropEvent
# WidgetMouseDropEvent
class omni.ui.WidgetMouseDropEvent
Bases: pybind11_object
Holds the data which is sent when a drag and drop action is completed.
Methods
__init__(*args, **kwargs)
Attributes
mime_data
The data that was dropped on the widget.
x
Position where the drop was made.
y
Position where the drop was made.
__init__(*args, **kwargs)
property mime_data
The data that was dropped on the widget.
property x
Position where the drop was made.
property y
Position where the drop was made.
© Copyright 2019-2024, NVIDIA.
Last updated on Mar 25, 2024. |
1_5_5.md | 1.5.5 — Omniverse Launcher latest documentation
Omniverse Launcher
»
Omniverse Launcher »
Release Notes »
1.5.5
# 1.5.5
Release Date: June 2022
## Fixed
Fixed an issue related to refreshing the session when installing new apps after desktop comes out of sleep mode.
Fixed an issue where connectors displayed in the library were enlarged.
Fixed an issue related to a blank error when Launcher is started without internet connection.
Fixed an issue where “Data collection and use” did not reset the language on dialog cancel.
Fixed an issue where trailing slashes were omitted when Launcher opened omniverse:// links.
© Copyright 2023-2024, NVIDIA.
Last updated on Apr 15, 2024. |
omni.ui.RasterImageProvider.md | RasterImageProvider — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
RasterImageProvider
# RasterImageProvider
class omni.ui.RasterImageProvider
Bases: ImageProvider
doc
Methods
__init__(self[, source_url])
doc
Attributes
max_mip_levels
Maximum number of mip map levels allowed
source_url
Sets byte data that the image provider will turn into an image.
__init__(self: omni.ui._ui.RasterImageProvider, source_url: str = None, **kwargs) → None
doc
property max_mip_levels
Maximum number of mip map levels allowed
property source_url
Sets byte data that the image provider will turn into an image.
© Copyright 2019-2024, NVIDIA.
Last updated on Mar 25, 2024. |
Sdf.md | Sdf module — pxr-usd-api 105.1 documentation
pxr-usd-api
»
Modules »
Sdf module
# Sdf module
Summary: The Sdf (Scene Description Foundation) provides foundations for serializing scene description and primitive abstractions for interacting.
Classes:
AngularUnit
AssetPath
Contains an asset path and an optional resolved path.
AssetPathArray
An array of type SdfAssetPath.
AttributeSpec
A subclass of SdfPropertySpec that holds typed data.
AuthoringError
BatchNamespaceEdit
A description of an arbitrarily complex namespace edit.
ChangeBlock
DANGER DANGER DANGER
ChildrenView_Sdf_AttributeChildPolicy_SdfAttributeViewPredicate
ChildrenView_Sdf_AttributeChildPolicy_SdfChildrenViewTrivialPredicate_SdfHandle_SdfAttributeSpec___
ChildrenView_Sdf_PrimChildPolicy_SdfChildrenViewTrivialPredicate_SdfHandle_SdfPrimSpec___
ChildrenView_Sdf_PropertyChildPolicy_SdfChildrenViewTrivialPredicate_SdfHandle_SdfPropertySpec___
ChildrenView_Sdf_RelationshipChildPolicy_SdfRelationshipViewPredicate
ChildrenView_Sdf_VariantChildPolicy_SdfChildrenViewTrivialPredicate_SdfHandle_SdfVariantSpec___
ChildrenView_Sdf_VariantSetChildPolicy_SdfChildrenViewTrivialPredicate_SdfHandle_SdfVariantSetSpec___
CleanupEnabler
An RAII class which, when an instance is alive, enables scheduling of automatic cleanup of SdfLayers.
DimensionlessUnit
FastUpdateList
FileFormat
Base class for file format implementations.
Int64ListOp
IntListOp
Layer
A scene description container that can combine with other such containers to form simple component assets, and successively larger aggregates.
LayerOffset
Represents a time offset and scale between layers.
LayerTree
A SdfLayerTree is an immutable tree structure representing a sublayer stack and its recursive structure.
LengthUnit
ListEditorProxy_SdfNameKeyPolicy
ListEditorProxy_SdfPathKeyPolicy
ListEditorProxy_SdfPayloadTypePolicy
ListEditorProxy_SdfReferenceTypePolicy
ListOpType
ListProxy_SdfNameKeyPolicy
ListProxy_SdfNameTokenKeyPolicy
ListProxy_SdfPathKeyPolicy
ListProxy_SdfPayloadTypePolicy
ListProxy_SdfReferenceTypePolicy
ListProxy_SdfSubLayerTypePolicy
MapEditProxy_VtDictionary
MapEditProxy_map_SdfPath_SdfPath_less_SdfPath__allocator_pair_SdfPath_const__SdfPath_____
MapEditProxy_map_string_string_less_string__allocator_pair_stringconst__string_____
NamespaceEdit
A single namespace edit.
NamespaceEditDetail
Detailed information about a namespace edit.
Notice
Wrapper class for Sdf notices.
Path
A path value used to locate objects in layers or scenegraphs.
PathArray
An array of type SdfPath.
PathListOp
Payload
Represents a payload and all its meta data.
PayloadListOp
Permission
PrimSpec
Represents a prim description in an SdfLayer object.
PropertySpec
Base class for SdfAttributeSpec and SdfRelationshipSpec.
PseudoRootSpec
Reference
Represents a reference and all its meta data.
ReferenceListOp
RelationshipSpec
A property that contains a reference to one or more SdfPrimSpec instances.
Spec
Base class for all Sdf spec classes.
SpecType
Specifier
StringListOp
TimeCode
Value type that represents a time code.
TimeCodeArray
An array of type SdfTimeCode.
TokenListOp
UInt64ListOp
UIntListOp
UnregisteredValue
Stores a representation of the value for an unregistered metadata field encountered during text layer parsing.
UnregisteredValueListOp
ValueBlock
A special value type that can be used to explicitly author an opinion for an attribute's default value or time sample value that represents having no value.
ValueRoleNames
ValueTypeName
Represents a value type name, i.e. an attribute's type name.
ValueTypeNames
Variability
VariantSetSpec
Represents a coherent set of alternate representations for part of a scene.
VariantSpec
Represents a single variant in a variant set.
Functions:
Find(layerFileName, scenePath)
layerFileName: string scenePath: Path
class pxr.Sdf.AngularUnit
Methods:
GetValueFromName
Attributes:
allValues
static GetValueFromName()
allValues = (Sdf.AngularUnitDegrees, Sdf.AngularUnitRadians)
class pxr.Sdf.AssetPath
Contains an asset path and an optional resolved path. Asset paths may
contain non-control UTF-8 encoded characters. Specifically,
U+0000..U+001F (C0 controls), U+007F (delete), and
U+0080..U+009F (C1 controls) are disallowed. Attempts to construct
asset paths with such characters will issue a TfError and produce the
default-constructed empty asset path.
Attributes:
path
resolvedPath
str
property path
property resolvedPath
str
Return the resolved asset path, if any.
Note that SdfAssetPath carries a resolved path only if its creator
passed one to the constructor. SdfAssetPath never performs resolution
itself.
type : str
Overload for rvalues, move out the asset path.
Type
type
class pxr.Sdf.AssetPathArray
An array of type SdfAssetPath.
class pxr.Sdf.AttributeSpec
A subclass of SdfPropertySpec that holds typed data.
Attributes are typed data containers that can optionally hold any and
all of the following:
A single default value.
An array of knot values describing how the value varies over
time.
A dictionary of posed values, indexed by name.
The values contained in an attribute must all be of the same type. In
the Python API the typeName property holds the attribute type. In
the C++ API, you can get the attribute type using the GetTypeName()
method. In addition, all values, including all knot values, must be
the same shape. For information on shapes, see the VtShape class
reference in the C++ documentation.
Methods:
ClearColorSpace()
Clears the colorSpace metadata value set on this attribute.
HasColorSpace()
Returns true if this attribute has a colorSpace value authored.
Attributes:
ConnectionPathsKey
DefaultValueKey
DisplayUnitKey
allowedTokens
The allowed value tokens for this property
colorSpace
The color-space in which the attribute value is authored.
connectionPathList
A PathListEditor for the attribute's connection paths.
displayUnit
The display unit for this attribute.
expired
roleName
The roleName for this attribute's typeName.
typeName
The typename of this attribute.
valueType
The value type of this attribute.
ClearColorSpace() → None
Clears the colorSpace metadata value set on this attribute.
HasColorSpace() → bool
Returns true if this attribute has a colorSpace value authored.
ConnectionPathsKey = 'connectionPaths'
DefaultValueKey = 'default'
DisplayUnitKey = 'displayUnit'
property allowedTokens
The allowed value tokens for this property
property colorSpace
The color-space in which the attribute value is authored.
property connectionPathList
A PathListEditor for the attribute’s connection paths.
The list of the connection paths for this attribute may be modified with this PathListEditor.
A PathListEditor may express a list either as an explicit value or as a set of list editing operations. See GdListEditor for more information.
property displayUnit
The display unit for this attribute.
property expired
property roleName
The roleName for this attribute’s typeName.
property typeName
The typename of this attribute.
property valueType
The value type of this attribute.
class pxr.Sdf.AuthoringError
Methods:
GetValueFromName
Attributes:
allValues
static GetValueFromName()
allValues = (Sdf.AuthoringErrorUnrecognizedFields, Sdf.AuthoringErrorUnrecognizedSpecType)
class pxr.Sdf.BatchNamespaceEdit
A description of an arbitrarily complex namespace edit.
A SdfBatchNamespaceEdit object describes zero or more namespace
edits. Various types providing a namespace will allow the edits to be
applied in a single operation and also allow testing if this will
work.
Clients are encouraged to group several edits into one object because
that may allow more efficient processing of the edits. If, for
example, you need to reparent several prims it may be faster to add
all of the reparents to a single SdfBatchNamespaceEdit and apply
them at once than to apply each separately.
Objects that allow applying edits are free to apply the edits in any
way and any order they see fit but they should guarantee that the
resulting namespace will be as if each edit was applied one at a time
in the order they were added.
Note that the above rule permits skipping edits that have no effect or
generate a non-final state. For example, if renaming A to B then to C
we could just rename A to C. This means notices may be elided.
However, implementations must not elide notices that contain
information about any edit that clients must be able to know but
otherwise cannot determine.
Methods:
Add(edit)
Add a namespace edit.
Process(processedEdits, hasObjectAtPath, ...)
Validate the edits and generate a possibly more efficient edit sequence.
Attributes:
edits
list[SdfNamespaceEdit]
Add(edit) → None
Add a namespace edit.
Parameters
edit (NamespaceEdit) –
Add(currentPath, newPath, index) -> None
Add a namespace edit.
Parameters
currentPath (NamespaceEdit.Path) –
newPath (NamespaceEdit.Path) –
index (NamespaceEdit.Index) –
Process(processedEdits, hasObjectAtPath, canEdit, details, fixBackpointers) → bool
Validate the edits and generate a possibly more efficient edit
sequence.
Edits are treated as if they were performed one at time in sequence,
therefore each edit occurs in the namespace resulting from all
previous edits.
Editing the descendants of the object in each edit is implied. If an
object is removed then the new path will be empty. If an object is
removed after being otherwise edited, the other edits will be
processed and included in processedEdits followed by the removal.
This allows clients to fixup references to point to the object’s final
location prior to removal.
This function needs help to determine if edits are allowed. The
callbacks provide that help. hasObjectAtPath returns true iff
there’s an object at the given path. This path will be in the original
namespace not any intermediate or final namespace. canEdit returns
true iff the object at the current path can be namespace edited to
the new path, ignoring whether an object already exists at the new
path. Both paths are in the original namespace. If it returns
false it should set the string to the reason why the edit isn’t
allowed. It should not write either path to the string.
If hasObjectAtPath is invalid then this assumes objects exist
where they should and don’t exist where they shouldn’t. Use this with
care. If canEdit in invalid then it’s assumed all edits are valid.
If fixBackpointers is true then target/connection paths are
expected to be in the intermediate namespace resulting from all
previous edits. If false and any current or new path contains a
target or connection path that has been edited then this will generate
an error.
This method returns true if the edits are allowed and sets
processedEdits to a new edit sequence at least as efficient as the
input sequence. If not allowed it returns false and appends
reasons why not to details .
Parameters
processedEdits (list[SdfNamespaceEdit]) –
hasObjectAtPath (HasObjectAtPath) –
canEdit (CanEdit) –
details (list[SdfNamespaceEditDetail]) –
fixBackpointers (bool) –
property edits
list[SdfNamespaceEdit]
Returns the edits.
Type
type
class pxr.Sdf.ChangeBlock
DANGER DANGER DANGER
Please make sure you have read and fully understand the issues below
before using a changeblock! They are very easy to use in an unsafe way
that could make the system crash or corrupt data. If you have any
questions, please contact the USD team, who would be happy to help!
SdfChangeBlock provides a way to group a round of related changes to
scene description in order to process them more efficiently.
Normally, Sdf sends notification immediately as changes are made so
that downstream representations like UsdStage can update accordingly.
However, sometimes it can be advantageous to group a series of Sdf
changes into a batch so that they can be processed more efficiently,
with a single round of change processing. An example might be when
setting many avar values on a model at the same time.
Opening a changeblock tells Sdf to delay sending notification about
changes until the outermost changeblock is exited. Until then, Sdf
internally queues up the notification it needs to send.
It is not safe to use Usd or other downstream API while a
changeblock is open!! This is because those derived representations
will not have had a chance to update while the changeblock is open.
Not only will their view of the world be stale, it could be unsafe to
even make queries from, since they may be holding onto expired handles
to Sdf objects that no longer exist. If you need to make a bunch of
changes to scene description, the best approach is to build a list of
necessary changes that can be performed directly via the Sdf API, then
submit those all inside a changeblock without talking to any
downstream modules. For example, this is how many mutators in Usd
that operate on more than one field or Spec work.
class pxr.Sdf.ChildrenView_Sdf_AttributeChildPolicy_SdfAttributeViewPredicate
Classes:
ChildrenView_Sdf_AttributeChildPolicy_SdfAttributeViewPredicate_Iterator
ChildrenView_Sdf_AttributeChildPolicy_SdfAttributeViewPredicate_KeyIterator
ChildrenView_Sdf_AttributeChildPolicy_SdfAttributeViewPredicate_ValueIterator
Methods:
get
index
items
keys
values
class ChildrenView_Sdf_AttributeChildPolicy_SdfAttributeViewPredicate_Iterator
class ChildrenView_Sdf_AttributeChildPolicy_SdfAttributeViewPredicate_KeyIterator
class ChildrenView_Sdf_AttributeChildPolicy_SdfAttributeViewPredicate_ValueIterator
get()
index()
items()
keys()
values()
class pxr.Sdf.ChildrenView_Sdf_AttributeChildPolicy_SdfChildrenViewTrivialPredicate_SdfHandle_SdfAttributeSpec___
Classes:
ChildrenView_Sdf_AttributeChildPolicy_SdfChildrenViewTrivialPredicate_SdfHandle_SdfAttributeSpec____Iterator
ChildrenView_Sdf_AttributeChildPolicy_SdfChildrenViewTrivialPredicate_SdfHandle_SdfAttributeSpec____KeyIterator
ChildrenView_Sdf_AttributeChildPolicy_SdfChildrenViewTrivialPredicate_SdfHandle_SdfAttributeSpec____ValueIterator
Methods:
get
index
items
keys
values
class ChildrenView_Sdf_AttributeChildPolicy_SdfChildrenViewTrivialPredicate_SdfHandle_SdfAttributeSpec____Iterator
class ChildrenView_Sdf_AttributeChildPolicy_SdfChildrenViewTrivialPredicate_SdfHandle_SdfAttributeSpec____KeyIterator
class ChildrenView_Sdf_AttributeChildPolicy_SdfChildrenViewTrivialPredicate_SdfHandle_SdfAttributeSpec____ValueIterator
get()
index()
items()
keys()
values()
class pxr.Sdf.ChildrenView_Sdf_PrimChildPolicy_SdfChildrenViewTrivialPredicate_SdfHandle_SdfPrimSpec___
Classes:
ChildrenView_Sdf_PrimChildPolicy_SdfChildrenViewTrivialPredicate_SdfHandle_SdfPrimSpec____Iterator
ChildrenView_Sdf_PrimChildPolicy_SdfChildrenViewTrivialPredicate_SdfHandle_SdfPrimSpec____KeyIterator
ChildrenView_Sdf_PrimChildPolicy_SdfChildrenViewTrivialPredicate_SdfHandle_SdfPrimSpec____ValueIterator
Methods:
get
index
items
keys
values
class ChildrenView_Sdf_PrimChildPolicy_SdfChildrenViewTrivialPredicate_SdfHandle_SdfPrimSpec____Iterator
class ChildrenView_Sdf_PrimChildPolicy_SdfChildrenViewTrivialPredicate_SdfHandle_SdfPrimSpec____KeyIterator
class ChildrenView_Sdf_PrimChildPolicy_SdfChildrenViewTrivialPredicate_SdfHandle_SdfPrimSpec____ValueIterator
get()
index()
items()
keys()
values()
class pxr.Sdf.ChildrenView_Sdf_PropertyChildPolicy_SdfChildrenViewTrivialPredicate_SdfHandle_SdfPropertySpec___
Classes:
ChildrenView_Sdf_PropertyChildPolicy_SdfChildrenViewTrivialPredicate_SdfHandle_SdfPropertySpec____Iterator
ChildrenView_Sdf_PropertyChildPolicy_SdfChildrenViewTrivialPredicate_SdfHandle_SdfPropertySpec____KeyIterator
ChildrenView_Sdf_PropertyChildPolicy_SdfChildrenViewTrivialPredicate_SdfHandle_SdfPropertySpec____ValueIterator
Methods:
get
index
items
keys
values
class ChildrenView_Sdf_PropertyChildPolicy_SdfChildrenViewTrivialPredicate_SdfHandle_SdfPropertySpec____Iterator
class ChildrenView_Sdf_PropertyChildPolicy_SdfChildrenViewTrivialPredicate_SdfHandle_SdfPropertySpec____KeyIterator
class ChildrenView_Sdf_PropertyChildPolicy_SdfChildrenViewTrivialPredicate_SdfHandle_SdfPropertySpec____ValueIterator
get()
index()
items()
keys()
values()
class pxr.Sdf.ChildrenView_Sdf_RelationshipChildPolicy_SdfRelationshipViewPredicate
Classes:
ChildrenView_Sdf_RelationshipChildPolicy_SdfRelationshipViewPredicate_Iterator
ChildrenView_Sdf_RelationshipChildPolicy_SdfRelationshipViewPredicate_KeyIterator
ChildrenView_Sdf_RelationshipChildPolicy_SdfRelationshipViewPredicate_ValueIterator
Methods:
get
index
items
keys
values
class ChildrenView_Sdf_RelationshipChildPolicy_SdfRelationshipViewPredicate_Iterator
class ChildrenView_Sdf_RelationshipChildPolicy_SdfRelationshipViewPredicate_KeyIterator
class ChildrenView_Sdf_RelationshipChildPolicy_SdfRelationshipViewPredicate_ValueIterator
get()
index()
items()
keys()
values()
class pxr.Sdf.ChildrenView_Sdf_VariantChildPolicy_SdfChildrenViewTrivialPredicate_SdfHandle_SdfVariantSpec___
Classes:
ChildrenView_Sdf_VariantChildPolicy_SdfChildrenViewTrivialPredicate_SdfHandle_SdfVariantSpec____Iterator
ChildrenView_Sdf_VariantChildPolicy_SdfChildrenViewTrivialPredicate_SdfHandle_SdfVariantSpec____KeyIterator
ChildrenView_Sdf_VariantChildPolicy_SdfChildrenViewTrivialPredicate_SdfHandle_SdfVariantSpec____ValueIterator
Methods:
get
index
items
keys
values
class ChildrenView_Sdf_VariantChildPolicy_SdfChildrenViewTrivialPredicate_SdfHandle_SdfVariantSpec____Iterator
class ChildrenView_Sdf_VariantChildPolicy_SdfChildrenViewTrivialPredicate_SdfHandle_SdfVariantSpec____KeyIterator
class ChildrenView_Sdf_VariantChildPolicy_SdfChildrenViewTrivialPredicate_SdfHandle_SdfVariantSpec____ValueIterator
get()
index()
items()
keys()
values()
class pxr.Sdf.ChildrenView_Sdf_VariantSetChildPolicy_SdfChildrenViewTrivialPredicate_SdfHandle_SdfVariantSetSpec___
Classes:
ChildrenView_Sdf_VariantSetChildPolicy_SdfChildrenViewTrivialPredicate_SdfHandle_SdfVariantSetSpec____Iterator
ChildrenView_Sdf_VariantSetChildPolicy_SdfChildrenViewTrivialPredicate_SdfHandle_SdfVariantSetSpec____KeyIterator
ChildrenView_Sdf_VariantSetChildPolicy_SdfChildrenViewTrivialPredicate_SdfHandle_SdfVariantSetSpec____ValueIterator
Methods:
get
index
items
keys
values
class ChildrenView_Sdf_VariantSetChildPolicy_SdfChildrenViewTrivialPredicate_SdfHandle_SdfVariantSetSpec____Iterator
class ChildrenView_Sdf_VariantSetChildPolicy_SdfChildrenViewTrivialPredicate_SdfHandle_SdfVariantSetSpec____KeyIterator
class ChildrenView_Sdf_VariantSetChildPolicy_SdfChildrenViewTrivialPredicate_SdfHandle_SdfVariantSetSpec____ValueIterator
get()
index()
items()
keys()
values()
class pxr.Sdf.CleanupEnabler
An RAII class which, when an instance is alive, enables scheduling of
automatic cleanup of SdfLayers.
Any affected specs which no longer contribute to the scene will be
removed when the last SdfCleanupEnabler instance goes out of scope.
Note that for this purpose, SdfPropertySpecs are removed if they have
only required fields (see SdfPropertySpecs::HasOnlyRequiredFields),
but only if the property spec itself was affected by an edit that left
it with only required fields. This will have the effect of
uninstantiating on-demand attributes. For example, if its parent prim
was affected by an edit that left it otherwise inert, it will not be
removed if it contains an SdfPropertySpec with only required fields,
but if the property spec itself is edited leaving it with only
required fields, it will be removed, potentially uninstantiating it if
it’s an on-demand property.
SdfCleanupEnablers are accessible in both C++ and Python.
/// SdfCleanupEnabler can be used in the following manner:
{
SdfCleanupEnabler enabler;
// Perform any action that might otherwise leave inert specs around,
// such as removing info from properties or prims, or removing name
// children. i.e:
primSpec->ClearInfo(SdfFieldKeys->Default);
// When enabler goes out of scope on the next line, primSpec will
// be removed if it has been left as an empty over.
}
class pxr.Sdf.DimensionlessUnit
Methods:
GetValueFromName
Attributes:
allValues
static GetValueFromName()
allValues = (Sdf.DimensionlessUnitPercent, Sdf.DimensionlessUnitDefault)
class pxr.Sdf.FastUpdateList
Classes:
FastUpdate
Attributes:
fastUpdates
hasCompositionDependents
class FastUpdate
Attributes:
path
value
property path
property value
property fastUpdates
property hasCompositionDependents
class pxr.Sdf.FileFormat
Base class for file format implementations.
Classes:
Tokens
Methods:
CanRead(file)
Returns true if file can be read by this format.
FindAllFileFormatExtensions
classmethod FindAllFileFormatExtensions() -> set[str]
FindByExtension
classmethod FindByExtension(path, target) -> FileFormat
FindById
classmethod FindById(formatId) -> FileFormat
GetFileExtension
classmethod GetFileExtension(s) -> str
GetFileExtensions()
Returns a list of extensions that this format supports.
IsPackage()
Returns true if this file format is a package containing other assets.
IsSupportedExtension(extension)
Returns true if extension matches one of the extensions returned by GetFileExtensions.
Attributes:
expired
True if this object has expired, False otherwise.
fileCookie
str
formatId
str
primaryFileExtension
str
target
str
class Tokens
Attributes:
TargetArg
TargetArg = 'target'
CanRead(file) → bool
Returns true if file can be read by this format.
Parameters
file (str) –
static FindAllFileFormatExtensions()
classmethod FindAllFileFormatExtensions() -> set[str]
Returns a set containing the extension(s) corresponding to all
registered file formats.
static FindByExtension()
classmethod FindByExtension(path, target) -> FileFormat
Returns the file format instance that supports the extension for
path .
If a format with a matching extension is not found, this returns a
null file format pointer.
An extension may be handled by multiple file formats, but each with a
different target. In such cases, if no target is specified, the
file format that is registered as the primary plugin will be returned.
Otherwise, the file format whose target matches target will be
returned.
Parameters
path (str) –
target (str) –
FindByExtension(path, args) -> FileFormat
Returns a file format instance that supports the extension for
path and whose target matches one of those specified by the given
args .
If the args specify no target, then the file format that is
registered as the primary plugin will be returned. If a format with a
matching extension is not found, this returns a null file format
pointer.
Parameters
path (str) –
args (FileFormatArguments) –
static FindById()
classmethod FindById(formatId) -> FileFormat
Returns the file format instance with the specified formatId
identifier.
If a format with a matching identifier is not found, this returns a
null file format pointer.
Parameters
formatId (str) –
static GetFileExtension()
classmethod GetFileExtension(s) -> str
Returns the file extension for path or file name s , without the
leading dot character.
Parameters
s (str) –
GetFileExtensions() → list[str]
Returns a list of extensions that this format supports.
IsPackage() → bool
Returns true if this file format is a package containing other assets.
IsSupportedExtension(extension) → bool
Returns true if extension matches one of the extensions returned
by GetFileExtensions.
Parameters
extension (str) –
property expired
True if this object has expired, False otherwise.
property fileCookie
str
Returns the cookie to be used when writing files with this format.
Type
type
property formatId
str
Returns the format identifier.
Type
type
property primaryFileExtension
str
Returns the primary file extension for this format.
This is the extension that is reported for layers using this file
format.
Type
type
property target
str
Returns the target for this file format.
Type
type
class pxr.Sdf.Int64ListOp
Methods:
ApplyOperations
Clear
ClearAndMakeExplicit
Create
CreateExplicit
GetAddedOrExplicitItems
HasItem
Attributes:
addedItems
appendedItems
deletedItems
explicitItems
isExplicit
orderedItems
prependedItems
ApplyOperations()
Clear()
ClearAndMakeExplicit()
static Create()
static CreateExplicit()
GetAddedOrExplicitItems()
HasItem()
property addedItems
property appendedItems
property deletedItems
property explicitItems
property isExplicit
property orderedItems
property prependedItems
class pxr.Sdf.IntListOp
Methods:
ApplyOperations
Clear
ClearAndMakeExplicit
Create
CreateExplicit
GetAddedOrExplicitItems
HasItem
Attributes:
addedItems
appendedItems
deletedItems
explicitItems
isExplicit
orderedItems
prependedItems
ApplyOperations()
Clear()
ClearAndMakeExplicit()
static Create()
static CreateExplicit()
GetAddedOrExplicitItems()
HasItem()
property addedItems
property appendedItems
property deletedItems
property explicitItems
property isExplicit
property orderedItems
property prependedItems
class pxr.Sdf.Layer
A scene description container that can combine with other such
containers to form simple component assets, and successively larger
aggregates. The contents of an SdfLayer adhere to the SdfData data
model. A layer can be ephemeral, or be an asset accessed and
serialized through the ArAsset and ArResolver interfaces.
The SdfLayer class provides a consistent API for accesing and
serializing scene description, using any data store provided by Ar
plugins. Sdf itself provides a UTF-8 text format for layers identified
by the”.sdf”identifier extension, but via the SdfFileFormat
abstraction, allows downstream modules and plugins to adapt arbitrary
data formats to the SdfData/SdfLayer model.
The FindOrOpen() method returns a new SdfLayer object with scene
description from any supported asset format. Once read, a layer
remembers which asset it was read from. The Save() method saves the
layer back out to the original asset. You can use the Export() method
to write the layer to a different location. You can use the
GetIdentifier() method to get the layer’s Id or GetRealPath() to get
the resolved, full URI.
Layers can have a timeCode range (startTimeCode and endTimeCode). This
range represents the suggested playback range, but has no impact on
the extent of the animation data that may be stored in the layer. The
metadatum”timeCodesPerSecond”is used to annotate how the time ordinate
for samples contained in the file scales to seconds. For example, if
timeCodesPerSecond is 24, then a sample at time ordinate 24 should be
viewed exactly one second after the sample at time ordinate 0.
Classes:
DetachedLayerRules
Methods:
AddToMutedLayers
classmethod AddToMutedLayers(mutedPath) -> None
Apply(arg1)
Performs a batch of namespace edits.
ApplyRootPrimOrder(vec)
Reorders the given list of prim names according to the reorder rootPrims statement for this layer.
CanApply(arg1, details)
Check if a batch of namespace edits will succeed.
Clear()
Clears the layer of all content.
ClearColorConfiguration()
Clears the color configuration metadata authored in this layer.
ClearColorManagementSystem()
Clears the'colorManagementSystem'metadata authored in this layer.
ClearCustomLayerData()
Clears out the CustomLayerData dictionary associated with this layer.
ClearDefaultPrim()
Clear the default prim metadata for this layer.
ClearEndTimeCode()
Clear the endTimeCode opinion.
ClearFramePrecision()
Clear the framePrecision opinion.
ClearFramesPerSecond()
Clear the framesPerSecond opinion.
ClearOwner()
Clear the owner opinion.
ClearSessionOwner()
ClearStartTimeCode()
Clear the startTimeCode opinion.
ClearTimeCodesPerSecond()
Clear the timeCodesPerSecond opinion.
ComputeAbsolutePath(assetPath)
Returns the path to the asset specified by assetPath using this layer to anchor the path if necessary.
CreateAnonymous
classmethod CreateAnonymous(tag, args) -> Layer
CreateIdentifier
classmethod CreateIdentifier(layerPath, arguments) -> str
CreateNew
classmethod CreateNew(identifier, args) -> Layer
DumpLayerInfo
Debug helper to examine content of the current layer registry and the asset/real path of all layers in the registry.
EraseTimeSample(path, time)
param path
Export(filename, comment, args)
Exports this layer to a file.
ExportToString
Returns the string representation of the layer.
Find(filename)
filename : string
FindOrOpen
classmethod FindOrOpen(identifier, args) -> Layer
FindOrOpenRelativeToLayer
classmethod FindOrOpenRelativeToLayer(anchor, identifier, args) -> Layer
FindRelativeToLayer
Returns the open layer with the given filename, or None.
GetAssetInfo()
Returns resolve information from the last time the layer identifier was resolved.
GetAssetName()
Returns the asset name associated with this layer.
GetAttributeAtPath(path)
Returns an attribute at the given path .
GetBracketingTimeSamples(time, tLower, tUpper)
param time
GetBracketingTimeSamplesForPath(path, time, ...)
param path
GetCompositionAssetDependencies()
Return paths of all assets this layer depends on due to composition fields.
GetDetachedLayerRules
classmethod GetDetachedLayerRules() -> DetachedLayerRules
GetDisplayName()
Returns the layer's display name.
GetDisplayNameFromIdentifier
classmethod GetDisplayNameFromIdentifier(identifier) -> str
GetExternalAssetDependencies()
Returns a set of resolved paths to all external asset dependencies the layer needs to generate its contents.
GetExternalReferences
Return a list of asset paths for this layer.
GetFileFormat()
Returns the file format used by this layer.
GetFileFormatArguments()
Returns the file format-specific arguments used during the construction of this layer.
GetLoadedLayers
Return list of loaded layers.
GetMutedLayers
Return list of muted layers.
GetNumTimeSamplesForPath(path)
param path
GetObjectAtPath(path)
Returns the object at the given path .
GetPrimAtPath(path)
Returns the prim at the given path .
GetPropertyAtPath(path)
Returns a property at the given path .
GetRelationshipAtPath(path)
Returns a relationship at the given path .
HasColorConfiguration()
Returns true if color configuration metadata is set in this layer.
HasColorManagementSystem()
Returns true if colorManagementSystem metadata is set in this layer.
HasCustomLayerData()
Returns true if CustomLayerData is authored on the layer.
HasDefaultPrim()
Return true if the default prim metadata is set in this layer.
HasEndTimeCode()
Returns true if the layer has an endTimeCode opinion.
HasFramePrecision()
Returns true if the layer has a frames precision opinion.
HasFramesPerSecond()
Returns true if the layer has a frames per second opinion.
HasOwner()
Returns true if the layer has an owner opinion.
HasSessionOwner()
Returns true if the layer has a session owner opinion.
HasStartTimeCode()
Returns true if the layer has a startTimeCode opinion.
HasTimeCodesPerSecond()
Returns true if the layer has a timeCodesPerSecond opinion.
Import(layerPath)
Imports the content of the given layer path, replacing the content of the current layer.
ImportFromString(string)
Reads this layer from the given string.
IsAnonymousLayerIdentifier
classmethod IsAnonymousLayerIdentifier(identifier) -> bool
IsDetached()
Returns true if this layer is detached from its serialized data store, false otherwise.
IsIncludedByDetachedLayerRules
classmethod IsIncludedByDetachedLayerRules(identifier) -> bool
IsMuted
classmethod IsMuted() -> bool
ListAllTimeSamples()
ListTimeSamplesForPath(path)
param path
New
classmethod New(fileFormat, identifier, args) -> Layer
OpenAsAnonymous
classmethod OpenAsAnonymous(layerPath, metadataOnly, tag) -> Layer
QueryTimeSample(path, time, value)
param path
Reload(force)
Reloads the layer from its persistent representation.
ReloadLayers
classmethod ReloadLayers(layers, force) -> bool
RemoveFromMutedLayers
classmethod RemoveFromMutedLayers(mutedPath) -> None
RemoveInertSceneDescription()
Removes all scene description in this layer that does not affect the scene.
Save(force)
Returns true if successful, false if an error occurred.
ScheduleRemoveIfInert(spec)
Cause spec to be removed if it no longer affects the scene when the last change block is closed, or now if there are no change blocks.
SetDetachedLayerRules
classmethod SetDetachedLayerRules(mask) -> None
SetMuted(muted)
Mutes the current layer if muted is true , and unmutes it otherwise.
SetPermissionToEdit(allow)
Sets permission to edit.
SetPermissionToSave(allow)
Sets permission to save.
SetTimeSample(path, time, value)
param path
SplitIdentifier
classmethod SplitIdentifier(identifier, layerPath, arguments) -> bool
StreamsData()
Returns true if this layer streams data from its serialized data store on demand, false otherwise.
TransferContent(layer)
Copies the content of the given layer into this layer.
Traverse(path, func)
param path
UpdateAssetInfo()
Update layer asset information.
UpdateCompositionAssetDependency(...)
Updates the asset path of a composation dependency in this layer.
UpdateExternalReference(oldAssetPath, ...)
Deprecated
Attributes:
ColorConfigurationKey
ColorManagementSystemKey
CommentKey
DocumentationKey
EndFrameKey
EndTimeCodeKey
FramePrecisionKey
FramesPerSecondKey
HasOwnedSubLayers
OwnerKey
SessionOwnerKey
StartFrameKey
StartTimeCodeKey
TimeCodesPerSecondKey
anonymous
bool
colorConfiguration
The color configuration asset-path of this layer.
colorManagementSystem
The name of the color management system used to interpret the colorConfiguration asset.
comment
The layer's comment string.
customLayerData
The customLayerData dictionary associated with this layer.
defaultPrim
The layer's default reference target token.
dirty
bool
documentation
The layer's documentation string.
empty
bool
endTimeCode
The end timeCode of this layer.
expired
True if this object has expired, False otherwise.
externalReferences
Return unique list of asset paths of external references for given layer.
fileExtension
The layer's file extension.
framePrecision
The number of digits of precision used in times in this layer.
framesPerSecond
The frames per second used in this layer.
hasOwnedSubLayers
Whether this layer's sub layers are expected to have owners.
identifier
The layer's identifier.
owner
The owner of this layer.
permissionToEdit
Return true if permitted to be edited (modified), false otherwise.
permissionToSave
Return true if permitted to be saved, false otherwise.
pseudoRoot
The pseudo-root of the layer.
realPath
The layer's resolved path.
repositoryPath
The layer's associated repository path
resolvedPath
The layer's resolved path.
rootPrimOrder
Get/set the list of root prim names for this layer's 'reorder rootPrims' statement.
rootPrims
The root prims of this layer, as an ordered dictionary.
sessionOwner
The session owner of this layer.
startTimeCode
The start timeCode of this layer.
subLayerOffsets
The sublayer offsets of this layer, as a list.
subLayerPaths
The sublayer paths of this layer, as a list.
timeCodesPerSecond
The timeCodes per second used in this layer.
version
The layer's version.
class DetachedLayerRules
Methods:
Exclude
GetExcluded
GetIncluded
Include
IncludeAll
IncludedAll
IsIncluded
Exclude()
GetExcluded()
GetIncluded()
Include()
IncludeAll()
IncludedAll()
IsIncluded()
static AddToMutedLayers()
classmethod AddToMutedLayers(mutedPath) -> None
Add the specified path to the muted layers set.
Parameters
mutedPath (str) –
Apply(arg1) → bool
Performs a batch of namespace edits.
Returns true on success and false on failure. On failure, no
namespace edits will have occurred.
Parameters
arg1 (BatchNamespaceEdit) –
ApplyRootPrimOrder(vec) → None
Reorders the given list of prim names according to the reorder
rootPrims statement for this layer.
This routine employs the standard list editing operations for ordered
items in a ListEditor.
Parameters
vec (list[str]) –
CanApply(arg1, details) → NamespaceEditDetail.Result
Check if a batch of namespace edits will succeed.
This returns SdfNamespaceEditDetail::Okay if they will succeed as
a batch, SdfNamespaceEditDetail::Unbatched if the edits will
succeed but will be applied unbatched, and
SdfNamespaceEditDetail::Error if they will not succeed. No edits
will be performed in any case.
If details is not None and the method does not return Okay
then details about the problems will be appended to details . A
problem may cause the method to return early, so details may not
list every problem.
Note that Sdf does not track backpointers so it’s unable to fix up
targets/connections to namespace edited objects. Clients must fix
those to prevent them from falling off. In addition, this method will
report failure if any relational attribute with a target to a
namespace edited object is subsequently edited (in the same batch).
Clients should perform edits on relational attributes first.
Clients may wish to report unbatch details to the user to confirm that
the edits should be applied unbatched. This will give the user a
chance to correct any problems that cause batching to fail and try
again.
Parameters
arg1 (BatchNamespaceEdit) –
details (list[SdfNamespaceEditDetail]) –
Clear() → None
Clears the layer of all content.
This restores the layer to a state as if it had just been created with
CreateNew() . This operation is Undo-able.
The fileName and whether journaling is enabled are not affected by
this method.
ClearColorConfiguration() → None
Clears the color configuration metadata authored in this layer.
HasColorConfiguration() , SetColorConfiguration()
ClearColorManagementSystem() → None
Clears the’colorManagementSystem’metadata authored in this layer.
HascolorManagementSystem(), SetColorManagementSystem()
ClearCustomLayerData() → None
Clears out the CustomLayerData dictionary associated with this layer.
ClearDefaultPrim() → None
Clear the default prim metadata for this layer.
See GetDefaultPrim() and SetDefaultPrim() .
ClearEndTimeCode() → None
Clear the endTimeCode opinion.
ClearFramePrecision() → None
Clear the framePrecision opinion.
ClearFramesPerSecond() → None
Clear the framesPerSecond opinion.
ClearOwner() → None
Clear the owner opinion.
ClearSessionOwner() → None
ClearStartTimeCode() → None
Clear the startTimeCode opinion.
ClearTimeCodesPerSecond() → None
Clear the timeCodesPerSecond opinion.
ComputeAbsolutePath(assetPath) → str
Returns the path to the asset specified by assetPath using this
layer to anchor the path if necessary.
Returns assetPath if it’s empty or an anonymous layer identifier.
This method can be used on asset paths that are authored in this layer
to create new asset paths that can be copied to other layers. These
new asset paths should refer to the same assets as the original asset
paths. For example, if the underlying ArResolver is filesystem-based
and assetPath is a relative filesystem path, this method might
return the absolute filesystem path using this layer’s location as the
anchor.
The returned path should in general not be assumed to be an absolute
filesystem path or any other specific form. It is”absolute”in that it
should resolve to the same asset regardless of what layer it’s
authored in.
Parameters
assetPath (str) –
static CreateAnonymous()
classmethod CreateAnonymous(tag, args) -> Layer
Creates a new anonymous layer with an optional tag .
An anonymous layer is a layer with a system assigned identifier, that
cannot be saved to disk via Save() . Anonymous layers have an
identifier, but no real path or other asset information fields.
Anonymous layers may be tagged, which can be done to aid debugging
subsystems that make use of anonymous layers. The tag becomes the
display name of an anonymous layer, and is also included in the
generated identifier. Untagged anonymous layers have an empty display
name.
Additional arguments may be supplied via the args parameter. These
arguments may control behavior specific to the layer’s file format.
Parameters
tag (str) –
args (FileFormatArguments) –
CreateAnonymous(tag, format, args) -> Layer
Create an anonymous layer with a specific format .
Parameters
tag (str) –
format (FileFormat) –
args (FileFormatArguments) –
static CreateIdentifier()
classmethod CreateIdentifier(layerPath, arguments) -> str
Joins the given layer path and arguments into an identifier.
Parameters
layerPath (str) –
arguments (FileFormatArguments) –
static CreateNew()
classmethod CreateNew(identifier, args) -> Layer
Creates a new empty layer with the given identifier.
Additional arguments may be supplied via the args parameter. These
arguments may control behavior specific to the layer’s file format.
Parameters
identifier (str) –
args (FileFormatArguments) –
CreateNew(fileFormat, identifier, args) -> Layer
Creates a new empty layer with the given identifier for a given file
format class.
This function has the same behavior as the other CreateNew function,
but uses the explicitly-specified fileFormat instead of attempting
to discern the format from identifier .
Parameters
fileFormat (FileFormat) –
identifier (str) –
args (FileFormatArguments) –
static DumpLayerInfo()
Debug helper to examine content of the current layer registry and
the asset/real path of all layers in the registry.
EraseTimeSample(path, time) → None
Parameters
path (Path) –
time (float) –
Export(filename, comment, args) → bool
Exports this layer to a file.
Returns true if successful, false if an error occurred.
If comment is not empty, the layer gets exported with the given
comment. Additional arguments may be supplied via the args
parameter. These arguments may control behavior specific to the
exported layer’s file format.
Note that the file name or comment of the original layer is not
updated. This only saves a copy of the layer to the given filename.
Subsequent calls to Save() will still save the layer to it’s
previously remembered file name.
Parameters
filename (str) –
comment (str) –
args (FileFormatArguments) –
ExportToString()
Returns the string representation of the layer.
static Find(filename) → LayerPtr
filename : string
Returns the open layer with the given filename, or None. Note that this is a static class method.
static FindOrOpen()
classmethod FindOrOpen(identifier, args) -> Layer
Return an existing layer with the given identifier and args ,
or else load it.
If the layer can’t be found or loaded, an error is posted and a null
layer is returned.
Arguments in args will override any arguments specified in
identifier .
Parameters
identifier (str) –
args (FileFormatArguments) –
static FindOrOpenRelativeToLayer()
classmethod FindOrOpenRelativeToLayer(anchor, identifier, args) -> Layer
Return an existing layer with the given identifier and args ,
or else load it.
The given identifier will be resolved relative to the anchor
layer. If the layer can’t be found or loaded, an error is posted and a
null layer is returned.
If the anchor layer is invalid, issues a coding error and returns
a null handle.
Arguments in args will override any arguments specified in
identifier .
Parameters
anchor (Layer) –
identifier (str) –
args (FileFormatArguments) –
static FindRelativeToLayer()
Returns the open layer with the given filename, or None. If the filename is a relative path then it’s found relative to the given layer. Note that this is a static class method.
GetAssetInfo() → VtValue
Returns resolve information from the last time the layer identifier
was resolved.
GetAssetName() → str
Returns the asset name associated with this layer.
GetAttributeAtPath(path) → AttributeSpec
Returns an attribute at the given path .
Returns None if there is no attribute at path . This is simply
a more specifically typed version of GetObjectAtPath() .
Parameters
path (Path) –
GetBracketingTimeSamples(time, tLower, tUpper) → bool
Parameters
time (float) –
tLower (float) –
tUpper (float) –
GetBracketingTimeSamplesForPath(path, time, tLower, tUpper) → bool
Parameters
path (Path) –
time (float) –
tLower (float) –
tUpper (float) –
GetCompositionAssetDependencies() → set[str]
Return paths of all assets this layer depends on due to composition
fields.
This includes the paths of all layers referred to by reference,
payload, and sublayer fields in this layer. This function only returns
direct composition dependencies of this layer, i.e. it does not
recurse to find composition dependencies from its dependent layer
assets.
static GetDetachedLayerRules()
classmethod GetDetachedLayerRules() -> DetachedLayerRules
Returns the current rules for the detached layer set.
GetDisplayName() → str
Returns the layer’s display name.
The display name is the base filename of the identifier.
static GetDisplayNameFromIdentifier()
classmethod GetDisplayNameFromIdentifier(identifier) -> str
Returns the display name for the given identifier , using the same
rules as GetDisplayName.
Parameters
identifier (str) –
GetExternalAssetDependencies() → set[str]
Returns a set of resolved paths to all external asset dependencies the
layer needs to generate its contents.
These are additional asset dependencies that are determined by the
layer’s file format and will be consulted during Reload() when
determining if the layer needs to be reloaded. This specifically does
not include dependencies related to composition, i.e. this will not
include assets from references, payloads, and sublayers.
GetExternalReferences()
Return a list of asset paths for
this layer.
GetFileFormat() → FileFormat
Returns the file format used by this layer.
GetFileFormatArguments() → FileFormatArguments
Returns the file format-specific arguments used during the
construction of this layer.
static GetLoadedLayers()
Return list of loaded layers.
static GetMutedLayers()
Return list of muted layers.
GetNumTimeSamplesForPath(path) → int
Parameters
path (Path) –
GetObjectAtPath(path) → Spec
Returns the object at the given path .
There is no distinction between an absolute and relative path at the
SdLayer level.
Returns None if there is no object at path .
Parameters
path (Path) –
GetPrimAtPath(path) → PrimSpec
Returns the prim at the given path .
Returns None if there is no prim at path . This is simply a
more specifically typed version of GetObjectAtPath() .
Parameters
path (Path) –
GetPropertyAtPath(path) → PropertySpec
Returns a property at the given path .
Returns None if there is no property at path . This is simply
a more specifically typed version of GetObjectAtPath() .
Parameters
path (Path) –
GetRelationshipAtPath(path) → RelationshipSpec
Returns a relationship at the given path .
Returns None if there is no relationship at path . This is
simply a more specifically typed version of GetObjectAtPath() .
Parameters
path (Path) –
HasColorConfiguration() → bool
Returns true if color configuration metadata is set in this layer.
GetColorConfiguration() , SetColorConfiguration()
HasColorManagementSystem() → bool
Returns true if colorManagementSystem metadata is set in this layer.
GetColorManagementSystem() , SetColorManagementSystem()
HasCustomLayerData() → bool
Returns true if CustomLayerData is authored on the layer.
HasDefaultPrim() → bool
Return true if the default prim metadata is set in this layer.
See GetDefaultPrim() and SetDefaultPrim() .
HasEndTimeCode() → bool
Returns true if the layer has an endTimeCode opinion.
HasFramePrecision() → bool
Returns true if the layer has a frames precision opinion.
HasFramesPerSecond() → bool
Returns true if the layer has a frames per second opinion.
HasOwner() → bool
Returns true if the layer has an owner opinion.
HasSessionOwner() → bool
Returns true if the layer has a session owner opinion.
HasStartTimeCode() → bool
Returns true if the layer has a startTimeCode opinion.
HasTimeCodesPerSecond() → bool
Returns true if the layer has a timeCodesPerSecond opinion.
Import(layerPath) → bool
Imports the content of the given layer path, replacing the content of
the current layer.
Note: If the layer path is the same as the current layer’s real path,
no action is taken (and a warning occurs). For this case use Reload()
.
Parameters
layerPath (str) –
ImportFromString(string) → bool
Reads this layer from the given string.
Returns true if successful, otherwise returns false .
Parameters
string (str) –
static IsAnonymousLayerIdentifier()
classmethod IsAnonymousLayerIdentifier(identifier) -> bool
Returns true if the identifier is an anonymous layer unique
identifier.
Parameters
identifier (str) –
IsDetached() → bool
Returns true if this layer is detached from its serialized data store,
false otherwise.
Detached layers are isolated from external changes to their serialized
data.
static IsIncludedByDetachedLayerRules()
classmethod IsIncludedByDetachedLayerRules(identifier) -> bool
Returns whether the given layer identifier is included in the current
rules for the detached layer set.
This is equivalent to GetDetachedLayerRules() .IsIncluded(identifier).
Parameters
identifier (str) –
IsMuted()
classmethod IsMuted() -> bool
Returns true if the current layer is muted.
IsMuted(path) -> bool
Returns true if the specified layer path is muted.
Parameters
path (str) –
ListAllTimeSamples() → set[float]
ListTimeSamplesForPath(path) → set[float]
Parameters
path (Path) –
static New()
classmethod New(fileFormat, identifier, args) -> Layer
Creates a new empty layer with the given identifier for a given file
format class.
The new layer will not be dirty and will not be saved.
Additional arguments may be supplied via the args parameter. These
arguments may control behavior specific to the layer’s file format.
Parameters
fileFormat (FileFormat) –
identifier (str) –
args (FileFormatArguments) –
static OpenAsAnonymous()
classmethod OpenAsAnonymous(layerPath, metadataOnly, tag) -> Layer
Load the given layer from disk as a new anonymous layer.
If the layer can’t be found or loaded, an error is posted and a null
layer is returned.
The anonymous layer does not retain any knowledge of the backing file
on the filesystem.
metadataOnly is a flag that asks for only the layer metadata to be
read in, which can be much faster if that is all that is required.
Note that this is just a hint: some FileFormat readers may disregard
this flag and still fully populate the layer contents.
An optional tag may be specified. See CreateAnonymous for details.
Parameters
layerPath (str) –
metadataOnly (bool) –
tag (str) –
QueryTimeSample(path, time, value) → bool
Parameters
path (Path) –
time (float) –
value (VtValue) –
QueryTimeSample(path, time, value) -> bool
Parameters
path (Path) –
time (float) –
value (SdfAbstractDataValue) –
QueryTimeSample(path, time, data) -> bool
Parameters
path (Path) –
time (float) –
data (T) –
Reload(force) → bool
Reloads the layer from its persistent representation.
This restores the layer to a state as if it had just been created with
FindOrOpen() . This operation is Undo-able.
The fileName and whether journaling is enabled are not affected by
this method.
When called with force = false (the default), Reload attempts to avoid
reloading layers that have not changed on disk. It does so by
comparing the file’s modification time (mtime) to when the file was
loaded. If the layer has unsaved modifications, this mechanism is not
used, and the layer is reloaded from disk. If the layer has any
external asset dependencies their modification state will also be
consulted when determining if the layer needs to be reloaded.
Passing true to the force parameter overrides this behavior,
forcing the layer to be reloaded from disk regardless of whether it
has changed.
Parameters
force (bool) –
static ReloadLayers()
classmethod ReloadLayers(layers, force) -> bool
Reloads the specified layers.
Returns false if one or more layers failed to reload.
See Reload() for a description of the force flag.
Parameters
layers (set[Layer]) –
force (bool) –
static RemoveFromMutedLayers()
classmethod RemoveFromMutedLayers(mutedPath) -> None
Remove the specified path from the muted layers set.
Parameters
mutedPath (str) –
RemoveInertSceneDescription() → None
Removes all scene description in this layer that does not affect the
scene.
This method walks the layer namespace hierarchy and removes any prims
and that are not contributing any opinions.
Save(force) → bool
Returns true if successful, false if an error occurred.
Returns false if the layer has no remembered file name or the
layer type cannot be saved. The layer will not be overwritten if the
file exists and the layer is not dirty unless force is true.
Parameters
force (bool) –
ScheduleRemoveIfInert(spec) → None
Cause spec to be removed if it no longer affects the scene when
the last change block is closed, or now if there are no change blocks.
Parameters
spec (Spec) –
static SetDetachedLayerRules()
classmethod SetDetachedLayerRules(mask) -> None
Sets the rules specifying detached layers.
Newly-created or opened layers whose identifiers are included in
rules will be opened as detached layers. Existing layers that are
now included or no longer included will be reloaded. Any unsaved
modifications to those layers will be lost.
This function is not thread-safe. It may not be run concurrently with
any other functions that open, close, or read from any layers.
The detached layer rules are initially set to exclude all layers. This
may be overridden by setting the environment variables
SDF_LAYER_INCLUDE_DETACHED and SDF_LAYER_EXCLUDE_DETACHED to specify
the initial set of include and exclude patterns in the rules. These
variables can be set to a comma-delimited list of patterns.
SDF_LAYER_INCLUDE_DETACHED may also be set to”*”to include all
layers. Note that these environment variables only set the initial
state of the detached layer rules; these values may be overwritten by
subsequent calls to this function.
See SdfLayer::DetachedLayerRules::IsIncluded for details on how the
rules are applied to layer identifiers.
Parameters
mask (DetachedLayerRules) –
SetMuted(muted) → None
Mutes the current layer if muted is true , and unmutes it
otherwise.
Parameters
muted (bool) –
SetPermissionToEdit(allow) → None
Sets permission to edit.
Parameters
allow (bool) –
SetPermissionToSave(allow) → None
Sets permission to save.
Parameters
allow (bool) –
SetTimeSample(path, time, value) → None
Parameters
path (Path) –
time (float) –
value (VtValue) –
SetTimeSample(path, time, value) -> None
Parameters
path (Path) –
time (float) –
value (SdfAbstractDataConstValue) –
SetTimeSample(path, time, value) -> None
Parameters
path (Path) –
time (float) –
value (T) –
static SplitIdentifier()
classmethod SplitIdentifier(identifier, layerPath, arguments) -> bool
Splits the given layer identifier into its constituent layer path and
arguments.
Parameters
identifier (str) –
layerPath (str) –
arguments (FileFormatArguments) –
StreamsData() → bool
Returns true if this layer streams data from its serialized data store
on demand, false otherwise.
Layers with streaming data are treated differently to avoid pulling in
data unnecessarily. For example, reloading a streaming layer will not
perform fine-grained change notification, since doing so would require
the full contents of the layer to be loaded.
TransferContent(layer) → None
Copies the content of the given layer into this layer.
Source layer is unmodified.
Parameters
layer (Layer) –
Traverse(path, func) → None
Parameters
path (Path) –
func (TraversalFunction) –
UpdateAssetInfo() → None
Update layer asset information.
Calling this method re-resolves the layer identifier, which updates
asset information such as the layer’s resolved path and other asset
info. This may be used to update the layer after external changes to
the underlying asset system.
UpdateCompositionAssetDependency(oldAssetPath, newAssetPath) → bool
Updates the asset path of a composation dependency in this layer.
If newAssetPath is supplied, the update works as”rename”, updating
any occurrence of oldAssetPath to newAssetPath in all
reference, payload, and sublayer fields.
If newAssetPath is not given, this update behaves as a”delete”,
removing all occurrences of oldAssetPath from all reference,
payload, and sublayer fields.
Parameters
oldAssetPath (str) –
newAssetPath (str) –
UpdateExternalReference(oldAssetPath, newAssetPath) → bool
Deprecated
Use UpdateCompositionAssetDependency instead.
Parameters
oldAssetPath (str) –
newAssetPath (str) –
ColorConfigurationKey = 'colorConfiguration'
ColorManagementSystemKey = 'colorManagementSystem'
CommentKey = 'comment'
DocumentationKey = 'documentation'
EndFrameKey = 'endFrame'
EndTimeCodeKey = 'endTimeCode'
FramePrecisionKey = 'framePrecision'
FramesPerSecondKey = 'framesPerSecond'
HasOwnedSubLayers = 'hasOwnedSubLayers'
OwnerKey = 'owner'
SessionOwnerKey = 'sessionOwner'
StartFrameKey = 'startFrame'
StartTimeCodeKey = 'startTimeCode'
TimeCodesPerSecondKey = 'timeCodesPerSecond'
property anonymous
bool
Returns true if this layer is an anonymous layer.
Type
type
property colorConfiguration
The color configuration asset-path of this layer.
property colorManagementSystem
The name of the color management system used to interpret the colorConfiguration asset.
property comment
The layer’s comment string.
property customLayerData
The customLayerData dictionary associated with this layer.
property defaultPrim
The layer’s default reference target token.
property dirty
bool
Returns true if the layer is dirty, i.e.
has changed from its persistent representation.
Type
type
property documentation
The layer’s documentation string.
property empty
bool
Returns whether this layer has no significant data.
Type
type
property endTimeCode
The end timeCode of this layer.
The end timeCode of a layer is not a hard limit, but is
more of a hint. A layer’s time-varying content is not limited to
the timeCode range of the layer.
property expired
True if this object has expired, False otherwise.
property externalReferences
Return unique list of asset paths of external references for
given layer.
property fileExtension
The layer’s file extension.
property framePrecision
The number of digits of precision used in times in this layer.
property framesPerSecond
The frames per second used in this layer.
property hasOwnedSubLayers
Whether this layer’s sub layers are expected to have owners.
property identifier
The layer’s identifier.
property owner
The owner of this layer.
property permissionToEdit
Return true if permitted to be edited (modified), false otherwise.
property permissionToSave
Return true if permitted to be saved, false otherwise.
property pseudoRoot
The pseudo-root of the layer.
property realPath
The layer’s resolved path.
property repositoryPath
The layer’s associated repository path
property resolvedPath
The layer’s resolved path.
property rootPrimOrder
Get/set the list of root prim names for this layer’s ‘reorder rootPrims’ statement.
property rootPrims
The root prims of this layer, as an ordered dictionary.
The prims may be accessed by index or by name.
Although this property claims it is read only, you can modify the contents of this dictionary to add, remove, or reorder the contents.
property sessionOwner
The session owner of this layer. Only intended for use with session layers.
property startTimeCode
The start timeCode of this layer.
The start timeCode of a layer is not a hard limit, but is
more of a hint. A layer’s time-varying content is not limited to
the timeCode range of the layer.
property subLayerOffsets
The sublayer offsets of this layer, as a list. Although this property is claimed to be read only, you can modify the contents of this list by assigning new layer offsets to specific indices.
property subLayerPaths
The sublayer paths of this layer, as a list. Although this property is claimed to be read only, you can modify the contents of this list.
property timeCodesPerSecond
The timeCodes per second used in this layer.
property version
The layer’s version.
class pxr.Sdf.LayerOffset
Represents a time offset and scale between layers.
The SdfLayerOffset class is an affine transform, providing both a
scale and a translate. It supports vector algebra semantics for
composing SdfLayerOffsets together via multiplication. The
SdfLayerOffset class is unitless: it does not refer to seconds or
frames.
For example, suppose layer A uses layer B, with an offset of X: when
bringing animation from B into A, you first apply the scale of X, and
then the offset. Suppose you have a scale of 2 and an offset of 24:
first multiply B’s frame numbers by 2, and then add 24. The animation
from B as seen in A will take twice as long and start 24 frames later.
Offsets are typically used in either sublayers or prim references. For
more information, see the SetSubLayerOffset() method of the SdfLayer
class (the subLayerOffsets property in Python), as well as the
SetReference() and GetReferenceLayerOffset() methods (the latter is
the referenceLayerOffset property in Python) of the SdfPrimSpec class.
Methods:
GetInverse()
Gets the inverse offset, which performs the opposite transformation.
IsIdentity()
Returns true if this is an identity transformation, with an offset of 0.0 and a scale of 1.0.
Attributes:
offset
None
scale
None
GetInverse() → LayerOffset
Gets the inverse offset, which performs the opposite transformation.
IsIdentity() → bool
Returns true if this is an identity transformation, with an offset
of 0.0 and a scale of 1.0.
property offset
None
Sets the time offset.
type : float
Returns the time offset.
Type
type
property scale
None
Sets the time scale factor.
type : float
Returns the time scale factor.
Type
type
class pxr.Sdf.LayerTree
A SdfLayerTree is an immutable tree structure representing a sublayer
stack and its recursive structure.
Layers can have sublayers, which can in turn have sublayers of their
own. Clients that want to represent that hierarchical structure in
memory can build a SdfLayerTree for that purpose.
We use TfRefPtr<SdfLayerTree> as handles to LayerTrees, as a simple
way to pass them around as immutable trees without worrying about
lifetime.
Attributes:
childTrees
list[SdfLayerTreeHandle]
expired
True if this object has expired, False otherwise.
layer
Layer
offset
LayerOffset
property childTrees
list[SdfLayerTreeHandle]
Returns the children of this tree node.
Type
type
property expired
True if this object has expired, False otherwise.
property layer
Layer
Returns the layer handle this tree node represents.
Type
type
property offset
LayerOffset
Returns the cumulative layer offset from the root of the tree.
Type
type
class pxr.Sdf.LengthUnit
Methods:
GetValueFromName
Attributes:
allValues
static GetValueFromName()
allValues = (Sdf.LengthUnitMillimeter, Sdf.LengthUnitCentimeter, Sdf.LengthUnitDecimeter, Sdf.LengthUnitMeter, Sdf.LengthUnitKilometer, Sdf.LengthUnitInch, Sdf.LengthUnitFoot, Sdf.LengthUnitYard, Sdf.LengthUnitMile)
class pxr.Sdf.ListEditorProxy_SdfNameKeyPolicy
Methods:
Add
Append
ApplyEditsToList
ClearEdits
ClearEditsAndMakeExplicit
ContainsItemEdit
CopyItems
Erase
GetAddedOrExplicitItems
ModifyItemEdits
Prepend
Remove
RemoveItemEdits
ReplaceItemEdits
Attributes:
addedItems
appendedItems
deletedItems
explicitItems
isExpired
isExplicit
isOrderedOnly
orderedItems
prependedItems
Add()
Append()
ApplyEditsToList()
ClearEdits()
ClearEditsAndMakeExplicit()
ContainsItemEdit()
CopyItems()
Erase()
GetAddedOrExplicitItems()
ModifyItemEdits()
Prepend()
Remove()
RemoveItemEdits()
ReplaceItemEdits()
property addedItems
property appendedItems
property deletedItems
property explicitItems
property isExpired
property isExplicit
property isOrderedOnly
property orderedItems
property prependedItems
class pxr.Sdf.ListEditorProxy_SdfPathKeyPolicy
Methods:
Add
Append
ApplyEditsToList
ClearEdits
ClearEditsAndMakeExplicit
ContainsItemEdit
CopyItems
Erase
GetAddedOrExplicitItems
ModifyItemEdits
Prepend
Remove
RemoveItemEdits
ReplaceItemEdits
Attributes:
addedItems
appendedItems
deletedItems
explicitItems
isExpired
isExplicit
isOrderedOnly
orderedItems
prependedItems
Add()
Append()
ApplyEditsToList()
ClearEdits()
ClearEditsAndMakeExplicit()
ContainsItemEdit()
CopyItems()
Erase()
GetAddedOrExplicitItems()
ModifyItemEdits()
Prepend()
Remove()
RemoveItemEdits()
ReplaceItemEdits()
property addedItems
property appendedItems
property deletedItems
property explicitItems
property isExpired
property isExplicit
property isOrderedOnly
property orderedItems
property prependedItems
class pxr.Sdf.ListEditorProxy_SdfPayloadTypePolicy
Methods:
Add
Append
ApplyEditsToList
ClearEdits
ClearEditsAndMakeExplicit
ContainsItemEdit
CopyItems
Erase
GetAddedOrExplicitItems
ModifyItemEdits
Prepend
Remove
RemoveItemEdits
ReplaceItemEdits
Attributes:
addedItems
appendedItems
deletedItems
explicitItems
isExpired
isExplicit
isOrderedOnly
orderedItems
prependedItems
Add()
Append()
ApplyEditsToList()
ClearEdits()
ClearEditsAndMakeExplicit()
ContainsItemEdit()
CopyItems()
Erase()
GetAddedOrExplicitItems()
ModifyItemEdits()
Prepend()
Remove()
RemoveItemEdits()
ReplaceItemEdits()
property addedItems
property appendedItems
property deletedItems
property explicitItems
property isExpired
property isExplicit
property isOrderedOnly
property orderedItems
property prependedItems
class pxr.Sdf.ListEditorProxy_SdfReferenceTypePolicy
Methods:
Add
Append
ApplyEditsToList
ClearEdits
ClearEditsAndMakeExplicit
ContainsItemEdit
CopyItems
Erase
GetAddedOrExplicitItems
ModifyItemEdits
Prepend
Remove
RemoveItemEdits
ReplaceItemEdits
Attributes:
addedItems
appendedItems
deletedItems
explicitItems
isExpired
isExplicit
isOrderedOnly
orderedItems
prependedItems
Add()
Append()
ApplyEditsToList()
ClearEdits()
ClearEditsAndMakeExplicit()
ContainsItemEdit()
CopyItems()
Erase()
GetAddedOrExplicitItems()
ModifyItemEdits()
Prepend()
Remove()
RemoveItemEdits()
ReplaceItemEdits()
property addedItems
property appendedItems
property deletedItems
property explicitItems
property isExpired
property isExplicit
property isOrderedOnly
property orderedItems
property prependedItems
class pxr.Sdf.ListOpType
Methods:
GetValueFromName
Attributes:
allValues
static GetValueFromName()
allValues = (Sdf.ListOpTypeExplicit, Sdf.ListOpTypeAdded, Sdf.ListOpTypePrepended, Sdf.ListOpTypeAppended, Sdf.ListOpTypeDeleted, Sdf.ListOpTypeOrdered)
class pxr.Sdf.ListProxy_SdfNameKeyPolicy
Methods:
ApplyEditsToList
ApplyList
append
clear
copy
count
index
insert
remove
replace
Attributes:
expired
ApplyEditsToList()
ApplyList()
append()
clear()
copy()
count()
index()
insert()
remove()
replace()
property expired
class pxr.Sdf.ListProxy_SdfNameTokenKeyPolicy
Methods:
ApplyEditsToList
ApplyList
append
clear
copy
count
index
insert
remove
replace
Attributes:
expired
ApplyEditsToList()
ApplyList()
append()
clear()
copy()
count()
index()
insert()
remove()
replace()
property expired
class pxr.Sdf.ListProxy_SdfPathKeyPolicy
Methods:
ApplyEditsToList
ApplyList
append
clear
copy
count
index
insert
remove
replace
Attributes:
expired
ApplyEditsToList()
ApplyList()
append()
clear()
copy()
count()
index()
insert()
remove()
replace()
property expired
class pxr.Sdf.ListProxy_SdfPayloadTypePolicy
Methods:
ApplyEditsToList
ApplyList
append
clear
copy
count
index
insert
remove
replace
Attributes:
expired
ApplyEditsToList()
ApplyList()
append()
clear()
copy()
count()
index()
insert()
remove()
replace()
property expired
class pxr.Sdf.ListProxy_SdfReferenceTypePolicy
Methods:
ApplyEditsToList
ApplyList
append
clear
copy
count
index
insert
remove
replace
Attributes:
expired
ApplyEditsToList()
ApplyList()
append()
clear()
copy()
count()
index()
insert()
remove()
replace()
property expired
class pxr.Sdf.ListProxy_SdfSubLayerTypePolicy
Methods:
ApplyEditsToList
ApplyList
append
clear
copy
count
index
insert
remove
replace
Attributes:
expired
ApplyEditsToList()
ApplyList()
append()
clear()
copy()
count()
index()
insert()
remove()
replace()
property expired
class pxr.Sdf.MapEditProxy_VtDictionary
Classes:
MapEditProxy_VtDictionary_Iterator
MapEditProxy_VtDictionary_KeyIterator
MapEditProxy_VtDictionary_ValueIterator
Methods:
clear
copy
get
items
keys
pop
popitem
setdefault
update
values
Attributes:
expired
class MapEditProxy_VtDictionary_Iterator
class MapEditProxy_VtDictionary_KeyIterator
class MapEditProxy_VtDictionary_ValueIterator
clear()
copy()
get()
items()
keys()
pop()
popitem()
setdefault()
update()
values()
property expired
class pxr.Sdf.MapEditProxy_map_SdfPath_SdfPath_less_SdfPath__allocator_pair_SdfPath_const__SdfPath_____
Classes:
MapEditProxy_map_SdfPath_SdfPath_less_SdfPath__allocator_pair_SdfPath_const__SdfPath______Iterator
MapEditProxy_map_SdfPath_SdfPath_less_SdfPath__allocator_pair_SdfPath_const__SdfPath______KeyIterator
MapEditProxy_map_SdfPath_SdfPath_less_SdfPath__allocator_pair_SdfPath_const__SdfPath______ValueIterator
Methods:
clear
copy
get
items
keys
pop
popitem
setdefault
update
values
Attributes:
expired
class MapEditProxy_map_SdfPath_SdfPath_less_SdfPath__allocator_pair_SdfPath_const__SdfPath______Iterator
class MapEditProxy_map_SdfPath_SdfPath_less_SdfPath__allocator_pair_SdfPath_const__SdfPath______KeyIterator
class MapEditProxy_map_SdfPath_SdfPath_less_SdfPath__allocator_pair_SdfPath_const__SdfPath______ValueIterator
clear()
copy()
get()
items()
keys()
pop()
popitem()
setdefault()
update()
values()
property expired
class pxr.Sdf.MapEditProxy_map_string_string_less_string__allocator_pair_stringconst__string_____
Classes:
MapEditProxy_map_string_string_less_string__allocator_pair_stringconst__string______Iterator
MapEditProxy_map_string_string_less_string__allocator_pair_stringconst__string______KeyIterator
MapEditProxy_map_string_string_less_string__allocator_pair_stringconst__string______ValueIterator
Methods:
clear
copy
get
items
keys
pop
popitem
setdefault
update
values
Attributes:
expired
class MapEditProxy_map_string_string_less_string__allocator_pair_stringconst__string______Iterator
class MapEditProxy_map_string_string_less_string__allocator_pair_stringconst__string______KeyIterator
class MapEditProxy_map_string_string_less_string__allocator_pair_stringconst__string______ValueIterator
clear()
copy()
get()
items()
keys()
pop()
popitem()
setdefault()
update()
values()
property expired
class pxr.Sdf.NamespaceEdit
A single namespace edit. It supports renaming, reparenting,
reparenting with a rename, reordering, and removal.
Methods:
Remove
classmethod Remove(currentPath) -> This
Rename
classmethod Rename(currentPath, name) -> This
Reorder
classmethod Reorder(currentPath, index) -> This
Reparent
classmethod Reparent(currentPath, newParentPath, index) -> This
ReparentAndRename
classmethod ReparentAndRename(currentPath, newParentPath, name, index) -> This
Attributes:
atEnd
currentPath
index
newPath
same
static Remove()
classmethod Remove(currentPath) -> This
Returns a namespace edit that removes the object at currentPath .
Parameters
currentPath (Path) –
static Rename()
classmethod Rename(currentPath, name) -> This
Returns a namespace edit that renames the prim or property at
currentPath to name .
Parameters
currentPath (Path) –
name (str) –
static Reorder()
classmethod Reorder(currentPath, index) -> This
Returns a namespace edit to reorder the prim or property at
currentPath to index index .
Parameters
currentPath (Path) –
index (Index) –
static Reparent()
classmethod Reparent(currentPath, newParentPath, index) -> This
Returns a namespace edit to reparent the prim or property at
currentPath to be under newParentPath at index index .
Parameters
currentPath (Path) –
newParentPath (Path) –
index (Index) –
static ReparentAndRename()
classmethod ReparentAndRename(currentPath, newParentPath, name, index) -> This
Returns a namespace edit to reparent the prim or property at
currentPath to be under newParentPath at index index with
the name name .
Parameters
currentPath (Path) –
newParentPath (Path) –
name (str) –
index (Index) –
atEnd = -1
property currentPath
property index
property newPath
same = -2
class pxr.Sdf.NamespaceEditDetail
Detailed information about a namespace edit.
Classes:
Result
Validity of an edit.
Attributes:
Error
Okay
Unbatched
edit
reason
result
class Result
Validity of an edit.
Methods:
GetValueFromName
Attributes:
allValues
static GetValueFromName()
allValues = (Sdf.NamespaceEditDetail.Error, Sdf.NamespaceEditDetail.Unbatched, Sdf.NamespaceEditDetail.Okay)
Error = Sdf.NamespaceEditDetail.Error
Okay = Sdf.NamespaceEditDetail.Okay
Unbatched = Sdf.NamespaceEditDetail.Unbatched
property edit
property reason
property result
class pxr.Sdf.Notice
Wrapper class for Sdf notices.
Classes:
Base
LayerDidReloadContent
LayerDidReplaceContent
LayerDirtinessChanged
LayerIdentifierDidChange
LayerInfoDidChange
LayerMutenessChanged
LayersDidChange
LayersDidChangeSentPerLayer
class Base
class LayerDidReloadContent
class LayerDidReplaceContent
class LayerDirtinessChanged
class LayerIdentifierDidChange
Attributes:
newIdentifier
oldIdentifier
property newIdentifier
property oldIdentifier
class LayerInfoDidChange
Methods:
key
key()
class LayerMutenessChanged
Attributes:
layerPath
wasMuted
property layerPath
property wasMuted
class LayersDidChange
Methods:
GetLayers
GetSerialNumber
GetLayers()
GetSerialNumber()
class LayersDidChangeSentPerLayer
Methods:
GetLayers
GetSerialNumber
GetLayers()
GetSerialNumber()
class pxr.Sdf.Path
A path value used to locate objects in layers or scenegraphs.
## Overview
SdfPath is used in several ways:
As a storage key for addressing and accessing values held in a
SdfLayer
As a namespace identity for scenegraph objects
As a way to refer to other scenegraph objects through relative
paths
The paths represented by an SdfPath class may be either relative or
absolute. Relative paths are relative to the prim object that contains
them (that is, if an SdfRelationshipSpec target is relative, it is
relative to the SdfPrimSpec object that owns the SdfRelationshipSpec
object).
SdfPath objects can be readily created from and converted back to
strings, but as SdfPath objects, they have behaviors that make it easy
and efficient to work with them. The SdfPath class provides a full
range of methods for manipulating scene paths by appending a namespace
child, appending a relationship target, getting the parent path, and
so on. Since the SdfPath class uses a node-based representation
internally, you should use the editing functions rather than
converting to and from strings if possible.
## Path Syntax
Like a filesystem path, an SdfPath is conceptually just a sequence of
path components. Unlike a filesystem path, each component has a type,
and the type is indicated by the syntax.
Two separators are used between parts of a path. A slash (“/”)
following an identifier is used to introduce a namespace child. A
period (“.”) following an identifier is used to introduce a property.
A property may also have several non-sequential colons (‘:’) in its
name to provide a rudimentary namespace within properties but may not
end or begin with a colon.
A leading slash in the string representation of an SdfPath object
indicates an absolute path. Two adjacent periods indicate the parent
namespace.
Brackets (“[“and”]”) are used to indicate relationship target paths
for relational attributes.
The first part in a path is assumed to be a namespace child unless it
is preceded by a period. That means:
/Foo is an absolute path specifying the root prim Foo.
/Foo/Bar is an absolute path specifying namespace child Bar
of root prim Foo.
/Foo/Bar.baz is an absolute path specifying property baz
of namespace child Bar of root prim Foo.
Foo is a relative path specifying namespace child Foo of the
current prim.
Foo/Bar is a relative path specifying namespace child Bar of
namespace child Foo of the current prim.
Foo/Bar.baz is a relative path specifying property baz of
namespace child Bar of namespace child Foo of the current prim.
.foo is a relative path specifying the property foo of
the current prim.
/Foo.bar[/Foo.baz].attrib is a relational attribute path. The
relationship /Foo.bar has a target /Foo.baz . There is a
relational attribute attrib on that relationship->target pair.
## A Note on Thread-Safety
SdfPath is strongly thread-safe, in the sense that zero additional
synchronization is required between threads creating or using SdfPath
values. Just like TfToken, SdfPath values are immutable. Internally,
SdfPath uses a global prefix tree to efficiently share representations
of paths, and provide fast equality/hashing operations, but
modifications to this table are internally synchronized. Consequently,
as with TfToken, for best performance it is important to minimize the
number of values created (since it requires synchronized access to
this table) or copied (since it requires atomic ref-counting
operations).
Classes:
AncestorsRange
Methods:
AppendChild(childName)
Creates a path by appending an element for childName to this path.
AppendElementString(element)
Creates a path by extracting and appending an element from the given ascii element encoding.
AppendExpression()
Creates a path by appending an expression element.
AppendMapper(targetPath)
Creates a path by appending a mapper element for targetPath .
AppendMapperArg(argName)
Creates a path by appending an element for argName .
AppendPath(newSuffix)
Creates a path by appending a given relative path to this path.
AppendProperty(propName)
Creates a path by appending an element for propName to this path.
AppendRelationalAttribute(attrName)
Creates a path by appending an element for attrName to this path.
AppendTarget(targetPath)
Creates a path by appending an element for targetPath .
AppendVariantSelection(variantSet, variant)
Creates a path by appending an element for variantSet and variant to this path.
ContainsPrimVariantSelection()
Returns whether the path or any of its parent paths identifies a variant selection for a prim.
ContainsPropertyElements()
Return true if this path contains any property elements, false otherwise.
ContainsTargetPath()
Return true if this path is or has a prefix that's a target path or a mapper path.
FindLongestPrefix
FindLongestStrictPrefix
FindPrefixedRange
GetAbsoluteRootOrPrimPath()
Creates a path by stripping all properties and relational attributes from this path, leaving the path to the containing prim.
GetAllTargetPathsRecursively(result)
Returns all the relationship target or connection target paths contained in this path, and recursively all the target paths contained in those target paths in reverse depth-first order.
GetAncestorsRange()
Return a range for iterating over the ancestors of this path.
GetCommonPrefix(path)
Returns a path with maximal length that is a prefix path of both this path and path .
GetConciseRelativePaths
classmethod GetConciseRelativePaths(paths) -> list[SdfPath]
GetParentPath()
Return the path that identifies this path's namespace parent.
GetPrefixes
Returns the prefix paths of this path.
GetPrimOrPrimVariantSelectionPath()
Creates a path by stripping all relational attributes, targets, and properties, leaving the nearest path for which IsPrimOrPrimVariantSelectionPath() returns true.
GetPrimPath()
Creates a path by stripping all relational attributes, targets, properties, and variant selections from the leafmost prim path, leaving the nearest path for which IsPrimPath() returns true.
GetVariantSelection()
Returns the variant selection for this path, if this is a variant selection path.
HasPrefix(prefix)
Return true if both this path and prefix are not the empty path and this path has prefix as a prefix.
IsAbsolutePath()
Returns whether the path is absolute.
IsAbsoluteRootOrPrimPath()
Returns whether the path identifies a prim or the absolute root.
IsAbsoluteRootPath()
Return true if this path is the AbsoluteRootPath() .
IsExpressionPath()
Returns whether the path identifies a connection expression.
IsMapperArgPath()
Returns whether the path identifies a connection mapper arg.
IsMapperPath()
Returns whether the path identifies a connection mapper.
IsNamespacedPropertyPath()
Returns whether the path identifies a namespaced property.
IsPrimPath()
Returns whether the path identifies a prim.
IsPrimPropertyPath()
Returns whether the path identifies a prim's property.
IsPrimVariantSelectionPath()
Returns whether the path identifies a variant selection for a prim.
IsPropertyPath()
Returns whether the path identifies a property.
IsRelationalAttributePath()
Returns whether the path identifies a relational attribute.
IsRootPrimPath()
Returns whether the path identifies a root prim.
IsTargetPath()
Returns whether the path identifies a relationship or connection target.
IsValidIdentifier
classmethod IsValidIdentifier(name) -> bool
IsValidNamespacedIdentifier
classmethod IsValidNamespacedIdentifier(name) -> bool
IsValidPathString
classmethod IsValidPathString(pathString, errMsg) -> bool
JoinIdentifier
classmethod JoinIdentifier(names) -> str
MakeAbsolutePath(anchor)
Returns the absolute form of this path using anchor as the relative basis.
MakeRelativePath(anchor)
Returns the relative form of this path using anchor as the relative basis.
RemoveAncestorPaths
classmethod RemoveAncestorPaths(paths) -> None
RemoveCommonSuffix(otherPath, stopAtRootPrim)
Find and remove the longest common suffix from two paths.
RemoveDescendentPaths
classmethod RemoveDescendentPaths(paths) -> None
ReplaceName(newName)
Return a copy of this path with its final component changed to newName.
ReplacePrefix(oldPrefix, newPrefix, ...)
Returns a path with all occurrences of the prefix path oldPrefix replaced with the prefix path newPrefix .
ReplaceTargetPath(newTargetPath)
Replaces the relational attribute's target path.
StripAllVariantSelections()
Create a path by stripping all variant selections from all components of this path, leaving a path with no embedded variant selections.
StripNamespace
classmethod StripNamespace(name) -> str
StripPrefixNamespace
classmethod StripPrefixNamespace(name, matchNamespace) -> tuple[str, bool]
TokenizeIdentifier
classmethod TokenizeIdentifier(name) -> list[str]
Attributes:
absoluteIndicator
absoluteRootPath
childDelimiter
elementString
The string representation of the terminal component of this path.
emptyPath
expressionIndicator
isEmpty
bool
mapperArgDelimiter
mapperIndicator
name
The name of the prim, property or relational attribute identified by the path.
namespaceDelimiter
parentPathElement
pathElementCount
The number of path elements in this path.
pathString
The string representation of this path.
propertyDelimiter
reflexiveRelativePath
relationshipTargetEnd
relationshipTargetStart
targetPath
The relational attribute target path for this path.
class AncestorsRange
Methods:
GetPath
GetPath()
AppendChild(childName) → Path
Creates a path by appending an element for childName to this path.
This path must be a prim path, the AbsoluteRootPath or the
ReflexiveRelativePath.
Parameters
childName (str) –
AppendElementString(element) → Path
Creates a path by extracting and appending an element from the given
ascii element encoding.
Attempting to append a root or empty path (or malformed path) or
attempting to append to the EmptyPath will raise an error and return
the EmptyPath.
May also fail and return EmptyPath if this path’s type cannot possess
a child of the type encoded in element .
Parameters
element (str) –
AppendExpression() → Path
Creates a path by appending an expression element.
This path must be a prim property or relational attribute path.
AppendMapper(targetPath) → Path
Creates a path by appending a mapper element for targetPath .
This path must be a prim property or relational attribute path.
Parameters
targetPath (Path) –
AppendMapperArg(argName) → Path
Creates a path by appending an element for argName .
This path must be a mapper path.
Parameters
argName (str) –
AppendPath(newSuffix) → Path
Creates a path by appending a given relative path to this path.
If the newSuffix is a prim path, then this path must be a prim path or
a root path.
If the newSuffix is a prim property path, then this path must be a
prim path or the ReflexiveRelativePath.
Parameters
newSuffix (Path) –
AppendProperty(propName) → Path
Creates a path by appending an element for propName to this path.
This path must be a prim path or the ReflexiveRelativePath.
Parameters
propName (str) –
AppendRelationalAttribute(attrName) → Path
Creates a path by appending an element for attrName to this path.
This path must be a target path.
Parameters
attrName (str) –
AppendTarget(targetPath) → Path
Creates a path by appending an element for targetPath .
This path must be a prim property or relational attribute path.
Parameters
targetPath (Path) –
AppendVariantSelection(variantSet, variant) → Path
Creates a path by appending an element for variantSet and
variant to this path.
This path must be a prim path.
Parameters
variantSet (str) –
variant (str) –
ContainsPrimVariantSelection() → bool
Returns whether the path or any of its parent paths identifies a
variant selection for a prim.
ContainsPropertyElements() → bool
Return true if this path contains any property elements, false
otherwise.
A false return indicates a prim-like path, specifically a root path, a
prim path, or a prim variant selection path. A true return indicates a
property-like path: a prim property path, a target path, a relational
attribute path, etc.
ContainsTargetPath() → bool
Return true if this path is or has a prefix that’s a target path or a
mapper path.
static FindLongestPrefix()
static FindLongestStrictPrefix()
static FindPrefixedRange()
GetAbsoluteRootOrPrimPath() → Path
Creates a path by stripping all properties and relational attributes
from this path, leaving the path to the containing prim.
If the path is already a prim or absolute root path, the same path is
returned.
GetAllTargetPathsRecursively(result) → None
Returns all the relationship target or connection target paths
contained in this path, and recursively all the target paths contained
in those target paths in reverse depth-first order.
For example, given the
path:’/A/B.a[/C/D.a[/E/F.a]].a[/A/B.a[/C/D.a]]’this method
produces:’/A/B.a[/C/D.a]’,’/C/D.a’,’/C/D.a[/E/F.a]’,’/E/F.a’
Parameters
result (list[SdfPath]) –
GetAncestorsRange() → SdfPathAncestorsRange
Return a range for iterating over the ancestors of this path.
The range provides iteration over the prefixes of a path, ordered from
longest to shortest (the opposite of the order of the prefixes
returned by GetPrefixes).
GetCommonPrefix(path) → Path
Returns a path with maximal length that is a prefix path of both this
path and path .
Parameters
path (Path) –
static GetConciseRelativePaths()
classmethod GetConciseRelativePaths(paths) -> list[SdfPath]
Given some vector of paths, get a vector of concise unambiguous
relative paths.
GetConciseRelativePaths requires a vector of absolute paths. It finds
a set of relative paths such that each relative path is unique.
Parameters
paths (list[SdfPath]) –
GetParentPath() → Path
Return the path that identifies this path’s namespace parent.
For a prim path (like’/foo/bar’), return the prim’s parent’s path
(‘/foo’). For a prim property path (like’/foo/bar.property’), return
the prim’s path (‘/foo/bar’). For a target path
(like’/foo/bar.property[/target]’) return the property path
(‘/foo/bar.property’). For a mapper path
(like’/foo/bar.property.mapper[/target]’) return the property path
(‘/foo/bar.property). For a relational attribute path
(like’/foo/bar.property[/target].relAttr’) return the relationship
target’s path (‘/foo/bar.property[/target]’). For a prim variant
selection path (like’/foo/bar{var=sel}’) return the prim path
(‘/foo/bar’). For a root prim path (like’/rootPrim’), return
AbsoluteRootPath() (‘/’). For a single element relative prim path
(like’relativePrim’), return ReflexiveRelativePath() (‘.’). For
ReflexiveRelativePath() , return the relative parent path (’..’).
Note that the parent path of a relative parent path (’..’) is a
relative grandparent path (’../..’). Use caution writing loops
that walk to parent paths since relative paths have infinitely many
ancestors. To more safely traverse ancestor paths, consider iterating
over an SdfPathAncestorsRange instead, as returend by
GetAncestorsRange() .
GetPrefixes()
Returns the prefix paths of this path.
GetPrimOrPrimVariantSelectionPath() → Path
Creates a path by stripping all relational attributes, targets, and
properties, leaving the nearest path for which
IsPrimOrPrimVariantSelectionPath() returns true.
See GetPrimPath also.
If the path is already a prim or a prim variant selection path, the
same path is returned.
GetPrimPath() → Path
Creates a path by stripping all relational attributes, targets,
properties, and variant selections from the leafmost prim path,
leaving the nearest path for which IsPrimPath() returns true.
See GetPrimOrPrimVariantSelectionPath also.
If the path is already a prim path, the same path is returned.
GetVariantSelection() → tuple[str, str]
Returns the variant selection for this path, if this is a variant
selection path.
Returns a pair of empty strings if this path is not a variant
selection path.
HasPrefix(prefix) → bool
Return true if both this path and prefix are not the empty path and
this path has prefix as a prefix.
Return false otherwise.
Parameters
prefix (Path) –
IsAbsolutePath() → bool
Returns whether the path is absolute.
IsAbsoluteRootOrPrimPath() → bool
Returns whether the path identifies a prim or the absolute root.
IsAbsoluteRootPath() → bool
Return true if this path is the AbsoluteRootPath() .
IsExpressionPath() → bool
Returns whether the path identifies a connection expression.
IsMapperArgPath() → bool
Returns whether the path identifies a connection mapper arg.
IsMapperPath() → bool
Returns whether the path identifies a connection mapper.
IsNamespacedPropertyPath() → bool
Returns whether the path identifies a namespaced property.
A namespaced property has colon embedded in its name.
IsPrimPath() → bool
Returns whether the path identifies a prim.
IsPrimPropertyPath() → bool
Returns whether the path identifies a prim’s property.
A relational attribute is not a prim property.
IsPrimVariantSelectionPath() → bool
Returns whether the path identifies a variant selection for a prim.
IsPropertyPath() → bool
Returns whether the path identifies a property.
A relational attribute is considered to be a property, so this method
will return true for relational attributes as well as properties of
prims.
IsRelationalAttributePath() → bool
Returns whether the path identifies a relational attribute.
If this is true, IsPropertyPath() will also be true.
IsRootPrimPath() → bool
Returns whether the path identifies a root prim.
the path must be absolute and have a single element (for example
/foo ).
IsTargetPath() → bool
Returns whether the path identifies a relationship or connection
target.
static IsValidIdentifier()
classmethod IsValidIdentifier(name) -> bool
Returns whether name is a legal identifier for any path component.
Parameters
name (str) –
static IsValidNamespacedIdentifier()
classmethod IsValidNamespacedIdentifier(name) -> bool
Returns whether name is a legal namespaced identifier.
This returns true if IsValidIdentifier() does.
Parameters
name (str) –
static IsValidPathString()
classmethod IsValidPathString(pathString, errMsg) -> bool
Return true if pathString is a valid path string, meaning that
passing the string to the SdfPath constructor will result in a
valid, non-empty SdfPath.
Otherwise, return false and if errMsg is not None, set the
pointed-to string to the parse error.
Parameters
pathString (str) –
errMsg (str) –
static JoinIdentifier()
classmethod JoinIdentifier(names) -> str
Join names into a single identifier using the namespace delimiter.
Any empty strings present in names are ignored when joining.
Parameters
names (list[str]) –
JoinIdentifier(names) -> str
Join names into a single identifier using the namespace delimiter.
Any empty strings present in names are ignored when joining.
Parameters
names (list[TfToken]) –
JoinIdentifier(lhs, rhs) -> str
Join lhs and rhs into a single identifier using the namespace
delimiter.
Returns lhs if rhs is empty and vice verse. Returns an empty
string if both lhs and rhs are empty.
Parameters
lhs (str) –
rhs (str) –
JoinIdentifier(lhs, rhs) -> str
Join lhs and rhs into a single identifier using the namespace
delimiter.
Returns lhs if rhs is empty and vice verse. Returns an empty
string if both lhs and rhs are empty.
Parameters
lhs (str) –
rhs (str) –
MakeAbsolutePath(anchor) → Path
Returns the absolute form of this path using anchor as the
relative basis.
anchor must be an absolute prim path.
If this path is a relative path, resolve it using anchor as the
relative basis.
If this path is already an absolute path, just return a copy.
Parameters
anchor (Path) –
MakeRelativePath(anchor) → Path
Returns the relative form of this path using anchor as the
relative basis.
anchor must be an absolute prim path.
If this path is an absolute path, return the corresponding relative
path that is relative to the absolute path given by anchor .
If this path is a relative path, return the optimal relative path to
the absolute path given by anchor . (The optimal relative path
from a given prim path is the relative path with the least leading
dot-dots.
Parameters
anchor (Path) –
static RemoveAncestorPaths()
classmethod RemoveAncestorPaths(paths) -> None
Remove all elements of paths that prefix other elements in paths.
As a side-effect, the result is left in sorted order.
Parameters
paths (list[SdfPath]) –
RemoveCommonSuffix(otherPath, stopAtRootPrim) → tuple[Path, Path]
Find and remove the longest common suffix from two paths.
Returns this path and otherPath with the longest common suffix
removed (first and second, respectively). If the two paths have no
common suffix then the paths are returned as-is. If the paths are
equal then this returns empty paths for relative paths and absolute
roots for absolute paths. The paths need not be the same length.
If stopAtRootPrim is true then neither returned path will be
the root path. That, in turn, means that some common suffixes will not
be removed. For example, if stopAtRootPrim is true then the
paths /A/B and /B will be returned as is. Were it false then the
result would be /A and /. Similarly paths /A/B/C and /B/C would return
/A/B and /B if stopAtRootPrim is true but /A and / if it’s
false .
Parameters
otherPath (Path) –
stopAtRootPrim (bool) –
static RemoveDescendentPaths()
classmethod RemoveDescendentPaths(paths) -> None
Remove all elements of paths that are prefixed by other elements in
paths.
As a side-effect, the result is left in sorted order.
Parameters
paths (list[SdfPath]) –
ReplaceName(newName) → Path
Return a copy of this path with its final component changed to
newName.
This path must be a prim or property path.
This method is shorthand for path.GetParentPath().AppendChild(newName)
for prim paths, path.GetParentPath().AppendProperty(newName) for prim
property paths, and
path.GetParentPath().AppendRelationalAttribute(newName) for relational
attribute paths.
Note that only the final path component is ever changed. If the name
of the final path component appears elsewhere in the path, it will not
be modified.
Some examples:
ReplaceName(‘/chars/MeridaGroup’,’AngusGroup’)
->’/chars/AngusGroup’ReplaceName(‘/Merida.tx’,’ty’)
->’/Merida.ty’ReplaceName(‘/Merida.tx[targ].tx’,’ty’)
->’/Merida.tx[targ].ty’
Parameters
newName (str) –
ReplacePrefix(oldPrefix, newPrefix, fixTargetPaths) → Path
Returns a path with all occurrences of the prefix path oldPrefix
replaced with the prefix path newPrefix .
If fixTargetPaths is true, any embedded target paths will also have
their paths replaced. This is the default.
If this is not a target, relational attribute or mapper path this will
do zero or one path prefix replacements, if not the number of
replacements can be greater than one.
Parameters
oldPrefix (Path) –
newPrefix (Path) –
fixTargetPaths (bool) –
ReplaceTargetPath(newTargetPath) → Path
Replaces the relational attribute’s target path.
The path must be a relational attribute path.
Parameters
newTargetPath (Path) –
StripAllVariantSelections() → Path
Create a path by stripping all variant selections from all components
of this path, leaving a path with no embedded variant selections.
static StripNamespace()
classmethod StripNamespace(name) -> str
Returns name stripped of any namespaces.
This does not check the validity of the name; it just attempts to
remove anything that looks like a namespace.
Parameters
name (str) –
StripNamespace(name) -> str
Returns name stripped of any namespaces.
This does not check the validity of the name; it just attempts to
remove anything that looks like a namespace.
Parameters
name (str) –
static StripPrefixNamespace()
classmethod StripPrefixNamespace(name, matchNamespace) -> tuple[str, bool]
Returns ( name , true ) where name is stripped of the
prefix specified by matchNamespace if name indeed starts with
matchNamespace .
Returns ( name , false ) otherwise, with name unmodified.
This function deals with both the case where matchNamespace
contains the trailing namespace delimiter’:’or not.
Parameters
name (str) –
matchNamespace (str) –
static TokenizeIdentifier()
classmethod TokenizeIdentifier(name) -> list[str]
Tokenizes name by the namespace delimiter.
Returns the empty vector if name is not a valid namespaced
identifier.
Parameters
name (str) –
absoluteIndicator = '/'
absoluteRootPath = Sdf.Path('/')
childDelimiter = '/'
property elementString
The string representation of the terminal component of this path.
This path can be reconstructed via
thisPath.GetParentPath().AppendElementString(thisPath.element).
None of absoluteRootPath, reflexiveRelativePath, nor emptyPath
possess the above quality; their .elementString is the empty string.
emptyPath = Sdf.Path.emptyPath
expressionIndicator = 'expression'
property isEmpty
bool
Returns true if this is the empty path ( SdfPath::EmptyPath() ).
Type
type
mapperArgDelimiter = '.'
mapperIndicator = 'mapper'
property name
The name of the prim, property or relational
attribute identified by the path.
‘’ for EmptyPath. ‘.’ for ReflexiveRelativePath.
‘..’ for a path ending in ParentPathElement.
namespaceDelimiter = ':'
parentPathElement = '..'
property pathElementCount
The number of path elements in this path.
property pathString
The string representation of this path.
propertyDelimiter = '.'
reflexiveRelativePath = Sdf.Path('.')
relationshipTargetEnd = ']'
relationshipTargetStart = '['
property targetPath
The relational attribute target path for this path.
EmptyPath if this is not a relational attribute path.
class pxr.Sdf.PathArray
An array of type SdfPath.
class pxr.Sdf.PathListOp
Methods:
ApplyOperations
Clear
ClearAndMakeExplicit
Create
CreateExplicit
GetAddedOrExplicitItems
HasItem
Attributes:
addedItems
appendedItems
deletedItems
explicitItems
isExplicit
orderedItems
prependedItems
ApplyOperations()
Clear()
ClearAndMakeExplicit()
static Create()
static CreateExplicit()
GetAddedOrExplicitItems()
HasItem()
property addedItems
property appendedItems
property deletedItems
property explicitItems
property isExplicit
property orderedItems
property prependedItems
class pxr.Sdf.Payload
Represents a payload and all its meta data.
A payload represents a prim reference to an external layer. A payload
is similar to a prim reference (see SdfReference) with the major
difference that payloads are explicitly loaded by the user.
Unloaded payloads represent a boundary that lazy composition and
system behaviors will not traverse across, providing a user-visible
way to manage the working set of the scene.
Attributes:
assetPath
None
layerOffset
None
primPath
None
property assetPath
None
Sets a new asset path for the layer the payload uses.
See SdfAssetPath for what characters are valid in assetPath . If
assetPath contains invalid characters, issue an error and set this
payload’s asset path to the empty asset path.
type : str
Returns the asset path of the layer that the payload uses.
Type
type
property layerOffset
None
Sets a new layer offset.
type : LayerOffset
Returns the layer offset associated with the payload.
Type
type
property primPath
None
Sets a new prim path for the prim that the payload uses.
type : Path
Returns the scene path of the prim for the payload.
Type
type
class pxr.Sdf.PayloadListOp
Methods:
ApplyOperations
Clear
ClearAndMakeExplicit
Create
CreateExplicit
GetAddedOrExplicitItems
HasItem
Attributes:
addedItems
appendedItems
deletedItems
explicitItems
isExplicit
orderedItems
prependedItems
ApplyOperations()
Clear()
ClearAndMakeExplicit()
static Create()
static CreateExplicit()
GetAddedOrExplicitItems()
HasItem()
property addedItems
property appendedItems
property deletedItems
property explicitItems
property isExplicit
property orderedItems
property prependedItems
class pxr.Sdf.Permission
Methods:
GetValueFromName
Attributes:
allValues
static GetValueFromName()
allValues = (Sdf.PermissionPublic, Sdf.PermissionPrivate)
class pxr.Sdf.PrimSpec
Represents a prim description in an SdfLayer object.
Every SdfPrimSpec object is defined in a layer. It is identified by
its path (SdfPath class) in the namespace hierarchy of its layer.
SdfPrimSpecs can be created using the New() method as children of
either the containing SdfLayer itself (for”root level”prims), or as
children of other SdfPrimSpec objects to extend a hierarchy. The
helper function SdfCreatePrimInLayer() can be used to quickly create a
hierarchy of primSpecs.
SdfPrimSpec objects have properties of two general types: attributes
(containing values) and relationships (different types of connections
to other prims and attributes). Attributes are represented by the
SdfAttributeSpec class and relationships by the SdfRelationshipSpec
class. Each prim has its own namespace of properties. Properties are
stored and accessed by their name.
SdfPrimSpec objects have a typeName, permission restriction, and they
reference and inherit prim paths. Permission restrictions control
which other layers may refer to, or express opinions about a prim. See
the SdfPermission class for more information.
Insert doc about references and inherits here.
Should have validate... methods for name, children,
properties
Methods:
ApplyNameChildrenOrder(vec)
Reorders the given list of child names according to the reorder nameChildren statement for this prim.
ApplyPropertyOrder(vec)
Reorders the given list of property names according to the reorder properties statement for this prim.
BlockVariantSelection(variantSetName)
Blocks the variant selected for the given variant set by setting the variant selection to empty.
CanSetName(newName, whyNot)
Returns true if setting the prim spec's name to newName will succeed.
ClearActive()
Removes the active opinion in this prim spec if there is one.
ClearInstanceable()
Clears the value for the prim's instanceable flag.
ClearKind()
Remove the kind opinion from this prim spec if there is one.
ClearPayloadList
Clears the payloads for this prim.
ClearReferenceList
Clears the references for this prim.
GetAttributeAtPath(path)
Returns an attribute given its path .
GetObjectAtPath(path)
path: Path
GetPrimAtPath(path)
Returns a prim given its path .
GetPropertyAtPath(path)
Returns a property given its path .
GetRelationshipAtPath(path)
Returns a relationship given its path .
GetVariantNames(name)
Returns list of variant names for the given variant set.
HasActive()
Returns true if this prim spec has an opinion about active.
HasInstanceable()
Returns true if this prim spec has a value authored for its instanceable flag, false otherwise.
HasKind()
Returns true if this prim spec has an opinion about kind.
RemoveProperty(property)
Removes the property.
Attributes:
ActiveKey
AnyTypeToken
CommentKey
CustomDataKey
DocumentationKey
HiddenKey
InheritPathsKey
KindKey
PayloadKey
PermissionKey
PrefixKey
PrefixSubstitutionsKey
PrimOrderKey
PropertyOrderKey
ReferencesKey
RelocatesKey
SpecializesKey
SpecifierKey
SymmetricPeerKey
SymmetryArgumentsKey
SymmetryFunctionKey
TypeNameKey
VariantSelectionKey
VariantSetNamesKey
active
Whether this prim spec is active.
assetInfo
Returns the asset info dictionary for this prim.
attributes
The attributes of this prim, as an ordered dictionary.
comment
The prim's comment string.
customData
The custom data for this prim.
documentation
The prim's documentation string.
expired
hasPayloads
Returns true if this prim has payloads set.
hasReferences
Returns true if this prim has references set.
hidden
Whether this prim spec will be hidden in browsers.
inheritPathList
A PathListEditor for the prim's inherit paths.
instanceable
Whether this prim spec is flagged as instanceable.
kind
What kind of model this prim spec represents, if any.
name
The prim's name.
nameChildren
The prim name children of this prim, as an ordered dictionary.
nameChildrenOrder
Get/set the list of child names for this prim's 'reorder nameChildren' statement.
nameParent
The name parent of this prim.
nameRoot
The name pseudo-root of this prim.
payloadList
A PayloadListEditor for the prim's payloads.
permission
The prim's permission restriction.
prefix
The prim's prefix.
prefixSubstitutions
Dictionary of prefix substitutions.
properties
The properties of this prim, as an ordered dictionary.
propertyOrder
Get/set the list of property names for this prim's 'reorder properties' statement.
realNameParent
The name parent of this prim.
referenceList
A ReferenceListEditor for the prim's references.
relationships
The relationships of this prim, as an ordered dictionary.
relocates
An editing proxy for the prim's map of relocation paths.
specializesList
A PathListEditor for the prim's specializes.
specifier
The prim's specifier (SpecifierDef or SpecifierOver).
suffix
The prim's suffix.
suffixSubstitutions
Dictionary of prefix substitutions.
symmetricPeer
The prims's symmetric peer.
symmetryArguments
Dictionary with prim symmetry arguments.
symmetryFunction
The prim's symmetry function.
typeName
The type of this prim.
variantSelections
Dictionary whose keys are variant set names and whose values are the variants chosen for each set.
variantSetNameList
A StringListEditor for the names of the variant sets for this prim.
variantSets
The VariantSetSpecs for this prim indexed by name.
ApplyNameChildrenOrder(vec) → None
Reorders the given list of child names according to the reorder
nameChildren statement for this prim.
This routine employs the standard list editing operation for ordered
items in a ListEditor.
Parameters
vec (list[str]) –
ApplyPropertyOrder(vec) → None
Reorders the given list of property names according to the reorder
properties statement for this prim.
This routine employs the standard list editing operation for ordered
items in a ListEditor.
Parameters
vec (list[str]) –
BlockVariantSelection(variantSetName) → None
Blocks the variant selected for the given variant set by setting the
variant selection to empty.
Parameters
variantSetName (str) –
CanSetName(newName, whyNot) → bool
Returns true if setting the prim spec’s name to newName will
succeed.
Returns false if it won’t, and sets whyNot with a string
describing why not.
Parameters
newName (str) –
whyNot (str) –
ClearActive() → None
Removes the active opinion in this prim spec if there is one.
ClearInstanceable() → None
Clears the value for the prim’s instanceable flag.
ClearKind() → None
Remove the kind opinion from this prim spec if there is one.
ClearPayloadList()
Clears the payloads for this prim.
ClearReferenceList()
Clears the references for this prim.
GetAttributeAtPath(path) → AttributeSpec
Returns an attribute given its path .
Returns invalid handle if there is no attribute at path . This is
simply a more specifically typed version of GetObjectAtPath.
Parameters
path (Path) –
GetObjectAtPath(path) → object
path: Path
Returns a prim or property given its namespace path.
If path is relative then it will be interpreted as relative to this prim. If it is absolute then it will be interpreted as absolute in this prim’s layer. The return type can be either PrimSpecPtr or PropertySpecPtr.
GetPrimAtPath(path) → PrimSpec
Returns a prim given its path .
Returns invalid handle if there is no prim at path . This is
simply a more specifically typed version of GetObjectAtPath.
Parameters
path (Path) –
GetPropertyAtPath(path) → PropertySpec
Returns a property given its path .
Returns invalid handle if there is no property at path . This is
simply a more specifically typed version of GetObjectAtPath.
Parameters
path (Path) –
GetRelationshipAtPath(path) → RelationshipSpec
Returns a relationship given its path .
Returns invalid handle if there is no relationship at path . This
is simply a more specifically typed version of GetObjectAtPath.
Parameters
path (Path) –
GetVariantNames(name) → list[str]
Returns list of variant names for the given variant set.
Parameters
name (str) –
HasActive() → bool
Returns true if this prim spec has an opinion about active.
HasInstanceable() → bool
Returns true if this prim spec has a value authored for its
instanceable flag, false otherwise.
HasKind() → bool
Returns true if this prim spec has an opinion about kind.
RemoveProperty(property) → None
Removes the property.
Parameters
property (PropertySpec) –
ActiveKey = 'active'
AnyTypeToken = '__AnyType__'
CommentKey = 'comment'
CustomDataKey = 'customData'
DocumentationKey = 'documentation'
HiddenKey = 'hidden'
InheritPathsKey = 'inheritPaths'
KindKey = 'kind'
PayloadKey = 'payload'
PermissionKey = 'permission'
PrefixKey = 'prefix'
PrefixSubstitutionsKey = 'prefixSubstitutions'
PrimOrderKey = 'primOrder'
PropertyOrderKey = 'propertyOrder'
ReferencesKey = 'references'
RelocatesKey = 'relocates'
SpecializesKey = 'specializes'
SpecifierKey = 'specifier'
SymmetricPeerKey = 'symmetricPeer'
SymmetryArgumentsKey = 'symmetryArguments'
SymmetryFunctionKey = 'symmetryFunction'
TypeNameKey = 'typeName'
VariantSelectionKey = 'variantSelection'
VariantSetNamesKey = 'variantSetNames'
property active
Whether this prim spec is active.
The default value is true.
property assetInfo
Returns the asset info dictionary for this prim.
The default value is an empty dictionary.
The asset info dictionary is used to annotate prims representing the root-prims of assets (generally organized as models) with various data related to asset management. For example, asset name, root layer identifier, asset version etc.
property attributes
The attributes of this prim, as an ordered dictionary.
property comment
The prim’s comment string.
property customData
The custom data for this prim.
The default value for custom data is an empty dictionary.
Custom data is for use by plugins or other non-tools supplied
extensions that need to be able to store data attached to arbitrary
scene objects. Note that if the only objects you want to store data
on are prims, using custom attributes is probably a better choice.
But if you need to possibly store this data on attributes or
relationships or as annotations on reference arcs, then custom data
is an appropriate choice.
property documentation
The prim’s documentation string.
property expired
property hasPayloads
Returns true if this prim has payloads set.
property hasReferences
Returns true if this prim has references set.
property hidden
Whether this prim spec will be hidden in browsers.
The default value is false.
property inheritPathList
A PathListEditor for the prim’s inherit paths.
The list of the inherit paths for this prim may be modified with this PathListEditor.
A PathListEditor may express a list either as an explicit value or as a set of list editing operations. See PathListEditor for more information.
property instanceable
Whether this prim spec is flagged as instanceable.
The default value is false.
property kind
What kind of model this prim spec represents, if any.
The default is an empty string
property name
The prim’s name.
property nameChildren
The prim name children of this prim, as an ordered dictionary.
Note that although this property is described as being read-only, you can modify the contents to add, remove, or reorder children.
property nameChildrenOrder
Get/set the list of child names for this prim’s ‘reorder nameChildren’ statement.
property nameParent
The name parent of this prim.
property nameRoot
The name pseudo-root of this prim.
property payloadList
A PayloadListEditor for the prim’s payloads.
The list of the payloads for this prim may be modified with this PayloadListEditor.
A PayloadListEditor may express a list either as an explicit value or as a set of list editing operations. See PayloadListEditor for more information.
property permission
The prim’s permission restriction.
The default value is SdfPermissionPublic.
property prefix
The prim’s prefix.
property prefixSubstitutions
Dictionary of prefix substitutions.
property properties
The properties of this prim, as an ordered dictionary.
Note that although this property is described as being read-only, you can modify the contents to add, remove, or reorder properties.
property propertyOrder
Get/set the list of property names for this prim’s ‘reorder properties’ statement.
property realNameParent
The name parent of this prim.
property referenceList
A ReferenceListEditor for the prim’s references.
The list of the references for this prim may be modified with this ReferenceListEditor.
A ReferenceListEditor may express a list either as an explicit value or as a set of list editing operations. See ReferenceListEditor for more information.
property relationships
The relationships of this prim, as an ordered dictionary.
property relocates
An editing proxy for the prim’s map of relocation paths.
The map of source-to-target paths specifying namespace relocation may be set or cleared whole, or individual map entries may be added, removed, or edited.
property specializesList
A PathListEditor for the prim’s specializes.
The list of the specializes for this prim may be modified with this PathListEditor.
A PathListEditor may express a list either as an explicit value or as a set of list editing operations. See PathListEditor for more information.
property specifier
The prim’s specifier (SpecifierDef or SpecifierOver).
The default value is SpecifierOver.
property suffix
The prim’s suffix.
property suffixSubstitutions
Dictionary of prefix substitutions.
property symmetricPeer
The prims’s symmetric peer.
property symmetryArguments
Dictionary with prim symmetry arguments.
Although this property is marked read-only, you can modify the contents to add, change, and clear symmetry arguments.
property symmetryFunction
The prim’s symmetry function.
property typeName
The type of this prim.
property variantSelections
Dictionary whose keys are variant set names and whose values are the variants chosen for each set.
Although this property is marked read-only, you can modify the contents to add, change, and clear variants.
property variantSetNameList
A StringListEditor for the names of the variant
sets for this prim.
The list of the names of the variants sets of this prim may be
modified with this StringListEditor.
A StringListEditor may express a list either as an explicit value or as a set of list editing operations. See StringListEditor for more information.
Although this property is marked as read-only, the returned object is modifiable.
property variantSets
The VariantSetSpecs for this prim indexed by name.
Although this property is marked as read-only, you can
modify the contents to remove variant sets. New variant sets
are created by creating them with the prim as the owner.
Although this property is marked as read-only, the returned object
is modifiable.
class pxr.Sdf.PropertySpec
Base class for SdfAttributeSpec and SdfRelationshipSpec.
Scene Spec Attributes (SdfAttributeSpec) and Relationships
(SdfRelationshipSpec) are the basic properties that make up Scene Spec
Prims (SdfPrimSpec). They share many qualities and can sometimes be
treated uniformly. The common qualities are provided by this base
class.
NOTE: Do not use Python reserved words and keywords as attribute
names. This will cause attribute resolution to fail.
Methods:
ClearDefaultValue()
Clear the attribute's default value.
HasDefaultValue()
Returns true if a default value is set for this attribute.
Attributes:
AssetInfoKey
CommentKey
CustomDataKey
CustomKey
DisplayGroupKey
DisplayNameKey
DocumentationKey
HiddenKey
PermissionKey
PrefixKey
SymmetricPeerKey
SymmetryArgumentsKey
SymmetryFunctionKey
assetInfo
Returns the asset info dictionary for this property.
comment
A comment describing the property.
custom
Whether this property spec declares a custom attribute.
customData
The property's custom data.
default
The default value of this property.
displayGroup
DisplayGroup for the property.
displayName
DisplayName for the property.
documentation
Documentation for the property.
expired
hasOnlyRequiredFields
Indicates whether this spec has any significant data other than just what is necessary for instantiation.
hidden
Whether this property will be hidden in browsers.
name
The name of the property.
owner
The owner of this property.
permission
The property's permission restriction.
prefix
Prefix for the property.
symmetricPeer
The property's symmetric peer.
symmetryArguments
Dictionary with property symmetry arguments.
symmetryFunction
The property's symmetry function.
variability
Returns the variability of the property.
ClearDefaultValue() → None
Clear the attribute’s default value.
HasDefaultValue() → bool
Returns true if a default value is set for this attribute.
AssetInfoKey = 'assetInfo'
CommentKey = 'comment'
CustomDataKey = 'customData'
CustomKey = 'custom'
DisplayGroupKey = 'displayGroup'
DisplayNameKey = 'displayName'
DocumentationKey = 'documentation'
HiddenKey = 'hidden'
PermissionKey = 'permission'
PrefixKey = 'prefix'
SymmetricPeerKey = 'symmetricPeer'
SymmetryArgumentsKey = 'symmetryArguments'
SymmetryFunctionKey = 'symmetryFunction'
property assetInfo
Returns the asset info dictionary for this property.
The default value is an empty dictionary.
The asset info dictionary is used to annotate SdfAssetPath-valued attributes pointing to the root-prims of assets (generally organized as models) with various data related to asset management. For example, asset name, root layer identifier, asset version etc.
Note: It is only valid to author assetInfo on attributes that are of type SdfAssetPath.
property comment
A comment describing the property.
property custom
Whether this property spec declares a custom attribute.
property customData
The property’s custom data.
The default value for custom data is an empty dictionary.
Custom data is for use by plugins or other non-tools supplied
extensions that need to be able to store data attached to arbitrary
scene objects. Note that if the only objects you want to store data
on are prims, using custom attributes is probably a better choice.
But if you need to possibly store this data on attributes or
relationships or as annotations on reference arcs, then custom data
is an appropriate choice.
property default
The default value of this property.
property displayGroup
DisplayGroup for the property.
property displayName
DisplayName for the property.
property documentation
Documentation for the property.
property expired
property hasOnlyRequiredFields
Indicates whether this spec has any significant data other
than just what is necessary for instantiation.
This is a less strict version of isInert, returning True if
the spec contains as much as the type and name.
property hidden
Whether this property will be hidden in browsers.
property name
The name of the property.
property owner
The owner of this property. Either a relationship or a prim.
property permission
The property’s permission restriction.
property prefix
Prefix for the property.
property symmetricPeer
The property’s symmetric peer.
property symmetryArguments
Dictionary with property symmetry arguments.
Although this property is marked read-only, you can modify the contents to add, change, and clear symmetry arguments.
property symmetryFunction
The property’s symmetry function.
property variability
Returns the variability of the property.
An attribute’s variability may be Varying
Uniform, Config or Computed.
For an attribute, the default is Varying, for a relationship the default is Uniform.
Varying relationships may be directly authored ‘animating’ targetpaths over time.
Varying attributes may be directly authored, animated and
affected on by Actions. They are the most flexible.
Uniform attributes may be authored only with non-animated values
(default values). They cannot be affected by Actions, but they
can be connected to other Uniform attributes.
Config attributes are the same as Uniform except that a Prim
can choose to alter its collection of built-in properties based
on the values of its Config attributes.
Computed attributes may not be authored in scene description.
Prims determine the values of their Computed attributes through
Prim-specific computation. They may not be connected.
class pxr.Sdf.PseudoRootSpec
Attributes:
expired
property expired
class pxr.Sdf.Reference
Represents a reference and all its meta data.
A reference is expressed on a prim in a given layer and it identifies
a prim in a layer stack. All opinions in the namespace hierarchy under
the referenced prim will be composed with the opinions in the
namespace hierarchy under the referencing prim.
The asset path specifies the layer stack being referenced. If this
asset path is non-empty, this reference is considered
an’external’reference to the layer stack rooted at the specified
layer. If this is empty, this reference is considered
an’internal’reference to the layer stack containing (but not
necessarily rooted at) the layer where the reference is authored.
The prim path specifies the prim in the referenced layer stack from
which opinions will be composed. If this prim path is empty, it will
be considered a reference to the default prim specified in the root
layer of the referenced layer stack see SdfLayer::GetDefaultPrim.
The meta data for a reference is its layer offset and custom data. The
layer offset is an affine transformation applied to all anim splines
in the referenced prim’s namespace hierarchy, see SdfLayerOffset for
details. Custom data is for use by plugins or other non-tools supplied
extensions that need to be able to store data associated with
references.
Methods:
IsInternal()
Returns true in the case of an internal reference.
Attributes:
assetPath
None
customData
None
layerOffset
None
primPath
None
IsInternal() → bool
Returns true in the case of an internal reference.
An internal reference is a reference with an empty asset path.
property assetPath
None
Sets the asset path for the root layer of the referenced layer stack.
This may be set to an empty string to specify an internal reference.
See SdfAssetPath for what characters are valid in assetPath . If
assetPath contains invalid characters, issue an error and set this
reference’s asset path to the empty asset path.
type : str
Returns the asset path to the root layer of the referenced layer
stack.
This will be empty in the case of an internal reference.
Type
type
property customData
None
Sets the custom data associated with the reference.
type : None
Sets a custom data entry for the reference.
If value is empty, then this removes the given custom data entry.
type : VtDictionary
Returns the custom data associated with the reference.
Type
type
property layerOffset
None
Sets a new layer offset.
type : LayerOffset
Returns the layer offset associated with the reference.
Type
type
property primPath
None
Sets the path of the referenced prim.
This may be set to an empty path to specify a reference to the default
prim in the referenced layer stack.
type : Path
Returns the path of the referenced prim.
This will be empty if the referenced prim is the default prim
specified in the referenced layer stack.
Type
type
class pxr.Sdf.ReferenceListOp
Methods:
ApplyOperations
Clear
ClearAndMakeExplicit
Create
CreateExplicit
GetAddedOrExplicitItems
HasItem
Attributes:
addedItems
appendedItems
deletedItems
explicitItems
isExplicit
orderedItems
prependedItems
ApplyOperations()
Clear()
ClearAndMakeExplicit()
static Create()
static CreateExplicit()
GetAddedOrExplicitItems()
HasItem()
property addedItems
property appendedItems
property deletedItems
property explicitItems
property isExplicit
property orderedItems
property prependedItems
class pxr.Sdf.RelationshipSpec
A property that contains a reference to one or more SdfPrimSpec
instances.
A relationship may refer to one or more target prims or attributes.
All targets of a single relationship are considered to be playing the
same role. Note that role does not imply that the target prims or
attributes are of the same type .
Relationships may be annotated with relational attributes. Relational
attributes are named SdfAttributeSpec objects containing values that
describe the relationship. For example, point weights are commonly
expressed as relational attributes.
Methods:
RemoveTargetPath(path, preserveTargetOrder)
Removes the specified target path.
ReplaceTargetPath(oldPath, newPath)
Updates the specified target path.
Attributes:
TargetsKey
expired
noLoadHint
whether the target must be loaded to load the prim this relationship is attached to.
targetPathList
A PathListEditor for the relationship's target paths.
RemoveTargetPath(path, preserveTargetOrder) → None
Removes the specified target path.
Removes the given target path and any relational attributes for the
given target path. If preserveTargetOrder is true , Erase() is
called on the list editor instead of RemoveItemEdits(). This preserves
the ordered items list.
Parameters
path (Path) –
preserveTargetOrder (bool) –
ReplaceTargetPath(oldPath, newPath) → None
Updates the specified target path.
Replaces the path given by oldPath with the one specified by
newPath . Relational attributes are updated if necessary.
Parameters
oldPath (Path) –
newPath (Path) –
TargetsKey = 'targetPaths'
property expired
property noLoadHint
whether the target must be loaded to load the prim this
relationship is attached to.
property targetPathList
A PathListEditor for the relationship’s target paths.
The list of the target paths for this relationship may be
modified with this PathListEditor.
A PathListEditor may express a list either as an explicit
value or as a set of list editing operations. See PathListEditor
for more information.
class pxr.Sdf.Spec
Base class for all Sdf spec classes.
Methods:
ClearInfo(key)
key : string nClears the value for scene spec info with the given key.
GetAsText
GetFallbackForInfo(key)
key : string
GetInfo(key)
Gets the value for the given metadata key.
GetMetaDataDisplayGroup(key)
Returns this metadata key's displayGroup.
GetMetaDataInfoKeys()
Returns the list of metadata info keys for this object.
GetTypeForInfo(key)
key : string
HasInfo(key)
key : string
IsInert
Indicates whether this spec has any significant data.
ListInfoKeys()
Returns the full list of info keys currently set on this object.
SetInfo(key, value)
Sets the value for the given metadata key.
SetInfoDictionaryValue(dictionaryKey, ...)
Sets the value for entryKey to value within the dictionary with the given metadata key dictionaryKey .
Attributes:
expired
isInert
Indicates whether this spec has any significant data.
layer
The owning layer.
path
The absolute scene path.
ClearInfo(key)
key : string
nClears the value for scene spec info with the given key. After calling this, HasInfo() will return false. To make HasInfo() return true, set a value for that scene spec info.
GetAsText()
GetFallbackForInfo(key)
key : string
Returns the fallback value for the given key.
GetInfo(key) → VtValue
Gets the value for the given metadata key.
This is interim API which is likely to change. Only editors with an
immediate specific need (like the Inspector) should use this API.
Parameters
key (str) –
GetMetaDataDisplayGroup(key) → str
Returns this metadata key’s displayGroup.
Parameters
key (str) –
GetMetaDataInfoKeys() → list[str]
Returns the list of metadata info keys for this object.
This is not the complete list of keys, it is only those that should be
considered to be metadata by inspectors or other presentation UI.
This is interim API which is likely to change. Only editors with an
immediate specific need (like the Inspector) should use this API.
GetTypeForInfo(key)
key : string
Returns the type of value for the given key.
HasInfo(key) → bool
key : string
Returns whether there is a setting for the scene spec info with the given key.
When asked for a value for one of its scene spec info, a valid value will always be returned. But if this API returns false for a scene spec info, the value of that info will be the defined default value.
(XXX: This may change such that it is an error to ask for a value when there is none).
When dealing with a composedLayer, it is not necessary to worry about whether a scene spec info ‘has a value’ because the composed layer will always have a valid value, even if it is the default.
A spec may or may not have an expressed value for some of its scene spec info.
IsInert()
Indicates whether this spec has any significant data. If ignoreChildren is true, child scenegraph objects will be ignored.
ListInfoKeys() → list[str]
Returns the full list of info keys currently set on this object.
This does not include fields that represent names of children.
SetInfo(key, value) → None
Sets the value for the given metadata key.
It is an error to pass a value that is not the correct type for that
given key.
This is interim API which is likely to change. Only editors with an
immediate specific need (like the Inspector) should use this API.
Parameters
key (str) –
value (VtValue) –
SetInfoDictionaryValue(dictionaryKey, entryKey, value) → None
Sets the value for entryKey to value within the dictionary
with the given metadata key dictionaryKey .
Parameters
dictionaryKey (str) –
entryKey (str) –
value (VtValue) –
property expired
property isInert
Indicates whether this spec has any significant data. This is for backwards compatibility, use IsInert instead.
Compatibility note: prior to presto 1.9, isInert (then isEmpty) was true for otherwise inert PrimSpecs with inert inherits, references, or variant sets. isInert is now false in such conditions.
property layer
The owning layer.
property path
The absolute scene path.
class pxr.Sdf.SpecType
Methods:
GetValueFromName
Attributes:
allValues
static GetValueFromName()
allValues = (Sdf.SpecTypeUnknown, Sdf.SpecTypeAttribute, Sdf.SpecTypeConnection, Sdf.SpecTypeExpression, Sdf.SpecTypeMapper, Sdf.SpecTypeMapperArg, Sdf.SpecTypePrim, Sdf.SpecTypePseudoRoot, Sdf.SpecTypeRelationship, Sdf.SpecTypeRelationshipTarget, Sdf.SpecTypeVariant, Sdf.SpecTypeVariantSet)
class pxr.Sdf.Specifier
Methods:
GetValueFromName
Attributes:
allValues
static GetValueFromName()
allValues = (Sdf.SpecifierDef, Sdf.SpecifierOver, Sdf.SpecifierClass)
class pxr.Sdf.StringListOp
Methods:
ApplyOperations
Clear
ClearAndMakeExplicit
Create
CreateExplicit
GetAddedOrExplicitItems
HasItem
Attributes:
addedItems
appendedItems
deletedItems
explicitItems
isExplicit
orderedItems
prependedItems
ApplyOperations()
Clear()
ClearAndMakeExplicit()
static Create()
static CreateExplicit()
GetAddedOrExplicitItems()
HasItem()
property addedItems
property appendedItems
property deletedItems
property explicitItems
property isExplicit
property orderedItems
property prependedItems
class pxr.Sdf.TimeCode
Value type that represents a time code. It’s equivalent to a double
type value but is used to indicate that this value should be resolved
by any time based value resolution.
Methods:
GetValue()
Return the time value.
GetValue() → float
Return the time value.
class pxr.Sdf.TimeCodeArray
An array of type SdfTimeCode.
class pxr.Sdf.TokenListOp
Methods:
ApplyOperations
Clear
ClearAndMakeExplicit
Create
CreateExplicit
GetAddedOrExplicitItems
HasItem
Attributes:
addedItems
appendedItems
deletedItems
explicitItems
isExplicit
orderedItems
prependedItems
ApplyOperations()
Clear()
ClearAndMakeExplicit()
static Create()
static CreateExplicit()
GetAddedOrExplicitItems()
HasItem()
property addedItems
property appendedItems
property deletedItems
property explicitItems
property isExplicit
property orderedItems
property prependedItems
class pxr.Sdf.UInt64ListOp
Methods:
ApplyOperations
Clear
ClearAndMakeExplicit
Create
CreateExplicit
GetAddedOrExplicitItems
HasItem
Attributes:
addedItems
appendedItems
deletedItems
explicitItems
isExplicit
orderedItems
prependedItems
ApplyOperations()
Clear()
ClearAndMakeExplicit()
static Create()
static CreateExplicit()
GetAddedOrExplicitItems()
HasItem()
property addedItems
property appendedItems
property deletedItems
property explicitItems
property isExplicit
property orderedItems
property prependedItems
class pxr.Sdf.UIntListOp
Methods:
ApplyOperations
Clear
ClearAndMakeExplicit
Create
CreateExplicit
GetAddedOrExplicitItems
HasItem
Attributes:
addedItems
appendedItems
deletedItems
explicitItems
isExplicit
orderedItems
prependedItems
ApplyOperations()
Clear()
ClearAndMakeExplicit()
static Create()
static CreateExplicit()
GetAddedOrExplicitItems()
HasItem()
property addedItems
property appendedItems
property deletedItems
property explicitItems
property isExplicit
property orderedItems
property prependedItems
class pxr.Sdf.UnregisteredValue
Stores a representation of the value for an unregistered metadata
field encountered during text layer parsing.
This provides the ability to serialize this data to a layer, as well
as limited inspection and editing capabilities (e.g., moving this data
to a different spec or field) even when the data type of the value
isn’t known.
Attributes:
value
VtValue
property value
VtValue
Returns the wrapped VtValue specified in the constructor.
Type
type
class pxr.Sdf.UnregisteredValueListOp
Methods:
ApplyOperations
Clear
ClearAndMakeExplicit
Create
CreateExplicit
GetAddedOrExplicitItems
HasItem
Attributes:
addedItems
appendedItems
deletedItems
explicitItems
isExplicit
orderedItems
prependedItems
ApplyOperations()
Clear()
ClearAndMakeExplicit()
static Create()
static CreateExplicit()
GetAddedOrExplicitItems()
HasItem()
property addedItems
property appendedItems
property deletedItems
property explicitItems
property isExplicit
property orderedItems
property prependedItems
class pxr.Sdf.ValueBlock
A special value type that can be used to explicitly author an opinion
for an attribute’s default value or time sample value that represents
having no value. Note that this is different from not having a value
authored.
One could author such a value in two ways.
attribute->SetDefaultValue(VtValue(SdfValueBlock());
\.\.\.
layer->SetTimeSample(attribute->GetPath(), 101, VtValue(SdfValueBlock()));
class pxr.Sdf.ValueRoleNames
Attributes:
Color
EdgeIndex
FaceIndex
Frame
Normal
Point
PointIndex
TextureCoordinate
Transform
Vector
Color = 'Color'
EdgeIndex = 'EdgeIndex'
FaceIndex = 'FaceIndex'
Frame = 'Frame'
Normal = 'Normal'
Point = 'Point'
PointIndex = 'PointIndex'
TextureCoordinate = 'TextureCoordinate'
Transform = 'Transform'
Vector = 'Vector'
class pxr.Sdf.ValueTypeName
Represents a value type name, i.e. an attribute’s type name. Usually,
a value type name associates a string with a TfType and an
optional role, along with additional metadata. A schema registers all
known value type names and may register multiple names for the same
TfType and role pair. All name strings for a given pair are
collectively called its aliases.
A value type name may also represent just a name string, without a
TfType , role or other metadata. This is currently used
exclusively to unserialize and re-serialize an attribute’s type name
where that name is not known to the schema.
Because value type names can have aliases and those aliases may change
in the future, clients should avoid using the value type name’s string
representation except to report human readable messages and when
serializing. Clients can look up a value type name by string using
SdfSchemaBase::FindType() and shouldn’t otherwise need the string.
Aliases compare equal, even if registered by different schemas.
Attributes:
aliasesAsStrings
arrayType
ValueTypeName
cppTypeName
defaultUnit
Enum
defaultValue
VtValue
isArray
bool
isScalar
bool
role
str
scalarType
ValueTypeName
type
Type
property aliasesAsStrings
property arrayType
ValueTypeName
Returns the array version of this type name if it’s an scalar type
name, otherwise returns this type name.
If there is no array type name then this returns the invalid type
name.
Type
type
property cppTypeName
property defaultUnit
Enum
Returns the default unit enum for the type.
Type
type
property defaultValue
VtValue
Returns the default value for the type.
Type
type
property isArray
bool
Returns true iff this type is an array.
The invalid type is considered neither scalar nor array.
Type
type
property isScalar
bool
Returns true iff this type is a scalar.
The invalid type is considered neither scalar nor array.
Type
type
property role
str
Returns the type’s role.
Type
type
property scalarType
ValueTypeName
Returns the scalar version of this type name if it’s an array type
name, otherwise returns this type name.
If there is no scalar type name then this returns the invalid type
name.
Type
type
property type
Type
Returns the TfType of the type.
Type
type
class pxr.Sdf.ValueTypeNames
Methods:
Find
Attributes:
Asset
AssetArray
Bool
BoolArray
Color3d
Color3dArray
Color3f
Color3fArray
Color3h
Color3hArray
Color4d
Color4dArray
Color4f
Color4fArray
Color4h
Color4hArray
Double
Double2
Double2Array
Double3
Double3Array
Double4
Double4Array
DoubleArray
Float
Float2
Float2Array
Float3
Float3Array
Float4
Float4Array
FloatArray
Frame4d
Frame4dArray
Half
Half2
Half2Array
Half3
Half3Array
Half4
Half4Array
HalfArray
Int
Int2
Int2Array
Int3
Int3Array
Int4
Int4Array
Int64
Int64Array
IntArray
Matrix2d
Matrix2dArray
Matrix3d
Matrix3dArray
Matrix4d
Matrix4dArray
Normal3d
Normal3dArray
Normal3f
Normal3fArray
Normal3h
Normal3hArray
Point3d
Point3dArray
Point3f
Point3fArray
Point3h
Point3hArray
Quatd
QuatdArray
Quatf
QuatfArray
Quath
QuathArray
String
StringArray
TexCoord2d
TexCoord2dArray
TexCoord2f
TexCoord2fArray
TexCoord2h
TexCoord2hArray
TexCoord3d
TexCoord3dArray
TexCoord3f
TexCoord3fArray
TexCoord3h
TexCoord3hArray
TimeCode
TimeCodeArray
Token
TokenArray
UChar
UCharArray
UInt
UInt64
UInt64Array
UIntArray
Vector3d
Vector3dArray
Vector3f
Vector3fArray
Vector3h
Vector3hArray
static Find()
Asset = <pxr.Sdf.ValueTypeName object>
AssetArray = <pxr.Sdf.ValueTypeName object>
Bool = <pxr.Sdf.ValueTypeName object>
BoolArray = <pxr.Sdf.ValueTypeName object>
Color3d = <pxr.Sdf.ValueTypeName object>
Color3dArray = <pxr.Sdf.ValueTypeName object>
Color3f = <pxr.Sdf.ValueTypeName object>
Color3fArray = <pxr.Sdf.ValueTypeName object>
Color3h = <pxr.Sdf.ValueTypeName object>
Color3hArray = <pxr.Sdf.ValueTypeName object>
Color4d = <pxr.Sdf.ValueTypeName object>
Color4dArray = <pxr.Sdf.ValueTypeName object>
Color4f = <pxr.Sdf.ValueTypeName object>
Color4fArray = <pxr.Sdf.ValueTypeName object>
Color4h = <pxr.Sdf.ValueTypeName object>
Color4hArray = <pxr.Sdf.ValueTypeName object>
Double = <pxr.Sdf.ValueTypeName object>
Double2 = <pxr.Sdf.ValueTypeName object>
Double2Array = <pxr.Sdf.ValueTypeName object>
Double3 = <pxr.Sdf.ValueTypeName object>
Double3Array = <pxr.Sdf.ValueTypeName object>
Double4 = <pxr.Sdf.ValueTypeName object>
Double4Array = <pxr.Sdf.ValueTypeName object>
DoubleArray = <pxr.Sdf.ValueTypeName object>
Float = <pxr.Sdf.ValueTypeName object>
Float2 = <pxr.Sdf.ValueTypeName object>
Float2Array = <pxr.Sdf.ValueTypeName object>
Float3 = <pxr.Sdf.ValueTypeName object>
Float3Array = <pxr.Sdf.ValueTypeName object>
Float4 = <pxr.Sdf.ValueTypeName object>
Float4Array = <pxr.Sdf.ValueTypeName object>
FloatArray = <pxr.Sdf.ValueTypeName object>
Frame4d = <pxr.Sdf.ValueTypeName object>
Frame4dArray = <pxr.Sdf.ValueTypeName object>
Half = <pxr.Sdf.ValueTypeName object>
Half2 = <pxr.Sdf.ValueTypeName object>
Half2Array = <pxr.Sdf.ValueTypeName object>
Half3 = <pxr.Sdf.ValueTypeName object>
Half3Array = <pxr.Sdf.ValueTypeName object>
Half4 = <pxr.Sdf.ValueTypeName object>
Half4Array = <pxr.Sdf.ValueTypeName object>
HalfArray = <pxr.Sdf.ValueTypeName object>
Int = <pxr.Sdf.ValueTypeName object>
Int2 = <pxr.Sdf.ValueTypeName object>
Int2Array = <pxr.Sdf.ValueTypeName object>
Int3 = <pxr.Sdf.ValueTypeName object>
Int3Array = <pxr.Sdf.ValueTypeName object>
Int4 = <pxr.Sdf.ValueTypeName object>
Int4Array = <pxr.Sdf.ValueTypeName object>
Int64 = <pxr.Sdf.ValueTypeName object>
Int64Array = <pxr.Sdf.ValueTypeName object>
IntArray = <pxr.Sdf.ValueTypeName object>
Matrix2d = <pxr.Sdf.ValueTypeName object>
Matrix2dArray = <pxr.Sdf.ValueTypeName object>
Matrix3d = <pxr.Sdf.ValueTypeName object>
Matrix3dArray = <pxr.Sdf.ValueTypeName object>
Matrix4d = <pxr.Sdf.ValueTypeName object>
Matrix4dArray = <pxr.Sdf.ValueTypeName object>
Normal3d = <pxr.Sdf.ValueTypeName object>
Normal3dArray = <pxr.Sdf.ValueTypeName object>
Normal3f = <pxr.Sdf.ValueTypeName object>
Normal3fArray = <pxr.Sdf.ValueTypeName object>
Normal3h = <pxr.Sdf.ValueTypeName object>
Normal3hArray = <pxr.Sdf.ValueTypeName object>
Point3d = <pxr.Sdf.ValueTypeName object>
Point3dArray = <pxr.Sdf.ValueTypeName object>
Point3f = <pxr.Sdf.ValueTypeName object>
Point3fArray = <pxr.Sdf.ValueTypeName object>
Point3h = <pxr.Sdf.ValueTypeName object>
Point3hArray = <pxr.Sdf.ValueTypeName object>
Quatd = <pxr.Sdf.ValueTypeName object>
QuatdArray = <pxr.Sdf.ValueTypeName object>
Quatf = <pxr.Sdf.ValueTypeName object>
QuatfArray = <pxr.Sdf.ValueTypeName object>
Quath = <pxr.Sdf.ValueTypeName object>
QuathArray = <pxr.Sdf.ValueTypeName object>
String = <pxr.Sdf.ValueTypeName object>
StringArray = <pxr.Sdf.ValueTypeName object>
TexCoord2d = <pxr.Sdf.ValueTypeName object>
TexCoord2dArray = <pxr.Sdf.ValueTypeName object>
TexCoord2f = <pxr.Sdf.ValueTypeName object>
TexCoord2fArray = <pxr.Sdf.ValueTypeName object>
TexCoord2h = <pxr.Sdf.ValueTypeName object>
TexCoord2hArray = <pxr.Sdf.ValueTypeName object>
TexCoord3d = <pxr.Sdf.ValueTypeName object>
TexCoord3dArray = <pxr.Sdf.ValueTypeName object>
TexCoord3f = <pxr.Sdf.ValueTypeName object>
TexCoord3fArray = <pxr.Sdf.ValueTypeName object>
TexCoord3h = <pxr.Sdf.ValueTypeName object>
TexCoord3hArray = <pxr.Sdf.ValueTypeName object>
TimeCode = <pxr.Sdf.ValueTypeName object>
TimeCodeArray = <pxr.Sdf.ValueTypeName object>
Token = <pxr.Sdf.ValueTypeName object>
TokenArray = <pxr.Sdf.ValueTypeName object>
UChar = <pxr.Sdf.ValueTypeName object>
UCharArray = <pxr.Sdf.ValueTypeName object>
UInt = <pxr.Sdf.ValueTypeName object>
UInt64 = <pxr.Sdf.ValueTypeName object>
UInt64Array = <pxr.Sdf.ValueTypeName object>
UIntArray = <pxr.Sdf.ValueTypeName object>
Vector3d = <pxr.Sdf.ValueTypeName object>
Vector3dArray = <pxr.Sdf.ValueTypeName object>
Vector3f = <pxr.Sdf.ValueTypeName object>
Vector3fArray = <pxr.Sdf.ValueTypeName object>
Vector3h = <pxr.Sdf.ValueTypeName object>
Vector3hArray = <pxr.Sdf.ValueTypeName object>
class pxr.Sdf.Variability
Methods:
GetValueFromName
Attributes:
allValues
static GetValueFromName()
allValues = (Sdf.VariabilityVarying, Sdf.VariabilityUniform)
class pxr.Sdf.VariantSetSpec
Represents a coherent set of alternate representations for part of a
scene.
An SdfPrimSpec object may contain one or more named SdfVariantSetSpec
objects that define variations on the prim.
An SdfVariantSetSpec object contains one or more named SdfVariantSpec
objects. It may also define the name of one of its variants to be used
by default.
When a prim references another prim, the referencing prim may specify
one of the variants from each of the variant sets of the target prim.
The chosen variant from each set (or the default variant from those
sets that the referencing prim does not explicitly specify) is
composited over the target prim, and then the referencing prim is
composited over the result.
Methods:
RemoveVariant(variant)
Removes variant from the list of variants.
Attributes:
expired
name
The variant set's name.
owner
The prim that this variant set belongs to.
variantList
The variants in this variant set as a list.
variants
The variants in this variant set as a dict.
RemoveVariant(variant) → None
Removes variant from the list of variants.
If the variant set does not currently own variant , no action is
taken.
Parameters
variant (VariantSpec) –
property expired
property name
The variant set’s name.
property owner
The prim that this variant set belongs to.
property variantList
The variants in this variant set as a list.
property variants
The variants in this variant set as a dict.
class pxr.Sdf.VariantSpec
Represents a single variant in a variant set.
A variant contains a prim. This prim is the root prim of the variant.
SdfVariantSpecs are value objects. This means they are immutable once
created and they are passed by copy-in APIs. To change a variant spec,
you make a new one and replace the existing one.
Methods:
GetVariantNames(name)
Returns list of variant names for the given variant set.
Attributes:
expired
name
The variant's name.
owner
The variant set that this variant belongs to.
primSpec
The root prim of this variant.
variantSets
SdfVariantSetsProxy
GetVariantNames(name) → list[str]
Returns list of variant names for the given variant set.
Parameters
name (str) –
property expired
property name
The variant’s name.
property owner
The variant set that this variant belongs to.
property primSpec
The root prim of this variant.
property variantSets
SdfVariantSetsProxy
Returns the nested variant sets.
The result maps variant set names to variant sets. Variant sets may be
removed through the proxy.
Type
type
pxr.Sdf.Find(layerFileName, scenePath) → object
layerFileName: string
scenePath: Path
If given a single string argument, returns the menv layer with
the given filename. If given two arguments (a string and a Path), finds
the menv layer with the given filename and returns the scene object
within it at the given path.
© Copyright 2019-2023, NVIDIA.
Last updated on Nov 14, 2023. |
omni.ui.IwpFillPolicy.md | IwpFillPolicy — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
IwpFillPolicy
# IwpFillPolicy
class omni.ui.IwpFillPolicy
Bases: pybind11_object
Members:
IWP_STRETCH
IWP_PRESERVE_ASPECT_FIT
IWP_PRESERVE_ASPECT_CROP
Methods
__init__(self, value)
Attributes
IWP_PRESERVE_ASPECT_CROP
IWP_PRESERVE_ASPECT_FIT
IWP_STRETCH
name
value
__init__(self: omni.ui._ui.IwpFillPolicy, value: int) → None
property name
© Copyright 2019-2024, NVIDIA.
Last updated on Mar 25, 2024. |
Garch.md | Garch module — pxr-usd-api 105.1 documentation
pxr-usd-api
»
Modules »
Garch module
# Garch module
Summary: GL Architecture
garch
Classes:
GLPlatformDebugContext
Platform specific context (e.g.
class pxr.Garch.GLPlatformDebugContext
Platform specific context (e.g. X11/GLX) which supports debug output.
Methods:
makeCurrent()
Attributes:
expired
True if this object has expired, False otherwise.
makeCurrent() → None
property expired
True if this object has expired, False otherwise.
© Copyright 2019-2023, NVIDIA.
Last updated on Nov 14, 2023. |
omni.ui.TreeView.md | TreeView — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
TreeView
# TreeView
class omni.ui.TreeView
Bases: Widget, ItemModelHelper
TreeView is a widget that presents a hierarchical view of information. Each item can have a number of subitems. An indentation often visualizes this in a list. An item can be expanded to reveal subitems, if any exist, and collapsed to hide subitems.
TreeView can be used in file manager applications, where it allows the user to navigate the file system directories. They are also used to present hierarchical data, such as the scene object hierarchy.
TreeView uses a model/view pattern to manage the relationship between data and the way it is presented. The separation of functionality gives developers greater flexibility to customize the presentation of items and provides a standard interface to allow a wide range of data sources to be used with other widgets.
TreeView is responsible for the presentation of model data to the user and processing user input. To allow some flexibility in the way the data is presented, the creation of the sub-widgets is performed by the delegate. It provides the ability to customize any sub-item of TreeView.
Methods
__init__(*args, **kwargs)
Overloaded function.
call_hover_changed_fn(self, arg0, arg1)
Set the callback that is called when the item hover status is changed.
call_selection_changed_fn(self, arg0)
Set the callback that is called when the selection is changed.
clear_selection(self)
Deselects all selected items.
dirty_widgets(self)
When called, it will make the delegate to regenerate all visible widgets the next frame.
extend_selection(self, item)
Extends the current selection selecting all the items between currently selected nodes and the given item.
has_hover_changed_fn(self)
Set the callback that is called when the item hover status is changed.
has_selection_changed_fn(self)
Set the callback that is called when the selection is changed.
is_expanded(self, item)
Returns true if the given item is expanded.
set_expanded(self, item, expanded, recursive)
Sets the given item expanded or collapsed.
set_hover_changed_fn(self, fn)
Set the callback that is called when the item hover status is changed.
set_selection_changed_fn(self, fn)
Set the callback that is called when the selection is changed.
toggle_selection(self, item)
Switches the selection state of the given item.
Attributes
column_widths
Widths of the columns.
columns_resizable
When true, the columns can be resized with the mouse.
drop_between_items
When true, the tree nodes can be dropped between items.
expand_on_branch_click
This flag allows to prevent expanding when the user clicks the plus icon.
header_visible
This property holds if the header is shown or not.
keep_alive
When true, the tree nodes are never destroyed even if they are disappeared from the model.
keep_expanded
Expand all the nodes and keep them expanded regardless their state.
min_column_widths
Minimum widths of the columns.
root_expanded
The expanded state of the root item.
root_visible
This property holds if the root is shown.
selection
Set current selection.
__init__(*args, **kwargs)
Overloaded function.
__init__(self: omni.ui._ui.TreeView, **kwargs) -> None
Create TreeView with default model.
__init__(self: omni.ui._ui.TreeView, arg0: omni.ui._ui.AbstractItemModel, **kwargs) -> None
Create TreeView with the given model.
### Arguments:
`model :`The given model.
`kwargsdict`See below
### Keyword Arguments:
`delegate`The Item delegate that generates a widget per item.
`header_visible`This property holds if the header is shown or not.
`selection`Set current selection.
`expand_on_branch_click`This flag allows to prevent expanding when the user clicks the plus icon. It’s used in the case the user wants to control how the items expanded or collapsed.
`keep_alive`When true, the tree nodes are never destroyed even if they are disappeared from the model. It’s useul for the temporary filtering if it’s necessary to display thousands of nodes.
`keep_expanded`Expand all the nodes and keep them expanded regardless their state.
`drop_between_items`When true, the tree nodes can be dropped between items.
`column_widths`Widths of the columns. If not set, the width is Fraction(1).
`min_column_widths`Minimum widths of the columns. If not set, the width is Pixel(0).
`columns_resizable`When true, the columns can be resized with the mouse.
`selection_changed_fn`Set the callback that is called when the selection is changed.
`root_expanded`The expanded state of the root item. Changing this flag doesn’t make the children repopulated.
`widthui.Length`This property holds the width of the widget relative to its parent. Do not use this function to find the width of a screen.
`heightui.Length`This property holds the height of the widget relative to its parent. Do not use this function to find the height of a screen.
`namestr`The name of the widget that user can set.
`style_type_name_overridestr`By default, we use typeName to look up the style. But sometimes it’s necessary to use a custom name. For example, when a widget is a part of another widget. (Label is a part of Button) This property can override the name to use in style.
`identifierstr`An optional identifier of the widget we can use to refer to it in queries.
`visiblebool`This property holds whether the widget is visible.
`visibleMinfloat`If the current zoom factor and DPI is less than this value, the widget is not visible.
`visibleMaxfloat`If the current zoom factor and DPI is bigger than this value, the widget is not visible.
`tooltipstr`Set a basic tooltip for the widget, this will simply be a Label, it will follow the Tooltip style
`tooltip_fnCallable`Set dynamic tooltip that will be created dynamiclly the first time it is needed. the function is called inside a ui.Frame scope that the widget will be parented correctly.
`tooltip_offset_xfloat`Set the X tooltip offset in points. In a normal state, the tooltip position is linked to the mouse position. If the tooltip offset is non zero, the top left corner of the tooltip is linked to the top left corner of the widget, and this property defines the relative position the tooltip should be shown.
`tooltip_offset_yfloat`Set the Y tooltip offset in points. In a normal state, the tooltip position is linked to the mouse position. If the tooltip offset is non zero, the top left corner of the tooltip is linked to the top left corner of the widget, and this property defines the relative position the tooltip should be shown.
`enabledbool`This property holds whether the widget is enabled. In general an enabled widget handles keyboard and mouse events; a disabled widget does not. And widgets display themselves differently when they are disabled.
`selectedbool`This property holds a flag that specifies the widget has to use eSelected state of the style.
`checkedbool`This property holds a flag that specifies the widget has to use eChecked state of the style. It’s on the Widget level because the button can have sub-widgets that are also should be checked.
`draggingbool`This property holds if the widget is being dragged.
`opaque_for_mouse_eventsbool`If the widgets has callback functions it will by default not capture the events if it is the top most widget and setup this option to true, so they don’t get routed to the child widgets either
`skip_draw_when_clippedbool`The flag that specifies if it’s necessary to bypass the whole draw cycle if the bounding box is clipped with a scrolling frame. It’s needed to avoid the limitation of 65535 primitives in a single draw list.
`mouse_moved_fnCallable`Sets the function that will be called when the user moves the mouse inside the widget. Mouse move events only occur if a mouse button is pressed while the mouse is being moved. void onMouseMoved(float x, float y, int32_t modifier)
`mouse_pressed_fnCallable`Sets the function that will be called when the user presses the mouse button inside the widget. The function should be like this: void onMousePressed(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier) Where ‘button’ is the number of the mouse button pressed. ‘modifier’ is the flag for the keyboard modifier key.
`mouse_released_fnCallable`Sets the function that will be called when the user releases the mouse button if this button was pressed inside the widget. void onMouseReleased(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)
`mouse_double_clicked_fnCallable`Sets the function that will be called when the user presses the mouse button twice inside the widget. The function specification is the same as in setMousePressedFn. void onMouseDoubleClicked(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)
`mouse_wheel_fnCallable`Sets the function that will be called when the user uses mouse wheel on the focused window. The function specification is the same as in setMousePressedFn. void onMouseWheel(float x, float y, carb::input::KeyboardModifierFlags modifier)
`mouse_hovered_fnCallable`Sets the function that will be called when the user use mouse enter/leave on the focused window. function specification is the same as in setMouseHovedFn. void onMouseHovered(bool hovered)
`drag_fnCallable`Specify that this Widget is draggable, and set the callback that is attached to the drag operation.
`accept_drop_fnCallable`Specify that this Widget can accept specific drops and set the callback that is called to check if the drop can be accepted.
`drop_fnCallable`Specify that this Widget accepts drops and set the callback to the drop operation.
`computed_content_size_changed_fnCallable`Called when the size of the widget is changed.
call_hover_changed_fn(self: omni.ui._ui.TreeView, arg0: omni.ui._ui.AbstractItem, arg1: bool) → None
Set the callback that is called when the item hover status is changed.
call_selection_changed_fn(self: omni.ui._ui.TreeView, arg0: List[omni.ui._ui.AbstractItem]) → None
Set the callback that is called when the selection is changed.
clear_selection(self: omni.ui._ui.TreeView) → None
Deselects all selected items.
dirty_widgets(self: omni.ui._ui.TreeView) → None
When called, it will make the delegate to regenerate all visible widgets the next frame.
extend_selection(self: omni.ui._ui.TreeView, item: omni.ui._ui.AbstractItem) → None
Extends the current selection selecting all the items between currently selected nodes and the given item. It’s when user does shift+click.
has_hover_changed_fn(self: omni.ui._ui.TreeView) → bool
Set the callback that is called when the item hover status is changed.
has_selection_changed_fn(self: omni.ui._ui.TreeView) → bool
Set the callback that is called when the selection is changed.
is_expanded(self: omni.ui._ui.TreeView, item: omni.ui._ui.AbstractItem) → bool
Returns true if the given item is expanded.
set_expanded(self: omni.ui._ui.TreeView, item: omni.ui._ui.AbstractItem, expanded: bool, recursive: bool) → None
Sets the given item expanded or collapsed.
### Arguments:
`item :`The item to expand or collapse.
`expanded :`True if it’s necessary to expand, false to collapse.
`recursive :`True if it’s necessary to expand children.
set_hover_changed_fn(self: omni.ui._ui.TreeView, fn: Callable[[omni.ui._ui.AbstractItem, bool], None]) → None
Set the callback that is called when the item hover status is changed.
set_selection_changed_fn(self: omni.ui._ui.TreeView, fn: Callable[[List[omni.ui._ui.AbstractItem]], None]) → None
Set the callback that is called when the selection is changed.
toggle_selection(self: omni.ui._ui.TreeView, item: omni.ui._ui.AbstractItem) → None
Switches the selection state of the given item.
property column_widths
Widths of the columns. If not set, the width is Fraction(1).
property columns_resizable
When true, the columns can be resized with the mouse.
property drop_between_items
When true, the tree nodes can be dropped between items.
property expand_on_branch_click
This flag allows to prevent expanding when the user clicks the plus icon. It’s used in the case the user wants to control how the items expanded or collapsed.
property header_visible
This property holds if the header is shown or not.
property keep_alive
When true, the tree nodes are never destroyed even if they are disappeared from the model. It’s useul for the temporary filtering if it’s necessary to display thousands of nodes.
property keep_expanded
Expand all the nodes and keep them expanded regardless their state.
property min_column_widths
Minimum widths of the columns. If not set, the width is Pixel(0).
property root_expanded
The expanded state of the root item. Changing this flag doesn’t make the children repopulated.
property root_visible
This property holds if the root is shown. It can be used to make a single level tree appear like a simple list.
property selection
Set current selection.
© Copyright 2019-2024, NVIDIA.
Last updated on Mar 25, 2024. |
omni.ui.FreeEllipse.md | FreeEllipse — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
FreeEllipse
# FreeEllipse
class omni.ui.FreeEllipse
Bases: Ellipse
The Ellipse widget provides a colored ellipse to display.
The free widget is the widget that is independent of the layout. It means it is stuck to other widgets. When initializing, it’s necessary to provide two widgets, and the shape is drawn from one widget position to the another.
Methods
__init__(self, arg0, arg1, **kwargs)
Initialize the shape with bounds limited to the positions of the given widgets.
Attributes
__init__(self: omni.ui._ui.FreeEllipse, arg0: omni.ui._ui.Widget, arg1: omni.ui._ui.Widget, **kwargs) → None
Initialize the shape with bounds limited to the positions of the given widgets.
### Arguments:
`start :`The bound corner is in the center of this given widget.
`end :`The bound corner is in the center of this given widget.
`kwargsdict`See below
### Keyword Arguments:
`widthui.Length`This property holds the width of the widget relative to its parent. Do not use this function to find the width of a screen.
`heightui.Length`This property holds the height of the widget relative to its parent. Do not use this function to find the height of a screen.
`namestr`The name of the widget that user can set.
`style_type_name_overridestr`By default, we use typeName to look up the style. But sometimes it’s necessary to use a custom name. For example, when a widget is a part of another widget. (Label is a part of Button) This property can override the name to use in style.
`identifierstr`An optional identifier of the widget we can use to refer to it in queries.
`visiblebool`This property holds whether the widget is visible.
`visibleMinfloat`If the current zoom factor and DPI is less than this value, the widget is not visible.
`visibleMaxfloat`If the current zoom factor and DPI is bigger than this value, the widget is not visible.
`tooltipstr`Set a basic tooltip for the widget, this will simply be a Label, it will follow the Tooltip style
`tooltip_fnCallable`Set dynamic tooltip that will be created dynamiclly the first time it is needed. the function is called inside a ui.Frame scope that the widget will be parented correctly.
`tooltip_offset_xfloat`Set the X tooltip offset in points. In a normal state, the tooltip position is linked to the mouse position. If the tooltip offset is non zero, the top left corner of the tooltip is linked to the top left corner of the widget, and this property defines the relative position the tooltip should be shown.
`tooltip_offset_yfloat`Set the Y tooltip offset in points. In a normal state, the tooltip position is linked to the mouse position. If the tooltip offset is non zero, the top left corner of the tooltip is linked to the top left corner of the widget, and this property defines the relative position the tooltip should be shown.
`enabledbool`This property holds whether the widget is enabled. In general an enabled widget handles keyboard and mouse events; a disabled widget does not. And widgets display themselves differently when they are disabled.
`selectedbool`This property holds a flag that specifies the widget has to use eSelected state of the style.
`checkedbool`This property holds a flag that specifies the widget has to use eChecked state of the style. It’s on the Widget level because the button can have sub-widgets that are also should be checked.
`draggingbool`This property holds if the widget is being dragged.
`opaque_for_mouse_eventsbool`If the widgets has callback functions it will by default not capture the events if it is the top most widget and setup this option to true, so they don’t get routed to the child widgets either
`skip_draw_when_clippedbool`The flag that specifies if it’s necessary to bypass the whole draw cycle if the bounding box is clipped with a scrolling frame. It’s needed to avoid the limitation of 65535 primitives in a single draw list.
`mouse_moved_fnCallable`Sets the function that will be called when the user moves the mouse inside the widget. Mouse move events only occur if a mouse button is pressed while the mouse is being moved. void onMouseMoved(float x, float y, int32_t modifier)
`mouse_pressed_fnCallable`Sets the function that will be called when the user presses the mouse button inside the widget. The function should be like this: void onMousePressed(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier) Where ‘button’ is the number of the mouse button pressed. ‘modifier’ is the flag for the keyboard modifier key.
`mouse_released_fnCallable`Sets the function that will be called when the user releases the mouse button if this button was pressed inside the widget. void onMouseReleased(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)
`mouse_double_clicked_fnCallable`Sets the function that will be called when the user presses the mouse button twice inside the widget. The function specification is the same as in setMousePressedFn. void onMouseDoubleClicked(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)
`mouse_wheel_fnCallable`Sets the function that will be called when the user uses mouse wheel on the focused window. The function specification is the same as in setMousePressedFn. void onMouseWheel(float x, float y, carb::input::KeyboardModifierFlags modifier)
`mouse_hovered_fnCallable`Sets the function that will be called when the user use mouse enter/leave on the focused window. function specification is the same as in setMouseHovedFn. void onMouseHovered(bool hovered)
`drag_fnCallable`Specify that this Widget is draggable, and set the callback that is attached to the drag operation.
`accept_drop_fnCallable`Specify that this Widget can accept specific drops and set the callback that is called to check if the drop can be accepted.
`drop_fnCallable`Specify that this Widget accepts drops and set the callback to the drop operation.
`computed_content_size_changed_fnCallable`Called when the size of the widget is changed.
© Copyright 2019-2024, NVIDIA.
Last updated on Mar 25, 2024. |
omni.ui.workspace_utils.dump_workspace.md | dump_workspace — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Submodules »
omni.ui.workspace_utils »
omni.ui.workspace_utils Functions »
dump_workspace
# dump_workspace
omni.ui.workspace_utils.dump_workspace()
Capture current workspace and return the dict with the description of the
docking state and window size.
© Copyright 2019-2024, NVIDIA.
Last updated on Mar 25, 2024. |
omni.ui.ToolBar.md | ToolBar — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
ToolBar
# ToolBar
class omni.ui.ToolBar
Bases: Window
The ToolBar class represents a window in the underlying windowing system that as some fixed size property.
Methods
__init__(self, title, **kwargs)
Construct ToolBar.
set_axis_changed_fn(self, arg0)
Attributes
axis
__init__(self: omni.ui._ui.ToolBar, title: str, **kwargs) → None
Construct ToolBar.
`kwargsdict`See below
### Keyword Arguments:
`axisui.Axis`@breif axis for the toolbar
`axis_changed_fnCallable[[ui.Axis], None]`@breif axis for the toolbar
`flags`This property set the Flags for the Window.
`visible`This property holds whether the window is visible.
`title`This property holds the window’s title.
`padding_x`This property set the padding to the frame on the X axis.
`padding_y`This property set the padding to the frame on the Y axis.
`width`This property holds the window Width.
`height`This property holds the window Height.
`position_x`This property set/get the position of the window in the X Axis. The default is kWindowFloatInvalid because we send the window position to the underlying system only if the position is explicitly set by the user. Otherwise the underlying system decides the position.
`position_y`This property set/get the position of the window in the Y Axis. The default is kWindowFloatInvalid because we send the window position to the underlying system only if the position is explicitly set by the user. Otherwise the underlying system decides the position.
`auto_resize`setup the window to resize automatically based on its content
`noTabBar`setup the visibility of the TabBar Handle, this is the small triangle at the corner of the view If it is not shown then it is not possible to undock that window and it need to be closed/moved programatically
`tabBarTooltip`This property sets the tooltip when hovering over window’s tabbar.
`raster_policy`Determine how the content of the window should be rastered.
`width_changed_fn`This property holds the window Width.
`height_changed_fn`This property holds the window Height.
`visibility_changed_fn`This property holds whether the window is visible.
set_axis_changed_fn(self: omni.ui._ui.ToolBar, arg0: Callable[[omni.ui._ui.ToolBarAxis], None]) → None
© Copyright 2019-2024, NVIDIA.
Last updated on Mar 25, 2024. |
planning.md | Planning Your Installation — Omniverse Launcher latest documentation
Omniverse Launcher
»
Omniverse Launcher »
Installation Guide »
Planning Your Installation
# Planning Your Installation
Whether you are looking for a way to install a single Omniverse foundation application for a user to test, or want to deploy an entire suite of Omniverse apps and content for your internal users to work and collaborate with, you should review and plan accordingly based on the requirements and options below to ensure your internal infrastructure is at the desired level of readiness.
## System Requirements
Ensure you have identified at least one computer with the ability to connect to the Internet to download the various installation files, applications and content archives from NVIDIA servers. All of these files are available for both Windows and Linux operating systems (except for the Enterprise Nucleus Server, which is only available for Linux via Docker) and it is up to you to determine which operating systems your users’ workstations need to be supported.
Confirm that you have hardware within your company firewall with ample disk space (100-500GB) where you can “stage” many of these downloaded files so they can be accessed as part of the installation or deployment process.
If you don’t have connected staging hardware that is accessible by users’ workstations (they are completely isolated from a network and Internet connections), you should have some form of portable media device (100-500GB) to manually move the downloaded files from one location to another.
Make sure to update the OS systems that will be utilized and installed upon (ie. Windows Update, etc.) so they are up to date
Verify that all orchestrations (if needed) have the correct versions in support of Omniverse deployed GPUs etc.
## Configuration Options
Ensure evaluation of Omniverse application and configuration needs for each internal customer group.
Create a topology of how Omniverse on internal customer systems (virtual or local) are connected to each other, Nucleus Server / Workstation, etc.
You can learn about Reference Architectures here.
You can learn about Virtualized Topologies here.
Omniverse currently does not support LDAP however, services like Microsoft InTune may be used to support hybrid and remote teams with disparate resources.
## Omniverse Readiness
Review and identify all internal customer requirements starting from application resource needs (Omniverse + other installed applications) working your way through to confirming your network, servers, and workstations meet these requirements for the collective requirements in deployment.
Pre-check that available Omniverse installation software are the correct versions required.
Ensure required Omniverse quantities of licensing are secured.
Download all necessary files from the Omniverse Enterprise Web Portal and transfer them to an easily accessible local networked system that will act as a staging area.
Ensure all necessary ports that need to be open for Omniverse applications to communicate with each other are configured properly.
## Permissions
Ensure that all extensions are downloaded/staged into IT managed public folders such as D:/omniverse/data. IT organizations tend to lock down non-user folders (anything sans %USER_ROOT%) will want to ensure that they have installed “all required” files in the read-only areas for workstation users.
As a first step, you must install the IT Managed Launcher to your users’ workstations.
© Copyright 2023-2024, NVIDIA.
Last updated on Apr 15, 2024. |
install_guide_win.md | Installation on Windows — Omniverse Launcher latest documentation
Omniverse Launcher
»
Omniverse Launcher »
Installation Guide »
Installation on Windows
# Installation on Windows
## Prerequisites for Installation
There are two elements that you need to have prior to starting the installation process. Both components are available within the NVIDIA Licensing Portal (NLP).
It’s important to note that the entitlements themselves are provided to the person at the company who makes the purchase, and that person can add others (including the IT Managers) to the Licensing Portal so that they can grab the components listed below. You can read more about this process as part of our Enterprise Quick Start Guide.
Download the IT Managed Launcher Installer.
(.exe) Executable since you’re running Windows.
Your Organization Name Identifier (org-name).
To find the IT Managed Launcher executable on the NLP:
Once you’ve logged into the Portal, go to the Software Downloads section (left nav) and look for the NVIDIA Omniverse IT Managed Launcher for your platform of choice (Windows in this case).
Click Download to initiate the download process of the installer.
Note
Once the installer is downloaded, you should place it onto your designated staging hardware inside of your company firewall.
Next you’ll grab your Organization’s Name Identifier (org-name).
To do this, at the top of the portal, hover your mouse over your user account until you see a View Settings message pop up. (See image below)
Within the resulting My Info dialog, under the Organization area, you will see an org-name section. The information that is presented there represents your Organization Name and will be required later.
View Settings:
Be sure to capture this information before you begin the installation process. You will need it to install the IT Managed Launcher as well as configure your enterprise enablement.
Organization Name
Once you have this information, it’s time to install the IT Managed Launcher.
There are two ways to install the IT Managed Launcher on Windows:
Manually: You can install the Launcher manually on a user’s workstation directly (e.g. using CMD or PowerShell).
Deployment: You can pre-configure the Launcher to be installed as part of a deployment software strategy (e.g. SCCM / Group Policy)
We will cover both options below.
## PowerShell
### Deploying Launcher
Run the IT Managed Launcher installer you downloaded from the Licensing Portal locally on a user’s workstation. This can be done in the UI by double-clicking omniverse-launcher-win-enterprise.exe or via the PowerShell terminal, by typing: ./omniverse-launcher-win-enterprise.exe
Follow the prompts until the installer finishes. At the end of the install process, the option to immediately run the IT Managed Launcher will be checked by default.
Leave that option checked, then click Finish to finish the install process.
Note
You can install the IT Managed Launcher silently by adding the /S parameter to the end of the filename. Example: ./omniverse-launcher-win-enterprise.exe /S
Note
You can install the IT Managed Launcher to a specific location by adding the /D parameter to the end of the filename. Example: ./omniverse-launcher-win-enterprise.exe /S /D="C:\Program Files\NVIDIA Corporation\NVIDIA Omniverse Launcher"
### Setting Up TOML Files
( Learn more about TOML syntax: https://toml.io/en/ )
1) When the IT Managed Launcher first opens, you’ll immediately be prompted to set a number of default locations for Omniverse data. These paths determine where Omniverse will place the installed applications (Library Path), data files (Data Path), content files (Content Path) and Cache information.
All of the paths set here will be recorded and stored within an omniverse.toml file for later editing as needed. It’s important to note that all of the paths set here can be changed as per preference and IT Policy at a later time. By default, the installer takes all of these path preferences and stores them in the omniverse.toml under the following folder structure:
c:\Users\[username]\.nvidia-omniverse\config
Where [username] represents the local user’s account.
2) Once you’ve set the default paths for Omniverse to use, click on the Continue Button.
You should now be presented with a blank Library window inside of the launcher.
3) Close the IT Managed Launcher.
At this point, the IT Managed Launcher is installed. However, before you start to install Omniverse applications, you’ll need to add two additional, important configuration files.
When you look at the default configuration location in Windows (c:\Users\[username]\.nvidia-omniverse\config), you should see the omniverse.toml file that the installer added as shown below.
This omniverse.toml file is the primary configuration file for the IT Managed Launcher. Within this configuration file, the following paths are described, and they should match the selections you made in step 1. Be aware that you can set these after the installation to different paths as needed for security policy at any time.
[paths]
library_root = "C:\\Omniverse\\library" # Path where to install all Omniverse applications
data_root = "C:\\Omniverse\\data" # Folder where Launcher and Omniverse apps store their data files
cache_root = "C:\\Omniverse\\cache" # Folder where Omniverse apps store their cache and temporary files
logs_root = "C:\\Users\\[username]\\.nvidia-omniverse\\logs" # Folder where Launcher and Omniverse apps store their logs
content_root = “C:\\Users\\[username]\\Downloads” # Folder where Launcher saves downloaded content packs
extension_root = “C:\\Users\\[username]\\Documents\\kit\\shared\\exts” # Folder where all Omniverse shared extensions are stored
confirmed = true # Confirmation that all paths are set correctly, must be set to `true`
Important
Also be aware that all paths on Windows require a double backslash (\) for proper operation.
Note
If a system administrator doesn’t want to allow users to change these paths, the omniverse.toml file can be marked as read-only. Also, if a System Administrator plans to install the IT Managed Launcher to a shared location like Program Files on Windows, they need to specify a shared folder for library_root and logs_root path in omniverse.toml file.
You’re now going to add two additional files to this /config folder in addition to the omniverse.toml file.
privacy.toml file to record consent choices for data collection and capture of crash logs.
license.toml to provide your license details.
Note
When creating or editing these configuration files, use a text editor such as Windows Notepad. Do not use a rich-text editor such as Wordpad or Microsoft Word.
Important
By opting into telemetry within the privacy.toml, you can help improve the performance & stability of the software. For more details on what data is collected and how it is processed see this section.
4) Within the /config folder, create a text file named privacy.toml. This is the configuration file for Omniverse telemetry. Within this privacy file, copy the following information:
[privacy]
performance = true
personalization = true
usage = true
Once this file contains these four lines, save the file.
Note
If your IT or Security Policy prohibits the collection of telemetry on a user’s workstation, set all of the values in the file to false.
5) For the last file needed in your /config folder, create a text file named license.toml This is the licensing configuration file for Omniverse. Within this licensing file, specify the Organization Name Identifier (org-name) you retrieved from the Licensing Portal in the prerequisites section:
[ovlicense]
org-name = "<insert-your-org-name-here>"
Once this file contains these two lines, save the file.
Once you’ve completed these steps, your /.nvidia-omniverse/config folder should have the directory and required .toml files like the screenshot below:
That completes the IT Managed Launcher manual installation for Windows and Omniverse applications can now be installed to users’ workstations.
### Setting Up Packages
Once the Omniverse IT Managed Launcher is installed and configured, you’re ready to install the Omniverse foundation applications for your users.
As an IT Manager, you now need to download the various Omniverse foundation applications from the Omniverse Enterprise Web Portal. Each application will come in the form of an archived .zip file that you can take to a user’s machine and install either manually, or via your internal deployment framework.
1) To begin, log into the Omniverse Enterprise Web Portal.
2) In the left-hand navigation area, select Apps, and from the resulting view, click on the tile of the Omniverse foundation application you want to install.
3) Available releases are categorized by release channel. A release is classified as Beta, Release, or Enterprise, depending on its maturity and stability.
Beta
Beta builds may or may not be feature complete or fully stable. These are good for testing new Omniverse functionality, but aren’t guaranteed to be ready for production.
Release
Release builds (also known as GA or General Availability) are feature complete and stable builds ready for production.
Enterprise
Enterprise builds are provided for Enterprise customers and represent supported production versions of Omniverse software.
4) Select a package version in the dropdown list and click Download.
5) Clicking the download button will prompt you to select the Windows or Linux version of the application to install. Choose the OS version that matches the user’s workstation.
6) Once downloaded, the application archive must then be transferred to the user’s machine or hosted on your chosen local network staging hardware so it can be accessed and installed on a user’s workstation.
Once you’ve downloaded the various Omniverse foundation applications, you are ready to proceed to the installation.
### Deploying the Apps
The most basic way to install Omniverse foundation applications is to open a custom protocol URL directly on the user’s machine. The simple command below will trigger the IT Managed Launcher to run the installation routine for the given Omniverse application .zip archive.
The format of the custom protocol can vary depending on the command line interface used, but as a general rule of thumb, the settings are as follows:
omniverse-launcher://install?path=<package.zip>
Where <package.zip> represents the name and path where the downloaded application archive is on the local workstation. Be aware that it does not matter where you place the archive, the custom protocol will install the application to its default location based on the library_root path in the omniverse.toml file that you configured earlier as part of the IT Managed Launcher installation process.
Example: start omniverse-launcher://install?path=C:/temp/usd_explorer.zip
Example: start omniverse-launcher://install?path=//Mainframe/temp/usd_explorer.zip
When the command is run, it will trigger the IT Managed Launcher to open and it will begin the installation process. You should see a screen similar to the one below that shows the progress bar for the application being installed in the upper right of the Launcher window.
Once the installation is complete, the Omniverse application will appear in the Library section of the Launcher window and these steps can be repeated for any additional applications you want to make available to your users.
## SCCM
To deploy the IT Managed Launcher executable file to users’ Windows workstations you will need to perform several tasks.
You’ll need to download and stage the IT Managed Launcher .EXE file to a shared network location inside your firewall that all of the users’ workstations can see and access.
Next, you’ll create and pre-configure a user’s omniverse.toml, policy.toml and license.toml files and stage them in the same shared network location.
After that, you’ll create a .bat file to control the installation process and reference .toml files you’ve set up.
Finally, you’ll configure another .bat file within the Windows Local Group Policy to execute at user logon to trigger the installation and configuration of the IT Managed Launcher for the user on their local workstation.
As per the prerequisite section of this document, you should have already downloaded the Windows version of the IT Managed Launcher install file from the Enterprise Web Portal. If not, please do that first.
### Setting up TOML Files
(Learn more about TOML syntax: https://toml.io/en/)
The first step is to create and stage the three .toml files for deployment.
omniverse.toml: Copy the following information into a new text document, replacing the path information with the location you want Omniverse and its data installed on each user’s workstation. Once done, save it to the staging location.
[paths]
library_root = "C:\\Omniverse\\library" # Path where to install all Omniverse applications
data_root = "C:\\Omniverse\\data" # Folder where Launcher and Omniverse apps store their data files
cache_root = "C:\\Omniverse\\cache" # Folder where Omniverse apps store their cache and temporary files
logs_root = "C:\\Users\\[username]\\.nvidia-omniverse\\logs" # Folder where Launcher and Omniverse apps store their logs
content_root = "C:\\Users\\[username]\\Downloads" # Folder where Launcher saves downloaded content packs
extension_root = "C:\\Users\\[username]\\Documents\\kit\\shared\\exts" # Folder where all Omniverse shared extensions are stored
confirmed = true # Confirmation that all paths are set correctly, must be set to `true`
Path
Description
library_root = “C:\Omniverse\library”
Path where to install all Omniverse applications
data_root = “C:\Omniverse\data”
Folder where Launcher and Omniverse apps store their data files
cache_root = “C:\Omniverse\cache”
Folder where Omniverse apps store their cache and temporary files
logs_root = “C:\Users\[username]\.nvidia-omniverse\logs”
Folder where Launcher and Omniverse apps store their logs
content_root = “C:\Users\[username]\Downloads”
Folder where Launcher saves downloaded content packs
extension_root = “C:\Users\[username]\Documents\kit\shared\exts”
Folder where all Omniverse shared extensions are stored
confirmed = true
Confirmation that all paths are set correctly, must be set to true
Important
Also be aware that all paths on Windows require a double backslash (\) for proper operation.
privacy.toml: Copy the following information into a new text document. This is the configuration file for Omniverse telemetry capture for each user’s workstation. Once done, save it to the staging location.
[privacy]
performance = true
personalization = true
usage = true
Note
If your Security Policy prohibits the collection of telemetry on a user’s workstation, set all of the values in the file to false.
license.toml: This is the licensing configuration file for Omniverse. Within this licensing file, specify the Organization Name Identifier (org-name) you retrieved from the Licensing Portal in the prerequisites section. Once done, save it to the staging location.
[ovlicense]
org-name = "<insert-your-org-name-here>"
Once you’ve saved all three .toml files, it’s time to build a .bat file that will be used to help deploy the files to each user’s workstation.
### Deploying Launcher
1) Create a new .bat file (you can name the file as needed, e.g. deployment-omniverse.bat). In that batch file, add the following information:
@echo off
SETLOCAL EnableDelayedExpansion
set CONFIG_PATH=%USERPROFILE%\.nvidia-omniverse\config\
set INSTALL_PATH=%ProgramFiles%\NVIDIA Corporation\NVIDIA Omniverse Launcher\
set SCRIPT_PATH=%~dp0
set REG_QUERY=Reg Query "HKLM\Software\Microsoft\Windows\CurrentVersion\Uninstall\ddd216ee-cf6c-55b0-9ca8-733b2ef622a0" /v "DisplayName"
:CONFIGURATION
:: Test for existing omniverse.toml config file.
if exist "%CONFIG_PATH%\omniverse.toml" GOTO INSTALLLAUNCHER
:: Copy.toml files to user's configuration.
xcopy /y "%SCRIPT_PATH%\omniverse.toml" "%CONFIG_PATH%"
xcopy /y "%SCRIPT_PATH%\privacy.toml" "%CONFIG_PATH%"
xcopy /y "%SCRIPT_PATH%\license.toml" "%CONFIG_PATH%"
:: Substitute [username] with %USERNAME%.
del "%CONFIG_PATH%\omniverse.txt" 2>NUL
for /f "usebackq tokens=*" %%a in ("%CONFIG_PATH%\omniverse.toml") do (
set LINE=%%a
set LINE=!LINE:[username]=%USERNAME%!
echo !LINE! >> "%CONFIG_PATH%\omniverse.txt"
)
del "%CONFIG_PATH%\omniverse.toml" 2>NUL
ren "%CONFIG_PATH%\omniverse.txt" "omniverse.toml"
:: Set the readonly flag to prevent users from changing the configured paths
attrib +r "%CONFIG_PATH%"\*.toml
:INSTALLLAUNCHER
:: Test if Launcher is already installed.
%REG_QUERY% 1>NUL 2>&1
if %ERRORLEVEL%==0 GOTO STARTLAUNCHER
:: Run the installer and wait until Launcher is installed (silent).
start /WAIT %SCRIPT_PATH%\omniverse-launcher-win-enterprise.exe /S /D="%INSTALL_PATH%"
:STARTLAUNCHER
:: Start the Launcher.
start "" "%INSTALL_PATH%\NVIDIA Omniverse Launcher.exe"
timeout /T 5 1>NUL 2>&1
:END
ENDLOCAL
The .bat script above copies the .toml files and installs Launcher.
All files must be located in the root directory of the script. (.toml / omniverse-launcher-win-enterprise.exe).
Install into a public folder, example C:NVIDIA.
2) Save this file to the same location as the pre-configured .toml files on the staging hardware.
In order to run the .bat file as part of a deployment strategy, you need to set up a local group policy for your users’ workstations.
3) Open the Local Group Policy Editor on the GPO manager machine.
4) Double-click to choose Logon.
5) From the Logon Properties dialog, choose Add.
6) Then point to the .bat file you created earlier and click OK.
The file should appear in the Logon Properties dialog.
7) Click OK to close the dialog
8) The scripts will run on the remote machines during the next Logon.
### Setting Up Packages
Once the Omniverse IT Managed Launcher is installed and configured, you’re ready to install the Omniverse foundation applications for your users.
As an IT Manager, you now need to download the various Omniverse foundation applications from the Omniverse Enterprise Web Portal. Each application will come in the form of an archived .zip file that you can take to a user’s machine and install either manually, or via your internal deployment framework.
1) To begin, log into the Omniverse Enterprise Web Portal.
2) In the left-hand navigation area, select Apps, and from the resulting view, click on the tile of the Omniverse foundation application you want to install.
Available releases are categorized by release channel. A release is classified as Beta, Release, or Enterprise, depending on its maturity and stability.
Beta
Beta builds may or may not be feature complete or fully stable. These are good for testing new Omniverse functionality, but aren’t guaranteed to be ready for production.
Release
Release builds (also known as GA or General Availability) are feature complete and stable builds ready for production.
Enterprise
Enterprise builds are provided for Enterprise customers and represent supported production versions of Omniverse software.
3) Select a package version in the dropdown list and click Download.
4) Clicking the download button will prompt you to select the Windows or Linux version of the application to install. Choose the OS version that matches the user’s workstation.
5) Once downloaded, the application archive must then be transferred to the user’s machine or hosted on your chosen local network staging hardware so it can be accessed and installed on a user’s workstation.
Once you’ve downloaded the various Omniverse foundation applications, you are ready to proceed to the installation.
### Deploying the Apps
To deploy the Omniverse Applications to users’ Windows workstations you will need to perform several tasks.
You’ll need to download and stage the Omniverse Application .zip archive files you want to deploy to a shared network location inside your firewall that all of the users’ workstations can see and access.
After that, you’ll create a .bat file to control the installation process that you’ve downloaded.
Finally, you’ll configure another .bat file within the Windows Local Group Policy to execute at user logon to trigger the installation and configuration of the Omniverse Applications for the user on their local workstation.
As per the prerequisite section of this document, you should have already downloaded the Windows .zip archive files for each Omniverse Application you want to deploy from the Enterprise Web Portal. If not, please do that first.
The next step is to create the .bat file that will handle the installation process on the local user’s workstation.
1) Create a new .bat file for the app installation (you can name the file as needed, e.g. deploy_OV<AppName>.bat). In that batch file, add the following information:
@echo off
SETLOCAL EnableDelayedExpansion
set CONFIG_PATH=%USERPROFILE%\.nvidia-omniverse\config\
set SCRIPT_PATH=%~dp0
:INSTALLAPPS
:: Find library_root from omniverse.toml
for /f "usebackq tokens=*" %%a in ("%CONFIG_PATH%\omniverse.toml") do (
set LINE=%%a
echo !LINE!|find "library_root" 1>NUL 2>&1
if !ERRORLEVEL!==0 (
for /f tokens^=^2^ delims^=^" %%i in ("!LINE!") do set LIBRARY_ROOT_PATH=%%i
set LIBRARY_ROOT_PATH=!LIBRARY_ROOT_PATH:\\=\!
)
)
:: Find .zip files
for /f "tokens=*" %%a in ('dir /B "%SCRIPT_PATH%\*.zip"') do (
set ZIP_FILE=%%a
set ZIP_FILE_SUB=!ZIP_FILE:.windows-x86_64-ent-package.zip=!
:: Check if ZIP_FILE_SUB is a folder in LIBRARY_ROOT_PATH. If not, install.
dir /B "!LIBRARY_ROOT_PATH!"| findstr "!ZIP_FILE_SUB!" 1>NUL 2>&1
if !ERRORLEVEL!==1 (
start omniverse-launcher://install?path="%SCRIPT_PATH%\!ZIP_FILE!"
timeout /T 600 1>NUL 2>&1
)
)
:END
ENDLOCAL
You are welcome to string together as many of the Custom Protocol Commands as needed to cover all of the Omniverse Applications you want to install.
Note
You can also choose to add this information to the existing .bat file that was used to install the IT Managed Launcher.
The .bat script above installs the Apps from a .zip
All files must be located in the root directory of the script. ( “App”.zip).
Install into the same directory that launcher was previously installed.
2) Save this .bat file to the staging hardware.
In order to run the .bat file as part of a deployment strategy, you need to get up a local group policy for your users’ workstations.
3) Open the Local Group Policy Editor on the GPO manager machine.
4) Double-click to choose Logon.
5) From the Logon Properties dialog, choose Add.
6) Then point to the .bat file you created earlier and click OK.
The file should appear in the Logon Properties dialog.
7) Click OK to close the dialog
8) The scripts will run on the remote machines during the next Logon.
© Copyright 2023-2024, NVIDIA.
Last updated on Apr 15, 2024. |
UsdUI.md | UsdUI module — pxr-usd-api 105.1 documentation
pxr-usd-api
»
Modules »
UsdUI module
# UsdUI module
Summary: The UsdUI module provides schemas for encoding information on USD prims for client GUI tools to use in organizing/presenting prims in GUI layouts.
Classes:
Backdrop
Provides a'group-box'for the purpose of node graph organization.
NodeGraphNodeAPI
This api helps storing information about nodes in node graphs.
SceneGraphPrimAPI
Utility schema for display properties of a prim
Tokens
class pxr.UsdUI.Backdrop
Provides a’group-box’for the purpose of node graph organization.
Unlike containers, backdrops do not store the Shader nodes inside of
them. Backdrops are an organizational tool that allows Shader nodes to
be visually grouped together in a node-graph UI, but there is no
direct relationship between a Shader node and a Backdrop.
The guideline for a node-graph UI is that a Shader node is considered
part of a Backdrop when the Backdrop is the smallest Backdrop a Shader
node’s bounding-box fits inside.
Backdrop objects are contained inside a NodeGraph, similar to how
Shader objects are contained inside a NodeGraph.
Backdrops have no shading inputs or outputs that influence the
rendered results of a NodeGraph. Therefore they can be safely ignored
during import.
Like Shaders and NodeGraphs, Backdrops subscribe to the
NodeGraphNodeAPI to specify position and size.
For any described attribute Fallback Value or Allowed Values
below that are text/tokens, the actual token is published and defined
in UsdUITokens. So to set an attribute to the value”rightHanded”, use
UsdUITokens->rightHanded as the value.
Methods:
CreateDescriptionAttr(defaultValue, ...)
See GetDescriptionAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
Define
classmethod Define(stage, path) -> Backdrop
Get
classmethod Get(stage, path) -> Backdrop
GetDescriptionAttr()
The text label that is displayed on the backdrop in the node graph.
GetSchemaAttributeNames
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
CreateDescriptionAttr(defaultValue, writeSparsely) → Attribute
See GetDescriptionAttr() , and also Create vs Get Property Methods for
when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
static Define()
classmethod Define(stage, path) -> Backdrop
Attempt to ensure a UsdPrim adhering to this schema at path is
defined (according to UsdPrim::IsDefined() ) on this stage.
If a prim adhering to this schema at path is already defined on
this stage, return that prim. Otherwise author an SdfPrimSpec with
specifier == SdfSpecifierDef and this schema’s prim type name for
the prim at path at the current EditTarget. Author SdfPrimSpec s
with specifier == SdfSpecifierDef and empty typeName at the
current EditTarget for any nonexistent, or existing but not Defined
ancestors.
The given path must be an absolute prim path that does not contain
any variant selections.
If it is impossible to author any of the necessary PrimSpecs, (for
example, in case path cannot map to the current UsdEditTarget ‘s
namespace) issue an error and return an invalid UsdPrim.
Note that this method may return a defined prim whose typeName does
not specify this schema class, in case a stronger typeName opinion
overrides the opinion at the current EditTarget.
Parameters
stage (Stage) –
path (Path) –
static Get()
classmethod Get(stage, path) -> Backdrop
Return a UsdUIBackdrop holding the prim adhering to this schema at
path on stage .
If no prim exists at path on stage , or if the prim at that
path does not adhere to this schema, return an invalid schema object.
This is shorthand for the following:
UsdUIBackdrop(stage->GetPrimAtPath(path));
Parameters
stage (Stage) –
path (Path) –
GetDescriptionAttr() → Attribute
The text label that is displayed on the backdrop in the node graph.
This help-description explains what the nodes in a backdrop do.
Declaration
uniform token ui:description
C++ Type
TfToken
Usd Type
SdfValueTypeNames->Token
Variability
SdfVariabilityUniform
static GetSchemaAttributeNames()
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
Return a vector of names of all pre-declared attributes for this
schema class and all its ancestor classes.
Does not include attributes that may be authored by custom/extended
methods of the schemas involved.
Parameters
includeInherited (bool) –
class pxr.UsdUI.NodeGraphNodeAPI
This api helps storing information about nodes in node graphs.
For any described attribute Fallback Value or Allowed Values
below that are text/tokens, the actual token is published and defined
in UsdUITokens. So to set an attribute to the value”rightHanded”, use
UsdUITokens->rightHanded as the value.
Methods:
Apply
classmethod Apply(prim) -> NodeGraphNodeAPI
CanApply
classmethod CanApply(prim, whyNot) -> bool
CreateDisplayColorAttr(defaultValue, ...)
See GetDisplayColorAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateExpansionStateAttr(defaultValue, ...)
See GetExpansionStateAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateIconAttr(defaultValue, writeSparsely)
See GetIconAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreatePosAttr(defaultValue, writeSparsely)
See GetPosAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateSizeAttr(defaultValue, writeSparsely)
See GetSizeAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateStackingOrderAttr(defaultValue, ...)
See GetStackingOrderAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
Get
classmethod Get(stage, path) -> NodeGraphNodeAPI
GetDisplayColorAttr()
This hint defines what tint the node should have in the node graph.
GetExpansionStateAttr()
The current expansionState of the node in the ui.
GetIconAttr()
This points to an image that should be displayed on the node.
GetPosAttr()
Declared relative position to the parent in a node graph.
GetSchemaAttributeNames
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
GetSizeAttr()
Optional size hint for a node in a node graph.
GetStackingOrderAttr()
This optional value is a useful hint when an application cares about the visibility of a node and whether each node overlaps another.
static Apply()
classmethod Apply(prim) -> NodeGraphNodeAPI
Applies this single-apply API schema to the given prim .
This information is stored by adding”NodeGraphNodeAPI”to the token-
valued, listOp metadata apiSchemas on the prim.
A valid UsdUINodeGraphNodeAPI object is returned upon success. An
invalid (or empty) UsdUINodeGraphNodeAPI object is returned upon
failure. See UsdPrim::ApplyAPI() for conditions resulting in failure.
UsdPrim::GetAppliedSchemas()
UsdPrim::HasAPI()
UsdPrim::CanApplyAPI()
UsdPrim::ApplyAPI()
UsdPrim::RemoveAPI()
Parameters
prim (Prim) –
static CanApply()
classmethod CanApply(prim, whyNot) -> bool
Returns true if this single-apply API schema can be applied to the
given prim .
If this schema can not be a applied to the prim, this returns false
and, if provided, populates whyNot with the reason it can not be
applied.
Note that if CanApply returns false, that does not necessarily imply
that calling Apply will fail. Callers are expected to call CanApply
before calling Apply if they want to ensure that it is valid to apply
a schema.
UsdPrim::GetAppliedSchemas()
UsdPrim::HasAPI()
UsdPrim::CanApplyAPI()
UsdPrim::ApplyAPI()
UsdPrim::RemoveAPI()
Parameters
prim (Prim) –
whyNot (str) –
CreateDisplayColorAttr(defaultValue, writeSparsely) → Attribute
See GetDisplayColorAttr() , and also Create vs Get Property Methods
for when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateExpansionStateAttr(defaultValue, writeSparsely) → Attribute
See GetExpansionStateAttr() , and also Create vs Get Property Methods
for when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateIconAttr(defaultValue, writeSparsely) → Attribute
See GetIconAttr() , and also Create vs Get Property Methods for when
to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreatePosAttr(defaultValue, writeSparsely) → Attribute
See GetPosAttr() , and also Create vs Get Property Methods for when to
use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateSizeAttr(defaultValue, writeSparsely) → Attribute
See GetSizeAttr() , and also Create vs Get Property Methods for when
to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateStackingOrderAttr(defaultValue, writeSparsely) → Attribute
See GetStackingOrderAttr() , and also Create vs Get Property Methods
for when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
static Get()
classmethod Get(stage, path) -> NodeGraphNodeAPI
Return a UsdUINodeGraphNodeAPI holding the prim adhering to this
schema at path on stage .
If no prim exists at path on stage , or if the prim at that
path does not adhere to this schema, return an invalid schema object.
This is shorthand for the following:
UsdUINodeGraphNodeAPI(stage->GetPrimAtPath(path));
Parameters
stage (Stage) –
path (Path) –
GetDisplayColorAttr() → Attribute
This hint defines what tint the node should have in the node graph.
Declaration
uniform color3f ui:nodegraph:node:displayColor
C++ Type
GfVec3f
Usd Type
SdfValueTypeNames->Color3f
Variability
SdfVariabilityUniform
GetExpansionStateAttr() → Attribute
The current expansionState of the node in the ui.
‘open’= fully expanded’closed’= fully collapsed’minimized’= should
take the least space possible
Declaration
uniform token ui:nodegraph:node:expansionState
C++ Type
TfToken
Usd Type
SdfValueTypeNames->Token
Variability
SdfVariabilityUniform
Allowed Values
open, closed, minimized
GetIconAttr() → Attribute
This points to an image that should be displayed on the node.
It is intended to be useful for summary visual classification of
nodes, rather than a thumbnail preview of the computed result of the
node in some computational system.
Declaration
uniform asset ui:nodegraph:node:icon
C++ Type
SdfAssetPath
Usd Type
SdfValueTypeNames->Asset
Variability
SdfVariabilityUniform
GetPosAttr() → Attribute
Declared relative position to the parent in a node graph.
X is the horizontal position. Y is the vertical position. Higher
numbers correspond to lower positions (coordinates are Qt style, not
cartesian).
These positions are not explicitly meant in pixel space, but rather
assume that the size of a node is approximately 1.0x1.0. Where size-x
is the node width and size-y height of the node. Depending on graph UI
implementation, the size of a node may vary in each direction.
Example: If a node’s width is 300 and it is position is at 1000, we
store for x-position: 1000 * (1.0/300)
Declaration
uniform float2 ui:nodegraph:node:pos
C++ Type
GfVec2f
Usd Type
SdfValueTypeNames->Float2
Variability
SdfVariabilityUniform
static GetSchemaAttributeNames()
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
Return a vector of names of all pre-declared attributes for this
schema class and all its ancestor classes.
Does not include attributes that may be authored by custom/extended
methods of the schemas involved.
Parameters
includeInherited (bool) –
GetSizeAttr() → Attribute
Optional size hint for a node in a node graph.
X is the width. Y is the height.
This value is optional, because node size is often determined based on
the number of in- and outputs of a node.
Declaration
uniform float2 ui:nodegraph:node:size
C++ Type
GfVec2f
Usd Type
SdfValueTypeNames->Float2
Variability
SdfVariabilityUniform
GetStackingOrderAttr() → Attribute
This optional value is a useful hint when an application cares about
the visibility of a node and whether each node overlaps another.
Nodes with lower stacking order values are meant to be drawn below
higher ones. Negative values are meant as background. Positive values
are meant as foreground. Undefined values should be treated as 0.
There are no set limits in these values.
Declaration
uniform int ui:nodegraph:node:stackingOrder
C++ Type
int
Usd Type
SdfValueTypeNames->Int
Variability
SdfVariabilityUniform
class pxr.UsdUI.SceneGraphPrimAPI
Utility schema for display properties of a prim
For any described attribute Fallback Value or Allowed Values
below that are text/tokens, the actual token is published and defined
in UsdUITokens. So to set an attribute to the value”rightHanded”, use
UsdUITokens->rightHanded as the value.
Methods:
Apply
classmethod Apply(prim) -> SceneGraphPrimAPI
CanApply
classmethod CanApply(prim, whyNot) -> bool
CreateDisplayGroupAttr(defaultValue, ...)
See GetDisplayGroupAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateDisplayNameAttr(defaultValue, ...)
See GetDisplayNameAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
Get
classmethod Get(stage, path) -> SceneGraphPrimAPI
GetDisplayGroupAttr()
When publishing a nodegraph or a material, it can be useful to provide an optional display group, for organizational purposes and readability.
GetDisplayNameAttr()
When publishing a nodegraph or a material, it can be useful to provide an optional display name, for readability.
GetSchemaAttributeNames
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
static Apply()
classmethod Apply(prim) -> SceneGraphPrimAPI
Applies this single-apply API schema to the given prim .
This information is stored by adding”SceneGraphPrimAPI”to the token-
valued, listOp metadata apiSchemas on the prim.
A valid UsdUISceneGraphPrimAPI object is returned upon success. An
invalid (or empty) UsdUISceneGraphPrimAPI object is returned upon
failure. See UsdPrim::ApplyAPI() for conditions resulting in failure.
UsdPrim::GetAppliedSchemas()
UsdPrim::HasAPI()
UsdPrim::CanApplyAPI()
UsdPrim::ApplyAPI()
UsdPrim::RemoveAPI()
Parameters
prim (Prim) –
static CanApply()
classmethod CanApply(prim, whyNot) -> bool
Returns true if this single-apply API schema can be applied to the
given prim .
If this schema can not be a applied to the prim, this returns false
and, if provided, populates whyNot with the reason it can not be
applied.
Note that if CanApply returns false, that does not necessarily imply
that calling Apply will fail. Callers are expected to call CanApply
before calling Apply if they want to ensure that it is valid to apply
a schema.
UsdPrim::GetAppliedSchemas()
UsdPrim::HasAPI()
UsdPrim::CanApplyAPI()
UsdPrim::ApplyAPI()
UsdPrim::RemoveAPI()
Parameters
prim (Prim) –
whyNot (str) –
CreateDisplayGroupAttr(defaultValue, writeSparsely) → Attribute
See GetDisplayGroupAttr() , and also Create vs Get Property Methods
for when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateDisplayNameAttr(defaultValue, writeSparsely) → Attribute
See GetDisplayNameAttr() , and also Create vs Get Property Methods for
when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
static Get()
classmethod Get(stage, path) -> SceneGraphPrimAPI
Return a UsdUISceneGraphPrimAPI holding the prim adhering to this
schema at path on stage .
If no prim exists at path on stage , or if the prim at that
path does not adhere to this schema, return an invalid schema object.
This is shorthand for the following:
UsdUISceneGraphPrimAPI(stage->GetPrimAtPath(path));
Parameters
stage (Stage) –
path (Path) –
GetDisplayGroupAttr() → Attribute
When publishing a nodegraph or a material, it can be useful to provide
an optional display group, for organizational purposes and
readability.
This is because often the usd shading hierarchy is rather flat while
we want to display it in organized groups.
Declaration
uniform token ui:displayGroup
C++ Type
TfToken
Usd Type
SdfValueTypeNames->Token
Variability
SdfVariabilityUniform
GetDisplayNameAttr() → Attribute
When publishing a nodegraph or a material, it can be useful to provide
an optional display name, for readability.
Declaration
uniform token ui:displayName
C++ Type
TfToken
Usd Type
SdfValueTypeNames->Token
Variability
SdfVariabilityUniform
static GetSchemaAttributeNames()
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
Return a vector of names of all pre-declared attributes for this
schema class and all its ancestor classes.
Does not include attributes that may be authored by custom/extended
methods of the schemas involved.
Parameters
includeInherited (bool) –
class pxr.UsdUI.Tokens
Attributes:
closed
minimized
open
uiDescription
uiDisplayGroup
uiDisplayName
uiNodegraphNodeDisplayColor
uiNodegraphNodeExpansionState
uiNodegraphNodeIcon
uiNodegraphNodePos
uiNodegraphNodeSize
uiNodegraphNodeStackingOrder
closed = 'closed'
minimized = 'minimized'
open = 'open'
uiDescription = 'ui:description'
uiDisplayGroup = 'ui:displayGroup'
uiDisplayName = 'ui:displayName'
uiNodegraphNodeDisplayColor = 'ui:nodegraph:node:displayColor'
uiNodegraphNodeExpansionState = 'ui:nodegraph:node:expansionState'
uiNodegraphNodeIcon = 'ui:nodegraph:node:icon'
uiNodegraphNodePos = 'ui:nodegraph:node:pos'
uiNodegraphNodeSize = 'ui:nodegraph:node:size'
uiNodegraphNodeStackingOrder = 'ui:nodegraph:node:stackingOrder'
© Copyright 2019-2023, NVIDIA.
Last updated on Nov 14, 2023. |
omni.ui.UIntSlider.md | UIntSlider — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
UIntSlider
# UIntSlider
class omni.ui.UIntSlider
Bases: AbstractSlider
The slider is the classic widget for controlling a bounded value. It lets the user move a slider handle along a horizontal groove and translates the handle’s position into an integer value within the legal range.
The difference with IntSlider is that UIntSlider has unsigned min/max.
Methods
__init__(self[, model])
Constructs UIntSlider.
Attributes
max
This property holds the slider's maximum value.
min
This property holds the slider's minimum value.
__init__(self: omni.ui._ui.UIntSlider, model: omni.ui._ui.AbstractValueModel = None, **kwargs) → None
Constructs UIntSlider.
### Arguments:
`model :`The widget’s model. If the model is not assigned, the default model is created.
`kwargsdict`See below
### Keyword Arguments:
`min`This property holds the slider’s minimum value.
`max`This property holds the slider’s maximum value.
`widthui.Length`This property holds the width of the widget relative to its parent. Do not use this function to find the width of a screen.
`heightui.Length`This property holds the height of the widget relative to its parent. Do not use this function to find the height of a screen.
`namestr`The name of the widget that user can set.
`style_type_name_overridestr`By default, we use typeName to look up the style. But sometimes it’s necessary to use a custom name. For example, when a widget is a part of another widget. (Label is a part of Button) This property can override the name to use in style.
`identifierstr`An optional identifier of the widget we can use to refer to it in queries.
`visiblebool`This property holds whether the widget is visible.
`visibleMinfloat`If the current zoom factor and DPI is less than this value, the widget is not visible.
`visibleMaxfloat`If the current zoom factor and DPI is bigger than this value, the widget is not visible.
`tooltipstr`Set a basic tooltip for the widget, this will simply be a Label, it will follow the Tooltip style
`tooltip_fnCallable`Set dynamic tooltip that will be created dynamiclly the first time it is needed. the function is called inside a ui.Frame scope that the widget will be parented correctly.
`tooltip_offset_xfloat`Set the X tooltip offset in points. In a normal state, the tooltip position is linked to the mouse position. If the tooltip offset is non zero, the top left corner of the tooltip is linked to the top left corner of the widget, and this property defines the relative position the tooltip should be shown.
`tooltip_offset_yfloat`Set the Y tooltip offset in points. In a normal state, the tooltip position is linked to the mouse position. If the tooltip offset is non zero, the top left corner of the tooltip is linked to the top left corner of the widget, and this property defines the relative position the tooltip should be shown.
`enabledbool`This property holds whether the widget is enabled. In general an enabled widget handles keyboard and mouse events; a disabled widget does not. And widgets display themselves differently when they are disabled.
`selectedbool`This property holds a flag that specifies the widget has to use eSelected state of the style.
`checkedbool`This property holds a flag that specifies the widget has to use eChecked state of the style. It’s on the Widget level because the button can have sub-widgets that are also should be checked.
`draggingbool`This property holds if the widget is being dragged.
`opaque_for_mouse_eventsbool`If the widgets has callback functions it will by default not capture the events if it is the top most widget and setup this option to true, so they don’t get routed to the child widgets either
`skip_draw_when_clippedbool`The flag that specifies if it’s necessary to bypass the whole draw cycle if the bounding box is clipped with a scrolling frame. It’s needed to avoid the limitation of 65535 primitives in a single draw list.
`mouse_moved_fnCallable`Sets the function that will be called when the user moves the mouse inside the widget. Mouse move events only occur if a mouse button is pressed while the mouse is being moved. void onMouseMoved(float x, float y, int32_t modifier)
`mouse_pressed_fnCallable`Sets the function that will be called when the user presses the mouse button inside the widget. The function should be like this: void onMousePressed(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier) Where ‘button’ is the number of the mouse button pressed. ‘modifier’ is the flag for the keyboard modifier key.
`mouse_released_fnCallable`Sets the function that will be called when the user releases the mouse button if this button was pressed inside the widget. void onMouseReleased(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)
`mouse_double_clicked_fnCallable`Sets the function that will be called when the user presses the mouse button twice inside the widget. The function specification is the same as in setMousePressedFn. void onMouseDoubleClicked(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)
`mouse_wheel_fnCallable`Sets the function that will be called when the user uses mouse wheel on the focused window. The function specification is the same as in setMousePressedFn. void onMouseWheel(float x, float y, carb::input::KeyboardModifierFlags modifier)
`mouse_hovered_fnCallable`Sets the function that will be called when the user use mouse enter/leave on the focused window. function specification is the same as in setMouseHovedFn. void onMouseHovered(bool hovered)
`drag_fnCallable`Specify that this Widget is draggable, and set the callback that is attached to the drag operation.
`accept_drop_fnCallable`Specify that this Widget can accept specific drops and set the callback that is called to check if the drop can be accepted.
`drop_fnCallable`Specify that this Widget accepts drops and set the callback to the drop operation.
`computed_content_size_changed_fnCallable`Called when the size of the widget is changed.
property max
This property holds the slider’s maximum value.
property min
This property holds the slider’s minimum value.
© Copyright 2019-2024, NVIDIA.
Last updated on Mar 25, 2024. |
omni.ui.IntDrag.md | IntDrag — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
IntDrag
# IntDrag
class omni.ui.IntDrag
Bases: IntSlider
The drag widget that looks like a field but it’s possible to change the value with dragging.
Methods
__init__(self[, model])
Constructs IntDrag.
Attributes
step
This property controls the steping speed on the drag, its float to enable slower speed, but of course the value on the Control are still integer.
__init__(self: omni.ui._ui.IntDrag, model: omni.ui._ui.AbstractValueModel = None, **kwargs) → None
Constructs IntDrag.
### Arguments:
`model :`The widget’s model. If the model is not assigned, the default model is created.
`kwargsdict`See below
### Keyword Arguments:
`step`This property controls the steping speed on the drag, its float to enable slower speed, but of course the value on the Control are still integer.
`min`This property holds the slider’s minimum value.
`max`This property holds the slider’s maximum value.
`widthui.Length`This property holds the width of the widget relative to its parent. Do not use this function to find the width of a screen.
`heightui.Length`This property holds the height of the widget relative to its parent. Do not use this function to find the height of a screen.
`namestr`The name of the widget that user can set.
`style_type_name_overridestr`By default, we use typeName to look up the style. But sometimes it’s necessary to use a custom name. For example, when a widget is a part of another widget. (Label is a part of Button) This property can override the name to use in style.
`identifierstr`An optional identifier of the widget we can use to refer to it in queries.
`visiblebool`This property holds whether the widget is visible.
`visibleMinfloat`If the current zoom factor and DPI is less than this value, the widget is not visible.
`visibleMaxfloat`If the current zoom factor and DPI is bigger than this value, the widget is not visible.
`tooltipstr`Set a basic tooltip for the widget, this will simply be a Label, it will follow the Tooltip style
`tooltip_fnCallable`Set dynamic tooltip that will be created dynamiclly the first time it is needed. the function is called inside a ui.Frame scope that the widget will be parented correctly.
`tooltip_offset_xfloat`Set the X tooltip offset in points. In a normal state, the tooltip position is linked to the mouse position. If the tooltip offset is non zero, the top left corner of the tooltip is linked to the top left corner of the widget, and this property defines the relative position the tooltip should be shown.
`tooltip_offset_yfloat`Set the Y tooltip offset in points. In a normal state, the tooltip position is linked to the mouse position. If the tooltip offset is non zero, the top left corner of the tooltip is linked to the top left corner of the widget, and this property defines the relative position the tooltip should be shown.
`enabledbool`This property holds whether the widget is enabled. In general an enabled widget handles keyboard and mouse events; a disabled widget does not. And widgets display themselves differently when they are disabled.
`selectedbool`This property holds a flag that specifies the widget has to use eSelected state of the style.
`checkedbool`This property holds a flag that specifies the widget has to use eChecked state of the style. It’s on the Widget level because the button can have sub-widgets that are also should be checked.
`draggingbool`This property holds if the widget is being dragged.
`opaque_for_mouse_eventsbool`If the widgets has callback functions it will by default not capture the events if it is the top most widget and setup this option to true, so they don’t get routed to the child widgets either
`skip_draw_when_clippedbool`The flag that specifies if it’s necessary to bypass the whole draw cycle if the bounding box is clipped with a scrolling frame. It’s needed to avoid the limitation of 65535 primitives in a single draw list.
`mouse_moved_fnCallable`Sets the function that will be called when the user moves the mouse inside the widget. Mouse move events only occur if a mouse button is pressed while the mouse is being moved. void onMouseMoved(float x, float y, int32_t modifier)
`mouse_pressed_fnCallable`Sets the function that will be called when the user presses the mouse button inside the widget. The function should be like this: void onMousePressed(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier) Where ‘button’ is the number of the mouse button pressed. ‘modifier’ is the flag for the keyboard modifier key.
`mouse_released_fnCallable`Sets the function that will be called when the user releases the mouse button if this button was pressed inside the widget. void onMouseReleased(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)
`mouse_double_clicked_fnCallable`Sets the function that will be called when the user presses the mouse button twice inside the widget. The function specification is the same as in setMousePressedFn. void onMouseDoubleClicked(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)
`mouse_wheel_fnCallable`Sets the function that will be called when the user uses mouse wheel on the focused window. The function specification is the same as in setMousePressedFn. void onMouseWheel(float x, float y, carb::input::KeyboardModifierFlags modifier)
`mouse_hovered_fnCallable`Sets the function that will be called when the user use mouse enter/leave on the focused window. function specification is the same as in setMouseHovedFn. void onMouseHovered(bool hovered)
`drag_fnCallable`Specify that this Widget is draggable, and set the callback that is attached to the drag operation.
`accept_drop_fnCallable`Specify that this Widget can accept specific drops and set the callback that is called to check if the drop can be accepted.
`drop_fnCallable`Specify that this Widget accepts drops and set the callback to the drop operation.
`computed_content_size_changed_fnCallable`Called when the size of the widget is changed.
property step
This property controls the steping speed on the drag, its float to enable slower speed, but of course the value on the Control are still integer.
© Copyright 2019-2024, NVIDIA.
Last updated on Mar 25, 2024. |
omni.ui.get_custom_glyph_code.md | get_custom_glyph_code — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Functions »
get_custom_glyph_code
# get_custom_glyph_code
omni.ui.get_custom_glyph_code(file_path: str, font_style: omni.ui._ui.FontStyle = <FontStyle.NORMAL: 1>) → str
Get glyph code.
Parameters
file_path (str) – Path to svg file
font_style (FontStyle) – font style to use.
© Copyright 2019-2024, NVIDIA.
Last updated on Mar 25, 2024. |
omni.ui.ImageProvider.md | ImageProvider — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
ImageProvider
# ImageProvider
class omni.ui.ImageProvider
Bases: pybind11_object
ImageProvider class, the goal of this class is to provide ImGui reference for the image to be rendered.
Methods
__init__(self, **kwargs)
doc
destroy(self)
get_managed_resource(self)
set_image_data(*args, **kwargs)
Overloaded function.
Attributes
height
Gets image height.
is_reference_valid
Returns true if ImGui reference is valid, false otherwise.
width
Gets image width.
__init__(self: omni.ui._ui.ImageProvider, **kwargs) → None
doc
destroy(self: omni.ui._ui.ImageProvider) → None
get_managed_resource(self: omni.ui._ui.ImageProvider) → omni.gpu_foundation_factory._gpu_foundation_factory.RpResource
set_image_data(*args, **kwargs)
Overloaded function.
set_image_data(self: omni.ui._ui.ImageProvider, arg0: capsule, arg1: int, arg2: int, arg3: omni.gpu_foundation_factory._gpu_foundation_factory.TextureFormat) -> None
set_image_data(self: omni.ui._ui.ImageProvider, rp_resource: omni.gpu_foundation_factory._gpu_foundation_factory.RpResource, presentation_key: int = 0) -> None
property height
Gets image height.
property is_reference_valid
Returns true if ImGui reference is valid, false otherwise.
property width
Gets image width.
© Copyright 2019-2024, NVIDIA.
Last updated on Mar 25, 2024. |
omni.ui.color_utils.ColorShade.md | ColorShade — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Submodules »
omni.ui.color_utils »
omni.ui.color_utils Functions »
ColorShade
# ColorShade
omni.ui.color_utils.ColorShade(*args, **kwargs)
© Copyright 2019-2024, NVIDIA.
Last updated on Mar 25, 2024. |
omni.ui.abstract_shade.AbstractShade.md | AbstractShade — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Submodules »
omni.ui.abstract_shade »
omni.ui.abstract_shade Classes »
AbstractShade
# AbstractShade
class omni.ui.abstract_shade.AbstractShade
Bases: object
The implementation of shades for custom style parameter type.
The user has to reimplement methods _store and _find to set/get the value
in the specific store.
Methods
__init__()
set_shade([name])
Set the default shade.
shade([default])
Save the given shade, pick the color and apply it to ui.ColorStore.
__init__()
set_shade(name: Optional[str] = None)
Set the default shade.
shade(default: Optional[Any] = None, **kwargs) → str
Save the given shade, pick the color and apply it to ui.ColorStore.
© Copyright 2019-2024, NVIDIA.
Last updated on Mar 25, 2024. |
configuring.md | Configuration — kit-manual 105.1 documentation
kit-manual
»
Configuration
# Configuration
Kit comes with a very rich and flexible configuration system based on Carbonite settings. Settings is a runtime representation of typical configuration formats (like json, toml, xml), and is basically a nested dictionary of values.
## Quick Start
When you run a kit executable, it doesn’t load any kit app file:
> kit.exe
That will start kit and exit, without enabling any extensions or applying any configuration, except for the built-in config: kit-core.json.
Note
To see all flags call > kit.exe -h
To see default kit settings pass --/app/printConfig=true:
> kit.exe --/app/printConfig=true
That will print all settings. This syntax --/ is used to apply settings from the command line. Any setting can be modified in this way. You may notice that the config it printed includes app/printConfig. You can try adding your own settings to the command line and observing them in the printed config to prove yourself that it works as expected.
Another useful flag to learn early is -v to enable info logging or -vv to enable verbose logging. There are settings to control logging more precisely, but this is an easy way to get more logging in console and debug startup routine.
> kit.exe -v
To make kit do something let’s enable some extensions:
> kit.exe --enable omni.kit.window.script_editor
That enables a script editor extension. You may also notice that it enabled a few extensions that it depends on. You can stack multiple --enable keywords to enable more extensions.
You can also add more folders to search in more for extensions with --ext-folder:
> kit.exe --enable omni.kit.window.script_editor --ext-folder ./exts --enable foo.bar
That enables you to create e.g exts/foo.bar/extension.toml and start hacking on your own extension right away.
Those flags, like --enable, --ext-folder and many others are just shorthand for commonly-used settings. For example, they just append to /app/exts/enabled and /app/exts/folders arrays respectively.
## Application Config
Settings can also be applied by passing a configuration file as a positional argument to Kit:
> kit.exe my.toml
This kind of config file becomes the “Application config”. It receives special treatment from Kit:
The config name becomes application name.
Separate data, documents and cache folders are created for applications.
The Folder where this config exists located becomes the application path.
This allows you to build separate applications with their own data and behavior.
## Kit File
A Kit file is the recommended way to configure applications.
> kit.exe my.kit
Kit files are single-file extensions (basically renamed extension.toml files). Only the [settings] part of them is applied to settings (as with any extension). Here is an example:
[package]
title = "My Script Editor App"
version = "0.1.0"
keywords = ["app"]
[dependencies]
"omni.kit.window.script_editor" = {}
[settings]
foo.bar = "123"
exts."omni.kit.window.script_editor".windowOpenByDefault = true
As with any extension, it can be named, versioned and even published to the registry. It defines dependencies in the same format to pull in additional extensions.
Notice that the setting windowOpenByDefault of the script editor extension is being overridden. Any extension can define its own settings and a guideline is to put them in the extension.toml file of the extension. Check the extension.toml file for omni.kit.window.script_editor. Another guideline is to use the root exts namespace and the name of extension next.
The goal of the .kit file is to bridge the gap between settings and extensions and have one file that the user can click to run Kit-based application (e.g. if .kit file extensions are associated with kit.exe in the OS).
## System Configs
You can create system wide configuration files to override any setting. There are few places to put them:
${shared_documents}/user.toml - To override settings of any kit application in the shared documents folder, typically in (on Windows): C:\Users\[username]\Documents\Kit\shared\user.toml
${app_documents}/user.toml - To override settings of particular application in the application documents folder, typically in: C:\Users\[username]\Documents\Kit\apps\[app_name]\user.toml
<app .kit file>\<0 or more levels above>\deps\user.toml - To override settings of any kit application locally, near the application .kit file. Only in portable mode.
<app .kit file>\<0 or more levels above>\deps\[app_name]\user.toml - To override settings of particular application locally, near the application .kit file. Only in portable mode.
${shared_program_data}/kit.config.toml - To override settings of any kit application in the shared program data, typically in (on Windows): %PROGRAMDATA%/NVIDIA Corporation/Kit/kit.config.toml
${app_program_data}/kit.config.toml - To override settings of particular application in the application program data, typically in (on Windows): %PROGRAMDATA%/NVIDIA Corporation/Kit/[app name]/kit.config.toml
To find the path of these folders on your system, you can run Kit with info logging enabled and look for Applied configs: and Non-existent configs: messages at the beginning. Also, Look for Tokens: list in the log. For more info: Tokens.
## Special Keys
### Appending Arrays
When configs are merged, one value can override another. Sometimes we want to append values for arrays instead of override. For this, use the special ++ key. For example, to add additional extension folders to the /app/folders setting, you can write:
[app.exts]
folders."++" = ["c:/temp"]
You can put that for instance in user.toml described above to add more extension folder search paths.
### Importing Other Configs
You can use the @import@ key to import other config files in that location:
[foo]
"@import@": ["./some.toml"],
That will import the config some.toml under the key foo. The ./ syntax implies a relative path, and that the config file is in the same folder.
## Portable Mode
A regular kit-based app installation sets and uses system wide data, cache, logs folders. It also reads the global Omniverse config in a known system-specific location. To know which folders are being used, you can look at tokens, like ${data}, ${cache}, ${logs}. They can be found at the beginning of each log file.
Kit based apps can also run in a portable mode, using a specified folder as a root for all of those folders. Useful for developers. Local builds by default run in portable mode. There are a few different ways to run kit in portable mode:
### Cmd Args
Pass --portable to run kit in portable mode and optionally pass --portable-root [path] to specify the location of the portable root.
### Portable Configs (Markers)
Kit looks for the following configs that force it to run in portable mode. It reads the content of a file if it finds one, and treats it as a path. If a path is relative - it is relative to this config folder. The priority of search is:
App portable config, e.g. foo.portable near foo.kit when run with: kit.exe foo.kit
Kit portable config near experience, e.g. kit.portable near foo.kit when run with: kit.exe foo.kit
Kit portable config near kit.exe, e.g. kit.portable near kit.exe
## Changing Settings With Command Line
Any setting can be changed via command line using --/ prefix:
> kit.exe --/[path/to/setting]=[value]
Path to setting is separated by / and prefixed by --/.
For example, if the required option is ignoreUnsavedOnExit as shown in the printed JSON configuration:
<ISettings root>:
{
"app": {
"hangDetector": {
"enabled": false,
"timeout": 120
},
"file": {
"ignoreUnsavedOnExit": false,
...
},
...
},
...
}
To change the value of ignoreUnsavedOnExit to true, you need to add --/app/file/ignoreUnsavedOnExit=true to the command line:
> kit.exe --/app/file/ignoreUnsavedOnExit=true
To specify a boolean value, true and false strings must be used.
Note
The values are case-insensitive and using --/some/path/to/parameter=false or --/some/path/to/parameter=FaLsE produces the same result
If you need to set the string value "true" or "false" escape it with double quotes: --/some/path/to/text_parameter=\"false\"
It is also possible to use --/some/path/to/parameter=0 or --/some/path/to/parameter=1 to set a setting to true or false correspondingly. In this case the actual value in the settings will be an integer, but functions working with settings will correctly convert it to a boolean.
Setting a numeric or string value is straightforward:
> kit.exe --/some/number=7 --/another/number=1.5 --/some/string=test
If you need to set a string value that can be parsed as a number or a boolean - or if the string value contains whitespaces - use double quotes to escape it:
> kit.exe --/sets/string/value=\"7\" --/sets/string/with/whitespaces=\"string with spaces\"
Note
Do not forget to escape the quotes so that the OS doesn’t remove them.
### Changing an array value with command line
To set an array value you can:
Specify individual array elements by adding their index in the array at the end of the path to the value:
for example, > kit.exe --/some/array/1=17 will change
...
"some": {
"array" : [1, 2, 3],
},
...
into
...
"some": {
"array" : [1, 17, 3],
},
...
Specify all array elements in the form [value0,value1,...]:
for example, > kit.exe --/some/array=[8,11] replaces
...
"some": {
"array" : [1, 2, 3],
},
...
with
...
"some": {
"array" : [8, 11],
},
...
Note
You can use whitespace in the square brackets ([val0, val1, val2]), if you escape the whole expression with double quotes, in order to prevent the OS from separating it into several command line arguments:
> kit.exe --/some/array="[ 8, 11]"
It is also possible to assign a proper JSON as a parameter value:
> kit.exe --/my/json/param={\"num\":1,\"str\":\"test\",\"arr\":[1,2,3],\"obj\":{\"info\":42}} results in
...
"my": {
"json" : {
"param" : {
"num": 1,
"str": "test",
"arr": [
1,
2,
3
],
"obj": {
"info": 42
}
}
}
},
...
## Passing Command Line arguments to extensions
Kit ignores all command line arguments after --. It also writes those into the /app/cmdLineUnprocessedArgs setting. Extensions can use this setting to access them and process as they wish.
## Code Examples
### Get Setting
# Settings/Get Setting
import carb.settings
settings = carb.settings.get_settings()
# get a string
print(settings.get("/log/file"))
# get an array (tuple)
print(settings.get("/app/exts/folders"))
# get an array element syntax:
print(settings.get("/app/exts/folders/0"))
# get a whole dictionary
exts = settings.get("/app/exts")
print(exts)
print(exts["folders"])
# get `None` if doesn't exist
print(settings.get("/app/DOES_NOT_EXIST_1111"))
### Set Setting
# Settings/Set Setting
import carb.settings
settings = carb.settings.get_settings()
# set different types into different keys
# guideline: each extension puts settings in /ext/[ext name]/ and lists them extension.toml for discoverability
settings.set("/exts/your.ext.name/test/value_int", 23)
settings.set("/exts/your.ext.name/test/value_float", 502.45)
settings.set("/exts/your.ext.name/test/value_bool", False)
settings.set("/exts/your.ext.name/test/value_str", "summer")
settings.set("/exts/your.ext.name/test/value_array", [9,13,17,21])
settings.set("/exts/your.ext.name/test/value_dict", { "a": 2, "b": "winter"})
# print all:
print(settings.get("/exts/your.ext.name/test"))
### Set Persistent Setting
# Settings/Set Persistent Setting
import carb.settings
settings = carb.settings.get_settings()
# all settings stored under "/persistent" saved between sessions
# run that snippet again after restarting an app to see that value is still there:
key = "/persistent/exts/your.ext.name/test/value"
print("{}: {}".format(key, settings.get(key)))
settings.set(key, "string from previous session")
# Below is a setting with location of a file where persistent settings are stored.
# To reset settings: delete it or run kit with `--reset-user`
print("persistent settings are stored in: {}".format(settings.get("/app/userConfigPath")))
### Subscribe To Setting Changes
# Settings/Subscribe To Setting Changes
import carb.settings
import omni.kit.app
settings = carb.settings.get_settings()
def on_change(value, change_type: carb.settings.ChangeEventType):
print(value, change_type)
# subscribe to value changes, returned object is subscription holder. To unsubscribe - destroy it.
subscription1 = omni.kit.app.SettingChangeSubscription("/exts/your.ext.name/test/test/value", on_change)
settings.set("/exts/your.ext.name/test/test/value", 23)
settings.set("/exts/your.ext.name/test/test/value", "fall")
settings.set("/exts/your.ext.name/test/test/value", None)
settings.set("/exts/your.ext.name/test/test/value", 89)
subscription1 = None # no more notifications
settings.set("/exts/your.ext.name/test/test/value", 100)
## Kit Kernel Settings
### /app/enableStdoutOutput (default: true)
Enable kernel standard output. E.g. when extension starts etc.
### /app/disableCmdArgs (default: false)
Disable processing of any command line arguments.
### /app/printConfig (default: false)
Print all settings on startup.
### /app/settings/persistent (default: true)
Enable saving persistent settings (user.config.json). It autosaves changed persistent settings (/persistent namespace) each frame.
### /app/settings/loadUserConfig (default: true)
Enable loading persistent settings (user.config.json) on startup.
### /app/hangDetector/enabled (default: false)
Enable hang detector.
### /app/hangDetector/alwaysEnabled (default: false)
It true ignore /app/hangDetector/disableReasons settings and keep hang detector always enabled. Normally it is disabled during startup and extensions can choose to disable it.
### /app/hangDetector/timeout (default: 120)
Hang detector timeout to trigger (in seconds).
### /app/quitAfter (default: -1)
Automatically quit app after X frames (if X is positive).
### /app/quitAfterMs (default: -1.0)
Automatically quit app after X milliseconds (if X is positive).
### /app/fastShutdown (default: false)
Do not perform full extension shutdown flow. Instead only let subscribers handle IApp shutdown event and terminate.
### /app/python/logSysStdOutput (default: true)
Intercept and log all python standard output in carb logger (info level).
© Copyright 2019-2023, NVIDIA.
Last updated on Nov 14, 2023. |
extensions_basic.md | Getting Started with Extensions — kit-manual 105.1 documentation
kit-manual
»
Getting Started with Extensions
# Getting Started with Extensions
This guide will help you get started creating new extensions for Kit based apps and sharing them with other people.
While this guide can be followed from any Kit based app with a UI, it was written for and tested in Create.
Note
For more comprehensive documentation on what an extension is and how it works, refer to :doc:Extensions (Advanced) <extensions_advanced>.
Note
We recommend installing and using Visual Studio Code as the main developer environment for the best experience.
## 1. Open Extension Manager UI: Window -> Extensions
This window shows all found extensions, regardless of whether they are enabled or disabled, local or remote.
## 2. Create New Extension Project: Press “Plus” button on the top left
It will ask you to select an empty folder to create a project in. You can create a new folder right in this dialog with a right-click.
It will then ask you to pick an extension name. It is good practice to match it with a python module that the extension will contain.
Save the extension folder to your own convenient location for development work.
A few things will happen next:
The selected folder will be prepopulated with a new extension.
exts subfolder will be automatically added to extension search paths.
app subfolder will be linked (symlink) to the location of your Kit based app.
The folder gets opened in Visual Studio Code, configured and ready to hack!
The new extension is enabled and a new UI window pops up:
The small “Gear” icon (on the right from the search bar) opens the extension preferences. There you can see and edit extension search paths. Notice your extension added at the end.
Have a look at the README.md file of created folder for more information on its content.
Try changing some python files in the new extension and observe changes immediately after saving. You can create new extensions by just cloning an existing one and renaming. You should be able to find it in the list of extensions immediately.
## 3. Push to git
When you are ready to share it with the world, push it to some public git repository host, for instance: GitHub
A link to your extension might look like: git://github.com/[user]/[your_repo].git?branch=main&dir=exts.
Notice that exts is repo subfolder with extensions. More information can be found in: Git URL as Extension Search Paths.
The repository link can be added right into the extension search paths in UI:
To get new changes pulled in from the repository, click on the little sync button.
Note
Git must already be installed (git command available in the shell) for this feature to work.
## More Advanced Things To Try
### Explore kit.exe
From Visual Studio Code terminal in a newly created project you have easy access to Kit executable.
Try a few commands in the terminal:
app\kit\kit.exe -h to get started
app\kit\kit.exe --ext-folder exts --enable company.hello.world to only start newly added extension. It has one dependency which will automatically start few more extensions.
app\kit\omni.app.mini.bat to run another Kit based app. More developer oriented, minimalistic and fast to start.
### Explore other extensions
Kit comes with a lot of bundled extensions. Look inside app/kit/exts, app/kit/extscore and app/exts. Most of them are written in python. All of the source to these extensions is available and can serve as an excellent reference to learn from.
© Copyright 2019-2023, NVIDIA.
Last updated on Nov 14, 2023. |
1_5_3.md | 1.5.3 — Omniverse Launcher latest documentation
Omniverse Launcher
»
Omniverse Launcher »
Release Notes »
1.5.3
# 1.5.3
Release Date: March 2022
## Added
Added a check argument for omniverse-launcher://install command that manages throwing an error in case the same component is already installed.
Support external links for third-party content.
## Fixed
Fixed an issue where downloaded zip archives were not removed when the installer is cancelled.
Improved Italian localization.
Fixed an issue where licenses were required for third-party content.
Fixed an issue where problematic components could crash the application.
© Copyright 2023-2024, NVIDIA.
Last updated on Apr 15, 2024. |
1_3_4.md | 1.3.4 — Omniverse Launcher latest documentation
Omniverse Launcher
»
Omniverse Launcher »
Release Notes »
1.3.4
# 1.3.4
Release Date: Oct 2021
## Added
Show the installation date for apps displayed on the library tab.
Added “Collect debug info” button to the settings dialog to prepare a tarball with logs and configuration files.
Show “External link” button for third-party components on the detailed page.
## Fixed
Fixed an issue where links on the “Learn” tab didn’t work after watching a video.
Fixed showing the latest component version instead of the currently installed version on the library tab.
Fixed an issue with dangling installers in the queue.
© Copyright 2023-2024, NVIDIA.
Last updated on Apr 15, 2024. |
pxr.md | Modules — pxr-usd-api 105.1 documentation
pxr-usd-api
»
Modules
# Modules
Ar
The Ar (Asset Resolution) library is responsible for querying, reading, and writing asset data.
CameraUtil
Camera Utilities
Garch
GL Architecture
GeomUtil
The GeomUtil module contains utilities to help image common geometry.
Gf
The Gf (Graphics Foundations) library contains classes and functions for working with basic mathematical aspects of graphics.
Glf
The Glf module contains Utility classes for OpenGL output.
Kind
The Kind library provides a runtime-extensible taxonomy known as “kinds”. Useful for classifying scenegraph objects.
Ndr
The Ndr (Node Definition Registry) provides a node-domain-agmostic framework for registering and querying information about nodes.
Pcp
The PrimCache Population module implements core scenegraph composition semantics - behaviors informally referred to as Layering & Referencing.
PhysicsSchemaTools
Omniverse-specific: The Physics Schema Tools provides tools for the representation of physics properties and behaviors in a 3D scene, such as gravity, collisions, and rigid body dynamics.
Plug
Provides a plug-in framework implementation. Define interfaces, discover, register, and apply plug-in modules to nodes.
Sdf
The Sdf (Scene Description Foundation) provides foundations for serializing scene description and primitive abstractions for interacting.
Sdr
The Sdr (Shader Definition Registry) is a specialized version of Ndr for Shaders.
Tf
The Tf (Tools Foundations) module.
Trace
The Trace module provides performance tracking utility classes for counting, timing, measuring, recording, and reporting events.
Usd
The core client-facing module for authoring, compositing, and reading Universal Scene Description.
UsdAppUtils
The UsdAppUtils module contains a number of utilities and common functionality for applications that view and/or record images of USD stages.
UsdGeom
The UsdGeom module defines 3D graphics-related prim and property schemas that form a basis for geometry interchange.
UsdHydra
The UsdHydra module.
UsdLux
The UsdLux module provides a representation for lights and related components that are common to many graphics environments.
UsdMedia
The UsdMedia module provides a representation for including other media, such as audio, in the context of a stage. UsdMedia currently contains one media type, UsdMediaSpatialAudio, which allows the playback of audio files both spatially and non-spatially.
UsdPhysics
The UsdPhysics module defines the physics-related prim and property schemas that together form a physics simulation representation.
UsdProc
The UsdProc module defines schemas for the scene description of procedural data meaningful to downstream systems.
UsdRender
The UsdRender module provides schemas and behaviors for describing renders.
UsdRi
The UsdRi module provides schemas and utilities for authoring USD that encodes Renderman-specific information, and USD/RI data conversions.
UsdShade
The UsdShade module provides schemas and behaviors for creating and binding materials, which encapsulate shading networks.
UsdSkel
The UsdSkel module defines schemas and API that form a basis for interchanging skeletally-skinned meshes and joint animations.
UsdUI
The UsdUI module provides schemas for encoding information on USD prims for client GUI tools to use in organizing/presenting prims in GUI layouts.
UsdUtils
The UsdUtils module contains utility classes and functions for managing, inspecting, editing, and creating USD Assets.
UsdVol
The UsdVol module provides schemas for representing volumes (smoke, fire, etc).
Vt
The Vt (Value Types) module defines classes that provide for type abstraction, enhanced array types, and value type manipulation.
Work
The Work library is intended to simplify the use of multithreading in the context of our software ecosystem.
© Copyright 2019-2023, NVIDIA.
Last updated on Nov 14, 2023. |
omni.ui.ArrowHelper.md | ArrowHelper — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
ArrowHelper
# ArrowHelper
class omni.ui.ArrowHelper
Bases: pybind11_object
The ArrowHelper widget provides a colored rectangle to display.
Methods
__init__(*args, **kwargs)
Attributes
begin_arrow_height
This property holds the height of the begin arrow.
begin_arrow_type
This property holds the type of the begin arrow can only be eNone or eRrrow.
begin_arrow_width
This property holds the width of the begin arrow.
end_arrow_height
This property holds the height of the end arrow.
end_arrow_type
This property holds the type of the end arrow can only be eNone or eRrrow.
end_arrow_width
This property holds the width of the end arrow.
__init__(*args, **kwargs)
property begin_arrow_height
This property holds the height of the begin arrow.
property begin_arrow_type
This property holds the type of the begin arrow can only be eNone or eRrrow. By default, the arrow type is eNone.
property begin_arrow_width
This property holds the width of the begin arrow.
property end_arrow_height
This property holds the height of the end arrow.
property end_arrow_type
This property holds the type of the end arrow can only be eNone or eRrrow. By default, the arrow type is eNone.
property end_arrow_width
This property holds the width of the end arrow.
© Copyright 2019-2024, NVIDIA.
Last updated on Mar 25, 2024. |
omni.ui.MenuBar.md | MenuBar — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
MenuBar
# MenuBar
class omni.ui.MenuBar
Bases: Menu
The MenuBar class provides a MenuBar at the top of the Window, could also be the MainMenuBar of the MainWindow.
it can only contain Menu, at the moment there is no way to remove item appart from clearing it all together
Methods
__init__(self, **kwargs)
Construct MenuBar.
Attributes
__init__(self: omni.ui._ui.MenuBar, **kwargs) → None
Construct MenuBar.
`kwargsdict`See below
### Keyword Arguments:
`tearablebool`The ability to tear the window off.
`shown_changed_fn`If the pulldown menu is shown on the screen.
`teared_changed_fn`If the window is teared off.
`on_build_fn`Called to re-create new children.
`textstr`This property holds the menu’s text.
`hotkey_textstr`This property holds the menu’s hotkey text.
`checkablebool`This property holds whether this menu item is checkable. A checkable item is one which has an on/off state.
`hide_on_clickbool`Hide or keep the window when the user clicked this item.
`delegateMenuDelegate`The delegate that generates a widget per menu item.
`triggered_fnvoid`Sets the function that is called when an action is activated by the user; for example, when the user clicks a menu option, or presses an action’s shortcut key combination.
`direction`This type is used to determine the direction of the layout. If the Stack’s orientation is eLeftToRight the widgets are placed in a horizontal row, from left to right. If the Stack’s orientation is eRightToLeft the widgets are placed in a horizontal row, from right to left. If the Stack’s orientation is eTopToBottom, the widgets are placed in a vertical column, from top to bottom. If the Stack’s orientation is eBottomToTop, the widgets are placed in a vertical column, from bottom to top. If the Stack’s orientation is eBackToFront, the widgets are placed sorted in a Z-order in top right corner. If the Stack’s orientation is eFrontToBack, the widgets are placed sorted in a Z-order in top right corner, the first widget goes to front.
`content_clipping`Determines if the child widgets should be clipped by the rectangle of this Stack.
`spacing`Sets a non-stretchable space in pixels between child items of this layout.
`send_mouse_events_to_back`When children of a Z-based stack overlap mouse events are normally sent to the topmost one. Setting this property true will invert that behavior, sending mouse events to the bottom-most child.
`widthui.Length`This property holds the width of the widget relative to its parent. Do not use this function to find the width of a screen.
`heightui.Length`This property holds the height of the widget relative to its parent. Do not use this function to find the height of a screen.
`namestr`The name of the widget that user can set.
`style_type_name_overridestr`By default, we use typeName to look up the style. But sometimes it’s necessary to use a custom name. For example, when a widget is a part of another widget. (Label is a part of Button) This property can override the name to use in style.
`identifierstr`An optional identifier of the widget we can use to refer to it in queries.
`visiblebool`This property holds whether the widget is visible.
`visibleMinfloat`If the current zoom factor and DPI is less than this value, the widget is not visible.
`visibleMaxfloat`If the current zoom factor and DPI is bigger than this value, the widget is not visible.
`tooltipstr`Set a basic tooltip for the widget, this will simply be a Label, it will follow the Tooltip style
`tooltip_fnCallable`Set dynamic tooltip that will be created dynamiclly the first time it is needed. the function is called inside a ui.Frame scope that the widget will be parented correctly.
`tooltip_offset_xfloat`Set the X tooltip offset in points. In a normal state, the tooltip position is linked to the mouse position. If the tooltip offset is non zero, the top left corner of the tooltip is linked to the top left corner of the widget, and this property defines the relative position the tooltip should be shown.
`tooltip_offset_yfloat`Set the Y tooltip offset in points. In a normal state, the tooltip position is linked to the mouse position. If the tooltip offset is non zero, the top left corner of the tooltip is linked to the top left corner of the widget, and this property defines the relative position the tooltip should be shown.
`enabledbool`This property holds whether the widget is enabled. In general an enabled widget handles keyboard and mouse events; a disabled widget does not. And widgets display themselves differently when they are disabled.
`selectedbool`This property holds a flag that specifies the widget has to use eSelected state of the style.
`checkedbool`This property holds a flag that specifies the widget has to use eChecked state of the style. It’s on the Widget level because the button can have sub-widgets that are also should be checked.
`draggingbool`This property holds if the widget is being dragged.
`opaque_for_mouse_eventsbool`If the widgets has callback functions it will by default not capture the events if it is the top most widget and setup this option to true, so they don’t get routed to the child widgets either
`skip_draw_when_clippedbool`The flag that specifies if it’s necessary to bypass the whole draw cycle if the bounding box is clipped with a scrolling frame. It’s needed to avoid the limitation of 65535 primitives in a single draw list.
`mouse_moved_fnCallable`Sets the function that will be called when the user moves the mouse inside the widget. Mouse move events only occur if a mouse button is pressed while the mouse is being moved. void onMouseMoved(float x, float y, int32_t modifier)
`mouse_pressed_fnCallable`Sets the function that will be called when the user presses the mouse button inside the widget. The function should be like this: void onMousePressed(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier) Where ‘button’ is the number of the mouse button pressed. ‘modifier’ is the flag for the keyboard modifier key.
`mouse_released_fnCallable`Sets the function that will be called when the user releases the mouse button if this button was pressed inside the widget. void onMouseReleased(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)
`mouse_double_clicked_fnCallable`Sets the function that will be called when the user presses the mouse button twice inside the widget. The function specification is the same as in setMousePressedFn. void onMouseDoubleClicked(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)
`mouse_wheel_fnCallable`Sets the function that will be called when the user uses mouse wheel on the focused window. The function specification is the same as in setMousePressedFn. void onMouseWheel(float x, float y, carb::input::KeyboardModifierFlags modifier)
`mouse_hovered_fnCallable`Sets the function that will be called when the user use mouse enter/leave on the focused window. function specification is the same as in setMouseHovedFn. void onMouseHovered(bool hovered)
`drag_fnCallable`Specify that this Widget is draggable, and set the callback that is attached to the drag operation.
`accept_drop_fnCallable`Specify that this Widget can accept specific drops and set the callback that is called to check if the drop can be accepted.
`drop_fnCallable`Specify that this Widget accepts drops and set the callback to the drop operation.
`computed_content_size_changed_fnCallable`Called when the size of the widget is changed.
© Copyright 2019-2024, NVIDIA.
Last updated on Mar 25, 2024. |
1_5_1.md | 1.5.1 — Omniverse Launcher latest documentation
Omniverse Launcher
»
Omniverse Launcher »
Release Notes »
1.5.1
# 1.5.1
Release Date: Jan 2022
## Added
Launcher can now pull notifications from the server. This can be used to send important messages to users instead of displaying them in the toolbar.
## Changed
Changed colors for messages displayed in the bottom toolbar (white for regular text and blue for links instead of yellow).
## Fixed
Escape desktop entry path on Linux for opening custom protocol links.
Fixed an issue where News and Learn tabs were refreshed when Launcher lost or regained focus.
Increased the default window size to fit the cache path in the Launcher settings.
Raise an error when users try to install components that are already installed.
Raise an error when users try to launch components that are not installed.
Fixed an issue where some packages couldn’t be moved to the right location by offline installer.
© Copyright 2023-2024, NVIDIA.
Last updated on Apr 15, 2024. |
custom-protocol-commands.md | Custom Protocol Commands — Omniverse Launcher latest documentation
Omniverse Launcher
»
Omniverse Launcher »
Custom Protocol Commands
# Custom Protocol Commands
Launcher supports deep linking which allows using custom URLs to point to specific Launcher screens or
run various Launcher commands. Deep linking is built on top of custom protocol URLs that start with omniverse-launcher://.
Such links can be used by emails, websites or messages to redirect users back to Launcher,
or can be used by system administrators to manage installed apps.
This document describes the list of all available custom protocol commands for Launcher.
## Showing a Launcher Screen
Launcher supports omniverse-launcher://navigate command to bring up the main window and
open a specific screen there. The screen is specified with the path query parameter, for example:
omniverse-launcher://navigate?path=/news
The list below defines all available screens supported by this command:
News: omniverse-launcher://navigate?path=/news
Library: omniverse-launcher://navigate?path=/library
Installed app in the library: omniverse-launcher://navigate?path=/library/:slug where :slug should be replaced with a unique application name.
Installed connectors: omniverse-launcher://navigate?path=/library/connectors/
Exchange: omniverse-launcher://navigate?path=/exchange
Detailed app info: omniverse-launcher://navigate?path=/exchange/app/:slug where :slug should be replaced with a unique application name.
Detailed connector info: omniverse-launcher://navigate?path=/exchange/connector/:slug where :slug should be replaced with a unique connector name.
Nucleus: omniverse-launcher://navigate?path=/collaboration
## Installing Apps
omniverse-launcher://install command can be used to start installing an application. This command requires
two query arguments:
### Query Arguments
slug - the unique name of the installed app or connector.
version - (optional) - the version that needs to be installed. If not specified, then the latest version is installed.
check - (optional) - defines if Launcher needs to throw an error if the same component is already installed. (true or false, true by default).
### Example
omniverse-launcher://install?slug=create&version=2020.3.0-rc.14
The IT Managed Launcher supports only the path argument that must point to a zip archive downloaded from the
enterprise portal.
### Example
omniverse-launcher://install?path=C:Downloadscreate.zip
## Uninstalling apps
omniverse-launcher://uninstall command can be used to removed installed apps or connectors. This command requires two query
arguments:
slug - the unique name of the installed app or connector.
version - the version that needs to be uninstalled.
### Example
omniverse-launcher://uninstall?slug=create^&version=2020.3.0-rc.14
## Launching apps
omniverse-launcher://launch command allows users to start the specified application. The launch command will start the app with the specified slug and will use the version that is currently selected by user.
This command requires one query argument:
slug - the unique name of the installed app that must be launched.
### Example
Starts the current version of Create.
omniverse-launcher://launch?slug=create
Note
Users can change their current app versions in the library settings.
## Close the Launcher
omniverse-launcher://exit command can be used to close Launcher. This command requires no query arguments.
### Example
omniverse-launcher://exit
## Open omniverse:// links
Launcher is also registered as the default handler for omniverse:// links.
The first time when such link is opened by user, Launcher brings up the dialog to select an Omniverse application
that should be used to open omniverse:// links by default:
### Example
omniverse://rc.ov.nvidia.com/NVIDIA/Samples/Astronaut/Astronaut.usd
## Run in kiosk mode
omniverse-laucher://kiosk command can be used to run Launcher in kiosk mode.
In kiosk mode, Launcher is opened fullscreen on top of other applications.
This feature is only available on Windows.
To disable the kiosk mode, use omniverse-launcher://kiosk?enabled=false command.
## Track start and exit data of apps
omniverse-launcher://register-start command can be used to register a launch event when an app has been started. This command accepts two query arguments:
slug [required] - the unique name of the app or connector that has been launched
version [required] - the version of the app or connector that has been launched
omniverse-launcher://register-exit command can be used to register an exit event when an app has been closed. This command accepts two query arguments:
slug [required] - the unique name of the app or connector that has been closed
version [required] - the version of the app or connector that has been closed
© Copyright 2023-2024, NVIDIA.
Last updated on Apr 15, 2024. |
omni.ui.set_shade.md | set_shade — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Functions »
set_shade
# set_shade
omni.ui.set_shade(shade_name: Optional[str] = None)
© Copyright 2019-2024, NVIDIA.
Last updated on Mar 25, 2024. |
omni.ui.MultiStringField.md | MultiStringField — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
MultiStringField
# MultiStringField
class omni.ui.MultiStringField
Bases: AbstractMultiField
MultiStringField is the widget that has a sub widget (StringField) per model item.
It’s handy to use it for string arrays.
Methods
__init__(*args, **kwargs)
Overloaded function.
Attributes
__init__(*args, **kwargs)
Overloaded function.
__init__(self: omni.ui._ui.MultiStringField, **kwargs) -> None
__init__(self: omni.ui._ui.MultiStringField, arg0: omni.ui._ui.AbstractItemModel, **kwargs) -> None
__init__(self: omni.ui._ui.MultiStringField, *args, **kwargs) -> None
Constructor.
`kwargsdict`See below
### Keyword Arguments:
`column_count`The max number of fields in a line.
`h_spacing`Sets a non-stretchable horizontal space in pixels between child fields.
`v_spacing`Sets a non-stretchable vertical space in pixels between child fields.
`widthui.Length`This property holds the width of the widget relative to its parent. Do not use this function to find the width of a screen.
`heightui.Length`This property holds the height of the widget relative to its parent. Do not use this function to find the height of a screen.
`namestr`The name of the widget that user can set.
`style_type_name_overridestr`By default, we use typeName to look up the style. But sometimes it’s necessary to use a custom name. For example, when a widget is a part of another widget. (Label is a part of Button) This property can override the name to use in style.
`identifierstr`An optional identifier of the widget we can use to refer to it in queries.
`visiblebool`This property holds whether the widget is visible.
`visibleMinfloat`If the current zoom factor and DPI is less than this value, the widget is not visible.
`visibleMaxfloat`If the current zoom factor and DPI is bigger than this value, the widget is not visible.
`tooltipstr`Set a basic tooltip for the widget, this will simply be a Label, it will follow the Tooltip style
`tooltip_fnCallable`Set dynamic tooltip that will be created dynamiclly the first time it is needed. the function is called inside a ui.Frame scope that the widget will be parented correctly.
`tooltip_offset_xfloat`Set the X tooltip offset in points. In a normal state, the tooltip position is linked to the mouse position. If the tooltip offset is non zero, the top left corner of the tooltip is linked to the top left corner of the widget, and this property defines the relative position the tooltip should be shown.
`tooltip_offset_yfloat`Set the Y tooltip offset in points. In a normal state, the tooltip position is linked to the mouse position. If the tooltip offset is non zero, the top left corner of the tooltip is linked to the top left corner of the widget, and this property defines the relative position the tooltip should be shown.
`enabledbool`This property holds whether the widget is enabled. In general an enabled widget handles keyboard and mouse events; a disabled widget does not. And widgets display themselves differently when they are disabled.
`selectedbool`This property holds a flag that specifies the widget has to use eSelected state of the style.
`checkedbool`This property holds a flag that specifies the widget has to use eChecked state of the style. It’s on the Widget level because the button can have sub-widgets that are also should be checked.
`draggingbool`This property holds if the widget is being dragged.
`opaque_for_mouse_eventsbool`If the widgets has callback functions it will by default not capture the events if it is the top most widget and setup this option to true, so they don’t get routed to the child widgets either
`skip_draw_when_clippedbool`The flag that specifies if it’s necessary to bypass the whole draw cycle if the bounding box is clipped with a scrolling frame. It’s needed to avoid the limitation of 65535 primitives in a single draw list.
`mouse_moved_fnCallable`Sets the function that will be called when the user moves the mouse inside the widget. Mouse move events only occur if a mouse button is pressed while the mouse is being moved. void onMouseMoved(float x, float y, int32_t modifier)
`mouse_pressed_fnCallable`Sets the function that will be called when the user presses the mouse button inside the widget. The function should be like this: void onMousePressed(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier) Where ‘button’ is the number of the mouse button pressed. ‘modifier’ is the flag for the keyboard modifier key.
`mouse_released_fnCallable`Sets the function that will be called when the user releases the mouse button if this button was pressed inside the widget. void onMouseReleased(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)
`mouse_double_clicked_fnCallable`Sets the function that will be called when the user presses the mouse button twice inside the widget. The function specification is the same as in setMousePressedFn. void onMouseDoubleClicked(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)
`mouse_wheel_fnCallable`Sets the function that will be called when the user uses mouse wheel on the focused window. The function specification is the same as in setMousePressedFn. void onMouseWheel(float x, float y, carb::input::KeyboardModifierFlags modifier)
`mouse_hovered_fnCallable`Sets the function that will be called when the user use mouse enter/leave on the focused window. function specification is the same as in setMouseHovedFn. void onMouseHovered(bool hovered)
`drag_fnCallable`Specify that this Widget is draggable, and set the callback that is attached to the drag operation.
`accept_drop_fnCallable`Specify that this Widget can accept specific drops and set the callback that is called to check if the drop can be accepted.
`drop_fnCallable`Specify that this Widget accepts drops and set the callback to the drop operation.
`computed_content_size_changed_fnCallable`Called when the size of the widget is changed.
© Copyright 2019-2024, NVIDIA.
Last updated on Mar 25, 2024. |
omni.ui.workspace_utils.CompareDelegate.md | CompareDelegate — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Submodules »
omni.ui.workspace_utils »
omni.ui.workspace_utils Classes »
CompareDelegate
# CompareDelegate
class omni.ui.workspace_utils.CompareDelegate
Bases: object
Methods
__init__()
compare_dock_in_value_dock_id(key, value, target)
compare_dock_in_value_height(key, value, target)
compare_dock_in_value_position_x(key, value, ...)
compare_dock_in_value_position_y(key, value, ...)
compare_dock_in_value_width(key, value, target)
compare_value(key, value, target)
compare_window_value_dock_id(key, value, target)
failed_get_window(error_list, target)
failed_window_key(error_list, key, target, ...)
failed_window_value(error_list, key, value, ...)
__init__()
© Copyright 2019-2024, NVIDIA.
Last updated on Mar 25, 2024. |
migration.md | Kit 105 Upgrade Migration Guide — kit-manual 105.1 documentation
kit-manual
»
Kit 105 Upgrade Migration Guide
# Kit 105 Upgrade Migration Guide
Welcome!
Kit Extensions Upgrade
Visual Studio 2019
Issues with USD
Kit SDK
Update premake.lua
Update Python Include Paths or Links
Update Boost Links
Common Errors
Usd 22.11 and Python 3.10 Updates
Python 3.10 Upgrade
Breaking Change: must call super __init__ function
Breaking Change: DLL load behavior
Breaking Change: Boost upgrade to version 1_76
Schema Development
Introduction
What’s Changed? (Relevant Release Notes)
22.11
22.08
22.05
22.03
21.11
21.08
21.05
21.02
Breaking Change: Applied API Schemas, Inheritance, and Built-Ins
Inheriting </APISchemaBase> and Applying Built-Ins To Represent Dependencies
What do I need to change?
Accessing API Schema Attributes
Breaking Change: Schema Kind
Breaking Change: Retrieving Schema Type Names
New Feature: Auto-Applied API Schemas
New Feature: Abstract Typed Schemas and the Schema Registry
New Feature: Codeless Schemas
New Feature: Additional GLOBAL Schema Metadata to Define Use of Literal Identifier Names
New Feature: Defining Sparse Overrides From Built-Ins
Ar 2.0 (Asset Resolution Re-architecture)
Introduction
Breaking Change: IsSearchPath() Removed
Breaking Change: IsRelativePath() Removed
Breaking Change: AnchorRelativePath() Renamed
Breaking Change: ComputeNormalizedPath() Removed
Breaking Change: ComputeRepositoryPath() Removed
Breaking Change: ComputeLocalPath() Removed
Breaking Change: Resolve() Signature Changed
Breaking Change: ResolveWithAssetInfo() Removed
Breaking Change: GetModificationTimestamp() Signature Changed
Breaking Change: OpenAsset() / ArAsset Signature Changed
New Feature: OpenAssetForWrite() / ArWritableAsset
New Feature: ArAsset Detached Assets
API Breaking Changes
Base
Arch
Arch.Filesystem
● ArchFile removed
Tf
pxr.Tf Python Module
● PrepareModule to PreparePythonModule
Usd
Ar
Ar.Resolver
● IsSearchPath() Removed
● IsRelativePath() Removed
● AnchorRelativePath() to CreateIdentifier()
● ComputeNormalizedPath() Removed
● ComputeRepositoryPath() Removed
● ComputeLocalPath() Removed
● Resolve() Signature Changed
● ResolveWithAssetInfo() Removed
● GetModificationTimestamp() Signature Changed
● OpenAsset() / ArAsset Signature Changes
Sdf
Sdf.ChangeBlock
● Sdf.ChangeBlock(fastUpdates) to Sdf.ChangeBlock()
Sdf.Layer
● GetResolvedPath return type changed
Usd
Usd.CollectionAPI
● ApplyCollection to Apply
Usd.Prim
● “Master” to “Prototype”
● GetAppliedSchemas: Now filters out non-existent schemas
Usd.SchemaRegistry
● SchemaType to SchemaKind
● Property Names of MultipleApply Schemas now namespaced in schema spec
Usd.Stage
● GetMasters to GetPrototypes
UsdGeom
UsdGeom.Imageable
UsdLux
● All properties now prefixed with “inputs:”
UsdLux.Light
● UsdLux.Light to UsdLuxLightAPI
● UsdLux.LightPortal to UsdLux.PortalLight
● UsdLuxLight.ComputeBaseEmission() removed
● UsdLux.LightFilterAPI removed
UsdRender
UsdRender.SettingsAPI
UsdShade
UsdShade.ConnectableAPI
● IsNodeGraph replaced with IsContainer
UsdShade.MaterialBindingAPI
● Material bindings require UsdShadeMaterialBindingAPI to be applied
UsdSkel
UsdSkel.Cache
● Populate/ComputeSkelBinding/ComputeSkelBindings now require a predicate parameter
Imaging
Glf
● Removed glew dependency
Other Breaking Changes
Schemas
pluginInfo.json
● plugInfo.json now requires schemaKind field
Non-Breaking Changes
Imaging
Hdx
Hdx.TaskController
● Added HdxTaskController::SetPresentationOutput, i.e., for AOV buffering 0
Dumping Ground
● Schemas removed in 20.08 to 22.11
● Schemas added in 20.08 to 22.11
## Welcome!
It’s no easy feat to roll out 2+ years of contributions to Python,
Visual Studio, and the USD Ecosystem in Omniverse– thank you for taking
the time to use this guide to navigate the myriad incompatibilities
introduced in this massive upgrade.
For the latest Omniverse Forum posts related to Kit 105 migration, please go [here]
## Kit Extensions Upgrade
This section on upgrading Kit extensions contains information
about breaking changes necessary to get building.
A fair amount of the toolset that we build on has been upgraded. This
includes a new version of Visual Studio (2019), Boost 1.76, Python 3.10
and USD 22.11. These changes do impact Kit Extension developers and this
next section will walk through some of the changes needed to upgrade an
Extension to support all these changes.
The following steps assume that your Kit Extension is based on the Kit
Extensions Template. The steps here should help the upgrade process but
might be different depending on how the repository is set up to build.
### Visual Studio 2019
The first step is to make sure your Extension is compatible with Visual
Studio 2019.
Update your host-deps.packman.xml
Change your premake dependency to a more recent version.
Currently, this is “5.0.0-beta1+nv1-${platform}”
Make your msvc dependency compatible with Visual Studio 2019.
Currently, this is “2019-16.11.17-2”
Also use an updated version of winsdk which is “10.0.19608.0”
Next, you’ll need to update your version of repo_kit_tools in
repo-deps.packman.xml. This updated version is needed so that
premake will use the Visual Studio 2019 generator during the build
process. This will require repo_kit-tools version 0.9.4 or later
These updated dependencies should get the Extension repository pulling
in the necessary dependencies for a Windows build using Visual Studio
2019
NOTE: An issue was encountered where the Extension(s) would still
issue Windows build errors if built from a normal Windows Command
Prompt. Switching to a Visual Studio 2019 Command Prompt fixed the
issue. The exact build error was:
TRACKER : error TRK0005: Failed to locate: \"CL.exe\". The system cannot find the file specified.
C:\\omniverse\\kit-ext-tpl-cpp-int\\\_compiler\\vs2019\\omni.example.cpp.commands.tests\\omni.example.cpp.commands.tests.vcxproj
TRACKER : error TRK0005: Failed to locate: \"CL.exe\". The system cannot find the file specified.
C:\\omniverse\\kit-ext-tpl-cpp-int\\\_compiler\\vs2019\\omni.example.cpp.commands.plugin\\omni.example.cpp.commands.plugin.vcxproj
#### Issues with USD
The main issue that we are aware of when building a USD plugin, such as
a SdfFileFormat plugin, against Visual Studio 2019 is an optimization
that the compiler makes with release builds. Visual Studio 2019 enables
the “/Zc:inline” option by default, we need to make sure that this
option is disabled otherwise USD will not be able to construct your USD
plugin in a release build.
In premake.lua make sure that you add the ”/Zc:inline-”
buildoption for release builds to disable that
behavior
If you are curious about why this needs to be done you can read
more about the issue
[here]
### Kit SDK
Next, we’ll need to point our Extension at a kit-sdk dependency that
includes all the changes necessary for Usd 22.11 and Python 3.10:
The kit-sdk dependency is usually declared within kit-sdk.packman.xml if using the Kit Extension Template
[email protected]
105.0.1+release.109439.ed961c5c.tc.${platform}.${config}
[email protected]
105.1+master.121139.5d3cfe78.tc.${platform}.${config}
We will also need to correctly import these new upstream dependencies
from our kit-sdk dependency:
In target-deps.packman.xml (or kit-sdk-deps.packman.xml) make sure that you are importing both the python and nv_usd dependencies from kit-sdk
Make sure that your import path is pulling from all-deps.packman.xml in Kit
filter to include “python”
filter to include “nv_usd_py310_${config}”
This only needs to be added or changed if you extension depends on nv_usd. So if you see a dependency like nv_usd_py37_${config} make sure that it is updated to nv_usd_py310_${config}
At a minimum, your target-deps.packman.xml should be updated to look something like:
<project toolsVersion="5.6">
<import path="../_build/${platform}/${config}/kit/dev/all-deps.packman.xml">
<filter include="python" />
<filter include="nv_usd_py310_${config}" />
</import>
<dependency name="nv_usd_py310_${config}" linkPath="../_build/target-deps/nv_usd/${config}" />
</project>
If you are pulling your nv_usd or python dependencies directly, it might be a good time to update your dependencies
and import directly from Kit’s all-deps.packman.xml. This will help align versions of Python and USD with the supported version of Kit for your Extension.
For example, if you are declaring your python and nv_usd dependencies like the following:
<project toolsVersion="5.6">
<dependency name="nv-usd_${config}" linkPath="../_build/deps/usd_${config}" >
<package name="nv-usd" version="20.08.nv.1.2.2404.6bf74556-win64_py37_${config}-main" platforms="windows-x86_64" />
<package name="nv-usd" version="20.08.nv.1.2.2404.6bf74556-linux64_py37-centos_${config}-main" platforms="linux-x86_64" />
<package name="nv-usd" version="20.08.nv.1.2.2404.6bf74556-linux-aarch64_py37_${config}-main" platforms="linux-aarch64" />
</dependency>
<dependency name="python" linkPath="../_build/deps/python" >
<package name="python" version="3.7.12+nv1-${platform}" platforms="windows-x86_64 linux-x86_64 linux-aarch64" />
</dependency>
</project>
Both python and nv_usd dependencies should be updated to use importing, i.e:
<project toolsVersion="5.6">
<import path="../_build/${platform}/${config}/kit/dev/all-deps.packman.xml">
<filter include="python" />
<filter include="nv_usd_py310_${config}" />
</import>
<dependency name="nv_usd_py310_${config}" linkPath="../_build/target-deps/nv_usd/${config}" />
</project>
### Update premake lua
We should have all of the necessary dependencies for MSVC 2019, Python
3.10, Boost 1.76 and USD 22.11 correctly set up. The next part of the
process is updating the premake.lua scripts for each extension.
Unfortunately, each one of these premake.lua scripts can be different
depending on what’s required to build the extension. For example, if
your extension is purely Python no changes to premake.lua should be
necessary. But if your extension depends on USD and links against Boost
for Python bindings it’s very likely that premake.lua will need to be
updated
#### Update Python Include Paths or Links
If you have an Extension that creates Python bindings for a Native
Extension, you’ll more than likely need to tweak some include paths and
links in premake.lua.
In premake.lua for each Extension search for usages of “python3.7”
and update to “python3.10”. Typically, these will be limited to
“includedirs” and “links” in premake.
This should be as simple as search and replace but YMMV with
complex build scripts.
The important part is that the Python 3.10 headers and binaries
can be found when you go to build / link your Extension.
#### Update Boost Links
If the Extension you are building depends on Boost, include paths and
links might need to change. This is definitely the case with Windows as the DLL
includes the MSVC toolset along with the Boost version number in its name.
These values are now vc142 and 1_76, respectively.
For convenience, the link_boost_for_windows function can be used.
When calling “link_boost_for_windows({“boost_python310”})” that should
correctly link against Boost for Python 3.10 using the vc142 toolset.
#### Common Errors
The location of the omni.usd binary has changed. To properly link
against omni.usd you will need to change the library path to find
it:
libdirs {“%{kit_sdk}/extscore/omni.usd.core/bin”} -> libdirs
{“%{kit_sdk}/exts/omni.usd.core/bin”}
Unable to find Python headers / library for building Python bindings
The following error usually means that an include directory
within a premake5.lua build script might be misconfigured and
not set to the correct directory
../../../_build/target-deps/nv_usd/debug/include/boost/python/detail/wrap_python.hpp:57:11:
fatal error: pyconfig.h: No such file or directory
Within your premake5.lua scripts a couple examples of incorrect
paths:
includedirs { target_deps.."/python/include/python3.10**m**" }
includedirs { target_deps.."/python/include/python3.7m" }
includedirs { target_deps.."/python/include/python3.7" }
These include directories should be set to the following now that
Kit is using Python 3.10
includedirs { target_deps.."/python/include/python3.10" }
### Usd 22.11 and Python 3.10 Updates
From here, the Extension repository should at least be able to find all
the necessary dependencies, build and link against them. The next part
will be to make any necessary changes for Python 3.10, such as calling
super().__init__(), and USD 22.11. These changes can vary wildly
between repositories and developers should refer to all the
documentation in this guide on how to properly migrate their repository.
## Python 3.10 Upgrade
### Breaking Change: must call super __init__ function
All derived classes that override __init__ must call the super
__init__ function. This does not limit only to omni.ext.IExt,
but any class, the following example will also fail:
class A:
def __init__(self):
self.x = 0
class B(A):
def __init__(self):
self.y = 0
b = B()
print(b.x, b.y)
Omitting this is now an error in 3.10. The simplest way is to call
super().__init__() with arguments if there are any.
### Breaking Change: DLL load behavior
DLL load behavior changed on Windows in Python 3.8+.
The PATH environment variable is no longer used for directories to
load DLLs from. Anything outside of the script dir/python exe dir
must be added in code now. There’s a new function in the os module
called add_dll_directory that takes a string path arg.
### Breaking Change: Boost upgrade to version 1_76
Boost has an auto linker for Windows that is enabled by default. The
lib names for Windows vary based on compiler, config, and mt or
not. The auto linker handles determining the correct version based
on the active build tooling. Boost 1_76 is aware of the VS 2019
build tools, unlike version 1_68 that was being used previously.
There’s a premake helper function in Kit called link_boost_for_windows
that takes a list of the short names and links the full ones.
## Schema Development
### Introduction
Between 20.08 and 22.08, schema extensions have undergone a number of
changes that include new features (such as codeless and auto-applied
schemas) and breaking changes (such as API schemas no longer supporting
inheritance). This section discusses both, along with examples of
changes that need to be made for schema extensions to be compliant with
USD 22.11.
### What’s Changed? (Relevant Release Notes)
#### 22.11
Added "GetAll" method for multi-apply schemas in codegenTemplates.
#### 22.08
Added the apiSchemaOverride feature to usdGenSchema that allows a
schema definition to explicitly define sparse overrides to
properties it expects to be included from a built-in API schema.
See: https://graphics.pixar.com/usd/release/api/_usd__page__generating_schemas.html#Usd_APISchemaPropertyOverride
#### 22.05
Changes for usdGenSchema:
Disabled inheritance for multiple apply API schemas, now that
built-in API schemas are supported for multiple apply schemas.
Fixed issue where schema tokens with invalid C++ identifiers
would be generated. These tokens will now be converted into a
valid identifier. Tokens beginning with a numeral are now
prefixed with ‘_’.
Added ability to generate C++ identifiers using property names
and values exactly as authored in schema.usda instead of
camel-casing them by specifying useLiteralIdentifier in the
GLOBAL schema metadata. This is helpful in scenarios where
schema.usda is generated using utilities like
usdgenschemafromsdr instead of being hand authored.
Fixed Python 3 compatibility by explicitly included the None
keyword in reserved list.
#### 22.03
Changes for applied API schemas:
Multiple-apply API schemas can now include other multiple-apply
API schemas as built-ins.
"prepend apiSchemas" must be used in schema.usda to set
built-in API schemas on another schema.
Applied API schemas authored on a prim can no longer change the
type of a property defined by that prim’s type or built-in
API schemas.
#### 21.11
Updated connectedAPIBehavior so that APISchemas can now provide
connectableAPIBehavior by explicitly registering a new behavior
associated with the APISchemaType or by providing plug metadata to
configure the connectability behavior. Note that the latter can be
used for codeless schemas.
Single apply API schemas can now include built-in API schemas and
can auto apply to other single apply API schemas. API schemas are
now only allowed to inherit directly from UsdAPISchemaBase.
Applied API schemas can no longer inherit from other other applied
API schemas, which allows UsdPrim::HasAPI() to be a much faster
query. Non-applied schemas may still inherit from other
non-applied schemas.
#### 21.08
Added support for “codeless” USD schemas that do not have any C++
or Python code. Changes to these schemas’ definitions do not
require any code to be recompiled; instead, the
generatedSchema.usda just needs to be regenerated via usdGenSchema
and reinstalled.
Added ability to specify allowed prim types for API schemas in the
customData dictionary for the schema in schema.usda.
Added UsdPrim::CanApplyAPI and CanApply to all API schema classes to
check if an API schema can be applied to a prim based on the
restrictions above.
API schemas can now provide connectability behavior, which can
override behavior based on prim type.
#### 21.05
Updated usdGenSchema to not error when generating a dynamic schema
and libraryPath is not specified.
Fixed usdGenSchema to honor apiName metadata for auto generated
tokens.h. This results in correct doxygen documentation for the
correct API names.
usdGenSchema now adds a type alias for abstract typed schemas, which
means abstract typed schemas now have an official USD type name
which is registered with the UsdSchemaRegistry.
Auto apply API schemas in USD can now specify abstract typed schemas
to auto apply to, indicating that the API should be applied to all
schemas that derive from the abstract schema type.
#### 21.02
Added support for auto-apply API schemas. This allows single-apply
API schemas to be automatically applied to prims using one of a
list of associated concrete schema types instead of requiring the
user to manually apply the API schema.
Renamed UsdSchemaType to UsdSchemaKind to disambiguate between the
schema type (e.g. UsdGeomSphere) and kind (e.g. non-applied,
single-apply, etc).
Deprecated functions using the "schema type" terminology in favor
of "schema kind".
### Breaking Change: Applied API Schemas, Inheritance, and Built-Ins
As of v21.11, USD no longer supports inheritance chains for API schemas
(although still fully supported for IsA schemas). The primary reason for
this breaking change was the need to make
UsdPrim::HasAPI<SchemaType>() more efficient by not continuously
checking derivation chains. To that end, support for inheritance was
removed from API schemas. Instead, API schemas have the ability to
define built-ins, which are semantically similar to defining inheritance
chains, but more performant from a USD run-time perspective.
Unfortunately, this has a significant impact to our own custom schema
definitions (particularly physics) and requires that these schemas be
migrated to conform to the new requirements.
#### Inheriting </APISchemaBase> and Applying Built-Ins To Represent Dependencies
All API schema types (both single and multiple-apply) are now required
to inherit </APISchemaBase>. This means that any derivation chains
that exist in applied API schemas must be converted such that the
inherits attribute of the schema type is </APISchemaBase>:
class "MyAppliedAPI" (
inherits = </APISchemaBase>
) {
}
To simulate inheritance and define a dependency chain, USD has
introduced the concept of built-ins. This is the inverse of the
auto-applied API schema feature - when an applied API schema is applied
to a prim instance, all applied API schemas declared as built-ins are
applied as well. Built-ins work recursively such that if SchemaType1API
declared built-ins of SchemaType2API and SchemaType3API, and
SchemaType2API declared built-ins of SchemaType4API, then applying
SchemaType1API to a prim instance will also apply SchemaType2API,
SchemaType3API, and SchemaType4API.
All built-ins specified must be either single-apply API or named
instances of multiple-apply API schemas (IsA schemas cannot be
built-ins).
Declaring an applied API schema type as a built-in involves placing it’s
schema type name in the prepend apiSchemas attribute of the schema type
that uses it as a built-in:
class "ExampleSchema1API" (
inherits = </APISchemaBase>
customData = {
token apiSchemaType = "singleApply"
}
prepend apiSchemas = ["ExampleSchema2API"]
) {
}
This definition states that when ExampleSchema1API is applied to a prim
instance, ExampleSchema2API will also be applied as a schema built-in to
ExampleSchemaAPI. This mimics inheritance in the sense that applying
ExampleSchema1API will always also apply ExampleSchema2API, so all
attributes from both will be present on the prim (as you would expect in
the normal inheritance chain).
Note: A schema can have a stronger opinion on a property that may come
from one of its built-ins if it declares the property itself. This is
useful to override the default value of the property. Be careful not to
do this unintentionally and do things like e.g. change the type of the
property!
Multiple-apply schemas have an additional set of consequences since they
must always be applied to a prim instance using the same instance name.
This results in the following:
If a multiple-apply API schema is listed as a built-in without an
instance name, it is always applied to the prim instance using the
same instance name as the schema type declaring the built-in.
If a multiple-apply API schema is listed as a built-in with an
instance name, it will be applied with a suffixed instance name
that combines the built-in instance name and the instance name of
the schema type declaring the built-in.
For example, consider the following definition:
class "MultipleApplySchema1API" (
inherits = </APISchemaBase>
customData = {
token apiSchemaType = "multipleApply"
}
prepend apiSchemas = ["MultipleApplySchema2API"]
) {
}
Applying MultipleApplySchema1API to a prim instance with the instance
name foo will also result in MultipleApplySchema2API being applied to
the prim instance with the instance name foo. Now consider a slight
modification to this definition:
class "MultipleApplySchema1API" (
inherits = </APISchemaBase>
customData = {
token apiSchemaType = "multipleApply"
}
prepend apiSchemas = ["MultipleApplySchema2API:bar"]
)
{
}
In this case, applying MultipleApplySchema1API to a prim instance with
the instance name foo will result in MultipleApplySchemaAPI2 being
applied with the suffixed instance name foo:bar.
Note that built-ins apply to IsA schema types as well (that is, you can
define a list of built-in API schema types that are applied to a prim
instance of the IsA type). In this case, inherited types will inherit
the built-ins from their base types.
##### What do I need to change?
Based on this breaking change, there are two things that must be done in
existing schemas:
All applied API schemas must be changed to inherit from
</APISchemaBase>
The existing inheritance hierarchy must be converted to a set of
built-ins (see examples below)
As an example, consider three applied API schemas Schema1API,
Schema2API, and Schema3API, each currently inheriting from the one
before as so:
class "Schema1API" (
inherits = </APISchemaBase>
customData = {
token apiSchemaType = "singleApply"
}
) {
}
class "Schema2API" (
inherits = </Schema1API>
customData = {
token apiSchemaType = "singleApply"
}
) {
}
class "Schema3API" (
inherits = </Schema2API>
customData = {
token apiSchemaType = "singleApply"
}
) {
}
To convert these, each would be modified to inherit APISchemaBase and to
prepend the schema type they inherit as follows:
class "Schema1API" (
inherits = </APISchemaBase>
customData = {
token apiSchemaType = "singleApply"
}
) {
}
class "Schema2API" (
inherits = </APISchemaBase>
customData = {
token apiSchemaType = "singleApply"
}
prepend apiSchemas = ["Schema1API"]
) {
}
class "Schema3API" (
inherits = </APISchemaBase>
customData = {
token apiSchemaType = "singleApply"
}
prepend apiSchemas = ["Schema2API"]
) {
}
Since built-ins are recursive, we get the properties that we would
expect from all three applied schemas when applying Schema3API to a
prim, just as we would in the inheritance scenario.
#### Accessing API Schema Attributes
Unfortunately, using the API schemas becomes a bit more burdensome than
it is with inheritance. Prior to this change, a developer could modify
any of the inherited attributes via the most-derived type:
Schema3API schema3API = Schema3API::Apply(prim);
int x = schema3API.GetSchema3Attr1().Get<int>();
double y = schema3API.GetSchema2Attr1().Get<double>();
This same approach does not work with built-ins, and so it is necessary
at the current time to acquire the different API schemas in the
built-ins set to set the attributes on each appropriately:
Schema3API schema3API = Schema3API::Apply(prim);
int x = schema3API.GetSchema3Attr1().Get<int>();
Schema2API schema2API = Schema2API(prim);
double y = schema2API.GetSchema2Attr1().Get<double>();
This requires (extensively) refactoring existing code, especially for
schemas like physics that have API schemas that are heavily inheritance
based. The expectation is that this will be addressed by USD to make
this more developer friendly.
### Breaking Change: Schema Kind
From v21.02 onward, what used to be schema type is now referred to as
schema kind. This change was made to disambiguate the schema type name
(e.g. Schema1API) and what kind of schema it is (e.g. single-apply,
multiple-apply, etc.). While the impact is small, it does require:
Regeneration of the schema classes such that the GetSchemaKind
method is generated over the GetSchemaType method (which will
return a UsdSchemaKind not a UsdSchemaType
Code changes in any code that uses those methods of the schema (or
associated methods of the UsdSchemaRegistry to reflect on schema
types).
In practice, since the values of UsdSchemaKind are the same as the old
UsdSchemaType enumeration, this means replacing any code that calls
GetSchemaType with calls to GetSchemaKind and using UsdSchemaKind as the
return value, on both schema types themselves and any code involving the
UsdSchemaRegistry.
Also, if your plugInfo.json is missing the schemaKind field, it may
silently fail to load.
For details on API breakage, see:
[Other Breaking Changes: Schemas: pugInfo.json: plugInfo.json now requires schemaKind field]
### Breaking Change: Retrieving Schema Type Names
From v21.02 onward, the GetSchemaPrimSpec method on UsdPrimDefinition
has been removed. This method was used to get the “schema prim spec”,
from which the schema type name of an e.g., C++ type could be retrieved.
While there is no direct replacement on UsdPrimDefinition, similar
functionality can be found in the UsdSchemaRegistry singleton object via
the method GetSchemaTypeName:
/// Return the type name in the USD schema for prims or API schemas of
the
/// given registered \\p SchemaType.
template <class SchemaType>
static TfToken GetSchemaTypeName() {
return GetSchemaTypeName(SchemaType::_GetStaticTfType());
}
### New Feature: Auto-Applied API Schemas
An auto-applied API schema refers to a single-apply API schema that will
be automatically attached to a set of prim instances of one or more
defined schema types. This is a new feature that requires no migration
of existing schema content and has two advantages:
An existing schema set can be extended with additional attributes
without having to modify the original schema. That is, if a schema
Schema1 supplied a set of attributes, and a developer decides that
there is an additional set of attributes that are directly
relevant to prims that have Schema1 applied, then they can create
a new schema Schema2API containing those new attributes and
declare that it should be auto-applied to all prim instances of
type Schema1 (in the case of typed schemas) or for which Schema1
is applied (in the case of API schemas), without modifying Schema1
itself. In the case of IsA schemas, the auto-apply rule would
trigger on the specified schema being applied to a prim instance
as well as any inherited type of that schema being applied.
All prim instances that satisfy the auto apply to criteria
automatically get the new schema applied without developers having
to explicitly call Apply on each prim they want the schema to
apply to.
The mechanism for defining this in a schema definition is via the
apiSchemaAutoApplyTo attribute of the API schema type’s customData
dictionary. This is an array of token strings defining the names of the
schemas applied to a prim instance that trigger the auto-apply rule.
Note this is an or set, not an and set (only one of the listed schemas
need be applied to a prim instance for the auto-apply rule to trigger).
For example, if a developer wanted to auto-apply a new schema type
Schema1API to all prim instances of type UsdGeomMesh, their definition
would look as follows:
class "Schema1API" {
inherits = </APISchemaBase>
customData = {
token[] apiSchemaAutoApplyTo = ["UsdGeomMesh"]
}
}
Note that this functionality only applies to single-apply API schemas
(as multiple-apply API schemas require an instance name to be specified
on application).
The above technique is applied at schema generation time, which is
sufficient for a broad number of use cases. USD also has an additional
mechanism for supplying this information which applies later in the
pipeline (i.e. after schema generation has occurred and is distributed).
This is referred to as plugin defined auto-applied API schemas. This
allows developers to specify additional auto-apply rules that may only
affect a subset of schema consumers. While an uncommon use case, USD
allows this type of auto-apply schema to be specified directly in the
plugInfo.json file via the AutoApplyApiSchemas key contained in the
Plugins.Info key. Representing the example above in the plugInfo.json
file would look as follows:
{
"Plugins": [
"Info": {
"AutoApplyAPISchemas": {
"Schema1API" : {
"apiSchemaAutoApplyTo": [
"UsdGeomMesh"
]
}
}
}
]
}
### New Feature: Abstract Typed Schemas and the Schema Registry
Prior to v21.05, USD did not record abstract typed schemas as official
USD type names in the schema registry. This effectively meant that
developers could not refer to these abstract typed schemas in scenarios
such as auto-apply of API schemas. This minor change makes abstract
typed schemas first class citizens in the schema registry, and their
type names can be used in auto-apply scenarios to capture a large number
of prims who’s schemas are derived from the abstract schema. That is,
consider the scenario below:
Figure 1: Abstract Typed Schemas with Auto-Apply
In this case, AppliedSchema1API will be auto-applied to all prims of
type ConcreteSchema1, ConcreteSchema2, or ConcreteSchema3. Prior to this
change, AppliedSchema1API would only have been allowed to specify one
(or more) of the concrete schema types to auto-apply to.
### New Feature: Codeless Schemas
v21.08 introduced the concept of codeless schemas. These schemas have no
generated code - only the type definition. This makes them easy to
distribute, use, and iterate; providing a data contract without binary
distribution issues (although codeless schemas are still discovered
through the standard USD plug-in system). You may already be taking
advantage of this feature - it was cherry picked into NVIDIA’s v20.08
USD source and made available to usdgenschema. Codeless schemas can be
declared by adding the skipCodeGeneration attribute to the GLOBAL schema
metadata. Note that this will cause all schemas defined in the
schema.usda file to be codeless, so if you want both codeful and
codeless schemas be sure to separate out their definitions into
different schema.usda files.
As an example, let’s define a codeless schema for the following simple
scenario:
Figure 2: Codeless Schema Example
over "GLOBAL" (
customData = {
bool skipCodeGeneration = true
}
) {
}
class "Schema1API" (
inherits = </APISchemaBase>
customData = {
token apiSchemaType = "singleApply"
}
)
{
int schema1:property1 = 5 (
)
int schema1:property2 = 2 (
)
}
The downside to codeless schemas is that you don’t get the nice wrappers
for accessing properties on a prim associated with that schema that are
available through the code generation. All property access must go
through the generic API’s available on UsdPrim.
TfType schemaType =
UsdSchemaRegistry::GetAPITypeFromSchemaTypeName("Schema1API");
bool hasApi = prim.HasAPI(schemaType);
if (hasApi)
{
int schema1APIProperty1Value = 0;
int schema1APIProperty2Value = 0;
prim.GetAttribute("schema1:property1").Get<int>(&schema1APIProperty1Value);
prim.GetAttribute("schema1:property2").Get<int>(&schema1APIProperty2Value);
assert(schema1APIProperty2Value == 2);
prim.GetAttribute("schema1:property2").Set<int>(schema1APIProperty1Value);
prim.GetAttribute("schema1:property2").Get<int>(&schemaAPIProperty2Value);
assert(schema1APIProperty2Value == 5);
}
### New Feature: Additional GLOBAL Schema Metadata to Define Use of Literal Identifier Names
In v22.05, USD added the ability for schema authors to specify that
property names should be generated verbatim as written rather than the
normal behavior of camel-casing them. This is a minor change, but
helpful in scenarios where the schema.usda file is auto-generated by a
tool rather than hand authored (e.g. usdgenschemafromsdr). To invoke
this behavior, a new metadata key was added to the GLOBAL schema
metadata:
over "GLOBAL" (
customData = {
string libraryName = "exampleLibrary"
string libraryPath = "."
bool useLiteralIdentifier = true
}
)
}
Adding this metadata informs usdgenschema to attempt to use the written
property names verbatim. Note that normal rules still apply for
identifiers, and usdgenschema will make the property name a valid
identifier (via TfMakeValidIdentifier) if it is invalid, even in cases
where useLiteralIdentifier is set in the GLOBAL metadata.
### New Feature: Defining Sparse Overrides From Built-Ins
In v22.08, USD introduced the ability for an API schema to perform a
sparse override of a built-in’s property. In this scenario, an API
schema may have an opinion on the default value of a property from one
of its built-ins, without defining or owning the property itself. This
is functionally similar to an over for the property, where the API
schema defines a stronger opinion of the default value. Consider the
following:
Figure 3: Sparse Overrides on Built-Ins
This new functionality can be taken advantage of by adding the
apiSchemaOverride to the customData dictionary of the property.
class "Schema1API" (
) {
uniform int schema1:property = 5 (
)
}
class "Schema2API" (
prepend apiSchemas = ["Schema1API"]
) {
uniform int schema1:property = 2 (
customData = {
bool apiSchemaOverride = true
}
)
}
In this scenario, Schema2API has declared Schema1API a built-in and
provided a sparse override of the schema1:property default value. Note
that when doing this, the property must be declared with the exact same
type and variability (e.g., uniform int in the above example), otherwise
the override is ignored. Also note that this functionality is only
available to API schemas and does not apply to overriding properties via
IsA schema inheritance.
## Ar 2 (Asset Resolution Re-architecture)
### Introduction
The public interface to Ar (Asset Resolution) has changed significantly,
hence the version change from 1.0 to 2.0. While it is a significant
change, the functionality is mostly the same but provides better hooks
for cloud-based asset backends such as Nucleus. The parts of Ar that
changed mostly relate to removed and renamed methods. In most
circumstances, methods were removed since they really only applied to
Pixar’s way of resolving assets. Other methods were renamed to more
accurately convey their intent.
### Breaking Change: IsSearchPath() Removed
Search paths are no longer a part of the public interface of Ar 2.0.
This was done for good reason as not all asset management systems
support search paths. Internally, an implementation of Ar 2.0 can
support search paths but there is no publicly available method such as
ArGetResolver().IsSearchPath(). Originally, this method was made a part
of the public Ar interface so Sdf could perform the “look here first”
approach when resolving an SdfAssetPath that fit the criteria of a
search path. If you are using ArGetResolver().IsSearchPath() it might be
a good time to assess why you are using it before migrating your code as
there is not an out-of-the-box solution. If
ArGetResolver().IsSearchPath() is used in a lot of places we could add a
utility function to mimic it’s behavior.
In order to migrate your code to check if an asset path is a search path
it will need to pass the following checks:
It is not a URL prefixed with a scheme such as omniverse:// or
https://
It is not an absolute file path i.e starting with / or \
It is not a file relative path:
a. Does not start with ./ or ../
b. Does not start with .\ or ..\
A C++ implementation would be:
// Add the C++ Implementation similar to what we are using in
OmniUsdResolver_Ar1.cpp
For details on API breakage, see:
API Breaking Changes: Ar.Resolver: IsSearchPath() Removed
### Breaking Change: IsRelativePath() Removed
As a part of the process to decouple assets from the filesystem,
ArGetResolver().IsRelativePath() was also removed. While sometimes
useful, it also made for a confusing API when paired with
ArGetResolver().AnchorRelativePath(). It would make the caller think
that you need to check if the asset path was relative before calling
ArGetResolver().AnchorRelativePath() which was not always the case. If
you find that you’re calling ArGetResolver().IsRelativePath() on asset
paths before ArGetResolver().AnchorRelativePath() a better way to
migrate your code would be to use a utility from Sdf:
auto stage = UsdStage::Open(“omniverse://some/asset.usd”);
const std::string assetPath = “./geom.usd”;
// SdfComputeAssetPathRelativeToLayer works for both Ar 1.0 and Ar 2.0
// It will also handle all the edge cases dealing with things like
anonymous layers,
// package relative paths, etc.
const std::string assetId = SdfComputeAssetPathRelativeToLayer(stage->GetRootLayer(), assetPath);
If you find that you do need to check if some string is relative,
TfIsRelativePath() could be used. But it’s important to understand that
TfIsRelativePath() will only work with filesystem paths. For example,
TfIsRelativePath(“omniverse://some/asset.usd”) would return true. So
only use TfIsRelativePath() if you’re sure it’s a filesystem path and
not a URL.
For details on API breakage, see:
API Breaking Changes: Ar.Resolver: IsRelativePath() Removed
### Breaking Change: AnchorRelativePath() Renamed
ArGetResolver().AnchorRelativePath() was correctly renamed to
ArGetResolver().CreateIdentifier(). The reason for this method being
renamed is to clarify its intent which is to create an identifier for an
incoming asset path. The incoming asset path may or may not be relative,
but ArGetResolver().AnchorRelativePath() was always called to make sure
the returned result was a valid identifier that could be consistently
resolved.
const std::string anchor = "omniverse://some/asset.usd";
const std::string assetPath = "./geom.usd";
##if !defined(AR_VERSION) || AR_VERSION < 2
// Ar 1.0
const std::string identifierAr1 =
ArGetResolver().AnchorRelativePath(anchor, assetPath);
##else
// Ar 2.0 - The ArResolvedPath is required for the anchor to indicate to
the ArResolver plugin
// implementing _CreateIdentifier that the anchor has already been
resolved
const ArResolvedPath resolvedAnchor(anchor);
// Ar 2.0 - Note how the anchor and asset path order are switched
const std::string identifierAr2 =
ArGetResolver().CreateIdentifier(assetPath, resolvedAnchor);
##endif
For details on API breakage, see:
API Breaking Changes: Ar.Resolver: AnchorRelativePath() to CreateIdentifier()
### Breaking Change: ComputeNormalizedPath() Removed
ArGetResolver().ComputeNormalizedPath() has been removed since in most
cases it was a redundant call. Most ArResolver plugins would return the
normalized form of an incoming asset path in
ArGetResolver().AnchorRelativePath(). However,
ArGetResolver().AnchorRelativePath() was vague as to the expected
result. ArGetResolver().CreateIdentifier() clarifies that its returned
result should be in its final normalized form.
For details on API breakage, see:
API Breaking Changes: Ar.Resolver: ComputeNormalizedPath() Removed
### Breaking Change: ComputeRepositoryPath() Removed
ArGetResolver().ComputeRepositoryPath() has been removed. A repository
path, or repoPath, was a very Pixar specific way of identifying their
assets within Perforce. For the majority of their assets they could
compute the resolved path or local path to a repository path
(identifier) in Perforce. In some ArResolver plugins a resolved path can
not be computed to its repository path (identifier). For this reason, an
ArResolver plugin would just return the incoming path as-is and adds to
a confusing ArResolver interface.
In order to migrate your code the call to
ArGetResolver().ComputeRepositoryPath() should just be removed. The
OmniUsdResolver would just return the incoming path, nothing was
actually computed since client-library does not support converting a
resolved cached path to the URL it was resolved from.
For details on API breakage, see:
API Breaking Changes: Ar.Resolver: ComputeRepositoryPath() Removed
### Breaking Change: ComputeLocalPath() Removed
ComputeLocalPath() has been removed and replaced with more accurately
named methods. In Ar 1.0, ComputeLocalPath() was called in
SdfLayer::CreateNew to redirect a new layer to some local path on disk
so it could still resolve. Ar 2.0 clarifies the interface by adding
CreateIdentifierForNewAsset / ResolveForNewAsset methods
const std::string assetPath = "omniverse://some/new/asset.usd";
// Not completely necessary but makes sure the assetPath is absolute +
normalized
const std::string identifier = ArGetResolver().CreateIdentifierForNewAsset(assetPath);
const ArResolvedPath resolvedPath = ArGetResolver().ResolveForNewAsset(identifier);
For details on API breakage, see:
API Breaking Changes: Ar.Resolver: ComputeLocalPath() Removed
### Breaking Change: Resolve() Signature Changed
Resolve() has changed the return type from std::string to
ArResolvedPath. The ArResolvedPath type is just a shim around
std::string to clarify the interface when an ArResolver plugin can
expect to receive a resolved path. One of the confusing aspects of Ar
1.0 for an ArResolver plugin implementation was when you were receiving
an unresolved asset path or a fully resolved path. This led to numerous
subtle bugs when the plugin would assume a resolved path but would
actually be receiving an asset path since everything was just typed from
std::string.
The code required to support this change can be done in a few different
ways and should be handled according to preference or coding style:
const std::string assetPath = "omniverse://some/asset.usd";
// In Ar 1.0
const std::string resolvedPath = ArGetResolver().Resolve(assetPath);
// In Ar 2.0
const ArResolvedPath resolvedPath = ArGetResolver().Resolve(assetPath);
// or to support Ar 1.0 + Ar 2.0
auto resolvedPath = ArGetResolver().Resolve(assetPath);
Another very important aspect of Resolve() is that USD no longer assumes
that the returned result will point to a normal file path on disk! It is
expected that Resolve() can return things such as URIs where any file
system calls, i.e ArchOpenFile() and ArchGetFileLength(), will not work
correctly and more than likely fail. If you are currently using any file
system operations on a resolved asset path your code should be updated
to use the ArAsset / ArWritableAsset abstractions so you can properly
read / write data. See the sections on OpenAsset() / OpenAssetForWrite()
for examples on reading / writing.
For details on API breakage, see:
API Breaking Changes: Ar.Resolver: Resolve() Signature Changed
### Breaking Change: ResolveWithAssetInfo() Removed
ResolveWithAssetInfo() has been removed and separated into two methods;
Resolve() and GetAssetInfo(). GetAssetInfo() accepts an asset path and
an ArResolvedPath as input to accurately find all the information
related to the asset. The ArResolvedPath can help with asset management
systems that might need the identifier, along with the resolved result
of that identifier to accurately return the ArAssetInfo with all the
correct information.
// In Ar 1.0
// Note that assetPath would typically be the identifier returned from
AnchorRelativePath()
const std::string assetPath = "omniverse://some/asset.usd";
ArAssetInfo assetInfo;
const std::string resolvedPath = ArGetResolver().ResolveWithAssetInfo(assetPath, &assetInfo);
// In Ar 2.0
const std::string assetPath = "omniverse://some/asset.usd";
const ArResolvedPath resolvedPath = ArGetResolver().Resolve(assetPath);
ArAssetInfo assetInfo = ArGetResolver().GetAssetInfo(assetPath,
resolvedPath);
For details on API breakage, see:
API Breaking Changes: Ar.Resolver: ResolveWithAssetInfo() Removed
### Breaking Change: GetModificationTimestamp() Signature Changed
GetModificationTimestamp() is another method that changes the return
type to clarify what was expected to be returned for ArResolver plugin
implementations. The return type for GetModificationTimestamp() changed
from a VtValue to an ArTimestamp. The ArTimestamp is a more suitable
type for external APIs to correctly sort and compare an asset’s
modification timestamp due to its guaranteed comparison overload
operators. These operators are important for a library such as Sdf to
correctly reload layers, since the asset representing the SdfLayer needs
to be sorted and compared based on the time the asset was last modified.
// In Ar 1.0
// Note that assetPath would typically be the identifier returned from
AnchorRelativePath()
const std::string assetPath = "omniverse://some/asset.usd";
const std::string resolvedPath = ArGetResolver().Resolve(assetPath);
VtValue timestamp = ArGetResolver().GetModificationTimestamp(assetPath,
resolvedPath);
// In Ar 2.0
const std::string assetPath = "omniverse://some/asset.usd";
const ArResolvedPath resolvedPath = ArGetResolver().Resolve(assetPath);
ArTimestamp ts = ArGetResolver().GetModificationTimestamp(assetPath,
resolvedPath);
For details on API breakage, see:
API Breaking Changes: Ar.Resolver: GetModificationTimestamp() Signature Changed
### Breaking Change: OpenAsset() and ArAsset Signature Changes
The change will mostly affect ArResolver plugin implementations, but is
still a breaking change. OpenAsset() has changed its signature to ensure
const-correctness. In Ar 1.0 this seemed like a bug, or oversight, where
an ArResolver plugin would modify its own state when opening an asset
for reading. This has been corrected in Ar 2.0 to guarantee that
OpenAsset() is indeed const and will not modify its own state. The only
required change here is for ArResolver plugin implementations to update
their function signatures to mark it as const-qualified. This change
also allows a const-qualified function to call
ArGetResolver().OpenAsset() along with the virtual methods exposed by
ArAsset such as GetSize(), GetBuffer(), Read(), etc.
Additionally, the type of resolvedPath has changed from a std::string to
an ArResolvedPath.
Using OpenAsset() for reading assets has been supported since Ar 1.0.
But now that ArGetResolver().Resolve() no longer assumes a file path on
disk being returned, it’s very important to use OpenAsset() when data
needs to be read from an asset path. Typical usage can look like the
following:
// In Ar 2.0
const std::string assetPath = "omniverse://some/asset.usd";
const ArResolvedPath resolvedPath = ArGetResolver().Resolve(assetPath);
auto asset = ArGetResolver().OpenAsset(resolvedPath);
if (asset) {
// get the buffer to read data into
std::shared_ptr<const char> buffer = asset->GetBuffer();
if (!buffer) {
TF_RUNTIME_ERROR("Failed to GetBuffer()");
return;
}
size_t bytesRead = asset->Read(buffer.get(), asset->GetSize(), 0);
if (bytesRead == 0) {
TF_RUNTIME_ERROR("Failed to read asset");
return;
}
// buffer should now contain bytesRead chars read from resolvedPath
}
For details on API breakage, see:
API Breaking Changes: Ar.Resolver: OpenAsset() / ArAsset Signature Changes
### New Feature: OpenAssetForWrite() and ArWritableAsset
One of the big features of Ar 2.0 is the ability to write data directly
to the underlying asset management system in an abstracted, and
extendable, way. ArGetResolver().OpenAssetForWrite() is a hook in an
ArResolver plugin implementation to assist and control how something is
written to the asset management system. This new feature allows for
things like streaming writes without the need to directly link against
custom libraries like client-library. This greatly simplifies the
process of getting new assets into asset management systems such as
Nucleus, and is natively supported across all of USD through facilities
like SdfFileFormat plugins. A very naive implementation could look
something like the following:
// In Ar 2.0
const std::string assetPath = "omniverse://some/asset.usd";
// if writing to an existing asset
const ArResolvedPath resolvedPath = ArGetResolver().Resolve(assetPath);
// or if writing to a new asset
const ArResolvedPath resolvedPath = ArGetResolver().ResolveForNewAsset(assetPath);
// create a buffer that contains the data we want to write
const size_t bufferSize = 4096;
std::unique_ptr<char[]> buffer(new char[bufferSize]);
// put some data into the buffer
const std::string data = "some asset data";
memcpy(buffer.get(), data.c_str(), data.length());
// open the asset for writing
auto writableAsset = ArGetResolver().OpenAssetForWrite(resolvedPath, ArResolver::WriteMode::Replace);
if (writableAsset) {
const size_t bytesWritten = writabelAsset->Write(buffer.get(),
data.length(), 0);
if (bytesWritten == 0) {
TF_RUNTIME_ERROR(\"Failed to write asset\");
return;
}
// close out the asset to indicate that all data has been written
asset->Close();
}
### New Feature: ArAsset Detached Assets
Detached assets are a new way to completely separate an ArAsset from the underlying asset management system. In some
asset management systems its possible for assets to continuously receive updates. Updates like this can cause
instability if the asset is in the process of being read into memory and the asset changes from underneath it.
GetDetachedAsset() on ArAsset is a place for an ArResolver plugin to perform any necessary steps to ensure that the
returned ArAsset will be consistent for reads throughout its lifetime.
## API Breaking Changes
## Base
### Arch
### Arch Filesystem
#### ArchFile removed
TODO
## Tf
### pxr Tf Python Module
Reference Commits:
Centralize Python module initialization logic
Python Find Regex:
from +. +import +(.*)[\r\n+]from +pxr +import +Tf[\r\n]+Tf.PrepareModule \( \1 , *locals\(\) *\)[\r\n]+del Tf(?:((?:[\r\n]+.))[\r\n]*try:[\r\n]+([ \t]+)import +__DOC(?:.|\r|\n)*[\r\n]except +Exception:(?:[r\n]+\3.)+)?
Python Replace Regex:
from pxr import Tf\nTf.PreparePythonModule()\ndel Tf
Python Example Before:
from . import _usdMdlfrom pxr import TfTf.PrepareModule(_usdMdl, locals())del Tftry: import __DOC __DOC.Execute(locals()) del __DOCexcept Exception: try: import __tmpDoc __tmpDoc.Execute(locals()) del __tmpDocfailed except: pass
Python Example After (22.11+ only):
from pxr import TfTf.PreparePythonModule()del Tf
Python Example After (branched):
from pxr import Tfif hasattr(Tf, “PreparePythonModule”): Tf.PreparePythonModule() del Tfelse: from . import _usdMdl Tf.PrepareModule(_usdMdl, locals()) del Tf try: import __DOC __DOC.Execute(locals()) del __DOC except Exception: try: import __tmpDoc __tmpDoc.Execute(locals()) del __tmpDocfailed except: pass
Python Error Strings:
ImportError: DLL load while importing {MODULE}: The specified module could not be found.WARNING The above is a very general error, and could also be triggered by other issues unrelated to this PrepareModule to PreparePythonModule change
#### PrepareModule to PreparePythonModule
## Usd
### Ar
#### Ar Resolver
##### IsSearchPath() Removed
For a detailed explanation, see: Breaking Change: IsSearchPath() Removed
Reference Commits:
* [ar 2.0] Add identifier API to ArResolver* [ar 2.0] Remove filesystem path operations during layer lookup* [ar 2.0] Deprecate ArResolver functions slated for removal* [ar 2.0] Remove deprecated relative/search path API from ArResolver* [ar 2.0] Remove Ar 1.0 implementation* [ar 2.0] Remove Ar 1.0 support from sdf* [ar 2.0] Remove Ar 1.0 support from pcp* [ar 2.0] Remove Ar 1.0 support from usdUtils
C++ Find Regex:
(?<=\W)IsSearchPath(?=\W)NOTE: IsSearchPath was never wrapped in python, so no python changes are necessary
C++ Error Strings (Linux):
* ‘class pxrInternal_v0_22__pxrReserved__::ArResolver’ has no member named ‘IsSearchPath’
C++ Error Strings (Windows):
* E0135 class “pxrInternal_v0_22__pxrReserved__::ArResolver” has no member “IsSearchPath”* C2039 ‘IsSearchPath’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::ArResolver’
##### IsRelativePath() Removed
For a detailed explanation, see: Breaking Change: IsRelativePath() Removed
Reference Commits:
* [ar 2.0] Add identifier API to ArResolver* [ar 2.0] Remove deprecated relative/search path API from ArResolver* [ar 2.0] Remove Ar 1.0 implementation* [ar 2.0] Remove Ar 1.0 support from sdf* [ar 2.0] Remove Ar 1.0 support from usdUtils
C++/Python Find Regex:
(?<=\W)IsRelativePath(?=\W)
C++ Example Before:
SdfLayerHandle layer = stage->GetRootLayer(); std::string assetId(“my/path.foo”); ArResolver& resolver = ArGetResolver(); if (resolver.IsRelativePath(assetId)) { std::string anchorPath = layer->GetIdentifier(); assetId = resolver.AnchorRelativePath(anchorPath, assetId); } std::string resolvedPath = resolver.Resolve(assetId);
C++ Example After (all versions):
SdfLayerHandle layer = stage->GetRootLayer(); std::string assetId(“my/path.foo”); assetId = SdfComputeAssetPathRelativeToLayer(layer, assetId); std::string resolvedPath = ArGetResolver().Resolve(assetId);
Python Example Before:
from pxr import Ar, Usdstage = Usd.Stage.CreateInMemory()layer = stage.GetRootLayer()assetId = “my/path.foo”resolver = Ar.GetResolver()if resolver.IsRelativePath(assetId): anchorPath = layer.identifier assetId = resolver.AnchorRelativePath(anchorPath, assetId)resolvedPath = resolver.Resolve(assetId)
Python Example After (all versions):
from pxr import Ar, Usdstage = Usd.Stage.CreateInMemory()layer = stage.GetRootLayer()assetId = “my/path.foo”resolver = Ar.GetResolver()if resolver.IsRelativePath(assetId): anchorPath = layer.identifier assetId = resolver.AnchorRelativePath(anchorPath, assetId)resolvedPath = resolver.Resolve(assetId)
C++ Error Strings (Linux):
* ‘class pxrInternal_v0_22__pxrReserved__::ArResolver’ has no member named ‘IsRelativePath’
C++ Error Strings (Windows):
* E0135 class “pxrInternal_v0_22__pxrReserved__::ArResolver” has no member “IsRelativePath”* C2039 ‘IsRelativePath’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::ArResolver’
Python Error Strings:
* AttributeError: ‘Resolver’ object has no attribute ‘IsRelativePath’
##### AnchorRelativePath() to CreateIdentifier()
For a detailed explanation, see: Breaking Change: AnchorRelativePath() Renamed
Reference Commits:
* [ar 2.0] Add identifier API to ArResolver* [ar 2.0] Remove deprecated relative/search path API from ArResolver* [ar 2.0] Remove Ar 1.0 implementation* [ar 2.0] Remove Ar 1.0 support from sdf
C++/Python Find Regex:
(?<=\W)AnchorRelativePath(?=\W)
C++ Example Before:
const std::string anchor = “omniverse://some/asset.usd”;const std::string assetPath = “./geom.usd”;// Ar 1.0const std::string identifier = ArGetResolver().AnchorRelativePath(anchor, assetPath);
C++ Example After (AR2 only):
const std::string anchor = “omniverse://some/asset.usd”;const std::string assetPath = “./geom.usd”;// Ar 2.0 - The ArResolvedPath is required for the anchor to indicate to the ArResolver// plugin implementing _CreateIdentifier that the anchor has already been resolvedconst ArResolvedPath resolvedAnchor(anchor);// Ar 2.0 - Note how the anchor and asset path order are switchedconst std::string identifier = ArGetResolver().CreateIdentifier(assetPath, resolvedAnchor);
C++ Example After (branched):
const std::string anchor = “omniverse://some/asset.usd”;const std::string assetPath = “./geom.usd”;#if defined(AR_VERSION) && AR_VERSION > 1// Ar 2.0 - The ArResolvedPath is required for the anchor to indicate to the ArResolver// plugin implementing _CreateIdentifier that the anchor has already been resolvedconst ArResolvedPath resolvedAnchor(anchor);// Ar 2.0 - Note how the anchor and asset path order are switchedconst std::string identifier = ArGetResolver().CreateIdentifier(assetPath, resolvedAnchor);#else// Ar 1.0const std::string identifier = ArGetResolver().AnchorRelativePath(anchor, assetPath);#endif
Python Example Before:
from pxr import Aranchor = “omniverse://some/asset.usd”assetPath = “./geom.usd”# Ar 1.0identifier = Ar.GetResolver().AnchorRelativePath(anchor, assetPath)
Python Example After (AR2 only):
from pxr import Aranchor = “omniverse://some/asset.usd”assetPath = “./geom.usd”# Ar 2.0 - The Ar.ResolvedPath is required for the anchor to indicate to the ArResolver# plugin implementing _CreateIdentifier that the anchor has already been resolvedresolvedAnchor = Ar.ResolvedPath(anchor)# Ar 2.0 - Note how the anchor and asset path order are switchedidentifier = Ar.GetResolver().CreateIdentifier(assetPath, resolvedAnchor)
Python Example After (branched):
from pxr import Aranchor = “omniverse://some/asset.usd”assetPath = “./geom.usd”resolver = Ar.GetResolver()if hasattr(resolver, “CreateIdentifier”): # Ar 2.0 - The Ar.ResolvedPath is required for the anchor to indicate to the ArResolver # plugin implementing _CreateIdentifier that the anchor has already been resolved resolvedAnchor = Ar.ResolvedPath(anchor) # Ar 2.0 - Note how the anchor and asset path order are switched identifier = resolver.CreateIdentifier(assetPath, resolvedAnchor)else: # Ar 1.0 identifier = resolver.AnchorRelativePath(anchor, assetPath)
C++ Error Strings (Linux):
* ‘class pxrInternal_v0_22__pxrReserved__::ArResolver’ has no member named ‘AnchorRelativePath’
C++ Error Strings (Windows):
* E0135 class “pxrInternal_v0_22__pxrReserved__::ArResolver” has no member “AnchorRelativePath”* C2039 ‘AnchorRelativePath’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::ArResolver’
Python Error Strings:
* AttributeError: ‘Resolver’ object has no attribute ‘AnchorRelativePath’
##### ComputeNormalizedPath() Removed
For a detailed explanation, see: Breaking Change: ComputeNormalizedPath() Removed
Reference Commits:
* [ar 2.0] Remove ArResolver::ComputeNormalizedPath* [ar 2.0] Remove Ar 1.0 implementation* [ar 2.0] Remove Ar 1.0 support from sdf* [ar 2.0] Remove Ar 1.0 support from usdUtils
C++ Find Regex:
(?<=\W)ComputeNormalizedPath(?=\W)NOTE: ComputeNormalizedPath was never wrapped in python, so no python changes are necessary
C++ Example Before:
const std::string assetPath = “./geom.usd”; const std::string anchor = “omniverse://some/asset.usd”; ArResolver& resolver = ArGetResolver(); // Ar 1.0 - in theory, AnchorRelativePath might not return final normalized form const std::string normalized_id = resolver.ComputeNormalizedPath( resolver.AnchorRelativePath(anchor, assetPath));
C++ Example After (AR2 only):
const std::string assetPath = “./geom.usd”; const ArResolvedPath anchor(“omniverse://some/asset.usd”); ArResolver& resolver = ArGetResolver(); // Ar 2.0 - CreateIdentifier should always return final normalized form const std::string normalized_id = resolver.CreateIdentifier(assetPath, anchor);
C++ Example After (branched):
const std::string assetPath = “./geom.usd”; ArResolver& resolver = ArGetResolver();#if defined(AR_VERSION) && AR_VERSION > 1 // Ar 2.0 - CreateIdentifier should always return final normalized form const ArResolvedPath anchor(“omniverse://some/asset.usd”); const std::string normalized_id = resolver.CreateIdentifier(assetPath, anchor);#else // Ar 1.0 - in theory, AnchorRelativePath might not return final normalized form const std::string anchor = “omniverse://some/asset.usd”; const std::string normalized_id = resolver.ComputeNormalizedPath( resolver.AnchorRelativePath(anchor, assetPath));#endif
C++ Error Strings (Linux):
* ‘class pxrInternal_v0_22__pxrReserved__::ArResolver’ has no member named ‘ComputeNormalizedPath’
C++ Error Strings (Windows):
* E0135 class “pxrInternal_v0_22__pxrReserved__::ArResolver” has no member “ComputeNormalizedPath”* C2039 ‘ComputeNormalizedPath’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::ArResolver’
##### ComputeRepositoryPath() Removed
For a detailed explanation, see: Breaking Change: ComputeRepositoryPath() Removed
Reference Commits:
* [ar 2.0] Remove ArResolver::ComputeNormalizedPath* [ar 2.0] Remove Ar 1.0 implementation* [ar 2.0] Remove Ar 1.0 support from sdf* [ar 2.0] Remove Ar 1.0 support from usdUtils
C++ Find Regex:
(?<=\W)ComputeNormalizedPath(?=\W)NOTE: ComputeNormalizedPath was never wrapped in python, so no python changes are necessary
C++ Example Before:
const std::string assetPath = “./geom.usd”; const std::string anchor = “omniverse://some/asset.usd”; ArResolver& resolver = ArGetResolver(); // Ar 1.0 - in theory, AnchorRelativePath might not return final normalized form const std::string normalized_id = resolver.ComputeNormalizedPath( resolver.AnchorRelativePath(anchor, assetPath));
C++ Example After (AR2 only):
const std::string assetPath = “./geom.usd”; const ArResolvedPath anchor(“omniverse://some/asset.usd”); ArResolver& resolver = ArGetResolver(); // Ar 2.0 - CreateIdentifier should always return final normalized form const std::string normalized_id = resolver.CreateIdentifier(assetPath, anchor);
C++ Example After (branched):
const std::string assetPath = “./geom.usd”; ArResolver& resolver = ArGetResolver();#if defined(AR_VERSION) && AR_VERSION > 1 // Ar 2.0 - CreateIdentifier should always return final normalized form const ArResolvedPath anchor(“omniverse://some/asset.usd”); const std::string normalized_id = resolver.CreateIdentifier(assetPath, anchor);#else // Ar 1.0 - in theory, AnchorRelativePath might not return final normalized form const std::string anchor = “omniverse://some/asset.usd”; const std::string normalized_id = resolver.ComputeNormalizedPath( resolver.AnchorRelativePath(anchor, assetPath));#endif
C++ Error Strings (Linux):
* ‘class pxrInternal_v0_22__pxrReserved__::ArResolver’ has no member named ‘ComputeNormalizedPath’
C++ Error Strings (Windows):
* E0135 class “pxrInternal_v0_22__pxrReserved__::ArResolver” has no member “ComputeNormalizedPath”* C2039 ‘ComputeNormalizedPath’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::ArResolver’
##### ComputeLocalPath() Removed
For a detailed explanation, see: Breaking Change: ComputeLocalPath() Removed
Reference Commits:
* [ar 2.0] Introduce ArResolver::ResolveForNewAsset* [ar 2.0] Remove Ar 1.0 implementation* [ar 2.0] Remove Ar 1.0 support from sdf
C++ Find Regex:
(?<=\W)ComputeLocalPath(?=\W)NOTE: ComputeRepositoryPath was never wrapped in python, so no python changes are necessary
C++ Example Before:
const std::string assetPath = “omniverse://some/new/asset.usd”; const std::string resolvedPath = ArGetResolver().ComputeLocalPath(assetPath);
C++ Example After (AR2 only):
const std::string assetPath = “omniverse://some/new/asset.usd”; ArResolver& resolver = ArGetResolver(); // Not completely necessary but makes sure the assetPath is absolute + normalized const std::string identifier = resolver.CreateIdentifierForNewAsset(assetPath); const ArResolvedPath resolvedPath = resolver.ResolveForNewAsset(identifier);
C++ Example After (branched):
const std::string assetPath = “omniverse://some/new/asset.usd”;#if defined(AR_VERSION) && AR_VERSION > 1 ArResolver& resolver = ArGetResolver(); // Not completely necessary but makes sure the assetPath is absolute + normalized const std::string identifier = resolver.CreateIdentifierForNewAsset(assetPath); const ArResolvedPath resolvedPath = resolver.ResolveForNewAsset(identifier);#else const std::string resolvedPath = ArGetResolver().ComputeLocalPath(assetPath);#endif
C++ Error Strings (Linux):
* ‘class pxrInternal_v0_22__pxrReserved__::ArResolver’ has no member named ‘ComputeLocalPath’
C++ Error Strings (Windows):
* E0135 class “pxrInternal_v0_22__pxrReserved__::ArResolver” has no member “ComputeLocalPath”* C2039 ‘ComputeLocalPath’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::ArResolver’
##### Resolve() Signature Changed
For a detailed explanation, see: Breaking Change: Resolve() Signature Changed
Also see: GetResolvedPath return type changed
Reference Commits:
* [ar 2.0] Update Resolve API on ArResolver* [ar 2.0] Add identifier API to ArResolver* [ar 2.0] Remove Ar 1.0 implementation* [ar 2.0] Remove Ar 1.0 support from sdf* [ar 2.0] Remove Ar 1.0 support from pcp
C++/Python Find Regex:
(?<=\W)Resolve\(
C++ Example Before:
const std::string assetPath = “omniverse://some/new/asset.usd”;ArResolver& resolver = ArGetResolver();const std::string resolvedPath = resolver.Resolve(assetPath);auto myAsset = resolver.OpenAsset(resolvedPath);
C++ Example After (AR2 only):
const std::string assetPath = “omniverse://some/new/asset.usd”;ArResolver& resolver = ArGetResolver();const ArResolvedPath resolvedPath = resolver.Resolve(assetPath);auto myAsset = resolver.OpenAsset(resolvedPath);
C++ Example After (all versions):
const std::string assetPath = “omniverse://some/new/asset.usd”;ArResolver& resolver = ArGetResolver();auto resolvedPath = resolver.Resolve(assetPath);auto myAsset = resolver.OpenAsset(resolvedPath);
Python Example Before:
NOTE: in most contexts, you will feed the resolves of Resolve() to a function that now expects an Ar.ResolvedPath object, such as ArResolver.CreateIdentifier, so NO CHANGES are neededHowever, if you formerly attempted to use the resolved path as a string, changes will be required:from pxr import ArassetPath = “omniverse://some/new/asset.usd”resolvedPath = Ar.GetResolver().Resolve(assetPath)resolvedPath.split(“/”)
Python Example After (all versions):
from pxr import ArassetPath = “omniverse://some/new/asset.usd”resolvedPath = str(Ar.GetResolver().Resolve(assetPath))resolvedPath.split(“/”)
C++ Error Strings (Linux):
* cannot convert ‘const string’ {aka ‘const std::__cxx11::basic_string<char>’} to ‘const pxrInternal_v0_22__pxrReserved__::ArResolvedPath&’
C++ Error Strings (Windows):
* E0312 no suitable user-defined conversion from “const std::string” to “const pxrInternal_v0_22__pxrReserved__::ArResolvedPath” exists* C2664 ‘std::shared_ptr<pxrInternal_v0_22__pxrReserved__::ArAsset> pxrInternal_v0_22__pxrReserved__::ArResolver::OpenAsset(const pxrInternal_v0_22__pxrReserved__::ArResolvedPath &) const’: cannot convert argument 1 from ‘const std::string’ to ‘const pxrInternal_v0_22__pxrReserved__::ArResolvedPath &’* C2664 ‘pxrInternal_v0_22__pxrReserved__::ArTimestamp pxrInternal_v0_22__pxrReserved__::ArResolver::GetModificationTimestamp(const std::string &,const pxrInternal_v0_22__pxrReserved__::ArResolvedPath &) const’: cannot convert argument 2 from ‘const std::string’ to ‘const pxrInternal_v0_22__pxrReserved__::ArResolvedPath &’* C2664 ‘std::shared_ptr<pxrInternal_v0_22__pxrReserved__::ArFilesystemAsset> pxrInternal_v0_22__pxrReserved__::ArFilesystemAsset::Open(const pxrInternal_v0_22__pxrReserved__::ArResolvedPath &)’: cannot convert argument 1 from ‘const std::string’ to ‘const pxrInternal_v0_22__pxrReserved__::ArResolvedPath &’* C2664 ‘pxrInternal_v0_22__pxrReserved__::ArTimestamp pxrInternal_v0_22__pxrReserved__::ArFilesystemAsset::GetModificationTimestamp(const pxrInternal_v0_22__pxrReserved__::ArResolvedPath &)’: cannot convert argument 1 from ‘const std::string’ to ‘const pxrInternal_v0_22__pxrReserved__::ArResolvedPath &’* C2664 ‘std::shared_ptr<pxrInternal_v0_22__pxrReserved__::ArFilesystemWritableAsset> pxrInternal_v0_22__pxrReserved__::ArFilesystemWritableAsset::Create(const pxrInternal_v0_22__pxrReserved__::ArResolvedPath &,pxrInternal_v0_22__pxrReserved__::ArResolver::WriteMode)’: cannot convert argument 1 from ‘const std::string’ to ‘const pxrInternal_v0_22__pxrReserved__::ArResolvedPath &’* C2664 ‘std::string pxrInternal_v0_22__pxrReserved__::ArResolver::CreateIdentifier(const std::string &,const pxrInternal_v0_22__pxrReserved__::ArResolvedPath &) const’: cannot convert argument 2 from ‘const std::string’ to ‘const pxrInternal_v0_22__pxrReserved__::ArResolvedPath &’* C2664 ‘std::string pxrInternal_v0_22__pxrReserved__::ArResolver::CreateIdentifierForNewAsset(const std::string &,const pxrInternal_v0_22__pxrReserved__::ArResolvedPath &) const’: cannot convert argument 2 from ‘const std::string’ to ‘const pxrInternal_v0_22__pxrReserved__::ArResolvedPath &’* C2664 ‘pxrInternal_v0_22__pxrReserved__::ArAssetInfo pxrInternal_v0_22__pxrReserved__::ArResolver::GetAssetInfo(const std::string &,const pxrInternal_v0_22__pxrReserved__::ArResolvedPath &) const’: cannot convert argument 2 from ‘const std::string’ to ‘const pxrInternal_v0_22__pxrReserved__::ArResolvedPath &’* C2664 ‘std::shared_ptr<pxrInternal_v0_22__pxrReserved__::ArWritableAsset> pxrInternal_v0_22__pxrReserved__::ArResolver::OpenAssetForWrite(const pxrInternal_v0_22__pxrReserved__::ArResolvedPath &,pxrInternal_v0_22__pxrReserved__::ArResolver::WriteMode) const’: cannot convert argument 1 from ‘const std::string’ to ‘const pxrInternal_v0_22__pxrReserved__::ArResolvedPath &’* C2664 ‘bool pxrInternal_v0_22__pxrReserved__::ArResolver::CanWriteAssetToPath(const pxrInternal_v0_22__pxrReserved__::ArResolvedPath &,std::string *) const’: cannot convert argument 1 from ‘const std::string’ to ‘const pxrInternal_v0_22__pxrReserved__::ArResolvedPath &’
Python Error Strings:
* AttributeError: ‘ResolvedPath’ object has no attribute ‘capitalize’* AttributeError: ‘ResolvedPath’ object has no attribute ‘casefold’* AttributeError: ‘ResolvedPath’ object has no attribute ‘center’* AttributeError: ‘ResolvedPath’ object has no attribute ‘count’* AttributeError: ‘ResolvedPath’ object has no attribute ‘encode’* AttributeError: ‘ResolvedPath’ object has no attribute ‘endswith’* AttributeError: ‘ResolvedPath’ object has no attribute ‘expandtabs’* AttributeError: ‘ResolvedPath’ object has no attribute ‘find’* AttributeError: ‘ResolvedPath’ object has no attribute ‘format’* AttributeError: ‘ResolvedPath’ object has no attribute ‘format_map’* AttributeError: ‘ResolvedPath’ object has no attribute ‘index’* AttributeError: ‘ResolvedPath’ object has no attribute ‘isalnum’* AttributeError: ‘ResolvedPath’ object has no attribute ‘isalpha’* AttributeError: ‘ResolvedPath’ object has no attribute ‘isascii’* AttributeError: ‘ResolvedPath’ object has no attribute ‘isdecimal’* AttributeError: ‘ResolvedPath’ object has no attribute ‘isdigit’* AttributeError: ‘ResolvedPath’ object has no attribute ‘isidentifier’* AttributeError: ‘ResolvedPath’ object has no attribute ‘islower’* AttributeError: ‘ResolvedPath’ object has no attribute ‘isnumeric’* AttributeError: ‘ResolvedPath’ object has no attribute ‘isprintable’* AttributeError: ‘ResolvedPath’ object has no attribute ‘isspace’* AttributeError: ‘ResolvedPath’ object has no attribute ‘istitle’* AttributeError: ‘ResolvedPath’ object has no attribute ‘isupper’* AttributeError: ‘ResolvedPath’ object has no attribute ‘join’* AttributeError: ‘ResolvedPath’ object has no attribute ‘ljust’* AttributeError: ‘ResolvedPath’ object has no attribute ‘lower’* AttributeError: ‘ResolvedPath’ object has no attribute ‘lstrip’* AttributeError: ‘ResolvedPath’ object has no attribute ‘maketrans’* AttributeError: ‘ResolvedPath’ object has no attribute ‘partition’* AttributeError: ‘ResolvedPath’ object has no attribute ‘replace’* AttributeError: ‘ResolvedPath’ object has no attribute ‘rfind’* AttributeError: ‘ResolvedPath’ object has no attribute ‘rindex’* AttributeError: ‘ResolvedPath’ object has no attribute ‘rjust’* AttributeError: ‘ResolvedPath’ object has no attribute ‘rpartition’* AttributeError: ‘ResolvedPath’ object has no attribute ‘rsplit’* AttributeError: ‘ResolvedPath’ object has no attribute ‘rstrip’* AttributeError: ‘ResolvedPath’ object has no attribute ‘split’* AttributeError: ‘ResolvedPath’ object has no attribute ‘splitlines’* AttributeError: ‘ResolvedPath’ object has no attribute ‘startswith’* AttributeError: ‘ResolvedPath’ object has no attribute ‘strip’* AttributeError: ‘ResolvedPath’ object has no attribute ‘swapcase’* AttributeError: ‘ResolvedPath’ object has no attribute ‘title’* AttributeError: ‘ResolvedPath’ object has no attribute ‘translate’* AttributeError: ‘ResolvedPath’ object has no attribute ‘upper’* AttributeError: ‘ResolvedPath’ object has no attribute ‘zfill’
##### ResolveWithAssetInfo() Removed
For a detailed explanation, see: Breaking Change: ResolveWithAssetInfo() Removed
Reference Commits:
* [ar 2.0] Update Resolve API on ArResolver* [ar 2.0] (Re)introduce API for computing asset info* [ar 2.0] Remove Ar 1.0 implementation* [ar 2.0] Remove Ar 1.0 support from sdf
C++/Python Find Regex:
(?<=\W)ResolveWithAssetInfo(?=\W)NOTE: ResolveWithAssetInfo was never wrapped in python, so no python changes are necessary
C++ Example Before:
const std::string assetPath = “omniverse://some/asset.usd”; ArResolver& resolver = ArGetResolver(); // In Ar 1.0 ArAssetInfo assetInfo; const std::string resolvedPath = ArGetResolver().ResolveWithAssetInfo(assetPath, &assetInfo);
C++ Example After (AR2 only):
const std::string assetPath = “omniverse://some/asset.usd”; ArResolver& resolver = ArGetResolver(); // In Ar 2.0 const ArResolvedPath resolvedPath = ArGetResolver().Resolve(assetPath); ArAssetInfo assetInfo = ArGetResolver().GetAssetInfo(assetPath, resolvedPath);
C++ Example After (branched):
const std::string assetPath = “omniverse://some/asset.usd”; ArResolver& resolver = ArGetResolver();#if defined(AR_VERSION) && AR_VERSION > 1 // In Ar 2.0 const ArResolvedPath resolvedPath = ArGetResolver().Resolve(assetPath); ArAssetInfo assetInfo = ArGetResolver().GetAssetInfo(assetPath, resolvedPath);#else // In Ar 1.0 ArAssetInfo assetInfo; const std::string resolvedPath = ArGetResolver().ResolveWithAssetInfo(assetPath, &assetInfo);#endif
C++ Error Strings (Linux):
* ‘class pxrInternal_v0_22__pxrReserved__::ArResolver’ has no member named ‘ResolveWithAssetInfo’
C++ Error Strings (Windows):
* C2039 ‘ResolveWithAssetInfo’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::ArResolver’* E0135 class “pxrInternal_v0_22__pxrReserved__::ArResolver” has no member “ResolveWithAssetInfo”
##### GetModificationTimestamp() Signature Changed
For a detailed explanation, see: Breaking Change: GetModificationTimestamp() Signature Changed
Reference Commits:
* [ar 2.0] Require Unix time for asset modification times* [ar 2.0] Add ArFilesystemAsset::GetModificationTimestamp* [ar 2.0] Make ArResolver::GetModificationTimestamp optional* [ar 2.0] Remove Ar 1.0 implementation* [ar 2.0] Remove Ar 1.0 support from sdf
C++ Find Regex:
(?<=\W)GetModificationTimestamp(?=\W)NOTE: GetModificationTimestamp was never wrapped in python, so no python changes are necessary
C++ Example Before:
const std::string assetPath = “omniverse://some/asset.usd”;ArResolver& resolver = ArGetResolver();auto resolvedPath = resolver.Resolve(assetPath);// In Ar 1.0VtValue timestamp = resolver.GetModificationTimestamp(assetPath, resolvedPath);
C++ Example After (AR2 only):
const std::string assetPath = “omniverse://some/asset.usd”;ArResolver& resolver = ArGetResolver();auto resolvedPath = resolver.Resolve(assetPath);// In Ar 2.0ArTimestamp timestamp = resolver.GetModificationTimestamp(assetPath, resolvedPath);
C++ Example After (all versions):
const std::string assetPath = “omniverse://some/asset.usd”;ArResolver& resolver = ArGetResolver();auto resolvedPath = resolver.Resolve(assetPath);// Ar 1.0 or 2.0auto timestamp = resolver.GetModificationTimestamp(assetPath, resolvedPath);
C++ Error Strings (Linux):
* conversion from ‘pxrInternal_v0_22__pxrReserved__::ArTimestamp’ to non-scalar type ‘pxrInternal_v0_22__pxrReserved__::VtValue’ requested
C++ Error Strings (Windows):
* C2440 ‘initializing’: cannot convert from ‘pxrInternal_v0_22__pxrReserved__::ArTimestamp’ to ‘pxrInternal_v0_22__pxrReserved__::VtValue’* E0312 no suitable user-defined conversion from “pxrInternal_v0_22__pxrReserved__::ArTimestamp” to “pxrInternal_v0_22__pxrReserved__::VtValue” exists
##### OpenAsset() and ArAsset Signature Changes
For a detailed explanation, see: Breaking Change: OpenAsset() / ArAsset Signature Changes
Reference Commits:
* [ar 2.0] Conform ArResolver::OpenAsset for Ar 2.0* [ar 2.0] General cleanup
C++ Find Regex:
(?<=\W)OpenAsset(?=\W)NOTE: const signature change not relevant to python
C++ Example Before:
class MyResolver : public ArResolver{… AR_API virtual std::shared_ptr<ArAsset> OpenAsset( const std::string& resolvedPath) override;
C++ Example After (AR2 only):
class MyResolver : public ArResolver{… AR_API std::shared_ptr<ArAsset> _OpenAsset( const ArResolvedPath& resolvedPath) const override;
C++ Error Strings (Linux):
* cannot declare variable ‘resolver’ to be of abstract type ‘RESOLVER_SUBCLASS’* invalid cast to abstract class type ‘RESOLVER_SUBCLASS’* ‘virtual std::shared_ptr<pxrInternal_v0_22__pxrReserved__::ArAsset> RESOLVER_SUBCLASS::OpenAsset(const pxrInternal_v0_22__pxrReserved__::ArResolvedPath&) const’ marked ‘override’, but does not override* ‘virtual std::shared_ptr<pxrInternal_v0_22__pxrReserved__::ArAsset> RESOLVER_SUBCLASS::OpenAsset(const string&)’ marked ‘override’, but does not override* ‘virtual std::shared_ptr<pxrInternal_v0_22__pxrReserved__::ArAsset> RESOLVER_SUBCLASS::_OpenAsset(const pxrInternal_v0_22__pxrReserved__::ArResolvedPath&)’ marked ‘override’, but does not override* ‘virtual std::shared_ptr<pxrInternal_v0_22__pxrReserved__::ArAsset> RESOLVER_SUBCLASS::_OpenAsset(const string&) const’ marked ‘override’, but does not override* ‘std::shared_ptr<pxrInternal_v0_22__pxrReserved__::ArAsset> RESOLVER_SUBCLASS::OpenAsset(const pxrInternal_v0_22__pxrReserved__::ArResolvedPath&) const’ marked ‘override’, but does not override* ‘std::shared_ptr<pxrInternal_v0_22__pxrReserved__::ArAsset> RESOLVER_SUBCLASS::OpenAsset(const string&)’ marked ‘override’, but does not override* ‘std::shared_ptr<pxrInternal_v0_22__pxrReserved__::ArAsset> RESOLVER_SUBCLASS::_OpenAsset(const pxrInternal_v0_22__pxrReserved__::ArResolvedPath&)’ marked ‘override’, but does not override* ‘std::shared_ptr<pxrInternal_v0_22__pxrReserved__::ArAsset> RESOLVER_SUBCLASS::_OpenAsset(const string&) const’ marked ‘override’, but does not override
C++ Error Strings (Windows):
* E0322 object of abstract class type “RESOLVER_SUBCLASS” is not allowed:* E0389 a cast to abstract class “RESOLVER_SUBCLASS” is not allowed:* E1455 member function declared with ‘override’ does not override a base class member* C2259 ‘RESOLVER_SUBCLASS’: cannot instantiate abstract class* C3668 ‘RESOLVER_SUBCLASS::_OpenAsset’: method with override specifier ‘override’ did not override any base class methods* C3668 ‘RESOLVER_SUBCLASS::OpenAsset’: method with override specifier ‘override’ did not override any base class methods
## Sdf
### Sdf.ChangeBlock
#### Sdf.ChangeBlock(fastUpdates) to Sdf.ChangeBlock()
OMNIVERSE ONLY
‘fastUpdates’ is an early OV-only prototype and has long been
deprecated, and has been removed from the API in nv-usd 22.05, to
avoid conflicting with the “enabled” parameter added by Pixar in USD
v22.03
Reference Commits:
* sdf: Rework SdfChangeBlock so that we can avoid tls lookup & atomic ops when closing change blocks that are not the innermost* OM-48922 First pass at forward-compatible changes for upgrade to nv-usd 22.05b
Python Find Regex:
(?<=\W)Sdf.ChangeBlock\([^\)]+\)
Python Replace Regex:
Sdf.ChangeBlock()
C++ Example Before:
SdfChangeBlock changeBlock(true /* fastUpdates /);// ORSdfChangeBlock changeBlock(false / fastUpdates */);
C++ Example After (all versions):
SdfChangeBlock changeBlock;
Python Example Before:
from pxr import SdffastUpdates = Truewith Sdf.ChangeBlock(fastUpdates): doStuff()
Python Example After (all versions):
from pxr import Sdfwith Sdf.ChangeBlock(): doStuff()
C++ Error Strings (Linux):
no matching function for call to ‘pxrInternal_v0_22__pxrReserved__::SdfChangeBlock::SdfChangeBlock(bool)’
C++ Error Strings (Windows):
* E0289 no instance of constructor “pxrInternal_v0_22__pxrReserved__::SdfChangeBlock::SdfChangeBlock” matches the argument list* C2664 ‘pxrInternal_v0_22__pxrReserved__::SdfChangeBlock::SdfChangeBlock(const pxrInternal_v0_22__pxrReserved__::SdfChangeBlock &)’: cannot convert argument 1 from ‘bool’ to ‘const pxrInternal_v0_22__pxrReserved__::SdfChangeBlock &’* warning C4930: ‘pxrInternal_v0_22__pxrReserved__::SdfChangeBlock changeBlock(void)’: prototyped function not called (was a variable definition intended?)
Python Error Strings:
WARNINGIn general, if you do:Sdf.ChangeBlock(fastUpdates)…then NO errors will be raised, as it will interpret this asSdf.ChangeBlock(enabled=fastUpdates)…which will not error, but not behave as expected!It will error if you do, ie:Sdf.ChangeBlock(fastUpdates=True)Traceback (most recent call last): File “<stdin>”, line 1, in <module>Boost.Python.ArgumentError: Python argument types in ChangeBlock.__init__(ChangeBlock)did not match C++ signature: __init__(struct _object * __ptr64, bool enabled=True)
### Sdf Layer
#### GetResolvedPath return type changed
Also see: Resolve() Signature Changed
TODO
## Usd
### Usd.CollectionAPI
Reference Commits:
* UsdCollectionAPI is no longer generated using ‘isPrivateApply = true’* Converting all uses of UsdCollectionAPI::ApplyCollection to use UsdCollectionAPI::Apply instead* Remove Deprecated UsdCollectionAPI::ApplyCollection API* Integrate with pxr usd v21.11 (c7306cb4) · Commits · omniverse / usd-rels / kit · GitLab (nvidia.com)
Python Find Regex:
(?<=\W)Usd.CollectionAPI.ApplyCollection(?=\W)
Python Replace Regex:
Usd.CollectionAPI.Apply
Python Example Before:
from pxr import Usdstage = Usd.Stage.CreateInMemory()prim = stage.DefinePrim(“/myPrim”, “Transform”)coll = Usd.CollectionAPI.ApplyCollection(prim, “MyCollection”)
Python Example After (20.11+ only):
from pxr import Usdstage = Usd.Stage.CreateInMemory()prim = stage.DefinePrim(“/myPrim”, “Transform”)coll = Usd.CollectionAPI.Apply(prim, “MyCollection”)
Python Example After (branched):
from pxr import Usdstage = Usd.Stage.CreateInMemory()prim = stage.DefinePrim(“/myPrim”, “Transform”)if hasattr(Usd.CollectionAPI, “Apply”): # >= 20.11 coll = Usd.CollectionAPI.Apply(prim, “MyCollection”)else: coll = Usd.CollectionAPI.ApplyCollection(prim, “MyCollection”)
C++ Error Strings (Linux):
‘ApplyCollection’ is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdCollectionAPI’
C++ Error Strings (Windows):
* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdCollectionAPI” has no member “ApplyCollection”* C2039 ‘ApplyCollection’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdCollectionAPI’* C3861 ‘ApplyCollection’: identifier not found
Python Error Strings:
AttributeError: type object ‘CollectionAPI’ has no attribute ‘ApplyCollection’. Did you mean: ‘BlockCollection’?
#### ApplyCollection to Apply
### Usd Prim
#### “Master” to “Prototype”
IsMasterPath to IsPrototypePath
IsPathInMaster to IsPathInPrototype
IsMaster to IsPrototype
IsInMaster to IsInPrototype
GetMaster to GetPrototype
GetPrimInMaster to GetPrimInPrototype
Reference Commits:
* Deprecate “master” API in favor of new “prototype” API on UsdPrim* Remove deprecated USD instancing “master” API
Python/C++ Find Regex:
(?<=\W)(?:(IsPathIn|Is|IsIn|Get|GetPrimIn)Master|(Is)Master(Path))(?=\W)
Python/C++ Replace Regex:
$1$2Prototype$3
C++ Example Before:
if (UsdPrim::IsMasterPath(SdfPath(“/myPath”))) { TF_WARN(”…”);}if (UsdPrim::IsPathInMaster(SdfPath(“/myPath”))) { TF_WARN(”…”);}if (prim.IsMaster()) { TF_WARN(”…”);}if (prim.IsInMaster()) { TF_WARN(”…”);}if (prim.GetMaster()) { TF_WARN(”…”);}if (prim.GetPrimInMaster()) { TF_WARN(”…”);}
C++ Example After (22.11+ only):
if (UsdPrim::IsPrototypePath(SdfPath(“/myPath”))) { TF_WARN(”…”);}if (UsdPrim::IsPathInPrototype(SdfPath(“/myPath”))) { TF_WARN(”…”);}if (prim.IsPrototype()) { TF_WARN(”…”);}if (prim.IsInPrototype()) { TF_WARN(”…”);}if (prim.GetPrototype()) { TF_WARN(”…”);}if (prim.GetPrimInPrototype()) { TF_WARN(”…”);}
C++ Example After (branched):
#if PXR_VERSION >= 2011if (UsdPrim::IsPrototypePath(SdfPath(“/myPath”))) { TF_WARN(”…”);}if (UsdPrim::IsPathInPrototype(SdfPath(“/myPath”))) { TF_WARN(”…”);}if (prim.IsPrototype()) { TF_WARN(”…”);}if (prim.IsInPrototype()) { TF_WARN(”…”);}if (prim.GetPrototype()) { TF_WARN(”…”);}if (prim.GetPrimInPrototype()) { TF_WARN(”…”);}#elseif (UsdPrim::IsMasterPath(SdfPath(“/myPath”))) { TF_WARN(”…”);}if (UsdPrim::IsPathInMaster(SdfPath(“/myPath”))) { TF_WARN(”…”);}if (prim.IsMaster()) { TF_WARN(”…”);}if (prim.IsInMaster()) { TF_WARN(”…”);}if (prim.GetMaster()) { TF_WARN(”…”);}if (prim.GetPrimInMaster()) { TF_WARN(”…”);}#endif
Python Example Before:
from pxr import Usdstage = Usd.Stage.CreateInMemory()prim = stage.DefinePrim(“/myPrim”, “Transform”)if Usd.Prim.IsMasterPath(“/myPrim”): print(“is master path”)if Usd.Prim.IsPathInMaster(“/myPrim”): print(“path is in master”)if prim.IsMaster(): print(“is master”)if prim.IsInMaster(): print(“is in master”)master = prim.GetMaster()primInMaster = prim.GetPrimInMaster()
Python Example After (20.11+ only):
from pxr import Usdstage = Usd.Stage.CreateInMemory()prim = stage.DefinePrim(“/myPrim”, “Transform”)if Usd.Prim.IsPrototypePath(“/myPrim”): print(“is prototype path”)if Usd.Prim.IsPathInPrototype(“/myPrim”): print(“path is in prototype”)if prim.IsPrototype(): print(“is prototype”)if prim.IsInPrototype(): print(“is in prototype”)prototype = prim.GetPrototype()primInPrototype = prim.GetPrimInPrototype()
Python Example After (branched):
from pxr import Usdstage = Usd.Stage.CreateInMemory()prim = stage.DefinePrim(“/myPrim”, “Transform”)if hasattr(Usd.Prim, “IsPrototypePath”): # >= 20.11 if Usd.Prim.IsPrototypePath(“/myPrim”): print(“is prototype path”) if Usd.Prim.IsPathInPrototype(“/myPrim”): print(“path is in prototype”)if prim.IsPrototype(): print(“is prototype”) if prim.IsInPrototype(): print(“is in prototype”) prototype = prim.GetPrototype() primInPrototype = prim.GetPrimInPrototype()else: if Usd.Prim.IsPrototypePath(“/myPrim”): print(“is prototype path”)if Usd.Prim.IsPathInPrototype(“/myPrim”): print(“path is in prototype”)if prim.IsPrototype(): print(“is prototype”)if prim.IsInPrototype(): print(“is in prototype”) prototype = prim.GetPrototype() primInPrototype = prim.GetPrimInPrototype()
C++ Error Strings (Linux):
* ‘IsMasterPath’ is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdPrim’* ‘IsPathInMaster’ is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdPrim’* ‘const class pxrInternal_v0_22__pxrReserved__::UsdPrim’ has no member named ‘IsMaster’; did you mean ‘IsModel’\?* ‘const class pxrInternal_v0_22__pxrReserved__::UsdPrim’ has no member named ‘IsInMaster’; did you mean ‘IsInstance’\?* ‘const class pxrInternal_v0_22__pxrReserved__::UsdPrim’ has no member named ‘GetMaster’; did you mean ‘GetName’\?* ‘const class pxrInternal_v0_22__pxrReserved__::UsdPrim’ has no member named ‘GetPrimInMaster’; did you mean ‘GetPrimIndex’\?
C++ Error Strings (Windows):
* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdPrim” has no member “IsMasterPath”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdPrim” has no member “IsPathInMaster”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdPrim” has no member “IsMaster”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdPrim” has no member “IsInMaster”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdPrim” has no member “GetMaster”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdPrim” has no member “GetPrimInMaster”* C2039 ‘IsMasterPath’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdPrim’* C3861 ‘IsMasterPath’: identifier not found* C2039 ‘IsPathInMaster’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdPrim’* C3861 ‘IsPathInMaster’: identifier not found* C2039 ‘IsMaster’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdPrim’* C2039 ‘IsInMaster’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdPrim’* C2039 ‘GetMaster’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdPrim’* C2039 ‘GetPrimInMaster’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdPrim’
Python Error Strings:
* AttributeError: type object ‘Prim’ has no attribute ‘IsMasterPath’* AttributeError: type object ‘Prim’ has no attribute ‘IsPathInMaster’* AttributeError: ‘Prim’ object has no attribute ‘IsMaster’* AttributeError: ‘Prim’ object has no attribute ‘IsInMaster’* AttributeError: ‘Prim’ object has no attribute ‘GetMaster’* AttributeError: ‘Prim’ object has no attribute ‘GetPrimInMaster’
#### GetAppliedSchemas: Now filters out non-existent schemas
To get the list of apiSchema tokens that are authored on the prim
(whether they exists or not), use
GetPrimTypeInfo().GetAppliedAPISchemas()
Reference Commits:
* Refactoring some of the functionality in UsdPrimDefinition for how we build prim definitions… There’s also one minor functional change in that API schema names that can’t be mapped to a valid prim definition are no longer included in the composed API schema list of a UsdPrimDefinition that is built with them* GetAppliedSchemas no longer will return old schemas
Python/C++ Find Regex:
.GetAppliedAPISchemas\(\)
Python/C++ Replace Regex:
.GetPrimTypeInfo().GetAppliedAPISchemas()WARNINGYou will likely not want to indiscriminately replace all occurrences of GetAppliedSchemas() with GetPrimTypeInfo().GetAppliedAPISchemas()Instead, you must decide on a case-by-case basis whether the intent was to:* get all “successfully applied schemas” - including “auto apply schemas”:* GetAppliedSchemas()* ie, do not change* This will likely be most use cases* get all authored “potentially applied schemas” - including possibly non-existent ones* GetPrimTypeInfo().GetAppliedAPISchemas()* ie, replace* This is useful in situations where you want to, ie, update outdated assets
C++ Example Before:
auto appliedSchemas = usdPrim.GetAppliedSchemas();
C++ Example After:
auto appliedSchemas = usdPrim.GetPrimTypeInfo().GetAppliedAPISchemas();
Python Example Before:
# In v21.08, this will print# [‘ShadowAPI’, ‘NoExistAPI’]# In v21.11, this will print# [‘ShadowAPI’]from pxr import Usd, UsdLuxstage = Usd.Stage.CreateInMemory()prim = stage.DefinePrim(“/World”, “Cube”)prim.ApplyAPI(UsdLux.ShadowAPI)prim.AddAppliedSchema(“NoExistAPI”)print(prim.GetAppliedSchemas())
Python Example After (all versions):
# In both v21.08 + v21.11, this will print# [‘ShadowAPI’, ‘NoExistAPI’]from pxr import Usd, UsdLuxstage = Usd.Stage.CreateInMemory()prim = stage.DefinePrim(“/World”, “Cube”)prim.ApplyAPI(UsdLux.ShadowAPI)prim.AddAppliedSchema(“NoExistAPI”)print(prim.GetPrimTypeInfo().GetAppliedAPISchemas())
### Usd SchemaRegistry
#### SchemaType to SchemaKind
For a detailed explanation, see: Breaking Change: Schema Kind
Reference Commits:
* UsdSchemaRegistry can now query about schema kind from the schemaKind plugInfo metadata that is generated by usdGenSchema for schema types. This is directly exposed through the new GetSchemaKind functions added to UsdSchemaRegistry.* Intermediary release work for the transition to schemaKind nomenclature from schemaType.* Removing the deprecated GetSchemaType and static schemaType from UsdSchemaBase.* Updating usdGenSchema to no longer generate the deprecated schemaType* Removing the backward compatibility in UsdSchemaRegistry for schemas that have not been regenerated to include schemaKind in their pluginInfo metadata.
C++/Python Find Regex:
SchemaType
C++/Python Replace Regex:
SchemaKind
Python Example Before:
from pxr import Usd, UsdGeommyStage = Usd.Stage.CreateInMemory()myPrim = myStage.DefinePrim(“/myPrim”, “Xform”)myXform = UsdGeom.Xform(myPrim)myUsdModel = Usd.ModelAPI(myPrim)myUsdGeomModel = UsdGeom.ModelAPI(myPrim)myCollection = Usd.CollectionAPI(myPrim, “MyCollection”)assert myXform.GetSchemaType() == Usd.SchemaType.ConcreteTypedassert myXform.GetSchemaType() != Usd.SchemaType.AbstractBaseassert myXform.GetSchemaType() != Usd.SchemaType.AbstractTypedassert myUsdModel.GetSchemaType() == Usd.SchemaType.NonAppliedAPIassert myUsdGeomModel.GetSchemaType() == Usd.SchemaType.SingleApplyAPIassert myCollection.GetSchemaType() == Usd.SchemaType.MultipleApplyAPI
Python Example After (21.02+ only):
from pxr import Usd, UsdGeommyStage = Usd.Stage.CreateInMemory()myPrim = myStage.DefinePrim(“/myPrim”, “Xform”)myXform = UsdGeom.Xform(myPrim)myUsdModel = Usd.ModelAPI(myPrim)myUsdGeomModel = UsdGeom.ModelAPI(myPrim)myCollection = Usd.CollectionAPI(myPrim, “MyCollection”)assert myXform.GetSchemaKind() == Usd.SchemaKind.ConcreteTypedassert myXform.GetSchemaKind() != Usd.SchemaKind.AbstractBaseassert myXform.GetSchemaKind() != Usd.SchemaKind.AbstractTypedassert myUsdModel.GetSchemaKind() == Usd.SchemaKind.NonAppliedAPIassert myUsdGeomModel.GetSchemaKind() == Usd.SchemaKind.SingleApplyAPIassert myCollection.GetSchemaKind() == Usd.SchemaKind.MultipleApplyAPI
Python Example After (branched):
from pxr import Usd, UsdGeommyStage = Usd.Stage.CreateInMemory()myPrim = myStage.DefinePrim(“/myPrim”, “Xform”)myXform = UsdGeom.Xform(myPrim)myUsdModel = Usd.ModelAPI(myPrim)myUsdGeomModel = UsdGeom.ModelAPI(myPrim)myCollection = Usd.CollectionAPI(myPrim, “MyCollection”)if hasattr(Usd.SchemaBase, “GetSchemaKind”): # 21.02+ assert myXform.GetSchemaKind() == Usd.SchemaKind.ConcreteTyped assert myXform.GetSchemaKind() != Usd.SchemaKind.AbstractBase assert myXform.GetSchemaKind() != Usd.SchemaKind.AbstractTyped assert myUsdModel.GetSchemaKind() == Usd.SchemaKind.NonAppliedAPI assert myUsdGeomModel.GetSchemaKind() == Usd.SchemaKind.SingleApplyAPI assert myCollection.GetSchemaKind() == Usd.SchemaKind.MultipleApplyAPIelse: assert myXform.GetSchemaType() == Usd.SchemaType.ConcreteTyped assert myXform.GetSchemaType() != Usd.SchemaType.AbstractBase assert myXform.GetSchemaType() != Usd.SchemaType.AbstractTyped assert myUsdModel.GetSchemaType() == Usd.SchemaType.NonAppliedAPI assert myUsdGeomModel.GetSchemaType() == Usd.SchemaType.SingleApplyAPI assert myCollection.GetSchemaType() == Usd.SchemaType.MultipleApplyAPI
C++ Error Strings (Linux):
* ‘UsdSchemaType’ has not been declared* ‘class pxrInternal_v0_22__pxrReserved__::UsdClipsAPI’ has no member named ‘GetSchemaType’; did you mean ‘_GetSchemaType’?* ‘class pxrInternal_v0_22__pxrReserved__::UsdCollectionAPI’ has no member named ‘GetSchemaType’; did you mean ‘_GetSchemaType’?* ‘class pxrInternal_v0_22__pxrReserved__::UsdGeomBasisCurves’ has no member named ‘GetSchemaType’; did you mean ‘_GetSchemaType’?* ‘class pxrInternal_v0_22__pxrReserved__::UsdGeomBoundable’ has no member named ‘GetSchemaType’; did you mean ‘_GetSchemaType’?* ‘class pxrInternal_v0_22__pxrReserved__::UsdGeomCamera’ has no member named ‘GetSchemaType’; did you mean ‘_GetSchemaType’?* ‘class pxrInternal_v0_22__pxrReserved__::UsdGeomCapsule’ has no member named ‘GetSchemaType’; did you mean ‘_GetSchemaType’?* ‘class pxrInternal_v0_22__pxrReserved__::UsdGeomCone’ has no member named ‘GetSchemaType’; did you mean ‘_GetSchemaType’?* ‘class pxrInternal_v0_22__pxrReserved__::UsdGeomCube’ has no member named ‘GetSchemaType’; did you mean ‘_GetSchemaType’?* ‘class pxrInternal_v0_22__pxrReserved__::UsdGeomCurves’ has no member named ‘GetSchemaType’; did you mean ‘_GetSchemaType’?* ‘class pxrInternal_v0_22__pxrReserved__::UsdGeomCylinder’ has no member named ‘GetSchemaType’; did you mean ‘_GetSchemaType’?* ‘class pxrInternal_v0_22__pxrReserved__::UsdGeomGprim’ has no member named ‘GetSchemaType’; did you mean ‘_GetSchemaType’?* ‘class pxrInternal_v0_22__pxrReserved__::UsdGeomHermiteCurves’ has no member named ‘GetSchemaType’; did you mean ‘_GetSchemaType’?* ‘class pxrInternal_v0_22__pxrReserved__::UsdGeomImageable’ has no member named ‘GetSchemaType’; did you mean ‘_GetSchemaType’?* ‘class pxrInternal_v0_22__pxrReserved__::UsdGeomMesh’ has no member named ‘GetSchemaType’; did you mean ‘_GetSchemaType’?* ‘class pxrInternal_v0_22__pxrReserved__::UsdGeomModelAPI’ has no member named ‘GetSchemaType’; did you mean ‘_GetSchemaType’?* ‘class pxrInternal_v0_22__pxrReserved__::UsdGeomMotionAPI’ has no member named ‘GetSchemaType’; did you mean ‘_GetSchemaType’?* ‘class pxrInternal_v0_22__pxrReserved__::UsdGeomNurbsCurves’ has no member named ‘GetSchemaType’; did you mean ‘_GetSchemaType’?* ‘class pxrInternal_v0_22__pxrReserved__::UsdGeomNurbsPatch’ has no member named ‘GetSchemaType’; did you mean ‘_GetSchemaType’?* ‘class pxrInternal_v0_22__pxrReserved__::UsdGeomPointBased’ has no member named ‘GetSchemaType’; did you mean ‘_GetSchemaType’?* ‘class pxrInternal_v0_22__pxrReserved__::UsdGeomPointInstancer’ has no member named ‘GetSchemaType’; did you mean ‘_GetSchemaType’?* ‘class pxrInternal_v0_22__pxrReserved__::UsdGeomPoints’ has no member named ‘GetSchemaType’; did you mean ‘_GetSchemaType’?* ‘class pxrInternal_v0_22__pxrReserved__::UsdGeomPrimvarsAPI’ has no member named ‘GetSchemaType’; did you mean ‘_GetSchemaType’?* ‘class pxrInternal_v0_22__pxrReserved__::UsdGeomScope’ has no member named ‘GetSchemaType’; did you mean ‘_GetSchemaType’?* ‘class pxrInternal_v0_22__pxrReserved__::UsdGeomSphere’ has no member named ‘GetSchemaType’; did you mean ‘_GetSchemaType’?* ‘class pxrInternal_v0_22__pxrReserved__::UsdGeomSubset’ has no member named ‘GetSchemaType’; did you mean ‘_GetSchemaType’?* ‘class pxrInternal_v0_22__pxrReserved__::UsdGeomXformCommonAPI’ has no member named ‘GetSchemaType’; did you mean ‘_GetSchemaType’?* ‘class pxrInternal_v0_22__pxrReserved__::UsdGeomXformable’ has no member named ‘GetSchemaType’; did you mean ‘_GetSchemaType’?* ‘class pxrInternal_v0_22__pxrReserved__::UsdGeomXform’ has no member named ‘GetSchemaType’; did you mean ‘_GetSchemaType’?* ‘class pxrInternal_v0_22__pxrReserved__::UsdLuxCylinderLight’ has no member named ‘GetSchemaType’; did you mean ‘_GetSchemaType’?* ‘class pxrInternal_v0_22__pxrReserved__::UsdLuxDiskLight’ has no member named ‘GetSchemaType’; did you mean ‘_GetSchemaType’?* ‘class pxrInternal_v0_22__pxrReserved__::UsdLuxDistantLight’ has no member named ‘GetSchemaType’; did you mean ‘_GetSchemaType’?* ‘class pxrInternal_v0_22__pxrReserved__::UsdLuxDomeLight’ has no member named ‘GetSchemaType’; did you mean ‘_GetSchemaType’?* ‘class pxrInternal_v0_22__pxrReserved__::UsdLuxGeometryLight’ has no member named ‘GetSchemaType’; did you mean ‘_GetSchemaType’?* ‘class pxrInternal_v0_22__pxrReserved__::UsdLuxLightFilter’ has no member named ‘GetSchemaType’; did you mean ‘_GetSchemaType’?* ‘class pxrInternal_v0_22__pxrReserved__::UsdLuxListAPI’ has no member named ‘GetSchemaType’; did you mean ‘_GetSchemaType’?* ‘class pxrInternal_v0_22__pxrReserved__::UsdLuxRectLight’ has no member named ‘GetSchemaType’; did you mean ‘_GetSchemaType’?* ‘class pxrInternal_v0_22__pxrReserved__::UsdLuxShadowAPI’ has no member named ‘GetSchemaType’; did you mean ‘_GetSchemaType’?* ‘class pxrInternal_v0_22__pxrReserved__::UsdLuxShapingAPI’ has no member named ‘GetSchemaType’; did you mean ‘_GetSchemaType’?* ‘class pxrInternal_v0_22__pxrReserved__::UsdLuxSphereLight’ has no member named ‘GetSchemaType’; did you mean ‘_GetSchemaType’?* ‘class pxrInternal_v0_22__pxrReserved__::UsdMediaSpatialAudio’ has no member named ‘GetSchemaType’; did you mean ‘_GetSchemaType’?* ‘class pxrInternal_v0_22__pxrReserved__::UsdModelAPI’ has no member named ‘GetSchemaType’; did you mean ‘_GetSchemaType’?* ‘class pxrInternal_v0_22__pxrReserved__::UsdRenderProduct’ has no member named ‘GetSchemaType’; did you mean ‘_GetSchemaType’?* ‘class pxrInternal_v0_22__pxrReserved__::UsdRenderSettingsBase’ has no member named ‘GetSchemaType’; did you mean ‘_GetSchemaType’?* ‘class pxrInternal_v0_22__pxrReserved__::UsdRenderSettings’ has no member named ‘GetSchemaType’; did you mean ‘_GetSchemaType’?* ‘class pxrInternal_v0_22__pxrReserved__::UsdRenderVar’ has no member named ‘GetSchemaType’; did you mean ‘_GetSchemaType’?* ‘class pxrInternal_v0_22__pxrReserved__::UsdSchemaBase’ has no member named ‘GetSchemaType’; did you mean ‘_GetSchemaType’?* ‘class pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI’ has no member named ‘GetSchemaType’; did you mean ‘_GetSchemaType’?* ‘class pxrInternal_v0_22__pxrReserved__::UsdShadeCoordSysAPI’ has no member named ‘GetSchemaType’; did you mean ‘_GetSchemaType’?* ‘class pxrInternal_v0_22__pxrReserved__::UsdShadeMaterialBindingAPI’ has no member named ‘GetSchemaType’; did you mean ‘_GetSchemaType’?* ‘class pxrInternal_v0_22__pxrReserved__::UsdShadeMaterial’ has no member named ‘GetSchemaType’; did you mean ‘_GetSchemaType’?* ‘class pxrInternal_v0_22__pxrReserved__::UsdShadeNodeGraph’ has no member named ‘GetSchemaType’; did you mean ‘_GetSchemaType’?* ‘class pxrInternal_v0_22__pxrReserved__::UsdShadeShader’ has no member named ‘GetSchemaType’; did you mean ‘_GetSchemaType’?* ‘class pxrInternal_v0_22__pxrReserved__::UsdSkelAnimation’ has no member named ‘GetSchemaType’; did you mean ‘_GetSchemaType’?* ‘class pxrInternal_v0_22__pxrReserved__::UsdSkelBindingAPI’ has no member named ‘GetSchemaType’; did you mean ‘_GetSchemaType’?* ‘class pxrInternal_v0_22__pxrReserved__::UsdSkelBlendShape’ has no member named ‘GetSchemaType’; did you mean ‘_GetSchemaType’?* ‘class pxrInternal_v0_22__pxrReserved__::UsdSkelPackedJointAnimation’ has no member named ‘GetSchemaType’; did you mean ‘_GetSchemaType’?* ‘class pxrInternal_v0_22__pxrReserved__::UsdSkelRoot’ has no member named ‘GetSchemaType’; did you mean ‘_GetSchemaType’?* ‘class pxrInternal_v0_22__pxrReserved__::UsdSkelSkeleton’ has no member named ‘GetSchemaType’; did you mean ‘_GetSchemaType’?* ‘class pxrInternal_v0_22__pxrReserved__::UsdTyped’ has no member named ‘GetSchemaType’; did you mean ‘_GetSchemaType’?* ‘class pxrInternal_v0_22__pxrReserved__::UsdUIBackdrop’ has no member named ‘GetSchemaType’; did you mean ‘_GetSchemaType’?* ‘class pxrInternal_v0_22__pxrReserved__::UsdUINodeGraphNodeAPI’ has no member named ‘GetSchemaType’; did you mean ‘_GetSchemaType’?* ‘class pxrInternal_v0_22__pxrReserved__::UsdUISceneGraphPrimAPI’ has no member named ‘GetSchemaType’; did you mean ‘_GetSchemaType’?* ‘class pxrInternal_v0_22__pxrReserved__::UsdVolField3DAsset’ has no member named ‘GetSchemaType’; did you mean ‘_GetSchemaType’?* ‘class pxrInternal_v0_22__pxrReserved__::UsdVolFieldAsset’ has no member named ‘GetSchemaType’; did you mean ‘_GetSchemaType’?* ‘class pxrInternal_v0_22__pxrReserved__::UsdVolFieldBase’ has no member named ‘GetSchemaType’; did you mean ‘_GetSchemaType’?* ‘class pxrInternal_v0_22__pxrReserved__::UsdVolOpenVDBAsset’ has no member named ‘GetSchemaType’; did you mean ‘_GetSchemaType’?* ‘class pxrInternal_v0_22__pxrReserved__::UsdVolVolume’ has no member named ‘GetSchemaType’; did you mean ‘_GetSchemaType’?* ‘schemaType’ is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdAPISchemaBase’* ‘schemaType’ is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdClipsAPI’* ‘schemaType’ is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdCollectionAPI’* ‘schemaType’ is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomBasisCurves’* ‘schemaType’ is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomBoundable’* ‘schemaType’ is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomCamera’* ‘schemaType’ is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomCapsule’* ‘schemaType’ is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomCone’* ‘schemaType’ is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomCube’* ‘schemaType’ is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomCurves’* ‘schemaType’ is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomCylinder’* ‘schemaType’ is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomGprim’* ‘schemaType’ is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomHermiteCurves’* ‘schemaType’ is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomImageable’* ‘schemaType’ is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomMesh’* ‘schemaType’ is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomModelAPI’* ‘schemaType’ is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomMotionAPI’* ‘schemaType’ is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomNurbsCurves’* ‘schemaType’ is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomNurbsPatch’* ‘schemaType’ is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomPointBased’* ‘schemaType’ is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomPointInstancer’* ‘schemaType’ is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomPoints’* ‘schemaType’ is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomPrimvarsAPI’* ‘schemaType’ is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomScope’* ‘schemaType’ is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomSphere’* ‘schemaType’ is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomSubset’* ‘schemaType’ is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomXformCommonAPI’* ‘schemaType’ is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomXformable’* ‘schemaType’ is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomXform’* ‘schemaType’ is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxCylinderLight’* ‘schemaType’ is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxDiskLight’* ‘schemaType’ is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxDistantLight’* ‘schemaType’ is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxDomeLight’* ‘schemaType’ is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxGeometryLight’* ‘schemaType’ is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxLightFilter’* ‘schemaType’ is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxListAPI’* ‘schemaType’ is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxRectLight’* ‘schemaType’ is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxShadowAPI’* ‘schemaType’ is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxShapingAPI’* ‘schemaType’ is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxSphereLight’* ‘schemaType’ is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdMediaSpatialAudio’* ‘schemaType’ is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdModelAPI’* ‘schemaType’ is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdRenderProduct’* ‘schemaType’ is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdRenderSettingsBase’* ‘schemaType’ is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdRenderSettings’* ‘schemaType’ is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdRenderVar’* ‘schemaType’ is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdSchemaBase’* ‘schemaType’ is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI’* ‘schemaType’ is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdShadeCoordSysAPI’* ‘schemaType’ is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdShadeMaterialBindingAPI’* ‘schemaType’ is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdShadeMaterial’* ‘schemaType’ is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdShadeNodeGraph’* ‘schemaType’ is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdShadeShader’* ‘schemaType’ is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdSkelAnimation’* ‘schemaType’ is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdSkelBindingAPI’* ‘schemaType’ is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdSkelBlendShape’* ‘schemaType’ is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdSkelPackedJointAnimation’* ‘schemaType’ is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdSkelRoot’* ‘schemaType’ is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdSkelSkeleton’* ‘schemaType’ is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdTyped’* ‘schemaType’ is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdUIBackdrop’* ‘schemaType’ is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdUINodeGraphNodeAPI’* ‘schemaType’ is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdUISceneGraphPrimAPI’* ‘schemaType’ is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdVolField3DAsset’* ‘schemaType’ is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdVolFieldAsset’* ‘schemaType’ is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdVolFieldBase’* ‘schemaType’ is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdVolOpenVDBAsset’* ‘schemaType’ is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdVolVolume’
C++ Error Strings (Windows):
* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdAPISchemaBase” has no member “schemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdClipsAPI” has no member “GetSchemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdClipsAPI” has no member “schemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdCollectionAPI” has no member “GetSchemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdCollectionAPI” has no member “schemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdGeomBasisCurves” has no member “GetSchemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdGeomBasisCurves” has no member “schemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdGeomBoundable” has no member “GetSchemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdGeomBoundable” has no member “schemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdGeomCamera” has no member “GetSchemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdGeomCamera” has no member “schemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdGeomCapsule” has no member “GetSchemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdGeomCapsule” has no member “schemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdGeomCone” has no member “GetSchemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdGeomCone” has no member “schemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdGeomCube” has no member “GetSchemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdGeomCube” has no member “schemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdGeomCurves” has no member “GetSchemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdGeomCurves” has no member “schemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdGeomCylinder” has no member “GetSchemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdGeomCylinder” has no member “schemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdGeomGprim” has no member “GetSchemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdGeomGprim” has no member “schemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdGeomHermiteCurves” has no member “GetSchemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdGeomHermiteCurves” has no member “schemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdGeomImageable” has no member “GetSchemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdGeomImageable” has no member “schemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdGeomMesh” has no member “GetSchemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdGeomMesh” has no member “schemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdGeomModelAPI” has no member “GetSchemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdGeomModelAPI” has no member “schemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdGeomMotionAPI” has no member “GetSchemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdGeomMotionAPI” has no member “schemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdGeomNurbsCurves” has no member “GetSchemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdGeomNurbsCurves” has no member “schemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdGeomNurbsPatch” has no member “GetSchemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdGeomNurbsPatch” has no member “schemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdGeomPointBased” has no member “GetSchemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdGeomPointBased” has no member “schemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdGeomPointInstancer” has no member “GetSchemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdGeomPointInstancer” has no member “schemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdGeomPoints” has no member “GetSchemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdGeomPoints” has no member “schemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdGeomPrimvarsAPI” has no member “GetSchemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdGeomPrimvarsAPI” has no member “schemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdGeomScope” has no member “GetSchemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdGeomScope” has no member “schemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdGeomSphere” has no member “GetSchemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdGeomSphere” has no member “schemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdGeomSubset” has no member “GetSchemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdGeomSubset” has no member “schemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdGeomXform” has no member “GetSchemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdGeomXform” has no member “schemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdGeomXformable” has no member “GetSchemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdGeomXformable” has no member “schemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdGeomXformCommonAPI” has no member “GetSchemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdGeomXformCommonAPI” has no member “schemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdLuxCylinderLight” has no member “GetSchemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdLuxCylinderLight” has no member “schemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdLuxDiskLight” has no member “GetSchemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdLuxDiskLight” has no member “schemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdLuxDistantLight” has no member “GetSchemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdLuxDistantLight” has no member “schemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdLuxDomeLight” has no member “GetSchemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdLuxDomeLight” has no member “schemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdLuxGeometryLight” has no member “GetSchemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdLuxGeometryLight” has no member “schemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdLuxLightFilter” has no member “GetSchemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdLuxLightFilter” has no member “schemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdLuxListAPI” has no member “GetSchemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdLuxListAPI” has no member “schemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdLuxRectLight” has no member “GetSchemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdLuxRectLight” has no member “schemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdLuxShadowAPI” has no member “GetSchemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdLuxShadowAPI” has no member “schemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdLuxShapingAPI” has no member “GetSchemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdLuxShapingAPI” has no member “schemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdLuxSphereLight” has no member “GetSchemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdLuxSphereLight” has no member “schemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdMediaSpatialAudio” has no member “GetSchemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdMediaSpatialAudio” has no member “schemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdModelAPI” has no member “GetSchemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdModelAPI” has no member “schemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdRenderProduct” has no member “GetSchemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdRenderProduct” has no member “schemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdRenderSettings” has no member “GetSchemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdRenderSettings” has no member “schemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdRenderSettingsBase” has no member “GetSchemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdRenderSettingsBase” has no member “schemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdRenderVar” has no member “GetSchemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdRenderVar” has no member “schemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdSchemaBase” has no member “GetSchemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdSchemaBase” has no member “schemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI” has no member “GetSchemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI” has no member “schemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdShadeCoordSysAPI” has no member “GetSchemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdShadeCoordSysAPI” has no member “schemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdShadeMaterial” has no member “GetSchemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdShadeMaterial” has no member “schemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdShadeMaterialBindingAPI” has no member “GetSchemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdShadeMaterialBindingAPI” has no member “schemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdShadeNodeGraph” has no member “GetSchemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdShadeNodeGraph” has no member “schemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdShadeShader” has no member “GetSchemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdShadeShader” has no member “schemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdSkelAnimation” has no member “GetSchemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdSkelAnimation” has no member “schemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdSkelBindingAPI” has no member “GetSchemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdSkelBindingAPI” has no member “schemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdSkelBlendShape” has no member “GetSchemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdSkelBlendShape” has no member “schemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdSkelPackedJointAnimation” has no member “GetSchemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdSkelPackedJointAnimation” has no member “schemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdSkelRoot” has no member “GetSchemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdSkelRoot” has no member “schemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdSkelSkeleton” has no member “GetSchemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdSkelSkeleton” has no member “schemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdTyped” has no member “GetSchemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdTyped” has no member “schemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdUIBackdrop” has no member “GetSchemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdUIBackdrop” has no member “schemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdUINodeGraphNodeAPI” has no member “GetSchemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdUINodeGraphNodeAPI” has no member “schemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdUISceneGraphPrimAPI” has no member “GetSchemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdUISceneGraphPrimAPI” has no member “schemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdVolField3DAsset” has no member “GetSchemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdVolField3DAsset” has no member “schemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdVolFieldAsset” has no member “GetSchemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdVolFieldAsset” has no member “schemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdVolFieldBase” has no member “GetSchemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdVolFieldBase” has no member “schemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdVolOpenVDBAsset” has no member “GetSchemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdVolOpenVDBAsset” has no member “schemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdVolVolume” has no member “GetSchemaType”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdVolVolume” has no member “schemaType”* C2039 ‘GetSchemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdClipsAPI’* C2039 ‘GetSchemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdCollectionAPI’* C2039 ‘GetSchemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomBasisCurves’* C2039 ‘GetSchemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomBoundable’* C2039 ‘GetSchemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomCamera’* C2039 ‘GetSchemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomCapsule’* C2039 ‘GetSchemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomCone’* C2039 ‘GetSchemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomCube’* C2039 ‘GetSchemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomCurves’* C2039 ‘GetSchemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomCylinder’* C2039 ‘GetSchemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomGprim’* C2039 ‘GetSchemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomHermiteCurves’* C2039 ‘GetSchemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomImageable’* C2039 ‘GetSchemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomMesh’* C2039 ‘GetSchemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomModelAPI’* C2039 ‘GetSchemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomMotionAPI’* C2039 ‘GetSchemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomNurbsCurves’* C2039 ‘GetSchemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomNurbsPatch’* C2039 ‘GetSchemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomPointBased’* C2039 ‘GetSchemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomPointInstancer’* C2039 ‘GetSchemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomPoints’* C2039 ‘GetSchemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomPrimvarsAPI’* C2039 ‘GetSchemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomScope’* C2039 ‘GetSchemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomSphere’* C2039 ‘GetSchemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomSubset’* C2039 ‘GetSchemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomXform’* C2039 ‘GetSchemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomXformable’* C2039 ‘GetSchemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomXformCommonAPI’* C2039 ‘GetSchemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxCylinderLight’* C2039 ‘GetSchemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxDiskLight’* C2039 ‘GetSchemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxDistantLight’* C2039 ‘GetSchemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxDomeLight’* C2039 ‘GetSchemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxGeometryLight’* C2039 ‘GetSchemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxLightFilter’* C2039 ‘GetSchemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxListAPI’* C2039 ‘GetSchemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxRectLight’* C2039 ‘GetSchemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxShadowAPI’* C2039 ‘GetSchemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxShapingAPI’* C2039 ‘GetSchemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxSphereLight’* C2039 ‘GetSchemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdMediaSpatialAudio’* C2039 ‘GetSchemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdModelAPI’* C2039 ‘GetSchemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdRenderProduct’* C2039 ‘GetSchemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdRenderSettings’* C2039 ‘GetSchemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdRenderSettingsBase’* C2039 ‘GetSchemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdRenderVar’* C2039 ‘GetSchemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdSchemaBase’* C2039 ‘GetSchemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI’* C2039 ‘GetSchemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdShadeCoordSysAPI’* C2039 ‘GetSchemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdShadeMaterial’* C2039 ‘GetSchemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdShadeMaterialBindingAPI’* C2039 ‘GetSchemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdShadeNodeGraph’* C2039 ‘GetSchemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdShadeShader’* C2039 ‘GetSchemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdSkelAnimation’* C2039 ‘GetSchemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdSkelBindingAPI’* C2039 ‘GetSchemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdSkelBlendShape’* C2039 ‘GetSchemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdSkelPackedJointAnimation’* C2039 ‘GetSchemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdSkelRoot’* C2039 ‘GetSchemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdSkelSkeleton’* C2039 ‘GetSchemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdTyped’* C2039 ‘GetSchemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdUIBackdrop’* C2039 ‘GetSchemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdUINodeGraphNodeAPI’* C2039 ‘GetSchemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdUISceneGraphPrimAPI’* C2039 ‘GetSchemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdVolField3DAsset’* C2039 ‘GetSchemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdVolFieldAsset’* C2039 ‘GetSchemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdVolFieldBase’* C2039 ‘GetSchemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdVolOpenVDBAsset’* C2039 ‘GetSchemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdVolVolume’* C2039 ‘schemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdAPISchemaBase’* C2039 ‘schemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdClipsAPI’* C2039 ‘schemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdCollectionAPI’* C2039 ‘schemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomBasisCurves’* C2039 ‘schemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomBoundable’* C2039 ‘schemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomCamera’* C2039 ‘schemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomCapsule’* C2039 ‘schemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomCone’* C2039 ‘schemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomCube’* C2039 ‘schemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomCurves’* C2039 ‘schemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomCylinder’* C2039 ‘schemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomGprim’* C2039 ‘schemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomHermiteCurves’* C2039 ‘schemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomImageable’* C2039 ‘schemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomMesh’* C2039 ‘schemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomModelAPI’* C2039 ‘schemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomMotionAPI’* C2039 ‘schemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomNurbsCurves’* C2039 ‘schemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomNurbsPatch’* C2039 ‘schemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomPointBased’* C2039 ‘schemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomPointInstancer’* C2039 ‘schemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomPoints’* C2039 ‘schemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomPrimvarsAPI’* C2039 ‘schemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomScope’* C2039 ‘schemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomSphere’* C2039 ‘schemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomSubset’* C2039 ‘schemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomXform’* C2039 ‘schemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomXformable’* C2039 ‘schemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomXformCommonAPI’* C2039 ‘schemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxCylinderLight’* C2039 ‘schemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxDiskLight’* C2039 ‘schemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxDistantLight’* C2039 ‘schemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxDomeLight’* C2039 ‘schemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxGeometryLight’* C2039 ‘schemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxLightFilter’* C2039 ‘schemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxListAPI’* C2039 ‘schemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxRectLight’* C2039 ‘schemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxShadowAPI’* C2039 ‘schemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxShapingAPI’* C2039 ‘schemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxSphereLight’* C2039 ‘schemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdMediaSpatialAudio’* C2039 ‘schemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdModelAPI’* C2039 ‘schemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdRenderProduct’* C2039 ‘schemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdRenderSettings’* C2039 ‘schemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdRenderSettingsBase’* C2039 ‘schemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdRenderVar’* C2039 ‘schemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdSchemaBase’* C2039 ‘schemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI’* C2039 ‘schemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdShadeCoordSysAPI’* C2039 ‘schemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdShadeMaterial’* C2039 ‘schemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdShadeMaterialBindingAPI’* C2039 ‘schemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdShadeNodeGraph’* C2039 ‘schemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdShadeShader’* C2039 ‘schemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdSkelAnimation’* C2039 ‘schemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdSkelBindingAPI’* C2039 ‘schemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdSkelBlendShape’* C2039 ‘schemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdSkelPackedJointAnimation’* C2039 ‘schemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdSkelRoot’* C2039 ‘schemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdSkelSkeleton’* C2039 ‘schemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdTyped’* C2039 ‘schemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdUIBackdrop’* C2039 ‘schemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdUINodeGraphNodeAPI’* C2039 ‘schemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdUISceneGraphPrimAPI’* C2039 ‘schemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdVolField3DAsset’* C2039 ‘schemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdVolFieldAsset’* C2039 ‘schemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdVolFieldBase’* C2039 ‘schemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdVolOpenVDBAsset’* C2039 ‘schemaType’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdVolVolume’* C2065 ‘AbstractBase’: undeclared identifier* C2065 ‘AbstractTyped’: undeclared identifier* C2065 ‘ConcreteTyped’: undeclared identifier* C2065 ‘MultipleApplyAPI’: undeclared identifier* C2065 ‘NonAppliedAPI’: undeclared identifier* C2065 ‘schemaType’: undeclared identifier* C2065 ‘SingleApplyAPI’: undeclared identifier* C2653 ‘UsdSchemaType’: is not a class or namespace name
Python Error Strings:
* AttributeError: ‘Animation’ object has no attribute ‘GetSchemaType’. Did you mean: ‘GetSchemaKind’?* AttributeError: ‘Backdrop’ object has no attribute ‘GetSchemaType’. Did you mean: ‘GetSchemaKind’?* AttributeError: ‘BasisCurves’ object has no attribute ‘GetSchemaType’. Did you mean: ‘GetSchemaKind’?* AttributeError: ‘BindingAPI’ object has no attribute ‘GetSchemaType’. Did you mean: ‘GetSchemaKind’?* AttributeError: ‘BlendShape’ object has no attribute ‘GetSchemaType’. Did you mean: ‘GetSchemaKind’?* AttributeError: ‘Boundable’ object has no attribute ‘GetSchemaType’. Did you mean: ‘GetSchemaKind’?* AttributeError: ‘Camera’ object has no attribute ‘GetSchemaType’. Did you mean: ‘GetSchemaKind’?* AttributeError: ‘Capsule’ object has no attribute ‘GetSchemaType’. Did you mean: ‘GetSchemaKind’?* AttributeError: ‘ClipsAPI’ object has no attribute ‘GetSchemaType’. Did you mean: ‘GetSchemaKind’?* AttributeError: ‘CollectionAPI’ object has no attribute ‘GetSchemaType’. Did you mean: ‘GetSchemaKind’?* AttributeError: ‘Cone’ object has no attribute ‘GetSchemaType’. Did you mean: ‘GetSchemaKind’?* AttributeError: ‘ConnectableAPI’ object has no attribute ‘GetSchemaType’. Did you mean: ‘GetSchemaKind’?* AttributeError: ‘CoordSysAPI’ object has no attribute ‘GetSchemaType’. Did you mean: ‘GetSchemaKind’?* AttributeError: ‘Cube’ object has no attribute ‘GetSchemaType’. Did you mean: ‘GetSchemaKind’?* AttributeError: ‘Curves’ object has no attribute ‘GetSchemaType’. Did you mean: ‘GetSchemaKind’?* AttributeError: ‘Cylinder’ object has no attribute ‘GetSchemaType’. Did you mean: ‘GetSchemaKind’?* AttributeError: ‘CylinderLight’ object has no attribute ‘GetSchemaType’. Did you mean: ‘GetSchemaKind’?* AttributeError: ‘DiskLight’ object has no attribute ‘GetSchemaType’. Did you mean: ‘GetSchemaKind’?* AttributeError: ‘DistantLight’ object has no attribute ‘GetSchemaType’. Did you mean: ‘GetSchemaKind’?* AttributeError: ‘DomeLight’ object has no attribute ‘GetSchemaType’. Did you mean: ‘GetSchemaKind’?* AttributeError: ‘Field3DAsset’ object has no attribute ‘GetSchemaType’. Did you mean: ‘GetSchemaKind’?* AttributeError: ‘FieldAsset’ object has no attribute ‘GetSchemaType’. Did you mean: ‘GetSchemaKind’?* AttributeError: ‘FieldBase’ object has no attribute ‘GetSchemaType’. Did you mean: ‘GetSchemaKind’?* AttributeError: ‘GeometryLight’ object has no attribute ‘GetSchemaType’. Did you mean: ‘GetSchemaKind’?* AttributeError: ‘Gprim’ object has no attribute ‘GetSchemaType’. Did you mean: ‘GetSchemaKind’?* AttributeError: ‘HermiteCurves’ object has no attribute ‘GetSchemaType’. Did you mean: ‘GetSchemaKind’?* AttributeError: ‘Imageable’ object has no attribute ‘GetSchemaType’. Did you mean: ‘GetSchemaKind’?* AttributeError: ‘LightFilter’ object has no attribute ‘GetSchemaType’. Did you mean: ‘GetSchemaKind’?* AttributeError: ‘ListAPI’ object has no attribute ‘GetSchemaType’. Did you mean: ‘GetSchemaKind’?* AttributeError: ‘Material’ object has no attribute ‘GetSchemaType’. Did you mean: ‘GetSchemaKind’?* AttributeError: ‘MaterialBindingAPI’ object has no attribute ‘GetSchemaType’. Did you mean: ‘GetSchemaKind’?* AttributeError: ‘MdlAPI’ object has no attribute ‘GetSchemaType’. Did you mean: ‘GetSchemaKind’?* AttributeError: ‘Mesh’ object has no attribute ‘GetSchemaType’. Did you mean: ‘GetSchemaKind’?* AttributeError: ‘ModelAPI’ object has no attribute ‘GetSchemaType’. Did you mean: ‘GetSchemaKind’?* AttributeError: ‘MotionAPI’ object has no attribute ‘GetSchemaType’. Did you mean: ‘GetSchemaKind’?* AttributeError: ‘NodeGraph’ object has no attribute ‘GetSchemaType’. Did you mean: ‘GetSchemaKind’?* AttributeError: ‘NodeGraphNodeAPI’ object has no attribute ‘GetSchemaType’. Did you mean: ‘GetSchemaKind’?* AttributeError: ‘NurbsCurves’ object has no attribute ‘GetSchemaType’. Did you mean: ‘GetSchemaKind’?* AttributeError: ‘NurbsPatch’ object has no attribute ‘GetSchemaType’. Did you mean: ‘GetSchemaKind’?* AttributeError: ‘OpenVDBAsset’ object has no attribute ‘GetSchemaType’. Did you mean: ‘GetSchemaKind’?* AttributeError: ‘PackedJointAnimation’ object has no attribute ‘GetSchemaType’. Did you mean: ‘GetSchemaKind’?* AttributeError: ‘PointBased’ object has no attribute ‘GetSchemaType’. Did you mean: ‘GetSchemaKind’?* AttributeError: ‘PointInstancer’ object has no attribute ‘GetSchemaType’. Did you mean: ‘GetSchemaKind’?* AttributeError: ‘Points’ object has no attribute ‘GetSchemaType’. Did you mean: ‘GetSchemaKind’?* AttributeError: ‘PrimvarsAPI’ object has no attribute ‘GetSchemaType’. Did you mean: ‘GetSchemaKind’?* AttributeError: ‘Product’ object has no attribute ‘GetSchemaType’. Did you mean: ‘GetSchemaKind’?* AttributeError: ‘RectLight’ object has no attribute ‘GetSchemaType’. Did you mean: ‘GetSchemaKind’?* AttributeError: ‘Root’ object has no attribute ‘GetSchemaType’. Did you mean: ‘GetSchemaKind’?* AttributeError: ‘SceneGraphPrimAPI’ object has no attribute ‘GetSchemaType’. Did you mean: ‘GetSchemaKind’?* AttributeError: ‘SchemaBase’ object has no attribute ‘GetSchemaType’. Did you mean: ‘GetSchemaKind’?* AttributeError: ‘Scope’ object has no attribute ‘GetSchemaType’. Did you mean: ‘GetSchemaKind’?* AttributeError: ‘Settings’ object has no attribute ‘GetSchemaType’. Did you mean: ‘GetSchemaKind’?* AttributeError: ‘SettingsBase’ object has no attribute ‘GetSchemaType’. Did you mean: ‘GetSchemaKind’?* AttributeError: ‘Shader’ object has no attribute ‘GetSchemaType’. Did you mean: ‘GetSchemaKind’?* AttributeError: ‘ShadowAPI’ object has no attribute ‘GetSchemaType’. Did you mean: ‘GetSchemaKind’?* AttributeError: ‘ShapingAPI’ object has no attribute ‘GetSchemaType’. Did you mean: ‘GetSchemaKind’?* AttributeError: ‘Skeleton’ object has no attribute ‘GetSchemaType’. Did you mean: ‘GetSchemaKind’?* AttributeError: ‘SpatialAudio’ object has no attribute ‘GetSchemaType’. Did you mean: ‘GetSchemaKind’?* AttributeError: ‘Sphere’ object has no attribute ‘GetSchemaType’. Did you mean: ‘GetSchemaKind’?* AttributeError: ‘SphereLight’ object has no attribute ‘GetSchemaType’. Did you mean: ‘GetSchemaKind’?* AttributeError: ‘Subset’ object has no attribute ‘GetSchemaType’. Did you mean: ‘GetSchemaKind’?* AttributeError: ‘Typed’ object has no attribute ‘GetSchemaType’. Did you mean: ‘GetSchemaKind’?* AttributeError: ‘Var’ object has no attribute ‘GetSchemaType’. Did you mean: ‘GetSchemaKind’?* AttributeError: ‘Volume’ object has no attribute ‘GetSchemaType’. Did you mean: ‘GetSchemaKind’?* AttributeError: ‘Xform’ object has no attribute ‘GetSchemaType’. Did you mean: ‘GetSchemaKind’?* AttributeError: ‘XformCommonAPI’ object has no attribute ‘GetSchemaType’. Did you mean: ‘GetSchemaKind’?* AttributeError: ‘Xformable’ object has no attribute ‘GetSchemaType’. Did you mean: ‘GetSchemaKind’?* AttributeError: module ‘pxr.Usd’ has no attribute ‘SchemaType’. Did you mean: ‘SchemaBase’?
#### Property Names of MultipleApply Schemas now namespaced in schema spec
ie, the schema spec for CollectionAPI’s “includes” relationship was formerly just includes
Now, it includes a template for the instance name, and is:
collection:__INSTANCE_NAME__:includes
Use
Usd.SchemaRegistry.GetMultipleApplyNameTemplateBaseName(propertySpec.name)
to return just the “includes” portion, as before.
Functions for dealing with the new templated names can be found in
[UsdSchemaRegistry]:
[GetMultipleApplyNameTemplateBaseName]
[IsMultipleApplyNameTemplate]
[MakeMultipleApplyNameInstance]
[MakeMultipleApplyNameTemplate]
Reference Commits:
* Changing how we specify properties in multiple apply API schemas to make the namespacing more explicit.
Python Example Before:
from pxr import UsdmyStage = Usd.Stage.CreateInMemory()myPrim = myStage.DefinePrim(“/myPrim”, “Transform”)myCollection = Usd.CollectionAPI.ApplyCollection(myPrim, “MyCollection”)primDef = myPrim.GetPrimDefinition()propertySpec = primDef.GetSchemaPropertySpec(“collection:MyCollection:expansionRule”)baseSpecName = propertySpec.nameassert baseSpecName == “expansionRule”
Python Example After (22.03+ only):
from pxr import UsdmyStage = Usd.Stage.CreateInMemory()myPrim = myStage.DefinePrim(“/myPrim”, “Transform”)myCollection = Usd.CollectionAPI.Apply(myPrim, “MyCollection”)primDef = myPrim.GetPrimDefinition()propertySpec = primDef.GetSchemaPropertySpec(“collection:MyCollection:expansionRule”)assert propertySpec.name == “collection:__INSTANCE_NAME__:expansionRule”baseSpecName = Usd.SchemaRegistry.GetMultipleApplyNameTemplateBaseName(propertySpec.name)assert baseSpecName == “expansionRule”
Python Example After (branching):
from pxr import UsdmyStage = Usd.Stage.CreateInMemory()myPrim = myStage.DefinePrim(“/myPrim”, “Transform”)if hasattr(Usd.CollectionAPI, “Apply”): myCollection = Usd.CollectionAPI.Apply(myPrim, “MyCollection”)else: myCollection = Usd.CollectionAPI.ApplyCollection(myPrim, “MyCollection”)primDef = myPrim.GetPrimDefinition()propertySpec = primDef.GetSchemaPropertySpec(“collection:MyCollection:expansionRule”)if hasattr(Usd.SchemaRegistry, “GetMultipleApplyNameTemplateBaseName”): # 22.03+ assert propertySpec.name == “collection:__INSTANCE_NAME__:expansionRule” baseSpecName = Usd.SchemaRegistry.GetMultipleApplyNameTemplateBaseName(propertySpec.name)else: baseSpecName = propertySpec.nameassert baseSpecName == “expansionRule”
### Usd.Stage
#### GetMasters to GetPrototypes
Reference Commits:
* Deprecate “master” API in favor of new “prototype” API on UsdStage* Remove deprecated USD instancing “master” API
C++/Python Find Regex:
(?<=\W)GetMasters(?=\W)
C++/Python Replace Regex:
GetPrototypes
C++ Example Before:
for (auto const& master : myStage->GetMasters())
C++ Example After (20.11+ only):
for (auto const& prototype : myStage->GetPrototypes())
C++ Example After (branched):
#if PXR_VERSION >= 2011for (auto const& prototype : myStage->GetPrototypes())#elsefor (auto const& master : myStage->GetMasters())#endif
C++ Error Strings (Linux):
* ‘class pxrInternal_v0_22__pxrReserved__::UsdStage’ has no member named ‘GetMasters’* ‘pxrInternal_v0_22__pxrReserved__::TfWeakPtrFacade<pxrInternal_v0_22__pxrReserved__::TfWeakPtr, pxrInternal_v0_22__pxrReserved__::UsdStage>::DataType {aka class pxrInternal_v0_22__pxrReserved__::UsdStage}’ has no member named ‘GetMasters’
C++ Error Strings (Windows):
* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdStage” has no member “GetMasters”* C2039 ‘GetMasters’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdStage’
Python Error Strings:
AttributeError: ‘Stage’ object has no attribute ‘GetMasters’
## UsdGeom
### UsdGeom.Imageable
UsdGeomImageable has removed convenience APIs for accessing primvars
Primvars for derived types of UsdGeomImageage, such as UsdGeomMesh,
must be accessed through the UsdGeomPrimvarsAPI
Reference Commits:
* Deleting deprecated primvar methods from UsdGeomImageable
C++ Example Before:
PXR_NS::UsdStageRefPtr stage = PXR_NS::UsdStage::Open(boxUrl);PXR_NS::UsdPrim prim = stage->GetPrimAtPath(PXR_NS::SdfPath(“/Cube”));PXR_NS::UsdGeomMesh mesh(prim);PXR_NS::TfToken name(“pv”);mesh.HasPrimvar(name);mesh.GetPrimvar(name);mesh.CreatePrimvar(name, PXR_NS::SdfValueTypeNames->Float);
C++ Example After:
PXR_NS::UsdStageRefPtr stage = PXR_NS::UsdStage::Open(boxUrl);PXR_NS::UsdPrim prim = stage->GetPrimAtPath(PXR_NS::SdfPath(“/Cube”));PXR_NS::UsdGeomPrimvarsAPI primvarsAPI(prim);primvarsAPI.HasPrimvar(name);primvarsAPI.GetPrimvar(name);primvarsAPI.CreatePrimvar(name, PXR_NS::SdfValueTypeNames->Float);
C++ Error Strings (Windows):
* error C2039: ‘HasPrimvar’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomGprim’* error C2039: ‘GetPrimvar’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomGprim’* error C2039: ‘CreatePrimvar’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomGprim’
C++ Error Strings (Linux):
* ‘HasPrimvar’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomGprim’* ‘GetPrimvar’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomGprim’* ‘CreatePrimvar’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdGeomGprim’
### UsdGeom Subset
Material bindings authored on GeomSubsets are honored by renderers
only if their familyName is UsdShadeTokens->materialBind. This
allows robust interchange of subset bindings between multiple DCC
apps. See more at
[OM-32124].
Assets can be repaired via the Asset Validator extension, see
[UsdMaterialBindingApi].
Reference Commits:
* Update UsdShadeMaterialBinding::ComputeBoundMaterial
## UsdLux
### All properties now prefixed with "inputs:"
… including shaping and shadow attributes
Assets can be repaired via the Asset Validator extension, see
[UsdLuxSchemaChecker]
Property Name Changes, By Schema:
Light:
intensity to inputs:intensity
exposure to inputs:exposure
diffuse to inputs:diffuse
specular to inputs:specular
normalize to inputs:normalize
color to inputs:color
enableColorTemperature to inputs:enableColorTemperature
colorTemperature to inputs:colorTemperature
DistantLight:
angle to inputs:angle
DiskLight:
radius to inputs:radius
RectLight:
width to inputs:width
height to inputs:height
texture:file to inputs:texture:file
SphereLight:
radius to inputs:radius
CylinderLight:
length to inputs:length
radius to inputs:radius
DomeLight:
texture:file to inputs:texture:file
texture:format to inputs:texture:format
ShapingAPI:
shaping:focus to inputs:shaping:focus
shaping:focusTint to inputs:shaping:focusTint
shaping:cone:angle to inputs:shaping:cone:angle
shaping:cone:softness to inputs:shaping:cone:softness
shaping:ies:file to inputs:shaping:ies:file
shaping:ies:angleScale to inputs:shaping:ies:angleScale
shaping:ies:normalize to inputs:shaping:ies:normalize
ShadowAPI:
shadow:enable to inputs:shadow:enable
shadow:color to inputs:shadow:color
shadow:distance to inputs:shadow:distance
shadow:falloff to inputs:shadow:falloff
shadow:falloffGamma to inputs:shadow:falloffGamma
UsdLuxTokens name changes:
angle to inputsAngle
color to inputsColor
colorTemperature to inputsColorTemperature
diffuse to inputsDiffuse
enableColorTemperature to inputsEnableColorTemperature
exposure to inputsExposure
height to inputsHeight
intensity to inputsIntensity
length to inputsLength
normalize to inputsNormalize
radius to inputsRadius
shadowColor to inputsShadowColor
shadowDistance to inputsShadowDistance
shadowEnable to inputsShadowEnable
shadowFalloff to inputsShadowFalloff
shadowFalloffGamma to inputsShadowFalloffGamma
shapingConeAngle to inputsShapingConeAngle
shapingConeSoftness to inputsShapingConeSoftness
shapingFocus to inputsShapingFocus
shapingFocusTint to inputsShapingFocusTint
shapingIesAngleScale to inputsShapingIesAngleScale
shapingIesFile to inputsShapingIesFile
shapingIesNormalize to inputsShapingIesNormalize
specular to inputsSpecular
textureFile to inputsTextureFile
textureFormat to inputsTextureFormat
width to inputsWidth
Reference Commits:
* Updated the schema in usdLux to have all attributes of Light and its inherited types use the “inputs:” prefix (with the exception of treatAsLine and treatAsPoint)* Shadow and Shaping APIs are now connectable. All attributes on these APIs have been given the “inputs:” prefix
C++/Python Find Regex:
(?<=UsdLux.Tokens.|UsdLuxTokens->)(angle|color|colorTemperature|diffuse|enableColorTemperature|exposure|height|intensity|length|normalize|radius|shadowColor|shadowDistance|shadowEnable|shadowFalloff|shadowFalloffGamma|shapingConeAngle|shapingConeSoftness|shapingFocus|shapingFocusTint|shapingIesAngleScale|shapingIesFile|shapingIesNormalize|specular|textureFile|textureFormat|width)(?=\W)
Python Example Before:
print(UsdLux.Tokens.angle)print(UsdLux.Tokens.color)print(UsdLux.Tokens.colorTemperature)print(UsdLux.Tokens.diffuse)print(UsdLux.Tokens.enableColorTemperature)print(UsdLux.Tokens.exposure)print(UsdLux.Tokens.height)print(UsdLux.Tokens.intensity)print(UsdLux.Tokens.length)print(UsdLux.Tokens.normalize)print(UsdLux.Tokens.radius)print(UsdLux.Tokens.shadowColor)print(UsdLux.Tokens.shadowDistance)print(UsdLux.Tokens.shadowEnable)print(UsdLux.Tokens.shadowFalloff)print(UsdLux.Tokens.shadowFalloffGamma)print(UsdLux.Tokens.shapingConeAngle)print(UsdLux.Tokens.shapingConeSoftness)print(UsdLux.Tokens.shapingFocus)print(UsdLux.Tokens.shapingFocusTint)print(UsdLux.Tokens.shapingIesAngleScale)print(UsdLux.Tokens.shapingIesFile)print(UsdLux.Tokens.shapingIesNormalize)print(UsdLux.Tokens.specular)print(UsdLux.Tokens.textureFile)print(UsdLux.Tokens.textureFormat)print(UsdLux.Tokens.width)
Python Example After (21.02+ only):
from pxr import UsdLuxprint(UsdLux.Tokens.inputsAngle)print(UsdLux.Tokens.inputsColor)print(UsdLux.Tokens.inputsColorTemperature)print(UsdLux.Tokens.inputsDiffuse)print(UsdLux.Tokens.inputsEnableColorTemperature)print(UsdLux.Tokens.inputsExposure)print(UsdLux.Tokens.inputsHeight)print(UsdLux.Tokens.inputsIntensity)print(UsdLux.Tokens.inputsLength)print(UsdLux.Tokens.inputsNormalize)print(UsdLux.Tokens.inputsRadius)print(UsdLux.Tokens.inputsShadowColor)print(UsdLux.Tokens.inputsShadowDistance)print(UsdLux.Tokens.inputsShadowEnable)print(UsdLux.Tokens.inputsShadowFalloff)print(UsdLux.Tokens.inputsShadowFalloffGamma)print(UsdLux.Tokens.inputsShapingConeAngle)print(UsdLux.Tokens.inputsShapingConeSoftness)print(UsdLux.Tokens.inputsShapingFocus)print(UsdLux.Tokens.inputsShapingFocusTint)print(UsdLux.Tokens.inputsShapingIesAngleScale)print(UsdLux.Tokens.inputsShapingIesFile)print(UsdLux.Tokens.inputsShapingIesNormalize)print(UsdLux.Tokens.inputsSpecular)print(UsdLux.Tokens.inputsTextureFile)print(UsdLux.Tokens.inputsTextureFormat)print(UsdLux.Tokens.inputsWidth)
Python Example After (branched):
from pxr import UsdLuxif hasattr(UsdLux.Tokens, “inputsAngle”): # >= 21.02 print(UsdLux.Tokens.inputsAngle) print(UsdLux.Tokens.inputsColor) print(UsdLux.Tokens.inputsColorTemperature) print(UsdLux.Tokens.inputsDiffuse) print(UsdLux.Tokens.inputsEnableColorTemperature) print(UsdLux.Tokens.inputsExposure) print(UsdLux.Tokens.inputsHeight) print(UsdLux.Tokens.inputsIntensity) print(UsdLux.Tokens.inputsLength) print(UsdLux.Tokens.inputsNormalize) print(UsdLux.Tokens.inputsRadius) print(UsdLux.Tokens.inputsShadowColor) print(UsdLux.Tokens.inputsShadowDistance) print(UsdLux.Tokens.inputsShadowEnable) print(UsdLux.Tokens.inputsShadowFalloff) print(UsdLux.Tokens.inputsShadowFalloffGamma) print(UsdLux.Tokens.inputsShapingConeAngle) print(UsdLux.Tokens.inputsShapingConeSoftness) print(UsdLux.Tokens.inputsShapingFocus) print(UsdLux.Tokens.inputsShapingFocusTint) print(UsdLux.Tokens.inputsShapingIesAngleScale) print(UsdLux.Tokens.inputsShapingIesFile) print(UsdLux.Tokens.inputsShapingIesNormalize) print(UsdLux.Tokens.inputsSpecular) print(UsdLux.Tokens.inputsTextureFile) print(UsdLux.Tokens.inputsTextureFormat) print(UsdLux.Tokens.inputsWidth)else: print(UsdLux.Tokens.angle) print(UsdLux.Tokens.color) print(UsdLux.Tokens.colorTemperature) print(UsdLux.Tokens.diffuse) print(UsdLux.Tokens.enableColorTemperature) print(UsdLux.Tokens.exposure) print(UsdLux.Tokens.height) print(UsdLux.Tokens.intensity) print(UsdLux.Tokens.length) print(UsdLux.Tokens.normalize) print(UsdLux.Tokens.radius) print(UsdLux.Tokens.shadowColor) print(UsdLux.Tokens.shadowDistance) print(UsdLux.Tokens.shadowEnable) print(UsdLux.Tokens.shadowFalloff) print(UsdLux.Tokens.shadowFalloffGamma) print(UsdLux.Tokens.shapingConeAngle) print(UsdLux.Tokens.shapingConeSoftness) print(UsdLux.Tokens.shapingFocus) print(UsdLux.Tokens.shapingFocusTint) print(UsdLux.Tokens.shapingIesAngleScale) print(UsdLux.Tokens.shapingIesFile) print(UsdLux.Tokens.shapingIesNormalize) print(UsdLux.Tokens.specular) print(UsdLux.Tokens.textureFile) print(UsdLux.Tokens.textureFormat) print(UsdLux.Tokens.width)
C++ Error Strings (Linux):
* ‘struct pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType’ has no member named ‘angle’; did you mean ‘angular’\?* ‘struct pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType’ has no member named ‘color’* ‘struct pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType’ has no member named ‘colorTemperature’; did you mean ‘inputsColorTemperature’\?* ‘struct pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType’ has no member named ‘diffuse’* ‘struct pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType’ has no member named ‘enableColorTemperature’; did you mean ‘inputsColorTemperature’\?* ‘struct pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType’ has no member named ‘exposure’* ‘struct pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType’ has no member named ‘height’* ‘struct pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType’ has no member named ‘intensity’* ‘struct pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType’ has no member named ‘length’* ‘struct pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType’ has no member named ‘normalize’* ‘struct pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType’ has no member named ‘radius’* ‘struct pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType’ has no member named ‘shadowColor’* ‘struct pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType’ has no member named ‘shadowDistance’; did you mean ‘inputsShadowDistance’\?* ‘struct pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType’ has no member named ‘shadowEnable’; did you mean ‘inputsShadowEnable’\?* ‘struct pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType’ has no member named ‘shadowFalloff’; did you mean ‘inputsShadowFalloff’\?* ‘struct pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType’ has no member named ‘shadowFalloffGamma’; did you mean ‘inputsShadowFalloffGamma’\?* ‘struct pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType’ has no member named ‘shapingConeAngle’; did you mean ‘inputsShapingConeAngle’\?* ‘struct pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType’ has no member named ‘shapingConeSoftness’; did you mean ‘inputsShapingConeSoftness’\?* ‘struct pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType’ has no member named ‘shapingFocus’; did you mean ‘inputsShapingFocus’\?* ‘struct pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType’ has no member named ‘shapingFocusTint’; did you mean ‘inputsShapingFocusTint’\?* ‘struct pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType’ has no member named ‘shapingIesAngleScale’; did you mean ‘inputsShapingIesAngleScale’\?* ‘struct pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType’ has no member named ‘shapingIesFile’; did you mean ‘inputsShapingIesFile’\?* ‘struct pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType’ has no member named ‘shapingIesNormalize’; did you mean ‘inputsShapingIesNormalize’\?* ‘struct pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType’ has no member named ‘specular’* ‘struct pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType’ has no member named ‘textureFile’; did you mean ‘inputsTextureFile’?* ‘struct pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType’ has no member named ‘textureFormat’; did you mean ‘inputsTextureFormat’?* ‘struct pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType’ has no member named ‘width’
C++ Error Strings (Windows):
* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType” has no member “angle”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType” has no member “color”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType” has no member “colorTemperature”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType” has no member “diffuse”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType” has no member “enableColorTemperature”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType” has no member “exposure”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType” has no member “height”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType” has no member “intensity”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType” has no member “length”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType” has no member “normalize”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType” has no member “radius”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType” has no member “shadowColor”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType” has no member “shadowDistance”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType” has no member “shadowEnable”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType” has no member “shadowFalloff”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType” has no member “shadowFalloffGamma”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType” has no member “shapingConeAngle”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType” has no member “shapingConeSoftness”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType” has no member “shapingFocus”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType” has no member “shapingFocusTint”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType” has no member “shapingIesAngleScale”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType” has no member “shapingIesFile”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType” has no member “shapingIesNormalize”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType” has no member “specular”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType” has no member “textureFile”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType” has no member “textureFormat”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType” has no member “width”* C2039 ‘angle’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType’* C2039 ‘color’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType’* C2039 ‘colorTemperature’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType’* C2039 ‘diffuse’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType’* C2039 ‘enableColorTemperature’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType’* C2039 ‘exposure’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType’* C2039 ‘height’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType’* C2039 ‘intensity’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType’* C2039 ‘length’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType’* C2039 ‘normalize’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType’* C2039 ‘radius’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType’* C2039 ‘shadowColor’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType’* C2039 ‘shadowDistance’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType’* C2039 ‘shadowEnable’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType’* C2039 ‘shadowFalloff’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType’* C2039 ‘shadowFalloffGamma’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType’* C2039 ‘shapingConeAngle’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType’* C2039 ‘shapingConeSoftness’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType’* C2039 ‘shapingFocus’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType’* C2039 ‘shapingFocusTint’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType’* C2039 ‘shapingIesAngleScale’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType’* C2039 ‘shapingIesFile’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType’* C2039 ‘shapingIesNormalize’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType’* C2039 ‘specular’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType’* C2039 ‘textureFile’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType’* C2039 ‘textureFormat’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType’* C2039 ‘width’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxTokensType’
Python Error Strings:
* AttributeError: type object ‘Tokens’ has no attribute ‘angle’* AttributeError: type object ‘Tokens’ has no attribute ‘color’* AttributeError: type object ‘Tokens’ has no attribute ‘colorTemperature’* AttributeError: type object ‘Tokens’ has no attribute ‘diffuse’* AttributeError: type object ‘Tokens’ has no attribute ‘enableColorTemperature’* AttributeError: type object ‘Tokens’ has no attribute ‘exposure’* AttributeError: type object ‘Tokens’ has no attribute ‘height’* AttributeError: type object ‘Tokens’ has no attribute ‘intensity’* AttributeError: type object ‘Tokens’ has no attribute ‘length’* AttributeError: type object ‘Tokens’ has no attribute ‘normalize’* AttributeError: type object ‘Tokens’ has no attribute ‘radius’* AttributeError: type object ‘Tokens’ has no attribute ‘shadowColor’* AttributeError: type object ‘Tokens’ has no attribute ‘shadowDistance’* AttributeError: type object ‘Tokens’ has no attribute ‘shadowEnable’* AttributeError: type object ‘Tokens’ has no attribute ‘shadowFalloff’* AttributeError: type object ‘Tokens’ has no attribute ‘shadowFalloffGamma’* AttributeError: type object ‘Tokens’ has no attribute ‘shapingConeAngle’* AttributeError: type object ‘Tokens’ has no attribute ‘shapingConeSoftness’* AttributeError: type object ‘Tokens’ has no attribute ‘shapingFocus’* AttributeError: type object ‘Tokens’ has no attribute ‘shapingFocusTint’* AttributeError: type object ‘Tokens’ has no attribute ‘shapingIesAngleScale’* AttributeError: type object ‘Tokens’ has no attribute ‘shapingIesFile’* AttributeError: type object ‘Tokens’ has no attribute ‘shapingIesNormalize’* AttributeError: type object ‘Tokens’ has no attribute ‘specular’* AttributeError: type object ‘Tokens’ has no attribute ‘textureFile’* AttributeError: type object ‘Tokens’ has no attribute ‘textureFormat’* AttributeError: type object ‘Tokens’ has no attribute ‘width’
### UsdLux.Light
#### UsdLux Light to UsdLuxLightAPI
Reference Commits:
* Creates the new single apply UsdLuxLightAPI applied API schema in preparation for migrating lights to having an applied LightAPI* Updates in usdLux to replace references to UsdLuxLight* Deleting UsdLuxLight and UsdLuxLightPortal
C++/Python Find Regex:
(?<=\W)Usd(?:.)LuxLight(?=\W)
C++ Example Before:
auto myStage = UsdStage::CreateInMemory();auto sphereLight = UsdLuxSphereLight::Define(myStage, SdfPath(“/sphereLight”));auto sphereLightPrim = sphereLight.GetPrim();if (sphereLightPrim.IsA<PXR_NS::UsdLuxLight>()) { std::cout << “It’s a light!” << std::endl;}if (sphereLightPrim.IsA<UsdLuxLight>()) { std::cout << “It’s a light!” << std::endl;}sphereLight.GetLightLinkCollectionAPI();sphereLight.GetShadowLinkCollectionAPI();
C++ Example After (21.11+ only):
auto myStage = UsdStage::CreateInMemory();auto sphereLight = UsdLuxSphereLight::Define(myStage, SdfPath(“/sphereLight”));auto sphereLightPrim = sphereLight.GetPrim();if (sphereLightPrim.HasAPI<PXR_NS::UsdLuxLightAPI>()) { std::cout << “It’s a light!” << std::endl;}if (sphereLightPrim.HasAPI<UsdLuxLightAPI>()) { std::cout << “It’s a light!” << std::endl;}UsdLuxLightAPI(sphereLight).GetLightLinkCollectionAPI();UsdLuxLightAPI(sphereLight).GetShadowLinkCollectionAPI();
C++ Example After (branched):
auto myStage = UsdStage::CreateInMemory();auto sphereLight = UsdLuxSphereLight::Define(myStage, SdfPath(“/sphereLight”));auto sphereLightPrim = sphereLight.GetPrim();#if PXR_VERSION >= 2111if (sphereLightPrim.HasAPI<PXR_NS::UsdLuxLightAPI>()) { std::cout << “It’s a light!” << std::endl;}if (sphereLightPrim.HasAPI<UsdLuxLightAPI>()) { std::cout << “It’s a light!” << std::endl;}UsdLuxLightAPI(sphereLight).GetLightLinkCollectionAPI();UsdLuxLightAPI(sphereLight).GetShadowLinkCollectionAPI();#elseif (sphereLightPrim.IsA<PXR_NS::UsdLuxLight>()) { std::cout << “It’s a light!” << std::endl;}if (sphereLightPrim.IsA<UsdLuxLight>()) { std::cout << “It’s a light!” << std::endl;}sphereLight.GetLightLinkCollectionAPI();sphereLight.GetShadowLinkCollectionAPI();#endif
C++ Error Strings (Linux):
* ‘class pxrInternal_v0_22__pxrReserved__::UsdLuxCylinderLight’ has no member named ‘GetLightLinkCollectionAPI’* ‘class pxrInternal_v0_22__pxrReserved__::UsdLuxCylinderLight’ has no member named ‘GetShadowLinkCollectionAPI’* ‘class pxrInternal_v0_22__pxrReserved__::UsdLuxDiskLight’ has no member named ‘GetLightLinkCollectionAPI’* ‘class pxrInternal_v0_22__pxrReserved__::UsdLuxDiskLight’ has no member named ‘GetShadowLinkCollectionAPI’* ‘class pxrInternal_v0_22__pxrReserved__::UsdLuxDistantLight’ has no member named ‘GetLightLinkCollectionAPI’* ‘class pxrInternal_v0_22__pxrReserved__::UsdLuxDistantLight’ has no member named ‘GetShadowLinkCollectionAPI’* ‘class pxrInternal_v0_22__pxrReserved__::UsdLuxDomeLight’ has no member named ‘GetLightLinkCollectionAPI’* ‘class pxrInternal_v0_22__pxrReserved__::UsdLuxDomeLight’ has no member named ‘GetShadowLinkCollectionAPI’* ‘class pxrInternal_v0_22__pxrReserved__::UsdLuxGeometryLight’ has no member named ‘GetLightLinkCollectionAPI’* ‘class pxrInternal_v0_22__pxrReserved__::UsdLuxGeometryLight’ has no member named ‘GetShadowLinkCollectionAPI’* ‘class pxrInternal_v0_22__pxrReserved__::UsdLuxRectLight’ has no member named ‘GetLightLinkCollectionAPI’* ‘class pxrInternal_v0_22__pxrReserved__::UsdLuxRectLight’ has no member named ‘GetShadowLinkCollectionAPI’* ‘class pxrInternal_v0_22__pxrReserved__::UsdLuxSphereLight’ has no member named ‘GetLightLinkCollectionAPI’* ‘class pxrInternal_v0_22__pxrReserved__::UsdLuxSphereLight’ has no member named ‘GetShadowLinkCollectionAPI’* ‘UsdLuxLight’ is not a member of ‘pxr’* ‘UsdLuxLight’ was not declared in this scope
C++ Error Strings (Windows):
* C2039 ‘GetLightLinkCollectionAPI’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxCylinderLight’* C2039 ‘GetLightLinkCollectionAPI’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxDiskLight’* C2039 ‘GetLightLinkCollectionAPI’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxDistantLight’* C2039 ‘GetLightLinkCollectionAPI’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxDomeLight’* C2039 ‘GetLightLinkCollectionAPI’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxGeometryLight’* C2039 ‘GetLightLinkCollectionAPI’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxRectLight’* C2039 ‘GetLightLinkCollectionAPI’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxSphereLight’* C2039 ‘GetShadowLinkCollectionAPI’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxCylinderLight’* C2039 ‘GetShadowLinkCollectionAPI’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxDiskLight’* C2039 ‘GetShadowLinkCollectionAPI’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxDistantLight’* C2039 ‘GetShadowLinkCollectionAPI’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxDomeLight’* C2039 ‘GetShadowLinkCollectionAPI’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxGeometryLight’* C2039 ‘GetShadowLinkCollectionAPI’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxRectLight’* C2039 ‘GetShadowLinkCollectionAPI’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxSphereLight’* C2039 ‘UsdLuxLight’: is not a member of ‘pxr’* C2065 ‘UsdLuxLight’: undeclared identifier* C2065 ‘UsdLuxLight’: undeclared identifier* C2672 ‘pxrInternal_v0_22__pxrReserved__::UsdPrim::IsA’: no matching overloaded function found* C2672 ‘pxrInternal_v0_22__pxrReserved__::UsdPrim::IsA’: no matching overloaded function found* C2974 ‘pxrInternal_v0_22__pxrReserved__::UsdPrim::IsA’: invalid template argument for ‘T’, type expected* C2974 ‘pxrInternal_v0_22__pxrReserved__::UsdPrim::IsA’: invalid template argument for ‘T’, type expected* E0020 identifier “UsdLuxLight” is undefined* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdLuxCylinderLight” has no member “GetLightLinkCollectionAPI”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdLuxCylinderLight” has no member “GetShadowLinkCollectionAPI”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdLuxDiskLight” has no member “GetLightLinkCollectionAPI”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdLuxDiskLight” has no member “GetShadowLinkCollectionAPI”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdLuxDistantLight” has no member “GetLightLinkCollectionAPI”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdLuxDistantLight” has no member “GetShadowLinkCollectionAPI”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdLuxDomeLight” has no member “GetLightLinkCollectionAPI”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdLuxDomeLight” has no member “GetShadowLinkCollectionAPI”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdLuxGeometryLight” has no member “GetLightLinkCollectionAPI”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdLuxGeometryLight” has no member “GetShadowLinkCollectionAPI”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdLuxRectLight” has no member “GetLightLinkCollectionAPI”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdLuxRectLight” has no member “GetShadowLinkCollectionAPI”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdLuxSphereLight” has no member “GetLightLinkCollectionAPI”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdLuxSphereLight” has no member “GetShadowLinkCollectionAPI”* E0135 namespace “pxr” has no member “UsdLuxLight”
Python Error Strings:
* AttributeError: module ‘pxr.UsdLux’ has no attribute ‘Light’* AttributeError: ‘SphereLight’ object has no attribute ‘GetLightLinkCollectionAPI’* AttributeError: ‘SphereLight’ object has no attribute ‘GetShadowLinkCollectionAPI’* AttributeError: ‘CylinderLight’ object has no attribute ‘GetLightLinkCollectionAPI’* AttributeError: ‘CylinderLight’ object has no attribute ‘GetShadowLinkCollectionAPI’* AttributeError: ‘DiskLight’ object has no attribute ‘GetLightLinkCollectionAPI’* AttributeError: ‘DiskLight’ object has no attribute ‘GetShadowLinkCollectionAPI’* AttributeError: ‘DistantLight’ object has no attribute ‘GetLightLinkCollectionAPI’* AttributeError: ‘DistantLight’ object has no attribute ‘GetShadowLinkCollectionAPI’* AttributeError: ‘DomeLight’ object has no attribute ‘GetLightLinkCollectionAPI’* AttributeError: ‘DomeLight’ object has no attribute ‘GetShadowLinkCollectionAPI’* AttributeError: ‘GeometryLight’ object has no attribute ‘GetLightLinkCollectionAPI’* AttributeError: ‘GeometryLight’ object has no attribute ‘GetShadowLinkCollectionAPI’* AttributeError: ‘RectLight’ object has no attribute ‘GetLightLinkCollectionAPI’* AttributeError: ‘RectLight’ object has no attribute ‘GetShadowLinkCollectionAPI’
#### UsdLux LightPortal to UsdLux PortalLight
TODO
#### UsdLuxLight.ComputeBaseEmission() removed
This function existed “solely as a reference example implementation of
how to interpret [UsdLuxLight’s] parameters.” It has been removed,
and there is no replacement. If you were making use of it, you will
have to add your own implementation - this function would duplicate
the old behavior:
GfVec3f ComputeBaseEmission(const UsdLuxLightAPI& light)
{
GfVec3f e(1.0);
float intensity = 1.0;
light.GetIntensityAttr().Get(&intensity);
e *= intensity;
float exposure = 0.0;
light.GetExposureAttr().Get(&exposure);
e *= exp2(exposure);
GfVec3f color(1.0);
light.GetColorAttr().Get(&color);
e = GfCompMult(e, color);
bool enableColorTemp = false;
light.GetEnableColorTemperatureAttr().Get(&enableColorTemp);
if (enableColorTemp) {
float colorTemp = 6500;
if (light.GetColorTemperatureAttr().Get(&colorTemp)) {
e = GfCompMult(e, UsdLuxBlackbodyTemperatureAsRgb(colorTemp));
}
}
return e;
}
Reference Commits:
Deleting UsdLuxLight and UsdLuxLightPortal
C++/Python Find Regex:
(?<=\W)ComputeBaseEmission(?=\W)
C++ Error Strings (Linux):
* ‘class pxrInternal_v0_22__pxrReserved__::UsdLuxCylinderLight’ has no member named ‘ComputeBaseEmission’* ‘class pxrInternal_v0_22__pxrReserved__::UsdLuxDiskLight’ has no member named ‘ComputeBaseEmission’* ‘class pxrInternal_v0_22__pxrReserved__::UsdLuxDistantLight’ has no member named ‘ComputeBaseEmission’* ‘class pxrInternal_v0_22__pxrReserved__::UsdLuxDomeLight’ has no member named ‘ComputeBaseEmission’* ‘class pxrInternal_v0_22__pxrReserved__::UsdLuxGeometryLight’ has no member named ‘ComputeBaseEmission’* ‘class pxrInternal_v0_22__pxrReserved__::UsdLuxRectLight’ has no member named ‘ComputeBaseEmission’* ‘class pxrInternal_v0_22__pxrReserved__::UsdLuxSphereLight’ has no member named ‘ComputeBaseEmission’
C++ Error Strings (Windows):
* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdLuxCylinderLight” has no member “ComputeBaseEmission”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdLuxDiskLight” has no member “ComputeBaseEmission”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdLuxDistantLight” has no member “ComputeBaseEmission”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdLuxDomeLight” has no member “ComputeBaseEmission”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdLuxGeometryLight” has no member “ComputeBaseEmission”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdLuxRectLight” has no member “ComputeBaseEmission”* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdLuxSphereLight” has no member “ComputeBaseEmission”* C2039 ‘ComputeBaseEmission’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxCylinderLight’* C2039 ‘ComputeBaseEmission’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxDiskLight’* C2039 ‘ComputeBaseEmission’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxDistantLight’* C2039 ‘ComputeBaseEmission’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxDomeLight’* C2039 ‘ComputeBaseEmission’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxGeometryLight’* C2039 ‘ComputeBaseEmission’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxRectLight’* C2039 ‘ComputeBaseEmission’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdLuxSphereLight’
Python Error Strings:
* AttributeError: ‘CylinderLight’ object has no attribute ‘ComputeBaseEmission’* AttributeError: ‘DiskLight’ object has no attribute ‘ComputeBaseEmission’* AttributeError: ‘DistantLight’ object has no attribute ‘ComputeBaseEmission’* AttributeError: ‘DomeLight’ object has no attribute ‘ComputeBaseEmission’* AttributeError: ‘GeometryLight’ object has no attribute ‘ComputeBaseEmission’* AttributeError: ‘RectLight’ object has no attribute ‘ComputeBaseEmission’* AttributeError: ‘SphereLight’ object has no attribute ‘ComputeBaseEmission’
#### UsdLux.LightFilterAPI removed
## UsdPhysics
### UsdPhysics Schema Changes
#### UsdPhysics uses USD stock schema.
Reference Commits:
* UsdPhysics API
C++ Example Before:
#include <usdPhysics/tokens.h>
C++ Example After (all versions):
#include <pxr/usd/usdPhysics/tokens.h>
C++ Error Strings
* Cannot open include file: ‘usdPhyiscs/articulationRootAPI.h’: No such file or directory* Cannot open include file: ‘usdPhyiscs/collisionAPI.h’: No such file or directory* Cannot open include file: ‘usdPhyiscs/meshCollisionAPI.h’: No such file or directory* Cannot open include file: ‘usdPhyiscs/collisionGroup.h’: No such file or directory* Cannot open include file: ‘usdPhyiscs/distanceJoint.h’: No such file or directory* Cannot open include file: ‘usdPhyiscs/driveAPI.h’: No such file or directory* Cannot open include file: ‘usdPhyiscs/filteredPairsAPI.h’: No such file or directory* Cannot open include file: ‘usdPhyiscs/joint.h’: No such file or directory* Cannot open include file: ‘usdPhyiscs/limitAPI.h’: No such file or directory* Cannot open include file: ‘usdPhyiscs/massAPI.h’: No such file or directory* Cannot open include file: ‘usdPhyiscs/metrics.h’: No such file or directory* Cannot open include file: ‘usdPhyiscs/rigidBodyAPI.h’: No such file or directory* Cannot open include file: ‘usdPhyiscs/materialAPI.h’: No such file or directory* Cannot open include file: ‘usdPhyiscs/scene.h’: No such file or directory* Cannot open include file: ‘usdPhyiscs/prismaticJoint.h’: No such file or directory* Cannot open include file: ‘usdPhyiscs/revoluteJoint.h’: No such file or directory* Cannot open include file: ‘usdPhyiscs/sphericalJoint.h’: No such file or directory* Cannot open include file: ‘usdPhyiscs/fixedJoint.h’: No such file or directory* Cannot open include file: ‘usdPhyiscs/tokens.h’: No such file or directory
#### UsdRender
##### UsdRender.SettingsAPI
###### UsdRender SettingsAPI removed
TODO
#### UsdShade
##### UsdShade.ConnectableAPI
###### Explicit ctor required for shaders and nodegraphs
See also: https://groups.google.com/g/usd-interest/c/I7gY7LpNkjw/m/Zjm7gFVUBgAJ
Reference Commits:
* UsdShade API concept separation
Python Example Before:
material.CreateSurfaceOutput().ConnectToSource(shader, “out”)
Python Example After (all versions):
material.CreateSurfaceOutput().ConnectToSource(shader.ConnectableAPI(), “out”)
C++ Error Strings (Linux):
* no known conversion for argument 1 from ‘pxrInternal_v0_22__pxrReserved__::UsdShadeMaterial’ to ‘const pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI&’* no known conversion for argument 1 from ‘pxrInternal_v0_22__pxrReserved__::UsdShadeNodeGraph’ to ‘const pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI&’* no known conversion for argument 1 from ‘pxrInternal_v0_22__pxrReserved__::UsdShadeShader’ to ‘const pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI&’* no known conversion for argument 2 from ‘pxrInternal_v0_22__pxrReserved__::UsdShadeMaterial’ to ‘const pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI&’* no known conversion for argument 2 from ‘pxrInternal_v0_22__pxrReserved__::UsdShadeNodeGraph’ to ‘const pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI&’* no known conversion for argument 2 from ‘pxrInternal_v0_22__pxrReserved__::UsdShadeShader’ to ‘const pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI&’* no matching function for call to ‘pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource(pxrInternal_v0_22__pxrReserved__::UsdAttribute&, pxrInternal_v0_22__pxrReserved__::UsdShadeMaterial&, const pxrInternal_v0_22__pxrReserved__::TfToken&, pxrInternal_v0_22__pxrReserved__::UsdShadeAttributeType, const pxrInternal_v0_22__pxrReserved__::SdfValueTypeName&)’* no matching function for call to ‘pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource(pxrInternal_v0_22__pxrReserved__::UsdAttribute&, pxrInternal_v0_22__pxrReserved__::UsdShadeMaterial&, const pxrInternal_v0_22__pxrReserved__::TfToken&, pxrInternal_v0_22__pxrReserved__::UsdShadeAttributeType)’* no matching function for call to ‘pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource(pxrInternal_v0_22__pxrReserved__::UsdAttribute&, pxrInternal_v0_22__pxrReserved__::UsdShadeMaterial&, const pxrInternal_v0_22__pxrReserved__::TfToken&)’* no matching function for call to ‘pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource(pxrInternal_v0_22__pxrReserved__::UsdAttribute&, pxrInternal_v0_22__pxrReserved__::UsdShadeMaterial&, pxrInternal_v0_22__pxrReserved__::TfToken&, pxrInternal_v0_22__pxrReserved__::UsdShadeAttributeType, const pxrInternal_v0_22__pxrReserved__::SdfValueTypeName&)’* no matching function for call to ‘pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource(pxrInternal_v0_22__pxrReserved__::UsdAttribute&, pxrInternal_v0_22__pxrReserved__::UsdShadeMaterial&, pxrInternal_v0_22__pxrReserved__::TfToken&, pxrInternal_v0_22__pxrReserved__::UsdShadeAttributeType)’* no matching function for call to ‘pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource(pxrInternal_v0_22__pxrReserved__::UsdAttribute&, pxrInternal_v0_22__pxrReserved__::UsdShadeMaterial&, pxrInternal_v0_22__pxrReserved__::TfToken&)’* no matching function for call to ‘pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource(pxrInternal_v0_22__pxrReserved__::UsdAttribute&, pxrInternal_v0_22__pxrReserved__::UsdShadeNodeGraph&, pxrInternal_v0_22__pxrReserved__::TfToken&, pxrInternal_v0_22__pxrReserved__::UsdShadeAttributeType, const pxrInternal_v0_22__pxrReserved__::SdfValueTypeName&)’* no matching function for call to ‘pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource(pxrInternal_v0_22__pxrReserved__::UsdAttribute&, pxrInternal_v0_22__pxrReserved__::UsdShadeNodeGraph&, pxrInternal_v0_22__pxrReserved__::TfToken&, pxrInternal_v0_22__pxrReserved__::UsdShadeAttributeType)’* no matching function for call to ‘pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource(pxrInternal_v0_22__pxrReserved__::UsdAttribute&, pxrInternal_v0_22__pxrReserved__::UsdShadeNodeGraph&, pxrInternal_v0_22__pxrReserved__::TfToken&)’* no matching function for call to ‘pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource(pxrInternal_v0_22__pxrReserved__::UsdAttribute&, pxrInternal_v0_22__pxrReserved__::UsdShadeShader&, pxrInternal_v0_22__pxrReserved__::TfToken&, pxrInternal_v0_22__pxrReserved__::UsdShadeAttributeType, const pxrInternal_v0_22__pxrReserved__::SdfValueTypeName&)’* no matching function for call to ‘pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource(pxrInternal_v0_22__pxrReserved__::UsdAttribute&, pxrInternal_v0_22__pxrReserved__::UsdShadeShader&, pxrInternal_v0_22__pxrReserved__::TfToken&, pxrInternal_v0_22__pxrReserved__::UsdShadeAttributeType)’* no matching function for call to ‘pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource(pxrInternal_v0_22__pxrReserved__::UsdAttribute&, pxrInternal_v0_22__pxrReserved__::UsdShadeShader&, pxrInternal_v0_22__pxrReserved__::TfToken&)’* no matching function for call to ‘pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource(pxrInternal_v0_22__pxrReserved__::UsdShadeInput&, pxrInternal_v0_22__pxrReserved__::UsdShadeMaterial&, const pxrInternal_v0_22__pxrReserved__::TfToken&)’* no matching function for call to ‘pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource(pxrInternal_v0_22__pxrReserved__::UsdShadeInput&, pxrInternal_v0_22__pxrReserved__::UsdShadeMaterial&, pxrInternal_v0_22__pxrReserved__::TfToken&, pxrInternal_v0_22__pxrReserved__::UsdShadeAttributeType, const pxrInternal_v0_22__pxrReserved__::SdfValueTypeName&)’* no matching function for call to ‘pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource(pxrInternal_v0_22__pxrReserved__::UsdShadeInput&, pxrInternal_v0_22__pxrReserved__::UsdShadeMaterial&, pxrInternal_v0_22__pxrReserved__::TfToken&, pxrInternal_v0_22__pxrReserved__::UsdShadeAttributeType)’* no matching function for call to ‘pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource(pxrInternal_v0_22__pxrReserved__::UsdShadeInput&, pxrInternal_v0_22__pxrReserved__::UsdShadeMaterial&, pxrInternal_v0_22__pxrReserved__::TfToken&)’* no matching function for call to ‘pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource(pxrInternal_v0_22__pxrReserved__::UsdShadeInput&, pxrInternal_v0_22__pxrReserved__::UsdShadeNodeGraph&, pxrInternal_v0_22__pxrReserved__::TfToken&, pxrInternal_v0_22__pxrReserved__::UsdShadeAttributeType, const pxrInternal_v0_22__pxrReserved__::SdfValueTypeName&)’* no matching function for call to ‘pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource(pxrInternal_v0_22__pxrReserved__::UsdShadeInput&, pxrInternal_v0_22__pxrReserved__::UsdShadeNodeGraph&, pxrInternal_v0_22__pxrReserved__::TfToken&, pxrInternal_v0_22__pxrReserved__::UsdShadeAttributeType)’* no matching function for call to ‘pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource(pxrInternal_v0_22__pxrReserved__::UsdShadeInput&, pxrInternal_v0_22__pxrReserved__::UsdShadeNodeGraph&, pxrInternal_v0_22__pxrReserved__::TfToken&)’* no matching function for call to ‘pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource(pxrInternal_v0_22__pxrReserved__::UsdShadeInput&, pxrInternal_v0_22__pxrReserved__::UsdShadeShader&, pxrInternal_v0_22__pxrReserved__::TfToken&, pxrInternal_v0_22__pxrReserved__::UsdShadeAttributeType, const pxrInternal_v0_22__pxrReserved__::SdfValueTypeName&)’* no matching function for call to ‘pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource(pxrInternal_v0_22__pxrReserved__::UsdShadeInput&, pxrInternal_v0_22__pxrReserved__::UsdShadeShader&, pxrInternal_v0_22__pxrReserved__::TfToken&, pxrInternal_v0_22__pxrReserved__::UsdShadeAttributeType)’* no matching function for call to ‘pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource(pxrInternal_v0_22__pxrReserved__::UsdShadeInput&, pxrInternal_v0_22__pxrReserved__::UsdShadeShader&, pxrInternal_v0_22__pxrReserved__::TfToken&)’* no matching function for call to ‘pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource(pxrInternal_v0_22__pxrReserved__::UsdShadeOutput&, pxrInternal_v0_22__pxrReserved__::UsdShadeMaterial&, const pxrInternal_v0_22__pxrReserved__::TfToken&)’* no matching function for call to ‘pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource(pxrInternal_v0_22__pxrReserved__::UsdShadeOutput&, pxrInternal_v0_22__pxrReserved__::UsdShadeMaterial&, pxrInternal_v0_22__pxrReserved__::TfToken&, pxrInternal_v0_22__pxrReserved__::UsdShadeAttributeType, const pxrInternal_v0_22__pxrReserved__::SdfValueTypeName&)’* no matching function for call to ‘pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource(pxrInternal_v0_22__pxrReserved__::UsdShadeOutput&, pxrInternal_v0_22__pxrReserved__::UsdShadeMaterial&, pxrInternal_v0_22__pxrReserved__::TfToken&, pxrInternal_v0_22__pxrReserved__::UsdShadeAttributeType)’* no matching function for call to ‘pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource(pxrInternal_v0_22__pxrReserved__::UsdShadeOutput&, pxrInternal_v0_22__pxrReserved__::UsdShadeMaterial&, pxrInternal_v0_22__pxrReserved__::TfToken&)’* no matching function for call to ‘pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource(pxrInternal_v0_22__pxrReserved__::UsdShadeOutput&, pxrInternal_v0_22__pxrReserved__::UsdShadeNodeGraph&, pxrInternal_v0_22__pxrReserved__::TfToken&, pxrInternal_v0_22__pxrReserved__::UsdShadeAttributeType, const pxrInternal_v0_22__pxrReserved__::SdfValueTypeName&)’* no matching function for call to ‘pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource(pxrInternal_v0_22__pxrReserved__::UsdShadeOutput&, pxrInternal_v0_22__pxrReserved__::UsdShadeNodeGraph&, pxrInternal_v0_22__pxrReserved__::TfToken&, pxrInternal_v0_22__pxrReserved__::UsdShadeAttributeType)’* no matching function for call to ‘pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource(pxrInternal_v0_22__pxrReserved__::UsdShadeOutput&, pxrInternal_v0_22__pxrReserved__::UsdShadeNodeGraph&, pxrInternal_v0_22__pxrReserved__::TfToken&)’* no matching function for call to ‘pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource(pxrInternal_v0_22__pxrReserved__::UsdShadeOutput&, pxrInternal_v0_22__pxrReserved__::UsdShadeShader&, pxrInternal_v0_22__pxrReserved__::TfToken&, pxrInternal_v0_22__pxrReserved__::UsdShadeAttributeType, const pxrInternal_v0_22__pxrReserved__::SdfValueTypeName&)’* no matching function for call to ‘pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource(pxrInternal_v0_22__pxrReserved__::UsdShadeOutput&, pxrInternal_v0_22__pxrReserved__::UsdShadeShader&, pxrInternal_v0_22__pxrReserved__::TfToken&, pxrInternal_v0_22__pxrReserved__::UsdShadeAttributeType)’* no matching function for call to ‘pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource(pxrInternal_v0_22__pxrReserved__::UsdShadeOutput&, pxrInternal_v0_22__pxrReserved__::UsdShadeShader&, pxrInternal_v0_22__pxrReserved__::TfToken&)’* no matching function for call to ‘pxrInternal_v0_22__pxrReserved__::UsdShadeInput::ConnectToSource(pxrInternal_v0_22__pxrReserved__::UsdShadeMaterial&, const pxrInternal_v0_22__pxrReserved__::TfToken&)’* no matching function for call to ‘pxrInternal_v0_22__pxrReserved__::UsdShadeInput::ConnectToSource(pxrInternal_v0_22__pxrReserved__::UsdShadeMaterial&, pxrInternal_v0_22__pxrReserved__::TfToken&, pxrInternal_v0_22__pxrReserved__::UsdShadeAttributeType, const pxrInternal_v0_22__pxrReserved__::SdfValueTypeName&)’* no matching function for call to ‘pxrInternal_v0_22__pxrReserved__::UsdShadeInput::ConnectToSource(pxrInternal_v0_22__pxrReserved__::UsdShadeMaterial&, pxrInternal_v0_22__pxrReserved__::TfToken&, pxrInternal_v0_22__pxrReserved__::UsdShadeAttributeType)’* no matching function for call to ‘pxrInternal_v0_22__pxrReserved__::UsdShadeInput::ConnectToSource(pxrInternal_v0_22__pxrReserved__::UsdShadeMaterial&, pxrInternal_v0_22__pxrReserved__::TfToken&)’* no matching function for call to ‘pxrInternal_v0_22__pxrReserved__::UsdShadeInput::ConnectToSource(pxrInternal_v0_22__pxrReserved__::UsdShadeNodeGraph&, pxrInternal_v0_22__pxrReserved__::TfToken&, pxrInternal_v0_22__pxrReserved__::UsdShadeAttributeType, const pxrInternal_v0_22__pxrReserved__::SdfValueTypeName&)’* no matching function for call to ‘pxrInternal_v0_22__pxrReserved__::UsdShadeInput::ConnectToSource(pxrInternal_v0_22__pxrReserved__::UsdShadeNodeGraph&, pxrInternal_v0_22__pxrReserved__::TfToken&, pxrInternal_v0_22__pxrReserved__::UsdShadeAttributeType)’* no matching function for call to ‘pxrInternal_v0_22__pxrReserved__::UsdShadeInput::ConnectToSource(pxrInternal_v0_22__pxrReserved__::UsdShadeNodeGraph&, pxrInternal_v0_22__pxrReserved__::TfToken&)’* no matching function for call to ‘pxrInternal_v0_22__pxrReserved__::UsdShadeInput::ConnectToSource(pxrInternal_v0_22__pxrReserved__::UsdShadeShader&, pxrInternal_v0_22__pxrReserved__::TfToken&, pxrInternal_v0_22__pxrReserved__::UsdShadeAttributeType, const pxrInternal_v0_22__pxrReserved__::SdfValueTypeName&)’* no matching function for call to ‘pxrInternal_v0_22__pxrReserved__::UsdShadeInput::ConnectToSource(pxrInternal_v0_22__pxrReserved__::UsdShadeShader&, pxrInternal_v0_22__pxrReserved__::TfToken&, pxrInternal_v0_22__pxrReserved__::UsdShadeAttributeType)’* no matching function for call to ‘pxrInternal_v0_22__pxrReserved__::UsdShadeInput::ConnectToSource(pxrInternal_v0_22__pxrReserved__::UsdShadeShader&, pxrInternal_v0_22__pxrReserved__::TfToken&)’* no matching function for call to ‘pxrInternal_v0_22__pxrReserved__::UsdShadeOutput::ConnectToSource(pxrInternal_v0_22__pxrReserved__::UsdShadeMaterial&, const pxrInternal_v0_22__pxrReserved__::TfToken&)’* no matching function for call to ‘pxrInternal_v0_22__pxrReserved__::UsdShadeOutput::ConnectToSource(pxrInternal_v0_22__pxrReserved__::UsdShadeMaterial&, pxrInternal_v0_22__pxrReserved__::TfToken&, pxrInternal_v0_22__pxrReserved__::UsdShadeAttributeType, const pxrInternal_v0_22__pxrReserved__::SdfValueTypeName&)’* no matching function for call to ‘pxrInternal_v0_22__pxrReserved__::UsdShadeOutput::ConnectToSource(pxrInternal_v0_22__pxrReserved__::UsdShadeMaterial&, pxrInternal_v0_22__pxrReserved__::TfToken&, pxrInternal_v0_22__pxrReserved__::UsdShadeAttributeType)’* no matching function for call to ‘pxrInternal_v0_22__pxrReserved__::UsdShadeOutput::ConnectToSource(pxrInternal_v0_22__pxrReserved__::UsdShadeMaterial&, pxrInternal_v0_22__pxrReserved__::TfToken&)’* no matching function for call to ‘pxrInternal_v0_22__pxrReserved__::UsdShadeOutput::ConnectToSource(pxrInternal_v0_22__pxrReserved__::UsdShadeNodeGraph&, pxrInternal_v0_22__pxrReserved__::TfToken&, pxrInternal_v0_22__pxrReserved__::UsdShadeAttributeType, const pxrInternal_v0_22__pxrReserved__::SdfValueTypeName&)’* no matching function for call to ‘pxrInternal_v0_22__pxrReserved__::UsdShadeOutput::ConnectToSource(pxrInternal_v0_22__pxrReserved__::UsdShadeNodeGraph&, pxrInternal_v0_22__pxrReserved__::TfToken&, pxrInternal_v0_22__pxrReserved__::UsdShadeAttributeType)’* no matching function for call to ‘pxrInternal_v0_22__pxrReserved__::UsdShadeOutput::ConnectToSource(pxrInternal_v0_22__pxrReserved__::UsdShadeNodeGraph&, pxrInternal_v0_22__pxrReserved__::TfToken&)’* no matching function for call to ‘pxrInternal_v0_22__pxrReserved__::UsdShadeOutput::ConnectToSource(pxrInternal_v0_22__pxrReserved__::UsdShadeShader&, pxrInternal_v0_22__pxrReserved__::TfToken&, pxrInternal_v0_22__pxrReserved__::UsdShadeAttributeType, const pxrInternal_v0_22__pxrReserved__::SdfValueTypeName&)’* no matching function for call to ‘pxrInternal_v0_22__pxrReserved__::UsdShadeOutput::ConnectToSource(pxrInternal_v0_22__pxrReserved__::UsdShadeShader&, pxrInternal_v0_22__pxrReserved__::TfToken&, pxrInternal_v0_22__pxrReserved__::UsdShadeAttributeType)’* no matching function for call to ‘pxrInternal_v0_22__pxrReserved__::UsdShadeOutput::ConnectToSource(pxrInternal_v0_22__pxrReserved__::UsdShadeShader&, pxrInternal_v0_22__pxrReserved__::TfToken&)’
C++ Error Strings (Windows):
* E0304 no instance of overloaded function “pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource” matches the argument list* E0304 no instance of overloaded function “pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource” matches the argument list* E0304 no instance of overloaded function “pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource” matches the argument list* E0304 no instance of overloaded function “pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource” matches the argument list* E0304 no instance of overloaded function “pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource” matches the argument list* E0304 no instance of overloaded function “pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource” matches the argument list* E0304 no instance of overloaded function “pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource” matches the argument list* E0304 no instance of overloaded function “pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource” matches the argument list* E0304 no instance of overloaded function “pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource” matches the argument list* E0304 no instance of overloaded function “pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource” matches the argument list* E0304 no instance of overloaded function “pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource” matches the argument list* E0304 no instance of overloaded function “pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource” matches the argument list* E0304 no instance of overloaded function “pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource” matches the argument list* E0304 no instance of overloaded function “pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource” matches the argument list* E0304 no instance of overloaded function “pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource” matches the argument list* E0304 no instance of overloaded function “pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource” matches the argument list* E0304 no instance of overloaded function “pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource” matches the argument list* E0304 no instance of overloaded function “pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource” matches the argument list* E0304 no instance of overloaded function “pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource” matches the argument list* E0304 no instance of overloaded function “pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource” matches the argument list* E0304 no instance of overloaded function “pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource” matches the argument list* E0304 no instance of overloaded function “pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource” matches the argument list* E0304 no instance of overloaded function “pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource” matches the argument list* E0304 no instance of overloaded function “pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource” matches the argument list* E0304 no instance of overloaded function “pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource” matches the argument list* E0304 no instance of overloaded function “pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource” matches the argument list* E0304 no instance of overloaded function “pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource” matches the argument list* E0304 no instance of overloaded function “pxrInternal_v0_22__pxrReserved__::UsdShadeOutput::ConnectToSource” matches the argument list* E0304 no instance of overloaded function “pxrInternal_v0_22__pxrReserved__::UsdShadeOutput::ConnectToSource” matches the argument list* E0304 no instance of overloaded function “pxrInternal_v0_22__pxrReserved__::UsdShadeOutput::ConnectToSource” matches the argument list* E0304 no instance of overloaded function “pxrInternal_v0_22__pxrReserved__::UsdShadeOutput::ConnectToSource” matches the argument list* E0304 no instance of overloaded function “pxrInternal_v0_22__pxrReserved__::UsdShadeOutput::ConnectToSource” matches the argument list* E0304 no instance of overloaded function “pxrInternal_v0_22__pxrReserved__::UsdShadeOutput::ConnectToSource” matches the argument list* E0304 no instance of overloaded function “pxrInternal_v0_22__pxrReserved__::UsdShadeOutput::ConnectToSource” matches the argument list* E0304 no instance of overloaded function “pxrInternal_v0_22__pxrReserved__::UsdShadeOutput::ConnectToSource” matches the argument list* E0304 no instance of overloaded function “pxrInternal_v0_22__pxrReserved__::UsdShadeOutput::ConnectToSource” matches the argument list* E0304 no instance of overloaded function “pxrInternal_v0_22__pxrReserved__::UsdShadeInput::ConnectToSource” matches the argument list* E0304 no instance of overloaded function “pxrInternal_v0_22__pxrReserved__::UsdShadeInput::ConnectToSource” matches the argument list* E0304 no instance of overloaded function “pxrInternal_v0_22__pxrReserved__::UsdShadeInput::ConnectToSource” matches the argument list* E0304 no instance of overloaded function “pxrInternal_v0_22__pxrReserved__::UsdShadeInput::ConnectToSource” matches the argument list* E0304 no instance of overloaded function “pxrInternal_v0_22__pxrReserved__::UsdShadeInput::ConnectToSource” matches the argument list* E0304 no instance of overloaded function “pxrInternal_v0_22__pxrReserved__::UsdShadeInput::ConnectToSource” matches the argument list* E0304 no instance of overloaded function “pxrInternal_v0_22__pxrReserved__::UsdShadeInput::ConnectToSource” matches the argument list* E0304 no instance of overloaded function “pxrInternal_v0_22__pxrReserved__::UsdShadeInput::ConnectToSource” matches the argument list* E0304 no instance of overloaded function “pxrInternal_v0_22__pxrReserved__::UsdShadeInput::ConnectToSource” matches the argument list* C2665 ‘pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource’: none of the 15 overloads could convert all the argument types* C2665 ‘pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource’: none of the 15 overloads could convert all the argument types* C2665 ‘pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource’: none of the 15 overloads could convert all the argument types* C2665 ‘pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource’: none of the 15 overloads could convert all the argument types* C2665 ‘pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource’: none of the 15 overloads could convert all the argument types* C2665 ‘pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource’: none of the 15 overloads could convert all the argument types* C2665 ‘pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource’: none of the 15 overloads could convert all the argument types* C2665 ‘pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource’: none of the 15 overloads could convert all the argument types* C2665 ‘pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource’: none of the 15 overloads could convert all the argument types* C2665 ‘pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource’: none of the 15 overloads could convert all the argument types* C2665 ‘pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource’: none of the 15 overloads could convert all the argument types* C2665 ‘pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource’: none of the 15 overloads could convert all the argument types* C2665 ‘pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource’: none of the 15 overloads could convert all the argument types* C2665 ‘pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource’: none of the 15 overloads could convert all the argument types* C2665 ‘pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource’: none of the 15 overloads could convert all the argument types* C2665 ‘pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource’: none of the 15 overloads could convert all the argument types* C2665 ‘pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource’: none of the 15 overloads could convert all the argument types* C2665 ‘pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource’: none of the 15 overloads could convert all the argument types* C2665 ‘pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource’: none of the 15 overloads could convert all the argument types* C2665 ‘pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource’: none of the 15 overloads could convert all the argument types* C2665 ‘pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource’: none of the 15 overloads could convert all the argument types* C2665 ‘pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource’: none of the 15 overloads could convert all the argument types* C2665 ‘pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource’: none of the 15 overloads could convert all the argument types* C2665 ‘pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource’: none of the 15 overloads could convert all the argument types* C2665 ‘pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource’: none of the 15 overloads could convert all the argument types* C2665 ‘pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource’: none of the 15 overloads could convert all the argument types* C2665 ‘pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI::ConnectToSource’: none of the 15 overloads could convert all the argument types* C2664 ‘bool pxrInternal_v0_22__pxrReserved__::UsdShadeOutput::ConnectToSource(const pxrInternal_v0_22__pxrReserved__::UsdShadeConnectionSourceInfo &,const pxrInternal_v0_22__pxrReserved__::UsdShadeOutput::ConnectionModification) const’: cannot convert argument 1 from ‘pxrInternal_v0_22__pxrReserved__::UsdShadeShader’ to ‘const pxrInternal_v0_22__pxrReserved__::UsdShadeConnectionSourceInfo &’* C2664 ‘bool pxrInternal_v0_22__pxrReserved__::UsdShadeOutput::ConnectToSource(const pxrInternal_v0_22__pxrReserved__::UsdShadeConnectionSourceInfo &,const pxrInternal_v0_22__pxrReserved__::UsdShadeOutput::ConnectionModification) const’: cannot convert argument 1 from ‘pxrInternal_v0_22__pxrReserved__::UsdShadeMaterial’ to ‘const pxrInternal_v0_22__pxrReserved__::UsdShadeConnectionSourceInfo &’* C2664 ‘bool pxrInternal_v0_22__pxrReserved__::UsdShadeOutput::ConnectToSource(const pxrInternal_v0_22__pxrReserved__::UsdShadeConnectionSourceInfo &,const pxrInternal_v0_22__pxrReserved__::UsdShadeOutput::ConnectionModification) const’: cannot convert argument 1 from ‘pxrInternal_v0_22__pxrReserved__::UsdShadeNodeGraph’ to ‘const pxrInternal_v0_22__pxrReserved__::UsdShadeConnectionSourceInfo &’* C2664 ‘bool pxrInternal_v0_22__pxrReserved__::UsdShadeOutput::ConnectToSource(const pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI &,const pxrInternal_v0_22__pxrReserved__::TfToken &,const pxrInternal_v0_22__pxrReserved__::UsdShadeAttributeType,pxrInternal_v0_22__pxrReserved__::SdfValueTypeName) const’: cannot convert argument 1 from ‘pxrInternal_v0_22__pxrReserved__::UsdShadeShader’ to ‘const pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI &’* C2664 ‘bool pxrInternal_v0_22__pxrReserved__::UsdShadeOutput::ConnectToSource(const pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI &,const pxrInternal_v0_22__pxrReserved__::TfToken &,const pxrInternal_v0_22__pxrReserved__::UsdShadeAttributeType,pxrInternal_v0_22__pxrReserved__::SdfValueTypeName) const’: cannot convert argument 1 from ‘pxrInternal_v0_22__pxrReserved__::UsdShadeMaterial’ to ‘const pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI &’* C2664 ‘bool pxrInternal_v0_22__pxrReserved__::UsdShadeOutput::ConnectToSource(const pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI &,const pxrInternal_v0_22__pxrReserved__::TfToken &,const pxrInternal_v0_22__pxrReserved__::UsdShadeAttributeType,pxrInternal_v0_22__pxrReserved__::SdfValueTypeName) const’: cannot convert argument 1 from ‘pxrInternal_v0_22__pxrReserved__::UsdShadeNodeGraph’ to ‘const pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI &’* C2664 ‘bool pxrInternal_v0_22__pxrReserved__::UsdShadeOutput::ConnectToSource(const pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI &,const pxrInternal_v0_22__pxrReserved__::TfToken &,const pxrInternal_v0_22__pxrReserved__::UsdShadeAttributeType,pxrInternal_v0_22__pxrReserved__::SdfValueTypeName) const’: cannot convert argument 1 from ‘pxrInternal_v0_22__pxrReserved__::UsdShadeShader’ to ‘const pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI &’* C2664 ‘bool pxrInternal_v0_22__pxrReserved__::UsdShadeOutput::ConnectToSource(const pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI &,const pxrInternal_v0_22__pxrReserved__::TfToken &,const pxrInternal_v0_22__pxrReserved__::UsdShadeAttributeType,pxrInternal_v0_22__pxrReserved__::SdfValueTypeName) const’: cannot convert argument 1 from ‘pxrInternal_v0_22__pxrReserved__::UsdShadeMaterial’ to ‘const pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI &’* C2664 ‘bool pxrInternal_v0_22__pxrReserved__::UsdShadeOutput::ConnectToSource(const pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI &,const pxrInternal_v0_22__pxrReserved__::TfToken &,const pxrInternal_v0_22__pxrReserved__::UsdShadeAttributeType,pxrInternal_v0_22__pxrReserved__::SdfValueTypeName) const’: cannot convert argument 1 from ‘pxrInternal_v0_22__pxrReserved__::UsdShadeNodeGraph’ to ‘const pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI &’* C2664 ‘bool pxrInternal_v0_22__pxrReserved__::UsdShadeInput::ConnectToSource(const pxrInternal_v0_22__pxrReserved__::UsdShadeConnectionSourceInfo &,const pxrInternal_v0_22__pxrReserved__::UsdShadeInput::ConnectionModification) const’: cannot convert argument 1 from ‘pxrInternal_v0_22__pxrReserved__::UsdShadeShader’ to ‘const pxrInternal_v0_22__pxrReserved__::UsdShadeConnectionSourceInfo &’* C2664 ‘bool pxrInternal_v0_22__pxrReserved__::UsdShadeInput::ConnectToSource(const pxrInternal_v0_22__pxrReserved__::UsdShadeConnectionSourceInfo &,const pxrInternal_v0_22__pxrReserved__::UsdShadeInput::ConnectionModification) const’: cannot convert argument 1 from ‘pxrInternal_v0_22__pxrReserved__::UsdShadeMaterial’ to ‘const pxrInternal_v0_22__pxrReserved__::UsdShadeConnectionSourceInfo &’* C2664 ‘bool pxrInternal_v0_22__pxrReserved__::UsdShadeInput::ConnectToSource(const pxrInternal_v0_22__pxrReserved__::UsdShadeConnectionSourceInfo &,const pxrInternal_v0_22__pxrReserved__::UsdShadeInput::ConnectionModification) const’: cannot convert argument 1 from ‘pxrInternal_v0_22__pxrReserved__::UsdShadeNodeGraph’ to ‘const pxrInternal_v0_22__pxrReserved__::UsdShadeConnectionSourceInfo &’* C2664 ‘bool pxrInternal_v0_22__pxrReserved__::UsdShadeInput::ConnectToSource(const pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI &,const pxrInternal_v0_22__pxrReserved__::TfToken &,const pxrInternal_v0_22__pxrReserved__::UsdShadeAttributeType,pxrInternal_v0_22__pxrReserved__::SdfValueTypeName) const’: cannot convert argument 1 from ‘pxrInternal_v0_22__pxrReserved__::UsdShadeShader’ to ‘const pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI &’* C2664 ‘bool pxrInternal_v0_22__pxrReserved__::UsdShadeInput::ConnectToSource(const pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI &,const pxrInternal_v0_22__pxrReserved__::TfToken &,const pxrInternal_v0_22__pxrReserved__::UsdShadeAttributeType,pxrInternal_v0_22__pxrReserved__::SdfValueTypeName) const’: cannot convert argument 1 from ‘pxrInternal_v0_22__pxrReserved__::UsdShadeMaterial’ to ‘const pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI &’* C2664 ‘bool pxrInternal_v0_22__pxrReserved__::UsdShadeInput::ConnectToSource(const pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI &,const pxrInternal_v0_22__pxrReserved__::TfToken &,const pxrInternal_v0_22__pxrReserved__::UsdShadeAttributeType,pxrInternal_v0_22__pxrReserved__::SdfValueTypeName) const’: cannot convert argument 1 from ‘pxrInternal_v0_22__pxrReserved__::UsdShadeNodeGraph’ to ‘const pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI &’* C2664 ‘bool pxrInternal_v0_22__pxrReserved__::UsdShadeInput::ConnectToSource(const pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI &,const pxrInternal_v0_22__pxrReserved__::TfToken &,const pxrInternal_v0_22__pxrReserved__::UsdShadeAttributeType,pxrInternal_v0_22__pxrReserved__::SdfValueTypeName) const’: cannot convert argument 1 from ‘pxrInternal_v0_22__pxrReserved__::UsdShadeShader’ to ‘const pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI &’* C2664 ‘bool pxrInternal_v0_22__pxrReserved__::UsdShadeInput::ConnectToSource(const pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI &,const pxrInternal_v0_22__pxrReserved__::TfToken &,const pxrInternal_v0_22__pxrReserved__::UsdShadeAttributeType,pxrInternal_v0_22__pxrReserved__::SdfValueTypeName) const’: cannot convert argument 1 from ‘pxrInternal_v0_22__pxrReserved__::UsdShadeMaterial’ to ‘const pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI &’* C2664 ‘bool pxrInternal_v0_22__pxrReserved__::UsdShadeInput::ConnectToSource(const pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI &,const pxrInternal_v0_22__pxrReserved__::TfToken &,const pxrInternal_v0_22__pxrReserved__::UsdShadeAttributeType,pxrInternal_v0_22__pxrReserved__::SdfValueTypeName) const’: cannot convert argument 1 from ‘pxrInternal_v0_22__pxrReserved__::UsdShadeNodeGraph’ to ‘const pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI &’
Python Error Strings:
* Boost.Python.ArgumentError: Python argument types in ConnectableAPI.ConnectToSource(Attribute, Material, str)did not match C++ signature:* Boost.Python.ArgumentError: Python argument types in ConnectableAPI.ConnectToSource(Attribute, Material, str, AttributeType)did not match C++ signature:* Boost.Python.ArgumentError: Python argument types in ConnectableAPI.ConnectToSource(Attribute, Material, str, AttributeType, ValueTypeName)did not match C++ signature:* Boost.Python.ArgumentError: Python argument types in ConnectableAPI.ConnectToSource(Attribute, NodeGraph, str)did not match C++ signature:* Boost.Python.ArgumentError: Python argument types in ConnectableAPI.ConnectToSource(Attribute, NodeGraph, str, AttributeType)did not match C++ signature:* Boost.Python.ArgumentError: Python argument types in ConnectableAPI.ConnectToSource(Attribute, NodeGraph, str, AttributeType, ValueTypeName)did not match C++ signature:* Boost.Python.ArgumentError: Python argument types in ConnectableAPI.ConnectToSource(Attribute, Shader, str)did not match C++ signature:* Boost.Python.ArgumentError: Python argument types in ConnectableAPI.ConnectToSource(Attribute, Shader, str, AttributeType)did not match C++ signature:* Boost.Python.ArgumentError: Python argument types in ConnectableAPI.ConnectToSource(Attribute, Shader, str, AttributeType, ValueTypeName)did not match C++ signature:* Boost.Python.ArgumentError: Python argument types in ConnectableAPI.ConnectToSource(Input, Material, str)did not match C++ signature:* Boost.Python.ArgumentError: Python argument types in ConnectableAPI.ConnectToSource(Input, Material, str, AttributeType)did not match C++ signature:* Boost.Python.ArgumentError: Python argument types in ConnectableAPI.ConnectToSource(Input, Material, str, AttributeType, ValueTypeName)did not match C++ signature:* Boost.Python.ArgumentError: Python argument types in ConnectableAPI.ConnectToSource(Input, NodeGraph, str)did not match C++ signature:* Boost.Python.ArgumentError: Python argument types in ConnectableAPI.ConnectToSource(Input, NodeGraph, str, AttributeType)did not match C++ signature:* Boost.Python.ArgumentError: Python argument types in ConnectableAPI.ConnectToSource(Input, NodeGraph, str, AttributeType, ValueTypeName)did not match C++ signature:* Boost.Python.ArgumentError: Python argument types in ConnectableAPI.ConnectToSource(Input, Shader, str)did not match C++ signature:* Boost.Python.ArgumentError: Python argument types in ConnectableAPI.ConnectToSource(Input, Shader, str, AttributeType)did not match C++ signature:* Boost.Python.ArgumentError: Python argument types in ConnectableAPI.ConnectToSource(Input, Shader, str, AttributeType, ValueTypeName)did not match C++ signature:* Boost.Python.ArgumentError: Python argument types in ConnectableAPI.ConnectToSource(Output, Material, str)did not match C++ signature:* Boost.Python.ArgumentError: Python argument types in ConnectableAPI.ConnectToSource(Output, Material, str, AttributeType)did not match C++ signature:* Boost.Python.ArgumentError: Python argument types in ConnectableAPI.ConnectToSource(Output, Material, str, AttributeType, ValueTypeName)did not match C++ signature:* Boost.Python.ArgumentError: Python argument types in ConnectableAPI.ConnectToSource(Output, NodeGraph, str)did not match C++ signature:* Boost.Python.ArgumentError: Python argument types in ConnectableAPI.ConnectToSource(Output, NodeGraph, str, AttributeType)did not match C++ signature:* Boost.Python.ArgumentError: Python argument types in ConnectableAPI.ConnectToSource(Output, NodeGraph, str, AttributeType, ValueTypeName)did not match C++ signature:* Boost.Python.ArgumentError: Python argument types in ConnectableAPI.ConnectToSource(Output, Shader, str)did not match C++ signature:* Boost.Python.ArgumentError: Python argument types in ConnectableAPI.ConnectToSource(Output, Shader, str, AttributeType)did not match C++ signature:* Boost.Python.ArgumentError: Python argument types in ConnectableAPI.ConnectToSource(Output, Shader, str, AttributeType, ValueTypeName)did not match C++ signature:* Boost.Python.ArgumentError: Python argument types in Input.ConnectToSource(Input, Material, str)did not match C++ signature:* Boost.Python.ArgumentError: Python argument types in Input.ConnectToSource(Input, Material, str, AttributeType)did not match C++ signature:* Boost.Python.ArgumentError: Python argument types in Input.ConnectToSource(Input, Material, str, AttributeType, ValueTypeName)did not match C++ signature:* Boost.Python.ArgumentError: Python argument types in Input.ConnectToSource(Input, NodeGraph, str)did not match C++ signature:* Boost.Python.ArgumentError: Python argument types in Input.ConnectToSource(Input, NodeGraph, str, AttributeType)did not match C++ signature:* Boost.Python.ArgumentError: Python argument types in Input.ConnectToSource(Input, NodeGraph, str, AttributeType, ValueTypeName)did not match C++ signature:* Boost.Python.ArgumentError: Python argument types in Input.ConnectToSource(Input, Shader, str)did not match C++ signature:* Boost.Python.ArgumentError: Python argument types in Input.ConnectToSource(Input, Shader, str, AttributeType)did not match C++ signature:* Boost.Python.ArgumentError: Python argument types in Input.ConnectToSource(Input, Shader, str, AttributeType, ValueTypeName)did not match C++ signature:* Boost.Python.ArgumentError: Python argument types in Output.ConnectToSource(Output, Material, str)did not match C++ signature:* Boost.Python.ArgumentError: Python argument types in Output.ConnectToSource(Output, Material, str, AttributeType)did not match C++ signature:* Boost.Python.ArgumentError: Python argument types in Output.ConnectToSource(Output, Material, str, AttributeType, ValueTypeName)did not match C++ signature:* Boost.Python.ArgumentError: Python argument types in Output.ConnectToSource(Output, NodeGraph, str)did not match C++ signature:* Boost.Python.ArgumentError: Python argument types in Output.ConnectToSource(Output, NodeGraph, str, AttributeType)did not match C++ signature:* Boost.Python.ArgumentError: Python argument types in Output.ConnectToSource(Output, NodeGraph, str, AttributeType, ValueTypeName)did not match C++ signature:* Boost.Python.ArgumentError: Python argument types in Output.ConnectToSource(Output, Shader, str)did not match C++ signature:* Boost.Python.ArgumentError: Python argument types in Output.ConnectToSource(Output, Shader, str, AttributeType)did not match C++ signature:* Boost.Python.ArgumentError: Python argument types in Output.ConnectToSource(Output, Shader, str, AttributeType, ValueTypeName) did not match C++ signature:
#### IsNodeGraph replaced with IsContainer
Reference Commits:
* UsdShade: Add a concept of “containers” for connectable nodes.* Remove already-deprecated API IsShader() / IsNodeGraph().
C++/Python Find Regex:
(?<=\W)IsNodeGraph(?=\W)
C++/Python Replace Regex:
IsContainer
Python Example Before:
from pxr import Usd, UsdShademyStage = Usd.Stage.CreateInMemory()myPrim = myStage.DefinePrim(“/myPrim”, “Transform”)material = UsdShade.Material.Define(myStage, “/myPrim/myMaterial”)shader = UsdShade.Shader.Define(myStage, “/myPrim/myMaterial/myShader”)nodeGraph = UsdShade.NodeGraph.Define(myStage, “/myPrim/myMaterial/nodeGraph”)assert material.ConnectableAPI().IsNodeGraph()assert not shader.ConnectableAPI().IsNodeGraph()assert nodeGraph.ConnectableAPI().IsNodeGraph()
Python Example After (21.02+ only):
from pxr import Usd, UsdShademyStage = Usd.Stage.CreateInMemory()myPrim = myStage.DefinePrim(“/myPrim”, “Transform”)material = UsdShade.Material.Define(myStage, “/myPrim/myMaterial”)shader = UsdShade.Shader.Define(myStage, “/myPrim/myMaterial/myShader”)nodeGraph = UsdShade.NodeGraph.Define(myStage, “/myPrim/myMaterial/nodeGraph”)assert material.ConnectableAPI().IsContainer()assert not shader.ConnectableAPI().IsContainer()assert nodeGraph.ConnectableAPI().IsContainer()
Python Example After (branched):
from pxr import Usd, UsdShademyStage = Usd.Stage.CreateInMemory()myPrim = myStage.DefinePrim(“/myPrim”, “Transform”)material = UsdShade.Material.Define(myStage, “/myPrim/myMaterial”)shader = UsdShade.Shader.Define(myStage, “/myPrim/myMaterial/myShader”)nodeGraph = UsdShade.NodeGraph.Define(myStage, “/myPrim/myMaterial/nodeGraph”)if hasattr(UsdShade.ConnectableAPI, “IsContainer”): # >= 21.02 assert material.ConnectableAPI().IsContainer() assert not shader.ConnectableAPI().IsContainer() assert nodeGraph.ConnectableAPI().IsContainer()else: assert material.ConnectableAPI().IsNodeGraph() assert not shader.ConnectableAPI().IsNodeGraph() assert nodeGraph.ConnectableAPI().IsNodeGraph()
C++ Error Strings (Linux):
* ‘class pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI’ has no member named ‘IsNodeGraph’
C++ Error Strings (Windows):
* E0135 class “pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI” has no member “IsNodeGraph”* C2039 ‘IsNodeGraph’: is not a member of ‘pxrInternal_v0_22__pxrReserved__::UsdShadeConnectableAPI’
Python Error Strings:
* AttributeError: ‘ConnectableAPI’ object has no attribute ‘IsNodeGraph’
### UsdShade.MaterialBindingAPI
#### Material bindings require UsdShadeMaterialBindingAPI to be applied
All code which authors material bindings should Apply()
UsdShadeMaterialBindingAPI to the prim upon which the binding is
to be authored
Current default is to post warnings at runtime, but still apply
material bindings if is not applied
May set USD_SHADE_MATERIAL_BINDING_API_CHECK env var to change
behavior:
allowMissingAPI
silence warnings and apply materials even if
MaterialBindingAPI not applied
warnOnMissingAPI
current default
print warnings, but still apply materials even if
MaterialBindingAPI not applied
strict
future default
only apply material bindings if MaterialBindingAPI applied
Assets can be repaired via the Asset Validator extension, see
UsdMaterialBindingApi.
Reference Commits:
* BindingAtPrim should return early if the prim doesn’t have a MaterialBindingAPI Applied.* Change USD_SHADE_MATERIAL_BINDING_API_CHECK to “warnOnMissingAPI”.
Runtime Warning Strings:
* Found material bindings on prim at path (%s) but MaterialBindingAPI is not applied on the prim
## UsdSkel
### UsdSkel Cache
#### Populate/ComputeSkelBinding/ComputeSkelBindings now require a predicate parameter
To maintain the same behavior, pass UsdPrimDefaultPredicate as the
predicate; if you wish to allow instancing of skeletons, use
UsdTraverseInstanceProxies instead
Reference Commits:
* Adding UsdImagingPrimAdapter::ShouldIgnoreNativeInstanceSubtrees(), which allows an adapter to disable instancing of itself and its descendants… Adding `predicate` flag to Populate, ComputeBinding and ComputeBindings methods of UsdSkelCache.
C++/Python Find Regex:
(?<=.|->)(Populate|ComputeSkelBindings?)\(
Python Example Before:
from pxr import Usd, UsdSkelmyStage = Usd.Stage.CreateInMemory()myPrim = myStage.DefinePrim(“/myPrim”, “Transform”)mySkel = myStage.DefinePrim(“/myPrim/skelRoot”, “SkelRoot”)skelCache = UsdSkel.Cache()mySkelRoot = UsdSkel.Root.Define(myStage, “/myPrim/skelRoot”)mySkel = UsdSkel.Skeleton.Define(myStage, “/myPrim/skelRoot/mySkel”)skelCache.Populate(mySkelRoot)binding = skelCache.ComputeSkelBinding(mySkelRoot, mySkel)bindings = skelCache.ComputeSkelBindings(mySkelRoot)
Python Example After (21.02+ only):
from pxr import Usd, UsdSkelmyStage = Usd.Stage.CreateInMemory()myPrim = myStage.DefinePrim(“/myPrim”, “Transform”)mySkel = myStage.DefinePrim(“/myPrim/skelRoot”, “SkelRoot”)skelCache = UsdSkel.Cache()mySkelRoot = UsdSkel.Root.Define(myStage, “/myPrim/skelRoot”)mySkel = UsdSkel.Skeleton.Define(myStage, “/myPrim/skelRoot/mySkel”)skelCache.Populate(mySkelRoot, Usd.PrimDefaultPredicate)binding = skelCache.ComputeSkelBinding(mySkelRoot, mySkel, Usd.PrimDefaultPredicate)bindings = skelCache.ComputeSkelBindings(mySkelRoot, Usd.PrimDefaultPredicate)
Python Example After (branched):
from pxr import Usd, UsdSkelmyStage = Usd.Stage.CreateInMemory()myPrim = myStage.DefinePrim(“/myPrim”, “Transform”)mySkel = myStage.DefinePrim(“/myPrim/skelRoot”, “SkelRoot”)skelCache = UsdSkel.Cache()mySkelRoot = UsdSkel.Root.Define(myStage, “/myPrim/skelRoot”)mySkel = UsdSkel.Skeleton.Define(myStage, “/myPrim/skelRoot/mySkel”)if Usd.GetVersion() >= (0,20,11): skelCache.Populate(mySkelRoot, Usd.PrimDefaultPredicate) binding = skelCache.ComputeSkelBinding(mySkelRoot, mySkel, Usd.PrimDefaultPredicate) bindings = skelCache.ComputeSkelBindings(mySkelRoot, Usd.PrimDefaultPredicate)else: skelCache.Populate(mySkelRoot) binding = skelCache.ComputeSkelBinding(mySkelRoot, mySkel) bindings = skelCache.ComputeSkelBindings(mySkelRoot)
C++ Error Strings (Linux):
* no matching function for call to ‘pxrInternal_v0_22__pxrReserved__::UsdSkelCache::ComputeSkelBinding(pxrInternal_v0_22__pxrReserved__::UsdSkelRoot&, pxrInternal_v0_22__pxrReserved__::UsdSkelSkeleton&, pxrInternal_v0_22__pxrReserved__::UsdSkelBinding*)’* no matching function for call to ‘pxrInternal_v0_22__pxrReserved__::UsdSkelCache::ComputeSkelBindings(pxrInternal_v0_22__pxrReserved__::UsdSkelRoot&, std::vector<pxrInternal_v0_22__pxrReserved__::UsdSkelBinding>)’ no matching function for call to ‘pxrInternal_v0_22__pxrReserved__::UsdSkelCache::Populate(pxrInternal_v0_22__pxrReserved__::UsdSkelRoot&)’
C++ Error Strings (Windows):
* C2660 ‘pxrInternal_v0_22__pxrReserved__::UsdSkelCache::Populate’: function does not take 1 arguments* C2660 ‘pxrInternal_v0_22__pxrReserved__::UsdSkelCache::ComputeSkelBinding’: function does not take 3 arguments* C2660 ‘pxrInternal_v0_22__pxrReserved__::UsdSkelCache::ComputeSkelBindings’: function does not take 2 arguments
Python Error Strings:
* Boost.Python.ArgumentError: Python argument types in Cache.Populate(Cache, Root) did not match C++ signature:* Boost.Python.ArgumentError: Python argument types in Cache.ComputeSkelBinding(Cache, Root, Skeleton) did not match C++ signature:* Boost.Python.ArgumentError: Python argument types in Cache.ComputeSkelBindings(Cache, Root) did not match C++ signature:
## Imaging
### Glf
#### Removed glew dependency
Reference Commits:
* [Glf] Removed glf/glew
C++ Find Regex:
(?<=\W)(GLEW|Glew|glew)(?=\W|_)
C++ Example Before:
// Generally code will include one or the other of these, not both - they are// both replaced by garch/glApi.h#include “pxr/imaging/glf/glew.h”#include “pxr/imaging/garch/gl.h”PXR_NAMESPACE_USING_DIRECTIVEvoid gl_functionality_example() { GlfGlewInit(); if (GLEW_KHR_debug) {} if (GLEW_ARB_bindless_texture) {} if (glewIsSupported(“GL_NV_conservative_raster”)) {}#if defined(GLEW_VERSION_4_5) if (GLEW_VERSION_4_5 | GLEW_ARB_direct_state_access) {}#endif}
C++ Example After (21.02+ only):
#include “pxr/imaging/garch/glApi.h”PXR_NAMESPACE_USING_DIRECTIVEvoid gl_functionality_example() { GarchGLApiLoad(); if (GARCH_GLAPI_HAS(KHR_debug)) {} if (GARCH_GLAPI_HAS(ARB_bindless_texture)) if (GARCH_GLAPI_HAS(NV_conservative_raster)) {}#if defined(GL_VERSION_4_5) if (GARCH_GLAPI_HAS(VERSION_4_5) | GARCH_GLAPI_HAS(ARB_direct_state_access)) {}#endif}
C++ Example After (branched):
#if PXR_VERSION >= 2102#include “pxr/imaging/garch/glApi.h”#else// Generally code will include one or the other of these, not both - they are// both replaced by garch/glApi.h#include “pxr/imaging/glf/glew.h”#include “pxr/imaging/garch/gl.h”#endifPXR_NAMESPACE_USING_DIRECTIVEvoid gl_functionality_example() {#if PXR_VERSION >= 2102 GarchGLApiLoad(); if (GARCH_GLAPI_HAS(KHR_debug)) {} if (GARCH_GLAPI_HAS(ARB_bindless_texture)) if (GARCH_GLAPI_HAS(NV_conservative_raster)) {}#if defined(GL_VERSION_4_5) if (GARCH_GLAPI_HAS(VERSION_4_5) | GARCH_GLAPI_HAS(ARB_direct_state_access)) {}#endif#else GlfGlewInit(); if (GLEW_KHR_debug) {} if (GLEW_ARB_bindless_texture) {} if (glewIsSupported(“GL_NV_conservative_raster”)) {}#if defined(GLEW_VERSION_4_5) if (GLEW_VERSION_4_5 | GLEW_ARB_direct_state_access) {}#endif#endif}
C++ Error Strings (Linux):
* pxr/imaging/glf/glew.h: No such file or directory* GL/glew.h: No such file or directory* ‘glewIsSupported’ was not declared in this scope* ‘GlfGlewInit’ was not declared in this scope* ‘GLEW_3DFX_multisample’ was not declared in this scope* ‘GLEW_3DFX_tbuffer’ was not declared in this scope* ‘GLEW_3DFX_texture_compression_FXT1’ was not declared in this scope* ‘GLEW_AMD_blend_minmax_factor’ was not declared in this scope* ‘GLEW_AMD_compressed_3DC_texture’ was not declared in this scope* ‘GLEW_AMD_compressed_ATC_texture’ was not declared in this scope* ‘GLEW_AMD_conservative_depth’ was not declared in this scope* ‘GLEW_AMD_debug_output’ was not declared in this scope* ‘GLEW_AMD_depth_clamp_separate’ was not declared in this scope* ‘GLEW_AMD_draw_buffers_blend’ was not declared in this scope* ‘GLEW_AMD_framebuffer_sample_positions’ was not declared in this scope* ‘GLEW_AMD_gcn_shader’ was not declared in this scope* ‘GLEW_AMD_gpu_shader_half_float’ was not declared in this scope* ‘GLEW_AMD_gpu_shader_int16’ was not declared in this scope* ‘GLEW_AMD_gpu_shader_int64’ was not declared in this scope* ‘GLEW_AMD_interleaved_elements’ was not declared in this scope* ‘GLEW_AMD_multi_draw_indirect’ was not declared in this scope* ‘GLEW_AMD_name_gen_delete’ was not declared in this scope* ‘GLEW_AMD_occlusion_query_event’ was not declared in this scope* ‘GLEW_AMD_performance_monitor’ was not declared in this scope* ‘GLEW_AMD_pinned_memory’ was not declared in this scope* ‘GLEW_AMD_program_binary_Z400’ was not declared in this scope* ‘GLEW_AMD_query_buffer_object’ was not declared in this scope* ‘GLEW_AMD_sample_positions’ was not declared in this scope* ‘GLEW_AMD_seamless_cubemap_per_texture’ was not declared in this scope* ‘GLEW_AMD_shader_atomic_counter_ops’ was not declared in this scope* ‘GLEW_AMD_shader_ballot’ was not declared in this scope* ‘GLEW_AMD_shader_explicit_vertex_parameter’ was not declared in this scope* ‘GLEW_AMD_shader_stencil_export’ was not declared in this scope* ‘GLEW_AMD_shader_stencil_value_export’ was not declared in this scope* ‘GLEW_AMD_shader_trinary_minmax’ was not declared in this scope* ‘GLEW_AMD_sparse_texture’ was not declared in this scope* ‘GLEW_AMD_stencil_operation_extended’ was not declared in this scope* ‘GLEW_AMD_texture_gather_bias_lod’ was not declared in this scope* ‘GLEW_AMD_texture_texture4’ was not declared in this scope* ‘GLEW_AMD_transform_feedback3_lines_triangles’ was not declared in this scope* ‘GLEW_AMD_transform_feedback4’ was not declared in this scope* ‘GLEW_AMD_vertex_shader_layer’ was not declared in this scope* ‘GLEW_AMD_vertex_shader_tessellator’ was not declared in this scope* ‘GLEW_AMD_vertex_shader_viewport_index’ was not declared in this scope* ‘GLEW_ANDROID_extension_pack_es31a’ was not declared in this scope* ‘GLEW_ANGLE_depth_texture’ was not declared in this scope* ‘GLEW_ANGLE_framebuffer_blit’ was not declared in this scope* ‘GLEW_ANGLE_framebuffer_multisample’ was not declared in this scope* ‘GLEW_ANGLE_instanced_arrays’ was not declared in this scope* ‘GLEW_ANGLE_pack_reverse_row_order’ was not declared in this scope* ‘GLEW_ANGLE_program_binary’ was not declared in this scope* ‘GLEW_ANGLE_texture_compression_dxt1’ was not declared in this scope* ‘GLEW_ANGLE_texture_compression_dxt3’ was not declared in this scope* ‘GLEW_ANGLE_texture_compression_dxt5’ was not declared in this scope* ‘GLEW_ANGLE_texture_usage’ was not declared in this scope* ‘GLEW_ANGLE_timer_query’ was not declared in this scope* ‘GLEW_ANGLE_translated_shader_source’ was not declared in this scope* ‘GLEW_APPLE_aux_depth_stencil’ was not declared in this scope* ‘GLEW_APPLE_client_storage’ was not declared in this scope* ‘GLEW_APPLE_clip_distance’ was not declared in this scope* ‘GLEW_APPLE_color_buffer_packed_float’ was not declared in this scope* ‘GLEW_APPLE_copy_texture_levels’ was not declared in this scope* ‘GLEW_APPLE_element_array’ was not declared in this scope* ‘GLEW_APPLE_fence’ was not declared in this scope* ‘GLEW_APPLE_float_pixels’ was not declared in this scope* ‘GLEW_APPLE_flush_buffer_range’ was not declared in this scope* ‘GLEW_APPLE_framebuffer_multisample’ was not declared in this scope* ‘GLEW_APPLE_object_purgeable’ was not declared in this scope* ‘GLEW_APPLE_pixel_buffer’ was not declared in this scope* ‘GLEW_APPLE_rgb_422’ was not declared in this scope* ‘GLEW_APPLE_row_bytes’ was not declared in this scope* ‘GLEW_APPLE_specular_vector’ was not declared in this scope* ‘GLEW_APPLE_sync’ was not declared in this scope* ‘GLEW_APPLE_texture_2D_limited_npot’ was not declared in this scope* ‘GLEW_APPLE_texture_format_BGRA8888’ was not declared in this scope* ‘GLEW_APPLE_texture_max_level’ was not declared in this scope* ‘GLEW_APPLE_texture_packed_float’ was not declared in this scope* ‘GLEW_APPLE_texture_range’ was not declared in this scope* ‘GLEW_APPLE_transform_hint’ was not declared in this scope* ‘GLEW_APPLE_vertex_array_object’ was not declared in this scope* ‘GLEW_APPLE_vertex_array_range’ was not declared in this scope* ‘GLEW_APPLE_vertex_program_evaluators’ was not declared in this scope* ‘GLEW_APPLE_ycbcr_422’ was not declared in this scope* ‘GLEW_ARB_ES2_compatibility’ was not declared in this scope* ‘GLEW_ARB_ES3_1_compatibility’ was not declared in this scope* ‘GLEW_ARB_ES3_2_compatibility’ was not declared in this scope* ‘GLEW_ARB_ES3_compatibility’ was not declared in this scope* ‘GLEW_ARB_arrays_of_arrays’ was not declared in this scope* ‘GLEW_ARB_base_instance’ was not declared in this scope* ‘GLEW_ARB_bindless_texture’ was not declared in this scope* ‘GLEW_ARB_blend_func_extended’ was not declared in this scope* ‘GLEW_ARB_buffer_storage’ was not declared in this scope* ‘GLEW_ARB_cl_event’ was not declared in this scope* ‘GLEW_ARB_clear_buffer_object’ was not declared in this scope* ‘GLEW_ARB_clear_texture’ was not declared in this scope* ‘GLEW_ARB_clip_control’ was not declared in this scope* ‘GLEW_ARB_color_buffer_float’ was not declared in this scope* ‘GLEW_ARB_compatibility’ was not declared in this scope* ‘GLEW_ARB_compressed_texture_pixel_storage’ was not declared in this scope* ‘GLEW_ARB_compute_shader’ was not declared in this scope* ‘GLEW_ARB_compute_variable_group_size’ was not declared in this scope* ‘GLEW_ARB_conditional_render_inverted’ was not declared in this scope* ‘GLEW_ARB_conservative_depth’ was not declared in this scope* ‘GLEW_ARB_copy_buffer’ was not declared in this scope* ‘GLEW_ARB_copy_image’ was not declared in this scope* ‘GLEW_ARB_cull_distance’ was not declared in this scope* ‘GLEW_ARB_debug_output’ was not declared in this scope* ‘GLEW_ARB_depth_buffer_float’ was not declared in this scope* ‘GLEW_ARB_depth_clamp’ was not declared in this scope* ‘GLEW_ARB_depth_texture’ was not declared in this scope* ‘GLEW_ARB_derivative_control’ was not declared in this scope* ‘GLEW_ARB_direct_state_access’ was not declared in this scope* ‘GLEW_ARB_draw_buffers_blend’ was not declared in this scope* ‘GLEW_ARB_draw_buffers’ was not declared in this scope* ‘GLEW_ARB_draw_elements_base_vertex’ was not declared in this scope* ‘GLEW_ARB_draw_indirect’ was not declared in this scope* ‘GLEW_ARB_draw_instanced’ was not declared in this scope* ‘GLEW_ARB_enhanced_layouts’ was not declared in this scope* ‘GLEW_ARB_explicit_attrib_location’ was not declared in this scope* ‘GLEW_ARB_explicit_uniform_location’ was not declared in this scope* ‘GLEW_ARB_fragment_coord_conventions’ was not declared in this scope* ‘GLEW_ARB_fragment_layer_viewport’ was not declared in this scope* ‘GLEW_ARB_fragment_program_shadow’ was not declared in this scope* ‘GLEW_ARB_fragment_program’ was not declared in this scope* ‘GLEW_ARB_fragment_shader_interlock’ was not declared in this scope* ‘GLEW_ARB_fragment_shader’ was not declared in this scope* ‘GLEW_ARB_framebuffer_no_attachments’ was not declared in this scope* ‘GLEW_ARB_framebuffer_object’ was not declared in this scope* ‘GLEW_ARB_framebuffer_sRGB’ was not declared in this scope* ‘GLEW_ARB_geometry_shader4’ was not declared in this scope* ‘GLEW_ARB_get_program_binary’ was not declared in this scope* ‘GLEW_ARB_get_texture_sub_image’ was not declared in this scope* ‘GLEW_ARB_gl_spirv’ was not declared in this scope* ‘GLEW_ARB_gpu_shader5’ was not declared in this scope* ‘GLEW_ARB_gpu_shader_fp64’ was not declared in this scope* ‘GLEW_ARB_gpu_shader_int64’ was not declared in this scope* ‘GLEW_ARB_half_float_pixel’ was not declared in this scope* ‘GLEW_ARB_half_float_vertex’ was not declared in this scope* ‘GLEW_ARB_imaging’ was not declared in this scope* ‘GLEW_ARB_indirect_parameters’ was not declared in this scope* ‘GLEW_ARB_instanced_arrays’ was not declared in this scope* ‘GLEW_ARB_internalformat_query2’ was not declared in this scope* ‘GLEW_ARB_internalformat_query’ was not declared in this scope* ‘GLEW_ARB_invalidate_subdata’ was not declared in this scope* ‘GLEW_ARB_map_buffer_alignment’ was not declared in this scope* ‘GLEW_ARB_map_buffer_range’ was not declared in this scope* ‘GLEW_ARB_matrix_palette’ was not declared in this scope* ‘GLEW_ARB_multi_bind’ was not declared in this scope* ‘GLEW_ARB_multi_draw_indirect’ was not declared in this scope* ‘GLEW_ARB_multisample’ was not declared in this scope* ‘GLEW_ARB_multitexture’ was not declared in this scope* ‘GLEW_ARB_occlusion_query2’ was not declared in this scope* ‘GLEW_ARB_occlusion_query’ was not declared in this scope* ‘GLEW_ARB_parallel_shader_compile’ was not declared in this scope* ‘GLEW_ARB_pipeline_statistics_query’ was not declared in this scope* ‘GLEW_ARB_pixel_buffer_object’ was not declared in this scope* ‘GLEW_ARB_point_parameters’ was not declared in this scope* ‘GLEW_ARB_point_sprite’ was not declared in this scope* ‘GLEW_ARB_polygon_offset_clamp’ was not declared in this scope* ‘GLEW_ARB_post_depth_coverage’ was not declared in this scope* ‘GLEW_ARB_program_interface_query’ was not declared in this scope* ‘GLEW_ARB_provoking_vertex’ was not declared in this scope* ‘GLEW_ARB_query_buffer_object’ was not declared in this scope* ‘GLEW_ARB_robust_buffer_access_behavior’ was not declared in this scope* ‘GLEW_ARB_robustness_application_isolation’ was not declared in this scope* ‘GLEW_ARB_robustness_share_group_isolation’ was not declared in this scope* ‘GLEW_ARB_robustness’ was not declared in this scope* ‘GLEW_ARB_sample_locations’ was not declared in this scope* ‘GLEW_ARB_sample_shading’ was not declared in this scope* ‘GLEW_ARB_sampler_objects’ was not declared in this scope* ‘GLEW_ARB_seamless_cube_map’ was not declared in this scope* ‘GLEW_ARB_seamless_cubemap_per_texture’ was not declared in this scope* ‘GLEW_ARB_separate_shader_objects’ was not declared in this scope* ‘GLEW_ARB_shader_atomic_counter_ops’ was not declared in this scope* ‘GLEW_ARB_shader_atomic_counters’ was not declared in this scope* ‘GLEW_ARB_shader_ballot’ was not declared in this scope* ‘GLEW_ARB_shader_bit_encoding’ was not declared in this scope* ‘GLEW_ARB_shader_clock’ was not declared in this scope* ‘GLEW_ARB_shader_draw_parameters’ was not declared in this scope* ‘GLEW_ARB_shader_group_vote’ was not declared in this scope* ‘GLEW_ARB_shader_image_load_store’ was not declared in this scope* ‘GLEW_ARB_shader_image_size’ was not declared in this scope* ‘GLEW_ARB_shader_objects’ was not declared in this scope* ‘GLEW_ARB_shader_precision’ was not declared in this scope* ‘GLEW_ARB_shader_stencil_export’ was not declared in this scope* ‘GLEW_ARB_shader_storage_buffer_object’ was not declared in this scope* ‘GLEW_ARB_shader_subroutine’ was not declared in this scope* ‘GLEW_ARB_shader_texture_image_samples’ was not declared in this scope* ‘GLEW_ARB_shader_texture_lod’ was not declared in this scope* ‘GLEW_ARB_shader_viewport_layer_array’ was not declared in this scope* ‘GLEW_ARB_shading_language_100’ was not declared in this scope* ‘GLEW_ARB_shading_language_420pack’ was not declared in this scope* ‘GLEW_ARB_shading_language_include’ was not declared in this scope* ‘GLEW_ARB_shading_language_packing’ was not declared in this scope* ‘GLEW_ARB_shadow_ambient’ was not declared in this scope* ‘GLEW_ARB_shadow’ was not declared in this scope* ‘GLEW_ARB_sparse_buffer’ was not declared in this scope* ‘GLEW_ARB_sparse_texture2’ was not declared in this scope* ‘GLEW_ARB_sparse_texture_clamp’ was not declared in this scope* ‘GLEW_ARB_sparse_texture’ was not declared in this scope* ‘GLEW_ARB_spirv_extensions’ was not declared in this scope* ‘GLEW_ARB_stencil_texturing’ was not declared in this scope* ‘GLEW_ARB_sync’ was not declared in this scope* ‘GLEW_ARB_tessellation_shader’ was not declared in this scope* ‘GLEW_ARB_texture_barrier’ was not declared in this scope* ‘GLEW_ARB_texture_border_clamp’ was not declared in this scope* ‘GLEW_ARB_texture_buffer_object_rgb32’ was not declared in this scope* ‘GLEW_ARB_texture_buffer_object’ was not declared in this scope* ‘GLEW_ARB_texture_buffer_range’ was not declared in this scope* ‘GLEW_ARB_texture_compression_bptc’ was not declared in this scope* ‘GLEW_ARB_texture_compression_rgtc’ was not declared in this scope* ‘GLEW_ARB_texture_compression’ was not declared in this scope* ‘GLEW_ARB_texture_cube_map_array’ was not declared in this scope* ‘GLEW_ARB_texture_cube_map’ was not declared in this scope* ‘GLEW_ARB_texture_env_add’ was not declared in this scope* ‘GLEW_ARB_texture_env_combine’ was not declared in this scope* ‘GLEW_ARB_texture_env_crossbar’ was not declared in this scope* ‘GLEW_ARB_texture_env_dot3’ was not declared in this scope* ‘GLEW_ARB_texture_filter_anisotropic’ was not declared in this scope* ‘GLEW_ARB_texture_filter_minmax’ was not declared in this scope* ‘GLEW_ARB_texture_float’ was not declared in this scope* ‘GLEW_ARB_texture_gather’ was not declared in this scope* ‘GLEW_ARB_texture_mirror_clamp_to_edge’ was not declared in this scope* ‘GLEW_ARB_texture_mirrored_repeat’ was not declared in this scope* ‘GLEW_ARB_texture_multisample’ was not declared in this scope* ‘GLEW_ARB_texture_non_power_of_two’ was not declared in this scope* ‘GLEW_ARB_texture_query_levels’ was not declared in this scope* ‘GLEW_ARB_texture_query_lod’ was not declared in this scope* ‘GLEW_ARB_texture_rectangle’ was not declared in this scope* ‘GLEW_ARB_texture_rgb10_a2ui’ was not declared in this scope* ‘GLEW_ARB_texture_rg’ was not declared in this scope* ‘GLEW_ARB_texture_stencil8’ was not declared in this scope* ‘GLEW_ARB_texture_storage_multisample’ was not declared in this scope* ‘GLEW_ARB_texture_storage’ was not declared in this scope* ‘GLEW_ARB_texture_swizzle’ was not declared in this scope* ‘GLEW_ARB_texture_view’ was not declared in this scope* ‘GLEW_ARB_timer_query’ was not declared in this scope* ‘GLEW_ARB_transform_feedback2’ was not declared in this scope* ‘GLEW_ARB_transform_feedback3’ was not declared in this scope* ‘GLEW_ARB_transform_feedback_instanced’ was not declared in this scope* ‘GLEW_ARB_transform_feedback_overflow_query’ was not declared in this scope* ‘GLEW_ARB_transpose_matrix’ was not declared in this scope* ‘GLEW_ARB_uniform_buffer_object’ was not declared in this scope* ‘GLEW_ARB_vertex_array_bgra’ was not declared in this scope* ‘GLEW_ARB_vertex_array_object’ was not declared in this scope* ‘GLEW_ARB_vertex_attrib_64bit’ was not declared in this scope* ‘GLEW_ARB_vertex_attrib_binding’ was not declared in this scope* ‘GLEW_ARB_vertex_blend’ was not declared in this scope* ‘GLEW_ARB_vertex_buffer_object’ was not declared in this scope* ‘GLEW_ARB_vertex_program’ was not declared in this scope* ‘GLEW_ARB_vertex_shader’ was not declared in this scope* ‘GLEW_ARB_vertex_type_10f_11f_11f_rev’ was not declared in this scope* ‘GLEW_ARB_vertex_type_2_10_10_10_rev’ was not declared in this scope* ‘GLEW_ARB_viewport_array’ was not declared in this scope* ‘GLEW_ARB_window_pos’ was not declared in this scope* ‘GLEW_ARM_mali_program_binary’ was not declared in this scope* ‘GLEW_ARM_mali_shader_binary’ was not declared in this scope* ‘GLEW_ARM_rgba8’ was not declared in this scope* ‘GLEW_ARM_shader_framebuffer_fetch_depth_stencil’ was not declared in this scope* ‘GLEW_ARM_shader_framebuffer_fetch’ was not declared in this scope* ‘GLEW_ATIX_point_sprites’ was not declared in this scope* ‘GLEW_ATIX_texture_env_combine3’ was not declared in this scope* ‘GLEW_ATIX_texture_env_route’ was not declared in this scope* ‘GLEW_ATIX_vertex_shader_output_point_size’ was not declared in this scope* ‘GLEW_ATI_draw_buffers’ was not declared in this scope* ‘GLEW_ATI_element_array’ was not declared in this scope* ‘GLEW_ATI_envmap_bumpmap’ was not declared in this scope* ‘GLEW_ATI_fragment_shader’ was not declared in this scope* ‘GLEW_ATI_map_object_buffer’ was not declared in this scope* ‘GLEW_ATI_meminfo’ was not declared in this scope* ‘GLEW_ATI_pn_triangles’ was not declared in this scope* ‘GLEW_ATI_separate_stencil’ was not declared in this scope* ‘GLEW_ATI_shader_texture_lod’ was not declared in this scope* ‘GLEW_ATI_text_fragment_shader’ was not declared in this scope* ‘GLEW_ATI_texture_compression_3dc’ was not declared in this scope* ‘GLEW_ATI_texture_env_combine3’ was not declared in this scope* ‘GLEW_ATI_texture_float’ was not declared in this scope* ‘GLEW_ATI_texture_mirror_once’ was not declared in this scope* ‘GLEW_ATI_vertex_array_object’ was not declared in this scope* ‘GLEW_ATI_vertex_attrib_array_object’ was not declared in this scope* ‘GLEW_ATI_vertex_streams’ was not declared in this scope* ‘GLEW_EGL_KHR_context_flush_control’ was not declared in this scope* ‘GLEW_EGL_NV_robustness_video_memory_purge’ was not declared in this scope* ‘GLEW_ERROR_GLX_VERSION_11_ONLY’ was not declared in this scope* ‘GLEW_ERROR_GL_VERSION_10_ONLY’ was not declared in this scope* ‘GLEW_ERROR_NO_GLX_DISPLAY’ was not declared in this scope* ‘GLEW_ERROR_NO_GL_VERSION’ was not declared in this scope* ‘GLEW_EXT_422_pixels’ was not declared in this scope* ‘GLEW_EXT_Cg_shader’ was not declared in this scope* ‘GLEW_EXT_EGL_image_array’ was not declared in this scope* ‘GLEW_EXT_YUV_target’ was not declared in this scope* ‘GLEW_EXT_abgr’ was not declared in this scope* ‘GLEW_EXT_base_instance’ was not declared in this scope* ‘GLEW_EXT_bgra’ was not declared in this scope* ‘GLEW_EXT_bindable_uniform’ was not declared in this scope* ‘GLEW_EXT_blend_color’ was not declared in this scope* ‘GLEW_EXT_blend_equation_separate’ was not declared in this scope* ‘GLEW_EXT_blend_func_extended’ was not declared in this scope* ‘GLEW_EXT_blend_func_separate’ was not declared in this scope* ‘GLEW_EXT_blend_logic_op’ was not declared in this scope* ‘GLEW_EXT_blend_minmax’ was not declared in this scope* ‘GLEW_EXT_blend_subtract’ was not declared in this scope* ‘GLEW_EXT_buffer_storage’ was not declared in this scope* ‘GLEW_EXT_clear_texture’ was not declared in this scope* ‘GLEW_EXT_clip_cull_distance’ was not declared in this scope* ‘GLEW_EXT_clip_volume_hint’ was not declared in this scope* ‘GLEW_EXT_cmyka’ was not declared in this scope* ‘GLEW_EXT_color_buffer_float’ was not declared in this scope* ‘GLEW_EXT_color_buffer_half_float’ was not declared in this scope* ‘GLEW_EXT_color_subtable’ was not declared in this scope* ‘GLEW_EXT_compiled_vertex_array’ was not declared in this scope* ‘GLEW_EXT_compressed_ETC1_RGB8_sub_texture’ was not declared in this scope* ‘GLEW_EXT_conservative_depth’ was not declared in this scope* ‘GLEW_EXT_convolution’ was not declared in this scope* ‘GLEW_EXT_coordinate_frame’ was not declared in this scope* ‘GLEW_EXT_copy_image’ was not declared in this scope* ‘GLEW_EXT_copy_texture’ was not declared in this scope* ‘GLEW_EXT_cull_vertex’ was not declared in this scope* ‘GLEW_EXT_debug_label’ was not declared in this scope* ‘GLEW_EXT_debug_marker’ was not declared in this scope* ‘GLEW_EXT_depth_bounds_test’ was not declared in this scope* ‘GLEW_EXT_direct_state_access’ was not declared in this scope* ‘GLEW_EXT_discard_framebuffer’ was not declared in this scope* ‘GLEW_EXT_draw_buffers2’ was not declared in this scope* ‘GLEW_EXT_draw_buffers_indexed’ was not declared in this scope* ‘GLEW_EXT_draw_buffers’ was not declared in this scope* ‘GLEW_EXT_draw_elements_base_vertex’ was not declared in this scope* ‘GLEW_EXT_draw_instanced’ was not declared in this scope* ‘GLEW_EXT_draw_range_elements’ was not declared in this scope* ‘GLEW_EXT_external_buffer’ was not declared in this scope* ‘GLEW_EXT_float_blend’ was not declared in this scope* ‘GLEW_EXT_fog_coord’ was not declared in this scope* ‘GLEW_EXT_frag_depth’ was not declared in this scope* ‘GLEW_EXT_fragment_lighting’ was not declared in this scope* ‘GLEW_EXT_framebuffer_blit’ was not declared in this scope* ‘GLEW_EXT_framebuffer_multisample_blit_scaled’ was not declared in this scope* ‘GLEW_EXT_framebuffer_multisample’ was not declared in this scope* ‘GLEW_EXT_framebuffer_object’ was not declared in this scope* ‘GLEW_EXT_framebuffer_sRGB’ was not declared in this scope* ‘GLEW_EXT_geometry_point_size’ was not declared in this scope* ‘GLEW_EXT_geometry_shader4’ was not declared in this scope* ‘GLEW_EXT_geometry_shader’ was not declared in this scope* ‘GLEW_EXT_gpu_program_parameters’ was not declared in this scope* ‘GLEW_EXT_gpu_shader4’ was not declared in this scope* ‘GLEW_EXT_gpu_shader5’ was not declared in this scope* ‘GLEW_EXT_histogram’ was not declared in this scope* ‘GLEW_EXT_index_array_formats’ was not declared in this scope* ‘GLEW_EXT_index_func’ was not declared in this scope* ‘GLEW_EXT_index_material’ was not declared in this scope* ‘GLEW_EXT_index_texture’ was not declared in this scope* ‘GLEW_EXT_instanced_arrays’ was not declared in this scope* ‘GLEW_EXT_light_texture’ was not declared in this scope* ‘GLEW_EXT_map_buffer_range’ was not declared in this scope* ‘GLEW_EXT_memory_object_fd’ was not declared in this scope* ‘GLEW_EXT_memory_object_win32’ was not declared in this scope* ‘GLEW_EXT_memory_object’ was not declared in this scope* ‘GLEW_EXT_misc_attribute’ was not declared in this scope* ‘GLEW_EXT_multi_draw_arrays’ was not declared in this scope* ‘GLEW_EXT_multi_draw_indirect’ was not declared in this scope* ‘GLEW_EXT_multiple_textures’ was not declared in this scope* ‘GLEW_EXT_multisample_compatibility’ was not declared in this scope* ‘GLEW_EXT_multisampled_render_to_texture2’ was not declared in this scope* ‘GLEW_EXT_multisampled_render_to_texture’ was not declared in this scope* ‘GLEW_EXT_multisample’ was not declared in this scope* ‘GLEW_EXT_multiview_draw_buffers’ was not declared in this scope* ‘GLEW_EXT_packed_depth_stencil’ was not declared in this scope* ‘GLEW_EXT_packed_float’ was not declared in this scope* ‘GLEW_EXT_packed_pixels’ was not declared in this scope* ‘GLEW_EXT_paletted_texture’ was not declared in this scope* ‘GLEW_EXT_pixel_buffer_object’ was not declared in this scope* ‘GLEW_EXT_pixel_transform_color_table’ was not declared in this scope* ‘GLEW_EXT_pixel_transform’ was not declared in this scope* ‘GLEW_EXT_point_parameters’ was not declared in this scope* ‘GLEW_EXT_polygon_offset_clamp’ was not declared in this scope* ‘GLEW_EXT_polygon_offset’ was not declared in this scope* ‘GLEW_EXT_post_depth_coverage’ was not declared in this scope* ‘GLEW_EXT_provoking_vertex’ was not declared in this scope* ‘GLEW_EXT_pvrtc_sRGB’ was not declared in this scope* ‘GLEW_EXT_raster_multisample’ was not declared in this scope* ‘GLEW_EXT_read_format_bgra’ was not declared in this scope* ‘GLEW_EXT_render_snorm’ was not declared in this scope* ‘GLEW_EXT_rescale_normal’ was not declared in this scope* ‘GLEW_EXT_sRGB_write_control’ was not declared in this scope* ‘GLEW_EXT_sRGB’ was not declared in this scope* ‘GLEW_EXT_scene_marker’ was not declared in this scope* ‘GLEW_EXT_secondary_color’ was not declared in this scope* ‘GLEW_EXT_semaphore_fd’ was not declared in this scope* ‘GLEW_EXT_semaphore_win32’ was not declared in this scope* ‘GLEW_EXT_semaphore’ was not declared in this scope* ‘GLEW_EXT_separate_shader_objects’ was not declared in this scope* ‘GLEW_EXT_separate_specular_color’ was not declared in this scope* ‘GLEW_EXT_shader_framebuffer_fetch’ was not declared in this scope* ‘GLEW_EXT_shader_group_vote’ was not declared in this scope* ‘GLEW_EXT_shader_image_load_formatted’ was not declared in this scope* ‘GLEW_EXT_shader_image_load_store’ was not declared in this scope* ‘GLEW_EXT_shader_implicit_conversions’ was not declared in this scope* ‘GLEW_EXT_shader_integer_mix’ was not declared in this scope* ‘GLEW_EXT_shader_io_blocks’ was not declared in this scope* ‘GLEW_EXT_shader_non_constant_global_initializers’ was not declared in this scope* ‘GLEW_EXT_shader_pixel_local_storage2’ was not declared in this scope* ‘GLEW_EXT_shader_pixel_local_storage’ was not declared in this scope* ‘GLEW_EXT_shader_texture_lod’ was not declared in this scope* ‘GLEW_EXT_shadow_funcs’ was not declared in this scope* ‘GLEW_EXT_shadow_samplers’ was not declared in this scope* ‘GLEW_EXT_shared_texture_palette’ was not declared in this scope* ‘GLEW_EXT_sparse_texture2’ was not declared in this scope* ‘GLEW_EXT_sparse_texture’ was not declared in this scope* ‘GLEW_EXT_stencil_clear_tag’ was not declared in this scope* ‘GLEW_EXT_stencil_two_side’ was not declared in this scope* ‘GLEW_EXT_stencil_wrap’ was not declared in this scope* ‘GLEW_EXT_subtexture’ was not declared in this scope* ‘GLEW_EXT_texture3D’ was not declared in this scope* ‘GLEW_EXT_texture_array’ was not declared in this scope* ‘GLEW_EXT_texture_buffer_object’ was not declared in this scope* ‘GLEW_EXT_texture_compression_astc_decode_mode_rgb9e5’ was not declared in this scope* ‘GLEW_EXT_texture_compression_astc_decode_mode’ was not declared in this scope* ‘GLEW_EXT_texture_compression_bptc’ was not declared in this scope* ‘GLEW_EXT_texture_compression_dxt1’ was not declared in this scope* ‘GLEW_EXT_texture_compression_latc’ was not declared in this scope* ‘GLEW_EXT_texture_compression_rgtc’ was not declared in this scope* ‘GLEW_EXT_texture_compression_s3tc’ was not declared in this scope* ‘GLEW_EXT_texture_cube_map_array’ was not declared in this scope* ‘GLEW_EXT_texture_cube_map’ was not declared in this scope* ‘GLEW_EXT_texture_edge_clamp’ was not declared in this scope* ‘GLEW_EXT_texture_env_add’ was not declared in this scope* ‘GLEW_EXT_texture_env_combine’ was not declared in this scope* ‘GLEW_EXT_texture_env_dot3’ was not declared in this scope* ‘GLEW_EXT_texture_env’ was not declared in this scope* ‘GLEW_EXT_texture_filter_anisotropic’ was not declared in this scope* ‘GLEW_EXT_texture_filter_minmax’ was not declared in this scope* ‘GLEW_EXT_texture_format_BGRA8888’ was not declared in this scope* ‘GLEW_EXT_texture_integer’ was not declared in this scope* ‘GLEW_EXT_texture_lod_bias’ was not declared in this scope* ‘GLEW_EXT_texture_mirror_clamp’ was not declared in this scope* ‘GLEW_EXT_texture_norm16’ was not declared in this scope* ‘GLEW_EXT_texture_object’ was not declared in this scope* ‘GLEW_EXT_texture_perturb_normal’ was not declared in this scope* ‘GLEW_EXT_texture_rectangle’ was not declared in this scope* ‘GLEW_EXT_texture_rg’ was not declared in this scope* ‘GLEW_EXT_texture_sRGB_R8’ was not declared in this scope* ‘GLEW_EXT_texture_sRGB_RG8’ was not declared in this scope* ‘GLEW_EXT_texture_sRGB_decode’ was not declared in this scope* ‘GLEW_EXT_texture_sRGB’ was not declared in this scope* ‘GLEW_EXT_texture_shared_exponent’ was not declared in this scope* ‘GLEW_EXT_texture_snorm’ was not declared in this scope* ‘GLEW_EXT_texture_storage’ was not declared in this scope* ‘GLEW_EXT_texture_swizzle’ was not declared in this scope* ‘GLEW_EXT_texture_type_2_10_10_10_REV’ was not declared in this scope* ‘GLEW_EXT_texture_view’ was not declared in this scope* ‘GLEW_EXT_texture’ was not declared in this scope* ‘GLEW_EXT_timer_query’ was not declared in this scope* ‘GLEW_EXT_transform_feedback’ was not declared in this scope* ‘GLEW_EXT_unpack_subimage’ was not declared in this scope* ‘GLEW_EXT_vertex_array_bgra’ was not declared in this scope* ‘GLEW_EXT_vertex_array_setXXX’ was not declared in this scope* ‘GLEW_EXT_vertex_array’ was not declared in this scope* ‘GLEW_EXT_vertex_attrib_64bit’ was not declared in this scope* ‘GLEW_EXT_vertex_shader’ was not declared in this scope* ‘GLEW_EXT_vertex_weighting’ was not declared in this scope* ‘GLEW_EXT_win32_keyed_mutex’ was not declared in this scope* ‘GLEW_EXT_window_rectangles’ was not declared in this scope* ‘GLEW_EXT_x11_sync_object’ was not declared in this scope* ‘GLEW_GET_VAR’ was not declared in this scope* ‘GLEW_GET_FUN’ was not declared in this scope* ‘GLEW_GREMEDY_frame_terminator’ was not declared in this scope* ‘GLEW_GREMEDY_string_marker’ was not declared in this scope* ‘GLEW_HP_convolution_border_modes’ was not declared in this scope* ‘GLEW_HP_image_transform’ was not declared in this scope* ‘GLEW_HP_occlusion_test’ was not declared in this scope* ‘GLEW_HP_texture_lighting’ was not declared in this scope* ‘GLEW_IBM_cull_vertex’ was not declared in this scope* ‘GLEW_IBM_multimode_draw_arrays’ was not declared in this scope* ‘GLEW_IBM_rasterpos_clip’ was not declared in this scope* ‘GLEW_IBM_static_data’ was not declared in this scope* ‘GLEW_IBM_texture_mirrored_repeat’ was not declared in this scope* ‘GLEW_IBM_vertex_array_lists’ was not declared in this scope* ‘GLEW_INGR_color_clamp’ was not declared in this scope* ‘GLEW_INGR_interlace_read’ was not declared in this scope* ‘GLEW_INTEL_conservative_rasterization’ was not declared in this scope* ‘GLEW_INTEL_fragment_shader_ordering’ was not declared in this scope* ‘GLEW_INTEL_framebuffer_CMAA’ was not declared in this scope* ‘GLEW_INTEL_map_texture’ was not declared in this scope* ‘GLEW_INTEL_parallel_arrays’ was not declared in this scope* ‘GLEW_INTEL_performance_query’ was not declared in this scope* ‘GLEW_INTEL_texture_scissor’ was not declared in this scope* ‘GLEW_KHR_blend_equation_advanced_coherent’ was not declared in this scope* ‘GLEW_KHR_blend_equation_advanced’ was not declared in this scope* ‘GLEW_KHR_context_flush_control’ was not declared in this scope* ‘GLEW_KHR_debug’ was not declared in this scope* ‘GLEW_KHR_no_error’ was not declared in this scope* ‘GLEW_KHR_parallel_shader_compile’ was not declared in this scope* ‘GLEW_KHR_robust_buffer_access_behavior’ was not declared in this scope* ‘GLEW_KHR_robustness’ was not declared in this scope* ‘GLEW_KHR_texture_compression_astc_hdr’ was not declared in this scope* ‘GLEW_KHR_texture_compression_astc_ldr’ was not declared in this scope* ‘GLEW_KHR_texture_compression_astc_sliced_3d’ was not declared in this scope* ‘GLEW_KTX_buffer_region’ was not declared in this scope* ‘GLEW_MESAX_texture_stack’ was not declared in this scope* ‘GLEW_MESA_pack_invert’ was not declared in this scope* ‘GLEW_MESA_resize_buffers’ was not declared in this scope* ‘GLEW_MESA_shader_integer_functions’ was not declared in this scope* ‘GLEW_MESA_window_pos’ was not declared in this scope* ‘GLEW_MESA_ycbcr_texture’ was not declared in this scope* ‘GLEW_NO_ERROR’ was not declared in this scope* ‘GLEW_NVX_blend_equation_advanced_multi_draw_buffers’ was not declared in this scope* ‘GLEW_NVX_conditional_render’ was not declared in this scope* ‘GLEW_NVX_gpu_memory_info’ was not declared in this scope* ‘GLEW_NVX_linked_gpu_multicast’ was not declared in this scope* ‘GLEW_NV_3dvision_settings’ was not declared in this scope* ‘GLEW_NV_EGL_stream_consumer_external’ was not declared in this scope* ‘GLEW_NV_alpha_to_coverage_dither_control’ was not declared in this scope* ‘GLEW_NV_bgr’ was not declared in this scope* ‘GLEW_NV_bindless_multi_draw_indirect_count’ was not declared in this scope* ‘GLEW_NV_bindless_multi_draw_indirect’ was not declared in this scope* ‘GLEW_NV_bindless_texture’ was not declared in this scope* ‘GLEW_NV_blend_equation_advanced_coherent’ was not declared in this scope* ‘GLEW_NV_blend_equation_advanced’ was not declared in this scope* ‘GLEW_NV_blend_minmax_factor’ was not declared in this scope* ‘GLEW_NV_blend_square’ was not declared in this scope* ‘GLEW_NV_clip_space_w_scaling’ was not declared in this scope* ‘GLEW_NV_command_list’ was not declared in this scope* ‘GLEW_NV_compute_program5’ was not declared in this scope* ‘GLEW_NV_conditional_render’ was not declared in this scope* ‘GLEW_NV_conservative_raster_dilate’ was not declared in this scope* ‘GLEW_NV_conservative_raster_pre_snap_triangles’ was not declared in this scope* ‘GLEW_NV_conservative_raster’ was not declared in this scope* ‘GLEW_NV_copy_buffer’ was not declared in this scope* ‘GLEW_NV_copy_depth_to_color’ was not declared in this scope* ‘GLEW_NV_copy_image’ was not declared in this scope* ‘GLEW_NV_deep_texture3D’ was not declared in this scope* ‘GLEW_NV_depth_buffer_float’ was not declared in this scope* ‘GLEW_NV_depth_clamp’ was not declared in this scope* ‘GLEW_NV_depth_range_unclamped’ was not declared in this scope* ‘GLEW_NV_draw_buffers’ was not declared in this scope* ‘GLEW_NV_draw_instanced’ was not declared in this scope* ‘GLEW_NV_draw_texture’ was not declared in this scope* ‘GLEW_NV_draw_vulkan_image’ was not declared in this scope* ‘GLEW_NV_evaluators’ was not declared in this scope* ‘GLEW_NV_explicit_attrib_location’ was not declared in this scope* ‘GLEW_NV_explicit_multisample’ was not declared in this scope* ‘GLEW_NV_fbo_color_attachments’ was not declared in this scope* ‘GLEW_NV_fence’ was not declared in this scope* ‘GLEW_NV_fill_rectangle’ was not declared in this scope* ‘GLEW_NV_float_buffer’ was not declared in this scope* ‘GLEW_NV_fog_distance’ was not declared in this scope* ‘GLEW_NV_fragment_coverage_to_color’ was not declared in this scope* ‘GLEW_NV_fragment_program2’ was not declared in this scope* ‘GLEW_NV_fragment_program4’ was not declared in this scope* ‘GLEW_NV_fragment_program_option’ was not declared in this scope* ‘GLEW_NV_fragment_program’ was not declared in this scope* ‘GLEW_NV_fragment_shader_interlock’ was not declared in this scope* ‘GLEW_NV_framebuffer_blit’ was not declared in this scope* ‘GLEW_NV_framebuffer_mixed_samples’ was not declared in this scope* ‘GLEW_NV_framebuffer_multisample_coverage’ was not declared in this scope* ‘GLEW_NV_framebuffer_multisample’ was not declared in this scope* ‘GLEW_NV_generate_mipmap_sRGB’ was not declared in this scope* ‘GLEW_NV_geometry_program4’ was not declared in this scope* ‘GLEW_NV_geometry_shader4’ was not declared in this scope* ‘GLEW_NV_geometry_shader_passthrough’ was not declared in this scope* ‘GLEW_NV_gpu_multicast’ was not declared in this scope* ‘GLEW_NV_gpu_program4’ was not declared in this scope* ‘GLEW_NV_gpu_program5_mem_extended’ was not declared in this scope* ‘GLEW_NV_gpu_program5’ was not declared in this scope* ‘GLEW_NV_gpu_program_fp64’ was not declared in this scope* ‘GLEW_NV_gpu_shader5’ was not declared in this scope* ‘GLEW_NV_half_float’ was not declared in this scope* ‘GLEW_NV_image_formats’ was not declared in this scope* ‘GLEW_NV_instanced_arrays’ was not declared in this scope* ‘GLEW_NV_internalformat_sample_query’ was not declared in this scope* ‘GLEW_NV_light_max_exponent’ was not declared in this scope* ‘GLEW_NV_multisample_coverage’ was not declared in this scope* ‘GLEW_NV_multisample_filter_hint’ was not declared in this scope* ‘GLEW_NV_non_square_matrices’ was not declared in this scope* ‘GLEW_NV_occlusion_query’ was not declared in this scope* ‘GLEW_NV_pack_subimage’ was not declared in this scope* ‘GLEW_NV_packed_depth_stencil’ was not declared in this scope* ‘GLEW_NV_packed_float_linear’ was not declared in this scope* ‘GLEW_NV_packed_float’ was not declared in this scope* ‘GLEW_NV_parameter_buffer_object2’ was not declared in this scope* ‘GLEW_NV_parameter_buffer_object’ was not declared in this scope* ‘GLEW_NV_path_rendering_shared_edge’ was not declared in this scope* ‘GLEW_NV_path_rendering’ was not declared in this scope* ‘GLEW_NV_pixel_buffer_object’ was not declared in this scope* ‘GLEW_NV_pixel_data_range’ was not declared in this scope* ‘GLEW_NV_platform_binary’ was not declared in this scope* ‘GLEW_NV_point_sprite’ was not declared in this scope* ‘GLEW_NV_polygon_mode’ was not declared in this scope* ‘GLEW_NV_present_video’ was not declared in this scope* ‘GLEW_NV_primitive_restart’ was not declared in this scope* ‘GLEW_NV_read_depth_stencil’ was not declared in this scope* ‘GLEW_NV_read_depth’ was not declared in this scope* ‘GLEW_NV_read_stencil’ was not declared in this scope* ‘GLEW_NV_register_combiners2’ was not declared in this scope* ‘GLEW_NV_register_combiners’ was not declared in this scope* ‘GLEW_NV_robustness_video_memory_purge’ was not declared in this scope* ‘GLEW_NV_sRGB_formats’ was not declared in this scope* ‘GLEW_NV_sample_locations’ was not declared in this scope* ‘GLEW_NV_sample_mask_override_coverage’ was not declared in this scope* ‘GLEW_NV_shader_atomic_counters’ was not declared in this scope* ‘GLEW_NV_shader_atomic_float64’ was not declared in this scope* ‘GLEW_NV_shader_atomic_float’ was not declared in this scope* ‘GLEW_NV_shader_atomic_fp16_vector’ was not declared in this scope* ‘GLEW_NV_shader_atomic_int64’ was not declared in this scope* ‘GLEW_NV_shader_buffer_load’ was not declared in this scope* ‘GLEW_NV_shader_noperspective_interpolation’ was not declared in this scope* ‘GLEW_NV_shader_storage_buffer_object’ was not declared in this scope* ‘GLEW_NV_shader_thread_group’ was not declared in this scope* ‘GLEW_NV_shader_thread_shuffle’ was not declared in this scope* ‘GLEW_NV_shadow_samplers_array’ was not declared in this scope* ‘GLEW_NV_shadow_samplers_cube’ was not declared in this scope* ‘GLEW_NV_stereo_view_rendering’ was not declared in this scope* ‘GLEW_NV_tessellation_program5’ was not declared in this scope* ‘GLEW_NV_texgen_emboss’ was not declared in this scope* ‘GLEW_NV_texgen_reflection’ was not declared in this scope* ‘GLEW_NV_texture_array’ was not declared in this scope* ‘GLEW_NV_texture_barrier’ was not declared in this scope* ‘GLEW_NV_texture_border_clamp’ was not declared in this scope* ‘GLEW_NV_texture_compression_latc’ was not declared in this scope* ‘GLEW_NV_texture_compression_s3tc_update’ was not declared in this scope* ‘GLEW_NV_texture_compression_s3tc’ was not declared in this scope* ‘GLEW_NV_texture_compression_vtc’ was not declared in this scope* ‘GLEW_NV_texture_env_combine4’ was not declared in this scope* ‘GLEW_NV_texture_expand_normal’ was not declared in this scope* ‘GLEW_NV_texture_multisample’ was not declared in this scope* ‘GLEW_NV_texture_npot_2D_mipmap’ was not declared in this scope* ‘GLEW_NV_texture_rectangle_compressed’ was not declared in this scope* ‘GLEW_NV_texture_rectangle’ was not declared in this scope* ‘GLEW_NV_texture_shader2’ was not declared in this scope* ‘GLEW_NV_texture_shader3’ was not declared in this scope* ‘GLEW_NV_texture_shader’ was not declared in this scope* ‘GLEW_NV_transform_feedback2’ was not declared in this scope* ‘GLEW_NV_transform_feedback’ was not declared in this scope* ‘GLEW_NV_uniform_buffer_unified_memory’ was not declared in this scope* ‘GLEW_NV_vdpau_interop’ was not declared in this scope* ‘GLEW_NV_vertex_array_range2’ was not declared in this scope* ‘GLEW_NV_vertex_array_range’ was not declared in this scope* ‘GLEW_NV_vertex_attrib_integer_64bit’ was not declared in this scope* ‘GLEW_NV_vertex_buffer_unified_memory’ was not declared in this scope* ‘GLEW_NV_vertex_program1_1’ was not declared in this scope* ‘GLEW_NV_vertex_program2_option’ was not declared in this scope* ‘GLEW_NV_vertex_program2’ was not declared in this scope* ‘GLEW_NV_vertex_program3’ was not declared in this scope* ‘GLEW_NV_vertex_program4’ was not declared in this scope* ‘GLEW_NV_vertex_program’ was not declared in this scope* ‘GLEW_NV_video_capture’ was not declared in this scope* ‘GLEW_NV_viewport_array2’ was not declared in this scope* ‘GLEW_NV_viewport_array’ was not declared in this scope* ‘GLEW_NV_viewport_swizzle’ was not declared in this scope* ‘GLEW_OES_byte_coordinates’ was not declared in this scope* ‘GLEW_OK’ was not declared in this scope; did you mean ‘W_OK’?* ‘GLEW_OML_interlace’ was not declared in this scope* ‘GLEW_OML_resample’ was not declared in this scope* ‘GLEW_OML_subsample’ was not declared in this scope* ‘GLEW_OVR_multiview2’ was not declared in this scope* ‘GLEW_OVR_multiview_multisampled_render_to_texture’ was not declared in this scope* ‘GLEW_OVR_multiview’ was not declared in this scope* ‘GLEW_PGI_misc_hints’ was not declared in this scope* ‘GLEW_PGI_vertex_hints’ was not declared in this scope* ‘GLEW_QCOM_alpha_test’ was not declared in this scope* ‘GLEW_QCOM_binning_control’ was not declared in this scope* ‘GLEW_QCOM_driver_control’ was not declared in this scope* ‘GLEW_QCOM_extended_get2’ was not declared in this scope* ‘GLEW_QCOM_extended_get’ was not declared in this scope* ‘GLEW_QCOM_framebuffer_foveated’ was not declared in this scope* ‘GLEW_QCOM_perfmon_global_mode’ was not declared in this scope* ‘GLEW_QCOM_shader_framebuffer_fetch_noncoherent’ was not declared in this scope* ‘GLEW_QCOM_tiled_rendering’ was not declared in this scope* ‘GLEW_QCOM_writeonly_rendering’ was not declared in this scope* ‘GLEW_REGAL_ES1_0_compatibility’ was not declared in this scope* ‘GLEW_REGAL_ES1_1_compatibility’ was not declared in this scope* ‘GLEW_REGAL_enable’ was not declared in this scope* ‘GLEW_REGAL_error_string’ was not declared in this scope* ‘GLEW_REGAL_extension_query’ was not declared in this scope* ‘GLEW_REGAL_log’ was not declared in this scope* ‘GLEW_REGAL_proc_address’ was not declared in this scope* ‘GLEW_REND_screen_coordinates’ was not declared in this scope* ‘GLEW_S3_s3tc’ was not declared in this scope* ‘GLEW_SGIS_clip_band_hint’ was not declared in this scope* ‘GLEW_SGIS_color_range’ was not declared in this scope* ‘GLEW_SGIS_detail_texture’ was not declared in this scope* ‘GLEW_SGIS_fog_function’ was not declared in this scope* ‘GLEW_SGIS_generate_mipmap’ was not declared in this scope* ‘GLEW_SGIS_line_texgen’ was not declared in this scope* ‘GLEW_SGIS_multisample’ was not declared in this scope* ‘GLEW_SGIS_multitexture’ was not declared in this scope* ‘GLEW_SGIS_pixel_texture’ was not declared in this scope* ‘GLEW_SGIS_point_line_texgen’ was not declared in this scope* ‘GLEW_SGIS_shared_multisample’ was not declared in this scope* ‘GLEW_SGIS_sharpen_texture’ was not declared in this scope* ‘GLEW_SGIS_texture4D’ was not declared in this scope* ‘GLEW_SGIS_texture_border_clamp’ was not declared in this scope* ‘GLEW_SGIS_texture_edge_clamp’ was not declared in this scope* ‘GLEW_SGIS_texture_filter4’ was not declared in this scope* ‘GLEW_SGIS_texture_lod’ was not declared in this scope* ‘GLEW_SGIS_texture_select’ was not declared in this scope* ‘GLEW_SGIX_async_histogram’ was not declared in this scope* ‘GLEW_SGIX_async_pixel’ was not declared in this scope* ‘GLEW_SGIX_async’ was not declared in this scope* ‘GLEW_SGIX_bali_g_instruments’ was not declared in this scope* ‘GLEW_SGIX_bali_r_instruments’ was not declared in this scope* ‘GLEW_SGIX_bali_timer_instruments’ was not declared in this scope* ‘GLEW_SGIX_blend_alpha_minmax’ was not declared in this scope* ‘GLEW_SGIX_blend_cadd’ was not declared in this scope* ‘GLEW_SGIX_blend_cmultiply’ was not declared in this scope* ‘GLEW_SGIX_calligraphic_fragment’ was not declared in this scope* ‘GLEW_SGIX_clipmap’ was not declared in this scope* ‘GLEW_SGIX_color_matrix_accuracy’ was not declared in this scope* ‘GLEW_SGIX_color_table_index_mode’ was not declared in this scope* ‘GLEW_SGIX_complex_polar’ was not declared in this scope* ‘GLEW_SGIX_convolution_accuracy’ was not declared in this scope* ‘GLEW_SGIX_cube_map’ was not declared in this scope* ‘GLEW_SGIX_cylinder_texgen’ was not declared in this scope* ‘GLEW_SGIX_datapipe’ was not declared in this scope* ‘GLEW_SGIX_decimation’ was not declared in this scope* ‘GLEW_SGIX_depth_pass_instrument’ was not declared in this scope* ‘GLEW_SGIX_depth_texture’ was not declared in this scope* ‘GLEW_SGIX_dvc’ was not declared in this scope* ‘GLEW_SGIX_flush_raster’ was not declared in this scope* ‘GLEW_SGIX_fog_blend’ was not declared in this scope* ‘GLEW_SGIX_fog_factor_to_alpha’ was not declared in this scope* ‘GLEW_SGIX_fog_layers’ was not declared in this scope* ‘GLEW_SGIX_fog_offset’ was not declared in this scope* ‘GLEW_SGIX_fog_patchy’ was not declared in this scope* ‘GLEW_SGIX_fog_scale’ was not declared in this scope* ‘GLEW_SGIX_fog_texture’ was not declared in this scope* ‘GLEW_SGIX_fragment_lighting_space’ was not declared in this scope* ‘GLEW_SGIX_fragment_specular_lighting’ was not declared in this scope* ‘GLEW_SGIX_fragments_instrument’ was not declared in this scope* ‘GLEW_SGIX_framezoom’ was not declared in this scope* ‘GLEW_SGIX_icc_texture’ was not declared in this scope* ‘GLEW_SGIX_igloo_interface’ was not declared in this scope* ‘GLEW_SGIX_image_compression’ was not declared in this scope* ‘GLEW_SGIX_impact_pixel_texture’ was not declared in this scope* ‘GLEW_SGIX_instrument_error’ was not declared in this scope* ‘GLEW_SGIX_interlace’ was not declared in this scope* ‘GLEW_SGIX_ir_instrument1’ was not declared in this scope* ‘GLEW_SGIX_line_quality_hint’ was not declared in this scope* ‘GLEW_SGIX_list_priority’ was not declared in this scope* ‘GLEW_SGIX_mpeg1’ was not declared in this scope* ‘GLEW_SGIX_mpeg2’ was not declared in this scope* ‘GLEW_SGIX_nonlinear_lighting_pervertex’ was not declared in this scope* ‘GLEW_SGIX_nurbs_eval’ was not declared in this scope* ‘GLEW_SGIX_occlusion_instrument’ was not declared in this scope* ‘GLEW_SGIX_packed_6bytes’ was not declared in this scope* ‘GLEW_SGIX_pixel_texture_bits’ was not declared in this scope* ‘GLEW_SGIX_pixel_texture_lod’ was not declared in this scope* ‘GLEW_SGIX_pixel_texture’ was not declared in this scope* ‘GLEW_SGIX_pixel_tiles’ was not declared in this scope* ‘GLEW_SGIX_polynomial_ffd’ was not declared in this scope* ‘GLEW_SGIX_quad_mesh’ was not declared in this scope* ‘GLEW_SGIX_reference_plane’ was not declared in this scope* ‘GLEW_SGIX_resample’ was not declared in this scope* ‘GLEW_SGIX_scalebias_hint’ was not declared in this scope* ‘GLEW_SGIX_shadow_ambient’ was not declared in this scope* ‘GLEW_SGIX_shadow’ was not declared in this scope* ‘GLEW_SGIX_slim’ was not declared in this scope* ‘GLEW_SGIX_spotlight_cutoff’ was not declared in this scope* ‘GLEW_SGIX_sprite’ was not declared in this scope* ‘GLEW_SGIX_subdiv_patch’ was not declared in this scope* ‘GLEW_SGIX_subsample’ was not declared in this scope* ‘GLEW_SGIX_tag_sample_buffer’ was not declared in this scope* ‘GLEW_SGIX_texture_add_env’ was not declared in this scope* ‘GLEW_SGIX_texture_coordinate_clamp’ was not declared in this scope* ‘GLEW_SGIX_texture_lod_bias’ was not declared in this scope* ‘GLEW_SGIX_texture_mipmap_anisotropic’ was not declared in this scope* ‘GLEW_SGIX_texture_multi_buffer’ was not declared in this scope* ‘GLEW_SGIX_texture_phase’ was not declared in this scope* ‘GLEW_SGIX_texture_range’ was not declared in this scope* ‘GLEW_SGIX_texture_scale_bias’ was not declared in this scope* ‘GLEW_SGIX_texture_supersample’ was not declared in this scope* ‘GLEW_SGIX_vector_ops’ was not declared in this scope* ‘GLEW_SGIX_vertex_array_object’ was not declared in this scope* ‘GLEW_SGIX_vertex_preclip_hint’ was not declared in this scope* ‘GLEW_SGIX_vertex_preclip’ was not declared in this scope* ‘GLEW_SGIX_ycrcb_subsample’ was not declared in this scope* ‘GLEW_SGIX_ycrcba’ was not declared in this scope* ‘GLEW_SGIX_ycrcb’ was not declared in this scope* ‘GLEW_SGI_color_matrix’ was not declared in this scope* ‘GLEW_SGI_color_table’ was not declared in this scope* ‘GLEW_SGI_complex_type’ was not declared in this scope* ‘GLEW_SGI_complex’ was not declared in this scope* ‘GLEW_SGI_fft’ was not declared in this scope* ‘GLEW_SGI_texture_color_table’ was not declared in this scope* ‘GLEW_SUNX_constant_data’ was not declared in this scope* ‘GLEW_SUN_convolution_border_modes’ was not declared in this scope* ‘GLEW_SUN_global_alpha’ was not declared in this scope* ‘GLEW_SUN_mesh_array’ was not declared in this scope* ‘GLEW_SUN_read_video_pixels’ was not declared in this scope* ‘GLEW_SUN_slice_accum’ was not declared in this scope* ‘GLEW_SUN_triangle_list’ was not declared in this scope* ‘GLEW_SUN_vertex’ was not declared in this scope* ‘GLEW_VERSION_1_1’ was not declared in this scope* ‘GLEW_VERSION_1_2_1’ was not declared in this scope* ‘GLEW_VERSION_1_2’ was not declared in this scope* ‘GLEW_VERSION_1_3’ was not declared in this scope* ‘GLEW_VERSION_1_4’ was not declared in this scope* ‘GLEW_VERSION_1_5’ was not declared in this scope* ‘GLEW_VERSION_2_0’ was not declared in this scope* ‘GLEW_VERSION_2_1’ was not declared in this scope* ‘GLEW_VERSION_3_0’ was not declared in this scope* ‘GLEW_VERSION_3_1’ was not declared in this scope* ‘GLEW_VERSION_3_2’ was not declared in this scope* ‘GLEW_VERSION_3_3’ was not declared in this scope* ‘GLEW_VERSION_4_0’ was not declared in this scope* ‘GLEW_VERSION_4_1’ was not declared in this scope* ‘GLEW_VERSION_4_2’ was not declared in this scope* ‘GLEW_VERSION_4_3’ was not declared in this scope* ‘GLEW_VERSION_4_4’ was not declared in this scope* ‘GLEW_VERSION_4_5’ was not declared in this scope* ‘GLEW_VERSION_4_6’ was not declared in this scope* ‘GLEW_VERSION_MAJOR’ was not declared in this scope; did you mean ‘TBB_VERSION_MAJOR’?* ‘GLEW_VERSION_MICRO’ was not declared in this scope; did you mean ‘TBB_VERSION_MINOR’?* ‘GLEW_VERSION_MINOR’ was not declared in this scope; did you mean ‘TBB_VERSION_MINOR’?* ‘GLEW_VERSION’ was not declared in this scope; did you mean ‘PSTL_VERSION’?* ‘GLEW_WIN_phong_shading’ was not declared in this scope* ‘GLEW_WIN_scene_markerXXX’ was not declared in this scope* ‘GLEW_WIN_specular_fog’ was not declared in this scope* ‘GLEW_WIN_swap_hint’ was not declared in this scope
C++ Error Strings (Windows):
* E1696 cannot open source file “pxr/imaging/glf/glew.h”* E0020 identifier “glewIsSupported” is undefined* E0020 identifier “GlfGlewInit” is undefined* C1083 Cannot open include file: ‘pxr/imaging/glf/glew.h’: No such file or directory* C3861 ‘glewIsSupported’: identifier not found* C3861 ‘GlfGlewInit’: identifier not found* E0020 identifier “GLEW_3DFX_multisample” is undefined* E0020 identifier “GLEW_3DFX_tbuffer” is undefined* E0020 identifier “GLEW_3DFX_texture_compression_FXT1” is undefined* E0020 identifier “GLEW_AMD_blend_minmax_factor” is undefined* E0020 identifier “GLEW_AMD_compressed_3DC_texture” is undefined* E0020 identifier “GLEW_AMD_compressed_ATC_texture” is undefined* E0020 identifier “GLEW_AMD_conservative_depth” is undefined* E0020 identifier “GLEW_AMD_debug_output” is undefined* E0020 identifier “GLEW_AMD_depth_clamp_separate” is undefined* E0020 identifier “GLEW_AMD_draw_buffers_blend” is undefined* E0020 identifier “GLEW_AMD_framebuffer_sample_positions” is undefined* E0020 identifier “GLEW_AMD_gcn_shader” is undefined* E0020 identifier “GLEW_AMD_gpu_shader_half_float” is undefined* E0020 identifier “GLEW_AMD_gpu_shader_int16” is undefined* E0020 identifier “GLEW_AMD_gpu_shader_int64” is undefined* E0020 identifier “GLEW_AMD_interleaved_elements” is undefined* E0020 identifier “GLEW_AMD_multi_draw_indirect” is undefined* E0020 identifier “GLEW_AMD_name_gen_delete” is undefined* E0020 identifier “GLEW_AMD_occlusion_query_event” is undefined* E0020 identifier “GLEW_AMD_performance_monitor” is undefined* E0020 identifier “GLEW_AMD_pinned_memory” is undefined* E0020 identifier “GLEW_AMD_program_binary_Z400” is undefined* E0020 identifier “GLEW_AMD_query_buffer_object” is undefined* E0020 identifier “GLEW_AMD_sample_positions” is undefined* E0020 identifier “GLEW_AMD_seamless_cubemap_per_texture” is undefined* E0020 identifier “GLEW_AMD_shader_atomic_counter_ops” is undefined* E0020 identifier “GLEW_AMD_shader_ballot” is undefined* E0020 identifier “GLEW_AMD_shader_explicit_vertex_parameter” is undefined* E0020 identifier “GLEW_AMD_shader_stencil_export” is undefined* E0020 identifier “GLEW_AMD_shader_stencil_value_export” is undefined* E0020 identifier “GLEW_AMD_shader_trinary_minmax” is undefined* E0020 identifier “GLEW_AMD_sparse_texture” is undefined* E0020 identifier “GLEW_AMD_stencil_operation_extended” is undefined* E0020 identifier “GLEW_AMD_texture_gather_bias_lod” is undefined* E0020 identifier “GLEW_AMD_texture_texture4” is undefined* E0020 identifier “GLEW_AMD_transform_feedback3_lines_triangles” is undefined* E0020 identifier “GLEW_AMD_transform_feedback4” is undefined* E0020 identifier “GLEW_AMD_vertex_shader_layer” is undefined* E0020 identifier “GLEW_AMD_vertex_shader_tessellator” is undefined* E0020 identifier “GLEW_AMD_vertex_shader_viewport_index” is undefined* E0020 identifier “GLEW_ANDROID_extension_pack_es31a” is undefined* E0020 identifier “GLEW_ANGLE_depth_texture” is undefined* E0020 identifier “GLEW_ANGLE_framebuffer_blit” is undefined* E0020 identifier “GLEW_ANGLE_framebuffer_multisample” is undefined* E0020 identifier “GLEW_ANGLE_instanced_arrays” is undefined* E0020 identifier “GLEW_ANGLE_pack_reverse_row_order” is undefined* E0020 identifier “GLEW_ANGLE_program_binary” is undefined* E0020 identifier “GLEW_ANGLE_texture_compression_dxt1” is undefined* E0020 identifier “GLEW_ANGLE_texture_compression_dxt3” is undefined* E0020 identifier “GLEW_ANGLE_texture_compression_dxt5” is undefined* E0020 identifier “GLEW_ANGLE_texture_usage” is undefined* E0020 identifier “GLEW_ANGLE_timer_query” is undefined* E0020 identifier “GLEW_ANGLE_translated_shader_source” is undefined* E0020 identifier “GLEW_APPLE_aux_depth_stencil” is undefined* E0020 identifier “GLEW_APPLE_client_storage” is undefined* E0020 identifier “GLEW_APPLE_clip_distance” is undefined* E0020 identifier “GLEW_APPLE_color_buffer_packed_float” is undefined* E0020 identifier “GLEW_APPLE_copy_texture_levels” is undefined* E0020 identifier “GLEW_APPLE_element_array” is undefined* E0020 identifier “GLEW_APPLE_fence” is undefined* E0020 identifier “GLEW_APPLE_float_pixels” is undefined* E0020 identifier “GLEW_APPLE_flush_buffer_range” is undefined* E0020 identifier “GLEW_APPLE_framebuffer_multisample” is undefined* E0020 identifier “GLEW_APPLE_object_purgeable” is undefined* E0020 identifier “GLEW_APPLE_pixel_buffer” is undefined* E0020 identifier “GLEW_APPLE_rgb_422” is undefined* E0020 identifier “GLEW_APPLE_row_bytes” is undefined* E0020 identifier “GLEW_APPLE_specular_vector” is undefined* E0020 identifier “GLEW_APPLE_sync” is undefined* E0020 identifier “GLEW_APPLE_texture_2D_limited_npot” is undefined* E0020 identifier “GLEW_APPLE_texture_format_BGRA8888” is undefined* E0020 identifier “GLEW_APPLE_texture_max_level” is undefined* E0020 identifier “GLEW_APPLE_texture_packed_float” is undefined* E0020 identifier “GLEW_APPLE_texture_range” is undefined* E0020 identifier “GLEW_APPLE_transform_hint” is undefined* E0020 identifier “GLEW_APPLE_vertex_array_object” is undefined* E0020 identifier “GLEW_APPLE_vertex_array_range” is undefined* E0020 identifier “GLEW_APPLE_vertex_program_evaluators” is undefined* E0020 identifier “GLEW_APPLE_ycbcr_422” is undefined* E0020 identifier “GLEW_ARB_arrays_of_arrays” is undefined* E0020 identifier “GLEW_ARB_base_instance” is undefined* E0020 identifier “GLEW_ARB_bindless_texture” is undefined* E0020 identifier “GLEW_ARB_blend_func_extended” is undefined* E0020 identifier “GLEW_ARB_buffer_storage” is undefined* E0020 identifier “GLEW_ARB_cl_event” is undefined* E0020 identifier “GLEW_ARB_clear_buffer_object” is undefined* E0020 identifier “GLEW_ARB_clear_texture” is undefined* E0020 identifier “GLEW_ARB_clip_control” is undefined* E0020 identifier “GLEW_ARB_color_buffer_float” is undefined* E0020 identifier “GLEW_ARB_compatibility” is undefined* E0020 identifier “GLEW_ARB_compressed_texture_pixel_storage” is undefined* E0020 identifier “GLEW_ARB_compute_shader” is undefined* E0020 identifier “GLEW_ARB_compute_variable_group_size” is undefined* E0020 identifier “GLEW_ARB_conditional_render_inverted” is undefined* E0020 identifier “GLEW_ARB_conservative_depth” is undefined* E0020 identifier “GLEW_ARB_copy_buffer” is undefined* E0020 identifier “GLEW_ARB_copy_image” is undefined* E0020 identifier “GLEW_ARB_cull_distance” is undefined* E0020 identifier “GLEW_ARB_debug_output” is undefined* E0020 identifier “GLEW_ARB_depth_buffer_float” is undefined* E0020 identifier “GLEW_ARB_depth_clamp” is undefined* E0020 identifier “GLEW_ARB_depth_texture” is undefined* E0020 identifier “GLEW_ARB_derivative_control” is undefined* E0020 identifier “GLEW_ARB_direct_state_access” is undefined* E0020 identifier “GLEW_ARB_draw_buffers” is undefined* E0020 identifier “GLEW_ARB_draw_buffers_blend” is undefined* E0020 identifier “GLEW_ARB_draw_elements_base_vertex” is undefined* E0020 identifier “GLEW_ARB_draw_indirect” is undefined* E0020 identifier “GLEW_ARB_draw_instanced” is undefined* E0020 identifier “GLEW_ARB_enhanced_layouts” is undefined* E0020 identifier “GLEW_ARB_ES2_compatibility” is undefined* E0020 identifier “GLEW_ARB_ES3_1_compatibility” is undefined* E0020 identifier “GLEW_ARB_ES3_2_compatibility” is undefined* E0020 identifier “GLEW_ARB_ES3_compatibility” is undefined* E0020 identifier “GLEW_ARB_explicit_attrib_location” is undefined* E0020 identifier “GLEW_ARB_explicit_uniform_location” is undefined* E0020 identifier “GLEW_ARB_fragment_coord_conventions” is undefined* E0020 identifier “GLEW_ARB_fragment_layer_viewport” is undefined* E0020 identifier “GLEW_ARB_fragment_program” is undefined* E0020 identifier “GLEW_ARB_fragment_program_shadow” is undefined* E0020 identifier “GLEW_ARB_fragment_shader” is undefined* E0020 identifier “GLEW_ARB_fragment_shader_interlock” is undefined* E0020 identifier “GLEW_ARB_framebuffer_no_attachments” is undefined* E0020 identifier “GLEW_ARB_framebuffer_object” is undefined* E0020 identifier “GLEW_ARB_framebuffer_sRGB” is undefined* E0020 identifier “GLEW_ARB_geometry_shader4” is undefined* E0020 identifier “GLEW_ARB_get_program_binary” is undefined* E0020 identifier “GLEW_ARB_get_texture_sub_image” is undefined* E0020 identifier “GLEW_ARB_gl_spirv” is undefined* E0020 identifier “GLEW_ARB_gpu_shader5” is undefined* E0020 identifier “GLEW_ARB_gpu_shader_fp64” is undefined* E0020 identifier “GLEW_ARB_gpu_shader_int64” is undefined* E0020 identifier “GLEW_ARB_half_float_pixel” is undefined* E0020 identifier “GLEW_ARB_half_float_vertex” is undefined* E0020 identifier “GLEW_ARB_imaging” is undefined* E0020 identifier “GLEW_ARB_indirect_parameters” is undefined* E0020 identifier “GLEW_ARB_instanced_arrays” is undefined* E0020 identifier “GLEW_ARB_internalformat_query2” is undefined* E0020 identifier “GLEW_ARB_internalformat_query” is undefined* E0020 identifier “GLEW_ARB_invalidate_subdata” is undefined* E0020 identifier “GLEW_ARB_map_buffer_alignment” is undefined* E0020 identifier “GLEW_ARB_map_buffer_range” is undefined* E0020 identifier “GLEW_ARB_matrix_palette” is undefined* E0020 identifier “GLEW_ARB_multi_bind” is undefined* E0020 identifier “GLEW_ARB_multi_draw_indirect” is undefined* E0020 identifier “GLEW_ARB_multisample” is undefined* E0020 identifier “GLEW_ARB_multitexture” is undefined* E0020 identifier “GLEW_ARB_occlusion_query2” is undefined* E0020 identifier “GLEW_ARB_occlusion_query” is undefined* E0020 identifier “GLEW_ARB_parallel_shader_compile” is undefined* E0020 identifier “GLEW_ARB_pipeline_statistics_query” is undefined* E0020 identifier “GLEW_ARB_pixel_buffer_object” is undefined* E0020 identifier “GLEW_ARB_point_parameters” is undefined* E0020 identifier “GLEW_ARB_point_sprite” is undefined* E0020 identifier “GLEW_ARB_polygon_offset_clamp” is undefined* E0020 identifier “GLEW_ARB_post_depth_coverage” is undefined* E0020 identifier “GLEW_ARB_program_interface_query” is undefined* E0020 identifier “GLEW_ARB_provoking_vertex” is undefined* E0020 identifier “GLEW_ARB_query_buffer_object” is undefined* E0020 identifier “GLEW_ARB_robust_buffer_access_behavior” is undefined* E0020 identifier “GLEW_ARB_robustness” is undefined* E0020 identifier “GLEW_ARB_robustness_application_isolation” is undefined* E0020 identifier “GLEW_ARB_robustness_share_group_isolation” is undefined* E0020 identifier “GLEW_ARB_sample_locations” is undefined* E0020 identifier “GLEW_ARB_sample_shading” is undefined* E0020 identifier “GLEW_ARB_sampler_objects” is undefined* E0020 identifier “GLEW_ARB_seamless_cube_map” is undefined* E0020 identifier “GLEW_ARB_seamless_cubemap_per_texture” is undefined* E0020 identifier “GLEW_ARB_separate_shader_objects” is undefined* E0020 identifier “GLEW_ARB_shader_atomic_counter_ops” is undefined* E0020 identifier “GLEW_ARB_shader_atomic_counters” is undefined* E0020 identifier “GLEW_ARB_shader_ballot” is undefined* E0020 identifier “GLEW_ARB_shader_bit_encoding” is undefined* E0020 identifier “GLEW_ARB_shader_clock” is undefined* E0020 identifier “GLEW_ARB_shader_draw_parameters” is undefined* E0020 identifier “GLEW_ARB_shader_group_vote” is undefined* E0020 identifier “GLEW_ARB_shader_image_load_store” is undefined* E0020 identifier “GLEW_ARB_shader_image_size” is undefined* E0020 identifier “GLEW_ARB_shader_objects” is undefined* E0020 identifier “GLEW_ARB_shader_precision” is undefined* E0020 identifier “GLEW_ARB_shader_stencil_export” is undefined* E0020 identifier “GLEW_ARB_shader_storage_buffer_object” is undefined* E0020 identifier “GLEW_ARB_shader_subroutine” is undefined* E0020 identifier “GLEW_ARB_shader_texture_image_samples” is undefined* E0020 identifier “GLEW_ARB_shader_texture_lod” is undefined* E0020 identifier “GLEW_ARB_shader_viewport_layer_array” is undefined* E0020 identifier “GLEW_ARB_shading_language_100” is undefined* E0020 identifier “GLEW_ARB_shading_language_420pack” is undefined* E0020 identifier “GLEW_ARB_shading_language_include” is undefined* E0020 identifier “GLEW_ARB_shading_language_packing” is undefined* E0020 identifier “GLEW_ARB_shadow” is undefined* E0020 identifier “GLEW_ARB_shadow_ambient” is undefined* E0020 identifier “GLEW_ARB_sparse_buffer” is undefined* E0020 identifier “GLEW_ARB_sparse_texture2” is undefined* E0020 identifier “GLEW_ARB_sparse_texture” is undefined* E0020 identifier “GLEW_ARB_sparse_texture_clamp” is undefined* E0020 identifier “GLEW_ARB_spirv_extensions” is undefined* E0020 identifier “GLEW_ARB_stencil_texturing” is undefined* E0020 identifier “GLEW_ARB_sync” is undefined* E0020 identifier “GLEW_ARB_tessellation_shader” is undefined* E0020 identifier “GLEW_ARB_texture_barrier” is undefined* E0020 identifier “GLEW_ARB_texture_border_clamp” is undefined* E0020 identifier “GLEW_ARB_texture_buffer_object” is undefined* E0020 identifier “GLEW_ARB_texture_buffer_object_rgb32” is undefined* E0020 identifier “GLEW_ARB_texture_buffer_range” is undefined* E0020 identifier “GLEW_ARB_texture_compression” is undefined* E0020 identifier “GLEW_ARB_texture_compression_bptc” is undefined* E0020 identifier “GLEW_ARB_texture_compression_rgtc” is undefined* E0020 identifier “GLEW_ARB_texture_cube_map” is undefined* E0020 identifier “GLEW_ARB_texture_cube_map_array” is undefined* E0020 identifier “GLEW_ARB_texture_env_add” is undefined* E0020 identifier “GLEW_ARB_texture_env_combine” is undefined* E0020 identifier “GLEW_ARB_texture_env_crossbar” is undefined* E0020 identifier “GLEW_ARB_texture_env_dot3” is undefined* E0020 identifier “GLEW_ARB_texture_filter_anisotropic” is undefined* E0020 identifier “GLEW_ARB_texture_filter_minmax” is undefined* E0020 identifier “GLEW_ARB_texture_float” is undefined* E0020 identifier “GLEW_ARB_texture_gather” is undefined* E0020 identifier “GLEW_ARB_texture_mirror_clamp_to_edge” is undefined* E0020 identifier “GLEW_ARB_texture_mirrored_repeat” is undefined* E0020 identifier “GLEW_ARB_texture_multisample” is undefined* E0020 identifier “GLEW_ARB_texture_non_power_of_two” is undefined* E0020 identifier “GLEW_ARB_texture_query_levels” is undefined* E0020 identifier “GLEW_ARB_texture_query_lod” is undefined* E0020 identifier “GLEW_ARB_texture_rectangle” is undefined* E0020 identifier “GLEW_ARB_texture_rg” is undefined* E0020 identifier “GLEW_ARB_texture_rgb10_a2ui” is undefined* E0020 identifier “GLEW_ARB_texture_stencil8” is undefined* E0020 identifier “GLEW_ARB_texture_storage” is undefined* E0020 identifier “GLEW_ARB_texture_storage_multisample” is undefined* E0020 identifier “GLEW_ARB_texture_swizzle” is undefined* E0020 identifier “GLEW_ARB_texture_view” is undefined* E0020 identifier “GLEW_ARB_timer_query” is undefined* E0020 identifier “GLEW_ARB_transform_feedback2” is undefined* E0020 identifier “GLEW_ARB_transform_feedback3” is undefined* E0020 identifier “GLEW_ARB_transform_feedback_instanced” is undefined* E0020 identifier “GLEW_ARB_transform_feedback_overflow_query” is undefined* E0020 identifier “GLEW_ARB_transpose_matrix” is undefined* E0020 identifier “GLEW_ARB_uniform_buffer_object” is undefined* E0020 identifier “GLEW_ARB_vertex_array_bgra” is undefined* E0020 identifier “GLEW_ARB_vertex_array_object” is undefined* E0020 identifier “GLEW_ARB_vertex_attrib_64bit” is undefined* E0020 identifier “GLEW_ARB_vertex_attrib_binding” is undefined* E0020 identifier “GLEW_ARB_vertex_blend” is undefined* E0020 identifier “GLEW_ARB_vertex_buffer_object” is undefined* E0020 identifier “GLEW_ARB_vertex_program” is undefined* E0020 identifier “GLEW_ARB_vertex_shader” is undefined* E0020 identifier “GLEW_ARB_vertex_type_2_10_10_10_rev” is undefined* E0020 identifier “GLEW_ARB_vertex_type_10f_11f_11f_rev” is undefined* E0020 identifier “GLEW_ARB_viewport_array” is undefined* E0020 identifier “GLEW_ARB_window_pos” is undefined* E0020 identifier “GLEW_ARM_mali_program_binary” is undefined* E0020 identifier “GLEW_ARM_mali_shader_binary” is undefined* E0020 identifier “GLEW_ARM_rgba8” is undefined* E0020 identifier “GLEW_ARM_shader_framebuffer_fetch” is undefined* E0020 identifier “GLEW_ARM_shader_framebuffer_fetch_depth_stencil” is undefined* E0020 identifier “GLEW_ATI_draw_buffers” is undefined* E0020 identifier “GLEW_ATI_element_array” is undefined* E0020 identifier “GLEW_ATI_envmap_bumpmap” is undefined* E0020 identifier “GLEW_ATI_fragment_shader” is undefined* E0020 identifier “GLEW_ATI_map_object_buffer” is undefined* E0020 identifier “GLEW_ATI_meminfo” is undefined* E0020 identifier “GLEW_ATI_pn_triangles” is undefined* E0020 identifier “GLEW_ATI_separate_stencil” is undefined* E0020 identifier “GLEW_ATI_shader_texture_lod” is undefined* E0020 identifier “GLEW_ATI_text_fragment_shader” is undefined* E0020 identifier “GLEW_ATI_texture_compression_3dc” is undefined* E0020 identifier “GLEW_ATI_texture_env_combine3” is undefined* E0020 identifier “GLEW_ATI_texture_float” is undefined* E0020 identifier “GLEW_ATI_texture_mirror_once” is undefined* E0020 identifier “GLEW_ATI_vertex_array_object” is undefined* E0020 identifier “GLEW_ATI_vertex_attrib_array_object” is undefined* E0020 identifier “GLEW_ATI_vertex_streams” is undefined* E0020 identifier “GLEW_ATIX_point_sprites” is undefined* E0020 identifier “GLEW_ATIX_texture_env_combine3” is undefined* E0020 identifier “GLEW_ATIX_texture_env_route” is undefined* E0020 identifier “GLEW_ATIX_vertex_shader_output_point_size” is undefined* E0020 identifier “GLEW_EGL_KHR_context_flush_control” is undefined* E0020 identifier “GLEW_EGL_NV_robustness_video_memory_purge” is undefined* E0020 identifier “GLEW_ERROR_GL_VERSION_10_ONLY” is undefined* E0020 identifier “GLEW_ERROR_GLX_VERSION_11_ONLY” is undefined* E0020 identifier “GLEW_ERROR_NO_GL_VERSION” is undefined* E0020 identifier “GLEW_ERROR_NO_GLX_DISPLAY” is undefined* E0020 identifier “GLEW_EXT_422_pixels” is undefined* E0020 identifier “GLEW_EXT_abgr” is undefined* E0020 identifier “GLEW_EXT_base_instance” is undefined* E0020 identifier “GLEW_EXT_bgra” is undefined* E0020 identifier “GLEW_EXT_bindable_uniform” is undefined* E0020 identifier “GLEW_EXT_blend_color” is undefined* E0020 identifier “GLEW_EXT_blend_equation_separate” is undefined* E0020 identifier “GLEW_EXT_blend_func_extended” is undefined* E0020 identifier “GLEW_EXT_blend_func_separate” is undefined* E0020 identifier “GLEW_EXT_blend_logic_op” is undefined* E0020 identifier “GLEW_EXT_blend_minmax” is undefined* E0020 identifier “GLEW_EXT_blend_subtract” is undefined* E0020 identifier “GLEW_EXT_buffer_storage” is undefined* E0020 identifier “GLEW_EXT_Cg_shader” is undefined* E0020 identifier “GLEW_EXT_clear_texture” is undefined* E0020 identifier “GLEW_EXT_clip_cull_distance” is undefined* E0020 identifier “GLEW_EXT_clip_volume_hint” is undefined* E0020 identifier “GLEW_EXT_cmyka” is undefined* E0020 identifier “GLEW_EXT_color_buffer_float” is undefined* E0020 identifier “GLEW_EXT_color_buffer_half_float” is undefined* E0020 identifier “GLEW_EXT_color_subtable” is undefined* E0020 identifier “GLEW_EXT_compiled_vertex_array” is undefined* E0020 identifier “GLEW_EXT_compressed_ETC1_RGB8_sub_texture” is undefined* E0020 identifier “GLEW_EXT_conservative_depth” is undefined* E0020 identifier “GLEW_EXT_convolution” is undefined* E0020 identifier “GLEW_EXT_coordinate_frame” is undefined* E0020 identifier “GLEW_EXT_copy_image” is undefined* E0020 identifier “GLEW_EXT_copy_texture” is undefined* E0020 identifier “GLEW_EXT_cull_vertex” is undefined* E0020 identifier “GLEW_EXT_debug_label” is undefined* E0020 identifier “GLEW_EXT_debug_marker” is undefined* E0020 identifier “GLEW_EXT_depth_bounds_test” is undefined* E0020 identifier “GLEW_EXT_direct_state_access” is undefined* E0020 identifier “GLEW_EXT_discard_framebuffer” is undefined* E0020 identifier “GLEW_EXT_draw_buffers2” is undefined* E0020 identifier “GLEW_EXT_draw_buffers” is undefined* E0020 identifier “GLEW_EXT_draw_buffers_indexed” is undefined* E0020 identifier “GLEW_EXT_draw_elements_base_vertex” is undefined* E0020 identifier “GLEW_EXT_draw_instanced” is undefined* E0020 identifier “GLEW_EXT_draw_range_elements” is undefined* E0020 identifier “GLEW_EXT_EGL_image_array” is undefined* E0020 identifier “GLEW_EXT_external_buffer” is undefined* E0020 identifier “GLEW_EXT_float_blend” is undefined* E0020 identifier “GLEW_EXT_fog_coord” is undefined* E0020 identifier “GLEW_EXT_frag_depth” is undefined* E0020 identifier “GLEW_EXT_fragment_lighting” is undefined* E0020 identifier “GLEW_EXT_framebuffer_blit” is undefined* E0020 identifier “GLEW_EXT_framebuffer_multisample” is undefined* E0020 identifier “GLEW_EXT_framebuffer_multisample_blit_scaled” is undefined* E0020 identifier “GLEW_EXT_framebuffer_object” is undefined* E0020 identifier “GLEW_EXT_framebuffer_sRGB” is undefined* E0020 identifier “GLEW_EXT_geometry_point_size” is undefined* E0020 identifier “GLEW_EXT_geometry_shader4” is undefined* E0020 identifier “GLEW_EXT_geometry_shader” is undefined* E0020 identifier “GLEW_EXT_gpu_program_parameters” is undefined* E0020 identifier “GLEW_EXT_gpu_shader4” is undefined* E0020 identifier “GLEW_EXT_gpu_shader5” is undefined* E0020 identifier “GLEW_EXT_histogram” is undefined* E0020 identifier “GLEW_EXT_index_array_formats” is undefined* E0020 identifier “GLEW_EXT_index_func” is undefined* E0020 identifier “GLEW_EXT_index_material” is undefined* E0020 identifier “GLEW_EXT_index_texture” is undefined* E0020 identifier “GLEW_EXT_instanced_arrays” is undefined* E0020 identifier “GLEW_EXT_light_texture” is undefined* E0020 identifier “GLEW_EXT_map_buffer_range” is undefined* E0020 identifier “GLEW_EXT_memory_object” is undefined* E0020 identifier “GLEW_EXT_memory_object_fd” is undefined* E0020 identifier “GLEW_EXT_memory_object_win32” is undefined* E0020 identifier “GLEW_EXT_misc_attribute” is undefined* E0020 identifier “GLEW_EXT_multi_draw_arrays” is undefined* E0020 identifier “GLEW_EXT_multi_draw_indirect” is undefined* E0020 identifier “GLEW_EXT_multiple_textures” is undefined* E0020 identifier “GLEW_EXT_multisample” is undefined* E0020 identifier “GLEW_EXT_multisample_compatibility” is undefined* E0020 identifier “GLEW_EXT_multisampled_render_to_texture2” is undefined* E0020 identifier “GLEW_EXT_multisampled_render_to_texture” is undefined* E0020 identifier “GLEW_EXT_multiview_draw_buffers” is undefined* E0020 identifier “GLEW_EXT_packed_depth_stencil” is undefined* E0020 identifier “GLEW_EXT_packed_float” is undefined* E0020 identifier “GLEW_EXT_packed_pixels” is undefined* E0020 identifier “GLEW_EXT_paletted_texture” is undefined* E0020 identifier “GLEW_EXT_pixel_buffer_object” is undefined* E0020 identifier “GLEW_EXT_pixel_transform” is undefined* E0020 identifier “GLEW_EXT_pixel_transform_color_table” is undefined* E0020 identifier “GLEW_EXT_point_parameters” is undefined* E0020 identifier “GLEW_EXT_polygon_offset” is undefined* E0020 identifier “GLEW_EXT_polygon_offset_clamp” is undefined* E0020 identifier “GLEW_EXT_post_depth_coverage” is undefined* E0020 identifier “GLEW_EXT_provoking_vertex” is undefined* E0020 identifier “GLEW_EXT_pvrtc_sRGB” is undefined* E0020 identifier “GLEW_EXT_raster_multisample” is undefined* E0020 identifier “GLEW_EXT_read_format_bgra” is undefined* E0020 identifier “GLEW_EXT_render_snorm” is undefined* E0020 identifier “GLEW_EXT_rescale_normal” is undefined* E0020 identifier “GLEW_EXT_scene_marker” is undefined* E0020 identifier “GLEW_EXT_secondary_color” is undefined* E0020 identifier “GLEW_EXT_semaphore” is undefined* E0020 identifier “GLEW_EXT_semaphore_fd” is undefined* E0020 identifier “GLEW_EXT_semaphore_win32” is undefined* E0020 identifier “GLEW_EXT_separate_shader_objects” is undefined* E0020 identifier “GLEW_EXT_separate_specular_color” is undefined* E0020 identifier “GLEW_EXT_shader_framebuffer_fetch” is undefined* E0020 identifier “GLEW_EXT_shader_group_vote” is undefined* E0020 identifier “GLEW_EXT_shader_image_load_formatted” is undefined* E0020 identifier “GLEW_EXT_shader_image_load_store” is undefined* E0020 identifier “GLEW_EXT_shader_implicit_conversions” is undefined* E0020 identifier “GLEW_EXT_shader_integer_mix” is undefined* E0020 identifier “GLEW_EXT_shader_io_blocks” is undefined* E0020 identifier “GLEW_EXT_shader_non_constant_global_initializers” is undefined* E0020 identifier “GLEW_EXT_shader_pixel_local_storage2” is undefined* E0020 identifier “GLEW_EXT_shader_pixel_local_storage” is undefined* E0020 identifier “GLEW_EXT_shader_texture_lod” is undefined* E0020 identifier “GLEW_EXT_shadow_funcs” is undefined* E0020 identifier “GLEW_EXT_shadow_samplers” is undefined* E0020 identifier “GLEW_EXT_shared_texture_palette” is undefined* E0020 identifier “GLEW_EXT_sparse_texture2” is undefined* E0020 identifier “GLEW_EXT_sparse_texture” is undefined* E0020 identifier “GLEW_EXT_sRGB” is undefined* E0020 identifier “GLEW_EXT_sRGB_write_control” is undefined* E0020 identifier “GLEW_EXT_stencil_clear_tag” is undefined* E0020 identifier “GLEW_EXT_stencil_two_side” is undefined* E0020 identifier “GLEW_EXT_stencil_wrap” is undefined* E0020 identifier “GLEW_EXT_subtexture” is undefined* E0020 identifier “GLEW_EXT_texture3D” is undefined* E0020 identifier “GLEW_EXT_texture” is undefined* E0020 identifier “GLEW_EXT_texture_array” is undefined* E0020 identifier “GLEW_EXT_texture_buffer_object” is undefined* E0020 identifier “GLEW_EXT_texture_compression_astc_decode_mode” is undefined* E0020 identifier “GLEW_EXT_texture_compression_astc_decode_mode_rgb9e5” is undefined* E0020 identifier “GLEW_EXT_texture_compression_bptc” is undefined* E0020 identifier “GLEW_EXT_texture_compression_dxt1” is undefined* E0020 identifier “GLEW_EXT_texture_compression_latc” is undefined* E0020 identifier “GLEW_EXT_texture_compression_rgtc” is undefined* E0020 identifier “GLEW_EXT_texture_compression_s3tc” is undefined* E0020 identifier “GLEW_EXT_texture_cube_map” is undefined* E0020 identifier “GLEW_EXT_texture_cube_map_array” is undefined* E0020 identifier “GLEW_EXT_texture_edge_clamp” is undefined* E0020 identifier “GLEW_EXT_texture_env” is undefined* E0020 identifier “GLEW_EXT_texture_env_add” is undefined* E0020 identifier “GLEW_EXT_texture_env_combine” is undefined* E0020 identifier “GLEW_EXT_texture_env_dot3” is undefined* E0020 identifier “GLEW_EXT_texture_filter_anisotropic” is undefined* E0020 identifier “GLEW_EXT_texture_filter_minmax” is undefined* E0020 identifier “GLEW_EXT_texture_format_BGRA8888” is undefined* E0020 identifier “GLEW_EXT_texture_integer” is undefined* E0020 identifier “GLEW_EXT_texture_lod_bias” is undefined* E0020 identifier “GLEW_EXT_texture_mirror_clamp” is undefined* E0020 identifier “GLEW_EXT_texture_norm16” is undefined* E0020 identifier “GLEW_EXT_texture_object” is undefined* E0020 identifier “GLEW_EXT_texture_perturb_normal” is undefined* E0020 identifier “GLEW_EXT_texture_rectangle” is undefined* E0020 identifier “GLEW_EXT_texture_rg” is undefined* E0020 identifier “GLEW_EXT_texture_shared_exponent” is undefined* E0020 identifier “GLEW_EXT_texture_snorm” is undefined* E0020 identifier “GLEW_EXT_texture_sRGB” is undefined* E0020 identifier “GLEW_EXT_texture_sRGB_decode” is undefined* E0020 identifier “GLEW_EXT_texture_sRGB_R8” is undefined* E0020 identifier “GLEW_EXT_texture_sRGB_RG8” is undefined* E0020 identifier “GLEW_EXT_texture_storage” is undefined* E0020 identifier “GLEW_EXT_texture_swizzle” is undefined* E0020 identifier “GLEW_EXT_texture_type_2_10_10_10_REV” is undefined* E0020 identifier “GLEW_EXT_texture_view” is undefined* E0020 identifier “GLEW_EXT_timer_query” is undefined* E0020 identifier “GLEW_EXT_transform_feedback” is undefined* E0020 identifier “GLEW_EXT_unpack_subimage” is undefined* E0020 identifier “GLEW_EXT_vertex_array” is undefined* E0020 identifier “GLEW_EXT_vertex_array_bgra” is undefined* E0020 identifier “GLEW_EXT_vertex_array_setXXX” is undefined* E0020 identifier “GLEW_EXT_vertex_attrib_64bit” is undefined* E0020 identifier “GLEW_EXT_vertex_shader” is undefined* E0020 identifier “GLEW_EXT_vertex_weighting” is undefined* E0020 identifier “GLEW_EXT_win32_keyed_mutex” is undefined* E0020 identifier “GLEW_EXT_window_rectangles” is undefined* E0020 identifier “GLEW_EXT_x11_sync_object” is undefined* E0020 identifier “GLEW_EXT_YUV_target” is undefined* E0020 identifier “GLEW_GET_FUN” is undefined* E0020 identifier “GLEW_GET_VAR” is undefined* E0020 identifier “GLEW_GREMEDY_frame_terminator” is undefined* E0020 identifier “GLEW_GREMEDY_string_marker” is undefined* E0020 identifier “GLEW_HP_convolution_border_modes” is undefined* E0020 identifier “GLEW_HP_image_transform” is undefined* E0020 identifier “GLEW_HP_occlusion_test” is undefined* E0020 identifier “GLEW_HP_texture_lighting” is undefined* E0020 identifier “GLEW_IBM_cull_vertex” is undefined* E0020 identifier “GLEW_IBM_multimode_draw_arrays” is undefined* E0020 identifier “GLEW_IBM_rasterpos_clip” is undefined* E0020 identifier “GLEW_IBM_static_data” is undefined* E0020 identifier “GLEW_IBM_texture_mirrored_repeat” is undefined* E0020 identifier “GLEW_IBM_vertex_array_lists” is undefined* E0020 identifier “GLEW_INGR_color_clamp” is undefined* E0020 identifier “GLEW_INGR_interlace_read” is undefined* E0020 identifier “GLEW_INTEL_conservative_rasterization” is undefined* E0020 identifier “GLEW_INTEL_fragment_shader_ordering” is undefined* E0020 identifier “GLEW_INTEL_framebuffer_CMAA” is undefined* E0020 identifier “GLEW_INTEL_map_texture” is undefined* E0020 identifier “GLEW_INTEL_parallel_arrays” is undefined* E0020 identifier “GLEW_INTEL_performance_query” is undefined* E0020 identifier “GLEW_INTEL_texture_scissor” is undefined* E0020 identifier “GLEW_KHR_blend_equation_advanced” is undefined* E0020 identifier “GLEW_KHR_blend_equation_advanced_coherent” is undefined* E0020 identifier “GLEW_KHR_context_flush_control” is undefined* E0020 identifier “GLEW_KHR_debug” is undefined* E0020 identifier “GLEW_KHR_no_error” is undefined* E0020 identifier “GLEW_KHR_parallel_shader_compile” is undefined* E0020 identifier “GLEW_KHR_robust_buffer_access_behavior” is undefined* E0020 identifier “GLEW_KHR_robustness” is undefined* E0020 identifier “GLEW_KHR_texture_compression_astc_hdr” is undefined* E0020 identifier “GLEW_KHR_texture_compression_astc_ldr” is undefined* E0020 identifier “GLEW_KHR_texture_compression_astc_sliced_3d” is undefined* E0020 identifier “GLEW_KTX_buffer_region” is undefined* E0020 identifier “GLEW_MESA_pack_invert” is undefined* E0020 identifier “GLEW_MESA_resize_buffers” is undefined* E0020 identifier “GLEW_MESA_shader_integer_functions” is undefined* E0020 identifier “GLEW_MESA_window_pos” is undefined* E0020 identifier “GLEW_MESA_ycbcr_texture” is undefined* E0020 identifier “GLEW_MESAX_texture_stack” is undefined* E0020 identifier “GLEW_NO_ERROR” is undefined* E0020 identifier “GLEW_NV_3dvision_settings” is undefined* E0020 identifier “GLEW_NV_alpha_to_coverage_dither_control” is undefined* E0020 identifier “GLEW_NV_bgr” is undefined* E0020 identifier “GLEW_NV_bindless_multi_draw_indirect” is undefined* E0020 identifier “GLEW_NV_bindless_multi_draw_indirect_count” is undefined* E0020 identifier “GLEW_NV_bindless_texture” is undefined* E0020 identifier “GLEW_NV_blend_equation_advanced” is undefined* E0020 identifier “GLEW_NV_blend_equation_advanced_coherent” is undefined* E0020 identifier “GLEW_NV_blend_minmax_factor” is undefined* E0020 identifier “GLEW_NV_blend_square” is undefined* E0020 identifier “GLEW_NV_clip_space_w_scaling” is undefined* E0020 identifier “GLEW_NV_command_list” is undefined* E0020 identifier “GLEW_NV_compute_program5” is undefined* E0020 identifier “GLEW_NV_conditional_render” is undefined* E0020 identifier “GLEW_NV_conservative_raster” is undefined* E0020 identifier “GLEW_NV_conservative_raster_dilate” is undefined* E0020 identifier “GLEW_NV_conservative_raster_pre_snap_triangles” is undefined* E0020 identifier “GLEW_NV_copy_buffer” is undefined* E0020 identifier “GLEW_NV_copy_depth_to_color” is undefined* E0020 identifier “GLEW_NV_copy_image” is undefined* E0020 identifier “GLEW_NV_deep_texture3D” is undefined* E0020 identifier “GLEW_NV_depth_buffer_float” is undefined* E0020 identifier “GLEW_NV_depth_clamp” is undefined* E0020 identifier “GLEW_NV_depth_range_unclamped” is undefined* E0020 identifier “GLEW_NV_draw_buffers” is undefined* E0020 identifier “GLEW_NV_draw_instanced” is undefined* E0020 identifier “GLEW_NV_draw_texture” is undefined* E0020 identifier “GLEW_NV_draw_vulkan_image” is undefined* E0020 identifier “GLEW_NV_EGL_stream_consumer_external” is undefined* E0020 identifier “GLEW_NV_evaluators” is undefined* E0020 identifier “GLEW_NV_explicit_attrib_location” is undefined* E0020 identifier “GLEW_NV_explicit_multisample” is undefined* E0020 identifier “GLEW_NV_fbo_color_attachments” is undefined* E0020 identifier “GLEW_NV_fence” is undefined* E0020 identifier “GLEW_NV_fill_rectangle” is undefined* E0020 identifier “GLEW_NV_float_buffer” is undefined* E0020 identifier “GLEW_NV_fog_distance” is undefined* E0020 identifier “GLEW_NV_fragment_coverage_to_color” is undefined* E0020 identifier “GLEW_NV_fragment_program2” is undefined* E0020 identifier “GLEW_NV_fragment_program4” is undefined* E0020 identifier “GLEW_NV_fragment_program” is undefined* E0020 identifier “GLEW_NV_fragment_program_option” is undefined* E0020 identifier “GLEW_NV_fragment_shader_interlock” is undefined* E0020 identifier “GLEW_NV_framebuffer_blit” is undefined* E0020 identifier “GLEW_NV_framebuffer_mixed_samples” is undefined* E0020 identifier “GLEW_NV_framebuffer_multisample” is undefined* E0020 identifier “GLEW_NV_framebuffer_multisample_coverage” is undefined* E0020 identifier “GLEW_NV_generate_mipmap_sRGB” is undefined* E0020 identifier “GLEW_NV_geometry_program4” is undefined* E0020 identifier “GLEW_NV_geometry_shader4” is undefined* E0020 identifier “GLEW_NV_geometry_shader_passthrough” is undefined* E0020 identifier “GLEW_NV_gpu_multicast” is undefined* E0020 identifier “GLEW_NV_gpu_program4” is undefined* E0020 identifier “GLEW_NV_gpu_program5” is undefined* E0020 identifier “GLEW_NV_gpu_program5_mem_extended” is undefined* E0020 identifier “GLEW_NV_gpu_program_fp64” is undefined* E0020 identifier “GLEW_NV_gpu_shader5” is undefined* E0020 identifier “GLEW_NV_half_float” is undefined* E0020 identifier “GLEW_NV_image_formats” is undefined* E0020 identifier “GLEW_NV_instanced_arrays” is undefined* E0020 identifier “GLEW_NV_internalformat_sample_query” is undefined* E0020 identifier “GLEW_NV_light_max_exponent” is undefined* E0020 identifier “GLEW_NV_multisample_coverage” is undefined* E0020 identifier “GLEW_NV_multisample_filter_hint” is undefined* E0020 identifier “GLEW_NV_non_square_matrices” is undefined* E0020 identifier “GLEW_NV_occlusion_query” is undefined* E0020 identifier “GLEW_NV_pack_subimage” is undefined* E0020 identifier “GLEW_NV_packed_depth_stencil” is undefined* E0020 identifier “GLEW_NV_packed_float” is undefined* E0020 identifier “GLEW_NV_packed_float_linear” is undefined* E0020 identifier “GLEW_NV_parameter_buffer_object2” is undefined* E0020 identifier “GLEW_NV_parameter_buffer_object” is undefined* E0020 identifier “GLEW_NV_path_rendering” is undefined* E0020 identifier “GLEW_NV_path_rendering_shared_edge” is undefined* E0020 identifier “GLEW_NV_pixel_buffer_object” is undefined* E0020 identifier “GLEW_NV_pixel_data_range” is undefined* E0020 identifier “GLEW_NV_platform_binary” is undefined* E0020 identifier “GLEW_NV_point_sprite” is undefined* E0020 identifier “GLEW_NV_polygon_mode” is undefined* E0020 identifier “GLEW_NV_present_video” is undefined* E0020 identifier “GLEW_NV_primitive_restart” is undefined* E0020 identifier “GLEW_NV_read_depth” is undefined* E0020 identifier “GLEW_NV_read_depth_stencil” is undefined* E0020 identifier “GLEW_NV_read_stencil” is undefined* E0020 identifier “GLEW_NV_register_combiners2” is undefined* E0020 identifier “GLEW_NV_register_combiners” is undefined* E0020 identifier “GLEW_NV_robustness_video_memory_purge” is undefined* E0020 identifier “GLEW_NV_sample_locations” is undefined* E0020 identifier “GLEW_NV_sample_mask_override_coverage” is undefined* E0020 identifier “GLEW_NV_shader_atomic_counters” is undefined* E0020 identifier “GLEW_NV_shader_atomic_float64” is undefined* E0020 identifier “GLEW_NV_shader_atomic_float” is undefined* E0020 identifier “GLEW_NV_shader_atomic_fp16_vector” is undefined* E0020 identifier “GLEW_NV_shader_atomic_int64” is undefined* E0020 identifier “GLEW_NV_shader_buffer_load” is undefined* E0020 identifier “GLEW_NV_shader_noperspective_interpolation” is undefined* E0020 identifier “GLEW_NV_shader_storage_buffer_object” is undefined* E0020 identifier “GLEW_NV_shader_thread_group” is undefined* E0020 identifier “GLEW_NV_shader_thread_shuffle” is undefined* E0020 identifier “GLEW_NV_shadow_samplers_array” is undefined* E0020 identifier “GLEW_NV_shadow_samplers_cube” is undefined* E0020 identifier “GLEW_NV_sRGB_formats” is undefined* E0020 identifier “GLEW_NV_stereo_view_rendering” is undefined* E0020 identifier “GLEW_NV_tessellation_program5” is undefined* E0020 identifier “GLEW_NV_texgen_emboss” is undefined* E0020 identifier “GLEW_NV_texgen_reflection” is undefined* E0020 identifier “GLEW_NV_texture_array” is undefined* E0020 identifier “GLEW_NV_texture_barrier” is undefined* E0020 identifier “GLEW_NV_texture_border_clamp” is undefined* E0020 identifier “GLEW_NV_texture_compression_latc” is undefined* E0020 identifier “GLEW_NV_texture_compression_s3tc” is undefined* E0020 identifier “GLEW_NV_texture_compression_s3tc_update” is undefined* E0020 identifier “GLEW_NV_texture_compression_vtc” is undefined* E0020 identifier “GLEW_NV_texture_env_combine4” is undefined* E0020 identifier “GLEW_NV_texture_expand_normal” is undefined* E0020 identifier “GLEW_NV_texture_multisample” is undefined* E0020 identifier “GLEW_NV_texture_npot_2D_mipmap” is undefined* E0020 identifier “GLEW_NV_texture_rectangle” is undefined* E0020 identifier “GLEW_NV_texture_rectangle_compressed” is undefined* E0020 identifier “GLEW_NV_texture_shader2” is undefined* E0020 identifier “GLEW_NV_texture_shader3” is undefined* E0020 identifier “GLEW_NV_texture_shader” is undefined* E0020 identifier “GLEW_NV_transform_feedback2” is undefined* E0020 identifier “GLEW_NV_transform_feedback” is undefined* E0020 identifier “GLEW_NV_uniform_buffer_unified_memory” is undefined* E0020 identifier “GLEW_NV_vdpau_interop” is undefined* E0020 identifier “GLEW_NV_vertex_array_range2” is undefined* E0020 identifier “GLEW_NV_vertex_array_range” is undefined* E0020 identifier “GLEW_NV_vertex_attrib_integer_64bit” is undefined* E0020 identifier “GLEW_NV_vertex_buffer_unified_memory” is undefined* E0020 identifier “GLEW_NV_vertex_program1_1” is undefined* E0020 identifier “GLEW_NV_vertex_program2” is undefined* E0020 identifier “GLEW_NV_vertex_program2_option” is undefined* E0020 identifier “GLEW_NV_vertex_program3” is undefined* E0020 identifier “GLEW_NV_vertex_program4” is undefined* E0020 identifier “GLEW_NV_vertex_program” is undefined* E0020 identifier “GLEW_NV_video_capture” is undefined* E0020 identifier “GLEW_NV_viewport_array2” is undefined* E0020 identifier “GLEW_NV_viewport_array” is undefined* E0020 identifier “GLEW_NV_viewport_swizzle” is undefined* E0020 identifier “GLEW_NVX_blend_equation_advanced_multi_draw_buffers” is undefined* E0020 identifier “GLEW_NVX_conditional_render” is undefined* E0020 identifier “GLEW_NVX_gpu_memory_info” is undefined* E0020 identifier “GLEW_NVX_linked_gpu_multicast” is undefined* E0020 identifier “GLEW_OES_byte_coordinates” is undefined* E0020 identifier “GLEW_OK” is undefined* E0020 identifier “GLEW_OML_interlace” is undefined* E0020 identifier “GLEW_OML_resample” is undefined* E0020 identifier “GLEW_OML_subsample” is undefined* E0020 identifier “GLEW_OVR_multiview2” is undefined* E0020 identifier “GLEW_OVR_multiview” is undefined* E0020 identifier “GLEW_OVR_multiview_multisampled_render_to_texture” is undefined* E0020 identifier “GLEW_PGI_misc_hints” is undefined* E0020 identifier “GLEW_PGI_vertex_hints” is undefined* E0020 identifier “GLEW_QCOM_alpha_test” is undefined* E0020 identifier “GLEW_QCOM_binning_control” is undefined* E0020 identifier “GLEW_QCOM_driver_control” is undefined* E0020 identifier “GLEW_QCOM_extended_get2” is undefined* E0020 identifier “GLEW_QCOM_extended_get” is undefined* E0020 identifier “GLEW_QCOM_framebuffer_foveated” is undefined* E0020 identifier “GLEW_QCOM_perfmon_global_mode” is undefined* E0020 identifier “GLEW_QCOM_shader_framebuffer_fetch_noncoherent” is undefined* E0020 identifier “GLEW_QCOM_tiled_rendering” is undefined* E0020 identifier “GLEW_QCOM_writeonly_rendering” is undefined* E0020 identifier “GLEW_REGAL_enable” is undefined* E0020 identifier “GLEW_REGAL_error_string” is undefined* E0020 identifier “GLEW_REGAL_ES1_0_compatibility” is undefined* E0020 identifier “GLEW_REGAL_ES1_1_compatibility” is undefined* E0020 identifier “GLEW_REGAL_extension_query” is undefined* E0020 identifier “GLEW_REGAL_log” is undefined* E0020 identifier “GLEW_REGAL_proc_address” is undefined* E0020 identifier “GLEW_REND_screen_coordinates” is undefined* E0020 identifier “GLEW_S3_s3tc” is undefined* E0020 identifier “GLEW_SGI_color_matrix” is undefined* E0020 identifier “GLEW_SGI_color_table” is undefined* E0020 identifier “GLEW_SGI_complex” is undefined* E0020 identifier “GLEW_SGI_complex_type” is undefined* E0020 identifier “GLEW_SGI_fft” is undefined* E0020 identifier “GLEW_SGI_texture_color_table” is undefined* E0020 identifier “GLEW_SGIS_clip_band_hint” is undefined* E0020 identifier “GLEW_SGIS_color_range” is undefined* E0020 identifier “GLEW_SGIS_detail_texture” is undefined* E0020 identifier “GLEW_SGIS_fog_function” is undefined* E0020 identifier “GLEW_SGIS_generate_mipmap” is undefined* E0020 identifier “GLEW_SGIS_line_texgen” is undefined* E0020 identifier “GLEW_SGIS_multisample” is undefined* E0020 identifier “GLEW_SGIS_multitexture” is undefined* E0020 identifier “GLEW_SGIS_pixel_texture” is undefined* E0020 identifier “GLEW_SGIS_point_line_texgen” is undefined* E0020 identifier “GLEW_SGIS_shared_multisample” is undefined* E0020 identifier “GLEW_SGIS_sharpen_texture” is undefined* E0020 identifier “GLEW_SGIS_texture4D” is undefined* E0020 identifier “GLEW_SGIS_texture_border_clamp” is undefined* E0020 identifier “GLEW_SGIS_texture_edge_clamp” is undefined* E0020 identifier “GLEW_SGIS_texture_filter4” is undefined* E0020 identifier “GLEW_SGIS_texture_lod” is undefined* E0020 identifier “GLEW_SGIS_texture_select” is undefined* E0020 identifier “GLEW_SGIX_async” is undefined* E0020 identifier “GLEW_SGIX_async_histogram” is undefined* E0020 identifier “GLEW_SGIX_async_pixel” is undefined* E0020 identifier “GLEW_SGIX_bali_g_instruments” is undefined* E0020 identifier “GLEW_SGIX_bali_r_instruments” is undefined* E0020 identifier “GLEW_SGIX_bali_timer_instruments” is undefined* E0020 identifier “GLEW_SGIX_blend_alpha_minmax” is undefined* E0020 identifier “GLEW_SGIX_blend_cadd” is undefined* E0020 identifier “GLEW_SGIX_blend_cmultiply” is undefined* E0020 identifier “GLEW_SGIX_calligraphic_fragment” is undefined* E0020 identifier “GLEW_SGIX_clipmap” is undefined* E0020 identifier “GLEW_SGIX_color_matrix_accuracy” is undefined* E0020 identifier “GLEW_SGIX_color_table_index_mode” is undefined* E0020 identifier “GLEW_SGIX_complex_polar” is undefined* E0020 identifier “GLEW_SGIX_convolution_accuracy” is undefined* E0020 identifier “GLEW_SGIX_cube_map” is undefined* E0020 identifier “GLEW_SGIX_cylinder_texgen” is undefined* E0020 identifier “GLEW_SGIX_datapipe” is undefined* E0020 identifier “GLEW_SGIX_decimation” is undefined* E0020 identifier “GLEW_SGIX_depth_pass_instrument” is undefined* E0020 identifier “GLEW_SGIX_depth_texture” is undefined* E0020 identifier “GLEW_SGIX_dvc” is undefined* E0020 identifier “GLEW_SGIX_flush_raster” is undefined* E0020 identifier “GLEW_SGIX_fog_blend” is undefined* E0020 identifier “GLEW_SGIX_fog_factor_to_alpha” is undefined* E0020 identifier “GLEW_SGIX_fog_layers” is undefined* E0020 identifier “GLEW_SGIX_fog_offset” is undefined* E0020 identifier “GLEW_SGIX_fog_patchy” is undefined* E0020 identifier “GLEW_SGIX_fog_scale” is undefined* E0020 identifier “GLEW_SGIX_fog_texture” is undefined* E0020 identifier “GLEW_SGIX_fragment_lighting_space” is undefined* E0020 identifier “GLEW_SGIX_fragment_specular_lighting” is undefined* E0020 identifier “GLEW_SGIX_fragments_instrument” is undefined* E0020 identifier “GLEW_SGIX_framezoom” is undefined* E0020 identifier “GLEW_SGIX_icc_texture” is undefined* E0020 identifier “GLEW_SGIX_igloo_interface” is undefined* E0020 identifier “GLEW_SGIX_image_compression” is undefined* E0020 identifier “GLEW_SGIX_impact_pixel_texture” is undefined* E0020 identifier “GLEW_SGIX_instrument_error” is undefined* E0020 identifier “GLEW_SGIX_interlace” is undefined* E0020 identifier “GLEW_SGIX_ir_instrument1” is undefined* E0020 identifier “GLEW_SGIX_line_quality_hint” is undefined* E0020 identifier “GLEW_SGIX_list_priority” is undefined* E0020 identifier “GLEW_SGIX_mpeg1” is undefined* E0020 identifier “GLEW_SGIX_mpeg2” is undefined* E0020 identifier “GLEW_SGIX_nonlinear_lighting_pervertex” is undefined* E0020 identifier “GLEW_SGIX_nurbs_eval” is undefined* E0020 identifier “GLEW_SGIX_occlusion_instrument” is undefined* E0020 identifier “GLEW_SGIX_packed_6bytes” is undefined* E0020 identifier “GLEW_SGIX_pixel_texture” is undefined* E0020 identifier “GLEW_SGIX_pixel_texture_bits” is undefined* E0020 identifier “GLEW_SGIX_pixel_texture_lod” is undefined* E0020 identifier “GLEW_SGIX_pixel_tiles” is undefined* E0020 identifier “GLEW_SGIX_polynomial_ffd” is undefined* E0020 identifier “GLEW_SGIX_quad_mesh” is undefined* E0020 identifier “GLEW_SGIX_reference_plane” is undefined* E0020 identifier “GLEW_SGIX_resample” is undefined* E0020 identifier “GLEW_SGIX_scalebias_hint” is undefined* E0020 identifier “GLEW_SGIX_shadow” is undefined* E0020 identifier “GLEW_SGIX_shadow_ambient” is undefined* E0020 identifier “GLEW_SGIX_slim” is undefined* E0020 identifier “GLEW_SGIX_spotlight_cutoff” is undefined* E0020 identifier “GLEW_SGIX_sprite” is undefined* E0020 identifier “GLEW_SGIX_subdiv_patch” is undefined* E0020 identifier “GLEW_SGIX_subsample” is undefined* E0020 identifier “GLEW_SGIX_tag_sample_buffer” is undefined* E0020 identifier “GLEW_SGIX_texture_add_env” is undefined* E0020 identifier “GLEW_SGIX_texture_coordinate_clamp” is undefined* E0020 identifier “GLEW_SGIX_texture_lod_bias” is undefined* E0020 identifier “GLEW_SGIX_texture_mipmap_anisotropic” is undefined* E0020 identifier “GLEW_SGIX_texture_multi_buffer” is undefined* E0020 identifier “GLEW_SGIX_texture_phase” is undefined* E0020 identifier “GLEW_SGIX_texture_range” is undefined* E0020 identifier “GLEW_SGIX_texture_scale_bias” is undefined* E0020 identifier “GLEW_SGIX_texture_supersample” is undefined* E0020 identifier “GLEW_SGIX_vector_ops” is undefined* E0020 identifier “GLEW_SGIX_vertex_array_object” is undefined* E0020 identifier “GLEW_SGIX_vertex_preclip” is undefined* E0020 identifier “GLEW_SGIX_vertex_preclip_hint” is undefined* E0020 identifier “GLEW_SGIX_ycrcb” is undefined* E0020 identifier “GLEW_SGIX_ycrcb_subsample” is undefined* E0020 identifier “GLEW_SGIX_ycrcba” is undefined* E0020 identifier “GLEW_SUN_convolution_border_modes” is undefined* E0020 identifier “GLEW_SUN_global_alpha” is undefined* E0020 identifier “GLEW_SUN_mesh_array” is undefined* E0020 identifier “GLEW_SUN_read_video_pixels” is undefined* E0020 identifier “GLEW_SUN_slice_accum” is undefined* E0020 identifier “GLEW_SUN_triangle_list” is undefined* E0020 identifier “GLEW_SUN_vertex” is undefined* E0020 identifier “GLEW_SUNX_constant_data” is undefined* E0020 identifier “GLEW_VERSION” is undefined* E0020 identifier “GLEW_VERSION_1_1” is undefined* E0020 identifier “GLEW_VERSION_1_2” is undefined* E0020 identifier “GLEW_VERSION_1_2_1” is undefined* E0020 identifier “GLEW_VERSION_1_3” is undefined* E0020 identifier “GLEW_VERSION_1_4” is undefined* E0020 identifier “GLEW_VERSION_1_5” is undefined* E0020 identifier “GLEW_VERSION_2_0” is undefined* E0020 identifier “GLEW_VERSION_2_1” is undefined* E0020 identifier “GLEW_VERSION_3_0” is undefined* E0020 identifier “GLEW_VERSION_3_1” is undefined* E0020 identifier “GLEW_VERSION_3_2” is undefined* E0020 identifier “GLEW_VERSION_3_3” is undefined* E0020 identifier “GLEW_VERSION_4_0” is undefined* E0020 identifier “GLEW_VERSION_4_1” is undefined* E0020 identifier “GLEW_VERSION_4_2” is undefined* E0020 identifier “GLEW_VERSION_4_3” is undefined* E0020 identifier “GLEW_VERSION_4_4” is undefined* E0020 identifier “GLEW_VERSION_4_5” is undefined* E0020 identifier “GLEW_VERSION_4_6” is undefined* E0020 identifier “GLEW_VERSION_MAJOR” is undefined* E0020 identifier “GLEW_VERSION_MICRO” is undefined* E0020 identifier “GLEW_VERSION_MINOR” is undefined* E0020 identifier “GLEW_WIN_phong_shading” is undefined* E0020 identifier “GLEW_WIN_scene_markerXXX” is undefined* E0020 identifier “GLEW_WIN_specular_fog” is undefined* E0020 identifier “GLEW_WIN_swap_hint” is undefined* C2065 ‘GLEW_3DFX_multisample’: undeclared identifier* C2065 ‘GLEW_3DFX_tbuffer’: undeclared identifier* C2065 ‘GLEW_3DFX_texture_compression_FXT1’: undeclared identifier* C2065 ‘GLEW_AMD_blend_minmax_factor’: undeclared identifier* C2065 ‘GLEW_AMD_compressed_3DC_texture’: undeclared identifier* C2065 ‘GLEW_AMD_compressed_ATC_texture’: undeclared identifier* C2065 ‘GLEW_AMD_conservative_depth’: undeclared identifier* C2065 ‘GLEW_AMD_debug_output’: undeclared identifier* C2065 ‘GLEW_AMD_depth_clamp_separate’: undeclared identifier* C2065 ‘GLEW_AMD_draw_buffers_blend’: undeclared identifier* C2065 ‘GLEW_AMD_framebuffer_sample_positions’: undeclared identifier* C2065 ‘GLEW_AMD_gcn_shader’: undeclared identifier* C2065 ‘GLEW_AMD_gpu_shader_half_float’: undeclared identifier* C2065 ‘GLEW_AMD_gpu_shader_int16’: undeclared identifier* C2065 ‘GLEW_AMD_gpu_shader_int64’: undeclared identifier* C2065 ‘GLEW_AMD_interleaved_elements’: undeclared identifier* C2065 ‘GLEW_AMD_multi_draw_indirect’: undeclared identifier* C2065 ‘GLEW_AMD_name_gen_delete’: undeclared identifier* C2065 ‘GLEW_AMD_occlusion_query_event’: undeclared identifier* C2065 ‘GLEW_AMD_performance_monitor’: undeclared identifier* C2065 ‘GLEW_AMD_pinned_memory’: undeclared identifier* C2065 ‘GLEW_AMD_program_binary_Z400’: undeclared identifier* C2065 ‘GLEW_AMD_query_buffer_object’: undeclared identifier* C2065 ‘GLEW_AMD_sample_positions’: undeclared identifier* C2065 ‘GLEW_AMD_seamless_cubemap_per_texture’: undeclared identifier* C2065 ‘GLEW_AMD_shader_atomic_counter_ops’: undeclared identifier* C2065 ‘GLEW_AMD_shader_ballot’: undeclared identifier* C2065 ‘GLEW_AMD_shader_explicit_vertex_parameter’: undeclared identifier* C2065 ‘GLEW_AMD_shader_stencil_export’: undeclared identifier* C2065 ‘GLEW_AMD_shader_stencil_value_export’: undeclared identifier* C2065 ‘GLEW_AMD_shader_trinary_minmax’: undeclared identifier* C2065 ‘GLEW_AMD_sparse_texture’: undeclared identifier* C2065 ‘GLEW_AMD_stencil_operation_extended’: undeclared identifier* C2065 ‘GLEW_AMD_texture_gather_bias_lod’: undeclared identifier* C2065 ‘GLEW_AMD_texture_texture4’: undeclared identifier* C2065 ‘GLEW_AMD_transform_feedback3_lines_triangles’: undeclared identifier* C2065 ‘GLEW_AMD_transform_feedback4’: undeclared identifier* C2065 ‘GLEW_AMD_vertex_shader_layer’: undeclared identifier* C2065 ‘GLEW_AMD_vertex_shader_tessellator’: undeclared identifier* C2065 ‘GLEW_AMD_vertex_shader_viewport_index’: undeclared identifier* C2065 ‘GLEW_ANDROID_extension_pack_es31a’: undeclared identifier* C2065 ‘GLEW_ANGLE_depth_texture’: undeclared identifier* C2065 ‘GLEW_ANGLE_framebuffer_blit’: undeclared identifier* C2065 ‘GLEW_ANGLE_framebuffer_multisample’: undeclared identifier* C2065 ‘GLEW_ANGLE_instanced_arrays’: undeclared identifier* C2065 ‘GLEW_ANGLE_pack_reverse_row_order’: undeclared identifier* C2065 ‘GLEW_ANGLE_program_binary’: undeclared identifier* C2065 ‘GLEW_ANGLE_texture_compression_dxt1’: undeclared identifier* C2065 ‘GLEW_ANGLE_texture_compression_dxt3’: undeclared identifier* C2065 ‘GLEW_ANGLE_texture_compression_dxt5’: undeclared identifier* C2065 ‘GLEW_ANGLE_texture_usage’: undeclared identifier* C2065 ‘GLEW_ANGLE_timer_query’: undeclared identifier* C2065 ‘GLEW_ANGLE_translated_shader_source’: undeclared identifier* C2065 ‘GLEW_APPLE_aux_depth_stencil’: undeclared identifier* C2065 ‘GLEW_APPLE_client_storage’: undeclared identifier* C2065 ‘GLEW_APPLE_clip_distance’: undeclared identifier* C2065 ‘GLEW_APPLE_color_buffer_packed_float’: undeclared identifier* C2065 ‘GLEW_APPLE_copy_texture_levels’: undeclared identifier* C2065 ‘GLEW_APPLE_element_array’: undeclared identifier* C2065 ‘GLEW_APPLE_fence’: undeclared identifier* C2065 ‘GLEW_APPLE_float_pixels’: undeclared identifier* C2065 ‘GLEW_APPLE_flush_buffer_range’: undeclared identifier* C2065 ‘GLEW_APPLE_framebuffer_multisample’: undeclared identifier* C2065 ‘GLEW_APPLE_object_purgeable’: undeclared identifier* C2065 ‘GLEW_APPLE_pixel_buffer’: undeclared identifier* C2065 ‘GLEW_APPLE_rgb_422’: undeclared identifier* C2065 ‘GLEW_APPLE_row_bytes’: undeclared identifier* C2065 ‘GLEW_APPLE_specular_vector’: undeclared identifier* C2065 ‘GLEW_APPLE_sync’: undeclared identifier* C2065 ‘GLEW_APPLE_texture_2D_limited_npot’: undeclared identifier* C2065 ‘GLEW_APPLE_texture_format_BGRA8888’: undeclared identifier* C2065 ‘GLEW_APPLE_texture_max_level’: undeclared identifier* C2065 ‘GLEW_APPLE_texture_packed_float’: undeclared identifier* C2065 ‘GLEW_APPLE_texture_range’: undeclared identifier* C2065 ‘GLEW_APPLE_transform_hint’: undeclared identifier* C2065 ‘GLEW_APPLE_vertex_array_object’: undeclared identifier* C2065 ‘GLEW_APPLE_vertex_array_range’: undeclared identifier* C2065 ‘GLEW_APPLE_vertex_program_evaluators’: undeclared identifier* C2065 ‘GLEW_APPLE_ycbcr_422’: undeclared identifier* C2065 ‘GLEW_ARB_arrays_of_arrays’: undeclared identifier* C2065 ‘GLEW_ARB_base_instance’: undeclared identifier* C2065 ‘GLEW_ARB_bindless_texture’: undeclared identifier* C2065 ‘GLEW_ARB_blend_func_extended’: undeclared identifier* C2065 ‘GLEW_ARB_buffer_storage’: undeclared identifier* C2065 ‘GLEW_ARB_cl_event’: undeclared identifier* C2065 ‘GLEW_ARB_clear_buffer_object’: undeclared identifier* C2065 ‘GLEW_ARB_clear_texture’: undeclared identifier* C2065 ‘GLEW_ARB_clip_control’: undeclared identifier* C2065 ‘GLEW_ARB_color_buffer_float’: undeclared identifier* C2065 ‘GLEW_ARB_compatibility’: undeclared identifier* C2065 ‘GLEW_ARB_compressed_texture_pixel_storage’: undeclared identifier* C2065 ‘GLEW_ARB_compute_shader’: undeclared identifier* C2065 ‘GLEW_ARB_compute_variable_group_size’: undeclared identifier* C2065 ‘GLEW_ARB_conditional_render_inverted’: undeclared identifier* C2065 ‘GLEW_ARB_conservative_depth’: undeclared identifier* C2065 ‘GLEW_ARB_copy_buffer’: undeclared identifier* C2065 ‘GLEW_ARB_copy_image’: undeclared identifier* C2065 ‘GLEW_ARB_cull_distance’: undeclared identifier* C2065 ‘GLEW_ARB_debug_output’: undeclared identifier* C2065 ‘GLEW_ARB_depth_buffer_float’: undeclared identifier* C2065 ‘GLEW_ARB_depth_clamp’: undeclared identifier* C2065 ‘GLEW_ARB_depth_texture’: undeclared identifier* C2065 ‘GLEW_ARB_derivative_control’: undeclared identifier* C2065 ‘GLEW_ARB_direct_state_access’: undeclared identifier* C2065 ‘GLEW_ARB_draw_buffers’: undeclared identifier* C2065 ‘GLEW_ARB_draw_buffers_blend’: undeclared identifier* C2065 ‘GLEW_ARB_draw_elements_base_vertex’: undeclared identifier* C2065 ‘GLEW_ARB_draw_indirect’: undeclared identifier* C2065 ‘GLEW_ARB_draw_instanced’: undeclared identifier* C2065 ‘GLEW_ARB_enhanced_layouts’: undeclared identifier* C2065 ‘GLEW_ARB_ES2_compatibility’: undeclared identifier* C2065 ‘GLEW_ARB_ES3_1_compatibility’: undeclared identifier* C2065 ‘GLEW_ARB_ES3_2_compatibility’: undeclared identifier* C2065 ‘GLEW_ARB_ES3_compatibility’: undeclared identifier* C2065 ‘GLEW_ARB_explicit_attrib_location’: undeclared identifier* C2065 ‘GLEW_ARB_explicit_uniform_location’: undeclared identifier* C2065 ‘GLEW_ARB_fragment_coord_conventions’: undeclared identifier* C2065 ‘GLEW_ARB_fragment_layer_viewport’: undeclared identifier* C2065 ‘GLEW_ARB_fragment_program’: undeclared identifier* C2065 ‘GLEW_ARB_fragment_program_shadow’: undeclared identifier* C2065 ‘GLEW_ARB_fragment_shader’: undeclared identifier* C2065 ‘GLEW_ARB_fragment_shader_interlock’: undeclared identifier* C2065 ‘GLEW_ARB_framebuffer_no_attachments’: undeclared identifier* C2065 ‘GLEW_ARB_framebuffer_object’: undeclared identifier* C2065 ‘GLEW_ARB_framebuffer_sRGB’: undeclared identifier* C2065 ‘GLEW_ARB_geometry_shader4’: undeclared identifier* C2065 ‘GLEW_ARB_get_program_binary’: undeclared identifier* C2065 ‘GLEW_ARB_get_texture_sub_image’: undeclared identifier* C2065 ‘GLEW_ARB_gl_spirv’: undeclared identifier* C2065 ‘GLEW_ARB_gpu_shader5’: undeclared identifier* C2065 ‘GLEW_ARB_gpu_shader_fp64’: undeclared identifier* C2065 ‘GLEW_ARB_gpu_shader_int64’: undeclared identifier* C2065 ‘GLEW_ARB_half_float_pixel’: undeclared identifier* C2065 ‘GLEW_ARB_half_float_vertex’: undeclared identifier* C2065 ‘GLEW_ARB_imaging’: undeclared identifier* C2065 ‘GLEW_ARB_indirect_parameters’: undeclared identifier* C2065 ‘GLEW_ARB_instanced_arrays’: undeclared identifier* C2065 ‘GLEW_ARB_internalformat_query2’: undeclared identifier* C2065 ‘GLEW_ARB_internalformat_query’: undeclared identifier* C2065 ‘GLEW_ARB_invalidate_subdata’: undeclared identifier* C2065 ‘GLEW_ARB_map_buffer_alignment’: undeclared identifier* C2065 ‘GLEW_ARB_map_buffer_range’: undeclared identifier* C2065 ‘GLEW_ARB_matrix_palette’: undeclared identifier* C2065 ‘GLEW_ARB_multi_bind’: undeclared identifier* C2065 ‘GLEW_ARB_multi_draw_indirect’: undeclared identifier* C2065 ‘GLEW_ARB_multisample’: undeclared identifier* C2065 ‘GLEW_ARB_multitexture’: undeclared identifier* C2065 ‘GLEW_ARB_occlusion_query2’: undeclared identifier* C2065 ‘GLEW_ARB_occlusion_query’: undeclared identifier* C2065 ‘GLEW_ARB_parallel_shader_compile’: undeclared identifier* C2065 ‘GLEW_ARB_pipeline_statistics_query’: undeclared identifier* C2065 ‘GLEW_ARB_pixel_buffer_object’: undeclared identifier* C2065 ‘GLEW_ARB_point_parameters’: undeclared identifier* C2065 ‘GLEW_ARB_point_sprite’: undeclared identifier* C2065 ‘GLEW_ARB_polygon_offset_clamp’: undeclared identifier* C2065 ‘GLEW_ARB_post_depth_coverage’: undeclared identifier* C2065 ‘GLEW_ARB_program_interface_query’: undeclared identifier* C2065 ‘GLEW_ARB_provoking_vertex’: undeclared identifier* C2065 ‘GLEW_ARB_query_buffer_object’: undeclared identifier* C2065 ‘GLEW_ARB_robust_buffer_access_behavior’: undeclared identifier* C2065 ‘GLEW_ARB_robustness’: undeclared identifier* C2065 ‘GLEW_ARB_robustness_application_isolation’: undeclared identifier* C2065 ‘GLEW_ARB_robustness_share_group_isolation’: undeclared identifier* C2065 ‘GLEW_ARB_sample_locations’: undeclared identifier* C2065 ‘GLEW_ARB_sample_shading’: undeclared identifier* C2065 ‘GLEW_ARB_sampler_objects’: undeclared identifier* C2065 ‘GLEW_ARB_seamless_cube_map’: undeclared identifier* C2065 ‘GLEW_ARB_seamless_cubemap_per_texture’: undeclared identifier* C2065 ‘GLEW_ARB_separate_shader_objects’: undeclared identifier* C2065 ‘GLEW_ARB_shader_atomic_counter_ops’: undeclared identifier* C2065 ‘GLEW_ARB_shader_atomic_counters’: undeclared identifier* C2065 ‘GLEW_ARB_shader_ballot’: undeclared identifier* C2065 ‘GLEW_ARB_shader_bit_encoding’: undeclared identifier* C2065 ‘GLEW_ARB_shader_clock’: undeclared identifier* C2065 ‘GLEW_ARB_shader_draw_parameters’: undeclared identifier* C2065 ‘GLEW_ARB_shader_group_vote’: undeclared identifier* C2065 ‘GLEW_ARB_shader_image_load_store’: undeclared identifier* C2065 ‘GLEW_ARB_shader_image_size’: undeclared identifier* C2065 ‘GLEW_ARB_shader_objects’: undeclared identifier* C2065 ‘GLEW_ARB_shader_precision’: undeclared identifier* C2065 ‘GLEW_ARB_shader_stencil_export’: undeclared identifier* C2065 ‘GLEW_ARB_shader_storage_buffer_object’: undeclared identifier* C2065 ‘GLEW_ARB_shader_subroutine’: undeclared identifier* C2065 ‘GLEW_ARB_shader_texture_image_samples’: undeclared identifier* C2065 ‘GLEW_ARB_shader_texture_lod’: undeclared identifier* C2065 ‘GLEW_ARB_shader_viewport_layer_array’: undeclared identifier* C2065 ‘GLEW_ARB_shading_language_100’: undeclared identifier* C2065 ‘GLEW_ARB_shading_language_420pack’: undeclared identifier* C2065 ‘GLEW_ARB_shading_language_include’: undeclared identifier* C2065 ‘GLEW_ARB_shading_language_packing’: undeclared identifier* C2065 ‘GLEW_ARB_shadow’: undeclared identifier* C2065 ‘GLEW_ARB_shadow_ambient’: undeclared identifier* C2065 ‘GLEW_ARB_sparse_buffer’: undeclared identifier* C2065 ‘GLEW_ARB_sparse_texture2’: undeclared identifier* C2065 ‘GLEW_ARB_sparse_texture’: undeclared identifier* C2065 ‘GLEW_ARB_sparse_texture_clamp’: undeclared identifier* C2065 ‘GLEW_ARB_spirv_extensions’: undeclared identifier* C2065 ‘GLEW_ARB_stencil_texturing’: undeclared identifier* C2065 ‘GLEW_ARB_sync’: undeclared identifier* C2065 ‘GLEW_ARB_tessellation_shader’: undeclared identifier* C2065 ‘GLEW_ARB_texture_barrier’: undeclared identifier* C2065 ‘GLEW_ARB_texture_border_clamp’: undeclared identifier* C2065 ‘GLEW_ARB_texture_buffer_object’: undeclared identifier* C2065 ‘GLEW_ARB_texture_buffer_object_rgb32’: undeclared identifier* C2065 ‘GLEW_ARB_texture_buffer_range’: undeclared identifier* C2065 ‘GLEW_ARB_texture_compression’: undeclared identifier* C2065 ‘GLEW_ARB_texture_compression_bptc’: undeclared identifier* C2065 ‘GLEW_ARB_texture_compression_rgtc’: undeclared identifier* C2065 ‘GLEW_ARB_texture_cube_map’: undeclared identifier* C2065 ‘GLEW_ARB_texture_cube_map_array’: undeclared identifier* C2065 ‘GLEW_ARB_texture_env_add’: undeclared identifier* C2065 ‘GLEW_ARB_texture_env_combine’: undeclared identifier* C2065 ‘GLEW_ARB_texture_env_crossbar’: undeclared identifier* C2065 ‘GLEW_ARB_texture_env_dot3’: undeclared identifier* C2065 ‘GLEW_ARB_texture_filter_anisotropic’: undeclared identifier* C2065 ‘GLEW_ARB_texture_filter_minmax’: undeclared identifier* C2065 ‘GLEW_ARB_texture_float’: undeclared identifier* C2065 ‘GLEW_ARB_texture_gather’: undeclared identifier* C2065 ‘GLEW_ARB_texture_mirror_clamp_to_edge’: undeclared identifier* C2065 ‘GLEW_ARB_texture_mirrored_repeat’: undeclared identifier* C2065 ‘GLEW_ARB_texture_multisample’: undeclared identifier* C2065 ‘GLEW_ARB_texture_non_power_of_two’: undeclared identifier* C2065 ‘GLEW_ARB_texture_query_levels’: undeclared identifier* C2065 ‘GLEW_ARB_texture_query_lod’: undeclared identifier* C2065 ‘GLEW_ARB_texture_rectangle’: undeclared identifier* C2065 ‘GLEW_ARB_texture_rg’: undeclared identifier* C2065 ‘GLEW_ARB_texture_rgb10_a2ui’: undeclared identifier* C2065 ‘GLEW_ARB_texture_stencil8’: undeclared identifier* C2065 ‘GLEW_ARB_texture_storage’: undeclared identifier* C2065 ‘GLEW_ARB_texture_storage_multisample’: undeclared identifier* C2065 ‘GLEW_ARB_texture_swizzle’: undeclared identifier* C2065 ‘GLEW_ARB_texture_view’: undeclared identifier* C2065 ‘GLEW_ARB_timer_query’: undeclared identifier* C2065 ‘GLEW_ARB_transform_feedback2’: undeclared identifier* C2065 ‘GLEW_ARB_transform_feedback3’: undeclared identifier* C2065 ‘GLEW_ARB_transform_feedback_instanced’: undeclared identifier* C2065 ‘GLEW_ARB_transform_feedback_overflow_query’: undeclared identifier* C2065 ‘GLEW_ARB_transpose_matrix’: undeclared identifier* C2065 ‘GLEW_ARB_uniform_buffer_object’: undeclared identifier* C2065 ‘GLEW_ARB_vertex_array_bgra’: undeclared identifier* C2065 ‘GLEW_ARB_vertex_array_object’: undeclared identifier* C2065 ‘GLEW_ARB_vertex_attrib_64bit’: undeclared identifier* C2065 ‘GLEW_ARB_vertex_attrib_binding’: undeclared identifier* C2065 ‘GLEW_ARB_vertex_blend’: undeclared identifier* C2065 ‘GLEW_ARB_vertex_buffer_object’: undeclared identifier* C2065 ‘GLEW_ARB_vertex_program’: undeclared identifier* C2065 ‘GLEW_ARB_vertex_shader’: undeclared identifier* C2065 ‘GLEW_ARB_vertex_type_2_10_10_10_rev’: undeclared identifier* C2065 ‘GLEW_ARB_vertex_type_10f_11f_11f_rev’: undeclared identifier* C2065 ‘GLEW_ARB_viewport_array’: undeclared identifier* C2065 ‘GLEW_ARB_window_pos’: undeclared identifier* C2065 ‘GLEW_ARM_mali_program_binary’: undeclared identifier* C2065 ‘GLEW_ARM_mali_shader_binary’: undeclared identifier* C2065 ‘GLEW_ARM_rgba8’: undeclared identifier* C2065 ‘GLEW_ARM_shader_framebuffer_fetch’: undeclared identifier* C2065 ‘GLEW_ARM_shader_framebuffer_fetch_depth_stencil’: undeclared identifier* C2065 ‘GLEW_ATI_draw_buffers’: undeclared identifier* C2065 ‘GLEW_ATI_element_array’: undeclared identifier* C2065 ‘GLEW_ATI_envmap_bumpmap’: undeclared identifier* C2065 ‘GLEW_ATI_fragment_shader’: undeclared identifier* C2065 ‘GLEW_ATI_map_object_buffer’: undeclared identifier* C2065 ‘GLEW_ATI_meminfo’: undeclared identifier* C2065 ‘GLEW_ATI_pn_triangles’: undeclared identifier* C2065 ‘GLEW_ATI_separate_stencil’: undeclared identifier* C2065 ‘GLEW_ATI_shader_texture_lod’: undeclared identifier* C2065 ‘GLEW_ATI_text_fragment_shader’: undeclared identifier* C2065 ‘GLEW_ATI_texture_compression_3dc’: undeclared identifier* C2065 ‘GLEW_ATI_texture_env_combine3’: undeclared identifier* C2065 ‘GLEW_ATI_texture_float’: undeclared identifier* C2065 ‘GLEW_ATI_texture_mirror_once’: undeclared identifier* C2065 ‘GLEW_ATI_vertex_array_object’: undeclared identifier* C2065 ‘GLEW_ATI_vertex_attrib_array_object’: undeclared identifier* C2065 ‘GLEW_ATI_vertex_streams’: undeclared identifier* C2065 ‘GLEW_ATIX_point_sprites’: undeclared identifier* C2065 ‘GLEW_ATIX_texture_env_combine3’: undeclared identifier* C2065 ‘GLEW_ATIX_texture_env_route’: undeclared identifier* C2065 ‘GLEW_ATIX_vertex_shader_output_point_size’: undeclared identifier* C2065 ‘GLEW_EGL_KHR_context_flush_control’: undeclared identifier* C2065 ‘GLEW_EGL_NV_robustness_video_memory_purge’: undeclared identifier* C2065 ‘GLEW_ERROR_GL_VERSION_10_ONLY’: undeclared identifier* C2065 ‘GLEW_ERROR_GLX_VERSION_11_ONLY’: undeclared identifier* C2065 ‘GLEW_ERROR_NO_GL_VERSION’: undeclared identifier* C2065 ‘GLEW_ERROR_NO_GLX_DISPLAY’: undeclared identifier* C2065 ‘GLEW_EXT_422_pixels’: undeclared identifier* C2065 ‘GLEW_EXT_abgr’: undeclared identifier* C2065 ‘GLEW_EXT_base_instance’: undeclared identifier* C2065 ‘GLEW_EXT_bgra’: undeclared identifier* C2065 ‘GLEW_EXT_bindable_uniform’: undeclared identifier* C2065 ‘GLEW_EXT_blend_color’: undeclared identifier* C2065 ‘GLEW_EXT_blend_equation_separate’: undeclared identifier* C2065 ‘GLEW_EXT_blend_func_extended’: undeclared identifier* C2065 ‘GLEW_EXT_blend_func_separate’: undeclared identifier* C2065 ‘GLEW_EXT_blend_logic_op’: undeclared identifier* C2065 ‘GLEW_EXT_blend_minmax’: undeclared identifier* C2065 ‘GLEW_EXT_blend_subtract’: undeclared identifier* C2065 ‘GLEW_EXT_buffer_storage’: undeclared identifier* C2065 ‘GLEW_EXT_Cg_shader’: undeclared identifier* C2065 ‘GLEW_EXT_clear_texture’: undeclared identifier* C2065 ‘GLEW_EXT_clip_cull_distance’: undeclared identifier* C2065 ‘GLEW_EXT_clip_volume_hint’: undeclared identifier* C2065 ‘GLEW_EXT_cmyka’: undeclared identifier* C2065 ‘GLEW_EXT_color_buffer_float’: undeclared identifier* C2065 ‘GLEW_EXT_color_buffer_half_float’: undeclared identifier* C2065 ‘GLEW_EXT_color_subtable’: undeclared identifier* C2065 ‘GLEW_EXT_compiled_vertex_array’: undeclared identifier* C2065 ‘GLEW_EXT_compressed_ETC1_RGB8_sub_texture’: undeclared identifier* C2065 ‘GLEW_EXT_conservative_depth’: undeclared identifier* C2065 ‘GLEW_EXT_convolution’: undeclared identifier* C2065 ‘GLEW_EXT_coordinate_frame’: undeclared identifier* C2065 ‘GLEW_EXT_copy_image’: undeclared identifier* C2065 ‘GLEW_EXT_copy_texture’: undeclared identifier* C2065 ‘GLEW_EXT_cull_vertex’: undeclared identifier* C2065 ‘GLEW_EXT_debug_label’: undeclared identifier* C2065 ‘GLEW_EXT_debug_marker’: undeclared identifier* C2065 ‘GLEW_EXT_depth_bounds_test’: undeclared identifier* C2065 ‘GLEW_EXT_direct_state_access’: undeclared identifier* C2065 ‘GLEW_EXT_discard_framebuffer’: undeclared identifier* C2065 ‘GLEW_EXT_draw_buffers2’: undeclared identifier* C2065 ‘GLEW_EXT_draw_buffers’: undeclared identifier* C2065 ‘GLEW_EXT_draw_buffers_indexed’: undeclared identifier* C2065 ‘GLEW_EXT_draw_elements_base_vertex’: undeclared identifier* C2065 ‘GLEW_EXT_draw_instanced’: undeclared identifier* C2065 ‘GLEW_EXT_draw_range_elements’: undeclared identifier* C2065 ‘GLEW_EXT_EGL_image_array’: undeclared identifier* C2065 ‘GLEW_EXT_external_buffer’: undeclared identifier* C2065 ‘GLEW_EXT_float_blend’: undeclared identifier* C2065 ‘GLEW_EXT_fog_coord’: undeclared identifier* C2065 ‘GLEW_EXT_frag_depth’: undeclared identifier* C2065 ‘GLEW_EXT_fragment_lighting’: undeclared identifier* C2065 ‘GLEW_EXT_framebuffer_blit’: undeclared identifier* C2065 ‘GLEW_EXT_framebuffer_multisample’: undeclared identifier* C2065 ‘GLEW_EXT_framebuffer_multisample_blit_scaled’: undeclared identifier* C2065 ‘GLEW_EXT_framebuffer_object’: undeclared identifier* C2065 ‘GLEW_EXT_framebuffer_sRGB’: undeclared identifier* C2065 ‘GLEW_EXT_geometry_point_size’: undeclared identifier* C2065 ‘GLEW_EXT_geometry_shader4’: undeclared identifier* C2065 ‘GLEW_EXT_geometry_shader’: undeclared identifier* C2065 ‘GLEW_EXT_gpu_program_parameters’: undeclared identifier* C2065 ‘GLEW_EXT_gpu_shader4’: undeclared identifier* C2065 ‘GLEW_EXT_gpu_shader5’: undeclared identifier* C2065 ‘GLEW_EXT_histogram’: undeclared identifier* C2065 ‘GLEW_EXT_index_array_formats’: undeclared identifier* C2065 ‘GLEW_EXT_index_func’: undeclared identifier* C2065 ‘GLEW_EXT_index_material’: undeclared identifier* C2065 ‘GLEW_EXT_index_texture’: undeclared identifier* C2065 ‘GLEW_EXT_instanced_arrays’: undeclared identifier* C2065 ‘GLEW_EXT_light_texture’: undeclared identifier* C2065 ‘GLEW_EXT_map_buffer_range’: undeclared identifier* C2065 ‘GLEW_EXT_memory_object’: undeclared identifier* C2065 ‘GLEW_EXT_memory_object_fd’: undeclared identifier* C2065 ‘GLEW_EXT_memory_object_win32’: undeclared identifier* C2065 ‘GLEW_EXT_misc_attribute’: undeclared identifier* C2065 ‘GLEW_EXT_multi_draw_arrays’: undeclared identifier* C2065 ‘GLEW_EXT_multi_draw_indirect’: undeclared identifier* C2065 ‘GLEW_EXT_multiple_textures’: undeclared identifier* C2065 ‘GLEW_EXT_multisample’: undeclared identifier* C2065 ‘GLEW_EXT_multisample_compatibility’: undeclared identifier* C2065 ‘GLEW_EXT_multisampled_render_to_texture2’: undeclared identifier* C2065 ‘GLEW_EXT_multisampled_render_to_texture’: undeclared identifier* C2065 ‘GLEW_EXT_multiview_draw_buffers’: undeclared identifier* C2065 ‘GLEW_EXT_packed_depth_stencil’: undeclared identifier* C2065 ‘GLEW_EXT_packed_float’: undeclared identifier* C2065 ‘GLEW_EXT_packed_pixels’: undeclared identifier* C2065 ‘GLEW_EXT_paletted_texture’: undeclared identifier* C2065 ‘GLEW_EXT_pixel_buffer_object’: undeclared identifier* C2065 ‘GLEW_EXT_pixel_transform’: undeclared identifier* C2065 ‘GLEW_EXT_pixel_transform_color_table’: undeclared identifier* C2065 ‘GLEW_EXT_point_parameters’: undeclared identifier* C2065 ‘GLEW_EXT_polygon_offset’: undeclared identifier* C2065 ‘GLEW_EXT_polygon_offset_clamp’: undeclared identifier* C2065 ‘GLEW_EXT_post_depth_coverage’: undeclared identifier* C2065 ‘GLEW_EXT_provoking_vertex’: undeclared identifier* C2065 ‘GLEW_EXT_pvrtc_sRGB’: undeclared identifier* C2065 ‘GLEW_EXT_raster_multisample’: undeclared identifier* C2065 ‘GLEW_EXT_read_format_bgra’: undeclared identifier* C2065 ‘GLEW_EXT_render_snorm’: undeclared identifier* C2065 ‘GLEW_EXT_rescale_normal’: undeclared identifier* C2065 ‘GLEW_EXT_scene_marker’: undeclared identifier* C2065 ‘GLEW_EXT_secondary_color’: undeclared identifier* C2065 ‘GLEW_EXT_semaphore’: undeclared identifier* C2065 ‘GLEW_EXT_semaphore_fd’: undeclared identifier* C2065 ‘GLEW_EXT_semaphore_win32’: undeclared identifier* C2065 ‘GLEW_EXT_separate_shader_objects’: undeclared identifier* C2065 ‘GLEW_EXT_separate_specular_color’: undeclared identifier* C2065 ‘GLEW_EXT_shader_framebuffer_fetch’: undeclared identifier* C2065 ‘GLEW_EXT_shader_group_vote’: undeclared identifier* C2065 ‘GLEW_EXT_shader_image_load_formatted’: undeclared identifier* C2065 ‘GLEW_EXT_shader_image_load_store’: undeclared identifier* C2065 ‘GLEW_EXT_shader_implicit_conversions’: undeclared identifier* C2065 ‘GLEW_EXT_shader_integer_mix’: undeclared identifier* C2065 ‘GLEW_EXT_shader_io_blocks’: undeclared identifier* C2065 ‘GLEW_EXT_shader_non_constant_global_initializers’: undeclared identifier* C2065 ‘GLEW_EXT_shader_pixel_local_storage2’: undeclared identifier* C2065 ‘GLEW_EXT_shader_pixel_local_storage’: undeclared identifier* C2065 ‘GLEW_EXT_shader_texture_lod’: undeclared identifier* C2065 ‘GLEW_EXT_shadow_funcs’: undeclared identifier* C2065 ‘GLEW_EXT_shadow_samplers’: undeclared identifier* C2065 ‘GLEW_EXT_shared_texture_palette’: undeclared identifier* C2065 ‘GLEW_EXT_sparse_texture2’: undeclared identifier* C2065 ‘GLEW_EXT_sparse_texture’: undeclared identifier* C2065 ‘GLEW_EXT_sRGB’: undeclared identifier* C2065 ‘GLEW_EXT_sRGB_write_control’: undeclared identifier* C2065 ‘GLEW_EXT_stencil_clear_tag’: undeclared identifier* C2065 ‘GLEW_EXT_stencil_two_side’: undeclared identifier* C2065 ‘GLEW_EXT_stencil_wrap’: undeclared identifier* C2065 ‘GLEW_EXT_subtexture’: undeclared identifier* C2065 ‘GLEW_EXT_texture3D’: undeclared identifier* C2065 ‘GLEW_EXT_texture’: undeclared identifier* C2065 ‘GLEW_EXT_texture_array’: undeclared identifier* C2065 ‘GLEW_EXT_texture_buffer_object’: undeclared identifier* C2065 ‘GLEW_EXT_texture_compression_astc_decode_mode’: undeclared identifier* C2065 ‘GLEW_EXT_texture_compression_astc_decode_mode_rgb9e5’: undeclared identifier* C2065 ‘GLEW_EXT_texture_compression_bptc’: undeclared identifier* C2065 ‘GLEW_EXT_texture_compression_dxt1’: undeclared identifier* C2065 ‘GLEW_EXT_texture_compression_latc’: undeclared identifier* C2065 ‘GLEW_EXT_texture_compression_rgtc’: undeclared identifier* C2065 ‘GLEW_EXT_texture_compression_s3tc’: undeclared identifier* C2065 ‘GLEW_EXT_texture_cube_map’: undeclared identifier* C2065 ‘GLEW_EXT_texture_cube_map_array’: undeclared identifier* C2065 ‘GLEW_EXT_texture_edge_clamp’: undeclared identifier* C2065 ‘GLEW_EXT_texture_env’: undeclared identifier* C2065 ‘GLEW_EXT_texture_env_add’: undeclared identifier* C2065 ‘GLEW_EXT_texture_env_combine’: undeclared identifier* C2065 ‘GLEW_EXT_texture_env_dot3’: undeclared identifier* C2065 ‘GLEW_EXT_texture_filter_anisotropic’: undeclared identifier* C2065 ‘GLEW_EXT_texture_filter_minmax’: undeclared identifier* C2065 ‘GLEW_EXT_texture_format_BGRA8888’: undeclared identifier* C2065 ‘GLEW_EXT_texture_integer’: undeclared identifier* C2065 ‘GLEW_EXT_texture_lod_bias’: undeclared identifier* C2065 ‘GLEW_EXT_texture_mirror_clamp’: undeclared identifier* C2065 ‘GLEW_EXT_texture_norm16’: undeclared identifier* C2065 ‘GLEW_EXT_texture_object’: undeclared identifier* C2065 ‘GLEW_EXT_texture_perturb_normal’: undeclared identifier* C2065 ‘GLEW_EXT_texture_rectangle’: undeclared identifier* C2065 ‘GLEW_EXT_texture_rg’: undeclared identifier* C2065 ‘GLEW_EXT_texture_shared_exponent’: undeclared identifier* C2065 ‘GLEW_EXT_texture_snorm’: undeclared identifier* C2065 ‘GLEW_EXT_texture_sRGB’: undeclared identifier* C2065 ‘GLEW_EXT_texture_sRGB_decode’: undeclared identifier* C2065 ‘GLEW_EXT_texture_sRGB_R8’: undeclared identifier* C2065 ‘GLEW_EXT_texture_sRGB_RG8’: undeclared identifier* C2065 ‘GLEW_EXT_texture_storage’: undeclared identifier* C2065 ‘GLEW_EXT_texture_swizzle’: undeclared identifier* C2065 ‘GLEW_EXT_texture_type_2_10_10_10_REV’: undeclared identifier* C2065 ‘GLEW_EXT_texture_view’: undeclared identifier* C2065 ‘GLEW_EXT_timer_query’: undeclared identifier* C2065 ‘GLEW_EXT_transform_feedback’: undeclared identifier* C2065 ‘GLEW_EXT_unpack_subimage’: undeclared identifier* C2065 ‘GLEW_EXT_vertex_array’: undeclared identifier* C2065 ‘GLEW_EXT_vertex_array_bgra’: undeclared identifier* C2065 ‘GLEW_EXT_vertex_array_setXXX’: undeclared identifier* C2065 ‘GLEW_EXT_vertex_attrib_64bit’: undeclared identifier* C2065 ‘GLEW_EXT_vertex_shader’: undeclared identifier* C2065 ‘GLEW_EXT_vertex_weighting’: undeclared identifier* C2065 ‘GLEW_EXT_win32_keyed_mutex’: undeclared identifier* C2065 ‘GLEW_EXT_window_rectangles’: undeclared identifier* C2065 ‘GLEW_EXT_x11_sync_object’: undeclared identifier* C2065 ‘GLEW_EXT_YUV_target’: undeclared identifier* C2065 ‘GLEW_GET_FUN’: undeclared identifier* C2065 ‘GLEW_GREMEDY_frame_terminator’: undeclared identifier* C2065 ‘GLEW_GREMEDY_string_marker’: undeclared identifier* C2065 ‘GLEW_HP_convolution_border_modes’: undeclared identifier* C2065 ‘GLEW_HP_image_transform’: undeclared identifier* C2065 ‘GLEW_HP_occlusion_test’: undeclared identifier* C2065 ‘GLEW_HP_texture_lighting’: undeclared identifier* C2065 ‘GLEW_IBM_cull_vertex’: undeclared identifier* C2065 ‘GLEW_IBM_multimode_draw_arrays’: undeclared identifier* C2065 ‘GLEW_IBM_rasterpos_clip’: undeclared identifier* C2065 ‘GLEW_IBM_static_data’: undeclared identifier* C2065 ‘GLEW_IBM_texture_mirrored_repeat’: undeclared identifier* C2065 ‘GLEW_IBM_vertex_array_lists’: undeclared identifier* C2065 ‘GLEW_INGR_color_clamp’: undeclared identifier* C2065 ‘GLEW_INGR_interlace_read’: undeclared identifier* C2065 ‘GLEW_INTEL_conservative_rasterization’: undeclared identifier* C2065 ‘GLEW_INTEL_fragment_shader_ordering’: undeclared identifier* C2065 ‘GLEW_INTEL_framebuffer_CMAA’: undeclared identifier* C2065 ‘GLEW_INTEL_map_texture’: undeclared identifier* C2065 ‘GLEW_INTEL_parallel_arrays’: undeclared identifier* C2065 ‘GLEW_INTEL_performance_query’: undeclared identifier* C2065 ‘GLEW_INTEL_texture_scissor’: undeclared identifier* C2065 ‘GLEW_KHR_blend_equation_advanced’: undeclared identifier* C2065 ‘GLEW_KHR_blend_equation_advanced_coherent’: undeclared identifier* C2065 ‘GLEW_KHR_context_flush_control’: undeclared identifier* C2065 ‘GLEW_KHR_debug’: undeclared identifier* C2065 ‘GLEW_KHR_no_error’: undeclared identifier* C2065 ‘GLEW_KHR_parallel_shader_compile’: undeclared identifier* C2065 ‘GLEW_KHR_robust_buffer_access_behavior’: undeclared identifier* C2065 ‘GLEW_KHR_robustness’: undeclared identifier* C2065 ‘GLEW_KHR_texture_compression_astc_hdr’: undeclared identifier* C2065 ‘GLEW_KHR_texture_compression_astc_ldr’: undeclared identifier* C2065 ‘GLEW_KHR_texture_compression_astc_sliced_3d’: undeclared identifier* C2065 ‘GLEW_KTX_buffer_region’: undeclared identifier* C2065 ‘GLEW_MESA_pack_invert’: undeclared identifier* C2065 ‘GLEW_MESA_resize_buffers’: undeclared identifier* C2065 ‘GLEW_MESA_shader_integer_functions’: undeclared identifier* C2065 ‘GLEW_MESA_window_pos’: undeclared identifier* C2065 ‘GLEW_MESA_ycbcr_texture’: undeclared identifier* C2065 ‘GLEW_MESAX_texture_stack’: undeclared identifier* C2065 ‘GLEW_NO_ERROR’: undeclared identifier* C2065 ‘GLEW_NV_3dvision_settings’: undeclared identifier* C2065 ‘GLEW_NV_alpha_to_coverage_dither_control’: undeclared identifier* C2065 ‘GLEW_NV_bgr’: undeclared identifier* C2065 ‘GLEW_NV_bindless_multi_draw_indirect’: undeclared identifier* C2065 ‘GLEW_NV_bindless_multi_draw_indirect_count’: undeclared identifier* C2065 ‘GLEW_NV_bindless_texture’: undeclared identifier* C2065 ‘GLEW_NV_blend_equation_advanced’: undeclared identifier* C2065 ‘GLEW_NV_blend_equation_advanced_coherent’: undeclared identifier* C2065 ‘GLEW_NV_blend_minmax_factor’: undeclared identifier* C2065 ‘GLEW_NV_blend_square’: undeclared identifier* C2065 ‘GLEW_NV_clip_space_w_scaling’: undeclared identifier* C2065 ‘GLEW_NV_command_list’: undeclared identifier* C2065 ‘GLEW_NV_compute_program5’: undeclared identifier* C2065 ‘GLEW_NV_conditional_render’: undeclared identifier* C2065 ‘GLEW_NV_conservative_raster’: undeclared identifier* C2065 ‘GLEW_NV_conservative_raster_dilate’: undeclared identifier* C2065 ‘GLEW_NV_conservative_raster_pre_snap_triangles’: undeclared identifier* C2065 ‘GLEW_NV_copy_buffer’: undeclared identifier* C2065 ‘GLEW_NV_copy_depth_to_color’: undeclared identifier* C2065 ‘GLEW_NV_copy_image’: undeclared identifier* C2065 ‘GLEW_NV_deep_texture3D’: undeclared identifier* C2065 ‘GLEW_NV_depth_buffer_float’: undeclared identifier* C2065 ‘GLEW_NV_depth_clamp’: undeclared identifier* C2065 ‘GLEW_NV_depth_range_unclamped’: undeclared identifier* C2065 ‘GLEW_NV_draw_buffers’: undeclared identifier* C2065 ‘GLEW_NV_draw_instanced’: undeclared identifier* C2065 ‘GLEW_NV_draw_texture’: undeclared identifier* C2065 ‘GLEW_NV_draw_vulkan_image’: undeclared identifier* C2065 ‘GLEW_NV_EGL_stream_consumer_external’: undeclared identifier* C2065 ‘GLEW_NV_evaluators’: undeclared identifier* C2065 ‘GLEW_NV_explicit_attrib_location’: undeclared identifier* C2065 ‘GLEW_NV_explicit_multisample’: undeclared identifier* C2065 ‘GLEW_NV_fbo_color_attachments’: undeclared identifier* C2065 ‘GLEW_NV_fence’: undeclared identifier* C2065 ‘GLEW_NV_fill_rectangle’: undeclared identifier* C2065 ‘GLEW_NV_float_buffer’: undeclared identifier* C2065 ‘GLEW_NV_fog_distance’: undeclared identifier* C2065 ‘GLEW_NV_fragment_coverage_to_color’: undeclared identifier* C2065 ‘GLEW_NV_fragment_program2’: undeclared identifier* C2065 ‘GLEW_NV_fragment_program4’: undeclared identifier* C2065 ‘GLEW_NV_fragment_program’: undeclared identifier* C2065 ‘GLEW_NV_fragment_program_option’: undeclared identifier* C2065 ‘GLEW_NV_fragment_shader_interlock’: undeclared identifier* C2065 ‘GLEW_NV_framebuffer_blit’: undeclared identifier* C2065 ‘GLEW_NV_framebuffer_mixed_samples’: undeclared identifier* C2065 ‘GLEW_NV_framebuffer_multisample’: undeclared identifier* C2065 ‘GLEW_NV_framebuffer_multisample_coverage’: undeclared identifier* C2065 ‘GLEW_NV_generate_mipmap_sRGB’: undeclared identifier* C2065 ‘GLEW_NV_geometry_program4’: undeclared identifier* C2065 ‘GLEW_NV_geometry_shader4’: undeclared identifier* C2065 ‘GLEW_NV_geometry_shader_passthrough’: undeclared identifier* C2065 ‘GLEW_NV_gpu_multicast’: undeclared identifier* C2065 ‘GLEW_NV_gpu_program4’: undeclared identifier* C2065 ‘GLEW_NV_gpu_program5’: undeclared identifier* C2065 ‘GLEW_NV_gpu_program5_mem_extended’: undeclared identifier* C2065 ‘GLEW_NV_gpu_program_fp64’: undeclared identifier* C2065 ‘GLEW_NV_gpu_shader5’: undeclared identifier* C2065 ‘GLEW_NV_half_float’: undeclared identifier* C2065 ‘GLEW_NV_image_formats’: undeclared identifier* C2065 ‘GLEW_NV_instanced_arrays’: undeclared identifier* C2065 ‘GLEW_NV_internalformat_sample_query’: undeclared identifier* C2065 ‘GLEW_NV_light_max_exponent’: undeclared identifier* C2065 ‘GLEW_NV_multisample_coverage’: undeclared identifier* C2065 ‘GLEW_NV_multisample_filter_hint’: undeclared identifier* C2065 ‘GLEW_NV_non_square_matrices’: undeclared identifier* C2065 ‘GLEW_NV_occlusion_query’: undeclared identifier* C2065 ‘GLEW_NV_pack_subimage’: undeclared identifier* C2065 ‘GLEW_NV_packed_depth_stencil’: undeclared identifier* C2065 ‘GLEW_NV_packed_float’: undeclared identifier* C2065 ‘GLEW_NV_packed_float_linear’: undeclared identifier* C2065 ‘GLEW_NV_parameter_buffer_object2’: undeclared identifier* C2065 ‘GLEW_NV_parameter_buffer_object’: undeclared identifier* C2065 ‘GLEW_NV_path_rendering’: undeclared identifier* C2065 ‘GLEW_NV_path_rendering_shared_edge’: undeclared identifier* C2065 ‘GLEW_NV_pixel_buffer_object’: undeclared identifier* C2065 ‘GLEW_NV_pixel_data_range’: undeclared identifier* C2065 ‘GLEW_NV_platform_binary’: undeclared identifier* C2065 ‘GLEW_NV_point_sprite’: undeclared identifier* C2065 ‘GLEW_NV_polygon_mode’: undeclared identifier* C2065 ‘GLEW_NV_present_video’: undeclared identifier* C2065 ‘GLEW_NV_primitive_restart’: undeclared identifier* C2065 ‘GLEW_NV_read_depth’: undeclared identifier* C2065 ‘GLEW_NV_read_depth_stencil’: undeclared identifier* C2065 ‘GLEW_NV_read_stencil’: undeclared identifier* C2065 ‘GLEW_NV_register_combiners2’: undeclared identifier* C2065 ‘GLEW_NV_register_combiners’: undeclared identifier* C2065 ‘GLEW_NV_robustness_video_memory_purge’: undeclared identifier* C2065 ‘GLEW_NV_sample_locations’: undeclared identifier* C2065 ‘GLEW_NV_sample_mask_override_coverage’: undeclared identifier* C2065 ‘GLEW_NV_shader_atomic_counters’: undeclared identifier* C2065 ‘GLEW_NV_shader_atomic_float64’: undeclared identifier* C2065 ‘GLEW_NV_shader_atomic_float’: undeclared identifier* C2065 ‘GLEW_NV_shader_atomic_fp16_vector’: undeclared identifier* C2065 ‘GLEW_NV_shader_atomic_int64’: undeclared identifier* C2065 ‘GLEW_NV_shader_buffer_load’: undeclared identifier* C2065 ‘GLEW_NV_shader_noperspective_interpolation’: undeclared identifier* C2065 ‘GLEW_NV_shader_storage_buffer_object’: undeclared identifier* C2065 ‘GLEW_NV_shader_thread_group’: undeclared identifier* C2065 ‘GLEW_NV_shader_thread_shuffle’: undeclared identifier* C2065 ‘GLEW_NV_shadow_samplers_array’: undeclared identifier* C2065 ‘GLEW_NV_shadow_samplers_cube’: undeclared identifier* C2065 ‘GLEW_NV_sRGB_formats’: undeclared identifier* C2065 ‘GLEW_NV_stereo_view_rendering’: undeclared identifier* C2065 ‘GLEW_NV_tessellation_program5’: undeclared identifier* C2065 ‘GLEW_NV_texgen_emboss’: undeclared identifier* C2065 ‘GLEW_NV_texgen_reflection’: undeclared identifier* C2065 ‘GLEW_NV_texture_array’: undeclared identifier* C2065 ‘GLEW_NV_texture_barrier’: undeclared identifier* C2065 ‘GLEW_NV_texture_border_clamp’: undeclared identifier* C2065 ‘GLEW_NV_texture_compression_latc’: undeclared identifier* C2065 ‘GLEW_NV_texture_compression_s3tc’: undeclared identifier* C2065 ‘GLEW_NV_texture_compression_s3tc_update’: undeclared identifier* C2065 ‘GLEW_NV_texture_compression_vtc’: undeclared identifier* C2065 ‘GLEW_NV_texture_env_combine4’: undeclared identifier* C2065 ‘GLEW_NV_texture_expand_normal’: undeclared identifier* C2065 ‘GLEW_NV_texture_multisample’: undeclared identifier* C2065 ‘GLEW_NV_texture_npot_2D_mipmap’: undeclared identifier* C2065 ‘GLEW_NV_texture_rectangle’: undeclared identifier* C2065 ‘GLEW_NV_texture_rectangle_compressed’: undeclared identifier* C2065 ‘GLEW_NV_texture_shader2’: undeclared identifier* C2065 ‘GLEW_NV_texture_shader3’: undeclared identifier* C2065 ‘GLEW_NV_texture_shader’: undeclared identifier* C2065 ‘GLEW_NV_transform_feedback2’: undeclared identifier* C2065 ‘GLEW_NV_transform_feedback’: undeclared identifier* C2065 ‘GLEW_NV_uniform_buffer_unified_memory’: undeclared identifier* C2065 ‘GLEW_NV_vdpau_interop’: undeclared identifier* C2065 ‘GLEW_NV_vertex_array_range2’: undeclared identifier* C2065 ‘GLEW_NV_vertex_array_range’: undeclared identifier* C2065 ‘GLEW_NV_vertex_attrib_integer_64bit’: undeclared identifier* C2065 ‘GLEW_NV_vertex_buffer_unified_memory’: undeclared identifier* C2065 ‘GLEW_NV_vertex_program1_1’: undeclared identifier* C2065 ‘GLEW_NV_vertex_program2’: undeclared identifier* C2065 ‘GLEW_NV_vertex_program2_option’: undeclared identifier* C2065 ‘GLEW_NV_vertex_program3’: undeclared identifier* C2065 ‘GLEW_NV_vertex_program4’: undeclared identifier* C2065 ‘GLEW_NV_vertex_program’: undeclared identifier* C2065 ‘GLEW_NV_video_capture’: undeclared identifier* C2065 ‘GLEW_NV_viewport_array2’: undeclared identifier* C2065 ‘GLEW_NV_viewport_array’: undeclared identifier* C2065 ‘GLEW_NV_viewport_swizzle’: undeclared identifier* C2065 ‘GLEW_NVX_blend_equation_advanced_multi_draw_buffers’: undeclared identifier* C2065 ‘GLEW_NVX_conditional_render’: undeclared identifier* C2065 ‘GLEW_NVX_gpu_memory_info’: undeclared identifier* C2065 ‘GLEW_NVX_linked_gpu_multicast’: undeclared identifier* C2065 ‘GLEW_OES_byte_coordinates’: undeclared identifier* C2065 ‘GLEW_OK’: undeclared identifier* C2065 ‘GLEW_OML_interlace’: undeclared identifier* C2065 ‘GLEW_OML_resample’: undeclared identifier* C2065 ‘GLEW_OML_subsample’: undeclared identifier* C2065 ‘GLEW_OVR_multiview2’: undeclared identifier* C2065 ‘GLEW_OVR_multiview’: undeclared identifier* C2065 ‘GLEW_OVR_multiview_multisampled_render_to_texture’: undeclared identifier* C2065 ‘GLEW_PGI_misc_hints’: undeclared identifier* C2065 ‘GLEW_PGI_vertex_hints’: undeclared identifier* C2065 ‘GLEW_QCOM_alpha_test’: undeclared identifier* C2065 ‘GLEW_QCOM_binning_control’: undeclared identifier* C2065 ‘GLEW_QCOM_driver_control’: undeclared identifier* C2065 ‘GLEW_QCOM_extended_get2’: undeclared identifier* C2065 ‘GLEW_QCOM_extended_get’: undeclared identifier* C2065 ‘GLEW_QCOM_framebuffer_foveated’: undeclared identifier* C2065 ‘GLEW_QCOM_perfmon_global_mode’: undeclared identifier* C2065 ‘GLEW_QCOM_shader_framebuffer_fetch_noncoherent’: undeclared identifier* C2065 ‘GLEW_QCOM_tiled_rendering’: undeclared identifier* C2065 ‘GLEW_QCOM_writeonly_rendering’: undeclared identifier* C2065 ‘GLEW_REGAL_enable’: undeclared identifier* C2065 ‘GLEW_REGAL_error_string’: undeclared identifier* C2065 ‘GLEW_REGAL_ES1_0_compatibility’: undeclared identifier* C2065 ‘GLEW_REGAL_ES1_1_compatibility’: undeclared identifier* C2065 ‘GLEW_REGAL_extension_query’: undeclared identifier* C2065 ‘GLEW_REGAL_log’: undeclared identifier* C2065 ‘GLEW_REGAL_proc_address’: undeclared identifier* C2065 ‘GLEW_REND_screen_coordinates’: undeclared identifier* C2065 ‘GLEW_S3_s3tc’: undeclared identifier* C2065 ‘GLEW_SGI_color_matrix’: undeclared identifier* C2065 ‘GLEW_SGI_color_table’: undeclared identifier* C2065 ‘GLEW_SGI_complex’: undeclared identifier* C2065 ‘GLEW_SGI_complex_type’: undeclared identifier* C2065 ‘GLEW_SGI_fft’: undeclared identifier* C2065 ‘GLEW_SGI_texture_color_table’: undeclared identifier* C2065 ‘GLEW_SGIS_clip_band_hint’: undeclared identifier* C2065 ‘GLEW_SGIS_color_range’: undeclared identifier* C2065 ‘GLEW_SGIS_detail_texture’: undeclared identifier* C2065 ‘GLEW_SGIS_fog_function’: undeclared identifier* C2065 ‘GLEW_SGIS_generate_mipmap’: undeclared identifier* C2065 ‘GLEW_SGIS_line_texgen’: undeclared identifier* C2065 ‘GLEW_SGIS_multisample’: undeclared identifier* C2065 ‘GLEW_SGIS_multitexture’: undeclared identifier* C2065 ‘GLEW_SGIS_pixel_texture’: undeclared identifier* C2065 ‘GLEW_SGIS_point_line_texgen’: undeclared identifier* C2065 ‘GLEW_SGIS_shared_multisample’: undeclared identifier* C2065 ‘GLEW_SGIS_sharpen_texture’: undeclared identifier* C2065 ‘GLEW_SGIS_texture4D’: undeclared identifier* C2065 ‘GLEW_SGIS_texture_border_clamp’: undeclared identifier* C2065 ‘GLEW_SGIS_texture_edge_clamp’: undeclared identifier* C2065 ‘GLEW_SGIS_texture_filter4’: undeclared identifier* C2065 ‘GLEW_SGIS_texture_lod’: undeclared identifier* C2065 ‘GLEW_SGIS_texture_select’: undeclared identifier* C2065 ‘GLEW_SGIX_async’: undeclared identifier* C2065 ‘GLEW_SGIX_async_histogram’: undeclared identifier* C2065 ‘GLEW_SGIX_async_pixel’: undeclared identifier* C2065 ‘GLEW_SGIX_bali_g_instruments’: undeclared identifier* C2065 ‘GLEW_SGIX_bali_r_instruments’: undeclared identifier* C2065 ‘GLEW_SGIX_bali_timer_instruments’: undeclared identifier* C2065 ‘GLEW_SGIX_blend_alpha_minmax’: undeclared identifier* C2065 ‘GLEW_SGIX_blend_cadd’: undeclared identifier* C2065 ‘GLEW_SGIX_blend_cmultiply’: undeclared identifier* C2065 ‘GLEW_SGIX_calligraphic_fragment’: undeclared identifier* C2065 ‘GLEW_SGIX_clipmap’: undeclared identifier* C2065 ‘GLEW_SGIX_color_matrix_accuracy’: undeclared identifier* C2065 ‘GLEW_SGIX_color_table_index_mode’: undeclared identifier* C2065 ‘GLEW_SGIX_complex_polar’: undeclared identifier* C2065 ‘GLEW_SGIX_convolution_accuracy’: undeclared identifier* C2065 ‘GLEW_SGIX_cube_map’: undeclared identifier* C2065 ‘GLEW_SGIX_cylinder_texgen’: undeclared identifier* C2065 ‘GLEW_SGIX_datapipe’: undeclared identifier* C2065 ‘GLEW_SGIX_decimation’: undeclared identifier* C2065 ‘GLEW_SGIX_depth_pass_instrument’: undeclared identifier* C2065 ‘GLEW_SGIX_depth_texture’: undeclared identifier* C2065 ‘GLEW_SGIX_dvc’: undeclared identifier* C2065 ‘GLEW_SGIX_flush_raster’: undeclared identifier* C2065 ‘GLEW_SGIX_fog_blend’: undeclared identifier* C2065 ‘GLEW_SGIX_fog_factor_to_alpha’: undeclared identifier* C2065 ‘GLEW_SGIX_fog_layers’: undeclared identifier* C2065 ‘GLEW_SGIX_fog_offset’: undeclared identifier* C2065 ‘GLEW_SGIX_fog_patchy’: undeclared identifier* C2065 ‘GLEW_SGIX_fog_scale’: undeclared identifier* C2065 ‘GLEW_SGIX_fog_texture’: undeclared identifier* C2065 ‘GLEW_SGIX_fragment_lighting_space’: undeclared identifier* C2065 ‘GLEW_SGIX_fragment_specular_lighting’: undeclared identifier* C2065 ‘GLEW_SGIX_fragments_instrument’: undeclared identifier* C2065 ‘GLEW_SGIX_framezoom’: undeclared identifier* C2065 ‘GLEW_SGIX_icc_texture’: undeclared identifier* C2065 ‘GLEW_SGIX_igloo_interface’: undeclared identifier* C2065 ‘GLEW_SGIX_image_compression’: undeclared identifier* C2065 ‘GLEW_SGIX_impact_pixel_texture’: undeclared identifier* C2065 ‘GLEW_SGIX_instrument_error’: undeclared identifier* C2065 ‘GLEW_SGIX_interlace’: undeclared identifier* C2065 ‘GLEW_SGIX_ir_instrument1’: undeclared identifier* C2065 ‘GLEW_SGIX_line_quality_hint’: undeclared identifier* C2065 ‘GLEW_SGIX_list_priority’: undeclared identifier* C2065 ‘GLEW_SGIX_mpeg1’: undeclared identifier* C2065 ‘GLEW_SGIX_mpeg2’: undeclared identifier* C2065 ‘GLEW_SGIX_nonlinear_lighting_pervertex’: undeclared identifier* C2065 ‘GLEW_SGIX_nurbs_eval’: undeclared identifier* C2065 ‘GLEW_SGIX_occlusion_instrument’: undeclared identifier* C2065 ‘GLEW_SGIX_packed_6bytes’: undeclared identifier* C2065 ‘GLEW_SGIX_pixel_texture’: undeclared identifier* C2065 ‘GLEW_SGIX_pixel_texture_bits’: undeclared identifier* C2065 ‘GLEW_SGIX_pixel_texture_lod’: undeclared identifier* C2065 ‘GLEW_SGIX_pixel_tiles’: undeclared identifier* C2065 ‘GLEW_SGIX_polynomial_ffd’: undeclared identifier* C2065 ‘GLEW_SGIX_quad_mesh’: undeclared identifier* C2065 ‘GLEW_SGIX_reference_plane’: undeclared identifier* C2065 ‘GLEW_SGIX_resample’: undeclared identifier* C2065 ‘GLEW_SGIX_scalebias_hint’: undeclared identifier* C2065 ‘GLEW_SGIX_shadow’: undeclared identifier* C2065 ‘GLEW_SGIX_shadow_ambient’: undeclared identifier* C2065 ‘GLEW_SGIX_slim’: undeclared identifier* C2065 ‘GLEW_SGIX_spotlight_cutoff’: undeclared identifier* C2065 ‘GLEW_SGIX_sprite’: undeclared identifier* C2065 ‘GLEW_SGIX_subdiv_patch’: undeclared identifier* C2065 ‘GLEW_SGIX_subsample’: undeclared identifier* C2065 ‘GLEW_SGIX_tag_sample_buffer’: undeclared identifier* C2065 ‘GLEW_SGIX_texture_add_env’: undeclared identifier* C2065 ‘GLEW_SGIX_texture_coordinate_clamp’: undeclared identifier* C2065 ‘GLEW_SGIX_texture_lod_bias’: undeclared identifier* C2065 ‘GLEW_SGIX_texture_mipmap_anisotropic’: undeclared identifier* C2065 ‘GLEW_SGIX_texture_multi_buffer’: undeclared identifier* C2065 ‘GLEW_SGIX_texture_phase’: undeclared identifier* C2065 ‘GLEW_SGIX_texture_range’: undeclared identifier* C2065 ‘GLEW_SGIX_texture_scale_bias’: undeclared identifier* C2065 ‘GLEW_SGIX_texture_supersample’: undeclared identifier* C2065 ‘GLEW_SGIX_vector_ops’: undeclared identifier* C2065 ‘GLEW_SGIX_vertex_array_object’: undeclared identifier* C2065 ‘GLEW_SGIX_vertex_preclip’: undeclared identifier* C2065 ‘GLEW_SGIX_vertex_preclip_hint’: undeclared identifier* C2065 ‘GLEW_SGIX_ycrcb’: undeclared identifier* C2065 ‘GLEW_SGIX_ycrcb_subsample’: undeclared identifier* C2065 ‘GLEW_SGIX_ycrcba’: undeclared identifier* C2065 ‘GLEW_SUN_convolution_border_modes’: undeclared identifier* C2065 ‘GLEW_SUN_global_alpha’: undeclared identifier* C2065 ‘GLEW_SUN_mesh_array’: undeclared identifier* C2065 ‘GLEW_SUN_read_video_pixels’: undeclared identifier* C2065 ‘GLEW_SUN_slice_accum’: undeclared identifier* C2065 ‘GLEW_SUN_triangle_list’: undeclared identifier* C2065 ‘GLEW_SUN_vertex’: undeclared identifier* C2065 ‘GLEW_SUNX_constant_data’: undeclared identifier* C2065 ‘GLEW_VERSION’: undeclared identifier* C2065 ‘GLEW_VERSION_1_1’: undeclared identifier* C2065 ‘GLEW_VERSION_1_2’: undeclared identifier* C2065 ‘GLEW_VERSION_1_2_1’: undeclared identifier* C2065 ‘GLEW_VERSION_1_3’: undeclared identifier* C2065 ‘GLEW_VERSION_1_4’: undeclared identifier* C2065 ‘GLEW_VERSION_1_5’: undeclared identifier* C2065 ‘GLEW_VERSION_2_0’: undeclared identifier* C2065 ‘GLEW_VERSION_2_1’: undeclared identifier* C2065 ‘GLEW_VERSION_3_0’: undeclared identifier* C2065 ‘GLEW_VERSION_3_1’: undeclared identifier* C2065 ‘GLEW_VERSION_3_2’: undeclared identifier* C2065 ‘GLEW_VERSION_3_3’: undeclared identifier* C2065 ‘GLEW_VERSION_4_0’: undeclared identifier* C2065 ‘GLEW_VERSION_4_1’: undeclared identifier* C2065 ‘GLEW_VERSION_4_2’: undeclared identifier* C2065 ‘GLEW_VERSION_4_3’: undeclared identifier* C2065 ‘GLEW_VERSION_4_4’: undeclared identifier* C2065 ‘GLEW_VERSION_4_5’: undeclared identifier* C2065 ‘GLEW_VERSION_4_6’: undeclared identifier* C2065 ‘GLEW_VERSION_MAJOR’: undeclared identifier* C2065 ‘GLEW_VERSION_MICRO’: undeclared identifier* C2065 ‘GLEW_VERSION_MINOR’: undeclared identifier* C2065 ‘GLEW_WIN_phong_shading’: undeclared identifier* C2065 ‘GLEW_WIN_scene_markerXXX’: undeclared identifier* C2065 ‘GLEW_WIN_specular_fog’: undeclared identifier* C2065 ‘GLEW_WIN_swap_hint’: undeclared identifier* C3861 ‘GLEW_GET_FUN’: identifier not found* C3861 ‘GLEW_GET_VAR’: identifier not found
Python Error Strings:
* AttributeError: module ‘pxr.Glf’ has no attribute ‘GlewInit’
## Other Breaking Changes
## Schemas
### pluginInfo.json
#### plugInfo json now requires schemaKind field
Without it, schemas may silently fail to load.
For more information on schemaKind, see: [Breaking Change: Schema
Kind]
TODO: more investigation / details
https://nvidia.slack.com/archives/C04190ZMT6U/p1677673185286159
https://nvidia.slack.com/archives/C04190ZMT6U/p1678264560240499
Python Error Strings:
* ‘ApplyAPI: Provided schema type ‘<SCHEMA_NAME>’ is not a single-apply API schema type.’
## Non-Breaking Changes
## Imaging
### Hdx
#### Hdx TaskController
##### Added HdxTaskController SetPresentationOutput
It seems that when SetPresentationOutput was originally added in
22.05, calling it from UsdImagingGLEngine / omni.hydra.pxr’s
SimpleUsdGLEngine.cpp may have been required, but in 22.08 the
functionality was moved to HgiInteropOpenGL
Reference Commits:
* Adding SetPresentationOutput to HdxPresentTask, HdxTaskController.* Adding UsdImagingGLEngine::SetPresentationOutput.* [UsdImagingGL] Removed most direct use of GL from UsdImagingGL… Also, we no longer explicitly set the current draw framebuffer binding as the presentation output in the task controller since the fallback behavior in HgiInteropOpenGL is to present to the current draw framebuffer.
## Upgrading assets and test files
The previous sections cover most of the changes you need to perform to
your code base, i.e. C++, Python files, as well as compilation and
interpretation errors. After following the previous fixes you may still
find that your assets or test files (i.e. your USDs) have stopped
working.
We have implemented forward compatibility tests in Omni Asset
Validation. This is an extension implemented in Kit, at the moment of
writing this document (03/23/2023) the latest version is 0.3.2. Please
refer to the documentation on how to quickly use it with the graphical user interface.
For the scope of this document, please select the Rules of the category
USD Schema.
Those rules will help you out to fix all your documents. Below you will
find some of the common problem:
### UsdGeomSubsetChecker
Problems
* GeomSubset has a material binding but no valid family name attribute.
See
* UsdGeom.Subset
Resolution
* Enable USD Schema / UsdGeomSubsetChecker.* Adds the family name attribute.
### UsdLuxSchemaChecker
Problems
* UsdLux attribute has been renamed to USD 21.02 and should be prefixed with ‘inputs:’.
See
* All properties now prefixed with “inputs:”
Resolution
* Enable USD Schema / UsdLuxSchemaChecker.* Asset Validator will create a new attribute with the prefix “inputs:” for backward and forward compatibility.
### UsdMaterialBindingApi
Problems
* Prim has a material binding but does not have the MaterialBindingApi.
See
* Material bindings require UsdShadeMaterialBindingAPI to be applied
Resolution
* Enable USD Schema / UsdMaterialBindingApi.* Asset Validator will apply UsdShadeMaterialBindingAPI to your prim.
### UsdDanglingMaterialBindingApi
Problems
* Prim has a material binding but the material binding is not found in the stage. The stage may not render properly. Example: https://nvidia-omniverse.atlassian.net/browse/OM-87439
See
* Material bindings require UsdShadeMaterialBindingAPI to be applied
Resolution
* Enable USD Schema / UsdDanglingMaterialBindingApi.* Asset Validator will unbind all bindings to your prim.
## Dumping Ground
A place for extra notes / incomplete items that we don’t want to forget
### Schemas removed
UsdLuxLight
UsdLux.Light to UsdLux.LightAPI
UsdLuxLightPortal
UsdLux.LightPortal to UsdLux.PortalLight
UsdMdlMdlAPI
UsdRenderSettingsAPI
UsdRiLightAPI
UsdRiLightFilterAPI
UsdRiLightPortalAPI
UsdRiPxrAovLight
UsdRiPxrBarnLightFilter
UsdRiPxrCookieLightFilter
UsdRiPxrEnvDayLight
UsdRiPxrIntMultLightFilter
UsdRiPxrRampLightFilter
UsdRiPxrRodLightFilter
UsdRiRiLightFilterAPI
UsdRiRisBxdf
UsdRiRisIntegrator
UsdRiRisObject
UsdRiRisOslPattern
UsdRiRisPattern
UsdRiRslShader
UsdRiTextureAPI
### Schemas added
UsdGeomPlane
UsdGeomVisibilityAPI
UsdHydraGenerativeProceduralAPI
UsdLuxBoundableLightBase
UsdLuxLightAPI
UsdLux.Light to> UsdLux.LightAPI
UsdLuxLightListAPI
UsdLuxMeshLightAPI
UsdLuxNonboundableLightBase
UsdLuxPluginLight
UsdLuxPluginLightFilter
UsdLuxPortalLight
UsdLux.LightPortal to UsdLux.PortalLight
UsdLuxVolumeLightAPI
UsdMdlAPIMdlAPI
UsdPhysicsArticulationRootAPI
UsdPhysicsCollisionAPI
UsdPhysicsCollisionGroup
UsdPhysicsDistanceJoint
UsdPhysicsDriveAPI
UsdPhysicsFilteredPairsAPI
UsdPhysicsFixedJoint
UsdPhysicsJoint
UsdPhysicsMassAPI
UsdPhysicsMaterialAPI
UsdPhysicsMeshCollisionAPI
UsdPhysicsPrismaticJoint
UsdPhysicsRevoluteJoint
UsdPhysicsRigidBodyAPI
UsdPhysicsScene
UsdPhysicsSphericalJoint
UsdRenderDenoisePass
UsdRenderPass
UsdShadeNodeDefAPI
© Copyright 2019-2023, NVIDIA.
Last updated on Nov 14, 2023. |
omni.ui.workspace_utils.restore_workspace.md | restore_workspace — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Submodules »
omni.ui.workspace_utils »
omni.ui.workspace_utils Functions »
restore_workspace
# restore_workspace
omni.ui.workspace_utils.restore_workspace(workspace_dump: List[Any], keep_windows_open=False)
Dock the windows according to the workspace description.
### Arguments
`workspace_dumpList[Any]`The dictionary with the description of the layout. It’s the dict
received from `dump_workspace`.
`keep_windows_openbool`Determines if it’s necessary to hide the already opened windows that
are not present in `workspace_dump`.
© Copyright 2019-2024, NVIDIA.
Last updated on Mar 25, 2024. |
UsdHydra.md | UsdHydra module — pxr-usd-api 105.1 documentation
pxr-usd-api
»
Modules »
UsdHydra module
# UsdHydra module
Summary: The UsdHydra module.
Classes:
GenerativeProceduralAPI
This API extends and configures the core UsdProcGenerativeProcedural schema defined within usdProc for use with hydra generative procedurals as defined within hdGp.
Tokens
class pxr.UsdHydra.GenerativeProceduralAPI
This API extends and configures the core UsdProcGenerativeProcedural
schema defined within usdProc for use with hydra generative
procedurals as defined within hdGp.
For any described attribute Fallback Value or Allowed Values
below that are text/tokens, the actual token is published and defined
in UsdHydraTokens. So to set an attribute to the value”rightHanded”,
use UsdHydraTokens->rightHanded as the value.
Methods:
Apply
classmethod Apply(prim) -> GenerativeProceduralAPI
CanApply
classmethod CanApply(prim, whyNot) -> bool
CreateProceduralSystemAttr(defaultValue, ...)
See GetProceduralSystemAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
CreateProceduralTypeAttr(defaultValue, ...)
See GetProceduralTypeAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
Get
classmethod Get(stage, path) -> GenerativeProceduralAPI
GetProceduralSystemAttr()
This value should correspond to a configured instance of HdGpGenerativeProceduralResolvingSceneIndex which will evaluate the procedural.
GetProceduralTypeAttr()
The registered name of a HdGpGenerativeProceduralPlugin to be executed.
GetSchemaAttributeNames
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
static Apply()
classmethod Apply(prim) -> GenerativeProceduralAPI
Applies this single-apply API schema to the given prim .
This information is stored by adding”HydraGenerativeProceduralAPI”to
the token-valued, listOp metadata apiSchemas on the prim.
A valid UsdHydraGenerativeProceduralAPI object is returned upon
success. An invalid (or empty) UsdHydraGenerativeProceduralAPI object
is returned upon failure. See UsdPrim::ApplyAPI() for conditions
resulting in failure.
UsdPrim::GetAppliedSchemas()
UsdPrim::HasAPI()
UsdPrim::CanApplyAPI()
UsdPrim::ApplyAPI()
UsdPrim::RemoveAPI()
Parameters
prim (Prim) –
static CanApply()
classmethod CanApply(prim, whyNot) -> bool
Returns true if this single-apply API schema can be applied to the
given prim .
If this schema can not be a applied to the prim, this returns false
and, if provided, populates whyNot with the reason it can not be
applied.
Note that if CanApply returns false, that does not necessarily imply
that calling Apply will fail. Callers are expected to call CanApply
before calling Apply if they want to ensure that it is valid to apply
a schema.
UsdPrim::GetAppliedSchemas()
UsdPrim::HasAPI()
UsdPrim::CanApplyAPI()
UsdPrim::ApplyAPI()
UsdPrim::RemoveAPI()
Parameters
prim (Prim) –
whyNot (str) –
CreateProceduralSystemAttr(defaultValue, writeSparsely) → Attribute
See GetProceduralSystemAttr() , and also Create vs Get Property
Methods for when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
CreateProceduralTypeAttr(defaultValue, writeSparsely) → Attribute
See GetProceduralTypeAttr() , and also Create vs Get Property Methods
for when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
static Get()
classmethod Get(stage, path) -> GenerativeProceduralAPI
Return a UsdHydraGenerativeProceduralAPI holding the prim adhering to
this schema at path on stage .
If no prim exists at path on stage , or if the prim at that
path does not adhere to this schema, return an invalid schema object.
This is shorthand for the following:
UsdHydraGenerativeProceduralAPI(stage->GetPrimAtPath(path));
Parameters
stage (Stage) –
path (Path) –
GetProceduralSystemAttr() → Attribute
This value should correspond to a configured instance of
HdGpGenerativeProceduralResolvingSceneIndex which will evaluate the
procedural.
The default value of”hydraGenerativeProcedural”matches the equivalent
default of HdGpGenerativeProceduralResolvingSceneIndex. Multiple
instances of the scene index can be used to determine where within a
scene index chain a given procedural will be evaluated.
Declaration
token proceduralSystem ="hydraGenerativeProcedural"
C++ Type
TfToken
Usd Type
SdfValueTypeNames->Token
GetProceduralTypeAttr() → Attribute
The registered name of a HdGpGenerativeProceduralPlugin to be
executed.
Declaration
token primvars:hdGp:proceduralType
C++ Type
TfToken
Usd Type
SdfValueTypeNames->Token
static GetSchemaAttributeNames()
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
Return a vector of names of all pre-declared attributes for this
schema class and all its ancestor classes.
Does not include attributes that may be authored by custom/extended
methods of the schemas involved.
Parameters
includeInherited (bool) –
class pxr.UsdHydra.Tokens
Attributes:
HwPrimvar_1
HwPtexTexture_1
HwUvTexture_1
black
clamp
displayLookBxdf
faceIndex
faceOffset
frame
hydraGenerativeProcedural
infoFilename
infoVarname
linear
linearMipmapLinear
linearMipmapNearest
magFilter
minFilter
mirror
nearest
nearestMipmapLinear
nearestMipmapNearest
primvarsHdGpProceduralType
proceduralSystem
repeat
textureMemory
useMetadata
uv
wrapS
wrapT
HwPrimvar_1 = 'HwPrimvar_1'
HwPtexTexture_1 = 'HwPtexTexture_1'
HwUvTexture_1 = 'HwUvTexture_1'
black = 'black'
clamp = 'clamp'
displayLookBxdf = 'displayLook:bxdf'
faceIndex = 'faceIndex'
faceOffset = 'faceOffset'
frame = 'frame'
hydraGenerativeProcedural = 'hydraGenerativeProcedural'
infoFilename = 'inputs:file'
infoVarname = 'inputs:varname'
linear = 'linear'
linearMipmapLinear = 'linearMipmapLinear'
linearMipmapNearest = 'linearMipmapNearest'
magFilter = 'magFilter'
minFilter = 'minFilter'
mirror = 'mirror'
nearest = 'nearest'
nearestMipmapLinear = 'nearestMipmapLinear'
nearestMipmapNearest = 'nearestMipmapNearest'
primvarsHdGpProceduralType = 'primvars:hdGp:proceduralType'
proceduralSystem = 'proceduralSystem'
repeat = 'repeat'
textureMemory = 'textureMemory'
useMetadata = 'useMetadata'
uv = 'uv'
wrapS = 'wrapS'
wrapT = 'wrapT'
© Copyright 2019-2023, NVIDIA.
Last updated on Nov 14, 2023. |
extensions_advanced.md | Extensions in-depth — kit-manual 105.1 documentation
kit-manual
»
Extensions in-depth
# Extensions in-depth
## What is an Extension?
An extension is, in its simplest form, just a folder with a config file (extension.toml). The Extension system will find that extension and if it’s enabled it will do whatever the config file tells it to do, which may include loading python modules, Carbonite plugins, shared libraries, applying settings etc.
There are many variations, you can have an extension whose sole purpose is just to enable 10 other extensions for example, or just apply some settings.
## Extension in a single folder
Everything that an extension has should be contained or nested within its root folder. This is a convention we are trying to adhere to. Looking at other package managers, like those in the Linux ecosystem, the content of packages can be spread across the filesystem, which makes some things easier (like loading shared libraries), but also creates many other problems.
Following this convention makes the installation step very simple - we just have to unpack a single folder.
A typical extension might look like this:
[extensions-folder]
└── omni.appwindow
│──bin
│ └───windows-x86_64
│ └───debug
│ └─── omni.appwindow.plugin.dll
│───config
│ └─── extension.toml
└───omni
└───appwindow
│─── _appwindow.cp37-win_amd64.pyd
└─── __init__.py
This example contains a Carbonite plugin and a python module (which contains the bindings to this plugin).
## Extension Id
Extension id consists of 3 parts: [ext_name]-[ext_tag]-[ext_version]:
[ext_name]: Extension name. Extension folder or kit file name.
[ext_tag]: Extension tag. Optional. Used to have different implementations of the same extension. Also part of folder or kit file name.
[ext_version]: Extension version. Defined in extension.toml. Can also be part of folder name, but ignored there.
Extension id example: omni.kit.commands-1.2.3-beta.1. Extension name is omni.kit.commands. Version is 1.2.3-beta.1. Tag is empty.
## Extension Version
Version is defined in [package.version] config field.
Semantic Versioning is used. A good example of valid and invalid versions: link
In short, it is [major].[minor].[patch]-[prerelease]. Express compatibility with version change:
For breaking change increment major version
For backwards compatible change increment minor version
For bugfixes increment patch version
Use [prerelease] part to test a new version e.g. 1.2.3-beta.1
## Extension Package Id
Extension package id is extension id plus build metadata. [ext_id]+[build_meta].
One extension id can have 1 or multiple packages in order to support different targets. It is common for binary extensions to have packages like:
[ext_id]+wx64.r - windows-x86_64, release config.
[ext_id]+lx64.r - linux-x86_64, release config.
[ext_id]+lx64.d - linux-x86_64, debug config.
…
Python version or kit version can also denote different target. Refer to [package.target] section of extension config.
## Single File Extensions
Single file Extensions are supported - i.e. Extensions consisting only of a config file, without any code. In this case the name of the config will be used as the extension ID. This is used to make a top-level extension which we call an app. They are used as an application entry point, to unroll the whole extension tree.
The file extension can be anything (.toml for instance), but the recommendation is to name them with the .kit file extension, so that it can be associated with the kit.exe executable and launched with a single click.
[extensions-folder]
└── omni.exp.hello.kit
## App Extensions
When .kit files are passed to kit.exe they are treated specially:
This: > kit.exe C:/abc/omni.exp.hello.kit
Is the same as: > kit.exe --ext-path C:/abc/omni.exp.hello.kit --enable omni.exp.hello
It adds this .kit file as an extension and enables it, ignoring any default app configs, and effectively starting an app.
Single file (.kit file) extensions are considered apps, and a “launch” button is added to it in the UI of the extension browser. For regular extensions, specify the keyword: package.app = true in the config file to mark your extension as an app that users can launch.
App extensions can be published, versioned, etc. just like normal extensions. So for instance if the omni.exp.hello example from above is published, we can just run Kit as:
> kit.exe omni.exp.hello.kit
Kit will pull it from the registry and start.
## Extension Search Paths
Extensions are automatically searched for in specified folders.
Core Kit config kit-core.json specifies default search folders in /app/exts/foldersCore setting. This way Kit can find core extensions, it also looks for extensions in system-specific documents folders for user convenience.
To add more folders to search paths there are a few ways:
Pass --ext-folder [PATH] CLI argument to kit.
Add to array in settings: /app/exts/folders
Use the omni::ext::ExtensionManager::addPath API to add more folders (also available in python).
To specify direct path to a specific extension use the /app/exts/paths setting or the --ext-path [PATH] CLI argument.
Folders added last are searched first. This way they will be prioritized over others, allowing the user to override existing extensions.
Example of adding an extension seach path in a kit file:
[settings.app.exts]
folders.'++' = [
"C:/hello/my_extensions"
]
### Custom Search Paths Protocols
Both folders and direct paths can be extended to support other url schemes. If no scheme is specified, they are assumed to be local filesystem. The extension system provides APIs to implement custom protocols. This way an extension can be written to enable searching for extensions in different locations, for example: git repos.
E.g. --ext-folder foo://abc/def – The extension manager will redirect this search path to the implementor of the foo scheme, if it was registered.
### Git URL as Extension Search Paths
Extension omni.kit.extpath.git implements following extension search path schemes: git, git+http, git+https, git+ssh.
Optional URL query params are supported:
dir subdirectory of a git repo to use as a search path (or direct path).
branch git branch to checkout
tag git tag to checkout
sha git sha to checkout
Example of usage with cmd arg:
--ext-folder git://github.com/bob/somerepo.git?branch=main&dir=exts – Add exts subfolder and main branch of this git repo as extension search paths.
Example of usage in kit file:
[settings.app.exts]
folders.'++' = [
"git+https://gitlab-master.nvidia.com/bob/some-repo.git?dir=exts&branch=feature"
]
After the first checkout, the git path is cached into global cache. To pull updates:
use extension manager properties pages
setting: --/exts/omni.kit.extpath.git/autoUpdate=1
API call omni.kit.extpath.git.update_all_git_paths()
The Extension system automatically enables this extension if a path with a scheme is added. It enables extensions specified in a setting: app/extensions/pathProtocolExtensions, which by default is ["omni.kit.extpath.git"].
Note
Git installation is required for this functionality. It expects the git executable to be available in system shell.
## Extension Discovery
The Extension system monitors any specified extension search folders (or direct paths) for changes. It automatically syncs all changed/added/removed extensions. Any subfolder which contains an extension.toml in the root or config folder is considered to be an extension.
The subfolder name uniquely identifies the extension and is used to extract the extension name and tag: [ext_name]-[ext_tag]
[extensions-folder]
└── omni.kit.example-gpu-2.0.1-stable.3+cp37
├── extension.toml
└── ...
In this example we have an extension omni.kit.example-gpu-2.0.1-stable.3+cp37, where:
name: omni.kit.example
tag: gpu (optional, default is “”)
The version and other information (like supported platforms) are queried in the extension config file (see below). They may also be included in the folder name, which is what the system does with packages downloaded from a remote registry, but that is not “the ground truth” for that data. So in this example anything could have been after the “gpu” tag, e.g. omni.kit.example-gpu-whatever.
## Extension Dependencies
When a Kit-based application starts, it discovers all extensions and does nothing with them until some of them are enabled, whether via config file or API. Each extension can depend on other extensions and this is where the whole application tree can unroll. The user may enable a high level extension like omni.usd_viewer which will bring in dozens of others.
An extension can express dependencies on other extensions using name, version and optionally tag. It is important to keep extensions versioned properly and express breaking changes using Semantic Versioning.
This is a good place to grasp what tag is for. If extension foo depends on bar, you might implement other versions of bar, like: bar-light, bar-prototype. If they still fulfill the same API contract and expected behavior, you can safely substitute bar without foo noticing. In other words if the extension is an interface, tag is the implementation.
The effect is that just enabling some high-level extensions like omni.kit.window.script_editor will expand the whole dependency tree in the correct order without the user having to specify all of them or worry about initialization order.
One can also substitute extensions in a tree with a different version or tag, towards the same end-user experience, but having swapped in-place a different low-level building block.
When an extension is enabled, the manager tries to satisfy all of its dependencies by recursively solving the dependency graph. This is a difficult problem - If dependency resolution succeeds the whole dependency tree is enabled in-order so that all dependents are enabled first. The opposite is true for disabling extensions. All extensions which depend on the target extension are disabled first. More details on the dependency system can be found in the C++ unit tests: source/tests/test.unit/ext/TestExtensions.cpp
A Dependency graph defines the order in which extensions are loaded - it is sorted topologically. There are however, many ways to sort the same graph (think of independent branches). To give finer control over startup order, the order parameters can be used. Each extension can use core.order config parameter to define its order and the order of dependencies can also be overriden with order param in [[dependencies]] section. Those with lower order will start sooner. If there are multiple extensions that depend on one extension and are trying to override this order then the one that is loaded last will be used (according to dependency tree). In summary - the dependency order is always satisfied (or extensions won’t be started at all, if the graph contains cycles) and soft ordering is applied on top using config params.
## Extension configuration file (extension.toml)
An Extension config file can specify:
Dependencies to import
Settings
A variety of metadata/information which are used by the Extension Registry browser (for example)
TOML is the format used. See this short toml tutorial.
Note in particular the [[]] TOML syntax for arrays of objects and quotes around keys which contain special symbols(e.g. "omni.physx").
The config file should be placed in the root of the extension folder or in a config subfolder.
Note
All relative paths in configs are relative to the extension folder. All paths accept tokens. (like ${platform}, ${config}, ${kit} etc). More info: Tokens.
There are no mandatory fields in a config, so even with an empty config, the extension will be considered valid and can be enabled - without any effect.
Next we will list all the config fields the extension system uses, though a config file may contain more. The Extension system provides a mechanism to query config files and hook into itself. That allows us to extend the extension system itself and add new config sections. For instance omni.kit.pipapi allows extensions to specify pip packages to be installed before enabling them. More info on that: Hooks. That also means that typos or unknown config settings will be left as-is and no warning will be issued.
### Config Fields
#### [core] section
For generic extension properties. Used directly by the Extension Manager core system.
##### [core.reloadable] (default: true)
Is the extension reloadable? The Extension system will monitor the extension’s files for changes and try to reload the extension when any of them change. If the extension is marked as non-reloadable, all other extensions that depend on it are also non-reloadable.
##### [core.order] (default: 0)
When extensions are independent of each other they are enabled in an undefined order. An extension can be ordered to be before (negative) or after (positive) other extensions
#### [package] section
Contains information used for publishing extensions and displaying user-facing details about the package.
##### [package.version] (default: "0.0.0")
Extension version. This setting is required in order to publish extensions to the remote registry. The Semantic Versioning concept is baked into the extension system, so make sure to follow the basic rules:
Before you reach 1.0.0, anything goes, but if you make breaking changes, increment the minor version.
After 1.0.0, only make breaking changes when you increment the major version.
Incrementing the minor version implies a backward-compatible change. Let’s say extension bar depends on foo-1.2.0. That means that foo-1.3.0, foo-1.4.5, etc.. are also suitable and can be enabled by extension system.
Use version numbers with three numeric parts such as 1.0.0 rather than 1.0.
Prerelease labels can also be used like so: 1.3.4-beta, 1.3.4-rc1.test.1, or 1.3.4-stable.
##### [package.title] default: ""
User-facing package name, used for UI.
##### [package.description] default: ""
User facing package description, used for UI.
##### [package.category] (default: "")
Extension category, used for UI. One of:
animation
graph
rendering
audio
simulation
example
internal
other
##### [package.app] (default: false)
Whether the extension is an App. Used to mark extension as an app in the UI. Adds a “Launch” button to run kit with only this extension (and its dependents) enabled. For single-file extensions (.kit files), it defaults to true.
##### [package.feature] (default: false)
Extension is a Feature. Used to show user-facing extensions, suitable to be enabled by the user from the UI. By default, the app can choose to show only those feature extensions.
##### [package.toggleable] (default: true)
Indicates whether an extension can be toggled (i.e enabled/disabled) by the user from the UI. There is another related setting: [core.reloadable], which can prevent the user from disabling an extension in the UI.
##### [package.authors] (default: [""])
Lists people or organizations that are considered the “authors” of the package. Optionally include email addresses within angled brackets after each author.
##### [package.repository] (default: "")
URL of the extension source repository, used for display in the UI.
##### [package.keywords] (default: [""])
Array of strings that describe this extension. Helpful when searching for it in an Extension registry.
##### [package.changelog] (default: "")
Location of a CHANGELOG.MD file in the target (final) folder of the Extension, relative to the root. The UI will load and show it. We can also insert the content of that file inline instead of specifying a filepath. It is important to keep the changelog updated when new versions of an extension are released and published.
For more info on writing changelogs refer to Keep a Changelog
##### [package.readme] (default: "")
Location of README file in the target (final) folder of an extension, relative to the root. The UI will load and show it. We can also insert the content of that file inline instead of specifying a filepath.
##### [package.preview_image] (default: "")
Location of a preview image in the target (final) folder of extension, relative to the root. The preview image is shown in the “Overview” of the extension in the Extensions window. A screenshot of your extension might make a good preview image.
##### [package.icon] (default: "")
Location of the icon in the target (final) folder of extension, relative to the root. Icon is shown in Extensions window. Recommended icon size is 256x256 pixels.
##### [package.target]
This section is used to describe the target platform this extension runs on - this is fairly arbitrary, but can include:
Operating system
CPU architecture
Python version
Build configuration
The Extension system will filter out extensions that doesn’t match the current environment/platform. This is particularly important for extensions published and downloaded from a remote Extension registry.
Normally you don’t need to fill this section in manually. When extensions are published, this will be automatically filled in with defaults, more in Publishing Extensions. But it can be overriden by setting:
package.target.kit (default: ["*"] – Kit version (major.minor), e.g. "101.0", "102.3".
package.target.kitHash (default: ["*"] – Kit git hash (8 symbols), e.g. "abcdabcd"
package.target.config (default: ["*"] – Build config, e.g. "debug", "release".
package.target.platform (default: ["*"] – Build platform, e.g. "windows-x86_64", "linux-aarch64".
package.target.python (default: ["*"] – Python version, e.g. "cp37" (cpython 3.7). Refer to PEP 0425.
Wildcards can be used. A full example:
[package.target]
config = ["debug"]
platform = ["linux-*", "windows"]
python = ["*"]
##### [package.writeTarget]
This section can be used to explicitly control if [package.target] should be written. By default it is written based on rules described in Extension Publishing. But if for some [target] a field is set, such as package.writeTarget.[target] = true/false, that tells explicitly whether it should automatically be filled in.
For example if you want to target a specific kit version to make the extension only work with that version, set:
[package]
writeTarget.kit = true
Or if you want your extension to work for all python versions, write:
[package]
writeTarget.python = false
The list of known targets is the same as in the [package.target] section: kit, config, platform, python.
#### [dependencies] section
This section is used to describe which extensions this extension depends on. The extension system will guarantee they are enabled before it loads your extension (assuming that it doesn’t fail to enable any component). One can optionally specify a version and tag per dependency, as well as make a dependency optional.
Each entry is a name of other extension. It may or may not additionally specify: tag, version, optional, exact:
"omni.physx" = { version="1.0", "tag"="gpu" }
"omni.foo" = { version="3.2" }
"omni.cool" = { optional = true }
Note that it is highly recommended to use versions, as it will help maintain stability for extensions (and the whole application) - i.e if a breaking change happens in a dependency and dependents have not yet been updated, an older version can still be used instead. (only the major and minor parts are needed for this according to semver).
optional (default: false) – will mean that if the extension system can’t resolve this dependency the extension will still be enabled. So it is expected that the extension can handle the absence of this dependency. Optional dependencies are not enabled unless they are a non-optional dependency of some other extension which is enabled, or if they are enabled explicitly (using API, settings, CLI etc).
exact (default: false) – only an exact version match of extension will be used. This flag is experimental and may change.
order (default: None) – override the core.order parameter of an extension that it depends on. Only applied if set.
#### [python] section
If an extension contains python modules or scripts this is where to specify them.
##### [[python.module]]
Specifies python module(s) that are part of this extension. Multiple can be specified. Take notice the [[]] syntax.
When an extension is enabled, modules are imported in order. Here we specify 2 python modules to be imported (import omni.hello and import omni.calculator).
When modules are scheduled for import this way, they will be reloaded if the module is already present.
Example:
[[python.module]]
name = "omni.hello"
[[python.module]]
name = "omni.calculator"
path = "."
public = true
name (required) – python module name, can be empty. Think of it as what will be imported by other extensions that depend on you:
import omni.calculator
public (default: true) – If public, a module will be available to be imported by other extensions (extension folder is added to sys.path). Non-public modules have limited support and their use is not recommended.
path (default: ".") – Path to the root folder where the python module is located. If written as relative, it is relative to extension root. Think of it as what gets added to sys.path. By default the extension root folder is added if any [[python.module]] directive is specified.
searchExt (default: true) – If true, imports said module and launches the extensions search routine within the module. If false, only the module is imported.
By default the extension system uses a custom fast importer. Fast importer only looks for python modules in extension root subfolders that correspond to the module namespace. In the example above it would only look in [ext root]/omni/**. If you have other subfolders that contain python modules you at least need to specify top level namespace. E.g. if you have also foo.bar in [ext root]/foo/bar.py:
[[python.module]]
name = "foo"
Would make it discoverable by fast importer. You can also just specify empty name to make importer search all subfolders:
[[python.module]]
path = "."
Example of that is in omni.kit.pip_archive which brings a lot of different modules, which would be tedious to list.
##### [[python.scriptFolder]]
Script folders can be added to IAppScripting, and they will be searched for when a script file path is specified to executed (with –exec or via API).
Example:
[[python.scriptFolder]]
path = "scripts"
path (required) – Path to the script folder to be added. If the path is relative it is relative to the extension root.
#### [native] section
Used to specify Carbonite plugins to be loaded.
##### [[native.plugin]]
When an Extension is enabled, the Extension system will search for Carbonite plugins using path pattern and load all of them. It will also try to acquire the omni::ext::IExt interface if any of the plugins implements it. That provides an optional entry point in C++ code where your extension can be loaded.
When an extension is disabled it releases any acquired interfaces which may lead to plugins being unloaded.
Example:
[[native.plugin]]
path = "bin/${platform}/${config}/*.plugin"
recursive = false
path (required) – Path to search for Carbonite plugins, may contain wildcards and Tokens).
recursive (default: false) – Search recursively in folders.
##### [[native.library]] section
Used to specify shared libraries to load when an Extension is enabled.
When an Extension is enabled the Extension system will search for native shared libraries using path and load them. This mechanism is useful to “preload” libraries needed later, avoid OS specific calls in your code, and the use of PATH/LD_LIBRARY_PATH etc to locate and load DSOs/DLLs. With this approach we just load the libraries needed directly.
When an extension is disabled it tries to unload those shared libraries.
Example:
[[native.library]]
path = "bin/${platform}/${config}/foo.dll"
path (required) – Path to search for shared libraries, may contain wildcards and Tokens.
#### [settings] section
Everything under this section is applied to the root of the global Carbonite settings (carb.settings.plugin). In case of conflict, the original setting is kept.
It is good practice to namespace your settings with your extension name and put them all under the exts root key, e.g.:
[settings]
exts."omni.kit.renderer.core".compatibilityMode = true
Note
Quotes are used here to distinguish between the . of a toml file and the . in the name of extension.
An important detail is that settings are applied in reverse order of extension startup (before any extensions start) and they don’t override each other. Therefore a parent extension can specify settings for child extensions to use.
#### [[env]] section
This section is used to specify one or more environment variables to set when an extension is enabled. Just like settings, env vars are applied in reverse order of startup.
They don’t by default override if already set, but override behavior does allow parent extensions to override env vars of extensions they depend on.
Example:
[[env]]
name = "HELLO"
value = "123"
isPath = false
append = false
override = false
platform = "windows-x86_64"
name (required) – Environment variable name.
value (required) – Environment variable value to set.
isPath (default: false) – Treat value as path. If relative it is relative to the extension root folder. Tokens can also be used as within any path.
append (default: false) – Append value to already set env var if any. Platform-specific separators will be used.
override (default: false) – Override value of already set env var if any.
platform (default: "") – Set only if platform matches pattern. Wildcards can be used.
#### [fswatcher] section
Used to specify file system watcher used by the Extension system to monitor for changes in extensions and auto reload.
##### [fswatcher.patterns]
Specify files that are monitored.
include (default: ["*.toml", "*.py"]) – File patterns to include.
exclude (default: []) – File patterns to exclude.
Example:
[fswatcher.patterns]
include = ["*.toml", "*.py", "*.txt"]
exclude = ["*.cache"]
##### [fswatcher.paths]
Specify folders that are monitored. FS watcher will use OS specific API to listen for changes on those folders. You can use that setting that limit amount of subscriptions if your extensions has too many folders inside.
Simple path as string pattern matching is used, where ‘*’ means any amount of symbols. Patterns like */123* will match abc/123/def, abc/123, abc/1234.
‘/’ path separator is used on all platforms. Matching paths are relative to extension root, they begin and end with ‘/’.
include (default: ["*/config/*", "*/./*"] and python modules) – Folder path patterns to include.
exclude (default: ["*/__pycache__/*", "*/.git/*"]) – Folder path patterns to exclude.
Example:
[fswatcher.paths]
include = ["*/config"]
exclude = ["*/data*"]
#### [[test]] section
This section is read only by the testing system (omni.kit.test extension) when running per-extension tests. Extension tests are run as a separate process where only the tested extension is enabled and runs all the tests that it has. Usually this section can be left empty, but extensions can specify additional extensions (which are not a part of their regular dependencies, or when the dependency is optional), additional cmd arguments, or filter out (or in) any additional stdout messages.
Each [[test]] entry will run a separate extension test process.
Extension tests run in the context of an app. An app can be empty, which makes extension test isolated and only its dependencies are enabled. Testing in an empty app is the minimal recommended test coverage. Extension developers can then opt-in to be tested in other apps and fine-tune their test settings per app.
Example:
[[test]]
name = "default"
enabled = true
apps = [""]
args = ["-v"]
dependencies = ["omni.kit.capture"]
pythonTests.include = ["omni.foo.*"]
pythonTests.exclude = []
cppTests.libraries = ["bin/${lib_prefix}omni.appwindow.tests${lib_ext}"]
timeout = 180
parallelizable = true
unreliable = false
profiling = false
pyCoverageEnabled = false
waiver = ""
stdoutFailPatterns.include = ["*[error]*", "*[fatal]*"]
stdoutFailPatterns.exclude = [
"*Leaking graphics objects*", # Exclude grahics leaks until fixed
]
name – Test process name. If there are multiple [[test]] entries, this name must be unique.
enabled – If tests are enabled. By default it is true. Useful to disable tests per platform.
apps – List of apps to use this test configuration for. Used in case there are multiple [[test]] entries. Wildcards are supported. Defaults to [""] which is an empty app.
args – Additional cmd arguments to pass into the extension test process.
dependencies – List of additional extensions to enable when running the extension tests.
pythonTests.include – List of tests to run. If empty, python modules are used instead ([[python.module]]), since all tests names start with module they are defined in. Can contain wildcards.
pythonTests.exclude – List of tests to exclude from running. Can contain wildcards.
cppTests.libraries – List of shared libraries with C++ doctests to load.
timeout (default: 180) – Test process timeout (in seconds).
parallelizable (default: true) – Whether the test processes can run in parallel relative to other test processes.
unreliable (default: false) – If marked as unreliable, test failures won’t fail a whole test run.
profiling (default: true) – Collects and outputs Chrome trace data via carb profiling for CPU events for the test process.
pyCoverageEnabled (default: false) – Collects python code coverage using Coverage.py.
waiver – String explaining why an extension contains no tests.
stdoutFailPatterns.include – List of additional patterns to search stdout for and mark as a failure. Can contain wildcards.
stdoutFailPatterns.exclude – List of additional patterns to search stdout for and exclude as a test failure. Can contain wildcards.
#### [documentation] section
This section is read by the omni.kit.documenation.builder extension, and is used to specify a list of markdown files for in-app API documentation and offline sphinx generation.
Example:
[documentation]
pages = ["docs/Overview.md"]
menu = "Help/API/omni.kit.documentation.builder"
title = "Omni UI Documentation Builder"
pages – List of .md file paths, relative to the extension root.
menu – Menu item path to add to the popup in-app documentation window.
title – Title of the documentation window.
### Config Filters
Any part of a config can be filtered based on the current platform or build configuration. Use "filter:platform"."[platform_name]" or "filter:config"."[build_config]" pair of keys. Anything under those keys will be merged on top of the tree they are located in (or filtered out if it doesn’t apply).
filter
values
platform
windows-x86_64, linux-x86_64
config
debug, release
To understand, here are some examples:
[dependencies]
"omni.foo" = {}
"filter:platform"."windows-x86_64"."omni.fox" = {}
"filter:platform"."linux-x86_64"."omni.owl" = {}
"filter:config"."debug"."omni.cat" = {}
After loading that extension on a Windows debug build, it would resolve to:
[dependencies]
"omni.foo" = {}
"omni.fox" = {}
"omni.cat" = {}
Note
You can debug this behavior by running in debug mode, with --/app/extensions/debugMode=1 setting and looking into the log file.
### Example
Here is a full example of an extension.toml file:
[core]
reloadable = true
order = 0
[package]
version = "0.1.0"
category = "Example"
feature = false
app = false
title = "The Best Package"
description = "long and boring text.."
authors = ["John Smith <[email protected]>"]
repository = "https://gitlab-master.nvidia.com/omniverse/kit"
keywords = ["banana", "apple"]
changelog = "docs/CHANGELOG.md"
readme = "docs/README.md"
preview_image = "data/preview.png"
icon = "data/icon.png"
# writeTarget.kit = true
# writeTarget.kitHash = true
# writeTarget.platform = true
# writeTarget.config = true
# writeTarget.python = true
[dependencies]
"omni.physx" = { version="1.0", "tag"="gpu" }
"omni.foo" = {}
# Modules are loaded in order. Here we specify 2 python modules to be imported (``import hello`` and ``import omni.physx``).
[[python.module]]
name = "hello"
path = "."
public = false
[[python.module]]
name = "omni.physx"
[[python.scriptFolder]]
path = "scripts"
# Native section, used if extension contains any Carbonite plugins to be loaded
[[native.plugin]]
path = "bin/${platform}/${config}/*.plugin"
recursive = false # false is default, hence it is optional
# Library section. Shared libraries will be loaded when the extension is enabled, note [[]] toml syntax for array of objects.
[[native.library]]
path = "bin/${platform}/${config}/foo.dll"
# Settings. They are applied on the root of global settings. In case of conflict original settings are kept.
[settings]
exts."omni.kit.renderer.core".compatibilityMode = true
# Environment variables. Example of adding "data" folder in extension root to PATH on Windows:
[[env]]
name = "PATH"
value = "data"
isPath = true
append = true
platform = "windows-x86_64"
# Fs Watcher patterns and folders. Specify which files are monitored for changes to reload an extension. Use wildcard for string matching.
[fswatcher]
patterns.include = ["*.toml", "*.py"]
patterns.exclude = []
paths.include = ["*"]
paths.exclude = ["*/__pycache__*", "*/.git*"]
[documentation]
pages = ["docs/Overview.md"]
menu = "Help/API/omni.kit.documentation.builder"
title = "Omni UI Documentation Builder"
## Extension Enabling/Disabling
Extensions can be enabled and disabled at runtime using the provided API. The default Create application comes with an Extension Manager UI which shows all the available extensions and allows a user to toggle them. An App configuration file can also be used to control which extensions are to be enabled.
You may also use command-line arguments to the Kit executable (or any Omniverse App based on Kit) to enable specific extensions:
Example: > kit.exe --enable omni.kit.window.console --enable omni.kit.window.extensions
--enable adds the chosen extension to the “enabled list”. The command above will start only extensions needed to show those 2 windows.
### Python Modules
Enabling an extension loads the python modules specified and searches for children of :class:omni.ext.IExt class. They are instantiated and the on_startup method is called, e.g.:
hello.py
import omni.ext
class MyExt(omni.ext.IExt):
def on_startup(self, ext_id):
pass
def on_shutdown(self):
pass
When an extension is disabled, on_shutdown is called and all references to the extension object are released.
### Native Plugins
Enabling an extension loads all Carbonite plugins specified by search masks in the native.plugin section. If one or more plugins implement the omni::ext::IExt interface, it is acquired and the onStartup method is called.
When an extension is disabled, onShutdown is called and the interface is released.
### Settings
Settings to be applied when an extension is enabled can be specified in the settings section. They are applied on the root of global settings. In case of any conflicts, the original settings are kept. It is recommended to use the path exts/[extension_name] for extension settings, but in general any path can be used.
It is also good practice to document each setting in the extension.toml file, for greater discoverability of which settings a particular extension supports.
### Tokens
When extension is enabled it sets tokens into the Carbonite ITokens interface with a path to the extension root folder. E.g. for the extension omni.foo-bar, the tokens ${omni.foo} and ${omni.foo-bar} are set.
## Extensions Manager
### Reloading
Extensions can be hot reloaded. The Extension system monitors the file system for changes to enabled extensions. If it finds any, the extensions are disabled and enabled again (which can involve reloading large parts of the dependency tree). This allows live editing of python code and recompilation of C++ plugins.
Use the fswatcher.patterns and fswatcher.paths config settings (see above) to control which files change triggers reloading.
Use the reloadable config setting to disable reloading. This will also block the reloading of all extensions this extension depends on. The extension can still be unloaded directly using the API.
New extensions can also be added and removed at runtime.
### Extension interfaces
The Extension manager is implemented in omni.ext.plugin, with an interface:
omni::ext::IExtensions (for C++), and omni.ext module (for python)
It is loaded by omni.kit.app and you can get an extension manager instance using its interface:
omni::kit::IApp (for C++) and omni.kit.app (for python)
### Runtime Information
At runtime, a user can query various pieces of information about each extension. Use omni::ext::IExtensions::getExtensionDict() to get a dictionary for each extension with all the relevant information.
For python use omni.ext.ExtensionManager.get_extension_dict().
This dictionary contains:
Everything the extension.toml contains under the same path
An additional state section which contains:
state/enabled (bool): Indicates if the extension is currently enabled.
state/reloadable (bool): Indicates if the extension can be reloaded (used in the UI to disable extension unloading/reloading)
### Hooks
Both the C++ and python APIs for the Extension system provide a way to hook into certain actions/phases of the Extension System to enable extending it. If you register a hook like this:
def on_before_ext_enabled(self, ext_id: str, *_):
pass
manager = omni.kit.app.get_app_interface().get_extension_manager()
self._hook = self._manager.get_hooks().create_extension_state_change_hook(
self.on_before_ext_enabled,
omni.ext.ExtensionStateChangeType.BEFORE_EXTENSION_ENABLE,
ext_dict_path="python/pipapi",
hook_name="python.pipapi",
)
…your callback will be called before each extension that contain the “python/pipapi” key in a config file is enabled. This allows us to write extension that extend the Extension system. They can define their own configuration settings and react to them when extensions which contain those settings get loaded.
### Extension API Code Examples
#### Enable Extension
# Extensions/Enable Extension
import omni.kit.app
manager = omni.kit.app.get_app().get_extension_manager()
# enable immediately
manager.set_extension_enabled_immediate("omni.kit.window.about", True)
print(manager.is_extension_enabled("omni.kit.window.about"))
# or next update (frame), multiple commands are be batched
manager.set_extension_enabled("omni.kit.window.about", True)
manager.set_extension_enabled("omni.kit.window.console", True)
#### Get All Extensions
# Extensions/Get All Extensions
import omni.kit.app
# there are a lot of extensions, print only first N entries in each loop
PRINT_ONLY_N = 10
# get all registered local extensions (enabled and disabled)
manager = omni.kit.app.get_app().get_extension_manager()
for ext in manager.get_extensions()[:PRINT_ONLY_N]:
print(ext["id"], ext["package_id"], ext["name"], ext["version"], ext["path"], ext["enabled"])
# get all registered non-local extensions (from the registry)
# this call blocks to download registry (slow). You need to call it at least once, or use refresh_registry() for non-blocking.
manager.sync_registry()
for ext in manager.get_registry_extensions()[:PRINT_ONLY_N]:
print(ext["id"], ext["package_id"], ext["name"], ext["version"], ext["path"], ext["enabled"])
# functions above print all versions of each extension. There is other API to get them grouped by name (like in ext manager UI).
# "enabled_version" and "latest_version" contains the same dict as returned by functions above, e.g. with "id", "name", etc.
for summary in manager.fetch_extension_summaries()[:PRINT_ONLY_N]:
print(summary["fullname"], summary["flags"], summary["enabled_version"]["id"], summary["latest_version"]["id"])
# get all versions for particular extension
for ext in manager.fetch_extension_versions("omni.kit.window.script_editor"):
print(ext["id"])
#### Get Extension Config
# Extensions/Get Extension Config
import omni.kit.app
manager = omni.kit.app.get_app().get_extension_manager()
# There could be multiple extensions with same name, but different version
# Extension id is: [ext name]-[ext version].
# Many functions accept extension id:
ext_id = manager.get_enabled_extension_id("omni.kit.window.script_editor")
data = manager.get_extension_dict(ext_id)
# Extension dict contains whole extension.toml as well as some runtime data:
# package section
print(data["package"])
# is enabled?
print(data["state/enabled"])
# resolved runtime dependencies
print(data["state/dependencies"])
# time it took to start it (ms)
print(data["state/startupTime"])
# can be converted to python dict for convenience and to prolong lifetime
data = data.get_dict()
print(type(data))
#### Get Extension Path
# Extensions/Get Extension Path
import omni.kit.app
manager = omni.kit.app.get_app().get_extension_manager()
# There could be multiple extensions with same name, but different version
# Extension id is: [ext name]-[ext version].
# Many functions accept extension id.
# You can get extension of enabled extension by name or by python module name:
ext_id = manager.get_enabled_extension_id("omni.kit.window.script_editor")
print(ext_id)
ext_id = manager.get_extension_id_by_module("omni.kit.window.script_editor")
print(ext_id)
# There are few ways to get fs path to extension:
print(manager.get_extension_path(ext_id))
print(manager.get_extension_dict(ext_id)["path"])
print(manager.get_extension_path_by_module("omni.kit.window.script_editor"))
### Other Settings
#### /app/extensions/disableStartup (default: false)
Special mode where extensions are not started (the python and C++ startup functions are not called). Everything else will work as usual. One use-case might be to warm-up everything and get extensions downloaded. Another use case is getting python environment setup without starting anything.
#### /app/extensions/precacheMode (default: false)
Special mode where all dependencies are solved and extensions downloaded, then the app exits. It is useful for precaching all extensions before running an app to get everything downloaded and check that all dependencies are correct.
#### /app/extensions/debugMode (default: false)
Output more debug information into the info logging channel.
#### /app/extensions/detailedSolverExplanation (default: false)
Output more information after the solver finishes explaining why certain versions were chosen and what the available versions were (more costly).
#### /app/extensions/registryEnabled (default: true)
Disable falling back to the extension registry when the application couldn’t resolve all its dependencies, and fail immediately.
#### /app/extensions/skipPublishVerification (default: false)
Skip extension verification before publishing. Use wisely.
#### /app/extensions/excluded (default: [])
List of extensions to exclude from startup. Can be used with or without a version. Before solving the startup order, all of those extensions are removed from all dependencies.
#### /app/extensions/preferLocalVersions (default: true)
If true, prefer local extension versions over remote ones during dependency solving. Otherwise all are treated equally, so it can become likely that newer versions are selected and downloaded.
#### /app/extensions/syncRegistryOnStartup (default: false)
Force sync with the registry on startup. Otherwise the registry is only enabled if dependency solving fails (i.e. something is missing). The --update-exts command line switch enables this behavior.
#### /app/extensions/publishExtraDict (default: {})
Extra data to write into the extension index root when published.
#### /app/extensions/fsWatcherEnabled (default: true)
Globally disable all filesystem watchers that the extension system creates.
#### /app/extensions/mkdirExtFolders (default: true)
Create non-existing extension folders when adding extension search path.
#### /app/extensions/installUntrustedExtensions (default: false)
Skip untrusted-extensions check when automatically installing dependencies and install anyway.
#### /app/extensions/profileImportTime (default: false)
Replace global import function with the one that sends events to carb.profiler. It makes all imported modules show up in a profiler. Similar to PYTHONPROFILEIMPORTTIME
#### /app/extensions/fastImporter/enabled (default: true)
Enable faster python importer, which doesn’t rely on sys.path and manually scan extensions instead.
#### /app/extensions/fastImporter/searchInTopNamespaceOnly (default: true)
If true fast importer will skip search for python files in subfolders of the extension root that doesn’t match module names defined in [[python.module]]. E.g. it won’t usually look in any folder other than [ext root]/omni.
#### /app/extensions/fastImporter/fileCache (default: false)
Cache file existence checks in the fast importer. This speeds up startup time, but extensions python code can’t be modified without cleaning the cache.
#### /app/extensions/parallelPullEnabled (default: false)
Enable parallel pulling of extensions from the registry.
## Extension Registries
The Extension system supports adding external registry providers for publishing extensions to, and pulling extensions from. By default Kit comes with the omni.kit.registry.nucleus extension which adds support for Nucleus as an extension registry.
When an extension is enabled, the dependency solver resolves all dependencies. If a dependency is missing in the local cache, it will ask the registry for a particular extension and it will be downloaded/installed at runtime. Installation is just unpacking of a zip archive into the cache folder (app/extensions/registryCache setting).
The Extension system will only enable the Extension registry when it can’t find all extensions locally. At that moment, it will try to enable any extensions specified in the setting: app/extensions/registryExtension, which by default is omni.kit.registry.nucleus.
The Registry system can be completely disabled with the app/extensions/registryEnabled setting.
The Extension manager provides an API to add other extension registries and query any existing ones (omni::ext::IExtensions::addRegistryProvider, omni::ext::IExtensions::getRegistryProviderCount etc).
Multiple registries can be configured to be used at the same time. They are uniquely identified with a name. Setting app/extensions/registryPublishDefault sets which one to use by default when publishing and unpublishing extensions. The API provides a way to explicitly pass the registry to use.
### Publishing Extensions
To properly publish your extension to the registry use publishing tool, refer to: Publishing Extensions Guide
Alternatively, kit.exe --publish CLI command can be used during development:
Example: > kit.exe --publish omni.my.ext-tag
If there is more than one version of this extension available, it will produce an error saying that you need to specify which one to publish.
Example: > kit.exe --publish omni.my.ext-tag-1.2.0
To specify the registry to publish to, override the default registry name:
Example: > kit.exe --publish omni.my.ext-tag-1.2.0 --/app/extensions/registryPublishDefault="kit/mr"
If the extension already exists in the registry, it will fail. To force overwriting, use the additional --publish-overwrite argument:
Example: > kit.exe --publish omni.my.ext --publish-overwrite
The version must be specified in a config file for publishing to succeed.
All [package.target] config subfields are filled in automatically if unspecified:
If the extension config has the [native] field [package.target.platform] or [package.target.config], they are filled with the current platform information.
If the extension config has the [native] and [python] fields, the field [package.target.python] is filled with the current python version.
If the /app/extensions/writeTarget/kitHash setting is true, the field [package.target.kitHash] is filled with the current kit githash.
An Extension package name will look like this: [ext_name]-[ext_tag]-[major].[minor].[patch]-[prerelease]+[build]. Where:
[ext_name]-[ext_tag] is the extension name (initially coming from the extension folder).
[ext_tag]-[major].[minor].[patch]-[prerelease] if [package.version] field of a config specifies.
[build] is composed from the [package.target]] field.
### Pulling Extensions
There are multiple ways to get Extensions (both new Extensions and updated versions of existing Extensions) from a registry:
Use the UI provided by this extension: omni.kit.window.extensions
If any extensions are specified in the app config file - or required through dependencies - are missing from the local cache, the system will attempt to sync with the registry and pull them. That means, if you have version “1.2.0” of an Extension locally, it won’t be updated to “1.2.1” automatically, because “1.2.0” satisfies the dependencies. To force an update run Kit with --update-exts flag:
Example: > kit.exe --update-exts
### Pre-downloading Extensions
You can also run Kit without starting any extensions. The benefit of doing this is that they will be downloaded and cached for the next run. To do that run Kit with --ext-precache-mode flag:
Example: > kit.exe --ext-precache-mode
### Authentication and Users
The Omniverse Client library is used to perform all operations with the nucleus registry. Syncing, downloading, and publishing extensions requires signing in. For automation, 2 separate accounts can be explicitly provided, for read and write operations.
User account read/write permissions can be set for the omni.kit.registry.nucleus extension. The “read” user account is used for syncing with registry and downloading extensions. The “write” user account is used for publishing or unpublishing extensions. If no user is set, it defaults to a regular sign-in using a browser.
By default, kit comes with a default read and write accounts set for the default registry.
Accounts setting example:
exts."omni.kit.registry.nucleus".accounts = [
{ url = "omniverse://kit-extensions.ov.nvidia.com", read = "[user]:[password]", write = "[user]:[password]" }
]
Where read - is read user account, write - is write user account. Both are optional. Format is: “user:password”.
## Building Extensions
Extensions are a runtime concept. This guide doesn’t describe how to build them or how to build other extensions which mihht depend on another specific extension at build-time. One can use a variety of different tools and setups for that. We do however have some best-practice recommendations. The best sources of information on that topic are currently:
The example omni.example.hello extension (and many other extensions). Copy and rename it to create a new extension.
We also strive to use folder linking as much as possible. Meaning we don’t copy python files and configs from the source folder to the target (build) folder, but link them. This permits live changes to those files under version control to be immediately reflected, even at runtime. Unfortunately we can’t link files, because of Windows limitations, so folder linking is used. This adds some verbosity to the way the folder structure is organized.
For example, for a simple python-only extension, we link the whole python namespace subfolder:
source/extensions/omni.example.hello/omni – [linked to] –> _build/windows-x86_64/debug/exts/omni.example.hello/omni
For an extension with binary components we link python code parts and copy binary parts.
We specify other parts to link in the premake file: repo_build.prebuild_link { "folder", ext.target_dir.."/folder" }
When working with the build system it is always a good idea to look at what the final _build/windows-x86_64/debug/exts folder looks like, which folder links exist, where they point to, which files were copied, etc. Remember that the goal is to produce one extension folder which will potentially be zipped and published. Folder links are just zipped as-is, as if they were actual folders.
© Copyright 2019-2023, NVIDIA.
Last updated on Nov 14, 2023. |
omni.ui.CornerFlag.md | CornerFlag — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
CornerFlag
# CornerFlag
class omni.ui.CornerFlag
Bases: pybind11_object
Members:
NONE
TOP_LEFT
TOP_RIGHT
BOTTOM_LEFT
BOTTOM_RIGHT
TOP
BOTTOM
LEFT
RIGHT
ALL
Methods
__init__(self, value)
Attributes
ALL
BOTTOM
BOTTOM_LEFT
BOTTOM_RIGHT
LEFT
NONE
RIGHT
TOP
TOP_LEFT
TOP_RIGHT
name
value
__init__(self: omni.ui._ui.CornerFlag, value: int) → None
property name
© Copyright 2019-2024, NVIDIA.
Last updated on Mar 25, 2024. |
omni.ui.url_utils.Singleton.md | Singleton — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Submodules »
omni.ui.url_utils »
omni.ui.url_utils Functions »
Singleton
# Singleton
omni.ui.url_utils.Singleton(class_)
A singleton decorator
© Copyright 2019-2024, NVIDIA.
Last updated on Mar 25, 2024. |
omni.ui.FreeBezierCurve.md | FreeBezierCurve — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
FreeBezierCurve
# FreeBezierCurve
class omni.ui.FreeBezierCurve
Bases: BezierCurve
Smooth curve that can be scaled infinitely.
The free widget is the widget that is independent of the layout. It means it is stuck to other widgets. When initializing, it’s necessary to provide two widgets, and the shape is drawn from one widget position to the another.
Methods
__init__(self, arg0, arg1, **kwargs)
Initialize the shape with bounds limited to the positions of the given widgets.
Attributes
__init__(self: omni.ui._ui.FreeBezierCurve, arg0: omni.ui._ui.Widget, arg1: omni.ui._ui.Widget, **kwargs) → None
Initialize the shape with bounds limited to the positions of the given widgets.
### Arguments:
`start :`The bound corner is in the center of this given widget.
`end :`The bound corner is in the center of this given widget.
`kwargsdict`See below
### Keyword Arguments:
`start_tangent_width: `
This property holds the X coordinate of the start of the curve relative to the width bound of the curve.
`start_tangent_height: `
This property holds the Y coordinate of the start of the curve relative to the width bound of the curve.
`end_tangent_width: `
This property holds the X coordinate of the end of the curve relative to the width bound of the curve.
`end_tangent_height: `
This property holds the Y coordinate of the end of the curve relative to the width bound of the curve.
`set_mouse_hovered_fn: `
Sets the function that will be called when the user use mouse enter/leave on the line. It’s the override to prevent Widget from the bounding box logic. The function specification is: void onMouseHovered(bool hovered)
`widthui.Length`This property holds the width of the widget relative to its parent. Do not use this function to find the width of a screen.
`heightui.Length`This property holds the height of the widget relative to its parent. Do not use this function to find the height of a screen.
`namestr`The name of the widget that user can set.
`style_type_name_overridestr`By default, we use typeName to look up the style. But sometimes it’s necessary to use a custom name. For example, when a widget is a part of another widget. (Label is a part of Button) This property can override the name to use in style.
`identifierstr`An optional identifier of the widget we can use to refer to it in queries.
`visiblebool`This property holds whether the widget is visible.
`visibleMinfloat`If the current zoom factor and DPI is less than this value, the widget is not visible.
`visibleMaxfloat`If the current zoom factor and DPI is bigger than this value, the widget is not visible.
`tooltipstr`Set a basic tooltip for the widget, this will simply be a Label, it will follow the Tooltip style
`tooltip_fnCallable`Set dynamic tooltip that will be created dynamiclly the first time it is needed. the function is called inside a ui.Frame scope that the widget will be parented correctly.
`tooltip_offset_xfloat`Set the X tooltip offset in points. In a normal state, the tooltip position is linked to the mouse position. If the tooltip offset is non zero, the top left corner of the tooltip is linked to the top left corner of the widget, and this property defines the relative position the tooltip should be shown.
`tooltip_offset_yfloat`Set the Y tooltip offset in points. In a normal state, the tooltip position is linked to the mouse position. If the tooltip offset is non zero, the top left corner of the tooltip is linked to the top left corner of the widget, and this property defines the relative position the tooltip should be shown.
`enabledbool`This property holds whether the widget is enabled. In general an enabled widget handles keyboard and mouse events; a disabled widget does not. And widgets display themselves differently when they are disabled.
`selectedbool`This property holds a flag that specifies the widget has to use eSelected state of the style.
`checkedbool`This property holds a flag that specifies the widget has to use eChecked state of the style. It’s on the Widget level because the button can have sub-widgets that are also should be checked.
`draggingbool`This property holds if the widget is being dragged.
`opaque_for_mouse_eventsbool`If the widgets has callback functions it will by default not capture the events if it is the top most widget and setup this option to true, so they don’t get routed to the child widgets either
`skip_draw_when_clippedbool`The flag that specifies if it’s necessary to bypass the whole draw cycle if the bounding box is clipped with a scrolling frame. It’s needed to avoid the limitation of 65535 primitives in a single draw list.
`mouse_moved_fnCallable`Sets the function that will be called when the user moves the mouse inside the widget. Mouse move events only occur if a mouse button is pressed while the mouse is being moved. void onMouseMoved(float x, float y, int32_t modifier)
`mouse_pressed_fnCallable`Sets the function that will be called when the user presses the mouse button inside the widget. The function should be like this: void onMousePressed(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier) Where ‘button’ is the number of the mouse button pressed. ‘modifier’ is the flag for the keyboard modifier key.
`mouse_released_fnCallable`Sets the function that will be called when the user releases the mouse button if this button was pressed inside the widget. void onMouseReleased(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)
`mouse_double_clicked_fnCallable`Sets the function that will be called when the user presses the mouse button twice inside the widget. The function specification is the same as in setMousePressedFn. void onMouseDoubleClicked(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)
`mouse_wheel_fnCallable`Sets the function that will be called when the user uses mouse wheel on the focused window. The function specification is the same as in setMousePressedFn. void onMouseWheel(float x, float y, carb::input::KeyboardModifierFlags modifier)
`mouse_hovered_fnCallable`Sets the function that will be called when the user use mouse enter/leave on the focused window. function specification is the same as in setMouseHovedFn. void onMouseHovered(bool hovered)
`drag_fnCallable`Specify that this Widget is draggable, and set the callback that is attached to the drag operation.
`accept_drop_fnCallable`Specify that this Widget can accept specific drops and set the callback that is called to check if the drop can be accepted.
`drop_fnCallable`Specify that this Widget accepts drops and set the callback to the drop operation.
`computed_content_size_changed_fnCallable`Called when the size of the widget is changed.
`anchor_position: `This property holds the parametric value of the curve anchor.
`anchor_alignment: `This property holds the Alignment of the curve anchor.
`set_anchor_fn: Callable`Sets the function that will be called for the curve anchor.
`invalidate_anchor: `Function that causes the anchor frame to be redrawn.
`get_closest_parametric_position: `Function that returns the closest parametric T value to a given x,y position.
© Copyright 2019-2024, NVIDIA.
Last updated on Mar 25, 2024. |
omni.ui.HGrid.md | HGrid — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
HGrid
# HGrid
class omni.ui.HGrid
Bases: Grid
Shortcut for Grid{eLeftToRight}. The grid grows from left to right with the widgets placed.
Methods
__init__(self, **kwargs)
Construct a grid that grow from left to right with the widgets placed.
Attributes
__init__(self: omni.ui._ui.HGrid, **kwargs) → None
Construct a grid that grow from left to right with the widgets placed.
`kwargsdict`See below
### Keyword Arguments:
`column_width`The width of the column. It’s only possible to set it if the grid is vertical. Once it’s set, the column count depends on the size of the widget.
`row_height`The height of the row. It’s only possible to set it if the grid is horizontal. Once it’s set, the row count depends on the size of the widget.
`column_count`The number of columns. It’s only possible to set it if the grid is vertical. Once it’s set, the column width depends on the widget size.
`row_count`The number of rows. It’s only possible to set it if the grid is horizontal. Once it’s set, the row height depends on the widget size.
`direction`This type is used to determine the direction of the layout. If the Stack’s orientation is eLeftToRight the widgets are placed in a horizontal row, from left to right. If the Stack’s orientation is eRightToLeft the widgets are placed in a horizontal row, from right to left. If the Stack’s orientation is eTopToBottom, the widgets are placed in a vertical column, from top to bottom. If the Stack’s orientation is eBottomToTop, the widgets are placed in a vertical column, from bottom to top. If the Stack’s orientation is eBackToFront, the widgets are placed sorted in a Z-order in top right corner. If the Stack’s orientation is eFrontToBack, the widgets are placed sorted in a Z-order in top right corner, the first widget goes to front.
`content_clipping`Determines if the child widgets should be clipped by the rectangle of this Stack.
`spacing`Sets a non-stretchable space in pixels between child items of this layout.
`send_mouse_events_to_back`When children of a Z-based stack overlap mouse events are normally sent to the topmost one. Setting this property true will invert that behavior, sending mouse events to the bottom-most child.
`widthui.Length`This property holds the width of the widget relative to its parent. Do not use this function to find the width of a screen.
`heightui.Length`This property holds the height of the widget relative to its parent. Do not use this function to find the height of a screen.
`namestr`The name of the widget that user can set.
`style_type_name_overridestr`By default, we use typeName to look up the style. But sometimes it’s necessary to use a custom name. For example, when a widget is a part of another widget. (Label is a part of Button) This property can override the name to use in style.
`identifierstr`An optional identifier of the widget we can use to refer to it in queries.
`visiblebool`This property holds whether the widget is visible.
`visibleMinfloat`If the current zoom factor and DPI is less than this value, the widget is not visible.
`visibleMaxfloat`If the current zoom factor and DPI is bigger than this value, the widget is not visible.
`tooltipstr`Set a basic tooltip for the widget, this will simply be a Label, it will follow the Tooltip style
`tooltip_fnCallable`Set dynamic tooltip that will be created dynamiclly the first time it is needed. the function is called inside a ui.Frame scope that the widget will be parented correctly.
`tooltip_offset_xfloat`Set the X tooltip offset in points. In a normal state, the tooltip position is linked to the mouse position. If the tooltip offset is non zero, the top left corner of the tooltip is linked to the top left corner of the widget, and this property defines the relative position the tooltip should be shown.
`tooltip_offset_yfloat`Set the Y tooltip offset in points. In a normal state, the tooltip position is linked to the mouse position. If the tooltip offset is non zero, the top left corner of the tooltip is linked to the top left corner of the widget, and this property defines the relative position the tooltip should be shown.
`enabledbool`This property holds whether the widget is enabled. In general an enabled widget handles keyboard and mouse events; a disabled widget does not. And widgets display themselves differently when they are disabled.
`selectedbool`This property holds a flag that specifies the widget has to use eSelected state of the style.
`checkedbool`This property holds a flag that specifies the widget has to use eChecked state of the style. It’s on the Widget level because the button can have sub-widgets that are also should be checked.
`draggingbool`This property holds if the widget is being dragged.
`opaque_for_mouse_eventsbool`If the widgets has callback functions it will by default not capture the events if it is the top most widget and setup this option to true, so they don’t get routed to the child widgets either
`skip_draw_when_clippedbool`The flag that specifies if it’s necessary to bypass the whole draw cycle if the bounding box is clipped with a scrolling frame. It’s needed to avoid the limitation of 65535 primitives in a single draw list.
`mouse_moved_fnCallable`Sets the function that will be called when the user moves the mouse inside the widget. Mouse move events only occur if a mouse button is pressed while the mouse is being moved. void onMouseMoved(float x, float y, int32_t modifier)
`mouse_pressed_fnCallable`Sets the function that will be called when the user presses the mouse button inside the widget. The function should be like this: void onMousePressed(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier) Where ‘button’ is the number of the mouse button pressed. ‘modifier’ is the flag for the keyboard modifier key.
`mouse_released_fnCallable`Sets the function that will be called when the user releases the mouse button if this button was pressed inside the widget. void onMouseReleased(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)
`mouse_double_clicked_fnCallable`Sets the function that will be called when the user presses the mouse button twice inside the widget. The function specification is the same as in setMousePressedFn. void onMouseDoubleClicked(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)
`mouse_wheel_fnCallable`Sets the function that will be called when the user uses mouse wheel on the focused window. The function specification is the same as in setMousePressedFn. void onMouseWheel(float x, float y, carb::input::KeyboardModifierFlags modifier)
`mouse_hovered_fnCallable`Sets the function that will be called when the user use mouse enter/leave on the focused window. function specification is the same as in setMouseHovedFn. void onMouseHovered(bool hovered)
`drag_fnCallable`Specify that this Widget is draggable, and set the callback that is attached to the drag operation.
`accept_drop_fnCallable`Specify that this Widget can accept specific drops and set the callback that is called to check if the drop can be accepted.
`drop_fnCallable`Specify that this Widget accepts drops and set the callback to the drop operation.
`computed_content_size_changed_fnCallable`Called when the size of the widget is changed.
© Copyright 2019-2024, NVIDIA.
Last updated on Mar 25, 2024. |
embedded_kit_python.md | Embedded Python — kit-manual 105.1 documentation
kit-manual
»
Embedded Python
# Embedded Python
Kit comes with embedded Python. Regular CPython 3.7 is used with no modifications.
Kit initializes the Python interpreter before any extension is started. Each extension can then add their own folders (or subfolders) to the sys.path (using [[python.module]] definitions). By subclassing as IExt, extensions get an entry point into Python code. They can then execute any code, import other extensions, use any API they provide. More info: Extensions.
For most applications this is all you need to know about Python in Kit. Examining sys.path at runtime is the most common way to debug most issues. This doc provides more advanced details on Python integration.
## Hello Python
Run > kit.exe --exec your_script.py to run your script using Kit Python.
## Using system Python
When the Python interpreter is initialized, system-defined environment variables (like PYTHONHOME, PYTHONPATH) are ignored. Instead, the following setting is used for python home:
/plugins/carb.scripting-python.plugin/pythonHome instead of PYTHONHOME
Note
You can find default values for this setting in kit-core.json file.
To use a system-level Python installation, override PYTHONHOME, e.g.: --/plugins/carb.scripting-python.plugin/pythonHome="C:\Users\bob\AppData\Local\Programs\Python\Python310".
Changing PYTHONHOME won’t change the loaded Python library. This is platform specific, but for instance on Windows, Kit is linked with python.dll and loads the one that is in the package using standard dll search rules. However, the standard library, site-packages, and everything else will be used from the specified python path.
## Add extra search paths
To add search paths (to sys.path), the /app/python/extraPaths setting can be used. For example:
> kit.exe --/app/python/extraPaths/0="C:/temp"
or in a kit file:
[settings]
app.python.extraPaths = ["C:/temp"]
To summarize, those are all the methods to extend sys.path:
Create new extension with [python.module] definitions (recommended).
Explicitly in python code: sys.path.append(...)
The /app/python/extraPaths setting.
## Other Python Configuration Tweaks
Most python configuration variables can be changed using following settings:
config variable
python flag documentation
/plugins/carb.scripting-python.plugin/Py_VerboseFlag
Py_VerboseFlag
/plugins/carb.scripting-python.plugin/Py_QuietFlag
Py_QuietFlag
/plugins/carb.scripting-python.plugin/Py_NoSiteFlag
Py_NoSiteFlag
/plugins/carb.scripting-python.plugin/Py_IgnoreEnvironmentFlag
Py_IgnoreEnvironmentFlag
/plugins/carb.scripting-python.plugin/Py_NoUserSiteDirectory
Py_NoUserSiteDirectory
/plugins/carb.scripting-python.plugin/Py_UnbufferedStdioFlag
Py_UnbufferedStdioFlag
/plugins/carb.scripting-python.plugin/Py_IsolatedFlag
Py_IsolatedFlag
## Using numpy, Pillow etc.
Kit comes with omni.kit.pip_archive extension which has few popular Python modules bundled into it. Have a look inside of it on filesystem.
After this extension is started you can freely do import numpy. Declare a dependency on this extension in your extension, or enable it by any other means to use any of them.
E.g.: run > kit.exe --enable omni.kit.pip_archive --exec use_numpy.py to run your script that can import and use numpy.
## Using Anaconda environment
As a starting point change PYTHONHOME setting described above to point to Anaconda environment: --/plugins/carb.scripting-python.plugin/pythonHome="C:/Users/bob/anaconda3/envs/py37". It is known to work for some packages and fail for others, on a case by case basis.
## Using other packages from pip
For most Python packages (installed with any package manager or locally developed) it is enough to add them to the search path (sys.path). That makes them discoverable by the python import system. Any of the methods described above can be used for that.
Alternatively, Kit has the omni.kit.pipapi extension to install modules from the pip package manager at runtime. It will check if the package is not available, and will try to pip install it and cache it. Example of usage: omni.kit.pipapi.install("some_package"). After that call, import the installed package.
Enabling the omni.kit.pipapi extension will allow specification of pip dependencies by extensions loaded after it. Refer to omni.kit.pipapi doc.
At build-time, any Python module can be packaged into any extension, including packages from pip. That can be done using other Python installations or kit Python. This is the recommended way, so that when an extension is downloaded and installed, it is ready to use. There is also no requirement for connectivity to public registries, and no runtime cost during installation.
## Why do some native Python modules not work in Kit?
It is common for something that works out of the box as-installed from pip or Anaconda not to work in Kit. Or vice versa, the Kit Python module doesn’t load outside of Kit.
For pure Python modules (only *.py files), finding the root cause might be a matter of following import errors. However, when it involves loading native Python modules (*.pyd files on Windows and *.so files on Linux), errors are often not really helpful.
Native Python modules are just regular OS shared libraries, with a special C API that Python looks for. They also are often implicitly linked with other libraries. When loaded, they might not be able to find other libraries, or be in conflict with already loaded libraries. Those issues can be debugged as any other library loading issue, specific to the OS. Some examples are:
Exploring PATH/LD_LIBRARY_PATH env vars.
Exploring libraries that are already loaded by the process.
Using tools like Dependency Walker.
Trying to isolate the issue, by loading in a simpler or more similar environment.
Kit doesn’t do anything special in this regard, and can be treated as just another instance of Python, with a potentially different set of loaded modules.
## Running Kit from Python
Normally the kit.exe process starts and loads an embedded Python library. Kit provides Python bindings to its core runtime components. This allows you to start Python, and then start Kit from that Python.
It is an experimental feature, and not used often. An example can be found within the Kit package: example.pythonapp.bat.
Differences from running normally:
A different Python library file is used (different python.dll).
There may be some GIL implications, because the call stack is different.
Allows explicit control over the update loop.
© Copyright 2019-2023, NVIDIA.
Last updated on Nov 14, 2023. |
omni.ui.Rectangle.md | Rectangle — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
Rectangle
# Rectangle
class omni.ui.Rectangle
Bases: Shape
The Rectangle widget provides a colored rectangle to display.
Methods
__init__(self, **kwargs)
Constructs Rectangle.
Attributes
__init__(self: omni.ui._ui.Rectangle, **kwargs) → None
Constructs Rectangle.
`kwargsdict`See below
### Keyword Arguments:
`widthui.Length`This property holds the width of the widget relative to its parent. Do not use this function to find the width of a screen.
`heightui.Length`This property holds the height of the widget relative to its parent. Do not use this function to find the height of a screen.
`namestr`The name of the widget that user can set.
`style_type_name_overridestr`By default, we use typeName to look up the style. But sometimes it’s necessary to use a custom name. For example, when a widget is a part of another widget. (Label is a part of Button) This property can override the name to use in style.
`identifierstr`An optional identifier of the widget we can use to refer to it in queries.
`visiblebool`This property holds whether the widget is visible.
`visibleMinfloat`If the current zoom factor and DPI is less than this value, the widget is not visible.
`visibleMaxfloat`If the current zoom factor and DPI is bigger than this value, the widget is not visible.
`tooltipstr`Set a basic tooltip for the widget, this will simply be a Label, it will follow the Tooltip style
`tooltip_fnCallable`Set dynamic tooltip that will be created dynamiclly the first time it is needed. the function is called inside a ui.Frame scope that the widget will be parented correctly.
`tooltip_offset_xfloat`Set the X tooltip offset in points. In a normal state, the tooltip position is linked to the mouse position. If the tooltip offset is non zero, the top left corner of the tooltip is linked to the top left corner of the widget, and this property defines the relative position the tooltip should be shown.
`tooltip_offset_yfloat`Set the Y tooltip offset in points. In a normal state, the tooltip position is linked to the mouse position. If the tooltip offset is non zero, the top left corner of the tooltip is linked to the top left corner of the widget, and this property defines the relative position the tooltip should be shown.
`enabledbool`This property holds whether the widget is enabled. In general an enabled widget handles keyboard and mouse events; a disabled widget does not. And widgets display themselves differently when they are disabled.
`selectedbool`This property holds a flag that specifies the widget has to use eSelected state of the style.
`checkedbool`This property holds a flag that specifies the widget has to use eChecked state of the style. It’s on the Widget level because the button can have sub-widgets that are also should be checked.
`draggingbool`This property holds if the widget is being dragged.
`opaque_for_mouse_eventsbool`If the widgets has callback functions it will by default not capture the events if it is the top most widget and setup this option to true, so they don’t get routed to the child widgets either
`skip_draw_when_clippedbool`The flag that specifies if it’s necessary to bypass the whole draw cycle if the bounding box is clipped with a scrolling frame. It’s needed to avoid the limitation of 65535 primitives in a single draw list.
`mouse_moved_fnCallable`Sets the function that will be called when the user moves the mouse inside the widget. Mouse move events only occur if a mouse button is pressed while the mouse is being moved. void onMouseMoved(float x, float y, int32_t modifier)
`mouse_pressed_fnCallable`Sets the function that will be called when the user presses the mouse button inside the widget. The function should be like this: void onMousePressed(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier) Where ‘button’ is the number of the mouse button pressed. ‘modifier’ is the flag for the keyboard modifier key.
`mouse_released_fnCallable`Sets the function that will be called when the user releases the mouse button if this button was pressed inside the widget. void onMouseReleased(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)
`mouse_double_clicked_fnCallable`Sets the function that will be called when the user presses the mouse button twice inside the widget. The function specification is the same as in setMousePressedFn. void onMouseDoubleClicked(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)
`mouse_wheel_fnCallable`Sets the function that will be called when the user uses mouse wheel on the focused window. The function specification is the same as in setMousePressedFn. void onMouseWheel(float x, float y, carb::input::KeyboardModifierFlags modifier)
`mouse_hovered_fnCallable`Sets the function that will be called when the user use mouse enter/leave on the focused window. function specification is the same as in setMouseHovedFn. void onMouseHovered(bool hovered)
`drag_fnCallable`Specify that this Widget is draggable, and set the callback that is attached to the drag operation.
`accept_drop_fnCallable`Specify that this Widget can accept specific drops and set the callback that is called to check if the drop can be accepted.
`drop_fnCallable`Specify that this Widget accepts drops and set the callback to the drop operation.
`computed_content_size_changed_fnCallable`Called when the size of the widget is changed.
© Copyright 2019-2024, NVIDIA.
Last updated on Mar 25, 2024. |
omni.ui.HStack.md | HStack — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
HStack
# HStack
class omni.ui.HStack
Bases: Stack
Shortcut for Stack{eLeftToRight}. The widgets are placed in a row, with suitable sizes.
Methods
__init__(self, **kwargs)
Construct a stack with the widgets placed in a row from left to right.
Attributes
__init__(self: omni.ui._ui.HStack, **kwargs) → None
Construct a stack with the widgets placed in a row from left to right.
`kwargsdict`See below
### Keyword Arguments:
`direction`This type is used to determine the direction of the layout. If the Stack’s orientation is eLeftToRight the widgets are placed in a horizontal row, from left to right. If the Stack’s orientation is eRightToLeft the widgets are placed in a horizontal row, from right to left. If the Stack’s orientation is eTopToBottom, the widgets are placed in a vertical column, from top to bottom. If the Stack’s orientation is eBottomToTop, the widgets are placed in a vertical column, from bottom to top. If the Stack’s orientation is eBackToFront, the widgets are placed sorted in a Z-order in top right corner. If the Stack’s orientation is eFrontToBack, the widgets are placed sorted in a Z-order in top right corner, the first widget goes to front.
`content_clipping`Determines if the child widgets should be clipped by the rectangle of this Stack.
`spacing`Sets a non-stretchable space in pixels between child items of this layout.
`send_mouse_events_to_back`When children of a Z-based stack overlap mouse events are normally sent to the topmost one. Setting this property true will invert that behavior, sending mouse events to the bottom-most child.
`widthui.Length`This property holds the width of the widget relative to its parent. Do not use this function to find the width of a screen.
`heightui.Length`This property holds the height of the widget relative to its parent. Do not use this function to find the height of a screen.
`namestr`The name of the widget that user can set.
`style_type_name_overridestr`By default, we use typeName to look up the style. But sometimes it’s necessary to use a custom name. For example, when a widget is a part of another widget. (Label is a part of Button) This property can override the name to use in style.
`identifierstr`An optional identifier of the widget we can use to refer to it in queries.
`visiblebool`This property holds whether the widget is visible.
`visibleMinfloat`If the current zoom factor and DPI is less than this value, the widget is not visible.
`visibleMaxfloat`If the current zoom factor and DPI is bigger than this value, the widget is not visible.
`tooltipstr`Set a basic tooltip for the widget, this will simply be a Label, it will follow the Tooltip style
`tooltip_fnCallable`Set dynamic tooltip that will be created dynamiclly the first time it is needed. the function is called inside a ui.Frame scope that the widget will be parented correctly.
`tooltip_offset_xfloat`Set the X tooltip offset in points. In a normal state, the tooltip position is linked to the mouse position. If the tooltip offset is non zero, the top left corner of the tooltip is linked to the top left corner of the widget, and this property defines the relative position the tooltip should be shown.
`tooltip_offset_yfloat`Set the Y tooltip offset in points. In a normal state, the tooltip position is linked to the mouse position. If the tooltip offset is non zero, the top left corner of the tooltip is linked to the top left corner of the widget, and this property defines the relative position the tooltip should be shown.
`enabledbool`This property holds whether the widget is enabled. In general an enabled widget handles keyboard and mouse events; a disabled widget does not. And widgets display themselves differently when they are disabled.
`selectedbool`This property holds a flag that specifies the widget has to use eSelected state of the style.
`checkedbool`This property holds a flag that specifies the widget has to use eChecked state of the style. It’s on the Widget level because the button can have sub-widgets that are also should be checked.
`draggingbool`This property holds if the widget is being dragged.
`opaque_for_mouse_eventsbool`If the widgets has callback functions it will by default not capture the events if it is the top most widget and setup this option to true, so they don’t get routed to the child widgets either
`skip_draw_when_clippedbool`The flag that specifies if it’s necessary to bypass the whole draw cycle if the bounding box is clipped with a scrolling frame. It’s needed to avoid the limitation of 65535 primitives in a single draw list.
`mouse_moved_fnCallable`Sets the function that will be called when the user moves the mouse inside the widget. Mouse move events only occur if a mouse button is pressed while the mouse is being moved. void onMouseMoved(float x, float y, int32_t modifier)
`mouse_pressed_fnCallable`Sets the function that will be called when the user presses the mouse button inside the widget. The function should be like this: void onMousePressed(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier) Where ‘button’ is the number of the mouse button pressed. ‘modifier’ is the flag for the keyboard modifier key.
`mouse_released_fnCallable`Sets the function that will be called when the user releases the mouse button if this button was pressed inside the widget. void onMouseReleased(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)
`mouse_double_clicked_fnCallable`Sets the function that will be called when the user presses the mouse button twice inside the widget. The function specification is the same as in setMousePressedFn. void onMouseDoubleClicked(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)
`mouse_wheel_fnCallable`Sets the function that will be called when the user uses mouse wheel on the focused window. The function specification is the same as in setMousePressedFn. void onMouseWheel(float x, float y, carb::input::KeyboardModifierFlags modifier)
`mouse_hovered_fnCallable`Sets the function that will be called when the user use mouse enter/leave on the focused window. function specification is the same as in setMouseHovedFn. void onMouseHovered(bool hovered)
`drag_fnCallable`Specify that this Widget is draggable, and set the callback that is attached to the drag operation.
`accept_drop_fnCallable`Specify that this Widget can accept specific drops and set the callback that is called to check if the drop can be accepted.
`drop_fnCallable`Specify that this Widget accepts drops and set the callback to the drop operation.
`computed_content_size_changed_fnCallable`Called when the size of the widget is changed.
© Copyright 2019-2024, NVIDIA.
Last updated on Mar 25, 2024. |
omni.ui.Alignment.md | Alignment — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
Alignment
# Alignment
class omni.ui.Alignment
Bases: pybind11_object
Members:
UNDEFINED
LEFT_TOP
LEFT_CENTER
LEFT_BOTTOM
CENTER_TOP
CENTER
CENTER_BOTTOM
RIGHT_TOP
RIGHT_CENTER
RIGHT_BOTTOM
LEFT
RIGHT
H_CENTER
TOP
BOTTOM
V_CENTER
Methods
__init__(self, value)
Attributes
BOTTOM
CENTER
CENTER_BOTTOM
CENTER_TOP
H_CENTER
LEFT
LEFT_BOTTOM
LEFT_CENTER
LEFT_TOP
RIGHT
RIGHT_BOTTOM
RIGHT_CENTER
RIGHT_TOP
TOP
UNDEFINED
V_CENTER
name
value
__init__(self: omni.ui._ui.Alignment, value: int) → None
property name
© Copyright 2019-2024, NVIDIA.
Last updated on Mar 25, 2024. |
omni.ui.OffsetLine.md | OffsetLine — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
OffsetLine
# OffsetLine
class omni.ui.OffsetLine
Bases: FreeLine
The free widget is the widget that is independent of the layout. It draws the line stuck to the bounds of other widgets.
Methods
__init__(self, arg0, arg1, **kwargs)
Attributes
bound_offset
The offset from the bounds of the widgets this line is stuck to.
offset
The offset to the direction of the line normal.
__init__(self: omni.ui._ui.OffsetLine, arg0: omni.ui._ui.Widget, arg1: omni.ui._ui.Widget, **kwargs) → None
property bound_offset
The offset from the bounds of the widgets this line is stuck to.
property offset
The offset to the direction of the line normal.
© Copyright 2019-2024, NVIDIA.
Last updated on Mar 25, 2024. |
UsdProc.md | UsdProc module — pxr-usd-api 105.1 documentation
pxr-usd-api
»
Modules »
UsdProc module
# UsdProc module
Summary: The UsdProc module defines schemas for the scene description of procedural data meaningful to downstream systems.
Classes:
GenerativeProcedural
Represents an abstract generative procedural prim which delivers its input parameters via properties (including relationships) within the"primvars:"namespace.
Tokens
class pxr.UsdProc.GenerativeProcedural
Represents an abstract generative procedural prim which delivers its
input parameters via properties (including relationships) within
the”primvars:”namespace.
It does not itself have any awareness or participation in the
execution of the procedural but rather serves as a means of delivering
a procedural’s definition and input parameters.
The value of its”proceduralSystem”property (either authored or
provided by API schema fallback) indicates to which system the
procedural definition is meaningful.
For any described attribute Fallback Value or Allowed Values
below that are text/tokens, the actual token is published and defined
in UsdProcTokens. So to set an attribute to the value”rightHanded”,
use UsdProcTokens->rightHanded as the value.
Methods:
CreateProceduralSystemAttr(defaultValue, ...)
See GetProceduralSystemAttr() , and also Create vs Get Property Methods for when to use Get vs Create.
Define
classmethod Define(stage, path) -> GenerativeProcedural
Get
classmethod Get(stage, path) -> GenerativeProcedural
GetProceduralSystemAttr()
The name or convention of the system responsible for evaluating the procedural.
GetSchemaAttributeNames
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
CreateProceduralSystemAttr(defaultValue, writeSparsely) → Attribute
See GetProceduralSystemAttr() , and also Create vs Get Property
Methods for when to use Get vs Create.
If specified, author defaultValue as the attribute’s default,
sparsely (when it makes sense to do so) if writeSparsely is
true - the default for writeSparsely is false .
Parameters
defaultValue (VtValue) –
writeSparsely (bool) –
static Define()
classmethod Define(stage, path) -> GenerativeProcedural
Attempt to ensure a UsdPrim adhering to this schema at path is
defined (according to UsdPrim::IsDefined() ) on this stage.
If a prim adhering to this schema at path is already defined on
this stage, return that prim. Otherwise author an SdfPrimSpec with
specifier == SdfSpecifierDef and this schema’s prim type name for
the prim at path at the current EditTarget. Author SdfPrimSpec s
with specifier == SdfSpecifierDef and empty typeName at the
current EditTarget for any nonexistent, or existing but not Defined
ancestors.
The given path must be an absolute prim path that does not contain
any variant selections.
If it is impossible to author any of the necessary PrimSpecs, (for
example, in case path cannot map to the current UsdEditTarget ‘s
namespace) issue an error and return an invalid UsdPrim.
Note that this method may return a defined prim whose typeName does
not specify this schema class, in case a stronger typeName opinion
overrides the opinion at the current EditTarget.
Parameters
stage (Stage) –
path (Path) –
static Get()
classmethod Get(stage, path) -> GenerativeProcedural
Return a UsdProcGenerativeProcedural holding the prim adhering to this
schema at path on stage .
If no prim exists at path on stage , or if the prim at that
path does not adhere to this schema, return an invalid schema object.
This is shorthand for the following:
UsdProcGenerativeProcedural(stage->GetPrimAtPath(path));
Parameters
stage (Stage) –
path (Path) –
GetProceduralSystemAttr() → Attribute
The name or convention of the system responsible for evaluating the
procedural.
NOTE: A fallback value for this is typically set via an API schema.
Declaration
token proceduralSystem
C++ Type
TfToken
Usd Type
SdfValueTypeNames->Token
static GetSchemaAttributeNames()
classmethod GetSchemaAttributeNames(includeInherited) -> list[TfToken]
Return a vector of names of all pre-declared attributes for this
schema class and all its ancestor classes.
Does not include attributes that may be authored by custom/extended
methods of the schemas involved.
Parameters
includeInherited (bool) –
class pxr.UsdProc.Tokens
Attributes:
proceduralSystem
proceduralSystem = 'proceduralSystem'
© Copyright 2019-2023, NVIDIA.
Last updated on Nov 14, 2023. |
omni.ui.MultiFloatDragField.md | MultiFloatDragField — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
MultiFloatDragField
# MultiFloatDragField
class omni.ui.MultiFloatDragField
Bases: AbstractMultiField
MultiFloatDragField is the widget that has a sub widget (FloatDrag) per model item.
It’s handy to use it for multi-component data, like for example, float3 or color.
Methods
__init__(*args, **kwargs)
Overloaded function.
Attributes
max
This property holds the drag's maximum value.
min
This property holds the drag's minimum value.
step
This property controls the steping speed on the drag.
__init__(*args, **kwargs)
Overloaded function.
__init__(self: omni.ui._ui.MultiFloatDragField, **kwargs) -> None
__init__(self: omni.ui._ui.MultiFloatDragField, arg0: omni.ui._ui.AbstractItemModel, **kwargs) -> None
__init__(self: omni.ui._ui.MultiFloatDragField, *args, **kwargs) -> None
Constructs MultiFloatDragField.
### Arguments:
`model :`The widget’s model. If the model is not assigned, the default model is created.
`kwargsdict`See below
### Keyword Arguments:
`min`This property holds the drag’s minimum value.
`max`This property holds the drag’s maximum value.
`step`This property controls the steping speed on the drag.
`column_count`The max number of fields in a line.
`h_spacing`Sets a non-stretchable horizontal space in pixels between child fields.
`v_spacing`Sets a non-stretchable vertical space in pixels between child fields.
`widthui.Length`This property holds the width of the widget relative to its parent. Do not use this function to find the width of a screen.
`heightui.Length`This property holds the height of the widget relative to its parent. Do not use this function to find the height of a screen.
`namestr`The name of the widget that user can set.
`style_type_name_overridestr`By default, we use typeName to look up the style. But sometimes it’s necessary to use a custom name. For example, when a widget is a part of another widget. (Label is a part of Button) This property can override the name to use in style.
`identifierstr`An optional identifier of the widget we can use to refer to it in queries.
`visiblebool`This property holds whether the widget is visible.
`visibleMinfloat`If the current zoom factor and DPI is less than this value, the widget is not visible.
`visibleMaxfloat`If the current zoom factor and DPI is bigger than this value, the widget is not visible.
`tooltipstr`Set a basic tooltip for the widget, this will simply be a Label, it will follow the Tooltip style
`tooltip_fnCallable`Set dynamic tooltip that will be created dynamiclly the first time it is needed. the function is called inside a ui.Frame scope that the widget will be parented correctly.
`tooltip_offset_xfloat`Set the X tooltip offset in points. In a normal state, the tooltip position is linked to the mouse position. If the tooltip offset is non zero, the top left corner of the tooltip is linked to the top left corner of the widget, and this property defines the relative position the tooltip should be shown.
`tooltip_offset_yfloat`Set the Y tooltip offset in points. In a normal state, the tooltip position is linked to the mouse position. If the tooltip offset is non zero, the top left corner of the tooltip is linked to the top left corner of the widget, and this property defines the relative position the tooltip should be shown.
`enabledbool`This property holds whether the widget is enabled. In general an enabled widget handles keyboard and mouse events; a disabled widget does not. And widgets display themselves differently when they are disabled.
`selectedbool`This property holds a flag that specifies the widget has to use eSelected state of the style.
`checkedbool`This property holds a flag that specifies the widget has to use eChecked state of the style. It’s on the Widget level because the button can have sub-widgets that are also should be checked.
`draggingbool`This property holds if the widget is being dragged.
`opaque_for_mouse_eventsbool`If the widgets has callback functions it will by default not capture the events if it is the top most widget and setup this option to true, so they don’t get routed to the child widgets either
`skip_draw_when_clippedbool`The flag that specifies if it’s necessary to bypass the whole draw cycle if the bounding box is clipped with a scrolling frame. It’s needed to avoid the limitation of 65535 primitives in a single draw list.
`mouse_moved_fnCallable`Sets the function that will be called when the user moves the mouse inside the widget. Mouse move events only occur if a mouse button is pressed while the mouse is being moved. void onMouseMoved(float x, float y, int32_t modifier)
`mouse_pressed_fnCallable`Sets the function that will be called when the user presses the mouse button inside the widget. The function should be like this: void onMousePressed(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier) Where ‘button’ is the number of the mouse button pressed. ‘modifier’ is the flag for the keyboard modifier key.
`mouse_released_fnCallable`Sets the function that will be called when the user releases the mouse button if this button was pressed inside the widget. void onMouseReleased(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)
`mouse_double_clicked_fnCallable`Sets the function that will be called when the user presses the mouse button twice inside the widget. The function specification is the same as in setMousePressedFn. void onMouseDoubleClicked(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)
`mouse_wheel_fnCallable`Sets the function that will be called when the user uses mouse wheel on the focused window. The function specification is the same as in setMousePressedFn. void onMouseWheel(float x, float y, carb::input::KeyboardModifierFlags modifier)
`mouse_hovered_fnCallable`Sets the function that will be called when the user use mouse enter/leave on the focused window. function specification is the same as in setMouseHovedFn. void onMouseHovered(bool hovered)
`drag_fnCallable`Specify that this Widget is draggable, and set the callback that is attached to the drag operation.
`accept_drop_fnCallable`Specify that this Widget can accept specific drops and set the callback that is called to check if the drop can be accepted.
`drop_fnCallable`Specify that this Widget accepts drops and set the callback to the drop operation.
`computed_content_size_changed_fnCallable`Called when the size of the widget is changed.
property max
This property holds the drag’s maximum value.
property min
This property holds the drag’s minimum value.
property step
This property controls the steping speed on the drag.
© Copyright 2019-2024, NVIDIA.
Last updated on Mar 25, 2024. |
omni.ui.get_main_window_height.md | get_main_window_height — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Functions »
get_main_window_height
# get_main_window_height
omni.ui.get_main_window_height() → float
Get the height in points of the current main window.
© Copyright 2019-2024, NVIDIA.
Last updated on Mar 25, 2024. |
GeomUtil.md | GeomUtil module — pxr-usd-api 105.1 documentation
pxr-usd-api
»
Modules »
GeomUtil module
# GeomUtil module
Summary: The GeomUtil module contains utilities to help image common geometry.
Utilities to help image common geometry.
Classes:
CapsuleMeshGenerator
This class provides an implementation for generating topology and point positions on a capsule.
ConeMeshGenerator
This class provides an implementation for generating topology and point positions on a cone of a given radius and height.
CuboidMeshGenerator
This class provides an implementation for generating topology and point positions on a rectangular cuboid given the dimensions along the X, Y and Z axes.
CylinderMeshGenerator
This class provides an implementation for generating topology and point positions on a cylinder with a given radius and height.
SphereMeshGenerator
This class provides an implementation for generating topology and point positions on a sphere with a given radius.
class pxr.GeomUtil.CapsuleMeshGenerator
This class provides an implementation for generating topology and
point positions on a capsule.
The simplest form takes a radius and height and is a cylinder capped
by two hemispheres that is centered at the origin. The generated
capsule is made up of circular cross-sections in the XY plane. Each
cross-section has numRadial segments. Successive cross-sections for
each of the hemispheres are generated at numCapAxial locations along
the Z and -Z axes respectively. The height is aligned with the Z axis
and represents the height of just the cylindrical portion.
An optional transform may be provided to GeneratePoints to orient the
capsule as necessary (e.g., whose height is along the Y axis).
An additional overload of GeneratePoints is provided to specify
different radii and heights for the bottom and top caps, as well as
the sweep angle for the capsule about the +Z axis. When the sweep is
less than 360 degrees, the generated geometry is not closed.
Usage:
const size_t numRadial = 4, numCapAxial = 4;
const size_t numPoints =
GeomUtilCapsuleMeshGenerator::ComputeNumPoints(numRadial, numCapAxial);
const float radius = 1, height = 2;
MyPointContainer<GfVec3f> points(numPoints);
GeomUtilCapsuleMeshGenerator::GeneratePoints(
points.begin(), numRadial, numCapAxial, radius, height);
Methods:
ComputeNumPoints
classmethod ComputeNumPoints(numRadial, numCapAxial, closedSweep) -> int
GeneratePoints
classmethod GeneratePoints(iter, numRadial, numCapAxial, radius, height, framePtr) -> None
GenerateTopology
classmethod GenerateTopology(numRadial, numCapAxial, closedSweep) -> MeshTopology
Attributes:
minNumCapAxial
minNumRadial
static ComputeNumPoints()
classmethod ComputeNumPoints(numRadial, numCapAxial, closedSweep) -> int
Parameters
numRadial (int) –
numCapAxial (int) –
closedSweep (bool) –
static GeneratePoints()
classmethod GeneratePoints(iter, numRadial, numCapAxial, radius, height, framePtr) -> None
Parameters
iter (PointIterType) –
numRadial (int) –
numCapAxial (int) –
radius (ScalarType) –
height (ScalarType) –
framePtr (Matrix4d) –
GeneratePoints(iter, numRadial, numCapAxial, bottomRadius, topRadius, height, bottomCapHeight, topCapHeight, sweepDegrees, framePtr) -> None
Parameters
iter (PointIterType) –
numRadial (int) –
numCapAxial (int) –
bottomRadius (ScalarType) –
topRadius (ScalarType) –
height (ScalarType) –
bottomCapHeight (ScalarType) –
topCapHeight (ScalarType) –
sweepDegrees (ScalarType) –
framePtr (Matrix4d) –
GeneratePoints(iter, arg2) -> None
Parameters
iter (PointIterType) –
arg2 –
static GenerateTopology()
classmethod GenerateTopology(numRadial, numCapAxial, closedSweep) -> MeshTopology
Parameters
numRadial (int) –
numCapAxial (int) –
closedSweep (bool) –
minNumCapAxial = 1
minNumRadial = 3
class pxr.GeomUtil.ConeMeshGenerator
This class provides an implementation for generating topology and
point positions on a cone of a given radius and height.
The cone is made up of circular cross-sections in the XY plane and is
centered at the origin. Each cross-section has numRadial segments. The
height is aligned with the Z axis, with the base of the object at Z =
-h/2 and apex at Z = h/2.
An optional transform may be provided to GeneratePoints to orient the
cone as necessary (e.g., whose height is along the Y axis).
An additional overload of GeneratePoints is provided to specify the
sweep angle for the cone about the +Z axis. When the sweep is less
than 360 degrees, the generated geometry is not closed.
Usage:
const size_t numRadial = 8;
const size_t numPoints =
GeomUtilConeMeshGenerator::ComputeNumPoints(numRadial);
const float radius = 1, height = 2;
MyPointContainer<GfVec3f> points(numPoints);
GeomUtilConeMeshGenerator::GeneratePoints(
points.begin(), numRadial, radius, height);
Methods:
ComputeNumPoints
classmethod ComputeNumPoints(numRadial, closedSweep) -> int
GeneratePoints
classmethod GeneratePoints(iter, numRadial, radius, height, framePtr) -> None
GenerateTopology
classmethod GenerateTopology(numRadial, closedSweep) -> MeshTopology
Attributes:
minNumRadial
static ComputeNumPoints()
classmethod ComputeNumPoints(numRadial, closedSweep) -> int
Parameters
numRadial (int) –
closedSweep (bool) –
static GeneratePoints()
classmethod GeneratePoints(iter, numRadial, radius, height, framePtr) -> None
Parameters
iter (PointIterType) –
numRadial (int) –
radius (ScalarType) –
height (ScalarType) –
framePtr (Matrix4d) –
GeneratePoints(iter, numRadial, radius, height, sweepDegrees, framePtr) -> None
Parameters
iter (PointIterType) –
numRadial (int) –
radius (ScalarType) –
height (ScalarType) –
sweepDegrees (ScalarType) –
framePtr (Matrix4d) –
GeneratePoints(iter, arg2) -> None
Parameters
iter (PointIterType) –
arg2 –
static GenerateTopology()
classmethod GenerateTopology(numRadial, closedSweep) -> MeshTopology
Parameters
numRadial (int) –
closedSweep (bool) –
minNumRadial = 3
class pxr.GeomUtil.CuboidMeshGenerator
This class provides an implementation for generating topology and
point positions on a rectangular cuboid given the dimensions along the
X, Y and Z axes.
The generated cuboid is centered at the origin.
An optional transform may be provided to GeneratePoints to orient the
cuboid as necessary.
Usage:
const size_t numPoints =
GeomUtilCuboidMeshGenerator::ComputeNumPoints();
const float l = 5, b = 4, h = 3;
MyPointContainer<GfVec3f> points(numPoints);
GeomUtilCuboidMeshGenerator::GeneratePoints(
points.begin(), l, b, h);
Methods:
ComputeNumPoints
classmethod ComputeNumPoints() -> int
GeneratePoints
classmethod GeneratePoints(iter, xLength, yLength, zLength, framePtr) -> None
GenerateTopology
classmethod GenerateTopology() -> MeshTopology
static ComputeNumPoints()
classmethod ComputeNumPoints() -> int
static GeneratePoints()
classmethod GeneratePoints(iter, xLength, yLength, zLength, framePtr) -> None
Parameters
iter (PointIterType) –
xLength (ScalarType) –
yLength (ScalarType) –
zLength (ScalarType) –
framePtr (Matrix4d) –
GeneratePoints(iter, arg2) -> None
Parameters
iter (PointIterType) –
arg2 –
static GenerateTopology()
classmethod GenerateTopology() -> MeshTopology
class pxr.GeomUtil.CylinderMeshGenerator
This class provides an implementation for generating topology and
point positions on a cylinder with a given radius and height.
The cylinder is made up of circular cross-sections in the XY plane and
is centered at the origin. Each cross-section has numRadial segments.
The height is aligned with the Z axis, with the base at Z = -h/2.
An optional transform may be provided to GeneratePoints to orient the
cone as necessary (e.g., whose height is along the Y axis).
An additional overload of GeneratePoints is provided to specify
different radii for the bottom and top discs of the cylinder and a
sweep angle for cylinder about the +Z axis. When the sweep is less
than 360 degrees, the generated geometry is not closed.
Setting one radius to 0 in order to get a cone is inefficient and
could result in artifacts. Clients should use
GeomUtilConeMeshGenerator instead. Usage:
const size_t numRadial = 8;
const size_t numPoints =
GeomUtilCylinderMeshGenerator::ComputeNumPoints(numRadial);
const float radius = 1, height = 2;
MyPointContainer<GfVec3f> points(numPoints);
GeomUtilCylinderMeshGenerator::GeneratePoints(
points.begin(), numRadial, radius, height);
Methods:
ComputeNumPoints
classmethod ComputeNumPoints(numRadial, closedSweep) -> int
GeneratePoints
classmethod GeneratePoints(iter, numRadial, radius, height, framePtr) -> None
GenerateTopology
classmethod GenerateTopology(numRadial, closedSweep) -> MeshTopology
Attributes:
minNumRadial
static ComputeNumPoints()
classmethod ComputeNumPoints(numRadial, closedSweep) -> int
Parameters
numRadial (int) –
closedSweep (bool) –
static GeneratePoints()
classmethod GeneratePoints(iter, numRadial, radius, height, framePtr) -> None
Parameters
iter (PointIterType) –
numRadial (int) –
radius (ScalarType) –
height (ScalarType) –
framePtr (Matrix4d) –
GeneratePoints(iter, numRadial, bottomRadius, topRadius, height, sweepDegrees, framePtr) -> None
Parameters
iter (PointIterType) –
numRadial (int) –
bottomRadius (ScalarType) –
topRadius (ScalarType) –
height (ScalarType) –
sweepDegrees (ScalarType) –
framePtr (Matrix4d) –
GeneratePoints(iter, arg2) -> None
Parameters
iter (PointIterType) –
arg2 –
static GenerateTopology()
classmethod GenerateTopology(numRadial, closedSweep) -> MeshTopology
Parameters
numRadial (int) –
closedSweep (bool) –
minNumRadial = 3
class pxr.GeomUtil.SphereMeshGenerator
This class provides an implementation for generating topology and
point positions on a sphere with a given radius.
The sphere is made up of circular cross-sections in the XY plane and
is centered at the origin. Each cross-section has numRadial segments.
Successive cross-sections are generated at numAxial locations along
the Z axis, with the bottom of the sphere at Z = -r and top at Z = r.
An optional transform may be provided to GeneratePoints to orient the
sphere as necessary (e.g., cross-sections in the YZ plane).
An additional overload of GeneratePoints is provided to specify a
sweep angle for the sphere about the +Z axis. When the sweep is less
than 360 degrees, the generated geometry is not closed.
Usage:
const size_t numRadial = 4, numAxial = 4;
const size_t numPoints =
GeomUtilSphereMeshGenerator::ComputeNumPoints(numRadial, numAxial);
const float radius = 5;
MyPointContainer<GfVec3f> points(numPoints);
GeomUtilSphereMeshGenerator::GeneratePoints(
points.begin(), numRadial, numAxial, radius);
Methods:
ComputeNumPoints
classmethod ComputeNumPoints(numRadial, numAxial, closedSweep) -> int
GeneratePoints
classmethod GeneratePoints(iter, numRadial, numAxial, radius, framePtr) -> None
GenerateTopology
classmethod GenerateTopology(numRadial, numAxial, closedSweep) -> MeshTopology
Attributes:
minNumAxial
minNumRadial
static ComputeNumPoints()
classmethod ComputeNumPoints(numRadial, numAxial, closedSweep) -> int
Parameters
numRadial (int) –
numAxial (int) –
closedSweep (bool) –
static GeneratePoints()
classmethod GeneratePoints(iter, numRadial, numAxial, radius, framePtr) -> None
Parameters
iter (PointIterType) –
numRadial (int) –
numAxial (int) –
radius (ScalarType) –
framePtr (Matrix4d) –
GeneratePoints(iter, numRadial, numAxial, radius, sweepDegrees, framePtr) -> None
Parameters
iter (PointIterType) –
numRadial (int) –
numAxial (int) –
radius (ScalarType) –
sweepDegrees (ScalarType) –
framePtr (Matrix4d) –
GeneratePoints(iter, arg2) -> None
Parameters
iter (PointIterType) –
arg2 –
static GenerateTopology()
classmethod GenerateTopology(numRadial, numAxial, closedSweep) -> MeshTopology
Parameters
numRadial (int) –
numAxial (int) –
closedSweep (bool) –
minNumAxial = 2
minNumRadial = 3
© Copyright 2019-2023, NVIDIA.
Last updated on Nov 14, 2023. |
omni.ui.Workspace.md | Workspace — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
Workspace
# Workspace
class omni.ui.Workspace
Bases: pybind11_object
Workspace object provides access to the windows in Kit.
Methods
__init__(*args, **kwargs)
clear()
Undock all.
compare_workspace([compare_delegate])
Compare current docked windows according to the workspace description.
dump_workspace()
Capture current workspace and return the dict with the description of the docking state and window size.
get_dock_children_id(dock_id)
Get two dock children of the given dock ID.
get_dock_id_height(dock_id)
Returns the height of the docking node.
get_dock_id_width(dock_id)
Returns the width of the docking node.
get_dock_position(dock_id)
Returns the position of the given dock ID.
get_docked_neighbours(member)
Get all the windows that docked with the given widow.
get_docked_windows(dock_id)
Get all the windows of the given dock ID.
get_dpi_scale()
Returns current DPI Scale.
get_main_window_height()
Get the height in points of the current main window.
get_main_window_width()
Get the width in points of the current main window.
get_parent_dock_id(dock_id)
Return the parent Dock Node ID.
get_selected_window_index(dock_id)
Get currently selected window inedx from the given dock id.
get_window(title)
Find Window by name.
get_window_from_callback(callback)
Find Window by window callback.
get_windows()
Returns the list of windows ordered from back to front.
remove_window_visibility_changed_callback(fn)
Remove the callback that is triggered when window's visibility changed.
restore_workspace([keep_windows_open])
Dock the windows according to the workspace description.
set_dock_id_height(dock_id, height)
Set the height of the dock node.
set_dock_id_width(dock_id, width)
Set the width of the dock node.
set_show_window_fn(title, fn)
Add the callback to create a window with the given title.
set_window_created_callback(fn)
Addd the callback that is triggered when a new window is created.
set_window_visibility_changed_callback(fn)
Add the callback that is triggered when window's visibility changed.
show_window(title[, show])
Makes the window visible or create the window with the callback provided with set_show_window_fn.
__init__(*args, **kwargs)
static clear() → None
Undock all.
compare_workspace(compare_delegate: ~omni.ui.workspace_utils.CompareDelegate = <omni.ui.workspace_utils.CompareDelegate object>)
Compare current docked windows according to the workspace description.
### Arguments
`workspace_dumpList[Any]`The dictionary with the description of the layout. It’s the dict
received from `dump_workspace`.
dump_workspace()
Capture current workspace and return the dict with the description of the
docking state and window size.
static get_dock_children_id(dock_id: int) → object
Get two dock children of the given dock ID.
true if the given dock ID has children
### Arguments:
`dockId :`the given dock ID
`first :`output. the first child dock ID
`second :`output. the second child dock ID
static get_dock_id_height(dock_id: int) → float
Returns the height of the docking node.
It’s different from the window height because it considers dock tab bar.
### Arguments:
`dockId :`the given dock ID
static get_dock_id_width(dock_id: int) → float
Returns the width of the docking node.
### Arguments:
`dockId :`the given dock ID
static get_dock_position(dock_id: int) → omni.ui._ui.DockPosition
Returns the position of the given dock ID. Left/Right/Top/Bottom.
static get_docked_neighbours(member: omni.ui._ui.WindowHandle) → List[omni.ui._ui.WindowHandle]
Get all the windows that docked with the given widow.
static get_docked_windows(dock_id: int) → List[omni.ui._ui.WindowHandle]
Get all the windows of the given dock ID.
static get_dpi_scale() → float
Returns current DPI Scale.
static get_main_window_height() → float
Get the height in points of the current main window.
static get_main_window_width() → float
Get the width in points of the current main window.
static get_parent_dock_id(dock_id: int) → int
Return the parent Dock Node ID.
### Arguments:
`dockId :`the child Dock Node ID to get parent
static get_selected_window_index(dock_id: int) → int
Get currently selected window inedx from the given dock id.
static get_window(title: str) → omni.ui._ui.WindowHandle
Find Window by name.
static get_window_from_callback(callback: omni::ui::windowmanager::IWindowCallback) → omni.ui._ui.WindowHandle
Find Window by window callback.
static get_windows() → List[omni.ui._ui.WindowHandle]
Returns the list of windows ordered from back to front.
If the window is a Omni::UI window, it can be upcasted.
static remove_window_visibility_changed_callback(fn: int) → None
Remove the callback that is triggered when window’s visibility changed.
restore_workspace(keep_windows_open=False)
Dock the windows according to the workspace description.
### Arguments
`workspace_dumpList[Any]`The dictionary with the description of the layout. It’s the dict
received from `dump_workspace`.
`keep_windows_openbool`Determines if it’s necessary to hide the already opened windows that
are not present in `workspace_dump`.
static set_dock_id_height(dock_id: int, height: float) → None
Set the height of the dock node.
It also sets the height of parent nodes if necessary and modifies the height of siblings.
### Arguments:
`dockId :`the given dock ID
`height :`the given height
static set_dock_id_width(dock_id: int, width: float) → None
Set the width of the dock node.
It also sets the width of parent nodes if necessary and modifies the width of siblings.
### Arguments:
`dockId :`the given dock ID
`width :`the given width
static set_show_window_fn(title: str, fn: Callable[[bool], None]) → None
Add the callback to create a window with the given title. When the callback’s argument is true, it’s necessary to create the window. Otherwise remove.
static set_window_created_callback(fn: Callable[[omni.ui._ui.WindowHandle], None]) → None
Addd the callback that is triggered when a new window is created.
static set_window_visibility_changed_callback(fn: Callable[[str, bool], None]) → int
Add the callback that is triggered when window’s visibility changed.
static show_window(title: str, show: bool = True) → bool
Makes the window visible or create the window with the callback provided with set_show_window_fn.
true if the window is already created, otherwise it’s necessary to wait one frame
### Arguments:
`title :`the given window title
`show :`true to show, false to hide
© Copyright 2019-2024, NVIDIA.
Last updated on Mar 25, 2024. |
1_2_8.md | 1.2.8 — Omniverse Launcher latest documentation
Omniverse Launcher
»
Omniverse Launcher »
Release Notes »
1.2.8
# 1.2.8
Release Date: Aug 2021
## Spotlight Features
Previous Versions
Users can now install previous version of Omniverse via a new and improved interface.
Easy Links
When opening files for the first time from a linked location, launcher now confirms the app to load with.
Users can also set the default app manually in settings.
## Added
Allow to customize system requirements for installable components.
Display a notification when applications are successfully uninstalled.
Added a smooth transition animation for the library tab.
Added thin packaging support - allows splitting large components into smaller packages that can be reused.
Added “Exit” button to the user menu.
Support installing previous versions of applications and connectors.
Added new dialog to select the default application used to open Omniverse links.
Support markdown for component description.
Show an error message on startup if Launcher can’t read the library database file.
## Changed
Scale side menu on the exchange tab based on the screen size.
Updated Starfleet integration to use name instead of preferred_username.
Renamed Download Launcher button to Download Enterprise Launcher
Display “News” tab inside of Launcher.
Use thumbnail images on the exchange tab to optimize page load time.
Disable Launch button for three seconds after click to prevent launching apps multiple times.
Display an error when iframes can’t load the external web page.
Update privacy settings on a new login.
Renamed “Collaboration” tab to “Nucleus”.
Updated “News” and “Learn” links to hide the website header.
Support tables and headers for component description via Markdown and HTML.
Changed the inactive tab color on the library tab.
Made Launcher errors more readable.
“News” and “Learn” tabs open a web browser now instead of showing these pages in iframes.
## Fixed
Fixed issues where users could install or update the same app more than once.
Fixed resizing of the main window at the top.
Fixed issues with scrolling the exchange tab when the featured section is available.
Fixed showing the main window on system startup (Launcher will be hidden in the system tray).
Ignore system errors when Launcher removes installed components.
Fixed an issue when users could not change their current account without a reboot.
Fixed race condition when users rapidly click on the installer pause button multiple times.
Fixed an issue with installers not queueing up in the correct order.
Fixed missing vendor prefix for desktop files on Linux to register a custom protocol handler.
Fixed issues with floating carousel images for featured components.
Preserve unknown fields in privacy.toml file.
Invalidate cached HTTP responses on a startup.
Fixed issues with cached URLs for loading applications and their versions.
Fixed installing previous versions of applications that don’t support side-by-side installations.
Fixed thin package installer did not create intermediate folders for installed packages.
Refresh auth tokens when external apps query /auth endpoint.
Fixed displaying loading state on the Nucleus tab if Nucleus installer fails.
Fixed issue with components not been marked as installed.
Fixed sorting of exchange components in the left menu.
Fixed displaying hidden components on the library tab after installation.
Allow Launcher to start without downloading the GDPR agreement if it’s accepted already.
Fixed running applications that require the finalize script after install.
Fixed running applications that require the finalize script after install.
## Removed
Launcher Cleanup tool disabled from running during uninstall/reinstall in Windows.
Removed OS and Video Driver from system requirements.
© Copyright 2023-2024, NVIDIA.
Last updated on Apr 15, 2024. |
omni.ui.AbstractMultiField.md | AbstractMultiField — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
AbstractMultiField
# AbstractMultiField
class omni.ui.AbstractMultiField
Bases: Widget, ItemModelHelper
AbstractMultiField is the abstract class that has everything to create a custom widget per model item.
The class that wants to create multiple widgets per item needs to reimplement the method _createField.
Methods
__init__(*args, **kwargs)
Attributes
column_count
The max number of fields in a line.
h_spacing
Sets a non-stretchable horizontal space in pixels between child fields.
v_spacing
Sets a non-stretchable vertical space in pixels between child fields.
__init__(*args, **kwargs)
property column_count
The max number of fields in a line.
property h_spacing
Sets a non-stretchable horizontal space in pixels between child fields.
property v_spacing
Sets a non-stretchable vertical space in pixels between child fields.
© Copyright 2019-2024, NVIDIA.
Last updated on Mar 25, 2024. |
omni.ui.Ellipse.md | Ellipse — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
Ellipse
# Ellipse
class omni.ui.Ellipse
Bases: Shape
Constructs Ellipse.
`kwargsdict`See below
### Keyword Arguments:
`widthui.Length`This property holds the width of the widget relative to its parent. Do not use this function to find the width of a screen.
`heightui.Length`This property holds the height of the widget relative to its parent. Do not use this function to find the height of a screen.
`namestr`The name of the widget that user can set.
`style_type_name_overridestr`By default, we use typeName to look up the style. But sometimes it’s necessary to use a custom name. For example, when a widget is a part of another widget. (Label is a part of Button) This property can override the name to use in style.
`identifierstr`An optional identifier of the widget we can use to refer to it in queries.
`visiblebool`This property holds whether the widget is visible.
`visibleMinfloat`If the current zoom factor and DPI is less than this value, the widget is not visible.
`visibleMaxfloat`If the current zoom factor and DPI is bigger than this value, the widget is not visible.
`tooltipstr`Set a basic tooltip for the widget, this will simply be a Label, it will follow the Tooltip style
`tooltip_fnCallable`Set dynamic tooltip that will be created dynamiclly the first time it is needed. the function is called inside a ui.Frame scope that the widget will be parented correctly.
`tooltip_offset_xfloat`Set the X tooltip offset in points. In a normal state, the tooltip position is linked to the mouse position. If the tooltip offset is non zero, the top left corner of the tooltip is linked to the top left corner of the widget, and this property defines the relative position the tooltip should be shown.
`tooltip_offset_yfloat`Set the Y tooltip offset in points. In a normal state, the tooltip position is linked to the mouse position. If the tooltip offset is non zero, the top left corner of the tooltip is linked to the top left corner of the widget, and this property defines the relative position the tooltip should be shown.
`enabledbool`This property holds whether the widget is enabled. In general an enabled widget handles keyboard and mouse events; a disabled widget does not. And widgets display themselves differently when they are disabled.
`selectedbool`This property holds a flag that specifies the widget has to use eSelected state of the style.
`checkedbool`This property holds a flag that specifies the widget has to use eChecked state of the style. It’s on the Widget level because the button can have sub-widgets that are also should be checked.
`draggingbool`This property holds if the widget is being dragged.
`opaque_for_mouse_eventsbool`If the widgets has callback functions it will by default not capture the events if it is the top most widget and setup this option to true, so they don’t get routed to the child widgets either
`skip_draw_when_clippedbool`The flag that specifies if it’s necessary to bypass the whole draw cycle if the bounding box is clipped with a scrolling frame. It’s needed to avoid the limitation of 65535 primitives in a single draw list.
`mouse_moved_fnCallable`Sets the function that will be called when the user moves the mouse inside the widget. Mouse move events only occur if a mouse button is pressed while the mouse is being moved. void onMouseMoved(float x, float y, int32_t modifier)
`mouse_pressed_fnCallable`Sets the function that will be called when the user presses the mouse button inside the widget. The function should be like this: void onMousePressed(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier) Where ‘button’ is the number of the mouse button pressed. ‘modifier’ is the flag for the keyboard modifier key.
`mouse_released_fnCallable`Sets the function that will be called when the user releases the mouse button if this button was pressed inside the widget. void onMouseReleased(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)
`mouse_double_clicked_fnCallable`Sets the function that will be called when the user presses the mouse button twice inside the widget. The function specification is the same as in setMousePressedFn. void onMouseDoubleClicked(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)
`mouse_wheel_fnCallable`Sets the function that will be called when the user uses mouse wheel on the focused window. The function specification is the same as in setMousePressedFn. void onMouseWheel(float x, float y, carb::input::KeyboardModifierFlags modifier)
`mouse_hovered_fnCallable`Sets the function that will be called when the user use mouse enter/leave on the focused window. function specification is the same as in setMouseHovedFn. void onMouseHovered(bool hovered)
`drag_fnCallable`Specify that this Widget is draggable, and set the callback that is attached to the drag operation.
`accept_drop_fnCallable`Specify that this Widget can accept specific drops and set the callback that is called to check if the drop can be accepted.
`drop_fnCallable`Specify that this Widget accepts drops and set the callback to the drop operation.
`computed_content_size_changed_fnCallable`Called when the size of the widget is changed.
Methods
__init__(self, **kwargs)
Attributes
__init__(self: omni.ui._ui.Ellipse, **kwargs) → None
© Copyright 2019-2024, NVIDIA.
Last updated on Mar 25, 2024. |
omni.ui.ImageWithProvider.md | ImageWithProvider — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
ImageWithProvider
# ImageWithProvider
class omni.ui.ImageWithProvider
Bases: Widget
The Image widget displays an image.
The source of the image is specified as a URL using the source property. By default, specifying the width and height of the item causes the image to be scaled to that size. This behavior can be changed by setting the fill_mode property, allowing the image to be stretched or scaled instead. The property alignment controls where to align the scaled image.
Methods
__init__(*args, **kwargs)
Overloaded function.
prepare_draw(self, width, height)
Force call `ImageProvider::prepareDraw` to ensure the next draw call the image is loaded.
Attributes
alignment
This property holds the alignment of the image when the fill policy is ePreserveAspectFit or ePreserveAspectCrop.
fill_policy
Define what happens when the source image has a different size than the item.
pixel_aligned
Prevents image blurring when it's placed to fractional position (like x=0.5, y=0.5)
__init__(*args, **kwargs)
Overloaded function.
__init__(self: omni.ui._ui.ImageWithProvider, arg0: ImageProvider, **kwargs) -> None
__init__(self: omni.ui._ui.ImageWithProvider, arg0: str, **kwargs) -> None
__init__(self: omni.ui._ui.ImageWithProvider, **kwargs) -> None
Construct image with given ImageProvider. If the ImageProvider is nullptr, it gets the image URL from styling.
`kwargsdict`See below
### Keyword Arguments:
`alignment`This property holds the alignment of the image when the fill policy is ePreserveAspectFit or ePreserveAspectCrop. By default, the image is centered.
`fill_policy`Define what happens when the source image has a different size than the item.
`pixel_aligned`Prevents image blurring when it’s placed to fractional position (like x=0.5, y=0.5)
`widthui.Length`This property holds the width of the widget relative to its parent. Do not use this function to find the width of a screen.
`heightui.Length`This property holds the height of the widget relative to its parent. Do not use this function to find the height of a screen.
`namestr`The name of the widget that user can set.
`style_type_name_overridestr`By default, we use typeName to look up the style. But sometimes it’s necessary to use a custom name. For example, when a widget is a part of another widget. (Label is a part of Button) This property can override the name to use in style.
`identifierstr`An optional identifier of the widget we can use to refer to it in queries.
`visiblebool`This property holds whether the widget is visible.
`visibleMinfloat`If the current zoom factor and DPI is less than this value, the widget is not visible.
`visibleMaxfloat`If the current zoom factor and DPI is bigger than this value, the widget is not visible.
`tooltipstr`Set a basic tooltip for the widget, this will simply be a Label, it will follow the Tooltip style
`tooltip_fnCallable`Set dynamic tooltip that will be created dynamiclly the first time it is needed. the function is called inside a ui.Frame scope that the widget will be parented correctly.
`tooltip_offset_xfloat`Set the X tooltip offset in points. In a normal state, the tooltip position is linked to the mouse position. If the tooltip offset is non zero, the top left corner of the tooltip is linked to the top left corner of the widget, and this property defines the relative position the tooltip should be shown.
`tooltip_offset_yfloat`Set the Y tooltip offset in points. In a normal state, the tooltip position is linked to the mouse position. If the tooltip offset is non zero, the top left corner of the tooltip is linked to the top left corner of the widget, and this property defines the relative position the tooltip should be shown.
`enabledbool`This property holds whether the widget is enabled. In general an enabled widget handles keyboard and mouse events; a disabled widget does not. And widgets display themselves differently when they are disabled.
`selectedbool`This property holds a flag that specifies the widget has to use eSelected state of the style.
`checkedbool`This property holds a flag that specifies the widget has to use eChecked state of the style. It’s on the Widget level because the button can have sub-widgets that are also should be checked.
`draggingbool`This property holds if the widget is being dragged.
`opaque_for_mouse_eventsbool`If the widgets has callback functions it will by default not capture the events if it is the top most widget and setup this option to true, so they don’t get routed to the child widgets either
`skip_draw_when_clippedbool`The flag that specifies if it’s necessary to bypass the whole draw cycle if the bounding box is clipped with a scrolling frame. It’s needed to avoid the limitation of 65535 primitives in a single draw list.
`mouse_moved_fnCallable`Sets the function that will be called when the user moves the mouse inside the widget. Mouse move events only occur if a mouse button is pressed while the mouse is being moved. void onMouseMoved(float x, float y, int32_t modifier)
`mouse_pressed_fnCallable`Sets the function that will be called when the user presses the mouse button inside the widget. The function should be like this: void onMousePressed(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier) Where ‘button’ is the number of the mouse button pressed. ‘modifier’ is the flag for the keyboard modifier key.
`mouse_released_fnCallable`Sets the function that will be called when the user releases the mouse button if this button was pressed inside the widget. void onMouseReleased(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)
`mouse_double_clicked_fnCallable`Sets the function that will be called when the user presses the mouse button twice inside the widget. The function specification is the same as in setMousePressedFn. void onMouseDoubleClicked(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)
`mouse_wheel_fnCallable`Sets the function that will be called when the user uses mouse wheel on the focused window. The function specification is the same as in setMousePressedFn. void onMouseWheel(float x, float y, carb::input::KeyboardModifierFlags modifier)
`mouse_hovered_fnCallable`Sets the function that will be called when the user use mouse enter/leave on the focused window. function specification is the same as in setMouseHovedFn. void onMouseHovered(bool hovered)
`drag_fnCallable`Specify that this Widget is draggable, and set the callback that is attached to the drag operation.
`accept_drop_fnCallable`Specify that this Widget can accept specific drops and set the callback that is called to check if the drop can be accepted.
`drop_fnCallable`Specify that this Widget accepts drops and set the callback to the drop operation.
`computed_content_size_changed_fnCallable`Called when the size of the widget is changed.
prepare_draw(self: omni.ui._ui.ImageWithProvider, width: float, height: float) → None
Force call `ImageProvider::prepareDraw` to ensure the next draw call the image is loaded. It can be used to load the image for a hidden widget or to set the rasterization resolution.
property alignment
This property holds the alignment of the image when the fill policy is ePreserveAspectFit or ePreserveAspectCrop. By default, the image is centered.
property fill_policy
Define what happens when the source image has a different size than the item.
property pixel_aligned
Prevents image blurring when it’s placed to fractional position (like x=0.5, y=0.5)
© Copyright 2019-2024, NVIDIA.
Last updated on Mar 25, 2024. |
omni.ui.Plot.md | Plot — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
Plot
# Plot
class omni.ui.Plot
Bases: Widget
The Plot widget provides a line/histogram to display.
Methods
__init__(self, type, scale_min, scale_max, ...)
Construct Plot.
set_data(self, *args)
Sets the image data value.
set_data_provider_fn(self, arg0, arg1)
Sets the function that will be called when when data required.
set_xy_data(self, arg0)
Attributes
scale_max
This property holds the max scale values.
scale_min
This property holds the min scale values.
title
This property holds the title of the image.
type
This property holds the type of the image, can only be line or histogram.
value_offset
This property holds the value offset.
value_stride
This property holds the stride to get value list.
__init__(self: omni.ui._ui.Plot, type: omni.ui._ui.Type = <Type.LINE: 0>, scale_min: float = 3.4028234663852886e+38, scale_max: float = 3.4028234663852886e+38, *args, **kwargs) → None
Construct Plot.
### Arguments:
`type :`The type of the image, can be line or histogram.
`scaleMin :`The minimal scale value.
`scaleMax :`The maximum scale value.
`valueList :`The list of values to draw the image.
`kwargsdict`See below
### Keyword Arguments:
`value_offsetint`This property holds the value offset. By default, the value is 0.
`value_strideint`This property holds the stride to get value list. By default, the value is 1.
`titlestr`This property holds the title of the image.
`widthui.Length`This property holds the width of the widget relative to its parent. Do not use this function to find the width of a screen.
`heightui.Length`This property holds the height of the widget relative to its parent. Do not use this function to find the height of a screen.
`namestr`The name of the widget that user can set.
`style_type_name_overridestr`By default, we use typeName to look up the style. But sometimes it’s necessary to use a custom name. For example, when a widget is a part of another widget. (Label is a part of Button) This property can override the name to use in style.
`identifierstr`An optional identifier of the widget we can use to refer to it in queries.
`visiblebool`This property holds whether the widget is visible.
`visibleMinfloat`If the current zoom factor and DPI is less than this value, the widget is not visible.
`visibleMaxfloat`If the current zoom factor and DPI is bigger than this value, the widget is not visible.
`tooltipstr`Set a basic tooltip for the widget, this will simply be a Label, it will follow the Tooltip style
`tooltip_fnCallable`Set dynamic tooltip that will be created dynamiclly the first time it is needed. the function is called inside a ui.Frame scope that the widget will be parented correctly.
`tooltip_offset_xfloat`Set the X tooltip offset in points. In a normal state, the tooltip position is linked to the mouse position. If the tooltip offset is non zero, the top left corner of the tooltip is linked to the top left corner of the widget, and this property defines the relative position the tooltip should be shown.
`tooltip_offset_yfloat`Set the Y tooltip offset in points. In a normal state, the tooltip position is linked to the mouse position. If the tooltip offset is non zero, the top left corner of the tooltip is linked to the top left corner of the widget, and this property defines the relative position the tooltip should be shown.
`enabledbool`This property holds whether the widget is enabled. In general an enabled widget handles keyboard and mouse events; a disabled widget does not. And widgets display themselves differently when they are disabled.
`selectedbool`This property holds a flag that specifies the widget has to use eSelected state of the style.
`checkedbool`This property holds a flag that specifies the widget has to use eChecked state of the style. It’s on the Widget level because the button can have sub-widgets that are also should be checked.
`draggingbool`This property holds if the widget is being dragged.
`opaque_for_mouse_eventsbool`If the widgets has callback functions it will by default not capture the events if it is the top most widget and setup this option to true, so they don’t get routed to the child widgets either
`skip_draw_when_clippedbool`The flag that specifies if it’s necessary to bypass the whole draw cycle if the bounding box is clipped with a scrolling frame. It’s needed to avoid the limitation of 65535 primitives in a single draw list.
`mouse_moved_fnCallable`Sets the function that will be called when the user moves the mouse inside the widget. Mouse move events only occur if a mouse button is pressed while the mouse is being moved. void onMouseMoved(float x, float y, int32_t modifier)
`mouse_pressed_fnCallable`Sets the function that will be called when the user presses the mouse button inside the widget. The function should be like this: void onMousePressed(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier) Where ‘button’ is the number of the mouse button pressed. ‘modifier’ is the flag for the keyboard modifier key.
`mouse_released_fnCallable`Sets the function that will be called when the user releases the mouse button if this button was pressed inside the widget. void onMouseReleased(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)
`mouse_double_clicked_fnCallable`Sets the function that will be called when the user presses the mouse button twice inside the widget. The function specification is the same as in setMousePressedFn. void onMouseDoubleClicked(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)
`mouse_wheel_fnCallable`Sets the function that will be called when the user uses mouse wheel on the focused window. The function specification is the same as in setMousePressedFn. void onMouseWheel(float x, float y, carb::input::KeyboardModifierFlags modifier)
`mouse_hovered_fnCallable`Sets the function that will be called when the user use mouse enter/leave on the focused window. function specification is the same as in setMouseHovedFn. void onMouseHovered(bool hovered)
`drag_fnCallable`Specify that this Widget is draggable, and set the callback that is attached to the drag operation.
`accept_drop_fnCallable`Specify that this Widget can accept specific drops and set the callback that is called to check if the drop can be accepted.
`drop_fnCallable`Specify that this Widget accepts drops and set the callback to the drop operation.
`computed_content_size_changed_fnCallable`Called when the size of the widget is changed.
set_data(self: omni.ui._ui.Plot, *args) → None
Sets the image data value.
set_data_provider_fn(self: omni.ui._ui.Plot, arg0: Callable[[int], float], arg1: int) → None
Sets the function that will be called when when data required.
set_xy_data(self: omni.ui._ui.Plot, arg0: List[Tuple[float, float]]) → None
property scale_max
This property holds the max scale values. By default, the value is FLT_MAX.
property scale_min
This property holds the min scale values. By default, the value is FLT_MAX.
property title
This property holds the title of the image.
property type
This property holds the type of the image, can only be line or histogram. By default, the type is line.
property value_offset
This property holds the value offset. By default, the value is 0.
property value_stride
This property holds the stride to get value list. By default, the value is 1.
© Copyright 2019-2024, NVIDIA.
Last updated on Mar 25, 2024. |
Plug.md | Plug module — pxr-usd-api 105.1 documentation
pxr-usd-api
»
Modules »
Plug module
# Plug module
Summary: Provides a plug-in framework implementation. Define interfaces, discover, register, and apply plug-in modules to nodes.
This package defines facilities for dealing with plugins.
Classes:
Notice
Notifications sent by the Plug module.
Plugin
Defines an interface to registered plugins.
Registry
Defines an interface for registering plugins.
class pxr.Plug.Notice
Notifications sent by the Plug module.
Classes:
Base
DidRegisterPlugins
class Base
class DidRegisterPlugins
Methods:
GetNewPlugins
GetNewPlugins()
class pxr.Plug.Plugin
Defines an interface to registered plugins.
Plugins are registered using the interfaces in PlugRegistry .
For each registered plugin, there is an instance of PlugPlugin
which can be used to load and unload the plugin and to retrieve
information about the classes implemented by the plugin.
Methods:
DeclaresType(type, includeSubclasses)
Returns true if type is declared by this plugin.
FindPluginResource(path, verify)
Find a plugin resource by absolute or relative path optionally verifying that file exists.
GetMetadataForType(type)
Returns the metadata sub-dictionary for a particular type.
Load()
Loads the plugin.
MakeResourcePath(path)
Build a plugin resource path by returning a given absolute path or combining the plugin's resource path with a given relative path.
Attributes:
expired
True if this object has expired, False otherwise.
isLoaded
bool
isPythonModule
bool
isResource
bool
metadata
JsObject
name
str
path
str
resourcePath
str
DeclaresType(type, includeSubclasses) → bool
Returns true if type is declared by this plugin.
If includeSubclasses is specified, also returns true if any
subclasses of type have been declared.
Parameters
type (Type) –
includeSubclasses (bool) –
FindPluginResource(path, verify) → str
Find a plugin resource by absolute or relative path optionally
verifying that file exists.
If verification fails an empty path is returned. Relative paths are
relative to the plugin’s resource path.
Parameters
path (str) –
verify (bool) –
GetMetadataForType(type) → JsObject
Returns the metadata sub-dictionary for a particular type.
Parameters
type (Type) –
Load() → bool
Loads the plugin.
This is a noop if the plugin is already loaded.
MakeResourcePath(path) → str
Build a plugin resource path by returning a given absolute path or
combining the plugin’s resource path with a given relative path.
Parameters
path (str) –
property expired
True if this object has expired, False otherwise.
property isLoaded
bool
Returns true if the plugin is currently loaded.
Resource plugins always report as loaded.
Type
type
property isPythonModule
bool
Returns true if the plugin is a python module.
Type
type
property isResource
bool
Returns true if the plugin is resource-only.
Type
type
property metadata
JsObject
Returns the dictionary containing meta-data for the plugin.
Type
type
property name
str
Returns the plugin’s name.
Type
type
property path
str
Returns the plugin’s filesystem path.
Type
type
property resourcePath
str
Returns the plugin’s resources filesystem path.
Type
type
class pxr.Plug.Registry
Defines an interface for registering plugins.
PlugRegistry maintains a registry of plug-ins known to the system and
provides an interface for base classes to load any plug-ins required
to instantiate a subclass of a given type.
## Defining a Base Class API
In order to use this facility you will generally provide a module
which defines the API for a plug-in base class. This API will be
sufficient for the application or framework to make use of custom
subclasses that will be written by plug-in developers.
For example, if you have an image processing application, you might
want to support plug-ins that implement image filters. You can define
an abstract base class for image filters that declares the API your
application will require image filters to implement; perhaps something
simple like C++ Code Example 1 (Doxygen only).
People writing custom filters would write a subclass of ImageFilter
that overrides the two methods, implementing their own special
filtering behavior.
## Enabling Plug-in Loading for the Base Class
In order for ImageFilter to be able to load plug-ins that implement
these custom subclasses, it must be registered with the TfType system.
The ImageFilter base class, as was mentioned earlier, should be made
available in a module that the application links with. This is done
so that plug-ins that want to provide ImageFilters can also link with
the module allowing them to subclass ImageFilter.
## Registering Plug-ins
A plug-in developer can now write plug-ins with ImageFilter
subclasses. Plug-ins can be implemented either as native dynamic
modules (either regular dynamic modules or framework bundles) or
as Python modules.
Plug-ins must be registered with the registry. All plugins are
registered via RegisterPlugins() . Plug-in Python modules must be
directly importable (in other words they must be able to be found in
Python’s module path.) Plugins are registered by providing a path or
paths to JSON files that describe the location, structure and contents
of the plugin. The standard name for these files in plugInfo.json.
Typically, the application that hosts plug-ins will locate and
register plug-ins at startup.
The plug-in facility is lazy. It does not dynamically load code from
plug-in bundles until that code is required.
## plugInfo.json
A plugInfo.json file has the following structure:
{
# Comments are allowed and indicated by a hash at the start of a
# line or after spaces and tabs. They continue to the end of line.
# Blank lines are okay, too.
# This is optional. It may contain any number of strings.
# Paths may be absolute or relative.
# Paths ending with slash have plugInfo.json appended automatically.
# '\*' may be used anywhere to match any character except slash.
# '\*\*' may be used anywhere to match any character including slash.
"Includes": [
"/absolute/path/to/plugInfo.json",
"/absolute/path/to/custom.filename",
"/absolute/path/to/directory/with/plugInfo/",
"relative/path/to/plugInfo.json",
"relative/path/to/directory/with/plugInfo/",
"glob\*/pa\*th/\*to\*/\*/plugInfo.json",
"recursive/pa\*\*th/\*\*/"
],
# This is optional. It may contain any number of objects.
"Plugins": [
{
# Type is required and may be "module", "python" or "resource".
"Type": "module",
# Name is required. It should be the Python module name,
# the shared module name, or a unique resource name.
"Name": "myplugin",
# Root is optional. It defaults to ".".
# This gives the path to the plugin as a whole if the plugin
# has substructure. For Python it should be the directory
# with the __init__.py file. The path is usually relative.
"Root": ".",
# LibraryPath is required by Type "module" and unused
# otherwise. It gives the path to the shared module
# object, either absolute or relative to Root.
"LibraryPath": "libmyplugin.so",
# ResourcePath is option. It defaults to ".".
# This gives the path to the plugin's resources directory.
# The path is either absolute or relative to Root.
"ResourcePath": "resources",
# Info is required. It's described below.
"Info": {
# Plugin contents.
}
}
]
}
As a special case, if a plugInfo.json contains an object that doesn’t
have either the”Includes”or”Plugins”keys then it’s as if the object
was in a”Plugins”array.
## Advertising a Plug-in’s Contents
Once the plug-ins are registered, the plug-in facility must also be
able to tell what they contain. Specifically, it must be able to find
out what subclasses of what plug-in base classes each plug-in
contains. Plug-ins must advertise this information through their
plugInfo.json file in the”Info”key. In the”Info”object there should be
a key”Types”holding an object.
This”Types”object’s keys are names of subclasses and its values are
yet more objects (the subclass meta-data objects). The meta-data
objects can contain arbitrary key-value pairs. The plug-in mechanism
will look for a meta-data key called”displayName”whose value should be
the display name of the subclass. The plug-in mechanism will look for
a meta-data key called”bases”whose value should be an array of base
class type names.
For example, a bundle that contains a subclass of ImageFilter might
have a plugInfo.json that looks like the following example.
{
"Types": {
"MyCustomCoolFilter" : {
"bases": ["ImageFilter"],
"displayName": "Add Coolness to Image"
# other arbitrary metadata for MyCustomCoolFilter here
}
}
}
What this says is that the plug-in contains a type called
MyCustomCoolFilter which has a base class ImageFilter and that this
subclass should be called”Add Coolness to Image”in user-visible
contexts.
In addition to the”displayName”meta-data key which is actually known
to the plug-in facility, you may put whatever other information you
want into a class’meta-data dictionary. If your plug-in base class
wants to define custom keys that it requires all subclasses to
provide, you can do that. Or, if a plug-in writer wants to define
their own keys that their code will look for at runtime, that is OK as
well.
## Working with Subclasses of a Plug-in Base Class
Most code with uses types defined in plug-ins doesn’t deal with the
Plug API directly. Instead, the TfType interface is used to lookup
types and to manufacture instances. The TfType interface will take
care to load any required plugins.
To wrap up our example, the application that wants to actually use
ImageFilter plug-ins would probably do a couple of things. First, it
would get a list of available ImageFilters to present to the user.
This could be accomplished as shown in Python Code Example 2 (Doxygen
only).
Then, when the user picks a filter from the list, it would manufacture
and instance of the filter as shown in Python Code Example 3 (Doxygen
only).
As was mentioned earlier, this plug-in facility tries to be as lazy as
possible about loading the code associated with plug-ins. To that end,
loading of a plugin will be deferred until an instance of a type is
manufactured which requires the plugin.
## Multiple Subclasses of Multiple Plug-in Base Classes
It is possible for a bundle to implement multiple subclasses for a
plug-in base class if desired. If you want to package half a dozen
ImageFilter subclasses in one bundle, that will work fine. All must be
declared in the plugInfo.json.
It is possible for there to be multiple classes in your application or
framework that are plug-in base classes. Plug-ins that implement
subclasses of any of these base classes can all coexist. And, it is
possible to have subclasses of multiple plug-in base classes in the
same bundle.
When putting multiple subclasses (of the same or different base
classes) in a bundle, keep in mind that dynamic loading happens for
the whole bundle the first time any subclass is needed, the whole
bundle will be loaded. But this is generally not a big concern.
For example, say the example application also has a plug-in base
class”ImageCodec”that allows people to add support for reading and
writing other image formats. Imagine that you want to supply a plug-in
that has two codecs and a filter all in a single plug-in. Your
plugInfo.json”Info”object might look something like this example.
{
"Types": {
"MyTIFFCodec": {
"bases": ["ImageCodec"],
"displayName": "TIFF Image"
},
"MyJPEGCodec": {
"bases": ["ImageCodec"],
"displayName": "JPEG Image"
},
"MyCustomCoolFilter" : {
"bases": ["ImageFilter"],
"displayName": "Add Coolness to Image"
}
}
}
## Dependencies on Other Plug-ins
If you write a plug-in that has dependencies on another plug-in that
you cannot (or do not want to) link against statically, you can
declare the dependencies in your plug-in’s plugInfo.json. A plug-in
declares dependencies on other classes with a PluginDependencies key
whose value is a dictionary. The keys of the dictionary are plug-in
base class names and the values are arrays of subclass names.
The following example contains an example of a plug-in that depends on
two classes from the plug-in in the previous example.
{
"Types": {
"UltraCoolFilter": {
"bases": ["MyCustomCoolFilter"],
"displayName": "Add Unbelievable Coolness to Image"
# A subclass of MyCustomCoolFilter that also uses MyTIFFCodec
}
},
"PluginDependencies": {
"ImageFilter": ["MyCustomCoolFilter"],
"ImageCodec": ["MyTIFFCodec"]
}
}
The ImageFilter provided by the plug-in in this example depends on the
other ImageFilter MyCoolImageFilter and the ImageCodec MyTIFFCodec.
Before loading this plug-in, the plug-in facility will ensure that
those two classes are present, loading the plug-in that contains them
if needed.
Methods:
FindDerivedTypeByName
classmethod FindDerivedTypeByName(base, typeName) -> Type
FindTypeByName
classmethod FindTypeByName(typeName) -> Type
GetAllDerivedTypes
classmethod GetAllDerivedTypes(base, result) -> None
GetAllPlugins()
Returns all registered plug-ins.
GetDirectlyDerivedTypes
classmethod GetDirectlyDerivedTypes(base) -> list[Type]
GetPluginForType(t)
Returns the plug-in for the given type, or a null pointer if there is no registered plug-in.
GetPluginWithName(name)
Returns a plugin with the specified module name.
GetStringFromPluginMetaData(type, key)
Looks for a string associated with type and key and returns it, or an empty string if type or key are not found.
RegisterPlugins(pathToPlugInfo)
Registers all plug-ins discovered at pathToPlugInfo.
Attributes:
expired
True if this object has expired, False otherwise.
static FindDerivedTypeByName()
classmethod FindDerivedTypeByName(base, typeName) -> Type
Retrieve the TfType that derives from base and has the given
alias or type name typeName .
See the documentation for TfType::FindDerivedByName for more
information. Use this function if you expect that the derived type may
be provided by a plugin. Calling this function will incur plugin
discovery (but not loading) if plugin discovery has not yet occurred.
Note that additional plugins may be registered during program runtime.
Plug-In Discovery & Registration
Parameters
base (Type) –
typeName (str) –
FindDerivedTypeByName(typeName) -> Type
Retrieve the TfType that derives from Base and has the given
alias or type name typeName .
See the documentation for TfType::FindDerivedByName for more
information. Use this function if you expect that the derived type may
be provided by a plugin. Calling this function will incur plugin
discovery (but not loading) if plugin discovery has not yet occurred.
Note that additional plugins may be registered during program runtime.
Plug-In Discovery & Registration
Parameters
typeName (str) –
static FindTypeByName()
classmethod FindTypeByName(typeName) -> Type
Retrieve the TfType corresponding to the given name .
See the documentation for TfType::FindByName for more information.
Use this function if you expect that name may name a type provided
by a plugin. Calling this function will incur plugin discovery (but
not loading) if plugin discovery has not yet occurred.
Note that additional plugins may be registered during program runtime.
Plug-In Discovery & Registration
Parameters
typeName (str) –
static GetAllDerivedTypes()
classmethod GetAllDerivedTypes(base, result) -> None
Return the set of all types derived (directly or indirectly) from
base.
Use this function if you expect that plugins may provide types derived
from base. Otherwise, use TfType::GetAllDerivedTypes.
Note that additional plugins may be registered during program runtime.
Plug-In Discovery & Registration
Parameters
base (Type) –
result (set[Type]) –
GetAllDerivedTypes(result) -> None
Return the set of all types derived (directly or indirectly) from
Base.
Use this function if you expect that plugins may provide types derived
from base. Otherwise, use TfType::GetAllDerivedTypes.
Note that additional plugins may be registered during program runtime.
Plug-In Discovery & Registration
Parameters
result (set[Type]) –
GetAllPlugins() → list[PlugPluginPtr]
Returns all registered plug-ins.
Note that additional plugins may be registered during program runtime.
Plug-In Discovery & Registration
static GetDirectlyDerivedTypes()
classmethod GetDirectlyDerivedTypes(base) -> list[Type]
Return a vector of types derived directly from base.
Use this function if you expect that plugins may provide types derived
from base. Otherwise, use TfType::GetDirectlyDerivedTypes.
Parameters
base (Type) –
GetPluginForType(t) → Plugin
Returns the plug-in for the given type, or a null pointer if there is
no registered plug-in.
Parameters
t (Type) –
GetPluginWithName(name) → Plugin
Returns a plugin with the specified module name.
Note that additional plugins may be registered during program runtime.
Plug-In Discovery & Registration
Parameters
name (str) –
GetStringFromPluginMetaData(type, key) → str
Looks for a string associated with type and key and returns it, or
an empty string if type or key are not found.
Parameters
type (Type) –
key (str) –
RegisterPlugins(pathToPlugInfo) → list[PlugPluginPtr]
Registers all plug-ins discovered at pathToPlugInfo.
Sends PlugNotice::DidRegisterPlugins with any newly registered
plugins.
Parameters
pathToPlugInfo (str) –
RegisterPlugins(pathsToPlugInfo) -> list[PlugPluginPtr]
Registers all plug-ins discovered in any of pathsToPlugInfo.
Sends PlugNotice::DidRegisterPlugins with any newly registered
plugins.
Parameters
pathsToPlugInfo (list[str]) –
property expired
True if this object has expired, False otherwise.
© Copyright 2019-2023, NVIDIA.
Last updated on Nov 14, 2023. |
omni.ui.url_utils.AbstractShade.md | AbstractShade — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Submodules »
omni.ui.url_utils »
omni.ui.url_utils Classes »
AbstractShade
# AbstractShade
class omni.ui.url_utils.AbstractShade
Bases: object
The implementation of shades for custom style parameter type.
The user has to reimplement methods _store and _find to set/get the value
in the specific store.
Methods
__init__()
set_shade([name])
Set the default shade.
shade([default])
Save the given shade, pick the color and apply it to ui.ColorStore.
__init__()
set_shade(name: Optional[str] = None)
Set the default shade.
shade(default: Optional[Any] = None, **kwargs) → str
Save the given shade, pick the color and apply it to ui.ColorStore.
© Copyright 2019-2024, NVIDIA.
Last updated on Mar 25, 2024. |
index.md | pxr-usd-api: pxr USD API — pxr-usd-api 105.1 documentation
pxr-usd-api
»
pxr-usd-api: pxr USD API
# pxr-usd-api: pxr USD API
pxr-usd-api
Modules
© Copyright 2019-2023, NVIDIA.
Last updated on Nov 14, 2023. |
omni.ui.Label.md | Label — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
Label
# Label
class omni.ui.Label
Bases: Widget
The Label widget provides a text to display.
Label is used for displaying text. No additional to Widget user interaction functionality is provided.
Methods
__init__(self, arg0, **kwargs)
Create a label with the given text.
Attributes
alignment
This property holds the alignment of the label's contents.
elided_text
When the text of a big length has to be displayed in a small area, it can be useful to give the user a visual hint that not all text is visible.
elided_text_str
Customized elidedText string when elidedText is True, default is ....
exact_content_height
Return the exact height of the content of this label.
exact_content_width
Return the exact width of the content of this label.
hide_text_after_hash
Hide anything after a '##' string or not
text
This property holds the label's text.
word_wrap
This property holds the label's word-wrapping policy If this property is true then label text is wrapped where necessary at word-breaks; otherwise it is not wrapped at all.
__init__(self: omni.ui._ui.Label, arg0: str, **kwargs) → None
Create a label with the given text.
### Arguments:
`text :`The text for the label.
`kwargsdict`See below
### Keyword Arguments:
`alignment`This property holds the alignment of the label’s contents. By default, the contents of the label are left-aligned and vertically-centered.
`word_wrap`This property holds the label’s word-wrapping policy If this property is true then label text is wrapped where necessary at word-breaks; otherwise it is not wrapped at all. By default, word wrap is disabled.
`elided_text`When the text of a big length has to be displayed in a small area, it can be useful to give the user a visual hint that not all text is visible. Label can elide text that doesn’t fit in the area. When this property is true, Label elides the middle of the last visible line and replaces it with “…”.
`elided_text_str`Customized elidedText string when elidedText is True, default is ….
`hide_text_after_hash`Hide anything after a ‘##’ string or not
`widthui.Length`This property holds the width of the widget relative to its parent. Do not use this function to find the width of a screen.
`heightui.Length`This property holds the height of the widget relative to its parent. Do not use this function to find the height of a screen.
`namestr`The name of the widget that user can set.
`style_type_name_overridestr`By default, we use typeName to look up the style. But sometimes it’s necessary to use a custom name. For example, when a widget is a part of another widget. (Label is a part of Button) This property can override the name to use in style.
`identifierstr`An optional identifier of the widget we can use to refer to it in queries.
`visiblebool`This property holds whether the widget is visible.
`visibleMinfloat`If the current zoom factor and DPI is less than this value, the widget is not visible.
`visibleMaxfloat`If the current zoom factor and DPI is bigger than this value, the widget is not visible.
`tooltipstr`Set a basic tooltip for the widget, this will simply be a Label, it will follow the Tooltip style
`tooltip_fnCallable`Set dynamic tooltip that will be created dynamiclly the first time it is needed. the function is called inside a ui.Frame scope that the widget will be parented correctly.
`tooltip_offset_xfloat`Set the X tooltip offset in points. In a normal state, the tooltip position is linked to the mouse position. If the tooltip offset is non zero, the top left corner of the tooltip is linked to the top left corner of the widget, and this property defines the relative position the tooltip should be shown.
`tooltip_offset_yfloat`Set the Y tooltip offset in points. In a normal state, the tooltip position is linked to the mouse position. If the tooltip offset is non zero, the top left corner of the tooltip is linked to the top left corner of the widget, and this property defines the relative position the tooltip should be shown.
`enabledbool`This property holds whether the widget is enabled. In general an enabled widget handles keyboard and mouse events; a disabled widget does not. And widgets display themselves differently when they are disabled.
`selectedbool`This property holds a flag that specifies the widget has to use eSelected state of the style.
`checkedbool`This property holds a flag that specifies the widget has to use eChecked state of the style. It’s on the Widget level because the button can have sub-widgets that are also should be checked.
`draggingbool`This property holds if the widget is being dragged.
`opaque_for_mouse_eventsbool`If the widgets has callback functions it will by default not capture the events if it is the top most widget and setup this option to true, so they don’t get routed to the child widgets either
`skip_draw_when_clippedbool`The flag that specifies if it’s necessary to bypass the whole draw cycle if the bounding box is clipped with a scrolling frame. It’s needed to avoid the limitation of 65535 primitives in a single draw list.
`mouse_moved_fnCallable`Sets the function that will be called when the user moves the mouse inside the widget. Mouse move events only occur if a mouse button is pressed while the mouse is being moved. void onMouseMoved(float x, float y, int32_t modifier)
`mouse_pressed_fnCallable`Sets the function that will be called when the user presses the mouse button inside the widget. The function should be like this: void onMousePressed(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier) Where ‘button’ is the number of the mouse button pressed. ‘modifier’ is the flag for the keyboard modifier key.
`mouse_released_fnCallable`Sets the function that will be called when the user releases the mouse button if this button was pressed inside the widget. void onMouseReleased(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)
`mouse_double_clicked_fnCallable`Sets the function that will be called when the user presses the mouse button twice inside the widget. The function specification is the same as in setMousePressedFn. void onMouseDoubleClicked(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)
`mouse_wheel_fnCallable`Sets the function that will be called when the user uses mouse wheel on the focused window. The function specification is the same as in setMousePressedFn. void onMouseWheel(float x, float y, carb::input::KeyboardModifierFlags modifier)
`mouse_hovered_fnCallable`Sets the function that will be called when the user use mouse enter/leave on the focused window. function specification is the same as in setMouseHovedFn. void onMouseHovered(bool hovered)
`drag_fnCallable`Specify that this Widget is draggable, and set the callback that is attached to the drag operation.
`accept_drop_fnCallable`Specify that this Widget can accept specific drops and set the callback that is called to check if the drop can be accepted.
`drop_fnCallable`Specify that this Widget accepts drops and set the callback to the drop operation.
`computed_content_size_changed_fnCallable`Called when the size of the widget is changed.
property alignment
This property holds the alignment of the label’s contents. By default, the contents of the label are left-aligned and vertically-centered.
property elided_text
When the text of a big length has to be displayed in a small area, it can be useful to give the user a visual hint that not all text is visible. Label can elide text that doesn’t fit in the area. When this property is true, Label elides the middle of the last visible line and replaces it with “…”.
property elided_text_str
Customized elidedText string when elidedText is True, default is ….
property exact_content_height
Return the exact height of the content of this label. Computed content height is a size hint and may be bigger than the text in the label.
property exact_content_width
Return the exact width of the content of this label. Computed content width is a size hint and may be bigger than the text in the label.
property hide_text_after_hash
Hide anything after a ‘##’ string or not
property text
This property holds the label’s text.
property word_wrap
This property holds the label’s word-wrapping policy If this property is true then label text is wrapped where necessary at word-breaks; otherwise it is not wrapped at all. By default, word wrap is disabled.
© Copyright 2019-2024, NVIDIA.
Last updated on Mar 25, 2024. |
omni.ui.Type.md | Type — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
Type
# Type
class omni.ui.Type
Bases: pybind11_object
Members:
LINE
HISTOGRAM
LINE2D
Methods
__init__(self, value)
Attributes
HISTOGRAM
LINE
LINE2D
name
value
__init__(self: omni.ui._ui.Type, value: int) → None
property name
© Copyright 2019-2024, NVIDIA.
Last updated on Mar 25, 2024. |
core.md | Omni Asset Validator (Core) — asset-validator 0.6.2 documentation
asset-validator
»
Omni Asset Validator (Core)
# Omni Asset Validator (Core)
Validates assets against Omniverse specific rules to ensure they run smoothly across all Omniverse products.
It includes the following components:
A rule interface and registration mechanism that can be called from external python modules.
An engine that runs the rules on a given Usd.Stage, layer file, or recursively searches an OV folder for layer files.
An issue fixing interface for applying automated fixes if/when individual rules provide suggestions.
Note
The IssueFixer API is still a work in-progress. Currently no rules provide the necessary suggestions to fix issues.
## Validation Rules by Category
Several categories of validation rules are defined in this core module. These include:
The Basic rules from Pixar (e.g. the default usdchecker rules).
The ARKit rules from Apple (also available via usdchecker).
These rules are disabled by default in this system, as they are in usdchecker. Use Carbonite Settings or the ValidationEngine API to re-enable them.
A few NVIDIA developed rules that we plan to contribute back to the Basic set.
Some Omniverse specific rules that apply to all Omniverse apps. These will be available under several Omni: prefixed categories.
## Writing your own Rules
Any external client code can define new rules and register them with the system. Simply add omni.asset_validator.core as a dependency of your tool (e.g. your Kit extension or other python module), derive a new class from BaseRuleChecker, and use the ValidationRulesRegistry to categorize your rule with the system. See the Core Python API for thorough details and example code. We even provide a small Testing API to ease unittesting your new rules against known USD layer files.
Important
Put extra thought into your category name, your class name, your GetDescription() implementation, and the messages in any errors, warnings, or failures that your rule generates at runtime. These are the user-facing portions of your rule, and many users will appreciate natural language over engineering semantics.
## Running the Validation Engine
Validation can be run synchronously (blocking) via ValidationEngine.validate(), or asynchronously via either ValidationEngine.validate_async() or ValidationEngine.validate_with_callbacks(). Currently validation within an individual layer file or Usd.Stage is synchronous. This may become asynchronous in the future if it is merited.
Validation Issues are captured in a Results container. Issues vary in severity (Error, Failure, Warning) and will provide detailed messages explaining the problem. Optionally, they may also provide detail on where the issue occured in the Usd.Stage and a suggestion (callable python code) for how it can be fixed automatically.
## Fixing Issues automatically
Once validation Results have been obtained, they can be displayed for a user as plain text, but we also provide an automatic IssueFixer for some Issues. It is up to each individual rule to define the suggested fix via a python callable. See the Core Python API for more details.
## Configuring Rules with Carbonite Settings
As with many Omniverse tools, omni.asset_validator.core is configurable at runtime using Carbonite settings. The following settings can be used to customize which rules are enabled/disabled for a particular app, company, or team.
### Settings
enabledCategories/disabledCategories are lists of of glob style patterns matched against registered categories. Categories can be force-enabled using an exact match (no wildcards) in enabledCategories.
enabledRules/disabledRules are lists of of glob style patterns matched against class names of registered rules. Rules can be force-enabled using an exact match (no wildcards) in enabledRules.
Tip
These settings only affect a default-constructed ValidationEngine. Using the Python API, client code may further configure a ValidationEngine using enableRule(). In such cases, the rules may not even be registered with the ValidationRulesRegistry.
## API and Changelog
We provide a thorough public API for the core validation framework and a minimal public testing API to assist clients in authoring new rules.
Core Python API
Testing API
Rules
Changelog
© Copyright 2021-2023, NVIDIA.
Last updated on Jun 20, 2023. |
omni.ui.DockPolicy.md | DockPolicy — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
DockPolicy
# DockPolicy
class omni.ui.DockPolicy
Bases: pybind11_object
Members:
DO_NOTHING
CURRENT_WINDOW_IS_ACTIVE
TARGET_WINDOW_IS_ACTIVE
Methods
__init__(self, value)
Attributes
CURRENT_WINDOW_IS_ACTIVE
DO_NOTHING
TARGET_WINDOW_IS_ACTIVE
name
value
__init__(self: omni.ui._ui.DockPolicy, value: int) → None
property name
© Copyright 2019-2024, NVIDIA.
Last updated on Mar 25, 2024. |
omni.ui.UnitType.md | UnitType — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
UnitType
# UnitType
class omni.ui.UnitType
Bases: pybind11_object
Unit types.
Widths, heights or other UI length can be specified in pixels or relative to window (or child window) size.
Members:
PIXEL
PERCENT
FRACTION
Methods
__init__(self, value)
Attributes
FRACTION
PERCENT
PIXEL
name
value
__init__(self: omni.ui._ui.UnitType, value: int) → None
property name
© Copyright 2019-2024, NVIDIA.
Last updated on Mar 25, 2024. |
1_8_11.md | 1.8.11 — Omniverse Launcher latest documentation
Omniverse Launcher
»
Omniverse Launcher »
Release Notes »
1.8.11
# 1.8.11
Release Date: July 2023
## Changed
Updated Nucleus tab with Navigator 3.3.2.
Display “Install” button for new versions in the setting menu on the Library tab.
Extend omniverse-launcher://launch command to support custom launch scripts.
## Fixed
Fixed an issue where users were unable to exit from Launcher via UI when not authenticated.
Fixed incorrect links displayed in GDPR/EULA error.
Add retries for pulling component versions during installations.
Fixed an issue where Launcher raised an error during installation if installed package printed too many messages.
Amend Italian and Korean translation strings.
Fixed the beta banner displayed with the carousel.
Fixed an issue where Launcher didn’t remember command line arguments specified for AppImage.
© Copyright 2023-2024, NVIDIA.
Last updated on Apr 15, 2024. |
omni.ui.Button.md | Button — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
Button
# Button
class omni.ui.Button
Bases: InvisibleButton
The Button widget provides a command button.
The command button, is perhaps the most commonly used widget in any graphical user interface. Click a button to execute a command. It is rectangular and typically displays a text label describing its action.
Methods
__init__(self[, text])
Construct a button with a text on it.
Attributes
image_height
This property holds the height of the image widget.
image_url
This property holds the button's optional image URL.
image_width
This property holds the width of the image widget.
spacing
Sets a non-stretchable space in points between image and text.
text
This property holds the button's text.
__init__(self: omni.ui._ui.Button, text: str = '', **kwargs) → None
Construct a button with a text on it.
### Arguments:
`text :`The text for the button to use.
`kwargsdict`See below
### Keyword Arguments:
`textstr`This property holds the button’s text.
`image_urlstr`This property holds the button’s optional image URL.
`image_widthfloat`This property holds the width of the image widget. Do not use this function to find the width of the image.
`image_heightfloat`This property holds the height of the image widget. Do not use this function to find the height of the image.
`spacingfloat`Sets a non-stretchable space in points between image and text.
`clicked_fnCallable[[], None]`Sets the function that will be called when when the button is activated (i.e., pressed down then released while the mouse cursor is inside the button).
`widthui.Length`This property holds the width of the widget relative to its parent. Do not use this function to find the width of a screen.
`heightui.Length`This property holds the height of the widget relative to its parent. Do not use this function to find the height of a screen.
`namestr`The name of the widget that user can set.
`style_type_name_overridestr`By default, we use typeName to look up the style. But sometimes it’s necessary to use a custom name. For example, when a widget is a part of another widget. (Label is a part of Button) This property can override the name to use in style.
`identifierstr`An optional identifier of the widget we can use to refer to it in queries.
`visiblebool`This property holds whether the widget is visible.
`visibleMinfloat`If the current zoom factor and DPI is less than this value, the widget is not visible.
`visibleMaxfloat`If the current zoom factor and DPI is bigger than this value, the widget is not visible.
`tooltipstr`Set a basic tooltip for the widget, this will simply be a Label, it will follow the Tooltip style
`tooltip_fnCallable`Set dynamic tooltip that will be created dynamiclly the first time it is needed. the function is called inside a ui.Frame scope that the widget will be parented correctly.
`tooltip_offset_xfloat`Set the X tooltip offset in points. In a normal state, the tooltip position is linked to the mouse position. If the tooltip offset is non zero, the top left corner of the tooltip is linked to the top left corner of the widget, and this property defines the relative position the tooltip should be shown.
`tooltip_offset_yfloat`Set the Y tooltip offset in points. In a normal state, the tooltip position is linked to the mouse position. If the tooltip offset is non zero, the top left corner of the tooltip is linked to the top left corner of the widget, and this property defines the relative position the tooltip should be shown.
`enabledbool`This property holds whether the widget is enabled. In general an enabled widget handles keyboard and mouse events; a disabled widget does not. And widgets display themselves differently when they are disabled.
`selectedbool`This property holds a flag that specifies the widget has to use eSelected state of the style.
`checkedbool`This property holds a flag that specifies the widget has to use eChecked state of the style. It’s on the Widget level because the button can have sub-widgets that are also should be checked.
`draggingbool`This property holds if the widget is being dragged.
`opaque_for_mouse_eventsbool`If the widgets has callback functions it will by default not capture the events if it is the top most widget and setup this option to true, so they don’t get routed to the child widgets either
`skip_draw_when_clippedbool`The flag that specifies if it’s necessary to bypass the whole draw cycle if the bounding box is clipped with a scrolling frame. It’s needed to avoid the limitation of 65535 primitives in a single draw list.
`mouse_moved_fnCallable`Sets the function that will be called when the user moves the mouse inside the widget. Mouse move events only occur if a mouse button is pressed while the mouse is being moved. void onMouseMoved(float x, float y, int32_t modifier)
`mouse_pressed_fnCallable`Sets the function that will be called when the user presses the mouse button inside the widget. The function should be like this: void onMousePressed(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier) Where ‘button’ is the number of the mouse button pressed. ‘modifier’ is the flag for the keyboard modifier key.
`mouse_released_fnCallable`Sets the function that will be called when the user releases the mouse button if this button was pressed inside the widget. void onMouseReleased(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)
`mouse_double_clicked_fnCallable`Sets the function that will be called when the user presses the mouse button twice inside the widget. The function specification is the same as in setMousePressedFn. void onMouseDoubleClicked(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)
`mouse_wheel_fnCallable`Sets the function that will be called when the user uses mouse wheel on the focused window. The function specification is the same as in setMousePressedFn. void onMouseWheel(float x, float y, carb::input::KeyboardModifierFlags modifier)
`mouse_hovered_fnCallable`Sets the function that will be called when the user use mouse enter/leave on the focused window. function specification is the same as in setMouseHovedFn. void onMouseHovered(bool hovered)
`drag_fnCallable`Specify that this Widget is draggable, and set the callback that is attached to the drag operation.
`accept_drop_fnCallable`Specify that this Widget can accept specific drops and set the callback that is called to check if the drop can be accepted.
`drop_fnCallable`Specify that this Widget accepts drops and set the callback to the drop operation.
`computed_content_size_changed_fnCallable`Called when the size of the widget is changed.
property image_height
This property holds the height of the image widget. Do not use this function to find the height of the image.
property image_url
This property holds the button’s optional image URL.
property image_width
This property holds the width of the image widget. Do not use this function to find the width of the image.
property spacing
Sets a non-stretchable space in points between image and text.
property text
This property holds the button’s text.
© Copyright 2019-2024, NVIDIA.
Last updated on Mar 25, 2024. |
Sdr.md | Sdr module — pxr-usd-api 105.1 documentation
pxr-usd-api
»
Modules »
Sdr module
# Sdr module
Summary: The Sdr (Shader Definition Registry) is a specialized version of Ndr for Shaders.
Python bindings for libSdr
Classes:
NodeContext
NodeMetadata
NodeRole
PropertyMetadata
PropertyRole
PropertyTypes
Registry
The shading-specialized version of NdrRegistry .
ShaderNode
A specialized version of NdrNode which holds shading information.
ShaderNodeList
ShaderProperty
A specialized version of NdrProperty which holds shading information.
class pxr.Sdr.NodeContext
Attributes:
Displacement
Light
LightFilter
Pattern
PixelFilter
SampleFilter
Surface
Volume
Displacement = 'displacement'
Light = 'light'
LightFilter = 'lightFilter'
Pattern = 'pattern'
PixelFilter = 'pixelFilter'
SampleFilter = 'sampleFilter'
Surface = 'surface'
Volume = 'volume'
class pxr.Sdr.NodeMetadata
Attributes:
Category
Departments
Help
ImplementationName
Label
Pages
Primvars
Role
SdrDefinitionNameFallbackPrefix
SdrUsdEncodingVersion
Target
Category = 'category'
Departments = 'departments'
Help = 'help'
ImplementationName = '__SDR__implementationName'
Label = 'label'
Pages = 'pages'
Primvars = 'primvars'
Role = 'role'
SdrDefinitionNameFallbackPrefix = 'sdrDefinitionNameFallbackPrefix'
SdrUsdEncodingVersion = 'sdrUsdEncodingVersion'
Target = '__SDR__target'
class pxr.Sdr.NodeRole
Attributes:
Field
Math
Primvar
Texture
Field = 'field'
Math = 'math'
Primvar = 'primvar'
Texture = 'texture'
class pxr.Sdr.PropertyMetadata
Attributes:
Colorspace
Connectable
DefaultInput
Help
Hints
ImplementationName
IsAssetIdentifier
IsDynamicArray
Label
Options
Page
RenderType
Role
SdrUsdDefinitionType
Target
ValidConnectionTypes
VstructConditionalExpr
VstructMemberName
VstructMemberOf
Widget
Colorspace = '__SDR__colorspace'
Connectable = 'connectable'
DefaultInput = '__SDR__defaultinput'
Help = 'help'
Hints = 'hints'
ImplementationName = '__SDR__implementationName'
IsAssetIdentifier = '__SDR__isAssetIdentifier'
IsDynamicArray = 'isDynamicArray'
Label = 'label'
Options = 'options'
Page = 'page'
RenderType = 'renderType'
Role = 'role'
SdrUsdDefinitionType = 'sdrUsdDefinitionType'
Target = '__SDR__target'
ValidConnectionTypes = 'validConnectionTypes'
VstructConditionalExpr = 'vstructConditionalExpr'
VstructMemberName = 'vstructMemberName'
VstructMemberOf = 'vstructMemberOf'
Widget = 'widget'
class pxr.Sdr.PropertyRole
Attributes:
None
None = 'none'
class pxr.Sdr.PropertyTypes
Attributes:
Color
Color4
Float
Int
Matrix
Normal
Point
String
Struct
Terminal
Unknown
Vector
Vstruct
Color = 'color'
Color4 = 'color4'
Float = 'float'
Int = 'int'
Matrix = 'matrix'
Normal = 'normal'
Point = 'point'
String = 'string'
Struct = 'struct'
Terminal = 'terminal'
Unknown = 'unknown'
Vector = 'vector'
Vstruct = 'vstruct'
class pxr.Sdr.Registry
The shading-specialized version of NdrRegistry .
Methods:
GetShaderNodeByIdentifier(identifier, ...)
Exactly like NdrRegistry::GetNodeByIdentifier() , but returns a SdrShaderNode pointer instead of a NdrNode pointer.
GetShaderNodeByIdentifierAndType(identifier, ...)
Exactly like NdrRegistry::GetNodeByIdentifierAndType() , but returns a SdrShaderNode pointer instead of a NdrNode pointer.
GetShaderNodeByName(name, typePriority, filter)
Exactly like NdrRegistry::GetNodeByName() , but returns a SdrShaderNode pointer instead of a NdrNode pointer.
GetShaderNodeByNameAndType(name, nodeType, ...)
Exactly like NdrRegistry::GetNodeByNameAndType() , but returns a SdrShaderNode pointer instead of a NdrNode pointer.
GetShaderNodeFromAsset(shaderAsset, ...)
Wrapper method for NdrRegistry::GetNodeFromAsset() .
GetShaderNodeFromSourceCode(sourceCode, ...)
Wrapper method for NdrRegistry::GetNodeFromSourceCode() .
GetShaderNodesByFamily(family, filter)
Exactly like NdrRegistry::GetNodesByFamily() , but returns a vector of SdrShaderNode pointers instead of a vector of NdrNode pointers.
GetShaderNodesByIdentifier(identifier)
Exactly like NdrRegistry::GetNodesByIdentifier() , but returns a vector of SdrShaderNode pointers instead of a vector of NdrNode pointers.
GetShaderNodesByName(name, filter)
Exactly like NdrRegistry::GetNodesByName() , but returns a vector of SdrShaderNode pointers instead of a vector of NdrNode pointers.
Attributes:
expired
True if this object has expired, False otherwise.
GetShaderNodeByIdentifier(identifier, typePriority) → ShaderNode
Exactly like NdrRegistry::GetNodeByIdentifier() , but returns a
SdrShaderNode pointer instead of a NdrNode pointer.
Parameters
identifier (NdrIdentifier) –
typePriority (NdrTokenVec) –
GetShaderNodeByIdentifierAndType(identifier, nodeType) → ShaderNode
Exactly like NdrRegistry::GetNodeByIdentifierAndType() , but
returns a SdrShaderNode pointer instead of a NdrNode pointer.
Parameters
identifier (NdrIdentifier) –
nodeType (str) –
GetShaderNodeByName(name, typePriority, filter) → ShaderNode
Exactly like NdrRegistry::GetNodeByName() , but returns a
SdrShaderNode pointer instead of a NdrNode pointer.
Parameters
name (str) –
typePriority (NdrTokenVec) –
filter (VersionFilter) –
GetShaderNodeByNameAndType(name, nodeType, filter) → ShaderNode
Exactly like NdrRegistry::GetNodeByNameAndType() , but returns a
SdrShaderNode pointer instead of a NdrNode pointer.
Parameters
name (str) –
nodeType (str) –
filter (VersionFilter) –
GetShaderNodeFromAsset(shaderAsset, metadata, subIdentifier, sourceType) → ShaderNode
Wrapper method for NdrRegistry::GetNodeFromAsset() .
Returns a valid SdrShaderNode pointer upon success.
Parameters
shaderAsset (AssetPath) –
metadata (NdrTokenMap) –
subIdentifier (str) –
sourceType (str) –
GetShaderNodeFromSourceCode(sourceCode, sourceType, metadata) → ShaderNode
Wrapper method for NdrRegistry::GetNodeFromSourceCode() .
Returns a valid SdrShaderNode pointer upon success.
Parameters
sourceCode (str) –
sourceType (str) –
metadata (NdrTokenMap) –
GetShaderNodesByFamily(family, filter) → SdrShaderNodePtrVec
Exactly like NdrRegistry::GetNodesByFamily() , but returns a
vector of SdrShaderNode pointers instead of a vector of
NdrNode pointers.
Parameters
family (str) –
filter (VersionFilter) –
GetShaderNodesByIdentifier(identifier) → SdrShaderNodePtrVec
Exactly like NdrRegistry::GetNodesByIdentifier() , but returns a
vector of SdrShaderNode pointers instead of a vector of
NdrNode pointers.
Parameters
identifier (NdrIdentifier) –
GetShaderNodesByName(name, filter) → SdrShaderNodePtrVec
Exactly like NdrRegistry::GetNodesByName() , but returns a vector
of SdrShaderNode pointers instead of a vector of NdrNode
pointers.
Parameters
name (str) –
filter (VersionFilter) –
property expired
True if this object has expired, False otherwise.
class pxr.Sdr.ShaderNode
A specialized version of NdrNode which holds shading information.
Methods:
GetAdditionalPrimvarProperties()
The list of string input properties whose values provide the names of additional primvars consumed by this node.
GetAllVstructNames()
Gets all vstructs that are present in the shader.
GetAssetIdentifierInputNames()
Returns the list of all inputs that are tagged as asset identifier inputs.
GetCategory()
The category assigned to this node, if any.
GetDefaultInput()
Returns the first shader input that is tagged as the default input.
GetDepartments()
The departments this node is associated with, if any.
GetHelp()
The help message assigned to this node, if any.
GetImplementationName()
Returns the implementation name of this node.
GetLabel()
The label assigned to this node, if any.
GetPages()
Gets the pages on which the node's properties reside (an aggregate of the unique SdrShaderProperty::GetPage() values for all of the node's properties).
GetPrimvars()
The list of primvars this node knows it requires / uses.
GetPropertyNamesForPage(pageName)
Gets the names of the properties on a certain page (one that was returned by GetPages() ).
GetRole()
Returns the role of this node.
GetShaderInput(inputName)
Get a shader input property by name.
GetShaderOutput(outputName)
Get a shader output property by name.
GetAdditionalPrimvarProperties() → NdrTokenVec
The list of string input properties whose values provide the names of
additional primvars consumed by this node.
For example, this may return a token named varname . This
indicates that the client should query the value of a (presumed to be
string-valued) input attribute named varname from its scene
description to determine the name of a primvar the node will consume.
See GetPrimvars() for additional information.
GetAllVstructNames() → NdrTokenVec
Gets all vstructs that are present in the shader.
GetAssetIdentifierInputNames() → NdrTokenVec
Returns the list of all inputs that are tagged as asset identifier
inputs.
GetCategory() → str
The category assigned to this node, if any.
Distinct from the family returned from GetFamily() .
GetDefaultInput() → ShaderProperty
Returns the first shader input that is tagged as the default input.
A default input and its value can be used to acquire a fallback value
for a node when the node is considered’disabled’or otherwise incapable
of producing an output value.
GetDepartments() → NdrTokenVec
The departments this node is associated with, if any.
GetHelp() → str
The help message assigned to this node, if any.
GetImplementationName() → str
Returns the implementation name of this node.
The name of the node is how to refer to the node in shader networks.
The label is how to present this node to users. The implementation
name is the name of the function (or something) this node represents
in the implementation. Any client using the implementation must
call this method to get the correct name; using getName() is not
correct.
GetLabel() → str
The label assigned to this node, if any.
Distinct from the name returned from GetName() . In the context of
a UI, the label value might be used as the display name for the node
instead of the name.
GetPages() → NdrTokenVec
Gets the pages on which the node’s properties reside (an aggregate of
the unique SdrShaderProperty::GetPage() values for all of the
node’s properties).
Nodes themselves do not reside on pages. In an example scenario,
properties might be divided into two pages,’Simple’and’Advanced’.
GetPrimvars() → NdrTokenVec
The list of primvars this node knows it requires / uses.
For example, a shader node may require the’normals’primvar to function
correctly. Additional, user specified primvars may have been authored
on the node. These can be queried via
GetAdditionalPrimvarProperties() . Together, GetPrimvars() and
GetAdditionalPrimvarProperties() , provide the complete list of
primvar requirements for the node.
GetPropertyNamesForPage(pageName) → NdrTokenVec
Gets the names of the properties on a certain page (one that was
returned by GetPages() ).
To get properties that are not assigned to a page, an empty string can
be used for pageName .
Parameters
pageName (str) –
GetRole() → str
Returns the role of this node.
This is used to annotate the role that the shader node plays inside a
shader network. We can tag certain shaders to indicate their role
within a shading network. We currently tag primvar reading nodes,
texture reading nodes and nodes that access volume fields (like
extinction or scattering). This is done to identify resources used by
a shading network.
GetShaderInput(inputName) → ShaderProperty
Get a shader input property by name.
nullptr is returned if an input with the given name does not
exist.
Parameters
inputName (str) –
GetShaderOutput(outputName) → ShaderProperty
Get a shader output property by name.
nullptr is returned if an output with the given name does not
exist.
Parameters
outputName (str) –
class pxr.Sdr.ShaderNodeList
Methods:
append
extend
append()
extend()
class pxr.Sdr.ShaderProperty
A specialized version of NdrProperty which holds shading
information.
Methods:
GetDefaultValueAsSdfType()
Accessor for default value corresponding to the SdfValueTypeName returned by GetTypeAsSdfType.
GetHelp()
The help message assigned to this property, if any.
GetHints()
Any UI"hints"that are associated with this property.
GetImplementationName()
Returns the implementation name of this property.
GetLabel()
The label assigned to this property, if any.
GetOptions()
If the property has a set of valid values that are pre-determined, this will return the valid option names and corresponding string values (if the option was specified with a value).
GetPage()
The page (group), eg"Advanced", this property appears on, if any.
GetVStructConditionalExpr()
If this field is part of a vstruct, this is the conditional expression.
GetVStructMemberName()
If this field is part of a vstruct, this is its name in the struct.
GetVStructMemberOf()
If this field is part of a vstruct, this is the name of the struct.
GetValidConnectionTypes()
Gets the list of valid connection types for this property.
GetWidget()
The widget"hint"that indicates the widget that can best display the type of data contained in this property, if any.
IsAssetIdentifier()
Determines if the value held by this property is an asset identifier (eg, a file path); the logic for this is left up to the parser.
IsDefaultInput()
Determines if the value held by this property is the default input for this node.
IsVStruct()
Returns true if the field is the head of a vstruct.
IsVStructMember()
Returns true if this field is part of a vstruct.
GetDefaultValueAsSdfType() → VtValue
Accessor for default value corresponding to the SdfValueTypeName
returned by GetTypeAsSdfType.
Note that this is different than GetDefaultValue which returns the
default value associated with the SdrPropertyType and may differ from
the SdfValueTypeName, example when sdrUsdDefinitionType metadata is
specified for a sdr property.
GetTypeAsSdfType
GetHelp() → str
The help message assigned to this property, if any.
GetHints() → NdrTokenMap
Any UI”hints”that are associated with this property.
“Hints”are simple key/value pairs.
GetImplementationName() → str
Returns the implementation name of this property.
The name of the property is how to refer to the property in shader
networks. The label is how to present this property to users. The
implementation name is the name of the parameter this property
represents in the implementation. Any client using the implementation
must call this method to get the correct name; using getName()
is not correct.
GetLabel() → str
The label assigned to this property, if any.
Distinct from the name returned from GetName() . In the context of
a UI, the label value might be used as the display name for the
property instead of the name.
GetOptions() → NdrOptionVec
If the property has a set of valid values that are pre-determined,
this will return the valid option names and corresponding string
values (if the option was specified with a value).
GetPage() → str
The page (group), eg”Advanced”, this property appears on, if any.
Note that the page for a shader property can be nested, delimited
by”:”, representing the hierarchy of sub-pages a property is defined
in.
GetVStructConditionalExpr() → str
If this field is part of a vstruct, this is the conditional
expression.
GetVStructMemberName() → str
If this field is part of a vstruct, this is its name in the struct.
GetVStructMemberOf() → str
If this field is part of a vstruct, this is the name of the struct.
GetValidConnectionTypes() → NdrTokenVec
Gets the list of valid connection types for this property.
This value comes from shader metadata, and may not be specified. The
value from NdrProperty::GetType() can be used as a fallback, or
you can use the connectability test in CanConnectTo() .
GetWidget() → str
The widget”hint”that indicates the widget that can best display the
type of data contained in this property, if any.
Examples of this value could include”number”,”slider”, etc.
IsAssetIdentifier() → bool
Determines if the value held by this property is an asset identifier
(eg, a file path); the logic for this is left up to the parser.
Note: The type returned from GetTypeAsSdfType() will be Asset
if this method returns true (even though its true underlying data
type is string).
IsDefaultInput() → bool
Determines if the value held by this property is the default input for
this node.
IsVStruct() → bool
Returns true if the field is the head of a vstruct.
IsVStructMember() → bool
Returns true if this field is part of a vstruct.
© Copyright 2019-2023, NVIDIA.
Last updated on Nov 14, 2023. |
linux_troubleshooting.md | Linux Troubleshooting — kit-manual 105.1 documentation
kit-manual
»
Linux Troubleshooting
# Linux Troubleshooting
Instructions for resolving issues when running Omniverse-kit or
Omniverse-Create on Linux.
## Q1) How to install a driver.
Always install .run executable driver files. e.g. downloaded
from: https://www.nvidia.com/Download/Find.aspx
Do NOT install PPA drivers. PPA drivers are packaged with
Linux distribution, and installed with add-apt or
Software & Updates. These drivers are not easy to uninstall or
clean up. It requires purging them and cleaning up Vulkan ICD files
manually.
Driver installation steps:
Go to TTYs mode (CRL + ALT + F3), or use systemctl
approach.
Uninstall all previous drivers:
sudo nvidia-uninstall
The following clean-up steps are only required if you have leftovers from PPA drivers:
sudo apt-get remove --purge nvidia-*
sudo apt autoremove
sudo apt autoclean
Reboot your machine and then go to TTYs mode from the login
screen:
sudo chmod +x NVIDIA-Linux-x86_64-460.67.run
sudo ./NVIDIA-Linux-x86_64-460.67.run
If the kernel could not be compiled, make sure to download headers
and image files related to your Linux kernel before the driver
installation.
Ignore errors related to missing 32-bit libraries, and build any
missing library if it required a confirmation.
Driver installation over SSH on remote machines:
Stop X, install the driver with NVIDIA driver installer, and
restart X.
On Ubuntu 18.04 to stop X, run the following command, then wait a
bit, and ensure X is not running. e.g.: run ps auxfw and
verify no X or Window manager process is running.
sudo systemctl isolate multi-user.target
To restart X, run:
sudo systemctl isolate graphical.target
Installing a driver on a system with Teradici already configured
should work just the same. Installing Teradici however requires
following their instructions the first time around, before installing
the NVIDIA driver.
## Q2) Omniverse kit logs only listed one of my GPUs, but nvidia-smi shows multiple GPUs.
How to support enumeration of multiple GPUs in Vulkan
xserver-xorg-core 1.20.7 or newer is required for multi-GPU
systems. Otherwise, Vulkan applications cannot see multiple GPUs.
Ubuntu 20.04 ships with Xorg 1.20.8 by default. Ubuntu 20 is known to work, but not exhaustively tested by Omniverse QA
Ubuntu 16 is not supported.
How to update xorg:
Update Ubuntu 18.04.x LTS through software update to the
latest Ubuntu 18.04.5 LTS.
Install LTS Enablement Stacks to upgrade xorg:
https://wiki.ubuntu.com/Kernel/LTSEnablementStack
## Q3) How to verify a correct Vulkan setup with vulkaninfo or vulkaninfoSDK utility
Download the latest Vulkan SDK tar.gz from
https://vulkan.lunarg.com/sdk/home and unzip it.
Do NOT install Vulkan SDK through apt-install, unless you
know what exact version Omniverse supports and you need validation
layers for debugging (refer to readme.md). Just simply download
the zip file.
Execute the following utility from the unzipped pack.
bin/vulkaninfo
It should enumerate all the GPUs. If it failed, your driver or the
required xorg is not installed properly. Do NOT install
vulkan-utils or other MESA tools to fix your driver, as they
might install old incompatible validation layers.
nvidia-smi GPU table is unrelated to the list of GPUs that Vulkan
driver reports.
## Q4) I have a single GPU, but I see multiple GPUs of the same type reported in Omniverse kit logs.
You likely have leftover components from other PPA drivers in
addition to the one you installed from the .run driver packages.
You can confirm this by checking that vulkaninfo only shows a
single GPU. These extra ICD files should be cleaned up.
These extra files will not affect the output of nvidia-smi, as it
is a Vulkan driver issue.
Steps to clean up duplicate ICD files:
If you see both of the following folders have some json files,
such as nvidia_icd.json, then delete the duplicate icd.d
folder from /usr/share/vulkan/ path.
"/etc/vulkan/icd.d": Location of ICDs installed from non-Linux-distribution-provided packages
"/usr/share/vulkan/icd.d": Location of ICDs installed from Linux-distribution-provided packages
Run vulkaninfo to verify the fix, instead of nvidia-smi.
## Q5) Startup failure with: VkResult: ERROR_DEVICE_LOST
A startup device lost is typically a system setup bug. Potential bugs:
A bad driver installation.
Uninstall and re-install it.
Driver bugs prior to the 460.67 driver when you have different GPU models. e.g. Turing + Ampere GPUs.
Solution: Install driver 460.67 or higher, which has the bug fix.
Workaround on older drivers: Remove Non-rtx cards, and re-install the driver after removing any GPU.
This issue has been known to crash other raytracing applications. However, regular raster vulkan applications won’t be affected.
If you have multiple GPUs, --/renderer/activeGpu=1 setting cannot change this behavior.
Old Shader caches are left in the folder
Delete the contents of folder /home/USERNAME/.cache/ov/Kit/101.0/rendering
It is known with omniverse-kit SDK packages that are not built
from the source, or not using the omniverse installer to remove
the caches.
## Q6) Startup failure with: GLFW initialization failed
This is a driver or display issue:
A physical display must be connected to your GPU, unless you are running kit/Create headless with --no-window for streaming. No visual rendering can happen on the X11 window without a display and presentable swapchain.
Test the display setup with the following command.
echo $DISPLAY
If nothing is returned, set the environment.
Set the display environment as following persistently
export DISPLAY=:0.0
Reboot upon completion.
echo $DISPLAY to verify again after the reboot.
Re-install the driver if above steps did not help.
## Q7) Startup failure with: Failed to find a graphics and/or presenting queue.
Your GPU is not connected to a physical display. Required, except
when running Kit/Create headless in --no-windows mode
Your GPU is connected to a physical display, however, it is not set
as the default GPU in xorg for Ubuntu’s GUI rendering:
Choose what GPU to use for both Ubuntu UI and Omniverse rendering to present the output to the screen.
Set its busid as follows and reboot: sudo nvidia-xconfig --busid PCI:103:0:0
busid is in decimal format, taken from NVIDIA X Server Settings
Connect the physical display to that GPU and boot up.
If you have multiple GPUs, --/renderer/activeGpu=1 setting cannot change what GPU to run on. busid must be set in the xorg config, and then activeGpu should be set to the same device if it is not zero.
NVIDIA Colossus involves a lot more work. Refer to Issac setup.
## Q8) Startup failure for carb::glinterop with X Error of failed request: GLXBadFBConfig
OpenGL Interop support is optional for RTX renderer in the latest build,
and is only needed for Storm renderer. However, such failures typically
reveals other system setup issues that might also affect Vulkan
applications.
A few potential issues:
Unsupported driver or hardware. Currently, OpenGL 4.6 is the minimum required.
Uninstall OpenGL utilities such as Mesa-utils and re-install your NVIDIA driver.
## Q9) How to specify what GPUs to run Omniverse apps on
Single-GPU mode: Follow Q8 instructions to set the desired main GPU for presentation, and then set index of that GPU with the following option during launch if it is not zero.
--/renderer/activeGpu=1
Multi-GPU mode: Follow Q8 instructions and then set indices of the desired GPUs with the following option during launch. The first device in the list performs the presentation and should be set in Xorg config.
--/renderer/multiGpu/activeGpus='1,2'
Note
Always verify that your desired GPUs are set as Active with a
“Yes” in the GPU table of omniverse .log file under
[gpu.foundation]. GPU index in above options are from this table
and not from nvidia-smi.
CUDA_VISIBLE_DEVICES and other CUDA commands cannot change
what GPUs to run on for Vulkan applications.
## Q10) Viewport is gray and nothing is rendered.
This means that RTX renderer has failed and the reason of the failure will be printed in the full .log file as errors, such as an unsupported driver, hardware or etc. The log file is typically located at /home/USERNAME/**/logs/**/*.log
## Q11) Getting spam of failures: Failed to create change watch for xxx: errno=28, No space left on device
This is a file change watcher limitation on Linux which is usually set to 8k. Either close other applications that use watchers, or increase max_user_watches to 512k. Note that this will increase your system RAM usage.
### To view the current watcher limit:
cat/proc/sys/fs/inotify/max_user_watches
### To update the watcher limit:
Edit /etc/sysctl.conf and add
fs.inotify.max_user_watches=524288 line.
Load the new value: sudo sysctl -p
You may follow the full instructions listed for Visual Studio Code Watcher limit
## Q12) How to increase the file descriptor limit on Linux to render on more than 2 GPUs
If you are rendering with multiple GPUs, file descriptor limit is
required to be increased. The default limit is 1024, but we
recommend a higher value, like 65535, for systems with more than 2
GPUs. Without that, Omniverse applications will fail during the creation
of shared resources, such as Vulkan fences, and will lead to crash at
startup.
### To increase the file descriptor limit
Modify /etc/systemd/user.conf and /etc/systemd/system.conf with the following line. This takes care of graphical login:
DefaultLimitNOFILE=65535
Modify /etc/security/limits.conf with the following lines. This takes care of non-GUI console login:
hard nofile 65535
soft nofile 65535
Reboot your computer for changes to take effect.
© Copyright 2019-2023, NVIDIA.
Last updated on Nov 14, 2023. |
omni.ui.ShapeAnchorHelper.md | ShapeAnchorHelper — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
ShapeAnchorHelper
# ShapeAnchorHelper
class omni.ui.ShapeAnchorHelper
Bases: pybind11_object
The ShapeAnchorHelper provides common functionality for Shape Anchors.
Methods
__init__(*args, **kwargs)
call_anchor_fn(self)
Sets the function that will be called for the curve anchor.
get_closest_parametric_position(self, ...)
Function that returns the closest parametric T value to a given x,y position.
has_anchor_fn(self)
Sets the function that will be called for the curve anchor.
invalidate_anchor(self)
Function that causes the anchor frame to be redrawn.
set_anchor_fn(self, fn)
Sets the function that will be called for the curve anchor.
Attributes
anchor_alignment
This property holds the Alignment of the curve anchor.
anchor_position
This property holds the parametric value of the curve anchor.
__init__(*args, **kwargs)
call_anchor_fn(self: omni.ui._ui.ShapeAnchorHelper) → None
Sets the function that will be called for the curve anchor.
get_closest_parametric_position(self: omni.ui._ui.ShapeAnchorHelper, position_x: float, position_y: float) → float
Function that returns the closest parametric T value to a given x,y position.
has_anchor_fn(self: omni.ui._ui.ShapeAnchorHelper) → bool
Sets the function that will be called for the curve anchor.
invalidate_anchor(self: omni.ui._ui.ShapeAnchorHelper) → None
Function that causes the anchor frame to be redrawn.
set_anchor_fn(self: omni.ui._ui.ShapeAnchorHelper, fn: Callable[[], None]) → None
Sets the function that will be called for the curve anchor.
property anchor_alignment
This property holds the Alignment of the curve anchor.
property anchor_position
This property holds the parametric value of the curve anchor.
© Copyright 2019-2024, NVIDIA.
Last updated on Mar 25, 2024. |
1_5_4.md | 1.5.4 — Omniverse Launcher latest documentation
Omniverse Launcher
»
Omniverse Launcher »
Release Notes »
1.5.4
# 1.5.4
Release Date: April 2022
## Fixed
Fixed an issue where users couldn’t change configured paths in Launcher.
Fixed Italian translations.
Fixed an issue where Launcher couldn’t be started if System Monitor is installed but missing on disk.
Fixed an issue where connector updates were started immediately instead of being queued on the library tab.
Fixed an issue where components couldn’t be found by full names and tags on the Exchange tab.
© Copyright 2023-2024, NVIDIA.
Last updated on Apr 15, 2024. |
build.md | Build a Project — Omniverse Developer Guide latest documentation
Omniverse Developer Guide
»
Omniverse Developer Guide »
Build a Project
# Build a Project
Depending on the nature of your project, a ‘build step’ may be required as development progresses. Omniverse supports this step with a variety of scripts and tools that generate a representation of the final product, enabling subsequent testing, debugging, and packaging.
## Build-less Projects
Python-only extensions do not require a build step.
Your project might simply be an Extension within another Application, consisting of purely Python code. If that’s the case, you can bypass the build step for the time being. However, if the complexity of your project increases or you decide to create a tailored Application around your extension, introducing a build step into your development process might become necessary.
## “Repo Build”
Find more information about Repo Tools in the Repo Tools documentation.
The Repo Tool is your most likely method for building a Project. This tool operates on both Linux and Windows platforms, providing functionalities ranging from creating new extensions from a template to packaging your final build for distribution.
For access to the current list of available tools via Repo, you can use the following command in a terminal:
repo -h
By Default, you can execute a build which compiles a release target by entering:
repo build
Other options include:
-r [default] will build only the release pipeline.
-d will build only the debug pipeline.
-x will delete all build files in the _build folder.
After executing a repo build, a _build folder is generated, containing targets that you’ve selected to build.
Within this directory, you will find a script file which loads the .kit file that you created for your Project. Alternatively, if you created an Extension, a script file should be present to load the Application you added your Extension to.
© Copyright 2023-2024, NVIDIA.
Last updated on Apr 15, 2024. |
omni.ui.FreeTriangle.md | FreeTriangle — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
FreeTriangle
# FreeTriangle
class omni.ui.FreeTriangle
Bases: Triangle
The Triangle widget provides a colored triangle to display.
The free widget is the widget that is independent of the layout. It means it is stuck to other widgets. When initializing, it’s necessary to provide two widgets, and the shape is drawn from one widget position to the another.
Methods
__init__(self, arg0, arg1, **kwargs)
Initialize the shape with bounds limited to the positions of the given widgets.
Attributes
__init__(self: omni.ui._ui.FreeTriangle, arg0: omni.ui._ui.Widget, arg1: omni.ui._ui.Widget, **kwargs) → None
Initialize the shape with bounds limited to the positions of the given widgets.
### Arguments:
`start :`The bound corner is in the center of this given widget.
`end :`The bound corner is in the center of this given widget.
`kwargsdict`See below
### Keyword Arguments:
`alignment`This property holds the alignment of the triangle when the fill policy is ePreserveAspectFit or ePreserveAspectCrop. By default, the triangle is centered.
`widthui.Length`This property holds the width of the widget relative to its parent. Do not use this function to find the width of a screen.
`heightui.Length`This property holds the height of the widget relative to its parent. Do not use this function to find the height of a screen.
`namestr`The name of the widget that user can set.
`style_type_name_overridestr`By default, we use typeName to look up the style. But sometimes it’s necessary to use a custom name. For example, when a widget is a part of another widget. (Label is a part of Button) This property can override the name to use in style.
`identifierstr`An optional identifier of the widget we can use to refer to it in queries.
`visiblebool`This property holds whether the widget is visible.
`visibleMinfloat`If the current zoom factor and DPI is less than this value, the widget is not visible.
`visibleMaxfloat`If the current zoom factor and DPI is bigger than this value, the widget is not visible.
`tooltipstr`Set a basic tooltip for the widget, this will simply be a Label, it will follow the Tooltip style
`tooltip_fnCallable`Set dynamic tooltip that will be created dynamiclly the first time it is needed. the function is called inside a ui.Frame scope that the widget will be parented correctly.
`tooltip_offset_xfloat`Set the X tooltip offset in points. In a normal state, the tooltip position is linked to the mouse position. If the tooltip offset is non zero, the top left corner of the tooltip is linked to the top left corner of the widget, and this property defines the relative position the tooltip should be shown.
`tooltip_offset_yfloat`Set the Y tooltip offset in points. In a normal state, the tooltip position is linked to the mouse position. If the tooltip offset is non zero, the top left corner of the tooltip is linked to the top left corner of the widget, and this property defines the relative position the tooltip should be shown.
`enabledbool`This property holds whether the widget is enabled. In general an enabled widget handles keyboard and mouse events; a disabled widget does not. And widgets display themselves differently when they are disabled.
`selectedbool`This property holds a flag that specifies the widget has to use eSelected state of the style.
`checkedbool`This property holds a flag that specifies the widget has to use eChecked state of the style. It’s on the Widget level because the button can have sub-widgets that are also should be checked.
`draggingbool`This property holds if the widget is being dragged.
`opaque_for_mouse_eventsbool`If the widgets has callback functions it will by default not capture the events if it is the top most widget and setup this option to true, so they don’t get routed to the child widgets either
`skip_draw_when_clippedbool`The flag that specifies if it’s necessary to bypass the whole draw cycle if the bounding box is clipped with a scrolling frame. It’s needed to avoid the limitation of 65535 primitives in a single draw list.
`mouse_moved_fnCallable`Sets the function that will be called when the user moves the mouse inside the widget. Mouse move events only occur if a mouse button is pressed while the mouse is being moved. void onMouseMoved(float x, float y, int32_t modifier)
`mouse_pressed_fnCallable`Sets the function that will be called when the user presses the mouse button inside the widget. The function should be like this: void onMousePressed(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier) Where ‘button’ is the number of the mouse button pressed. ‘modifier’ is the flag for the keyboard modifier key.
`mouse_released_fnCallable`Sets the function that will be called when the user releases the mouse button if this button was pressed inside the widget. void onMouseReleased(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)
`mouse_double_clicked_fnCallable`Sets the function that will be called when the user presses the mouse button twice inside the widget. The function specification is the same as in setMousePressedFn. void onMouseDoubleClicked(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)
`mouse_wheel_fnCallable`Sets the function that will be called when the user uses mouse wheel on the focused window. The function specification is the same as in setMousePressedFn. void onMouseWheel(float x, float y, carb::input::KeyboardModifierFlags modifier)
`mouse_hovered_fnCallable`Sets the function that will be called when the user use mouse enter/leave on the focused window. function specification is the same as in setMouseHovedFn. void onMouseHovered(bool hovered)
`drag_fnCallable`Specify that this Widget is draggable, and set the callback that is attached to the drag operation.
`accept_drop_fnCallable`Specify that this Widget can accept specific drops and set the callback that is called to check if the drop can be accepted.
`drop_fnCallable`Specify that this Widget accepts drops and set the callback to the drop operation.
`computed_content_size_changed_fnCallable`Called when the size of the widget is changed.
© Copyright 2019-2024, NVIDIA.
Last updated on Mar 25, 2024. |
omni.ui.Stack.md | Stack — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
Stack
# Stack
class omni.ui.Stack
Bases: Container
The Stack class lines up child widgets horizontally, vertically or sorted in a Z-order.
Methods
__init__(self, arg0, **kwargs)
Constructor.
Attributes
content_clipping
Determines if the child widgets should be clipped by the rectangle of this Stack.
direction
This type is used to determine the direction of the layout.
send_mouse_events_to_back
When children of a Z-based stack overlap mouse events are normally sent to the topmost one.
spacing
Sets a non-stretchable space in pixels between child items of this layout.
__init__(self: omni.ui._ui.Stack, arg0: omni.ui._ui.Direction, **kwargs) → None
Constructor.
### Arguments:
`direction :`Determines the orientation of the Stack.
`kwargsdict`See below
### Keyword Arguments:
`direction`This type is used to determine the direction of the layout. If the Stack’s orientation is eLeftToRight the widgets are placed in a horizontal row, from left to right. If the Stack’s orientation is eRightToLeft the widgets are placed in a horizontal row, from right to left. If the Stack’s orientation is eTopToBottom, the widgets are placed in a vertical column, from top to bottom. If the Stack’s orientation is eBottomToTop, the widgets are placed in a vertical column, from bottom to top. If the Stack’s orientation is eBackToFront, the widgets are placed sorted in a Z-order in top right corner. If the Stack’s orientation is eFrontToBack, the widgets are placed sorted in a Z-order in top right corner, the first widget goes to front.
`content_clipping`Determines if the child widgets should be clipped by the rectangle of this Stack.
`spacing`Sets a non-stretchable space in pixels between child items of this layout.
`send_mouse_events_to_back`When children of a Z-based stack overlap mouse events are normally sent to the topmost one. Setting this property true will invert that behavior, sending mouse events to the bottom-most child.
`widthui.Length`This property holds the width of the widget relative to its parent. Do not use this function to find the width of a screen.
`heightui.Length`This property holds the height of the widget relative to its parent. Do not use this function to find the height of a screen.
`namestr`The name of the widget that user can set.
`style_type_name_overridestr`By default, we use typeName to look up the style. But sometimes it’s necessary to use a custom name. For example, when a widget is a part of another widget. (Label is a part of Button) This property can override the name to use in style.
`identifierstr`An optional identifier of the widget we can use to refer to it in queries.
`visiblebool`This property holds whether the widget is visible.
`visibleMinfloat`If the current zoom factor and DPI is less than this value, the widget is not visible.
`visibleMaxfloat`If the current zoom factor and DPI is bigger than this value, the widget is not visible.
`tooltipstr`Set a basic tooltip for the widget, this will simply be a Label, it will follow the Tooltip style
`tooltip_fnCallable`Set dynamic tooltip that will be created dynamiclly the first time it is needed. the function is called inside a ui.Frame scope that the widget will be parented correctly.
`tooltip_offset_xfloat`Set the X tooltip offset in points. In a normal state, the tooltip position is linked to the mouse position. If the tooltip offset is non zero, the top left corner of the tooltip is linked to the top left corner of the widget, and this property defines the relative position the tooltip should be shown.
`tooltip_offset_yfloat`Set the Y tooltip offset in points. In a normal state, the tooltip position is linked to the mouse position. If the tooltip offset is non zero, the top left corner of the tooltip is linked to the top left corner of the widget, and this property defines the relative position the tooltip should be shown.
`enabledbool`This property holds whether the widget is enabled. In general an enabled widget handles keyboard and mouse events; a disabled widget does not. And widgets display themselves differently when they are disabled.
`selectedbool`This property holds a flag that specifies the widget has to use eSelected state of the style.
`checkedbool`This property holds a flag that specifies the widget has to use eChecked state of the style. It’s on the Widget level because the button can have sub-widgets that are also should be checked.
`draggingbool`This property holds if the widget is being dragged.
`opaque_for_mouse_eventsbool`If the widgets has callback functions it will by default not capture the events if it is the top most widget and setup this option to true, so they don’t get routed to the child widgets either
`skip_draw_when_clippedbool`The flag that specifies if it’s necessary to bypass the whole draw cycle if the bounding box is clipped with a scrolling frame. It’s needed to avoid the limitation of 65535 primitives in a single draw list.
`mouse_moved_fnCallable`Sets the function that will be called when the user moves the mouse inside the widget. Mouse move events only occur if a mouse button is pressed while the mouse is being moved. void onMouseMoved(float x, float y, int32_t modifier)
`mouse_pressed_fnCallable`Sets the function that will be called when the user presses the mouse button inside the widget. The function should be like this: void onMousePressed(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier) Where ‘button’ is the number of the mouse button pressed. ‘modifier’ is the flag for the keyboard modifier key.
`mouse_released_fnCallable`Sets the function that will be called when the user releases the mouse button if this button was pressed inside the widget. void onMouseReleased(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)
`mouse_double_clicked_fnCallable`Sets the function that will be called when the user presses the mouse button twice inside the widget. The function specification is the same as in setMousePressedFn. void onMouseDoubleClicked(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)
`mouse_wheel_fnCallable`Sets the function that will be called when the user uses mouse wheel on the focused window. The function specification is the same as in setMousePressedFn. void onMouseWheel(float x, float y, carb::input::KeyboardModifierFlags modifier)
`mouse_hovered_fnCallable`Sets the function that will be called when the user use mouse enter/leave on the focused window. function specification is the same as in setMouseHovedFn. void onMouseHovered(bool hovered)
`drag_fnCallable`Specify that this Widget is draggable, and set the callback that is attached to the drag operation.
`accept_drop_fnCallable`Specify that this Widget can accept specific drops and set the callback that is called to check if the drop can be accepted.
`drop_fnCallable`Specify that this Widget accepts drops and set the callback to the drop operation.
`computed_content_size_changed_fnCallable`Called when the size of the widget is changed.
property content_clipping
Determines if the child widgets should be clipped by the rectangle of this Stack.
property direction
This type is used to determine the direction of the layout. If the Stack’s orientation is eLeftToRight the widgets are placed in a horizontal row, from left to right. If the Stack’s orientation is eRightToLeft the widgets are placed in a horizontal row, from right to left. If the Stack’s orientation is eTopToBottom, the widgets are placed in a vertical column, from top to bottom. If the Stack’s orientation is eBottomToTop, the widgets are placed in a vertical column, from bottom to top. If the Stack’s orientation is eBackToFront, the widgets are placed sorted in a Z-order in top right corner. If the Stack’s orientation is eFrontToBack, the widgets are placed sorted in a Z-order in top right corner, the first widget goes to front.
property send_mouse_events_to_back
When children of a Z-based stack overlap mouse events are normally sent to the topmost one. Setting this property true will invert that behavior, sending mouse events to the bottom-most child.
property spacing
Sets a non-stretchable space in pixels between child items of this layout.
© Copyright 2019-2024, NVIDIA.
Last updated on Mar 25, 2024. |
1_0_42.md | 1.0.42 — Omniverse Launcher latest documentation
Omniverse Launcher
»
Omniverse Launcher »
Release Notes »
1.0.42
# 1.0.42
Release Date: Jan 2021
Added News section to display content from Omniverse News in the launcher
Fixed collecting hardware info on Linux when lshw returns an array
Add a login session in System Monitor when Nucleus is installed
Moved all licenses to PACKAGE-LICENSES folder, added a LICENSES link to the about dialog
Fixed user was not prompted to select data paths or install Cache
© Copyright 2023-2024, NVIDIA.
Last updated on Apr 15, 2024. |
omni.ui.Window.md | Window — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
Window
# Window
class omni.ui.Window
Bases: WindowHandle
The Window class represents a window in the underlying windowing system.
This window is a child window of main Kit window. And it can be docked.
Rasterization
omni.ui generates vertices every frame to render UI elements. One of the features of the framework is the ability to bake a DrawList per window and reuse it if the content has not changed, which can significantly improve performance. However, in some cases, such as the Viewport window and Console window, it may not be possible to detect whether the window content has changed, leading to a frozen window. To address this problem, you can control the rasterization behavior by adjusting RasterPolicy. The RasterPolicy is an enumeration class that defines the rasterization behavior of a window. It has three possible values:
NEVER: Do not rasterize the widget at any time. ON_DEMAND: Rasterize the widget as soon as possible and always use the rasterized version. The widget will only be updated when the user calls invalidateRaster. AUTO: Automatically determine whether to rasterize the widget based on performance considerations. If necessary, the widget will be rasterized and updated when its content changes.
To resolve the frozen window issue, you can manually set the RasterPolicy of the problematic window to Never. This will force the window to rasterize its content and use the rasterized version until the user explicitly calls invalidateRaster to request an update.
window = ui.Window(“Test window”, raster_policy=ui.RasterPolicy.NEVER)
Methods
__init__(self, title, dockPreference, **kwargs)
Construct the window, add it to the underlying windowing system, and makes it appear.
call_key_pressed_fn(self, arg0, arg1, arg2)
Sets the function that will be called when the user presses the keyboard key on the focused window.
deferred_dock_in(self, target_window, ...)
Deferred docking.
destroy(self)
Removes all the callbacks and circular references.
dock_in_window(self, title, dockPosition[, ...])
place the window in a specific docking position based on a target window name.
get_window_callback(self)
Returns window set draw callback pointer for the given UI window.
has_key_pressed_fn(self)
Sets the function that will be called when the user presses the keyboard key on the focused window.
move_to_app_window(self, arg0)
Moves the window to the specific OS window.
move_to_main_os_window(self)
Bring back the Window callback to the Main Window and destroy the Current OS Window.
move_to_new_os_window(self)
Move the Window Callback to a new OS Window.
notify_app_window_change(self, arg0)
Notifies the window that window set has changed.
setPosition(self, x, y)
This property set/get the position of the window in both axis calling the property.
set_docked_changed_fn(self, arg0)
Has true if this window is docked.
set_focused_changed_fn(self, arg0)
Read only property that is true when the window is focused.
set_height_changed_fn(self, arg0)
This property holds the window Height.
set_key_pressed_fn(self, fn)
Sets the function that will be called when the user presses the keyboard key on the focused window.
set_position_x_changed_fn(self, arg0)
This property set/get the position of the window in the X Axis.
set_position_y_changed_fn(self, arg0)
This property set/get the position of the window in the Y Axis.
set_selected_in_dock_changed_fn(self, arg0)
Has true if this window is currently selected in the dock.
set_top_modal(self)
Brings this window to the top level of modal windows.
set_visibility_changed_fn(self, arg0)
This property holds whether the window is visible.
set_width_changed_fn(self, arg0)
This property holds the window Width.
Attributes
app_window
auto_resize
setup the window to resize automatically based on its content
detachable
If the window is able to be separated from the main application window.
docked
Has true if this window is docked.
exclusive_keyboard
When true, only the current window will receive keyboard events when it's focused.
flags
This property set the Flags for the Window.
focus_policy
How the Window gains focus.
focused
Read only property that is true when the window is focused.
frame
The main layout of this window.
height
This property holds the window Height.
menu_bar
noTabBar
setup the visibility of the TabBar Handle, this is the small triangle at the corner of the view If it is not shown then it is not possible to undock that window and it need to be closed/moved programatically
padding_x
This property set the padding to the frame on the X axis.
padding_y
This property set the padding to the frame on the Y axis.
position_x
This property set/get the position of the window in the X Axis.
position_y
This property set/get the position of the window in the Y Axis.
raster_policy
Determine how the content of the window should be rastered.
selected_in_dock
Has true if this window is currently selected in the dock.
tabBar_tooltip
This property sets the tooltip when hovering over window's tabbar.
title
This property holds the window's title.
visible
This property holds whether the window is visible.
width
This property holds the window Width.
__init__(self: omni.ui._ui.Window, title: str, dockPreference: omni.ui._ui.DockPreference = <DockPreference.DISABLED: 0>, **kwargs) → None
Construct the window, add it to the underlying windowing system, and makes it appear.
### Arguments:
`title :`The window title. It’s also used as an internal window ID.
`dockPrefence :`In the old Kit determines where the window should be docked. In Kit Next it’s unused.
`kwargsdict`See below
### Keyword Arguments:
`flags`This property set the Flags for the Window.
`visible`This property holds whether the window is visible.
`title`This property holds the window’s title.
`padding_x`This property set the padding to the frame on the X axis.
`padding_y`This property set the padding to the frame on the Y axis.
`width`This property holds the window Width.
`height`This property holds the window Height.
`position_x`This property set/get the position of the window in the X Axis. The default is kWindowFloatInvalid because we send the window position to the underlying system only if the position is explicitly set by the user. Otherwise the underlying system decides the position.
`position_y`This property set/get the position of the window in the Y Axis. The default is kWindowFloatInvalid because we send the window position to the underlying system only if the position is explicitly set by the user. Otherwise the underlying system decides the position.
`auto_resize`setup the window to resize automatically based on its content
`noTabBar`setup the visibility of the TabBar Handle, this is the small triangle at the corner of the view If it is not shown then it is not possible to undock that window and it need to be closed/moved programatically
`tabBarTooltip`This property sets the tooltip when hovering over window’s tabbar.
`raster_policy`Determine how the content of the window should be rastered.
`width_changed_fn`This property holds the window Width.
`height_changed_fn`This property holds the window Height.
`visibility_changed_fn`This property holds whether the window is visible.
call_key_pressed_fn(self: omni.ui._ui.Window, arg0: int, arg1: int, arg2: bool) → None
Sets the function that will be called when the user presses the keyboard key on the focused window.
deferred_dock_in(self: omni.ui._ui.Window, target_window: str, active_window: omni.ui._ui.DockPolicy = <DockPolicy.DO_NOTHING: 0>) → None
Deferred docking. We need it when we want to dock windows before they were actually created. It’s helpful when extension initialization, before any window is created.
### Arguments:
`targetWindowTitle :`Dock to window with this title when it appears.
`activeWindow :`Make target or this window active when docked.
destroy(self: omni.ui._ui.Window) → None
Removes all the callbacks and circular references.
dock_in_window(self: omni.ui._ui.Window, title: str, dockPosition: omni.ui._ui.DockPosition, ratio: float = 0.5) → bool
place the window in a specific docking position based on a target window name. We will find the target window dock node and insert this window in it, either by spliting on ratio or on top if the window is not found false is return, otherwise true
get_window_callback(self: omni.ui._ui.Window) → omni::ui::windowmanager::IWindowCallback
Returns window set draw callback pointer for the given UI window.
has_key_pressed_fn(self: omni.ui._ui.Window) → bool
Sets the function that will be called when the user presses the keyboard key on the focused window.
move_to_app_window(self: omni.ui._ui.Window, arg0: omni::kit::IAppWindow) → None
Moves the window to the specific OS window.
move_to_main_os_window(self: omni.ui._ui.Window) → None
Bring back the Window callback to the Main Window and destroy the Current OS Window.
move_to_new_os_window(self: omni.ui._ui.Window) → None
Move the Window Callback to a new OS Window.
notify_app_window_change(self: omni.ui._ui.Window, arg0: omni::kit::IAppWindow) → None
Notifies the window that window set has changed.
setPosition(self: omni.ui._ui.Window, x: float, y: float) → None
This property set/get the position of the window in both axis calling the property.
set_docked_changed_fn(self: omni.ui._ui.Window, arg0: Callable[[bool], None]) → None
Has true if this window is docked. False otherwise. It’s a read-only property.
set_focused_changed_fn(self: omni.ui._ui.Window, arg0: Callable[[bool], None]) → None
Read only property that is true when the window is focused.
set_height_changed_fn(self: omni.ui._ui.Window, arg0: Callable[[float], None]) → None
This property holds the window Height.
set_key_pressed_fn(self: omni.ui._ui.Window, fn: Callable[[int, int, bool], None]) → None
Sets the function that will be called when the user presses the keyboard key on the focused window.
set_position_x_changed_fn(self: omni.ui._ui.Window, arg0: Callable[[float], None]) → None
This property set/get the position of the window in the X Axis. The default is kWindowFloatInvalid because we send the window position to the underlying system only if the position is explicitly set by the user. Otherwise the underlying system decides the position.
set_position_y_changed_fn(self: omni.ui._ui.Window, arg0: Callable[[float], None]) → None
This property set/get the position of the window in the Y Axis. The default is kWindowFloatInvalid because we send the window position to the underlying system only if the position is explicitly set by the user. Otherwise the underlying system decides the position.
set_selected_in_dock_changed_fn(self: omni.ui._ui.Window, arg0: Callable[[bool], None]) → None
Has true if this window is currently selected in the dock. False otherwise. It’s a read-only property.
set_top_modal(self: omni.ui._ui.Window) → None
Brings this window to the top level of modal windows.
set_visibility_changed_fn(self: omni.ui._ui.Window, arg0: Callable[[bool], None]) → None
This property holds whether the window is visible.
set_width_changed_fn(self: omni.ui._ui.Window, arg0: Callable[[float], None]) → None
This property holds the window Width.
property auto_resize
setup the window to resize automatically based on its content
property detachable
If the window is able to be separated from the main application window.
property docked
Has true if this window is docked. False otherwise. It’s a read-only property.
property exclusive_keyboard
When true, only the current window will receive keyboard events when it’s focused. It’s useful to override the global key bindings.
property flags
This property set the Flags for the Window.
property focus_policy
How the Window gains focus.
property focused
Read only property that is true when the window is focused.
property frame
The main layout of this window.
property height
This property holds the window Height.
property noTabBar
setup the visibility of the TabBar Handle, this is the small triangle at the corner of the view If it is not shown then it is not possible to undock that window and it need to be closed/moved programatically
property padding_x
This property set the padding to the frame on the X axis.
property padding_y
This property set the padding to the frame on the Y axis.
property position_x
This property set/get the position of the window in the X Axis. The default is kWindowFloatInvalid because we send the window position to the underlying system only if the position is explicitly set by the user. Otherwise the underlying system decides the position.
property position_y
This property set/get the position of the window in the Y Axis. The default is kWindowFloatInvalid because we send the window position to the underlying system only if the position is explicitly set by the user. Otherwise the underlying system decides the position.
property raster_policy
Determine how the content of the window should be rastered.
property selected_in_dock
Has true if this window is currently selected in the dock. False otherwise. It’s a read-only property.
property tabBar_tooltip
This property sets the tooltip when hovering over window’s tabbar.
property title
This property holds the window’s title.
property visible
This property holds whether the window is visible.
property width
This property holds the window Width.
© Copyright 2019-2024, NVIDIA.
Last updated on Mar 25, 2024. |
omni.ui.Percent.md | Percent — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
Percent
# Percent
class omni.ui.Percent
Bases: Length
Percent is the length in percents from the parent widget.
Methods
__init__(self, value)
Construct Percent.
Attributes
__init__(self: omni.ui._ui.Percent, value: float) → None
Construct Percent.
`kwargsdict`See below
### Keyword Arguments:
© Copyright 2019-2024, NVIDIA.
Last updated on Mar 25, 2024. |
omni.ui.TextureFormat.md | TextureFormat — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
TextureFormat
# TextureFormat
class omni.ui.TextureFormat
Bases: pybind11_object
Members:
R8_UNORM
R8_SNORM
R8_UINT
R8_SINT
RG8_UNORM
RG8_SNORM
RG8_UINT
RG8_SINT
BGRA8_UNORM
BGRA8_SRGB
RGBA8_UNORM
RGBA8_SNORM
RGBA8_UINT
RGBA8_SINT
RGBA8_SRGB
R16_UNORM
R16_SNORM
R16_UINT
R16_SINT
R16_SFLOAT
RG16_UNORM
RG16_SNORM
RG16_UINT
RG16_SINT
RG16_SFLOAT
RGBA16_UNORM
RGBA16_SNORM
RGBA16_UINT
RGBA16_SINT
RGBA16_SFLOAT
R32_UINT
R32_SINT
R32_SFLOAT
RG32_UINT
RG32_SINT
RG32_SFLOAT
RGB32_UINT
RGB32_SINT
RGB32_SFLOAT
RGBA32_UINT
RGBA32_SINT
RGBA32_SFLOAT
R10_G10_B10_A2_UNORM
R10_G10_B10_A2_UINT
R11_G11_B10_UFLOAT
R9_G9_B9_E5_UFLOAT
B5_G6_R5_UNORM
B5_G5_R5_A1_UNORM
BC1_RGBA_UNORM
BC1_RGBA_SRGB
BC2_RGBA_UNORM
BC2_RGBA_SRGB
BC3_RGBA_UNORM
BC3_RGBA_SRGB
BC4_R_UNORM
BC4_R_SNORM
BC5_RG_UNORM
BC5_RG_SNORM
BC6H_RGB_UFLOAT
BC6H_RGB_SFLOAT
BC7_RGBA_UNORM
BC7_RGBA_SRGB
D16_UNORM
D24_UNORM_S8_UINT
D32_SFLOAT
D32_SFLOAT_S8_UINT_X24
R24_UNORM_X8
X24_R8_UINT
X32_R8_UINT_X24
R32_SFLOAT_X8_X24
SAMPLER_FEEDBACK_MIN_MIP
SAMPLER_FEEDBACK_MIP_REGION_USED
Methods
__init__(self, value)
Attributes
B5_G5_R5_A1_UNORM
B5_G6_R5_UNORM
BC1_RGBA_SRGB
BC1_RGBA_UNORM
BC2_RGBA_SRGB
BC2_RGBA_UNORM
BC3_RGBA_SRGB
BC3_RGBA_UNORM
BC4_R_SNORM
BC4_R_UNORM
BC5_RG_SNORM
BC5_RG_UNORM
BC6H_RGB_SFLOAT
BC6H_RGB_UFLOAT
BC7_RGBA_SRGB
BC7_RGBA_UNORM
BGRA8_SRGB
BGRA8_UNORM
D16_UNORM
D24_UNORM_S8_UINT
D32_SFLOAT
D32_SFLOAT_S8_UINT_X24
R10_G10_B10_A2_UINT
R10_G10_B10_A2_UNORM
R11_G11_B10_UFLOAT
R16_SFLOAT
R16_SINT
R16_SNORM
R16_UINT
R16_UNORM
R24_UNORM_X8
R32_SFLOAT
R32_SFLOAT_X8_X24
R32_SINT
R32_UINT
R8_SINT
R8_SNORM
R8_UINT
R8_UNORM
R9_G9_B9_E5_UFLOAT
RG16_SFLOAT
RG16_SINT
RG16_SNORM
RG16_UINT
RG16_UNORM
RG32_SFLOAT
RG32_SINT
RG32_UINT
RG8_SINT
RG8_SNORM
RG8_UINT
RG8_UNORM
RGB32_SFLOAT
RGB32_SINT
RGB32_UINT
RGBA16_SFLOAT
RGBA16_SINT
RGBA16_SNORM
RGBA16_UINT
RGBA16_UNORM
RGBA32_SFLOAT
RGBA32_SINT
RGBA32_UINT
RGBA8_SINT
RGBA8_SNORM
RGBA8_SRGB
RGBA8_UINT
RGBA8_UNORM
SAMPLER_FEEDBACK_MIN_MIP
SAMPLER_FEEDBACK_MIP_REGION_USED
X24_R8_UINT
X32_R8_UINT_X24
name
value
__init__(self: omni.gpu_foundation_factory._gpu_foundation_factory.TextureFormat, value: int) → None
property name
© Copyright 2019-2024, NVIDIA.
Last updated on Mar 25, 2024. |
omni.ui.ByteImageProvider.md | ByteImageProvider — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
ByteImageProvider
# ByteImageProvider
class omni.ui.ByteImageProvider
Bases: ImageProvider
doc
Methods
__init__(*args, **kwargs)
Overloaded function.
set_bytes_data(self, bytes, sizes, format, ...)
Sets Python sequence as byte data.
set_bytes_data_from_gpu(self, gpu_bytes, ...)
Sets byte data from a copy of gpu memory at gpuBytes.
set_data(self, arg0, arg1)
[DEPRECATED FUNCTION]
set_data_array(self, arg0, arg1)
set_raw_bytes_data(self, raw_bytes, sizes, ...)
Sets byte data that the image provider will turn raw pointer array into an image.
Attributes
__init__(*args, **kwargs)
Overloaded function.
__init__(self: omni.ui._ui.ByteImageProvider) -> None
doc
__init__(self: omni.ui._ui.ByteImageProvider, bytes: sequence, sizes: List[int], format: omni.gpu_foundation_factory._gpu_foundation_factory.TextureFormat = <TextureFormat.???: 0>, stride: int = -1) -> None
doc
set_bytes_data(self: omni.ui._ui.ByteImageProvider, bytes: sequence, sizes: List[int], format: omni.gpu_foundation_factory._gpu_foundation_factory.TextureFormat = <TextureFormat.???: 0>, stride: int = -1) → None
Sets Python sequence as byte data. The image provider will recognize flattened color values, or sequence within sequence and convert it into an image.
set_bytes_data_from_gpu(self: omni.ui._ui.ByteImageProvider, gpu_bytes: int, sizes: List[int], format: omni.gpu_foundation_factory._gpu_foundation_factory.TextureFormat = <TextureFormat.RGBA8_UNORM: 11>, stride: int = -1) → None
Sets byte data from a copy of gpu memory at gpuBytes.
set_data(self: omni.ui._ui.ByteImageProvider, arg0: List[int], arg1: List[int]) → None
[DEPRECATED FUNCTION]
set_data_array(self: omni.ui._ui.ByteImageProvider, arg0: numpy.ndarray[numpy.uint8], arg1: List[int]) → None
set_raw_bytes_data(self: omni.ui._ui.ByteImageProvider, raw_bytes: capsule, sizes: List[int], format: omni.gpu_foundation_factory._gpu_foundation_factory.TextureFormat = <TextureFormat.RGBA8_UNORM: 11>, stride: int = -1) → None
Sets byte data that the image provider will turn raw pointer array into an image.
© Copyright 2019-2024, NVIDIA.
Last updated on Mar 25, 2024. |
omni.ui.AbstractItemDelegate.md | AbstractItemDelegate — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
AbstractItemDelegate
# AbstractItemDelegate
class omni.ui.AbstractItemDelegate
Bases: pybind11_object
AbstractItemDelegate is used to generate widgets that display and edit data items from a model.
Methods
__init__(self)
Constructs AbstractItemDelegate.
build_branch(self, model[, item, column_id, ...])
This pure abstract method must be reimplemented to generate custom collapse/expand button.
build_header(self[, column_id])
This pure abstract method must be reimplemented to generate custom widgets for the header table.
build_widget(self, model[, item, index, ...])
This pure abstract method must be reimplemented to generate custom widgets for specific item in the model.
__init__(self: omni.ui._ui.AbstractItemDelegate) → None
Constructs AbstractItemDelegate.
`kwargsdict`See below
### Keyword Arguments:
build_branch(self: omni.ui._ui.AbstractItemDelegate, model: omni.ui._ui.AbstractItemModel, item: omni.ui._ui.AbstractItem = None, column_id: int = 0, level: int = 0, expanded: bool = False) → None
This pure abstract method must be reimplemented to generate custom collapse/expand button.
build_header(self: omni.ui._ui.AbstractItemDelegate, column_id: int = 0) → None
This pure abstract method must be reimplemented to generate custom widgets for the header table.
build_widget(self: omni.ui._ui.AbstractItemDelegate, model: omni.ui._ui.AbstractItemModel, item: omni.ui._ui.AbstractItem = None, index: int = 0, level: int = 0, expanded: bool = False) → None
This pure abstract method must be reimplemented to generate custom widgets for specific item in the model.
© Copyright 2019-2024, NVIDIA.
Last updated on Mar 25, 2024. |
omni.ui.set_menu_delegate.md | set_menu_delegate — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Functions »
set_menu_delegate
# set_menu_delegate
omni.ui.set_menu_delegate(delegate: MenuDelegate)
Set the default delegate to use it when the item doesn’t have a
delegate.
© Copyright 2019-2024, NVIDIA.
Last updated on Mar 25, 2024. |
kit_core_iapp_interface.md | Omniverse Kit Core IApp interface — kit-manual 105.1 documentation
kit-manual
»
Omniverse Kit Core IApp interface
# Omniverse Kit Core IApp interface
The omni.kit.app subsystem is a Kit core plugin that defines the minimal set of functionality that Kit Core provides, specifically:
Loop runner entry point
Extension manager
Scripting support
General message bus
Shutdown sequence management
Hang detector
From the external extension point of view, the only wires that extension gets initially - are just the startup and shutdown functions. In order for the extension to be updated in the Kit environment, the extension is supposed to subscribe to the event stream updates that are served by the Kit application’s loop runner.
## Loop runners
Loop runner is something that drives the application loop, more specifically - pushes update events into corresponding update event streams and pumps the event streams, thus allowing the modular bits and pieces to tick.
In the simplest scenario, the loop runner is a piece of logic that ensures that core event streams are being pumped periodically. Pseudocode of the simplest loop runner:
void update()
{
preUpdateEventStream->push(...);
preUpdateEventStream->pump();
updateEventStream->push(...);
updateEventStream->pump();
postUpdateEventStream->push(...);
postUpdateEventStream->pump();
messageBus->pump();
}
This is the most straightforward way to drive the Kit app, and it is possible to implement a custom version of IRunLoopRunner and provide it for the app to use. The default loop runner is close to the straightforward implementation outlined in the pseudocode with the small additions of rate limiter logic and other minor pieces of maintenance logic.
## Extension manager
Extension manager controls the extensions execution flow, maintains the extension registry, and does other related things. Extensions subsystem will be detailed separately, as this is the main entry point for all the modular pieces that make up the Kit app. The extension manager interface can be accessed via the Kit Core app interface.
## Scripting
The Kit Core app sets up Python scripting environment required to support Python extensions and execute custom Python scripts and code snippets. IAppScripting provides a simple interface to this scripting environment, which can be used to execute files and strings, as well as manage script search folders, and subscribe to the event stream that will broadcast all the scripting events (such as script command events, script output events and script error events, all bucketed into corresponding event types).
## General message bus
General message bus is a simple yet powerful concept. This is simply an event stream, which is pumped once a frame after all updates, and anybody can use the bus to send and listen to events. This is useful in cases where event stream ownership is inconvenient, or when app-wide events are established (for example, displaying a popup, or things like that) - which can be used by many consumers across all the extensions. According to the event stream guidelines, it is recommended to derive an event type from a string hash. Simple example of message bus usage:
import carb.events
import omni.kit.app
BUS_EVENT_TYPE = carb.events.type_from_string("my_ext.SOME_EVENT")
message_bus = omni.kit.app.get_app().get_message_bus_event_stream()
subscription = message_bus.create_subscription_to_pop_by_type(BUS_EVENT_TYPE, on_change)
# Store subscription somewhere so it doesn't get deleted immediately
subs.append(subscription)
## Shutdown sequence
The application receives shutdown requests via the post quit queries. Queries will be recorded and the app will proceed as usual, until the shutdown query will be processed at a defined place in the update logic.
Prior to the real shutdown initiation, the post query event will be injected into the shutdown event stream. Consumers subscribed to the event stream will have a chance to request a shutdown request cancellation. If it will be requested, the shutdown will not happen. This is needed for example to show the dialog popups confirming exit when there is unsaved work pending. If the shutdown wasn’t cancelled - another event will be injected into the shutdown event stream, this time telling it that the real shutdown is about to start.
However, it is possible to post an uncancellable quit request - as an emergency measure in case the application needs to be shut down without interruptions.
## Hang detector
The app core also incorporates a simple hang detector, which is designed to receive periodic nudges, and if there are no nudges for some defined amount of time - it will notify the user that a hang is detected and can crash the application if user chooses. This is helpful because crashes generates crash dumps, allowing developers understand what happened, and what the callstack was at the time of this hang. Things like the timeout, if it is enabled - and other things - can be tweaked via the settings.
© Copyright 2019-2023, NVIDIA.
Last updated on Nov 14, 2023. |
omni.ui.Frame.md | Frame — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
Frame
# Frame
class omni.ui.Frame
Bases: Container
The Frame is a widget that can hold one child widget.
Frame is used to crop the contents of a child widget or to draw small widget in a big view. The child widget must be specified with addChild().
Methods
__init__(self, **kwargs)
Constructs Frame.
call_build_fn(self)
Set the callback that will be called once the frame is visible and the content of the callback will override the frame child.
has_build_fn(self)
Set the callback that will be called once the frame is visible and the content of the callback will override the frame child.
invalidate_raster(self)
This method regenerates the raster image of the widget, even if the widget's content has not changed.
rebuild(self)
After this method is called, the next drawing cycle build_fn will be called again to rebuild everything.
set_build_fn(self, fn)
Set the callback that will be called once the frame is visible and the content of the callback will override the frame child.
Attributes
frozen
A special mode where the child is placed to the transparent borderless window.
horizontal_clipping
When the content of the frame is bigger than the frame the exceeding part is not drawn if the clipping is on.
raster_policy
Determine how the content of the frame should be rasterized.
separate_window
A special mode where the child is placed to the transparent borderless window.
vertical_clipping
When the content of the frame is bigger than the frame the exceeding part is not drawn if the clipping is on.
__init__(self: omni.ui._ui.Frame, **kwargs) → None
Constructs Frame.
`kwargsdict`See below
### Keyword Arguments:
`horizontal_clipping`When the content of the frame is bigger than the frame the exceeding part is not drawn if the clipping is on. It only works for horizontal direction.
`vertical_clipping`When the content of the frame is bigger than the frame the exceeding part is not drawn if the clipping is on. It only works for vertial direction.
`separate_window`A special mode where the child is placed to the transparent borderless window. We need it to be able to place the UI to the exact stacking order between other windows.
`raster_policy`Determine how the content of the frame should be rasterized.
`build_fn`Set the callback that will be called once the frame is visible and the content of the callback will override the frame child. It’s useful for lazy load.
`widthui.Length`This property holds the width of the widget relative to its parent. Do not use this function to find the width of a screen.
`heightui.Length`This property holds the height of the widget relative to its parent. Do not use this function to find the height of a screen.
`namestr`The name of the widget that user can set.
`style_type_name_overridestr`By default, we use typeName to look up the style. But sometimes it’s necessary to use a custom name. For example, when a widget is a part of another widget. (Label is a part of Button) This property can override the name to use in style.
`identifierstr`An optional identifier of the widget we can use to refer to it in queries.
`visiblebool`This property holds whether the widget is visible.
`visibleMinfloat`If the current zoom factor and DPI is less than this value, the widget is not visible.
`visibleMaxfloat`If the current zoom factor and DPI is bigger than this value, the widget is not visible.
`tooltipstr`Set a basic tooltip for the widget, this will simply be a Label, it will follow the Tooltip style
`tooltip_fnCallable`Set dynamic tooltip that will be created dynamiclly the first time it is needed. the function is called inside a ui.Frame scope that the widget will be parented correctly.
`tooltip_offset_xfloat`Set the X tooltip offset in points. In a normal state, the tooltip position is linked to the mouse position. If the tooltip offset is non zero, the top left corner of the tooltip is linked to the top left corner of the widget, and this property defines the relative position the tooltip should be shown.
`tooltip_offset_yfloat`Set the Y tooltip offset in points. In a normal state, the tooltip position is linked to the mouse position. If the tooltip offset is non zero, the top left corner of the tooltip is linked to the top left corner of the widget, and this property defines the relative position the tooltip should be shown.
`enabledbool`This property holds whether the widget is enabled. In general an enabled widget handles keyboard and mouse events; a disabled widget does not. And widgets display themselves differently when they are disabled.
`selectedbool`This property holds a flag that specifies the widget has to use eSelected state of the style.
`checkedbool`This property holds a flag that specifies the widget has to use eChecked state of the style. It’s on the Widget level because the button can have sub-widgets that are also should be checked.
`draggingbool`This property holds if the widget is being dragged.
`opaque_for_mouse_eventsbool`If the widgets has callback functions it will by default not capture the events if it is the top most widget and setup this option to true, so they don’t get routed to the child widgets either
`skip_draw_when_clippedbool`The flag that specifies if it’s necessary to bypass the whole draw cycle if the bounding box is clipped with a scrolling frame. It’s needed to avoid the limitation of 65535 primitives in a single draw list.
`mouse_moved_fnCallable`Sets the function that will be called when the user moves the mouse inside the widget. Mouse move events only occur if a mouse button is pressed while the mouse is being moved. void onMouseMoved(float x, float y, int32_t modifier)
`mouse_pressed_fnCallable`Sets the function that will be called when the user presses the mouse button inside the widget. The function should be like this: void onMousePressed(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier) Where ‘button’ is the number of the mouse button pressed. ‘modifier’ is the flag for the keyboard modifier key.
`mouse_released_fnCallable`Sets the function that will be called when the user releases the mouse button if this button was pressed inside the widget. void onMouseReleased(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)
`mouse_double_clicked_fnCallable`Sets the function that will be called when the user presses the mouse button twice inside the widget. The function specification is the same as in setMousePressedFn. void onMouseDoubleClicked(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)
`mouse_wheel_fnCallable`Sets the function that will be called when the user uses mouse wheel on the focused window. The function specification is the same as in setMousePressedFn. void onMouseWheel(float x, float y, carb::input::KeyboardModifierFlags modifier)
`mouse_hovered_fnCallable`Sets the function that will be called when the user use mouse enter/leave on the focused window. function specification is the same as in setMouseHovedFn. void onMouseHovered(bool hovered)
`drag_fnCallable`Specify that this Widget is draggable, and set the callback that is attached to the drag operation.
`accept_drop_fnCallable`Specify that this Widget can accept specific drops and set the callback that is called to check if the drop can be accepted.
`drop_fnCallable`Specify that this Widget accepts drops and set the callback to the drop operation.
`computed_content_size_changed_fnCallable`Called when the size of the widget is changed.
call_build_fn(self: omni.ui._ui.Frame) → None
Set the callback that will be called once the frame is visible and the content of the callback will override the frame child. It’s useful for lazy load.
has_build_fn(self: omni.ui._ui.Frame) → bool
Set the callback that will be called once the frame is visible and the content of the callback will override the frame child. It’s useful for lazy load.
invalidate_raster(self: omni.ui._ui.Frame) → None
This method regenerates the raster image of the widget, even if the widget’s content has not changed. This can be used with both the eOnDemand and eAuto raster policies, and is used to update the content displayed in the widget. Note that this operation may be resource-intensive, and should be used sparingly.
rebuild(self: omni.ui._ui.Frame) → None
After this method is called, the next drawing cycle build_fn will be called again to rebuild everything.
set_build_fn(self: omni.ui._ui.Frame, fn: Callable[[], None]) → None
Set the callback that will be called once the frame is visible and the content of the callback will override the frame child. It’s useful for lazy load.
property frozen
A special mode where the child is placed to the transparent borderless window. We need it to be able to place the UI to the exact stacking order between other windows.
property horizontal_clipping
When the content of the frame is bigger than the frame the exceeding part is not drawn if the clipping is on. It only works for horizontal direction.
property raster_policy
Determine how the content of the frame should be rasterized.
property separate_window
A special mode where the child is placed to the transparent borderless window. We need it to be able to place the UI to the exact stacking order between other windows.
property vertical_clipping
When the content of the frame is bigger than the frame the exceeding part is not drawn if the clipping is on. It only works for vertial direction.
© Copyright 2019-2024, NVIDIA.
Last updated on Mar 25, 2024. |
omni.ui.IntField.md | IntField — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
IntField
# IntField
class omni.ui.IntField
Bases: AbstractField
The IntField widget is a one-line text editor with a string model.
Methods
__init__(self[, model])
Construct IntField.
Attributes
__init__(self: omni.ui._ui.IntField, model: omni.ui._ui.AbstractValueModel = None, **kwargs) → None
Construct IntField.
`kwargsdict`See below
### Keyword Arguments:
`widthui.Length`This property holds the width of the widget relative to its parent. Do not use this function to find the width of a screen.
`heightui.Length`This property holds the height of the widget relative to its parent. Do not use this function to find the height of a screen.
`namestr`The name of the widget that user can set.
`style_type_name_overridestr`By default, we use typeName to look up the style. But sometimes it’s necessary to use a custom name. For example, when a widget is a part of another widget. (Label is a part of Button) This property can override the name to use in style.
`identifierstr`An optional identifier of the widget we can use to refer to it in queries.
`visiblebool`This property holds whether the widget is visible.
`visibleMinfloat`If the current zoom factor and DPI is less than this value, the widget is not visible.
`visibleMaxfloat`If the current zoom factor and DPI is bigger than this value, the widget is not visible.
`tooltipstr`Set a basic tooltip for the widget, this will simply be a Label, it will follow the Tooltip style
`tooltip_fnCallable`Set dynamic tooltip that will be created dynamiclly the first time it is needed. the function is called inside a ui.Frame scope that the widget will be parented correctly.
`tooltip_offset_xfloat`Set the X tooltip offset in points. In a normal state, the tooltip position is linked to the mouse position. If the tooltip offset is non zero, the top left corner of the tooltip is linked to the top left corner of the widget, and this property defines the relative position the tooltip should be shown.
`tooltip_offset_yfloat`Set the Y tooltip offset in points. In a normal state, the tooltip position is linked to the mouse position. If the tooltip offset is non zero, the top left corner of the tooltip is linked to the top left corner of the widget, and this property defines the relative position the tooltip should be shown.
`enabledbool`This property holds whether the widget is enabled. In general an enabled widget handles keyboard and mouse events; a disabled widget does not. And widgets display themselves differently when they are disabled.
`selectedbool`This property holds a flag that specifies the widget has to use eSelected state of the style.
`checkedbool`This property holds a flag that specifies the widget has to use eChecked state of the style. It’s on the Widget level because the button can have sub-widgets that are also should be checked.
`draggingbool`This property holds if the widget is being dragged.
`opaque_for_mouse_eventsbool`If the widgets has callback functions it will by default not capture the events if it is the top most widget and setup this option to true, so they don’t get routed to the child widgets either
`skip_draw_when_clippedbool`The flag that specifies if it’s necessary to bypass the whole draw cycle if the bounding box is clipped with a scrolling frame. It’s needed to avoid the limitation of 65535 primitives in a single draw list.
`mouse_moved_fnCallable`Sets the function that will be called when the user moves the mouse inside the widget. Mouse move events only occur if a mouse button is pressed while the mouse is being moved. void onMouseMoved(float x, float y, int32_t modifier)
`mouse_pressed_fnCallable`Sets the function that will be called when the user presses the mouse button inside the widget. The function should be like this: void onMousePressed(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier) Where ‘button’ is the number of the mouse button pressed. ‘modifier’ is the flag for the keyboard modifier key.
`mouse_released_fnCallable`Sets the function that will be called when the user releases the mouse button if this button was pressed inside the widget. void onMouseReleased(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)
`mouse_double_clicked_fnCallable`Sets the function that will be called when the user presses the mouse button twice inside the widget. The function specification is the same as in setMousePressedFn. void onMouseDoubleClicked(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)
`mouse_wheel_fnCallable`Sets the function that will be called when the user uses mouse wheel on the focused window. The function specification is the same as in setMousePressedFn. void onMouseWheel(float x, float y, carb::input::KeyboardModifierFlags modifier)
`mouse_hovered_fnCallable`Sets the function that will be called when the user use mouse enter/leave on the focused window. function specification is the same as in setMouseHovedFn. void onMouseHovered(bool hovered)
`drag_fnCallable`Specify that this Widget is draggable, and set the callback that is attached to the drag operation.
`accept_drop_fnCallable`Specify that this Widget can accept specific drops and set the callback that is called to check if the drop can be accepted.
`drop_fnCallable`Specify that this Widget accepts drops and set the callback to the drop operation.
`computed_content_size_changed_fnCallable`Called when the size of the widget is changed.
© Copyright 2019-2024, NVIDIA.
Last updated on Mar 25, 2024. |
pxr_index.md | API (pxr) — kit-manual 105.1 documentation
kit-manual
»
API (pxr)
# API (pxr)
© Copyright 2019-2023, NVIDIA.
Last updated on Nov 14, 2023. |
omni.ui.Container.md | Container — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
Container
# Container
class omni.ui.Container
Bases: Widget
Base class for all UI containers. Container can hold one or many other omni.ui.Widget s
Methods
__init__(*args, **kwargs)
add_child(self, arg0)
Adds widget to this container in a manner specific to the container.
clear(self)
Removes the container items from the container.
Attributes
__init__(*args, **kwargs)
add_child(self: omni.ui._ui.Container, arg0: omni.ui._ui.Widget) → None
Adds widget to this container in a manner specific to the container. If it’s allowed to have one sub-widget only, it will be overwriten.
clear(self: omni.ui._ui.Container) → None
Removes the container items from the container.
© Copyright 2019-2024, NVIDIA.
Last updated on Mar 25, 2024. |
omni.ui.AbstractItem.md | AbstractItem — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
AbstractItem
# AbstractItem
class omni.ui.AbstractItem
Bases: pybind11_object
The object that is associated with the data entity of the AbstractItemModel.
Methods
__init__(self)
__init__(self: omni.ui._ui.AbstractItem) → None
© Copyright 2019-2024, NVIDIA.
Last updated on Mar 25, 2024. |
python_scripting.md | Scripting — kit-manual 105.1 documentation
kit-manual
»
Scripting
# Scripting
## Overview
Kit Core comes with a python interpreter and a scripting system. It is mainly used to write extensions in python, but it can also be used to make simple python scripts. Each extension can register a set of script search folders. Scripts can be run via command line or API.
## How to add a script folder
Multiple ways:
Use the /app/python/scriptFolders setting. As with any setting it can be changed in the core config, in the app config, via the command line or at runtime using settings API.
Use IAppScripting API, e.g. carb::getCachedInterface<omni::kit::IApp>()->getPythonScripting()->addSearchScriptFolder("myfolder").
Specify in the extension.toml, in the [[python.scriptFolder]] section:
[[python.scriptFolder]]
path = "scripts"
## How to run a script
Command line:
Example: > kit.exe --exec "some_script.py arg1 arg2" --exec "open_stage"
Settings:
Example: > kit.exe --app/exec/0="some_script.py arg1"
API:
C++ Example: carb::getCachedInterface<omni::kit::IApp>()->getPythonScripting()->executeFile("script.py")
Python Example: omni.kit.app.get_app_interface().get_python_scripting().execute_file("script.py") see (omni.kit.app.IAppScripting.execute_file()) for more details.
Note
The script extension (.py) can be omitted.
© Copyright 2019-2023, NVIDIA.
Last updated on Nov 14, 2023. |
Subsets and Splits