#include <PxCollectionExt.h>

Static Public Member Functions
static void	releaseObjects (PxCollection &collection)
	Removes and releases all object from a collection. More...

static void	remove (PxCollection &collection, PxType concreteType, PxCollection *to=NULL)
	Removes objects of a given type from a collection, potentially adding them to another collection. More...

static PxCollection *	createCollection (PxPhysics &physics)
	Collects all objects in PxPhysics that are shareable across multiple scenes. More...

static PxCollection *	createCollection (PxScene &scene)
	Collects all objects from a PxScene. More...

Member Function Documentation

static PxCollection* PxCollectionExt::createCollection ( PxPhysics & physics )

static

Collects all objects in PxPhysics that are shareable across multiple scenes.

This function creates a new collection from all objects that are shareable across multiple scenes. Instances of the following types are included: PxConvexMesh, PxTriangleMesh, PxHeightField, PxShape, PxMaterial and PxClothFabric.

This is a helper function to ease the creation of collections for serialization.

Parameters

[in] physics The physics SDK instance from which objects are collected. See PxPhysics

Returns: Collection to which objects are added. See PxCollection

See Also: PxCollection, PxPhysics

static PxCollection* PxCollectionExt::createCollection ( PxScene & scene )

static

Collects all objects from a PxScene.

This function creates a new collection from all objects that where added to the specified PxScene. Instances of the following types are included: PxActor, PxAggregate, PxArticulation and PxJoint (other PxConstraint types are not included).

This is a helper function to ease the creation of collections for serialization. The function PxSerialization.complete() can be used to complete the collection with required objects prior to serialization.

Parameters

[in] scene The PxScene instance from which objects are collected. See PxScene

Returns: Collection to which objects are added. See PxCollection

See Also: PxCollection, PxScene, PxSerialization.complete()

static void PxCollectionExt::releaseObjects ( PxCollection & collection )

static

Removes and releases all object from a collection.

The Collection itself is not released.

It is assumed that the application holds a reference to each of the objects in the collection, with the exception of objects that are subordinate (PxBase::isSubordinate). This is for example not the case if the collection contains a shape that was created with PxRigidActor::createShape, as the application gives up the reference to the shape with this call. Objects that violate this assumption need to be removed from the collection prior to calling releaseObjects.

Parameters

[in] collection to remove and release all object from.

static void PxCollectionExt::remove	(	PxCollection &	collection,
		PxType	concreteType,
		PxCollection *	to = `NULL`
	)

static

Removes objects of a given type from a collection, potentially adding them to another collection.

Parameters

[in,out]	collection	Collection from which objects are removed
[in]	concreteType	PxConcreteType of sdk objects that should be removed
[in,out]	to	Optional collection to which the removed objects are added

See Also: PxCollection, PxConcreteType

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

PxCollectionExt.h

Static Public Member Functions

Member Function Documentation