org.openimaj.math.geometry.point

Class Point3dImpl

java.lang.Object

org.openimaj.math.geometry.point.Point3dImpl

All Implemented Interfaces:

Cloneable, Readable, ReadableASCII, ReadableBinary, ReadWriteable, Writeable, WriteableASCII, WriteableBinary, Coordinate, Point3d

public class Point3dImpl
extends Object
implements Point3d, Cloneable

Simple concrete implementation of a three dimensional point.

Author:

Jonathon Hare

Field Summary

Fields

Modifier and Type	Field and Description
double	x The x-ordinate
double	y The y-ordinate
double	z The z-ordinate

Constructor Summary

Constructors

Constructor and Description
Point3dImpl() Construct a Point3dImpl at the origin.
Point3dImpl(double[] array) Construct a Point3dImpl with the given (x, y, z) coordinates packed into an array
Point3dImpl(double x, double y, double z) Construct a Point3dImpl with the given (x, y, z) coordinates
Point3dImpl(Point3d p) Construct a Point3dImpl with the (x,y,z) coordinates given via another point.

Method Summary

Modifier and Type	Method and Description
String	asciiHeader() Header for ascii input.
byte[]	binaryHeader() Header for binary input.
Point3dImpl	clone()
Point3dImpl	copy() Clone the point
void	copyFrom(Point3d p) Copy the values of the given point into this point.
static Point3d	createRandomPoint() Create a random point in ([0..1], [0..1], [0..1]).
boolean	equals(Object o)
int	getDimensions()
Double	getOrdinate(int dimension) Get the ordinate value for a specific dimension.
double	getX()
double	getY()
double	getZ()
int	hashCode()
Point3d	minus(Point3d a) Take point point from another point such that return = this - a
void	readASCII(Scanner in) Read internal state from in.
void	readBinary(DataInput in) Read internal state from in.
void	setOrdinate(int dimension, Number value) Set the ordinate value for a specific dimension.
void	setX(double x) Set x coordinate of point
void	setY(double y) Set y coordinate of point
void	setZ(double z) Set z coordinate of point
String	toString()
Point3dImpl	transform(Jama.Matrix transform) Transform the point by the given matrix
void	translate(double x, double y, double z) Translate the position of the point by the given amounts
void	translate(Point3d v) Translate the position of the point by the given amounts
void	writeASCII(PrintWriter out) Write the content of this as ascii to out.
void	writeBinary(DataOutput out) Write the content of this as binary to out.

Methods inherited from class java.lang.Object

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

Field Detail

x

public double x

The x-ordinate

y

public double y

The y-ordinate

z

public double z

The z-ordinate

Constructor Detail

Point3dImpl

public Point3dImpl(double x,
                   double y,
                   double z)

Construct a Point3dImpl with the given (x, y, z) coordinates

Parameters:

x - x-ordinate

y - y-ordinate

z - z-ordinate

Point3dImpl

public Point3dImpl(double[] array)

Construct a Point3dImpl with the given (x, y, z) coordinates packed into an array

Parameters:

array - the coordinates ([x, y, z])

Point3dImpl

public Point3dImpl(Point3d p)

Construct a Point3dImpl with the (x,y,z) coordinates given via another point.

Parameters:

p - The point to copy from.

Point3dImpl

public Point3dImpl()

Construct a Point3dImpl at the origin.

Method Detail

getX

public double getX()

Specified by:

getX in interface Point3d

Returns:

x coordinate of point

setX

public void setX(double x)

Description copied from interface: Point3d

Set x coordinate of point

Specified by:

setX in interface Point3d

Parameters:

x - x-coordinate

getY

public double getY()

Specified by:

getY in interface Point3d

Returns:

y coordinate of point

setY

public void setY(double y)

Description copied from interface: Point3d

Set y coordinate of point

Specified by:

setY in interface Point3d

Parameters:

y - y-coordinate

getZ

public double getZ()

Specified by:

getZ in interface Point3d

Returns:

z coordinate of point

setZ

public void setZ(double z)

Description copied from interface: Point3d

Set z coordinate of point

Specified by:

setZ in interface Point3d

Parameters:

z - z-coordinate

copyFrom

public void copyFrom(Point3d p)

Description copied from interface: Point3d

Copy the values of the given point into this point.

Specified by:

copyFrom in interface Point3d

Parameters:

p - The point to copy values from.

toString

public String toString()

Overrides:

toString in class Object

clone

public Point3dImpl clone()

Overrides:

clone in class Object

getOrdinate

public Double getOrdinate(int dimension)

Description copied from interface: Coordinate

Get the ordinate value for a specific dimension.

Specified by:

getOrdinate in interface Coordinate

Parameters:

dimension - The index of the dimension we are interested in

Returns:

The value of the ordinate of the given dimension.

getDimensions

public int getDimensions()

Specified by:

getDimensions in interface Coordinate

Returns:

The number of dimensions in the coordinate.

translate

public void translate(double x,
                      double y,
                      double z)

Description copied from interface: Point3d

Translate the position of the point by the given amounts

Specified by:

translate in interface Point3d

Parameters:

x - x-amount

y - y-amount

z - z-amount

translate

public void translate(Point3d v)

Description copied from interface: Point3d

Translate the position of the point by the given amounts

Specified by:

translate in interface Point3d

Parameters:

v - the vector to translate by

transform

public Point3dImpl transform(Jama.Matrix transform)

Description copied from interface: Point3d

Transform the point by the given matrix

Specified by:

transform in interface Point3d

Returns:

a copy

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

minus

public Point3d minus(Point3d a)

Description copied from interface: Point3d

Take point point from another point such that return = this - a

Specified by:

minus in interface Point3d

Returns:

a new point

readASCII

public void readASCII(Scanner in)
               throws IOException

Description copied from interface: ReadableASCII

Read internal state from in.

Specified by:

readASCII in interface ReadableASCII

Parameters:

in - source to read from.

Throws:

IOException - an error reading input

asciiHeader

public String asciiHeader()

Description copied from interface: ReadableASCII

Header for ascii input. Will be automatically read by IOUtils when using readASCII().

Specified by:

asciiHeader in interface ReadableASCII

Specified by:

asciiHeader in interface WriteableASCII

Returns:

header

readBinary

public void readBinary(DataInput in)
                throws IOException

Description copied from interface: ReadableBinary

Read internal state from in.

Specified by:

readBinary in interface ReadableBinary

Parameters:

in - source to read from.

Throws:

IOException - an error reading input

binaryHeader

public byte[] binaryHeader()

Description copied from interface: ReadableBinary

Header for binary input. Will be automatically read by IOUtils when using readBinary().

Specified by:

binaryHeader in interface ReadableBinary

Specified by:

binaryHeader in interface WriteableBinary

Returns:

header

writeASCII

public void writeASCII(PrintWriter out)
                throws IOException

Description copied from interface: WriteableASCII

Write the content of this as ascii to out.

Specified by:

writeASCII in interface WriteableASCII

Parameters:

out - sink to write to

Throws:

IOException - an error writing to out

writeBinary

public void writeBinary(DataOutput out)
                 throws IOException

Description copied from interface: WriteableBinary

Write the content of this as binary to out.

Specified by:

writeBinary in interface WriteableBinary

Parameters:

out - sink to write to

Throws:

IOException - an error writing to out

copy

public Point3dImpl copy()

Description copied from interface: Point3d

Clone the point

Specified by:

copy in interface Point3d

Returns:

a copy of the point

createRandomPoint

public static Point3d createRandomPoint()

Create a random point in ([0..1], [0..1], [0..1]).

Returns:

random point.

setOrdinate

public void setOrdinate(int dimension,
                        Number value)

Description copied from interface: Coordinate

Set the ordinate value for a specific dimension.

Specified by:

setOrdinate in interface Coordinate

Parameters:

dimension - The index of the dimension we are interested in

value - The value of the ordinate of the given dimension.