org.apache.commons.geometry.euclidean.threed

Class Vector3D.Unit

java.lang.Object

org.apache.commons.geometry.euclidean.EuclideanVector<V>

org.apache.commons.geometry.euclidean.MultiDimensionalEuclideanVector<Vector3D>

org.apache.commons.geometry.euclidean.threed.Vector3D

org.apache.commons.geometry.euclidean.threed.Vector3D.Unit

All Implemented Interfaces:

Point<Vector3D>, Spatial, Vector<Vector3D>

Enclosing class:

Vector3D

public static final class Vector3D.Unit
extends Vector3D

Represents unit vectors. This allows optimizations for certain operations.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.commons.geometry.euclidean.threed.Vector3D

Vector3D.Sum, Vector3D.Unit

Field Summary

Fields

Modifier and Type	Field and Description
static Vector3D.Unit	MINUS_X Negation of unit vector (coordinates: -1, 0, 0).
static Vector3D.Unit	MINUS_Y Negation of unit vector (coordinates: 0, -1, 0).
static Vector3D.Unit	MINUS_Z Negation of unit vector (coordinates: 0, 0, -1).
static Vector3D.Unit	PLUS_X Unit vector (coordinates: 1, 0, 0).
static Vector3D.Unit	PLUS_Y Unit vector (coordinates: 0, 1, 0).
static Vector3D.Unit	PLUS_Z Unit vector (coordinates: 0, 0, 1).

Fields inherited from class org.apache.commons.geometry.euclidean.threed.Vector3D

COORDINATE_ASCENDING_ORDER, NaN, NEGATIVE_INFINITY, POSITIVE_INFINITY, ZERO

Method Summary

Modifier and Type	Method and Description
static Vector3D.Unit	from(double x, double y, double z) Create a normalized vector.
static Vector3D.Unit	from(Vector3D v) Create a normalized vector.
Vector3D.Unit	negate()
double	norm()
Vector3D.Unit	normalize()
Vector3D.Unit	normalizeOrNull()
double	normSq()
Vector3D	withNorm(double mag)

Methods inherited from class org.apache.commons.geometry.euclidean.threed.Vector3D

add, add, angle, centroid, centroid, cross, directionTo, distance, distanceSq, dot, eq, equals, getDimension, getX, getY, getZ, getZero, hashCode, isFinite, isInfinite, isNaN, lerp, max, max, min, min, multiply, of, of, orthogonal, orthogonal, parse, project, reject, subtract, subtract, toArray, toString, transform, vectorTo

Methods inherited from class org.apache.commons.geometry.euclidean.EuclideanVector

getCheckedNorm, isZero

Methods inherited from class java.lang.Object

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

Field Detail

PLUS_X

public static final Vector3D.Unit PLUS_X

Unit vector (coordinates: 1, 0, 0).

MINUS_X

public static final Vector3D.Unit MINUS_X

Negation of unit vector (coordinates: -1, 0, 0).

PLUS_Y

public static final Vector3D.Unit PLUS_Y

Unit vector (coordinates: 0, 1, 0).

MINUS_Y

public static final Vector3D.Unit MINUS_Y

Negation of unit vector (coordinates: 0, -1, 0).

PLUS_Z

public static final Vector3D.Unit PLUS_Z

Unit vector (coordinates: 0, 0, 1).

MINUS_Z

public static final Vector3D.Unit MINUS_Z

Negation of unit vector (coordinates: 0, 0, -1).

Method Detail

norm

public double norm()

Specified by:

norm in interface Vector<Vector3D>

Overrides:

norm in class Vector3D

normSq

public double normSq()

Specified by:

normSq in interface Vector<Vector3D>

Overrides:

normSq in class Vector3D

normalize

public Vector3D.Unit normalize()

Specified by:

normalize in interface Vector<Vector3D>

Overrides:

normalize in class Vector3D

normalizeOrNull

public Vector3D.Unit normalizeOrNull()

Specified by:

normalizeOrNull in interface Vector<Vector3D>

Overrides:

normalizeOrNull in class Vector3D

withNorm

public Vector3D withNorm(double mag)

Specified by:

withNorm in interface Vector<Vector3D>

Overrides:

withNorm in class Vector3D

negate

public Vector3D.Unit negate()

Specified by:

negate in interface Vector<Vector3D>

Overrides:

negate in class Vector3D

from

public static Vector3D.Unit from(double x,
                                 double y,
                                 double z)

Create a normalized vector.

Parameters:

x - Vector coordinate.

y - Vector coordinate.

z - Vector coordinate.

Returns:

a vector whose norm is 1.

Throws:

IllegalArgumentException - if the norm of the given value is zero, NaN, or infinite

from

public static Vector3D.Unit from(Vector3D v)

Create a normalized vector.

Parameters:

v - Vector.

Returns:

a vector whose norm is 1.

Throws:

IllegalArgumentException - if the norm of the given value is zero, NaN, or infinite