Class: HingeBehaviour
Defined in: behaviours/hinge.ts:35
Implements
Constructors
Constructor
new HingeBehaviour(config?: Omit<HingeConfig, "kind">): HingeBehaviour;
Defined in: behaviours/hinge.ts:48
Parameters
| Parameter | Type |
|---|---|
config | Omit<HingeConfig, "kind"> |
Returns
HingeBehaviour
Properties
| Property | Modifier | Type | Default value | Description | Defined in |
|---|---|---|---|---|---|
grabbable | readonly | true | true | True when this behaviour makes the interactable a grab target. | behaviours/hinge.ts:39 |
kind | readonly | "hinge" | "hinge" | - | behaviours/hinge.ts:36 |
ownership | readonly | "handDriven" | undefined | - | behaviours/hinge.ts:37 |
requires | readonly | readonly ["grabs"] | undefined | ALL of these must be satisfied. | behaviours/hinge.ts:38 |
Methods
getMaxAngle()
getMaxAngle(): number;
Defined in: behaviours/hinge.ts:105
Returns
number
getValue()
getValue(): number;
Defined in: behaviours/hinge.ts:96
Current logical 0..1 value (state snapshots, HUDs).
Returns
number
Implementation of
onGrabEnd()
onGrabEnd(ctx: BehaviourContext, interactor: InteractorInfo): void;
Defined in: behaviours/hinge.ts:66
Parameters
| Parameter | Type |
|---|---|
ctx | BehaviourContext |
interactor | InteractorInfo |
Returns
void
Implementation of
onGrabStart()
onGrabStart(ctx: BehaviourContext, interactor: InteractorInfo): void;
Defined in: behaviours/hinge.ts:55
Parameters
| Parameter | Type |
|---|---|
ctx | BehaviourContext |
interactor | InteractorInfo |
Returns
void
Implementation of
setMaxAngle()
setMaxAngle(maxAngle: number): void;
Defined in: behaviours/hinge.ts:101
Live-tune the swing range (playground steppers).
Parameters
| Parameter | Type |
|---|---|
maxAngle | number |
Returns
void
update()
update(ctx: BehaviourContext, holder?: InteractorInfo): void;
Defined in: behaviours/hinge.ts:77
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