00001 // This code contains NVIDIA Confidential Information and is disclosed to you
00002 // under a form of NVIDIA software license agreement provided separately to you.
00003 //
00004 // Notice
00005 // NVIDIA Corporation and its licensors retain all intellectual property and
00006 // proprietary rights in and to this software and related documentation and
00007 // any modifications thereto. Any use, reproduction, disclosure, or
00008 // distribution of this software and related documentation without an express
00009 // license agreement from NVIDIA Corporation is strictly prohibited.
00010 //
00011 // ALL NVIDIA DESIGN SPECIFICATIONS, CODE ARE PROVIDED "AS IS.". NVIDIA MAKES
00012 // NO WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO
00013 // THE MATERIALS, AND EXPRESSLY DISCLAIMS ALL IMPLIED WARRANTIES OF NONINFRINGEMENT,
00014 // MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE.
00015 //
00016 // Information and code furnished is believed to be accurate and reliable.
00017 // However, NVIDIA Corporation assumes no responsibility for the consequences of use of such
00018 // information or for any infringement of patents or other rights of third parties that may
00019 // result from its use. No license is granted by implication or otherwise under any patent
00020 // or patent rights of NVIDIA Corporation. Details are subject to change without notice.
00021 // This code supersedes and replaces all information previously supplied.
00022 // NVIDIA Corporation products are not authorized for use as critical
00023 // components in life support devices or systems without express written approval of
00024 // NVIDIA Corporation.
00025 //
00026 // Copyright (c) 2008-2017 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