Module de.fabmax.physxjni

Package physx.extensions

Enum Class PxD6DriveEnum

java.lang.Object

java.lang.Enum<PxD6DriveEnum>

physx.extensions.PxD6DriveEnum

All Implemented Interfaces:

Serializable, Comparable<PxD6DriveEnum>, Constable

public enum PxD6DriveEnum
extends Enum<PxD6DriveEnum>

Used to specify which axes of a D6 joint are driven.

Each drive is an implicit force-limited damped spring:

force = spring * (target position - position) + damping * (targetVelocity - velocity)

Alternatively, the spring may be configured to generate a specified acceleration instead of a force.

A linear axis is affected by drive only if the corresponding drive flag is set. There are two possible models for angular drive: swing/twist, which may be used to drive one or more angular degrees of freedom, or slerp, which may only be used to drive all three angular degrees simultaneously. Please use #PxD6AngularDriveConfig to configure the angular drive model.

See also: PxD6Joint PxD6AngularDriveConfig

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
eSLERP	drive of all three angular degrees along a SLERP-path
eSWING
eTWIST	rotational drive around the X-axis
eX	drive along the X-axis
eY	drive along the Y-axis
eZ	drive along the Z-axis

Field Summary

Fields

Modifier and Type	Field	Description
final int	value

Method Summary

Modifier and Type	Method	Description
static PxD6DriveEnum	forValue(int value)
static PxD6DriveEnum	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PxD6DriveEnum[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

eX

public static final PxD6DriveEnum eX

drive along the X-axis

eY

public static final PxD6DriveEnum eY

drive along the Y-axis

eZ

public static final PxD6DriveEnum eZ

drive along the Z-axis

eSWING

public static final PxD6DriveEnum eSWING

eTWIST

public static final PxD6DriveEnum eTWIST

rotational drive around the X-axis

Note: Only allowed if the angular drive configuration is set to PxD6AngularDriveConfig::eLEGACY or PxD6AngularDriveConfig::eSWING_TWIST.

eSLERP

public static final PxD6DriveEnum eSLERP

drive of all three angular degrees along a SLERP-path

Note: Only allowed if the angular drive configuration is set to PxD6AngularDriveConfig::eSLERP or PxD6AngularDriveConfig::eLEGACY.

Note: If the angular drive configuration is set to PxD6AngularDriveConfig::eLEGACY, then eSLERP takes precedence over eSWING/eTWIST

Field Details

value

public final int value

Method Details

values

public static PxD6DriveEnum[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static PxD6DriveEnum valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

forValue

public static PxD6DriveEnum forValue(int value)