com.wowza.gocoder.sdk.api.geometry

Class WOWZPoint

java.lang.Object

com.wowza.gocoder.sdk.api.geometry.WOWZPoint

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<WOWZPoint>

public class WOWZPoint
extends java.lang.Object
implements java.lang.Comparable<WOWZPoint>, java.io.Serializable

The WOWZPoint class represents an integer-based two-dimensional coordinate. For example:

         WOWZPoint pt1 = new WOWZPoint(200, 300);
         WOWZPoint pt2 = new WOWZPoint(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
WOWZPoint() The default constructor.
WOWZPoint(int x, int y) Creates and intitalizes an instance using the specified property values.
WOWZPoint(WOWZPoint other) Creates and intitalizes an instance using the property values from the specified instance.

Method Summary

Modifier and Type	Method and Description
int	compareTo(int x, int y) Compares this property values of this instance with the specified values.
int	compareTo(WOWZPoint other) Compares 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(WOWZPoint other) Calculates the distance between this point and the specified instance.
boolean	equals(int x, int y) Compares the property values of this instance with the specified values for equality.
boolean	equals(int x1, int y1, int x2, int y2) Compares two points for equality.
boolean	equals(java.lang.Object other) Compares this instance with the specified instance for equality.
int	getX()
int	getY()
void	invert() Inverts the coordinate values of this instance.
WOWZPoint	inverted() Creates a version of this instance with the coordinate values reversed.
static java.lang.String	label(int x, int y) Gets a human-readable description of the specified values.
void	set(int x, int y) Updates the property values of this instance with the specified values.
void	set(WOWZPoint other) Updates the property values of this instance with the property values from the specified instance.
void	setX(int x) Updates the x coordinate property value.
void	setY(int y) Updates the y coordinate property value.
java.lang.String	toString() Gets 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

WOWZPoint

public WOWZPoint()

The default constructor.

WOWZPoint

public WOWZPoint(int x,
                 int y)

Creates and intitalizes an instance using the specified property values.

Parameters:

x - The value of the x coordinate.

y - The value of the y coordinate.

WOWZPoint

public WOWZPoint(WOWZPoint other)

Creates and intitalizes an instance using the property values from the specified instance.

Parameters:

other - The instance to use.

Method Detail

equals

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

Compares 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 if 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 java.lang.String label(int x,
                                     int y)

Gets a human-readable description of the specified values.

Returns:

A string representation of the values.

getX

public int getX()

Returns:

The value of the x coordinate.

setX

public void setX(int x)

Updates the x coordinate property value.

Parameters:

x - The value of the x coordinate.

getY

public int getY()

Returns:

The value of the y coordinate.

setY

public void setY(int y)

Updates the y coordinate property value.

Parameters:

y - The value of the y coordinate.

set

public void set(int x,
                int y)

Updates the property values of this instance with the specified values.

Parameters:

x - The value of the x coordinate.

y - The value of the y coordinate.

set

public void set(WOWZPoint other)

Updates the property values of this instance with the property values from the specified instance.

Parameters:

other - The instance with the property values to use.

equals

public boolean equals(int x,
                      int y)

Compares the property values of this instance with the specified values for equality.

Parameters:

x - The value of the x coordinate.

y - The value of the y coordinate.

Returns:

True if the values are equal; false otherwise.

equals

public boolean equals(java.lang.Object other)

Compares this instance with the specified instance for equality.

Overrides:

equals in class java.lang.Object

Parameters:

other - The instance to use for comparison.

Returns:

True if the instances are equal; false otherwise.

compareTo

public int compareTo(int x,
                     int y)

Compares this property values of this instance with the specified values.

Parameters:

x - The value of the x coordinate.

y - The value of 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(WOWZPoint other)

Compares this instance with the specified instance.

Specified by:

compareTo in interface java.lang.Comparable<WOWZPoint>

Parameters:

other - The instance to use for comparison.

Returns:

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

toString

public java.lang.String toString()

Gets a human-readable description of this instance.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this instance.

inverted

public WOWZPoint inverted()

Creates a version of this instance with the coordinate values reversed.

Returns:

An instance with the coordinate values reversed.

invert

public void invert()

Inverts 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 of the x coordinate.

y - The value of the y coordinate.

Returns:

The distance between this point and the specified values.

distanceTo

public double distanceTo(WOWZPoint 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.