Skip to main content

Class: CameraComponent

Defined in: rendering/components/camera-component.ts:49

The CameraComponent class implements the Component interface and represents a camera in the rendering system. It provides properties for zooming and panning sensitivity, as well as options to restrict zoom levels and enable/disable panning and zooming.

Implements​

Constructors​

Constructor​

new CameraComponent(options): CameraComponent

Defined in: rendering/components/camera-component.ts:82

Constructs a new instance of the CameraComponent class with the given options.

Parameters​

options​

Partial<CameraComponentOptions> = defaultOptions

Partial options to configure the camera component.

Returns​

CameraComponent

Properties​

isStatic​

isStatic: boolean

Defined in: rendering/components/camera-component.ts:69

Indicates if the camera is static (non-movable).

maxZoom​

maxZoom: number

Defined in: rendering/components/camera-component.ts:66

The maximum zoom level allowed.

minZoom​

minZoom: number

Defined in: rendering/components/camera-component.ts:63

The minimum zoom level allowed.

name​

name: symbol

Defined in: rendering/components/camera-component.ts:51

The name property holds the unique symbol for this component.

Implementation of​

Component.name

panInput?​

optional panInput: Axis2dAction

Defined in: rendering/components/camera-component.ts:73

panSensitivity​

panSensitivity: number

Defined in: rendering/components/camera-component.ts:60

The sensitivity of the panning controls.

zoom​

zoom: number

Defined in: rendering/components/camera-component.ts:54

The current zoom level of the camera.

zoomInput?​

optional zoomInput: Axis1dAction

Defined in: rendering/components/camera-component.ts:71

zoomSensitivity​

zoomSensitivity: number

Defined in: rendering/components/camera-component.ts:57

The sensitivity of the zoom controls.

symbol​

readonly static symbol: typeof symbol

Defined in: rendering/components/camera-component.ts:76

A static symbol property that uniquely identifies the CameraComponent.

Methods​

createDefaultCamera()​

static createDefaultCamera(isStatic): CameraComponent

Defined in: rendering/components/camera-component.ts:104

Creates a default camera component with the option to set it as static.

Parameters​

isStatic​

boolean = false

Indicates if the camera should be static (default: false).

Returns​

CameraComponent

A new CameraComponent instance with default settings.