Readonly
apiGeneric object accessible by other instances of ScriptComponent. Use this object to store references to properties and methods that need to be accessible from other ScriptComponents.
Speed coefficient of the one-euro filter. Higher values reduce lag during fast movements but may increase jitter. Adjust this parameter after setting minCutoff to minimize lag during quick movements.
Derivative cutoff frequency for the one-euro filter. Controls how the filter responds to changes in movement speed. Higher values make the filter more responsive to velocity changes.
If disabled, the Component will stop enacting its behavior.
Enhances depth manipulation by applying a distance-based multiplier to Z-axis movement. When enabled, objects that are farther away will move greater distances with the same hand movement, making it easier to position distant objects without requiring excessive physical reach.
The largest this object can scale up to, relative to its original scale. A value of 2 means it cannot scale larger than twice its original size.
Minimum cutoff frequency of the one-euro filter. Lower values reduce jitter during slow movements but increase lag. Adjust this parameter first with beta=0 to find a balance that removes jitter while maintaining acceptable responsiveness during slow movements.
The smallest this object can scale down to, relative to its original scale. A value of 0.5 means it cannot scale smaller than 50% of its original size.
Callback for when any manipulation ends
Callback for when any manipulation begins
Callback for when any manipulation updates
Callback for when rotation has ended
Callback for when rotation begins
Callback for when rotation updates each frame
Callback for when scale has ended
Callback for when scale has reached the minimum or maximum limit
Callback for when scale begins
Callback for when scale updates each frame
Callback for when translation has ended
Callback for when translation begins
Callback for when translation updates each frame
Readonly
sceneThe scene object this component is on.
Controls the visibility of rotation options in the Inspector.
Controls the visibility of advanced Z-stretch configuration options in the Inspector. When enabled, shows additional properties that fine-tune the distance-based Z-axis movement multiplier (Z Stretch Factor Min and Z Stretch Factor Max).
Controls the visibility of translation options in the Inspector.
Readonly
uniqueThe maximum multiplier applied to Z-axis movement when using stretch mode. This value is used when objects are far away from the user. Higher values allow faster positioning of distant objects with minimal hand movement.
The minimum multiplier applied to Z-axis movement when using stretch mode. This value is used when objects are close to the user. Higher values result in more responsive depth movement for nearby objects.
Returns if translation along world X-axis is enabled.
Set if translation along world X-axis is enabled.
Returns if translation along world Y-axis is enabled.
Set if translation along world Y-axis is enabled.
Returns if translation along world Z-axis is enabled.
Set if translation along world Z-axis is enabled.
Get if rotation occurs about all axes or a single world axis (x,y,z) when using to two hands..
Set if rotation occurs about all axes or a single world axis (x,y,z) when using to two hands.
Returns true if any of rotation x, y, or z is enabled
Returns true if any of scale x, y, or z is enabled
Returns true translation is enabled
Adds a new SceneEvent, triggered by eventType
events, to the ScriptComponent.
Destroys the component.
Gets the transform of the root of the manipulated object(s).
Returns the SceneObject the component is attached to.
Returns the Transform this component is attached to.
Static
getReturns the name of this object's type.
Returns true if the object matches or derives from the passed in type.
Returns true if this object is the same as other
. Useful for checking if two references point to the same thing.
Removes a previously added SceneEvent from the ScriptComponent.
Resets the interactable's position
Resets the interactable's rotation
Resets the interactable's scale
Resets the interactable's transform
Toggle for allowing an object to rotate
Toggle for allowing an object to scale
Toggle for allowing an object to translate
Sets the transform of the passed SceneObject as the root of the manipulated object(s).
This class provides manipulation capabilities for interactable objects, including translation, rotation, and scaling. It allows configuration of the manipulation root, scale limits, and rotation axes.