Class FlyCamera
Hierarchy
-
TargetCamera
- FlyCamera
Index
Constructors
Properties
- _track
Roll - apply
Gravity - banked
Turn - banked
Turn Limit - banked
Turn Multiplier - camera
Direction - camera
Rotation - check
Collisions - ellipsoid
- ellipsoid
Offset - ignore
Parent Scaling - inputs
- inverse
Rotation Speed - invert
Rotation - locked
Target - no
Rotation Constraint - on
Collide - roll
Correct - rotation
- rotation
Quaternion - speed
- update
UpVector From Rotation
Accessors
Methods
Constructors
constructor
-
Instantiates a FlyCamera. This is a flying camera, designed for 3D movement and rotation in all directions, such as in a 3D Space Shooter or a Flight Simulator.
Parameters
-
name: string
Define the name of the camera in the scene.
-
position: Vector3
Define the starting position of the camera in the scene.
-
Optional scene: Scene
Define the scene the camera belongs to.
-
Optional setActiveOnSceneIfNoneActive: boolean
Defines whether the camera should be marked as active, if no other camera has been defined as active.
Returns FlyCamera
-
Properties
_track
Track Roll to maintain the wanted Rolling when looking around.
apply
Enable or disable gravity on the camera.
banked
Mimic a banked turn, Rolling the camera when Yawing. It's recommended to use rollCorrect = 10 for faster banking correction.
banked
Limit in radians for how much Roll banking will add. (Default: 90°)
banked
Value of 0 disables the banked Roll. Value of 1 is equal to the Yaw angle in radians.
camera
Define the current direction the camera is moving to.
camera
Define the current rotation the camera is rotating to
check
Enable or disable collisions of the camera with the rest of the scene objects.
ellipsoidSearch playground for ellipsoid
Define the collision ellipsoid of the camera. This is helpful for simulating a camera body, like a player's body.
ellipsoid
Define an offset for the position of the ellipsoid around the camera. This can be helpful if the camera is attached away from the player's body center, such as at its head.
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
The inputs manager loads all the input sources, such as keyboard and mouse.
inverse
Speed multiplier for inverse camera panning
invert
Reverses mouselook direction to 'natural' panning as opposed to traditional direct panning
locked
Define the current target of the camera as an object or a position.
no
Add constraint to the camera to prevent it to move freely in all directions and around all axis.
on
Event raised when the camera collides with a mesh in the scene.
Type declaration
-
-
Parameters
-
collidedMesh: AbstractMesh
Returns void
-
-
roll
Slowly correct the Roll to its original value after a Pitch+Yaw rotation.
rotationSearch playground for rotation
Define the current rotation of the camera
rotation
Define the current local rotation of the camera as a quaternion to prevent Gimbal lock. This overrides and empties cameraRotation.
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
Accessors
angular
-
Gets the input sensibility for mouse input. Higher values reduce sensitivity.
Returns number
-
Sets the input sensibility for a mouse input. Higher values reduce sensitivity.
Parameters
-
value: number
Returns any
-
collision
-
Get the mask that the camera ignores in collision events.
Returns number
-
Set the mask that the camera ignores in collision events.
Parameters
-
mask: number
Returns any
-
keys
-
Get the keys for camera movement backward.
Returns number[]
-
Get the keys for camera movement backward.
Parameters
-
value: number[]
Returns any
-
keys
-
Get the keys for camera movement down.
Returns number[]
-
Set the keys for camera movement down.
Parameters
-
value: number[]
Returns any
-
keys
-
Get the keys for camera movement forward.
Returns number[]
-
Set the keys for camera movement forward.
Parameters
-
value: number[]
Returns any
-
keys
-
Get the keys for camera movement left.
Returns number[]
-
Set the keys for camera movement left.
Parameters
-
value: number[]
Returns any
-
keys
-
Set the keys for camera movement right.
Returns number[]
-
Set the keys for camera movement right.
Parameters
-
value: number[]
Returns any
-
keys
-
Get the keys for camera movement up.
Returns number[]
-
Set the keys for camera movement up.
Parameters
-
value: number[]
Returns any
-
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 a control from the HTML DOM element. The camera will stop reacting to that input.
Returns void
disposeSearch playground for dispose
-
Destroy the camera and release the current resources held by it.
Returns void
get
-
Get the current object 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
This is a flying camera, designed for 3D movement and rotation in all directions, such as in a 3D Space Shooter or a Flight Simulator.