Class: PressBehaviour

Defined in: webxr-interactions/src/behaviours/press.ts:28

Implements

• Behaviour

Constructors

Constructor

new PressBehaviour(config?: Omit<PressConfig, "kind">): PressBehaviour;

Defined in: webxr-interactions/src/behaviours/press.ts:49

Parameters

Parameter	Type
config	Omit<PressConfig, "kind">

Returns

PressBehaviour

Properties

Property	Modifier	Type	Default value	Description	Defined in
grabbable	readonly	false	false	True when this behaviour makes the interactable a grab target.	webxr-interactions/src/behaviours/press.ts:33
kind	readonly	"press"	"press"	-	webxr-interactions/src/behaviours/press.ts:29
ownership	readonly	"driven"	undefined	-	webxr-interactions/src/behaviours/press.ts:30
requires	readonly	readonly []	undefined	ALL of these must be satisfied.	webxr-interactions/src/behaviours/press.ts:31
requiresAnyOf	readonly	readonly [readonly ["rays", "pokes", "pointer2d", "gaze"]]	undefined	For each group, AT LEAST ONE must be satisfied.	webxr-interactions/src/behaviours/press.ts:32

Accessors

isLatched

Get Signature

get isLatched(): boolean;

Defined in: webxr-interactions/src/behaviours/press.ts:127

Latched state (latching mode).

Returns

boolean

Methods

getDepthFraction()

getDepthFraction(): number;

Defined in: webxr-interactions/src/behaviours/press.ts:138

Returns

number

---

getSpring()

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

Defined in: webxr-interactions/src/behaviours/press.ts:144

Returns

{
  damping: number;
  stiffness: number;
}

Name	Type	Defined in
damping	number	webxr-interactions/src/behaviours/press.ts:144
stiffness	number	webxr-interactions/src/behaviours/press.ts:144

---

getTravel()

getTravel(): number;

Defined in: webxr-interactions/src/behaviours/press.ts:132

Returns

number

---

getValue()

getValue(): number;

Defined in: webxr-interactions/src/behaviours/press.ts:122

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

Returns

number

Implementation of

Behaviour.getValue

---

onPressEnd()

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

Defined in: webxr-interactions/src/behaviours/press.ts:88

Parameters

Parameter	Type
ctx	BehaviourContext
interactor	InteractorInfo

Returns

void

Implementation of

Behaviour.onPressEnd

---

onPressStart()

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

Defined in: webxr-interactions/src/behaviours/press.ts:58

Parameters

Parameter	Type
ctx	BehaviourContext
interactor	InteractorInfo

Returns

void

Implementation of

Behaviour.onPressStart

---

setDepthFraction()

setDepthFraction(fraction: number): void;

Defined in: webxr-interactions/src/behaviours/press.ts:141

Parameters

Parameter	Type
fraction	number

Returns

void

---

setSpring()

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

Defined in: webxr-interactions/src/behaviours/press.ts:147

Parameters

Parameter	Type
stiffness	number
damping	number

Returns

void

---

setTravel()

setTravel(travel: number): void;

Defined in: webxr-interactions/src/behaviours/press.ts:135

Parameters

Parameter	Type
travel	number

Returns

void

---

update()

update(ctx: BehaviourContext): void;

Defined in: webxr-interactions/src/behaviours/press.ts:101

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

Returns

void

Implementation of

Behaviour.update