Revision control
- //
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// * Neither the name of NVIDIA CORPORATION nor the names of its
// contributors may be used to endorse or promote products derived
// from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ''AS IS'' AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
// OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
- // Copyright (c) 2008-2021 NVIDIA Corporation. All rights reserved.
+ // Copyright (c) 2008-2026 NVIDIA Corporation. All rights reserved.
// Copyright (c) 2004-2008 AGEIA Technologies, Inc. All rights reserved.
// Copyright (c) 2001-2004 NovodeX AG. All rights reserved.
+ #ifndef PX_BASE_H
+ #define PX_BASE_H
- #ifndef PX_PHYSICS_PX_BASE
- #define PX_PHYSICS_PX_BASE
-
- /** \addtogroup common
- @{
- */
#include "foundation/PxFlags.h"
+ #include "foundation/PxString.h"
+ #include "foundation/PxFoundation.h"
#include "common/PxSerialFramework.h"
#include "common/PxCollection.h"
#include "common/PxTypeInfo.h"
- #include <string.h> // For strcmp
+ #include "foundation/PxAssert.h"
+
+ #define PX_IS_KIND_OF(query, classname, baseclass) \
+ PX_ASSERT(query != NULL); \
+ if(query == NULL) \
+ { \
+ PxGetFoundation().error(PxErrorCode::eINVALID_PARAMETER, PX_FL, "isKindOf called with invalid string"); \
+ return false; \
+ } \
+ return !Pxstrcmp(classname, query) || baseclass::isKindOf(query)
#if !PX_DOXYGEN
namespace physx
{
#endif
typedef PxU16 PxType;
/**
\brief Flags for PxBase.
*/
struct PxBaseFlag
- {
+ {
enum Enum
{
- eOWNS_MEMORY = (1<<0),
- eIS_RELEASABLE = (1<<1)
+ eOWNS_MEMORY = (1<<0),
+ eIS_RELEASABLE = (1<<1)
};
};
typedef PxFlags<PxBaseFlag::Enum, PxU16> PxBaseFlags;
PX_FLAGS_OPERATORS(PxBaseFlag::Enum, PxU16)
/**
\brief Base class for objects that can be members of a PxCollection.
All PxBase sub-classes can be serialized.
- @see PxCollection
+ \see PxCollection
*/
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:
/**
\brief Releases the PxBase instance, please check documentation of release in derived class.
*/
- virtual void release() = 0;
+ virtual void release() = 0;
/**
\brief Returns string name of dynamic type.
\return Class name of most derived type of this object.
*/
- virtual const char* getConcreteTypeName() const = 0;
+ virtual const char* getConcreteTypeName() const = 0;
/* 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; }
+ 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; }
+ template<class T> const T* is() const { return typeMatch<T>() ? static_cast<const T*>(this) : NULL; }
/**
\brief Returns concrete type of object.
\return PxConcreteType::Enum of serialized object
- @see PxConcreteType
+ \see PxConcreteType
*/
- PX_FORCE_INLINE PxType getConcreteType() const { return mConcreteType; }
+ PX_FORCE_INLINE PxType getConcreteType() const { return mConcreteType; }
/**
\brief Set PxBaseFlag
\param[in] flag The flag to be set
\param[in] value The flags new value
*/
- PX_FORCE_INLINE void setBaseFlag(PxBaseFlag::Enum flag, bool value) { mBaseFlags = value ? mBaseFlags|flag : mBaseFlags&~flag; }
+ PX_FORCE_INLINE void setBaseFlag(PxBaseFlag::Enum flag, bool value) { mBaseFlags = value ? mBaseFlags|flag : mBaseFlags&~flag; }
/**
\brief Set PxBaseFlags
\param[in] inFlags The flags to be set
- @see PxBaseFlags
+ \see PxBaseFlags
*/
- PX_FORCE_INLINE void setBaseFlags(PxBaseFlags inFlags) { mBaseFlags = inFlags; }
+ PX_FORCE_INLINE void setBaseFlags(PxBaseFlags inFlags) { mBaseFlags = inFlags; }
/**
\brief Returns PxBaseFlags
\return PxBaseFlags
- @see PxBaseFlags
+ \see PxBaseFlags
*/
- PX_FORCE_INLINE PxBaseFlags getBaseFlags() const { return mBaseFlags; }
+ PX_FORCE_INLINE PxBaseFlags getBaseFlags() const { return mBaseFlags; }
/**
\brief Whether the object is subordinate.
A class is subordinate, if it can only be instantiated in the context of another class.
\return Whether the class is subordinate
- @see PxSerialization::isSerializable
+ \see PxSerialization::isSerializable
*/
- virtual bool isReleasable() const { return mBaseFlags & PxBaseFlag::eIS_RELEASABLE; }
+ virtual bool isReleasable() const { return mBaseFlags & PxBaseFlag::eIS_RELEASABLE; }
protected:
/**
\brief Constructor setting concrete type and base flags.
*/
- PX_INLINE PxBase(PxType concreteType, PxBaseFlags baseFlags)
- : mConcreteType(concreteType), mBaseFlags(baseFlags) {}
+ PX_INLINE PxBase(PxType concreteType, PxBaseFlags baseFlags)
+ : mConcreteType(concreteType), mBaseFlags(baseFlags), mBuiltInRefCount(1) {}
/**
\brief Deserialization constructor setting base flags.
*/
- PX_INLINE PxBase(PxBaseFlags baseFlags) : mBaseFlags(baseFlags) {}
-
+ PX_INLINE PxBase(PxBaseFlags baseFlags) : mBaseFlags(baseFlags)
+ {
+ PX_ASSERT(mBuiltInRefCount == 1);
+ }
/**
\brief Destructor.
*/
- virtual ~PxBase() {}
+ virtual ~PxBase() {}
/**
\brief Returns whether a given type name matches with the type of this instance
*/
- virtual bool isKindOf(const char* superClass) const { return !::strcmp(superClass, "PxBase"); }
+ virtual bool isKindOf(const char* superClass) const { return !Pxstrcmp(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());
- }
+ template<class T> bool typeMatch() const
+ {
+ return PxU32(PxTypeInfo<T>::eFastTypeId)!=PxU32(PxConcreteType::eUNDEFINED) ?
+ PxU32(getConcreteType()) == PxU32(PxTypeInfo<T>::eFastTypeId) : isKindOf(PxTypeInfo<T>::name());
+ }
+ protected:
+ PxType mConcreteType; // concrete type identifier - see PxConcreteType.
+ PxBaseFlags mBaseFlags; // internal flags
+ PxU32 mBuiltInRefCount;
+ };
+
+ /**
+ \brief Base class for ref-counted objects.
+ */
+ class PxRefCounted : public PxBase
+ {
+ public:
+
+ /**
+ \brief Decrements the reference count of the object and releases it if the new reference count is zero.
+ */
+ virtual void release() = 0;
+
+ /**
+ \brief Returns the reference count of the object.
+
+ At creation, the reference count of the object is 1. Every other object referencing this object increments the
+ count by 1. When the reference count reaches 0, and only then, the object gets destroyed automatically.
+
+ \return the current reference count.
+ */
+ virtual PxU32 getReferenceCount() const = 0;
+
+ /**
+ \brief Acquires a counted reference to this object.
- private:
- friend void getBinaryMetaData_PxBase(PxOutputStream& stream);
+ This method increases the reference count of the object by 1. Decrement the reference count by calling release()
+ */
+ virtual void acquireReference() = 0;
protected:
- PxType mConcreteType; // concrete type identifier - see PxConcreteType.
- PxBaseFlags mBaseFlags; // internal flags
+ virtual void onRefCountZero() { delete this; }
+ PX_INLINE PxRefCounted(PxType concreteType, PxBaseFlags baseFlags) : PxBase(concreteType, baseFlags) {}
+ PX_INLINE PxRefCounted(PxBaseFlags baseFlags) : PxBase(baseFlags) {}
+ virtual ~PxRefCounted() {}
+ virtual bool isKindOf(const char* name) const { PX_IS_KIND_OF(name, "PxRefCounted", PxBase); }
};
#if !PX_DOXYGEN
} // namespace physx
#endif
- /** @} */
#endif