RavEngine
Loading...
Searching...
No Matches
PxRepXSerializer.h
1// Redistribution and use in source and binary forms, with or without
2// modification, are permitted provided that the following conditions
3// are met:
4// * Redistributions of source code must retain the above copyright
5// notice, this list of conditions and the following disclaimer.
6// * Redistributions in binary form must reproduce the above copyright
7// notice, this list of conditions and the following disclaimer in the
8// documentation and/or other materials provided with the distribution.
9// * Neither the name of NVIDIA CORPORATION nor the names of its
10// contributors may be used to endorse or promote products derived
11// from this software without specific prior written permission.
12//
13// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ''AS IS'' AND ANY
14// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
17// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21// OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24//
25// Copyright (c) 2008-2022 NVIDIA Corporation. All rights reserved.
26// Copyright (c) 2004-2008 AGEIA Technologies, Inc. All rights reserved.
27// Copyright (c) 2001-2004 NovodeX AG. All rights reserved.
28
29#ifndef PX_REPX_SERIALIZER_H
30#define PX_REPX_SERIALIZER_H
35#include "common/PxBase.h"
36#include "extensions/PxRepXSimpleType.h"
37
38#if !PX_DOXYGEN
39namespace 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
110template<typename TDataType>
115
120{
121 PX_ASSERT(inType);
122 return physx::PxRepXObject(inType->getConcreteTypeName(), inType, inId);
123}
124
128template<typename TDataType>
130{
131 return PxCreateRepXObject(inType, static_cast<physx::PxSerialObjectId>(size_t(inType)));
132}
133
137#define PX_NEW_REPX_SERIALIZER(T) \
138 *PX_PLACEMENT_NEW(PxGetAllocatorCallback()->allocate(sizeof(T), "PxRepXSerializer", __FILE__, __LINE__ ), T)(*PxGetAllocatorCallback())
139
143#define PX_DELETE_REPX_SERIALIZER(x) \
144 { PxRepXSerializer* s = x; if (s) { PxGetAllocatorCallback()->deallocate(s); } }
145
146
148#endif
149
Definition SnXmlMemoryPoolStreams.h:165
Base class for objects that can be members of a PxCollection.
Definition PxBase.h:73
virtual const char * getConcreteTypeName() const =0
Returns string name of dynamic type.
Collection class for serialization.
Definition PxCollection.h:104
Serializer interface for RepX (Xml) serialization.
Definition PxRepXSerializer.h:67
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.
Definition SnXmlSimpleXmlWriter.h:37
Definition SnXmlMemoryAllocator.h:37
Definition SnXmlReader.h:42
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
#define PX_INLINE
Definition PxPreprocessor.h:320
Sorts an array of objects in ascending order, assuming that the predicate implements the < operator:
Definition PxBoxController.h:39
PxU64 PxSerialObjectId
ID type for PxBase objects in a PxCollection.
Definition PxSerialFramework.h:61
Arguments required to instantiate a serializable object from RepX.
Definition PxRepXSimpleType.h:83
Helper class containing the mapping of id to object, and type name.
Definition PxRepXSimpleType.h:50
a structure containing per-type information for types inheriting from PxBase
Definition PxTypeInfo.h:113