net.avensome.dev.gnupolpot.api.plotter

Interface IViewport

public interface IViewport

Method Summary

Modifier and Type	Method and Description
void	centerAt(double x, double y) Changes viewport center.
boolean	contains(double plotX, double plotY)
boolean	containsHorizontalCoord(double xCoord)
boolean	containsVerticalCoord(double yCoord)
Point	fromScreenCoords(double screenX, double screenY) Translate point from screen coordinates to plot coordinates.
double	getBottom()
double	getHeight()
double	getLeft()
double	getRight()
double	getScale()
double	getTop()
double	getWidth()
void	moveBy(double deltaX, double deltaY) Moves viewport by a provided amount in both dimensions.
PlotPoint	pointAtPlotCoords(double x, double y, double radius, java.util.Collection<PlotPoint> points) Returns a point closest to provided coordinates within provided radius.
void	setScalePower(int power) Set scale to an absolute value
Point	toScreenCoords(double plotX, double plotY) Method opposite to fromScreenCoords(double, double).
Point	toScreenCoords(PlotPoint point) Convenience method that calls toScreenCoords(double, double).
java.util.Collection<PlotPoint>	visiblePoints(java.util.Collection<PlotPoint> points) Filters points by visibility.
void	zoom(double factor) Change viewport zoom.

Method Detail

getScale

double getScale()

getLeft

double getLeft()

getBottom

double getBottom()

getWidth

double getWidth()

getHeight

double getHeight()

getRight

double getRight()

getTop

double getTop()

centerAt

void centerAt(double x,
              double y)

Changes viewport center.

Parameters:

x - new X coordinate of center

y - new Y coordinate of center

moveBy

void moveBy(double deltaX,
            double deltaY)

Moves viewport by a provided amount in both dimensions.

Parameters:

deltaX - amount to move right

deltaY - amount to move up

zoom

void zoom(double factor)

Change viewport zoom.

Parameters:

factor - to multiply scale by

setScalePower

void setScalePower(int power)

Set scale to an absolute value

Parameters:

power - Scale power. 0 is 1:1 scale, increasing by 1 doubles scale.

containsHorizontalCoord

boolean containsHorizontalCoord(double xCoord)

Parameters:

xCoord - X coordinate

Returns:

Whether this coordinate is contained in viewport.

containsVerticalCoord

boolean containsVerticalCoord(double yCoord)

Parameters:

yCoord - Y coordinate

Returns:

Whether this coordinate is contained in viewport.

contains

boolean contains(double plotX,
                 double plotY)

Parameters:

plotX - X coordinate

plotY - Y coordinate

Returns:

Whether viewport contains point at these coordinates.

fromScreenCoords

Point fromScreenCoords(double screenX,
                       double screenY)

Translate point from screen coordinates to plot coordinates.

Screen uses down-pointing Y axis and its (0,0) coordinate is in the top left corner. Plot, on the other hand, has up-pointing Y axis and its (0,0) point isn't fixed. This method converts screen coordinates (eg. coordinates of a mouse click) to plot coordinates.

Parameters:

screenX - X coordinate in screen coordinate system

screenY - Y coordinate in screen coordinate system

Returns:

A point in plot coordinate system.

toScreenCoords

Point toScreenCoords(double plotX,
                     double plotY)

Method opposite to fromScreenCoords(double, double). See fromScreenCoords(double, double) for details.

Parameters:

plotX - X coordinate in plot coordinate system

plotY - Y coordinate in plot coordinate system

Returns:

A point in screen coordinate system.

toScreenCoords

Point toScreenCoords(PlotPoint point)

Convenience method that calls toScreenCoords(double, double).

Parameters:

point - a plot point

Returns:

Point's position in screen coordinate system

visiblePoints

java.util.Collection<PlotPoint> visiblePoints(java.util.Collection<PlotPoint> points)

Filters points by visibility.

Parameters:

points - a collection of points

Returns:

Points from provided collection that are contained in this viewport.

pointAtPlotCoords

PlotPoint pointAtPlotCoords(double x,
                            double y,
                            double radius,
                            java.util.Collection<PlotPoint> points)

Returns a point closest to provided coordinates within provided radius.

This method uses plot coordinates, use fromScreenCoords(double, double) to convert from screen (mouse) coordinates.

Parameters:

x - X plot coordinate to look at

y - Y plot coordinate to look at

radius - maximum allowed distance from (x,y) point

points - Collection of points to search

Returns:

PlotPoint from collection points closest to (x,y), or null if there are no points within radius