WZSize (GoCoder SDK Android API)

java.lang.Object
- com.wowza.gocoder.sdk.api.geometry.WZSize

All Implemented Interfaces:: Serializable, Comparable<WZSize>

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

The WZSize class represents a dimension with integer-based width and height values.

Usage example:

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

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`WZSize.ScaledDimensions` `ScaledDimensions` is a utility class representing common scaling operations when placing one rectangular area (the source) within another (the destination)

Field Summary

Fields
Modifier and Type Field and Description

int height
The height value

int width
The width value

Fields
Modifier and Type	Field and Description
`int`	`height` The height value
`int`	`width` The width value

Constructor Summary

Constructors
Constructor and Description
`WZSize()` The default constructor
`WZSize(int width, int height)` Construct a new instance using the specified property values
`WZSize(WZSize other)` Construct a new instance using the property values from the specified instance

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static WZSize`	`absOffset(int w1, int h1, int w2, int h2)` Calculates the offset between two dimensions.
`WZSize`	`absOffsetFrom(WZSize 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 values of this instance
`double`	`area(int w, int h)`
`WZSize`	`asLandscape()` Returns a new instance with the width and height values assigned in a manner that guarantees width >= height
`static WZSize`	`asLandscape(int width, int height)` Returns an instance with the width and height values assigned in a manner that guarantees width >= height
`float`	`aspectRatio()` Calculates the aspect ratio (width / height) using the width and height values of this instance
`static float`	`aspectRatio(int width, int height)` Calculates an aspect ratio (width / height)
`String`	`aspectRatioLabel()` Returns a string representation of the aspect ratio of this dimension
`static String`	`aspectRatioLabel(int width, int height)` Returns an aspect ratio as a string (e.g.
`WZSize`	`asPortrait()` Returns a new instance with the width and height values assigned in a manner that guarantees width <= height
`static WZSize`	`asPortrait(int width, int height)` Returns an instance with the width and height values assigned in a manner that guarantees width <= height
`WZPoint`	`center()` Calculates the center point of an zero-based rectangle with the width and height values of this instance
`WZPoint`	`center(int width, int height)` Calculates the center point of the rectangular region with the specified dimensions
`WZSize.ScaledDimensions`	`center(WZSize other)` Calculate the offset of this instance from the destination after centering it within the destination.
`static WZSize`	`closestTo(int width, int height, WZSize[] others)` Returns the instance from the specified array that is greater to and closest in size to the specified dimension values
`static WZSize`	`closestTo(WZSize src, WZSize[] others)` Returns the instance from the specified array that is greater to and closest in size to the specified instance
`static int`	`closestToIndex(int width, int height, WZSize[] others)` Returns the index of the instance from the specified array that is greater to and closest in size to the specified dimension values
`static int`	`closestToIndex(WZSize src, WZSize[] others)` Returns the index of the instance from the specified array that is greater to and closest in size to the specified instance
`int`	`compareTo(int width, int height)` Compare this property values of this instance with the specified values
`int`	`compareTo(WZSize other)` Compare this instance with the specified instance
`boolean`	`equals(int width, int height)` Compare the property values of this instance with the specified values for equality
`boolean`	`equals(int w1, int h1, int w2, int h2)` Compare two dimensions for equality.
`boolean`	`equals(Object other)` Compare this instance with the specified instance for equality
`boolean`	`equalsAspect(int width, int height)` Compare 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)` Compare the aspect ratios of two dimensions for equality
`boolean`	`equalsAspect(WZSize other)` Compare the aspect ratio of this instance with another instance
`static boolean`	`equalsAspect(WZSize s1, WZSize s2)` Compare the aspect ratios of two WZSize instances for equality
`static WZSize[]`	`filterByAspectRatio(WZSize[] sizes, WZSize srcSize)` Filter an array of sizes by those that match the aspect ratio of a specified size
`static WZSize[]`	`findContainers(WZSize[] srcSizes, WZSize minSize)` Filter an array of sizes by those that are equal to or larger than a specified minimum size
`boolean`	`fitsWithin(WZSize other)` Compares this instance with the specified instance to see if it is smaller
`int`	`getHeight()`
`int`	`getWidth()`
`void`	`invert()` Invert the coordinate values of this instance
`WZSize`	`inverted()` Create a new "inverted" 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 String`	`label(int width, int height)` Returns a human-readable description of the specified values
`boolean`	`largerThan(WZSize other)` Compares this instance with the specified instance to see if it is larger
`int`	`longDimension()`
`static int`	`longDimension(int width, int height)`
`static WZSize`	`offset(int w1, int h1, int w2, int h2)` Calculates the offset between two dimensions.
`WZSize`	`offsetFrom(WZSize other)` Calculates the offset between the width and height values from this instance and the specified instance.
`WZSize.ScaledDimensions`	`scaleWithCrop(WZSize other)` Calculate the dimensions of this instance after scaling it so that it fits entirely within the specified instance, preserving the aspect ratio.
`WZSize.ScaledDimensions`	`scaleWithFill(WZSize other)` Calculate 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)` Update the property values of this instance with the specified values
`void`	`set(WZSize other)` Update the property values of this instance with the property values from the specified instance
`void`	`setHeight(int height)` Update the height value
`void`	`setWidth(int width)` Update the width 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
  - width
```
public int width
```
    The width value
  - height
```
public int height
```
    The height value
- Constructor Detail
  - WZSize
```
public WZSize()
```
    The default constructor
  - WZSize
```
public WZSize(int width,
              int height)
```
    Construct a new instance using the specified property values
    
    Parameters:
    
    width - The width value
    
    height - The height value
  - WZSize
```
public WZSize(WZSize 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 w1,
                      int h1,
                      int w2,
                      int h2)
```
    Compare two dimensions for equality.
    
    Parameters:
    
    w1 - The width value of the first dimension
    
    h1 - The height value of the first dimension
    
    w2 - The width value of the second dimension
    
    h2 - The height value 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)
    
    Returns:
    
    The aspect ratio
  - aspectRatioLabel
```
public static String aspectRatioLabel(int width,
                                      int height)
```
    Returns an aspect ratio as a string (e.g. "16:9")
    
    Parameters:
    
    width - width, in pixels
    
    height - height, in pixels
    
    Returns:
    
    a string representation of the aspect ratio
  - filterByAspectRatio
```
public static WZSize[] filterByAspectRatio(WZSize[] sizes,
                                           WZSize srcSize)
```
    Filter 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 WZSize[] findContainers(WZSize[] srcSizes,
                                      WZSize minSize)
```
    Filter 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)
```
    Compare the aspect ratios of two dimensions for equality
    
    Parameters:
    
    w1 - The width value of the first dimension
    
    h1 - The height value of the first dimension
    
    w2 - The width value of the second dimension
    
    h2 - The height value of the second dimension
    
    Returns:
    
    true is the aspect ratios are equal, false otherwise
  - equalsAspect
```
public static boolean equalsAspect(WZSize s1,
                                   WZSize s2)
```
    Compare the aspect ratios of two WZSize instances for equality
    
    Parameters:
    
    s1 - the first size for comparison
    
    s2 - the second size for comparison
    
    Returns:
    
    true is the aspect ratios are equal, false otherwise
  - offset
```
public static WZSize offset(int w1,
                            int h1,
                            int w2,
                            int h2)
```
    Calculates the offset between two dimensions. The returned values may be negative if the width and/or height values of the first dimension are greater than the corresponding values in the second dimension.
    
    Parameters:
    
    w1 - The width value of the first dimension
    
    h1 - The height value of the first dimension
    
    w2 - The width value of the second dimension
    
    h2 - The height value of the second dimension
    
    Returns:
    
    The offset between the two dimensions.
  - absOffset
```
public static WZSize absOffset(int w1,
                               int h1,
                               int w2,
                               int h2)
```
    Calculates the offset between two dimensions.
    
    Parameters:
    
    w1 - The width value of the first dimension
    
    h1 - The height value of the first dimension
    
    w2 - The width value of the second dimension
    
    h2 - The height value of the second dimension
    
    Returns:
    
    The offset between the two dimensions.
  - area
```
public double area(int w,
                   int h)
```
  - center
```
public WZPoint center(int width,
                      int height)
```
    Calculates the center point of the rectangular region with the specified dimensions
    
    Parameters:
    
    width - The width value
    
    height - The height value
    
    Returns:
    
    The center point
  - isLandscape
```
public static boolean isLandscape(int width,
                                  int height)
```
    Returns:
    
    true if width > height, false otherwise
  - isPortrait
```
public static boolean isPortrait(int width,
                                 int height)
```
    Returns:
    
    true if width < height, false otherwise
  - isSquare
```
public static boolean isSquare(int width,
                               int height)
```
    Returns:
    
    true if width == 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 WZSize asLandscape(int width,
                                 int height)
```
    Returns an instance with the width and height values assigned in a manner that guarantees width >= height
    
    Returns:
    
    A new landscape-based instance
  - asPortrait
```
public static WZSize asPortrait(int width,
                                int height)
```
    Returns an instance with the width and height values assigned in a manner that guarantees width <= height
    
    Returns:
    
    A new portrait-based instance
  - closestTo
```
public static WZSize closestTo(WZSize src,
                               WZSize[] others)
```
    Returns the instance from the specified array that is greater to 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. null if none of the instances in the array are greater than the specified instance.
  - closestToIndex
```
public static int closestToIndex(WZSize src,
                                 WZSize[] others)
```
    Returns the index of the instance from the specified array that is greater to 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. -1 if none of the instances in the array are greater than the specified instance.
  - closestTo
```
public static WZSize closestTo(int width,
                               int height,
                               WZSize[] others)
```
    Returns the instance from the specified array that is greater to and closest in size to the specified dimension values
    
    Parameters:
    
    width - The width value to use for comparison
    
    height - The height value to use for comparison
    
    others - An array of instances to compare with the specified values
    
    Returns:
    
    The instance from the array that is greater to and closest to the specified values. null if none of the instances in the array are greater than the specified values.
  - closestToIndex
```
public static int closestToIndex(int width,
                                 int height,
                                 WZSize[] others)
```
    Returns the index of the instance from the specified array that is greater to and closest in size to the specified dimension values
    
    Parameters:
    
    width - The width value to use for comparison
    
    height - The height value 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 to and closest to the specified values. -1 if none of the instances in the array are greater than the specified values.
  - label
```
public static String label(int width,
                           int height)
```
    Returns 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)
```
    Update the width value
    
    Parameters:
    
    width - The width value
  - getHeight
```
public int getHeight()
```
    Returns:
    
    The height value
  - setHeight
```
public void setHeight(int height)
```
    Update the height value
    
    Parameters:
    
    height - The height value
  - set
```
public void set(int width,
                int height)
```
    Update the property values of this instance with the specified values
    
    Parameters:
    
    width - The width value
    
    height - The height value
  - set
```
public void set(WZSize 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 width,
                      int height)
```
    Compare the property values of this instance with the specified values for equality
    
    Parameters:
    
    width - The width value
    
    height - The height value
    
    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(WZSize other)
```
    Compare this instance with the specified instance
    
    Specified by:
    
    compareTo in interface Comparable<WZSize>
    
    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)
```
    Compare this 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 String toString()
```
    Returns a human-readable description of this instance
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this instance
  - inverted
```
public WZSize inverted()
```
    Create a new "inverted" version of this instance with the width and height values reversed
    
    Returns:
    
    A new instance with the width and height values reversed
  - invert
```
public void invert()
```
    Invert the coordinate values of this instance
  - aspectRatio
```
public float aspectRatio()
```
    Calculates the aspect ratio (width / height) using the width and height values of this instance
    
    Returns:
    
    The aspect ratio
  - aspectRatioLabel
```
public String aspectRatioLabel()
```
    Returns 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)
```
    Compare 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(WZSize other)
```
    Compare the aspect ratio of this instance with another instance
    
    Parameters:
    
    other - the other instance to use for comparison
    
    Returns:
    
    true if the aspect ratios are equals, false otherwise
  - isLandscape
```
public boolean isLandscape()
```
    Returns:
    
    true if width > height, false otherwise
  - isPortrait
```
public boolean isPortrait()
```
    Returns:
    
    true if width < height, false otherwise
  - isSquare
```
public boolean isSquare()
```
    Returns:
    
    true if width == height, false otherwise
  - isZero
```
public boolean isZero()
```
    Returns:
    
    true if width and height are both 0, false otherwise
  - longDimension
```
public int longDimension()
```
    Returns:
    
    the greater of width and height
  - asLandscape
```
public WZSize asLandscape()
```
    Returns a new instance with the width and height values assigned in a manner that guarantees width >= height
    
    Returns:
    
    A new landscape-based instance
  - asPortrait
```
public WZSize asPortrait()
```
    Returns a new instance with the width and height values assigned in a manner that guarantees width <= height
    
    Returns:
    
    A new portrait-based instance
  - fitsWithin
```
public boolean fitsWithin(WZSize 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 from the specified instance, false otherwise
  - largerThan
```
public boolean largerThan(WZSize 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 from the specified instance, false otherwise
  - center
```
public WZPoint center()
```
    Calculates the center point of an zero-based rectangle with the width and height values of this instance
    
    Returns:
    
    The center point
  - area
```
public double area()
```
    Calculates the area of a rectangle with the width and height values of this instance
    
    Returns:
    
    The area
  - offsetFrom
```
public WZSize offsetFrom(WZSize other)
```
    Calculates the offset between the width and height values from this instance and the specified instance. The returned values may be negative if the width and/or height values of this instance are greater than the corresponding values in the specified instance
    
    Parameters:
    
    other - The instance with the width and height values for the offset calculation
    
    Returns:
    
    The offset between the instances.
  - absOffsetFrom
```
public WZSize absOffsetFrom(WZSize 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 values for the offset calculation
    
    Returns:
    
    The offset between the instances.
  - scaleWithCrop
```
public WZSize.ScaledDimensions scaleWithCrop(WZSize other)
```
    Calculate the dimensions of this instance after scaling it so that it fits entirely within the specified instance, preserving the aspect ratio.
    
    Parameters:
    
    other - The destination rectangular instance
    
    Returns:
    
    The calculated size, offset, and scale factors
  - scaleWithFill
```
public WZSize.ScaledDimensions scaleWithFill(WZSize other)
```
    Calculate 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 WZSize.ScaledDimensions center(WZSize other)
```
    Calculate the offset of this instance from the destination after centering it within the destination.
    
    Parameters:
    
    other - The destination rectangular instance
    
    Returns:
    
    The calculated offset

Class WZSize

Usage example:

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

width

height

Constructor Detail

WZSize

WZSize

WZSize

Method Detail

equals

aspectRatio

aspectRatioLabel

filterByAspectRatio

findContainers

equalsAspect

equalsAspect

offset

absOffset

area

center

isLandscape

isPortrait

isSquare

isZero

longDimension

asLandscape

asPortrait

closestTo

closestToIndex

closestTo

closestToIndex

label

getWidth

setWidth

getHeight

setHeight

set

set

equals

equals

compareTo

compareTo

toString

inverted

invert

aspectRatio

aspectRatioLabel

equalsAspect

equalsAspect

isLandscape

isPortrait

isSquare

isZero

longDimension

asLandscape

asPortrait

fitsWithin

largerThan

center

area

offsetFrom

absOffsetFrom

scaleWithCrop

scaleWithFill

center