Creates a new VRM Spring Bone instance.
The scene graph entity node to attach this spring bone to
Collection of tags associated with this object
The bone axis direction in local space coordinates
The length of the bone in world space units
Current tail position in world space coordinates
The drag force that dampens the bone movement
The direction vector of gravity force
The power of gravity affecting the bone movement
The radius used for collision detection
Flag indicating whether the spring bone has been initialized
The initial local position of the child bone
The scene graph entity node that this spring bone is attached to
Previous tail position in world space coordinates
The stiffness force that controls how quickly the bone returns to its rest position
StaticcurrentCurrent maximum object count for UID generation
Static ReadonlyInvalidInvalid object UID constant
Gets the unique object identifier
The object's UID
Gets the unique name of this object
The unique name string
Calculates the bone length in world space coordinates. This method updates the boneLength property based on the current world positions of the bone and its child (or estimated child position).
InternalCopies tag data from another RnObject instance to this object
The source RnObject to copy tags from
Gets the transformation matrix from center space to world space.
Optionalcenter: SceneGraphComponentOptional center component for coordinate transformation
The transformation matrix from center to world space
Gets the transformation matrix from world space to center space.
Optionalcenter: SceneGraphComponentOptional center component for coordinate transformation
The transformation matrix from world to center space
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
Initializes the spring bone with default values and calculates initial positions. This method should be called once before starting the physics simulation.
Optionalcenter: SceneGraphComponentOptional center component for coordinate transformation
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
VRM Spring Bone implementation for physics-based bone animation. This class handles the physics simulation of spring bones commonly used in VRM models for secondary animation like hair, clothes, and accessories.