OgreSimplePageContentCollection.h
Go to the documentation of this file.
/*
-----------------------------------------------------------------------------
This source file is part of OGRE
(Object-oriented Graphics Rendering Engine)
For the latest info, see http://www.ogre3d.org/
Copyright (c) 2000-2013 Torus Knot Software Ltd
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
-----------------------------------------------------------------------------
*/
#ifndef __Ogre_SimplePageContentCollection_H__
#define __Ogre_SimplePageContentCollection_H__
#include "OgrePagingPrerequisites.h"
#include "OgrePageContentCollection.h"
#include "OgrePageContentCollectionFactory.h"
namespace Ogre
{
class _OgrePagingExport SimplePageContentCollection : public PageContentCollection
{
public:
typedef vector<PageContent*>::type ContentList;
static const uint32 SUBCLASS_CHUNK_ID;
static const uint16 SUBCLASS_CHUNK_VERSION;
protected:
ContentList mContentList;
public:
SimplePageContentCollection(PageContentCollectionFactory* creator);
~SimplePageContentCollection();
virtual PageContent* createContent(const String& typeName);
virtual void destroyContent(PageContent* coll);
virtual const ContentList& getContentList() const { return mContentList; }
// Overridden from PageContentCollection
virtual void save(StreamSerialiser& stream);
virtual void frameStart(Real timeSinceLastFrame);
virtual void frameEnd(Real timeElapsed);
virtual void notifyCamera(Camera* cam);
bool prepare(StreamSerialiser& stream);
void load();
void unload();
void unprepare();
protected:
};
class _OgrePagingExport SimplePageContentCollectionFactory : public PageContentCollectionFactory
{
public:
static String FACTORY_NAME;
SimplePageContentCollectionFactory() {}
~SimplePageContentCollectionFactory() {}
const String& getName() const { return FACTORY_NAME; }
PageContentCollection* createInstance()
{
return OGRE_NEW SimplePageContentCollection(this);
}
void destroyInstance(PageContentCollection* c)
{
OGRE_DELETE c;
}
};
}
#endif
_OgrePagingExport
#define _OgrePagingExport
Definition: OgrePagingPrerequisites.h:72
OgrePageContentCollection.h
OGRE_DELETE
#define OGRE_DELETE
Definition: OgreMemoryAllocatorConfig.h:474
Ogre::PageContent
Interface definition for a unit of content within a page.
Definition: OgrePageContent.h:49
Ogre::Real
float Real
Software floating point type.
Definition: OgrePrerequisites.h:70
Ogre::PageContentCollectionFactory
Define the interface to a factory class that will create subclasses of PageContentCollection.
Definition: OgrePageContentCollectionFactory.h:47
OgrePagingPrerequisites.h
OGRE_NEW
#define OGRE_NEW
Definition: OgreMemoryAllocatorConfig.h:473
Ogre::SimplePageContentCollectionFactory::FACTORY_NAME
static String FACTORY_NAME
Definition: OgreSimplePageContentCollection.h:114
Ogre::SimplePageContentCollectionFactory::~SimplePageContentCollectionFactory
~SimplePageContentCollectionFactory()
Definition: OgreSimplePageContentCollection.h:117
Ogre::SimplePageContentCollectionFactory::SimplePageContentCollectionFactory
SimplePageContentCollectionFactory()
Definition: OgreSimplePageContentCollection.h:116
Ogre::PageContentCollection
Definition of the interface for a collection of PageContent instances.
Definition: OgrePageContentCollection.h:55
Ogre::SimplePageContentCollection
Specialisation of PageContentCollection which just provides a simple list of PageContent instances...
Definition: OgreSimplePageContentCollection.h:66
Ogre::String
_StringBase String
Definition: OgrePrerequisites.h:439
Ogre::SimplePageContentCollectionFactory::destroyInstance
void destroyInstance(PageContentCollection *c)
Definition: OgreSimplePageContentCollection.h:125
Ogre::SimplePageContentCollectionFactory::createInstance
PageContentCollection * createInstance()
Definition: OgreSimplePageContentCollection.h:121
Ogre::SimplePageContentCollectionFactory::getName
const String & getName() const
Definition: OgreSimplePageContentCollection.h:119
Ogre::SimplePageContentCollection::SUBCLASS_CHUNK_ID
static const uint32 SUBCLASS_CHUNK_ID
Definition: OgreSimplePageContentCollection.h:70
Ogre::StreamSerialiser
Utility class providing helper methods for reading / writing structured data held in a DataStream...
Definition: OgreStreamSerialiser.h:66
OgrePageContentCollectionFactory.h
Ogre::Camera
A viewpoint from which the scene will be rendered.
Definition: OgreCamera.h:86
Ogre::SimplePageContentCollection::getContentList
virtual const ContentList & getContentList() const
Get const access to the list of content.
Definition: OgreSimplePageContentCollection.h:90
Ogre::uint32
unsigned int uint32
Definition: OgrePlatform.h:359
Ogre
Definition: OgreAndroidLogListener.h:34
Ogre::vector
Definition: OgrePrerequisites.h:491
Ogre::SimplePageContentCollection::ContentList
vector< PageContent * >::type ContentList
Definition: OgreSimplePageContentCollection.h:69
Ogre::SimplePageContentCollection::mContentList
ContentList mContentList
Definition: OgreSimplePageContentCollection.h:73
Ogre::SimplePageContentCollectionFactory
Factory class for SimplePageContentCollection.
Definition: OgreSimplePageContentCollection.h:111
Ogre::SimplePageContentCollection::SUBCLASS_CHUNK_VERSION
static const uint16 SUBCLASS_CHUNK_VERSION
Definition: OgreSimplePageContentCollection.h:71
Ogre::uint16
unsigned short uint16
Definition: OgrePlatform.h:360

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