Overview#

omni.kit.property.tagging enables users to manage asset tags directly from the property panel in Omniverse Kit. It provides a set of commands to add, remove, and update tagging property values, helping to keep asset metadata organized. The extension also integrates a dedicated widget into the properties window, ensuring that tag modifications are smoothly reflected in the UI.

Concepts#

This extension introduces a command-based approach to tagging assets. The commands follow a “do/undo” pattern, ensuring that changes can be reversed if needed. Each command expects the asset path in server which enable tagging sevice and interacts with a tagging server—operations will fail if the server is unavailable.

This extesion also register a TaggingAttributesWidget to property, provides editing tagging properties in Omniverse Kit. It has custom UI for editing tagging properties, with capabilities to handle tagging in assets.

Functionality#

AddTagCommand
Adds a tag to a specified asset. If a conflicting (excluded) tag is provided, it will be removed automatically. The command can be reversed, restoring the asset to its previous state.
RemoveTagCommand
Removes an existing tag from an asset. It ensures that once a tag is removed, the change can be undone by re-adding it if necessary.
UpdateTagCommand
Updates a tag on an asset by replacing an old tag with a new one. This command supports undo functionality, allowing the original tag to be restored if needed.

Relationships#

This extension depends on several core modules to function correctly:

It builds on omni.kit.commands to leverage the standardized command lifecycle.
Integration with omni.kit.tagging and omni.kit.window.property ensures that tagging operations are coordinated within the larger property and tagging framework.
Dependencies on modules such as omni.usd and omni.ui enable seamless UI integration and asset management across Omniverse Kit.

Considerations#

Tag operations will not execute if there is no connection to the tagging server, so ensure that networking conditions are met before performing actions.
Asset paths must in server which enable tagging service; otherwise, the commands will simply return without making any changes.
The extension is designed to integrate with the properties panel, ensuring that the widget registration and unregistration follow the application’s lifecycle, which helps maintain resource integrity.

By providing a clear structure for managing tagging properties, omni.kit.property.tagging simplifies asset metadata management in Omniverse Kit, enabling efficient organization and quick updates directly within the property view.