icy.type.dimension

Class Dimension3D

java.lang.Object

icy.type.dimension.Dimension3D

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

Dimension3D.Double, Dimension3D.Float, Dimension3D.Integer

public abstract class Dimension3D
extends java.lang.Object
implements java.lang.Cloneable

The Dimension3D class is to encapsulate a 3D dimension (X,Y,Z).

Author:

Stephane

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Dimension3D.Double
static class	Dimension3D.Float
static class	Dimension3D.Integer

Constructor Summary

Constructors

Constructor and Description
Dimension3D()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	clone() Creates a new object of the same class as this object.
boolean	equals(java.lang.Object obj)
abstract double	getSizeX() Returns the size of the X dimension in double precision.
abstract double	getSizeY() Returns the size of the Y dimension in double precision.
abstract double	getSizeZ() Returns the size of the Z dimension in double precision.
abstract boolean	isInfiniteX() Returns true if the X dimension should be considered as infinite.
abstract boolean	isInfiniteY() Returns true if the Y dimension should be considered as infinite.
abstract boolean	isInfiniteZ() Returns true if the Z dimension should be considered as infinite.
void	setSize(Dimension3D d) Sets the size of this Dimension3D object to match the specified size.
abstract void	setSize(double sizeX, double sizeY, double sizeZ) Sets the size of this Dimension3D object.
abstract void	setSizeX(double value) Sets the size of the X dimension of this Dimension3D in double precision.
abstract void	setSizeY(double value) Sets the size of the Y dimension of this Dimension3D in double precision.
abstract void	setSizeZ(double value) Sets the size of the Z dimension of this Dimension3D in double precision.
abstract java.awt.geom.Dimension2D	toDimension2D() Convert to 2D dimension.
Dimension3D.Integer	toInteger() Returns an integer Dimension3D that encloses the double Dimension3D.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Dimension3D

public Dimension3D()

Method Detail

getSizeX

public abstract double getSizeX()

Returns the size of the X dimension in double precision.

Returns:

the size of the X dimension.

getSizeY

public abstract double getSizeY()

Returns the size of the Y dimension in double precision.

Returns:

the size of the Y dimension.

getSizeZ

public abstract double getSizeZ()

Returns the size of the Z dimension in double precision.

Returns:

the size of the Z dimension.

setSizeX

public abstract void setSizeX(double value)

Sets the size of the X dimension of this Dimension3D in double precision.

setSizeY

public abstract void setSizeY(double value)

Sets the size of the Y dimension of this Dimension3D in double precision.

setSizeZ

public abstract void setSizeZ(double value)

Sets the size of the Z dimension of this Dimension3D in double precision.

setSize

public abstract void setSize(double sizeX,
           double sizeY,
           double sizeZ)

Sets the size of this Dimension3D object.

Parameters:

sizeX - the new size for the X dimension

sizeY - the new size for the Y dimension

sizeZ - the new size for the Z dimension

setSize

public void setSize(Dimension3D d)

Sets the size of this Dimension3D object to match the specified size.

Parameters:

d - the new size for the Dimension3D object

isInfiniteX

public abstract boolean isInfiniteX()

Returns true if the X dimension should be considered as infinite.

isInfiniteY

public abstract boolean isInfiniteY()

Returns true if the Y dimension should be considered as infinite.

isInfiniteZ

public abstract boolean isInfiniteZ()

Returns true if the Z dimension should be considered as infinite.

toDimension2D

public abstract java.awt.geom.Dimension2D toDimension2D()

Convert to 2D dimension.

toInteger

public Dimension3D.Integer toInteger()

Returns an integer Dimension3D that encloses the double Dimension3D.
The returned Dimension3D.Integer might also fail to completely enclose the original double Dimension3D if it overflows the limited range of the integer data type.

Returns:

an integer Dimension3D that completely encloses the actual double Dimension3D.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

clone

public java.lang.Object clone()

Creates a new object of the same class as this object.

Overrides:

clone in class java.lang.Object

Returns:

a clone of this instance.

Throws:

java.lang.OutOfMemoryError - if there is not enough memory.

See Also:

Cloneable

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object