Class: OrbitControls3

Core-API.OrbitControls3

Hierarchy

• OrbitControls

  ↳ OrbitControls3

Implements

• IUiConfigContainer
• ICameraControls<OrbitControlsEventMap>

Constructors

constructor

• new OrbitControls3(object, domElement?)

Parameters

Name	Type
object	Camera<Object3DEventMap>
domElement?	HTMLElement

Inherited from

OrbitControls.constructor

Properties

uiConfig

• Optional uiConfig: UiObjectConfig<void, "panel">

Implementation of

ICameraControls.uiConfig

---

type

• type: string = 'OrbitControls'

---

enabled

• enabled: boolean = true

Implementation of

ICameraControls.enabled

Overrides

OrbitControls.enabled

---

dollyZoom

• dollyZoom: boolean = false

---

zoomToCursor

• zoomToCursor: boolean = false

Overrides

OrbitControls.zoomToCursor

---

enableDamping

• enableDamping: boolean = true

Overrides

OrbitControls.enableDamping

---

dampingFactor

• dampingFactor: number = 0.08

Overrides

OrbitControls.dampingFactor

---

autoRotate

• autoRotate: boolean = false

Implementation of

ICameraControls.autoRotate

Overrides

OrbitControls.autoRotate

---

autoRotateSpeed

• autoRotateSpeed: number = 2.0

Overrides

OrbitControls.autoRotateSpeed

---

enableZoom

• enableZoom: boolean = true

Overrides

OrbitControls.enableZoom

---

zoomSpeed

• zoomSpeed: number = 0.15

Overrides

OrbitControls.zoomSpeed

---

maxZoomSpeed

• maxZoomSpeed: number = 0.20

---

enableRotate

• enableRotate: boolean = true

Overrides

OrbitControls.enableRotate

---

rotateSpeed

• rotateSpeed: number = 2.0

Overrides

OrbitControls.rotateSpeed

---

enablePan

• enablePan: boolean = true

Overrides

OrbitControls.enablePan

---

panSpeed

• panSpeed: number = 1.0

Overrides

OrbitControls.panSpeed

---

autoPushTarget2

• autoPushTarget2: boolean = false

---

autoPullTarget

• autoPullTarget: boolean = false

---

minDistance

• minDistance: number = 0.35

Overrides

OrbitControls.minDistance

---

maxDistance

• maxDistance: number = 1000

Overrides

OrbitControls.maxDistance

---

minZoom

• minZoom: number = 0.01

Overrides

OrbitControls.minZoom

---

maxZoom

• maxZoom: number = 1000

Overrides

OrbitControls.maxZoom

---

minPolarAngle

• minPolarAngle: number = 0

Overrides

OrbitControls.minPolarAngle

---

maxPolarAngle

• maxPolarAngle: number = Math.PI

Overrides

OrbitControls.maxPolarAngle

---

minAzimuthAngle

• minAzimuthAngle: number = -10000

Overrides

OrbitControls.minAzimuthAngle

---

maxAzimuthAngle

• maxAzimuthAngle: number = 10000

Overrides

OrbitControls.maxAzimuthAngle

---

clampMin

• clampMin: Vector3

---

clampMax

• clampMax: Vector3

---

screenSpacePanning

• screenSpacePanning: boolean = true

Overrides

OrbitControls.screenSpacePanning

---

keyPanSpeed

• keyPanSpeed: number = 7.0

Overrides

OrbitControls.keyPanSpeed

---

throttleUpdate

• throttleUpdate: number = 60

Overrides

OrbitControls.throttleUpdate

---

_autoPushTarget

• Protected _autoPushTarget: boolean = false

Accessors

autoPushTarget

• get autoPushTarget(): boolean

Returns

boolean

• set autoPushTarget(autoPushTarget): void

Parameters

Name	Type
autoPushTarget	boolean

Returns

void

Methods

zoomIn

▸ zoomIn(delta): void

Parameters

Name	Type
delta	number

Returns

void

Overrides

OrbitControls.zoomIn

---

zoomOut

▸ zoomOut(delta): void

Parameters

Name	Type
delta	number

Returns

void

Overrides

OrbitControls.zoomOut

---

dispatchEvent

▸ dispatchEvent(event): void

Parameters

Name	Type
event	Object
event.type	TOrbitControlsEvents
event.target?	any

Returns

void

Implementation of

ICameraControls.dispatchEvent

Overrides

OrbitControls.dispatchEvent