uē-tôo

Appearance

@ue-too/board / createDefaultCameraRig

Function: createDefaultCameraRig() ​

createDefaultCameraRig(camera): CameraRig

Defined in: packages/board/src/camera/camera-rig/camera-rig.ts:940

Creates a camera rig with sensible default configuration.

Parameters ​

camera ​

ObservableBoardCamera

Observable camera instance to control

Returns ​

CameraRig

Configured camera rig ready for use

Remarks ​

This factory function creates a DefaultCameraRig with a balanced default configuration:

Enabled by default:

  • limitEntireViewPort: true - Entire viewport stays within boundaries
  • clampTranslation: true - Position is clamped to boundaries
  • clampZoom: true - Zoom is clamped to limits

Disabled by default:

  • All movement restrictions (restrictXTranslation, restrictYTranslation, etc.)
  • Zoom restrictions (restrictZoom)
  • Relative translation restrictions

This configuration allows free camera movement with boundary enforcement, suitable for most infinite canvas applications.

Example ​

typescript
const camera = new DefaultBoardCamera(1920, 1080);
const rig = createDefaultCameraRig(camera);

// Ready to use with sensible defaults
rig.configure({
  boundaries: {
    min: { x: -1000, y: -1000 },
    max: { x: 1000, y: 1000 }
  }
});

rig.panByViewPort({ x: 100, y: 50 });
rig.zoomByAt(0.1, mousePosition);

See ​