Interface CameraParams

Parameters for a Camera.

interface CameraParams {
    constrainPitch?: boolean;
    customProjection?: CustomProjectionParams;
    deviceMatrix?: FloatArrayParam;
    eye?: FloatArrayParam;
    frustumProjection?: FrustumProjectionParams;
    gimbalLock?: boolean;
    look?: FloatArrayParam;
    orthoProjection?: OrthoProjectionParams;
    perspectiveProjection?: PerspectiveProjectionParams;
    projectionType?: number;
    up?: FloatArrayParam;
    worldAxis?: FloatArrayParam;
}

Properties

constrainPitch? customProjection? deviceMatrix? eye? frustumProjection? gimbalLock? look? orthoProjection? perspectiveProjection? projectionType? up? worldAxis?

Properties

OptionalconstrainPitch

constrainPitch?: boolean

Whether to prevent the Camera from being pitched upside down.

The Camera is upside down when the angle between Camera.up and Camera.worldUp is less than one degree.

Default value is false.

OptionalcustomProjection

customProjection?: CustomProjectionParams

Parameters for the CustomProjection at Camera.customProjection.

Optional InternaldeviceMatrix

deviceMatrix?: FloatArrayParam

Optionaleye

eye?: FloatArrayParam

The 3D position of the Camera's viewpoint.

Default value is [0, 0, -10].

OptionalfrustumProjection

frustumProjection?: FrustumProjectionParams

Parameters for the FrustumProjection at Camera.frutsumProjection.

OptionalgimbalLock

gimbalLock?: boolean

Whether to lock the Camera's yaw rotation to pivot about the World-space "up" axis.

Default value is true.

Optionallook

look?: FloatArrayParam

The 3D point that the Camera is looking at.

Default value is [0, 0, 0].

OptionalorthoProjection

orthoProjection?: OrthoProjectionParams

Parameters for the OrthoProjection at Camera.orthoProjection.

OptionalperspectiveProjection

perspectiveProjection?: PerspectiveProjectionParams

Parameters for the PerspectiveProjection at Camera.perspectiveProjection.

OptionalprojectionType

projectionType?: number

The Camera's active projection type.

Possible values are PerspectiveProjectionType, OrthoProjectionType, FrustumProjectionType and CustomProjectionType.

Default value is PerspectiveProjectionType.

Returns

Identifies the active projection type.

Optionalup

up?: FloatArrayParam

3D vector indicating the Camera's upwards direction.

Default value is [0, 1, 0].

OptionalworldAxis

worldAxis?: FloatArrayParam

The up, right and forward axis of the Camera's World coordinate system.

Has format: [rightX, rightY, rightZ, upX, upY, upZ, forwardX, forwardY, forwardZ].

Default value is [1, 0, 0, 0, 1, 0, 0, 0, 1].

Settings

Member Visibility

On This Page

Properties