Class: SlideBehaviour

Defined in: packages/webxr-interactions/src/behaviours/slide.ts:23

Implements

• Behaviour

Constructors

Constructor

new SlideBehaviour(config?: Omit<SlideConfig, "kind">): SlideBehaviour;

Defined in: packages/webxr-interactions/src/behaviours/slide.ts:42

Parameters

Parameter	Type
config	Omit<SlideConfig, "kind">

Returns

SlideBehaviour

Properties

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

Methods

getSpring()

getSpring(): {
  damping: number;
  stiffness: number;
};

Defined in: packages/webxr-interactions/src/behaviours/slide.ts:128

Returns

{
  damping: number;
  stiffness: number;
}

Name	Type	Defined in
damping	number	packages/webxr-interactions/src/behaviours/slide.ts:128
stiffness	number	packages/webxr-interactions/src/behaviours/slide.ts:128

---

getTravel()

getTravel(): number;

Defined in: packages/webxr-interactions/src/behaviours/slide.ts:119

Returns

number

---

getValue()

getValue(): number;

Defined in: packages/webxr-interactions/src/behaviours/slide.ts:110

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

Returns

number

Implementation of

Behaviour.getValue

---

onGrabEnd()

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

Defined in: packages/webxr-interactions/src/behaviours/slide.ts:74

Parameters

Parameter	Type
ctx	BehaviourContext
interactor	InteractorInfo

Returns

void

Implementation of

Behaviour.onGrabEnd

---

onGrabStart()

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

Defined in: packages/webxr-interactions/src/behaviours/slide.ts:59

Parameters

Parameter	Type
ctx	BehaviourContext
interactor	InteractorInfo

Returns

void

Implementation of

Behaviour.onGrabStart

---

setSpring()

setSpring(stiffness: number, damping: number): void;

Defined in: packages/webxr-interactions/src/behaviours/slide.ts:123

Parameters

Parameter	Type
stiffness	number
damping	number

Returns

void

---

setTravel()

setTravel(travel: number): void;

Defined in: packages/webxr-interactions/src/behaviours/slide.ts:114

Parameters

Parameter	Type
travel	number

Returns

void

---

update()

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

Defined in: packages/webxr-interactions/src/behaviours/slide.ts:86

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