Class: DialBehaviour

Defined in: webxr-interactions/src/behaviours/dial.ts:30

Implements

• Behaviour

Constructors

Constructor

new DialBehaviour(config?: Omit<DialConfig, "kind">): DialBehaviour;

Defined in: webxr-interactions/src/behaviours/dial.ts:43

Parameters

Parameter	Type
config	Omit<DialConfig, "kind">

Returns

DialBehaviour

Properties

Property	Modifier	Type	Default value	Description	Defined in
grabbable	readonly	true	true	True when this behaviour makes the interactable a grab target.	webxr-interactions/src/behaviours/dial.ts:34
kind	readonly	"dial"	"dial"	-	webxr-interactions/src/behaviours/dial.ts:31
ownership	readonly	"handDriven"	undefined	-	webxr-interactions/src/behaviours/dial.ts:32
requires	readonly	readonly ["grabs"]	undefined	ALL of these must be satisfied.	webxr-interactions/src/behaviours/dial.ts:33

Methods

getMaxAngle()

getMaxAngle(): number;

Defined in: webxr-interactions/src/behaviours/dial.ts:117

Returns

number

---

getValue()

getValue(): number;

Defined in: webxr-interactions/src/behaviours/dial.ts:108

Current logical 0..1 value (state snapshots, HUDs).

Returns

number

Implementation of

Behaviour.getValue

---

onGrabEnd()

onGrabEnd(ctx: BehaviourContext, interactor: InteractorInfo): void;

Defined in: webxr-interactions/src/behaviours/dial.ts:78

Parameters

Parameter	Type
ctx	BehaviourContext
interactor	InteractorInfo

Returns

void

Implementation of

Behaviour.onGrabEnd

---

onGrabStart()

onGrabStart(ctx: BehaviourContext, interactor: InteractorInfo): void;

Defined in: webxr-interactions/src/behaviours/dial.ts:65

Parameters

Parameter	Type
ctx	BehaviourContext
interactor	InteractorInfo

Returns

void

Implementation of

Behaviour.onGrabStart

---

setMaxAngle()

setMaxAngle(maxAngle: number): void;

Defined in: webxr-interactions/src/behaviours/dial.ts:112

Parameters

Parameter	Type
maxAngle	number

Returns

void

---

update()

update(ctx: BehaviourContext, holder?: InteractorInfo): void;

Defined in: webxr-interactions/src/behaviours/dial.ts:90

Per-frame tick. holder is set while a grab interactor holds this interactable (grab-family behaviours consume it; others ignore it).

Parameters

Parameter	Type
ctx	BehaviourContext
holder?	InteractorInfo

Returns

void

Implementation of

Behaviour.update