Module de.fabmax.physxjni

Package physx.physics

Enum Class PxDynamicTreeSecondaryPrunerEnum

java.lang.Object

java.lang.Enum<PxDynamicTreeSecondaryPrunerEnum>

physx.physics.PxDynamicTreeSecondaryPrunerEnum

All Implemented Interfaces:

Serializable, Comparable<PxDynamicTreeSecondaryPrunerEnum>, Constable

public enum PxDynamicTreeSecondaryPrunerEnum
extends Enum<PxDynamicTreeSecondaryPrunerEnum>

Secondary pruning structure used for newly added objects in dynamic trees.

Dynamic trees (PxPruningStructureType::eDYNAMIC_AABB_TREE) are slowly rebuilt over several frames. A secondary pruning structure holds and manages objects added to the scene while this rebuild is in progress.

eNONE ignores newly added objects. This means that for a number of frames (roughly defined by PxSceneQueryDesc::dynamicTreeRebuildRateHint) newly added objects will be ignored by scene queries. This can be acceptable when streaming large worlds, e.g. when the objects added at the boundaries of the game world don't immediately need to be visible from scene queries (it would be equivalent to streaming that data in a few frames later). The advantage of this approach is that there is no CPU cost associated with inserting the new objects in the scene query data structures, and no extra runtime cost when performing queries.

eBUCKET uses a structure similar to PxPruningStructureType::eNONE. Insertion is fast but query cost can be high.

eINCREMENTAL uses an incremental AABB-tree, with no direct PxPruningStructureType equivalent. Query time is fast but insertion cost can be high.

eBVH uses a PxBVH structure. This usually offers the best overall performance.

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
eBUCKET	bucket-based secondary pruner, faster updates, slower query time
eBVH	PxBVH-based secondary pruner, good overall performance
eINCREMENTAL	incremental-BVH secondary pruner, faster query time, slower updates
eNONE	no secondary pruner, new objects aren't visible to SQ for a few frames

Field Summary

Fields

Modifier and Type	Field	Description
final int	value

Method Summary

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

no secondary pruner, new objects aren't visible to SQ for a few frames

eBUCKET

public static final PxDynamicTreeSecondaryPrunerEnum eBUCKET

bucket-based secondary pruner, faster updates, slower query time

eINCREMENTAL

public static final PxDynamicTreeSecondaryPrunerEnum eINCREMENTAL

incremental-BVH secondary pruner, faster query time, slower updates

eBVH

public static final PxDynamicTreeSecondaryPrunerEnum eBVH

PxBVH-based secondary pruner, good overall performance

Field Details

value

public final int value

Method Details

values

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