Creates a new Gizmo instance
The entity that this gizmo will be associated with and manipulate
Protected__Protected__Protected__the target entity which this gizmo belong to
Protected Optional__The top entity of this gizmo group. A programmer who implements a gizmo class has to make this entity a child of the target entity's scene graph component that the gizmo will belong to manually.
Collection of tags associated with this object
StaticcurrentCurrent maximum object count for UID generation
Static ReadonlyInvalidInvalid object UID constant
Checks whether the gizmo has been properly initialized and set up.
True if the gizmo's top entity exists and setup is complete, false otherwise
Gets the current visibility state of the gizmo
True if the gizmo is visible, false otherwise
Sets the visibility state of the gizmo
True to make the gizmo visible, false to hide it
Gets the unique object identifier
The object's UID
Gets the unique name of this object
The unique name string
Protected__Internal method to set the visibility of the gizmo and all its child entities
True to show the gizmo, false to hide it
Protected__Determines whether the gizmo setup should be skipped
True if setup should be skipped, false otherwise
InternalCopies tag data from another RnObject instance to this object
The source RnObject to copy tags from
InternalDestroys the gizmo and cleans up its resources. Removes the top entity and all associated components from the scene.
InternalInitializes the gizmo entities and visual representation if not already done. Creates a mesh entity with a light gizmo primitive and attaches it to the target entity.
InternalUpdates the transform properties (position, rotation, scale) of the gizmo to match the target entity. The gizmo's position is set to either the target's position or the center of its bounding box, and its scale is adjusted based on the target's bounding box size.
Retrieves a complete tag object (name and value) for the specified tag name
The name of the tag to retrieve
A Tag object containing the name and value
Retrieves the value associated with a specific tag name
The name of the tag whose value to retrieve
The tag value, or undefined if the tag doesn't exist
Checks whether this object has a tag with the specified name
The name of the tag to check for
True if the tag exists (value is not null/undefined), false otherwise
Checks if this object has a tag with the specified name and value
The tag name to match
The tag value to match
True if the object has a matching tag, false otherwise
Checks if this object has all the specified tags with exactly matching values
Object containing tag names as keys and expected values
True if all specified tags exist with matching values, false otherwise
Checks if the object's combined tag string contains all the provided search strings. This allows for flexible searching within tag names and values.
Array of strings that must all be present in the combined tag string
True if all strings are found in the combined tag string, false otherwise
Removes a tag from this object
The name of the tag to remove
ProtectedsetApplies appropriate tags to the gizmo entities for identification and categorization This method ensures that all gizmo entities are properly tagged for rendering and processing pipelines
Attempts to set a tag on this object. If the tag already exists, it will be replaced.
The tag object containing the name and value to set
True if the tag was successfully set, false if the tag name contains invalid characters
Attempts to set a unique name for this object
The desired unique name
If true, appends UID to make name unique when conflicts occur; if false, fails on conflict
True if the name was successfully set, false if there was a conflict and toAddNameIfConflict was false
Unregisters this object from all tracking collections. Should be called when the object is being destroyed.
Validates that a tag string contains only allowed characters (alphanumeric and underscore)
The string to validate
True if the string contains only valid characters, false if it contains invalid characters
Static_InternalResets all static object tracking data. Used primarily for testing.
StaticgetRetrieves an RnObject instance by its unique identifier
The unique identifier of the object to retrieve
The RnObject instance or undefined if not found or garbage collected
StaticgetRetrieves an RnObject instance by its unique name
The unique name of the object to retrieve
The RnObject instance or undefined if not found or garbage collected
StaticsearchSearches for the first object that has a specific tag with the given value
The tag name to search for
The tag value to match
WeakRef to the first matching object, or undefined if not found
Abstract Gizmo class that provides a foundation for creating interactive gizmo objects in 3D scenes. Gizmos are typically used for manipulation tools like transform handles, rotation rings, or other interactive visual aids.