org.joml

Class Vector3i

java.lang.Object

org.joml.Vector3i

All Implemented Interfaces:

Externalizable, Serializable, Vector3ic

public class Vector3i
extends Object
implements Externalizable, Vector3ic

Contains the definition of a Vector comprising 3 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	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
Vector3i() Create a new Vector3i of (0, 0, 0).
Vector3i(ByteBuffer buffer) Create a new Vector3i and read this vector from the supplied ByteBuffer at the current buffer position.
Vector3i(int d) Create a new Vector3i and initialize all three components with the given value.
Vector3i(IntBuffer buffer) Create a new Vector3i and read this vector from the supplied IntBuffer at the current buffer position.
Vector3i(int index, ByteBuffer buffer) Create a new Vector3i and read this vector from the supplied ByteBuffer starting at the specified absolute buffer position/index.
Vector3i(int index, IntBuffer buffer) Create a new Vector3i and read this vector from the supplied IntBuffer starting at the specified absolute buffer position/index.
Vector3i(int x, int y, int z) Create a new Vector3i with the given component values.
Vector3i(Vector2ic v, int z) Create a new Vector3i with the first two components from the given v and the given z
Vector3i(Vector3ic v) Create a new Vector3i with the same values as v.

Method Summary

Modifier and Type	Method and Description
Vector3i	add(int x, int y, int z) Increment the components of this vector by the given values.
Vector3i	add(int x, int y, int z, Vector3i dest) Increment the components of this vector by the given values and store the result in dest.
Vector3i	add(Vector3ic v) Add the supplied vector to this one.
Vector3i	add(Vector3ic v, Vector3i dest) Add the supplied vector to this one and store the result in dest.
double	distance(int x, int y, int z) Return the distance between this vector and (x, y, z).
double	distance(Vector3ic v) Return the distance between this Vector and v.
long	distanceSquared(int x, int y, int z) Return the square of the distance between this vector and (x, y, z).
long	distanceSquared(Vector3ic v) Return the square of the distance between 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.
Vector3i	mul(int scalar) Multiply all components of this Vector3i by the given scalar value.
Vector3i	mul(int x, int y, int z) Multiply the components of this vector by the given values.
Vector3i	mul(int x, int y, int z, Vector3i dest) Multiply the components of this vector by the given values and store the result in dest.
Vector3i	mul(int scalar, Vector3i dest) Multiply the components of this vector by the given scalar and store the result in dest.
Vector3i	mul(Vector3ic v) Add the supplied vector by this one.
Vector3i	mul(Vector3ic v, Vector3i dest) Multiply the supplied vector by this one and store the result in dest.
Vector3i	negate() Negate this vector.
Vector3i	negate(Vector3i dest) Negate this vector and store the result in dest.
void	readExternal(ObjectInput in)
Vector3i	set(ByteBuffer buffer) Read this vector from the supplied ByteBuffer at the current buffer position.
Vector3i	set(int d) Set the x, y, and z components to the supplied value.
Vector3i	set(IntBuffer buffer) Read this vector from the supplied IntBuffer at the current buffer position.
Vector3i	set(int index, ByteBuffer buffer) Read this vector from the supplied ByteBuffer starting at the specified absolute buffer position/index.
Vector3i	set(int index, IntBuffer buffer) Read this vector from the supplied IntBuffer starting at the specified absolute buffer position/index.
Vector3i	set(int x, int y, int z) Set the x, y and z components to the supplied values.
Vector3i	set(Vector2ic v, int z) Set the first two components from the given v and the z component from the given z
Vector3i	set(Vector3dc v) Set the x, y and z components to match the supplied vector.
Vector3i	set(Vector3ic v) Set the x, y and z components to match the supplied vector.
Vector3i	sub(int x, int y, int z) Decrement the components of this vector by the given values.
Vector3i	sub(int x, int y, int z, Vector3i dest) Decrement the components of this vector by the given values and store the result in dest.
Vector3i	sub(Vector3ic v) Subtract the supplied vector from this one and store the result in this.
Vector3i	sub(Vector3ic v, Vector3i dest) Subtract the supplied vector from this one and store the result in dest.
Vector3ic	toImmutable() Create a new immutable view of this Vector3i.
String	toString() Return a string representation of this vector.
String	toString(NumberFormat formatter) Return a string representation of this vector by formatting the vector components with the given NumberFormat.
void	writeExternal(ObjectOutput out)
int	x()
int	y()
int	z()
Vector3i	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.

Constructor Detail

Vector3i

public Vector3i()

Create a new Vector3i of (0, 0, 0).

Vector3i

public Vector3i(int d)

Create a new Vector3i and initialize all three components with the given value.

Parameters:

d - the value of all three components

Vector3i

public Vector3i(int x,
                int y,
                int z)

Create a new Vector3i with the given component values.

Parameters:

x - the value of x

y - the value of y

z - the value of z

Vector3i

public Vector3i(Vector3ic v)

Create a new Vector3i with the same values as v.

Parameters:

v - the Vector3ic to copy the values from

Vector3i

public Vector3i(Vector2ic v,
                int z)

Create a new Vector3i with the first two components from the given v and the given z

Parameters:

v - the Vector2ic to copy the values from

z - the z component

Vector3i

public Vector3i(ByteBuffer buffer)

Create a new Vector3i 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 Vector3i(int, ByteBuffer), taking the absolute position as parameter.

Parameters:

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

See Also:

Vector3i(int, ByteBuffer)

Vector3i

public Vector3i(int index,
                ByteBuffer buffer)

Create a new Vector3i 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 order

Vector3i

public Vector3i(IntBuffer buffer)

Create a new Vector3i 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 Vector3i(int, IntBuffer), taking the absolute position as parameter.

Parameters:

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

See Also:

Vector3i(int, IntBuffer)

Vector3i

public Vector3i(int index,
                IntBuffer buffer)

Create a new Vector3i 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 order

Method Detail

x

public int x()

Specified by:

x in interface Vector3ic

Returns:

the value of the x component

y

public int y()

Specified by:

y in interface Vector3ic

Returns:

the value of the y component

z

public int z()

Specified by:

z in interface Vector3ic

Returns:

the value of the z component

set

public Vector3i set(Vector3ic v)

Set the x, y and z components to match the supplied vector.

Parameters:

v - contains the values of x, y and z to set

Returns:

this

set

public Vector3i set(Vector3dc v)

Set the x, y and z components to match the supplied vector.

Note that due to the given vector v storing the components in double-precision, there is the possibility to lose precision.

Parameters:

v - contains the values of x, y and z to set

Returns:

this

set

public Vector3i set(Vector2ic v,
                    int z)

Set the first two components from the given v and the z component from the given z

Parameters:

v - the Vector2ic to copy the values from

z - the z component

Returns:

this

set

public Vector3i set(int d)

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

Parameters:

d - the value of all three components

Returns:

this

set

public Vector3i set(int x,
                    int y,
                    int z)

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

Parameters:

x - the x component

y - the y component

z - the z component

Returns:

this

set

public Vector3i 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 order

Returns:

this

See Also:

set(int, ByteBuffer)

set

public Vector3i 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 order

Returns:

this

set

public Vector3i 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 order

Returns:

this

See Also:

set(int, IntBuffer)

set

public Vector3i 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 order

Returns:

this

get

public IntBuffer get(IntBuffer buffer)

Description copied from interface: Vector3ic

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 Vector3ic.get(int, IntBuffer), taking the absolute position as parameter.

Specified by:

get in interface Vector3ic

Parameters:

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

Returns:

the passed in buffer

See Also:

Vector3ic.get(int, IntBuffer)

get

public IntBuffer get(int index,
                     IntBuffer buffer)

Description copied from interface: Vector3ic

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 Vector3ic

Parameters:

index - the absolute position into the IntBuffer

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

Returns:

the passed in buffer

get

public ByteBuffer get(ByteBuffer buffer)

Description copied from interface: Vector3ic

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 Vector3ic.get(int, ByteBuffer), taking the absolute position as parameter.

Specified by:

get in interface Vector3ic

Parameters:

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

Returns:

the passed in buffer

See Also:

Vector3ic.get(int, ByteBuffer)

get

public ByteBuffer get(int index,
                      ByteBuffer buffer)

Description copied from interface: Vector3ic

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 Vector3ic

Parameters:

index - the absolute position into the ByteBuffer

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

Returns:

the passed in buffer

sub

public Vector3i sub(Vector3ic v)

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

Parameters:

v - the vector to subtract

Returns:

this

sub

public Vector3i sub(Vector3ic v,
                    Vector3i dest)

Description copied from interface: Vector3ic

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

Specified by:

sub in interface Vector3ic

Parameters:

v - the vector to subtract

dest - will hold the result

Returns:

dest

sub

public Vector3i sub(int x,
                    int y,
                    int z)

Decrement the components of this vector by the given values.

Parameters:

x - the x component to subtract

y - the y component to subtract

z - the z component to subtract

Returns:

this

sub

public Vector3i sub(int x,
                    int y,
                    int z,
                    Vector3i dest)

Description copied from interface: Vector3ic

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

Specified by:

sub in interface Vector3ic

Parameters:

x - the x component to subtract

y - the y component to subtract

z - the z component to subtract

dest - will hold the result

Returns:

dest

add

public Vector3i add(Vector3ic v)

Add the supplied vector to this one.

Parameters:

v - the vector to add

Returns:

this

add

public Vector3i add(Vector3ic v,
                    Vector3i dest)

Description copied from interface: Vector3ic

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

Specified by:

add in interface Vector3ic

Parameters:

v - the vector to add

dest - will hold the result

Returns:

dest

add

public Vector3i add(int x,
                    int y,
                    int z)

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

Returns:

this

add

public Vector3i add(int x,
                    int y,
                    int z,
                    Vector3i dest)

Description copied from interface: Vector3ic

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

Specified by:

add in interface Vector3ic

Parameters:

x - the x component to add

y - the y component to add

z - the z component to add

dest - will hold the result

Returns:

dest

mul

public Vector3i mul(int scalar)

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

Parameters:

scalar - the scalar to multiply this vector by

Returns:

this

mul

public Vector3i mul(int scalar,
                    Vector3i dest)

Description copied from interface: Vector3ic

Multiply the components of this vector by the given scalar and store the result in dest.

Specified by:

mul in interface Vector3ic

Parameters:

scalar - the value to multiply this vector's components by

dest - will hold the result

Returns:

dest

mul

public Vector3i mul(Vector3ic v)

Add the supplied vector by this one.

Parameters:

v - the vector to multiply

Returns:

this

mul

public Vector3i mul(Vector3ic v,
                    Vector3i dest)

Description copied from interface: Vector3ic

Multiply the supplied vector by this one and store the result in dest.

Specified by:

mul in interface Vector3ic

Parameters:

v - the vector to multiply

dest - will hold the result

Returns:

dest

mul

public Vector3i mul(int x,
                    int y,
                    int z)

Multiply the components of this vector by the given values.

Parameters:

x - the x component to multiply

y - the y component to multiply

z - the z component to multiply

Returns:

this

mul

public Vector3i mul(int x,
                    int y,
                    int z,
                    Vector3i dest)

Description copied from interface: Vector3ic

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

Specified by:

mul in interface Vector3ic

Parameters:

x - the x component to multiply

y - the y component to multiply

z - the z component to multiply

dest - will hold the result

Returns:

dest

lengthSquared

public long lengthSquared()

Description copied from interface: Vector3ic

Return the length squared of this vector.

Specified by:

lengthSquared in interface Vector3ic

Returns:

the length squared

length

public double length()

Description copied from interface: Vector3ic

Return the length of this vector.

Specified by:

length in interface Vector3ic

Returns:

the length

distance

public double distance(Vector3ic v)

Description copied from interface: Vector3ic

Return the distance between this Vector and v.

Specified by:

distance in interface Vector3ic

Parameters:

v - the other vector

Returns:

the distance

distance

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

Description copied from interface: Vector3ic

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

Specified by:

distance in interface Vector3ic

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

Returns:

the euclidean distance

distanceSquared

public long distanceSquared(Vector3ic v)

Description copied from interface: Vector3ic

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

Specified by:

distanceSquared in interface Vector3ic

Parameters:

v - the other vector

Returns:

the squared of the distance

distanceSquared

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

Description copied from interface: Vector3ic

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

Specified by:

distanceSquared in interface Vector3ic

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

Returns:

the square of the distance

zero

public Vector3i zero()

Set all components to zero.

Returns:

this

toString

public String toString()

Return a string representation of this vector.

Overrides:

toString in class Object

Returns:

the string representation

toString

public String toString(NumberFormat formatter)

Return a string representation of this vector 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

negate

public Vector3i negate()

Negate this vector.

Returns:

this

negate

public Vector3i negate(Vector3i dest)

Description copied from interface: Vector3ic

Negate this vector and store the result in dest.

Specified by:

negate in interface Vector3ic

Parameters:

dest - will hold the result

Returns:

dest

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toImmutable

public Vector3ic toImmutable()

Create a new immutable view of this Vector3i.

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

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

Returns:

the immutable instance