de.gurkenlabs.litiengine.graphics

Interface ICamera

All Superinterfaces:

IUpdateable

All Known Implementing Classes:

Camera, FreeFlightCamera, PositionLockCamera

public interface ICamera
extends IUpdateable

The Interface ICamera defines methods that allow to determine where entities or tiles are rendered on the current screen.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ICamera.FocusChangedListener This listener interface receives focus events for a camera.
static interface	ICamera.ZoomChangedListener This listener interface receives zoom events for a camera.

Method Summary

Modifier and Type	Method and Description
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 point) 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)
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 point) This method calculates to location for the specified point in relation to the focus map location of the camera.
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.
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 zoom, int delay)
void	shake(double intensity, int delay, int duration)
void	updateFocus()

Methods inherited from interface de.gurkenlabs.litiengine.IUpdateable

update

Method Detail

onZoom

void onZoom(ICamera.ZoomChangedListener listener)

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

Parameters:

listener - The listener to add.

removeZoomListener

void removeZoomListener(ICamera.ZoomChangedListener listener)

Removes the specified zoom changed listener.

Parameters:

listener - The listener to add.

onFocus

void onFocus(ICamera.FocusChangedListener listener)

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

Parameters:

listener - The listener to add.

removeFocusListener

void removeFocusListener(ICamera.FocusChangedListener listener)

Removes the specified focus changed listener.

Parameters:

listener - The listener to add.

getFocus

java.awt.geom.Point2D getFocus()

Gets the map location that is focused by this camera.

Returns:

the focus map location

getMapLocation

java.awt.geom.Point2D getMapLocation(java.awt.geom.Point2D point)

Gets the map location.

Parameters:

point - the point

Returns:

the map location

getPixelOffsetX

double getPixelOffsetX()

Gets the pixel offset x.

Returns:

the pixel offset x

getPixelOffsetY

double getPixelOffsetY()

Gets the pixel offset y.

Returns:

the pixel offset y

getViewport

java.awt.geom.Rectangle2D getViewport()

Gets the camera region.

Returns:

the camera region

getViewportDimensionCenter

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

getViewportLocation

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

Gets the render location.

Parameters:

x - the x

y - the y

Returns:

the render location

getViewportLocation

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.

Parameters:

entity - the entity

Returns:

the render location

getViewportLocation

java.awt.geom.Point2D getViewportLocation(java.awt.geom.Point2D point)

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

Parameters:

point - the point

Returns:

the render location

getRenderScale

float getRenderScale()

getZoom

float getZoom()

setFocus

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

setFocus

void setFocus(double x,
              double y)

pan

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. Event listeners attached to this camera are notified when the pan completes.

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

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. Event listeners attached to this camera are notified when the pan completes.

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

setZoom

void setZoom(float zoom,
             int delay)

isClampToMap

boolean isClampToMap()

setClampToMap

void setClampToMap(boolean clampToMap)

setClampAlign

void setClampAlign(Align align,
                   Valign valign)

getClampAlign

Align getClampAlign()

getClampValign

Valign getClampValign()

shake

void shake(double intensity,
           int delay,
           int duration)

updateFocus

void updateFocus()