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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jolt-jni-MacOSX64 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.template.Array;

/**
 * A variable-length array of references to constraints. (native type:
 * {@code Array>})
 *
 * @author Stephen Gold [email protected]
 */
public class Constraints extends Array {
    // *************************************************************************
    // constructors

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

    /**
     * Count how many references the currently allocated storage can hold. The
     * array is unaffected.
     *
     * @return the number of references (≥size)
     */
    @Override
    public int capacity() {
        long arrayVa = va();
        int result = capacity(arrayVa);

        return result;
    }

    /**
     * Remove all references in the specified range of indices.
     *
     * @param startIndex the index of the first element to remove (≥0)
     * @param stopIndex one plus the index of the last element to remove (≥0)
     */
    @Override
    public void erase(int startIndex, int stopIndex) {
        long vectorVa = va();
        erase(vectorVa, startIndex, stopIndex);
    }

    /**
     * Copy the reference at the specified index.
     *
     * @param elementIndex the index from which to get the reference (≥0)
     * @return a new reference to the same constraint
     */
    @Override
    public ConstraintRef get(int elementIndex) {
        long arrayVa = va();
        long refVa = get(arrayVa, elementIndex);
        ConstraintRef result = new ConstraintRef(refVa, true);

        return result;
    }

    /**
     * Expand or truncate the array.
     *
     * @param numReferences the desired size (number of references, ≥0)
     */
    @Override
    public void resize(int numReferences) {
        long arrayVa = va();
        resize(arrayVa, numReferences);
    }

    /**
     * Duplicate the specified reference at the specified index.
     *
     * @param elementIndex the index at which to put the reference (≥0)
     * @param reference the reference to put (not null)
     */
    @Override
    public void set(int elementIndex, ConstraintRef reference) {
        long arrayVa = va();
        long refVa = reference.va();
        setRef(arrayVa, elementIndex, refVa);
    }

    /**
     * Count how many references are in the array. The array is unaffected.
     *
     * @return the number of references (≥0, ≤capacity)
     */
    @Override
    public int size() {
        long arrayVa = va();
        int result = size(arrayVa);

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

    native private static int capacity(long arrayVa);

    native private static void free(long arrayVa);

    native private static void erase(
            long vectorVa, int startIndex, int stopIndex);

    native private static long get(long arrayVa, int elementIndex);

    native private static void resize(long arrayVa, int numReferences);

    native private static void setRef(
            long arrayVa, int elementIndex, long refVa);

    native private static int size(long arrayVa);
}