Holds all the data associated with a Binary Space Parition (BSP) based indoor level. More...

#include <OgreBspLevel.h>

Inheritance diagram for Ogre::BspLevel:

Collaboration diagram for Ogre::BspLevel:

Classes
struct	BspVertex
	Vertex format for fixed geometry. More...

struct	VisData
	Internal lookup table to determine visibility between leaves. More...

Public Types
enum	LoadingState { LOADSTATE_UNLOADED, LOADSTATE_LOADING, LOADSTATE_LOADED, LOADSTATE_UNLOADING, LOADSTATE_PREPARED, LOADSTATE_PREPARING }
	Enum identifying the loading state of the resource. More...

Public Member Functions
	BspLevel (ResourceManager creator, const String &name, ResourceHandle handle, const String &group, bool isManual=false, ManualResourceLoader loader=0)
	Default constructor - used by BspResourceManager (do not call directly) More...

	~BspLevel ()

virtual void	_dirtyState ()
	Manually mark the state of this resource as having been changed. More...

virtual void	_fireLoadingComplete (bool wasBackgroundLoaded)
	Firing of loading complete event. More...

virtual void	_firePreparingComplete (bool wasBackgroundLoaded)
	Firing of preparing complete event. More...

virtual void	_fireUnloadingComplete (void)
	Firing of unloading complete event. More...

void	_notifyObjectDetached (const MovableObject *mov)
	Internal method, makes sure an object is removed from the leaves when detached from a node. More...

void	_notifyObjectMoved (const MovableObject *mov, const Vector3 &pos)
	Ensures that the MovableObject is attached to the right leaves of the BSP tree. More...

virtual void	_notifyOrigin (const String &origin)
	Notify this resource of it's origin. More...

virtual void	addListener (Listener *lis)
	Register a listener on this resource. More...

virtual void	changeGroupOwnership (const String &newGroup)
	Change the resource group ownership of a Resource. More...

virtual void	copyParametersTo (StringInterface *dest) const
	Method for copying this object's parameters to another object. More...

virtual void	escalateLoading ()
	Escalates the loading of a background loaded resource. More...

BspNode *	findLeaf (const Vector3 &point) const
	Walks the entire BSP tree and returns the leaf which contains the given point. More...

virtual ResourceManager *	getCreator (void)
	Gets the manager which created this resource. More...

virtual const String &	getGroup (void)
	Gets the group which this resource is a member of. More...

virtual ResourceHandle	getHandle (void) const

BspNode *	getLeafStart (void)
	Gets a pointer to the start of the leaf nodes. More...

virtual LoadingState	getLoadingState () const
	Returns the current loading state. More...

virtual const String &	getName (void) const
	Gets resource name. More...

int	getNumLeaves (void) const
	Gets the number of leaf nodes. More...

virtual const String &	getOrigin (void) const
	Get the origin of this resource, e.g. More...

ParamDictionary *	getParamDictionary (void)
	Retrieves the parameter dictionary for this class. More...

const ParamDictionary *	getParamDictionary (void) const

virtual String	getParameter (const String &name) const
	Generic parameter retrieval method. More...

const ParameterList &	getParameters (void) const
	Retrieves a list of parameters valid for this object. More...

const BspNode *	getRootNode (void)
	Returns a pointer to the root node (BspNode) of the BSP tree. More...

virtual size_t	getSize (void) const
	Retrieves info about the size of the resource. More...

Real	getSkyCurvature (void) const
	Get sky curvature. More...

const String &	getSkyMaterialName (void) const
	Get Sky material name. More...

virtual size_t	getStateCount () const
	Returns the number of times this resource has changed state, which generally means the number of times it has been loaded. More...

virtual bool	isBackgroundLoaded (void) const
	Returns whether this Resource has been earmarked for background loading. More...

bool	isLeafVisible (const BspNode from, const BspNode to) const
	Determines if one leaf node is visible from another. More...

virtual bool	isLoaded (void) const
	Returns true if the Resource has been loaded, false otherwise. More...

virtual bool	isLoading () const
	Returns whether the resource is currently in the process of background loading. More...

virtual bool	isManuallyLoaded (void) const
	Is this resource manually loaded? More...

virtual bool	isPrepared (void) const
	Returns true if the Resource has been prepared, false otherwise. More...

virtual bool	isReloadable (void) const
	Returns true if the Resource is reloadable, false otherwise. More...

bool	isSkyEnabled (void) const
	Is sky enabled? More...

void	load (DataStreamPtr &stream)
	Load direct from stream. More...

virtual void	load (bool backgroundThread=false)
	Loads the resource, if it is not already. More...

void	operator delete (void *ptr)

void	operator delete (void ptr, void )

void	operator delete (void ptr, const char , int, const char *)

void	operator delete[] (void *ptr)

void	operator delete[] (void ptr, const char , int, const char *)

void *	operator new (size_t sz, const char file, int line, const char func)
	operator new, with debug line info More...

void *	operator new (size_t sz)

void *	operator new (size_t sz, void *ptr)
	placement operator new More...

void *	operator new[] (size_t sz, const char file, int line, const char func)
	array operator new, with debug line info More...

void *	operator new[] (size_t sz)

virtual void	prepare (bool backgroundThread=false)
	Prepares the resource for load, if it is not already. More...

virtual void	reload (void)
	Reloads the resource, if it is already loaded. More...

virtual void	removeListener (Listener *lis)
	Remove a listener on this resource. More...

virtual void	setBackgroundLoaded (bool bl)
	Tells the resource whether it is background loaded or not. More...

virtual bool	setParameter (const String &name, const String &value)
	Generic parameter setting method. More...

virtual void	setParameterList (const NameValuePairList &paramList)
	Generic multiple parameter setting method. More...

virtual void	touch (void)
	'Touches' the resource to indicate it has been used. More...

virtual void	unload (void)
	Unloads the resource; this is not permanent, the resource can be reloaded later if required. More...

Static Public Member Functions
static size_t	calculateLoadingStages (const String &levelName)
	Calculate the number of loading stages required for a given level. More...

static size_t	calculateLoadingStages (DataStreamPtr &stream)
	Calculate the number of loading stages required for a given level. More...

static void	cleanupDictionary ()
	Cleans up the static 'msDictionary' required to reset Ogre, otherwise the containers are left with invalid pointers, which will lead to a crash as soon as one of the ResourceManager implementers (e.g. More...

Protected Types
typedef list< Listener * >::type	ListenerList

typedef map< const MovableObject , list< BspNode > ::type >::type	MovableToNodeMap

typedef map< int, PatchSurface * > ::type	PatchMap

Protected Member Functions
void	buildQuake3Patches (size_t vertOffset, size_t indexOffset)

size_t	calculateSize (void) const

bool	createParamDictionary (const String &className)
	Internal method for creating a parameter dictionary for the class, if it does not already exist. More...

void	initQuake3Patches (const Quake3Level &q3lvl, VertexDeclaration *decl)

void	loadEntities (const Quake3Level &q3lvl)
	Internal method for parsing chosen entities. More...

void	loadImpl (void)
	Utility class just to enable queueing of patches. More...

void	loadQuake3Level (const Quake3Level &q3lvl)
	Internal utility function for loading data from Quake3. More...

virtual void	postLoadImpl (void)
	Internal hook to perform actions after the load process, but before the resource has been marked as fully loaded. More...

virtual void	postUnloadImpl (void)
	Internal hook to perform actions after the unload process, but before the resource has been marked as fully unloaded. More...

virtual void	preLoadImpl (void)
	Internal hook to perform actions before the load process, but after the resource has been marked as 'loading'. More...

virtual void	prepareImpl (void)
	Internal implementation of the meat of the 'prepare' action. More...

virtual void	preUnloadImpl (void)
	Internal hook to perform actions before the unload process. More...

void	quakeVertexToBspVertex (const bsp_vertex_t src, BspVertex dest)

void	tagNodesWithMovable (BspNode node, const MovableObject mov, const Vector3 &pos)

void	unloadImpl (void)

virtual void	unprepareImpl (void)
	Internal function for undoing the 'prepare' action. More...

Protected Attributes
BspNode::Brush *	mBrushes
	Brushes as used for collision, main memory is here. More...

ResourceManager *	mCreator
	Creator. More...

StaticFaceGroup *	mFaceGroups
	Array of face groups, indexed into by contents of mLeafFaceGroups. More...

String	mGroup
	The name of the resource group. More...

ResourceHandle	mHandle
	Numeric handle for more efficient look up than name. More...

HardwareIndexBufferSharedPtr	mIndexes

volatile bool	mIsBackgroundLoaded
	Is this resource going to be background loaded? Only applicable for multithreaded. More...

bool	mIsManual
	Is this file manually loaded? More...

int *	mLeafFaceGroups
	Array of indexes into the mFaceGroups array. More...

int	mLeafStart

ListenerList	mListenerList

ManualResourceLoader *	mLoader
	Optional manual loader; if provided, data is loaded from here instead of a file. More...

AtomicScalar< LoadingState >	mLoadingState
	Is the resource currently loaded? More...

MovableToNodeMap	mMovableToNodeMap
	Map for locating the nodes a movable is currently a member of. More...

String	mName
	Unique name of the resource. More...

int	mNumBrushes

int	mNumFaceGroups

size_t	mNumIndexes
	indexes for the whole level, will be copied to the real indexdata per frame More...

int	mNumLeafFaceGroups

int	mNumLeaves

int	mNumNodes

String	mOrigin
	Origin of this resource (e.g. script name) - optional. More...

PatchMap	mPatches

size_t	mPatchIndexCount

size_t	mPatchVertexCount

vector< ViewPoint >::type	mPlayerStarts
	Vector of player start points. More...

BspNode *	mRootNode
	Pointer to the root node of the BSP tree; This pointer actually has a dual purpose; to avoid allocating lots of small chunks of memory, the BspLevel actually allocates all nodes required through this pointer. More...

size_t	mSize
	The size of the resource in bytes. More...

Real	mSkyCurvature

bool	mSkyEnabled

String	mSkyMaterial

size_t	mStateCount
	State count, the number of times this resource has changed state. More...

VertexData *	mVertexData
	Vertex data holding all the data for the level, but able to render parts of it. More...

VisData	mVisData

Friends
class	BspSceneManager

Detailed Description

Holds all the data associated with a Binary Space Parition (BSP) based indoor level.

The data used here is populated by loading level files via the BspLevelManager::load method, although application users are more likely to call SceneManager::setWorldGeometry which will automatically arrange the loading of the level. Note that this assumes that you have asked for an indoor-specialised SceneManager (specify ST_INDOOR when calling Root::getSceneManager).

Ogre currently only supports loading from Quake3 Arena level files, although any source that can be converted into this classes structure could also be used. The Quake3 level load process is in a different class called Quake3Level to keep the specifics separate.

Definition at line 56 of file OgreBspLevel.h.

Member Typedef Documentation

typedef list<Listener*>::type Ogre::Resource::ListenerList

protectedinherited

Definition at line 164 of file OgreResource.h.

typedef map<const MovableObject*, list<BspNode*>::type >::type Ogre::BspLevel::MovableToNodeMap

protected

Definition at line 204 of file OgreBspLevel.h.

typedef map<int, PatchSurface*>::type Ogre::BspLevel::PatchMap

protected

Definition at line 211 of file OgreBspLevel.h.

Member Enumeration Documentation

enum Ogre::Resource::LoadingState

inherited

Enum identifying the loading state of the resource.

Enumerator
LOADSTATE_UNLOADED	Not loaded.
LOADSTATE_LOADING	Loading is in progress.
LOADSTATE_LOADED	Fully loaded.
LOADSTATE_UNLOADING	Currently unloading.
LOADSTATE_PREPARED	Fully prepared.
LOADSTATE_PREPARING	Preparing is in progress.

Definition at line 125 of file OgreResource.h.

Constructor & Destructor Documentation

Ogre::BspLevel::BspLevel	(	ResourceManager *	creator,
		const String &	name,
		ResourceHandle	handle,
		const String &	group,
		bool	isManual = `false`,
		ManualResourceLoader *	loader = `0`
	)

Default constructor - used by BspResourceManager (do not call directly)

Ogre::BspLevel::~BspLevel ( )

Member Function Documentation

virtual void Ogre::Resource::_dirtyState ( )

virtualinherited

Manually mark the state of this resource as having been changed.

Remarks: You only need to call this from outside if you explicitly want derived objects to think this object has changed.

See also: getStateCount.

virtual void Ogre::Resource::_fireLoadingComplete ( bool wasBackgroundLoaded )

virtualinherited

Firing of loading complete event.

Remarks: You should call this from the thread that runs the main frame loop to avoid having to make the receivers of this event thread-safe. If you use Ogre's built in frame loop you don't need to call this yourself.

Parameters

wasBackgroundLoaded Whether this was a background loaded event

virtual void Ogre::Resource::_firePreparingComplete ( bool wasBackgroundLoaded )

virtualinherited

Firing of preparing complete event.

Remarks: You should call this from the thread that runs the main frame loop to avoid having to make the receivers of this event thread-safe. If you use Ogre's built in frame loop you don't need to call this yourself.

Parameters

wasBackgroundLoaded Whether this was a background loaded event

virtual void Ogre::Resource::_fireUnloadingComplete ( void )

virtualinherited

Firing of unloading complete event.

Remarks: You should call this from the thread that runs the main frame loop to avoid having to make the receivers of this event thread-safe. If you use Ogre's built in frame loop you don't need to call this yourself.

void Ogre::BspLevel::_notifyObjectDetached ( const MovableObject * mov )

Internal method, makes sure an object is removed from the leaves when detached from a node.

void Ogre::BspLevel::_notifyObjectMoved	(	const MovableObject *	mov,
		const Vector3 &	pos
	)

Ensures that the MovableObject is attached to the right leaves of the BSP tree.

virtual void Ogre::Resource::_notifyOrigin ( const String & origin )

inlinevirtualinherited

Notify this resource of it's origin.

Definition at line 420 of file OgreResource.h.

virtual void Ogre::Resource::addListener ( Listener * lis )

virtualinherited

Register a listener on this resource.

See also: Resource::Listener

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

void Ogre::BspLevel::buildQuake3Patches	(	size_t	vertOffset,
		size_t	indexOffset
	)

protected

static size_t Ogre::BspLevel::calculateLoadingStages ( const String & levelName )

static

Calculate the number of loading stages required for a given level.

static size_t Ogre::BspLevel::calculateLoadingStages ( DataStreamPtr & stream )

static

Calculate the number of loading stages required for a given level.

size_t Ogre::BspLevel::calculateSize ( void ) const

protectedvirtual

Implements Ogre::Resource.

virtual void Ogre::Resource::changeGroupOwnership ( const String & newGroup )

virtualinherited

Change the resource group ownership of a Resource.

Remarks: This method is generally reserved for internal use, although if you really know what you're doing you can use it to move this resource from one group to another.

Parameters

newGroup Name of the new group

static void Ogre::StringInterface::cleanupDictionary ( )

staticinherited

Cleans up the static 'msDictionary' required to reset Ogre, otherwise the containers are left with invalid pointers, which will lead to a crash as soon as one of the ResourceManager implementers (e.g.

MaterialManager) initializes.

virtual void Ogre::StringInterface::copyParametersTo ( StringInterface * dest ) const

inlinevirtualinherited

Method for copying this object's parameters to another object.

Remarks: This method takes the values of all the object's parameters and tries to set the same values on the destination object. This provides a completely type independent way to copy parameters to other objects. Note that because of the String manipulation involved, this should not be regarded as an efficient process and should be saved for times outside of the rendering loop.

: Any unrecognised parameters will be ignored as with setParameter method.

Parameters

dest	Pointer to object to have it's parameters set the same as this object.

Definition at line 301 of file OgreStringInterface.h.

References Ogre::ParamDictionary::mParamDefs, and Ogre::StringInterface::setParameter().

bool Ogre::StringInterface::createParamDictionary ( const String & className )

inlineprotectedinherited

Internal method for creating a parameter dictionary for the class, if it does not already exist.

Remarks: This method will check to see if a parameter dictionary exist for this class yet, and if not will create one. NB you must supply the name of the class (RTTI is not used or performance).

Parameters

className the name of the class using the dictionary

Returns: true if a new dictionary was created, false if it was already there

Definition at line 184 of file OgreStringInterface.h.

References OGRE_LOCK_MUTEX.

virtual void Ogre::Resource::escalateLoading ( )

virtualinherited

Escalates the loading of a background loaded resource.

Remarks: If a resource is set to load in the background, but something needs it before it's been loaded, there could be a problem. If the user of this resource really can't wait, they can escalate the loading which basically pulls the loading into the current thread immediately. If the resource is already being loaded but just hasn't quite finished then this method will simply wait until the background load is complete.

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

BspNode* Ogre::BspLevel::findLeaf ( const Vector3 & point ) const

Walks the entire BSP tree and returns the leaf which contains the given point.

virtual ResourceManager* Ogre::Resource::getCreator ( void )

inlinevirtualinherited

Gets the manager which created this resource.

Definition at line 411 of file OgreResource.h.

virtual const String& Ogre::Resource::getGroup ( void )

inlinevirtualinherited

Gets the group which this resource is a member of.

Reimplemented in Ogre::SkeletonInstance.

Definition at line 399 of file OgreResource.h.

virtual ResourceHandle Ogre::Resource::getHandle ( void ) const

inlinevirtualinherited

Reimplemented in Ogre::SkeletonInstance.

Definition at line 317 of file OgreResource.h.

BspNode* Ogre::BspLevel::getLeafStart ( void )

inline

Gets a pointer to the start of the leaf nodes.

Definition at line 84 of file OgreBspLevel.h.

References mLeafStart, and mRootNode.

virtual LoadingState Ogre::Resource::getLoadingState ( ) const

inlinevirtualinherited

Returns the current loading state.

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

Definition at line 348 of file OgreResource.h.

virtual const String& Ogre::Resource::getName ( void ) const

inlinevirtualinherited

Gets resource name.

Reimplemented in Ogre::SkeletonInstance.

Definition at line 312 of file OgreResource.h.

int Ogre::BspLevel::getNumLeaves ( void ) const

inline

Gets the number of leaf nodes.

Definition at line 86 of file OgreBspLevel.h.

References mNumLeaves.

virtual const String& Ogre::Resource::getOrigin ( void ) const

inlinevirtualinherited

Get the origin of this resource, e.g.

a script file name.

Remarks: This property will only contain something if the creator of this resource chose to populate it. Script loaders are advised to populate it.

Definition at line 418 of file OgreResource.h.

ParamDictionary* Ogre::StringInterface::getParamDictionary ( void )

inlineinherited

Retrieves the parameter dictionary for this class.

Remarks: Only valid to call this after createParamDictionary.

Returns: Pointer to ParamDictionary shared by all instances of this class which you can add parameters to, retrieve parameters etc.

Definition at line 217 of file OgreStringInterface.h.

const ParamDictionary* Ogre::StringInterface::getParamDictionary ( void ) const

inlineinherited

Definition at line 222 of file OgreStringInterface.h.

virtual String Ogre::StringInterface::getParameter ( const String & name ) const

inlinevirtualinherited

Generic parameter retrieval method.

Remarks: Call this method with the name of a parameter to retrieve a string-format value of the parameter in question. If in doubt, check the parameter definition in the list returned from getParameters for the type of this parameter. If you like you can use StringConverter to convert this string back into a native type.

Parameters

name	The name of the parameter to get

Returns: String value of parameter, blank if not found

Definition at line 270 of file OgreStringInterface.h.

References Ogre::ParamCommand::doGet(), and Ogre::ParamDictionary::getParamCommand().

const ParameterList& Ogre::StringInterface::getParameters ( void ) const

inherited

Retrieves a list of parameters valid for this object.

Returns: A reference to a static list of ParameterDef objects.

const BspNode* Ogre::BspLevel::getRootNode ( void )

Returns a pointer to the root node (BspNode) of the BSP tree.

virtual size_t Ogre::Resource::getSize ( void ) const

inlinevirtualinherited

Retrieves info about the size of the resource.

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

Definition at line 301 of file OgreResource.h.

Real Ogre::BspLevel::getSkyCurvature ( void ) const

Get sky curvature.

const String& Ogre::BspLevel::getSkyMaterialName ( void ) const

Get Sky material name.

virtual size_t Ogre::Resource::getStateCount ( ) const

inlinevirtualinherited

Returns the number of times this resource has changed state, which generally means the number of times it has been loaded.

Objects that build derived data based on the resource can check this value against a copy they kept last time they built this derived data, in order to know whether it needs rebuilding. This is a nice way of monitoring changes without having a tightly-bound callback.

Definition at line 429 of file OgreResource.h.

void Ogre::BspLevel::initQuake3Patches	(	const Quake3Level &	q3lvl,
		VertexDeclaration *	decl
	)

protected

virtual bool Ogre::Resource::isBackgroundLoaded ( void ) const

inlinevirtualinherited

Returns whether this Resource has been earmarked for background loading.

Remarks: This option only makes sense when you have built Ogre with thread support (OGRE_THREAD_SUPPORT). If a resource has been marked for background loading, then it won't load on demand like normal when load() is called. Instead, it will ignore request to load() except if the caller indicates it is the background loader. Any other users of this resource should check isLoaded(), and if that returns false, don't use the resource and come back later.

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

Definition at line 365 of file OgreResource.h.

bool Ogre::BspLevel::isLeafVisible	(	const BspNode *	from,
		const BspNode *	to
	)		const

Determines if one leaf node is visible from another.

virtual bool Ogre::Resource::isLoaded ( void ) const

inlinevirtualinherited

Returns true if the Resource has been loaded, false otherwise.

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

Definition at line 332 of file OgreResource.h.

virtual bool Ogre::Resource::isLoading ( ) const

inlinevirtualinherited

Returns whether the resource is currently in the process of background loading.

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

Definition at line 341 of file OgreResource.h.

virtual bool Ogre::Resource::isManuallyLoaded ( void ) const

inlinevirtualinherited

Is this resource manually loaded?

Definition at line 289 of file OgreResource.h.

virtual bool Ogre::Resource::isPrepared ( void ) const

inlinevirtualinherited

Returns true if the Resource has been prepared, false otherwise.

Definition at line 324 of file OgreResource.h.

virtual bool Ogre::Resource::isReloadable ( void ) const

inlinevirtualinherited

Returns true if the Resource is reloadable, false otherwise.

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

Definition at line 282 of file OgreResource.h.

bool Ogre::BspLevel::isSkyEnabled ( void ) const

Is sky enabled?

void Ogre::BspLevel::load ( DataStreamPtr & stream )

Load direct from stream.

virtual void Ogre::Resource::load ( bool backgroundThread = false )

virtualinherited

Loads the resource, if it is not already.

Remarks: If the resource is loaded from a file, loading is automatic. If not, if for example this resource gained it's data from procedural calls rather than loading from a file, then this resource will not reload on it's own.

Parameters

backgroundThread Indicates whether the caller of this method is the background resource loading thread.

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

void Ogre::BspLevel::loadEntities ( const Quake3Level & q3lvl )

protected

Internal method for parsing chosen entities.

void Ogre::BspLevel::loadImpl ( void )

protectedvirtual

Utility class just to enable queueing of patches.

Implements Ogre::Resource.

void Ogre::BspLevel::loadQuake3Level ( const Quake3Level & q3lvl )

protected

Internal utility function for loading data from Quake3.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete ( void * ptr )

inlineinherited

Definition at line 95 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete	(	void *	ptr,
		void *
	)

inlineinherited

Definition at line 101 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete	(	void *	ptr,
		const char *	,
		int	,
		const char *
	)

inlineinherited

Definition at line 107 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[] ( void * ptr )

inlineinherited

Definition at line 112 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[]	(	void *	ptr,
		const char *	,
		int	,
		const char *
	)

inlineinherited

Definition at line 118 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new	(	size_t	sz,
		const char *	file,
		int	line,
		const char *	func
	)

inlineinherited

operator new, with debug line info

Definition at line 67 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new ( size_t sz )

inlineinherited

Definition at line 72 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new	(	size_t	sz,
		void *	ptr
	)

inlineinherited

placement operator new

Definition at line 78 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[]	(	size_t	sz,
		const char *	file,
		int	line,
		const char *	func
	)

inlineinherited

array operator new, with debug line info

Definition at line 85 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t sz )

inlineinherited

Definition at line 90 of file OgreMemoryAllocatedObject.h.

virtual void Ogre::Resource::postLoadImpl ( void )

inlineprotectedvirtualinherited

Internal hook to perform actions after the load process, but before the resource has been marked as fully loaded.

Note: Mutex will have already been acquired by the loading thread. Also, this call will occur even when using a ManualResourceLoader (when loadImpl is not actually called)

Reimplemented in Ogre::Mesh, and Ogre::D3D9Texture.

Definition at line 189 of file OgreResource.h.

virtual void Ogre::Resource::postUnloadImpl ( void )

inlineprotectedvirtualinherited

Internal hook to perform actions after the unload process, but before the resource has been marked as fully unloaded.

Note: Mutex will have already been acquired by the unloading thread.

Definition at line 199 of file OgreResource.h.

virtual void Ogre::Resource::preLoadImpl ( void )

inlineprotectedvirtualinherited

Internal hook to perform actions before the load process, but after the resource has been marked as 'loading'.

Note: Mutex will have already been acquired by the loading thread. Also, this call will occur even when using a ManualResourceLoader (when loadImpl is not actually called)

Definition at line 182 of file OgreResource.h.

virtual void Ogre::Resource::prepare ( bool backgroundThread = false )

virtualinherited

Prepares the resource for load, if it is not already.

One can call prepare() before load(), but this is not required as load() will call prepare() itself, if needed. When OGRE_THREAD_SUPPORT==1 both load() and prepare() are thread-safe. When OGRE_THREAD_SUPPORT==2 however, only prepare() is thread-safe. The reason for this function is to allow a background thread to do some of the loading work, without requiring the whole render system to be thread-safe. The background thread would call prepare() while the main render loop would later call load(). So long as prepare() remains thread-safe, subclasses can arbitrarily split the work of loading a resource between load() and prepare(). It is best to try and do as much work in prepare(), however, since this will leave less work for the main render thread to do and thus increase FPS.

Parameters

backgroundThread Whether this is occurring in a background thread

virtual void Ogre::Resource::prepareImpl ( void )

inlineprotectedvirtualinherited

Internal implementation of the meat of the 'prepare' action.

Reimplemented in Ogre::Mesh, Ogre::D3D9Texture, Ogre::Material, Ogre::PatchMesh, Ogre::GLTexture, and Ogre::GLESTexture.

Definition at line 203 of file OgreResource.h.

virtual void Ogre::Resource::preUnloadImpl ( void )

inlineprotectedvirtualinherited

Internal hook to perform actions before the unload process.

Note: Mutex will have already been acquired by the unloading thread.

Definition at line 194 of file OgreResource.h.

void Ogre::BspLevel::quakeVertexToBspVertex	(	const bsp_vertex_t *	src,
		BspVertex *	dest
	)

protected

virtual void Ogre::Resource::reload ( void )

virtualinherited

Reloads the resource, if it is already loaded.

Remarks: Calls unload() and then load() again, if the resource is already loaded. If it is not loaded already, then nothing happens.

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

virtual void Ogre::Resource::removeListener ( Listener * lis )

virtualinherited

Remove a listener on this resource.

See also: Resource::Listener

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

virtual void Ogre::Resource::setBackgroundLoaded ( bool bl )

inlinevirtualinherited

Tells the resource whether it is background loaded or not.

Remarks

See also: Resource::isBackgroundLoaded . Note that calling this only defers the normal on-demand loading behaviour of a resource, it does not actually set up a thread to make sure the resource gets loaded in the background. You should use ResourceBackgroundLoadingQueue to manage the actual loading (which will call this method itself).

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

Definition at line 375 of file OgreResource.h.

virtual bool Ogre::StringInterface::setParameter	(	const String &	name,
		const String &	value
	)

virtualinherited

Generic parameter setting method.

Remarks: Call this method with the name of a parameter and a string version of the value to set. The implementor will convert the string to a native type internally. If in doubt, check the parameter definition in the list returned from StringInterface::getParameters.

Parameters

name	The name of the parameter to set
value	String value. Must be in the right format for the type specified in the parameter definition. See the StringConverter class for more information.

Returns: true if set was successful, false otherwise (NB no exceptions thrown - tolerant method)

Referenced by Ogre::StringInterface::copyParametersTo().

virtual void Ogre::StringInterface::setParameterList ( const NameValuePairList & paramList )

virtualinherited

Generic multiple parameter setting method.

Remarks: Call this method with a list of name / value pairs to set. The implementor will convert the string to a native type internally. If in doubt, check the parameter definition in the list returned from StringInterface::getParameters.

Parameters

paramList Name/value pair list

void Ogre::BspLevel::tagNodesWithMovable	(	BspNode *	node,
		const MovableObject *	mov,
		const Vector3 &	pos
	)

protected

virtual void Ogre::Resource::touch ( void )

virtualinherited

'Touches' the resource to indicate it has been used.

Reimplemented in Ogre::Material, and Ogre::UnifiedHighLevelGpuProgram.

Referenced by Ogre::Material::touch().

virtual void Ogre::Resource::unload ( void )

virtualinherited

Unloads the resource; this is not permanent, the resource can be reloaded later if required.

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

void Ogre::BspLevel::unloadImpl ( void )

protectedvirtual

Implements Ogre::Resource.

virtual void Ogre::Resource::unprepareImpl ( void )

inlineprotectedvirtualinherited

Internal function for undoing the 'prepare' action.

Called when the load is completed, and when resources are unloaded when they are prepared but not yet loaded.

Reimplemented in Ogre::Mesh, Ogre::D3D9Texture, Ogre::Material, Ogre::GLTexture, and Ogre::GLESTexture.

Definition at line 208 of file OgreResource.h.

Friends And Related Function Documentation

friend class BspSceneManager

friend

Definition at line 58 of file OgreBspLevel.h.

Member Data Documentation

BspNode::Brush* Ogre::BspLevel::mBrushes

protected

Brushes as used for collision, main memory is here.

Definition at line 169 of file OgreBspLevel.h.

ResourceManager* Ogre::Resource::mCreator

protectedinherited

Creator.

Definition at line 142 of file OgreResource.h.

StaticFaceGroup* Ogre::BspLevel::mFaceGroups

protected

Array of face groups, indexed into by contents of mLeafFaceGroups.

Definition at line 153 of file OgreBspLevel.h.

String Ogre::Resource::mGroup

protectedinherited

The name of the resource group.

Definition at line 146 of file OgreResource.h.

ResourceHandle Ogre::Resource::mHandle

protectedinherited

Numeric handle for more efficient look up than name.

Definition at line 148 of file OgreResource.h.

HardwareIndexBufferSharedPtr Ogre::BspLevel::mIndexes

protected

Definition at line 166 of file OgreBspLevel.h.

volatile bool Ogre::Resource::mIsBackgroundLoaded

protectedinherited

Is this resource going to be background loaded? Only applicable for multithreaded.

Definition at line 152 of file OgreResource.h.

bool Ogre::Resource::mIsManual

protectedinherited

Is this file manually loaded?

Definition at line 156 of file OgreResource.h.

int* Ogre::BspLevel::mLeafFaceGroups

protected

Array of indexes into the mFaceGroups array.

This buffer is organised by leaf node so leaves can just use contiguous chunks of it and get repointed to the actual entries in mFaceGroups.

Definition at line 149 of file OgreBspLevel.h.

int Ogre::BspLevel::mLeafStart

protected

Definition at line 121 of file OgreBspLevel.h.

Referenced by getLeafStart().

ListenerList Ogre::Resource::mListenerList

protectedinherited

Definition at line 165 of file OgreResource.h.

ManualResourceLoader* Ogre::Resource::mLoader

protectedinherited

Optional manual loader; if provided, data is loaded from here instead of a file.

Definition at line 160 of file OgreResource.h.

AtomicScalar<LoadingState> Ogre::Resource::mLoadingState

protectedinherited

Is the resource currently loaded?

Definition at line 150 of file OgreResource.h.

MovableToNodeMap Ogre::BspLevel::mMovableToNodeMap

protected

Map for locating the nodes a movable is currently a member of.

Definition at line 206 of file OgreBspLevel.h.

String Ogre::Resource::mName

protectedinherited

Unique name of the resource.

Definition at line 144 of file OgreResource.h.

int Ogre::BspLevel::mNumBrushes

protected

Definition at line 120 of file OgreBspLevel.h.

int Ogre::BspLevel::mNumFaceGroups

protected

Definition at line 154 of file OgreBspLevel.h.

size_t Ogre::BspLevel::mNumIndexes

protected

indexes for the whole level, will be copied to the real indexdata per frame

Definition at line 164 of file OgreBspLevel.h.

int Ogre::BspLevel::mNumLeafFaceGroups

protected

Definition at line 150 of file OgreBspLevel.h.

int Ogre::BspLevel::mNumLeaves

protected

Definition at line 119 of file OgreBspLevel.h.

Referenced by getNumLeaves().

int Ogre::BspLevel::mNumNodes

protected

Definition at line 118 of file OgreBspLevel.h.

String Ogre::Resource::mOrigin

protectedinherited

Origin of this resource (e.g. script name) - optional.

Definition at line 158 of file OgreResource.h.

PatchMap Ogre::BspLevel::mPatches

protected

Definition at line 212 of file OgreBspLevel.h.

size_t Ogre::BspLevel::mPatchIndexCount

protected

Definition at line 216 of file OgreBspLevel.h.

size_t Ogre::BspLevel::mPatchVertexCount

protected

Definition at line 214 of file OgreBspLevel.h.

vector<ViewPoint>::type Ogre::BspLevel::mPlayerStarts

protected

Vector of player start points.

Definition at line 172 of file OgreBspLevel.h.

BspNode* Ogre::BspLevel::mRootNode

protected

Pointer to the root node of the BSP tree; This pointer actually has a dual purpose; to avoid allocating lots of small chunks of memory, the BspLevel actually allocates all nodes required through this pointer.

So this pointer is the handle for the allocation of memory for all nodes. It also happens to point to the root node, since the first one in the memory chunk is the root node.

Definition at line 117 of file OgreBspLevel.h.

Referenced by getLeafStart().

size_t Ogre::Resource::mSize

protectedinherited

The size of the resource in bytes.

Definition at line 154 of file OgreResource.h.

Real Ogre::BspLevel::mSkyCurvature

protected

Definition at line 222 of file OgreBspLevel.h.

bool Ogre::BspLevel::mSkyEnabled

protected

Definition at line 218 of file OgreBspLevel.h.

String Ogre::BspLevel::mSkyMaterial

protected

Definition at line 220 of file OgreBspLevel.h.

size_t Ogre::Resource::mStateCount

protectedinherited

State count, the number of times this resource has changed state.

Definition at line 162 of file OgreResource.h.

VertexData* Ogre::BspLevel::mVertexData

protected

Vertex data holding all the data for the level, but able to render parts of it.

Definition at line 144 of file OgreBspLevel.h.

VisData Ogre::BspLevel::mVisData

protected

Definition at line 198 of file OgreBspLevel.h.

The documentation for this class was generated from the following file:

OgreBspLevel.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation