RavEngine
Loading...
Searching...
No Matches
SnRepXSerializerImpl.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 SN_REPX_SERIALIZER_IMPL_H
30#define SN_REPX_SERIALIZER_IMPL_H
31
32#include "foundation/PxUserAllocated.h"
33#include "SnXmlVisitorWriter.h"
34#include "SnXmlVisitorReader.h"
35
36namespace physx {
37 using namespace Sn;
38
44 template<typename TLiveType>
46 {
47 protected:
48 RepXSerializerImpl( const RepXSerializerImpl& inOther );
49 RepXSerializerImpl& operator=( const RepXSerializerImpl& inOther );
50
51 public:
52 PxAllocatorCallback& mAllocator;
53
55 : mAllocator( inAllocator )
56 {
57 }
58
59 virtual const char* getTypeName() { return PxTypeInfo<TLiveType>::name(); }
60
61 virtual void objectToFile( const PxRepXObject& inLiveObject, PxCollection* inCollection, XmlWriter& inWriter, MemoryBuffer& inTempBuffer, PxRepXInstantiationArgs& inArgs )
62 {
63 const TLiveType* theObj = reinterpret_cast<const TLiveType*>( inLiveObject.serializable );
64 objectToFileImpl( theObj, inCollection, inWriter, inTempBuffer, inArgs );
65 }
66
67 virtual PxRepXObject fileToObject( XmlReader& inReader, XmlMemoryAllocator& inAllocator, PxRepXInstantiationArgs& inArgs, PxCollection* inCollection )
68 {
69 TLiveType* theObj( allocateObject( inArgs ) );
70 if ( theObj )
71 if(fileToObjectImpl( theObj, inReader, inAllocator, inArgs, inCollection ))
72 return PxCreateRepXObject(theObj);
73 return PxRepXObject();
74 }
75
76 virtual void objectToFileImpl( const TLiveType* inObj, PxCollection* inCollection, XmlWriter& inWriter, MemoryBuffer& inTempBuffer, PxRepXInstantiationArgs& /*inArgs*/)
77 {
78 writeAllProperties( inObj, inWriter, inTempBuffer, *inCollection );
79 }
80
81 virtual bool fileToObjectImpl( TLiveType* inObj, XmlReader& inReader, XmlMemoryAllocator& inAllocator, PxRepXInstantiationArgs& inArgs, PxCollection* inCollection )
82 {
83 return readAllProperties( inArgs, inReader, inObj, inAllocator, *inCollection );
84 }
85
86 virtual TLiveType* allocateObject( PxRepXInstantiationArgs& inArgs ) = 0;
87 };
88}
89
90#endif
Definition SnXmlMemoryPoolStreams.h:165
Abstract base class for an application defined memory allocator that can be used by the Nv library.
Definition PxAllocatorCallback.h:53
Collection class for serialization.
Definition PxCollection.h:104
Serializer interface for RepX (Xml) serialization.
Definition PxRepXSerializer.h:67
Definition PxUserAllocated.h:43
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
Sorts an array of objects in ascending order, assuming that the predicate implements the < operator:
Definition PxBoxController.h:39
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
const void * serializable
Pointer to the serializable this was created from.
Definition PxRepXSimpleType.h:60
a structure containing per-type information for types inheriting from PxBase
Definition PxTypeInfo.h:113
Definition SnRepXSerializerImpl.h:46
virtual const char * getTypeName()
The type this Serializer is meant to operate on.
Definition SnRepXSerializerImpl.h:59
virtual PxRepXObject fileToObject(XmlReader &inReader, XmlMemoryAllocator &inAllocator, PxRepXInstantiationArgs &inArgs, PxCollection *inCollection)
Convert from a descriptor to a live object. Must be an object of this Serializer type.
Definition SnRepXSerializerImpl.h:67
virtual void objectToFile(const PxRepXObject &inLiveObject, PxCollection *inCollection, XmlWriter &inWriter, MemoryBuffer &inTempBuffer, PxRepXInstantiationArgs &inArgs)
Convert from a RepX object to a key-value pair hierarchy.
Definition SnRepXSerializerImpl.h:61