Class: PlumArcRotateCamera

Defined in: packages/core/sdk/src/camera/PlumArcRotateCamera.ts:8

Extends

• ArcRotateCamera

Constructors

Constructor

new PlumArcRotateCamera(name, alpha, beta, radius, target, scene?, setActiveOnSceneIfNoneActive?): PlumArcRotateCamera

Defined in: packages/core/sdk/src/camera/PlumArcRotateCamera.ts:9

Parameters

name

string

alpha

number

beta

number

radius

number

target

Vector3

scene?

Scene

setActiveOnSceneIfNoneActive?

boolean = true

Returns

PlumArcRotateCamera

Overrides

ArcRotateCamera.constructor

Properties

_accessibilityTag

protected _accessibilityTag: IAccessibilityTag

Defined in: node_modules/@babylonjs/core/node.d.ts:82

Inherited from

ArcRotateCamera._accessibilityTag

---

_activeMeshes

_activeMeshes: SmartArray<AbstractMesh>

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:278

Internal

Inherited from

ArcRotateCamera._activeMeshes

---

_cache

_cache: any

Defined in: node_modules/@babylonjs/core/node.d.ts:119

Internal

Inherited from

ArcRotateCamera._cache

---

_cameraRigParams

_cameraRigParams: any

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:266

Internal

Inherited from

ArcRotateCamera._cameraRigParams

---

_cameraRotationMatrix

_cameraRotationMatrix: Matrix

Defined in: node_modules/@babylonjs/core/Cameras/targetCamera.d.ts:73

Internal

Inherited from

ArcRotateCamera._cameraRotationMatrix

---

_cameraTransformMatrix

_cameraTransformMatrix: Matrix

Defined in: node_modules/@babylonjs/core/Cameras/targetCamera.d.ts:71

Internal

Inherited from

ArcRotateCamera._cameraTransformMatrix

---

_camMatrix

_camMatrix: Matrix

Defined in: node_modules/@babylonjs/core/Cameras/targetCamera.d.ts:69

Internal

Inherited from

ArcRotateCamera._camMatrix

---

_children

protected _children: Node[]

Defined in: node_modules/@babylonjs/core/node.d.ts:122

Internal

Inherited from

ArcRotateCamera._children

---

_childUpdateId

_childUpdateId: number

Defined in: node_modules/@babylonjs/core/node.d.ts:109

Internal

Inherited from

ArcRotateCamera._childUpdateId

---

_collider

protected _collider: Collider

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:345

Inherited from

ArcRotateCamera._collider

---

_collisionTriggered

protected _collisionTriggered: boolean

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:352

Inherited from

ArcRotateCamera._collisionTriggered

---

_collisionVelocity

protected _collisionVelocity: Vector3

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:347

Inherited from

ArcRotateCamera._collisionVelocity

---

_computedViewMatrix

_computedViewMatrix: Matrix

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:281

Internal

Inherited from

ArcRotateCamera._computedViewMatrix

---

_currentRenderId

_currentRenderId: number

Defined in: node_modules/@babylonjs/core/node.d.ts:106

Internal

Inherited from

ArcRotateCamera._currentRenderId

---

_currentTarget

_currentTarget: Vector3

Defined in: node_modules/@babylonjs/core/Cameras/targetCamera.d.ts:63

Internal

Inherited from

ArcRotateCamera._currentTarget

---

_deferOnly

protected _deferOnly: boolean

Defined in: node_modules/@babylonjs/core/Cameras/targetCamera.d.ts:82

Inherited from

ArcRotateCamera._deferOnly

---

_deferredPositionUpdate

protected _deferredPositionUpdate: Vector3

Defined in: node_modules/@babylonjs/core/Cameras/targetCamera.d.ts:78

Inherited from

ArcRotateCamera._deferredPositionUpdate

---

_deferredRotationQuaternionUpdate

protected _deferredRotationQuaternionUpdate: Quaternion

Defined in: node_modules/@babylonjs/core/Cameras/targetCamera.d.ts:79

Inherited from

ArcRotateCamera._deferredRotationQuaternionUpdate

---

_deferredRotationUpdate

protected _deferredRotationUpdate: Vector3

Defined in: node_modules/@babylonjs/core/Cameras/targetCamera.d.ts:80

Inherited from

ArcRotateCamera._deferredRotationUpdate

---

_deferredUpdated

protected _deferredUpdated: boolean

Defined in: node_modules/@babylonjs/core/Cameras/targetCamera.d.ts:81

Inherited from

ArcRotateCamera._deferredUpdated

---

_frustumPlanes

_frustumPlanes: Plane[]

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:285

Internal

Inherited from

ArcRotateCamera._frustumPlanes

---

_globalPosition

protected _globalPosition: Vector3

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:279

Inherited from

ArcRotateCamera._globalPosition

---

_initialFocalDistance

_initialFocalDistance: number

Defined in: node_modules/@babylonjs/core/Cameras/targetCamera.d.ts:65

Internal

Inherited from

ArcRotateCamera._initialFocalDistance

---

_internalMetadata

_internalMetadata: any

Defined in: node_modules/@babylonjs/core/node.d.ts:67

Internal

Inherited from

ArcRotateCamera._internalMetadata

---

_isCamera

readonly _isCamera: true = true

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:326

Internal

Inherited from

ArcRotateCamera._isCamera

---

_isDirty

protected _isDirty: boolean

Defined in: node_modules/@babylonjs/core/node.d.ts:24

Inherited from

ArcRotateCamera._isDirty

---

_isLeftCamera

_isLeftCamera: boolean

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:500

Internal

Inherited from

ArcRotateCamera._isLeftCamera

---

_isNode

readonly _isNode: true = true

Defined in: node_modules/@babylonjs/core/node.d.ts:160

Internal

Inherited from

ArcRotateCamera._isNode

---

_isRightCamera

_isRightCamera: boolean

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:506

Internal

Inherited from

ArcRotateCamera._isRightCamera

---

_multiviewTexture

_multiviewTexture: RenderTargetTexture

Defined in: node_modules/@babylonjs/core/Engines/Extensions/engine.multiview.d.ts:39

Internal

For cameras that cannot use multiview images to display directly. (e.g. webVR camera will render to multiview texture, then copy to each eye texture and go from there)

Inherited from

ArcRotateCamera._multiviewTexture

---

_newPosition

protected _newPosition: Vector3

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:348

Inherited from

ArcRotateCamera._newPosition

---

_onCollisionPositionChange()

protected _onCollisionPositionChange: (collisionId, newPosition, collidedMesh?) => void

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:470

Parameters

collisionId

number

newPosition

Vector3

collidedMesh?

AbstractMesh

Returns

void

Inherited from

ArcRotateCamera._onCollisionPositionChange

---

_panningMouseButton

_panningMouseButton: number

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:269

Internal

Inherited from

ArcRotateCamera._panningMouseButton

---

_parentContainer

_parentContainer: IAssetContainer

Defined in: node_modules/@babylonjs/core/node.d.ts:93

Internal

Inherited from

ArcRotateCamera._parentContainer

---

_parentNode

protected _parentNode: Node

Defined in: node_modules/@babylonjs/core/node.d.ts:120

Inherited from

ArcRotateCamera._parentNode

---

_position

_position: Vector3

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:100

Internal

Inherited from

ArcRotateCamera._position

---

_postProcesses

_postProcesses: PostProcess[]

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:276

Internal

Inherited from

ArcRotateCamera._postProcesses

---

_previousAlpha

protected _previousAlpha: number

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:349

Inherited from

ArcRotateCamera._previousAlpha

---

_previousBeta

protected _previousBeta: number

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:350

Inherited from

ArcRotateCamera._previousBeta

---

_previousPosition

protected _previousPosition: Vector3

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:346

Inherited from

ArcRotateCamera._previousPosition

---

_previousRadius

protected _previousRadius: number

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:351

Inherited from

ArcRotateCamera._previousRadius

---

_projectionMatrix

_projectionMatrix: Matrix

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:274

Internal

Inherited from

ArcRotateCamera._projectionMatrix

---

_ranges

protected _ranges: object

Defined in: node_modules/@babylonjs/core/node.d.ts:98

Index Signature

[name: string]: AnimationRange

Inherited from

ArcRotateCamera._ranges

---

_referencePoint

_referencePoint: Vector3

Defined in: node_modules/@babylonjs/core/Cameras/targetCamera.d.ts:75

Internal

Inherited from

ArcRotateCamera._referencePoint

---

_renderingMultiview

_renderingMultiview: boolean

Defined in: node_modules/@babylonjs/core/Engines/Extensions/engine.multiview.d.ts:44

Internal

For WebXR cameras that are rendering to multiview texture arrays.

Inherited from

ArcRotateCamera._renderingMultiview

---

_reset()

_reset: () => void

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:275

Internal

Returns

void

Inherited from

ArcRotateCamera._reset

---

_rigCameras

_rigCameras: Camera[]

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:268

Internal

Inherited from

ArcRotateCamera._rigCameras

---

_rigPostProcess

_rigPostProcess: PostProcess

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:270

Internal

Inherited from

ArcRotateCamera._rigPostProcess

---

_scene

_scene: Scene

Defined in: node_modules/@babylonjs/core/node.d.ts:117

Internal

Inherited from

ArcRotateCamera._scene

---

_skipRendering

_skipRendering: boolean

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:272

Internal

Inherited from

ArcRotateCamera._skipRendering

---

_target

protected _target: Vector3

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:52

Inherited from

ArcRotateCamera._target

---

_targetBoundingCenter

protected _targetBoundingCenter: Vector3

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:353

Inherited from

ArcRotateCamera._targetBoundingCenter

---

_targetHost

protected _targetHost: TransformNode

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:53

Inherited from

ArcRotateCamera._targetHost

---

_transformedDirection

protected _transformedDirection: Vector3

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:280

Inherited from

ArcRotateCamera._transformedDirection

---

_transformedReferencePoint

_transformedReferencePoint: Vector3

Defined in: node_modules/@babylonjs/core/Cameras/targetCamera.d.ts:77

Internal

Inherited from

ArcRotateCamera._transformedReferencePoint

---

_upToYMatrix

protected _upToYMatrix: Matrix

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:77

Inherited from

ArcRotateCamera._upToYMatrix

---

_upVector

protected _upVector: Vector3

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:106

Inherited from

ArcRotateCamera._upVector

---

_useCtrlForPanning

_useCtrlForPanning: boolean

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:267

Internal

Inherited from

ArcRotateCamera._useCtrlForPanning

---

_useMultiviewToSingleView

_useMultiviewToSingleView: boolean

Defined in: node_modules/@babylonjs/core/Engines/Extensions/engine.multiview.d.ts:34

Internal

For cameras that cannot use multiview images to display directly. (e.g. webVR camera will render to multiview texture, then copy to each eye texture and go from there)

Inherited from

ArcRotateCamera._useMultiviewToSingleView

---

_viewMatrix

_viewMatrix: Matrix

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:265

Internal

Inherited from

ArcRotateCamera._viewMatrix

---

_waitingParentId

_waitingParentId: string

Defined in: node_modules/@babylonjs/core/node.d.ts:111

Internal

Inherited from

ArcRotateCamera._waitingParentId

---

_waitingParentInstanceIndex

_waitingParentInstanceIndex: string

Defined in: node_modules/@babylonjs/core/node.d.ts:113

Internal

Inherited from

ArcRotateCamera._waitingParentInstanceIndex

---

_waitingParsedUniqueId

_waitingParsedUniqueId: number

Defined in: node_modules/@babylonjs/core/node.d.ts:115

Internal

Inherited from

ArcRotateCamera._waitingParsedUniqueId

---

_worldMatrix

_worldMatrix: Matrix

Defined in: node_modules/@babylonjs/core/node.d.ts:124

Internal

Inherited from

ArcRotateCamera._worldMatrix

---

_worldMatrixDeterminant

_worldMatrixDeterminant: number

Defined in: node_modules/@babylonjs/core/node.d.ts:126

Internal

Inherited from

ArcRotateCamera._worldMatrixDeterminant

---

_worldMatrixDeterminantIsDirty

_worldMatrixDeterminantIsDirty: boolean

Defined in: node_modules/@babylonjs/core/node.d.ts:128

Internal

Inherited from

ArcRotateCamera._worldMatrixDeterminantIsDirty

---

_yToUpMatrix

protected _yToUpMatrix: Matrix

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:78

Inherited from

ArcRotateCamera._yToUpMatrix

---

allowUpsideDown

allowUpsideDown: boolean

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:254

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

Inherited from

ArcRotateCamera.allowUpsideDown

---

alpha

alpha: number

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:38

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

Inherited from

ArcRotateCamera.alpha

---

animations

animations: Animation[]

Defined in: node_modules/@babylonjs/core/node.d.ts:97

Gets a list of Animations associated with the node

Inherited from

ArcRotateCamera.animations

---

beta

beta: number

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:42

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

Inherited from

ArcRotateCamera.beta

---

cameraDirection

cameraDirection: Vector3

Defined in: node_modules/@babylonjs/core/Cameras/targetCamera.d.ts:19

Define the current direction the camera is moving to

Inherited from

ArcRotateCamera.cameraDirection

---

cameraRigMode

cameraRigMode: number

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:206

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.

Inherited from

ArcRotateCamera.cameraRigMode

---

cameraRotation

cameraRotation: Vector2

Defined in: node_modules/@babylonjs/core/Cameras/targetCamera.d.ts:23

Define the current rotation the camera is rotating to

Inherited from

ArcRotateCamera.cameraRotation

---

checkCollisions

checkCollisions: boolean

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:338

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-

Inherited from

ArcRotateCamera.checkCollisions

---

collisionRadius

collisionRadius: Vector3

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:344

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

Inherited from

ArcRotateCamera.collisionRadius

---

customRenderTargets

customRenderTargets: RenderTargetTexture[]

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:222

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)

Inherited from

ArcRotateCamera.customRenderTargets

---

fov

fov: number

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:152

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

Inherited from

ArcRotateCamera.fov

---

fovMode

fovMode: number

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:200

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

Inherited from

ArcRotateCamera.fovMode

---

id

id: string

Defined in: node_modules/@babylonjs/core/node.d.ts:53

Gets or sets the id of the node

Inherited from

ArcRotateCamera.id

---

ignoreParentScaling

ignoreParentScaling: boolean

Defined in: node_modules/@babylonjs/core/Cameras/targetCamera.d.ts:25

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

Inherited from

ArcRotateCamera.ignoreParentScaling

---

inertia

inertia: number

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:175

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

Inherited from

ArcRotateCamera.inertia

---

inertialAlphaOffset

inertialAlphaOffset: number

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:94

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

Inherited from

ArcRotateCamera.inertialAlphaOffset

---

inertialBetaOffset

inertialBetaOffset: number

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:99

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

Inherited from

ArcRotateCamera.inertialBetaOffset

---

inertialPanningX

inertialPanningX: number

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:143

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

Inherited from

ArcRotateCamera.inertialPanningX

---

inertialPanningY

inertialPanningY: number

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:147

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

Inherited from

ArcRotateCamera.inertialPanningY

---

inertialRadiusOffset

inertialRadiusOffset: number

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:104

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

Inherited from

ArcRotateCamera.inertialRadiusOffset

---

inputs

inputs: ArcRotateCameraInputsManager

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:273

Defines the input associated to the camera.

Inherited from

ArcRotateCamera.inputs

---

inspectableCustomProperties

inspectableCustomProperties: IInspectable[]

Defined in: node_modules/@babylonjs/core/node.d.ts:76

List of inspectable custom properties (used by the Inspector)

See

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

Inherited from

ArcRotateCamera.inspectableCustomProperties

---

interaxialDistance

interaxialDistance: number

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:210

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

Inherited from

ArcRotateCamera.interaxialDistance

---

inverseRotationSpeed

inverseRotationSpeed: number

Defined in: node_modules/@babylonjs/core/Cameras/targetCamera.d.ts:56

Speed multiplier for inverse camera panning

Inherited from

ArcRotateCamera.inverseRotationSpeed

---

invertRotation

invertRotation: boolean

Defined in: node_modules/@babylonjs/core/Cameras/targetCamera.d.ts:52

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

Inherited from

ArcRotateCamera.invertRotation

---

isIntermediate

isIntermediate: boolean

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:186

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

Inherited from

ArcRotateCamera.isIntermediate

---

isRigCamera

isRigCamera: boolean

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:250

Is this camera a part of a rig system?

Inherited from

ArcRotateCamera.isRigCamera

---

isStereoscopicSideBySide

isStereoscopicSideBySide: boolean

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:214

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

Inherited from

ArcRotateCamera.isStereoscopicSideBySide

---

layerMask

layerMask: number

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:196

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

Inherited from

ArcRotateCamera.layerMask

---

lockedTarget

lockedTarget: any

Defined in: node_modules/@babylonjs/core/Cameras/targetCamera.d.ts:61

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

Inherited from

ArcRotateCamera.lockedTarget

---

lowerAlphaLimit

lowerAlphaLimit: number

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:109

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

Inherited from

ArcRotateCamera.lowerAlphaLimit

---

lowerBetaLimit

lowerBetaLimit: number

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:119

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

Inherited from

ArcRotateCamera.lowerBetaLimit

---

lowerRadiusLimit

lowerRadiusLimit: number

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:129

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.

Inherited from

ArcRotateCamera.lowerRadiusLimit

---

lowerTargetYLimit

lowerTargetYLimit: number

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:139

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.

Inherited from

ArcRotateCamera.lowerTargetYLimit

---

mapPanning

mapPanning: boolean

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:284

Defines if camera will eliminate transform on y axis.

Inherited from

ArcRotateCamera.mapPanning

---

maxZ

maxZ: number

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:170

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.

Inherited from

ArcRotateCamera.maxZ

---

metadata

metadata: any

Defined in: node_modules/@babylonjs/core/node.d.ts:65

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

Inherited from

ArcRotateCamera.metadata

---

minZ

minZ: number

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:164

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.

Inherited from

ArcRotateCamera.minZ

---

name

name: string

Defined in: node_modules/@babylonjs/core/node.d.ts:49

Gets or sets the name of the node

Inherited from

ArcRotateCamera.name

---

noRotationConstraint

noRotationConstraint: boolean

Defined in: node_modules/@babylonjs/core/Cameras/targetCamera.d.ts:47

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

Inherited from

ArcRotateCamera.noRotationConstraint

---

oblique

oblique: IObliqueParams

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:116

Object containing oblique projection values (only used with ORTHOGRAPHIC_CAMERA)

Inherited from

ArcRotateCamera.oblique

---

onAccessibilityTagChangedObservable

onAccessibilityTagChangedObservable: Observable<IAccessibilityTag>

Defined in: node_modules/@babylonjs/core/node.d.ts:86

Observable fired when an accessibility tag is changed

Inherited from

ArcRotateCamera.onAccessibilityTagChangedObservable

---

onAfterCheckInputsObservable

onAfterCheckInputsObservable: Observable<Camera>

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:242

Observable triggered when the inputs have been processed.

Inherited from

ArcRotateCamera.onAfterCheckInputsObservable

---

onCollide()

onCollide: (collidedMesh) => void

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:333

Event raised when the camera is colliding with a mesh.

Parameters

collidedMesh

AbstractMesh

Returns

void

Inherited from

ArcRotateCamera.onCollide

---

onDisposeObservable

onDisposeObservable: Observable<Node>

Defined in: node_modules/@babylonjs/core/node.d.ts:164

An event triggered when the mesh is disposed

Inherited from

ArcRotateCamera.onDisposeObservable

---

onMeshTargetChangedObservable

onMeshTargetChangedObservable: Observable<TransformNode>

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:329

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

Inherited from

ArcRotateCamera.onMeshTargetChangedObservable

---

onProjectionMatrixChangedObservable

onProjectionMatrixChangedObservable: Observable<Camera>

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:238

Observable triggered when the camera Projection matrix has changed.

Inherited from

ArcRotateCamera.onProjectionMatrixChangedObservable

---

onReady()

onReady: (node) => void

Defined in: node_modules/@babylonjs/core/node.d.ts:104

Callback raised when the node is ready to be used

Parameters

node

Node

Returns

void

Inherited from

ArcRotateCamera.onReady

---

onRestoreStateObservable

onRestoreStateObservable: Observable<Camera>

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:246

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

Inherited from

ArcRotateCamera.onRestoreStateObservable

---

onViewMatrixChangedObservable

onViewMatrixChangedObservable: Observable<Camera>

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:234

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.

Inherited from

ArcRotateCamera.onViewMatrixChangedObservable

---

outputRenderTarget

outputRenderTarget: RenderTargetTexture

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:228

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

Inherited from

ArcRotateCamera.outputRenderTarget

---

overrideCloneAlphaBetaRadius

overrideCloneAlphaBetaRadius: boolean

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:51

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).

Inherited from

ArcRotateCamera.overrideCloneAlphaBetaRadius

---

panningAxis

panningAxis: Vector3

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:279

Defines the allowed panning axis.

Inherited from

ArcRotateCamera.panningAxis

---

panningDistanceLimit

panningDistanceLimit: number

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:158

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

Inherited from

ArcRotateCamera.panningDistanceLimit

---

panningInertia

panningInertia: number

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:167

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

Inherited from

ArcRotateCamera.panningInertia

---

panningOriginTarget

panningOriginTarget: Vector3

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:162

Defines the target of the camera before panning.

Inherited from

ArcRotateCamera.panningOriginTarget

---

pinchToPanMaxDistance

pinchToPanMaxDistance: number

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:153

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.

Inherited from

ArcRotateCamera.pinchToPanMaxDistance

---

projectionPlaneTilt

projectionPlaneTilt: number

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:158

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

Inherited from

ArcRotateCamera.projectionPlaneTilt

---

radius

radius: number

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:46

Defines the radius of the camera from its target point.

Inherited from

ArcRotateCamera.radius

---

renderPassId

renderPassId: number

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:259

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

Inherited from

ArcRotateCamera.renderPassId

---

reservedDataStore

reservedDataStore: any

Defined in: node_modules/@babylonjs/core/node.d.ts:71

For internal use only. Please do not use.

Inherited from

ArcRotateCamera.reservedDataStore

---

restoreStateInterpolationFactor

restoreStateInterpolationFactor: number

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:262

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

Inherited from

ArcRotateCamera.restoreStateInterpolationFactor

---

rigParent?

optional rigParent: Camera

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:255

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)

Inherited from

ArcRotateCamera.rigParent

---

rotation

rotation: Vector3

Defined in: node_modules/@babylonjs/core/Cameras/targetCamera.d.ts:34

Define the current rotation of the camera

Inherited from

ArcRotateCamera.rotation

---

rotationQuaternion

rotationQuaternion: Quaternion

Defined in: node_modules/@babylonjs/core/Cameras/targetCamera.d.ts:38

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

Inherited from

ArcRotateCamera.rotationQuaternion

---

speed

speed: number

Defined in: node_modules/@babylonjs/core/Cameras/targetCamera.d.ts:42

Define the current speed of the camera

Inherited from

ArcRotateCamera.speed

---

state

state: string

Defined in: node_modules/@babylonjs/core/node.d.ts:61

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

Inherited from

ArcRotateCamera.state

---

targetScreenOffset

targetScreenOffset: Vector2

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:249

Defines a screen offset for the camera position.

Inherited from

ArcRotateCamera.targetScreenOffset

---

uniqueId

uniqueId: number

Defined in: node_modules/@babylonjs/core/node.d.ts:57

Gets or sets the unique id of the node

Inherited from

ArcRotateCamera.uniqueId

---

updateUpVectorFromRotation

updateUpVectorFromRotation: boolean

Defined in: node_modules/@babylonjs/core/Cameras/targetCamera.d.ts:29

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

Inherited from

ArcRotateCamera.updateUpVectorFromRotation

---

upperAlphaLimit

upperAlphaLimit: number

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:114

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

Inherited from

ArcRotateCamera.upperAlphaLimit

---

upperBetaLimit

upperBetaLimit: number

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:124

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

Inherited from

ArcRotateCamera.upperBetaLimit

---

upperRadiusLimit

upperRadiusLimit: number

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:134

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.

Inherited from

ArcRotateCamera.upperRadiusLimit

---

useInputToRestoreState

useInputToRestoreState: boolean

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:258

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

Inherited from

ArcRotateCamera.useInputToRestoreState

---

viewport

viewport: Viewport

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:191

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.

Inherited from

ArcRotateCamera.viewport

---

zoomOnFactor

zoomOnFactor: number

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:245

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

Inherited from

ArcRotateCamera.zoomOnFactor

---

_AnimationRangeFactory()

static _AnimationRangeFactory: (_name, _from, _to) => AnimationRange

Defined in: node_modules/@babylonjs/core/node.d.ts:28

Internal

Parameters

_name

string

_from

number

_to

number

Returns

AnimationRange

Inherited from

ArcRotateCamera._AnimationRangeFactory

---

_CreateDefaultParsedCamera()

static _CreateDefaultParsedCamera: (name, scene) => Camera

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:36

Internal

Parameters

name

string

scene

Scene

Returns

Camera

Inherited from

ArcRotateCamera._CreateDefaultParsedCamera

---

ForceAttachControlToAlwaysPreventDefault

static ForceAttachControlToAlwaysPreventDefault: boolean

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:94

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

Inherited from

ArcRotateCamera.ForceAttachControlToAlwaysPreventDefault

---

FOVMODE_HORIZONTAL_FIXED

readonly static FOVMODE_HORIZONTAL_FIXED: 1 = 1

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:56

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

Inherited from

ArcRotateCamera.FOVMODE_HORIZONTAL_FIXED

---

FOVMODE_VERTICAL_FIXED

readonly static FOVMODE_VERTICAL_FIXED: 0 = 0

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:52

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.

Inherited from

ArcRotateCamera.FOVMODE_VERTICAL_FIXED

---

ORTHOGRAPHIC_CAMERA

readonly static ORTHOGRAPHIC_CAMERA: 1 = 1

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:47

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.

Inherited from

ArcRotateCamera.ORTHOGRAPHIC_CAMERA

---

PERSPECTIVE_CAMERA

readonly static PERSPECTIVE_CAMERA: 0 = 0

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:42

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.

Inherited from

ArcRotateCamera.PERSPECTIVE_CAMERA

---

RIG_MODE_CUSTOM

readonly static RIG_MODE_CUSTOM: 22 = 22

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:90

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

Inherited from

ArcRotateCamera.RIG_MODE_CUSTOM

---

RIG_MODE_NONE

readonly static RIG_MODE_NONE: 0 = 0

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:61

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

Inherited from

ArcRotateCamera.RIG_MODE_NONE

---

RIG_MODE_STEREOSCOPIC_ANAGLYPH

readonly static RIG_MODE_STEREOSCOPIC_ANAGLYPH: 10 = 10

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:66

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

Inherited from

ArcRotateCamera.RIG_MODE_STEREOSCOPIC_ANAGLYPH

---

RIG_MODE_STEREOSCOPIC_INTERLACED

readonly static RIG_MODE_STEREOSCOPIC_INTERLACED: 14 = 14

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:82

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

Inherited from

ArcRotateCamera.RIG_MODE_STEREOSCOPIC_INTERLACED

---

RIG_MODE_STEREOSCOPIC_OVERUNDER

readonly static RIG_MODE_STEREOSCOPIC_OVERUNDER: 13 = 13

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:78

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

Inherited from

ArcRotateCamera.RIG_MODE_STEREOSCOPIC_OVERUNDER

---

RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_CROSSEYED

readonly static RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_CROSSEYED: 12 = 12

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:74

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

Inherited from

ArcRotateCamera.RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_CROSSEYED

---

RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_PARALLEL

readonly static RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_PARALLEL: 11 = 11

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:70

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

Inherited from

ArcRotateCamera.RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_PARALLEL

---

RIG_MODE_VR

readonly static RIG_MODE_VR: 20 = 20

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:86

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

Inherited from

ArcRotateCamera.RIG_MODE_VR

Accessors

absoluteRotation

Get Signature

get absoluteRotation(): Quaternion

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:573

Returns the current camera absolute rotation

Returns

Quaternion

Inherited from

ArcRotateCamera.absoluteRotation

---

accessibilityTag

Get Signature

get accessibilityTag(): IAccessibilityTag

Defined in: node_modules/@babylonjs/core/node.d.ts:81

Returns

IAccessibilityTag

Set Signature

set accessibilityTag(value): void

Defined in: node_modules/@babylonjs/core/node.d.ts:80

Gets or sets the accessibility tag to describe the node for accessibility purpose.

Parameters

value

IAccessibilityTag

Returns

void

Inherited from

ArcRotateCamera.accessibilityTag

---

angularSensibilityX

Get Signature

get angularSensibilityX(): number

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:171

Gets or Set the pointer angular sensibility along the X axis or how fast is the camera rotating.

Returns

number

Set Signature

set angularSensibilityX(value): void

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:172

Parameters

value

number

Returns

void

Inherited from

ArcRotateCamera.angularSensibilityX

---

angularSensibilityY

Get Signature

get angularSensibilityY(): number

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:176

Gets or Set the pointer angular sensibility along the Y axis or how fast is the camera rotating.

Returns

number

Set Signature

set angularSensibilityY(value): void

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:177

Parameters

value

number

Returns

void

Inherited from

ArcRotateCamera.angularSensibilityY

---

animationPropertiesOverride

Get Signature

get animationPropertiesOverride(): AnimationPropertiesOverride

Defined in: node_modules/@babylonjs/core/node.d.ts:152

Gets or sets the animation properties override

Returns

AnimationPropertiesOverride

Set Signature

set animationPropertiesOverride(value): void

Defined in: node_modules/@babylonjs/core/node.d.ts:153

Parameters

value

AnimationPropertiesOverride

Returns

void

Inherited from

ArcRotateCamera.animationPropertiesOverride

---

autoRotationBehavior

Get Signature

get autoRotationBehavior(): AutoRotationBehavior

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:319

Gets the auto rotation behavior of the camera if it has been enabled.

See

https://doc.babylonjs.com/features/featuresDeepDive/behaviors/cameraBehaviors#autorotation-behavior

Returns

AutoRotationBehavior

Inherited from

ArcRotateCamera.autoRotationBehavior

---

behaviors

Get Signature

get behaviors(): Behavior<Node>[]

Defined in: node_modules/@babylonjs/core/node.d.ts:215

Gets the list of attached behaviors

See

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

Returns

Behavior<Node>[]

Inherited from

ArcRotateCamera.behaviors

---

bouncingBehavior

Get Signature

get bouncingBehavior(): BouncingBehavior

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:295

Gets the bouncing behavior of the camera if it has been enabled.

See

https://doc.babylonjs.com/features/featuresDeepDive/behaviors/cameraBehaviors#bouncing-behavior

Returns

BouncingBehavior

Inherited from

ArcRotateCamera.bouncingBehavior

---

doNotSerialize

Get Signature

get doNotSerialize(): boolean

Defined in: node_modules/@babylonjs/core/node.d.ts:90

Gets or sets a boolean used to define if the node must be serialized

Returns

boolean

Set Signature

set doNotSerialize(value): void

Defined in: node_modules/@babylonjs/core/node.d.ts:91

Parameters

value

boolean

Returns

void

Inherited from

ArcRotateCamera.doNotSerialize

---

framingBehavior

Get Signature

get framingBehavior(): FramingBehavior

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:307

Gets the framing behavior of the camera if it has been enabled.

See

https://doc.babylonjs.com/features/featuresDeepDive/behaviors/cameraBehaviors#framing-behavior

Returns

FramingBehavior

Inherited from

ArcRotateCamera.framingBehavior

---

globalPosition

Get Signature

get globalPosition(): Vector3

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:340

Gets the current world space position of the camera.

Returns

Vector3

Inherited from

ArcRotateCamera.globalPosition

---

hasMoved

Get Signature

get hasMoved(): boolean

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:264

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

---

isInterpolating

Get Signature

get isInterpolating(): boolean

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:290

If true, indicates the camera is currently interpolating to a new pose.

Returns

boolean

Inherited from

ArcRotateCamera.isInterpolating

---

isLeftCamera

Get Signature

get isLeftCamera(): boolean

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:504

Gets the left camera of a rig setup in case of Rigged Camera

Returns

boolean

Inherited from

ArcRotateCamera.isLeftCamera

---

isRightCamera

Get Signature

get isRightCamera(): boolean

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:510

Gets the right camera of a rig setup in case of Rigged Camera

Returns

boolean

Inherited from

ArcRotateCamera.isRightCamera

---

keysDown

Get Signature

get keysDown(): number[]

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:212

Gets or Set the list of keyboard keys used to control beta angle in a negative direction.

Returns

number[]

Set Signature

set keysDown(value): void

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:213

Parameters

value

number[]

Returns

void

Inherited from

ArcRotateCamera.keysDown

---

keysLeft

Get Signature

get keysLeft(): number[]

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:217

Gets or Set the list of keyboard keys used to control alpha angle in a negative direction.

Returns

number[]

Set Signature

set keysLeft(value): void

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:218

Parameters

value

number[]

Returns

void

Inherited from

ArcRotateCamera.keysLeft

---

keysRight

Get Signature

get keysRight(): number[]

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:222

Gets or Set the list of keyboard keys used to control alpha angle in a positive direction.

Returns

number[]

Set Signature

set keysRight(value): void

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:223

Parameters

value

number[]

Returns

void

Inherited from

ArcRotateCamera.keysRight

---

keysUp

Get Signature

get keysUp(): number[]

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:207

Gets or Set the list of keyboard keys used to control beta angle in a positive direction.

Returns

number[]

Set Signature

set keysUp(value): void

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:208

Parameters

value

number[]

Returns

void

Inherited from

ArcRotateCamera.keysUp

---

leftCamera

Get Signature

get leftCamera(): FreeCamera

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:514

Gets the left camera of a rig setup in case of Rigged Camera

Returns

FreeCamera

Inherited from

ArcRotateCamera.leftCamera

---

mode

Get Signature

get mode(): number

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:181

Returns

number

Set Signature

set mode(mode): void

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:180

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

Parameters

mode

number

Returns

void

Inherited from

ArcRotateCamera.mode

---

onClonedObservable

Get Signature

get onClonedObservable(): Observable<Node>

Defined in: node_modules/@babylonjs/core/node.d.ts:177

An event triggered when the node is cloned

Returns

Observable<Node>

Inherited from

ArcRotateCamera.onClonedObservable

---

onDispose

Set Signature

set onDispose(callback): void

Defined in: node_modules/@babylonjs/core/node.d.ts:169

Sets a callback that will be raised when the node will be disposed

Parameters

callback

() => void

Returns

void

Inherited from

ArcRotateCamera.onDispose

---

onEnabledStateChangedObservable

Get Signature

get onEnabledStateChangedObservable(): Observable<boolean>

Defined in: node_modules/@babylonjs/core/node.d.ts:173

An event triggered when the enabled state of the node changes

Returns

Observable<boolean>

Inherited from

ArcRotateCamera.onEnabledStateChangedObservable

---

orthoBottom

Get Signature

get orthoBottom(): number

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:141

Returns

number

Set Signature

set orthoBottom(value): void

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:140

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

Parameters

value

number

Returns

void

Inherited from

ArcRotateCamera.orthoBottom

---

orthoLeft

Get Signature

get orthoLeft(): number

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:127

Returns

number

Set Signature

set orthoLeft(value): void

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:126

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

Parameters

value

number

Returns

void

Inherited from

ArcRotateCamera.orthoLeft

---

orthoRight

Get Signature

get orthoRight(): number

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:134

Returns

number

Set Signature

set orthoRight(value): void

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:133

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

Parameters

value

number

Returns

void

Inherited from

ArcRotateCamera.orthoRight

---

orthoTop

Get Signature

get orthoTop(): number

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:148

Returns

number

Set Signature

set orthoTop(value): void

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:147

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

Parameters

value

number

Returns

void

Inherited from

ArcRotateCamera.orthoTop

---

panningSensibility

Get Signature

get panningSensibility(): number

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:202

Gets or Set the pointer panning sensibility or how fast is the camera moving.

Returns

number

Set Signature

set panningSensibility(value): void

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:203

Parameters

value

number

Returns

void

Inherited from

ArcRotateCamera.panningSensibility

---

parent

Get Signature

get parent(): Node

Defined in: node_modules/@babylonjs/core/node.d.ts:139

Returns

Node

Set Signature

set parent(parent): void

Defined in: node_modules/@babylonjs/core/node.d.ts:138

Gets or sets the parent of the node (without keeping the current position in the scene)

See

https://doc.babylonjs.com/features/featuresDeepDive/mesh/transforms/parent_pivot/parent

Parameters

parent

Node

Returns

void

Inherited from

ArcRotateCamera.parent

---

pinchDeltaPercentage

Get Signature

get pinchDeltaPercentage(): number

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:188

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

Set Signature

set pinchDeltaPercentage(value): void

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:189

Parameters

value

number

Returns

void

Inherited from

ArcRotateCamera.pinchDeltaPercentage

---

pinchPrecision

Get Signature

get pinchPrecision(): number

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:181

Gets or Set the pointer pinch precision or how fast is the camera zooming.

Returns

number

Set Signature

set pinchPrecision(value): void

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:182

Parameters

value

number

Returns

void

Inherited from

ArcRotateCamera.pinchPrecision

---

position

Get Signature

get position(): Vector3

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:75

Define the current local position of the camera in the scene

Returns

Vector3

Set Signature

set position(newPosition): void

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:76

Define the current local position of the camera in the scene

Parameters

newPosition

Vector3

Returns

void

Inherited from

ArcRotateCamera.position

---

rigCameras

Get Signature

get rigCameras(): Camera[]

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:398

Internal

Returns

Camera[]

Inherited from

ArcRotateCamera.rigCameras

---

rightCamera

Get Signature

get rightCamera(): FreeCamera

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:518

Gets the right camera of a rig setup in case of Rigged Camera

Returns

FreeCamera

Inherited from

ArcRotateCamera.rightCamera

---

rigPostProcess

Get Signature

get rigPostProcess(): PostProcess

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:402

Gets the post process used by the rig cameras

Returns

PostProcess

Inherited from

ArcRotateCamera.rigPostProcess

---

screenArea

Get Signature

get screenArea(): number

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:120

The screen area in scene units squared

Returns

number

Inherited from

ArcRotateCamera.screenArea

---

target

Get Signature

get target(): Vector3

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:58

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

Returns

Vector3

Set Signature

set target(value): void

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:59

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

---

targetHost

Get Signature

get targetHost(): TransformNode

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:65

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

TransformNode

Set Signature

set targetHost(value): void

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:66

Parameters

value

TransformNode

Returns

void

Inherited from

ArcRotateCamera.targetHost

---

upVector

Get Signature

get upVector(): Vector3

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:85

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

Returns

Vector3

Set Signature

set upVector(vec): void

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:84

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

---

useAutoRotationBehavior

Get Signature

get useAutoRotationBehavior(): boolean

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:324

Defines if the auto rotation behavior of the camera is enabled on the camera.

See

https://doc.babylonjs.com/features/featuresDeepDive/behaviors/cameraBehaviors#autorotation-behavior

Returns

boolean

Set Signature

set useAutoRotationBehavior(value): void

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:325

Parameters

value

boolean

Returns

void

Inherited from

ArcRotateCamera.useAutoRotationBehavior

---

useBouncingBehavior

Get Signature

get useBouncingBehavior(): boolean

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:300

Defines if the bouncing behavior of the camera is enabled on the camera.

See

https://doc.babylonjs.com/features/featuresDeepDive/behaviors/cameraBehaviors#bouncing-behavior

Returns

boolean

Set Signature

set useBouncingBehavior(value): void

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:301

Parameters

value

boolean

Returns

void

Inherited from

ArcRotateCamera.useBouncingBehavior

---

useFramingBehavior

Get Signature

get useFramingBehavior(): boolean

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:312

Defines if the framing behavior of the camera is enabled on the camera.

See

https://doc.babylonjs.com/features/featuresDeepDive/behaviors/cameraBehaviors#framing-behavior

Returns

boolean

Set Signature

set useFramingBehavior(value): void

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:313

Parameters

value

boolean

Returns

void

Inherited from

ArcRotateCamera.useFramingBehavior

---

useNaturalPinchZoom

Get Signature

get useNaturalPinchZoom(): boolean

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:197

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

Set Signature

set useNaturalPinchZoom(value): void

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:198

Parameters

value

boolean

Returns

void

Inherited from

ArcRotateCamera.useNaturalPinchZoom

---

wheelDeltaPercentage

Get Signature

get wheelDeltaPercentage(): number

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:240

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

Set Signature

set wheelDeltaPercentage(value): void

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:241

Parameters

value

number

Returns

void

Inherited from

ArcRotateCamera.wheelDeltaPercentage

---

wheelPrecision

Get Signature

get wheelPrecision(): number

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:227

Gets or Set the mouse wheel precision or how fast is the camera zooming.

Returns

number

Set Signature

set wheelPrecision(value): void

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:228

Parameters

value

number

Returns

void

Inherited from

ArcRotateCamera.wheelPrecision

---

worldMatrixFromCache

Get Signature

get worldMatrixFromCache(): Matrix

Defined in: node_modules/@babylonjs/core/node.d.ts:234

Returns directly the latest state of the mesh World matrix. A Matrix is returned.

Returns

Matrix

Inherited from

ArcRotateCamera.worldMatrixFromCache

---

zoomToMouseLocation

Get Signature

get zoomToMouseLocation(): boolean

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:233

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

Set Signature

set zoomToMouseLocation(value): void

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:234

Parameters

value

boolean

Returns

void

Inherited from

ArcRotateCamera.zoomToMouseLocation

Methods

_addToSceneRootNodes()

_addToSceneRootNodes(): void

Defined in: node_modules/@babylonjs/core/node.d.ts:145

Internal

Returns

void

Inherited from

ArcRotateCamera._addToSceneRootNodes

---

_calculateHandednessMultiplier()

_calculateHandednessMultiplier(): number

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:603

Internal

Returns

number

Inherited from

ArcRotateCamera._calculateHandednessMultiplier

---

_calculateLowerRadiusFromModelBoundingSphere()

_calculateLowerRadiusFromModelBoundingSphere(minimumWorld, maximumWorld, radiusScale?): number

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:504

Internal

Parameters

minimumWorld

Vector3

maximumWorld

Vector3

radiusScale?

number

Returns

number

Inherited from

ArcRotateCamera._calculateLowerRadiusFromModelBoundingSphere

---

_checkInputs()

_checkInputs(): void

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:447

Internal

Returns

void

Inherited from

ArcRotateCamera._checkInputs

---

_checkLimits()

protected _checkLimits(): void

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:448

Returns

void

Inherited from

ArcRotateCamera._checkLimits

---

_computeLocalCameraSpeed()

_computeLocalCameraSpeed(): number

Defined in: node_modules/@babylonjs/core/Cameras/targetCamera.d.ts:127

Internal

Returns

number

Inherited from

ArcRotateCamera._computeLocalCameraSpeed

---

_computeViewMatrix()

protected _computeViewMatrix(position, target, up): void

Defined in: node_modules/@babylonjs/core/Cameras/targetCamera.d.ts:160

Parameters

position

Vector3

target

Vector3

up

Vector3

Returns

void

Inherited from

ArcRotateCamera._computeViewMatrix

---

_decideIfNeedsToMove()

_decideIfNeedsToMove(): boolean

Defined in: node_modules/@babylonjs/core/Cameras/targetCamera.d.ts:145

Internal

Returns

boolean

Inherited from

ArcRotateCamera._decideIfNeedsToMove

---

_getActionManagerForTrigger()

_getActionManagerForTrigger(trigger?, _initialCall?): AbstractActionManager

Defined in: node_modules/@babylonjs/core/node.d.ts:244

Internal

Parameters

trigger?

number

_initialCall?

boolean

Returns

AbstractActionManager

Inherited from

ArcRotateCamera._getActionManagerForTrigger

---

_getDescendants()

_getDescendants(results, directDescendantsOnly?, predicate?): void

Defined in: node_modules/@babylonjs/core/node.d.ts:293

Internal

Parameters

results

Node[]

directDescendantsOnly?

boolean

predicate?

(node) => boolean

Returns

void

Inherited from

ArcRotateCamera._getDescendants

---

_getFirstPostProcess()

_getFirstPostProcess(): PostProcess

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:407

Internal, gets the first post process.

Returns

PostProcess

the first post process to be run on this camera.

Inherited from

ArcRotateCamera._getFirstPostProcess

---

_getLockedTargetPosition()

_getLockedTargetPosition(): Vector3

Defined in: node_modules/@babylonjs/core/Cameras/targetCamera.d.ts:103

Internal

Returns

Vector3

Inherited from

ArcRotateCamera._getLockedTargetPosition

---

_getTargetPosition()

protected _getTargetPosition(): Vector3

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:372

Returns

Vector3

Inherited from

ArcRotateCamera._getTargetPosition

---

_getViewMatrix()

_getViewMatrix(): Matrix

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:469

Internal

Returns

Matrix

Inherited from

ArcRotateCamera._getViewMatrix

---

_getVRProjectionMatrix()

_getVRProjectionMatrix(): Matrix

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:535

Internal

Returns

Matrix

Inherited from

ArcRotateCamera._getVRProjectionMatrix

---

_getWorldMatrixDeterminant()

_getWorldMatrixDeterminant(): number

Defined in: node_modules/@babylonjs/core/node.d.ts:229

Internal

Returns

number

Inherited from

ArcRotateCamera._getWorldMatrixDeterminant

---

_initCache()

_initCache(): void

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:367

Internal

Returns

void

Inherited from

ArcRotateCamera._initCache

---

_isSynchronized()

_isSynchronized(): boolean

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:365

Internal

Returns

boolean

Inherited from

ArcRotateCamera._isSynchronized

---

_isSynchronizedProjectionMatrix()

_isSynchronizedProjectionMatrix(): boolean

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:369

Internal

Returns

boolean

Inherited from

ArcRotateCamera._isSynchronizedProjectionMatrix

---

_isSynchronizedViewMatrix()

_isSynchronizedViewMatrix(): boolean

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:410

Internal

Returns

boolean

Inherited from

ArcRotateCamera._isSynchronizedViewMatrix

---

_markSyncedWithParent()

_markSyncedWithParent(): void

Defined in: node_modules/@babylonjs/core/node.d.ts:252

Internal

Returns

void

Inherited from

ArcRotateCamera._markSyncedWithParent

---

_removeFromSceneRootNodes()

_removeFromSceneRootNodes(): void

Defined in: node_modules/@babylonjs/core/node.d.ts:147

Internal

Returns

void

Inherited from

ArcRotateCamera._removeFromSceneRootNodes

---

_resizeOrCreateMultiviewTexture()

_resizeOrCreateMultiviewTexture(width, height): void

Defined in: node_modules/@babylonjs/core/Engines/Extensions/engine.multiview.d.ts:51

Internal

ensures the multiview texture of the camera exists and has the specified width/height

Parameters

width

number

height to set on the multiview texture

height

number

width to set on the multiview texture

Returns

void

Inherited from

ArcRotateCamera._resizeOrCreateMultiviewTexture

---

_restoreStateValues()

_restoreStateValues(): boolean

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:392

Internal

Restored camera state. You must call storeState() first

Returns

boolean

Inherited from

ArcRotateCamera._restoreStateValues

---

_serializeAsParent()

_serializeAsParent(serializationObject): void

Defined in: node_modules/@babylonjs/core/node.d.ts:143

Internal

Parameters

serializationObject

any

Returns

void

Inherited from

ArcRotateCamera._serializeAsParent

---

_setReady()

_setReady(state): void

Defined in: node_modules/@babylonjs/core/node.d.ts:339

Internal

Parameters

state

boolean

Returns

void

Inherited from

ArcRotateCamera._setReady

---

_setRigMode()

protected _setRigMode(rigParams): void

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:533

Parameters

rigParams

any

Returns

void

Inherited from

ArcRotateCamera._setRigMode

---

_setupInputs()

_setupInputs(): void

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:551

Internal

Returns

void

Inherited from

ArcRotateCamera._setupInputs

---

_syncParentEnabledState()

protected _syncParentEnabledState(): void

Defined in: node_modules/@babylonjs/core/node.d.ts:277

Internal

Returns

void

Inherited from

ArcRotateCamera._syncParentEnabledState

---

_updateCache()

_updateCache(ignoreParentClass?): void

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:371

Internal

Parameters

ignoreParentClass?

boolean

Returns

void

Inherited from

ArcRotateCamera._updateCache

---

_updateCameraRotationMatrix()

protected _updateCameraRotationMatrix(): void

Defined in: node_modules/@babylonjs/core/Cameras/targetCamera.d.ts:150

Returns

void

Inherited from

ArcRotateCamera._updateCameraRotationMatrix

---

_updateFrustumPlanes()

_updateFrustumPlanes(): void

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:460

Internal

Returns

void

Inherited from

ArcRotateCamera._updateFrustumPlanes

---

_updatePosition()

_updatePosition(): void

Defined in: node_modules/@babylonjs/core/Cameras/targetCamera.d.ts:147

Internal

Returns

void

Inherited from

ArcRotateCamera._updatePosition

---

_updateRigCameras()

_updateRigCameras(): void

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:500

Internal

Override Camera._updateRigCameras

Returns

void

Inherited from

ArcRotateCamera._updateRigCameras

---

addBehavior()

addBehavior(behavior, attachImmediately?): Node

Defined in: node_modules/@babylonjs/core/node.d.ts:203

Attach a behavior to the node

Parameters

behavior

Behavior<Node>

defines the behavior to attach

attachImmediately?

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

---

applyVerticalCorrection()

applyVerticalCorrection(): void

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:336

Automatically tilts the projection plane, using projectionPlaneTilt, to correct the perspective effect on vertical lines.

Returns

void

Inherited from

ArcRotateCamera.applyVerticalCorrection

---

attachControl()

Call Signature

attachControl(noPreventDefault?): void

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:415

Attach the input controls to a specific dom element to get the input from.

Parameters

noPreventDefault?

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

Call Signature

attachControl(ignored, noPreventDefault?): void

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:421

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.

noPreventDefault?

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

Call Signature

attachControl(noPreventDefault, useCtrlForPanning): void

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:427

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

Call Signature

attachControl(ignored, noPreventDefault, useCtrlForPanning): void

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:434

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

Call Signature

attachControl(noPreventDefault, useCtrlForPanning, panningMouseButton): void

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:441

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

---

attachPostProcess()

attachPostProcess(postProcess, insertAt?): number

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:416

Attach a post process to the camera.

Parameters

postProcess

PostProcess

The post process to attach to the camera

insertAt?

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

---

backView()

backView(): void

Defined in: packages/core/sdk/src/camera/PlumArcRotateCamera.ts:39

Returns

void

---

beginAnimation()

beginAnimation(name, loop?, speedRatio?, onAnimationEnd?): Animatable

Defined in: node_modules/@babylonjs/core/node.d.ts:386

Will start the animation sequence

Parameters

name

string

defines the range frames for animation sequence

loop?

boolean

defines if the animation should loop (false by default)

speedRatio?

number

defines the speed factor in which to run the animation (1 by default)

onAnimationEnd?

() => void

defines a function to be executed when the animation ended (undefined by default)

Returns

Animatable

the object created for this animation. If range does not exist, it will return null

Inherited from

ArcRotateCamera.beginAnimation

---

bottomView()

bottomView(): void

Defined in: packages/core/sdk/src/camera/PlumArcRotateCamera.ts:29

Returns

void

---

clone()

clone(name, newParent?): Camera

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:563

Clones the current camera.

Parameters

name

string

The cloned camera name

newParent?

Node

The cloned camera's new parent (none by default)

Returns

Camera

the cloned camera

Inherited from

ArcRotateCamera.clone

---

computeWorldMatrix()

computeWorldMatrix(): Matrix

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:594

Compute the world matrix of the camera.

Returns

Matrix

the camera world matrix

Inherited from

ArcRotateCamera.computeWorldMatrix

---

createAnimationRange()

createAnimationRange(name, from, to): void

Defined in: node_modules/@babylonjs/core/node.d.ts:352

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

---

createRigCamera()

createRigCamera(name, cameraIndex): Camera

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:494

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

---

deleteAnimationRange()

deleteAnimationRange(name, deleteFrames?): void

Defined in: node_modules/@babylonjs/core/node.d.ts:358

Delete a specific animation range

Parameters

name

string

defines the name of the range to delete

deleteFrames?

boolean

defines if animation frames from the range must be deleted as well

Returns

void

Inherited from

ArcRotateCamera.deleteAnimationRange

---

detachControl()

detachControl(): void

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:445

Detach the current controls from the specified dom element.

Returns

void

Inherited from

ArcRotateCamera.detachControl

---

detachPostProcess()

detachPostProcess(postProcess): void

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:422

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

---

dispose()

dispose(): void

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:508

Destroy the camera and release the current resources hold by it.

Returns

void

Inherited from

ArcRotateCamera.dispose

---

focusOn()

focusOn(meshesOrMinMaxVectorAndDistance, doNotUpdateMaxZ?): void

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:483

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

Defines the mesh or bounding info to focus on

AbstractMesh[] | { distance: number; max: Vector3; min: Vector3; }

doNotUpdateMaxZ?

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

---

freezeProjectionMatrix()

freezeProjectionMatrix(projection?): void

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:442

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

projection?

Matrix

Defines manually a projection if necessary

Returns

void

Inherited from

ArcRotateCamera.freezeProjectionMatrix

---

frontView()

frontView(): void

Defined in: packages/core/sdk/src/camera/PlumArcRotateCamera.ts:34

Returns

void

---

getActiveMeshes()

getActiveMeshes(): SmartArray<AbstractMesh>

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:345

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

---

getAnimationByName()

getAnimationByName(name): Animation

Defined in: node_modules/@babylonjs/core/node.d.ts:345

Get an animation by name

Parameters

name

string

defines the name of the animation to look for

Returns

Animation

null if not found else the requested animation

Inherited from

ArcRotateCamera.getAnimationByName

---

getAnimationRange()

getAnimationRange(name): AnimationRange

Defined in: node_modules/@babylonjs/core/node.d.ts:364

Get an animation range by name

Parameters

name

string

defines the name of the animation range to look for

Returns

AnimationRange

null if not found else the requested animation range

Inherited from

ArcRotateCamera.getAnimationRange

---

getAnimationRanges()

getAnimationRanges(): AnimationRange[]

Defined in: node_modules/@babylonjs/core/node.d.ts:377

Gets the list of all animation ranges defined on this node

Returns

AnimationRange[]

an array

Inherited from

ArcRotateCamera.getAnimationRanges

---

getBehaviorByName()

getBehaviorByName(name): Behavior<Node>

Defined in: node_modules/@babylonjs/core/node.d.ts:222

Gets an attached behavior by name

Parameters

name

string

defines the name of the behavior to look for

Returns

Behavior<Node>

null if behavior was not found else the requested behavior

See

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

Inherited from

ArcRotateCamera.getBehaviorByName

---

getChildMeshes()

Call Signature

getChildMeshes<T>(directDescendantsOnly?, predicate?): T[]

Defined in: node_modules/@babylonjs/core/node.d.ts:314

Get all child-meshes of this node

Type Parameters

T

T extends AbstractMesh

Parameters

directDescendantsOnly?

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)

predicate?

(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

Call Signature

getChildMeshes(directDescendantsOnly?, predicate?): AbstractMesh[]

Defined in: node_modules/@babylonjs/core/node.d.ts:321

Get all child-meshes of this node

Parameters

directDescendantsOnly?

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)

predicate?

(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

---

getChildren()

Call Signature

getChildren<T>(predicate?, directDescendantsOnly?): T[]

Defined in: node_modules/@babylonjs/core/node.d.ts:328

Get all direct children of this node

Type Parameters

T

T extends Node

Parameters

predicate?

(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

directDescendantsOnly?

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

Call Signature

getChildren(predicate?, directDescendantsOnly?): Node[]

Defined in: node_modules/@babylonjs/core/node.d.ts:335

Get all direct children of this node

Parameters

predicate?

(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

directDescendantsOnly?

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

---

getClassName()

getClassName(): string

Defined in: packages/core/sdk/src/camera/PlumArcRotateCamera.ts:20

Gets the current object class name.

Returns

string

the class name

Overrides

ArcRotateCamera.getClassName

---

getDescendants()

Call Signature

getDescendants<T>(directDescendantsOnly?, predicate?): T[]

Defined in: node_modules/@babylonjs/core/node.d.ts:300

Will return all nodes that have this node as ascendant

Type Parameters

T

T extends Node

Parameters

directDescendantsOnly?

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

predicate?

(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

Call Signature

getDescendants(directDescendantsOnly?, predicate?): Node[]

Defined in: node_modules/@babylonjs/core/node.d.ts:307

Will return all nodes that have this node as ascendant

Parameters

directDescendantsOnly?

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

predicate?

(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

---

getDirection()

getDirection(localAxis): Vector3

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:569

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

---

getDirectionToRef()

getDirectionToRef(localAxis, result): void

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:579

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

---

getEngine()

getEngine(): AbstractEngine

Defined in: node_modules/@babylonjs/core/node.d.ts:194

Gets the engine of the node

Returns

AbstractEngine

a Engine

Inherited from

ArcRotateCamera.getEngine

---

getForwardRay()

getForwardRay(length?, transform?, origin?): Ray

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:483

Gets a ray in the forward direction from the camera.

Parameters

length?

number

Defines the length of the ray to create

transform?

Matrix

Defines the transform to apply to the ray, by default the world matrix is used to create a workd space ray

origin?

Vector3

Defines the start point of the ray which defaults to the camera position

Returns

Ray

the forward ray

Inherited from

ArcRotateCamera.getForwardRay

---

getForwardRayToRef()

getForwardRayToRef(refRay, length?, transform?, origin?): Ray

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:492

Gets a ray in the forward direction from the camera.

Parameters

refRay

Ray

the ray to (re)use when setting the values

length?

number

Defines the length of the ray to create

transform?

Matrix

Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray

origin?

Vector3

Defines the start point of the ray which defaults to the camera position

Returns

Ray

the forward ray

Inherited from

ArcRotateCamera.getForwardRayToRef

---

getFrontPosition()

getFrontPosition(distance): Vector3

Defined in: node_modules/@babylonjs/core/Cameras/targetCamera.d.ts:101

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

---

getHierarchyBoundingVectors()

getHierarchyBoundingVectors(includeDescendants?, predicate?): object

Defined in: node_modules/@babylonjs/core/node.d.ts:417

Return the minimum and maximum world vectors of the entire hierarchy under current node

Parameters

includeDescendants?

boolean

Include bounding info from descendants as well (true by default)

predicate?

(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

object

the new bounding vectors

max

max: Vector3

min

min: Vector3

Inherited from

ArcRotateCamera.getHierarchyBoundingVectors

---

getLeftTarget()

getLeftTarget(): Vector3

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:523

Gets the left camera target of a rig setup in case of Rigged Camera

Returns

Vector3

the target position

Inherited from

ArcRotateCamera.getLeftTarget

---

getProjectionMatrix()

getProjectionMatrix(force?): Matrix

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:452

Gets the current projection matrix of the camera.

Parameters

force?

boolean

forces the camera to recompute the matrix without looking at the cached state

Returns

Matrix

the projection matrix

Inherited from

ArcRotateCamera.getProjectionMatrix

---

getRightTarget()

getRightTarget(): Vector3

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:528

Gets the right camera target of a rig setup in case of Rigged Camera

Returns

Vector3

the target position

Inherited from

ArcRotateCamera.getRightTarget

---

getScene()

getScene(): Scene

Defined in: node_modules/@babylonjs/core/node.d.ts:189

Gets the scene of the node

Returns

Scene

a scene

Inherited from

ArcRotateCamera.getScene

---

getTarget()

getTarget(): Vector3

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:71

Return the current target position of the camera. This value is expressed in local space.

Returns

Vector3

the target position

Inherited from

ArcRotateCamera.getTarget

---

getTransformationMatrix()

getTransformationMatrix(): Matrix

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:457

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

Returns

Matrix

a Matrix

Inherited from

ArcRotateCamera.getTransformationMatrix

---

getViewMatrix()

getViewMatrix(force?): Matrix

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:435

Gets the current view matrix of the camera.

Parameters

force?

boolean

forces the camera to recompute the matrix without looking at the cached state

Returns

Matrix

the view matrix

Inherited from

ArcRotateCamera.getViewMatrix

---

getWorldMatrix()

getWorldMatrix(): Matrix

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:427

Gets the current world matrix of the camera

Returns

Matrix

the world matrix

Inherited from

ArcRotateCamera.getWorldMatrix

---

hasStateStored()

hasStateStored(): boolean

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:309

Returns true if a state has been stored by calling storeState method.

Returns

boolean

true if state has been stored.

Inherited from

ArcRotateCamera.hasStateStored

---

interpolateTo()

interpolateTo(alpha?, beta?, radius?, target?, targetScreenOffset?, interpolationFactor?): void

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:408

Interpolates the camera to a goal state.

Parameters

alpha?

number

Defines the goal alpha.

beta?

number

Defines the goal beta.

radius?

number

Defines the goal radius.

target?

Vector3

Defines the goal target.

targetScreenOffset?

Vector2

Defines the goal target screen offset.

interpolationFactor?

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

---

isActiveMesh()

isActiveMesh(mesh): boolean

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:351

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

---

isCompletelyInFrustum()

isCompletelyInFrustum(target): boolean

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:475

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

---

isDescendantOf()

isDescendantOf(ancestor): boolean

Defined in: node_modules/@babylonjs/core/node.d.ts:289

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

---

isDisposed()

isDisposed(): boolean

Defined in: node_modules/@babylonjs/core/node.d.ts:133

Gets a boolean indicating if the node has been disposed

Returns

boolean

true if the node was disposed

Inherited from

ArcRotateCamera.isDisposed

---

isEnabled()

isEnabled(checkAncestors?): boolean

Defined in: node_modules/@babylonjs/core/node.d.ts:275

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

checkAncestors?

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

---

isInFrustum()

isInFrustum(target, checkRigCameras?): boolean

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:468

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

checkRigCameras?

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

---

isReady()

isReady(completeCheck?): boolean

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:357

Is this camera ready to be used/rendered

Parameters

completeCheck?

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

---

isSynchronized()

isSynchronized(): boolean

Defined in: node_modules/@babylonjs/core/node.d.ts:256

Internal

Returns

boolean

Inherited from

ArcRotateCamera.isSynchronized

---

isSynchronizedWithParent()

isSynchronizedWithParent(): boolean

Defined in: node_modules/@babylonjs/core/node.d.ts:254

Internal

Returns

boolean

Inherited from

ArcRotateCamera.isSynchronizedWithParent

---

leftSideView()

leftSideView(): void

Defined in: packages/core/sdk/src/camera/PlumArcRotateCamera.ts:49

Returns

void

---

markAsDirty()

markAsDirty(_property?): Node

Defined in: node_modules/@babylonjs/core/node.d.ts:268

Flag the node as dirty (Forcing it to update everything)

Parameters

_property?

string

helps children apply precise "dirtyfication"

Returns

Node

this node

Inherited from

ArcRotateCamera.markAsDirty

---

rebuildAnglesAndRadius()

rebuildAnglesAndRadius(): void

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:452

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

Returns

void

Inherited from

ArcRotateCamera.rebuildAnglesAndRadius

---

removeBehavior()

removeBehavior(behavior): Node

Defined in: node_modules/@babylonjs/core/node.d.ts:210

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

---

restoreState()

restoreState(): boolean

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:319

Restored camera state. You must call storeState() first.

Returns

boolean

true if restored and false otherwise

Inherited from

ArcRotateCamera.restoreState

---

rightSideView()

rightSideView(): void

Defined in: packages/core/sdk/src/camera/PlumArcRotateCamera.ts:44

Returns

void

---

serialize()

serialize(): any

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:556

Serialiaze the camera setup to a json representation

Returns

any

the JSON representation

Inherited from

ArcRotateCamera.serialize

---

serializeAnimationRanges()

serializeAnimationRanges(): any

Defined in: node_modules/@babylonjs/core/node.d.ts:391

Serialize animation ranges into a JSON compatible object

Returns

any

serialization object

Inherited from

ArcRotateCamera.serializeAnimationRanges

---

setCameraRigMode()

setCameraRigMode(mode, rigParams): void

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:532

Internal

Parameters

mode

number

rigParams

any

Returns

void

Inherited from

ArcRotateCamera.setCameraRigMode

---

setCameraRigParameter()

setCameraRigParameter(name, value): void

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:539

Internal

Parameters

name

string

value

any

Returns

void

Inherited from

ArcRotateCamera.setCameraRigParameter

---

setEnabled()

setEnabled(value): void

Defined in: node_modules/@babylonjs/core/node.d.ts:282

Set the enabled state of this node

Parameters

value

boolean

defines the new enabled state

Returns

void

Inherited from

ArcRotateCamera.setEnabled

---

setMatUp()

setMatUp(): void

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:89

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

---

setPosition()

setPosition(position): void

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:457

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

---

setTarget()

setTarget(target, toBoundingCenter?, allowSamePosition?, cloneAlphaBetaRadius?): void

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:467

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

Defines the new target as a Vector or a transform node

Vector3 | TransformNode

toBoundingCenter?

boolean

In case of a mesh target, defines whether to target the mesh position or its bounding information center

allowSamePosition?

boolean

If false, prevents reapplying the new computed position if it is identical to the current one (optim)

cloneAlphaBetaRadius?

boolean

If true, replicate the current setup (alpha, beta, radius) on the new target

Returns

void

Inherited from

ArcRotateCamera.setTarget

---

stopInterpolation()

stopInterpolation(): void

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:396

Stops any in-progress interpolation.

Returns

void

Inherited from

ArcRotateCamera.stopInterpolation

---

storeState()

storeState(): Camera

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:387

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

Returns

Camera

the camera itself

Inherited from

ArcRotateCamera.storeState

---

topView()

topView(): void

Defined in: packages/core/sdk/src/camera/PlumArcRotateCamera.ts:24

Returns

void

---

toString()

toString(fullDetails?): string

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:332

Gets a string representation of the camera useful for debug purpose.

Parameters

fullDetails?

boolean

Defines that a more verbose level of logging is required

Returns

string

the string representation

Inherited from

ArcRotateCamera.toString

---

unfreezeProjectionMatrix()

unfreezeProjectionMatrix(): void

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:446

Unfreeze the projection matrix if it has previously been freezed by freezeProjectionMatrix.

Returns

void

Inherited from

ArcRotateCamera.unfreezeProjectionMatrix

---

update()

update(): void

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:394

Update the camera state according to the different inputs gathered during the frame.

Returns

void

Inherited from

ArcRotateCamera.update

---

updateCache()

updateCache(force?): void

Defined in: node_modules/@babylonjs/core/node.d.ts:240

Internal

Parameters

force?

boolean

Returns

void

Inherited from

ArcRotateCamera.updateCache

---

zoomOn()

zoomOn(meshes?, doNotUpdateMaxZ?): void

Defined in: node_modules/@babylonjs/core/Cameras/arcRotateCamera.d.ts:476

Zooms on a mesh to be at the min distance where we could see it fully in the current viewport.

Parameters

meshes?

AbstractMesh[]

Defines the mesh to zoom on

doNotUpdateMaxZ?

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

---

AddNodeConstructor()

static AddNodeConstructor(type, constructorFunc): void

Defined in: node_modules/@babylonjs/core/node.d.ts:35

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

---

Construct()

static Construct(type, name, scene, options?): () => Node

Defined in: node_modules/@babylonjs/core/node.d.ts:44

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

options?

any

defines optional options to transmit to constructors

Returns

the new constructor or null

(): Node

Returns

Node

Inherited from

ArcRotateCamera.Construct

---

GetConstructorFromName()

static GetConstructorFromName(type, name, scene, interaxial_distance?, isStereoscopicSideBySide?): () => Camera

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:589

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

interaxial_distance?

number

In case of stereoscopic setup, the distance between both eyes

isStereoscopicSideBySide?

boolean

In case of stereoscopic setup, should the sereo be side b side

Returns

a factory method to construct the camera

(): Camera

Returns

Camera

Inherited from

ArcRotateCamera.GetConstructorFromName

---

Parse()

static Parse(parsedCamera, scene): Camera

Defined in: node_modules/@babylonjs/core/Cameras/camera.d.ts:601

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

---

ParseAnimationRanges()

static ParseAnimationRanges(node, parsedNode, _scene): void

Defined in: node_modules/@babylonjs/core/node.d.ts:410

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