Module de.fabmax.physxjni

Package physx.vehicle2

Enum Class PxVehicleEngineDriveTransmissionCommandStateEnum

java.lang.Object

java.lang.Enum<PxVehicleEngineDriveTransmissionCommandStateEnum>

physx.vehicle2.PxVehicleEngineDriveTransmissionCommandStateEnum

All Implemented Interfaces:

Serializable, Comparable<PxVehicleEngineDriveTransmissionCommandStateEnum>, Constable

public enum PxVehicleEngineDriveTransmissionCommandStateEnum
extends Enum<PxVehicleEngineDriveTransmissionCommandStateEnum>

A description of the state of transmission-related commands that are applied to a vehicle with engine drive.

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
eAUTOMATIC_GEAR	Special gear value to denote the automatic shift mode (often referred to as DRIVE).

Field Summary

Fields

Modifier and Type	Field	Description
final int	value

Method Summary

Modifier and Type	Method	Description
static PxVehicleEngineDriveTransmissionCommandStateEnum	forValue(int value)
static PxVehicleEngineDriveTransmissionCommandStateEnum	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PxVehicleEngineDriveTransmissionCommandStateEnum[]	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

eAUTOMATIC_GEAR

public static final PxVehicleEngineDriveTransmissionCommandStateEnum eAUTOMATIC_GEAR

Special gear value to denote the automatic shift mode (often referred to as DRIVE).

When using automatic transmission, setting this value as target gear will enable automatic gear shifts between first and highest gear. If the current gear is a reverse gear or the neutral gear, then this value will trigger a shift to first gear. If this value is used even though there is no automatic transmission available, the gear state will remain unchanged.

Field Details

value

public final int value

Method Details

values

public static PxVehicleEngineDriveTransmissionCommandStateEnum[] 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 PxVehicleEngineDriveTransmissionCommandStateEnum 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 PxVehicleEngineDriveTransmissionCommandStateEnum forValue(int value)