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

/**
 * Settings used to generate a rigid body in a {@code Ragdoll}. (native type:
 * RagdollSettings::Part)
 *
 * @author Stephen Gold [email protected]
 */
public class Part extends BodyCreationSettings {
    // *************************************************************************
    // constructors

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

    /**
     * Return the settings to create the joint to the part's parent. The part is
     * unaffected. (native attribute: mToParent)
     *
     * @return a new JVM with the pre-exising native object assigned
     */
    public ConstraintSettings getToParent() {
        long partVa = va();
        long settingsVa = getToParent(partVa);
        ConstraintSettings result
                = ConstraintSettings.newConstraintSettings(settingsVa);

        return result;
    }

    /**
     * Alter the settings to create the joint to the part's parent. (native
     * attribute: mToParent)
     *
     * @param settings the desired settings (not null)
     */
    public void setToParent(ConstraintSettings settings) {
        long partVa = va();
        long settingsVa = settings.va();
        setToParent(partVa, settingsVa);
    }
    // *************************************************************************
    // native private methods

    native private static long getToParent(long partVa);

    native private static void setToParent(long partVa, long settingsVa);
}