Abstract Class: XRInputVisualAdapter

Defined in: packages/xr-input/src/visual/adapter/base-visual-adapter.ts:57

Extended by

• XRControllerVisualAdapter
• XRHandVisualAdapter

Constructors

Constructor

new XRInputVisualAdapter(playerSpace, handedness, visualsEnabled, visualClass, scene, camera, assetLoader): XRInputVisualAdapter

Defined in: packages/xr-input/src/visual/adapter/base-visual-adapter.ts:66

Parameters

playerSpace

Group

handedness

XRHandedness

visualsEnabled

boolean

visualClass

VisualConstructor<VisualImplementation>

scene

Scene

camera

PerspectiveCamera

assetLoader

XRAssetLoader

Returns

XRInputVisualAdapter

Properties

gripSpace

gripSpace: Group<Object3DEventMap>

Defined in: packages/xr-input/src/visual/adapter/base-visual-adapter.ts:62

---

handedness

handedness: XRHandedness

Defined in: packages/xr-input/src/visual/adapter/base-visual-adapter.ts:68

---

isPrimary

isPrimary: boolean = false

Defined in: packages/xr-input/src/visual/adapter/base-visual-adapter.ts:63

---

raySpace

raySpace: Group<Object3DEventMap>

Defined in: packages/xr-input/src/visual/adapter/base-visual-adapter.ts:61

---

visual?

optional visual: VisualImplementation

Defined in: packages/xr-input/src/visual/adapter/base-visual-adapter.ts:59

---

cursorPool

static cursorPool: Mesh<BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>, MeshBasicMaterial, Object3DEventMap>[] = []

Defined in: packages/xr-input/src/visual/adapter/base-visual-adapter.ts:58

---

visualCache

static visualCache: Map<string, VisualImplementation>

Defined in: packages/xr-input/src/visual/adapter/base-visual-adapter.ts:170

Accessors

connected

Get Signature

get connected(): boolean

Defined in: packages/xr-input/src/visual/adapter/base-visual-adapter.ts:143

Returns

boolean

---

inputSource

Get Signature

get inputSource(): XRInputSource

Defined in: packages/xr-input/src/visual/adapter/base-visual-adapter.ts:148

Returns

XRInputSource

---

pointerBusy

Get Signature

get pointerBusy(): boolean

Defined in: packages/xr-input/src/visual/adapter/base-visual-adapter.ts:166

Returns

boolean

Methods

connect()

connect(inputSource): void

Defined in: packages/xr-input/src/visual/adapter/base-visual-adapter.ts:152

Parameters

inputSource

XRInputSource

Returns

void

---

disconnect()

disconnect(): void

Defined in: packages/xr-input/src/visual/adapter/base-visual-adapter.ts:160

Returns

void

---

update()

abstract update(frame, delta): void

Defined in: packages/xr-input/src/visual/adapter/base-visual-adapter.ts:164

Parameters

frame

XRFrame

delta

number

Returns

void

---

updateVisualImplementation()

updateVisualImplementation<T>(visualClass): void

Defined in: packages/xr-input/src/visual/adapter/base-visual-adapter.ts:135

Swap the controller/hand visual to a different VisualImplementation subclass at runtime. Tears down the current visual (model removed from the scene graph, xrInput cleared) and triggers asset load + init() for the new class on the next tick.

Type Parameters

T

T extends VisualImplementation

Parameters

visualClass

VisualConstructor<T>

A VisualConstructor — typically a subclass of BaseControllerVisual (for controllers) or BaseHandVisual (for hands), or one of the built-in implementations such as AnimatedController, AnimatedControllerHand, or AnimatedHand.

Returns

void

Example

import { BaseControllerVisual, type VisualConstructor } from '@iwsdk/xr-input';

class MyCustomController extends BaseControllerVisual {
  init() { ... }
}

controllerAdapter.updateVisualImplementation(
  MyCustomController as VisualConstructor<MyCustomController>,
);

---

createVisual()

static createVisual<T>(visualClass, inputSource, layout, enabled, scene, camera, assetLoader, profileAssetPath?): Promise<T>

Defined in: packages/xr-input/src/visual/adapter/base-visual-adapter.ts:172

Type Parameters

T

T extends VisualImplementation

Parameters

visualClass

VisualConstructor<T>

inputSource

XRInputSource

layout

InputLayout

enabled

boolean

scene

Scene

camera

PerspectiveCamera

assetLoader

XRAssetLoader

profileAssetPath?

string

Returns

Promise<T>