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 36

Fires:

event:viewchange
event:moveend
event:flystart
event:flyend
event:flystop

Extends

Camera

Members

depthZeroToOne

Returns active depth range mode.

Overrides: Camera#depthZeroToOne
Source: camera/Camera.ts, line 361

focusDistance

Returns focus distance used for orthographic projection size.

Overrides: Camera#focusDistance
Source: camera/Camera.ts, line 394

frustum

Returns current active frustum.

Overrides: Camera#frustum
Source: camera/Camera.ts, line 1289

height

Returns viewport height.

Overrides: Camera#height
Source: camera/Camera.ts, line 720

horizontalViewAngle

Returns camera horizontal view angle in degrees.

Overrides: Camera#horizontalViewAngle
Source: camera/Camera.ts, line 882

id

Returns camera identifier.

Overrides: Camera#id
Source: camera/Camera.ts, line 417

isOrthographic

Returns current projection mode.

Overrides: Camera#isOrthographic
Source: camera/Camera.ts, line 334

reverseDepth

Returns reverse depth flag.

Overrides: Camera#reverseDepth
Source: camera/Camera.ts, line 343

reverseDepthActive

Returns active reverse depth state.

Overrides: Camera#reverseDepthActive
Source: camera/Camera.ts, line 352

verticalViewAngle

Returns camera vertical view angle in degrees.

Overrides: Camera#verticalViewAngle
Source: camera/Camera.ts, line 873

viewAngle

Returns camera vertical view angle in degrees.

Overrides: Camera#viewAngle
Source: camera/Camera.ts, line 873

width

Returns viewport width.

Overrides: Camera#width
Source: camera/Camera.ts, line 711

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 582

_setProj(viewAngle, aspect)

Sets camera projection.

Parameters:

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

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

bindFrustumsPickingColors(renderer)

Binds picking colors for all frustums.

Parameters:

Name	Type	Description
`renderer`	Renderer	Renderer instance.

Overrides: Camera#bindFrustumsPickingColors
Source: camera/Camera.ts, line 570

checkFly()

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

Overrides: Camera#checkFly
Source: camera/Camera.ts, line 504

checkMoveEnd()

Checks whether the camera stopped moving and dispatches moveend.

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

checkTerrainCollision() → {Vec3|undefined}

Updates terrain altitude and keeps camera above minimum altitude.

Source: camera/PlanetCamera.ts, line 654

Returns:

Terrain point under camera when available.

Type:: Vec3 | undefined

containsSphere(sphere) → {boolean}

Checks whether sphere intersects any camera frustum.

Parameters:

Name	Type	Description
`sphere`	Sphere	Bounding sphere.

Overrides: Camera#containsSphere
Source: camera/Camera.ts, line 1274

Returns:

true when visible in at least one frustum.

Type:: boolean

copy(cam)

Copies camera pose and projection settings from another camera.

Parameters:

Name	Type	Description
`cam`	Camera	Source camera.

Overrides: Camera#copy
Source: camera/Camera.ts, line 1355

flyCartesian(cartesianopt, paramsopt)

Flies to the cartesian coordinates.

Parameters:

Name	Type	Attributes	Description
`cartesian`	Vec3	<optional>	Finish cartesian coordinates.
`params`	IFlyCartesianParams	<optional>	Flight parameters

Overrides: Camera#flyCartesian
Source: camera/Camera.ts, line 426

flyDistance(cartesian, distanceopt, paramsopt)

Flies camera to a position at a fixed distance from the target point.

Parameters:

Name	Type	Attributes	Default	Description
`cartesian`	Vec3			Target cartesian point.
`distance`	number	<optional>	10000.0	Distance from the target.
`params`	IPlanetFlyCartesianParams	<optional>		Flight parameters.

Source: camera/PlanetCamera.ts, line 400

flyExtent(extent, heightopt, paramsopt)

Flies to the current extent.

Parameters:

Name	Type	Attributes	Description
`extent`	Extent		Current extent.
`height`	number	<optional>	Destination height.
`params`	IPlanetFlyCartesianParams	<optional>	Flight parameters

Source: camera/PlanetCamera.ts, line 357

flyLonLat(lonlat, paramsopt)

Flies to the geo coordinates.

Parameters:

Name	Type	Attributes	Description
`lonlat`	LonLat		Finish coordinates.
`params`	IPlanetFlyCartesianParams	<optional>	Flight parameters

Source: camera/PlanetCamera.ts, line 389

getAbsolutePitch() → {number}

Returns absolute pitch angle.

Overrides: Camera#getAbsolutePitch
Source: camera/Camera.ts, line 1023

Returns:

Absolute pitch angle in radians.

Type:: number

getAbsoluteRoll() → {number}

Returns absolute roll angle.

Overrides: Camera#getAbsoluteRoll
Source: camera/Camera.ts, line 1041

Returns:

Absolute roll angle in radians.

Type:: number

getAbsoluteYaw() → {number}

Returns absolute yaw angle.

Overrides: Camera#getAbsoluteYaw
Source: camera/Camera.ts, line 1032

Returns:

Absolute yaw angle in radians.

Type:: number

getAltitude()

Gets altitude over the terrain.

Overrides: Camera#getAltitude
Source: camera/PlanetCamera.ts, line 230

getAspectRatio() → {number}

Returns aspect ratio.

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

Returns:

Aspect ratio.

Type:: number

getBackward() → {Vec3}

Returns backward direction vector.

Overrides: Camera#getBackward
Source: camera/Camera.ts, line 648

Returns:

Backward direction.

Type:: Vec3

getCurrentFrustum() → {number}

Returns current active frustum index.

Overrides: Camera#getCurrentFrustum
Source: camera/Camera.ts, line 1265

Returns:

Current frustum index.

Type:: number

getDown() → {Vec3}

Returns down direction vector.

Overrides: Camera#getDown
Source: camera/Camera.ts, line 612

Returns:

Down direction.

Type:: Vec3

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 273

Returns:

Type:: Vec3

getForward() → {Vec3}

Returns forward direction vector.

Overrides: Camera#getForward
Source: camera/Camera.ts, line 639

Returns:

Forward direction.

Type:: Vec3

getHeading() → {number}

Returns heading angle in degrees. Should match getYaw() in most cases.

Source: camera/PlanetCamera.ts, line 685

Returns:

Heading in [0, 360) degrees.

Type:: number

getHeight() → {number}

Returns camera height.

Source: camera/PlanetCamera.ts, line 264

Returns:

Type:: number

getInverseProjectionMatrix() → {NumberArray16}

Returns inverse projection matrix.

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

Returns:

Inverse projection matrix.

Type:: NumberArray16

getInverseProjectionViewMatrix() → {NumberArray16}

Returns inverse projection-view matrix.

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

Returns:

Inverse projection-view matrix.

Type:: NumberArray16

getLeft() → {Vec3}

Returns left direction vector.

Overrides: Camera#getLeft
Source: camera/Camera.ts, line 630

Returns:

Left direction.

Type:: Vec3

getLonLat() → {LonLat}

Returns camera geographical position.

Source: camera/PlanetCamera.ts, line 255

Returns:

Type:: LonLat

getNormalMatrix() → {NumberArray9}

Returns normal matrix.

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

Returns:

Normal matrix.

Type:: NumberArray9

getPitch() → {number}

Returns pitch angle in local planet frame.

Overrides: Camera#getPitch
Source: camera/PlanetCamera.ts, line 713

Returns:

Pitch angle in radians.

Type:: number

getProjectionMatrix() → {NumberArray16}

Returns projection matrix.

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

Returns:

Projection matrix.

Type:: NumberArray16

getProjectionViewMatrix() → {NumberArray16}

Returns projection-view matrix.

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

Returns:

Projection-view matrix.

Type:: NumberArray16

getProjectionViewRTEMatrix() → {NumberArray16}

Returns projection-view RTE matrix.

Overrides: Camera#getProjectionViewRTEMatrix
Source: camera/Camera.ts, line 1316

Returns:

Projection-view RTE matrix.

Type:: NumberArray16

getRight() → {Vec3}

Returns right direction vector.

Overrides: Camera#getRight
Source: camera/Camera.ts, line 621

Returns:

Right direction.

Type:: Vec3

getRoll() → {number}

Returns roll angle in local planet frame.

Overrides: Camera#getRoll
Source: camera/PlanetCamera.ts, line 734

Returns:

Roll angle in radians.

Type:: number

getRotation() → {Quat}

Returns camera rotation quaternion.

Overrides: Camera#getRotation
Source: camera/Camera.ts, line 1050

Returns:

Camera rotation quaternion.

Type:: Quat

getSurfaceVisibleDistance(d) → {number}

Returns visible surface arc distance from current altitude.

Parameters:

Name	Type	Description
`d`	number	Additional height offset.

Source: camera/PlanetCamera.ts, line 674

Returns:

Visible surface distance.

Type:: number

getUp() → {Vec3}

Returns up direction vector.

Overrides: Camera#getUp
Source: camera/Camera.ts, line 603

Returns:

Up direction.

Type:: Vec3

getViewAngle() → {number}

Returns camera vertical view angle in degrees.

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

Returns:

View angle in degrees.

Type:: number

getViewMatrix() → {NumberArray16}

Returns model matrix.

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

Returns:

View matrix.

Type:: NumberArray16

getYaw() → {number}

Returns yaw angle in local planet frame. Should match getHeading() in most cases.

Overrides: Camera#getYaw
Source: camera/PlanetCamera.ts, line 723

Returns:

Yaw angle in radians.

Type:: number

isFlying() → {boolean}

Returns camera is flying.

Overrides: Camera#isFlying
Source: camera/Camera.ts, line 536

Returns:

Type:: boolean

isVisible(poi) → {boolean}

Checks whether a cartesian point is visible above the horizon.

Parameters:

Name	Type	Description
`poi`	Vec3	Point in cartesian coordinates.

Source: camera/PlanetCamera.ts, line 702

Returns:

true when the point is visible.

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 916

project(x, y, z) → {Vec2}

Gets projected 3d point to the 2d screen coordinates

Parameters:

Name	Type	Description
`x`	number	X coordinate
`y`	number	Y coordinate
`z`	number	Z coordinate

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

Returns:

Screen point coordinates

Type:: Vec2

project3v(v) → {Vec2}

Gets projected 3d point to the 2d screen coordinates

Parameters:

Name	Type	Description
`v`	Vec3	Cartesian 3d coordinates

Overrides: Camera#project3v
Source: camera/Camera.ts, line 1152

Returns:

Screen point coordinates

Type:: Vec2

projectedSize(p, r) → {number}

Gets 3d size factor. Uses in LOD distance calculation. It is very important function used in Node.ts

Parameters:

Name	Type	Description
`p`	Vec3	Point in 3d.
`r`	Vec3	size.

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

Returns:

Size factor.

Type:: number

refresh()

Refresh camera matrices

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

rotate(rot)

Rotates current camera basis by quaternion.

Parameters:

Name	Type	Description
`rot`	Quat	Rotation quaternion.

Overrides: Camera#rotate
Source: camera/Camera.ts, line 1074

rotateAround(angle, isArcopt, centeropt, upopt)

Rotates camera around center point

Parameters:

Name	Type	Attributes	Default	Description
`angle`	number			Rotation angle in radians
`isArc`	boolean	<optional>	false	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 1175

rotateDown(angle)

Rotates around planet to the South Pole.

Parameters:

Name	Type	Description
`angle`	number	Rotation angle.

Source: camera/PlanetCamera.ts, line 603

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 1195

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 571

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 582

rotateUp(angle)

Rotates around planet to the North Pole.

Parameters:

Name	Type	Description
`angle`	number	Rotation angle.

Source: camera/PlanetCamera.ts, line 593

rotateVertical(angle, center, minSlopeopt)

Rotates camera vertically around the given center.

Parameters:

Name	Type	Attributes	Default	Description
`angle`	number			Rotation angle in radians.
`center`	Vec3			Rotation center.
`minSlope`	number	<optional>	0	Minimum allowed slope limit.

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

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 891

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 214

setCurrentFrustum(k)

Sets current active frustum index.

Parameters:

Name	Type	Description
`k`	number	Frustum index.

Overrides: Camera#setCurrentFrustum
Source: camera/Camera.ts, line 1254

setDepthZeroToOne(enabled)

Enables or disables ZERO_TO_ONE depth range mode.

Parameters:

Name	Type	Description
`enabled`	boolean	Depth range mode flag.

Overrides: Camera#setDepthZeroToOne
Source: camera/Camera.ts, line 370

setFrustums(frustums)

Replaces camera frustum ranges.

Parameters:

Name	Type	Description
`frustums`	Array.<NumberArray2>	Array of `[near, far]` ranges.

Overrides: Camera#setFrustums
Source: camera/Camera.ts, line 786

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 238

setNearFar(near, faropt, frustumIndexopt)

Updates near/far planes for one frustum.

Parameters:

Name	Type	Attributes	Default	Description
`near`	number			Near clipping plane distance.
`far`	number	<optional>		Far clipping plane distance.
`frustumIndex`	number	<optional>	0	Frustum index.

Overrides: Camera#setNearFar
Source: camera/Camera.ts, line 775

setPitch(a)

Sets pitch angle in local planet frame.

Parameters:

Name	Type	Description
`a`	number	Pitch angle in radians.

Overrides: Camera#setPitch
Source: camera/PlanetCamera.ts, line 744

setPitchYawRoll(pitch, yaw, roll)

Sets orientation from pitch, yaw and roll in local planet frame.

Parameters:

Name	Type	Description
`pitch`	number	Pitch angle in radians.
`yaw`	number	Yaw angle in radians.
`roll`	number	Roll angle in radians.

Overrides: Camera#setPitchYawRoll
Source: camera/PlanetCamera.ts, line 780

setRoll(a)

Sets roll angle in local planet frame.

Parameters:

Name	Type	Description
`a`	number	Roll angle in radians.

Overrides: Camera#setRoll
Source: camera/PlanetCamera.ts, line 768

setRotation(rot, upopt, rightopt, backopt)

Sets camera orientation from a quaternion.

Parameters:

Name	Type	Attributes	Description
`rot`	Quat		Rotation quaternion.
`up`	Vec3	<optional>	Base up vector.
`right`	Vec3	<optional>	Base right vector.
`back`	Vec3	<optional>	Base backward vector.

Overrides: Camera#setRotation
Source: camera/Camera.ts, line 1059

setTerrainCollisionActivity(isActive)

Enables or disables terrain collision checks.

Parameters:

Name	Type	Description
`isActive`	boolean	Terrain collision flag.

Source: camera/PlanetCamera.ts, line 170

setViewAngle(angle)

Sets camera view angle in degrees

Parameters:

Name	Type	Description
`angle`	number	View angle

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

setViewportSize(width, height)

Sets viewport size and updates projection.

Parameters:

Name	Type	Description
`width`	number	Viewport width in pixels.
`height`	number	Viewport height in pixels.

Overrides: Camera#setViewportSize
Source: camera/Camera.ts, line 729

setYaw(a)

Sets yaw angle in local planet frame.

Parameters:

Name	Type	Description
`a`	number	Yaw angle in radians.

Overrides: Camera#setYaw
Source: camera/PlanetCamera.ts, line 756

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 931

stopFlying()

Breaks the flight.

Overrides: Camera#stopFlying
Source: camera/Camera.ts, line 490

unproject(x, y, distopt, outPosopt) → {Vec3}

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

Parameters:

Name	Type	Attributes	Description
`x`	number		Screen X coordinate in pixels.
`y`	number		Screen Y coordinate in pixels.
`dist`	number	<optional>	Optional projection distance for orthographic mode.
`outPos`	Vec3	<optional>	Optional output world position for orthographic mode.

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

Returns:

Direction vector.

Type:: Vec3

unproject2v(pos, distopt, outPosopt) → {Vec3}

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

Parameters:

Name	Type	Attributes	Description
`pos`	Vec2		Screen coordinates in pixels.
`dist`	number	<optional>	Optional projection distance for orthographic mode.
`outPos`	Vec3	<optional>	Optional output world position for orthographic mode.