diff options
| author | git perforce import user <a@b> | 2016-10-25 12:29:14 -0600 |
|---|---|---|
| committer | Sheikh Dawood Abdul Ajees <Sheikh Dawood Abdul Ajees> | 2016-10-25 18:56:37 -0500 |
| commit | 3dfe2108cfab31ba3ee5527e217d0d8e99a51162 (patch) | |
| tree | fa6485c169e50d7415a651bf838f5bcd0fd3bfbd /PxShared/include/foundation/PxFlags.h | |
| download | physx-3.4-3dfe2108cfab31ba3ee5527e217d0d8e99a51162.tar.xz physx-3.4-3dfe2108cfab31ba3ee5527e217d0d8e99a51162.zip | |
Initial commit:
PhysX 3.4.0 Update @ 21294896
APEX 1.4.0 Update @ 21275617
[CL 21300167]
Diffstat (limited to 'PxShared/include/foundation/PxFlags.h')
| -rw-r--r-- | PxShared/include/foundation/PxFlags.h | 375 |
1 files changed, 375 insertions, 0 deletions
diff --git a/PxShared/include/foundation/PxFlags.h b/PxShared/include/foundation/PxFlags.h new file mode 100644 index 00000000..0fa82783 --- /dev/null +++ b/PxShared/include/foundation/PxFlags.h @@ -0,0 +1,375 @@ +// This code contains NVIDIA Confidential Information and is disclosed to you +// under a form of NVIDIA software license agreement provided separately to you. +// +// Notice +// NVIDIA Corporation and its licensors retain all intellectual property and +// proprietary rights in and to this software and 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. +// +// ALL NVIDIA DESIGN SPECIFICATIONS, CODE ARE PROVIDED "AS IS.". NVIDIA MAKES +// NO WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO +// THE MATERIALS, AND EXPRESSLY DISCLAIMS ALL IMPLIED WARRANTIES OF NONINFRINGEMENT, +// MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE. +// +// Information and code furnished is believed to be accurate and reliable. +// However, NVIDIA Corporation assumes no responsibility for the consequences of use of such +// information or for any infringement of patents or other rights of third parties that may +// result from its use. No license is granted by implication or otherwise under any patent +// or patent rights of NVIDIA Corporation. Details are subject to change without notice. +// This code supersedes and replaces all information previously supplied. +// NVIDIA Corporation products are not authorized for use as critical +// components in life support devices or systems without express written approval of +// NVIDIA Corporation. +// +// Copyright (c) 2008-2016 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 PXFOUNDATION_PXFLAGS_H +#define PXFOUNDATION_PXFLAGS_H + +/** \addtogroup foundation + @{ +*/ + +#include "foundation/Px.h" + +#if !PX_DOXYGEN +namespace physx +{ +#endif +/** +\brief Container for bitfield flag variables associated with a specific enum type. + +This allows for type safe manipulation for bitfields. + +<h3>Example</h3> + // enum that defines each bit... + struct MyEnum + { + enum Enum + { + eMAN = 1, + eBEAR = 2, + ePIG = 4, + }; + }; + + // implements some convenient global operators. + PX_FLAGS_OPERATORS(MyEnum::Enum, uint8_t); + + PxFlags<MyEnum::Enum, uint8_t> myFlags; + myFlags |= MyEnum::eMAN; + myFlags |= MyEnum::eBEAR | MyEnum::ePIG; + if(myFlags & MyEnum::eBEAR) + { + doSomething(); + } +*/ + +template <typename enumtype, typename storagetype = uint32_t> +class PxFlags +{ + public: + typedef storagetype InternalType; + + PX_CUDA_CALLABLE PX_INLINE explicit PxFlags(const PxEMPTY) + { + } + PX_CUDA_CALLABLE PX_INLINE PxFlags(void); + PX_CUDA_CALLABLE PX_INLINE PxFlags(enumtype e); + PX_CUDA_CALLABLE PX_INLINE PxFlags(const PxFlags<enumtype, storagetype>& f); + PX_CUDA_CALLABLE PX_INLINE explicit PxFlags(storagetype b); + + PX_CUDA_CALLABLE PX_INLINE bool isSet(enumtype e) const; + PX_CUDA_CALLABLE PX_INLINE PxFlags<enumtype, storagetype>& set(enumtype e); + PX_CUDA_CALLABLE PX_INLINE bool operator==(enumtype e) const; + PX_CUDA_CALLABLE PX_INLINE bool operator==(const PxFlags<enumtype, storagetype>& f) const; + PX_CUDA_CALLABLE PX_INLINE bool operator==(bool b) const; + PX_CUDA_CALLABLE PX_INLINE bool operator!=(enumtype e) const; + PX_CUDA_CALLABLE PX_INLINE bool operator!=(const PxFlags<enumtype, storagetype>& f) const; + + PX_CUDA_CALLABLE PX_INLINE PxFlags<enumtype, storagetype>& operator=(const PxFlags<enumtype, storagetype>& f); + PX_CUDA_CALLABLE PX_INLINE PxFlags<enumtype, storagetype>& operator=(enumtype e); + + PX_CUDA_CALLABLE PX_INLINE PxFlags<enumtype, storagetype>& operator|=(enumtype e); + PX_CUDA_CALLABLE PX_INLINE PxFlags<enumtype, storagetype>& operator|=(const PxFlags<enumtype, storagetype>& f); + PX_CUDA_CALLABLE PX_INLINE PxFlags<enumtype, storagetype> operator|(enumtype e) const; + PX_CUDA_CALLABLE PX_INLINE PxFlags<enumtype, storagetype> operator|(const PxFlags<enumtype, storagetype>& f) const; + + PX_CUDA_CALLABLE PX_INLINE PxFlags<enumtype, storagetype>& operator&=(enumtype e); + PX_CUDA_CALLABLE PX_INLINE PxFlags<enumtype, storagetype>& operator&=(const PxFlags<enumtype, storagetype>& f); + PX_CUDA_CALLABLE PX_INLINE PxFlags<enumtype, storagetype> operator&(enumtype e) const; + PX_CUDA_CALLABLE PX_INLINE PxFlags<enumtype, storagetype> operator&(const PxFlags<enumtype, storagetype>& f) const; + + PX_CUDA_CALLABLE PX_INLINE PxFlags<enumtype, storagetype>& operator^=(enumtype e); + PX_CUDA_CALLABLE PX_INLINE PxFlags<enumtype, storagetype>& operator^=(const PxFlags<enumtype, storagetype>& f); + PX_CUDA_CALLABLE PX_INLINE PxFlags<enumtype, storagetype> operator^(enumtype e) const; + PX_CUDA_CALLABLE PX_INLINE PxFlags<enumtype, storagetype> operator^(const PxFlags<enumtype, storagetype>& f) const; + + PX_CUDA_CALLABLE PX_INLINE PxFlags<enumtype, storagetype> operator~(void) const; + + PX_CUDA_CALLABLE PX_INLINE operator bool(void) const; + PX_CUDA_CALLABLE PX_INLINE operator uint8_t(void) const; + PX_CUDA_CALLABLE PX_INLINE operator uint16_t(void) const; + PX_CUDA_CALLABLE PX_INLINE operator uint32_t(void) const; + + PX_CUDA_CALLABLE PX_INLINE void clear(enumtype e); + + public: + friend PX_INLINE PxFlags<enumtype, storagetype> operator&(enumtype a, PxFlags<enumtype, storagetype>& b) + { + PxFlags<enumtype, storagetype> out; + out.mBits = a & b.mBits; + return out; + } + + private: + storagetype mBits; +}; + +#define PX_FLAGS_OPERATORS(enumtype, storagetype) \ + PX_INLINE PxFlags<enumtype, storagetype> operator|(enumtype a, enumtype b) \ + { \ + PxFlags<enumtype, storagetype> r(a); \ + r |= b; \ + return r; \ + } \ + PX_INLINE PxFlags<enumtype, storagetype> operator&(enumtype a, enumtype b) \ + { \ + PxFlags<enumtype, storagetype> r(a); \ + r &= b; \ + return r; \ + } \ + PX_INLINE PxFlags<enumtype, storagetype> operator~(enumtype a) \ + { \ + return ~PxFlags<enumtype, storagetype>(a); \ + } + +#define PX_FLAGS_TYPEDEF(x, y) \ + typedef PxFlags<x::Enum, y> x##s; \ + PX_FLAGS_OPERATORS(x::Enum, y) + +template <typename enumtype, typename storagetype> +PX_INLINE PxFlags<enumtype, storagetype>::PxFlags(void) +{ + mBits = 0; +} + +template <typename enumtype, typename storagetype> +PX_INLINE PxFlags<enumtype, storagetype>::PxFlags(enumtype e) +{ + mBits = static_cast<storagetype>(e); +} + +template <typename enumtype, typename storagetype> +PX_INLINE PxFlags<enumtype, storagetype>::PxFlags(const PxFlags<enumtype, storagetype>& f) +{ + mBits = f.mBits; +} + +template <typename enumtype, typename storagetype> +PX_INLINE PxFlags<enumtype, storagetype>::PxFlags(storagetype b) +{ + mBits = b; +} + +template <typename enumtype, typename storagetype> +PX_INLINE bool PxFlags<enumtype, storagetype>::isSet(enumtype e) const +{ + return (mBits & static_cast<storagetype>(e)) == static_cast<storagetype>(e); +} + +template <typename enumtype, typename storagetype> +PX_INLINE PxFlags<enumtype, storagetype>& PxFlags<enumtype, storagetype>::set(enumtype e) +{ + mBits = static_cast<storagetype>(e); + return *this; +} + +template <typename enumtype, typename storagetype> +PX_INLINE bool PxFlags<enumtype, storagetype>::operator==(enumtype e) const +{ + return mBits == static_cast<storagetype>(e); +} + +template <typename enumtype, typename storagetype> +PX_INLINE bool PxFlags<enumtype, storagetype>::operator==(const PxFlags<enumtype, storagetype>& f) const +{ + return mBits == f.mBits; +} + +template <typename enumtype, typename storagetype> +PX_INLINE bool PxFlags<enumtype, storagetype>::operator==(bool b) const +{ + return bool(*this) == b; +} + +template <typename enumtype, typename storagetype> +PX_INLINE bool PxFlags<enumtype, storagetype>::operator!=(enumtype e) const +{ + return mBits != static_cast<storagetype>(e); +} + +template <typename enumtype, typename storagetype> +PX_INLINE bool PxFlags<enumtype, storagetype>::operator!=(const PxFlags<enumtype, storagetype>& f) const +{ + return mBits != f.mBits; +} + +template <typename enumtype, typename storagetype> +PX_INLINE PxFlags<enumtype, storagetype>& PxFlags<enumtype, storagetype>::operator=(enumtype e) +{ + mBits = static_cast<storagetype>(e); + return *this; +} + +template <typename enumtype, typename storagetype> +PX_INLINE PxFlags<enumtype, storagetype>& PxFlags<enumtype, storagetype>::operator=(const PxFlags<enumtype, storagetype>& f) +{ + mBits = f.mBits; + return *this; +} + +template <typename enumtype, typename storagetype> +PX_INLINE PxFlags<enumtype, storagetype>& PxFlags<enumtype, storagetype>::operator|=(enumtype e) +{ + mBits |= static_cast<storagetype>(e); + return *this; +} + +template <typename enumtype, typename storagetype> +PX_INLINE PxFlags<enumtype, storagetype>& PxFlags<enumtype, storagetype>:: +operator|=(const PxFlags<enumtype, storagetype>& f) +{ + mBits |= f.mBits; + return *this; +} + +template <typename enumtype, typename storagetype> +PX_INLINE PxFlags<enumtype, storagetype> PxFlags<enumtype, storagetype>::operator|(enumtype e) const +{ + PxFlags<enumtype, storagetype> out(*this); + out |= e; + return out; +} + +template <typename enumtype, typename storagetype> +PX_INLINE PxFlags<enumtype, storagetype> PxFlags<enumtype, storagetype>:: +operator|(const PxFlags<enumtype, storagetype>& f) const +{ + PxFlags<enumtype, storagetype> out(*this); + out |= f; + return out; +} + +template <typename enumtype, typename storagetype> +PX_INLINE PxFlags<enumtype, storagetype>& PxFlags<enumtype, storagetype>::operator&=(enumtype e) +{ + mBits &= static_cast<storagetype>(e); + return *this; +} + +template <typename enumtype, typename storagetype> +PX_INLINE PxFlags<enumtype, storagetype>& PxFlags<enumtype, storagetype>:: +operator&=(const PxFlags<enumtype, storagetype>& f) +{ + mBits &= f.mBits; + return *this; +} + +template <typename enumtype, typename storagetype> +PX_INLINE PxFlags<enumtype, storagetype> PxFlags<enumtype, storagetype>::operator&(enumtype e) const +{ + PxFlags<enumtype, storagetype> out = *this; + out.mBits &= static_cast<storagetype>(e); + return out; +} + +template <typename enumtype, typename storagetype> +PX_INLINE PxFlags<enumtype, storagetype> PxFlags<enumtype, storagetype>:: +operator&(const PxFlags<enumtype, storagetype>& f) const +{ + PxFlags<enumtype, storagetype> out = *this; + out.mBits &= f.mBits; + return out; +} + +template <typename enumtype, typename storagetype> +PX_INLINE PxFlags<enumtype, storagetype>& PxFlags<enumtype, storagetype>::operator^=(enumtype e) +{ + mBits ^= static_cast<storagetype>(e); + return *this; +} + +template <typename enumtype, typename storagetype> +PX_INLINE PxFlags<enumtype, storagetype>& PxFlags<enumtype, storagetype>:: +operator^=(const PxFlags<enumtype, storagetype>& f) +{ + mBits ^= f.mBits; + return *this; +} + +template <typename enumtype, typename storagetype> +PX_INLINE PxFlags<enumtype, storagetype> PxFlags<enumtype, storagetype>::operator^(enumtype e) const +{ + PxFlags<enumtype, storagetype> out = *this; + out.mBits ^= static_cast<storagetype>(e); + return out; +} + +template <typename enumtype, typename storagetype> +PX_INLINE PxFlags<enumtype, storagetype> PxFlags<enumtype, storagetype>:: +operator^(const PxFlags<enumtype, storagetype>& f) const +{ + PxFlags<enumtype, storagetype> out = *this; + out.mBits ^= f.mBits; + return out; +} + +template <typename enumtype, typename storagetype> +PX_INLINE PxFlags<enumtype, storagetype> PxFlags<enumtype, storagetype>::operator~(void) const +{ + PxFlags<enumtype, storagetype> out; + out.mBits = storagetype(~mBits); + return out; +} + +template <typename enumtype, typename storagetype> +PX_INLINE PxFlags<enumtype, storagetype>::operator bool(void) const +{ + return mBits ? true : false; +} + +template <typename enumtype, typename storagetype> +PX_INLINE PxFlags<enumtype, storagetype>::operator uint8_t(void) const +{ + return static_cast<uint8_t>(mBits); +} + +template <typename enumtype, typename storagetype> +PX_INLINE PxFlags<enumtype, storagetype>::operator uint16_t(void) const +{ + return static_cast<uint16_t>(mBits); +} + +template <typename enumtype, typename storagetype> +PX_INLINE PxFlags<enumtype, storagetype>::operator uint32_t(void) const +{ + return static_cast<uint32_t>(mBits); +} + +template <typename enumtype, typename storagetype> +PX_INLINE void PxFlags<enumtype, storagetype>::clear(enumtype e) +{ + mBits &= ~static_cast<storagetype>(e); +} + +#if !PX_DOXYGEN +} // namespace physx +#endif + +/** @} */ +#endif // #ifndef PXFOUNDATION_PXFLAGS_H |