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

/**
 * A {@code Shape} composed from a union of simpler subshapes.
 *
 * @author Stephen Gold [email protected]
 */
abstract public class CompoundShape extends Shape {
    // *************************************************************************
    // constructors

    /**
     * Instantiate a shape with no native object assigned.
     */
    CompoundShape() {
    }

    /**
     * Instantiate a shape with the specified native object assigned but not
     * owned.
     *
     * @param shapeVa the virtual address of the native object to assign (not
     * zero)
     */
    CompoundShape(long shapeVa) {
        super(shapeVa);
    }
    // *************************************************************************
    // new methods exposed

    /**
     * Count the subshapes.
     *
     * @return the count (≥0)
     */
    public int getNumSubShapes() {
        long shapeVa = va();
        int result = getNumSubShapes(shapeVa);

        return result;
    }

    /**
     * Access the specified subshape.
     *
     * @param subShapeIndex the index of the subshape (≥0)
     * @return a new JVM object with the pre-existing native object assigned
     */
    public SubShape getSubShape(int subShapeIndex) {
        long shapeVa = va();
        long subShapeVa = getSubShape(shapeVa, subShapeIndex);
        SubShape result = new SubShape(subShapeVa);

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

    native private static int getNumSubShapes(long shapeVa);

    native private static long getSubShape(long shapeVa, int subShapeIndex);
}