PxCollection
Defined in include/common/PxCollection.h
-
class PxCollection
Collection class for serialization.
A collection is a set of PxBase objects. PxBase objects can be added to the collection regardless of other objects they depend on. Objects may be named using PxSerialObjectId values in order to resolve dependencies between objects of different collections.
Serialization and deserialization only work through collections.
A scene is typically serialized using the following steps:
create a serialization registry
create a collection for scene objects
complete the scene objects (adds all dependent objects, e.g. meshes)
serialize collection
release collection
release serialization registry
For example the code may look like this:
PxPhysics* physics; // The physics PxScene* scene; // The physics scene SerialStream s; // The user-defined stream doing the actual write to disk PxSerializationRegistry* registry = PxSerialization::createSerializationRegistry(*physics); // step 1) PxCollection* collection = PxSerialization::createCollection(*scene); // step 2) PxSerialization::complete(*collection, *registry); // step 3) PxSerialization::serializeCollectionToBinary(s, *collection, *registry); // step 4) collection->release(); // step 5) registry->release(); // step 6)
A scene is typically deserialized using the following steps:
load a serialized collection into memory
create a serialization registry
create a collection by passing the serialized memory block
add collected objects to scene
release collection
release serialization registry
For example the code may look like this:
PxPhysics* physics; // The physics PxScene* scene; // The physics scene void* memory128; // a 128-byte aligned buffer previously loaded from disk by the user - step 1) PxSerializationRegistry* registry = PxSerialization::createSerializationRegistry(*physics); // step 2) PxCollection* collection = PxSerialization::createCollectionFromBinary(memory128, *registry); // step 3) scene->addCollection(*collection); // step 4) collection->release(); // step 5) registry->release(); // step 6)
See also
PxBase, PxCreateCollection()
Public Functions
-
virtual void add(PxBase &object, PxSerialObjectId id = PX_SERIAL_OBJECT_ID_INVALID) = 0
Adds a PxBase object to the collection.
Adds a PxBase object to the collection. Optionally a PxSerialObjectId can be provided in order to resolve dependencies between collections. A PxSerialObjectId value of PX_SERIAL_OBJECT_ID_INVALID means the object remains without id. Objects can be added regardless of other objects they require. If the object is already in the collection, the ID will be set if it was PX_SERIAL_OBJECT_ID_INVALID previously, otherwise the operation fails.
- Parameters
object – [in] Object to be added to the collection
id – [in] Optional PxSerialObjectId id
-
virtual void remove(PxBase &object) = 0
Removes a PxBase member object from the collection.
Object needs to be contained by the collection.
- Parameters
object – [in] PxBase object to be removed
-
virtual bool contains(PxBase &object) const = 0
Returns whether the collection contains a certain PxBase object.
- Parameters
object – [in] PxBase object
- Returns
Whether object is contained.
-
virtual void addId(PxBase &object, PxSerialObjectId id) = 0
Adds an id to a member PxBase object.
If the object is already associated with an id within the collection, the id is replaced. May only be called for objects that are members of the collection. The id needs to be unique within the collection.
- Parameters
object – [in] Member PxBase object
id – [in] PxSerialObjectId id to be given to the object
-
virtual void removeId(PxSerialObjectId id) = 0
Removes id from a contained PxBase object.
May only be called for ids that are associated with an object in the collection.
- Parameters
id – [in] PxSerialObjectId value
-
virtual void add(PxCollection &collection) = 0
Adds all PxBase objects and their ids of collection to this collection.
PxBase objects already in this collection are ignored. Object ids need to be conflict free, i.e. the same object may not have two different ids within the two collections.
- Parameters
collection – [in] Collection to be added
-
virtual void remove(PxCollection &collection) = 0
Removes all PxBase objects of collection from this collection.
PxBase objects not present in this collection are ignored. Ids of objects which are removed are also removed.
- Parameters
collection – [in] Collection to be removed
-
virtual PxU32 getNbObjects() const = 0
Gets number of PxBase objects in this collection.
- Returns
Number of objects in this collection
-
virtual PxBase &getObject(PxU32 index) const = 0
Gets the PxBase object of this collection given its index.
- Parameters
index – [in] PxBase index in [0, getNbObjects())
- Returns
PxBase object at index index
-
virtual PxU32 getObjects(PxBase **userBuffer, PxU32 bufferSize, PxU32 startIndex = 0) const = 0
Copies member PxBase pointers to a user specified buffer.
-
virtual PxBase *find(PxSerialObjectId id) const = 0
Looks for a PxBase object given a PxSerialObjectId value.
If there is no PxBase object in the collection with the given id, NULL is returned.
- Parameters
id – [in] PxSerialObjectId value to look for
- Returns
PxBase object with the given id value or NULL
-
virtual PxU32 getNbIds() const = 0
Gets number of PxSerialObjectId names in this collection.
- Returns
Number of PxSerialObjectId names in this collection
-
virtual PxU32 getIds(PxSerialObjectId *userBuffer, PxU32 bufferSize, PxU32 startIndex = 0) const = 0
Copies member PxSerialObjectId values to a user specified buffer.
- Parameters
userBuffer – [out] Array of PxSerialObjectId values
bufferSize – [in] Capacity of userBuffer
startIndex – [in] Offset into list of member PxSerialObjectId values
- Returns
number of members PxSerialObjectId values that have been written to the userBuffer
-
virtual PxSerialObjectId getId(const PxBase &object) const = 0
Gets the PxSerialObjectId name of a PxBase object within the collection.
The PxBase object needs to be a member of the collection.
- Parameters
object – [in] PxBase object to get id for
- Returns
PxSerialObjectId name of the object or PX_SERIAL_OBJECT_ID_INVALID if the object is unnamed
-
virtual void release() = 0
Deletes a collection object.
This function only deletes the collection object, i.e. the container class. It doesn’t delete objects that are part of the collection.
See also
PxCreateCollection()