Skip to main content

Camera

Since version 4.0.0

source

Camera for View360

class Camera extends Component<CameraEvents>

Extends

Properties

animation

Active camera animation, null if there isn't.

fov

Camera's horizontal FOV(Field of View) value

initialPitch

Initial pitch (x-axis rotation) value for camera. (in degrees, °)
As View360 uses right-handed coordinate system internally, positive value will make camera to look upside, while negative value will look down.

initialYaw

Initial yaw (y-axis rotation) value for camera. (in degrees, °)
As View360 uses right-handed coordinate system internally, camera will rotate counter-clockwise by this value.

initialZoom

Initial pitch (x-axis rotation) value for camera. (in degrees, °)
As View360 uses right-handed coordinate system internally, positive value will make camera to look upside, while negative value will look down.

pitch

Current pitch(x-axis rotation) value

position

Current camera position

projectionMatrix

Camera's projection matrix

quaternion

Current camera quaternion

viewMatrix

Camera's view matrix

yaw

Current yaw(y-axis rotation) value

zoom

Current zoom value

aspect

Camera's width / height ratio

changed

Whether the camera's rotation changed from the last frame.

pitchRange

Restrict pitch(x-axis rotation) range. (in degrees, °)

yawRange

Restrict yaw(y-axis rotation) range. (in degrees, °)

zoomRange

Restrict camera zoom range.
If null, a default zoom range from 0.6 to 10 will be used.

Methods

animateTo

Change camera's rotation to given euler values by the given duration.

destroy

Destroy instance and detach all event listeners

fovToZoom

Calculate zoom value for the given fov.

getHorizontalFov

Return horizontal fov value when the given zoom is applied. (in degrees, °)

getPitchRange

Get actual pitch range by the given zoom value.

getVerticalFov

Return vertical fov value when the given zoom is applied. (in degrees, °)

getYawRange

Get actual yaw range by the given zoom value.

getZoomRange

Get actual zoom range in fov degrees.

hasOn
lookAt

Change camera's rotation with euler values.

off
on
once
resize

Refresh internal size value.

rotate

Change camera's rotation with quaternion.

trigger
updateMatrix

Update inner matrixes.

Events

animationEnd

An event that fires when camera's animation stops

Constructor​

Create new instance of Camera
new Camera(options: CameraOptions): Camera

Parameters

options

CameraOptions

Camera options

Properties​

animation​

>=4.0.0
animation

null | CameraAnimation

Active camera animation, null if there isn't.

source

fov​

>=4.0.0
fov

number

Camera's horizontal FOV(Field of View) value

source

initialPitch​

>=4.0.0
initialPitch

number

0

Initial pitch (x-axis rotation) value for camera. (in degrees, °)
As View360 uses right-handed coordinate system internally, positive value will make camera to look upside, while negative value will look down.

Example
const viewer = new View360("#el_id", {
  initialPitch: 60
});

viewer.on("ready", () => {
  console.log(viewer.camera.pitch); // 60
});

source

initialYaw​

>=4.0.0
initialYaw

number

0

Initial yaw (y-axis rotation) value for camera. (in degrees, °)
As View360 uses right-handed coordinate system internally, camera will rotate counter-clockwise by this value.

Example
const viewer = new View360("#el_id", {
  initialYaw: 30
});

viewer.on("ready", () => {
  console.log(viewer.camera.yaw); // 30
});

source

initialZoom​

>=4.0.0
initialZoom

number

0

Initial pitch (x-axis rotation) value for camera. (in degrees, °)
As View360 uses right-handed coordinate system internally, positive value will make camera to look upside, while negative value will look down.

Example
const viewer = new View360("#el_id", {
  initialPitch: 60
});

viewer.on("ready", () => {
  console.log(viewer.camera.pitch); // 60
});

source

pitch​

>=4.0.0
pitch

number

Current pitch(x-axis rotation) value

source

position​

>=4.0.0
position

vec3

Current camera position

source

projectionMatrix​

>=4.0.0
projectionMatrix

mat4

Camera's projection matrix

source

quaternion​

>=4.0.0
quaternion

quat

Current camera quaternion

source

viewMatrix​

>=4.0.0
viewMatrix

mat4

Camera's view matrix

source

yaw​

>=4.0.0
yaw

number

Current yaw(y-axis rotation) value

source

zoom​

>=4.0.0
zoom

number

Current zoom value

source

aspect​

readonly
aspect

number

Camera's width / height ratio

source

changed​

readonly
changed

boolean

Whether the camera's rotation changed from the last frame.

source

pitchRange​

pitchRange

null | Range

Restrict pitch(x-axis rotation) range. (in degrees, °)

source

yawRange​

yawRange

null | Range

Restrict yaw(y-axis rotation) range. (in degrees, °)

source

zoomRange​

zoomRange

null | Range

Restrict camera zoom range.
If null, a default zoom range from 0.6 to 10 will be used.

source

Methods​

animateTo​

animateTo

Promise<void>

animateTo(options: Partial<{ duration: number; easing: ((x: number) => number); pitch: number; yaw: number; zoom: number }>): Promise<void>

Change camera's rotation to given euler values by the given duration.

Parameters

options

Partial<{ duration: number; easing: ((x: number) => number); pitch: number; yaw: number; zoom: number }>

{}

Animation parameters

source

destroy​

>=4.0.0
destroy

void

destroy(): void

Destroy instance and detach all event listeners

source

fovToZoom​

>=4.0.0
fovToZoom

number

fovToZoom(fov: number): number

Calculate zoom value for the given fov.

Parameters

fov

number

horizontal fov (in degrees, °)

source

getHorizontalFov​

>=4.0.0
getHorizontalFov

number

getHorizontalFov(zoom: number): number

Return horizontal fov value when the given zoom is applied. (in degrees, °)

Parameters

zoom

number

...

Returns

Zoomed horizontal FOV

source

getPitchRange​

>=4.0.0
getPitchRange

Readonly<Range>

getPitchRange(zoom: number): Readonly<Range>

Get actual pitch range by the given zoom value.

Parameters

zoom

number

source

getVerticalFov​

>=4.0.0
getVerticalFov

number

getVerticalFov(zoom: number): number

Return vertical fov value when the given zoom is applied. (in degrees, °)

Parameters

zoom

number

...

Returns

Zoomed vertical FOV

source

getYawRange​

>=4.0.0
getYawRange

Readonly<Range>

getYawRange(zoom: number): Readonly<Range>

Get actual yaw range by the given zoom value.

Parameters

zoom

number

source

getZoomRange​

>=4.0.0
getZoomRange

{ current: number;   max: number;   min: number }

getZoomRange(): { current: number; max: number; min: number }

Get actual zoom range in fov degrees.

source

hasOn​

inherited
hasOn

boolean

hasOn<K>(eventName: K): boolean

Parameters

eventName

K

lookAt​

>=4.0.0
lookAt

void

lookAt(rotation: Partial<{ pitch: number; yaw: number; zoom: number }>): void

Change camera's rotation with euler values.

Parameters

rotation

Partial<{ pitch: number; yaw: number; zoom: number }>

Rotation values

source

off​

inherited
off

Camera

off<K>(eventName: K, handlerToDetach: EventCallback<CameraEvents, K, Camera>): Camera

Parameters

eventName

K

handlerToDetach

EventCallback<CameraEvents, K, Camera>

on​

inherited
on

Camera

on(eventHash: Partial<{ animationEnd: ((event: { animation: CameraAnimation }) => any) }>): Camera

Parameters

eventHash

Partial<{ animationEnd: ((event: { animation: CameraAnimation }) => any) }>

once​

inherited
once

Camera

once(eventHash: Partial<{ animationEnd: ((event: { animation: CameraAnimation }) => any) }>): Camera

Parameters

eventHash

Partial<{ animationEnd: ((event: { animation: CameraAnimation }) => any) }>

resize​

>=4.0.0
resize

void

resize(width: number, height: number): void

Refresh internal size value.

Parameters

width

number

New width

height

number

New height

source

rotate​

>=4.0.0
rotate

void

rotate(rotation: quat, zoom: number): void

Change camera's rotation with quaternion.

Parameters

rotation

quat

Quaternion to apply

zoom

number

...

zoom value to apply

source

trigger​

inherited
trigger

Camera

trigger<K>(event: K, ...params: EventTriggerParams<CameraEvents, K>): Camera

Parameters

event

K

params

EventTriggerParams<CameraEvents, K>

updateMatrix​

>=4.0.0
updateMatrix

void

updateMatrix(): void

Update inner matrixes.

source

Events​

animationEnd​

>=4.0.0
animationEnd

{ animation: CameraAnimation }

An event that fires when camera's animation stops

source