com.github.stephengold.joltjni.Vertex Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jolt-jni-Windows64 Show documentation
a JNI interface to Jolt Physics
The newest version!
/*
Copyright (c) 2024 Stephen Gold

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.github.stephengold.joltjni;

import com.github.stephengold.joltjni.readonly.Vec3Arg;

/**
 * Attributes of a particle, for use during the creation of a soft body. (native
 * type: {@code SoftBodySharedSettings::Vertex})
 *
 * @author Stephen Gold [email protected]
 */
public class Vertex extends JoltPhysicsObject {
    // *************************************************************************
    // constructors

    /**
     * Instantiate a default vertex.
     */
    public Vertex() {
        long vertexVa = createDefault();
        setVirtualAddress(vertexVa, () -> free(vertexVa));
    }
    // *************************************************************************
    // new methods exposed

    /**
     * Return the inverse mass. The vertex is unaffected. (native attribute:
     * mInvMass)
     *
     * @return the inverse of the mass (in 1/kilograms)
     */
    public float getInvMass() {
        long vertexVa = va();
        float result = getInvMass(vertexVa);

        return result;
    }

    /**
     * Copy the initial location. The vertex is unaffected. (native attribute:
     * mPosition)
     *
     * @return a new location vector
     */
    public Float3 getPosition() {
        long vertexVa = va();
        float x = getPositionX(vertexVa);
        float y = getPositionY(vertexVa);
        float z = getPositionZ(vertexVa);
        Float3 result = new Float3(x, y, z);

        return result;
    }

    /**
     * Copy the initial velocity. The vertex is unaffected. (native attribute:
     * mVelocity)
     *
     * @return a new velocity vector (in meters per second)
     */
    public Float3 getVelocity() {
        long vertexVa = va();
        float x = getVelocityX(vertexVa);
        float y = getVelocityY(vertexVa);
        float z = getVelocityZ(vertexVa);
        Float3 result = new Float3(x, y, z);

        return result;
    }

    /**
     * Alter the inverse mass.
     *
     * @param invMass the desired inverse mass (in 1/kilograms)
     */
    public void setInvMass(float invMass) {
        long vertexVa = va();
        setInvMass(vertexVa, invMass);
    }

    /**
     * Alter the initial location of the vertex.
     *
     * @param location the desired location (not null, unaffected)
     */
    public void setPosition(Vec3Arg location) {
        long vertexVa = va();
        float x = location.getX();
        float y = location.getY();
        float z = location.getZ();
        setPosition(vertexVa, x, y, z);
    }

    /**
     * Alter the initial velocity of the vertex.
     *
     * @param velocity the desired velocity (in meters per second, not null,
     * unaffected)
     */
    public void setVelocity(Vec3Arg velocity) {
        long vertexVa = va();
        float x = velocity.getX();
        float y = velocity.getY();
        float z = velocity.getZ();
        setVelocity(vertexVa, x, y, z);
    }
    // *************************************************************************
    // native private methods

    native private static long createDefault();

    native private static void free(long vertexVa);

    native private static float getInvMass(long vertexVa);

    native private static float getPositionX(long vertexVa);

    native private static float getPositionY(long vertexVa);

    native private static float getPositionZ(long vertexVa);

    native private static float getVelocityX(long vertexVa);

    native private static float getVelocityY(long vertexVa);

    native private static float getVelocityZ(long vertexVa);

    native private static void setInvMass(long vertexVa, float invMass);

    native private static void setPosition(
            long vertexVa, float x, float y, float z);

    native private static void setVelocity(
            long vertexVa, float vx, float vy, float vz);
}