Module com.github.stephengold.joltjni

Package com.github.stephengold.joltjni

Class RackAndPinionConstraintSettings

java.lang.Object

com.github.stephengold.joltjni.JoltPhysicsObject

com.github.stephengold.joltjni.SerializableObject

com.github.stephengold.joltjni.ConstraintSettings

com.github.stephengold.joltjni.TwoBodyConstraintSettings

com.github.stephengold.joltjni.RackAndPinionConstraintSettings

All Implemented Interfaces:

ConstConstraintSettings, ConstJoltPhysicsObject, ConstSerializableObject, RefTarget, AutoCloseable, Comparable<JoltPhysicsObject>

public class RackAndPinionConstraintSettings
extends TwoBodyConstraintSettings

Settings used to construct a RackAndPinionConstraint.

Constructor Summary

Constructors

Constructor	Description
RackAndPinionConstraintSettings()	Instantiate default settings.
RackAndPinionConstraintSettings(RackAndPinionConstraintSettings original)	Instantiate a copy of the specified settings.

Method Summary

Modifier and Type	Method	Description
Vec3	getHingeAxis()	Copy the hinge axis of the pinion.
float	getRatio()	Return the ratio of pinion rotation divided rack translation.
Vec3	getSliderAxis()	Copy the translation axis of the slider.
EConstraintSpace	getSpace()	Return which space the other properties are specified in.
Vec3Arg	setHingeAxis(Vec3Arg direction)	Alter the hinge axis of the pinion.
void	setRatio(float ratio)	Alter the ratio of pinion rotation to rack translation.
void	setRatio(int rackTeeth, float rackLength, int pinionTeeth)	Update the ratio of pinion rotation to rack translation.
Vec3Arg	setSliderAxis(Vec3Arg direction)	Alter the translation axis of the rack.
void	setSpace(EConstraintSpace space)	Alter which space the other properties are specified in.

Methods inherited from class com.github.stephengold.joltjni.TwoBodyConstraintSettings

create, toRef

Methods inherited from class com.github.stephengold.joltjni.ConstraintSettings

getConstraintPriority, getControllerType, getDrawConstraintSize, getEnabled, getNumPositionStepsOverride, getNumVelocityStepsOverride, getRefCount, saveBinaryState, setConstraintPriority, setDrawConstraintSize, setEmbedded, setEnabled, setNumPositionStepsOverride, setNumVelocityStepsOverride, setVirtualAddressAsCoOwner, sRestoreFromBinaryState

Methods inherited from class com.github.stephengold.joltjni.SerializableObject

getRtti

Methods inherited from class com.github.stephengold.joltjni.JoltPhysicsObject

close, compareTo, equals, getContainingObject, hasAssignedNativeObject, hashCode, isCleanerStarted, ownsNativeObject, setVirtualAddress, setVirtualAddress, startCleaner, targetVa, toString, va

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface com.github.stephengold.joltjni.readonly.ConstJoltPhysicsObject

close, hasAssignedNativeObject, ownsNativeObject, targetVa

Methods inherited from interface com.github.stephengold.joltjni.readonly.ConstSerializableObject

getRtti

Constructor Details

RackAndPinionConstraintSettings

public RackAndPinionConstraintSettings()

Instantiate default settings.

RackAndPinionConstraintSettings

public RackAndPinionConstraintSettings(RackAndPinionConstraintSettings original)

Instantiate a copy of the specified settings.

Parameters:

original - the settings to copy (not null, unaffected)

Method Details

getHingeAxis

public Vec3 getHingeAxis()

Copy the hinge axis of the pinion. The settings are unaffected. (native attribute: mHingeAxis)

Returns:

a new direction vector

getRatio

public float getRatio()

Return the ratio of pinion rotation divided rack translation. The settings are unaffected. (native attribute: mRatio)

Returns:

the ratio (in radians per meter)

getSliderAxis

public Vec3 getSliderAxis()

Copy the translation axis of the slider. The settings are unaffected. (native attribute: mSliderAxis)

Returns:

a new direction vector

getSpace

public EConstraintSpace getSpace()

Return which space the other properties are specified in. The settings are unaffected. (native attribute: mSpace)

Returns:

an enum value (not null)

setHingeAxis

public Vec3Arg setHingeAxis(Vec3Arg direction)

Alter the hinge axis of the pinion. (native attribute: mHingeAxis)

Parameters:

direction - the desired axis direction (not null, unaffected, default=(1,0,0))

Returns:

the argument, for chaining

setRatio

public void setRatio(float ratio)

Alter the ratio of pinion rotation to rack translation. (native attribute: mRatio)

Parameters:

ratio - the desired radio (in radians/meter)

setRatio

public void setRatio(int rackTeeth,
 float rackLength,
 int pinionTeeth)

Update the ratio of pinion rotation to rack translation.

Parameters:

rackTeeth - the number of teeth in the rack

rackLength - the length of the rack (in meters)

pinionTeeth - the number of teeth in the pinion

setSliderAxis

public Vec3Arg setSliderAxis(Vec3Arg direction)

Alter the translation axis of the rack. (native attribute: mSliderAxis)

Parameters:

direction - the desired axis direction (not null, unaffected, default=(1,0,0))

Returns:

the argument, for chaining

setSpace

public void setSpace(EConstraintSpace space)

Alter which space the other properties are specified in. (native attribute: mSpace)

Parameters:

space - enum value (not null, default=WorldSpace)