org.joml

Class Vector4i

java.lang.Object

org.joml.Vector4i

All Implemented Interfaces:

Externalizable, Serializable, Vector4ic

public class Vector4i
extends Object
implements Externalizable, Vector4ic

Contains the definition of a Vector comprising 4 ints and associated transformations.

Author:

Richard Greenlees, Kai Burjack, Hans Uhlig

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
int	w The w component of the vector.
int	x The x component of the vector.
int	y The y component of the vector.
int	z The z component of the vector.

Constructor Summary

Constructors

Constructor and Description
Vector4i() Create a new Vector4i of (0, 0, 0, 1).
Vector4i(ByteBuffer buffer) Create a new Vector4i and read this vector from the supplied ByteBuffer at the current buffer position.
Vector4i(int s) Create a new Vector4i and initialize all four components with the given value.
Vector4i(IntBuffer buffer) Create a new Vector4i and read this vector from the supplied IntBuffer at the current buffer position.
Vector4i(int index, ByteBuffer buffer) Create a new Vector4i and read this vector from the supplied ByteBuffer starting at the specified absolute buffer position/index.
Vector4i(int index, IntBuffer buffer) Create a new Vector4i and read this vector from the supplied IntBuffer starting at the specified absolute buffer position/index.
Vector4i(int x, int y, int z, int w) Create a new Vector4i with the given component values.
Vector4i(Vector2ic v, int z, int w) Create a new Vector4i with the first two components from the given v and the given z, and w.
Vector4i(Vector3ic v, int w) Create a new Vector4i with the first three components from the given v and the given w.
Vector4i(Vector4ic v) Create a new Vector4i with the same values as v.

Method Summary

Modifier and Type	Method and Description
Vector4i	add(int x, int y, int z, int w) Increment the components of this vector by the given values.
Vector4i	add(int x, int y, int z, int w, Vector4i dest) Increment the components of this vector by the given values and store the result in dest.
Vector4i	add(Vector4ic v) Add the supplied vector to this one.
Vector4i	add(Vector4ic v, Vector4i dest) Add the supplied vector to this one and store the result in dest.
double	distance(int x, int y, int z, int w) Return the distance between this vector and (x, y, z, w).
double	distance(Vector4ic v) Return the distance between this Vector and v.
int	distanceSquared(int x, int y, int z, int w) Return the square of the distance between this vector and (x, y, z, w).
int	distanceSquared(Vector4ic v) Return the square of the distance between this vector and v.
Vector4i	div(float scalar, Vector4i dest) Divide all components of this Vector4i by the given scalar value and store the result in dest.
Vector4i	div(int scalar) Divide all components of this Vector4i by the given scalar value.
Vector4i	div(Vector4ic v) Divide this Vector4i component-wise by another Vector4i.
Vector4i	div(Vector4ic v, Vector4i dest) Divide this Vector4i component-wise by another Vector4ic and store the result in dest.
int	dot(Vector4ic v) Compute the dot product (inner product) of this vector and v.
boolean	equals(Object obj)
ByteBuffer	get(ByteBuffer buffer) Store this vector into the supplied ByteBuffer at the current buffer position.
IntBuffer	get(IntBuffer buffer) Store this vector into the supplied IntBuffer at the current buffer position.
ByteBuffer	get(int index, ByteBuffer buffer) Store this vector into the supplied ByteBuffer starting at the specified absolute buffer position/index.
IntBuffer	get(int index, IntBuffer buffer) Store this vector into the supplied IntBuffer starting at the specified absolute buffer position/index.
int	hashCode()
double	length() Return the length of this vector.
long	lengthSquared() Return the length squared of this vector.
Vector4i	max(Vector4ic v) Set the components of this vector to be the component-wise maximum of this and the other vector.
Vector4i	min(Vector4ic v) Set the components of this vector to be the component-wise minimum of this and the other vector.
Vector4i	mul(float scalar) Multiply all components of this Vector4i by the given scalar value.
Vector4i	mul(float scalar, Vector4i dest) Multiply all components of this Vector4i by the given scalar value and store the result in dest.
Vector4i	mul(Vector4ic v) Multiply this Vector4i component-wise by another Vector4i.
Vector4i	mul(Vector4ic v, Vector4i dest) Multiply this Vector4i component-wise by another Vector4ic and store the result in dest.
Vector4i	negate() Negate this vector.
Vector4i	negate(Vector4i dest) Negate this vector and store the result in dest.
void	readExternal(ObjectInput in)
Vector4i	set(ByteBuffer buffer) Read this vector from the supplied ByteBuffer at the current buffer position.
Vector4i	set(int s) Set the x, y, z, and w components to the supplied value.
Vector4i	set(IntBuffer buffer) Read this vector from the supplied IntBuffer at the current buffer position.
Vector4i	set(int index, ByteBuffer buffer) Read this vector from the supplied ByteBuffer starting at the specified absolute buffer position/index.
Vector4i	set(int index, IntBuffer buffer) Read this vector from the supplied IntBuffer starting at the specified absolute buffer position/index.
Vector4i	set(int x, int y, int z, int w) Set the x, y, z, and w components to the supplied values.
Vector4i	set(Vector2ic v, int z, int w) Sets the first two components of this to the components of given v and last two components to the given z, and w.
Vector4i	set(Vector3ic v, int w) Set the first three components of this to the components of v and the last component to w.
Vector4i	set(Vector4ic v) Set this Vector4i to the values of the given v.
Vector4i	setComponent(int component, int value) Set the value of the specified component of this vector.
Vector4i	sub(int x, int y, int z, int w) Subtract (x, y, z, w) from this.
Vector4i	sub(int x, int y, int z, int w, Vector4i dest) Subtract (x, y, z, w) from this and store the result in dest.
Vector4i	sub(Vector4ic v) Subtract the supplied vector from this one.
Vector4i	sub(Vector4ic v, Vector4i dest) Subtract the supplied vector from this one and store the result in dest.
Vector4ic	toImmutable() Create a new immutable view of this Vector4i.
String	toString() Return a string representation of this vector.
String	toString(NumberFormat formatter) Return a string representation of this quaternion by formatting the vector components with the given NumberFormat.
int	w()
void	writeExternal(ObjectOutput out)
int	x()
int	y()
int	z()
Vector4i	zero() Set all components to zero.

Methods inherited from class java.lang.Object

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

Field Detail

x

public int x

The x component of the vector.

y

public int y

The y component of the vector.

z

public int z

The z component of the vector.

w

public int w

The w component of the vector.

Constructor Detail

Vector4i

public Vector4i()

Create a new Vector4i of (0, 0, 0, 1).

Vector4i

public Vector4i(Vector4ic v)

Create a new Vector4i with the same values as v.

Parameters:

v - the Vector4ic to copy the values from

Vector4i

public Vector4i(Vector3ic v,
                int w)

Create a new Vector4i with the first three components from the given v and the given w.

Parameters:

v - the Vector3ic

w - the w component

Vector4i

public Vector4i(Vector2ic v,
                int z,
                int w)

Create a new Vector4i with the first two components from the given v and the given z, and w.

Parameters:

v - the Vector2ic

z - the z component

w - the w component

Vector4i

public Vector4i(int s)

Create a new Vector4i and initialize all four components with the given value.

Parameters:

s - scalar value of all four components

Vector4i

public Vector4i(int x,
                int y,
                int z,
                int w)

Create a new Vector4i with the given component values.

Parameters:

x - the x component

y - the y component

z - the z component

w - the w component

Vector4i

public Vector4i(ByteBuffer buffer)

Create a new Vector4i and read this vector from the supplied ByteBuffer at the current buffer position.

This method will not increment the position of the given ByteBuffer.

In order to specify the offset into the ByteBuffer at which the vector is read, use Vector4i(int, ByteBuffer), taking the absolute position as parameter.

Parameters:

buffer - values will be read in x, y, z, w order

See Also:

Vector4i(int, ByteBuffer)

Vector4i

public Vector4i(int index,
                ByteBuffer buffer)

Create a new Vector4i and read this vector from the supplied ByteBuffer starting at the specified absolute buffer position/index.

This method will not increment the position of the given ByteBuffer.

Parameters:

index - the absolute position into the ByteBuffer

buffer - values will be read in x, y, z, w order

Vector4i

public Vector4i(IntBuffer buffer)

Create a new Vector4i and read this vector from the supplied IntBuffer at the current buffer position.

This method will not increment the position of the given IntBuffer.

In order to specify the offset into the IntBuffer at which the vector is read, use Vector4i(int, IntBuffer), taking the absolute position as parameter.

Parameters:

buffer - values will be read in x, y, z, w order

See Also:

Vector4i(int, IntBuffer)

Vector4i

public Vector4i(int index,
                IntBuffer buffer)

Create a new Vector4i and read this vector from the supplied IntBuffer starting at the specified absolute buffer position/index.

This method will not increment the position of the given IntBuffer.

Parameters:

index - the absolute position into the IntBuffer

buffer - values will be read in x, y, z, w order

Method Detail

x

public int x()

Specified by:

x in interface Vector4ic

Returns:

the value of the x component

y

public int y()

Specified by:

y in interface Vector4ic

Returns:

the value of the y component

z

public int z()

Specified by:

z in interface Vector4ic

Returns:

the value of the z component

w

public int w()

Specified by:

w in interface Vector4ic

Returns:

the value of the w component

set

public Vector4i set(Vector4ic v)

Set this Vector4i to the values of the given v.

Parameters:

v - the vector whose values will be copied into this

Returns:

this

set

public Vector4i set(Vector3ic v,
                    int w)

Set the first three components of this to the components of v and the last component to w.

Parameters:

v - the Vector3ic to copy

w - the w component

Returns:

this

set

public Vector4i set(Vector2ic v,
                    int z,
                    int w)

Sets the first two components of this to the components of given v and last two components to the given z, and w.

Parameters:

v - the Vector2ic

z - the z component

w - the w component

Returns:

this

set

public Vector4i set(int s)

Set the x, y, z, and w components to the supplied value.

Parameters:

s - the value of all four components

Returns:

this

set

public Vector4i set(int x,
                    int y,
                    int z,
                    int w)

Set the x, y, z, and w components to the supplied values.

Parameters:

x - the x component

y - the y component

z - the z component

w - the w component

Returns:

this

set

public Vector4i set(ByteBuffer buffer)

Read this vector from the supplied ByteBuffer at the current buffer position.

This method will not increment the position of the given ByteBuffer.

In order to specify the offset into the ByteBuffer at which the vector is read, use set(int, ByteBuffer), taking the absolute position as parameter.

Parameters:

buffer - values will be read in x, y, z, w order

Returns:

this

See Also:

set(int, ByteBuffer)

set

public Vector4i set(int index,
                    ByteBuffer buffer)

Read this vector from the supplied ByteBuffer starting at the specified absolute buffer position/index.

This method will not increment the position of the given ByteBuffer.

Parameters:

index - the absolute position into the ByteBuffer

buffer - values will be read in x, y, z, w order

Returns:

this

set

public Vector4i set(IntBuffer buffer)

Read this vector from the supplied IntBuffer at the current buffer position.

This method will not increment the position of the given IntBuffer.

In order to specify the offset into the IntBuffer at which the vector is read, use set(int, IntBuffer), taking the absolute position as parameter.

Parameters:

buffer - values will be read in x, y, z, w order

Returns:

this

See Also:

set(int, IntBuffer)

set

public Vector4i set(int index,
                    IntBuffer buffer)

Read this vector from the supplied IntBuffer starting at the specified absolute buffer position/index.

This method will not increment the position of the given IntBuffer.

Parameters:

index - the absolute position into the IntBuffer

buffer - values will be read in x, y, z, w order

Returns:

this

setComponent

public Vector4i setComponent(int component,
                             int value)
                      throws IllegalArgumentException

Set the value of the specified component of this vector.

Parameters:

component - the component whose value to set, within [0..3]

value - the value to set

Returns:

this

Throws:

IllegalArgumentException - if component is not within [0..3]

get

public IntBuffer get(IntBuffer buffer)

Description copied from interface: Vector4ic

Store this vector into the supplied IntBuffer at the current buffer position.

This method will not increment the position of the given IntBuffer.

In order to specify the offset into the IntBuffer at which the vector is stored, use Vector4ic.get(int, IntBuffer), taking the absolute position as parameter.

Specified by:

get in interface Vector4ic

Parameters:

buffer - will receive the values of this vector in x, y, z, w order

Returns:

the passed in buffer

See Also:

Vector4ic.get(int, IntBuffer)

get

public IntBuffer get(int index,
                     IntBuffer buffer)

Description copied from interface: Vector4ic

Store this vector into the supplied IntBuffer starting at the specified absolute buffer position/index.

This method will not increment the position of the given IntBuffer.

Specified by:

get in interface Vector4ic

Parameters:

index - the absolute position into the IntBuffer

buffer - will receive the values of this vector in x, y, z, w order

Returns:

the passed in buffer

get

public ByteBuffer get(ByteBuffer buffer)

Description copied from interface: Vector4ic

Store this vector into the supplied ByteBuffer at the current buffer position.

This method will not increment the position of the given ByteBuffer.

In order to specify the offset into the ByteBuffer at which the vector is stored, use Vector4ic.get(int, ByteBuffer), taking the absolute position as parameter.

Specified by:

get in interface Vector4ic

Parameters:

buffer - will receive the values of this vector in x, y, z, w order

Returns:

the passed in buffer

See Also:

Vector4ic.get(int, ByteBuffer)

get

public ByteBuffer get(int index,
                      ByteBuffer buffer)

Description copied from interface: Vector4ic

Store this vector into the supplied ByteBuffer starting at the specified absolute buffer position/index.

This method will not increment the position of the given ByteBuffer.

Specified by:

get in interface Vector4ic

Parameters:

index - the absolute position into the ByteBuffer

buffer - will receive the values of this vector in x, y, z, w order

Returns:

the passed in buffer

sub

public Vector4i sub(Vector4ic v)

Subtract the supplied vector from this one.

Parameters:

v - the vector to subtract

Returns:

this

sub

public Vector4i sub(int x,
                    int y,
                    int z,
                    int w)

Subtract (x, y, z, w) from this.

Parameters:

x - the x component to subtract

y - the y component to subtract

z - the z component to subtract

w - the w component to subtract

Returns:

this

sub

public Vector4i sub(Vector4ic v,
                    Vector4i dest)

Description copied from interface: Vector4ic

Subtract the supplied vector from this one and store the result in dest.

Specified by:

sub in interface Vector4ic

Parameters:

v - the vector to subtract from this

dest - will hold the result

Returns:

dest

sub

public Vector4i sub(int x,
                    int y,
                    int z,
                    int w,
                    Vector4i dest)

Description copied from interface: Vector4ic

Subtract (x, y, z, w) from this and store the result in dest.

Specified by:

sub in interface Vector4ic

Parameters:

x - the x component to subtract

y - the y component to subtract

z - the z component to subtract

w - the w component to subtract

dest - will hold the result

Returns:

dest

add

public Vector4i add(Vector4ic v)

Add the supplied vector to this one.

Parameters:

v - the vector to add

Returns:

this

add

public Vector4i add(Vector4ic v,
                    Vector4i dest)

Description copied from interface: Vector4ic

Add the supplied vector to this one and store the result in dest.

Specified by:

add in interface Vector4ic

Parameters:

v - the vector to add

dest - will hold the result

Returns:

dest

add

public Vector4i add(int x,
                    int y,
                    int z,
                    int w)

Increment the components of this vector by the given values.

Parameters:

x - the x component to add

y - the y component to add

z - the z component to add

w - the w component to add

Returns:

this

add

public Vector4i add(int x,
                    int y,
                    int z,
                    int w,
                    Vector4i dest)

Description copied from interface: Vector4ic

Increment the components of this vector by the given values and store the result in dest.

Specified by:

add in interface Vector4ic

Parameters:

x - the x component to add

y - the y component to add

z - the z component to add

w - the w component to add

dest - will hold the result

Returns:

dest

mul

public Vector4i mul(Vector4ic v)

Multiply this Vector4i component-wise by another Vector4i.

Parameters:

v - the other vector

Returns:

this

mul

public Vector4i mul(Vector4ic v,
                    Vector4i dest)

Description copied from interface: Vector4ic

Multiply this Vector4i component-wise by another Vector4ic and store the result in dest.

Specified by:

mul in interface Vector4ic

Parameters:

v - the other vector

dest - will hold the result

Returns:

dest

div

public Vector4i div(Vector4ic v)

Divide this Vector4i component-wise by another Vector4i.

Parameters:

v - the vector to divide by

Returns:

this

div

public Vector4i div(Vector4ic v,
                    Vector4i dest)

Description copied from interface: Vector4ic

Divide this Vector4i component-wise by another Vector4ic and store the result in dest.

Specified by:

div in interface Vector4ic

Parameters:

v - the vector to divide by

dest - will hold the result

Returns:

dest

mul

public Vector4i mul(float scalar)

Multiply all components of this Vector4i by the given scalar value.

Parameters:

scalar - the scalar to multiply by

Returns:

this

mul

public Vector4i mul(float scalar,
                    Vector4i dest)

Description copied from interface: Vector4ic

Multiply all components of this Vector4i by the given scalar value and store the result in dest.

Specified by:

mul in interface Vector4ic

Parameters:

scalar - the scalar to multiply by

dest - will hold the result

Returns:

dest

div

public Vector4i div(int scalar)

Divide all components of this Vector4i by the given scalar value.

Parameters:

scalar - the scalar to divide by

Returns:

this

div

public Vector4i div(float scalar,
                    Vector4i dest)

Description copied from interface: Vector4ic

Divide all components of this Vector4i by the given scalar value and store the result in dest.

Specified by:

div in interface Vector4ic

Parameters:

scalar - the scalar to divide by

dest - will hold the result

Returns:

dest

lengthSquared

public long lengthSquared()

Description copied from interface: Vector4ic

Return the length squared of this vector.

Specified by:

lengthSquared in interface Vector4ic

Returns:

the length squared

length

public double length()

Description copied from interface: Vector4ic

Return the length of this vector.

Specified by:

length in interface Vector4ic

Returns:

the length

distance

public double distance(Vector4ic v)

Description copied from interface: Vector4ic

Return the distance between this Vector and v.

Specified by:

distance in interface Vector4ic

Parameters:

v - the other vector

Returns:

the distance

distance

public double distance(int x,
                       int y,
                       int z,
                       int w)

Description copied from interface: Vector4ic

Return the distance between this vector and (x, y, z, w).

Specified by:

distance in interface Vector4ic

Parameters:

x - the x component of the other vector

y - the y component of the other vector

z - the z component of the other vector

w - the w component of the other vector

Returns:

the euclidean distance

distanceSquared

public int distanceSquared(Vector4ic v)

Description copied from interface: Vector4ic

Return the square of the distance between this vector and v.

Specified by:

distanceSquared in interface Vector4ic

Parameters:

v - the other vector

Returns:

the squared of the distance

distanceSquared

public int distanceSquared(int x,
                           int y,
                           int z,
                           int w)

Description copied from interface: Vector4ic

Return the square of the distance between this vector and (x, y, z, w).

Specified by:

distanceSquared in interface Vector4ic

Parameters:

x - the x component of the other vector

y - the y component of the other vector

z - the z component of the other vector

w - the w component of the other vector

Returns:

the square of the distance

dot

public int dot(Vector4ic v)

Description copied from interface: Vector4ic

Compute the dot product (inner product) of this vector and v.

Specified by:

dot in interface Vector4ic

Parameters:

v - the other vector

Returns:

the dot product

zero

public Vector4i zero()

Set all components to zero.

Returns:

this

negate

public Vector4i negate()

Negate this vector.

Returns:

this

negate

public Vector4i negate(Vector4i dest)

Description copied from interface: Vector4ic

Negate this vector and store the result in dest.

Specified by:

negate in interface Vector4ic

Parameters:

dest - will hold the result

Returns:

dest

toString

public String toString()

Return a string representation of this vector.

This method creates a new DecimalFormat on every invocation with the format string "0.000E0;-".

Overrides:

toString in class Object

Returns:

the string representation

toString

public String toString(NumberFormat formatter)

Return a string representation of this quaternion by formatting the vector components with the given NumberFormat.

Parameters:

formatter - the NumberFormat used to format the vector components with

Returns:

the string representation

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException

min

public Vector4i min(Vector4ic v)

Set the components of this vector to be the component-wise minimum of this and the other vector.

Parameters:

v - the other vector

Returns:

this

max

public Vector4i max(Vector4ic v)

Set the components of this vector to be the component-wise maximum of this and the other vector.

Parameters:

v - the other vector

Returns:

this

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toImmutable

public Vector4ic toImmutable()

Create a new immutable view of this Vector4i.

The observable state of the returned object is the same as that of this, but casting the returned object to Vector4i will not be possible.

This method allocates a new instance of a class implementing Vector4ic on every call.

Returns:

the immutable instance