org.gicentre.geomap

Class Point

java.lang.Object

org.gicentre.geomap.Point

All Implemented Interfaces:

Feature

public class Point
extends java.lang.Object
implements Feature

Class for representing and drawing a point feature.

Version:

1.3, 4th March, 2017.

Author:

Jo Wood , giCentre, City University of London.

Constructor Summary

Constructors

Constructor and Description
Point(float x, float y, float z, processing.core.PApplet parent) Constructs a new point object with the given 3d geometry.
Point(float x, float y, processing.core.PApplet parent) Constructs a new point object with the given 2d geometry.

Method Summary

Modifier and Type	Method and Description
boolean	contains(float x, float y) Tests whether the given location matches this point.
void	draw(Geographic transformer) Draws the point in the parent sketch.
processing.core.PVector	getCoords() Reports the coordinates of the point feature.
int	getNumVertices() Reports the number of vertices that make up the point definition.
FeatureType	getType() Report the type of feature (point).
void	setRenderer(Drawable renderer) Sets the renderer to be used for drawing this feature.
static void	setTolerance(float tolerance) Sets the tolerance values used for contains() testing.

Methods inherited from class java.lang.Object

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

Constructor Detail

Point

public Point(float x,
             float y,
             processing.core.PApplet parent)

Constructs a new point object with the given 2d geometry.

Parameters:

x - x coordinates of the point.

y - y coordinates of the point.

parent - The parent sketch.

Point

public Point(float x,
             float y,
             float z,
             processing.core.PApplet parent)

Constructs a new point object with the given 3d geometry.

Parameters:

x - x coordinates of the point.

y - y coordinates of the point.

z - z coordinates of the point.

parent - The parent sketch.

Method Detail

getNumVertices

public int getNumVertices()

Reports the number of vertices that make up the point definition.

Specified by:

getNumVertices in interface Feature

Returns:

number of vertices that make up the point. This will always be 1.

getType

public FeatureType getType()

Report the type of feature (point).

Specified by:

getType in interface Feature

Returns:

Type of feature

getCoords

public processing.core.PVector getCoords()

Reports the coordinates of the point feature.

Returns:

Coordinates of the point feature.

draw

public void draw(Geographic transformer)

Draws the point in the parent sketch.

Specified by:

draw in interface Feature

Parameters:

transformer - Class that handles the geographic to screen transformations.

setRenderer

public void setRenderer(Drawable renderer)

Sets the renderer to be used for drawing this feature. This need only be set if some non-default rendering is required (such as the sketchy rendering produced by the Handy library).

Specified by:

setRenderer in interface Feature

Parameters:

renderer - New renderer to use or null if default rendering is to be used.

setTolerance

public static void setTolerance(float tolerance)

Sets the tolerance values used for contains() testing. Any location within a distance of the given tolerance of this point is considered to be at the same location. Note that this method is static, meaning that a single tolerance value is shared by all point objects.

Parameters:

tolerance - Tolerance distance in the same units as the point's coordinates.

contains

public boolean contains(float x,
                        float y)

Tests whether the given location matches this point. Coordinates should be in the same geographic units as the point feature.

Specified by:

contains in interface Feature

Parameters:

x - x coordinate in geographic coordinates.

y - y coordinate in geographic coordinates.

Returns:

True if the given point matches this point, false if not.