com.wowza.gocoder.sdk.api.geometry

Class WOWZSize

java.lang.Object

com.wowza.gocoder.sdk.api.geometry.WOWZSize

All Implemented Interfaces:

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

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

The WOWZSize class represents a dimension with integer-based width and height values. For example:

         WOWZSize frameSize = WOWZSize(1280, 720);
         float aspectRatio = frameSize.aspectRatio();
     

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WOWZSize.ScaledDimensions ScaledDimensions is a utility class representing common scaling operations when placing one rectangular area (the source) in another (the destination).

Field Summary

Fields

Modifier and Type	Field and Description
int	height The height value.
int	width The width value.

Constructor Summary

Constructors

Constructor and Description
WOWZSize() The default constructor.
WOWZSize(int width, int height) Creates and initializes an instance using the specified property values.
WOWZSize(WOWZSize other) Creates and initializes an instance using the property values from the specified instance.

Method Summary

Modifier and Type	Method and Description
static WOWZSize	absOffset(int w1, int h1, int w2, int h2) Calculates the offset between two dimensions.
WOWZSize	absOffsetFrom(WOWZSize other) Calculates the offset between the width and height values from this instance and the specified instance.
double	area() Calculates the area of a rectangle with the width and height of this instance.
double	area(int w, int h)
WOWZSize	asLandscape() Creates an instance whose width is greater than or equal to its height.
static WOWZSize	asLandscape(int width, int height) Creates an instance whose width is greater than or equal to its height.
float	aspectRatio() Calculates the aspect ratio (width / height) of this instance.
static float	aspectRatio(int width, int height) Calculates an aspect ratio (width / height).
java.lang.String	aspectRatioLabel() Gets a string representation of the aspect ratio of this dimension.
static java.lang.String	aspectRatioLabel(int width, int height) Gets an aspect ratio as a string, for example, 16:9.
WOWZSize	asPortrait() Creates an instance whose width is less than or equal to its height.
static WOWZSize	asPortrait(int width, int height) Creates an instance whose width is less than or equal to its height.
WOWZPoint	center() Calculates the center point of a zero-based rectangle with the width and height of this instance.
WOWZPoint	center(int width, int height) Calculates the center point of the rectangular region with the specified dimensions.
WOWZSize.ScaledDimensions	center(WOWZSize other) Calculates the offset of this instance from the destination after centering it in the destination.
static WOWZSize	closestTo(int width, int height, WOWZSize[] others) Gets the instance from the specified array that is greater than and closest in size to the specified dimension values.
static WOWZSize	closestTo(WOWZSize src, WOWZSize[] others) Gets the instance from the specified array that is greater than and closest in size to the specified instance.
static int	closestToIndex(int width, int height, WOWZSize[] others) Gets the index of the instance from the specified array that is greater than and closest in size to the specified dimension values.
static int	closestToIndex(WOWZSize src, WOWZSize[] others) Gets the index of the instance from the specified array that is greater than and closest in size to the specified instance.
int	compareTo(int width, int height) Compares the property values of this instance with the specified values.
int	compareTo(WOWZSize other) Compares this instance with the specified instance.
boolean	equals(int width, int height) Compares the property values of this instance with the specified values for equality.
boolean	equals(int w1, int h1, int w2, int h2) Compares two dimensions for equality.
boolean	equals(java.lang.Object other) Compares this instance with the specified instance for equality.
boolean	equalsAspect(int width, int height) Compares the aspect ratio of this instance with the aspect ratio of the specified width and height.
static boolean	equalsAspect(int w1, int h1, int w2, int h2) Compares the aspect ratios of two dimensions for equality.
boolean	equalsAspect(WOWZSize other) Compares the aspect ratio of this instance with another instance.
static boolean	equalsAspect(WOWZSize s1, WOWZSize s2) Compares the aspect ratios of two WOWZSize instances for equality.
static WOWZSize[]	filterByAspectRatio(WOWZSize[] sizes, WOWZSize srcSize) Filters an array of sizes by those that match the aspect ratio of a specified size.
static WOWZSize[]	findContainers(WOWZSize[] srcSizes, WOWZSize minSize) Filters an array of sizes by those that are equal to or larger than a specified minimum size.
boolean	fitsWithin(WOWZSize other) Compares this instance with the specified instance to see if it is smaller.
int	getHeight()
int	getWidth()
void	invert() Inverts the coordinate values of this instance.
WOWZSize	inverted() Creates a version of this instance with the width and height values reversed.
boolean	isLandscape()
static boolean	isLandscape(int width, int height)
boolean	isPortrait()
static boolean	isPortrait(int width, int height)
boolean	isSquare()
static boolean	isSquare(int width, int height)
boolean	isZero()
static boolean	isZero(int width, int height)
static java.lang.String	label(int width, int height) Gets a human-readable description of the specified values.
boolean	largerThan(WOWZSize other) Compares this instance with the specified instance to see if it is larger.
int	longDimension()
static int	longDimension(int width, int height)
static WOWZSize	offset(int w1, int h1, int w2, int h2) Calculates the offset between two dimensions.
WOWZSize	offsetFrom(WOWZSize other) Calculates the offset between the width and height from this instance and the specified instance.
WOWZSize.ScaledDimensions	scaleWithCrop(WOWZSize other) Calculates the dimensions of this instance after scaling it so that it fits entirely in the specified instance, preserving the aspect ratio.
WOWZSize.ScaledDimensions	scaleWithFill(WOWZSize other) Calculates the dimensions of this instance after scaling it so that it fills the specified instance, preserving the aspect ratio.
void	set(int width, int height) Updates the property values of this instance with the specified values.
void	set(WOWZSize other) Updates the property values of this instance with the property values from the specified instance.
void	setHeight(int height) Updates the height value.
void	setWidth(int width) Updates the width 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

width

public int width

The width value.

height

public int height

The height value.

Constructor Detail

WOWZSize

public WOWZSize()

The default constructor.

WOWZSize

public WOWZSize(int width,
                int height)

Creates and initializes an instance using the specified property values.

Parameters:

width - The width value.

height - The height value.

WOWZSize

public WOWZSize(WOWZSize other)

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

Parameters:

other - The instance to use.

Method Detail

equals

public boolean equals(int w1,
                      int h1,
                      int w2,
                      int h2)

Compares two dimensions for equality.

Parameters:

w1 - The width of the first dimension.

h1 - The height of the first dimension.

w2 - The width of the second dimension.

h2 - The height of the second dimension.

Returns:

True if the values are equal; false otherwise.

aspectRatio

public static float aspectRatio(int width,
                                int height)

Calculates an aspect ratio (width / height).

Parameters:

width - The width, in pixels.

height - The height, in pixels.

Returns:

The aspect ratio.

aspectRatioLabel

public static java.lang.String aspectRatioLabel(int width,
                                                int height)

Gets an aspect ratio as a string, for example, 16:9.

Parameters:

width - The width, in pixels.

height - The height, in pixels.

Returns:

A string representation of the aspect ratio.

filterByAspectRatio

public static WOWZSize[] filterByAspectRatio(WOWZSize[] sizes,
                                             WOWZSize srcSize)

Filters an array of sizes by those that match the aspect ratio of a specified size.

Parameters:

sizes - The array of sizes to compare.

srcSize - The source size.

Returns:

An array of sizes that match the aspect ratio of the specified size.

findContainers

public static WOWZSize[] findContainers(WOWZSize[] srcSizes,
                                        WOWZSize minSize)

Filters an array of sizes by those that are equal to or larger than a specified minimum size.

Parameters:

srcSizes - The array of sizes to compare.

minSize - The minimum size.

Returns:

An array of sizes that are equal to or larger than the specified minimum size.

equalsAspect

public static boolean equalsAspect(int w1,
                                   int h1,
                                   int w2,
                                   int h2)

Compares the aspect ratios of two dimensions for equality.

Parameters:

w1 - The width of the first dimension.

h1 - The height of the first dimension.

w2 - The width of the second dimension.

h2 - The height of the second dimension.

Returns:

True if the aspect ratios are equal; false otherwise.

equalsAspect

public static boolean equalsAspect(WOWZSize s1,
                                   WOWZSize s2)

Compares the aspect ratios of two WOWZSize instances for equality.

Parameters:

s1 - The first size for comparison.

s2 - The second size for comparison.

Returns:

True if the aspect ratios are equal; false otherwise.

offset

public static WOWZSize offset(int w1,
                              int h1,
                              int w2,
                              int h2)

Calculates the offset between two dimensions.

Parameters:

w1 - The width of the first dimension.

h1 - The height of the first dimension.

w2 - The width of the second dimension.

h2 - The height of the second dimension.

Returns:

The offset between the two dimensions. Negative if the width and/or height values of the first dimension are greater than the corresponding values in the second dimension.

absOffset

public static WOWZSize absOffset(int w1,
                                 int h1,
                                 int w2,
                                 int h2)

Calculates the offset between two dimensions.

Parameters:

w1 - The width of the first dimension.

h1 - The height of the first dimension.

w2 - The width of the second dimension.

h2 - The height of the second dimension.

Returns:

The offset between the two dimensions.

area

public double area(int w,
                   int h)

center

public WOWZPoint center(int width,
                        int height)

Calculates the center point of the rectangular region with the specified dimensions.

Parameters:

width - The width.

height - The height.

Returns:

The center point.

isLandscape

public static boolean isLandscape(int width,
                                  int height)

Returns:

True if the width is greater than the height; false otherwise.

isPortrait

public static boolean isPortrait(int width,
                                 int height)

Returns:

True if the width is less than height; false otherwise.

isSquare

public static boolean isSquare(int width,
                               int height)

Returns:

True if the width equals the height; false otherwise.

isZero

public static boolean isZero(int width,
                             int height)

Returns:

True if width and height are both 0; false otherwise.

longDimension

public static int longDimension(int width,
                                int height)

Returns:

The greater of width and height.

asLandscape

public static WOWZSize asLandscape(int width,
                                   int height)

Creates an instance whose width is greater than or equal to its height.

Returns:

A new landscape-oriented instance.

asPortrait

public static WOWZSize asPortrait(int width,
                                  int height)

Creates an instance whose width is less than or equal to its height.

Returns:

A new portrait-oriented instance.

closestTo

public static WOWZSize closestTo(WOWZSize src,
                                 WOWZSize[] others)

Gets the instance from the specified array that is greater than and closest in size to the specified instance.

Parameters:

src - The instance to use for comparison to the instances in the array.

others - An array of instances to compare with the specified instance.

Returns:

The instance from the array that is greater to and closest to the specified instance, or null if none of the instances in the array is greater than the specified instance.

closestToIndex

public static int closestToIndex(WOWZSize src,
                                 WOWZSize[] others)

Gets the index of the instance from the specified array that is greater than and closest in size to the specified instance.

Parameters:

src - The instance to use for comparison to the instances in the array.

others - An array of instances to compare with the specified instance.

Returns:

The index of the instance from the array that is greater to and closest to the specified instance, or -1 if none of the instances in the array is greater than the specified instance.

closestTo

public static WOWZSize closestTo(int width,
                                 int height,
                                 WOWZSize[] others)

Gets the instance from the specified array that is greater than and closest in size to the specified dimension values.

Parameters:

width - The width to use for comparison.

height - The height to use for comparison.

others - An array of instances to compare with the specified values.

Returns:

The instance from the array that is greater than and closest to the specified values, or null if none of the instances in the array is greater than the specified values.

closestToIndex

public static int closestToIndex(int width,
                                 int height,
                                 WOWZSize[] others)

Gets the index of the instance from the specified array that is greater than and closest in size to the specified dimension values.

Parameters:

width - The width to use for comparison.

height - The height to use for comparison.

others - An array of instances to compare with the specified values.

Returns:

The index of the instance from the array that is greater than and closest to the specified values, or -1 if none of the instances in the array is greater than the specified values.

label

public static java.lang.String label(int width,
                                     int height)

Gets a human-readable description of the specified values.

Returns:

A string representation of the specified values.

getWidth

public int getWidth()

Returns:

The width value.

setWidth

public void setWidth(int width)

Updates the width value.

Parameters:

width - The width value.

getHeight

public int getHeight()

Returns:

The height value.

setHeight

public void setHeight(int height)

Updates the height value.

Parameters:

height - The height value.

set

public void set(int width,
                int height)

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

Parameters:

width - The width value.

height - The height value.

set

public void set(WOWZSize 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 width,
                      int height)

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

Parameters:

width - The width value.

height - The height value.

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 be used for comparison.

Returns:

True if the instances are equal; false otherwise.

compareTo

public int compareTo(WOWZSize other)

Compares this instance with the specified instance.

Specified by:

compareTo in interface java.lang.Comparable<WOWZSize>

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.

compareTo

public int compareTo(int width,
                     int height)

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

Parameters:

width - The width value.

height - The height value.

Returns:

-1 if the properties of this instance are less than the specified values, 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 WOWZSize inverted()

Creates a version of this instance with the width and height values reversed.

Returns:

An instance with the width and height values reversed.

invert

public void invert()

Inverts the coordinate values of this instance.

aspectRatio

public float aspectRatio()

Calculates the aspect ratio (width / height) of this instance.

Parameters:

width - The width value.

height - The height value.

Returns:

The aspect ratio.

aspectRatioLabel

public java.lang.String aspectRatioLabel()

Gets a string representation of the aspect ratio of this dimension.

Returns:

A string representation of the aspect ratio of this dimension.

equalsAspect

public boolean equalsAspect(int width,
                            int height)

Compares the aspect ratio of this instance with the aspect ratio of the specified width and height.

Parameters:

width - The width to use for comparison.

height - The height to use for comparison.

Returns:

True if the aspect ratio of this instance is equal to the aspect ratio of the specified width and height; false otherwise.

equalsAspect

public boolean equalsAspect(WOWZSize other)

Compares the aspect ratio of this instance with another instance.

Parameters:

other - The instance to use for comparison.

Returns:

True if the aspect ratios are equal; false otherwise.

isLandscape

public boolean isLandscape()

Returns:

True if the width is greater than the height; false otherwise.

isPortrait

public boolean isPortrait()

Returns:

True if the width is less than the height; false otherwise.

isSquare

public boolean isSquare()

Returns:

True if the width equals the height; false otherwise.

isZero

public boolean isZero()

Returns:

True if the width and height are both 0; false otherwise.

longDimension

public int longDimension()

Returns:

The greater of width and height.

asLandscape

public WOWZSize asLandscape()

Creates an instance whose width is greater than or equal to its height.

Returns:

A landscape-oriented instance.

asPortrait

public WOWZSize asPortrait()

Creates an instance whose width is less than or equal to its height.

Returns:

A portrait-oriented instance.

fitsWithin

public boolean fitsWithin(WOWZSize other)

Compares this instance with the specified instance to see if it is smaller.

Returns:

True if the width and height values of this instance are less than the values of the specified instance; false otherwise.

largerThan

public boolean largerThan(WOWZSize other)

Compares this instance with the specified instance to see if it is larger.

Returns:

True if the width and height values of this instance are greater than the values of the specified instance; false otherwise.

center

public WOWZPoint center()

Calculates the center point of a zero-based rectangle with the width and height of this instance.

Returns:

The center point.

area

public double area()

Calculates the area of a rectangle with the width and height of this instance.

Returns:

The area.

offsetFrom

public WOWZSize offsetFrom(WOWZSize other)

Calculates the offset between the width and height from this instance and the specified instance.

Parameters:

other - The instance with the width and height values for the offset calculation.

Returns:

The offset between the instances. Negative if the width and/or height values of this instance are greater than the corresponding values in the specified instance.

absOffsetFrom

public WOWZSize absOffsetFrom(WOWZSize other)

Calculates the offset between the width and height values from this instance and the specified instance.

Parameters:

other - The instance with the width and height to use for the offset calculation.

Returns:

The offset between the instances.

scaleWithCrop

public WOWZSize.ScaledDimensions scaleWithCrop(WOWZSize other)

Calculates the dimensions of this instance after scaling it so that it fits entirely in the specified instance, preserving the aspect ratio.

Parameters:

other - The destination rectangular instance.

Returns:

The calculated size, offset, and scale factors.

scaleWithFill

public WOWZSize.ScaledDimensions scaleWithFill(WOWZSize other)

Calculates the dimensions of this instance after scaling it so that it fills the specified instance, preserving the aspect ratio.

Parameters:

other - The destination rectangular instance.

Returns:

The calculated size, offset, and scale factors.

center

public WOWZSize.ScaledDimensions center(WOWZSize other)

Calculates the offset of this instance from the destination after centering it in the destination.

Parameters:

other - The destination rectangular instance.

Returns:

The calculated offset.