Revision control
++ // Copyright (c) 2001-2004 NovodeX AG. All rights reserved.
++ // Copyright (c) 2004-2008 AGEIA Technologies, Inc. All rights reserved.
++ // SPDX-FileCopyrightText: Copyright (c) 2008-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
++ // SPDX-License-Identifier: Apache-2.0
++
++ #ifndef PX_REPX_SERIALIZER_H
++ #define PX_REPX_SERIALIZER_H
++
++ #include "common/PxBase.h"
++ #include "extensions/PxRepXSimpleType.h"
++
++ #if !PX_DOXYGEN
++ namespace physx
++ {
++ #endif
++
++ class XmlMemoryAllocator;
++ class XmlWriter;
++ class XmlReader;
++ class MemoryBuffer;
++
++ /**
++ \brief Serializer interface for RepX (Xml) serialization.
++
++ \deprecated Xml serialization is deprecated. An alternative serialization system is provided through USD Physics.
++
++ 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 PxSerializer, PX_NEW_REPX_SERIALIZER, PxSerializationRegistry::registerRepXSerializer
++ */
++ class PX_DEPRECATED PxRepXSerializer
++ {
++ protected:
++ virtual ~PxRepXSerializer(){}
++ public:
++
++ /**
++ \brief The type this Serializer is meant to operate on.
++ \see PxRepXObject::typeName
++ */
++ virtual const char* getTypeName() = 0;
++
++ /**
++ \brief Convert from a RepX object to a key-value pair hierarchy
++
++ \param[in] inLiveObject The object to convert to the passed in descriptor.
++ \param[in] inCollection The collection to use to find ids of references of this object.
++ \param[in] inWriter Interface to write data to.
++ \param[in] inTempBuffer used to for temporary allocations.
++ \param[in] inArgs The arguments used in create resources and objects.
++ */
++ virtual void objectToFile( const PxRepXObject& inLiveObject, PxCollection* inCollection, XmlWriter& inWriter, MemoryBuffer& inTempBuffer, PxRepXInstantiationArgs& inArgs ) = 0;
++
++ /**
++ \brief Convert from a descriptor to a live object. Must be an object of this Serializer type.
++
++ \param[in] inReader The inverse of the writer, a key-value pair database.
++ \param[in] inAllocator An allocator to use for temporary allocations. These will be freed after instantiation completes.
++ \param[in] inArgs The arguments used in create resources and objects.
++ \param[in] inCollection The collection used to find references.
++
++ \return The new live object. It can be an invalid object if the instantiation cannot take place.
++ */
++ virtual PxRepXObject fileToObject( XmlReader& inReader, XmlMemoryAllocator& inAllocator, PxRepXInstantiationArgs& inArgs, PxCollection* inCollection ) = 0;
++
++ };
++
++ #if !PX_DOXYGEN
++ } // namespace physx
++ #endif
++
++ /**
++ \brief Inline helper template function to create PxRepXObject from TDataType type supporting PxTypeInfo<TDataType>::name.
++ \deprecated Xml serialization is deprecated. An alternative serialization system is provided through USD Physics.
++ */
++ template<typename TDataType>
++ PX_DEPRECATED PX_INLINE physx::PxRepXObject PxCreateRepXObject(const TDataType* inType, const physx::PxSerialObjectId inId)
++ {
++ return physx::PxRepXObject(physx::PxTypeInfo<TDataType>::name(), inType, inId);
++ }
++
++ /**
++ \brief Inline helper function to create PxRepXObject from a PxBase instance.
++ \deprecated Xml serialization is deprecated. An alternative serialization system is provided through USD Physics.
++ */
++ PX_DEPRECATED PX_INLINE physx::PxRepXObject PxCreateRepXObject(const physx::PxBase* inType, const physx::PxSerialObjectId inId)
++ {
++ PX_ASSERT(inType);
++ return physx::PxRepXObject(inType->getConcreteTypeName(), inType, inId);
++ }
++
++ /**
++ \brief Inline helper template function to create PxRepXObject form TDataType type using inType pointer as a PxSerialObjectId id.
++ \deprecated Xml serialization is deprecated. An alternative serialization system is provided through USD Physics.
++ */
++ template<typename TDataType>
++ PX_DEPRECATED PX_INLINE physx::PxRepXObject PxCreateRepXObject(const TDataType* inType)
++ {
++ return PxCreateRepXObject(inType, static_cast<physx::PxSerialObjectId>(size_t(inType)));
++ }
++
++ /**
++ \brief Preprocessor macro for RepX serializer creation.
++ \deprecated Xml serialization is deprecated. An alternative serialization system is provided through USD Physics.
++ */
++ #define PX_NEW_REPX_SERIALIZER(T) \
++ *PX_PLACEMENT_NEW(PxGetAllocatorCallback()->allocate(sizeof(T), "PxRepXSerializer", PX_FL), T)(*PxGetAllocatorCallback())
++
++ /**
++ \brief Preprocessor Macro to simplify RepX serializer delete.
++ \deprecated Xml serialization is deprecated. An alternative serialization system is provided through USD Physics.
++ */
++ #define PX_DELETE_REPX_SERIALIZER(x) \
++ { PxRepXSerializer* s = x; if (s) { PxGetAllocatorCallback()->deallocate(s); } }
++
++
++ #endif
++