Class OrbitControls

Hierarchy (view full)

Implements

  • ICameraController

Properties

autoTarget

Accessors

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

Methods

addEventListener awake destroy dispatchEvent distanceToTarget earlyUpdate? fitCamera lateUpdate? lerpTarget onAfterRender? onBeforeRender onCollisionEnter? onCollisionExit? onCollisionStay? onDestroy onDisable onEnable onStartInteraction onTriggerEnter? onTriggerExit? onTriggerStay? onValidate? removeEventListener resolveGuids? setCameraTarget setFromTargetPosition setTarget setWorldPosition setWorldQuaternion setWorldRotation start startCoroutine stopCoroutine update?

Properties

autoTarget

autoTarget: boolean = true

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

Accessors

activeAndEnabled

  • get activeAndEnabled(): boolean

  • Returns boolean

context

  • get context(): Context

  • Returns Context

  • set context(context): void

  • Parameters

    Returns void

controllerObject

  • get controllerObject(): any

  • Returns any

controls

  • get controls(): any

  • Returns any

destroyed

  • get destroyed(): boolean

  • Returns boolean

enabled

  • get enabled(): boolean

  • Returns boolean

  • set enabled(val): void

  • Parameters

    • val: boolean

    Returns void

forward

hideFlags

  • get hideFlags(): HideFlags

  • Returns HideFlags

isCameraController

  • get isCameraController(): boolean

  • Returns boolean

isComponent

  • get isComponent(): boolean

  • Returns boolean

layer

  • get layer(): number

  • Returns number

name

  • get name(): string

  • Returns string

  • set name(str): void

  • Parameters

    • str: string

    Returns void

right

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

up

worldEuler

  • get worldEuler(): Euler

  • Returns Euler

  • set worldEuler(val): void

  • Parameters

    Returns void

worldPosition

  • get worldPosition(): Vector3

  • Returns Vector3

  • set worldPosition(val): void

  • Parameters

    Returns void

worldQuaternion

  • get worldQuaternion(): Quaternion

  • Returns Quaternion

  • set worldQuaternion(val): void

  • Parameters

    Returns void

worldRotation

  • get worldRotation(): Vector3

  • Returns Vector3

  • set worldRotation(val): void

  • Parameters

    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

distanceToTarget

  • distanceToTarget(position): number

  • Parameters

    Returns number

Optional earlyUpdate

fitCamera

  • fitCamera(objects?, fitOffset?): 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

    Returns void

Optional lateUpdate

lerpTarget

  • lerpTarget(position, delta): void

  • Parameters

    Returns void

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

onStartInteraction

  • onStartInteraction(func): void

  • 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

setCameraTarget

  • setCameraTarget(position?, immediate?): void

  • Parameters

    • Optional position: any
    • immediate: boolean = false

    Returns void

setFromTargetPosition

  • setFromTargetPosition(index?, t?): boolean

  • Parameters

    • index: number = 0
    • t: number = 1

    Returns boolean

setTarget

  • setTarget(position?, immediate?): void

  • Parameters

    • position: any = null
    • immediate: 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

stopCoroutine

  • stopCoroutine(routine, evt?): void

  • Parameters

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

    Returns void

Optional update

Settings

Member Visibility

Theme

On This Page

autoTargetactiveAndEnabledcontextcontrollerObjectcontrolsdestroyedenabledforwardhideFlagsisCameraControllerisComponentlayernamerightscenestatictagupworldEulerworldPositionworldQuaternionworldRotationaddEventListenerawakedestroydispatchEventdistanceToTargetearlyUpdatefitCameralateUpdatelerpTargetonAfterRenderonBeforeRenderonCollisionEnteronCollisionExitonCollisionStayonDestroyonDisableonEnableonStartInteractiononTriggerEnteronTriggerExitonTriggerStayonValidateremoveEventListenerresolveGuidssetCameraTargetsetFromTargetPositionsetTargetsetWorldPositionsetWorldQuaternionsetWorldRotationstartstartCoroutinestopCoroutineupdate

Generated using TypeDoc