Class: GrabSystem

Defined in: packages/core/src/grab/grab-system.ts:51

Manages interactive object grabbing and manipulation for VR/AR experiences.

Remarks

Uses the @pmndrs/handle library for precise multitouch manipulation.
Automatically creates handle instances for entities with grabbable components.
Supports three types of grab interactions: one‑hand, two‑hand, and distance grabbing.
Automatically cleans up handle instances when grabbable components are removed.

Examples

// Add to your world to enable grab interactions
world.addSystem(GrabSystem)

// Create a grabbable box
const box = world.createEntity()
box.addComponent(OneHandGrabbable, {})

// Create an object that can be scaled with two hands
const sculpture = world.createEntity()
sculpture.addComponent(TwoHandsGrabbable, {
  scaleMin: [0.5, 0.5, 0.5],
  scaleMax: [3, 3, 3]
})

See

Extends

System<SystemSchema, { distanceGrabbables: { required: Component<{ movementMode: { default: string; enum: { MoveAtSource: string; MoveFromTarget: string; MoveTowardsTarget: string; RotateAtSource: string; }; type: Enum; }; moveSpeed: { default: number; type: Float32; }; returnToOrigin: { default: false; type: Boolean; }; rotate: { default: true; type: Boolean; }; rotateMax: { default: [number, number, number]; type: Vec3; }; rotateMin: { default: [number, number, number]; type: Vec3; }; scale: { default: true; type: Boolean; }; scaleMax: { default: [number, number, number]; type: Vec3; }; scaleMin: { default: [number, number, number]; type: Vec3; }; translate: { default: true; type: Boolean; }; translateMax: { default: [number, number, number]; type: Vec3; }; translateMin: { default: [number, number, number]; type: Vec3; }; }>[]; }; handles: { required: Component<{ instance: { default: any; type: Object; }; }>[]; }; oneHandGrabbables: { required: Component<{ rotate: { default: true; type: Boolean; }; rotateMax: { default: [number, number, number]; type: Vec3; }; rotateMin: { default: [number, number, number]; type: Vec3; }; translate: { default: true; type: Boolean; }; translateMax: { default: [number, number, number]; type: Vec3; }; translateMin: { default: [number, number, number]; type: Vec3; }; }>[]; }; twoHandsGrabbables: { required: Component<{ rotate: { default: true; type: Boolean; }; rotateMax: { default: [number, number, number]; type: Vec3; }; rotateMin: { default: [number, number, number]; type: Vec3; }; scale: { default: true; type: Boolean; }; scaleMax: { default: [number, number, number]; type: Vec3; }; scaleMin: { default: [number, number, number]; type: Vec3; }; translate: { default: true; type: Boolean; }; translateMax: { default: [number, number, number]; type: Vec3; }; translateMin: { default: [number, number, number]; type: Vec3; }; }>[]; }; }, this>

Constructors

Constructor

new GrabSystem(_w, _qm, _p): GrabSystem

Defined in: node_modules/.pnpm/elics@3.3.0/node_modules/elics/lib/system.d.ts:73

Parameters

_w

World

_qm

QueryManager

_p

number

Returns

GrabSystem

Inherited from

createSystem({ oneHandGrabbables: { required: [OneHandGrabbable], }, twoHandsGrabbables: { required: [TwoHandsGrabbable], }, distanceGrabbables: { required: [DistanceGrabbable], }, handles: { required: [Handle], }, }).constructor