com.bonzaiengine.gamekit.util

Class FreeCamera

java.lang.Object

com.bonzaiengine.gamekit.util.FreeCamera

All Implemented Interfaces:

ICamera, ICameraController, IInputListener

public class FreeCamera
extends java.lang.Object
implements ICameraController

Free movement in 3d space with smoothing. Inputs:

• Right click: orientation of the view
• Left click: orientation of the view on side + move forward/backward along horizontal plane
• Up/Down: move forward/backward along view direction
• Left/Right: move sideward along side direction

The mouse pointer is lockable with setUsePointerControl(boolean).
User must call processInput(SceneView, IInput) and update(long)

Constructor Summary

Constructors

Constructor and Description
FreeCamera()
FreeCamera(IMovable movable)
FreeCamera(ITransformable transformable)

Method Summary

Modifier and Type	Method and Description
void	discardPointerControl(IInput input) Force this FreeCamera to discard pointer control
Mat4x4	getLookAt(Mat4x4 dst) | -left.x -left.y -left.z -( left.dot.position) | | up.x up.y up.z ( up.dot.position) | | -forward.x -forward.y -forward.z -(forward.dot.position) | | 0 0 0 1 |
IMovable	getMovable()
float	getSpeed()
float	getSpeedDamping()
boolean	isPointerControlled()
void	processInput(SceneView sceneView, IInput input) Update inputs.
void	rotate(Vec3 anglesInRadians) Rotate this FreeCamera.
void	setLookAt(Mat4x4 src)
void	setPosition(Vec3 pos)
void	setRotation(Quat q)
void	setRotation(Vec3 anglesInRadians)
void	setRotationMask(int axis, boolean active)
void	setSpeed(float speed)
void	setSpeedDamping(float speedDamping)
void	setTranslationMask(int axis, boolean active)
void	setUsePointerControl(boolean usePointerControl)
void	translate(Vec3 vector) Translate the camera.
void	update(long timePassedMs) Update the camera.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FreeCamera

public FreeCamera()

FreeCamera

public FreeCamera(ITransformable transformable)

FreeCamera

public FreeCamera(IMovable movable)

Method Detail

setSpeed

public final void setSpeed(float speed)

getSpeed

public final float getSpeed()

setSpeedDamping

public final void setSpeedDamping(float speedDamping)

getSpeedDamping

public float getSpeedDamping()

processInput

public void processInput(SceneView sceneView,
                         IInput input)

Update inputs.
This is usually called once per frame, and before update(long)

Specified by:

processInput in interface IInputListener

update

public void update(long timePassedMs)

Update the camera.
Usually called once per frame after processInput(SceneView, IInput)

Specified by:

update in interface ICameraController

Parameters:

timePassedMs - elapsed time in milliseconds used to update/animate the camera.
This is usually the frame duration.

getMovable

public final IMovable getMovable()

Returns:

the IMovable attached to this FreeCamera

getLookAt

public final Mat4x4 getLookAt(Mat4x4 dst)

Description copied from interface: ICamera

 |    -left.x    -left.y    -left.z -(   left.dot.position) |
 |       up.x       up.y       up.z  (     up.dot.position) |
 | -forward.x -forward.y -forward.z -(forward.dot.position) |
 |        0          0          0               1           |
 

Specified by:

getLookAt in interface ICamera

Parameters:

dst - destination matrix to store the look at matrix

setLookAt

public final void setLookAt(Mat4x4 src)

Specified by:

setLookAt in interface ICameraController

Parameters:

src - a look at matrix

setUsePointerControl

public void setUsePointerControl(boolean usePointerControl)

Parameters:

usePointerControl - true to allow this FreeCamera to take control of mouse pointer when dragging.

isPointerControlled

public final boolean isPointerControlled()

Returns:

true if the pointer is currently controlled by this FreeCamera

discardPointerControl

public final void discardPointerControl(IInput input)

Force this FreeCamera to discard pointer control

Parameters:

input - IInput previously passed in processInput(SceneView, IInput)

setTranslationMask

public final void setTranslationMask(int axis,
                                     boolean active)

Parameters:

axis - 0 for x axis; 1 for y axis; 2 for z axis

active - true to allow translation, false to freeze/lock translation on the specified axis

setRotationMask

public final void setRotationMask(int axis,
                                  boolean active)

Parameters:

axis - 0 for x axis; 1 for y axis; 2 for z axis

active - true to allow rotation, false to freeze/lock rotation on the specified axis

translate

public void translate(Vec3 vector)

Translate the camera.

Specified by:

translate in interface ICameraController

Parameters:

vector - expressed in the camera axis system

setPosition

public final void setPosition(Vec3 pos)

Parameters:

pos - set the camera position

rotate

public void rotate(Vec3 anglesInRadians)

Rotate this FreeCamera.

Specified by:

rotate in interface ICameraController

Parameters:

anglesInRadians - rotation angles in radians

setRotation

public final void setRotation(Vec3 anglesInRadians)

Parameters:

anglesInRadians - set the camera rotation, from angles in radians

setRotation

public final void setRotation(Quat q)

Parameters:

q - set the camera rotation, from a quaternion