Class Point6Float

java.lang.Object

com.github.yellowstonegames.grid.Point6Float

All Implemented Interfaces:

com.github.tommyettinger.crux.Point6<Point6Float>, com.github.tommyettinger.crux.PointN<Point6Float>, com.github.tommyettinger.crux.PointNFloat<Point6Float, com.github.tommyettinger.crux.Point6<?>>, com.github.tommyettinger.ds.PrimitiveCollection<Float>, com.github.tommyettinger.ds.PrimitiveCollection.OfFloat, PointNFloat<Point6Float, com.github.tommyettinger.crux.Point6<?>>

public class Point6Float
extends Object
implements com.github.tommyettinger.crux.Point6<Point6Float>, PointNFloat<Point6Float, com.github.tommyettinger.crux.Point6<?>>, com.github.tommyettinger.ds.PrimitiveCollection.OfFloat

A mutable 6D point with float components implementing Point6, PrimitiveCollection.OfFloat, and PointNFloat.

Nested Class Summary

Nested classes/interfaces inherited from interface com.github.tommyettinger.ds.PrimitiveCollection

com.github.tommyettinger.ds.PrimitiveCollection.OfBoolean, com.github.tommyettinger.ds.PrimitiveCollection.OfByte, com.github.tommyettinger.ds.PrimitiveCollection.OfChar, com.github.tommyettinger.ds.PrimitiveCollection.OfDouble, com.github.tommyettinger.ds.PrimitiveCollection.OfFloat, com.github.tommyettinger.ds.PrimitiveCollection.OfInt, com.github.tommyettinger.ds.PrimitiveCollection.OfLong, com.github.tommyettinger.ds.PrimitiveCollection.OfShort

Field Summary

Fields

Modifier and Type	Field	Description
float	u
float	v
float	w
float	x
float	y
float	z

Constructor Summary

Constructors

Constructor	Description
Point6Float()
Point6Float(float x, float y, float z, float w, float u, float v)
Point6Float(com.github.tommyettinger.crux.Point6<?> p)
Point6Float(Point6Float p)

Method Summary

Modifier and Type	Method	Description
boolean	add(float c)	Not supported; this collection is fixed-size.
Point6Float	add(float x, float y, float z, float w, float u, float v)
Point6Float	add(com.github.tommyettinger.crux.Point6<?> point)
Point6Float	add(Point6Float point)
Point6Float	addProduct(com.github.tommyettinger.crux.Point6<?> vec, float scalar)
Point6Float	addProduct(com.github.tommyettinger.crux.Point6<?> vec, com.github.tommyettinger.crux.Point6<?> mulVec)
Point6Float	clampEach(float min, float max)	For each component, this clamps it between min and max, inclusive.
Point6Float	clampLength(float min, float max)
void	clear()	Not supported; this collection is fixed-size.
boolean	contains(float c)	Compares c with the components of this collection using ==; if any are considered equal, this returns true.
Point6Float	copy()
Point6Float	cpy()
float	distance(com.github.tommyettinger.crux.Point6<?> point)
float	distanceSquared(com.github.tommyettinger.crux.Point6<?> point)
Point6Float	div(com.github.tommyettinger.crux.Point6<?> point)
Point6Float	div(Point6Float point)
Point6Float	divide(float scalar)
Point6Float	divide(com.github.tommyettinger.crux.Point6<?> point)
float	dot(com.github.tommyettinger.crux.Point6<?> other)
static float	dot(com.github.tommyettinger.crux.Point6<?> a, com.github.tommyettinger.crux.Point6<?> b)
float	dst2(com.github.tommyettinger.crux.Point6<?> point)
float	dst2(Point6Float point)
boolean	equals(Object o)
boolean	floatingPoint()	Returns true if this type of point uses float or double for its components, or false otherwise.
Point6Float	fract()	Sets each component so it only has a fractional value, by subtracting the floor from each component.
Point6Float	fractional()
Point6Float	fromString(String s)	Sets this Point6Float to the value represented by the specified string according to the format of toString().
float	get(int index)	Gets the component at the specified index.
int	hashCode()
Point6Float	interpolate(com.github.tommyettinger.crux.Point6<?> target, float alpha, com.github.tommyettinger.digital.Interpolations.Interpolator interpolation)	Calls PointNFloat.lerp(PointN, float) with the alpha determined by the given interpolation.
Point6Float	inverse()	Assigns to each component of this point 1f divided by its original value.
boolean	isEmpty()
PointNFloatIterator	iterator()
float	len2()
Point6Float	lerp(com.github.tommyettinger.crux.Point6<?> target, float alpha)	Linear-interpolates from this point toward target, moving a distance proportional to alpha and changing this point in-place if possible.
Point6Float	limit(float limit)
Point6Float	limit2(float limit2)
Point6Float	limitSquared(float limit2)
Point6Float	minus(float scalar)
Point6Float	mul(float scalar)	Multiplies each component of this by the given scalar, in-place, and returns this.
Point6Float	mul(float x, float y, float z, float w, float u, float v)	Multiplies each component of this by the corresponding scalar, in-place, and returns this.
Point6Float	mul(com.github.tommyettinger.crux.Point6<?> point)
Point6Float	mul(Point6Float point)
Point6Float	mulAdd(com.github.tommyettinger.crux.Point6<?> vec, float scalar)
Point6Float	mulAdd(com.github.tommyettinger.crux.Point6<?> vec, com.github.tommyettinger.crux.Point6<?> mulVec)
Point6Float	multiply(float scalar)	Multiplies each component of this by the given scalar, in-place, and returns this.
Point6Float	multiply(float x, float y, float z, float w, float u, float v)	Multiplies each component of this by the corresponding scalar, in-place, and returns this.
Point6Float	multiply(com.github.tommyettinger.crux.Point6<?> point)
Point6Float	nor()
Point6Float	normalize()
boolean	notEmpty()
Point6Float	plus(float scalar)
boolean	remove(float c)	Not supported; this collection is fixed-size.
Point6Float	scale(float scalar)
Point6Float	scale(float x, float y, float z, float w, float u, float v)
Point6Float	scale(com.github.tommyettinger.crux.Point6<?> point)
Point6Float	scl(float x, float y, float z, float w, float u, float v)
Point6Float	scl(com.github.tommyettinger.crux.Point6<?> point)
Point6Float	scl(Point6Float point)
Point6Float	set(float x, float y, float z, float w, float u, float v)
Point6Float	set(com.github.tommyettinger.crux.Point6<?> point)
Point6Float	set(Point6Float point)
Point6Float	setAt(int index, float value)	Sets the component at the specified index to the specified value.
Point6Float	setLength(float len)
Point6Float	setLength2(float len2)
Point6Float	setToRandomDirection(Random random)	Sets this PointNFloat to a randomly chosen unit vector.
Point6Float	setZero()
int	size()
Point6Float	slerpGeometric(Point6Float target, float alpha)
Point6Float	sub(float x, float y, float z, float w, float u, float v)
Point6Float	sub(com.github.tommyettinger.crux.Point6<?> point)
Point6Float	sub(Point6Float point)
Point6Float	subtract(float x, float y, float z, float w, float u, float v)
Point6Float	subtract(com.github.tommyettinger.crux.Point6<?> point)
Point6Float	times(float scalar)
String	toString()	Converts this Point6Float to a string in the format (x,y,z,w,u,v).
float	u()
Point6Float	u(float next)
float	v()
Point6Float	v(float next)
float	w()
Point6Float	w(float next)
float	x()
Point6Float	x(float next)
float	y()
Point6Float	y(float next)
float	z()
Point6Float	z(float next)

Methods inherited from class Object

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

Methods inherited from interface com.github.tommyettinger.crux.Point6

rank, seti, ui, ui, vi, vi, wi, wi, xi, xi, yi, yi, zi, zi

Methods inherited from interface com.github.tommyettinger.crux.PointN

dst, isUnit, isUnit, isZero, isZero, len, mutable

Methods inherited from interface com.github.tommyettinger.ds.PrimitiveCollection.OfFloat

addAll, addAll, addAll, addAll, addDense, addDense, addLegible, addLegible, addVarargs, appendTo, appendTo, containsAll, containsAll, containsAll, containsAll, containsAny, containsAny, containsAny, containsAny, denseAppendTo, first, forEach, removeAll, removeAll, removeAll, removeAll, removeEach, removeEach, removeEach, removeEach, removeIf, retainAll, retainAll, retainAll, toArray, toArray, toDenseString, toDenseString, toString, toString, toString

Field Details

x

public float x

y

public float y

z

public float z

w

public float w

u

public float u

v

public float v

Constructor Details

Point6Float

public Point6Float()

Point6Float

public Point6Float(float x,
 float y,
 float z,
 float w,
 float u,
 float v)

Point6Float

public Point6Float(Point6Float p)

Point6Float

public Point6Float(com.github.tommyettinger.crux.Point6<?> p)

Method Details

floatingPoint

public boolean floatingPoint()

Returns true if this type of point uses float or double for its components, or false otherwise. This always returns false.

Specified by:

floatingPoint in interface com.github.tommyettinger.crux.PointN<Point6Float>

Specified by:

floatingPoint in interface com.github.tommyettinger.crux.PointNFloat<Point6Float, com.github.tommyettinger.crux.Point6<?>>

Specified by:

floatingPoint in interface PointNFloat<Point6Float, com.github.tommyettinger.crux.Point6<?>>

Returns:

false

cpy

public Point6Float cpy()

Specified by:

cpy in interface com.github.tommyettinger.crux.PointN<Point6Float>

copy

public Point6Float copy()

len2

public float len2()

Specified by:

len2 in interface com.github.tommyettinger.crux.PointN<Point6Float>

set

public Point6Float set(Point6Float point)

Specified by:

set in interface com.github.tommyettinger.crux.PointN<Point6Float>

set

public Point6Float set(com.github.tommyettinger.crux.Point6<?> point)

sub

public Point6Float sub(Point6Float point)

Specified by:

sub in interface com.github.tommyettinger.crux.PointN<Point6Float>

sub

public Point6Float sub(com.github.tommyettinger.crux.Point6<?> point)

subtract

public Point6Float subtract(com.github.tommyettinger.crux.Point6<?> point)

add

public Point6Float add(Point6Float point)

Specified by:

add in interface com.github.tommyettinger.crux.PointN<Point6Float>

add

public Point6Float add(com.github.tommyettinger.crux.Point6<?> point)

scl

public Point6Float scl(Point6Float point)

Specified by:

scl in interface com.github.tommyettinger.crux.PointN<Point6Float>

scl

public Point6Float scl(com.github.tommyettinger.crux.Point6<?> point)

scale

public Point6Float scale(com.github.tommyettinger.crux.Point6<?> point)

mul

public Point6Float mul(Point6Float point)

mul

public Point6Float mul(com.github.tommyettinger.crux.Point6<?> point)

multiply

public Point6Float multiply(com.github.tommyettinger.crux.Point6<?> point)

div

public Point6Float div(Point6Float point)

Specified by:

div in interface com.github.tommyettinger.crux.PointN<Point6Float>

div

public Point6Float div(com.github.tommyettinger.crux.Point6<?> point)

divide

public Point6Float divide(com.github.tommyettinger.crux.Point6<?> point)

dst2

public float dst2(Point6Float point)

Specified by:

dst2 in interface com.github.tommyettinger.crux.PointN<Point6Float>

dst2

public float dst2(com.github.tommyettinger.crux.Point6<?> point)

distance

public float distance(com.github.tommyettinger.crux.Point6<?> point)

distanceSquared

public float distanceSquared(com.github.tommyettinger.crux.Point6<?> point)

setZero

public Point6Float setZero()

Specified by:

setZero in interface com.github.tommyettinger.crux.PointN<Point6Float>

x

public float x()

Specified by:

x in interface com.github.tommyettinger.crux.Point6<Point6Float>

x

public Point6Float x(float next)

Specified by:

x in interface com.github.tommyettinger.crux.Point6<Point6Float>

y

public float y()

Specified by:

y in interface com.github.tommyettinger.crux.Point6<Point6Float>

y

public Point6Float y(float next)

Specified by:

y in interface com.github.tommyettinger.crux.Point6<Point6Float>

z

public float z()

Specified by:

z in interface com.github.tommyettinger.crux.Point6<Point6Float>

z

public Point6Float z(float next)

Specified by:

z in interface com.github.tommyettinger.crux.Point6<Point6Float>

w

public float w()

Specified by:

w in interface com.github.tommyettinger.crux.Point6<Point6Float>

w

public Point6Float w(float next)

Specified by:

w in interface com.github.tommyettinger.crux.Point6<Point6Float>

u

public float u()

Specified by:

u in interface com.github.tommyettinger.crux.Point6<Point6Float>

u

public Point6Float u(float next)

Specified by:

u in interface com.github.tommyettinger.crux.Point6<Point6Float>

v

public float v()

Specified by:

v in interface com.github.tommyettinger.crux.Point6<Point6Float>

v

public Point6Float v(float next)

Specified by:

v in interface com.github.tommyettinger.crux.Point6<Point6Float>

set

public Point6Float set(float x,
 float y,
 float z,
 float w,
 float u,
 float v)

Specified by:

set in interface com.github.tommyettinger.crux.Point6<Point6Float>

nor

public Point6Float nor()

Specified by:

nor in interface com.github.tommyettinger.crux.PointN<Point6Float>

normalize

public Point6Float normalize()

add

public Point6Float add(float x,
 float y,
 float z,
 float w,
 float u,
 float v)

sub

public Point6Float sub(float x,
 float y,
 float z,
 float w,
 float u,
 float v)

subtract

public Point6Float subtract(float x,
 float y,
 float z,
 float w,
 float u,
 float v)

plus

public Point6Float plus(float scalar)

Specified by:

plus in interface com.github.tommyettinger.crux.PointN<Point6Float>

minus

public Point6Float minus(float scalar)

Specified by:

minus in interface com.github.tommyettinger.crux.PointN<Point6Float>

times

public Point6Float times(float scalar)

Specified by:

times in interface com.github.tommyettinger.crux.PointN<Point6Float>

scale

public Point6Float scale(float scalar)

scl

public Point6Float scl(float x,
 float y,
 float z,
 float w,
 float u,
 float v)

scale

public Point6Float scale(float x,
 float y,
 float z,
 float w,
 float u,
 float v)

mul

public Point6Float mul(float scalar)

Multiplies each component of this by the given scalar, in-place, and returns this. This is an alias for times(float).

Parameters:

scalar - a float that will be multiplied with each component

Returns:

this, for chaining

multiply

public Point6Float multiply(float scalar)

Multiplies each component of this by the given scalar, in-place, and returns this. This is an alias for times(float).

Parameters:

scalar - a float that will be multiplied with each component

Returns:

this, for chaining

mul

public Point6Float mul(float x,
 float y,
 float z,
 float w,
 float u,
 float v)

Multiplies each component of this by the corresponding scalar, in-place, and returns this. This is an alias for scl(float, float, float, float, float, float).

Parameters:

x - a float that will be multiplied with x

y - a float that will be multiplied with y

Returns:

this, for chaining

multiply

public Point6Float multiply(float x,
 float y,
 float z,
 float w,
 float u,
 float v)

Multiplies each component of this by the corresponding scalar, in-place, and returns this. This is an alias for scl(float, float, float, float, float, float).

Parameters:

x - a float that will be multiplied with x

y - a float that will be multiplied with y

Returns:

this, for chaining

divide

public Point6Float divide(float scalar)

Specified by:

divide in interface com.github.tommyettinger.crux.PointN<Point6Float>

addProduct

public Point6Float addProduct(com.github.tommyettinger.crux.Point6<?> vec,
 float scalar)

mulAdd

public Point6Float mulAdd(com.github.tommyettinger.crux.Point6<?> vec,
 float scalar)

mulAdd

public Point6Float mulAdd(com.github.tommyettinger.crux.Point6<?> vec,
 com.github.tommyettinger.crux.Point6<?> mulVec)

addProduct

public Point6Float addProduct(com.github.tommyettinger.crux.Point6<?> vec,
 com.github.tommyettinger.crux.Point6<?> mulVec)

limit

public Point6Float limit(float limit)

limit2

public Point6Float limit2(float limit2)

limitSquared

public Point6Float limitSquared(float limit2)

clampLength

public Point6Float clampLength(float min,
 float max)

setLength

public Point6Float setLength(float len)

setLength2

public Point6Float setLength2(float len2)

dot

public float dot(com.github.tommyettinger.crux.Point6<?> other)

dot

public static float dot(com.github.tommyettinger.crux.Point6<?> a,
 com.github.tommyettinger.crux.Point6<?> b)

lerp

public Point6Float lerp(com.github.tommyettinger.crux.Point6<?> target,
 float alpha)

Description copied from interface: PointNFloat

Linear-interpolates from this point toward target, moving a distance proportional to alpha and changing this point in-place if possible. If this point is not PointN.mutable(), this will return a new or pooled point. The alpha is expected to be in the 0 to 1 range, inclusive.

Specified by:

lerp in interface com.github.tommyettinger.crux.PointNFloat<Point6Float, com.github.tommyettinger.crux.Point6<?>>

Specified by:

lerp in interface PointNFloat<Point6Float, com.github.tommyettinger.crux.Point6<?>>

Parameters:

target - any point with the same dimension to move toward

alpha - between 0 and 1, inclusive

Returns:

this point after modifications, if possible, or a new PointNFloat if this is immutable

interpolate

public Point6Float interpolate(com.github.tommyettinger.crux.Point6<?> target,
 float alpha,
 com.github.tommyettinger.digital.Interpolations.Interpolator interpolation)

Description copied from interface: PointNFloat

Calls PointNFloat.lerp(PointN, float) with the alpha determined by the given interpolation. Simply returns lerp(target, interpolation.apply(alpha)) .

Specified by:

interpolate in interface PointNFloat<Point6Float, com.github.tommyettinger.crux.Point6<?>>

Parameters:

target - any point with the same dimension to move toward

alpha - between 0 and 1, inclusive

interpolation - an Interpolator from digital, such as Interpolations.smooth

Returns:

this point after modifications, if possible, or a new PointNFloat if this is immutable

slerpGeometric

public Point6Float slerpGeometric(Point6Float target,
 float alpha)

setToRandomDirection

public Point6Float setToRandomDirection(Random random)

Description copied from interface: PointNFloat

Sets this PointNFloat to a randomly chosen unit vector. The exact algorithm is expected to vary between dimensions. In 2D, for instance, it is sufficient to get a random float between 0 and 1, and call TrigTools.cosTurns(float) and TrigTools.sinTurns(float) to get x and y. In higher dimensions, this gets more complex. A solution that works for any dimension, but is only the best option for 4D and up, is to assign to each component a normal-distributed float using Distributor.probitF(float) with random inputs, then normalize the PointNFloat with PointN.nor().

Specified by:

setToRandomDirection in interface PointNFloat<Point6Float, com.github.tommyettinger.crux.Point6<?>>

Parameters:

random - any Random or subclass thereof

Returns:

this point after modifications, if possible, or a new PointNFloat if this is immutable

clampEach

public Point6Float clampEach(float min,
 float max)

For each component, this clamps it between min and max, inclusive.

Parameters:

min - the minimum value allowable for any component, inclusive

max - the maximum value allowable for any component, inclusive

Returns:

this, after modifications

fract

public Point6Float fract()

Sets each component so it only has a fractional value, by subtracting the floor from each component. This produces a non-negative float for each component, between 0.0 inclusive and 1.0 exclusive, unless a component is outside the safe range for MathTools.floor(float) (-16384.0 at the lowest).

The result of fract() for a component with a value of  1.25 will be 0.25 .
The result of fract() for a component with a value of -1.25 will be 0.75 .

Returns:

this, after modifications

fractional

public Point6Float fractional()

inverse

public Point6Float inverse()

Assigns to each component of this point 1f divided by its original value. If a component is 0.0f, its value after this will be positive infinity. If a component is -0.0f, its value after this will be negative infinity.

Specified by:

inverse in interface com.github.tommyettinger.crux.PointNFloat<Point6Float, com.github.tommyettinger.crux.Point6<?>>

Specified by:

inverse in interface PointNFloat<Point6Float, com.github.tommyettinger.crux.Point6<?>>

Returns:

1f divided by this point, assigned in-place to this

get

public float get(int index)

Gets the component at the specified index. Kotlin-compatible using square-bracket indexing.

Specified by:

get in interface com.github.tommyettinger.crux.PointNFloat<Point6Float, com.github.tommyettinger.crux.Point6<?>>

Specified by:

get in interface PointNFloat<Point6Float, com.github.tommyettinger.crux.Point6<?>>

Parameters:

index - which component to get, in order

Returns:

the component

setAt

public Point6Float setAt(int index,
 float value)

Sets the component at the specified index to the specified value.

Specified by:

setAt in interface com.github.tommyettinger.crux.PointNFloat<Point6Float, com.github.tommyettinger.crux.Point6<?>>

Specified by:

setAt in interface PointNFloat<Point6Float, com.github.tommyettinger.crux.Point6<?>>

Parameters:

index - which component to set, in order

value - the value to assign at index

Returns:

this, for chaining

equals

public boolean equals(Object o)

Specified by:

equals in interface com.github.tommyettinger.ds.PrimitiveCollection<Float>

Overrides:

equals in class Object

hashCode

public int hashCode()

Specified by:

hashCode in interface com.github.tommyettinger.ds.PrimitiveCollection<Float>

Overrides:

hashCode in class Object

toString

public String toString()

Converts this Point6Float to a string in the format (x,y,z,w,u,v).

Overrides:

toString in class Object

Returns:

a string representation of this object.

fromString

public Point6Float fromString(String s)

Sets this Point6Float to the value represented by the specified string according to the format of toString().

Parameters:

s - the string.

Returns:

this point for chaining

add

public boolean add(float c)

Not supported; this collection is fixed-size.

Specified by:

add in interface com.github.tommyettinger.ds.PrimitiveCollection.OfFloat

Parameters:

c - ignored

Returns:

never returns

Throws:

UnsupportedOperationException - always

remove

public boolean remove(float c)

Not supported; this collection is fixed-size.

Specified by:

remove in interface com.github.tommyettinger.ds.PrimitiveCollection.OfFloat

Parameters:

c - ignored

Returns:

never returns

Throws:

UnsupportedOperationException - always

clear

public void clear()

Not supported; this collection is fixed-size.

Specified by:

clear in interface com.github.tommyettinger.ds.PrimitiveCollection<Float>

Throws:

UnsupportedOperationException - always

contains

public boolean contains(float c)

Compares c with the components of this collection using ==; if any are considered equal, this returns true.

Specified by:

contains in interface com.github.tommyettinger.ds.PrimitiveCollection.OfFloat

Parameters:

c - a float to be compared using ==

Returns:

true if any component of this collection is equal to c via == comparison

size

public int size()

Specified by:

size in interface com.github.tommyettinger.ds.PrimitiveCollection<Float>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface com.github.tommyettinger.ds.PrimitiveCollection<Float>

notEmpty

public boolean notEmpty()

Specified by:

notEmpty in interface com.github.tommyettinger.ds.PrimitiveCollection<Float>

iterator

public PointNFloatIterator iterator()

Specified by:

iterator in interface com.github.tommyettinger.ds.PrimitiveCollection<Float>

Specified by:

iterator in interface com.github.tommyettinger.ds.PrimitiveCollection.OfFloat