include/geometry/PxHeightFieldDesc.h

File members: include/geometry/PxHeightFieldDesc.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-2023 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_DESC_H
#define PX_HEIGHTFIELD_DESC_H
#include "common/PxPhysXCommonConfig.h"
#include "geometry/PxHeightFieldFlag.h"
#include "common/PxCoreUtilityTypes.h"

#if !PX_DOXYGEN
namespace physx
{
#endif

class PxHeightFieldDesc
{
public:

    PxU32                           nbRows;

    PxU32                           nbColumns;

    PxHeightFieldFormat::Enum       format;

    PxStridedData                   samples;

    PxReal                  convexEdgeThreshold;

    PxHeightFieldFlags      flags;

    PX_INLINE               PxHeightFieldDesc();

    PX_INLINE       void    setToDefault();

    PX_INLINE       bool    isValid() const;
};

PX_INLINE PxHeightFieldDesc::PxHeightFieldDesc()    //constructor sets to default
{
    nbColumns                   = 0;
    nbRows                      = 0;
    format                      = PxHeightFieldFormat::eS16_TM;
    convexEdgeThreshold         = 0.0f;
    flags                       = PxHeightFieldFlags();
}

PX_INLINE void PxHeightFieldDesc::setToDefault()
{
    *this = PxHeightFieldDesc();
}

PX_INLINE bool PxHeightFieldDesc::isValid() const
{
    if (nbColumns < 2)
        return false;
    if (nbRows < 2)
        return false;
    if(format != PxHeightFieldFormat::eS16_TM)
        return false;
    if (samples.stride < 4)
        return false;
    if (convexEdgeThreshold < 0)
        return false;
    if ((flags & PxHeightFieldFlag::eNO_BOUNDARY_EDGES) != flags)
        return false;
    return true;
}

#if !PX_DOXYGEN
} // namespace physx
#endif

#endif