net.richarddawkins.watchmaker.geom

Class Dim

java.lang.Object

net.richarddawkins.watchmaker.geom.Dim

public class Dim
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
int	height
int	width

Constructor Summary

Constructors

Constructor and Description
Dim(double width2, double height2)
Dim(int d, int e)

Method Summary

Modifier and Type	Method and Description
int	getHeight()
static Dim	getLargest(java.util.Collection<Dim> dims) Return a dim that is at least as large in width and height as all of the provided Dims.
int	getScale(Dim dimToFit, double zoomBase) Returns the logarithm of the scale multiplier required to ensure that the second dimension fits within the first, to the given logarithmic base.
int	getWidth()
void	setHeight(int height)
void	setWidth(int width)
java.lang.String	toString()
Dim	union(Dim dim)

Methods inherited from class java.lang.Object

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

Field Detail

width

public int width

height

public int height

Constructor Detail

Dim

public Dim(int d,
           int e)

Dim

public Dim(double width2,
           double height2)

Method Detail

getWidth

public int getWidth()

setWidth

public void setWidth(int width)

getHeight

public int getHeight()

setHeight

public void setHeight(int height)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

union

public Dim union(Dim dim)

Parameters:

dim - a Dim to be added with this one for purposes of determining an enclosing Dim.

Returns:

a new Dim whose width and height are the greater of those of this dim and the provided dim.

getLargest

public static Dim getLargest(java.util.Collection<Dim> dims)

Return a dim that is at least as large in width and height as all of the provided Dims.

Parameters:

dims - a list of dims, to calculate the enclosing dimension

Returns:

a Dim whose width and height are equal to the greatest width and height of the provided collection of dims.

getScale

public int getScale(Dim dimToFit,
                    double zoomBase)

Returns the logarithm of the scale multiplier required to ensure that the second dimension fits within the first, to the given logarithmic base.

Parameters:

dimToFit - the dimension to fit inside this dimension.

zoomBase - the logarithm base (example 2.0 gives a multiplier of 2 for each integral zoom step.) Values greater than 1 are meaningful.

Returns:

the smallest integer that is not larger than the logarithm of the scale required to fit the given dimension inside this dimension, to the given logarithmic base.