mirror of
https://github.com/Jozufozu/Flywheel.git
synced 2024-12-27 07:26:48 +01:00
a42c027b6f
- Fix Resources not being closed properly - Change versioning scheme to match Create - Add LICENSE to built jar - Fix mods.toml version sync - Move JOML code to non-src directory - Update Gradle - Organize imports
432 lines
12 KiB
Java
432 lines
12 KiB
Java
/*
|
|
* The MIT License
|
|
*
|
|
* Copyright (c) 2016-2021 JOML
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
* of this software and associated documentation files (the "Software"), to deal
|
|
* in the Software without restriction, including without limitation the rights
|
|
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
* copies of the Software, and to permit persons to whom the Software is
|
|
* furnished to do so, subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included in
|
|
* all copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
* THE SOFTWARE.
|
|
*/
|
|
package com.jozufozu.flywheel.repack.joml;
|
|
|
|
import java.nio.ByteBuffer;
|
|
import java.nio.IntBuffer;
|
|
|
|
/**
|
|
* Interface to a read-only view of a 4-dimensional vector of integers.
|
|
*
|
|
* @author Kai Burjack
|
|
*/
|
|
public interface Vector4ic {
|
|
|
|
/**
|
|
* @return the value of the x component
|
|
*/
|
|
int x();
|
|
|
|
/**
|
|
* @return the value of the y component
|
|
*/
|
|
int y();
|
|
|
|
/**
|
|
* @return the value of the z component
|
|
*/
|
|
int z();
|
|
|
|
/**
|
|
* @return the value of the w component
|
|
*/
|
|
int w();
|
|
|
|
/**
|
|
* Store this vector into the supplied {@link IntBuffer} at the current
|
|
* buffer {@link IntBuffer#position() position}.
|
|
* <p>
|
|
* This method will not increment the position of the given IntBuffer.
|
|
* <p>
|
|
* In order to specify the offset into the IntBuffer at which the vector is
|
|
* stored, use {@link #get(int, IntBuffer)}, taking the absolute position as
|
|
* parameter.
|
|
*
|
|
* @see #get(int, IntBuffer)
|
|
*
|
|
* @param buffer
|
|
* will receive the values of this vector in <code>x, y, z, w</code> order
|
|
* @return the passed in buffer
|
|
*/
|
|
IntBuffer get(IntBuffer buffer);
|
|
|
|
/**
|
|
* Store this vector into the supplied {@link IntBuffer} starting at the
|
|
* specified absolute buffer position/index.
|
|
* <p>
|
|
* This method will not increment the position of the given IntBuffer.
|
|
*
|
|
* @param index
|
|
* the absolute position into the IntBuffer
|
|
* @param buffer
|
|
* will receive the values of this vector in <code>x, y, z, w</code> order
|
|
* @return the passed in buffer
|
|
*/
|
|
IntBuffer get(int index, IntBuffer buffer);
|
|
|
|
/**
|
|
* Store this vector into the supplied {@link ByteBuffer} at the current
|
|
* buffer {@link ByteBuffer#position() position}.
|
|
* <p>
|
|
* This method will not increment the position of the given ByteBuffer.
|
|
* <p>
|
|
* In order to specify the offset into the ByteBuffer at which the vector is
|
|
* stored, use {@link #get(int, ByteBuffer)}, taking the absolute position
|
|
* as parameter.
|
|
*
|
|
* @see #get(int, ByteBuffer)
|
|
*
|
|
* @param buffer
|
|
* will receive the values of this vector in <code>x, y, z, w</code> order
|
|
* @return the passed in buffer
|
|
*/
|
|
ByteBuffer get(ByteBuffer buffer);
|
|
|
|
/**
|
|
* Store this vector into the supplied {@link ByteBuffer} starting at the
|
|
* specified absolute buffer position/index.
|
|
* <p>
|
|
* This method will not increment the position of the given ByteBuffer.
|
|
*
|
|
* @param index
|
|
* the absolute position into the ByteBuffer
|
|
* @param buffer
|
|
* will receive the values of this vector in <code>x, y, z, w</code> order
|
|
* @return the passed in buffer
|
|
*/
|
|
ByteBuffer get(int index, ByteBuffer buffer);
|
|
|
|
/**
|
|
* Store this vector at the given off-heap memory address.
|
|
* <p>
|
|
* This method will throw an {@link UnsupportedOperationException} when JOML is used with `-Djoml.nounsafe`.
|
|
* <p>
|
|
* <em>This method is unsafe as it can result in a crash of the JVM process when the specified address range does not belong to this process.</em>
|
|
*
|
|
* @param address
|
|
* the off-heap address where to store this vector
|
|
* @return this
|
|
*/
|
|
Vector4ic getToAddress(long address);
|
|
|
|
/**
|
|
* Subtract the supplied vector from this one and store the result in
|
|
* <code>dest</code>.
|
|
*
|
|
* @param v
|
|
* the vector to subtract from <code>this</code>
|
|
* @param dest
|
|
* will hold the result
|
|
* @return dest
|
|
*/
|
|
Vector4i sub(Vector4ic v, Vector4i dest);
|
|
|
|
/**
|
|
* Subtract <code>(x, y, z, w)</code> from this and store the result in
|
|
* <code>dest</code>.
|
|
*
|
|
* @param x
|
|
* the x component to subtract
|
|
* @param y
|
|
* the y component to subtract
|
|
* @param z
|
|
* the z component to subtract
|
|
* @param w
|
|
* the w component to subtract
|
|
* @param dest
|
|
* will hold the result
|
|
* @return dest
|
|
*/
|
|
Vector4i sub(int x, int y, int z, int w, Vector4i dest);
|
|
|
|
/**
|
|
* Add the supplied vector to this one and store the result in
|
|
* <code>dest</code>.
|
|
*
|
|
* @param v
|
|
* the vector to add
|
|
* @param dest
|
|
* will hold the result
|
|
* @return dest
|
|
*/
|
|
Vector4i add(Vector4ic v, Vector4i dest);
|
|
|
|
/**
|
|
* Increment the components of this vector by the given values and store the
|
|
* result in <code>dest</code>.
|
|
*
|
|
* @param x
|
|
* the x component to add
|
|
* @param y
|
|
* the y component to add
|
|
* @param z
|
|
* the z component to add
|
|
* @param w
|
|
* the w component to add
|
|
* @param dest
|
|
* will hold the result
|
|
* @return dest
|
|
*/
|
|
Vector4i add(int x, int y, int z, int w, Vector4i dest);
|
|
|
|
/**
|
|
* Multiply this Vector4i component-wise by another Vector4ic and store the
|
|
* result in <code>dest</code>.
|
|
*
|
|
* @param v
|
|
* the other vector
|
|
* @param dest
|
|
* will hold the result
|
|
* @return dest
|
|
*/
|
|
Vector4i mul(Vector4ic v, Vector4i dest);
|
|
|
|
/**
|
|
* Divide this Vector4i component-wise by another Vector4ic and store the
|
|
* result in <code>dest</code>.
|
|
*
|
|
* @param v
|
|
* the vector to divide by
|
|
* @param dest
|
|
* will hold the result
|
|
* @return dest
|
|
*/
|
|
Vector4i div(Vector4ic v, Vector4i dest);
|
|
|
|
/**
|
|
* Multiply all components of this {@link Vector4i} by the given scalar
|
|
* value and store the result in <code>dest</code>.
|
|
*
|
|
* @param scalar
|
|
* the scalar to multiply by
|
|
* @param dest
|
|
* will hold the result
|
|
* @return dest
|
|
*/
|
|
Vector4i mul(int scalar, Vector4i dest);
|
|
|
|
/**
|
|
* Divide all components of this {@link Vector4i} by the given scalar value
|
|
* and store the result in <code>dest</code>.
|
|
*
|
|
* @param scalar
|
|
* the scalar to divide by
|
|
* @param dest
|
|
* will hold the result
|
|
* @return dest
|
|
*/
|
|
Vector4i div(float scalar, Vector4i dest);
|
|
|
|
/**
|
|
* Divide all components of this {@link Vector4i} by the given scalar value
|
|
* and store the result in <code>dest</code>.
|
|
*
|
|
* @param scalar
|
|
* the scalar to divide by
|
|
* @param dest
|
|
* will hold the result
|
|
* @return dest
|
|
*/
|
|
Vector4i div(int scalar, Vector4i dest);
|
|
|
|
/**
|
|
* Return the length squared of this vector.
|
|
*
|
|
* @return the length squared
|
|
*/
|
|
long lengthSquared();
|
|
|
|
/**
|
|
* Return the length of this vector.
|
|
*
|
|
* @return the length
|
|
*/
|
|
double length();
|
|
|
|
/**
|
|
* Return the distance between this Vector and <code>v</code>.
|
|
*
|
|
* @param v
|
|
* the other vector
|
|
* @return the distance
|
|
*/
|
|
double distance(Vector4ic v);
|
|
|
|
/**
|
|
* Return the distance between <code>this</code> vector and <code>(x, y, z, w)</code>.
|
|
*
|
|
* @param x
|
|
* the x component of the other vector
|
|
* @param y
|
|
* the y component of the other vector
|
|
* @param z
|
|
* the z component of the other vector
|
|
* @param w
|
|
* the w component of the other vector
|
|
* @return the euclidean distance
|
|
*/
|
|
double distance(int x, int y, int z, int w);
|
|
|
|
/**
|
|
* Return the grid distance in between (aka 1-Norm, Minkowski or Manhattan distance)
|
|
* <code>(x, y)</code>.
|
|
*
|
|
* @param v
|
|
* the other vector
|
|
* @return the grid distance
|
|
*/
|
|
long gridDistance(Vector4ic v);
|
|
|
|
/**
|
|
* Return the grid distance in between (aka 1-Norm, Minkowski or Manhattan distance)
|
|
* <code>(x, y)</code>.
|
|
*
|
|
* @param x
|
|
* the x component of the other vector
|
|
* @param y
|
|
* the y component of the other vector
|
|
* @param z
|
|
* the z component of the other vector
|
|
* @param w
|
|
* the w component of the other vector
|
|
* @return the grid distance
|
|
*/
|
|
long gridDistance(int x, int y, int z, int w);
|
|
|
|
/**
|
|
* Return the square of the distance between this vector and <code>v</code>.
|
|
*
|
|
* @param v
|
|
* the other vector
|
|
* @return the squared of the distance
|
|
*/
|
|
int distanceSquared(Vector4ic v);
|
|
|
|
/**
|
|
* Return the square of the distance between <code>this</code> vector and
|
|
* <code>(x, y, z, w)</code>.
|
|
*
|
|
* @param x
|
|
* the x component of the other vector
|
|
* @param y
|
|
* the y component of the other vector
|
|
* @param z
|
|
* the z component of the other vector
|
|
* @param w
|
|
* the w component of the other vector
|
|
* @return the square of the distance
|
|
*/
|
|
int distanceSquared(int x, int y, int z, int w);
|
|
|
|
/**
|
|
* Compute the dot product (inner product) of this vector and <code>v</code>.
|
|
*
|
|
* @param v
|
|
* the other vector
|
|
* @return the dot product
|
|
*/
|
|
int dot(Vector4ic v);
|
|
|
|
/**
|
|
* Negate this vector and store the result in <code>dest</code>.
|
|
*
|
|
* @param dest
|
|
* will hold the result
|
|
* @return dest
|
|
*/
|
|
Vector4i negate(Vector4i dest);
|
|
|
|
/**
|
|
* Set the components of <code>dest</code> to be the component-wise minimum of this and the other vector.
|
|
*
|
|
* @param v
|
|
* the other vector
|
|
* @param dest
|
|
* will hold the result
|
|
* @return dest
|
|
*/
|
|
Vector4i min(Vector4ic v, Vector4i dest);
|
|
|
|
/**
|
|
* Set the components of <code>dest</code> to be the component-wise maximum of this and the other vector.
|
|
*
|
|
* @param v
|
|
* the other vector
|
|
* @param dest
|
|
* will hold the result
|
|
* @return dest
|
|
*/
|
|
Vector4i max(Vector4ic v, Vector4i dest);
|
|
|
|
/**
|
|
* Get the value of the specified component of this vector.
|
|
*
|
|
* @param component
|
|
* the component, within <code>[0..3]</code>
|
|
* @return the value
|
|
* @throws IllegalArgumentException if <code>component</code> is not within <code>[0..3]</code>
|
|
*/
|
|
int get(int component) throws IllegalArgumentException;
|
|
|
|
/**
|
|
* Determine the component with the biggest absolute value.
|
|
*
|
|
* @return the component index, within <code>[0..3]</code>
|
|
*/
|
|
int maxComponent();
|
|
|
|
/**
|
|
* Determine the component with the smallest (towards zero) absolute value.
|
|
*
|
|
* @return the component index, within <code>[0..3]</code>
|
|
*/
|
|
int minComponent();
|
|
|
|
/**
|
|
* Compute the absolute of each of this vector's components
|
|
* and store the result into <code>dest</code>.
|
|
*
|
|
* @param dest
|
|
* will hold the result
|
|
* @return dest
|
|
*/
|
|
Vector4i absolute(Vector4i dest);
|
|
|
|
/**
|
|
* Compare the vector components of <code>this</code> vector with the given <code>(x, y, z, w)</code>
|
|
* and return whether all of them are equal.
|
|
*
|
|
* @param x
|
|
* the x component to compare to
|
|
* @param y
|
|
* the y component to compare to
|
|
* @param z
|
|
* the z component to compare to
|
|
* @param w
|
|
* the w component to compare to
|
|
* @return <code>true</code> if all the vector components are equal
|
|
*/
|
|
boolean equals(int x, int y, int z, int w);
|
|
|
|
}
|