Module de.fabmax.physxjni

Package physx.geometry

Enum Class PxHeightFieldFormatEnum

java.lang.Object

java.lang.Enum<PxHeightFieldFormatEnum>

physx.geometry.PxHeightFieldFormatEnum

All Implemented Interfaces:

Serializable, Comparable<PxHeightFieldFormatEnum>, Constable

public enum PxHeightFieldFormatEnum
extends Enum<PxHeightFieldFormatEnum>

Describes the format of height field samples. See also: PxHeightFieldDesc.format PxHeightFieldDesc.samples

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
eS16_TM	Height field height data is 16 bit signed integers, followed by triangle materials.

Field Summary

Fields

Modifier and Type	Field	Description
final int	value

Method Summary

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

eS16_TM

public static final PxHeightFieldFormatEnum eS16_TM

Height field height data is 16 bit signed integers, followed by triangle materials.

Each sample is 32 bits wide arranged as follows:

\image html heightFieldFormat_S16_TM.png

1) First there is a 16 bit height value. 2) Next, two one byte material indices, with the high bit of each byte reserved for special use. (so the material index is only 7 bits). The high bit of material0 is the tess-flag. The high bit of material1 is reserved for future use.

There are zero or more unused bytes before the next sample depending on PxHeightFieldDesc.sampleStride, where the application may eventually keep its own data.

This is the only format supported at the moment.

See also: PxHeightFieldDesc.format PxHeightFieldDesc.samples

Field Details

value

public final int value

Method Details

values

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