com.wowza.gocoder.sdk.api.geometry

Class WOWZSize.ScaledDimensions

java.lang.Object

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

Enclosing class:

WOWZSize

public static class WOWZSize.ScaledDimensions
extends java.lang.Object

ScaledDimensions is a utility class representing common scaling operations when placing one rectangular area (the source) in another (the destination). For example:

         WOWZSize frameSize = WOWZSize(640, 480);
         WOWZSize screenSize = WOWZSize(1920, 1080);
         WOWZSize.ScaledDimension croppedDimensions = frameSize.scaleAndCrop(screenSize);
     

Field Summary

Fields

Modifier and Type	Field and Description
WOWZPoint	centerPoint The center point of the destination rectangle.
WOWZSize	destSize The dimensions of the destination rectangle.
WOWZSize	offset The offset of the source rectangle in the destination.
WOWZSize	scaledSize The dimensions of the source rectangle after the appropriate placement calculation has been applied.
float	scaleX The scaling factor applied to the width of the source rectangle.
float	scaleY The scaling factor applied to the height of the source rectangle.
WOWZSize	srcSize The dimensions of the source rectangle.

Constructor Summary

Constructors

Constructor and Description
ScaledDimensions(WOWZSize srcSize, WOWZSize destSize) The default constructor.

Method Summary

Modifier and Type	Method and Description
WOWZSize.ScaledDimensions	center() Calculates the offset of the source rectangle from the destination after centering it in the destination.
WOWZSize.ScaledDimensions	scaleWithCrop() Calculates the dimensions of the source rectangle after scaling such that it fits entirely in the destination rectangle, preserving the aspect ratio.
WOWZSize.ScaledDimensions	scaleWithFill() Calculates the dimensions of the source rectangle after scaling such that it fills the destination rectangle, preserving the aspect ratio.
void	setDestSize(WOWZSize destSize) Updates the dimensions of the destination rectangle.
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

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

Field Detail

srcSize

public WOWZSize srcSize

The dimensions of the source rectangle.

destSize

public WOWZSize destSize

The dimensions of the destination rectangle.

scaledSize

public WOWZSize scaledSize

The dimensions of the source rectangle after the appropriate placement calculation has been applied.

offset

public WOWZSize offset

The offset of the source rectangle in the destination.

centerPoint

public WOWZPoint centerPoint

The center point of the destination rectangle.

scaleX

public float scaleX

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

scaleY

public float scaleY

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

Constructor Detail

ScaledDimensions

public ScaledDimensions(WOWZSize srcSize,
                        WOWZSize destSize)

The default constructor.

Parameters:

srcSize - The dimensions of the source rectangle.

destSize - The dimensions of the destination rectangle.

Method Detail

setSrcSize

public void setSrcSize(WOWZSize srcSize)

Updates the dimensions of the source rectangle.

Parameters:

srcSize - The dimensions of the source rectangle.

setDestSize

public void setDestSize(WOWZSize destSize)

Updates the dimensions of the destination rectangle.

Parameters:

destSize - The dimensions of the destination rectangle.

scaleWithCrop

public WOWZSize.ScaledDimensions scaleWithCrop()

Calculates the dimensions of the source rectangle after scaling such that it fits entirely in the destination rectangle, preserving the aspect ratio.

Returns:

This instance after scaledSize, offset, and the scale factors have been updated with the results of the calculation.

scaleWithFill

public WOWZSize.ScaledDimensions scaleWithFill()

Calculates the dimensions of the source rectangle after scaling such that it fills the destination rectangle, preserving the aspect ratio.

Returns:

This instance after scaledSize, offset, and the scale factors have been updated with the results of the calculation.

center

public WOWZSize.ScaledDimensions center()

Calculates the offset of the source rectangle from the destination after centering it in the destination.

Returns:

This instance after the offset has been updated with the results of the calculation.

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.