rescuecore2.misc.gui

Class ScreenTransform

java.lang.Object

rescuecore2.misc.gui.ScreenTransform

public class ScreenTransform
extends java.lang.Object

A class that handles transforming between world coordinates and screen coordinates. This class should be used rather than affine transforms when you want to draw something in the right position (in world coordinates) but with a particular on-screen size. Affine transforms make it hard to control the output size.

Constructor Summary

Constructors

Constructor and Description
ScreenTransform(double minX, double minY, double maxX, double maxY) Create a ScreenTransform that covers a particular world coordinate range.

Method Summary

Modifier and Type	Method and Description
java.awt.geom.Rectangle2D	getViewBounds() Get the current view bounds in world coordinates.
boolean	isInView(java.awt.geom.Point2D p) Find out if a point is inside the current view bounds.
boolean	isInView(java.awt.Shape s) Find out if a shape is inside the current view bounds.
void	makeCentreRelativeTo(double x, double y, int screenX, int screenY) Set the on-screen center point relative to another point.
void	rescale(int width, int height) Recalculate the transform based on screen geometry.
void	resetZoom() Reset the zoom level to one.
double	screenToX(int x) Convert a screen X coordinate to a world coordinate.
double	screenToY(int y) Convert a screen Y coordinate to a world coordinate.
void	setCentrePoint(double x, double y) Set the on-screen centre point.
void	setFixedAspectRatio(boolean b) Set whether to use a fixed aspect ratio or not.
void	show(java.awt.geom.Rectangle2D bounds) Zoom and translate to show a particular rectangle.
int	xToScreen(double x) Convert a world X coordinate to a screen coordinate.
int	yToScreen(double y) Convert a world Y coordinate to a screen coordinate.
void	zoomIn() Increase the zoom level by one step.
void	zoomOut() Decrease the zoom level by one step.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScreenTransform

public ScreenTransform(double minX,
                       double minY,
                       double maxX,
                       double maxY)

Create a ScreenTransform that covers a particular world coordinate range.

Parameters:

minX - The minimum X world coordinate.

minY - The minimum Y world coordinate.

maxX - The maximum X world coordinate.

maxY - The maximum Y world coordinate.

Method Detail

setCentrePoint

public void setCentrePoint(double x,
                           double y)

Set the on-screen centre point.

Parameters:

x - The X world coordinate to put in the centre.

y - The Y world coordinate to put in the centre.

makeCentreRelativeTo

public void makeCentreRelativeTo(double x,
                                 double y,
                                 int screenX,
                                 int screenY)

Set the on-screen center point relative to another point.

Parameters:

x - The world X coordinate.

y - The world Y coordinate.

screenX - The screen X coordinate.

screenY - The screen Y coordinate.

setFixedAspectRatio

public void setFixedAspectRatio(boolean b)

Set whether to use a fixed aspect ratio or not.

Parameters:

b - True to use a fixed aspect ratio, false otherwise.

zoomIn

public void zoomIn()

Increase the zoom level by one step.

zoomOut

public void zoomOut()

Decrease the zoom level by one step.

resetZoom

public void resetZoom()

Reset the zoom level to one. This also clears the fixed point coordinate.

show

public void show(java.awt.geom.Rectangle2D bounds)

Zoom and translate to show a particular rectangle.

Parameters:

bounds - The bounds of the rectangle to show.

rescale

public void rescale(int width,
                    int height)

Recalculate the transform based on screen geometry.

Parameters:

width - The width of the screen.

height - The height of the screen.

isInView

public boolean isInView(java.awt.Shape s)

Find out if a shape is inside the current view bounds.

Parameters:

s - The shape to test.

Returns:

True if any part of the shape is inside the current view bounds, false otherwise.

isInView

public boolean isInView(java.awt.geom.Point2D p)

Find out if a point is inside the current view bounds.

Parameters:

p - The point to test.

Returns:

True if the point is inside the current view bounds, false otherwise.

getViewBounds

public java.awt.geom.Rectangle2D getViewBounds()

Get the current view bounds in world coordinates.

Returns:

The view bounds.

xToScreen

public int xToScreen(double x)

Convert a world X coordinate to a screen coordinate.

Parameters:

x - The world X coordinate.

Returns:

The screen coordinate.

yToScreen

public int yToScreen(double y)

Convert a world Y coordinate to a screen coordinate.

Parameters:

y - The world Y coordinate.

Returns:

The screen coordinate.

screenToX

public double screenToX(int x)

Convert a screen X coordinate to a world coordinate.

Parameters:

x - The screen X coordinate.

Returns:

The world coordinate.

screenToY

public double screenToY(int y)

Convert a screen Y coordinate to a world coordinate.

Parameters:

y - The screen Y coordinate.

Returns:

The world coordinate.