com.github.stephengold.joltjni.OffsetCenterOfMassShapeSettings 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.enumerate.EShapeSubType;
import com.github.stephengold.joltjni.readonly.Vec3Arg;

/**
 * Settings used to construct an {@code OffsetCenterOfMassShape}.
 *
 * @author Stephen Gold [email protected]
 */
public class OffsetCenterOfMassShapeSettings extends DecoratedShapeSettings {
    // *************************************************************************
    // constructors

    /**
     * Instantiate with the specified native object assigned but not owned.
     *
     * @param ocomssVa the virtual address of the native object to assign (not
     * zero)
     */
    OffsetCenterOfMassShapeSettings(long ocomssVa) {
        super(ocomssVa);
        setSubType(EShapeSubType.OffsetCenterOfMass);
    }

    /**
     * Instantiate a settings object with the specified offset and base shape.
     *
     * @param offset (not null, unaffected)
     * @param baseShapeRef a reference to the base shape (not null)
     */
    public OffsetCenterOfMassShapeSettings(
            Vec3Arg offset, ShapeRefC baseShapeRef) {
        float offsetX = offset.getX();
        float offsetY = offset.getY();
        float offsetZ = offset.getZ();
        long baseShapeRefVa = baseShapeRef.va();
        long ocomssVa = createSettingsFromShapeRef(
                offsetX, offsetY, offsetZ, baseShapeRefVa);
        setVirtualAddress(ocomssVa, null); // no owner due to ref counting
        setSubType(EShapeSubType.OffsetCenterOfMass);
    }

    /**
     * Instantiate a settings object with the specified offset and base-shape
     * settings.
     *
     * @param offset (not null, unaffected)
     * @param baseShapeSettings settings to create the base shape (not null)
     */
    public OffsetCenterOfMassShapeSettings(
            Vec3Arg offset, ShapeSettings baseShapeSettings) {
        float offsetX = offset.getX();
        float offsetY = offset.getY();
        float offsetZ = offset.getZ();
        long baseShapeSettingsVa = baseShapeSettings.va();
        long ocomssVa = createSettingsFromSettings(
                offsetX, offsetY, offsetZ, baseShapeSettingsVa);
        setVirtualAddress(ocomssVa, null); // no owner due to ref counting
        setSubType(EShapeSubType.OffsetCenterOfMass);
    }
    // *************************************************************************
    // new methods exposed

    /**
     * Copy the offset relative to the base shape. The settings are unaffected.
     * (native attribute: mOffset)
     *
     * @return a new, mutable offset vector
     */
    public Vec3 getOffset() {
        long ocomssVa = va();
        float offsetX = getOffsetX(ocomssVa);
        float offsetY = getOffsetY(ocomssVa);
        float offsetZ = getOffsetZ(ocomssVa);
        Vec3 result = new Vec3(offsetX, offsetY, offsetZ);

        return result;
    }

    /**
     * Alter the offset relative to the base shape. (native attribute: mOffset)
     *
     * @param offset the desired offset vector (not null, unaffected,
     * default=(0,0,0))
     */
    public void setOffset(Vec3Arg offset) {
        long ocomssVa = va();
        float offsetX = offset.getX();
        float offsetY = offset.getY();
        float offsetZ = offset.getZ();
        setOffset(ocomssVa, offsetX, offsetY, offsetZ);
    }
    // *************************************************************************
    // native private methods

    native private static long createSettingsFromSettings(float offsetX,
            float offsetY, float offsetZ, long baseShapeSettingsVa);

    native private static long createSettingsFromShapeRef(
            float offsetX, float offsetY, float offsetZ, long baseShapeRefVa);

    native private static float getOffsetX(long ocomssVa);

    native private static float getOffsetY(long ocomssVa);

    native private static float getOffsetZ(long ocomssVa);

    native private static void setOffset(
            long ocomssVa, float offsetX, float offsetY, float offsetZ);
}