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

/**
 * Settings used to construct a {@code TwoBodyConstraint}.
 *
 * @author Stephen Gold [email protected]
 */
abstract public class TwoBodyConstraintSettings extends ConstraintSettings {
    // *************************************************************************
    // constructors

    /**
     * Instantiate settings with no native object assigned.
     */
    TwoBodyConstraintSettings() {
    }

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

    /**
     * Create a constraint using the settings. The settings are unaffected.
     *
     * @param body1 the desired first body (not null)
     * @param body2 the desired 2nd body (not null)
     * @return a new constraint
     */
    public TwoBodyConstraint create(Body body1, Body body2) {
        long settingsVa = va();
        long body1Va = body1.va();
        long body2Va = body2.va();
        long constraintVa = createConstraint(settingsVa, body1Va, body2Va);
        TwoBodyConstraint result
                = (TwoBodyConstraint) Constraint.newConstraint(constraintVa);

        return result;
    }
    // *************************************************************************
    // ConstraintSettings methods

    /**
     * Create a counted reference to the native {@code ConstraintSettings}.
     *
     * @return a new JVM object with a new native object assigned
     */
    @Override
    public TwoBodyConstraintSettingsRef toRef() {
        long settingsVa = va();
        long refVa = toRef(settingsVa);
        TwoBodyConstraintSettingsRef result
                = new TwoBodyConstraintSettingsRef(refVa, true);

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

    native static long createConstraint(
            long settingsVa, long body1Va, long body2Va);

    native private static long toRef(long settingsVa);
}