lecho.lib.hellocharts.model

Class Viewport

java.lang.Object

lecho.lib.hellocharts.model.Viewport

All Implemented Interfaces:

android.os.Parcelable

public class Viewport
extends java.lang.Object
implements android.os.Parcelable

Partial copy of android.graphics.Rect but here the top should be greater then the bottom. Viewport holds 4 float coordinates for a chart extremes. The viewport is represented by the coordinates of its 4 edges (left, top, right bottom). These fields can be accessed directly. Use width() and height() to retrieve the viewport's width and height. Note: most methods do not check to see that the coordinates are sorted correctly (i.e. left is less than right and bottom is less than top). Viewport implements Parcerable.

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
float	bottom
static android.os.Parcelable.Creator<Viewport>	CREATOR
float	left
float	right
float	top

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
Viewport() Create a new empty Viewport.
Viewport(float left, float top, float right, float bottom) Create a new viewport with the specified coordinates.
Viewport(Viewport v) Create a new viewport, initialized with the values in the specified viewport (which is left unmodified).

Method Summary

Modifier and Type	Method and Description
float	centerX()
float	centerY()
boolean	contains(float x, float y) Returns true if (x,y) is inside the viewport.
boolean	contains(float left, float top, float right, float bottom) Returns true iff the 4 specified sides of a viewport are inside or equal to this viewport.
boolean	contains(Viewport v) Returns true iff the specified viewport r is inside or equal to this viewport.
int	describeContents() Parcelable interface methods
boolean	equals(java.lang.Object obj)
int	hashCode()
float	height()
void	inset(float dx, float dy) Inset the viewport by (dx,dy).
boolean	intersect(float left, float top, float right, float bottom) If the viewport specified by left,top,right,bottom intersects this viewport, return true and set this viewport to that intersection, otherwise return false and do not change this viewport.
boolean	intersect(Viewport v) If the specified viewport intersects this viewport, return true and set this viewport to that intersection, otherwise return false and do not change this viewport.
boolean	isEmpty() Returns true if the viewport is empty left >= right or bottom >= top
void	offset(float dx, float dy) Offset the viewport by adding dx to its left and right coordinates, and adding dy to its top and bottom coordinates.
void	offsetTo(float newLeft, float newTop) Offset the viewport to a specific (left, top) position, keeping its width and height the same.
void	readFromParcel(android.os.Parcel in) Set the viewport's coordinates from the data stored in the specified parcel.
void	set(float left, float top, float right, float bottom) Set the viewport's coordinates to the specified values.
void	set(Viewport src) Copy the coordinates from src into this viewport.
void	setEmpty() Set the viewport to (0,0,0,0)
java.lang.String	toString()
void	union(float left, float top, float right, float bottom) Update this Viewport to enclose itself and the specified viewport.
void	union(Viewport v) Update this Viewport to enclose itself and the specified viewport.
float	width()
void	writeToParcel(android.os.Parcel out, int flags) Write this viewport to the specified parcel.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

left

public float left

top

public float top

right

public float right

bottom

public float bottom

CREATOR

public static final android.os.Parcelable.Creator<Viewport> CREATOR

Constructor Detail

Viewport

public Viewport()

Create a new empty Viewport. All coordinates are initialized to 0.

Viewport

public Viewport(float left,
                float top,
                float right,
                float bottom)

Create a new viewport with the specified coordinates. Note: no range checking is performed, so the caller must ensure that left is less than right and bottom is less than top.

Parameters:

left - The X coordinate of the left side of the viewport

top - The Y coordinate of the top of the viewport

right - The X coordinate of the right side of the viewport

bottom - The Y coordinate of the bottom of the viewport

Viewport

public Viewport(Viewport v)

Create a new viewport, initialized with the values in the specified viewport (which is left unmodified).

Parameters:

v - The viewport whose coordinates are copied into the new viewport.

Method Detail

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

isEmpty

public final boolean isEmpty()

Returns true if the viewport is empty left >= right or bottom >= top

setEmpty

public void setEmpty()

Set the viewport to (0,0,0,0)

width

public final float width()

Returns:

the viewport's width. This does not check for a valid viewport (i.e. left <= right) so the result may be negative.

height

public final float height()

Returns:

the viewport's height. This does not check for a valid viewport (i.e. top <= bottom) so the result may be negative.

centerX

public final float centerX()

Returns:

the horizontal center of the viewport. This does not check for a valid viewport (i.e. left <= right)

centerY

public final float centerY()

Returns:

the vertical center of the viewport. This does not check for a valid viewport (i.e. bottom <= top)

set

public void set(float left,
                float top,
                float right,
                float bottom)

Set the viewport's coordinates to the specified values. Note: no range checking is performed, so it is up to the caller to ensure that left <= right and bottom <= top.

Parameters:

left - The X coordinate of the left side of the viewport

top - The Y coordinate of the top of the viewport

right - The X coordinate of the right side of the viewport

bottom - The Y coordinate of the bottom of the viewport

set

public void set(Viewport src)

Copy the coordinates from src into this viewport.

Parameters:

src - The viewport whose coordinates are copied into this viewport.

offset

public void offset(float dx,
                   float dy)

Offset the viewport by adding dx to its left and right coordinates, and adding dy to its top and bottom coordinates.

Parameters:

dx - The amount to add to the viewport's left and right coordinates

dy - The amount to add to the viewport's top and bottom coordinates

offsetTo

public void offsetTo(float newLeft,
                     float newTop)

Offset the viewport to a specific (left, top) position, keeping its width and height the same.

Parameters:

newLeft - The new "left" coordinate for the viewport

newTop - The new "top" coordinate for the viewport

inset

public void inset(float dx,
                  float dy)

Inset the viewport by (dx,dy). If dx is positive, then the sides are moved inwards, making the viewport narrower. If dx is negative, then the sides are moved outwards, making the viewport wider. The same holds true for dy and the top and bottom.

Parameters:

dx - The amount to add(subtract) from the viewport's left(right)

dy - The amount to add(subtract) from the viewport's top(bottom)

contains

public boolean contains(float x,
                        float y)

Returns true if (x,y) is inside the viewport. The left and top are considered to be inside, while the right and bottom are not. This means that for a x,y to be contained: left <= x < right and bottom <= y < top. An empty viewport never contains any point.

Parameters:

x - The X coordinate of the point being tested for containment

y - The Y coordinate of the point being tested for containment

Returns:

true iff (x,y) are contained by the viewport, where containment means left <= x < right and top <= y < bottom

contains

public boolean contains(float left,
                        float top,
                        float right,
                        float bottom)

Returns true iff the 4 specified sides of a viewport are inside or equal to this viewport. i.e. is this viewport a superset of the specified viewport. An empty viewport never contains another viewport.

Parameters:

left - The left side of the viewport being tested for containment

top - The top of the viewport being tested for containment

right - The right side of the viewport being tested for containment

bottom - The bottom of the viewport being tested for containment

Returns:

true iff the the 4 specified sides of a viewport are inside or equal to this viewport

contains

public boolean contains(Viewport v)

Returns true iff the specified viewport r is inside or equal to this viewport. An empty viewport never contains another viewport.

Parameters:

v - The viewport being tested for containment.

Returns:

true iff the specified viewport r is inside or equal to this viewport

union

public void union(float left,
                  float top,
                  float right,
                  float bottom)

Update this Viewport to enclose itself and the specified viewport. If the specified viewport is empty, nothing is done. If this viewport is empty it is set to the specified viewport.

Parameters:

left - The left edge being unioned with this viewport

top - The top edge being unioned with this viewport

right - The right edge being unioned with this viewport

bottom - The bottom edge being unioned with this viewport

union

public void union(Viewport v)

Update this Viewport to enclose itself and the specified viewport. If the specified viewport is empty, nothing is done. If this viewport is empty it is set to the specified viewport.

Parameters:

v - The viewport being unioned with this viewport

intersect

public boolean intersect(float left,
                         float top,
                         float right,
                         float bottom)

If the viewport specified by left,top,right,bottom intersects this viewport, return true and set this viewport to that intersection, otherwise return false and do not change this viewport. No check is performed to see if either viewport is empty. Note: To just test for intersection, use intersects()

Parameters:

left - The left side of the viewport being intersected with this viewport

top - The top of the viewport being intersected with this viewport

right - The right side of the viewport being intersected with this viewport.

bottom - The bottom of the viewport being intersected with this viewport.

Returns:

true if the specified viewport and this viewport intersect (and this viewport is then set to that intersection) else return false and do not change this viewport.

intersect

public boolean intersect(Viewport v)

If the specified viewport intersects this viewport, return true and set this viewport to that intersection, otherwise return false and do not change this viewport. No check is performed to see if either viewport is empty. To just test for intersection, use intersects()

Parameters:

v - The viewport being intersected with this viewport.

Returns:

true if the specified viewport and this viewport intersect (and this viewport is then set to that intersection) else return false and do not change this viewport.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

describeContents

public int describeContents()

Parcelable interface methods

Specified by:

describeContents in interface android.os.Parcelable

writeToParcel

public void writeToParcel(android.os.Parcel out,
                          int flags)

Write this viewport to the specified parcel. To restore a viewport from a parcel, use readFromParcel()

Specified by:

writeToParcel in interface android.os.Parcelable

Parameters:

out - The parcel to write the viewport's coordinates into

readFromParcel

public void readFromParcel(android.os.Parcel in)

Set the viewport's coordinates from the data stored in the specified parcel. To write a viewport to a parcel, call writeToParcel().

Parameters:

in - The parcel to read the viewport's coordinates from