From 3dfe2108cfab31ba3ee5527e217d0d8e99a51162 Mon Sep 17 00:00:00 2001 From: git perforce import user Date: Tue, 25 Oct 2016 12:29:14 -0600 Subject: Initial commit: PhysX 3.4.0 Update @ 21294896 APEX 1.4.0 Update @ 21275617 [CL 21300167] --- .../PhysXAPI/files/classPxMeshScale.html | 391 +++++++++++++++++++++ 1 file changed, 391 insertions(+) create mode 100644 PhysX_3.4/Documentation/PhysXAPI/files/classPxMeshScale.html (limited to 'PhysX_3.4/Documentation/PhysXAPI/files/classPxMeshScale.html') diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/classPxMeshScale.html b/PhysX_3.4/Documentation/PhysXAPI/files/classPxMeshScale.html new file mode 100644 index 00000000..1099cedc --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/classPxMeshScale.html @@ -0,0 +1,391 @@ + + + NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxMeshScale Class Reference + + + + + + + +
+

PxMeshScale Class Reference
+ +[Geomutils] +

A class expressing a nonuniform scaling transformation. +More... +

+#include <PxMeshScale.h> +

+

+Collaboration diagram for PxMeshScale:
+
+

Collaboration graph
+ +PxVec3PxQuat +
[legend]
+ +

+List of all members. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Member Functions

PX_CUDA_CALLABLE PX_FORCE_INLINE PxMeshScale ()
 Constructor initializes to identity scale.
PX_CUDA_CALLABLE PX_FORCE_INLINE PxMeshScale (PxReal r)
 Constructor from scalar.
PX_CUDA_CALLABLE PX_FORCE_INLINE PxMeshScale (const PxVec3 &s)
 Constructor to initialize to arbitrary scale and identity scale rotation.
PX_CUDA_CALLABLE PX_FORCE_INLINE PxMeshScale (const PxVec3 &s, const PxQuat &r)
 Constructor to initialize to arbitrary scaling.
PX_CUDA_CALLABLE
+PX_FORCE_INLINE bool 		isIdentity () const
 Returns true if the scaling is an identity transformation.
PX_CUDA_CALLABLE
+PX_FORCE_INLINE PxMeshScale 		getInverse () const
 Returns the inverse of this scaling transformation.
PX_CUDA_CALLABLE
+PX_FORCE_INLINE PxMat33 		toMat33 () const
 Converts this transformation to a 3x3 matrix representation.
PX_CUDA_CALLABLE
+PX_FORCE_INLINE bool 		hasNegativeDeterminant () const
 Returns true if combination of negative scale components will cause the triangle normal to flip. The SDK will flip the normals internally.
PxVec3 transform (const PxVec3 &v) const
bool isValidForTriangleMesh () const
bool isValidForConvexMesh () const

Public Attributes

PxVec3 scale
 A nonuniform scaling.
PxQuat rotation
 The orientation of the scaling axes.
+

Detailed Description

+A class expressing a nonuniform scaling transformation. +

+The scaling is along arbitrary axes that are specified by PxMeshScale::rotation.

+

Note:
Negative scale values are supported for PxTriangleMeshGeometry with absolute values for each component within [PX_MIN_ABS_MESH_SCALE, PX_MAX_ABS_MESH_SCALE] range. Negative scale causes a reflection around the specified axis, in addition PhysX will flip the normals for mesh triangles when scale.x*scale.y*scale.z < 0.

+Only positive scale values are supported for PxConvexMeshGeometry with values for each component within [PX_MIN_ABS_MESH_SCALE, PX_MAX_ABS_MESH_SCALE] range).

+
See also:
PxConvexMeshGeometry PxTriangleMeshGeometry
+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + +
PX_CUDA_CALLABLE PX_FORCE_INLINE PxMeshScale::PxMeshScale (  )  [inline]
+
+
+ +

+Constructor initializes to identity scale. +

+ +

+

+ +

+
+ + + + + + + + + +
PX_CUDA_CALLABLE PX_FORCE_INLINE PxMeshScale::PxMeshScale (PxReal  r  )  [inline, explicit]
+
+
+ +

+Constructor from scalar. +

+ +

+

+ +

+
+ + + + + + + + + +
PX_CUDA_CALLABLE PX_FORCE_INLINE PxMeshScale::PxMeshScale (const PxVec3 &  s  )  [inline]
+
+
+ +

+Constructor to initialize to arbitrary scale and identity scale rotation. +

+ +

References PxIdentity.

+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
PX_CUDA_CALLABLE PX_FORCE_INLINE PxMeshScale::PxMeshScale (const PxVec3 &  s,
const PxQuat &  r 
) [inline]
+
+
+ +

+Constructor to initialize to arbitrary scaling. +

+ +

References PxQuat::isUnit(), and PX_ASSERT.

+ +
+

+

Member Function Documentation

+ +
+
+ + + + + + + + +
PX_CUDA_CALLABLE PX_FORCE_INLINE PxMeshScale PxMeshScale::getInverse (  )  const [inline]
+
+
+ +

+Returns the inverse of this scaling transformation. +

+ +

+

+ +

+
+ + + + + + + + +
PX_CUDA_CALLABLE PX_FORCE_INLINE bool PxMeshScale::hasNegativeDeterminant (  )  const [inline]
+
+
+ +

+Returns true if combination of negative scale components will cause the triangle normal to flip. The SDK will flip the normals internally. +

+ +

+

+ +

+
+ + + + + + + + +
PX_CUDA_CALLABLE PX_FORCE_INLINE bool PxMeshScale::isIdentity (  )  const [inline]
+
+
+ +

+Returns true if the scaling is an identity transformation. +

+ +

+

+ +

+
+ + + + + + + + +
bool PxMeshScale::isValidForConvexMesh (  )  const [inline]
+
+
+ +

+ +

References PX_MESH_SCALE_MAX, and PX_MESH_SCALE_MIN.

+ +

Referenced by PxConvexMeshGeometry::isValid().

+ +
+

+ +

+
+ + + + + + + + +
bool PxMeshScale::isValidForTriangleMesh (  )  const [inline]
+
+
+ +

+ +

References PxVec3::maxElement(), PxVec3::minElement(), PX_MESH_SCALE_MAX, and PX_MESH_SCALE_MIN.

+ +

Referenced by PxTriangleMeshGeometry::isValid().

+ +
+

+ +

+
+ + + + + + + + +
PX_CUDA_CALLABLE PX_FORCE_INLINE PxMat33 PxMeshScale::toMat33 (  )  const [inline]
+
+
+ +

+Converts this transformation to a 3x3 matrix representation. +

+ +

References PxMat33::column0, PxMat33::column1, PxMat33::column2, and PxMat33::getTranspose().

+ +
+

+ +

+
+ + + + + + + + + +
PxVec3 PxMeshScale::transform (const PxVec3 &  v  )  const [inline]
+
+
+ +

+ +

+

+

Member Data Documentation

+ +
+
+ + + + +
PxQuat PxMeshScale::rotation
+
+
+ +

+The orientation of the scaling axes. +

+ +

Referenced by PxTriangleMeshGeometry::isValid(), PxConvexMeshGeometry::isValid(), and PxMassProperties::PxMassProperties().

+ +
+

+ +

+
+ + + + +
PxVec3 PxMeshScale::scale
+
+
+ +

+A nonuniform scaling. +

+ +

Referenced by PxTriangleMeshGeometry::isValid(), PxConvexMeshGeometry::isValid(), and PxMassProperties::PxMassProperties().

+ +
+

+

The documentation for this class was generated from the following file: +
+ +

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