Interface OrbitControlsParams

Defines base parameters used to create an OrbitControls.

interface OrbitControlsParams {
    target?: Vec3;
    enableZoom?: boolean;
    minZoom?: number;
    maxZoom?: number;
    zoomSpeed?: number;
    enableRotate?: boolean;
    minPolarAngle?: number;
    maxPolarAngle?: number;
    minAzimuthAngle?: number;
    maxAzimuthAngle?: number;
    rotateSpeed?: number;
    enablePan?: boolean;
    panSpeed?: number;
    camera?: Camera;
    element?: HTMLElement | Window;
}

Hierarchy (View Summary)

Properties

target? enableZoom? minZoom? maxZoom? zoomSpeed? enableRotate? minPolarAngle? maxPolarAngle? minAzimuthAngle? maxAzimuthAngle? rotateSpeed? enablePan? panSpeed? camera? element?

Properties

Optionaltarget

target?: Vec3

The focus point or the OrbitControls.

OptionalenableZoom

enableZoom?: boolean

Whether to allow zooming or not.

OptionalminZoom

minZoom?: number

Minimum zoom value to use.

OptionalmaxZoom

maxZoom?: number

Maximum zoom value to use.

OptionalzoomSpeed

zoomSpeed?: number

Zoom speed value to use.

OptionalenableRotate

enableRotate?: boolean

Whether to allow rotating or not.

OptionalminPolarAngle

minPolarAngle?: number

Minimum angle to use for vertical rotation.

OptionalmaxPolarAngle

maxPolarAngle?: number

Maximum angle to use for vertical rotation.

OptionalminAzimuthAngle

minAzimuthAngle?: number

Minimum angle to use for horizontal rotation.

OptionalmaxAzimuthAngle

maxAzimuthAngle?: number

Maximum angle to use for horizontal rotation.

OptionalrotateSpeed

rotateSpeed?: number

Rotate speed value to use.

OptionalenablePan

enablePan?: boolean

Whether to allow paning or not.

OptionalpanSpeed

panSpeed?: number

Pan speed value to use.

Optionalcamera

camera?: Camera

Optional Camera to use.

Optionalelement

element?: HTMLElement | Window

Optional HTMLElement (or Window element) to use for event listeners.

Settings

Member Visibility

On This Page

Properties