com.wowza.gocoder.sdk.api.geometry

Class WZSize.ScaledDimensions

java.lang.Object

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

Enclosing class:

WZSize

public static class WZSize.ScaledDimensions
extends Object

ScaledDimensions is a utility class representing common scaling operations when placing one rectangular area (the source) within another (the destination)

Usage example:

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

Field Summary

Fields

Modifier and Type	Field and Description
WZPoint	centerPoint The center point of the destination rectangle
WZSize	destSize The dimensions of the destination rectangle
WZSize	offset The offset of the source rectangle within the destination
WZSize	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
WZSize	srcSize The dimensions of the source rectangle

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
WZSize.ScaledDimensions	center() Calculate the offset of the source rectangle from the destination after centering it within the destination.
WZSize.ScaledDimensions	scaleWithCrop() Calculate the dimensions of the source rectangle after scaling such that it fits entirely within the destination rectangle, preserving the aspect ratio.
WZSize.ScaledDimensions	scaleWithFill() Calculate the dimensions of the source rectangle after scaling such that it fills the destination rectangle, preserving the aspect ratio.
void	setDestSize(WZSize destSize) Update the dimensions of the destination rectangle
void	setSrcSize(WZSize srcSize) Update the dimensions of the source rectangle
String	toString() Returns 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 WZSize srcSize

The dimensions of the source rectangle

destSize

public WZSize destSize

The dimensions of the destination rectangle

scaledSize

public WZSize scaledSize

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

offset

public WZSize offset

The offset of the source rectangle within the destination

centerPoint

public WZPoint 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(WZSize srcSize,
                        WZSize 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(WZSize srcSize)

Update the dimensions of the source rectangle

Parameters:

srcSize - The dimensions of the source rectangle

setDestSize

public void setDestSize(WZSize destSize)

Update the dimensions of the destination rectangle

Parameters:

destSize - The dimensions of the destination rectangle

scaleWithCrop

public WZSize.ScaledDimensions scaleWithCrop()

Calculate the dimensions of the source rectangle after scaling such that it fits entirely within 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 WZSize.ScaledDimensions scaleWithFill()

Calculate 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 WZSize.ScaledDimensions center()

Calculate the offset of the source rectangle from the destination after centering it within the destination.

Returns:

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

toString

public String toString()

Returns a human-readable description of this instance

Overrides:

toString in class Object

Returns:

A string representation of this instance