Class FollowCamera
Hierarchy
-
TargetCamera
- FollowCamera
Index
Constructors
Properties
- camera
Acceleration - camera
Direction - camera
Rotation - height
Offset - ignore
Parent Scaling - inputs
- inverse
Rotation Speed - invert
Rotation - locked
Target - lower
Height Offset Limit - lower
Radius Limit - lower
Rotation Offset Limit - max
Camera Speed - no
Rotation Constraint - radius
- rotation
- rotation
Offset - rotation
Quaternion - speed
- update
UpVector From Rotation - upper
Height Offset Limit - upper
Radius Limit - upper
Rotation Offset Limit
Accessors
Methods
Constructors
constructor
-
Instantiates the follow camera.
Parameters
-
name: string
Define the name of the camera in the scene
-
position: Vector3
Define the position of the camera
-
Optional scene: Scene
Define the scene the camera belong to
-
Optional lockedTarget: Nullable<AbstractMesh>
Define the target of the camera
Returns FollowCamera
-
Properties
camera
Define how fast the camera can accelerate to follow it s target.
camera
Define the current direction the camera is moving to
camera
Define the current rotation the camera is rotating to
height
Define a height offset between the camera and the object it follows. It can help following an object from the top (like a car chasing a plane)
ignore
Gets or sets a boolean indicating that the scaling of the parent hierarchy will not be taken in account by the camera
inputsSearch playground for inputs
Defines the input associated with the camera.
inverse
Speed multiplier for inverse camera panning
invert
Reverses mouselook direction to 'natural' panning as opposed to traditional direct panning
locked
Define the target of the camera.
lower
Minimum allowed height of camera position relative to target object. This can help limiting how the Camera is able to move in the scene.
lower
Minimum allowed distance of the camera to the axis of rotation (The camera can not get closer). This can help limiting how the Camera is able to move in the scene.
lower
Minimum allowed angle to camera position relative to target object. This can help limiting how the Camera is able to move in the scene.
max
Define the speed limit of the camera following an object.
no
Add constraint to the camera to prevent it to move freely in all directions and around all axis.
radiusSearch playground for radius
Distance the follow camera should follow an object at
rotationSearch playground for rotation
Define the current rotation of the camera
rotation
Define a rotation offset between the camera and the object it follows
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
update
When set, the up vector of the camera will be updated by the rotation of the camera
upper
Maximum allowed height of camera position relative to target object. This can help limiting how the Camera is able to move in the scene.
upper
Maximum allowed distance of the camera to the axis of rotation (The camera can not get further). This can help limiting how the Camera is able to move in the scene.
upper
Maximum allowed angle to camera position relative to target object. This can help limiting how the Camera is able to move in the scene.
Accessors
target
Methods
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
-
detach
-
Detach the current controls from the specified dom element.
Returns void
get
-
Gets the camera class name.
Returns string
the class name
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 current target position of the camera. This value is expressed in local space.
Returns Vector3
the target position
set
-
Defines the target the camera should look at.
Parameters
-
target: Vector3
Defines the new target as a Vector
Returns void
-
store
-
Store current camera state of the camera (fov, position, rotation, etc..)
Returns Camera
the camera
A follow camera takes a mesh as a target and follows it as it moves. Both a free camera version followCamera and an arc rotate version arcFollowCamera are available.
https://doc.babylonjs.com/features/cameras#follow-camera