PxSerialization.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008-2015, NVIDIA CORPORATION.  All rights reserved.
 *
 * NVIDIA CORPORATION and its licensors retain all intellectual property
 * and proprietary rights in and to this software, related documentation
 * and any modifications thereto.  Any use, reproduction, disclosure or
 * distribution of this software and related documentation without an express
 * license agreement from NVIDIA CORPORATION is strictly prohibited.
 */
// Copyright (c) 2004-2008 AGEIA Technologies, Inc. All rights reserved.
// Copyright (c) 2001-2004 NovodeX AG. All rights reserved.  


#ifndef PX_SERIALIZATION_H
#define PX_SERIALIZATION_H

#include "PxPhysXConfig.h"
#include "common/PxBase.h"
#include "cooking/PxCooking.h"
#include "foundation/PxIO.h"
#include "common/PxTolerancesScale.h"
#include "common/PxTypeInfo.h"
#include "common/PxStringTable.h"

//
// Important: if you adjust the comment about binary compatible versions below, don't forget to adjust the compatibility list in
// sBinaryCompatibleVersionsbinary as well
//
#define PX_BINARY_SERIAL_VERSION 0


#ifndef PX_DOXYGEN
namespace physx
{
#endif

class PxSerialization
{
public:
    struct PxXmlMiscParameter
    {
        PxVec3              upVector;

        PxTolerancesScale   scale;
        
        PxXmlMiscParameter() : upVector(0) {}
        PxXmlMiscParameter(PxVec3& inUpVector, PxTolerancesScale inScale) : upVector(inUpVector), scale(inScale) {}
    };

    static  bool            isSerializable(PxCollection& collection, PxSerializationRegistry& sr, const PxCollection* externalReferences = NULL);

    static  void            complete(PxCollection& collection, PxSerializationRegistry& sr, const PxCollection* exceptFor = NULL, bool followJoints = false);
    
    static  void            createSerialObjectIds(PxCollection& collection, const PxSerialObjectId base);
            
    static  PxCollection*   createCollectionFromXml(PxInputData& inputData, PxCooking& cooking, PxSerializationRegistry& sr, const PxCollection* externalRefs = NULL, PxStringTable* stringTable = NULL, PxXmlMiscParameter* outArgs = NULL);
    
    static  PxCollection*   createCollectionFromBinary(void* memBlock, PxSerializationRegistry& sr, const PxCollection* externalRefs = NULL);

    static  bool            serializeCollectionToXml(PxOutputStream& outputStream, PxCollection& collection,  PxSerializationRegistry& sr, PxCooking* cooking = NULL, const PxCollection* externalRefs = NULL, PxXmlMiscParameter* inArgs = NULL);
    
    static  bool            serializeCollectionToBinary(PxOutputStream& outputStream, PxCollection& collection, PxSerializationRegistry& sr, const PxCollection* externalRefs = NULL, bool exportNames = false );

    static  void            dumpBinaryMetaData(PxOutputStream& outputStream, PxSerializationRegistry& sr);

    static PxBinaryConverter* createBinaryConverter();

    PX_DEPRECATED PX_INLINE PxBinaryConverter* createBinaryConverter(PxSerializationRegistry& ) { return createBinaryConverter(); }

    static PxSerializationRegistry* createSerializationRegistry(PxPhysics& physics);    
};

#ifndef PX_DOXYGEN
} // namespace physx
#endif

#endif