PxRepXSerializer.h
Go to the documentation of this file.
1 //
2 // Redistribution and use in source and binary forms, with or without
3 // modification, are permitted provided that the following conditions
4 // are met:
5 // * Redistributions of source code must retain the above copyright
6 // notice, this list of conditions and the following disclaimer.
7 // * Redistributions in binary form must reproduce the above copyright
8 // notice, this list of conditions and the following disclaimer in the
9 // documentation and/or other materials provided with the distribution.
10 // * Neither the name of NVIDIA CORPORATION nor the names of its
11 // contributors may be used to endorse or promote products derived
12 // from this software without specific prior written permission.
13 //
14 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ''AS IS'' AND ANY
15 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
18 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22 // OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 //
26 // Copyright (c) 2008-2021 NVIDIA Corporation. All rights reserved.
27 // Copyright (c) 2004-2008 AGEIA Technologies, Inc. All rights reserved.
28 // Copyright (c) 2001-2004 NovodeX AG. All rights reserved.
29 #ifndef PX_REPX_SERIALIZER_H
30 #define PX_REPX_SERIALIZER_H
31 
35 #include "common/PxBase.h"
37 
38 #if !PX_DOXYGEN
39 namespace physx
40 {
41 #endif
42 
43  class XmlMemoryAllocator;
44  class XmlWriter;
45  class XmlReader;
46  class MemoryBuffer;
47 
67  {
68  protected:
69  virtual ~PxRepXSerializer(){}
70  public:
71 
76  virtual const char* getTypeName() = 0;
77 
87  virtual void objectToFile( const PxRepXObject& inLiveObject, PxCollection* inCollection, XmlWriter& inWriter, MemoryBuffer& inTempBuffer, PxRepXInstantiationArgs& inArgs ) = 0;
88 
99  virtual PxRepXObject fileToObject( XmlReader& inReader, XmlMemoryAllocator& inAllocator, PxRepXInstantiationArgs& inArgs, PxCollection* inCollection ) = 0;
100 
101  };
102 
103 #if !PX_DOXYGEN
104 } // namespace physx
105 #endif
106 
110 template<typename TDataType>
111 PX_INLINE physx::PxRepXObject PxCreateRepXObject(const TDataType* inType, const physx::PxSerialObjectId inId)
112 {
113  return physx::PxRepXObject(physx::PxTypeInfo<TDataType>::name(), inType, inId);
114 }
115 
119 PX_INLINE physx::PxRepXObject PxCreateRepXObject(const physx::PxBase* inType, const physx::PxSerialObjectId inId)
120 {
121  PX_ASSERT(inType);
122  return physx::PxRepXObject(inType->getConcreteTypeName(), inType, inId);
123 }
124 
128 template<typename TDataType>
129 PX_INLINE physx::PxRepXObject PxCreateRepXObject(const TDataType* inType)
130 {
131  return PxCreateRepXObject(inType, static_cast<physx::PxSerialObjectId>(reinterpret_cast<size_t>(inType)));
132 }
133 
137 #define PX_NEW_REPX_SERIALIZER(T) \
138  *PX_PLACEMENT_NEW(PxGetFoundation().getAllocatorCallback().allocate(sizeof(T), "PxRepXSerializer", __FILE__, __LINE__ ), T)(PxGetFoundation().getAllocatorCallback())
139 
143 #define PX_DELETE_REPX_SERIALIZER(x) \
144  { PxRepXSerializer* s = x; if (s) { PxGetFoundation().getAllocatorCallback().deallocate(s); } }
145 
146 
148 #endif // PX_REPX_SERIALIZER_H
Definition: GuContactBuffer.h:37
PX_INLINE physx::PxRepXObject PxCreateRepXObject(const TDataType *inType, const physx::PxSerialObjectId inId)
Inline helper template function to create PxRepXObject from TDataType type supporting PxTypeInfo<TDat...
Definition: PxRepXSerializer.h:111
Serializer interface for RepX (Xml) serialization.
Definition: PxRepXSerializer.h:66
PxU64 PxSerialObjectId
ID type for PxBase objects in a PxCollection.
Definition: PxSerialFramework.h:62
Collection class for serialization.
Definition: PxCollection.h:105
Arguments required to instantiate a serializable object from RepX.
Definition: PxRepXSimpleType.h:85
#define PX_ASSERT(exp)
Definition: PxAssert.h:59
Helper class containing the mapping of id to object, and type name.
Definition: PxRepXSimpleType.h:52
virtual ~PxRepXSerializer()
Definition: PxRepXSerializer.h:69
#define PX_INLINE
Definition: PxPreprocessor.h:336