/src/ogre/OgreMain/include/OgreFactoryObj.h
Line | Count | Source |
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-2014 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 _FactoryObj_H__ |
29 | | #define _FactoryObj_H__ |
30 | | |
31 | | #include "OgrePrerequisites.h" |
32 | | |
33 | | namespace Ogre { |
34 | | |
35 | | /** \addtogroup Core |
36 | | * @{ |
37 | | */ |
38 | | /** \addtogroup General |
39 | | * @{ |
40 | | */ |
41 | | /** Abstract factory class. Does nothing by itself, but derived classes can add |
42 | | functionality. |
43 | | */ |
44 | | template< typename T > class FactoryObj |
45 | | { |
46 | | public: |
47 | 264 | virtual ~FactoryObj() {} |
48 | | |
49 | | /** Returns the factory type. |
50 | | @return |
51 | | The factory type. |
52 | | */ |
53 | | virtual const String& getType() const = 0; |
54 | | |
55 | | /** Creates a new object. |
56 | | @param name Name of the object to create |
57 | | @return |
58 | | An object created by the factory. The type of the object depends on |
59 | | the factory. |
60 | | */ |
61 | | virtual T* createInstance(const String& name) = 0; |
62 | | /** Destroys an object which was created by this factory. |
63 | | @param ptr Pointer to the object to destroy |
64 | | */ |
65 | 264 | virtual void destroyInstance(T* ptr) { delete ptr; } |
66 | | }; |
67 | | |
68 | | /** @} */ |
69 | | /** @} */ |
70 | | } // namespace Ogre |
71 | | |
72 | | #endif // _FactoryObj_H__ |