Skip to main content

Interface: CameraSettings

Properties​

alpha​

alpha: number

Defines the rotation angle of the camera along the longitudinal axis.

beta​

beta: number

Defines the rotation angle of the camera along the latitudinal axis.

collision?​

optional collision: boolean

Defines whether the camera should check collision with the objects oh the scene.

collisionRadius?​

optional collisionRadius: number[]

Defines the collision radius of the camera. This simulates a sphere around the camera.

disableCameraControls?​

optional disableCameraControls: boolean

If true, it will remove all controls over camera. It would be possible to change camera position only programmatically

fov​

fov: number

Camera field of view. Set in radians

fovMode​

fovMode: FovMode

Sets the camera frustum bounds to the viewport bounds.

framingTime?​

optional framingTime: string | number

The transition time when framing the mesh, in milliseconds

id?​

optional id: string

Unique camera ID

idleRotationSpeed?​

optional idleRotationSpeed: string | number

Default speed at which the camera rotates around the model.

idleRotationSpinupTime?​

optional idleRotationSpinupTime: string | number

The time (milliseconds) to take to spin up to the full idle rotation speed.

idleRotationWaitTime?​

optional idleRotationWaitTime: string | number

The time (in milliseconds) to wait after user interaction before the camera starts rotating.

inertia?​

optional inertia: number

Define the default inertia of the camera. This helps giving a smooth feeling to the camera movement.

isEnabled?​

optional isEnabled: boolean

If true, camera is enabled

isLocked?​

optional isLocked: boolean

If true, camera position will be locked at current state

isOrtho?​

optional isOrtho: boolean

Define the mode of the camera (Camera.PERSPECTIVE_CAMERA or Camera.ORTHOGRAPHIC_CAMERA)

limitTarget?​

optional limitTarget: number[]

Limit target

lowerAlphaLimit​

lowerAlphaLimit: number

Minimum allowed angle on the longitudinal axis. This can help limiting how the Camera is able to move in the scene.

lowerBetaLimit?​

optional lowerBetaLimit: number

Minimum allowed angle on the latitudinal axis. This can help limiting how the Camera is able to move in the scene.

lowerRadiusLimit?​

optional lowerRadiusLimit: number

Minimum allowed distance of the camera to the target (The camera can not get closer). This can help limiting how the Camera is able to move in the scene.

maxZ?​

optional maxZ: number

Define the maximum distance the camera can see to. This is important to note that the depth buffer are not infinite and the further it end the more your scene might encounter depth fighting issue.

minZ?​

optional minZ: number

Define the minimum distance the camera can see from. This is important to note that the depth buffer are not infinite and the closer it starts the more your scene might encounter depth fighting issue.

name​

name: string

Camera name

orthoBottom?​

optional orthoBottom: string | number

Define the current limit on the bottom side for an orthographic camera In scene unit

orthoLeft?​

optional orthoLeft: string | number

Define the current limit on the left side for an orthographic camera In scene unit

orthoRight?​

optional orthoRight: string | number

Define the current limit on the right side for an orthographic camera In scene unit

orthoTop?​

optional orthoTop: string | number

Define the current limit on the top side for an orthographic camera In scene unit

position​

position: number[]

Define the current local position of the camera in the scene

preventScroll?​

optional preventScroll: boolean

If true it will prevent scroll on canvas

radius​

radius: string | number

Defines the radius of the camera from it s target point.

radiusScale?​

optional radiusScale: string | number

The scale applied to the radius (1 by default)

speed?​

optional speed: number

Define the current speed of the camera

target​

target: number[]

Defines the target point of the camera. The camera looks towards it from the radius distance.

type?​

optional type: "MAIN" | "GHOST"

Camera type

upperAlphaLimit​

upperAlphaLimit: number

Maximum allowed angle on the longitudinal axis. This can help limiting how the Camera is able to move in the scene.

upperBetaLimit?​

optional upperBetaLimit: number

Maximum allowed angle on the latitudinal axis. This can help limiting how the Camera is able to move in the scene.

upperRadiusLimit?​

optional upperRadiusLimit: number

Maximum allowed distance of the camera to the target (The camera can not get further). This can help limiting how the Camera is able to move in the scene.

useAlphaLimit?​

optional useAlphaLimit: boolean

If true, it will apply alpha limit

useAutoRotationBehavior?​

optional useAutoRotationBehavior: boolean

If true auto rotation will be enabled

useBetaLimit?​

optional useBetaLimit: boolean

If true, it will apply beta limit

useBouncingBehavior?​

optional useBouncingBehavior: boolean

Enable Bouncing Behavior

useFramingBehavior?​

optional useFramingBehavior: boolean

Enalbe Framing Behavior

useNaturalPinchZoom?​

optional useNaturalPinchZoom: boolean

the pointer use natural pinch zoom to override the pinch precision and pinch delta percentage. When useNaturalPinchZoom is true, multi touch zoom will zoom in such that any object in the plane at the camera's target point will scale perfectly with finger motion.

zoomStopsAnimation?​

optional zoomStopsAnimation: boolean

If true, user zooming should stop animation.