@ue-too/board-react-adapter / useAllBoardCameraState

Function: useAllBoardCameraState()

useAllBoardCameraState(): object

Defined in: hooks/useBoardify.tsx:225

Hook to subscribe to all camera state properties with automatic re-rendering.

Returns

object

Object containing:

• position - Current camera position
• rotation - Current camera rotation in radians
• zoomLevel - Current camera zoom level

position

position: object

position.x

x: number

position.y

y: number

rotation

rotation: number

zoomLevel

zoomLevel: number

Remarks

This hook provides a snapshot of all camera state (position, rotation, zoomLevel) and re-renders only when any of these values change. It's more efficient than using multiple useBoardCameraState calls when you need all state properties.

Performance: The hook uses snapshot caching to maintain referential equality when values haven't changed, preventing unnecessary re-renders in child components.

Example

function CameraStateDisplay() {
  const { position, rotation, zoomLevel } = useAllBoardCameraState();

  return (
    <div>
      <h3>Camera State</h3>
      <p>Position: ({position.x.toFixed(2)}, {position.y.toFixed(2)})</p>
      <p>Rotation: {rotation.toFixed(2)} rad</p>
      <p>Zoom: {zoomLevel.toFixed(2)}x</p>
    </div>
  );
}

See

useBoardCameraState for subscribing to individual state properties