NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxRepXSerializer Class Reference

NVIDIA PhysX SDK 3.4 API

PxRepXSerializer Class Reference
[Serializers]

Serializer interface for RepX (Xml) serialization. More...

#include <PxRepXSerializer.h>

List of all members.


Public Member Functions

virtual const char * getTypeName ()=0
 The type this Serializer is meant to operate on.
virtual void objectToFile (const PxRepXObject &inLiveObject, PxCollection *inCollection, XmlWriter &inWriter, MemoryBuffer &inTempBuffer, PxRepXInstantiationArgs &inArgs)=0
 Convert from a RepX object to a key-value pair hierarchy.
virtual PxRepXObject fileToObject (XmlReader &inReader, XmlMemoryAllocator &inAllocator, PxRepXInstantiationArgs &inArgs, PxCollection *inCollection)=0
 Convert from a descriptor to a live object. Must be an object of this Serializer type.

Protected Member Functions

virtual ~PxRepXSerializer ()

Detailed Description

Serializer interface for RepX (Xml) serialization.

In order to serialize a class to RepX both a PxSerializer and a PxRepXSerializer implementation are needed.

A repx Serializer provides the ability to capture a live object to a descriptor or static state and the ability to write that state out to a file. Objects allocated by the Serializer using the allocator are freed when the collection itself is freed. SnRepXCoreSerializers.cpp implements a set of Serializers for the core PhysX types.

Note:
Implementing a PxRepXSerializer is currently not practical without including the internal PhysXExtension header "SnRepXSerializerImpl.h".
See also:
PxSerializer, PX_NEW_REPX_SERIALIZER, PxSerializationRegistry::registerRepXSerializer

Constructor & Destructor Documentation

virtual PxRepXSerializer::~PxRepXSerializer (  )  [inline, protected, virtual]


Member Function Documentation

virtual PxRepXObject PxRepXSerializer::fileToObject ( XmlReader &  inReader,
XmlMemoryAllocator &  inAllocator,
PxRepXInstantiationArgs inArgs,
PxCollection inCollection 
) [pure virtual]

Convert from a descriptor to a live object. Must be an object of this Serializer type.

Parameters:
[in] inReader The inverse of the writer, a key-value pair database.
[in] inAllocator An allocator to use for temporary allocations. These will be freed after instantiation completes.
[in] inArgs The arguments used in create resources and objects.
[in] inCollection The collection used to find references.
Returns:
The new live object. It can be an invalid object if the instantiation cannot take place.

virtual const char* PxRepXSerializer::getTypeName (  )  [pure virtual]

The type this Serializer is meant to operate on.

See also:
PxRepXObject::typeName

virtual void PxRepXSerializer::objectToFile ( const PxRepXObject inLiveObject,
PxCollection inCollection,
XmlWriter &  inWriter,
MemoryBuffer &  inTempBuffer,
PxRepXInstantiationArgs inArgs 
) [pure virtual]

Convert from a RepX object to a key-value pair hierarchy.

Parameters:
[in] inLiveObject The object to convert to the passed in descriptor.
[in] inCollection The collection to use to find ids of references of this object.
[in] inWriter Interface to write data to.
[in] inTempBuffer used to for temporary allocations.
[in] inArgs The arguments used in create resources and objects.


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



Copyright © 2008-2017 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com