team.unnamed.creative.base

Class Vector2Float

java.lang.Object

team.unnamed.creative.base.Vector2Float

All Implemented Interfaces:

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

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

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

Since:

1.0.0

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
@NotNull Vector2Float	add(@NotNull Vector2Float value) Returns a new vector result of adding the given value to this vector.
@NotNull Vector2Float	divide(float value) Returns a new vector result of dividing this vector by the given scalar value.
@NotNull Vector2Float	divide(@NotNull Vector2Float value) Returns a new vector result of dividing this vector by the given value vector.
boolean	equals(java.lang.Object o)
@NotNull java.util.stream.Stream<? extends net.kyori.examination.ExaminableProperty>	examinableProperties()
int	hashCode()
@NotNull java.util.Iterator<java.lang.Float>	iterator()
@NotNull Vector2Float	multiply(float value) Returns a new vector result of multiplying this vector by the given scalar value.
@NotNull Vector2Float	multiply(@NotNull Vector2Float value) Returns a new vector result of multiplying the given value vector by this vector.
@NotNull Vector2Float	subtract(@NotNull Vector2Float value) Returns a new vector result of subtracting the given value to this vector.
float[]	toArray() Converts this vector object to a float array with the X component at index 0 and the Y component at index 1.
java.lang.String	toString()
float	x() Returns the "X" component or abscissa of this vector.
float	y() Returns the "Y" component or ordinate of 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 Vector2Float ZERO

Constant for Vector2Float value with abscissa and ordinate of 0 zero.

Since:

1.0.0

ONE

public static final Vector2Float ONE

Constant for Vector2Float value with abscissa and ordinate of 1 one.

Since:

1.1.0

Constructor Detail

Vector2Float

public Vector2Float(float x,
                    float y)

Constructs a new Vector2Float with the given x and y values.

Parameters:

x - The vector abscissa

y - The vector ordinate

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

y

public float y()

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

Returns:

The vector ordinate

Since:

1.0.0

add

@Contract(value="_ -> new",
          pure=true)
 @NotNull
public @NotNull Vector2Float add(@NotNull
                                                                                               @NotNull Vector2Float 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 Vector2Float subtract(@NotNull
                                                                                                    @NotNull Vector2Float value)

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

Parameters:

value - The value to subtract

Returns:

The result vector

Since:

1.0.0

multiply

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

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

The resulting X component is calculated by multiplying the X components of both vectors.

The resulting Y component is calculated by multiplying the Y components of both vectors.

Parameters:

value - The value to multiply

Returns:

The result vector

Since:

1.0.0

multiply

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

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

Parameters:

value - The factor

Returns:

The result vector

Since:

1.1.0

divide

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

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

The resulting X component is calculated by dividing the X components of both vectors.

The resulting Y component is calculated by dividing the Y components of both vectors.

Parameters:

value - The value to divide

Returns:

The result vector

Since:

1.0.0

divide

@Contract(value="_ -> new",
          pure=true)
 @NotNull
public @NotNull Vector2Float 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.1.0

toArray

@Contract(value="-> new",
          pure=true)
public float[] toArray()

Converts this vector object to a float array with the X component at index 0 and the Y component at index 1.

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