Interface: PointerBeam
@roomful/core / PointerBeam
Interface: PointerBeam
Section titled “Interface: PointerBeam”Defined in: packages/core/src/types.ts:1126
Describes a single peer’s laser-pointer beam — a transient position broadcast
only while that peer’s pointer is active. x/y are normalized 0–1 of the
tracked container (resolution-independent, like cursor and viewport coordinates),
so each peer denormalizes them against its own container size.
Properties
Section titled “Properties”active
Section titled “active”active:
boolean
Defined in: packages/core/src/types.ts:1158
Indicates whether the peer’s pointer is currently broadcasting. An inactive beam is dropped by peers (the laser disappears).
color:
string
Defined in: packages/core/src/types.ts:1140
Supplies the peer color, resolved from the peer’s presence.
name:
string
Defined in: packages/core/src/types.ts:1135
Supplies the peer display name, resolved from the peer’s presence.
peerId
Section titled “peerId”peerId:
string
Defined in: packages/core/src/types.ts:1130
Identifies the peer that owns the beam.
x:
number
Defined in: packages/core/src/types.ts:1146
Reports the normalized X coordinate within the tracked container, from 0
(left edge) to 1 (right edge).
y:
number
Defined in: packages/core/src/types.ts:1152
Reports the normalized Y coordinate within the tracked container, from 0
(top edge) to 1 (bottom edge).