com.helger.commons.dimension

Class SizeFloat

java.lang.Object

com.helger.commons.dimension.SizeFloat

All Implemented Interfaces:

IHasDimensionFloat, IHasHeightFloat, IHasWidthFloat, Serializable

@Immutable
public class SizeFloat
extends Object
implements IHasDimensionFloat, Serializable

This class represents an object having width and height.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SizeFloat(float dWidth, float dHeight)
SizeFloat(IHasDimensionFloat aObj)
SizeFloat(IHasDimensionInt aObj)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
SizeFloat	getAdded(IHasDimensionFloat aToAdd)
SizeFloat	getAdded(IHasDimensionInt aToAdd)
SizeFloat	getBestMatchingSize(float dMaxWidth, float dMaxHeight) Return the scaled width and height relative to a maximum size.
float	getHeight()
SizeFloat	getScaledToHeight(float dNewHeight)
SizeFloat	getScaledToWidth(float dNewWidth)
SizeFloat	getSubtracted(IHasDimensionFloat aToSubtract)
SizeFloat	getSubtracted(IHasDimensionInt aToSubtract)
float	getWidth()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SizeFloat

public SizeFloat(@Nonnull
         IHasDimensionInt aObj)

SizeFloat

public SizeFloat(@Nonnull
         IHasDimensionFloat aObj)

SizeFloat

public SizeFloat(@Nonnegative
         float dWidth,
         @Nonnegative
         float dHeight)

Method Detail

getWidth

@Nonnegative
public float getWidth()

Specified by:

getWidth in interface IHasWidthFloat

Returns:

The width of an object

getHeight

@Nonnegative
public float getHeight()

Specified by:

getHeight in interface IHasHeightFloat

Returns:

The height of an object

getBestMatchingSize

@Nonnull
@CheckReturnValue
public SizeFloat getBestMatchingSize(@Nonnegative
                                                     float dMaxWidth,
                                                     @Nonnegative
                                                     float dMaxHeight)

Return the scaled width and height relative to a maximum size.

Parameters:

dMaxWidth - Maximum width. Must be > 0.

dMaxHeight - Maximum height. Must be > 0.

Returns:

An array with 2 elements, where the first element is the width, and the second is the height.

getScaledToWidth

@Nonnull
@CheckReturnValue
public SizeFloat getScaledToWidth(@Nonnegative
                                                  float dNewWidth)

getScaledToHeight

@Nonnull
@CheckReturnValue
public SizeFloat getScaledToHeight(@Nonnegative
                                                   float dNewHeight)

getAdded

@Nonnull
@CheckReturnValue
public SizeFloat getAdded(@Nonnull
                                          IHasDimensionInt aToAdd)

getAdded

@Nonnull
@CheckReturnValue
public SizeFloat getAdded(@Nonnull
                                          IHasDimensionFloat aToAdd)

getSubtracted

@Nonnull
@CheckReturnValue
public SizeFloat getSubtracted(@Nonnull
                                               IHasDimensionInt aToSubtract)

getSubtracted

@Nonnull
@CheckReturnValue
public SizeFloat getSubtracted(@Nonnull
                                               IHasDimensionFloat aToSubtract)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object