OgrePageContent.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_PageContent_H__
30 #define __Ogre_PageContent_H__
31 
33 
34 
35 
36 namespace Ogre
37 {
50  {
51  protected:
54  public:
56  virtual ~PageContent();
57 
60 
62  virtual void _notifyAttached(PageContentCollection* parent);
64  virtual const String& getType() const;
65 
67  virtual void save(StreamSerialiser& stream) = 0;
69  virtual void frameStart(Real timeSinceLastFrame) {}
71  virtual void frameEnd(Real timeElapsed) {}
73  virtual void notifyCamera(Camera* cam) {}
74 
76  virtual bool prepare(StreamSerialiser& ser) = 0;
78  virtual void load() = 0;
80  virtual void unload() = 0;
82  virtual void unprepare() = 0;
83 
84  };
85 
88 }
89 
90 #endif
#define _OgrePagingExport
Superclass for all objects that wish to use custom memory allocators when their new / delete operator...
A viewpoint from which the scene will be rendered.
Definition: OgreCamera.h:87
Definition of the interface for a collection of PageContent instances.
Define the interface to a factory class that will create subclasses of PageContent.
Interface definition for a unit of content within a page.
virtual void notifyCamera(Camera *cam)
Notify a section of the current camera.
PageContentFactory * mCreator
virtual void unload()=0
Unload - will be called in main thread.
virtual void _notifyAttached(PageContentCollection *parent)
Internal method to notify a page that it is attached.
virtual void frameEnd(Real timeElapsed)
Called when the frame ends.
SceneManager * getSceneManager() const
virtual const String & getType() const
Get the type of the content, which will match it's factory.
virtual void load()=0
Load - will be called in main thread.
PageContent(PageContentFactory *creator)
virtual void save(StreamSerialiser &stream)=0
Save the content to a stream.
PageManager * getManager() const
virtual void unprepare()=0
Unprepare data - may be called in the background.
virtual ~PageContent()
virtual void frameStart(Real timeSinceLastFrame)
Called when the frame starts.
PageContentCollection * mParent
virtual bool prepare(StreamSerialiser &ser)=0
Prepare data - may be called in the background.
The PageManager is the entry point through which you load all PagedWorld instances,...
Manages the organisation and rendering of a 'scene' i.e.
Utility class providing helper methods for reading / writing structured data held in a DataStream.
float Real
Software floating point type.
_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.