| 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 | #ifndef PXFOUNDATION_PXERRORCALLBACK_H |
|---|
| 31 | #define PXFOUNDATION_PXERRORCALLBACK_H |
|---|
| 32 | |
|---|
| 33 | /** \addtogroup foundation |
|---|
| 34 | @{ |
|---|
| 35 | */ |
|---|
| 36 | |
|---|
| 37 | #include "foundation/PxErrors.h" |
|---|
| 38 | #if !PX_DOXYGEN |
|---|
| 39 | namespace physx |
|---|
| 40 | { |
|---|
| 41 | #endif |
|---|
| 42 | |
|---|
| 43 | /** |
|---|
| 44 | \brief User defined interface class. Used by the library to emit debug information. |
|---|
| 45 | |
|---|
| 46 | \note The SDK state should not be modified from within any error reporting functions. |
|---|
| 47 | |
|---|
| 48 | <b>Threading:</b> The SDK sequences its calls to the output stream using a mutex, so the class need not |
|---|
| 49 | be implemented in a thread-safe manner if the SDK is the only client. |
|---|
| 50 | */ |
|---|
| 51 | class PxErrorCallback |
|---|
| 52 | { |
|---|
| 53 | public: |
|---|
| 54 | virtual ~PxErrorCallback() |
|---|
| 55 | { |
|---|
| 56 | } |
|---|
| 57 | |
|---|
| 58 | /** |
|---|
| 59 | \brief Reports an error code. |
|---|
| 60 | \param code Error code, see #PxErrorCode |
|---|
| 61 | \param message Message to display. |
|---|
| 62 | \param file File error occured in. |
|---|
| 63 | \param line Line number error occured on. |
|---|
| 64 | */ |
|---|
| 65 | virtual void reportError(PxErrorCode::Enum code, const char* message, const char* file, int line) = 0; |
|---|
| 66 | }; |
|---|
| 67 | |
|---|
| 68 | #if !PX_DOXYGEN |
|---|
| 69 | } // namespace physx |
|---|
| 70 | #endif |
|---|
| 71 | |
|---|
| 72 | /** @} */ |
|---|
| 73 | #endif // #ifndef PXFOUNDATION_PXERRORCALLBACK_H |
|---|
| 74 | |
|---|
