quilt-three / Class: NavigationControls

Defined in: packages/three/src/navigation-controls.ts:61

Optional hovered-viewport keyboard navigation, coordinated with damped OrbitControls.

Extends

• EventDispatcher<{ change: { }; inputchange: { actions: readonly NavigationAction[]; }; modechange: { mode: NavigationMode; }; }>

Implements

• ViewControls

Constructors

Constructor

new NavigationControls(context, options?): NavigationControls

Defined in: packages/three/src/navigation-controls.ts:93

Parameters

context

ControlsContext

options?

NavigationControlsOptions = {}

Returns

NavigationControls

Overrides

EventDispatcher<{ change: {}; modechange: { mode: NavigationMode }; inputchange: { actions: readonly NavigationAction[] }; }>.constructor

Properties

camera

readonly camera: PerspectiveCamera | OrthographicCamera

Defined in: packages/three/src/navigation-controls.ts:69

---

orbitTargetPolicy

orbitTargetPolicy: OrbitTargetPolicy

Defined in: packages/three/src/navigation-controls.ts:86

Policy used on the next return to Orbit; changing it does not move the camera.

---

target

readonly target: Vector3

Defined in: packages/three/src/navigation-controls.ts:70

Accessors

activeActions

Get Signature

get activeActions(): readonly NavigationAction[]

Defined in: packages/three/src/navigation-controls.ts:339

Actions currently held by this viewport; aliases and custom bindings are resolved.

Returns

readonly NavigationAction[]

---

enabled

Get Signature

get enabled(): boolean

Defined in: packages/three/src/navigation-controls.ts:205

Returns

boolean

Set Signature

set enabled(value): void

Defined in: packages/three/src/navigation-controls.ts:208

Parameters

value

boolean

Returns

void

Implementation of

ViewControls.enabled

---

mode

Get Signature

get mode(): NavigationMode

Defined in: packages/three/src/navigation-controls.ts:194

Current navigation mode; use setMode() to switch.

Returns

NavigationMode

---

speed

Get Signature

get speed(): number

Defined in: packages/three/src/navigation-controls.ts:198

Base world units per second, clamped to the configured speed limits.

Returns

number

Set Signature

set speed(value): void

Defined in: packages/three/src/navigation-controls.ts:201

Parameters

value

number

Returns

void

Methods

addEventListener()

addEventListener<T>(type, listener): void

Adds a listener to an event type.

Type Parameters

T

T extends "change" | "modechange" | "inputchange"

Parameters

type

T

The type of event to listen to.

listener

EventListener<object[T], T, NavigationControls>

The function that gets called when the event is fired.

Returns

void

Inherited from

EventDispatcher.addEventListener

---

dispatchEvent()

dispatchEvent<T>(event): void

Fire an event type.

Type Parameters

T

T extends "change" | "modechange" | "inputchange"

Parameters

event

BaseEvent<T> & object[T]

The event that gets fired.

Returns

void

Inherited from

EventDispatcher.dispatchEvent

---

dispose()

dispose(): void

Defined in: packages/three/src/navigation-controls.ts:508

Remove listeners and underlying controls without disposing camera or scene assets. Idempotent.

Returns

void

Implementation of

ViewControls.dispose

---

hasEventListener()

hasEventListener<T>(type, listener): boolean

Checks if listener is added to an event type.

Type Parameters

T

T extends "change" | "modechange" | "inputchange"

Parameters

type

T

The type of event to listen to.

listener

EventListener<object[T], T, NavigationControls>

The function that gets called when the event is fired.

Returns

boolean

Inherited from

EventDispatcher.hasEventListener

---

removeEventListener()

removeEventListener<T>(type, listener): void

Removes a listener from an event type.

Type Parameters

T

T extends "change" | "modechange" | "inputchange"

Parameters

type

T

The type of the listener that gets removed.

listener

EventListener<object[T], T, NavigationControls>

The listener function that gets removed.

Returns

void

Inherited from

EventDispatcher.removeEventListener

---

reset()

reset(): void

Defined in: packages/three/src/navigation-controls.ts:291

Restore the initial pose and Orbit mode while enabled.

Returns

void

---

setMode()

setMode(mode): void

Defined in: packages/three/src/navigation-controls.ts:251

Switch modes immediately, clearing motion. Preserve turns toward the saved target on return.

Parameters

mode

NavigationMode

Returns

void

---

setPosition()

setPosition(position): void

Defined in: packages/three/src/navigation-controls.ts:281

Translate position and orbit target together, preserving orientation and zoom.

Parameters

position

Vector3

Returns

void

---

update()

update(delta): boolean

Defined in: packages/three/src/navigation-controls.ts:463

Advance in seconds through the session scheduler; true requests another frame.

Parameters

delta

number

Returns

boolean

Implementation of

ViewControls.update