![]() |
OGRE
1.12.5
Object-Oriented Graphics Rendering Engine
|
Holds all the data associated with a Binary Space Parition (BSP) based indoor level. More...
#include <OgreBspLevel.h>
Public Types | |
enum | LoadingFlags { LF_DEFAULT = 0, LF_INCLUDE_NON_RELOADABLE = 1, LF_ONLY_UNREFERENCED = 2, LF_ONLY_UNREFERENCED_INCLUDE_NON_RELOADABLE = 3, LF_PRESERVE_STATE = 4 } |
Enum that allow to choose subset of unloaded/reloaded resources and to adjust reloading behavior. More... | |
enum | LoadingState { LOADSTATE_UNLOADED, LOADSTATE_LOADING, LOADSTATE_LOADED, LOADSTATE_UNLOADING, LOADSTATE_PREPARED, LOADSTATE_PREPARING } |
Enum identifying the loading state of the resource. More... | |
typedef SharedPtr< RenderSystemData > | RenderSystemDataPtr |
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... | |
void | _fireLoadingComplete (bool wasBackgroundLoaded) |
Firing of loading complete event. More... | |
void | _firePreparingComplete (bool wasBackgroundLoaded) |
Firing of preparing complete event. More... | |
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... | |
void | _notifyOrigin (const String &origin) |
Notify this resource of it's origin. More... | |
virtual void | _updateCustomGpuParameter (const GpuProgramParameters::AutoConstantEntry &constantEntry, GpuProgramParameters *params) const |
Update a custom GpuProgramParameters constant which is derived from information only this Renderable knows. 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... | |
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 bool | getCastsShadows (void) const |
Method which reports whether this renderable would normally cast a shadow. More... | |
ResourceManager * | getCreator (void) |
Gets the manager which created this resource. More... | |
const Vector4 & | getCustomParameter (size_t index) const |
Gets the custom value associated with this Renderable at the given index. More... | |
virtual const String & | getGroup (void) const |
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... | |
const LightList & | getLights () const override |
Gets a list of lights, ordered relative to how close they are to this renderable. More... | |
virtual LoadingState | getLoadingState () const |
Returns the current loading state. More... | |
const MaterialPtr & | getMaterial (void) const override |
Retrieves a weak reference to the material this renderable object uses. More... | |
virtual const String & | getName (void) const |
Gets resource name. More... | |
int | getNumLeaves (void) const |
Gets the number of leaf nodes. More... | |
virtual unsigned short | getNumWorldTransforms (void) const |
Returns the number of world transform matrices this renderable requires. More... | |
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 |
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... | |
bool | getPolygonModeOverrideable (void) const |
Gets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting. More... | |
void | getRenderOperation (RenderOperation &op) override |
Gets the render operation required to send this object to the frame buffer. More... | |
const RenderSystemDataPtr & | getRenderSystemData () const |
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... | |
Real | getSquaredViewDepth (const Camera *cam) const override |
Returns the camera-relative squared depth of this renderable. 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 Technique * | getTechnique (void) const |
Retrieves a pointer to the Material Technique this renderable object uses. More... | |
bool | getUseIdentityProjection (void) const |
Returns whether or not to use an 'identity' projection. More... | |
bool | getUseIdentityView (void) const |
Returns whether or not to use an 'identity' view. More... | |
const Any & | getUserAny (void) const |
UserObjectBindings & | getUserObjectBindings () |
Return an instance of user objects binding associated with this class. More... | |
const UserObjectBindings & | getUserObjectBindings () const |
Return an instance of user objects binding associated with this class. More... | |
void | getWorldTransforms (Matrix4 *xform) const override |
Gets the world transform matrix / matrices for this renderable object. More... | |
bool | hasCustomParameter (size_t index) const |
Checks whether a custom value is associated with this Renderable at the given index. 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... | |
virtual void | load (bool backgroundThread=false) |
Loads the resource, if it is not already. More... | |
void | load (DataStreamPtr &stream) |
Load direct from stream. More... | |
virtual void | postRender (SceneManager *sm, RenderSystem *rsys) |
Called immediately after the Renderable has been rendered. More... | |
virtual void | prepare (bool backgroundThread=false) |
Prepares the resource for load, if it is not already. More... | |
virtual bool | preRender (SceneManager *sm, RenderSystem *rsys) |
Called just prior to the Renderable being rendered. More... | |
virtual void | reload (LoadingFlags flags=LF_DEFAULT) |
Reloads the resource, if it is already loaded. More... | |
void | removeCustomParameter (size_t index) |
Removes a custom value which is associated with this Renderable at the given index. 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... | |
void | setCustomParameter (size_t index, const Vector4 &value) |
Sets a custom parameter for this Renderable, which may be used to drive calculations for this specific Renderable, like GPU program parameters. More... | |
bool | setParameter (const String &name, const String &value) |
Generic parameter setting method. More... | |
void | setParameterList (const NameValuePairList ¶mList) |
Generic multiple parameter setting method. More... | |
void | setPolygonModeOverrideable (bool override) |
Sets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting. More... | |
void | setRenderSystemData (RenderSystemDataPtr val) const |
void | setUseIdentityProjection (bool useIdentityProjection) |
Sets whether or not to use an 'identity' projection. More... | |
void | setUseIdentityView (bool useIdentityView) |
Sets whether or not to use an 'identity' view. More... | |
void | setUserAny (const Any &anything) |
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... | |
Public Attributes | |
OGRE_AUTO_MUTEX | |
Friends | |
class | BspSceneManager |
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.
|
inherited |
|
inherited |
|
inherited |
Enum that allow to choose subset of unloaded/reloaded resources and to adjust reloading behavior.
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 | ( | ) |
Determines if one leaf node is visible from another.
const BspNode* Ogre::BspLevel::getRootNode | ( | void | ) |
Returns a pointer to the root node (BspNode) of the BSP tree.
Walks the entire BSP tree and returns the leaf which contains the given point.
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::BspLevel::_notifyObjectDetached | ( | const MovableObject * | mov | ) |
Internal method, makes sure an object is removed from the leaves when detached from a node.
|
inline |
Gets a pointer to the start of the leaf nodes.
|
inline |
Gets the number of leaf nodes.
|
static |
Calculate the number of loading stages required for a given level.
|
static |
Calculate the number of loading stages required for a given level.
void Ogre::BspLevel::load | ( | DataStreamPtr & | stream | ) |
Load direct from stream.
bool Ogre::BspLevel::isSkyEnabled | ( | void | ) | const |
Is sky enabled?
const String& Ogre::BspLevel::getSkyMaterialName | ( | void | ) | const |
Get Sky material name.
Real Ogre::BspLevel::getSkyCurvature | ( | void | ) | const |
Get sky curvature.
|
inlineoverridevirtual |
Gets the render operation required to send this object to the frame buffer.
Implements Ogre::Renderable.
|
inlineoverridevirtual |
Gets the world transform matrix / matrices for this renderable object.
Implements Ogre::Renderable.
References Ogre::Matrix4::IDENTITY.
Returns the camera-relative squared depth of this renderable.
Implements Ogre::Renderable.
|
inlineoverridevirtual |
Gets a list of lights, ordered relative to how close they are to this renderable.
Implements Ogre::Renderable.
|
inlineoverridevirtual |
Retrieves a weak reference to the material this renderable object uses.
Implements Ogre::Renderable.
|
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.
backgroundThread | Whether this is occurring in a background thread |
|
virtualinherited |
Loads the resource, if it is not already.
backgroundThread | Indicates whether the caller of this method is the background resource loading thread. |
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
|
virtualinherited |
Reloads the resource, if it is already loaded.
Reimplemented in Ogre::Mesh, and Ogre::UnifiedHighLevelGpuProgram.
|
inlinevirtualinherited |
Returns true if the Resource is reloadable, false otherwise.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
|
inlinevirtualinherited |
Is this resource manually loaded?
|
virtualinherited |
Unloads the resource; this is not permanent, the resource can be reloaded later if required.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
|
inlinevirtualinherited |
Retrieves info about the size of the resource.
Reimplemented in Ogre::CgProgram, and Ogre::UnifiedHighLevelGpuProgram.
|
virtualinherited |
'Touches' the resource to indicate it has been used.
Reimplemented in Ogre::Material, Ogre::CgProgram, and Ogre::UnifiedHighLevelGpuProgram.
Referenced by Ogre::Material::touch().
|
inlinevirtualinherited |
Gets resource name.
Reimplemented in Ogre::SkeletonInstance.
Referenced by Ogre::GpuProgramUsage::getProgramName(), and OgreBites::TrayManager::resourceLoadStarted().
|
inlinevirtualinherited |
Reimplemented in Ogre::SkeletonInstance.
|
inlinevirtualinherited |
Returns true if the Resource has been prepared, false otherwise.
|
inlinevirtualinherited |
Returns true if the Resource has been loaded, false otherwise.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
|
inlinevirtualinherited |
Returns whether the resource is currently in the process of background loading.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
|
inlinevirtualinherited |
Returns the current loading state.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
|
inlinevirtualinherited |
Returns whether this Resource has been earmarked for background loading.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
|
inlinevirtualinherited |
Tells the resource whether it is background loaded or not.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
|
virtualinherited |
Escalates the loading of a background loaded resource.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
|
virtualinherited |
Register a listener on this resource.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
|
virtualinherited |
Remove a listener on this resource.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
|
inlinevirtualinherited |
Gets the group which this resource is a member of.
Reimplemented in Ogre::SkeletonInstance.
|
virtualinherited |
Change the resource group ownership of a Resource.
newGroup | Name of the new group |
|
inlineinherited |
Gets the manager which created this resource.
|
inlineinherited |
Get the origin of this resource, e.g.
a script file name.
|
inlineinherited |
Notify this resource of it's origin.
|
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.
|
virtualinherited |
Manually mark the state of this resource as having been changed.
|
inherited |
Firing of loading complete event.
wasBackgroundLoaded | Whether this was a background loaded event |
|
inherited |
Firing of preparing complete event.
wasBackgroundLoaded | Whether this was a background loaded event |
|
inherited |
Firing of unloading complete event.
|
inlineinherited |
Retrieves the parameter dictionary for this class.
|
inlineinherited |
|
inherited |
Retrieves a list of parameters valid for this object.
Generic parameter setting method.
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. |
Referenced by Ogre::StringInterface::copyParametersTo().
|
inherited |
Generic multiple parameter setting method.
paramList | Name/value pair list |
Generic parameter retrieval method.
name | The name of the parameter to get |
References Ogre::ParamCommand::doGet().
|
inlineinherited |
Method for copying this object's parameters to another object.
dest | Pointer to object to have it's parameters set the same as this object. |
References Ogre::StringInterface::setParameter().
|
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.
|
inlinevirtualinherited |
Retrieves a pointer to the Material Technique this renderable object uses.
Reimplemented in Ogre::SubEntity, Ogre::InstanceBatch, and Ogre::StaticGeometry::GeometryBucket.
|
inlinevirtualinherited |
Called just prior to the Renderable being rendered.
Reimplemented in Ogre::BillboardChain.
|
inlinevirtualinherited |
Called immediately after the Renderable has been rendered.
|
inlinevirtualinherited |
Returns the number of world transform matrices this renderable requires.
Reimplemented in Ogre::SubEntity, Ogre::BorderRenderable, Ogre::BaseInstanceBatchVTF, Ogre::InstanceBatchHW, and Ogre::InstanceBatchShader.
|
inlineinherited |
Sets whether or not to use an 'identity' projection.
|
inlineinherited |
Returns whether or not to use an 'identity' projection.
|
inlineinherited |
Sets whether or not to use an 'identity' view.
|
inlineinherited |
Returns whether or not to use an 'identity' view.
|
inlinevirtualinherited |
Method which reports whether this renderable would normally cast a shadow.
Reimplemented in Ogre::SubEntity, and Ogre::StaticGeometry::GeometryBucket.
|
inlineinherited |
Sets a custom parameter for this Renderable, which may be used to drive calculations for this specific Renderable, like GPU program parameters.
index | The index with which to associate the value. Note that this does not have to start at 0, and can include gaps. It also has no direct correlation with a GPU program parameter index - the mapping between the two is performed by the ACT_CUSTOM entry, if that is used. |
value | The value to associate. |
|
inlineinherited |
Removes a custom value which is associated with this Renderable at the given index.
index | Index of the parameter to remove. |
|
inlineinherited |
Checks whether a custom value is associated with this Renderable at the given index.
index | Index of the parameter to check for existence. |
|
inlineinherited |
Gets the custom value associated with this Renderable at the given index.
index | Index of the parameter to retrieve. |
References Ogre::Exception::ERR_ITEM_NOT_FOUND, and OGRE_EXCEPT.
|
inlinevirtualinherited |
Update a custom GpuProgramParameters constant which is derived from information only this Renderable knows.
constantEntry | The auto constant entry referring to the parameter being updated |
params | The parameters object which this method should call to set the updated parameters. |
Reimplemented in Ogre::SubEntity.
References Ogre::GpuProgramParameters::_writeRawConstant(), Ogre::GpuProgramParameters::AutoConstantEntry::data, Ogre::GpuProgramParameters::AutoConstantEntry::elementCount, and Ogre::GpuProgramParameters::AutoConstantEntry::physicalIndex.
|
inlineinherited |
Sets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting.
override | true means that a lower camera detail will override this renderables detail level, false means it won't. |
|
inlineinherited |
Gets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting.
Referenced by Ogre::BorderRenderable::getPolygonModeOverrideable().
|
inlineinherited |
Sets any kind of user value on this object.
|
inlineinherited |
Retrieves the custom user value associated with this object.
|
inlineinherited |
Return an instance of user objects binding associated with this class.
You can use it to associate one or more custom objects with this class instance.
|
inlineinherited |
Return an instance of user objects binding associated with this class.
You can use it to associate one or more custom objects with this class instance.
|
inlineinherited |
|
inlineinherited |
|
friend |
|
inherited |