com.github.stephengold.joltjni.BodyId 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
There is a newer version: 0.9.3
/*
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.ConstBodyId;

/**
 * Identify a particular {@code Body} to a {@code BodyInterface}.
 *
 * @author Stephen Gold [email protected]
 */
public class BodyId extends JoltPhysicsObject implements ConstBodyId {
    // *************************************************************************
    // constructors

    /**
     * Instantiate with the specified native object assigned.
     *
     * @param idVa the virtual address of the native object to assign (not zero)
     * @param owner true → make the JVM object the owner, false → it
     * isn't the owner
     */
    BodyId(long idVa, boolean owner) {
        Runnable freeingAction = owner ? () -> free(idVa) : null;
        setVirtualAddress(idVa, freeingAction);
    }
    // *************************************************************************
    // ConstBodyId methods

    /**
     * Create a mutable copy.
     *
     * @return a new mutable JVM object with a new native object assigned
     */
    @Override
    public BodyId copy() {
        long idVa = va();
        long copyVa = copy(idVa);
        BodyId result = new BodyId(copyVa, true);

        return result;
    }

    /**
     * Return the body's index in the array. The ID is unaffected.
     *
     * @return the index (≥0)
     */
    @Override
    public int getIndex() {
        long idVa = va();
        int result = getIndex(idVa);

        return result;
    }

    /**
     * Return the body's sequence number. The ID is unaffected.
     *
     * @return the sequence number (≥0)
     */
    @Override
    public int getSequenceNumber() {
        long idVa = va();
        int result = getSequenceNumber(idVa);

        return result;
    }

    /**
     * Test whether the ID is valid. It is unaffected.
     *
     * @return true if invalid, false if valid
     */
    @Override
    public boolean isInvalid() {
        long idVa = va();
        boolean result = isInvalid(idVa);

        return result;
    }
    // *************************************************************************
    // native private methods

    native private static long copy(long idVa);

    native private static void free(long idVa);

    native private static int getIndex(long idVa);

    native private static int getSequenceNumber(long idVa);

    native private static boolean isInvalid(long idVa);
}