[148] | 1 | /* |
---|
| 2 | ----------------------------------------------------------------------------- |
---|
| 3 | This source file is part of OGRE |
---|
| 4 | (Object-oriented Graphics Rendering Engine) |
---|
| 5 | For the latest info, see http://www.ogre3d.org/ |
---|
| 6 | |
---|
| 7 | Copyright (c) 2000-2013 Torus Knot Software Ltd |
---|
| 8 | |
---|
| 9 | Permission is hereby granted, free of charge, to any person obtaining a copy |
---|
| 10 | of this software and associated documentation files (the "Software"), to deal |
---|
| 11 | in the Software without restriction, including without limitation the rights |
---|
| 12 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
---|
| 13 | copies of the Software, and to permit persons to whom the Software is |
---|
| 14 | furnished to do so, subject to the following conditions: |
---|
| 15 | |
---|
| 16 | The above copyright notice and this permission notice shall be included in |
---|
| 17 | all copies or substantial portions of the Software. |
---|
| 18 | |
---|
| 19 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
---|
| 20 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
---|
| 21 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
---|
| 22 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
---|
| 23 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
---|
| 24 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
---|
| 25 | THE SOFTWARE. |
---|
| 26 | ----------------------------------------------------------------------------- |
---|
| 27 | */ |
---|
| 28 | #ifndef __CompositorLogic_H__ |
---|
| 29 | #define __CompositorLogic_H__ |
---|
| 30 | |
---|
| 31 | #include "OgrePrerequisites.h" |
---|
| 32 | |
---|
| 33 | namespace Ogre { |
---|
| 34 | /** \addtogroup Core |
---|
| 35 | * @{ |
---|
| 36 | */ |
---|
| 37 | /** \addtogroup Effects |
---|
| 38 | * @{ |
---|
| 39 | */ |
---|
| 40 | /** Interface for compositor logics, which can be automatically binded to compositors, |
---|
| 41 | * allowing per-compositor logic (such as attaching a relevant listener) to happen |
---|
| 42 | * automatically. |
---|
| 43 | * @remarks All methods have empty implementations to not force an implementer into |
---|
| 44 | * extending all of them. |
---|
| 45 | */ |
---|
| 46 | class _OgreExport CompositorLogic |
---|
| 47 | { |
---|
| 48 | public: |
---|
| 49 | /** Called when a compositor instance has been created. |
---|
| 50 | @remarks |
---|
| 51 | This happens after its setup was finished, so the chain is also accessible. |
---|
| 52 | This is an ideal method to automatically attach a compositor listener. |
---|
| 53 | */ |
---|
| 54 | virtual void compositorInstanceCreated(CompositorInstance* newInstance) {} |
---|
| 55 | |
---|
| 56 | /** Called when a compositor instance has been destroyed |
---|
| 57 | @remarks |
---|
| 58 | The chain that contained the compositor is still alive during this call. |
---|
| 59 | */ |
---|
| 60 | virtual void compositorInstanceDestroyed(CompositorInstance* destroyedInstance) {} |
---|
| 61 | |
---|
| 62 | virtual ~CompositorLogic() {} |
---|
| 63 | }; |
---|
| 64 | /** @} */ |
---|
| 65 | /** @} */ |
---|
| 66 | } |
---|
| 67 | |
---|
| 68 | #endif |
---|