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

PxPruningStructure Class Reference
+ +[Physics] +

A precomputed pruning structure to accelerate scene queries against newly added actors. +More... +

+#include <PxPruningStructure.h> +

+

+Inheritance diagram for PxPruningStructure:
+
+

Inheritance graph
+ +PxBase +
[legend]
+
+Collaboration diagram for PxPruningStructure:
+
+

Collaboration graph
+ +PxBasePxFlags\< PxBaseFlag::Enum, PxU16 \> +
[legend]
+ +

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

Public Member Functions

virtual void release ()=0
 Release this object.
virtual PxU32 getRigidActors (PxRigidActor **userBuffer, PxU32 bufferSize, PxU32 startIndex=0) const =0
 Retrieve rigid actors in the pruning structure.
virtual PxU32 getNbRigidActors () const =0
 Returns the number of rigid actors in the pruning structure.
virtual const char * getConcreteTypeName () const
 Returns string name of dynamic type.

Protected Member Functions

PX_INLINE PxPruningStructure (PxType concreteType, PxBaseFlags baseFlags)
PX_INLINE PxPruningStructure (PxBaseFlags baseFlags)
virtual ~PxPruningStructure ()
virtual bool isKindOf (const char *name) const
 Returns whether a given type name matches with the type of this instance.
+

Detailed Description

+A precomputed pruning structure to accelerate scene queries against newly added actors. +

+The pruning structure can be provided to PxScene:: addActors() in which case it will get merged directly into the scene query optimization AABB tree, thus leading to improved performance when doing queries against the newly added actors. This applies to both static and dynamic actors.

+

Note:
PxPruningStructure objects can be added to a collection and get serialized.

+Adding a PxPruningStructure object to a collection will also add the actors that were used to build the pruning structure.

+PxPruningStructure must be released before its rigid actors.

+PxRigidBody objects can be in one PxPruningStructure only.

+Changing the bounds of PxRigidBody objects assigned to a pruning structure that has not been added to a scene yet will invalidate the pruning structure. Same happens if shape scene query flags change or shape gets removed from an actor.

+
See also:
PxScene::addActors PxCollection
+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + +
PX_INLINE PxPruningStructure::PxPruningStructure (PxType  concreteType,
PxBaseFlags  baseFlags 
) [inline, protected]
+
+
+ +

+ +

+

+ +

+
+ + + + + + + + + +
PX_INLINE PxPruningStructure::PxPruningStructure (PxBaseFlags  baseFlags  )  [inline, protected]
+
+
+ +

+ +

+

+ +

+
+ + + + + + + + +
virtual PxPruningStructure::~PxPruningStructure (  )  [inline, protected, virtual]
+
+
+ +

+ +

+

+

Member Function Documentation

+ +
+
+ + + + + + + + +
virtual const char* PxPruningStructure::getConcreteTypeName (  )  const [inline, virtual]
+
+
+ +

+Returns string name of dynamic type. +

+

Returns:
Class name of most derived type of this object.
+ +

Implements PxBase.

+ +
+

+ +

+
+ + + + + + + + +
virtual PxU32 PxPruningStructure::getNbRigidActors (  )  const [pure virtual]
+
+
+ +

+Returns the number of rigid actors in the pruning structure. +

+You can use getRigidActors() to retrieve the rigid actor pointers.

+

Returns:
Number of rigid actors in the pruning structure.
+
See also:
PxRigidActor
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + +
virtual PxU32 PxPruningStructure::getRigidActors (PxRigidActor **  userBuffer,
PxU32  bufferSize,
PxU32  startIndex = 0 
) const [pure virtual]
+
+
+ +

+Retrieve rigid actors in the pruning structure. +

+You can retrieve the number of rigid actor pointers by calling getNbRigidActors()

+

Parameters:
+ + + + +
[out] userBuffer The buffer to store the actor pointers.
[in] bufferSize Size of provided user buffer.
[in] startIndex Index of first actor pointer to be retrieved
+
+
Returns:
Number of rigid actor pointers written to the buffer.
+
See also:
PxRigidActor
+ +
+

+ +

+
+ + + + + + + + + +
virtual bool PxPruningStructure::isKindOf (const char *  superClass  )  const [inline, protected, virtual]
+
+
+ +

+Returns whether a given type name matches with the type of this instance. +

+ +

Reimplemented from PxBase.

+ +

References PxBase::isKindOf().

+ +
+

+ +

+
+ + + + + + + + +
virtual void PxPruningStructure::release (  )  [pure virtual]
+
+
+ +

+Release this object. +

+ +

Implements PxBase.

+ +
+

+

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