Main Page Namespace List Class Hierarchy Alphabetical List Compound List File List Namespace Members Compound Members File Members Related Pages

# 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 © 2000-2002 The OGRE Team
    00008 Also see acknowledgements in Readme.html
    00009
    00010 This program is free software; you can redistribute it and/or modify it under
    00011 the terms of the GNU Lesser General Public License as published by the Free Software
    00012 Foundation; either version 2 of the License, or (at your option) any later
    00013 version.
    00014
    00015 This program is distributed in the hope that it will be useful, but WITHOUT
    00016 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
    00017 FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
    00018
    00019 You should have received a copy of the GNU Lesser General Public License along with
    00020 this program; if not, write to the Free Software Foundation, Inc., 59 Temple
    00021 Place - Suite 330, Boston, MA 02111-1307, USA, or go to
    00022 http://www.gnu.org/copyleft/lesser.txt.
    00023 -----------------------------------------------------------------------------
    00024 */
    00025 #ifndef __RenderTargetListener_H__
    00026 #define __RenderTargetListener_H__
    00027
    00028
    00029 #include "OgrePrerequisites.h"
    00030
    00031 namespace Ogre {
    00032
    00035     struct RenderTargetEvent
    00036     {
    00038         RenderTarget* source;
    00039     };
    00040
    00043     struct RenderTargetViewportEvent
    00044     {
    00046         Viewport* source;
    00047     };
    00048
    00068     class _OgreExport RenderTargetListener
    00069     {
    00070         /*
    00071         Note that this could have been an abstract class, but I made
    00072         the explicit choice not to do this, because I wanted to give
    00073         people the option of only implementing the methods they wanted,
    00074         rather than having to create 'do nothing' implementations for
    00075         those they weren't interested in. As such this class follows
    00076         the 'Adapter' classes in Java rather than pure interfaces.
    00077         */
    00078     public:
    00090         virtual void preRenderTargetUpdate(const RenderTargetEvent& evt) { }
    00099         virtual void postRenderTargetUpdate(const RenderTargetEvent& evt) { }
    00100
    00101         /* Called just before a Viewport on a RenderTarget is to be updated.
    00102         @remarks
    00103             This method is called before each viewport on the RenderTarget is
    00104             rendered to. You can use this to perform per-viewport settings changes,
    00105             such as showing / hiding particular overlays.
    00106         */
    00107         virtual void preViewportUpdate(const RenderTargetViewportEvent& evt) { }
    00108
    00109         /* Called just after a Viewport on a RenderTarget is to be updated.
    00110         @remarks
    00111             This method is called after each viewport on the RenderTarget is
    00112             rendered to.
    00113         */
    00114         virtual void postViewportUpdate(const RenderTargetViewportEvent& evt) { }
    00115     };
    00116 }
    00117
    00118 #endif

Copyright © 2002-2003 by The OGRE Team
Last modified Sun Nov 28 19:48:42 2004