PxHeightField.h
Go to the documentation of this file.
1 //
2 // Redistribution and use in source and binary forms, with or without
3 // modification, are permitted provided that the following conditions
4 // are met:
5 // * Redistributions of source code must retain the above copyright
6 // notice, this list of conditions and the following disclaimer.
7 // * Redistributions in binary form must reproduce the above copyright
8 // notice, this list of conditions and the following disclaimer in the
9 // documentation and/or other materials provided with the distribution.
10 // * Neither the name of NVIDIA CORPORATION nor the names of its
11 // contributors may be used to endorse or promote products derived
12 // from this software without specific prior written permission.
13 //
14 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY
15 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
18 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22 // OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 //
26 // Copyright (c) 2008-2018 NVIDIA Corporation. All rights reserved.
27 // Copyright (c) 2004-2008 AGEIA Technologies, Inc. All rights reserved.
28 // Copyright (c) 2001-2004 NovodeX AG. All rights reserved.
29 
30 
31 #ifndef PX_PHYSICS_GEOMUTILS_NX_HEIGHTFIELD
32 #define PX_PHYSICS_GEOMUTILS_NX_HEIGHTFIELD
33 
39 #include "common/PxBase.h"
40 
41 #if !PX_DOXYGEN
42 namespace physx
43 {
44 #endif
45 
46 class PxHeightFieldDesc;
47 
85 class PxHeightField : public PxBase
86 {
87  public:
93  PX_PHYSX_COMMON_API virtual void release() = 0;
94 
107  PX_PHYSX_COMMON_API virtual PxU32 saveCells(void* destBuffer, PxU32 destBufferSize) const = 0;
108 
129  PX_PHYSX_COMMON_API virtual bool modifySamples(PxI32 startCol, PxI32 startRow, const PxHeightFieldDesc& subfieldDesc, bool shrinkBounds = false) = 0;
130 
138  PX_PHYSX_COMMON_API virtual PxU32 getNbRows() const = 0;
139 
147  PX_PHYSX_COMMON_API virtual PxU32 getNbColumns() const = 0;
148 
156  PX_PHYSX_COMMON_API virtual PxHeightFieldFormat::Enum getFormat() const = 0;
157 
165  PX_PHYSX_COMMON_API virtual PxU32 getSampleStride() const = 0;
166 
174  PX_PHYSX_COMMON_API virtual PxReal getConvexEdgeThreshold() const = 0;
175 
183  PX_PHYSX_COMMON_API virtual PxHeightFieldFlags getFlags() const = 0;
184 
190  PX_PHYSX_COMMON_API virtual PxReal getHeight(PxReal x, PxReal z) const = 0;
191 
200  PX_PHYSX_COMMON_API virtual PxU32 getReferenceCount() const = 0;
201 
207  PX_PHYSX_COMMON_API virtual void acquireReference() = 0;
208 
217  PX_PHYSX_COMMON_API virtual PxMaterialTableIndex getTriangleMaterialIndex(PxTriangleID triangleIndex) const = 0;
218 
227  PX_PHYSX_COMMON_API virtual PxVec3 getTriangleNormal(PxTriangleID triangleIndex) const = 0;
228 
236  PX_PHYSX_COMMON_API virtual const PxHeightFieldSample& getSample(PxU32 row, PxU32 column) const = 0;
237 
246  PX_PHYSX_COMMON_API virtual PxU32 getTimestamp() const = 0;
247 
248  PX_PHYSX_COMMON_API virtual const char* getConcreteTypeName() const { return "PxHeightField"; }
249 
250 protected:
251  PX_INLINE PxHeightField(PxType concreteType, PxBaseFlags baseFlags) : PxBase(concreteType, baseFlags) {}
252  PX_INLINE PxHeightField(PxBaseFlags baseFlags) : PxBase(baseFlags) {}
254  PX_PHYSX_COMMON_API virtual bool isKindOf(const char* name) const { return !::strcmp("PxHeightField", name) || PxBase::isKindOf(name); }
255 };
256 
257 #if !PX_DOXYGEN
258 } // namespace physx
259 #endif
260 
262 #endif
Definition: GuContactBuffer.h:37
Enum
Definition: PxHeightFieldFlag.h:50
float PxReal
Definition: PxSimpleTypes.h:78
virtual bool isKindOf(const char *superClass) const
Returns whether a given type name matches with the type of this instance.
Definition: PxBase.h:178
virtual PX_PHYSX_COMMON_API bool isKindOf(const char *name) const
Returns whether a given type name matches with the type of this instance.
Definition: PxHeightField.h:254
Descriptor class for PxHeightField.
Definition: PxHeightFieldDesc.h:54
PxU16 PxType
Definition: PxBase.h:49
virtual PX_PHYSX_COMMON_API const char * getConcreteTypeName() const
Returns string name of dynamic type.
Definition: PxHeightField.h:248
PX_INLINE PxHeightField(PxType concreteType, PxBaseFlags baseFlags)
Definition: PxHeightField.h:251
PxU16 PxMaterialTableIndex
Definition: PxPhysXCommonConfig.h:117
A height field class.
Definition: PxHeightField.h:85
PX_INLINE PxHeightField(PxBaseFlags baseFlags)
Definition: PxHeightField.h:252
int32_t PxI32
Definition: PxSimpleTypes.h:70
Heightfield sample format.
Definition: PxHeightFieldSample.h:68
PxU32 PxTriangleID
Definition: PxPhysXCommonConfig.h:114
#define PX_PHYSX_COMMON_API
Definition: PxPhysXCommonConfig.h:97
uint32_t PxU32
Definition: Px.h:48
Base class for objects that can be members of a PxCollection.
Definition: PxBase.h:73
#define PX_INLINE
Definition: PxPreprocessor.h:349
virtual PX_PHYSX_COMMON_API ~PxHeightField()
Definition: PxHeightField.h:253
3 Element vector class.
Definition: PxVec3.h:49