sdk/extensions/assetutils/include/NvBlastExtAssetUtils.h File Reference

#include "NvBlastTypes.h"
#include "NvCTypes.h"
#include <stdint.h>

Go to the source code of this file.

Classes
struct	NvBlastExtAssetUtilsBondDesc
Functions
void	NvBlastExtAssetTransformInPlace (NvBlastAsset *asset, const NvcVec3 *scale, const NvcQuat *rotation, const NvcVec3 *translation)
NvBlastAsset *	NvBlastExtAssetUtilsAddWorldBonds (const NvBlastAsset *asset, const uint32_t *worldBoundChunks, uint32_t worldBoundChunkCount, const NvcVec3 *bondDirections, const uint32_t *bondUserData)
NvBlastAssetDesc	NvBlastExtAssetUtilsMergeAssets (const NvBlastAsset **components, const NvcVec3 *scales, const NvcQuat *rotations, const NvcVec3 *translations, uint32_t componentCount, const NvBlastExtAssetUtilsBondDesc *newBondDescs, uint32_t newBondCount, uint32_t *chunkIndexOffsets, uint32_t *chunkReorderMap, uint32_t chunkReorderMapSize)

---

Function Documentation

void NvBlastExtAssetTransformInPlace	(	NvBlastAsset *	asset,
		const NvcVec3 *	scale,
		const NvcQuat *	rotation,
		const NvcVec3 *	translation
	)

Transforms asset in place using scale, rotation, transform. Chunk centroids, chunk bond centroids and bond normals are being transformed. Chunk volume and bond area are changed accordingly.

Parameters:

[in,out]	asset	Pointer to the asset to be transformed (modified).
[in]	scale	Pointer to scale to be applied. Can be nullptr.
[in]	rotation	Pointer to rotation to be applied. Can be nullptr.
[in]	translation	Pointer to translation to be applied. Can be nullptr.

NvBlastAsset* NvBlastExtAssetUtilsAddWorldBonds	(	const NvBlastAsset *	asset,
		const uint32_t *	worldBoundChunks,
		uint32_t	worldBoundChunkCount,
		const NvcVec3 *	bondDirections,
		const uint32_t *	bondUserData
	)

Reauthor the provided asset to bond the specified support chunks to the world.

Parameters:

[in]	asset	Pointer to the original asset. Won't be modified.
[in]	worldBoundChunks	Array of support chunk indices which are to be bound to the world.
[in]	worldBoundChunksCount	Size of worldBoundChunks array.
[in]	bondDirections	Array of normals for each bond (size worldBoundChunksCount)
[in]	bondUserData	Array of user data values for the new bonds, of size worldBoundChunksCount. May be NULL. If NULL, bond user data will be set to zero.

Returns:

a new asset with added bonds if successful, NULL otherwise.

NvBlastAssetDesc NvBlastExtAssetUtilsMergeAssets	(	const NvBlastAsset **	components,
		const NvcVec3 *	scales,
		const NvcQuat *	rotations,
		const NvcVec3 *	translations,
		uint32_t	componentCount,
		const NvBlastExtAssetUtilsBondDesc *	newBondDescs,
		uint32_t	newBondCount,
		uint32_t *	chunkIndexOffsets,
		uint32_t *	chunkReorderMap,
		uint32_t	chunkReorderMapSize
	)

Creates an asset descriptor which will build an asset that merges several assets. Each asset (or component) is given a transform, applied to the geometric information in the chunk and bond descriptors.

New bond descriptors may be given to bond support chunks from different components.

An NvBlastAsset may appear more than once in the components array.

This function will call NvBlastEnsureAssetExactSupportCoverage on the returned chunk descriptors. It will also call NvBlastReorderAssetDescChunks if the user passes in valid arrays for chunkReorderMap and chunkReorderMapSize. Otherwise, the user must ensure that the returned chunk descriptors are in a valid order is valid before using them.

NOTE: This function allocates memory using the allocator in NvBlastGlobals, to create the new chunk and bond descriptor arrays referenced in the returned NvBlastAssetDesc. The user must free this memory after use with NVBLAST_FREE appied to the pointers in the returned NvBlastAssetDesc.

Parameters:

[in]	components	An array of assets to merge, of size componentCount.
[in]	scales	An array of scales to apply to the geometric data in the chunks and bonds. If NULL, no scales are applied. If not NULL, the array must be of size componentCount.
[in]	rotations	An array of rotations to apply to the geometric data in the chunks and bonds, stored quaternion format. The quaternions MUST be normalized. If NULL, no rotations are applied. If not NULL, the array must be of size componentCount.
[in]	translations	An array of translations to apply to the geometric data in the chunks and bonds. If NULL, no translations are applied. If not NULL, the array must be of size componentCount.
[in]	componentCount	The size of the components and relativeTransforms arrays.
[in]	newBondDescs	Descriptors of type NvBlastExtAssetUtilsBondDesc for new bonds between components, of size newBondCount. If NULL, newBondCount must be 0.
[in]	newBondCount	The size of the newBondDescs array.
[in]	chunkIndexOffsets	If not NULL, must point to a uin32_t array of size componentCount. It will be filled with the starting elements in chunkReorderMap corresponding to each component.
[in]	chunkReorderMap	If not NULL, the returned descriptor is run through NvBlastReorderAssetDescChunks, to ensure that it is a valid asset descriptor. In the process, chunks may be reordered (in addition to their natural re-indexing due to them all being placed in one array). To map from the old chunk indexing for the various component assets to the chunk indexing used in the returned descriptor, set chunkReorderMap to point to a uin32_t array of size equal to the total number of chunks in all components, and pass in a non-NULL value to chunkIndexOffsets as described above. Then, for component index c and chunk index k within that component, the new chunk index is given by: index = chunkReorderMap[ k + chunkIndexOffsets[c] ].
[in]	chunkReorderMapSize	The size of the array passed into chunkReorderMap, if chunkReorderMap is not NULL. This is for safety, so that this function does not overwrite chunkReorderMap.

Returns:

an asset descriptor that will build an asset which merges the components, using NvBlastCreateAsset.