All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.github.stephengold.joltjni.ConeConstraintSettings Maven / Gradle / Ivy

There is a newer version: 0.9.3
Show 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.enumerate.EConstraintSpace;
import com.github.stephengold.joltjni.enumerate.EConstraintSubType;
import com.github.stephengold.joltjni.readonly.RVec3Arg;
import com.github.stephengold.joltjni.readonly.Vec3Arg;

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

    /**
     * Instantiate with the specified native object assigned but not owned.
     *
     * @param settingsVa the virtual address of the native object to assign (not
     * zero)
     */
    ConeConstraintSettings(long settingsVa) {
        super(settingsVa);
        setSubType(EConstraintSubType.Cone);
    }

    /**
     * Instantiate default settings.
     */
    public ConeConstraintSettings() {
        long settingsVa = createConeConstraintSettings();
        setVirtualAddress(settingsVa, null); // not owner due to ref counting
        setSubType(EConstraintSubType.Cone);
    }
    // *************************************************************************
    // new methods exposed

    /**
     * Return one-half the maximum angle between the twist axes of body 1 and
     * body 2. The settings are unaffected. (native attribute: mHalfConeAngle)
     *
     * @return the half angle (in radians)
     */
    public float getHalfConeAngle() {
        long settingsVa = va();
        float result = getHalfConeAngle(settingsVa);

        return result;
    }

    /**
     * Copy the constraint location for body 1. The settings are unaffected.
     * (native attribute: mPoint1)
     *
     * @return a new location vector
     */
    public RVec3 getPoint1() {
        long settingsVa = va();
        double x = getPoint1X(settingsVa);
        double y = getPoint1Y(settingsVa);
        double z = getPoint1Z(settingsVa);
        RVec3 result = new RVec3(x, y, z);

        return result;
    }

    /**
     * Copy the constraint location for body 2. The settings are unaffected.
     * (native attribute: mPoint2)
     *
     * @return a new location vector
     */
    public RVec3 getPoint2() {
        long settingsVa = va();
        double x = getPoint2X(settingsVa);
        double y = getPoint2Y(settingsVa);
        double z = getPoint2Z(settingsVa);
        RVec3 result = new RVec3(x, y, z);

        return result;
    }

    /**
     * Return which space the other properties are specified in. The settings
     * are unaffected. (native attribute: mSpace)
     *
     * @return an enum value (not null)
     */
    public EConstraintSpace getSpace() {
        long settingsVa = va();
        int ordinal = getSpace(settingsVa);
        EConstraintSpace result = EConstraintSpace.values()[ordinal];

        return result;
    }

    /**
     * Copy the twist axis of body 1. The settings are unaffected. (native
     * attribute: mTwistAxis1)
     *
     * @return a new direction vector
     */
    public Vec3 getTwistAxis1() {
        long settingsVa = va();
        float x = getTwistAxis1X(settingsVa);
        float y = getTwistAxis1Y(settingsVa);
        float z = getTwistAxis1Z(settingsVa);
        Vec3 result = new Vec3(x, y, z);

        return result;
    }

    /**
     * Copy the twist axis of body 2. The settings are unaffected. (native
     * attribute: mTwistAxis2)
     *
     * @return a new direction vector
     */
    public Vec3 getTwistAxis2() {
        long settingsVa = va();
        float x = getTwistAxis2X(settingsVa);
        float y = getTwistAxis2Y(settingsVa);
        float z = getTwistAxis2Z(settingsVa);
        Vec3 result = new Vec3(x, y, z);

        return result;
    }

    /**
     * Alter the maximum angle between the twist axes of body 1 and body 2.
     * (native attribute: mHalfConeAngle)
     *
     * @param halfAngle the desired half angle (in radians, default=0)
     */
    public void setHalfConeAngle(float halfAngle) {
        long settingsVa = va();
        setHalfConeAngle(settingsVa, halfAngle);
    }

    /**
     * Alter the constraint location for body 1. (native attribute: mPoint1)
     *
     * @param location the desired location (not null, unaffected,
     * default=(0,0,0))
     */
    public void setPoint1(RVec3Arg location) {
        long settingsVa = va();
        double x = location.xx();
        double y = location.yy();
        double z = location.zz();
        setPoint1(settingsVa, x, y, z);
    }

    /**
     * Alter the constraint location for body 2. (native attribute: mPoint2)
     *
     * @param location the desired location (not null, unaffected,
     * default=(0,0,0))
     */
    public void setPoint2(RVec3Arg location) {
        long settingsVa = va();
        double x = location.xx();
        double y = location.yy();
        double z = location.zz();
        setPoint2(settingsVa, x, y, z);
    }

    /**
     * Alter which space the other properties are specified in. (native
     * attribute: mSpace)
     *
     * @param space enum value (not null, default=WorldSpace)
     */
    public void setSpace(EConstraintSpace space) {
        long settingsVa = va();
        int ordinal = space.ordinal();
        setSpace(settingsVa, ordinal);
    }

    /**
     * Alter the twist axis of body 1. (native attribute: mTwistAxis1)
     *
     * @param direction the desired axis direction (not null, unaffected,
     * default=(1,0,0))
     */
    public void setTwistAxis1(Vec3Arg direction) {
        long settingsVa = va();
        float x = direction.getX();
        float y = direction.getY();
        float z = direction.getZ();
        setTwistAxis1(settingsVa, x, y, z);
    }

    /**
     * Alter the twist axis of body 2. (native attribute: mTwistAxis2)
     *
     * @param direction the desired axis direction (not null, unaffected,
     * default=(1,0,0))
     */
    public void setTwistAxis2(Vec3Arg direction) {
        long settingsVa = va();
        float x = direction.getX();
        float y = direction.getY();
        float z = direction.getZ();
        setTwistAxis2(settingsVa, x, y, z);
    }
    // *************************************************************************
    // native private methods

    native private static long createConeConstraintSettings();

    native private static float getHalfConeAngle(long settingsVa);

    native private static double getPoint1X(long settingsVa);

    native private static double getPoint1Y(long settingsVa);

    native private static double getPoint1Z(long settingsVa);

    native private static double getPoint2X(long settingsVa);

    native private static double getPoint2Y(long settingsVa);

    native private static double getPoint2Z(long settingsVa);

    native private static int getSpace(long settingsVa);

    native private static float getTwistAxis1X(long settingsVa);

    native private static float getTwistAxis1Y(long settingsVa);

    native private static float getTwistAxis1Z(long settingsVa);

    native private static float getTwistAxis2X(long settingsVa);

    native private static float getTwistAxis2Y(long settingsVa);

    native private static float getTwistAxis2Z(long settingsVa);

    native private static void setHalfConeAngle(long settingsVa, float angle);

    native private static void setPoint1(
            long settingsVa, double x, double y, double z);

    native private static void setPoint2(
            long settingsVa, double x, double y, double z);

    native private static void setSpace(long settingsVa, int ordinal);

    native private static void setTwistAxis1(
            long settingsVa, float x, float y, float z);

    native private static void setTwistAxis2(
            long settingsVa, float x, float y, float z);
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy