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 29 #ifndef __Ogre_PageContent_H__ 30 #define __Ogre_PageContent_H__ 31 32 #include "OgrePagingPrerequisites.h" 33 34 35 36 namespace Ogre 37 { 38 /** \addtogroup Optional 39 * @{ 40 */ 41 /** \addtogroup Paging 42 * Some details on paging component 43 * @{ 44 */ 45 46 47 /** Interface definition for a unit of content within a page. 48 */ 49 class _OgrePagingExport PageContent : public PageAlloc 50 { 51 protected: 52 PageContentFactory* mCreator; 53 PageContentCollection* mParent; 54 public: 55 PageContent(PageContentFactory* creator); 56 virtual ~PageContent(); 57 58 PageManager* getManager() const; 59 SceneManager* getSceneManager() const; 60 61 /// Internal method to notify a page that it is attached 62 virtual void _notifyAttached(PageContentCollection* parent); 63 /// Get the type of the content, which will match it's factory 64 virtual const String& getType() const; 65 66 /// Save the content to a stream 67 virtual void save(StreamSerialiser& stream) = 0; 68 /// Called when the frame starts frameStart(Real timeSinceLastFrame)69 virtual void frameStart(Real timeSinceLastFrame) {} 70 /// Called when the frame ends frameEnd(Real timeElapsed)71 virtual void frameEnd(Real timeElapsed) {} 72 /// Notify a section of the current camera notifyCamera(Camera * cam)73 virtual void notifyCamera(Camera* cam) {} 74 75 /// Prepare data - may be called in the background 76 virtual bool prepare(StreamSerialiser& ser) = 0; 77 /// Load - will be called in main thread 78 virtual void load() = 0; 79 /// Unload - will be called in main thread 80 virtual void unload() = 0; 81 /// Unprepare data - may be called in the background 82 virtual void unprepare() = 0; 83 84 }; 85 86 /** @} */ 87 /** @} */ 88 } 89 90 #endif 91