Class StereoscopicArcRotateCamera
Hierarchy
- ArcRotateCamera
- StereoscopicArcRotateCamera
Index
Constructors
Properties
- allow
Upside Down - alpha
- animations
- beta
- camera
Direction - camera
Rig Mode - camera
Rotation - check
Collisions - collision
Radius - custom
Render Targets - fov
- fov
Mode - id
- ignore
Parent Scaling - inertia
- inertial
Alpha Offset - inertial
Beta Offset - inertial
PanningX - inertial
PanningY - inertial
Radius Offset - inputs
- inspectable
Custom Properties - interaxial
Distance - inverse
Rotation Speed - invert
Rotation - is
Intermediate - is
Rig Camera - is
Stereoscopic Side By Side - layer
Mask - locked
Target - lower
Alpha Limit - lower
Beta Limit - lower
Radius Limit - map
Panning - maxZ
- metadata
- minZ
- name
- no
Rotation Constraint - oblique
- on
Accessibility Tag Changed Observable - on
After Check Inputs Observable - on
Collide - on
Dispose Observable - on
Mesh Target Changed Observable - on
Projection Matrix Changed Observable - on
Ready - on
Restore State Observable - on
View Matrix Changed Observable - output
Render Target - override
Clone Alpha Beta Radius - panning
Axis - panning
Distance Limit - panning
Inertia - panning
Origin Target - pinch
To Pan Max Distance - projection
Plane Tilt - radius
- render
Pass Id - reserved
Data Store - rig
Parent - rotation
- rotation
Quaternion - speed
- state
- target
Screen Offset - unique
Id - update
Up Vector From Rotation - upper
Alpha Limit - upper
Beta Limit - upper
Radius Limit - use
Input To Restore State - viewport
- zoom
On Factor - FOVMODE_
HORIZONTAL_ FIXED - FOVMODE_
VERTICAL_ FIXED - Force
Attach Control To Always Prevent Default - ORTHOGRAPHIC_
CAMERA - PERSPECTIVE_
CAMERA - RIG_
MODE_ CUSTOM - RIG_
MODE_ NONE - RIG_
MODE_ STEREOSCOPIC_ ANAGLYPH - RIG_
MODE_ STEREOSCOPIC_ INTERLACED - RIG_
MODE_ STEREOSCOPIC_ OVERUNDER - RIG_
MODE_ STEREOSCOPIC_ SIDEBYSIDE_ CROSSEYED - RIG_
MODE_ STEREOSCOPIC_ SIDEBYSIDE_ PARALLEL - RIG_
MODE_ VR
Accessors
- absolute
Rotation - accessibility
Tag - angular
SensibilityX - angular
SensibilityY - animation
Properties Override - auto
Rotation Behavior - behaviors
- bouncing
Behavior - do
Not Serialize - framing
Behavior - global
Position - is
Left Camera - is
Right Camera - keys
Down - keys
Left - keys
Right - keys
Up - left
Camera - mode
- on
Cloned Observable - on
Dispose - on
Enabled State Changed Observable - ortho
Bottom - ortho
Left - ortho
Right - ortho
Top - panning
Sensibility - parent
- pinch
Delta Percentage - pinch
Precision - position
- rig
Post Process - right
Camera - screen
Area - target
- target
Host - up
Vector - use
Auto Rotation Behavior - use
Bouncing Behavior - use
Framing Behavior - use
Natural Pinch Zoom - wheel
Delta Percentage - wheel
Precision - world
Matrix From Cache - zoom
To Mouse Location
Methods
- _get
First Post Process - add
Behavior - apply
Vertical Correction - attach
Control - attach
Post Process - begin
Animation - clone
- compute
World Matrix - create
Animation Range - create
Rig Camera - delete
Animation Range - detach
Control - detach
Post Process - dispose
- focus
On - freeze
Projection Matrix - get
Active Meshes - get
Animation By Name - get
Animation Range - get
Animation Ranges - get
Behavior By Name - get
Child Meshes - get
Children - get
Class Name - get
Descendants - get
Direction - get
Direction To Ref - get
Engine - get
Forward Ray - get
Forward Ray To Ref - get
Front Position - get
Hierarchy Bounding Vectors - get
Left Target - get
Projection Matrix - get
Right Target - get
Scene - get
Target - get
Transformation Matrix - get
View Matrix - get
World Matrix - is
Active Mesh - is
Completely In Frustum - is
Descendant Of - is
Disposed - is
Enabled - is
In Frustum - is
Ready - mark
As Dirty - rebuild
Angles And Radius - remove
Behavior - restore
State - serialize
- serialize
Animation Ranges - set
Enabled - set
Mat Up - set
Position - set
Target - store
State - to
String - unfreeze
Projection Matrix - update
- zoom
On - Add
Node Constructor - Construct
- Get
Constructor From Name - Parse
- Parse
Animation Ranges
Constructors
constructor
Creates a new StereoscopicArcRotateCamera
Parameters
name: string
defines camera name
alpha: number
defines alpha angle (in radians)
beta: number
defines beta angle (in radians)
radius: number
defines radius
target: Vector3
defines camera target
interaxialDistance: number
defines distance between each color axis
isStereoscopicSideBySide: boolean
defines is stereoscopic is done side by side or over under
Optional scene: Scene
defines the hosting scene
Returns StereoscopicArcRotateCamera
Properties
allow
Allows the camera to be completely reversed. If false the camera can not arrive upside down.
alphaSearch playground for alpha
Defines the rotation angle of the camera along the longitudinal axis.
animationsSearch playground for animations
Gets a list of Animations associated with the node
betaSearch playground for beta
Defines the rotation angle of the camera along the latitudinal axis.
camera
Define the current direction the camera is moving to
camera
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.
camera
Define the current rotation the camera is rotating to
check
Defines whether the camera should check collision with the objects oh the scene.
collision
Defines the collision radius of the camera. This simulates a sphere around the camera.
custom
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)
fovSearch playground for fov
Field Of View is set in Radians. (default is 0.8)
fov
fovMode sets the camera frustum bounds to the viewport bounds. (default is FOVMODE_VERTICAL_FIXED)
idSearch playground for id
Gets or sets the id of the node
ignore
Gets or sets a boolean indicating that the scaling of the parent hierarchy will not be taken in account by the camera
inertiaSearch playground for inertia
Define the default inertia of the camera. This helps giving a smooth feeling to the camera movement.
inertial
Current inertia value on the longitudinal axis. The bigger this number the longer it will take for the camera to stop.
inertial
Current inertia value on the latitudinal axis. The bigger this number the longer it will take for the camera to stop.
inertial
Defines the current inertia value used during panning of the camera along the X axis.
inertial
Defines the current inertia value used during panning of the camera along the Y axis.
inertial
Current inertia value on the radius axis. The bigger this number the longer it will take for the camera to stop.
inputsSearch playground for inputs
Defines the input associated to the camera.
inspectable
List of inspectable custom properties (used by the Inspector)
interaxial
Defines the distance between both "eyes" in case of a RIG
inverse
Speed multiplier for inverse camera panning
invert
Reverses mouselook direction to 'natural' panning as opposed to traditional direct panning
is
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
Is this camera a part of a rig system?
is
Defines if stereoscopic rendering is done side by side or over under.
layer
Restricts the camera to viewing objects with the same layerMask. A camera with a layerMask of 1 will render mesh.layerMask & camera.layerMask!== 0
locked
Define the current target of the camera as an object or a position. Please note that locking a target will disable panning.
lower
Minimum allowed angle on the longitudinal axis. This can help limiting how the Camera is able to move in the scene.
lower
Minimum allowed angle on the latitudinal axis. This can help limiting how the Camera is able to move in the scene.
lower
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.
map
Defines if camera will eliminate transform on y axis.
maxZSearch playground for maxZ
Define the maximum distance the camera can see to. This is important to note that the depth buffer are not infinite and the further it end the more your scene might encounter depth fighting issue.
metadataSearch playground for metadata
Gets or sets an object used to store user defined information for the node
minZSearch playground for minZ
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.
nameSearch playground for name
Gets or sets the name of the node
no
Add constraint to the camera to prevent it to move freely in all directions and around all axis.
obliqueSearch playground for oblique
Object containing oblique projection values (only used with ORTHOGRAPHIC_CAMERA)
on
on
Observable triggered when the inputs have been processed.
on
Type declaration
Event raised when the camera is colliding with a mesh.
Parameters
collidedMesh: AbstractMesh
Returns void
on
An event triggered when the mesh is disposed
on
Observable triggered when the mesh target has been changed on the camera.
on
Observable triggered when the camera Projection matrix has changed.
on
Callback raised when the node is ready to be used
on
Observable triggered when reset has been called and applied to the camera.
on
Observable triggered when the camera view matrix has changed.
output
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
override
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).
panning
Defines the allowed panning axis.
panning
Defines the maximum distance the camera can pan. This could help keeping the camera always in your scene.
panning
Defines the value of the inertia used during panning. 0 would mean stop inertia and one would mean no deceleration at all.
panning
Defines the target of the camera before panning.
pinch
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.
projection
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
radiusSearch playground for radius
Defines the radius of the camera from it s target point.
render
Render pass id used by the camera to render into the main framebuffer
reserved
For internal use only. Please do not use.
Optional rig
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)
rotationSearch playground for rotation
Define the current rotation of the camera
rotation
Define the current rotation of the camera as a quaternion to prevent Gimbal lock
speedSearch playground for speed
Define the current speed of the camera
stateSearch playground for state
Gets or sets a string used to store user defined state for the node
target
Defines a screen offset for the camera position.
unique
Gets or sets the unique id of the node
update
When set, the up vector of the camera will be updated by the rotation of the camera
upper
Maximum allowed angle on the longitudinal axis. This can help limiting how the Camera is able to move in the scene.
upper
Maximum allowed angle on the latitudinal axis. This can help limiting how the Camera is able to move in the scene.
upper
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.
use
Define if double tap/click is used to restore the previously saved state of the camera.
viewportSearch playground for viewport
Define the viewport of the camera. This correspond to the portion of the screen the camera will render to in normalized 0 to 1 unit.
zoom
Defines how much the radius should be scaled while zooming on a particular mesh (through the zoomOn function)
Static Readonly FOVMODE_
This setting aligns the left and right bounds of the viewport to the left and right bounds of the camera frustum.
Static Readonly FOVMODE_
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 Force
Defines if by default attaching controls should prevent the default javascript event to continue.
Static Readonly ORTHOGRAPHIC_
This helps creating camera with an orthographic mode. Orthographic is commonly used in engineering as a means to produce object specifications that communicate dimensions unambiguously, each line of 1 unit length (cm, meter..whatever) will appear to have the same length everywhere on the drawing. This allows the drafter to dimension only a subset of lines and let the reader know that other lines of that length on the drawing are also that length in reality. Every parallel line in the drawing is also parallel in the object.
Static Readonly PERSPECTIVE_
This is the default projection mode used by the cameras. It helps recreating a feeling of perspective and better appreciate depth. This is the best way to simulate real life cameras.
Static Readonly RIG_
Custom rig mode allowing rig cameras to be populated manually with any number of cameras
Static Readonly RIG_
This specifies there is no need for a camera rig. Basically only one eye is rendered corresponding to the camera.
Static Readonly RIG_
Simulates a camera Rig with one blue eye and one red eye. This can be use with 3d blue and red glasses.
Static Readonly RIG_
Defines that both eyes of the camera will be rendered on successive lines interlaced for passive 3d monitors.
Static Readonly RIG_
Defines that both eyes of the camera will be rendered over under each other.
Static Readonly RIG_
Defines that both eyes of the camera will be rendered side by side with a none parallel target.
Static Readonly RIG_
Defines that both eyes of the camera will be rendered side by side with a parallel target.
Static Readonly RIG_
Defines that both eyes of the camera should be renderered in a VR mode (carbox).
Accessors
absolute
Returns the current camera absolute rotation
Returns Quaternion
accessibility
Gets or sets the accessibility tag to describe the node for accessibility purpose.
Returns Nullable<IAccessibilityTag>
Gets or sets the accessibility tag to describe the node for accessibility purpose.
Parameters
value: Nullable<IAccessibilityTag>
Returns void
angular
Gets or Set the pointer angular sensibility along the X axis or how fast is the camera rotating.
Returns number
Gets or Set the pointer angular sensibility along the X axis or how fast is the camera rotating.
Parameters
value: number
Returns void
angular
Gets or Set the pointer angular sensibility along the Y axis or how fast is the camera rotating.
Returns number
Gets or Set the pointer angular sensibility along the Y axis or how fast is the camera rotating.
Parameters
value: number
Returns void
animation
Gets or sets the animation properties override
Returns Nullable<AnimationPropertiesOverride>
Gets or sets the animation properties override
Parameters
value: Nullable<AnimationPropertiesOverride>
Returns void
auto
Gets the auto rotation behavior of the camera if it has been enabled.
Returns Nullable<AutoRotationBehavior>
behaviors
bouncing
Gets the bouncing behavior of the camera if it has been enabled.
Returns Nullable<BouncingBehavior>
do
Gets or sets a boolean used to define if the node must be serialized
Returns boolean
Gets or sets a boolean used to define if the node must be serialized
Parameters
value: boolean
Returns void
framing
Gets the framing behavior of the camera if it has been enabled.
Returns Nullable<FramingBehavior>
global
Gets the current world space position of the camera.
Returns Vector3
is
Gets the left camera of a rig setup in case of Rigged Camera
Returns boolean
is
Gets the right camera of a rig setup in case of Rigged Camera
Returns boolean
keys
Gets or Set the list of keyboard keys used to control beta angle in a negative direction.
Returns number[]
Gets or Set the list of keyboard keys used to control beta angle in a negative direction.
Parameters
value: number[]
Returns void
keys
Gets or Set the list of keyboard keys used to control alpha angle in a negative direction.
Returns number[]
Gets or Set the list of keyboard keys used to control alpha angle in a negative direction.
Parameters
value: number[]
Returns void
keys
Gets or Set the list of keyboard keys used to control alpha angle in a positive direction.
Returns number[]
Gets or Set the list of keyboard keys used to control alpha angle in a positive direction.
Parameters
value: number[]
Returns void
keys
Gets or Set the list of keyboard keys used to control beta angle in a positive direction.
Returns number[]
Gets or Set the list of keyboard keys used to control beta angle in a positive direction.
Parameters
value: number[]
Returns void
left
Gets the left camera of a rig setup in case of Rigged Camera
Returns Nullable<FreeCamera>
mode
Returns number
Parameters
mode: number
Returns void
on
An event triggered when the node is cloned
Returns Observable<Node>
on
Sets a callback that will be raised when the node will be disposed
Parameters
callback: (() => void)
Returns void
Returns void
on
An event triggered when the enabled state of the node changes
Returns Observable<boolean>
ortho
ortho
ortho
ortho
panning
Gets or Set the pointer panning sensibility or how fast is the camera moving.
Returns number
Gets or Set the pointer panning sensibility or how fast is the camera moving.
Parameters
value: number
Returns void
parent
pinch
Gets or Set the pointer pinch delta percentage or how fast is the camera zooming. It will be used instead of pinchDeltaPrecision if different from 0. It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
Returns number
Gets or Set the pointer pinch delta percentage or how fast is the camera zooming. It will be used instead of pinchDeltaPrecision if different from 0. It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
Parameters
value: number
Returns void
pinch
Gets or Set the pointer pinch precision or how fast is the camera zooming.
Returns number
Gets or Set the pointer pinch precision or how fast is the camera zooming.
Parameters
value: number
Returns void
position
rig
Gets the post process used by the rig cameras
Returns Nullable<PostProcess>
right
Gets the right camera of a rig setup in case of Rigged Camera
Returns Nullable<FreeCamera>
screen
The screen area in scene units squared
Returns number
target
target
Defines the target mesh of the camera. The camera looks towards it from the radius distance. Please note that setting a target host will disable panning.
Returns Nullable<AbstractMesh>
Defines the target mesh of the camera. The camera looks towards it from the radius distance. Please note that setting a target host will disable panning.
Parameters
value: Nullable<AbstractMesh>
Returns void
up
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.
Returns Vector3
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
use
Defines if the auto rotation behavior of the camera is enabled on the camera.
Returns boolean
Defines if the auto rotation behavior of the camera is enabled on the camera.
Parameters
value: boolean
Returns void
use
Defines if the bouncing behavior of the camera is enabled on the camera.
Returns boolean
Defines if the bouncing behavior of the camera is enabled on the camera.
Parameters
value: boolean
Returns void
use
Defines if the framing behavior of the camera is enabled on the camera.
Returns boolean
Defines if the framing behavior of the camera is enabled on the camera.
Parameters
value: boolean
Returns void
use
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
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.
Parameters
value: boolean
Returns void
wheel
Gets or Set the mouse wheel delta percentage or how fast is the camera zooming. It will be used instead of pinchDeltaPrecision if different from 0. It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
Returns number
Gets or Set the mouse wheel delta percentage or how fast is the camera zooming. It will be used instead of pinchDeltaPrecision if different from 0. It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
Parameters
value: number
Returns void
wheel
Gets or Set the mouse wheel precision or how fast is the camera zooming.
Returns number
Gets or Set the mouse wheel precision or how fast is the camera zooming.
Parameters
value: number
Returns void
world
Returns directly the latest state of the mesh World matrix. A Matrix is returned.
Returns Matrix
zoom
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
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.
Parameters
value: boolean
Returns void
Methods
_get
Internal, gets the first post process.
Returns Nullable<PostProcess>
the first post process to be run on this camera.
add
apply
Automatically tilts the projection plane, using
projectionPlaneTilt, to correct the perspective effect on vertical lines.Returns void
attach
Attach the input controls to a specific dom element to get the input from.
Parameters
Optional 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
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.
Optional 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
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
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
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
attach
Attach a post process to the camera.
Parameters
postProcess: PostProcess
The post process to attach to the camera
Optional insertAt: Nullable<number>
The position of the post process in case several of them are in use in the scene
Returns number
the position the post process has been inserted at
begin
Will start the animation sequence
Parameters
name: string
defines the range frames for animation sequence
Optional loop: boolean
defines if the animation should loop (false by default)
Optional speedRatio: number
defines the speed factor in which to run the animation (1 by default)
Optional onAnimationEnd: (() => void)
defines a function to be executed when the animation ended (undefined by default)
Returns void
Returns Nullable<Animatable>
the object created for this animation. If range does not exist, it will return null
cloneSearch playground for clone
compute
Compute the world matrix of the camera.
Returns Matrix
the camera world matrix
create
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
create
Parameters
name: string
cameraIndex: number
Returns Camera
delete
Delete a specific animation range
Parameters
name: string
defines the name of the range to delete
Optional deleteFrames: boolean
defines if animation frames from the range must be deleted as well
Returns void
detach
Detach the current controls from the specified dom element.
Returns void
detach
Detach a post process to the camera.
Parameters
postProcess: PostProcess
The post process to detach from the camera
Returns void
disposeSearch playground for dispose
Destroy the camera and release the current resources hold by it.
Returns void
focus
Focus on a mesh or a bounding box. This adapts the target and maxRadius if necessary but does not update the current radius. The target will be changed but the radius
Parameters
meshesOrMinMaxVectorAndDistance: AbstractMesh[] | { distance: number; max: Vector3; min: Vector3 }
Defines the mesh or bounding info to focus on
Optional 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
freeze
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
Optional projection: Matrix
Defines manually a projection if necessary
Returns void
get
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
get
get
Get an animation range by name
Parameters
name: string
defines the name of the animation range to look for
Returns Nullable<AnimationRange>
null if not found else the requested animation range
get
Gets the list of all animation ranges defined on this node
Returns Nullable<AnimationRange>[]
an array
get
get
Get all child-meshes of this node
Type Parameters
T extends AbstractMesh<T>
Parameters
Optional 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)
Optional predicate: ((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
Parameters
node: Node
Returns node is T
Returns T[]
an array of AbstractMesh
Get all child-meshes of this node
Parameters
Optional 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)
Optional predicate: ((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
Parameters
node: Node
Returns boolean
Returns AbstractMesh[]
an array of AbstractMesh
get
Get all direct children of this node
Type Parameters
T extends Node<T>
Parameters
Optional predicate: ((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
Parameters
node: Node
Returns node is T
Optional 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
Get all direct children of this node
Parameters
Optional predicate: ((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
Parameters
node: Node
Returns boolean
Optional 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
get
Gets camera class name
Returns string
StereoscopicArcRotateCamera
get
Will return all nodes that have this node as ascendant
Type Parameters
T extends Node<T>
Parameters
Optional 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
Optional predicate: ((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
Parameters
node: Node
Returns node is T
Returns T[]
all children nodes of all types
Will return all nodes that have this node as ascendant
Parameters
Optional 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
Optional predicate: ((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
Parameters
node: Node
Returns boolean
Returns Node[]
all children nodes of all types
get
get
get
Gets the engine of the node
Returns Engine
a Engine
get
Gets a ray in the forward direction from the camera.
Parameters
Optional length: number
Defines the length of the ray to create
Optional transform: Matrix
Defines the transform to apply to the ray, by default the world matrix is used to create a workd space ray
Optional origin: Vector3
Defines the start point of the ray which defaults to the camera position
Returns Ray
the forward ray
get
Gets a ray in the forward direction from the camera.
Parameters
refRay: Ray
the ray to (re)use when setting the values
Optional length: number
Defines the length of the ray to create
Optional transform: Matrix
Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
Optional origin: Vector3
Defines the start point of the ray which defaults to the camera position
Returns Ray
the forward ray
get
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
get
Return the minimum and maximum world vectors of the entire hierarchy under current node
Parameters
Optional includeDescendants: boolean
Include bounding info from descendants as well (true by default)
Optional predicate: Nullable<((abstractMesh: AbstractMesh) => boolean)>
defines a callback function that can be customize to filter what meshes should be included in the list used to compute the bounding vectors
Returns { max: Vector3; min: Vector3 }
the new bounding vectors
get
get
Gets the current projection matrix of the camera.
Parameters
Optional force: boolean
forces the camera to recompute the matrix without looking at the cached state
Returns Matrix
the projection matrix
get
get
Gets the scene of the node
Returns Scene
a scene
get
Return the current target position of the camera. This value is expressed in local space.
Returns Vector3
the target position
get
Gets the transformation matrix (ie. the multiplication of view by projection matrices)
Returns Matrix
a Matrix
get
Gets the current view matrix of the camera.
Parameters
Optional force: boolean
forces the camera to recompute the matrix without looking at the cached state
Returns Matrix
the view matrix
get
Gets the current world matrix of the camera
Returns Matrix
is
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
is
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
is
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
is
Gets a boolean indicating if the node has been disposed
Returns boolean
true if the node was disposed
is
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
Optional 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
is
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
Optional 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
is
Is this camera ready to be used/rendered
Parameters
Optional 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
mark
Flag the node as dirty (Forcing it to update everything)
Parameters
Optional _property: string
helps children apply precise "dirtyfication"
Returns Node
this node
rebuild
Rebuilds angles (alpha, beta) and radius from the give position and target
Returns void
remove
restore
Restored camera state. You must call storeState() first.
Returns boolean
true if restored and false otherwise
serializeSearch playground for serialize
Serialiaze the camera setup to a json representation
Returns any
the JSON representation
serialize
Serialize animation ranges into a JSON compatible object
Returns any
serialization object
set
Set the enabled state of this node
Parameters
value: boolean
defines the new enabled state
Returns void
set
Sets the Y-up to camera up-vector rotation matrix, and the up-vector to Y-up rotation matrix.
Returns void
set
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
set
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: AbstractMesh | Vector3
Defines the new target as a Vector or a mesh
Optional toBoundingCenter: boolean
In case of a mesh target, defines whether to target the mesh position or its bounding information center
Optional allowSamePosition: boolean
If false, prevents reapplying the new computed position if it is identical to the current one (optim)
Optional cloneAlphaBetaRadius: boolean
If true, replicate the current setup (alpha, beta, radius) on the new target
Returns void
store
Stores the current state of the camera (alpha, beta, radius and target)
Returns Camera
the camera itself
to
Gets a string representation of the camera useful for debug purpose.
Parameters
Optional fullDetails: boolean
Defines that a more verbose level of logging is required
Returns string
the string representation
unfreeze
Unfreeze the projection matrix if it has previously been freezed by freezeProjectionMatrix.
Returns void
updateSearch playground for update
Update the camera state according to the different inputs gathered during the frame.
Returns void
zoom
Zooms on a mesh to be at the min distance where we could see it fully in the current viewport.
Parameters
Optional meshes: AbstractMesh[]
Defines the mesh to zoom on
Optional 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
Static Add
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
Static ConstructSearch playground for Construct
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
Optional options: any
defines optional options to transmit to constructors
Returns Nullable<(() => Node)>
the new constructor or null
Static Get
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
Optional interaxial_distance: number
In case of stereoscopic setup, the distance between both eyes
Optional isStereoscopicSideBySide: boolean
In case of stereoscopic setup, should the sereo be side b side
Returns (() => Camera)
a factory method to construct the camera
Gets a camera constructor for a given camera type
Returns Camera
a factory method to construct the camera
Camera used to simulate stereoscopic rendering (based on ArcRotateCamera)
https://doc.babylonjs.com/features/featuresDeepDive/cameras