Package limn.math

Record Class Vec3

java.lang.Object

java.lang.Record

limn.math.Vec3

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

An immutable 3-component vector (single precision), right-handed. Used for positions, directions, normals and colors in the 3D subsystem. Operations return new instances, cheap enough for UI-scale 3D (a handful of transforms per frame, not a hot game loop); the allocation-free forms live in MutVec3 and the *Into methods elsewhere in this package.

The arithmetic is component-wise; the operations with an edge case worth knowing are div(float), normalize(), lerp(limn.math.Vec3, float) and get(int).

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	add(Vec3 o)
Vec3	cross(Vec3 o)
float	distance(Vec3 o)
Vec3	div(float s)	Component-wise division.
float	dot(Vec3 o)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
float	get(int i)	Component by index, 0 = x, 1 = y, 2 = z.
final int	hashCode()	Returns a hash code value for this object.
float	length()
float	lengthSquared()
Vec3	lerp(Vec3 o, float t)	Linear interpolation towards o.
Vec3	max(Vec3 o)
Vec3	min(Vec3 o)
Vec3	mul(float s)
Vec3	mul(Vec3 o)	Component-wise multiply (e.g.
Vec3	negate()
Vec3	normalize()	Unit vector in the same direction; returns ZERO for a zero-length input.
static Vec3	of(float s)	The same value in all three components.
Vec3	sub(Vec3 o)
final String	toString()	Returns a string representation of this record class.
Vec4	toVec4(float w)	This vector with an explicit w: 1 for a position, 0 for a direction.
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 java.lang.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

of

public static Vec3 of(float s)

The same value in all three components.

add

public Vec3 add(Vec3 o)

Returns:

the sum of this vector and o

sub

public Vec3 sub(Vec3 o)

Returns:

this vector minus o

mul

public Vec3 mul(float s)

Returns:

this vector scaled by s

mul

public Vec3 mul(Vec3 o)

Component-wise multiply (e.g. modulating a color).

div

public Vec3 div(float s)

Component-wise division. Not guarded: s == 0 yields infinities or NaN rather than throwing, so divide by a length only after checking it.

negate

public Vec3 negate()

Returns:

this vector pointing the other way

dot

public float dot(Vec3 o)

Returns:

the dot product of this vector and o

cross

public Vec3 cross(Vec3 o)

Returns:

the cross product, right-handed: UNIT_X.cross(UNIT_Y) is UNIT_Z

lengthSquared

public float lengthSquared()

Returns:

the squared length, which needs no square root

length

public float length()

Returns:

the Euclidean length

distance

public float distance(Vec3 o)

Returns:

the distance between this point and o

normalize

public Vec3 normalize()

Unit vector in the same direction; returns ZERO for a zero-length input.

lerp

public Vec3 lerp(Vec3 o,
 float t)

Linear interpolation towards o. t is not clamped: values outside [0,1] extrapolate, which is what makes this usable for easing curves that overshoot.

min

public Vec3 min(Vec3 o)

Returns:

the smaller of each pair of components

max

public Vec3 max(Vec3 o)

Returns:

the larger of each pair of components

get

public float get(int i)

Component by index, 0 = x, 1 = y, 2 = z.

Throws:

IndexOutOfBoundsException - for any other index

toVec4

public Vec4 toVec4(float w)

This vector with an explicit w: 1 for a position, 0 for a direction.

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 '=='.

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