com.github.stephengold.joltjni.ConstraintSettings 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
Show all versions of jolt-jni-Windows64 Show documentation
a JNI interface to Jolt Physics
/*
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.EConstraintSubType;
import com.github.stephengold.joltjni.readonly.ConstConstraintSettings;
import com.github.stephengold.joltjni.template.RefTarget;
/**
* Settings used to construct a {@code Constraint}.
*
* @author Stephen Gold [email protected]
*/
abstract public class ConstraintSettings
extends SerializableObject
implements ConstConstraintSettings, RefTarget {
// *************************************************************************
// constructors
/**
* Instantiate settings with no native object assigned.
*/
ConstraintSettings() {
}
/**
* Instantiate settings with the specified native object assigned but not
* owned.
*
* @param settingsVa the virtual address of the native object to assign (not
* zero)
*/
ConstraintSettings(long settingsVa) {
super(settingsVa);
}
// *************************************************************************
// new methods exposed
/**
* Instantiate a {@code ConstraintSettings} given its virtual address.
*
* @param settingsVa the virtual address of the native object, or zero
* @return a new JVM object, or {@code null} if the argument was zero
*/
static ConstraintSettings newConstraintSettings(long settingsVa) {
if (settingsVa == 0L) {
return null;
}
long ordinal = getUserData(settingsVa);
EConstraintSubType subType = EConstraintSubType.values()[(int) ordinal];
ConstraintSettings result;
switch (subType) {
case Cone:
result = new ConeConstraintSettings(settingsVa);
break;
case Distance:
result = new DistanceConstraintSettings(settingsVa);
break;
case Fixed:
result = new FixedConstraintSettings(settingsVa);
break;
case Gear:
result = new GearConstraintSettings(settingsVa);
break;
case Hinge:
result = new HingeConstraintSettings(settingsVa);
break;
case Path:
result = new PathConstraintSettings(settingsVa);
break;
case Point:
result = new PointConstraintSettings(settingsVa);
break;
case Pulley:
result = new PulleyConstraintSettings(settingsVa);
break;
case RackAndPinion:
result = new RackAndPinionConstraintSettings(settingsVa);
break;
case SixDof:
result = new SixDofConstraintSettings(settingsVa);
break;
case Slider:
result = new SliderConstraintSettings(settingsVa);
break;
case SwingTwist:
result = new SwingTwistConstraintSettings(settingsVa);
break;
case Vehicle:
result = new VehicleConstraintSettings(settingsVa);
break;
default:
throw new IllegalArgumentException("subType = " + subType);
}
return result;
}
/**
* Alter the constraint's priority when solving. (native attribute:
* mConstraintPriority)
*
* @param level the desired priority level (default=0)
*/
public void setConstraintPriority(int level) {
long settingsVa = va();
setConstraintPriority(settingsVa, level);
}
/**
* Alter the size of constraint in debug renders. (native attribute:
* mDrawConstraintSize)
*
* @param size the desired size (default=1)
*/
public void setDrawConstraintSize(float size) {
long settingsVa = va();
setDrawConstraintSize(settingsVa, size);
}
/**
* Initially enable or disable the constraint. (native attribute: mEnabled)
*
* @param setting true to enable or false to disable (default=true)
*/
public void setEnabled(boolean setting) {
long settingsVa = va();
setEnabled(settingsVa, setting);
}
/**
* Alter the override for the number of position iterations used in the
* solver. (native attribute: mNumPositionStepsOverride)
*
* @param setting the number of iterations, or 0 to use the default in
* {@code PhysicsSettings} (default=0)
*/
public void setNumPositionStepsOverride(int setting) {
long settingsVa = va();
setNumPositionStepsOverride(settingsVa, setting);
}
/**
* Alter the override for the number of velocity iterations used in the
* solver. (native attribute: mNumVelocityStepsOverride)
*
* @param setting the number of iterations, or 0 to use the default in
* {@code PhysicsSettings} (default=0)
*/
public void setNumVelocityStepsOverride(int setting) {
long settingsVa = va();
setNumVelocityStepsOverride(settingsVa, setting);
}
// *************************************************************************
// new protected methods
/**
* Alter the user data, which holds the {@code EConstraintSubType} ordinal.
* (native attribute: mUserData)
*
* @param constraintSubType the desired value (not null, default=0)
*/
void setSubType(EConstraintSubType constraintSubType) {
long settingsVa = va();
long ordinal = constraintSubType.ordinal();
setUserData(settingsVa, ordinal);
}
// *************************************************************************
// ConstConstraintSettings methods
/**
* Return the constraint's priority when solving. The settings are
* unaffected. (native attribute: mConstraintPriority)
*
* @return the priority level
*/
@Override
public int getConstraintPriority() {
long settingsVa = va();
int result = getConstraintPriority(settingsVa);
return result;
}
/**
* Return the size of the constraint in debug renders. The settings are
* unaffected. (native attribute: mDrawConstraintSize)
*
* @return the size
*/
@Override
public float getDrawConstraintSize() {
long settingsVa = va();
float result = getDrawConstraintSize(settingsVa);
return result;
}
/**
* Test whether the constraint will be enabled initially. The settings are
* unaffected. (native attribute: mEnabled)
*
* @return true if enabled, otherwise false
*/
@Override
public boolean getEnabled() {
long settingsVa = va();
boolean result = getEnabled(settingsVa);
return result;
}
/**
* Return the override for the number of position iterations used in the
* solver. The settings are unaffected. (native attribute:
* mNumPositionStepsOverride)
*
* @return the number of iterations, or 0 to use the default in
* {@code PhysicsSettings}
*/
@Override
public int getNumPositionStepsOverride() {
long settingsVa = va();
int result = getNumPositionStepsOverride(settingsVa);
return result;
}
/**
* Return the override for the number of velocity iterations used in the
* solver. The settings are unaffected. (native attribute:
* mNumVelocityStepsOverride)
*
* @return the number of iterations, or 0 to use the default configured in
* {@code PhysicsSettings}
*/
@Override
public int getNumVelocityStepsOverride() {
long settingsVa = va();
int result = getNumVelocityStepsOverride(settingsVa);
return result;
}
// *************************************************************************
// RefTarget methods
/**
* Count the active references to the native {@code ConstraintSettings}. The
* settings are unaffected.
*
* @return the count (≥0)
*/
@Override
public int getRefCount() {
long settingsVa = va();
int result = getRefCount(settingsVa);
return result;
}
/**
* Mark the native {@code ConstraintSettings} as embedded.
*/
@Override
public void setEmbedded() {
long settingsVa = va();
setEmbedded(settingsVa);
}
/**
* Create a counted reference to the native {@code ConstraintSettings}.
*
* @return a new JVM object with a new native object assigned
*/
@Override
public ConstraintSettingsRef toRef() {
long settingsVa = va();
long refVa = toRef(settingsVa);
ConstraintSettingsRef result = new ConstraintSettingsRef(refVa, true);
return result;
}
// *************************************************************************
// native methods
native static int getConstraintPriority(long settingsVa);
native static float getDrawConstraintSize(long settingsVa);
native static boolean getEnabled(long settingsVa);
native static int getNumPositionStepsOverride(long settingsVa);
native static int getNumVelocityStepsOverride(long settingsVa);
native static int getRefCount(long settingsVa);
native static long getUserData(long settingsVa);
native private static void setConstraintPriority(
long settingsVa, int level);
native private static void setDrawConstraintSize(
long settingsVa, float size);
native private static void setEmbedded(long settingsVa);
native private static void setEnabled(long settingsVa, boolean value);
native private static void setNumPositionStepsOverride(
long settingsVa, int setting);
native private static void setNumVelocityStepsOverride(
long settingsVa, int setting);
native private static void setUserData(long settingsVa, long value);
native private static long toRef(long settingsVa);
}