PxHeightFieldDesc.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_COLLISION_NXHEIGHTFIELDDESC
#define PX_COLLISION_NXHEIGHTFIELDDESC

#include "foundation/PxBounds3.h"
#include "common/PxPhysXCommonConfig.h"
#include "geometry/PxHeightFieldFlag.h"
#include "common/PxCoreUtilityTypes.h"

#ifndef PX_DOXYGEN
namespace physx
{
#endif

class PxHeightFieldDesc
{
public:

    PxU32                           nbRows;

    PxU32                           nbColumns;

    PxHeightFieldFormat::Enum       format;

    PxStridedData                   samples;

    PxReal                  thickness;

    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;
    thickness                   = -1.0f;
    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;
    switch (format)
    {
    case PxHeightFieldFormat::eS16_TM:
        if (samples.stride < 4)
            return false;
        break;
    default:
        return false;
    }
    if (convexEdgeThreshold < 0)
        return false;
    if ((flags & PxHeightFieldFlag::eNO_BOUNDARY_EDGES) != flags)
        return false;
    if (thickness < -PX_MAX_BOUNDS_EXTENTS || thickness > PX_MAX_BOUNDS_EXTENTS)
        return false;
    return true;
}

#ifndef PX_DOXYGEN
} // namespace physx
#endif

#endif