| 1 | // |
|---|
| 2 | // Redistribution and use in source and binary forms, with or without |
|---|
| 3 | // modification, are permitted provided that the following conditions |
|---|
| 4 | // are met: |
|---|
| 5 | // * Redistributions of source code must retain the above copyright |
|---|
| 6 | // notice, this list of conditions and the following disclaimer. |
|---|
| 7 | // * Redistributions in binary form must reproduce the above copyright |
|---|
| 8 | // notice, this list of conditions and the following disclaimer in the |
|---|
| 9 | // documentation and/or other materials provided with the distribution. |
|---|
| 10 | // * Neither the name of NVIDIA CORPORATION nor the names of its |
|---|
| 11 | // contributors may be used to endorse or promote products derived |
|---|
| 12 | // from this software without specific prior written permission. |
|---|
| 13 | // |
|---|
| 14 | // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ''AS IS'' AND ANY |
|---|
| 15 | // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
|---|
| 16 | // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR |
|---|
| 17 | // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR |
|---|
| 18 | // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, |
|---|
| 19 | // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, |
|---|
| 20 | // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR |
|---|
| 21 | // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY |
|---|
| 22 | // OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
|---|
| 23 | // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
|---|
| 24 | // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
|---|
| 25 | // |
|---|
| 26 | // Copyright (c) 2008-2021 NVIDIA Corporation. All rights reserved. |
|---|
| 27 | // Copyright (c) 2004-2008 AGEIA Technologies, Inc. All rights reserved. |
|---|
| 28 | // Copyright (c) 2001-2004 NovodeX AG. All rights reserved. |
|---|
| 29 | |
|---|
| 30 | |
|---|
| 31 | #ifndef PX_PHYSICS_NX_DELETIONLISTENER |
|---|
| 32 | #define PX_PHYSICS_NX_DELETIONLISTENER |
|---|
| 33 | /** \addtogroup physics |
|---|
| 34 | @{ |
|---|
| 35 | */ |
|---|
| 36 | |
|---|
| 37 | #include "PxPhysXConfig.h" |
|---|
| 38 | #include "common/PxBase.h" |
|---|
| 39 | |
|---|
| 40 | #if !PX_DOXYGEN |
|---|
| 41 | namespace physx |
|---|
| 42 | { |
|---|
| 43 | #endif |
|---|
| 44 | |
|---|
| 45 | |
|---|
| 46 | /** |
|---|
| 47 | \brief Flags specifying deletion event types. |
|---|
| 48 | |
|---|
| 49 | @see PxDeletionListener::onRelease PxPhysics.registerDeletionListener() |
|---|
| 50 | */ |
|---|
| 51 | struct PxDeletionEventFlag |
|---|
| 52 | { |
|---|
| 53 | enum Enum |
|---|
| 54 | { |
|---|
| 55 | eUSER_RELEASE = (1<<0), //!< The user has called release on an object. |
|---|
| 56 | eMEMORY_RELEASE = (1<<1) //!< The destructor of an object has been called and the memory has been released. |
|---|
| 57 | }; |
|---|
| 58 | }; |
|---|
| 59 | |
|---|
| 60 | /** |
|---|
| 61 | \brief Collection of set bits defined in PxDeletionEventFlag. |
|---|
| 62 | |
|---|
| 63 | @see PxDeletionEventFlag |
|---|
| 64 | */ |
|---|
| 65 | typedef PxFlags<PxDeletionEventFlag::Enum,PxU8> PxDeletionEventFlags; |
|---|
| 66 | PX_FLAGS_OPERATORS(PxDeletionEventFlag::Enum,PxU8) |
|---|
| 67 | |
|---|
| 68 | |
|---|
| 69 | /** |
|---|
| 70 | \brief interface to get notification on object deletion |
|---|
| 71 | |
|---|
| 72 | */ |
|---|
| 73 | class PxDeletionListener |
|---|
| 74 | { |
|---|
| 75 | public: |
|---|
| 76 | /** |
|---|
| 77 | \brief Notification if an object or its memory gets released |
|---|
| 78 | |
|---|
| 79 | If release() gets called on a PxBase object, an eUSER_RELEASE event will get fired immediately. The object state can be queried in the callback but |
|---|
| 80 | it is not allowed to change the state. Furthermore, when reading from the object it is the user's responsibility to make sure that no other thread |
|---|
| 81 | is writing at the same time to the object (this includes the simulation itself, i.e., #PxScene::fetchResults() must not get called at the same time). |
|---|
| 82 | |
|---|
| 83 | Calling release() on a PxBase object does not necessarily trigger its destructor immediately. For example, the object can be shared and might still |
|---|
| 84 | be referenced by other objects or the simulation might still be running and accessing the object state. In such cases the destructor will be called |
|---|
| 85 | as soon as it is safe to do so. After the destruction of the object and its memory, an eMEMORY_RELEASE event will get fired. In this case it is not |
|---|
| 86 | allowed to dereference the object pointer in the callback. |
|---|
| 87 | |
|---|
| 88 | \param[in] observed The object for which the deletion event gets fired. |
|---|
| 89 | \param[in] userData The user data pointer of the object for which the deletion event gets fired. Not available for all object types in which case it will be set to 0. |
|---|
| 90 | \param[in] deletionEvent The type of deletion event. Do not dereference the object pointer argument if the event is eMEMORY_RELEASE. |
|---|
| 91 | |
|---|
| 92 | */ |
|---|
| 93 | virtual void onRelease(const PxBase* observed, void* userData, PxDeletionEventFlag::Enum deletionEvent) = 0; |
|---|
| 94 | |
|---|
| 95 | protected: |
|---|
| 96 | PxDeletionListener() {} |
|---|
| 97 | virtual ~PxDeletionListener() {} |
|---|
| 98 | }; |
|---|
| 99 | |
|---|
| 100 | |
|---|
| 101 | #if !PX_DOXYGEN |
|---|
| 102 | } // namespace physx |
|---|
| 103 | #endif |
|---|
| 104 | |
|---|
| 105 | /** @} */ |
|---|
| 106 | #endif |
|---|
| 107 | |
|---|
