OgrePageContentCollection.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_PageContentCollection_H__
30 #define __Ogre_PageContentCollection_H__
31 
33 
34 
35 namespace Ogre
36 {
56  {
57  protected:
60  public:
61  static const uint32 CHUNK_ID;
62  static const uint16 CHUNK_VERSION;
63 
66 
68  Page* getParentPage() const { return mParent; }
70 
72  virtual const String& getType() const;
73 
75  virtual void _notifyAttached(Page* parent);
77  virtual void save(StreamSerialiser& stream) = 0;
79  virtual void frameStart(Real timeSinceLastFrame) = 0;
81  virtual void frameEnd(Real timeElapsed) = 0;
83  virtual void notifyCamera(Camera* cam) = 0;
84 
85 
87  virtual bool prepare(StreamSerialiser& ser) = 0;
89  virtual void load() = 0;
91  virtual void unload() = 0;
93  virtual void unprepare() = 0;
94 
95 
96  };
97 
98 
101 }
102 
103 #endif
Ogre::PageContentCollection::~PageContentCollection
virtual ~PageContentCollection()
Ogre::PageContentCollection::frameEnd
virtual void frameEnd(Real timeElapsed)=0
Called when the frame ends.
Ogre::PageContentCollection::PageContentCollection
PageContentCollection(PageContentCollectionFactory *creator)
Ogre::AllocatedObject
Superclass for all objects that wish to use custom memory allocators when their new / delete operator...
Definition: OgreMemoryAllocatedObject.h:59
Ogre
Definition: OgreAndroidLogListener.h:35
Ogre::PageContentCollection::unprepare
virtual void unprepare()=0
Unprepare data - may be called in the background.
Ogre::Camera
A viewpoint from which the scene will be rendered.
Definition: OgreCamera.h:87
Ogre::PageContentCollection::CHUNK_VERSION
static const uint16 CHUNK_VERSION
Definition: OgrePageContentCollection.h:62
Ogre::PageContentCollection::notifyCamera
virtual void notifyCamera(Camera *cam)=0
Notify a section of the current camera.
Ogre::PageContentCollection::getType
virtual const String & getType() const
Get the type of the collection, which will match it's factory.
OgrePagingPrerequisites.h
Ogre::PageContentCollection::getManager
PageManager * getManager() const
Ogre::uint16
unsigned short uint16
Definition: OgrePlatform.h:360
Ogre::PageManager
The PageManager is the entry point through which you load all PagedWorld instances,...
Definition: OgrePageManager.h:137
Ogre::PageContentCollection::getSceneManager
SceneManager * getSceneManager() const
Ogre::uint32
unsigned int uint32
Definition: OgrePlatform.h:359
Ogre::String
_StringBase String
Definition: OgrePrerequisites.h:439
Ogre::PageContentCollection::frameStart
virtual void frameStart(Real timeSinceLastFrame)=0
Called when the frame starts.
Ogre::PageContentCollection::mCreator
PageContentCollectionFactory * mCreator
Definition: OgrePageContentCollection.h:58
Ogre::SceneManager
Manages the organisation and rendering of a 'scene' i.e.
Definition: OgreSceneManager.h:144
Ogre::PageContentCollection
Definition of the interface for a collection of PageContent instances.
Definition: OgrePageContentCollection.h:56
Ogre::Page
Page class.
Definition: OgrePage.h:51
Ogre::PageContentCollection::getParentPage
Page * getParentPage() const
Definition: OgrePageContentCollection.h:68
Ogre::PageContentCollection::_notifyAttached
virtual void _notifyAttached(Page *parent)
Internal method to notify a collection that it is attached.
Ogre::PageContentCollection::mParent
Page * mParent
Definition: OgrePageContentCollection.h:59
Ogre::PageContentCollection::prepare
virtual bool prepare(StreamSerialiser &ser)=0
Prepare data - may be called in the background.
Ogre::StreamSerialiser
Utility class providing helper methods for reading / writing structured data held in a DataStream.
Definition: OgreStreamSerialiser.h:67
Ogre::PageContentCollection::unload
virtual void unload()=0
Unload - will be called in main thread.
Ogre::PageContentCollection::load
virtual void load()=0
Load - will be called in main thread.
Ogre::PageContentCollection::save
virtual void save(StreamSerialiser &stream)=0
Save the collection to a stream.
Ogre::Real
float Real
Software floating point type.
Definition: OgrePrerequisites.h:70
Ogre::PageContentCollection::CHUNK_ID
static const uint32 CHUNK_ID
Definition: OgrePageContentCollection.h:61
Ogre::PageContentCollectionFactory
Define the interface to a factory class that will create subclasses of PageContentCollection.
Definition: OgrePageContentCollectionFactory.h:48
_OgrePagingExport
#define _OgrePagingExport
Definition: OgrePagingPrerequisites.h:72

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