org.pepsoft.worldpainter.util

Class GeometryUtil

java.lang.Object

org.pepsoft.worldpainter.util.GeometryUtil

public final class GeometryUtil
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GeometryUtil.AbsoluteVolumeVisitor
static interface	GeometryUtil.LineVisitor
static interface	GeometryUtil.PlaneVisitor
static interface	GeometryUtil.VolumeVisitor

Method Summary

Modifier and Type	Method and Description
static boolean	visitCircle(int radius, GeometryUtil.PlaneVisitor visitor) Visit all the points along the outline of a circle in an integer coordinate space with the centre at 0,0.
static boolean	visitFilledAbsoluteSphere(double x, double y, double z, float radius, GeometryUtil.AbsoluteVolumeVisitor visitor) Visit all the points in integer coordinate space inside a spherical volume in a floating point coordinate space with a specified center.
static boolean	visitFilledCircle(int radius, GeometryUtil.PlaneVisitor visitor) Visit all the points on the face of a filled circular disk in an integer coordinate space with the centre at 0,0.
static boolean	visitFilledSphere(int radius, GeometryUtil.VolumeVisitor visitor) Visit all the points inside a spherical volume in an integer coordinate space with the centre at 0,0,0.
static boolean	visitLine(int x1, int y1, int x2, int y2, GeometryUtil.LineVisitor visitor) Visit all the points along a straight line on a 2D plane.
static boolean	visitLine(int x1, int y1, int x2, int y2, int every, GeometryUtil.LineVisitor visitor) Visit all the points along a straight line on a 2D plane.

Methods inherited from class java.lang.Object

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

Method Detail

visitCircle

public static boolean visitCircle(int radius,
                                  GeometryUtil.PlaneVisitor visitor)

Visit all the points along the outline of a circle in an integer coordinate space with the centre at 0,0. The order in which the points are visited is not defined. The visitor may abort the process at any point by returning false.

Parameters:

radius - The radius of the circle to visit.

visitor - The visitor to invoke for each point.

Returns:

true if the visitor returned true for each point (and therefore every point was visited). false if the visitor returned false for some point and the process was aborted.

visitFilledCircle

public static boolean visitFilledCircle(int radius,
                                        GeometryUtil.PlaneVisitor visitor)

Visit all the points on the face of a filled circular disk in an integer coordinate space with the centre at 0,0. The order in which the points are visited is not defined. The visitor may abort the process at any point by returning false.

Parameters:

radius - The radius of the circle to visit.

visitor - The visitor to invoke for each point.

Returns:

true if the visitor returned true for each point (and therefore every point was visited). false if the visitor returned false for some point and the process was aborted.

visitFilledSphere

public static boolean visitFilledSphere(int radius,
                                        GeometryUtil.VolumeVisitor visitor)

Visit all the points inside a spherical volume in an integer coordinate space with the centre at 0,0,0. The order in which the points are visited is not defined. The visitor may abort the process at any point by returning false.

Parameters:

radius - The radius of the sphere to visit.

visitor - The visitor to invoke for each point.

Returns:

true if the visitor returned true for each point (and therefore every point was visited). false if the visitor returned false for some point and the process was aborted.

visitFilledAbsoluteSphere

public static boolean visitFilledAbsoluteSphere(double x,
                                                double y,
                                                double z,
                                                float radius,
                                                GeometryUtil.AbsoluteVolumeVisitor visitor)

Visit all the points in integer coordinate space inside a spherical volume in a floating point coordinate space with a specified center. The order in which the points are visited is not defined. The visitor may abort the process at any point by returning false.

Parameters:

x - The X coordinate of the center of the sphere

y - The Y coordinate of the center of the sphere

z - The Z coordinate of the center of the sphere

radius - The radius of the sphere to visit.

visitor - The visitor to invoke for each point.

Returns:

true if the visitor returned true for each point (and therefore every point was visited). false if the visitor returned false for some point and the process was aborted.

visitLine

public static boolean visitLine(int x1,
                                int y1,
                                int x2,
                                int y2,
                                GeometryUtil.LineVisitor visitor)

Visit all the points along a straight line on a 2D plane. The visitor may abort the process at any point by returning false.

Parameters:

x1 - The X coordinate of the start of the line.

y1 - The Y coordinate of the start of the line.

x2 - The X coordinate of the end of the line.

y2 - The Y coordinate of the end of the line.

visitor - The visitor to invoke for each point.

Returns:

true if the visitor returned true for each point (and therefore every point was visited). false if the visitor returned false for some point and the process was aborted.

visitLine

public static boolean visitLine(int x1,
                                int y1,
                                int x2,
                                int y2,
                                int every,
                                GeometryUtil.LineVisitor visitor)

Visit all the points along a straight line on a 2D plane. The visitor may abort the process at any point by returning false. Points on the line can optionally be skipped by specifying the every parameter larger than one.

Parameters:

x1 - The X coordinate of the start of the line.

y1 - The Y coordinate of the start of the line.

x2 - The X coordinate of the end of the line.

y2 - The Y coordinate of the end of the line.

every - The interval between performances of the specified task.

visitor - The visitor to invoke for each point.

Returns:

true if the visitor returned true for each point (and therefore every point was visited). false if the visitor returned false for some point and the process was aborted.