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 45

Fires:

EventsHandler#event:viewchange
EventsHandler#event:moveend

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 319

_setProj(angle, aspect)

Sets up camera projection

Parameters:

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

Source: camera/Camera.ts, line 445

getAspectRatio() → {number}

Returns aspect ratio

Source: camera/Camera.ts, line 436

Returns:

Aspect ratio

Type:: number

getInverseProjectionMatrix() → {Mat4}

Returns inverse projection matrix.

Source: camera/Camera.ts, line 846

Returns:

Inverse projection-view matrix.

Type:: Mat4

getInverseProjectionViewMatrix() → {Mat4}

Returns inverse projection and model matrix product.

Source: camera/Camera.ts, line 837

Returns:

Inverse projection-view matrix.

Type:: Mat4

getNormalMatrix() → {NumberArray9}

Returns normal matrix.

Source: camera/Camera.ts, line 778

Returns:

Normal matrix.

Type:: NumberArray9

getProjectionMatrix() → {Mat4}

Returns projection matrix.

Source: camera/Camera.ts, line 810

Returns:

Projection matrix.

Type:: Mat4

getProjectionViewMatrix() → {Mat4}

Returns projection and model matrix product.

Source: camera/Camera.ts, line 819

Returns:

Projection-view matrix.

Type:: Mat4

getProjectionViewRTEMatrix() → {Mat4}

Returns projection and model RTE matrix product.

Source: camera/Camera.ts, line 828

Returns:

Projection-view matrix.

Type:: Mat4

getRotation()

Returns camera quaternion

Source: camera/Camera.ts, line 638

getViewAngle() → {number}

Gets camera view angle in degrees

Source: camera/Camera.ts, line 483

Returns:

angle -

Type:: number

getViewMatrix() → {NumberArray16}

Returns model matrix.

Source: camera/Camera.ts, line 769

Returns:

View matrix.

Type:: NumberArray16

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 529

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 703

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 693

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.

Source: camera/Camera.ts, line 758

Returns:

Size factor.

Type:: number

refresh()

Refresh camera matrices

Source: camera/Camera.ts, line 403

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 716

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 736

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 749

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 504

Returns:

This camera

Type:: Camera

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 578

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 557

setViewAngle(angle)

Sets camera view angle in degrees

Parameters:

Name	Type	Description
`angle`	number	View angle

Source: camera/Camera.ts, line 473

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 599

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 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

Source: camera/Camera.ts, line 669

Returns:

Direction vector

Type:: Vec3

unproject2v(pos) → {Vec3}

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

Parameters:

Name	Type	Description
`pos`	Vec2	Screen X coordinate

Source: camera/Camera.ts, line 659

Returns:

Direction vector

Type:: Vec3

(abstract) update()

Updates camera view space

Source: camera/Camera.ts, line 365