Class NaturalCamera

java.lang.Object

gaiasky.scene.camera.AbstractCamera

gaiasky.scene.camera.NaturalCamera

All Implemented Interfaces:

IObserver, ICamera

public class NaturalCamera
extends AbstractCamera
implements IObserver

The basic camera of Gaia Sky. Implements focus, free and game modes. It also incorporates the cinematic and the non-cinematic behaviours.

Field Summary

Fields

Modifier and Type	Field	Description
final Vector3D	accel	Acceleration and velocity.
final Vector3D	direction
boolean	facingFocus	Indicates whether the camera is facing the focus or not.
FocusView	focus	The focus entity.
FocusView	focusBak	Reference to focus, backup.
final Vector3D	posBak	Acceleration and velocity.
final Vector3D	up
final Vector3D	vel	Acceleration and velocity.
final Vector3D	vrOffset	VR offset.

Fields inherited from class AbstractCamera

angleEdgeRad, ar, CAM_FAR, CAM_NEAR, camera, cameras, camLeft, camRight, closest, closestBody, closestStar, closestStarView, distance, dPos, fovFactor, gamepadInput, logger, parent, pos, posInv, prevCombined, prevPos, proximity, shift, tmp

Constructor Summary

Constructors

Constructor	Description
NaturalCamera(com.badlogic.gdx.assets.AssetManager assetManager, CameraManager parent, boolean vr, com.badlogic.gdx.graphics.glutils.ShaderProgram spriteShader, com.badlogic.gdx.graphics.glutils.ShaderProgram shapeShader)

Method Summary

Modifier and Type	Method	Description
void	addAmount(Vector3D vec, double amount, boolean x)
void	addForwardForce(double amount)	Adds a forward movement by the given amount.
void	addGamepadListener()
void	addHorizontal(double amount, boolean acceleration)	Adds the given amount to camera horizontal rotation around the focus acceleration, or pan in free mode
void	addPitch(double amount, boolean acceleration)	Adds the given amount to the camera pitch acceleration
void	addRoll(double amount, boolean acceleration)	Adds the given amount to the camera roll acceleration
void	addRotateMovement(double deltaX, double deltaY, boolean focusLookKeyPressed, boolean acceleration)	Adds a rotation force to the camera.
void	addVertical(double amount, boolean acceleration)	Adds the given amount to camera vertical rotation around the focus acceleration, or pan in free mode
void	addYaw(double amount, boolean acceleration)	Adds the given amount to the camera yaw acceleration
protected void	applyForce(Vector3Q force)	Applies the given force to this entity's acceleration.
void	camOrientProjection(float yaw, float pitch, float roll)	Does a pre-transformation to the camera to orient it using the given yaw, pitch and roll angles.
void	clearVelocityVR()	Clears the velocityVR vector
void	doneLoading(com.badlogic.gdx.assets.AssetManager manager)	Loading is finished, gather resources.
void	forward(double amount)
void	forward(double amount, double minTu)
com.badlogic.gdx.graphics.PerspectiveCamera	getCamera()	Returns the perspective camera.
AbstractMouseKbdListener	getCurrentMouseKbdListener()
Vector3D	getDirection()
Vector3D[]	getDirections()
IFocus	getFocus()	Returns the focus if any.
com.badlogic.gdx.graphics.PerspectiveCamera[]	getFrontCameras()
MainGamepadListener	getGamepadListener()
CameraManager.CameraMode	getMode()
int	getNCameras()
Scene	getScene()
double	getSpeed()	Gets the current velocity of the camera in km/h.
double	getSpeedScaling()
double	getSpeedScalingCapped()
Vector3D	getUp()
Vector3D	getVelocity()
boolean	hasFocus()	Checks whether the current camera has a focus set.
void	initialize(com.badlogic.gdx.graphics.glutils.ShaderProgram spriteShader, com.badlogic.gdx.graphics.glutils.ShaderProgram shapeShader)
boolean	isFocus(com.badlogic.ashley.core.Entity focus)	Checks if the given entity is the current focus.
boolean	isRotating()	Check whether the camera is currently rotating around the (possible) focus object.
void	notify(Event event, Object source, Object... data)	Event notification call.
void	removeGamepadListener()
void	render(int rw, int rh)
void	resize(int width, int height)
void	rotate(Vector3D axis, double angle)
void	rotateAround(Vector3Q rotationCenter, Vector3D rotationAxis, double angle)	Rotates the direction and up vector of this camera by the given angle around the given axis, with the axis attached to given point.
void	setCamera(com.badlogic.gdx.graphics.PerspectiveCamera perspectiveCamera)	Sets the active camera
void	setCameraMultipliers(double movementMultiplier, double speedMultiplier)
void	setCenterFocus(boolean centerFocus)
void	setDirection(Vector3D dir)
void	setDiverted(boolean diverted)
void	setFocus(String focusName, com.badlogic.ashley.core.Entity newFocus)
void	setHorizontal(double amount)
void	setPitch(double amount)
void	setPointerProjectionOnFocus(com.badlogic.gdx.math.Vector3 point)	Sets the current pointer coordinates, as projected on the current focus object.
void	setRoll(double amount)
void	setThrust(double thrust, int direction)
void	setUp(Vector3D up)
void	setVelocity(double amount)	Sets the gamepad velocity as it comes from the joystick sensor.
void	setVelocityVR(Vector3D p0, Vector3D p1, double amountX, double amountY)	Sets the velocity of the VR controller as a vector.
void	setVertical(double amount)
void	setYaw(double amount)
double	speedScaling()	The speed scaling function.
double	speedScaling(double min)	The speed scaling function.
void	stopForwardMovement()	Stops the camera movement.
boolean	stopMovement()	Stops the camera movement.
void	stopRotateMovement()
void	stopTotalMovement()	Stops the camera movement.
void	strafe(double amount, double minTu)
void	translate(double x, double y, double z)	Moves the camera by the given amount on each axis.
void	translate(Vector3D vec)	Moves the camera by the given vector.
void	update(double dt, ITimeFrameProvider time)	Updates the camera.
void	updateMode(ICamera previousCam, CameraManager.CameraMode previousMode, CameraManager.CameraMode newMode, boolean centerFocus)	Updates the camera mode.
void	updatePerspectiveCamera()	Sets the perspective camera float values from the computed double vectors, and recalculates the camera matrices.
protected void	updatePosition(double dt, double multiplier, double speedScaling)	Updates the position of this entity using the current force
protected void	updateVelocity(double dt, double multiplier, double speedScaling)
void	vertical(double amount)
void	vertical(double amount, double minTu)

Methods inherited from class AbstractCamera

checkClosestBody, checkClosestBody, checkClosestParticle, copyParamsFrom, getAngleEdge, getAngleEdge, getCameraStereoLeft, getCameraStereoRight, getCloseLightSource, getClosest, getClosestBody, getClosestParticle, getCurrent, getDistance, getDPos, getFar, getFovFactor, getInversePos, getManager, getNear, getPos, getPreviousPos, getPreviousProjView, getProjView, getSecondClosestBody, getShift, isVisible, isVisible, isVisible, setCameraStereoLeft, setCameraStereoRight, setClosest, setDPos, setDPos, setFrustumPlanes, setGamepadInput, setPos, setPos, setPreviousPos, setPreviousPos, setPreviousProjView, setShift, swapBuffers, updateAngleEdge, updateFrustumPlanes

Methods inherited from class Object

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

Field Details

vrOffset

public final Vector3D vrOffset

VR offset.

accel

public final Vector3D accel

Acceleration and velocity.

vel

public final Vector3D vel

Acceleration and velocity.

posBak

public final Vector3D posBak

Acceleration and velocity.

direction

public final Vector3D direction

up

public final Vector3D up

facingFocus

public boolean facingFocus

Indicates whether the camera is facing the focus or not.

focus

public FocusView focus

The focus entity.

focusBak

public FocusView focusBak

Reference to focus, backup.

Constructor Details

NaturalCamera

public NaturalCamera(com.badlogic.gdx.assets.AssetManager assetManager,
 CameraManager parent,
 boolean vr,
 com.badlogic.gdx.graphics.glutils.ShaderProgram spriteShader,
 com.badlogic.gdx.graphics.glutils.ShaderProgram shapeShader)

Method Details

initialize

public void initialize(com.badlogic.gdx.graphics.glutils.ShaderProgram spriteShader,
 com.badlogic.gdx.graphics.glutils.ShaderProgram shapeShader)

doneLoading

public void doneLoading(com.badlogic.gdx.assets.AssetManager manager)

Description copied from interface: ICamera

Loading is finished, gather resources.

Specified by:

doneLoading in interface ICamera

Parameters:

manager - The asset manager.

update

public void update(double dt,
 ITimeFrameProvider time)

Description copied from interface: ICamera

Updates the camera.

Specified by:

update in interface ICamera

Parameters:

dt - The time since the las frame in seconds.

time - The frame time provider (simulation time).

camOrientProjection

public void camOrientProjection(float yaw,
 float pitch,
 float roll)

Does a pre-transformation to the camera to orient it using the given yaw, pitch and roll angles.

Parameters:

yaw - The yaw angle (to the right)

pitch - The pitch angle (up)

roll - The roll angle (clockwise)

updatePerspectiveCamera

public void updatePerspectiveCamera()

Sets the perspective camera float values from the computed double vectors, and recalculates the camera matrices.

addForwardForce

public void addForwardForce(double amount)

Adds a forward movement by the given amount.

Parameters:

amount - Positive for forward force, negative for backward force.

setVelocityVR

public void setVelocityVR(Vector3D p0,
 Vector3D p1,
 double amountX,
 double amountY)

Sets the velocity of the VR controller as a vector. The magnitude of this vector should not be larger than 1

Parameters:

p0 - Start point of the beam

p1 - End point of the beam

amountX - Amount in the perpendicular direction of p0-p1

amountY - Amount in the direction of p0-p1

clearVelocityVR

public void clearVelocityVR()

Clears the velocityVR vector

forward

public void forward(double amount)

forward

public void forward(double amount,
 double minTu)

strafe

public void strafe(double amount,
 double minTu)

vertical

public void vertical(double amount)

vertical

public void vertical(double amount,
 double minTu)

addRotateMovement

public void addRotateMovement(double deltaX,
 double deltaY,
 boolean focusLookKeyPressed,
 boolean acceleration)

Adds a rotation force to the camera. DeltaX corresponds to yaw (right/left) and deltaY corresponds to pitch (up/down).

Parameters:

deltaX - The yaw amount.

deltaY - The pitch amount.

focusLookKeyPressed - The key to look around when on focus mode is pressed.

addAmount

public void addAmount(Vector3D vec,
 double amount,
 boolean x)

addYaw

public void addYaw(double amount,
 boolean acceleration)

Adds the given amount to the camera yaw acceleration

setYaw

public void setYaw(double amount)

addPitch

public void addPitch(double amount,
 boolean acceleration)

Adds the given amount to the camera pitch acceleration

setPitch

public void setPitch(double amount)

addRoll

public void addRoll(double amount,
 boolean acceleration)

Adds the given amount to the camera roll acceleration

setRoll

public void setRoll(double amount)

addHorizontal

public void addHorizontal(double amount,
 boolean acceleration)

Adds the given amount to camera horizontal rotation around the focus acceleration, or pan in free mode

setHorizontal

public void setHorizontal(double amount)

addVertical

public void addVertical(double amount,
 boolean acceleration)

Adds the given amount to camera vertical rotation around the focus acceleration, or pan in free mode

setVertical

public void setVertical(double amount)

stopMovement

public boolean stopMovement()

Stops the camera movement.

Returns:

True if the camera had any movement at all and it has been stopped. False if camera was already still.

stopTotalMovement

public void stopTotalMovement()

Stops the camera movement.

stopRotateMovement

public void stopRotateMovement()

stopForwardMovement

public void stopForwardMovement()

Stops the camera movement.

updateVelocity

protected void updateVelocity(double dt,
 double multiplier,
 double speedScaling)

updatePosition

protected void updatePosition(double dt,
 double multiplier,
 double speedScaling)

Updates the position of this entity using the current force

updateMode

public void updateMode(ICamera previousCam,
 CameraManager.CameraMode previousMode,
 CameraManager.CameraMode newMode,
 boolean centerFocus)

Updates the camera mode.

Specified by:

updateMode in interface ICamera

getGamepadListener

public MainGamepadListener getGamepadListener()

addGamepadListener

public void addGamepadListener()

removeGamepadListener

public void removeGamepadListener()

setFocus

public void setFocus(String focusName,
 com.badlogic.ashley.core.Entity newFocus)

speedScaling

public double speedScaling(double min)

The speed scaling function.

Parameters:

min - The minimum speed.

Returns:

The speed scaling.

speedScaling

public double speedScaling()

The speed scaling function.

Specified by:

speedScaling in interface ICamera

Returns:

The speed scaling.

notify

public void notify(Event event,
 Object source,
 Object... data)

Description copied from interface: IObserver

Event notification call.

Specified by:

notify in interface IObserver

Parameters:

event - The event type.

source - The source object, if any.

data - The data associated with this event.

rotateAround

public void rotateAround(Vector3Q rotationCenter,
 Vector3D rotationAxis,
 double angle)

Rotates the direction and up vector of this camera by the given angle around the given axis, with the axis attached to given point. The direction and up vector will not be orthogonal.

Parameters:

rotationCenter - the point to attach the axis to

rotationAxis - the axis to rotate around

angle - the angle, in degrees

rotate

public void rotate(Vector3D axis,
 double angle)

translate

public void translate(double x,
 double y,
 double z)

Moves the camera by the given amount on each axis.

Parameters:

x - the displacement on the x-axis

y - the displacement on the y-axis

z - the displacement on the z-axis

translate

public void translate(Vector3D vec)

Moves the camera by the given vector.

Parameters:

vec - the displacement vector

applyForce

protected void applyForce(Vector3Q force)

Applies the given force to this entity's acceleration.

Parameters:

force - The force.

getFrontCameras

public com.badlogic.gdx.graphics.PerspectiveCamera[] getFrontCameras()

Specified by:

getFrontCameras in interface ICamera

getCamera

public com.badlogic.gdx.graphics.PerspectiveCamera getCamera()

Description copied from interface: ICamera

Returns the perspective camera.

Specified by:

getCamera in interface ICamera

Returns:

The perspective camera.

setCamera

public void setCamera(com.badlogic.gdx.graphics.PerspectiveCamera perspectiveCamera)

Description copied from interface: ICamera

Sets the active camera

Specified by:

setCamera in interface ICamera

Parameters:

perspectiveCamera - The perspective camera.

getDirection

public Vector3D getDirection()

Specified by:

getDirection in interface ICamera

setDirection

public void setDirection(Vector3D dir)

Specified by:

setDirection in interface ICamera

getUp

public Vector3D getUp()

Specified by:

getUp in interface ICamera

setUp

public void setUp(Vector3D up)

getDirections

public Vector3D[] getDirections()

Specified by:

getDirections in interface ICamera

getNCameras

public int getNCameras()

Specified by:

getNCameras in interface ICamera

getMode

public CameraManager.CameraMode getMode()

Specified by:

getMode in interface ICamera

getSpeed

public double getSpeed()

Description copied from interface: ICamera

Gets the current velocity of the camera in km/h.

Specified by:

getSpeed in interface ICamera

Returns:

The velocity in km/h.

isFocus

public boolean isFocus(com.badlogic.ashley.core.Entity focus)

Description copied from interface: ICamera

Checks if the given entity is the current focus.

Specified by:

isFocus in interface ICamera

Parameters:

focus - The entity.

Returns:

Whether the entity is focus.

getFocus

public IFocus getFocus()

Description copied from interface: ICamera

Returns the focus if any.

Specified by:

getFocus in interface ICamera

Returns:

The focus object if it is in focus mode. Null otherwise.

hasFocus

public boolean hasFocus()

Description copied from interface: ICamera

Checks whether the current camera has a focus set.

Specified by:

hasFocus in interface ICamera

Returns:

True if the camera has a focus.

setCenterFocus

public void setCenterFocus(boolean centerFocus)

setThrust

public void setThrust(double thrust,
 int direction)

render

public void render(int rw,
 int rh)

Specified by:

render in interface ICamera

Overrides:

render in class AbstractCamera

resize

public void resize(int width,
 int height)

Specified by:

resize in interface ICamera

setPointerProjectionOnFocus

public void setPointerProjectionOnFocus(com.badlogic.gdx.math.Vector3 point)

Description copied from interface: ICamera

Sets the current pointer coordinates, as projected on the current focus object. This only applies when the camera is in focus mode, and the focus is a planet.

Specified by:

setPointerProjectionOnFocus in interface ICamera

Overrides:

setPointerProjectionOnFocus in class AbstractCamera

Parameters:

point - The Cartesian coordinates of the pointer on the sphere representing the focus object.

getSpeedScaling

public double getSpeedScaling()

Specified by:

getSpeedScaling in interface ICamera

Overrides:

getSpeedScaling in class AbstractCamera

getSpeedScalingCapped

public double getSpeedScalingCapped()

Specified by:

getSpeedScalingCapped in interface ICamera

Overrides:

getSpeedScalingCapped in class AbstractCamera

getVelocity

public Vector3D getVelocity()

Specified by:

getVelocity in interface ICamera

Overrides:

getVelocity in class AbstractCamera

setVelocity

public void setVelocity(double amount)

Sets the gamepad velocity as it comes from the joystick sensor.

Parameters:

amount - The amount in [-1, 1].

setDiverted

public void setDiverted(boolean diverted)

setCameraMultipliers

public void setCameraMultipliers(double movementMultiplier,
 double speedMultiplier)

getCurrentMouseKbdListener

public AbstractMouseKbdListener getCurrentMouseKbdListener()

getScene

public Scene getScene()

isRotating

public boolean isRotating()

Description copied from interface: ICamera

Check whether the camera is currently rotating around the (possible) focus object.

Specified by:

isRotating in interface ICamera

Overrides:

isRotating in class AbstractCamera

Returns:

Whether the camera is rotating.