Skip to content

Interface: HoverChannel

Per-body hover publication channel.

Body factories write into the two refs when the user hovers a tile; scene-level projectors (e.g. TileCenterProjector) read them every frame to project the local-space tile center to screen pixels.

Each body owns its own channel — multi-body scenes can therefore host several hovered tiles concurrently without cross-body interference. Callers that want a single global hover slot (popover UX) can pass the same channel into multiple bodies via useBody(config, tileSize, { hoverChannel }).

Properties

hoverLocalPos

ts
hoverLocalPos: MutableRef<Vector3 | null>;

Local-space position of the currently hovered tile center, or null when no tile is hovered. Transformed to world-space each frame by the scene projector using hoverParentGroup's matrixWorld.


hoverParentGroup

ts
hoverParentGroup: MutableRef<Object3D<Object3DEventMap> | null>;

Parent group whose matrixWorld transforms hoverLocalPos to world space. Set to the body's root group when a tile is hovered.

Distribué sous la licence indiquée dans le dépôt.