OGRE: OgreRenderTargetListener.h Source File - OGRE Documentation

# OgreRenderTargetListener.h

Go to the documentation of this file.

    00001 /*
    00002 -----------------------------------------------------------------------------
    00003 This source file is part of OGRE
    00004     (Object-oriented Graphics Rendering Engine)
    00005 For the latest info, see http://www.ogre3d.org/
    00006
    00007 Copyright (c) 2000-2009 Torus Knot Software Ltd
    00008
    00009 Permission is hereby granted, free of charge, to any person obtaining a copy
    00010 of this software and associated documentation files (the "Software"), to deal
    00011 in the Software without restriction, including without limitation the rights
    00012 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    00013 copies of the Software, and to permit persons to whom the Software is
    00014 furnished to do so, subject to the following conditions:
    00015
    00016 The above copyright notice and this permission notice shall be included in
    00017 all copies or substantial portions of the Software.
    00018
    00019 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    00020 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    00021 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    00022 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    00023 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    00024 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    00025 THE SOFTWARE.
    00026 -----------------------------------------------------------------------------
    00027 */
    00028 #ifndef __RenderTargetListener_H__
    00029 #define __RenderTargetListener_H__
    00030
    00031
    00032 #include "OgrePrerequisites.h"
    00033
    00034 namespace Ogre {
    00035
    00044     struct RenderTargetEvent
    00045     {
    00047         RenderTarget* source;
    00048     };
    00049
    00052     struct RenderTargetViewportEvent
    00053     {
    00055         Viewport* source;
    00056     };
    00057
    00077     class _OgreExport RenderTargetListener
    00078     {
    00079         /*
    00080         Note that this could have been an abstract class, but I made
    00081         the explicit choice not to do this, because I wanted to give
    00082         people the option of only implementing the methods they wanted,
    00083         rather than having to create 'do nothing' implementations for
    00084         those they weren't interested in. As such this class follows
    00085         the 'Adapter' classes in Java rather than pure interfaces.
    00086         */
    00087     public:
    00088         virtual ~RenderTargetListener() {}
    00100         virtual void preRenderTargetUpdate(const RenderTargetEvent& evt)
    00101         { (void)evt; }
    00102
    00111         virtual void postRenderTargetUpdate(const RenderTargetEvent& evt)
    00112         { (void)evt; }
    00113
    00114         /* Called just before a Viewport on a RenderTarget is to be updated.
    00115         @remarks
    00116             This method is called before each viewport on the RenderTarget is
    00117             rendered to. You can use this to perform per-viewport settings changes,
    00118             such as showing / hiding particular overlays.
    00119         */
    00120         virtual void preViewportUpdate(const RenderTargetViewportEvent& evt)
    00121         { (void)evt; }
    00122
    00123         /* Called just after a Viewport on a RenderTarget is to be updated.
    00124         @remarks
    00125             This method is called after each viewport on the RenderTarget is
    00126             rendered to.
    00127         */
    00128         virtual void postViewportUpdate(const RenderTargetViewportEvent& evt)
    00129         { (void)evt; }
    00130
    00134         virtual void viewportAdded(const RenderTargetViewportEvent& evt)
    00135                 { (void)evt; }
    00139         virtual void viewportRemoved(const RenderTargetViewportEvent& evt)
    00140                 { (void)evt; }
    00141     };
    00144 }
    00145
    00146 #endif

Copyright © 2008 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.
Last modified Wed Nov 3 2010 19:24:52