Record Class Vec3

java.lang.Object

java.lang.Record

dev.engine.core.math.Vec3

public record Vec3(float x, float y, float z)
extends Record

Field Summary

Fields

Modifier and Type	Field	Description
static final Vec3	ONE
static final Vec3	UNIT_X
static final Vec3	UNIT_Y
static final Vec3	UNIT_Z
static final Vec3	ZERO

Constructor Summary

Constructors

Constructor	Description
Vec3(float x, float y, float z)	Creates an instance of a Vec3 record class.

Method Summary

Modifier and Type	Method	Description
Vec3	abs()
Vec3	add(Vec3 o)
Vec3	clamp(float min, float max)
Vec3	clamp(Vec3 min, Vec3 max)
Vec3	cross(Vec3 o)
float	distance(Vec3 o)
float	distanceSquared(Vec3 o)
float	dot(Vec3 o)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
float	length()
float	lengthSquared()
Vec3	lerp(Vec3 o, float t)
Vec3	max(Vec3 o)
Vec3	min(Vec3 o)
Vec3	mul(Vec3 o)
Vec3	negate()
Vec3	normalize()
Vec3	reflect(Vec3 normal)
Vec3	scale(float s)
Vec3	sub(Vec3 o)
final String	toString()	Returns a string representation of this record class.
float	x()	Returns the value of the x record component.
float	y()	Returns the value of the y record component.
float	z()	Returns the value of the z record component.

Methods inherited from class Object

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

Field Details

ZERO

public static final Vec3 ZERO

ONE

public static final Vec3 ONE

UNIT_X

public static final Vec3 UNIT_X

UNIT_Y

public static final Vec3 UNIT_Y

UNIT_Z

public static final Vec3 UNIT_Z

Constructor Details

Vec3

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

Creates an instance of a Vec3 record class.

Parameters:

x - the value for the x record component

y - the value for the y record component

z - the value for the z record component

Method Details

add

public Vec3 add(Vec3 o)

sub

public Vec3 sub(Vec3 o)

mul

public Vec3 mul(Vec3 o)

scale

public Vec3 scale(float s)

negate

public Vec3 negate()

dot

public float dot(Vec3 o)

cross

public Vec3 cross(Vec3 o)

lengthSquared

public float lengthSquared()

length

public float length()

normalize

public Vec3 normalize()

lerp

public Vec3 lerp(Vec3 o,
 float t)

distance

public float distance(Vec3 o)

distanceSquared

public float distanceSquared(Vec3 o)

reflect

public Vec3 reflect(Vec3 normal)

abs

public Vec3 abs()

min

public Vec3 min(Vec3 o)

max

public Vec3 max(Vec3 o)

clamp

public Vec3 clamp(Vec3 min,
 Vec3 max)

clamp

public Vec3 clamp(float min,
 float max)

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with the compare method from their corresponding wrapper classes.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

x

public float x()

Returns the value of the x record component.

Returns:

the value of the x record component

y

public float y()

Returns the value of the y record component.

Returns:

the value of the y record component

z

public float z()

Returns the value of the z record component.

Returns:

the value of the z record component