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

import com.github.stephengold.joltjni.Quat;
import com.github.stephengold.joltjni.RVec3;

/**
 * Read-only access to a {@code SoftBodyCreationSettings} object. (native type:
 * const SoftBodyCreationSettings)
 *
 * @author Stephen Gold [email protected]
 */
public interface ConstSoftBodyCreationSettings extends ConstJoltPhysicsObject {
    // *************************************************************************
    // new methods exposed

    /**
     * Test whether the created body will be allowed to fall asleep. The
     * settings are unaffected.
     *
     * @return {@code true} if allowed, otherwise {@code false}
     */
    boolean getAllowSleeping();

    /**
     * Return the friction ratio. The settings are unaffected.
     *
     * @return the ratio (typically ≥0 and ≤1)
     */
    float getFriction();

    /**
     * Return the gravity factor. The settings are unaffected.
     *
     * @return the factor
     */
    float getGravityFactor();

    /**
     * Return the linear damping constant. The settings are unaffected.
     *
     * @return the constant (in units of per second, ≥0, ≤1)
     */
    float getLinearDamping();

    /**
     * Return the maximum linear speed. The settings are unaffected.
     *
     * @return the maximum speed (in meters per second)
     */
    float getMaxLinearVelocity();

    /**
     * Return the index of the object layer. The settings are unaffected.
     *
     * @return the layer index (≥0, <numObjectLayers)
     */
    int getObjectLayer();

    /**
     * Return the (initial) location. The settings are unaffected.
     *
     * @return a new location vector (in physics-system coordinates, all
     * components finite)
     */
    RVec3 getPosition();

    /**
     * Return the pressure. The settings are unaffected.
     *
     * @return the pressure
     */
    float getPressure();

    /**
     * Return the restitution ratio. The settings are unaffected.
     *
     * @return the ratio (typically ≥0 and ≤1)
     */
    float getRestitution();

    /**
     * Copy the (initial) orientation of the body's axes. The settings are
     * unaffected.
     *
     * @return a new rotation quaternion (relative to the physics-system axes)
     */
    Quat getRotation();
}