---

       

---

PxHeightField.h

Go to the documentation of this file.

// 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) 2008-2018 NVIDIA Corporation. All rights reserved.
// Copyright (c) 2004-2008 AGEIA Technologies, Inc. All rights reserved.
// Copyright (c) 2001-2004 NovodeX AG. All rights reserved.


#ifndef PX_PHYSICS_GEOMUTILS_NX_HEIGHTFIELD
#define PX_PHYSICS_GEOMUTILS_NX_HEIGHTFIELD

#include "geometry/PxHeightFieldFlag.h"
#include "geometry/PxHeightFieldSample.h"
#include "common/PxBase.h"

#if !PX_DOXYGEN
namespace physx
{
#endif

class PxHeightFieldDesc;

class PxHeightField : public PxBase
{
    public:
    PX_PHYSX_COMMON_API virtual     void                        release() = 0;

    PX_PHYSX_COMMON_API virtual     PxU32                       saveCells(void* destBuffer, PxU32 destBufferSize) const = 0;

    PX_PHYSX_COMMON_API virtual     bool                        modifySamples(PxI32 startCol, PxI32 startRow, const PxHeightFieldDesc& subfieldDesc, bool shrinkBounds = false) = 0;

    PX_PHYSX_COMMON_API virtual     PxU32                       getNbRows()                 const = 0;

    PX_PHYSX_COMMON_API virtual     PxU32                       getNbColumns()              const = 0;

    PX_PHYSX_COMMON_API virtual     PxHeightFieldFormat::Enum   getFormat()                 const = 0;

    PX_PHYSX_COMMON_API virtual     PxU32                       getSampleStride()           const = 0;

    PX_PHYSX_COMMON_API virtual     PxReal                      getThickness()              const = 0;

    PX_PHYSX_COMMON_API virtual     PxReal                      getConvexEdgeThreshold()    const = 0;

    PX_PHYSX_COMMON_API virtual     PxHeightFieldFlags          getFlags()                  const = 0;

    PX_PHYSX_COMMON_API virtual     PxReal                      getHeight(PxReal x, PxReal z) const = 0;

    PX_PHYSX_COMMON_API virtual     PxU32                       getReferenceCount()         const   = 0;

    PX_PHYSX_COMMON_API virtual void                            acquireReference()                  = 0;

    PX_PHYSX_COMMON_API virtual PxMaterialTableIndex    getTriangleMaterialIndex(PxTriangleID triangleIndex) const = 0;

    PX_PHYSX_COMMON_API virtual PxVec3                  getTriangleNormal(PxTriangleID triangleIndex) const = 0;

    PX_PHYSX_COMMON_API virtual const PxHeightFieldSample&  getSample(PxU32 row, PxU32 column) const = 0;

    PX_PHYSX_COMMON_API virtual     PxU32                       getTimestamp()          const   = 0;

    PX_PHYSX_COMMON_API virtual const char*             getConcreteTypeName() const { return "PxHeightField"; }

protected:
                        PX_INLINE                       PxHeightField(PxType concreteType, PxBaseFlags baseFlags) : PxBase(concreteType, baseFlags) {}
                        PX_INLINE                       PxHeightField(PxBaseFlags baseFlags) : PxBase(baseFlags) {}
    PX_PHYSX_COMMON_API virtual                         ~PxHeightField() {}
    PX_PHYSX_COMMON_API virtual bool                    isKindOf(const char* name) const { return !::strcmp("PxHeightField", name) || PxBase::isKindOf(name); }
};

#if !PX_DOXYGEN
} // namespace physx
#endif

#endif

---

Copyright © 2008-2018 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com