OgreSimplePageContentCollection.h
Go to the documentation of this file.
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-2013 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 
29 #ifndef __Ogre_SimplePageContentCollection_H__
30 #define __Ogre_SimplePageContentCollection_H__
31 
35 
36 namespace Ogre
37 {
45 
46 
67  {
68  public:
70  static const uint32 SUBCLASS_CHUNK_ID;
72  protected:
74  public:
77 
81  virtual PageContent* createContent(const String& typeName);
82 
87  virtual void destroyContent(PageContent* coll);
88 
90  virtual const ContentList& getContentList() const { return mContentList; }
91 
92  // Overridden from PageContentCollection
93  virtual void save(StreamSerialiser& stream);
94  virtual void frameStart(Real timeSinceLastFrame);
95  virtual void frameEnd(Real timeElapsed);
96  virtual void notifyCamera(Camera* cam);
97  bool prepare(StreamSerialiser& stream);
98  void load();
99  void unload();
100  void unprepare();
101 
102  protected:
103 
104 
105 
106 
107  };
108 
109 
112  {
113  public:
115 
118 
119  const String& getName() const { return FACTORY_NAME; }
120 
122  {
124  }
126  {
127  OGRE_DELETE c;
128  }
129 
130 
131  };
132 
135 }
136 
137 #endif
#define _OgrePagingExport
A viewpoint from which the scene will be rendered.
Definition: OgreCamera.h:87
Define the interface to a factory class that will create subclasses of PageContentCollection.
Definition of the interface for a collection of PageContent instances.
Interface definition for a unit of content within a page.
Factory class for SimplePageContentCollection.
Specialisation of PageContentCollection which just provides a simple list of PageContent instances.
Utility class providing helper methods for reading / writing structured data held in a DataStream.
#define OGRE_NEW
#define OGRE_DELETE
void unload()
Unload - will be called in main thread.
virtual void destroyContent(PageContent *coll)
Destroy a PageContent within this page.
void unprepare()
Unprepare data - may be called in the background.
virtual void save(StreamSerialiser &stream)
Save the collection to a stream.
virtual PageContent * createContent(const String &typeName)
Create a new PageContent within this collection.
virtual void notifyCamera(Camera *cam)
Notify a section of the current camera.
virtual const ContentList & getContentList() const
Get const access to the list of content.
void load()
Load - will be called in main thread.
bool prepare(StreamSerialiser &stream)
Prepare data - may be called in the background.
virtual void frameStart(Real timeSinceLastFrame)
Called when the frame starts.
SimplePageContentCollection(PageContentCollectionFactory *creator)
virtual void frameEnd(Real timeElapsed)
Called when the frame ends.
float Real
Software floating point type.
unsigned short uint16
Definition: OgrePlatform.h:360
unsigned int uint32
Definition: OgrePlatform.h:359
_StringBase String

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