Loading...
Searching...
No Matches
Ogre::BspSceneManager Class Reference
Plugins » BSPSceneManager

Specialisation of the SceneManager class to deal with indoor scenes based on a BSP tree. More...

`#include <OgreBspSceneManager.h>`

Inheritance diagram for Ogre::BspSceneManager:
[legend]

## Public Member Functions

| BspSceneManager (const String &name)
| ~BspSceneManager ()
void | _findVisibleObjects (Camera *cam, VisibleObjectsBoundsInfo *visibleBounds, bool onlyShadowCasters) override
| Overridden from SceneManager.
void | _notifyObjectDetached (const MovableObject *mov)
| Internal method for notifying the level that an object has been detached from a node.
void | _notifyObjectMoved (const MovableObject *mov, const Vector3 &pos)
| Internal method for tagging BspNodes with objects which intersect them.
IntersectionSceneQuery * | createIntersectionQuery (uint32 mask=0xFFFFFFFF) override
| Creates an IntersectionSceneQuery for this scene manager.
RaySceneQuery * | createRayQuery (const Ray &ray, uint32 mask=0xFFFFFFFF) override
| Creates a RaySceneQuery for this scene manager.
SceneNode * | createSceneNodeImpl (const String &name) override
| Creates a specialized BspSceneNode.
SceneNode * | createSceneNodeImpl (void) override
| Creates a specialized BspSceneNode.
size_t | estimateWorldGeometry (const String &filename) override
| Specialised from SceneManager to support Quake3 bsp files.
size_t | estimateWorldGeometry (DataStreamPtr &stream, const String &typeName=BLANKSTRING) override
| Specialised from SceneManager to support Quake3 bsp files.
const BspLevelPtr & | getLevel (void)
ViewPoint | getSuggestedViewpoint (bool random=false) override
| Specialised to suggest viewpoints.
const String & | getTypeName (void) const override
| Retrieve the type name of this scene manager.
void | setLevel (const BspLevelPtr &level)
void | setWorldGeometry (const String &filename) override
| Specialised from SceneManager to support Quake3 bsp files.
void | setWorldGeometry (DataStreamPtr &stream, const String &typeName=BLANKSTRING) override
| Specialised from SceneManager to support Quake3 bsp files.
void | showNodeBoxes (bool show)
| Tells the manager whether to draw the axis-aligned boxes that surround nodes in the Bsp tree.
Public Member Functions inherited from Ogre::SceneManager
| SceneManager (const String &instanceName)
| Constructor.
virtual | ~SceneManager ()
| Default destructor.
CompositorChain * | _getActiveCompositorChain () const
| Gets the active compositor chain of the current scene being rendered.
const AutoParamDataSource * | _getAutoParamDataSource () const
uint32 | _getCombinedVisibilityMask (void) const
| Internal method for getting the combination between the global visibility mask and the per-viewport visibility mask.
IlluminationRenderStage | _getCurrentRenderStage () const
void | _handleLodEvents ()
| Handle LOD events.
void | _injectRenderWithPass (Pass *pass, Renderable *rend, bool shadowDerivation=true, bool doLightIteration=false, const LightList *manualLightList=0)
| Render something as if it came from the current queue.
void | _issueRenderOp (Renderable *rend, const Pass *pass)
| Internal method for issuing the render operation.
void | _markGpuParamsDirty (uint16 mask)
| Method to allow you to mark gpu parameters as dirty, causing them to be updated according to the mask that you set when updateGpuProgramParameters is next called.
void | _notifyAutotrackingSceneNode (SceneNode *node, bool autoTrack)
| Internal method for notifying the manager that a SceneNode is autotracking.
void | _notifyEntityMaterialLodChanged (EntityMaterialLodChangedEvent &evt)
| Notify that an entity material LOD change event has occurred.
void | _notifyEntityMeshLodChanged (EntityMeshLodChangedEvent &evt)
| Notify that an entity mesh LOD change event has occurred.
void | _notifyMovableObjectLodChanged (MovableObjectLodChangedEvent &evt)
| Notify that a movable object LOD change event has occurred.
RenderContext * | _pauseRendering ()
| Pause rendering of the frame.
void | _releaseManualHardwareResources ()
| Notifies the scene manager that hardware resources were lost.
void | _renderQueueGroupObjects (RenderQueueGroup *group, QueuedRenderableCollection::OrganisationMode om)
| Render the objects in a given queue group.
virtual void | _renderScene (Camera *camera, Viewport *vp, bool includeOverlays=true)
| Prompts the class to send its contents to the renderer.
void | _renderVisibleObjects (void)
| Sends visible objects found in _findVisibleObjects to the rendering engine.
void | _restoreManualHardwareResources ()
| Notifies the scene manager that hardware resources should be restored.
void | _resumeRendering (RenderContext *context)
| Resume rendering of the frame.
void | _setActiveCompositorChain (CompositorChain *chain)
| Sets the active compositor chain of the current scene being rendered.
void | _setDestinationRenderSystem (RenderSystem *sys)
| Notifies the scene manager of its destination render system.
const Pass * | _setPass (const Pass *pass, bool shadowDerivation=true)
| Internal method for setting up the renderstate for a rendering pass.
virtual void | _updateSceneGraph (Camera *cam)
| Internal method for updating the scene graph ie the tree of SceneNode instances managed by this class.
void | addListener (Listener *s)
| Add a listener which will get called back on scene manager events.
void | addLodListener (LodListener *listener)
| Add a level of detail listener.
void | addRenderObjectListener (RenderObjectListener *newListener)
| Registers a new Render Object Listener which will be notified when rendering an object.
void | addRenderQueueListener (RenderQueueListener *newListener)
| Registers a new RenderQueueListener which will be notified when render queues are processed.
void | addShadowTextureListener (ShadowTextureListener *s)
| Add a listener which will get called back on shadow texture events.
void | addSpecialCaseRenderQueue (uint8 qid)
| Adds an item to the 'special case' render queue list.
void | clearSpecialCaseRenderQueues (void)
| Clears the 'special case' render queue list.
const ColourValue & | getAmbientLight (void) const
| Returns the ambient light level to be used for the scene.
Viewport * | getCurrentViewport (void) const
| Gets the current viewport being rendered (advanced use only, only valid during viewport update.
RenderSystem * | getDestinationRenderSystem ()
| Get the rendersystem subclass to which the output of this Scene Manager gets sent.
bool | getFindVisibleObjects (void)
| Gets whether the SceneManager should search for visible objects, or whether they are being manually handled.
bool | getFlipCullingOnNegativeScale () const
| Get whether to automatically flip the culling mode on objects whenever they are negatively scaled.
const String & | getName (void) const
| Return the instance name of this SceneManager.
virtual bool | getOption (const String &strKey, void *pDestValue)
| Method for getting the value of an implementation-specific Scene Manager option.
virtual bool | getOptionKeys (StringVector &refKeys)
| Method for getting all the implementation-specific options of the scene manager.
virtual bool | getOptionValues (const String &strKey, StringVector &refValueList)
| Method for getting all possible values for a specific option.
SceneMgrQueuedRenderableVisitor * | getQueuedRenderableVisitor (void) const
| Gets the current visitor object which processes queued renderables.
RenderQueue * | getRenderQueue (void)
| Retrieves the internal render queue, for advanced users only.
const VisibleObjectsBoundsInfo & | getShadowCasterBoundsInfo (const Light *light, size_t iteration=0) const
SpecialCaseRenderQueueMode | getSpecialCaseRenderQueueMode (void)
| Gets the way the special case render queue list is processed.
uint32 | getVisibilityMask (void)
| Gets a mask which is bitwise 'and'ed with objects own visibility masks to determine if the object is visible.
const VisibleObjectsBoundsInfo & | getVisibleObjectsBoundsInfo (const Camera *cam) const
| Returns a visibility boundary box for a specific camera.
uint8 | getWorldGeometryRenderQueue ()
| Gets the render queue that the world geometry (if any) this SceneManager renders will be associated with.
virtual bool | hasOption (const String &strKey) const
| Method for verifying whether the scene manager has an implementation-specific option.
bool | isLateMaterialResolving () const
| Gets whether using late material resolving or not.
bool | isRenderQueueToBeProcessed (uint8 qid)
| Returns whether or not the named queue will be rendered based on the current 'special case' render queue list and mode.
void | manualRender (Renderable *rend, const Pass *pass, Viewport *vp, const Affine3 &viewMatrix, const Matrix4 &projMatrix, bool doBeginEndFrame=false, bool lightScissoringClipping=true, bool doLightIteration=true, const LightList *manualLightList=0)
| Manual rendering method for rendering a single object.
void | manualRender (RenderOperation *rend, Pass *pass, Viewport *vp, const Affine3 &worldMatrix, const Affine3 &viewMatrix, const Matrix4 &projMatrix, bool doBeginEndFrame=false)
| Manual rendering method, for advanced users only.
| OGRE_MUTEX (sceneGraphMutex)
| Mutex to protect the scene graph from simultaneous access from multiple threads.
void | removeListener (Listener *s)
| Remove a listener.
void | removeLodListener (LodListener *listener)
| Remove a level of detail listener.
void | removeRenderObjectListener (RenderObjectListener *delListener)
| Removes a listener previously added with addRenderObjectListener.
void | removeRenderQueueListener (RenderQueueListener *delListener)
| Removes a listener previously added with addRenderQueueListener.
void | removeShadowTextureListener (ShadowTextureListener *s)
| Remove a listener.
void | removeSpecialCaseRenderQueue (uint8 qid)
| Removes an item to the 'special case' render queue list.
void | setAmbientLight (const ColourValue &colour)
| Sets the ambient light level to be used for the scene.
void | setFindVisibleObjects (bool find)
| Sets whether the SceneManager should search for visible objects, or whether they are being manually handled.
void | setFlipCullingOnNegativeScale (bool n)
| Set whether to automatically flip the culling mode on objects whenever they are negatively scaled.
void | setLateMaterialResolving (bool isLate)
| Sets whether to use late material resolving or not.
virtual bool | setOption (const String &strKey, const void *pValue)
| Method for setting a specific option of the Scene Manager.
void | setQueuedRenderableVisitor (SceneMgrQueuedRenderableVisitor *visitor)
| Advanced method for supplying an alternative visitor, used for parsing the render queues and sending the results to the renderer.
void | setSpecialCaseRenderQueueMode (SpecialCaseRenderQueueMode mode)
| Sets the way the special case render queue list is processed.
void | setVisibilityMask (uint32 vmask)
| Sets a mask which is bitwise 'and'ed with objects own visibility masks to determine if the object is visible.
void | setVPRTCameras (const std::vector< const Camera * > &cameras) const
void | setWorldGeometryRenderQueue (uint8 qid)
| Sets the render queue that the world geometry (if any) this SceneManager renders will be associated with.
virtual Camera * | createCamera (const String &name)
| Creates a camera to be managed by this scene manager.
Camera * | getCamera (const String &name) const
| Retrieves a pointer to the named camera.
bool | hasCamera (const String &name) const
| Returns whether a camera with the given name exists.
void | destroyCamera (Camera *cam)
| Removes a camera from the scene.
void | destroyCamera (const String &name)
| Removes a camera from the scene.
void | destroyAllCameras (void)
| Removes (and destroys) all cameras from the scene.
void | setCameraRelativeRendering (bool rel)
| Set whether to use camera-relative coordinates when rendering, ie to always place the camera at the origin and move the world around it.
bool | getCameraRelativeRendering () const
| Get whether to use camera-relative coordinates when rendering, ie to always place the camera at the origin and move the world around it.
CameraIterator | getCameraIterator (void)
| Returns a specialised MapIterator over all cameras in the scene.
const CameraList & | getCameras () const
| Returns a const version of the camera list.
virtual Light * | createLight (const String &name)
| Creates a light for use in the scene.
Light * | createLight (const String &name, Light::LightTypes type)
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
virtual Light * | createLight ()
| Creates a light with a generated name.
Light * | createLight (Light::LightTypes type)
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
virtual Light * | getLight (const String &name) const
| Get a reference to a previously created object instance.
virtual bool | hasLight (const String &name) const
| Returns whether a object instance with the given name exists.
const PlaneList & | getLightClippingPlanes (Light *l)
| Retrieve a set of clipping planes for a given light.
const RealRect & | getLightScissorRect (Light *l, const Camera *cam)
| Retrieve a scissor rectangle for a given light and camera.
virtual void | invalidatePerFrameScissorRectCache ()
| Scissor rects are cached during frame, and this cache should be explicitly invalidated if several renders are done during one frame using different projections matrices, for example for tiled, stereo or multiview orthographic projection rendering.
virtual void | destroyLight (const String &name)
| Removes the light from the scene and destroys it.
void | destroyLight (Light *light)
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
virtual void | destroyAllLights (void)
| Removes and destroys all lights in the scene.
void | _notifyLightsDirty (void)
| Advanced method to increase the lights dirty counter due to lights having changed.
ulong | _getLightsDirtyCounter (void) const
| Advanced method to gets the lights dirty counter.
const LightList & | _getLightsAffectingFrustum (void) const
| Get the list of lights which could be affecting the frustum.
void | _populateLightList (const Vector3 &position, Real radius, LightList &destList, uint32 lightMask=0xFFFFFFFF)
| Populate a light list with an ordered set of the lights which are closest to the position specified.
void | _populateLightList (const SceneNode *sn, Real radius, LightList &destList, uint32 lightMask=0xFFFFFFFF)
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
SceneNode * | createSceneNode (void)
| Creates an instance of a SceneNode.
SceneNode * | createSceneNode (const String &name)
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
virtual void | destroySceneNode (SceneNode *sn)
| Destroys a SceneNode.
void | destroySceneNode (const String &name)
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
SceneNode * | getRootSceneNode (void)
| Gets the SceneNode at the root of the scene hierarchy.
SceneNode * | getSceneNode (const String &name, bool throwExceptionIfNotFound=true) const
| Retrieves a named SceneNode from the scene graph.
bool | hasSceneNode (const String &name) const
| Returns whether a scene node with the given name exists.
void | setDisplaySceneNodes (bool display)
| Tells the SceneManager whether it should render the SceneNodes which make up the scene as well as the objects in the scene.
bool | getDisplaySceneNodes (void) const
| Returns true if all scene nodes axis are to be displayed.
void | showBoundingBoxes (bool bShow)
| Allows all bounding boxes of scene nodes to be displayed.
bool | getShowBoundingBoxes () const
| Returns if all bounding boxes of scene nodes are to be displayed.
DebugDrawer * | getDebugDrawer () const
Entity * | createEntity (const String &entityName, const String &meshName, const String &groupName=ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME)
| Create an Entity (instance of a discrete mesh).
Entity * | createEntity (const String &entityName, const MeshPtr &pMesh)
| Create an Entity (instance of a discrete mesh).
Entity * | createEntity (const String &meshName)
| Create an Entity (instance of a discrete mesh) with an autogenerated name.
Entity * | createEntity (const MeshPtr &pMesh)
| Create an Entity (instance of a discrete mesh) with an autogenerated name.
Entity * | getEntity (const String &name) const
| Get a reference to a previously created object instance.
bool | hasEntity (const String &name) const
| Returns whether a object instance with the given name exists.
void | destroyEntity (MovableObject *ent)
| Removes & destroys an Entity from the SceneManager.
void | destroyEntity (const String &name)
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void | destroyAllEntities (void)
| Removes & destroys all Entities.
ManualObject * | createManualObject (const String &name)
| Create a ManualObject, an object which you populate with geometry manually through a GL immediate-mode style interface.
ManualObject * | createManualObject ()
| Create a ManualObject, an object which you populate with geometry manually through a GL immediate-mode style interface, generating the name.
ManualObject * | getManualObject (const String &name) const
| Get a reference to a previously created object instance.
bool | hasManualObject (const String &name) const
| Returns whether a object instance with the given name exists.
void | destroyManualObject (MovableObject *obj)
| Removes & destroys a ManualObject from the SceneManager.
void | destroyManualObject (const String &name)
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void | destroyAllManualObjects (void)
| Removes & destroys all ManualObjects from the SceneManager.
Rectangle2D * | createScreenSpaceRect (const String &name, bool includeTextureCoords=false)
| Creates a Rectangle2D that can be displayed for screen space effects or showing a basic GUI.
Rectangle2D * | createScreenSpaceRect (bool includeTextureCoords=false)
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool | hasScreenSpaceRect (const String &name) const
| Returns whether a object instance with the given name exists.
Rectangle2D * | getScreenSpaceRect (const String &name) const
| Get a reference to a previously created object instance.
BillboardChain * | createBillboardChain (const String &name)
| Create a BillboardChain, an object which you can use to render a linked chain of billboards.
BillboardChain * | createBillboardChain ()
| Create a BillboardChain, an object which you can use to render a linked chain of billboards, with a generated name.
BillboardChain * | getBillboardChain (const String &name) const
| Get a reference to a previously created object instance.
bool | hasBillboardChain (const String &name) const
| Returns whether a object instance with the given name exists.
void | destroyBillboardChain (MovableObject *obj)
| Removes & destroys a BillboardChain from the SceneManager.
void | destroyBillboardChain (const String &name)
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void | destroyAllBillboardChains (void)
| Removes & destroys all BillboardChains from the SceneManager.
RibbonTrail * | createRibbonTrail (const String &name)
| Create a RibbonTrail, an object which you can use to render a linked chain of billboards which follows one or more nodes.
RibbonTrail * | createRibbonTrail ()
| Create a RibbonTrail, an object which you can use to render a linked chain of billboards which follows one or more nodes, generating the name.
RibbonTrail * | getRibbonTrail (const String &name) const
| Get a reference to a previously created object instance.
bool | hasRibbonTrail (const String &name) const
| Returns whether a object instance with the given name exists.
void | destroyRibbonTrail (MovableObject *obj)
| Removes & destroys a RibbonTrail from the SceneManager.
void | destroyRibbonTrail (const String &name)
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void | destroyAllRibbonTrails (void)
| Removes & destroys all RibbonTrails from the SceneManager.
ParticleSystem * | createParticleSystem (const String &name, const String &templateName)
| Creates a particle system based on a template.
ParticleSystem * | createParticleSystem (const String &name, size_t quota=500, const String &resourceGroup=ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME)
| Create a blank particle system.
ParticleSystem * | createParticleSystem (size_t quota=500, const String &resourceGroup=ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME)
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
ParticleSystem * | getParticleSystem (const String &name) const
| Get a reference to a previously created object instance.
bool | hasParticleSystem (const String &name) const
| Returns whether a object instance with the given name exists.
void | destroyParticleSystem (MovableObject *obj)
| Removes & destroys a ParticleSystem from the SceneManager.
void | destroyParticleSystem (const String &name)
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void | destroyAllParticleSystems (void)
| Removes & destroys all ParticleSystems from the SceneManager.
void | setSkyRenderingEnabled (bool enable)
| Enables / disables a 'sky'.
bool | isSkyRenderingEnabled (void) const
| Return whether a sky is enabled.
SceneNode * | getSkyNode (void) const
| Get the sky node, if enabled.
void | setSkyPlane (bool enable, const Plane &plane, const String &materialName, Real scale=1000, Real tiling=10, bool drawFirst=true, Real bow=0, int xsegments=1, int ysegments=1, const String &groupName=ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME)
| Enables / disables a 'sky plane' i.e.
void | _setSkyPlane (bool enable, const Plane &plane, const String &materialName, Real scale=1000, Real tiling=10, uint8 renderQueue=RENDER_QUEUE_SKIES_EARLY, Real bow=0, int xsegments=1, int ysegments=1, const String &groupName=ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME)
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void | setSkyPlaneEnabled (bool enable)
bool | isSkyPlaneEnabled (void) const
SceneNode * | getSkyPlaneNode (void) const
SkyPlaneGenParameters | getSkyPlaneGenParameters (void) const
void | setSkyBox (bool enable, const String &materialName, Real distance=5000, bool drawFirst=true, const Quaternion &orientation=Quaternion::IDENTITY, const String &groupName=ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME)
| Enables / disables a 'sky box' i.e.
void | _setSkyBox (bool enable, const String &materialName, Real distance=5000, uint8 renderQueue=RENDER_QUEUE_SKIES_EARLY, const Quaternion &orientation=Quaternion::IDENTITY, const String &groupName=ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME)
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void | setSkyBoxEnabled (bool enable)
bool | isSkyBoxEnabled (void) const
SceneNode * | getSkyBoxNode (void) const
SkyBoxGenParameters | getSkyBoxGenParameters (void) const
void | setSkyDome (bool enable, const String &materialName, Real curvature=10, Real tiling=8, Real distance=4000, bool drawFirst=true, const Quaternion &orientation=Quaternion::IDENTITY, int xsegments=16, int ysegments=16, int ysegments_keep=-1, const String &groupName=ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME)
| Enables / disables a 'sky dome' i.e.
void | _setSkyDome (bool enable, const String &materialName, Real curvature=10, Real tiling=8, Real distance=4000, uint8 renderQueue=RENDER_QUEUE_SKIES_EARLY, const Quaternion &orientation=Quaternion::IDENTITY, int xsegments=16, int ysegments=16, int ysegments_keep=-1, const String &groupName=ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME)
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void | setSkyDomeEnabled (bool enable)
bool | isSkyDomeEnabled (void) const
SceneNode * | getSkyDomeNode (void) const
SkyDomeGenParameters | getSkyDomeGenParameters (void) const
void | setFog (FogMode mode=FOG_NONE, const ColourValue &colour=ColourValue::White, Real expDensity=0.001f, Real linearStart=0.0f, Real linearEnd=1.0f)
| Sets the fogging mode applied to the scene.
FogMode | getFogMode (void) const
| Returns the fog mode for the scene.
const ColourValue & | getFogColour (void) const
| Returns the fog colour for the scene.
Real | getFogStart (void) const
| Returns the fog start distance for the scene.
Real | getFogEnd (void) const
| Returns the fog end distance for the scene.
Real | getFogDensity (void) const
| Returns the fog density for the scene.
BillboardSet * | createBillboardSet (unsigned int poolSize=20)
| Creates a new BillboardSet for use with this scene manager.
BillboardSet * | createBillboardSet (const String &name, unsigned int poolSize=20)
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
BillboardSet * | getBillboardSet (const String &name) const
| Retrieves a pointer to the named BillboardSet.
bool | hasBillboardSet (const String &name) const
| Returns whether a billboardset with the given name exists.
void | destroyBillboardSet (MovableObject *set)
| Removes & destroys an BillboardSet from the SceneManager.
void | destroyBillboardSet (const String &name)
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void | destroyAllBillboardSets (void)
| Removes & destroys all BillboardSets.
void | _applySceneAnimations (void)
| Internal method for applying animations to scene nodes.
Animation * | createAnimation (const String &name, Real length) override
| Creates an animation which can be used to animate scene nodes.
Animation * | getAnimation (const String &name) const override
| Looks up an Animation object previously created with createAnimation.
bool | hasAnimation (const String &name) const override
| Returns whether this object contains the named animation.
uint16 | getNumAnimations (void) const override
| Gets the number of animations in this container.
Animation * | getAnimation (unsigned short index) const override
| Retrieve an animation by index.
void | removeAnimation (const String &name) override
| Remove & destroy an Animation from this container.
void | destroyAnimation (const String &name)
void | destroyAllAnimations (void)
| Removes all animations created using this SceneManager.
AnimationState * | createAnimationState (const String &animName)
| Create an AnimationState object for managing application of animations.
AnimationState * | getAnimationState (const String &animName) const
| Retrieves animation state as previously created using createAnimationState.
bool | hasAnimationState (const String &name) const
| Returns whether an animation state with the given name exists.
void | destroyAnimationState (const String &name)
| Destroys an AnimationState.
void | destroyAllAnimationStates (void)
| Removes all animation states created using this SceneManager.
AnimationIterator | getAnimationIterator (void)
| Returns a specialised MapIterator over all animations in the scene.
const AnimationList & | getAnimations () const
| Returns a const version of the animation list.
AnimationStateIterator | getAnimationStateIterator (void)
| Returns a specialised MapIterator over all animation states in the scene.
const AnimationStateMap & | getAnimationStates ()
| Returns a specialised Map over all animation states in the scene.
virtual AxisAlignedBoxSceneQuery * | createAABBQuery (const AxisAlignedBox &box, uint32 mask=0xFFFFFFFF)
| Creates an AxisAlignedBoxSceneQuery for this scene manager.
virtual SphereSceneQuery * | createSphereQuery (const Sphere &sphere, uint32 mask=0xFFFFFFFF)
| Creates a SphereSceneQuery for this scene manager.
virtual PlaneBoundedVolumeListSceneQuery * | createPlaneBoundedVolumeQuery (const PlaneBoundedVolumeList &volumes, uint32 mask=0xFFFFFFFF)
| Creates a PlaneBoundedVolumeListSceneQuery for this scene manager.
void | destroyQuery (SceneQuery *query)
| Destroys a scene query of any type.
void | setShadowTechnique (ShadowTechnique technique)
| Sets the general shadow technique to be used in this scene.
ShadowTechnique | getShadowTechnique (void) const
| Gets the current shadow technique.
void | setShadowColour (const ColourValue &colour)
| Set the colour used to modulate areas in shadow.
const ColourValue & | getShadowColour (void) const
| Get the colour used to modulate areas in shadow.
void | setShadowDirectionalLightExtrusionDistance (Real dist)
| Sets the distance a shadow volume is extruded for a directional light.
Real | getShadowDirectionalLightExtrusionDistance (void) const
| Gets the distance a shadow volume is extruded for a directional light.
bool | isShadowTechniqueStencilBased (void) const
| Is there a stencil shadow based shadowing technique in use?
bool | isShadowTechniqueTextureBased (void) const
| Is there a texture shadow based shadowing technique in use?
bool | isShadowTechniqueModulative (void) const
| Is there a modulative shadowing technique in use?
bool | isShadowTechniqueAdditive (void) const
| Is there an additive shadowing technique in use?
bool | isShadowTechniqueIntegrated (void) const
| Is the shadow technique integrated into primary materials?
bool | isShadowTechniqueInUse (void) const
| Is there any shadowing technique in use?
void | setShowDebugShadows (bool debug)
| Enables / disables the rendering of debug information for shadows.
bool | getShowDebugShadows (void) const
| Are debug shadows shown?
void | setShadowIndexBufferSize (size_t size)
| Sets the maximum size of the index buffer used to render shadow primitives.
size_t | getShadowIndexBufferSize (void) const
| Get the size of the shadow index buffer.
void | setShadowUseInfiniteFarPlane (bool enable)
| Sets whether we should use an infinite camera far plane when rendering stencil shadows.
void | setShadowUseLightClipPlanes (bool enabled)
| Sets whether when using a built-in additive shadow mode, user clip planes should be used to restrict light rendering.
bool | getShadowUseLightClipPlanes () const
| Gets whether when using a built-in additive shadow mode, user clip planes should be used to restrict light rendering.
void | setShadowFarDistance (Real distance)
| Sets the default maximum distance away from the camera that shadows will be visible.
Real | getShadowFarDistance (void) const
| Gets the default maximum distance away from the camera that shadows will be visible.
Real | getShadowFarDistanceSquared (void) const
virtual void | updateShadowTextures (Camera *cam, Viewport *vp, const LightList *lightList=0)
| Method for update shadow textures ready for use in a regular render Do not call manually unless before frame start or rendering is paused If lightList is not supplied, will render all lights in frustum.
void | prepareShadowTextures (Camera *cam, Viewport *vp, const LightList *lightList=0)
void | setShadowTextureSize (unsigned short size)
| Set the size of the texture used for all texture-based shadows.
void | setShadowTextureConfig (size_t shadowIndex, uint16 width, uint16 height, PixelFormat format, uint16 fsaa=0, uint16 depthBufferPoolId=1)
| Set the detailed configuration for a shadow texture.
void | setShadowTextureConfig (size_t shadowIndex, const ShadowTextureConfig &config)
| Set the detailed configuration for a shadow texture.
const ShadowTextureConfigList & | getShadowTextureConfigList () const
| Get the current shadow texture settings.
ConstShadowTextureConfigIterator | getShadowTextureConfigIterator () const
void | setShadowTexturePixelFormat (PixelFormat fmt)
| Set the pixel format of the textures used for texture-based shadows.
void | setShadowTextureFSAA (unsigned short fsaa)
| Set the level of multisample AA of the textures used for texture-based shadows.
void | setShadowTextureCount (size_t count)
| Set the number of textures allocated for texture-based shadows.
size_t | getShadowTextureCount (void) const
void | setShadowTextureCountPerLightType (Light::LightTypes type, size_t count)
| Set the number of shadow textures a light type uses.
size_t | getShadowTextureCountPerLightType (Light::LightTypes type) const
| Get the number of shadow textures is assigned for the given light type.
void | setShadowTextureSettings (uint16 size, uint16 count, PixelFormat fmt=PF_BYTE_RGBA, uint16 fsaa=0, uint16 depthBufferPoolId=1)
| Sets the size and count of textures used in texture-based shadows.
void | setShadowTextureCompositor (const String &compositorName, const String &resourceGroup=RGN_DEFAULT)
| Sets the configuration of textures used for texture-based shadows.
const TexturePtr & | getShadowTexture (size_t shadowIndex)
| Get a reference to the shadow texture currently in use at the given index.
void | setShadowDirLightTextureOffset (Real offset)
| Sets the proportional distance which a texture shadow which is generated from a directional light will be offset into the camera view to make best use of texture space.
Real | getShadowDirLightTextureOffset (void) const
| Gets the proportional distance which a texture shadow which is generated from a directional light will be offset into the camera view to make best use of texture space.
void | setShadowTextureFadeStart (Real fadeStart)
| Sets the proportional distance at which texture shadows begin to fade out.
void | setShadowTextureFadeEnd (Real fadeEnd)
| Sets the proportional distance at which texture shadows finish to fading out.
void | setShadowTextureSelfShadow (bool selfShadow)
| Sets whether or not texture shadows should attempt to self-shadow.
bool | getShadowTextureSelfShadow (void) const
| Gets whether or not texture shadows attempt to self-shadow.
void | setShadowTextureCasterMaterial (const MaterialPtr &mat)
| Sets the default material to use for rendering shadow casters.
void | setShadowTextureReceiverMaterial (const MaterialPtr &mat)
| Sets the default material to use for rendering shadow receivers.
void | setShadowCasterRenderBackFaces (bool bf)
| Sets whether or not shadow casters should be rendered into shadow textures using their back faces rather than their front faces.
bool | getShadowCasterRenderBackFaces () const
| Gets whether or not shadow casters should be rendered into shadow textures using their back faces rather than their front faces.
void | setShadowCameraSetup (const ShadowCameraSetupPtr &shadowSetup)
| Set the shadow camera setup to use for all lights which don't have their own shadow camera setup.
const ShadowCameraSetupPtr & | getShadowCameraSetup () const
| Get the shadow camera setup in use for all lights which don't have their own shadow camera setup.
StaticGeometry * | createStaticGeometry (const String &name)
| Creates a StaticGeometry instance suitable for use with this SceneManager.
StaticGeometry * | getStaticGeometry (const String &name) const
| Retrieve a previously created StaticGeometry instance.
bool | hasStaticGeometry (const String &name) const
| Returns whether a static geometry instance with the given name exists.
const StaticGeometryMap * | getStaticGeometryCollection () const
| Returns all static geometry instances with names.
void | destroyStaticGeometry (StaticGeometry *geom)
| Remove & destroy a StaticGeometry instance.
void | destroyStaticGeometry (const String &name)
| Remove & destroy a StaticGeometry instance.
void | destroyAllStaticGeometry (void)
| Remove & destroy all StaticGeometry instances.
InstanceManager * | createInstanceManager (const String &customName, const String &meshName, const String &groupName, InstanceManager::InstancingTechnique technique, size_t numInstancesPerBatch, uint16 flags=0, unsigned short subMeshIdx=0)
| Creates an InstanceManager interface to create & manipulate instanced entities You need to call this function at least once before start calling createInstancedEntity to build up an instance based on the given mesh.
InstanceManager * | getInstanceManager (const String &managerName) const
| Retrieves an existing InstanceManager by it's name.
bool | hasInstanceManager (const String &managerName) const
| Returns whether an InstanceManager with the given name exists.
void | destroyInstanceManager (const String &name)
| Destroys an InstanceManager if it was created with createInstanceManager().
void | destroyInstanceManager (InstanceManager *instanceManager)
void | destroyAllInstanceManagers (void)
size_t | getNumInstancesPerBatch (const String &meshName, const String &groupName, const String &materialName, InstanceManager::InstancingTechnique technique, size_t numInstancesPerBatch, uint16 flags=0, unsigned short subMeshIdx=0)
InstancedEntity * | createInstancedEntity (const String &materialName, const String &managerName)
| Creates an InstancedEntity based on an existing InstanceManager.
void | destroyInstancedEntity (InstancedEntity *instancedEntity)
| Removes an InstancedEntity,.
void | _addDirtyInstanceManager (InstanceManager *dirtyManager)
| Called by an InstanceManager when it has at least one InstanceBatch that needs their bounds to be updated for proper culling.
MovableObject * | createMovableObject (const String &name, const String &typeName, const NameValuePairList *params=0)
| Create a movable object of the type specified.
MovableObject * | createMovableObject (const String &typeName, const NameValuePairList *params=0)
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void | destroyMovableObject (const String &name, const String &typeName)
| Destroys a MovableObject with the name specified, of the type specified.
void | destroyMovableObject (MovableObject *m)
| Destroys a MovableObject.
void | destroyAllMovableObjectsByType (const String &typeName)
| Destroy all MovableObjects of a given type.
void | destroyAllMovableObjects (void)
| Destroy all MovableObjects.
MovableObject * | getMovableObject (const String &name, const String &typeName) const
| Get a reference to a previously created object instance.
bool | hasMovableObject (const String &name, const String &typeName) const
| Returns whether a object instance with the given name exists.
const MovableObjectMap & | getMovableObjects (const String &typeName)
| Get all MovableObect instances of a given type.
MovableObjectIterator | getMovableObjectIterator (const String &typeName)
void | injectMovableObject (MovableObject *m)
| Inject a MovableObject instance created externally.
void | extractMovableObject (const String &name, const String &typeName)
| Extract a previously injected MovableObject.
void | extractMovableObject (MovableObject *m)
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void | extractAllMovableObjectsByType (const String &typeName)
| Extract all injected MovableObjects of a given type.
Public Member Functions inherited from Ogre::AnimationContainer
virtual | ~AnimationContainer ()

## Additional Inherited Members

Public Types inherited from Ogre::SceneManager
typedef MapIterator< AnimationList > | AnimationIterator
typedef MapIterator< CameraList > | CameraIterator
typedef std::map< String, Camera * > | CameraList
enum | IlluminationRenderStage { IRS_NONE , IRS_RENDER_TO_TEXTURE , IRS_RENDER_RECEIVER_PASS }
| Describes the stage of rendering when performing complex illumination. More...
typedef MapIterator< MovableObjectMap > | MovableObjectIterator
typedef std::map< String, MovableObject * > | MovableObjectMap
enum | QueryTypeMask : uint32 { WORLD_GEOMETRY_TYPE_MASK = 0x80000000 , ENTITY_TYPE_MASK = 0x40000000 , FX_TYPE_MASK = 0x20000000 , STATICGEOMETRY_TYPE_MASK = 0x10000000 , LIGHT_TYPE_MASK = 0x08000000 , FRUSTUM_TYPE_MASK = 0x04000000 , USER_TYPE_MASK_LIMIT = FRUSTUM_TYPE_MASK }
enum | SpecialCaseRenderQueueMode { SCRQM_INCLUDE , SCRQM_EXCLUDE }
| Enumeration of the possible modes allowed for processing the special case render queue list. More...
typedef std::map< String, StaticGeometry * > | StaticGeometryMap
Public Types inherited from Ogre::AnimationContainer
typedef std::map< String, Animation * > | AnimationList
Static Public Member Functions inherited from Ogre::SceneManager
static bool | hasPerRenderableLights ()
static void | usePerRenderableLights (bool enabled)
| Toggle sorting of lights for each renderable.
Static Public Attributes inherited from Ogre::SceneManager
static constexpr const char * | PT_CUBE = "Prefab_Cube"
| 100x100x100 cube centred at origin with normals and UVs
static constexpr const char * | PT_PLANE = "Prefab_Plane"
| XY plane with -100..100 extent, +Z normal and UVs.
static constexpr const char * | PT_SPHERE = "Prefab_Sphere"

## Detailed Description

Specialisation of the SceneManager class to deal with indoor scenes based on a BSP tree.

This class refines the behaviour of the default SceneManager to manage a scene whose bulk of geometry is made up of an indoor environment which is organised by a Binary Space Partition (BSP) tree. A BSP tree progressively subdivides the space using planes which are the nodes of the tree. At some point we stop subdividing and everything in the remaining space is part of a 'leaf' which contains a number of polygons. Typically we traverse the tree to locate the leaf in which a point in space is (say the camera origin) and work from there. A second structure, the Potentially Visible Set, tells us which other leaves can been seen from this leaf, and we test their bounding boxes against the camera frustum to see which we need to draw. Leaves are also a good place to start for collision detection since they divide the level into discrete areas for testing. This BSP and PVS technique has been made famous by engines such as Quake and Unreal. Ogre provides support for loading Quake3 level files to populate your world through this class, by calling the BspSceneManager::setWorldGeometry. Note that this interface is made available at the top level of the SceneManager class so you don't have to write your code specifically for this class - just call Root::getSceneManager passing a SceneType of ST_INTERIOR and in the current implementation you will get a BspSceneManager silently disguised as a standard SceneManager.

## Constructor & Destructor Documentation

## BspSceneManager()

Ogre::BspSceneManager::BspSceneManager | ( | const String & | name | ) |

## ~BspSceneManager()

Ogre::BspSceneManager::~BspSceneManager | ( |  | ) |

## Member Function Documentation

## getTypeName()

const String & Ogre::BspSceneManager::getTypeName | ( | void |  | ) | const

override virtual

Retrieve the type name of this scene manager.

This method has to be implemented by subclasses. It should return the type name of this SceneManager which agrees with the type name of the SceneManagerFactory which created it.

Implements Ogre::SceneManager.

## setWorldGeometry() [1/2]

void Ogre::BspSceneManager::setWorldGeometry | ( | const String & | filename | ) |

override virtual

Specialised from SceneManager to support Quake3 bsp files.

Reimplemented from Ogre::SceneManager.

## estimateWorldGeometry() [1/2]

size_t Ogre::BspSceneManager::estimateWorldGeometry | ( | const String & | filename | ) |

override virtual

Specialised from SceneManager to support Quake3 bsp files.

Reimplemented from Ogre::SceneManager.

## setWorldGeometry() [2/2]

void Ogre::BspSceneManager::setWorldGeometry | ( | DataStreamPtr & | stream,
|  | const String & | typeName = BLANKSTRING )

override virtual

Specialised from SceneManager to support Quake3 bsp files.

Reimplemented from Ogre::SceneManager.

References Ogre::BLANKSTRING.

## estimateWorldGeometry() [2/2]

size_t Ogre::BspSceneManager::estimateWorldGeometry | ( | DataStreamPtr & | stream,
|  | const String & | typeName = BLANKSTRING )

override virtual

Specialised from SceneManager to support Quake3 bsp files.

Reimplemented from Ogre::SceneManager.

References Ogre::BLANKSTRING.

## showNodeBoxes()

void Ogre::BspSceneManager::showNodeBoxes | ( | bool | show | ) |

Tells the manager whether to draw the axis-aligned boxes that surround nodes in the Bsp tree.

For debugging purposes.

## getSuggestedViewpoint()

ViewPoint Ogre::BspSceneManager::getSuggestedViewpoint | ( | bool | random = false | ) |

override virtual

Specialised to suggest viewpoints.

Reimplemented from Ogre::SceneManager.

## getLevel()

const BspLevelPtr & Ogre::BspSceneManager::getLevel | ( | void |  | ) |

inline

## setLevel()

void Ogre::BspSceneManager::setLevel | ( | const BspLevelPtr & | level | ) |

## _findVisibleObjects()

void Ogre::BspSceneManager::_findVisibleObjects | ( | Camera * | cam,
|  | VisibleObjectsBoundsInfo * | visibleBounds,
|  | bool | onlyShadowCasters )

override virtual

Overridden from SceneManager.

Reimplemented from Ogre::SceneManager.

## createSceneNodeImpl() [1/2]

SceneNode * Ogre::BspSceneManager::createSceneNodeImpl | ( | void |  | ) |

override virtual

Creates a specialized BspSceneNode.

Reimplemented from Ogre::SceneManager.

## createSceneNodeImpl() [2/2]

SceneNode * Ogre::BspSceneManager::createSceneNodeImpl | ( | const String & | name | ) |

override virtual

Creates a specialized BspSceneNode.

Reimplemented from Ogre::SceneManager.

## _notifyObjectMoved()

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

Internal method for tagging BspNodes with objects which intersect them.

## _notifyObjectDetached()

void Ogre::BspSceneManager::_notifyObjectDetached | ( | const MovableObject * | mov | ) |

Internal method for notifying the level that an object has been detached from a node.

## createRayQuery()

RaySceneQuery * Ogre::BspSceneManager::createRayQuery | ( | const Ray & | ray,
|  | uint32 | mask = 0xFFFFFFFF )

override virtual

Creates a RaySceneQuery for this scene manager.

This method creates a new instance of a query object for this scene manager, looking for objects which fall along a ray. See SceneQuery and RaySceneQuery for full details.

  The instance returned from this method must be destroyed by calling SceneManager::destroyQuery when it is no longer required.

Parameters

  ray | Details of the ray which describes the region for this query.
  mask | The query mask to apply to this query; can be used to filter out certain objects; see SceneQuery for details.

Reimplemented from Ogre::SceneManager.

## createIntersectionQuery()

IntersectionSceneQuery * Ogre::BspSceneManager::createIntersectionQuery | ( | uint32 | mask = 0xFFFFFFFF | ) |

override virtual

Creates an IntersectionSceneQuery for this scene manager.

This method creates a new instance of a query object for locating intersecting objects. See SceneQuery and IntersectionSceneQuery for full details.

  The instance returned from this method must be destroyed by calling SceneManager::destroyQuery when it is no longer required.

Parameters

  mask | The query mask to apply to this query; can be used to filter out certain objects; see SceneQuery for details.

Reimplemented from Ogre::SceneManager.

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

- OgreBspSceneManager.h