nvidia::apex::DestructibleChunkDesc Class Reference

#include <DestructibleAsset.h>

List of all members.

Public Member Functions
PX_INLINE	DestructibleChunkDesc ()
	constructor sets to default.
PX_INLINE void	setToDefault ()
	(re)sets the structure to the default.
PX_INLINE bool	isValid () const
Public Attributes
bool	isSupportChunk
bool	doNotFracture
bool	doNotDamage
bool	doNotCrumble
bool	runtimeFracture
bool	useInstancedRendering
PxVec3	instancePositionOffset
PxVec2	instanceUVOffset
uint16_t	meshIndex
int32_t	parentIndex
PxVec3	surfaceNormal
int8_t	behaviorGroupIndex
uint32_t	scatterMeshCount
const uint8_t *	scatterMeshIndices
const PxMat44 *	scatterMeshTransforms

---

Detailed Description

Destructible authoring structure.

Descriptor to build one chunk in a fracture hierarchy.

---

Constructor & Destructor Documentation

PX_INLINE nvidia::apex::DestructibleChunkDesc::DestructibleChunkDesc

(

)

constructor sets to default.

---

Member Function Documentation

PX_INLINE bool nvidia::apex::DestructibleChunkDesc::isValid

(

)

const

Returns true iff an object can be created using this descriptor.

PX_INLINE void nvidia::apex::DestructibleChunkDesc::setToDefault

(

)

(re)sets the structure to the default.

---

Member Data Documentation

int8_t nvidia::apex::DestructibleChunkDesc::behaviorGroupIndex

Referring to the behavior group used of this chunk, please check DestructibleAssetCookingDesc::behaviorGroupDescs for more detail.

bool nvidia::apex::DestructibleChunkDesc::doNotCrumble

Defines the chunk to be uncrumbleable. This means this chunk will not be broken down into fluid mesh particles no matter how much damage it takes. Note: this only applies to chunks with no children. For a chunk with children, then: 1) The chunk may be broken down into its children, and then its children may be crumbled, if the doNotCrumble flag is not set on them. 2) If the Destructible module's chunk depth offset LOD may be set such that this chunk effectively has no children. In this case, the doNotCrumble flag will apply to it.

bool nvidia::apex::DestructibleChunkDesc::doNotDamage

Defines the chunk to be undamageable. This means this chunk will not fracture, but its children might.

bool nvidia::apex::DestructibleChunkDesc::doNotFracture

Defines the chunk to be unfractureable. If this is true, then none of its children will be fractureable.

PxVec3 nvidia::apex::DestructibleChunkDesc::instancePositionOffset

Translation for this chunk mesh within the asset. Normally a chunk needs no translation, but if a chunk is instanced within the asset, then this translation is needed. Default = (0,0,0).

PxVec2 nvidia::apex::DestructibleChunkDesc::instanceUVOffset

UV translation for this chunk mesh within the asset. Normally a chunk needs no UV translation, but if a chunk is instanced within the asset, then this translation is usually needed. Default = (0,0).

bool nvidia::apex::DestructibleChunkDesc::isSupportChunk

Defines the chunk to be environmentally supported, if the appropriate DestructibleParametersFlag flags are set in DestructibleParameters.

uint16_t nvidia::apex::DestructibleChunkDesc::meshIndex

If useInstancedRendering = TRUE, this index is the instanced mesh index. If useInstancedRendering = FALSE, this index is the mesh part index for the skinned or statically rendered mesh. This must index a valid DestructibleGeometryDesc (see below). Default = 0xFFFF (invalid).

int32_t nvidia::apex::DestructibleChunkDesc::parentIndex

The parent index of this chunk. If the index is negative, this is a root chunk. Default = -1.

bool nvidia::apex::DestructibleChunkDesc::runtimeFracture

Defines the chunk to use run-time, dynamic fracturing. The chunk will use the fracture pattern provided by the asset to guide it's fracture. The resulting chunks will follow a similar process for subdivision.

uint32_t nvidia::apex::DestructibleChunkDesc::scatterMeshCount

The number of scatter mesh instances on this chunk. Default = 0.

const uint8_t* nvidia::apex::DestructibleChunkDesc::scatterMeshIndices

Array of indices corresponding the scatter mesh assets set using DestructibleAssetAuthoring::setScatterMeshAssets(). The array length must be at least scatterMeshCount. This pointer may be NULL if scatterMeshCount = 0. Default = NULL.

const PxMat44* nvidia::apex::DestructibleChunkDesc::scatterMeshTransforms

Array of chunk-relative transforms corresponding the scatter mesh assets set using DestructibleAssetAuthoring::setScatterMeshAssets(). The array length must be at least scatterMeshCount. This pointer may be NULL if scatterMeshCount = 0. Default = NULL.

PxVec3 nvidia::apex::DestructibleChunkDesc::surfaceNormal

A direction used to move the chunk out of the destructible, if an impact kick is applied.

bool nvidia::apex::DestructibleChunkDesc::useInstancedRendering

Whether or not to use instancing when rendering this chunk. If useInstancedRendering = TRUE, this chunk will share a draw call with all others that instance the mesh indexed by meshIndex. This may extend to other destructible actors created from this asset. If useInstancedRendering = FALSE, this chunk may share a draw call only with other chunks in this asset which have useInstancedRendering = FALSE. Default = FALSE.

---

The documentation for this class was generated from the following file:

• DestructibleAsset.h