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

Go to download
/*
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 vector (array) of bodies. (native type:
 * {@code Array})
 *
 * @author Stephen Gold [email protected]
 */
public class BodyVector extends Array {
    // *************************************************************************
    // constructors

    /**
     * Instantiate a vector with the specified native object assigned but not
     * owned.
     *
     * @param manager the containing object, or {@code null} if none
     * @param vectorVa the virtual address of the native object to assign (not
     * zero)
     */
    BodyVector(BodyManager manager, long vectorVa) {
        super(manager, vectorVa);
    }
    // *************************************************************************
    // new methods exposed

    /**
     * Access the underlying {@code BodyManager}.
     *
     * @return the pre-existing instance (not null)
     */
    public BodyManager getManager() {
        return (BodyManager) getContainingObject();
    }
    // *************************************************************************
    // Array methods

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

        return result;
    }

    /**
     * Remove all bodies 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);
    }

    /**
     * Access the body at the specified index.
     *
     * @param elementIndex the index from which to get the body (≥0)
     * @return a new JVM object with the pre-existing native object assigned, or
     * else {@code null}
     */
    @Override
    public Body get(int elementIndex) {
        long vectorVa = va();
        long bodyVa = getBody(vectorVa, elementIndex);
        Body result;
        if (bodyVa == 0L) {
            result = null;
        } else {
            result = new Body(bodyVa);
        }

        return result;
    }

    /**
     * Expand or truncate the vector.
     *
     * @param numBodies the desired size (number of bodies, ≥0)
     */
    @Override
    public void resize(int numBodies) {
        long vectorVa = va();
        resize(vectorVa, numBodies);
    }

    /**
     * Put the specified body at the specified index.
     *
     * @param elementIndex the index at which to put the body (≥0)
     * @param body the body to put (not null)
     */
    @Override
    public void set(int elementIndex, Body body) {
        long vectorVa = va();
        long bodyVa = body.va();
        setBody(vectorVa, elementIndex, bodyVa);
    }

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

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

    native private static int capacity(long vectorVa);

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

    native private static long getBody(long vectorVa, int elementIndex);

    native private static void resize(long vectorVa, int numBodies);

    native private static void setBody(
            long vectorVa, int elementIndex, long bodyVa);

    native private static int size(long vectorVa);
}