Class FrameCameraBase

Hierarchy

FrameCameraBase
- ReceivedOrthographicCamera
- ReceivedPerspectiveCamera

Index

Constructors

constructor

new FrameCameraBase(position: Vector3, lookAt: Vector3, up: Vector3, near: number, far: number, aspectRatio: number): FrameCameraBase

- Defined in packages/viewer/src/lib/types/frame.ts:177
Parameters
- position: Vector3
- lookAt: Vector3
- up: Vector3
- near: number
- far: number
- aspectRatio: number
Returns FrameCameraBase

Properties

Readonly aspectRatio

aspectRatio: number

Readonly far

far: number

Readonly lookAt

lookAt: Vector3

Readonly near

near: number

Readonly position

position: Vector3

Readonly up

up: Vector3

Accessors

direction

get direction(): Vector3

- Defined in packages/viewer/src/lib/types/frame.ts:186
Returns Vector3

frustumProjectionViewMatrix

get frustumProjectionViewMatrix(): Matrix4

- Defined in packages/viewer/src/lib/types/frame.ts:214
Returns Matrix4

projectionMatrix

get projectionMatrix(): Matrix4

- Defined in packages/viewer/src/lib/types/frame.ts:202
Returns Matrix4

projectionMatrixInverse

get projectionMatrixInverse(): Matrix4

- Defined in packages/viewer/src/lib/types/frame.ts:206
Returns Matrix4

projectionViewMatrix

get projectionViewMatrix(): Matrix4

- Defined in packages/viewer/src/lib/types/frame.ts:210
Returns Matrix4

viewMatrix

get viewMatrix(): Matrix4

- Defined in packages/viewer/src/lib/types/frame.ts:198
Returns Matrix4

viewVector

get viewVector(): Vector3

- Defined in packages/viewer/src/lib/types/frame.ts:190
Returns Vector3

worldMatrix

get worldMatrix(): Matrix4

- Defined in packages/viewer/src/lib/types/frame.ts:194
Returns Matrix4

Methods

intersectLineWithNear

intersectLineWithNear(line: Line3): undefined | Vector3

- Defined in packages/viewer/src/lib/types/frame.ts:295
Returns a point on the near plane that intersects with line. If line does not intersect, then undefined is returned.

Parameters
- line: Line3
  
  The line to intersect.
Returns undefined | Vector3
A point in world space, or undefined if the line does not intersect with the near plane.

isOrthographic

isOrthographic(): this is ReceivedOrthographicCamera

- Defined in packages/viewer/src/lib/types/frame.ts:263
Returns whether this FrameCameraBase is an orthographic camera.

Returns this is ReceivedOrthographicCamera

isPerspective

isPerspective(): this is ReceivedPerspectiveCamera

- Defined in packages/viewer/src/lib/types/frame.ts:270
Returns whether this FrameCameraBase is a perspective camera.

Returns this is ReceivedPerspectiveCamera

isPointBehindNear

isPointBehindNear(world: Vector3): boolean

- Defined in packages/viewer/src/lib/types/frame.ts:281
Checks if the given point, in world space, is behind the near plane of the camera.

Parameters
- world: Vector3
  
  A point in world space.
Returns boolean
true if the point is behind the camera.

Static fromBoundingBox

fromBoundingBox(camera: FrameCamera, boundingBox: BoundingBox, aspectRatio: number): FrameCameraBase

- Defined in packages/viewer/src/lib/types/frame.ts:218
Parameters
- camera: FrameCamera
- boundingBox: BoundingBox
- aspectRatio: number
Returns FrameCameraBase