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

PxRigidActorExt Class Reference
+ +[Extensions] +

utility functions for use with PxRigidActor and subclasses +More... +

+#include <PxRigidActorExt.h> +

+ +

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

Static Public Member Functions

static PxShape * createExclusiveShape (PxRigidActor &actor, const PxGeometry &geometry, PxMaterial *const *materials, PxU16 materialCount, PxShapeFlags shapeFlags=PxShapeFlag::eVISUALIZATION|PxShapeFlag::eSCENE_QUERY_SHAPE|PxShapeFlag::eSIMULATION_SHAPE)
 Creates a new shape with default properties and a list of materials and adds it to the list of shapes of this actor.
static PX_FORCE_INLINE PxShape * createExclusiveShape (PxRigidActor &actor, const PxGeometry &geometry, const PxMaterial &material, PxShapeFlags shapeFlags=PxShapeFlag::eVISUALIZATION|PxShapeFlag::eSCENE_QUERY_SHAPE|PxShapeFlag::eSIMULATION_SHAPE)
 Creates a new shape with default properties and a single material adds it to the list of shapes of this actor.
+

Detailed Description

+utility functions for use with PxRigidActor and subclasses +

+

See also:
PxRigidActor PxRigidStatic PxRigidBody PxRigidDynamic PxArticulationLink
+

Member Function Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
static PX_FORCE_INLINE PxShape* PxRigidActorExt::createExclusiveShape (PxRigidActor &  actor,
const PxGeometry &  geometry,
const PxMaterial &  material,
PxShapeFlags  shapeFlags = PxShapeFlag::eVISUALIZATION | PxShapeFlag::eSCENE_QUERY_SHAPE | PxShapeFlag::eSIMULATION_SHAPE 
) [inline, static]
+
+
+ +

+Creates a new shape with default properties and a single material adds it to the list of shapes of this actor. +

+This is equivalent to the following

+PxShape* shape(...) = PxGetPhysics().createShape(...); // reference count is 1 actor->attachShape(shape); // increments reference count shape->release(); // releases user reference, leaving reference count at 1

+As a consequence, detachShape() will result in the release of the last reference, and the shape will be deleted.

+

Note:
The default shape flags to be set are: eVISUALIZATION, eSIMULATION_SHAPE, eSCENE_QUERY_SHAPE (see PxShapeFlag). Triangle mesh, heightfield or plane geometry shapes configured as eSIMULATION_SHAPE are not supported for non-kinematic PxRigidDynamic instances.

+Creating compounds with a very large number of shapes may adversely affect performance and stability.

+Sleeping: Does NOT wake the actor up automatically.

+

Parameters:
+ + + + + +
[in] actor the actor to which to attach the shape
[in] geometry the geometry of the shape
[in] material the material for the shape
[in] shapeFlags optional PxShapeFlags
+
+
Returns:
The newly created shape.
+
See also:
PxShape PxShape::release(), PxPhysics::createShape(), PxRigidActor::attachShape()
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
static PxShape* PxRigidActorExt::createExclusiveShape (PxRigidActor &  actor,
const PxGeometry &  geometry,
PxMaterial *const *  materials,
PxU16  materialCount,
PxShapeFlags  shapeFlags = PxShapeFlag::eVISUALIZATION | PxShapeFlag::eSCENE_QUERY_SHAPE | PxShapeFlag::eSIMULATION_SHAPE 
) [inline, static]
+
+
+ +

+Creates a new shape with default properties and a list of materials and adds it to the list of shapes of this actor. +

+This is equivalent to the following

+PxShape* shape(...) = PxGetPhysics().createShape(...); // reference count is 1 actor->attachShape(shape); // increments reference count shape->release(); // releases user reference, leaving reference count at 1

+As a consequence, detachShape() will result in the release of the last reference, and the shape will be deleted.

+

Note:
The default shape flags to be set are: eVISUALIZATION, eSIMULATION_SHAPE, eSCENE_QUERY_SHAPE (see PxShapeFlag). Triangle mesh, heightfield or plane geometry shapes configured as eSIMULATION_SHAPE are not supported for non-kinematic PxRigidDynamic instances.

+Creating compounds with a very large number of shapes may adversely affect performance and stability.

+Sleeping: Does NOT wake the actor up automatically.

+

Parameters:
+ + + + + + +
[in] actor the actor to which to attach the shape
[in] geometry the geometry of the shape
[in] materials a pointer to an array of material pointers
[in] materialCount the count of materials
[in] shapeFlags optional PxShapeFlags
+
+
Returns:
The newly created shape.
+
See also:
PxShape PxShape::release(), PxPhysics::createShape(), PxRigidActor::attachShape()
+ +

References PxRigidActor::attachShape(), PxGetPhysics(), and PxShape::release().

+ +
+

+

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