PxHeightField.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008-2015, NVIDIA CORPORATION.  All rights reserved.
 *
 * NVIDIA CORPORATION and its licensors retain all intellectual property
 * and proprietary rights in and to this software, 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.
 */
// 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 "common/PxBase.h"

#ifndef 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 PxMaterialTableIndex    getTriangleMaterialIndex(PxTriangleID triangleIndex) const = 0;

    PX_PHYSX_COMMON_API virtual PxVec3                  getTriangleNormal(PxTriangleID triangleIndex) 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); }
};

#ifndef PX_DOXYGEN
} // namespace physx
#endif

#endif