NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxHeightField.h Source File

00001 // This code contains NVIDIA Confidential Information and is disclosed to you
+00002 // under a form of NVIDIA software license agreement provided separately to you.
+00003 //
+00004 // Notice
+00005 // NVIDIA Corporation and its licensors retain all intellectual property and
+00006 // proprietary rights in and to this software and related documentation and
+00007 // any modifications thereto. Any use, reproduction, disclosure, or
+00008 // distribution of this software and related documentation without an express
+00009 // license agreement from NVIDIA Corporation is strictly prohibited.
+00010 //
+00011 // ALL NVIDIA DESIGN SPECIFICATIONS, CODE ARE PROVIDED "AS IS.". NVIDIA MAKES
+00012 // NO WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO
+00013 // THE MATERIALS, AND EXPRESSLY DISCLAIMS ALL IMPLIED WARRANTIES OF NONINFRINGEMENT,
+00014 // MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE.
+00015 //
+00016 // Information and code furnished is believed to be accurate and reliable.
+00017 // However, NVIDIA Corporation assumes no responsibility for the consequences of use of such
+00018 // information or for any infringement of patents or other rights of third parties that may
+00019 // result from its use. No license is granted by implication or otherwise under any patent
+00020 // or patent rights of NVIDIA Corporation. Details are subject to change without notice.
+00021 // This code supersedes and replaces all information previously supplied.
+00022 // NVIDIA Corporation products are not authorized for use as critical
+00023 // components in life support devices or systems without express written approval of
+00024 // NVIDIA Corporation.
+00025 //
+00026 // Copyright (c) 2008-2016 NVIDIA Corporation. All rights reserved.
+00027 // Copyright (c) 2004-2008 AGEIA Technologies, Inc. All rights reserved.
+00028 // Copyright (c) 2001-2004 NovodeX AG. All rights reserved.
+00029 
+00030 
+00031 #ifndef PX_PHYSICS_GEOMUTILS_NX_HEIGHTFIELD
+00032 #define PX_PHYSICS_GEOMUTILS_NX_HEIGHTFIELD
+00033 
+00037 #include "geometry/PxHeightFieldFlag.h"
+00038 #include "common/PxBase.h"
+00039 
+00040 #if !PX_DOXYGEN
+00041 namespace physx
+00042 {
+00043 #endif
+00044 
+00045 class PxHeightFieldDesc;
+00046 
+00084 class PxHeightField : public PxBase
+00085 {
+00086     public:
+00092     PX_PHYSX_COMMON_API virtual     void                        release() = 0;
+00093 
+00106     PX_PHYSX_COMMON_API virtual     PxU32                       saveCells(void* destBuffer, PxU32 destBufferSize) const = 0;
+00107 
+00128     PX_PHYSX_COMMON_API virtual     bool                        modifySamples(PxI32 startCol, PxI32 startRow, const PxHeightFieldDesc& subfieldDesc, bool shrinkBounds = false) = 0;
+00129 
+00137     PX_PHYSX_COMMON_API virtual     PxU32                       getNbRows()                 const = 0;
+00138 
+00146     PX_PHYSX_COMMON_API virtual     PxU32                       getNbColumns()              const = 0;
+00147 
+00155     PX_PHYSX_COMMON_API virtual     PxHeightFieldFormat::Enum   getFormat()                 const = 0;
+00156 
+00164     PX_PHYSX_COMMON_API virtual     PxU32                       getSampleStride()           const = 0;
+00165 
+00173     PX_PHYSX_COMMON_API virtual     PxReal                      getThickness()              const = 0;
+00174 
+00182     PX_PHYSX_COMMON_API virtual     PxReal                      getConvexEdgeThreshold()    const = 0;
+00183 
+00191     PX_PHYSX_COMMON_API virtual     PxHeightFieldFlags          getFlags()                  const = 0;
+00192 
+00198     PX_PHYSX_COMMON_API virtual     PxReal                      getHeight(PxReal x, PxReal z) const = 0;
+00199 
+00208     PX_PHYSX_COMMON_API virtual     PxU32                       getReferenceCount()         const   = 0;
+00209 
+00215     PX_PHYSX_COMMON_API virtual void                            acquireReference()                  = 0;
+00216 
+00225     PX_PHYSX_COMMON_API virtual PxMaterialTableIndex    getTriangleMaterialIndex(PxTriangleID triangleIndex) const = 0;
+00226 
+00235     PX_PHYSX_COMMON_API virtual PxVec3                  getTriangleNormal(PxTriangleID triangleIndex) const = 0;
+00236 
+00245     PX_PHYSX_COMMON_API virtual     PxU32                       getTimestamp()          const   = 0;
+00246 
+00247     PX_PHYSX_COMMON_API virtual const char*             getConcreteTypeName() const { return "PxHeightField"; }
+00248 
+00249 protected:
+00250                         PX_INLINE                       PxHeightField(PxType concreteType, PxBaseFlags baseFlags) : PxBase(concreteType, baseFlags) {}
+00251                         PX_INLINE                       PxHeightField(PxBaseFlags baseFlags) : PxBase(baseFlags) {}
+00252     PX_PHYSX_COMMON_API virtual                         ~PxHeightField() {}
+00253     PX_PHYSX_COMMON_API virtual bool                    isKindOf(const char* name) const { return !::strcmp("PxHeightField", name) || PxBase::isKindOf(name); }
+00254 };
+00255 
+00256 #if !PX_DOXYGEN
+00257 } // namespace physx
+00258 #endif
+00259 
+00261 #endif
+