diff options
| author | Bryan Galdrikian <[email protected]> | 2018-05-31 11:36:08 -0700 |
|---|---|---|
| committer | Bryan Galdrikian <[email protected]> | 2018-05-31 11:36:08 -0700 |
| commit | 7115f60b91b5717d90f643fd692010905c7004db (patch) | |
| tree | effd68c6978751c517d54c2f2bb5bb6e7dc93e18 /sdk/toolkit/include/NvBlastTkAsset.h | |
| parent | Updating BlastTool zip (diff) | |
| download | blast-7115f60b91b5717d90f643fd692010905c7004db.tar.xz blast-7115f60b91b5717d90f643fd692010905c7004db.zip | |
Blast 1.1.3. See docs/release_notes.txt.v1.1.3_rc1
Diffstat (limited to 'sdk/toolkit/include/NvBlastTkAsset.h')
| -rwxr-xr-x[-rw-r--r--] | sdk/toolkit/include/NvBlastTkAsset.h | 308 |
1 files changed, 154 insertions, 154 deletions
diff --git a/sdk/toolkit/include/NvBlastTkAsset.h b/sdk/toolkit/include/NvBlastTkAsset.h index 4a4f5be..f965e09 100644..100755 --- a/sdk/toolkit/include/NvBlastTkAsset.h +++ b/sdk/toolkit/include/NvBlastTkAsset.h @@ -1,154 +1,154 @@ -// This code contains NVIDIA Confidential Information and is disclosed to you -// under a form of NVIDIA software license agreement provided separately to you. -// -// Notice -// NVIDIA Corporation and its licensors retain all intellectual property and -// proprietary rights in and to this software and related documentation and -// any modifications thereto. Any use, reproduction, disclosure, or -// distribution of this software and related documentation without an express -// license agreement from NVIDIA Corporation is strictly prohibited. -// -// ALL NVIDIA DESIGN SPECIFICATIONS, CODE ARE PROVIDED "AS IS.". NVIDIA MAKES -// NO WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO -// THE MATERIALS, AND EXPRESSLY DISCLAIMS ALL IMPLIED WARRANTIES OF NONINFRINGEMENT, -// MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE. -// -// Information and code furnished is believed to be accurate and reliable. -// However, NVIDIA Corporation assumes no responsibility for the consequences of use of such -// information or for any infringement of patents or other rights of third parties that may -// result from its use. No license is granted by implication or otherwise under any patent -// or patent rights of NVIDIA Corporation. Details are subject to change without notice. -// This code supersedes and replaces all information previously supplied. -// NVIDIA Corporation products are not authorized for use as critical -// components in life support devices or systems without express written approval of -// NVIDIA Corporation. -// -// Copyright (c) 2016-2018 NVIDIA Corporation. All rights reserved. - - -#ifndef NVBLASTTKASSET_H -#define NVBLASTTKASSET_H - -#include "NvBlastTkIdentifiable.h" -#include "NvBlastTypes.h" -#include "PxVec3.h" - -// Forward declarations -struct NvBlastAsset; - - -namespace Nv -{ -namespace Blast -{ - -/** -A descriptor stored by a TkAsset for an internal joint. Internal joints are created when a TkAsset is instanced into a TkActor. -*/ -struct TkAssetJointDesc -{ - uint32_t nodeIndices[2]; //!< The graph node indices corresponding to the support chunks joined by a joint - physx::PxVec3 attachPositions[2]; //!< The joint's attachment positions in asset-local space -}; - - -/** -The static data associated with a destructible actor. TkAsset encapsulates an NvBlastAsset. In addition to the NvBlastAsset, -the TkAsset stores joint descriptors (see TkAssetJointDesc). -*/ -class TkAsset : public TkIdentifiable -{ -public: - /** - Access to underlying low-level asset. - - \return a pointer to the (const) low-level NvBlastAsset object. - */ - virtual const NvBlastAsset* getAssetLL() const = 0; - - /** - Get the number of chunks in this asset. - - NOTE: Wrapper function over low-level function call, see NvBlastAssetGetChunkCount for details. - - \return the number of chunks in the asset. - */ - virtual uint32_t getChunkCount() const = 0; - - /** - Get the number of leaf chunks in the given asset. - - NOTE: Wrapper function over low-level function call, see NvBlastAssetGetLeafChunkCount for details. - - \return the number of leaf chunks in the asset. - */ - virtual uint32_t getLeafChunkCount() const = 0; - - /** - Get the number of bonds in the given asset. - - NOTE: Wrapper function over low-level function call, see NvBlastAssetGetBondCount for details. - - \return the number of bonds in the asset. - */ - virtual uint32_t getBondCount() const = 0; - - /** - Access an array of chunks of the given asset. - - NOTE: Wrapper function over low-level function call, see NvBlastAssetGetChunks for details. - - \return a pointer to an array of chunks of the asset. - */ - virtual const NvBlastChunk* getChunks() const = 0; - - /** - Access an array of bonds of the given asset. - - NOTE: Wrapper function over low-level function call, see NvBlastAssetGetBonds for details. - - \return a pointer to an array of bonds of the asset. - */ - virtual const NvBlastBond* getBonds() const = 0; - - /** - Access an support graph for the given asset. - - NOTE: Wrapper function over low-level function call, see NvBlastAssetGetSupportGraph for details. - - \return a struct of support graph for the given asset. - */ - virtual const NvBlastSupportGraph getGraph() const = 0; - - /** - Retrieve the size (in bytes) of the LL asset. - - NOTE: Wrapper function over low-level function call, see NvBlastAssetGetSize for details. - - \return the size of the data block (in bytes). - */ - virtual uint32_t getDataSize() const = 0; - - /** - The number of internal TkJoint objects that will be created when this asset is instanced into a TkActor - (see TkFramework::createActor). These joints will not trigger TkJointUpdateEvent events - until this actor is split into actors such that a joint connects two actors. At this time the actor's family - will dispatch a TkJointUpdateEvent::External event during a call to TkGroup::endProcess() (see TkGroup). - - \return the number of descriptors for internal joints. - */ - virtual uint32_t getJointDescCount() const = 0; - - /** - The descriptors for the internal joints created when this asset is instanced. (See getJointDescCount.) - - \return a pointer to the array of descriptors for internal joints. - */ - virtual const TkAssetJointDesc* getJointDescs() const = 0; -}; - -} // namespace Blast -} // namespace Nv - - -#endif // ifndef NVBLASTTKASSET_H +// This code contains NVIDIA Confidential Information and is disclosed to you
+// under a form of NVIDIA software license agreement provided separately to you.
+//
+// Notice
+// NVIDIA Corporation and its licensors retain all intellectual property and
+// proprietary rights in and to this software and related documentation and
+// any modifications thereto. Any use, reproduction, disclosure, or
+// distribution of this software and related documentation without an express
+// license agreement from NVIDIA Corporation is strictly prohibited.
+//
+// ALL NVIDIA DESIGN SPECIFICATIONS, CODE ARE PROVIDED "AS IS.". NVIDIA MAKES
+// NO WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO
+// THE MATERIALS, AND EXPRESSLY DISCLAIMS ALL IMPLIED WARRANTIES OF NONINFRINGEMENT,
+// MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE.
+//
+// Information and code furnished is believed to be accurate and reliable.
+// However, NVIDIA Corporation assumes no responsibility for the consequences of use of such
+// information or for any infringement of patents or other rights of third parties that may
+// result from its use. No license is granted by implication or otherwise under any patent
+// or patent rights of NVIDIA Corporation. Details are subject to change without notice.
+// This code supersedes and replaces all information previously supplied.
+// NVIDIA Corporation products are not authorized for use as critical
+// components in life support devices or systems without express written approval of
+// NVIDIA Corporation.
+//
+// Copyright (c) 2016-2018 NVIDIA Corporation. All rights reserved.
+
+
+#ifndef NVBLASTTKASSET_H
+#define NVBLASTTKASSET_H
+
+#include "NvBlastTkIdentifiable.h"
+#include "NvBlastTypes.h"
+#include "PxVec3.h"
+
+// Forward declarations
+struct NvBlastAsset;
+
+
+namespace Nv
+{
+namespace Blast
+{
+
+/**
+A descriptor stored by a TkAsset for an internal joint. Internal joints are created when a TkAsset is instanced into a TkActor.
+*/
+struct TkAssetJointDesc
+{
+ uint32_t nodeIndices[2]; //!< The graph node indices corresponding to the support chunks joined by a joint
+ physx::PxVec3 attachPositions[2]; //!< The joint's attachment positions in asset-local space
+};
+
+
+/**
+The static data associated with a destructible actor. TkAsset encapsulates an NvBlastAsset. In addition to the NvBlastAsset,
+the TkAsset stores joint descriptors (see TkAssetJointDesc).
+*/
+class TkAsset : public TkIdentifiable
+{
+public:
+ /**
+ Access to underlying low-level asset.
+
+ \return a pointer to the (const) low-level NvBlastAsset object.
+ */
+ virtual const NvBlastAsset* getAssetLL() const = 0;
+
+ /**
+ Get the number of chunks in this asset.
+
+ NOTE: Wrapper function over low-level function call, see NvBlastAssetGetChunkCount for details.
+
+ \return the number of chunks in the asset.
+ */
+ virtual uint32_t getChunkCount() const = 0;
+
+ /**
+ Get the number of leaf chunks in the given asset.
+
+ NOTE: Wrapper function over low-level function call, see NvBlastAssetGetLeafChunkCount for details.
+
+ \return the number of leaf chunks in the asset.
+ */
+ virtual uint32_t getLeafChunkCount() const = 0;
+
+ /**
+ Get the number of bonds in the given asset.
+
+ NOTE: Wrapper function over low-level function call, see NvBlastAssetGetBondCount for details.
+
+ \return the number of bonds in the asset.
+ */
+ virtual uint32_t getBondCount() const = 0;
+
+ /**
+ Access an array of chunks of the given asset.
+
+ NOTE: Wrapper function over low-level function call, see NvBlastAssetGetChunks for details.
+
+ \return a pointer to an array of chunks of the asset.
+ */
+ virtual const NvBlastChunk* getChunks() const = 0;
+
+ /**
+ Access an array of bonds of the given asset.
+
+ NOTE: Wrapper function over low-level function call, see NvBlastAssetGetBonds for details.
+
+ \return a pointer to an array of bonds of the asset.
+ */
+ virtual const NvBlastBond* getBonds() const = 0;
+
+ /**
+ Access an support graph for the given asset.
+
+ NOTE: Wrapper function over low-level function call, see NvBlastAssetGetSupportGraph for details.
+
+ \return a struct of support graph for the given asset.
+ */
+ virtual const NvBlastSupportGraph getGraph() const = 0;
+
+ /**
+ Retrieve the size (in bytes) of the LL asset.
+
+ NOTE: Wrapper function over low-level function call, see NvBlastAssetGetSize for details.
+
+ \return the size of the data block (in bytes).
+ */
+ virtual uint32_t getDataSize() const = 0;
+
+ /**
+ The number of internal TkJoint objects that will be created when this asset is instanced into a TkActor
+ (see TkFramework::createActor). These joints will not trigger TkJointUpdateEvent events
+ until this actor is split into actors such that a joint connects two actors. At this time the actor's family
+ will dispatch a TkJointUpdateEvent::External event during a call to TkGroup::endProcess() (see TkGroup).
+
+ \return the number of descriptors for internal joints.
+ */
+ virtual uint32_t getJointDescCount() const = 0;
+
+ /**
+ The descriptors for the internal joints created when this asset is instanced. (See getJointDescCount.)
+
+ \return a pointer to the array of descriptors for internal joints.
+ */
+ virtual const TkAssetJointDesc* getJointDescs() const = 0;
+};
+
+} // namespace Blast
+} // namespace Nv
+
+
+#endif // ifndef NVBLASTTKASSET_H
|