Package org.web3d.util.spatial

Interface ReadonlyVec3DDouble

All Known Implementing Classes:

Vec3DDouble

public interface ReadonlyVec3DDouble

Readonly, immutable interface wrapper for Vec3DDouble instances. Used throughout the library for safety purposes.

Method Summary

Modifier and Type	Method	Description
Vec3DDouble	add(double a, double b, double c)	Adds vector {a,b,c} and returns result as new vector.
Vec3DDouble	add(ReadonlyVec3DDouble v)
Vec3DDouble	add(Vec3DDouble v)	Add vector v and returns result as new vector.
double	angleBetween(ReadonlyVec3DDouble v)	Computes the angle between this vector and vector V.
double	angleBetween(ReadonlyVec3DDouble v, boolean forceNormalize)	Computes the angle between this vector and vector V.
int	compareTo(ReadonlyVec3DDouble v)	Compares the length of the vector with another one.
Vec3DDouble	copy()	Copy.
Vec3DDouble	cross(ReadonlyVec3DDouble v)	Calculates cross-product with vector v.
Vec3DDouble	crossInto(ReadonlyVec3DDouble v, Vec3DDouble result)	Calculates cross-product with vector v.
double	distanceTo(ReadonlyVec3DDouble v)	Calculates distance to another vector.
double	distanceToSquared(ReadonlyVec3DDouble v)	Calculates the squared distance to another vector.
double	dot(ReadonlyVec3DDouble v)	Computes the scalar product (dot product) with the given vector.
boolean	equals(Object obj)
boolean	equalsWithTolerance(ReadonlyVec3DDouble v, double tolerance)	Compares this vector with the one given.
Vec3DDouble	getAbs()	Gets the abs.
Vec3DDouble	getCartesian()	Converts the spherical vector back into cartesian coordinates.
double	getComponent(int id)
double	getComponent(Vec3DDouble.Axis id)
Vec3DDouble	getConstrained(toxi.geom.AABB box)	Creates a copy of the vector which forcefully fits in the given AABB.
Vec3DDouble	getFloored()	Creates a new vector whose components are the integer value of their current values.
Vec3DDouble	getFrac()	Creates a new vector whose components are the fractional part of their current values.
Vec3DDouble	getInverted()	Scales vector uniformly by factor -1 ( v = -v ).
Vec3DDouble	getLimited(double lim)	Creates a copy of the vector with its magnitude limited to the length given.
Vec3DDouble	getMapped(toxi.math.ScaleMap map)	Produces a new vector with its coordinates passed through the given ScaleMap.
Vec3DDouble	getNormalized()	Produces the normalized version as a new vector.
Vec3DDouble	getNormalizedTo(double len)	Produces a new vector normalized to the given length.
Vec3DDouble	getReciprocal()	Returns a multiplicative inverse copy of the vector.
Vec3DDouble	getReflected(ReadonlyVec3DDouble normal)
Vec3DDouble	getRotatedAroundAxis(ReadonlyVec3DDouble axis, double theta)	Gets the rotated around axis.
Vec3DDouble	getRotatedX(double theta)	Creates a new vector rotated by the given angle around the X axis.
Vec3DDouble	getRotatedY(double theta)	Creates a new vector rotated by the given angle around the Y axis.
Vec3DDouble	getRotatedZ(double theta)	Creates a new vector rotated by the given angle around the Z axis.
Vec3DDouble	getSignum()	Creates a new vector in which all components are replaced with the signum of their original values.
Vec3DDouble	getSpherical()	Converts the vector into spherical coordinates.
double	headingXY()	Computes the vector's direction in the XY plane (for example for 2D points).
double	headingXZ()	Computes the vector's direction in the XZ plane.
double	headingYZ()	Computes the vector's direction in the YZ plane.
Vec3DDouble	interpolateTo(ReadonlyVec3DDouble v, double f)	Interpolates the vector towards the given target vector, using linear interpolation.
Vec3DDouble	interpolateTo(ReadonlyVec3DDouble v, double f, toxi.math.InterpolateStrategy s)	Interpolates the vector towards the given target vector, using the given InterpolateStrategy.
boolean	isInAABB(Vec3DDouble boxOrigin, Vec3DDouble boxExtent)	Checks if the point is inside the given axis-aligned bounding box.
boolean	isInAABB(toxi.geom.AABB box)	Checks if the point is inside the given AABB.
boolean	isMajorAxis(double tolerance)	Checks if the vector is parallel with either the X or Y axis (any direction).
boolean	isZeroVector()	Checks if vector has a magnitude equals or close to zero (tolerance used is MathUtils.EPS).
double	magnitude()	Calculates the magnitude/eucledian length of the vector.
double	magSquared()	Calculates only the squared magnitude/length of the vector.
Vec3DDouble	scale(double s)	Scales vector uniformly and returns result as new vector.
Vec3DDouble	scale(double a, double b, double c)	Scales vector non-uniformly and returns result as new vector.
Vec3DDouble	scale(ReadonlyVec3DDouble s)	Scales vector non-uniformly by vector v and returns result as new vector.
Vec3DDouble	sub(double a, double b, double c)	Subtracts vector {a,b,c} and returns result as new vector.
Vec3DDouble	sub(ReadonlyVec3DDouble v)	Subtracts vector v and returns result as new vector.
toxi.geom.Vec2D	to2DXY()	Creates a new 2D vector of the XY components.
toxi.geom.Vec2D	to2DXZ()	Creates a new 2D vector of the XZ components.
toxi.geom.Vec2D	to2DYZ()	Creates a new 2D vector of the YZ components.
double[]	toArray()
double[]	toArray4(double w)
double	x()
double	y()
double	z()

Method Details

add

Vec3DDouble add(double a,
 double b,
 double c)

Adds vector {a,b,c} and returns result as new vector.

Parameters:

a - X coordinate

b - Y coordinate

c - Z coordinate

Returns:

result as new vector

add

Vec3DDouble add(ReadonlyVec3DDouble v)

add

Vec3DDouble add(Vec3DDouble v)

Add vector v and returns result as new vector.

Parameters:

v - vector to add

Returns:

result as new vector

angleBetween

double angleBetween(ReadonlyVec3DDouble v)

Computes the angle between this vector and vector V. This function assumes both vectors are normalized, if this can't be guaranteed, use the alternative implementation angleBetween(ReadonlyVec3DDouble, boolean)

Parameters:

v - vector

Returns:

angle in radians, or NaN if vectors are parallel

angleBetween

double angleBetween(ReadonlyVec3DDouble v,
 boolean forceNormalize)

Computes the angle between this vector and vector V.

Parameters:

v - vector

forceNormalize - true, if normalized versions of the vectors are to be used (Note: only copies will be used, original vectors will not be altered by this method)

Returns:

angle in radians, or NaN if vectors are parallel

compareTo

int compareTo(ReadonlyVec3DDouble v)

Compares the length of the vector with another one.

Parameters:

v - vector to compare with

Returns:

-1 if other vector is longer, 0 if both are equal or else +1

copy

Vec3DDouble copy()

Copy.

Returns:

a new independent instance/copy of a given vector

cross

Vec3DDouble cross(ReadonlyVec3DDouble v)

Calculates cross-product with vector v. The resulting vector is perpendicular to both the current and supplied vector.

Parameters:

v - vector to cross

Returns:

cross-product as new vector

crossInto

Vec3DDouble crossInto(ReadonlyVec3DDouble v,
 Vec3DDouble result)

Calculates cross-product with vector v. The resulting vector is perpendicular to both the current and supplied vector and stored in the supplied result vector.

Parameters:

v - vector to cross

result - result vector

Returns:

result vector

distanceTo

double distanceTo(ReadonlyVec3DDouble v)

Calculates distance to another vector.

Parameters:

v - non-null vector

Returns:

distance or Float.NaN if v=null

distanceToSquared

double distanceToSquared(ReadonlyVec3DDouble v)

Calculates the squared distance to another vector.

Parameters:

v - non-null vector

Returns:

distance or NaN if v=null

See Also:

• magSquared()

dot

double dot(ReadonlyVec3DDouble v)

Computes the scalar product (dot product) with the given vector.

Parameters:

v - the v

Returns:

dot product

See Also:

• Wikipedia entry

equals

boolean equals(Object obj)

Overrides:

equals in class Object

equalsWithTolerance

boolean equalsWithTolerance(ReadonlyVec3DDouble v,
 double tolerance)

Compares this vector with the one given. The vectors are deemed equal if the individual differences of all component values are within the given tolerance.

Parameters:

v - the v

tolerance - the tolerance

Returns:

true, if equal

getAbs

Vec3DDouble getAbs()

Gets the abs.

Returns:

the abs

getCartesian

Vec3DDouble getCartesian()

Converts the spherical vector back into cartesian coordinates.

Returns:

new vector

getComponent

double getComponent(Vec3DDouble.Axis id)

getComponent

double getComponent(int id)

getConstrained

Vec3DDouble getConstrained(toxi.geom.AABB box)

Creates a copy of the vector which forcefully fits in the given AABB.

Parameters:

box - the box

Returns:

fitted vector

getFloored

Vec3DDouble getFloored()

Creates a new vector whose components are the integer value of their current values.

Returns:

result as new vector

getFrac

Vec3DDouble getFrac()

Creates a new vector whose components are the fractional part of their current values.

Returns:

result as new vector

getInverted

Vec3DDouble getInverted()

Scales vector uniformly by factor -1 ( v = -v ).

Returns:

result as new vector

getLimited

Vec3DDouble getLimited(double lim)

Creates a copy of the vector with its magnitude limited to the length given.

Parameters:

lim - new maximum magnitude

Returns:

result as new vector

getMapped

Vec3DDouble getMapped(toxi.math.ScaleMap map)

Produces a new vector with its coordinates passed through the given ScaleMap.

Parameters:

map -

Returns:

mapped vector

getNormalized

Vec3DDouble getNormalized()

Produces the normalized version as a new vector.

Returns:

new vector

getNormalizedTo

Vec3DDouble getNormalizedTo(double len)

Produces a new vector normalized to the given length.

Parameters:

len - new desired length

Returns:

new vector

getReciprocal

Vec3DDouble getReciprocal()

Returns a multiplicative inverse copy of the vector.

Returns:

new vector

getReflected

Vec3DDouble getReflected(ReadonlyVec3DDouble normal)

getRotatedAroundAxis

Vec3DDouble getRotatedAroundAxis(ReadonlyVec3DDouble axis,
 double theta)

Gets the rotated around axis.

Parameters:

axis - the axis

theta - the theta

Returns:

new result vector

getRotatedX

Vec3DDouble getRotatedX(double theta)

Creates a new vector rotated by the given angle around the X axis.

Parameters:

theta - the theta

Returns:

rotated vector

getRotatedY

Vec3DDouble getRotatedY(double theta)

Creates a new vector rotated by the given angle around the Y axis.

Parameters:

theta - the theta

Returns:

rotated vector

getRotatedZ

Vec3DDouble getRotatedZ(double theta)

Creates a new vector rotated by the given angle around the Z axis.

Parameters:

theta - the theta

Returns:

rotated vector

getSignum

Vec3DDouble getSignum()

Creates a new vector in which all components are replaced with the signum of their original values. In other words if a components value was negative its new value will be -1, if zero => 0, if positive => +1

Returns:

result vector

getSpherical

Vec3DDouble getSpherical()

Converts the vector into spherical coordinates. After the conversion the vector components are to be interpreted as:

• x = radius
• y = azimuth
• z = theta

Returns:

new vector

headingXY

double headingXY()

Computes the vector's direction in the XY plane (for example for 2D points). The positive X axis equals 0 degrees.

Returns:

rotation angle

headingXZ

double headingXZ()

Computes the vector's direction in the XZ plane. The positive X axis equals 0 degrees.

Returns:

rotation angle

headingYZ

double headingYZ()

Computes the vector's direction in the YZ plane. The positive Z axis equals 0 degrees.

Returns:

rotation angle

interpolateTo

Vec3DDouble interpolateTo(ReadonlyVec3DDouble v,
 double f)

Interpolates the vector towards the given target vector, using linear interpolation.

Parameters:

v - target vector

f - interpolation factor (should be in the range 0..1)

Returns:

result as new vector

interpolateTo

Vec3DDouble interpolateTo(ReadonlyVec3DDouble v,
 double f,
 toxi.math.InterpolateStrategy s)

Interpolates the vector towards the given target vector, using the given InterpolateStrategy.

Parameters:

v - target vector

f - interpolation factor (should be in the range 0..1)

s - InterpolateStrategy instance

Returns:

result as new vector

isInAABB

boolean isInAABB(toxi.geom.AABB box)

Checks if the point is inside the given AABB.

Parameters:

box - bounding box to check

Returns:

true, if point is inside

isInAABB

boolean isInAABB(Vec3DDouble boxOrigin,
 Vec3DDouble boxExtent)

Checks if the point is inside the given axis-aligned bounding box.

Parameters:

boxOrigin - bounding box origin/center

boxExtent - bounding box extends (half measure)

Returns:

true, if point is inside the box

isMajorAxis

boolean isMajorAxis(double tolerance)

Checks if the vector is parallel with either the X or Y axis (any direction).

Parameters:

tolerance -

Returns:

true, if parallel within the given tolerance

isZeroVector

boolean isZeroVector()

Checks if vector has a magnitude equals or close to zero (tolerance used is MathUtils.EPS).

Returns:

true, if zero vector

magnitude

double magnitude()

Calculates the magnitude/eucledian length of the vector.

Returns:

vector length

magSquared

double magSquared()

Calculates only the squared magnitude/length of the vector. Useful for inverse square law applications and/or for speed reasons or if the real eucledian distance is not required (e.g. sorting).

Returns:

squared magnitude (x^2 + y^2 + z^2)

scale

Vec3DDouble scale(double s)

Scales vector uniformly and returns result as new vector.

Parameters:

s - scale factor

Returns:

new vector

scale

Vec3DDouble scale(double a,
 double b,
 double c)

Scales vector non-uniformly and returns result as new vector.

Parameters:

a - scale factor for X coordinate

b - scale factor for Y coordinate

c - scale factor for Z coordinate

Returns:

new vector

scale

Vec3DDouble scale(ReadonlyVec3DDouble s)

Scales vector non-uniformly by vector v and returns result as new vector.

Parameters:

s - scale vector

Returns:

new vector

sub

Vec3DDouble sub(double a,
 double b,
 double c)

Subtracts vector {a,b,c} and returns result as new vector.

Parameters:

a - X coordinate

b - Y coordinate

c - Z coordinate

Returns:

result as new vector

sub

Vec3DDouble sub(ReadonlyVec3DDouble v)

Subtracts vector v and returns result as new vector.

Parameters:

v - vector to be subtracted

Returns:

result as new vector

to2DXY

toxi.geom.Vec2D to2DXY()

Creates a new 2D vector of the XY components.

Returns:

new vector

to2DXZ

toxi.geom.Vec2D to2DXZ()

Creates a new 2D vector of the XZ components.

Returns:

new vector

to2DYZ

toxi.geom.Vec2D to2DYZ()

Creates a new 2D vector of the YZ components.

Returns:

new vector

toArray

double[] toArray()

toArray4

double[] toArray4(double w)

x

double x()

y

double y()

z

double z()