team.unnamed.creative.base

Class Vector3Float

java.lang.Object

team.unnamed.creative.base.Vector3Float

All Implemented Interfaces:

java.lang.Iterable<java.lang.Float>, net.kyori.examination.Examinable

public final class Vector3Float
extends java.lang.Object
implements net.kyori.examination.Examinable, java.lang.Iterable<java.lang.Float>

Represents a fixed-size vector of three 32-bit floating-point numbers, immutable.

Since:

1.0.0

Field Summary

Fields

Modifier and Type	Field and Description
static Vector3Float	ONE Constant for Vector3Float value with abscissa, ordinate and applicate of 1 one.
static Vector3Float	ZERO Constant for Vector3Float value with abscissa, ordinate and applicate of 0 zero.

Constructor Summary

Constructors

Constructor and Description
Vector3Float(float x, float y, float z) Constructs a new Vector3Float with the given x, y and z values.

Method Summary

Modifier and Type	Method and Description
@NotNull Vector3Float	add(float x, float y, float z) Returns a new vector result of adding the given x, y and z values to this vector.
@NotNull Vector3Float	add(@NotNull Vector3Float value) Returns a new vector result of adding the given value to this vector.
@NotNull Vector3Float	crossProduct(@NotNull Vector3Float vector) Returns the cross product of this and the given vector.
@NotNull Vector3Float	divide(float value) Returns a new vector result of dividing this vector by the given scalar value.
@NotNull Vector3Float	divide(float x, float y, float z) Returns a new vector result of dividing this vector by the given x, y and z values, one by one.
@NotNull Vector3Float	divide(@NotNull Vector3Float value) Returns a new vector result of dividing this vector by the given value, one by one (Xa/Xb, Ya/Yb, Za/Zb).
float	dot(@NotNull Vector3Float vector) Returns the dot product of this and the given vector.
boolean	equals(java.lang.Object o)
@NotNull java.util.stream.Stream<? extends net.kyori.examination.ExaminableProperty>	examinableProperties()
float	get(@NotNull Axis3D axis) Returns the component at a specific Axis3D, fails if axis is invalid
int	hashCode()
@NotNull java.util.Iterator<java.lang.Float>	iterator()
@NotNull Vector3Float	multiply(float value) Returns a new vector result of multiplying this vector by the given scalar value.
@NotNull Vector3Float	multiply(float x, float y, float z) Returns a new vector result of multiplying this vector by the given x, y and z values, one by one.
@NotNull Vector3Float	multiply(@NotNull Vector3Float value) Returns a new vector result of multiplying this vector by the given value, one by one (Xa*Xb, Ya*Yb, Za*Zb).
@NotNull Vector3Float	subtract(float x, float y, float z) Returns a new vector result of subtracting the given x, y and z values from this vector.
@NotNull Vector3Float	subtract(@NotNull Vector3Float value) Returns a new vector result of subtracting the given value from this vector.
float[]	toArray() Converts this vector to an array of float values with X, Y, Z order.
java.lang.String	toString()
@NotNull Vector3Float	with(@NotNull Axis3D axis, float value) Returns a new vector which is the same as this vector, but with one component updated.
float	x() Returns the "X" component or abscissa of this vector.
@NotNull Vector3Float	x(float x) Returns a new vector with the given x value and the same y and z values as this vector.
float	y() Returns the "Y" component or ordinate of this vector.
@NotNull Vector3Float	y(float y) Returns a new vector with the given y value and the same x and z values as this vector.
float	z() Returns the "Z" component or applicate of this vector.
@NotNull Vector3Float	z(float z) Returns a new vector with the given z value and the same x and y values as this vector.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.kyori.examination.Examinable

examinableName, examine

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

ZERO

public static final Vector3Float ZERO

Constant for Vector3Float value with abscissa, ordinate and applicate of 0 zero.

Since:

1.0.0

ONE

public static final Vector3Float ONE

Constant for Vector3Float value with abscissa, ordinate and applicate of 1 one.

Since:

1.0.0

Constructor Detail

Vector3Float

public Vector3Float(float x,
                    float y,
                    float z)

Constructs a new Vector3Float with the given x, y and z values.

Parameters:

x - The vector abscissa

y - The vector ordinate

z - The vector applicate

Since:

1.0.0

Method Detail

x

public float x()

Returns the "X" component or abscissa of this vector.

Returns:

The vector abscissa

Since:

1.0.0

x

@Contract(value="_ -> new",
          pure=true)
 @NotNull
public @NotNull Vector3Float x(float x)

Returns a new vector with the given x value and the same y and z values as this vector.

Parameters:

x - The new X value

Returns:

The updated vector

Since:

1.0.0

y

public float y()

Returns the "Y" component or ordinate of this vector.

Returns:

The vector ordinate

Since:

1.0.0

y

@Contract(value="_ -> new",
          pure=true)
 @NotNull
public @NotNull Vector3Float y(float y)

Returns a new vector with the given y value and the same x and z values as this vector.

Parameters:

y - The new Y value

Returns:

The updated vector

Since:

1.0.0

z

public float z()

Returns the "Z" component or applicate of this vector.

Returns:

The vector applicate

Since:

1.0.0

z

@Contract(value="_ -> new",
          pure=true)
 @NotNull
public @NotNull Vector3Float z(float z)

Returns a new vector with the given z value and the same x and y values as this vector.

Parameters:

z - The new Z value

Returns:

The updated vector

Since:

1.0.0

add

@Contract(value="_, _, _ -> new",
          pure=true)
 @NotNull
public @NotNull Vector3Float add(float x,
                                                                                                     float y,
                                                                                                     float z)

Returns a new vector result of adding the given x, y and z values to this vector.

Parameters:

x - The value to add to the abscissa

y - The value to add to the ordinate

z - The value to add to the applicate

Returns:

The result vector

Since:

1.0.0

add

@Contract(value="_ -> new",
          pure=true)
 @NotNull
public @NotNull Vector3Float add(@NotNull
                                                                                               @NotNull Vector3Float value)

Returns a new vector result of adding the given value to this vector.

Parameters:

value - The value to add

Returns:

The result vector

Since:

1.0.0

subtract

@Contract(value="_, _, _ -> new",
          pure=true)
 @NotNull
public @NotNull Vector3Float subtract(float x,
                                                                                                          float y,
                                                                                                          float z)

Returns a new vector result of subtracting the given x, y and z values from this vector.

Parameters:

x - The value to subtract from the abscissa

y - The value to subtract from the ordinate

z - The value to subtract from the applicate

Returns:

The result vector

Since:

1.0.0

subtract

@Contract(value="_ -> new",
          pure=true)
 @NotNull
public @NotNull Vector3Float subtract(@NotNull
                                                                                                    @NotNull Vector3Float value)

Returns a new vector result of subtracting the given value from this vector.

Parameters:

value - The value to subtract

Returns:

The result vector

Since:

1.0.0

multiply

@NotNull
public @NotNull Vector3Float multiply(float value)

Returns a new vector result of multiplying this vector by the given scalar value.

Parameters:

value - The scalar value

Returns:

The result vector

Since:

1.0.0

multiply

@NotNull
public @NotNull Vector3Float multiply(float x,
                                                float y,
                                                float z)

Returns a new vector result of multiplying this vector by the given x, y and z values, one by one.

Parameters:

x - The factor for the abscissa

y - The factor for the ordinate

z - The factor for the applicate

Returns:

The result vector

Since:

1.0.0

multiply

@NotNull
public @NotNull Vector3Float multiply(@NotNull
                                                @NotNull Vector3Float value)

Returns a new vector result of multiplying this vector by the given value, one by one (Xa*Xb, Ya*Yb, Za*Zb).

Parameters:

value - The factor vector

Returns:

The result vector

Since:

1.0.0

divide

@Contract(value="_ -> new",
          pure=true)
 @NotNull
public @NotNull Vector3Float divide(float value)

Returns a new vector result of dividing this vector by the given scalar value.

Parameters:

value - The divisor

Returns:

The result vector

Since:

1.0.0

divide

@Contract(value="_, _, _ -> new",
          pure=true)
 @NotNull
public @NotNull Vector3Float divide(float x,
                                                                                                        float y,
                                                                                                        float z)

Returns a new vector result of dividing this vector by the given x, y and z values, one by one.

Parameters:

x - The divisor for the abscissa

y - The divisor for the ordinate

z - The divisor for the applicate

Returns:

The result vector

Since:

1.0.0

divide

@Contract(value="_ -> new",
          pure=true)
 @NotNull
public @NotNull Vector3Float divide(@NotNull
                                                                                                  @NotNull Vector3Float value)

Returns a new vector result of dividing this vector by the given value, one by one (Xa/Xb, Ya/Yb, Za/Zb).

Parameters:

value - The divisor vector

Returns:

The result vector

Since:

1.0.0

dot

@Contract(pure=true)
public float dot(@NotNull
                                       @NotNull Vector3Float vector)

Returns the dot product of this and the given vector.

Parameters:

vector - The vector to calculate the dot product with

Returns:

The dot product

Since:

1.0.0

crossProduct

@Contract(value="_ -> new",
          pure=true)
 @NotNull
public @NotNull Vector3Float crossProduct(@NotNull
                                                                                                        @NotNull Vector3Float vector)

Returns the cross product of this and the given vector.

Parameters:

vector - The vector to calculate the cross product with

Returns:

The cross product

Since:

1.0.0

with

@Contract(value="_, _ -> new",
          pure=true)
 @NotNull
public @NotNull Vector3Float with(@NotNull
                                                                                                   @NotNull Axis3D axis,
                                                                                                   float value)

Returns a new vector which is the same as this vector, but with one component updated.

Parameters:

axis - The axis to update

value - The new value for the axis

Returns:

The updated vector

Since:

1.0.0

get

public float get(@NotNull
                 @NotNull Axis3D axis)

Returns the component at a specific Axis3D, fails if axis is invalid

Parameters:

axis - The requested axis

Returns:

The component at the given axis

Throws:

java.lang.IllegalArgumentException - If axis is not X, Y or Z

toArray

public float[] toArray()

Converts this vector to an array of float values with X, Y, Z order.

Returns:

This vector as an array

Since:

1.0.0

iterator

@NotNull
public @NotNull java.util.Iterator<java.lang.Float> iterator()

Specified by:

iterator in interface java.lang.Iterable<java.lang.Float>

examinableProperties

@NotNull
public @NotNull java.util.stream.Stream<? extends net.kyori.examination.ExaminableProperty> examinableProperties()

Specified by:

examinableProperties in interface net.kyori.examination.Examinable

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object