CPDFGeneration.android.graphics

Class PointI

java.lang.Object

CPDFGeneration.android.graphics.PointI

public class PointI
extends java.lang.Object

A 2D point with int coordinates.

This class is similar in spirit to Android's android.graphics.Point and provides basic point operations such as setting coordinates, negation, offsetting, equality checks, and computing vector length.

Field Summary

Fields

Modifier and Type	Field and Description
int	x X coordinate.
int	y Y coordinate.

Constructor Summary

Constructors

Constructor and Description
PointI() Creates a point at the origin (0, 0).
PointI(int x, int y) Creates a point with the specified coordinates.
PointI(PointI p) Copy constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(int x, int y) Returns whether this point's coordinates equal (x, y).
boolean	equals(java.lang.Object o) Indicates whether some other object is "equal to" this one.
int	hashCode() Returns a hash code value for this point.
float	length() Returns the Euclidean length of the vector from (0,0) to this point: hypot(x, y).
static float	length(int x, int y) Returns the Euclidean length of the vector from (0,0) to (x,y).
void	negate() Negates this point in place: (x, y) -> (-x, -y).
void	offset(float dx, float dy) Offsets this point in place by (dx, dy).
void	set(int x, int y) Sets this point's coordinates.
void	set(PointI p) Sets this point's coordinates to match another point.
java.lang.String	toString() Returns a string representation of this point.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

x

public int x

X coordinate.

y

public int y

Y coordinate.

Constructor Detail

PointI

public PointI()

Creates a point at the origin (0, 0).

PointI

public PointI(int x,
              int y)

Creates a point with the specified coordinates.

Parameters:

x - x coordinate

y - y coordinate

PointI

public PointI(PointI p)

Copy constructor. Creates a new PointI with the same coordinates as p.

Parameters:

p - the point to copy from

Throws:

java.lang.NullPointerException - if p is null

Method Detail

set

public final void set(int x,
                      int y)

Sets this point's coordinates.

Parameters:

x - new x coordinate

y - new y coordinate

set

public final void set(PointI p)

Sets this point's coordinates to match another point.

Parameters:

p - the source point

Throws:

java.lang.NullPointerException - if p is null

negate

public final void negate()

Negates this point in place: (x, y) -> (-x, -y).

offset

public final void offset(float dx,
                         float dy)

Offsets this point in place by (dx, dy).

Note: dx and dy are float and will be converted to int using Java's compound-assignment conversion rules (i.e. fractional parts are truncated).

Parameters:

dx - delta x

dy - delta y

equals

public final boolean equals(int x,
                            int y)

Returns whether this point's coordinates equal (x, y).

Parameters:

x - x coordinate to compare

y - y coordinate to compare

Returns:

true if both coordinates match; otherwise false

equals

public boolean equals(java.lang.Object o)

Indicates whether some other object is "equal to" this one.

Overrides:

equals in class java.lang.Object

Parameters:

o - the reference object with which to compare

Returns:

true if this object is equal to o; otherwise false

hashCode

public int hashCode()

Returns a hash code value for this point.

Overrides:

hashCode in class java.lang.Object

Returns:

hash code

toString

public java.lang.String toString()

Returns a string representation of this point.

Overrides:

toString in class java.lang.Object

Returns:

string representation in the form PointI(x, y)

length

public final float length()

Returns the Euclidean length of the vector from (0,0) to this point: hypot(x, y).

Returns:

vector length

length

public static float length(int x,
                           int y)

Returns the Euclidean length of the vector from (0,0) to (x,y).

Parameters:

x - x component

y - y component

Returns:

vector length