Datasets:

pe-nlp
/

ov-kit-doc-files-filter

Dataset card Viewer Files Files and versions Community

Split (1)

train · 3.27k rows

file_path stringlengths 5 148	content stringlengths 0 526k
carb.tokens.Classes.md	# carb.tokens Classes ## Classes Summary - [ITokens](./carb.tokens/carb.tokens.ITokens.html)
carb.tokens.Functions.md	# carb.tokens Functions ## Functions Summary: - get_tokens_interface - Returns cached :class:`carb.tokens.ITokens` interface - acquire_tokens_interface - acquire_tokens_interface(plugin_name: str = None, library_path: str = None) -> carb.tokens._tokens.ITokens
carb.tokens.get_tokens_interface.md	# get_tokens_interface  ## get_tokens_interface  ### carb.tokens.get_tokens_interface  #### Returns - `ITokens`: [carb.tokens.ITokens](carb.tokens.ITokens.html#carb.tokens.ITokens) #### Description Returns cached `carb.tokens.ITokens` interface
carb.tokens.ITokens.md	# ITokens ## ITokens ``` class carb.tokens.ITokens ``` Bases: ``` pybind11_object ``` Methods: \| Method \| Description \| \|--------\|-------------\| \| `__init__(args, kwargs)` \| \| \| `exists(self, arg0)` \| \| \| `remove_token(self, arg0)` \| \| \| `resolve(self, str[, flags])` \| \| \| `set_initial_value(self, arg0, arg1)` \| \| \| `set_value(self, arg0, arg1)` \| \| ``` ## __init__(args, **kwargs) ## exists(self, arg0) ## remove_token(self, arg0) ## resolve(self, str[, flags]) ## set_initial_value(self, arg0, arg1) ## set_value(self, arg0, arg1) ### __init__(kwargs) ### exists(self: carb.tokens._tokens.ITokens, arg0: str) -> bool ### remove_token(self: carb.tokens._tokens.ITokens, arg0: str) -> bool ### resolve(self: carb.tokens._tokens.ITokens, arg0: str, flags: int = 0) -> str ### set_initial_value(self: carb.tokens._tokens.ITokens, arg0: str, arg1: str) -> None ## 方法定义 ### set_value
carb.tokens.md	# carb.tokens ## Classes Summary - [ITokens](./carb.tokens.Classes.html) ## Functions Summary - [get_tokens_interface](carb.tokens/carb.tokens.get_tokens_interface.html) - Returns cached :class:`carb.tokens.ITokens` interface - [acquire_tokens_interface](carb.tokens/carb.tokens.acquire_tokens_interface.html) - acquire_tokens_interface(plugin_name: str = None, library_path: str = None) -> carb.tokens._tokens.ITokens
CarboniteInterfaces.md	# Creating a New Carbonite Interface ## Overview Carbonite interfaces are simple yet powerful when used appropriately. There are a few considerations to be made when choosing to make a Carbonite interface versus an ONI one. Carbonite interfaces are best used in situations where global data or state can be used or when an object hierarchy is not necessary. Using a Carbonite interface for these projects can simplify the workflow, but also has some drawbacks and restrictions. Some benefits of Carbonite interfaces are: - Interfaces are simple and can be more efficient to call into. There does not need to be an API wrapper layer in the interface and there are not as many restrictions on what can be passed to functions. - Interfaces are quick and easy to implement. A new plugin for a Carbonite interface can be created in a matter of minutes. - They match better to some usage cases. Some of the main drawbacks with Carbonite interfaces are: - Interfaces are not reference counted. Since a Carbonite interface is nothing more than a v-table containing function pointers, every caller that attempts to acquire a given interface will receive the same object. However, plugins can create reference-counted objects, such as `carb.events.plugin`. - Interfaces cannot have data associated with them. Contextual object information returned from a Carbonite interface must go through opaque pointers that then get passed back to other functions in the interface to operate on. This often ends up making the interface flat and monolithic instead of hierarchical. - ABI safety and backward compatibility between interface versions is difficult to maintain without close attention to detail when making changes. It is easy to break compatibility with previous versions of an interface without necessarily realizing it. This was one of the main motivations for creating ONI and its toolchain. - Historically, a given Carbonite plugin may only implement a single version of any given interface. While a plugin may export multiple versions of an interface now, earlier plugins may only support the latest interface version. In this guide we’ll make an interface called `carb::stats::IStats` to collect and aggregate simple statistical values. ## Project Definitions The first step in creating a new Carbonite interface (and a plugin for it) is to add a project new definition to the `premake5.lua` script: ```lua project "example.carb.stats.plugin" define_plugin { ifaces = "source/examples/example.stats/include/carb/stats", impl = "source/examples/example.stats/plugins/carb.stats" } defines { "carb_stats_IStats=carb_stats_IStats_latest" } dependson { "carb" } includedirs { "source/examples/example.stats/include" } filter { "system:linux" } buildoptions { "-pthread" } links { "dl", "pthread" } filter {} ``` This adds a new plugin project called `example.carb.stats.plugin`. example.carb.stats.plugin . When built, this will produce a dynamic library such as example.carb.stats.plugin.dll (on Windows). The plugin is set to implement some or all of the interfaces in the source/examples/example.stats/include/carb/stats/ folder (link) with its implementation files in source/examples/example.stats/plugins/carb.stats/ (link). Note the line ``` defines { "carb_stats_IStats=carb_stats_IStats_latest" } ``` for this plugin definition. This ensures that building the plugin always uses the latest version of the IStats interface. A similar line will need to be specified for each interface that the plugin exports. See below for further explanation. Example implementation files: - Interface - examples/example.stats/include/carb/stats/IStats.h - Plugin - examples/example.stats/plugins/carb.stats/Stats.h - examples/example.stats/plugins/carb.stats/Stats.cpp - examples/example.stats/plugins/carb.stats/Interfaces.cpp - Sample App - examples/example.stats/example.stats/main.cpp ## Define the Interface API The next step is to create the interface’s main header. According to the coding standard for Carbonite, this should be located in a directory structure that matches the namespace that will be used (ie: include/carb/stats/ in this case). The interface’s header file itself should have the same name as the interface (ie: IStats.h here). The bare minimum requirements for declaring an interface are that the carb/Interface.h header be included, a `#pragma once` guard is used, and at least one struct containing a call to the CARB_PLUGIN_INTERFACE or CARB_PLUGIN_INTERFACE_EX macro be made. It is recommended to prefer CARB_PLUGIN_INTERFACE_EX for new interfaces, and to switch existing interfaces to this method when they need to change. The first step is to define the latest and default versions near the top of the file: ```c++ //! Latest IStats interface version #define carb_stats_IStats_latest CARB_HEXVERSION(1, 1) #ifndef carb_stats_IStats //! The current default IStats interface version # define carb_stats_IStats CARB_HEXVERSION(1, 0) #endif ``` In this example, the latest version of the API available is 1.1 but by default consumers will use the default version: 1.0. These macros also correspond to the `defines` line from premake5.lua above, where the module always overrides the version to be the latest version. Any requirements for the interface (ie: enums, parameter structs, constants, etc) should be declared either before the interface’s struct or in another header that is included at the top of the file. Now the interface itself can be declared: ```c++ /** * (Example--not a real interface) * * A simple global table of statistics that can be maintained and aggregated. Statistics * can be added and removed as needed and new values can be aggregated into existing * statistics. Each statistic's current value can then be retrieved at a later time for * display or analysis. / struct IStats { CARB_PLUGIN_INTERFACE_EX("carb::stats::IStats", carb_stats_IStats_latest, carb_stats_IStats) /* Adds a new statistic value to the table. * * @param[in] desc The descriptor of the new statistic value to add. ``` * @returns An identifier for the newly created statistic value if it is successfully added. * If this statistic is no longer needed, it can be removed from the table with removeStat(). * @retval kBadStatId if the new statistic could not be added or an error occurred. * * @thread_safety This operation is thread safe. * StatId addStat(const StatDesc& desc); * Removes an existing statistic value from the table. * * @param[in] stat The identifier of the statistic to be removed. This identifier is acquired from the call to addStat() that originally added it to the table. * @returns `true` if the statistic is successfully removed from the table. * @returns `false` if the statistic could not be removed or an error occurred. * * @thread_safety This operation is thread safe. * bool removeStat(StatId stat); * Adds a new value to be accumulated into a given statistic. * * @param[in] stat The identifier of the statistic to be removed. This identifier is acquired from the call to addStat() that originally added it to the table. * @param[in] value The new value to accumulate into the statistic. It is the caller's responsibility to ensure this new value is appropriate for the given statistic. The new value will be accumulated according to the accumulation method chosen when the statistic was first created. * @returns `true` if the new value was successfully accumulated into the given statistic. * @returns `false` if the new value could not be accumulated into the given statistic or the given statistic could not be found. * * @thread_safety This operation is thread safe. * bool addValue(StatId stat, const Value& value); * Retrieves the current accumulated value for a given statistic. * * @param[in] stat The identifier of the statistic to be removed. This identifier is acquired from the call to addStat() that originally added it to the table. * @param[out] value Receives the new value and information for the given statistic. Note that the string values in this returned object will only be valid until the statistic object is removed. It is the caller's responsibility to ensure the string is either copied as needed or to guarantee the statistic will not be removed while its value is being used. * @returns `true` if the statistic's current value is successfully retrieved. * @returns `false` if the statistic's value could not be retrieved or the statistic identifier was not valid. * * @thread_safety It is the caller's responsibility to ensure the given statistic is not removed while the returned value's strings are being used. Aside from that, this operation is thread safe. * bool getValue(StatId stat, StatDesc& value); #if CARB_VERSION_ATLEAST(carb_stats_IStats, 1, 1) * Retrieves the total number of statistics in the table. * * @returns The total number of statistics currently in the table. This value can change at any time if a statistic is removed from the table by another thread. * * @thread_safety Retrieving this value is thread safe. However, the actual size of the table may change at any time if another thread modifies it. * size_t getCount(); #endif # Interface Design Considerations For more information on how to best design your interface, stick to our coding standard, and avoid various pitfalls. # Add an Implementation for the Interface A Carbonite interface may have multiple implementations. Typically these are done so that each implementation handles a specific type of data (e.g., `carb.dictionary.serializer-json.plugin` versus `carb.dictionary.serializer-toml.plugin`) or each implementation provides functionality from a different backend library (e.g., `carb.profiler-cpu.plugin` versus `carb.profiler-tracy.plugin` versus `carb.profiler-nvtx.plugin`). By convention, the backend provider or data handling context is reflected in the plugin’s name itself. ## Source files A simple interface like `carb::stats::IStats` could theoretically be implemented in a single source file. However, for example purposes here, we’ll split it up into multiple files as though it was a more complex interface. The following files will be used here: - source/examples/example.stats/plugins/carb.stats/Stats.h: A common internal header file for the implementation of the plugin. This should contain any functional definitions needed to implement the interface. This file is relatively straightforward and can simply be examined. - source/examples/example.stats/plugins/carb.stats/Stats.cpp: The actual implementation of the `carb::stats::IStats` interface as a C++ class. This class implementation is relatively straightforward and can simply be examined. - source/examples/example.stats/plugins/carb.stats/Interfaces.cpp: The definition of the Carbonite interface itself. This file typically acts as the point where all interfaces in the plugin are exposed to the Carbonite framework. This file includes the simple C wrapper functions used to call through to the C++ implementation class. ## Boilerplate Code Generation The plugin’s information and interface description must be exported. This is typically done by a macro. But first, an interface-design-considerations-label must be made if your plugin is going to support multiple versions or not. It is highly recommended to support multiple versions. ### Multiple Interface Versions All of the interfaces exported by the plugin must be listed in the `CARB_PLUGIN_IMPL_EX` macro. This will generate exported functions that the Carbonite Framework expects when it loads the plugin. See `CARB_PLUGIN_IMPL_EX` for more information. The macro expects as its first parameter a `carb::PluginImplDesc` – a descriptor for the plugin. For each interface exported by the plugin, a `template<class T> bool fillInterface(carb::Version, void)` explicit template specialization must be provided. The framework will call this with a `carb::Version` to construct the interface of that version. If the plugin cannot construct the version, it may return `false` to indicate to the Framework that the version is not supported. ```c++ /// Define the descriptor for this plugin. This gives the plugin's name, a human readable /// description of it, the creator/implementor, and whether 'hot' reloading is supported /// (though that is a largely deprecated feature now and only works properly for a small /// selection of interfaces). const struct carb::PluginImplDesc kPluginImpl = { "example.carb.stats.plugin", "Example Carbonite Plugin", "NVIDIA", carb::PluginHotReload::eDisabled, "dev" }; /// Define all of the interfaces that are implemented in this plugin. If more than one /// interface is implemented, a comma separated list of each [fully qualified] plugin /// interface name should be given as additional arguments to the macro. For example, ``` ```c++ /// `CARB_PLUGIN_IMPL_EX(kPluginImpl, carb::stats::IStats, carb::stats::IStatsUtils)`. CARB_PLUGIN_IMPL_EX(kPluginImpl, carb::stats::IStats) /** Main interface filling function for IStats. * * @remarks This function is necessary to fulfill the needs of the CARB_PLUGIN_IMPL_EX() macro * used above. Since the IStats interface was listed in that call, a matching * fillInterface() for it must be implemented as well. This fills in the vtable * for the IStats interface for use by callers who try to acquire that interface. / template <> bool fillInterface<carb::stats::IStats>(carb::Version v, void* iface) { using namespace carb::stats; switch (v->major) { case IStats::getLatestInterfaceDesc().version.major: v = IStats::getLatestInterfaceDesc().version; static_cast<IStats>(iface) = { addStat, removeStat, addValue, getValue, getCount }; return true; default: return false; } } ``` ## Single Interface Version Historically, Carbonite plugins could only support semantic versions for one major* version. This method is still supported but not recommended. However, it may be ideal to create the first version with this simpler method and transition to Multiple Version support when the version changes to a new major version. All of the interfaces exported by the plugin must be listed in the `CARB_PLUGIN_IMPL` macro. This will generate exported functions that the Carbonite Framework expects when it loads the plugin. See `CARB_PLUGIN_IMPL` for more information. The macro expects as its first parameter a `carb::PluginImplDesc` –a descriptor for the plugin. For each interface exported by the plugin, a `void fillInterface(InterfaceType&)` function must be provided (where `InterfaceType` is the interface type exported by the plugin). ```c++ /// Define the descriptor for this plugin. This gives the plugin's name, a human readable /// description of it, the creator/implementor, and whether 'hot' reloading is supported /// (though that is a largely deprecated feature now and only works properly for a small /// selection of interfaces). const struct carb::PluginImplDesc kPluginImpl = { "example.carb.stats.plugin", "Example Carbonite Plugin", "NVIDIA", carb::PluginHotReload::eDisabled, "dev" }; /// Define all of the interfaces that are implemented in this plugin. If more than one /// interface is implemented, a comma separated list of each [fully qualified] plugin /// interface name should be given as additional arguments to the macro. For example, /// `CARB_PLUGIN_IMPL_EX(kPluginImpl, carb::stats::IStats, carb::stats::IStatsUtils)`. CARB_PLUGIN_IMPL(kPluginImpl, carb::stats::IStats) ```c++ /** Main interface filling function for IStats. * * @remarks This function is necessary to fulfill the needs of the CARB_PLUGIN_IMPL() macro * used above. Since the IStats interface was listed in that call, a matching * fillInterface() for it must be implemented as well. This fills in the vtable * for the IStats interface for use by callers who try to acquire that interface. / void fillInterface(carb::stats::IStats& iface) { using namespace carb::stats; iface = { addStat, removeStat, addValue, getValue, getCount }; } ``` ## Dependencies Plugins declare their dependencies with the `CARB_PLUGIN_IMPL_DEPS` macro. This is a list of interfaces required* by this plugin. If the Framework is unable to provide these dependencies, your plugin will not load. For dependencies declared in this way, your plugin is free to use `carb::Framework::acquireInterface()` to acquire the interface. It is recommended that your plugin limit dependencies, and instead attempt to acquire interfaces using `carb::Framework::tryAcquireInterface()` which allows them to fail. Your plugin would need to then handle the situation where the other interface is not found. Keep in mind that dependencies are at the plugin level, not the interface level. If your plugin changes to add a dependency, this may break backwards compatibility. If your plugin has no dependencies, you can optionally state this explicitly with `CARB_PLUGIN_IMPL_NO_DEPS` : ```c++ /// Mark that this plugin is not dependent on any other interfaces being available. CARB_PLUGIN_IMPL_NO_DEPS() ``` ## Exported Callback Functions It is generally recommended to include `carbOnPluginStartup()` (or `carbOnPluginStartupEx()` if startup may fail) and `carbOnPluginShutdown()` functions, but these are not required. > Warning > It is very important that no Carbonite functionality (logging, Framework, profiling, etc.) is used prior to when the Framework calls the `carbOnPluginStartup()` function at plugin initialization time! This includes but is not limited to static initializers! Prior to this function call, the plugin pointers (such as `g_carbFramework` or `g_carbLogging`) have not been initialized. See the [Framework Overview](carb/Framework.html#carb-framework) section on [finding plugins](carb/Framework.html#finding-plugins) for a full list of callback functions that the Framework looks for in a plugin. ```c++ CARB_EXPORT void carbOnPluginStartup() { /// Do any necessary global scope plugin initialization here. In this case nothing needs /// to be done! } CARB_EXPORT void carbOnPluginShutdown() { /// Do any necessary global scope plugin shutdown tasks here. In this case nothing needs /// to be done! } Much of this example app is specific to the `carb::stats::IStats` interface itself. The only parts that really need some explanation are: - CARB_GLOBALS must be called at the global scope. This adds all of the global variables needed by the Carbonite framework to the host app. This will include symbols to support functionality such as logging, structured logging, assertions, profiling, and localization. This must be called in exactly one spot in the host app. ```cpp /// This macro call must be made at the global namespace level to add all of the Carbonite /// Framework's global symbols to the executable. This only needs to be used in host apps /// and should only be called once in the entire module. The specific name given here is /// intended to name the host app itself for use in logging output from the Carbonite /// framework. CARB_GLOBALS("example.stats"); ``` - Before the interface can be used, it must be acquired by the host app. This can be done in one of many ways with the Carbonite framework. The commonly suggested method is to use the `carb::getCachedInterface()` helper functions. These will be the quickest way to find and acquire an interface pointer since the result will be cached internally once found. If the framework unloads the plugin that a cached interface came from, it will automatically be reacquired on the next call to `carb::getCachedInterface()`. The particular usage of each interface differs. Please see each interface’s documentation for usage specifics. - Once the interface pointer has been successfully acquired, it may be used by the host app until the framework is shut down. If a particular implementation of an interface is needed and multiple are loaded, the default behavior is to acquire the ‘best’ version of the interface. This often comes down to the one with the highest version number. - If a specific version of an interface is required (ie: from a specific plugin), the interface could be acquired either using `carb::Framework::acquireInterface()` directly or using the second template parameter to the `carb::getCachedInterface()` template to specify the plugin name. This allows a plugin name or a specific version number to be passed in. ```cpp OMNI_CORE_INIT(argc, argv); stats = carb::getCachedInterface<carb::stats::IStats>(); if (stats == nullptr) { fputs("ERROR-> failed to acquire the IStats interface.\n", stderr); return EXIT_FAILURE; } ``` - Add a config file for the example app. This lets the Carbonite framework know which plugins it should try to find and load automatically and which default configuration options to use. This is specified in the TOML format. The only portion of it that is strictly important is the `pluginsLoaded=` list. In order for this config file to be picked up automatically, it must have the same base name as the built application target (ie: “example.stats” in this case) with the “.config.toml” extension and must be located in the same directory as the executable file. ```toml # Specify the list of plugins that this example app depends on and should be found and # loaded by the Carbonite framework during startup. pluginsLoaded = [ "example.carb.stats.plugin", ] ``` ## Building and Running the Example App Building the example app is as easy as running `build.bat` (Windows) or `build.sh` (Linux). Alternatively, it can be built directly from within either VS Code (Linux or Windows) or MSVC (Windows). The example app builds to the location _build/<platform>/<configuration>/example.stats<exe_extension>. This example app doesn’t require any arguments and can be run in one of many ways: - Directly on command line or in a window manager such as Explorer (Windows) or Nautilus (Ubuntu). - in MSVC on Windows by setting `examples/example.stats` as the startup app in the Solution Explorer window (right click on the project name and choose “Set As Startup Project”), then running (“Debug” menu -> “Start Debugging” or “Debug” menu -> “Start Without Debugging”). - Under VS Code on either Windows or Linux by selecting the `example.stats` launch profile for your current system. Running the example app under the debugger and stepping through some of the code may be the most instructional way to figure out how different parts of the app and the example plugin work. ## Interface Design Considerations A keen observer may have noticed some weaknesses in the design of the `carb::stats::IStats` API. These could be overcome with some redesign of the interface or at least some more care in the implementation of the interface. Some things that could use improvements: - Only `ABI safe` types may be used in the arguments to Carbonite interface functions. These rules should be followed as a list of what types are and are not allowed: - The language primitives (ie: `int`, `long`, `float`, `char`, etc.) and pointers or references to the primitive types are always allowed. - Locally defined structs, classes and enums, pointers or references to locally defined types, or enums are always allowed. Structs and classes must contain only ABI-safe types and use standard layout (`std::is_standard_layout<>::value` must be true). - Carbonite types which declare themselves ABI-safe such as `omni::string` and `carb::RString` are always allowed. - Variadic arguments are allowed, but only ABI-safe types must be passed through them. - C++ class objects should never be passed into an interface function. They may be returned from one as an opaque pointer as long as the only way to operate on it is for the caller to pass it back into another interface function. - No Carbonite class types should be passed into or returned from interface functions except for the ones that are explicitly marked as being ABI safe such as `omni::string` or `carb::RString`. - If an ABI unsafe type (ie: STL container) is to be used, its use must be entirely restricted to inlined code in the header. The object itself (or anything containing it) should never be passed into or returned from an interface function. - No Carbonite interface function or any struct passed to it should ever use an ABI unsafe type such as an STL object, or anything from a third party library. Any types or enums from third party libraries should be abstracted out with locally defined Carbonite types. - Instead of using the `carb::stats::Value` struct, a `carb::variant::Variant` could be used. This would allow for a wider variety of data types and give an easier way to specify both the data’s type and its value. - The `carb::stats::IStats::getValue` function has some thread safety (and general usability) concerns. The name and description strings it returns in the output parameter could be invalidated at any time if another thread (or even the same calling thread later on) removes that particular statistic from the table while it’s still being used. This puts an undue requirement for managing all access to the statistics table on the host app. This could be improved in one of the following ways: - Change the strings to be `omni::string` objects instead. This would allow for an ABI safe way of both retrieving and storing the strings for the host app. One consideration would be that the memory may need to be allocated and the strings copied on each access. - Change the object stored internally in the table to be reference counted. This would prevent the strings from being de-allocated before any caller was done with accessing it. The down side would be that the caller would then be required to release the value object each time it was finished with it. - Change the string storage to be in a table that persists for the lifetime of the plugin (or use carb::RString which essentially does the same thing), but at process scope. This would make the retrieved strings safe to access at any point, but could also lead to the table growing in an unmaintainable way with certain usage patterns. - If an interface function needs to return a state object to be operated on by other interface functions, it must do so by using an opaque pointer to the object. The caller may not be allowed to directly inspect or operate on the returned object. Only other functions in the same interface or another cooperative interface in the same plugin may know how to access and manipulate the object. If two plugins both offer the same interface, it is undefined behavior to pass a state object created by one plugin’s interface to the other plugin’s interface, unless this is explicitly allowed. Likewise, when a plugin supports multiple versions of an interface it is undefined behavior to pass a state object created by one version of the interface to a different version of that same interface, unless explicitly allowed. Documentation on an interface is always very important. This is how other developers will discover and figure out how to use your shiny new interface. All public headers should be fully documented: - The ideal documentation is such that any possible questions about a given function or object’s usage has at least been touched on. - All function documentation should mention any thread safety concerns there may be to calling it, all parameters and return values must be documented. - All interfaces should have overview documentation that covers what it does and roughly how it is intended to be used. - All API documentation should be in the Doxygen format. - No matter how straightforward it is, code _never_ documents itself. ## Expanding the Interface Later Once an interface has been released into the wild and has been used in several places, it becomes more likely that users will request bug fixes, improvements, or changes to the functionality. When doing so, there are a few guidelines to follow to ensure old software doesn’t break if it hasn’t updated to the latest version of the interface’s plugin yet: - When adding new functions to the interface, always add to the end of the struct. Software that is still expecting to use an older version of the interface will still work with the newer versions as long as it hasn’t broken the existing ABI at the start of the struct. If a new function is added in the middle of the struct or an existing function is removed, all functions in the interface will be shifted up or down in the v-table of any software expecting to an older version of the interface. - Never change parameters or return values on any existing functions in a released interface when making changes to it. This could cause code build for an older version of the interface to behave erratically or incorrectly when calling into those interface functions. Instead, add a new version of the function with the different parameters or return values at the end of the interface struct. - When making any change to an interface, its version numbers should be bumped. A minor change that doesn’t break backward compatibility with older versions should simply increment the minor version number. If a change needs to occur that may break older software including deprecating some functions, the major version should be incremented and the minor version reset to zero. If this is the case, consider continuing to support the old version in template<class T> bool fillInterface(carb::Version, void).
carbonite_api.md	# Carbonite SDK API ## Directory hierarchy - dir - carb - carb/assert - AssertUtils.h - IAssert.h - carb/assets - AssetsTypes.h - AssetsUtils.h ### carb/assets - file carb/assets/AssetsUtils.h - file carb/assets/IAssets.h - file carb/assets/IAssetsBlob.h ### carb/audio - file carb/audio/AudioStreamerUtils.h - file carb/audio/AudioTypes.h - file carb/audio/AudioUtils.h - file carb/audio/IAudioCapture.h - file carb/audio/IAudioData.h - file carb/audio/IAudioDevice.h - file carb/audio/IAudioGroup.h - file carb/audio/IAudioPlayback.h - file carb/audio/IAudioUtils.h ### carb/clock - file carb/clock/TscClock.h ### carb/container - file carb/container/BufferedObject.h - file carb/container/BufferedObject.h - file carb/container/IntrusiveList.h - file carb/container/IntrusiveUnorderedMultimap.h - file carb/container/LocklessQueue.h - file carb/container/LocklessStack.h - file carb/container/RHUnorderedMap.h - file carb/container/RHUnorderedMultimap.h - file carb/container/RHUnorderedMultiset.h - file carb/container/RHUnorderedSet.h - file carb/container/RobinHoodImpl.h ### dir carb/cpp - dir carb/cpp/detail - file carb/cpp/detail/AtomicOps.h - file carb/cpp/detail/ImplData.h - file carb/cpp/detail/ImplDummy.h - file carb/cpp/Barrier.h - file carb/cpp/Bit.h - file carb/cpp/Functional.h - file carb/cpp/Latch.h - file carb/cpp/Memory.h - file carb/cpp/Numeric.h - file carb/cpp/Semaphore.h - file carb/cpp/Span.h - file carb/cpp/StdDef.h - file carb/cpp/StringView.h - file carb/cpp/TypeTraits.h - dir carb/cpp17 - file carb/cpp17/Exception.h - file carb/cpp17/Functional.h - file carb/cpp17/Memory.h - file carb/cpp17/Optional.h - file carb/cpp17/StdDef.h - file carb/cpp17/StringView.h - file carb/cpp17/Tuple.h - file carb/cpp17/TypeTraits.h - file carb/cpp17/Utility.h - file carb/cpp17/Variant.h - dir carb/cpp20 - file carb/cpp20/Atomic.h - file carb/cpp20/Atomic.h - file carb/cpp20/Barrier.h - file carb/cpp20/Bit.h - file carb/cpp20/Latch.h - file carb/cpp20/Memory.h - file carb/cpp20/Semaphore.h - file carb/cpp20/Span.h - file carb/cpp20/TypeTraits.h ### dir carb/crashreporter - file carb/crashreporter/CrashReporterUtils.h - file carb/crashreporter/ICrashReporter.h ### dir carb/delegate #### dir carb/delegate/detail - file carb/delegate/detail/DelegateBase.h - file carb/delegate/Delegate.h ### dir carb/detail <details> <summary>file</summary> <div class="rebreather hierarchy docutils container"> <ul> <li> <p>carb/detail/DeferredLoad.h</p> </li> <li> <p>carb/detail/NoexceptType.h</p> </li> <li> <p>carb/detail/PopBadMacros.h</p> </li> <li> <p>carb/detail/PushBadMacros.h</p> </li> <li> <p>carb/detail/TSan.h</p> </li> </ul> </div> </details> <details> <summary>dir carb/dictionary</summary> <div class="rebreather hierarchy docutils container"> <ul> <li> <p>carb/dictionary/DictionaryUtils.h</p> </li> <li> <p>carb/dictionary/IDictionary.h</p> </li> <li> <p>carb/dictionary/ISerializer.h</p> </li> </ul> </div> </details> <details> <summary>dir carb/eventdispatcher</summary> <div class="rebreather hierarchy docutils container"> <ul> <li> <p>carb/eventdispatcher/EventDispatcherTypes.h</p> </li> <li> <p>carb/eventdispatcher/IEventDispatcher.h</p> </li> </ul> </div> </details> <details> <summary>dir carb/events</summary> <div class="rebreather hierarchy docutils container"> <ul> <li> <p>carb/events/Event.h</p> </li> <li> <p>carb/events/EventDispatcher.h</p> </li> <li> <p>carb/events/EventTypes.h</p> </li> </ul> </div> </details> - carb/events/EventsUtils.h - carb/events/IEvents.h ### dir carb/extras - carb/extras/Base64.h - carb/extras/CpuInfo.h - carb/extras/Debugging.h - carb/extras/EnvironmentVariable.h - carb/extras/EnvironmentVariableParser.h - carb/extras/Errors.h - carb/extras/HandleDatabase.h - carb/extras/Library.h - carb/extras/MemoryUsage.h - carb/extras/Options.h - carb/extras/Path.h - carb/extras/SharedMemory.h - carb/extras/StringSafe.h - carb/extras/TestEnvironment.h - carb/extras/Tokens.h - carb/extras/Utf8Parser.h - carb/extras/Uuid.h - carb/extras/VariableSetup.h - carb/extras/WindowsPath.h ### dir - carb/filesystem #### Files - file carb/filesystem/FindFiles.h - file carb/filesystem/IFileSystem.h ### dir - carb/input #### Files - file carb/input/IInput.h - file carb/input/InputProvider.h - file carb/input/InputTypes.h - file carb/input/InputUtils.h ### dir - carb/l10n #### Files - file carb/l10n/IL10n.h - file carb/l10n/L10nUtils.h ### dir - carb/launcher #### Files - file carb/launcher/ILauncher.h - file carb/launcher/LauncherUtils.h ### carb/launcher - file carb/launcher/LauncherUtils.h ### carb/logging - file carb/logging/ILogging.h - file carb/logging/Log.h - file carb/logging/Logger.h - file carb/logging/LoggingTypes.h - file carb/logging/LoggingUtils.h - file carb/logging/StandardLogger.h - file carb/logging/StandardLogger2.h ### carb/math - file carb/math/Util.h ### carb/memory - file carb/memory/ArenaAllocator.h - file carb/memory/Util.h ### carb/process ### dir - carb/profiler - carb/settings - carb/simplegui - carb/tasking ### dir - carb/profiler - carb/profiler/IProfileMonitor.h - carb/profiler/IProfiler.h - carb/profiler/Profile.h - carb/profiler/ProfilerUtils.h ### dir - carb/settings - carb/settings/ISettings.h - carb/settings/SettingsUtils.h ### dir - carb/simplegui - carb/simplegui/ISimpleGui.h - carb/simplegui/SimpleGuiTypes.h ### dir - carb/tasking ### Files - carb/tasking/Delegate.h - carb/tasking/IFiberEvents.h - carb/tasking/ITasking.h - carb/tasking/IThreadPool.h - carb/tasking/TaskingHelpers.h - carb/tasking/TaskingTypes.h - carb/tasking/TaskingUtils.h - carb/tasking/ThreadPoolUtils.h ### Directory - carb/thread - carb/thread/detail - carb/thread/detail/FutexImpl.h - carb/thread/detail/LowLevelLock.h - carb/thread/detail/NativeFutex.h - carb/thread/detail/ParkingLot.h - carb/thread/Futex.h - carb/thread/IThreadUtil.h - carb/thread/Mutex.h - carb/thread/RecursiveSharedMutex.h - file carb/thread/RecursiveSharedMutex.h - file carb/thread/SharedMutex.h - file carb/thread/Spinlock.h - file carb/thread/ThreadLocal.h - file carb/thread/Util.h ### dir carb/time - file carb/time/TscClock.h - file carb/time/Util.h ### dir carb/tokens - file carb/tokens/ITokens.h - file carb/tokens/TokensUtils.h ### dir carb/variant - file carb/variant/IVariant.h - file carb/variant/VariantTypes.h - file carb/variant/VariantUtils.h - file carb/BindingsPythonTypes.h - file carb/BindingsUtils.h - file carb/BindingsUtils.h - file carb/CarbWindows.h - file carb/ClientUtils.h - file carb/Defines.h - file carb/Error.h - file carb/FindPlugins.h - file carb/Framework.h - file carb/IObject.h - file carb/Interface.h - file carb/InterfaceUtils.h - file carb/Memory.h - file carb/ObjectUtils.h - file carb/PluginCoreUtils.h - file carb/PluginInitializers.h - file carb/PluginUtils.h - file carb/RString.h - file carb/RStringEnum.inl - file carb/SdkVersion.h - file carb/StartupUtils.h - file carb/Types.h - file carb/Version.h ### dir examples - dir examples/example.stats ### dir - examples/example.stats/example.stats ### dir - examples/example.stats/include ### dir - examples/example.stats/include/carb ### dir - examples/example.stats/include/carb/stats - file - examples/example.stats/include/carb/stats/IStats.h ### dir - examples/example.stats/plugins ### dir - examples/example.stats/plugins/carb.stats <details> <summary> dir examples/example.windowing </summary> <div> <details> <summary> dir examples/example.windowing/example-glfw </summary> <div> <ul> <li> <p> file examples/example.windowing/example-glfw/glfw.cpp </p> </li> </ul> </div> </details> <details> <summary> dir examples/example.windowing/example.windowing.native.app </summary> <div> <ul> <li> <p> file examples/example.windowing/example.windowing.native.app/example.windowing.cpp </p> </li> </ul> </div> </details> <details> <summary> dir examples/example.windowing/example.windowing.no.plugin.app </summary> <div> <ul> <li> <p> file </p> </li> </ul> </div> </details> </div> </details> ### 目录结构 #### omni - omni - omni/audio - omni/audio/experimental - omni/audio/experimental/IAudioCapture.h - omni/compiletime - omni/compiletime/CompileTime.h - omni/core - omni/core/Api.h - omni/core/Assert.h - omni/core/BuiltIn.h - file omni/core/BuiltIn.h - file omni/core/IObject.gen.h - file omni/core/IObject.h - file omni/core/ITypeFactory.gen.h - file omni/core/ITypeFactory.h - file omni/core/IWeakObject.gen.h - file omni/core/IWeakObject.h - file omni/core/Interface.h - file omni/core/ModuleExports.h - file omni/core/ModuleInfo.h - file omni/core/Omni.h - file omni/core/OmniAttr.h - file omni/core/OmniInit.h - file omni/core/Platform.h - file omni/core/Result.gen.h - file omni/core/Result.h - file omni/core/ResultError.h - file omni/core/TypeId.h - file omni/core/Types.h - dir omni/detail - file omni/detail/ConvertsFromAnyCvRef.h - file omni/detail/ExpectedImpl.h - file omni/detail/FunctionImpl.h ### Files - file omni/detail/ParamPack.h - file omni/detail/PointerIterator.h - file omni/detail/VectorDetail.h ### Directories #### omni/experimental - file omni/experimental/job/IJob.gen.h - file omni/experimental/job/IJob.h #### omni/ext - file omni/ext/ExtensionsUtils.h - file omni/ext/IExt.h - file omni/ext/IExtensionData.gen.h - file omni/ext/IExtensionData.h - file omni/ext/IExtensionHooks.gen.h - file omni/ext/IExtensionHooks.h - file omni/ext/IExtensions.h ### omni/extras - file omni/extras/ContainerHelper.h - file omni/extras/DictHelpers.h - file omni/extras/FileSystemHelpers.h - file omni/extras/ForceLink.h - file omni/extras/OutArrayUtils.h - file omni/extras/PathMap.h - file omni/extras/PrivacySettings.h - file omni/extras/RtxSettings.h - file omni/extras/ScratchBuffer.h - file omni/extras/SettingsHelpers.h - file omni/extras/StringHelpers.h - file omni/extras/UniqueApp.h - file omni/extras/Version.h - file omni/extras/md5.h ### omni/kit - file omni/kit/EventSubscribers.h - file omni/kit/IApp.h - file omni/kit/IAppMessageBox.h - file omni/kit/IRunLoopRunner.h - file omni/kit/KitUpdateOrder.h - file omni/kit/SettingsUtils.h - file omni/kit/Wildcard.h ### dir omni/log - file omni/log/ILog.gen.h - file omni/log/ILog.h - file omni/log/ILogChannelFilter.gen.h - file omni/log/ILogChannelFilter.h - file omni/log/LogChannel.h - file omni/log/WildcardLogChannelFilter.h ### dir omni/platforminfo - file omni/platforminfo/ICpuInfo.gen.h - file omni/platforminfo/ICpuInfo.h - file omni/platforminfo/IMemoryInfo.gen.h - file omni/platforminfo/IMemoryInfo.h - file omni/platforminfo/IOsInfo.gen.h - file omni/platforminfo/IOsInfo.h ### dir omni/python <details> <summary>dir</summary> - file - omni/python/PyBind.h </details> <details> <summary>dir</summary> - file - omni/str/IReadOnlyCString.gen.h - omni/str/IReadOnlyCString.h - omni/str/Wildcard.h </details> <details> <summary>dir</summary> - file - omni/structuredlog/BinarySerializer.h - omni/structuredlog/IStructuredLog.gen.h - omni/structuredlog/IStructuredLog.h - omni/structuredlog/IStructuredLogControl.gen.h - omni/structuredlog/IStructuredLogControl.h - omni/structuredlog/IStructuredLogExtraFields.gen.h - omni/structuredlog/IStructuredLogExtraFields.h - omni/structuredlog/IStructuredLogFromILog.gen.h - omni/structuredlog/IStructuredLogFromILog.h - omni/structuredlog/IStructuredLogSettings.gen.h </details> - file omni/structuredlog/IStructuredLogSettings.h - file omni/structuredlog/IStructuredLogSettings2.gen.h - file omni/structuredlog/IStructuredLogSettings2.h - file omni/structuredlog/JsonSerializer.h - file omni/structuredlog/JsonTree.h - file omni/structuredlog/JsonTreeSerializer.h - file omni/structuredlog/StringView.h - file omni/structuredlog/StructuredLogCommon.h - file omni/structuredlog/StructuredLogSettingsUtils.h - file omni/structuredlog/Telemetry.h - file omni/Expected.h - file omni/Function.h - file omni/Span.h - file omni/String.h - file omni/StringView.h - file omni/Vector.h - dir tests - dir tests/test.unit - dir tests/test.unit/omni.core ## Namespace hierarchy  ### namespace carb #### namespace carb::assert - struct carb::assert::IAssert #### namespace carb::assets ### Namespace carb::assets - enum `carb::assets::Reason` - struct `carb::assets::AssetTypeParams` - struct `carb::assets::IAssets` - struct `carb::assets::IAssetsBlob` - struct `carb::assets::LoadContext` - struct `carb::assets::LoadParameters` - struct `carb::assets::LoaderDesc` - class `carb::assets::ScopedSnapshot` - struct `carb::assets::Type` ### Namespace carb::audio - enum `carb::audio::AudioResult` - enum `carb::audio::ChooseType` - enum `carb::audio::CodecPart` - enum `carb::audio::ContextCallbackEvent` - enum `carb::audio::DeviceBackend` - enum `carb::audio::DeviceType` - enum `carb::audio::FlacFileType` - enum `carb::audio::OpusCodecUsage` - enum `carb::audio::OpusApplication` - enum carb::audio::RolloffType - enum carb::audio::SampleFormat - enum carb::audio::Speaker - enum carb::audio::StreamState - enum carb::audio::UnitType - enum carb::audio::VoiceCallbackType - struct carb::audio::AudioImageDesc - struct carb::audio::CaptureContextDesc - struct carb::audio::CaptureDeviceDesc - struct carb::audio::CodecInfo - struct carb::audio::CodecState - struct carb::audio::CodecStateDesc - struct carb::audio::Context - struct carb::audio::ContextCaps - struct carb::audio::ContextParams - struct carb::audio::ContextParams2 - struct carb::audio::ConversionDesc - struct carb::audio::DecodeStateDesc - struct carb::audio::DeviceCaps - struct carb::audio::DspValuePair - struct carb::audio::EmitterAttributes - struct carb::audio::EncodeStateDesc - struct carb::audio::EntityAttributes - struct carb::audio::EntityCone - carb::audio::EntityCone - carb::audio::EventListener - carb::audio::EventPoint - carb::audio::EventStreamer - carb::audio::FlacEncoderSettings - carb::audio::GroupDesc - carb::audio::IAudioCapture - carb::audio::IAudioData - carb::audio::IAudioDevice - carb::audio::IAudioGroup - carb::audio::IAudioPlayback - carb::audio::IAudioUtils - carb::audio::ListenerAttributes - carb::audio::LockRegion - carb::audio::LoopPointDesc - carb::audio::NullStreamer - carb::audio::OpusEncoderSettings - carb::audio::OutputDesc - carb::audio::OutputStreamDesc - carb::audio::OutputStreamer - carb::audio::PeakVolumes - carb::audio::PlaySoundDesc - carb::audio::PlaySoundDesc2 - carb::audio::PlaybackContextDesc - struct carb::audio::ProbabilityDesc - struct carb::audio::RolloffCurve - struct carb::audio::RolloffDesc - struct carb::audio::SoundData - struct carb::audio::SoundDataLoadDesc - struct carb::audio::SoundDataSaveDesc - struct carb::audio::SoundEntry - struct carb::audio::SoundFormat - struct carb::audio::SoundLoadParameters - struct carb::audio::SpeakerDirection - struct carb::audio::SpeakerDirectionDesc - struct carb::audio::Streamer - class carb::audio::StreamerWrapper - struct carb::audio::TranscodeDesc - struct carb::audio::UserData - struct carb::audio::Voice - struct carb::audio::VoiceParams - struct carb::audio::VorbisEncoderSettings - struct carb::audio::WaveEncoderSettings ### namespace - carb::container namespace - carb::container::detail class - carb::container::detail::RobinHood class - carb::container::BufferedObject - carb::container::IntrusiveList - carb::container::IntrusiveListLink - carb::container::IntrusiveUnorderedMultimap - carb::container::IntrusiveUnorderedMultimapLink - carb::container::LocklessQueue - carb::container::LocklessQueueLink - carb::container::LocklessStack - carb::container::LocklessStackLink - carb::container::RHUnorderedMap - carb::container::RHUnorderedMultimap - carb::container::RHUnorderedMultiset - carb::container::RHUnorderedSet ## namespace ### carb::cpp #### Contents - enum: carb::cpp::byte - class: carb::cpp::barrier - class: carb::cpp::basic_string_view - struct: carb::cpp::conjunction - class: carb::cpp::counting_semaphore - struct: carb::cpp::disjunction - struct: carb::cpp::invoke_result - struct: carb::cpp::is_invocable - struct: carb::cpp::is_invocable_r - struct: carb::cpp::is_nothrow_convertible - struct: carb::cpp::is_nothrow_invocable - struct: carb::cpp::is_nothrow_invocable_r - struct: carb::cpp::is_nothrow_swappable - struct: carb::cpp::is_nothrow_swappable_with - struct: carb::cpp::is_swappable - struct: carb::cpp::is_swappable_with - class: carb::cpp::latch - struct: carb::cpp::negation - struct: carb::cpp::remove_cvref - class: carb::cpp::span - struct - carb::cpp::type_identity - enum - carb::cpp::endian - namespace - carb::cpp17 - namespace - carb::cpp20 ### namespace carb::crashreporter - namespace - carb::crashreporter::detail - enum - carb::crashreporter::CrashSentResult - enum - carb::crashreporter::MetadataValueType - struct - carb::crashreporter::CrashSentInfo - struct - carb::crashreporter::ICrashReporter - struct - carb::crashreporter::MetadataValueCallback ### namespace carb::delegate ### namespace carb::delegate::detail - class - carb::delegate::detail::DelegateBase - class - carb::delegate::detail::DelegateBase<Mutex, Exec, void(Args...)> - class `carb::delegate::Delegate` - class `carb::delegate::Delegate<void(Args…)>` - class `carb::delegate::DelegateRef` - class `carb::delegate::DelegateRef<void(Args…)>` - struct `carb::delegate::RefFromDelegate` - class `carb::detail::RStringTraits` - enum `carb::dictionary::ChangeEventType` - enum `carb::dictionary::ItemFlag` - enum `carb::dictionary::ItemType` - enum `carb::dictionary::UpdateAction` - enum `carb::dictionary::WalkerMode` - struct `carb::dictionary::IDictionary` - struct `carb::dictionary::ISerializer` - struct `carb::dictionary::Item` ### Namespace carb::dictionary - class: carb::dictionary::ScopedRead - class: carb::dictionary::ScopedWrite - struct: carb::dictionary::SubscriptionId ### Namespace carb::eventdispatcher - class: carb::eventdispatcher::Event - struct: carb::eventdispatcher::EventData - struct: carb::eventdispatcher::IEventDispatcher - struct: carb::eventdispatcher::NamedVariant - class: carb::eventdispatcher::ObserverGuard ### Namespace carb::events - class: carb::events::IEvent - class: carb::events::IEventListener - class: carb::events::IEventStream - struct: carb::events::IEvents - class: carb::events::ISubscription - class: carb::events::LambdaEventListener ### Namespace carb::extras - class: carb::extras::ExampleClass - struct: carb::extras::ExampleStruct - enum: carb::extras::ExampleEnum <details> <summary>namespace carb::extras</summary> <div> <ul> <li> <p>enum <span>carb::extras::MemoryQueryType</span></p> </li> <li> <p>enum <span>carb::extras::MemoryScaleType</span></p> </li> <li> <p>class <span>carb::extras::Base64</span></p> </li> <li> <p>struct <span>carb::extras::ConstHandleRef</span></p> </li> <li> <p>class <span>carb::extras::CpuInfo</span></p> </li> <li> <p>class <span>carb::extras::EnvironmentVariable</span></p> </li> <li> <p>class <span>carb::extras::EnvironmentVariableParser</span></p> </li> <li> <p>class <span>carb::extras::HandleDatabase</span></p> </li> <li> <p>struct <span>carb::extras::HandleRef</span></p> </li> <li> <p>class <span>carb::extras::Path</span></p> </li> <li> <p>class <span>carb::extras::SharedMemory</span></p> </li> <li> <p>struct <span>carb::extras::SystemMemoryInfo</span></p> </li> <li> <p>class <span>carb::extras::Utf8Iterator</span></p> </li> <li> <p>class <span>carb::extras::Utf8Parser</span></p> </li> <li> <p>class <span>carb::extras::Uuid</span></p> </li> </ul> </div> </details> <details> <summary>namespace carb::filesystem</summary> <div> <ul> <li> <p>enum <span>carb::filesystem::ChangeAction</span></p> </li> <li> <p>enum <span>carb::filesystem::DirectoryItemType</span></p> </li> </ul> </div> </details> - enum carb::filesystem::FileStatus - enum carb::filesystem::FileWhence - enum carb::filesystem::WalkAction - struct carb::filesystem::DirectoryItemInfo - struct carb::filesystem::File - struct carb::filesystem::FileInfo - struct carb::filesystem::FindFilesArgs - struct carb::filesystem::IFileSystem - enum carb::input::CurrentButtonState - enum carb::input::DeviceType - enum carb::input::FilterResult - enum carb::input::GamepadConnectionEventType - enum carb::input::GamepadInput - enum carb::input::KeyboardEventType - enum carb::input::KeyboardInput - enum carb::input::MouseEventType - enum carb::input::MouseInput - enum carb::input::PreviousButtonState - struct `carb::input::ActionEvent` - struct `carb::input::ActionMappingDesc` - class `carb::input::ActionMappingSet` - struct `carb::input::Gamepad` - struct `carb::input::GamepadConnectionEvent` - struct `carb::input::GamepadEvent` - struct `carb::input::IInput` - struct `carb::input::InputDevice` - struct `carb::input::InputEvent` - struct `carb::input::InputProvider` - struct `carb::input::Keyboard` - struct `carb::input::KeyboardEvent` - struct `carb::input::Mouse` - struct `carb::input::MouseEvent` - class `carb::input::ScopedRead` - class `carb::input::ScopedWrite` - namespace `carb::l10n` - enum `carb::l10n::LocalizedName` - struct `carb::l10n::IL10n` - struct `carb::l10n::LanguageIdentifier` - struct `carb::l10n::LanguageTable` ### Namespace carb::l10n - LanguageTable - LanguageTableData ### Namespace carb::launcher - KillStatus - ArgCollector - EnvCollector - ILauncher - LaunchDesc ### Namespace carb::logging - LogSettingBehavior - OutputStream - OutputType - ILogging - LogFileConfiguration - Logger - ScopedFilePause - ScopedLevelThreadOverride - StandardLogger - namespace - carb::logging - namespace - carb::math - namespace - carb::memory - class - carb::memory::ArenaAllocator - namespace - carb::options - enum - carb::options::ParseResult - enum - carb::options::ValueType - struct - carb::options::Option - class - carb::options::Options - class - carb::options::Value - namespace - carb::process - namespace - carb::profiler - enum - carb::profiler::FlowType ### Namespace carb::profiler - enum `carb::profiler::LockableOperationType` - class `carb::profiler::Channel` - struct `carb::profiler::IProfileMonitor` - struct `carb::profiler::IProfiler` - struct `carb::profiler::ProfileEvent` - class `carb::profiler::ProfileZoneDynamic` - class `carb::profiler::ProfileZoneStatic` - class `carb::profiler::ProfiledMutex` - class `carb::profiler::ProfiledSharedMutex` ### Namespace carb::settings - struct `carb::settings::ISettings` - class `carb::settings::ScopedRead` - class `carb::settings::ScopedSubscription` - class `carb::settings::ScopedWrite` - class `carb::settings::ThreadSafeLocalCache` - struct `carb::settings::Transaction` ### Namespace carb::simplegui - (No items listed under this namespace) - enum carb::simplegui::Condition - enum carb::simplegui::DataType - enum carb::simplegui::Direction - enum carb::simplegui::MouseCursor - enum carb::simplegui::StyleColor - enum carb::simplegui::StyleColorsPreset - enum carb::simplegui::StyleVar - struct carb::simplegui::ContextDesc - struct carb::simplegui::DrawCommand - struct carb::simplegui::DrawData - struct carb::simplegui::DrawList - struct carb::simplegui::DrawVertex - struct carb::simplegui::FontConfig - struct carb::simplegui::FontCustomRect - struct carb::simplegui::ISimpleGui - struct carb::simplegui::ListClipper - struct carb::simplegui::Payload - struct carb::simplegui::Style - struct carb::simplegui::TextEditCallbackData - struct carb::simplegui::Viewport - struct carb::simplegui::WindowClass ### Namespace carb::stats - enum `carb::stats::AggregationType` - enum `carb::stats::StatType` - struct `carb::stats::IStats` - struct `carb::stats::StatDesc` - struct `carb::stats::Value` ### Namespace carb::tasking - enum `carb::tasking::ObjectType` - enum `carb::tasking::Priority` - enum `carb::tasking::TaskDebugState` - struct `carb::tasking::All` - struct `carb::tasking::Any` - class `carb::tasking::ConditionVariable` - class `carb::tasking::ConditionVariableWrapper` - class `carb::tasking::Counter` - class `carb::tasking::CounterWrapper` - class `carb::tasking::Delegate` - class `carb::tasking::Delegate< void(Args…)>` - class `carb::tasking::DelegateRef` - class `carb::tasking::DelegateRef` - class `carb::tasking::DelegateRef<void(Args…)>` - class `carb::tasking::Future` - struct `carb::tasking::IFiberEvents` - struct `carb::tasking::ITasking` - struct `carb::tasking::IThreadPool` - class `carb::tasking::Mutex` - class `carb::tasking::MutexWrapper` - struct `carb::tasking::Object` - class `carb::tasking::PinGuard` - class `carb::tasking::Promise` - class `carb::tasking::RecursiveMutexWrapper` - struct `carb::tasking::RefFromDelegate` - struct `carb::tasking::RequiredObject` - class `carb::tasking::ScopedTracking` - class `carb::tasking::Semaphore` - class `carb::tasking::SemaphoreWrapper` - class `carb::tasking::SharedFuture` - class `carb::tasking::SharedMutex` - class `carb::tasking::SharedMutexWrapper` - struct `carb::tasking::SpinMutex` - struct `carb::tasking::SpinSharedMutex` - struct `carb::tasking::TaskDebugInfo` - struct `carb::tasking::TaskDesc` - class carb::tasking::TaskGroup - struct carb::tasking::TaskingDesc - class carb::tasking::ThreadPool - class carb::tasking::ThreadPoolWrapper - struct carb::tasking::Tracker - struct carb::tasking::Trackers - namespace carb::this_process - namespace carb::this_thread - namespace carb::thread - namespace carb::thread::detail - class carb::thread::detail::SpinlockImpl - enum carb::thread::RelayResult - class carb::thread::AtomicBackoff - struct carb::thread::IThreadUtil - struct carb::thread::RelayTaskDesc - class carb::thread::ThreadLocal - class carb::thread::ThreadLocal< T, false > - class carb::thread::ThreadLocal< T, true > - carb::thread::ThreadLocal< T, true > - carb::thread::futex - carb::thread::mutex - carb::thread::recursive_mutex - carb::thread::recursive_shared_mutex - carb::thread::shared_mutex - carb::time - carb::tokens - carb::tokens::ResolveResult - carb::tokens::StringEndingMode - carb::tokens::ITokens - carb::variant - carb::variant::IVariant - carb::variant::KeyValuePair - carb::variant::Registrar - carb::variant::Translator - carb::variant::VTable - carb::variant::Variant - carb::variant::VariantArray - `carb::variant::VariantArray` - `carb::variant::VariantData` - `carb::variant::VariantMap` - `carb::variant::traits` - `carb::variant_literals` - `carb::windowing` - `carb::AcquireInterfaceFlags` - `carb::BindingType` - `carb::LoadPluginResult` - `carb::PluginHotReload` - `carb::PluginReloadState` - `carb::PrefetchLevel` - `carb::RStringOp` - `carb::AcquireInterfaceOptions` - `carb::Allocator` - `carb::Color` - `carb::ColorRgb` - `carb::ColorRgbDouble` - `carb::ColorRgba` - `carb::ColorRgbaDouble` - `carb::Deleter` - `carb::Double2` - `carb::Double3` - `carb::Double4` - `carb::EmptyMemberPair` - struct carb::ErrorApi - class carb::EventSubscribers - struct carb::FindPluginsArgs - struct carb::Float2 - struct carb::Float3 - struct carb::Float4 - struct carb::Framework - class carb::FrameworkInitializerForBindings - class carb::IObject - struct carb::InitBoth - struct carb::Int2 - struct carb::Int3 - struct carb::Int4 - struct carb::InterfaceDesc - class carb::ObjectPtr - struct carb::PluginDesc - struct carb::PluginFrameworkDesc - struct carb::PluginImplDesc - struct carb::PluginLoadingDesc - struct carb::PluginRegistrationDesc - struct carb::PluginRegistryEntry - struct carb::PluginRegistryEntry2 - class carb::RString - class carb::RStringKey - class carb::RStringU - class carb::RStringUKey - struct carb::SharedHandle - `carb::SharedHandle` - `carb::StartupFrameworkDesc` - `carb::Uint2` - `carb::Uint3` - `carb::Uint4` - `carb::UseCarbAllocatorAligned` - `carb::ValueInitFirst` - `carb::Version` - `detail::IsNothrowSwappable` - `detail::IsNothrowSwappableWith` - `detail::IsSwappable` - `detail::IsSwappableWith` - `detail::invocable_r_impl` - `omni` - `omni::audio` - `omni::audio::experimental` ### omni::audio::experimental - enum `omni::audio::experimental::CaptureInfoType` - struct `omni::audio::experimental::CaptureDeviceDesc` - struct `omni::audio::experimental::CaptureStreamDesc` - struct `omni::audio::experimental::Format` - class `omni::audio::experimental::IAudioCapture` - class `omni::audio::experimental::ICaptureStream` - class `omni::audio::experimental::ICaptureStream_abi` ### omni::compiletime - namespace `omni::compiletime` ### omni::core - class `omni::core::Api` - class `omni::core::Api<omni::core::ITypeFactory_abi>` - class `omni::core::Generated` - class `omni::core::Generated<omni::core::IObject_abi>` - class `omni::core::Generated<omni::core::ITypeFactory_abi>` - class `omni::core::Generated<omni::core::IWeakObjectControlBlock_abi>` - class `omni::core::Generated<omni::core::IWeakObject_abi>` - class `omni::core::Generated<omni::experimental::job::IAffinityMask_abi>` - omni::core::Generated< omni::experimental::job::IAffinityMask_abi > - omni::core::Generated< omni::experimental::job::IJobAffinity_abi > - omni::core::Generated< omni::experimental::job::IJobWorker_abi > - omni::core::Generated< omni::experimental::job::IJob_abi > - omni::core::Generated< omni::ext::IExtensionData_abi > - omni::core::Generated< omni::ext::IExtensionHooks_abi > - omni::core::Generated< omni::log::ILogChannelFilter_abi > - omni::core::Generated< omni::log::ILogChannelUpdateConsumer_abi > - omni::core::Generated< omni::log::ILogMessageConsumer_abi > - omni::core::Generated< omni::log::ILog_abi > - omni::core::Generated< omni::platforminfo::ICpuInfo_abi > - omni::core::Generated< omni::platforminfo::IMemoryInfo_abi > - omni::core::Generated< omni::platforminfo::IOsInfo_abi > - omni::core::Generated< omni::str::IReadOnlyCString_abi > - omni::core::Generated< omni::structuredlog::IStructuredLogControl_abi > - omni::core::Generated< omni::structuredlog::IStructuredLogExtraFields_abi > - omni::core::Generated< omni::structuredlog::IStructuredLogFromILog_abi > - omni::core::Generated< omni::structuredlog::IStructuredLogSettings2_abi > - omni::core::Generated< omni::structuredlog::IStructuredLogSettings_abi > - class omni::core::Generated< omni::structuredlog::IStructuredLogSettings_abi > - class omni::core::Generated< omni::structuredlog::IStructuredLog_abi > - class omni::core::IObject - class omni::core::IObject_abi - class omni::core::ITypeFactory_abi - class omni::core::IWeakObject - class omni::core::IWeakObjectControlBlock - class omni::core::IWeakObjectControlBlock_abi - class omni::core::IWeakObject_abi - struct omni::core::Implements - struct omni::core::ImplementsCast - struct omni::core::ImplementsWeak - class omni::core::Inherits - struct omni::core::InterfaceImplementation - struct omni::core::ModuleExportEntry - struct omni::core::ModuleExportEntryCarbClientName - struct omni::core::ModuleExportEntryCarbFramework - struct omni::core::ModuleExportEntryCarbIAssert - struct omni::core::ModuleExportEntryCarbIL10n - struct omni::core::ModuleExportEntryCarbILogging - struct omni::core::ModuleExportEntryCarbIProfiler - struct omni::core::ModuleExportEntryGetModuleDependencies - struct omni::core::ModuleExportEntryILog - struct omni::core::ModuleExportEntryILog - struct omni::core::ModuleExportEntryIStructuredLog - struct omni::core::ModuleExportEntryITypeFactory - struct omni::core::ModuleExportEntryLogChannel - struct omni::core::ModuleExportEntryOnModuleCanUnload - struct omni::core::ModuleExportEntryOnModuleLastChanceShutdown - struct omni::core::ModuleExportEntryOnModuleLoad - struct omni::core::ModuleExportEntryOnModuleStarted - struct omni::core::ModuleExportEntryOnModuleUnload - struct omni::core::ModuleExportEntrySchema - struct omni::core::ModuleExports - class omni::core::ObjectParam - class omni::core::ObjectPtr - class omni::core::ResultError - struct omni::core::ScopedFrameworkStartup - struct omni::core::ScopedOmniCore - class omni::core::TypeFactoryArgs - class omni::core::WeakPtr ### namespace omni::detail - class omni::detail::PointerIterator ### namespace omni::experimental ### namespace omni::experimental::job - class `omni::experimental::job::IAffinityMask_abi` - class `omni::experimental::job::IJobAffinity_abi` - class `omni::experimental::job::IJobWorker_abi` - class `omni::experimental::job::IJob_abi` ### namespace omni::ext - enum `omni::ext::DownloadState` - enum `omni::ext::ExtensionPathType` - enum `omni::ext::ExtensionStateChangeType` - struct `omni::ext::ExtPathUrl` - struct `omni::ext::ExtensionFolderInfo` - struct `omni::ext::ExtensionInfo` - class `omni::ext::ExtensionManager` - class `omni::ext::ExtensionStateChangeHookLambda` - `omni::ext::ExtensionStateChangeHookLambda` - `omni::ext::ExtensionSummary` - `omni::ext::IExt` - `omni::ext::IExtensionData_abi` - `omni::ext::IExtensionHooks_abi` - `omni::ext::IExtensionManagerHooks` - `omni::ext::IExtensionStateChangeHook` - `omni::ext::IExtensions` - `omni::ext::IHookHolder` - `omni::ext::IPathProtocolProvider` - `omni::ext::IRegistryProvider` - `omni::ext::RegistryProviderInfo` - `omni::ext::SolverInput` - `omni::ext::Version` - `omni::ext::VersionLockDesc` ### namespace `omni::extras` - `omni::extras::ConsentLevel` - `omni::extras::ForceSymbolLink` - `omni::extras::PrivacySettings` - `omni::extras::ScratchBuffer` - `omni::extras::SemanticVersion` <details class="sd-sphinx-override sd-dropdown sd-card sd-mb-3"> <summary class="sd-summary-title sd-card-header"> namespace <span class="std std-ref"> omni::kit </span> </summary> <div class="sd-summary-content sd-card-body docutils"> <details class="sd-sphinx-override sd-dropdown sd-card sd-mb-3"> <summary class="sd-summary-title sd-card-header"> namespace <span class="std std-ref"> omni::kit::update </span> </summary> <div class="sd-summary-content sd-card-body docutils"> <div class="rebreather hierarchy docutils container"> <ul class="simple"> <li> <p class="sd-card-text"> enum <span class="std std-ref"> omni::kit::update::IUsdStageEventOrdering </span> </p> </li> <li> <p class="sd-card-text"> enum <span class="std std-ref"> omni::kit::update::KitUsdStageEventOrdering </span> </p> </li> <li> <p class="sd-card-text"> enum <span class="std std-ref"> omni::kit::update::PostUpdateOrdering </span> </p> </li> <li> <p class="sd-card-text"> enum <span class="std std-ref"> omni::kit::update::PreUpdateOrdering </span> </p> </li> <li> <p class="sd-card-text"> enum <span class="std std-ref"> omni::kit::update::UpdateOrdering </span> </p> </li> </ul> </div> </div> </details> <div class="rebreather hierarchy docutils container"> <ul class="simple"> <li> <p class="sd-card-text"> enum <span class="std std-ref"> omni::kit::MessageBoxButtons </span> </p> </li> <li> <p class="sd-card-text"> enum <span class="std std-ref"> omni::kit::MessageBoxResponse </span> </p> </li> <li> <p class="sd-card-text"> enum <span class="std std-ref"> omni::kit::MessageBoxType </span> </p> </li> <li> <p class="sd-card-text"> enum <span class="std std-ref"> omni::kit::RestartArgsPolicy </span> </p> </li> <li> <p class="sd-card-text"> struct <span class="std std-ref"> omni::kit::AppDesc </span> </p> </li> <li> <p class="sd-card-text"> struct <span class="std std-ref"> omni::kit::AppInfo </span> </p> </li> <li> <p class="sd-card-text"> struct <span class="std std-ref"> omni::kit::BuildInfo </span> </p> </li> <li> <p class="sd-card-text"> class <span class="std std-ref"> omni::kit::IApp </span> </p> </li> <li> <p class="sd-card-text"> class <span class="std std-ref"> omni::kit::IAppMessageBox </span> </p> </li> </ul> </div> </div> </details> ### Class and Namespace Summary #### omni::kit - Class: omni::kit::IAppMessageBox - Class: omni::kit::IAppScripting - Class: omni::kit::IRunLoopRunner - Struct: omni::kit::PlatformInfo - Class: omni::kit::RunLoop - Class: omni::kit::Wildcard #### omni::log - Enum: omni::log::ChannelUpdateReason - Enum: omni::log::Level - Enum: omni::log::SettingBehavior - Class: omni::log::ILog - Class: omni::log::ILogChannelFilter - Class: omni::log::ILogChannelFilter_abi - Class: omni::log::ILogChannelUpdateConsumer - Class: omni::log::ILogChannelUpdateConsumer_abi - Class: omni::log::ILogMessageConsumer - Class: omni::log::ILogMessageConsumer_abi - Class: omni::log::ILog_abi #### omni::platforminfo - Details: omni::platforminfo Namespace ### Platform Information - enum `omni::platforminfo::Architecture` - enum `omni::platforminfo::CpuFeature` - enum `omni::platforminfo::Os` - struct `omni::platforminfo::CompositorInfo` - class `omni::platforminfo::ICpuInfo` - class `omni::platforminfo::ICpuInfo_abi` - class `omni::platforminfo::IMemoryInfo` - class `omni::platforminfo::IMemoryInfo_abi` - class `omni::platforminfo::IOsInfo` - class `omni::platforminfo::IOsInfo_abi` - struct `omni::platforminfo::OsVersion` ### Python Namespace - namespace `omni::python` - namespace `omni::python::detail` - class `omni::python::detail::PyObjectPtr` ### String Namespace - namespace `omni::str` ### Classes - class `omni::str::IReadOnlyCString_abi` - class `omni::str::ReadOnlyCString` ### Namespaces - namespace `omni::structuredlog` - namespace `omni::structuredlog::@253` - namespace `omni::structuredlog::@266` ### Enumerations - enum `omni::structuredlog::IdMode` - enum `omni::structuredlog::IdType` - enum `omni::structuredlog::JsonTreeCompareFuzz` - enum `omni::structuredlog::NodeType` - enum `omni::structuredlog::SchemaResult` ### Classes in omni::structuredlog - class `omni::structuredlog::Allocator` - class `omni::structuredlog::BasicStringView` - class `omni::structuredlog::BinaryBlobSizeCalculator` - class `omni::structuredlog::BlobReader` - class `omni::structuredlog::BlobWriter` - class `omni::structuredlog::BlockAllocator` - struct `omni::structuredlog::EventInfo` - class `omni::structuredlog::IStructuredLog` - class `omni::structuredlog::IStructuredLogControl` - class `omni::structuredlog::IStructuredLogControl_abi` - class `omni::structuredlog::IStructuredLogExtraFields` - class `omni::structuredlog::IStructuredLogExtraFields_abi` - class `omni::structuredlog::IStructuredLogFromILog` - class `omni::structuredlog::IStructuredLogFromILog_abi` - class `omni::structuredlog::IStructuredLogSettings` - class `omni::structuredlog::IStructuredLogSettings2` - class `omni::structuredlog::IStructuredLogSettings2_abi` - class `omni::structuredlog::IStructuredLogSettings_abi` - class `omni::structuredlog::IStructuredLog_abi` - class `omni::structuredlog::JsonBuilder` - class `omni::structuredlog::JsonConsumer` - class `omni::structuredlog::JsonLengthCounter` - struct `omni::structuredlog::JsonNode` - class `omni::structuredlog::JsonPrinter` - class `omni::structuredlog::JsonSerializer` - class `omni::structuredlog::JsonTreeSizeCalculator` - class `omni::structuredlog::TempJsonNode` - namespace `omni::telemetry` - class `omni::expected` - struct `omni::formatted_t` - class `omni::formatted_t` - class `omni::function` - class `omni::function< TReturn(TArgs…)>` - class `omni::string` - class `omni::unexpected` - class `omni::vector` - class `omni::vector< bool >` - struct `omni::vformatted_t` ### namespace `rtx` - class `rtx::RenderSettings` ### namespace `std` - struct `std::hash< carb::cpp::basic_string_view< CharT, Traits > >` - struct `std::hash< omni::string >` - struct `std::hash<::carb::RString >` - struct `std::hash<::carb::RStringKey >` - struct `std::hash<::carb::RStringU >` - struct `std::hash<::carb::RStringUKey >` - struct `std::owner_less<::carb::RString >` - struct `std::owner_less<::carb::RStringKey >` ## API contents - Classes - Macros - Directories - Enumerations - Files - Functions - Groups - Namespaces - Pages - Structs - Typedefs - Unions - Variables ### Structs - std::owner_less<::carb::RStringU> - std::owner_less<::carb::RStringUKey> ### Classes - InterfaceType - OmniCoreStartArgs
carbonite_kit_overview.md	# Overview ## Omniverse Kit Omniverse Kit is the SDK for building Omniverse applications like Create and View. It can also be used to develop your own Omniverse applications. It brings together a few major components: - USD/Hydra (see also omni.usd) - Omniverse (via Omniverse client library) - Carbonite - Omniverse RTX Renderer - Scripting - A UI Toolkit (omni.ui) As a developer you can use any combination of those to build your own application or just extend or modify what’s already there. ### USD/Hydra USD is the primary Scene Description used by Kit, both for in-memory/authoring/runtime use, and as the serialisation format. USD can be accessed directly via an external shared library. If your plugin uses USD through C++ it must link to this library. You can also use USD from python using USD’s own python bindings, which cover the whole USD API (but not all of it’s dependencies like Tf, SDF etc). We generated reference documentation for it, see the Modules. Hydra allows USD to stream it’s content to any Renderer which has a Hydra Scene Delegate - these include Pixar’s HDStorm (currently shipped with the USD package shipped as part of Kit) as well as the Omniverse RTX Renderer and IRay (both of which ship with Kit) ### Omni.USD Omni.USD (See the omni.usd module for API docs) is an API written in C++ which sits on top of USD, Kit’s core, and the OmniClient library, and provides application-related services such as: - Events/Listeners - Selection handling - Access to the Omniverse USD Audio subsystem - Access to the Omniverse Client Library, and handling of Omniverse Assets/URIs - USD Layer handling - A USDContext which provides convenient access to the main USDStage and its layers, as well as various Hydra, Renderer and Viewport related services - MDL support - Python bindings to all of the above, using the Python-3 async API in most cases ### Omniverse Client Library This is the library that Omniverse clients such as Kit use to communicate with both Omniverse servers and with local filesystems when loading and saving Assets (such as USD, MDL and textures). It contains: - a USD AssetResolver for parsing omniverse:// URIs - some SDF FileFormat plugins to support specialised use cases, including Omniverse’s Live Edit mode - an API to read/write/copy data/files and filesystem-like queries on Omniverse Nucleus servers - Support for managing connections with Omniverse servers - Python bindings to all of the above, using Python-3 async API in most cases # Carbonite The Carbonite SDK provides the core functionality of all Omniverse apps. This is a C++ based SDK that provides features such as: - Plugin management - Input handling - File access - Persistent settings management - Audio - Asset loading and management - Thread and task management - Image loading - Localization - Synchronization - Basic windowing All of this is provided with a single platform independent API. ## Plugins Carbonite Plugins are basically shared libraries with C-style interfaces, which can be dynamically loaded and unloaded. Interfaces are semantically versioned and backward compatibility is supported. Most plugin interfaces have python bindings, i.e they are accessible from python. The pybind11 library is used. For your own plugins you can also write python bindings and make them directly accessible from python. # Omniverse RTX Renderer As mentioned above, Pixar’s Hydra is used to interface between USD and RTX. This is an area of high architectural complexity, as Kit is required to support a large number of Renderers, multiple custom Scene delegates, multiple Hydra Engines (to support GL, Vulkan, DX12) and a host of other requirements, providing a Viewport inside Kit Applications with Gizmos and other controls, all rendering asynchronously at high frame rates # Scripting Kit comes with a version of python (currently 3.7) . You can run arbitrary python scripts in Kit based apps which can: - Access all plugins that are exposed via python bindings - Access the USD python API - Access Kit python-only modules - Load and access your C++ Carbonite plugins Currently there are 3 ways to run scripts: - At app startup time by passing cmd arguments. E.g.: ``` kit.exe --exec "some_script.py" ``` - Using the Console window - Using the Script Editor Window # Kit Extensions Building on top of scripting and Carbonite Plugins there is the highest-level and probably most crucial building block: Kit Extensions. You can think of Extensions as versioned packages with a runtime enabled/disabled state. These extensions can depend on other extensions. # omni.ui Omni.ui, our UI framework, is built on top of Dear Imgui. and written in C++, but exposes only a Python API.
carter-urdf-example_index.md	# Omniverse URDF Importer ## Omniverse URDF Importer The URDF Importer Extension is used to import URDF representations of robots. Unified Robot Description Format (URDF) is an XML format for representing a robot model in ROS. ### Getting Started 1. Clone the GitHub repo to your local machine. 2. Open a command prompt and navigate to the root of your cloned repo. 3. Run `build.bat` to bootstrap your dev environment and build the example extensions. 4. Run `_build\{platform}\release\omni.importer.urdf.app.bat` to start the Kit application. 5. From the menu, select `Isaac Utils->URDF Importer` to launch the UI for the URDF Importer extension. This extension is enabled by default. If it is ever disabled, it can be re-enabled from the Extension Manager by searching for `omni.importer.urdf`. Note: On Linux, replace `.bat` with `.sh` in the instructions above. ### Conventions Special characters in link or joint names are not supported and will be replaced with an underscore. In the event that the name starts with an underscore due to the replacement, an a is pre-pended. It is recommended to make these name changes in the mjcf directly. See the Convention References documentation for a complete list of Isaac Sim conventions. ### User Interface Information Panel: This panel has useful information about this extension. Import Options Panel: This panel has utility functions for testing the gains being set for the Articulation. See Import Options below for full details. Import Panel: This panel holds the source path, destination path, and import button. ### Import Options - Merge Fixed Joints ## URDF Importer Settings - Consolidate Fixed Joints: Consolidate links that are connected by fixed joints, so that an articulation is only applied to joints that move. - Fix Base Link: When checked, the robot will have its base fixed where it’s placed in world coordinates. - Import Inertia Tensor: Check to load inertia from urdf directly. If the urdf does not specify an inertia tensor, identity will be used and scaled by the scaling factor. If unchecked, Physx will compute it automatically. - Stage Units Per Meter: \|kit\| default length unit is centimeters. Here you can set the scaling factor to match the unit used in your URDF. Currently, the URDF importer only supports uniform global scaling. Applying different scaling for different axes and specific mesh parts (i.e. using the `scale` parameter under the URDF mesh label) will be available in future releases. If you have a `scale` parameter in your URDF, you may need to manually adjust the other values in the URDF so that all parameters are in the same unit. - Link Density: If a link does not have a given mass, uses this density (in Kg/m^3) to compute mass based on link volume. A value of 0.0 can be used to tell the physics engine to automatically compute density as well. - Joint Drive Type: Default Joint drive type, Values can be `None`, `Position`, and `Velocity`. - Joint Drive Strength: The drive strength is the joint stiffness for position drive, or damping for velocity driven joints. - Joint Position Drive Damping: If the drive type is set to position this is the default damping value used. - Clear Stage: When checked, cleans the stage before loading the new URDF, otherwise loads it on current open stage at position `(0,0,0)`. - Convex Decomposition: If Checked, the collision object will be made a set of Convex meshes to better match the visual asset. Otherwise a convex hull will be used. - Self Collision: Enables self collision between adjacent links. It may cause instability if the collision meshes are intersecting at the joint. - Create Physics Scene: Creates a default physics scene on the stage. Because this physics scene is created outside of the robot asset, it won’t be loaded into other scenes composed with the robot asset. - Output Directory: The destination of the imported asset. it will create a folder structure with the robot asset and all textures used for its rendering. You must have write access to this directory. ### Note: - It is recommended to set Self Collision to false unless you are certain that links on the robot are not self colliding. - You must have write access to the output directory used for import, it will default to the current open stage, change this as necessary. ### Known Issue: If more than one asset in URDF contains the same material name, only one material will be created, regardless if the parameters in the material are different (e.g two meshes have materials with the name “material”, one is blue and the other is red. both meshes will be either red or blue.). This also applies for textured materials. ## Robot Properties There might be many properties you want to tune on your robot. These properties can be spread across many different Schemas and APIs. The general steps of getting and setting a parameter are: 1. Find which API is the parameter under. Most common ones can be found in the Pixar USD API. 2. Get the prim handle that the API is applied to. For example, Articulation and Drive APIs are applied to joints, and MassAPIs are applied to the rigid bodies. 3. Get the handle to the API. From there on, you can Get or Set the attributes associated with that API. For example, if we want to set the wheel’s drive velocity and the actuators’ stiffness, we need to find the DriveAPI: ```python # get handle to the Drive API for both wheels left_wheel_drive = UsdPhysics.DriveAPI.Get(stage.GetPrimAtPath("/carter/chassis_link/left_wheel"), "angular") right_wheel_drive = UsdPhysics.DriveAPI.Get(stage.GetPrimAtPath("/carter/chassis_link/right_wheel"), "angular") # Set the velocity drive target in degrees/second left_wheel_drive.GetTargetVelocityAttr().Set(150) right_wheel_drive.GetTargetVelocityAttr().Set(150) # Set the drive damping, which controls the strength of the velocity drive left_wheel_drive.GetDampingAttr().Set(15000) right_wheel_drive.GetDampingAttr().Set(15000) ``` # Set the drive stiffness, which controls the strength of the position drive # In this case because we want to do velocity control this should be set to zero left_wheel_drive.GetStiffnessAttr().Set(0) right_wheel_drive.GetStiffnessAttr().Set(0) Alternatively you can use the Omniverse Commands Tool to change a value in the UI and get the associated Omniverse command that changes the property. Note: - The drive stiffness parameter should be set when using position control on a joint drive. - The drive damping parameter should be set when using velocity control on a joint drive. - A combination of setting stiffness and damping on a drive will result in both targets being applied, this can be useful in position control to reduce vibrations. ## Examples The following examples showcase how to best use this extension: - Carter Example: ``` Isaac Examples > Import Robot > Carter URDF ``` - Franka Example: ``` Isaac Examples > Import Robot > Franka URDF ``` - Kaya Example: ``` Isaac Examples > Import Robot > Kaya URDF ``` - UR10 Example: ``` Isaac Examples > Import Robot > UR10 URDF ``` Note: For these example, please wait for materials to get loaded. You can track progress on the bottom right corner of UI. ## Carter URDF Example To run the Example: 1. Go to the top menu bar and click ``` Isaac Examples > Import Robots > Carter URDF ``` 2. Press the `Load Robot` button to import the URDF into the stage, add a ground plane, add a light, and a physics scene. 3. Press the `Configure Drives` button to configure the joint drives and allow the rear pivot to spin freely. 4. Press the `Open Source Code` button to view the source code. The source code illustrates how to import and integrate the robot using the Python API. 5. Press the `PLAY` button to begin simulating. 6. Press the `Move to Pose` button to make the robot drive forward. ## Franka URDF Example To run the Example: 1. Go to the top menu bar and click ``` Isaac Examples > Import Robots > Franka URDF ``` 2. Press the `Load Robot` button to import the URDF into the stage, add a ground plane, add a light, and a physics scene. 3. Press the `Configure Drives` button to configure the joint drives and allow the rear pivot to spin freely. 4. Press the `Open Source Code` button to view the source code. The source code illustrates how to import and integrate the robot using the Python API. 5. Press the `PLAY` button to begin simulating. 6. Press the `Move to Pose` button to make the robot drive forward. ## Franka URDF Example To run the Example: 1. Go to the top menu bar and click `Isaac Examples > Import Robots > Franka URDF`. 2. Press the `Load Robot` button to import the URDF into the stage, add a ground plane, add a light, and and a physics scene. 3. Press the `Configure Drives` button to configure the joint drives. This sets each drive stiffness and damping value. 4. Press the `Open Source Code` button to view the source code. The source code illustrates how to import and integrate the robot using the Python API. 5. Press the `PLAY` button to begin simulating. 6. Press the `Move to Pose` button to make the robot move to a home/rest position. ## Kaya URDF Example To run the Example: 1. Go to the top menu bar and click `Isaac Examples > Import Robots > Kaya URDF`. 2. Press the `Load Robot` button to import the URDF into the stage, add a ground plane, add a light, and and a physics scene. 3. Press the `Configure Drives` button to configure the joint drives. This sets the drive stiffness and damping value of each wheel, sets all of its rollers as freely rotating. 4. Press the `Open Source Code` button to view the source code. The source code illustrates how to import and integrate the robot using the Python API. 5. Press the `PLAY` button to begin simulating. 6. Press the `Move to Pose` button to make the robot rotate in place. ## UR10 URDF Example To run the Example: 1. Go to the top menu bar and click `Isaac Examples > Import Robots > UR10 URDF`. 2. Press the `Load Robot` button to import the URDF into the stage, add a ground plane, add a light, and and a physics scene. 3. Press the `Configure Drives` button to configure the joint drives. This sets each drive stiffness and damping value. 4. Press the `Open Source Code` button to view the source code. The source code illustrates how to import and integrate the robot using the Python API. 5. Press the `PLAY` button to begin simulating. 6. Press the `Move to Pose` button to make the robot move to a home/rest position. ## Extension Documentation * URDF Import Extension [omni.importer.urdf] * Usage * High Level Code Overview * Limitations * Changelog * Contributing to the URDF Importer Extension
Categories.md	# Node Categories An OmniGraph node can have one or more categories associated with it, giving the UI a method of presenting large lists of nodes or node types in a more organized manner. ## Category Specification In .ogn File For now the node categories are all specified through the .ogn file, so the node will inherit all of the categories that were associated with its node type. There are three ways you can specify a node type category in a .ogn file; using a predefined category, creating a new category definition inline, or referencing an external file that has shared category definitions. ### Predefined Categories This is the simplest, and recommended, method of specifying categories. There is a single .ogn keyword to add to the file to associate categories with the node type. It can take three different forms. The first is a simple string with a single category in it: ```json { "MyNodeWithOneCategory": { "version": 1, "categories": "function", "description": "Empty node with one category" } } ``` Warning The list of categories is intentionally fixed. Using a category name that is not known to the system will result in a parsing failure and the node will not be generated. See below for methods of expanding the list of available categories. The second is a comma-separated list within that string, which specifies more than one category. ```json { "MyNodeWithTwoCategories": { "version": 1, "categories": "function,time", "description": "Empty node with two categories" } } ``` The last also specifies more than one category; this time in a list format: ```json { "MyNodeWithAListOfTwoCategories": { "version": 1, "categories": ["function", "time"], "description": "Empty node with a list of two categories" } } ``` The predefined list is contained within a configuration file. Later you will see how to add your own category definitions. The predefined configuration file looks like this: ```json { "categoryDefinitions": { "$description": [ "This file contains the category information that will tell OGN what the acceptable values for", "categories are in the .ogn file under the 'categories' keyword along with descriptions of each of", "the categories. Categories have an optional namespace to indicate subcategories, e.g. 'math:vector'", "indicates math nodes dealing exclusively with vectors.", "", "The contents of this file will always denote legal categories. The list can be extended by creating", "another file with the same format and adding it under the 'categoryDefinitions' keyword in .ogn, or by", "inserting an individual category definition in the 'category' keyword in .ogn. See the docs for details." ], "bundle": "Nodes dealing with Bundles", "constants": "Nodes which provide a constant value", "debug": "Development assist nodes for debugging", "event": "Action Graph nodes which are event sources for the graph", "examples": "Nodes which are used in documentation examples", "fileIO": "Nodes relating to data stored in the file system", "flowControl": "Nodes dealing with evaluation order of the graph", "function": "Nodes implementing a general function", "geometry:analysis": "Nodes dealing with the analysis of geometry representations", "geometry:deformer": "Nodes that deform geometry in space", "geometry:generator": "Nodes that generate different kinds of geometry", "geometry": "Nodes dealing with the manipulation of geometry", "graph:action": "Nodes specifically relating to action graphs", "graph:onDemand": "Nodes specifically relating to on-demand graphs", "graph:postRender": "Nodes specifically relating to post-render graphs", "graph:preRender": "Nodes specifically relating to pre-render graphs", "graph:simulation": "Nodes specifically relating to action graphs", "graph": "Nodes dealing with the graph to which they belong", "input:gamepad": "Nodes dealing with gamepad input", "input:keyboard": "Nodes dealing with keyboard input", "input:mouse": "Nodes dealing with mouse input", "input": "Nodes dealing with external input sources", "internal:test": "Nodes used solely for internal testing", "internal:tutorial": "Nodes used solely for illustrating a node writing technique", "internal": "Nodes not meant for general use", "material:shader": "Nodes dealing with shader information", "material:texture": "Nodes dealing with texture information", "material": "Nodes dealing with general materials", "math:array": "Nodes dealing with operations on arrays", "math:casts": "Nodes casting values from one type to another compatible type", "math:condition": "Nodes implementing mathematical logic functions", "math:constant": "Nodes with a constant value", "math:conversion": "Nodes converting between different types of data", "math:matrix": "Nodes dealing with matrix math" } } ``` { "math:operator": "Nodes implementing a mathematical operator", "math:vector": "Nodes dealing with vector math", "math": "General math values and functions", "rendering": "Nodes dealing with rendering components", "sceneGraph:camera": "Nodes dealing with the scene graph directly", "sceneGraph": "Nodes dealing with the scene graph directly", "script": "Nodes dealing with custom scripts", "sound": "Nodes dealing with sound", "time": "Nodes dealing with time values", "tutorials": "Nodes which are used in a documentation tutorial", "ui": "Nodes that create UI widgets and UI containers", "variables": "Nodes dealing with variables on the graph", "variants": "Nodes dealing with USD variants", "viewport": "Nodes dealing with viewport" } ``` ```markdown Note ==== You might have noticed some categories contain a colon as a separator. This is a convention that allows splitting of a single category into subcategories. Some UI may choose to use this information to provide more fine-grained filtering and organizing features. ``` ```markdown Inline Category Definition ========================== On occasion you may find that your node does not fit into any of the predefined categories, or you may wish to add extra categories that are specific to your project. One way to do this is to define a new category directly within the .ogn file. The way you define a new category is to use a `name:description` category dictionary rather than a simple string. For example, you could replace a single string directly: ```json { "MyNodeWithOneCustomCategory": { "version": 1, "categories": { "light": "Nodes implementing lights for rendering" }, "description": "Empty node with one custom category" } } ``` You can add more than one category by adding more dictionary entries: ```json { "MyNodeWithTwoCustomCategories": { "version": 1, "categories": { "light": "Nodes implementing lights for rendering", "night": "Nodes implementing all aspects of nighttime" }, "description": "Empty node with two custom categories" } } ``` You can also mix custom categories with predefined categories using the list form: ```json { "MyNodeWithMixedCategories": { "version": 1, "categories": [ "rendering", { "light": "Nodes implementing lights for rendering", "night": "Nodes implementing all aspects of nighttime" } ], "description": "Empty node with mixed categories" } } ``` ``` ```markdown Shared Category Definition File =============================== While adding a category definition directly within a file is convenient, it is not all that useful as you either only have one node type per category, or you have to duplicate the category definitions in every .ogn file. A better approach is to put all of your extension’s, or project’s, categories into a single configuration file and add it to the build. </p> <p> The configuration file is a .json file containing a single dictionary entry with the keyword <em> categoryDefinitions </em> . The entries are <em> name:description </em> pairs, where <em> name </em> is the name of the category that can be used in the .ogn file and <em> description </em> is a short description of the function of node types within that category. </p> <p> Here is the file that would implement the above two custom categories: </p> ```json { "categoryDefinitions": { "$description": "These categories are applied to nodes in MyProject", "light": "Nodes implementing lights for rendering", "night": "Nodes implementing all aspects of nighttime" } } ``` ```markdown <div class="admonition tip"> <p class="admonition-title"> Tip </p> <p> As with regular .ogn file any keyword beginning with a “ <em> $ </em> ” will be ignored and can be used for documentation. </p> </div> <p> If your extension is building within Kit then you can install your configuration into the build by adding this line to your <em> premake5.lua </em> file: </p> ```lua install_ogn_configuration_file("MyProjectCategories.json") ``` ```markdown <p> This allows you to reference the new category list directly from your .ogn file, expanding the list of available categories using the .ogn keyword <em> categoryDefinitions </em> : </p> ```json { "MyNodeWithOneCustomCategory": { "version": 1, "categoryDefinitions": "MyProjectCategories.json", "categories": "light", "description": "Empty node with one custom category" } } ``` ```markdown <p> Here, the predefined category list has been expanded to include those defined in your custom category configuration file, allowing use of the new category name without an explicit definition. </p> <p> If your extension is independent, either using the Kit SDK to build or not having a build component at all, you can instead reference either the absolute path of your configuration file, or the path relative to the directory in which your .ogn resides. As with categories, the definition references can be a single value or a list of values: </p> ```json { "MyNodeWithOneCustomCategory": { "version": 1, "categoryDefinitions": ["myConfigDirectory/MyProjectCategories.json", "C:/Shared/Categories.json"], "categories": "light", "description": "Empty node with one custom category" } } ``` ```markdown <section id="category-access"> <h3> Category Access </h3> <p> Access to the existing categories in C++ is done through the <code> <span class="pre"> omni::graph::core::INodeCategories_abi </span> </code> class. In Python you use the bind to that interface in <code> <span class="pre"> omni.graph.core.INodeCategories_abi </span> </code> . </p> </section> </section> </section> </div> </div> <footer> <hr/> </footer> </div> </div> </section> </div>
changed_CHANGELOG.md	# Changelog All notable changes to this project will be documented in this file. The format is based on Keep a Changelog, and this project adheres to Semantic Versioning. ## [107.0.0] - 2024-03-11 ### Changed - Initial version
changelog-omni-example-cpp-omnigraph-node_CHANGELOG.md	# Changelog ## [1.0.2] - 2024-01-02 ### Updated - Build against Kit 105.2 ## [1.0.1] - 2023-04-27 ### Updated - Build against Kit 105.0 ## [1.0.0] - 2022-08-15 ### Added - Initial implementation.
changelog-omni-graph-action-core_CHANGELOG.md	# Changelog All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ## [1.1.6] - 2024-02-27 ### Changed - Removed usd dependency ## [1.1.5] - 2024-01-30 ### Fixed - bug canceling action latent node ## [1.1.4] - 2023-12-20 ### Changed - Modify ActionContainerGraphDef’s executor to use the SafeDispatch scheduling strategy. ## [1.1.3] - 2023-11-29 ### Fixed - Added validity checks to ensure node type is still active when scheduling ## [1.1.2] - 2023-11-01 ### Fixed - Potential crash using dependency folding ## [1.1.1] - 2023-10-18 ### Changed - Using the added ‘canEvaluate’ ABI from core ## [1.1.0] - 2023-09-28 ### Add IActionGraphNodes ## [1.0.0] - 2023-08-10 ### Move IActionGraph from omni.graph.action
changelog-omni-graph-action-nodes_CHANGELOG.md	# Changelog This document records all notable changes to the omni.graph.action_nodes extension. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ## [1.22.2] - 2024-04-17 ### Added - Add a ‘support_level’ entry to the configuration file of the extensions ## [1.22.1] - 2024-04-10 ### Changed - Fix for onkeyboardinput test ## [1.22.0] - 2024-04-10 ### Changed - Bumped dependency on omni.graph to version 1.139.0 - Bumped dependency on omni.graph.core to version 2.177.1 - Bumped dependency on omni.graph.tools to version 1.77.0 ## [1.21.1] - 2024-04-08 ### Changed - Removed dependency on stage_templates and pipapi. ## [1.21.0] - 2024-03-18 ### Changed - Bumped dependency on omni.graph.core to version 2.176.3 - Bumped dependency on omni.graph to version 1.138.1 ## [1.20.1] - 2024-02-22 ### Changed - Turn off hotkeys in with_window test ## [1.20.0] - 2024-02-15 ### Fixed - Filtered out a known test failure ### Changed - Bumped dependency on omni.graph.core to version 2.174.2 - Bumped dependency on omni.graph.tools to version 1.76.1 ## [1.19.0] - 2024-02-05 ### Changed - Replace fabric::kInvalidTime with the newer name, fabric::kInvalidRationalTime. ## [1.18.1] - 2024-02-03 ### Changed - Bumped minimum omni.graph.core extension version dependency to be compatible with changes to the INodeType interface and lazy graph executor. ## [1.18.0] - 2024-01-31 ### Changed - Bumped dependency on omni.graph to version 1.137.0 - Bumped dependency on omni.graph.core to version 2.171.1 - Bumped dependency on omni.graph.tools to version 1.76.0 ## [1.17.0] - 2024-01-30 ### Changed - Bumped dependency on omni.graph to version 1.136.1 - Bumped dependency on omni.graph.core to version 2.170.1 - Bumped dependency on omni.graph.tools to version 1.74.0 ## [1.16.1] - 2024-01-26 ### Changed - Fixed bug in OnMessageBusEvent where it would unexpectedly trigger after graph reset ## [1.16.0] - 2024-01-23 ### Changed - Bumped dependency on omni.graph to version 1.136.0 ## [1.15.1] - 2024-01-22 ### Fixed - Made node type and attribute descriptions consistent and informative ## [1.15.0] - 2024-01-18 ### Changed - Bumped dependency on omni.graph.core to version 2.169.1 - Bumped dependency on omni.graph to version 1.135.1 - Bumped dependency on omni.graph.tools to version 1.73.0 ## [1.14.1] - 2024-01-13 ### Fixed - Repository URL in config file. ## [1.14.0] - 2024-01-12 ### Changed - Bumped dependency on omni.graph to version 1.134.7 - Bumped dependency on omni.graph.core to version 2.169.0 - Bumped dependency on omni.graph.tools to version 1.70.0 ## [1.13.1] - 2024-01-02 ### Changed - Add –no-window arg to tests ## [1.13.0] - 2023-12-28 ### Changed - Bumped dependency on omni.graph.tools to version 1.69.0 ## [1.12.0] - 2023-12-28 ### Changed - Bumped dependency on omni.graph.core to version 2.167.0 - Bumped dependency on omni.graph to version 1.134.2 ## [1.11.0] - 2023-12-18 ### Removed - Display of OnImpulseEvent’s ‘enableImpulse’ attribute in the ‘State’ section of the Property Window. ### Added - A ‘Send Impulse’ button to OnImpulseEvent’s ‘Inputs’ section of the Property Window. ## [1.10.0] - 2023-12-18 ### Changed - Bumped dependency on omni.graph.core to version 2.166.0 - Bumped dependency on omni.graph to version 1.134.0 - Bumped dependency on omni.graph.tools to version 1.65.0 ## [1.9.2] - 2023-12-18 ### Changed - Improve ForEach node error handling ## [1.9.1] - 2023-12-15 ### Changed - Minor change to improve code safety ## [1.9.0] - 2023-12-12 ### Changed - Bumped dependency on omni.graph.core to version 2.165.3 - Bumped dependency on omni.graph to version 1.133.2 - Bumped dependency on omni.graph.tools to version 1.65.0 ## [1.8.0] - 2023-12-11 ### Changed - Bumped dependency on omni.graph.core to version 2.165.3 - Bumped dependency on omni.graph to version 1.133.2 - Bumped dependency on omni.graph.tools to version 1.65.0 ## [1.7.2] - 2023-12-07 ### Changed - Fixed a bug related to string payload in SendMessageBusEvent ## [1.7.1] - 2023-12-06 ### Changed - Improve message bus node docs ## [1.7.0] - 2023-12-01 ### Changed - Add a test for attribute removal handling ## [1.6.5] - 2023-11-30 ### Changed - Set the minimal omni.graph.core version required in order to properly load that extension ## [1.6.4] - 2023-11-28 ### Changed - Changed deprecated internal state functions to their new version ## [1.6.3] - 2023-11-20 ### Changed - Use newer, stable INodeTypeForwarding2 ONI. ## [1.6.2] - 2023-11-09 ### Changed - Ran the formatter ## [1.6.1] - 2023-11-01 ### Changed # [1.5.1] - 2023-10-31 ## Changed - Built against kit-sdk version 132791 # [1.5.0] - 2023-10-26 ## Changed - Added c++ implementation for OnMessageBusEvent ## Added - SendMessageBusEvent node # [1.4.0] - 2023-10-05 ## Changed - Restore action nodes to .action from .action_nodes for forward-compatibility # [1.3.5] - 2023-09-22 ## Changed - Fix crash related to OnGamepadInput # [1.3.4] - 2023-09-07 ## Changed - replace VariableNameModel as VariableNameListModel # [1.3.3] - 2023-09-07 ## Changed - OnStageEvent will react with 1 frame less relative to source event # [1.3.2] - 2023-08-25 ## Changed - Fixed write to target flag # [1.3.1] - 2023-08-24 ## Changed - Rename ApplicationExit to ExitApplication # [1.3.0] - 2023-08-23 ## Changed - Add Application Exit node # [1.2.1] - 2023-08-18 ## Fixed - Placement and delivery of icon and preview images # [1.2.0] - 2023-08-18 ## Changed - migrate from kit repo # [1.1.0] - 2023-08-17 ## Changed - Moved extension repo # [1.0.0] - 2023-07-14 ## Added - Moved nodes from omni.graph.action
changelog-omni-graph-action_CHANGELOG.md	# Changelog This document records all notable changes to the omni.graph.action extension. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ## [1.101.1] - 2024-04-17 ### Added - Add a ‘support_level’ entry to the configuration file of the extensions ## [1.101.0] - 2024-02-09 ### Changed - Updated version number to work after the Kit branch was renamed from 105.2 to 106. ## [1.59.1] - 2024-01-13 ### Fixed - Repository URL in config file. ## [1.59.0] - 2023-12-15 ### Changed - Manually bumped the version number to be higher than the one in the 105.1 branch so that it takes priority ## [1.54.3] - 2023-12-15 ### Changed - Add python coverage to omni.graph.action ## [1.54.2] - 2023-08-25 ### Changed - Fixed write to target flag ## [1.54.1] - 2023-08-18 ### Fixed - Placement and delivery of icon and preview images ## [1.54.0] - 2023-08-18 ### Changed - migrate from kit repo ## [1.53.0] - 2023-08-17 ### Changed - Moved extension repo ## [1.52.0] - 2023-08-14 ### Changed - Move nodes out of extension into omni.graph.action_nodes, move ABI into omni.graph.action_core ## [1.51.0] - 2023-07-27 ### Changed - Added reset pin to MultiGate ## [1.50.2] - 2023-07-21 ### Changed - Renamed Node::createForDef references to Node::create. ## [1.50.1] - 2023-07-14 ### Fixed - bug with compute-on-request nodes in subgraphs ## [1.50.0] - 2023-07-12 ### Changed - Removed omni.kit.async_engine dependency ## [1.49.0] - 2023-07-07 ### Changed - Latent chains of nodes will now be interrupted when their event node triggers. - Can be disabled with /ext/omni.graph.action/disableInterrupts ## [1.48.5] - 2023-06-30 ### Fixed - Crash when script node triggers a stage resync ## [1.48.4] - 2023-06-28 ### Fixed - Bug in how pre/post execute is called for AG container graph ## [1.48.3] - 2023-06-28 ### Changed - Use ISchedulingHints2 interface when checking for node purity status. ## [1.48.2] - 2023-06-27 ### Fixed - Refactored OmniGraph documentation to point to locally generated files ## [1.48.1] - 2023-06-27 ### Changed - Set up the extension to load python nodes and tests in parallel ## [1.48.0] - 2023-06-27 ### Changed - Islands of nodes are moved into independent graphs so they can be executed in parallel. Can be disabled with /ext/omni.graph.action/disableArchipelago ## [1.47.3] - 2023-06-22 ### Changed - Ignore constant nodes when construct Action Graph backend execution graph topology. - Modified unit test to account for fact that constant nodes will not be computed in Action Graphs. ## [1.47.2] - 2023-06-12 ### Fixed - Fix for instanced action graphs ## [1.47.1] - 2023-06-08 ### Fixed - test instability ## [1.47.0] - 2023-06-06 ## Changed - Subgraphs are now flattened for IR ## [1.46.0] - 2023-06-02 ### Changed - Converted nodes to use IActionGraph API ## [1.45.2] - 2023-05-31 ### Fixed - Support for partitioning of AG IR - Added DependencyFoldPass test partitioner ## [1.45.1] - 2023-05-31 ### Fixed - Adjusted the CRLF settings for the generated .md node table of content files ## [1.45.0] - 2023-05-29 ### Added - Regenerated node table of contents ## [1.44.2] - 2023-05-15 ### Removed - Removed old subgraph unit test. ## [1.44.1] - 2023-05-08 ### Fixed - Bug with Python code generator for BundleContents ## [1.44.0] - 2023-04-21 ### Fixed - OnObjectChanged with graph instancing ### Added - name input to OnObjectChanged ## [1.43.3] - 2023-04-20 ### Changed - Improved IActionGraph error handling ## [1.43.2] - 2023-04-12 ### Changed - Updated SetPrimActive ui ## [1.43.1] - 2023-04-11 ### Added - Links to C++ and Python ABI documentation - Table of documentation links for nodes in the extension ## [1.43.0] - 2023-04-05 ### Added - IActionGraph::getExecutionEnabled ## [1.42.0] - 2023-03-28 ### Fixed - Add target input to nodes that have a prim path input and prefer this to the path if both are provided ## [1.41.0] - 2023-03-26 ### Added - IActionGraph to replace legacy execution attribute workflow ## [1.40.0] - 2023-03-24 ### Changed - Updated OnObjectChanged to use new target type for prim input ## [1.39.0] - 2023-03-10 ## Fixed - Fix tests to handle target attributes ## [1.38.1] - 2023-03-16 ### Added - “threadsafe” scheduling hints to OgnOnObjectChange, OgnOnVariableChange, and OgnRationalTimeSyncGate nodes. ### Changed - OgnOnObjectChange and OgnOnVariableChange unit tests to utilize thread-safety test constructs since they are now marked threadsafe. ## [1.38.0] - 2023-03-10 ### Changed - OnStageEvent now ignores timeline pause and resume - Added omni.timeline dependency ## [1.37.6] - 2023-03-10 ### Changed - OGN tick uses fabric vectorized states instead of an internal state (x10 perf improvment) ## [1.37.5] - 2023-03-01 ### Fixed - Corner case related to fan-out of exec connections to a single node ## [1.37.4] - 2023-02-25 ### Changed - Modifed format of Overview to be consistent with the rest of Kit ## [1.37.3] - 2023-02-23 ### Fixed - A few Action Graph node unit tests that were failing/flaky. ## [1.37.2] - 2023-02-22 ### Added - Links to JIRA tickets regarding filling in the missing documentation ## [1.37.1] - 2023-02-22 ### Changed - Renamed omni.kit.exec references to omni.kit.exec.core ## [1.37.0] - 2023-02-22 ### Added - OnStageEvent handles new event - “Hierarchy Changed” ## [1.36.3] - 2023-02-21 ### Added - Unit tests for all Action Graph nodes that were missing them. - Threadsafety tests for threadsafe AG nodes using the ThreadsafetyTestUtils decorator. ### Changed - Moved some of the Action Graph integration tests out of omni.graph.test and into omni.graph.action because they fit in the latter extension better (i.e. some of the AG “integration” tests were really just testing specific AG node behavior and/or specific AG evaluation mechanics, and not broader integration with other nodes/ systems). ## [1.36.2] - 2023-02-19 ### Changed - Added label to the main doc page so that higher level docs can reference the extension - Tagged for adding links to node documentation ## [1.36.1] - 2023-02-17 ### Added - “threadsafe” scheduling hints to OgnBranch, OgnCounter, OgnDelay, OgnFlipFlop, OgnForEach, OgnForLoop, OgnGate, OgnMultigate, OgnMultisequence, OgnOnClosing, OgnOnGamepadInput, OgnOnImpulseEvent, OgnOnLoaded, OgnOnMouseInput, OgnOnPlaybackTick, OgnOnce, OgnSequence, ## OgnSwitchToken, and OgnSyncGate nodes. ### Changed #### Changed a CARB_LOG_ERROR_ONCE call to CARB_LOG_WARN_ONCE in OnGamepadInput.cpp. ### Removed #### Unnecessary headers in OnVariableChange.cpp. #### Excluded .ogn tests for OgnCounter, OgnFlipFlop, and OgnForLoop due to failing false-positive autogenerated threadsafety tests. ## [1.36.0] - 2023-02-10 ### Added #### New node GetGraphTargetId ### Fixed #### OnGamepadInput handling of button press ### Changed #### GraphTarget is now named “Get Graph Target” ## [1.35.3] - 2023-02-09 ### Fixed #### Ordering of dependency node compute for AG fan-out with shared dependencies ## [1.35.2] - 2023-02-08 ### Fixed #### Book-keeping in ActionNodeDef for add and remove of dynamic attributes ## [1.35.1] - 2023-02-07 ### Fixed #### OnVariableChange node now correctly takes into account instancing in its “onValueChangeCallback” ## [1.35.0] - 2023-02-02 ### Changed #### Adopted safe dispatch to stabilize execution of nodes computed for the first time. ## [1.34.2] - 2023-01-30 ### Changed #### Removed the kit-sdk landing page #### Moved all of the documentation into the new omni.graph.docs extension ## [1.34.1] - 2023-01-26 ### Fixed #### OnKeyboardInput to work with instancing #### bug in event node input dirtying logic ## [1.34.0] - 2023-01-24 ### Added #### Execution framework implementation of action graph evaluator ## [1.33.0] - 2023-01-11 ### Changed #### ABI calls to take into account instancing #### Few nodes implement vectorized computes ## [1.32.2] - 2022-12-21 ### Changed #### Refactored CUDA build to consolidate build functions and remove unnecessary rebuilds ## [1.32.1] - 2022-08-30 ### Fixed #### Linting errors ## [1.32.0] - 2022-08-17 ### Added #### Added OnVariableChange node [1.31.0] - 2022-08-16 ### Added - SwitchToken [1.30.1] - 2022-08-09 ### Fixed - Applied formatting to all of the Python files [1.30.0] - 2022-07-29 ### Changed - Add prim input to OnObjectChanged node [1.29.0] - 2022-07-29 ### Added - Support for relative image urls in UI widget nodes [1.28.1] - 2022-07-28 ### Fixed - Spurious error messages about ‘Node compute request is ignored because XXX is not request-driven’ [1.28.0] - 2022-07-26 ### Added - Placer node. - Added ReadWidgetProperty node [1.27.0] - 2022-07-26 ### Changed - Removed internal Placers from the widget nodes. [1.26.1] - 2022-07-25 ### Fixed - Various UI nodes were rejecting valid exec inputs like ENABLED_AND_PUSH [1.26.0] - 2022-07-22 ### Added - ‘style’ input attributes for Button, Spacer and Stack nodes. ### Fixed - WriteWidgetStyle was failing on styles containing hex values (e.g. for colors) [1.25.0] - 2022-07-20 ### Added - WriteWidgetStyle node [1.24.1] - 2022-07-21 ### Changed - Undo revert [1.24.0] - 2022-07-18 ### Added - Spacer node ### Changed - VStack node: - Removed all execution inputs except for create. - Added support for OgnWriteWidgetProperty. - inputs:parentWidgetPath is no longer optional. [1.23.0] - 2022-07-18 ### Changed - Reverted changes in 1.21.1 [1.22.0] - 2022-07-15 ### Added - WriteWidgetProperty node ### Changed ## [1.21.1] - 2022-07-15 ### Changed - Added test node TickN, modified tests ## [1.21.0] - 2022-07-14 ### Changed - Added +/- icons to Multigate and Sequence ## [1.20.0] - 2022-07-07 ### Added - Test for public API consistency ## [1.19.0] - 2022-07-04 ### Changed - OgnButton requires a parentWidgetPath. It no longer defaults to the current viewport. - Each OgnButton instance can create multiples buttons. They no longer destroy the previous ones. - widgetIdentifiers are now unique within GraphContext ## [1.18.1] - 2022-06-20 ### Changed - Optimized MultiSequence ## [1.18.0] - 2022-05-30 ### Added - OnClosing ## [1.17.1] - 2022-05-23 ### Changed - Changed VStack ui name to Stack ## [1.17.0] - 2022-05-24 ### Changed - Converted ForEach node from Python to C++ - Removed OnWidgetDoubleClicked ## [1.16.1] - 2022-05-23 ### Changed - Converted Counter node from Python to C++ ## [1.16.0] - 2022-05-21 ### Added - Removed OnGraphInitialize, added Once to replace ## [1.15.1] - 2022-05-20 ### Changed - Added direction input to VStack node to allow objects to stack in width, height & depth directions. - Button node uses styles to select icons rather than mouse functions. ## [1.15.0] - 2022-05-19 ### Added - OnGraphInitialize - triggers when the graph is created ### Changed - OnStageEvent - removed non-functional events ## [1.14.1] - 2022-05-19 ### Fixed - Fixed OgnOnWidgetValueChanged output type resolution ## [1.14.0] - 2022-05-17 ### Added - OnGraphInitialize - triggers when the graph is created ### Changed - OnStageEvent - removed non-functional events ## [1.13.0] - 2022-05-16 ### Added - Added Sequence node with dynamic outputs named OgnMultisequence ## [1.12.0] - 2022-05-11 ### Added - Node definitions for UI creation and manipulation - Documentation on how to use the new UI nodes - Dependencies on extensions omni.ui_query and omni.kit.window.filepicker(optional) ## [1.11.3] - 2022-04-12 ### Fixed - OnCustomEvent when onlyPlayback=true - Remove state attrib from PrintText ## [1.11.2] - 2022-04-08 ### Added - Added absoluteSimTime output attribute to the OnTick node ## [1.11.1] - 2022-03-16 ### Fixed - OnStageEvent Animation Stop event when only-on-playback is true ## [1.11.0] - 2022-03-10 ### Added - Removed `outputs::shiftOut`, `outputs::ctrlOut`, `outputs::altOut` from `OnKeyboardInput` node. - Added `inputs::shiftIn`, `inputs::ctrlIn`, `inputs::altIn` from `OnKeyboardInput` node. - Added support for key modifiers to `OnKeyboardInput` node. ## [1.10.1] - 2022-03-09 ### Changed - Made all input attributes of all event source nodes literalOnly ## [1.10.0] - 2022-02-24 ### Added - added SyncGate node ## [1.9.1] - 2022-02-14 ### Fixed - add additional extension enabled check for omni.graph.ui not enabled error ## [1.9.0] - 2022-02-04 ### Added - added SetPrimRelationship node ## [1.8.0] - 2022-02-04 ### Modified - Several event nodes now have `inputs:onlyPlayback` attributes to control when they are active. The default is enabled, which means these nodes will only operate when playback is active. ## [1.7.0] - 2022-01-27 ### Added - Added SetPrimActive node # [1.5.0] - 2022-01-25 ## Added - Added OnMouseInput node # [1.4.5] - 2022-01-24 ## Modified - Changed OnGamepadInput to use SubscriptionToInputEvents instead - Changed OnKeyboardInput to use SubscriptionToInputEvents instead # [1.4.4] - 2022-01-14 ## Fixed - categories for several nodes # [1.4.2] - 2022-01-05 ## Added - Added car customizer tutorial # [1.4.1] - 2021-12-20 ## Modified - Categories added to all nodes # [1.4.0] - 2021-12-10 ## Modified - GetLookAtRotation moved to omni.graph.nodes # [1.3.0] - 2021-11-22 ## Modified - OnStageEvent handles new stage events # [1.2.0] - 2021-11-10 ## Modified - OnKeyboardInput, OnCustomEvent to use INode::requestCompute() # [1.1.0] - 2021-11-04 ## Modified - OnImpulseEvent to use INode::requestCompute() # [1.0.0] - 2021-05-10 ## Initial Version
changelog-omni-graph-bundle-action_CHANGELOG.md	# Changelog ## [2.3.1] - 2024-04-17 ### Added - Add a ‘support_level’ entry to the configuration file of the extensions ## [2.3.0] - 2024-02-09 ### Changed - Updated version number to work after the Kit branch was renamed from 105.2 to 106. ## [2.2.1] - 2024-01-13 ### Fixed - Repository URL in config file. ## [2.2.0] - 2023-11-30 ### Added - Python module with basic testing ## [2.1.2] - 2023-11-28 ### Changed - Add test waiver ## [2.1.1] - 2023-11-20 ### Changed - Force fast shutdown for auto-generated test to address OM-113797. ## [2.1.0] - 2023-08-18 ### Changed - migrate omni.graph.action from kit repo ## [2.0.8] - 2023-08-14 ### Changed - Moved omni.graph.ui and omni.graph.nodes references to be local ## [2.0.7] - 2023-08-03 ### Changed - Targeted a specific version of the Kit SDK ## [2.0.6] - 2023-07-31 ## [2.0.5] - 2023-07-26 ### Changed - Standardized the format of the CHANGELOG ## [2.0.4] - 2023-07-14 ### Changed - Updated references to the UI nodes extension docs ## [2.0.3] - 2023-06-12 ### Changed - Moved files out of LFS for easier management ## [2.0.2] - 2023-05-26 ### Changed - Fixed the repo path in the extension configuration ## [2.0.1] - 2023-05-23 ### Changed - Fixed the repo path in the extension configuration ## [2.0.0] - 2023-05-18 ### Changed - Moved the extension over from the Kit SDK to the kit-omnigraph repo ## [1.4.0] - 2023-03-22 ### Fixed - Added missing extension to the bundle ## [1.3.4] - 2023-02-27 ### Changed - Reenable tests from omni.graph.bundle.action ## [1.3.3] - 2023-02-25 ### Changed - Modifed format of Overview to be consistent with the rest of Kit ## [1.3.2] - 2023-02-19 ### Changed - Added label to the main doc page so that higher level docs can reference the extension - Added links to the bundled extensions ## [1.3.1] - 2023-01-30 ### Changed - Removed the kit-sdk landing page - Moved all of the documentation into the new omni.graph.docs extension ## [1.3.0] - 2022-08-11 ### Removed - omni.graph.window.action dependency ## [1.2.0] - 2022-08-04 ### Removed - omni.graph.instancing dependency ## [1.1.1] - 2022-06-21 ### Fixed - Put docs in the README for the extension manager ## [1.1.0] - 2022-05-05 ### Removed - omni.graph.tutorials dependency # [1.0.0] - 2021-11-18 ## Changes - Created with initial required set of extensions
changelog-omni-graph-bundle-all_CHANGELOG.md	# Changelog ## [1.6.1] - 2024-04-17 ### Added - Add a ‘support_level’ entry to the configuration file of the extensions ## [1.6.0] - 2024-02-09 ### Changed - Updated version number to work after the Kit branch was renamed from 105.2 to 106. ## [1.5.2] - 2024-01-13 ### Fixed - Repository URL in config file. ## [1.5.1] - 2023-12-04 ### Changed - Increased the test timeout to avoid failure ## [1.5.0] - 2023-12-01 ### Changed - Added omni.graph.telemetry to the bundle ## [1.4.0] - 2023-11-30 ### Added - Python module with basic testing ## [1.3.1] - 2023-11-30 ### Changed - Increased the test timeout ## [1.3.0] - 2023-08-18 ### Changed - migrate omni.graph.action from kit repo ## [1.2.0] - 2023-08-14 ### Changed - Added omni.graph.ui to the bundle ## [1.1.0] - 2023-08-14 ### Changed - Added omni.graph.ui to the bundle # [1.0.3] - 2023-08-03 ## Changed - Added the newest extensions to the bundle dependencies # [1.0.2] - 2023-07-31 ## Changed - Targeted a specific version of the Kit SDK # [1.0.1] - 2023-07-26 ## Changed - Standardized the format of the CHANGELOG # [1.0.0] - 2023-07-22 ## Changed - Updated references to the UI nodes extension docs # [1.0.0] - 2023-07-22 ## Added - Created with initial set of migrated extensions
changelog-omni-graph-core_CHANGELOG.md	# Changelog All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ## [2.178.0] - 2024-04-22 ### Fixed - Threadsafe nodes have the correct CUDA device set on the host thread when executing concurrently. ### Added - Exposed the CUDA device ID used by OmniGraph in the ComputeGraph interface. ## [2.177.2] - 2024-04-09 ### Changed - Undo change that forces `flushFsd` to be invoked each time `ComputeGraphImpl::updateChangeProcessing` is called since this results in CoreAPI crashing. ## [2.177.1] - 2024-04-02 ### Changed - `flushFsd` always gets invoked when `ComputeGraphImpl::updateChangeProcessing` is called, even if there are no deferred tasks that need evaluation. ## [2.177.0] - 2024-03-22 ### Changed - OmniGraph queries the Renderer for the active CUDA device. ## [2.176.3] - 2024-03-07 ### Fixed - Fixed crash when calling Attribute::getDataOwningAttribute_abi on attribute with unknown type. ## [2.176.2] - 2024-02-29 ### Fixed - considerKitUpdateLoop interface was not being filled with the corresponding ABI implementation; this has been fixed. ## [2.176.1] - 2024-02-27 ### Fixed - OnConnectionTypeResolved now invoked when a dynamic attribute is removed. ## [2.176.0] - 2024-02-26 ### Added - Added the setting `--/app/omnigraph/disableUsdBacking` disable the loading of OmniGraph from USD. ## [2.175.2] - 2024-02-16 ### Changed - Skip OG pre-process tasks when OG itself is disabled from ticking in StageUpdate. - Force updateSimStepUsd (which is used by DriveSim to on-demand execute OG) to explicitly run the required pre-process tasks in the sim thread before actual evaluation. ## [2.175.1] - 2024-02-15 ### Fixed - Added back the accidentally-deleted implementation for considerKitUpdateLoop (which was replaced at the time with a no-op for local testing purposes, but wasn’t reverted prior to merging). ## [2.175.0] - 2024-02-14 ### Added - Added new node ABI computeCuda, supported in the pre and post render graph nodes. ## [2.174.2] - 2024-02-13 ### Changed - Removed GraphPipelineGuard in favor of explicitly grabbing mutex locks when accessing orchestration graphs. - Acquire all orchestration graph mutexes with std::scoped_lock prior to invoking any methods that iterate over all orchestration graphs; helps to prevent deadlocks in multithreaded simulation environments (e.g., DriveSim2). ## [2.174.1] - 2024-02-08 ### Fixed - OM-119859 Remove RuntimeAttributes from database by name instead of by handle ## [2.174.0] - 2024-02-01 ### Fixed - Modified type created by BundlePrim::addRelationship to be a relationship rather than a token[]. ## [2.173.0] - 2024-01-31 ### Added - Ability for OG nodes to register custom ONI implementations and to query said interfaces via INodeType. - New IDirtyable interface to allow OG nodes to communicate with the lazy graph executor in a customized fashion. ### Changed - Cleaned up the lazy graph executor to utilize the new IDirtyable interface rather than having hard-coded logic for handling specific node types. ## [2.172.0] - 2024-01-31 ### Added - = and <= operators to FileFormatVersion ## [2.171.1] - 2024-01-29 ### Removed - Workaround that prevented a crash caused by thread safety issue in the Fabric change tracking system, which is now fixed ## [2.171.0] - 2024-01-25 ### Fixed - Bundle asymmetry issue, outputs:bundle and state:bundle renamed to outputs_bundle and state_bundle ## [2.170.1] - 2024-01-22 ### Changed ## [2.170.0] - 2024-01-18 ### Changed - Renamed PullGraphDef to LazyGraphDef. - Miscellaneous refactorings surrounding the legacy OG scheduling/evaluation system clean-up. ### Removed - Legacy OG scheduling/evaluation systems. ## [2.169.2] - 2024-01-17 ### Changed - Move ComputeGraphImpl::updateChangeProcessing into its own pre-process task, rather than calling it during execution graph compilation/pre-execution. ## [2.169.1] - 2024-01-16 ### Removed - Duplicated implementation of bundle interface ## [2.169.0] - 2024-01-11 ### Fixed - Evaluating explicitly an auto-instancved graph now works as expected ### Added - AllowAutoInstancing graph option from the schema is now correctly managed ## [2.168.2] - 2024-01-10 ### Changed - OM-115855 Improve code coverage for bundles, exclude unsupported code and add unit tests ## [2.168.1] - 2024-01-09 ### Changed - OM-117492 Bundle implementation replace handles with reference counted fabric::Path ## [2.168.0] - 2023-12-20 ### Fixed - Added the ability for the OGN layer to not cache any pointers. OmniGraph now works with StageWithHistory with prim filtering disabled ## [2.167.1] - 2023-12-20 ### Deprecated - OM-116989 Soft-deprecate access to child bundles by index ## [2.167.0] - 2023-12-18 ### Changed - Reduced non-fatal problem from an error to a warning in order to fix tests ## [2.166.3] - 2023-12-14 ### Removed - Removes useless setting monitoring callback ## [2.166.2] - 2023-12-13 ### Fixed - Missing include + fixes some compile warning ## [2.166.1] - 2023-12-12 ### Fixed - Prevent crashing when using an invalid RuntimeAttribute ## [2.166.0] - 2023-12-11 ### Added - Allows to set custom fabric backing on target mapped attribute ## [2.165.3] - 2023-12-09 ## Added - OM-116247 Provide getBundle and getBundles overloaded functions for IBundleFactory ## [2.165.2] - 2023-12-08 ### Fixed - Fixed double6 incorrectly identified as an OGN type ## [2.165.1] - 2023-12-08 ### Changed - onConnectionTypeResolved callback now triggers when an dynamic extended attribute is created ## [2.165.0] - 2023-12-08 ### Fixed - objectId supported in extended types - bundle, target and execution explicitly excluded from ‘any’ or union types - timecode type works with resolvePartiallyCoupledAttributes - Attribute:setResolvedType allows for re-resolution of extended attributes - Attribute:setResolvedType(og.Type()) no longer unresolves other input attributes with extended types ## [2.164.4] - 2023-12-07 ### Fixed - Fixed target mapping and instancing out of order updates with Fabric Scene Delegate enabled ## [2.164.3] - 2023-12-06 ### Fixed - Crash when deleting a graph containing nodes of an extension that has been unloaded ## [2.164.2] - 2023-12-05 ### Changed - Post-process (formerly known as post-execute) tasks are now scheduled via the default ExecutionController. ## [2.164.1] - 2023-12-05 ### Fixed - OM-98247 Remove bundle portion from dirty ids implementation ## [2.164.0] - 2023-11-29 ### Changed - Log an error when registering a node built with a more recent framework than the one used in the running app ## [2.163.0] - 2023-11-29 ### Removed - Removed old and now unused code, and deprecated associated ABIs ## [2.162.1] - 2023-11-29 ### Fixed - Added validity checks to ensure node type is still active when scheduling ## [2.162.0] - 2023-11-28 ### Added - INodeType function definedAtRuntime to check if a node type was created at runtime ### Changed - Separated out INodeType into its own file ## [2.161.0] - 2023-11-24 ### Changed - Invalid connections now prevent nodes from evaluating and log errors during the compute phase ## [2.160.0] - 2023-11-23 ### Fixed - Do not call releaseInstance on the authoring graph ## [2.159.0] - 2023-11-22 ## Added - Added ABIs for Attribute::isPassthrough and Attribute::getDataOwningAttribute ## [2.158.0] - 2023-11-21 ### Fixed - Keep a reference to target paths as token, so it remains the same ## [2.157.4] - 2023-11-21 ### Changed - Cleaned up unused code paths ## [2.157.3] - 2023-11-20 ### Changed - Updated getINodeTypeForwarding to use the most up-to-date interface (V2). ## [2.157.2] - 2023-11-17 ### Added - Added templated version of GenericNodeDefT execution node ## [2.157.1] - 2023-11-17 ### Changed - Improved code coverage for compound nodes. ### Fixed - Fixed compound node types not responding to API additions & removes from USD ## [2.157.0] - 2023-11-17 ### Added - Callbacks to the node interface to init/release a graph instance - Plugged that feature into the OGN framework - Ability to access internal state through instance index as well as instance ID ## [2.156.0] - 2023-11-13 ### Removed - Retires deprecated ABI related to schedule node and associated features - Removes dead code ### Fixed - Fixed small bugs revealed by improved code coverage ### Changed - Exclude some safety error path code from code coverage ## [2.155.1] - 2023-11-09 ### Added - Support for testing of the graph registry ### Fixed - A few miscellaneous pointer check issues ## [2.155.0] - 2023-11-08 ### Fixed - Authoring graph and default instance now have a different unique ID (allows shared internal state and per instance one to be distinct for example) ## [2.154.4] - 2023-11-08 ### Fixed - Small fix when trying to access a graph target with an invalid index ## [2.154.3] - 2023-11-06 ### Fixed - Small fixes for bugs revealed by increased test code coverage ## [2.154.2] - 2023-11-05 ### Added ## [2.154.1] - 2023-11-02 ### Changed - Added error checks for invalid node prims ## [2.154.0] - 2023-11-02 ### Added - Ability to run C++ unit tests through Kit unit test framework ### Fixed - Casts for pxr::GfHalf types that did not work ### Changed - Moved disabled unit tests to the new framework and enabled them ## [2.153.4] - 2023-11-01 ### Fixed - Infinite loop when using path attribute with an inexisting relative path ## [2.153.3] - 2023-10-30 ### Fixed - Potential crash with math operations on arrays ## [2.153.2] - 2023-10-24 ### Fixed - Invalid access errors occurring in omni.graph.tests in debug mode ## [2.153.1] - 2023-10-24 ### Fixed - Unmapping of attribute that are in a deferded mapping state ## [2.153.0] - 2023-10-20 ### Changed - Upgraded to latest OmniGraphSchema. Changed references to use latest Compound Node Type schema ## [2.152.3] - 2023-10-20 ### Changed - Runtime attribute do not prefetch pointers when using the ‘any’ type of memory - Bundle attribute insertion does not remove target attribute if it is compatible (instead of perfect type equality) ## [2.152.2] - 2023-10-19 ### Fixed - Fix crash when accessing invalid variables ## [2.152.1] - 2023-10-18 ### Fixed - Made UniqueQueue thread safe. ## [2.152.0] - 2023-10-18 ### Added - Ability to map a node attribute directly to a target attribute - Ability to bind a ‘prim view’ to a graph, an object that is responsible to return a collection of prims that are used to populate the instances - Execution of push graphs can now take into account various vectorized segment size per node, and multithread them - Ability to retrieve the vectorized target list as path as well as token ## [2.151.3] - 2023-10-17 ### Fixed - Fixed crash on exit on scenes that use Path attributes types ## [2.151.2] - 2023-10-17 ## Changed - Batched node instantiation to speed up the stage attach. ## [2.151.1] - 2023-10-16 ### Fixed - Update issue with type resolution of dynamic attrs. OM-108200 ## [2.151.0] - 2023-10-13 ### Added - Safety checks for nodes with unregistered node types - Execution graph topology change notification when node types that are in use are deregistered ## [2.150.3] - 2023-10-11 ### Changed - Fixed nodes in a compound graph not having InternalState data properly removed ## [2.150.2] - 2023-10-10 ### Changed - Added extra information to the node type forwarding error message to make them easier to correlate ## [2.150.1] - 2023-10-04 ### Fixed - Graph USD changes are processed on main thread to fix hangs that can occur when extensions with USD notice handlers are loaded. ## [2.150.0] - 2023-10-02 ### Changed - Upgraded Compound Node Types to use latest OmniGraph USD compound schema ## [2.149.3] - 2023-09-27 ### Changed - Skip parsing compound node graphs during stage attach. ## [2.149.2] - 2023-09-22 ### Changed - Replaced Usd.Stage traversals with usdrt queries to speed up the stage attach phase. ## [2.149.1] - 2023-09-21 ### Fixed - Prevent useless allocation and copy on the stack when setting an attribute value from python ## [2.149.0] - 2023-09-21 ### Changed - OM-110007 Fix graph instances removal ## [2.148.2] - 2023-09-18 ### Changed - OM-108141 Fix bump bundle dirty id for write flag for getArraySizes for CPU and GPU ## [2.148.1] - 2023-09-13 ### Fixed - OmniGraph global time update logic for DriveSim-specific animation. ## [2.148.0] - 2023-09-11 ### Added - New BundleWriteBlock API to minimize the number of bundles that are made dirty during the lifetime of the block ## [2.147.4] - 2023-09-08 ### Fixed - Creating attribute with a default value not properly setting the default in all situations - Setting a default value was not working for all types ## [2.147.3] - 2023-09-08 ### Changed - Make sure that OGN overrides are called before removing them when an extension with a python node is unloaded. ## [2.147.2] - 2023-09-07 ### Changed - Fix crash that can occur setting default data from a USD attribute ## [2.147.1] - 2023-09-06 ### Fixed - Execution types always write out their type to custom metadata ## [2.147.0] - 2023-09-06 ### Removed - Serialization data: OG prims are not synched to fabric anymore - `resolved` tag on extended attributes ### Changed - The way default data is stored, and can be modified using ### Added - setDefaultValue ABI ## [2.146.0] - 2023-08-31 ### Added - Officially supported interface for node type forwarding ### Fixed - Faulty cycle detection and access of null pointer strings ## [2.145.3] - 2023-08-25 ### Changed - Nodes inside a compound now ignore cross-graphs connections to a non-compound nodes. ## [2.145.2] - 2023-08-24 ### Added - An extra execution graph compilation step for DriveSim2’s updateSimStepUsd_abi method. ## [2.145.1] - 2023-08-23 ### Fixed - Uninitialized dirty ids would cause bundles and attributes to be put into the change tracking cache, thus produce per-frame cleanup overhead. ## [2.145.0] - 2023-08-17 ### Added - Added an execution node in OmniGraph for the rendering execution graph. ## [2.144.3] - 2023-08-15 ### Fixed - Auto instancing managment on reload_from_stage ## [2.144.2] - 2023-08-10 ### Fixed - Resolution errors when renaming ports on subgraphs ## [2.144.1] - 2023-08-04 ### Fixed - OM-100540 Bug fix - nodes during graph removal could traverse through deleted instances ## [2.144.0] - 2023-07-31 ### Fixed - Added missing null pointer checks to avoid crash on exit ## [2.143.0] - 2023-07-30 ### Added - Node type forwarding for the core GPU interop nodes ## [2.142.0] - 2023-07-25 ### Changed - Revert output and state bundle name space separator to underscore ## [2.141.0] - 2023-07-21 ### Removed - References to obsolete node types ## [2.140.7] - 2023-07-21 ### Changed - Renamed Node::createForDef references to Node::create. ## [2.140.6] - 2023-07-19 ### Changed - Added more profiler tags for the stage attach phase. ## [2.140.5] - 2023-07-18 ### Changed - OM-101615 Suppress Fabric warnings when bundles are removed ## [2.140.4] - 2023-07-18 ### Changed - OM-97363 Bundle asymmetry - file format update use UsdRt to traverse primitives ## [2.140.3] - 2023-07-17 ### Changed - OM-97363 Bundle asymmetry - update connect and disconnect prim ## [2.140.2] - 2023-07-17 ### Removed - References to migrated tutorials node types ## [2.140.1] - 2023-07-14 ### Fixed - Graph::ReloadFromStage preserves instance references ## [2.140.0] - 2023-07-13 ### Changed - OM-97363: Resolve input-output bundle asymmetry ## [2.139.6] - 2023-07-13 ### Removed - Removed the “defaultEvaluator” and “useCachedConnectionsForFileLoad” OG settings. ## [2.139.5] - 2023-07-12 ### Fixed - Resolved types now serialize correct values in compound graphs ## [2.139.4] - 2023-07-11 ### Changed - Compound Subgraphs are created with no_delete metadata ## [2.139.3] - 2023-07-06 ### Changed - Improved performance for `IBundle2::createAttribute` by skipping the existing attribute(s) ## [2.139.2] - 2023-07-06 ### Changed - Improved performance for `IBundle2::createAttribute` by skipping the existing attribute(s) ## Changed - DM_ASSERT is using CARB_ASSERT when DataModel debug is off ## [2.139.1] - 2023-06-30 ### Changed - Refactor all code regarding graph runtime data in its own class ## [2.139.0] - 2023-06-28 ### Added - New ISchedulingHints2 ABI that extends ISchedulingHints by including functionality for the new “pure” scheduling hint. ## [2.138.1] - 2023-06-28 ### Fixed - Added the generated code support files to the C API documentation ## [2.138.0] - 2023-06-27 ### Changed - OM-99661 Materialize attribute before resizing ## [2.137.1] - 2023-06-27 ### Changed - Replaced C17 std::same_v<> with C14 std::same<>::value ## [2.137.0] - 2023-06-26 ### Changed - OM-98519: Do not allow bundle to target connection ## [2.136.0] - 2023-06-23 ### Added - New “pure” scheduling hint for OG nodes. ### Changed - Ignore constant nodes in Push Graphs when constructing their backend execution graph topology. ## [2.135.5] - 2023-06-23 ### Changed - OM-99356 Remove C++17 features from IDirtyID2 header file. ## [2.135.4] - 2023-06-22 ### Fixed - OM-99127 bundle change tracking do not bump dirty ids for attributes that already exist ## [2.135.3] - 2023-06-22 ### Fixed - Fixed crash when renaming a compound graph ## [2.135.2] - 2023-06-22 ### Changed - Prevent creating USD scene-graph-instanced graph (which are not correctly supported), and log a warning ## [2.135.1] - 2023-06-21 ### Changed - Prevent creating USD scene-graph-instanced graph (which are not correctly supported), and log a warning ## [2.135.0] - 2023-06-21 ### Fixed - Compute messages are now thread safe ### Changed - Compute messages are now tagged with the instance emitting them - Compute messages are now managed at the graph level, not at the node level anymore ## [2.134.0] - 2023-06-20 ## Added - Change Tracking for bundles ## [2.133.2] - 2023-06-20 ### Changed - Global flag set on the Graph to warn that evaluation is in progress, instead of relying on the task TLS ### Removed - Old leftover of the “is in evaluation” tracking ## [2.133.1] - 2023-06-19 ### Fixed - Crash when preparing a graph that has no fabric cache attached ## [2.133.0] - 2023-06-14 ### Fixed - Attributes that don’t have a USD value don’t get properly initialized ### Changed - OGN defaults are not set to USD anymore ## [2.132.2] - 2023-06-09 ### Fixed - OM-97928: enable docs generation for bundles. ## [2.132.1] - 2023-06-08 ### Changed - temporarily disable auto-instancing for action graph ## [2.132.0] - 2023-06-06 ### Changed - Use `bundle__private` prefix to make attributes private in a bundle ## [2.131.3] - 2023-06-05 ### Fixed - Log error when graph.reloadFromStage is called from a subgraph ## [2.131.2] - 2023-06-02 ### Changed - `WritePrimsV2` node now supports exporting relationship. ## [2.131.1] - 2023-06-01 ### Fixed - removing an attributes from a node was not cleaning the associated runtime and serialization data - Node removed then re-added to an empty graph was keeping its old values ## [2.131.0] - 2023-06-01 ### Added - IGraph::getOwningCompoundNode ABI ## [2.130.0] - 2023-05-31 ### Added - Double underscored attributes in a bundle are private ## [2.129.7] - 2023-05-30 ### Fixed - Fixed PrivateNodeDef and PrivateNodeGraphDef to correctly handle EF partition passes in instanced OG graphs. ## [2.129.6] - 2023-05-29 ### Removed - Obsolete node registration since there are no nodes in this extension ### Changed - Used Fabric token and path text converters rather than the direct USD ones ### [2.129.5] - 2023-05-29 #### Fixed - Invoking the changelog script without a console attached ### [2.129.4] - 2023-05-26 #### Added - Added `registerForUSDWriteBacksToLayer` function to support USD writeback to a local layer. ### [2.129.3] - 2023-05-26 #### Added - Support for attribute in OGN that have `any` or `union` as type, and `any` as memory type #### Fixed - Runtime attribute with `any` memory type ### [2.129.2] - 2023-05-25 #### Fixed - Fixed errors when promoting bundle attributes to compounds ### [2.129.1] - 2023-05-24 #### Changed - Moved s_settingsDefaultEvaluator and s_settingsUseCachedConnectionsForFileLoad to the list of hard-deprecated OG settings. ### [2.129.0] - 2023-05-24 #### Removed - Removed the FallbackGraphDef, FallbackInstancedGraphDef, and StaticScheduler. - Removed the “pull” and “execution_pull” modes from the PullEvaluator. ### [2.128.2] - 2023-05-24 #### Fixed - Reset as early as possible broken array attribute reference ### [2.128.1] - 2023-05-23 #### Removed - Removed some OG settings that were referencing now-deleted legacy systems (using the dynamic/realm static schedulers). ### [2.128.0] - 2023-05-19 #### Added - Copy child bundle python bindings and unit tests. ### [2.127.0] - 2023-05-19 #### Added - Fix copy attribute’s metadata when copying attributes by name. ### [2.126.0] - 2023-05-18 #### Removed - Removed some of the legacy evaluators/schedulers, more specifically the DynamicScheduler, RealmStaticScheduler, ExecutionScheduler, and ExecutionEvaluator. ### [2.125.0] - 2023-05-18 #### Changed - OM-94464 IBundle use Bundle Data Model. ### [2.124.0] - 2023-05-18 #### Fixed - Runtime attribute with `any` memory type ## Added - Auto instancing now provides the actual node and graph that the instance refers to - Auto instancing now properly keep the data (including bundles) when an auto instance get (un)merged - OG natvis ## Changed - Perf for adding/removing/merging instances - Bundle python functions takes the instance index ## [2.123.2] - 2023-05-16 ### Changed - Fixed issue where compounds attributes are incorrectly identified ## [2.123.1] - 2023-05-15 ### Fixed - Ghost data when disconnecting an attribute ## [2.123.0] - 2023-05-12 ### Added - EF support for non-instanced/standalone graphs running with the OnDemand pipeline. ## [2.122.6] - 2023-05-11 ### Fixed - Allow bundles to re-create attributes with 0 size ## [2.122.5] - 2023-05-10 ### Fixed - Crash when adding a node to an instantiated graph ## [2.122.4] - 2023-05-10 ### Fixed - Manually resolved attribute type is now persisted to customData without a value change ## [2.122.3] - 2023-05-10 ### Changed - OM-94111: Improve copying bundles through BundleDataModel ## [2.122.2] - 2023-05-09 ### Fixed - OM-94114: BundleDataModel recursive children removal ## [2.122.1] - 2023-05-09 ### Fixed - type resolution bug where downstream connections where not being type checked ## [2.122.0] - 2023-05-08 ### Changed - CompoundSubgraphs share variables with their parent graph ## [2.121.0] - 2023-05-04 ### Changed - Compatibility with usd-ext-omnigraph 5.0.130, which adds OmniGraphSchema.CompoundNodeAPI schema - Upgraded USD file format to 1.7 ## [2.120.0] - 2023-05-03 ### Added - INode::getCompoundGraphInstance - Support for subgraph evaluator types which don’t match the parent graph ## [2.119.0] - 2023-05-02 ### Added - New interface class INodeTypeForwarding - Node type registry information to remember node type forwarding ### Changed - (No changes listed under this heading) - Moved all of the current renaming to their respective .ogn files ## [2.118.1] - 2023-05-02 ### Added - Added function constructInputFromOutput to construct an input RuntimeAttribute from an output. ## [2.118.0] - 2023-05-01 ### Added - Auto-instancing: similar graphs gets merged together as auto instances, and can be computed vectorized ## [2.117.3] - 2023-04-28 ### Fixed - CreateAttribute API adds proper metadata for target and objectID types ## [2.117.2] - 2023-04-27 ### Added - Cache lookups of the compound node type definitions ## [2.117.1] - 2023-04-26 ### Changed - All OG handles are now unique per object, and not recycled (not the pointer anymore) ## [2.117.0] - 2023-04-24 ### Added - Add special node type to represent compound subgraphs ## [2.116.3] - 2023-04-24 ### Fixed - Crash when deleting a graph with instances through the UI ## [2.116.2] - 2023-04-24 ### Fixed - Do not assert when trying to materialize a deleted array ## [2.116.1] - 2023-04-24 ### Added - Variation of the deprecation macro that outputs then name of the function it’s in ## [2.116.0] - 2023-04-21 ### Added - ArrayWrapper::empty ## [2.115.2] - 2023-04-20 ### Fixed - Crash related to creating child bundles ## [2.115.1] - 2023-04-20 ### Fixed - Fixed crash that can occur when a data copy fails ## [2.115.0] - 2023-04-19 ### Changed - Move children management to Bundle Data Model ## [2.114.0] - 2023-04-19 ### Deprecated - Removed all references to the obsolete settings constants ## [2.113.2] - 2023-04-17 ### Changed - Move old IDirtyID interface as refactoring process before new IDirtyID arrives. ## [2.113.1] - 2023-04-14 ### Changed - Move old IDirtyID interface as refactoring process before new IDirtyID arrives. ## Changed - Call ``` release ``` on node before removing them from their owning graph list of nodes ## [2.113.0] - 2023-04-13 ### Added - Unit tests to clear content of the bundle. ## [2.112.0] - 2023-04-12 ### Changed - Changed graph target path to be a relative path ## [2.111.0] - 2023-04-12 ### Changed - Introduce Bundle Data Model for IBundle2. ## [2.110.2] - 2023-04-11 ### Fixed - Take into account the graph disabled state in EF ## [2.110.1] - 2023-04-11 ### Changed - Refactored some duplicated EF-related code to use existing methods. ## [2.110.0] - 2023-04-06 ### Added - OmniGraphDatabase cache dynamic inputs, outputs and states. ## [2.109.2] - 2023-04-06 ### Changed - Using the new Fabric’s addAttributesToBucket which allows to add several atributes to a bucket at once ## [2.109.1] - 2023-04-05 ### Changed - IBundle2 clears metadata by default ## [2.109.0] - 2023-04-05 ### Added - Target types support the use of placeholder graph target prim ## [2.108.1] - 2023-04-04 ### Changed - IBundle and IBundle2 code cleanup ## [2.108.0] - 2023-04-03 ### Added - kInstancingGraphTargetPath ### Removed - Deprecated code from 2021 ## [2.107.0] - 2023-03-31 ### Changed - target attributes now use relationships with output and state ports ## [2.106.2] - 2023-03-30 ### Fixed - Loading input target attributes as outputOnly now maintain their connections when loaded ## [2.106.1] - 2023-03-29 ### Added - Added Fabric Type class to C++ docs ## [2.106.0] - 2023-03-29 ## Fixed - Disable the node type definitions when the extension implementing them is unloaded - Enable the node type definitions when the extension implementing them is loaded ## [2.105.3] - 2023-03-28 ### Fixed - Deleting a node or a graph was leaking its bundle attributes - Deleting a bundle was leaking its children - Serialization data was leaking empty bundle attribute - Deleting child bundles was deleting upstream bundles when passed by reference ## [2.105.2] - 2023-03-28 ### Fixed - Copy the default value from the indirect pointer for array attribute ## [2.105.1] - 2023-03-27 ### Changed - Added ability for target attributes to target bundle attributes ### Fixed - target attributes use correct port name in fabric ## [2.105.0] - 2023-03-24 ### Added - IVariable2 class with method for changing a variable type - IGraphEvent.eVariableTypeChanged event ## [2.104.0] - 2023-03-24 ### Added - added firstOrDefault accessor to ArrayAttribute helper ## [2.103.1] - 2023-03-24 ### Fixed - Crash in topology depth computation when having several cycles in the graph ## [2.103.0] - 2023-03-24 ### Removed - Deprecated code accessing the old Fabric interfaces ## [2.102.7] - 2023-03-23 ### Changed - Comments on PushGraphDef and PullGraphDef EF graph builders as to why single-node cycles are still (silently) not constructed in the corresponding IR. ## [2.102.6] - 2023-03-23 ### Added - Fixed node state being unnecessarily reset by changes to unrelated USD objects ## [2.102.5] - 2023-03-23 ### Fixed - Fix crash copying array attributes when restoring saved data from stage ## [2.102.4] - 2023-03-22 ### Changed - Improved children creation for bundles ## [2.102.3] - 2023-03-22 ### Fixed - Fabric restored from an older snapshot was making OG crash ## [2.102.2] - 2023-03-22 ### Fixed - Made all docstrings to publicly visible documentation consistent ## [2.102.1] - 2023-03-17 ### Changed - PushGraph and PullGraph executor visitation strategies to ignore cycles. - Silently disallow the creation of loops when the IR of PushGraphs and PullGraphs is being built in EF to prevent Kit app crash (temporary fix). ## [2.102.0] - 2023-03-17 ### Added - Implemented new target typed backed by relationships ## [2.101.5] - 2023-03-15 ### Added - Compute and maintain a topological depth integer on nodes ### Changed - Use the topoplogical depth to order type resolution ## [2.101.4] - 2023-03-13 ### Changed - Do not serialize default OGN value to USD ## [2.101.3] - 2023-03-10 ### Changed - Allows to change the type resolution of an attribute if the new one keeps auto-converison compatibility with upstream node ## [2.101.2] - 2023-03-10 ### Added - ABI to register several USD-write-backs at once ### Fixed - Graph::reset was missing some important cleanup ## [2.101.1] - 2023-03-09 ### Fixed - Prevent deepCopy of a variable value if it is badly typed in source data ## [2.101.0] - 2023-03-07 ### Added - Revert New BundleDataModel built on top of DataModel. ## [2.100.1] - 2023-03-07 ### Fixed - Variables now copy initial values instead of using connections to Fabric prims - Connections are updated when copying arrays in Fabric ## [2.100.0] - 2023-03-07 ### Added - New BundleDataModel built on top of DataModel. ## [2.99.1] - 2023-03-06 ### Added - Support for compute incomplete in pull graph def ## [2.99.0] - 2023-03-05 ### Added - CompoundNodeType reads default data from USD custom object data - IAttributeTemplate.getDefaultData() ## [2.98.1] - 2023-03-01 ### Added - updateChangeProcessing call to updateSimStepUsd_abi ### Fixed - Fixes DRIVESim 2 OG nodes to correctly be created and run with the hard deprecation of global implicit graphs. ## [2.98.0] - 2023-02-28 ### Added - og._flush_usd call to apply pending usd changes. ### Fixed - Improved compatibility when Fabric Scene Delegate is enabled. ## [2.97.9] - 2023-02-27 ### Fixed - Compute helper was not working correctly on a set of vectorized arrays ### Added - Allow access to data of a specific instance in python ## [2.97.8] - 2023-02-27 ### Fixed - Properly invalidates OGN databases when a new upstream connection is made to an existing upstream node ## [2.97.7] - 2023-02-25 ### Changed - Modifed format of Overview to be consistent with the rest of Kit ## [2.97.6] - 2023-02-23 ### Changed - BundleContents delays attribute cache creation until needed ## [2.97.5] - 2023-02-23 ### Fixed - ABI violation with OGN DBs ### Changed - OGN databases are not deleted on graph bucket reconfiguration - On topological changes, OGN databases are lazily deleted, threaded, at compute time ### Added - Protection of graph bucket reconstruction for concurrent accesses ## [2.97.4] - 2023-02-22 ### Added - Fixed instances not updated after stage frame rate changed ## [2.97.3] - 2023-02-22 ### Changed - Renamed omni.kit.exec references to omni.kit.exec.core ## [2.97.2] - 2023-02-21 ### Fixed - Python node in instantiated graph are now working ### Changed - Python node internal states are now per graph instance ## [2.97.1] - 2023-02-19 ### Changed - Added label to the main doc page so that higher level docs can reference the extension ## [2.97.0] - 2023-02-17 ### Changed - Soft deprecate INode::(de)registerPathChangedCallback ## [2.96.1] - 2023-02-15 ### Fixed - Type resolution propagation to not enter compound graphs ## [2.96.0] - 2023-02-15 ### Changed - Execution Framework backend is enabled by default ## [2.95.2] - 2023-02-14 ### Fixed - Don’t access invalid bucket in DataModel::copyAndWrite ## [2.95.1] - 2023-02-14 ### Changed - Graph reset function will make sure NodeGraphDef is invalidated by the end of the call ## [2.95.0] - 2023-02-13 ### Added - Support for stage update loop skipping in OmniGraphDef ## [2.94.0] - 2023-02-13 ### Added - Resetting of cuda device in OmniGraphDef to device:0 ## [2.93.0] - 2023-02-10 ### Changed - Soft deprecated `PrimHandle` ## [2.92.2] - 2023-02-010 ### Fixed - Ordering of dependency node compute for AG fan-out with shared dependencies ## [2.92.1] - 2023-02-09 ### Added - Gives access to underlying ABI handle in OGN SimpleAttribute ## [2.92.0] - 2023-02-09 ### Changed - Removed onAttributeChanged_abi, onNodeChanged_abi - PullGraphDef now checks for attribute changes in PullExecutionVisit ## [2.91.0] - 2023-02-08 ### Added - IAttributeTemplate metadata ABI calls ## [2.90.0] - 2023-02-08 ### Changed - SafeDispatch now uses Isolate scheduling constraint for nodes that execute first time. ## [2.89.1] - 2023-02-07 ### Changed - Don’t prepare a graph on target access unless absolutely necessary - While propagating type resolution, postpone the prepare of graph to the end ## [2.89.0] - 2023-02-06 ### Added - IAttributeTemplate and ICompoundNodeType interfaces in unstable namespace. - addExtendedInput, addExtendedOutput, addExtendedState can be overridden in custom INodeType ## [2.88.3] - 2023-02-06 ### Fixed - Set the proper instance index in the action graph executor before doing anything ## [2.88.2] - 2023-02-03 ### Fixed - (No content provided for this version) ## [2.88.1] - 2023-02-02 ### Fixed - Storing of OGN databases was not thread safe when running several instances of the same graph concurrently - Graph was not prepared when starting computation with EF ## [2.88.0] - 2023-02-02 ### Added - Introduced new safe dispatch to serialize granularily node on their first compute. ## [2.87.8] - 2023-01-31 ### Changed - Retrieving the nodes of a graph is now done by enumerating them instead of filling a provided container ## [2.87.7] - 2023-01-31 ### Removed - Workarounds added for initial EF implementation, not necesary anymore ## [2.87.6] - 2023-01-30 ### Added - Ability to schedule full vectorized batches through EF for instantiated pushgraph ## [2.87.5] - 2023-01-30 ### Changed - Removed the kit-sdk landing page - Moved all of the documentation into the new omni.graph.docs extension - Added support for doxygen generation of a subset of the ABI - Created a minimal landing page for the core functionality ## [2.87.4] - 2023-01-30 ### Fixed - Different role in runtime attribute won’t prevent vectorization anymore ### Added - Ability to access proper variable in a vectorized loop ## [2.87.3] - 2023-01-27 ### Fixed - Prevent copy error by not triggering USD notice handler when setting initial value while creating an attribute ## [2.87.2] - 2023-01-27 ### Fixed - Fix crash when adding an instance to an empty graph ## [2.87.1] - 2023-01-26 ### Fixed - Fix regression - release was not called on node when destroyed through USD notice handler ## [2.87.0] - 2023-01-26 ### Changed - NodeDef’s are created with type name returned by getTypeName instead of getNodeType ## [2.86.2] - 2023-01-25 ### Fixed - Fix regression - release was not called on node when destroyed through ABI ## [2.86.1] - 2023-01-20 ### Fixed - When disconnecting an attribute, modify the topology BEFORE modifying USD so notice handler can operate on an up-to-date authoring graph ## [2.86.0] - 2023-01-20 ### Changed - NodeDef’s are created with type name returned by getTypeName instead of getNodeType ## Added - INode::getAttributeChangeStamp - IGraphEvent::eClosing, IGraphEvent::eComputeRequested - IGenericNodeGraphDef_abi::inspect_abi - IExecutor::continueExecute_abi ## Fixed - Locking logic in ExecutionContext::applyOnEach ## Changed - action evaluator logic for requestCompute, OnClosing and request-driven node dirty based on attribute changes ## [2.85.2] - 2023-01-18 ### Changed - Isolates AttributeData interface in its own file - Restore RuntimeAttribute RO-array-accessor returning const_array instead of const_array ## [2.85.1] - 2023-01-17 ### Fixed - Push back to usd was called too often, for instantiated graphs and subgraph ## [2.85.0] - 2023-01-11 ### Added - Internal API calls to validate attribute name ## [2.84.1] - 2023-01-11 ### Added - Profiler instrumentation to OmniGraphDef ## [2.84.0] - 2023-01-11 ### Added - Native support for vectorization compute in nodes - Ability to index a given instance in OGN database and wrappers - All OGN attributes now also have a vectorized(count) accessor which returns a span<>, and allows an efficient loop/SIMD ### Fixed - Default values for states were not taken into account - Few places were not properly treating relationship attribute as array of paths - Bundle attributes are now all typed as eRelationship (no ePrim anymore) ### Removed - Gather prototype is gone ### Changed - Runtime data is stored in a unique fabric bucket managed by the graph - Variables are now stored in this bucket - Each instance has its own set of data - The GraphContext now has an index which references the current active instance - Compute helpers now support vectorization, are more efficient, and are variadic (any number of parameters) - OGN DB state are per instance - OGN DB caching is now per context index - All OGN attributes have a reference to the current DB target, but can also be accessed with an offset compared to the current DB target (which also has an offset compared to the current context target) - DataModel don’t try to create an attribute on copy - Most data access ABI now take an instance index - Internals of OGN wrappers are now private - Extended attributes now uses a specialization of SimpleAttribute that stores the RuntimeAttrib, which allows the proper vectorized access - Each Input and output bundle now have a dedicated relationship attribute, that can be vectorized - There is no more special treatment regarding bundle attributes and connections to other attributes - OGN Array attributes don’t store the data pointer anymore. The responsability of the pointer managment has been given to the ogn array helper struct - The ogn array helper struct (for string and array attributes) now has the context and the target handle. This allows to request the data from DataModel as lazily as possible, and apply CoW only on the ultimate data access ## [2.83.1] - 2023-01-10 ### Fixed - Enabled precompiled headers and cleaned up includes ## [2.83.0] - 2023-01-03 ### Added - Compound Node Types inputs and output definitions handle description and display name metadata ## [2.82.3] - 2022-12-21 ### Changed - Refactored CUDA build to consolidate build functions and remove unnecessary rebuilds ## [2.82.2] - 2022-12-16 ### Fixed - Updated output to properly handle subnode types ## [2.82.1] - 2022-12-15 ### Fixed - Performance for processing of large node fan-in (action graph) ## [2.82.0] - 2022-12-14 ### Added - Added areAnyTypesCompatible typeConversion helper ## [2.81.1] - 2022-12-14 ### Added - Implementation for new EF interface allowing push and lazy graph defs to be partition ## [2.81.0] - 2022-12-13 ### Added - IAttribute 1.3->1.4: ABI functions added to access the attribute union definitions. ## [2.80.2] - 2022-12-11 ### Fixed - OM-75582 Fix for write back to Usd ## [2.80.1] - 2022-12-09 ### Fixed - Condition for allowing evaluation of pull graph in the EF ## [2.80.0] - 2022-12-09 ### Changed - Updated DataModel’s metadata implementation. - Deprecated access to bundle metadata storage in IBundle2. - IConstBundle2 and IBundle2 made public. - Cleaned up implementation and removed code duplication. ## [2.79.4] - 2022-12-08 ### Fixed - Accessing the size of an inexistent array was returning 1 ## [2.79.3] - 2022-12-07 ### Fixed - OM-75593 Fixed DataModel::copyAttributeInternal for array attribute that used to set array size to 0 when src and dst was the same. ## [2.79.2] - 2022-12-06 ### Changed - GraphContext::invalidateBucket() now also invalidates the databases of downstream nodes. - Don’t assign the node’s database until after its bucket has been invalidated. ## [2.79.1] - 2022-12-03 ### Fixed - Fixed crash when loading resolved string attributes ## [2.79.0] - 2022-11-24 ## Removed - Setting useSchemaPrims - Code implementing support for that setting ## [2.78.4] - 2022-11-23 ### Fixed - Bug in evaluation of fan-out nodes in some cases ### Changed - Improved overhead of OG when stage contains no OmniGraph prims ## [2.78.3] - 2022-11-22 ### Fixed - EF invalidation for graph instance changes ## [2.78.2] - 2022-11-21 ### Added - Documentation link in how-tos for running a minimal Kit with OmniGraph - Documentation for the various types of node implementations and what they are for ## [2.78.1] - 2022-11-19 ### Fixed - Issues detected with EF and test_compute_counts: hang on a lock in recursive pattern and incorrect Graph::isInEvaluation ## [2.78.0] - 2022-11-18 ### Added - Interfaces for EF: IGenericNodeGraphDef, IGenericNodeDef, IPrivateNodeGraphDef - New internal method to IInternal: createPrivateGraphDef - Refactored population of EF to support any graph type - Introduced basic support for lazy / dirty_push graph ## [2.77.0] - 2022-11-17 ### Removed - Settings updateToUSD, supportForceWriteback, useLegacySimulationPipeline, and enableUSDInPreRender - Code implementing support for those settings ## [2.76.3] - 2022-11-16 ### Fixed - Bug in Graph::reloadFromStage for EF ## [2.76.2] - 2022-11-16 ### Fixed - Fixed memory leak when compound nodes are deleted ## [2.76.1] - 2022-11-14 ### Added - Start of unstable ABI for Execution Framework (omni.graph.exec) ## [2.76.0] - 2022-11-12 ### Removed - Setting that controls the ability to work with implicit global graphs - Code implementing support for implicit global graphs ## [2.75.3] - 2022-11-09 ## Fixed - BundlePrims attribute copying regression ## [2.75.2] - 2022-11-04 ### Fixed - potential crash on detach stage in same update that nodes are removed ## [2.75.1] - 2022-11-03 ### Fixed - Crash in omnigraph when loading usda files with start time offset ## [2.75.0] - 2022-10-31 ### Changed - tuple indexes are now uint8_t instead of int in the cpp headers ## [2.74.0] - 2022-10-28 ### Added - Interpretation of the deprecationsAreErrors setting that disables all non-schema support ## [2.73.3] - 2022-10-26 ### Fixed - Do not reinitialize node’s bucket to empty bucket. ## [2.73.2] - 2022-10-25 ### Added - Fixed double parse of nested graphs on stage during load. ## [2.73.1] - 2022-10-21 ### Fixed - Bug related to action graph loops ## [2.73.0] - 2022-10-20 ### Added - INodeType 1.8->1.9: isCompoundNodeType() - IGraphRegistryEvent.eNodeTypeNamespaceChanged, IGraphRegistryEvent.eNodeTypeCategoryChanged ## [2.72.1] - 2022-10-19 ### Fixed - Made the category check more lenient, ignoring empty descriptions ## [2.72.0] - 2022-10-17 ### Added - IGraphRegistry 1.4 -> 1.5: deprecated registerNodeType in favor of registerNodeTypeInterface ## [2.71.4] - 2022-10-16 ### Fixed - Array memory copy with a wrong element type for arrays of booleans. ## [2.71.3] - 2022-10-14 ### Changed - On-demand graphs fallbacks to evaluators. This is only a temporary change. ## [2.71.2] - 2022-10-12 ### Added - Profiling instrumentation for EF ### Changed - Graph definitions to call updateChangeProcessing instead of global omni graph definition ## [2.71.1] - 2022-10-11 ### Fixed - Fixed a crash due to a false assumption that a child bundle always has “primIndex” attribute. ## [2.71.0] - 2022-10-04 ### Fixed - BundlePrims dirtyIDs ## [2.70.0] - 2022-10-03 ### Added - IGraphContext 3.3 -> 3.4: getVariableInstanceDataHandle, getVariableInstanceConstDataHandle ## [2.69.0] - 2022-09-30 ### Added # [2.68.1] - 2022-09-29 ## Fixed - Inconsistent evaluation of nodes with fan-in # [2.68.0] - 2022-09-27 ## Changed - Restored `BundlePrim::setPath` from deprecation. ## Removed - Removed `getPrimDirtyIDs`, `getConstPrimPaths`, & `getConstPrimTypes` in the ConstBundlePrims class. - Removed `getPrimDirtyIDs`, `getPrimPaths`, `getPrimTypes`, `addPrimPathsIfMissing`, & `addPrimTypesIfMissing` in the BundlePrims class. # [2.67.0] - 2022-09-27 ## Added - OG Usd Listener path attribute target prim rename and reparenting. # [2.66.2] - 2022-09-26 ## Added - Fixed unloading of a graphs in layer that undergo a file format update. # [2.66.1] - 2022-09-25 ## Fixed - Dynamic attributes and PushEvaluator bug fix to call for reset() only when update is required. # [2.66.0] - 2022-09-22 ## Changed - Extended attribute type values are now persisted to USD as customData - Dynamic extended attribute types are now persisted to scoped customData as well as deprecated unscoped # [2.65.0] - 2022-09-21 ## Added - Initial support for Compound Nodes and Compound NodeTypes - INode::isCompoundNode to test if a node is a compound node - IGraph::isCompoundGraph to test if a node is a compound graph # [2.64.7] - 2022-09-20 ## Fixed - A bug in action graph logic related to fan-in # [2.64.6] - 2022-09-14 ## Added - On demand compute using Execution Framework # [2.64.5] - 2022-09-11 ## Changed - Assignment operator for AttributeDef now returns a reference to the assignee instead of void ## Fixed - Consistent index of BundlePrim instances among multiple BundlePrims instances attached to the same bundle. - Consistent index of BundlePrim instances throughout the lifetime of a BundlePrims instance. ## [2.64.3] - 2022-09-07 ### Changed - Fixes OM-62261 ``` og.OmniGraphInspector().as_json ``` Returns Bad Json ## [2.64.2] - 2022-09-07 ### Added - NodeTypeDef attributes now maintain separate memory for attribute defaults. ## [2.64.1] - 2022-09-06 ### Changed - Gave a better error message for deprecated node type presence - Reenabled the still-flaky tests ## [2.64.0] - 2022-08-31 ### Added - IDataModel and thread-safety to data model changes that can affect other nodes - Ability to discover when data model structure changed (via global id stamp) ## [2.63.0] - 2022-08-30 ### Changed - HandleToPtrMap to use concurrent container to avoid contention during parallel execution ## [2.62.0] - 2022-08-30 ### Removed - Temporary hack for Python node late delayed default value setting ### Added - Extra information to flag when the node type definition is responsible for deletion of default data memory ## [2.61.1] - 2022-08-24 ### Changed - Fixes ReadOnly array attribute sometimes having a dangling pointer ## [2.61.0] - 2022-08-23 ### Added - IGraphRegistry::getEventStream to get an event stream that triggers when node types are added and removed. ## [2.60.1] - 2022-08-22 ### Fixed - GraphContext’s getOutputPrim did not use DataModel. ## [2.60.0] - 2022-08-19 ### Added - Support for new setting that turns deprecations into errors - New macro for flagging use of deprecated code path - Deprecation messages for code paths not using schema prims ## [2.59.2] - 2022-08-18 ### Fixed - Added missing call to tell nodes created from a Prim that they already have a default set ## [2.59.1] - 2022-08-17 ### Added - Architectural decision for splitting off the extensions into a separate repo ### Fixed - Made Fabric dump of connections provide a default when presented with bad data ## Changed - Updated the apply_change_info script to preserve local branch edits of extension.toml ## [2.59.0] - 2022-08-16 ### Added - Added isValid() methods to OG Obj ABI structs ## [2.58.1] - 2022-08-15 ### Changed - Allow write variable to operate even if role types differs ## [2.58.0] - 2022-08-12 ### Changed - Node path is now added to console-logged messages - Node path is no longer added to messages captured on nodes ## [2.57.4] - 2022-08-11 ### Changed - Handles auto conversion in data model ## [2.57.3] - 2022-08-08 ### Added - Warning when schema prims are loaded when the setting is disabled. ## [2.57.2] - 2022-08-05 ### Fixed - action evaluator for cycles in connections ## [2.57.1] - 2022-08-04 ### Fixed - Avoided multiple `__metadata__bundle__` tokens in a path ## [2.57.0] - 2022-08-03 ### Changed - OGN Bundle wrapper `size` and `abi_primHandle` are marked as deprecated. ### Added - Two methods to OGN Bundle wrapper: `attributeCount` and `childCount`. ## [2.56.0] - 2022-08-02 ### Added - Update OGN Bundle wrapper to use IBundle2 ## [2.55.0] - 2022-08-02 ### Added - /persistent/omnigraph/enablePathChangedCallback to deprecate INode::registerPathChangedCallback - /persistent/omnigraph/disableInfoNoticeHandlingInPlayback optimization setting ### Changed - pathChangedCallback will now trigger once per OG update with accumulated changes instead of immediately ## [2.54.0] - 2022-07-28 ### Added - Added `IDirtyID` interface - Added `BundleAttrib` class and `BundleAttribSource` class ## [2.53.1] - 2022-07-28 ### Fixed - Fixed handling of empty strings in operator< and operator> of ogn::base_string ## [2.53.0] - 2022-07-22 ### Added - IBundle2 - remove_attributes_by_name and remove_child_bundles_by_name ## [2.52.1] - 2022-07-27 ### Fixed - Fixed data model for storing attribute metadata in IBundle2 ## [2.52.0] - 2022-07-27 ### Changed - valueChanged callback handling ## [2.51.3] - 2022-07-23 ### Fixed - Fixed dirty_push graphs being re-run during playback when time has not advanced ## [2.51.2] - 2022-07-22 ### Fixed - Registration order of TfNotice handler for OG ## [2.51.1] - 2022-07-21 ### Fixed - OM-56991 Ill-formed sdf paths ## [2.51.0] - 2022-07-21 ### Changed - Undo revert and fix bug in evaluation of nodes with dynamic execution attribs ## [2.50.0] - 2022-07-19 ### Fixed - IBundle2 reviewed ABI, reviewed copy and link for attributes and bundles ## [2.49.0] - 2022-07-18 ### Changed - Reverted the changes in 2.48.0 ## [2.48.1] - 2022-07-18 ### Added - Better ReadPrimAttribute error reporting ## [2.48.0] - 2022-07-15 ### Changed - Action graph fan-out of execution wires are now evaluated in parallel instead of sequence ## [2.47.1] - 2022-07-12 ### Changed - Changed node create to write extended attributes to USD prior to node creation ## [2.47.0] - 2022-07-08 ### Added - ‘deprecated’ .ogn keyword for attributes - IInternal / omni.graph.core._internal - IInternal::deprecateAttribute() / omni.graph.core._internal.deprecate_attribute() - IAttribute::isDeprecated() / omni.graph.core.Attribute.is_deprecated() - IAttribute::deprecationMessage() / omni.graph.core.Attribute.deprecation_message() - ‘internal’ attribute metadata keyword ## [2.46.0] - 2022-07-08 ### Fixed - Fixed memory leak coming from NodeType objects ### Changed - INodeType 1.6 -> 1.7 - fileFormatVersion attribute on OmniGraph objects only writes to USD if it has changed ### Added - INodeType::destroyNodeType to deallocate a node type object ## [2.45.2] - 2022-07-07 ### Fixed - IConstBundle2 and IBundle2 broken logging system ## [2.45.1] - 2022-07-06 ### Added - Ability to raise an error/warning for a node through (new) static methods of the database ## [2.45.0] - 2022-06-30 ### Added - Metadata support for IBundle2 interface ## [2.44.3] - 2022-06-30 ### Changed - USD write back is now performed just once per frame per Fabric cache ## [2.44.2] - 2022-06-28 ### Fixed - Checked newly added nodes for file format version upgrade requirements ## [2.44.1] - 2022-06-28 ### Changed - Ensured nodeContextHandle is initialized correctly ## [2.44.0] - 2022-06-29 ### Changed - Deprecated IScheduleNode::getNode, INodeType::getScheduleNodeCount, INodeType::getScheduleNodes ## [2.43.1] - 2022-06-29 ### Added - A compile switch to disable OGN database caching ## [2.43.0] - 2022-06-28 ### Fixed - Array attributes not keeping a single copy of their data/size pointers as intended - Few places using P2AM directly instead of DataModel - Debugging features of DataModel - usdToCache overwritting connection informations - Bad performance of getLocalAttributeHandle ### Added - OGN Database caching at the node level - Tracking of changes that might invalidate this caching - Gives a chance to DataModel to prepare buckets of nodes at load time, in order to prevent useless rebucket later ## [2.42.0] - 2022-06-23 ### Added - clearContents method to IBundle2 interface ## [2.41.0] - 2022-06-22 ### Added - Faster check for deprecated node types ### Removed - Unused core node animation/OgnPointsWeight - Unused core node animation/OgnTextGenerator - Unused core node animation/OgnTimeSampleArray - Unused core node animation/OgnTimeSamplePoints - Unused core node animation/OgnXformDeformer - Unused core node animation/OgnXformSRT - Unused core node animation/OgnXformToFastCache - Unused core node core/OgnFetch - Unused core node core/OgnGather - Unused core node core/OgnScatter - Unused core node core/OgnSlang - Unused core node core/OgnTime - Unused core node core/OgnTimeSample - Unused core node core/OgnXtoY - Unused core node math/OgnVectorElementDecompose - Unused core node math/OgnVectorElementSet ## [2.40.4] - 2022-06-22 ### Changed - Fix for output attribute being resolved by downstream connection ## [2.40.3] - 2022-06-22 ### Added - Architectural decision records support - Added ADR for the decision around how to present the Python API surface ## [2.40.2] - 2022-06-21 ### Changed - Optimized attribute look up ## [2.40.1] - 2022-06-17 ### Changed - Added extra validity checks to bundle data access ### Added - Finished off the documentation for versioning, both internal and external ## [2.40.0] - 2022-06-17 ### Added - IGraph::getEvaluationName ### Changed - When using schemaPrims, OmniGraph now responds to changes made to graph settings in USD. ## [2.39.0] - 2022-06-16 ### Changed - ForceWriteBack mechanism (that was used to write back prim data to USD) is now soft deprecated behind a setting ### Added - A per attribute tracking system that allows to write back to USD at single attribute definition ## [2.38.3] - 2022-06-16 ### Fixed - cpp wrapepr getAttributesR template function, internally it wasn’t casting to NameToken. ### Changed - Outputs for `IBundle2::create`, `IBundle2::link` ## [2.38.2] - 2022-06-15 ### Fixed - Handled the one missing colorama reference ## [2.38.1] - 2022-06-14 ### Fixed - When removing the last attributes on a path, DataModel was failing to move it properly to the empty bucket ## [2.38.0] - 2022-06-13 ### Added - CreateGraphAsNodeOptions structure - GraphEvaluationMode enum - IGraph::getEvaluationMode - IGraph::setEvaluationMode - IGraph::createGraphAsNode(GraphObject&, const CreateGraphAsNodeOption) ### Deprecated - IGraph::createGraphAsNode(GraphObject&, const char, const char, const char, bool, bool, GraphBackingType, GraphPipelineStage) ## [2.37.1] - 2022-06-13 ### Fixed - Crash fix when trying to convert an invalid “FabricBundle” to a value ## [2.37.0] - 2022-06-13 ### Added - Temporary support for flagging values already set for Python initialize ## [2.36.0] - 2022-06-08 ### Added - Pre-render evaluation functions ## [2.35.0] - 2022-06-07 ### Added - Support for the generator setting for Python optimization ## [2.34.3] - 2022-06-03 ### Fixed - Copy on Write for Child bundles ## [2.34.2] - 2022-06-02 ## Changed - Allow arguments arrayDepthsBuf and tuplesBuf for resolvePartiallyCoupledAttributes() to be null pointers ## [2.34.1] - 2022-06-01 ### Fixed - Input execution attribute are now reset to Disabled state when node enters latent state - Bug making bundle connection to legacy prim ## [2.34.0] - 2022-05-30 ### Changed - Connections between nodes are now not stored in fabric anymore - We now rely only on connections expressed in the Object Oriented Layer in OmniGraph core - DataModel now don’t have to do extra logic to interpret FC connections as toppological connection or upstream reference ### Added - Ability to access and set default value on an attribute - Interfaced this new feature with python - Using this new feature in python OGN generator ### Fixed - Bug preventing to clear an attribute array in python ### Removed ## [2.33.11] - 2022-05-27 ### Changed - Deprecated the GraphContext::updateToUsd() code path with useSchemaPrims off ### Fixed - Fixed the Fabric dump in GraphContext, broken when Fabric was upgraded - Fixed the graph population phase in PluginInterface to walk all graphs, not just the first one ## [2.33.10] - 2022-05-26 ### Fixed - Fixed memory leak with variables - Fixed errors caused by removing variables from Fabric ## [2.33.9] - 2022-05-24 ### Fixed - Attributes on bundle not properly materialized, attempt 2 ## [2.33.8] - 2022-05-18 ### Fixed - Attributes on bundle not properly materialized ## [2.33.7] - 2022-05-17 ### Fixed - Fixed reparenting graph to previous parent which otherwise corrupted fabric state and left nodes without properties ## [2.33.6] - 2022-05-17 ### Fixed - Duplicate bundle connections on rename ## [2.33.5] - 2022-05-16 ### Fixed - Connection-compatibility check for execution attributes ## [2.33.4] - 2022-05-16 ### Changed - Makes dynamic bundle works in python ## [2.33.3] - 2022-05-16 ### Changed - Fix type not properly registered in FC when adding new attributes ## [2.33.2] - 2022-05-13 ### Changed - Makes bundle works on node not backed by USD ## [2.33.1] - 2022-05-12 ### Changed - Array attribute are now using ABI, giving a chance to the framework to perform CoW and DS ## [2.33.0] - 2022-05-11 ### Changed - Refactoring of data model: centralized all Fabric accesses in one place - MBiB now uses connections instead of bucket tagging ### Added - Lazy pointer retrieval (for read and write) in OGN layer - Array attribute and bundles are now passed by reference from node to node - Copy on Write: Array attributes/Bundle content are copied when mutated - ABI entry for batch attribute copy from one bundle/prim to another ### Fixed - Fixed some API for data retrieval in OGN layer that were misbehaving when used ## Removed - Data stealing prototype ## [2.32.2] - 2022-05-11 ### Fixed - Fixed read time node with pull evaluator when time changes outside of playback (e.g. timeline tool) ## [2.32.1] - 2022-05-06 ### Fixed - Fixed instances loaded from references requiring a stage reload to evaluate correctly ## [2.32.0] - 2022-05-05 ### Changed - Refactored settings to handle interdependencies ### Fixed - Changed std::is_pod to std::is_trivial for C++20 compatibility ### Added - Added architectural diagram of the OmniGraph extension interdependencies - Internal diagram of the schema prim code path dependencies - Adding callbacks in settings to handle interdependencies ## [2.31.3] - 2022-05-04 ### Fixed - Fixed a bit too agressive type unresolution on input attributes ## [2.31.2] - 2022-05-03 ### Fixed - Default variable values not always getting set to instances with no overrides ## [2.31.1] - 2022-05-02 ### Fixed - bug resolving values in certain extended attribute connections ## [2.31.0] - 2022-04-29 ### Changed - Passed graph prim for more targeted Fabric initialization - Bumped file format to 1.4 - Made file format calls more tolerant of useSchemaPrims settings ## [2.30.3] - 2022-04-25 ### Changed - Only flush USD to fabric when we are parsing the first root graph, otherwise previous changes to fabric may be overwritten ## [2.30.2] - 2022-04-28 ### Fixed - Removed the obsolete parts of the unit tests ## [2.30.1] - 2022-04-26 ### Fixed - Fix situation with bad type resolution ## [2.30.0] - 2022-04-22 ### Added - `OmniGraphDatabase.getGraphTarget` - IGraphContext 3.1->3.2 - `IGraphContext.getGraphTarget` ## [2.30.0] - 2022-04-25 ### Removed - Removed the unimplemented IDataReference class ## Changed - Removed the obsolete TestComputeGraph.cpp unit test ## Changed - Stopped building the obsolete nodes - Moved the generated substitutions.rst file to the build area ## [2.29.4] - 2022-04-21 ### Changed - “ui:”-prefixed attributes present on Node prims are no longer read as OG attributes ## [2.29.3] - 2022-04-19 ### Fixed - Rare crash that occurred when using string-based node attributes ## [2.29.2] - 2022-04-14 ### Fixed - updateSimStepUsd* disableUsdUpdates is respected ## [2.29.1] - 2022-04-08 ### Fixed - Auto conversion bug for native tuple ## [2.29.0] - 2022-04-08 ### Changed - Passed graph prim for more targeted Fabric initialization - Bumped file format to 1.4 - Made file format calls more tolerant of useSchemaPrims settings ## [2.28.0] - 2022-04-08 ### Changed - input attribute types are no longer inferred from output attribute types. - type resolution and unresolution will no longer propagate upstream. ## [2.27.0] - 2022-04-08 ### Added - Added IGraphContext::getAbsoluteSimTime() function - Added ComputeGraph::updateV2() function which updates the absoluteSimTime ## [2.26.3] - 2022-04-07 ### Fixed - Graph::writeTokenSetting() was failing to update the token if it already existed but was empty. ### Changed - Graph::writeTokenSetting() no longer updates the token or issue a warning if the new value is the same as the existing one. ## [2.26.2] - 2022-04-05 ### Fixed - Fixes issues where ForceWriteBack token on newly created Nodes would not be respected unless the Prim of the Node was selected ## [2.26.1] - 2022-03-31 ### Fixed - Fixed issue when using OG in MGPU: forces use of Device 0 in StaticScheduler ## [2.26.0] - 2022-03-31 ### Added - PrimHandle and ConstPrimHandle renamed to BundleHandle and ConstBundleHandle. PrimHandle and ConstPrimHandle remain as aliases to BundleHandle and ConstBundleHandle. ### [2.25.2] - 2022-03-25 #### Fixed - Fixed issue where type resolution on node with coupled attribute would not work - Fixed auto type conversion not working on coupled attributes ### [2.25.1] - 2022-03-25 #### Fixed - dynamic scheduler will now evaluate execution subgraphs ### [2.25.0] - 2022-03-23 #### Added - IGraph 3.6 -> 3.7 - getEventStream - accessor to retrieve a graphs event stream - IGraphEvent enum type - IGraphEvent.eCreateVariable, raised when a variable is created through the ABI - IGraphEvent.eRemoveVariable, raised when a variable is removed through the ABI ### [2.24.0] - 2022-03-16 #### Added - Setting /persistent/omnigraph/enableLegacyPrimConnections. When enabled, this will restore legacy behavior for OG Prim nodes: - Entire stage is searched for connections between Nodes and Prims, any connected Prims will be brought into FC, and corresponding OG Prim nodes created with all attributes. - Terminal nodes will be automatically synced to FC every frame - This setting is not exposed in the UI. It is a temporary setting until legacy code can be migrated to no longer use Prim connections. ### [2.23.8] - 2022-03-15 #### Fixed - Fixed issue where ComputeGraphs in sublayers may not correctly load ### [2.23.7] - 2022-03-14 #### Fixed - Auto type conversion was not correctly computed on load ### [2.23.6] - 2022-03-14 #### Fixed - Bug in default string attribute initialization ### [2.23.5] - 2022-03-09 #### Fixed - Fixed issue where type resolution on node with coupled attribute would not work - Fixed auto type conversion not working on coupled attributes ## Added - Added a check to make sure that literalOnly attributes cannot be connected to other attributes ## [2.23.4] - 2022-03-08 ### Fixed - Cleanup of graph deletion ## [2.23.3] - 2022-03-08 ### Changed - Modified the node type registration/deregistration process to avoid static destructor ordering problems and allow multiple initialize/release calls ## [2.23.2] - 2022-03-07 ### Fixed - Removed unnecessary migration of bundle connection members to a copied bundle ## [2.23.1] - 2022-03-05 ### Fixed - RenderVar prim data will be automatically loaded into FC when they are part of an OG network ## [2.23.0] - 2022-03-04 ### Changed - Removed the updateTerminalNodesOnly setting, the default of updateToUSD is now False. OG will now only sync Prims FC->USD with the ForceWriteBack token when updateToUSD is False. When the setting is True, it will sync all Prims. - Added settingsVersion setting ## [2.22.3] - 2022-03-04 ### Changed - OG will no longer automatically load non-OG Prim data into FC during stage attach. ## [2.22.2] - 2022-03-02 ### Fixed - Added support for omni.graph.nodes.ReadTime to lazy (dirty_push) evaluator ## [2.22.1] - 2022-02-18 ### Changed - Bug fix in path attribute monitoring: properly retarget subpath when reparenting happens higher in the hierarchy ## [2.22.0] - 2022-02-18 ### Added - Added tests for schema-based prims - Added test case base class factory method ### Fixed - Fixed handling of the schema-based prims - Removed use of deprecated OmniGraphHelper from some scripts ## [2.21.4] - 2022-02-18 ### Changed - Bug fix accessing a deleted entry in a map ## [2.21.3] - 2022-02-17 ### Changed - Added proper support for path role (that keep track of the target) ## [2.21.2] - 2022-02-16 ### Changed - Changed Fabric Cache creation to new `create2` to allow RingBuffers to have CUDA enabled ## Fixed - Categories on several nodes ## [2.21.0] - 2022-02-15 ### Added - Added support for update_usd flag to the data_view and SetAttr command ### Fixed - Ignored the Expression node for the warning on nodes without namespaces - Avoided a crash when the fileFormatVersion attribute could not be found ## [2.20.0] - 2022-02-13 ### Changed - Prim nodes will no longer have OG attributes automatically added - Prim node authored USD attributes added to FC - Removed support for special attribute OGN_NonUSDConnections ## [2.19.0] - 2022-02-11 ### Added - Added OmniGraphDatabase.getVariable ## [2.18.0] - 2022-02-10 ### Added - Added setting for using schema prims for graphs and nodes. - Added use of the omniGraphSchema library for graph and node prims (protected by the setting). ## [2.17.0] - 2022-02-08 ### Changed - Added support for auto conversion between attributes. ## [2.16.1] - 2022-02-07 ### Changed - Moved carb logging out of Database.h and into Node::logComputeMessage. ## [2.16.0] - 2022-02-05 ### Added - IGraph 3.5 -> 3.6 - Added IGraph::createVariable - Added IGraph::removeVariable - Added IGraph::findVariable - IVariable - Added IVariable::getDisplayName and IVariable::setDisplayName - Added IVariable::getCategory and IVariable::setCategory - Added IVariable::getTooltip and IVariable::setTooltip - Added IVariable::getScope and IVariable::setScope - Added IVariable::isValid ## [2.15.1] - 2022-02-04 ### Fixed - Edge cases in action graph evaluator for fan-in and fan-out of execution attributes ## [2.15.0] - 2022-02-02 ### Added - IGatherPrototype 1.1 -> 2.0 - Changed the signature of gatherPaths - Added getGatheredRepeatedPaths ## [2.14.0] - 2022-02-01 ### Added - ComputeGraph 1.0 -> 1.1 - Added IOmniGraphTest::setTestFailure - Added IOmniGraphTest::testFailureCount - Python bindings at the module level - Added set_test_failure ## [2.13.0] - 2022-01-31 ### Changed - IVariable.getPath renamed to IVariable.getSourcePath ## [2.12.0] - 2022-01-28 ### Fixed - Error status change callbacks weren’t firing during normal evaluations. - Bumping the minor version # since features which use the callbacks will not work without this change. ## [2.11.0] - 2022-01-26 ### Added - INode 4.1 -> 4.2 - Added INode::logComputeMessage - Added INode::getComputeMessageCount - Added INode::getComputeMessage - Added INode::clearOldComputeMessages - IGraph 3.4 -> 3.5 - Added IGraph::registerErrorStatusChangeCallback - Added IGraph::deregisterErrorStatusChangeCallback - Added IGraph::nodeErrorStatusChanged - Added IGraph::getVariableCount - Added IGraph::getVariables - Created the IVariable type ### Changed - OmniGraphDatabase::logWarning and logError now log compute messages whenever they are different from the node’s previous evaluation. Previously they would only log a given error once per session and node type. ## [2.10.1] - 2022-01-19 ### Changed - Fixed a bug in attribute resolution propagation logic ## [2.10.0] - 2022-01-18 ### Changed - Extended attributes will now be returned to an unresolved state upon disconnection if the topology of the graph does not prevent it. ## [2.9.0] - 2022-01-17 ### Added - INode 4.0 -> 4.1 - Added INode::getComputeCount - Added INode::incrementComputeCount ## [2.8.0] - 2022-01-13 ### Added - IGraphRegistry 1.1 -> 1.2 - Added IGraphRegistry::getRegisteredType ## [2.7.0] - 2022-01-06 ### Modified - GraphContextObj.context has been replaced with GraphContextObj.contextHandle. The old member was a pointer to an internal OG class. The new member is a POD handle which can be used with OG ABI functions. ## [2.6.1] - 2021-12-30 ### Modified - INode::resolvePartiallyCoupledAttributes checks more type resolution error conditions. ## [2.6.0] - 2021-12-21 ### Added - IAttributeData 1.3 -> 1.4 - Added IAttributeData::getDataRGpuAt ## [2.5.1] - 2021-12-16 ### Changed - Action Graph evaluator now uses `og.ExecutionAttributeState.LATENT_FINISH` to indicate when a latent node is finished. ## [2.5.0] - 2021-12-10 ### Added - Created the INodeCategories interface - ComputeGraph 2.4 -> 2.5 - Added `ComputeGraph::getNodeCategories` ## [2.5.1] - 2021-12-08 ### Fixed - Fix RuntimeAttribute getXX templates to avoid an MSVC compiler bug ## [2.4.0] - 2021-12-07 ### Added - IGraph 3.3 -> 3.4 - Added `IGraph::isGlobalGraphPrim` - Modified RuntimeAttribute to include PtrToPtrKind template, with default for backward compatibility ## [2.3.0] - 2021-12-06 ### Added - Added `INodeEvent::eAttributeTypeResolve` ## [2.2.1] - 2021-12-02 ### Fixed - Fix bug where renaming a graph doesn’t rename the wrapper node, resulting in new graphs overwriting old graphs ## [2.2.0] - 2021-11-26 ### Added - Python Bindings 2.1.0 -> 2.2.0 - Added Python api `Graph.get_parent_graph` - Ignore connections to ComputeGraph prims for the new OmniGraph UI. ## [2.1.0] - 2021-11-26 ### Added - IAttributeType 1.2 -> 1.3 - Added `IAttributeType::isLegalOgnType` ## [2.0.3] - 2021-11-25 ### Added - INodeType 1.5 -> 1.6 - Added `INodeType::getName` ## [2.0.2] - 2021-11-24 ### Fixed - Fix for handling of referenced OmniGraph Graphs ## [2.0.1] - 2021-11-18 - Exposing attribute optional flag. ### Added - IAttribute 1.8 -> 1.9 - Added `IAttribute::getIsOptionalForCompute` - Added `IAttribute::setIsOptionalForCompute` ## [2.0.0] - 2021-11-12 Major change to deprecate functionality that has been on the chopping block for a while now. ### Removed - Removed - PlugFlags - kPlugFlagNone - kPlugFlagFollowUpstream - INode 3.1 -> 4.0 - Retired - getPlug - stashPlug - getStashedPlugCount - getStashedPlug - IGraphContext 2.1 -> 3.0 - Retired - getAttribute - getAttributeWithAttr - getAttributeGPU - getElementCount ## [1.4.1] - 2021-11-10 Fixed bugs where renaming the global graph breaks connections and where bundles don’t work in global graphs ## [1.4.0] - 2021-11-10 ### Added - New Interface ISchedulingHints - Added - ISchedulingHints::getComputeRule - ISchedulingHints::setComputeRule ## [1.3.1] - 2021-11-08 ### Changed - ISchedulingHints 1.0 -> ONI - Kept same functionality, implemented as ONI interface instead of Carbonite interface ## [1.3.0] - 2021-11-04 ### Added - INode 3.1 -> 3.2 - Added - INode::requestCompute ## [1.3.0] - 2021-10-27 ### Added - IGraph 3.2 -> 3.3 - Added - IGraph::evaluate ## [1.2.0] - 2021-10-18 ### Changed - Prim nodes now not created unless attribute-connected to OG node ### Added - IGraph 3.1 -> 3.2 - Added - IGraph::getFabricUserId - IAttribute 1.8 -> 1.9 - Added - IAttribute::ensurePortTypeInName - IAttribute::getPortTypeFromName - IAttribute::removePortTypeFromName ## [1.1.0] - 2021-10-13 ### Added - IAttribute 1.7 -> 1.8 - Added - IAttribute::isValid - INode 3.0 -> 3.1 - Added - INode::isValid - IGraph 3.0 -> 3.1 - Added - IGraph::isValid # [1.0.7] - 2021-10-10 ## Added ### IGraph 2.0 -> 2.1 #### Added `IGraph::isValid` ### IGraphContext 2.0 -> 2.1 #### Added `IGraphContext::isValid` # [1.0.6] - 2021-10-08 ## Added ### FileFormatVersion 1.1 -> 1.2 #### Added support for scoped graphs in the editor # [1.0.5] - 2021-10-07 ## Added ### IBundle 1.3 -> 1.4 #### Added `IBundle::addAttributes` #### Added `IBundle::removeAttributes` # [1.0.4] - 2021-09-30 ## Added ### Created ISchedulingHints 1.0 #### Added `ISchedulingHints::getThreadsafety` #### Added `ISchedulingHints::setThreadsafety` #### Added `ISchedulingHints::getDataAccess` #### Added `ISchedulingHints::setDataAccess` ### INodeType 1.4 -> 1.5 #### Added `INodeType::getSchedulingHints` #### Added `INodeType::setSchedulingHints` # [1.0.3] - 2021-09-29 ## Added ### ComputeGraph 2.3 -> 2.4 #### Added `ComputeGraph::getGraphCountInPipelineStage` #### Added `ComputeGraph::getGraphsInPipelineStage` #### Added `GraphBackingType::kGraphBackingType_None` # [1.0.3] - 2021-09-23 ## Added ### IGraph 2.1 -> 3.0 #### Changed the signature of `IGraph::createGraphAsNode` #### Added `IGraph::getGraphBackingType` #### Added `IGraph::getPipelineStage` # [1.0.3] - 2021-09-21 ## Added ### IGatherPrototype 1.0 -> 1.1 #### Added `getGatherArray` #### Added `getGatherArrayGPU` #### Added `getGatherPathArray` #### Added `getGatherArrayAttributeSizes` #### Added `getGatherArrayAttributeSizesGPU` #### Added `getElementCount` # [1.0.3] - 2021-09-16 ## Added ### IAttribute 1.6 -> 1.7 #### Added `IAttribute::isDynamic()` #### Added `IAttribute::getUnionTypes()` # [1.0.3] - 2021-09-15 ## Added ### IAttributeData 1.2 -> 1.3 # [1.0.3] - 2021-08-30 ## Added - IGraph 2.0 –> 2.1 - Added `IGraph::reloadFromStage()` # [1.0.2] - 2021-08-18 ## Added - INode 2.0 -> 2.1 - Added `INode::getEventStream` # [1.0.2] - 2021-08-09 ## IGatherPrototype 1.0 - Added `IGatherPrototype::gatherPaths` - Added `IGatherPrototype::getGatheredPaths` - Added `IGatherPrototype::getGatheredBuckets` - Added `IGatherPrototype::getGatheredType` # [1.0.2] - 2021-07-26 ## Changed - INode 1.6 –> 2.0 - Changed the signature of `INode::createAttribute` # [1.0.2] - 2021-07-16 ## Added - INodeType 1.3 -> 1.4 - Added `INodeType::removeSubNodeType()` # [1.0.2] - 2021-07-14 ## Changed - IGraph 1.3 -> 2.0 - Changed the signature of `IGraph::createSubgraph` # [1.0.2] - 2021-07-12 ## Added - IGraph 1.2 -> 1.3 - Added `IGraph::createGraphAsNode` # [1.0.2] - 2021-07-04 ## Added - INode 1.5 -> 1.6 - Added `INode::getWrappedGraph()` ## Changed - ComputeGraph 2.2 -> 2.3 - Changed the semantics of getGraphCount, getGraphs, getGraphContextCount, getGraphContexts # [1.0.2] - 2021-07-01 ## Added - INode 1.4 -> 1.5 - Added `INode::registerPathChangedCallback()` - Added `INode::deregisterPathChangedCallback()` # [1.0.2] - 2021-06-21 ## Added - IAttribute 1.5 -> 1.6 - Added `IAttribute::getPortType()` ## [1.0.2] - 2021-06-11 ### Added - IBundle 1.2 -> 1.3 - Added `IBundle::removeAttribute` - IGraphContext 1.3 -> 1.4 - Added `IGraphContext::getTimeSinceStart()` ## [1.0.2] - 2021-06-10 ### Added - INodeType 1.2 -> 1.3 - Added `INodeType::getSubNodeTypeCount` - Added `INodeType::getAllSubNodeTypes` - IDataStealingPrototype 1.0 - Added `IDataStealingPrototype::actualReference` - Added `IDataStealingPrototype::moveReference` - Added `IDataStealingPrototype::enabled` - Added `IDataStealingPrototype::setEnabled` ## [1.0.2] - 2021-06-01 ### Changed - INode 1.3 -> 1.4 - Modified `INode::registerConnectedCallback` - Modified `INode::registerDisconnectedCallback` - Modified `INode::deregisterConnectedCallback` - Modified `INode::deregisterDisconnectedCallback` ## [1.0.2] - 2021-05-31 ### Added - IGraph 1.1 -> 1.2 - Added `IGraph::registerPreLoadFileFormatUpgradeCallback` - Added `IGraph::registerPostLoadFileFormatUpgradeCallback` - Added `IGraph::deregisterPreLoadFileFormatUpgradeCallback` - Added `IGraph::deregisterPostLoadFileFormatUpgradeCallback` ## [1.0.2] - 2021-05-05 ### Added - IGraph 1.0 -> 1.1 - Added `IGraph::inspect()` - IAttributeData 1.1 -> 1.2 - Added `IAttributeData::getDataReferenceR()` - Added `IAttributeData::getDataReferenceRGpu()` - Added `IAttributeData::getDataReferenceW()` - Added `IAttributeData::getDataReferenceWGpu()` - IAttributeType 1.0 -> 1.1 - Added `IAttributeType::inspect()` - Added `IAttributeType::baseDataSize()` - Added `IGraphRegistry::inspect()` - Added `IGraphRegistry::registerNodeTypeAlias()` - Added `INodeType::inspect()` - INode 1.2 -> 1.3 - Added `INode::resolveCoupledAttributes()` - Added `INode::resolvePartiallyCoupledAttributes()` - INode 1.1 -> 1.2 - Added `INode::getNodeTypeObj()` - IGraphContext 1.1 -> 1.2 - Added `IGraphContext::inspect()` # [1.0.1] - 2021-04-07 ## Added - Created the interface IAttributeType for working with the Type struct # [1.0.0] - 2021-03-01 ## Initial Version - Started changelog with initial released version of the OmniGraph core
changelog-omni-graph-docs_CHANGELOG.md	# Changelog This document records all notable changes to the omni.graph.docs extension. The format is based on [Keep a Changelog](https://keepachangelog.com). The project adheres to [Semantic Versioning](https://semver.org). ## [1.25.2] - 2024-04-26 ### Changed - The warp example shows how to use the CUDA device used by OmniGraph. ## [1.25.1] - 2024-04-17 ### Added - Add a ‘support_level’ entry to the configuration file of the extensions ## [1.25.0] - 2024-02-09 ### Changed - Updated version number to work after the Kit branch was renamed from 105.2 to 106. ## [1.21.3] - 2024-02-05 ### Fixed - Broken link to the Python API ## [1.21.2] - 2024-01-13 ### Fixed - Repository URL in config file. ## [1.21.1] - 2024-01-12 ### Fixed - Spelling mistakes ## [1.21.0] - 2024-01-05 ### Removed - Documentation for OmniGraph UI nodes. ## [1.20.0] - 2023-12-13 ### Added - Added an entry for auto-instancing in documentation ## [1.19.3] - 2023-12-08 ### Changed - Update docs to reflect types not supported by any or union types ## [1.19.2] - 2023-12-08 ### Changed - Added Bundle section to Developer Reference ## [1.19.1] - 2023-12-01 ### Changed - Added mention of omni.graph.telemetry to Extensions.md ## [1.19.0] - 2023-11-30 ### Removed - Redundant Python node type development instructions ## [1.18.1] - 2023-11-28 ### Changed - Updated some outdated documentation about internal states ## [1.18.0] - 2023-11-01 ### Added - Compound Node documentation ## [1.17.1] - 2023-10-05 ### Fixed - node references ## [1.17.0] - 2023-10-05 ### Changed - Fixed documentation of USD data types and rearranged presentation to be cleaner ## [1.16.1] - 2023-10-02 ### Removed - Reference to obsolete AutoNode module ## [1.16.0] - 2023-09-21 ### Added - Documentation for the allowMultiInputs OGN metadata ## [1.15.2] - 2023-09-01 ### Changed - Moved internal references to the internal docs build - Changed the extension references to have the extension name instead of just Overview ## [1.15.1] - 2023-08-18 ### Removed - Internal comments from the user facing documentation ## [1.15.0] - 2023-08-18 ### Changed - migrate omni.graph.action from kit repo ## [1.14.6] - 2023-08-17 ### Changed - Moved the AutoNode document references back to the omni.graph.tools extension ## [1.14.5] - 2023-08-16 ### Changed - Reworded the mission to add being a framework ## [1.14.4] - 2023-08-14 ### Changed - Moved omni.graph.ui references to be local ## [1.14.3] - 2023-08-14 ### Added - Compound Node documentation ## [1.14.2] - 2023-08-09 ### Changed - Moved references to omni.graph.nodes docs from Kit to the local repo ## [1.14.1] - 2023-08-03 ### Changed - Targeted a specific version of the Kit SDK ### Removed - Temporarily unavailable documentation generation ## [1.14.0] - 2023-08-02 ### Changed - Added OmniGraph conventions documentation ## [1.13.0] - 2023-07-31 ### Added - Added OmniGraph conventions documentation ## [1.12.7] - 2023-07-31 ### Changed - Standardized the format of the CHANGELOG ### Removed - Temporarily unavailable documentation generation ## [1.12.6] - 2023-07-27 ### Changed - OM-97363 Revert separator to underscore for output and state bundles ## [1.12.5] - 2023-07-26 ### Changed - Swapped locations between local and remote for examples extensions docs - Updated references to the UI nodes extension docs ## [1.12.4] - 2023-07-22 ### Added - Removed an unnecessary workaround for Linux doc index building ## [1.12.3] - 2023-07-21 ### Changed - Swapped locations between local and remote for examples extensions docs ## [1.12.2] - 2023-07-20 ### Changed - Bumping the version so that debug versions of extensions will publish ## [1.12.1] - 2023-07-19 ### Changed - Moved temporary redirections over to the tutorials extension since that is where they are needed now ## [1.12.0] - 2023-07-19 ### Changed - Moved the tutorial docs out to omni.graph.tutorials ## [1.11.4] - 2023-07-17 ### Removed - Obsolete reference to omni.kit.async_engine dependency. ## [1.11.3] - 2023-07-14 ### Changed - Fixed a spelling error ## [1.11.2] - 2023-06-26 ### Changed - Modified paths to the new Fabric core include directory ## [1.11.1] - 2023-06-12 ### Changed - Added dependencies on unnecessary extensions to work around the Vulkan error ## [1.11.0] - 2023-06-02 ### Added - Docs for converting node to use IActionGraph ## [1.10.0] - 2023-05-26 ### Added - Reference to CREATE_ATTRIBUTES flag in the controller.edit() function ## [1.9.2] - 2023-05-24 ### Removed - Removed references to “pull” and “execution_pull” evaluator modes. ## [1.9.1] - 2023-05-23 ### Removed - Removed references to now-nonexistant legacy schedulers/evaluators. ## [1.9.0] - 2023-04-20 ### Added - Docs for converting node to use IActionGraph ## [1.8.0] - 2023-04-19 ### Deprecated - Removed all references to ContextHelper and OmniGraphHelper ## [1.7.0] - 2023-04-14 ### Added - Variable overview ## [1.6.0] - 2023-04-13 ### Added - More detail on the capabilities of the script node ## [1.5.0] - 2023-04-12 ### Added - Action graph code examples ## [1.4.0] - 2023-04-11 ### Added - Better description of OmniGraph ### Removed - Obsolete unittest flag removed from the node generator command ## [1.3.0] - 2023-04-06 ### Added - Examples for the enhanced allowedTokens functionality ## [1.2.1] - 2023-03-31 ### Added - Updated target docs ## [1.2.0] - 2023-03-29 ### Added - Documentation for Attribute Type functionality # CHanged - Changed target python output type # [1.1.6] - 2023-03-22 ## Fixed - Added missing extension reference # [1.1.5] - 2023-03-16 ## Added - Updated the docs for target attributes # [1.1.4] - 2023-03-16 ## Changed - Updated scheduling hints documentation. # [1.1.3] - 2023-03-08 ## Added - Documentation for scheduling hints and node thread-safety conditions + unit tests. # [1.1.2] - 2023-02-25 ## Fixed - Fixed up cross-extension links - Fixed up ABI and API links ## Changed - Reorganized the developer reference to be more task-based - Modifed format of Overview to be consistent with the rest of Kit ## Added - Placeholders for new docs gaps discovered # [1.1.1] - 2023-02-22 ## Added - Documentation for steps to write nodes in both C++ and Python - Links to JIRA tickets regarding filling in the missing documentation # [1.1.0] - 2023-02-19 ## Changed - Rearranged all of the existing doc pages to be organized by topic, not be extension # [1.0.0] - 2023-01-26 ## Added - Created and merged all existing OmniGraph documentation into a single location
changelog-omni-graph-example-ext_CHANGELOG.md	# Changelog All notable changes to this project will be documented in this file. The format is based on Keep a Changelog, and this project adheres to Semantic Versioning. ## [1.0.2] - 2023-06-27 ### Changed - Set up the extension to load python nodes and tests in parallel ## [1.0.1] - 2023-02-25 ### Changed - Modified format of Overview to be consistent with the rest of Kit ## [1.0.0] - 2023-01-30 ### Initial Version - Started changelog with initial released version of the OmniGraph example extension
changelog-omni-graph-examples-cpp_CHANGELOG.md	# Changelog All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ## [1.25.1] - 2024-04-17 ### Added - Add a ‘support_level’ entry to the configuration file of the extensions ## [1.25.0] - 2024-04-10 ### Changed - Bumped dependency on omni.graph.core to version 2.177.1 - Bumped dependency on omni.graph.tools to version 1.77.0 ## [1.24.0] - 2024-03-18 ### Changed - Bumped dependency on omni.graph.core to version 2.176.3 ## [1.23.0] - 2024-02-15 ### Changed - Bumped dependency on omni.graph.core to version 2.174.2 - Bumped dependency on omni.graph.tools to version 1.76.1 ## [1.22.0] - 2024-02-05 ### Changed - Bumped dependency on omni.graph.core to version 2.174.0 - Bumped dependency on omni.graph.tools to version 1.76.0 ## [1.21.1] - 2024-02-03 ### Changed - Bumped minimum omni.graph.core extension version dependency to be compatible with changes to the INodeType interface and lazy graph executor. ## [1.21.0] - 2024-01-31 ### Changed - Bumped dependency on omni.graph.core to version 2.171.1 - Bumped dependency on omni.graph.tools to version 1.76.0 ## [1.20.0] - 2024-01-30 ### Changed - Bumped dependency on omni.graph.core to version 2.170.1 - Bumped dependency on omni.graph.tools to version 1.76.0 ## [1.19.0] - 2024-01-23 ### Added - Test coverage for the universal add node type ## [1.18.1] - 2024-01-22 ### Fixed - Made execution attribute descriptions consistent and informative ## [1.18.0] - 2024-01-18 ### Changed - Bumped dependency on omni.graph.core to version 2.169.1 - Bumped dependency on omni.graph.tools to version 1.73.0 ## [1.17.1] - 2024-01-13 ### Fixed - Repository URL in config file. ## [1.17.0] - 2024-01-12 ### Changed - Bumped dependency on omni.graph.core to version 2.169.0 - Bumped dependency on omni.graph.tools to version 1.70.0 ## [1.16.1] - 2024-01-12 ### Changed - Fix build warnings ## [1.16.0] - 2023-12-28 ### Changed - Bumped dependency on omni.graph.tools to version 1.69.0 ## [1.15.0] - 2023-12-28 ### Removed - Filter on tests failing from an earlier Kit SDK update ### Changed - Bumped dependency on omni.graph.core to version 2.167.0 - Bumped dependency on omni.graph.tools to version 1.68.0 ## [1.14.1] - 2023-12-18 ### Changed - Address some security issues ## [1.14.0] - 2023-12-12 ### Changed - Bumped dependency on omni.graph.core to version 2.165.3 - Bumped dependency on omni.graph.tools to version 1.65.0 ## [1.13.0] - 2023-12-11 ### Changed - Bumped dependency on omni.graph.core to version 2.165.3 - Bumped dependency on omni.graph.tools to version 1.65.0 ## [1.12.2] - 2023-12-08 ### Changed - Added Bundle section to Developer Reference ## [1.12.1] - 2023-11-30 ### Changed - Set the minimal omni.graph.core version required in order to properly load that extension ## [1.12.0] - 2023-11-10 ### Fixed - Code coverage filtering and additional tests ## [1.11.0] - 2023-11-09 ### Fixed - Code coverage filtering and additional tests ## [1.10.0] - 2023-10-05 ### Changed - Restore action nodes to .action from .action_nodes for forward-compatibility ## [1.9.5] - 2023-09-12 ### Changed - OM-106978 / OM-103829: Update to latest EF API (renamed traversal methods and node count) ## [1.9.4] - 2023-08-15 ### Changed - Fixed type name check in OverrideForEachPass ## [1.9.3] - 2023-08-11 ### Fixed - Version bump to force extension publication to fix Linux platform errors ## [1.9.2] - 2023-08-09 ### Fixed - Linux build errors - Bumping versions to get the extension published from a more compatible Linux build configuration ## [1.9.1] - 2023-08-04 ### Added - Missing link of the data directory ## [1.9.0] - 2023-08-03 ### Changed - Moved the extension over from Kit ## [1.8.0] - 2023-07-30 ### Changed - Moved GPU interop nodes to omni.graph.image.nodes ### Added - Dependency on omni.graph.image.nodes for backward compatibility ## [1.7.8] - 2023-07-21 ### Changed - Renamed Node::createForDef references to Node::create. ## [1.7.7] - 2023-06-27 ### Fixed - Refactored OmniGraph documentation to point to locally generated files ## [1.7.6] - 2023-06-27 ### Changed - Set up the extension to load python nodes and tests in parallel ## [1.7.5] - 2023-06-02 ### Fixed - OverrideForEachPass to work with new ActionGraph method of activation ## [1.7.4] - 2023-05-31 ### Fixed - Adjusted the CRLF settings for the generated .md node table of content files ## [1.7.3] - 2023-05-25 ### Removed - Removed the usage of the now-deleted EF runtime switch setting in one of the unit tests. ## [1.7.2] - 2023-05-12 ### Added - Set compute flags on node definitions in partition pass examples so that they respect the rules of PullGraphDef evaluation. - Unit test to ensure that the change described above actually works. ### Changed - Moved unit tests for partition pass examples out of omni.graph.test and into this extension. ## [1.7.1] - 2023-04-11 ### Added - Table of documentation links for nodes in the extension ## [1.7.0] - 2023-03-24 ### Added - EF Partition pass examples based off of this draft MR ## [1.6.9] - 2023-03-16 ### Added - “threadsafe” scheduling hint to OgnExampleExtractFloat3Array node. - “usd-write” scheduling hints to OgnPrimDeformer1, OgnPrimDeformer1_GPU, OgnPrimDeformer2, and OgnScaleCubeWithPrim nodes. ## [1.6.8] - 2023-02-25 ### Changed - Modifed format of Overview to be consistent with the rest of Kit ## [1.6.7] - 2023-02-22 ### Added - Links to JIRA tickets regarding filling in the missing documentation ## [1.6.6] - 2023-02-19 ### Changed - Added label to the main doc page so that higher level docs can reference the extension - Tagged for adding links to node documentation ## [1.6.5] - 2023-02-17 ### Added - “threadsafe” scheduling hints to OgnIK, OgnCompound, OgnSimple, OgnVersionedDeformer, OgnDeformer1_CPU, OgnDeformer1_GPU, OgnDeformer2_CPU, OgnDeformer2_GPU, OgnDeformerTimeBased, OgnExampleSimpleDeformer, OgnScaleCube, and OgnUniversalAdd nodes. ## [1.6.4] - 2023-01-30 ### Changed - Removed the kit-sdk landing page - Moved all of the documentation into the new omni.graph.docs extension ## [1.6.3] - 2022-12-21 ### Changed - Refactored CUDA build to consolidate build functions and remove unnecessary rebuilds ## [1.6.2] - 2022-12-19 ### Fixed - Avoid null pointer dereferences in compute for various nodes ## [1.6.1] - 2022-12-15 ### Fixed - Added firewall test to OgnDeformer1Gather_GPU.cpp for null pointers to avoid crash ## [1.6.0] - 2022-12-13 ### Removed - Unnecessary bindings and interfaces that prevent safe unload ## [1.5.0] - 2022-12-13 # Removed - Unnecessary bindings and interfaces that prevent safe unload # [1.4.2] - 2022-10-26 ## Changed - Disabled test_om_43835. # [Unreleased] # [1.4.1] - 2022-08-09 ## Fixed - Applied formatting to all of the Python files # [1.4.0] - 2022-07-07 ## Added - Test for public API consistency # [1.3.0] - 2022-06-28 ## Changed - Modified the Python code to create a more definitive API surface # [1.2.0] - 2022-06-23 ## Changed - Modified the Python code to create a more definitive API surface # [1.1.0] - 2022-04-29 ## Removed - Obsolete settings test # [1.0.1] - 2022-03-14 ## Changed - Added categories to node OGN # [1.0.0] - 2021-03-01 ## Initial Version - Started changelog with initial released version of the OmniGraph core
changelog-omni-graph-examples-python_CHANGELOG.md	# Changelog This document records all notable changes to the omni.graph.examples.python extension. The format is based on [Keep a Changelog](https://keepachangelog.com). The project adheres to [Semantic Versioning](https://semver.org). ## [Unreleased] ## [1.22.1] - 2024-04-17 ### Added - Add a ‘support_level’ entry to the configuration file of the extensions ## [1.22.0] - 2024-04-10 ### Changed - Bumped dependency on omni.graph to version 1.139.0 - Bumped dependency on omni.graph.core to version 2.177.1 - Bumped dependency on omni.graph.tools to version 1.77.0 ## [1.21.0] - 2024-03-18 ### Changed - Bumped dependency on omni.graph.core to version 2.176.3 - Bumped dependency on omni.graph to version 1.138.1 ## [1.20.0] - 2024-02-15 ### Changed - Bumped dependency on omni.graph.core to version 2.174.2 - Bumped dependency on omni.graph.tools to version 1.76.1 ## [1.19.0] - 2024-02-05 ### Changed - Bumped dependency on omni.graph to version 1.138.0 - Bumped dependency on omni.graph.core to version 2.174.0 - Bumped dependency on omni.graph.tools to version 1.76.0 ## [1.18.0] - 2024-01-31 ### Changed - Bumped dependency on omni.graph to version 1.137.0 - Bumped dependency on omni.graph.core to version 2.171.1 - Bumped dependency on omni.graph.tools to version 1.76.0 ## [1.17.0] - 2024-01-30 ### Changed - Clarified which node types are deprecated and removed code coverage for them ## [1.16.0] - 2024-01-23 ### Added - Test coverage for the universal add node type ### Removed - Test coverage checks for deprecated dynamic switch node type - Test coverage checks for deprecated Torch code path - Support for deprecated transform attribute type ## [1.15.0] - 2024-01-23 ### Changed - Bumped dependency on omni.graph to version 1.136.0 ## [1.14.1] - 2024-01-22 ### Fixed - Made execution attribute descriptions consistent and informative ## [1.14.0] - 2024-01-18 ### Changed - Bumped dependency on omni.graph.core to version 2.169.1 - Bumped dependency on omni.graph to version 1.135.1 - Bumped dependency on omni.graph.tools to version 1.73.0 ## [1.13.1] - 2024-01-13 ### Fixed - Repository URL in config file. ## [1.13.0] - 2024-01-12 ### Changed - Bumped dependency on omni.graph to version 1.134.7 - Bumped dependency on omni.graph.core to version 2.169.0 - Bumped dependency on omni.graph.tools to version 1.70.0 ## [1.12.0] - 2023-12-28 ### Changed - Bumped dependency on omni.graph.tools to version 1.69.0 ## [1.11.0] - 2023-12-28 ### Changed - Bumped dependency on omni.graph.core to version 2.167.0 - Bumped dependency on omni.graph to version 1.134.2 - Bumped dependency on omni.graph.tools to version 1.68.0 ## [1.10.0] - 2023-12-18 ### Changed - Bumped dependency on omni.graph.core to version 2.166.0 - Bumped dependency on omni.graph to version 1.134.0 - Bumped dependency on omni.graph.tools to version 1.65.0 ## [1.9.1] - 2023-12-14 ### Changed - Fix tests when FabricSceneDelegate is enabled ## [1.9.0] - 2023-12-12 ### Changed - Bumped dependency on omni.graph.core to version 2.165.3 - Bumped dependency on omni.graph to version 1.133.2 - Bumped dependency on omni.graph.tools to version 1.65.0 ## [1.8.0] - 2023-12-11 ### Changed - Bumped dependency on omni.graph.core to version 2.165.3 ## [1.7.0] - 2023-12-07 ### Changed - Forces minimal og core version ## [1.6.5] - 2023-11-28 ### Changed - OgnTestInitNode is now testing as well init/release_instance and shared/per-instance internal states ## [1.6.4] - 2023-08-03 ### Changed - Targeted a specific version of the Kit SDK ## [1.6.3] - 2023-07-31 ### Changed - Standardized the format of the CHANGELOG ## [1.6.2] - 2023-07-26 ### Added - Test file that failed to migrate from Kit ## [1.6.1] - 2023-07-20 ### Changed - Bumping the version so that debug versions of extensions will publish ## [1.6.0] - 2023-07-19 ### Changed - Moved extension over from the Kit repo ## [1.5.3] - 2023-06-27 ### Fixed - Refactored OmniGraph documentation to point to locally generated files ## [1.5.2] - 2023-06-27 ### Changed - Set up the extension to load python nodes and tests in parallel ## [1.5.1] - 2023-05-31 ### Fixed - Adjusted the CRLF settings for the generated .md node table of content files ## [1.5.0] - 2023-05-29 ### Added - Regenerated node table of contents ## [1.4.2] - 2023-05-23 ### Removed - Removed unit test for now-nonexistant legacy dynamic scheduler. ## [1.4.1] - 2023-04-26 ### Added - ExecSwitch node ## [1.4.0] - 2023-04-19 ### Deprecated - Deprecated bouncing cube nodes that used the obsolete gather approach ## [1.3.10] - 2023-04-11 ### Added - Table of documentation links for nodes in the extension ## [1.3.9] - 2023-03-17 ### Added - Table of documentation links for nodes in the extension ## Fixed - Lint errors ## [1.3.8] - 2023-03-06 ### Added - New test for set_compute_incomplete API ## [1.3.7] - 2023-02-25 ### Changed - Modifed format of Overview to be consistent with the rest of Kit ## [1.3.6] - 2023-02-22 ### Added - Links to JIRA tickets regarding filling in the missing documentation ## [1.3.5] - 2023-02-19 ### Changed - Added label to the main doc page so that higher level docs can reference the extension - Tagged for adding links to node documentation ## [1.3.4] - 2023-01-30 ### Changed - Removed the kit-sdk landing page - Moved all of the documentation into the new omni.graph.docs extension ## [1.3.3] - 2023-01-16 ### Changed - Modified the premake to use a customized version of the OGN project dependency definition ## [1.3.2] - 2022-11-22 ### Changed - Disabled `test_dynamic_scheduling` when running with EF ## [1.3.1] - 2022-08-09 ### Fixed - Applied formatting to all of the Python files ## [1.3.0] - 2022-07-07 ### Added - Test for public API consistency ## [1.2.0] - 2022-06-21 ### Changed - Made the imports and docstring more explicit in the top level `init.py` - Deliberately emptied out the _impl/ `init.py` since it should not be imported - Changed the name of the extension class to emphasize that it is not part of an API ## [1.1.0] - 2022-04-29 ### Removed - Obsolete GPU Tests ### Changed - Made tests derive from OmniGraphTestCase ## [1.0.2] - 2022-03-14 ### Changed - Added categories to node OGN ## [1.0.1] - 2022-01-13 ### Changed - Fixed the outdated OmniGraph tutorial - Updated the USDA files, UI screenshots, and tutorial contents # [1.0.0] - 2021-03-01 ## Initial Version * Started changelog with initial released version of the OmniGraph core
changelog-omni-graph-expression_CHANGELOG.md	# Changelog All notable changes to this project will be documented in this file. The format is based on Keep a Changelog, and this project adheres to Semantic Versioning. ## [1.1.6] - 2023-04-11 ### Added - Table of documentation links for nodes in the extension ## [1.1.5] - 2023-02-25 ### Changed - Modifed format of Overview to be consistent with the rest of Kit ## [1.1.4] - 2023-01-30 ### Changed - Removed the kit-sdk landing page - Moved all of the documentation into the new omni.graph.docs extension ## [1.1.3] - 2022-12-21 ### Changed - Refactored CUDA build to consolidate build functions and remove unnecessary rebuilds ## [1.1.2] - 2022-08-09 ### Fixed - Applied formatting to all of the Python files ## [1.1.1] - 2022-08-03 ### Fixed - All of the lint errors reported on the Python files in this extension ## [1.1.0] - 2022-07-07 ### Added - Test for public API consistency - Added build handling for tests module
changelog-omni-graph-http_CHANGELOG.md	# Changelog All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ## [Unreleased] ## [0.2.0] - 2023-08-10 ### Changed - Updated Kit SDK version to latest ## [0.1.0] - 2023-06-30 ### Initial Version - Start changelog with initial version of nodes
changelog-omni-graph-image-core_CHANGELOG.md	# Changelog All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ## [0.4.4] - 2024-03-25 ### Fixed - Fixed crash when setting the graph state variables after a fabric snapshot is applied on the fabric stage. ## [0.4.3] - 2024-03-07 ### Fixed - Fixed crash when building graphs where nodes have attributes with unknown types. ## [0.4.2] - 2024-02-28 ### Changed - Move the initialization of the state variables to a pre process task. ## [0.4.1] - 2024-02-26 ### Changed - Initialize the state variables during the build stage, to avoid spike at runtime and deadlock. ## [0.4.0] - 2024-02-14 ### Added - The CudaInteropExecutor now executes CUDA interop nodes both on the render thread and as cuda commands. - The execution framework sets graph variables with the cudaStream_t and other execution state necessary for post render graph nodes ### Changed - Changed the ComputeParamsBuilder methods to return a reference, to allow multiple separate add* calls on the same instance. ## [0.3.2] - 2024-01-02 ### Changed - Updated the description of the extension in the readme file. ## [0.3.1] - 2023-12-13 ### Fixed - Fixed an issue where the graph state variables were not being properly initialized after a fabric snapshot was applied. # [0.3.0] - 2023-11-22 ## Added - Added support for compound nodes in pre and post render graphs. # [0.2.5] - 2023-11-16 ## Added - Added private interfaces for execution nodes CudaInteropEntryNodeDef and RenderProductInteropEntryNodeDef ## Fixed - Fixed bad cast to check for CudaInteropEntryNodeDef nodes in the CudaInteropExecutor # [0.2.4] - 2023-10-18 ## Changed - Using the added ‘canEvaluate’ ABI from core # [0.2.3] - 2023-10-10 ## Changed - The RenderGraphState is now stored in thread local storage to avoid data races in MGPU setups - Assert when attempting to update the PreRenderGraphDef in parallel from separate threads. # [0.2.2] - 2023-08-31 ## Fixed - Attach execution definition to the pre-render and post-render stage update root nodes. # [0.2.1] - 2023-08-25 ## Fixed - Ensure the runtime data is initialized before executing post render graphs. # [0.2.0] - 2023-08-17 ## Added - Introduced the IPreRenderGraph and IPostRenderGraph interfaces. - Implemented the execution graph for pre and post render graphs. # [0.1.1] - 2023-07-14 ## Changed - Improved the documentation of ComputeParams and ComputeParamsBuilder types. # [0.1.0] - 2023-05-12 ## Initial Version - Initial version introduces the ComputeParamsBuilder and ComputeParams types.
changelog-omni-graph-image-nodes_CHANGELOG.md	# Changelog This document records all notable changes to the omni.graph.image.nodes extension. The format is based on [Keep a Changelog](https://keepachangelog.com). The project adheres to [Semantic Versioning](https://semver.org). ## [1.1.0] - 2024-02-14 ### Changed - Updated the pre and post render graph nodes to access the framework data from the graph variables. ## [1.0.4] - 2024-01-23 ### Changed - Improved the node documentation. ## [1.0.3] - 2024-01-02 ### Changed - Updated the description of the extension in the readme file. ## [1.0.2] - 2023-12-20 ### Fixed - Typo ## [1.0.1] - 2023-08-03 ### Added - Test waiver since the automatic test detection does not recognize automatically generated tests ## [1.0.0] - 2023-07-25 ### Changed - Created the initial version with contents migrated from other extensions
changelog-omni-graph-index_CHANGELOG.md	# Changelog All notable changes to this project will be documented in this file. The format is based on Keep a Changelog, and this project adheres to Semantic Versioning. ## [0.3.7] - 2023-04-11 ### Added - Table of documentation links for nodes in the extension ## [0.3.6] - 2023-02-25 ### Changed - Modifed format of Overview to be consistent with the rest of Kit ## [0.3.5] - 2023-02-19 ### Changed - Added label to the main doc page so that higher level docs can reference the extension - Added link to the IndeX online docs ## [0.3.4] - 2023-02-17 ### Added - “threadsafe” scheduling hint to OgnTimestepSelector node. ## [0.3.3] - 2023-01-30 ### Changed - Removed the kit-sdk landing page - Moved all of the documentation into the new omni.graph.docs extension ## [0.3.2] - 2022-12-21 ### Changed - Refactored CUDA build to consolidate build functions and remove unnecessary rebuilds ## [0.3.1] - 2022-08-09 ### Fixed - Applied formatting to all of the Python files ## [0.3.0] - 2022-07-07 ### Added - Test for public API consistency
changelog-omni-graph-nodes_CHANGELOG.md	# Changelog All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ## [1.143.1] - 2024-04-17 ### Added - Add a ‘support_level’ entry to the configuration file of the extensions ## [1.143.0] - 2024-04-10 ### Changed - Bumped dependency on omni.graph to version 1.139.0 - Bumped dependency on omni.graph.core to version 2.177.1 - Bumped dependency on omni.graph.tools to version 1.77.0 ## [1.142.1] - 2024-04-08 ### Changed - Removed dependency on stage_templates and pipapi. ## [1.142.0] - 2024-03-27 ### Changed - Manual version bump to ensure that the version of this extension that’s built against kit 107 is higher than the one built against kit 106 (see OM-122109). ## [1.140.0] - 2024-03-18 ### Changed - Bumped dependency on omni.graph.core to version 2.176.3 - Bumped dependency on omni.graph to version 1.138.1 ## [1.139.2] - 2024-02-23 ### Changed - Cleanup and code coverage for matrix and vector math nodes ### Fixed - Fixed TranslateToTarget to allow for target prim to be specified (was bundle). ## [1.139.1] - 2024-02-22 ### Changed - Cleanup and code coverage for arithmetic nodes - Arithmetic nodes now unresolve output when new input is added. ## [1.139.0] - 2024-02-15 ## Changed - Bumped dependency on omni.graph.core to version 2.174.2 - Bumped dependency on omni.graph.tools to version 1.76.1 ## [1.138.0] - 2024-02-15 ### Fixed - Fixed vectorized node speed issues. ## [1.137.5] - 2024-02-07 ### Changed - Fix a bug in kit-omniverse variant test ## [1.137.4] - 2024-02-07 ### Fixed - Fix skinned points being in skeleton space rather than target prim space with ReadPrimsV2’s applySkelBinding ## [1.137.3] - 2024-02-07 ### Changed - Remove unnecessary warning when property is removed ## [1.137.2] - 2024-02-07 ### Changed - OMPRW-686 Sounds try to play before loaded ## [1.137.1] - 2024-02-05 ### Changed - OMPRW-596 Errors with “set variant selection” node on purse asset ## [1.137.0] - 2024-02-05 ### Changed - Bumped dependency on omni.graph to version 1.138.0 - Bumped dependency on omni.graph.core to version 2.174.0 - Bumped dependency on omni.graph.tools to version 1.76.0 ## [1.136.0] - 2024-02-03 ### Added - ReadTime and ReadPrimAttribute nodes now implements the IDirtyable interface to specify custom dirtying logic when placed in a lazy graph. ### Changed - Bumped minimum omni.graph.core extension version dependency to be compatible with changes to the INodeType interface and lazy graph executor. ## [1.135.2] - 2024-02-02 ### Changed - Update settings to use latest file format version from omni.graph ## [1.135.1] - 2024-01-31 ### Changed - Bundle asymmetry correction update file version ## [1.135.0] - 2024-01-31 ### Changed - Update settings to use latest file format version - Bumped dependency on omni.graph to version 1.137.0 - Bumped dependency on omni.graph.core to version 2.171.1 - Bumped dependency on omni.graph.tools to version 1.76.0 ## [1.134.0] - 2024-01-30 ### Changed - Moved uiName to a first order keyword for a few example nodes - Bumped dependency on omni.graph to version 1.136.1 - Bumped dependency on omni.graph.core to version 2.170.1 - Bumped dependency on omni.graph.tools to version 1.74.0 ## [1.133.3] - 2024-01-26 ### Changed - Clean up and update the docs of OgnRpResourceExample* nodes ## [1.133.2] - 2024-01-25 ### Fixed - WriteVariable output no longer aliases the variable. ## [1.133.1] - 2024-01-24 ### Changed - Minor doc improvements ## [1.133.0] - 2024-01-24 ### Changed - Expanded on and made consistent the node type documentation for a bunch of node types ## [1.132.3] - 2024-01-24 ### Changed - Updated some of the documentation in various .ogn’s in this extension. ## [1.132.2] - 2024-01-23 ### Changed - OM-117679: Pre-emptively fix tests prior to merging upstream MR ## [1.132.1] - 2024-01-23 ### Changed - Improve Documentation for Conversion nodes ## [1.132.0] - 2024-01-23 ### Changed - Bumped dependency on omni.graph to version 1.136.0 ## [1.131.2] - 2024-01-22 ### Changed - Fix build warnings ## [1.131.1] - 2024-01-22 ### Fixed - Made execution attribute descriptions consistent and informative ## [1.131.0] - 2024-01-19 ### Changed - WriteSetting now resolve it’s input attribute automatically - int array values are no longer converted to tuples, int64, double is used instead of int,float by default ## [1.130.0] - 2024-01-18 ### Added - Moved nodes from omni.graph.io ### Changed - Bumped dependency on omni.graph.core to version 2.169.1 - Bumped dependency on omni.graph to version 1.135.1 - Bumped dependency on omni.graph.tools to version 1.73.0 ## [1.129.2] - 2024-01-17 ### Fixed - crash with threaded prim translation nodes ## [1.129.1] - 2024-01-13 ### Fixed - Repository URL in config file. ## [1.129.0] - 2024-01-12 ### Changed ## [1.128.1] - 2024-01-12 ### Changed - Fix build warnings ## [1.128.0] - 2023-12-28 ### Changed - Improve run time of tests. - Bumped dependency on omni.graph.tools to version 1.69.0 ## [1.127.0] - 2023-12-28 ### Changed - Bumped dependency on omni.graph.core to version 2.167.0 - Bumped dependency on omni.graph to version 1.134.2 - Bumped dependency on omni.graph.tools to version 1.68.0 ## [1.126.1] - 2023-12-20 ### Changed - OgnRpResourceExampleAllocator: Check the validity of the ResourceManager before use. ## [1.126.0] - 2023-12-18 ### Fixed - Put in missing version numbers for .ogn files ### Changed - Bumped dependency on omni.graph.core to version 2.166.0 - Bumped dependency on omni.graph to version 1.134.0 - Bumped dependency on omni.graph.tools to version 1.65.0 ## [1.125.3] - 2023-12-14 ### Changed - Prevent excessive stage creation in the test exercising setting nodes ## [1.125.2] - 2023-12-14 ### Fixed - OgnRpResourceExampleAllocator: check the resource pointer before freeing the resource. ## [1.125.1] - 2023-12-13 ### Fixed - Fixed tests when FabricSceneDelegate is enabled - Non-USD compatible types no longer create ports on WritePrimAttributes ## [1.125.0] - 2023-12-12 ### Added - Filter for flaky test_read_and_write_settings ### Changed - Bumped dependency on omni.graph.core to version 2.165.3 - Bumped dependency on omni.graph to version 1.133.2 - Bumped dependency on omni.graph.tools to version 1.65.0 ## [1.124.0] - 2023-12-11 ### Changed - Update tests to latest kit behavior - Bumped dependency on omni.graph.core to version 2.165.3 - Bumped dependency on omni.graph to version 1.133.2 - Bumped dependency on omni.graph.tools to version 1.65.0 ## [1.123.0] - 2023-12-08 ### Changed - Implemented Minimum, Maximum, Logarithm, Inverse and Constant e nodes. ## Changed - Use ScopedRead lock on settings for thread safety ## [1.122.0] - 2023-12-05 ### Changed - Increase timeout ## [1.121.1] - 2023-12-05 ### Changed - Fix cross product test with correct attribute types ## [1.121.0] - 2023-12-04 ### Changed - Test coverage for utility nodes. - Utility nodes converted to computeVectorized. - *BreakVector nodes now support arrays. - Changed nodes to use correct set of input types instead of any. - GetPrimRelationship now hidden (deprecated). ### Added - Added tests for utility nodes. ### Fixed - Removing all attributes from ConstructArray node will no longer loose the input type. - Compare now works with half tuples ## [1.120.6] - 2023-12-04 ### Changed - Fix ogn tests that use inconsistent types ## [1.120.5] - 2023-11-30 ### Changed - Added test coverage to math trig nodes. - Math trig nodes now support tuples. ### Added - Replaced python ATan2 node with c++ version. ## [1.120.4] - 2023-11-30 ### Changed - Set the minimal omni.graph.core version required in order to properly load that extension ## [1.120.3] - 2023-11-28 ### Changed - Changed deprecated internal state functions to their new version ## [1.120.2] - 2023-11-21 ### Changed - Fix for CapitalizeString test failure ## [1.120.1] - 2023-11-21 ### Changed - Added simulation time attribute to node RpResourceExampleDeformer to make the test using it deterministic. ## [1.120.0] - 2023-11-21 ### Added - Implemented string nodes to manipulate strings ### Changed - Updated string nodes to use computeVectorized - Added test coverage for BuildString & AppendString ### Fixed - Fixed BuildString to prevent crashing when encountering invalid attribute resolutions.** ## [1.119.0] - 2023-11-15 ### Changed ## Changed ## [1.118.0] - 2023-11-15 ### Added - Added AppendArray node to merge multiple arrays. - Added ArrayAppendValue node to append values to the end of an array. - Added ArrayReplaceValue node to replace a specified value in an array - Added ArrayReverse node to reverse an array or string - Added ArraySlice node to return a partial array from an input array or string. ### Changed - Updated array nodes to use computeVectorized & correct output types. - Updated array node tests to test all available extended types. - Added string type to array nodes. - Added tests for code coverage. ### Fixed - Fixed crash with ArrayResize when index is negative. - Fixed broken removeAll behavior in ArrayRemoveValue node. ## [1.117.12] - 2023-11-14 ### Changed - Further code coverage for conversion nodes ## [1.117.11] - 2023-11-13 ### Changed - Improved code coverage for conversion nodes. ## [1.117.10] - 2023-11-10 ### Changed - Improve code coverage on variant nodes ## [1.117.9] - 2023-11-10 ### Changed - Improve code coverage on variant nodes ## [1.117.9] - 2023-11-10 ### Changed - Removed dead code paths ## [1.117.7] - 2023-11-09 ### Changed - Code coverage annotations for constants and io nodes ## [1.117.6] - 2023-11-09 ### Changed - Ran the formatter ## [1.117.5] - 2023-11-09 ### Changed - Improved coverage for core nodes ## [1.117.4] - 2023-11-07 ### Changed - Improved test coverage on geometry nodes ## [1.117.3] - 2023-11-07 ### Changed - Improved test coverage for attribute, constant and settings nodes ### Fixed - Issue where write settings nodes did not write all array elements ## [1.117.2] - 2023-11-03 ### Changed ## [1.117.1] - 2023-11-01 ### Fixed - WriteVariable now works with an auto converted input ## [1.117.0] - 2023-10-31 ### Changed - GetMatrix4Rotation now has correct output and allows inputs of angles, quaternions and rotation matrices. - SetQuaternion is deprecated/hidden. - GetMatrix4Quaternion now allows inputs of angles and rotation matrices. - SetMatrix4Rotation now allows inputs of angles, quaternions and rotation matrices. - RotateVector now allows inputs of angles, quaternions and rotation matrices. - Rotation transform nodes now allow users to change the rotation order. ### Added - Added BreakMatrix2\|3\|4 to extract vectors from a matrix - Added MakeMatrix2\|3\|4 to construct a matrix from vectors. - Added Orthonormalize node to orthonormalize a matrix - Added Transpose node to transpose (flip) a matrix - Added GetMatrix4Scale node extract the scale from a matrix - Added GetMatrix4RotationMatrix node extract the rotation matrix from a matrix - Added Ui templates for node with rotation order ## [1.116.2] - 2023-10-31 ### Changed - Built against kit-sdk version 132791 ## [1.116.1] - 2023-10-23 ### Changed - Vectorized some matrix nodes ### Added - Set Matrix4 scale ## [1.116.0] - 2023-10-17 ### Changed - Made modulo node vectorized ## [1.115.0] - 2023-10-09 ### Changed - Adding Conversion nodes for all supported types - ToDouble, ToFloat and ToHalf nodes now have the ability to select the attribute role of the output ## [1.114.0] - 2023-10-06 ### Changed - Changed ToToken and ToString to use computeVectorized - Fixed ToToken to properly work with empty tokens and uchar[] ## [1.113.0] - 2023-10-05 ### Fixed - SetPrimActive UI template ## [1.112.1] - 2023-10-04 ### Changed - Add fabric material bindings for Set, Clear, and Blend ## [1.112.0] - 2023-10-03 ### Changed - Fixed nodes that did not resolve output attributes correctly when using ‘Convert To’ command - SetMatrix* nodes now allow mixing of arrays and scalar inputs - Added checks to avoid invalid input situations in Ease, InterpolateTo, Compare and SelectIf nodes ## [1.110.3] - 2023-09-29 ### Changed - Implemented computeVectorized for a bunch of stock nodes ## [1.110.2] - 2023-09-27 ### Changed - Fixed compile error against latest fabric ## [1.110.1] - 2023-09-26 ### Changed - Disable failing test assert in `test_read_write_prims_remove_missing` tests ## [1.110.0] - 2023-09-25 ### Changed - Adding all attribute types to ConstructArray ## [1.109.0] - 2023-09-22 ### Changed - OM-110129: Use Bundle Write Block for Read Prims ## [1.108.2] - 2023-09-21 ### Changed - OM-109701 Bundle Inspector needs execution pins in order to work in AG ## [1.108.1] - 2023-09-19 ### Fixed - ReadVariable node: Do not reset extended attribute, as the framework already does it ## [1.108.0] - 2023-09-08 ### Changed - Added target nodes that more closely follow naming conventions - Deprecated GetPrimsAtPath and ConstantPrims ## [1.107.1] - 2023-09-01 ### Fixed - Fixed issue where unauthored attributes from schema were not readable/writeable ## [1.107.0] - 2023-08-31 ### Changed - ReadPrimsV2 now adds a sourcePrimHandle PathC attribute in the bundle, to avoid costly token->string->SdfPath conversion ## [1.106.5] - 2023-08-30 ### Fixed - Fixed ReadPrims and ReadPrimsV2 dangling paths that caused an access violation ## [1.106.4] - 2023-08-29 ### Changed - Moved reference to deprecated AutoNode implementation ## [1.106.3] - 2023-08-28 ### Changed - Change ReadPrims to more closely match the ImportUSDPrim imported attributes. ## [1.106.2] - 2023-08-26 ### Changed - Add kit target to extension. ## [1.106.1] - 2023-08-22 ### Fixed ## [1.106.0] - 2023-08-21 ### Changed - Added Constant nodes for all supported types ## [1.105.6] - 2023-08-15 ### Changed - Fix crash in GetPrimLocalToWorldTransform ## [1.105.5] - 2023-08-11 ### Changed - WritePrimsV2 node now cleans up created objects upon deletion. ## [1.105.4] - 2023-08-10 ### Changed - Cherry picked changes from Kit ## [1.105.3] - 2023-08-09 ### Changed - Moved extension from Kit to this repo ## [1.105.2] - 2023-08-08 ### Changed - Consolidated CreatedObjectsTracker(Group) code so it’s easier to follow. ### Fixed - Fixed a performace regression introduced by bundle change tracking on WritePrimsV2 node. ## [1.105.1] - 2023-08-05 ### Changed - `WritePrimsV2` node now supports bundle change tracking. Only changed prims/attributes in dirtied bundles will be written out during compute. ## [1.105.0] - 2023-08-03 ### Added - OgnReadPrimsV2 now always requests a node update whenever any of its tracked prims change, making it usable in dirty-push graphs. ## [1.104.0] - 2023-07-30 ### Changed - Moved GPU interop nodes to omni.graph.image.nodes ### Removed - Long deprecated function that has no body ### Added - Dependency on omni.graph.image.nodes for backward compatibility ## [1.103.1] - 2023-07-26 ### Changed - Modified unit test to conform to the new structuring of .ogn “tests” data. ## [1.103.0] - 2023-07-25 ### Changed - Revert output and state bundle name space separator to underscore ## [1.102.1] - 2023-07-20 ### Fixed - `ReadPrimsV2` skinned points are not synchronized from CPU to GPU ## [1.102.0] - 2023-07-14 ## Removed - Test for the read prim node, which requires omni.graph.test ## [1.101.0] - 2023-07-13 ### Changed - OM-97363: Resolve input-output bundle asymmetry ## [1.100.0] - 2023-07-12 ### Changed - Removed omni.kit.async_engine dependency ## [1.99.0] - 2023-07-06 ### Added - Enhanced USD change tracker and ReadPrimsV2 to track ancestors and descendants for incrementally updating the world matrix and local bound ## [1.98.3] - 2023-07-05 ### Changed - `ReadPrimsV2` avoids unnecessary update for the interpolation metadata ## [1.98.2] - 2023-07-01 ### Fixed - Null check in WritePrimAttribute ## [1.98.1] - 2023-06-30 ### Added - `ReadPrimsV2` node now supports importing relationship. ### Changed - `WritePrimsV2` node now treats unauthored schema properties on target prims as newly created properties. ## [1.98.0] - 2023-06-30 ### Added - ReadPrimsV2 updates prim attributes incrementally by leveraging USD change tracker. ## [1.97.4] - 2023-06-28 ### Fixed - Prevent emitting an error during type resolution in OgnConstructArray if input is not connected ## [1.97.3] - 2023-06-27 ### Fixed - Refactored OmniGraph documentation to point to locally generated files ## [1.97.2] - 2023-06-27 ### Changed - Set up the extension to load python nodes and tests in parallel ## [1.97.1] - 2023-06-27 ### Fixed - OgnConstructArray: fixed potential crash when setting the arraySize attribute to negative values. ## [1.97.0] - 2023-06-23 ### Changed - Tagged all constant nodes with the “pure” scheduling hint. ## [1.96.2] - 2023-06-23 ### Changed - Modified scheduling hint on OgnWritePrimRelationship to be “usd-write” only (instead of both “usd-read” and “threadsafe”). ## [1.96.1] - 2023-06-23 ## Changed - OM-93232, OM-95573* fix test_basic_write_prim_relationships flaky unit test ## [1.96.0] - 2023-06-23 ### Added - Enhanced USD change tracker to report which attributes were updated. ## [1.95.5] - 2023-06-21 ### Changed - Reverted parallel change from 1.95.3 ## [1.95.4] - 2023-06-21 ### Changed - Changed a few nodes to properly emit their compute messages with the proper instance index ## [1.95.3] - 2023-06-21 ### Changed - Set up the extension to load python nodes and tests in parallel ## [1.95.2] - 2023-06-19 ### Fixed - OM-98684: bugfix for write prims layer identifier assignment ## [1.95.1] - 2023-06-13 ### Fixed - Enabled timeline nodes Python code generator - Added missing frame-based start/end range get/set ## [1.95.0] - 2023-06-13 ### Changed - Nodes to control and query the main timeline ## [1.94.0] - 2023-06-11 ### Added - ReadPrimsV2 reads prim attributes into output bundle directly (without Fabric prefetch) ## [1.93.1] - 2023-06-05 ### Fixed - AppendString/BuildString were not properly enforcing all of their attribute type resolution ## [1.93.0] - 2023-06-03 ### Added - ReadPrimsV2 only updates child bundles whose associated USD prim changes - Added input attribute to disable this behavior ## [1.92.0] - 2023-06-03 ### Added - Input targets to GetPrims. ## [1.91.2] - 2023-05-31 ### Fixed - Adjusted the CRLF settings for the generated .md node table of content files ## [1.91.1] - 2023-05-31 ### Changed - WritePrims node doesn’t crash anymore when passing non-token values for sourcePrimPath and sourcePrimType attributes ## [1.91.0] - 2023-05-29 ### Added - Regenerated node table of contents ### Changed - WritePrims node doesn’t crash anymore when passing non-token values for sourcePrimPath and sourcePrimType attributes # [1.90.3] - 2023-05-26 ## Added - Added `inputs:layerIdentifier` to `WritePrimsV2` node to support writing to a specific local layer. - Added UI template and builder for a user friendly layer identifier property widget. # [1.90.2] - 2023-05-24 ## Changed - Modified unit tests/test scripts that were using the now-removed “pull” evaluation mode to instead use “push” (these tests did not rely on “pull” mode being explicitly used to fulfill their testing purposes). # [1.90.1] - 2023-05-23 ## Changed - Updated test_read_and_write_settings test to use an existing setting (the one it was using has since been removed). # [1.90.0] - 2023-05-17 ## Changed - Restored the original node functionality to ReadPrims node and marked it deprecated, hidden from UI. - All existing ReadPrims tests have been ported to run on both ReadPrims (legacy) and ReadPrimsV2 node. ## Added - Added ReadPrimsV2 node to host the new functionality in place of soft deprecated ReadPrims. - Added back legacy tests for WritePrims node # [1.89.0] - 2023-05-16 ## Added - Various improvements to random number nodes. - The nodes are now thread-safe - min/max and mean/stdev inputs are not optional, default to double. - min/max and mean/stdev inputs can now be set without connecting a const node. - Support for vectorization and graph instancing, combining the hash with the path of the graph target. - OgnRandomNumeric, OgnRandomGaussian, OgnRandomBoolean, OgnRandomUnitVector, OgnRandomUnitQuaterion. # [1.88.1] - 2023-05-15 ## Removed - Removed old subgraph unit tests. # [1.88.0] - 2023-05-15 ## Changed - Restored the original node functionality to WritePrims node and marked it deprecated, hidden from UI. ## Added - Added WritePrimsV2 node to host the new functionality in place of soft deprecated WritePrims. # [1.87.0] - 2023-05-12 ## Added - Added OgnReadPrimRelationship and OgnWritePrimRelationship nodes # [1.86.0] - 2023-05-11 ## Changed - Renamed `inputs:parentPrims` to `inputs:prims` on `WritePrims` node. - When `inputs:writeToUsd` on `WritePrims` is not enabled, making sure the target fabric prim has desired type, - `WritePrims` only removes attrs/prims previously created (instead of written to) by the node. ## Added - Added a new mode to `WritePrims` node as default to directly use the prim target as output prim (instead of appending source prim path and export under them). Controlled by `inputs:scatterUnderTargets`. ## [1.85.0] - 2023-05-09 ### Changed - Add startValue and endValue to Timer node ## [1.84.0] - 2023-05-07 ### Added - Stop All Sounds node ## [1.83.4] - 2023-05-04 ### Changed - `WritePrims` node is now able to pick different targets to write out prims to. - `useFindPrims` is no longer on `ReadPrims` node. As long as `pathPattern` is not empty, it turns on `useFindPrims` automatically. ## [1.83.3] - 2023-05-03 ### Changed - BlendVariant node mangles attribute names in some cases - lerp discrete properties half-way through the blend - Have blend continue when an attribute is not found for a variant property - Fix bug in UI for variantNameA ## [1.83.2] - 2023-05-03 ### Fixed - OM-92618 Failing test_prim_relationship_load test ## [1.83.1] - 2023-05-02 ### Changed - Updated OgnNor, OgnNand, OgnBuildString to use constructInputFromOutput during computation. ## [1.83.0] - 2023-05-01 ### Changed - Migrate variants from usePath to target type ## [1.82.7] - 2023-05-01 ### Fixed - Small perf improvement for ReadPrimAttribute - ReadPrimAttribute with invalid setup properly report the problem - WritePrimAttribute with invalid setup properly report the problem ## [1.82.6] - 2023-04-27 ### Added - Added `rootPrims` target to `ReadPrims` node so that `useFindPrims` can search under different prims other than absolute root. - Added tracker for all `ReadPrims`’s `rootPrims` paths. ## [1.82.5] - 2023-04-26 ### Changed - Blend Variants implementation to optionally blend local values ## [1.82.4] - 2023-04-24 ### Fixed - Replaced deprecated call to get_elem_count ## [1.82.3] - 2023-04-20 ### Fixed - `Read Prims` outputs invalid skinned mesh when SkelBinding is applied. ## [1.82.2] - 2023-04-17 ### Fixed - build of inputs:prim widget ## [1.82.1] - 2023-04-17 ### Fixed - Perf regression in ReadPrimAttribute ## [1.82.0] - 2023-04-12 ### Added - Random number nodes for action graphs - OgnRandomNumeric, OgnRandomGaussian, OgnRandomBoolean, OgnRandomUnitVector, OgnRandomUnitQuaterion ## [1.81.6] - 2023-04-12 ### Changed - Updated UI for nodes that input a target attibute and a prim path - Added material target input for WritePrimMaterial - Changed all templates to use OmniGraph version of property widget - Updated WritePrim to use target connections - ReadPrimsBundle now accepts multiple inputs ## [1.81.5] - 2023-04-13 ### Changed - Make the ReadPrimAttribute node only throw errors on compute to avoid confusing users ## [1.81.4] - 2023-04-12 ### Fixed - OgnWritePrims regression for Fabric array attributes ## [1.81.3] - 2023-04-12 ### Fixed - The attribute arraySize of OgnConstructArray is now literalOnly - Handle exceptions when attempting to remove connected attributes ## [1.81.2] - 2023-04-11 ### Added - Table of documentation links for nodes in the extension ## [1.81.1] - 2023-04-11 ### Fixed - Fixed a bug in OgnReadPrimAttribute when importing with timesamples ## [1.81.0] - 2023-04-05 - OgnAppendString is replaced by OgnBuildString and supports dynamic inputs. - OgnAdd, OgnSubtract, OgnMultiply, OgnAnd, OgnOr, OgnNand, OgnNor are updated to support dynamic inputs. ## [1.80.4] - 2023-04-05 ### Fixed - OgnConstructArray updates the arraySize correctly when an input cannot be removed because it is connected - OgnConstructArray removes input0 when the arraySize is set to 0 ## [1.80.3] - 2023-04-05 ### Fixed - OgnConstructArray updates the arraySize correctly when an input cannot be removed because it is connected - OgnConstructArray removes input0 when the arraySize is set to 0 ## [1.80.2] - 2023-04-05 ### Changed - Do not abuse `IBundle` to copy attribute, use `IAttributeData` instead. ## [1.80.1] - 2023-04-03 ### Changed - Name consistency pass - Added timcode to read/write prim Inputs group ## [1.80.0] - 2023-04-03 ### Added - Added a target input to nodes that currently take prim paths and prefer the target if both are provided ## [1.79.1] - 2023-03-31 ### Changed - Optimized OgnWritePrims by minimizing number of API calls. ## [1.79.0] - 2023-03-31 ### Changed - Updated tests for target output change to relationship ## [1.78.0] - 2023-03-30 ### Changed - Vectorized GetParentPrims, GetPrimPath, GetPrimPaths - Changed ConstantPrims to use an outputOnly input ## [1.77.1] - 2023-03-29 ### Changed - ConstantPrims and GetParentPrims tagged for multiple input targets ## [1.77.0] - 2023-03-28 ### Added - Target ports to OgnReadPrimMaterial ### Changed - GetPrimPath handles empty inputs - ToString converts empty tokens to empty strings ## [1.76.2] - 2023-03-28 ### Fixed - Failing target tests when ExecutionFramework is disabled ## [1.76.1] - 2023-03-24 ### Changed - Updated tests to check for new target python type (usdrt.Sdf.Path) ## [1.76.0] - 2023-03-24 ### Changed - Updated various nodes to use new target type for prim input ## [1.75.1] - 2023-03-21 ### Fixed - Fixed issue in ToToken/ToString where path types were ignored ## [1.75.0] - 2023-03-20 ### Fixed - Once node now resets correctly. ### Added - Countdown node ## [1.73.13] - 2023-03-17 ### Changed - Refactored nodes using the low performance anti-pattern of chained if statements to use direct type comparisons ## [1.73.12] - 2023-03-17 ### Fixed - Lint errors ## [1.73.11] - 2023-03-16 ### Added - “threadsafe” scheduling hints to various nodes. - “usd-write” scheduling hints to OgnWriteSetting and OgnWriteVariable nodes. ## [1.73.10] - 2023-03-13 ### Changed - The arraySize attribute of node OgnConstructArray defaults to 1 ### Fixed - Changing the arraySize property of OgnConstructArray resizes the input ports ## [1.73.9] - 2023-03-10 ### Fixed - Properly re-resolve input attribute with auto conversion on load ## [1.73.8] - 2023-03-10 ### Changed - ReadPrimAttribute is now vectorized and (a lot) faster - WritePrimAttribute is now vectorized and (a lot) faster ## [1.73.7] - 2023-03-06 ### Fixed - Setting proper evaluation mode when evaluating a single graph through ABI ## [1.73.6] - 2023-03-01 ### Fixed - spurious error messages from ReadPrimAttribute, WritePrimAttribute empty attributes ## [1.73.5] - 2023-02-28 ### Fixed - Writing back to usd with a Write node in a for loop ## [1.73.4] - 2023-02-27 ### Fixed - Makes OgnFindPrim instantiatable ## [1.73.3] - 2023-02-27 ### Fixed - og tests failing: ‘test_block_variant_set’ and ‘test_set_variant_selection’ ## [1.73.2] - 2023-02-27 ### Changed - Reenable test_copy_attr test from omni.graph.nodes ## [1.73.1] - 2023-02-25 ### Changed - Modifed format of Overview to be consistent with the rest of Kit ## [1.73.0] - 2023-02-22 ### Added - Changed ReadPrim nodes to use nan as a default for timecode inputs ## [1.72.1] - 2023-02-22 ### Added - Links to JIRA tickets regarding filling in the missing documentation ## [1.72.0] - 2023-02-21 ### Changed - Variant nodes update ## [1.71.5] - 2023-02-19 ### Changed - Added label to the main doc page so that higher level docs can reference the extension - Tagged for adding links to node documentation ## [1.71.4] - 2023-02-17 ### Added - “threadsafe” scheduling hints to OgnCreateTubeTopology, OgnCurveFrame, OgnCurveTubePositions, OgnCurveTubeST, OgnLengthAlongCurve, OgnSelectIf, and OgnToUint64 nodes. ### Removed - “threadsafe” scheduling hint from OgnArrayLength node (uses bundles, which are not guaranteed to be threadsafe at the time of writing). ## [1.71.3] - 2023-02-15 ### Fixed - MakeArray resizing when inputs added/removed ## [1.71.2] - 2023-02-14 ### Fixed - OnGamepadInput, OnMouseInput for instancing ## [1.71.1] - 2023-02-10 ### Changed - Using fabric states for OgnAppendPath instead of internal state (improves perf) ## [1.71.0] - 2023-02-09 ### Removed - Moved `OgnSetViewportFullscreen` into the omni.graph.ui extension ## [1.70.0] - 2023-02-07 ### Removed - Obsolete test of builtins ## [1.69.1] - 2023-02-06 ### Changed - Add usd read/write hints to SetCameraTarget, SetCameraPosition, SetActiveViewportCamera ## [1.69.0] - 2023-02-03 ### Added - Sound category and Play, Stop, Pause Sound nodes ## [1.68.0] - 2023-02-03 ### Added - Add Absolute Node to compute absolute value for scalars and arrays. ## [1.67.1] - 2023-02-03 ## Fixed - Fixed incorrect warnings in Write Prims - OM-78182 ## [1.67.0] - 2023-02-03 ### Added - Added `OgnSetViewportFullscreen` which toggles fullscreen on/off for viewport(s) and visibility on/off for all other panes. ## [1.66.4] - 2023-01-30 ### Changed - Removed the kit-sdk landing page - Moved all of the documentation into the new omni.graph.docs extension ## [1.66.3] - 2023-01-27 ### Changed - Modified some node to be vectorization friendly ## [1.66.2] - 2023-01-23 ### Added - `OgnHasVariantSet`, `OgnGetVariantNames`, `OgnGetVariantSelection`, `OgnGetVariantSetNames`, `OgnClearVariantSelection`, and `OgnSetVariantSelection` ## [1.66.1] - 2023-01-20 ### Added - `Read Prims` improved caching for bbox and xform ## [1.66.0] - 2023-01-12 ### Added - `Bundle Inspector` can now inspect recursive bundles. ## [1.65.0] - 2023-01-11 ### Removed - Gather prototype is gone ### Changed - ABI calls to take into account instancing - Few nodes implement vectorized computes ## [1.64.0] - 2022-12-23 ### Added - `WritePrims` to write a fan-in of hierarchical bundles back to Fabric or USD prims ## [1.63.1] - 2023-01-05 ### Changed - `Read Prims` no longer creates a custom attribute named `normals:interpolation` for skinnable prims. ## [1.63.0] - 2023-01-03 ### Added - `Read Prims` reads interpolation of the attribute. This feature allows `Import` # [1.62.2] - 2022-12-21 ## Changed - Refactored CUDA build to consolidate build functions and remove unnecessary rebuilds # [1.62.1] - 2022-12-20 ## Fixed - `Read Prims` outputs invalid attribute data when reading multiple prims at non-default USD timecode. # [1.62.0] - 2022-12-15 ## Added - `Read Prims` reads skeletal data and applies SkelBinding to deform skinnable prims. # [1.61.5] - 2022-12-14 ## Fixed - ReadPrimAttributes was evicting from the cache all other attributes from the targetted prim that some other nodes could need # [1.61.4] - 2022-12-14 ## Fixed - GatherByPath from failing when run twice. It shouldn’t rely on static counters. # [1.61.3] - 2022-12-02 ## Fixed - Forces WriteVariable to actually write the array value to the variable location, and bypass CoW # [1.61.2] - 2022-11-11 ## Fixed - Convert if/else to switch case to improve performance of Magnitude node # [1.61.1] - 2022-11-11 ## Fixed - Convert if/else to switch case to improve performance of Normalize node # [1.61.0] - 2022-11-10 ## Added - OnMessageBusEvent # [1.60.0] - 2022-11-08 ## Added - ReadStageSelection, IsPrimSelected # [1.59.0] - 2022-11-03 ## Added - `Read Prims` outputs Multiple Primitives in a Bundle. - `Read Prims into Bundle` outputs Multiple Primitives in a Bundle. - `Extract Prim` takes Multiple Primitives input and extract Single Primitive in the output. - `Type Pattern` to `Find Prims` and provided backward compatibility. ## Changed - Reverted `Read Prim` functionality to output Single Primitive in a Bundle, deprecated and hidden. - Reverted `Read Prim into Bundle` functionality to output Single Primitive in a Bundle, deprecated and hidden. - Reverted `Extract Bundle` functionality. ## [1.58.3] - 2022-11-03 ### Fixed - Fixes WritePrimAttribute not loading correctly if inputs have auto-conversion ## [1.58.2] - 2022-11-03 ### Fixed - Bug in GatherByPath, FindPrims ## [1.58.1] - 2022-11-03 ### Changed - Custom layout for property panel of the `GetPrims` node. ## [1.58.0] - 2022-10-31 ### Added - Added `GetPrims` node to filter primitives in the input bundle by path and type. ## [1.57.1] - 2022-10-31 ### Fixed - IsEmpty now errors on un-resolved inputs ## [1.57.0] - 2022-10-28 ### Added - Pattern matcher, with exclusion support, for nodes: `FindPrims`, `ReadPrim`, `ReadPrimBundle`, `RemoveAttr`. ## [1.56.1] - 2022-10-26 ### Changed - Re-enabled unreliable tests: `test_remove_attr`, `test_rename_attr` ## [1.56.0] - 2022-10-19 ### Added - New node Exponent ### Changed - Update NthRoot node to check componentCount/baseType rather than rely on tryCompute ## [1.55.0] - 2022-10-12 ### Added - `ReadPrimIntoBundle` added an attribute filter that specifies names or wildcard patterns of the attributes to be imported. - `ReadPrim` added an attribute filter that specifies names or wildcard patterns of the attributes to be imported. ## [1.54.1] - 2022-10-12 ### Changed ## [1.54.0] - 2022-10-07 ### Changed - Flagged test_remove_attr as unreliable. ### Changed - `ExtractBundle` searches for one specific child bundle with a path in the input bundle. - `ReadPrimIntoBundle` outputs multiple primitives in bundle. - `ReadPrimIntoBundle`’s primPath attribute became an extended attribute with supporting `token`, `token[]`, and `path`. - `ReadPrim` outputs multiple primitives in bundle. - `ReadPrim` uses path pattern attribute to discover primitives in the stage using wildcard path pattern matching. ## [1.53.1] - 2022-10-07 ### Changed - Flag test_rename_attr as unreliable to get the integ-master queue moving again. ## [1.53.0] - 2022-10-05 ### Added - ‘up’ input to GetLookAtRotation node. Defaults to scene up. This prevents spinning about the aim vector. ## [1.52.0] - 2022-09-28 ### Changed - `ToString` no longer adds enclosing quotes for uchar[] inputs. ## [1.51.0] - 2022-09-28 ### Added - `FindPrims` added `pathPattern` attribute to search for primitives based on wildcard path pattern matching. ## [1.50.0] - 2022-09-23 ### Modified - GetPrimPath returns a “path” type as well as a token ## [1.49.0] - 2022-09-20 ### Added - New node ToUint64 ## [1.48.1] - 2022-09-13 ### Fixed - Don’t force FC to eject the prim every time we add another attribute. ## [1.48.0] - 2022-09-02 ### Added - Added IsEmpty node ## [1.47.0] - 2022-08-31 ### Added - Data model write scope to avoid race conditions during parallel executions ## [1.46.0] - 2022-08-26 ### Added - Added `GraphInstanceSpecific` to enable acceleration structures work per graph instance # [1.45.2] - 2022-08-17 ## Fixed - Enabled Copy-on-Write for ArrayRemoveValue node # [1.45.1] - 2022-08-24 ## Changed - Added the ability to force USD read in read nodes - Added the ability to choose whether or not write nodes should write back to USD # [1.45.0] - 2022-08-24 ## Added - Added `computeBoundingBox` support to ReadPrim node # [1.44.0] - 2022-08-23 ## Added - Added USD timecode support to ReadPrim node # [1.43.0] - 2022-08-17 ## Changed - added prim rel to ReadPrimRelationship node # [1.42.0] - 2022-08-16 ## Added - EndsWith, StartsWith # [1.41.2] - 2022-08-15 ## Changed - Read Prim Into Bundle value changes of Add Target parameter did not trigger node computation # [1.41.1] - 2022-08-11 ## Changed - Added support for tuples and arrays to Ceil & Floor nodes # [1.41.0] - 2022-08-11 ## Added - Path inputs to transformation nodes # [1.40.1] - 2022-08-09 ## Fixed - Applied formatting to all of the Python files # [1.40.0] - 2022-08-09 ## Changed - Removed omni.graph.scriptnode dependency # [1.39.0] - 2022-08-04 ## Added - Added Ceil node # [1.38.0] - 2022-08-03 ## Added - BundleInspector returns number of child bundles. # [1.37.4] - 2022-08-03 ## Fixed - Handling of compatible types in the Make Array node and error with saving and loading # [1.37.3] - 2022-07-28 ## Fixed - Handling of token and string input in the Compare node # [1.37.2] - 2022-07-27 ## Changed ## [1.37.1] - 2022-07-25 ### Fixed - All of the lint errors reported on the Python files in this extension ## [1.37.0] - 2022-07-20 ### Changed - Added requiredRelationship feature to FindPrims ## [1.36.0] - 2022-07-14 ### Changed - Added +/- icons to Make Array ## [1.35.0] - 2022-07-07 ### Changed - Refactored imports from omni.graph.tools to get the new locations ### Added - Test for public API consistency ## [1.34.1] - 2022-07-06 ### Changed - Prevent the re-setup of the ReadPrimAttribute and WritePrimAttribute each frame, and only re-do it when necessary ## [1.34.0] - 2022-07-05 ### Added - Added dynamic version of MakeArray node replacing the previous fixed version ## [1.33.1] - 2022-06-30 ### Changed - Convert CrossProduct node to C++ ## [1.33.0] - 2022-06-29 ### Added - Added OgnReadSetting and OgnWriteSetting nodes. ## [1.32.0] - 2022-06-29 ### Changed - Added several new constant nodes ## [1.31.0] - 2022-06-24 ### Changed - Moved ReadMouseState into omni.graph.ui ## [1.30.3] - 2022-06-21 ### Changed - Convert DotProduct node to C++ ## [1.30.2] - 2022-06-16 ### Changed - Now using the new write-back mechanism for nodes that should write back to USD ## [1.30.1] - 2022-06-15 ### Changed - Refactored compute algorithm to find the correct type faster ## [1.28.0] - 2022-05-31 ### Added - Nodes for vertex deformation using gpu interop and pre-render evaluation ## [1.30.0] - 2022-06-13 ### Added - (No specific details provided) ## [1.29.0] - 2022-06-06 ### Added - Added ReadOmniGraphValue node ## [1.28.0] - 2022-05-30 ### Added - Added logic directory for logical operators - Added boolean operator nodes in logic which support array and bool array inputs ### Changed - Soft deprecated (via metadata:hidden) OgnBooleanExpr in favour of the new individual logical nodes - Moved OgnBooleanExpr to logic directory - Moved OgnBooleanNot to logic from math and renamed it to OgnNot to match the new naming convention - Updated OgnBooleanNot to take bool or bool array input instead of just bool, to match the new logical operator nodes ## [1.27.3] - 2022-05-27 ### Removed - Some useless dependencies/visibility to PathToAttributeMap ## [1.27.2] - 2022-05-19 - Converted ToDouble to C++ ## [1.27.1] - 2022-05-18 ### Changed - Converted Array Manipulation Nodes from python to C++. ## [1.27.0] - 2022-05-18 ### Added - Added OgnNegate node that multiplies input by -1 ## [1.26.2] - 2022-05-16 ### Fixed - ReadPrimBundle/Attribute not correctly export the bounding box when asked to - Fixed and Re-activated the test that exercises this feature ## [1.26.1] - 2022-05-16 ### Fixed - ToToken no longer appends quote characters to a converted string ## [1.26.0] - 2022-05-11 ### Added - ExtractBundle node: “explode” a bundle content into individual dynamic attributes ### Changed - ReadPrimBundle/ReadPrimAttribute/WritePrim/WritePrimAtribute now uses OG ABI instead of direct Fabric access - ReadPrim is using functionnality of ReadPrimBundle and ExtractBundle - RemoveAttribute is using OGN wrapper instead of direct ABI access ## [1.25.4] - 2022-05-05 ### Changed - Converted OgnArraySetIndex node from python to C++. ## [1.25.3] - 2022-05-05 ### Fixed - Fixed string input for SelectIf node ## [1.25.2] - 2022-05-05 ### Fixed - Read/WritePrimAttribute will now issue error messages when usePath is true and attribute is not found. ## Changed - Converted OgnMagnitude node from python to C++. - Converted OgnDivide node from python to C++. - Converted OgnRound node from python to C++. ## [1.25.0] - 2022-05-02 ### Changed - Converted OgnToString, OgnToToken, OgnToFloat, OgnClamp to cpp - MakeVector2/3/4 will now auto-resolve inputs when at least one input is resolved ## [1.24.0] - 2022-04-29 ### Removed - Obsolete tests ### Changed - Made tests derive from OmniGraphTestCase ## [1.23.3] - 2022-04-28 ### Changed - Converted OgnSubtract node from python to C++. ## [1.23.2] - 2022-04-27 ### Fixed - Fixed bug in Distance3D, InvertMatrix and Round nodes ## [1.23.1] - 2022-04-26 ### Fixed - Fixed bug in MakeTransform node ## [1.23.0] - 2022-04-21 ### Added - GraphTarget node that retrieves the path of instance being run ## [1.22.0] - 2022-04-14 ### Added - Changed OgnTrig node into cpp node - Broke OgnTrig node by operation ## [1.21.4] - 2022-04-18 ### Changed - Added support for more characters to Generate3dText ## [1.21.3] - 2022-04-12 ### Fixed - Fixed a bug in GetLookAtRotation and GetLocationAtDistanceOnCurve nodes ## [1.21.2] - 2022-04-08 ### Changed - Changed Compose/Decompose Tuple to Make/Break Vector for those nodes and make them C++ nodes ## [1.21.1] - 2022-04-11 ### Fixed - Generate3dText node ## [1.21.0] - 2022-04-05 ### Added - Added Generate3dText node ## [1.20.1] - 2022-04-08 ### Added - Added absoluteSimTime output attribute to the ReadTime node ## [1.20.0] - 2022-04-05 ### Added # [1.19.2] - 2022-04-06 ## Added - Added Normalize node # [1.19.1] - 2022-04-03 ## Fixed - RotateToOrientation bug, Maneuver node bugs with varying target input. # [1.19.0] - 2022-03-30 ## Added - WriteVariable value output port # [1.18.4] - 2022-03-31 ## Fixed - Fixed crash when copying bundle with empty points attribute # [1.18.3] - 2022-03-23 ## Added - Tests for maneuver nodes # [1.18.3] - 2022-03-21 - Revive functionnality from 1.16.1 with different approach # [1.18.2] - 2022-03-18 ## Fixed - Naming of constant nodes # [1.18.1] - 2022-03-16 ## Fixed - Bug in MoveToTransform # [1.18.0] - 2022-03-14 ## Added - Added MakeTransformLookAt node. # [1.17.1] - 2022-03-11 - Revert changes of 1.16.1 # [1.17.0] - 2022-03-10 ## Added - Added `outputs::shiftOut`, `outputs::ctrlOut`, `outputs::altOut` to `ReadKeyboardState` node. # [1.16.1] - 2022-03-07 ## Fixed - ReadPrimBundle/ReadPrimAttribute can now use a usd time code at which to import the prim/attribute - ReadPrimBundle now outputs its transform and BBox # [1.16.0] - 2022-03-01 ## Added - `bundle_test_utils.BundleResultKeys` - `bundle_test_utils.prim_with_everything_definition` - `bundle_test_utils.get_bundle_with_all_results` - `bundle_test_utils.bundle_inspector_results` - `bundle_test_utils.verify_bundles_are_equal` - `bundle_test_utils.filter_bundle_inspector_results` ## Fixed - Made bundle tests and utility node tests use the Controller - GatherByPath, add checkResyncAttributes attribute ## Changed - Deprecated old bundle test utilities that relied on USD save/read and OmniGraphHelper for functioning - Updated some tests to use OmniGraphTestCase ## [1.15.0] - 2022-02-17 ### Fixed - added a “path”” constant node ## [1.15.0] - 2022-02-15 ### Changed - WritePrim node now uses GPU arrays for points ## [1.14.0] - 2022-02-15 ### Fixed - added a dependency on omni.graph.scriptnode ## [1.13.2] - 2022-02-14 ### Fixed - add additional extension enabled check for omni.graph.ui not enabled error ## [1.13.2] - 2022-02-14 ### Fixed - MoveToTarget, RotateToTarget etc bug with float, half precision XformOp ## [1.13.1] - 2022-02-13 ### Fixed - ReadPrimBundle, ReadPrim now support token[] attributes ## [1.13.0] - 2022-02-11 ### Added - ReadVariable and WriteVariable nodes ## [1.12.3] - 2022-02-10 ### Fixed - Fixed MoveToTarget, MoveToTransform, RotateToTarget, GetPrimDirectionVector, GetMatrix4Quaternion and GetLocationAtDistanceOnCurve nodes behaviour when rotation is scaled ## [1.12.2] - 2022-02-07 ### Fixed - Fixed ArrayRotate, Compare, and SelectIf nodes behaviour when input was a token ## [1.12.1] - 2022-02-04 ### Fixed - RotateToOrientation, MoveToTransform attrib docs ## [1.12.0] - 2022-01-31 ### Added - Added shouldWriteBack input flag to GatherByPath node ### Fixed - Fixed duplicate path behaviour for gather nodes ## [1.11.0] - 2022-01-27 ### Added - Added IsPrimActive node - Added BooleanNot ## [1.10.1] - 2022-01-28 ### Fixed - spurious error message when creating ReadPrim - updated extension doc ## [1.10.0] - 2022-01-27 ### Added - added ReadMouseState node ## [1.9.2] - 2022-01-28 ### Modified ## [1.9.1] - 2022-01-24 ### Fixed - categories for several nodes ## [1.9.0] - 2022-01-19 ### Added - Added constant Pi node which will output a constant Pi or its multiple - Added Nth Root node which will calculate the nth root of inputs ## [1.8.0] - 2022-01-17 ### Added - Added sets of tryCompute (including for arrays and tuples) functions to allow one non-runtime attribute input when two inputs - Added Increment Node ## [1.7.1] - 2022-01-11 ### Changed - Changed token names in ReadGamepadState node - Fixed incorrect default token in ReadGamepadState node ## [1.7.0] - 2022-01-10 ### Added - Added GetPrimDirectionVector node ## [1.6.0] - 2022-01-07 ### Added - Added ReadGamepadState node ## [1.5.3] - 2022-01-06 ### Changed - Categories added to all nodes ## [1.5.2] - 2022-01-05 ### Modified - ReadPrimBundle and ReadPrim now have a sourcePrimPath bundle attribute which contains the path of the Prim being read. ## [1.5.1] - 2021-12-30 ### Changed - ArrayIndex converted to C++, AppendString now supports string inputs ## [1.5.0] - 2021-12-20 ### Added - Added ReadTime and moved GetLookAtRotation from omni.graph.action ## [1.4.0] - 2021-12-17 ### Added - Added ReadKeyboardState node ## [1.3.0] - 2021-12-02 ### Added - UI templates for Read/WritePrimAttribute nodes ### Changed - Read/WritePrimAttribute nodes usePath attribute now defaults to False ## [1.2.2] - 2021-11-24 ### Changed - Prevented some problematic attributes from being exposed by ReadPrimAttributes and WritePrimAttributes ## [1.2.1] - 2021-11-19 ## [1.3.0] - 2021-11-25 ### Changed - Bug fix for ReadPrimAttributes ## [1.2.0] - 2021-11-04 ### Added - TransformVector - RotateVector ### Changed - Multiply: Support adding scalars to tuples - Add: Support adding scalars to tuples - MatrixMultiply: Support matrix * vector as well as matrix * matrix ### Moved - OgnAdd2IntegerArray: Moved to omni.graph.test (deprecated by Add) - OgnMultiply2IntegerArray: Moved to omni.graph.test (deprecated by Multiply) ## [1.1.0] - 2021-10-17 ### Added - PrimRead, PrimWrite ## [1.0.0] - 2021-03-01 ### Initial Version - Started changelog with initial released version of the OmniGraph core
changelog-omni-graph-rtxtest_CHANGELOG.md	# Changelog This document records all notable changes to the omni.graph.rtxtest extension. The format is based on [Keep a Changelog](https://keepachangelog.com). The project adheres to [Semantic Versioning](https://semver.org). ## [1.19.1] - 2024-04-17 ### Added - Add a ‘support_level’ entry to the configuration file of the extensions ## [1.19.0] - 2024-04-10 ### Changed - Bumped dependency on omni.graph to version 1.139.0 - Bumped dependency on omni.graph.core to version 2.177.1 - Bumped dependency on omni.graph.tools to version 1.77.0 ## [1.18.2] - 2024-04-08 ### Changed - Removed dependency on stage_templates. ## [1.18.1] - 2024-03-26 ### Changed - Added test to validate that the CUDA device set by OmniGraph is in the allowed DeviceGroup selected by the Renderer. ## [1.18.0] - 2024-03-18 ### Added - Added test showcasing how the stage at time can be read from the post render graph. - Added native test to validate that the graph state variables are initialized after the execution graph compilation. - Added native test to validate that building the post render graphs does not crash when some input node attributes have unknown types. ### Changed - Bumped dependency on omni.graph.core to version 2.176.3 - Bumped dependency on omni.graph to version 1.138.1 - Bumped dependency on omni.graph.image.core to version 0.4.3 ## [1.17.0] - 2024-02-20 ### Added - Added tests covering the computeCuda node ABI and the declaration of new AOVs in cuda interop nodes of the post render graph ## [1.16.0] - 2024-02-15 ### Changed - Bumped dependency on omni.graph.core to version 2.176.3 - Bumped dependency on omni.graph to version 1.138.1 - Bumped dependency on omni.graph.image.core to version 0.4.3 ## [1.15.0] - 2024-02-05 ### Changed - Bumped dependency on omni.graph to version 1.138.0 - Bumped dependency on omni.graph.core to version 2.174.0 - Bumped dependency on omni.graph.tools to version 1.76.0 ## [1.14.1] - 2024-02-03 ### Changed - Bumped minimum omni.graph.core extension version dependency to be compatible with changes to the INodeType interface and lazy graph executor. ## [1.14.0] - 2024-01-31 ### Changed - Bumped dependency on omni.graph to version 1.137.0 - Bumped dependency on omni.graph.core to version 2.171.1 - Bumped dependency on omni.graph.tools to version 1.76.0 ## [1.13.0] - 2024-01-30 ### Changed - Bumped dependency on omni.graph to version 1.136.1 - Bumped dependency on omni.graph.core to version 2.170.1 - Bumped dependency on omni.graph.tools to version 1.74.0 ## [1.12.0] - 2024-01-23 ### Changed - Bumped dependency on omni.graph to version 1.136.0 ## [1.11.2] - 2024-01-22 ### Changed - Disable sampled lighting in the extension config. ## [1.11.1] - 2024-01-22 ### Fixed - Made execution attribute descriptions consistent and informative ## [1.11.0] - 2024-01-18 ### Changed - Bumped dependency on omni.graph.core to version 2.169.1 - Bumped dependency on omni.graph to version 1.135.1 - Bumped dependency on omni.graph.tools to version 1.73.0 ## [1.10.1] - 2024-01-13 ### Fixed - Repository URL in config file. ## [1.10.0] - 2024-01-12 ### Changed - Bumped dependency on omni.graph to version 1.134.7 - Bumped dependency on omni.graph.core to version 2.169.0 - Bumped dependency on omni.graph.tools to version 1.70.0 ## [1.9.1] - 2024-01-03 ### Added - Fixed a typo ## [1.9.0] - 2023-12-28 ### Changed - Bumped dependency on omni.graph.tools to version 1.69.0 ## [1.8.0] - 2023-12-28 ### Changed - Bumped dependency on omni.graph.core to version 2.167.0 - Bumped dependency on omni.graph to version 1.134.2 ## [1.7.1] - 2023-12-18 ### Added - Added test validating the expected error when executing a post render graph explicitly ## [1.7.0] - 2023-12-18 ### Changed - Bumped dependency on omni.graph.core to version 2.166.0 - Bumped dependency on omni.graph to version 1.134.0 - Bumped dependency on omni.graph.tools to version 1.65.0 ## [1.6.1] - 2023-12-14 ### Changed - Disable RTX tests when FSD is enabled ## [1.6.0] - 2023-12-12 ### Changed - Bumped dependency on omni.graph.core to version 2.165.3 - Bumped dependency on omni.graph to version 1.133.2 - Bumped dependency on omni.graph.tools to version 1.65.0 ## [1.5.0] - 2023-12-11 ### Changed - Bumped dependency on omni.graph.core to version 2.165.3 - Bumped dependency on omni.graph to version 1.133.2 - Bumped dependency on omni.graph.tools to version 1.65.0 ## [1.4.7] - 2023-11-30 ### Changed - Set the minimal omni.graph.core version required in order to properly load that extension ## [1.4.6] - 2023-11-30 ### Changed - Added test to validate that cuda interop nodes can have internal state ## [1.4.5] - 2023-11-21 ### Changed - Enabled the pre and post render graph tests. ## [1.4.4] - 2023-11-09 ### Changed - Ran the formatter ## [1.4.3] - 2023-08-29 ### Changed - Disable the RTX tests ## [1.4.2] - 2023-08-28 ### Changed - Enable pre and post render graph tests ## [1.4.1] - 2023-08-21 ### Removed - Remove the synthetic data tests. ## [1.4.0] - 2023-08-18 ### Added - Migrated tests from omni.syntheticdata in Kit that require action graph nodes ## [1.3.6] - 2023-08-14 ### Changed - Disabled tests know to be failing ## [1.3.5] - 2023-08-09 ### Changed - Disabled tests know to be failing ## [1.3.4] - 2023-08-03 ### Changed - up the wait count for the renderer ## [1.3.3] - 2023-07-31 ### Changed - Targeted a specific version of the Kit SDK ## [1.3.2] - 2023-07-22 ### Changed - Standardized the format of the CHANGELOG ## [1.3.1] - 2023-07-20 ### Changed - Bumping the extension number to force a republication with the proper Linux configuration ## [1.3.0] - 2023-07-19 ### Changed - Bumping the version so that debug versions of extensions will publish ## [1.2.1] - 2023-07-19 ### Added - Build copy of data files required for extension publication ## [1.2.0] - 2023-07-18 ### Changed - Moved docs dependencies to the local test extension ## [1.1.2] - 2023-07-14 ### Added - Preview image and icon for publishing ## [1.1.1] - 2023-06-12 ### Changed - Moved files out of LFS for easier management ## [1.1.0] - 2023-05-26 ### Fixed - Moved extension over from Kit repo to OmniGraph repo ## [1.0.5] - 2023-05-12 ### Added - Added end to end tests for the post render graph ## [1.0.4] - 2023-03-22 ### Added - Added unit test for `LockViewportRender` node ## [1.0.3] - 2023-02-25 ### Fixed - Corrected a bad reference ## [1.0.2] - 2023-01-30 ### Changed - Modifed format of Overview to be consistent with the rest of Kit - Added cross-extension link to omni.graph.test ## [1.0.1] - 2022-12-21 ### Changed - Added link at the top of the changelog for docs ## Changed - Refactored CUDA build to consolidate build functions and remove unnecessary rebuilds ## [1.0.0] - 2022-08-30 ### Added - Migrated the prerender graph tests from omni.graph.test
changelog-omni-graph-samples_CHANGELOG.md	# Changelog ## [1.0.0] - 2024-01-18 ### Added - Created extension to manage configuration of OmniGraph samples
changelog-omni-graph-scriptnode_CHANGELOG.md	# Changelog This document records all notable changes to the omni.graph.scriptnode extension. The format is based on [Keep a Changelog](https://keepachangelog.com). The project adheres to [Semantic Versioning](https://semver.org). ## [1.18.2] - 2024-04-26 ### Fixed - The warp test uses the same CUDA device as OmniGraph in MGPU environments. ## [1.18.1] - 2024-04-17 ### Added - Add a ‘support_level’ entry to the configuration file of the extensions ## [1.18.0] - 2024-04-15 ### Changed - Updated the warp extension dependency to get the latest instead of a specific version ## [1.17.0] - 2024-03-20 ### Changed - Bumped dependency on omni.graph to version 1.134.1 - Bumped dependency on omni.graph.core to version 2.168.1 ## [1.16.0] - 2024-02-09 ### Changed - Updated version number to work after the Kit branch was renamed from 105.2 to 106. ## [1.9.0] - 2024-02-05 ### Changed - Bumped dependency on omni.graph to version 1.134.0 - Bumped dependency on omni.graph.core to version 2.167.1 - Bumped dependency on omni.graph.tools to version 1.76.0 ## [1.8.1] - 2024-01-30 ### Fixed - Incremented version to compensate for a pipeline failure last week. ## [1.7.0] - 2024-01-23 ### Fixed - Made dependency on omni.warp to an explicit version to get the latest ## [1.6.0] - 2024-01-15 ## [1.5.1] - 2024-01-13 ### Fixed - Minor problems in Warp snippet ## [1.5.0] - 2024-01-12 ### Changed - Bumped dependency on omni.graph to version 1.133.4 - Bumped dependency on omni.graph.core to version 2.165.3 - Bumped dependency on omni.graph.tools to version 1.69.0 ## [1.4.0] - 2024-01-10 ### Added - Tests for code coverage ### Fixed - Minor problems in script node ## [1.3.0] - 2023-12-12 ### Changed - Bumped dependency on omni.graph.core to version 2.165.3 - Bumped dependency on omni.graph to version 1.133.2 - Bumped dependency on omni.graph.tools to version 1.65.0 ## [1.2.0] - 2023-12-11 ### Changed - Bumped dependency on omni.graph.core to version 2.165.3 - Bumped dependency on omni.graph to version 1.133.2 - Bumped dependency on omni.graph.tools to version 1.65.0 ## [1.1.9] - 2023-11-28 ### Changed - Changed deprecated internal state functions to their new version ## [1.1.8] - 2023-11-13 ### Changed - Manual version bump ## [1.1.7] - 2023-11-10 ### Added - Check for missing path in state ## [1.1.6] - 2023-08-03 ### Changed - Targeted a specific version of the Kit SDK ## [1.1.5] - 2023-07-31 ### Changed - Migrated the extension from the Kit repo ## [1.1.4] - 2023-07-11 ### Removed - Obsolete docs debugging link ## [1.1.3] - 2023-06-27 ### Fixed - Refactored OmniGraph documentation to point to locally generated files ## [1.1.2] - 2023-06-06 ### Fixed - Fixed ScriptNode to work in instanced graphs. ## [1.1.1] - 2023-05-31 ### Fixed - Fixed ScriptNode to work in instanced graphs. ### Fixed - Adjusted the CRLF settings for the generated .md node table of content files ### [1.1.0] - 2023-05-29 #### Added - Regenerated node table of contents ### [1.0.1] - 2023-05-11 #### Fixed - Bugs loading a script from a file - Bug in timing of opt-in dialog ### [1.0.0] - 2023-05-05 #### Changed - Improved performance with file-based scripts - ‘Reload Script’ press now required instead of continuous re-compile - state:omni_intitialized can be set to False to trigger a reload by script ### [0.12.0] - 2023-04-26 #### Changed - use omni.client to read script file - rework the property panel UI ### [0.11.5] - 2023-04-11 #### Added - Table of documentation links for nodes in the extension ### [0.11.4] - 2023-03-16 #### Added - “usd-write” scheduling hint to OgnScriptNode node. ### [0.11.3] - 2023-02-25 #### Changed - Modifed format of Overview to be consistent with the rest of Kit ### [0.11.2] - 2023-02-22 #### Added - Links to JIRA tickets regarding filling in the missing documentation ### [0.11.1] - 2023-02-19 #### Changed - Added label to the main doc page so that higher level docs can reference the extension - Tagged for adding links to node documentation - Added information on the security risks of the extension ### [0.11.0] - 2023-02-07 #### Changed - opt-in is enabled by /app/omni.graph.scriptnode/enable_opt_in - modify the dialog to appear after loading - disable all graphs until opt-in is verified ### [0.10.2] - 2023-02-02 #### Fixed - Lint error that appeared when pylint updated ### [0.10.1] - 2023-01-30 #### Changed - Removed the kit-sdk landing page - Moved all of the documentation into the new omni.graph.docs extension ### [0.10.0] - 2022-12-07 #### Changed - demonstrate how to use GPU dynamic attributes in Warp snippet ### [0.9.0] - 2022-09-12 ### Added - [0.8.0] - 2022-08-31 - Added - User-defined callbacks ‘compute’, ‘setup’, and ‘cleanup’, along with a reset button - Ability to “remove” outputs:execOut by hiding it - Support for warp, inspect, ast, and other modules by saving inputs:script to a temp file - Script path input for reading scripts from files - Improved textbox UI for inputs:script using omni.kit.widget.text_editor - [0.7.2] - 2022-08-23 - Changed - Removed security warnings. We don’t want to advertise the problem. - [0.7.1] - 2022-08-09 - Fixed - Applied formatting to all of the Python files - [0.7.0] - 2022-08-09 - Changed - Removed omni.graph.action dependency - [0.6.0] - 2022-07-07 - Changed - Refactored imports from omni.graph.tools to get the new locations - [0.5.0] - 2022-03-30 - Changed - Give each example code snippet a title, which will be displayed when you click on the Code Snippets button - Change title of Add Attribute window from “Create a new attribute…” to “Create Attribute” - Disable resizing of the Add Attribute dialog - Add Cancel button to the Add Attribute dialog - Make the Add Attribute/Remove Attribute/Code Snippets buttons left aligned - Allow users to add Script Node to push graphs by removing the graph:action category - Fixed - Fixed a bug where Remove Attribute button allows you to remove the node-as-bundle output attribute - [0.4.1] - 2022-03-10 - Fixed - Made property panel only display non-None props - Renamed some variables to better match what they are doing - [0.4.0] - 2022-02-28 - Added - Gave user the ability to add and remove dynamic attribute from the script node via UI - Also allowed user to select a fixed, static type for their new attributes - Created a popup dialog window for the Add Attribute button, which has a search bar for the attribute types - Removed - Removed the existing inputs:data and outputs:data attributes which are of type “any” - [0.3.0] - 2022-02-18 - Added - A default script with a simple example, and some comments explaining how to use the script node - Three example scripts to illustrate the various functionalities of the script node - Changed - Move the script node widget into a template - Move the multiline editor to the top of property window, so that we don’t have two multiline editors - Compile the script before executing it - Catch errors and log the errors ## [0.2.0] - 2022-02-15 ### Added - icon and category ## [0.1.2] - 2021-10-19 ### Modified - Restructured plugin files as part of repo relocation ## [0.1.1] - 2021-06-30 ### Modified - Change bundle input to Any type ## [0.1.0] - 2021-06-30 ### Added - Initial publish
changelog-omni-graph-telemetry_CHANGELOG.md	# Changelog This document records all notable changes to the omni.graph.telemetry extension. The format is based on [Keep a Changelog](https://keepachangelog.com). The project adheres to [Semantic Versioning](https://semver.org). ## [2.13.1] - 2024-04-17 ### Added - Add a ‘support_level’ entry to the configuration file of the extensions ## [2.13.0] - 2024-04-10 ### Changed - Bumped dependency on omni.graph to version 1.139.0 - Bumped dependency on omni.graph.core to version 2.177.1 ## [2.12.0] - 2024-03-18 ### Changed - Bumped dependency on omni.graph.core to version 2.176.3 - Bumped dependency on omni.graph to version 1.138.1 ## [2.11.0] - 2024-02-15 ### Changed - Bumped dependency on omni.graph.core to version 2.174.2 ## [2.10.0] - 2024-02-05 ### Changed - Bumped dependency on omni.graph to version 1.138.0 - Bumped dependency on omni.graph.core to version 2.174.0 ## [2.9.0] - 2024-01-31 ### Changed - Bumped dependency on omni.graph to version 1.137.0 - Bumped dependency on omni.graph.core to version 2.171.1 ## [2.8.0] - 2024-01-30 ### Changed - Bumped dependency on omni.graph to version 1.136.1 - Bumped dependency on omni.graph.core to version 2.170.1 ## [2.7.0] - 2024-01-23 ### Changed - Bumped dependency on omni.graph to version 1.136.0 # [2.6.0] - 2024-01-18 ## Changed - Bumped dependency on omni.graph.core to version 2.169.1 - Bumped dependency on omni.graph to version 1.135.1 # [2.5.1] - 2024-01-13 ## Fixed - Repository URL in config file. # [2.5.0] - 2024-01-12 ## Changed - Bumped dependency on omni.graph to version 1.134.7 - Bumped dependency on omni.graph.core to version 2.169.0 # [2.4.0] - 2023-12-28 ## Changed - Bumped dependency on omni.graph.core to version 2.167.0 - Bumped dependency on omni.graph to version 1.134.2 # [2.3.0] - 2023-12-18 ## Changed - Bumped dependency on omni.graph.core to version 2.166.0 - Bumped dependency on omni.graph to version 1.134.0 # [2.2.0] - 2023-12-12 ## Changed - Bumped dependency on omni.graph.core to version 2.165.3 - Bumped dependency on omni.graph to version 1.133.2 # [2.1.0] - 2023-12-11 ## Changed - Bumped dependency on omni.graph.core to version 2.165.3 - Bumped dependency on omni.graph to version 1.133.2 # [2.0.2] - 2023-12-04 ## Changed - Comment out schema code generation # [2.0.1] - 2023-12-04 ## Changed - Fix lint error # [2.0.0] - 2023-12-01 ## Added - Initial version of the OmniGraph telemetry extension # [1.0.0] - 2023-10-23 ## Initial Version
changelog-omni-graph-template-cpp_CHANGELOG.md	# Changelog This document records all notable changes to the omni.graph.template.cpp extension. The format is based on [Keep a Changelog](https://keepachangelog.com). The project adheres to [Semantic Versioning](https://semver.org). ## [2.3.1] - 2024-04-17 ### Added - Add a ‘support_level’ entry to the configuration file of the extensions ## [2.3.0] - 2024-02-09 ### Changed - Updated version number to work after the Kit branch was renamed from 105.2 to 106. ## [2.2.1] - 2024-01-13 ### Fixed - Repository URL in config file. ## [2.2.0] - 2023-11-30 ### Changed - Beefed up the documentation for how to use the template ## [2.1.4] - 2023-10-11 ### Changed - Patch bump to force republication for omniexts.nvidia.com ## [2.1.3] - 2023-08-03 ### Changed - Targeted a specific version of the Kit SDK ## [2.1.2] - 2023-07-31 ### Changed - Standardized the format of the CHANGELOG ## [2.1.1] - 2023-07-20 ### Changed - Bumping the version so that debug versions of extensions will publish ## [2.1.0] - 2023-07-19 ### Changed - Replaced the generated node links page with generated node docs ## [2.0.2] - 2023-07-14 ### Changed - Moved files out of LFS for easier management ## [2.0.1] - 2023-06-26 ### Changed - Ensured that docs and data directories propagate to the build ## [2.0.0] - 2023-05-26 ### Changed - Created the initial instantiation with working documentation ## [1.0.0] - 2023-05-23 ### Changed - Created the initial instantiation with working documentation ## [0.0.1] - 2023-05-05 ### Initial Version
changelog-omni-graph-template-mixed_CHANGELOG.md	# Changelog This document records all notable changes to the omni.graph.template.mixed extension. The format is based on [Keep a Changelog](https://keepachangelog.com). The project adheres to [Semantic Versioning](https://semver.org). ## [2.3.1] - 2024-04-17 ### Added - Add a ‘support_level’ entry to the configuration file of the extensions ## [2.3.0] - 2024-02-09 ### Changed - Updated version number to work after the Kit branch was renamed from 105.2 to 106. ## [2.2.1] - 2024-01-13 ### Fixed - Repository URL in config file. ## [2.2.0] - 2023-11-30 ### Changed - Beefed up the documentation for how to use the template ## [2.1.5] - 2023-11-09 ### Added - Tests for coverage ## [2.1.4] - 2023-10-11 ### Changed - Patch bump to force republication for omniexts.nvidia.com ## [2.1.3] - 2023-08-03 ### Changed - Targeted a specific version of the Kit SDK ## [2.1.2] - 2023-07-31 ### Changed - Standardized the format of the CHANGELOG ## [2.1.1] - 2023-07-20 ### Changed - Standardized the format of the CHANGELOG ## [2.1.0] - 2023-07-19 ### Changed - Replaced the generated node links page with generated node docs ## [2.0.4] - 2023-07-18 ### Added - Import omni.bind requires in order to instantiate interface objects ## [2.0.3] - 2023-07-14 ### Changed - Moved files out of LFS for easier management ## [2.0.2] - 2023-06-12 ### Fixed - Corrected the path to the local copy of the carbonite documentation ## [2.0.1] - 2023-05-31 ### Added - Missing dependencies to pick up Carbonite docs ## [2.0.0] - 2023-05-26 ### Changed - Created the initial instantiation with working documentation ## [1.0.0] - 2023-05-23 ### Changed - Created the initial instantiation with working documentation ## [0.0.1] - 2023-05-05 ### Initial Version
changelog-omni-graph-template-no-build_CHANGELOG.md	# Changelog All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ## [2.3.1] - 2024-04-17 ### Added - Add a ‘support_level’ entry to the configuration file of the extensions ## [2.3.0] - 2024-02-09 ### Changed - Updated version number to work after the Kit branch was renamed from 105.2 to 106. ## [2.2.0] - 2023-11-30 ### Changed - Beefed up the documentation for how to use the template ## [2.1.0] - 2023-07-19 ### Changed - Replaced the generated node links page with generated node docs ## [2.0.1] - 2023-07-14 ### Changed - Moved files out of LFS for easier management ## [2.0.0] - 2023-05-26 ### Changed - Created the initial instantiation with working documentation ## [1.0.0] - 2023-05-23 ### Changed - Created the initial instantiation with working documentation ## [0.0.1] - 2023-05-05 ### Initial Version
changelog-omni-graph-test_CHANGELOG.md	# Changelog This document records all notable changes to the omni.graph.test extension. The format is based on [Keep a Changelog](https://keepachangelog.com). The project adheres to [Semantic Versioning](https://semver.org). ## [Unreleased] ## [0.79.1] - 2024-04-17 ### Added - Add a ‘support_level’ entry to the configuration file of the extensions ## [0.79.0] - 2024-04-10 ### Changed - Bumped dependency on omni.graph to version 1.139.0 - Bumped dependency on omni.graph.core to version 2.177.1 - Bumped dependency on omni.graph.tools to version 1.77.0 ## [0.78.1] - 2024-04-08 ### Changed - Removed dependency on stage_templates. ## [0.78.0] - 2024-03-18 ### Changed - Bumped dependency on omni.graph.core to version 2.176.3 - Bumped dependency on omni.graph to version 1.138.1 ## [0.77.6] - 2024-03-04 ### Changed - Temporarily skip some tests if Fabric Scene Delegate is disabled ## [0.77.5] - 2024-02-29 ### Changed - Temporarily disable test_evaluator_type_changed_from_usd. ## [0.77.4] - 2024-02-26 ### Changed - Temporarily disable failing lazy graph unit tests. ## [0.77.3] - 2024-02-26 ### Changed - Added test to validate that OmniGraphs cannot be loaded from USD when ## [0.77.2] - 2024-02-23 ### Changed - Updated tests for maneuver nodes ## [0.77.1] - 2024-02-23 ### Changed - Re-enabled flaky test ## [0.77.0] - 2024-02-21 ### Changed - Removes a test that doesn’t work in its current form (new one will be required to exercise the feature) ## [0.76.0] - 2024-02-15 ### Fixed - Filtered out a known test failure ### Changed - Bumped dependency on omni.graph.core to version 2.174.2 - Bumped dependency on omni.graph.tools to version 1.76.1 ## [0.75.2] - 2024-02-07 ### Changed - Add test for skinned points local space ## [0.75.1] - 2024-02-06 ### Added - Test for adding a relationship attribute to a bundle via BundlePrim::addRelationship. ## [0.75.0] - 2024-02-05 ### Changed - Bumped dependency on omni.graph to version 1.138.0 - Bumped dependency on omni.graph.core to version 2.174.0 - Bumped dependency on omni.graph.tools to version 1.76.0 ## [0.74.4] - 2024-02-05 ### Changed - New unit test to validate that recursive graph execution triggered via parallel-scheduled nodes works correctly and does not deadlock. ## [0.74.3] - 2024-02-03 ### Changed - Bumped minimum omni.graph.core extension version dependency to be compatible with changes to the INodeType interface and lazy graph executor. ## [0.74.2] - 2024-02-02 ### Changed - Added test for upstream fix of action graph ## [0.74.1] - 2024-01-31 ### Added - Bundle asymmetry correction unit tests ## [0.74.0] - 2024-01-31 ### Changed - Bumped dependency on omni.graph to version 1.137.0 - Bumped dependency on omni.graph.core to version 2.171.1 - Bumped dependency on omni.graph.tools to version 1.76.0 ## [0.73.0] - 2024-01-30 ### Changed - Bumped dependency on omni.graph to version 1.136.1 - Bumped dependency on omni.graph.core to version 2.170.1 - Bumped dependency on omni.graph.tools to version 1.74.0 ## [0.72.2] - 2024-01-26 ## [0.72.1] - 2024-01-25 ### Added - tests for self connection in compound subgraphs ## [0.72.0] - 2024-01-23 ### Added - Test for write variable aliasing with arrays ## [0.71.2] - 2024-01-22 ### Changed - Bumped dependency on omni.graph to version 1.136.0 ## [0.71.1] - 2024-01-22 ### Fixed - Made execution attribute descriptions consistent and informative ## [0.71.0] - 2024-01-18 ### Changed - Bumped dependency on omni.graph.core to version 2.169.1 - Bumped dependency on omni.graph to version 1.135.1 - Bumped dependency on omni.graph.tools to version 1.73.0 ## [0.70.1] - 2024-01-13 ### Fixed - Repository URL in config file. ## [0.70.0] - 2024-01-12 ### Changed - Bumped dependency on omni.graph to version 1.134.7 - Bumped dependency on omni.graph.core to version 2.169.0 - Bumped dependency on omni.graph.tools to version 1.70.0 ## [0.69.1] - 2024-01-11 ### Changed - Temporarily disable a test requiring a newer versions of nodes to be released ## [0.69.0] - 2024-01-11 ### Added - Test that exercise auto-instancing option - Test that exercise auto-instanced graph explicit direct evaluation ## [0.68.1] - 2024-01-10 ### Fixed - test_query_prim_view that failed when ran async ## [0.68.0] - 2024-01-09 ### Added - Test that exercise a graph backed by a stage-with-history fabric and filtering turned off ## [0.67.0] - 2023-12-28 ### Changed - Disable multiple fabric test with FSD enabled. - Bumped dependency on omni.graph.tools to version 1.69.0 ## [0.66.0] - 2023-12-28 ### Removed - Reference to local link in README file - Filter on tests failing from an earlier Kit SDK update ## Changed - Bumped dependency on omni.graph.core to version 2.167.0 - Bumped dependency on omni.graph to version 1.134.2 - Bumped dependency on omni.graph.tools to version 1.68.0 ## [0.65.1] - 2023-12-18 ### Added - Added test validating the expected error when `og.Controller.evaluate` is invoked with invalid graph ids ## [0.65.0] - 2023-12-18 ### Fixed - Put in missing version numbers for .ogn files ### Changed - Bumped dependency on omni.graph.core to version 2.166.0 - Bumped dependency on omni.graph to version 1.134.0 - Bumped dependency on omni.graph.tools to version 1.65.0 ## [0.64.2] - 2023-12-18 ### Changed - Address security issues in test nodes ## [0.64.1] - 2023-12-14 ### Changed - Fix tests when FabricSceneDelegate is enabled ## [0.64.0] - 2023-12-12 ### Changed - Reapplied dependency bumps to fix publishing problem ## [0.63.0] - 2023-12-11 ### Changed - Bumped dependency on omni.graph.core to version 2.165.3 - Bumped dependency on omni.graph to version 1.133.2 - Bumped dependency on omni.graph.tools to version 1.65.0 ## [0.62.0] - 2023-12-11 ### Added - Test exercising target mapped attribute with custom fabric backing ## [0.61.0] - 2023-12-06 ### Changed - Test that exercise deleting a graph with a node whose type has been unregistered ## [0.60.2] - 2023-12-05 ### Changed - Increase timeout ## [0.60.1] - 2023-12-02 ### Changed - Update tests for node validation ## [0.60.0] - 2023-12-01 ### Changed - Add a test for AG dependency fold pass ## [0.59.12] - 2023-12-01 ### Changed - Improve coverage for compound nodes ## [0.59.11] - 2023-11-30 ### Changed - Set the minimal omni.graph.core version required in order to properly load that extension ## [0.59.10] - 2023-11-30 ### Changed - Skip running parallel execution tests if the test machine does not have enough cores ## [0.59.9] - 2023-11-28 ### Changed - Changed deprecated internal state functions to their new version ## [0.59.8] - 2023-11-23 ### Changed - Disable connection validation tests temporarily ## [0.59.7] - 2023-11-20 ### Changed - Use newer, stable INodeTypeForwarding2 ONI. ## [0.59.6] - 2023-11-13 ### Fixed - Callback test not calling the correct function ### Added - Test to exercise dynamic attributes without USD backing - Test to exercise USD-less bad node creation ## [0.59.5] - 2023-11-10 ### Added - Code coverage removal for test node implementations ## [0.59.4] - 2023-11-10 ### Added - Add test for update issue with type resolution of dynamic attributes. OM-108200 ## [0.59.3] - 2023-11-09 ### Changed - Improved coverage of io nodes ## [0.59.2] - 2023-11-09 ### Changed - Ran the formatter ## [0.59.1] - 2023-11-09 ### Changed - Improved coverage for core nodes ## [0.59.0] - 2023-11-08 ### Changed - Added a test that exercise per-instance and shared internal state ## [0.58.0] - 2023-11-07 ### Added - Add/Modify some tests to improve og.Core testing code coverage ## [0.57.1] - 2023-11-01 ### Changed - Added compound example to test_controller_api ## [0.57.0] - 2023-11-01 ### Changed - Added a test that exercise registering an inexistent relative path ## [0.56.2] - 2023-11-01 ### Fixed - Added tests for WriteVariable and WritePrimAttribute with an auto converted input ## [0.56.1] - 2023-10-27 ### Changed - Add test that accesses invalid variables ## [0.56.0] - 2023-10-27 ### Added - Stress test to help replicate rare test crashes ## [0.55.1] - 2023-10-27 ### Changed - Reenable target mapping tests ## [0.55.0] - 2023-10-23 ### Added - A test to exercise unmapping deferred mapping ## [0.54.2] - 2023-10-20 ### Changed - Temporarily disable another target map test ## [0.54.1] - 2023-10-20 ### Changed - Disabled tests that require nodes to be rebuilt. - Fixed abi test for attributes to match new additions ## [0.54.0] - 2023-10-18 ### Added - Tests for Query-Compute ## [0.53.2] - 2023-10-18 ### Changed - Fixup compound node type tests to use latest schema ## [0.53.1] - 2023-10-12 ### Changed - Add regression test for OM-110707 ## [0.53.0] - 2023-10-11 ### Added - Missing USD tests cases for testing all types ### Removed - Non-SDF types from USD test cases ## [0.52.1] - 2023-10-10 ### Changed - OM-110007: Unit tests for graph instances removal ## [0.52.0] - 2023-10-10 ### Added - Tests that replicate hangs with omni.anim.curves.core loaded ## [0.51.0] - 2023-10-06 ### Changed - Temporary disable of a test that will break with upcoming changes to core ## [0.50.1] - 2023-10-05 ### Changed - Re-enable compound node tests, updated for new compound node type format ## [0.50.0] - 2023-09-29 ### Added - Moved test_write_prims_node.py in from omni.graph.nodes - Added new test node that is equivalent to the old AutoNode one # [0.49.4] - 2023-09-27 ## Changed - Converted the AutoNode test in the above file to use the new test node # [0.49.3] - 2023-09-26 ## Changed - Disabled a flaky test # [0.49.2] - 2023-09-21 ## Added - Added a test for a stack overflow bug when setting a big array from python # [0.49.1] - 2023-09-13 ## Changed - OM-61324: Remove test_import_time_samples test from unreliable list # [0.49.0] - 2023-09-13 ## Added - Tests that exercise default values # [0.48.1] - 2023-09-12 ## Changed - Updating tests for new target nodes # [0.48.0] - 2023-09-07 ## Added - Tests for reading and writing of execution attributes - Support for running against extension versions # [0.47.1] - 2023-09-06 ## Changed - Temporarily disable a copy prim tests # [0.47.0] - 2023-09-01 ## Added - Test coverage for copying a node into a compound graph # [0.46.1] - 2023-09-01 ## Changed - Temporary disable extended attribute test # [0.46.0] - 2023-09-01 ## Removed - Redundant test of the node type forwarding # [0.45.2] - 2023-08-29 ## Changed - Moved reference to deprecated AutoNode implementation # [0.45.1] - 2023-08-28 ## Changed - Update tests for changes to ReadPrims. # [0.45.0] - 2023-08-23 ## Changed - Auto instancing tests to exercise reload_from_stage # [0.44.4] - 2023-08-16 ## Fixed - Forced update to get the latest version of the code generation ## [0.44.3] - 2023-08-15 ### Changed - Adds tests for compound type resolution bugs ## [0.44.2] - 2023-08-14 ### Fixed - Removed workaround for missing include in Fabric ## [0.44.1] - 2023-08-14 ### Fixed - Increase the number of maximum tries before the test test_rotate_to_target is expected to converge to the target value ## [0.44.0] - 2023-08-14 ### Changed - Ported over tests from Kit that make extensions require unnecessary dependencies on omni.graph.nodes ## [0.43.2] - 2023-08-14 ### Added - New unit tests inside of a node .ogn file to exercise the new functionality. ## [0.43.1] - 2023-08-14 ### Changed - Fix test for renamed action nodes ## [0.43.0] - 2023-08-14 ### Removed - test validating a constant that is about to be removed ## [0.42.0] - 2023-08-10 ### Added - Moved tests with circular dependencies out of omni.graph.nodes ## [0.41.1] - 2023-08-09 ### Fixed - Linux build errors ## [0.41.0] - 2023-08-09 ### Added - Tests for promotion and renaming that cover all data types ## [0.40.8] - 2023-08-07 ### Fixed - OM-100540 Fix node removal bug that appears in ScriptNode ## [0.40.7] - 2023-08-05 ### Fixed - OM-67770 Update Simple Rename unit test ## [0.40.6] - 2023-08-03 ### Changed - Targeted a specific version of the Kit SDK ## [0.40.5] - 2023-07-31 ### Changed - Standardized the format of the CHANGELOG ## [0.40.4] - 2023-07-27 ### Changed - OM-97363 Revert separator to underscore for output and state bundles ## [0.40.3] - 2023-07-26 ### Fixed - (No specific issue mentioned) - API calls that changed in Kit ## [0.40.2] - 2023-07-24 ### Changed - Temporarily disabled a test causing trouble with the ETM ## [0.40.1] - 2023-07-21 ### Fixed - Update call to `build` to follow latest EF recommendation. ## [0.40.0] - 2023-07-21 ### Added - Test node and script to test data sync of skinned points from CPU to GPU for ReadPrimsV2 ### Fixed - Compilation failure due to API signature change of `omni::graph::exec::unstable::GraphBuilder::create()` ## [0.39.1] - 2023-07-20 ### Changed - Bumping the version so that debug versions of extensions will publish ## [0.39.0] - 2023-07-19 ### Added - Build copy of data files required for extension publication ## [0.38.0] - 2023-07-18 ### Added - Test added on the Kit side after extension migration - Preview image and icon for publishing ## [0.37.5] - 2023-07-18 ### Changed - Disabled bundle output compound tests ## [0.37.4] - 2023-07-14 ### Added - Moved the extension over from the Kit repo ## [0.37.3] - 2023-06-28 ### Changed - Updated scheduling hint unit tests to use new ISchedulingHints2 interface when working with purity scheduling hints. ## [0.37.2] - 2023-06-27 ### Fixed - Excluded USD files and docs from node generated code in the files that missed it ## [0.37.1] - 2023-06-27 ### Changed - Set up the extension to load python nodes and tests in parallel ## [0.37.0] - 2023-06-22 ### Added - Test for constant node elision in Push and Action graphs. ### Changed - Modified some other unit tests to correctly account for the new fact that constant nodes will not be computed in Push and Action graphs. - Edited a scheduling hint unit test to also account for the “pure” hint. - Refactored the test partition passes (consolidated into fewer number of files). ## [0.36.0] - 2023-06-20 ### Added - (End of content) ## [0.35.0] - 2023-05-30 ### Added - Unit test for checking that EF partition passes work correctly in instanced graphs. ## [0.34.0] - 2023-05-26 ### Added - Test for CREATE_ATTRIBUTES flag in the controller.edit() function ## [0.33.8] - 2023-05-24 ### Changed - Modified tests that were using, but not reliant on the behavior of, the now-nonexistant “pull” evaluation mode to instead use “push”. ### Removed - Unit tests/test scenes that were explicitly testing the “pull” evaluation mode. ## [0.33.7] - 2023-05-17 ### Changed - Updated tests to work with restored ReadPrims and ReadPrimsV2 nodes. ## [0.33.6] - 2023-05-15 ### Removed - Removed old subgraph unit tests. ## [0.33.5] - 2023-05-15 ### Changed - Updated WritePrims to WritePrimsV2 node. ## [0.33.4] - 2023-05-15 ### Added - Unit tests for non-instanced OnDemand pipeline stage to ensure that it works correctly with the Execution Framework (EF) code-path. ## [0.33.3] - 2023-05-12 ### Changed - Moved partition pass unit tests for omni.graph.examples.cpp out of this extension. ## [0.33.2] - 2023-05-11 ### Changed - Renamed `inputs:parentPrims` to `inputs:prims` on `WritePrims` node in unittest. ## [0.33.1] - 2023-05-09 ### Added - Test for OM-94114 to check if recursive children removal is handled properly. ## [0.33.0] - 2023-05-09 ### Added - More detailed tests for deprecation support ## [0.32.2] - 2023-05-08 ### Fixed - Bug with Python code generator for BundleContents ## [0.32.1] - 2023-05-04 ### Changed - Updated `ReadPrims` related tests during to node inputs changes. ## [0.32.0] - 2023-05-02 ## [0.31.0] - 2023-05-02 ### Added - Tests for node type forwarding ## [0.30.2] - 2023-04-11 ### Added - Table of documentation links for nodes in the extension ## [0.30.1] - 2023-04-06 ### Fixed - Changed direct reference to a struct member to an accessor ## [0.30.0] - 2023-04-03 ### Added - Tests for ABI of omni.graph.core.Attribute ## [0.29.0] - 2023-03-31 ### Changed - target attributes now use relationships with output and state ports - Updated TestAllDataTypes to use multi-target target attributes ## [0.28.10] - 2023-03-29 ### Changed - Close stage at end of test to avoid dangling graph references. ## [0.28.9] - 2023-03-24 ### Added - Unit tests for EF partition pass examples (ForEach and ScriptNode). ## [0.28.8] - 2023-03-24 ### Fixed - Lint errors ## [0.28.7] - 2023-03-23 ### Added - Single-node cycles to PushGraph- and PullGraph-EF integration tests, to make sure that nodes with such cycles still get computed. ## [0.28.6] - 2023-03-17 ### Added - Unit tests to check that PushGraphs and PullGraphs correctly ignore cycles. ## [0.28.5] - 2023-03-17 ### Added - Added tests for target types ## [0.28.4] - 2023-03-17 ### Fixed - Lint errors ## [0.28.3] - 2023-03-16 ### Added - “threadsafe” scheduling hints for OgnBundleProperties, OgnTestBundleAttributeInterpolation, and OgnTestScatter nodes. ## [0.28.2] - 2023-03-08 ### Added - Added tests for the graph traversal APIs ## [0.28.1] - 2023-02-28 ### Added - Added tests for target types # [0.28.0] - 2023-02-27 ## Added - Added Python binding for IGraphContext::getInputTargets() and unit test # [0.27.9] - 2023-02-25 ## Changed - Modifed format of Overview to be consistent with the rest of Kit # [0.27.8] - 2023-02-21 ## Removed - Action Graph “integration” tests that were actually just testing specific AG node behavior and/or AG evaluator functionality w/o broader integrations; moved these tests to omni.graph.action instead. # [0.27.7] - 2023-02-17 ## Added - Dedicated EF test for isolate scheduling. # [0.27.6] - 2023-02-17 ## Added - “threadsafe” scheduling hints to OgnAdd2IntArray, OgnComposeDouble3C, OgnComputeErrorCpp, OgnDecomposeDouble3C, OgnMultiply2IntArray, OgnPerturbPoints, OgnPerturbPointsGpu, OgnRandomPoints, OgnRandomPointsGpu, OgnSubtractDoubleC, OgnTestAllDataTypesCarb, OgnTestAllDataTypesPod, OgnTestDeformer, OgnTestGracefulShutdown, OgnTestNanInf, and OgnTestTypeResolution nodes. # [0.27.5] - 2023-02-10 ## Changed - EF dedicated tests will always run with EF backend, regardless of the execution backend provided to test generation # [0.27.4] - 2023-02-08 ## Changed - EF test now only expects one isolated frame when executing # [0.27.3] - 2023-02-07 ## Fixed - Refactored to remove deprecated import # [0.27.2] - 2023-01-30 ## Changed - Added link at the top of the changelog for docs # [0.27.1] - 2023-01-12 ## Added - Error pattern to allow filtering of expected errors # [0.27.0] - 2023-01-11 ## Added - Test for illegal double addition of the same dynamic attribute # [0.26.0] - 2023-01-11 ## Removed - Gather prototype is gone ## Changed - Bundle attributes are now all typed as eRelationship (no ePrim anymore) - Changed related to introduction of native vectorization in core # [0.25.0] - 2023-01-03 ## Added - `TestBundleAttributeInterpolation` to exercise attribute interpolation. # [0.24.3] - 2022-12-21 ## Changed ## [0.24.2] - 2022-12-09 ### Added - Filtering for known EF test failure ## [0.24.1] - 2022-11-30 ### Changed - Added special characters to the test node with all data types to handle those edge cases ## [0.24.0] - 2022-11-24 ### Changed - Modified tests to account for the removal of setting useSchemaPrims ## [0.23.1] - 2022-11-18 ### Added - Added EF generated tests to tests marked as unreliable ## [0.23.0] - 2022-11-17 ### Changed - Modified tests to account for the removal of settings updateToUSD, supportForceWriteback, useLegacySimulationPipeline, and enableUSDInPreRender ## [0.22.1] - 2022-11-16 ### Changed - Fixed test_three_deformers_dirty_push - Disabled test_subgraph_creation for EF - Re-enabled test_compute_counts ## [0.22.0] - 2022-11-14 ### Added - Additional test to exercise simple dynamic attribute values ## [0.21.0] - 2022-11-12 ### Changed - Modified tests to account for the removal of implicit global graph support ## [0.20.0] - 2022-11-10 ### Added - Test node and script for verifying location of dynamic attribute memory ## [0.19.6] - 2022-11-10 ### Added - Compound tests with mixed evaluator types ## [0.19.5] - 2022-11-08 ### Added - Test to validate instances can be duplicated ## [0.19.4] - 2022-10-27 ### Modified - Poor `test_simple_rename`, it gets disabled again! ## [0.19.3] - 2022-10-26 ### Modified - Re-enabled unreliable tests: `test_import_time_samples`, `test_reparent_graph`, `test_reparent_primnode`, `test_simple_rename` ## [0.19.2] - 2022-10-18 ## Modified - Flag test_change_pipeline_stage as unreliable. ## [0.19.1] - 2022-10-14 ### Modified - Filtered test to as well include auto generated test for EF. ## [0.19.0] - 2022-09-28 ### Modified - Tests to support multiple primitives output from `Read Prim` and `Read Prim into Bundle` ## [0.18.1] - 2022-09-28 ### Fixed - Lint errors that crept in ## [0.18.0] - 2022-09-27 ### Added - Tests for OG Usd Listener ## [0.17.0] - 2022-09-14 ### Added - Test for argument flattening utility ### Fixed - Obsolete branding - Obsolete test configurations ## [0.16.0] - 2022-09-13 ### Added - Tests for execution framework - New test nodes: TestConcurrency and TestExecutionTask ## [0.15.0] - 2022-09-06 ### Removed - Tests and dependencies related to UI and RTX ### Changed - Test node type that used the omni.graph.ui extension to one that does not ## [0.14.0] - 2022-08-30 ### Added - Test for reading nodes with all data types, and sample test files with such nodes ### Fixed - Linting errors ## [0.13.9] - 2022-08-17 ### Changed - Restored the fixed failing test to the test suite ## [0.13.8] - 2022-08-16 ### Removed - References to obsolete ABI methods ## [0.13.7] - 2022-08-09 ### Fixed - Applied formatting to all of the Python files ## [0.13.6] - 2022-08-03 ### Fixed - Compilation errors related to deprecation of methods in ogn bundle. ## [0.13.5] - 2022-07-27 ### Fixed - All of the lint errors reported on the Python files in this extension ## [0.13.4] - 2022-07-21 ### Changed - Undo revert ## [0.13.3] - 2022-07-18 ### Changed - Reverted the changes in 0.13.2 ## [0.13.2] - 2022-07-15 ### Changed - Removed LatentTest node, modified tests ## [0.13.1] - 2022-07-11 ### Fixed - OgnComputeErrorPy node was importing the _internal class directly, which some of our linux build systems do not like. ## [0.13.0] - 2022-07-08 ### Added - Test of attribute deprecation API. ## [0.12.0] - 2022-07-07 ### Changed - Refactored imports from omni.graph.tools to get the new locations ### Added - Test for public API consistency ## [0.11.0] - 2022-06-28 ### Added - Test to verify that CHANGELOG and extension.toml versions match ## [0.10.0] - 2022-06-17 ### Added - Tests for changing graph settings from USD ## [0.9.0] - 2022-06-13 ### Added - Tests for evaluation mode setting ### Changed - Evaluation mode added to settings tests ## [0.8.0] - 2022-06-13 ### Added - New test to verify that C++ and Python node duplication propagate attribute values ## [0.7.0] - 2022-06-08 ### Added - Added gpuinterop vertex deformation test ## [0.6.0] - 2022-06-07 ### Added - Test for CPU-GPU pointer access in the controller interface ## [0.5.1] - 2022-06-06 ### Fixed - Fixed extension dependencies and restored flaky test ## [0.5.0] - 2022-05-27 ### Added - Test for attribute deprecation API. # [0.4.1] - 2022-05-26 ## Changed - Re-enabled test_graphs_in_sublayer_load, test_variable_commands and test_variables_create_remove_stress_test # [0.4.0] - 2022-04-29 ## Removed - Removed obsolete tests and test files ## Changed - Made tests derive from OmniGraphTestCase and use the new og.Settings # [0.3.0] - 2022-04-25 ## Changed - Stopped generating the pointless USD and docs for the test nodes ## Fixed - Fixed reference to extension.toml in the docs to point to the correct line and use an explicit language # [0.2.4] - 2022-04-20 ## Added - Test for undoing prim deletions. # [0.2.3] - 2022-04-11 ## Added - Test for connection callbacks ## Changed - Consolidated various callback tests into test_callbacks.py # [0.2.2] - 2022-03-16 ## Changed - Previously disabled tests have been re-enabled with new `enabledLegacyPrimConnections` setting. # [0.2.1] - 2022-03-08 ## Changed - Modified registration test to match the new style used as of `omni.graph.core 2.23.3` # [0.2.0] - 2022-03-01 ## Changed - Moved `expected_errors.py` to omni.graph so that it can be more generally accessible # [0.1.0] - 2021-03-01 ## Changed - Renamed from omni.graph.tests to avoid conflict with automatic test detection
changelog-omni-graph-tools_CHANGELOG.md	# Changelog All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ## [Unreleased] ## [1.77.0] - 2024-02-14 ### Added - Code generate helper methods for pre and post render graph nodes, as part of the node database. ## [1.76.1] - 2024-02-05 ### Changed - Small fix for unit test. ## [1.76.0] - 2024-01-26 ### Added - More detailed database tests for better code coverage of generated code ## [1.75.0] - 2024-01-25 ### Added - Function to nicely format attribute and node type names for the user - Pedantic mode for the node generator so that smaller details needing attention can emit warnings ### Changed - Modified docs generator to use the nice formatting when an explicit override does not exist - Updated the OGN best practices documentation with more information on execution attributes ## [1.74.0] - 2024-01-19 ### Added - Documentation for best practices in naming and documentation in .ogn files. ### Changed - Modified repo tools to share common code and look in the DriveSim relative locations - Changed nodes.json generator to call the script directly in the build rather than going through repo tools ## [1.73.0] - 2024-01-15 ### Changed - Moved nodes.json generation to a post build command # [1.72.0] - 2024-01-12 ## Changed - Ogn scanner now prioritizes package files even with a version mismatch occurs # [1.71.0] - 2024-01-12 ## Added - extras keyword for specifying the addition of generators not normally running - Implementation of Python database generation for cpp nodes when it is added as an extra # [1.70.0] - 2024-01-09 ## Added - Extra code coverage. # [1.69.2] - 2024-01-02 ## Fixed - Removed an API test that changes state based on whether tests are running or not # [1.69.1] - 2023-12-28 ## Changed - Avoid generation of unnecessary test code # [1.69.0] - 2023-12-27 ## Changed - Changed test generation to use separate graphs instead of fresh scenes - Threading tests now run multiple test cases at once # [1.68.0] - 2023-12-19 ## Added - OGN_GENERATED_TEST_LIMIT can be used to limit the number of test cases that are run # [1.68.0] - 2023-12-20 ## Added - Code coverage tests for attribute generation and some utilities # [1.67.1] - 2023-12-20 ## Added - Extra code coverage. ## Removed - Miscellaneous dead and/or redundant code-paths. # [1.67.0] - 2023-12-19 ## Added - Testing for main_docs and generate_type_name_conversions tools ## Changed - Configuration of the tools to allow for easier testing ## Removed - Obsolete tool to add node type information to the .toml file - that approach will not be used # [1.66.0] - 2023-12-15 ## Removed - The unused generated Python databases on C++ nodes # [1.65.0] - 2023-12-08 ## Changed - Invalid extended types cause ogn parsing to fail # [1.64.0] - 2023-12-05 ## Changed - Ensured the icon path written as metadata is relative # [1.63.0] - 2023-12-01 ## Changed - Ensured the icon path written as metadata is relative ## [1.62.1] - 2023-11-27 ### Added - Handle OSError that may be raised when the test module `init.py` file cannot be locked for writing. ## [1.62.0] - 2023-11-23 ### Fixed - `init_instance` and `release_instance` were not passing the instanceID to the user callback ## [1.61.1] - 2023-11-17 ### Fixed - Fixed exception when the number of node definitions to be imported as background tasks is less than the thread count. ## [1.61.0] - 2023-11-17 ### Changed - Deprecated the generated `db.internalState` and `DB::sInternalState` functions, in favor of the `sharedState` and `perInstanceState` version - Stack created OGN databases now have access to (auto)instances ### Added - Generates the code in the python OGN database that can invoke `init_instance` and `release_instance` if implemented by the node writer ## [1.60.0] - 2023-11-09 ### Added - Coverage filtering for generated node types marked as `internal:test` ## [1.59.0] - 2023-11-09 ### Changed - Made documentation references consistent through use of substitutions ## [1.58.3] - 2023-11-06 ### Fixed - Import the tests synchronously when running the extension tests. ## [1.58.2] - 2023-11-02 ### Fixed - Leaking file handles from configuration files ## [1.58.1] - 2023-10-27 ### Fixed - Numpy type definitions in the conversions data ## [1.58.0] - 2023-10-22 ### Changed - Rearrangement of docs for AutoNode ### Added - Tool for dumping the set of all available types to a `.rst` file ## [1.57.1] - 2023-10-18 ### Changed - Removed redundant variables generated in the database files, which cause compilation warnings. ## [1.57.0] - 2023-10-18 ### Added - OGN generator now instrument the database to take into account mapped attribute ## [1.56.1] - 2023-10-17 ### Fixed - Premake file filters were not handling update tag and type name conversion file correctly ## [1.56.0] - 2023-10-13 ## [1.55.0] - 2023-10-11 ### Changed - Renamed put_func to register_function to more accurately reflect what it is doing ### Added - Methods for deregistering functions ### Removed - Incorrectly identified SDF types for attribute types without an equivalent ### Fixed - Incorrect references to node types when it meant node type names ## [1.54.1] - 2023-10-06 ### Added - Dependency on omni.kit.test. Needed because we import nodes’ test modules even when not running tests and they import omni.kit.test. ## [1.54.0] - 2023-10-06 ### Changed - Moved ogn_types.py to an AutoNode specific location ### Added - Repo tools command and support for creating file mapping all supported type representations - Module for providing the above mapping data ### Removed - Obsolete data_types.py file ## [1.53.0] - 2023-09-29 ### Changed - Reorganized AutoNode documentation to reflect separation of runtime and developer mode - Hid some deprecated code ## [1.52.0] - 2023-09-28 ### Changed - Access the IAttribute interface from an object instead of from Carbonite where it could fail ## [1.51.0] - 2023-09-21 ### Added - Explicit module for type annotations in the .toml file ### Changed - Generated compute functions, to simplify the parameters they accept ## [1.50.0] - 2023-09-18 ### Added - Access for the cudaPointers keyword - Added code generation to get cudaPointer value into the metadata ## [1.49.0] - 2023-09-13 ### Changed - Location processing for AutoNode toml definitions - Documentation for AutoNode to add information about the setting - Import location for data type definitions - AutoNode generator tool argument list - compute generation for AutoNode definitions ### Added - Implementation of AutoNode generator calls as part of build ### Fixed - Syntax of test generated .toml files ## [1.48.0] - 2023-09-08 ### Added - Functionality and test to generate the nodes.json node type definition metadata file programmatically ## [1.47.0] - 2023-08-31 ### Added - Tests for all types with the generator ### Changed - Modified the generator to recognize all legal OGN type definitions ### Removed - Support for plain Python types, temporarily ## [1.46.2] - 2023-08-02 ### Changed - Fixed config for generating matrix2d types. - Adding matrix2d to matrices union configuration. ## [1.46.1] - 2023-08-02 ### Changed - Fix for a small test generation error when reading test file paths. ## [1.46.0] - 2023-07-31 ### Removed - Obsolete autograph support ## [1.45.2] - 2023-07-30 ### Removed - Long deprecated function that has no body ## [1.45.1] - 2023-07-28 ### Removed - Unnecessary Linux file copy for doc index building ## [1.45.0] - 2023-07-26 ### Added - Ability to utilize external test scenes in .ogn “tests” constructs. ## [1.44.0] - 2023-07-25 ### Changed - Revert output and state bundle name space separator to underscore ## [1.43.0] - 2023-07-13 ### Removed - Obsolete documentation special case for tutorial nodes ## [1.42.1] - 2023-07-14 ### Added - Error handling for when a generated test file is unreadable ## [1.42.0] - 2023-07-11 ### Changed - Moved the post build command project to a common area so that it can be shared by downstream repos ## [1.41.1] - 2023-06-28 ### Changed - Small edit to parsing logic for the “pure” scheduling hint. ## [1.41.0] - 2023-06-27 ### Changed - Modified toc specification to point to an extension-local directory - Changed the ogn file dependencies to not include the table of contents generator files - Modified generation and parsing of per-extension index files to link to local files instead of the node library - Modified format of generated node documentation files to correspond to what is found in the node library ### Added - Extension root parameter to the node documentation index generator - veryVerbose flag to the node documentation index generator for extra output - Deprecation support for constant objects - Ability to specify pre and post documentation files for any node - Support for CSV table output in restructuredText and readable directory list for argparse arguments ## [1.40.1] - 2023-06-27 ### Changed - OGN node and test generation is multi threaded - OGN nodes and test modules can be imported in parallel on multiple threads - Python tests are imported on a separate thread ## [1.40.0] - 2023-06-22 ### Added - Parsing logic for new “pure” scheduling hint. ## [1.39.0] - 2023-05-31 ### Fixed - Adjusted the CRLF settings for the generated .md node table of content files ## [1.38.0] - 2023-05-29 ### Fixed - Regeneration of table of contents with new data - Algorithm looking for location of the config dir in downstream repos ## [1.37.0] - 2023-05-26 ### Added - Keyword CREATE_ATTRIBUTES for controller.edit() function ## [1.36.2] - 2023-05-23 ### Changed - Small comment change. ## [1.36.1] - 2023-05-11 ### Added - Warning to generated code for input bundle that is invalid but is required for computation ## [1.36.0] - 2023-05-09 ### Fixed - Refactored deprecation decorators to work in more cases ### Added - Beefed up the deprecation tests ## [1.35.1] - 2023-05-08 ### Fixed - Bug with Python code generator for BundleContents ## [1.35.0] - 2023-05-08 ### Deprecated - Removed deprecated locations of Python modules ## [1.34.0] - 2023-05-02 ### Added - Parsing support for the addition of node type forwarding for a node type in the .ogn file ## [1.33.0] - 2023-05-02 ### Changed - Changed the dynamic attribute accessors getDynamicInputs(), getDynamicOutputs(), getDynamicStates() to return gsl::span. ## [1.32.0] - 2023-04-19 ### Deprecated - Removed all references to ContextHelper and OmniGraphHelper - Old .ogn test specification format no longer supported ## [1.31.0] - 2023-04-11 ### Added - Generation of the table of contents documentation for nodes ### Changed ### Removed - Obsolete unitTest flag from the node generator command - Unnecessary import in generated Python tests ## [1.30.0] - 2023-04-07 ### Added - Generate code for OmniGraphDatabase to cache dynamic input, output and state attributes. ## [1.29.0] - 2023-04-06 ### Added - Ability to use allowedTokens as a top level definition for attributes - Ability to reference an allowedToken by name or value as a default in the .ogn - Tests for the new functionality ### Fixed - Stored tokens internally with reference counts to avoid sporadic illegal data accesses ## [1.28.0] - 2023-03-31 ### Changed - target attributes now use relationships with output and state ports ## [1.27.3] - 2023-03-28 ### Changed - Filtered out cpp nodes from using batched reads and writes ## [1.27.2] - 2023-03-24 ### Changed - target python wrapping changed from string to usdrt Sdf.Path ## [1.27.1] - 2023-03-22 ### Fixed - Made all docstrings to publicly visible documentation consistent ## [1.27.0] - 2023-03-21 ### Fixed - Use top level Python module’s name instead of ext_id as module name when generating cached node code ## [1.26.0] - 2023-03-17 ### Added - Implementing target attribute type ## [1.25.0] - 2023-03-17 ### Added - Generate an update file indicating that the tools scripts are up to date - Build support for respect of the update file when deciding whether to regenerate from .ogn files - Updated category_definitions to use Python 3.10 type syntax, mostly as a test for incremental rebuilds ## [1.24.0] - 2023-03-14 ### Changed - Default of cudaPointers on Python nodes is now CPU instead of CUDA as it was before, mainly for Warp ## [1.23.0] - 2023-03-09 ### Added - Change default index for static version of internal state to return the authoring graph - Added wrappers for shared and per-instance versions of internal state functions # [1.22.11] - 2023-02-28 ## Fixed - Rebuild python Database if input bundles are invalid # [1.22.10] - 2023-02-27 ## Added - Generation of OGN tests on vectorized data # [1.22.9] - 2023-02-25 ## Changed - Modifed format of Overview to be consistent with the rest of Kit # [1.22.8] - 2023-02-22 ## Added - Removed debugging print # [1.22.7] - 2023-02-21 ## Added - ThreadsafetyTestUtils to public API. # [1.22.6] - 2023-02-19 ## Changed - Added label to the main doc page so that higher level docs can reference the extension # [1.22.5] - 2023-02-14 ## Fixed - Made test file pattern account for node files not beginning with Ogn # [1.22.4] - 2023-02-08 ## Changed - Modified lookup of target extension version to account for the modified path names # [1.22.3] - 2023-02-07 ## Fixed - Removed an unused import # [1.22.2] - 2023-02-02 ## Fixed - Lint error that appeared when pylint updated # [1.22.1] - 2023-01-30 ## Changed - Removed the kit-sdk landing page - Moved all of the documentation into the new omni.graph.docs extension # [1.22.0] - 2023-01-16 ## Changed - Split functions and added configuration information to make the ogn project builds more flexible # [1.21.1] - 2023-01-11 ## Changed - Sort the generated Python import statements to ensure a consistent ordering # [1.21.0] - 2023-01-11 ## Changed - OGN generator for vectorization # [1.20.1] - 2022-12-14 ## Fixed - Made build level access of config directory account for being inside the SDK as well as in the build # [1.20.0] - 2022-12-13 ### Changed - Attribute Union Definitions are now loaded from a json configuration file(AttributeUnionConfiguration.json) ### [1.19.0] - 2022-12-02 #### Changed - Modified Python node type code generation process to handle multiple versions on-demand ### [1.18.1] - 2022-11-30 #### Fixed - Output formatting for string and token defaults containing special characters ### [1.18.0] - 2022-10-21 #### Added - Internal utilities for support of testing node type registration ### [1.17.0] - 2022-09-30 #### Fixed - Changed code emission to avoid defining interface that will not be used ### [1.16.3] - 2022-09-14 #### Added - Better documentation for categories #### Removed - Testing for obsolete transform data type ### [1.16.2] - 2022-08-30 #### Fixed - Linting errors ### [1.16.1] - 2022-08-24 #### Fixed - AttributeManager has_* generated methods for optional extended attributes. ### [1.16.0] - 2022-08-19 #### Added - Support for new setting that turns deprecations into errors - Tests for deprecation code - Access to deprecation message logs to use for testing ### [1.15.3] - 2022-08-16 #### Changed - Refactored checking for legal extension name as Python import ### [1.15.2] - 2022-08-09 #### Fixed - Applied formatting to all of the Python files ### [1.15.1] - 2022-08-05 #### Fixed - All of the lint errors reported on the Python files in this extension ### [1.15.0] - 2022-08-01 #### Change - Changed `m_primHandle` to `m_bundleHandle` in `BundleAttributeManager` ### [1.14.1] - 2022-07-25 #### Added - Added ALLOW_MULTI_INPUTS metadata key ### [1.14.0] - 2022-07-13 ## [1.13.0] - 2022-07-08 ### Added - Support for ‘deprecation’ attribute keyword in .ogn files. ## [1.12.0] - 2022-07-07 ### Changed - Refactored import of non-public API to emit a deprecation warning - Moved node_generator/ into the _impl section ### Added - Support for fully defined Python API at the omni.graph.tools level - Support for fully defined Python API at the omni.graph.tools.ogn level - Support for public API consistency test ## [1.11.0] - 2022-06-28 ### Changed - Merged to USD and import generated tests and added enhanced generated code coverage ## [1.10.0] - 2022-06-23 ### Removed - Support for the deprecated Autograph functionality, now in omni.graph.core.autonode ## [1.9.1] - 2022-06-17 ### Fixed - Corrected bad API documentation formatting ### Added - Documentation links for Python API ## [1.9.0] - 2022-06-13 ### Added - Check to see if values are already set before initializing defaults in Python nodes ## [1.8.1] - 2022-06-08 ### Fixed - Add stdint include when constructing node database files. ## [1.8.0] - 2022-06-07 ### Added - Support for generator settings to alter the generated code - Generator setting for Python output optimization - Build flag to modify generator settings - Generator script support for generator settings being passed around ## [1.7.0] - 2022-05-27 ### Added - Ability for the controller to take an attribute description as the first parameter instead of only attributes ## [1.6.2] - 2022-05-17 ### Fixed - Improved node description formatting by using newlines to indicate paragraph breaks ## [1.6.1] - 2022-05-11 ### Added - Category for UI nodes ## [1.6.0] - 2022-05-10 ### Added - Ability to use @deprecated_function with property getters and setters. ## [1.5.4] - 2022-05-06 ## Fixed - Fixed the emission of the CPU to GPU pointer information for output bundles ## [1.5.3] - 2022-04-29 ### Fixed - Fixed incorrect line highlighting in user guide ## [1.5.2] - 2022-04-25 ### Fixed - Stopped generating bundle handle extraction in situations where the handle will not be used ## [1.5.1] - 2022-04-05 ### Fixed - Removed regeneration warning until such time as the regeneration actually happens ## [1.5.0] - 2022-03-24 ### Fixed - Fixed generated contents of tests/init.py to be constant - Refactored generation to use standard import pattern - Ability to create generated directories on the fly rather than insisting they already exist ### Added ## [1.4.0] - 2022-03-14 ### Added - ensure_nodes_in_toml.py to add the [[omnigraph]] section to the extension.toml file ## [1.3.2] - 2022-03-14 ### Added - examples category ## [1.3.1] - 2022-03-09 ### Added - Added literalOnly to the list of metadata keys - Added some explanation for the literalOnly metadata key to the OGN reference guide ## [1.3.0] - 2022-03-08 ### Changed - Changed the naming of the generated tests to be shorter for easier use in TestRunner - Changed the generated USD to use the schema prims - Changed the generated test scripts to use the schema prims - Removed unused USD metadata from generated code ## [1.2.4] - 2022-03-08 ### Changed - Modified C++ generated code node registration to match omni.graph.core 2.23.3 ## [1.2.3] - 2022-02-15 ### Added - script node category ## [1.2.1] - 2022-02-10 ### Added - Unset the useSchemaPrims setting for tests until they are working ## [1.2.0] - 2022-02-09 ### Changed - Moved autograph to omni.graph.core, retained imports for backward compatibility ## [1.1.1] - 2021-08-30 ### Breaking Changes # Type names have changed. ``` ``` Float32 ``` is now ``` Float ``` and ``` Int32 ``` is now ``` Int ``` . ## Improvements and Bugfixes - BUGFIX Fixed type initializers in autograph - PERF IMPROVEMENT Functions using Autofunc now use code generated at read time instead of runtime lookups. - UI IMPROVEMENT Nodes no longer have extra connections with the node name. ## [1.1.0] - 2021-08-19 ### Adds Autograph Added Autograph tools and types ## [1.0.0] - 2021-03-01 ### Initial Version Started changelog with initial released version of the OmniGraph core
changelog-omni-graph-tutorials_CHANGELOG.md	# Changelog This document records all notable changes to the omni.graph.tutorials extension. The format is based on [Keep a Changelog](https://keepachangelog.com). The project adheres to [Semantic Versioning](https://semver.org). ## [1.27.1] - 2024-04-17 ### Added - Add a ‘support_level’ entry to the configuration file of the extensions ## [1.27.0] - 2024-04-10 ### Changed - Bumped dependency on omni.graph to version 1.139.0 - Bumped dependency on omni.graph.core to version 2.177.1 - Bumped dependency on omni.graph.tools to version 1.77.0 ## [1.26.0] - 2024-03-18 ### Changed - Bumped dependency on omni.graph.core to version 2.176.3 - Bumped dependency on omni.graph to version 1.138.1 ## [1.25.0] - 2024-02-15 ### Changed - Bumped dependency on omni.graph.core to version 2.174.2 - Bumped dependency on omni.graph.tools to version 1.76.1 ## [1.24.0] - 2024-02-05 ### Changed - Bumped dependency on omni.graph to version 1.138.0 - Bumped dependency on omni.graph.core to version 2.174.0 - Bumped dependency on omni.graph.tools to version 1.76.0 ## [1.23.1] - 2024-02-03 ### Changed - Bumped minimum omni.graph.core extension version dependency to be compatible with changes to the INodeType interface and lazy graph executor. ## [1.23.0] - 2024-01-31 ### Changed - Bumped dependency on omni.graph to version 1.137.0 - Bumped dependency on omni.graph.core to version 2.171.1 - Bumped dependency on omni.graph.tools to version 1.76.0 ## [1.22.0] - 2024-01-30 ### Changed - Reenabled an old extension test that is now valid - Bumped dependency on omni.graph to version 1.136.1 - Bumped dependency on omni.graph.core to version 2.170.1 - Bumped dependency on omni.graph.tools to version 1.74.0 ## [1.21.0] - 2024-01-23 ### Changed - Bumped dependency on omni.graph to version 1.136.0 ## [1.20.1] - 2024-01-22 ### Fixed - Made execution attribute descriptions consistent and informative ## [1.20.0] - 2024-01-18 ### Changed - Bumped dependency on omni.graph.core to version 2.169.1 - Bumped dependency on omni.graph to version 1.135.1 - Bumped dependency on omni.graph.tools to version 1.73.0 ## [1.19.1] - 2024-01-13 ### Fixed - Repository URL in config file. ## [1.19.0] - 2024-01-12 ### Changed - Bumped dependency on omni.graph to version 1.134.7 - Bumped dependency on omni.graph.core to version 2.169.0 - Bumped dependency on omni.graph.tools to version 1.70.0 ## [1.18.1] - 2024-01-12 ### Changed - Fix build warnings ## [1.18.0] - 2023-12-28 ### Changed - Bumped dependency on omni.graph.tools to version 1.69.0 ## [1.17.0] - 2023-12-28 ### Removed - Obsolete test of python database that will not be generated ### Changed - Bumped dependency on omni.graph.core to version 2.167.0 - Bumped dependency on omni.graph to version 1.134.2 - Bumped dependency on omni.graph.tools to version 1.68.0 ## [1.16.0] - 2023-12-18 ### Fixed - Temporary workaround to prevent fatal error in the compiler on a CUDA file ### Changed - Bumped dependency on omni.graph.core to version 2.166.0 - Bumped dependency on omni.graph to version 1.134.0 - Bumped dependency on omni.graph.tools to version 1.65.0 ## [1.15.2] - 2023-12-18 ### Changed - Address security issues in tutorial nodes ## [1.15.1] - 2023-12-15 ### Changed - Minor changes to improve code safety ## [1.15.0] - 2023-12-12 ### Changed - Bumped dependency on omni.graph.core to version 2.166.0 - Bumped dependency on omni.graph to version 1.134.0 - Bumped dependency on omni.graph.tools to version 1.65.0 ## Changed - Bumped dependency on omni.graph.core to version 2.165.3 - Bumped dependency on omni.graph to version 1.133.2 - Bumped dependency on omni.graph.tools to version 1.65.0 ## [1.14.0] - 2023-12-11 ### Changed - Bumped dependency on omni.graph.core to version 2.165.3 - Bumped dependency on omni.graph to version 1.133.2 - Bumped dependency on omni.graph.tools to version 1.65.0 ## [1.13.0] - 2023-11-30 ### Removed - Obsolete tutorials on build and node type conversion - Obsolete redirects ## [1.12.3] - 2023-11-30 ### Changed - Set the minimal omni.graph.core version required in order to properly load that extension ## [1.12.2] - 2023-11-28 ### Changed - Changed deprecated internal state functions to their new version - Updated the C++ state tutorial to take advantage of the new per-instance init/release callbacks ## [1.12.1] - 2023-11-14 ### Changed - Removes a deprecated ABI test ## [1.12.0] - 2023-11-13 ### Changed - Vectorization tutorial, so the rarest code path is exercised ## [1.11.0] - 2023-11-10 ### Added - Low level testing support and tests for the ABI node ## [1.10.0] - 2023-11-08 ### Changed - Modified the C++ ‘internal state’ tutorial to illustrate shared and per-instance states ## [1.9.8] - 2023-08-21 ### Fixed - Tutorials throwing on a legitimate value ## [1.9.7] - 2023-08-14 ### Added - Updated tutorial2 with further discussion on the new external scene-loading functionality. ## [1.9.6] - 2023-08-09 ### Fixed - Linux build errors ## [1.9.5] - 2023-08-03 ### Changed - Targeted a specific version of the Kit SDK ## [1.9.4] - 2023-07-31 ### Changed - Standardized the format of the CHANGELOG ## [1.9.3] - 2023-07-26 ### Changed - Bump to force republication after build configuration change ## [1.9.2] - 2023-07-21 ### Changed - Bumping the version so that debug versions of extensions will publish ## [1.9.1] - 2023-07-20 ### Changed - Bumping the version so that debug versions of extensions will publish ## [1.9.0] - 2023-07-19 ### Added - Test for extension enabling, moved over from omni.graph in Kit ## [1.8.0] - 2023-07-19 ### Changed - Replaced the generated node links page with generated node docs - Moved the tutorial docs from omni.graph.docs into this extension ### Added - Temporary links to avoid circular dependencies with omni.graph.docs ## [1.7.2] - 2023-07-14 ### Changed - Moved files out of LFS for easier management ## [1.7.1] - 2023-06-26 ### Changed - Upgraded to C++17 support as required by the latest Kit ## [1.7.0] - 2023-06-12 ### Added - Missing preview images ## [1.6.1] - 2023-05-31 ### Changed - Adjusted some instructional wording ## [1.7.0] - 2023-05-26 ### Changed - Migrated the existing Kit version of the extension into the kit-omnigraphs repo ## [1.6.0] - 2023-05-02 ### Added - Added testing for token array ## [1.5.6] - 2023-04-11 ### Added - Table of documentation links for nodes in the extension ## [1.5.5] - 2023-02-28 ### Changed - Reenabled test_setting_in_ogn_python_api test ## [1.5.4] - 2023-02-25 ### Changed - Modifed format of Overview to be consistent with the rest of Kit ## [1.5.3] - 2023-02-19 ### Changed - Added label to the main doc page so that higher level docs can reference the extension ## [1.5.2] - 2023-02-17 ### Added - “threadsafe” scheduling hints to OgnTutorialEmpty, OgnTutorialDefaults, OgnTutorialState # [1.5.1] - 2023-01-30 ## Changed - Removed the kit-sdk landing page - Moved all of the documentation into the new omni.graph.docs extension # [1.5.0] - 2023-01-11 ## Changed - Changes related to introduction of native vectorization in core # [1.4.1] - 2022-12-21 ## Changed - Refactored CUDA build to consolidate build functions and remove unnecessary rebuilds # [1.4.0] - 2022-12-13 ## Changed - Refactored build and extension handling to allow safe unload/reload # [1.3.3] - 2022-10-14 ## Modified - Filtered test to as well include auto generated test for EF. # [1.3.2] - 2022-08-30 ## Fixed - Doc error referencing a Python node in a C++ node docs # [1.3.1] - 2022-08-09 ## Fixed - Applied formatting to all of the Python files # [1.3.0] - 2022-07-07 ## Changed - Refactored imports from omni.graph.tools to get the new locations ## Added - Test for public API consistency # [1.2.0] - 2022-05-06 ## Changed - Updated the CPU to GPU test to show the actual pointer contents # [1.1.3] - 2022-04-29 ## Changed - Made tests derive from OmniGraphTestCase # [1.1.2] - 2022-03-07 ## Changed - Substituted old tutorial 1 node icons with new version # [1.1.1] - 2022-03-01 ## Fixed - Made bundle tests use the Controller # [1.0.0] - 2021-03-01 ## Initial Version - Started changelog with initial released version of the OmniGraph core
changelog-omni-graph-ui-nodes_CHANGELOG.md	# Changelog This document records all notable changes to the omni.graph.ui_nodes extension. The format is based on [Keep a Changelog](https://keepachangelog.com). The project adheres to [Semantic Versioning](https://semver.org). ## [1.24.1] - 2024-04-17 ### Added - Add a ‘support_level’ entry to the configuration file of the extensions ## [1.24.0] - 2024-04-12 ### Deprecated - DrawDebugCurve node. ### Changed - omni.debugdraw dependency made optional. ## [1.23.1] - 2024-04-08 ### Changed - Replaced omni.ui_query calls with equivalent code in UINodeCommon.py ### Removed - Dependency on omni.ui_query. ## [1.23.0] - 2024-03-20 ### Fixed - Added missing required extension dependency for testing ### Changed - Bumped dependency on omni.graph to version 1.134.1 - Bumped dependency on omni.graph.core to version 2.168.1 ## [1.22.1] - 2024-02-28 ### Changed - Fix for test_draw_debug_curve_closed ## [1.22.0] - 2024-02-16 ### Changed - Updated version number to work after the Kit branch was renamed from 105.2 to 106. - 106 branch version was updated before the previous return took effect so another bump was needed ## [1.21.0] - 2024-02-09 ### Changed ## [1.14.1] - 2024-02-07 ### Changed - Fix for CameraTarget nodes ## [1.14.0] - 2024-02-05 ### Changed - Bumped dependency on omni.graph to version 1.134.0 - Bumped dependency on omni.graph.core to version 2.167.1 - Bumped dependency on omni.graph.tools to version 1.76.0 ## [1.12.2] - 2024-01-23 ### Fixed - Made execution attribute descriptions consistent and informative ## [1.12.1] - 2024-01-13 ### Fixed - Repository URL in config file. ## [1.12.0] - 2024-01-12 ### Changed - Bumped dependency on omni.graph to version 1.133.4 - Bumped dependency on omni.graph.core to version 2.165.3 - Bumped dependency on omni.graph.tools to version 1.69.0 ## [1.13.1] - 2024-01-30 ### Fixed - Incremented version to compensate for a pipeline failure last week. ## [1.11.1] - 2024-01-06 ### Added - More tests of Python code. ## [1.11.0] - 2023-01-05 ### Changed - Set the Button, Slider, OnWidgetClicked and OnWidgetValueChanged to be hidden in the UI. ### Removed - ComboBox, Placer, ReadWidgetProperty, ReadWindowSize, Spacer, VStack (aka Stack), WriteWidgetProperty and WriteWidgetStyle nodes. ## [1.10.1] - 2023-12-14 ### Changed - disable test_on_picked when FSD is enabled ## [1.10.0] - 2023-12-12 ### Changed - Bumped dependency on omni.graph.core to version 2.165.3 - Bumped dependency on omni.graph to version 1.133.2 - Bumped dependency on omni.graph.tools to version 1.65.0 ## [1.9.0] - 2023-12-11 ### Changed - Bumped dependency on omni.graph.core to version 2.165.3 - Bumped dependency on omni.graph to version 1.133.2 - Bumped dependency on omni.graph.tools to version 1.65.0 ## [1.8.0] - 2023-12-07 ### Changed - OM-77263 OM-105672 Use rtx viewport as picking doesn’t work with pxr one and re-enable viewport tests ## [1.7.2] - 2023-11-30 ### Changed - Set the minimal omni.graph.core version required in order to properly load that extension ## [1.7.1] - 2023-11-28 ### Changed - Changed deprecated internal state functions to their new version ## [1.7.0] - 2023-10-26 ### Changed - Moved tests to omni.graph.ui ## [1.6.7] - 2023-10-19 ### Changed - Added tests for token array widget ## [1.6.6] - 2023-10-17 ### Changed - Added tests for node widgets ## [1.6.5] - 2023-10-04 ### Changed - Fix test images ## [1.6.4] - 2023-09-12 ### Changed - Updating tests for new target nodes ## [1.6.3] - 2023-09-08 ### Changed - Updated tests ## [1.6.2] - 2023-08-18 ### Changed - fix spelling ## [1.6.1] - 2023-08-16 ### Changed - Re-enable ui_nodes tests ## [1.6.0] - 2023-08-14 ### Changed - Ported over tests from Kit that make extensions require unnecessary dependencies on omni.graph.nodes ## [1.5.15] - 2023-08-11 ### Changed - Fixes some tests and skips others, to be able to focus on drag and drop crash ## [1.5.14] - 2023-08-11 ### Fixed - Fixed some ui_nodes tests so they can run again - Set some of the broken tests to skip for now ## [1.5.13] - 2023-08-11 ### Fixed - Version bump to force extension publication to fix Linux platform errors ## [1.5.12] - 2023-08-09 ### Fixed - Linux build errors ## [1.5.11] - 2023-08-04 ### Changed - Bumped up the test timeout to prevent Linux flaky failures ## [1.5.10] - 2023-08-03 ### Changed - Targeted a specific version of the Kit SDK ## [1.5.9] - 2023-07-31 ### Changed - Standardized the format of the CHANGELOG ## [1.5.8] - 2023-07-27 ### Added - UI Nodes test migrated from Kit ## [1.5.7] - 2023-07-26 ### Changed - Migrated the extension from Kit ## [1.5.6] - 2023-07-13 ### Removed - Unnecessary dependency on omni.graph.test ## [1.5.5] - 2023-06-27 ### Fixed - Refactored OmniGraph documentation to point to locally generated files ### Added - Example pre and post documentation additions ## [1.5.4] - 2023-06-27 ### Changed - OgnSetViewportMode imports OgnVStack by absolute path - Set up the extension to load python tests in parallel ## [1.5.3] - 2023-06-12 ### Changed - Hide the ComboBox and Slider nodes in the node catalog. - Give a warning if ComboBox or Slider are used. ## [1.5.2] - 2023-06-02 ### Changed - Added ‘passClicksThru’ input to SetViewportMode node. ## [1.5.1] - 2023-05-31 ### Fixed - Adjusted the CRLF settings for the generated .md node table of content files ## [1.5.0] - 2023-05-29 ### Added - Regenerated node table of contents ## [1.4.0] - 2023-05-15 ### Added - Added `OgnLockViewportRender` for locking and unlocking viewport render ### Fixed - Enabled output execution attributes of `OgnSetViewportFullscreen`, `OgnSetViewportRenderer`, and `OgnSetViewportResolution` when triggered ## [1.3.3] - 2023-04-21 ### Changed - Updated OnPicked and ReadPickState nodes to properly use targets - Moved templates so they would properly work ## [1.3.2] - 2023-04-12 ### Fixed - Fixed issue with nodes not properly using targets # Re-enabled tests ## [1.3.1] - 2023-04-11 ### Added - Table of documentation links for nodes in the extension ## [1.3.0] - 2023-03-29 ### Added - Updated tests for target output type change to relationship ## [1.2.0] - 2023-03-29 ### Added - Property panel support for allowMultiInput tags on target types ## [1.1.0] - 2023-03-28 ### Added - Target ports added to GetActiveViewportCamera and OnPicked nodes ## [1.0.2] - 2023-03-27 ### Fixed - Error in ReadViewportDragState, ReadViewportHoverState ## [1.0.1] - 2023-03-12 ### Fixed - bug in ReadViewportPressState ## [1.0.0] - 2023-03-06 ### Initial Version - Moved nodes out of omni.graph.ui
changelog-omni-graph-ui_CHANGELOG.md	# Changelog All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ## [1.67.1] - 2024-04-17 ### Added - Add a ‘support_level’ entry to the configuration file of the extensions ## [1.67.0] - 2024-04-12 ### Removed - Some unused dependencies. ## [1.66.1] - 2024-04-08 ### Changed - Removed dependency on stage_templates. ## [1.66.0] - 2024-03-20 ### Fixed - Updated omni.kit.context_menu to omni.kit.widget.context_menu ### Changed - Bumped dependency on omni.graph to version 1.134.1 - Bumped dependency on omni.graph.core to version 2.168.1 ## [1.65.0] - 2024-02-16 ### Changed - Updated version number to work after the Kit branch was renamed from 105.2 to 106. - 106 branch version was updated before the previous return took effect so another bump was needed ## [1.63.0] - 2024-02-09 ### Changed - Updated version number to work after the Kit branch was renamed from 105.2 to 106. ## [1.60.0] - 2024-02-05 ### Changed - Bumped dependency on omni.graph to version 1.134.0 - Bumped dependency on omni.graph.core to version 2.167.1 ## [1.59.1] - 2024-01-30 ### Fixed - Incremented version to compensate for a pipeline failure last week. ## [1.58.1] - 2024-01-25 ### Added - Test images for graph.io nodes ## [1.58.0] - 2024-01-15 ### Fixed - Made the OmniGraph extension pane work for new and old variations of nodes.json ## [1.57.2] - 2024-01-13 ### Fixed - Repository URL in config file. ## [1.57.1] - 2024-01-13 ### Changed - Fix build warnings ## [1.57.0] - 2024-01-12 ### Changed - Bumped dependency on omni.graph to version 1.133.4 - Bumped dependency on omni.graph.core to version 2.165.3 ## [1.56.2] - 2024-01-11 ### Changed - Fix for test_target_attribute_browse, test_target_attribute ## [1.56.1] - 2024-01-10 ### Changed - Fix for test_extended_attributes ## [1.56.0] - 2024-01-09 ### Added - Tests for omnigraph_attribute_models ### Fixed - Bug related to Quat* widgets - Setting attr values through the Property Window sometimes don’t fire attribute changed callbacks. ## [1.55.2] - 2023-12-29 ### Changed - Remove node description editor from py coverage ## [1.55.1] - 2023-12-14 ### Changed - Fix spelling error in documentation ## [1.55.0] - 2023-12-12 ### Fixed - Typo of representation ### Changed - Bumped dependency on omni.graph.core to version 2.165.3 - Bumped dependency on omni.graph to version 1.133.2 ## [1.54.0] - 2023-12-11 ### Changed - Bumped dependency on omni.graph.core to version 2.165.3 - Bumped dependency on omni.graph to version 1.133.2 ## [1.53.1] - 2023-12-08 ### Fixed - lint error caused by auto-formatter. ## [1.53.0] - 2023-12-08 ### Added ## Fixed - Exception if Fabric Debug button clicked when omni.fabric.fabric_inspector extension not enabled. ## [1.52.3] - 2023-12-08 ### Changed - Updated golden images for Minimum and Maximum nodes. ## [1.52.2] - 2023-11-15 ### Changed - Adjust ConstructArray property panel for union attributes ## [1.52.1] - 2023-11-15 ### Added - Updated golden images for AppendArray. ## [1.52.0] - 2023-10-31 ### Changed - Update golden images for new nodes. ## [1.51.0] - 2023-10-26 ### Changed - Moved tests from omni.graph.ui_nodes ## [1.50.3] - 2023-10-25 ### Changed - Add support for older compound schemas ## [1.50.2] - 2023-10-19 ### Changed - Token array editing will properly work with extended attributes and allowed tokens ## [1.50.1] - 2023-10-19 ### Changed - Fix target mapping with the relationship builder ## [1.50.0] - 2023-10-18 ### Added - Display target mapped items in the property panel ## [1.49.3] - 2023-10-18 ### Changed - Fixup compound node type schema property handler to use latest schema ## [1.49.2] - 2023-10-17 ### Changed - Added property UI for Quatd\|f\|h and Matrix4d ## [1.49.1] - 2023-10-11 ### Changed - Don’t require omni.kit.window.extensions. Only enable the bits which use it if it’s already loaded. ## [1.49.0] - 2023-10-09 ### Changed - Adding UI template for conversion nodes that allow role specification ## [1.48.0] - 2023-10-06 ### Changed - re-enable tests ## [1.47.0] - 2023-10-05 ### Added ## [1.46.11] - 2023-09-19 ### Changed - fix context menu misalignment issue ## [1.46.10] - 2023-09-07 ### Changed - update all instances when a variable is renamed ## [1.46.9] - 2023-09-06 ### Changed - Replaced VariableNameModel as VariableNameListModel ## [1.46.8] - 2023-08-29 ### Changed - Replaced use of pyclip with the native kit clipboard ## [1.46.7] - 2023-08-25 ### Changed - Fixed write to target flag ## [1.46.6] - 2023-08-19 ### Added - Missing extension icon ## [1.46.5] - 2023-08-14 ### Changed - Moved omni.graph.ui from Kit to the OmniGraph repo ## [1.46.4] - 2023-07-27 ### Removed - Test that requires omni.graph.ui_nodes to work - moved to the downstream repo with that extension ## [1.46.3] - 2023-07-13 ### Removed - Removed the “defaultEvaluator” and “useCachedConnectionsForFileLoad” OG settings. ## [1.46.2] - 2023-06-27 ### Fixed - Fixed some documentation nits ## [1.46.1] - 2023-06-12 ### Changed - Fixed one deprecated ogt.OmniGraphExtension reference which was missed. ## [1.46.0] - 2023-06-08 ### Changed - Remove widget for input bundle ## [1.45.3] - 2023-06-08 ### Changed - Replaced load-time dependency on omni.kit.window.tests with a runtime dependency ## [1.45.2] - 2023-05-29 ### Changed - Replaced deprecated calls with supported versions ## [1.45.1] - 2023-05-26 ### Added - Added test for layer identifier property widget. ## [1.45.0] - 2023-05-23 ### Removed ## [1.44.2] - 2023-05-17 ### Changed - Updated tests to work with ReadPrimsV2 node. ## [1.44.1] - 2023-05-17 ### Fixed - read/write prim attribute name widget shows graph attributes when targeting instanced prim ## [1.44.0] - 2023-05-11 ### Added - OmniGraphTfTokenNoAllowedTokensModel to handle tokens as asset-paths ### Changed - OG property panel widgets now commit changes on end-edit instead of every change for string/token ## [1.43.0] - 2023-05-08 ### Deprecated - Removed deprecated locations of Python modules ## [1.42.1] - 2023-05-05 ### Changed - Updated `ReadPrims` related tests during to node inputs changes. ## [1.42.0] - 2023-05-04 ### Changed - Filter out problematic event types in on_graph_event ## [1.41.0] - 2023-04-26 ### Changed - Fix wording of bundle/target tooltip - Fix unresolved attribute label ## [1.40.3] - 2023-04-24 ### Changed - Read/WritePrimAttribute nodes will find attribute names when prim or primPath is connected ## [1.40.2] - 2023-04-24 ### Fixed - Replaced deprecated call to get_elem_count ## [1.40.1] - 2023-04-21 ### Fixed - target property widget without template ## [1.40.0] - 2023-04-20 ### Added - Reset menu item for type-conversion menu ## [1.39.0] - 2023-04-17 ### Changed - target attributes now show instancing target path as relative to symbol ## [1.38.5] - 2023-04-12 ### Changed - Created template class for nodes with prim/primPath structure - Changed bundle buttons in UI to say “Bundle(s)” ## [1.38.4] - 2023-04-11 ### Fixed - Prim node template allows text editing when non-valid prim is selected ## [1.38.3] - 2023-04-11 ### Removed - Removed node documentation TODO which is no longer relevant ## [1.38.2] - 2023-04-03 ### Fixed - Fixed incorrect object in template ### Added - Added test for property window output extended attributes ## [1.38.1] - 2023-04-03 ### Changed - Added timcode to read/write prim Inputs group - Name consistency pass ## [1.38.0] - 2023-04-03 ### Added - Support for picking graph-instancing-target ## [1.37.4] - 2023-03-31 ### Changed - output and state target attributes show values not target inputs - Relationship attributes now are sorted into their respective port display group ## [1.37.3] - 2023-03-30 ### Changed - Target widget shows as readonly when port is connected ## [1.37.2] - 2023-03-24 ### Fixed - Fix no len() exception when showing Quat attributes ## [1.37.1] - 2023-03-24 ### Changed - Graph instance variable now show warning when there is a type mismatch ## [1.37.0] - 2023-03-24 ### Changed - Updated Camera, picking nodes to use new target type for prim input ### Fixed - Fixed ReadPrimAttributes property panel throwing errors ## [1.36.0] - 2023-03-24 ### Added - New button to access the Fabric inspector ### Removed - Obsolete flags for dumping Fabric data from the graph ## [1.35.2] - 2023-03-16 ### Added - “threadsafe” scheduling hints to various nodes - “usd-write” scheduling hint to OgnSetViewportFullscreen node ## [1.35.1] - 2023-03-09 ### Fixed - Check component index is valid when comparing values ## [1.35.0] - 2023-03-10 ### Changed ## [1.34.3] - 2023-03-09 ### Added - Change default index for static version of internal state to be the authoring graph - Add wrappers for shared and per-instance state query functions ## [1.34.2] - 2023-03-08 ### Fixed - Fix exception when bringing up the attribute context menu on a non-node attribute. ## [1.34.1] - 2023-03-06 ### Fixed - Fix exceptions from property widget when multi-selecting certain node types ## [1.34.0] - 2023-03-06 ### Changed - Removed the warning about nodes being incompatible with instancing ## [1.33.2] - 2023-02-28 ### Fixed - OmniUiTest-based tests close any stages they open to avoid dangling graph references which crash on exit. ## [1.33.1] - 2023-02-25 ### Changed - Modifed format of Overview to be consistent with the rest of Kit ## [1.33.0] - 2023-02-24 ### Added - build_port_type_convert_menu - property panel context menu for converting extended types ## [1.32.1] - 2023-02-22 ### Added - Links to JIRA tickets regarding filling in the missing documentation ## [1.32.0] - 2023-02-21 ### Changed - Added usdWriteBack to WritePrimAttribute ## [1.31.4] - 2023-02-21 ### Changed - Change ComputeNodeWidget label to reflect node type ## [1.31.3] - 2023-02-20 ### Changed - Made the interfaces subproject unique to omni.graph.ui ## [1.31.2] - 2023-02-19 ### Changed - Added label to the main doc page so that higher level docs can reference the extension - Tagged for adding links to node documentation ## [1.31.1] - 2023-02-05 ### Added - Add property filter support ## [1.31.0] - 2023-02-15 ### Changed - unconnected token input arrays can be edited with property panel ### Fixed - Don’t error on default value of NaN for float inputs ## [1.30.2] - 2023-02-13 ### Changed - Runtime initialization for the `inputs:renderer` attribute of `OgnSetViewportRenderer` ## [1.30.1] - 2023-02-10 ### Changed - Correct namespace of `OgnSetViewportFullscreen` ## [1.30.0] - 2023-02-09 ### Added - Added `OgnSetViewportFullscreen` - Added `OgnSetViewportRenderer` and `OgnGetViewportRenderer` - Added `OgnSetViewportResolution` and `OgnGetViewportResolution` ## [1.29.3] - 2023-02-06 ### Fixed - Bug in property panel when setting resolved attribute values ## [1.29.2] - 2023-02-02 ### Fixed - Lint error that appeared when pylint updated ## [1.29.1] - 2023-01-30 ### Changed - Removed the kit-sdk landing page - Moved all of the documentation into the new omni.graph.docs extension ## [1.29.0] - 2023-01-11 ### Changed - ABI calls to take into account instancing - Changes related to introduction of native vectorization in core ## [1.28.4] - 2022-12-28 ### Changed - Changed the way errors and warnings are surfaced to OgnReadWidgetProperty/OgnWriteWidgetProperty ## [1.28.3] - 2022-12-07 ### Fixed - Make sure variable colour widgets use AbstractItemModel ## [1.28.2] - 2022-12-05 ### Fixed - Fixed tab not working on variable vector fields ## [1.28.1] - 2022-12-05 ### Fixed - Fixed UI update issues with graph variable widgets ## [1.28.0] - 2022-11-24 ### Removed - Widget controlling the deleted setting useSchemaPrims ## [1.27.0] - 2022-11-17 ### Removed - Removed `useSchemaPrims` setting control widget ## [1.26.0] - 2022-11-12 ### Removed - Widget controlling the deleted implicit global graph setting ## [1.25.0] - 2022-11-02 ### Added - Display initial and runtime values of graph variables ## [1.24.1] - 2022-10-28 ### Fixed - Undo on node attributes ## [1.24.0] - 2022-10-20 ### Added - Custom Property Panel for OmniGraphCompoundNodeType schema Prims ## [1.23.0] - 2022-09-28 ### Added - Widget for reporting timing information related to extension processing by OmniGraph ## [1.22.2] - 2022-09-19 ### Added - Use id parameter for Viewport picking request so a node will only generate request. ## [1.22.1] - 2022-09-09 ### Added - Instance variable properties remove underlying attribute when reset to default ## [1.22.0] - 2022-08-31 ### Changed - Added OmniGraphAttributeModel to public API ## [1.21.1] - 2022-08-19 ### Changed - Added OnVariableChange to the list of instancing-compatible nodes ## [1.21.0] - 2022-08-19 ### Added - UI for controlling new setting that turns deprecations into errors ## [1.20.1] - 2022-08-17 ### Changed - Refactored scene frame to be widget-based instead of monolithic ## [1.20.0] - 2022-08-16 ### Fixed - Modified the import path acceptance pattern to adhere to PEP8 guidelines - Fixed hot reload for the editors by correctly destroying menu items - Added FIXME comments recommended in a prior review ### Added - Button for Save-As to support being able to add multiple nodes in a single session ## [1.19.0] - 2022-08-11 ### Added - ReadWindowSize node - ‘widgetPath’ inputs to ReadWidgetProperty, WriteWidgetProperty and WriteWidgetStyle nodes. ### Changed - WriteWidgetStyle now reports the full details of style syntax errors. ## [1.18.1] - 2022-08-10 ## Fixed - Applied formatting to all of the Python files ## [1.18.0] - 2022-08-09 ### Changed - Removed unused graph editor modules - Removed omni.kit.widget.graph and omni.kit.widget.fast_search dependencies ## [1.17.1] - 2022-08-06 ### Changed - OmniGraph(API) references changed to ‘Visual Scripting’ ## [1.17.0] - 2022-08-05 ### Added - Mouse press gestures to picking nodes ## [1.16.4] - 2022-08-05 ### Changed - Fixed bug related to parameter-tagged properties ## [1.16.3] - 2022-08-03 ### Fixed - All of the lint errors reported on the Python files in this extension ## [1.16.2] - 2022-07-28 ### Fixed - Spurious error messages about ‘Node compute request is ignored because XXX is not request-driven’ ## [1.16.1] - 2022-07-28 ### Changed - Fixes for OG property panel - compute_node_widget no longer flushes prim to FC ## [1.16.0] - 2022-07-25 ### Added - Viewport mouse event nodes for click, press/release, hover, and scroll ### Changed - Behavior of drag and picking nodes to be consistent ## [1.15.3] - 2022-07-22 ### Changed - Moving where custom metadata is set on the usd property so custom templates have access to it ## [1.15.2] - 2022-07-15 ### Added - test_omnigraph_ui_node_creation() ### Fixed - Missing graph context in test_open_and_close_all_omnigraph_ui() ### Changed - Set all of the old Action Graph Window code to be omitted from pyCoverage ## [1.15.1] - 2022-07-13 - OM-55771: File browser button ## [1.15.0] - 2022-07-12 ### Added - OnViewportDragged and ReadViewportDragState nodes ### Changed - OnPicked and ReadPickState, most importantly how OnPicked handles an empty picking event ## [1.14.0] - 2022-07-08 ## [1.13.0] - 2022-07-08 ### Changed - Refactored imports from omni.graph.tools to get the new locations ### Added - Added test for public API consistency ## [1.12.0] - 2022-07-07 ### Changed - Overhaul of SetViewportMode - Changed default viewport for OnPicked/ReadPickState to 'Viewport' - Allow templates in omni.graph.ui to be loaded ## [1.11.0] - 2022-07-04 ### Added - OgnSetViewportMode.widgetPath attribute ### Changed - OgnSetViewportMode does not enable execOut if there’s an error ## [1.10.1] - 2022-06-28 ### Changed - Change default viewport for SetViewportMode/OnPicked/ReadPickState to 'Viewport Next' ## [1.10.0] - 2022-06-27 ### Changed - Move ReadMouseState into omni.graph.ui - Make ReadMouseState coords output window-relative ## [1.9.0] - 2022-06-24 ### Added - Added PickingManipulator for prim picking nodes controlled from SetViewportMode - Added OnPicked and ReadPickState nodes for prim picking ## [1.8.5] - 2022-06-17 ### Added - Added instancing ui elements ## [1.8.4] - 2022-06-07 ### Changed - Updated imports to remove explicit imports - Added explicit generator settings ## [1.8.3] - 2022-05-24 ### Added - Remove dependency on Viewport for Camera Get/Set operations - Run tests with omni.hydra.pxr/Storm instead of RTX ## [1.8.2] - 2022-05-23 ### Added - Use omni.kit.viewport.utility for Viewport nodes and testing. ## [1.8.1] - 2022-05-20 ### Fixed - Change cls.default_model_table to correctly set model_cls in _create_color_or_drag_per_channel for vec2d, vec2f, vec2h, and vec2i omnigraph attributes - Infer default values from type for OG attributes when not provided in metadata ## [1.8.0] - 2022-05-05 ### Added ## Support for enableLegacyPrimConnections setting, used by DS but deprecated ## Fixed ### Tooltips and descriptions for settings that are interdependent ## [1.7.1] - 2022-04-29 ### Changed #### Made tests derive from OmniGraphTestCase ## [1.7.0] - 2022-04-26 ### Added #### GraphVariableCustomLayout property panel widget moved from omni.graph.instancing ## [1.6.1] - 2022-04-21 ### Fixed #### Some broken and out of date tests. ## [1.6.0] - 2022-04-18 ### Changed #### Property Panel widget for OG nodes now reads attribute values from Fabric backing instead of USD. ## [1.5.0] - 2022-03-17 ### Added #### Added `add_create_menu_type` and `remove_create_menu_type` functions to allow kit-graph extensions to add their corresponding create graph menu item ### Changed #### `Menu.create_graph` now return the wrapper node, and will no longer pops up windows #### `Menu` no longer creates the three menu items `Create\Visual Sciprting\Action Graph`, `Create\Visual Sciprting\Push Graph`, `Create\Visual Sciprting\Lazy Graph` at extension start up #### Creating a graph now will directly create a graph with default title and open it ## [1.4.4] - 2022-03-11 ### Added #### Added glyph icons for menu items `Create/Visual Scripting/` and items under this submenu #### Added Create Graph context menu for viewport and stage windows. ## [1.4.3] - 2022-03-11 ### Fixed #### Node is written to backing store when the custom widget is reset to ensure that view is up to date with FC. ## [1.4.2] - 2022-03-07 ### Changed #### Add spliter for items in submenu `Window/Visual Scripting` #### Renamed menu item `Create/Graph` to `Create/Visual Scripting` #### Changed glyph icon for `Create/Visual Scripting` and added glyph icons for all sub menu items under ## [1.4.1] - 2022-02-22 ### Changed #### Change `Window/Utilities/Attribute Connection`, `Window/Visual Scripting/Node Description Editor` and `Window/Visual Scripting/Toolkit` into toggle buttons #### Added OmniGraph.svg glyph for `Create/Graph` ## [1.4.0] - 2022-02-16 ### Changes #### Decompose the original OmniGraph menu in toolbar into several small menu items under correct categories ## [1.3.0] - 2022-02-10 # [1.2.2] - 2022-01-28 ## Fixed - Toolkit access to the setting that uses schema prims in graphs, and a migration tool for same # [1.2.1] - 2022-01-21 ## Fixed - Potential crash when handling menu or stage changes # [1.2.0] - 2022-01-06 ## Fixed - ReadPrimAttribute/WritePrimAttribute property panel when usePath is true # [1.1.0] - 2021-12-02 ## Changes - Fixed compute node widget bug with duplicate graphs # [1.0.2] - 2021-11-24 ## Changes - Fixed compute node widget to work with scoped graphs # [1.0.1] - 2021-02-10 ## Changes - Updated StyleUI handling # [1.0.0] - 2021-02-01 ## Initial Version - Started changelog with initial released version of the OmniGraph core
changelog-omni-graph-window-action_CHANGELOG.md	# Changelog This document records all notable changes to the omni.graph.window.action extension. The format is based on [Keep a Changelog](https://keepachangelog.com). The project adheres to [Semantic Versioning](https://semver.org). ## [1.26.1] - 2024-04-17 ### Added - Add a ‘support_level’ entry to the configuration file of the extensions ## [1.26.0] - 2024-04-10 ### Changed - Bumped dependency on omni.graph to version 1.139.0 - Bumped dependency on omni.graph.core to version 2.177.1 - Bumped dependency on omni.graph.tools to version 1.77.0 ## [1.25.1] - 2024-03-20 ### Fixed - Removed obsolete import ## [1.25.0] - 2024-03-18 ### Changed - Bumped dependency on omni.graph.core to version 2.176.3 - Bumped dependency on omni.graph to version 1.138.1 ## [1.24.0] - 2024-02-15 ### Changed - Bumped dependency on omni.graph.core to version 2.174.2 - Bumped dependency on omni.graph.tools to version 1.76.1 ## [1.23.0] - 2024-02-05 ### Changed - Bumped dependency on omni.graph to version 1.138.0 - Bumped dependency on omni.graph.core to version 2.174.0 - Bumped dependency on omni.graph.tools to version 1.76.0 ## [1.22.0] - 2024-01-31 ### Changed - Bumped dependency on omni.graph to version 1.137.0 - Bumped dependency on omni.graph.core to version 2.171.1 - Bumped dependency on omni.graph.tools to version 1.76.0 ## [1.21.0] - 2024-01-30 ### Changed - Bumped dependency on omni.graph to version 1.136.0 - Bumped dependency on omni.graph.core to version 2.170.0 - Bumped dependency on omni.graph.tools to version 1.75.0 ## [1.20.0] - 2024-01-23 ### Changed - Bumped dependency on omni.graph to version 1.136.1 - Bumped dependency on omni.graph.core to version 2.170.1 - Bumped dependency on omni.graph.tools to version 1.74.0 ## [1.19.0] - 2024-01-18 ### Changed - Bumped dependency on omni.graph.core to version 2.169.1 - Bumped dependency on omni.graph to version 1.135.1 - Bumped dependency on omni.graph.tools to version 1.73.0 ## [1.18.1] - 2024-01-13 ### Fixed - Repository URL in config file. ## [1.18.0] - 2024-01-12 ### Changed - Bumped dependency on omni.graph to version 1.134.7 - Bumped dependency on omni.graph.core to version 2.169.0 - Bumped dependency on omni.graph.tools to version 1.70.0 ## [1.17.2] - 2024-01-04 ### Changed - Updated golden image tests to be less affected by changes to the node catalog. ### Removed - Kit 104-specific image tests. ## [1.17.1] - 2024-01-03 ### Changed - Adds toast warning when pasting node with variables that does not exist in the current graph. And ignore nodes that are incompatible ## [1.17.0] - 2023-12-28 ### Changed - Bumped dependency on omni.graph.tools to version 1.69.0 ## [1.16.0] - 2023-12-28 ### Changed - Bumped dependency on omni.graph.core to version 2.167.0 - Bumped dependency on omni.graph to version 1.134.2 - Bumped dependency on omni.graph.tools to version 1.68.0 ## [1.15.0] - 2023-12-18 ### Changed - Bumped dependency on omni.graph.core to version 2.166.0 - Bumped dependency on omni.graph to version 1.134.0 - Bumped dependency on omni.graph.tools to version 1.65.0 ## [1.14.0] - 2023-12-12 ### Changed - Bumped dependency on omni.graph.core to version 2.165.3 - Bumped dependency on omni.graph to version 1.133.2 - Bumped dependency on omni.graph.tools to version 1.65.0 ## [1.13.0] - 2023-12-11 ### Changed - Bumped dependency on omni.graph.core to version 2.165.3 - Bumped dependency on omni.graph to version 1.133.2 - Bumped dependency on omni.graph.tools to version 1.65.0 ## [1.12.2] - 2023-08-14 ### Changed ## Changed - Fix test for renamed action nodes ## [1.12.1] - 2023-07-31 ### Changed - Standardized the format of the CHANGELOG ## [1.12.0] - 2023-07-22 ### Added - Main documentation page ## [1.11.2] - 2023-07-21 ### Removed - Another omni.graph.test dependency. ## [1.11.1] - 2023-07-20 ### Changed - Bumping the version so that debug versions of extensions will publish ## [1.11.0] - 2023-07-19 ### Removed - Obsolete test dependency on omni.graph.test ## [1.10.1] - 2023-07-18 ### Fixed - Spelling errors ## [1.10.0] - 2023-07-10 ### Changed - Migrated this extension from kit-graphs to the kit-omnigraph repo. The kit-graphs repo will continue to be used for Kit 105.0-based releases. ## [1.9.0] - 2023-06-22 ### Changed - Nodes created from the QuickSearch window by clicking on an item or pressing ENTER will now be created at the position the mouse was at when QuickSearch was invoked. ### Fixed - Clicking on a node type in the QuickSearch window will reliably create the node. ## [1.8.1] - 2023-06-05 ### Changed - Replaced deprecated omni.graph.core.MetadataKeys references with omni.graph.tools.ogn.MetadataKeys ## [1.8.0] - 2023-05-12 ### Added - Enable double-click to enter compound nodes ## [1.7.7] - 2023-05-10 ### Updated - Updated golden image ## [1.7.6] - 2023-05-04 ### Changed - Disabled node rasterization in tests. ## [1.7.5] - 2023-03-31 ### Changed - Removed omni.graph.ui_nodes tests ## [1.7.4] - 2023-03-28 ### Fixed - Disable crashing test ## [1.7.3] - 2023-03-21 ### Fixed - Fixed crashing test ## [1.7.2] - 2023-03-15 ### Fixed - A couple of golden image tests were overwriting each other’s output files. ## [1.7.1] - 2023-03-10 ### Fixed - another test fix ## [1.7.0] - 2023-03-08 ### Added - omni.graph.bundle.action test dependency ## [1.6.0] - 2023-03-07 ### Added - Action and hotkey support ## [1.5.6] - 2023-02-22 ### Fixed - An expected SyntaxError check in test_button_negative_invalid_style() now works with Python 3.10 as well. ## [1.5.5] - 2023-02-09 ### Changed - Use fastShutdown on tests to avoid problems in Kit 104.2 which have been fixed in 105. ## [1.5.4] - 2023-02-06 ### Changed - Disabled test_write_widget_style_with_widget_path on Linux ## [1.5.3] - 2023-02-02 ### Fixed - Add dependency to omni.kit.ui_test for tests ## [1.5.2] - 2023-01-19 ### Fixed - Action Graph window once again opens as soon as it is created, or shown for the first time. ## [1.5.1] - 2023-01-11 ### Fixed - The Action Graph window now toggles correctly in the Window -> Visual Scripting menu and selecting the menu item while it is checked will cause the window to close. ## [1.5.0] - 2023-01-09 ### Changed - Switched how versioned golden images are suffixed. The most recent version is unsuffixed and older versions are suffixed with last kit version they worked for. - Added new golden image for og.window.core.test_dynamic_attributes. - Merged all of the _get_kit_version() functions in og.window.* into one. ## [1.4.7] - 2023-01-07 ### Changed - Moved OgActionTestCatalogModel into action_catalog_model.py. - OgActionTestCatalogModel’s constructor now takes an iterable of the node types to allow. - Removed all the debugging prints that I added earlier. ## [1.4.6] - 2022-12-29 ### Fixed - Don’t cache a new connection until both of the connected nodes have been cached. ## [1.4.5] - 2022-12-29 ### Added - Some prints to investigate linux ETM test failure. ## [1.4.4] - 2022-12-22 ## [1.4.3] - 2022-12-19 ### Changed - Disable display of the viewport HUD, grid, and axis gnomon. - Moved tests requiring a viewport into test_ui_nodes.py - Removed viewport dependencies from the other tests. - Removed graph editor setup and display from the tests in test_ui_nodes.py ## [1.4.2] - 2022-12-08 ### Added - Added tests for Action Graph UI-creation nodes. - Added modern viewport as dependency ## [1.4.1] - 2022-12-07 ### Fixed - The window turns to black when it is closed when it’s moved to become an external window ## [1.4.0] - 2022-08-22 ### Changed - Created separate pre- and post-kit-105 golden images. ## [1.3.9] - 2022-08-22 ### Changed - Changed test golden image name to be unique among all extensions. ## [1.3.8] - 2022-03-30 ### Changed - update repo_build and repo-licensing ## [1.3.7] - 2022-03-29 ### Added - UI unit test framework. ## [1.3.6] - 2022-03-17 ### Added - The lifetime of `Create\Visual Sciprting\Action Graph` menu item is now controlled by this extension - After opening a graph, the correspnding graph editor window will become focused ## [1.3.5] - 2022-03-02 ### Changed - Mechanism for opening graph from stage widget ## [1.3.4] - 2022-02-23 ### Changed - skip the popup question if user clicks on the Create Graph button on toolbar ## [1.3.3] - 2022-02-22 ### Change - create OmniGraphNodeQuickSearchModel in the extension instead from the core ## [1.3.2] - 2022-02-16 ### Changed - Window is now located at Window/Visual Scripting/Action Graph ## [1.3.1] - 2022-02-21 ### Added - register quick search with Omni Graph Action nodes ## [1.3.0] - 2022-02-01 ## [1.2.0] - 2022-01-31 ### Fixed - Bump dependency on omni.graph.window.core ## [1.1.0] - 2022-01-28 ### Changed - Window is now located at Window/OmniGraph/Action Graph ## [1.0.36] - 2022-01-26 ### Changed - Filter non-action graphs out of graph selectors ## [1.0.35] - 2022-01-24 ### Changed - Specialize the catalog - Filter out node types from other types of graphs - Bump dependency on omni.graph.window.core to 1.1.0 ## [1.0.34] - 2022-01-20 ### Changed - Modified main widget button layout ## [1.0.33] - 2022-01-19 ### Changed - Implementation is now based on omni.graph.window.core ## [1.0.32] - 2022-01-14 ### Changed - Fix connection artifact for halfway connections ## [1.0.31] - 2022-01-14 ### Fixed - Display custom icons on node instances ## [1.0.30] - 2022-01-14 ### Fixed - Fixed an error thrown when creating a new graph ## [1.0.29] - 2022-01-12 ### Changed - Simplify port delegate override ## [1.0.28] - 2022-01-11 ### Fixed - Fixed a bug in USD notice handling ## [1.0.27] - 2022-01-07 ### Changed - Return the node type to override the node tooltip in modern delegate ## [1.0.26] - 2022-01-07 ### Changed - Save node positions and expansion state to USD. ## [1.0.25] - 2022-01-07 ### Fixed - Fixed an error that could occur when subgraph nodes are created. ## [1.0.24] - 2022-01-06 ### Changed - Node types with the metadata tag ‘hidden’ no longer appear. ## [1.0.23] - 2022-01-05 ### Changed - The node type catalog is now organized using OG categories metadata ## [1.0.22] - 2021-12-21 ### Changed - Added a ‘nice_name’ property to the model. ## [1.0.21] - 2021-12-20 ### Fixed - The automatically added output bundle attribute is now hidden by default for non-Prim OmniGraph nodes. ## [1.0.20] - 2021-12-20 ### Fixed - Position of dragged and dropped nodes ### Changed - Deprecated Prim nodes are no longer shown in the graph by default ## [1.0.19] - 2021-12-20 ### Changed - Changed connection and connected port color to constant gray by default ## [1.0.18] - 2021-12-17 ### Added - Toolbar added to OmniGraph window ## [1.0.17] - 2021-12-17 ### Fixed - Bug with is_output check causing errors and breaking subgraphs ## [1.0.16] - 2021-12-15 ### Changed - Input attributes with metadata “outputOnly” set to “1” will be given an output port and no input port. ## [1.0.15] - 2021-12-15 ### Fixed - Fix dynamic attributes in UI ## [1.0.14] - 2021-12-10 ### Fixed - Fix tooltips for extended types. ## [1.0.13] - 2021-12-09 ### Fixed - Fix for bug in stage RMB menu for ComputeGraph ## [1.0.12] - 2021-12-08 ### Fixed - Update window to be compatible with latest Kit. ## [1.0.11] - 2021-12-06 ### Fixed - Fix for bug in drop handler for legacy prim node setting ## [1.0.10] - 2021-12-06 ### Changed - Changed the delegate function name to align with other types of delegates ## [1.0.9] - 2021-12-06 ### Added - Tools for supporting working with multiple graphs ## [1.0.8] - 2021-12-03 ### Changed - Prim drop menu now offers Read/WritePrimAttribute instead of Read/WritePrim ## [1.0.7] - 2021-11-26 ### Fixed - Allow multiple inputs to execution attributes for nodes & subgraphs ## [1.0.6] - 2021-11-23 ### Fixed - Fixed the subgraph connection issue - Moved the execution pin delegate here from omni.kit.graph.delegate.modern ## [1.0.5] - 2021-11-23 ### Fixed - Moved hard coded color and icons from omni.kit.graph.delegate.modern here - Changed the catalog filter also check node type and node info ## [1.0.4] - 2021-11-19 ### Fixed - Fix the bundle attribute connection ## [1.0.3] - 2021-11-19 ### Fixed - Remove omni.graph.bundle.action extension. Otherwise, there is a circular dependency ## [1.0.2] - 2021-11-19 ### Fixed - Fixed issued caused by empty description of nodes - Fixed drop handler in new editor (read/write/read bundle) ## [1.0.1] - 2021-11-17 ### Fixed - Fixed error of [Error][omni.graph] Invalid NodeObj object in Py_Node triggered by graph model ## [1.0.0] - 2021-11-12 ### Added - Initial commit for omni graph
changelog-omni-graph-window-core_CHANGELOG.md	# Changelog This document records all notable changes to the omni.graph.window.core extension. The format is based on [Keep a Changelog](https://keepachangelog.com). The project adheres to [Semantic Versioning](https://semver.org). ## [1.109.1] - 2024-04-17 ### Added - Add a ‘support_level’ entry to the configuration file of the extensions ## [1.109.0] - 2024-04-10 ### Changed - Bumped dependency on omni.graph to version 1.139.0 - Bumped dependency on omni.graph.core to version 2.177.1 - Bumped dependency on omni.graph.tools to version 1.77.0 ## [1.108.1] - 2024-04-04 ### Changed - Change the behavior category to character ## [1.108.0] - 2024-03-18 ### Changed - Bumped dependency on omni.graph.core to version 2.176.3 - Bumped dependency on omni.graph to version 1.138.1 ## [1.107.0] - 2024-03-01 ### Fixed - If right mouse + Alt is held for zooming, it shouldn’t trigger context menu even when the click is on the nodes ## [1.106.0] - 2024-02-29 ### Changed - Removed workaround from OM-99274. ## [1.105.2] - 2024-02-29 ### Changed - Fixed graph selector to work in raster mode and external AG window to refocus when Opening Graph from stage. ## [1.105.1] - 2024-02-23 ### Changed - Fixing graph crash during switching graph through selector ## [1.105.0] - 2024-02-15 ## [1.104.0] - 2024-02-05 ### Changed - Bumped dependency on omni.graph to version 1.138.0 - Bumped dependency on omni.graph.core to version 2.174.0 - Bumped dependency on omni.graph.tools to version 1.76.0 ## [1.103.0] - 2024-01-31 ### Changed - Bumped dependency on omni.graph to version 1.137.0 - Bumped dependency on omni.graph.core to version 2.171.1 - Bumped dependency on omni.graph.tools to version 1.76.0 ## [1.102.1] - 2024-01-30 ### Fixed - increase test_create_connection refresh frames ## [1.102.0] - 2024-01-30 ### Changed - Bumped dependency on omni.graph to version 1.136.1 - Bumped dependency on omni.graph.core to version 2.170.1 - Bumped dependency on omni.graph.tools to version 1.74.0 ## [1.101.1] - 2024-01-29 ### Changed - Add unit tests for variable rename ## [1.101.0] - 2024-01-26 ### Added - Support for connecting subgraph inputs to subgraph outputs ## [1.100.1] - 2024-01-25 ### Fixed - Updated tests image containing constant nodes ## [1.100.0] - 2024-01-23 ### Changed - reverted change to call node_background_v2 - Bumped dependency on omni.graph to version 1.136.0 ## [1.99.1] - 2024-01-22 ### Changed - add node_background_v2 to allow disable drawing icon ## [1.99.0] - 2024-01-18 ### Changed - Bumped dependency on omni.graph.core to version 2.169.1 - Bumped dependency on omni.graph to version 1.135.1 - Bumped dependency on omni.graph.tools to version 1.73.0 ## [1.98.3] - 2024-01-16 ### Changed - Re-enable tests ## [1.98.2] - 2024-01-13 ### Fixed - Repository URL in config file. ## [1.98.1] - 2024-01-12 ### Changed - Update variable instances window ## [1.98.0] - 2024-01-12 ## [1.97.3] - 2024-01-04 ### Changed - Bumped dependency on omni.graph to version 1.134.7 - Bumped dependency on omni.graph.core to version 2.169.0 - Bumped dependency on omni.graph.tools to version 1.70.0 ## [1.97.2] - 2024-01-04 ### Changed - Made a test less time dependent (and thus less flaky). ## [1.97.1] - 2024-01-03 ### Removed - Kit 104-specific image tests. ## [1.97.1] - 2024-01-03 ### Changed - Adds right-click menu options for copy/paste. ## [1.97.0] - 2023-12-28 ### Changed - Bumped dependency on omni.graph.tools to version 1.69.0 ## [1.96.0] - 2023-12-28 ### Changed - Bumped dependency on omni.graph.core to version 2.167.0 - Bumped dependency on omni.graph to version 1.134.2 - Bumped dependency on omni.graph.tools to version 1.68.0 ## [1.95.0] - 2023-12-18 ### Changed - Bumped dependency on omni.graph.core to version 2.166.0 - Bumped dependency on omni.graph to version 1.134.0 - Bumped dependency on omni.graph.tools to version 1.65.0 ## [1.94.0] - 2023-12-15 ### Added - Event streams for OmniGraphWidget and OmniGraphModel. ## [1.93.0] - 2023-12-12 ### Changed - Enable port snapping connection for omni.graph.window.core, make sure the return widget is correct for port_input and port_output ## [1.92.0] - 2023-12-12 ### Changed - Bumped dependency on omni.graph.core to version 2.165.3 - Bumped dependency on omni.graph to version 1.133.2 - Bumped dependency on omni.graph.tools to version 1.65.0 ## [1.91.0] - 2023-12-11 ### Changed - Increase test wait time between frames - Bumped dependency on omni.graph.core to version 2.165.3 - Bumped dependency on omni.graph to version 1.133.2 - Bumped dependency on omni.graph.tools to version 1.65.0 ## [1.90.5] - 2023-12-08 ### Fixed - Call to private method was failing. Switched to public method. ## [1.90.4] - 2023-12-01 ### Changed - Added comment to catalog_model.py about a dependency on pseudo-node types in omni.kit.telemetry ## [1.90.3] - 2023-11-30 ### Fixed - (No content provided for this section) ## [1.90.2] - 2023-11-30 ### Changed - Fix spelling issues ## [1.90.1] - 2023-11-29 ### Changed - add get variable instances fn in variable model ## [1.90.0] - 2023-11-16 ### Fixed - If right mouse + Alt is held for zooming, it shouldn’t trigger context menu ## [1.89.3] - 2023-11-09 ### Changed - Ran the formatter ## [1.89.2] - 2023-11-06 ### Changed - IsolationModel EmptyPorts should not be renamable ## [1.89.1] - 2023-10-19 ### Changed - Fix compatibility with older versions of kit ## [1.89.0] - 2023-10-18 ### Added - Hidden menu items for mapping an target attributes ## [1.88.2] - 2023-09-27 ### Changed - Fix broken tests due to recent variable widget changes ## [1.88.1] - 2023-09-21 ### Changed - Fixed bundle connection test ## [1.88.0] - 2023-09-18 ### Changed - Restricting multi connections to bundle attributes without allowMultiInputs metadata ## [1.87.1] - 2023-09-12 ### Changed - Updating tests for new target nodes ## [1.87.0] - 2023-09-11 ### Changed - Renamed built-in characterSystem category to behavior and removed unused animationGraph category. ## [1.86.4] - 2023-09-08 ### Changed - Promote to Constant now works with target typed attributes ## [1.86.3] - 2023-09-07 ### Changed - replace VariableNameModel as VariableNameListModel ## [1.86.2] - 2023-09-07 ### Changed - Suppress multiple expected warnings/errors from incompatible type tests ## [1.86.1] - 2023-09-05 ### Changed - (No content provided for this section) ## [1.86.0] - 2023-08-22 ### Removed - Disabled test that no longer works with PostRenderGraph ## [1.85.9] - 2023-08-21 ### Changed - Promote to Constant now supports all availible types ## [1.85.8] - 2023-08-11 ### Changed - Promote to Constant now supports all availible types ## [1.85.7] - 2023-08-10 ### Changed - Changes OmniNote to Note in node catalog ## [1.85.6] - 2023-08-09 ### Changed - Changed “OmniNote” to just “Note” in node catalog ## [1.85.5] - 2023-08-09 ### Fixed - Renaming and connecting output bundles to compound node outputs no longer throw errors ## [1.85.4] - 2023-08-09 ### Fixed - Renaming a compound node correctly refreshes connections - Fixed exception during connection when renaming or creating compounds ### Changed - Promotion menu items no longer visible when nothing selected ## [1.85.3] - 2023-08-02 ### Fixed - Add rename port to context menu for connected ports ## [1.85.2] - 2023-08-02 ### Changed - Add context menu to promote unconnected inputs/outputs on a node ## [1.85.1] - 2023-08-02 ### Fixed - Editing a compound subgraph prim now opens the subgraph instead of printing an error ## [1.85.0] - 2023-08-01 ### Added - Context menus to create new ports from the virtual node ## [1.84.2] - 2023-07-31 ### Changed - Standardized the format of the CHANGELOG ## [1.84.1] - 2023-07-29 ### Fixed - Dragging prims from the Stage window into a graph view was failing with errors. ## [1.84.0] - 2023-07-22 ### Added - Main documentation page ## [1.83.1] - 2023-07-20 ## Changed - Bumping the version so that debug versions of extensions will publish ## [1.83.0] - 2023-07-19 ### Removed - Obsolete test dependency on omni.graph.test ## [1.82.1] - 2023-07-18 ### Fixed - Lint errors caused by formatter - Spelling errors ## [1.82.0] - 2023-07-18 ### Added - Enabled renaming ports on input and output nodes ### Changed - Reusing port names during rename automatically finds a new name ## [1.81.0] - 2023-07-17 ### Added - Ability to create an empty compound subgraph from the context menu ## [1.80.0] - 2023-07-10 ### Changed - Migrated this extension from kit-graphs to the kit-omnigraph repo. The kit-graphs repo will continue to be used for Kit 105.0-based releases. ## [1.69.1] - 2023-06-29 ### Fixed - Compound node ports were incorrectly refreshing on disconnection ## [1.69.0] - 2023-06-29 ### Added - Context menu now appears when right-clicking empty space ### Changed - Context menu on input and output nodes allows for removing of ports - Input and Output nodes hide unsupported operations in node context menu - Compound Nodes hide the help documentation overlay ## [1.68.0] - 2023-06-26 ### Changed - Support for only selecting backdrops only by header bar. - Moved backdropGetter so we can pass in the GraphWidget, to be able to get node sizes. ## [1.67.0] - 2023-06-23 ### Changed - The node catalog and QuickSearch now search the UI name of the node type rather than its internal name. - The node catalog and QuickSearch no longer search the node description. - The matching of search terms can now be spread between the node type and its category. - If a category matches the search terms it will be expanded even if none of its nodes match. ### Fixed - Clicking on a node type in the QuickSearch window will reliably create the node. ## [1.66.0] - 2023-06-23 ### Added - Enabled compound subgraphs for all builds ## [1.65.1] - 2023-06-22 ### Fixed - Variables nodes are now correctly created in compound graphs ## [1.65.0] - 2023-06-13 ### Added - Ability to create an empty compound subgraph from the context menu ## Added - Added input and output virtual nodes when using a compound subgraph ## [1.64.0] - 2023-06-12 ### Added - Added OmniNote functionality. ## [1.63.3] - 2023-06-09 ### Changed - Only enable new graph delegate behavior if compounds are enabled and compound subgraphs are supported ## [1.63.2] - 2023-06-07 ### Added - Context menus for add/remove/rename ports for compounds - Double click to edit compound names and port names - Use compound name rather than type, regardless of the type as name setting ## [1.63.1] - 2023-06-05 ### Changed - Replaced deprecrated omni.graph.core.MetadataKeys references with omni.graph.tools.ogn.MetadataKeys - Replaced deprecrated omni.graph.core.get_global_container_graphs references with get_global_orchestration_graphs - Replaced deprecrated omni.graph.tools.supported_attribute_type_names refs with omni.graph.tools.ogn.supported_attribute_type_names ## [1.63.0] - 2023-05-31 ### Changed - bump kit-sdk version - Breadcrumbs should use the compound name rather than the subgraph name - Select compound node after creation - Change tests to use lower case default compound name ## [1.62.0] - 2023-05-18 ### Changed - bumped kit-sdk version ## [1.61.0] - 2023-05-18 ### Changed - Moved `force_regenerate = True` to omni.kit.widget.graph ## [1.60.3] - 2023-05-17 ### Added - Added RMB menu option to edit a compound ## [1.60.2] - 2023-05-16 ### Fixed - Changed test to use different nodes that hadn’t been changed from 105 to 105.1 ## [1.60.1] - 2023-05-15 ### Fixed - Modified test to handle 105.0 and 105.1+ differently ## [1.60.0] - 2023-05-15 ### Changed - Re-enable double-click to enter compounds, but disable test caused by virtual input/output nodes appearing ## [1.59.3] - 2023-05-12 ### Fixed - Prim drop menu was always dropping ReadPrims. ## [1.59.2] - 2023-05-11 ### Updated # [1.59.1] - 2023-05-10 ## Updated - Updated golden images # [1.59.0] - 2023-05-04 ## Added - OmniGraphView.screen_to_view(), .mouse_to_view() and .mouse_to_screen() ## Fixed - Dialog windows in the graph editor not appearing at mouse pointer. - Invisible zombie dialog boxes never being destroyed. # [1.58.0] - 2023-05-01 ## Added - Collapse nodes to a subgraph compound node # [1.57.1] - 2023-04-24 ## Added - Added deprecation warning for bundle attributes without ‘allowMultiInputs’ metadata - Reenabled bundle connection test # [1.57.0] - 2023-04-24 ## Removed - Deprecated commands: OGSetUsdUINodeGraphNodeAttrCommand, OGRemoveUsdUIPositionAttrCommand # [1.56.1] - 2023-04-24 ## Fixed - too many refreshes when attribute values change # [1.56.0] - 2023-04-24 ## Changed - Reverted compound MR that enables subgraphs # [1.55.0] - 2023-04-20 ## Added - Ability to double-click and open up compound nodes - Added subgraphs to the list of graphs that can be switched to in the drop-down # [1.54.2] - 2023-04-18 ## Fixed - Fixed issue where connections were always removed when making multiple connections. - Updated test images for change in node help functionality # [1.54.1] - 2023-04-18 ## Fixed - The node help icon only appears when hovering over the header now and only after a half-second delay. - Only clicking with the left mouse button will bring up node help now. - Dragging on the help icon won’t bring up help. # [1.54.0] - 2023-04-14 ## Added - Type conversion context menu to nodes # [1.53.2] - 2023-04-14 ## Changed - Added more general way to handle relationship connections - Removed implicit multi-connection support for target types. Now relys on allowMultiInputs metadata. ## Added - Added test_delete_target_connection # [1.53.1] - 2023-04-11 ## Fixed ## [1.53.0] - 2023-04-11 ### Fixed - Call rebuild node when attributes are resolved ## [1.52.6] - 2023-04-11 ### Fixed - ActionGraph Subgraphs created in code or in older versions can be opened without exceptions in the editor. ## [1.52.5] - 2023-04-05 ### Changed - Dragging a prim into the editor and reading bundles now brings in a ReadPrims node in 105 and greater. ## [1.52.4] - 2023-04-05 ### Fixed - Fixed failing test_delete_connection test. ## [1.52.3] - 2023-04-05 ### Fixed - Fixed some invalid type hinting. ## [1.52.2] - 2023-04-03 ### Fixed - The node context menu now appears even when there is no selected node ## [1.52.1] - 2023-04-03 ### Fixed - Added better check for newest mouse position functions ## [1.52.0] - 2023-03-29 ### Added - Added Actions and Hotkeys for Copy & Paste in OmniGraphs. ## [1.51.1] - 2023-03-23 ### Fixed - Variable type changes handle authoring layer mismatches - Variable appearance refreshes on type change ## [1.51.0] - 2023-03-22 ### Added - graph_operations.show_help_for_node_type() ### Changed - Have the node menu and the help icon use the new method. ## [1.50.0] - 2023-03-21 ### Added - Restore support for a help page to open up when the user clicks on the node type icon ## [1.49.1] - 2023-03-15 ### Added - Added support for target attributes in editor ## [1.49.0] - 2023-03-15 ### Added - double-clicking on the empty canvas will now select the Graph ## [1.48.0] - 2023-03-08 ### Added - omni.graph.bundle.action test dependency ## [1.47.1] - 2023-03-08 ### Fixed - Updated the test golden images to match kit 105.1 ## Fixed ### [1.47.0] - 2023-03-07 #### Added - Action and hotkey support. ### [1.46.0] - 2023-03-07 #### Added - Added a context menu for nodes. ### [1.45.4] - 2023-03-06 #### Fixed - New connections to bundle ports will remove existing connections. ### [1.45.3] - 2023-03-01 #### Fixed - Only utilize the new run_coroutine() method if it exists in omni.kit.async_engine, otherwise revert to asyncio.ensure_future(). This is done for backwards compatibility with Kit 104.2, which doesn’t have the method. ### [1.45.2] - 2023-02-28 #### Changed - Replaced asyncio.ensure_future() call with the new omni.kit.async_engine.run_coroutine() method. ### [1.45.1] - 2023-02-22 #### Fixed - Attempts to create connections between incompatible attributes no longer remove the existing connections. ### [1.45.0] - 2023-02-21 #### Changed - Node types now sorted by name in catalog ### [1.44.4] - 2023-02-20 #### Added - Adds new category and icons for animationGraph and characterSystem. ### [1.44.3] - 2023-02-09 #### Changed - Use fastShutdown on tests to avoid problems in Kit 104.2 which have been fixed in 105. ### [1.44.2] - 2023-02-03 #### Removed - Removed support for the node help icon until some issues can be resolved. ### [1.44.1] - 2023-02-02 #### Fixed - Add dependency to omni.kit.ui_test for tests - OmniGraphNodeTypeCatalogModel init: removing passing of ‘args’ to super init. - Remove hardcoded subclass and self arguments in super() init call in the following classes: - OmniGraphSelectorItemDelegate - OmniGraphSelectorItem - OmniGraphSelectorModel - OmniGraphWindow: added property to store a function that will be called in on_build_window, This is done to fix a Pybind11 issue OM-79384, that was happening in the omni.graph.window.generic tests Note: this change should be reverted when that issue is solved. ### [1.44.0] - 2023-02-01 #### Added - Support for a help page to open up when the user clicks on the node type icon ### [1.43.3] - 2023-01-26 #### Changed - Disabled (in Linux ETM only) all tests which fail with ‘invalid self’ error. ### [1.43.2] - 2023-01-20 #### Fixed ## View -> Layout Nodes works again. Or at least as well as it used to. ## Added test_layout_nodes ## [1.43.1] - 2023-01-12 ### Fixed issue where hidden ports would be shown when node is first created. ## [1.43.0] - 2023-01-09 ### Changed Merged all of the _get_kit_version() functions in og.window.* into one. ## [1.42.4] - 2023-01-07 ### Fixed Don’t let OmniGraphNodeTypeCatalogModel build the node list until after its init () has returned. ## [1.42.3] - 2022-12-30 ### Fixed Don’t cache a new connection until both of the connected nodes have been cached. ## [1.42.2] - 2022-12-14 ### Fixed Increased image comparison threshold for test_set_from_variable to avoid failures due to minor differences in how text is aliased. ## [1.42.1] - 2022-12-13 ### Changed Update test golden image. ### Fixed Filter prop changes from removed prims instead of changed prims. ## [1.42.0] - 2022-12-12 ### Added Context menu on ports ### Added Promote to Constant, Promote to Variable and Set to/from Variable options ## [1.41.0] - 2022-12-01 ### Fixed Handle the deprecation of the useSchemaPrims preference. ## [1.40.1] - 2022-11-02 ### Added Create regression tests that mimic manual omnigraph changes ## [1.40.0] - 2022-10-28 ### Added Context menu for compound creation ## [1.39.0] - 2022-10-26 ### Added Support for compound node styles ## [1.38.0] - 2022-10-24 ### Changed Stopped OM-66897 changes from affecting pre-kit-105 builds. ## [1.37.0] - 2022-10-24 ### Changed OM-64076: Update drag and drop and add targets to the Read Prim. ## [1.36.0] - 2022-10-20 ### Changed ## [1.35.0] - 2022-10-17 ### Added - Initial support for graphs containing compound nodes ## [1.34.0] - 2022-09-14 ### Added - Added draw_header_label_left(), draw_header_label_center() and draw_header_label_right() (for OM-61502) ## [1.33.1] - 2022-09-14 ### Fixed - Fixed variable read and write widgets not override drag of variable ## [1.33.0] - 2022-09-08 ### Fixed - Revert to old way of disabling undo if omni.kit.undo.disabled() is not available. ## [1.32.0] - 2022-09-02 ### Fixed - Nodes once again update their colors and tooltips when their error status changes. ## [1.31.0] - 2022-08-31 ### Removed - The fixed version in the omni.kit.commands dependency. ## [1.30.3] - 2022-08-25 ### Changed - Fixing issue where bundle connections show up as fan-in even when they are not ## [1.30.2] - 2022-08-25 ### Changed - Added ability to open graphs when right-clicking on a node in the stage ## [1.30.1] - 2022-08-28 - Added omni.graph.tutorials as test dependency ## [1.30.0] - 2022-08-24 ### Changed - Uses event stream on graph registry instead of the extension manager to refresh node catalog ## [1.29.1] - 2022-08-22 ### Changed - Renamed test golden image to be unique among all extensions. ## [1.29.0] - 2022-08-08 ### Changed - OGSetUsdUINodeGraphNodeAttrCommand and OGRemoveUsdUIPositionAttrCommand have been deprecated in favor of UsdUINodeGraphNodeSetCommand and UsdUIRemovePositionCommand from omni.kit.graph.usd.commands. ## [1.28.1] - 2022-08-02 ### Fixed - OM-57134 Fix for renaming tuple variables cause them to be deleted ## [1.28.0] - 2022-07-29 ### Added - OM-56665 handling fan-in to any attribute type, not represented in UI (moving implementation to base class) ## [1.27.2] - 2022-07-28 ### Added - OM-56668 Drag and drop multiple prims from stage onto node editor (fix for only dropping “readprimintobundle”) ## [1.27.1] - 2022-07-28 ### Fixed - Variable type name is now in Sdf format when its model is initialized - Fixed error when reading tooltip for a non-existing variable ## [1.27.0] - 2022-07-21 ### Added - OM-56668 Drag and drop multiple prims from stage onto node editor ## [1.26.2] - 2022-07-19 ### Changed - VariableNameModel now notifies subscribed widgets only after editing is finished ## [1.26.1] - 2022-07-15 ### Fixed - Leak of model on window shutdown ## [1.26.0] - 2022-07-14 ### Changed - Removed the icon tooltip from node catalog items and extended the description tooltip over the icon ## [1.25.1] - 2022-07-05 ### Changed - Added function that can be shared with particle system graph when processing property changes ## [1.25.0] - 2022-07-05 ### Changed - Changed definition of get_item_value_model in catalog_model for new catalog item design ## [1.24.0] - 2022-07-05 ### Changed - Reverted change ## [1.23.5] - 2022-07-04 ### Changed - Added description to WriteVariable node’s tooltip. ## [1.23.4] - 2022-05-27 ### Changed - Removed view regeneration behavior from the literalOnly metadata key, and hardcoded it for Read/Write Variable nodes. ## [1.23.3] - 2022-05-27 ### Fixed - Renaming a variable to an existing name no longer creates a duplicate entry ## [1.23.2] - 2022-05-27 ### Fixed - Turned on always_force_regenerate optimization in OmniGraphView ## [1.23.1] - 2022-05-26 ### Fixed - dbl-click to rename backdrop ## [1.23.0] - 2022-05-23 ### Added - Backdrop support - ‘description’, ‘size’, ‘display_color’ and ‘stacking_order’ properties to OmniGraphModel - is_pseudo_node() and create_backdrop() methods to OmniGraphModel - Added dependency on omni.kit.graph.usd.commands ## [1.22.1] - 2022-05-18 ### Fixed ## [1.22.0] - 2022-05-17 ### Changed - Value changes to ui:graphnode:pos & ui:graphnode:expansionState now checked when the graph is dirtied. ## [1.21.1] - 2022-05-17 ### Fixed - Improved node description formatting by using newlines to indicate paragraph breaks ## [1.21.0] - 2022-05-17 ### Changed - When creating default node name from type name, strip out “(BETA)”. ## [1.20.0] - 2022-05-10 ### Changed - Replace all uses of OmniGraphWidget’s ‘_graph_model’ member with base class’s ‘model’. - References to ‘_graph_model’ by derived classes will be redirected to ‘model’ and a deprecation warning displayed. - Clear the model when the stage is closed rather than when it is opened. ## [1.19.0] - 2022-05-06 ### Added - Added support for truncated words in node catalog search window ## [1.18.2] - 2022-05-03 ### Fixed - Fixed errors being displayed when creating and modifying variables - Variable colors in side-panel now match variable node colors ## [1.18.1] - 2022-05-02 ### Fixed - Disable dragging for categories ### Added - Add icon borders for create node drop menu ## [1.18.0] - 2022-04-08 ### Added - ALT+RMB+Drag for graph zoom ## [1.17.0] - 2022-04-06 ### Fixed - Added missing ‘node’ param to header label __draw_header_label() ### Changed - Renamed _draw_header_label(), _draw_header_icon, and _draw_expansion_button() to make them private. ## [1.16.7] - 2022-04-06 ### Fixed - Fixed a bug where constant node names are broken - Refactored naming utils - moved make_nice_name() from graph_model.py to graph_config.py so that it can be called from everywhere - Determine node path from UI name rather than type name, for those nodes that don’t have the UI_NAME metadata ## [1.16.6] - 2022-04-05 ### Fixed - Fixed undo/redo for variable description ## [1.16.5] - 2022-04-04 ### Changed - Added support for multiple variable node types ## [1.16.4] - 2022-03-30 ### Fixed # [1.16.3] - 2022-03-30 ## Changed - Hide WriteVariable output port - Regenerate layout when a LITERAL_ONLY tagged attribute changes # [1.16.2] - 2022-03-30 ## Fixed - Fixed incorrect node type name # [1.16.1] - 2022-03-30 ## Changed - update repo_build and repo-licensing # [1.16.0] - 2022-03-28 ## Changed - Increment minor version so that derived windows can set a dependency which they know includes the test framework. # [1.15.1] - 2022-03-28 ## Added - UI unit test framework. # [1.15.0] - 2022-03-29 ## Added - Variable nodes have custom nodes colored based on variable type ## Fixed - Expansion state shows correct state with updated color # [1.14.3] - 2022-03-28 ## Changed - Made it default that open graph will not pop up an inquiry window in home # [1.14.2] - 2022-03-18 ## Fixed - Issue of deleting graph’s parent making the graph crash # [1.14.1] - 2022-03-18 ## Fixed - Fix the port colors - Fix the node type name formatting # [1.14.0] - 2022-03-16 ## Changed - Updated variable UI to match the latest design # [1.13.0] - 2022-03-16 ## Fixed - Node types marked as hidden only hide in the catalogue, not on the canvas # [1.12.0] - 2022-03-14 ## Fixed - When multiple nodes are selected dragging one now drags them all. # [1.11.0] - 2022-03-11 ## Changed - Added the ability to change the type of variables after creation - Removed the popup to create variables # [1.10.2] - 2022-03-09 ## Fixed - Undoing node layout won’t give an error. - Undoing node layout only requires a single undo, not one per node. ## [1.10.1] - 2022-03-08 ### Changed - Duplicated nodes will appear offset from their originals - Nodes which are duplicated together will have the same connections between them as their originals ## [1.10.0] - 2022-03-02 ### Added - Mechanism for registering graph editor extensions to open graphs from the stage widget - Optional dependency on omni.kit.window.quicksearch 2.1 ## [1.9.6] - 2022-02-25 ### Added - Added right mouse button menu for connection curve to disconnect selected connection - Added some comments about inputs property of graph_model ## [1.9.5] - 2022-02-23 ### Changed - Skip the popup question if user clicks on the Create Graph button on toolbar - Move the ? button to the right of the toolbar ## [1.9.4] - 2022-02-23 ### Fixed - Variables model refreshes properly when the graph is changed ## [1.9.3] - 2022-02-23 ### Changed - Moved the variable editing commands into kit ## [1.9.2] - 2022-02-22 ### Changed - Moved the quicksearch model to individual extensions - Default node position with on_drop ## [1.9.1] - 2022-02-22 ### Added - Added a shortcut from graph editor to preference ## [1.9.0] - 2022-02-22 ### Added - OmniGraphNodeQuickSearchModel for quick search ## [1.8.10] - 2022-02-22 ### Changed - tool tips for ports - added dependency on omni.graph.tools ## [1.8.9] - 2022-02-18 ### Changed - toolbar icon for graph selector ## [1.8.8] - 2022-02-18 ### Added - OG editors will now recognize the schema prims (OmniGraph, OmniGraphNode) when they are enabled. ### Changed - OG editors will not recognize ComputeGraph, GlobalComputeGraph or ComputeGraphSettings nodes if schema prims are enabled ## [1.8.7] - 2022-02-18 ### Fixed - If a prim has a bogus/non-existent UsdUI expansion state, fall back to a sensible default. ## [1.8.6] - 2022-02-18 ### Fixed - Variables model refreshes properly when the graph is changed ## [1.8.5] - 2022-02-17 ### Fixed - Nodes will refresh when dynamic attributes are added or removed - OmniGraphModel.expansion_state() wasn’t handling prims without UsdUI NodeGraphNodeAPI properly. - OmniGraphModel.expansion_state() was using the ‘node_type_name’ property incorrectly. ## [1.8.4] - 2022-02-16 ### Added - Script category icon - Added variables panel and supporting code ## [1.8.3] - 2022-02-16 ### Added - Added a Create Graph button to the toolbar - Added an Edit Graph button to the toolbar - Added a Help button to the toolbar ## [1.8.2] - 2022-02-16 ### Added - icons for tutorial and constant and animation categories ## [1.8.1] - 2022-02-15 ### Fixed - Fix “‘_OmniGraphModel__usd_expansion_state_to_og’ is not defined” error ## [1.8.0] - 2022-02-15 ### Added - OmniGraphModel.og_expansion_state_to_usd() - OmniGraphModel.usd_expansion_state_to_og() ### Changed - Removed ‘usd’ parameter from OmniGraphModel.get_default_node_expansion_state() ### Fixed - OmniGraphModel.import_node() was passing tuples instead of strings to get_default_node_expansion_state() ## [1.7.1] - 2022-02-14 ### Fixed - An error when Prims are dragged on to stage, and legacy prims are enabled ## [1.7.0] - 2022-02-14 ### Added - OmniGraphModel.get_default_node_expansion_state() ### Changed - Removed the first underscore from OmniGraphModel’s __connections, __reversed_connections, and __node_connected_ports members, making them available for use by derived classes. - Legacy Prim nodes now always display their node names, even when show_name_as_type is True. ### Fixed - Workaround for OM-44798: exclude zombie legacy Prim nodes from OmniGraphModel’s node caches. ## [1.6.6] - 2022-02-11 ### Added - Add icons to the getter and setter node dialogue ## [1.6.5] - 2022-02-11 ### Fixed - A regression where expansion state and View toolbar did not function ## [1.6.4] - 2022-02-10 ### Fixed - A regression where expansion state and View toolbar did not function ## [1.6.3] - 2022-02-09 ### Fixed - Clear cached port and connection data when a node is deleted. ## [1.6.2] - 2022-02-08 ### Added - Setter method for OmniGraphModel.name ### Fixed - Editing the node’s name by double-clicking on it in the graph now works. ### Changed - Double-clicking the node header won’t put you into edit mode if the header is displaying the node’s type instead of its name. - Node tooltip now always shows the node’s name and type, regardless of whether the header itself is showing name or type. ## [1.6.1] - 2022-02-04 ### Added - OmniGraphModel.get_node_from_prim() ### Changed - Nodes change visual appearance when they have evaluation warnings or errors. - Node header tooltip includes the current warning/error message. ## [1.5.1] - 2022-02-04 ### Fixed - Fallback category icon ### Changed - Removed Subgraph category ## [1.5.0] - 2022-02-01 ### Fixed - undo of connections from legacy Prims ### Changed - bump dependency on omni.graph to 1.9 ## [1.4.0] - 2022-01-31 ### Changed - Added the catalog delegate ## [1.3.0] - 2022-01-31 ### Fixed - Fixed prim node culling override logic - Temporarily relax dependency of omni.graph-1.9 to 1.8 to fix older builds of Create ## [1.2.2] - 2022-01-28 ### Fixed - Fixed delegate routing issue ## [1.2.1] - 2022-01-27 ### Fixed - Fixed dependency on omni.graph-1.9 - Changed default setting of showNameAsType ## [1.2.0] - 2022-01-26 ### Changed - Added OmniGraphWidget.is_graph_editable to allow filtering of graph selection ## [1.1.1] - 2022-01-25 ### Fixed - Bundle connections were not being drawn or connected # [1.1.0] - 2022-01-24 ## Changed - Minor refactoring - Only show nodes in their primary catalog category # [1.0.2] - 2022-01-20 ## Changed - Changed main widget button layout - Minor refactor # [1.0.1] - 2022-01-20 ## Changed - Changed graph to not use catalog icons - Updated fallback icon - Factored out some settings and paths to graph_config module # [1.0.0] - 2022-01-19 ## Added - Initial commit is migrating code from omni.graph.window.action
changelog-omni-graph-window-generic_CHANGELOG.md	# Changelog ## [1.24.1] - 2024-04-17 ### Added - Add a ‘support_level’ entry to the configuration file of the extensions ## [1.24.0] - 2024-04-10 ### Changed - Bumped dependency on omni.graph to version 1.139.0 - Bumped dependency on omni.graph.core to version 2.177.1 - Bumped dependency on omni.graph.tools to version 1.77.0 ## [1.23.1] - 2024-03-20 ### Fixed - Removed obsolete import ## [1.23.0] - 2024-03-18 ### Changed - Bumped dependency on omni.graph.core to version 2.176.3 - Bumped dependency on omni.graph to version 1.138.1 ## [1.22.0] - 2024-02-15 ### Changed - Bumped dependency on omni.graph.core to version 2.174.2 - Bumped dependency on omni.graph.tools to version 1.76.1 ## [1.21.0] - 2024-02-05 ### Changed - Bumped dependency on omni.graph to version 1.138.0 - Bumped dependency on omni.graph.core to version 2.174.0 - Bumped dependency on omni.graph.tools to version 1.76.0 ## [1.20.0] - 2024-01-31 ### Changed - Bumped dependency on omni.graph to version 1.137.0 - Bumped dependency on omni.graph.core to version 2.171.1 - Bumped dependency on omni.graph.tools to version 1.76.0 ## [1.19.0] - 2024-01-30 # [1.18.0] - 2024-01-23 ## Changed - Bumped dependency on omni.graph to version 1.136.1 - Bumped dependency on omni.graph.core to version 2.170.1 - Bumped dependency on omni.graph.tools to version 1.74.0 # [1.17.0] - 2024-01-18 ## Changed - Bumped dependency on omni.graph.core to version 2.169.1 - Bumped dependency on omni.graph to version 1.135.1 - Bumped dependency on omni.graph.tools to version 1.73.0 # [1.16.1] - 2024-01-13 ## Fixed - Repository URL in config file. # [1.16.0] - 2024-01-12 ## Changed - Bumped dependency on omni.graph to version 1.134.7 - Bumped dependency on omni.graph.core to version 2.169.0 - Bumped dependency on omni.graph.tools to version 1.70.0 # [1.15.2] - 2024-01-04 ## Changed - Updated golden image tests to be less affected by changes to the node catalog. ## Removed - Kit 104-specific image tests. # [1.15.1] - 2024-01-03 ## Changed - Adds toast warning when pasting node with variables that does not exist in the current graph. And ignore nodes that are incompatible # [1.15.0] - 2023-12-28 ## Changed - Bumped dependency on omni.graph.tools to version 1.69.0 # [1.14.0] - 2023-12-28 ## Changed - Bumped dependency on omni.graph.core to version 2.167.0 - Bumped dependency on omni.graph to version 1.134.2 - Bumped dependency on omni.graph.tools to version 1.68.0 # [1.13.0] - 2023-12-18 ## Changed - Bumped dependency on omni.graph.core to version 2.166.0 - Bumped dependency on omni.graph to version 1.134.0 - Bumped dependency on omni.graph.tools to version 1.65.0 # [1.12.0] - 2023-12-12 ## Changed - Bumped dependency on omni.graph.core to version 2.165.3 - Bumped dependency on omni.graph to version 1.133.2 - Bumped dependency on omni.graph.tools to version 1.65.0 # [1.11.0] - 2023-12-11 ## Changed - Bumped dependency on omni.graph.core to version 2.165.3 - Bumped dependency on omni.graph to version 1.133.2 - Bumped dependency on omni.graph.tools to version 1.65.0 # [1.10.1] - 2023-07-31 ## Changed - Standardized the format of the CHANGELOG ## [1.10.0] - 2023-07-22 ### Added - Main documentation page ## [1.9.1] - 2023-07-20 ### Changed - Bumping the version so that debug versions of extensions will publish ## [1.9.0] - 2023-07-19 ### Removed - Obsolete test dependency on omni.graph.test ## [1.8.2] - 2023-07-18 ### Fixed - Lint errors caused by formatter ## [1.8.1] - 2023-07-17 ### Fixed - Format and linting on tests ## [1.8.0] - 2023-07-10 ### Changed - Migrated this extension from kit-graphs to the kit-omnigraph repo. The kit-graphs repo will continue to be used for Kit 105.0-based releases. ## [1.7.0] - 2023-06-22 ### Changed - Nodes created from the QuickSearch window by clicking on an item or pressing ENTER will now be created at the position the mouse was at when QuickSearch was invoked. ### Fixed - Clicking on a node type in the QuickSearch window will reliably create the node. ## [1.6.2] - 2023-06-14 ### Changed - Updated golden image ## [1.6.1] - 2023-06-05 ### Changed - Replaced deprecrated omni.graph.core.MetadataKeys references with omni.graph.tools.ogn.MetadataKeys ## [1.6.0] - 2023-05-09 ### Added - Ability to double-click and enter compounds ## [1.5.2] - 2023-05-04 ### Changed - Disabled node rasterization in tests. ## [1.5.1] - 2023-04-11 ### Fixed - Updated the test golden images to match kit 105.1 ## [1.5.0] - 2023-03-31 ### Added - Added filter_fn to Generic Graph, to specify valid prims to paste into the graph. ## [1.4.0] - 2023-03-07 ### Added - Action and hotkey support. ## [1.3.17] - 2023-02-09 ### Changed ## [1.3.16] - 2023-02-02 ### Changed - Add additional dependencies - Add dependency to omni.kit.ui_test for tests - Added hack to tests which passes a function to the OmniGraphWindow constructur to fix a Pybind11 issue OM-79384. Note: this change should be reverted when that issue is solved. ## [1.3.15] - 2023-01-26 ### Changed - Disabled (in Linux ETM only) all tests which fail with ‘invalid self’ error. ## [1.3.14] - 2023-01-19 ### Fixed - Generic Graph window once again opens as soon as it is created, or shown for the first time. ## [1.3.13] - 2023-01-11 ### Fixed - The Generic Graph window now toggles correctly in the Window -> Visual Scripting menu and selecting the menu item while it is checked will cause the window to close. ## [1.3.12] - 2023-01-09 ### Changed - Ensure outstanding futures are cancelled on object destruction. ## [1.3.11] - 2022-12-07 ### Fixed - The window turns to black when it is closed when it’s moved to become an external window ## [1.3.10] - 2022-08-28 - Added omni.graph.tutorials as test dependency ## [1.3.9] - 2022-08-22 ### Changed - Renamed test golden image to be unique among all extensions. ## [1.3.8] - 2022-03-30 ### Changed - update repo_build and repo-licensing ## [1.3.7] - 2022-03-29 ### Added - UI testing framework. ## [1.3.6] - 2022-03-17 ### Added - The lifetime of Create\Visual Sciprting\Push Graph, Create\Visual Sciprting\Lazy Graph menu items is now controlled by this extension - After opening a graph, the correspnding graph editor window will become focused ## [1.3.5] - 2022-03-02 ### Added - Stage widget can open non-action graphs in generic editor ## [1.3.4] - 2022-02-23 ### Changed - skip the popup question if user clicks on the Create Graph button on toolbar ## [1.3.3] - 2022-02-22 ### Change - create OmniGraphNodeQuickSearchModel in the extension instead from the core # [1.3.1] - 2022-02-21 ## Changed - Window is now located at Window/Visual Scripting/Generic Graph - Renamed window to Generic Graph # [1.3.1] - 2022-02-21 ## Added - register quick search with Omni Graph Generic nodes # [1.3.0] - 2022-02-01 - Bump dependency on omni.graph.core # [1.2.0] - 2022-01-31 ## Changed - Added no-op model override and cleanup - Temporarily tie Prim culling to the drag-drop setting - Workaround for Create 2022.1.0-beta8 # [1.1.0] - 2022-01-28 ## Changed - Window is now located at Window/OmniGraph/OmniGraph Generic ## Fixed - Destroy window when extension is unloaded # [1.0.0] - 2022-01-26 ## Added - Initial commit - add new window type
changelog-omni-graph_CHANGELOG.md	# Changelog All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ## [1.140.0] - 2024-04-22 ### Added - Added python bindings for the CUDA device ID used by OmniGraph. ## [1.139.1] - 2024-04-18 ### Fixed - Usage of Python objects without the GIL held. ## [1.139.0] - 2024-03-18 ### Fixed - Added bypass for errors that only affect the docs build ## [1.138.1] - 2024-02-26 ### Changed - OnConnectionTypeResolved tests now test for dynamic attribute removal ## [1.138.0] - 2024-01-31 ### Added - og.Graph.CURRENT_FILE_FORMAT_VERSION constant - og.FileFormatVersion >= and <= operators ## [1.137.0] - 2024-01-26 ### Fixed - Handling of node types that were unloaded when gathering extension information ## [1.136.1] - 2024-01-22 ### Changed - OM-115843 Removed unnecessary clear during bundle copy. ## [1.136.0] - 2024-01-18 ### Added - og.ObjectLookup.compound_graph and og.ObjectLookup.compound_node ## [1.135.1] - 2024-01-15 ### Added - (内容省略，因原文中此部分未完整给出) ## [1.135.0] - 2024-01-15 ### Fixed - Restore timecode to be automatically converted to double. ## [1.134.8] - 2024-01-11 ### Changed - OM-115855 Improve code coverage for bundles, complete line coverage ## [1.134.7] - 2024-01-10 ### Changed - OM-115855 Improve code coverage for bundles, exclude unsupported code and add unit tests ## [1.134.6] - 2023-12-29 ### Changed - Added additional test coverage ### Fixed - generate_ogn no longer accesses invalid constants ## [1.134.5] - 2023-12-28 ### Changed - Fix setup cases in test code from previous test ## [1.134.4] - 2023-12-27 ### Changed - Added argument to test utils to reset the stage only when necessary ## [1.134.3] - 2023-12-20 ### Changed - Added additional test coverage ## [1.134.2] - 2023-12-16 ### Changed - Avoid exception and string conversion in extract_attribute_type_information for performance. ## [1.134.1] - 2023-12-15 ### Changed - Controller: Skip evaluating the pre and post render graphs and raise error when invoked explicitly. - Controller: Raise error when evaluating a graph that does not exist. ## [1.134.0] - 2023-12-11 ### Added - Binding for setting custom fabric backing on target mapped attribute ## [1.133.2] - 2023-12-08 ### Fixed - og.Attribute.resolve_partially_coupled_attribute allows ‘None’ list arguments ## [1.133.1] - 2023-12-07 ### Fixed - Fixed OmniGraph upgrade code not triggering when Fabric Scene Delegate is enabled ## [1.133.0] - 2023-11-29 ### Changed - Deprecated binding of deprecated core ABIs ## [1.132.0] - 2023-11-28 ### Added - Implementation of the INodeType function definedAtRuntime ## [1.131.0] - 2023-11-23 ### Added - Extra terminology links for documentation ## Fixed - init_instance in python was not called ## [1.130.1] - 2023-11-17 ### Fixed - Fixed exception when the extension is destroyed before the background node registration task completes. ## [1.130.0] - 2023-11-17 ### Added - Callbacks to the python node interface to init/release a graph instance ## [1.129.0] - 2023-11-09 ### Changed - Made documentation references to AutoNode consistent through use of a substitution ### Removed - Warning about requiring a setting to use AutoNode ## [1.128.1] - 2023-11-03 ### Added - Added the flag `--/exts/omni.graph/syncNodeRegistration` to toggle the deferred node registration off globally. - Added extension config `package.python.node_registration_mode` to toggle synchronous node registration per extension. ## [1.128.0] - 2023-10-27 ### Added - Support and tests for all array types and the remaining special types for AutoNode - Support and tests for the AutoNode decorator arguments - Documentation on some of the pieces missing from the first implementation of AutoNode ## [1.127.0] - 2023-10-25 ### Added - Support and tests for all tuple types and the remaining special types for AutoNode - Documentation on some of the pieces missing from the first implementation of AutoNode ## [1.126.1] - 2023-10-24 ### Changed - Added workaround in ExpectedError to handle cases where the carb output is an expected error or warning ## [1.126.0] - 2023-10-23 ### Added - Runtime node type definition registration handling ### Changed - Implementation of AutoNode to use the new runtime node type definition ### Fixed - Miscellaneous features of runtime node type definition ## [1.125.2] - 2023-10-22 ### Changed - Rearrangement of docs for AutoNode ## [1.125.1] - 2023-10-20 ### Changed - Use latest compound node type schema ## [1.125.0] - 2023-10-18 ### Added - Bindings for views, attribute mapping and vectorized count ## [1.124.0] - 2023-10-17 ### Added ## Implementation and testing for method override addition in runtime node type definitions ## [1.123.0] - 2023-10-13 ### Added - Implementation and testing for metadata addition in runtime node type definitions - Implementation and testing for attribute addition in runtime node type definitions ## [1.122.0] - 2023-10-13 ### Changed - Moved attribute structure information into the unstable namespace ### Removed - Duplicate registration of Python node types in test_raw_extension_creation ### Added - Safety checks for nodes with unregistered node types - Exception raised when attempting to register the same node type name twice - Callback to the register to deregister a node type when the subnode type is deregistered - Basic implementation of runtime node type definition helper function and support ## [1.121.1] - 2023-10-11 ### Added - Support for some basic types in a method compatible with Warp definitions and tests for them - Test arguments that enable the AutoNode tests - Support for categories as an argument type for create_node_type definitions - Addition of input and output execution pins to the structure definition when specified - Support for conversion between runtime type representations of attribute data types - Import module omni.graph.core.types exclusively holding type information ### Fixed - A few typos ### Changed - Separated the runtime and build time autonode tests ## [1.121.0] - 2023-10-10 ### Changed - Reworked a test to make it easier to filter out expected errors ### Removed - Filtering of unreliable tests that have been succeeding recently ## [1.120.0] - 2023-10-06 ### Changed - Moved commands down into their own submodule - Moved typing to type_aliases, a more suitable location ## [1.119.0] - 2023-10-02 ### Fixed - Changed compound commands to use latest OmniGraph USD compound schema ## [1.118.0] - 2023-09-29 ### Added - Addition of runtime definitions to the FunctionRegistry - Generation of node type populator from an AutoNode decorated function ## [1.117.0] - 2023-09-28 - Modify error checking in python bindings. Exceptions are raised instead of returning invalid objects in many functions. ## [1.116.0] - 2023-09-21 ### Added - Support for runtime configuration of AutoNode decorators - Tests of AutoNode function registration and developer mode implementation of node type ## Changed - Forced all exceptions from the controller to be og.OmniGraphError ## [1.114.0] - 2023-09-18 ### Added - Handling for runtime set and get of the PtrToPtrKind value ## [1.113.0] - 2023-09-13 ### Added - Framework for AutoNode runtime type definition - Setting to disable AutoNode functionality by default ### Changed - AutoNode test definition to match new naming and import locations ### Fixed - Added missing extension disable calls for tests - Made extensions enable immediately for tests ## [1.112.1] - 2023-09-06 ### Changed - Call the OGN release() callback when an extension with a python node is unloaded ## [1.112.0] - 2023-08-31 ### Added - Bindings for supported version of the node type forwarding interface - Inspection capabilities for the node type forwarding interface - Test dependency on omni.inspect for access to the inspection - Tests for cycle detection of node type forwarding and reverse numerical addition ## [1.111.4] - 2023-08-16 ### Added - Support for accessing the default inspection of node types in the Python subnode types ## [1.111.3] - 2023-08-08 ### Removed - References to migrated extensions ## [1.111.2] - 2023-08-07 ### Fixed - Promoting bundle outputs no longer generates prefix errors ## [1.111.1] - 2023-08-01 ### Fixed - Compounds no longer error when creating and connecting bundle outputs ## [1.111.0] - 2023-07-31 ### Changed - Migrated the type annotation definitions used by AutoNode up to a proper typing module that can be introspected ## [1.110.0] - 2023-07-28 ### Added - Build of node type documentation extension, including build links to all extensions in the index ## [1.109.1] - 2023-07-26 ### Changed - Modified test utility methods for processing external files in .ogn “tests” constructs. ## [1.109.0] - 2023-07-25 ### Changed - Revert output and state bundle name space separator to underscore ## [1.108.0] - 2023-07-21 ## Removed - References to removed omni.graph.examples.python ## [1.107.4] - 2023-07-19 ### Changed - Replaced Usd.Stage traversals with usdrt queries to speed up the stage attach phase. ## [1.107.3] - 2023-07-17 ### Fixed - Enabled bundle output on compounds ## [1.107.2] - 2023-07-14 ### Removed - References to migrated tutorials node types ## [1.107.0] - 2023-07-13 ### Changed - OM-97363: Resolve input-output bundle asymmetry ## [1.106.1] - 2023-07-13 ### Removed - Removed the “defaultEvaluator” and “useCachedConnectionsForFileLoad” OG settings. ## [1.106.0] - 2023-07-11 ### Added - RenameCompoundSubgraph command ## [1.105.0] - 2023-07-05 ### Added - command to promote unconnected inputs/outputs to compound subgraph ## [1.104.1] - 2023-07-03 ### Fixed - OgnOnVariableChange with array based variables ## [1.104.0] - 2023-06-28 ### Added - New bindings for functionality described by ISchedulingHints2. ## [1.103.3] - 2023-06-28 ### Changed - traverse_downstream_graph, traverse_upstream_graph accept compound graph prims as inputs - og.ObjectLookup.prims and og.Controller.prim_path accept og.Graph objects - og.ObjectLookup.graph accepts Usd.Prim and Usd.Typed ## [1.103.2] - 2023-06-27 ### Fixed - Fixed some documentation examples ## [1.103.1] - 2023-06-22 ### Added - Bindings for new “pure” scheduling hint. ## [1.103.0] - 2023-06-20 ### Added - Bindings Change Tracking for bundles ## [1.102.0] - 2023-06-12 ### Added - og.ObjectLookup.usd_relationship and og.ObjectLookup.usd_property ### Fixed - og.ObjectLookup.attribute gives the same result with equivalent str and Sdf.Path inputs ## [1.101.3] - 2023-06-08 ### Changed - Compound nodes correctly manage fan-in, including execution ports ## [1.101.2] - 2023-06-08 ### Added - Unit test to check if bundle can carry target attribute type ## [1.101.1] - 2023-06-05 ### Fixed - Fixed crash in ReplaceWithCompoundSubgraph when called from compound graph ## [1.101.0] - 2023-06-01 ### Added - Graph.get_owning_compound_node() API ## [1.100.0] - 2023-05-29 ### Changed - Moved cache generation tests to be disabled in the .toml file instead of by decorator - Moved some calls to actual deprecation even though they are not functioning since others are at least calling them ### Removed - Dependencies not required for OmniGraph operation (omni.kit.async_engine:stage_templates:pip_archive) - Hard deprecated functions ## [1.99.0] - 2023-05-26 ### Added - CREATE_ATTRIBUTES capabilities in the controller.edit() function ## [1.98.1] - 2023-05-26 ### Added - Added command to rename compound subgraph ports ## [1.98.0] - 2023-05-25 ### Added - Support for promoting bundle inputs - Validation methods for subgraph compounds ### Changed - Output bundles excluded from compound promotion. ## [1.97.3] - 2023-05-24 ### Changed - Modified some comments that were referring to now-deprecated OG settings. ## [1.97.2] - 2023-05-24 ### Removed - Removed references to “pull” and “execution_pull” evaluators. - Removed test scene that was being explicitly used to test the “pull” evaluator. ## [1.97.1] - 2023-05-24 ### Changed - Default name for compounds is lower case, same as other omni graph nodes ## [1.97.0] - 2023-05-23 ### Removed - Removed OG settings that were referencing now-removed constructs (dynamic scheduler and realm static scheduler). - Removed TestDynamicScheduling.usda because OG dynamic scheduler no longer exists. ## [1.96.1] - 2023-05-17 ### Fixed - Fixed mismatched allocations on default type data ## [1.96.0] - 2023-05-16 ### Added - og.Controller.keys.CREATE_NODES now also takes a dictionary of commands to define a compound subgraph - og.Controller.keys.PROMOTE_ATTRIBUTES added to define exposed compound node attributes ## [1.95.2] - 2023-05-12 ### Changed - Refactored extension search to prevent syncing the registry if it was already there ## [1.95.1] - 2023-05-10 ### Changed - Handle compound nodes when validating node’s owner graph ## [1.95.0] - 2023-05-09 ### Changed - Made MetadataKeys deprecation message more explicit ## [1.94.0] - 2023-05-08 ### Added - og.Controller.keys.CREATE_VARIABLE tuples take an optional 3rd entry representing the default value ## [1.93.0] - 2023-05-08 ### Deprecated - Removed deprecated locations of Python modules ## [1.92.0] - 2023-05-04 ### Added - Compounds subgraphs attribute commands added to _unstable module ## [1.91.0] - 2023-05-04 ### Added - Migration support for omniGraphSchema.CompoundNodeAPI ## [1.90.0] - 2023-05-03 ### Changed - CreateCompoundNodeType now takes evaluator_type - Added Py_Node.get_compound_graph_instance ## [1.89.0] - 2023-05-02 ### Added - Bindings for the new INodeTypeForwarding interface - Added a generic validator for Python interface bindings - Refactored some binding definitions to live in their own files ## [1.88.1] - 2023-05-01 ### Added - Setting to control auto-instancing ## [1.88.0] - 2023-04-28 ### Added - CreateCompoundSubgraph and ReplaceWithCompoundSubgraph ## [1.87.1] - 2023-04-24 ### Fixed - Don’t allow other text streams to interleave with an expected error. ## [1.87.0] - 2023-04-24 ### Deprecated - Replaced all documentation for GraphContext.get_attribute_as_XX and GraphContext.set_XX with deprecation notices - Added runtime deprecation notices to GraphContext.get_attribute_as_XX and GraphContext.set_XX calls ### Added - Migration support for omniGraphSchema.CompoundNodeAPI ## [1.86.0] - 2023-04-19 ### Changed - Py_AttributeData: review access data permission ## [1.85.0] - 2023-04-19 ### Deprecated - Removed all references to the obsolete settings constants ## [1.84.0] - 2023-04-19 ### Deprecated - Removed context_helper parameter from og.Database.init - Removed context_helper parameter from og.DynamicAttributeInterface.set/get - Removed og.ContextHelper and og.OmniGraphHelper - Removed types supporting og.OmniGraphHelper - BundledAttribute_t, ConnectData_t, ConnectDatas_t, CreateNodeData_t, CreateNodeDatas_t, CreatePrimData_t, CreatePrimDatas_t, DeleteNodeData_t, DeleteNodeDatas_t, DisconnectData_t, DisconnectDatas_t, OmniGraphHelper, SetValueData_t, SetValueDatas_t ## [1.83.0] - 2023-04-18 ### Removed - References to deprecated torch/tensor support ## [1.82.3] - 2023-04-16 ### Removed - Removed dynamic test generation for legacy backend ## [1.82.2] - 2023-04-13 ### Fixed - Typo in a Python reference from og.LOG to ogi.LOG ## [1.82.1] - 2023-04-12 ### Changed - Setting target type values now support scalar and string values ## [1.82.0] - 2023-04-05 ### Changed - attribute_value_as_usd supports relationships - Relationships can be set through controller.edit ### Added - og.GraphContext.get_graph_target now takes optional instance index ## [1.81.0] - 2023-04-03 ### Added - og.INSTANCING_GRAPH_TARGET_PATH - Bindings for missing functions in IAttribute ABI - Testing support for validating ABI definitions ### Changed - Moved binding definitions for omni.graph.core.Attribute into its own file ## [1.80.0] - 2023-03-31 ### Changed - target attributes now use relationships with output and state ports ## [1.79.0] - 2023-03-29 ### Deprecated - omni.graph.core.Database.ROLE_XX constants, in favor of omni.graph.core.AttributeRole enum values ## [1.78.1] - 2023-03-27 ### Changed - target python wrapping changed from string to usdrt Sdf.Path ## [1.78.0] - 2023-03-24 ### Changed - target attributes now use relationships with output and state ports ## Added - IVariable.set_type python method for changing a variable type - ChangeVariableTypeCommand - GraphEvent.VARIABLE_TYPE_CHANGE event when a variable type is changed ## [1.77.2] - 2023-03-24 ### Fixed - Fixed documentation errors ## [1.77.1] - 2023-03-22 ### Fixed - Made all docstrings to publicly visible documentation consistent ## [1.77.0] - 2023-03-17 ### Added - Implementing target attribute python wrapping ## [1.76.1] - 2023-03-17 ### Fixed - Lint errors ## [1.76.0] - 2023-03-07 ### Added - Added functions to traverse the graph and visit upstream and downstream nodes ## [1.75.0] - 2023-03-05 ### Added - AttributeTemplate.get_default_data accessor ## [1.74.2] - 2023-03-01 ### Fixed - OM-84762 IBundleFactory get_bundle conversion methods bugfix. ## [1.74.1] - 2023-03-01 ### Fixed - warning about deprecated function call ## [1.74.0] - 2023-02-28 ### Added - ComputeGraph::flushUsd call to apply pending usd changes. ## [1.73.1] - 2023-02-25 ### Changed - Modifed format of Overview to be consistent with the rest of Kit - Fixed link to Python autodocs ## [1.73.0] - 2023-02-24 ### Added - ResolveAttrTypeCommand ## [1.72.4] - 2023-02-23 ### Added - Two new utility methods for evaluating code once at the start/end of threaded unit tests in ThreadsafetyTestUtils. ## [1.72.3] - 2023-02-22 ### Changed - Renamed omni.kit.exec references to omni.kit.exec.core ## [1.72.2] - 2023-02-21 ### Added - ThreadsafetyTestUtils class that helps simplify the writing of thread-safety tests for OG nodes. ## [1.72.1] - 2023-02-19 ### Changed ## [1.72.0] - 2023-02-16 ### Changed - Unification of Py_Bundle and IConstBundle/IBundle ## [1.71.1] - 2023-02-15 ### Fixed - Made test file pattern account for node files not beginning with Ogn ## [1.71.0] - 2023-02-15 ### Changed - Switched the default execution backend for generated tests. Execution Framework in enabled by default ## [1.70.1] - 2023-02-09 ### Fixed - Reverted unintential change to test case creation ## [1.70.0] - 2023-02-08 ### Added - AttributeTemplate API calls ## [1.69.0] - 2023-02-07 ### Added - Split support for test configurations without forcing specific base class ## [1.68.0] - 2023-02-06 ### Added - omni.graph.core._unstable module - AttributeTemplate CompoundNodeType python bindings - CreateCompoundNodeType, CreateCompoundNodeTypeInput, CreateCompoundNodeTypeOutput, RemoveCompoundNodeTypeInput, RemoveCompoundNodeTypeOutput commands ### Removed - CreateNodeType, CreateTypeInput, CreateNodeTypeOutput, RemoveNodeTypeInput, RemoveNodeTypeOutput ## [1.67.4] - 2023-02-02 ### Fixed - Lint error that appeared when pylint updated ## [1.67.3] - 2023-01-30 ### Changed - Removed the kit-sdk landing page - Moved all of the documentation into the new omni.graph.docs extension ## [1.67.2] - 2023-01-30 ### Changed - Refactored OG test generation to not assume execution backend ## [1.67.1] - 2023-01-20 ### Fixed - GIL locking safety in bindings call out to python - GIL is released before Graph eval via python ## [1.67.0] - 2023-01-11 ### Changed - Made dynamic attribute failures raise exceptions - Made return values of dynamic attribute commands more consistent - Made the node controller failures in dynamic attribute operations raise exceptions ## [1.66.0] - 2023-01-11 ### Removed - Gather prototype is gone ### Changed - (No specific changes listed under "Changed") ## [1.65.3] - 2023-01-03 ### Changed - Bundle attributes are now all typed as eRelationship (no ePrim anymore) ## [1.65.2] - 2022-12-21 ### Changed - Added [native] to make package separate for each platform & build config ## [1.65.1] - 2022-12-16 ### Changed - Refactored CUDA build to consolidate build functions and remove unnecessary rebuilds ## [1.65.0] - 2022-12-14 ### Fixed - Updated inspection to handle Python node redirection ## [1.64.0] - 2022-12-14 ### Added - CreateNodeTypeInput and CreateNodeTypeOutput support empty references and specifying the supported ogn type(s) ## [1.63.0] - 2022-12-13 ### Changed - Filtered out test_data_access tests from EF generation. These tests have issue with per-node data when run twice, but they don’t provide any value for compute correctness since they only read a file and use python data base. ## [1.62.1] - 2022-12-12 ### Added - og.AttributeType.get_unions() method to access the attribute union definitions. ## [1.62.0] - 2022-12-08 ### Added - Fixed occasional crash in grouped undos/redos. ## [1.61.0] - 2022-12-02 ### Fixed - Settings.tempoary context manager now removes any settings that it adds. ### Changed - Settings.temporary context manager now accepts a list of settings. ## [1.60.0] - 2022-11-24 ### Changed - Modified Python node type registration process to handle multiple versions on-demand ## [1.59.0] - 2022-11-22 ### Removed - Setting useSchemaPrims - Test variations that allow modifying the deleted setting ### Changed - Turned use of the deleted setting into errors ## [1.58.1] - 2022-11-21 ### Added - ObjectLookup.variable now supports Sdf.Path and str objects ### Fixed - Errors and crashes from OmniGraph commands when grouping or applying successive undo and redo calls ## [1.58.0] - 2022-11-17 ### Added - Documentation for running a minimal Kit with OmniGraph - Settings updateToUSD, supportForceWriteback, useLegacySimulationPipeline, and enableUSDInPreRender - Test variations that allow modifying the deleted setting ## Changed - Turned use of the deleted settings into errors ## [1.57.0] - 2022-11-14 ### Changed - Default simple dynamic attribute values to the CPU ## [1.56.0] - 2022-11-12 ### Removed - Support for the deleted implicit global graph setting - Test variations that allow modifying the implicit global graph setting ### Changed - Turned use of the implicit global graph setting into errors ## [1.55.1] - 2022-11-10 ### Changed - removed dependency on omni.kit.test ## [1.55.0] - 2022-11-10 ### Added - Support for redirecting dynamic attributes to the GPU ## [1.54.0] - 2022-10-31 ### Changed - change bindings to reflect new Fabric naming conventions. - change all types to reflect new namespace, should remain abi compatible ## [1.53.0] - 2022-10-23 ### Added - og.get_kit_version() ## [1.52.0] - 2022-10-20 ### Added - NodeType.is_compound_node_type() - GraphRegistryEvent.NODE_TYPE_NAMESPACED_CHANGED, GraphRegistryEvent.NODE_TYPE_CATEGORY_CHANGED ## [1.51.2] - 2022-10-19 ### Fixed - Corrected the path to the default category files ## [1.51.1] - 2022-10-14 ### Changed - test generation for EF will filter tests that target deprecated implicit graph ## [1.51.0] - 2022-10-03 ### Added - instance_path argument added to IVariable.get, get_array and set methods to specify the instance of the variable ## [1.50.0] - 2022-09-30 ### Added - node_type.get_path(), which returns the path to the prim associated with a node type ## [1.49.0] - 2022-09-28 ### Added - Collection of registration and deregistration timing for Python node types ## [1.48.1] - 2022-09-27 ### Fixed - Py_AttributeData set value for attribute with ePath role ## [1.48.0] - 2022-09-21 ## Added - Og.Node.is_compound_node - Og.Graph.is_compound_graph - CreateNodeType, CreateNodeTypeInput, RemoveNodeTypeInput, CreateNodeTypeOutput, RemoveNodeTypeOutput, ReplaceWithCompound commands ## [1.47.0] - 2022-09-20 ### Added - Ability to control prim and node creation behavior with allow_exists ## [1.46.1] - 2022-09-19 ### Fixed - Lookup of output bundles by path ## [1.46.0] - 2022-09-14 ### Changed - Refactored controller classes to accept variable arguments in all methods and constructor ### Removed - References to obsolete set of unsupported types - Last remaining references to the obsolete ContextHelper ### Added - Argument flattening utility ## [1.45.2] - 2022-09-07 ### Added - Python node type registration deallocates attribute defaults after registration. ## [1.45.1] - 2022-09-01 ### Fixed - Fixed the type name access in the node controller to handle bundles properly ## [1.45.0] - 2022-08-30 ### Added - Handling for allocation of memory and transfer of values for Python default values ## [1.44.0] - 2022-08-23 ### Added - GraphRegistry.get_event_stream to get an event stream that triggers when node types are added and removed. ## [1.43.0] - 2022-08-19 ### Added - Access to new setting that turns deprecations into errors ## [1.42.0] - 2022-08-12 ### Changed - og.AttributeData now raise exceptions for errors instead of printing ## [1.41.1] - 2022-08-09 ### Fixed - All of the lint errors reported on the Python files in this extension ## [1.41.0] - 2022-08-02 ### Added - Optimize attribute setting from python nodes - during runtime computation we skip commands (no need for undo) ## [1.40.0] - 2022-07-27 ### Added - IBundle2 remove_attributes_by_name, remove_child_bundles_by_name ## [1.39.0] - 2022-07-27 ### Changed - Added better repr to Attribute and Node ## [1.38.1] - 2022-07-26 ### Fixed - Adjusted config to avoid obsolete commands module - Added firewall protection to AutoFunc and AutoClass initialization so that they work in the script editor ## [1.38.0] - 2022-07-19 ### Added - IBundle2 interface API review ## [1.37.0] - 2022-07-12 ### Added - Python performance: database caching, prefetch and commit for batching of simple attribute reads/writes ## [1.36.0] - 2022-07-12 ### Fixed - Backward compatibility of the generated attribute descriptions. ## [1.35.0] - 2022-07-08 ### Added - omni.graph.core.Attribute.is_deprecated() - omni.graph.core.Attribute.deprecation_message() - omni.graph.core.Internal sub-module - omni.graph.core.Internal._deprecateAttribute() ## [1.34.0] - 2022-07-07 ### Changed - Refactored imports from omni.graph.tools to get the new locations - Moved node_generator/ into the _impl/ subdirectory - Made dunder attribute names in AttributeDataValueHelper into single-underscore to avoid Python compatibility problem ### Added - Test for public API consistency ## [1.33.0] - 2022-07-06 ### Added - Metadata support for IBundle2 interface ## [1.32.3] - 2022-07-04 ### Fixed - Py_GraphContext’s eq and hash now use the underlying GraphContext object rather than the Python wrapper ## [1.32.2] - 2022-06-28 ### Changed - Made node type failure a more actionable error - Bootstrap the nodeContextHandle to allow independent database creation ### Added - Linked docs in the build area ## [1.32.1] - 2022-06-26 ### Changed - Made node type failure a more actionable error ## [1.32.0] - 2022-06-26 ### Added - Added test for clearing bundle contents ## [1.31.1] - 2022-06-21 ### Changed - Fixed error in graph_settings when loading non-schema prims ## [1.31.0] - 2022-06-17 ## Added - omni.graph.core.graph.get_evaluator_name() ## [1.30.1] - 2022-06-17 ### Added - Added ApplyOmniGraph and RemoveOmniGraph api commands ## [1.30.0] - 2022-06-13 ### Added - omni.graph.core.GraphEvaluationMode enum - evaluation_mode argument added to omni.graph.core.Graph.create_graph_as_node - evaluation_mode property added to omni.graph.core.Graph - SetEvaluationModeCommand - evaluation_mode parameter added to CreateGraphAsNodeCommand - evaluation_mode option added to GraphController ## [1.29.0] - 2022-06-13 ### Added - Temporary binding function to prevent Python node initialization from overwriting values already set ## [1.28.0] - 2022-06-07 ### Added - Added CPU-GPU pointer support in data_view class and propagation of the state through python wrapper classes ## [1.27.0] - 2022-06-07 ### Added - Support for the generator settings to complement runtime settings ## [1.26.1] - 2022-06-04 ### Fixed - Nodes with invalid connections no longer break upgrades to OmniGraph schema ## [1.26.0] - 2022-05-06 ### Fixed - Handling of runtime attributes whose bundle uses CPU to GPU pointers ### Added - Support for CPU to GPU data in the DataWrapper ## [1.25.0] - 2022-05-05 ### Removed - Python subscriptions to changes in settings, now handled in C++ ## [1.24.1] - 2022-05-05 ### Deprecated - Deprecated OmniGraphHelper and ContextHelper for og.Controller ## [1.24.0] - 2022-04-29 ### Fixed - Fixed override method for IPythonNode type ### Removed - Obsolete example files ### Added - Explicit settings handler ### Changed - Used explicit OmniGraph test handler base classes ## [1.24.0] - 2022-04-27 ### Added - GraphController.set_variable_default_value - GraphController.get_variable_default_value - ObjectLookup.variable ## [1.23.0] - 2022-04-25 ### Added - Added a test to confirm that all version references in omni.graph.* match ## [1.22.2] - 2022-04-20 ### Fixed - Undoing the deletion of a connection’s src prim will now restore the connection on undo. ## [1.22.1] - 2022-04-18 ### Changed - og.Attribute will now raise an exception when methods are called when in an invalid state. ## [1.22.0] - 2022-04-11 ### Fixed - Moved Py_Node and Py_Graph callback lists to static storage where they won’t be destroyed prematurely. - Callback objects now get destroyed when the extension is unloaded. ## [1.21.1] - 2022-04-05 ### Fixed - Added hash check to avoid overwriting ogn/tests/init.py when it hasn’t changed - Fix deprecated generator of ogn/tests/init.py to generate a safer, non-changing version ## [1.21.0] - 2022-03-31 ### Added - IConstBundle2, IBundle2 and IBundleFactory interface python bindings. - Unit tests for bundle interfaces ## [1.20.1] - 2022-03-24 ### Fixed - Fixed location of live-generation of USD files from .ogn - Fixed contents of the generated tests/init.py file ## [1.20.0] - 2022-03-23 ### Added - GraphEvent.CREATE_VARIABLE and GraphEvent.REMOVE_VARIABLE event types - Graph.get_event_stream() ## [1.19.0] - 2022-03-18 ### Added - Added command to set variable tooltip ## [1.18.0] - 2022-03-16 ### Added - support for enableLegacyPrimConnection setting to test utils ## [1.17.1] - 2022-03-14 ### Fixed - Corrected creation of implicit graphs that were not at the root path - Added tests for such graphs and a graph in a layer ## [1.17.0] - 2022-03-11 ### Added - Node.get_backing_bucket_id() - GraphContext.write_bucket_to_backing() ## [1.16.0] - 2022-03-01 ### Added - expected_error.ExpectedError (moved from omni.graph.test) ### Changed - Updated OmniGraphTestCase and derived classes to use test_case_class ## [1.15.0] - 2022-02-16 ### Added - Added commands to create and remove variables ## [1.14.0] - 2022-02-11 ### Added - Attribute.register_value_changed_callback - Database.get_variable - Database.set_variable - Controller.keys.CREATE_VARIABLES - GraphController.create_variable ## [1.13.0] - 2022-02-10 ### Added - Added support for migration of old graphs to use schema prims ## [1.12.2] - 2022-02-07 ### Changed - Moved carb logging out of database.py and into Node::logComputeMessage. - Fall back to old localized logging for Python nodes which don’t yet support the compute message logging ABI. ## [1.12.1] - 2022-02-04 ### Fixed - Compute counts weren’t working for Python nodes - Compute messages from Python nodes weren’t visible in the graph editors ## [1.12.0] - 2022-01-28 ### Added - Support for WritePrim creation in GraphController.expose_prims ## [1.11.0] - 2022-01-29 ### Changed - Reflecting change of omni.graph.core from 2.11 -> 2.12 ## [1.10.0] - 2022-01-27 ### Added - ObjectLookup.usd_attribute ## [1.9.0] - 2022-01-21 ### Added - Node.log_compute_message - Node.get_compute_messages - Node.clear_old_compute_messages - Graph.register_error_status_change_callback - Graph.deregister_error_status_change_callback - Severity enum ## [1.8.0] - 2021-12-17 ### Added - NodeType.get_all_categories_ - get_node_categories_interface - Created binding class NodeCategories ## [1.7.0] - 2021-12-15 ### Added ## [1.6.0] - 2021-12-06 ### Added - Added `og.NodeEvent.ATTRIBUTE_TYPE_RESOLVE` ## [1.5.2] - 2021-12-03 ### Added - Node, Attribute, AttributeData, Graph, and Type objects are now hashable in Python, meaning that they can be used in sets, as keys in dicts, etc. ### Fixed - Comparing Node and Graph objects for equality in Python now compare the actual objects referenced rather than the wrappers which hold the references - Comparing Attribute and AttributeData objects to None in Python no longer generates an exception. ## [1.5.0] - 2021-12-01 - Added functions to get extension versions for core and tools - Added cascading Python node registration process, that auto-generates when out of date - Added user cache location for live regeneration of nodes ## [1.4.0] - 2021-11-26 ### Added - Python Api `Graph.get_parent_graph` ### Fixed - Fix failure when disconnecting a connection from a subgraph node to the parent graph node ## [1.3.2] - 2021-11-24 ### Changed - Generated python nodes will emit info instead of warning when inputs are unresolved ## [1.3.1] - 2021-11-22 ### Changed - Improved error messages from wrapped functions ## [1.3.0] - 2021-11-19 ### Added - `bool` operators added to all returned OG Objects. So `if node:` is equivalent to `if node.is_valid():` ### Changed - Bug fix in Graph getter methods ## [1.2.0] - 2021-11-10 ### Added - `og.get_node_by_path` - `get_graph_by_path`, `get_node_by_path` now return None on failure ## [1.1.0] - 2021-10-17 ### Added - `og.get_graph_by_path` ## [1.0.0] - 2021-10-17 ### Initial Version - Started changelog with current version of omni.graph --- title: "Example Document" author: "John Doe" date: "2023-01-01" --- # Introduction This is an example document to demonstrate the conversion from HTML to Markdown. ## Section 1 Lorem ipsum dolor sit amet, consectetur adipiscing elit. ## Section 2 Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. ### Subsection 2.1 Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. ### Subsection 2.2 Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. ## Section 3 Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. --- This is the end of the document.
changelog-omni-index-compute_CHANGELOG.md	# Changelog ## [0.4.3] - 2023-11-17 ### Changed - Changed deprecated functions to their new version ## [0.4.2] - 2023-06-27 ### Fixed - Refactored OmniGraph documentation to point to locally generated files ## [0.4.1] - 2023-05-31 ### Fixed - Adjusted the CRLF settings for the generated .md node table of content files ## [0.4.0] - 2023-05-29 ### Added - Regenerated node table of contents ## [0.3.7] - 2023-04-11 ### Added - Table of documentation links for nodes in the extension ## [0.3.6] - 2023-02-25 ### Changed - Modifed format of Overview to be consistent with the rest of Kit ## [0.3.5] - 2023-02-19 ### Changed - Added label to the main doc page so that higher level docs can reference the extension - Added link to the IndeX online docs ## [0.3.4] - 2023-02-17 ### Added - “threadsafe” scheduling hint to OgnTimestepSelector node. ## [0.3.3] - 2023-01-30 ### Changed ## [0.3.2] - 2022-12-21 ### Changed - Refactored CUDA build to consolidate build functions and remove unnecessary rebuilds ## [0.3.1] - 2022-08-09 ### Fixed - Applied formatting to all of the Python files ## [0.3.0] - 2022-07-07 ### Added - Test for public API consistency
changelog-omni-services-task-omnigraph_CHANGELOG.md	# Changelog All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ## [0.2.0] - 2023-09-26 ### Changed - Replaced legacy live session logic with omni.kit.usd.layers API ## [0.1.0] - 2023-07-05 ### Added - Added initial version of the Extension.
changelog-omni-sim-haircomposer_CHANGELOG.md	# Changelog All notable changes to this project will be documented in this file. ## [1.3.1] - 2023-08-15 ### Hotfix ## [1.3.0] - 2023-08-10 ### Chat to groom ## [1.2.0] - 2023-08-01 ### Improvements and hotfixes ## [1.1.0] - 2023-07-01 ### Text to groom ## [1.0.3] - 2023-06-05 ### Hotfix ## [1.0.2] - 2023-05-01 ### Additional package updates ## [1.0.1] - 2023-05-01 ### Package updates ## [1.0.0] - 2023-03-01 ### Initial release
changelog-omni-syntheticdata_CHANGELOG.md	# Changelog This document records all notable changes to the omni.syntheticdata extension. The format is based on [Keep a Changelog](https://keepachangelog.com). The project adheres to [Semantic Versioning](https://semver.org). ## [0.6.8] - 2024-03-27 ### Fixed - Removed assumption that OmniGraph always runs on GPU 0. ## [0.6.7] - 2024-02-23 ### Added - Added test to ensure the SDG graphs continue to work when USD loading is disabled globally in OmniGraph ## [0.6.6] - 2024-01-11 ### Fix - Visualizer window update callback. - Instance mapping number of semantics update. ## [0.6.5] - 2024-01-10 ### Fix - OgnSdPostRenderVarTextureToBuffer graphic copy fallback. ## [0.6.4] - 2024-01-09 ### Added - Unit test to verify that SyntheticData-generated OmniGraphs respond to USD authoring changes. ### Changed - All SyntheticData-related OmniGraphs (e.g., post-process graphs, pre- and post-render graphs, etc.) are treated as “global graphs” so that USD change processing can be performed successfully by the OmniGraph core. ## [0.6.3] - 2023-12-05 ### Changed - Change DistanceToCamera values for pinhole cameras to not be dependent on near clipping range ## [0.6.2] - 2023-11-17 ### Changed - Changed deprecated functions to their new version ## [0.6.1] - 2023-09-20 ### Removed ## [0.6.0] - 2023-09-18 ### Added - Unnecessary evaluate call in test which causes irrelevant error message ## [0.5.2] - 2023-09-07 ### Fixed - Deprecated python function bindings ## [0.5.1] - 2023-09-05 ### Fixed - Automatic deactivation of intergraph connected nodes ## [0.5.0] - 2023-08-19 ### Removed - Tests that rely on omni.graph.action_nodes - moved to the OmniGraph repo - Dependency on the downstream extension omni.graph.ui ## [0.4.14] - 2023-08-14 ### Added - Post-render nodes for dispatching renderVar IO works. ## [0.4.13] - 2023-08-11 ### Fixed - Replace inter-graph node connections by internal node attributes of downstream node_handle dependency list ### Added - Setting to disable the backing of the graphs by USD ## [0.4.12] - 2023-08-08 ### Added - Custom Semantic filter node (SdSemanticLabelsMap) ## [0.4.11] - 2023-08-02 ### Fixed - 3D bounding boxes realtime preview regression ## [0.4.10] - 2023-07-30 ### Added - Added dependency on new extension containing GPU interop nodes ## [0.4.9] - 2023-07-12 ### Added - Instance-mapping Fabric update timestamp. - Texture renderVar buffer stride information. ## [0.4.8] - 2023-07-11 ### Fixed - Realtime preview flickering in asynchronous rendering. ## [0.4.7] - 2023-07-10 ### Added - Default activation of visualization node templates ## [0.4.6] - 2023-07-03 ### Fixed - OgnPostRenderVarToHost node : memory leak when creating texture host renderVar data. - OgnPostInstanceMapping node : memory leak when fetching instance mapping transforms from Fabric. - OgnSdStageInstanceMapping : double Fabric lock when fetching instance mapping transforms from Fabric. ## [0.4.5] - 2023-06-28 ### Fixed - OgnSdPostSemantic3dBoundingBoxCameraProjection: check input semanticWorldTransformSDCudaPtr before launching CUDA task to avoid potential crash. ## Changed - Restored implementation of OgnSdPostSemantic3dBoundingBoxCameraProjection, OgnSdPostSemantic3dBoundingBoxFilter and OgnSdPostSemanticBoundingBox. ## [0.4.4] - 2023-06-27 ### Fixed - Fixed up some documentation errors ### Added - Documentation page for accessing the OmniGraph node definitions ## [0.4.3] - 2023-06-27 ### Changed - Set up the extension to load python nodes and tests in parallel ## [0.4.2] - 2023-06-24 ### Fixed - Crashes due to instance mapping unprotected concurrent read/write. - Missing empty buffer and host renderVars. ### Added - Instance mapping local to world transform interpolation. ### Removed - Omnigraph computeParamsBuilder support ## [0.4.1] - 2023-06-20 ### Fixed - Crash when enabling 3d bounding boxes sensors. ## [0.4.0] - 2023-05-26 ### Changed - Refactored the nodes which schedule CUDA tasks to use a common API. ## [0.3.0] - 2023-05-18 - Deprecate obsolete semantic ID management through renderer (see below) - Deprecate SemanticSegmentationSD sensor from renderer - Remove SemanticIdSegmentation from visualizer - Deprecate omni.syntheticdata functions to retrieve semantic from renderer (get_semantic_segmentation_…) - Deprecate semantic ID filtering through renderer ## [0.2.9] - 2022-12-28 ### Fixed - Clear visualizer selection menu on new stage opened (OM-72422) ## [0.2.8] - 2022-12-21 ### Changed - Refactored CUDA build to consolidate build functions and remove unnecessary rebuilds ## [0.2.7] - 2022-12-14 ### Changed - Re-enabled pipeline tests. ## [0.2.6] - 2022-11-26 ### Changed - Enable TestSemanticSeg tests. ## [0.2.5] - 2022-10-26 ### Changed - Flagged all “cube” tests in TestSemanticSeg as unreliable. ## [0.2.4] - 2022-09-22 ### Changed - Update icon to match Viewport 2.0 style ## [0.2.3] - 2021-08-16 ## Fixed - Call dict.discard instead of non existent dict.remove. ## [0.2.2] - 2021-05-18 ### Changed - Add dependency on omni.kit.viewport.utility ## [0.2.1] - 2022-03-23 ### Changed - Support Legacy and Modern Viewport ## [0.1.8] - 2021-12-10 ### Changed - Deprecated Depth and DepthLinear sensors and added DistanceToImagePlane and DistanceToCamera ### Added - Cross Correspondence Sensor ## [0.1.7] - 2021-10-16 ### Changed - Move synthetic data sensors to AOV outputs that can be specified in USD and used in OmniGraph nodes ## [0.1.6] - 2021-06-18 ### Fixed - Instance Segmentation is now always returned as uint32 - Fixed parsed segmentation mode - Fixed Pinhole projection which incorrectly used the camera’s local transform instead of its world transform ### Added - Linear depth sensor mode ## [0.1.5] - 2021-03-11 ### Added - Motion Vector visualization and helper function ### Changed - BBox3D corners axis order to be Y-Up for consistency with USD API - All parsed data return uniqueId field, along with list of instanceIds - `instanceId` field removed from parsed output to avoid confusion with renderer instanceId - Add `get_instance` function to extension - Improve returned data of `get_occlusion_quadrant` for consistency with other sensors ### Fixed - Fix BBox3D parsed mode when dealing with nested transforms - Fix BBox3D camera_frame mode, previously returned incorrect values - Use seeded random generator for shuffling colours during visualization ## [0.1.4] - 2021-02-10 ### Changed - Moved to internal extension - Minor bug fixes ## [0.1.3] - 2021-02-05 ### Added - Python 3.7 support ### Changed - Bug fixes ## [0.1.2] - 2021-01-28 ### Added - Occlusion Quadrant Sensor - Metadata Sensor ### Changed - Metadata (SemanticSchemas of Type != 'class') added to sensor outputs - UI changed to better suit multi-viewport scenarios - Misc. sensor fixes and improvements ## [0.1.1] - 2021-01-25 - Linux support ## [0.1.0] - 2021-01-18 - Initial version
changelog-omni-volume-nodes_CHANGELOG.md	# Changelog ## Changelog ### Changelog-omni-volume-nodes ### [Unreleased] ### [0.2.0] - 2023-11-16 #### Changed - Minor cosmetic cleanup ### [0.1.0] - 2023-10-23 #### Initial Version - Seeding initial version with refactor from omni.volume
changelog-test-omni-graph-core_CHANGELOG.md	# Changelog ## [1.2.1] - 2024-01-31 ### Added - New unit tests to validate custom interface registration against node types. ## [1.2.0] - 2023-12-01 ### Changed - Moved test node icon location to exercise currently unsupported behaviour ## [1.1.0] - 2023-11-28 ### Added - Tests for INodeType, including the new definedAtRuntime function ## [1.0.0] - 2023-11-08 ### Added - Tests for IGraphRegistry interface as initial example of how to use the extension ## [0.0.0] - 2023-11-07 ### Initial Version
CHANGELOG.md	# Changelog ## [1.0.1] - 2023-04-27 ### Updated - Build against Kit 105.0 ## [1.0.0] - 2022-07-01 ### Added - Initial implementation.
changelog_CHANGELOG.md	# Changelog All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ## [107.0.0] - 2024-03-11 ### Changed - Initial version
changes.md	## Changed - OVCC-1497: `tsc_clock` was moved from the `carb::time` namespace to `carb::clock`, though it is also available from within the `time` namespace for historical consistency. The `time` namespace was conflicting in some cases with the `time()` function. - OM-122864: update freetype to version 2.13.2. - OVCC-1529 / OM-122864: Update FLAC to version 1.4.3 - OVCC-1525: `carb.crashreporter-breakpad.plugin`: added default settings for `/crashreporter/url`, `/crashreporter/product`, and `/crashreporter/version` so that crash reports can always be uploaded even in apps that have not been fully configured. ## Fixed - OVCC-1497: `tsc_clock::sample()` now acts as a compiler barrier to prevent compiler reordering of sampling. - OVCC-1513: address UB in omni::string. Replace the union with a struct to avoid accessing an inactive member. - OVCC-1497: Significantly improved performance of `carb::thread::mutex` (now ~70% faster than `std::mutex`) and `carb::tasking::Mutex` (about ~70% faster than the previous implementation). - OM-123447: add module docstring for carb.settings, carb.tokens, omni.kit.app, omni.ext. - OM-121493: Python: Using `carb.profiler` decorators and profiling will now work properly with `async` functions. ## Added - OVCC-1472: Added `CARB_PLUGIN_INTERFACE_EX` which allows interfaces to have a default version that is distinct from the latest version. This allows modules to opt-in to interface changes rather than always getting the latest. - OMPE-1332: `omni.ext`: apply ext dict filters for remote extensions and include them when publishing. - OVCC-1504: `carb.audio-forge.plugin`: added a `playFilePaused` command to the `example.audio.playback` app. This plays a sound on a voice that is initially paused. It is unpaused after a few seconds then plays to completion. The `--input` option is used to provide the path to the sound to play. The `--interactive` option is optionally used to print the play cursor position during playback. Various other common options such as `--format`, `--frame-rate`, `--decoded`, `--memory-stream`, `--disk-stream`, etc will also affect the behavior of this new command. - OVCC-1524: `carb.crashreporter-breakpad.plugin`: added a new volatile metadata type that allows a file blob in memory to be written to file. The crash reporter will then include the written file in the crash report. This is useful as a way of including arbitrarily large metadata values in the crash report as files instead of directly as metadata values. Each metadata value itself has a limit of 32KB on the OmniCrashes side. This provides a way to work around this limit. Currently OmniCrashes will discard any metadata values that are beyond this size limit. - OM-123294: `omni.structuredlog.plugin`: added a setting that can be used to enable ‘anonymous data’ mode. This forces all user and login information to be cleared out and all consent levels approved. This modified information will also ## 167.0 ### Added - OM-123459: `omni.structuredlog.plugin`: added the `omni::structuredlog::IStructuredLogControl2` interface. This new interface contains the `emitProcessLifetimeExitEvent()` function to force the process lifetime exit event to be emitted early and with a custom reason. This is only intended to be used at process shutdown time. ### Changed - OM-122864: Upgrade python dependencies to fix security issues. - OM-117408: `omni.ext`: print/log registry sync status. - OVCC-1523: `framework`: Made assertion failures also log to all of the currently configured standard logger destinations. This includes the main log file, standard streams, and the debug console (on Windows at least). These messages will only be explicitly written by the `IAssert` interface to the standard streams and debug console destinations if the standard logger has not already written to those destinations as well. ### Fixed - OVCC-1504: `carb.audio-forge.plugin`: fixed a bug in `carb.audio` that caused voices that were started in a paused state to potentially accumulate position information from previous voices. This was only an issue if the previous voice did not play to completion of its sound and following uses of the same bus were started in a paused state. - OM-123140: `omni.ext`: fix kit sdk extensions exclusion when generating version lock. ## 166.0 ### Added - OVCC-1506: `carb.tasking.plugin`: Added `/carb.tasking.plugin/suppressTaskException` setting for debugging task exceptions. - OVCC-1509: `carb.tasking.plugin`: Added `/carb.tasking.plugin/debugAlwaysContextSwitch` setting which is a debug/test mode that will greatly increase the number of context switches to shake out issues. ### Changed - OM-121332: `omni.kit.app.plugin`: /app/fastShutdown defaults to true - OVCC-1503: Increased buffer given to `omniGetModuleExports` from 1k to 4k. - OVCC-1512: `carb::cpp::bit_cast` will be `constexpr` if the compiler supports it, even prior to C++20. - OVCC-1512: The bit operations library (`carb/Bit.h`) will fall back to C++20 definitions (i.e. from `<bit>`) if C++20 is available. - OM-116009: flush prints to `stdout` after loading the extensions. ### Fixed - OVCC-1510: `carb.input.plugin`: Fixed a regression with hashability of device types. - OVCC-1511: Fixed compilation issues when built with TSAN (`-fsanitize=thread`) on newer versions of GCC. - OVCC-1512: Fixed compilation issues when building with older versions of MSVC 2017. - OM-122114: Updated `omni.bind` testing dependencies. - OVCC-1494: Linux: Logging to an ANSI console now issues an explicit reset to fix issues with text coloring. ## 165.0 ### Added - OM-120782: `omni.ext`: add deprecation warning param for extensions - OM-120782: `omni.ext`: make deprecation warning a developer-only warning - OVCC-1428: Carbonite now packages `tools/premake-deps.lua` –a library of Premake functions to build with various Carbonite dependencies. ### Changed - OM-120985: updated to zlib 1.3.1 # OM-120985: omni.telemetry.transmitter: updated to zlib 1.3.1 and libcurl v8.6.0 to get a fix for CVE-2024-0853 ## Fixed - OM-120831: Fix CARB_PROFILE_FRAME crash on Kit shutdown (emitting event after Tracy shutdown) - OVCC-1502: Carbonite headers should now compile under C++20. - OVCC-1500: carb.tasking.plugin: Fixed a rare race that could manifest when very short tasks return a value via a `Future`. - OM-120313: carb.crashreporter-breakpad.plugin: launched the user story GUI child process with its working directory set to the location that the parent (ie: crashing) process loaded its own `carb.dll`/`libcarb.so` library from. This allows the child process to find the carb module on startup since it is a static dependency of the tool. - OMPRW-707: cache more acquire interface calls for omni.kit.app and omni.ext - OM-120581: carb.crashreporter-breakpad.plugin: added some thread safety fixes around accessing the metadata and file tables in the crash reporter and improved some logging output around the crash report upload. - OVCC-1499: carb.input Python bindings: Fixed an issue with `get_modifier_flags` and `get_global_modifier_flags` that would not properly distinguish between empty arrays and `None`. Also added several functions that were available in the `carb::input::IInput` API but not available in the Python bindings. - OVCC-1493: omni.app.plugin: `/app/fastShutdown` will no longer hijack the exit code. - OM-120581: Build: took initial steps to get Carbonite building with the GCC 11 toolchain. - fixed an issue in `omni.bind` that hardcoded the paths to the include folders for GCC 7. - fixed some new warning that have shown up with GCC 11. - fixed a change in the `cpuid.h` header under GCC 11’s headers that added a `__cpuidex()` function. This conflicted with a version that was explicitly implemented in `omni.platforminfo.plugin`. - fixed some deprecations in GCC 11’s libraries. - called `__gcov_dump()` instead of `__gcov_flush()` since the latter has been both deprecated and removed in GCC 11. - added passthrough replacements for the `___finite()` math functions since they were removed in a more recent GCC/glibc. This could also be fixed later by rebuilding `forgeaudio` under a newer GCC version as well. # 164.0 ## Added - OVCC-1488: Added `carb::this_thread::spinTryWaitWithBackoff()`, similar to `spinWaitWithBackoff()` but will give up in high contention cases, informing the caller that waiting in the kernel is likely a good idea. - OVCC-1492: carb.scripting-python.plugin and Python bindings: Added support for Python 3.11. ## Changed - OM-119706: omni.telemetry.transmitter: improved some logging in the telemetry transmitter. - OM-119706: omni.telemetry.transmitter: changed the default transmission limits for each event processing protocol to match the limits for each default endpoint. - OVCC-1441: framework: changed the `carb::StartupFrameworkDesc` struct to include a `carb::PluginLoadingDesc` member. This allows apps to programmatically control which plugins are loaded during framework init instead of having to specify it either on the command line or in the ‘/PluginsToLoad’ setting in a config file for the app. # Section 1 ## Fixed - OVCC-1491: Linux: Improved `carb::this_thread::getId()` performance by about 97% in most cases. - OVCC-1488: aarch64: Fixed a potential rare hang that could occur in the futex system, affecting all synchronization primitives. As a result of the fix, aarch64 futex operations are much faster, with a contended test executing nearly 90% faster. - OVCC-1488: Linux: Improved `carb::thread::mutex` and `carb::thread::recursive_mutex` substantially by fixing a performance regression: in the contended case they are ~98% faster executing in a mere 2% of the previous time. In contended tests they are about ~54% faster than `std::mutex` and `std::recursive_mutex`, respectively. - OM-119240: `omni.ext`: Fix non-deterministic import order when using fast_importer - OVCC-1473: Windows: Console applications will no longer hang or crash when CTRL+C is pressed to end the application. Note: Applications that desire different CTRL+C behavior should install their own handler after initializing the Carbonite framework. - OVCC-1478: `carb.tasking` with `omni.job`: Fixed a rare hang that could occur when calling `ITasking::reloadFiberEvents()`. - OM-119706: `omni.telemetry.transmitter`: reworked the transmitter’s retry policy for failed endpoints. A failed transmission will now be retried a configurable number of times before removing the endpoint for the session. This fixes a potential situation where the transmitter could effectively hang under certain configurations. - OM-87381: Fixed issues where `carb.crashreporter-breakpad` would crash inside the crash handler when `NtCreateThreadEx` was used to inject a thread to crash the process. # Section 2 ## 163.0 ### Added - OVCC-1480: `kit-kernel`: added the `OMNI_ENABLE_CRASHREPORTER_ON_FAST_SHUTDOWN` environment variable to allow the crash reporter to remain enabled during a fast shutdown in Kit. Set this environment variable to `1` to keep the crash reporter enabled. Set to any other value to use the default behavior of disabling the crash reporter during a fast shutdown. If the environment variable is not present, the default behavior is to leave the crash reporter enabled when running under TeamCity or GitLab, and to disable it on fast shutdown otherwise. - OVCC-1295: Added documentation for `carb::tokens::ITokens` and Python bindings. ### Changed - OM-111557: Reworked Python exceptions handling to call `sys.excepthook` instead of just logging - OVCC-1481: `carb.tasking`: Implemented an optimization that can execute tasks within a `TaskGroup` or `Counter` when waiting on the `TaskGroup` or `Counter`, which allows tasks to resolve quicker. Improves performance of the ‘skynet:TaskGroup’ test by about 28% on Windows and makes it runnable on Linux. ### Fixed - OVCC-1474: Fixed a rare crash that could occur in `carb.tasking`. - OVCC-1475: Fixed a hang in `carb.crashreporter-breakpad` if a crash occurred in the logging system. - OVCC-1476: Linux: Reduced calls to `getenv()` as it cannot be called safely if any other thread may also be performing any change to the environment due to deficiencies in GLIBC. - OVCC-1474: Fixed a rare crash that could occur in `carb.tasking` in certain `applyRange` subtasks. - OVCC-1478: Fixed a rare crash that could occur in `carb.tasking` if the main thread calls `executeMainTasks` and happens to context switch while another thread is calling `reloadFiberEvents`. ### 162.0 #### Added - OVCC-1434: Added `carb::tasking::Delegate<>` , which is the same as `carb::delegate::Delegate<>` , but is tasking-aware. - OVCC-411: Added `omni::vector<>` , an ABI-safe implementation of `std::vector<>` . This class adheres to the C++ standard vector excepting that `Allocator` is not a template parameter; `omni::vector<>` always uses `carb::Allocator<>` , which uses Carbonite’s `carb::allocate` and `carb::deallocate` functions (and require `carb.dll` or `libcarb.so`). - OVCC-1467: `omni.telemetry.transmitter`: output the transmitter version and log file location(s) to its log during startup. #### Changed - OM-117489: `omni.ext.plugin`: target.kit now takes kit patch part of the version into account too. - OVCC-1352: `carb.tasking` has received various performance improvements: - `applyRange` / `parallelFor` are significantly faster; the `skynet` test runs 21x faster on Windows and 7x faster on Linux due to algorithmic changes. The new algorithm is better able to sense system overload and adapt. - Waking threads has been found to take about 10 µs (microseconds) on Linux and 50 µs on Windows, which is very slow. The changes try to lessen the impact of waking threads by preferring deferred wake (chain reaction) and keeping threads active while the system has work available. - Algorithms and task queues have changed to utilize multiple lanes to reduce contention. - Pinning, while still not recommended, is much more efficient and will no longer log warnings. - `omni.kit.app` , `omni.ext`: Replace most std map/set containers with carb RH version. - OVCC-1054: `carb.tokens`: Warning/error logs will now include the entire token stack with the issue. Token names and values longer than 256 characters will be truncated. - OVCC-1440: Windows: The `omni.kit.app` / `kit.exe` CTRL+C behavior now matches Linux: a quit is posted to the app and it will shutdown gracefully on the next frame. - OVCC-1470: `carb::container::LocklessStack` uses a common algorithm between Windows and Linux and is once again lock-free on Linux. All operations on Linux are now ~99% faster in the uncontended case and ~95% faster in the contended case. Windows operations are ~20% faster in the uncontended case and ~10% faster in the contended case. - OVCC-1468: On Windows, Carbonite executables and libraries now implement Control Flow Guard excepting `carb.tasking.plugin` for performance concerns. - OM-118678: `omni.telemetry.transmitter`: updated to libcurl v8.5.0 to get a fix for CVE-2023-46218. #### Fixed - OVCC-1235: Linux/GCC: Warnings in public includes from `-Wconversion` and `-Wno-float-conversion` have been fixed. - OVCC-1352: Fixed issues with `CARB_PROFILE_BEGIN` and `CARB_PROFILE_END` not respecting profiler channels properly. - OVCC-1464/OVCC-1420: Further fix to a deadlock that could occur if Python bindings are loaded simultaneously with Carbonite plugins in separate threads. This resolves on old versions of GLIBC that have problems with internal locking. - OM-108121: Fixed test for keyboard-modifier-down transitioning after up. - OM-118059: `omni.telemetry.transmitter`: fixed a bug that prevented the transmitter from automatically pulling down the latest schema ID for use on the non-OVE open endpoint. - OVCC-1069: Fixed carb.dictionary python bindings does not handle `bool` correctly. - OVCC-1450: Improved tracy profiler backtracing performance and fixed symbol resolution for dynamically loaded shared libraries on linux. - OVCC-1469: Fixed a race condition that could lead to a hang when `carb.tasking` was used with `omni.job` as the underlying thread pool. ### 161.0 - OVCC-1431: For Linux x86-64, Carbonite now publishes `carb_sdk+tsan` and `carb_sdk+plugins+tsan` packages that have Thread Sanitizer enabled (`-fsanitize=thread`), allowing those modules to report to Thread Sanitizer. Suppressions are located in the `include/tsan-suppressions.txt` file. - OM-114023: `omni.kit.app`: Rework `--vulkan`, add `app/vulkan` setting to control Vulkan ### Fixed - OVCC-1164: Fixed ScratchBuffer move and copy constructors to correctly initialize data. - OVCC-1444: `omni.ext.plugin`: fix ext linking bug when using non-English OS language on Windows - OVCC-1420: Fixed a deadlock that could occur if Python bindings are loaded simultaneously with Carbonite plugins in separate threads. - OVCC-1427: Log consumers and Loggers will no longer be called recursively. If a Logger does something that would recursively log, other Loggers will still receive the log message but the offending Logger will be ignored. - OVCC-1427: Logs that occur on a thread with either the Framework or PluginManager (OVCC-948) mutexes locked are now deferred until both of these mutexes are unlocked to prevent unsafe recursive calling into the Framework. ### 160.0 - OM-113541: Linux: `omni.kit.app.gcov.plugin` was added and `kit-gcov` uses this to ensure that the fast shutdown code path also calls `__gcov_flush`. - OVCC-1438: Added `runningInContainer` crash metadata, indicating if the process is running inside a container. - OVCC-1263: `omni.kit.app.plugin`: added the `OMNI_TRACK_SETTINGS` environment variable to allow all changes to a given list of settings to be reported as warning messages. If a debugger is attached, a software breakpoint will also be triggered for each change to the tracked setting. Multiple settings may be monitored by separating their paths with a comma (‘,’), pipe (‘\|’), colon (‘:’), or semicolon (‘;’). ### Fixed - OVCC-1432: `carb.dictionary.plugin`: Added a missing mutex in subscribeToNodeChangeEventsImpl that otherwise led to data corruption. - OVCC-1397: `carb.input.plugin`: Fixed an issue from 159.0 that caused action mapping hooks to not work properly. - OM-115009: Fixed carbReallocate not freeing memory when using mimalloc. - OVCC-1436: Fixed missing quotes for Windows in `omni.structuredlog.lua`. - OVCC-1442: `carb.crashreporter-breakpad.plugin`: prevented upload retry attempts for crash reports that previously failed with most 4xx HTTP status codes. These crash report files will remain on disk locally but will never attempt to be uploaded again. The user can attempt to modify the crash report’s metadata manually to allow it to be tried again, or they can delete the report. - OVCC-1442: `carb.crashreporter-breakpad.plugin`: fixed an issue that could cause the crash reporter to become disabled if its interface was acquired early on Kit startup but the settings registry wasn’t present yet. ## Added - OVCC-1209: `omni.platforminfo.plugin`: added a function to `omni::platforminfo::IOsInfo2` to retrieve a machine ID that can be used as an anonymous user ID in telemetry. - OVCC-1209: set the structured logging user ID to an anonymous machine ID if `/structuredLog/anonymousUserIdMode` is set to “machine”. - OMFP-3389: `kit-kernel`: scanned the command line on startup for extension and integration test commands. When found, `kit` puts `omni.structuredlog.plugin` into ‘test’ mode automatically so that structured log events generated during test runs do not interfere with production telemetry analysis. - OVCC-1415: `carb.crashreporter-breakpad.plugin`: added a check for the `CARB_DISABLE_ABORT_HANDLER` environment variable before installing the SIGABRT handler on Windows for plugins and executables that are statically linked to the Windows CRT. If this environment variable is set to “1”, the SIGABRT handler will not be installed. If it is undefined or set to any other value, the SIGABRT handler will be installed by default. This is a temporary workaround to allow the Nsight debugger to still work with newer Omniverse apps that include this Carbonite functionality. - OVCC-1422: `carb.crashreporter-breakpad.plugin`: added a check for the `OMNI_CRASHREPORTER_CRASHREPORTBASEURL` environment variable to override the ‘/crashreporter/crashReportBaseUrl’ setting. - OVCC-1286: Fix a bug where omni.structuredlog would generate a pure python module with invalid `send_event()` functions when the event properties had characters other than `[a-zA-Z_]`. - OM-113393: [omni.ext.plugin] package yanking support - OVCC-1414: Added additional Python binding documentation. - OVCC-1411: The environment variable `CARB_USE_SYSTEM_ALLOC`, if defined and set to a value other than `0` at the time of the first request, will cause `carb::allocate`, `carb::deallocate`, and `carb::reallocate` to use the system default heap instead of using Mimalloc. - OVCC-1418: `carb.crashreproter-breakpad.plugin`: added the `/crashreporter/metadataToEmit` setting. This is expected to be an array of regular expression strings that identify the names of crash metadata values that should also be emitted as telemetry events any time they are modified. A single event will be emitted when any metadata value is added or modified. If the metadata is set again to its current value, no event will be emitted. - OM-114420: `omni.ext.plugin`: add support for filter:setting to be able to change extension dependencies based on setting - OM-113920: `omni.ext.plugin`: updated packman link code to sync closely with changes in packman 7.10.1 which fixes issues creating symbolic links / junctions. - OM-114145: `omni.ext.plugin` add support for different version ranges (~, >, <, =, ^ operators) - OVCC-1358: Try to allow structuredlog.sh/structuredlog.bat to find packman from the CWD. - OVCC-1358: Add `repo structuredlog` to launch structuredlog from repo tools. This avoids issues around having structuredlog find packman and other resources. ## Changed - OVCC-1204: POSSIBLY BREAKING CHANGE* Now that Packman 7.10 can support aliases through the `<filter ... as="" />` tag, the previous change for CC-1204 has been undone and Carbonite’s `target-deps.packman.xml` chain no longer includes a `python` dependency. All Python dependencies are now tagged with their version, such as `python-3.10`. - OVCC-1368: `Framework::releaseInterface` will now allow plugins to unload that are only referenced by themselves. - OVCC-1397: `carb.input.plugin` has been made thread-safe. The `IInput` interface and associated `carb::input` namespace have also been documented. ## Fixed - OVCC-1407: Python: Fixed an issue where creating a `carb.dictionary` with an empty value (i.e. `{ "payload": {} }`) would produce an empty dictionary (without the `"payload"`). - OMFP-3353: `omni.ext.plugin`: Fix core.reloadable=False not propagating correctly to all dependencies - OVCC-1368: `carb::getCachedInterface` will work properly if a plugin restarts even if a module fails to unload. - OMFP-3389: `kit-kernel`: fixed the ‘normal’ shutdown path for `kit` so that it properly shuts down `omni.structuredlog.plugin`. Previously this path was force unloading the plugin without notifying it of the unload. - OM-113843: `carb.crashreporter-breakpad.plugin`: fixed an issue with the recent crash reporter changes that caused the Nsight system profiler to stop working with Carbonite based apps on Windows. The issue was tracked down to the new SIGABRT handler using a `thread_local` global variable. - OVCC-1423: `omni.bind` now correctly produces a Python binding to `__init__()` that allows for casting between interfaces. - OVCC-1416: fix temp folder not being removed on fast shutdown - OVCC-1380: Linux: Fixes a crash that can occur when `carb.crashreporter-breakpad.plugin` is shut down when running on older versions of GLIBC, such as on CentOS-7. - OVCC-1371: `include/carb/thread/RecursiveSharedMutex.h`: Fix compilation error if `CARB_ASSERT_ENABLED` was forced on. ### 158.0 #### Added - OVCC-1254: `carb.settings.plugin`: Added `carb::settings::ScopedWrite` and `carb::settings::ScopedRead` RAII lock classes. - OVCC-1408: Added `include/carb/time/Util.h` which has platform-independent versions of time utility functions `asctime_r()`, `ctime_r()`, `gmtime_r()` and `localtime_r()`. - OMFP-901: Linux: `kit-gcov` was added. This is a `kit` binary that is compiled with `gcov` support and calls `__gcov_flush()` before exiting. This can be used for downstream projects that want to collect code coverage information. #### Changed #### Fixed - OMFP-2683: Upgrade Python packages to fix BDSA-2022-3544 (CVE-2022-46908) - OVCC-1406: Fixed the handling of assertion failures so they can now generate a crash report if not ignored by the user (in debug builds on Windows). This allows the process lifetime ‘crash’ structured logging event to still be emitted in cases of an assertion failure. - OVCC-1254: `carb.settings.plugin`: Documented `ISettings` and fixed some thread safety issues. - OVCC-1408: Linux: locations that were using non-thread-safe `gmtime()` and `localtime()` have been changed to use `gmtime_r()` and `localtime_r()` respectively. The biggest issue was logging timestamps, but it also affected `carb.crashreporter-breakpad.plugin` timestamps and `carb.profiler-cpu.plugin` file names. - OVCC-1410: `carb.tasking.plugin`: Fixed a very rare case where `ITasking::addSubTask` would never return. - OVCC-1399: Windows: Fixed an issue where `_exit()` was attempting to shutdown the Carbonite Framework even though atexit callbacks were not run. NOTE: This solution requires Carbonite executables to either dynamically link the CRT, or to start the framework from the executable with either ```code carb::acquireFrameworkAndRegisterBuiltins() ``` , ```code OMNI_CORE_START() ``` or ```code OMNI_CORE_INIT() ``` . ## 157.0 ### Added * carb.profiler-tracy.plugin: * Added tracy profiler plugin option `/plugins/carb.profiler-tracy.plugin/memoryTraceStackCaptureDepth` to capture callstacks on memory event operations in order to benefit from tracy views where it uses callstack info for grouping [defaults to 0]. * Added tracy profiler plugin option `/plugins/carb.profiler-tracy.plugin/instantEventsAsMessages` to inject “instant” events via tracy profiler messages instead of the current “fake zones” [defaults to false]. * Added tracy profiler plugin option `/plugins/carb.profiler-tracy.plugin/skipEventsOnShutdown` to skip injecting profile events after tracy plugin shutdown has been requested [default to false]. ### Changed ### Fixed * OVCC-1392: Logging performance with `/log/async` on has been greatly improved. * OVCC-1393: Fixed an issue where `/log/async` on at shutdown could cause the last few log messages to be skipped. * OMFP-2562: `omni.telemetry.transmitter`: updated to `libcurl` version 8.4.0 and `openssl` version 3.0.11 to address CVE-2023-38545. * OMFP-1262: Fix for passing nullptr as text when setting clipboard crashes on Linux. * OM-112381: `omni.ext.plugin`: Fix exact=true to match exactly one version * OMFP-2353 / OMFP-2356: `omni.kit.app`: (Linux only) Fixed a crash that could occur sometimes when `SIGTERM` or `SIGINT` (CTRL+C) was received. * OVCC-1315: Visual Studio: Fix compilation warning 4668 on `include/carb/Defines.h`. * OVCC-1371: `include/carb/thread/SharedMutex.h`: Fix compilation error if `CARB_ASSERT_ENABLED` was forced on. * OVCC-1398 / OMFP-2908: `carb.crashreporter-breakpad.plugin`: Heap usage and `fork()` can cause hanging inside the crash handler. These have been eliminated in the crash handler. ## 156.0 ### Added * OVCC-1372: Added `carb::logging::StandardLogger2` sub-interface that is accessible from `carb::logging::ILogging`. This interface has functions that can be used to override the log level for the current thread only. * OVCC-1372: Added `carb::logging::ScopedLevelThreadOverride`, a RAII class that can be used to override the log level for a given `StandardLogger2` while in scope. * OVCC-1325: `carb.events.plugin`: `carb::IEvent` now has `attachObject()` and `retrieveObject()` functions that can be used to attach descendants of `carb::IObject` to an event. * OMFP-1450: `omni.telemetry.transmitter`: added support to the transmitter to pull down the latest Kratos schema IDs for use on open endpoints. The transmitter now attempts to download the latest schema IDs file from the same base URLs as the schemas packages are downloaded from. It then reads the appropriate schema ID for the current run. ## Changed ### OVCC-1369: carb.crashreporter-breakpad.plugin now has a companion tool called crashreport.gui. If shipped along with carb.crashreporter-breakpad.plugin, it will be invoked in the event of a crash for the user to provide a story of what they were doing when the crash occurred. ### OVCC-1372: BREAKING CHANGE carb::logging::StandardLogger is deprecated; carb::logging::StandardLogger2 inherits all of its functionality as a pure virtual interface. The old ILogging::getDefaultLogger(), ILogging::createStandardLogger(), and ILogging::destroyStandardLogger() functions have gained an Old suffix, breaking the API, but not the ABI. The new ILogging::getDefaultLogger() and ILogging::createStandardLogger() functions work with StandardLogger2. StandardLogger2 is ref-counted and can be destroyed with release(). ### BREAKING CHANGE The carb::logging::ScopedFilePause class has moved to carb/logging/LoggingUtils.h. ## Fixed ### OVCC-1373: Code that uses carb/profile/Profile.h macros will now compile if profiling is disabled at compile time by setting CARB_PROFILING=0. ### OVCC-1379: carb.crashreporter-breakpad.plugin: fixed the abort/termination handlers for all plugins that are statically linked to the Windows CRT. ### OVCC-1381: carb.events.plugin: Fixed slow IEventStream and subscription creation times when a name is not provided. The generated name will be very simple unless /plugins/carb.events.plugin/nameFromCaller setting key is true, in which case symbol lookup will take place to determine a more descriptive generated name. ### OVCC-1367: omni.structuredlog.plugin: fixed how the early privacy.toml fields are loaded to avoid a bad user ID from being used. When the user ID value in the privacy.toml file is present and points to a non-existent environment variable, this would previously incorrectly insert the full $env{} tag as the user name. This fixes that behavior so that even the early loading of the file handles resolving environment variables too. ### OM-111167: fix an explicit python3.dll load from python ### OMFP-1450: omni.bind: fixed a crash in the omni.bind tool due to a diff of C++ code being passed to f"" while writing out an error message for a --fail-on-write failure. ### OMFP-1977: Fixed a performance regression on Windows with logging. ### OVCC-1387: omni.structuredlog.plugin: fixed some bad early loading of consent settings in standalone mode. This does not effect Kit or Carbonite based uses of structured logging however since the consent settings are loaded again through ISettings later during startup. # Added - OVCC-1363: Adds type hints for omni.bind python code - OVCC-1166: omni.bind’s input/output filenames now correctly resolve `%{cfg.buildcfg}` and `%{config}` in `premake5.lua`. - OVCC-1364: `omni.telemetry.transmitter`: added support to the telemetry transmitter to add specific extra fields to each message instead of having to add them only at the time each message is produced. The ‘/telemetry/extraFieldsToAdd’ setting controls which extra fields from ‘/structuredLog/extraFields/’ will be added to each message. The ‘/telemetry/replaceExtraFields’ setting controls whether any existing extra fields will be replaced with the new values (true) or just be left as-is (false). - OMFP-583: `omni.crashreporter-breakpad.plugin`: added the crash report metadata file to compressed crash report files. - OM-108908: `carb.windowing`: Exposed monitor functions to python. - OM-108791: Added support for default values for arguments passed through ONI / omni.bind # Changed - OVCC-1375: cleaned up `omni.bind.util.Lazy`; replaced with python’s `functools.cache` - OVCC-1377: Tweaked `CARB_HARDWARE_PAUSE()` to be more correct on x86_64 with non-Microsoft compilers, and aarch64. # Fixed - OVCC-1374: A built-in plugin that was released before the framework was shutdown could cause a crash during framework shutdown. - OVCC-1376: An assertion could happen in debug builds if `Framework::tryAcquireInterfaceFromLibrary` or `Framework::loadPlugin` was called prior to `IFileSystem` being instantiated. This would only happen in certain “lightweight” instantiations of the Carbonite framework as `OMNI_CORE_START()` or `acquireFrameworkAndRegisterBuiltins()` would not exhibit this problem. - OM-109545: fix omni::ext::getExtensionPath not to crash when can’t find an extension # Added - OVATUEQI-35: Adds functionality to enable extra security checks when opening an archive based on the trust level of the registry from where the extension originates. By default, registries are trusted. - OM-101243: `carb.crashreporter-breakpad.plugin`: added a helper tool called `hang.crasher` for Windows that is used to intentionally crash a Carbonite based app that has hung. This is intended to be used in CI/CD with unit test child processes that run beyond their expected timeout. - OM-108121: `carb.input.plugin`: API to query modifier state of input devices. # Changed - OM-108121: `carb.input.plugin`: Added ability to query number of keys pressed. - OVCC-1347: `carb::cpp::countl_one()` and `carb::cpp::countr_one()` have been implemented as C++14-compatible equivalents to `std::countl_one()` and `std::countr_one()` respectively. - OVCC-1347: All non-`constexpr` functions in the `carb/cpp/Bit.h` library now have `constexpr` extensions with a `_constexpr` suffix. Within the `carb::cpp` namespace the new functions are: `popcount_constexpr`, - Added - `countl_zero_constexpr`, `countr_zero_constexpr`, `countl_one_constexpr`, and `countr_one_constexpr`. - OVCC-1347: Added `carb::UseCarbAllocatorAligned`, which allows overriding `new` and `delete` on a per-class basis while specifying an overriding alignment. - OVCC-1340: Linux/Mac: Futex performance was further improved, especially contended wake-up situations where no waiters are present. - OVCC-1347: Added `carb::thread::AtomicBackoff`, a helper class for providing a back-off in spin-wait loops. - OVCC-1347: `carb::Allocator<>` now has an optional `Align` parameter that is used as an alignment hint. - Several minor performance improvements for `carb.tasking.plugin`: - The futex system has received the same improvements from OVCC-1340. - Spurious wake-ups of co-routines and threads that wait on tasking objects have been eliminated. - Allocations are cacheline-aligned to reduce false-sharing. - Linux: Thread IDs are now cached as the syscall to obtain them was very slow. - Linux: Handle slab allocations are now larger to reduce the total number of slow `mmap` syscalls. - Fixed - OM-99583: bump python to 3.10.13+nv2 (CVE) - 153.0 - Added - OM-93636: added documentation on how to configure an app in a container to support telemetry. - OVCC-1344: Adds `IWeakObject` and `WeakPtr`. Interfaces implementing `IWeakObject` will support non-owning references. `WeakPtr` is similar in functionality to `std::weak_ptr`. Implementations are encouraged to use `ImplementsWeak` to add support for weak pointers in their implementations. Consumers of weak pointers must add the following to their `premake5.lua` projects to enable weak pointer support on OSX: ```lua filter { "system:macosx" } linkoptions { "-Wl,-U,_omniWeakObjectGetOrCreateControlBlock" } linkoptions { "-Wl,-U,_omniWeakObjectControlBlockOp" } ``` - OVCC-1350: string_view: Add std::string to carb::string_view implicit conversion - Changed - OVCC-1340: Linux/Mac: Futex performance was improved, which has a knock-on effect for all synchronization primitives. Four-byte futexes now use the ParkingLot as opposed going directly to the system futex, which saves ~97% on no-op cases. Waking 8 threads has improved about 55%, and the threads wake about 20% faster due to less contention. - OVCC-1340: `carb::thread::futex`: the `wake`, `wake_one`, and `wake_all` functions are deprecated in favor of respective replacement functions: `notify`, `notify_one`, and `notify_all`. These new names better match the standard and are more distinct from “wait”. - OVCC-1341: `carb::allocate`, `carb::deallocate`, and `carb::reallocate`... - Performance Improvements: - Allocations in `carb.tasking`, `carb.dictionary.plugin`, and `carb.events.plugin` are now based on Microsoft’s Mimalloc allocator for improved performance, especially in multi-threaded contentious environments. On Windows, single-threaded alloc/dealloc is 54% faster; contended alloc/dealloc is 219% faster. On Linux (GLIBC 2.35), single-threaded alloc/dealloc is 23% faster; contended alloc/dealloc is 864% faster. - OVCC-1348: Fixed a performance regression in Linux `carb.profiler-cpu.plugin`. - OVCC-1355: `carb.crashreporter-breakpad.plugin`: Python tracebacks are now reported with full filenames. - Fixed Issues: - OM-106256: fix supported targets check on registry 2.0 - OM-100519: [omni.ext.plugin] fix crash on shutdown when extension was removed - OM-106907: fix not all ext summaries are included in registry v2 - Added Features: - OVCC-1284: `omni.structuredlog.plugin`: added an interface to allow extra fields to be added to each structured log message. Extra fields may be provided programmatically with the `omni::structuredlog::IStructuredLogExtraFields` interface or by adding a key/value pair to the ‘/structuredLog/extraFields/’ settings branch on framework startup. - OVCC-1323: `carb.crashreporter-breakpad.plugin`: improved some logging and metadata from the crash reporter. This includes: - printed an info message indicating that the crash reporter successfully started up. - printed info messages any time the crash reporter or upload setting is toggled. - renamed some existing CI metadata keys to be more clear what they are collecting. - added several more GitLab and TC specific metadata values. - added a metadata value that indicates whether TC or GitLab is being used to run the crashing job. - tried to collect the app name and version from multiple settings. - added a GMT timestamp indicating when the crash occurred. - OM-93636: `omni.telemetry.transmitter`: added a new message processing protocol (called ‘defaultWithList’) to the telemetry transmitter. This will batch up events in a JSON array and deliver them to the endpoint as a JSON batch object. - OVCC-1320: Added `carb/time/TscClock.h`, a CPU time-stamp counter sampling “clock” for super-high-performance profiling and timing purposes. - OVCC-1320: Added `carb/cpp/Numeric.h` with an implementation of `std::gcd`: `carb::cpp::gcd`. - OVCC-1320: `HandleDatabase` has changed to using a `LocklessQueue` for free-list instead of `LocklessStack` as this proved to perform better due to less contention, especially on Linux. - OVCC-1343: Added `hash` field to `carb::datasource::ItemInfo`. - Changed Features: - OVCC-1316: unified the parsing of the command line options in kit-kernel so that parameters for other options are parsed consistently in all cases. All options now support providing their parameter either after an equals sign in the same command line argument or in the following argument. - OM-93335: `omni.kit.app` revert “python” token change to include python version in the path - OVCC-1324/OM-96947: The `carb.tasking` setting `debugTaskBacktrace` is now off by default in release builds. - OVCC-1320: Greatly improved `carb.tasking` handle allocation speeds. Created a Fibers-vs-Threads document with history and current performance times. The maximum number of fibers was increased to support the new “skynet” benchmark unit test. - Fixed Issues: - OVCC-1294: Fixed a performance issue with using `omni.log` from Python - OVCC-1313: Fixed a crash fix that could occur with `carb::settings::appendToStringArray()` - OVCC-1310: `carb.crashreporter-breakpad.plugin`: Fixed an issue where a deadlock could occur when a crash occurred. - OM-103625: `omni.ext` extensions packing does not preserve file symlinks on linux ## OVCC-1318 carb.crashreporter-breakpad.plugin: Fixed an issue where a crash in multiple threads simultaneously would likely cause the process to exit without writing crash information. ## OVCC-1298 Worked around issues with `carb::thread::recursive_shared_mutex` when used with Link-Time Code Generation ## OM-100518 Load and Release hooks that are not unregistered when a module is unloaded will now log an error instead of causing a crash when called. Note that this is a workaround in attempt to diagnose libraries that are not unregistering Load and Release hooks. ## 151.0 ### Added omni.ext.plugin: add support for the registry v2 with incremental index loading OVCC-414: Adds `omni::expected<T, E>` and `omni::unexpected<E>` class templates, which are ABI-stable implementations of their `std` counterparts. These monads are useful in representing potential error conditions when exceptions are not desired or not enabled. The API for these types is compatible with the `std` version, with a few minor changes: - `error_type` for both class templates is allowed to be `void` to match parity with other languages with result monads (e.g.: Rust allows `Result<T, ()>`) - The `omni` implementation is less `constexpr`-friendly that the `std` implementation, mainly due to requiring C++14 compatibility. - Cases where the C++ Standard leaves things as implementation-defined will generally result in program termination (e.g.: calling `expected.error()` when `expected.has_value()` will hit an assertion). OVCC-1301, OVCC-1303, OVCC-1306: Created gdb pretty-printers for `carb::extras::HandleDatabase`, `carb::RString` and several `carb.tasking` types. Additionally commands were created for `task list` (lists all `carb.tasking` tasks), `task bt <task>` (gives the current backtrace of a `carb.tasking` task), etc. ### Changed OVCC-414: Changes the C++17 utility type backports (e.g.: `carb::cpp17::in_place_t`) to alias their `std` counterparts when C++17 is enabled instead of being distinct types. This has the potential to break APIs where there is an overload for both the `carb` and `std` versions, which can be fixed by deleting one of them. Keep the `carb::cpp17` overload if you need support for pre-C++17; keep the `std` overload if you only support C++17 and beyond. OVCC-1293: `omni.structuredlog`: changed the `omni.structuredlog` tool to include the event name in generated struct and enum names. This allows the same field name for an object to be used across multiple events within a schema. OVCC-1264: The `carb::cpp17` and `carb::cpp20` namespaces have been merged into `carb::cpp`. Likewise, the `carb/cpp17` and `carb/cpp20` include directories have been merged into `carb/cpp`. - For backwards compatibility, the previous `carb::cpp17` and `carb::cpp20` directories have files (marked as deprecated) that pull the `carb::cpp` symbols into their respective namespaces (`carb::cpp17` or `carb::cpp20`). - OVCC-1311: `carb::extras::HandleDatabase::makeScopedRef` (the `const` variant) now returns a `ConstHandleRef` which can only be used for const access to mapped items. ### Fixed - OVCC-1288: Carbonite uses a new `doctest` package that fixes a build issue on glibc 2.34+ where `SIGSTKSZ` is not a constant. - OVCC-1311: Fixed a compilation error in `carb::extras::HandleDatabase::makeScopedRef` (the `const` variant). - OVCC-1166: omni.bind’s include paths now correctly resolve `%{cfg.buildcfg}` in `premake5.lua`. ### 150.0 #### Added - OVCC-1281: Add `OMNI_ATTR("nodiscard")` to omni.bind. - OM-99352: `omni.structuredlog.plugin`: added the `/structuredLog/emitPayloadOnly` setting to allow the structured logging system to skip adding the CloudEvents wrapper to each event on output. This is useful for apps that want to use the structured logging system for a purpose other than telemetry and allows the schema for each event to be directly used for full validation of each event instead of just defining the layout of the “data” field. - add `omni.ext.get_all_sys_paths` and `omni.ext.get_fast_importer_sys_paths` to get all sys paths and fast importer sys paths respectively. - `omni.ext.plugin`: log when extensions are requested to be enabled or disabled. - OM-96953: `omni.ext.plugin`: the Kit-kernel extension manager now outputs structured log events any time an extension is loaded or shutdown. The extension’s name and ID are included in both events. On the extension startup event, the startup time in milliseconds is also included. #### Changed - OM-97668: `omni.ext.plugin`: FS watcher will now ignore changes `extension.gen.toml` not to reload extensions when installing by parallel kit instances. - OVCC-1186: omni.bind: out-of-date messages are no longer considered warnings. - OM-99926: `omni.ext.plugin`: defaulted the `/app/extensions/fsWatcherEnabled` setting to `false` when running in a container. When running outside of a container this setting still defaults to `true`. - OVCC-1273: `carb.crashreporter-breakpad.plugin`: removed the missing metadata check before uploading a batch of old crash reports and instead checked for missing metadata for each individual crash report before uploading. - OM-93335: `Runtime-breaking change`: renamed carb_scripting_project from “scripting-python-3.7m” to “scripting-python-3.7” Runtime python version is now determined by carb.scripting-python.plugin settings in kit-core.json python prebuild link is now named python-3.10, python-3.9, and python-3.7 #### Fixed - OVCC-1268: Plugin startup functions `carbOnPluginStartup` and `carbOnPluginStartupEx` will no longer assert on debug builds when called from within a `carb.tasking` task and the calling thread changes. - OVCC-1265: `carb.filesystem` ### Changes - OM-99795: `omni.ext.plugin`: fix if set_extension_enabled_immediate is called from python and parallelPullEnabled is enabled - app hangs. - OVCC-1285: `carb.crashreporter-breakpad.plugin` changes: - The python traceback file is now named `$crashid.py.txt` by default. - Metadata is written out before gathering volatile metadata in case of a double-fault. - Attempts to upload previous crashes will now include all available files (such as python traceback files). - Failing to load metadata will produce `MetadataLoadFailed` metadata for the upload. - OVCC-1291: `carb.tasking.plugin`: Fixed a rare edge-case crash that was introduced by OVCC-1268. ### Added - OM-93952: `omni.kit.app`: (Linux only) support for /app/preload, a key which can be used to relaunch with LD_PRELOAD prefixed with the value of this key. - OVCC-1258: `omni::string_view` is available as an alias for `carb::cpp17::string_view`, and related typedefs. - OVCC-1261: `carb.crashreporter-breakpad.plugin`: Additional “PythonBacktraceStatus” metadata is now recorded for the status of gathering python backtrace during crashing. - OVCC-1200: `carb.crashreporter-breakpad.plugin`: added environment variables to override selected settings for the crash reporter. These are only intended to be used in debugging situation. The following environment variables have been added: - `OMNI_CRASHREPORTER_URL` will override the value of the `/crashreporter/url` setting. - `OMNI_CRASHREPORTER_ENABLED` will override the value of the `/crashreporter/enabled` setting. - `OMNI_CRASHREPORTER_SKIPOLDDUMPUPLOAD` will override the value of the `/crashreporter/skipOldDumpUpload` setting. - `OMNI_CRASHREPORTER_PRESERVEDUMP` will override the value of the `/crashreporter/preserveDump` setting. - `OMNI_CRASHREPORTER_DEBUGGERATTACHTIMEOUTMS` will override the value of the `/crashreporter/debuggerAttachTimeoutMs` setting. - OM-84354: `omni::extras::OmniConfig` has been added to replace omni-config-cpp. This new class has similar functionality but uses standard Carbonite utilities, which improves some things such as unicode support. This new class requires carb.dictionary.serializer-toml.plugin for full functionality, but it will work without the framework. - OVCC-1277: `omni.structuredlog.plugin`: added the `/structuredLog/needLogHeaders` setting to control whether header JSON objects will be added to each written log file. - OVCC-1279: `omni.telemetry.transmitter`: added support for accepting a `file:///` URI in the `/telemetry/endpoint` and `/telemetry/transmitter/<index>/endpoint` settings. This file URI can also point to `file:///dev/stdout` or `file:///dev/stderr` to write the output to stdout or stderr respectively. When a file URI is used as the endpoint, the event data will not be sent to another server but instead just written to a local log file. This is useful for cloud or farm setups where another log collecting system will be run to collect and aggregate data before sending elsewhere. ## OVCC-1258: `carb::cpp17::basic_string_view` and associated typedefs (i.e. `string_view`) are now considered ABI- and Interop-safe and may be used across ABI boundaries. These classes have been checked against the C++ standard and improved with additions made up to C++23. ## OVCC-1259: `carb::cpp20::span` (and `omni::span`) now support limited ranges: that is, classes such as `std::vector` that have a `data()` method and a `size()` method (with other requirements–see documentation) can be used to construct a `span`. ## OM-96952: `carb.profiler-cpu.plugin`, `carb.profiler-tracy.plugin`, and `carb.profiler-nvtx.plugin` will ignore floating-point value records of NaN and Infinity. ## OVCC-1269: Fixed a bug in `omni::string` where certain operations (such as appending) that exceeded the small string optimization size would result in a string that was not null terminated. ## OVCC-1276: Fixed `omni::string` constructor and `assign` which accept `(pointer, size)` erroneously throwing when receiving `(nullptr, 0)`. This is now legal. ## OM-95894: Added clipboard support for virtual windows. ## 148.0 ### Added - OVCC-1257: `omni.bind`: Support `externalincludedirs`. - OVCC-1240: `carb.crashreporter-breakpad.plugin`: Added wide-string volatile metadata support. - OVCC-1248: `omni.telemetry.transmitter`: Added the crash reporter to the telemetry transmitter tool. - OVCC-68: Added `carb::extras::withFormatV()` and `carb::extras::withFormatNV()` which will format a string as by `std::vsnprintf()` and call a Callable with the formatted string (the `N` variant also passes the length). This utility removes the need to allocate space on the stack or the heap to format the string as the function does it. - OVCC-68: Added macros `CARB_FORMATTED`, `CARB_FORMATTED_SIZE`, `CARB_FORMATTED_N`, and `CARB_FORMATTED_N_SIZE` which initialize the `va_list` machinery for a varargs function, and call `carb::extras::withFormatV()` or `carb::extras::withFormatNV()` (for the `N` variants) to format the string. - OM-95249: `omni.kit.app.plugin` Add a setting to clear user config extension version selections - OVCC-1255: Carbonite packages now include `tools/gdb-syms/gdb-syms.py`, a Python script that can be used with the GDB command `source /path/to/gdb-syms.py` which will attempt to download symbols from the Omniverse symbol server. - OVCC-1250: `carb.scripting-python.plugin` is now available for Python 3.8 and 3.9, in addition to the previously available 3.7 and 3.10. ### Changed - ... ## Changes ### Added - OVCC-1241: removed the ‘/privacy/externalBuild’ setting from being able to override internal telemetry related behavior. - OVCC-1237: Updates Carbonite, `omni.bind`, and `omni.structuredlog` to Python 3.10.11. - OVCC-68: `carb.profiler-tracy.plugin` and `carb.profiler-nvtx.plugin` have been refactored to share more common code and to improve performance. - `omni.ext.plugin`: downgrade “Extension with the same id is already registered” to info level (was a warning) - OM-95781: `omni.ext.plugin` deprecate and cleanup stripping level support in the registry ### Fixed - OVCC-1251: Worked around slow extension unloading code in omni.ext. - OVCC-1242: `carb.filesystem` (Windows only) Fixed an issue introduced in 147.0 where file timestamp calculations could vary between `getFileInfo()`, `getFileModTime()`, `getModTime()`, and the `DirectoryItemInfo` passed to the callback for `forEachDirectoryItem()`. - OVCC-1240: `carb.crashreporter-breakpad.plugin`: Fixed an issue that could cause a stack overflow on Linux while in the crash handler, resulting in lost crash information. - OVCC-1245: Fixed a compilation issue that could happen in some cases when `omni/Function.h` was included. Also fixed a few missing include guards. - OVCC-1247: `carb.filesystem` (Windows only) Fixed an assertion failure that can occur if an enumerated file is deleted during the enumeration. - OVCC-1248: `omni.telemetry.transmitter`: disabled assertion dialogs in the telemetry transmitter. ## 147.0 ### Added - OVCC-1228: Added `CARB_ASSERT_INTEROP_SAFE` that checks types for trivially-copyable and standard layout which are required for interop safety. - OVCC-1232: `carb.crashreporter-breakpad.plugin`: Added `/crashreporter/pythonTracebackArgs` (defaults to `dump --nonblocking --pid $pid`) that can be used to override options to `py-spy`. - OM-92726: Add OMNI_KIT_ALLOW_ROOT=1 env var as an alternative to –allow-root for kit executable - OVCC-1221: Added some helper functions to `carb::ErrorApi`. - OVCC-1222: Added documentation around `omni.kit.app`, `omni.ext.plugin` and many other items in the `omni::kit`, `omni::ext` and `omni::extras` namespaces. ### Changed - OVCC-1222: POSSIBLY BREAKING CHANGE: Fixed a spelling error in the `prerelease` members of omni::ext::Version and omni::extras::SemanticVersion. - OVCC-1221: `carb.filesystem`: Eliminated all info, warning and error logs. Instead, error states are set through `carb::ErrorApi`. Documentation indicates what error states are set by which functions. - OVCC-1216 / OM-90179: The Carbonite framework no longer spams “pluginA is already a dependency of pluginB” when plugins are repeatedly acquired. However, if a plugin is acquired a significant number of times, a performance warning will appear recommending use of `getCachedInterface()`. ### Fixed - OM-86228: `carb.launcher.plugin`: fixed support for launching detached child processes. Previously a zombie process was left on Linux that needed to be externally cleaned up. A detached child process now launches as an orphaned grandchild - OM-92725: Fixed a process that is automatically cleaned up by the terminal session or initd. - OM-92726: Fixed regression to use only the first positional argument to kit executable as an app file. - OVCC-1221: `carb.filesystem`: `getModTime()` was fixed to match `getFileModTime()`, and `getCreateTime()` was fixed to match `getFileCreateTime()`. - OVCC-1229: `omni.telemetry.transmitter`: added the missing `libjemalloc.so` files to the `telemetry_transmitter` package. The same files were also added to the `carb_sdk` and `carb_unittests` packages. - OVCC-1229: `omni.telemetry.transmitter`: fixed an issue with `omni::extras::UniqueApp` that could cause guard files to fail to be created if the requested directories do not exist. This now makes sure to create all directories in the given path when creating guard lock files. - OVCC-1213: `carb.tasking.plugin`: Fixed a rare race condition that could lead to a hang or crash if `ITasking::reloadFiberEvents()` is called from multiple threads simultaneously. - OM-93618: Linux: Removed `jemalloc` as it could cause some crashes. ### 146.0 #### Added - OM-89427: Linux: Executables now use `jemalloc` for better heap performance. - OM-89273: `omni.structuredlog.plugin`: added support for getting privacy setting in `privacy.toml` from environment variables instead of just fixed strings. The settings in this TOML file can now have values like `$env{<envvar_name>}` to specify that their value should come from an environment variable. - CC-1206: `carb.crashreporter-breakpad.plugin`: added a “[crash]” tag to each log message for the handling of a current crash and a “[previous crash]” tag to each log message when uploading old crash reports so they can be easily and explicitly differentiated in a log. - OVCC-1214: `carb::delegate::RefFromDelegate<>` and `RefFromDelegate_t<>` were created in order to specify the type of a `DelegateRef` from a `Delegate`. - CC-1202: Implemented `carb::cpp20::span<>` which is a C++14+ implementation of `std::span` that is mostly compatible with the C++20 version, and also ABI safe. It also implements the C++23 requirement that it be trivially copyable and therefore is also interop-safe. This class is also available as `omni::span<>` and has MSVC visualizers. - CC-1193: `carb.crashreporter-breakpad.plugin`: added the process launch command line to the crash report metadata. Any paths in the command line will be scrubbed of usernames. - CC-1193: `carb.crashreporter-breakpad.plugin`: added the current working directory to the crash report metadata. Any usernames will be scrubbed from expected path components. - CC-1193: `carb.crashreporter-breakpad.plugin`: optionally added the environment block to the crash report metadata. Any detectable usernames will be scrubbed from the variable values. This is enabled with the boolean setting ‘/crashreporter/includeEnvironmentAsMetadata’. This setting defaults to ‘false’. - CC-1138: Added `carb::ErrorApi`, the low-level unified layer for propagating errors across modules and programming languages. High level (C++ and Python) utilities that are easier to use will be coming in a future release (soon). - OVCC-1201: `carb.crashreporter-breakpad.plugin` at crash time will run `py-spy` (if present) to capture python traceback information about the crashing process, which is then uploaded as a file to the crash server. - OM-74259: `omni.kit.app`: add `IApp::restart` API to restart the application. - OM-54868: `omni.ext.plugin` adds the `uninstallExtension` API. ## Changed - POSSIBLY BREAKING CHANGE: CC-1199: `omni.bind` no longer requires an empty “Dummy.cpp” file on Windows; it is no longer packaged with the `carb_sdk` and `carb_sdk+plugins` packages. On Linux, an empty file is still required but this file has been renamed to `Empty.cpp`. - OM-89273: changed the behavior of `carb::extras::EnvironmentVariableParser` so that if no prefix string is given, all environment variables get stored as normal environment variables instead of pathwise overrides. - `carb.profiler-tracy.plugin`: Updated to use Tracy v0.9.1. NOTE: Viewers will need to update to the same binary version in order to accept and view captures. - CC-1207: `omni.telemetry.transmitter`: the ‘default’ transmission protocol of the transmitter has now changed such that the ‘data’ field of each event is not converted to a string value before sending to the endpoint server. A new protocol mode called ‘dataWithStringify’ has been added to retain the previous behavior. This can be set using the ‘/telemetry/eventProtocol’ or ‘/telemetry/transmitter/ /eventProtocol’ settings. - CC-1211: Windows: Error messages for failing to load plugins or extensions have been improved when it is suspected that the failure is due to a dependent library. Improved documentation for `carb::extras::loadLibrary()`. - Call `ITasking::reloadFiberEvents` in the startup functions of `carb.profiler-cpu.plugin`, `carb.profiler-nvtx.plugin`, and `carb.profiler-tracy.plugin` so they still work correctly when loaded on demand, as opposed to only at app startup. ## Fixed - OM-90424: Fixed the `config` token set in `omni.kit.app` incorrectly resolving to release for debug builds on Linux. - OM-90358: `carb.crashreporter-breakpad.plugin`: avoided calling `abort()` in the termination handler since it can cause up to two extra unnecessary crash reports to be generated and uploaded. - CC-1210: `omni.structuredlog.plugin`: made retrieving the privacy settings safer, especially if a value in the given privacy file has the wrong inferred type (ie: a boolean instead of a string). - `carb.profiler-mux.plugin`: Fixed race condition when appending new profilers while another thread iterates over them. - OM-91369: `Empty.cpp` is now packaged along with omni.bind for MacOSX packages. - OVCC-1214: Fixed an issue with `carb::delegate::DelegateRef<>` whereupon destruction it would unbind all elements from the referenced `carb::delegate::Delegate<>`. - OVCC-1212: Load hooks are no longer called with the Framework mutex locked in order to prevent deadlocks where another thread may be waiting on the Framework mutex, but a load hook is waiting on that other thread. However, load hooks must still complete before any attempts to acquire that specific interface return. - CC-1212: `carb.crashreporter-breakpad.plugin` now uses cached interfaces instead of acquiring interfaces when settings change. This can help prevent deadlocks involving the Framework mutex. - omni.ext: Create cache path anyway even when mkdir ext folders is disabled. - omni.ext: Remove progressbar from extension packing/unpacking code (speedup). - OVCC-1219: `carb.crashreporter-breakpad.plugin`: all metadata and extra files key names will now be sanitized regardless of whether they come through a command line setting, config file, direct change to the settings registry, or one of the `carb::crashreporter::addCrashMetadata()` or `carb::crashreporter::addCrashExtraFile()` helper functions. ## 145.0 ### Added - CC-1176: `carb.tasking.plugin`: Added `ITasking::reloadFiberEvents()`, a safe method to reload `IFiberEvents` interfaces. - CC-1137: `carb.crashreporter-breakpad.plugin`: allowed the crash reporter to enable its configuration functionality once the `carb.settings.plugin`. - The `carb::settings::ISettings` interface may not be available if the crash reporter plugin has been loaded (or another plugin that provides the `carb::settings::ISettings` interface). This can happen if the crash reporter plugin is loaded before the `carb.settings.plugin` plugin is loaded. ### Changed - CC-1198: On Windows, `kit.exe` is now known as “NVIDIA Omniverse Kit” instead of “NVIDIA Omniverse Carbonite SDK”. ### Fixed - OM-90036: Incorrect ternary logic when an optional `classDocstring` parameter is passed to `carb::defineInterfaceClass`. - CC-1204: The Carbonite dependency files now have an “alias” of the `python-3.10` dependency as `python`. This is temporary until Packman allows aliases. ### Added - OM-81978: New `carb.profiler-mux.plugin` that can be used to forward profiler events to multiple other loaded implementations of `carb::profiler::IProfiler`. - Add start_time and thread_id to Python get_profile_events, and add Instant and Frame events to monitor. - CC-1158: `carb.events.plugin`: - `IEventStream` objects can be created with a name. If a name is not provided, a name is generated based on the caller of the creation function. The name can be retrieved via the `getName` function. - `ISubscription` objects now generate a name based on the module that contains the `onEvent` function if a name is not provided. The name can be retrieved via the `getName` function. - Profiling of event notification now is more explicit and provides the name of the `IEventStream` and each `ISubscription` as it is called, along with the `IEvent::type` field (which unfortunately is numeric as the string name is lost to hashing). - CC-1161: added methods of determining whether a given plugin or module is a debug or release build without needing to load up and interrogate the library. On Windows, the string “(Debug)” will show up in the “Product Name” field of the module’s property window (“Details” tab). On Linux, the `g_carbIsDebugConfig` symbol will be present in debug modules and `g_carbIsReleaseConfig` symbol will be present in release modules. - CC-1153: Added kit-kernel plugins `omni.kit.app.plugin` and `omni.ext.plugin` and launcher executable `kit`. - OM-88365: Added optional `classDocstring` parameter to `carb::defineInterfaceClass`. - CC-1188: `omni.platforminfo.plugin`: added support for detecting and handling processes running under compatibility mode on Windows 10 and up. `omni::platforminfo::IOsInfo` will now report as close to the actual OS version as it can even when running under compatibility mode. ### Changed - CC-1144: Telemetry: updated the default transmitter schemas packages download URLs. - CC-1159: `carb.tasking.plugin`: A task name can now be passed as a `Tracker` to make task naming easier. - CC-1149: StructuredLog: failed early during prebuild if the Carbonite package path passed to `setup_omni_structuredlog()` either doesn’t exist or doesn’t contain the tool at the expected subfolder. Previously this would only fail out at build time if the tool was missing. ## carb.dictionary.plugin: New verbose printout on un-subscribing of a subscription with a list of remaining subscriptions that are active. ### Standardized internally on `detail` for an implementation-specific namespace, as opposed to `details`. ## Fixed - CC-1174: Fixed a situation whereby the Framework would reject a default plugin even though it supported the requested version. - CC-1173: Fixed a compile issue on Clang where `include/carb/delegate/Delegate.h` did not `#include <memory>`. - CC-1160: Framework: fixed framework startup so that it can succeed even if no plugins are present. - CC-1177 / OM-86573: `carb.profiler-cpu.plugin`: Fixed a stack overflow crash that could occur if a frame contained too many dynamic strings. - OM-85428: Build: made the command line flag generation in `omni.bind.bat` files deterministic to avoid unintentional rebuilding of projects. - CC-1190: `carb.dictionary.plugin`: Fixed a potential assert (debug) or bad access (release) that could occur if multiple threads were iterating an item array. ## 143.0 ### Added - Added `CARB_FILE_DEPRECATED` to warn that a deprecated file has been included. This can be ignored by having `CARB_IGNORE_REMOVEFILE_WARNINGS` defined. - CC-1139: Added `CARB_NODISCARD_TYPE`, `CARB_NODISCARD_MSG`, and `CARB_NODISCARD_TYPE_MSG` to supplement the existing `CARB_NODISCARD` macro for decorating types, decorating functions with a custom message, and decorating types with a custom message, respectively. These fall back to their most reasonable approximation if the compiler does not support them. - CC-1117: Added a `carb.tasking.plugin` debug visualizer to `carb.natvis` for Visual Studio 2019+ that displays an aggregate view of task counts by task function (see `[task counts by function]` in the CarbTaskingDebug visualizer). - CC-1118: Prerequisites of a `carb.tasking.plugin` task are now visible in the tasks listed under the `[task database]` member of the CarbTaskingDebug visualizer (called `[prerequisite]`). - OM-66287: StructuredLog: added an optional process lifetime heartbeat event that can be emitted at regular intervals from `omni.structuredlog.plugin`. These heartbeat events are disabled by default but can be controlled using the `omni::structuredlog::IStructuredLogSettings2` interface (specifically the `setHeartbeatPeriod()` method). - CC-1151: Windows crash dumps will included unloaded module info, which will aid debugging when a crash occurs in an unloaded module (such as when a callback is called but the module has been unloaded). - CC-51: `carb.tasking` now provides `carb::tasking::ITasking::nameTask()` which allows naming a task. The task name shows up in debug information and is retrievable with `getTaskDebugInfo()`. - `include/carb/memory/Utils.h` now has `carb::memory::protectedMemmove()` and `carb::memory::protectedStrncpy()`, which are implementations of `memcpy()` and `strncpy()` (respectively) that will return `memcpy()` and `strncpy()`. - CC-1141: StructuredLog: allowed all event output to be written to stdout or stderr using the `/structuredLog/defaultLogName` setting and a value of either `/dev/stdout` or `/dev/stderr`. When used, all events will be redirected to the specified stream regardless of per-event or per-schema settings. - Removed: - The following public items were determined to be internal to Carbonite only and have been removed: - `omni::log::configureLogChannelFilterList()` - `omni::log::registerLogChannelFilterList()` - `omni::log::ILogChannelFilterList_abi` - `omni::log::ILogChannelFilterList` - `omni::log::ILogChannelFilterListUpdateConsumer_abi` - `omni::log::ILogChannelFilterListUpdateConsumer` - `omni::log::WildcardLogChannelFilter` - Associated Python bindings for the above - Changed: - DEPRECATED: The following include files have been marked as Deprecated and may be removed in the future: - `LogChannelFilterUtils.h` - `WildcardLogChannelFilter.h` - CC-1113: `carb.dictionary.plugin` keeps child keys in the same order as they are created via `createItem`, `update`, or `duplicateItem`. The `IDictionary` interface was changed to version 1.1 to reflect this. - CC-1113: `carb.dictionary.serializer-json.plugin` and `carb.dictionary.serializer-toml.plugin` were changed to SAX-style parsing, so that keys encountered are pushed into `carb.dictionary.plugin` in the order specified in the data. - CC-1117: `carb.tasking.plugin` now considers the `debugTaskBacktrace` setting to be on by default. - All non-generated public include files now use relative paths - CC-1147: Amended coding standard on thread-safety, internal code, and other practices. - Fixed: - OM-71761: updated to openssl 1.1.1t, fixes CVE-2023-0286 for omni.telemetry.transmitter - OM-80517: Linux: Fixed some issues that could lead to deadlocks when running on Centos7 (glibc 2.17) - CC-1113: Log filters (specified in settings under `/log/channels`) are now processed in order, provided that the underlying `IDictionary`, `ISettings`, and `ISerializer` interface(s) respect order. Note that the Carbonite-provided `carb.dictionary.plugin`, `carb.dictionary.serializer-json.plugin`, `carb.dictionary.serializer-toml.plugin`, and `carb.settings.plugin` all respect order. The logging system now automatically monitors the `/log/channels` settings key and processes changes as they occur. - Fixed and improved several visualizers for Carbonite types listed in `carb.natvis` (for Visual Studio 2019+). Carbonite types and members that have visualizer support are now tagged with `CARB_VIZ`. - OM-79835: omni.bind: Avoid touching .gen.h files when contents haven’t changed. - CC-1154: Fixed issues with public include files compiling on GCC 8, such as ### 142.0 #### Added - OM-81922: updated to repo_build 0.29.4 to preserve symlinks when copying in premake - OM-59371: Requested feature to stop all voices `IAudioPlayback::stopAllVoices`. - CC-1087: New carb.audio-forge setting: `/audio/allowThreadTermination`. Forge will attempt to terminate its own threads if they’re detected to be hanging as a result of watchdog timers expiring. Terminating threads is not safe and may cause a crash/hang later on. Setting this to `false` will switch the behavior to abort when the watchdogs expire. This is intended to be set to `false` during tests to avoid a terminated thread resulting in a deferred crash. - CC-241: Added `omni::function`, an ABI safe drop-in replacement for `std::function`. Support for `omni::function` callbacks in ONI will be added in CC-1131. - Added a `carb.natvis` visualizer for `omni::string`. #### Changed - CC-1104: `carb::IFileSystem::subscribeToChangeEvents()` on Mac OS now uses the `FSEvents` backend. This should have a lower performance overhead and modify events are no longer dependent on filesystem timestamps. The timing and ordering of events may change as a result. This also limits the maximum number of file subscriptions to ~512. - OM-80477: allowed the structured log session ID to be retrieved without a consent check. #### Fixed - OM-81171: Fixed several issues stemming from shutdown when started by Python. - CC-1116: removed a hard link dependency on X11 in `omni.platforminfo.plugin`. The required functionality is now dynamically loaded from that library instead. - CC-1126: Implemented a workaround for shutdown crashes on Linux where `exit()` is called before the Carbonite framework is shut down. The Framework now attempts to register late `atexit()` handlers and shut itself down in the event of an unexpected `exit()`. - OM-81172: Linux: Fixed an issue with using the Carbonite allocation functions in a module that was not explicitly linking against `libcarb.so` that could lead to crashes if the symbol was not found. - CC-1112 and CC-1120: The GCC warning `noexcept-type` was producing false positives on `carb::cpp17::invoke` family functions when compiling in C++14 mode. This add the macros `CARB_DETAIL_PUSH_IGNORE_NOEXCEPT_TYPE` and `CARB_DETAIL_POP_IGNORE_NOEXCEPT_TYPE` to assist in disabling this warning when it is appropriate and fixes `invoke` family of functions when using `noexcept`-specified function pointers. ### 141.0 #### Added - CC-1078: Carbonite, through a new macro `CARB_PLUGIN_IMPL_EX`, now has the ability for a plugin to support multiple versions for a given interface. The Framework also has the ability to serve multiple versions of itself, allowing for future change without breaking already-built plugins. See the Carbonite Interface Walkthrough documentation for more ## Added ### Changed - CC-1078: Framework version has been changed to 0.6. The previous Framework version 0.5 is still supported, but plugins built after this version will not be compatible with earlier versions of Carbonite. - CC-1107: Attempting to load a Carbonite plugin with the same name as an already loaded plugin will now produce a warning log (instead of error) and will now return `carb::LoadPluginResult::eAlreadyLoaded` instead of `carb::LoadPluginResult::eFailed`. - CC-1107: Attempting to load an already-loaded ONI plugin with `carb::Framework::loadPlugin()` will now return `carb::LoadPluginResult::eAlreadyLoaded` and will no longer log that the dynamic library remains loaded after unload request. ### Fixed - CC-1098: Fixing passing the errorlevel through to the build system when the called-python routines return an error. - CC-1103: Fixed an issue with packaging on Mac that was excluding python bindings. - CC-1086: Removed use of Carbonite logging in Breakpad Crash Reporter. Logging here can cause deadlock while crashing if a thread was logging and held the lock while crashing (noticed in OM-78013). - CC-1108: A Linux system that cannot create any more inotify instances when `carb::filesystem::IFileSystem::subscribeToChangeEvents` is called will now fail gracefully with a warning message instead of crash. - CC-1110: Fixed undefined reference linker errors that could occur in C++14 with header-only utilities on GCC, including `Path.h`, `RobinHoodImpl.h`, and `Utf8Parser.h`, due to `static constexpr` members within classes. ## 140.0 ### Added ### Changed - CC-1088: updated to `repo_build` 0.28.12 to generate `compile_commands.json` on MacOS. - CC-1085: bump all Conan dependencies for updated metadata. - For `carb.crashreporter-breakpad.plugin`: - CC-1065: flattened the folder structure in zip files for crash reports. All filenames in the flattened zip archive are also ensured to be unique. - CC-1065: added a manifest to crash report zip files that lists each file’s original location and upload key name. - CC-1073: prevented preserved crash dumps from being re-uploaded. - OM-18948: Detect incorrect usage of `ObjectPtr` at compile time rather than runtime. Note, this may cause hand written ONI Python bindings to have to be re-written (i.e. use `omni::python::detail::PyObjectPtr` rather than `omni::core::ObjectPtr`). ### Fixed - CC-1068: Fixed `carb.datasource-file.plugin`’s `readData` and `readDataSync` functions not working properly on Mac. - CC-1077: Fixed an issue with `carb::extras::Path` where `replaceExtension` would crash in Linux on startup in debug builds. - CC-1065: fixed some potential zip file corruption in crash reports generated by `carb.crashreporter-breakpad.plugin` related to storing 0 byte files and missing files. - CC-1055/CC-1089: Updated to Python 3.7.15, 3.8.15, 3.9.15, 3.10.8 and zlib 1.2.13-1 to fix security issues. - CC-1072: Fixed two issues when fetching environment variables on Windows. Fetching a zero-sized value will no longer read uninitialized stack data. Fetching a value larger than 256 wide characters is no longer subject to a race condition if the environment variable changes between the size query and data fetching. - CC-1099: fixed the detection of the Windows 11 OS display name in `omni.platforminfo.plugin` on machines that were # 139.0 ## Added - CC-1064: added options to the `omni.structuredlog` tool to allow it to skip the code formatting step. - added the `--skip-structuredlog-format` option to the `build.{sh\|bat}` scripts and the `premake5` tool. - added the `skip_format` boolean argument to the `omni_structuredlog_schema()` project function. - added the `--skip-format` option to the `tools/omni.structuredlog/omni.structuredlog.py` script. - OM-43302: Extended support for setting and querying the maximized/minimized/restored state of a glfw window. - CC-1060: Added more verbose logging to `carb::Framework::releaseInterface()` to log which plugins still have references to an interface. - CC-615: Preliminary VulkanSDK support for MacOS ## Changed - Corrected the spelling of `omni::core::GetModuleDependenciesFn`. While this is a public symbol it should not affect ABI and its use is generally confined to macros whose names did not change. ## Fixed - CC-1057: Fixed some constructors in `carb::ObjectPtr` and `carb::container::BufferedObject` to not be `explicit` as these potentially lead to compilation warnings/errors in C++17. - OM-74155: Fixed an issue on Linux where walking a directory on XFS filesystems would sometimes not properly identify the type of a file/directory. - CC-1060: Fixed an issue where releasing interfaces from a script binding would not actually release the interface. - CC-1012: Fixed an issue where ONI modules did not properly initialize the Carbonite profiler. # 138.0 ## Added - OM-58581: The new carb.audio bindings are now available in python versions prior to 3.10. ## Changed - CC-629: updated to glfw-3.3.8, removed dynamic glfw libs ## Fixed - CC-1031: Fixed an issue where outputting a structured logging event to a standard stream would unintentionally close the stream. This fix also ensures that the stream is flushed before continuing with the next message. - CC-1046: Fixed an issue where `carb::Framework` would not be `nullptr`-padded, so functions added to the Framework later would be garbage data instead of `nullptr`. - CC-1046: Fixed an issue where older Carbonite releases (pre v135.0) would crash when compiled against newer headers (v135.0 and later). - CC-1052: `carb::container::LocklessStack` on Linux is no longer lockless as registering multiple signal handlers in multiple dynamic libraries became untenable. # 137.0 ## Added - CC-448: `carb.variant.plugin` now supports a `VariantMap` type: an associative container with `Variant` keys and values that can be itself passed as a `Variant`. ## Changed - CC-1027: `CARB_EXPORTS` (note the S) is no longer required to be defined in order for `CARB_EXPORT` to export a function. This was the cause of much pain and lost hours. Now, `CARB_EXPORT` always exports a function, which is the typical need for functions like `carbOnPluginStartup()`. The rare case of needing dynamic import/export is now handled by a new macro– `CARB_DYNAMICLINK` –which will export if `CARB_EXPORTS` is defined before `carb/Defines.h` is included, but otherwise imports (the default). - CC-949: updated some packages to get several CVE fixes: - updated to zlib 1.2.13+nv2. - updated to OpenSSL 1.1.1q+nv7. - updated to libcurl 7.85.0+nv3. - CC-1034: changed code generated by `omni.structuredlog` so that it now uses references to objects instead of pointers when passing to the various ‘send event’ functions. This allows for easier access to inlined calls to emit messages instead of having to declare local variables for the object parameters. This also included generating default, basic, and copy constructors for each generated object struct as well as an assignment operator to make it easier to construct objects inline in the event helper macros. - CC-1031: added support for writing structured log messages to stdout and stderr. The `fFlagOutputToStderr`, `fFlagOutputToStdout`, and `fFlagSkipLog` schema and event flags have been added to allow structured log events to be output to the stdout and stderr streams either in addition to the normal log or to exclude the output to the normal log. ## Fixed - CC-1029: If functions were added to an interface without changing the version, newer code that conditionally checked for the functions when running against an older version of the plugin (with a compatible version but without the functions) would see uninitialized memory instead of `nullptr`. This has been fixed: the Framework now keeps a null region large enough for 32 functions following any interface memory so that reading beyond the end of it will show null function pointers for new functions. - CC-1034: Fixed a code generation bug with the `omni.structuredlog` tool. If a property in an object property specified in a schema contained a character that is not valid in a C++ symbol, invalid C++ code would be generated. This bug did not occur on property names that were outside of objects however. - CC-47: Fixed potential deadlocks that could occur if multiple threads were acquiring interfaces at the same time. - CC-1039: To mitigate an issue that could potentially cause a dangling pointer crash in `deregisterLoggingForClient()` if `ONI` was stopped and restarted without unloading all plugins, stopping `ONI` (i.e., with `OMNI_CORE_STOP()`) will now unload all plugins. - CC-1023: The `no_acquire` keyword tells `omni.bind` that the returned pointer has not had `acquire()` called on it and `ObjectPtr` should not be used in the API layer. Additionally, methods that end with `WithoutAcquire` will also use raw pointers rather than `ObjectPtr` on the returned pointer. `no_acquire`/`WithoutAcquire` are dangerous but useful in hot code paths where the cost of atomically incrementing the reference counts degrades performance. - CC-1025: `omni.bind` now supports the `ref` attribute on both return types and parameters. `ref` converts pointers in the ABI layer to references in the API layer. - CC-1021: `omni.bind` now supports `throw_result` attribute on methods. When used, this attribute will throw an exception in the API layer when the ABI layer returns a bad `Result` error code. This attribute can be combined with the `return` attribute (on a parameter) to return a value in the API layer instead of the ABI layer’s `Result`. - CC-1024: `build` now supports building all flavors of Python bindings. Before the user had to build each binding individually: ```bat build -t bindings\carb.python-3.9 && build -t bindings\carb.python-3.10 && ... ``` Now: ```bat build -t bindings\carb.python ``` - Added many `omni::core::Result` codes. - `ObjectParam` can now be used as a boolean. ### Changed - OM-70174: updated to the latest `concurrentqueue` package to fix some include issues in Kit and Carbonite. ### Fixed - CC-889: Fixed `carb::filesystem::IFileSystem::unsubscribeToChangeEvents()` so that it is possible to unsubscribe from within the subscription callback. - `omni.bind` no longer produces optimization warnings. - `OMNI_ASSERT` messages now include the filename. - Fixed ambiguous pointer to `ObjectParam` casts. - Removed troublesome usage of `OMNI_DECLARE_INTERFACE` in `ILogChannelFilter.h`. - Function/Methods in `IObject.h` now have correct `noexcept` specifiers. ### Added - CC-883: The `carb.tokens.plugin` plugin now supports environment variable replacement via tokens named `${env.<name>}`. - CC-63: Profiler channels have been added! Profiler channels can be configured at runtime via the `ISettings` system and can be used in place of masks anywhere. Use `CARB_PROFILE_DECLARE_CHANNEL` to declare a channel, and then it can be turned on/off (even at runtime) with `/profiler/channels/<name>/enabled`. Internally Carbonite’s profiling has changed to use channels with the following names (corresponding to plugins): - carb.assets - carb.eventdispatcher - carb.events - carb.scripting-python - carb.tasking - carb.windowing-glfw ## Changed - CC-1015: silenced a warning message in `carb.audio` that can occur while enumerating capture devices on a system that does not have a microphone. Also downgraded several error messages around device enumeration to warnings. ## Fixed - CC-1011: Fixed an issue where `carb::cpp20::countl_zero()` and `carb.tasking.plugin` would not run properly on pre-Haswell Intel CPUs. ## 134.0 ### Added - OM-58581: Added bindings to carb.audio to add support for modifying carb.audio.Voice parameters, as well as the ability to play sounds from python. This functionality will not be available with versions of python prior to 3.10. - CC-1010: Added support for compressing crash dumps and crash report extra files for upload on all platforms. The crash report files will all be compressed into a single standard .zip file and only that .zip file will be uploaded. This feature is enabled with the `/crashreporter/compressDumpFiles` setting. Note that the server side must also support receiving zipped crash reports before this can be enabled. - CC-206: `ITasking` can now be used with `omni.experimental.job.plugin` providing the underlying thread pool. This is enabled by setting `/plugins/carb.tasking.plugin/useOmniJob` (default: `false`) to `true`. This allows other systems to also share worker threads by using `omni.experimental.job.plugin`. ### Changed - OM-57542: Updated ImGui version and added necessary package references. Added premake5 section for building SimpleGui plugin on MacOS. Changed SimpleGui’s renderer to support 32-bit indices. ### Fixed - CC-249: fix comparison bug so that CC-249 is really fixed. - OM-58581: Fixed an out of bounds read in a `CARB_ASSERT()` statement in carb.audio. - CC-1006: Fixed the quick shutdown process so that it properly shuts down structured logging. - CC-860: Added support for uploading extra files with Carbonite crash reports. New files are added to the upload with `carb::crashreporter::addExtraCrashFile()`. Files are only uploaded if a crash occurs. - CC-1009: Fixed `carb::container::LocklessStack` on Linux to try and avoid crashes when modules that use `LocklessStack` are unloaded in an order that is not the reverse of load order. ## 133.0 ### Added - OM-62703: added `CARB_PLATFORM_NAME` containing the name of the current platform and `CARB_ARCH_NAME` containing the name of the current architecture. - OM-62703: added some new flags to `carb::extras::loadLibrary()` to expose some extra library loading behavior on Linux. - CC-879: added a new version of `carb.scripting-python.plugin` that supports python 3.10. These are in subdirectories in the binaries directory which are labeled `scripting-python-[version]`. Loading multiple python versions in a single process is dangerous, so it’s not possible to load multiple of these plugins simultaneously and not recommended to try to unload one and load another. - OM-63213: added `omni::platforminfo::IMemoryInfo::getProcessPeakMemoryUsage()` and `carb::extras::getPeakProcessMemoryUsage()`. - OM-63213: added `omni::platforminfo::IOsInfo::getKernelVersion()`. - carb::dictionary::ISerializer has an updated createDictionaryFromStringBuffer() function with more options that can produce better performance. The ABI supports the previous function, but new compilation will use the new function. ### Changed - BREAKING CHANGE CC-879: carb.scripting-python.plugin was moved into the scripting-python-3.7m subdirectory in the binaries directory. - CC-891: carb.tasking.plugin is now a task-stealing scheduler that scales better with more cores. Other changes: - The watchdog functionality has been split from the timer thread into its own thread. - Instead of one (potentially giant) thread pool, threads are divided up into thread-groups with four threads ideally. - When a task is added, a thread-group is chosen and assigned the task. If the thread-group has too much work, other thread-groups are woken and will try to steal tasks. - Resuming tasks now respects priority order. - Resuming a task that is pinned to a specific thread is more efficient. ### Fixed - OM-62819: Fixed a performance issue in carb.profiler-cpu.plugin that was making it unusable in certain cases. - OM-62523: Addressed some docstrings that error when consumed by Sphinx. - CC-879: Fixed a bug where IScripting::getObjectAsString() was not acquiring the GIL. - CC-948: Fixed a hang that could occur if a log listener called back into the framework while the framework was loading a plugin. - CC-988: Fixed an issue where a deadlock could occur if a log listener attempted to acquire an interface. - CC-988: Fixed a compilation warning that could occur in TaskingHelpers.h. - OM-63659: Fixed an issue with carb.tasking where a stuck condition would be improperly realized and emergency threads started unnecessarily. - CC-996: Improved performance of carb.dictionary.serializer-json.plugin and carb.dictionary.plugin in some cases, especially with large JSON files. ### 132.0 #### Added - CC-868: added support for bindings for python 3.10 with pybind11 2.7. The pybind11 internals ABI has changed, so if you want to add pybind11 bindings on top of the Carbonite bindings, you will need to upgrade to an ABI compatible pybind (such as 2.7.1-08fa9f60). #### Changed - BREAKING CHANGE The CARB_PROFILE_FRAME() macro no longer increments IProfileMonitor frames for last-frame events. This is because CARB_PROFILE_FRAME() now supports multiple frame-sets (i.e. main thread and GPU thread). Instead, please call IProfileMonitor::markFrameEnd() to increment a frame for the Profile Monitor. - CC-868: The include path to pybind11 needs to be added on the build command line when building python bindings with Carbonite’s binding utilities headers. These previously required an include path pointing into the target-deps directory. - CC-868: Some workarounds for -Wundef errors in pybind11 2.3 have been removed because they break pybind11 2.7. The suggested fix is to disable -Wundef until you can upgrade to 2.7. - CC-902: Built-in plugins (ILogging, IAssert, IThreadUtil, IFileSystem) are now always installed the first time the framework is acquired, and are not unloaded via Framework::unloadAllPlugins(). They are only unloaded when the framework is released. - CC-918: removed the carb.ecs plugin, along with all of its headers, tests, and projects. This plugin was not used in any projects and has long since been superceded by other projects. - CC-919: removed support for hot reloading C++ plugins. This feature was untested and unused and has become bit rotted. ## Fixed - CC-907/OM-60787: Fixed an issue that could cause plugins to unload in an incorrect order. - CC-902: Calling `carb::acquireFrameworkAndRegisterBuiltins()` multiple times is now safe and will no longer result in error logs. - CC-880: `carb.profiler-cpu.plugin`: `CARB_PROFILE_FRAME()` now outputs an event to the chrome-tracing file to mark the frame end. When a subsequent Tracy PR is merged, Tracy’s import-chrome tool will be able to translate these events into frame markers. - CC-913: Fixed a rare bug in `carb::extras::HandleDatabase` that could lead to rare crashes in `carb.tasking`. - CC-915: Fixed an issue with `carb.profiler-tracy.plugin` where the Tracy viewer gets confused with too many source locations. - CC-954: Fixed a problem with the RobinHood container hashing that was causing compilation issues on clang 14. ## Added - CC-864: Added lock profiling interface, which is currently only used by `carb.profiler-tracy.plugin`. - CC-848: Several performance improvements were made to `carb.profiler-cpu.plugin`. - CC-862: Completed the `invoke`-family functions and meta queries (`invoke_r`, `is_invocable`, `is_invocable_r`, `is_nothrow_invocable`, `is_nothrow_invocable_r`) and added requisite utility meta query `is_nothrow_convertible`. These behave according to the rules in the current (as of August 2022) C++23 Standard Draft, but reside in the `carb::cpp17` namespace, as that is when the functionality was introduced to the C++ Standard. - CC-372: Added a setting `log/forceAnsiColor` that allows the user to force the logger to use ANSI escape codes to color the console. Useful for CI/CD settings. - CC-853: `carb.tasking.plugin` has a function that will bind trackers to a required object: `ITasking::bindTrackers()`. ## Changed - `carb.profiler-cpu.plugin` no longer exports Chrome Tracing Flow events by default. They can be enabled with setting key `/plugins/carb.profiler-cpu.plugin/flow` (boolean, default: `false`). - CC-848: `carb.profiler-cpu.plugin` now emits additional profiler zones for itself (profiling the profiler) if `carb::profiler::kCaptureMaskProfiler` is set in the capture mask. - CC-848: Some of the `carb.tasking.plugin` profile zones are now static names instead of dynamic names to save time capturing these profiler zones. (Example: “Running fiber 123” is now just “Running fiber”). - Upgraded `carb.profiler-tracy.plugin` to Tracy 0.8.2. - CC-658: Removed `carb::thread::getCurrentProcessor()`. The only reasonable use of this function was in tests for thread pinning utilities, so the decision was made to remove it. ## Fixed - CC-854: Fixed locking that could lead to a performance issue with `carb.settings` and `carb.dictionary`. - CC-64: Performance is improved when `carb.profiler-cpu.plugin` is loaded but not started or has a capture mask of `0`. - CC-855: Fixed a rare crash that could occur if `carb.profiler-cpu.plugin` was started and quickly shutdown. - CC-886: Added the missing `ChangeEventType.CREATED` type to - carb.settings python bindings. - CC-862: carb::cpp17::invoke_result to be SFINAE-safe. Previously, when the F(Args...) signature was not invocable, it was an error in the immediate context. - CC-857: Fixed an issue with carb.profiler-tracy.plugin where CARB_PROFILE_END() would still pay attention to the mask and could potentially cause profile zones to become out of sync. Applied the same fix from CC-603 to the Tracy profiler. - CC-881: Fixed an issue with carb.profiler-tracy.plugin where profiler zone source location could be duplicated. - CC-537: Fixed omni.structuredlog python code generation. ### 130.0 - Changed - CC-684: Failing to close a file will now report the file that failed to close and the underlying error. - CC-817: Non-quick shutdown returns back to two phases: the first phase is shutting down all plugins, followed by unloading all plugins. - CC-847: (Windows only) As a performance improvement, OutputDebugString is no longer called by default for log messages unless a debugger is attached. Calling StandardLogger::setDebugConsoleOutput(true) will force debug output even when a debugger is not attached. - Fixed - CC-817: Fixed an issue where interfaces are released before a plugin is shutdown. In some cases (such as carb.tasking.plugin) this can result in the interface being re-instantiated while shutting down. - Fixed verbose log spam in carb.settings.plugin ("node type mismatch" logs when a key did not exist). - Fixed verbose log spam in carb.audio-forge.plugin ("{context = xxx}" logs when updating a context). ### 129.0 - Added - Warning logs are now emitted when a plugin unload is requested but the module is not unloaded. - Support for limiting the zone depth of a profile capture taken using the carb.profiler-cpu.plugin. The max zone depth can be set via the new /plugins/carb.profiler-cpu.plugin/maxZoneDepth setting. - Changed - The CARB_BINDINGS() and CARB_BINDINGS_EX() macros take an additional optional parameter that is the string of the script language that the binding is for. If unspecified, "python" is assumed. - CC-808: carb::quickReleaseFrameworkAndTerminate() no longer runs carbOnPluginShutdown() for plugins that do not provide a carbOnPluginQuickShutdown(); only the carbOnPluginQuickShutdown() function is called if provided. This makes quick-shutdown significantly faster, but it is now highly recommended that all plugins that have files open for writing flush and close those files. - Fixed - CC-779: Python script bindings are now considered dependencies of carb.scripting-python.plugin and now attempt to unload carb.scripting-python.plugin before dependent interfaces to improve shutdown stability. - Fixed an issue with carb::extras::getLibraryHandleByFilename() that would leak shared object references on Linux. - Fixed an issue with carb.scripting-python.plugin leaking a reference to the python shared object on Linux. - Fixed an issue with omni.structuredlog.plugin where it would not be properly reset if the module failed to unload. - CC-781: Fixed an issue with carb::Delegate where parameters to Call() were improperly handled. - Fixed an issue where `std::move` was not correctly forwarded to the first receiver when multiple receivers were bound. - Fixed an issue where interfaces could be acquired (and plugins loaded) during a call to `Framework::unloadAllPlugins`. - Fixed an issue where shutting down the framework did not clear some state, causing inconsistencies and issues when the framework was later re-initialized. - Fixed a warning at shutdown from `carb.profiler-cpu.plugin` about “Failed to remove release hook”. - Fixed a rare thread-safety crash with `omni.structuredlog.plugin`. - CC-809: fixed the auto-detection of MP3 files with both the ‘error protection’ bit enabled and disabled. Previously, MP3 files with error protection enabled were failing to load. - CC-668: got `carb.launcher.plugin` building and passing all tests on MacOS. Some tests had to be disabled because MacOS doesn’t support the related functionality. ### 128.0 #### Added - CC-587: Basic support for Mac OS was added. - Carbonite binaries for Mac OS are not available yet. - `CARB_PLATFORM_MACOS` has been added for detection of Mac OS. - `CARB_POSIX` was added. This is set to `_POSIX_VERSION` on systems that are mostly-compliant with POSIX, such as Linux and Mac OS, and set to 0 on other systems, such as Windows. - `CARB_MACOS_UNIMPLEMENTED()` has been added to mark code paths that are not supported yet on Mac OS. If you want to use Carbonite extras headers on Mac OS, you can grep for this symbol to verify whether the extras header is supported on Mac OS yet. - OM-55766: - `OMNI_GENERATED_API` Helper macro to access generated API - `OMNI_USE_FROM_GENERATED_API` Helper macro to bring member functions from generated API when function overloads are provided. #### Changed - CC-705: reworked the telemetry transmitter so that it now stores the processed and validated message strings instead of the JSON documents themselves in the event queue. This significantly reduces memory usage for the transmitter. - CC-745: Unsuccessfully loading a plugin optionally (with `tryAcquireInterface`) will no longer produce any error logs. - CC-743: Fixed a performance issue with `carb::tolower` and `carb::toupper` on Linux. - CC-716: `carb::extras::convertUtf8ToWide()` and `carb::extras::convertWideToUtf8()` no longer use the deprecated C++ `wstring_convert` library and instead use our Utf8Parser library. This affects the failure condition of these functions. #### Fixed - CC-595: Use canonical paths in `omni::core::TypeFactoryImpl`. Prior to this commit, `omni::core::TypeFactoryImpl` would directly use the `moduleName` arguments provided to the `createType_abi`, `registerInterfaceImplementationsFromModule_abi`, and `unregisterInterfaceImplementationsFromModule_abi` functions. This caused an issue because `carb::FrameworkImpl::loadPlugins` would call `registerInterfaceImplementationsFromModule_abi` with the canonical path of the module, and then future calls to createType with the non-canonical version of the path to the same module would reload the module because the module name (which is the path) would not match. This commit fixes that by making the three API methods above convert the moduleName argument to a canonical path for consistency. - CC-747: Resolved a shutdown order issue with - CC-751: Upgraded openssl in omni.telemetry.transmitter to 1.1.1q to address CVE-2022-2068. - CC-772: Resolved an issue with plugin unload order not respecting dependencies correctly. - CC-622: Fixed `carb::extras::Path::getParentPath()` when resolving parent path’s with only 1 directory level. ### Added - CC-582: `carb::cpp20::atomic<>` now supports waiting for non-primitive (but `is_always_lock_free`) types. - OM-53429: Added settings and support to the telemetry transmitter to be able to filter out messages that came from host apps run in different modes (ie: ‘dev’ vs ‘production’ vs ‘test’). The `/telemetry/transmitter/messageMatchMode` setting is used to control this behavior. By default, all messages are allowed to pass through. - CC-510: Adds `omni::experimental::IUrl`, an RFC-3986 compliant URL implementation. It is currently experimental. - OM-45102: Added separate functions for trimming strings in a UTF-8 friendly way or by using current C locale. Helper function for finding the last Unicode symbol in a UTF-8 string. - CC-714: Added `carb::thread::hardware_concurrency()`, which is similar to `std::thread::hardware_concurrency()` but will take docker cgroups into account if running from within a docker container. - CC-705: added support for batching events when sending to NVDF backends. These will now send as many events as possible in a single HTTP request instead of sending each message individually. - CC-716: `convertUtf32ToUtf8()` now has flags which allow you to return U+FFFD on codepoint conversion failure. ### Changed - CC-632: `carb.tasking.plugin`: Evaluated how calling `ITasking::applyRange` recursively works, especially with non-uniform workloads. In some cases, performance improvements up to 67% were seen in tests with Kit. - OM-53429: Added a telemetry mode tag to each structured log message’s “source” field if running in “dev” or “test” mode. - CC-386: `omni.bind` now outputs a comprehensive diff when using `--fail-on-write` option alongside the error message. This should help debugging CI errors by eliminating the “What’s different?” question that requires a re-run in the environment the build failed in. - CC-705: changed the telemetry transmitter to limit the number of events that would be processed at any given time to help reduce the amount of memory used. Added the `/telemetry/transmitter/<index>/queueLimit` option to control the maximum number of events that can be processed at once. This new option defaults to 10000 events. In testing, this roughly corresponds to ~500-1000MB of memory usage. - CC-714: `carb.tasking.plugin` and `omni.job` now use `carb::thread::hardware_concurrency()` for default thread counts. - CC-560: Deprecated the old `kSerializerOption` flags and renamed them to `fSerializerOption` to better comply with the coding standard. The use of the old flags will have to be changed in any Carbonite based apps. ### Fixed - CC-603: Fixed issue where repeated profiler runs caused incorrect profile in second run onwards. This was caused by zones ends unintentionally matching partial zone begins from the previous run. Please note that this has been fixed for the cpu profiler ONLY (`/plugins/carb.profiler-cpu`). - OM-34980: Fixed an issue with command line array argument in the form `[a, b]` not replacing the whole previous array. - CC-628: Fixed a few more issues with `min`/`max` in public headers, as well as adding a compilation test to prevent future uses. - CC-625: `carb::framework::getPluginCount` returns only the count of carb plugins loaded. The change for CC-383 made `carb::framework::getPluginCount` return the count of all plugins. - OM-53428: Fixed the behavior of `carb::framework::getPluginCount` to only return the count of carb plugins. Previously, it would return the total number of carb and oni plugins, but `carb::framework::getPlugins` would only return carb plugins, leading to empty entries in the `get_plugins()` python function. This change restores the previous behavior. - OM-53429: Fixed an issue in `omni.telemetry.transmitter` where only the first transmitter would control whether the log directory was processed and whether events were uploaded. This has now been changed so that any transmitter that needs or can accept data will allow the logs to be processed and events uploaded. - CC-697: Fixed use-after-move issue in `carb::extras::EnvironmentVariable`. - CC-705: fixed the broken launch guard in the `omni.telemetry.transmitter` app. - CC-705: fixed the transmitter so that it no longer has the potential to resend events when multiple transmitter endpoints are out of sync. - CC-716: `convertUtf32ToUtf8()` is now implemented identically across all platforms. ### 126.0 #### Added - CC-505: `omni.telemetry.transmitter` now has the capability to send data to multiple endpoints at once. To do this, just make the settings key `/telemetry/transmitter` an array of objects. Each object will transmit to a separate telemetry endpoint. - The new setting `/telemetry/transmitter/retryLimit` has been added to allow the transmitter to handle offline telemetry endpoints more gracefully. - CC-505: `omni.telemetry.transmitter` can specify an array of telemetry endpoints with the setting key `/telemetry/transmitter/endpoint` to specify fallback URLs to if your main endpoint goes down. - CC-454, OM-28642: `omni.bind` diagnostic reporting has been re-done for a better experience when reporting things to the user. Multiple errors can be reported by a single run of the program as opposed to stopping at the first issue (some errors are still considered fatal and will halt execution immediately). Diagnostic messages are highlighted based on their severity if the output is a TTY. - CC-533: `carb::tasking::ITasking::applyRangeBatch` was added as a more tunable alternative to `applyRange` and reduces the function call overhead of `applyRange`. - CC-447: `carb.variant.plugin.dll` now supports `RString` / `RStringU` / `RStringKey` / `RStringUKey` as contained types. #### Changed - CC-505: The following omni.telemetry.transmitter settings have been updated to work better with the multiple endpoint system. The old settings will continue to work as long as the `/telemetry/transmitter` settings key is not set; if you use the new settings keys, you must upgrade all of your keys to the new system. - `/telemetry/resendEvents` => `/telemetry/transmitter/resendEvents` - `/telemetry/transmissionLimit` => `/telemetry/transmitter/transmissionLimit` - `/telemetry/endpoint` => `/telemetry/transmitter/endpoint` - `/telemetry/schemasUrl` => `/telemetry/transmitter/schemasUrl` - `/telemetry/authenticate` => `/telemetry/transmitter/authenticate` - `/telemetry/authTokenUrl` => `/telemetry/transmitter/authTokenUrl` - `/telemetry/authTokenKeyName` => `/telemetry/transmitter/authTokenKeyName` - `/telemetry/authTokenExpiryName` => `/telemetry/transmitter/authTokenExpiryName` - `/telemetry/eventProtocol` => `/telemetry/transmitter/eventProtocol` - `/telemetry/seekTagName` => `/telemetry/transmitter/seekTagName` - `/telemetry/authTokenType` => `/telemetry/transmitter/authTokenType` - `/telemetry/oldEventThreshold` => `/telemetry/transmitter/oldEventThreshold` - `/telemetry/ignoreOldEvents` => `/telemetry/transmitter/ignoreOldEvents` - `/telemetry/pseudonymizeOldEvents` => `/telemetry/transmitter/pseudonymizeOldEvents` The following settings have been deprecated. These settings will continue to work as-is, but they are no longer supported when using the `/telemetry/transmitter` settings key. To continue using this functionality, specify the directory or file in `/telemetry/transmitter/schemasUrl` with a `file://` prefix. - `/telemetry/schemaFile` - `/telemetry/schemasDirectory` ### Fixed - CC-514: The `g_carbProfiler` global variable is now automatically set to `nullptr` when the profiler is unloaded and/or the framework is released. Once `carb::profiler::registerProfilerForClient()` is called, a load hook is installed which will cause the `g_carbProfiler` global variable to be set for a module once the profiler module loads. Previously this global variable would be left dangling, potentially leading to crashes. A plugin or application need only be rebuilt to pick up this fix. - CC-585: Fixed an issue with `carb::hashPair()` where it would erroneously always return 0. - CC-593: Carbonite has changed its coding standard to not use keywords `min` or `max` in public headers and changed all existing places that previously used these keywords. This is an effort to prevent compilation issues when Windows.h is included without defining `NOMINMAX`. `::carb_min()` and `::carb_max()` have been added as alternatives to `std::min` and `std::max`, in `include/carb/Defines.h`. - CC-597: Build fix in `omni::core::PluginManager` ## 125.0 ### Added - CC-258: ONI Python bindings now support `omni::string` by conversion to Python-native `str`. - CC-520: Added python support for several `IProfiler` functions that were missing. - CC-506: Added “Robin Hood” open-addressing hash containers to `carb::container`: `RHUnorderedMap`, `RHUnorderedSet`, `RHUnorderedMultimap`, and `RHUnorderedMultiset`. While similar to the `std` unordered containers, they are not drop-in replacements, but should be useable in many cases. - CC-497: Added support for the new NVDF protocol for omni.telemetry.transmitter. Use the settings key `/telemetry/eventProtocol` to configure this. - CC-497: Added an option to specify the name for seek tag in omni.telemetry.transmitter. Use the settings key `/telemetry/seekTagName` to configure this. - CC-507: Removed some log messages in `ILauncher` that could lead to a deadlock in the child process. - CC-440: Added overloads to allow `carb::extras::Guid` to be used as a key in `std::unordered_map`. - CC-440: Added `IAudioDevice::getDeviceCapsByGuid()` and `IAudioDevice::getDeviceNameByGuid()`. - CC-440: Added example.audio.device to demonstrate usage of the `IAudioDevice` interface. - CC-513: Added a walkthrough document and related example app and plugin to demonstrate how to create and use a Carbonite interface. - CC-383: Added the ability for ONI plugins to declare dependencies, and for Carbonite and ONI plugins to depend on each other. `omni::bind` now generates an `OMNI_PLUGIN_INTERFACE` macro that defines the `getInterfaceDesc()` function, the same as carbonite interfaces. This allows for declaring dependencies to work the same between carb/omni. Omni modules can now export the function `getModuleDependencies` to declare their dependencies. Carbonite and ONI plugin dependencies are tracked together, to unload order can be guaranteed across frameworks. ### Changed - CC-520: For `carb.profiler-cpu.plugin`, the `CARB_PROFILE_FRAME` macro now ignores the `mask` parameter by default. This is an effort to make frame processing consistent no matter what capture mask is specified. This behavior can be returned to the previous behavior (where the `mask` parameter is considered) by setting config key `/plugins/carb.profiler-cpu.plugin/ignoreFrameMask` to false. - CC-497: Increased the omni.structuredlog log header size to 1024 when new log files are generated. Older versions of omni.telemetry.transmitter should continue to work with these longer headers. - CC-440: The audio example binaries have been renamed to better indicate which submodule they demonstrate. ### Fixed - CC-516: Upgrade to OpenSSL 1.1.1o to fix multiple CVEs. - CC-520: Fixed a race condition in `carb.profiler-cpu.plugin` where it was possible to immediately query `IProfileMonitor::getLastProfileEvents` after `CARB_PROFILE_FRAME` but not receive the previous frame’s information (instead it was still the frame-before-previous). ### 124.0 #### Added - CC-498: Added more debugging log output to ILauncher when a new child process fails to launch (as error or warning level messages) and when a new process handle is first created (as info level messages). Only launch descriptor values that differ from their defaults will be output. - CC-291: Added documentation for `/audio/nullBackend/CaptureTestMode`. - CC-291: Added `/audio/nullBackend/ReportsOverruns` for testing overrun detection in `IAudioCapture`. #### Changed - CC-478: On Windows, the memory functions (`carb::allocate`, `carb::deallocate`, and `carb::reallocate`) no longer require `carb.lib` to be linked in order to build; instead, by default they now find the underlying `carbReallocate` function from `carb.dll` at runtime. However, sometimes it is desirable to have `carb.dll` loaded implicitly. This is now accomplished by defining `CARB_REQUIRE_LINKED=1` before including `include/carb/Memory.h` and will also require linking against `carb.lib`. - CC-500: Changed the exit codes returned from `carb::launcher::ILauncher::waitProcessExit()` and from `carb::launcher::ILauncher::getProcessExitCode()` on Linux in the case of a crashed child process so that they return the same value that a shell would report in `$?`. This does not in any way affect the exit code returns in the case of child processes that exit normally. It is left up to an exercise for the host app to detect and handle the event of a crashed child process. In general, Linux processes will return a value that is 128 plus the number of the signal (ie: SIGSEGV, SIGABRT, etc) that killed the process. On Windows a crashed process will generally have an exit code that starts with 0xc0000000 (though this is not true in the case of `raise()`, `abort()`, or a failed `assert()` call which all typically set an exit code of `3`). - CC-291: Renamed some device backend settings in carb.audio-forge to make it easier for users to find settings. - `/audio/oldWindowsBackend` was renamed to `/audio/WASAPI/legacyBackend`. - `/audio/nullDeviceCount` was renamed to `/audio/nullBackend/DeviceCount`. - `/audio/nullBackendIsFunctional` was renamed to `/audio/nullBackend/IsFunctional`. - `/audio/nullBackendCaptureTestMode` was renamed to `/audio/nullBackend/CaptureTestMode`. #### Fixed - CC-486: Improved performance of `carb.tasking.plugin`: fewer system calls to wake a thread, and fiber stack reset (if `/plugins/carb.tasking.plugin/resetFiberStack` is `true`) now only occurs in a single thread when no other tasks are available to run. ### CARB_PROFILE_EVENT() macro. ### DRIVE-4086: Fix for reconciling an external callers held zoneId with the new/replayed zoneId created on fiber switch. ### CC-473: Allow for plugins to depend on interfaces they provide. ### OM-36366: Fixed a bug in `carb.audio` that would cause a muted sound to not be muted if the `carb::audio::fPlaybackModeFadeIn` flag was also used. ### OM-48634: Add GPU timestamp injection interface to `IProfiler`. ### OM-48808: Reworded some output in the crash reporter about the size and readability of the crash dump file to make it more clear whether the dump file was deleted due to a successful upload or not. ### CC-470: The `Framework` now supports “load hooks”: a load hook is a callback that is called when an interface becomes available from a plugin load. This can be used to weakly couple plugins, such as if a Profiler plugin doesn’t normally load `carb.tasking.plugin`, but takes action when it is otherwise loaded. ### OM-49026: Improved the `carb.crashreporter-breakpad.plugin` startup by deferring symbol loading until a crash actually occurs. ### CC-485: Improved performance of `carb.tasking.plugin` on Windows by setting the system timer to the highest resolution available. ### CC-485: Further improved performance of `carb.profiler-cpu.plugin` when used with `carb.tasking.plugin` by more quickly recording task switches. ### CC-479: Upgraded to FLAC-1.3.4. This fixes CVE-2021-0561. ### CC-449: `IAudioCapture` on Windows no longer uses DSound. It now uses the same capture system as on Linux, with a device backend built on Windows Audio Services. Functionality on Windows should not change substantially; the only major difference is that the new system has improved overrun detection. Additionally, this means the `null` device backend will now work with `IAudioCapture` on Windows. ### OM-48865: Fix potential infinite loop in ProfilerNvtx ‘endEx’. ### OM-47219: A better fix for the degenerative performance issue when `carb.profiler-cpu.plugin` was used with `carb.tasking.plugin` and `/plugins/carb.profiler-cpu.plugin/fibersAsThreads` as `true`. ### CC-422: `carb::Framework` will not print a warning message when a plugin acquires an interface that is not listed as a dependency if that interface is provided by the plugin that is loading it. ### CC-475 `omni.experimental.job.plugin` no longer links with X11. ### CC-472: Fixed an issue that could cause a hang if multiple threads in different modules were using `carb::RString` at the same time. ### CC-483: Worked around a few places in the logging system that could deadlock via interaction with internal locks in GLIBC 2.17, especially when logging in a thread while a different thread loads a python binding .so which registers a log listener in a static initializer. ### CC-483: Fixed a potential hang that could occur when using `carb::getCachedInterface` simultaneously from multiple threads. ## New Features - Added a new feature to the `carb::variant_literals` namespace: a literal `_v` that can be appended to a literal to create a `Variant` type from it (e.g. `123_v`, `"Hello"_v`, etc.). - CC-359: `carb.assets.plugin` is now documented and now sends (via `carb.eventdispatcher.plugin`, if available) events `Asset.BeginLoading` when loading (or re-loading) starts for an asset, and `Asset.EndLoading` when loading finishes. See `carb::assets::IAssets::loadAsset()` in `include/carb/assets/IAssets.h` for more information. - CC-441: Added a specialization of std::hash for `carb::cpp17::variant`. - CC-376: `omni.bind` generated Python bindings now support keyword parameters with names based on their C++ parameter name (in `snake_case`). This can be overridden with `OMNI_ATTR("py_name=something_else")`. ## Changed - BREAKING CHANGE: The types `Id`, `Pool`, and `Snapshot` within the `carb::assets` namespace have been converted to strong types (`carb::Strong`) instead of fake pointer types. As such, assigning them to `0` or `nullptr` will now cause a compile error. Instead use their default constructed or special invalid types: `kInvalidAssetId`, `kInvalidPool`, and `kInvalidSnapshot`, respectively. For `printf`-style formatting, instead of using `%p`, use the format specifier for the underlying type and call the `.get()` function. This is to better facilitate types passing through the Variant system. - BREAKING CHANGE: The rarely-used `carb::assets::CreateContextFn` loader function must now return a `carb::assets::LoadContext` instead of a `void`; the rarely-used symbol `carb::assets::OnDependancyChangedFn` has had its spelling corrected to `carb::assets::OnDependencyChangedFn`. - CC-275: Updated the Windows audio playback backend to an improved implementation. If you run into playback issues, you can restore the old backend with this settings key: `/audio/oldWindowsBackend`. - OM-39028: improved `carb::dictionary` conversion error reporting. - CC-420: On Linux, changes the `carbReallocate` function to be weak-linked. This alters the memory functions which use it (`carb::allocate`, `carb::deallocate`, and `carb::reallocate`) to understand this and gracefully fail when the `carbReallocate` function is not available. This allows users which only incidentally use these functions to not link against `libcarb.so`. This case is common for plugins which might use an `omni::string`. ## 121.0 ### Added - CC-289: Allowed `omni.structuredlog.plugin` to be used in a ‘standalone’ mode. This plugin can be used in a non-Carbonite app without the need for other dependent libraries (including ‘carb.dll/so’). When being used in standalone mode, the `omni/structuredlog/StructuredLogStandalone.h` header should be used to pull in the supported dependencies. The structured log library is expected to be present in the same directory as the main executable. The `example.structuredlog.dynamic` example app demonstrates how the library can be used in standalone mode. - CC-396: Added string conversion helpers to Utf8Parser.h, which will allow easy conversions between UTF-8 and UTF-16/UTF-32. - CC-377: Added `carb.eventdispatcher.plugin` which is a replacement for `carb.events.plugin` for immediate events (the `carb.events.plugin` is more of a message queue). Additional features: - Allows observers to filter which events they receive. - Doesn’t use `carb.dictionary.plugin`; instead it uses a new extensible variant system in `carb.variant.plugin` which is faster than dictionary and supports the same types. - More clearly defined behavior of recursive event dispatching when adding/removing observers. - Lack of ref-counting prevents crashes like OM-43254 from unreleased events. - CC-421: Carb python logging will now convert to string and log any python object. ### Fixed - CC-401: Update Python and OpenSSL dependencies to fix a security vulnerability. - CC-396: Fixed some security issues in `carb::extras::Utf8Parser` around invalid characters. ## 120.0 ### Added - CC-363: Added support for specifying other types of authentication tokens in `omni.telemetry.transmitter`. This now supports long-lived API keys as tokens through the use of the ‘/telemetry/authTokenType’ setting and specifying a local file through ‘/telemetry/authTokenUrl’ instead of a URL. These two options can also be used to specify a long-lived API key that is downloaded from a custom URL or read from a file. The ‘/telemetry/authTokenKeyName’ and ‘/telemetry/authTokenExpiryName’ settings can also be used to specify different ways to parse the token out of a JSON blob from all sources. By default, the token type is detected based on whether it is retrieved from a URL or file. - CC-199: Added the `IJob` interface. `IJob` is an experimental ONI interface that provides an abstraction for a foreign job system. ## Fixed Issues ### OM-45612: Changed an error message from `carb.profiler` to a warning since it could potentially be written out frequently and flood the telemetry data lake if it is redirected as a telemetry event. ### CC-364: Fixed improper use of `memory_order_relaxed` in `carb::tasking::TaskGroup` and improper use of `volatile`. ### CC-355: Fixed some minor rendering issues in `IAudioUtils::drawWaveform()`. Golden image tests that use this functionality will likely need their images regenerated. ### CC-362: Fixed the `flags` parameter validity checks in `carb::audio::createSoundFromFile()` and `carb::audio::createSoundFromBlob()`. ### CC-362: `IAudioData::getFormat()` has had its documentation corrected. ### CC-362: Fixed the confusing behavior of `SoundData.get_format()` on streaming sounds in the `carb.audio` python bindings. ## Added Features ### OM-44734: Added a ‘retry count’ to each crash dump’s metadata. If a crash dump fails to upload multiple times, it will eventually be deleted and considered corrupt instead of letting failing crash dump files pile up locally and attempting to upload on each new run. The retry count to delete failed dumps after is controlled with the setting ‘/crashreporter/retryCount’. This is an integer value that defines the maximum number of times to try an upload of any given crash dump file. This setting defaults to 10 tries. This can be set to a lower value to delete so that on the next run, any local dumps that have already been tried and failed that many times will be deleted if they fail again. ### CC-329: added python bindings for `IAudioData`. ## Fixed Issues ### CC-353: Fixed a build break in GCC 9.3.0 caused by `__attribute__(())` syntax changes. ### CC-374: Fixed memory orders and contention issues that could arise on high CPU counts, especially on AArch64 machines. ## Added Features ### CC-316: Added the `audio/pulseAudio/enumerateMonitors` setting to allow PulseAudio’s loopback (AKA monitors) devices to be enumerated as audio capture devices. ### CC-331: Added `carbGetSdkVersion()` and `include/carb/SdkVersion.h` to allow access to the SDK version string. A helper macro was also added to allow verification of whether the loaded Carbonite framework version matches the header files that are being used in a host app. ### OM-44740: Added the Carbonite SDK version as metadata in the crash reporter. ## Changed Features ### CC-301: Changed all of the Carbonite framework globals (ie: `g_carb`) so that they are weakly linked. This is to resolve an issue related to pulling in `include/carb/extras/` headers from pure ONI modules. When this happened, the linker would often add an undefined reference to one of the framework globals because something in the header called `CARB_ASSERT()`, `CARB_LOG_()`, etc. ### OM-44182: Changed the ‘quick shutdown’ process to include unloading the omni.core plugins as well as the Carbonite plugins. ### CC-304: `carb::delegate::Delegate` now allows itself to be destructed while in a callback. ## Fixed Issues ### OM-43654: Evaluated all Carbonite Python bindings and released the GIL (global interpreter lock) wherever appropriate. - carb.profiler-cpu.plugin when `/plugins/carb.profiler-cpu.plugin/recordSourceInfo` was enabled (the default). - OM-43254: `carb::memory::PooledAllocator` behaves correctly if the underlying allocator throws during `allocate()`. - OM-43254: Resolved an issue with `carb.dictionary.plugin` where a `std::bad_alloc` exception could be raised during operations that could create a new `dictionary::Item`. This is now considered a fatal condition instead of allowing an exception to cross the ABI boundary. - OM-43898: Thread safety improvements to fix a rare crash and a few other issues in carb.audio. ### 117.0 #### Added - CC-298: `omni::string` now supports `printf`-style formatting through additional constructors and functions: `assign_printf`, `append_printf`, `insert_printf`, and `replace_printf`. `_vprintf` versions of these functions also exist that accept a `va_list`. - CC-253: Adds overloads to `omni::string` for `std::string`, `carb::cpp17::string_view`, and `std::string_view`. These additional overloads make it easier to use `omni::string` with `std::string`. - CC-274: Implemented `carb::container::IntrusiveUnorderedMultimap`. See the documentation for more details and example usage. - CC-193: Adds `CARB_TOOLCHAIN_CLANG` definition to be `1` when a Clang-infrastructure tool is running (`0` otherwise). #### Changed - CC-266: Both the `omni.bind` and `omni.structuredlog` tools now support the `--fail-on-write` option that causes them to fail their operation if a change to a generated file needs to be written to disk. This is used in the CI build scripts to ensure that MRs that make changes to generated code always include the latest version. - OM-43576: Removed the `MiniDumpWithDataSegs` flag from the crash dumps on Windows. This skips adding the global data segments of each module to the crash dump which can make some debugging tasks more difficult. However, if needed that dump flag can be added back by using the ‘/crashreporter/dumpFlags=WithDataSegs’ setting. - CC-247: Warn, instead of fail, when a user asks for 0.x and we have an implementation 0.y (where y > x). Previously, we error out when x != y since according to semver 0.* versions should not be considered to be backwards compatible (but they could be). #### Fixed - CC-295: Fixed compilation errors in `omni::string` when exceptions are disabled. - CC-303 / OM-43576: Now that `MiniDumpWithDataSegs` has been removed from crash dumps, - RString values cannot be resolved in minidumps. CC-303 resolves that by including additional debugging information for RString in crash dumps. Also establishes better testing practices for future RString version changes. - CC-306: Fixed a compiler error when using `operator+(carb::extras::Path, const char)` in the `omni` namespace. That operator was ambigous following the additional `operator+` overloads added by CC-253. Added additional `operator+` overloads for `carb::extras::Path` to remove the ambiguity. - OM-43783: Fixed an issue in `carb::cpp20::counting_semaphore` and `binary_semaphore` where threads would busy wait. - OM-43783: Fixed an issue in `include/carb/Framework.h` that would cause issues if `free()` was `#define`’d (i.e. for memory debugging). - OM-43783: Cleaned up some Intellisense warnings in `include/carb/cpp17/Variant.h`. - OM-43783: Fixed some ambiguous operator errors and namespace issues with `include/omni/String.inl` and `include/carb/cpp17/StringView.h` that could occur when building external projects. - OM-43783: Issues around `std::vsnprintf()` that are worked around in `include/carb/extras/StringSafe.h` also now apply to `std::snprintf()`. - CC-193: Changes GNUC compiler-specific warning macros (those with names like `CARB_IGNOREWARNING_GNUC`) to be available when `CARB_COMPILER_MSC` is `1` and a Clang-infrastructure tool is being run (`CARB_TOOLCHAIN_CLANG` is `1`). This now correctly suppresses GNUC-specific warnings being emitted on the Windows platform from Clang. - OM-43819: Allowed the `omni.structuredlog.plugin` module’s ‘shutdown’ flag to be cleared each time the plugin is reloaded, even if the previous unload didn’t actually remove it from memory. This prevents some crashes and potential loss of functionality on Linux when dlclose() silently leaves the library loaded. - Reverted CC-5: Ability for crashreporter to upload files (attachments) to S3. The original change was causing issues on Linux related to the static linking of OpenSSL in `carb.crashreporter-breakpad.plugin` and conflicting with the static linking of OpenSSL in Python 3.7. A future Carbonite build will reinstate this functionality. ### 116.0 #### Added - CC-183: Added `std::string` and `carb::cpp17::string_view` overloads to `IDictionary::makeAtPath()`. - CC-82: Added optional support for zipping crash dump files before uploading them. The zip implementation supports 4+GB files and can process files without allocating memory at crash time. The zip files are typically ~10% the size of the original file in practice, so crash dump upload time should be greatly reduced once supported on the server side. - CC-252: Added DLL boundary safe `allocate`, `deallocate`, and `reallocate` top level functions to Carbonite. These functions all use an internal reallocation function within carb.dll/libcarb.so, making them safe to use from different modules. `carb::Framework::internalRealloc`, `carb::Framework::allocate`, `carb::Framework::free`, and `carb::Framework::reallocate` are now deprecated in favor of these new top level functions. ## Added - CC-263: Added `IFileSystem::makeCanonicalPathEx2()`. This version takes an extra `flags` parameter that allows some behaviour to be controlled. By default on Windows, this version assumes that the caller has already checked if the given file already exists. The `carb::filesystem::fCanonicalFlagCheckExists` has been added to get back the same behaviour as `IFileSystem::makeCanonicalPathEx()`. - CC-244: Added a framework for simple geolocation to the telemetry transmitter. This will be used to allow the transmitter to exit itself early on startup if its current country matches a country code in a restricted regions list (specified in the ‘/telemetry/restrictedRegions’ setting). This is currently disabled due to the need for an account to use various geolocation APIs. This may be enabled at some point in the future. By default, the transmitter is allowed to run in all regions. - CC-246: Added `omni::detail::PointerIterator`, a wrapper iterator for a possibly-cv-qualified `T` as a `T` iterator class. It does not change the semantics from the fundamental logic of pointers. This is meant to be used on container types with contiguous storage (such as `vector` and `string`), as returning a pointer directly from iterator functions (`begin()` and `end()`) would be inappropriate. - CC-218: Added flags and settings to the telemetry transmitter to control the behaviour of how old events are processed if they are encountered in a telemetry log. - CC-8: Added `omni::string`, an ABI safe replacement for `std::string` that also offers DLL-Boundary safe allocation. - CC-290: Added `carb::extras::getLibraryHandleFromFilename()` to get a library handle without forcing a load (ie: only retrieve the handle if the library is already loaded in the process). ## Changed - CC-262: Improved some logging in the telemetry transmitter. It will now output the path to log directory it will be scanning and whether it is able to get a valid authentication token (if needed). - CC-281: Changed the way the `omni.structuredlog.plugin` plugin loads the privacy settings on startup. In addition to the previous method of loading the state into the ISettings dictionaries, it now also loads and caches the privacy settings state internally on plugin load. - CC-290: Added a `flags` parameter to `carb::extras::loadLibrary()` to allow a module name to be constructed internally from a base filename instead of having to explicitly call `carb::extras::createLibraryNameForModule()` first. - CC-290: Changed `carb::extras::createLibraryNameForModule()` to allow path components to also be included in the base library name instead of only supporting the base name itself. ## Fixed - OM-42834: Fixed an issue on x86-64 Linux where `carb.windowing-glfw.plugin` required libGLX but did not link against it, potentially causing crashes if libGLX.so was unloaded before it. - OM-28142: `omni.bind` now only updates copyright in .gen.h files if the code contents of the file change. - CC-266: `omni.structuredlog` now only updates the copyright year in .gen.h files if other code changes also occurred. - CC-268: `carb.events` now keeps subscriptions at a given `Order` in the same order as when they were registered. - CC-278: Resolved an issue where `carb.profiler-cpu.plugin` could potentially access memory from a DLL/SO after it had been unloaded. - CC-279: Resolved a rare issue with `carb.tasking` where a task could be assigned to an emergency thread which wouldn’t execute the task and could leave the task in a stuck state. - CC-293: Fixed an issue where `carb.tasking` could crash shortly after unloading if emergency threads had been started. - CC-217: Evaluated and fixed several places that were incorrectly using `std::memory_order_relaxed`. - CC-292: Fixed an issue in `carb.datasource-file.plugin` where a crash could rarely occur when the plugin was shut down and unloaded. ``` ## 115.0 ### Changed - CC-276: Instead of using getFileStat to determine the filesize of an opened file use fseek / ftell on linux and getFileSizeEx on windows. getFileStat retrieves costly information like the time converted to the local timezone which showed up in profilings. - CC-276: use DeleteFileEx to delete a file on Windows instead of ShFileOperationW for performance reasons. ### Added - CC-222: ILauncher: Added `ILauncher::waitForStreamEnd()` to wait for the `stdout` or `stderr` streams from a child process to end completely before doing other operations on the process handle. This allows a caller to ensure all the data from the child process has been received before destroying the process handle or waiting for the child process to exit. Since the reads from these streams happen asynchronously, it was not previously possible to ensure all data had been received without waiting for a fixed period of time after the child process exits. - CC-222: ILauncher: added a single extra read callback call for `stdout` or `stderr` streams when the stream ends. The end of the stream is signalled by delivering a callback with a zero byte count. - CC-248: Exposed all of the minidump ‘type’ flags to the settings under `/crashreporter/dumpFlags`. These can either be specified as a single hex value for all the flags to use (assuming the user knows what they are doing), or with `MiniDump` flag names separated by comma (‘,’), colon (‘:’), bar (‘\|’), or whitespace. There should be no whitespace between flags when specified on the command line. The ‘MiniDump’ prefix on each flag name may be omitted if desired. This defaults to an empty string (ie: no extra flags). The flags specified here may either override the default flags or be added to them depending on the value of `/crashreporter/overrideDefaultDumpFlags`. This option is ignored on Linux. ### Changed - CC-222: ILauncher: documented some behavior on Linux where destroying a process handle before the child process exits could result in the child process terminating. This occurs if a read callback has been registered for the child process, then the child process tries to write to the stream (ie: `stdout` or `stderr`) after the parent process has destroyed the handle. This occurs because the Linux kernel’s default behavior on trying to write to a broken pipe or socket is to raise a SIGPIPE signal. This cannot be worked around in a general case without the child process knowing to ignore SIGPIPE. ### Fixed - CC-220: Fixed a crash that could occur in `carb.dll` on Windows in `carb::filesystem::FileSystemWatcherWindows`, especially when watching paths that were mapped to network shares. - CC-5: Added ability for crashreporter to upload files (attachments) to S3. By default the `.dmp` and `.dmp.toml` are uploaded, but other files can be specified in the settings (either statically in config file or dynamically via the settings interface). By default only internal NVIDIA crashes are uploaded to carb-telemetry bucket. A future update will include a web interface and backtrace.io link to the data. - CC-242: Fixed a issue on Windows that would cause DLLs to fail to load if their pathname exceeded 260 characters. ``` ```markdown ## 114.0 ### Added - Functions for string trimming - `overwriteOriginalWithArrayHandling` function in `DictionaryUtils.h` that handles overwriting of arrays during dictionary merge - CC-192: Added the `/audio/nullDeviceCount` setting to allow the number of null audio devices to be configured for testing purposes. - CC-192: Added the `/audio/nullBackendIsFunctional` setting to allow the null backend to simulate broken audio devices for testing purposes. - Some additional flags were added to `carb::extras::SharedMemory`. - A `carb::extras::SharedMemory::open()` overload was added to support opening an existing region by name. - Added: - `carb::this_process::getId()` and `carb::this_process::getIdCached()` were added to `carb/process/Util.h`; `carb::this_thread::getProcessId()` and `carb::this_thread::getProcessIdCached()` are now deprecated. - `carb::this_process::getUniqueId()` was added to generate a process-specific unique ID for the uptime of the machine since PID can be reused. - `carb::memory::testReadable()` was added to `carb/memory/Util.h` to test if a memory word can be read from an address without crashing. - CC-182: `carb::Framework` now has memory management functions that enable cross-plugin memory blocks: `allocate`, `free`, and `reallocate`. Memory allocated with these functions by one plugin can be passed to and freed by a different plugin or the executable. - CC-185: Added task debugging functions to `carb.tasking.plugin`: `ITasking::getTaskDebugInfo()` and `ITasking::walkTaskDebugInfo()`. These functions allow retrieving runtime debug information about tasks. - CC-235: The `carb.assets.plugin` system will now provide more debug information about orphaned assets when asset types are unregistered and the system is shut down. - Changed: - CC-190: Allowed the `/telemetry/schemasUrl` setting to be treated as either an array of URL strings or just a single URL string. If multiple URLs are provided, they will be tried in order until a schemas package successfully downloads. This allows for a way for the ‘backup’ URLs to be provided for the telemetry transmitter. - carb::extras::CmdLineParser now trims whitespace character for keys and values. - OM-34980: Helper functions for processing command line arguments handle array and JSON values. - CC-192: carb.audio previously had two `null` audio backends that could be chosen in different configurations (there was no obvious way to do this). Only one of these `null` backends should be possible to use anymore. Audio devices under the `null` backend may appear to have changed as a result of this. - CC-192: `IAudioPlayback::setOutput()` now checks for invalid flags, so it will now fail if non-zero flags are passed in which contain neither of `fOutputFlagDevice` or `fOutputFlagStreamer`. - How `carb::extras::SharedMemory::createOrOpen()` uses the `size` parameter when opening an existing shared memory region has changed to be safer. On Linux the shared memory region grows to accommodate a larger size; on Windows growth is not supported, so requesting a larger size will fail. Previously the `size` parameter was ignored which could lead to invalid memory accesses. - On Linux, a global semaphore named `/carbonite-sharedmemory` is used to synchronize the `carb::extras::SharedMemory` system across multiple processes. If a process crashed or was killed with this semaphore acquired, all apps that use `carb::extras::SharedMemory` (or derivative systems, such as `RString` and `carb.dictionary`) would hang when attempting to acquire the semaphore. Now, a warning log (or print to `stderr`) is emitted after 5 seconds of waiting on the semaphore. - CC-58: Previously, `Framework::unloadAllPlugins()` would terminate all plugins (calling `carbOnPluginShutdown`) and then on a subsequent pass unload the plugin (call `FreeLibrary()` or `dlclose()`). Now, the plugin is unloaded immediately after termination. ## Fixed - Replaced usage of* `kUpdateItemOverwriteOriginal` with `overwriteOriginalWithArrayHandling` in code that handles configuration processing - CC-192: Capture devices capabilities queried through `IAudioDevice::getDeviceCaps()` and `IAudioCapture::getDeviceCaps()` will now report `fDeviceFlagConnected` on working devices. - CC-192: Audio device capabilities queried through `IAudioDevice::getDeviceName` will no longer report `fDeviceFlagConnected`, since that function does not test for device connectivity/functionality. - CC-192: When using the `null` audio device backend on Linux, `IAudioPlayback` and `IAudioDevice` in some configurations could report different playback devices. This should no longer occur. - CC-181: On Linux, shared memory regions used for `carb::RString` could be left over from an incomplete previous run of a Carbonite application, causing crashes when RString was initialized. This has been fixed in a backwards-compatible way so that the application validates the shared memory. - Fixed an issue with `extras::isTestEnvironment()` leaking module references on Linux. - Fixed an issue with `IFileSystem::getExecutablePath()` and `IFileSystem::getExecutableDirectoryPath()` not initializing in a thread-safe manner. - Fixed an incorrect error message that was reported when using `ILauncher` on Windows. - CC-227: omni.structuredlog timestamp checking has been fixed, so it won’t regenerate files during every build. - CC-213: Fixed carb.audio returning `AudioResult::eInvalidParameter` and `AudioResult::eDeviceDisconnected` when `AudioResult::eDeviceLost` should have been returned. ## 113.0 ### Fixed - BREAKING CHANGE: `carb::Format::B5_G6_R5_UNROM` spelling was corrected to `carb::Format::B5_G6_R5_UNORM`. - CC-1: `carb::RStringKey` and `carb::RStringUKey` now satisfy `std::is_standard_layout<>` in order to conform to better ABI safety. The binary layout of these classes did not change and are therefore backwards compatible with older Carbonite binaries. - CC-184: Fixed an issue where running a Carbonite executable as root on Linux could potentially cause other Carbonite executables by other users to crash on startup when either the `SharedMemory` or `RString` systems were in use. - Fixed a shared memory leak on Linux when the `RString` system was in use and shutdown occurred with `carb::quickReleaseFrameworkAndTerminate()`. - OM-39751: `IAudioCapture::getSoundFormat()` will no longer report its format as `eDefault` and it will also no longer report a channel mask of 0. - CC-164: Fixed an issue where `carb::profiler::ProfileEvent` objects within a frame provided by `carb::profiler::IProfileMonitor` would not be sorted correctly. ### IAudioPlayback leaking ### Streamer objects when the ### Context is destroyed. ### Added - Documentation for our release and versioning process, docs/Releasing.html\|rst - Implemented `carb::cpp20::bit_cast` and `carb::cpp20::endian` in include/carb/cpp20/Bit.h. - carb/tasking/TaskingHelpers.h now contains additional macros such as `CARB_ASYNC` and `CARB_MAYBE_ASYNC` to signal that a function is called from a task. Macros such as `CARB_ASSERT_ASYNC` to assert that a function is running in task context. - OM-41046: added `waitForClose()` to `carb::audio::OutputStreamer`, so that it is possible to verify when the output file is no longer being written to when you disconnect the streamer via `IAudioPlayback::setOutput()`. - OM-41046: exposed `fOutputFlagAllowNoStreamers` in `IAudioPlayback` to allow clients to easily have an audio context with no underlying audio device. This is mainly intended to simplify testing. - CC-176: Added support for fixed length string buffers in structs to `omni.bind`. - Implemented carb.simplegui.plugin, a wrapper around Dear ImGui with a built-in Vulkan raster renderer that significantly simplifies the work required to get a usable GUI for example projects. This also removes Carbonite’s dependency on the carb_gfx_plugins. - OM-39664: Added the `omni::platforminfo::IDisplayInfo` interface to use to collect information on all the attached displays in the system and their supported display modes. ### Changed - `carb::dictionary::getStringArray()` now has its parameters marked as `const`. - CC-163: Changed the `omni.structuredlog` tool so that it only writes the output files if they have changed versus the code that has been generated or the output file doesn’t exist yet. If the file already exists and is identical to the generated code, the output will just be ignored. This is to avoid having to touch timestamps for unmodified generated files and to avoid the possibility of a write permission error if another project with a missing dependency is currently reading from the generated file. - OM-39751: add `/audio/maxDefaultChannels` to limit the number of audio channels that are used when opening an audio device with a default speaker mode. This was an issue when opening the “null” device in ALSA which reported the maximum possible number of audio channels. Opening an `IAudioPlayback` context with more than 16 channels requires some additional setup, so this should not be automatic. - OM-35496: added some extra omni.structuredlog bindings to python. As a result, omni.structuredlog now ships an `__init__.py` and a binary instead of only shipping a binary. - CC-23: Applicable carb.tasking.plugin settings are now dynamic and will be reloaded automatically when they change. ### 112.53 @joshuakr #### Changed ##### carb.profiler-cpu.plugin Improvements - The `IProfiler` interface now supports Instant events via macro `CARB_PROFILE_EVENT()`. Instant events are drawn on the timeline with zero duration. Instant events may not be supported by profilers other than profiler-cpu. - The `IProfiler` interface now supports Flow events via macros. - CARB_PROFILE_FLOW_BEGIN() and CARB_PROFILE_FLOW_END(). Flow events draw as an arrow between two zones and can begin and end in different threads. Flow events may not be supported by profilers other than profiler-cpu. - When using carb.tasking.plugin and profiler-cpu, an Instant event is automatically emitted when a task is queued. A Flow event is automatically drawn from where the task was queued to when the task begins executing. When the setting key /plugins/carb.profiler-cpu.plugin/fibersAsThreads is false, Flow events are automatically drawn to connect all zones executing the task as they move between various task threads. - For profiler zones, the Category field is now automatically set to the name of the library containing the zone. - The resulting (possibly compressed) json output from carb.profiler-cpu.plugin is more compact. - The “begin” event (via CARB_PROFILE_BEGIN() or CARB_PROFILE_ZONE()) is now slightly faster. - The “frame complete” event (via CARB_PROFILE_FRAME()) is now slightly faster. - Fixed a few possible crashes that could occur if a library had been unloaded when unprocessed profile events referenced it. ### 112.52 @jshentu #### Added - OM-40643: Added createCursor to IWindowing. Allowing supplying custom image and use it as cursor shape. ### 112.51 @cdannemiller #### Changed - Removed trailing new lines from all CARB_LOG messages as Carbonite will automatically add this newline to each log. ### 112.50 @jroback #### Added - OM-36988: Added carb::extras::Uuid, UUIDv4 class for UUIDv4 unique identifiers ### 112.49 @jfeather #### Fixed - OM-39751: removed an optimization for an edge case in carb.audio-forge that prevented certain callbacks from being sent. ### 112.48 @saxonp #### Added - OM-22490: Include the deps folder in the Carbonite Package ### 112.47 @evanbeurden #### Fixed - OM-40193: Deferred creation of the standard logger log file until a message is actually written to it. This was to fix the behaviour of a log file being truncated by a secondary concurrent launch of an app trying to write to the same log file even if the new process did not write any log messages. - OM-40193: Fixed the behaviour of carb::logging::StandardLogger::setFileConfiguration() in the case of disabling logging to file when the log file has not been opened yet. Previously the log filename was not being cleared as documented. - OM-40193: Allowed carb::filesystem::IFileSystem::closeFile() to fail gracefully if passed nullptr. This makes the function more friendly to use and makes its behaviour match expected common OS level behaviour for similar functions such as fclose() and CloseHandle(). - OM-40193: Enabled much more of the omni.telemetry.transmitter app’s logging by default. This allows it to leave a log file that can be reliably used for post mortem analysis of its behaviour. - OM-40193: Updated the OpenSSL version used in the omni.telemetry.transmitter app to fix some issues. # CentOS 7 ## 112.46 @hfannar ## 112.45 @evanbeurden / @joshuakr ### Fixed #### OM-40256: Fixed a potential race condition calling the IEventListener::onEvent() functions for subscribers to an event stream. It was previously possible to have the subscription removed at the same time the object was being used to call the onEvent() function. #### OM-40212: Fixed an issue where serialized events sent from different threads could be received out-of-order despite the serialization. Added documentation for `carb.events`. ## 112.44 @joshuakr ### Added #### OM-39253: For `carb::profiler::IProfiler`, `CARB_PROFILE_BEGIN()` now returns a value that can be passed to `CARB_PROFILE_END()` for validation. #### OM-33647: `carb.profiler-cpu.plugin` now outputs source information if available. This can be disabled with setting: `/plugins/carb.profiler-cpu.plugin/recordSourceInfo` (default: true). #### Documentation for header files in `include/carb/profiler/`. ### Fixed #### OM-40102: Fixed a `carb.tasking` issue where a timed-wait could cause `ITasking::suspendTask()` to not work correctly. ## 112.43 @jfeather ### Fixed #### OM-40135: Converting bytes to frames with a variable-bitrate format in the audio utilities in `AudioUtils.h` will no longer result in a divide-by-zero. Note that this behavior is still an error. #### OM-40135: setting `AudioImageDesc::lengthType` to `UnitType::eBytes` should now function correctly instead of hitting a divide-by-zero. #### OM-40135: Fixed a bug where sounds would fail to encode due to libvorbis setting `bitrate_nominal` to a negative number. ## 112.42 @evanbeurden ### Added #### OM-39664: Added a concept of ‘volatile’ metadata to the crash reporter. These are metadata values that change frequently (ie: free RAM, frame rate, etc) that should only be collected in the event a crash does actually occur. #### OM-39664: Added the ‘/crashreporter/debuggerAttachTimeoutMs’ config option to provide a wait period after a crash occurs where a debugger can attach before the crash upload and metadata processing actually occurs. #### OM-39664: Added RAM, swap, and VM space information as metadata in the crash report. ## 112.41 ### Fixed #### OM-40023: Add an error message when `remove()` fails in `IFileSystem::removeFile()` to match the Windows behavior. ## 112.40 ### Fixed #### OM-39974: Fixed a memory corruption crash that could occur when `IInput::clearActionMappings` was called in a multi-threaded environment. ## 112.39 ### Fixed #### Updated the following INFO log from carb.audio from `[carb.audio.context] the bus count would not` ## 112.38 ### Fixed - `carb::audio::IAudioUtils::drawWaveform()` will no longer encounter errors when the sound offset is specified in a unit other than frames. ## 112.37 ### Changed #### Enable C++17 on codebase - OM-34896: Enable C++17. By default Carbonite now compiles with C++17. Linux toolchains stay the same as before, MSVC has been moved to VS2019. All existing binaries remain 100% compatiable, including python bindings. Projects using Carbonite can continue using C++14. Carbonite remains backwards compatible with C++14. ## 112.36 ### Fixed - Fixed a bug in ILauncher on Linux where destroying a process handle could incorrectly close a file descriptor it didn’t own. ## 112.35 ### Changed #### Drastically improved performance of carb.profiler-cpu.plugin - OM-33716: Change `carb.profiler-cpu.plugin` to use per-thread queues instead of a global ringbuffer. This greatly improved performance by reducing contention: about 99.5% faster in highly contended cases. - Switched to using Ryu and {fmt} for conversion of numeric values to string in the profiler for additional speed improvement. Adjusted compression settings so that a generated .gz profile is about 2% larger but much faster. - OM-39381: Fixed an issue where `CARB_PROFILE_FUNCTION` incorrectly generated the function name. ## 112.34 ### Fixed - OM-39573: Fixed an issue where dictionary keys that ended with `_0` could drop the `_0`. ## 112.33 ### Fixed - OM-38834: `IFileSystem::readFileLine()` now consumes the line ending even if there is no room for it in the buffer provided. See the documentation for `IFileSystem::readFileLine()` for more information. ### Changes - Keys for `carb.dictionary.plugin` now internally use `carb::RString`. This has no effect on the plugin interface, ABI or API but should result in higher performance and less (transient and long-term) memory usage. - Compile-breaking change: `carb/rstring/RString.h` has moved to `carb/RString.h`. ## 112.31 ### Fixed - OM-38790: Fixed memory corruption and invalid memory accesses that could occur in the `RString` system on Linux. - Improved stability around `carb::extras::SharedMemory` and `carb.launcher`. ### Added - Added a `CARB_RETRY_EINTR` macro for GCC on Linux to automatically retry operations when `EINTR` is reported. - All Carbonite python bindings are now built for Python 3.9 in addition to the previous platforms. ## 112.30 ### Fixed - Improved the retrieval of available physical RAM in `carb::extras::getPhysicalMemory()`. ## 112.29 ### Added - Added the `omni.platforminfo.plugin` plugin. This provides interfaces to access the CPU, memory, and OS information for the calling process. - Added python bindings for the `omni.platforminfo.plugin` plugin. ## 112.28 ### Fixed #### Structured Logging: - Fixed a thread race condition that could lead to a crash. ## 112.27 ### Fixed #### carb.scripting-python.plugin - Using global context `getGlobalContext()` no longer causes stack overflow. ### Changed #### carb.scripting-python.plugin - Enabled UTF-8 mode for Python scripting by default. It can be turned off with the `/plugins/carb.scripting-python.plugin/pythonFlags/Py_UTF8Mode` setting. ## 112.26 ### Reverted - The changes from 112.19 have been reverted pending further testing. ## 112.25 ### Fixed #### carb.input.plugin - OM-37121: Allow `filterBufferedEvents()` to be called multiple times before `distributeBufferedEvents()`. ## 112.24 ### Fixed #### carb.assets.plugin - OM-38102: The carb.assets system would consider successful but zero-byte loads from a datasource as failures. This is no longer the case: zero-byte successful loads are now treated as success and the asset will proceed with the loading process. - `carb::assets::IBlobAsset` now supports `nullptr`/zero-byte data and has been changed to version 1.0. ## 112.23 ### Changes #### carb.crashreporter-breakpad.plugin - OM-38102: Crashes now store metadata as a separate file alongside crashes, so if crash uploads must be deferred until a subsequent run, the proper metadata can be uploaded. - The uptime of the application (measured as time that `carb.crashreporter-breakpad.plugin` has been loaded) is now automatically included in the metadata as `UptimeSeconds`. - The UUID of the dump is now included in the metadata as `DumpId`. - Crash metadata is included in the human-readable text file that is produced alongside the crash dump. ## 112.22 ### Changed - fix carb.log_* python functions to provide more source info (file, line number, module etc) to the logging system. ## 112.21 ### Fixed - OM-37197: When `carb.crashreporter-breakpad.plugin` detects a crash and writes out the callstack in the .txt file, it now attempts to discern source file and line information (via `addr2line`) and include it in the report. - Resolved an erroneous log message “Failed to create or open a semaphore” that would be logged when using `RString` in multiple modules. ## 112.20 ### Removed - Removed the `omni/extras/InterruptableSleep.h` header and related classes in favor of using `carb::cpp20::binary_semaphore` directly instead. ## 112.19 ### Added (Reverted in 112.26) ## Functions for string trimming ## OM-34980: Helper functions for processing command line arguments handle array and JSON values ## Changed (Reverted in 112.26) ### carb::extras::CmdLineParser now trims whitespace character for keys and values ## 112.18 ### Fixed #### OM-37431: Fixed an internal carb.tasking assumption that could lead to `CARB_CHECK` violations. #### OM-37902: Fixed a race condition with certain timed waits that could lead to asserts and test failures. ## 112.17 ### Fixed #### OM-37870: Fixed an issue that was causing `carb::tasking::Future` returned from `ITasking::addTask` (and variants) to be signaled before a task was complete, causing spurious test failures. Added documentation. ## 112.16 ### Added #### Added the omni.telemetry.transmitter tool to its own package that is published with the other Carbonite packages. This was done for easier deployment of the tool in non-Carbonite projects that want to use it. ## 112.15 ### Added #### OM-31214: Added a function `carb::quickReleaseFrameworkAndTerminate()` which will attempt to shutdown all plugins, flush `stdout` and `stderr`, and terminate the app via `TerminateProcess()` on Windows or `_exit()` on Linux. ### Fixed #### carb.memory has been disabled by default for Debug builds (it was already disabled by default for Release builds) as it could cause shutdown crashes. #### On Windows, if `main()` exits and the Carbonite framework has not been shut down, the framework now attempts to shut itself down before all threads are terminated. #### A workaround was implemented when using carb.tasking with ASan and UBSan: false errors could previously be reported due to fiber stack memory being reused. If ASan is detected, the memory for thread stacks is now `mmap`’d to `PROT_NONE` instead of unmapped, leaving the address space non-reusable but preventing the errors. ## 112.14 ### Fixed #### OM-37286: Fixed possible UB with `carb::tasking::Trackers` storing an `initializer_list`. #### Fixed a compile issue with `include/carb/assets/IAssets.h` on GCC 10. ## 112.13 ### Fixed #### OM-34654: `carb.dictionary.serializer-json` could not handle serializing or parsing float values such as `inf` or `nan`, which could cause corrupted JSON files from failed serialization. This has been fixed to serialize those values as strings so they can be serialized/deserialized properly. ## 112.12 ### Changed # 112.11 ## Changed - Changed `carb.crashreporter-breakpad` to determine the absolute path of the crash dump directory during configuration rather than in the crash handling code path to prevent possible errors while crashing. # 112.10 ## Changed - Changed command line setting parsing to also parse hexadecimal and octal values. # 112.9 ## Fixed - Changed command line setting parsing to also parse hexadecimal and octal values. # 112.8 ## Fixed - Made the handling of finding the system temp directory more robust on Linux and improved some error messages from `carb::filesystem::IFileSystem::makeTempDirectory()`. # 112.7 ## Fixed - Command line settings are now parsed as 64 bit integers and doubles, rather than 32 bit integers and floats. This prevents clamping of values larger than the maximum values of 32 bit integers or floats. # 112.6 ## Changed - Changed `carb.crashreporter-breakpad` to print the absolute path of the crash dump file. # 112.5 ## Changed - `carb.crashreporter` is now disabled by default on Linux. # 112.4 ## Changed - Added a `omni::core::ImplementsCast` that only implements the `cast_abi` function. # 112.3 ## Fixed ### CrashReporter-Breakpad changes - OM-34471: Reduced the amount of redundant Verbose log output. - OM-36335: Asynchronous uploading of crash dumps was holding a mutex that could block the main thread. This mutex is no longer held while the upload is pending, allowing the main thread to proceed. # 112.2 ## 112.2 - Changed the code generator for structured logging to use `repo_format`. # 112.1 ## Fixed - Resolved an issue with counted `RString` objects from 112.0 where the length was not always taken into account. # 112.0 ## Changed ### RString changes - `RString` changes. ### API has a minor change: `isNone()` is replaced by `isEmpty()`, and default-constructed `RString` will refer to an empty string (`c_str()` returns “”). Similarly, `eRString::RS_None` is replaced by `eRString::Empty`. ### `RString` and variant classes now have constructors that accept a counted string (length provided) and a `std::string`. ### As such, `RString` now supports strings with embedded NUL (‘\0’) characters. ### CrashReporter-Breakpad changes - Windows minidumps now include data segment information (global variables). - `RString` data is included in Windows minidumps. - Settings key `/crashreporter/preserveDump` (default: false) can be used to have a dump file remain even after it has been uploaded to the server. - Several log messages when writing a crash dump and uploading were changed from Verbose to Warn to be more visible. ### Fixed - On Linux, processes launched via `ILauncher` with `fLaunchFlagNoStdOut` and/or `fLaunchFlagNoStdErr` would close the file handles for `stdout` and `stderr`, allowing them to be reused. This could lead to undefined behavior. ### 111.21 #### Added - Added `BitScanForward`, `BitScanReverse`, and `PopCount` functions to `carb::math` ### 111.20 - Optimized read access of the IDictionary interface. #### Fixed #### Changed - OM-36102: `carb.crashreporter-breakpad` prints crash dump file location at error level when crash occurs. ### 111.18 #### Fixed - omni::core::cast would not compile if used with `IObject` and the Implementation uses multiple inheritance. - Added a unit test for the above. ### 111.17 #### Fixed - OM-13024 and OM-25736: Interfaces (that may be non-trivial) were always memcpy’d when instantiated. Now, by means of a new plugin function `carbOnPluginRegisterEx2` (automatically generated by `CARB_PLUGIN_IMPL`), the plugin interfaces are now constructed in place without memcpy. This requires the plugin to be recompiled against Carbonite 111.17. The Carbonite Framework version did not change and remains version 0.5. Any plugins compiled against Carbonite Framework 0.5 will continue to work (but will perform the memcpy which is unsafe if the Interface struct is not trivial), and Carbonite Framework 0.5 from Carbonite 111.16 and previous will continue to load newer plugins. ## 111.16 ### Fixed - OM-34946: C++17 compile error with pybind11 and BindingsPythonUtils.h ## 111.15 ### Fixed - OM-35664: Fixed an issue with plugin unload ordering where dependencies could be unloaded too early. This was rare and generally affected plugins which had a stated dependency in `CARB_PLUGIN_IMPL_DEPS` but did not acquire the dependency until `carbOnPluginShutdown()` was called. ## 111.14 ### Fixed - OM-35375: It was possible for some `ISettings` setter functions such as `setString` to call callbacks while an internal lock was held. This could lead to some deadlock situations if another thread was querying the settings. ## 111.13 ### Fixed - Renamed template vars in `TypeTraits.h` to avoid conflicting with termios.h ### Changed - Moved the telemetry transmitter helper functions in `include/omni/structuredlog/Telemetry.h` from the `omni::structuredlog` namespace to `omni::telemetry`. - Implied ‘test’ mode in the telemetry transmitter when the `/telemetry/schemaFile` or `/telemetry/schemasDirectory` options are used. ## 111.12 ### Fixed - Fixed the `omni.structuredlog` tool to only disable MSVC’s ‘fast up-to-date’ check for projects that make use of the tool. Projects that do not use the tool will still skip the build check if they are up to date. ## Changed - `omni::structuredlog::launchTransmitter()` will now automatically pass a number of settings from the host process to the child process, so that launching the transmitter is easier. ## 111.11 ## Changed - Updated to repo_format 0.6.4 ## 111.10 ### Fixed - Fixed an issue with `carb.profiler-tracy.plugin` where throwing a C++ exception could cause issues after the plugin was unloaded. ### Added - Added a helper function to `carb::launcher::ArgCollector` to collect all the settings in a given branch and add them as arguments that can be passed to a child process. ## 111.9 ### Changed - Upgraded to repo_format 0.6.0 and ran latest repo_format on all code. This results in a large change to copyright ranges in the header of source files only. ## 111.8 ### Changed ## 111.7 ### Fixed #### Fixed potential memory corruption that could occur within `carb.tasking`, especially with `ITasking::applyRange()`. ### Changed #### `omni.telemetry.transmitter` requires `--/telemetry/allowRoot=true` to be able to run as root. This was done to prevent users from running the transmitter with `sudo` and causing permission issues with the lock files. ## 111.6 ### Fixed #### Shutdown/unload improvements - Change 110.0 introduced a tweak to unload ordering that would attempt to discover “implicit dependencies” by plugins acquiring interfaces through `tryAcquireInterface`. There were issues with this implementation and it was disabled in version 111.3. - A corrected unload order is now present in Carbonite. If plugin `Foo` acquires an interface from plugin `Bar`, `Foo` must now be unloaded before `Bar`. The exception to this rule is a circular reference, in which case unload order is the reverse of the load order. ### Added - Added documentation for the various structured log settings to the Telemetry Overview docs. - Added documentation for the various telemetry transmitter settings to the Telemetry Overview docs. - Added `/structuredlog/logDirectory` to allow the output directory of structured logging to be specified by Settings. ## 111.5 ### Added #### Structured Log - Documented the wildcard helper functions in `include/omni/str/Wildcard.h`. - Added settings keys to allow structured log schemas to be enabled or disabled from config files or command line. - The following new settings paths have been added to disable schemas and events. Each key under this path will enable or disable one or more schemas or events (wildcards are allowed): - `/structuredLog/state/schemas`: enable or disable zero or more schemas when they are first registered. - `/structuredLog/state/events`: enable or disable zero or more events when they are first registered. - The following new settings keys have been added to disable schemas and events. Each of these keys is expected to be an array of strings indicating the schema or event name and its enable or disable state: - `/structuredLog/schemaStates`: enables or disables zero or more matching schemas when they are first registered. - `/structuredLog/eventStates`: enables or disables zero or more matching events when they are first registered. - For more information, see `include/omni/structuredlog/StructuredLogSettingsUtils.h` or consult the generated documentation package. - Added `/structuredlog/logDirectory` to allow the output directory of structured logging to be specified by Settings. #### Utilities - Added `carb::this_thread::getProcessId()` and `carb::this_thread::getThreadId()`. # 111.4 ## Fixed - Fixed a hang that could occur rarely with `carb::getCachedInterface<>` on the AArch64 platform. # 111.3 ## Changed - The “Improvements to Carbonite Shutdown” from version 110.0 have been revoked pending review. An issue was discovered that would cause improper plugin unload order on shutdown. # 111.2 ## Added ### String-interning (registered fast-comparison strings) - A registered string class `RString` has been added in `carb/rstring/RString.h`. - The `RString` class is case-sensitive, but has companion class `RStringU` that is “un-cased” (i.e. case-insensitive). - The `RString` and variant classes can be (in)equality checked in O(1), and non-lexicographically sorted in O(1) time. - All registered strings are shared within an application’s memory space across multiple modules and can be used prior to `main()` without needing to instantiate the Carbonite framework. - Carbonite registered strings are similar to Unreal’s `FName`, `boost::flyweight<std::string>` and USD’s `TfToken`. # 111.1 ## Added - `/telemetry/schemasDirectory` and `/telemetry/schemaFile` has been added to omni.telemetry.transmitter. This will allow debug builds to load their telemetry schemas from disk instead of requiring a HTTP download. - `/telemetry/authentication` has also been added to the transmitter to allow test cases where authentication can’t be used. ## Fixed - Fixed a shutdown crash that could occur if a cached interface was destroyed after the Carbonite framework has been unloaded. # 111.0 ## Removed - Removed unused, untested lua bindings. # 110.1 ## Fixed - Fixed an issue with `carb.scripting-python.plugin` where `IScripting::executeScript()` and `IScripting::executeScriptWithArgs()` would crash if the script had incorrect Python grammar. # 110.0 ## Changed ### Improvements to Carbonite Shutdown - If a plugin creates a dependency with `tryAcquireInterface()`, that dependency could be unloaded before the plugin is unloaded, leading to potential crashes at shutdown. Now such a dependency is taken into account during plugin shutdown. unloading so that plugins are unloaded before their dependencies. - The `getCachedInterface()` helper function no longer tries to re-acquire the interface if the interface has been released. The `resetCachedInterface()` function will evict the cached interface and reset so that the next call to `getCachedInterface()` will attempt to re-acquire the interface. Releasing the entire framework however does reset the cached state so that it can be re-acquired. - Cached interfaces are now evicted immediately prior to calling `carbOnPluginShutdown` for a plugin. This causes `getCachedInterface()` to return `nullptr` instead of an interface that is in the process of destructing. ### 109.0 #### Changed - `carb::extra::EnvironmentVariable` is now RAII class. ### 108.14 #### Added - `IAudioDevice::getBackend()` has been added to allow users to check which audio backend they’re running under to make specific decisions based on which audio system is running. This is mainly intended to be used to detect if ALSA is in use, which makes some operations (such as device enumeration) costly. ### 108.13 #### Changed - omni.telemetry.transmitter switched from environment variables to ISettings. This allows users to configure omni.telemetry.transmitter with the config.toml file or via command line arguments. `OMNI_TELEMETRY_ENDPOINT` has been replaced with `/telemetry/endpoint`. `OMNI_TELEMETRY_SCHEMAS_URL` has been replaced with `/telemetry/schemasUrl`. ### 108.12 #### Changed - omni.telemetry.transmitter no longer uses python. - `omni::structuredlog::launchTransmitter()` has had the arguments for its python environment removed. ### 108.11 #### Changed - The carb.tasking.plugin heuristic that guides `carb::tasking::ITasking::applyRange` has been adjusted to allow for more parallelism, especially with fewer than 512 items. ### 108.10 #### Fixed - Callstacks reported by `carb.crashreporter-breakpad.plugin` during crash time now include offsets next to the function names in order to be more accurate. ### 108.9 #### Changed - carb.profiler-cpu is now statically linked to zlib on Linux. This was the existing behavior on windows. - Public include files should now build cleanly with /W4 warning level on MSVC and -Wall on GCC. #### Added - If the `/plugins/carb.tasking.plugin/debugTaskBacktrace` key is true and a task enters the Waiting state, the backtrace is now captured and stored at `carb::tasking::TaskBundle::m_backtrace` for a given task. The entire database of tasks is available at ``` ``` carb.tasking.plugin.dll!carb::tasking::Scheduler::s_scheduler->m_taskHandleDb ``` and can be added to the watch window. ``` carb::tasking::ScopedTracking ``` now exists to be able to start and end tracking on ``` carb::tasking::Trackers ``` without having to add a dummy task (OM-33470). ### 108.8 #### Fixed Fixed the ``` omni.structuredlog ``` tool when it is called using an external project (ie: outside of Carbonite). Previously this script would generate prebuild commands that would not work properly under MSVC. They would however build correctly when run through ``` build.{bat\|sh} ``` . This tool has now been fixed to write out a full build script for MSVC prebuild commands and write out a similar set of commands for use on Linux. ### 108.7 #### Changed ##### carb.tasking.plugin Changes: An optimization where a task that waits on another task may attempt to execute the dependent task immediately, regardless of priority. Dependency helper classes ``` carb::tasking::Any ``` and ``` carb::tasking::All ``` can now take iterators as input. Fixed a small rare memory leak at shutdown. ### 108.6 #### Added ##### Additional features for carb.tasking.plugin “Task Storage” has now been exposed in the ``` ITasking ``` interface (similar to thread-local storage, but for tasks). Full support for ``` Promise ``` and ``` Future ``` types. Added support for specifying multiple schemas to be built in a single project. Multiple schemas may now be specified as an array in a single call to ``` omni_structuredlog_schema() ``` . A single schema to be built may still be specified by passing an object containing the parameters instead of a full array. ### 108.5 #### Added Added support for anonymized and pseudonymized events in the telemetry transmitter. #### Fixed Fixed some structured log schemas that don’t always rebuild properly under MSVC. This was caused by a limitation of MSVC projects generated under premake. This problem didn’t exist on Linux. ### 108.4 #### Changed Class names in generated structured log headers have changed to include the version in their name. This will require changes in structured log calls that use enum types or object types and code that uses generated structured log python bindings. #### Fixed The ``` OMNI_FORCE_SYMBOL_LINK ``` macro now correctly evaluates, so redefinition errors should no longer occur. It should now be possible to include multiple versions of a structured log schema without encountering build errors. ### 108.3 #### Fixed Added a more helpful error message when setup_omni_structuredlog() isn’t called in a premake script that uses omni_structuredlog_schema(). ### 108.2 ## Changed - Added `isWindowFloating` and `setWindowFloating` to `carb::windowing::IWindowing`, and implemented them for `carb.windowing-glfw.plugin`. ## 108.1 ### Changed - Upgraded to the newest version of repo_format, which includes clang-format v12. - Removed the –clang-format and –clang-format-style options from the omni.bind python script, these are replaced with –format-module, which gives the user more flexibility in choose how and if they want to format the code. ### Breaking Changes - Users are required to upgrade to repo_format 0.5.4 or later. ## 108.0 ### Changed - `ILogMessageConsumer_abi::onMessage_abi()` had its prototype changed to add the TID, PID and timestamp, so that this data will be available when using asynchronous logging. ## 107.3 ### Fixed - Fixed a rare debug assert in ITasking. - Fixed an issue where a carb::tasking::Semaphore could assert on destruction. ### Changed - omni.structuredlog.lua has replaced the questionable `carb_path` global with `setup_omni_structuredlog()` to specify the carbonite path. ## 107.2 ### Changed ### IAssets - The `IAssets` interface has changed to better support `ITasking` and to deprecate `carb::tasking::Counter`. - The `IAssets::loadAsset()` functions no longer take a `Counter` object. Instead, they take a `carb::tasking::Tracker` helper object similar to the `ITasking::addTask` functions. - The `IAssets::loadAssetEx` function is deprecated and directs the caller to use the safer `loadAsset` wrapper functions. - The `LoadAssetFn` and `CreateContextFn` no longer pass a `Counter` and expect data to be returned rather than passed through an output argument. ## 107.1 ### Fixed ### Python uses static openssl again - 107.0 inadvertently used a python package that had switched to dynamically linking libssl.so and libcrypto.so, so dependencies would encounter linking issues. 107.1 switches back to a python package that has these dependencies statically linked. ## 107.0 ### Changed #### ITasking 2.0 The `ITasking` interface has undergone some extensive improvements that are (mostly) backwards-compatible with existing code. - The `Counter` type is deprecated. The interface remains for the time being but will now produce deprecation warnings for manual `Counter` manipulation. Instead, `TaskGroup` is a more efficient means of grouping tasks together. - The `Any` and `All` helper objects for `RequiredObject` used by `ITasking::addSubTask` are now nestable. - Tasks can now be canceled before they have started executing. See `ITasking::tryCancelTask()`. - The `ITasking::addTaskIn` and `ITasking::addTaskAt` functions now accept multiple tracker objects. - The `ITasking` functions `yieldUntilCounter` and `waitForTask` have been combined into a generic `wait()` function. The `wait()` function can also use `Any` and `All` helper objects. - Unhandled exceptions thrown from a task will now treat the task as canceled. - A fiber-aware futex system has now been exposed to allow for generic waiting. - The `PinGuard` and wrapper classes such as `CounterWrapper` no longer need an `ITasking` pointer passed to them, nor do they cache the pointer. These classes now rely on the `carb::getCachedInterface` helper function. #### IAssets The `IAssets` interface has changed to better support `ITasking` and to deprecate `carb::tasking::Counter`. - The `IAssets::loadAsset()` functions no longer take a `Counter` object. Instead, they take a `carb::tasking::Tracker` helper object similar to the `ITasking::addTask` functions. This allows specifying multiple variant types of trackers to asset loading (including the now-deprecated `Counter` objects). - The `IAssets::loadAssetEx()` function is deprecated and directs the caller to use the safer `loadAsset` wrapper functions. - The `LoadAssetFn` and `CreateContextFn` no longer pass a `Counter` and expect data to be returned rather than passed through an output argument. Since these functions are called from Task Context as a co-routine, they are free to use any of the fiber-safe waiting methods provided by `ITasking`. ## HandleDatabase - HandleDatabase has a new function `handleWasValid()` to check if a handle was previously valid but has been released. - Added an `addRef()` function that accepts a valid `TrueType`. ## 106.7 ### Changed - `carb.crashreporter-breakpad.plugin` was updated to use Google Breakpad chrome_90 release. ## 106.6 ### Changed - Renamed the `OmniCoreStartArgs::padding` member to `OmniCoreStartArgs::flags` and added some flags to control the behavior of some of the built-in object overrides more explicitly. Specifically to allow for the `ILog` and `IStructuredLog` objects to be able to be disabled without having to create a dummy stub implementation for each of them. This member was intentionally unused before and did not change size so it should not cause any breakages from the name and usage change. ## 106.5 ### Changed - Moved documentation related docs into `repo_docs` repo. ## 106.4 ### Changed - `carb.scripting-python.plugin`: `executeScript()` and `executeScriptWithArgs()` now do just-in-time script compilation when called for the first time. Previously the script was compiled each time the functions were called. ## 106.3 ### Fixed - Fixed a crash that would occur in an app started from Python if `carb.scripting-python.plugin` was initialized but the GIL had been released by the calling thread. ## 106.2 ### Fixed - The `carb.tasking` plugin will now discard all pending tasks when released. Only the tasks currently running will be allowed to finish. Note that this will potentially cause leaks; if it is important to clean up rather than abandoning tasks, use a `carb::tasking::Counter` or other means to ensure that all necessary tasks have completed before releasing `carb.tasking.plugin`. ## 106.1 ### Added - Added `omniGetBuiltInWithoutAcquire()` to carb.dll/libcarb.so which will become the new entry-point for accessing interfaces. The existing functions `omniGetLogWithoutAcquire()`, `omniGetTypeFactoryWithoutAcquire()`, and `omniGetStructuredLogWithoutAcquire()` are now deprecated and will be removed in a future version. ## 106.0 ### Broke - Removed `ICaching` interface. The interface had no known usage in the wild. ## Fixed - Restored `omniGetTelemetryWithoutAcquire` which was removed between 105.0 and 105.1. ## 105.2 ### Changes #### Improvements to carb.tasking’s parallel_for()/applyRange() The `parallel_for()` and `applyRange()` functions in `ITasking` should be seeing 5-10% improvement in certain situations. #### Improvements to LocklessQueue and LocklessStack The `InputIterator`-style `push()` functions on these containers now accept `InputIterator` types that dereference into both `T` and `T&` types to allow for different situations. ### Fixed - Using `carb.tasking`’s `applyRange()` function should prevent stuck checking and fix the occasional “carb.tasking is likely stuck” messages. - Fixed an issue that could sometimes cause a crash at shutdown in `carb.profiler-cpu` and `carb.dictionary`. ## 105.1 ### Fixed - `.pyd` files that call `OMNI_PYTHON_GLOBALS` can now access `carb::Framework` from within the bindings. ## 105.0 ### Removed - The `mirror` tool dependency has been removed along with associated tests. - `carb.windowing-glfw` now only supports X11/GLX on Linux. The Wayland/EGL backend has been removed. ## 104.0 ### Broke #### ITokens 0.1 -> 1.0 `ITokens::calculateDestinationBufferSize` now accepts a pointer to store an error code (`ResolveResult`) of the calculation. This is an ABI breaking change. `ITokens::calculateDestinationBufferSize` and `ITokens::resolveString` now accept special flags (`ResolveFlags`) that allow to modify token resolution process. This is an ABI breaking change. #### All Interfaces Bumped to at least 1.0 - `IObject` 0.1 -> 1.0 - `IAssert` 0.2 -> 1.0 - `IAssetsBlob` 0.1 -> 1.0 - `IAudioCapture` 0.4 -> 1.0 - `IAudioData` 0.6 -> 1.0 - `IAudioDevice` 0.1 -> 1.0 - `IAudioGroup` 0.1 -> 1.0 - `IAudioPlayback` 0.5 -> 1.0 - `IAudioUtils` 0.3 -> 1.0 - `ICaching` 0.1 -> 1.0 - `IDataSource` 0.3 -> 1.0 - `IDictionary` 0.8 -> 1.0 - `IEcs` 0.1 -> 1.0 - `IEvents` 0.2 -> 1.0 - `IFileSystem` 0.1 -> 1.0 - `IMemoryTracker` 0.1 -> 1.0 - `IProfileMonitor` 0.3 -> 1.0 - `ISettings` 0.6 -> 1.0 - `IFiberEvents` 0.1 -> 1.0 - `IThreadPool` 0.1 -> 1.0 - `IThreadUtil` 0.1 -> 1.0 - `ITypeInfo` 0.1 -> 1.0 - `IGLContext` 0.1 -> 1.0 This change was made to avoid potentially unnecessary breaking changes (due to semantic versioning's 0 major rule) in the future. ### 103.1 #### Fixed ##### RingBuffer improvements The `carb/container/RingBuffer` object had a problem with high contention. The RingBuffer now performs much better in a high-contention environment. ##### carb.profiler-cpu improvements Because it was based on the RingBuffer, `carb.profiler-cpu.plugin` also suffered from debilitating performance problems that have been resolved with the RingBuffer improvements. ##### Resolved potential Linux hang in carb::thread::futex The Futex system had a rare hang that could occur in certain situations where a wait() would not be woken by a notify() due to a race condition. This also affected things using `carb::cpp20::atomic<>` which was based on `carb::thread::futex`. ##### PooledAllocator no longer constrained by “buckets” The template parameter for the number of “buckets” in use by the `PooledAllocator` has now been removed. `PooledAllocator` will now happily allocate memory until the underlying allocator runs out of memory. ### 103.0 #### Fixed ##### getCachedInterface() now re-acquires when framework/plugin unloaded If an interface is released (or the entire framework is released), `carb::getCachedInterface()` will now detect this and attempt to re-acquire the interface (or return `nullptr` if it is no longer available). This fixes issues where plugins may be often released and re-acquired. NOTE: Do not use `static` when calling `carb::getCachedInterface()`. ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ```markdown ### IDictionary::getPreferredArrayType Now use the first element as a baseline type to convert to, instead of trying to convert everything to eBool by default. This was causing an array of [0.0, 0.0, 0.0] to convert to [False, False, False] erroniously. ### Fixed #### IAssets delay reloading fix Fixes two issues introduced with 102.11: - `IAssets::yieldForAssetLoaded` could spuriously wait if an asset reload was in progress. - Unregistering an AssetType would wait for pending assets to reload, even if the reload delay was very long. Now asset reloads are abandoned immediately upon unregistering an AssetType. #### ITasking crash fix Fixes a rare crash with use of `carb::tasking::Any` and `carb::tasking::All` in 102.10 ### 102.12 #### ITasking fix for “carb.tasking is likely stuck” during applyRange() In long-running parallel tasks during `applyRange()` the carb.tasking stuck checking feature could determine that the system is stuck even when it is not. Now `applyRange()` contributes to the heuristic which should reduce false positive stuck warnings. ### 102.11 #### Changes #### IAssets version 1.0 `IAssets` has been promoted to version 1.0 with a few additional changes. `AssetTypeParams` has been created as a parameter for `registerAssetType()` to contain all of the configuration information for Asset Types; this struct should start as `AssetTypeParams::getDefault()` and then any parameter changes can be made. The `AssetTypeParams` struct has a new `reloadDelayMs` option (default=100 ms). For Asset Types that automatically reload, this will wait for `reloadDelayMs` to elapse from the last datasource change notification in an effort to prevent multiple reloads for multiple changes in rapid succession that can occur when an asset is being written to. ### 102.10 #### Changes #### ITasking::addSubTask() and ITasking::addThrottledSubTask() support lists of required Counter objects In some cases, it is desirable to wait until any or all of a group of Counter objects become complete in order to start a sub-task. To that end, `addSubTask()` and `addThrottledSubTask()` now accept an initializer_list of Counters, passed into helper objects `carb::tasking::Any` or `carb::tasking::All`. ```html <div class="highlight"> <pre><span></span><span class="n">tasking</span><span class="o">-></span><span class="n">addSubTask</span><span class="p">(</span><span class="n">carb</span><span class="o">::</span><span class="n">tasking</span><span class="o">::</span><span class="n">All</span><span class="p">{</span><span class="w"> </span><span class="n">counter1</span><span class="p">,</span><span class="w"> </span><span class="n">counter2</span><span class="w"> </span><span class="p">},</span><span class="w"> </span><span class="p">...)</span><span class="w"></span> </pre> </div> </div> <p> Which would wait until both <code> counter1 </code> and <code> counter2 </code> are complete before starting the sub-task. <code> carb::tasking::Any </code> is specified similarly but waits until at least one of the passed Counters is complete. </p> </section> <section id="itasking-addtask-and-variants-support-lists-of-notify-counter-objects"> <h4> <code> ITasking::addTask() </code> and variants support lists of notify Counter objects </h4> <p> In some cases, it is desirable for multiple Counter objects to be incremented before a task starts and decremented when the task completes. Previously, only one Counter could be passed to <code> addTask() </code> variant functions and the other Counter objects would need to be manually incremented/decremented. Now, <code> addTask() </code> variants (except for <code> addTaskAt() </code> and <code> addTaskIn() </code> ) will allow passing an <code> initializer_list </code> of Counters. Each of the non-nullptr Counter objects passed will be incremented before the <code> addTask() </code> variant function returns and decremented upon task completion. </p> </section> </section> </section> <section id="id468"> <h2> 102.9 </h2> <section id="id469"> <h3> Added </h3> <section id="new-feature-carb-strongtype"> <h4> New feature: <code> CARB_STRONGTYPE </code> </h4> <p> <code> CARB_STRONGTYPE </code> now exists in <em> carb/Strong.h </em> to declare a strong type. The <code> using </code> and <code> typedef </code> keywords do not actually create a new type; they just create aliases for the type. <code> CARB_STRONGTYPE </code> declares a structure that acts like the referenced type but is strongly typed and requires explicit assignment. </p> </section> <section id="new-feature-carb-delegate-delegate"> <h4> New feature: <code> carb::delegate::Delegate </code> </h4> <p> <code> Delegate </code> implements a <code> std::function </code> -like loose-coupling system but allows multiple bindings and thread-safe access. Additionally, it attempts to be as safe as possible allowing bound callbacks to unbind themselves (or other callbacks) safely when the callback is executing. See <em> carb/delegate/Delegate.h </em> for more information. </p> </section> </section> </section> <section id="id470"> <h2> 102.8 </h2> <section id="id471"> <h3> Fixed </h3> <section id="performance-improved-in-itasking-applyrange"> <h4> Performance improved in <code> ITasking::applyRange() </code> </h4> <p> A degenerate case was identified that could cause <code> ITasking::applyRange() </code> to perform poorly under very short workloads. This has been corrected. In some cases, small workloads may still perform more poorly than a straight <code> for() </code> loop due to the overhead in dispatching tasks to other threads and subsequent cache performance. Performance testing uses of <code> applyRange() </code> is advised. </p> </section> </section> <section id="id472"> <h3> Added </h3> <section id="itasking-parallelfor-implementation"> <h4> <code> ITasking::parallelFor() </code> implementation </h4> <p> <code> ITasking::parallelFor() </code> now exists as a wrapper for <code> ITasking::applyRange() </code> . These new funtions allow specifying the classic parameters to <code> for </code> loops: begin, end and optional step values. </p> </section> </section> </section> <section id="id473"> <h2> 102.7 </h2> # Changes ## ITypeFactory now calls onModuleCanUnload and onModuleUnload Previously, `~ITypeFactory` would simply call `dlclose` / `FreeLibrary` to shutdown each loaded plugin. This patch now attempts to call each plugin’s `onModuleCanUnload`, and if it returns `true`, `onModuleUnload` is called followed by `dlclose` / `FreeLibrary`. If a plugin’s `onModuleCanUnload` returns `false` it may be called again after other plugins are unloaded. If `onModuleUnload` cannot be safely called, either because `onModuleCanUnload` returns `false` or it is not defined, `~ITypeFactory` will call `dlclose` / `FreeLibrary` on the loaded plugin. This is new behavior and may expose bugs in previously existing `onModuleCanUnload` / `onModuleUnload` implementations. # 102.6 ## Changes ### Debugging mode for waiting tasks `ITasking` now supports a new boolean setting: /plugins/carb.tasking.plugin/debugWaitingTasks* (default=false). This setting parks all waiting tasks in a dedicated thread so that they will show up in debuggers. For Visual Studio, the Parallel Stacks and Threads windows will now have threads named “carb.task wait” and `__WAITING_TASK__()` will be in the call stack. For GDB, the threads will appear with the name “carb.task wait” and will show up in the “info threads” list. Note that this debugging feature can create hundreds of transient threads and may negatively affect performance, but can be useful for debugging hangs. ### Debugging mode for Task and Counter creation backtrace `ITasking` now supports a new boolean setting: /plugins/carb.tasking.plugin/debugTaskBacktrace (default=false). This setting will capture a backtrace when `ITasking::addTask()` is (or variants are) called. This backtrace is available to view in the debugger as a local variable `DebugTaskCreationCallstack` in the `carb::tasking::TaskBundle::execute` function whenever a task is being executed. Similarly, a backtrace will be captured for Counter objects created with `ITasking::createCounter` and `ITasking::createCounterWithTarget`. This backtrace is available as a local variable in the `Counter::wait` function called `DebugCounterCreationCallstack`. At `carb.tasking.plugin` shutdown time, the creation backtrace of any leaked Counter objects is logged as a Warning. # 102.5 ## Fixed - Fixed a crash that could occur sometimes in carb.tasking.plugin. # 102.4 ## Fixed - Carbonite SDK + Plugins package no longer has licensing errors. ## 102.3 ### Changes - ITasking will attempt to detect a “stuck” condition and attempt to get “unstuck” - It is possible to get `ITasking` into a situation where it is stuck: a task uniquely locks a resource and then waits in a fiber-safe way. Other tasks attempt to lock the same resource but don’t wait in a fiber-safe way until all task threads are blocked waiting on the resource. At this point `ITasking` is stuck because when the task that holds the lock becomes ready to run, no threads are available to run it. The new emergency-unstick system will detect this and start emergency threads to process ready tasks, attempting to un-stick the system. - The stuck-check time can be configured using `ISettings` key `/plugins/carb.tasking.plugin/stuckCheckSeconds` (default: 1; set to 0 to disable). ## 102.2 ### Fixed - IAssets::unregisterAssetType() now waits until all assets are actually unloaded - In prior versions, performing several `IAssets::unloadAsset`, `IAssets::unloadAssets` or `IAssets::releaseSnapshot` could start unloading data in the background. A call to `IAssets::unregisterAssetType` after this point could potentially destroy the asset type, but would not wait for the background unload tasks to complete. This could cause issues at shutdown where other systems would shut down expecting that after unregistering the type that they would no longer be used. This fix causes `IAsset::unregisterAssetType` to wait for any pending load/unloads to complete before returning. - Fixes an issue where IAssets could stop updating an asset - If an asset was loaded twice and one of the assets was unloaded, the system would ignore changes to the underlying data and no longer update the still-loaded asset. This has been resolved. ## 102.1 ### Fixed - Task priority changes to ITasking - `ITasking` now correctly respects task priority when resuming tasks that have slept, waited or suspended. - ITasking compile fixes - `ITasking::addTask()` and variants would fail to compile in situations where they were capturing additional parameters that would be passed to the `Callable` parameter. These compile issues have been fixed. ## 102.0 ### Broke - Normalized Mouse Coordinate in IInput - `IInput` interface version has bumped from 0.5 to 1.0. This is to support mouse coordinates being returned in either normalized or pixel coordinates. - `IInput::getMouseCoords` was renamed to `IInput::getMouseCoordsPixel`. - Added `getMouseCoordsNormalized`. ## Changes in MouseEvent Methods - JavaScript: `MouseEvent.get_mouse_coords` was renamed to `MouseEvent.get_mouse_coords_pixel`. - Python: `MouseEvent.get_mouse_coords` was renamed to `MouseEvent.get_mouse_coords_pixel`. - Python: Added `MouseEvent.get_mouse_coords_normalized`. ## carb.imaging.plugin.dll Has Moved to the rendering Repo `IImaging` has moved to the rendering repo. - Kit is incompatible with older Carbonite builds that still have `carb.imaging.plugin.dll`. - `carb.imaging.plugin.dll` users outside kit/rendering must: - Pull `rtx_plugins` instead of Carbonite. - Add a header include path from `rtx_plugins/include`. - Add `plugins/carb_gfx` to your search library path. - kit/rendering users can no longer rely on `carb.imaging.plugin.dll` being built ahead of time and must make it a build prerequisite by including it in their `dependson`. Transition discussion can be found here.
changes_CHANGELOG.md	# Changelog ## [1.1.0] - 2024-02-21 ### Changes - Font size adjustment ## [1.0.1] - 2023-12-07 ### Changes - Documentation improvements ## [1.0.0] - 2023-11-30 ### Changes - Created
changetracking.md	# Change Tracking in USDRT USDRT offers an option for tracking changes to Fabric scene data with the RtChangeTracker class, which is available for users in both C++ and Python. Like the rest of the USDRT Scenegraph API, RtChangeTracker aims to leverage the performance gains of Fabric while remaining accessible for USD-centric developers. ## Background ### Change Tracking in USD USD provides native support for change tracking through a notification subsystem. It works by notifying interested objects when an event has occured somewhere in the application. Notifications are defined by users by extending the `TfNotice` base class. The user can populate these notifications with relevant information about the triggering event. Listener classes register interest in specific notice classes. When a notice-triggering function is invoked, the subsystem delivers a notice to all interested listener objects. Because the subsystem synchronously invokes each listener from the sender’s thread, performance is highly dependent on the listeners. The original thread is blocked until all listeners resolve. Avoiding this potential block is one of the main goals of change tracking in USDRT. More details about the TfNotice subsystem can be found in Pixar’s USD Documentation. ### Change Tracking in Fabric Fabric provides a non-blocking subsystem to track changes to prim and attributes in Fabric buckets. Instead of using notifications, Fabric changes are tracked by ID and polled at whatever frequency the developer requires. Multiple listeners can be registered to a stage, and tracking is enabled by attribute name per listener. Fabric provides methods to manage what attributes are currently being tracked, as well as methods to query and clear changes on a listener. Below is a usage example that enables change tracking on a listener for the position attribute, and then queries and iterates through the changes after they occur. C++ ```c++ ListenerId listener = iSimStageWithHistory->createListener(); stage.attributeEnableChangeTracking(positionToken, listener); // Changes are made to position attributes on the stage ChangedPrimBucketList changedBuckets = stage.getChanges(listener); for (size_t i = 0; i != changedBuckets.size(); i++) { BucketChanges changes = changedBuckets.getChanges(i); gsl::span<const Path> paths = changes.pathArray; for (size_t j = 0; j != changes.attrChangedIndices.size(); j++) ``` ```cpp #include <usdrt/scenegraph/usd/rt/changeTracker.h> using namespace usdrt; UsdStageRefPtr stage = UsdStage::Open("./data/usd/tests/cornell.usda"); UsdPrim prim = stage->GetPrimAtPath(SdfPath("/DistantLight")); RtChangeTracker tracker(stage); tracker.TrackAttribute("color"); UsdAttribute color = prim.GetAttribute("color"); ``` ``` Change tracking in Fabric is fast and non-blocking. However, the underlying struct (BucketChanges) that changes are stored and returned in relies on some understanding of Fabric’s underlying bucket-based structure. For developers that are used to working with the standard USD API, this may not be as intuitive. ## RtChangeTracker The RtChangeTracker class provides an interface for tracking changes to Fabric data. Unlike TfNotice, RtChangeTracker handles change notifications in a non-blocking manner. RtChangeTracker leverages Fabric’s change tracking capabilities, while abstracting out the underlying bucket-based details. It also adds helper methods for querying changes in the data by prim and attribute. ### Functionality Overview Under the hood, an RtChangeTracker instance represents one listener in Fabric. Just like on the Fabric side, users add attribute names they are interested in tracking to the RtChangeTracker instance. The RtChangeTracker class closely mirrors Fabric’s functionality for managing the tracked attributes: - TrackAttribute(TfToken attrName) - StopTrackingAttribute(TfToken attrName) - PauseTracking() - ResumeTracking() - IsChangeTrackingPaused() - IsTrackingAttribute(TfToken attrName) - GetTrackedAttributes() When a change occurs on a tracked attribute, the change gets added to a persistent stack of changes. These changes accumulate over time in the change tracker. A user can query for the presence of any changes as needed, and clear any that have accumulated to “reset” the stack: - HasChanges() - ClearChanges() The RtChangeTracker class adds functionality atop Fabric’s change tracking that lets users query specific information from the stack of changes by prim and attribute: - GetAllChangedPrims() - GetAllChangedAttributes() - PrimChanged(UsdPrim prim) & PrimChanged(SdfPath primPath) - AttributeChanged(UsdAttribute attr) & AttributeChanged(SdfPath primPath) Currently, RtChangeTracker supports tracking changes to attribute values in a scene. Future work includes adding support for tracking the creation and deletion of prims, which is currently supported in Fabric. ### Usage Examples C++ ```cpp #include <usdrt/scenegraph/usd/rt/changeTracker.h> using namespace usdrt; UsdStageRefPtr stage = UsdStage::Open("./data/usd/tests/cornell.usda"); UsdPrim prim = stage->GetPrimAtPath(SdfPath("/DistantLight")); RtChangeTracker tracker(stage); tracker.TrackAttribute("color"); UsdAttribute color = prim.GetAttribute("color"); ```
class-list_Overview.md	# Overview An extension wraps around RTX Raycast Query to provide simpler raycast interface into the stage. ## Class List - IRaycastQuery: Interface class for Raycast Query operations. This class represents the interface for performing Raycast Query operations in the current scene. This class is thread-safe and can be called from any thread. There are two sets of functions to do raycast query: - The combination of `add_raycast_sequence` / `remove_raycast_sequence`, `submit_ray_to_raycast_sequence`, get_latest_result_from_raycast_sequence as a way to cast multiple rays into the scene and get result by polling. - `submit_raycast_query` as a single call that casts one Ray into the scene and returns hit result via callback. - Result: An enumeration class called “Result” which represents the possible error codes for a raycast query system. - RayQueryResult: Alias of the struct rtx::raytracing::RaycastQueryResult, represents the result of a raycast query. Inclued whether this query is valid, the hit position, normal and so on. - Ray: Alias of the struct rtx::raytracing::RaycastQueryRay, defines a ray that is used as input for a raycast query. ## Example Usage ```python import omni.kit.raycast.query from pxr import Gf # get raycast interface raycast = omni.kit.raycast.query.acquire_raycast_query_interface() # set up a cube for test stage = omni.usd.get_context().get_stage() CUBE_PATH = "/Cube" cube = UsdGeom.Cube.Define(stage, CUBE_PATH) UsdGeom.XformCommonAPI(cube.GetPrim()).SetTranslate(Gf.Vec3d(123.45, 0, 0)) # generate a ray ray = omni.kit.raycast.query.Ray((1000, 0, 0), (-1, 0, 0)) def callback(ray, result): if result.valid: # Got the raycast result in the callback print(Gf.Vec3d(result.hit_position)) ``` ```python print(result.hit_t) print(Gf.Vec3d(result.normal)) print(result.get_target_usd_path()) ``` ```python raycast.submit_raycast_query(ray, callback) ```
classes.md	# Classes - omni::avreality::rain::IPuddleBaker: Bakes puddle into dynamic textures. - omni::avreality::rain::IWetnessController: Controller scene level wetness parameters. - omni::avreality::rain::PuddleBaker: Bake puddles into dynamic textures. - omni::avreality::rain::WetnessController: Controller for scene level wetness parameters.
classomni_1_1avreality_1_1rain_1_1_puddle_baker.md	# omni::avreality::rain::PuddleBaker Defined in [omni/avreality/rain/PuddleBaker.h](#puddle-baker-8h) ## Functions - [PuddleBaker()=delete](#classomni_1_1avreality_1_1rain_1_1_puddle_baker_1a5471be17f6dcaa1d8b80fd9e419cf5cb) : Creates a new PuddleBaker. - [assignShadersAccumulationMapTextureNames(gsl::span< std::tuple< const pxr::SdfPath, const std::string > > shaderPathsAndTextureNames, omni::usd::UsdContext usdContext=nullptr)](#classomni_1_1avreality_1_1rain_1_1_puddle_baker_1a6d928e2c37ef74e4bd5feeec453432cb) - [bake(std::string textureName, carb::Uint2 textureDims, carb::Float2 regionMin, carb::Float2 regionMax, gsl::span< const carb::Float2 > puddlesPositions, gsl::span< const float > puddlesRadii, gsl::span< const float > puddlesDepths)](#classomni_1_1avreality_1_1rain_1_1_puddle_baker_1a9b667a91c8f838194bb16760530c6fd6) - [bake(std::string textureName, carb::Float2 regionMin, carb::Float2 regionMax, gsl::span< carb::Float2 > puddlesPositions, gsl::span< float > puddlesRadii, gsl::span< float > puddlesDepths)](#classomni_1_1avreality_1_1rain_1_1_puddle_baker_1ad2f231448a08e002e2b83a7c34981a38) ## Public Functions - PuddleBaker()=delete : Creates a new PuddleBaker. - assignShadersAccumulationMapTextureNames(gsl::span< std::tuple< const pxr::SdfPath, const std::string > > shaderPathsAndTextureNames, omni::usd::UsdContext usdContext=nullptr) - bake(std::string textureName, carb::Uint2 textureDims, carb::Float2 regionMin, carb::Float2 regionMax, gsl::span< const carb::Float2 > puddlesPositions, gsl::span< const float > puddlesRadii, gsl::span< const float > puddlesDepths) - bake(std::string textureName, carb::Float2 regionMin, carb::Float2 regionMax, gsl::span< carb::Float2 > puddlesPositions, gsl::span< float > puddlesRadii, gsl::span< float > puddlesDepths) Creates a new PuddleBaker. ### Public Static Functions ```cpp static inline void bake( std::string textureName, carb::Uint2 textureDims, carb::Float2 regionMin, carb::Float2 regionMax, gsl::span<const carb::Float2> puddlesPositions, gsl::span<const float> puddlesRadii, gsl::span<const float> puddlesDepths ) ``` Bake puddles to the dynamic texture `textureName`. > Warning > The size of puddlesPositions, puddlesRadii and puddlesDepths must be the same. - textureName – The name of the dynamic texture to bake into. - textureDims – The dimensions of the generated texture. - regionMin – The 2D world space minimum of the region the texture maps onto. - regionMax – The 2D world space maximum of the region the texture maps onto. - puddlesPositions – A pointer to the 2D positions of the puddles. - puddlesRadii – A pointer to the radii of the puddles. - puddlesDepths – A pointer to the depths of the puddles. ```cpp static inline void bake( std::string textureName, carb::Float2 regionMin, carb::Float2 regionMax, gsl::span<carb::Float2> puddlesPositions, gsl::span<float> puddlesRadii, gsl::span<float> puddlesDepths ) ``` Bake puddles to the dynamic texture `textureName`. > Note > Generated texture size defaults to 1024x1024. > Warning > The size of puddlesPositions, puddlesRadii and puddlesDepths must be the same. ### Parameters - textureName – The name of the dynamic texture to bake into. - regionMin – The 2D world space minimum of the region the texture maps onto. - regionMax – The 2D world space maximum of the region the texture maps onto. - puddlesPositions – A pointer to the 2D positions of the puddles. - puddlesRadii – A pointer to the radii of the puddles. - puddlesDepths – A pointer to the depths of the puddles. ### Parameters - usdContext – The Usd context holding the prims to update. - shaderPathsAndTextureNames – The shaders to assign the dynamic textures to, provided as a list of tuple of shader path and associated texture name.
classomni_1_1avreality_1_1rain_1_1_wetness_controller.md	# omni::avreality::rain::WetnessController Defined in [omni/avreality/rain/WetnessController.h](#) ## Functions - *WetnessController(omni::usd::UsdContext usdContext=nullptr) : Create a new scene wetness controller. - applyGlobalPorosity(float porosity) : Apply porosity value `porosity` to all SimPBR primitives supporting porosity. - applyGlobalPorosityScale(float porosityScale) : Apply porosityScale value `porosityScale` to all SimPBR primitives supporting porosity. - applyGlobalWaterAccumulation(float waterAccumulation) : Apply water accumulation value `waterAccumulation` to all SimPBR primitives supporting accumulation. - applyGlobalWaterAccumulationScale(float accumulationScale) : Apply accumulationScale value `accumulationScale` to all SimPBR primitives supporting accumulation. - applyGlobalWaterAlbedo(carb::ColorRgb waterAlbedo) : Apply albedo value `waterAlbedo` to all SimPBR primitives supporting accumulation. - applyGlobalWaterTransparency(float waterTransparency) : Apply water transparency value `waterTransoarency` to all SimPBR primitives supporting accumulation. - applyGlobalWetness(float wetness)** : Apply wetness value `wetness` to all SimPBR primitives supporting wetness. - applyGlobalWetnessState(bool state) : Set wetness state to `state` to all SimPBR primitives supporting wetness. - loadShadersParameters(omni::usd::UsdContext usdContext=nullptr) : Load shader parameters default values for USD shader when those values are not authored. - ~WetnessController() : Destroys this WetnessController. ### omni::avreality::rain::WetnessController Controller for scene level wetness parameters. #### Public Functions - WetnessController(omni::usd::UsdContext usdContext=nullptr) : Create a new scene wetness controller. - ~WetnessController() : Destroys this WetnessController. - void applyGlobalWetnessState(bool state) : Set wetness state to `state` to all SimPBR primitives supporting wetness. ### omni::avreality::rain::WetnessController::applyGlobalWetness(float wetness) - Description: Apply wetness value `wetness` to all SimPBR primitives supporting wetness. ### omni::avreality::rain::WetnessController::applyGlobalPorosity(float porosity) - Description: Apply porosity value `porosity` to all SimPBR primitives supporting porosity. ### omni::avreality::rain::WetnessController::applyGlobalPorosityScale(float porosityScale) - Description: Apply porosityScale value `porosityScale` to all SimPBR primitives supporting porosity. ### omni::avreality::rain::WetnessController::applyGlobalWaterAlbedo(carb::ColorRgb waterAlbedo) - Description: Apply albedo value `waterAlbedo` to all SimPBR primitives supporting accumulation. ### Public Static Functions #### loadShadersParameters(omni::usd::UsdContext* usdContext) - Description: Load shader parameters. #### applyGlobalWaterTransparency(float waterTransparency) - Description: Apply water transparency value `waterTransoarency` to all SimPBR primitives supporting accumulation. #### applyGlobalWaterAccumulation(float waterAccumulation) - Description: Apply water accumulation value `waterAccumulation` to all SimPBR primitives supporting accumulation. #### applyGlobalWaterAccumulationScale(float accumulationScale) - Description: Apply accumulationScale value `accumulationScale` to all SimPBR primitives supporting accumulation. = nullptr ) ## Load shader parameters default values for USD shader when those values are not authored. ### Warning Unstable API, subject to change.
class_structomni_1_1avreality_1_1rain_1_1_i_puddle_baker.md	# omni::avreality::rain::IPuddleBaker Defined in omni/avreality/rain/IPuddleBaker.h ## Variables - assignShadersAccumulationMapTextureNames: Assign dynamic textures to the water accumulation entry in the provided shader list. - bake: ## Class Definition ```cpp class IPuddleBaker ``` Bakes puddle into dynamic textures. > Warning > Low level ABI compatible interface. Common usage will be through the `PuddleBaker::PuddleBaker()` class. ### Public Members - bake ```cpp void bake(const char * const) ``` ``` textureName, carb::Uint2 textureDims, carb::Float2 regionMin, carb::Float2 regionMax, carb::Float2 puddleCount, std::size_t const carb::Float2 puddlesPositions, const float puddlesRadii, const float puddlesDepths Bake puddles to the dynamic texture `textureName`. !!! warning The size of puddlesPositions, puddlesRadii and puddlesDepths must match the size given as `puddleCount`. Param textureName: The name of the dynamic texture to bake into. * Param textureDims: The dimensions of the generated texture. * Param regionMin: The 2D world space minimum of the region the texture maps onto. * Param regionMax: The 2D world space maximum of the region the texture maps onto. * Param puddleCount: The number of puddles to bake. * Param puddlesPositions: A pointer to the 2D positions of the puddles. * Param puddlesRadii: A pointer to the radii of the puddles. * Param puddlesDepths: A pointer to the depths of the puddles. * assignShadersAccumulationMapTextureNames( gsl::span< const std::tuple< const char , const char > > shaderPathsAndTextureNames, const char * usdContextName ) Assign dynamic textures to the water accumulation entry in the provided shader list.
class_structomni_1_1avreality_1_1rain_1_1_i_wetness_controller.md	# omni::avreality::rain::IWetnessController Defined in [omni/avreality/rain/IWetnessController.h](#i-wetness-controller-8h) ## Variables - applyGlobalPorosity: Apply porosity value `porosity` to all SimPBR primitives supporting wetness. - applyGlobalPorosityScale: Apply porosity scale value `porosityScale` to all SimPBR primitives supporting wetness. - applyGlobalWaterAccumulation: Apply water accumulation value `accumulation` to all SimPBR primitives supporting wetness. - applyGlobalWaterAccumulationScale: Apply water accumulationScale value `waterAccumulationScale` to all SimPBR primitives supporting wetness. - applyGlobalWaterAlbedo: Apply water albedo value `waterAlbedo` to all SimPBR primitives supporting wetness. - applyGlobalWaterTransparency: Apply water transparency `waterTransparency` to all SimPBR primitives supporting wetness. - applyGlobalWetness: Apply wetness value `wetness` to all SimPBR primitives supporting wetness. - applyGlobalWetnessState: Apply wetness state to `state` to all SimPBR primitives supporting wetness. ### loadShadersParameters : Load shader parameters default values to the session layer. ### IWetnessController : Controller scene level wetness parameters. #### Warning Low level ABI compatible interface. Common usage will be through WetnessController class. #### Public Members ##### applyGlobalWetnessState Apply wetness state to `state` to all SimPBR primitives supporting wetness. ##### applyGlobalWetness Apply wetness value `wetness` to all SimPBR primitives supporting wetness. ##### applyGlobalPorosity Apply porosity value `porosity` to all SimPBR primitives supporting porosity. ```cpp void applyGlobalPorosity(float porosity, const char usdContextName); ``` Apply porosity value `porosity` to all SimPBR primitives supporting wetness. ```cpp void applyGlobalPorosityScale(float porosityScale, const char usdContextName); ``` Apply porosity scale value `porosityScale` to all SimPBR primitives supporting wetness. ```cpp void applyGlobalWaterAlbedo(carb::ColorRgb waterAlbedo, const char usdContextName); ``` Apply water albedo value `waterAlbedo` to all SimPBR primitives supporting wetness. ```cpp void applyGlobalWaterTransparency(float waterTransparency, const char usdContextName); ``` Apply water transparency value `waterTransparency` to all SimPBR primitives supporting wetness. ### applyGlobalWaterTransparency Apply water transparency `waterTransparency` to all SimPBR primitives supporting wetness. ### applyGlobalWaterAccumulation Apply water accumulation value `accumulation` to all SimPBR primitives supporting wetness. ### applyGlobalWaterAccumulationScale Apply water accumulationScale value `waterAccumulationScale` to all SimPBR primitives supporting wetness. ### loadShadersParameters ( * loadShadersParameters ) ( const char * usdContextName ) --- Load shader parameters default values to the session layer.
cleaning-up_ext_serialization.md	# Serialization (NvBlastExtSerialization) ## Introduction This extension defines the Nv::Blast::ExtSerialization class, a modular serialization manager which can be extended to handle data types from different Blast modules (such as low-level and Tk). An ExtSerialization manager is created using the global function NvBlastExtSerializationCreate: ```text ExtSerialization* ser = NvBlastExtSerializationCreate(); ``` ExtSerialization is capable of loading sets of serializers for different data types and encodings. The NvBlastExtSerialization extension comes with a set of low-level data serializers, with types enumerated in the header NvBlastExtLlSerialization.h. The low-level serializers are automatically loaded into an ExtSerialization when it is created. To load serializers for ExtTk assets, you must also load the extension [BlastTk Serialization (NvBlastExtTkSerialization)](ext_tkserialization.html). See the documentation for that module. Each serializer is capable of reading (and writing, if it is not read-only) a single data type in a single encoding (format). Some serializers are read-only, in order to read legacy formats. The encodings available are enumerated in ExtSerialization::EncodingID. They are currently: - CapnProtoBinary - Uses Cap’n Proto’s binary serialization format - Raw - For low-level NvBlastAsset and NvBlastFamily types, this is simply a memory copy. ## Serialization (writing) To serialize an object, the serialization manager’s write encoding ID must be set to the desired value. By default it is set to EncodingID::CapnProtoBinary, as this is the only encoding which supports writing for all object types (at the present time). When other encodings become available, use ExtSerialization::setSerializationEncoding to set the write encoding to the desired type. Each serialization module defines the object types it can serialize. ExtSerialization defines the low-level types in NvBlastExtLlSerialization.h: - LlObjectTypeID::Asset - An NvBlastAsset - LlObjectTypeID::Family - An NvBlastFamily To serialize an object, for example an NvBlastAsset, use ExtSerialization::serializeIntoBuffer as follows: ```text const NvBlastAsset* asset = ... // Given pointer to an NvBlastAsset void* buffer; uint64_t size = ser->serializeIntoBuffer(buffer, asset, LlObjectTypeID::Asset); ``` If successful, the data is written into a buffer allocated using the NvBlastGlobals allocator, written to the “buffer” parameter, and the size of the buffer written is the return value of the function. If the function returns 0, then serialization was unsuccessful. Notice that the second function parameter is actually a void, so it requires the last parameter to tell it what object it is serializing. A utility wrapper function is given in NvBlastExtLlSerialization.h* which performs the same operation with an NvBlastAsset, so one could equivalently use ```text void* buffer; uint64_t size = NvBlastExtSerializationSerializeAssetIntoBuffer(buffer, ser, asset); ``` A corresponding function also exists for NvBlastFamily, as well as other data types supported by other serialization extensions. This buffer may be written to disk, memory, networked, etc. Since the memory for the buffer is allocated using the allocator in NvBlastGlobals, it may be freed using the same allocator: ```text NVBLAST_FREE(buffer) ``` # Using a Buffer Provider If you wish to provide the serialization buffer by some means other than the NvBlastGlobals allocator, you may set a “buffer provider” in the serialization manager. A buffer provider is simply a callback that requests a buffer from the user of the necessary size. The user implements the interface ExtSerialization::BufferProvider, and passes a pointer to an instance of one to the serialization manager using ExtSerialization::setBufferProvider. For example: ```cpp std::vector<char> growableBuffer; class MyBufferProvider : public Nv::Blast::ExtSerialization::BufferProvider { public: MyBufferProvider(std::vector<char>& growableBuffer) : m_growableBuffer(growableBuffer) {} virtual void requestBuffer(size_t size) override { if (m_growableBuffer.size() < size) { m_growableBuffer.resize(size); } return m_growableBuffer.data(); } private: std::vector<char>& m_growableBuffer; } myBufferProvider(growableBuffer); ser->setBufferProvider(&myBufferProvider); ``` Passing NULL to setBufferProvider returns the serialization to its default behavior of using the NvBlastGlobals allocator. # Deserialization (reading) To deserialize an object, use the ExtSerialization::deserializeFromBuffer method. If you know the type of object in the buffer, you may directly cast the returned pointer to one of that type. For example, if the buffer contains an NvBlastAsset, use: ```cpp const void* buffer = ... // A given buffer, may be read from disk, memory, etc. const uint64_t size = ... // The buffer's size in bytes NvBlastAsset* asset = static_cast<NvBlastAsset>(ser->deserializeFromBuffer(buffer, size)); ``` This returns a valid pointer if deserialization was successful, or NULL otherwise. If no serializer is loaded which can handle the object type in the stream in its given encoding, it will fail and return NULL. Again, the memory for the asset is allocated using NvBlastGlobals, so that the asset may be released using ```cpp NVBLAST_FREE(asset); ``` # Detecting the Object Type in a Buffer If you don’t know the object type in the buffer, you may use the last (optional) argument in deserializeFromBuffer to return the type: ```cpp uint32_t objTypeID; void obj = ser->deserializeFromBuffer(buffer, size, &objTypeID); NVBLAST_CHECK_ERROR(obj != nullptr, "Object could not be read from buffer.", return); switch (objTypeID) { case LlObjectTypeID::Asset: handleAssetLoad(static_cast<NvBlastAsset>(obj)); break; case LlObjectTypeID::Family: handleFamilyLoad(static_cast<NvBlastFamily>(obj)); break; default: NVBLAST_LOG_ERROR("Unknown object type "); } ``` # Peeking at and Skipping Buffer Data If a buffer contains multiple objects, you may peek at the buffer to get object information including object type, encoding, and data size, and skip to the next object in the buffer (whether or not you have chosen to read the current object). For example: ```cpp const void* buffer = ... // The input buffer uint64_t size = ... // The input buffer size while (size) { uint64_t objTypeID; if (!ser->peekHeader(&objTypeID, NULL, NULL, buffer, size)) // Only reading the object type ID; may pass in NULL for the other header value pointers { break; // Read error, stop } if (objectShouldBeLoaded(objTypeID)) // Some function to determine whether or not we want this object { void* obj = ser->deserializeFromBuffer(buffer, size); // Handle loaded object ... } // Jump to next object: buffer = ser->skipObject(size, buffer); // Updates size as well } ``` # Cleaning Up When finished with the serialization manager, it may be released using its release() method: ```cpp ser->release(); ```
cli.md	# Omni Asset Validator (CLI) ## Command Line Interface Utility for USD validation to ensure layers run smoothly across all Omniverse products. Validation is based on the USD ComplianceChecker (i.e. the same backend as the usdchecker commandline tool), and has been extended with additional rules as follows: - Additional “Basic” rules applicable in the broader USD ecosystem. - Omniverse centric rules that ensure layer files work well with all Omniverse applications & connectors. - Configurable end-user rules that can be specific to individual company and/or team workflows. - Note this level of configuration requires manipulating PYTHONPATH prior to launching this tool. ## Syntax Use the following syntax to run asset validator: ```text usage: omni_asset_validator [-h] [-d 0\|1] [-c CATEGORY] [-r RULE] [-e] [-f] [-p PREDICATE] [URI] ``` ## Positional arguments ### URI A single Omniverse Asset. > Note: This can be a file URI or folder/container URI. (default: None) ## Options ### -h, –help show this help message and exit ### -d 0\| 1, –defaultRules 0\|1 Flag to use the default-enabled validation rules. Opt-out of this behavior to gain finer control over the rules using the –categories and –rules flags. The default configuration includes: - ByteAlignmentChecker - CompressionChecker - MissingReferenceChecker - StageMetadataChecker - TextureChecker - PrimEncapsulationChecker - NormalMapTextureChecker - KindChecker ## -c CATEGORY, –category CATEGORY Categories to enable, regardless of the –defaultRules flag. Valid categories are: - Basic - ARKit - Omni:NamingConventions - Omni:Layout - Omni:Material - Usd:Performance - Usd:Schema ## -r RULE, –rule RULE Rules to enable, regardless of the –defaultRules flag. Valid rules include: - ByteAlignmentChecker - CompressionChecker - MissingReferenceChecker - StageMetadataChecker - TextureChecker - PrimEncapsulationChecker - NormalMapTextureChecker - KindChecker - ExtentsChecker - TypeChecker - ARKitLayerChecker - ARKitPrimTypeChecker - ARKitShaderChecker - ARKitMaterialBindingChecker - ARKitFileExtensionChecker - ARKitPackageEncapsulationChecker - ARKitRootLayerChecker - OmniInvalidCharacterChecker - OmniDefaultPrimChecker - OmniOrphanedPrimChecker - OmniMaterialPathChecker - UsdAsciiPerformanceChecker - UsdLuxSchemaChecker - UsdGeomSubsetChecker - UsdMaterialBindingApi - UsdDanglingMaterialBinding OmniOrphanedPrimChecker OmniMaterialPathChecker UsdAsciiPerformanceChecker UsdLuxSchemaChecker UsdGeomSubsetChecker UsdMaterialBindingApi UsdDanglingMaterialBinding (default: []) ### -e, –explain Rather than running the validator, provide descriptions for each configured rule. (default: False) ### -f, –fix If this is selected, apply fixes. ### -p PREDICATE, –predicate PREDICATE Report issues and fix issues that match this predicate. Currently: IsFailure IsWarning IsError HasRootLayer See [Asset Validator](../../index.html) for more details. ### Command Line Interface using USD Composer #### Getting USD Composer installation path Open Omniverse Launcher. On Library / USD Composer, beside the `Launch` button click the burger menu to view the settings. On Settings we can see the path of USD Composer installation. Add it as environment variable. In Windows: ```bash set INSTALL_DIR=#See above set KIT_PATH=%INSTALL_DIR%\kit ``` In Linux: ```bash export INSTALL_DIR=#See above export KIT_PATH=${INSTALL_DIR}\kit ``` #### Getting Asset Validation Core path Open the Extension manager in USD Composer. In Windows / Extensions, select `omni.asset_validator.core` extension. On the extension information click on the path icon. Add it as environment variable. In Windows: ```bash set VALIDATION_PATH=#See above ``` In Linux: ```bash export VALIDATION_PATH=#See above ``` #### Examples ##### Calling the help command Windows: ```bash %KIT_PATH% --enable omni.asset_validator.core --exec "%VALIDATION_PATH%\scripts\omni_asset_validator.py --help" ``` Linux: ```bash ${KIT_PATH} --enable omni.asset_validator.core --exec "${VALIDATION_PATH}\scripts\omni_asset_validator.py --help" ``` ##### Validating a file Windows: ```bash %KIT_PATH% --enable omni.asset_validator.core --exec "%VALIDATION_PATH%\scripts\omni_asset_validator.py %VALIDATION_PATH%\scripts\test\asset.usda" ``` Linux: ```bash ${KIT_PATH} --enable omni.asset_validator.core --exec "${VALIDATION_PATH}\scripts\omni_asset_validator.py ${VALIDATION_PATH}\scripts\test\asset.usda" ``` # Validating a folder, recursively ## Windows: ```bash %KIT_PATH% --enable omni.asset_validator.core --exec "%VALIDATION_PATH%\scripts\omni_asset_validator.py %VALIDATION_PATH%\scripts\test\" ``` ## Linux: ```bash ${KIT_PATH} --enable omni.asset_validator.core --exec "${VALIDATION_PATH}\scripts\omni_asset_validator.py ${VALIDATION_PATH}\scripts\test\" ``` # Apply fixes on file ## Windows: ```bash %KIT_PATH% --enable omni.asset_validator.core --exec "%VALIDATION_PATH%\scripts\omni_asset_validator.py --fix %VALIDATION_PATH%\scripts\test\asset.usda" ``` ## Linux: ```bash ${KIT_PATH} --enable omni.asset_validator.core --exec "${VALIDATION_PATH}\scripts\omni_asset_validator.py --fix ${VALIDATION_PATH}\scripts\test\asset.usda" ``` # Apply fixes on a folder, specific category ## Windows: ```bash %KIT_PATH% --enable omni.asset_validator.core --exec "%VALIDATION_PATH%\scripts\omni_asset_validator.py --fix --category Usd:Schema %VALIDATION_PATH%\scripts\test\" ``` ## Linux: ```bash ${KIT_PATH} --enable omni.asset_validator.core --exec "${VALIDATION_PATH}\scripts\omni_asset_validator.py --fix --category Usd:Schema ${VALIDATION_PATH}\scripts\test\" ``` # Apply fixes on a folder, multiple categories ## Windows: ```bash %KIT_PATH% --enable omni.asset_validator.core --exec "%VALIDATION_PATH%\scripts\omni_asset_validator.py --fix --category Usd:Schema --category Basic %VALIDATION_PATH%\scripts\test\" ``` ## Linux: ```bash ${KIT_PATH} --enable omni.asset_validator.core --exec "${VALIDATION_PATH}\scripts\omni_asset_validator.py --fix --category Usd:Schema --category Basic ${VALIDATION_PATH}\scripts\test\" ``` # Apply predicates, single file ## Windows: ```bash %KIT_PATH% --enable omni.asset_validator.core --exec "%VALIDATION_PATH%\scripts\omni_asset_validator.py --predicate HasRootLayer %VALIDATION_PATH%\scripts\test\asset.usda" ``` ## Linux: ```bash ${KIT_PATH} --enable omni.asset_validator.core --exec "${VALIDATION_PATH}\scripts\omni_asset_validator.py --predicate HasRootLayer ${VALIDATION_PATH}\scripts\test\asset.usda" ```
client_library_api.md	# Omniverse Client Library API ## Class Hierarchy - struct OmniClientAclEntry - struct OmniClientAuthDeviceFlowParams - struct OmniClientBookmark - struct OmniClientBranchAndCheckpoint - struct OmniClientContent - struct OmniClientCredentials - struct OmniClientListEntry - struct OmniClientLiveUpdateInfo - struct OmniClientRetryBehavior - struct OmniClientServerInfo - struct OmniClientUrl - struct OmniClientWriteFileExInfo - enum OmniClientAccessFlags - enum OmniClientCacheBypassStatus - enum OmniClientChannelEvent - enum OmniClientConnectionStatus - enum OmniClientCopyBehavior - enum OmniClientFileStatus - enum OmniClientItemFlags - enum OmniClientListEvent - enum OmniClientListIncludeOption - enum OmniClientLiveUpdateType - enum OmniClientLogLevel ## File Hierarchy ### File * OmniClient.h * OmniClientAbi.h * OmniClientVersion.h ## Classes and Structs * OmniClientAclEntry: ACL Entry. * OmniClientAuthDeviceFlowParams: This struct contains data provided to the “Device Flow” authentication callback. * OmniClientBookmark: A bookmark. * OmniClientBranchAndCheckpoint: Branch & Checkpoint. * OmniClientContent: Content. * OmniClientCredentials: Credentials to sign in with. * OmniClientListEntry: List Entry. * OmniClientLiveUpdateInfo: This holds information about a live update that was queued. * OmniClientRetryBehavior: Parameters to control retry behavior. * OmniClientServerInfo: Server Info. * OmniClientUrl: A URL broken into the component pieces. * OmniClientWriteFileExInfo: This holds extra info provided by omniClientWriteFileEx. ## Enums * OmniClientAccessFlags: Access flags. * OmniClientCacheBypassStatus: Cache Bypass Status If enabled, the cache is being bypassed to workaround misbehaving cache. * OmniClientChannelEvent: Channel Event. * OmniClientConnectionStatus: Connection Status. * OmniClientCopyBehavior: Copy Behavior. * OmniClientFileStatus: File Status. * OmniClientItemFlags: Item flags. * OmniClientListEvent: List Subscribe Event. * OmniClientListIncludeOption: Stat/List Include Options. * OmniClientListSubscribeEvent: List Subscribe Event. * OmniClientListIncludeOption: Stat/List Include Options. * OmniClientLiveUpdateStatus: Live Update Status. ## Enumerations - OmniClientLiveUpdateType: Live Update Type. - OmniClientLogLevel: Log Level. - OmniClientResult: The primary result code returned by the asynchronous functions. ## Functions - omniClientAddBookmark: Add a URL to the list of bookmarks. - omniClientAddDefaultSearchPath: Add a default search path to the list of search paths used by resolve. - omniClientAddUserToGroup: Add user to a group. - omniClientAllocContent: Allocate a content buffer with the specified size. - omniClientAuthenticationCancel: Call this to cancel the current authentication process. - omniClientBreakUrl: Break a URL into components. - omniClientBreakUrlReference: Break a URL into components. - omniClientBypassListCache: Bypass the internal cache for list requests. - omniClientCombineUrls: This combines a URL with an explicit base URL. - omniClientCombineUrls2: This combines a URL with an explicit base URL. - omniClientCombineWithBaseUrl: This calls `omniClientCombineUrls` with the URL on the top of the stack. - omniClientCombineWithBaseUrl2: This calls `omniClientCombineUrls` with the URL on the top of the stack. - omniClientConfigFreeString: This is an internal function intended for unit tests. - omniClientConfigGetString: This is an internal function intended for unit tests. - omniClientConfigReload: This is an internal function intended for unit tests. - omniClientConfigSetInt: This is an internal function intended for unit tests. - omniClientCopy: Copy a thing from ‘srcUrl’ to ‘dstUrl’. - omniClientCopyContent: Copy a content buffer. - omniClientCreateCheckpoint: Create a checkpoint for a given URL (which can include a branch, otherwise assume the default branch) - omniClientCreateFolder: Create a folder. - omniClientCreateGroup: Create a group on server. - omniClientCreateWithHash: Create a new file with the hash known upfront. This can be used to avoid additional uploads of an asset that is already on the server. - omniClientDelete: Delete something (file, folder, mount, live object, channel etc..). - omniClientFreeBranchAndCheckpoint: Free the structure returned from omniClientGetBranchAndCheckpointFromQuery. - omniClientFreeContent: Free an allocated content buffer. - omniClientFreeUrl: Free the URL structure allocated by omniClientBreakUrlReference or omniClientBreakUrl. - omniClientGetAcls: Retrieve the ACLs for an item. - omniClientGetBaseUrl: Returns the top of the base URL stack. - omniClientGetBranchAndCheckpointFromQuery: Breaks a query string into the branch/checkpoint parameters. - omniClientGetCacheBypassStatusString: Retrieve a human readable string for a cache bypass status. - omniClientGetConnectionStatusString: Retrieve a human readable string for a connection status. - omniClientGetDefaultSearchPaths: Retrieve the current list of default search paths. - omniClientGetFileStatusString: Retrieve a human readable string for a file status. - omniClientGetGroups: Returns a list of all groups registered with the server. - omniClientGetGroupUsers: Returns a list of users associated with a group. - omniClientGetLocalFile: Get a local file name for the URL. - omniClientGetLogLevelChar: Retrieve a single character to represent a log level. - omniClientGetLogLevelString: Retrieve a human readable string for a log level. - omniClientGetOmniHubVersion: Check the version of the OmniHub. - omniClientGetReactor: Get access to the reactor. - omniClientGetResultString: Retrieve a human readable string from a result. - omniClientGetServerInfo: Retrieve information about the server for a specified URL. - omniClientGetUserGroups: Returns all groups a user belongs to. - omniClientGetUsers: Returns all users registered with the server. - omniClientGetVersionString: Returns a human-readable version string. - omniClientInitialize: Perform some one-time initialization. - omniClientJoinChannel: Start listening to a channel. - omniClientKvCacheGet: Retrieve a value/content from the KvCache which has been stored before by `omniClientKvCacheSet`. Still experimental, interface might change. - omniClientKvCacheSet: Store a value/content in the KvCache using a context/key pair as address. Still experimental, interface might change. - omniClientKvCacheStat: Check if a key exists in the KV cache, and optionally determine the size of the data. See `omniClientKvCacheSet`. Still experimental, interface might change. - omniClientList: Retrieve contents of a folder. This function is equivalent to omniClientList2 with eOmniClientListIncludeOption_DefaultNotDeleted. - omniClientList2: Retrieve contents of a folder. - omniClientListBookmarks: Register a callback to receive the list of bookmarks. - omniClientListCheckpoints: Returns a list of checkpoints for a URL. - omniClientListSubscribe: Subscribe to change notifications for a url. This function is equivalent to omniClientListSubscribe2 with eOmniClientListIncludeOption_DefaultNotDeleted. - omniClientListSubscribe2: Subscribe to change notifications for a url. - omniClientLiveConfigureJitterReduction: Set parameters that control jitter reduction. - omniClientLiveCreate: Create a live object. - omniClientLiveGetLatestServerTime: Returns the server timestamp of the most recently received message (0 if no messages have been received) - omniClientLiveProcess: Call this to send live updates to the server and process live updates received from the server. - omniClientLiveProcessUpTo: Same as `omniClientLiveProcess`. - omniClientLiveRead: Read a live object and set up a subscription to be notified of new updates to that object. - omniClientLiveRead2: This is the same as `omniClientLiveRead` except you don’t need to call omniClientLiveProcess. - omniClientLiveRegisterProcessUpdatesCallback: Register a callback to be notified that we are about to begin processing live updates. - omniClientLiveRegisterQueuedCallback2: Register a function to be called any time there’s an update in the queue that needs to be processed. - omniClientLiveSetQueuedCallback: Set a function to be called any time there’s an update in the queue that needs to be processed. - omniClientLiveUpdate: Update a live object. - omniClientLiveUpdate2: This is the same as `omniClientLiveUpdate` except you don’t need to call omniClientLiveProcess. - omniClientLiveWaitForPendingUpdates: Call this to wait for all pending live updates to complete. - omniClientLock: Lock a file so no other clients can modify it. - omniClientMakeFileUrl: This creates a “file:” URL from a path. - omniClientMakePrintable: This makes a URL safe for printing in a UI or to a console window. - omniClientMakeQueryFromBranchAndCheckpoint: This creates a query string from the parameters provided. - omniClientMakeRelativeUrl: This makes “otherUrl” relative to “baseUrl”. - omniClientMakeUrl: This creates a URL from the pieces provided. - omniClientMove: Move a thing from ‘srcUrl’ to ‘dstUrl’. - omniClientMoveContent: Attempt to take ownership of a content buffer. - omniClientNormalizeUrl: This normalizes a URL by parsing it then recomposing it. - omniClientObliterate: Obliterate a path. - omniClientPopBaseUrl: Pop a base URL from the context stack. - omniClientPushBaseUrl: Push a base URL for relative URLs to resolve against. - omniClientReadFile: Read the entire file. - omniClientReconnect: Attempt to reconnect, even if the previous connection attempt failed. - omniClientReferenceContent: Reference an existing content buffer. - omniClientRefreshAuthToken: This refreshes the auth token for a given URL. - omniClientRegisterAuthCallback: Register a callback to provide authentication credentials. - omniClientRegisterAuthDeviceFlowCallback: Register a function to be called when authenticating using “Device Flow”. - omniClientRegisterCacheBypassStatusCallback: Register a callback to receive cache bypass status updates. - omniClientRegisterConnectionStatusCallback: Register a callback to receive connection status updates. - omniClientRegisterFileStatusCallback: Register a callback to receive file transfer updates. - omniClientRemoveBookmark: Remove a URL from the list of bookmarks. - omniClientRemoveDefaultSearchPath: Remove a default search path from the list of search paths used by resolve. - omniClientRemoveGroup: Remove group from server. - omniClientRemoveUserFromGroup: Remove user from a group. - omniClientRenameGroup: Rename group on server. - omniClientResolve: Resolve operates similarly to stat with one major difference. - omniClientResolveSubscribe: Resolve an item, and subscribe to future changes. - omniClientSendMessage: Send a message to a channel. - omniClientSetAcls: Set ACLs for an item. - omniClientSetAlias: Redirect a URL to a different location. - omniClientSetAuthenticationMessageBoxCallback: Set a callback which is called instead of showing the “Please sign in using your browser” dialog. - omniClientSetAzureSASToken: Set Azure SAS token for a blob container. - omniClientSetCacheBypassStatus: Set the cache bypass status. The function will not call the callback registered with omniClientRegisterCacheBypassStatusCallback. - omniClientSetLogCallback: Set a log callback function. - omniClientSetLogLevel: Set the log level. ## Functions - `omniClientSetProductInfo`: Sets product information that’s sent to Nucleus when connecting. - `omniClientSetRetries`: Configure retry behavior. - `omniClientSetS3Configuration`: Set S3 configuration info for a given URL. - `omniClientShutdown`: Terminate all connections and free everything. - `omniClientSignOut`: Immediately disconnect from the server specified by this URL. - `omniClientStat`: Retrieve information about a single item. This function is equivalent to omniClientStat2 with eOmniClientListIncludeOption_DefaultNotDeleted. - `omniClientStat2`: Retrieve information about a single item. - `omniClientStatSubscribe`: Retrieve information about a single item, and subscribe to future changes. This function is equivalent to omniClientStatSubscribe2 with eOmniClientListIncludeOption_DefaultNotDeleted. - `omniClientStatSubscribe2`: Retrieve information about a single item, and subscribe to future changes. - `omniClientStop`: Stop an active request. - `omniClientTraceStart`: Start tracing using carb::tracer. - `omniClientTraceStop`: Stop tracing using carb::tracer. - `omniClientUndelete`: Restore a path. - `omniClientUnlock`: Unlock a file so other clients can modify it. - `omniClientUnregisterCallback`: Unregister a callback. - `omniClientWait`: Wait for a request to complete. - `omniClientWaitFor`: Wait for a request to complete, but with a timeout. - `omniClientWriteFile`: Create a new file, overwriting if it already exists. - `omniClientWriteFileEx`: Create a new file, overwriting if it already exists. ## Variables - `kInvalidRequestId`: This is returned if you call an asynchronous function after calling `omniClientShutdown`. - `kOmniClientVersion`: The version of this library. You can pass it to `omniClientInitialize` to verify that the dll which is loaded matches the header file you compiled against. ## Macros - BIT: Macro to help define bit fields. - OMNICLIENT_ABI - OMNICLIENT_BUILD_STRING: This is the full build string that is also returned by `omniClientGetVersionString`. - OMNICLIENT_CALLBACK_NOEXCEPT - OMNICLIENT_DEFAULT - OMNICLIENT_DEPRECATED - OMNICLIENT_EXPORT - OMNICLIENT_EXPORT_C - OMNICLIENT_EXPORT_CPP - OMNICLIENT_NOEXCEPT - OMNICLIENT_VERSION_BUILD: This unused, and is always 0. - OMNICLIENT_VERSION_MAJOR: Major version number. This will not change unless there is a major non-backwards compatible change. - OMNICLIENT_VERSION_MINOR: Minor version number. This changes with every release. - OMNICLIENT_VERSION_PATCH: Patch number. This will normally be 0, but can change if a fix is backported to a previous release. ## Typedefs - OmniClientAddUserToGroupCallback: This is called with the result of `omniClientAddUserToGroup`. - OmniClientAuthCallback: This allows you to provide credentials used to sign in to a server. - OmniClientAuthDeviceFlowCallback: This is called when connecting to a server using “Device Flow” authentication. - OmniClientAuthenticationMessageBoxCallback: This is called when the library needs to continue authentication in a web browser. - OmniClientBookmarkCallback: This is called with the list of bookmarks. - OmniClientCacheBypassStatusCallback: This is called any time any cache status changes. - OmniClientConnectionStatusCallback: This is called any time any connection status changes. - OmniClientCopyCallback: This is called with the result of - `omniClientCopy`: - `OmniClientCreateCheckpointCallback`: This is called with the result of `omniClientCreateCheckpoint`. - `OmniClientCreateFolderCallback`: This is called with the result of `omniClientCreateFolder`. - `OmniClientCreateGroupCallback`: This is called with the result of `omniClientCreateGroup`. - `OmniClientCreateWithHashCallback`: This is called with the result of `omniClientCreateWithHash`. - `OmniClientDeleteCallback`: This is called with the result of `omniClientDelete`. - `OmniClientFileStatusCallback`: This is called any time any file status changes. - `OmniClientGetAclsCallback`: This is called with the result of `omniClientGetAcls`. - `OmniClientGetGroupsCallback`: This is called with the result of `omniClientGetGroups`. - `OmniClientGetGroupUsersCallback`: This is called with the result of `omniClientGetGroupUsers`. - `OmniClientGetLocalFileCallback`: This is called with the result of `omniClientGetLocalFile`. - `OmniClientGetOmniHubVersionCallback`: Called with the result of `omniClientGetOmniHubVersion`. - `OmniClientGetServerInfoCallback`: This is called with the results of `omniClientGetServerInfo`. - `OmniClientGetUserGroupsCallback`: This is called with the result of `omniClientGetUserGroups`. - `OmniClientGetUsersCallback`: This is called with the result of `omniClientGetUsers`. - `omniClientGetUsers`: - `OmniClientJoinChannelCallback`: This is called with the result of `omniClientJoinChannel`. - `OmniClientKvCacheGetCallback`: Called with the result of `omniClientKvCacheGet`. result will be eOmniClientResult_Ok if content is a valid pointer, and eOmniClientResult_ErrorNotFound if the key doesn’t exist. Other error codes indicate connection errors to OmniHub. The content’s memory can be acquired by `omniClientMoveContent` or copied out, as the library will free the memory once the callback returns if it is not moved. - `OmniClientKvCacheSetCallback`: Called with the result of `omniClientKvCacheSet`. - `OmniClientKvCacheStatCallback`: Called with the result of `omniClientKvCacheStat`. - `OmniClientListCallback`: This is called with the results of `omniClientList` and `omniClientListSubscribe`. - `OmniClientListCheckpointsCallback`: This is called with the result of `omniClientListCheckpoints`. - `OmniClientListSubscribeCallback`: This is called any time an item you’ve subscribed to with `omniClientListSubscribe` changes. - `OmniClientLiveCreateCallback`: Called with the result of `omniClientLiveCreate`. - `OmniClientLiveProcessUpdatesCallback`: This is called any time `omniClientLiveProcess`, `omniClientLiveProcessUpTo`, or `omniClientLiveWaitForPendingUpdates` is called. - `OmniClientLiveQueuedCallback`: This is called any time we receive a live update from the network. - `OmniClientLiveQueuedCallback2`: This is called any time we receive a live update from the network. - `OmniClientLiveReadCallback`: Called with the result of `omniClientLiveRead`. - `OmniClientLiveReadCallback`: Called with the result of `omniClientLiveRead`. - OmniClientLiveUpdateCallback: Called with the result of `omniClientLiveUpdate`. - OmniClientLockCallback: This is called with the result of `omniClientLock`. - OmniClientLogCallback: This is called from a background thread any time the library wants to print a message to the log. - OmniClientMoveCallback: This is called with the result of `omniClientMove`. - OmniClientObliterateCallback: This is called with the result of `omniClientObliterate`. - OmniClientReadFileCallback: This is called with the result of `omniClientReadFile`. - OmniClientRefreshAuthTokenCallback: This is called with the results of `omniClientRefreshAuthToken`. - OmniClientRemoveGroupCallback: This is called with the result of `omniClientRemoveGroup`. - OmniClientRemoveUserFromGroupCallback: This is called with the result of `omniClientRemoveUserFromGroup`. - OmniClientRenameGroupCallback: This is called with the result of `omniClientRenameGroup`. - OmniClientRequestId: Request Id returned from all the asynchronous functions. - OmniClientResolveCallback: This is called with the result of `omniClientResolve` or `omniClientResolveSubscribe`. - OmniClientResolveSubscribeCallback: This is called any time an item you’ve subscribed to with `omniClientResolveSubscribe` changes. - OmniClientSendMessageCallback: This is called with the result of `omniClientSendMessage`. - OmniClientSetAclsCallback: This is called with the result of omniClientSetAcls. - OmniClientStatCallback: This is called with the results of omniClientStat or omniClientStatSubscribe. - OmniClientStatSubscribeCallback: This is called any time an item you’ve subscribed to with omniClientStatSubscribe changes. - OmniClientUndeleteCallback: This is called with the result of omniClientUndelete. - OmniClientUnlockCallback: This is called with the result of omniClientUnlock. - OmniClientWriteFileCallback: This is called with the result of omniClientWriteFile. - OmniClientWriteFileExCallback: This is called with the result of omniClientWriteFileEx.
clone-the-kit-app-template-github-repository_developer_setup.md	# Project Setup ## Visual Studio Code Download and install Visual Studio Code. Standard installation works for this tutorial. ## Clone the kit-app-template GitHub Repository Use a preferred method to download the repo. Here is how clone kit-app-template from within Visual Studio: 1. Open VSCode. 2. Open the command palette using `Ctrl + Shift + P`. 3. In the palette prompt enter gitcl then select `Git: Clone` command. 4. Paste `https://github.com/NVIDIA-Omniverse/kit-app-template` into the repository URL then select Clone from URL. 5. Select (or create) the local directory into which you want to clone the project. 6. Once it has finished cloning it will ask if you want to open the cloned repository, select `Open`. 7. Set the terminal to use `Command Prompt` so the syntax in the [Command Cheat-Sheet](commands.html) is supported. ![VS Code Terminal](_images/vs_code_terminal.png) Once the project has been downloaded, make sure it’s open in VSCode. Note: VSCode may recommend installing VSCode Extensions such as the Python Extension. VSCode Extensions are not the same as Kit SDK Extensions. Feel free to install those for VSCode to improve developer workflows. ## Project Overview Before changing or adding anything let’s review the starting point. This kit-app-template project is a barebone starting point and additional files will be added as tools are used. Here is an outline of the core project: \| Directory Item \| Purpose \| \|----------------\|---------\| \| docs \| Source files for building documentation. \| \| source \| Source files for Applications, Services, and Extensions. \| \| tools \| Tools and configurations for making builds and packages. \| \| .editorconfig \| [EditorConfig](https://editorconfig.org/) file. \| ## Verify Project Starting Point Let’s make sure the core functionality works before creating new solutions. 1. Open a terminal in VSCode and run a build - see `build` command in [Command Cheat-Sheet](commands.html). Internet access to NVIDIA repositories is required as dependencies are downloaded as part of the build process. Subsequent builds will be faster as dependencies no longer need to be downloaded. 2. Notice the additional directories that are created in the root directory after the build has completed: - _build: Debug and release builds of apps. Packages. Built docs. - _compiler: Solution files. - _repo: Links to installed `repo` tools. Important: The directories named with an underscore are safe to delete. They are generated by `repo` and `build` commands. 3. Start an app included in the project. - Windows: `.\_build\windows-x86_64\release\my_name.my_app.bat`. - Linux: `./_build/linux-x86_64/release/my_name.my_app.sh`. 4. An Application should launch - presenting a viewport, content browser, and a few other panels. This is a basic functional USD viewer Application within the Kit SDK itself. If there were errors causing the apps not to run then please start over - making sure not to make any changes prior to this section. Now you are ready to either continue with the tutorial or develop Applications and Extensions on your own.
CODING.md	# Coding Style Guidelines This document covers style guidelines for the various programming languages used in the Carbonite codebase. ## C/C++ Coding Conventions This covers the basic coding conventions and guidelines for all C/C++ code that is submitted to this repository. - It’s expected that you will not love every convention that we’ve adopted. - These conventions establish a modern and hybrid C/C++14 style. - Please keep in mind that it’s impossible to make everybody happy all the time. - Instead appreciate the consistency that these guidelines will bring to our code and thus improve the readability for others. - Coding guidelines that can be enforced by clang-format will be applied to the code. This project heavily embraces a plugin architecture. Please consult [Architectural Overview](docs/Architecture.html) for more information. ### Repository The project should maintain a well structured layout where source code, tools, samples and any other folders needed are separated, well organized and maintained. The convention has been adopted to group all generated files into top-level folders that are prefixed with an underscore, this makes them stand out from the source controlled folders and files while also allowing them to be easily cleaned out from local storage (Ex. `rm -r _`). This is the layout of the Carbonite* project repository: \| Item \| Description \| \| --- \| --- \| \| .vscode \| Visual Studio Code configuration files. \| \| _build \| Build target outputs (generated). \| \| _compiler \| Compiler scripts, IDE projects (generated). \| \| deps \| External dependency configuration files. \| \| docs \| Carbonite documentation. \| \| include/carb \| Public includes for consumers of Carbonite SDK. \| \| tools \| Small tools or boot-strappers for the project. \| \| source \| All source code for project. \| \| source/bindings \| Script bindings for Carbonite SDK. \| \| source/examples \| Examples of using Carbonite. \| \| Folder/File \| Description \| \| --- \| --- \| \| source/framework \| Carbonite framework implementation. \| \| source/tests \| Source code for tests of Carbonite. \| \| source/tools \| Source code for tools built with Carbonite. \| \| source/plugins \| Carbonite plugin implementations. \| \| source/plugins/carb.assets \| The carb.assets.plugin implementation \| \| source/plugins/carb.graphics-direct3d \| The implementation of carb.graphics interface for Direct3D12 \| \| source/plugins/carb.graphics-vulkan \| The implementation of carb.graphics interface for Vulkan \| \| .clang-format \| Configuration for running clang format on the source code. \| \| .editorconfig \| Maintains editor and IDE style conformance Ex. Tabs/Spaces. \| \| .flake8 \| Configuration for additional coding style conformance. \| \| .gitattributes \| Governs repository attributes for git repository. \| \| .gitignore \| Governs which files to ignore in the git repository. \| \| build.bat \| Build script to build debug and release targets on Windows. \| \| build.sh \| Build script to build debug and release targets on Linux. \| \| CODING.md \| These coding guidelines. \| \| format_code.bat \| Run this to format code on Windows before submitting to repository. \| \| format_code.sh \| Run this to format code on Linux before submitting to repository. \| \| prebuild.bat \| Run this to generate visual studio solution files on Windows into _compiler folder. \| \| premake5.lua \| Script for configuration of all build output targets using premake. \| \| setup.sh \| Setup run once installation script of Linux platform dependencies. \| \| README.md \| The summary of any project information you should read first. \| One important rule captured in the above folder structure is that public headers are stored under `include/carb` folder but implementation files and private headers are stored under `source` folders. ### Include There are four rules to be followed when writing include statements correctly for Carbonite: 1. Do not include `Windows.h` in header files as it is monolithic and pollutes the global environment for Windows. Instead, a much slimmer CarbWindows.h exists to declare only what is needed by Carbonite. If additional Windows constructs are desired, add them to CarbWindows.h. There are instructions in that file for how to handle typedefs, enums, structs and functions. `Windows.h` should still be included in compilation units (cpp and c files); CarbWindows.h exists solely to provide a minimal list of Windows declarations for header files. Example from a file in `include/carb/extras`: ```cpp #include "../Defines.h" #if CARB_PLATFORM_WINDOWS # include "../CarbWindows.h" ``` #endif 2. Public headers (located under `include/carb`) referencing each other always use path-relative include format: ```cpp #include "../Defines.h" #include "../container/LocklessQueue.h" #include "IAudioGroup.h" ``` 3. Includes of files that are not local to Carbonite (or are pulled in via package) use the search path format. Carbonite source files (under `source/`) may also use search-path format for Carbonite public headers (under `include/carb/`): ```cpp #include <carb/graphics/Graphics.h> // via packman package #include <doctest/doctest.h> ``` 4. All other includes local to Carbonite use the path-relative include format: ```cpp #include "MyHeader.h" #include "../ParentHeader.h" ``` In the example above `MyHeader.h` is next to the source file and `ParentHeader.h` is one level above. It is important to note that these relative includes are not allowed to cross package boundaries. If parts are shipped as separate packages the includes must use the angle bracket search path format in item 1 when referring to headers from other packages. We do also have rules about ordering of includes but all of these are enforced by format_code.{bat\|sh} so there is no need to memorize them. They are captured here for completeness: 1. Matching header include for cpp file is first, if it exists - in a separate group of one file. This is to ensure self-sufficiency. 2. carb/Defines.h is it’s own group of one file to ensure that it is included before other includes. 3. Other local includes are in the third group, alphabetically sorted. 4. Search path includes to Carbonite are in the fourth group (`#include <carb/>`), alphabetically sorted. 5. Other 3rd party includes are in the fifth group (`#include </>`), alphabetically sorted. 6. System includes are in the sixth and final group, alphabetically sorted. Here is an example from `AllocationGroup.cpp` (doesn’t have the fifth group) ```cpp #include "AllocationGroup.h" #include <carb/Defines.h> #include "StackEntry.h" #include <carb/logging/Log.h> #if CARB_PLATFORM_LINUX # include <signal.h> #endif ``` Two things are worth noting about the automatic grouping and reordering that we do with format_code script. If you need to associate a comment with an include put the comment on the same line as the include statement - otherwise clang-format will not move the chunk of code. Like this: ```cpp #include <stdlib.h> // this is needed for size_t on Linux ``` Secondly, if include order is important for some files just put `// clang-format off` and `// clang-format on` around those lines. ## Files - Header files should have the extension `.h`, since this is least surprising. - Source files should have the extension `.cpp`, since this is least surprising. - `.cc` is typically used for UNIX only and not recommended. - Header files must include the preprocessor directive to only include a header file once. ```cpp #pragma once ``` - Source files should include the associated header in the first line of code after the commented license banner. - All files must end in blank line. - Header and source files should be named with `PascalCase` according to their type names and placed in their - Appropriate namespaced folder paths, which are in lowercase. A file that doesn’t represent a type name should nevertheless start with uppercase and be written in PascalCase, Ex. `carb/Defines.h`. - Type \| Path - --- \| --- - carb::assets::IAssets \| ./include/carb/assets/IAssets.h - carb::audio::IAudioPlayback \| ./include/carb/audio/IAudioPlayback.h - carb::settings::ISettings \| ./include/carb/settings/ISettings.h - This allows for inclusion of headers that match code casing while creating a unique include path: ```cpp #include <carb/assets/IAssets.h> #include <carb/audio/IAudioPlayback.h> #include <carb/settings/ISettings.h> ``` - In an effort to reduce difficulty downstream, all public header files (i.e. those under the include* directory) must not use any identifier named `min` or `max`. This is an effort to coexist with `#include <Windows.h>` where `NOMINMAX` has not been specified: - Instead, `include/carb/Defines.h` has global symbols `carb_min()` and `carb_max()` that may be used in similar fashion to `std::min` and `std::max`. - For rare locations where it is necessary to use `min` and `max` (i.e. to use `std::numeric_limits<>::max()` for instance), please use the following construct: ```cpp #pragma push_macro("max") // or "min" #undef max // or min /* use the max or min symbol as you normally would / #pragma pop_macro("max") // or "min" ``` - Similarly, the identifier `interface` can be problematic since `Windows.h` defines that as `class`. Use of identifiers named `interface` should be replaced by something else, such as `iface`, to avoid conflicts. Note that if unity builds are being used, it may also be necessary to avoid using both `interface` and `min/max` as identifiers even in .cpp files. ## Namespaces Before we dive into usage of namespaces it’s important to establish what namespaces were originally intended for. They were added to prevent name collisions. Instead of each group prefixing all their names with a unique identifier they could now scope their work within a unique namespace. The benefit of this was that implementers could write their implementations within the namespace and did therefore not have to prefix that code with the namespace. However, when adding this feature a few other features were also added and that is where things took a turn for the worse. Outside parties can alias the namespace, i.e. give it a different name when using it. This causes confusion because now a namespace is known by multiple names. Outside parties can hoist the namespace, effectively removing the protection. Hoisting can also be used within a user created namespace to introduce another structure and names for 3rd party namespaces, for an even higher level of confusion. Finally, the namespaces were designed to support nesting of namespaces. It didn’t take long for programmers to [run away with this feature for organization](https://punchlet.wordpress.com/2011/06/18/letter-the-sixth-belatedly/). Nested namespaces stem from a desire to hierarchically organize a library but this is at best a convenience for the implementer and a nuisance for the consumer. Why should our consumers have to learn about our internal organization hierarchy? It should be noted here that the aliasing of namespaces and hoisting of namespaces are often coping mechanisms for consumers trapped in deeply nested namespaces. So, essentially the C++ committee created both the disease and the palliative care. What consumers really need is a namespace to protect their code from clashing with code in external libraries that they have no control over. Notice the word a* in there. Consumers don’t need nested levels of namespaces in these libraries - one is quite enough for this purpose. This also means that a namespace should preferably map to a team or project, since such governing bodies can easily resolve naming conflicts within their namespace when they arise. With the above in mind we have developed the following rules: - The C++ namespace should be project and/or team based and easily associated with the project. - Ex. The Carbonite project namespace is `carb::` and is managed by the Carbonite team - This avoids collisions with other external and internal NVIDIA project namespaces. - We do not use a top level `nvidia::` namespace because there is no central governance for this namespace, additionally this would lead to a level of nesting that benefits no one. - Namespaces are all lowercase. - This distinguishes them from classes which is important because the usage is sometimes similar. - This encourages short namespace names, preferably a single word; reduces chances of users hoisting them. - Demands less attention when reading, which is precisely what we want. We want people to use them for protection but not hamper code readability. - Exposed namespaces are no more than two levels deep. - One level deep is sufficient to avoid collisions since by definition the top level namespace is always managed by a governing body (team or project) - A second level is permitted for organization; we accept that in larger systems one level of organization is justifiable (in addition to the top level name-clash preventing namespace). Related plugin interfaces and type headers are often grouped together in a namespace. - Other NVIDIA projects can make plugins and manage namespace and naming within. These rules don’t really apply because we don’t have governance for such projects. However, we recommend that these rules be followed. For a single plugin a top level namespace will typically suffice. For a collection of plugins a single top level namespace may still suffice, but breaking it down into two levels is permitted by these guidelines. - We don’t add indentation for code inside namespaces. - This conserves maximum space for indentation inside code. - We don’t add comments for documenting closing of structs or definitions, but it’s OK for namespaces because they often span many pages and there is no indentation to help: Name Prefixing and Casing ----------------------- The following table outlines the naming prefixing and casing used: \| Construct \| Prefixing / Casing \| \|----------------------------\|--------------------\| \| class, struct, enum class and typedef \| PascalCase \| \| constants \| kCamelCase \| \| enum class values \| eCamelCase \| \| functions \| camelCase \| \| private/protected functions\| _camelCase \| \| exported C plugin functions\| carbCamelCase \| \| public member variables \| camelCase \| \| private/protected member variables \| m_camelCase \| \| private/protected static member variables \| s_camelCase \| \| global - static variable at file or project scope \| g_camelCase \| \| local variables \| camelCase \| # camelCase When a name includes an abbreviation or acronym that is commonly written entirely in uppercase, you must still follow the casing rules laid out above. For instance: ```cpp void* gpuBuffer; // not GPUBuffer struct HtmlPage; // not HTMLPage struct UiElement; // not UIElement using namespace carb::io; // namespaces are always lowercase ``` ## Naming - Guidelines - All names must be written in US English. ```cpp std::string fileName; // NOT: dateiName uint32_t color; // NOT: colour ``` - The following names cannot be used according to the C++ standard: - names that are already keywords; - names with a double underscore anywhere are reserved; - names that begin with an underscore followed by an uppercase letter are reserved; - names that begin with an underscore are reserved in the global namespace. - Method names must always begin with a verb. - This avoids confusion about what a method actually does. ```cpp myVector.getLength(); myObject.applyForce(x, y, z); myObject.isDynamic(); texture.getFormat(); ``` - The terms get/set or is/set (bool) should be used where an attribute is accessed directly. - This indicates there is no significant computation overhead and only access. ```cpp employee.getName(); employee.setName("Jensen Huang"); light.isEnabled(); light.setEnabled(true); ``` - Use stateful names for all boolean variables. (Ex bool enabled, bool m_initialized, bool g_cached) and leave questions for methods (Ex. isXxxx() and hasXxxx()) ```cpp bool isEnabled() const; void setEnabled(bool enabled); void doSomething() { bool initialized = m_coolSystem.isInitialized(); ... } ``` - Please consult the antonym list if naming symmetric functions. - Avoid redundancy in naming methods and functions. - The name of the object is implicit, and must be avoided in method names. ```cpp line.getLength(); // NOT: line.getLineLength(); ``` - Function names must indicate when a method does significant work. ```cpp float waveHeight = wave.computeHeight(); // NOT: wave.getHeight(); ``` - Avoid public method, arguments and member names that are likely to have been defined in the preprocessor. - When in doubt, use another name or prefix it. ```cpp size_t malloc; // BAD size_t bufferMalloc; // GOOD ``` ```cpp int min, max; // BAD int boundsMin, boundsMax; // GOOD ``` - Avoid conjunctions and sentences in names as much as possible. - Use `Count` at the end of a name for the number of items. ```cpp size_t numberOfShaders; // BAD size_t shaderCount; // GOOD VkBool32 skipIfDataIsCached; // BAD VkBool32 skipCachedData; // GOOD ``` ## Internal code For public header files, a `detail` namespace should be used to declare implementation as private and subject to change, as well as signal to external users that the functions, types, etc. in the `detail` namespace should not be called. Within a translation unit (.cpp file), use an anonymous namespace to prevent external linkage or naming conflicts within a module: ```cpp namespace // anonymous { struct OnlyForMe { }; } ``` In general, prefer anonymous namespaces over `static`. ## Deprecation and Retirement As part of the goal to minimize major version changes, interface functions may be deprecated and retired through the Deprecation and Retirement Guidelines section of the Architectural Overview. ## Shader naming HLSL shaders must have the following naming patterns to properly work with our compiler and slangc.py script: - HLSL shader naming: - if it contains multiple entry points or stages: [shader name].hlsl - if it contains a single entry point and stage: [shader name].[stage].hlsl - Compiled shader naming: [shader name].[entry point name].[stage].dxil/dxbc/spv[.h] - Do not add extra dots to the names, or they will be ignored. You may use underscore instead. ```cpp basic_raytracing.hlsl // Input: DXIL library with multiple entry points basic_raytracing.chs.closesthit.dxil // Output: entry point: chs, stage: closesthit shader color.pixel.hlsl // Input: a pixel shader color.main.pixel.dxbc // Output: entrypoint: main, stage: pixel shader ``` ## Rules for class - Classes that should not be inherited from should be declared as `final`. - Each access modifier appears no more than once in a class, in the order: `public`, `protected`, `private`. - All `public` member variables live at the start of the class. They have no prefix. If they are accessed in a member function that access must be prefixed with `this->` for improved readability and reduced head-scratching. - All `private` member variables live at the end of the class. They are prefixed with `m_`. They should be accessed directly in member functions, adding `this->` to access members in the same class is unnecessary. ## Rules for class - Member variables are judiciously prefixed with `m_`. They should be accessed directly in member functions, adding `this->` to access them is unnecessary. - Constructors and destructor are first methods in a class after `public` member variables unless private scoped in which case they are first `private` methods. - The implementations in cpp should appear in the order which they are declared in the class. - Avoid `inline` implementations unless trivial and needed for optimization. - Use the `override` specifier on all overridden virtual methods. Also, every member function should have at most one of these specifiers: `virtual`, `override`, or `final`. - Do not override pure-virtual method with another pure-virtual method. - Here is a typical class layout: ```cpp #pragma once namespace carb { namespace ui { /** * Defines a user interface widget. / class Widget { public: Widget(); ~Widget(); const char getName() const; void setName(const char* name); bool isEnabled() const; bool setEnabled(bool enabled); private: char* m_name; bool m_enabled; }; } } ``` ## Rules for struct - We make a clear distinction between structs and classes. - We do not permit any member functions on structs. Those we make classes. - If you must initialize a member of the struct then use C++14 static initializers for this, but don’t do this for basic types like a Float3 struct because default construction/initialization is not free. - No additional scoping is needed on struct variables. - Not everything needs to be a class object with logic. - Sometimes it’s better to separate the data type from the functionality and structs are a great vehicle for this. - For instance, vector math types follow this convention. - Allows keeping vector math functionality internalized rather than imposing it on users. - Here is a typical struct with plain-old-data (pod): ```cpp struct Float3 { float x; float y; float z; }; // check this out (structs are awesome): Float3 pointA = {0}; Float3 pointB = {1, 0, 0}; ``` ## Rules for function - When declaring a function that accepts a pointer to a memory area and a counter or size for the area we should place them in a fixed order: the address first, followed by the counter. Additionally, `size_t` must be used as the type for the counter. ```cpp void readData(const char* buffer, size_t bufferSize); ``` ```cpp void setNames(const char* names, size_t nameCount); void updateTag(const char* tag, size_t tagLength); ``` ## Rules for enum class and bit flags * We use `enum class` over `enum` to support namespaced values that do not collide. * Keep their names as simple and short-and-sweet as possible. * If you have an enum class as a subclass, then it should be declared inside the class directly before the constructor and destructor. * Here is a typical enum class definition: ```cpp class Camera { public: enum class Projection { ePerspective, eOrthographic }; Camera(); ~Camera(); }; ``` * The values are accessed like this: * `EnumName::eSomeValue` * Note that any sequential or non-sequential enumeration is acceptable - the only rule is that the type should never be able to hold the value of more than one enumeration literal at any time. An example of a type that violates this rule is a bit mask. Those should not be represented by an enum. Instead use constant integers (constexpr) and group them by a prefix. Also, in a `cpp` file you want them to also be `static`. Below we show an example of a bit mask and bit flags in Carbonite: ```cpp namespace carb { namespace graphics { constexpr uint32_t kColorMaskRed = 0x00000001; // static constexpr in .cpp constexpr uint32_t kColorMaskGreen = 0x00000002; constexpr uint32_t kColorMaskBlue = 0x00000004; constexpr uint32_t kColorMaskAlpha = 0x00000008; } namespace input { /** * Type used as an identifier for all subscriptions. / typedef uint32_t SubscriptionId; /* * Defines possible press states. / typedef uint32_t ButtonFlags; constexpr uint32_t kButtonFlagNone = 0; constexpr uint32_t kButtonFlagTransitionUp = 1; constexpr uint32_t kButtonFlagStateUp = (1 << 1); constexpr uint32_t kButtonFlagTransitionDown = (1 << 2); constexpr uint32_t kButtonFlagStateDown = (1 << 3); } } ``` ## Rules for Pre-processors and Macros It’s recommended to place preprocessor definitions in the source files instead of makefiles/compiler/project files. - Try to reduce the use of `#define` (e.g. for constants and small macro functions), and prefer `constexpr` values or functions when possible. - Definitions in the public global namespace must be prefixed with the namespace in uppercase: - Indent macros that are embedded within one another. - All `#define`s should be set to 0, 1 or some other value. Accessing an undefined macro in Carbonite is an error. - All checks for Carbonite macros should use `#if` and not `#ifdef` or `#if defined()` - Macros that are defined for all of Carbonite should be placed in carb/Defines.h - Transient macros that are only needed inside of a header file should be `#undef`ed at the end of the header file. - `CARB_POSIX` is set to `_POSIX_VERSION` on platforms that are mostly POSIX conformant, such as Linux and MacOS. `CARB_POSIX` is set to `0` on other platforms. Functions used in these blocks should be verified to actually follow the POSIX standard, rather than being common but non-standard (e.g. `ptrace`). Non-standard calls inside `CARB_POSIX` blocks should be wrapped in a nested platform check, such as `CARB_PLATFORM_LINUX`. - When adding `#if` pre-processor blocks to support multiple platforms, the block must end with an `#else` clause containing the `CARB_UNSUPPORTED_PLATFORM()` macro. An exception to this is when the `#else` block uses entirely C++ standard code; this sometimes happens in the case of platform-specific optimizations. This logic also applied to `#if` directives nested in an `#if` block for a standard, such as `CARB_POSIX` where the `#else` block follows that platform. In other words, you may not make assumptions about what features future platforms may have, aside from what’s in the C++ standard; all platform-specific code must have the associated platform specifically stated. - Macros that do not have universal appeal (i.e. are only intended to be used within a single header file) shall be prefixed with `CARBLOCAL_` and `#undef`’d at the end of the file. - When adding `#if` pre-processor blocks to support multiple platforms, the block must end with an `#else` clause containing the `CARB_UNSUPPORTED_PLATFORM()` macro. An exception to this is when the `#else` block uses entirely C++ standard code; this sometimes happens in the case of platform-specific optimizations. This logic also applied to `#if` directives nested in an `#if` block for a standard, such as `CARB_POSIX` where the `#else` block follows that platform. In other words, you may not make assumptions about what features future platforms may have, aside from what’s in the C++ standard; all platform-specific code must have the associated platform specifically stated. ## Porting to new platforms This is the process to port Carbonite to new platforms with minimal disruption to development work. This is the process being used to port Carbonite to Mac OS. - The initial commit to master is the minimal code to get the new platform to build. Code paths that cannot be shared with another platform will have a crash macro to mark where they are (The Mac OS port has `CARB_MACOS_UNIMPLEMENTED()`) ## CI Builds and Testing - Initial Commit: Code should build and pass all tests on the current platform. - Crash Macros: Each crash macro should have a comment with an associated ticket for fixing it. After this point, CI builds should be enabled. - Code Added After Initial Commit: Code should still build for the new platform, but new code can use the crash macro if needed. - CI Testing: CI testing is enabled on a subset of the tests once the framework is able to run on the new platform. - Full Support: Once there are no remaining crash macros and all tests are enabled on CI, the new platform will be considered fully supported. ## Commenting - Header Files - Avoid Errors: Avoid spelling and grammatical errors. - Consider Audience: Assume customers will read comments. Err on the side of caution. - Cautionary tale: to ‘nuke’ poor implementation code is a fairly idiomatic usage for US coders. It can be highly offensive elsewhere. - License Banner: Each source file should start with a comment banner for license. - This should be strictly the first thing in the file. - Doxygen Format: Header comments use doxygen format. We are not too sticky on doxygen formatting policy. - Document Public Elements: All public functions and variables must be documented. - Detail Level: The level of detail for the comment is based on the complexity for the API. - Clarity: Most important is that comments are simple and have clarity on how to use the API. - @brief and @details: `@brief` can be dropped and automatic assumed on first line of code. `@details` is dropped and automatic assumed proceeding the brief line. - @param and @return: `@param` and `@return` are followed with a space after summary brief or details. ```cpp /** * Tests whether this bounding box intersects the specified bounding box. * * You would add any specific details that may be needed here. This is * only necessary if there is complexity to the user of the function. * * @param box The bounding box to test intersection with. * @return true if the specified bounding box intersects this bounding box; * false otherwise. / bool intersects(const BoundingBox& box) const; ``` - Overridden Functions: Overridden functions can simply refer to the base class comments. ```cpp class Bar : public Foo { protected: /* * @see Foo::render / void render(float elapsedTime) override; }; ``` ## Commenting - Source Files - Clean Code: Clean simple code is the best form of commenting. - Duplicate Comments: Do not add comments above function definitions in .cpp if they are already in header. - Implementation Details: Comment necessary non-obvious implementation details not the API. - Line Comments: Only use // line comments on the line above the code you plan to comment. - Block Comments: Avoid / / block comments inside implementation code (.cpp). This prevents others from easily doing their own block comments when testing, debugging, etc. - Identifier Comments: Avoid explicitly referring to identifiers in comments, since that’s an easy way to make your comment outdated when an identifier is renamed. ## License - License Notice: The following must be included at the start of every header and source file: ```cpp // Copyright (c) 2020 NVIDIA CORPORATION. All rights reserved. // // NVIDIA CORPORATION and its licensors retain all intellectual property // and proprietary rights in and to this software, related documentation // and any modifications thereto. Any use, reproduction, disclosure or // distribution of this software and related documentation without an express // license agreement from NVIDIA CORPORATION is strictly prohibited. // ``` ## Formatting Code - Editor Settings: You should set your Editor/IDE to follow the formatting guidelines. - .editorconfig: This repository uses .editorconfig - take advantage of it. - Line Length: Keep all code less than 120 characters per line. - Code Style: We use a... ```{code-block} .clang-format :linenos: file with clang-format (via `repo_format`) to keep our code auto-formatted. - In some rare cases where code is manually formatted in a pleasing fashion, auto-formatting can be suspended with a comment block: ```cpp // clang-format off ... Manually formatted code // clang-format on ``` - Indentation - Insert 4 spaces* for each tab. We’ve gone back and forth on this but ultimately GitLab ruined our affair with tabs since it relies on default browser behavior for displaying tabs. Most browsers, including Chrome, are set to display each tab as 8 spaces. This made the code out of alignment when viewed in GitLab, where we perform our code reviews. That was the straw that broke the camel’s back. - The repository includes .editorconfig which automatically configures this setting for VisualStudio and many other popular editors. In most cases you won’t have to do a thing to comply with this rule. - Line Spacing - One line of space between function declarations in source and header. - One line after each class scope section in header. - Function call spacing: - No space before bracket. - No space just inside brackets. - One space after each comma separating parameters. ```cpp serializer->writeFloat("range", range, kLightRange); ``` - Conditional statement spacing: - One space after conditional keywords. - No space just inside the brackets. - One space separating commas, colons and condition comparison operators. ```cpp if (enumName.compare("carb::scenerendering::Light::Type") == 0) { switch (static_cast<Light::Type>(value)) { case Light::Type::eDirectional: return "eDirectional"; ... } } ``` - Don’t align blocks of variables or trailing comments to match spacing causing unnecessary code changes when new variables are introduced: ```cpp class Foo { ... private: bool m_very; // Formatting float3 m_annoying; // generates ray m_nooNoo; // spurious uint32_t m_dirtyBits; // diffs. }; ``` - Align indentation space for parameters when wrapping lines to match the initial bracket: ```cpp Matrix::Matrix(float m11, float m12, float m13, float m14, float m21, float m22, float m23, float m24, float m31, float m32, float m33, float m34, float m41, float m42, float m43, float m44) ``` ```cpp return sqrt((point.x - sphere.center.x) * (point.x - sphere.center.x) + (point.y - sphere.center.y) * (point.y - sphere.center.x) + (point.z - sphere.center.z) * (point.z - sphere.center.x)); ``` Use a line of space within .cpp implementation functions to help organize blocks of code. ```cpp // Lookup device surface extensions ... ... // Create the platform surface connection ... ... ... ``` ### Indentation Indent next line after all braces { }. Move code after braces { } to the next line. Always indent the next line of any condition statement line. ```cpp if (box.isEmpty()) { return; } ``` ```cpp for (size_t i = 0; i < count; ++i) { if (distance(sphere, points[i]) > sphere.radius) { return false; } } ``` Never leave conditional code statements on same line as condition test: ```cpp if (box.isEmpty()) return; ``` ### C++14 and Beyond Recommendations Carbonite supports a minimum of C++14, therefore public include files should not use any features in later standards. Carbonite includes some implementations of C++17 and later features that will build on C++14. These are located in directories that name the standard, such as `include/carb/cpp17`. ### Pointers and Smart Pointers Use raw C/C++ pointers in the public interface (Plugin ABI). In other cases prefer to use `std::unique_ptr` or `std::shared_ptr` to signal ownership, rather than using raw pointers. Use `std::shared_ptr` only when sharing is required. Any `delete` or `delete[]` call appearing in the code is a red flag and needs a good reason. ### Casts - Casting between numeric types (integer types, float, etc.) or pointer-to/from-numeric ( `size_t(ptr)` ) may use C-style or functional-style casts (i.e. `ptrdiff_t(val)` ) for brevity. One may still use `static_cast` if desired. - Except as mentioned above, avoid using C-style casts wherever possible. Note that `const_cast` can also be used to add/remove the `volatile` qualifier. - For non-numeric types, prefer explicit C++ named casts ( `static_cast` , `const_cast` , `reinterpret_cast` ) over C-style cast or functional cast. That will allow compiler to catch some errors. - Using `dynamic_cast` requires RTTI (Run-Time Type Information), is slow, and happens at runtime. Avoid using `dynamic_cast` unless necessary. - Use the narrowest cast possible. Only use `reinterpret_cast` if it is unavoidable. Note that `static_cast` can be used for `void`: ```cpp void userData = ...; MyClass* c = static_cast<MyClass>(userData); ``` - Containers - You are free to use the STL containers but you can never allow them to cross the ABI boundary. That is, you cannot create them inside one plugin and have another plugin take over the object and be responsible for freeing it via the default C++ means. Instead you must hide the STL object within an opaque data structure and expose create/destroy functions. If you violate this rule you are forced to link the C++ runtime dynamically and the ABI breaks down. See Architecture documentation and ABI Compatibility for more details. - Characters and Strings - All strings internally and in interfaces are of the same type: 8-bit char. This type should always be expected to hold a UTF-8 encoded string. This means that the first 7-bits map directly to ASCII and above that we have escaped multi-byte sequences. Please read Unicode to learn how to interact with OS and third-part APIs that cannot consume UTF8 directly. If you need to enter a text string in code that contains characters outside 7-bit ASCII then you must also read Unicode. - For ABI-safe strings, you can use `omni::string`; a string class similar to `std::string`. - You are free to use `std::string` inside modules but we cannot expose STL string types in public interfaces (violation of Plugin ABI). Instead use (const) char pointers. This does require some thought on lifetime management. Usually the character array can be associated with an object and the lifetime is directly tied to that object. - Even though you can use STL strings and functionality inside your implementation please consider first if what you want to do is easily achievable with the C runtime character functions. These are considerably faster and often lead to fewer lines of code. Additionally the STL string functions can raise exceptions on non-terminal errors and Carbonite plugins are built without exception support so it will most likely just crash. - Auto - Avoid the use of `auto` where it will make code more difficult to read for developers who do not have an in-depth knowledge of the codebase. Reading someone else’s code is harder than writing your own code, so code should be optimized for readability. - `auto` should be used for generic code, such as templates and macros, where the type will differ based on invocation. - `auto` may optionally be used for overly verbose types that have a standard usage, such as iterators. - `auto` may be optionally used for types where the definition makes the type obvious, such as `auto a = std::unique_ptr(new (std::nothrow) Q)` or `auto&& lambda = [](Spline s) -> Spline* { return s->reticulate(); }` - `auto` may optionally be used for trailing return types, such as `auto MyClass::MyFunction() -> decltype(myPrivateFunction()) { return myPrivateFunction(); }` ### Auto - Use `auto` for type deduction to reduce verbosity and improve maintainability. - Example: `MyEnum` - To avoid typing out types with overly verbose template arguments, it is preferable to define a new type with the `using` keyword rather than using `auto`. For types with a very broad scope, it is generally beneficial for readability to give a type a name that reflects its usage. - Avoid having `auto` variables initialized from methods of other `auto` variables, since this makes the code much harder to follow. - If you find yourself using tools to resolve the type of an `auto` variable, that variable should not be declared as `auto`. - Be careful about accidental copy-by-value when you meant copy-by-reference. - Understand the difference between `auto` and `auto&`. ### Lambdas - Lambdas are acceptable where they make sense. - Focus use around anonymity. - Avoid over use, but especially for std algorithms (Ex. `std::sort`, etc.) they are fine. - For large lambdas, avoid using capture-all `[=]` and `[&]`, and prefer explicit capture (by reference or by value, as needed) - For asynchronous lambdas, such as passed to `ITasking` functions, or `std::thread` or `std::async` make sure to capture local variables by value instead of by reference or pointer as they will have gone out of scope. ### Range-based loops - They’re great, use them. - They don’t necessarily have to be combined with `auto`. - They are often more readable. - For complex objects, make sure to use a reference (`&`) or forwarding reference (`&&`) if possible to avoid copying (especially when combined with `auto`). - Use accurate variable naming, as this is more important than choosing between using `auto` or the type name: ```cpp // BAD: Suggests `dev` might be of type Device even though it's a device ID. `auto` without reference means that a large object could be copied. for (auto dev : devices) // GOOD: More obvious that the iterator is a device index. for (int dev : devices) // BETTER: Even more obvious that the iterator is a device index. for (int devId : devices) // BEST: Blatantly obvious that the iterator and container are device indexes. for (int devId : deviceIndexes) // or for (auto&& devId : deviceIndexes) ``` ### Integer types - We prefer to use the standard integer types as defined in the C++ standard. </p> ``` ```markdown <div class="highlight-cpp notranslate"> <div class="highlight"> <pre><span></span><span class="cp">#include</span><span class="w"> </span><span class="cpf"><cstdint></span><span class="cp"></span> </pre> </div> </div> ``` ```markdown </li> </ul> </section> ``` ```markdown <section id="nullptr"> <h4> nullptr </h4> <ul class="simple"> <li> <p> Use <code> nullptr </code> for any pointer types instead of <code> 0 </code> or <code> NULL </code> . </p> </li> </ul> </section> ``` ```markdown <section id="friend"> <h4> friend </h4> <ul class="simple"> <li> <p> Avoid using friend unless absolutely needed to restrict access to inter-class interop only. </p> </li> <li> <p> It easily leads to <em> difficult-to-untangle </em> inter-dependencies that are hard to maintain. </p> </li> </ul> </section> ``` ```markdown <section id="use-of-anonymous-namespaces"> <h4> use of anonymous namespaces </h4> <ul class="simple"> <li> <p> Prefer anonymous namespaces to <code> static </code> free functions in <code> .cpp </code> files ( <code> static </code> should be omitted). </p> </li> </ul> </section> ``` ```markdown <section id="templated-functions"> <h4> templated functions </h4> <ul class="simple"> <li> <p> internal-linkage is implied for non-specialized <code> template </code> d functions functions, and for member functions defined inside a class declaration. You can additionally declare them <code> inline </code> to give the compiler a hint for inlining. </p> </li> <li> <p> neither internal-linkage nor <code> inline </code> is implied for fully specialized <code> template </code> d functions, and thus those follow the rules of non- <code> template </code> d functions (see below) </p> </li> </ul> </section> ``` ```markdown <section id="static"> <h4> static </h4> <ul class="simple"> <li> <p> Declare non-interface non-member functions as <code> static </code> in <code> .cpp </code> files (or even better, include them in anonymous namespaces). <code> template </code> d free functions (specialized or not) in <code> .cpp </code> files also follow this rule. </p> </li> <li> <p> Declare non-interface non-member functions as <code> static </code> <code> inline </code> in <code> .cpp </code> files (or <code> inline </code> in anonymous namespaces) if you want to give the compiler a hint for inlining. </p> </li> <li> <p> Avoid <code> static </code> non-member functions in includes, as they will cause code to appear multiple times in different translation units. </p> </li> </ul> </section> ``` ```markdown <section id="inline"> <h4> inline </h4> <ul class="simple"> <li> <p> Declare non-interface non-member functions as <code> inline </code> in include files. Fully-specialized <code> templete </code> d free functions also need to be specified <code> inline </code> (as neither <code> inline </code> nor internal-linkage is implied). </p> </li> <li> <p> Avoid non- <code> static </code> <code> inline </code> non-member functions in <code> .cpp </code> files, as they can hide potential bugs (different function with same signature might get silently merged at link time). </p> </li> </ul> </section> ``` ```markdown <section id="static-assert"> <h4> static_assert </h4> <ul class="simple"> <li> <p> Use <code> static_assert </code> liberally as it is a compile-time check and can be used to check assumptions at compile time. Failing the check will cause a compile error. Providing an expression that cannot be evaluated at compile time will also produce a compile error. It can be used within global, namespace and block scopes. It can be used within class declarations and function bodies. - `static_assert` should be used to future-proof code. - `static_assert` can be used to purposefully break code that must be maintained when assumptions change (an example of this would be to break code dependent on `enum` values when that `enum` changes). - `static_assert` can also be used to verify that alignment and `sizeof(type)` matches assumptions. - `static_assert` can be used with C++ traits (i.e. `std::is_standard_layout`, etc.) to notify future engineers of broken assumptions. ### Constant Strings Suggested way of declaring string constants: ```cpp // in a .h file constexpr char mystring[] = "constant string"; // in a .cpp file static constexpr char mystring[] = "constant string"; class A { // inside a class: static const char* const mystring = "constant string"; // ^^^ do not use static constexpr members of which an address is required within a class before C++17, otherwise // link errors will occur. } ``` > NOTE > Prior to C++17, the use of `static constexpr` as a member within a `struct`/`class` may cause link problems if the > address is taken of the member, unless the definition of the member is contained within a translation unit. This is > not possible for header-only classes. Therefore, avoid using `static constexpr` members when the address is required > of the member (i.e. passed via pointer or reference). Avoid using `static constexpr` string or character array members. > With C++17, it is possible to declare static members as `inline`, and `inline` is implied for `static constexpr` members. > However, Carbonite supports a minimum of C++14. ### Higher-level Concepts #### Internal and Experimental Code Functions, types, etc. that are inside of a `detail`/`details` namespace, or contain `detail[s]` or `internal` (in any capitalization) as part of their name should not be called by code that is not packaged with and built at the same time. These functions, types, etc. should be considered private and may change at any time, therefore their existence should not be relied upon. Similarly, any functions, types, etc. marked as experimental should be considered as such: the ABI may not be entirely stable and subject to change in the future. Carbonite uses `detail` namespace (not `details`) to contain private/internal code. The `internal` name may also be used for function and type names. Writing thread-safe code is very difficult. Introducing asynchronicity and threads means that code will execute non-deterministically and have potentially exponential variations. - Use `std::atomic` types sparingly and with caution! These atomic types can ensure low-level synchronization, but also lead to a false sense of thread safety. Race conditions are still quite possible with `std::atomic`. Consider higher-level synchronization primitives instead. - Avoid explicitly specifying `std::memory_order` on uses of `std::atomic` functions except as described below. The default memory order is also the safest: `std::memory_order_seq_cst` (sequentially consistent). Specifying an incorrect memory order especially on weakly-ordered machines such as ARM can lead to unexpected and extremely-difficult-to-track-down errors. - The `std::memory_order_seq_cst` memory order always can be specified explicitly to indicate where sequential consistency is required. - For performance intensive code, at least one but ideally two Senior or Principal engineers may sign off on more weakly-ordered uses of specified memory orders. - All explicit uses of memory order should be commented. - `volatile` is not a synchronization primitive! It makes no guarantees about atomicity, visibility or ordering. Do not use volatile as a synchronization primitive! Much more control and all of the necessary guarantees are given by `std::atomic`. - Avoid global and function-local `static` variables which may be modified by several threads. - Avoid busy-waiting–spinning while waiting for a condition. This includes loops that call `std::this_thread::yield()` or sleeping for a brief period of time. Properly architected synchronization code will block in the operating system while waiting for a condition to be met. - Many containers and library functions are not thread-safe. Be sure to check the documentation and assume that everything is not thread-safe unless explicitly stated. - Carbonite includes two containers that are not only thread-safe but are generally high performance and wait-free: `carb::container::LocklessQueue` and `carb::container::LocklessStack`. - Use the right synchronization primitive for the job: - `std::call_once` executes a callable exactly once, even if called concurrently from several threads. All threads wait until the callable completes execution. - So-called “magic” `static` variables (function-local static initialization) is guaranteed to be thread-safe with C++11. That is, they execute in the same manner as `std::call_once` ensuring that construction happens exactly once and all threads wait until the construction is finished. - However, keep in mind that only the static initialization is guaranteed to be thread-safe, but remember that initialization can be by a function return value, in which case the function is called in a thread-safe manner. - A Mutex is one of the most common synchronization primitives for mutual-exclusion and can be used to protect memory reads and writes in critical sections of code. See `carb::thread::mutex` and `carb::thread::recursive_mutex`. Since only one thread may have a mutex locked, all other threads must stop and wait in order to gain exclusive access. - A Shared Mutex (sometimes called a read/write mutex) is similar to a Mutex but can be accessed in either of two modes: shared (read) mode, or exclusive (write) mode. A thread which has exclusive access causes all other threads to wait. A thread which has shared access allows other threads to also obtain shared access but causes any threads seeking exclusive access to wait. See `carb::thread::shared_mutex`. - Mutexes are used to protect shared resources from simultaneous access by multiple threads. There are several types of mutexes: - A Shared Mutex allows multiple threads to read a shared resource concurrently, but only one thread to write to it. See `carb::thread::shared_mutex` and `carb::thread::recursive_shared_mutex`. - A Condition Variable can be used to signal threads: threads wait until a condition is true, at which point they are signaled. Condition Variables work in concert with a Mutex. See `std::condition_variable` or `std::condition_variable_any`. - A Semaphore is a thread-safe counter that controls access to limited resources. See `carb::cpp::binary_semaphore` and `carb::cpp::counting_semaphore`. - A Latch is a one-shot gate that opens once a certain number of threads wait at the gate. See `carb::cpp::latch`. - A Barrier is similar to a Latch, but operates in phases as opposed to being one-shot. See `carb::cpp::barrier`. - A Future and a Promise create a thread-safe one-way synchronization channel for passing results of asynchronous operations. See `std::future` and `std::promise`. Note that `carb.tasking` has its own versions that are fiber-aware: `carb::tasking::Promise` and `carb::tasking::Future`. - A Spin Lock is a primitive similar to a Mutex that waits by busy-waiting, refusing to give up the thread’s assigned CPU under the guise of resuming as quickly as possible. Spin Locks are not recommended for use in user-level code (kernel or driver code only) and are generally less performant than Mutex due to increased contention. - When using `carb.tasking`’s `carb::tasking::ITasking` interface to launch tasks, the tasks should use synchronization primitives provided by the `ITasking` interface (i.e. `carb::tasking::Mutex`, `carb::tasking::Semaphore`, etc.). - Avoid conditions that may cause a deadlock. A deadlock occurs when one thread has locked Mutex A followed by Mutex B, while another thread has locked Mutex B and wants to lock Mutex A. Each thread owns a resource desired by the other thread and neither will give it up. Therefore, both threads are stuck. A simple way to solve this problem is to always lock Mutexes in the same order (always A followed by B), but this problem can be much more complicated. `std::lock (C++11)` and `std::scoped_lock (C++17)` provide the ability to lock multiple locks with deadlock avoidance heuristics. - Make use of tools that can help visualize and diagnose threading issues: - Visual Studio has several tools, such as Parallel Stacks and Parallel Watch Window. # Parallel Watch On Linux, Valgrind and Thread Sanitizer may be of use. The `carb.tasking.plugin` has a robust debug visualizer for Visual Studio. When writing C++ functions called from Python, release the Global Interpreter Lock (GIL) as soon as possible. - When using Pybind, this can be accomplished through the `py::gil_scoped_release` RAII class. Consider using `carb.tasking` and thinking in terms of tasks or co-routines. See the main article here. # Testing Main article: Testing # Assertions Compile-time assertions (using `static_assert`) should be preferred. Carbonite offers three kinds of runtime assertions: - `CARB_ASSERT` should be used for non-performance-intensive code and code that is commonly run in debug. It compiles to a no-op in optimized builds. - `CARB_CHECK` is similar to `CARB_ASSERT` but also occurs in optimized builds. - `CARB_FATAL_UNLESS` performs a similar check to `CARB_CHECK` and `CARB_ASSERT`, but calls `std::terminate()` after notifying the assertion handler. # Callbacks Carbonite often runs in a multi-threaded environment, so clear documentation and conformance of how callbacks operate is required. - Basic Callback Hygiene in Carbonite is as follows: - Callback un-registration may occur from within the callback. - Un-registration of a callback must ensure that the callback will never be called again, and any calls to the callback in other threads must be complete. - Holding locks while calling a callback is strongly discouraged, and generally will require that they be recursive locks as a callback function may re-enter the system. ### Exceptions Exceptions may not cross the ABI boundary of a Carbonite plugin because that would require all users to dynamically link to the same C++ runtime as your plugin to operate safely. Functions in a Carbonite interface should be marked `noexcept` as they are not allowed to throw exceptions. If an exception is not handled in a function marked `noexcept`, `std::terminate` will be called, which will prevent the exception from escaping the ABI boundary. It is also helpful to mark internal functions as `noexcept` when they’re known not to throw exceptions (especially if you are building with exceptions enabled). Callback functions passed into Carbonite interfaces should be marked as `noexcept`. Callback types cannot be marked as `noexcept` until C++17, so this cannot be enforced by the compiler. Other entry points into a carbonite plugin, such as `carbOnPluginStartup()` must be marked as `noexcept` as well. The behavior of `noexcept` described above will only occur in code built with exceptions enabled. Code must be built with exceptions unless exceptions will not occur under any circumstances. When using libraries that can throw exceptions (for example, the STL throws exceptions on GCC even when building with `-fno-exceptions`), ensure that your exceptions either are handled gracefully or cause the process to exit before the exception can cross the ABI boundary. See the section on error handling for guidelines on how to choose between these two options. Python bindings all need to be built against the same shared C++ runtime because pybind11 C++ objects in a manner that is not ABI safe (this is why they are distributed as headers). Python will also catch exceptions, so exceptions aren’t fatal when they’re thrown in a python binding. Because of this, exceptions are acceptable to use in python bindings as a method of error handling. Because pybind11 can throw exceptions, callbacks into python must call through `callPythonCodeSafe()` or wrap the callback with `wrapPythonCallback()` (this also ensures the python GIL is locked). ### Error handling Errors that can realistically happen under normal circumstances should always be handled. For example, in almost all cases, you should check whether a file opened successfully before trying to read from the file. Errors that won’t realistically happen or are difficult to recover from, like failed allocation of a 64 byte struct, don’t need to be handled. You must ensure that the application will terminate in a predictable manner if this occurs, however. A failed `CARB_FATAL_UNLESS` statement is a good way to terminate the application in a reliable way. Allowing an exception to reach the end of a `noexcept` function is another way to terminate the application in predictable manner. Performing large allocations or allocations where the size is potentially unbounded (e.g. if the size has been specified by code calling into your plugin), should be considered as cases where a memory allocation failure could potentially occur. This should be handled if it is possible; for example, decoding audio or a texture can easily fail for many reasons, so an allocation failure can be reasonably handled. A more complex case, like allocating a stack for a fiber, may be unrealistic to handle, so crashing is acceptable. ### Logging Log messages should be descriptive enough that the reader would not need to be looking at the code that printed them to understand them. For example, a log message that prints “7” instead of “calculated volume 7” is not acceptable. Strings that are printed in log messages should be wrapped in some form of delimiter, such as `'%s'`, so that it is obvious in log messages if the string was empty. Delimiters may be omitted if the printed string is a compile time constant string or the printed string is already guaranteed to have its own delimiters. ```cpp CARB_LOG_WARN("failed to make '%s' relative to '%s'", baseName, path); ``` Unexpected errors from system library functions should always be logged, preferably as an error. Some examples of unexpected errors would be: memory allocation failure, failing to read from a file for a reason other than reaching the end of the file or GetModuleHandle(nullptr) failing. It is important to log these because this type of thing failing silently can lead to bugs that are very difficult to track down. If a crash handler is bound, immediately crashing after the failure is an acceptable way to log the crash. `CARB_FATAL_UNLESS` is also a good way to terminate an application while logging what the error condition was. Please use portable formatting strings when you print the values of expressions or variables. The format string is composed of zero or more directives: ordinary characters (not `%`), which are copied unchanged to the output stream; and conversion specifications, each of which results in fetching zero or more subsequent arguments. Each conversion specification is introduced by the character `%`, and ends with a conversion specifier. In between there may be zero or more flag characters, an optional minimum field width, an optional precision, and an optional size modifier. \| flag characters \| description \| \|-----------------\|-------------\| \| `#` \| The value should be converted in “alternative form”. For `o` conversions, the first character of the output string is made zero (by prefixing a `0` if it was not zero already). For `x` and `X` conversions, a nonzero result prefixed by the string `0x` (or `0X`). For `f`, `e` conversions, the result will always contain a decimal point, even if no digits follow it. For `g` conversion, trailing zeros are not removed from the result. \| \| `0` \| The value should be zero padded. If the `0` and `-` flags both appear, the `0` flag is ignored. If a precision is given with a numeric conversion `d`, `u`, `o`, `x`, `X`, the `0` flag is ignored. \| \| `-` \| The converted value is to be left adjusted on the field boundary. The converted value is padded on the right with blanks, rather than on the left with blanks or zeros. \| \| (space) \| A blank should be left before positive number (or empty string) produced by a signed conversion. \| \| `+` \| A sign (`+` or `-`) should be placed before a number produced by a signed conversion. \| <p> A following integer conversion corresponds to <code> signed char </code> or <code> unsigned char </code> argument. </p> <p> A following integer conversion corresponds to <code> short int </code> or <code> unsigned short int </code> argument. </p> <p> A following integer conversion corresponds to <code> long int </code> or <code> unsigned long int </code> argument. </p> <p> A following integer conversion corresponds to <code> long long int </code> or <code> unsigned long long int </code> argument. </p> <p> A following integer conversion corresponds to <code> intmax_t </code> or <code> uintmax_t </code> argument. </p> <p> A following integer conversion corresponds to <code> size_t </code> or <code> ssize_t </code> argument. </p> <p> A following integer conversion corresponds to a <code> ptrdiff_t </code> argument. </p> <p> The integer argument is converted to signed decimal notation. </p> <p> The integer argument is converted to unsigned decimal notation. </p> <p> The integer argument is converted to unsigned octal notation. \| Macro \| Description \| \|-------\|-------------\| \| `PRIx16`, `PRIX16` \| The integer argument is converted in `d`, `u`, `o`, `x`, `X` notation correspondingly and has `int16_t` or `uint16_t` type. \| \| `PRId32`, `PRIu32`, `PRIo32`, `PRIx32`, `PRIX32` \| The integer argument is converted in `d`, `u`, `o`, `x`, `X` notation correspondingly and has `int32_t` or `uint32_t` type. \| \| `PRId64`, `PRIu64`, `PRIo64`, `PRIx64`, `PRIX64` \| The integer argument is converted in `d`, `u`, `o`, `x`, `X` notation correspondingly and has `int64_t` or `uint64_t` type. \| Example: ```cpp int x = 2, y = 3; unsigned long long z = 25ULL; size_t s = sizeof(z); ptrdiff_t d = &y - &x; uint32_t r = 32; CARB_LOG_WARN("x = %d, y = %u, z = %llu", x, y, z); CARB_LOG_INFO("sizeof(z) = %zu", s); ``` ```cpp CARB_LOG_DEBUG("&y - &x = %td", d); CARB_LOG_INFO("r = %"PRIu32"", r); ``` Please note, that Windows-family OSes, contrary to Unix family, uses fixed-size types in their API to provide binary compatibility without providing any OS sources. Please use portable macros to make your code portable across different hardware platforms and compilers. \| Windows type \| compatible fixed-size type \| portable format string \| \|--------------\|---------------------------\|------------------------\| \| `BYTE` \| `uint8_t` \| `"%PRId8"`, `"%PRIu8"`, `"%PRIo8"`, `"%PRIx8"`, `"%PRIX8"` \| \| `WORD` \| `uint16_t` \| `"%PRId16"`, `"%PRIu16"`, `"%PRIo16"`, `"%PRIx16"`, `"%PRIX16"` \| \| `DWORD` \| `uint32_t` \| `"%PRId32"`, `"%PRIu32"`, `"%PRIo32"`, `"%PRIx32"`, `"%PRIX32"` \| \| `QWORD` \| `uint64_t` \| `"%PRId64"`, `"%PRIu64"`, `"%PRIo64"`, `"%PRIx64"`, `"%PRIX64"` \| Example: ```cpp DWORD rc = GetLastError(); if (rc != ERROR_SUCCESS) { CARB_LOG_ERROR("Operation failed with error code %#PRIx32", rc); return rc; } ``` ``` ## Debugging Functionality When adding code that is to only run or exist in debug builds, it should be wrapped in an ```c #if CARB_DEBUG ``` block. This symbol is defined for all C++ translation units on all platforms and is set to 1 and 0 for the debug and release configurations correspondingly in the carb/Defines.h file. Thus this header file must be included before checking the value of the `CARB_DEBUG`. The `CARB_DEBUG` macro should be preferred over other macros such as ```c NDEBUG _DEBUG ``` etc. The preferred method of enabling or disabling debug code that is purely internal to Carbonite would be to check `CARB_DEBUG`. Do not check the `CARB_DEBUG` with ```c #ifdef #if defined() ``` as it will be defined in both release and debug builds. ## Batch Coding Conventions Please consult David Sullins’s guide when writing Windows batch files. ## Bash Coding Conventions - Bash scripts should be run through shellcheck and pass with 0 warnings (excluding spurious warnings that occur due to edge cases). shellcheck can save you from a wide variety of common bash bugs and typos. For example: ```bash In scratch/bad.sh line 2: rm -rf /usr /share/directory/to/delete ^-- SC2114: Warning: deletes a system directory. Use 'rm --' to disable this message. ``` - Bash scripts should run with ```bash set -e set -o pipefail ``` to immediately exit when an unhandled command error occurs. You can explicitly ignore a command failure by appending ```bash \|\| true ``` . - Bash scripts should be run with ```bash set -u ``` to avoid unexpected issues when variables are unexpectedly unset. A classic example where this is useful is a command such as ```bash rm -rf "$DIRECTORY"/* ``` ; if `DIRECTORY` were unexpectedly undefined, `set -u` would terminate the script instead of destroying your system. If you still want to expand a potentially undefined variable, you can use a default substitution value ```bash ${POSSIBLY_DEFINED-$DEFAULT_VALUE} ``` . If `$POSSIBLY_DEFINED` is defined, it will expand to that value. If `$POSSIBLY_DEFINED` is not defined, it will expand to `$DEFAULT_VALUE`. The default value can be empty ( ```bash ${POSSIBLY_DEFINED-} ``` ), which will give you behavior identical to the default variable expansion in bash without `set -u`. You can also use `:-` instead of `-` (e.g. ```bash ${POSSIBLY_DEFINED:-} ``` ) and empty variables will be treated the same as undefined variables. - For a stronger guarantee that a command such as ```bash rm -rf "$DIRECTORY"/* ``` will not be dangerous, you can expand the variable like this ```bash rm ``` - Ensure that variables are not empty before using them. For example, use a command like: ```bash rm -rf "${DIRECTORY:?}"/* ``` , which will terminate the script if it evaluates to an empty string. - Use arrays to avoid word splitting. A classic example is something like: ```bash rm $BUILDDIR/.o ``` This will not work on paths with spaces and shellcheck will warn about this. You can instead use an array so that each file will be passed as a separate argument. ```bash FILES=($BUILDDIR/.o) rm "${FILES[@]}" ``` - Set nullglob mode when using wildcards: ```bash FILES=(.c) # if there are no .c files, ".c" will be in the array shopt -s nullglob # set nullglob mode FILES=(.c) # if there are no .c files, the array will be empty shopt -u nullglob # unset nullglob mode - things will break if you forget this ``` - Alternatively, use `failglob` to have the command fail out if the glob doesn’t match anything.* - Bash scripts should use the following shebang: ```bash #!/usr/bin/env bash ``` This is somewhat more portable than: ```bash #!/bin/bash ```
commands.md	# Commands Like other extensions, the OmniGraph extensions expose undoable functionality through some basic commands. A lot of the functionality of the commands can be accessed from the `og.Controller` object, described above. OmniGraph has created a shortcut to allow more natural expression of command execution. The raw method of executing a command is something like this: ```python import omni.graph.core as og graph = og.get_graph_by_path("/World/PushGraph") omni.kit.commands.execute("CreateNode", graph=graph, node_path="/World/PushGraph/TestSingleton", node_type="omni.graph.examples.python.TestSingleton", create_usd=True) ``` The abbreviated method, using the constructed `cmds` object looks like this: ```python import omni.graph.core as og graph = og.get_graph_by_path("/World/PushGraph") og.cmds.CreateNode(graph=graph, node_path="/World/PushGraph/TestSingleton", node_type="omni.graph.examples.python.TestSingleton", create_usd=True) ``` However for most operations you would use the controller class, which is a single line: ```python import omni.graph.core as og og.Controller.edit("/World/PushGraph", { og.Controller.Keys.CREATE_NODES: ("TestSingleton", "omni.graph.examples.python.TestSingleton") }) ``` ### Tip Running the Python command `help(omni.graph.core.cmds)` in the script editor will give you a description of all available commands.
compatibility_index.md	# NVIDIA RTX Remix ## Introduction RTX Remix is a modding platform for remastering a catalog of fixed-function DirectX 8 and 9 games with cutting edge graphics. With NVIDIA RTX Remix, experienced modders can upgrade textures with AI, easily replace game assets with high fidelity assets built with physically accurate (PBR) materials, and inject RTX ray tracing, DLSS and Reflex technologies into the game. It’s like giving your old games a makeover with gorgeous modern-looking graphical mods. Remix consists of two components; there’s the RTX Remix Application (also known as the Toolkit), which is used for creating lights, revamping textures with AI, and adding remastered assets into a game scene that you’ve made with your favorite DCC tool. The second component is the RTX Remix Runtime, which helps you capture classic game scenes to bring into the RTX Remix application to begin your mod. The runtime also is responsible for making your mod “work” when a gamer is playing your mod–in real time, it replaces any old asset with the remastered assets you’ve added to the game scene, and relights the game with path tracing at playback. With the release of the RTX Remix application in Open Beta, the full power of RTX Remix is now in the hands of modders to make next level RTX mods. ## How Does It Work You don’t need to be a computer expert to use RTX Remix. It does most of the hard work for you. But it helps to know a bit about how it works. RTX Remix has two main parts, the runtime which attaches to the game while being played, and the toolkit which is used to edit assets for the game offline (without needing to have the game running). The runtime has two components, the Remix Bridge and Renderer. The Bridge is like a middleman. It sits next to the game and listens to what the game wants to do. It then sends this information to another program called NvRemixBridge.exe, which is a special program that allows the original games renderer to operate in 64-bit, allowing the game to use more of the systems memory than is available in 32-bit (which most classic games are) and because of this, we can use raytracing to render high resolution textures and meshes. The Bridge acts as the messenger - it sends all the game instructions to another part called the RTX Remix Renderer. This Renderer Is a super powerful graphics engine. It takes all the things the game wants to draw, like characters and objects, but does so using a powerful real-time path-tracing engine. The renderer also knows how to swap out the old game stuff with new and improved things from an RTX Remix Mod that you put in a special folder. It keeps track of what’s what using special codes (hash IDs) so it knows what to change in the game as you play. Finally, using the RTX Remix Toolkit, you are able to easily make and add new game objects, materials, and lights. And since it’s built on the NVIDIA Omniverse ecosystem, you’ll have lots of cool tools to make your game look even better. ## Requirements ### Technical Requirements RTX Remix and its mods are built to run on RTX-powered machines. For ideal performance, we recommend using GeForce RTX™ 4070 or higher. For latest drivers, visit NVIDIA Driver Downloads. For Quadro, select ‘Quadro New Feature Driver (QNF). \| Level \| Operating System \| CPU \| CPU Cores \| RAM \| GPU \| VRAM \| Disk \| \|-------\|------------------\|-----\|-----------\|-----\|-----\|------\|------\| ## System Requirements \| Min \| Windows 10/11 \| Intel I7 or AMD Ryzen 7 \| 4 \| 16 GB \| GeForce RTX 3060Ti \| 8 GB \| 512 GB SSD \| \| --- \| --- \| --- \| --- \| --- \| --- \| --- \| --- \| \| Rec \| Windows 10/11 \| Intel I7 or AMD Ryzen 7 \| 8 \| 32 GB \| GeForce RTX 4070 \| 12 GB \| 512 GB M.2 SSD \| ## Recommendations We recommend that you review the Omniverse Technical Requirement Documentation for further details on what is required to use Applications within the Omniverse Platform. ## Requirements For Modders - Windows 10 or 11 - NVIDIA Omniverse ## RTX Remix Runtime Requirements for Developers - Windows 10 or 11 - Visual Studio (VS 2019 or newer) - Windows SDK and emulator (10.0.19041.0 or newer) - Meson (V0.61.4 or newer) - Please Note that v1.2.0 does not work (missing library) - Follow these instructions on how to install and reboot the PC before - Vulkan SDK (1.3.211.0 or newer) - Please Note that you may need to uninstall previous SDK if you have an old version - Python (version 3.9 or newer) ## Compatibility The RTX Remix Runtime is primarily targeting DirectX 8 and 9 games with a fixed function pipeline for compatibility. Injecting the Remix runtime into other content is unlikely to work. It is important to state that even amongst DX8/9 games with fixed function pipelines, there is diversity in how they utilize certain shader techniques or handle rendering. As a result, there are crashes and unexpected rendering scenarios that require improvements to the RTX Remix Runtime for content to work perfectly. It is our goal to work in parallel with the community to identify these errors and improve the runtime to widen compatibility with as many DX8 and 9 fixed function games as possible. As Remix development continues, we will be adding revisions to the RTX Remix Runtime that will expand compatibility for more and more titles. Some of those solutions will be code contributions submitted by our talented developer community, which we will receive on our GitHub as pull requests and integrate into the main RTX Remix Runtime. RTX Remix is a first of its kind modding platform for reimagining a diverse set of classic games with the same workflow, but it’s going to take some investigation and work to achieve that broad compatibility. ### Defining Compatibility Games are ‘compatible’ if the majority of their draw calls can be intercepted by Remix. That doesn’t mean there won’t currently be crashes or other bugs that prevent a specific game from launching. If the game crashes, but the content is compatible, then fixing the crash means the game can be remastered. If the game’s content isn’t compatible, then fixing the crash won’t really achieve anything. This also doesn’t mean that everything in the game will be Remix compatible - often specific effects will either need to be replaced using the existing replacements flow, or will need some kind of custom support added to the runtime. ### Fixed Function Pipelines Remix functions by intercepting the data the game sends to the GPU, recreating the game’s scene based on that data, and then path tracing that recreated scene. With a fixed function graphics pipeline, the game is just sending textures and meshes to the GPU, using standardized data formats. It’s reasonable (though not easy) to recreate a scene from this standardized data. Part of why RTX Remix targets DX8 and 9 titles with fixed function pipelines is because later games utilize shader graphics pipelines, where the game can send the data in any format, and the color of a given surface isn’t determined until it is actually drawn on the screen. This makes it very difficult for RTX Remix to recreate the scene - which, amongst other problems, causes the game to be incompatible. The transition from 100% fixed function to 100% shader was gradual - most early DirectX 9.0 games only used shaders for particularly tricky cases, while later DirectX 9.0 games (like most made with 9.0c) may not use the fixed function pipeline at all. Applying Remix to a game using a mix of techniques will likely result in the fixed function objects showing up, and the shader dependent objects either looking wrong, or not showing up at all. ## Vertex Shader Capture We have some experimental code to handle very simple vertex shaders, which will enable some objects which would otherwise fail. Currently, though, this is very limited. See the ‘Vertex Shader Capture’ option in ‘Game Setup -> Parameters’. ## DirectX Versions Remix functions as a DirectX 9 replacer, and by itself cannot interact with OpenGL or DirectX 7, 8, etc. However, there exists various wrapper libraries which can translate from early OpenGL or DirectX 8 to fixed function DirectX 9. While multiple translation layers introduce even more opportunities for bugs, these have been effectively used to get Remix working with several games that are not DirectX 9. We are not currently aware of any wrapper libraries for DirectX 7 to fixed function DirectX 9, but in theory such a wrapper could be created to extend RTX Remix compatibility further. ## ModDB Compatibility Table ModDB’s community has banded together to make modding with RTX Remix even easier. You can visit the ModDB website and see a community maintained compatibility table, which indicates every game the mod community has found currently works with RTX Remix. It also specifies the last RTX Remix runtime that was tested with any given game, and provides config files (called “rtx.conf” files) that make any compatible game work with RTX Remix out of the box. Take a look, and be sure to contribute and update the table if you make any discoveries of your own. ## Rules of Thumb The following quick checks can help you quickly narrow down on how likely a game is to be compatible, even before you try to run RTX Remix. ### Publish Date The best “at a glance” way to guess if a game is compatible is to look at the publish date. Games released between 2000 and 2005 are most likely to work. Games after 2010 are almost certainly not going to work (unless they are modified to support fixed function pipelines). ### Graphics API version DirectX 8 and DirectX 9.0 will probably be fixed function, and thus feasible. DirectX 9.0c games are usually mostly shader based, so probably won’t work. ### Supported GPU The Nvidia Geforce 2 graphics card was the last card to be fixed function only, so if the game could run on that card, it’s probably fixed function. Note that many games supported fixed functions when they were released, but removed that support in later updates. Testing the content It’s actually possible to tell dxvk to dump out any shaders used by the game by adding these settings to your environment variables: ```bash DXVK_SHADER_DUMP_PATH=/some/path DXVK_LOG_LEVEL=debug ``` If that dumps out a few shaders, then the content may mostly be Remix compatible. If it dumps out a lot of shaders, then the game probably won’t be workable. ### So Is My Game Content Being Processed by Remix? Here is an alternate, more definitive way to check if Remix is processing the some steps to check: 1. Open the developer menu 2. Click Enable Debug View 3. Change the dropdown below it to Geometry Hash If it looks anything like the image below, then the content is probably remixable. If objects have a stable color, those objects are probably replaceable (once the tool comes out). If a mesh’s color changes when you’re in that view, that means the mesh won’t be reliably replaceable using the current settings - though there may be workarounds with different configurations. If nothing changes, the game’s content isn’t going through remix at all. Try lowering the graphics settings as far as they will go, playing with the shader model, or whatever other tricks you can to try to force the game into a fixed function fallback mode. Regarding the geometry hash mode above: Dynamic meshes are expected to change color every frame - things like particle effects and maybe animated meshes. Animated meshes may flicker, depending on how the game does skinning: - Software animation (apply skinning on the CPU) - this will flicker - Hardware animation (apply skinning on the GPU) - this should be stable Some games will support both based on some config value, so you may be able to force it into hardware animation. Remix still can’t actually replace an animated mesh, but that’s relatively straightforward to do if the mesh is GPU skinned- it is on our roadmap to address in the future. We have ideas to also enable CPU skinned meshes… but that’s going to be a big experiment. It is a more speculative feature, and we will be investigating it sometime in the future. ### Why are Shaders Hard to Path Trace? NOTE: This is simplified and meant for someone with no knowledge of computer graphics What is a fixed function pipeline? Imagine you’re making a little shoebox diorama, and you want the background to look like a brick wall. So you print out a picture of a brick wall and glue it on the back of the shoebox. Simple, easy, works great. This is basically what fixed function does - surface + texture, slap it on screen, done. What is a shader? What if you want to make it fancier? What if you wanted more artistic freedom to change the back of your box? Well, you could slap a tablet back there, and just display whatever you want on the screen. You could even write a little program that detects where someone is looking at the box from, and changes what is on the tablet’s screen based on the viewing angle. This is basically what shaders do - they get passed a bunch of arbitrary data from the app, are told the camera position, and are asked what color a tiny piece of an object is supposed to be. Until the pixel shader runs for that tiny piece of that object, for that specific camera position, that object doesn’t actually have a color assigned to it. The shader has to compute what color it should be. It also doesn’t actually output the raw color - it includes lighting and whatever else the game is doing. That just describes pixel shaders though. Vertex shaders let that tablet change shape however it wants… and I think the metaphor starts to fall apart at this point. So why are shaders a problem? First off, shaders don’t require a standardized description of the scene (positions of surfaces, cameras, lights, etc). Remix needs that information to reconstruct the scene for path tracing, and there’s no standard way to extract that information that works across every game. It can be done on a per game basis, but it’s a decent chunk of work for each game. Secondly, we need to know the color (and other material properties) of every surface - without any lighting or shading interfering. With pixel shaders, there’s no straightforward way to get that - even if we could run the shader for every surface, it wouldn’t be outputting the raw color data we need. This may be solvable with automatic shader processing, or letting modders write new ray-hit shaders to replace the functionality of the game’s pixel shaders, but we’ll need to do more experimentation to know what approach will actually work. Thirdly, there are the vertex shaders - but fortunately, we’ve already got an experimental solution that handles most vertex shaders. Once Remix is more stable and fleshed out, it may be possible to remaster shader based games. I’ve seen the modding community succeed at equally complicated projects, so I’m not going to rule that out. But I don’t think it’s worth even starting those projects yet - we should focus on the games that are actually a good fit first, build out and stabilize the tech for those, and get some remasters out the door. Need to leave feedback about the RTX Remix Documentation? Click here
CompoundNodes.md	# Compound Nodes Compound nodes are nodes whose execution is defined by the evaluation of an `OmniGraph`. Compound nodes can be used to encapsulate complex functionality into a single node, or to create a node that can be reused. The existing release of OmniGraph supports Compound Subgraphs, which allow the user to collapse a subnetwork of nodes into a separate `OmniGraph` that is represented by a node in the owning graph. ## USD Representation of Compound Nodes Similar to non-compound nodes, Compound Nodes are represented in USD using a prim with the schema type `OmniGraphSchema.OmniGraphNode`. A Compound Node also contains attributes and a node type. When a Compound Node represents a Compound Subgraph, the node type is fixed to `omni.graph.nodes.CompoundSubgraph`. For the prim to be recognized by OmniGraph as a compound, a USD schemaAPI is applied: `OmniGraphSchema.OmniGraphCompoundNodeAPI`. This allows the compound node to inherit an attribute representing the compound node type (currently only “subgraph” is supported), and a USD relationship attribute (`omni:graph:compoundGraph`) that references the location of the graph Prim on the stage that represents the definition of the Compound Nodes execution. The Prim representing the graph is a standard OmniGraph Prim. The Prim is inserted as a child of the Compound Node. Connections are made between the Compound Node and the nodes in the Compound Graph. The attributes of the Compound Node generally act as a passthrough, moving data between the owning graph and Compound Graph. ```usd def OmniGraphNode "compound" ( prepend apiSchemas = ["OmniGraphCompoundNodeAPI"] ) { custom token inputs:a custom token inputs:b token node:type = "omni.graph.nodes.CompoundSubgraph" int node:typeVersion = 1 rel omni:graph:compoundGraph = </World/PushGraph/compound/Subgraph> token omni:graph:compoundType = "subgraph" custom token outputs:sum prepend token outputs:sum.connect = </World/PushGraph/compound/Subgraph/add.outputs:sum> def OmniGraph "Subgraph" { def OmniGraphNode "add" } } ``` { custom token inputs:a prepend token inputs:a.connect = </World/PushGraph/compound.inputs:a> custom token inputs:b prepend token inputs:b.connect = </World/PushGraph/compound.inputs:b> token node:type = "omni.graph.nodes.Add" int node:typeVersion = 2 custom token outputs:sum } ``` ## Using the og.Controller Class to Create Compound Nodes in Scripts ### Creating Compound Nodes The og.Controller class can be used to create Compound Nodes in scripts. The `og.Controller` class provides a set of methods useful in defining OmniGraphs using python scripting. The most straightforward way to create a compound node using the `og.Controller.edit` function is to define the Compound Subgraph when defining the Compound Node by using a recursive definition, as demonstrated in the following sample: ```python keys = og.Controller.Keys controller = og.Controller() (graph, nodes, _, name_to_object_map) = controller.edit( "/World/MyGraph1", { keys.CREATE_NODES: [ ( "CompoundNode", { # Creates the compound nodes # Defines the subgraph of the compound node keys.CREATE_NODES: [ ("Constant1", "omni.graph.nodes.ConstantDouble"), ("Constant2", "omni.graph.nodes.ConstantDouble"), ("Add", "omni.graph.nodes.Add"), ], keys.CONNECT: [ ("Constant1.inputs:value", "Add.inputs:a"), ("Constant2.inputs:value", "Add.inputs:b"), ], }, ), ], }, ) ``` This will generate a graph that contains a Compound Node containing a Subgraph with two Constant nodes and an Add Node. Note that in the returned values from the `edit` function, the list represented by the `nodes` variable will only contain the Compound Node, and not the nodes defined inside the Compound Subgraph. In other words, the list of returned nodes only contains nodes in the top-level graph. However, the nodes inside the Compound Subgraph can be accessed via the returned `name_to_object_map` dictionary using the defined names of each of the nodes in the Subgraph. For example, to access the `Constant1` node, use `name_to_object_map["Constant1"]`. This does mean that when creating complex graph structures, all node names need to be unique, even if they are defined in different Compound Subgraphs. ### Promoting Compound Node Attributes In the example above, the generated compound node has neither input nor output attributes. In practice, a Compound Node will use data from, and produce data for, adjacent nodes in the graph. This is accomplished using the `og.Controller.keys.PROMOTE_ATTRIBUTES` key. The following example demonstrates how to promote attributes: ```python keys = og.Controller.Keys controller = og.Controller() (graph, nodes, _, name_to_object_map) = controller.edit( "/World/MyGraph2", { keys.CREATE_NODES: [ ( "CompoundNode", { # Creates the compound nodes # Defines the subgraph of the compound node keys.CREATE_NODES: [ ("Constant1", "omni.graph.nodes.ConstantDouble"), ("Constant2", "omni.graph.nodes.ConstantDouble"), ("Add", "omni.graph.nodes.Add"), ], keys.CONNECT: [ ("Constant1.inputs:value", "Add.inputs:a"), ("Constant2.inputs:value", "Add.inputs:b"), ], }, ), ], }, ) ( "CompoundNode", { keys.CREATE_NODES: [ ("Add", "omni.graph.nodes.Add"), ], keys.PROMOTE_ATTRIBUTES: [ ("Add.inputs:a", "inputs:one"), ("Add.inputs:b", "inputs:two"), ("Add.outputs:sum", "outputs:result"), ("Add.outputs:sum", "outputs:alt_result"), ], }, ), ("Constant1", "omni.graph.nodes.ConstantDouble"), ("Constant2", "omni.graph.nodes.ConstantDouble"), ("Consumer", "omni.graph.nodes.Add"), keys.CONNECT: [ # Connect to the promoted attributes ("Constant1.inputs:value", "CompoundNode.inputs:one"), ("Constant2.inputs:value", "CompoundNode.inputs:two"), ("CompoundNode.outputs:result", "Consumer.inputs:a"), ("CompoundNode.outputs:alt_result", "Consumer.inputs:b"), ], While the sample above does not demonstrate a particularly useful Compound Node, it does demonstrates a few important concepts about promotion. When promoting an attribute, the source attribute and the compound attribute name are supplied as a tuple. The source attribute is a path to an attribute in the Compound Subgraph. The second element of the tuple specifies the promoted attribute name in the compound. Note the name does not have to match the source attribute path. The promoted attribute can then be accessed in the owning graph using the name specified in the promotion in the same manner as one would use any other node attributes. If required, an attribute can be promoted multiple times, as demonstrated by the promotion of the Add.outputs:sum. Attribute promotion can also be accomplished using the `og.NodeController.promote_attribute` function. The inputs and outputs prefix is optional in the compound attribute name. This means that the type of promoted attribute is determined solely by the port type of the source attribute, and not the prefix of the compound attribute name. The is demonstrated in the following example: ```python keys = og.Controller.Keys controller = og.Controller() (graph, nodes, _, name_to_object_map) = controller.edit( "/World/MyGraph3", { keys.CREATE_NODES: [ ("CompoundNode", { keys.CREATE_NODES: [ ("Add", "omni.graph.nodes.Add"), ("Constant1", "omni.graph.nodes.ConstantDouble"), ], keys.PROMOTE_ATTRIBUTES: [ ("Add.inputs:a", "one"), # Promoted as inputs:one ("Add.inputs:b", "outputs:two"), # Promoted as inputs:outputs:two ("Add.outputs:sum", "inputs:result"), # Promoted as outputs:inputs:result ("Constant1.inputs:value", "const"), # Promoted as outputs:const ], }), ], }, ) ``` Here, the appropriate prefix is appended to each of the promoted attribute names. In the case of Constants, which used input attributes that are marked as output-only, they become output attributes on the Compound Node.
configuration-options_index.md	# Omniverse MJCF Importer ## Omniverse MJCF Importer The MJCF Importer Extension is used to import MuJoCo representations of scenes. MuJoCo Modeling XML File (MJCF), is an XML format for representing a scene in the MuJoCo simulator. ## Getting Started 1. Clone the GitHub repo to your local machine. 2. Open a command prompt and navigate to the root of your cloned repo. 3. Run `build.bat` to bootstrap your dev environment and build the example extensions. 4. Run `_build\{platform}\release\omni.importer.mjcf.app.bat` to start the Kit application. 5. From the menu, select `Isaac Utils->MJCF Importer` to launch the UI for the MJCF Importer extension. This extension is enabled by default. If it is ever disabled, it can be re-enabled from the Extension Manager by searching for `omni.importer.mjcf`. Note: On Linux, replace `.bat` with `.sh` in the instructions above. ## Conventions Special characters in link or joint names are not supported and will be replaced with an underscore. In the event that the name starts with an underscore due to the replacement, an a is pre-pended. It is recommended to make these name changes in the mjcf directly. See the [Convention References](https://docs.omniverse.nvidia.com/app_isaacsim/app_isaacsim/reference_conventions.html#isaac-sim-conventions) documentation for a complete list of `Isaac Sim` conventions. ## User Interface ## Configuration Options - Fix Base Link: When checked, every world body will have its base fixed where it is placed in world coordinates. - Import Inertia Tensor: Check to load inertia from mjcf directly. If the mjcf does not specify an inertia tensor, identity will be used and scaled by the scaling factor. If unchecked, Physx will compute it automatically. - Stage Units Per Meter: The default length unit is meters. Here you can set the scaling factor to match the unit used in your MJCF. - Link Density: If a link does not have a given mass, it uses this density (in Kg/m^3) to compute mass based on link volume. A value of 0.0 can be used to tell the physics engine to automatically compute density as well. Clean Stage: When checked, cleans the stage before loading the new MJCF, otherwise loads it on current open stage at position `(0,0,0)` Self Collision: Enables self collision between adjacent links. It may cause instability if the collision meshes are intersecting at the joint. Create Physics Scene: Creates a default physics scene on the stage. Because this physics scene is created outside of the scene asset, it will not be loaded into other scenes composed with the robot asset. Note: It is recommended to set Self Collision to false unless you are certain that links on the robot are not self colliding ### Robot Properties There might be many properties you want to tune on your robot. These properties can be spread across many different Schemas and APIs. The general steps of getting and setting a parameter are: 1. Find which API is the parameter under. Most common ones can be found in the Pixar USD API. 2. Get the prim handle that the API is applied to. For example, Articulation and Drive APIs are applied to joints, and MassAPIs are applied to the rigid bodies. 3. Get the handle to the API. From there on, you can Get or Set the attributes associated with that API. For example, if we want to set the wheel’s drive velocity and the actuators’ stiffness, we need to find the DriveAPI: ```python # get handle to the Drive API for both wheels left_wheel_drive = UsdPhysics.DriveAPI.Get(stage.GetPrimAtPath("/carter/chassis_link/left_wheel"), "angular") right_wheel_drive = UsdPhysics.DriveAPI.Get(stage.GetPrimAtPath("/carter/chassis_link/right_wheel"), "angular") # Set the velocity drive target in degrees/second left_wheel_drive.GetTargetVelocityAttr().Set(150) right_wheel_drive.GetTargetVelocityAttr().Set(150) # Set the drive damping, which controls the strength of the velocity drive left_wheel_drive.GetDampingAttr().Set(15000) right_wheel_drive.GetDampingAttr().Set(15000) # Set the drive stiffness, which controls the strength of the position drive # In this case because we want to do velocity control this should be set to zero left_wheel_drive.GetStiffnessAttr().Set(0) right_wheel_drive.GetStiffnessAttr().Set(0) ``` Note: - The drive stiffness parameter should be set when using position control on a joint drive. - The drive damping parameter should be set when using velocity control on a joint drive. - A combination of setting stiffness and damping on a drive will result in both targets being applied, this can be useful in position control to reduce vibrations. ## Extension Documentation - [MJCF Importer Extension [omni.importer.mjcf]] - Usage - High Level Code Overview - Changelog - Contributing to the MJCF Importer Extension
configuration_overview.md	# Scene Optimizer Service The Scene Optimizer Service uses the [Scene Optimizer Extension](https://docs.omniverse.nvidia.com/prod_extensions/prod_extensions/ext_scene-optimizer.html) (omni.kit.services.scene.optimizer) to optimize USD files to improve performance. Example use cases for the service: - Automated UV generation for CAD models - Optimizing scenes for runtime interactivity - Optimizing scenes for memory efficiency - Point Cloud Partitioning The service will take a USD file from a Nucleus location, use a predefined configuration file with desired optimization operations and create a new optimized USD file in the same Nucleus directory. ## Configuration The service is primarily configured via a json file which describes the operation stack which should be executed on the scene. ### Generating Config Files The file can be written by hand, but the easier way is to use the Scene Optimizer Kit extension to generate the file. The optimization steps can be defined in the Scene Optimizer UI, then saved to a JSON file. See details on how to generate the JSON file from the [Scene Optimizer Kit extension](https://docs.omniverse.nvidia.com/prod_extensions/prod_extensions/ext_scene-optimizer/user-manual.html). ### Example JSON Configuration This sample json will run the following operations: - optimize materials - deduplicate - deduplicate geometry - instanceable reference - prune leaf xforms
configuring-assets-and-adding-them-to-a-stage_Overview.md	# SimReady Explorer Developer Guide ## Overview SimReady Assets are the building blocks of industrial virtual worlds. They are built on top of the Universal Scene Description (USD) platform and have accurate physical properties, behaviors, and connected data streams. They are comprised on multiple files such as USD layers, material description files (.mdl), textures, thumbnails, etc. The SimReady Explorer extension allows for working with libraries of SimReady Assets, by enabling users to: - Find assets by words matched against tags and asset names - Configure asset behavior, appearance, etc in the browser, before they are assembled into a scene - Assemble assets into virtual worlds through Omniverse applications such as USD Composer, DriveSim, Isaac Sim, etc. Through the SimReady Explorer API, developers can: - Search for assets by matching search words against tags and asset names - Configure various aspects of assets, as defined by the asset class - Add the configured assets to a stage ## Finding assets SimReady Assets have a name, tags, and labels. The labels are derived from the Wiki Data database, and as such are backed by QCodes. Note that the labels and the QCode of an asset are also part of its list of tags. Both tags and labels can consist of multiple, space separated words. Finding SimReady Assets is like querying a database. A list of search terms is each matched against the asset’s name and tags. Partial matches of the search term in names, tags, and labels are also returned. For example, the search term “wood” would match names such as “recycledwoodpallete” and “crestwood_sofa”. See the find_assets() API for details on how to programmatically search for assets. ## Configuring assets and adding them to a stage The find_assets() API returns a list of SimreadyAsset objects, which can be added to the current stage with the desired behaviors enabled. The behaviors supported currently are the USD variant sets exposed by the asset. When adding assets to a stage, they can be inserted at a given location, can be parented to another prim, or can be added at or even replace a list of prims. See the add_asset_to_stage(), and the add_asset_to_stage_using_prims() APIs for details on how to programmatically add assets to the current stage. # SimReady Explorer API Tutorial The following code illustrates how to find assets, add them to the current scene, and even replace some of them with other assets. The code below can be executed from the Script Editor of any Omniverse application. ```python import asyncio from typing import List, Tuple ``` ```python import omni.kit.app import omni.simready.explorer as sre import omni.usd from pxr import Gf, Sdf, Usd async def main(): # 1. Find all residential wooden chair assets. # We use multiple search terms, some will be matched in the tags, others in the asset names assets = await sre.find_assets(search_words=["residential", "chair", "wood"]) print(f"Found {len(assets)} chairs") # 2. Prepare to configure the assets # All SimReady Assets have a Physics behavior, which is implemented as a # variantset named PhysicsVariant. To enable rigid body physics on an asset, # this variantset needs to be set to "RigidBody". variants = {"PhysicsVariant": "RigidBody"} # 3. Add all assets found in step (1) to the current stage as a payload added_prim_paths: List[Sdf.Path] = [] for i, asset in enumerate(assets): pos = -200 + 200 * i res, prim_path = sre.add_asset_to_stage( asset.main_url, position=Gf.Vec3d(pos, 0, -pos), variants=variants, payload=True ) if res: print(f"Added '{prim_path}' from '{asset.main_url}'") # 4. Find an ottoman assets = await sre.find_assets(search_words=["ottoman"]) print(f"Found {len(assets)} ottomans") # 5. Replace the first chair with an ottoman if assets and added_prim_paths: usd_context: omni.usd.UsdContext = omni.usd.get_context() stage: Usd.Stage = usd_context.get_stage() if usd_context else None await omni.kit.app.get_app().next_update_async() res, prim_path = sre.add_asset_to_stage_using_prims( usd_context, stage, assets[0].main_url, variants=variants, replace_prims=True, prim_paths=[added_prim_paths[0]], ) if res: print(f"Replaced assets '{added_prim_paths[0]}' with '{prim_path}' from '{assets[0].main_url}'") asyncio.ensure_future(main()) ``` ## Future enhancements The SimReady Explorer API will be extended in the near future to allow defining custom asset classes with specific behaviors.
configuring-rules-with-carbonite-settings_index.md	# 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
configuring-the-omni-kit-telemetry-extension_KitTelemetry.md	# Configuring the `omni.kit.telemetry` Extension ## Overview The `omni.kit.telemetry` extension is responsible for a few major tasks. These largely occur in the background and require no direct interaction from the rest of the app. All of this behavior occurs during the startup of the extension automatically. The major tasks that occur during extension startup are: - Launch the telemetry transmitter app. This app is shipped with the extension and is responsible for parsing, validating, and transmitting all structured log messages produced by the app. Only the specific messages that have been approved and validated will be transmitted. More on this below. - Collect system information and emit structured log messages and crash reporter metadata values for it. The collected system information includes CPU, memory, OS, GPU, and display information. Only information about the capabilities of the system is collected, never any user specific information. - Emit various startup events. This includes events that identify the run environment being used (ie: cloud/enterprise/individual, cloud node/cluster name, etc), the name and version of the app, the various session IDs (ie: telemetry, launcher, cloud, etc), and the point at which the app is ready for the user to interact with it. - Provide interfaces that allow some limited access to information about the session. The `omni::telemetry::ITelemetry` and `omni::telemetry::ITelemetry2` interfaces can be used to access this information. These interfaces are read-only for the most part. Once the extension has successfully started up, it is generally not interacted with again for the duration of the app’s session. ## The Telemetry Transmitter The telemetry transmitter is a separate app that is bundled with the `omni.kit.telemetry` extension. It is launched during the extension’s startup. For the most part the configuration of the transmitter is automatic. However, its configuration can be affected by passing specific settings to the Kit based app itself. In general, any settings under the `/telemetry/` settings branch will be passed directly on to the transmitter when it is launched. There are some settings that may be slightly adjusted or added to however depending on the launch mode. The transmitter process will also inherit any settings under the `/log/` (with a few exceptions) and `/structuredLog/extraFields/` settings branches. In almost all cases, the transmitter process will be unique in the system. At any given time, only a single instance of the transmitter process will be running. If another instance of the transmitter is launched while another one is running, the new instance will immediately exit. This single instance of the transmitter will however handle events produced by all Kit based apps, even if multiple apps are running simultaneously. This limitation can be overcome by specifying a new launch guard name with the `/telemetry/launchGuardName` setting, but is not recommended without also including additional configuration changes for the transmitter such as the log folder to be scanned. Having multiple transmitters running simultaneously could result in duplicate messages being sent and more contention on accessing log files. When the transmitter is successfully launched, it will keep track of how many Kit based apps have attempted to launch it. The transmitter will continue to run until all Kit based apps that tried to launch it have exited. This is true regardless of how each Kit based app exits - whether through a normal exit, crashing, or being terminated by the user. The only cases where the transmitter will exit early will be if it detects that another instance is already running, and if it detects that the user has not given any consent to transmit any data. In the latter case, the transmitter exits because it has no job to perform without user consent. When the transmitter is run with authentication enabled (ie: the ``` \``` /telemetry/transmitter/0/authenticate=true \``` or ``` \``` /telemetry/authenticate=true \``` settings), it requires a way to deliver the authentication token to it. This is usually provided by downloading a JSON file from a certain configurable URL. The authentication token may arrive with an expiry time. The transmitter will request a renewed authentication token only once the expiry time has passed. The authentication token is never stored locally in a file by the transmitter. If the transmitter is unable to acquire an authentication token for any reason (ie: URL not available, attempt to download the token failed or was rejected, etc), that endpoint in the transmitter will simply pause its event processing queue until a valid authentication token can be acquired. When the transmitter starts up, it performs the following checks: - Reads the current privacy consent settings for the user. These settings are found in the ``` \``` privacy.toml \``` file that the Kit based app loaded on startup. By default this file is located in ``` \``` ~/.nvidia-omniverse/config/privacy.toml \``` but can be relocated for a session using the ``` \``` /structuredLog/privacySettingsFile \``` setting. - Loads its configuration settings and builds all the requested transmission profiles. The same set of parsed, validated events can be sent to multiple endpoints if the transmitter is configured to do so. - Downloads the appropriate approved schemas package for the current telemetry mode. Each schema in the package is then loaded and validated. Information about each event in each schema is then stored internally. - Parses out the extra fields passed to it. Each of the named extra fields will be added to each validated message before it is transmitted. - In newer versions of the transmitter (v0.5.0 and later), the list of current schema IDs is downloaded and parsed if running in ‘open endpoint’ mode (ie: authentication is off and the ``` \``` schemaid \``` extra field is passed on to it). This is used to set the latest value for the ``` \``` schemaid \``` field. - Outputs its startup settings to its log file. Depending on how the Kit based app is launched, this log file defaults to either ``` \``` ${kit}/logs/ \``` or ``` \``` ~/.nvidia-omniverse/logs/ \``` . The default name for the log file is ``` \``` omni.telemetry.transmitter.log \``` . While the transmitter is running, it repeatedly performs the following operations: - Scans the log directory for new structured log messages. If no new messages are found, the transmitter will sleep for one minute (by default) before trying again. - All new messages that are found are then validated against the set of loaded events. Any message that fails validation (ie: not formatted correctly or its event type isn’t present in the approved events list) will simply be dropped and not transmitted. - Send the set of new approved, validated events to each of the requested endpoints. The transmitter will remove any endpoint that repeatedly fails to be contacted but continue doing its job for all other endpoints. If all endpoints are removed, the transmitter will simply exit. - Update the progress tags for each endpoint in each log file to indicate how far into the log file it has successfully processed and transmitted. If the transmitter exits and the log files persist, the next run will simply pick off where it left off. - Check whether the transmitter should exit. This can occur if all of the launching Kit based apps have exited or if all endpoints have been removed due to them being unreachable. ## Anonymous Data Mode An anonymous data mode is also supported for Omniverse telemetry. This guarantees that all user information is cleared out, if loaded, very early on startup. Enabling this also enables open endpoint usage, and sets the transmitter to ‘production’ mode. All consent levels will also be enabled once a random user ID is chosen for the session. This mode is enabled using the ``` \``` /telemetry/enableAnonymousData \``` setting (boolean). For more information, please see the [Anonymous Data Mode documentation](#). ## Configuration Options Available to the ``` \``` omni.kit.telemetry \``` Extension The ``` \``` omni.kit.telemetry \``` will do its best to automatically detect the mode that it should run in. However, sometimes an app can be run in a setting where the correct mode cannot be accurately detected. In these cases the extension will just fall back to its default mode. The current mode can be explicitly chosen using the ``` \``` /telemetry/mode \``` setting. However, some choices of mode (ie: ‘test’) may not function properly without the correct build of the extension and transmitter. The extension can run in the following modes: - ``` \``` Production \``` : Only transmits events that are approved for public users. Internal-only events will only be emitted to local log files and will not be transmitted anywhere. The default transmission endpoint is Kratos (public). This is the default mode. - ``` \``` Developer \``` : Transmits events that are approved for both public users and internal users. The default ``` transmission endpoints are Kratos (public) and NVDF (internal only). - Send only locally defined test events. This mode is typically only used for early iterative testing purposes during development. This mode in the transmitter allows locally defined schemas to be provided. The default transmission endpoints are Kratos (public) and NVDF (internal only). The extension also detects the ‘run environment’ it is in as best it can. This detection cannot be overridden by a setting. The current run environment can be retrieved with the `omni::telemetry::ITelemetry2::getRunEnvironment()` function (C++) or the `omni.telemetry.ITelemetry2().run_environment` property (python). The following run environments are detected and supported: - Individual: This is the default mode. This launches the transmitter in its default mode as well (ie: `production` unless otherwise specified). If consent is given, all generated and approved telemetry events will be sent to both Kratos (public) and NVDF (internal only). This mode requires that the user be logged into the Omniverse Launcher app since it provides the authentication information that the public data endpoint requires. If the Omniverse Launcher is not running, data transmission will just be paused until the Launcher app is running. This mode is chosen only if no others are detected. This run environment is typically picked for individual users who install their Omniverse apps through the desktop Omniverse Launcher app. This run environment is referred to as “OVI”. - Cloud: This launches the transmitter in ‘cloud’ mode. In this mode the final output from the transmitter is not sent anywhere, but rather written to a local file on disk. The intent is that another log consumer service will monitor for changes on this log file and consume events as they become available. This allows more control over which data is ingested and how that data is ingested. This run environment is typically launched through the Omniverse Cloud cockpit web portal and is referred to as “OVC”. - Enterprise: This launches the transmitter in ‘enterprise’ mode. In this mode, data is sent to an open endpoint data collector. No authentication is needed in this mode. The data coming in does however get validated before storing. This run environment is typically detected when using the Omniverse Enterprise Launcher app to install or launch the Kit based app. This run environment is referred to as “OVE”. Many of the structured logging and telemetry settings that come from the Carbonite components of the telemetry system also affect how the `omni.kit.telemetry` extension starts up. Some of the more useful settings that affect this are listed below. Other settings listed in the above Carbonite documentation can be referred to for additional information. The following settings can control the startup behavior of the `omni.kit.telemetry` extension, the transmitter launch, and structured logging for the app: - Settings used for configuring the transmitter to use an open endpoint: - `/structuredLog/privacySettingsFile`: Sets the location of the privacy settings TOML file. This setting should only be used when configuring an app in a container to use a special privacy settings file instead of the default one. The default location and name for this file is `~/.nvidia-omniverse/config/privacy.toml`. This setting is undefined by default. - `/telemetry/openTestEndpointUrl`: Sets the URL to use as the test mode open endpoint URL for the transmitter. This value is specified in the extension’s configuration files and may override anything given on the command line or other global config files. - `/telemetry/openEndpointUrl`: Sets the URL to use as the dev or production mode open endpoint URL for the transmitter. This value is specified in the extension’s configuration files and may override anything given on the command line or other global config files. - `/telemetry/enterpriseOpenTestEndpointUrl`: Sets the URL to use as the test mode open endpoint URL for OVE for the transmitter. This value is specified in the extension’s configuration files and may override anything given on the command line or other global config files. - `/telemetry/enterpriseOpenEndpointUrl`: Sets the URL to use as the dev or production mode open endpoint URL for OVE for the transmitter. This value is specified in the extension’s configuration files and may override anything given on the command line or other global config files. - `/telemetry/useOpenEndpoint`: Boolean value to explicitly launch the transmitter in ‘open endpoint’ mode. This will configure the transmitter to set its endpoint to the Kratos open endpoint URL for the current telemetry mode and run environment. In most cases this setting and ensuring that the privacy settings are provided by the user are enough to successfully launch the transmitter in open endpoint mode. This defaults to `false`. - `/telemetry/enableAnonymousData`: Boolean value to override several other telemetry, privacy, and endpoint settings. This will clear out all user information settings (both in the settings registry and cached in the running process), choose a random user ID for the session, enable all consent levels, enable `/telemetry/useOpenEndpoint`, and clear out `/telemetry/mode` so that only production mode events can be used. 1. Extension Startup: - `omni.kit.telemetry`: This is the identifier for the telemetry extension when it starts up. 2. Logging Control Settings: - `/telemetry/log/level`: Sets the logging level for the transmitter, defaulting to `warning`. Useful for debugging without affecting the app's default logging level. - `/telemetry/log/file`: Sets the log output filename for the transmitter, defaulting to `omni.telemetry.transmitter.log` in the structured log directory (`~/.nvidia-omniverse/logs/`). Can be overridden in 'portable' mode. - Any other `/log/` settings, except `/log/enableStandardStreamOutput`, `/log/file`, and `/log/level`, are inherited by the transmitter. - `/structuredLog/extraFields/`: Settings under this branch are passed to the transmitter unmodified. - `/telemetry/`: Settings under this branch are passed to the transmitter unmodified. - `/structuredLog/privacySettingsFile`: Passed to the transmitter if specified. Transmitter may override these settings if a `privacy.toml` file is detected. - `/structuredLog/logDirectory`: Passed to the transmitter if explicitly given. - `/telemetry/testLogFile`: Specifies the path to a special log file for additional transmitter information, defaulting to disabled. 3. Telemetry Destination Control Settings: - `/telemetry/enableNVDF`: Controls whether the NVDF endpoint is added during launch in OVI environments, enabled by default. - `/telemetry/nvdfTestEndpoint`: Specifies the 'test' or 'production' NVDF endpoint if `/telemetry/enableNVDF` is enabled, defaulting to `false`. - `/telemetry/endpoint`: Overrides the default public endpoint, ignored in OVE and open endpoint environments, defaulting to an empty string. - `/telemetry/cloudLogEndpoint`: Allows overriding the default endpoint for OVC, expected as a local file URI, defaulting to `file:///${omni_logs}/kit.transmitter.out.log`. Must set server name to `localhost` or leave it blank. ## File Paths The `<code>` tag in HTML is used to represent computer code. HTML also supports the use of the `<pre>` tag for preformatted text. The `<code>` tag is used to define a piece of computer code. Text within this tag is typically displayed in a monospace font. For example: ```html <code> <span class="pre"> localhost </span> </code> ``` In this case, the text "localhost" would be displayed in a monospace font. The `<pre>` tag is used to define preformatted text. Text within this tag preserves both spaces and line breaks. For example: ```html <pre> This is a line of text. This is another line of text. </pre> ``` In this case, the text would be displayed exactly as it is written, with the line breaks preserved. When used together, the `<code>` and `<pre>` tags can be used to display code in a way that is easy to read and understand. For example: ```html <pre> <code> for (int i = 0; i < 10; i++) { printf("Hello, world!\n"); } </code> </pre> ``` In this case, the code would be displayed in a monospace font, with the line breaks and indentation preserved. It is important to note that the `<code>` and `<pre>` tags are not the only way to display code in HTML. There are also other tags and attributes that can be used to style code, such as the `<kbd>` tag for keyboard input, and the `style` attribute for custom CSS styles. However, the `<code>` and `<pre>` tags are the most commonly used, and are supported by all modern web browsers. ## Settings to control the extension’s startup behavior - `/exts/omni.kit.telemetry/skipDeferredStartup`: Boolean setting to allow the extension’s various startup tasks to be run serially instead of in parallel. This is often needed for unit test purposes to guarantee that all of the startup tasks have completed before the extension’s tests start to run. If enabled, this will cause the extension to take slightly longer to startup (should still be less than 2s in almost all cases). This defaults to `false`. ## Settings specific to the OVC run environment - `/cloud/cluster`: String setting that specifies the name of the cluster the session will run on. This is expected to be provided by the OVC app launch system. This defaults to an empty string. - `/cloud/node`: String setting that specifies the name of the node that the session will run on. This is expected to be provided by the OVC app launch system. This defaults to an empty string. - `/telemetry/extraFieldsToAdd`: String setting that specifies which of the extra fields under `/structuredLog/extraFields/` that are inherited by the telemetry transmitter on launch should be automatically added to each message by the transmitter. This is expected to be a comma separated list of key names in the `/structuredLog/extraFields/` settings branch. Note that there should not be any whitespace in this setting’s value otherwise some platforms such as Windows could parse it incorrectly. Any keys names in this list that do not exist as extra fields passed to the transmitter will simply be ignored. This defaults to an empty string. Note that if this setting is present and contains the `schemaid` field name, the transmitter will automatically retrieve and add the correct schema ID value to each message that is sent. This automatic behavior also requires the `/telemetry/runEnvironment` setting however to correctly determine which schema ID to use. - `/telemetry/runEnvironment`: String setting that specifies the run environment that the `omni.kit.telemetry` extension has detected. This is automatically passed on to the telemetry transmitter when running in open-endpoint mode. ## Crash Reporter Metadata The `omni.kit.telemetry` extension will set or modify several crash reporter metadata values during its startup. Unless otherwise noted, each of these metadata values will be created by the extension. The following metadata values are managed by this extension: - `environmentName`: This metadata value is originally set by Kit-kernel, but can be modified by `omni.kit.telemetry` if it is left at the value `default`. In this case, its value will be replaced by the current detected run environment - one of `Individual`, `Enterprise`, or `Cloud`. - `runEnvironment`: Contains the current detected run environment - one of `Individual`, `Enterprise`, or `Cloud`. This value is added to explicitly include the run environment name even in cases where `environmentName` is set to something else by Kit-kernel. - `externalBuild`: Set to `true` if the current Kit app is being run by an external (ie: public) user or has not been detected as an internal-only session. Set to `false` if an internal user or session has been detected. - `launcherSessionId`: If the OVI launcher app is currently running in the system, this value is set to the session ID for the launcher. - `cloudPodSessionId`: If in the OVC run environment, this will contain the cloud session ID. - `cpuName`: The friendly name of the system’s main CPU. - `cpuId`: The internal ID of the system’s main CPU. - `cpuVendor`: The name of the system’s main CPU vendor. - `osName`: The friendly name of the operating system. - `osDistro`: The distribution name of the operating system. - `osVersion`: The detailed version number or code of the operating system. - `primaryDisplayRes`: The resolution of the system’s primary display (if any). - `desktopSize`: The size of the entire system desktop for the current user. - `desktopOrigin`: The top-left origin point of the desktop window. On some systems this may just be (0, 0), but others such as Windows allow for negative origin points. - `displayCount`: The number of attached displays (if any). - `displayRes_<n>`: The current resolution in pixels of the n-th display. - `gpu_<n>`: The name of the n-th GPU attached to the system. - `gpuVRAM_<n>`: The amount of video memory the n-th GPU attached to the system has. - `gpuDriver_<n>`: The active driver version for the n-th GPU attached to the system.
configuring.md	# 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`. > 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: 1. The config name becomes application name. 2. Separate data, documents and cache folders are created for applications. 3. 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: ```toml [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: 1. `${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` 2. `${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` 3. `<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. 4. `<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. - To override settings of any kit application in the shared program data, typically in (on Windows): ``` ${shared_program_data}/kit.config.toml ``` ``` %PROGRAMDATA%/NVIDIA Corporation/Kit/kit.config.toml ``` - To override settings of particular application in the application program data, typically in (on Windows): ``` ${app_program_data}/kit.config.toml ``` ``` %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: ```toml [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: ```toml [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: 1. App portable config, e.g. ``` foo.portable ``` near ``` foo.kit ``` when run with: ``` kit.exe foo.kit ``` 2. Kit portable config near experience, e.g. ``` kit.portable ``` near ``` foo.kit ``` when run with: ``` kit.exe foo.kit ``` 1. 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: ```json <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 1. The values are case-insensitive and using `--/some/path/to/parameter=false` or `--/some/path/to/parameter=FaLsE` produces the same result 2. If you need to set the string value `"true"` or `"false"` escape it with double quotes: `--/some/path/to/text_parameter=\"false\"` 3. 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: 1. 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 ```json ... "some": { "array" : [1, 2, 3], }, ... ``` into ```json ... "some": { "array" : [1, 17, 3], }, ... ``` 1. 要求转化成markdown格式后的数据能够被markdown编译器直接运行，不需要添加额外的解释。 2. 要保证转换后的markdown数据和转换前的html数据，在文本内容上能够完整对应，不要改动或删除html的内容。 3. 在转换时，删除掉html中的url链接，但是要保留链接对应的文本信息。 4. 在转换时，删除掉html中的图片 4. 剔除乱码，解决格式错乱问题。 html格式数据如下： ```markdown - 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 ```python # 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 ```python # 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 ```python # Settings/Set Persistent Setting ``` ```python 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 ```python 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`) Disable processing of any command line arguments. ## 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).
containers.md	# Containers Container is the base class for grouping items. It’s possible to add children to the container with Python’s `with` statement. It’s not possible to reparent items. Instead, it’s necessary to remove the item and recreate a similar item under another parent. ## Transform Transform is the container that propagates the affine transformations to its children. It has properties to scale the items to screen space and orient the items to the current camera. ```python line_count = 36 for i in range(line_count): weight = i / line_count angle = 2.0 * math.pi * weight # translation matrix move = sc.Matrix44.get_translation_matrix( 8 * (weight - 0.5), 0.5 * math.sin(angle), 0) # rotation matrix rotate = sc.Matrix44.get_rotation_matrix(0, 0, angle) # the final transformation transform = move * rotate color = cl(weight, 1.0 - weight, 1.0) # create transform and put line to it with sc.Transform(transform=transform): sc.Line([0, 0, 0], [0.5, 0, 0], color=color) ```
content.md	# Repo Overview ## Extensions During build phase extensions are built (native), staged (copied and linked) into `_build/{platform}/{config}/exts` folder. Custom app (`.kit` file config) is used to enable those extensions. Each extension is a folder (or zip archive) in the end. You can write user code in python code only, or C++ only, or both. Ultimately extension archive could contain python code, python bindings (pyd/so files) and C++ plugins (dll/so). Each binary file is platform and configuration (debug/release) specific. For python bindings naming we follow Python standards. For more info refer to Kit documentation. ### example.python_ext Example of pure python extension src: `source/extensions/example.python_ext` ### example.cpp_ext Example of native (C++ only) extension. src: `source/extensions/example.cpp_ext` ### example.mixed_ext Example of mixed extension which has both C++ and python code. They interact via python bindings built and included with this extension. src: `source/extensions/example.mixed_ext` ## Simple App Example of an app which runs only those 3 extensions in Kit (and test_runner for tests). All configs are in `source/apps`, they are linked during build (stage phase). src: `source/apps/omni.app.new_exts_demo_mini.kit` ``` _build\windows-x86_64\release\omni.app.new_exts_demo_mini.bat ``` ## Running Kit from Python It also includes example of running Kit from python, both default Kit and an app which runs only those 3 extensions in Kit. ``` _build\windows-x86_64\release\example.pythonapp.bat ``` That runs default python example, to see list of examples: ``` _build\windows-x86_64\release\example.pythonapp.bat --help ``` Pass different one as first argument to run it. ## App that is deployed in the Launcher Another app included: ``` # Application Structure This section describes the structure of the application. ## App Kit The app kit is located at `source/apps/omni.app.my_app.kit`. It demonstrates an app that ends up in Omniverse Launcher. It has dependencies that come from extension registry. Kit will automatically resolve and download missing extensions when started. But usually we download them at build-time and package final application with everything included to work offline. That is done using the `repo precache_exts` tool. It runs after build, starts Kit with special set of flags to download all extensions. In the `[repo_precache_exts]` section of `repo.toml`, you can find list of kit files it uses. Also it locks all versions of each extension, including implicit dependencies (2nd, 3rd etc order) and writes back into the kit file. You can find the generated section in the end of kit file. This version lock is then should be committed. That provides reproducible builds and makes kit file completely and immutably define whole application. To regenerate version lock run `build -u`. ## Config files - `premake5.lua` - all configuration for generating platform specific build solutions. premake5 docs. - `repo.toml` - configuration of all repo tools (build, package, format etc). Notice `import_configs = ["${root}/_repo/deps/repo_kit_tools/kit-template/repo.toml"]` in `repo.toml`. That is a feature of `repo_man` to import another configuration. In practice it means that this `repo.toml` is merged later on top of imported one. You can find many more shared settings in this file. Premake file also imports shared configuration with `dofile("_repo/deps/repo_kit_tools/kit-template/premake5.lua")` line. ## CI / Teamcity Teamcity Project runs on every commit. Builds both platforms, docs, runs tests. Publishing is optional (click “Run” on “publish” configuration). Teamcity configuration is stored in the repo, in `.teamcity` folder. All Teamcity entry points are in `tools/ci` folder. It can also be easily copied in Teamcity along with forking this project on gitlab.
contents_index.md	# Omniverse Carbonite SDK ## Omniverse Carbonite SDK The Omniverse Carbonite SDK is the foundational software layer for Omniverse applications, microservices, tools, plugins, Connectors, and SDKs. The Omniverse Carbonite SDK provides the following high-level features: ### ABI Stable Interfaces The core of Carbonite provides tooling that enables developers to define and maintain ABI stable interfaces. We call these interfaces Omniverse Native Interfaces (ONI). These interfaces allow the creation of software components that are binary stable across compiler toolchains, OS revisions, and SDK releases. ### Plugins Carbonite provides a plugin system that allows the functionality of applications to be dynamically extended at runtime. ### Cross-Platform Abstractions In order to be useful on a variety of hardware and operating systems, Carbonite exposes ABI-stable interfaces which provide a uniform abstraction over low-level platform facilities. ### Inline Headers Carbonite contains a rich suite of well tested, efficient, cross-platform, general purpose inline headers. ### Diagnostics Universally useful diagnostic APIs for profiling, crash reporting, and telemetry are provided by Carbonite as first-class citizens. ## Building To build on Windows: ```shell build ``` To build on Linux: ```shell ./build.sh ``` ## Testing To run Carbonite’s unit tests on Windows: ```shell _build\windows-x86_64\release\test.unit.exe ``` ## License Carbonite is proprietary software of NVIDIA Corporation. License details can be found in the documentation. # Contents ## Top Level - Carbonite Plugins/Interfaces - Omniverse Native Interfaces - Deploying a Carbonite Application ## Components - Asserts - Audio - Crash Reporter - Function - Carbonite Input Plugin - Overview - Localization - Logging - Memory - Python Bindings - String - Tasking - Telemetry - Unicode ## Guides - ABI Compatibility - Building - Unity Builds - Testing - Packaging - Releasing - Using Valgrind - Carbonite Interface Walkthrough - Creating a New Omniverse Native Interface - Troubleshooting - Extending an Omniverse Native Interface Walkthrough - Using omni.bind ## Documenting - Documentation Guidelines - Restructured Text Guide - C++ Documentation Guide - Python Documentation Guide
content_install.md	# 3D Content Pack Installation For our Omniverse customers who need to run in a firewalled environment, here is how to configure the sample 3D content that comes with the Omniverse foundation applications. As there is currently a total of roughly 260GB of USD samples, materials and environments available, this document should help you identify the types of content packs that you need to provide to your internal Omniverse users to help them with their workflows. ## 3D Content Pack Download Process There are five steps for IT managers to follow to download and configure individual Omniverse content packs for firewalled environments and users. 1. Identify: The first step is to select which 3D content packs are required by your users. Given that users will often ask for content based on where it lives within certain Omniverse foundation app Browsers (e.g. “can I get all of the Base Materials in the Materials tab?”) this documentation organizes the downloadable packs by which Omniverse Browser they normally reside or which Omniverse Extension they relate to. See the following section on the various Omniverse browsers and extensions that include content. 2. Download: Once you’ve determined which content packs to download, the next step is to go to the Omniverse Enterprise Web Portal, and to click on the Content section to find all of the available archive files. When you find the pack that matches, click Download, and choose whether you’re downloading for a Windows or Linux workstation. The download will begin automatically for that pack. Given that many content packs are GBs in size, this process can take some time to complete. > Certain Omniverse foundation applications contain the same browsers, but the content available within them may be slightly different or reduced. Wherever possible, we have indicated which content packs in each browser are included with those apps. 3. Unpack: After each content pack is downloaded, you need to unzip it. We’ve tried to make the unpacking process as simple as possible by configuring each zip archive so that it mirrors the same folder structure that exists on our AWS server so that all you have to do is create a top-level folder where you want ALL of your content to live, and then unpack the archives “as-is” into that root location. Doing so will create an exact copy of the NVIDIA folder structure normally available within every Nucleus install. By default, that top-level structure includes five (5) main folders (Assets / Demos / Environments / Materials / Samples): ![Content Structure](../_images/content_01.png) Each of the downloadable content packs is set up to reflect these top-level folders which should make organization of the assets themselves efficient and straightforward. For example, if you download the Base Materials pack, when you open the zip archive, you’ll see this: ![Base Materials Pack Structure](../_images/content_02.png) By default, the content itself lives inside of the sub-folder and is called `package.zip`. If you decompress the entire archive, you’ll end up with a sub-folder and when you open the `package.zip` file within it, you’ll see this: ![Decompressed Base Materials Pack](../_images/content_03.png) At the root is a `/Materials` folder, which matches the online AWS configuration, and within it are the various sub-folders and files that make up the Base Materials MDL library. By unpacking the archive with the folder structure intact, you’ll ensure that your library matches the one that exists online. ```admonition::note Note There are two additional files in each archive: - A PACKAGE-INFO.yaml file - this describes the package contents. - A PACKAGE-LICENSES folder with a text document pointing users to the Omniverse Terms of Use. Neither of these is required for your users to access the content packs, and can be safely stored elsewhere or deleted upon the completion of unpacking each archive. ``` 4) Deploy: In order to make the content visible within Omniverse for your users, you have a choice on how to deploy the content. - Option 1: Copy all of the content to a local hard disk drive location - Option 2: Copy all of the content to a shared Nucleus server behind your firewall Both options are straightforward as you simply need to transfer the entire content folder structure that you set up in Step 3 to a local physical hard drive location or you can use Nucleus Navigator to copy that content folder to a shared internal Nucleus Server that is accessible to your internal users. 5) Update firewalled TOML files: In order for a user to see the local files instead of trying to “dial-out” to get content via AWS, you need to add a set of known redirect paths to point those requests to your local hard disk or internal Enterprise Nucleus server. To do this, you must define the new content path root aliases within the `omniverse.toml` file stored in `~/.nvidia-omniverse/config` (Linux) or `\%USERPROFILE%\.nvidia-omniverse\config` (Windows) for each user on the network. If you have opted to place the content on a local hard disk drive location, add the following section in its entirety to the `omniverse.toml` file and replace the `<HardDrivePath>` variable with the folder you chose in step 5 to store all of the content packs. ```toml [aliases] "http://omniverse-content-production.s3.us-west-2.amazonaws.com" = "<HardDrivePath>" "https://omniverse-content-production.s3.us-west-2.amazonaws.com" = "<HardDrivePath>" "http://omniverse-content-production.s3-us-west-2.amazonaws.com" = "<HardDrivePath>" "https://omniverse-content-production.s3-us-west-2.amazonaws.com" = "<HardDrivePath>" "https://twinbru.s3.eu-west-1.amazonaws.com/omniverse" = "<HardDrivePath>" ``` As an example, if you have copied all of your content to the `C:\Temp\NVIDIA_Assets` folder on the local machine, the paths would look like this: ```toml [aliases] "http://omniverse-content-production.s3.us-west-2.amazonaws.com" = "C:\\Temp\\NVIDIA_Assets" "https://omniverse-content-production.s3.us-west-2.amazonaws.com" = "C:\\Temp\\NVIDIA_Assets" "http://omniverse-content-production.s3-us-west-2.amazonaws.com" = "C:\\Temp\\NVIDIA_Assets" "https://omniverse-content-production.s3-us-west-2.amazonaws.com" = "C:\\Temp\\NVIDIA_Assets" "https://twinbru.s3.eu-west-1.amazonaws.com/omniverse" = "C:\\Temp\\NVIDIA_Assets" ``` ```admonition::note Note The need for double-backslashes (\\) in the path name if you’re on Windows. ``` If you have opted to place the content on a shared Nucleus location, in the following section replace the `<server_name>` with the actual name of your server (i.e. `<server_name>` is replaced with localhost). ```toml [aliases] "http://omniverse-content-production.s3.us-west-2.amazonaws.com" = "omniverse://<server_name>/<path>" "https://omniverse-content-production.s3.us-west-2.amazonaws.com" = "omniverse://<server_name>/<path>" "http://omniverse-content-production.s3-us-west-2.amazonaws.com" = "omniverse://<server_name>/<path>" "https://omniverse-content-production.s3-us-west-2.amazonaws.com" = "omniverse://<server_name>/<path>" "https://twinbru.s3.eu-west-1.amazonaws.com/omniverse" = "omniverse://<server_name>/<path>" ``` Once this process is complete, when a user launches their copy of an Omniverse foundation app, they should have direct access to the various content packs directly without the application trying to connect to the Internet. # NVIDIA Assets Browser The NVIDIA Assets Browser will indicate that 5 separate zip downloads are needed to provide all of the various 3D assets within it. ## List of Browsers Accompanying Omniverse Foundation Applications - Core Content (Strongly Recommended all users grab this) - NVIDIA Assets - Environments - Materials - Showcases - SimReady Explorer - Examples - Physics Demo Scenes Additionally, some content shows up with specific Omniverse extensions, and if your users ask for any of these content packs by the extension they support, you can find them here: - AnimGraph - Rendering - Particles - ActionGraph - Warp - Flow Some Omniverse foundation applications also include unique content packs as well. You can find them here: - Audio2Face - IsaacSim # Core Omniverse App Content When many Omniverse foundation applications start (USD Composer, USD Explorer, Code), it loads a set of default scene templates including the textured ground plane and lighting that comes up automatically. This pack should always be downloaded. It is very small but will help prevent errors in the console when an Omniverse application first starts in an firewalled environment. This content pack includes all of the templates and is essential for firewalled environments. - Launcher Pack Name: Default Scene Templates Pack - Included in Omniverse Apps: USD Composer / USD Explorer / Code / USD Presenter - Pack: `Scene_Templates_NVD@10010.zip` - Pack Size: 24MB - Contents: All of the scene templates that can be accessed from the File->New from Stage Template menu in Omniverse - Default Nucleus Location: NVIDIA/Assets/Scenes/Templates # Browsers Content There are several different browsers where you can access and utilize content provided by NVIDIA. Some of these are visible by default (depending on which foundation Omniverse application you are running), while others are accessible via different menus inside of the applications. For each browser, here is a list of the content packs required. ## NVIDIA Assets Browser There are 5 individual content pack downloads that encompass all of the visible content available within this browser - Launcher Pack Name: Commercial 3D Models Pack - Included in Omniverse Apps: USD Composer / USD Explorer / Code - Pack: `Commercial_NVD@10013.zip` - Pack Size: 5.8GB - Contents: Commercial furniture and entourage content - Default Nucleus Location: NVIDIA/Assets/ArchVis/Commercial # Note In order for the Commercial content within this pack to operate correctly, it needs to have the Materials / Base Materials Pack (Base_Materials_NVD@10012.zip) from the Materials Browser installed for the materials. ## Industrial 3D Models Pack - Launcher Pack Name: Industrial 3D Models Pack - Included in Omniverse Apps: USD Composer / USD Explorer / Code - Pack: Industrial_NVD@10012.zip - Pack Size: 1.8GB - Contents: Industrials boxes/shelving and entourage content - Default Nucleus Location: NVIDIA/Assets/ArchVis/Industrial ## Residential 3D Models Pack - Launcher Pack Name: Residential 3D Models Pack - Included in Omniverse Apps: USD Composer / Code - Pack: Residential_NVD@10012.zip - Pack Size: 22.5GB - Contents: Residential furniture and entourage content - Default Nucleus Location: NVIDIA/Assets/ArchVis/Residential ## Vegetation 3D Models Pack - Launcher Pack Name: Vegetation 3D Models Pack - Included in Omniverse Apps: USD Composer / Code - Pack: Vegetation_NVD@10012.zip - Pack Size: 2.7GB - Contents: Selection of plants and tree content - Default Nucleus Location: NVIDIA/Assets/Vegetation ## Warehouse 3D Models Pack - Launcher Pack Name: Warehouse 3D Models Pack - Included in Omniverse Apps: USD Composer / USD Explorer / Code - Pack: Warehouse_NVD@10012.zip - Pack Size: 18GB - Contents: Digital Twin warehouse elements content - Default Nucleus Location: NVIDIA/Assets/DigitalTwin/Assets/Warehouse # Showcases Browser In order for the content within this pack to operate correctly, it needs to have the Examples Browser / Sample Scenes Pack from the Examples Browser installed for the materials. ## Showcase Scenes 3D Models Pack - Launcher Pack Name: Showcase Scenes 3D Models Pack - Included in Omniverse Apps: USD Composer - Pack: Showcases_Content_NVD@10010.zip - Pack Size: 2.3GB - Contents: Full warehouse and Ragnarok vehicle content - Default Nucleus Location: NVIDIA/Samples/Showcases # Materials Browser There are 3 individual content pack downloads that encompass all of the visible content available through this browser and it is recommended that you download and install both the Base Materials and vMaterials 2 packs as they are often used within other sample content. ## Base Materials Pack - Launcher Pack Name: Base Materials Pack - Included in Omniverse Apps: USD Composer / USD Explorer / Code - Pack: Base_Materials_NVD@10012.zip - Pack Size: 8.2GB - Contents: (No specific content mentioned) ### Base Materials Library - Default Nucleus Location: NVIDIA/Materials/2023_1/Base - Launcher Pack Name: VMaterials 2 Pack - Included in Omniverse Apps: USD Composer / Code - Pack: `vMaterials_2_2_1_NVD@20022.zip` - Pack Size: 5.5GB - Contents: vMaterials 2 library (v. 2.2.1 is the current release) - Default Nucleus Location: NVIDIA/Materials/2023_1/vMaterials_2 - Launcher Pack Name: Automotive Materials Pack - Included in Omniverse Apps: USD Composer / Code - Pack: `Automotive_Materials_NVD@10010.zip` - Pack Size: 21GB - Contents: Automotive materials library - Default Nucleus Location: NVIDIA/Materials/2023_1/Automotive ### Environments Browser - Launcher Pack Name: Environments Skies Pack - Included in Omniverse Apps: USD Composer / Code - Pack: `Environments_NVD@10012.zip` - Pack Size: 8.9GB - Contents: HDRI skydomes and Dynamic sky environments - Default Nucleus Location: NVIDIA/Environments/2023_1/DomeLights - Launcher Pack Name: Environment Templates Pack - Included in Omniverse Apps: USD Composer / Code - Pack: `Environments_Templates_NVD@10010.zip` - Pack Size: 16.0GB - Contents: Templates that have been designed to assist with automotive presentations - Default Nucleus Location: NVIDIA/Environments/2023_1/Templates ### SimReady Explorer - Note: There is some redundancy in files between packs that are shared across the entire library, but if you are only interested in a small subset of the content, you will still get all of the supporting materials and configuration files in any one downloaded content pack. - Launcher Pack Name: SimReady Warehouse 01 3D Models Pack - Included in Omniverse Apps: USD Composer / Code - Pack: `SimReady_Warehouse_01_NVD@10010.zip` - Pack Size: 13.9GB - Contents: Warehouse elements (foot stools, ramps, shelving, pallets) - Default Nucleus Location: NVIDIA/Assets/simready_content - Launcher Pack Name: SimReady Warehouse 02 3D Models Pack - Included in Omniverse Apps: USD Composer / Code - Pack: `SimReady_Warehouse_02_NVD@10010.zip` - Pack Size: 20.5GB - Contents: Warehouse elements (pallets, racks, ramps) - Default Nucleus Location: NVIDIA/Assets/simready_content - Launcher Pack Name: SimReady Furniture & Misc 3D Models Pack - Included in Omniverse Apps: USD Composer / Code - Pack: `SimReady_Furniture_Misc_NVD@10010.zip` - Pack Size: 9.4GB - Contents: Assorted furniture and entourage elements (cones, chairs, sofas, utensils) - Default Nucleus Location: NVIDIA/Assets/simready_content - Launcher Pack Name: SimReady Containers & Shipping 01 3D Models Pack - Included in Omniverse Apps: USD Composer / Code - Pack: `SimReady_Containers_Shipping_01_NVD@10010.zip` - Pack Size: 21.4GB - Contents: Industrial elements (bins, boxes, cases, drums, buckets) - Default Nucleus Location: NVIDIA/Assets/simready_content - Launcher Pack Name: SimReady Containers & Shipping 02 3D Models Pack - Included in Omniverse Apps: USD Composer / Code - Pack: `SimReady_Containers_Shipping_02_NVD@10010.zip` - Pack Size: 20.6GB - Contents: Industrial elements (crates, jugs, IBC tank, bottles, etc.) - Default Nucleus Location: NVIDIA/Assets/simready_content - Launcher Pack Name: AnimGraph Sample 3D Model Pack - Included in Omniverse Apps: USD Composer - Pack: `AnimGraph_NVD@10010.zip` - Pack Size: 1.6GB - Contents: This pack includes all of the character animation samples - Default Nucleus Location: NVIDIA/Assets/AnimGraph - Launcher Pack Name: Automotive Configurator 3D Models Pack - Included in Omniverse Apps: USD Composer - Pack: `Configurator_Content_NVD@10010.zip` - Pack Size: 2.0GB - Contents: This pack contains content for building automotive configurators - Default Nucleus Location: NVIDIA/Assets/Configurator - Launcher Pack Name: Sample Scenes 3D Models Pack - Included in Omniverse Apps: USD Composer / Code - Pack: `Sample_Scenes_NVD@10010.zip` - Pack Size: 26.0GB - Contents: High fidelity rendering scenes including the Astronaut, Marbles and the Old Attic datasets - Default Nucleus Location: NVIDIA/Samples/Examples/2023_1/Rendering Note: The Sample_Scenes pack is also needed if you’ve downloaded the Showcases content pack to work as expected. - Launcher Pack Name: Particle Systems 3D Models Pack - Included in Omniverse Apps: USD Composer - Pack: `Particles_NVD@10010.zip` - Pack Size: 159MB - Contents: (contents not specified) # Contents - Contents: This pack includes all of the particle systems sample files - Default Nucleus Location: NVIDIA/Assets/Particles - Launcher Pack Name: Extensions Samples 3D Models Pack - Included in Omniverse Apps: USD Composer / Code - Pack: Extensions_Samples_NVD@10010.zip - Pack Size: 900MB - Contents: Contains sample data for Flow, Paint, Warp and ActionGraph extensions - Default Nucleus Location: NVIDIA/Assets/Extensions/Samples # Physics Demo Scenes Browser - Launcher Pack Name: Physics Demo Scenes 3D Models Pack - Included in Omniverse Apps: USD Composer / Code - Pack: Physics_Scenes_NVD@10010.zip - Pack Size: 5.5GB - Contents: All of the current Physics sample scene files that can be loaded from the Demo Scenes tab - Default Nucleus Location: Not in a public Nucleus folder # Extensions Content Extension content is mostly covered within the various Browsers inside of the foundation Omniverse applications. But if you’re interested in a specific extension and the content that showcases it, here’s a list of which downloadable pack contains that content. ## AnimGraph Samples - Launcher Pack Name: AnimGraph Sample 3D Models Pack - Included in Omniverse Apps: USD Composer / Code - Pack: AnimGraph_NVD@10010.zip - Pack Size: 1.6GB - Contents: Character and motion sample data for use with AnimGraph - Default Nucleus Location: NVIDIA/Assets/AnimGraph ## Rendering Samples - Launcher Pack Name: Sample Scenes 3D Models Pack - Included in Omniverse Apps: USD Composer / Code - Pack: Sample_Scenes_NVD@10010.zip - Pack Size: 26.0GB - Contents: High fidelity rendering scenes including the Astronaut, Marbles and the Old Attic datasets - Default Nucleus Location: NVIDIA/Samples/Examples/2023_1/Rendering ## Particle Systems Presets - Launcher Pack Name: Particle Systems 3D Models Pack - Included in Omniverse Apps: USD Composer - Pack: ``` Particles_NVD@10010.zip ``` - Pack Size: 159MB - Contents: Particles systems presets - Default Nucleus Location: NVIDIA/Samples/Examples/2023_1/Visual Scripting ### Note The Ocean sample files are installed locally with the omni.ocean extension and can be found in the following Omniverse install location (USD Composer: - /Omniverse/Library/prod-create-2023.1.1/extscache/omni.ocean-0.4.1/data Any installed Omniverse foundation application that includes the omni.ocean extension will include these files, so you can replace the library app path (e.g. `prod-create-2023.1.1`) to find those that are installed on your machine. ## ActionGraph Samples - ActionGraph: Available within the Examples Browser under the Visual Scripting header - Launcher Pack Name: Sample Scenes 3D Models Pack - Included in Omniverse Apps: USD Composer / Code - Pack: ``` Sample_Scenes_NVD@10010.zip ``` - Pack Size: 26.0GB - Contents: Tutorial samples for OmniGraph - Default Nucleus Location: NVIDIA/Samples/Examples/2023_01/Visual Scripting ## Warp Samples - Warp: Available within the Examples Browser under the Warp header - Launcher Pack Name: Extensions Samples 3D Models Pack - Included in Omniverse Apps: USD Composer / Code - Pack: ``` Extensions_Samples_NVD@10010.zip ``` - Pack Size: 878MB - Contents: Tutorial samples for the Warp extension - Default Nucleus Location: NVIDIA/Samples/Examples/Warp ### Note Some of the sample files are installed locally with the omni.warp extension and can be found in the following Omniverse install location (USD Composer: - /Omniverse/Library/extscache/omni.warp-0.8.2/data/scenes Any installed Omniverse foundation application that includes the omni.warp extension will include these files, so you can replace the library app path (e.g. `prod-create-2023.1.1`) to find those that are installed on your machine. ## Flow Presets - Flow: Accessed through the Window -> Simulation -> Flow Presets menu - Launcher Pack Name: Extensions Samples 3D Models Pack - Included in Omniverse Apps: USD Composer - Pack: ``` Extensions_Samples_NVD@10010.zip ``` - Pack Size: 878MB - Contents: Tutorial samples for the Flow simulation extension - Default Nucleus Location: NVIDIA/Samples/Examples/Flow - XR: This content is accessed directly from within the Nucleus Content browser - Launcher Pack Name: XR Samples 3D Models Pack - Included in Omniverse Apps: USD Composer - Pack: ``` XR_Content_NVD@10010.zip ``` - Pack Size: 5.3GB # Contents: - Legacy Create XR templates and stages for working in XR environments - Default Nucleus Location: NVIDIA/Assets/XR # Core Demos: This content is accessed directly from within the Nucleus Content browser - Launcher Pack Name: Core Demo Samples 3D Models Pack - Included in Omniverse Apps: USD Composer - Pack: Core_Demos_NVD@10010.zip - Pack Size: 8.9GB - Contents: Contains multiple demo scenes for MFG, Cloudmaker, Connect and Warehouse Physics - Default Nucleus Location: NVIDIA/Demos # Foundation Apps Specific Content ## Audio2Face App - Launcher Pack Name: Audio2Face Sample 3D Models Pack - Included in Omniverse Apps: Audio2Face / USD Composer - Pack: A2F_Content_NVD@10010.zip - Pack Size: 6.2GB - Contents: All of the core Audio2Face sample content that is available within the Example Browser in the Audio2Face app - Default Nucleus Location: NVIDIA/Assets/Audio2Face ## IsaacSim IsaacSim content is versioned in folders inside of NVIDIA/Assets/Isaac on AWS and as such, it’s been configured in zip archives to mimic this folder structure. Each version of Isaac Sim uses only the specific versioned folder. In the Launcher IsaacSim Assets is split into 3 content packs. - Launcher Pack Name: Isaac Sim Assets Pack 1 - Included in Omniverse Apps: IsaacSim - Pack Size: 19.9GB - Contents: All of the core Isaac Sim sample content plus dependencies from the /NVIDIA folder. Split into 3 packs. - Default Nucleus Location: NVIDIA/Assets/Isaac/2023.1.0 - Launcher Pack Name: Isaac Sim Assets Pack 2 - Included in Omniverse Apps: IsaacSim - Pack Size: 27.8GB - Contents: All of the core Isaac Sim sample content plus dependencies from the /NVIDIA folder. Split into 3 packs. - Default Nucleus Location: NVIDIA/Assets/Isaac/2023.1.0 - Launcher Pack Name: Isaac Sim Assets Pack 3 - Included in Omniverse Apps: IsaacSim - Pack Size: 28.4GB - Contents: All of the core Isaac Sim sample content plus dependencies from the /NVIDIA folder. Split into 3 packs. - Default Nucleus Location: NVIDIA/Assets/Isaac/2023.1.0 # Extra Content Packs ## Datacenter - Launcher Pack Name: Datacenter 3D Models Pack - Included in Omniverse Apps: USD Composer - Pack: Datacenter_NVD@10011.zip - Pack Size: 187MB - Contents: Datacenter assets for creating digital twins - Default Nucleus Location: NVIDIA/Assets/DigitalTwin/Assets/Datacenter ## AECXR - Launcher Pack Name: AEC XR 3D Models Pack - Included in Omniverse Apps: USD Composer - Pack: ``` AEC_XR_NVD@10012.zip ``` - Pack Size: 13MB - Contents: Architectural AEC elements for XR testing - Default Nucleus Location: No default location on Nucleus - only available through download
context-menu_Overview.md	# Overview — Omniverse Kit 1.7.8 documentation ## Overview The layer widget extension provides a widget for viewing and interacting with the USD layers in the local layer stack. By default, the widget displays the current layer prim hierarchy, with one column, namely the prim name. ### Functionality #### Searching In the search field, users can type in filter text for prim paths to search for prims with matching keywords. #### Options Menu In the options menu, users can toggle on/off layer widget options, or reset them. #### Context Menu Right clicking in the stage widget will display the stage widget context menu. Context includes the current USD stage context, prim selection, hovered prim, etc. For more details on context menu items, please refer to `omni.kit.widget.layer.ContextMenu`. ### Insert/Create/Remove sublayer Click the “Insert Sublayer” button on the widget bottom or menu item from the context menu, it shows a layer dialog that allows users to pick a new sublayer path. For the new inserted sublayer, there are four new buttons that allow users to save/mute/lock the new layer.
contributing.md	# Contributing to the URDF Importer Extension ## Did you find a bug? - Check in the GitHub Issues if a report for your bug already exists. - If the bug has not been reported yet, open a new Issue. - Use a short and descriptive title which contains relevant keywords. - Write a clear description of the bug. - Document the environment including your operating system, compiler version, and hardware specifications. - Add code samples and executable test cases with instructions for reproducing the bug. ## Did you find an issue in the documentation? - Please create an Issue if you find a documentation issue. ## Did you write a bug fix? - Open a new Pull Request with your bug fix. - Write a description of the bug which is fixed by your patch or link to related Issues. - If your patch fixes for example Issue #33, write `Fixes #33`. - Explain your solution with a few words. ## Did you write a cosmetic patch? - Patches that are purely cosmetic will not be considered and associated Pull Requests will be closed. - Cosmetic are patches which do not improve stability, performance, functionality, etc. - Examples for cosmetic patches: code formatting, fixing whitespaces. ## Do you have a question? - Search the GitHub Discussions for your question. - If nobody asked your question before, feel free to open a new discussion. - Once somebody shares a satisfying answer to your question, click “Mark as answer”. - GitHub Issues should only be used for bug reports. - If you open an Issue with a question, we may convert it into a discussion.
contributing_index.md	# Kit C++ Extension Template ## Omniverse Kit C++ Extension Template This project contains everything necessary to develop extensions that contain C++ code, along with a number of examples demonstrating best practices for creating them. ### What Are Extensions? While an extension can consist of a single `extension.toml` file, most contain Python code, C++ code, or a mixture of both: ``` \| Kit \| ___________________________________\|____________________________________ \| \| \| \| \| Python Only \| C++ Only \| Mixed (eg. omni.example.python.hello_world) \| (eg. omni.example.cpp.hello_world) \| (eg. omni.example.cpp.pybind) ``` Extensive documentation detailing what extensions are and how they work can be found [here](https://docs.omniverse.nvidia.com/py/kit/docs/guide/extensions.html). ### Getting Started 1. Clone the [GitHub repo](https://github.com/NVIDIA-Omniverse/kit-extension-template-cpp) to your local machine. 2. Open a command prompt and navigate to the root of your cloned repo. 3. Run `build.bat` to bootstrap your dev environment and build the example extensions. 4. Run `_build\{platform}\release\omni.app.example.extension_browser.bat` to open an example kit application. - Run `omni.app.example.viewport.bat` instead if you want the renderer and main viewport to be enabled. - Run `omni.app.kit.dev.bat` instead if you want the full kit developer experience to be enabled. 5. From the menu, select `Window->Extensions` to open the extension browser window. ``` # Debugging C++ Extensions 1. Run `build.bat` (if you haven’t already) to generate the solution file. 2. Open `_compiler\vs2019\kit-extension-template-cpp.sln` using Visual Studio 2019. 3. Select `omni.app.example.extension_browser` as the startup project (if it isn’t already). - Select `omni.app.example.viewport` instead if you want the renderer and main viewport to be enabled. - Select `omni.app.kit.dev` instead if you want the full kit developer experience to be enabled. 4. Run/debug the example kit application, using the extension browser window to enable/disable extensions. # Creating New C++ Extensions 1. Copy one of the existing extension examples to a new folder within the `source/extensions` folder. - The name of the new folder will be the name of your new extension. - The omni prefix is reserved for NVIDIA applications and extensions. 2. Update the fields in your new extension’s `config/extension.toml` file as necessary. 3. Update your new extension’s `premake5.lua` file as necessary. 4. Update your new extension’s C++ code in the `plugins` folder as necessary. 5. Update your new extension’s Python code in the `python` folder as necessary. 6. Update your new extension’s Python bindings in the `bindings` folder as necessary. 7. Update your new extension’s documentation in the `docs` folder as necessary. 8. Run `build.bat` to build your new extension. 9. Refer to the Getting Started section above to open the example kit application and extension browser window. 10. Enter the name of your new extension in the search bar at the top of the extension browser window to view it. # Generating Documentation 1. Run `repo.bat docs` to generate the documentation for the repo, including all extensions it contains. - You can generate the documentation for a single extension by running `repo.bat docs -p {extension_name}` 2. Open `_build/docs/kit-extension-template-cpp/latest/index.html` to view the generated documentation. # Publishing Developers can publish publicly hosted extensions to the community extension registry using the following steps: 1. Tag the GitHub repository with the [omniverse-kit-extension](https://github.com/topics/omniverse-kit-extension) tag. 2. Create a [GitHub release](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository). 3. Upload the packaged extension archives, created with `./repo.bat package` on Windows or `./repo.sh package` on other platforms. # Publishing Extensions To publish an extension, you must package it and upload it to a GitHub release. This section describes the process of packaging an extension and the naming convention for the packaged extension archive. ## Packaging Package your extension on Linux, to the GitHub release. You must rename the packaged extension archive to match the following convention: - Linux: ``` {github-namespace}-{github-repository}-linux-x86_64-{github-release-tag}.zip ``` - Windows: ``` {github-namespace}-{github-repository}-windows-x86_64-{github-release-tag}.zip ``` For example, the v0.0.2 release of the extension has archives named `jshrake-nvidia-kit-community-release-test-linux-x86_64-v0.0.2.zip` and `jshrake-nvidia-kit-community-release-test-windows-x86_64-v0.0.2.zip` for Linux and Windows, respectively. Our publishing pipeline runs nightly and discovers any publicly hosted GitHub repository with the `omniverse-kit-extension` tag. The published extensions should be visible in the community registry the day following the creation of a GitHub release. Refer to the kit extension documentation for how to specify the Kit version compatibility for your extension. This ensures that the correct version of your extension is listed in any given Kit application. # Contributing The source code for this repository is provided as-is and we are not accepting outside contributions. # Example Extensions - omni.example.cpp.actions - omni.example.cpp.commands - omni.example.cpp.hello_world - omni.example.cpp.omnigraph_node - omni.example.cpp.pybind - omni.example.cpp.ui_widget - omni.example.cpp.usd - omni.example.cpp.usd_physics - omni.example.cpp.usdrt - omni.example.python.hello_world - omni.example.python.ui - omni.example.python.usdrt
Controller.md	# Controller Class The primary interface you can use for interacting with OmniGraph is the `omni.graph.core.Controller`. It is accessible through the main module like this: ```python import omni.graph.core as og keys = og.Controller.Keys # Usually handy to keep this name short as it is used often controller = og.Controller() ``` Note For the examples below, the above initialization code will be assumed to be present. ## Structure The `omni.graph.core.Controller` class is an amalgam of several other classes with specific subsets of functionality. It derives from each of them, so that all of their functionality can be accessed through a single class. - `omni.graph.core.GraphController` handles operations that affect the structure of the graph - `omni.graph.core.NodeController` handles operations that affect individual nodes - `omni.graph.core.ObjectLookup` provides a generic set of interfaces for finding OmniGraph objects with a flexible set of inputs - `omni.graph.core.DataView` lets you get and set attribute values For the most part the controller functions can be accessed as either static class methods or as regular object methods: ```python await og.Controller.evaluate() await controller.evaluate() ``` The main difference between the two is that the object-based calls can maintain state information to simplify the arguments to future calls. Each of the base classes have their own constructor parameters. The ones accepted by the main controller constructor are as follows: ``` ``` """Set up state information. You only need to create an instance of the Controller if you are going to use the edit() function more than once, when it needs to remember the node mapping used for creation. Args are passed on to the parent classes who have inits and interpreted by them as they see fit. Args: graph_id: If specified then operations are performed on this graph_id unless it is overridden in a particular function call. See GraphController.create_graph() for the data types accepted for the graph description. path_to_object_map: Dictionary of relative paths mapped on to their full path after creation so that the edit_commands can use either full paths or short-forms to specify the nodes. update_usd: If specified then override whether to update the USD after the operations (default False) undoable: If True the operation is added to the undo queue, else it is done immediately and forgotten (default True) allow_exists_attr: If True then attribute creation operation won't fail when the attribute already exists on the node it was being added to (default False) allow_exists_node: If True then node creation operation won't fail when the node already exists in the scene graph (default False) allow_exists_prim: If True then prim creation operation won't fail when the prim already exists in the scene graph (default False) Check the help information for GraphController.__init__(), NodeController.__init__(), DataView.__init__(), and ObjectLookup.__init__() for details on what other constructor arguments are accepted. """ ``` ## Controller Functions In addition to the functions inherited from the other classes the `Controller` has some of its own functions. ### evaluate()/evaluate_sync() These are sync and async versions of a function to evaluate a graph or list of graphs. ```python # This version evaluates all graphs asynchronously await og.Controller.evaluate() # This version evaluates the graph defined by the controller object synchronously controller.evaluate_sync() # This version evaluates the single named graph synchronously og.Controller.evaluate_sync(graph) ``` ### edit() The workhorse of the controller class is the `edit()` method. It provides simple access to a lot of the underlying functionality for manipulating the contents of OmniGraph. One of the most typical operations you will perform in a script is to create a predefined graph and populate it with connections and values. Here is a comprehensive example that illustrates how to use all of the features in an edit call: ```python # Keywords are shown for the edit arguments, however they are not required (graph, nodes, prims, name_to_object_map) = og.Controller.edit( # First parameter is a graph reference, created if it doesn't already exist. # See omni.graph.core.GraphController.create_graph() for more options graph_id="/World/MyGraph", # Second parameter is a dictionary edit_commands={ # Delete a node or list of nodes that already existed in the graph # See omni.graph.core.GraphController.delete_nodes() for more options keys.DELETE_NODES: ["MyNode"], # Create new nodes in the graph - the resulting og.Nodes are returned in the "nodes" part of the tuple # See omni.graph.core.GraphController.create_node() for more options keys.CREATE_NODES: [ ("src", "omni.graph.tutorials.SimpleData"), ("dst", "omni.graph.tutorials.SimpleData"), # Create a new compound node in the graph. Note that the nodes created in the compound are not # returned in the "nodes" part of the tuple, but are inserted into name_to_object_map. ("compound", { keys.CREATE_NODES: [("subNode", "omni.graph.tutorials.SimpleData")], # Expose the compound node's subNode ports as part of the compound node # by specifying the attribute to promote and the name of the attribute on the # compound node keys.PROMOTE_ATTRIBUTES: [("subNode.inputs:a_float", "inputs:attr0")], }), ], # Create new (dynamic) attributes on some nodes. # See omni.graph.core.NodeController.create_attribute() for more options keys.CREATE_ATTRIBUTES: [ ("src.inputs:dyn_float", "float"), ("dst.inputs:dyn_any", "any"), ], # Create new prims in the stage - the resulting Usd.Prims are returned in the "prims" part of the tuple # See omni.graph.core.GraphController.create_prims() for more options keys.CREATE_PRIMS: [ ], }, ) ```python (("Prim1", {"attrFloat": ("float", 2.0)}), ("Prim2", {"attrBool": ("bool", True)}), ), # Expose one of the prims to OmniGraph by creating a USD import node to read it as a bundle. # The resulting node is in the "nodes" part of the tuple, after any native OmniGraph node types. # See omni.graph.core.GraphController.expose_prims() for more options keys.EXPOSE_PRIMS: [(og.Controller.PrimExposureType.AS_BUNDLE, "Prim1", "Prim1Exposed")], # Connect a source output to a destination input to create a flow of data between the two nodes # See omni.graph.core.GraphController.connect() for more options keys.CONNECT: [("src.outputs:a_int", "dst.inputs:a_int")], # Disconnect an already existing connection. # See omni.graph.core.GraphController.disconnect() for more options keys.DISCONNECT: [ ("/World/MyGraph/MyClassNode.outputs:a_bool", "/World/MyGraph/KnownNode.inputs:a_bool") ], # Define an attribute's value (inputs and state attributes only - outputs are computed) # See omni.graph.core.DataView.set() for more options keys.SET_VALUES: [("src.inputs:a_int", 5)], # Create graph-local variable values # See omni.graph.core.GraphController.create_variables() for more options keys.CREATE_VARIABLES: [("a_float_var", og.Type(og.BaseDataType.FLOAT)), ("a_bool_var", "bool")], }, # Parameters from here down could also be saved as part of the object and reused repeatedly if you had # created a controller rather than calling edit() as a class method path_to_object_map=None, # Saved object-to-path map, bootstraps any created as part of the call update_usd=True, # Immediately echo the changes to the underlying USD undoable=True, # If False then do not remember previous state - useful for writing tests allow_exists_node=False, # If True then silently succeed requests to create already existing nodes allow_exists_prim=False, # If True then silently succeed requests to create already existing prims ) ``` See the method documentation for more details on what types of arguments can be accepted for each of the parameters. ## ObjectLookup This class contains the functions you will probably use the most. It provides an extremely flexible method for looking up OmniGraph objects from the information you have on hand. The specs it accepts as arguments can be seen in the class documentation. The subsection titles link to the actual method documentation, while the content consists of a simple example of how to use that method in a typical script. Each subsection assumes a graph set up through the following initialization code: ```python import omni.graph.core as og import omni.usd from pxr import OmniGraphSchema, Sdf keys = og.Controller.Keys # Note that when you extract the parameters this way it is important to have the trailing "," in the node # and prim tuples so that Python doesn't try to interpret them as single objects. (graph, (node,), (prim,), _) = og.Controller.edit( "/World/MyGraph", { keys.CREATE_NODES: ("MyNode", "omni.graph.test.TestAllDataTypes"), keys.CREATE_PRIMS: ("MyPrim", {"myFloat": ("float", 0)}), keys.CREATE_VARIABLES: ("MyVariable", "float"), }, ) assert prim.IsValid() attribute = node.get_attribute("inputs:a_bool") ``` ```python relationship_attribute = node.get_attribute("inputs:a_target") attribute_type = attribute.get_resolved_type() node_type = node.get_node_type() variable = graph.get_variables()[0] stage = omni.usd.get_context().get_stage() ``` ## Graph ```python # Look up the graph directly from itself (to simplify code) assert graph == og.Controller.graph(graph) # Look up the graph by path assert graph == og.Controller.graph("/World/MyGraph") # Look up the graph by Usd Prim graph_prim = stage.GetPrimAtPath("/World/MyGraph") assert graph == og.Controller.graph(graph_prim) # Look up by a Usd Schema object graph_schema = OmniGraphSchema.OmniGraph(graph_prim) assert graph == og.Controller.graph(graph_schema) # Look up the graph by SdfPath path = Sdf.Path("/World/MyGraph") assert graph == og.Controller.graph(path) # Look up a list of graphs by passing a list of any of the above for new_graph in og.Controller.graph([graph, "/World/MyGraph", path]): assert graph == new_graph ``` ## Node ```python # Look up the node directly from itself (to simplify code) assert node == og.Controller.node(node) # Look up the node by path assert node == og.Controller.node("/World/MyGraph/MyNode") # Look up the node by partial path and graph. # The graph parameter can be any of the ones supported by og.Controller.graph() assert node == og.Controller.node(("MyNode", graph)) # Look up the node by SdfPath node_path = Sdf.Path("/World/MyGraph/MyNode") assert node == og.Controller.node(node_path) # Look up the node from its underlying USD prim backing, if it exists node_prim = stage.GetPrimAtPath("/World/MyGraph/MyNode") assert node == og.Controller.node(node_prim) # Look up a list of nodes by passing a list of any of the above for new_node in og.Controller.node([node, "/World/MyGraph/MyNode", ("MyNode", graph), node_path, node_prim]): assert node == new_node ``` ## attribute `attribute()` Finds an `og.Attribute` object. ```python # Look up the attribute directly from itself (to simplify code) assert attribute == og.Controller.attribute(attribute) # Look up the attribute by path assert attribute == og.Controller.attribute("/World/MyGraph/MyNode.inputs:a_bool") # Look up the attribute by SdfPath assert attribute == og.Controller.attribute(Sdf.Path("/World/MyGraph/MyNode.inputs:a_bool")) # Look up the attribute by name and node assert attribute == og.Controller.attribute(("inputs:a_bool", node)) # These can chain, so you can also look up the attribute by name and node, where node is further looked up by # relative path and graph assert attribute == og.Controller.attribute(("inputs:a_bool", ("MyNode", graph))) # Look up the attribute by SdfPath attr_path = Sdf.Path("/World/MyGraph/MyNode.inputs:a_bool") assert attribute == og.Controller.attribute(attr_path) # Look up the attribute through its Usd counterpart stage = omni.usd.get_context().get_stage() node_prim = stage.GetPrimAtPath("/World/MyGraph/MyNode") usd_attribute = node_prim.GetAttribute("inputs:a_bool") assert attribute == og.Controller.attribute(usd_attribute) # Look up a list of attributes by passing a list of any of the above for new_attribute in og.Controller.attribute( [ attribute, "/World/MyGraph/MyNode.inputs:a_bool", Sdf.Path("/World/MyGraph/MyNode.inputs:a_bool"), ("inputs:a_bool", node), ("inputs:a_bool", ("MyNode", graph)), attr_path, usd_attribute, ] ): assert attribute == new_attribute ``` ## attribute-type `attribute_type()` Finds an `og.Type` object. ```python attribute_type = og.Type(og.BaseDataType.FLOAT, tuple_count=3, array_depth=1, role=og.AttributeRole.POSITION) # Look up the attribute type by OGN type name assert attribute_type == og.Controller.attribute_type("pointf[3][]") # Look up the attribute type by SDF type name assert attribute_type == og.Controller.attribute_type("point3f[]") # Look up the attribute type directly from itself (to simplify code) assert attribute_type == og.Controller.attribute_type(attribute_type) ``` # Look up the attribute type from the attribute with that type point_attribute = og.Controller.attribute(("inputs:a_pointf_3_array", node)) assert attribute_type == og.Controller.attribute_type(point_attribute) # Look up the attribute type from the attribute data whose attribute has that type (most commonly done with # attributes that have extended types or attributes belonging to bundles) point_attribute_data = point_attribute.get_attribute_data() assert attribute_type == og.Controller.attribute_type(point_attribute_data) ``` ```markdown ## node_type node_type = node.get_node_type() # Look up the node type directly from itself (to simplify code) assert node_type == og.Controller.node_type(node_type) # Look up the node type from the string that uniquely identifies it assert node_type == og.Controller.node_type("omni.graph.test.TestAllDataTypes") # Look up the node type from the node with that type assert node_type == og.Controller.node_type(node) # Look up the node type from the USD Prim backing a node of that type assert node_type == og.Controller.node_type(node_prim) # Look up a list of node types by passing a list of any of the above for new_node_type in og.Controller.node_type( [ node_type, "omni.graph.test.TestAllDataTypes", node, node_prim, ] ): assert node_type == new_node_type ``` ```markdown ## prim # Look up the prim directly from itself (to simplify code) assert node_prim == og.Controller.prim(node_prim) # Look up the prim from the prim path as a string assert node_prim == og.Controller.prim("/World/MyGraph/MyNode") # Look up the prim from the Sdf.Path pointing to the prim assert node_prim == og.Controller.prim(node_path) # Look up the prim from the OmniGraph node for which it is the backing assert node_prim == og.Controller.prim(node) # Look up the prim from the (node_path, graph) tuple defining the OmniGraph node for which it is the backing assert node_prim == og.Controller.prim(("MyNode", graph)) # Look up the prim from an OmniGraph graph assert graph_prim == og.Controller.prim(graph) # Look up a list of prims by passing a list of any of the above for new_prim in og.Controller.prim( [ node_prim, "/World/MyGraph/MyNode", node_path, node, ("MyNode", graph), ] ): assert node_prim == new_prim ``` ## usd-attribute Finds a Usd.Attribute object ```python # USD attributes can be looked up with the same parameters as for looking up an OmniGraph attribute # Look up the USD attribute directly from itself (to simplify code) assert usd_attribute == og.Controller.usd_attribute(usd_attribute) # Look up the USD attribute by path assert usd_attribute == og.Controller.usd_attribute("/World/MyGraph/MyNode.inputs:a_bool") # Look up the USD attribute by name and node assert usd_attribute == og.Controller.usd_attribute(("inputs:a_bool", node)) # These can chain, so you can also look up the USD attribute by name and node, where node is further looked up by # relative path and graph assert usd_attribute == og.Controller.usd_attribute(("inputs:a_bool", ("MyNode", graph))) # Look up the USD attribute by SdfPath attr_path = Sdf.Path("/World/MyGraph/MyNode.inputs:a_bool") assert usd_attribute == og.Controller.usd_attribute(attr_path) # Look up the USD attribute through its OmniGraph counterpart assert usd_attribute == og.Controller.usd_attribute(attribute) # Look up a list of attributes by passing a list of any of the above for new_usd_attribute in og.Controller.usd_attribute( [ usd_attribute, "/World/MyGraph/MyNode.inputs:a_bool", ("inputs:a_bool", node), ("inputs:a_bool", ("MyNode", graph)), attr_path, attribute, ] ): assert usd_attribute == new_usd_attribute ``` ## variable Finds an `og.IVariable` object ```python # Look up the variable directly from itself (to simplify code) assert variable == og.Controller.variable(variable) # Look up the variable from a tuple with the variable name and the graph to which it belongs assert variable == og.Controller.variable((graph, "MyVariable")) # Look up the variable from a path string pointing directly to it assert variable == og.Controller.variable(variable.source_path) # Look up the variable from an Sdf.Path pointing directly to it variable_path = Sdf.Path(variable.source_path) assert variable == og.Controller.variable(variable_path) # Look up a list of variables by passing a list of any of the above for new_variable in og.Controller.variable( [ variable, (graph, "MyVariable"), variable.source_path, variable_path, ] ): assert variable == new_variable ``` ## Utilities In addition to type lookups there are a few methods that provide utility functions related to these lookups. - `attribute_path()` - `node_path()` - `node_path()` - `prim_path()` - `split_graph_from_node_path()` ```python # Look up the path to an attribute given any of the types an attribute lookup recognizes for attribute_spec in [ attribute, "/World/MyGraph/MyNode.inputs:a_bool", ("inputs:a_bool", node), ("inputs:a_bool", ("MyNode", graph)), attr_path, usd_attribute, ]: assert attribute.get_path() == og.Controller.attribute_path(attribute_spec) # Look up the path to a node given any of the types a node lookup recognizes for node_spec in [node, "/World/MyGraph/MyNode", ("MyNode", graph), node_path, node_prim]: assert node.get_prim_path() == og.Controller.node_path(node_spec) # Look up the path to a prim given any of the types a prim lookup recognizes for prim_spec in [node_prim, "/World/MyGraph/MyNode", node_path, node, ("MyNode", graph)]: assert node_prim.GetPrimPath() == og.Controller.prim_path(prim_spec) # Look up the path to a prim given any of the types a graph lookup recognizes graph_path = graph.get_path_to_graph() for graph_spec in [graph, graph_path, Sdf.Path(graph_path)]: assert graph_path == og.Controller.prim_path(graph_spec) # Look up a list of paths to prims given a list of any of the types a prim lookup recognizes for new_path in og.Controller.prim_path( [node_prim, "/World/MyGraph/MyNode", node_path, node, ("MyNode", graph)] ): assert node_prim.GetPrimPath() == new_path # Separate the graph name from the node name in a full path to a node assert (graph, "MyNode") == og.Controller.split_graph_from_node_path("/World/MyGraph/MyNode") # Separate the graph name from the node name in an Sdf.Path to a node assert (graph, "MyNode") == og.Controller.split_graph_from_node_path(node_path) ``` ## GraphController This class contains the functions that manipulate the structure of the graph, including creating a graph. The class documentation describe the details of what it can do. The subsection titles link to the actual method documentation, while the content consists of a simple example of how to use that method in a typical script. Each subsection assumes a set up through the following initialization code: ```python import omni.graph.core as og import omni.kit from pxr import Sdf node_type_name = "omni.graph.test.TestAllDataTypes" node_type = og.Controller.node_type(node_type_name) ``` ### __init__() A few parameters can be shared among multiple calls to the controller if it is instantiated as an object rather than calling the functions as class methods. ```python # Explanation of the non-default values in the constructor controller = og.GraphController( update_usd=False, # Only update Fabric when paths are added are removed, do not propagate to USD undoable=False, # Do not save information on changes for later undo (most applicable to testing) # If a node specification in og.GraphController.create_node() exists then silently succeed instead of # raising an exception allow_exists_node=True, # If a prim specification in og.GraphController.create_prim() exists then silently succeed instead of # raising an exception allow_exists_prim=True, ) assert controller is not None # The default values are what is assumed when class methods are called. Where they apply to any of the # functions they can also be passed to the class method functions to specify non-default values. ``` ### create_graph() Creates a new `og.Graph`, similar to the first parameter to the `og.Controller.edit()` function. ```python # Simple method of creating a graph just passes the desire prim path to it. This creates a graph using all # of the default parameters. graph = og.GraphController.create_graph("/World/MyGraph") assert graph.is_valid() # If you want to customize the type of graph then instead of passing just a path you can pass a dictionary # graph configuration values. See the developer documentation of omni.graph.core.GraphController.create_graph # for details on what each parameter means action_graph = og.GraphController.create_graph( { "graph_path": "/World/MyActionGraph", "node_name": "MyActionGraph", "evaluator_name": "execution", "is_global_graph": True, "backed_by_usd": True, "fc_backing_type": og.GraphBackingType.GRAPH_BACKING_TYPE_FABRIC_SHARED, "pipeline_stage": og.GraphPipelineStage.GRAPH_PIPELINE_STAGE_SIMULATION, "evaluation_mode": og.GraphEvaluationMode.GRAPH_EVALUATION_MODE_AUTOMATIC, } ) # Also accepts the "update_usd" and "undoable" shared construction parameters ``` ### create_node() Creates a new `og.Node`. This performs the same function and takes the same parameters as the `og.Controller.edit()` keyword `og.Controller.Keys.CREATE_NODES`. ```python # Creates a new node in an existing graph. # The two mandatory parameters are node path and node type. The node path can be any of the types recognized # by the omni.graph.core.ObjectLookup.node_path() method and the node type can be any of the types recognized # by the omni.graph.core.ObjectLookup.node_type() method. node_by_path = og.GraphController.create_node( node_id="/World/MyGraph/MyNode", node_type_id=node_type_name, ) assert node_by_path.is_valid() node_by_name = og.GraphController.create_node( ``` node_id=("MyNodeByName", graph), node_type_id=node_type, ) assert node_by_name.is_valid() node_by_sdf_path = Sdf.Path("/World/MyGraph/MyNodeBySdf") node_by_sdf = og.GraphController.create_node(node_id=node_by_sdf_path, node_type_id=node_by_name) assert node_by_sdf.is_valid() # Also accepts the "update_usd", "undoable", and "allow_exists_node" shared construction parameters ## create_prim Creates a new Usd.Prim. This performs the same function and takes the same parameters as the `og.Controller.edit()` keyword `og.Controller.Keys.CREATE_PRIMS`. ```python # Creates a new prim on the USD stage # You can just specify the prim path to get a default prim type with no attributes. The prim_path argument # can accept any value accepted by omni.graph.core.ObjectLookup.prim_path prim_empty = og.GraphController.create_prim(prim_path="/World/MyEmptyPrim") assert prim_empty.IsValid() # You can add a prim type if you want the prim to be a specific type, including schema types prim_cube = og.GraphController.create_prim(prim_path=Sdf.Path("/World/MyCube"), prim_type="Cube") assert prim_cube.IsValid() # You can also populate the prim with some attributes and values using the attribute_values parameter, which # accepts a dictionary of Name:(Type,Value). An attribute named "Name" will be created with type "Type" # (specified in either USD or SDF type format), and initial value "Value" (specified in any format compatible # with the Usd.Attribute.Set() function). The names do not have to conform to the usual OGN standards of # starting with one of the "inputs", "outputs", or "state" namespaces, though they can. The "Type" value is # restricted to the USD-native types, so things like "any", "bundle", and "execution" are not allowed. prim_with_values = og.GraphController.create_prim( prim_path="/World/MyValuedPrim", attribute_values={ "someFloat": ("float", 3.0), "inputs:float3": ("float3", [1.0, 2.0, 3.0]), "someFloat3": ("float[3]", [4.0, 5.0, 6.0]), "someColor": ("color3d", [0.5, 0.6, 0.2]), }, ) assert prim_with_values.IsValid() # Also accepts the "undoable" and "allow_exists_prim" shared construction parameters ``` ## create_variable Creates a new `og.IVariable`. This performs the same function and takes the same parameters as the `og.Controller.edit()` keyword `og.Controller.Keys.CREATE_VARIABLES`. ```python # To construct a variable the graph must be specified, along with the name and type of variable. # The variable type can only be an omni.graph.core.Type or a string representing one of those types. float_variable = og.GraphController.create_variable(graph_id=graph, name="FloatVar", var_type="float") assert float_variable.valid ``` color3_type = og.Type(og.BaseDataType.FLOAT, 3, role=og.AttributeRole.COLOR) color3_variable = og.GraphController.create_variable(graph_id=graph, name="Color3Var", var_type=color3_type) assert color3_variable.valid # Also accepts the "undoable" shared construction parameter ## delete_node Deletes an existing `og.Node`. This performs the same function and takes the same parameters as the `og.Controller.edit()` keyword `og.Controller.Keys.DELETE_NODES`. ```python # To delete a node you can pass in a node_id, as accepted by omni.graph.core.ObjectLookup.node, or a node # name and a graph_id as accepted by omni.graph.core.ObjectLookup.graph. og.GraphController.delete_node(node_by_sdf) # The undo flag was the global default so this operation is undoable omni.kit.undo.undo() # HOWEVER, you must get the node reference back as it may have been altered by the undo node_by_sdf = og.Controller.node(node_by_sdf_path) # Try it a different way og.GraphController.delete_node(node_id="MyNodeBySdf", graph_id=graph) # If you do not know if the node exists or not you can choose to ignore that case and silently succeed og.GraphController.delete_node(node_id=node_by_sdf_path, ignore_if_missing=True) # Also accepts the "update_usd" and "undoable" shared construction parameters ``` ## expose_prim Makes a Usd.Prim visible to OmniGraph through a read node. This performs the same function and takes the same parameters as the `og.Controller.edit()` keyword `og.Controller.Keys.EXPOSE_PRIMS`. ```python # USD prims cannot be directly visible in OmniGraph so instead you must expose them through an import or # export node. See the documentation of the function for details on the different ways you can expose a prim # to OmniGraph. # A prim is exposed as a new OmniGraph node of a given type where the exposure process creates the node and # the necessary links to the underlying prim. The OmniGraph node can then be used as any others might. # The prim_id can accept any type accepted by omni.graph.core.ObjectLookup.prim() and the node_path_id can # accept any type accepted by omni.graph.core.ObjectLookup.node_path() exposed_empty = og.GraphController.expose_prim( exposure_type=og.GraphController.PrimExposureType.AS_BUNDLE, prim_id="/World/MyEmptyPrim", node_path_id="/World/MyActionGraph/MyEmptyNode", ) assert exposed_empty is not None exposed_cube = og.GraphController.expose_prim( exposure_type=og.GraphController.PrimExposureType.AS_ATTRIBUTES, prim_id=prim_cube, node_path_id=("MyCubeNode", action_graph), ) assert exposed_cube is not None # Also accepts the "update_usd" and "undoable" shared construction parameters ``` ## connect ### connect() Connects two `og.Attributes` together. This performs the same function and takes the same parameters as the `og.Controller.edit()` keyword `og.Controller.Keys.CONNECT`. ```python # Once you have more than one node in a graph you will want to connect them so that the results of one node's # computation can be passed on to another for further computation - the true power of OmniGraph. The connection # sends data from the attribute in "src_spec" and sends it to the attribute in "dst_spec". Both of those # parameters can accept anything accepted by omni.graph.core.ObjectLookup.attribute og.GraphController.connect( src_spec=("outputs:a_bool", ("MyNode", graph)), dst_spec="/World/MyGraph/MyNodeByName/outputs:a_bool", ) # Also accepts the "update_usd" and "undoable" shared construction parameters ``` ## disconnect ### disconnect() Breaks an existing connection between two `og.Attributes`. This performs the same function and takes the same parameters as the `og.Controller.edit()` keyword `og.Controller.Keys.DISCONNECT`. ```python # As part of wiring the nodes together you may also want to break connections, either to make a new connection # elsewhere or just to leave the attributes unconnected. The disconnect method is a mirror of the connect # method, taking the same parameters and breaking any existing connection between them. It is any error to try # to disconnect two unconnected attributes. og.GraphController.disconnect( src_spec=("outputs:a_bool", ("MyNode", graph)), dst_spec="/World/MyGraph/MyNodeByName/outputs:a_bool", ) omni.kit.undo.undo() # Also accepts the "update_usd" and "undoable" shared construction parameters ``` ## disconnect-all ### disconnect_all() Disconnects everything from an existing `og.Attribute`. ```python # Sometimes you don't know or don't care what an attribute is connected to, you just want to remove all of its # connections, both coming to and going from it. The single attribute_spec parameter tells which attribute is to # be disconnected, accepting any value accepted by omni.graph.ObjectLookup.attribute og.GraphController.disconnect_all(attribute_spec=("outputs:a_bool", ("MyNode", graph))) # As this just disconnects "all" if an attribute is not connected to anything it will silently succeed og.GraphController.disconnect_all(attribute_spec=("outputs:a_bool", ("MyNode", graph))) # Also accepts the "update_usd" and "undoable" shared construction parameters ``` ## set-variable-default-value ### set_variable_default_value() ``` ## set_variable_default_value Sets the default value of an `og.IVariable`. ```python # After creation a graph variable will have zeroes as its default value. You may want to set some other default # so that when the graph is instantiated a second time the defaults are non-zero. The variable_id parameter # accepts anything accepted by omni.graph.core.ObjectLookup.variable() and the value must be a data type # compatible with the type of the (already existing) variable # For example you might have a color variable that you wish to initialize in all subsequent graphs to red og.GraphController.set_variable_default_value(variable_id=(graph, "Color3Var"), value=(1.0, 0.0, 0.0)) ``` ## get_variable_default_value Gets the default value of an `og.IVariable`. ```python # If you are using variables to configure your graphs you probably want to know what the default values are, # especially if someone else created them. You can read the default for a given variable, where the variable_id # parameter accepts anything accepted by omni.graph.core.ObjectLookup.variable(). color_default = og.GraphController.get_variable_default_value(variable_id=color3_variable) assert color_default == (1.0, 0.0, 0.0) ``` ## NodeController This class contains the functions that manipulate the contents of a node. It only has a few functions. The class documentation outlines its areas of control. The subsection titles link to the actual method documentation, while the content consists of a simple example of how to use that method in a typical script. Each subsection assumes a graph set up through the following initialization code: ```python import omni.graph.core as og keys = og.Controller.Keys (_, (node,), _, _) = og.Controller.edit( "/World/MyGraph", { keys.CREATE_NODES: ("MyNode", "omni.graph.test.TestAllDataTypes"), }, ) assert node.is_valid() ``` ### __init__() A few parameters can be shared among multiple calls to the controller if it is instantiated as an object rather than calling the functions as class methods. ```python # The NodeController constructor only recognizes one parameter controller = og.NodeController( update_usd=False, # Only update Fabric when attributes are added or removed, do not propagate to USD ) assert controller is not None ``` ### create_attribute Creates a new dynamic `og.Attribute`. This performs the same function and takes the same parameters as the `og.Controller.edit()` keyword `og.Controller.Keys.CREATE_ATTRIBUTES`. ```markdown # description of the attribute. The mandatory pieces are "node" on which it is to be created, accepting # anything accepted by omni.graph.core.ObjectLookup.node, the name of the attribute not including the port # namespace (i.e. without the "inputs:", "outputs:", or "state:" prefix, though you can leave it on if you # prefer), the type "attr_type" of the attribute, accepting anything accepted by # omni.graph.core.ObjectLookup.attribute_type. # The default here is to create an input attribute of type float float_attr = og.NodeController.create_attribute(node, "theFloat", "float") assert float_attr.is_valid() # Using the namespace is okay, but redundant double_attr = og.NodeController.create_attribute("/World/MyGraph/MyNode", "inputs:theDouble", "double") assert double_attr.is_valid() # Unless you want a non-default port type, in which case it will be extracted from the name int_attr = og.NodeController.create_attribute(node, "outputs:theInt", og.Type(og.BaseDataType.INT)) assert int_attr.is_valid() # ...or you can just specify the port explicitly and omit the namespace int2_attr = og.NodeController.create_attribute( node, "theInt2", "int2", attr_port=og.AttributePortType.ATTRIBUTE_PORT_TYPE_OUTPUT ) assert int2_attr.is_valid() # The default will set an initial value on your attribute, though it is not remembered in the future float_1_attr = og.NodeController.create_attribute(node, "the1Float", "float", attr_default=1.0) assert float_1_attr.is_valid() # Mismatching between an explicit namespace and a port type will result in a duplicated namespace so be careful error_attr = og.NodeController.create_attribute(node, "outputs:theError", "float") assert error_attr.get_path() == "/World/MyGraph/MyNode.inputs:outputs:theError" assert error_attr.is_valid() # Lastly the special "extended" types of attributes (any or union) can be explicitly specified through # the "attr_extended_type" parameter. When this is anything other than the default then the "attr_type" # parameter will be ignored in favor of the extended type definition, however it must still be a legal type. # This simplest type of extended attribute is "any", whose value can be any legal type. union_attr = og.NodeController.create_attribute( node, "theAny", attr_type="float", attr_extended_type=og.ExtendedAttributeType.EXTENDED_ATTR_TYPE_ANY ) assert union_attr.is_valid() # Note that with any extended type the "default" is invalid and will be ignored any_other_attr = og.NodeController.create_attribute( node, "theOtherAny", "token", default=5, attr_extended_type=og.ExtendedAttributeType.EXTENDED_ATTR_TYPE_ANY ) assert any_other_attr.is_valid() # If you want a more restricted set of types you can instead use the extended union type. When specifying # that type it will be a 2-tuple where the second value is a list of types accepted by the union. For example # this attribute will accept either doubles or floats as value types. (See the documentation on extended # attribute types for more information on how types are resolved.) union_attr = og.NodeController.create_attribute( node, "theUnion", "token", attr_extended_type=(og.ExtendedAttributeType.EXTENDED_ATTR_TYPE_UNION, ["double", "float"]), ) assert union_attr.is_valid() # Also accepts the "undoable" shared construction parameter ## remove_attribute() Removes an existing dynamic `og.Attribute` from a node. ```python # Dynamic attributes are a powerful method of reconfiguring a node at runtime, and as such you will also want # to remove them. The "attribute" parameter accepts anything accepted by # omni.graph.core.ObjectLookup.attribute(). (The "node" parameter, while still functional, is only there for # historical reasons and can be ignored.) og.NodeController.remove_attribute(error_attr) og.NodeController.remove_attribute(("inputs:theUnion", node)) # Also accepts the "undoable" shared construction parameter ``` ## safe_node_name() Returns a node name based on an `og.NodeType` that is USD-safe. i.e. it replaces any characters that are not accepted by USD as part of a node name, such as a period or vertical bar. ```python # This is a utility you can use to ensure a node name is safe for use in the USD backing prim. Normally # OmniGraph will take care of this for you but if you wish to dynamically create nodes using USD names you can # use this to confirm that your name is safe for use as a prim. assert og.NodeController.safe_node_name("omni.graph.node.name") == "omni_graph_node_name" # There is also an option to use a shortened name rather than replacing dots with underscores assert og.NodeController.safe_node_name("omni.graph.node.name", abbreviated=True) == "name" ``` ## DataView This class contains the functions to get and set attribute values. It has a flexible init function that can optionally take an “attribute” parameter to specify either an `og.Attribute` or `og.AttributeData` to which the data operations will apply. The class documentation shows the available functionality. The subsection titles link to the actual method documentation, while the content consists of a simple example of how to use that method in a typical script. Each subsection assumes a graph set up through the following initialization code: ```python import omni.graph.core as og keys = og.Controller.Keys (_, (node, any_node,), _, _) = og.Controller.edit( "/World/MyGraph", { keys.CREATE_NODES: [ ("MyNode", "omni.graph.test.TestAllDataTypes"), ("MyAnyNode", "omni.graph.tutorials.ExtendedTypes"), ], keys.SET_VALUES: [ ("MyNode.inputs:a_int", 3), ], }, ) int_attr = og.Controller.attribute("inputs:a_int", node) union_attr = og.Controller.attribute("inputs:floatOrToken", any_node) float_array_attr = og.Controller.attribute("outputs:a_float_array", node) double_array_attr = og.Controller.attribute("outputs:a_double_array", node) ``` ## __init__() A few parameters can be shared among multiple calls to the controller if it is instantiated as an object rather than calling the functions as class methods. ```python # The DataView constructor can take a number of parameters, mostly useful if you intend to make repeated # calls with the same configuration. # The most common parameter is the attribute on which you will operate. The parameter accepts anything # accepted by omni.graph.core.ObjectLookup.attribute() per_attr_view = og.DataView(attribute=int_attr) assert per_attr_view # Subsequent calls to per_attr_view functions will always apply to "int_attr" # You can also force USD and undo configurations, as per other classes like omni.graph.core.NodeController do_now = og.DataView(update_usd=False, undoable=False) assert do_now is not None # To keep memory operations on a single device you can configure the DataView to always use the GPU gpu_view = og.DataView(on_gpu=True, gpu_ptr_kind=og.PtrToPtrKind.CPU) # You can retrieve the GPU pointer kind (i.e. where the memory pointing to GPU arrays lives) assert gpu_view.gpu_ptr_kind == og.PtrToPtrKind.CPU # And if you are working with an instanced graph you can isolate the DataView to a single instance. Also # handy for looping through different instances. instance_view = og.DataView(instance=1) assert instance_view is not None ``` ## get() Fetches the current value of an attribute. ```python # Reading the value of an attribute is the most common operation you'll want to use. assert og.DataView.get(attribute=int_attr) == 3 # If you've already configured the attribute you don't need to specify it, and you can reuse it assert per_attr_view.get() == 3 assert per_attr_view.get() == 3 # As a special case, when you have array attributes that you want to write on you can specify an array size # when you get the reference with the "reserved_element_count" parameter array_to_write = og.DataView.get(attribute=float_array_attr) assert len(array_to_write) == 2 array_to_write = og.DataView.get(attribute=float_array_attr, reserved_element_count=5) assert len(array_to_write) == 5 # Only valid on GPU array attributes is the "return_type" argument. Normally array values are returned in # numpy wrappers, however you can get the data as raw pointers as well if you want to handle processing of # the data yourself or cast it to some other library type. This also illustrates how you can use the # pre-configured constructed GPU view to get specific attribute values on the GPU. raw_array = gpu_view.get(attribute=double_array_attr, return_type=og.WrappedArrayType.RAW) # The return value is omni.graph.core.DataWrapper, which describes its device-specific data and configuration assert raw_array.gpu_ptr_kind == og.PtrToPtrKind.CPU # Also accepts overrides to the global parameters "on_gpu", "gpu_ptr_kind", and "instance" ``` ## get_array_size() Fetches the number of elements in an array attribute. This is meant to be a quick read of the size-only that avoids fetching the entire array, which can be quite large in some cases. ```python # An array size may be set without actually allocating space for it. In the case of very large arrays this can # be quite useful. The get_array_size function lets you find the number of elements that will be in the array # if you request the data, either on GPU or CPU. assert og.DataView.get_array_size(float_array_attr) == 5 ``` # Also accepts overrides to the global parameter "instance" ## set ### `set()` Sets a new value for an attribute. This performs the same function and takes the same parameters as the `og.Controller.edit()` keyword `og.Controller.Keys.SET_VALUES`. ```python # The counterpart to getting values is of course setting them. Normally through this interface you will be # setting values on input attributes, or sometimes state attributes, relying on the generated database to # provide the interface for setting output values as part of your node's compute function. # The "attribute" parameter accepts anything accepted by omni.graph.core.ObjectLookup.attribute(), and the # "value" parameter must be a legal value for the attribute type. og.DataView.set(attribute=int_attr, value=5) assert og.DataView.get(int_attr) == 5 # An optional "update_usd" argument does what you'd expect, preventing the update of the USD backing value # for the attribute you just set. await og.Controller.evaluate() og.DataView.set(int_attr, value=10, update_usd=False) usd_attribute = og.ObjectLookup.usd_attribute(int_attr) assert usd_attribute.Get() != 10 # The values being set are flexible as well, with the ability to use a dictionary format so that you can set # the type for any of the extended attributes. og.DataView.set(union_attr, value={"type": "float", "value": 3.5}) assert og.DataView.get(union_attr) == 3.5 # Also accepts overrides to the global parameters "on_gpu", "gpu_ptr_kind", and "instance" ``` ## force_usd_update ### `force_usd_update()` A context manager that lets you temporarily bracket a bunch of calls to force them to update immediately to USD or not, regardless of the class or parameter values. ```python # Sometimes you are calling unknown code and you want to ensure USD updates are performed the way you want # them. The DataView class provides a method that returns a contextmanager for just such a purpose. with og.DataView.force_usd_update(False): int_view = og.DataView(int_attr) int_view.set(value=20) # The USD value does not update, even though normally the default is to update assert usd_attribute.Get() != 20 with og.DataView.force_usd_update(True): int_view = og.DataView(int_attr) int_view.set(value=30) # The USD value updates assert usd_attribute.Get() == 30 ```
Conventions.md	# Conventions ## Naming Conventions ### File And Class Names Class and file naming is `InterCaps` with the prefix `Ogn`. For example, OgnMyNode.ogn, OgnYourNode.py, class OgnMyNode, and OgnHerNode.cpp. As with regular writing, active phrasing (verb-noun) is preferred over passive phrasing when a node name refers to its function. \| Weak \| Preferred \| \| --- \| --- \| \| OgnSumOfTwoValues \| OgnAddTwoValues \| \| OgnAttributeRemoval \| OgnRemoveAttribute \| \| OgnTextGenerator \| OgnGenerateText \| Tip Some of the automated processes use the `Ogn` prefix to more quickly recognize node files. Using it helps them work at peak efficiency. If the node outputs multiple objects (bundles, prims, etc) then reflect that in the name. (i.e. GetPrimPath for a single path vs GetPrimPaths for an array of paths) The following is a list of common actions/prefixes. These should be used whenever possible for consistency and readability: \| Action/Prefix \| Purpose \| \| --- \| --- \| \| Constant \| A constant value (i.e. ConstantBool) \| \| Read \| Reading the value of a prim from fabric or USD (i.e. ReadPrimAttribute) \| \| Write \| Writing the value of a prim to fabric or USD (i.e. WritePrimAttribute) \| \| Set \| Setting the value of an object (i.e. SetPrimActive) \| \| Get \| \| ## Node Operations - Computing the value of an object (i.e. GetPrimPath) - Find - Search data for a result (i.e. FindPrims) - To - Converting from one value to another (i.e. ToString) - Insert - inserting an object into a bundle/array (i.e. InsertPrim) - Extract - extracting an object from a bundle/array (i.e. ExtractPrim) - Remove - remove an object from a bundle/array (i.e. RemoveAttribute) - Build/Make - Constructing a value from one or more objects. (i.e. BuildString) - Is - Query for object matching (i.e. IsPrimSelected) - Has - Query for object exists on another object (i.e. HasAttr) - On - Event node; used for action graph specific nodes. (i.e OnTick) ## Node Names Although the only real restriction on node names is that they consist of alphanumeric, or underscore characters, there are some conventions established to make it easier to work with nodes, both familiar and unfamiliar. A node will generally have two names - a unique name to identify it to OmniGraph, and a user-friendly name for viewing in the UI. The name of the node should be generally related to the name of the class, to make them easy to find. The name will be made unique within the larger space by prepending the extension as a namespace. The name specified in the file only need be unique within its extension, and by convention is in uppercase CamelCase, also known as PascalCase. It’s a good idea to keep your name related to the class name so that you can correlate the two easily. > Warning > You can override the prepending of the extension name if you want your node name to be something different, but if you do, you must be prepared to ensure its uniqueness. To override the name simply put it in a namespace by including a `.` character, e.g. `omni.deformer.Visualizer`. Note that the `omni.` prefix is reserved for NVIDIA developed extensions. The user-friendly name can be anything, even an entire phrase, in Title Case. Although any name is acceptable, always keep in mind that your node name will appear in the user interface and its function should be immediately identifiable from its name. If you do not specify a user-friendly name then the unique name will be used in the user interface instead. Here are a few examples from the OmniGraph extensions: \| Class Name \| Name in the .ogn file \| Unique Extended Name \| User Facing Node Name \| \|---------------------\|-----------------------\|-------------------------------\|--------------------------------\| \| OgnTutorialTupleData \| TupleData \| omni.graph.tutorials.TupleData \| Tutorial Node: Tuple Attributes \| \| OgnVersionedDeformer \| VersionedDeformer \| omni.graph.examples.cpp.VersionedDeformer \| Example Node: Versioned Deformer \| \| OgnAdd \| Add \| omni.graph.nodes.Add \| Add \| > Attention > The unique node name is restricted to the alphanumeric characters and underscore (`_`). Any other characters in the node name will cause the code generation to fail with an error message. ## Attribute Names As you will learn, every node has a set of attributes which describe the data it requires to perform its operations. The attributes also have naming conventions. The mandatory part is that attributes may only contain alphanumeric characters, underscore, and optional colon-separated namespacing. The preferred naming for attributes is camelCase and, as with nodes, both a unique name and a user-friendly name may be specified where the user-friendly name has no real restrictions. ```code inputs: ``` , ```code outputs: ``` , and ```code state: ``` ) so you can use this to have inputs and outputs with the same name since they will be in different namespaces. Here is an example of attribute names on a node that adds two values together: \| Name in the .ogn file \| Full Name \| User Facing Name \| \|------------------------\|-------------------\|--------------------\| \| a \| inputs:a \| First Addend \| \| b \| inputs:b \| Second Addend \| \| sum \| outputs:sum \| Sum Of Inputs \| ::: attention Attention The unique attribute name is restricted to the alphanumeric characters, underscore (`_`), and colon (`:`). Any other characters in the attribute name will cause the code generation to fail with an error message. ::: Suggest multiplicity in the name when using arrays or when `target` or `bundle` attributes are expected to have multiple entries. (ex. prims for multiple prims and prim for a single prim) The following is a list of common attribute names/suffixes that can be used when appropriate: \| Name/Suffix \| Purpose \| \|-------------\|-------------------------------------------------------------------------\| \| prim / target \| `target` attribute that targets a single prim \| \| prims / targets \| `target` attribute that targets multiple prims \| \| bundle \| `bundle` attribute that contains non-prim data \| \| primBundle \| `bundle` attribute that contains a single prim \| \| primsBundle \| `bundle` attribute that contains multiple prims \| \| pattern \| `string` attribute that uses a search pattern \| \| value \| attribute name for constants and math functions inputs/outputs \| \| name \| `token` attribute used for specifying attribute names \| \| A…Z \| Dynamic attribute names \| ::: tip Tip You will find that your node will be easier to use if you minimize the use of attribute namespaces. It has some implications in generated code due to the special meaning of the colon in C++, Python, and USD. For example an output bundle you name `internal:color:bundle` will be accessed in code as `outputs_internal_color_bundle`. ::: ## Illegal Attribute Names Attributes cannot use C++ or python keywords as their name. The following attribute names are illegal and should be avoided regardless of the method of implementing your node. \| alignas \| char16_t \| do \| mutable \| return \| typeid \| \|---------\|----------\|----\|---------\|--------\|--------\| \| alignof \| char32_t \| double \| namespace \| short \| typename \| \| and \| class \| dynamic_cast \| new \| signed \| union \| \| and_eq \| compl \| else \| noexcept \| sizeof \| unsigned \| \| asm \| concept \| enum \| not \| static \| using \| \| atomic_cancel \| const \| explicit \| not_eq \| static_assert \| virtual \| \| atomic_commit \| consteval \| export \| nullptr \| static_cast \| void \| \| atomic_noexcept \| constexpr \| extern \| operator \| struct \| volatile \| \| auto \| constinit \| false \| or \| switch \| wchar_t \| \| bitand \| const_cast \| float \| or_eq \| synchronized \| while \| \| bitor \| continue \| for \| private \| template \| xor \| \| bool \| co_await \| friend \| protected \| this \| xor_eq \| \| break \| co_return \| goto \| public \| thread_local \| \| \| case \| co_yield \| if \| reflexpr \| throw \| \| \| C++ \| C++ \| C++ \| C++ \| C++ \| C++ \| \|-----------\|--------------\|--------------\|--------------\|--------------\|--------------\| \| catch \| decltype \| inline \| register \| true \| \| \| char \| default \| int \| reinterpret_cast \| try \| \| \| char8_t \| delete \| long \| requires \| typedef \| \| \| Python \| Python \| Python \| Python \| Python \| Python \| \|-----------\|--------------\|--------------\|--------------\|--------------\|--------------\| \| False \| async \| del \| from \| lambda \| raise \| \| None \| await \| elif \| global \| nonlocal \| return \| \| True \| break \| else \| if \| not \| try \| \| and \| class \| except \| import \| or \| while \| \| as \| continue \| finally \| in \| pass \| with \| \| assert \| def \| for \| is \| property \| yield \| ### Code Conventions #### Errors & Warnings OmniGraph has two ways to communicate to the user when the compute function of a node has failed. Either of these methods take a formatted string that describes the failure. \| Python \| C++ \| Description \| \|-----------\|--------------\|-----------------------------------------------------------------------------\| \| db.log_warn \| db.logWarning \| Used when a compute encounters unusual data but can still provide an output. This should not trigger the compute to halt. Ex. Request to deform an empty mesh. \| \| db.log_error \| db.logError \| Used when a compute encounters inconsistent, invalid or unexpected data and it cannot compute an output. This should trigger the compute to halt. Ex. Request to add two vectors with incompatible sizes. \| ## Return Conditions There are two types of compute functions that can be used in nodes; `compute` and `computeVectorized`. For nodes using `compute` return a `bool` type. The convention for these nodes is to return `true` if the function was successful and `false` otherwise. ```cpp static bool compute(GraphContextObj const& contextObj, NodeObj const& nodeObj) { if (db.inputs.value().isValid()) { db.outputs.value() = db.inputs.value(); return true; } return false; } ``` For nodes using `computeVectorized` return a `size_t` value that represents the number of successful instance computations. ```cpp static size_t computeVectorized(GraphContextObj const& contextObj, NodeObj const& nodeObj, size_t count) { size_t ret = 0; for(size_t idx = 0; idx < count; ++idx) { if (db.inputs.value().isValid()) { db.outputs.value() = db.inputs.value(); db.moveToNextInstance(); ++ret; } } return ret; } ``` ### Warning The return value of these functions are not currently used for anything, but this could change in the future. ## Data Conventions ### Prim Path Data #### Tip - Use `target` attributes when a node or bundle needs to consume a prim path. - Use the first path in the `target` array when accessing a single path. Previously, OmniGraph offered several methods of consuming a prim path; bundles, path strings and path tokens. These methods have been replaced with a new `target` type. - `target` attributes are backed by USD relationships, so paths will repair if referenced or if the namespace hierarchy changes. - They are arrays, so consuming multiple paths is possible. When a single path is required, the first path in the array should be used. - Output `target` attributes are possible, so nodes can construct a path array that is read by another node. In the future, previous methods of consuming a path may be deprecated. If any nodes currently use these methods, they must be upgraded to use `target` attributes. - To be able to select multiple targets, add the ogn metadata: ``` allowMultiInputs: "1" ``` - To disallow incoming connections, add the ogn metadata: ``` literalOnly: "1" ``` - Code should not use the USD API to read paths, otherwise incoming connections will be ignored. ### Prim Bundle Data > Tip > > - All prim bundle attributes are containers of one or more child bundles. > - Nodes referencing a single prim bundle access the first child bundle from the attribute. > - When reading a prim bundle into a graph, users must use a ReadPrims node. > - The `sourcePrimPath` and `sourcePrimType` attributes define a bundle as a prim bundle. > - All data added to bundles should conform with USD standards for naming and types. Bundles are a flexible data type that is designed to pass a large amount of attribute data through a single connection. Prim bundles are special bundles that represent a prim within OmniGraph. Moving forward all prim bundle attributes in OmniGraph will act as containers for one or more child bundles containing the attributes for each prim (i.e multiple prims in bundles) rather than have attributes on the root of the bundle (i.e single prim in bundle). Deeper documentation about the multiple prim bundle structure can be found in the Bundles User Guide. ### Single Prim Bundle There are cases where a node needs to access only a single prim bundle, such as extracting attributes from a bundle for a specific prim. When referencing a single prim bundle, the convention is to access the first child bundle from the bundle attribute. This can be accomplished with `get_child_bundle(0)` in python and `getChildBundle(0)` in C++. Full documentation about how to access child bundles can be found in the Bundle Python API Documentation or Bundle C++ API Documentation. ### Prim Bundle Attributes When constructing a bundle with a ReadPrims node, there are several special attributes added to each child prim bundle. The `sourcePrimPath` and `sourcePrimType` are required attributes that define a prim bundle, and `worldMatrix` is used to track the transformation of each prim. There are also optional attributes generated for bounding boxes and skeletal binding (when applicable). Users should refrain from altering these attributes manually unless it is absolutely necessary. #### Required Attributes \| Attribute Name \| Type \| Purpose \| \|----------------\|--------\|----------------------------------------------------------------------------------------------\| \| sourcePrimPath \| token \| Path to the prim in the bundle (ex `/World`) \| \| sourcePrimType \| token \| Type of the prim in the bundle (ex `Mesh`) \| \| worldMatrix \| matrix4d \| The world space matrix of the prim \| ## Optional Attributes \| Attribute Name \| Type \| Purpose \| \|----------------\|----------\|----------------------------------------------\| \| bboxTransform \| matrix4d \| The transform of the bounding box of the prim. \| \| bboxMinCorner \| point3d \| The lower corner of the bounding box in world space. \| \| bboxMaxCorner \| point3d \| The upper corner of the bounding box in world space. \| ## USD Prim Bundle Data There are a set of standard attributes when handling prims that users should use when constructing bundles. These are consistent with the USD naming and types. To allow for maximum compatibility through all nodes, these attributes should be the only ones used when referencing prims. ## Imageable Attributes Base attributes for all prims that may require rendering or visualization of some sort. \| Attribute Name \| Type \| Purpose \| \|----------------\|--------\|-------------------------------------------------------------------------\| \| purpose \| token \| 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. [“default”, “render”, “proxy”, “guide”] \| \| visibility \| token \| Visibility is meant to be the simplest form of “pruning” visibility that is supported by most DCC apps. [“inherited”, “invisible”] \| \| proxyPrim \| target \| 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. \| ## Xformable Attributes Base attributes for all transformable prims, which allows arbitrary sequences of component affine transformations to be encoded. These transformation attributes also allow a separate suffix (ex. `xformOp:translate:pivot`) that can allow multiple attributes of the same type on a single prim. \| Attribute Name \| Type \| Purpose \| \|----------------------\|----------\|-----------------\| \| xformOp:translate \| double3 \| Translation \| \| xformOp:translate:pivot \| double3 \| Pivot translation \| \| xformOp:rotateX \| double \| Single X axis rotation in degrees \| \| xformOp:rotateY \| double \| Single Y axis rotation in degrees \| \| xformOp:rotateZ \| double \| Single Z axis rotation in degrees \| \| xformOp:rotateXYZ \| double3 \| Euler Rotation in XYZ in degrees \| \| xformOp:rotateXZY \| double3 \| Euler Rotation in XZY in degrees \| \| xformOp:rotateYXZ \| double3 \| Euler Rotation in YXZ in degrees \| \| xformOp:rotateYXZ \| double3 \| Euler Rotation in YXZ in degrees \| \|------------------\|---------\|----------------------------------\| \| xformOp:rotateYZX \| double3 \| Euler Rotation in YZX in degrees \| \| xformOp:rotateZXY \| double3 \| Euler Rotation in ZXY in degrees \| \| xformOp:rotateZYX \| double3 \| Euler Rotation in ZYX in degrees \| \| xformOp:scale \| double3 \| Scale \| \| xformOp:orient \| quatd \| Quaternion rotate \| \| xformOp:transform \| matrix4d\| Transformation Matrix \| \| xformOpOrder \| token[] \| 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. \| Kit will also automatically convert from Z to Y up or from a mismatch in units using ``` ``` xformOp:rotateX:unitsResolve xformOp:scale:unitsResolve ``` ``` ## Boundable Attributes Boundable attributes introduce the ability for a prim to persistently cache a rectilinear, local-space, extent. \| Attribute Name \| Type \| Purpose \| \|----------------\|------------\|---------------------------------------------------------------------------------------------\| \| extent \| float3[] \| 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. This space is aligned to world. \| ## Geometric Prim Attributes Base attributes for all geometric primitives. \| Attribute Name \| Type \| Purpose \| \|----------------------\|--------\|---------------------------------------------------------------------------------------------\| \| doublesided \| bool \| 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. \| \| orientation \| token \| Orientation specifies whether the gprim’s surface normal should be computed using the right hand rule, or the left hand rule. Please see for a deeper explanation and generalization of orientation to composed scenes with transformation hierarchies. [“rightHanded”, “leftHanded”] \| \| primvars:displayColor \| color3f[] \| A colorSet that can be used as a display or modeling color, even in the absence of any specified shader for a gprim. \| \| primvars:displayOpacity \| float[] \| 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. \| ``` ## Point Based Attributes Base attributes for all prims that possess points, providing common attributes such as normals and velocities. \| Attribute Name \| Type \| \|----------------\|------\| # Purpose \| Points \| Type \| Purpose \| \|--------\|------------\|---------------------------------------------------------------------------------------------\| \| points \| point3f[] \| The primary geometry attribute for all PointBased prims. Describes points in local space \| \| normals\| normal3f[] \| Provide an object-space orientation for individual points, which, depending on subclass, may define a surface, curve, or free points. \| \| velocities \| vector3f[] \| If provided, ‘velocities’ should be used by renderers to compute positions between samples for the ‘points’ attribute, rather than interpolating between neighboring ‘points’ samples. Velocity is measured in position units per second, as per most simulation software. \| \| acceleration \| vector3f[] \| 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. \| # Material Attributes Attributes used for prims that include shading data (bindings, uvs, etc.). \| Attribute Name \| Type \| Purpose \| \|----------------\|------------\|---------------------------------------------------------------------------------------------\| \| material:binding \| rel (target) \| Relationship that targets the bound material. \| \| primvars:st \| texCoord2f[] \| Standard UV set. \| # Mesh Attributes Attributes used for mesh prims. \| Attribute Name \| Type \| Purpose \| \|----------------\|------------\|---------------------------------------------------------------------------------------------\| \| cornerIndices \| int[] \| 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) \| \| cornerSharpness\| float[] \| 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. \| \| creaseIndices \| int[] \| 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. \| \| creaseLengths \| int[] \| 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. \| \| creaseSharpness \| float[] \| 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. \| \| faceVaryingLinearInterpolation \| token \| 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. [“none”, “cornersOnly”, “cornersPlus1”, “cornersPlus2”, “boundaries”, “all”] \| \| \| \| \| \|-------\|---------------------\|--------------------------------------------------------------------------------------\| \| \| faceVertexCount \| 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. \| \| \| faceVertexIndices \| 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. \| \| \| holeIndices \| 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. \| \| \| interpolateBoundary \| Specifies how subdivision is applied for faces adjacent to boundary edges and boundary points. ["none", "edgeOnly", "edgeAndCorner"] \| \| \| subdivisionScheme \| The subdivision scheme to be applied to the surface. ["catmullClark", "loop", "bilinear", "none"] \| \| \| triangleSubdivisionRule \| Specifies an option to the subdivision rules for the Catmull-Clark scheme to try and improve undesirable artifacts when subdividing triangles. ["catmullClark", "smooth"] \|
ConvertActionGraphNodesToAPI.md	# Converting Action Graph Nodes to IActionGraph This document describes how to convert Action Graph nodes written using the legacy method of manipulating execution attributes to the currently recommended approach using `omni::graph::action::IActionGraph_abi` introduced in kit-sdk 105.1. ## What Changed The mechanism of writing and reading control information between nodes and the executor has changed. We now use the API to do this communication instead of reading and writing execution attributes. While the `execution` attributes are used to author the flow of execution of the graph, the `value` of these attributes is no longer relevant. ## OGN Tests Since the values of execution attributes are not relevant, the [OGN tests](../dev/ogn/ogn_reference_guide.html#ogn-test-data) can not usually be used to validate node behavior, instead unit tests should be used. ## Add the extension dependency The new API lives in `omni.graph.action`, so any extension that implements action graph nodes needs to depend on that. ```c++ [dependencies] "omni.graph.action" = {} ``` ## Include the API The `omni::graph::action::IActionGraph_abi` must be included in the node code, and a handle to API itself is acquired. ```c++ #include <omni/graph/action/IActionGraph.h> // Acquire the API auto iActionGraph = omni::graph::action::getInterface(); ``` ```python from omni.graph.action import get_interface # Acquire the API action_graph = get_interface() ``` ## Enabling an Execution Output # All execution outputs are automatically disabled before compute is called. An output can be enabled using the API call. ```C++ db.outputs.opened() = kExecutionAttributeStateEnabled; // Becomes: iActionGraph->setExecutionEnabled(outputs::opened.token(), db.getInstanceIndex()); ``` ```python db.outputs.opened = og.ExecutionState.ENABLED // Becomes: action_graph.set_execution_enabled("outputs:opened") ``` # Reading an Execution Input This is not needed for most nodes, but the state of input attributes should be read with the API call. ```C++ bool resetIsActive = (db.inputs.reset() != kExecutionAttributeStateDisabled); // Becomes: bool resetIsActive = iActionGraph->getExecutionEnabled(inputs::reset.token(), db.getInstanceIndex()); ``` ```python reset_is_active = (db.inputs.reset != db.ExecutionAttributeState.DISABLED) // Becomes: reset_in_is_active = action_graph.get_execution_enabled("inputs:reset") ``` # Starting and Ending Latent State This is not needed for most nodes, but the latent state should be controlled via the API. ```C++ if (starting) db.outputs.finished() = kExecutionAttributeStateLatentPush; else { db.outputs.finished() = kExecutionAttributeStateLatentFinish; } // Becomes: if (starting) iActionGraph->startLatentState(db.getInstanceIndex()); else { iActionGraph->endLatentState(db.getInstanceIndex()); iActionGraph->setExecutionEnabled(outputs::finished.token(), db.getInstanceIndex()); } ``` ```python if starting: db.outputs.finished = og.ExecutionAttributeState.LATENT_PUSH else: db.outputs.finished = og.ExecutionAttributeState.LATENT_FINISH // Becomes: if starting: action_graph.start_latent_state() else: action_graph.end_latent_state() action_graph.set_execution_enabled("outputs:finished") ```
coordinate-systems_Overview.md	# Overview — kit-omnigraph 1.109.1 documentation ## Overview This extension contains the base functionality that is shared by editors of OmniGraph. It is based on `omni.kit.graph.editor.core` and provides base implementations which are intended to be specialized by editor windows for particular graph types. ### Coordinate Systems There are three coordinate systems used in the graph editor code: screen, view and mouse. Screen coordinates are the pixel coordinates of the display device, with (0, 0) in the upper left corner of the display. View coordinates are the coordinates within the `GraphView` widget. Internally `GraphView` uses an `omni.ui.CanvasFrame` to display the nodes and connections. `CanvasFrame` allows its contents to be zoomed and panned, meaning that view coordinates are not simply an offset from screen coordinates. (If you see references to canvas coordinates those are the same as view coordinates.) To convert screen coordinates to view coordinates call `GraphView.screen_to_view()`. There is currently no method available for converting from view coordinates back to screen. Mouse coordinates are the coordinates supplied by mouse events which occur over the `GraphView`. Normally these are the same as screen coordinates but may differ depending upon certain settings. `GraphView.mouse_to_screen()` and `GraphView.mouse_to_view()` can be used to convert mouse coordinates in a consistent manner, regardless of settings.
core-converter_Overview.md	# Hoops Converter ## Overview The Hoops Converter extension enables conversion for many common CAD file formats to USD. USD Explorer includes the Hoops Converter extension enabled by default. ## Supported CAD file formats The following file formats are supported by Hoops Converter: - CATIA V5 Files (`.CATPart, .CATProduct, .CGR`) - CATIA V6 Files (`.3DXML`) - IFC Files (`.ifc, .ifczip`) - Siemens NX Files (`.prt`) - Parasolid Files (`.xmt, .x_t, .x_b, .xmt_txt`) - SolidWorks Files (`.sldprt, .sldasm`) - STL Files (`.stl`) - Autodesk Inventor Files (`.IPT, .IAM`) - AutoCAD 3D Files (`.DWG, .DXF`) - Creo - Pro/E Files (`.ASM, .PRT`) - Revit Files (`.RVT, .RFA`) - Solid Edge Files (`.ASM, .PAR, .PWD, .PSM`) - Step/Iges (`.STEP, .IGES`) - JT Files (`.jt`) - DGN (`.DGN`) ::: note Note ::: # 支持的文件格式 .fbx, .obj, .gltf, .glb, .lxo, .md5, .e57 和 .pts 是由 Asset Converter 支持的默认文件格式。 ## 注意如果安装了 Creo、Revit 或 Alias 等专业工具，我们建议使用相应的连接器。这些连接器提供了更广泛的转换选项。 ## 注意在转换来自 Nucleus 的 CAD 装配体时可能会遇到问题。当转换带有外部引用的装配体时，我们建议使用本地文件或 Omniverse Drive。 # Converter Options 本节涵盖了将 Hoops 文件格式转换为 USD 的配置选项。 # Related Extensions 这些相关扩展构成了 Hoops 转换器。此扩展通过其接口为扩展提供导入任务。 ### Core Converter - Hoops Core: :doc:`omni.kit.converter.hoops_core<omni.kit.converter.hoops_core:Overview> ### Services - CAD Converter Service: :doc:`omni.services.convert.cad ### Utils - Converter Common: :doc:`omni.kit.converter.common
CoreConcepts.md	# Core Concepts ## Graph The graph comprises two conceptual pieces - the [Authoring Graph](Glossary.html#term-Authoring-Graph) and the [Execution Graph](Glossary.html#term-Execution-Graph). The term is often used to refer to one or both of these graphs, though among users and casual developers it most commonly refers to the [Authoring Graph](Glossary.html#term-Authoring-Graph). One type of graph you might hear a lot of is the [Action Graph](Glossary.html#term-Action-Graph) where you can build up behaviors that are triggered on some event. See this [Action Graph](concepts/ActionGraph.html#ogn-omni-graph-action-overview) for an introduction to how it can be used. ### Authoring Graph The authoring graph is what a user sees when they are constructing a graph for evaluation. It has nodes that come from a node library, connections between them, and specific values on the attributes. It describes the topology and configuration of a graph that in turn describes a specific computation to be made. In C++, the graph is accessed through the `omni::graph::core::IGraph` interface. In Python, the bindings are available in `omni.graph.core.Graph`. ### Execution Graph The execution graph is what the system uses when it is evaluating the computation the authoring graph has described. It is free to take the description in the authoring graph and use it as-is by calling functions in the same graph structure, or to perform any optimization it sees fit to transform the authoring graph into a more efficient representation for execution. For example, it might take two successive nodes that double a number and change it into a single node that quadruples a number. ## Graph Context The graph context contains things such as the current evaluation time and other information relevant to the current context of evaluation (and hence the name). Thus, we can ask it for the values on a particular attribute (as it will need to take things such as time into consideration when determining the value). In C++, the graph is accessed through the `omni::graph::core::IGraphContext` interface. In Python, the bindings are available in `omni.graph.core.GraphContext`. ## Graph Type ## Graph Type The graph type, sometimes referred to as the evaluation type, indicates how the graph is to be executed. This includes the process of graph transformation that takes an Authoring Graph and creates from it an Execution Graph that follows the desired type of evaluation pattern. Examples of graph types include the Action Graph, Push Graph, and Lazy Graph. ## Graph Registry This is where we register new node types (and unregister, when our plugin is unloaded). The code generated through the descriptive .ogn format automatically handles interaction with the registry. Interaction with the registry is handled through the C++ ABI interface `omni::graph::core::IGraphRegistry` and in Python through the binding `omni.graph.core.GraphRegistry`. ## Node The heart of any node graph system is of course, the node. The most important exposed method on the node is one to get an attribute, which houses all of the data the node uses for computing. The most import method you implement is the `compute` method, which performs the node’s computation algorithm. In C++ the graph is accessed through the `omni::graph::core::INode` interface. In Python the bindings are available in `omni.graph.core.Node`. ## Node Type In order to register a new type of node with the system, you will need to fill the exposed `omni::graph::core::INodeType` interface with your own custom functions in order to register your new node type with the system. To simplify this process a descriptive format (.ogn files) has been created which is described in OGN User Guide. Each node type has a unique implementation of the `omni::graph::core::INodeType` interface. This can be used for both C++ and Python node type implementations. The Python nodes use bindings and function forwarding to interface with the C++ ABI in `omni.graph.core.NodeType`. ## Attribute An Attribute has a name and contains some data. This should be no surprise to anyone who has worked with graphs before. Attributes can be connected to other attributes on other nodes to form an evaluation network. In C++ the graph is accessed through the `omni::graph::core::IAttribute` interface. In Python the bindings are available in `omni.graph.core.Attribute`. ## Attribute Data While the Attribute defines the connection points on a node and its Attribute Type defines the type(s) of data the attribute will take on, the Attribute Data is the actual data of the attribute, usually stored in Fabric. In C++ the graph is accessed through the `omni::graph::core::IAttributeData` interface. ## Attribute Data In Python the bindings are available in `omni.graph.core.AttributeData`. ## Attribute Type OmniGraph mostly relies on Fabric for data, and Fabric was designed to mostly just mirror the data in USD, but in more compute friendly form. That said, we did not want to literally use the USD data types, as that creates unnecessary dependencies. Instead, we create data types that are binary compatible with the USD data types (so that in C++ they can be cast directly), but can be defined independently. Also, our types capture some useful metadata, such as the role of the data. For example, a `float[3]` can be used both to describe a position as well as a normal. However, the way the code would want to deal with the data is very different depending on which of the two roles it plays. Our types have a `role` field to capture this sort of meta-data. See more detailed documentation in [Attribute Type Definition](#omnigraph-attribute-type). ## Connections If the [Node](#term-Node) is thought of as the vertex in the [Graph](#term-Graph) then the [Connection](#term-Connection)s are the edges. They are a representation of a directed dependency between two specific [Attribute](#term-Attribute)s on [Node](#term-Node)s in the graph. ## Bundles To address the limitations of regular attributes, we introduced the notion of the [Bundle](#term-Bundle). As the name suggests, this is a flexible bundle of data, similar to a [USD Prim](#term-USD-Prim). One can dynamically create any number of attributes inside the bundle and transport that data down the graph. This serves two important purposes. First, the system becomes more flexible - we are no longer limited to pre-declared data. Second, the system becomes more usable. Instead of many connections in the graph, we have just a single connection, with all the necessary data that needs to be transported. A brief introduction to bundles can be seen [Bundles](#omnigraph-dev-bundles) and [Bundles User Guide](#omnigraph-bundle-user-guide). ## Fabric The data model for OmniGraph is based on the Fabric data manager. Fabric is used as a common location for all data within the nodes in OmniGraph. This common data location allows for many efficiencies. Further, Fabric handles data synchronization between CPU data, GPU data, and USD data, offloading that task from OmniGraph. Fabric is a cache of USD-compatible data in vectorized, compute friendly form. OmniGraph leverages Fabric’s data vectorization feature to help optimize its performance. Fabric also facilitates the movement of data between CPU and GPU, allowing data to migrate between the two in a transparent manner. There are currently two kinds of Fabric caches. There is a single `SimStageWithHistory` cache in the whole system, and any number of `StageWithoutHistory` caches. When a graph is created, it must specify what kind of Fabric cache “backs” it. All the data for the graph will be stored in that cache. ## USD Like the rest of Omniverse, OmniGraph interacts with and is highly compatible with USD. We use USD for persistence of the graph. Moreover, since Fabric is essentially USD in compute efficient form, any transient compute data can be “hardened” to USD if we so choose. That said, while it is possible to do so, we recommend that node writers refrain from accessing USD data directly from the node, as USD is essentially global data, and accessing it from the node would prevent it from being parallel scheduled and thus get in the way of scaling and distribution of the overall system. ## Instancing Instancing is a templating technique that allows to create a graph once, and to apply it to multiple prims. It brings several benefits: - For authoring: The graph is created once but can be used multiple time without additional effort. - For maintenance: Any change made to this shared “template” is automatically applied to all “instances” - For runtime: - Vectorized data: All the runtime data for “instances” of a given graph is allocated in contiguous arrays per attributes. This compact data organization provides data locality which reduces cache misses, thus improving performance. - Compute “transposition”: Instead of iterating over each graph and execute all its node, the framework can iterate over the graph nodes and execute all its “instances”. This brings a huge benefit when there are a lot of “instances”. - Compute “factorization”: All “instances” can be provided to the compute at once, so the framework don’t even have to iterate the “instances” anymore - Vectorized compute: A node can decide to implement a vectorized compute for further optimizations: this allows to use SIMD instruction sets for example, or apply similar types of optimizations. Note that this feature is currently only available for [Push Graph](#term-Push-Graph). # Auto-instancing Auto-instancing is a framework feature that automatically factorizes similar graphs as instances, in order to benefit from the runtime performance gains explained above. This feature will set up compute for all of those graphs, at once, through the same execution pipline than regular instances. This feature does not require any user action, and is meant to bring the same level of performance as regular instancing. It is particularly helpful when replicating/referencing the same “Smart Asset” (an asset embedding its own logic/behavior as a graph) many times in a stage. # Graph Variables Variables are values associated with an instance of a graph that can be read or changed by the graph during its execution. Variables can be used to keep track of state within the graph between execution frames, or to supply individualized values for different instances of the same graph. The initial value of a variable is read from USD, and the runtime value is maintained in Fabric. Variable values are never written back to USD, so any changes to their value during execution are lost when the application completes. In C++ variable properties can be queried through the `omni::graph::core::IVariable` interface, with methods to create, remove and find variables available on `omni::graph::core::IGraph`. In python, the bindings are available on the `omni.graph.core.IVariable` and `omni.graph.core.Graph` classes, respectively. Reading and writing variable runtime values in Fabric can be accomplished by accessing their corresponding Attribute Data available through a Graph Context in a similar manner to working with an Attribute. Reading and writing initial, a.k.a default, values in python can be accomplished with methods provided with the Controller Class. # Compounds Compounds are a representation used to group related nodes together into a sub-network. This grouping of nodes can be done for organization purposes or to create a single definition to be reused multiple times, either within a single OmniGraph or across OmniGraphs. OmniGraph currently supports Compound Subgraphs, which are a collection of nodes that are represented by a single Compound Node in the parent graph. Compound Subgraphs share state, including variables, with the OmniGraph of the Compound Node.
CrashReporter.md	# Carbonite Crash Reporter ## Overview The crash reporter is intended to catch and handle exceptions and signals that are produced at runtime by any app that loads it. On startup, if configured to do so, the crash reporter will install itself in the background and wait for an unhandled exception or signal to occur. There is no performance overhead for this to occur and for the most part the crash reporter plugin just sits idle until a crash actually occurs. The only exception to this is that it will monitor changes to the `/crashreporter/` branch in the settings registry (managed by the `carb::settings::ISettings` interface if present). The crash reporter plugin does not have any other dependent plugins. It will however make use of the `carb::settings::ISettings` interface if it is loaded in the process at the time that the crash reporter plugin is loaded. Any changes to the `/crashreporter/` settings branch will be monitored by the plugin and will have the possibility to change its configuration at runtime. See below in [Configuration Options](#crashreporter-settings-label) for more information in the specific settings that can be used to control its behavior. Note that if an implementation of the `carb::settings::ISettings` interface is not available before the crash reporter plugin is loaded, the crash reporter will not be able to reconfigure itself automatically at runtime. In this case, the crash reporter will only use its default configuration (ie: no crash report uploads, write reports to the current working directory). If the `carb::settings::ISettings` interface becomes available at a later time, the crash reporter will automatically enable its configuration system. When this occurs, any configuration changes listed in the settings registry will be loaded and acted on immediately. The implementation of the crash reporter plugin that is being referred to here is based on the Google Breakpad project. The specific plugin is called `carb.crashreporter-breakpad.plugin`. ## Common Crash Reporter Terms - “Crash Report”: A crash report is a collection of files, metadata, and process state that describes a single crash event. This collection may be compressed into a zip file or stored as a loose files. The crash report may be stored locally or be uploaded to a crash report processing system for later analysis. - “Crash Dump”: This is a file included in a crash report that contains the process state at the time of a crash. This typically contains enough information to do a post-mortem analysis on the state of the crashing portion of the process, but does not always contain the complete state of the process. This file is often one of the largest components in a crash report. - “Crash Log”: The log file related to the crashing process. This can help a crash investigator determine what the crashing process may have been doing near the time of the crash or perhaps even contain a reason for the crash. This log file is not automatically included in a crash report. Since this log may contain either confidential information or personally identifiable information (ie: file names and paths, user names, etc), care must be taken when deciding to include a log file in a crash report. # Report - "Metadata": Each application can include its own custom data points with any crash report. These are referred to as metadata values. These can be set by the application at any time before a crash occurs. All registered metadata values will be included with a crash report when and if it is generated. See [Crash Handling and Metadata](#crashreporter-metadata-label) for more info on how to add metadata. Metadata comes in two flavors - static and volatile. A static metadata value is not expected to change during the lifetime of the process (or change rarely). For example, the application’s product name and version would be static metadata. See below for a description of volatile metadata. - "Volatile Metadata": A volatile metadata value is one that changes frequently throughout the lifetime of the process. For example, the amount of system memory used at crash time would be considered volatile. Adding such a value as static metadata would potentially be very expensive at runtime. A volatile metadata value instead registers a callback function with the crash reporter. When and if a crash occurs, this callback is called so that the crash reporter can collect the most recent value of the metadata. - "Extra Files": A crash report can contain zero or more custom extra files as well. This is left up to the application to decide which files would be most interesting to collect at crash time. It is the responsibility of the application to ensure that the files being collected do not contain any confidential or personally identifiable information. ## Setting Up the Crash Reporter When the Carbonite framework is initialized and configured, by default an attempt will be made to find and load an implementation of the `carb.crashreporter-.plugin` plugin. This normally occurs after the initial set of plugins has been loaded, including the plugin that implements the `carb::settings::ISettings` interface. If a crash reporter implementation plugin is successfully loaded, it will be ‘registered’ by the Carbonite framework using a call to `carb::crashreporter::registerCrashReporterForClient()`. This will ensure the crash reporter’s main interface `carb::crashreporter::ICrashReporter` is loaded and available to all modules. The default behavior of loading the crash reporter plugin can be overridden using the flag `carb::StartupFrameworkDesc::disableCrashReporter` when starting the framework. If this is set to `true`, the search, load, and registration for the plugin will be skipped. In that case, it will be up to the host app to explicitly load and register its own crash reporter if its services are desired. Once loaded and registered, the Carbonite framework will make an attempt to upload old crash report files if the `/app/uploadDumpsOnStartup` setting is `true` (this is also the default value). Note that this behavior can also be disabled at the crash reporter level using the setting `/crashreporter/skipOldDumpUpload`. This upload process will happen asynchronously in the background and will not affect the functionality of other tasks. If the process tries to exit early however, this background uploading could cause the exit of the process to be delayed until the current upload finishes (if any). There is not currently any way to cancel an upload that is in progress. Most host apps will not need to interact with the crash reporter very much after this point. The only functionality that may be useful for a host app is to provide the crash reporter with various bits of metadata about the process throughout its lifetime. Providing this metadata is discussed below in [Crash Handling and Metadata](#crashreporter-metadata-label). ## Configuring the Crash Reporter See [Configuration Options](#crashreporter-settings-label) for a full listing of available configuration settings. Once the crash reporter plugin has been loaded, it needs to be configured properly before any crash reports can be sent anywhere. Crash reports will always be generated locally if the crash reporter is loaded and enabled (with the `/crashreporter/enabled` setting). When the crash reporter is disabled, the operating system’s default crash handling will be used instead. To enable uploads of generated crash reports, the following conditions must be met: 1. The `/crashreporter/enabled` setting must be set to `true`. 2. The `/crashreporter/url` setting must be set the URL to send the generated crash report to. 3. The `/crashreporter/product` setting must be set to the name of the product that crashed. ## Crash Reporter Configuration ### Version Information The `/crashreporter/version` setting must be set to the version information of the crashing app. This value may not be empty, but is also not processed for any purposes except crash categorization and display to developers. ### Privacy and Upload Settings Either the `/privacy/performance` setting must be set to `true` or the `/crashreporter/devOnlyOverridePrivacyAndForceUpload` setting must be set to `true`. The former is always preferred but should never be set explicitly in an app’s config file. This is a user consent setting and should only ever be set through explicit user choice. It should also never be overridden with `/crashreporter/devOnlyOverridePrivacyAndForceUpload` except for internal investigations. ### Configuration by Main Process Only the main process (ie: `kit-kernel`) should ever configure the crash reporter. This can either be done in startup config files, on the command line, or programmatically. A plugin or extension should never change this base configuration of the crash reporter. Plugins and extensions may however add crash report metadata and extra files (described below). ### Crash Report Upload Once the crash reporter has been configured in this way, each new crash report that is generated will be attempted to be uploaded to the given URL. Should the upload fail, another crash occurs during the upload (the process is possibly unstable after a crash), or the user terminates the process during the upload, an attempt to upload it again will be made the next time any Carbonite based app starts up using the same crash dump folder. By default, up to 10 attempts will be made to upload any given crash report. Each attempt will be made on a separate run of a Carbonite app. If all attempts fail, the crash report will simply be deleted from the local directory. ### Dump File Preservation After a crash report is successfully uploaded, it will be deleted from the local dump directory along with its metadata file. If the crash report files should remain even after a successful upload, the `/crashreporter/preserveDump` setting should be set to `true`. This option should really only be used for debugging purposes. Note that if a crash report is preserved and it has already been successfully uploaded, another attempt to upload it will not be made. ### Dump Directory By default, the crash reports dump directory will be the app’s current working directory. This can be changed using the `/crashreporter/dumpDir` setting. Any relative or absolute path may be used here. The named directory must exist before any crash occurs. ## Compressed Crash Reports The `carb.crashreporter-breakpad.plugin` implementation includes support for creating zip compressed crash reports. Typically a crash dump file will compress down to ~10% of its original size which can save a lot of time and bandwidth usage uploading the crash reports. Log files typically compress very well too. This feature is enabled with the `/crashreporter/compressDumpFiles` setting. When set to `true`, a zip compressed crash report will be used instead. The crash report management system that NVIDIA provides does support accepting zipped crash report files. When enabled, all files that are to be included with the crash report will be included in a single zip archive and sent along with the crash metadata. In this case, the crash report’s file will have the extension `.dmp.zip` and its metadata file will have the extension `.dmp.zip.toml`. This feature is still in the beta stage, but is being used exclusively by some Carbonite based apps both internally and publicly. ## Crash Handling and Metadata When a crash does occur in the app, the crash reporter will catch it. Upon catching a crash, the crash reporter plugin will create a crash dump file and collect metadata from the running app. The format of the crash dump file will differ depending on the platform. On Windows, a minidump file compatible with Microsoft Visual Studio will be created. On Linux, a proprietary crash dump file will be created. This file is compatible with Microsoft minidump files, but will not necessarily contain information that Visual Studio can fully understand. This Linux crash dump file can be converted to a stripped-down Linux core dump file with the use of a helper tool from the Breakpad library (the tool is `utils/minidump-2-core` in the separately-distributed Google Breakpad packman package). A minidump or core dump file contains some portions of the state of the process at the time it crashed. This state includes the list of running threads, each of their CPU register states, portions of their stack memory, a list of loaded modules, and some selected memory blocks that were referenced on the various thread stacks. From this crash state information some investigation can successfully be done into what may have caused the crash. The dump files do not contain all of the process’ state information by default since that could be several gigabytes of data. The metadata for the crash will be collected from multiple sources both at crash time and as the program runs. The metadata is simply a set of key-value pairs specified by the host app. The metadata values may be any string, integer, floating point, or boolean value (arrays of these values are not currently supported) and are collected from these sources: - Any value specified in a call to `carb::crashreporter::addCrashMetadata()`. This is just a helper wrapper for adding metadata values through the `/crashreporter/data/` settings branch. This is the preferred method of adding constant metadata values. - Any key/value pairs written to the `/crashreporter/data/` branch of the settings registry. This registers a constant metadata key-value pair and is best used for values that do not change at all. or do not change frequently throughout the app’s lifetime. These metadata values are collected and stored immediately. This method of adding metadata can be used on the command line or in a config file for example if the information is known at launch time. Any ‘volatile’ metadata values specified with `carb::crashreporter::ICrashReporter::addVolatileMetadata()`. This registers a value to be collected at crash time through a callback function. This type of metadata is intended to be used for values that change frequently and would be too expensive to update immediately every time they change. The only value that is important is the last value at the time of a crash. For example, this is used internally to collect the process uptime and memory usage information at the time of a crash. Regardless of how a metadata value is added, its key name will be always sanitized to only contain characters that are friendly to database key names. This sanitization will involve replacing most symbol characters with an underscore (‘_’). All key names should only contain ASCII characters as well. Metadata values may contain any UTF-8 codepoints however. ### Python Tracebacks The crash reporter has the ability to run a utility when a crash is detected that will inspect the Python interpreter running in the process and produce a Python traceback of all Python threads. By default this utility is py-spy. The utility’s binary must be in the same directory as the crash reporter, as the application binary, or in the working directory of the process at configuration time. For this process to work correctly, the Python library must be an official distribution, or it must have symbols packaged along with it. Several configuration keys (containing `pythonTraceback`) can configure how the process runs. The metadata key `PythonTracebackStatus` will record the outcome of gathering the Python traceback. The Python traceback is uploaded as a separate text file. The process must return an exit code of 0 to be considered successful. ### User Story The crash reporter can also run a separate process in order to gather information from the user. This is known as the “user story”–the user’s telling of what they were doing when the crash occurred. This may provide some hints necessary to reproduce and diagnose the problem. Several configuration keys (containing `userStory`) can configure how the process runs. The metadata key `UserStoryStatus` will record the outcome of gathering the user story. By default, this is `crashreport.gui`, a small and simple GUI application maintained by Carbonite: The checkbox will be auto-populated based on whether crash dumps are allowed to be uploaded (both configuration and privacy settings affect this). However, if the user submits a crash report, that acts as a privacy consent to send a report. If the user cancels, the crash is deleted (ignoring configuration to persist crashes). If the checkbox is not checked, the ‘Submit’ button is disabled and cannot be pressed. Both pressing the ‘Cancel’ button, or pressing the ‘Submit’ button with the text box empty will cause a popup message to be displayed for the user to confirm the action. These can be suppressed by adding `--/app/window/confirmOnCancel=1` or `--/app/window/confirmOnEmptyRepro=1` respectively to the arguments in the `/crashreporter/userStoryArgs` configuration keys (though the default arguments from that key must be part of your redefinition). The binary is expected to log the user story to `stdout` and produce an exit code of `0` to submit the crash, or `1` to cancel and delete the crash. Any other exit code (or a timeout) will report an error to the `UserStoryStatus` metadata field and proceed as if the user story binary was not run (i.e. uploading based on current configuration). The tool requires `--/app/crashId=<crash ID>` to be passed on the command line (with `<crash ID>` as the current crash ID) in order to fully start, otherwise a message is displayed that the application is not intended to be run manually. ### Adding Extra Files to a Crash Report By default a crash report is sent with just a crash dump file and a set of metadata key/value pairs. If necessary, extra files can be added to the crash report as well. This could include log files, data files, screenshots, etc. However, when adding extra files to a crash report, care must be taken to ensure that private data is not included. This is left up to the system adding the extra files to verify. Private data includes both personal information of users and potential intellectual property information. For example, this type of information is highly likely to unintentionally exist in log files in messages containing file paths. To add an extra file to a crash report, one of the following methods may be used: - Call `carb::crashreporter::addExtraCrashFile`... ## Adding Extra Files to a Crash Report There are two primary ways to add extra files to a crash report: 1. Use the function `carb::crashreporter::addExtraCrashFile()` to add the new file path. This may be a relative or absolute path (though if a relative path is used, the current working directory for the process may not change). This is the preferred method for adding a new file. 2. Add a new key and value to the `/crashreporter/files/` branch of the settings registry. This can be done in a config file or on the command line if the path to the file is known at the time. This can also be done programmatically if necessary. When extra files are included with the crash report, they will all be uploaded in the same POST request as the main crash dump file and metadata. These extra files will be included whether the crash report has been compressed or not. ## Loading a Crash Dump to Investigate On Windows, a crash dump file can be opened by dragging it into Visual Studio then selecting “Debug with native only” on the right hand side of the window. This will attempt to load the state of the process at the time of the crash and search available symbol servers for symbols and code to the modules that were loaded at the time of the crash. The specific symbol and source servers that are needed to collect this information depend on the specific project being debugged. Once loaded, many of the features of the Visual Studio debugger will be available. Note that symbols and source code may or may not be available for every module depending on your access to such resources. Some restrictions in this mode are that you won’t be able to step through code or change the instruction pointer’s position. Also, global data may not be available depending on the contents of the crash dump file. If a particular crash is repeatable, the `/crashreporter/dumpFlags` setting can be used to collect more information in the crash dump file that is created. Note though that some of the flags that are available can make the crash dump very large. On Windows, the following dump flags are available: - `Normal`: only capture enough information for basic stack traces of each thread. - `WithDataSegs`: include the memory for the data sections of each module. This can make the dump file very large because it will include the global memory space for each loaded module. - `WithFullMemory`: include all of the process’ mapped memory in the dump file. This can cause the dump file to become very large. This will however result in the most debuggable dump file in the end. - `WithHandleData`: includes all of the OS level information about open handles in the process. - `FilterMemory`: attempts to filter out blocks of memory that are not strictly needed to generate a stack trace for any given thread. - `ScanMemory`: attempts to scan stack memory for values that may be pointers to interesting memory blocks to include in the dump file. This can result in a larger dump file if a lot of large blocks are included as a result of the scan. - `WithUnloadedModules`: attempts to include a list of modules that had been recently unloaded by the process. - `WithIndirectlyReferencedMemory`: includes blocks of memory that are referenced on the stack of each thread. This can result in a significantly larger dump file. - `FilterModulePaths`: filters out module paths that may include user names or other user related directories. This can avoid potential issues with personally identifying information (PII), but might result in some module information not being found while loading the dump file. - `WithProcessThreadData`: includes full process and thread information from the operating system. - `WithPrivateReadWriteMemory`: searches the process’s virtual memory space and includes all pages that have the `PAGE_READWRITE` protection. - `WithoutOptionalData`: attempts to remove memory blocks that may be specific to the user or is not strictly necessary to create a usable dump file. This does not guarantee that the dump file will be devoid of PII, just reduces the possibility of it. - `WithFullMemoryInfo`: includes information about the various memory regions in the process. This is simply the page allocation, protections, and state information, not the data in those memory regions itself. - `WithThreadInfo`: includes full thread state information. This includes thread context and stack memory. Depending on the number of threads and amount of stack space used, this can make the dump file larger. - `WithCodeSegs`: includes code segments from each module. Depending on the number and size of modules loaded, this can make the dump file much larger. - `WithoutAuxiliaryState`: disables the automatic collection of some extra memory blocks. - `WithFullAuxiliaryState`: includes memory and state from auxilary data providers. This can cause the dump file to become much larger. - WithPrivateWriteCopyMemory: includes memory blocks that have the `PAGE_WRITECOPY` protection. This can make the dump file larger if a lot of large blocks exist. - IgnoreInaccessibleMemory: if the `WithFullMemory` flag is also used, this prevents the dump file generation from failing if an inaccessible region of memory is encountered. The unreadable pages will not be included in the dump file. - WithTokenInformation: includes security token information in the dump file. - WithModuleHeaders: includes the headers from each loaded module. - FilterTriage: adds filter triage related data (not clear exactly what this adds). - WithAvxXStateContext: includes the AVX state context for each thread (x86_64 only). - WithIptTrace: includes additional Intel Processor Trace information in the dump file. On Linux, the process for loading a crash dump file is not entirely defined yet. Depending on how in depth the investigation needs to be, there are two currently known methods. Both require some tools from the `Breakpad` SDK. The following methods are suggested but not officially supported yet: - Use the `minidump-2-core` tool from `Breakpad` to convert the crash dump file to a standard Linux core dump file. Note that by default this tool will output the result to `stdout` which can break some terminals. Instead the output should always be redirected to a file. This file can then be opened with GDB using the command `gdb <executable> --core <core_file>`. GDB may also need to be pointed to the various symbol files for the process. Please see the manual for GDB on how to find and load symbol files if needed. Carbonite also provides a `gdb-syms.py` Python script for GDB that will attempt to download symbols from the NVIDIA Omniverse symbol server. - Use the `minidump-stackwalk` tool to attempt to retrieve a stack backtrace for each thread listed in the crash dump file. This will produce a lot of output so it is best to redirect it to a file. This can provide some basic information about where the crash occurred and can give at least an idea of a starting point for an investigation. The current crash report management system (called OmniCrashes) usually does a good job of extracting crash information for all platforms and displays it. This is an internal crash reporting system however and cannot be accessed publicly. It is however a deployable product for customers who need to run their own instance of OmniCrashes. ## Uploading Crash Reports NVIDIA provides a default URL to send crash reports to. At this location, crash dumps and metadata will be accepted via HTTP POST commands. The expected format of the POST is a multipart form that provides key/value pairs for each of the metadata items followed by the binary data for the crash dump file itself, followed by any additional files to be included with the crash report upload. The crash report files are processed at this location and stored for later investigation. This default location can always be overridden by using the `/crashreporter/url` setting. The new URL will still be expected to accept POSTed forms in the same format. Once a crash report is created locally on a machine, the default behavior (if enabled) is to attempt to upload the crash dump and its associated metadata to the current upload URL. There are multiple settings that can affect how and if the crash report upload will occur. See [Configuring the Crash Reporter](#crashreporter-configuring-label) and [Configuration Options](#crashreporter-settings-label) for more information on those specific settings. The upload is performed synchronously in the crashing thread. Once finished and if successful, the crash dump file and its metadata may be deleted locally (depending on the `/crashreporter/preserveDump` setting). If the upload is not successful for any reason, the crash dump and metadata files will be left locally to retry again later. By default, up to 10 attempts will be made for each crash report. Should the upload fail for any reason on the first attempt (ie: in the crashing process), an attempt to upload it again will be made the next time the app is run. The original upload could fail for many reasons including network connection issues, another crash occurred while trying to do the original upload, or even that the server side rejected the upload. When retrying an upload in future runs of the app, old crash dump files will be uploaded sequentially with their original metadata. Should a retry also fail, a counter in the metadata will be incremented. If an upload attempt fails too many times (see `/crashreporter/retryCount` below), the crash dump file and its metadata file will be deleted anyway. If a crash report is successfully uploaded during a retry and the `/crashreporter/preserveDump` setting is set to `true`, the crash report’s metadata will be modified to reflect that change so that another upload attempt is not made. ## Debugging Crashes ## Debugging Crashes Sometimes it is necessary to intentionally cause a crash multiple times in order to debug or triage it properly. For example, this might be done in order to try to determine crash reproduction steps. If the build it is being tested on has the crash reporter properly configured, this could result in a lot of extra crash dumps being uploaded and a lot of unnecessary work and noise being generated (ie: crash notifications, emails, extra similar crashes being reported, etc). In cases like this, it may be desirable to either not upload the crash report at all or at least mark the new crash(es) as “being debugged”. This can be done in one of a few ways: - Add a new metadata value to the crash report indicating that it is an intentional debugging step. This can be done for example with the command line option or config setting `--/crashreporter/data/debuggingCrash=1`. This is the preferred metadata key to use to indicate that crash debugging or triage is in progress. - Disable crash reporter uploads for the app build while testing. The easiest way to do this is to simply remove the upload URL setting. This can be done with a command line option such as `--/crashreporter/url=""`. This should override any settings stored in config files. - If the crash report itself is not interesting during debugging, the crash reporter plugin itself could just be disabled. This can be done with `--/crashreporter/enabled=false`. For situations where a command line option is difficult or impossible, there are also some environment variables that can be used to override certain aspects of the crash reporter’s behavior. Each of these environment variables has the same value requirements as the setting they override (ie: a boolean value is expected to be one of ‘0’, ‘1’, ‘n’, ‘N’, ‘y’, ‘Y’, ‘f’, ‘F’, ‘t’, or ‘T’). The environment variables and the settings they override are: - `OMNI_CRASHREPORTER_URL` will override the value of the `/crashreporter/url` setting. - `OMNI_CRASHREPORTER_ENABLED` will override the value of the `/crashreporter/enabled` setting. - `OMNI_CRASHREPORTER_SKIPOLDDUMPUPLOAD` will override the value of the `/crashreporter/skipOldDumpUpload` setting. - `OMNI_CRASHREPORTER_PRESERVEDUMP` will override the value of the `/crashreporter/preserveDump` setting. - `OMNI_CRASHREPORTER_DEBUGGERATTACHTIMEOUTMS` will override the value of the `/crashreporter/debuggerAttachTimeoutMs` setting. - `OMNI_CRASHREPORTER_CRASHREPORTBASEURL` will override the value of the `/crashreporter/crashReportBaseUrl` setting. It is highly recommended that these environment variable overrides only ever be used in situations where they are the only option. They should also only be used in the most direct way possible to ensure that they do not unintentionally affect the system globally, but only the single intended run of the Carbonite based app. Especially on Windows, environment variables will remain persistent in the terminal they are set in. On Linux, if possible new environment variables should be added to the start of the command line that launches the process being tested (ie: `OMNI_CRASHREPORTER_ENABLED=0 ./kit [<other_arguments>]`). ## Public Interfaces and Utilities Instead of being configured programmatically through an interface, all of the crash reporter’s configuration goes through the `carb::settings::ISettings` settings registry. Upon load of the plugin, the crash reporter plugin will start monitoring for changes in the `/crashreporter/` branch of the settings registry. As soon as any value in that branch changes, the crash reporter will be synchronously notified and will update its configuration. While the crash reporter is intended to be a service that largely works on its own, there are still some operations a host app can perform on it. These are outlined in the documentation for the `carb::crashreporter::ICrashReporter` interface. These operations include starting a task of trying to upload old crash report files, registering callback functions for any time a crash report upload completes, resolving addresses to symbols (for debug purposes only), and adding volatile metadata for the process. There are also some utility helper functions in the `carb::crashreporter` namespace that can simplify some operations such as adding new static metadata values or adding extra files to the crash report. The only set of functions that should be directly called from there are the `carb::crashreporter::addCrashMetaData()`, and `carb::crashreporter::addExtraCrashFile()`. Here are the two functions mentioned: 1. `carb::crashreporter::addExtraCrashFile()` 2. `carb::crashreporter::isExtraCrashFileKeyUsed()` ### Configuration Options The Carbonite crash reporter (`carb.crashreporter-breakpad.plugin`) has several configuration options that can be used to control its behavior. These are specified either in an app’s config file or on the command line. The following settings keys are defined: - `/crashreporter/url`: The URL to use when uploading crash report files. By default this will be an empty string. The URL is expected to be able to accept multipart form messages being posted to it. Many omniverse apps will be automatically configured to use the default upload URL of https://services.nvidia.com/submit using this setting. This can then be overridden on the command line or in a config file if needed. This setting is required in order for any uploads of crash reports to occur. This setting can be overridden with the environment variable `OMNI_CRASHREPORTER_URL`. - `/crashreporter/product`: Sets the name of the product for which crash reports will be generated. This setting is required in order for any uploads of crash reports to occur. This becomes the product name that is included with the crash report’s metadata. Without this metadata value set, the NVIDIA URL will reject the report files. This may be any string value, but should be descriptive enough of the name of the app that it can be distinguished from crash reports for other products. This defaults to an empty string. - `/crashreporter/version`: Sets the version information for the app. This setting is required in order for any uploads of crash reports to occur. This becomes the version information that is included with the crash report’s metadata. Without this metadata value set, the NVIDIA URL will reject the report files. This may be any string value, but should be descriptive enough of the version information of the crashing app that an investigation can be done on it. This defaults to an empty string. - `/crashreporter/dumpDir`: The full path to the location to write crash dump and metadata files to on the local machine. This will also be the location that old crash reports are uploaded from (if they exist) on subsequent runs of the app. This directory must already exist and will not be created by the crash reporter itself. By default this is the current working directory. - `/crashreporter/enabled`: Sets whether the crash reporter is enabled or not. By default, the crash reporter will be enabled on load of the plugin. This setting can change at any point during the process’ lifetime and it will be acted on immediately by the crash reporter. When the crash reporter is disabled, its exception/signal catching hooks will be removed. The plugin will remain loaded and functional, but no action will be taken if a crash does occur. When the crash reporter is enabled, the exception/signal catching hooks will be installed again. This defaults to `true`. - `/crashreporter/devOnlyOverridePrivacyAndForceUpload`: Sets whether crash report files should be uploaded after they are created. This can be used to override the user’s performance consent setting for the purposes of uploading a crash report if needed. If this is `false`, the user’s performance consent setting will control whether uploads are attempted. Note that this setting is effectively ignored if no upload URL has been set in `/crashreporter/url`. This defaults to `false`. This setting should _never_ be used in a released product. This is only intended for local debugging. - `/crashreporter/skipOldDumpUpload`: Indicates whether attempts to upload old crash report files should be skipped. This is useful for situations such as test apps or launching child instances of an app so that they don’t potentially end up blocking during shutdown due to an upload in progress. This defaults to `false`. This setting can be overridden with the environment variable `OMNI_CRASHREPORTER_SKIPOLDDUMPUPLOAD`. - `/crashreporter/log`: When enabled, this indicates whether a stack trace of the crashing thread should be written out to the app log. This will attempt to resolve the symbols on the call stack as best it can with the debugging information that is available. This defaults to `true`. - `/crashreporter/preserveDump`: When enabled, this indicates that crash report files that were successfully uploaded should not be deleted. This is useful in situations such as CI/CD so that any crash report files from a crashed process can be stored as job artifacts. This defaults to `false`. This setting can be overridden with the environment variable `OMNI_CRASHREPORTER_PRESERVEDUMP`. - `/crashreporter/data/`: [This line seems incomplete in the provided HTML] : Settings branch that may contain zero or more crash metadata key/value pairs. Any non-array setting created under this settings branch will be captured as metadata values for the process. These metadata values can be added at any point during runtime up until an actual crash occurs. These settings may also be provided on the command line or in config files if the metadata value is known at the time. A new metadata value can be added programmatically at runtime using the `carb::crashreporter::addCrashMetadata()` helper function. This defaults to an empty settings branch. <div class="admonition note"> <p class="admonition-title">Note</p> <p><strong>Care must be taken to ensure that no user or third party intellectual property information is included in a metadata value</strong>. This is always the responsibility of the app, plugin, extension, script, config file author, etc to ensure. It is acceptable to include user information for internal test runs, but this functionality or configuration may not be exposed to public end users.</p> </div> : Settings branch that may contain zero or more extra files that should be included in crash reports. Each key/value pair found in this settings branch will identify a new file to be included. The key is expected to be a descriptor of why the file is included. The value is expected to be the relative or absolute path to the file to be included. If a relative path is used, it is up to the app to guarantee that the current working directory that path is relative to will not be modified between when it is added and when a crash report is generated. It is highly suggested that absolute paths always be given to avoid this. Settings in this branch may be added, removed, or modified at any point during runtime up until an actual crash occurs. These settings may also be provided on the command line or in config files if the file name and path is known ahead of time (regardless of whether the file exists at the time). Any listed files that do not exist or are inaccessible at crash time will be silently ignored. A new extra file setting can be added programmatically using the `carb::crashreporter::addExtraCrashFile()` helper function. This default to an empty settings branch. <div class="admonition note"> <p class="admonition-title">Note</p> <p><strong>Care must be taken to ensure that no user or third party intellectual property information is included in any extra file that is sent with a crash report</strong>. This is always the responsibility of the app, plugin, extension, script, config file author, etc to ensure. It is acceptable to include user information for internal test runs, but this functionality or configuration may not be exposed to public end users.</p> </div> : Array setting to specify which metadata values should also be emitted as telemetry events. Each entry in the array is expected to be a regular expression describing the pattern to try to match each new metadata value to. Note that only new or modified metadata values will be reported as telemetry events once a specified pattern is added to the array. To capture all new metadata key/value pairs, these patterns should be specified either in a config file or on the command line. Note that this will not be able to capture any of the metadata values that are internally generated by the crash reporter since most of these internal metadata values are only given values at crash time. The patterns in this array may be changed at any point during runtime. However, if a pattern changes only new or modified metadata values after that point will be emitted as telemetry events. Only a single telemetry event will be emitted for each new or modified metadata value. If a piece of metadata is set again to its current value, no new event will be emitted. This defaults to an empty array. : Windows only. Provides a timeout in milliseconds that, when exceeded, will consider the upload as failed. This does not limit the actual amount of time that the upload takes due to a bug in `wininet`. Typically this value does not need to be changed. This defaults to 7,200,000ms (2 hours). : Determines the time in milliseconds to wait for a debugger to attach after a crash occurs. If this is a non-zero value, the crash report processing and upload will proceed once a debugger successfully attaches to the process or the given timeout expires. This is useful when trying to debug post-crash functionality since some debuggers don’t let the original exception go completely unhandled to the point where the crash reporter is allowed to handle it (ie: if attached before the crash). This setting defaults to 0ms meaning the wait is disabled. This setting can be overridden with the environment variable `OMNI_CRASHREPORTER_DEBUGGERATTACHTIMEOUTMS`. : Flags to control which data is written to the minidump file (on Windows). These can either be specified as a single hex value for all the flags to use (assuming the user knows what they are doing), or with MiniDump flag names separated by comma (‘,’), colon (‘:’), bar (‘\|’), or whitespace. There should be no whitespace between flags when specified on the command line. The ‘MiniDump’ prefix on each flag name may be omitted if desired. This defaults to an empty string (ie: no extra flags). The flags specified here may either override the default flags or be added to them depending on the value of `/crashreporter/overrideDefaultDumpFlags`. This setting is ignored on Linux. For more information on the flags and their values, look up `MiniDumpNormal` on MSDN or see a brief summary above at Loading a Crash Dump to Investigate. : Indicates whether the crash dump flags specified in `/crashreporter/dumpFlags` should replace the default crash dump flags (when `true`) or simply be added to the default flags (when `false`). This defaults to `false`. - This setting is ignored on Linux. - `/crashreporter/compressDumpFiles`: Indicates whether the crash report files should be compressed as zip files before uploading to the server. The compressed crash dump files are typically ~10% the size of the original, so upload time should be greatly reduced. This feature must be supported on the server side as well to be useful for upload. However, if this setting is enabled the crash reports will still be compressed locally on disk and will occupy less space should the initial upload fail. This defaults to `false`. - `/crashreporter/retryCount`: Determines the maximum number of times to try to upload any given crash report to the server. The number of times the upload has been retried for any given crash report is stored in its metadata. When the report files are first created, the retry count will be set to the 0. Each time the upload fails, the retry count will be incremented by one. When the count reaches this limit (or goes over it if it changes from the default), the dump file and its metadata will be deleted whether the upload succeeds or not. This defaults to 10. - `/crashreporter/crashReportBaseUrl`: The base URL to use to print a message after a successful crash report upload. This message will include a URL that is pieced together using this base URL followed by the ID of the crash report that was just sent. Note that this generated URL is just speculative however and may not be valid for some small amount of time after the crash report has been sent. This setting is optional and defaults to an empty string. This setting should only be used in situations where it will not result in the URL for an internal resource being baked into a setting in builds that will go out to public users. This setting can be overridden by the environment variable `OMNI_CRASHREPORTER_CRASHREPORTBASEURL`. - `/crashreporter/includeEnvironmentAsMetadata`: Determines whether the environment block should be included as crash report metadata. This environment block can be very large and potentially contain private information. When included, the environment block will be scrubbed of detectable user names. This defaults to `false`. - `/crashreporter/includePythonTraceback`: Attempts to gather a Python traceback using the py-spy tool, if available and packaged with the crash reporter. The output from this tool will be a separate file that is uploaded along with the crash dump, configured by `/crashreporter/pythonTracebackFile`. This defaults to `true`. - `/crashreporter/pythonTracebackBinary`: The binary to execute in order to capture a Python traceback. This allows the py-spy binary to exist under a different name if so desired. Defaults to `py-spy.exe` on Windows and `py-spy` on non-Windows. May include a relative (to application working directory) or absolute path. If no directory is provided, first the same directory as the crash reporter is checked, followed by application working directory. - `/crashreporter/pythonTracebackArgs`: Arguments that are passed to `/crashreporter/pythonTracebackBinary`. By default this is `dump --full-filenames --nonblocking --pid $pid` where `$pid` is a simple token that refers to the process ID of the crashing process. NOTE: py-spy will not work properly without at least these arguments, and overriding this key will replace these arguments, so these arguments should likely be included in your override. - `/crashreporter/pythonTracebackDir`: The directory where the Python traceback is stored. May be an absolute path, or relative to the working directory of the process at the time the crash reporter is loaded. May be changed dynamically. This has an empty default, which means to use the same directory as `dumpDir`. - `/crashreporter/pythonTracebackName`: The name of the Python traceback file. Any path separators are ignored. The default value is `$crashid.py.txt` where `$crashid` is a simple token that refers to the Crash ID of the crashing process–that is, the UUID generated by Breakpad at crash time. This file is created at crash time in the directory provided by `pythonTracebackDir` if `includePythonTraceback` is `true`. If the file cannot be created at crash time, no Python traceback file will be included. The simple token `$pid` is also available, which is the process ID of the crashing process. - PythonTracebackTimeoutMs : (default: 60000 [1 minute]) The time to wait (in milliseconds) for the Python-traceback process to run. If this time is exceeded, the process is terminated and no Python traceback will be available. - "/crashreporter/gatherUserStory" : (default: true) When a crash occurs, `carb.crashreporter-breakpad` has the ability to run a process that gathers information from the user, such as steps to reproduce the problem or what the user specifically did. This value can be set to false to prevent gathering this information. - "/crashreporter/userStoryBinary" : (default: crashreport.gui) The binary to execute to gather the crash user story. - "/crashreporter/userStoryArgs" : (default: --/app/crashId=$crashid --/app/allowUpload=$allowupload) Arguments passed to the binary when it is executed. - "/crashreporter/userStoryTimeoutMs" : (default: 600,000 [10 minutes]) The time to wait (in milliseconds) for the crash user story process to run. If this time is exceeded, the process is terminated and no crash user story will be available. ## Internally Created Crash Metadata The crash reporter plugin itself will create several crash metadata values on its own. Many of these metadata key names are considered ‘reserved’ as they are necessary for the functionality of the crash reporter and for categorizing crash reports once received. There are also some other crash metadata values that are created internally by either the crash reporter or kit-kernel that should not be replaced or modified by other plugins, extensions, or configuration options. Both groups are described below: ### Reserved Metadata Keys These key names are reserved by the crash reporter plugin. If an app attempts to set a metadata key under the `/crashreporter/data/` settings branch using one of these names, it will be ignored. Any Carbonite based app will get these metadata values. - ProductName : Collected by the crash reporter plugin on startup. This value comes from either the `/crashreporter/product` or `/app/name` setting (in that order of priority). - Version : Collected by the crash reporter plugin on startup. This value comes from either the `/crashreporter/version` or `/app/version` setting (in that order of priority). - comment : Currently unused and unassigned, but still left as a reserved metadata key name. - StartupTime : The time index at the point the crash reporter plugin was initialized. This will be expressed as the number of seconds since midnight GMT on January 1, 1970. - DumpId : Collected at crash time by the crash reporter plugin. This is a UUID that is generated to ensure the generated crash report is unique. This ID is used to uniquely identify the crash report on any crash tracking system. - CarbSdkVersion : Currently unused and unassigned, but still left as a reserved metadata key name. This named value is currently expressed through the `carboniteSdkVersion` metadata value. - RetryCount : The number of retries that should be attempted to upload any crash report that is generated. This defaults to 0 and will be incremented with each failed attempt to upload the report. The default limit for this value is 10 attempts but can be modified with the `/crashreporter/retryCount` setting. - UploadSuccessful : Set to ‘1’ for a given crash report when it has been successfully uploaded. This value defaults to ‘0’. This value will always be ‘0’ locally and on any crash report management system except in the case where the `/crashreporter/preserveDump` setting is enabled. - PythonTracebackStatus : Set to a status message indicating whether gathering the Python stack trace was successful or why it failed or was skipped. - CrashTime : An RFC3339 GMT timestamp expressing when a given crash occurred. - UserStory : The message entered into the ‘user story’ dialog by the user before uploading a crash # Report ## User Story Metadata - UserStory : This defaults to an empty string and will only be filled in if the `/crashreporter/gatherUserStory` setting is enabled and the user enters text. - UserStoryStatus : Set to a status message indicating whether gathering the user story was successful or why it failed or was cancelled. - LastUploadStatus : Set to the HTTP status code of the last crash report upload attempt for a given report. This is only checked on attempting to upload a previously failed upload attempt. ## Additional Metadata Collected at Crash Time - UptimeSeconds : The total number of seconds that the process ran for. This value is written when the crash report is first generated. - telemetrySessionId : The telemetry session ID for the process. This is used to link the crash report to all telemetry events for the session. - memoryStats : System memory usage information at crash time. This includes available and total system RAM, swap file, and virtual memory (VM) amounts for the process. - workingDirectory : The current working directory for the process at the time of the crash. This value will be scrubbed to not include any user names if found. - hangDetected : Set to ‘1’ if a hang is detected and that leads to an intentional crash. - crashingThread : Set to the ID of the thread that was presumably detected as hung by the Kit hang detector. Currently this will always be the process’ main thread. - crashingIntentionallyDueTo : Set to a reason message for why an intentional crash occurred. This is only present if the crash was intentional and not the result of a program malfunction or bug. ## Metadata Collected on Crash Reporter Startup - commandLine : The full command line that was used to launch the process. This will be scrubbed for user names before being added. - environment : Lists all environment variables present at process launch time. This metadata value is disabled by default but can be enabled with the `/crashreporter/includeEnvironmentAsMetadata` setting. All environment variables will be scrubbed for user names before being added as metadata. - runningInContainer : Boolean indicating if the process is running in a container. ## Metadata Collected on Kit-Kernel Startup - environmentName : The runtime environment the app is currently running in. This will either be the name of any detected CI/CD system (ie: TeamCity, GitLab, etc), or ‘default’ if none is detected. This will also be modified later by the `omni.kit.telemetry` extension to be set to either ‘Individual’, ‘Enterprise’, or ‘Cloud’ if it was previously set to ‘default’. - appState : Set to either ‘startup’, ‘started’, or ‘shutdown’ depending on which stage of the kit-kernel life cycle the process is currently in. - carboniteSdkVersion : The version of the Carbonite SDK that is in use. - carboniteFrameworkVersion : The version of the Carbonite framework that is in use. - appName : The name of the app that is currently running. - appVersion : The version of the app that is currently running. - portableMode : Set to ‘1’ if the `--portable` and - `--portable-root`: command line options are used or a portable root is implicitly setup in a local developer build. Set to ‘0’ otherwise. - `email`: Set to the user’s email address as reported in their `privacy.toml` file. Note that this value will not be present in `privacy.toml` for public users. - `userId`: Set to the user’s ID as reported in their `privacy.toml` file. Note that this metadata value will not be set for public users. ### CI/CD Related Metadata These metadata values are detected on crash reporter from various environment variables that common CI/CD systems export for all of their jobs. Currently this only supports TeamCity and GitLab. Any Carbonite based app will get these metadata values. - `crashingJobId`: The CI/CD specific identifier of the running job that crashed. - `crashingJobName`: The name of the CI/CD job that crashed. - `projectName`: The name of the project the crashing CI/CD job belongs to. - `crashingJobUrl`: The URL to the status page for the crashing CI/CD job. - `commitAuthor`: The author of the top commit for the crashing CI/CD job. This is only available for GitLab pipeline jobs. - `commitHash`: The hash of the top commit for the crashing CI/CD job. This is only available for GitLab pipeline jobs. - `commitTimestamp`: The timestamp of the top commit for the crashing CI/CD job. This is only available for GitLab pipeline jobs. - `crashingPipelineUrl`: The URL to the status page for the pipeline that the crashing CI/CD job is running under. This is only available for GitLab pipeline jobs. - `crashingPipelineName`: The name of the pipeline that the crashing CI/CD job is running under. This is only available for GitLab pipeline jobs. - `crashingPipelineId`: The ID of the pipeline that the crashing CI/CD job is running under. This is only available for GitLab pipeline jobs. - `ciEnvironment`: The name of the CI/CD environment that was detected. - `teamcity_run`: Set to ‘true’ if the crash occurred during a job run on TeamCity. - `teamcity_build_number`: The build number of the TeamCity job that crashed. - `teamcity_project_name`: The name of the project that the crashing TeamCity job belongs to. - `teamcity_buildconf_name`: The build configuration name of the project that the crashing TeamCity job belongs to. ### Metadata Added From Assertion Failures These metadata values are only added when a `CARB_ASSERT()`, `CARB_CHECK()`, or `CARB_FATAL_UNLESS()` test fails. These provide information on why the process aborted due to a failed assertion that was not caught and continued by a debugger. Any Carbonite based app will get these metadata values. - `assertionCausedCrash`: Set to ‘true’ if the crash was caused by a failed assertion. This value is not present otherwise. - `assertionCount`: Set to the number of assertions that had failed for the process. For most situations this will just be set to ‘1’. However, it is possible to continue from a failed assertion under a debugger at least so this could be larger than 1 if a developer continued from multiple assertions before finally crashing. - `lastAssertionCondition`: The text of the assertion condition that failed. This will not include any values of any variables mentioned in the condition however. - `lastAssertionFile`: The name and path of the source file the assertion failed in. ## Assertion Failure Metadata - lastAssertionFunc: The name of the function the assertion failed in. - lastAssertionLine: The source code line number of the failed assertion. ## Metadata Added When Extensions Load These metadata values are added by the extension loading plugin in Kit-kernel. These will be present only in certain situations in Kit based apps. Any Kit based app will get these metadata values. - extraExts: Set to the list of extensions that the user has explicitly installed or toggled on or off during the session. This is done through the extension manager window in Kit apps. Extension names will be removed from this list any time an extension is explicitly unloaded by the user at runtime. - autoloadExts: Set to the list of extensions that the user has explicitly marked for ‘auto-load’ in the Kit extension manager window. This value will only be written out once on startup.
create-a-material-and-bind-to-world-plane-method-1_Overview.md	# Overview — Omniverse Kit 1.4.2 documentation ## Overview omni.kit.material.library is library of python functions for materials. Provides simple interface with hydra and neuraylib low level extensions, for creating materials as prims, binding materials to “bindable” prims, material UI, material “Create” menus, material preferences and much more. ### Examples #### Create a material. ```python import omni.kit.material.library # Create a Shader omni.kit.commands.execute('CreateAndBindMdlMaterialFromLibrary', mdl_name='OmniPBR.mdl', mtl_name='OmniPBR') ``` #### Create a material and bind to /World/Plane, method 1. ```python import omni.kit.material.library from pxr import Usd prim_path = "/World/Plane" prim_name = "testplane" # Create a Plane Prim omni.kit.commands.execute('CreatePrimWithDefaultXform', prim_type='Plane', prim_path=prim_path) # Select the Plane omni.kit.commands.execute('SelectPrims', old_selected_paths=[''], new_selected_paths=[prim_path], expand_in_stage=True) # Create a Shader omni.kit.commands.execute('CreateAndBindMdlMaterialFromLibrary', mdl_name='OmniPBR.mdl', mtl_name='OmniPBR', prim_name=prim_name, mtl_created_list=None, bind_selected_prims=True) ``` #### Create a material and bind to /World/Plane, method 2 ```python import omni.kit.material.library # (Code example continues here) ``` ```python from pxr import Usd, UsdShade prim_path = "/World/Plane" prim_name = "testplane" # Create a Plane Prim omni.kit.commands.execute('CreatePrimWithDefaultXform', prim_type='Plane', prim_path=prim_path) # Select the Plane omni.kit.commands.execute('SelectPrims', old_selected_paths=[''], new_selected_paths=[prim_path], expand_in_stage=True) # Create a Shader mtl_created_list = [] omni.kit.commands.execute('CreateAndBindMdlMaterialFromLibrary', mdl_name='OmniPBR.mdl', mtl_name='OmniPBR', mtl_created_list=mtl_created_list) # Bind material to prim omni.kit.commands.execute("BindMaterial", prim_path=[prim_path], material_path=mtl_created_list[0], strength=UsdShade.Tokens.weakerThanDescendants) ``` ## Create a material and modify created material. This can be a problem as just creating the material doesn’t mean its Usd.Attribute’s are immediately accessible. Created materials inputs/outputs then have to be “loaded” into Usd.Prim, so to work around this use on_created_fn callback. NOTE: Materials loaded via a .usd file will also not have the Usd.Attribute immediately accessible. Selecting the prim triggers ```python omni.usd.get_context().load_mdl_parameters_for_prim_async() ``` todo this. ```python import omni.kit.material.library from pxr import Usd # Created material callback async def on_created(shader_prim: Usd.Prim): shader_prim.GetAttribute("inputs:diffuse_texture").Set("./test.png") # Create a Shader omni.kit.commands.execute('CreateAndBindMdlMaterialFromLibrary', mdl_name='OmniPBR.mdl', mtl_name='OmniPBR', on_created_fn=lambda p: asyncio.ensure_future(on_created(p))) ``` ## Get SubIds from material ```python import asyncio import carb import omni.kit.material.library async def get_subs_ids(): mdl_path = carb.tokens.get_tokens_interface().resolve("${kit}/mdl/core/Base/OmniHairPresets.mdl") subid_list = await omni.kit.material.library.get_subidentifier_from_mdl(mdl_file=mdl_path) print(f"subid_list:{subid_list}") asyncio.ensure_future(get_subs_ids()) ``` ## Get SubIds from material using callback ```python import asyncio import carb import omni.kit.material.library def have_subids(id_list): print(f"id_list:{id_list}") mdl_path = carb.tokens.get_tokens_interface().resolve("${kit}/mdl/core/Base/OmniHairPresets.mdl") ``` ```python asyncio.ensure_future(omni.kit.material.library.get_subidentifier_from_mdl(mdl_file=mdl_path, on_complete_fn=have_subids)) ```
create-a-material-and-bind-to-world-plane-method-2_Overview.md	# Overview ## Extension : omni.kit.material.library-1.4.2 ## Documentation Generated : May 08, 2024 ## Overview omni.kit.material.library is library of python functions for materials. Provides simple interface with hydra and neuraylib low level extensions, for creating materials as prims, binding materials to “bindable” prims, material UI, material “Create” menus, material preferences and much more. ## Examples ### Create a material ```python import omni.kit.material.library # Create a Shader omni.kit.commands.execute('CreateAndBindMdlMaterialFromLibrary', mdl_name='OmniPBR.mdl', mtl_name='OmniPBR') ``` ### Create a material and bind to /World/Plane, method 1 ```python import omni.kit.material.library from pxr import Usd prim_path = "/World/Plane" prim_name = "testplane" # Create a Plane Prim omni.kit.commands.execute('CreatePrimWithDefaultXform', prim_type='Plane', prim_path=prim_path) # Select the Plane omni.kit.commands.execute('SelectPrims', old_selected_paths=[''], new_selected_paths=[prim_path], expand_in_stage=True) # Create a Shader omni.kit.commands.execute('CreateAndBindMdlMaterialFromLibrary', mdl_name='OmniPBR.mdl', mtl_name='OmniPBR', prim_name=prim_name, mtl_created_list=None, bind_selected_prims=True) ``` ### Create a material and bind to /World/Plane, method 2 ```python import omni.kit.material.library # (Code here would be similar to method 1, but with different parameters or steps) ``` ```python from pxr import Usd, UsdShade prim_path = "/World/Plane" prim_name = "testplane" # Create a Plane Prim omni.kit.commands.execute('CreatePrimWithDefaultXform', prim_type='Plane', prim_path=prim_path) # Select the Plane omni.kit.commands.execute('SelectPrims', old_selected_paths=[''], new_selected_paths=[prim_path], expand_in_stage=True) # Create a Shader mtl_created_list = [] omni.kit.commands.execute('CreateAndBindMdlMaterialFromLibrary', mdl_name='OmniPBR.mdl', mtl_name='OmniPBR', mtl_created_list=mtl_created_list) # Bind material to prim omni.kit.commands.execute("BindMaterial", prim_path=[prim_path], material_path=mtl_created_list[0], strength=UsdShade.Tokens.weakerThanDescendants) ``` ## Create a material and modify created material. This can be a problem as just creating the material doesn’t mean its Usd.Attribute’s are immediately accessible. Created materials inputs/outputs then have to be “loaded” into Usd.Prim, so to work around this use on_created_fn callback. NOTE: Materials loaded via a .usd file will also not have the Usd.Attribute immediately accessible. Selecting the prim triggers ```python omni.usd.get_context().load_mdl_parameters_for_prim_async() ``` todo this. ```python import omni.kit.material.library from pxr import Usd # Created material callback async def on_created(shader_prim: Usd.Prim): shader_prim.GetAttribute("inputs:diffuse_texture").Set("./test.png") # Create a Shader omni.kit.commands.execute('CreateAndBindMdlMaterialFromLibrary', mdl_name='OmniPBR.mdl', mtl_name='OmniPBR', on_created_fn=lambda p: asyncio.ensure_future(on_created(p))) ``` ## Get SubIds from material ```python import asyncio import carb import omni.kit.material.library async def get_subs_ids(): mdl_path = carb.tokens.get_tokens_interface().resolve("${kit}/mdl/core/Base/OmniHairPresets.mdl") subid_list = await omni.kit.material.library.get_subidentifier_from_mdl(mdl_file=mdl_path) print(f"subid_list:{subid_list}") asyncio.ensure_future(get_subs_ids()) ``` ## Get SubIds from material using callback ```python import asyncio import carb import omni.kit.material.library def have_subids(id_list): print(f"id_list:{id_list}") mdl_path = carb.tokens.get_tokens_interface().resolve("${kit}/mdl/core/Base/OmniHairPresets.mdl") ``` ```python asyncio.ensure_future(omni.kit.material.library.get_subidentifier_from_mdl(mdl_file=mdl_path, on_complete_fn=have_subids)) ```
create-a-material-and-modify-created-material_Overview.md	# Overview — Omniverse Kit 1.4.2 documentation ## Overview omni.kit.material.library is library of python functions for materials. Provides simple interface with hydra and neuraylib low level extensions, for creating materials as prims, binding materials to “bindable” prims, material UI, material “Create” menus, material preferences and much more. ### Examples #### Create a material ```python import omni.kit.material.library # Create a Shader omni.kit.commands.execute('CreateAndBindMdlMaterialFromLibrary', mdl_name='OmniPBR.mdl', mtl_name='OmniPBR') ``` #### Create a material and bind to /World/Plane, method 1 ```python import omni.kit.material.library from pxr import Usd prim_path = "/World/Plane" prim_name = "testplane" # Create a Plane Prim omni.kit.commands.execute('CreatePrimWithDefaultXform', prim_type='Plane', prim_path=prim_path) # Select the Plane omni.kit.commands.execute('SelectPrims', old_selected_paths=[''], new_selected_paths=[prim_path], expand_in_stage=True) # Create a Shader omni.kit.commands.execute('CreateAndBindMdlMaterialFromLibrary', mdl_name='OmniPBR.mdl', mtl_name='OmniPBR', prim_name=prim_name, mtl_created_list=None, bind_selected_prims=True) ``` #### Create a material and bind to /World/Plane, method 2 ```python import omni.kit.material.library # (Code snippet for method 2 would be here if provided in the HTML) ``` ```python asyncio.ensure_future(omni.kit.material.library.get_subidentifier_from_mdl(mdl_file=mdl_path, on_complete_fn=have_subids)) ```
create-an-extension_create_from_usd_explorer.md	# Develop a USD Explorer App ## Important The Omniverse USD Explorer Application is composed of many curated Extensions from Kit SDK. These have been been through quality control to ensure they work together in concert with the specific settings of the USD Explorer Application. In this tutorial, we encourage developers to explore using all Extensions available on the platform; however, it’s important to recognize the need to scrutinize any new Application based on the example. Adding existing Extensions, adding new Extensions, and changing settings are all reasons to do careful quality control of the new app if it is to be used for production. ## This section covers: - Customizing the Application through settings. - Adding new functionality by creating a new Python Extension. - Hot loading Python code changes in the app. - Adding a menu item to reveal a window. - Connect VSCode to the app for debugging Python code. - Write tests that simulate user interactions. - How to develop Applications for Omniverse Cloud. ## Setup a New App This project provides an `omni.usd_explorer.kit` file as an example of a feature-rich Application. Let’s duplicate the `omni.usd_explorer.kit` app and the associated `omni.usd_explorer.setup` Extension. You could also just rename the existing files - but duplicating them allows keeping an original around for reference. ### Duplicate Files 1. Duplicate `.\source\apps\omni.usd_explorer.kit`. Name the new file `my_company.usd_explorer.kit`. 2. Duplicate directory `.\source\extensions\omni.usd_explorer.setup`. Name the new directory `my_company.usd_explorer.setup`. 3. Rename the `omni` folder in `.\source\extensions\my_company.usd_explorer.setup\`. 1. Replace `omni` with `my_company` in the following code blocks: - From ``` <span class="pre"> omni </span> ``` to ``` <span class="pre"> my_company </span> ``` - Replace ``` <span class="pre"> omni.usd_explorer.setup </span> ``` within the new files with ``` <span class="pre"> my_company.usd_explorer.setup </span> ``` - In VSCode, use ``` <span class="pre"> Edit </span> ``` > ``` <span class="pre"> Replace </span> <span class="pre"> in </span> <span class="pre"> Files </span> ``` - For each entry in ``` <span class="pre"> my_company.usd_explorer.kit </span> ``` and entries in the ``` <span class="pre"> my_company.usd_explorer.setup </span> ``` directory use the ``` <span class="pre"> Replace </span> ``` button. - In ``` <span class="pre"> .\my_company.usd_explorer.setup\premake5.lua </span> ``` , change ``` <span class="pre"> repo_build.prebuild_link </span> <span class="pre"> { </span> <span class="pre"> "omni", </span> <span class="pre"> ext.target_dir.."/omni" </span> <span class="pre"> } </span> ``` to ``` <span class="pre"> repo_build.prebuild_link </span> <span class="pre"> { </span> <span class="pre"> "my_company", </span> <span class="pre"> ext.target_dir.."/my_company" </span> <span class="pre"> } </span> ``` 2. Configure build tool to recognize the new Application. - Open ``` <span class="pre"> .\kit-app-template\premake5.lua </span> ``` - Find the section ``` <span class="pre"> -- </span> <span class="pre"> Apps: </span> ``` - Add an entry for the new app: ``` <span class="pre"> define_app("my_company.usd_explorer") </span> ``` . Optionally remove the entry ``` <span class="pre"> define_app("omni.usd_explorer") </span> ``` . 3. Build & Verify - Run a build and verify that the new Application works by starting it: - Windows: ``` <span class="pre"> .\_build\windows-x86_64\release\my_company.usd_explorer.bat </span> ``` - Linux: ``` <span class="pre"> ./_build/linux-x86_64/release/my_company.usd_explorer.sh </span> ``` - Note: The first time the Application launches it could take a while. In the shell, you’ll eventually see ``` <span class="pre"> RTX </span> <span class="pre"> ready </span> ``` - this is when the app is done initializing. - Important: If you accidentally missed a step and the build fails, or if there are errors finding ``` <span class="pre"> my_company.usd_explorer.setup </span> ``` Extension on startup: - Make any necessary changes in ``` <span class="pre"> .\source </span> ``` - Remove ``` <span class="pre"> _build </span> ``` directory with command ``` <span class="pre"> build </span> <span class="pre"> -c </span> ``` or delete the directory manually. - Run a new build. 4. Customize App via Settings - We’ve established that the ``` <span class="pre"> [settings] </span> ``` section of a kit file allows a low code approach to change the behavior of an Extension. But how do you know what settings are available to begin with? Let’s use the ``` <span class="pre"> Debug </span> <span class="pre"> Settings </span> ``` Extension and do some customizations of the app. # Example: Title Bar (Windows only) The title bar Extension is at this writing a Windows-only feature. It creates a custom title bar for the Application where icon, font styles, title etc can be customized via settings. ## Explore Extension Settings 1. Run the app again. 2. Close the `WELCOME TO OMNIVERSE` window. 3. Search for `omni.kit.window.modifier.titlebar` within the `Debug Settings` window and open the `exts` section. Now you can explore the various settings for the Extension. 4. In `my_company.usd_explorer.kit`, search for `[settings.exts."omni.kit.window.modifier.titlebar"]`. ```toml [settings.exts."omni.kit.window.modifier.titlebar"] titleFormatString = " USD EXPLORER {verKey:/app/version,font_color=0x909090} {separator} {file, board=true}" showFileFullPath = true icon.file = "${my_company.usd_explorer.setup}/data/nvidia-omniverse-usd_explorer.ico" icon.size = 18 icon.use_size = true defaultFont.size = 18 defaultFont.color = 0xD0D0D0 ... ``` 1. Now you are able to change for example the title from `USD EXPLORER to MY COMPANY USD EXPLORER` within the `titleFormatString` setting. 2. Observe how resources are referenced by the `icon.file` setting: `${my_company.usd_explorer.setup}` is the root directory of the given Extension and `/data/nvidia-omniverse-usd_explorer.ico` is the file being referenced from within that Extension. Feel free to change that icon but be sure to keep the same resolution. If a path needs to be relative to the app - the `.kit` file - then use `${app}`. 3. Run the app to see changes. # Example: Asset Browser (Windows & Linux) The [Asset Browser](https://docs.omniverse.nvidia.com/extensions/latest/ext_browser-extensions/asset-browser.html) Extension presents files from a list of locations - providing end users with intuitive access to content libraries. Customization of the location list can easily be done via a .kit file. ## Explore Extension Settings ## Run the App 1. Run the app again. 2. Close the `WELCOME TO OMNIVERSE` window. 3. Search for `omni.kit.browser.asset` within the `Debug Settings` window and open the `exts` section to see settings used by the Extension. Here we see that the `omni.kit.browser.asset.folders` setting provides a list of locations. ## Edit Extension Settings In `my_company.usd_explorer.kit`, find the settings line that starts with `"omni.kit.browser.asset".folders`. Add a local folder - or some Nucleus directory - that has some USD files in it - here’s an example adding a `My Company Assets` directory to the list: ### Windows: ```toml "omni.kit.browser.asset".folders = [ "http://omniverse-content-production.s3-us-west-2.amazonaws.com/Assets/Vegetation", "http://omniverse-content-production.s3-us-west-2.amazonaws.com/Assets/ArchVis/Commercial", "http://omniverse-content-production.s3-us-west-2.amazonaws.com/Assets/ArchVis/Industrial", "http://omniverse-content-production.s3-us-west-2.amazonaws.com/Assets/ArchVis/Residential", "C:/My Company Assets", ] ``` ### Linux: ```toml "omni.kit.browser.asset".folders = [ "http://omniverse-content-production.s3-us-west-2.amazonaws.com/Assets/Vegetation", "http://omniverse-content-production.s3-us-west-2.amazonaws.com/Assets/ArchVis/Commercial", "http://omniverse-content-production.s3-us-west-2.amazonaws.com/Assets/ArchVis/Industrial", "http://omniverse-content-production.s3-us-west-2.amazonaws.com/Assets/ArchVis/Residential", "/home/my_username/My Company Assets", ] ``` 4. Run the app and switch to the `Layout` mode. 5. Select the `NVIDIA Assets browser` - the folder you added is now listed on the left. Observe just how easy it was to change the behavior of the Asset Browser. Keep this in mind when you create Extensions of your own: expose configurable settings where appropriate. Think of the settings as part of the public API of the Extension. ## Create an Extension Adding functionality to Applications - beyond what is available in existing Extensions - is done by creating new Extensions. Here we’ll create a new Extension and use it in the app. 1. Create a new Extension using `repo template new` command (command cheat-sheet). - For `What do you want to add` choose `extension`. - For `Choose a template` choose `python-extension-window`. - Enter name `my_company.usd_explorer.tutorial`. - Leave version as `0.1.0`. - The new Extension is created in `.\source\extensions\my_company.usd_explorer.tutorial`. The added Extension has this directory structure: ``` ```toml # Extension root directory my_company.usd_explorer.tutorial config # `extension.toml` is the equivalence of an Application .kit file. # This is where package metadata, dependencies and settings are managed. extension.toml # The `data` folder contains resources. At this point it contains some images # used to display the Extension in the Extension Manager. data icon.png preview.png # The `docs` folder contains both the `CHANGELOG.md` and files for building docs. docs CHANGELOG.md Overview.md README.md my_company usd_explorer tutorial tests # A sample of Python files for tests. # These are configured to be used only when the Application runs # in `test` mode. __init__.py test_window.py # These are the Python modules used by the Application. # The directory can have as many files as needed - and subdirectories. __init__.py python_ext.py # `premake5.lua` makes the build process recognize and build the Extension. # Without this file nothing inside the my_company.usd_explorer.tutorial directory # is included in the build. premake5.lua ``` Let’s add the Extension to the app: 1. In `my_company.usd_explorer.kit`, add `"my_company.usd_explorer.tutorial" = {}` in the `[dependencies]` section. 2. Do a build. 3. Run the app again. 4. Close the `WELCOME TO OMNIVERSE` window so the `My Window` can be seen. Hot Loading Python Code Changes ============================== 1. If you closed the app, start it up again and make sure the added window is visible. 2. Open `python_ext.py` from `.\source\extensions\my_company.usd_explorer.tutorial\my_company\usd_explorer\tutorial`. 3. Change one of the button labels; for example, change `ui.Button("Add", clicked_fn=on_click)` to `ui.Button("Increase", clicked_fn=on_click)`. 4. Save the file and look at what happened to the button in the Application. It was updated. NOTE: When working with Python Extensions it is possible to leave the Application running when smaller changes are made to the source code. This immediate feedback can be rather useful when making iterative changes. Show Window from a Menu ======================= Change the contents of `python_ext.py` </code> to the below. This will create a ```code``` My Company Window ```code``` omni.ui.MenuItem inside the already existing ```code``` Window ```code``` menu for showing the new window. Note that we’re renaming the window from ```code``` My Window ```code``` to ```code``` My Company Window ```code``` . ```c++ import omni.ext.omni.ui as ui import omni.kit.ui # Functions and vars are available to other Extension as usual in python: `example.python_ext.some_public_function(x)` def some_public_function(x: int): print(f"[omni.hello.world] some_public_function was called with {x}") return x x # Any class derived from `omni.ext.IExt` in top level module (defined in `python.modules` of `extension.toml`) will be # instantiated when Extension gets enabled and `on_startup(ext_id)` will be called. Later when Extension gets disabled # on_shutdown() is called. class MyExtension(omni.ext.IExt): # ext_id is current Extension id. It can be used with Extension manager to query additional information, like where # this Extension is located on filesystem. def on_startup(self, ext_id): # Initialize some properties self._count = 0 self._window = None self._menu = None # Create a menu item inside the already existing "Window" menu. editor_menu = omni.kit.ui.get_editor_menu() if editor_menu: self._menu = editor_menu.add_item("Window/My Company Window", self.show_window, toggle=True, value=False) def on_shutdown(self): self._window = None self._menu = None def show_window(self, menu_path: str, visible: bool): if visible: # Create window self._window = ui.Window("My Company Window", width=300, height=300) with self._window.frame: with ui.VStack(): label = ui.Label("") def on_click(): self._count += 1 label.text = f"count: {self._count}" ``` ```python def on_reset(): self._count = 0 label.text = "empty" on_reset() with ui.HStack(): ui.Button("Add", clicked_fn=on_click) ui.Button("Reset", clicked_fn=on_reset) self._window.set_visibility_changed_fn(self._visiblity_changed_fn) elif self._window: # Remove window self._window = None self._count = 0 editor_menu = omni.kit.ui.get_editor_menu() if editor_menu: editor_menu.set_value("Window/My Company Window", visible) def _visiblity_changed_fn(self, visible): editor_menu = omni.kit.ui.get_editor_menu() if editor_menu: # Toggle the checked state of the menu item editor_menu.set_value("Window/My Company Window", visible) ``` ## Review 1. Run the Application again. 2. Close the `WELCOME TO OMNIVERSE` window. 3. Click the `Layout` tab. 4. Open the new window from `Window` > `My Company Window`. ## Debug Code Let’s use the tutorial Extension to explore how to debug Python Extensions running in an App. Kit SDK provides `omni.kit.debug.vscode` that enables Visual Studio Code to attach to a Kit process. Let’s use this Extension and trigger a breakpoint when using the `Add` button in our window. ### Visual Studio Code Setup The project includes a `.\.vscode\launch.json` file which is a configuration for connecting with the debugger. Note the `port` number `3000`: this is the default port used by `omni.kit.debug.vscode`. ```json { // Use IntelliSense to learn about possible attributes. // Hover to view descriptions of existing attributes. // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387 "version": "0.2.0", "configurations": [ { "name": "Python: Remote Attach", "type": "python", ... } ] } ``` # Application Setup Add ``` ``` "omni.kit.debug.vscode" = {} ``` ``` to the dependencies section of the ``` ``` my_company.usd_explorer.kit ``` ``` . # Attach & Debug 1. Run the ``` ``` my_company.usd_explorer ``` ``` app. 2. Note the ``` ``` VS Code Link ``` ``` window. 3. Return to VSCode. 1. Click the ``` ``` Run and Debug ``` ``` button on the left toolbar. 2. Select the ``` ``` Python: Remote Attach ``` ``` option - as named in the above ``` ``` launch.json ``` ``` : ``` ``` "name": "Python: Remote Attach" ``` ``` . 3. Now click the button to run in debug mode. 4. Return to the ``` ``` my_company.usd_explorer ``` ``` app and note that the debugger is attached. 5. Open ``` ``` ".\my_company.usd_explorer.tutorial\my_company\usd_explorer\tutorial\python_ext.py ``` ``` and set a breakpoint inside the ``` ``` on_click() ``` ``` method. 6. Bring up the ``` ``` My Company Window ``` ``` in the app and click on the ``` ``` Add ``` ``` button. The breakpoint in VS Code should be triggered at this point. Observe that the Python file in VSCode is the file in the ``` ``` _build ``` ``` directory: you set the breakpoint on the source file and the breakpoint triggers within the build files. Be sure to remove the ``` ``` omni.kit.debug.vscode ``` ``` dependency from the app when you are done debugging. # Test Now that we know the Extensions works we want to keep it that way. Kit SDK provides a framework for running tests that assert functionalities as Applications and Extensions are improved with more and more functionality. my_company.usd_explorer.tutorial's `extension.toml` file has a section where additional dependencies can be added for when tests run. ```toml [[test]] # Extra dependencies only to be used during test run dependencies = [ "omni.kit.ui_test" # UI testing Extension ] ``` The `omni.kit.test` Extension which provides the foundation for running tests does not need to be added as a dependency because it is added to the executables by the build process. We added `omni.kit.ui_test` because it enables using the UI in tests. The Extension’s `test_window.py` module contains the tests: - It imports modules from within the Extension. - Function `test_hello_public_function` is an example of asserting a method on a module. - Function `test_window_button` is an example of including UI elements in a test. Buttons are found by their UI path and then button clicks are simulated. ## Run Test The `.\_build\windows-x86_64\release` directory contains a number of bat files for testing Extensions and Applications. To run the test of this specific Extension run the `tests-my_company.usd_explorer.tutorial.bat` file inside of a command line to see the output. ## Adjust the Test Note that the test fails because it can’t find the UI elements. That’s because we changed the UI behavior: the `My Company Window` window does not open automatically. We need to simulate a user opening the window in order for the UI elements to be found: Edit the `extension.toml`’s `[[test]]` section by adding `omni.app.setup` as a dependency. This allows the menu to appear just like it would when the Extension is part of an Application. ```toml [[test]] # Extra dependencies only to be used during test run dependencies = [ "omni.app.setup", "omni.kit.ui_test" # UI testing Extension ] ``` Also in the `[[test]]` section, comment out the `--no-window` line. This will allow you to see the UI when running the test. ```toml args = [ "--/app/window/dpiScaleOverride=1.0", "--/app/window/scaleToMonitor=false", # "--no-window" ] ``` In `test_window.py`, add `await ui_test.menu_click("Window/My Company Window")` at the beginning of the `test_window_button` method. This simulates a user showing the window. ```python async def test_window_button(self): # Simulate user clicking menuitem to show window await ui_test.menu_click("Window/My Company Window") ``` Continue adjusting `test_window.py` by changing the UI paths starting with `My Window/`: set to `My Company Window/` instead. ```python # Find a label in our window label = ui_test.find("My Company Window//Frame//Label[]") ``` # Find buttons in our window add_button = ui_test.find("My Company Window//Frame//Button[].text=='Add'") reset_button = ui_test.find("My Company Window//Frame/*/Button[].text=='Reset'") Run the test again. Notice how the menu is clicked - and the test is successful again. As additional functionality is added to the Extension, more tests can be added to make sure manual QA can be kept to a minimum. Test coverage can be reported as part of running the test by passing the ``` ``` --coverage ``` ``` argument to the executable: ``` ``` tests-my_company.usd_explorer.tutorial.bat --coverage ``` ``` . Note that ``` ``` --coverage ``` ``` should only be used for individual Extensions - not Applications. Read more about code coverage. ::: note Note Reference: omni.kit.test Reference: omni.kit.ui_test Reference: Python Test Reference: C++ Test ::: ## Develop for Omniverse Cloud If you are not familiar with Omniverse Cloud then you can read more here and revisit this section in the future. In the above steps you worked with the ``` omni.usd_explorer.kit ``` file as a starting point. You may have noticed the neighboring ``` omni.usd_explorer.ovc.kit ``` file. The latter is a file to use when you plan for an app to run on Omniverse Cloud (OVC). Applications streamed from OVC are very similar to Applications that run on workstations. There are some small but necessary differences in settings mostly. Observe that ``` omni.usd_explorer ``` is a dependency inside ``` omni.usd_explorer.ovc.kit ``` . The “ovc” app is composed with the “base”: ```toml [dependencies] # the base App "omni.usd_explorer" = {} ``` If you wanted to develop a ``` my_company.usd_explorer ``` app for OVC you would: 1. Duplicate the ``` omni.usd_explorer.ovc.kit ``` and name it ``` my_company.usd_explorer.ovc.kit ``` . 2. In ``` my_company.usd_explorer.ovc.kit ``` , change the dependency ``` "omni.usd_explorer" = {} ``` to ``` "my_company.usd_explorer" = {} ``` . 3. Change the ``` [settings.app.extensions] ``` section to: ```toml [settings.app.extensions] generateVersionLockExclude = ["my_company.usd_explorer"] ``` 4. Add ``` define_app("my_company.usd_explorer.ovc") ``` in ``` .\premake5.lua ``` . The developer workflow for creating an OVC app: - Continue developing for the workstation. At the very least, you as a developer still need the ability to run the app locally to test functionality. - Do most changes to dependencies and settings in the “base” kit file. Only make changes in the “ovc” kit file when the change is only relevant to running the app on OVC. - The changes you make in the “base” kit file are automatically picked up by the “ovc” app. - When you package the app, use fat packaging for OVC publishing. You can package both apps in a single package. ## Summary Hopefully this tutorial has been beneficial thus far. We’ve covered everything from creating apps, how to configure dependencies and settings, how to debug and test code. At this point it’s all about iterating on functionality; however, let’s assume that has already been completed. Let’s fast-forward and imagine we want to give the app to end users. Please continue reading through the Package App and Publish App sections to learn how to do just that.
create.md	# Create a Project Before development can begin, you must first create a new Project. There are many ways to create an Omniverse Project, and the method you choose depends on what you intend to build and how you prefer to work. Projects tend to align within distinct categories, yet there remains remarkable flexibility within each category to help you address the needs of the user. Here we will give instructions on how to begin the most common types of Projects using the Omniverse platform. ## Extensions Extensions are a common development path within Omniverse and they serve as the fundamental building blocks of Applications and Services. In effect, all user-facing elements in an Omniverse Application are created using Extensions. Extensions such as the Content Browser, Viewport and Stage elements are used by the Omniverse USD Composer and Omniverse USD Presenter Applications among many others. Extensions are persistent within Applications so long as they are configured as an application dependency or they are set to load in the Extension Manager. In creating Omniverse Extensions, multiple options are available: 1. One powerful and flexible technique involves cloning our template from Github, which can be discovered under the Automated (Repo Tool) tab above. 2. For a simpler route, we offer a method via the UI (Extension Manager) tab. This provides a straightforward UI workflow to create your extension in another application, such as Omniverse Code. ### Automated (Repo Tool) Requirements: - [Git](../../common/glossary-of-terms.html#term-Git) - [Command-Line](../../common/glossary-of-terms.html#term-Command-Line) Optional: - [VS Code](../../common/glossary-of-terms.html#term-VS-Code) A template for Omniverse Project development can be accessed via the following GitHub repository: - [Advanced Template Repository](https://github.com/NVIDIA-Omniverse/kit-app-template). Below we describe the procedure to create an Extension development Project using this template. 1. Fork and/or Clone the Kit App Template repository link into a local directory using [Git](../../common/glossary-of-terms.html#term-Git). The Windows/Linux command-line might resemble: From the chosen local directory: ``` git clone https://github.com/NVIDIA-Omniverse/kit-app-template.git ``` ```bash git clone https://github.com/NVIDIA-Omniverse/kit-app-template ``` This command will generate a subfolder named kit-app-template with multiple files and folders designed to help you customize your Omniverse Project including sample Extension and Application files. 1. Navigate to the newly created ‘kit-app-template’: ```bash cd kit-app-template ``` optional If you have VS Code installed, you can now open the Project template in VSCode: ```bash code . ``` Once completed, you should have a folder structure which looks like this. 2. From either the integrated terminal in VSCode or from the command line, create a new Extension: ```bash repo template new ``` This action will trigger a sequence of options. Make the following selections: - What do you want to add : extension - Choose a template : python-extension-window - Enter a name: my_company.my_app.extension_name - Select a version, for instance: 0.1.0 The newly created Extension is located at: ``` kit-app-template/source/extensions/my_company.my_app.extension_name ``` You have now created an Extension template and are ready to begin development. Additional information The ‘repo’ command is a useful tool within an Omniverse Project. This command is both configurable and customizable to suit your requirements. To review the tools accessible within any Project, enter the following command: ```bash repo -h ``` More details on this tool can be found in the Repo Tools Documentation. If you prefer a comprehensive tutorial that guides you through Application and Extension development see the Kit App Template Tutorial. With the Extension Manager UI, you have the ability to quickly create an extension directly within an existing application. Step-by-step instructions on creating an extension this way are available under Getting Started with Extensions in the Kit Manual. You have now created an Extension template and are ready to begin development. Apps Omniverse Applications are simply a collection of Extensions. By configuring these collections, you can create high-performance, custom solutions suited to your organization’s needs without necessarily writing any code. NVIDIA develops and maintains a suite of Omniverse Applications to demonstrate what possible solutions you can create from these collections. An Omniverse Application is a .kit configuration file that instructs the Kit executable to load a predetermined set of Extensions. Either a `.bat` file (for Windows) or a `.sh` file (for Linux) is employed to launch your Application, by passing your Application .kit file to the Kit executable. Applications serve as an ideal option when you need tailor-made software with a unique layout and features. Omniverse Applications offer the flexibility to select from existing Extensions or create novel ones to add desired functionality. ## Application Template For inspiration, you can reference additional applications on the Omniverse Launcher. Download those which appeal to you and explore their installation folders and related .kit files. ### Requirements: - Git - Command-Line ### Optional: - VS Code A template for Omniverse Project development can be accessed via the following GitHub repository: - Advanced Template Repository. Below we describe the procedure to create an Extension development Project using this template. 1. Fork and/or Clone the Kit App Template repository link into a local directory using Git. The Windows/Linux command-line might resemble: ``` git clone https://github.com/NVIDIA-Omniverse/kit-app-template ``` This command will generate a subfolder named kit-app-template with multiple files and folders designed to help you customize your Omniverse Project including sample Extension and Application files. 2. Navigate to the newly created ‘kit-app-template’: ``` cd kit-app-template ``` optional If you have VS Code installed, you can now open the Project template in VSCode: ``` code . ``` Once completed, you should have a folder structure which looks like this. 3. Navigate to `/source/apps` folder and examine the sample .kit files found there. You have now created an Application template and are ready to begin development and learn to manipulate your .kit files. ### Additional information - If you prefer a comprehensive tutorial that guides you through Application and Extension development see the Kit App Template Tutorial. ## Connectors Omniverse Connectors serve as middleware, enabling communication between Omniverse and various software applications. They allow for the import and export of 3D assets, data, and models between different workflows and tools through the use of Universal Scene Description (OpenUSD) as the interchange format. Creating a Connector can be beneficial when connecting a third-party application to Omniverse, providing the ability to import, export, and synchronize 3D data via the USD format. A practical use case of this could involve generating a 3D model in Maya, then exporting it to an Omniverse Application like Omniverse USD Composer for rendering with our photo-realistic RTX or Path Tracing renderers. ### Connector Resources To equip you with an understanding of creating Omniverse Connectors, we’ve compiled some beneficial resources below: #### Video Overview Gain insight into Omniverse Connectors with this concise overview. This video helps you understand the basics of Connectors and the unique value they bring. - Omniverse Connectors overview #### Documentation Learn about what you can create with Connectors following our samples using OpenUSD and Omniverse Client Library APIs - Connect Sample - Video Tutorial - Learn how to connect with the Omniverse platform by syncing data to it via OpenUSD. Establish a live sync session and get an OpenUSD 101 overview to get you started. - Making a Connector for Omniverse ## Services Omniverse offers a Services framework based on its foundational Kit SDK. This framework is designed to simplify the construction of Services that can leverage the capabilities of custom Extensions. Developers can choose to run their Services in various settings, such as local machines, virtual machines, or in the cloud. The framework is flexible, allowing Services to be migrated to different infrastructures easily without changing the Service’s code. The framework promotes loose coupling, with its components serving as building blocks that foster scalability and resilience. These reusable components help accelerate the development of your tools and features for databases, logging, metrics collection, and progress monitoring. Creating a Service project employs the same tools used for Extensions, with a similar development process. However, certain aspects, such as configuration and dependencies, are unique to Services. More information is available here. ### Automated (Repo Tool) Requirements: - Git - Command-Line Optional: - VS Code A template for Omniverse Project development can be accessed via the following GitHub repository: - Advanced Template Repository. Below we describe the procedure to create an Extension development Project using this template. 1. Fork and/or Clone the Kit App Template repository link into a local directory using Git. The Windows/Linux command-line might resemble: ``` git clone https://github.com/NVIDIA-Omniverse/kit-app-template ``` This command will generate a subfolder named kit-app-template with multiple files and folders designed to help you customize your Omniverse Project including sample Extension and Application files. 2. Navigate to the newly created ‘kit-app-template’: ``` cd kit-app-template ``` Optional: If you have VS Code installed, you can now open the Project template in VSCode: ``` code . ``` Once completed, you should have a folder structure which looks like this. 3. From either integrated terminal in VSCode or from the command line, create a new Extension: ``` repo template new ``` This action will trigger a sequence of options. Make the following selections: - What do you want to add : extension - Choose a template : python-extension-main - Enter a name: my_company.my_app.extension_name - Select a version, for instance: 0.1.0 The newly created Extension is located at: ``` ``` kit-app-template/source/extensions/my_company.my_app.extension_name ``` You have now created an Extension template and are ready to begin development of your Service. Additional information - The ‘repo’ command is a useful tool within an Omniverse Project. This command is both configurable and customizable to suit your requirements. To review the tools accessible within any Project, enter the following command: ``` repo -h ``` More details on this tool can be found in the Repo Tools Documentation. - If you prefer a comprehensive tutorial that guides you through Application and Extension development see the Kit App Template Tutorial. With the Extension Manager UI, you have the ability to quickly create an extension directly within an existing application. Step-by-step instructions on creating an extension this way are available under Getting Started with Extensions in the Kit Manual. You have now created an Extension template and are ready to begin development of your Service.
create_docs.md	# Document This document that you are reading was built from files and tools inside the kit-app-template project. The `.md` and `.toml` files in the `.\docs` directory is the source for this webpage. There’s some images in that directory as well. Using the same tools - with your own markdown files - you can create docs to help end users understand the Applications and Extensions you develop. ## Build Docs To build documentation, simply use the `repo docs` command (command cheat-sheet). To see built documentation open `_build\docs\kit-app-template\latest\index.html`. > Note > Reference: Documentation System. ## Link to Docs Once the docs are hosted an Application can provide a button or menu to access it. Here’s a sample for how to open a webpage: ```toml import webbrowser webbrowser.open(url) ```
creating-and-registering-custom-actions_Overview.md	# Overview — Kit Extension Template C++ 1.0.1 documentation ## Overview An example C++ extension that can be used as a reference/template for creating new extensions. Demonstrates how to create actions in C++ that can then be executed from either C++ or Python. See the omni.kit.actions.core extension for extensive documentation about actions themselves. ## C++ Usage Examples ### Defining Custom Actions ```c++ using namespace omni::kit::actions::core; class ExampleCustomAction : public Action { public: static carb::ObjectPtr<IAction> create(const char* extensionId, const char* actionId, const MetaData* metaData) { return carb::stealObject<IAction>(new ExampleCustomAction(extensionId, actionId, metaData)); } ExampleCustomAction(const char* extensionId, const char* actionId, const MetaData* metaData) : Action(extensionId, actionId, metaData), m_executionCount(0) { } carb::variant::Variant execute(const carb::variant::Variant& args = {}, const carb::dictionary::Item* kwargs = nullptr) override ``` ```cpp { ++m_executionCount; printf("Executing %s (execution count = %d).\n", getActionId(), m_executionCount); return carb::variant::Variant(m_executionCount); } void invalidate() override { resetExecutionCount(); } uint32_t getExecutionCount() const { return m_executionCount; } protected: void resetExecutionCount() { m_executionCount = 0; } private: uint32_t m_executionCount = 0; }; ``` ## Creating and Registering Custom Actions ```cpp // Example of creating and registering a custom action from C++. Action::MetaData metaData; metaData.displayName = "Example Custom Action Display Name"; metaData.description = "Example Custom Action Description."; carb::ObjectPtr<IAction> exampleCustomAction = ExampleCustomAction::create("omni.example.cpp.actions", "example_custom_action_id", &metaData); carb::getCachedInterface<omni::kit::actions::core::IActionRegistry>()->registerAction(exampleCustomAction); ``` ## Creating and Registering Lambda Actions ```cpp auto actionRegistry = carb::getCachedInterface<omni::kit::actions::core::IActionRegistry>(); // Example of creating and registering a lambda action from C++. omni::kit::actions::core::IAction::MetaData metaData; metaData.displayName = "Example Lambda Action Display Name"; metaData.description = "Example Lambda Action Description."; carb::ObjectPtr<IAction> exampleLambdaAction = omni::kit::actions::core::LambdaAction::create( "omni.example.cpp.actions", "example_lambda_action_id", &metaData, [this](const carb::variant::Variant& args = {}, const carb::dictionary::Item* kwargs = nullptr) { printf("Executing example_lambda_action_id.\n"); }); ``` ```cpp return carb::variant::Variant(); ``` ```cpp carb::getCachedInterface<omni::kit::actions::core::IActionRegistry>()->registerAction(exampleLambdaAction); ``` ```cpp // Example of creating and registering (at the same time) a lambda action from C++. carb::getCachedInterface<omni::kit::actions::core::IActionRegistry>()->registerAction( "omni.example.cpp.actions", "example_lambda_action_id", [](const carb::variant::Variant& args = {}, const carb::dictionary::Item* kwargs = nullptr) { printf("Executing example_lambda_action_id.\n"); return carb::variant::Variant(); }, "Example Lambda Action Display Name", "Example Lambda Action Description."); ``` ## Discovering Actions ```cpp auto registry = carb::getCachedInterface<omni::kit::actions::core::IActionRegistry>(); // Retrieve an action that has been registered using the registering extension id and the action id. carb::ObjectPtr<IAction> action = registry->getAction("omni.example.cpp.actions", "example_custom_action_id"); // Retrieve all actions that have been registered by a specific extension id. std::vector<carb::ObjectPtr<IAction>> actions = registry->getAllActionsForExtension("example"); // Retrieve all actions that have been registered by any extension. std::vector<carb::ObjectPtr<IAction>> actions = registry->getAllActions(); ``` ## Deregistering Actions ```cpp auto actionRegistry = carb::getCachedInterface<omni::kit::actions::core::IActionRegistry>(); // Deregister an action directly... actionRegistry->deregisterAction(exampleCustomAction); // or using the registering extension id and the action id... actionRegistry->deregisterAction("omni.example.cpp.actions", "example_custom_action_id"); // or deregister all actions that were registered by an extension. actionRegistry->deregisterAllActionsForExtension("omni.example.cpp.actions"); ``` ## Executing Actions ```cpp auto actionRegistry = carb::getCachedInterface<omni::kit::actions::core::IActionRegistry>(); // Execute an action after retrieving it from the action registry. auto action = actionRegistry->getAction("omni.example.cpp.actions", "example_custom_action_id"); ``` ```cpp action->execute(); // Execute an action indirectly (retrieves it internally). actionRegistry->executeAction("omni.example.cpp.actions", "example_custom_action_id"); // Execute an action that was stored previously. exampleCustomAction->execute(); ``` Note: All of the above will find any actions that have been registered from either Python or C++, and you can interact with them without needing to know anything about where they were registered. ```
CreatingCppNodes.md	# Creating C++ Nodes ## Setting Up Your Extension This is a guide to writing a node in C++, including how to set up and structure everything you need in your extension so that the node can be delivered to others in a consistent way. You may already have some of the pieces in place - feel free to skip ahead to just the parts you will need. If you wish to create a Python node then see [Creating Python Nodes](#omnigraph-creating-python-nodes). The Omniverse applications rely on extensions to provide functionality in a modular way and the nodes you write will be integrated best if you follow the same model. You may choose to add much more to your extension. What is described here is the bare minimum required to make an extension containing a single C++ node integrate into a Kit-based application. Whether you are familiar with extension development in Kit or not, the best place to start is from one of the predefined template extensions. Important It is assumed you understand how to build C++ files in an extension, usually using the `premake5.lua` build file favored by the Kit extension environment. See the templates in the Kit [github C++ repo](https://github.com/NVIDIA-Omniverse/kit-extension-template-cpp) for more information. Once you have a build directory you can copy the template extension [omni.graph.template.cpp](#ext-omni-graph-template-cpp) into your `source/extensions` directory so that the build process can access it. See [that extension’s documentation](#ext-omni-graph-template-cpp) for a more thorough explanation of how to populate and build your C++ nodes once the extension is in place. Note If you will have a mixture of both C++ and Python files in your extension then you should instead use [this template that sets up an extension with both kinds of nodes](#ext-omni-graph-template-mixed). To see details of what capabilities the C++ node and its corresponding .ogn definition have look through some examples in the [OGN User Guide](#ogn-user-guide), or look at some nodes that have already been implemented in the node library reference. See in particular the [OGN Code Samples - C++](#ogn-code-samples-cpp) for examples of how to access different types of data within a node.
CreatingPythonNodes.md	# Creating Python Nodes This is a guide to writing a node in Python, including how to set up and structure everything you need in your extension so that the node can be delivered to others in a consistent way. You may already have some of the pieces in place - feel free to skip ahead to just the parts you will need. If you wish to create a C++ node then see Creating C++ Nodes. ## Setting Up Your Extension The Omniverse applications rely on extensions to provide functionality in a modular way and the nodes you write will be integrated best if you follow the same model. You may choose to add much more to your extension. What is described here is the bare minimum required to make an extension containing a single Python node integrate into a Kit-based application. Whether you are familiar with extension development in Kit or not, the best place to start is from one of the predefined template extensions. ### Note If you will have a mixture of both C++ and Python files in your extension then you should instead use this template that sets up an extension with both kinds of nodes. ## Python Nodes With A Build The typical method of creating OmniGraph Python nodes is to use a build process with a .ogn definition file to generate Python support code, documentation, and even automated tests for your node type. Once you have a build directory you can copy the template extension omni.graph.template.python into your source/extensions directory so that the build process can access it. See that extension’s documentation for a more thorough explanation of how to populate and build your Python nodes once the extension is in place. ## Python Nodes Without A Build If you want to get up and running faster without the overhead of a build you can build a much smaller extension. This type of extension can only contain Python files, documentation, data, and configuration files such as the mandatory config/extension.toml file. You can define a local extension in your Documents/Kit/shared/exts directory, which will be automatically scanned by the extension manager. A template for an extension with no build process can be found in omni.graph.template.no_build. You can copy this directory into your Documents/Kit/shared/exts directory, which will be automatically scanned by the extension manager. Be sure to rename everything to match your own extension’s requirements. </p> <p> See that extension’s documentation for a more thorough explanation of how to build your Python nodes once the extension is in place. </p> <p> To see details of what capabilities the Python node and its corresponding .ogn definition have look through some examples in the OGN User Guide , or look at some nodes that have already been implemented in the node library reference . </p> <p> See in particular the OGN Code Samples - Python for examples of how to access different types of data within a node. </p> <p> To see details of what capabilities the Python node and its corresponding .ogn definition have look through some examples in the OGN User Guide , or look at some nodes that have already been implemented in the node library reference ). </p> </section> </section> </section> </div> </div> <footer> <hr/> </footer> </div> </div> </section> </div>
custom-protocol-commands.md	# Custom Protocol Commands — Omniverse Launcher latest documentation ## 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: - News: 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` - the version of the app or connector to install. - (optional) - the version that needs to be installed. If not specified, then the latest version is installed. - (optional) - defines if Launcher needs to throw an error if the same component is already installed. (true or false, true by default). ### Example The IT Managed Launcher supports only the `path` argument that must point to a zip archive downloaded from the enterprise portal. ### Example ### Example - the unique name of the installed app or connector. - the version that needs to be uninstalled. ### Example This 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: - the unique name of the installed app that must be launched. ### Example Note: Users can change their current app versions in the library settings. ### Example ### Example 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 This 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 This 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
CustomizeTabs.md	# Welcome screen: Customize tabs Tabs can be specified in `[[settings.app.welcome.page]]` sections. Here are default tabs: ```toml [[settings.app.welcome.page]] text = "Open" icon = "${omni.kit.welcome.window}/icons/open_inactive.png" active_icon = "${omni.kit.welcome.window}/icons/open_active.png" extension_id = "omni.kit.welcome.open" order = 0 [[settings.app.welcome.page]] text = "What's New" icon = "${omni.kit.welcome.window}/icons/whats_new_inactive.png" active_icon = "${omni.kit.welcome.window}/icons/whats_new_active.png" extension_id = "omni.kit.welcome.whats_new" order = 10 [[settings.app.welcome.page]] text = "Learn" icon = "${omni.kit.welcome.window}/icons/learn_inactive.png" active_icon = "${omni.kit.welcome.window}/icons/learn_active.png" extension_id = "omni.kit.welcome.learn" order = 20 [[settings.app.welcome.page]] text = "About" icon = "${omni.kit.welcome.window}/icons/about_inactive.png" active_icon = "${omni.kit.welcome.window}/icons/about_active.png" extension_id = "omni.kit.welcome.about" order = 40 ``` - text: Text for tab to show in Welcome screen - icon and active_icon: Icon for tab (normal and selected) to show in Welcome screen, along with “text” - extension_id: Extension to load when tab selected - order: Order of this tab to show in Welcome screen.