dk.heick.properties.types.custom

Class Point3D

java.lang.Object

dk.heick.properties.types.custom.Point3D

All Implemented Interfaces:

Serializable, Comparable<Point3D>

public class Point3D
extends Object
implements Serializable, Comparable<Point3D>

A class that holds a point [x,y,z] as doubles.
This is an immutable object.

Since:

1.6

Author:

Frederik Heick

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static char	VALUE_SEPERATOR The character use to seperate the X and Y value when making a to string representation or decoding a string representation.

Constructor Summary

Constructors

Constructor and Description
Point3D() Default construtor, sets X, Y and Z to 0.
Point3D(double x, double y, double z) Constructor with doubles.
Point3D(int x, int y, int z) Constructor with integers (int).

Method Summary

Modifier and Type	Method and Description
int	compareTo(Point3D o) Compares the length of a Point3D
double	distance(Point3D otherPoint) The distance between two points.
boolean	equals(Object obj) Determines if this Point3D is equals with either another Point3D.
boolean	equals(Object obj, double precision) Determines if this Point3D is equals with either another Point3D.
double	getLength() Getting the distance from (0,0,0) to this point.
Point3D	getUnitVector() In mathematics, a unit vector in a normed vector space is a vector (often a spatial vector) whose length is 1 (the unit length).
Double	getX() Gets the X value as a Double
int	getXAsInt() Gets the X value as an int using Double.intValue() method.
Double	getY() Gets the Y value as a Double
int	getYAsInt() Gets the Y value as an int using Double.intValue() method.
Double	getZ() Gets the Z value as a Double
int	getZAsInt() Gets the Z value as an int using Double.intValue() method.
int	hashCode()
Point3D	scale(double factor) Scale the values in this Point with factor an returns the result as a new Point.
String	toString()
Point3D	translate(double dx, double dy, double dz) Translates this point, at location (x,y,z), by dx along the x axis,dy along the y axis and dz along the z axis so that it now represents the point (x+dx,y+dy,z+dz).

Methods inherited from class java.lang.Object

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

Field Detail

VALUE_SEPERATOR

public static final char VALUE_SEPERATOR

The character use to seperate the X and Y value when making a to string representation or decoding a string representation.

See Also:

Constant Field Values

Constructor Detail

Point3D

public Point3D()

Default construtor, sets X, Y and Z to 0.

Point3D

public Point3D(int x,
               int y,
               int z)

Constructor with integers (int).

Parameters:

x - the x int.

y - the y int.

z - the z int.

Point3D

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

Constructor with doubles.

Parameters:

x - the x double.

y - the y double.

z - the x double.

Method Detail

getX

public Double getX()

Gets the X value as a Double

Returns:

the X value.

See Also:

Double

getY

public Double getY()

Gets the Y value as a Double

Returns:

the Y value.

See Also:

Double

getZ

public Double getZ()

Gets the Z value as a Double

Returns:

the Z value.

See Also:

Double

getXAsInt

public int getXAsInt()

Gets the X value as an int using Double.intValue() method.

Returns:

the X value as int.

See Also:

Double.intValue()

getYAsInt

public int getYAsInt()

Gets the Y value as an int using Double.intValue() method.

Returns:

the Y value as int.

See Also:

Double.intValue()

getZAsInt

public int getZAsInt()

Gets the Z value as an int using Double.intValue() method.

Returns:

the Z value as int.

See Also:

Double.intValue()

getLength

public double getLength()

Getting the distance from (0,0,0) to this point.

Returns:

the distance/length of this point using Pythagoras.

distance

public double distance(Point3D otherPoint)
                throws NullPointerException

The distance between two points.

Parameters:

otherPoint - the other Point3D

Returns:

the distance using Phythagoras.

Throws:

NullPointerException - if the otherPoint is null.

scale

public Point3D scale(double factor)

Scale the values in this Point with factor an returns the result as a new Point.

Parameters:

factor - the factor the scale the values with.

Returns:

a new Point3D where the X, Y and Z has be multiplied with the factor.

translate

public Point3D translate(double dx,
                         double dy,
                         double dz)

Translates this point, at location (x,y,z),
by dx along the x axis,dy along the y axis and dz along the z axis so that it now represents the point (x+dx,y+dy,z+dz).

Parameters:

dx - the distance to move this point along the X axis

dy - the distance to move this point along the Y axis

dz - the distance to move this point along the Z axis

Returns:

the result as new Point3D(x+dx,y+dy,z+dz).

getUnitVector

public Point3D getUnitVector()

In mathematics, a unit vector in a normed vector space is a vector (often a spatial vector) whose length is 1 (the unit length).
so this is there result of all the values being divived by the the length.

Returns:

the Point3D as a unit vector.

equals

public boolean equals(Object obj)

Determines if this Point3D is equals with either another Point3D.
Using the PropertyFrameworkGlobals.getDoublePrecision() Double comparator delta.

Overrides:

equals in class Object

See Also:

{@inheritDoc}

equals

public boolean equals(Object obj,
                      double precision)

Determines if this Point3D is equals with either another Point3D.
Using the PropertyFrameworkGlobals.getDoublePrecision() Double comparator delta.

See Also:

equals(Object, double), {@inheritDoc}

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(Point3D o)

Compares the length of a Point3D

Specified by:

compareTo in interface Comparable<Point3D>