the object provided by the user
the THREE.Camera instance used in the scene
hides all other Controls instances when drag starts
hides other handles of a Controls instance when drag starts
For translation handles: highlights the axis along which the object moves. For rotation handles: highlights the axis of rotation. Not available on other handles.
enables damping for the controls
the object provided by the user
handle which translates the object in the eye-plane
handle which translates the object in XY plane
handle which translates the object in YZ plane
handle which translates the object in ZX plane
handle which rotates the object in the eye-plane
handle which rotates the object along the x-axis
handle which rotates the object along the y-axis
handle which rotates the object along the z-axis
displays the plane in which the drag interaction takes place (useful for debugging)
Enables snap to grid (nearest integer coordinate) for all translation type handles: TranslationGroup, PickGroup, and PickPlaneGroup
handle which translates the object along the x-axis; displayed in the -ve x-axis direction
handle which translates the object along the x-axis; displayed in the +ve x-axis direction
handle which translates the object along the y-axis; displayed in the -ve y-axis direction
handle which translates the object along the y-axis; displayed in the +ve y-axis direction
handle which translates the object along the z-axis; displayed in the -ve z-axis direction
handle which translates the object along the z-axis; displayed in the +ve z-axis direction
Only takes effect if IControlsOptions.isDampingEnabled is true.
value between 0 and 1, acts like a weight on the controls
Puts a limit on the object's translation anchored at the current position.
{ x: [-1, 2], y: false, z: false } - sets the translation limit to -1 unit
in the -x-direction, +2 units in the +x-direction, and no limit on the
y and z-direction.
Setting the limit to false disables the limit in all directions.
Applies supplied visibility to all handles
Applies supplied visibility to the supplied handle names.
Individual handle's visibility can also be changed by modifying the visibility
property on the handle directly.
Generated using TypeDoc
Controls is the main class in this library. It is a subclass of THREE.Group, so its properties like
positionandquaternioncan be modified as desired. Thechildrenare the control handles (likerotationX). All translations and rotations are setup with respect to the global coordinate system.