00001 // This code contains NVIDIA Confidential Information and is disclosed to you 
00002 // under a form of NVIDIA software license agreement provided separately to you.
00003 //
00004 // Notice
00005 // NVIDIA Corporation and its licensors retain all intellectual property and
00006 // proprietary rights in and to this software and related documentation and 
00007 // any modifications thereto. Any use, reproduction, disclosure, or 
00008 // distribution of this software and related documentation without an express 
00009 // license agreement from NVIDIA Corporation is strictly prohibited.
00010 // 
00011 // ALL NVIDIA DESIGN SPECIFICATIONS, CODE ARE PROVIDED "AS IS.". NVIDIA MAKES
00012 // NO WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO
00013 // THE MATERIALS, AND EXPRESSLY DISCLAIMS ALL IMPLIED WARRANTIES OF NONINFRINGEMENT,
00014 // MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE.
00015 //
00016 // Information and code furnished is believed to be accurate and reliable.
00017 // However, NVIDIA Corporation assumes no responsibility for the consequences of use of such
00018 // information or for any infringement of patents or other rights of third parties that may
00019 // result from its use. No license is granted by implication or otherwise under any patent
00020 // or patent rights of NVIDIA Corporation. Details are subject to change without notice.
00021 // This code supersedes and replaces all information previously supplied.
00022 // NVIDIA Corporation products are not authorized for use as critical
00023 // components in life support devices or systems without express written approval of
00024 // NVIDIA Corporation.
00025 //
00026 // Copyright (c) 2008-2012 NVIDIA Corporation. All rights reserved.
00027 // Copyright (c) 2004-2008 AGEIA Technologies, Inc. All rights reserved.
00028 // Copyright (c) 2001-2004 NovodeX AG. All rights reserved.  
00029 
00030 
00031 #ifndef PX_COLLISION_NXHEIGHTFIELDDESC
00032 #define PX_COLLISION_NXHEIGHTFIELDDESC
00033 
00037 #include "common/PxPhysXCommon.h"
00038 #include "geometry/PxHeightFieldFlag.h"
00039 #include "common/PxCoreUtilityTypes.h"
00040 
00041 #ifndef PX_DOXYGEN
00042 namespace physx
00043 {
00044 #endif
00045 
00054 class PxHeightFieldDesc
00055 {
00056 public:
00057 
00064     PxU32                           nbRows;
00065 
00072     PxU32                           nbColumns;
00073 
00083     PxHeightFieldFormat::Enum       format;
00084     
00103     PxStridedData                   samples;
00104 
00120     PxReal                  thickness;
00121 
00136     PxReal                  convexEdgeThreshold;
00137 
00145     PxHeightFieldFlags      flags;
00146 
00150     PX_INLINE               PxHeightFieldDesc();
00151 
00155     PX_INLINE       void    setToDefault();
00156 
00161     PX_INLINE       bool    isValid() const;
00162 };
00163 
00164 PX_INLINE PxHeightFieldDesc::PxHeightFieldDesc()    //constructor sets to default
00165 {
00166     nbColumns                   = 0;
00167     nbRows                      = 0;
00168     format                      = PxHeightFieldFormat::eS16_TM;
00169     thickness                   = -1.0f;
00170     convexEdgeThreshold         = 0.0f;
00171     flags                       = PxHeightFieldFlags();
00172 }
00173 
00174 PX_INLINE void PxHeightFieldDesc::setToDefault()
00175 {
00176     *this = PxHeightFieldDesc();
00177 }
00178 
00179 PX_INLINE bool PxHeightFieldDesc::isValid() const
00180 {
00181     if (nbColumns < 2) return false;
00182     if (nbRows < 2) return false;
00183     switch (format)
00184     {
00185     case PxHeightFieldFormat::eS16_TM:
00186         if (samples.stride < 4) return false;
00187         break;
00188     default:
00189         return false;
00190     }
00191     if (convexEdgeThreshold < 0) return false;
00192     if ((flags & PxHeightFieldFlag::eNO_BOUNDARY_EDGES) != flags) return false;
00193     return true;
00194 }
00195 
00196 #ifndef PX_DOXYGEN
00197 } // namespace physx
00198 #endif
00199 
00201 #endif