de.gurkenlabs.litiengine.graphics

Class Camera

java.lang.Object

de.gurkenlabs.litiengine.graphics.Camera

All Implemented Interfaces:

ICamera, IUpdateable

Direct Known Subclasses:

FreeFlightCamera, PositionLockCamera

public class Camera
extends java.lang.Object
implements ICamera

Nested Class Summary

Nested classes/interfaces inherited from interface de.gurkenlabs.litiengine.graphics.ICamera

ICamera.FocusChangedListener, ICamera.ZoomChangedListener

Field Summary

Fields

Modifier and Type	Field and Description
protected java.awt.geom.Point2D	focus Provides the center location for the viewport.

Constructor Summary

Constructors

Constructor and Description
Camera() Instantiates a new camera.

Method Summary

Modifier and Type	Method and Description
protected java.awt.geom.Point2D	clampToMap(java.awt.geom.Point2D focus)
Align	getClampAlign()
Valign	getClampValign()
java.awt.geom.Point2D	getFocus() Gets the map location that is focused by this camera.
java.awt.geom.Point2D	getMapLocation(java.awt.geom.Point2D viewPortLocation) Gets the map location.
double	getPixelOffsetX() Gets the pixel offset x.
double	getPixelOffsetY() Gets the pixel offset y.
float	getRenderScale()
java.awt.geom.Rectangle2D	getViewport() Gets the camera region.
java.awt.geom.Point2D	getViewportDimensionCenter(IEntity entity)
protected double	getViewportHeight()
java.awt.geom.Point2D	getViewportLocation(double x, double y) Gets the render location.
java.awt.geom.Point2D	getViewportLocation(IEntity entity) This method calculates to location for the specified entity in relation to the focus map location of the camera.
java.awt.geom.Point2D	getViewportLocation(java.awt.geom.Point2D mapLocation) This method calculates to location for the specified point in relation to the focus map location of the camera.
protected double	getViewportWidth()
float	getZoom()
boolean	isClampToMap()
void	onFocus(ICamera.FocusChangedListener listener) Adds the specified focus changed listener to receive events when the focus of this camera changed.
void	onZoom(ICamera.ZoomChangedListener listener) Adds the specified zoom changed listener to receive events when the zoom of this camera changed.
void	pan(double x, double y, int duration) Pans the camera over the specified duration (in frames) to the target location, after accounting for modifications such as clamping to the map.
void	pan(java.awt.geom.Point2D focus, int duration) Pans the camera over the specified duration (in frames) to the target location, after accounting for modifications such as clamping to the map.
protected int	panTime()
void	removeFocusListener(ICamera.FocusChangedListener listener) Removes the specified focus changed listener.
void	removeZoomListener(ICamera.ZoomChangedListener listener) Removes the specified zoom changed listener.
void	setClampAlign(Align align, Valign valign)
void	setClampToMap(boolean clampToMap)
void	setFocus(double x, double y)
void	setFocus(java.awt.geom.Point2D focus)
void	setZoom(float targetZoom, int delay)
void	shake(double intensity, int delay, int shakeDuration)
void	update() This method is called by the game loop on all objects that are attached to the loop.
void	updateFocus()

Methods inherited from class java.lang.Object

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

Field Detail

focus

protected java.awt.geom.Point2D focus

Provides the center location for the viewport.

Constructor Detail

Camera

public Camera()

Instantiates a new camera.

Method Detail

getFocus

public java.awt.geom.Point2D getFocus()

Description copied from interface: ICamera

Gets the map location that is focused by this camera.

Specified by:

getFocus in interface ICamera

Returns:

the focus map location

getMapLocation

public java.awt.geom.Point2D getMapLocation(java.awt.geom.Point2D viewPortLocation)

Description copied from interface: ICamera

Gets the map location.

Specified by:

getMapLocation in interface ICamera

Parameters:

viewPortLocation - the point

Returns:

the map location

getPixelOffsetX

public double getPixelOffsetX()

Description copied from interface: ICamera

Gets the pixel offset x.

Specified by:

getPixelOffsetX in interface ICamera

Returns:

the pixel offset x

getPixelOffsetY

public double getPixelOffsetY()

Description copied from interface: ICamera

Gets the pixel offset y.

Specified by:

getPixelOffsetY in interface ICamera

Returns:

the pixel offset y

getViewport

public java.awt.geom.Rectangle2D getViewport()

Description copied from interface: ICamera

Gets the camera region.

Specified by:

getViewport in interface ICamera

Returns:

the camera region

getViewportDimensionCenter

public java.awt.geom.Point2D getViewportDimensionCenter(IEntity entity)

Specified by:

getViewportDimensionCenter in interface ICamera

getViewportLocation

public java.awt.geom.Point2D getViewportLocation(double x,
                                                 double y)

Description copied from interface: ICamera

Gets the render location.

Specified by:

getViewportLocation in interface ICamera

Parameters:

x - the x

y - the y

Returns:

the render location

getViewportLocation

public java.awt.geom.Point2D getViewportLocation(IEntity entity)

Description copied from interface: ICamera

This method calculates to location for the specified entity in relation to the focus map location of the camera.

Specified by:

getViewportLocation in interface ICamera

Parameters:

entity - the entity

Returns:

the render location

getViewportLocation

public java.awt.geom.Point2D getViewportLocation(java.awt.geom.Point2D mapLocation)

Description copied from interface: ICamera

This method calculates to location for the specified point in relation to the focus map location of the camera.

Specified by:

getViewportLocation in interface ICamera

Parameters:

mapLocation - the point

Returns:

the render location

getZoom

public float getZoom()

Specified by:

getZoom in interface ICamera

getRenderScale

public float getRenderScale()

Specified by:

getRenderScale in interface ICamera

onZoom

public void onZoom(ICamera.ZoomChangedListener listener)

Description copied from interface: ICamera

Adds the specified zoom changed listener to receive events when the zoom of this camera changed.

Specified by:

onZoom in interface ICamera

Parameters:

listener - The listener to add.

removeZoomListener

public void removeZoomListener(ICamera.ZoomChangedListener listener)

Description copied from interface: ICamera

Removes the specified zoom changed listener.

Specified by:

removeZoomListener in interface ICamera

Parameters:

listener - The listener to add.

onFocus

public void onFocus(ICamera.FocusChangedListener listener)

Description copied from interface: ICamera

Adds the specified focus changed listener to receive events when the focus of this camera changed.

Specified by:

onFocus in interface ICamera

Parameters:

listener - The listener to add.

removeFocusListener

public void removeFocusListener(ICamera.FocusChangedListener listener)

Description copied from interface: ICamera

Removes the specified focus changed listener.

Specified by:

removeFocusListener in interface ICamera

Parameters:

listener - The listener to add.

setFocus

public void setFocus(java.awt.geom.Point2D focus)

Specified by:

setFocus in interface ICamera

setFocus

public void setFocus(double x,
                     double y)

Specified by:

setFocus in interface ICamera

setZoom

public void setZoom(float targetZoom,
                    int delay)

Specified by:

setZoom in interface ICamera

shake

public void shake(double intensity,
                  int delay,
                  int shakeDuration)

Specified by:

shake in interface ICamera

update

public void update()

Description copied from interface: IUpdateable

This method is called by the game loop on all objects that are attached to the loop. It's called on every tick of the loop and the frequency can be configured using the ClientConfiguration.

Specified by:

update in interface IUpdateable

See Also:

ClientConfiguration.setMaxFps(int)

updateFocus

public void updateFocus()

Specified by:

updateFocus in interface ICamera

isClampToMap

public boolean isClampToMap()

Specified by:

isClampToMap in interface ICamera

setClampToMap

public void setClampToMap(boolean clampToMap)

Specified by:

setClampToMap in interface ICamera

setClampAlign

public void setClampAlign(Align align,
                          Valign valign)

Specified by:

setClampAlign in interface ICamera

getClampAlign

public Align getClampAlign()

Specified by:

getClampAlign in interface ICamera

getClampValign

public Valign getClampValign()

Specified by:

getClampValign in interface ICamera

clampToMap

protected java.awt.geom.Point2D clampToMap(java.awt.geom.Point2D focus)

getViewportWidth

protected double getViewportWidth()

getViewportHeight

protected double getViewportHeight()

pan

public void pan(java.awt.geom.Point2D focus,
                int duration)

Description copied from interface: ICamera

Pans the camera over the specified duration (in frames) to the target location, after accounting for modifications such as clamping to the map. Event listeners attached to this camera are notified when the pan completes.

Specified by:

pan in interface ICamera

Parameters:

focus - the new focus for the camera once the panning is complete

duration - the number of frames between this call and when the pan completes

pan

public void pan(double x,
                double y,
                int duration)

Description copied from interface: ICamera

Pans the camera over the specified duration (in frames) to the target location, after accounting for modifications such as clamping to the map. Event listeners attached to this camera are notified when the pan completes.

Specified by:

pan in interface ICamera

Parameters:

x - the new X position for the camera once the panning is complete

y - the new Y position for the camera once the panning is complete

duration - the number of frames between this call and when the pan completes

panTime

protected int panTime()