Class: Camera

sigma/src.Camera

Camera class

Hierarchy

• TypedEventEmitter<CameraEvents>

  ↳ Camera

Implements

• CameraState

Constructors

constructor

• new Camera(): Camera

Returns

Camera

Overrides

TypedEventEmitter&lt;CameraEvents&gt;.constructor

Defined in

sigma/src/core/camera.ts:43

Properties

angle

• angle: number = 0

Implementation of

CameraState.angle

Defined in

sigma/src/core/camera.ts:31

---

animationCallback

• Optional animationCallback: () => void

Type declaration

▸ (): void

Returns

void

Defined in

sigma/src/core/camera.ts:41

---

enabled

• Private enabled: boolean = true

Defined in

sigma/src/core/camera.ts:39

---

maxRatio

• maxRatio: null | number = null

Defined in

sigma/src/core/camera.ts:35

---

minRatio

• minRatio: null | number = null

Defined in

sigma/src/core/camera.ts:34

---

nextFrame

• Private nextFrame: null | number = null

Defined in

sigma/src/core/camera.ts:37

---

previousState

• Private previousState: null | CameraState = null

Defined in

sigma/src/core/camera.ts:38

---

ratio

• ratio: number = 1

Implementation of

CameraState.ratio

Defined in

sigma/src/core/camera.ts:32

---

rawEmitter

• rawEmitter: EventEmitter<DefaultEventMap>

Inherited from

TypedEventEmitter.rawEmitter

Defined in

sigma/src/types.ts:103

---

x

• x: number = 0.5

Implementation of

CameraState.x

Defined in

sigma/src/core/camera.ts:29

---

y

• y: number = 0.5

Implementation of

CameraState.y

Defined in

sigma/src/core/camera.ts:30

Methods

addListener

▸ addListener<Event>(type, listener): this

Type parameters

Name	Type
Event	extends "updated"

Parameters

Name	Type
type	Event
listener	CameraEvents[Event]

Returns

this

Inherited from

TypedEventEmitter.addListener

Defined in

sigma/src/types.ts:109

---

animate

▸ animate(state, opts?, callback?): void

Method used to animate the camera.

Parameters

Name	Type	Description
state	Partial<CameraState>	State to reach eventually.
opts?	Partial<AnimateOptions>	Options:
callback?	() => void	Callback

Returns

void

Defined in

sigma/src/core/camera.ts:206

---

animatedReset

▸ animatedReset(options?): void

Method used to reset the camera.

Parameters

Name	Type	Description
options?	Partial<AnimateOptions>	Options.

Returns

void

Defined in

sigma/src/core/camera.ts:308

---

animatedUnzoom

▸ animatedUnzoom(factorOrOptions?): void

Method used to unzoom the camera.

Parameters

Name	Type	Description
factorOrOptions?	number | Partial<AnimateOptions> & { factor?: number }	Factor or options.

Returns

void

Defined in

sigma/src/core/camera.ts:288

---

animatedZoom

▸ animatedZoom(factorOrOptions?): void

Method used to zoom the camera.

Parameters

Name	Type	Description
factorOrOptions?	number | Partial<AnimateOptions> & { factor?: number }	Factor or options.

Returns

void

Defined in

sigma/src/core/camera.ts:268

---

copy

▸ copy(): Camera

Returns a new Camera instance, with the same state as the current camera.

Returns

Camera

Defined in

sigma/src/core/camera.ts:325

---

disable

▸ disable(): this

Method used to disable the camera.

Returns

this

Defined in

sigma/src/core/camera.ts:76

---

emit

▸ emit<Event>(type, ...args): boolean

Type parameters

Name	Type
Event	extends "updated"

Parameters

Name	Type
type	Event
...args	Parameters<CameraEvents[Event]>

Returns

boolean

Inherited from

TypedEventEmitter.emit

Defined in

sigma/src/types.ts:108

---

enable

▸ enable(): this

Method used to enable the camera.

Returns

this

Defined in

sigma/src/core/camera.ts:66

---

eventNames

▸ eventNames<Event>(): Event[]

Type parameters

Name	Type
Event	extends "updated"

Returns

Event[]

Inherited from

TypedEventEmitter.eventNames

Defined in

sigma/src/types.ts:105

---

getBoundedRatio

▸ getBoundedRatio(ratio): number

Method used to check minRatio and maxRatio values.

Parameters

Name	Type
ratio	number

Returns

number

Defined in

sigma/src/core/camera.ts:128

---

getMaxListeners

▸ getMaxListeners(): number

Returns

number

Inherited from

TypedEventEmitter.getMaxListeners

Defined in

sigma/src/types.ts:107

---

getPreviousState

▸ getPreviousState(): null | CameraState

Method used to retrieve the camera's previous state.

Returns

null | CameraState

Defined in

sigma/src/core/camera.ts:109

---

getState

▸ getState(): CameraState

Method used to retrieve the camera's current state.

Returns

CameraState

Defined in

sigma/src/core/camera.ts:86

---

hasState

▸ hasState(state): boolean

Method used to check whether the camera has the given state.

Parameters

Name	Type
state	CameraState

Returns

boolean

Defined in

sigma/src/core/camera.ts:100

---

isAnimated

▸ isAnimated(): boolean

Method used to check whether the camera is currently being animated.

Returns

boolean

Defined in

sigma/src/core/camera.ts:155

---

listenerCount

▸ listenerCount<Event>(type): number

Type parameters

Name	Type
Event	extends "updated"

Parameters

Name	Type
type	Event

Returns

number

Inherited from

TypedEventEmitter.listenerCount

Defined in

sigma/src/types.ts:118

---

listeners

▸ listeners<Event>(type): CameraEvents[Event][]

Type parameters

Name	Type
Event	extends "updated"

Parameters

Name	Type
type	Event

Returns

CameraEvents[Event][]

Inherited from

TypedEventEmitter.listeners

Defined in

sigma/src/types.ts:117

---

off

▸ off<Event>(type, listener): this

Type parameters

Name	Type
Event	extends "updated"

Parameters

Name	Type
type	Event
listener	CameraEvents[Event]

Returns

this

Inherited from

TypedEventEmitter.off

Defined in

sigma/src/types.ts:115

---

on

▸ on<Event>(type, listener): this

Type parameters

Name	Type
Event	extends "updated"

Parameters

Name	Type
type	Event
listener	CameraEvents[Event]

Returns

this

Inherited from

TypedEventEmitter.on

Defined in

sigma/src/types.ts:110

---

once

▸ once<Event>(type, listener): this

Type parameters

Name	Type
Event	extends "updated"

Parameters

Name	Type
type	Event
listener	CameraEvents[Event]

Returns

this

Inherited from

TypedEventEmitter.once

Defined in

sigma/src/types.ts:111

---

prependListener

▸ prependListener<Event>(type, listener): this

Type parameters

Name	Type
Event	extends "updated"

Parameters

Name	Type
type	Event
listener	CameraEvents[Event]

Returns

this

Inherited from

TypedEventEmitter.prependListener

Defined in

sigma/src/types.ts:112

---

prependOnceListener

▸ prependOnceListener<Event>(type, listener): this

Type parameters

Name	Type
Event	extends "updated"

Parameters

Name	Type
type	Event
listener	CameraEvents[Event]

Returns

this

Inherited from

TypedEventEmitter.prependOnceListener

Defined in

sigma/src/types.ts:113

---

rawListeners

▸ rawListeners<Event>(type): CameraEvents[Event][]

Type parameters

Name	Type
Event	extends "updated"

Parameters

Name	Type
type	Event

Returns

CameraEvents[Event][]

Inherited from

TypedEventEmitter.rawListeners

Defined in

sigma/src/types.ts:119

---

removeAllListeners

▸ removeAllListeners<Event>(type?): this

Type parameters

Name	Type
Event	extends "updated"

Parameters

Name	Type
type?	Event

Returns

this

Inherited from

TypedEventEmitter.removeAllListeners

Defined in

sigma/src/types.ts:116

---

removeListener

▸ removeListener<Event>(type, listener): this

Type parameters

Name	Type
Event	extends "updated"

Parameters

Name	Type
type	Event
listener	CameraEvents[Event]

Returns

this

Inherited from

TypedEventEmitter.removeListener

Defined in

sigma/src/types.ts:114

---

setMaxListeners

▸ setMaxListeners(n): this

Parameters

Name	Type
n	number

Returns

this

Inherited from

TypedEventEmitter.setMaxListeners

Defined in

sigma/src/types.ts:106

---

setState

▸ setState(state): this

Method used to set the camera's state.

Parameters

Name	Type	Description
state	Partial<CameraState>	New state.

Returns

this

Defined in

sigma/src/core/camera.ts:165

---

updateState

▸ updateState(updater): this

Method used to update the camera's state using a function.

Parameters

Name	Type	Description
updater	(state: CameraState) => Partial<CameraState>	Updated function taking current state and returning next state.

Returns

this

Defined in

sigma/src/core/camera.ts:192

---

validateState

▸ validateState(state): Partial<CameraState>

Method used to check various things to return a legit state candidate.

Parameters

Name	Type
state	Partial<CameraState>

Returns

Partial<CameraState>

Defined in

sigma/src/core/camera.ts:141

---

from

▸ from(state): Camera

Static method used to create a Camera object with a given state.

Parameters

Name	Type
state	CameraState

Returns

Camera

Defined in

sigma/src/core/camera.ts:56