com.wowza.gocoder.sdk.api.geometry

Class WOWZCropDimensions

java.lang.Object

com.wowza.gocoder.sdk.api.geometry.WOWZCropDimensions

public class WOWZCropDimensions
extends java.lang.Object

WOWZCropDimensions is a convenience class for calculating the scale and position of one rectangle (the source) when placed inside another (the destination) and applying a scaling mode.

Constructor Summary

Constructors

Constructor and Description
WOWZCropDimensions() The default constructor.
WOWZCropDimensions(WOWZCropDimensions other) Creates and initializes an instance using the property values from the specified instance.
WOWZCropDimensions(WOWZSize srcSize, WOWZSize destSize) Creates and initializes an instance by specifying the source and destination rectangle sizes.
WOWZCropDimensions(WOWZSize srcSize, WOWZSize destSize, int scaleMode) Creates and initializes an instance by specifying the source and destination rectangle sizes and scale mode.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
WOWZPoint	getCenterPoint() Gets the center point of the destination rectangle.
WOWZSize	getDestSize() Gets the dimensions of the destination rectangle.
WOWZPoint	getOffset() Gets the offset of the bottom left of the source rectangle within the destination.
WOWZSize	getScaledSize() Gets the dimensions of the source rectangle after the scale mode has been applied.
int	getScaleMode() Gets the scaling mode used for the placement calculation.
float	getScaleX() Gets the scaling factor applied to the width of the source rectangle.
float	getScaleY() Gets the scaling factor applied to the height of the source rectangle.
WOWZSize	getSrcSize() Gets the dimensions of the source rectangle.
void	set(WOWZCropDimensions other) Updates the property values of this instance with the property values from the specified instance.
void	setDestSize(WOWZSize destSize) Updates the dimensions of the destination rectangle and recalculates its size.
void	setScaleMode(int scaleMode) Sets the scaling mode.
void	setSrcSize(WOWZSize srcSize) Updates the dimensions of the source rectangle.
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

Constructor Detail

WOWZCropDimensions

public WOWZCropDimensions(WOWZSize srcSize,
                          WOWZSize destSize,
                          int scaleMode)

Creates and initializes an instance by specifying the source and destination rectangle sizes and scale mode.

Parameters:

srcSize - The dimensions of the source rectangle.

destSize - The dimensions of the destination rectangle.

WOWZCropDimensions

public WOWZCropDimensions(WOWZCropDimensions other)

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

Parameters:

other - The instance to use.

WOWZCropDimensions

public WOWZCropDimensions()

The default constructor.

WOWZCropDimensions

public WOWZCropDimensions(WOWZSize srcSize,
                          WOWZSize destSize)

Creates and initializes an instance by specifying the source and destination rectangle sizes.

Parameters:

srcSize - The dimensions of the source rectangle.

destSize - The dimensions of the destination rectangle.

Method Detail

set

public void set(WOWZCropDimensions 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(java.lang.Object o)

Overrides:

equals in class java.lang.Object

setSrcSize

public void setSrcSize(WOWZSize srcSize)

Updates the dimensions of the source rectangle.

Parameters:

srcSize - The dimensions of the source rectangle.

getSrcSize

public WOWZSize getSrcSize()

Gets the dimensions of the source rectangle.

Returns:

The dimensions of the source rectangle.

setDestSize

public void setDestSize(WOWZSize destSize)

Updates the dimensions of the destination rectangle and recalculates its size.

Parameters:

destSize - The dimensions of the destination rectangle.

getDestSize

public WOWZSize getDestSize()

Gets the dimensions of the destination rectangle.

Returns:

The dimensions of the destination rectangle.

setScaleMode

public void setScaleMode(int scaleMode)

Sets the scaling mode.

Parameters:

scaleMode - The scaling mode used for the placement calculation, either WOWZMediaConfig.RESIZE_TO_ASPECT or WOWZMediaConfig.FILL_VIEW.

getScaleMode

public int getScaleMode()

Gets the scaling mode used for the placement calculation.

Returns:

The scaling mode used for the placement calculation, either WOWZMediaConfig.RESIZE_TO_ASPECT or WOWZMediaConfig.FILL_VIEW.

getOffset

public WOWZPoint getOffset()

Gets the offset of the bottom left of the source rectangle within the destination.

Returns:

The offset of the bottom left of the source rectangle within the destination.

getScaledSize

public WOWZSize getScaledSize()

Gets the dimensions of the source rectangle after the scale mode has been applied.

Returns:

The dimensions of the source rectangle after the scale mode has been applied.

getScaleX

public float getScaleX()

Gets the scaling factor applied to the width of the source rectangle.

Returns:

The scaling factor applied to the width of the source rectangle.

getScaleY

public float getScaleY()

Gets the scaling factor applied to the height of the source rectangle.

Returns:

The scaling factor applied to the height of the source rectangle.

getCenterPoint

public WOWZPoint getCenterPoint()

Gets the center point of the destination rectangle.

Returns:

The center point of the destination rectangle.

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.