PxSerialization.h

Go to the documentation of this file.
00001 //
00002 // Redistribution and use in source and binary forms, with or without
00003 // modification, are permitted provided that the following conditions
00004 // are met:
00005 //  * Redistributions of source code must retain the above copyright
00006 //    notice, this list of conditions and the following disclaimer.
00007 //  * Redistributions in binary form must reproduce the above copyright
00008 //    notice, this list of conditions and the following disclaimer in the
00009 //    documentation and/or other materials provided with the distribution.
00010 //  * Neither the name of NVIDIA CORPORATION nor the names of its
00011 //    contributors may be used to endorse or promote products derived
00012 //    from this software without specific prior written permission.
00013 //
00014 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY
00015 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00016 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00017 // PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR
00018 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00019 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00020 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00021 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
00022 // OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
00023 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
00024 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00025 //
00026 // Copyright (c) 2008-2018 NVIDIA Corporation. All rights reserved.
00027 // Copyright (c) 2004-2008 AGEIA Technologies, Inc. All rights reserved.
00028 // Copyright (c) 2001-2004 NovodeX AG. All rights reserved.  
00029 
00030 
00031 #ifndef PX_SERIALIZATION_H
00032 #define PX_SERIALIZATION_H
00033 
00037 #include "PxPhysXConfig.h"
00038 #include "common/PxBase.h"
00039 #include "cooking/PxCooking.h"
00040 #include "foundation/PxIO.h"
00041 #include "common/PxTolerancesScale.h"
00042 #include "common/PxTypeInfo.h"
00043 #include "common/PxStringTable.h"
00044 
00045 //
00046 // Important: if you adjust the comment about binary compatible versions below, don't forget to adjust the compatibility list in
00047 // sBinaryCompatibleVersionsbinary as well
00048 //
00058 #define PX_BINARY_SERIAL_VERSION 0
00059 
00060 
00061 #if !PX_DOXYGEN
00062 namespace physx
00063 {
00064 #endif
00065 
00071 class PxSerialization
00072 {
00073 public:
00081     struct PxXmlMiscParameter
00082     {
00086         PxVec3              upVector;
00087 
00091         PxTolerancesScale   scale;
00092         
00093         PxXmlMiscParameter() : upVector(0) {}
00094         PxXmlMiscParameter(PxVec3& inUpVector, PxTolerancesScale inScale) : upVector(inUpVector), scale(inScale) {}
00095     };
00096 
00121     static  bool            isSerializable(PxCollection& collection, PxSerializationRegistry& sr, const PxCollection* externalReferences = NULL);
00122 
00151     static  void            complete(PxCollection& collection, PxSerializationRegistry& sr, const PxCollection* exceptFor = NULL, bool followJoints = false);
00152     
00163     static  void            createSerialObjectIds(PxCollection& collection, const PxSerialObjectId base);
00164             
00178     static  PxCollection*   createCollectionFromXml(PxInputData& inputData, PxCooking& cooking, PxSerializationRegistry& sr, const PxCollection* externalRefs = NULL, PxStringTable* stringTable = NULL, PxXmlMiscParameter* outArgs = NULL);
00179     
00197     static  PxCollection*   createCollectionFromBinary(void* memBlock, PxSerializationRegistry& sr, const PxCollection* externalRefs = NULL);
00198 
00217     static  bool            serializeCollectionToXml(PxOutputStream& outputStream, PxCollection& collection,  PxSerializationRegistry& sr, PxCooking* cooking = NULL, const PxCollection* externalRefs = NULL, PxXmlMiscParameter* inArgs = NULL);
00218     
00241     static  bool            serializeCollectionToBinary(PxOutputStream& outputStream, PxCollection& collection, PxSerializationRegistry& sr, const PxCollection* externalRefs = NULL, bool exportNames = false );
00242 
00257     static  void            dumpBinaryMetaData(PxOutputStream& outputStream, PxSerializationRegistry& sr);
00258 
00264     static PxBinaryConverter* createBinaryConverter();
00265 
00275     static PxSerializationRegistry* createSerializationRegistry(PxPhysics& physics);    
00276 };
00277 
00278 #if !PX_DOXYGEN
00279 } // namespace physx
00280 #endif
00281 
00283 #endif


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