Class: PlanetCamera

Constructor#

new PlanetCamera(planet, optionsopt)#

Parameters:

Name Type Attributes Description

planet

Planet

Planet render node.

options

IPlanetCameraParams

Planet camera options:

Properties

Name	Type	Attributes	Description
`name`	string	<optional>	Camera name.
`viewAngle`	number	<optional>	Camera angle of view.
`near`	number	<optional>	Camera near plane distance. Default is 1.0
`far`	number	<optional>	Camera far plane distance. Default is og.math.MAX
`minAltitude`	number	<optional>	Minimal altitude for the camera. Default is 5
`maxAltitude`	number	<optional>	Maximal altitude for the camera. Default is 20000000
`eye`	Vec3	<optional>	Camera eye position. Default (0,0,0)
`look`	Vec3	<optional>	Camera look position. Default (0,0,0)
`up`	Vec3	<optional>	Camera eye position. Default (0,1,0)

Source: camera/PlanetCamera.ts, line 26

Extends#

Camera

Methods#

_init(optionsopt)#

Camera initialization.

Parameters:

Name Type Attributes Description

options

Object

Camera options:

Properties

Name	Type	Attributes	Description
`viewAngle`	number	<optional>	Camera angle of view.
`near`	number	<optional>	Camera near plane distance. Default is 1.0
`far`	number	<optional>	Camera far plane distance. Default is math.MAX
`eye`	Vec3	<optional>	Camera eye position. Default (0,0,0)
`look`	Vec3	<optional>	Camera look position. Default (0,0,0)
`up`	Vec3	<optional>	Camera eye position. Default (0,1,0)

Overrides: Camera#_init
Source: camera/Camera.ts, line 280

_setProj(angle, aspect)#

Sets up camera projection

Parameters:

Name	Type	Description
`angle`	number	Camera view angle
`aspect`	number	Screen aspect ratio

Overrides: Camera#_setProj
Source: camera/Camera.ts, line 384

checkFly()#

Prepare camera to the frame. Used in render node frame function.

Source: camera/PlanetCamera.ts, line 648

flyCartesian(cartesian, lookopt, upopt, amplopt, completeCallbackopt, startCallbackopt, frameCallbackopt)#

Flies to the cartesian coordinates.

Parameters:

Name	Type	Attributes	Default	Description
`cartesian`	Vec3			Finish cartesian coordinates.
`look`	Vec3	<optional>		Camera LOOK in the end of flying. Default - (0,0,0)
`up`	Vec3	<optional>		Camera UP vector in the end of flying. Default - (0,1,0)
`ampl`	Number	<optional>	1.0	Altitude amplitude factor.
`completeCallback`	function	<optional>		Callback that calls after flying when flying is finished.
`startCallback`	function	<optional>		Callback that calls before the flying begins.
`frameCallback`	function	<optional>		Each frame callback

Source: camera/PlanetCamera.ts, line 404

flyExtent(extent, heightopt, upopt, amplopt, completeCallbackopt, startCallbackopt, frameCallbackopt)#

Flies to the current extent.

Parameters:

Name	Type	Attributes	Description
`extent`	Extent		Current extent.
`height`	number	<optional>	Destination height.
`up`	Vec3	<optional>	Camera UP in the end of flying. Default - (0,1,0)
`ampl`	Number	<optional>	Altitude amplitude factor.
`completeCallback`	function	<optional>	Callback that calls after flying when flying is finished.
`startCallback`	function	<optional>	Callback that calls before the flying begins.
`frameCallback`	function	<optional>	Each frame callback

Source: camera/PlanetCamera.ts, line 332

flyLonLat(lonlat, lookopt, upopt, amplopt, completeCallbackopt, startCallbackopt, frameCallbackopt)#

Flies to the geo coordinates.

Parameters:

Name	Type	Attributes	Description
`lonlat`	LonLat		Finish coordinates.
`look`	Vec3 \| LonLat	<optional>	Camera LOOK in the end of flying. Default - (0,0,0)
`up`	Vec3	<optional>	Camera UP vector in the end of flying. Default - (0,1,0)
`ampl`	number	<optional>	Altitude amplitude factor.
`completeCallback`	function	<optional>	Callback that calls after flying when flying is finished.
`startCallback`	function	<optional>	Callback that calls befor the flying begins.
`frameCallback`	function	<optional>	each frame callback

Source: camera/PlanetCamera.ts, line 512

getAltitude()#

Gets altitude over the terrain.

Source: camera/PlanetCamera.ts, line 204

getAspectRatio() → {number}#

Returns aspect ratio

Overrides: Camera#getAspectRatio
Source: camera/Camera.ts, line 375

Returns:

Aspect ratio

Type:: number

getExtentPosition(extent, height) → {Vec3}#

Gets position by viewable extent.

Parameters:

Name	Type	Description
`extent`	Extent	Viewable extent.
`height`	Number	Camera height

Source: camera/PlanetCamera.ts, line 247

Returns:

Type:: Vec3

getHeight() → {number}#

Returns camera height.

Source: camera/PlanetCamera.ts, line 238

Returns:

Type:: number

getInverseProjectionMatrix() → {Mat4}#

Returns inverse projection matrix.

Overrides: Camera#getInverseProjectionMatrix
Source: camera/Camera.ts, line 702

Returns:

Inverse projection-view matrix.

Type:: Mat4

getInverseProjectionViewMatrix() → {Mat4}#

Returns inverse projection and model matrix product.

Overrides: Camera#getInverseProjectionViewMatrix
Source: camera/Camera.ts, line 693

Returns:

Inverse projection-view matrix.

Type:: Mat4

getLonLat() → {LonLat}#

Returns camera geographical position.

Source: camera/PlanetCamera.ts, line 229

Returns:

Type:: LonLat

getNormalMatrix() → {NumberArray9}#

Returns normal matrix.

Overrides: Camera#getNormalMatrix
Source: camera/Camera.ts, line 644

Returns:

Normal matrix.

Type:: NumberArray9

getProjectionMatrix() → {Mat4}#

Returns projection matrix.

Overrides: Camera#getProjectionMatrix
Source: camera/Camera.ts, line 675

Returns:

Projection matrix.

Type:: Mat4

getProjectionViewMatrix() → {Mat4}#

Returns projection and model matrix product.

Overrides: Camera#getProjectionViewMatrix
Source: camera/Camera.ts, line 684

Returns:

Projection-view matrix.

Type:: Mat4

getViewAngle() → {number}#

Gets camera view angle in degrees

Overrides: Camera#getViewAngle
Source: camera/Camera.ts, line 418

Returns:

angle -

Type:: number

getViewMatrix() → {NumberArray16}#

Returns model matrix.

Overrides: Camera#getViewMatrix
Source: camera/Camera.ts, line 635

Returns:

View matrix.

Type:: NumberArray16

isFlying() → {boolean}#

Returns camera is flying.

Source: camera/PlanetCamera.ts, line 560

Returns:

Type:: boolean

look(look, upopt)#

Sets camera look point

Parameters:

Name	Type	Attributes	Description
`look`	Vec3		Look point
`up`	Vec3	<optional>	Camera up vector otherwise camera current up vector(this._u)

Overrides: Camera#look
Source: camera/Camera.ts, line 455

pitch(angle)#

Pitch the camera to the angle in degrees

Parameters:

Name	Type	Description
`angle`	number	Delta pitch angle in degrees

Overrides: Camera#pitch
Source: camera/Camera.ts, line 503

project(v) → {Vec2}#

Gets projected 3d point to the 2d screen coordinates

Parameters:

Name	Type	Description
`v`	Vec3	Cartesian 3d coordinates

Overrides: Camera#project
Source: camera/Camera.ts, line 566

Returns:

Screen point coordinates

Type:: Vec2

projectedSize(p, r) → {number}#

Gets 3d size factor. Uses in LOD distance calculation.

Parameters:

Name	Type	Description
`p`	Vec3	Far point.
`r`	Vec3	Far point.

Overrides: Camera#projectedSize
Source: camera/Camera.ts, line 624

Returns:

Size factor.

Type:: number

refresh()#

Refresh camera matrices

Overrides: Camera#refresh
Source: camera/Camera.ts, line 356

roll(angle)#

Roll the camera to the angle in degrees

Parameters:

Name	Type	Description
`angle`	number	Delta roll angle in degrees

Overrides: Camera#roll
Source: camera/Camera.ts, line 482

rotateAround(angle, isArcopt, centeropt, upopt)#

Rotates camera around center point

Parameters:

Name	Type	Attributes	Description
`angle`	number		Rotation angle in radians
`isArc`	boolean	<optional>	If true camera up vector gets from current up vector every frame, otherwise up is always input parameter.
`center`	Vec3	<optional>	Point that the camera rotates around
`up`	Vec3	<optional>	Camera up vector

Overrides: Camera#rotateAround
Source: camera/Camera.ts, line 578

rotateDown(angle)#

Rotates around planet to the South Pole.

Parameters:

Name	Type	Description
`angle`	number	Rotation angle.

Source: camera/PlanetCamera.ts, line 601

rotateHorizontal(angle, isArcopt, centeropt, upopt)#

Rotates camera around center point by horizontal.

Parameters:

Name	Type	Attributes	Description
`angle`	number		Rotation angle in radians.
`isArc`	boolean	<optional>	If true camera up vector gets from current up vector every frame, otherwise up is always input parameter.
`center`	Vec3	<optional>	Point that the camera rotates around.
`up`	Vec3	<optional>	Camera up vector.

Overrides: Camera#rotateHorizontal
Source: camera/Camera.ts, line 602

rotateLeft(angle, spinopt)#

Rotates around planet to the left.

Parameters:

Name	Type	Attributes	Description
`angle`	number		Rotation angle.
`spin`	boolean	<optional>	If its true rotates around globe spin.

Source: camera/PlanetCamera.ts, line 569

rotateRight(angle, spinopt)#

Rotates around planet to the right.

Parameters:

Name	Type	Attributes	Description
`angle`	number		Rotation angle.
`spin`	boolean	<optional>	If its true rotates around globe spin.

Source: camera/PlanetCamera.ts, line 580

rotateUp(angle)#

Rotates around planet to the North Pole.

Parameters:

Name	Type	Description
`angle`	number	Rotation angle.

Source: camera/PlanetCamera.ts, line 591

rotateVertical(angle, centeropt)#

Rotates camera around center point by vertical.

Parameters:

Name	Type	Attributes	Description
`angle`	number		Rotation angle in radians.
`center`	Vec3	<optional>	Point that the camera rotates around.

Overrides: Camera#rotateVertical
Source: camera/Camera.ts, line 615

set(eye, look, up) → {Camera}#

Sets camera to eye position

Parameters:

Name	Type	Description
`eye`	Vec3	Camera position
`look`	Vec3	Look point
`up`	Vec3	Camera up vector

Overrides: Camera#set
Source: camera/Camera.ts, line 431

Returns:

This camera

Type:: Camera

setAltitude(alt)#

Sets altitude over the terrain.

Parameters:

Name	Type	Description
`alt`	number	Altitude over the terrain.

Source: camera/PlanetCamera.ts, line 187

setAspectRatio(aspect)#

Sets aspect ratio

Parameters:

Name	Type	Description
`aspect`	Number	Camera aspect ratio

Overrides: Camera#setAspectRatio
Source: camera/Camera.ts, line 365

setLonLat(lonlat, lookLonLatopt, upopt)#

Places camera to view to the geographical point.

Parameters:

Name	Type	Attributes	Description
`lonlat`	LonLat		New camera and camera view position.
`lookLonLat`	LonLat	<optional>	Look up coordinates.
`up`	Vec3	<optional>	Camera UP vector. Default (0,1,0)

Source: camera/PlanetCamera.ts, line 212

setViewAngle(angle)#

Sets camera view angle in degrees

Parameters:

Name	Type	Description
`angle`	number	View angle

Overrides: Camera#setViewAngle
Source: camera/Camera.ts, line 408

slide(du, dv, dn)#

Slides camera to vector d - (du, dv, dn)

Parameters:

Name	Type	Description
`du`	number	delta X
`dv`	number	delta Y
`dn`	number	delta Z

Overrides: Camera#slide
Source: camera/Camera.ts, line 469

stopFlying()#

Breaks the flight.

Source: camera/PlanetCamera.ts, line 544

unproject(x, y) → {Vec3}#

Returns normal vector direction to the unprojected screen point from camera eye

Parameters:

Name	Type	Description
`x`	number	Screen X coordinate
`y`	number	Screen Y coordinate

Overrides: Camera#unproject
Source: camera/Camera.ts, line 545

Returns:

Direction vector

Type:: Vec3

(abstract) update()#

Updates camera view space.

Overrides: Camera#update
Source: camera/PlanetCamera.ts, line 156

viewExtent(extent, heightopt)#

View current extent.

Parameters:

Name	Type	Attributes	Description
`extent`	Extent		Current extent.
`height`	number	<optional>

Source: camera/PlanetCamera.ts, line 320

yaw(angle)#

Yaw the camera to the angle in degrees

Parameters:

Name	Type	Description
`angle`	number	Delta yaw angle in degrees

Overrides: Camera#yaw
Source: camera/Camera.ts, line 524