@ue-too/board / index / clampToHandler

函式: clampToHandler()

clampToHandler(destination, camera, config): Point

定義於: packages/board/src/camera/camera-rig/pan-handler.ts:467

Handler pipeline step that clamps "pan to" destinations to camera boundaries.

參數

destination

Point

Target camera position in world space

camera

BoardCamera

Current camera instance (provides boundaries and viewport dimensions)

config

PanHandlerClampConfig

Clamping configuration

回傳

Point

Clamped destination position

備註

This handler enforces boundary constraints on absolute camera positioning. Behavior depends on configuration:

• If clampTranslation is false: Returns destination unchanged (no clamping)
• If limitEntireViewPort is false: Clamps camera center to boundaries
• If limitEntireViewPort is true: Ensures entire viewport rectangle stays in bounds

The entire-viewport mode accounts for:

• Viewport dimensions (width/height)
• Current zoom level (affects viewport size in world space)
• Camera rotation (affects viewport orientation)

Can be used standalone, but typically composed into a handler pipeline via createDefaultPanToHandler or createHandlerChain.

範例

// Standalone usage - ensure entire viewport stays in bounds
camera.boundaries = {
  min: { x: 0, y: 0 },
  max: { x: 2000, y: 1000 }
};

const config: PanHandlerClampConfig = {
  clampTranslation: true,
  limitEntireViewPort: true
};

const destination = { x: 2500, y: 500 };  // Outside bounds
const clamped = clampToHandler(destination, camera, config);
// Result keeps entire viewport within [0,0] to [2000,1000]

參閱

• clampPoint for center-point clamping
• clampPointEntireViewPort for full-viewport clamping
• createDefaultPanToHandler for default pipeline usage