com.androidplot

Class Region

java.lang.Object

com.androidplot.Region

public class Region
extends java.lang.Object

A one dimensional region represented by a starting and ending value.

Constructor Summary

Constructors

Constructor and Description
Region()
Region(java.lang.Number v1, java.lang.Number v2)

Method Summary

Modifier and Type	Method and Description
java.lang.Number	center()
boolean	contains(java.lang.Number value) Tests whether a value is within the given range
java.lang.Number	getMax()
java.lang.Number	getMin()
void	intersect(Region input) The result of an intersect will always be an equal or smaller size region.
boolean	intersects(java.lang.Number line2Min, java.lang.Number line2Max) Tests whether this segment intersects another
boolean	intersects(Region region)
boolean	isDefined()
boolean	isMaxSet()
boolean	isMinSet()
java.lang.Number	length()
static java.lang.Number	measure(java.lang.Number v1, java.lang.Number v2)
double	ratio(double min, double max)
java.lang.Number	ratio(Region r2)
void	setMax(java.lang.Number max)
void	setMin(java.lang.Number min)
void	setMinMax(Region region)
java.lang.String	toString()
double	transform(double value, double min, double max, boolean flip)
java.lang.Number	transform(double value, Region region2) Transform a value relative to this region into it's corresponding value relative to the specified region.
java.lang.Number	transform(double value, Region region2, boolean flip)
void	union(java.lang.Number value)
void	union(Region input) Compares the input bounds min/max against this instance's current min/max.
static Region	withDefaults(Region defaults)

Methods inherited from class java.lang.Object

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

Constructor Detail

Region

public Region()

Region

public Region(java.lang.Number v1,
              java.lang.Number v2)

Method Detail

withDefaults

public static Region withDefaults(Region defaults)

setMinMax

public void setMinMax(Region region)

measure

public static java.lang.Number measure(java.lang.Number v1,
                                       java.lang.Number v2)

Parameters:

v1 -

v2 -

Returns:

The distance between val1 and val2 or null if either parameters are null.

Since:

0.9.7

length

public java.lang.Number length()

contains

public boolean contains(java.lang.Number value)

Tests whether a value is within the given range

Parameters:

value -

Returns:

intersects

public boolean intersects(Region region)

center

public java.lang.Number center()

Returns:

Middle value within this region

transform

public java.lang.Number transform(double value,
                                  Region region2)

Transform a value relative to this region into it's corresponding value relative to the specified region.

Parameters:

value -

region2 -

Returns:

transform

public java.lang.Number transform(double value,
                                  Region region2,
                                  boolean flip)

transform

public double transform(double value,
                        double min,
                        double max,
                        boolean flip)

ratio

public java.lang.Number ratio(Region r2)

ratio

public double ratio(double min,
                    double max)

Parameters:

min -

max -

Returns:

length of this series divided by the length of the distance between min and max.

union

public void union(java.lang.Number value)

union

public void union(Region input)

Compares the input bounds min/max against this instance's current min/max. 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 of a union will always be an equal or larger size region.

Parameters:

input -

intersect

public void intersect(Region input)

The result of an intersect will always be an equal or smaller size region.

Parameters:

input -

intersects

public boolean intersects(java.lang.Number line2Min,
                          java.lang.Number line2Max)

Tests whether this segment intersects another

Parameters:

line2Min -

line2Max -

Returns:

isMinSet

public boolean isMinSet()

getMin

public java.lang.Number getMin()

setMin

public void setMin(java.lang.Number min)

isMaxSet

public boolean isMaxSet()

getMax

public java.lang.Number getMax()

setMax

public void setMax(java.lang.Number max)

isDefined

public boolean isDefined()

Returns:

True if both min and max values are non-null, false otherwise. Does *not* consider defaults.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object