include/geometry/PxHeightField.h

File members: include/geometry/PxHeightField.h

// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
//  * Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//  * Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//  * Neither the name of NVIDIA CORPORATION nor the names of its
//    contributors may be used to endorse or promote products derived
//    from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ''AS IS'' AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
// OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Copyright (c) 2008-2024 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_HEIGHTFIELD_H
#define PX_HEIGHTFIELD_H

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

#if !PX_DOXYGEN
namespace physx
{
#endif

class PxHeightFieldDesc;

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

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

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

    virtual     PxU32   getNbRows() const = 0;

    virtual     PxU32   getNbColumns()  const = 0;

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

    virtual     PxU32   getSampleStride()   const = 0;

    virtual     PxReal  getConvexEdgeThreshold()    const = 0;

    virtual     PxHeightFieldFlags  getFlags()  const = 0;

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

    virtual PxMaterialTableIndex    getTriangleMaterialIndex(PxTriangleID triangleIndex) const = 0;

    virtual PxVec3  getTriangleNormal(PxTriangleID triangleIndex) const = 0;

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

    virtual     PxU32   getTimestamp()  const   = 0;

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

protected:
    PX_INLINE           PxHeightField(PxType concreteType, PxBaseFlags baseFlags) : PxRefCounted(concreteType, baseFlags) {}
    PX_INLINE           PxHeightField(PxBaseFlags baseFlags) : PxRefCounted(baseFlags) {}
    virtual             ~PxHeightField() {}
    virtual bool        isKindOf(const char* name) const { PX_IS_KIND_OF(name, "PxHeightField", PxRefCounted); }
};

#if !PX_DOXYGEN
} // namespace physx
#endif

#endif