NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxHeightFieldDesc.h Source File

NVIDIA PhysX SDK 3.4 API

PxHeightFieldDesc.h

Go to the documentation of this file.
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-2017 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 "foundation/PxBounds3.h"
00038 #include "common/PxPhysXCommonConfig.h"
00039 #include "geometry/PxHeightFieldFlag.h"
00040 #include "common/PxCoreUtilityTypes.h"
00041 
00042 #if !PX_DOXYGEN
00043 namespace physx
00044 {
00045 #endif
00046 
00055 class PxHeightFieldDesc
00056 {
00057 public:
00058 
00067     PxU32                           nbRows;
00068 
00077     PxU32                           nbColumns;
00078 
00088     PxHeightFieldFormat::Enum       format;
00089 
00108     PxStridedData                   samples;
00109 
00127     PX_DEPRECATED PxReal                    thickness;
00128 
00143     PxReal                  convexEdgeThreshold;
00144 
00152     PxHeightFieldFlags      flags;
00153 
00157     PX_INLINE               PxHeightFieldDesc();
00158 
00162     PX_INLINE       void    setToDefault();
00163 
00168     PX_INLINE       bool    isValid() const;
00169 };
00170 
00171 PX_INLINE PxHeightFieldDesc::PxHeightFieldDesc()    //constructor sets to default
00172 {
00173     nbColumns                   = 0;
00174     nbRows                      = 0;
00175     format                      = PxHeightFieldFormat::eS16_TM;
00176     thickness                   = -1.0f;
00177     convexEdgeThreshold         = 0.0f;
00178     flags                       = PxHeightFieldFlags();
00179 }
00180 
00181 PX_INLINE void PxHeightFieldDesc::setToDefault()
00182 {
00183     *this = PxHeightFieldDesc();
00184 }
00185 
00186 PX_INLINE bool PxHeightFieldDesc::isValid() const
00187 {
00188     if (nbColumns < 2)
00189         return false;
00190     if (nbRows < 2)
00191         return false;
00192     if(format != PxHeightFieldFormat::eS16_TM)
00193         return false;
00194     if (samples.stride < 4)
00195         return false;
00196     if (convexEdgeThreshold < 0)
00197         return false;
00198     if ((flags & PxHeightFieldFlag::eNO_BOUNDARY_EDGES) != flags)
00199         return false;
00200     if (thickness < -PX_MAX_BOUNDS_EXTENTS || thickness > PX_MAX_BOUNDS_EXTENTS)
00201         return false;
00202     return true;
00203 }
00204 
00205 #if !PX_DOXYGEN
00206 } // namespace physx
00207 #endif
00208 
00210 #endif


Copyright © 2008-2017 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com