Class TrackballControls

Allows a camera to be manipulated using mouse controls. 

// The trackball controls a view implementation such as a camera.
const camera = new EIGHT.PerspectiveCamera()

// Create TrackballControls anytime.
const controls = new EIGHT.TrackballControls(camera)

// Subscribe to mouse events, usually in the window.onload function.
controls.subscribe(canvas)

// Update the camera position, usually in the animate function.
controls.update()

// Stop listening to mouse events.
controls.unsubscribe()

// Inform the controls they are no longer needed, usually in the window.onunload function.
controls.release()

You may decide to update directional lighting to synchronize with the camera.

Hierarchy

  • ViewControls
    • TrackballControls

Constructors

constructor

Properties

enabled eyeMinusLook look maxDistance minDistance moveCurr movePrev noPan noRotate noZoom panEnd panSpeed panStart rotateSpeed up zoomEnd zoomSpeed zoomStart

Methods

addRef disableContextMenu enableContextMenu getLoggingName handleResize hasView isZombie move release reset setLoggingName setView subscribe synchronize unsubscribe update zoomCamera

Constructors

constructor

Properties

enabled

enabled: boolean = true

Default

true

ProtectedeyeMinusLook

eyeMinusLook: Vector3 = ...

Protectedlook

look: Vector3 = ...

maxDistance

maxDistance: number = Infinity

Default

Infinity

minDistance

minDistance: number = 0

Default

0

ProtectedmoveCurr

moveCurr: Vector2 = ...

ProtectedmovePrev

movePrev: Vector2 = ...

noPan

noPan: boolean = false

Default

false

noRotate

noRotate: boolean = false

Default

false

noZoom

noZoom: boolean = false

Default

false

ProtectedpanEnd

panEnd: Vector2 = ...

panSpeed

panSpeed: number = 1

Default

1

ProtectedpanStart

panStart: Vector2 = ...

rotateSpeed

rotateSpeed: number = 1

Default

1

Protectedup

up: Vector3 = ...

ProtectedzoomEnd

zoomEnd: Vector2 = ...

zoomSpeed

zoomSpeed: number = 1

Default

1

ProtectedzoomStart

zoomStart: Vector2 = ...

Methods

addRef

  • addRef(): number

  • Notifies this instance that something is referencing it.

    Returns number

    The new value of the reference count.

disableContextMenu

enableContextMenu

getLoggingName

  • getLoggingName(): string

  • Returns the name that was assigned by the call to the setLoggingName method.

    Returns string

handleResize

ProtectedhasView

isZombie

  • isZombie(): boolean

  • An object is a zombie if it has been released by all who have held references. In some cases it may be possible to recycle a zombie.

    Returns boolean

move

  • move(x, y): void

  • Simulates a movement of the mouse in coordinates -1 to +1 in both directions.

    Parameters

    • x: number
    • y: number

    Returns void

release

  • release(): number

  • Notifies this instance that something is dereferencing it.

    Returns number

    The new value of the reference count.

reset

ProtectedsetLoggingName

  • setLoggingName(name): void

  • This method is for use within constructors.

    Immediately after a call to the super class constructor, make a call to setLoggingName. This will have the effect of refining the name used for reporting reference counts.

    This method has the secondary purpose of enabling a tally of the number of classes in the constructor chain. This enables the runtime architecture to verify that destructor chains are consistent with constructor chains, which is a good practice for cleaning up resources.

    Notice that this method is intentionally protected to discourage it from being called outside of the constructor.

    Parameters

    • name: string

      This will usually be set to the name of the class.

    Returns void

setView

subscribe

synchronize

unsubscribe

update

  • update(): void

  • This should be called inside the animation frame to update the camera location. Notice that the movement of the mouse controls is decoupled from the effect. We also want to avoid temporary object creation in this and called methods by recycling variables.

    Returns void

ProtectedzoomCamera

Settings

Member Visibility

On This Page

Constructors
Properties
Methods