Class ReceivedPerspectiveCamera

Hierarchy (View Summary)

FrameCameraBase
- ReceivedPerspectiveCamera

Index

Constructors

constructor

new ReceivedPerspectiveCamera(
    position: Vector3.Vector3,
    lookAt: Vector3.Vector3,
    up: Vector3.Vector3,
    near: number,
    far: number,
    aspectRatio: number,
    fovY: number,
): ReceivedPerspectiveCamera
Parameters
- position: Vector3.Vector3
- lookAt: Vector3.Vector3
- up: Vector3.Vector3
- near: number
- far: number
- aspectRatio: number
- fovY: number
Returns ReceivedPerspectiveCamera
Overrides FrameCameraBase.constructor
- Defined in packages/viewer/src/lib/types/frame.ts:341

Properties

`Readonly`aspectRatio

aspectRatio: number

`Readonly`far

far: number

`Readonly`fovY

fovY: number

`Readonly`lookAt

lookAt: Vector3.Vector3

`Readonly`near

near: number

`Readonly`position

position: Vector3.Vector3

`Readonly`up

up: Vector3.Vector3

Accessors

direction

get direction(): Vector3.Vector3
Returns Vector3.Vector3
Inherited from FrameCameraBase.direction
- Defined in packages/viewer/src/lib/types/frame.ts:186

frustumProjectionViewMatrix

get frustumProjectionViewMatrix(): Matrix4.Matrix4
Returns Matrix4.Matrix4
Inherited from FrameCameraBase.frustumProjectionViewMatrix
- Defined in packages/viewer/src/lib/types/frame.ts:214

projectionMatrix

get projectionMatrix(): Matrix4.Matrix4
Returns Matrix4.Matrix4
Inherited from FrameCameraBase.projectionMatrix
- Defined in packages/viewer/src/lib/types/frame.ts:202

projectionMatrixInverse

get projectionMatrixInverse(): Matrix4.Matrix4
Returns Matrix4.Matrix4
Inherited from FrameCameraBase.projectionMatrixInverse
- Defined in packages/viewer/src/lib/types/frame.ts:206

projectionViewMatrix

get projectionViewMatrix(): Matrix4.Matrix4
Returns Matrix4.Matrix4
Inherited from FrameCameraBase.projectionViewMatrix
- Defined in packages/viewer/src/lib/types/frame.ts:210

viewMatrix

get viewMatrix(): Matrix4.Matrix4
Returns Matrix4.Matrix4
Inherited from FrameCameraBase.viewMatrix
- Defined in packages/viewer/src/lib/types/frame.ts:198

viewVector

get viewVector(): Vector3.Vector3
Returns Vector3.Vector3
Inherited from FrameCameraBase.viewVector
- Defined in packages/viewer/src/lib/types/frame.ts:190

worldMatrix

get worldMatrix(): Matrix4.Matrix4
Returns Matrix4.Matrix4
Inherited from FrameCameraBase.worldMatrix
- Defined in packages/viewer/src/lib/types/frame.ts:194

Methods

intersectLineWithNear

intersectLineWithNear(line: Line3): Vector3.Vector3 | undefined
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 Vector3.Vector3 | undefined
A point in world space, or undefined if the line does not intersect with the near plane.
Inherited from FrameCameraBase.intersectLineWithNear
- Defined in packages/viewer/src/lib/types/frame.ts:295

isOrthographic

isOrthographic(): this is ReceivedOrthographicCamera
Returns whether this FrameCameraBase is an orthographic camera.

Returns this is ReceivedOrthographicCamera
Inherited from FrameCameraBase.isOrthographic
- Defined in packages/viewer/src/lib/types/frame.ts:263

isPerspective

isPerspective(): this is ReceivedPerspectiveCamera
Returns whether this FrameCameraBase is a perspective camera.

Returns this is ReceivedPerspectiveCamera
Overrides FrameCameraBase.isPerspective
- Defined in packages/viewer/src/lib/types/frame.ts:367

isPointBehindNear

isPointBehindNear(world: Vector3.Vector3): boolean
Checks if the given point, in world space, is behind the near plane of the camera.
Parameters
- world: Vector3.Vector3
  A point in world space.
Returns boolean
true if the point is behind the camera.
Inherited from FrameCameraBase.isPointBehindNear
- Defined in packages/viewer/src/lib/types/frame.ts:281

toOrthographic

toOrthographic(boundingBox: BoundingBox): FrameCameraBase
Converts this FramePerspectiveCamera to a FrameOrthographicCamera using the provided boundingBox to compute the viewing frustum.
Parameters
- boundingBox: BoundingBox
  The visible bounding box.
Returns FrameCameraBase
- Defined in packages/viewer/src/lib/types/frame.ts:359

`Static`fromBoundingBox

fromBoundingBox(
    camera: FrameCamera,
    boundingBox: BoundingBox,
    aspectRatio: number,
): FrameCameraBase
Parameters
- camera: FrameCamera
- boundingBox: BoundingBox
- aspectRatio: number
Returns FrameCameraBase
Inherited from FrameCameraBase.fromBoundingBox
- Defined in packages/viewer/src/lib/types/frame.ts:218

Class ReceivedPerspectiveCamera

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ReceivedPerspectiveCamera

Properties

ReadonlyaspectRatio

Readonlyfar

ReadonlyfovY

ReadonlylookAt

Readonlynear

Readonlyposition

Readonlyup

Accessors

direction

Returns Vector3.Vector3

frustumProjectionViewMatrix

Returns Matrix4.Matrix4

projectionMatrix

Returns Matrix4.Matrix4

projectionMatrixInverse

Returns Matrix4.Matrix4

projectionViewMatrix

Returns Matrix4.Matrix4

viewMatrix

Returns Matrix4.Matrix4

viewVector

Returns Vector3.Vector3

worldMatrix

Returns Matrix4.Matrix4

Methods

intersectLineWithNear

Parameters

Returns Vector3.Vector3 | undefined

isOrthographic

Returns this is ReceivedOrthographicCamera

isPerspective

Returns this is ReceivedPerspectiveCamera

isPointBehindNear

Parameters

Returns boolean

toOrthographic

Parameters

Returns FrameCameraBase

StaticfromBoundingBox

Parameters

Returns FrameCameraBase

Settings

On This Page

`Readonly`aspectRatio

`Readonly`far

`Readonly`fovY

`Readonly`lookAt

`Readonly`near

`Readonly`position

`Readonly`up

`Static`fromBoundingBox