PxHeightFieldGeometry.h
Go to the documentation of this file.
1 //
2 // Redistribution and use in source and binary forms, with or without
3 // modification, are permitted provided that the following conditions
4 // are met:
5 // * Redistributions of source code must retain the above copyright
6 // notice, this list of conditions and the following disclaimer.
7 // * Redistributions in binary form must reproduce the above copyright
8 // notice, this list of conditions and the following disclaimer in the
9 // documentation and/or other materials provided with the distribution.
10 // * Neither the name of NVIDIA CORPORATION nor the names of its
11 // contributors may be used to endorse or promote products derived
12 // from this software without specific prior written permission.
13 //
14 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY
15 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
18 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22 // OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 //
26 // Copyright (c) 2008-2018 NVIDIA Corporation. All rights reserved.
27 // Copyright (c) 2004-2008 AGEIA Technologies, Inc. All rights reserved.
28 // Copyright (c) 2001-2004 NovodeX AG. All rights reserved.
29 
30 
31 #ifndef PX_PHYSICS_NX_HEIGHTFIELD_GEOMETRY
32 #define PX_PHYSICS_NX_HEIGHTFIELD_GEOMETRY
33 
38 
39 #if !PX_DOXYGEN
40 namespace physx
41 {
42 #endif
43 
44 #define PX_MIN_HEIGHTFIELD_XZ_SCALE 1e-8f
45 #define PX_MIN_HEIGHTFIELD_Y_SCALE (0.0001f / PxReal(0xFFFF))
46 
47 class PxHeightField;
48 
57 {
58 public:
60  PxGeometry (PxGeometryType::eHEIGHTFIELD),
61  heightField (NULL),
62  heightScale (1.0f),
63  rowScale (1.0f),
64  columnScale (1.0f),
65  heightFieldFlags(0)
66  {}
67 
70  PxReal heightScale_,
71  PxReal rowScale_,
72  PxReal columnScale_) :
73  PxGeometry (PxGeometryType::eHEIGHTFIELD),
74  heightField (hf) ,
75  heightScale (heightScale_),
76  rowScale (rowScale_),
77  columnScale (columnScale_),
78  heightFieldFlags (flags)
79  {
80  }
81 
92  PX_INLINE bool isValid() const;
93 
94 public:
99 
104 
109 
114 
119 
121 };
122 
123 
125 {
126  if (mType != PxGeometryType::eHEIGHTFIELD)
127  return false;
128  if (!PxIsFinite(heightScale) || !PxIsFinite(rowScale) || !PxIsFinite(columnScale))
129  return false;
130  if (rowScale < PX_MIN_HEIGHTFIELD_XZ_SCALE || columnScale < PX_MIN_HEIGHTFIELD_XZ_SCALE || heightScale < PX_MIN_HEIGHTFIELD_Y_SCALE)
131  return false;
132  if (!heightField)
133  return false;
134 
135  return true;
136 }
137 
138 #if !PX_DOXYGEN
139 } // namespace physx
140 #endif
141 
143 #endif
Definition: GuContactBuffer.h:37
A geometry type.
Definition: PxGeometry.h:51
float PxReal
Definition: PxSimpleTypes.h:78
Definition: PxGeometry.h:61
PxMeshGeometryFlags heightFieldFlags
Flags to specify some collision properties for the height field.
Definition: PxHeightFieldGeometry.h:118
A geometry object.
Definition: PxGeometry.h:75
Height field geometry class.
Definition: PxHeightFieldGeometry.h:56
A height field class.
Definition: PxHeightField.h:85
PxU16 flags
a set of Px1DConstraintFlags
Definition: PxConstraintDesc.h:110
PxPadding< 3 > paddingFromFlags
padding for mesh flags.
Definition: PxHeightFieldGeometry.h:120
PX_INLINE PxHeightFieldGeometry()
Definition: PxHeightFieldGeometry.h:59
PX_INLINE PxHeightFieldGeometry(PxHeightField *hf, PxMeshGeometryFlags flags, PxReal heightScale_, PxReal rowScale_, PxReal columnScale_)
Definition: PxHeightFieldGeometry.h:68
PxReal columnScale
The scaling factor for the height field in the column direction (z direction in local space)...
Definition: PxHeightFieldGeometry.h:113
PxHeightField * heightField
The height field data.
Definition: PxHeightFieldGeometry.h:98
#define PX_MIN_HEIGHTFIELD_Y_SCALE
Definition: PxHeightFieldGeometry.h:45
PX_INLINE bool isValid() const
Returns true if the geometry is valid.
Definition: PxHeightFieldGeometry.h:124
PxReal rowScale
The scaling factor for the height field in the row direction (x direction in local space)...
Definition: PxHeightFieldGeometry.h:108
PX_CUDA_CALLABLE PX_FORCE_INLINE bool PxIsFinite(float f)
returns true if the passed number is a finite floating point number as opposed to INF...
Definition: PxMath.h:292
PX_FORCE_INLINE PxHeightFieldGeometry & heightField()
Definition: PxGeometryHelpers.h:163
#define PX_MIN_HEIGHTFIELD_XZ_SCALE
Definition: PxHeightFieldGeometry.h:44
PxReal heightScale
The scaling factor for the height field in vertical direction (y direction in local space)...
Definition: PxHeightFieldGeometry.h:103
#define PX_INLINE
Definition: PxPreprocessor.h:349