Render3D. FirstPersonCamera3D

FirstPersonCamera3D - Look around with the mouse and move with the keys, with the camera at its position

  • Click to capture the mouse so looking needs no button held, Esc lets it go; holding the button looks too, for touch
  • WASD or the arrow keys walk level, or move the way it looks when fly is set
  • An EngineObject3D that moves by velocity3D, so give it a size3D and call setCollision to walk into solid objects instead of through them; walking keeps velocity3D.y, so render3D.gravity can pull it down
  • Starts from wherever render3D.camera is, so it can take over from another camera without a jump
  • As the child of an EngineObject3D, like a player on a ship, its yaw, pitch and walking are relative to the parent, so it turns and moves with it
  • Destroy it to hand the camera back

Constructor

new FirstPersonCamera3D(pos3Dopt, yawopt, pitchopt)

Create a first person camera, it drives render3D.camera every frame

Parameters:
NameTypeAttributesDescription
pos3DVector3<optional>

Where the eye is, defaults to where the camera is now

yawnumber<optional>

Radians around Y, defaults to the camera's

pitchnumber<optional>

Radians up from level, defaults to the camera's

Source
Example
const player = new FirstPersonCamera3D(vec3(0, 1.5, 5));
player.size3D = vec3(1); // bump into solid objects
player.collideAsSphere3D = true;
player.setCollision();

Extends

  • EngineObject3D

Members

eyeHeight

Properties
TypeDescription
number

How far above its position the eye is, in its own space, so with a size3D the eye can sit toward the top of the body instead of its middle; keep it under half the body's height, or the eye is outside the body and sees through a ceiling it stands under

Source

fly

Properties
TypeDescription
boolean

Move the way it looks, up and down included, instead of walking level

Source

jumpSpeed

Properties
TypeDescription
number

Speed of a jump in world units a frame, 0 for none; Space or gamepad button 0 jumps while it stands on something, a height map, a voxel map or a solid, see groundObject

Source

lockPointer

Properties
TypeDescription
boolean

Capture the mouse on a click, so looking needs no button held

Source

lookSpeed

Properties
TypeDescription
number

How far a pixel of mouse movement turns the view

Source

moveSpeed

Properties
TypeDescription
number

World units per frame at full speed

Source

pitch

Properties
TypeDescription
number

Angle up from level, the mouse tilts it

Source

pitchRange

Properties
TypeDescription
Vector2

Lowest and highest pitch

Source

yaw

Properties
TypeDescription
number

Angle around Y, the mouse turns it

Source

Methods

destroy(immediateopt)

Let go of the mouse and stop driving the camera

Parameters:
NameTypeAttributesDescription
immediateboolean<optional>
Source

render3D()

Camera controls draw nothing

Source

update()

Read the mouse and keys and put the camera at the eye, called automatically each frame

Source

updatePhysics()

Move by velocity3D, and fall by render3D.gravity unless flying, called automatically each frame

Source