com.wowza.gocoder.sdk.api.geometry

Class WZCropDimensions

java.lang.Object

com.wowza.gocoder.sdk.api.geometry.WZCropDimensions

public class WZCropDimensions
extends Object

WZCropDimensions 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 modes (WZMediaConfig.RESIZE_TO_ASPECT or WZMediaConfig.FILL_VIEW)

Constructor Summary

Constructors

Constructor and Description
WZCropDimensions() The default constructor
WZCropDimensions(WZCropDimensions other) Construct a new instance using the property values from the specified instance
WZCropDimensions(WZSize srcSize, WZSize destSize) Construct a new instance by specifying the source and destination rectangle sizes
WZCropDimensions(WZSize srcSize, WZSize destSize, int scaleMode) Construct a new instance by specifying the source and destination rectangle sizes and scale mode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
WZPoint	getCenterPoint() Returns the center point of the destination rectangle
WZSize	getDestSize() Returns the dimensions of the destination rectangle
WZPoint	getOffset() Returns the offset of the bottom left of the source rectangle within the destination
WZSize	getScaledSize() Returns the dimensions of the source rectangle after the scale mode has been applied
int	getScaleMode() Returns the scaling mode used for the placement calculation
float	getScaleX() Returns the scaling factor applied to the width of the source rectangle
float	getScaleY() Returns the scaling factor applied to the height of the source rectangle
WZSize	getSrcSize() Returns the dimensions of the source rectangle
void	set(WZCropDimensions other) Update the property values of this instance with the property values from the specified instance
void	setDestSize(WZSize destSize) Update the dimensions of the destination rectangle and recalculate
void	setScaleMode(int scaleMode) Set the scale mode and recalculate
void	setSrcSize(WZSize srcSize) Update the dimensions of the source rectangle and recalculate
String	toString() Returns a human-readable description of this instance

Methods inherited from class java.lang.Object

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

Constructor Detail

WZCropDimensions

public WZCropDimensions(WZSize srcSize,
                        WZSize destSize,
                        int scaleMode)

Construct a new 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

WZCropDimensions

public WZCropDimensions(WZCropDimensions other)

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

Parameters:

other - The instance to replicate

WZCropDimensions

public WZCropDimensions()

The default constructor

WZCropDimensions

public WZCropDimensions(WZSize srcSize,
                        WZSize destSize)

Construct a new 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(WZCropDimensions 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(Object o)

Overrides:

equals in class Object

setSrcSize

public void setSrcSize(WZSize srcSize)

Update the dimensions of the source rectangle and recalculate

Parameters:

srcSize - The dimensions of the source rectangle

getSrcSize

public WZSize getSrcSize()

Returns the dimensions of the source rectangle

Returns:

The dimensions of the source rectangle

setDestSize

public void setDestSize(WZSize destSize)

Update the dimensions of the destination rectangle and recalculate

Parameters:

destSize - The dimensions of the destination rectangle

getDestSize

public WZSize getDestSize()

Returns the dimensions of the destination rectangle

Returns:

The dimensions of the destination rectangle

setScaleMode

public void setScaleMode(int scaleMode)

Set the scale mode and recalculate

Parameters:

scaleMode - The scaling mode used for the placement calculation. One of WZMediaConfig.RESIZE_TO_ASPECT or WZMediaConfig.FILL_VIEW

getScaleMode

public int getScaleMode()

Returns the scaling mode used for the placement calculation

Returns:

The scaling mode used for the placement calculation. One of WZMediaConfig.RESIZE_TO_ASPECT or WZMediaConfig.FILL_VIEW

getOffset

public WZPoint getOffset()

Returns 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 WZSize getScaledSize()

Returns 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()

Returns 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()

Returns 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 WZPoint getCenterPoint()

Returns the center point of the destination rectangle

Returns:

The center point of the destination rectangle

toString

public String toString()

Returns a human-readable description of this instance

Overrides:

toString in class Object

Returns:

A string representation of this instance