Class OrbitControls

Hierarchy (view full)

Implements

  • ICameraController

Properties

allowInterrupt autoFit autoTarget targetLerpDuration

Accessors

activeAndEnabled cameraLerpActive context controllerObject controls destroyed enabled forward hideFlags isCameraController isComponent layer lookTargetLerpActive name right scene static tag targetLerpSpeed up worldEuler worldPosition worldQuaternion worldRotation

Methods

addEventListener awake destroy dispatchEvent earlyUpdate? fitCamera lateUpdate? lerpTarget onAfterRender? onBeforeRender onCollisionEnter? onCollisionExit? onCollisionStay? onDestroy onDisable onEnable onPausedChanged? onStartInteraction onTriggerEnter? onTriggerExit? onTriggerStay? onValidate? removeEventListener resolveGuids? setCameraAndLookTarget setCameraTargetPosition setLookTargetPosition setWorldPosition setWorldQuaternion setWorldRotation start startCoroutine stopCameraLerp stopCoroutine stopLookTargetLerp update?

Properties

allowInterrupt

allowInterrupt: boolean = true

If true user input interrupts the camera from animating to a target

autoFit

autoFit: boolean = false

When enabled the scene will be automatically fitted into the camera view in onEnable

autoTarget

autoTarget: boolean = true

When enabled OrbitControls will automatically raycast find a look at target in start

targetLerpDuration

targetLerpDuration: number = 1

The duration in seconds it takes for the camera look ad and position lerp to reach their destination (when set via setCameraTargetPosition and setLookTargetPosition)

Accessors

activeAndEnabled

  • get activeAndEnabled(): boolean

  • Returns boolean

cameraLerpActive

  • get cameraLerpActive(): boolean

  • True while the camera position is being lerped

    Returns boolean

context

  • get context(): Context

  • Returns Context

  • set context(context): void

  • Parameters

    Returns void

controllerObject

  • get controllerObject(): any

  • The object being controlled by the OrbitControls (usually the camera)

    Returns any

controls

  • get controls(): any

  • The underlying three.js OrbitControls

    Returns any

destroyed

  • get destroyed(): boolean

  • Returns boolean

enabled

  • get enabled(): boolean

  • Returns boolean

  • set enabled(val): void

  • Parameters

    • val: boolean

    Returns void

forward

  • get forward(): Vector3

  • Forward (0,0,-1) vector in world space

    Returns Vector3

hideFlags

  • get hideFlags(): HideFlags

  • Returns HideFlags

isCameraController

  • get isCameraController(): boolean

  • Returns boolean

isComponent

  • get isComponent(): boolean

  • Returns boolean

layer

  • get layer(): number

  • Returns number

lookTargetLerpActive

  • get lookTargetLerpActive(): boolean

  • True while the camera look target is being lerped

    Returns boolean

name

  • get name(): string

  • Returns string

  • set name(str): void

  • Parameters

    • str: string

    Returns void

right

  • get right(): Vector3

  • Right (1,0,0) vector in world space

    Returns Vector3

scene

  • get scene(): Scene

  • Returns Scene

static

  • get static(): any

  • Returns any

tag

  • get tag(): string

  • Returns string

  • set tag(str): void

  • Parameters

    • str: string

    Returns void

targetLerpSpeed

  • get targetLerpSpeed(): number

  • Returns number

    Deprecated

    use targetLerpDuration instead
    The speed at which the camera target and the camera will be lerping to their destinations (if set via script or user input)

  • set targetLerpSpeed(v): void

  • Parameters

    • v: number

    Returns void

up

  • get up(): Vector3

  • Up (0,1,0) vector in world space

    Returns Vector3

worldEuler

  • get worldEuler(): Euler

  • Returns Euler

  • set worldEuler(val): void

  • Parameters

    • val: Euler

    Returns void

worldPosition

  • get worldPosition(): Vector3

  • Returns Vector3

  • set worldPosition(val): void

  • Parameters

    • val: Vector3

    Returns void

worldQuaternion

  • get worldQuaternion(): Quaternion

  • Returns Quaternion

  • set worldQuaternion(val): void

  • Parameters

    • val: Quaternion

    Returns void

worldRotation

  • get worldRotation(): Vector3

  • Returns Vector3

  • set worldRotation(val): void

  • Parameters

    • val: Vector3

    Returns void

Methods

addEventListener

  • addEventListener<T>(type, listener): void

  • Type Parameters

    Parameters

    • type: string
    • listener: ((evt) => any)
        • (evt): any

        • Parameters

          • evt: T

          Returns any

    Returns void

awake

  • awake(): void

  • called once when the component becomes active for the first time

    Returns void

destroy

dispatchEvent

Optional earlyUpdate

fitCamera

  • fitCamera(objects?, fitOffset?, immediate?): void

  • Fits the camera to show the objects provided (defaults to the scene if no objects are passed in)

    Parameters

    • Optional objects: Object3D[]
    • fitOffset: number = 1.1
    • immediate: boolean = true

    Returns void

Optional lateUpdate

lerpTarget

  • lerpTarget(position, delta): void

  • Parameters

    • position: Vector3
    • delta: number

    Returns void

    Deprecated

    use controls.target.lerp(position, delta)

Optional onAfterRender

onBeforeRender

Optional onCollisionEnter

Optional onCollisionExit

Optional onCollisionStay

onDestroy

onDisable

onEnable

  • onEnable(): void

  • called every time when the component gets enabled (this is invoked after awake and before start)

    Returns void

Optional onPausedChanged

  • onPausedChanged(isPaused, wasPaused): void

  • Called for all scripts when the context gets paused or unpaused

    Parameters

    • isPaused: boolean
    • wasPaused: boolean

    Returns void

onStartInteraction

  • onStartInteraction(callback): void

  • Register callback when user starts interacting with the orbit controls

    Parameters

    Returns void

Optional onTriggerEnter

Optional onTriggerExit

Optional onTriggerStay

Optional onValidate

  • onValidate(prop?): void

  • called when you decorate fields with the @validate() decorator

    Parameters

    • Optional prop: string

    Returns void

removeEventListener

  • removeEventListener<T>(type, listener): void

  • Type Parameters

    Parameters

    • type: string
    • listener: ((arg) => any)
        • (arg): any

        • Parameters

          • arg: T

          Returns any

    Returns void

Optional resolveGuids

  • resolveGuids(guidsMap): void

  • called on a component with a map of old to new guids (e.g. when instantiate generated new guids and e.g. timeline track bindings needs to remape them)

    Parameters

    • guidsMap: GuidsMap

    Returns void

setCameraAndLookTarget

  • setCameraAndLookTarget(target): void

  • Sets camera target position and look direction. Does perform a raycast in the forward direction of the passed in object to find an orbit point

    Parameters

    • target: Object3D

    Returns void

setCameraTargetPosition

  • setCameraTargetPosition(position?, immediateOrDuration?): void

  • Moves the camera to position smoothly.

    Parameters

    • Optional position: any

      The position in local space of the controllerObject to move the camera to. If null the camera will stop lerping to the target.

    • immediateOrDuration: number | boolean = false

    Returns void

setLookTargetPosition

  • setLookTargetPosition(position?, immediateOrDuration?): void

  • Moves the camera look-at target to a position smoothly.

    Parameters

    • position: any = null
    • immediateOrDuration: boolean = false

    Returns void

setWorldPosition

setWorldQuaternion

  • setWorldQuaternion(x, y, z, w): void

  • Parameters

    • x: number
    • y: number
    • z: number
    • w: number

    Returns void

setWorldRotation

  • setWorldRotation(x, y, z, degrees?): void

  • Parameters

    • x: number
    • y: number
    • z: number
    • degrees: boolean = true

    Returns void

start

startCoroutine

stopCameraLerp

  • stopCameraLerp(): void

  • Call to stop camera position lerping

    Returns void

stopCoroutine

  • stopCoroutine(routine, evt?): void

  • Parameters

    • routine: Generator<unknown, any, unknown>
    • evt: FrameEvent = FrameEvent.Update

    Returns void

stopLookTargetLerp

  • stopLookTargetLerp(): void

  • Call to stop camera look target lerping

    Returns void

Optional update

Settings

Member Visibility

Theme

On This Page

allowInterruptautoFitautoTargettargetLerpDurationactiveAndEnabledcameraLerpActivecontextcontrollerObjectcontrolsdestroyedenabledforwardhideFlagsisCameraControllerisComponentlayerlookTargetLerpActivenamerightscenestatictagtargetLerpSpeedupworldEulerworldPositionworldQuaternionworldRotationaddEventListenerawakedestroydispatchEventearlyUpdatefitCameralateUpdatelerpTargetonAfterRenderonBeforeRenderonCollisionEnteronCollisionExitonCollisionStayonDestroyonDisableonEnableonPausedChangedonStartInteractiononTriggerEnteronTriggerExitonTriggerStayonValidateremoveEventListenerresolveGuidssetCameraAndLookTargetsetCameraTargetPositionsetLookTargetPositionsetWorldPositionsetWorldQuaternionsetWorldRotationstartstartCoroutinestopCameraLerpstopCoroutinestopLookTargetLerpupdate

Generated using TypeDoc