PxSerializationContext

Defined in include/common/PxSerialFramework.h

class PxSerializationContext

Binary serialization context class.

This class is used to register reference values and write object and object extra data during serialization. It is mainly used by the serialization framework. Except for custom serializable types, users should not have to worry about it.

See also

PxDeserializationContext

Public Functions

virtual void registerReference(PxBase &base, PxU32 kind, size_t reference) = 0

Registers a reference value corresponding to a PxBase object.

This method is assumed to be called in the implementation of PxSerializer::registerReferences for serialized references that need to be resolved on deserialization.

A reference needs to be associated with exactly one PxBase object in either the collection or the external references collection.

Different kinds of references are supported and need to be specified. In the most common case (PX_SERIAL_REF_KIND_PXBASE) the PxBase object matches the reference value (which is the pointer to the PxBase object). Integer references maybe registered as well (used for internal material indices with PX_SERIAL_REF_KIND_MATERIAL_IDX). Other kinds could be added with the restriction that for pointer types the kind value needs to be marked with the PX_SERIAL_REF_KIND_PTR_TYPE_BIT.

See also

PxDeserializationContext::resolveReference, PX_SERIAL_REF_KIND_PXBASE, PX_SERIAL_REF_KIND_MATERIAL_IDX, PxSerializer::registerReferences

Parameters

  • base – [in] PxBase object associated with the reference

  • kind – [in] What kind of reference this is (PX_SERIAL_REF_KIND_PXBASE, PX_SERIAL_REF_KIND_MATERIAL_IDX or custom kind)

  • reference – [in] Value of reference

virtual const PxCollection &getCollection() const = 0

Returns the collection that is being serialized.

virtual void writeData(const void *data, PxU32 size) = 0

Serializes object data and object extra data.

This function is assumed to be called within the implementation of PxSerializer::exportData and PxSerializer::exportExtraData.

See also

PxSerializer::exportData, PxSerializer::exportExtraData, PxSerializer::createObject, PxDeserializationContext::readExtraData

virtual void alignData(PxU32 alignment = 16) = 0

Aligns the serialized data.

This function is assumed to be called within the implementation of PxSerializer::exportData and PxSerializer::exportExtraData.

See also

PxSerializer::exportData, PxSerializer::exportExtraData, PxDeserializationContext::alignExtraData

virtual void writeName(const char *name) = 0

Helper function to write a name to the extraData if serialization is configured to save names.

This function is assumed to be called within the implementation of PxSerializer::exportExtraData.

See also

PxSerialization::serializeCollectionToBinary, PxDeserializationContext::readName

Protected Functions

inline PxSerializationContext()
inline virtual ~PxSerializationContext()