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

/**
 * A {@code Shape} to represent centered, axis-aligned rectangular solids.
 *
 * @author Stephen Gold [email protected]
 */
public class BoxShape extends ConvexShape {
    // *************************************************************************
    // constructors

    /**
     * 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)
     */
    BoxShape(long shapeVa) {
        super(shapeVa);
    }

    /**
     * Instantiate a shape with the specified half extents.
     *
     * @param halfExtents the desired half extents on each local axis (not null,
     * all components ≥0.05, unaffected)
     */
    public BoxShape(Vec3Arg halfExtents) {
        this(halfExtents, PhysicsSettings.cDefaultConvexRadius);
    }

    /**
     * Instantiate a shape with the specified half extents and convex radius.
     *
     * @param halfExtents the desired half extents on each local axis (not null,
     * all components ≥convexRadius, unaffected)
     * @param convexRadius the desired convex radius (default=0.05)
     */
    public BoxShape(Vec3Arg halfExtents, float convexRadius) {
        float xHalfExtent = halfExtents.getX();
        float yHalfExtent = halfExtents.getY();
        float zHalfExtent = halfExtents.getZ();
        assert xHalfExtent >= convexRadius : xHalfExtent;
        assert yHalfExtent >= convexRadius : yHalfExtent;
        assert zHalfExtent >= convexRadius : zHalfExtent;
        long shapeVa = createBoxShape(
                xHalfExtent, yHalfExtent, zHalfExtent, convexRadius);
        setVirtualAddress(shapeVa, null); // not the owner due to ref counting
    }
    // *************************************************************************
    // new methods exposed

    /**
     * Return the convex radius. The shape is unaffected.
     *
     * @return the radius (≥0)
     */
    public float getConvexRadius() {
        long shapeVa = va();
        float result = getConvexRadius(shapeVa);

        return result;
    }

    /**
     * Copy the half extents. The shape is unaffected.
     *
     * @return a new vector
     */
    public Vec3 getHalfExtent() {
        long shapeVa = va();
        float hx = getHalfExtentX(shapeVa);
        float hy = getHalfExtentY(shapeVa);
        float hz = getHalfExtentZ(shapeVa);
        Vec3 result = new Vec3(hx, hy, hz);

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

    native private static long createBoxShape(float xHalfExtent,
            float yHalfExtent, float zHalfExtent, float convexRadius);

    native private static float getConvexRadius(long shapeVa);

    native private static float getHalfExtentX(long shapeVa);

    native private static float getHalfExtentY(long shapeVa);

    native private static float getHalfExtentZ(long shapeVa);
}