Protected_Protected Readonly_Protected_Protected Readonly_Protected Readonly_Protected Readonly_Protected_Protected_Protected_Protected_Protected_Protected_Protected Readonly_Protected Readonly_Protected_Protected Readonly_Define the current direction the camera is moving to
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.
Define the current rotation the camera is rotating to
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)
Field Of View is set in Radians. (default is 0.8)
fovMode sets the camera frustum bounds to the viewport bounds. (default is FOVMODE_VERTICAL_FIXED)
Gets or sets the id of the node
Ignores camera maxZ when computing the projection matrix (ie. use 0 instead of maxZ), meaning objects won't be culled by the far plane
Define the input manager associated with the camera.
List of inspectable custom properties (used by the Inspector)
Defines the distance between both "eyes" in case of a RIG
Speed multiplier for inverse camera panning
Reverses mouselook direction to 'natural' panning as opposed to traditional direct panning
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
Is this camera a part of a rig system?
Defines if stereoscopic rendering is done side by side or over under.
Restricts the camera to viewing objects with the same layerMask. A camera with a layerMask of 1 will render mesh.layerMask & camera.layerMask!== 0
Define the current target of the camera as an object or a position. Please note that locking a target will disable panning.
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.
Gets or sets an object used to store user defined information for the node
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.
Framerate-independent movement controller shared by the TargetCamera family (FreeCamera/FlyCamera/FollowCamera). Provides inertial physics and the configurable input map. Subclasses may replace it with a specialized CameraMovement (for example ArcRotateCamera uses ArcRotateCameraMovement).
Gets or sets the name of the node
Add constraint to the camera to prevent it to move freely in all directions and around all axis.
Object containing oblique projection values (only used with ORTHOGRAPHIC_CAMERA)
Observable fired when an accessibility tag is changed
Observable triggered when the inputs have been processed.
An event triggered when the mesh is disposed
Observable triggered when the camera Projection matrix has changed.
Callback raised when the node is ready to be used
Observable triggered when reset has been called and applied to the camera.
Observable triggered when the camera view matrix has changed. Beware of reentrance! Some methods like Camera.getViewMatrix and Camera.getWorldMatrix can trigger the onViewMatrixChangedObservable observable, so using them inside an observer will require additional logic to avoid a stack overflow error.
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
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
Render pass id used by the camera to render into the main framebuffer
For internal use only. Please do not use.
OptionalrigIf 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)
Define the current rotation of the camera
Define the current rotation of the camera as a quaternion to prevent Gimbal lock
Define the current speed of the camera
Gets or sets a string used to store user defined state for the node
Gets or sets the unique id of the node
When set, the up vector of the camera will be updated by the rotation of the camera
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.
StaticForceDefines if by default attaching controls should prevent the default javascript event to continue.
Static ReadonlyFOVMODE_This setting aligns the left and right bounds of the viewport to the left and right bounds of the camera frustum.
Static ReadonlyFOVMODE_This is the default FOV mode for perspective cameras. This setting aligns the upper and lower bounds of the viewport to the upper and lower bounds of the camera frustum.
Static ReadonlyORTHOGRAPHIC_This helps creating camera with an orthographic mode. Orthographic is commonly used in engineering as a means to produce object specifications that communicate dimensions unambiguously, each line of 1 unit length (cm, meter..whatever) will appear to have the same length everywhere on the drawing. This allows the drafter to dimension only a subset of lines and let the reader know that other lines of that length on the drawing are also that length in reality. Every parallel line in the drawing is also parallel in the object.
Static ReadonlyPERSPECTIVE_This is the default projection mode used by the cameras. It helps recreating a feeling of perspective and better appreciate depth. This is the best way to simulate real life cameras.
Static ReadonlyRIG_Custom rig mode allowing rig cameras to be populated manually with any number of cameras
Static ReadonlyRIG_This specifies there is no need for a camera rig. Basically only one eye is rendered corresponding to the camera.
Static ReadonlyRIG_Simulates a camera Rig with one blue eye and one red eye. This can be use with 3d blue and red glasses.
Static ReadonlyRIG_Defines that both eyes of the camera will be rendered on successive lines interlaced for passive 3d monitors.
Static ReadonlyRIG_Defines that both eyes of the camera will be rendered over under each other.
Static ReadonlyRIG_Defines that both eyes of the camera will be rendered side by side with a none parallel target.
Static ReadonlyRIG_Defines that both eyes of the camera will be rendered side by side with a parallel target.
Static ReadonlyRIG_Defines that both eyes of the camera should be renderered in a VR mode (carbox).
Returns the current camera absolute rotation
Gets or sets the accessibility tag to describe the node for accessibility purpose.
Gets or sets the animation properties override
Gets the list of attached behaviors
Gets or sets a boolean used to define if the node must be serialized
Gets the current world space position of the camera.
Gets a flag indicating that the camera has moved in some way since the last call to Camera.update()
Defines the inertia (decay coefficient applied per reference frame at 60fps) of the camera. This helps giving a smooth feeling to the camera movement.
Override of Camera.inertia that writes through to the movement system so the framerate-independent pan/rotation glide stays in sync. Setting this updates the movement system immediately (matching the accessor convergence used by ArcRotateCamera).
Backed by a local field rather than super.inertia: the shipped UMD bundle is compiled with
TypeScript at target: ES5, and ES5 downleveling of super access inside a decorated accessor
(the base Camera.inertia carries @serialize()) mis-compiles to undefined. That would
feed NaN into the movement decay and freeze the camera. It only breaks in the ES5 UMD bundle;
native-ESM dev keeps real super. See the babylonjs/no-super-in-accessor lint rule.
Define the default inertia of the camera. This helps giving a smooth feeling to the camera movement.
Gets the left camera of a rig setup in case of Rigged Camera
Gets the right camera of a rig setup in case of Rigged Camera
Gets the left camera of a rig setup in case of Rigged Camera
Define the mode of the camera (Camera.PERSPECTIVE_CAMERA or Camera.ORTHOGRAPHIC_CAMERA)
An event triggered when the node is cloned
Sets a callback that will be raised when the node will be disposed
An event triggered when the effective enabled state of the node changes, i.e. whenever the value returned by isEnabled changes. Unlike onEnabledStateChangedObservable, this fires for changes caused by an ancestor's enabled state as well as this node's own state. The observable is created on first access, so no cost is incurred for nodes that never observe it.
An event triggered when the enabled state of the node changes. This only reflects changes to the node's own enabled flag (as set via setEnabled), not changes inherited from an ancestor. Use onEffectiveEnabledStateChangedObservable to also be notified when an ancestor's enabled state changes the effective enabled state.
Define the current limit on the bottom side for an orthographic camera In scene unit
Define the current limit on the left side for an orthographic camera In scene unit
Define the current limit on the right side for an orthographic camera In scene unit
Define the current limit on the top side for an orthographic camera In scene unit
Gets or sets the parent of the node (without keeping the current position in the scene)
Define the current local position of the camera in the scene
Gets the right camera of a rig setup in case of Rigged Camera
Gets the post process used by the rig cameras
The screen area in scene units squared
Defines the target point of the camera. The camera looks towards it form the radius distance.
The vector the camera should consider as up. (default is Vector3(0, 1, 0) aka Vector3.Up())
Returns directly the latest state of the mesh World matrix. A Matrix is returned.
Protected_Internal, gets the first post process.
the first post process to be run on this camera.
Protected_Protected_Attach a behavior to the node
defines the behavior to attach
OptionalattachImmediately: boolean
defines that the behavior must be attached even if the scene is still loading
the current Node
Automatically tilts the projection plane, using projectionPlaneTilt, to correct the perspective effect on vertical lines.
Attach the input controls to a specific dom element to get the input from.
OptionalnoPreventDefault: boolean
Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
Attach the input controls to a specific dom element to get the input from.
defines an ignored parameter kept for backward compatibility.
OptionalnoPreventDefault: boolean
Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault) BACK COMPAT SIGNATURE ONLY.
Attach a post process to the camera.
The post process to attach to the camera
OptionalinsertAt: Nullable<number>
The position of the post process in case several of them are in use in the scene
the position the post process has been inserted at
Will start the animation sequence
defines the range frames for animation sequence
Optionalloop: boolean
defines if the animation should loop (false by default)
OptionalspeedRatio: number
defines the speed factor in which to run the animation (1 by default)
OptionalonAnimationEnd: () => void
defines a function to be executed when the animation ended (undefined by default)
the object created for this animation. If range does not exist, it will return null
Clones the current camera.
The cloned camera name
OptionalnewParent: Nullable<Node>
The cloned camera's new parent (none by default)
the cloned camera
Compute the world matrix of the camera.
the camera world matrix
Creates an animation range for this node
defines the name of the range
defines the starting key
defines the end key
Delete a specific animation range
defines the name of the range to delete
OptionaldeleteFrames: boolean
defines if animation frames from the range must be deleted as well
Detach the current controls from the specified dom element.
Detach the current controls from the specified dom element.
Optionalignored: any
defines an ignored parameter kept for backward compatibility.
Detach a post process to the camera.
The post process to detach from the camera
Releases resources associated with this node.
OptionaldoNotRecurse: boolean
Set to true to not recurse into each children (recurse into each children by default)
OptionaldisposeMaterialAndTextures: boolean
Set to true to also dispose referenced materials and textures (false by default)
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
Optionalprojection: Matrix
Defines manually a projection if necessary
Gets the list of active meshes this frame (meshes no culled or excluded by lod s in the frame)
the active meshe list
Get an animation by name
defines the name of the animation to look for
null if not found else the requested animation
Get an animation range by name
defines the name of the animation range to look for
null if not found else the requested animation range
Gets the list of all animation ranges defined on this node
an array
Gets an attached behavior by name
defines the name of the behavior to look for
null if behavior was not found else the requested behavior
Get all child-meshes of this node
OptionaldirectDescendantsOnly: boolean
defines if true only direct descendants of 'this' will be considered, if false direct and also indirect (children of children, an so on in a recursive manner) descendants of 'this' will be considered (Default: false)
Optionalpredicate: (node: Node) => node is T
defines an optional predicate that will be called on every evaluated child, the predicate must return true for a given child to be part of the result, otherwise it will be ignored
an array of AbstractMesh
Get all child-meshes of this node
OptionaldirectDescendantsOnly: boolean
defines if true only direct descendants of 'this' will be considered, if false direct and also indirect (children of children, an so on in a recursive manner) descendants of 'this' will be considered (Default: false)
Optionalpredicate: (node: Node) => boolean
defines an optional predicate that will be called on every evaluated child, the predicate must return true for a given child to be part of the result, otherwise it will be ignored
an array of AbstractMesh
Get all direct children of this node
Optionalpredicate: (node: Node) => node is T
defines an optional predicate that will be called on every evaluated child, the predicate must return true for a given child to be part of the result, otherwise it will be ignored
OptionaldirectDescendantsOnly: boolean
defines if true only direct descendants of 'this' will be considered, if false direct and also indirect (children of children, an so on in a recursive manner) descendants of 'this' will be considered (Default: true)
an array of Node
Get all direct children of this node
Optionalpredicate: (node: Node) => boolean
defines an optional predicate that will be called on every evaluated child, the predicate must return true for a given child to be part of the result, otherwise it will be ignored
OptionaldirectDescendantsOnly: boolean
defines if true only direct descendants of 'this' will be considered, if false direct and also indirect (children of children, an so on in a recursive manner) descendants of 'this' will be considered (Default: true)
an array of Node
Gets the current object class name.
the class name
Will return all nodes that have this node as ascendant
OptionaldirectDescendantsOnly: boolean
defines if true only direct descendants of 'this' will be considered, if false direct and also indirect (children of children, an so on in a recursive manner) descendants of 'this' will be considered
Optionalpredicate: (node: Node) => node is T
defines an optional predicate that will be called on every evaluated child, the predicate must return true for a given child to be part of the result, otherwise it will be ignored
all children nodes of all types
Will return all nodes that have this node as ascendant
OptionaldirectDescendantsOnly: boolean
defines if true only direct descendants of 'this' will be considered, if false direct and also indirect (children of children, an so on in a recursive manner) descendants of 'this' will be considered
Optionalpredicate: (node: Node) => boolean
defines an optional predicate that will be called on every evaluated child, the predicate must return true for a given child to be part of the result, otherwise it will be ignored
all children nodes of all types
Gets the direction of the camera relative to a given local axis.
Defines the reference axis to provide a relative direction.
the direction
Gets the direction of the camera relative to a given local axis into a passed vector.
Defines the reference axis to provide a relative direction.
Defines the vector to store the result in
Gets the engine of the node
a Engine
Gets a ray in the forward direction from the camera.
Optionallength: number
Defines the length of the ray to create
Optionaltransform: Matrix
Defines the transform to apply to the ray, by default the world matrix is used to create a world space ray
Optionalorigin: Vector3
Defines the start point of the ray which defaults to the camera position
the forward ray
Gets a ray in the forward direction from the camera.
the ray to (re)use when setting the values
Optionallength: number
Defines the length of the ray to create
Optionaltransform: Matrix
Defines the transform to apply to the ray, by default the world matrix is used to create a world space ray
Optionalorigin: Vector3
Defines the start point of the ray which defaults to the camera position
the forward ray
Gets the position in front of the camera at a given distance.
The distance from the camera we want the position to be
the position
Return the minimum and maximum world vectors of the entire hierarchy under current node
OptionalincludeDescendants: boolean
Include bounding info from descendants as well (true by default)
Optionalpredicate: Nullable<(abstractMesh: AbstractMesh) => boolean>
defines a callback function that can be customize to filter what meshes should be included in the list used to compute the bounding vectors
the new bounding vectors
Gets the left camera target of a rig setup in case of Rigged Camera
the target position
Gets the current projection matrix of the camera.
OptionalpForce: booleanthe projection matrix
Gets the right camera target of a rig setup in case of Rigged Camera
the target position
Gets the scene of the node
a scene
Return the current target position of the camera. This value is expressed in local space.
the target position
Gets the transformation matrix (ie. the multiplication of view by projection matrices)
a Matrix
Gets the current view matrix of the camera.
Optionalforce: boolean
forces the camera to recompute the matrix without looking at the cached state
the view matrix
Gets the current world matrix of the camera
the world matrix
Returns true if a state has been stored by calling storeState method.
true if state has been stored.
Check whether a mesh is part of the current active mesh list of the camera
Defines the mesh to check
true if active, false otherwise
Checks if a cullable object (mesh...) is in the camera frustum Unlike isInFrustum this checks the full bounding box
The object to check
true if the object is in frustum otherwise false
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
defines the parent node to inspect
a boolean indicating if this node is a descendant of the given node
Gets a boolean indicating if the node has been disposed
true if the node was disposed
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
OptionalcheckAncestors: boolean
indicates if this method should check the ancestors. The default is to check the ancestors. If set to false, the method will return the value of this node without checking ancestors
whether this node (and its parent) is enabled
To observe changes to the value returned when calling this with checkAncestors set to true (the default, i.e. the effective enabled state), subscribe to onEffectiveEnabledStateChangedObservable.
To observe changes to the value returned when calling this with checkAncestors set to false (i.e. this node's own enabled state only), subscribe to onEnabledStateChangedObservable.
Checks if a cullable object (mesh...) is in the camera frustum This checks the bounding box center. See isCompletelyInFrustum for a full bounding check
The object to check
OptionalcheckRigCameras: boolean
If the rig cameras should be checked (eg. with VR camera both eyes should be checked) (Default: false)
true if the object is in frustum otherwise false
Is this camera ready to be used/rendered
OptionalcompleteCheck: boolean
defines if a complete check (including post processes) has to be done (false by default)
true if the camera is ready
Flag the node as dirty (Forcing it to update everything)
Optional_property: string
helps children apply precise "dirtyfication"
this node
Remove an attached behavior
defines the behavior to attach
the current Node
Restored camera state. You must call storeState() first.
true if restored and false otherwise
Serialiaze the camera setup to a json representation
the JSON representation
Serialize animation ranges into a JSON compatible object
serialization object
Set the enabled state of this node
defines the new enabled state
Sets the camera's field of view in radians based on the focal length and sensor size.
the focal length of the camera in mm.
OptionalsensorSize: number
the sensor width size of the camera in mm. (default is 36mm, which is a full frame sensor)
Defines the target the camera should look at.
Store current camera state of the camera (fov, position, rotation, etc..)
the camera
Gets a string representation of the camera useful for debug purpose.
OptionalfullDetails: boolean
Defines that a more verbose level of logging is required
the string representation
Unfreeze the projection matrix if it has previously been freezed by freezeProjectionMatrix.
Update the camera state according to the different inputs gathered during the frame.
StaticAddAdd a new node constructor
defines the type name of the node to construct
defines the constructor function
StaticConstructReturns a node constructor based on type name
defines the type name
defines the new node name
defines the hosting scene
Optionaloptions: any
defines optional options to transmit to constructors
the new constructor or null
StaticGetGets a camera constructor for a given camera type
The type of the camera to construct (should be equal to one of the camera class name)
The name of the camera the result will be able to instantiate
The scene the result will construct the camera in
Optionalinteraxial_distance: number
In case of stereoscopic setup, the distance between both eyes
OptionalisStereoscopicSideBySide: boolean
In case of stereoscopic setup, should the sereo be side b side
a factory method to construct the camera
StaticParseParse animation range data from a serialization object and store them into a given node
defines where to store the animation ranges
defines the serialization object to read data from
defines the hosting scene
Gets a list of Animations associated with the node