Crazy Eddie's GUI System  0.8.7
RenderEffectFactory.h
1 /***********************************************************************
2  created: Sat Dec 26 2009
3  author: Paul D Turner <paul@cegui.org.uk>
4 *************************************************************************/
5 /***************************************************************************
6  * Copyright (C) 2004 - 2009 Paul D Turner & The CEGUI Development Team
7  *
8  * Permission is hereby granted, free of charge, to any person obtaining
9  * a copy of this software and associated documentation files (the
10  * "Software"), to deal in the Software without restriction, including
11  * without limitation the rights to use, copy, modify, merge, publish,
12  * distribute, sublicense, and/or sell copies of the Software, and to
13  * permit persons to whom the Software is furnished to do so, subject to
14  * the following conditions:
15  *
16  * The above copyright notice and this permission notice shall be
17  * included in all copies or substantial portions of the Software.
18  *
19  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
20  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
21  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
22  * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
23  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
24  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
25  * OTHER DEALINGS IN THE SOFTWARE.
26  ***************************************************************************/
27 #ifndef _CEGUIRenderEffectFactory_h_
28 #define _CEGUIRenderEffectFactory_h_
29 
30 #include "CEGUI/RenderEffect.h"
31 
32 // Start of CEGUI namespace section
33 namespace CEGUI
34 {
40 class RenderEffectFactory : public
41  AllocatedObject<RenderEffectFactory>
42 {
43 public:
45  virtual ~RenderEffectFactory() {}
46 
48  virtual RenderEffect& create(Window* window) = 0;
49 
51  virtual void destroy(RenderEffect& effect) = 0;
52 };
53 
55 template <typename T>
57 {
58 public:
59  // Implement RenderEffectFactory interface
60  RenderEffect& create(Window* window);
61  void destroy(RenderEffect& effect);
62 };
63 
64 //---------------------------------------------------------------------------//
65 template <typename T>
67 {
68  return *CEGUI_NEW_AO T(window);
69 }
70 
71 //---------------------------------------------------------------------------//
72 template <typename T>
74 {
75  CEGUI_DELETE_AO &effect;
76 }
77 
78 //---------------------------------------------------------------------------//
79 
80 } // End of CEGUI namespace section
81 
82 #endif // end of guard _CEGUIRenderEffectFactory_h_
83 
Interface for objects that hook into RenderingWindow to affect the rendering process, thus allowing various effects to be achieved.
Definition: RenderEffect.h:40
Definition: MemoryAllocatedObject.h:109
Main namespace for Crazy Eddie's GUI Library.
Definition: arch_overview.dox:1
Interface for factory objects that create RenderEffect instances. Currently this interface is intende...
Definition: RenderEffectFactory.h:40
RenderEffect & create(Window *window)
Create an instance of the RenderEffect that this factory creates.
Definition: RenderEffectFactory.h:66
Templatised RenderEffectFactory subclass used internally by the system.
Definition: RenderEffectFactory.h:56
virtual void destroy(RenderEffect &effect)=0
Destroy an instance of the RenderEffect that this factory creates.
An abstract base class providing common functionality and specifying the required interface for deriv...
Definition: Window.h:149
virtual RenderEffect & create(Window *window)=0
Create an instance of the RenderEffect that this factory creates.
virtual ~RenderEffectFactory()
base class virtual destructor.
Definition: RenderEffectFactory.h:45
void destroy(RenderEffect &effect)
Destroy an instance of the RenderEffect that this factory creates.
Definition: RenderEffectFactory.h:73