PxBase.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_PX_BASE
#define PX_PHYSICS_PX_BASE

#include "PxSerialFramework.h"
#include "PxCollection.h"

#ifndef PX_DOXYGEN
namespace physx
{
#endif

typedef PxU16 PxType;

struct PxBaseFlag
{   
    enum Enum
    {
        eOWNS_MEMORY            = (1<<0),
        eIS_RELEASABLE          = (1<<1)
    };
};

typedef PxFlags<PxBaseFlag::Enum, PxU16> PxBaseFlags;
PX_FLAGS_OPERATORS(PxBaseFlag::Enum, PxU16)


class PxBase
{
//= ATTENTION! =====================================================================================
// Changing the data layout of this class breaks the binary serialization format.  See comments for 
// PX_BINARY_SERIAL_VERSION.  If a modification is required, please adjust the getBinaryMetaData 
// function.  If the modification is made on a custom branch, please change PX_BINARY_SERIAL_VERSION
// accordingly.
//==================================================================================================
public:
    virtual     void                        release()                                       = 0;    

    virtual     const char*                 getConcreteTypeName() const                     { return NULL; }

    /* brief Implements dynamic cast functionality. 

    Example use:
    
    if(actor->is<PxRigidDynamic>()) {...}

    \return A pointer to the specified type if object matches, otherwise NULL
    */
    template<class T> T*                    is()                                            { return typeMatch<T>() ? static_cast<T*>(this) : NULL; }

    /* brief Implements dynamic cast functionality for const objects. 

    Example use:
    
    if(actor->is<PxRigidDynamic>()) {...}

    \return A pointer to the specified type if object matches, otherwise NULL
    */
    template<class T> const T*              is() const                                      { return typeMatch<T>() ? static_cast<const T*>(this) : NULL; }

    PX_INLINE   PxType                      getConcreteType() const                         { return mConcreteType; }
                
    PX_INLINE   void                        setBaseFlag(PxBaseFlag::Enum flag, bool value)  { mBaseFlags = value ? mBaseFlags|flag : mBaseFlags&~flag; }
    
    PX_INLINE   void                        setBaseFlags(PxBaseFlags inFlags )              { mBaseFlags = inFlags; }
    
    PX_INLINE   PxBaseFlags                 getBaseFlags() const                            { return mBaseFlags; }

    virtual     bool                        isReleasable() const                            { return mBaseFlags & PxBaseFlag::eIS_RELEASABLE; }

protected:
    PX_INLINE                               PxBase(PxType concreteType, PxBaseFlags baseFlags)
                                                : mConcreteType(concreteType), mBaseFlags(baseFlags) {}

    PX_INLINE                               PxBase(PxBaseFlags baseFlags) : mBaseFlags(baseFlags) {}

    virtual                                 ~PxBase()                                       {}

    virtual             bool                isKindOf(const char* superClass) const { return !strcmp(superClass, "PxBase"); }

    template<class T>   bool                typeMatch() const
                                            {
                                                return PxU32(PxTypeInfo<T>::eFastTypeId)!=PxU32(PxConcreteType::eUNDEFINED) ? 
                                                    PxU32(getConcreteType()) == PxU32(PxTypeInfo<T>::eFastTypeId) : isKindOf(PxTypeInfo<T>::name());
                                            }


private:
    friend              void                getBinaryMetaData_PxBase(PxOutputStream& stream);

protected:
    PxType                                  mConcreteType;          // concrete type identifier - see PxConcreteType.
    PxBaseFlags                             mBaseFlags;             // internal flags

};

#ifndef PX_DOXYGEN
} // namespace physx
#endif

#endif