com.wowza.gocoder.sdk.api.geometry

Class WZPoint

java.lang.Object

com.wowza.gocoder.sdk.api.geometry.WZPoint

All Implemented Interfaces:

Serializable, Comparable<WZPoint>

public class WZPoint
extends Object
implements Comparable<WZPoint>, Serializable

The WZPoint class represents an integer-based two-dimensional coordinate.

Usage example:

         WZPoint pt1 = new WZPoint(200, 300);
         WZPoint pt2 = new WZPoint(287, 543);
         double distanceApart = pt1.distanceTo(pt2);
     

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
int	x The x coordinate of the point
int	y The y coordinate of the point

Constructor Summary

Constructors

Constructor and Description
WZPoint() The default constructor
WZPoint(int x, int y) Construct a new instance using the specified property values
WZPoint(WZPoint other) Construct a new instance using the property values from the specified instance

Method Summary

Modifier and Type	Method and Description
int	compareTo(int x, int y) Compare this property values of this instance with the specified values
int	compareTo(WZPoint other) Compare this instance with the specified instance
static double	distance(int x1, int y1, int x2, int y2) Calculates the distance between two points
double	distanceTo(int x, int y) Calculates the distance between this point and the specified values
double	distanceTo(WZPoint other) Calculates the distance between this point and the specified instance
boolean	equals(int x, int y) Compare the property values of this instance with the specified values for equality
boolean	equals(int x1, int y1, int x2, int y2) Compare two points for equality
boolean	equals(Object other) Compare this instance with the specified instance for equality
int	getX()
int	getY()
void	invert() Invert the coordinate values of this instance
WZPoint	inverted() Create a new "inverted" version of this instance with the coordinate values reversed
static String	label(int x, int y) Returns a human-readable description of the specified values
void	set(int x, int y) Update the property values of this instance with the specified values
void	set(WZPoint other) Update the property values of this instance with the property values from the specified instance
void	setX(int x) Update the x coordinate property value
void	setY(int y) Update the y coordinate property value
String	toString() Returns a human-readable description of this instance

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

x

public int x

The x coordinate of the point

y

public int y

The y coordinate of the point

Constructor Detail

WZPoint

public WZPoint()

The default constructor

WZPoint

public WZPoint(int x,
               int y)

Construct a new instance using the specified property values

Parameters:

x - The value for the x coordinate

y - The value fot the y coordinate

WZPoint

public WZPoint(WZPoint other)

Construct a new instance using the property values from the specified instance

Parameters:

other - The instance to replicate

Method Detail

equals

public boolean equals(int x1,
                      int y1,
                      int x2,
                      int y2)

Compare two points for equality

Parameters:

x1 - The x coordinate of the first point

y1 - The y coordinate of the first point

x2 - The x coordinate of the second point

y2 - The y coordinate of the second point

Returns:

true is the points are equal, false otherwise

distance

public static double distance(int x1,
                              int y1,
                              int x2,
                              int y2)

Calculates the distance between two points

Parameters:

x1 - The x coordinate of the first point

y1 - The y coordinate of the first point

x2 - The x coordinate of the second point

y2 - The y coordinate of the second point

Returns:

The distance between the two points

label

public static String label(int x,
                           int y)

Returns a human-readable description of the specified values

Returns:

A string representation of the specified values

getX

public int getX()

Returns:

The value for the x coordinate

setX

public void setX(int x)

Update the x coordinate property value

Parameters:

x - The value for the x coordinate

getY

public int getY()

Returns:

The value for the y coordinate

setY

public void setY(int y)

Update the y coordinate property value

Parameters:

y - The value for the y coordinate

set

public void set(int x,
                int y)

Update the property values of this instance with the specified values

Parameters:

x - The value for the x coordinate

y - The value for the y coordinate

set

public void set(WZPoint other)

Update the property values of this instance with the property values from the specified instance

Parameters:

other - The instance with the property values to replicate

equals

public boolean equals(int x,
                      int y)

Compare the property values of this instance with the specified values for equality

Parameters:

x - The value for the x coordinate

y - The value for the y coordinate

Returns:

true> is the values are equal, false> otherwise

equals

public boolean equals(Object other)

Compare this instance with the specified instance for equality

Overrides:

equals in class Object

Parameters:

other - The instance to be used for comparison

Returns:

true> is the instances are equal, false> otherwise

compareTo

public int compareTo(int x,
                     int y)

Compare this property values of this instance with the specified values

Parameters:

x - The value for the x coordinate

y - The value for the y coordinate

Returns:

-1 if the properties of this instance are less than the specified values, 0 if equal, or 1 if greater

compareTo

public int compareTo(WZPoint other)

Compare this instance with the specified instance

Specified by:

compareTo in interface Comparable<WZPoint>

Parameters:

other - The instance to be used for comparison

Returns:

-1 if this instance is less than the specified instance, 0 if equal, or 1 if greater

toString

public String toString()

Returns a human-readable description of this instance

Overrides:

toString in class Object

Returns:

A string representation of this instance

inverted

public WZPoint inverted()

Create a new "inverted" version of this instance with the coordinate values reversed

Returns:

A new instance with the coordinate values reversed

invert

public void invert()

Invert the coordinate values of this instance

distanceTo

public double distanceTo(int x,
                         int y)

Calculates the distance between this point and the specified values

Parameters:

x - The value for the x coordinate

y - The value for the y coordinate

Returns:

The distance between this point and the specified values

distanceTo

public double distanceTo(WZPoint other)

Calculates the distance between this point and the specified instance

Parameters:

other - The instance to use for the calculation

Returns:

The distance between this point and the specified instance