com.androidplot.xy

Class RectRegion

java.lang.Object

com.androidplot.xy.RectRegion

public class RectRegion
extends Object

RectRegion is just a rectangle with additional methods for determining intersections with other RectRegion instances. RectRegion operates on "native units" which are simply whatever unit type is passed into it by the user.

Constructor Summary

Constructors

Constructor and Description
RectRegion()
RectRegion(Number minX, Number maxX, Number minY, Number maxY)
RectRegion(Number minX, Number maxX, Number minY, Number maxY, String label)
RectRegion(android.graphics.RectF rect)
RectRegion(XYCoords min, XYCoords max)

Method Summary

Modifier and Type	Method and Description
android.graphics.RectF	asRectF()
boolean	contains(Number x, Number y) True if this region contains the specified coordinates.
Number	getHeight()
String	getLabel()
Number	getMaxX()
Number	getMaxY()
Number	getMinX()
Number	getMinY()
Number	getWidth()
Region	getxRegion()
Region	getyRegion()
void	intersect(RectRegion clippingBounds) The result of an intersect is always a RectRegion with an equal or smaller area.
List<RectRegion>	intersects(List<RectRegion> regions) Returns a list of XYRegions that either completely or partially intersect the area defined by params.
boolean	intersects(Number minX, Number maxX, Number minY, Number maxY) Tests whether this region intersects the region defined by params.
boolean	intersects(RectRegion region)
boolean	isFullyDefined()
boolean	isMaxXSet()
boolean	isMaxYSet()
boolean	isMinXSet()
boolean	isMinYSet()
void	set(Number minX, Number maxX, Number minY, Number maxY)
void	setLabel(String label)
void	setMaxX(Number maxX)
void	setMaxY(Number maxY)
void	setMinX(Number minX)
void	setMinY(Number minY)
void	setxRegion(Region xRegion)
void	setyRegion(Region yRegion)
String	toString()
android.graphics.PointF	transform(Number x, Number y, android.graphics.RectF region2, boolean flipX, boolean flipY)
XYCoords	transform(Number x, Number y, RectRegion region2)
XYCoords	transform(Number x, Number y, RectRegion region2, boolean flipX, boolean flipY)
void	transform(android.graphics.PointF result, Number x, Number y, android.graphics.RectF region2, boolean flipX, boolean flipY)
RectRegion	transform(RectRegion r, RectRegion r2, boolean flipX, boolean flipY) Transform a region (r) from the current region space (this) into the specified one (r2)
android.graphics.PointF	transform(XYCoords value, android.graphics.RectF region2, boolean flipX, boolean flipY) Convenience method to transform into screen coordinate space.
XYCoords	transform(XYCoords value, RectRegion region2)
android.graphics.PointF	transformScreen(Number x, Number y, android.graphics.RectF region2) Convenience method to transform into screen coordinate space.
void	transformScreen(android.graphics.PointF result, Number x, Number y, android.graphics.RectF region2)
android.graphics.PointF	transformScreen(XYCoords value, android.graphics.RectF region2)
void	union(Number x, Number y)
void	union(RectRegion input) Compares the input bounds xy min/max vals against this instance's current xy min/max vals.
static RectRegion	withDefaults(RectRegion defaults)

Methods inherited from class java.lang.Object

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

Constructor Detail

RectRegion

public RectRegion()

RectRegion

public RectRegion(XYCoords min,
                  XYCoords max)

RectRegion

public RectRegion(Number minX,
                  Number maxX,
                  Number minY,
                  Number maxY,
                  String label)

Parameters:

minX -

maxX -

minY -

maxY -

RectRegion

public RectRegion(android.graphics.RectF rect)

RectRegion

public RectRegion(Number minX,
                  Number maxX,
                  Number minY,
                  Number maxY)

Method Detail

withDefaults

public static RectRegion withDefaults(RectRegion defaults)

transform

public XYCoords transform(Number x,
                          Number y,
                          RectRegion region2,
                          boolean flipX,
                          boolean flipY)

transform

public XYCoords transform(Number x,
                          Number y,
                          RectRegion region2)

transform

public XYCoords transform(XYCoords value,
                          RectRegion region2)

transform

public RectRegion transform(RectRegion r,
                            RectRegion r2,
                            boolean flipX,
                            boolean flipY)

Transform a region (r) from the current region space (this) into the specified one (r2)

Parameters:

r - The region to which the transformation applies

r2 - The region into which r is being transformed

Returns:

transformScreen

public android.graphics.PointF transformScreen(Number x,
                                               Number y,
                                               android.graphics.RectF region2)

Convenience method to transform into screen coordinate space. Equivalent to invoking transform(Number, Number, RectF, boolean, boolean) with flipX = false and flipY = true.

Parameters:

x -

y -

region2 -

Returns:

transformScreen

public void transformScreen(android.graphics.PointF result,
                            Number x,
                            Number y,
                            android.graphics.RectF region2)

transform

public void transform(android.graphics.PointF result,
                      Number x,
                      Number y,
                      android.graphics.RectF region2,
                      boolean flipX,
                      boolean flipY)

transform

public android.graphics.PointF transform(Number x,
                                         Number y,
                                         android.graphics.RectF region2,
                                         boolean flipX,
                                         boolean flipY)

transformScreen

public android.graphics.PointF transformScreen(XYCoords value,
                                               android.graphics.RectF region2)

transform

public android.graphics.PointF transform(XYCoords value,
                                         android.graphics.RectF region2,
                                         boolean flipX,
                                         boolean flipY)

Convenience method to transform into screen coordinate space. Equivalent to invoking transform(XYCoords, RectF, boolean, boolean) with flipX = false and flipY = true.

Parameters:

value -

region2 -

flipX -

flipY -

Returns:

union

public void union(Number x,
                  Number y)

union

public void union(RectRegion input)

Compares the input bounds xy min/max vals against this instance's current xy min/max vals. If the input.min is less than this.min then this.min will be set to input.min. If the input.max is greater than this.max then this.max will be set to input.max The result will always have equal or greater area than the inputs.

Parameters:

input -

intersects

public boolean intersects(RectRegion region)

intersects

public boolean intersects(Number minX,
                          Number maxX,
                          Number minY,
                          Number maxY)

Tests whether this region intersects the region defined by params. Use null to represent infinity. Negative and positive infinity is implied by the boundary edge, ie. a maxX of null equals positive infinity while a minX of null equals negative infinity.

Parameters:

minX -

maxX -

minY -

maxY -

Returns:

asRectF

public android.graphics.RectF asRectF()

intersect

public void intersect(RectRegion clippingBounds)

The result of an intersect is always a RectRegion with an equal or smaller area.

Parameters:

clippingBounds -

intersects

public List<RectRegion> intersects(List<RectRegion> regions)

Returns a list of XYRegions that either completely or partially intersect the area defined by params. A null value for any parameter represents infinity / no boundary.

Parameters:

regions - The list of regions to search through

Returns:

getWidth

public Number getWidth()

Returns:

Width of this region, in native units

getHeight

public Number getHeight()

Returns:

Height of this region, in native units

set

public void set(Number minX,
                Number maxX,
                Number minY,
                Number maxY)

isMinXSet

public boolean isMinXSet()

getMinX

public Number getMinX()

setMinX

public void setMinX(Number minX)

isMaxXSet

public boolean isMaxXSet()

getMaxX

public Number getMaxX()

setMaxX

public void setMaxX(Number maxX)

isMinYSet

public boolean isMinYSet()

getMinY

public Number getMinY()

setMinY

public void setMinY(Number minY)

isMaxYSet

public boolean isMaxYSet()

getMaxY

public Number getMaxY()

setMaxY

public void setMaxY(Number maxY)

getLabel

public String getLabel()

setLabel

public void setLabel(String label)

getxRegion

public Region getxRegion()

setxRegion

public void setxRegion(Region xRegion)

getyRegion

public Region getyRegion()

setyRegion

public void setyRegion(Region yRegion)

isFullyDefined

public boolean isFullyDefined()

Returns:

True if both xRegion and yRegion are defined, false otherwise

contains

public boolean contains(Number x,
                        Number y)

True if this region contains the specified coordinates.

Parameters:

x -

y -

Returns:

toString

public String toString()

Overrides:

toString in class Object