# Ogre::BspLevel Class Reference

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

`#include <OgreBspLevel.h>`

Inheritance diagram for Ogre::BspLevel:

List of all members.

## 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).
| ~BspLevel ()
bool | isLeafVisible (const BspNode *from, const BspNode *to) const
| Determines if one leaf node is visible from another.
const BspNode * | getRootNode (void)
| Returns a pointer to the root node (BspNode) of the BSP tree.
BspNode * | findLeaf (const Vector3 &point) const
| Walks the entire BSP tree and returns the leaf which contains the given point.
void | _notifyObjectMoved (const MovableObject *mov, const Vector3 &pos)
| Ensures that the MovableObject is attached to the right leaves of the BSP tree.
void | _notifyObjectDetached (const MovableObject *mov)
| Internal method, makes sure an object is removed from the leaves when detached from a node.
BspNode * | getLeafStart (void)
| Gets a pointer to the start of the leaf nodes.
int | getNumLeaves (void) const
| Gets the number of leaf nodes.
virtual void | load (void)
| Loads the resource, if it is not already.
virtual void | reload (void)
| Reloads the resource, if it is already loaded.
bool | isReloadable (void) const
| Returns true if the Resource is reloadable, false otherwise.
bool | isManuallyLoaded (void) const
| Is this resource manually loaded?
virtual void | unload (void)
| Unloads the resource; this is not permanent, the resource can be reloaded later if required.
size_t | getSize (void) const
| Retrieves info about the size of the resource.
virtual void | touch (void)
| 'Touches' the resource to indicate it has been used.
const String & | getName (void) const
| Gets resource name.
ResourceHandle | getHandle (void) const
bool | isLoaded (void) const
| Returns true if the Resource has been loaded, false otherwise.
const String & | getGroup (void)
| Gets the group which this resource is a member of.
ResourceManager * | getCreator (void)
| Gets the manager which created this resource.
const String & | getOrigin (void) const
| Get the origin of this resource, e.g.
void | _notifyOrigin (const String &origin)
| Notify this resource of it's origin.
ParamDictionary * | getParamDictionary (void)
| Retrieves the parameter dictionary for this class.
const ParamDictionary * | getParamDictionary (void) const
const ParameterList & | getParameters (void) const
| Retrieves a list of parameters valid for this object.
virtual bool | setParameter (const String &name, const String &value)
| Generic parameter setting method.
virtual void | setParameterList (const NameValuePairList &paramList)
| Generic multiple parameter setting method.
virtual String | getParameter (const String &name) const
| Generic parameter retrieval method.
virtual void | copyParametersTo (StringInterface *dest) const
| Method for copying this object's parameters to another object.

## Static Public Member Functions

size_t | calculateLoadingStages (const String &levelName)
| Calculate the number of loading stages required for a given level.
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.

## Protected Types

typedef std::map< const MovableObject *, std::list< BspNode * > > | MovableToNodeMap
typedef std::map< int, PatchSurface * > | PatchMap

## Protected Member Functions

void | loadImpl (void)
| .
void | unloadImpl (void)
| .
size_t | calculateSize (void) const
| .
void | loadQuake3Level (const Quake3Level &q3lvl)
| Internal utility function for loading data from Quake3.
void | loadEntities (const Quake3Level &q3lvl)
| Internal method for parsing chosen entities.
void | tagNodesWithMovable (BspNode *node, const MovableObject *mov, const Vector3 &pos)
void | initQuake3Patches (const Quake3Level &q3lvl, VertexDeclaration *decl)
void | buildQuake3Patches (size_t vertOffset, size_t indexOffset)
void | quakeVertexToBspVertex (const bsp_vertex_t *src, BspVertex *dest)
bool | createParamDictionary (const String &className)
| Internal method for creating a parameter dictionary for the class, if it does not already exist.

## Protected Attributes

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.
int | mNumNodes
int | mNumLeaves
int | mLeafStart
VertexData * | mVertexData
| Vertex data holding all the data for the level, but able to render parts of it.
int * | mLeafFaceGroups
| Array of indexes into the mFaceGroups array.
int | mNumLeafFaceGroups
StaticFaceGroup * | mFaceGroups
| Array of face groups, indexed into by contents of mLeafFaceGroups.
int | mNumFaceGroups
size_t | mNumIndexes
| indexes for the whole level, will be copied to the real indexdata per frame
HardwareIndexBufferSharedPtr | mIndexes
BspNode::Brush * | mBrushes
| Brushes as used for collision, main memory is here.
std::vector< ViewPoint > | mPlayerStarts
| Vector of player start points.
VisData | mVisData
MovableToNodeMap | mMovableToNodeMap
| Map for locating the nodes a movable is currently a member of.
PatchMap | mPatches
size_t | mPatchVertexCount
size_t | mPatchIndexCount
ResourceManager * | mCreator
| Creator.
String | mName
| Unique name of the resource.
String | mGroup
| The name of the resource group.
ResourceHandle | mHandle
| Numeric handle for more efficient look up than name.
bool | mIsLoaded
| Is the resource currently loaded?
size_t | mSize
| The size of the resource in bytes.
bool | mIsManual
| Is this file manually loaded?
String | mOrigin
| Origin of this resource (e.g. script name) - optional.
ManualResourceLoader * | mLoader
| Optional manual loader; if provided, data is loaded from here instead of a file.
String | mParamDictName
| Class name for this instance to be used as a lookup (must be initialised by subclasses).

## Static Protected Attributes

ParamDictionaryMap | msDictionary
| Dictionary of parameters.

## 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 53 of file OgreBspLevel.h.

## Member Typedef Documentation

typedef std::map<const MovableObject*, std::list<BspNode*> > Ogre::BspLevel::MovableToNodeMap `[protected]`

| Definition at line 188 of file OgreBspLevel.h.

typedef std::map<int, PatchSurface*> Ogre::BspLevel::PatchMap `[protected]`

| Definition at line 195 of file OgreBspLevel.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

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.

void Ogre::Resource::_notifyOrigin | ( | const String & | origin | ) | `[inherited]`

| Notify this resource of it's origin. Definition at line 214 of file OgreResource.h. References Ogre::String.

void Ogre::BspLevel::buildQuake3Patches | ( | size_t | vertOffset,
|  | size_t | indexOffset
| ) | `[protected]`

size_t Ogre::BspLevel::calculateLoadingStages | ( | const String & | levelName | ) | `[static]`

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

size_t Ogre::BspLevel::calculateSize | ( | void |  | ) | const`[protected, virtual]`

| . Implements Ogre::Resource.

void Ogre::StringInterface::cleanupDictionary | ( |  | ) | `[static, inherited]`

| 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`[virtual, inherited]`

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 296 of file OgreStringInterface.h.

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

bool Ogre::StringInterface::createParamDictionary | ( | const String & | className | ) | `[protected, inherited]`

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 172 of file OgreStringInterface.h.

References Ogre::String.

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

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

ResourceManager* Ogre::Resource::getCreator | ( | void |  | ) | `[inherited]`

| Gets the manager which created this resource. Definition at line 205 of file OgreResource.h.

const String& Ogre::Resource::getGroup | ( | void |  | ) | `[inherited]`

| Gets the group which this resource is a member of. Definition at line 202 of file OgreResource.h. References Ogre::String.

ResourceHandle Ogre::Resource::getHandle | ( | void |  | ) | const`[inherited]`

| Definition at line 188 of file OgreResource.h. References Ogre::ResourceHandle.

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

| Gets a pointer to the start of the leaf nodes. Definition at line 81 of file OgreBspLevel.h. References mLeafStart.

const String& Ogre::Resource::getName | ( | void |  | ) | const`[inherited]`

| Gets resource name. Definition at line 183 of file OgreResource.h. References Ogre::String.

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

| Gets the number of leaf nodes. Definition at line 83 of file OgreBspLevel.h. References mNumLeaves.

const String& Ogre::Resource::getOrigin | ( | void |  | ) | const`[inherited]`

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 212 of file OgreResource.h.

References Ogre::String.

const ParamDictionary* Ogre::StringInterface::getParamDictionary | ( | void |  | ) | const`[inherited]`

| Definition at line 209 of file OgreStringInterface.h.

ParamDictionary* Ogre::StringInterface::getParamDictionary | ( | void |  | ) | `[inherited]`

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 196 of file OgreStringInterface.h.

virtual String Ogre::StringInterface::getParameter | ( | const String & | name | ) | const`[virtual, inherited]`

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 265 of file OgreStringInterface.h.

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

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.

size_t Ogre::Resource::getSize | ( | void |  | ) | const`[inherited]`

| Retrieves info about the size of the resource. Definition at line 172 of file OgreResource.h.

void Ogre::BspLevel::initQuake3Patches | ( | const Quake3Level & | q3lvl,
|  | VertexDeclaration * | decl
| ) | `[protected]`

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

| Determines if one leaf node is visible from another.

bool Ogre::Resource::isLoaded | ( | void |  | ) | const`[inherited]`

| Returns true if the Resource has been loaded, false otherwise. Definition at line 195 of file OgreResource.h. References OGRE_LOCK_AUTO_MUTEX.

bool Ogre::Resource::isManuallyLoaded | ( | void |  | ) | const`[inherited]`

| Is this resource manually loaded? Definition at line 160 of file OgreResource.h.

bool Ogre::Resource::isReloadable | ( | void |  | ) | const`[inherited]`

| Returns true if the Resource is reloadable, false otherwise. Definition at line 153 of file OgreResource.h.

virtual void Ogre::Resource::load | ( | void |  | ) | `[virtual, inherited]`

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

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

void Ogre::BspLevel::loadEntities | ( | const Quake3Level & | q3lvl | ) | `[protected]`

| Internal method for parsing chosen entities.

void Ogre::BspLevel::loadImpl | ( | void |  | ) | `[protected, virtual]`

| . Implements Ogre::Resource.

void Ogre::BspLevel::loadQuake3Level | ( | const Quake3Level & | q3lvl | ) | `[protected]`

| Internal utility function for loading data from Quake3.

void Ogre::BspLevel::quakeVertexToBspVertex | ( | const bsp_vertex_t * | src,
|  | BspVertex * | dest
| ) | `[protected]`

virtual void Ogre::Resource::reload | ( | void |  | ) | `[virtual, inherited]`

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.

virtual bool Ogre::StringInterface::setParameter | ( | const String & | name,
|  | const String & | value
| ) | `[virtual, inherited]`

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 | ) | `[virtual, inherited]`

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 |  | ) | `[virtual, inherited]`

| 'Touches' the resource to indicate it has been used. Reimplemented in Ogre::Material.

virtual void Ogre::Resource::unload | ( | void |  | ) | `[virtual, inherited]`

| Unloads the resource; this is not permanent, the resource can be reloaded later if required. Reimplemented in Ogre::GLSLGpuProgram.

void Ogre::BspLevel::unloadImpl | ( | void |  | ) | `[protected, virtual]`

| . Implements Ogre::Resource.

## Friends And Related Function Documentation

friend class BspSceneManager `[friend]`

| Definition at line 55 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 153 of file OgreBspLevel.h.

ResourceManager* Ogre::Resource::mCreator `[protected, inherited]`

| Creator. Definition at line 73 of file OgreResource.h.

StaticFaceGroup* Ogre::BspLevel::mFaceGroups `[protected]`

| Array of face groups, indexed into by contents of mLeafFaceGroups. Definition at line 137 of file OgreBspLevel.h.

String Ogre::Resource::mGroup `[protected, inherited]`

| The name of the resource group. Definition at line 77 of file OgreResource.h.

ResourceHandle Ogre::Resource::mHandle `[protected, inherited]`

| Numeric handle for more efficient look up than name. Definition at line 79 of file OgreResource.h.

HardwareIndexBufferSharedPtr Ogre::BspLevel::mIndexes `[protected]`

| Definition at line 150 of file OgreBspLevel.h.

bool Ogre::Resource::mIsLoaded `[protected, inherited]`

| Is the resource currently loaded? Definition at line 81 of file OgreResource.h.

bool Ogre::Resource::mIsManual `[protected, inherited]`

| Is this file manually loaded? Definition at line 85 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 133 of file OgreBspLevel.h.

int Ogre::BspLevel::mLeafStart `[protected]`

| Definition at line 105 of file OgreBspLevel.h. Referenced by getLeafStart().

ManualResourceLoader* Ogre::Resource::mLoader `[protected, inherited]`

| Optional manual loader; if provided, data is loaded from here instead of a file. Definition at line 89 of file OgreResource.h.

MovableToNodeMap Ogre::BspLevel::mMovableToNodeMap `[protected]`

| Map for locating the nodes a movable is currently a member of. Definition at line 190 of file OgreBspLevel.h.

String Ogre::Resource::mName `[protected, inherited]`

| Unique name of the resource. Definition at line 75 of file OgreResource.h.

int Ogre::BspLevel::mNumFaceGroups `[protected]`

| Definition at line 138 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 148 of file OgreBspLevel.h.

int Ogre::BspLevel::mNumLeafFaceGroups `[protected]`

| Definition at line 134 of file OgreBspLevel.h.

int Ogre::BspLevel::mNumLeaves `[protected]`

| Definition at line 104 of file OgreBspLevel.h. Referenced by getNumLeaves().

int Ogre::BspLevel::mNumNodes `[protected]`

| Definition at line 103 of file OgreBspLevel.h.

String Ogre::Resource::mOrigin `[protected, inherited]`

| Origin of this resource (e.g. script name) - optional. Definition at line 87 of file OgreResource.h.

String Ogre::StringInterface::mParamDictName `[protected, inherited]`

| Class name for this instance to be used as a lookup (must be initialised by subclasses). Definition at line 160 of file OgreStringInterface.h.

PatchMap Ogre::BspLevel::mPatches `[protected]`

| Definition at line 196 of file OgreBspLevel.h.

size_t Ogre::BspLevel::mPatchIndexCount `[protected]`

| Definition at line 200 of file OgreBspLevel.h.

size_t Ogre::BspLevel::mPatchVertexCount `[protected]`

| Definition at line 198 of file OgreBspLevel.h.

std::vector<ViewPoint> Ogre::BspLevel::mPlayerStarts `[protected]`

| Vector of player start points. Definition at line 156 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 102 of file OgreBspLevel.h.

ParamDictionaryMap Ogre::StringInterface::msDictionary `[static, protected, inherited]`

| Dictionary of parameters. Definition at line 157 of file OgreStringInterface.h.

size_t Ogre::Resource::mSize `[protected, inherited]`

| The size of the resource in bytes. Definition at line 83 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 128 of file OgreBspLevel.h.

VisData Ogre::BspLevel::mVisData `[protected]`

| Definition at line 182 of file OgreBspLevel.h.

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

- OgreBspLevel.h

Copyright © 2000-2005 by The OGRE Team
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Feb 12 13:05:18 2006