Module de.fabmax.physxjni

Package physx.physics

Enum Class PxPruningStructureTypeEnum

java.lang.Object

java.lang.Enum<PxPruningStructureTypeEnum>

physx.physics.PxPruningStructureTypeEnum

All Implemented Interfaces:

Serializable, Comparable<PxPruningStructureTypeEnum>, Constable

public enum PxPruningStructureTypeEnum
extends Enum<PxPruningStructureTypeEnum>

Pruning structure used to accelerate scene queries.

eNONE uses a simple data structure that consumes less memory than the alternatives, but generally has slower query performance.

eDYNAMIC_AABB_TREE usually provides the fastest queries. However there is a constant per-frame management cost associated with this structure. How much work should be done per frame can be tuned via the #PxSceneQueryDesc::dynamicTreeRebuildRateHint parameter.

eSTATIC_AABB_TREE is typically used for static objects. It is the same as the dynamic AABB tree, without the per-frame overhead. This can be a good choice for static objects, if no static objects are added, moved or removed after the scene has been created. If there is no such guarantee (e.g. when streaming parts of the world in and out), then the dynamic version is a better choice even for static objects.

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
eDYNAMIC_AABB_TREE	Using a dynamic AABB tree
eNONE	Using a simple data structure
eSTATIC_AABB_TREE	Using a static AABB tree

Field Summary

Fields

Modifier and Type	Field	Description
final int	value

Method Summary

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

eNONE

public static final PxPruningStructureTypeEnum eNONE

Using a simple data structure

eDYNAMIC_AABB_TREE

public static final PxPruningStructureTypeEnum eDYNAMIC_AABB_TREE

Using a dynamic AABB tree

eSTATIC_AABB_TREE

public static final PxPruningStructureTypeEnum eSTATIC_AABB_TREE

Using a static AABB tree

Field Details

value

public final int value

Method Details

values

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