Interface: OrbitControlsOptions

Defined in: interaction/OrbitControls.ts:8

Options for configuring OrbitControls.

Properties

autoRotate?

optional autoRotate: boolean

Defined in: interaction/OrbitControls.ts:32

Enable auto-rotation. Defaults to false.

---

autoRotateSpeed?

optional autoRotateSpeed: number

Defined in: interaction/OrbitControls.ts:34

Auto-rotation speed in degrees per second. Defaults to 2.

---

dampingFactor?

optional dampingFactor: number

Defined in: interaction/OrbitControls.ts:12

Damping factor for smooth motion. Defaults to 0.05.

---

enableDamping?

optional enableDamping: boolean

Defined in: interaction/OrbitControls.ts:10

Enable smooth motion damping. Defaults to true.

---

enablePan?

optional enablePan: boolean

Defined in: interaction/OrbitControls.ts:16

Enable panning (right-click drag). Defaults to true.

---

enableRotate?

optional enableRotate: boolean

Defined in: interaction/OrbitControls.ts:18

Enable rotation (left-click drag). Defaults to true.

---

enableZoom?

optional enableZoom: boolean

Defined in: interaction/OrbitControls.ts:14

Enable zoom with scroll wheel. Defaults to true.

---

maxAzimuthAngle?

optional maxAzimuthAngle: number

Defined in: interaction/OrbitControls.ts:30

Maximum horizontal angle in radians.

---

maxDistance?

optional maxDistance: number

Defined in: interaction/OrbitControls.ts:22

Maximum zoom distance.

---

maxPolarAngle?

optional maxPolarAngle: number

Defined in: interaction/OrbitControls.ts:26

Maximum vertical angle in radians (PI = looking up).

---

minAzimuthAngle?

optional minAzimuthAngle: number

Defined in: interaction/OrbitControls.ts:28

Minimum horizontal angle in radians.

---

minDistance?

optional minDistance: number

Defined in: interaction/OrbitControls.ts:20

Minimum zoom distance.

---

minPolarAngle?

optional minPolarAngle: number

Defined in: interaction/OrbitControls.ts:24

Minimum vertical angle in radians (0 = looking down).

---

orbitControlsUp?

optional orbitControlsUp: "x" | "y" | "z" | "camera"

Defined in: interaction/OrbitControls.ts:36

Vertical rotation axis: 'x', 'y', 'z', or 'camera' (uses camera's initial up). Defaults to 'z'.