@ue-too/board / PanHandlerRestrictionConfig

Type Alias: PanHandlerRestrictionConfig

PanHandlerRestrictionConfig = object

Defined in: packages/board/src/camera/camera-rig/pan-handler.ts:102

Configuration for restricting camera movement along specific axes.

Remarks

Provides fine-grained control over which directions the camera can move. Supports both world-space restrictions (absolute X/Y) and viewport-relative restrictions (screen-space horizontal/vertical, accounting for rotation).

World-space restrictions:

• restrictXTranslation: Prevents movement along world X axis
• restrictYTranslation: Prevents movement along world Y axis

Viewport-relative restrictions (rotation-aware):

• restrictRelativeXTranslation: Prevents horizontal movement (screen-space)
• restrictRelativeYTranslation: Prevents vertical movement (screen-space)

Use cases:

• Side-scrolling games: restrictYTranslation = true
• Locked vertical scrolling: restrictRelativeYTranslation = true
• Fixed-axis pan tools in editors

Example

// Side-scroller: only allow horizontal movement in world space
const config: PanHandlerRestrictionConfig = {
  restrictXTranslation: false,
  restrictYTranslation: true,
  restrictRelativeXTranslation: false,
  restrictRelativeYTranslation: false
};

// Lock to vertical screen movement only (with camera rotation)
const screenConfig: PanHandlerRestrictionConfig = {
  restrictXTranslation: false,
  restrictYTranslation: false,
  restrictRelativeXTranslation: true,
  restrictRelativeYTranslation: false
};

Properties

restrictRelativeXTranslation

restrictRelativeXTranslation: boolean

Defined in: packages/board/src/camera/camera-rig/pan-handler.ts:115

Whether to prevent horizontal movement in viewport/screen space. Accounts for camera rotation - locks movement perpendicular to screen's vertical direction.

---

restrictRelativeYTranslation

restrictRelativeYTranslation: boolean

Defined in: packages/board/src/camera/camera-rig/pan-handler.ts:120

Whether to prevent vertical movement in viewport/screen space. Accounts for camera rotation - locks movement perpendicular to screen's horizontal direction.

---

restrictXTranslation

restrictXTranslation: boolean

Defined in: packages/board/src/camera/camera-rig/pan-handler.ts:106

Whether to prevent movement along the world X axis.

---

restrictYTranslation

restrictYTranslation: boolean

Defined in: packages/board/src/camera/camera-rig/pan-handler.ts:110

Whether to prevent movement along the world Y axis.