OgreRenderTargetListener.h
Go to the documentation of this file.
/*
-----------------------------------------------------------------------------
This source file is part of OGRE
(Object-oriented Graphics Rendering Engine)
For the latest info, see http://www.ogre3d.org/
Copyright (c) 2000-2013 Torus Knot Software Ltd
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
-----------------------------------------------------------------------------
*/
#ifndef __RenderTargetListener_H__
#define __RenderTargetListener_H__
#include "OgrePrerequisites.h"
namespace Ogre {
struct RenderTargetEvent
{
RenderTarget* source;
};
struct RenderTargetViewportEvent
{
Viewport* source;
};
class _OgreExport RenderTargetListener
{
/*
Note that this could have been an abstract class, but I made
the explicit choice not to do this, because I wanted to give
people the option of only implementing the methods they wanted,
rather than having to create 'do nothing' implementations for
those they weren't interested in. As such this class follows
the 'Adapter' classes in Java rather than pure interfaces.
*/
public:
virtual ~RenderTargetListener() {}
virtual void preRenderTargetUpdate(const RenderTargetEvent& evt)
{ (void)evt; }
virtual void postRenderTargetUpdate(const RenderTargetEvent& evt)
{ (void)evt; }
/* Called just before a Viewport on a RenderTarget is to be updated.
@remarks
This method is called before each viewport on the RenderTarget is
rendered to. You can use this to perform per-viewport settings changes,
such as showing / hiding particular overlays.
*/
virtual void preViewportUpdate(const RenderTargetViewportEvent& evt)
{ (void)evt; }
/* Called just after a Viewport on a RenderTarget is to be updated.
@remarks
This method is called after each viewport on the RenderTarget is
rendered to.
*/
virtual void postViewportUpdate(const RenderTargetViewportEvent& evt)
{ (void)evt; }
virtual void viewportAdded(const RenderTargetViewportEvent& evt)
{ (void)evt; }
virtual void viewportRemoved(const RenderTargetViewportEvent& evt)
{ (void)evt; }
};
}
#endif
Ogre::RenderTarget
A &#39;canvas&#39; which can receive the results of a rendering operation.
Definition: OgreRenderTarget.h:65
Ogre::RenderTargetListener::preViewportUpdate
virtual void preViewportUpdate(const RenderTargetViewportEvent &evt)
Definition: OgreRenderTargetListener.h:120
Ogre::RenderTargetEvent::source
RenderTarget * source
The source of the event being raised.
Definition: OgreRenderTargetListener.h:47
Ogre::RenderTargetListener::preRenderTargetUpdate
virtual void preRenderTargetUpdate(const RenderTargetEvent &evt)
Called just before a RenderTarget is about to be rendered into.
Definition: OgreRenderTargetListener.h:100
_OgreExport
#define _OgreExport
Definition: OgrePlatform.h:257
Ogre::RenderTargetListener::postRenderTargetUpdate
virtual void postRenderTargetUpdate(const RenderTargetEvent &evt)
Called just after a RenderTarget has been rendered to.
Definition: OgreRenderTargetListener.h:111
Ogre::RenderTargetViewportEvent::source
Viewport * source
The source of the event being raised.
Definition: OgreRenderTargetListener.h:55
Ogre::RenderTargetListener::~RenderTargetListener
virtual ~RenderTargetListener()
Definition: OgreRenderTargetListener.h:88
Ogre::Viewport
An abstraction of a viewport, i.e.
Definition: OgreViewport.h:57
OgrePrerequisites.h
Ogre::RenderTargetViewportEvent
Struct containing information about a RenderTarget Viewport-specific event.
Definition: OgreRenderTargetListener.h:52
Ogre::RenderTargetListener::viewportRemoved
virtual void viewportRemoved(const RenderTargetViewportEvent &evt)
Called to notify listener that a Viewport has been removed from the target in question.
Definition: OgreRenderTargetListener.h:139
Ogre
Definition: OgreAndroidLogListener.h:34
Ogre::RenderTargetListener::postViewportUpdate
virtual void postViewportUpdate(const RenderTargetViewportEvent &evt)
Definition: OgreRenderTargetListener.h:128
Ogre::RenderTargetEvent
Struct containing information about a RenderTarget event.
Definition: OgreRenderTargetListener.h:44
Ogre::RenderTargetListener
A interface class defining a listener which can be used to receive notifications of RenderTarget even...
Definition: OgreRenderTargetListener.h:77
Ogre::RenderTargetListener::viewportAdded
virtual void viewportAdded(const RenderTargetViewportEvent &evt)
Called to notify listener that a Viewport has been added to the target in question.
Definition: OgreRenderTargetListener.h:134

Copyright © 2012 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.