com.bonzaiengine.gamekit.util

Class FreeCamera

java.lang.Object

com.bonzaiengine.gamekit.util.FreeCamera

All Implemented Interfaces:

IActivableCamera, ICamera, IViewable, IInputListener

public class FreeCamera
extends java.lang.Object
implements IActivableCamera, IInputListener

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 ICamera.update(SceneView, 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 |
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	setTranslationMask(int axis, boolean active)
void	translate(Vec3 vector) Translate the camera.
void	update(SceneView sceneView, long timePassedMs) Update the camera.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.bonzaiengine.camera.IActivableCamera

isActive, setActive

Constructor Detail

FreeCamera

public FreeCamera()

FreeCamera

public FreeCamera(ITransformable transformable)

FreeCamera

public FreeCamera(IMovable movable)

Method Detail

processInput

public void processInput(SceneView sceneView,
                         IInput input)

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

Specified by:

processInput in interface IInputListener

update

public void update(SceneView sceneView,
                   long timePassedMs)

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

Specified by:

update in interface ICamera

timePassedMs - elapsed time in milliseconds used to update/animate the camera.

getLookAt

public final Mat4x4 getLookAt(Mat4x4 dst)

Description copied from interface: IViewable

 |    -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 IViewable

Parameters:

dst - destination matrix to store the look at matrix

setLookAt

public final void setLookAt(Mat4x4 src)

Specified by:

setLookAt in interface ICamera

Parameters:

src - a look at matrix

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.

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.

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