StereoscopicArcRotateCamera | Babylon.js API documentation

Class StereoscopicArcRotateCamera

Camera used to simulate stereoscopic rendering (based on ArcRotateCamera)

See

https://doc.babylonjs.com/features/featuresDeepDive/cameras

Hierarchy (View Summary)

ArcRotateCamera
- StereoscopicArcRotateCamera

Index

Constructors

constructor

new StereoscopicArcRotateCamera(
    name: string,
    alpha: number,
    beta: number,
    radius: number,
    target: Vector3,
    interaxialDistance: number,
    isStereoscopicSideBySide: boolean,
    scene?: Scene,
): StereoscopicArcRotateCamera
Creates a new StereoscopicArcRotateCamera
Parameters
- name: string
  defines camera name
- alpha: number
  defines alpha angle (in radians)
- beta: number
  defines beta angle (in radians)
- radius: number
  defines radius
- target: Vector3
  defines camera target
- interaxialDistance: number
  defines distance between each color axis
- isStereoscopicSideBySide: boolean
  defines is stereoscopic is done side by side or over under
- Optionalscene: Scene
  defines the hosting scene
Returns StereoscopicArcRotateCamera
Overrides ArcRotateCamera.constructor
- Defined in .temp/typedoc/docdirectory/doc.d.ts:129484

Properties

allowUpsideDown

allowUpsideDown: boolean

Allows the camera to be completely reversed. If false the camera can not arrive upside down.

alpha

alpha: number

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

animations

animations: Animation[]

Gets a list of Animations associated with the node

beta

beta: number

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

cameraDirection

cameraDirection: Vector3

Define the current direction the camera is moving to

cameraRigMode

cameraRigMode: number

Rig mode of the camera. This is useful to create the camera with two "eyes" instead of one to create VR or stereoscopic scenes. This is normally controlled byt the camera themselves as internal use.

cameraRotation

cameraRotation: Vector2

Define the current rotation the camera is rotating to

checkCollisions

checkCollisions: boolean

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

See

https://doc.babylonjs.com/features/featuresDeepDive/cameras/camera_collisions#how-can-i-do-this-

collisionRadius

collisionRadius: Vector3

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

See

https://doc.babylonjs.com/features/featuresDeepDive/cameras/camera_collisions#arcrotatecamera

customRenderTargets

customRenderTargets: RenderTargetTexture[]

Defines the list of custom render target which are rendered to and then used as the input to this camera's render. Eg. display another camera view on a TV in the main scene This is pretty helpful if you wish to make a camera render to a texture you could reuse somewhere else in the scene. (Eg. security camera)

To change the final output target of the camera, camera.outputRenderTarget should be used instead (eg. webXR renders to a render target corresponding to an HMD)

fov

fov: number

Field Of View is set in Radians. (default is 0.8)

fovMode

fovMode: number

fovMode sets the camera frustum bounds to the viewport bounds. (default is FOVMODE_VERTICAL_FIXED)

id

id: string

Gets or sets the id of the node

ignoreParentScaling

ignoreParentScaling: boolean

Gets or sets a boolean indicating that the scaling of the parent hierarchy will not be taken in account by the camera

inertia

inertia: number

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

inertialAlphaOffset

inertialAlphaOffset: number

Current inertia value on the longitudinal axis. The bigger this number the longer it will take for the camera to stop.

inertialBetaOffset

inertialBetaOffset: number

Current inertia value on the latitudinal axis. The bigger this number the longer it will take for the camera to stop.

inertialPanningX

inertialPanningX: number

Defines the current inertia value used during panning of the camera along the X axis.

inertialPanningY

inertialPanningY: number

Defines the current inertia value used during panning of the camera along the Y axis.

inertialRadiusOffset

inertialRadiusOffset: number

Current inertia value on the radius axis. The bigger this number the longer it will take for the camera to stop.

inputs

inputs: ArcRotateCameraInputsManager

Defines the input associated to the camera.

inspectableCustomProperties

inspectableCustomProperties: IInspectable[]

List of inspectable custom properties (used by the Inspector)

See

https://doc.babylonjs.com/toolsAndResources/inspector#extensibility

interaxialDistance

interaxialDistance: number

Defines the distance between both "eyes" in case of a RIG

inverseRotationSpeed

inverseRotationSpeed: number

Speed multiplier for inverse camera panning

invertRotation

invertRotation: boolean

Reverses mouselook direction to 'natural' panning as opposed to traditional direct panning

isIntermediate

isIntermediate: boolean

Define whether the camera is intermediate. This is useful to not present the output directly to the screen in case of rig without post process for instance

isRigCamera

isRigCamera: boolean

Is this camera a part of a rig system?

isStereoscopicSideBySide

isStereoscopicSideBySide: boolean

Defines if stereoscopic rendering is done side by side or over under.

layerMask

layerMask: number

Restricts the camera to viewing objects with the same layerMask. A camera with a layerMask of 1 will render mesh.layerMask & camera.layerMask!== 0

lockedTarget

lockedTarget: any

Define the current target of the camera as an object or a position. Please note that locking a target will disable panning.

lowerAlphaLimit

lowerAlphaLimit: Nullable<number>

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

lowerBetaLimit

lowerBetaLimit: Nullable<number>

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

lowerRadiusLimit

lowerRadiusLimit: Nullable<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.

lowerTargetYLimit

lowerTargetYLimit: number

Minimum allowed vertical target position of the camera. Use this setting in combination with upperRadiusLimit to set a global limit for the Cameras vertical position.

mapPanning

mapPanning: boolean

Defines if camera will eliminate transform on y axis.

maxZ

maxZ: number

Define the maximum distance the camera can see to. (default is 10000) 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.

metadata

metadata: any

Gets or sets an object used to store user defined information for the node

minZ

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

Gets or sets the name of the node

noRotationConstraint

noRotationConstraint: boolean

Add constraint to the camera to prevent it to move freely in all directions and around all axis.

oblique

oblique: Nullable<IObliqueParams>

Object containing oblique projection values (only used with ORTHOGRAPHIC_CAMERA)

onAccessibilityTagChangedObservable

onAccessibilityTagChangedObservable: Observable<Nullable<IAccessibilityTag>>

Observable fired when an accessibility tag is changed

onAfterCheckInputsObservable

onAfterCheckInputsObservable: Observable<Camera>

Observable triggered when the inputs have been processed.

onCollide

onCollide: (collidedMesh: AbstractMesh) => void

Event raised when the camera is colliding with a mesh.

onDisposeObservable

onDisposeObservable: Observable<Node>

An event triggered when the mesh is disposed

onMeshTargetChangedObservable

onMeshTargetChangedObservable: Observable<Nullable<TransformNode>>

Observable triggered when the transform node target has been changed on the camera.

onProjectionMatrixChangedObservable

onProjectionMatrixChangedObservable: Observable<Camera>

Observable triggered when the camera Projection matrix has changed.

onReady

onReady: Nullable<(node: Node) => void>

Callback raised when the node is ready to be used

onRestoreStateObservable

onRestoreStateObservable: Observable<Camera>

Observable triggered when reset has been called and applied to the camera.

onViewMatrixChangedObservable

onViewMatrixChangedObservable: Observable<Camera>

Observable triggered when the camera view matrix has changed. Beware of reentrance! Some methods like Camera.getViewMatrix and Camera.getWorldMatrix can trigger the onViewMatrixChangedObservable observable, so using them inside an observer will require additional logic to avoid a stack overflow error.

outputRenderTarget

outputRenderTarget: Nullable<RenderTargetTexture>

When set, the camera will render to this render target instead of the default canvas

If the desire is to use the output of a camera as a texture in the scene consider using camera.customRenderTargets instead

overrideCloneAlphaBetaRadius

overrideCloneAlphaBetaRadius: Nullable<boolean>

Defines an override value to use as the parameter to setTarget. This allows the parameter to be specified when animating the target (e.g. using FramingBehavior).

panningAxis

panningAxis: Vector3

Defines the allowed panning axis.

panningDistanceLimit

panningDistanceLimit: Nullable<number>

Defines the maximum distance the camera can pan. This could help keeping the camera always in your scene.

panningInertia

panningInertia: number

Defines the value of the inertia used during panning. 0 would mean stop inertia and one would mean no deceleration at all.

panningOriginTarget

panningOriginTarget: Vector3

Defines the target of the camera before panning.

pinchToPanMaxDistance

pinchToPanMaxDistance: number

Defines the distance used to consider the camera in pan mode vs pinch/zoom. Basically if your fingers moves away from more than this distance you will be considered in pinch mode.

projectionPlaneTilt

projectionPlaneTilt: number

Projection plane tilt around the X axis (horizontal), set in Radians. (default is 0) Can be used to make vertical lines in world space actually vertical on the screen. See https://forum.babylonjs.com/t/add-vertical-shift-to-3ds-max-exporter-babylon-cameras/17480

radius

radius: number

Defines the radius of the camera from its target point.

renderPassId

renderPassId: number

Render pass id used by the camera to render into the main framebuffer

reservedDataStore

reservedDataStore: any

For internal use only. Please do not use.

restoreStateInterpolationFactor

restoreStateInterpolationFactor: number

Factor for restoring information interpolation. default is 0 = off. Any value < 0 or > 1 will disable interpolation.

`Optional`rigParent

rigParent?: Camera

If isRigCamera set to true this will be set with the parent camera. The parent camera is not (!) necessarily the .parent of this camera (like in the case of XR)

rotation

rotation: Vector3

Define the current rotation of the camera

rotationQuaternion

rotationQuaternion: Quaternion

Define the current rotation of the camera as a quaternion to prevent Gimbal lock

speed

speed: number

Define the current speed of the camera

state

state: string

Gets or sets a string used to store user defined state for the node

targetScreenOffset

targetScreenOffset: Vector2

Defines a screen offset for the camera position.

uniqueId

uniqueId: number

Gets or sets the unique id of the node

updateUpVectorFromRotation

updateUpVectorFromRotation: boolean

When set, the up vector of the camera will be updated by the rotation of the camera

upperAlphaLimit

upperAlphaLimit: Nullable<number>

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

upperBetaLimit

upperBetaLimit: Nullable<number>

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

upperRadiusLimit

upperRadiusLimit: Nullable<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.

useInputToRestoreState

useInputToRestoreState: boolean

Define if double tap/click is used to restore the previously saved state of the camera.

viewport

viewport: Viewport

Define the viewport of the camera. This correspond to the portion of the screen the camera will render to in normalized 0 to 1 unit.

zoomOnFactor

zoomOnFactor: number

Defines how much the radius should be scaled while zooming on a particular mesh (through the zoomOn function)

`Static`ForceAttachControlToAlwaysPreventDefault

ForceAttachControlToAlwaysPreventDefault: boolean

Defines if by default attaching controls should prevent the default javascript event to continue.

`Static` `Readonly`FOVMODE_HORIZONTAL_FIXED

FOVMODE_HORIZONTAL_FIXED: 1

This setting aligns the left and right bounds of the viewport to the left and right bounds of the camera frustum.

`Static` `Readonly`FOVMODE_VERTICAL_FIXED

FOVMODE_VERTICAL_FIXED: 0

This is the default FOV mode for perspective cameras. This setting aligns the upper and lower bounds of the viewport to the upper and lower bounds of the camera frustum.

`Static` `Readonly`ORTHOGRAPHIC_CAMERA

ORTHOGRAPHIC_CAMERA: 1

This helps creating camera with an orthographic mode. Orthographic is commonly used in engineering as a means to produce object specifications that communicate dimensions unambiguously, each line of 1 unit length (cm, meter..whatever) will appear to have the same length everywhere on the drawing. This allows the drafter to dimension only a subset of lines and let the reader know that other lines of that length on the drawing are also that length in reality. Every parallel line in the drawing is also parallel in the object.

`Static` `Readonly`PERSPECTIVE_CAMERA

PERSPECTIVE_CAMERA: 0

This is the default projection mode used by the cameras. It helps recreating a feeling of perspective and better appreciate depth. This is the best way to simulate real life cameras.

`Static` `Readonly`RIG_MODE_CUSTOM

RIG_MODE_CUSTOM: 22

Custom rig mode allowing rig cameras to be populated manually with any number of cameras

`Static` `Readonly`RIG_MODE_NONE

RIG_MODE_NONE: 0

This specifies there is no need for a camera rig. Basically only one eye is rendered corresponding to the camera.

`Static` `Readonly`RIG_MODE_STEREOSCOPIC_ANAGLYPH

RIG_MODE_STEREOSCOPIC_ANAGLYPH: 10

Simulates a camera Rig with one blue eye and one red eye. This can be use with 3d blue and red glasses.

`Static` `Readonly`RIG_MODE_STEREOSCOPIC_INTERLACED

RIG_MODE_STEREOSCOPIC_INTERLACED: 14

Defines that both eyes of the camera will be rendered on successive lines interlaced for passive 3d monitors.

`Static` `Readonly`RIG_MODE_STEREOSCOPIC_OVERUNDER

RIG_MODE_STEREOSCOPIC_OVERUNDER: 13

Defines that both eyes of the camera will be rendered over under each other.

`Static` `Readonly`RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_CROSSEYED

RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_CROSSEYED: 12

Defines that both eyes of the camera will be rendered side by side with a none parallel target.

`Static` `Readonly`RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_PARALLEL

RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_PARALLEL: 11

Defines that both eyes of the camera will be rendered side by side with a parallel target.

`Static` `Readonly`RIG_MODE_VR

RIG_MODE_VR: 20

Defines that both eyes of the camera should be renderered in a VR mode (carbox).

Accessors

absoluteRotation

get absoluteRotation(): Quaternion
Returns the current camera absolute rotation

Returns Quaternion
Inherited from ArcRotateCamera.absoluteRotation
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128250

accessibilityTag

get accessibilityTag(): Nullable<IAccessibilityTag>
Returns Nullable<IAccessibilityTag>
Inherited from ArcRotateCamera.accessibilityTag
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4464
set accessibilityTag(value: Nullable<IAccessibilityTag>): void
Gets or sets the accessibility tag to describe the node for accessibility purpose.
Parameters
- value: Nullable<IAccessibilityTag>
Returns void
Inherited from ArcRotateCamera.accessibilityTag
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4463

angularSensibilityX

get angularSensibilityX(): number
Gets or Set the pointer angular sensibility along the X axis or how fast is the camera rotating.

Returns number
Inherited from ArcRotateCamera.angularSensibilityX
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128470
set angularSensibilityX(value: number): void
Parameters
- value: number
Returns void
Inherited from ArcRotateCamera.angularSensibilityX
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128471

angularSensibilityY

get angularSensibilityY(): number
Gets or Set the pointer angular sensibility along the Y axis or how fast is the camera rotating.

Returns number
Inherited from ArcRotateCamera.angularSensibilityY
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128475
set angularSensibilityY(value: number): void
Parameters
- value: number
Returns void
Inherited from ArcRotateCamera.angularSensibilityY
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128476

animationPropertiesOverride

get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>
Gets or sets the animation properties override

Returns Nullable<AnimationPropertiesOverride>
Inherited from ArcRotateCamera.animationPropertiesOverride
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4535
set animationPropertiesOverride(
value: Nullable<AnimationPropertiesOverride>,
): void
Parameters
- value: Nullable<AnimationPropertiesOverride>
Returns void
Inherited from ArcRotateCamera.animationPropertiesOverride
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4536

autoRotationBehavior

get autoRotationBehavior(): Nullable<AutoRotationBehavior>
Gets the auto rotation behavior of the camera if it has been enabled.

Returns Nullable<AutoRotationBehavior>
See
https://doc.babylonjs.com/features/featuresDeepDive/behaviors/cameraBehaviors#autorotation-behavior
Inherited from ArcRotateCamera.autoRotationBehavior
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128618

behaviors

get behaviors(): Behavior<Node>[]
Gets the list of attached behaviors

Returns Behavior<Node>[]
See
https://doc.babylonjs.com/features/featuresDeepDive/behaviors
Inherited from ArcRotateCamera.behaviors
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4598

bouncingBehavior

get bouncingBehavior(): Nullable<BouncingBehavior>
Gets the bouncing behavior of the camera if it has been enabled.

Returns Nullable<BouncingBehavior>
See
https://doc.babylonjs.com/features/featuresDeepDive/behaviors/cameraBehaviors#bouncing-behavior
Inherited from ArcRotateCamera.bouncingBehavior
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128594

doNotSerialize

get doNotSerialize(): boolean
Gets or sets a boolean used to define if the node must be serialized

Returns boolean
Inherited from ArcRotateCamera.doNotSerialize
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4473
set doNotSerialize(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from ArcRotateCamera.doNotSerialize
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4474

framingBehavior

get framingBehavior(): Nullable<FramingBehavior>
Gets the framing behavior of the camera if it has been enabled.

Returns Nullable<FramingBehavior>
See
https://doc.babylonjs.com/features/featuresDeepDive/behaviors/cameraBehaviors#framing-behavior
Inherited from ArcRotateCamera.framingBehavior
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128606

globalPosition

get globalPosition(): Vector3
Gets the current world space position of the camera.

Returns Vector3
Inherited from ArcRotateCamera.globalPosition
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128017

hasMoved

get hasMoved(): boolean
Gets a flag indicating that the camera has moved in some way since the last call to Camera.update()

Returns boolean
Inherited from ArcRotateCamera.hasMoved
- Defined in .temp/typedoc/docdirectory/doc.d.ts:127941

isInterpolating

get isInterpolating(): boolean
If true, indicates the camera is currently interpolating to a new pose.

Returns boolean
Inherited from ArcRotateCamera.isInterpolating
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128589

isLeftCamera

get isLeftCamera(): boolean
Gets the left camera of a rig setup in case of Rigged Camera

Returns boolean
Inherited from ArcRotateCamera.isLeftCamera
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128181

isRightCamera

get isRightCamera(): boolean
Gets the right camera of a rig setup in case of Rigged Camera

Returns boolean
Inherited from ArcRotateCamera.isRightCamera
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128187

keysDown

get keysDown(): number[]
Gets or Set the list of keyboard keys used to control beta angle in a negative direction.

Returns number[]
Inherited from ArcRotateCamera.keysDown
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128511
set keysDown(value: number[]): void
Parameters
- value: number[]
Returns void
Inherited from ArcRotateCamera.keysDown
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128512

keysLeft

get keysLeft(): number[]
Gets or Set the list of keyboard keys used to control alpha angle in a negative direction.

Returns number[]
Inherited from ArcRotateCamera.keysLeft
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128516
set keysLeft(value: number[]): void
Parameters
- value: number[]
Returns void
Inherited from ArcRotateCamera.keysLeft
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128517

keysRight

get keysRight(): number[]
Gets or Set the list of keyboard keys used to control alpha angle in a positive direction.

Returns number[]
Inherited from ArcRotateCamera.keysRight
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128521
set keysRight(value: number[]): void
Parameters
- value: number[]
Returns void
Inherited from ArcRotateCamera.keysRight
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128522

keysUp

get keysUp(): number[]
Gets or Set the list of keyboard keys used to control beta angle in a positive direction.

Returns number[]
Inherited from ArcRotateCamera.keysUp
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128506
set keysUp(value: number[]): void
Parameters
- value: number[]
Returns void
Inherited from ArcRotateCamera.keysUp
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128507

leftCamera

get leftCamera(): Nullable<FreeCamera>
Gets the left camera of a rig setup in case of Rigged Camera

Returns Nullable<FreeCamera>
Inherited from ArcRotateCamera.leftCamera
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128191

mode

get mode(): number
Returns number
Inherited from ArcRotateCamera.mode
- Defined in .temp/typedoc/docdirectory/doc.d.ts:127858
set mode(mode: number): void
Define the mode of the camera (Camera.PERSPECTIVE_CAMERA or Camera.ORTHOGRAPHIC_CAMERA)
Parameters
- mode: number
Returns void
Inherited from ArcRotateCamera.mode
- Defined in .temp/typedoc/docdirectory/doc.d.ts:127857

onClonedObservable

get onClonedObservable(): Observable<Node>
An event triggered when the node is cloned

Returns Observable<Node>
Inherited from ArcRotateCamera.onClonedObservable
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4560

onDispose

set onDispose(callback: () => void): void
Sets a callback that will be raised when the node will be disposed
Parameters
- callback: () => void
Returns void
Inherited from ArcRotateCamera.onDispose
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4552

onEnabledStateChangedObservable

get onEnabledStateChangedObservable(): Observable<boolean>
An event triggered when the enabled state of the node changes

Returns Observable<boolean>
Inherited from ArcRotateCamera.onEnabledStateChangedObservable
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4556

orthoBottom

get orthoBottom(): Nullable<number>
Returns Nullable<number>
Inherited from ArcRotateCamera.orthoBottom
- Defined in .temp/typedoc/docdirectory/doc.d.ts:127818
set orthoBottom(value: Nullable<number>): void
Define the current limit on the bottom side for an orthographic camera In scene unit
Parameters
- value: Nullable<number>
Returns void
Inherited from ArcRotateCamera.orthoBottom
- Defined in .temp/typedoc/docdirectory/doc.d.ts:127817

orthoLeft

get orthoLeft(): Nullable<number>
Returns Nullable<number>
Inherited from ArcRotateCamera.orthoLeft
- Defined in .temp/typedoc/docdirectory/doc.d.ts:127804
set orthoLeft(value: Nullable<number>): void
Define the current limit on the left side for an orthographic camera In scene unit
Parameters
- value: Nullable<number>
Returns void
Inherited from ArcRotateCamera.orthoLeft
- Defined in .temp/typedoc/docdirectory/doc.d.ts:127803

orthoRight

get orthoRight(): Nullable<number>
Returns Nullable<number>
Inherited from ArcRotateCamera.orthoRight
- Defined in .temp/typedoc/docdirectory/doc.d.ts:127811
set orthoRight(value: Nullable<number>): void
Define the current limit on the right side for an orthographic camera In scene unit
Parameters
- value: Nullable<number>
Returns void
Inherited from ArcRotateCamera.orthoRight
- Defined in .temp/typedoc/docdirectory/doc.d.ts:127810

orthoTop

get orthoTop(): Nullable<number>
Returns Nullable<number>
Inherited from ArcRotateCamera.orthoTop
- Defined in .temp/typedoc/docdirectory/doc.d.ts:127825
set orthoTop(value: Nullable<number>): void
Define the current limit on the top side for an orthographic camera In scene unit
Parameters
- value: Nullable<number>
Returns void
Inherited from ArcRotateCamera.orthoTop
- Defined in .temp/typedoc/docdirectory/doc.d.ts:127824

panningSensibility

get panningSensibility(): number
Gets or Set the pointer panning sensibility or how fast is the camera moving.

Returns number
Inherited from ArcRotateCamera.panningSensibility
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128501
set panningSensibility(value: number): void
Parameters
- value: number
Returns void
Inherited from ArcRotateCamera.panningSensibility
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128502

parent

get parent(): Nullable<Node>
Returns Nullable<Node>
Inherited from ArcRotateCamera.parent
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4522
set parent(parent: Nullable<Node>): void
Gets or sets the parent of the node (without keeping the current position in the scene)
Parameters
- parent: Nullable<Node>
Returns void
See
https://doc.babylonjs.com/features/featuresDeepDive/mesh/transforms/parent_pivot/parent
Inherited from ArcRotateCamera.parent
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4521

pinchDeltaPercentage

get pinchDeltaPercentage(): number
Gets or Set the pointer pinch delta percentage or how fast is the camera zooming. It will be used instead of pinchPrecision if different from 0. It defines the percentage of current camera.radius to use as delta when pinch zoom is used.

Returns number
Inherited from ArcRotateCamera.pinchDeltaPercentage
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128487
set pinchDeltaPercentage(value: number): void
Parameters
- value: number
Returns void
Inherited from ArcRotateCamera.pinchDeltaPercentage
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128488

pinchPrecision

get pinchPrecision(): number
Gets or Set the pointer pinch precision or how fast is the camera zooming.

Returns number
Inherited from ArcRotateCamera.pinchPrecision
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128480
set pinchPrecision(value: number): void
Parameters
- value: number
Returns void
Inherited from ArcRotateCamera.pinchPrecision
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128481

position

get position(): Vector3
Define the current local position of the camera in the scene

Returns Vector3
Inherited from ArcRotateCamera.position
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128374
set position(newPosition: Vector3): void
Define the current local position of the camera in the scene
Parameters
- newPosition: Vector3
Returns void
Inherited from ArcRotateCamera.position
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128375

rightCamera

get rightCamera(): Nullable<FreeCamera>
Gets the right camera of a rig setup in case of Rigged Camera

Returns Nullable<FreeCamera>
Inherited from ArcRotateCamera.rightCamera
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128195

rigPostProcess

get rigPostProcess(): Nullable<PostProcess>
Gets the post process used by the rig cameras

Returns Nullable<PostProcess>
Inherited from ArcRotateCamera.rigPostProcess
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128079

screenArea

get screenArea(): number
The screen area in scene units squared

Returns number
Inherited from ArcRotateCamera.screenArea
- Defined in .temp/typedoc/docdirectory/doc.d.ts:127797

target

get target(): Vector3
Defines the target point of the camera. The camera looks towards it from the radius distance.

Returns Vector3
Inherited from ArcRotateCamera.target
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128357
set target(value: Vector3): void
Defines the target point of the camera. The camera looks towards it form the radius distance.
Parameters
- value: Vector3
Returns void
Inherited from ArcRotateCamera.target
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128358

targetHost

get targetHost(): Nullable<TransformNode>
Defines the target transform node of the camera. The camera looks towards it from the radius distance. Please note that setting a target host will disable panning.

Returns Nullable<TransformNode>
Inherited from ArcRotateCamera.targetHost
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128364
set targetHost(value: Nullable<TransformNode>): void
Parameters
- value: Nullable<TransformNode>
Returns void
Inherited from ArcRotateCamera.targetHost
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128365

upVector

get upVector(): Vector3
The vector the camera should consider as up. (default is Vector3(0, 1, 0) aka Vector3.Up())

Returns Vector3
Inherited from ArcRotateCamera.upVector
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128384
set upVector(vec: Vector3): void
The vector the camera should consider as up. (default is Vector3(0, 1, 0) as returned by Vector3.Up()) Setting this will copy the given vector to the camera's upVector, and set rotation matrices to and from Y up. DO NOT set the up vector using copyFrom or copyFromFloats, as this bypasses setting the above matrices.
Parameters
- vec: Vector3
Returns void
Inherited from ArcRotateCamera.upVector
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128383

useAutoRotationBehavior

get useAutoRotationBehavior(): boolean
Defines if the auto rotation behavior of the camera is enabled on the camera.

Returns boolean
See
https://doc.babylonjs.com/features/featuresDeepDive/behaviors/cameraBehaviors#autorotation-behavior
Inherited from ArcRotateCamera.useAutoRotationBehavior
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128623
set useAutoRotationBehavior(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from ArcRotateCamera.useAutoRotationBehavior
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128624

useBouncingBehavior

get useBouncingBehavior(): boolean
Defines if the bouncing behavior of the camera is enabled on the camera.

Returns boolean
See
https://doc.babylonjs.com/features/featuresDeepDive/behaviors/cameraBehaviors#bouncing-behavior
Inherited from ArcRotateCamera.useBouncingBehavior
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128599
set useBouncingBehavior(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from ArcRotateCamera.useBouncingBehavior
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128600

useFramingBehavior

get useFramingBehavior(): boolean
Defines if the framing behavior of the camera is enabled on the camera.

Returns boolean
See
https://doc.babylonjs.com/features/featuresDeepDive/behaviors/cameraBehaviors#framing-behavior
Inherited from ArcRotateCamera.useFramingBehavior
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128611
set useFramingBehavior(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from ArcRotateCamera.useFramingBehavior
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128612

useNaturalPinchZoom

get useNaturalPinchZoom(): boolean
Gets or Set 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.

Returns boolean
Inherited from ArcRotateCamera.useNaturalPinchZoom
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128496
set useNaturalPinchZoom(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from ArcRotateCamera.useNaturalPinchZoom
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128497

wheelDeltaPercentage

get wheelDeltaPercentage(): number
Gets or Set the mouse wheel delta percentage or how fast is the camera zooming. It will be used instead of wheelPrecision if different from 0. It defines the percentage of current camera.radius to use as delta when wheel zoom is used.

Returns number
Inherited from ArcRotateCamera.wheelDeltaPercentage
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128539
set wheelDeltaPercentage(value: number): void
Parameters
- value: number
Returns void
Inherited from ArcRotateCamera.wheelDeltaPercentage
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128540

wheelPrecision

get wheelPrecision(): number
Gets or Set the mouse wheel precision or how fast is the camera zooming.

Returns number
Inherited from ArcRotateCamera.wheelPrecision
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128526
set wheelPrecision(value: number): void
Parameters
- value: number
Returns void
Inherited from ArcRotateCamera.wheelPrecision
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128527

worldMatrixFromCache

get worldMatrixFromCache(): Matrix
Returns directly the latest state of the mesh World matrix. A Matrix is returned.

Returns Matrix
Inherited from ArcRotateCamera.worldMatrixFromCache
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4617

zoomToMouseLocation

get zoomToMouseLocation(): boolean
Gets or Set the boolean value that controls whether or not the mouse wheel zooms to the location of the mouse pointer or not. The default is false.

Returns boolean
Inherited from ArcRotateCamera.zoomToMouseLocation
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128532
set zoomToMouseLocation(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from ArcRotateCamera.zoomToMouseLocation
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128533

Methods

_getFirstPostProcess

_getFirstPostProcess(): Nullable<PostProcess>
Internal, gets the first post process.

Returns Nullable<PostProcess>
the first post process to be run on this camera.
Inherited from ArcRotateCamera._getFirstPostProcess
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128084

addBehavior

addBehavior(behavior: Behavior<Node>, attachImmediately?: boolean): Node
Attach a behavior to the node
Parameters
- behavior: Behavior<Node>
  defines the behavior to attach
- OptionalattachImmediately: boolean
  defines that the behavior must be attached even if the scene is still loading
Returns Node
the current Node

See
https://doc.babylonjs.com/features/featuresDeepDive/behaviors
Inherited from ArcRotateCamera.addBehavior
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4586

applyVerticalCorrection

applyVerticalCorrection(): void
Automatically tilts the projection plane, using projectionPlaneTilt, to correct the perspective effect on vertical lines.

Returns void
Inherited from ArcRotateCamera.applyVerticalCorrection
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128013

attachControl

attachControl(noPreventDefault?: boolean): void
Attach the input controls to a specific dom element to get the input from.
Parameters
- OptionalnoPreventDefault: boolean
  Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
Returns void
Inherited from ArcRotateCamera.attachControl
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128714
attachControl(ignored: any, noPreventDefault?: boolean): void
Attach the input controls to a specific dom element to get the input from.
Parameters
- ignored: any
  defines an ignored parameter kept for backward compatibility.
- OptionalnoPreventDefault: boolean
  Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
Returns void
Inherited from ArcRotateCamera.attachControl
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128720
attachControl(noPreventDefault: boolean, useCtrlForPanning: boolean): void
Attached controls to the current camera.
Parameters
- noPreventDefault: boolean
  Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
- useCtrlForPanning: boolean
  Defines whether ctrl is used for panning within the controls
Returns void
Inherited from ArcRotateCamera.attachControl
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128726
attachControl(
    ignored: any,
    noPreventDefault: boolean,
    useCtrlForPanning: boolean,
): void
Attached controls to the current camera.
Parameters
- ignored: any
  defines an ignored parameter kept for backward compatibility.
- noPreventDefault: boolean
  Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
- useCtrlForPanning: boolean
  Defines whether ctrl is used for panning within the controls
Returns void
Inherited from ArcRotateCamera.attachControl
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128733
attachControl(
    noPreventDefault: boolean,
    useCtrlForPanning: boolean,
    panningMouseButton: number,
): void
Attached controls to the current camera.
Parameters
- noPreventDefault: boolean
  Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
- useCtrlForPanning: boolean
  Defines whether ctrl is used for panning within the controls
- panningMouseButton: number
  Defines whether panning is allowed through mouse click button
Returns void
Inherited from ArcRotateCamera.attachControl
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128740

attachPostProcess

attachPostProcess(postProcess: PostProcess, insertAt?: Nullable<number>): number
Attach a post process to the camera.
Parameters
- postProcess: PostProcess
  The post process to attach to the camera
- OptionalinsertAt: Nullable<number>
  The position of the post process in case several of them are in use in the scene
Returns number
the position the post process has been inserted at

See
https://doc.babylonjs.com/features/featuresDeepDive/postProcesses/usePostProcesses#attach-postprocess
Inherited from ArcRotateCamera.attachPostProcess
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128093

beginAnimation

beginAnimation(
    name: string,
    loop?: boolean,
    speedRatio?: number,
    onAnimationEnd?: () => void,
): Nullable<Animatable>
Will start the animation sequence
Parameters
- name: string
  defines the range frames for animation sequence
- Optionalloop: boolean
  defines if the animation should loop (false by default)
- OptionalspeedRatio: number
  defines the speed factor in which to run the animation (1 by default)
- OptionalonAnimationEnd: () => void
  defines a function to be executed when the animation ended (undefined by default)
Returns Nullable<Animatable>
the object created for this animation. If range does not exist, it will return null
Inherited from ArcRotateCamera.beginAnimation
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4769

clone

clone(name: string, newParent?: Nullable<Node>): Camera
Clones the current camera.
Parameters
- name: string
  The cloned camera name
- OptionalnewParent: Nullable<Node>
  The cloned camera's new parent (none by default)
Returns Camera
the cloned camera
Inherited from ArcRotateCamera.clone
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128240

computeWorldMatrix

computeWorldMatrix(): Matrix
Compute the world matrix of the camera.

Returns Matrix
the camera world matrix
Inherited from ArcRotateCamera.computeWorldMatrix
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128271

createAnimationRange

createAnimationRange(name: string, from: number, to: number): void
Creates an animation range for this node
Parameters
- name: string
  defines the name of the range
- from: number
  defines the starting key
- to: number
  defines the end key
Returns void
Inherited from ArcRotateCamera.createAnimationRange
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4735

createRigCamera

createRigCamera(name: string, cameraIndex: number): Camera
Override Camera.createRigCamera
Parameters
- name: string
  the name of the camera
- cameraIndex: number
  the index of the camera in the rig cameras array
Returns Camera
Inherited from ArcRotateCamera.createRigCamera
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128793

deleteAnimationRange

deleteAnimationRange(name: string, deleteFrames?: boolean): void
Delete a specific animation range
Parameters
- name: string
  defines the name of the range to delete
- OptionaldeleteFrames: boolean
  defines if animation frames from the range must be deleted as well
Returns void
Inherited from ArcRotateCamera.deleteAnimationRange
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4741

detachControl

detachControl(): void
Detach the current controls from the specified dom element.

Returns void
Inherited from ArcRotateCamera.detachControl
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128744

detachPostProcess

detachPostProcess(postProcess: PostProcess): void
Detach a post process to the camera.
Parameters
- postProcess: PostProcess
  The post process to detach from the camera
Returns void
See
https://doc.babylonjs.com/features/featuresDeepDive/postProcesses/usePostProcesses#attach-postprocess
Inherited from ArcRotateCamera.detachPostProcess
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128099

dispose

dispose(): void
Destroy the camera and release the current resources hold by it.

Returns void
Inherited from ArcRotateCamera.dispose
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128807

focusOn

focusOn(
    meshesOrMinMaxVectorAndDistance:
        | AbstractMesh[]
        | { distance: number; max: Vector3; min: Vector3 },
    doNotUpdateMaxZ?: boolean,
): void
Focus on a mesh or a bounding box. This adapts the target and maxRadius if necessary but does not update the current radius. The target will be changed but the radius
Parameters
- meshesOrMinMaxVectorAndDistance: AbstractMesh[] | { distance: number; max: Vector3; min: Vector3 }
  Defines the mesh or bounding info to focus on
- OptionaldoNotUpdateMaxZ: boolean
  Defines whether or not maxZ should be updated whilst zooming on the mesh (this can happen if the mesh is big and the maxradius pretty small for instance)
Returns void
Inherited from ArcRotateCamera.focusOn
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128782

freezeProjectionMatrix

freezeProjectionMatrix(projection?: Matrix): void
Freeze the projection matrix. It will prevent the cache check of the camera projection compute and can speed up perf if no parameter of the camera are meant to change
Parameters
- Optionalprojection: Matrix
  Defines manually a projection if necessary
Returns void
Inherited from ArcRotateCamera.freezeProjectionMatrix
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128119

getActiveMeshes

getActiveMeshes(): SmartArray<AbstractMesh>
Gets the list of active meshes this frame (meshes no culled or excluded by lod s in the frame)

Returns SmartArray<AbstractMesh>
the active meshe list
Inherited from ArcRotateCamera.getActiveMeshes
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128022

getAnimationByName

getAnimationByName(name: string): Nullable<Animation>
Get an animation by name
Parameters
- name: string
  defines the name of the animation to look for
Returns Nullable<Animation>
null if not found else the requested animation
Inherited from ArcRotateCamera.getAnimationByName
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4728

getAnimationRange

getAnimationRange(name: string): Nullable<AnimationRange>
Get an animation range by name
Parameters
- name: string
  defines the name of the animation range to look for
Returns Nullable<AnimationRange>
null if not found else the requested animation range
Inherited from ArcRotateCamera.getAnimationRange
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4747

getAnimationRanges

getAnimationRanges(): Nullable<AnimationRange>[]
Gets the list of all animation ranges defined on this node

Returns Nullable<AnimationRange>[]
an array
Inherited from ArcRotateCamera.getAnimationRanges
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4760

getBehaviorByName

getBehaviorByName(name: string): Nullable<Behavior<Node>>
Gets an attached behavior by name
Parameters
- name: string
  defines the name of the behavior to look for
Returns Nullable<Behavior<Node>>
null if behavior was not found else the requested behavior

See
https://doc.babylonjs.com/features/featuresDeepDive/behaviors
Inherited from ArcRotateCamera.getBehaviorByName
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4605

getChildMeshes

getChildMeshes<T extends AbstractMesh>(
directDescendantsOnly?: boolean,
predicate?: (node: Node) => node is T,
): T[]
Get all child-meshes of this node
Type Parameters
- T extends AbstractMesh
Parameters
- OptionaldirectDescendantsOnly: boolean
  defines if true only direct descendants of 'this' will be considered, if false direct and also indirect (children of children, an so on in a recursive manner) descendants of 'this' will be considered (Default: false)
- Optionalpredicate: (node: Node) => node is T
  defines an optional predicate that will be called on every evaluated child, the predicate must return true for a given child to be part of the result, otherwise it will be ignored
Returns T[]
an array of AbstractMesh
Inherited from ArcRotateCamera.getChildMeshes
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4697
getChildMeshes(
directDescendantsOnly?: boolean,
predicate?: (node: Node) => boolean,
): AbstractMesh[]
Get all child-meshes of this node
Parameters
- OptionaldirectDescendantsOnly: boolean
  defines if true only direct descendants of 'this' will be considered, if false direct and also indirect (children of children, an so on in a recursive manner) descendants of 'this' will be considered (Default: false)
- Optionalpredicate: (node: Node) => boolean
  defines an optional predicate that will be called on every evaluated child, the predicate must return true for a given child to be part of the result, otherwise it will be ignored
Returns AbstractMesh[]
an array of AbstractMesh
Inherited from ArcRotateCamera.getChildMeshes
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4704

getChildren

getChildren<T extends Node>(
predicate?: (node: Node) => node is T,
directDescendantsOnly?: boolean,
): T[]
Get all direct children of this node
Type Parameters
- T extends Node
Parameters
- Optionalpredicate: (node: Node) => node is T
  defines an optional predicate that will be called on every evaluated child, the predicate must return true for a given child to be part of the result, otherwise it will be ignored
- OptionaldirectDescendantsOnly: boolean
  defines if true only direct descendants of 'this' will be considered, if false direct and also indirect (children of children, an so on in a recursive manner) descendants of 'this' will be considered (Default: true)
Returns T[]
an array of Node
Inherited from ArcRotateCamera.getChildren
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4711
getChildren(
predicate?: (node: Node) => boolean,
directDescendantsOnly?: boolean,
): Node[]
Get all direct children of this node
Parameters
- Optionalpredicate: (node: Node) => boolean
  defines an optional predicate that will be called on every evaluated child, the predicate must return true for a given child to be part of the result, otherwise it will be ignored
- OptionaldirectDescendantsOnly: boolean
  defines if true only direct descendants of 'this' will be considered, if false direct and also indirect (children of children, an so on in a recursive manner) descendants of 'this' will be considered (Default: true)
Returns Node[]
an array of Node
Inherited from ArcRotateCamera.getChildren
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4718

getClassName

getClassName(): string
Gets camera class name

Returns string
StereoscopicArcRotateCamera
Overrides ArcRotateCamera.getClassName
- Defined in .temp/typedoc/docdirectory/doc.d.ts:129489

getDescendants

getDescendants<T extends Node>(
directDescendantsOnly?: boolean,
predicate?: (node: Node) => node is T,
): T[]
Will return all nodes that have this node as ascendant
Type Parameters
- T extends Node
Parameters
- OptionaldirectDescendantsOnly: boolean
  defines if true only direct descendants of 'this' will be considered, if false direct and also indirect (children of children, an so on in a recursive manner) descendants of 'this' will be considered
- Optionalpredicate: (node: Node) => node is T
  defines an optional predicate that will be called on every evaluated child, the predicate must return true for a given child to be part of the result, otherwise it will be ignored
Returns T[]
all children nodes of all types
Inherited from ArcRotateCamera.getDescendants
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4683
getDescendants(
directDescendantsOnly?: boolean,
predicate?: (node: Node) => boolean,
): Node[]
Will return all nodes that have this node as ascendant
Parameters
- OptionaldirectDescendantsOnly: boolean
  defines if true only direct descendants of 'this' will be considered, if false direct and also indirect (children of children, an so on in a recursive manner) descendants of 'this' will be considered
- Optionalpredicate: (node: Node) => boolean
  defines an optional predicate that will be called on every evaluated child, the predicate must return true for a given child to be part of the result, otherwise it will be ignored
Returns Node[]
all children nodes of all types
Inherited from ArcRotateCamera.getDescendants
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4690

getDirection

getDirection(localAxis: DeepImmutableObject<Vector3>): Vector3
Gets the direction of the camera relative to a given local axis.
Parameters
- localAxis: DeepImmutableObject<Vector3>
  Defines the reference axis to provide a relative direction.
Returns Vector3
the direction
Inherited from ArcRotateCamera.getDirection
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128246

getDirectionToRef

getDirectionToRef(
localAxis: DeepImmutableObject<Vector3>,
result: Vector3,
): void
Gets the direction of the camera relative to a given local axis into a passed vector.
Parameters
- localAxis: DeepImmutableObject<Vector3>
  Defines the reference axis to provide a relative direction.
- result: Vector3
  Defines the vector to store the result in
Returns void
Inherited from ArcRotateCamera.getDirectionToRef
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128256

getEngine

getEngine(): AbstractEngine
Gets the engine of the node

Returns AbstractEngine
a Engine
Inherited from ArcRotateCamera.getEngine
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4577

getForwardRay

getForwardRay(length?: number, transform?: Matrix, origin?: Vector3): Ray
Gets a ray in the forward direction from the camera.
Parameters
- Optionallength: number
  Defines the length of the ray to create
- Optionaltransform: Matrix
  Defines the transform to apply to the ray, by default the world matrix is used to create a workd space ray
- Optionalorigin: Vector3
  Defines the start point of the ray which defaults to the camera position
Returns Ray
the forward ray
Inherited from ArcRotateCamera.getForwardRay
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128160

getForwardRayToRef

getForwardRayToRef(
    refRay: Ray,
    length?: number,
    transform?: Matrix,
    origin?: Vector3,
): Ray
Gets a ray in the forward direction from the camera.
Parameters
- refRay: Ray
  the ray to (re)use when setting the values
- Optionallength: number
  Defines the length of the ray to create
- Optionaltransform: Matrix
  Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
- Optionalorigin: Vector3
  Defines the start point of the ray which defaults to the camera position
Returns Ray
the forward ray
Inherited from ArcRotateCamera.getForwardRayToRef
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128169

getFrontPosition

getFrontPosition(distance: number): Vector3
Gets the position in front of the camera at a given distance.
Parameters
- distance: number
  The distance from the camera we want the position to be
Returns Vector3
the position
Inherited from ArcRotateCamera.getFrontPosition
- Defined in .temp/typedoc/docdirectory/doc.d.ts:126775

getHierarchyBoundingVectors

getHierarchyBoundingVectors(
includeDescendants?: boolean,
predicate?: Nullable<(abstractMesh: AbstractMesh) => boolean>,
): { max: Vector3; min: Vector3 }
Return the minimum and maximum world vectors of the entire hierarchy under current node
Parameters
- OptionalincludeDescendants: boolean
  Include bounding info from descendants as well (true by default)
- Optionalpredicate: Nullable<(abstractMesh: AbstractMesh) => boolean>
  defines a callback function that can be customize to filter what meshes should be included in the list used to compute the bounding vectors
Returns { max: Vector3; min: Vector3 }
the new bounding vectors
Inherited from ArcRotateCamera.getHierarchyBoundingVectors
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4800

getLeftTarget

getLeftTarget(): Nullable<Vector3>
Gets the left camera target of a rig setup in case of Rigged Camera

Returns Nullable<Vector3>
the target position
Inherited from ArcRotateCamera.getLeftTarget
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128200

getProjectionMatrix

getProjectionMatrix(force?: boolean): Matrix
Gets the current projection matrix of the camera.
Parameters
- Optionalforce: boolean
  forces the camera to recompute the matrix without looking at the cached state
Returns Matrix
the projection matrix
Inherited from ArcRotateCamera.getProjectionMatrix
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128129

getRightTarget

getRightTarget(): Nullable<Vector3>
Gets the right camera target of a rig setup in case of Rigged Camera

Returns Nullable<Vector3>
the target position
Inherited from ArcRotateCamera.getRightTarget
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128205

getScene

getScene(): Scene
Gets the scene of the node

Returns Scene
a scene
Inherited from ArcRotateCamera.getScene
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4572

getTarget

getTarget(): Vector3
Return the current target position of the camera. This value is expressed in local space.

Returns Vector3
the target position
Inherited from ArcRotateCamera.getTarget
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128370

getTransformationMatrix

getTransformationMatrix(): Matrix
Gets the transformation matrix (ie. the multiplication of view by projection matrices)

Returns Matrix
a Matrix
Inherited from ArcRotateCamera.getTransformationMatrix
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128134

getViewMatrix

getViewMatrix(force?: boolean): Matrix
Gets the current view matrix of the camera.
Parameters
- Optionalforce: boolean
  forces the camera to recompute the matrix without looking at the cached state
Returns Matrix
the view matrix
Inherited from ArcRotateCamera.getViewMatrix
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128112

getWorldMatrix

getWorldMatrix(): Matrix
Gets the current world matrix of the camera

Returns Matrix
the world matrix
Inherited from ArcRotateCamera.getWorldMatrix
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128104

hasStateStored

hasStateStored(): boolean
Returns true if a state has been stored by calling storeState method.

Returns boolean
true if state has been stored.
Inherited from ArcRotateCamera.hasStateStored
- Defined in .temp/typedoc/docdirectory/doc.d.ts:127986

interpolateTo

interpolateTo(
    alpha?: number,
    beta?: number,
    radius?: number,
    target?: Vector3,
    targetScreenOffset?: Vector2,
    interpolationFactor?: number,
): void
Interpolates the camera to a goal state.
Parameters
- Optionalalpha: number
  Defines the goal alpha.
- Optionalbeta: number
  Defines the goal beta.
- Optionalradius: number
  Defines the goal radius.
- Optionaltarget: Vector3
  Defines the goal target.
- OptionaltargetScreenOffset: Vector2
  Defines the goal target screen offset.
- OptionalinterpolationFactor: number
  A value between 0 and 1 that determines the speed of the interpolation.
Returns void
Remarks
Passing undefined for any of the parameters will use the current value (effectively stopping any in-progress interpolation for that parameter). Passing NaN will not start or stop any interpolation for that parameter (effectively allowing multiple interpolations of different parameters to overlap).
Inherited from ArcRotateCamera.interpolateTo
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128707

isActiveMesh

isActiveMesh(mesh: Mesh): boolean
Check whether a mesh is part of the current active mesh list of the camera
Parameters
- mesh: Mesh
  Defines the mesh to check
Returns boolean
true if active, false otherwise
Inherited from ArcRotateCamera.isActiveMesh
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128028

isCompletelyInFrustum

isCompletelyInFrustum(target: ICullable): boolean
Checks if a cullable object (mesh...) is in the camera frustum Unlike isInFrustum this checks the full bounding box
Parameters
- target: ICullable
  The object to check
Returns boolean
true if the object is in frustum otherwise false
Inherited from ArcRotateCamera.isCompletelyInFrustum
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128152

isDescendantOf

isDescendantOf(ancestor: Node): boolean
Is this node a descendant of the given node? The function will iterate up the hierarchy until the ancestor was found or no more parents defined
Parameters
- ancestor: Node
  defines the parent node to inspect
Returns boolean
a boolean indicating if this node is a descendant of the given node
Inherited from ArcRotateCamera.isDescendantOf
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4672

isDisposed

isDisposed(): boolean
Gets a boolean indicating if the node has been disposed

Returns boolean
true if the node was disposed
Inherited from ArcRotateCamera.isDisposed
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4516

isEnabled

isEnabled(checkAncestors?: boolean): boolean
Is this node enabled? If the node has a parent, all ancestors will be checked and false will be returned if any are false (not enabled), otherwise will return true
Parameters
- OptionalcheckAncestors: boolean
  indicates if this method should check the ancestors. The default is to check the ancestors. If set to false, the method will return the value of this node without checking ancestors
Returns boolean
whether this node (and its parent) is enabled
Inherited from ArcRotateCamera.isEnabled
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4658

isInFrustum

isInFrustum(target: ICullable, checkRigCameras?: boolean): boolean
Checks if a cullable object (mesh...) is in the camera frustum This checks the bounding box center. See isCompletelyInFrustum for a full bounding check
Parameters
- target: ICullable
  The object to check
- OptionalcheckRigCameras: boolean
  If the rig cameras should be checked (eg. with VR camera both eyes should be checked) (Default: false)
Returns boolean
true if the object is in frustum otherwise false
Inherited from ArcRotateCamera.isInFrustum
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128145

isReady

isReady(completeCheck?: boolean): boolean
Is this camera ready to be used/rendered
Parameters
- OptionalcompleteCheck: boolean
  defines if a complete check (including post processes) has to be done (false by default)
Returns boolean
true if the camera is ready
Inherited from ArcRotateCamera.isReady
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128034

markAsDirty

markAsDirty(_property?: string): Node
Flag the node as dirty (Forcing it to update everything)
Parameters
- Optional_property: string
  helps children apply precise "dirtyfication"
Returns Node
this node
Inherited from ArcRotateCamera.markAsDirty
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4651

rebuildAnglesAndRadius

rebuildAnglesAndRadius(): void
Rebuilds angles (alpha, beta) and radius from the give position and target

Returns void
Inherited from ArcRotateCamera.rebuildAnglesAndRadius
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128751

removeBehavior

removeBehavior(behavior: Behavior<Node>): Node
Remove an attached behavior
Parameters
- behavior: Behavior<Node>
  defines the behavior to attach
Returns Node
the current Node

See
https://doc.babylonjs.com/features/featuresDeepDive/behaviors
Inherited from ArcRotateCamera.removeBehavior
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4593

restoreState

restoreState(): boolean
Restored camera state. You must call storeState() first.

Returns boolean
true if restored and false otherwise
Inherited from ArcRotateCamera.restoreState
- Defined in .temp/typedoc/docdirectory/doc.d.ts:127996

serialize

serialize(): any
Serialiaze the camera setup to a json representation

Returns any
the JSON representation
Inherited from ArcRotateCamera.serialize
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128233

serializeAnimationRanges

serializeAnimationRanges(): any
Serialize animation ranges into a JSON compatible object

Returns any
serialization object
Inherited from ArcRotateCamera.serializeAnimationRanges
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4774

setEnabled

setEnabled(value: boolean): void
Set the enabled state of this node
Parameters
- value: boolean
  defines the new enabled state
Returns void
Inherited from ArcRotateCamera.setEnabled
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4665

setMatUp

setMatUp(): void
Sets the Y-up to camera up-vector rotation matrix, and the up-vector to Y-up rotation matrix.

Returns void
Inherited from ArcRotateCamera.setMatUp
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128388

setPosition

setPosition(position: Vector3): void
Use a position to define the current camera related information like alpha, beta and radius
Parameters
- position: Vector3
  Defines the position to set the camera at
Returns void
Inherited from ArcRotateCamera.setPosition
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128756

setTarget

setTarget(
    target: TransformNode | Vector3,
    toBoundingCenter?: boolean,
    allowSamePosition?: boolean,
    cloneAlphaBetaRadius?: boolean,
): void
Defines the target the camera should look at. This will automatically adapt alpha beta and radius to fit within the new target. Please note that setting a target as a mesh will disable panning.
Parameters
- target: TransformNode | Vector3
  Defines the new target as a Vector or a transform node
- OptionaltoBoundingCenter: boolean
  In case of a mesh target, defines whether to target the mesh position or its bounding information center
- OptionalallowSamePosition: boolean
  If false, prevents reapplying the new computed position if it is identical to the current one (optim)
- OptionalcloneAlphaBetaRadius: boolean
  If true, replicate the current setup (alpha, beta, radius) on the new target
Returns void
Inherited from ArcRotateCamera.setTarget
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128766

stopInterpolation

stopInterpolation(): void
Stops any in-progress interpolation.

Returns void
Inherited from ArcRotateCamera.stopInterpolation
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128695

storeState

storeState(): Camera
Stores the current state of the camera (alpha, beta, radius and target)

Returns Camera
the camera itself
Inherited from ArcRotateCamera.storeState
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128686

toString

toString(fullDetails?: boolean): string
Gets a string representation of the camera useful for debug purpose.
Parameters
- OptionalfullDetails: boolean
  Defines that a more verbose level of logging is required
Returns string
the string representation
Inherited from ArcRotateCamera.toString
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128009

unfreezeProjectionMatrix

unfreezeProjectionMatrix(): void
Unfreeze the projection matrix if it has previously been freezed by freezeProjectionMatrix.

Returns void
Inherited from ArcRotateCamera.unfreezeProjectionMatrix
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128123

update

update(): void
Update the camera state according to the different inputs gathered during the frame.

Returns void
Inherited from ArcRotateCamera.update
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128071

zoomOn

zoomOn(meshes?: AbstractMesh[], doNotUpdateMaxZ?: boolean): void
Zooms on a mesh to be at the min distance where we could see it fully in the current viewport.
Parameters
- Optionalmeshes: AbstractMesh[]
  Defines the mesh to zoom on
- OptionaldoNotUpdateMaxZ: boolean
  Defines whether or not maxZ should be updated whilst zooming on the mesh (this can happen if the mesh is big and the maxradius pretty small for instance)
Returns void
Inherited from ArcRotateCamera.zoomOn
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128775

`Static`AddNodeConstructor

AddNodeConstructor(type: string, constructorFunc: NodeConstructor): void
Add a new node constructor
Parameters
- type: string
  defines the type name of the node to construct
- constructorFunc: NodeConstructor
  defines the constructor function
Returns void
Inherited from ArcRotateCamera.AddNodeConstructor
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4418

`Static`Construct

Construct(
    type: string,
    name: string,
    scene: Scene,
    options?: any,
): Nullable<() => Node>
Returns a node constructor based on type name
Parameters
- type: string
  defines the type name
- name: string
  defines the new node name
- scene: Scene
  defines the hosting scene
- Optionaloptions: any
  defines optional options to transmit to constructors
Returns Nullable<() => Node>
the new constructor or null
Inherited from ArcRotateCamera.Construct
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4427

`Static`GetConstructorFromName

GetConstructorFromName(
    type: string,
    name: string,
    scene: Scene,
    interaxial_distance?: number,
    isStereoscopicSideBySide?: boolean,
): () => Camera
Gets a camera constructor for a given camera type
Parameters
- type: string
  The type of the camera to construct (should be equal to one of the camera class name)
- name: string
  The name of the camera the result will be able to instantiate
- scene: Scene
  The scene the result will construct the camera in
- Optionalinteraxial_distance: number
  In case of stereoscopic setup, the distance between both eyes
- OptionalisStereoscopicSideBySide: boolean
  In case of stereoscopic setup, should the sereo be side b side
Returns () => Camera
a factory method to construct the camera
Inherited from ArcRotateCamera.GetConstructorFromName
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128266

`Static`Parse

Parse(parsedCamera: any, scene: Scene): Camera
Parse a JSON and creates the camera from the parsed information
Parameters
- parsedCamera: any
  The JSON to parse
- scene: Scene
  The scene to instantiate the camera in
Returns Camera
the newly constructed camera
Inherited from ArcRotateCamera.Parse
- Defined in .temp/typedoc/docdirectory/doc.d.ts:128278

`Static`ParseAnimationRanges

ParseAnimationRanges(node: Node, parsedNode: any, _scene: Scene): void
Parse animation range data from a serialization object and store them into a given node
Parameters
- node: Node
  defines where to store the animation ranges
- parsedNode: any
  defines the serialization object to read data from
- _scene: Scene
  defines the hosting scene
Returns void
Inherited from ArcRotateCamera.ParseAnimationRanges
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4793

Class StereoscopicArcRotateCamera

See

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns StereoscopicArcRotateCamera

Properties

allowUpsideDown

alpha

animations

beta

cameraDirection

cameraRigMode

cameraRotation

checkCollisions

See

collisionRadius

See

customRenderTargets

fov

fovMode

id

ignoreParentScaling

inertia

inertialAlphaOffset

inertialBetaOffset

inertialPanningX

inertialPanningY

inertialRadiusOffset

inputs

inspectableCustomProperties

See

interaxialDistance

inverseRotationSpeed

invertRotation

isIntermediate

isRigCamera

isStereoscopicSideBySide

layerMask

lockedTarget

lowerAlphaLimit

lowerBetaLimit

lowerRadiusLimit

lowerTargetYLimit

mapPanning

maxZ

metadata

minZ

name

noRotationConstraint

oblique

onAccessibilityTagChangedObservable

onAfterCheckInputsObservable

onCollide

onDisposeObservable

onMeshTargetChangedObservable

onProjectionMatrixChangedObservable

onReady

onRestoreStateObservable

onViewMatrixChangedObservable

outputRenderTarget

overrideCloneAlphaBetaRadius

panningAxis

panningDistanceLimit

panningInertia

panningOriginTarget

pinchToPanMaxDistance

projectionPlaneTilt

radius

renderPassId

reservedDataStore

restoreStateInterpolationFactor

OptionalrigParent

rotation

`Optional`rigParent

`Static`ForceAttachControlToAlwaysPreventDefault

`Static` `Readonly`FOVMODE_HORIZONTAL_FIXED

`Static` `Readonly`FOVMODE_VERTICAL_FIXED

`Static` `Readonly`ORTHOGRAPHIC_CAMERA

`Static` `Readonly`PERSPECTIVE_CAMERA

`Static` `Readonly`RIG_MODE_CUSTOM

`Static` `Readonly`RIG_MODE_NONE

`Static` `Readonly`RIG_MODE_STEREOSCOPIC_ANAGLYPH

`Static` `Readonly`RIG_MODE_STEREOSCOPIC_INTERLACED

`Static` `Readonly`RIG_MODE_STEREOSCOPIC_OVERUNDER

`Static` `Readonly`RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_CROSSEYED

`Static` `Readonly`RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_PARALLEL

`Static` `Readonly`RIG_MODE_VR