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

import com.github.stephengold.joltjni.BodyCreationSettings;
import com.github.stephengold.joltjni.Quat;
import com.github.stephengold.joltjni.RMat44;
import com.github.stephengold.joltjni.RVec3;
import com.github.stephengold.joltjni.Vec3;
import com.github.stephengold.joltjni.enumerate.EBodyType;
import com.github.stephengold.joltjni.enumerate.EMotionType;

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

    /**
     * Test whether the body could be made kinematic or dynamic. The body is
     * unaffected.
     *
     * @return {@code true} if possible, otherwise {@code false}
     */
    boolean canBeKinematicOrDynamic();

    /**
     * Return the net force acting on the body. The body is unaffected.
     *
     * @return a new force vector (Newtons in system coordinates)
     */
    Vec3 getAccumulatedForce();

    /**
     * Return the net torque acting on the body. The body is unaffected.
     *
     * @return a new torque vector (Newton.meters in system coordinates)
     */
    Vec3 getAccumulatedTorque();

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

    /**
     * Return the body's angular velocity. The body is unaffected.
     *
     * @return a new velocity vector (radians per second in system coordinates)
     */
    Vec3 getAngularVelocity();

    /**
     * Convert the body to a {@code BodyCreationSettings} object. The body is
     * unaffected.
     *
     * @return a new object
     */
    BodyCreationSettings getBodyCreationSettings();

    /**
     * Return the body type (rigid or soft). The body is unaffected.
     *
     * @return an enum value (not null)
     */
    EBodyType getBodyType();

    /**
     * Return the broadphase layer. The body is unaffected.
     *
     * @return the layer ID
     */
    int getBroadPhaseLayer();

    /**
     * Copy the location of the body's center of mass (which might not coincide
     * with its origin). The body is unaffected.
     *
     * @return a new location vector (in system coordinates, all components
     * finite)
     */
    RVec3 getCenterOfMassPosition();

    /**
     * Copy the coordinate transform of the body's center of mass. The body is
     * unaffected.
     *
     * @return a new transform matrix (relative to system coordinates)
     */
    RMat44 getCenterOfMassTransform();

    /**
     * Test whether extra effort should be made to remove ghost contacts. The
     * body is unaffected.
     *
     * @return {@code true} for extra effort, otherwise {@code false}
     */
    boolean getEnhancedInternalEdgeRemoval();

    /**
     * Return the body's friction ratio. The body is unaffected.
     *
     * @return the ratio
     */
    float getFriction();

    /**
     * Copy the body's ID for use with {@code BodyInterface}. The body is
     * unaffected.
     *
     * @return a new immutable JVM object with the pre-existing native object
     * assigned
     */
    ConstBodyId getId();

    /**
     * Return the body's linear velocity. The body is unaffected.
     *
     * @return a new velocity vector (meters per second in system coordinates)
     */
    Vec3 getLinearVelocity();

    /**
     * Return the body's motion type. The body is unaffected.
     *
     * @return an enum value (not null)
     */
    EMotionType getMotionType();

    /**
     * Return the body's object layer. The body is unaffected.
     *
     * @return a layer index (≥0)
     */
    int getObjectLayer();

    /**
     * Return the location of the body's origin (which might not coincide with
     * its center of mass). The body is unaffected.
     *
     * @return a new location vector (in system coordinates, all components
     * finite)
     */
    RVec3 getPosition();

    /**
     * Return the body's restitution ratio. The body is unaffected.
     *
     * @return the value (typically ≥0 and ≤1)
     */
    float getRestitution();

    /**
     * Return the body's orientation. The body is unaffected.
     *
     * @return a new rotation quaternion (relative to the system axes)
     */
    Quat getRotation();

    /**
     * Access the body's shape.
     *
     * @return a new immutable JVM object with the pre-existing native object
     * assigned, or {@code null} if none
     */
    ConstShape getShape();

    /**
     * Return the body's user data: can be used for anything. The body is
     * unaffected.
     *
     * @return the value
     */
    long getUserData();

    /**
     * Access the body's bounding box. The body is unaffected.
     *
     * @return a new immutable JVM object with the pre-existing native object
     * assigned
     */
    ConstAaBox getWorldSpaceBounds();

    /**
     * Copy the world transform. The body is unaffected.
     *
     * @return a new matrix relative to system coordinates
     */
    RMat44 getWorldTransform();

    /**
     * Test whether the body is deactivated. The body is unaffected.
     *
     * @return {@code false} if deactivated, otherwise {@code true}
     */
    boolean isActive();

    /**
     * Test whether the body is dynamic. The body is unaffected.
     *
     * @return {@code true} if dynamic, otherwise {@code false}
     */
    boolean isDynamic();

    /**
     * Test whether the body has been added to its {@code PhysicsSystem}. The
     * body is unaffected.
     *
     * @return {@code true} if added, otherwise {@code false}
     */
    boolean isInBroadPhase();

    /**
     * Test whether the body is kinematic. It is unaffected.
     *
     * @return {@code true} if kinematic, otherwise {@code false}
     */
    boolean isKinematic();

    /**
     * Test whether the body is a rigid body. It is unaffected.
     *
     * @return {@code true} if rigid body, otherwise {@code false}
     */
    boolean isRigidBody();

    /**
     * Test whether the body is a sensor. The body is unaffected.
     *
     * @return {@code true} if a sensor, otherwise {@code false}
     */
    boolean isSensor();

    /**
     * Test whether the body is static (non-moving). It is unaffected.
     *
     * @return {@code true} if static, otherwise {@code false}
     */
    boolean isStatic();
}