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/classPxCapsuleGeometry.html | 171 +++++++++++++++++++++ 1 file changed, 171 insertions(+) create mode 100644 PhysX_3.4/Documentation/PhysXAPI/files/classPxCapsuleGeometry.html (limited to 'PhysX_3.4/Documentation/PhysXAPI/files/classPxCapsuleGeometry.html') diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/classPxCapsuleGeometry.html b/PhysX_3.4/Documentation/PhysXAPI/files/classPxCapsuleGeometry.html new file mode 100644 index 00000000..46e5557d --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/classPxCapsuleGeometry.html @@ -0,0 +1,171 @@ + + + NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxCapsuleGeometry Class Reference + + + + + + + +
+

PxCapsuleGeometry Class Reference
+ +[Geomutils] +

Class representing the geometry of a capsule. +More... +

+#include <PxCapsuleGeometry.h> +

+

+Inheritance diagram for PxCapsuleGeometry:
+
+

Inheritance graph
+ +PxGeometry +
[legend]
+
+Collaboration diagram for PxCapsuleGeometry:
+
+

Collaboration graph
+ +PxGeometry +
[legend]
+ +

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

Public Member Functions

PX_INLINE PxCapsuleGeometry ()
 Default constructor, initializes to a capsule with zero height and radius.
PX_INLINE PxCapsuleGeometry (PxReal radius_, PxReal halfHeight_)
 Constructor, initializes to a capsule with passed radius and half height.
PX_INLINE bool isValid () const
 Returns true if the geometry is valid.

Public Attributes

PxReal radius
 The radius of the capsule.
PxReal halfHeight
 half of the capsule's height, measured between the centers of the hemispherical ends.
+

Detailed Description

+Class representing the geometry of a capsule. +

+Capsules are shaped as the union of a cylinder of length 2 * halfHeight and with the given radius centered at the origin and extending along the x axis, and two hemispherical ends.

Note:
The scaling of the capsule is expected to be baked into these values, there is no additional scaling parameter.
+The function PxTransformFromSegment is a helper for generating an appropriate transform for the capsule from the capsule's interior line segment.

+

See also:
PxTransformFromSegment
+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + +
PX_INLINE PxCapsuleGeometry::PxCapsuleGeometry (  )  [inline]
+
+
+ +

+Default constructor, initializes to a capsule with zero height and radius. +

+ +

+

+ +

+
+ + + + + + + + + + + + + + + + + + +
PX_INLINE PxCapsuleGeometry::PxCapsuleGeometry (PxReal  radius_,
PxReal  halfHeight_ 
) [inline]
+
+
+ +

+Constructor, initializes to a capsule with passed radius and half height. +

+ +

+

+

Member Data Documentation

+ +
+
+ + + + +
PxReal PxCapsuleGeometry::halfHeight
+
+
+ +

+half of the capsule's height, measured between the centers of the hemispherical ends. +

+ +

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

+ +
+

+ +

+
+ + + + +
PxReal PxCapsuleGeometry::radius
+
+
+ +

+The radius of the capsule. +

+ +

Referenced by 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