PxMetaData.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_PHYSICS_METADATA_H
#define PX_PHYSICS_METADATA_H

#include "foundation/Px.h"
#include "PxMetaDataFlags.h"
#include "foundation/PxIO.h"

#ifndef PX_DOXYGEN
namespace physx
{
#endif

    struct PxMetaDataEntry
    {
        const char*     type;           
        const char*     name;           
        PxU32           offset;         
        PxU32           size;           
        PxU32           count;          
        PxU32           offsetSize;     
        PxU32           flags;          
        PxU32           alignment;      
    };

    #define PX_STORE_METADATA(stream, metaData) stream.write(&metaData, sizeof(PxMetaDataEntry))

    #define PX_DEF_BIN_METADATA_ITEM(stream, Class, type, name, flags) \
    { \
        PxMetaDataEntry tmp = { #type, #name, (PxU32)PX_OFFSET_OF(Class, name), PX_SIZE_OF(Class, name), \
                                1, 0, flags, 0}; \
        PX_STORE_METADATA(stream, tmp); \
    }

    #define PX_DEF_BIN_METADATA_ITEMS(stream, Class, type, name, flags, count) \
    { \
        PxMetaDataEntry tmp = { #type, #name, (PxU32)PX_OFFSET_OF(Class, name), PX_SIZE_OF(Class, name), \
                            count, 0, flags, 0}; \
        PX_STORE_METADATA(stream, tmp); \
    }

    #define PX_DEF_BIN_METADATA_ITEMS_AUTO(stream, Class, type, name, flags) \
    { \
        PxMetaDataEntry tmp = { #type, #name, (PxU32)PX_OFFSET_OF(Class, name), PX_SIZE_OF(Class, name), \
                            sizeof(((Class*)0)->name)/sizeof(type), 0, flags, 0}; \
                            PX_STORE_METADATA(stream, tmp); \
    }

    #define PX_DEF_BIN_METADATA_CLASS(stream, Class) \
    { \
        PxMetaDataEntry tmp = { #Class, 0, 0, sizeof(Class), 0, 0, PxMetaDataFlag::eCLASS, 0 }; \
        PX_STORE_METADATA(stream, tmp); \
    }

    #define PX_DEF_BIN_METADATA_VCLASS(stream, Class) \
    { \
        PxMetaDataEntry tmp = { #Class, 0, 0, sizeof(Class), 0, 0, PxMetaDataFlag::eCLASS|PxMetaDataFlag::eVIRTUAL, 0}; \
        PX_STORE_METADATA(stream, tmp); \
    }

    #define PX_DEF_BIN_METADATA_TYPEDEF(stream, newType, oldType) \
    { \
        PxMetaDataEntry tmp = { #newType, #oldType, 0, 0, 0, 0, PxMetaDataFlag::eTYPEDEF, 0 }; \
        PX_STORE_METADATA(stream, tmp); \
    }

    #define PX_DEF_BIN_METADATA_BASE_CLASS(stream, Class, BaseClass) \
    { \
        Class* myClass = reinterpret_cast<Class*>(42);                                                          \
        BaseClass* s = static_cast<BaseClass*>(myClass);                                                        \
        const PxU32 offset = PxU32(size_t(s) - size_t(myClass));                                                \
        PxMetaDataEntry tmp = { #Class, #BaseClass, offset, sizeof(Class), 0, 0, PxMetaDataFlag::eCLASS, 0 };   \
        PX_STORE_METADATA(stream, tmp);                                                                         \
    }

    #define PX_DEF_BIN_METADATA_UNION(stream, Class, name) \
    { \
        PxMetaDataEntry tmp = { #Class, 0, (PxU32)PX_OFFSET_OF(Class, name), PX_SIZE_OF(Class, name), \
                            1, 0, PxMetaDataFlag::eUNION, 0 }; \
        PX_STORE_METADATA(stream, tmp); \
    }

    #define PX_DEF_BIN_METADATA_UNION_TYPE(stream, Class, type, enumValue)  \
    { \
        PxMetaDataEntry tmp = { #Class, #type, enumValue, 0, 0, 0, PxMetaDataFlag::eUNION, 0 }; \
        PX_STORE_METADATA(stream, tmp); \
    }

    #define PX_DEF_BIN_METADATA_EXTRA_ITEM(stream, Class, type, control, align) \
    { \
        PxMetaDataEntry tmp = { #type, 0, (PxU32)PX_OFFSET_OF(Class, control), sizeof(type), 0, (PxU32)PX_SIZE_OF(Class, control), \
                            PxMetaDataFlag::eEXTRA_DATA|PxMetaDataFlag::eEXTRA_ITEM, align }; \
        PX_STORE_METADATA(stream, tmp); \
    }

    #define PX_DEF_BIN_METADATA_EXTRA_ITEMS(stream, Class, type, control, count, flags, align)  \
    { \
        PxMetaDataEntry tmp = { #type, 0, (PxU32)PX_OFFSET_OF(Class, control), (PxU32)PX_SIZE_OF(Class, control), \
                            (PxU32)PX_OFFSET_OF(Class, count), (PxU32)PX_SIZE_OF(Class, count), \
                            PxMetaDataFlag::eEXTRA_DATA|PxMetaDataFlag::eEXTRA_ITEMS|flags, align }; \
        PX_STORE_METADATA(stream, tmp); \
    }
    
    #define PX_DEF_BIN_METADATA_EXTRA_ITEMS_MASKED_CONTROL(stream, Class, type, control, controlMask ,count, flags, align) \
    { \
        PxMetaDataEntry tmp = { #type, 0, (PxU32)PX_OFFSET_OF(Class, control), (PxU32)PX_SIZE_OF(Class, control), \
                            (PxU32)PX_OFFSET_OF(Class, count), (PxU32)PX_SIZE_OF(Class, count), \
                            PxMetaDataFlag::eCONTROL_MASK|PxMetaDataFlag::eEXTRA_DATA|PxMetaDataFlag::eEXTRA_ITEMS|flags|(controlMask & PxMetaDataFlag::eCONTROL_MASK_RANGE) << 16, \
                            align}; \
        PX_STORE_METADATA(stream, tmp); \
    }

    #define PX_DEF_BIN_METADATA_EXTRA_ARRAY(stream, Class, type, dyn_count, align, flags) \
    { \
        PxMetaDataEntry tmp = { #type, 0, (PxU32)PX_OFFSET_OF(Class, dyn_count), PX_SIZE_OF(Class, dyn_count), align, 0, \
                            PxMetaDataFlag::eEXTRA_DATA|flags, align }; \
        PX_STORE_METADATA(stream, tmp); \
    }

    #define PX_DEF_BIN_METADATA_EXTRA_NAME(stream, Class, control, align) \
    { \
        PxMetaDataEntry tmp = { "char", "string", 0, 0, 0, 0, PxMetaDataFlag::eEXTRA_DATA|PxMetaDataFlag::eEXTRA_NAME, align }; \
        PX_STORE_METADATA(stream, tmp); \
    }
    
    #define PX_DEF_BIN_METADATA_EXTRA_ALIGN(stream, Class, align)   \
    { \
        PxMetaDataEntry tmp = { "PxU8", "Alignment", 0, 0, 0, 0, PxMetaDataFlag::eEXTRA_DATA|PxMetaDataFlag::eALIGNMENT, align}; \
        PX_STORE_METADATA(stream, tmp); \
    }

#ifndef PX_DOXYGEN
} // namespace physx
#endif

#endif