Documentation / Node reference / geo nodes

geo/OrbitControls

Lets the viewer drive the input camera with the mouse and keyboard.

Controls

Attaches orbit controls to the cameras coming in. Drag with the left mouse button to orbit around the target, drag with the middle button to pan, and use the wheel to zoom. W, A, S and D move the camera, E and Q move it up and down. Hold Shift to move faster and Ctrl to move slower. Each of orbit, pan, zoom and move can be turned off, and the mouse button or key it used is then left to the scene.

Parameters

Name Type What it does
target Vector3 The point the camera orbits around and looks at.
orbit Bool Orbit around the target by dragging with the left mouse button.
orbitSensitivity Float How far the camera turns for each pixel the mouse moves.
smoothOrbit Bool Keep turning for a moment after a quick drag is released.
phiBounds Vector2 The lowest and highest vertical angle the camera can reach, in radians. Set both to the same value to lock the vertical angle.
pan Bool Pan by dragging with the middle mouse button.
smoothPan Bool Keep sliding for a moment after a pan is released.
zoom Bool Zoom towards and away from the target with the mouse wheel.
zoomSensitivity Float How far each wheel step zooms, relative to the current distance.
radiusBounds Vector2 The closest and furthest the camera can be from the target.
move Bool Move with W, A, S and D, and up and down with E and Q.
moveSpeed Float Movement speed, in scene units per second.
moveSpeedMult Float How much faster the camera moves while Shift is held.
moveSpeedSlowMult Float How much slower the camera moves while Ctrl is held. A Ctrl combination bound to a shortcut, like Ctrl+S or Ctrl+A in the editor, runs the shortcut and does not move the camera.
frameObjects String Which objects a frame action fits in the view, as an object name mask.

See also

This page is generated from the engine, so it describes the release you can download. The same text is in the editor's Help panel next to the node itself.