Class: Camera

Constructor

new Camera(optionsopt)

Parameters:

Name Type Attributes Description

options

Object

Camera options:

Properties

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

Source: camera/Camera.ts, line 104

Fires:

event:viewchange
event:moveend

Members

depthZeroToOne

Returns active depth range mode.

Source: camera/Camera.ts, line 362

focusDistance

Returns focus distance used for orthographic projection size.

Source: camera/Camera.ts, line 395

focusDistance

Sets focus distance used for orthographic projection size.

Source: camera/Camera.ts, line 404

frustum

Returns current active frustum.

Source: camera/Camera.ts, line 1324

height

Returns viewport height.

Source: camera/Camera.ts, line 720

horizontalViewAngle

Returns camera horizontal view angle in degrees.

Source: camera/Camera.ts, line 882

id

Returns camera identifier.

Source: camera/Camera.ts, line 418

isOrthographic

Returns current projection mode.

Source: camera/Camera.ts, line 335

isOrthographic

Enables or disables orthographic projection mode.

Source: camera/Camera.ts, line 383

reverseDepth

Returns reverse depth flag.

Source: camera/Camera.ts, line 344

reverseDepthActive

Returns active reverse depth state.

Source: camera/Camera.ts, line 353

verticalViewAngle

Returns camera vertical view angle in degrees.

Source: camera/Camera.ts, line 873

viewAngle

Returns camera vertical view angle in degrees.

Source: camera/Camera.ts, line 873

width

Returns viewport 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)

Source: camera/Camera.ts, line 583

_setProj(viewAngle, aspect)

Sets camera projection.

Parameters:

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

Source: camera/Camera.ts, line 750

bindFrustumsPickingColors(renderer)

Binds picking colors for all frustums.

Parameters:

Name	Type	Description
`renderer`	Renderer	Renderer instance.

Source: camera/Camera.ts, line 571

checkFly()

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

Source: camera/Camera.ts, line 505

checkMoveEnd()

Checks whether the camera stopped moving and dispatches moveend.

Source: camera/Camera.ts, line 546

containsSphere(sphere) → {boolean}

Checks whether sphere intersects any camera frustum.

Parameters:

Name	Type	Description
`sphere`	Sphere	Bounding sphere.

Source: camera/Camera.ts, line 1309

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.

Source: camera/Camera.ts, line 1390

flyCartesian(cartesianopt, paramsopt)

Flies to the cartesian coordinates.

Parameters:

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

Source: camera/Camera.ts, line 427

getAbsolutePitch() → {number}

Returns absolute pitch angle.

Source: camera/Camera.ts, line 1023

Returns:

Absolute pitch angle in radians.

Type:: number

getAbsoluteRoll() → {number}

Returns absolute roll angle.

Source: camera/Camera.ts, line 1041

Returns:

Absolute roll angle in radians.

Type:: number

getAbsoluteYaw() → {number}

Returns absolute yaw angle.

Source: camera/Camera.ts, line 1032

Returns:

Absolute yaw angle in radians.

Type:: number

getAltitude() → {number}

Returns camera altitude value for base camera.

Source: camera/Camera.ts, line 1407

Returns:

Camera y coordinate.

Type:: number

getAspectRatio() → {number}

Returns aspect ratio.

Source: camera/Camera.ts, line 741

Returns:

Aspect ratio.

Type:: number

getBackward() → {Vec3}

Returns backward direction vector.

Source: camera/Camera.ts, line 649

Returns:

Backward direction.

Type:: Vec3

getCurrentFrustum() → {number}

Returns current active frustum index.

Source: camera/Camera.ts, line 1300

Returns:

Current frustum index.

Type:: number

getDown() → {Vec3}

Returns down direction vector.

Source: camera/Camera.ts, line 613

Returns:

Down direction.

Type:: Vec3

getForward() → {Vec3}

Returns forward direction vector.

Source: camera/Camera.ts, line 640

Returns:

Forward direction.

Type:: Vec3

getInverseProjectionMatrix() → {NumberArray16}

Returns inverse projection matrix.

Source: camera/Camera.ts, line 1369

Returns:

Inverse projection matrix.

Type:: NumberArray16

getInverseProjectionViewMatrix() → {NumberArray16}

Returns inverse projection-view matrix.

Source: camera/Camera.ts, line 1360

Returns:

Inverse projection-view matrix.

Type:: NumberArray16

getLeft() → {Vec3}

Returns left direction vector.

Source: camera/Camera.ts, line 631

Returns:

Left direction.

Type:: Vec3

getNormalMatrix() → {NumberArray9}

Returns camera normal matrix.

Source: camera/Camera.ts, line 1280

Returns:

Type:: NumberArray9

getPitch() → {number}

Returns pitch angle.

Source: camera/Camera.ts, line 996

Returns:

Pitch angle in radians.

Type:: number

getProjectionMatrix() → {NumberArray16}

Returns projection matrix.

Source: camera/Camera.ts, line 1333

Returns:

Projection matrix.

Type:: NumberArray16

getProjectionViewMatrix() → {NumberArray16}

Returns projection-view matrix.

Source: camera/Camera.ts, line 1342

Returns:

Projection-view matrix.

Type:: NumberArray16

getProjectionViewRTEMatrix() → {NumberArray16}

Returns projection-view RTE matrix.

Source: camera/Camera.ts, line 1351

Returns:

Projection-view RTE matrix.

Type:: NumberArray16

getRay(x, y) → {Ray}

Returns a world-space ray corresponding to the given screen point. For perspective camera the ray shares camera eye as origin. For orthographic camera the origin is offset across the view plane, and the direction equals the camera forward vector.

Parameters:

Name	Type	Description
`x`	number	Screen X coordinate in pixels.
`y`	number	Screen Y coordinate in pixels.

Source: camera/Camera.ts, line 1152

Returns:

Type:: Ray

getRay2v(pos) → {Ray}

Returns a world-space ray corresponding to the given screen point.

Parameters:

Name	Type	Description
`pos`	Vec2	Screen coordinates in pixels.

Source: camera/Camera.ts, line 1177

Returns:

Type:: Ray

getRight() → {Vec3}

Returns right direction vector.

Source: camera/Camera.ts, line 622

Returns:

Right direction.

Type:: Vec3

getRoll() → {number}

Returns roll angle.

Source: camera/Camera.ts, line 1014

Returns:

Roll angle in radians.

Type:: number

getRotation() → {Quat}

Returns camera rotation quaternion.

Source: camera/Camera.ts, line 1050

Returns:

Camera rotation quaternion.

Type:: Quat

getUp() → {Vec3}

Returns up direction vector.

Source: camera/Camera.ts, line 604

Returns:

Up direction.

Type:: Vec3

getViewAngle() → {number}

Returns camera vertical view angle in degrees.

Source: camera/Camera.ts, line 855

Returns:

View angle in degrees.

Type:: number

getViewMatrix() → {NumberArray16}

Returns model matrix.

Source: camera/Camera.ts, line 1271

Returns:

View matrix.

Type:: NumberArray16

getYaw() → {number}

Returns yaw angle.

Source: camera/Camera.ts, line 1005

Returns:

Yaw angle in radians.

Type:: number

isFlying() → {boolean}

Returns camera is flying.

Source: camera/Camera.ts, line 537

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)

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

Source: camera/Camera.ts, line 1197

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

Source: camera/Camera.ts, line 1187

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.

Source: camera/Camera.ts, line 1252

Returns:

Size factor.

Type:: number

refresh()

Refresh camera matrices

Source: camera/Camera.ts, line 702

rotate(rot)

Rotates current camera basis by quaternion.

Parameters:

Name	Type	Description
`rot`	Quat	Rotation quaternion.

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

Source: camera/Camera.ts, line 1210

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.

Source: camera/Camera.ts, line 1230

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.

Source: camera/Camera.ts, line 1243

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

Source: camera/Camera.ts, line 891

Returns:

This camera

Type:: Camera

setCurrentFrustum(k)

Sets current active frustum index.

Parameters:

Name	Type	Description
`k`	number	Frustum index.

Source: camera/Camera.ts, line 1289

setDepthZeroToOne(enabled)

Enables or disables ZERO_TO_ONE depth range mode.

Parameters:

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

Source: camera/Camera.ts, line 371

setFrustums(frustums)

Replaces camera frustum ranges.

Parameters:

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

Source: camera/Camera.ts, line 786

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.

Source: camera/Camera.ts, line 775

setPitch(angle)

Pitch the camera to the angle in radians

Parameters:

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

Source: camera/Camera.ts, line 957

setPitchYawRoll(pitch, yaw, roll)

Sets camera orientation from Euler angles.

Parameters:

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

Source: camera/Camera.ts, line 983

setRoll(angle)

Roll the camera to the angle in radians

Parameters:

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

Source: camera/Camera.ts, line 944

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.

Source: camera/Camera.ts, line 1059

setViewAngle(angle)

Sets camera view angle in degrees

Parameters:

Name	Type	Description
`angle`	number	View angle

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.

Source: camera/Camera.ts, line 729

setYaw(angle)

Yaw the camera to the angle in radians

Parameters:

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

Source: camera/Camera.ts, line 970

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

Source: camera/Camera.ts, line 931

stopFlying()

Breaks the flight.

Source: camera/Camera.ts, line 491

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.

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.

Source: camera/Camera.ts, line 1086

Returns:

Direction vector.

Type:: Vec3

(abstract) update()

Updates camera view space

Source: camera/Camera.ts, line 658

viewDistance(cartesian, distanceopt)

Places camera at a fixed distance from a point and looks at it.

Parameters:

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

Source: camera/Camera.ts, line 1378