Specialized SceneManager that uses Portal-Connected-Zones to divide the scene spatially. More...

#include <OgrePCZSceneManager.h>

Inheritance diagram for Ogre::PCZSceneManager:

Public Types
typedef MapIterator< AnimationList >	AnimationIterator

typedef map< String, Animation * >::type	AnimationList

typedef MapIterator< CameraList >	CameraIterator

typedef map< String, Camera *>::type	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

enum	PrefabType { PT_PLANE, PT_CUBE, PT_SPHERE }
	Prefab shapes available without loading a model. More...

enum	SpecialCaseRenderQueueMode { SCRQM_INCLUDE, SCRQM_EXCLUDE }
	Enumeration of the possible modes allowed for processing the special case render queue list. More...

typedef MapIterator< ZoneMap >	ZoneIterator
	ZoneMap iterator for read-only access to the zonemap. More...

Public Member Functions
	PCZSceneManager (const String &name)
	Standard Constructor. More...

	~PCZSceneManager ()
	Standard destructor. More...

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. More...

virtual void	_alertVisibleObjects (void)
	Alerts each unculled object, notifying it that it will be drawn. More...

void	_applySceneAnimations (void)
	Internal method for applying animations to scene nodes. More...

bool	_areRenderStateChangesSuppressed (void) const
	Are render state changes suppressed? More...

bool	_areShadowsSuppressed (void) const
	Are shadows suppressed? More...

void	_calcZonesAffectedByLights (Camera *cam)
	Calculate which zones are affected by each light. More...

void	_clearAllZonesPortalUpdateFlag (void)
	Clear portal update flag from all zones. More...

void	_dirtyNodeByMovingPortals (void)
	Mark nodes dirty for every zone with moving portal in the scene. More...

virtual void	_findVisibleObjects (Camera cam, VisibleObjectsBoundsInfo visibleBounds, bool onlyShadowCasters)
	Recurses through the PCZTree determining which nodes are visible. More...

CompositorChain *	_getActiveCompositorChain () const
	Gets the active compositor chain of the current scene being rendered. More...

uint32	_getCombinedVisibilityMask (void) const
	Internal method for getting the combination between the global visibility mask and the per-viewport visibility mask. More...

IlluminationRenderStage	_getCurrentRenderStage ()

const LightList &	_getLightsAffectingFrustum (void) const
	Get the list of lights which could be affecting the frustum. More...

ulong	_getLightsDirtyCounter (void) const
	Advance method to gets the lights dirty counter. More...

void	_handleLodEvents ()
	Handle LOD events. More...

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. More...

void	_issueRenderOp (Renderable rend, const Pass pass)
	Internal method for issuing the render operation. More...

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. More...

void	_notifyAutotrackingSceneNode (SceneNode *node, bool autoTrack)
	Internal method for notifying the manager that a SceneNode is autotracking. More...

void	_notifyEntityMaterialLodChanged (EntityMaterialLodChangedEvent &evt)
	Notify that an entity material LOD change event has occurred. More...

void	_notifyEntityMeshLodChanged (EntityMeshLodChangedEvent &evt)
	Notify that an entity mesh LOD change event has occurred. More...

void	_notifyLightsDirty (void)
	Advance method to increase the lights dirty counter due lights changed. More...

void	_notifyMovableObjectLodChanged (MovableObjectLodChangedEvent &evt)
	Notify that a movable object LOD change event has occurred. More...

RenderContext *	_pauseRendering ()
	Pause rendering of the frame. More...

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. More...

void	_populateLightList (const SceneNode *sn, Real radius, LightList &destList, uint32 lightMask=0xFFFFFFFF)
	Populates a light list with an ordered set of the lights which are closest to the position of the SceneNode given. More...

void	_queueSkiesForRendering (Camera *cam)
	Internal method for queueing the sky objects with the params as previously set through setSkyBox, setSkyPlane and setSkyDome. More...

void	_releaseManualHardwareResources ()
	Notifies the scene manager that hardware resources were lost. More...

void	_renderQueueGroupObjects (RenderQueueGroup *group, QueuedRenderableCollection::OrganisationMode om)
	Render the objects in a given queue group. More...

void	_renderScene (Camera cam, Viewport vp, bool includeOverlays)
	Overridden from basic scene manager. More...

void	_renderVisibleObjects (void)
	Sends visible objects found in _findVisibleObjects to the rendering engine. More...

void	_restoreManualHardwareResources ()
	Notifies the scene manager that hardware resources should be restored. More...

void	_resumeRendering (RenderContext *context)
	Resume rendering of the frame. More...

void	_setActiveCompositorChain (CompositorChain *chain)
	Sets the active compositor chain of the current scene being rendered. More...

void	_setDestinationRenderSystem (RenderSystem *sys)
	Notifies the scene manager of its destination render system. More...

const Pass *	_setPass (const Pass *pass, bool evenIfSuppressed=false, bool shadowDerivation=true)
	Internal method for setting up the renderstate for a rendering pass. More...

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)

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)

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)

void	_suppressRenderStateChanges (bool suppress)
	Indicates to the SceneManager whether it should suppress changing the RenderSystem states when rendering objects. More...

void	_suppressShadows (bool suppress)
	Indicates to the SceneManager whether it should suppress the active shadow rendering technique until told otherwise. More...

void	_updateHomeZone (PCZSceneNode *, bool)
	Make sure the home zone for the PCZSceneNode is up-to-date. More...

void	_updatePCZSceneNode (PCZSceneNode *)
	Checks the given SceneNode, and determines if it needs to be moved to a different PCZone or be added to the visitors list of other PCZone(s). More...

void	_updatePCZSceneNodes (void)
	Update the PCZSceneNodes. More...

void	_updatePortalZoneData (void)
	Check/Update the zone data for every portal in the scene. More...

virtual void	_updateSceneGraph (Camera *cam)
	Update Scene Graph (does several things now) More...

void	addListener (Listener *s)
	Add a listener which will get called back on scene manager events. More...

void	addLodListener (LodListener *listener)
	Add a level of detail listener. More...

void	addPCZSceneNode (PCZSceneNode sn, PCZone zone)
	add a PCZSceneNode to the scene by putting it in a zone NOTE: This zone will be the scene node's home zone More...

void	addRenderObjectListener (RenderObjectListener *newListener)
	Registers a new Render Object Listener which will be notified when rendering an object. More...

void	addRenderQueueListener (RenderQueueListener *newListener)
	Registers a new RenderQueueListener which will be notified when render queues are processed. More...

void	addSpecialCaseRenderQueue (uint8 qid)
	Adds an item to the 'special case' render queue list. More...

virtual void	clearScene (void)
	Overridden to clean up zones. More...

void	clearSpecialCaseRenderQueues (void)
	Clears the 'special case' render queue list. More...

void	connectPortalsToTargetZonesByLocation (void)

AxisAlignedBoxSceneQuery *	createAABBQuery (const AxisAlignedBox &box, uint32 mask=0xFFFFFFFF)
	Overridden from SceneManager. More...

Animation *	createAnimation (const String &name, Real length)
	Creates an animation which can be used to animate scene nodes. More...

AnimationState *	createAnimationState (const String &animName)
	Create an AnimationState object for managing application of animations. More...

AntiPortal *	createAntiPortal (const String &name, PortalBase::PORTAL_TYPE type=PortalBase::PORTAL_TYPE_QUAD)
	Create a new anti portal instance. More...

BillboardChain *	createBillboardChain (const String &name)
	Create a BillboardChain, an object which you can use to render a linked chain of billboards. More...

BillboardChain *	createBillboardChain ()
	Create a BillboardChain, an object which you can use to render a linked chain of billboards, with a generated name. More...

BillboardSet *	createBillboardSet (unsigned int poolSize=20)
	Creates a new BillboardSet for use with this scene manager. More...

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. More...

virtual Camera *	createCamera (const String &name)
	Creates a specialized PCZCamera. More...

Entity *	createEntity (const String &entityName, const String &meshName, const String &groupName=ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME)
	Create an Entity (instance of a discrete mesh). More...

Entity *	createEntity (const String &entityName, const MeshPtr &pMesh)
	Create an Entity (instance of a discrete mesh). More...

Entity *	createEntity (const String &meshName)
	Create an Entity (instance of a discrete mesh) with an autogenerated name. More...

Entity *	createEntity (const MeshPtr &pMesh)
	Create an Entity (instance of a discrete mesh) with an autogenerated name. More...

Entity *	createEntity (const String &entityName, PrefabType ptype)
	Create an Entity (instance of a discrete mesh) from a range of prefab shapes. More...

Entity *	createEntity (PrefabType ptype)
	Create an Entity (instance of a discrete mesh) from a range of prefab shapes, generating the name. More...

InstancedEntity *	createInstancedEntity (const String &materialName, const String &managerName)
	Creates an InstancedEntity based on an existing InstanceManager (. More...

InstancedGeometry *	createInstancedGeometry (const String &name)
	Creates a InstancedGeometry instance suitable for use with this SceneManager. More...

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. More...

IntersectionSceneQuery *	createIntersectionQuery (uint32 mask=0xFFFFFFFF)
	Creates an IntersectionSceneQuery for this scene manager. More...

virtual Light *	createLight (const String &name)
	Creates a light for use in the scene. More...

virtual Light *	createLight ()
	Creates a light with a generated name. More...

ManualObject *	createManualObject (const String &name)
	Create a ManualObject, an object which you populate with geometry manually through a GL immediate-mode style interface. More...

ManualObject *	createManualObject ()
	Create a ManualObject, an object which you populate with geometry manually through a GL immediate-mode style interface, generating the name. More...

MovableObject *	createMovableObject (const String &name, const String &typeName, const NameValuePairList *params=0)
	Create a movable object of the type specified. More...

MovableObject *	createMovableObject (const String &typeName, const NameValuePairList *params=0)

ParticleSystem *	createParticleSystem (const String &name, const String &templateName)
	Creates a particle system based on a template. More...

ParticleSystem *	createParticleSystem (const String &name, size_t quota=500, const String &resourceGroup=ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME)
	Create a blank particle system. More...

ParticleSystem *	createParticleSystem (size_t quota=500, const String &resourceGroup=ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME)
	Create a blank particle system with a generated name. More...

PlaneBoundedVolumeListSceneQuery *	createPlaneBoundedVolumeQuery (const PlaneBoundedVolumeList &volumes, uint32 mask=0xFFFFFFFF)
	Creates a PlaneBoundedVolumeListSceneQuery for this scene manager. More...

Portal *	createPortal (const String &name, PortalBase::PORTAL_TYPE type=PortalBase::PORTAL_TYPE_QUAD)
	Create a new portal instance. More...

RaySceneQuery *	createRayQuery (const Ray &ray, uint32 mask=0xFFFFFFFF)
	Creates a RaySceneQuery for this scene manager. More...

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. More...

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. More...

virtual SceneNode *	createSceneNode (void)
	Creates a PCZSceneNode. More...

virtual SceneNode *	createSceneNode (const String &name)
	Creates a PCZSceneNode. More...

virtual SceneNode *	createSceneNodeImpl (void)
	override this to ensure specialised PCZSceneNode is used. More...

virtual SceneNode *	createSceneNodeImpl (const String &name)
	override this to ensure their specialised PCZSceneNode is used. More...

SphereSceneQuery *	createSphereQuery (const Sphere &sphere, uint32 mask=0xFFFFFFFF)
	Creates a SphereSceneQuery for this scene manager. More...

StaticGeometry *	createStaticGeometry (const String &name)
	Creates a StaticGeometry instance suitable for use with this SceneManager. More...

PCZone *	createZone (const String &zoneType, const String &instanceName)
	Create a zone with the given name. More...

PCZone *	createZoneFromFile (const String &zoneTypeName, const String &zoneName, PCZSceneNode *parentNode, const String &filename)
	Create a zone from a file (type of file depends on the zone type. More...

void	createZoneSpecificNodeData (PCZSceneNode *)
	Create any zone-specific data necessary for all zones for the given node. More...

void	createZoneSpecificNodeData (PCZone *)
	Create any zone-specific data necessary for all nodes for the given zone. More...

void	destroyAllAnimations (void)
	Removes all animations created using this SceneManager. More...

void	destroyAllAnimationStates (void)
	Removes all animation states created using this SceneManager. More...

void	destroyAllBillboardChains (void)
	Removes & destroys all BillboardChains from the SceneManager. More...

void	destroyAllBillboardSets (void)
	Removes & destroys all BillboardSets. More...

virtual void	destroyAllCameras (void)
	Removes (and destroys) all cameras from the scene. More...

virtual void	destroyAllEntities (void)
	Removes & destroys all Entities. More...

void	destroyAllInstancedGeometry (void)
	Remove & destroy all InstancedGeometry instances. More...

void	destroyAllInstanceManagers (void)

virtual void	destroyAllLights (void)
	Removes and destroys all lights in the scene. More...

void	destroyAllManualObjects (void)
	Removes & destroys all ManualObjects from the SceneManager. More...

void	destroyAllMovableObjects (void)
	Destroy all MovableObjects. More...

void	destroyAllMovableObjectsByType (const String &typeName)
	Destroy all MovableObjects of a given type. More...

void	destroyAllParticleSystems (void)
	Removes & destroys all ParticleSystems from the SceneManager. More...

void	destroyAllRibbonTrails (void)
	Removes & destroys all RibbonTrails from the SceneManager. More...

void	destroyAllStaticGeometry (void)
	Remove & destroy all StaticGeometry instances. More...

void	destroyAnimation (const String &name)
	Destroys an Animation. More...

void	destroyAnimationState (const String &name)
	Destroys an AnimationState. More...

void	destroyAntiPortal (AntiPortal *p)
	Delete a anti portal instance by pointer. More...

void	destroyAntiPortal (const String &portalName)
	Delete a anti portal instance by name. More...

void	destroyBillboardChain (BillboardChain *obj)
	Removes & destroys a BillboardChain from the SceneManager. More...

void	destroyBillboardChain (const String &name)

void	destroyBillboardSet (BillboardSet *set)
	Removes & destroys an BillboardSet from the SceneManager. More...

void	destroyBillboardSet (const String &name)

virtual void	destroyCamera (Camera *cam)
	Removes a camera from the scene. More...

virtual void	destroyCamera (const String &name)
	Removes a camera from the scene. More...

void	destroyEntity (Entity *ent)
	Removes & destroys an Entity from the SceneManager. More...

void	destroyEntity (const String &name)

void	destroyInstancedEntity (InstancedEntity *instancedEntity)
	Removes an InstancedEntity,. More...

void	destroyInstancedGeometry (InstancedGeometry *geom)
	Remove & destroy a InstancedGeometry instance. More...

void	destroyInstancedGeometry (const String &name)
	Remove & destroy a InstancedGeometry instance. More...

void	destroyInstanceManager (const String &name)
	Destroys an InstanceManager if it was created with createInstanceManager() More...

void	destroyInstanceManager (InstanceManager *instanceManager)

virtual void	destroyLight (const String &name)
	Removes the named light from the scene and destroys it. More...

virtual void	destroyLight (Light *light)
	Removes the light from the scene and destroys it based on a pointer. More...

void	destroyManualObject (ManualObject *obj)
	Removes & destroys a ManualObject from the SceneManager. More...

void	destroyManualObject (const String &name)

void	destroyMovableObject (const String &name, const String &typeName)
	Destroys a MovableObject with the name specified, of the type specified. More...

void	destroyMovableObject (MovableObject *m)
	Destroys a MovableObject. More...

void	destroyParticleSystem (ParticleSystem *obj)
	Removes & destroys a ParticleSystem from the SceneManager. More...

void	destroyParticleSystem (const String &name)
	Removes & destroys a ParticleSystem from the SceneManager. More...

void	destroyPortal (Portal *p)
	Delete a portal instance by pointer. More...

void	destroyPortal (const String &portalName)
	Delete a portal instance by name. More...

void	destroyQuery (SceneQuery *query)
	Destroys a scene query of any type. More...

void	destroyRibbonTrail (RibbonTrail *obj)
	Removes & destroys a RibbonTrail from the SceneManager. More...

void	destroyRibbonTrail (const String &name)

virtual void	destroySceneNode (const String &name)
	Deletes a scene node by name & corresponding PCZSceneNode. More...

virtual void	destroySceneNode (SceneNode *sn)
	Deletes a scene node & corresponding PCZSceneNode. More...

void	destroyStaticGeometry (StaticGeometry *geom)
	Remove & destroy a StaticGeometry instance. More...

void	destroyStaticGeometry (const String &name)
	Remove & destroy a StaticGeometry instance. More...

void	destroyZone (PCZone *zone, bool destroySceneNodes)
	Destroy an existing zone within the scene. More...

void	enableSky (bool)
	Enable/disable sky rendering. More...

virtual size_t	estimateWorldGeometry (const String &filename)
	Estimate the number of loading stages required to load the named world geometry. More...

virtual size_t	estimateWorldGeometry (DataStreamPtr &stream, const String &typeName=BLANKSTRING)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...

void	extractAllMovableObjectsByType (const String &typeName)
	Extract all injected MovableObjects of a given type. More...

void	extractMovableObject (const String &name, const String &typeName)
	Extract a previously injected MovableObject. More...

void	extractMovableObject (MovableObject *m)

void	findNodesIn (const AxisAlignedBox &box, PCZSceneNodeList &list, PCZone startZone, PCZSceneNode exclude=0)
	Recurses the scene, adding any nodes intersecting with the box into the given list. More...

void	findNodesIn (const Sphere &sphere, PCZSceneNodeList &list, PCZone startZone, PCZSceneNode start=0)
	Recurses the scene, adding any nodes intersecting with the sphere into the given list. More...

void	findNodesIn (const PlaneBoundedVolume &volume, PCZSceneNodeList &list, PCZone startZone, PCZSceneNode start=0)
	Recurses the PCZTree, adding any nodes intersecting with the volume into the given list. More...

void	findNodesIn (const Ray &ray, PCZSceneNodeList &list, PCZone startZone, PCZSceneNode start=0)
	Recurses the scene, starting in the given startZone, adding any nodes intersecting with the ray into the given list. More...

PCZone *	findZoneForPoint (Vector3 &point)
	Find the smallest zone which contains the point. More...

const ColourValue &	getAmbientLight (void) const
	Returns the ambient light level to be used for the scene. More...

Animation *	getAnimation (const String &name) const
	Looks up an Animation object previously created with createAnimation. More...

AnimationIterator	getAnimationIterator (void)
	Returns a specialised MapIterator over all animations in the scene. More...

const AnimationList &	getAnimations () const
	Returns a const version of the animation list. More...

AnimationState *	getAnimationState (const String &animName) const
	Retrieves animation state as previously created using createAnimationState. More...

AnimationStateIterator	getAnimationStateIterator (void)
	Returns a specialised MapIterator over all animation states in the scene. More...

const AnimationStateMap &	getAnimationStates ()
	Returns a specialised Map over all animation states in the scene. More...

BillboardChain *	getBillboardChain (const String &name) const
	Retrieves a pointer to the named BillboardChain. More...

BillboardSet *	getBillboardSet (const String &name) const
	Retrieves a pointer to the named BillboardSet. More...

Camera *	getCamera (const String &name) const
	Retrieves a pointer to the named camera. More...

CameraIterator	getCameraIterator (void)
	Returns a specialised MapIterator over all cameras in the scene. More...

bool	getCameraRelativeRendering () const
	Get whether to use camera-relative co-ordinates when rendering, ie to always place the camera at the origin and move the world around it. More...

const CameraList &	getCameras () const
	Returns a const version of the camera list. More...

Viewport *	getCurrentViewport (void) const
	Gets the current viewport being rendered (advanced use only, only valid during viewport update. More...

PCZone *	getDefaultZone (void)
	Get the default zone. More...

RenderSystem *	getDestinationRenderSystem ()
	Get the rendersystem subclass to which the output of this Scene Manager gets sent. More...

bool	getDisplaySceneNodes (void) const
	Returns true if all scene nodes axis are to be displayed. More...

Entity *	getEntity (const String &name) const
	Retrieves a pointer to the named Entity. More...

bool	getFindVisibleObjects (void)
	Gets whether the SceneManager should search for visible objects, or whether they are being manually handled. More...

bool	getFlipCullingOnNegativeScale () const
	Get whether to automatically flip the culling mode on objects whenever they are negatively scaled. More...

const ColourValue &	getFogColour (void) const
	Returns the fog colour for the scene. More...

Real	getFogDensity (void) const
	Returns the fog density for the scene. More...

Real	getFogEnd (void) const
	Returns the fog end distance for the scene. More...

FogMode	getFogMode (void) const
	Returns the fog mode for the scene. More...

Real	getFogStart (void) const
	Returns the fog start distance for the scene. More...

InstancedGeometry *	getInstancedGeometry (const String &name) const
	Retrieve a previously created InstancedGeometry instance. More...

InstanceManager *	getInstanceManager (const String &managerName) const
	Retrieves an existing InstanceManager by it's name. More...

virtual Light *	getLight (const String &name) const
	Returns a pointer to the named Light which has previously been added to the scene. More...

const PlaneList &	getLightClippingPlanes (Light *l)
	Retrieve a set of clipping planes for a given light. More...

const RealRect &	getLightScissorRect (Light l, const Camera cam)
	Retrieve a scissor rectangle for a given light and camera. More...

ManualObject *	getManualObject (const String &name) const
	Retrieves a pointer to the named ManualObject. More...

MovableObject *	getMovableObject (const String &name, const String &typeName) const
	Get a reference to a previously created MovableObject. More...

MovableObjectIterator	getMovableObjectIterator (const String &typeName)
	Get an iterator over all MovableObect instances of a given type. More...

const String &	getName (void) const
	Return the instance name of this SceneManager. More...

bool	getNormaliseNormalsOnScale () const
	Get whether to automatically normalise normals on objects whenever they are scaled. More...

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)

virtual bool	getOption (const String &, void *)
	Gets the given option for the Scene Manager. More...

bool	getOptionKeys (StringVector &refKeys)
	Method for getting all the implementation-specific options of the scene manager. More...

bool	getOptionValues (const String &key, StringVector &refValueList)
	Method for getting all possible values for a specific option. More...

ParticleSystem *	getParticleSystem (const String &name) const
	Retrieves a pointer to the named ParticleSystem. More...

SceneMgrQueuedRenderableVisitor *	getQueuedRenderableVisitor (void) const
	Gets the current visitor object which processes queued renderables. More...

RenderQueue *	getRenderQueue (void)
	Retrieves the internal render queue, for advanced users only. More...

RibbonTrail *	getRibbonTrail (const String &name) const
	Retrieves a pointer to the named RibbonTrail. More...

SceneNode *	getRootSceneNode (void)
	Gets the SceneNode at the root of the scene hierarchy. More...

SceneNode *	getSceneNode (const String &name) const
	Retrieves a named SceneNode from the scene graph. More...

const ShadowCameraSetupPtr &	getShadowCameraSetup () const
	Get the shadow camera setup in use for all lights which don't have their own shadow camera setup. More...

const VisibleObjectsBoundsInfo &	getShadowCasterBoundsInfo (const Light *light, size_t iteration=0) const
	Returns the shadow caster AAB for a specific light-camera combination. More...

bool	getShadowCasterRenderBackFaces () const
	Gets whether or not shadow casters should be rendered into shadow textures using their back faces rather than their front faces. More...

const ColourValue &	getShadowColour (void) const
	Get the colour used to modulate areas in shadow. More...

Real	getShadowDirectionalLightExtrusionDistance (void) const
	Gets the distance a shadow volume is extruded for a directional light. More...

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. More...

Real	getShadowFarDistance (void) const
	Gets the default maximum distance away from the camera that shadows will be visible. More...

Real	getShadowFarDistanceSquared (void) const

size_t	getShadowIndexBufferSize (void) const
	Get the size of the shadow index buffer. More...

ShadowTechnique	getShadowTechnique (void) const
	Gets the current shadow technique. More...

const TexturePtr &	getShadowTexture (size_t shadowIndex)
	Get a reference to the shadow texture currently in use at the given index. More...

ConstShadowTextureConfigIterator	getShadowTextureConfigIterator () const
	Get an iterator over the current shadow texture settings. More...

size_t	getShadowTextureCount (void) const
	Get the number of the textures allocated for texture based shadows. More...

size_t	getShadowTextureCountPerLightType (Light::LightTypes type) const
	Get the number of shadow textures is assigned for the given light type. More...

bool	getShadowTextureSelfShadow (void) const
	Gets whether or not texture shadows attempt to self-shadow. More...

bool	getShadowUseLightClipPlanes () const
	Gets whether when using a built-in additive shadow mode, user clip planes should be used to restrict light rendering. More...

bool	getShowBoundingBoxes () const
	Returns if all bounding boxes of scene nodes are to be displayed. More...

bool	getShowDebugShadows (void) const
	Are debug shadows shown? More...

const SkyBoxGenParameters &	getSkyBoxGenParameters (void) const
	Get the parameters used to generate the current SkyBox, if any. More...

SceneNode *	getSkyBoxNode (void) const
	Get the skybox node, if enabled. More...

const SkyDomeGenParameters &	getSkyDomeGenParameters (void) const
	Get the parameters used to generate the current SkyDome, if any. More...

SceneNode *	getSkyDomeNode (void) const
	Get the sky dome node, if enabled. More...

const SkyPlaneGenParameters &	getSkyPlaneGenParameters (void) const
	Get the parameters used to construct the SkyPlane, if any. More...

SceneNode *	getSkyPlaneNode (void) const
	Get the sky plane node, if enabled. More...

SpecialCaseRenderQueueMode	getSpecialCaseRenderQueueMode (void)
	Gets the way the special case render queue list is processed. More...

StaticGeometry *	getStaticGeometry (const String &name) const
	Retrieve a previously created StaticGeometry instance. More...

virtual ViewPoint	getSuggestedViewpoint (bool random=false)
	Asks the SceneManager to provide a suggested viewpoint from which the scene should be viewed. More...

const String &	getTypeName (void) const
	Retrieve the type name of this scene manager. More...

uint32	getVisibilityMask (void)
	Gets a mask which is bitwise 'and'ed with objects own visibility masks to determine if the object is visible. More...

const VisibleObjectsBoundsInfo &	getVisibleObjectsBoundsInfo (const Camera *cam) const
	Returns a visibility boundary box for a specific camera. More...

uint8	getWorldGeometryRenderQueue (void)
	Gets the render queue that the world geometry (if any) this SceneManager renders will be associated with. More...

PCZone *	getZoneByName (const String &zoneName)
	Get a zone by name. More...

ZoneIterator	getZoneIterator (void)

bool	hasAnimation (const String &name) const
	Returns whether an animation with the given name exists. More...

bool	hasAnimationState (const String &name) const
	Returns whether an animation state with the given name exists. More...

bool	hasBillboardChain (const String &name) const
	Returns whether a billboard chain with the given name exists. More...

bool	hasBillboardSet (const String &name) const
	Returns whether a billboardset with the given name exists. More...

bool	hasCamera (const String &name) const
	Returns whether a camera with the given name exists. More...

bool	hasEntity (const String &name) const
	Returns whether an entity with the given name exists. More...

bool	hasInstanceManager (const String &managerName) const
	Returns whether an InstanceManager with the given name exists. More...

virtual bool	hasLight (const String &name) const
	Returns whether a light with the given name exists. More...

bool	hasManualObject (const String &name) const
	Returns whether a manual object with the given name exists. More...

bool	hasMovableObject (const String &name, const String &typeName) const
	Returns whether a movable object instance with the given name exists. More...

virtual bool	hasOption (const String &strKey) const
	Method for verifying whether the scene manager has an implementation-specific option. More...

bool	hasParticleSystem (const String &name) const
	Returns whether a particle system with the given name exists. More...

bool	hasRibbonTrail (const String &name) const
	Returns whether a ribbon trail with the given name exists. More...

bool	hasSceneNode (const String &name) const
	Returns whether a scene node with the given name exists. More...

bool	hasStaticGeometry (const String &name) const
	Returns whether a static geometry instance with the given name exists. More...

void	init (const String &defaultZoneTypeName, const String &filename="none")
	Initializes the manager. More...

void	injectMovableObject (MovableObject *m)
	Inject a MovableObject instance created externally. More...

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. More...

bool	isLateMaterialResolving () const
	Gets whether using late material resolving or not. More...

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. More...

bool	isShadowTechniqueAdditive (void) const
	Is there an additive shadowing technique in use? More...

bool	isShadowTechniqueIntegrated (void) const
	Is the shadow technique integrated into primary materials? More...

bool	isShadowTechniqueInUse (void) const
	Is there any shadowing technique in use? More...

bool	isShadowTechniqueModulative (void) const
	Is there a modulative shadowing technique in use? More...

bool	isShadowTechniqueStencilBased (void) const
	Is there a stencil shadow based shadowing technique in use? More...

bool	isShadowTechniqueTextureBased (void) const
	Is there a texture shadow based shadowing technique in use? More...

bool	isSkyBoxEnabled (void) const
	Return whether a skybox is enabled. More...

bool	isSkyDomeEnabled (void) const
	Return whether a skydome is enabled. More...

bool	isSkyPlaneEnabled (void) const
	Return whether a key plane is enabled. More...

void	manualRender (RenderOperation rend, Pass pass, Viewport *vp, const Matrix4 &worldMatrix, const Matrix4 &viewMatrix, const Matrix4 &projMatrix, bool doBeginEndFrame=false)
	Manual rendering method, for advanced users only. More...

void	manualRender (Renderable rend, const Pass pass, Viewport vp, const Matrix4 &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. More...

	OGRE_MUTEX (sceneGraphMutex)
	Mutex to protect the scene graph from simultaneous access from multiple threads. More...

virtual void	prepareShadowTextures (Camera cam, Viewport vp, const LightList *lightList=0)

virtual void	prepareWorldGeometry (const String &filename)
	Sets the source of the 'world' geometry, i.e. More...

virtual void	prepareWorldGeometry (DataStreamPtr &stream, const String &typeName=BLANKSTRING)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...

void	removeListener (Listener *s)
	Remove a listener. More...

void	removeLodListener (LodListener *listener)
	Remove a level of detail listener. More...

void	removeRenderObjectListener (RenderObjectListener *delListener)
	Removes a listener previously added with addRenderObjectListener. More...

void	removeRenderQueueListener (RenderQueueListener *delListener)
	Removes a listener previously added with addRenderQueueListener. More...

void	removeSceneNode (SceneNode *)
	Removes the given PCZSceneNode. More...

void	removeSpecialCaseRenderQueue (uint8 qid)
	Removes an item to the 'special case' render queue list. More...

void	setAmbientLight (const ColourValue &colour)
	Sets the ambient light level to be used for the scene. More...

void	setCameraRelativeRendering (bool rel)
	Set whether to use camera-relative co-ordinates when rendering, ie to always place the camera at the origin and move the world around it. More...

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. More...

void	setFindVisibleObjects (bool find)
	Sets whether the SceneManager should search for visible objects, or whether they are being manually handled. More...

void	setFlipCullingOnNegativeScale (bool n)
	Set whether to automatically flip the culling mode on objects whenever they are negatively scaled. More...

void	setFog (FogMode mode=FOG_NONE, const ColourValue &colour=ColourValue::White, Real expDensity=0.001, Real linearStart=0.0, Real linearEnd=1.0)
	Sets the fogging mode applied to the scene. More...

void	setLateMaterialResolving (bool isLate)
	Sets whether to use late material resolving or not. More...

void	setNodeHomeZone (SceneNode , PCZone )
	Set the home zone for a scene node. More...

void	setNormaliseNormalsOnScale (bool n)
	Set whether to automatically normalise normals on objects whenever they are scaled. More...

virtual bool	setOption (const String &, const void *)
	Sets the given option for the SceneManager. More...

void	setQueuedRenderableVisitor (SceneMgrQueuedRenderableVisitor *visitor)
	Advanced method for supplying an alternative visitor, used for parsing the render queues and sending the results to the renderer. More...

void	setShadowCameraSetup (const ShadowCameraSetupPtr &shadowSetup)
	Set the shadow camera setup to use for all lights which don't have their own shadow camera setup. More...

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. More...

void	setShadowColour (const ColourValue &colour)
	Set the colour used to modulate areas in shadow. More...

void	setShadowDirectionalLightExtrusionDistance (Real dist)
	Sets the distance a shadow volume is extruded for a directional light. More...

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. More...

void	setShadowFarDistance (Real distance)
	Sets the default maximum distance away from the camera that shadows will be visible. More...

void	setShadowIndexBufferSize (size_t size)
	Sets the maximum size of the index buffer used to render shadow primitives. More...

void	setShadowTechnique (ShadowTechnique technique)
	Sets the general shadow technique to be used in this scene. More...

void	setShadowTextureCasterMaterial (const MaterialPtr &mat)
	Sets the default material to use for rendering shadow casters. More...

void	setShadowTextureCasterMaterial (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. More...

void	setShadowTextureConfig (size_t shadowIndex, unsigned short width, unsigned short height, PixelFormat format, unsigned short fsaa=0, uint16 depthBufferPoolId=1)
	Set the detailed configuration for a shadow texture. More...

void	setShadowTextureConfig (size_t shadowIndex, const ShadowTextureConfig &config)
	Set the detailed configuration for a shadow texture. More...

void	setShadowTextureCount (size_t count)
	Set the number of textures allocated for texture-based shadows. More...

void	setShadowTextureCountPerLightType (Light::LightTypes type, size_t count)
	Set the number of shadow textures a light type uses. More...

void	setShadowTextureFadeEnd (Real fadeEnd)
	Sets the proportional distance at which texture shadows finish to fading out. More...

void	setShadowTextureFadeStart (Real fadeStart)
	Sets the proportional distance at which texture shadows begin to fade out. More...

void	setShadowTextureFSAA (unsigned short fsaa)
	Set the level of multisample AA of the textures used for texture-based shadows. More...

void	setShadowTexturePixelFormat (PixelFormat fmt)
	Set the pixel format of the textures used for texture-based shadows. More...

void	setShadowTextureReceiverMaterial (const MaterialPtr &mat)
	Sets the default material to use for rendering shadow receivers. More...

void	setShadowTextureReceiverMaterial (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. More...

void	setShadowTextureSelfShadow (bool selfShadow)
	Sets whether or not texture shadows should attempt to self-shadow. More...

void	setShadowTextureSettings (unsigned short size, unsigned short count, PixelFormat fmt=PF_X8R8G8B8, unsigned short fsaa=0, uint16 depthBufferPoolId=1)
	Sets the size and count of textures used in texture-based shadows. More...

void	setShadowTextureSize (unsigned short size)
	Set the size of the texture used for all texture-based shadows. More...

void	setShadowUseInfiniteFarPlane (bool enable)
	Sets whether we should use an inifinite camera far plane when rendering stencil shadows. More...

void	setShadowUseLightClipPlanes (bool enabled)
	Sets whether when using a built-in additive shadow mode, user clip planes should be used to restrict light rendering. More...

void	setShowDebugShadows (bool debug)
	Enables / disables the rendering of debug information for shadows. More...

void	setShowPortals (bool b)
	Sets the portal visibility flag. More...

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. More...

void	setSkyBoxEnabled (bool enable)
	Enables / disables a 'sky box'. More...

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. More...

void	setSkyDomeEnabled (bool enable)
	Enables / disables a 'sky dome'. More...

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. More...

void	setSkyPlaneEnabled (bool enable)
	Enables / disables a 'sky plane'. More...

void	setSkyZone (PCZone *zone)
	Set the zone which contains the sky node. More...

void	setSpecialCaseRenderQueueMode (SpecialCaseRenderQueueMode mode)
	Sets the way the special case render queue list is processed. More...

void	setVisibilityMask (uint32 vmask)
	Sets a mask which is bitwise 'and'ed with objects own visibility masks to determine if the object is visible. More...

virtual void	setWorldGeometry (const String &filename)
	Sets the source of the 'world' geometry, i.e. More...

virtual void	setWorldGeometry (DataStreamPtr &stream, const String &typeName=BLANKSTRING)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...

void	setWorldGeometryRenderQueue (uint8 qid)
	Overridden from SceneManager. More...

virtual void	setZoneGeometry (const String &zoneName, PCZSceneNode *parentNode, const String &filename)
	Set the "main" geometry of the zone. More...

void	showBoundingBoxes (bool bShow)
	Allows all bounding boxes of scene nodes to be displayed. More...

Static Public Attributes
static uint32	ENTITY_TYPE_MASK
	Query type mask which will be used for entities. More...

static uint32	FRUSTUM_TYPE_MASK
	Query type mask which will be used for frusta and cameras. More...

static uint32	FX_TYPE_MASK
	Query type mask which will be used for effects like billboardsets / particle systems. More...

static uint32	LIGHT_TYPE_MASK
	Query type mask which will be used for lights. More...

static uint32	STATICGEOMETRY_TYPE_MASK
	Query type mask which will be used for StaticGeometry. More...

static uint32	USER_TYPE_MASK_LIMIT
	User type mask limit. More...

static uint32	WORLD_GEOMETRY_TYPE_MASK
	Query type mask which will be used for world geometry. More...

Friends
class	PCZAxisAlignedBoxSceneQuery

class	PCZIntersectionSceneQuery

class	PCZPlaneBoundedVolumeListSceneQuery

class	PCZRaySceneQuery

class	PCZSphereSceneQuery

Detailed Description

Specialized SceneManager that uses Portal-Connected-Zones to divide the scene spatially.

Member Typedef Documentation

◆ ZoneIterator

typedef MapIterator<ZoneMap> Ogre::PCZSceneManager::ZoneIterator

ZoneMap iterator for read-only access to the zonemap.

◆ CameraList

typedef map<String, Camera* >::type Ogre::SceneManager::CameraList

inherited

◆ AnimationList

typedef map<String, Animation*>::type Ogre::SceneManager::AnimationList

inherited

◆ CameraIterator

typedef MapIterator<CameraList> Ogre::SceneManager::CameraIterator

inherited

◆ AnimationIterator

typedef MapIterator<AnimationList> Ogre::SceneManager::AnimationIterator

inherited

◆ MovableObjectIterator

typedef MapIterator<MovableObjectMap> Ogre::SceneManager::MovableObjectIterator

inherited

Member Enumeration Documentation

◆ IlluminationRenderStage

enum Ogre::SceneManager::IlluminationRenderStage

inherited

Describes the stage of rendering when performing complex illumination.

Enumerator
IRS_NONE	No special illumination stage.
IRS_RENDER_TO_TEXTURE	Render to texture stage, used for texture based shadows.
IRS_RENDER_RECEIVER_PASS	Render from shadow texture to receivers stage.

◆ SpecialCaseRenderQueueMode

enum Ogre::SceneManager::SpecialCaseRenderQueueMode

inherited

Enumeration of the possible modes allowed for processing the special case render queue list.

See also: SceneManager::setSpecialCaseRenderQueueMode

Enumerator
SCRQM_INCLUDE	Render only the queues in the special case list.
SCRQM_EXCLUDE	Render all except the queues in the special case list.

◆ PrefabType

enum Ogre::SceneManager::PrefabType

inherited

Prefab shapes available without loading a model.

Note: Minimal implementation at present.

Enumerator
PT_PLANE
PT_CUBE
PT_SPHERE

Constructor & Destructor Documentation

◆ PCZSceneManager()

Ogre::PCZSceneManager::PCZSceneManager ( const String & name )

Standard Constructor.

◆ ~PCZSceneManager()

Ogre::PCZSceneManager::~PCZSceneManager ( )

Standard destructor.

Member Function Documentation

◆ getTypeName()

const String& Ogre::PCZSceneManager::getTypeName ( void ) const

virtual

Retrieve the type name of this scene manager.

Remarks: 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.

◆ init()

void Ogre::PCZSceneManager::init	(	const String &	defaultZoneTypeName,
		const String &	filename = `"none"`
	)

Initializes the manager.

◆ createPortal()

Portal* Ogre::PCZSceneManager::createPortal	(	const String &	name,
		PortalBase::PORTAL_TYPE	type = `PortalBase::PORTAL_TYPE_QUAD`
	)

Create a new portal instance.

◆ destroyPortal() [1/2]

void Ogre::PCZSceneManager::destroyPortal ( Portal * p )

Delete a portal instance by pointer.

◆ destroyPortal() [2/2]

void Ogre::PCZSceneManager::destroyPortal ( const String & portalName )

Delete a portal instance by name.

◆ createAntiPortal()

AntiPortal* Ogre::PCZSceneManager::createAntiPortal	(	const String &	name,
		PortalBase::PORTAL_TYPE	type = `PortalBase::PORTAL_TYPE_QUAD`
	)

Create a new anti portal instance.

◆ destroyAntiPortal() [1/2]

void Ogre::PCZSceneManager::destroyAntiPortal ( AntiPortal * p )

Delete a anti portal instance by pointer.

◆ destroyAntiPortal() [2/2]

void Ogre::PCZSceneManager::destroyAntiPortal ( const String & portalName )

Delete a anti portal instance by name.

◆ createZoneFromFile()

PCZone* Ogre::PCZSceneManager::createZoneFromFile	(	const String &	zoneTypeName,
		const String &	zoneName,
		PCZSceneNode *	parentNode,
		const String &	filename
	)

Create a zone from a file (type of file depends on the zone type.

◆ setZoneGeometry()

virtual void Ogre::PCZSceneManager::setZoneGeometry	(	const String &	zoneName,
		PCZSceneNode *	parentNode,
		const String &	filename
	)

virtual

Set the "main" geometry of the zone.

◆ createSceneNodeImpl() [1/2]

virtual SceneNode* Ogre::PCZSceneManager::createSceneNodeImpl ( void )

virtual

override this to ensure specialised PCZSceneNode is used.

Reimplemented from Ogre::SceneManager.

◆ createSceneNodeImpl() [2/2]

virtual SceneNode* Ogre::PCZSceneManager::createSceneNodeImpl ( const String & name )

virtual

override this to ensure their specialised PCZSceneNode is used.

Reimplemented from Ogre::SceneManager.

◆ createSceneNode() [1/2]

virtual SceneNode* Ogre::PCZSceneManager::createSceneNode ( void )

virtual

Creates a PCZSceneNode.

Reimplemented from Ogre::SceneManager.

◆ createSceneNode() [2/2]

virtual SceneNode* Ogre::PCZSceneManager::createSceneNode ( const String & name )

virtual

Creates a PCZSceneNode.

Reimplemented from Ogre::SceneManager.

◆ createCamera()

virtual Camera* Ogre::PCZSceneManager::createCamera ( const String & name )

virtual

Creates a specialized PCZCamera.

Reimplemented from Ogre::SceneManager.

◆ destroySceneNode() [1/2]

virtual void Ogre::PCZSceneManager::destroySceneNode ( const String & name )

virtual

Deletes a scene node by name & corresponding PCZSceneNode.

Reimplemented from Ogre::SceneManager.

◆ destroySceneNode() [2/2]

virtual void Ogre::PCZSceneManager::destroySceneNode ( SceneNode * sn )

virtual

Deletes a scene node & corresponding PCZSceneNode.

Reimplemented from Ogre::SceneManager.

◆ clearScene()

virtual void Ogre::PCZSceneManager::clearScene ( void )

virtual

Overridden to clean up zones.

Reimplemented from Ogre::SceneManager.

◆ setWorldGeometryRenderQueue()

void Ogre::PCZSceneManager::setWorldGeometryRenderQueue ( uint8 qid )

Overridden from SceneManager.

◆ _renderScene()

void Ogre::PCZSceneManager::_renderScene	(	Camera *	cam,
		Viewport *	vp,
		bool	includeOverlays
	)

virtual

Overridden from basic scene manager.

Reimplemented from Ogre::SceneManager.

◆ enableSky()

void Ogre::PCZSceneManager::enableSky ( bool )

Enable/disable sky rendering.

◆ setSkyZone()

void Ogre::PCZSceneManager::setSkyZone ( PCZone * zone )

Set the zone which contains the sky node.

◆ _updateSceneGraph()

virtual void Ogre::PCZSceneManager::_updateSceneGraph ( Camera * cam )

virtual

Update Scene Graph (does several things now)

Reimplemented from Ogre::SceneManager.

◆ _findVisibleObjects()

virtual void Ogre::PCZSceneManager::_findVisibleObjects	(	Camera *	cam,
		VisibleObjectsBoundsInfo *	visibleBounds,
		bool	onlyShadowCasters
	)

virtual

Recurses through the PCZTree determining which nodes are visible.

Reimplemented from Ogre::SceneManager.

◆ _alertVisibleObjects()

virtual void Ogre::PCZSceneManager::_alertVisibleObjects ( void )

virtual

Alerts each unculled object, notifying it that it will be drawn.

Useful for doing calculations only on nodes that will be drawn, prior to drawing them...

◆ createLight() [1/2]

virtual Light* Ogre::PCZSceneManager::createLight ( const String & name )

virtual

Creates a light for use in the scene.

Remarks: Lights can either be in a fixed position and independent of the scene graph, or they can be attached to SceneNodes so they derive their position from the parent node. Either way, they are created using this method so that the SceneManager manages their existence.

Parameters

name	The name of the new light, to identify it later.

Reimplemented from Ogre::SceneManager.

◆ getLight()

virtual Light* Ogre::PCZSceneManager::getLight ( const String & name ) const

virtual

Returns a pointer to the named Light which has previously been added to the scene.

Note: Throws an exception if the named instance does not exist

Reimplemented from Ogre::SceneManager.

◆ hasLight()

virtual bool Ogre::PCZSceneManager::hasLight ( const String & name ) const

virtual

Returns whether a light with the given name exists.

Reimplemented from Ogre::SceneManager.

◆ destroyLight() [1/2]

virtual void Ogre::PCZSceneManager::destroyLight ( const String & name )

virtual

Removes the named light from the scene and destroys it.

Remarks: Any pointers held to this light after calling this method will be invalid.

Reimplemented from Ogre::SceneManager.

◆ destroyAllLights()

virtual void Ogre::PCZSceneManager::destroyAllLights ( void )

virtual

Removes and destroys all lights in the scene.

Reimplemented from Ogre::SceneManager.

◆ _updatePortalZoneData()

void Ogre::PCZSceneManager::_updatePortalZoneData ( void )

Check/Update the zone data for every portal in the scene.

Essentially, this routine checks each portal for intersections with other portals and updates if a crossing occurs

◆ _dirtyNodeByMovingPortals()

void Ogre::PCZSceneManager::_dirtyNodeByMovingPortals ( void )

Mark nodes dirty for every zone with moving portal in the scene.

◆ _updatePCZSceneNodes()

void Ogre::PCZSceneManager::_updatePCZSceneNodes ( void )

Update the PCZSceneNodes.

◆ _calcZonesAffectedByLights()

void Ogre::PCZSceneManager::_calcZonesAffectedByLights ( Camera * cam )

Calculate which zones are affected by each light.

◆ connectPortalsToTargetZonesByLocation()

void Ogre::PCZSceneManager::connectPortalsToTargetZonesByLocation ( void )

◆ _updatePCZSceneNode()

void Ogre::PCZSceneManager::_updatePCZSceneNode ( PCZSceneNode * )

Checks the given SceneNode, and determines if it needs to be moved to a different PCZone or be added to the visitors list of other PCZone(s).

◆ removeSceneNode()

void Ogre::PCZSceneManager::removeSceneNode ( SceneNode * )

Removes the given PCZSceneNode.

◆ addPCZSceneNode()

void Ogre::PCZSceneManager::addPCZSceneNode	(	PCZSceneNode *	sn,
		PCZone *	zone
	)

add a PCZSceneNode to the scene by putting it in a zone NOTE: This zone will be the scene node's home zone

◆ createZone()

PCZone* Ogre::PCZSceneManager::createZone	(	const String &	zoneType,
		const String &	instanceName
	)

Create a zone with the given name.

◆ destroyZone()

void Ogre::PCZSceneManager::destroyZone	(	PCZone *	zone,
		bool	destroySceneNodes
	)

Destroy an existing zone within the scene.

◆ _updateHomeZone()

void Ogre::PCZSceneManager::_updateHomeZone	(	PCZSceneNode *	,
		bool
	)

Make sure the home zone for the PCZSceneNode is up-to-date.

◆ findZoneForPoint()

PCZone* Ogre::PCZSceneManager::findZoneForPoint ( Vector3 & point )

Find the smallest zone which contains the point.

◆ createZoneSpecificNodeData() [1/2]

void Ogre::PCZSceneManager::createZoneSpecificNodeData ( PCZSceneNode * )

Create any zone-specific data necessary for all zones for the given node.

◆ createZoneSpecificNodeData() [2/2]

void Ogre::PCZSceneManager::createZoneSpecificNodeData ( PCZone * )

Create any zone-specific data necessary for all nodes for the given zone.

◆ setNodeHomeZone()

void Ogre::PCZSceneManager::setNodeHomeZone	(	SceneNode *	,
		PCZone *
	)

Set the home zone for a scene node.

◆ findNodesIn() [1/4]

void Ogre::PCZSceneManager::findNodesIn	(	const AxisAlignedBox &	box,
		PCZSceneNodeList &	list,
		PCZone *	startZone,
		PCZSceneNode *	exclude = `0`
	)

Recurses the scene, adding any nodes intersecting with the box into the given list.

It ignores the exclude scene node.

◆ findNodesIn() [2/4]

void Ogre::PCZSceneManager::findNodesIn	(	const Sphere &	sphere,
		PCZSceneNodeList &	list,
		PCZone *	startZone,
		PCZSceneNode *	start = `0`
	)

Recurses the scene, adding any nodes intersecting with the sphere into the given list.

It will start in the start SceneNode if given, otherwise, it will start at the root node.

◆ findNodesIn() [3/4]

void Ogre::PCZSceneManager::findNodesIn	(	const PlaneBoundedVolume &	volume,
		PCZSceneNodeList &	list,
		PCZone *	startZone,
		PCZSceneNode *	start = `0`
	)

Recurses the PCZTree, adding any nodes intersecting with the volume into the given list.

It will start in the start SceneNode if given, otherwise, it will start at the root node.

◆ findNodesIn() [4/4]

void Ogre::PCZSceneManager::findNodesIn	(	const Ray &	ray,
		PCZSceneNodeList &	list,
		PCZone *	startZone,
		PCZSceneNode *	start = `0`
	)

Recurses the scene, starting in the given startZone, adding any nodes intersecting with the ray into the given list.

It will start in the start SceneNode if given, otherwise, it will start at the root node.

◆ getDefaultZone()

PCZone* Ogre::PCZSceneManager::getDefaultZone ( void )

inline

Get the default zone.

◆ getZoneByName()

PCZone* Ogre::PCZSceneManager::getZoneByName ( const String & zoneName )

Get a zone by name.

◆ setShowPortals()

void Ogre::PCZSceneManager::setShowPortals ( bool b )

inline

Sets the portal visibility flag.

◆ setOption()

virtual bool Ogre::PCZSceneManager::setOption	(	const String &	,
		const void *
	)

virtual

Sets the given option for the SceneManager.

Remarks: Options are: "ShowPortals", bool *; "ShowBoundingBoxes", bool *;

Reimplemented from Ogre::SceneManager.

◆ getOption()

virtual bool Ogre::PCZSceneManager::getOption	(	const String &	,
		void *
	)

virtual

Gets the given option for the Scene Manager.

Remarks: See setOption

Reimplemented from Ogre::SceneManager.

◆ getOptionValues()

bool Ogre::PCZSceneManager::getOptionValues	(	const String &	strKey,
		StringVector &	refValueList
	)

virtual

Method for getting all possible values for a specific option.

When this list is too large (i.e. the option expects, for example, a float), the return value will be true, but the list will contain just one element whose size will be set to 0. Otherwise, the list will be filled with all the possible values the option can accept.

Parameters

strKey	The name of the option to get the values for.
refValueList	A reference to a list that will be filled with the available values.

Returns: On success (the option exists), true is returned.

: On failure, false is returned.

Reimplemented from Ogre::SceneManager.

◆ getOptionKeys()

bool Ogre::PCZSceneManager::getOptionKeys ( StringVector & refKeys )

virtual

Method for getting all the implementation-specific options of the scene manager.

Parameters

refKeys A reference to a list that will be filled with all the available options.

Returns: On success, true is returned. On failure, false is returned.

Reimplemented from Ogre::SceneManager.

◆ createAABBQuery()

AxisAlignedBoxSceneQuery* Ogre::PCZSceneManager::createAABBQuery	(	const AxisAlignedBox &	box,
		uint32	mask = `0xFFFFFFFF`
	)

virtual

Overridden from SceneManager.

Reimplemented from Ogre::SceneManager.

◆ createSphereQuery()

SphereSceneQuery* Ogre::PCZSceneManager::createSphereQuery	(	const Sphere &	sphere,
		uint32	mask = `0xFFFFFFFF`
	)

virtual

Creates a SphereSceneQuery for this scene manager.

Remarks: This method creates a new instance of a query object for this scene manager, for a spherical region. See SceneQuery and SphereSceneQuery for full details.

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

Parameters

sphere	Details of the sphere 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.

◆ createPlaneBoundedVolumeQuery()

PlaneBoundedVolumeListSceneQuery* Ogre::PCZSceneManager::createPlaneBoundedVolumeQuery	(	const PlaneBoundedVolumeList &	volumes,
		uint32	mask = `0xFFFFFFFF`
	)

virtual

Creates a PlaneBoundedVolumeListSceneQuery for this scene manager.

Remarks: This method creates a new instance of a query object for this scene manager, for a region enclosed by a set of planes (normals pointing inwards). See SceneQuery and PlaneBoundedVolumeListSceneQuery for full details.

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

Parameters

volumes	Details of the volumes which describe 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.

◆ createRayQuery()

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

virtual

Creates a RaySceneQuery for this scene manager.

Remarks: 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::PCZSceneManager::createIntersectionQuery ( uint32 mask = 0xFFFFFFFF )

virtual

Creates an IntersectionSceneQuery for this scene manager.

Remarks: 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.

◆ getZoneIterator()

ZoneIterator Ogre::PCZSceneManager::getZoneIterator ( void )

inline

◆ _clearAllZonesPortalUpdateFlag()

void Ogre::PCZSceneManager::_clearAllZonesPortalUpdateFlag ( void )

Clear portal update flag from all zones.

◆ prepareShadowTextures()

virtual void Ogre::PCZSceneManager::prepareShadowTextures	(	Camera *	cam,
		Viewport *	vp,
		const LightList *	lightList = `0`
	)

virtual

See also: SceneManager::prepareShadowTextures.

Reimplemented from Ogre::SceneManager.

◆ OGRE_MUTEX()

Ogre::SceneManager::OGRE_MUTEX ( sceneGraphMutex )

inherited

Mutex to protect the scene graph from simultaneous access from multiple threads.

Remarks: If you are updating the scene in a separate thread from the rendering thread, then you should lock this mutex before making any changes to the scene graph - that means creating, modifying or deleting a scene node, or attaching / detaching objects. It is your responsibility to take out this lock, the detail methods on the nodes will not do it for you (for the reasons discussed below).

: Note that locking this mutex will prevent the scene being rendered until it is unlocked again. Therefore you should do this sparingly. Try to create any objects you need separately and fully prepare them before doing all your scene graph work in one go, thus keeping this lock for the shortest time possible.

Note: A single global lock is used rather than a per-node lock since it keeps the number of locks required during rendering down to a minimum. Obtaining a lock, even if there is no contention, is not free so for performance it is good to do it as little as possible. Since modifying the scene in a separate thread is a fairly rare occurrence (relative to rendering), it is better to keep the locking required during rendering lower than to make update locks more granular.

◆ _pauseRendering()

RenderContext* Ogre::SceneManager::_pauseRendering ( )

inherited

Pause rendering of the frame.

This has to be called when inside a renderScene call (Usually using a listener of some sort)

◆ _resumeRendering()

void Ogre::SceneManager::_resumeRendering ( RenderContext * context )

inherited

Resume rendering of the frame.

This has to be called after a _pauseRendering call

Parameters

context The rendring context, as returned by the _pauseRendering call

◆ getName()

const String& Ogre::SceneManager::getName ( void ) const

inlineinherited

Return the instance name of this SceneManager.

◆ getCamera()

Camera* Ogre::SceneManager::getCamera ( const String & name ) const

inherited

Retrieves a pointer to the named camera.

Note: Throws an exception if the named instance does not exist

◆ hasCamera()

bool Ogre::SceneManager::hasCamera ( const String & name ) const

inherited

Returns whether a camera with the given name exists.

◆ destroyCamera() [1/2]

virtual void Ogre::SceneManager::destroyCamera ( Camera * cam )

virtualinherited

Removes a camera from the scene.

Remarks: This method removes a previously added camera from the scene. The camera is deleted so the caller must ensure no references to it's previous instance (e.g. in a SceneNode) are used.

Parameters

cam	Pointer to the camera to remove

◆ destroyCamera() [2/2]

virtual void Ogre::SceneManager::destroyCamera ( const String & name )

virtualinherited

Removes a camera from the scene.

Remarks: This method removes an camera from the scene based on the camera's name rather than a pointer.

◆ destroyAllCameras()

virtual void Ogre::SceneManager::destroyAllCameras ( void )

virtualinherited

Removes (and destroys) all cameras from the scene.

Remarks: Some cameras are internal created to dealing with texture shadow, their aren't supposed to destroy outside. So, while you are using texture shadow, don't call this method, or you can set the shadow technique other than texture-based, which will destroy all internal created shadow cameras and textures.

◆ createLight() [2/2]

virtual Light* Ogre::SceneManager::createLight ( )

virtualinherited

Creates a light with a generated name.

◆ getLightClippingPlanes()

const PlaneList& Ogre::SceneManager::getLightClippingPlanes ( Light * l )

inherited

Retrieve a set of clipping planes for a given light.

◆ getLightScissorRect()

const RealRect& Ogre::SceneManager::getLightScissorRect	(	Light *	l,
		const Camera *	cam
	)

inherited

Retrieve a scissor rectangle for a given light and camera.

◆ invalidatePerFrameScissorRectCache()

virtual void Ogre::SceneManager::invalidatePerFrameScissorRectCache ( )

virtualinherited

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.

◆ destroyLight() [2/2]

virtual void Ogre::SceneManager::destroyLight ( Light * light )

virtualinherited

Removes the light from the scene and destroys it based on a pointer.

Remarks: Any pointers held to this light after calling this method will be invalid.

◆ _notifyLightsDirty()

void Ogre::SceneManager::_notifyLightsDirty ( void )

inherited

Advance method to increase the lights dirty counter due lights changed.

Remarks: Scene manager tracking lights that affecting the frustum, if changes detected (the changes includes light list itself and the light's position and attenuation range), then increase the lights dirty counter.

: For some reason, you can call this method to force whole scene objects re-populate their light list. But near in mind, call to this method will harm performance, so should avoid if possible.

◆ _getLightsDirtyCounter()

ulong Ogre::SceneManager::_getLightsDirtyCounter ( void ) const

inlineinherited

Advance method to gets the lights dirty counter.

Remarks: Scene manager tracking lights that affecting the frustum, if changes detected (the changes includes light list itself and the light's position and attenuation range), then increase the lights dirty counter.

: When implementing customise lights finding algorithm relied on either SceneManager::_getLightsAffectingFrustum or SceneManager::_populateLightList, might check this value for sure that the light list are really need to re-populate, otherwise, returns cached light list (if exists) for better performance.

References Ogre::ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME, and Ogre::ViewPoint::position.

◆ _getLightsAffectingFrustum()

const LightList& Ogre::SceneManager::_getLightsAffectingFrustum ( void ) const

inherited

Get the list of lights which could be affecting the frustum.

Remarks: Note that default implementation of this method returns a cached light list, which is populated when rendering the scene. So by default the list of lights is only available during scene rendering.

◆ _populateLightList() [1/2]

void Ogre::SceneManager::_populateLightList	(	const Vector3 &	position,
		Real	radius,
		LightList &	destList,
		uint32	lightMask = `0xFFFFFFFF`
	)

inherited

Populate a light list with an ordered set of the lights which are closest to the position specified.

Remarks: Note that since directional lights have no position, they are always considered closer than any point lights and as such will always take precedence.

: Subclasses of the default SceneManager may wish to take into account other issues such as possible visibility of the light if that information is included in their data structures. This basic scenemanager simply orders by distance, eliminating those lights which are out of range or could not be affecting the frustum (i.e. only the lights returned by SceneManager::_getLightsAffectingFrustum are take into account).

: The number of items in the list max exceed the maximum number of lights supported by the renderer, but the extraneous ones will never be used. In fact the limit will be imposed by Pass::getMaxSimultaneousLights.

Parameters

position	The position at which to evaluate the list of lights
radius	The bounding radius to test
destList	List to be populated with ordered set of lights; will be cleared by this method before population.
lightMask	The mask with which to include / exclude lights

◆ _populateLightList() [2/2]

void Ogre::SceneManager::_populateLightList	(	const SceneNode *	sn,
		Real	radius,
		LightList &	destList,
		uint32	lightMask = `0xFFFFFFFF`
	)

inherited

Populates a light list with an ordered set of the lights which are closest to the position of the SceneNode given.

Remarks: Note that since directional lights have no position, they are always considered closer than any point lights and as such will always take precedence. This overloaded version will take the SceneNode's position and use the second method to populate the list.

: Subclasses of the default SceneManager may wish to take into account other issues such as possible visibility of the light if that information is included in their data structures. This basic scenemanager simply orders by distance, eliminating those lights which are out of range or could not be affecting the frustum (i.e. only the lights returned by SceneManager::_getLightsAffectingFrustum are take into account).

: Also note that subclasses of the SceneNode might be used here to provide cached scene related data, accelerating the list population (for example light lists for SceneNodes could be cached inside subclassed SceneNode objects).

: The number of items in the list may exceed the maximum number of lights supported by the renderer, but the extraneous ones will never be used. In fact the limit will be imposed by Pass::getMaxSimultaneousLights.

Parameters

sn	The SceneNode for which to evaluate the list of lights
radius	The bounding radius to test
destList	List to be populated with ordered set of lights; will be cleared by this method before population.
lightMask	The mask with which to include / exclude lights

◆ getRootSceneNode()

SceneNode* Ogre::SceneManager::getRootSceneNode ( void )

inherited

Gets the SceneNode at the root of the scene hierarchy.

Remarks: The entire scene is held as a hierarchy of nodes, which allows things like relative transforms, general changes in rendering state etc (See the SceneNode class for more info). In this basic SceneManager class, the application using Ogre is free to structure this hierarchy however it likes, since it has no real significance apart from making transforms relative to each node (more specialised subclasses will provide utility methods for building specific node structures e.g. loading a BSP tree).

: However, in all cases there is only ever one root node of the hierarchy, and this method returns a pointer to it.

◆ getSceneNode()

SceneNode* Ogre::SceneManager::getSceneNode ( const String & name ) const

inherited

Retrieves a named SceneNode from the scene graph.

Remarks: If you chose to name a SceneNode as you created it, or if you happened to make a note of the generated name, you can look it up wherever it is in the scene graph using this method.

Note: Throws an exception if the named instance does not exist

◆ hasSceneNode()

bool Ogre::SceneManager::hasSceneNode ( const String & name ) const

inherited

Returns whether a scene node with the given name exists.

◆ createEntity() [1/6]

Entity* Ogre::SceneManager::createEntity	(	const String &	entityName,
		const String &	meshName,
		const String &	groupName = `ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME`
	)

inherited

Create an Entity (instance of a discrete mesh).

Parameters

entityName	The name to be given to the entity (must be unique).
meshName	The name of the Mesh it is to be based on (e.g. 'knot.oof'). The mesh will be loaded if it is not already.
groupName	The resource name where the mesh lives

◆ createEntity() [2/6]

Entity* Ogre::SceneManager::createEntity	(	const String &	entityName,
		const MeshPtr &	pMesh
	)

inherited

Create an Entity (instance of a discrete mesh).

Parameters

entityName	The name to be given to the entity (must be unique).
pMesh	The pointer to the Mesh it is to be based on.

◆ createEntity() [3/6]

Entity* Ogre::SceneManager::createEntity ( const String & meshName )

inherited

Create an Entity (instance of a discrete mesh) with an autogenerated name.

Parameters

meshName The name of the Mesh it is to be based on (e.g. 'knot.oof'). The mesh will be loaded if it is not already.

◆ createEntity() [4/6]

Entity* Ogre::SceneManager::createEntity ( const MeshPtr & pMesh )

inherited

Create an Entity (instance of a discrete mesh) with an autogenerated name.

Parameters

pMesh The pointer to the Mesh it is to be based on.

◆ createEntity() [5/6]

Entity* Ogre::SceneManager::createEntity	(	const String &	entityName,
		PrefabType	ptype
	)

inherited

Create an Entity (instance of a discrete mesh) from a range of prefab shapes.

Parameters

entityName	The name to be given to the entity (must be unique).
ptype	The prefab type.

◆ createEntity() [6/6]

Entity* Ogre::SceneManager::createEntity ( PrefabType ptype )

inherited

Create an Entity (instance of a discrete mesh) from a range of prefab shapes, generating the name.

Parameters

ptype The prefab type.

◆ getEntity()

Entity* Ogre::SceneManager::getEntity ( const String & name ) const

inherited

Retrieves a pointer to the named Entity.

Note: Throws an exception if the named instance does not exist

◆ hasEntity()

bool Ogre::SceneManager::hasEntity ( const String & name ) const

inherited

Returns whether an entity with the given name exists.

◆ destroyEntity() [1/2]

void Ogre::SceneManager::destroyEntity ( Entity * ent )

inherited

Removes & destroys an Entity from the SceneManager.

Warning: Must only be done if the Entity is not attached to a SceneNode. It may be safer to wait to clear the whole scene if you are unsure use clearScene.

See also: SceneManager::clearScene

◆ destroyEntity() [2/2]

void Ogre::SceneManager::destroyEntity ( const String & name )

inherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ destroyAllEntities()

virtual void Ogre::SceneManager::destroyAllEntities ( void )

virtualinherited

Removes & destroys all Entities.

Warning: Again, use caution since no Entity must be referred to elsewhere e.g. attached to a SceneNode otherwise a crash is likely. Use clearScene if you are unsure (it clears SceneNode entries too.)

See also: SceneManager::clearScene

◆ createManualObject() [1/2]

ManualObject* Ogre::SceneManager::createManualObject ( const String & name )

inherited

Create a ManualObject, an object which you populate with geometry manually through a GL immediate-mode style interface.

Parameters

name	The name to be given to the object (must be unique).

◆ createManualObject() [2/2]

ManualObject* Ogre::SceneManager::createManualObject ( )

inherited

Create a ManualObject, an object which you populate with geometry manually through a GL immediate-mode style interface, generating the name.

◆ getManualObject()

ManualObject* Ogre::SceneManager::getManualObject ( const String & name ) const

inherited

Retrieves a pointer to the named ManualObject.

Note: Throws an exception if the named instance does not exist

◆ hasManualObject()

bool Ogre::SceneManager::hasManualObject ( const String & name ) const

inherited

Returns whether a manual object with the given name exists.

◆ destroyManualObject() [1/2]

void Ogre::SceneManager::destroyManualObject ( ManualObject * obj )

inherited

Removes & destroys a ManualObject from the SceneManager.

◆ destroyManualObject() [2/2]

void Ogre::SceneManager::destroyManualObject ( const String & name )

inherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ destroyAllManualObjects()

void Ogre::SceneManager::destroyAllManualObjects ( void )

inherited

Removes & destroys all ManualObjects from the SceneManager.

◆ createBillboardChain() [1/2]

BillboardChain* Ogre::SceneManager::createBillboardChain ( const String & name )

inherited

Create a BillboardChain, an object which you can use to render a linked chain of billboards.

Parameters

name	The name to be given to the object (must be unique).

◆ createBillboardChain() [2/2]

BillboardChain* Ogre::SceneManager::createBillboardChain ( )

inherited

Create a BillboardChain, an object which you can use to render a linked chain of billboards, with a generated name.

◆ getBillboardChain()

BillboardChain* Ogre::SceneManager::getBillboardChain ( const String & name ) const

inherited

Retrieves a pointer to the named BillboardChain.

Note: Throws an exception if the named instance does not exist

◆ hasBillboardChain()

bool Ogre::SceneManager::hasBillboardChain ( const String & name ) const

inherited

Returns whether a billboard chain with the given name exists.

◆ destroyBillboardChain() [1/2]

void Ogre::SceneManager::destroyBillboardChain ( BillboardChain * obj )

inherited

Removes & destroys a BillboardChain from the SceneManager.

◆ destroyBillboardChain() [2/2]

void Ogre::SceneManager::destroyBillboardChain ( const String & name )

inherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ destroyAllBillboardChains()

void Ogre::SceneManager::destroyAllBillboardChains ( void )

inherited

Removes & destroys all BillboardChains from the SceneManager.

◆ createRibbonTrail() [1/2]

RibbonTrail* Ogre::SceneManager::createRibbonTrail ( const String & name )

inherited

Create a RibbonTrail, an object which you can use to render a linked chain of billboards which follows one or more nodes.

Parameters

name	The name to be given to the object (must be unique).

◆ createRibbonTrail() [2/2]

RibbonTrail* Ogre::SceneManager::createRibbonTrail ( )

inherited

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.

◆ getRibbonTrail()

RibbonTrail* Ogre::SceneManager::getRibbonTrail ( const String & name ) const

inherited

Retrieves a pointer to the named RibbonTrail.

Note: Throws an exception if the named instance does not exist

◆ hasRibbonTrail()

bool Ogre::SceneManager::hasRibbonTrail ( const String & name ) const

inherited

Returns whether a ribbon trail with the given name exists.

◆ destroyRibbonTrail() [1/2]

void Ogre::SceneManager::destroyRibbonTrail ( RibbonTrail * obj )

inherited

Removes & destroys a RibbonTrail from the SceneManager.

◆ destroyRibbonTrail() [2/2]

void Ogre::SceneManager::destroyRibbonTrail ( const String & name )

inherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ destroyAllRibbonTrails()

void Ogre::SceneManager::destroyAllRibbonTrails ( void )

inherited

Removes & destroys all RibbonTrails from the SceneManager.

◆ createParticleSystem() [1/3]

ParticleSystem* Ogre::SceneManager::createParticleSystem	(	const String &	name,
		const String &	templateName
	)

inherited

Creates a particle system based on a template.

Remarks: This method creates a new ParticleSystem instance based on the named template (defined through ParticleSystemManager::createTemplate) and returns a pointer to the caller. The caller should not delete this object, it will be freed at system shutdown, or can be released earlier using the destroyParticleSystem method.

: Each system created from a template takes the template's settings at the time of creation, but is completely separate from the template from there on.

: Creating a particle system does not make it a part of the scene. As with other MovableObject subclasses, a ParticleSystem is not rendered until it is attached to a SceneNode.

: This is probably the more useful particle system creation method since it does not require manual setup of the system. Note that the initial quota is based on the template but may be changed later.

Parameters

name	The name to give the new particle system instance.
templateName	The name of the template to base the new instance on.

◆ createParticleSystem() [2/3]

ParticleSystem* Ogre::SceneManager::createParticleSystem	(	const String &	name,
		size_t	quota = `500`,
		const String &	resourceGroup = `ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME`
	)

inherited

Create a blank particle system.

Remarks: This method creates a new, blank ParticleSystem instance and returns a pointer to it. The caller should not delete this object, it will be freed at system shutdown, or can be released earlier using the destroyParticleSystem method.

: The instance returned from this method won't actually do anything because on creation a particle system has no emitters. The caller should manipulate the instance through it's ParticleSystem methods to actually create a real particle effect.

: Creating a particle system does not make it a part of the scene. As with other MovableObject subclasses, a ParticleSystem is not rendered until it is attached to a SceneNode.

Parameters

name	The name to give the ParticleSystem.
quota	The maximum number of particles to allow in this system.
resourceGroup	The resource group which will be used to load dependent resources

◆ createParticleSystem() [3/3]

ParticleSystem* Ogre::SceneManager::createParticleSystem	(	size_t	quota = `500`,
		const String &	resourceGroup = `ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME`
	)

inherited

Create a blank particle system with a generated name.

Remarks: This method creates a new, blank ParticleSystem instance and returns a pointer to it. The caller should not delete this object, it will be freed at system shutdown, or can be released earlier using the destroyParticleSystem method.

: The instance returned from this method won't actually do anything because on creation a particle system has no emitters. The caller should manipulate the instance through it's ParticleSystem methods to actually create a real particle effect.

: Creating a particle system does not make it a part of the scene. As with other MovableObject subclasses, a ParticleSystem is not rendered until it is attached to a SceneNode.

Parameters

quota	The maximum number of particles to allow in this system.
resourceGroup	The resource group which will be used to load dependent resources

◆ getParticleSystem()

ParticleSystem* Ogre::SceneManager::getParticleSystem ( const String & name ) const

inherited

Retrieves a pointer to the named ParticleSystem.

Note: Throws an exception if the named instance does not exist

◆ hasParticleSystem()

bool Ogre::SceneManager::hasParticleSystem ( const String & name ) const

inherited

Returns whether a particle system with the given name exists.

◆ destroyParticleSystem() [1/2]

void Ogre::SceneManager::destroyParticleSystem ( ParticleSystem * obj )

inherited

Removes & destroys a ParticleSystem from the SceneManager.

◆ destroyParticleSystem() [2/2]

void Ogre::SceneManager::destroyParticleSystem ( const String & name )

inherited

Removes & destroys a ParticleSystem from the SceneManager.

◆ destroyAllParticleSystems()

void Ogre::SceneManager::destroyAllParticleSystems ( void )

inherited

Removes & destroys all ParticleSystems from the SceneManager.

◆ setAmbientLight()

void Ogre::SceneManager::setAmbientLight ( const ColourValue & colour )

inherited

Sets the ambient light level to be used for the scene.

Remarks: This sets the colour and intensity of the ambient light in the scene, i.e. the light which is 'sourceless' and illuminates all objects equally. The colour of an object is affected by a combination of the light in the scene, and the amount of light that object reflects (in this case based on the Material::ambient property).; By default the ambient light in the scene is ColourValue::Black, i.e. no ambient light. This means that any objects rendered with a Material which has lighting enabled (see Material::setLightingEnabled) will not be visible unless you have some dynamic lights in your scene.

◆ getAmbientLight()

const ColourValue& Ogre::SceneManager::getAmbientLight ( void ) const

inherited

Returns the ambient light level to be used for the scene.

◆ prepareWorldGeometry() [1/2]

virtual void Ogre::SceneManager::prepareWorldGeometry ( const String & filename )

virtualinherited

Sets the source of the 'world' geometry, i.e.

the large, mainly static geometry making up the world e.g. rooms, landscape etc. This function can be called before setWorldGeometry in a background thread, do to some slow tasks (e.g. IO) that do not involve the backend render system.

Remarks: Depending on the type of SceneManager (subclasses will be specialised for particular world geometry types) you have requested via the Root or SceneManagerEnumerator classes, you can pass a filename to this method and it will attempt to load the world-level geometry for use. If you try to load an inappropriate type of world data an exception will be thrown. The default SceneManager cannot handle any sort of world geometry and so will always throw an exception. However subclasses like BspSceneManager can load particular types of world geometry e.g. "q3dm1.bsp".

◆ prepareWorldGeometry() [2/2]

virtual void Ogre::SceneManager::prepareWorldGeometry	(	DataStreamPtr &	stream,
		const String &	typeName = `BLANKSTRING`
	)

virtualinherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

stream	Data stream containing data to load
typeName	String identifying the type of world geometry contained in the stream - not required if this manager only supports one type of world geometry.

◆ setWorldGeometry() [1/2]

virtual void Ogre::SceneManager::setWorldGeometry ( const String & filename )

virtualinherited

Sets the source of the 'world' geometry, i.e.

the large, mainly static geometry making up the world e.g. rooms, landscape etc.

Remarks: Depending on the type of SceneManager (subclasses will be specialised for particular world geometry types) you have requested via the Root or SceneManagerEnumerator classes, you can pass a filename to this method and it will attempt to load the world-level geometry for use. If you try to load an inappropriate type of world data an exception will be thrown. The default SceneManager cannot handle any sort of world geometry and so will always throw an exception. However subclasses like BspSceneManager can load particular types of world geometry e.g. "q3dm1.bsp".

Reimplemented in Ogre::BspSceneManager.

◆ setWorldGeometry() [2/2]

virtual void Ogre::SceneManager::setWorldGeometry	(	DataStreamPtr &	stream,
		const String &	typeName = `BLANKSTRING`
	)

virtualinherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

stream	Data stream containing data to load
typeName	String identifying the type of world geometry contained in the stream - not required if this manager only supports one type of world geometry.

Reimplemented in Ogre::BspSceneManager.

◆ estimateWorldGeometry() [1/2]

virtual size_t Ogre::SceneManager::estimateWorldGeometry ( const String & filename )

inlinevirtualinherited

Estimate the number of loading stages required to load the named world geometry.

Remarks: This method should be overridden by SceneManagers that provide custom world geometry that can take some time to load. They should return from this method a count of the number of stages of progress they can report on whilst loading. During real loading (setWorldGeometry), they should call ResourceGroupManager::_notifyWorldGeometryProgress exactly that number of times when loading the geometry for real.

Note: The default is to return 0, ie to not report progress.

Reimplemented in Ogre::BspSceneManager.

◆ estimateWorldGeometry() [2/2]

virtual size_t Ogre::SceneManager::estimateWorldGeometry	(	DataStreamPtr &	stream,
		const String &	typeName = `BLANKSTRING`
	)

inlinevirtualinherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

stream	Data stream containing data to load
typeName	String identifying the type of world geometry contained in the stream - not required if this manager only supports one type of world geometry.

Reimplemented in Ogre::BspSceneManager.

◆ getSuggestedViewpoint()

virtual ViewPoint Ogre::SceneManager::getSuggestedViewpoint ( bool random = false )

virtualinherited

Asks the SceneManager to provide a suggested viewpoint from which the scene should be viewed.

Remarks: Typically this method returns the origin unless a) world geometry has been loaded using SceneManager::setWorldGeometry and b) that world geometry has suggested 'start' points. If there is more than one viewpoint which the scene manager can suggest, it will always suggest the first one unless the random parameter is true.

Parameters

random If true, and there is more than one possible suggestion, a random one will be used. If false the same one will always be suggested.

Returns: On success, true is returned.

: On failure, false is returned.

Reimplemented in Ogre::BspSceneManager.

◆ hasOption()

virtual bool Ogre::SceneManager::hasOption ( const String & strKey ) const

inlinevirtualinherited

Method for verifying whether the scene manager has an implementation-specific option.

Parameters

strKey The name of the option to check for.

Returns: If the scene manager contains the given option, true is returned.

Remarks: If it does not, false is returned.

◆ _issueRenderOp()

void Ogre::SceneManager::_issueRenderOp	(	Renderable *	rend,
		const Pass *	pass
	)

inherited

Internal method for issuing the render operation.

◆ _applySceneAnimations()

void Ogre::SceneManager::_applySceneAnimations ( void )

inherited

Internal method for applying animations to scene nodes.

Remarks: Uses the internally stored AnimationState objects to apply animation to SceneNodes.

◆ _renderVisibleObjects()

void Ogre::SceneManager::_renderVisibleObjects ( void )

inherited

Sends visible objects found in _findVisibleObjects to the rendering engine.

◆ _queueSkiesForRendering()

void Ogre::SceneManager::_queueSkiesForRendering ( Camera * cam )

inherited

Internal method for queueing the sky objects with the params as previously set through setSkyBox, setSkyPlane and setSkyDome.

◆ _setDestinationRenderSystem()

void Ogre::SceneManager::_setDestinationRenderSystem ( RenderSystem * sys )

inherited

Notifies the scene manager of its destination render system.

Remarks: Called automatically by RenderSystem::addSceneManager this method simply notifies the manager of the render system to which its output must be directed.

Parameters

sys	Pointer to the RenderSystem subclass to be used as a render target.

◆ _releaseManualHardwareResources()

void Ogre::SceneManager::_releaseManualHardwareResources ( )

inherited

Notifies the scene manager that hardware resources were lost.

Remarks: Called automatically by RenderSystem if hardware resources were lost and can not be restored using some internal mechanism. Among affected resources are manual meshes without loaders, manual textures without loaders, ManualObjects, etc.

◆ _restoreManualHardwareResources()

void Ogre::SceneManager::_restoreManualHardwareResources ( )

inherited

Notifies the scene manager that hardware resources should be restored.

Remarks: Called automatically by RenderSystem if hardware resources were lost and can not be restored using some internal mechanism. Among affected resources are manual meshes without loaders, manual textures without loaders, ManualObjects, etc.

◆ setSkyPlane()

Ogre::SceneManager::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`
	)

inherited

Enables / disables a 'sky plane' i.e.

a plane at constant distance from the camera representing the sky.

Remarks: You can create sky planes yourself using the standard mesh and entity methods, but this creates a plane which the camera can never get closer or further away from - it moves with the camera. (NB you could create this effect by creating a world plane which was attached to the same SceneNode as the Camera too, but this would only apply to a single camera whereas this plane applies to any camera using this scene manager).

Note: To apply scaling, scrolls etc to the sky texture(s) you should use the TextureUnitState class methods.

Parameters

enable	True to enable the plane, false to disable it
plane	Details of the plane, i.e. it's normal and it's distance from the camera.
materialName	The name of the material the plane will use
scale	The scaling applied to the sky plane - higher values mean a bigger sky plane - you may want to tweak this depending on the size of plane.d and the other characteristics of your scene
tiling	How many times to tile the texture across the sky. Applies to all texture layers. If you need finer control use the TextureUnitState texture coordinate transformation methods.
drawFirst	If true, the plane is drawn before all other geometry in the scene, without updating the depth buffer. This is the safest rendering method since all other objects will always appear in front of the sky. However this is not the most efficient way if most of the sky is often occluded by other objects. If this is the case, you can set this parameter to false meaning it draws after all other geometry which can be an optimisation - however you must ensure that the plane.d value is large enough that no objects will 'poke through' the sky plane when it is rendered.
bow	If zero, the plane will be completely flat (like previous versions. If above zero, the plane will be curved, allowing the sky to appear below camera level. Curved sky planes are simular to skydomes, but are more compatible with fog.
xsegments,ysegments	Determines the number of segments the plane will have to it. This is most important when you are bowing the plane, but may also be useful if you need tessellation on the plane to perform per-vertex effects.
groupName	The name of the resource group to which to assign the plane mesh.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

renderQueue The render queue to use when rendering this object

◆ _setSkyPlane()

void Ogre::SceneManager::_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`
	)

inherited

◆ setSkyPlaneEnabled()

void Ogre::SceneManager::setSkyPlaneEnabled ( bool enable )

inlineinherited

Enables / disables a 'sky plane'.

◆ isSkyPlaneEnabled()

bool Ogre::SceneManager::isSkyPlaneEnabled ( void ) const

inlineinherited

Return whether a key plane is enabled.

◆ getSkyPlaneNode()

SceneNode* Ogre::SceneManager::getSkyPlaneNode ( void ) const

inlineinherited

Get the sky plane node, if enabled.

◆ getSkyPlaneGenParameters()

const SkyPlaneGenParameters& Ogre::SceneManager::getSkyPlaneGenParameters ( void ) const

inlineinherited

Get the parameters used to construct the SkyPlane, if any.

References Ogre::ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME, Ogre::Quaternion::IDENTITY, Ogre::ViewPoint::orientation, and Ogre::RENDER_QUEUE_SKIES_EARLY.

◆ setSkyBox()

Ogre::SceneManager::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`
	)

inherited

Enables / disables a 'sky box' i.e.

a 6-sided box at constant distance from the camera representing the sky.

Remarks: You could create a sky box yourself using the standard mesh and entity methods, but this creates a plane which the camera can never get closer or further away from - it moves with the camera. (NB you could create this effect by creating a world box which was attached to the same SceneNode as the Camera too, but this would only apply to a single camera whereas this skybox applies to any camera using this scene manager).

: The material you use for the skybox can either contain layers which are single textures, or they can be cubic textures, i.e. made up of 6 images, one for each plane of the cube. See the TextureUnitState class for more information.

Parameters

enable	True to enable the skybox, false to disable it
materialName	The name of the material the box will use
distance	Distance in world coorinates from the camera to each plane of the box. The default is normally OK.
drawFirst	If true, the box is drawn before all other geometry in the scene, without updating the depth buffer. This is the safest rendering method since all other objects will always appear in front of the sky. However this is not the most efficient way if most of the sky is often occluded by other objects. If this is the case, you can set this parameter to false meaning it draws after all other geometry which can be an optimisation - however you must ensure that the distance value is large enough that no objects will 'poke through' the sky box when it is rendered.
renderQueue	The render queue to use when rendering this object
orientation	Optional parameter to specify the orientation of the box. By default the 'top' of the box is deemed to be in the +y direction, and the 'front' at the -z direction. You can use this parameter to rotate the sky if you want.
groupName	The name of the resource group to which to assign the plane mesh.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

renderQueue The render queue to use when rendering this object

◆ _setSkyBox()

void Ogre::SceneManager::_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`
	)

inherited

◆ setSkyBoxEnabled()

void Ogre::SceneManager::setSkyBoxEnabled ( bool enable )

inlineinherited

Enables / disables a 'sky box'.

◆ isSkyBoxEnabled()

bool Ogre::SceneManager::isSkyBoxEnabled ( void ) const

inlineinherited

Return whether a skybox is enabled.

◆ getSkyBoxNode()

SceneNode* Ogre::SceneManager::getSkyBoxNode ( void ) const

inlineinherited

Get the skybox node, if enabled.

◆ getSkyBoxGenParameters()

const SkyBoxGenParameters& Ogre::SceneManager::getSkyBoxGenParameters ( void ) const

inlineinherited

Get the parameters used to generate the current SkyBox, if any.

References Ogre::ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME, Ogre::Quaternion::IDENTITY, Ogre::ViewPoint::orientation, and Ogre::RENDER_QUEUE_SKIES_EARLY.

◆ setSkyDome()

Ogre::SceneManager::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`
	)

inherited

Enables / disables a 'sky dome' i.e.

an illusion of a curved sky.

Remarks: A sky dome is actually formed by 5 sides of a cube, but with texture coordinates generated such that the surface appears curved like a dome. Sky domes are appropriate where you need a realistic looking sky where the scene is not going to be 'fogged', and there is always a 'floor' of some sort to prevent the viewer looking below the horizon (the distortion effect below the horizon can be pretty horrible, and there is never anyhting directly below the viewer). If you need a complete wrap-around background, use the setSkyBox method instead. You can actually combine a sky box and a sky dome if you want, to give a positional backdrop with an overlayed curved cloud layer.

: Sky domes work well with 2D repeating textures like clouds. You can change the apparent 'curvature' of the sky depending on how your scene is viewed - lower curvatures are better for 'open' scenes like landscapes, whilst higher curvatures are better for say FPS levels where you don't see a lot of the sky at once and the exaggerated curve looks good.

Parameters

enable	True to enable the skydome, false to disable it
materialName	The name of the material the dome will use
curvature	The curvature of the dome. Good values are between 2 and 65. Higher values are more curved leading to a smoother effect, lower values are less curved meaning more distortion at the horizons but a better distance effect.
tiling	How many times to tile the texture(s) across the dome.
distance	Distance in world coorinates from the camera to each plane of the box the dome is rendered on. The default is normally OK.
drawFirst	If true, the dome is drawn before all other geometry in the scene, without updating the depth buffer. This is the safest rendering method since all other objects will always appear in front of the sky. However this is not the most efficient way if most of the sky is often occluded by other objects. If this is the case, you can set this parameter to false meaning it draws after all other geometry which can be an optimisation - however you must ensure that the distance value is large enough that no objects will 'poke through' the sky when it is rendered.
orientation	Optional parameter to specify the orientation of the dome. By default the 'top' of the dome is deemed to be in the +y direction, and the 'front' at the -z direction. You can use this parameter to rotate the sky if you want.
groupName	The name of the resource group to which to assign the plane mesh.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

renderQueue The render queue to use when rendering this object

◆ _setSkyDome()

void Ogre::SceneManager::_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`
	)

inherited

◆ setSkyDomeEnabled()

void Ogre::SceneManager::setSkyDomeEnabled ( bool enable )

inlineinherited

Enables / disables a 'sky dome'.

◆ isSkyDomeEnabled()

bool Ogre::SceneManager::isSkyDomeEnabled ( void ) const

inlineinherited

Return whether a skydome is enabled.

◆ getSkyDomeNode()

SceneNode* Ogre::SceneManager::getSkyDomeNode ( void ) const

inlineinherited

Get the sky dome node, if enabled.

◆ getSkyDomeGenParameters()

const SkyDomeGenParameters& Ogre::SceneManager::getSkyDomeGenParameters ( void ) const

inlineinherited

Get the parameters used to generate the current SkyDome, if any.

References Ogre::FOG_NONE, and Ogre::ColourValue::White.

◆ setFog()

void Ogre::SceneManager::setFog	(	FogMode	mode = `FOG_NONE`,
		const ColourValue &	colour = `ColourValue::White`,
		Real	expDensity = `0.001`,
		Real	linearStart = `0.0`,
		Real	linearEnd = `1.0`
	)

inherited

Sets the fogging mode applied to the scene.

Remarks: This method sets up the scene-wide fogging effect. These settings apply to all geometry rendered, UNLESS the material with which it is rendered has it's own fog settings (see Material::setFog).

Parameters

mode	Set up the mode of fog as described in the FogMode enum, or set to FOG_NONE to turn off.
colour	The colour of the fog. Either set this to the same as your viewport background colour, or to blend in with a skydome or skybox.
expDensity	The density of the fog in FOG_EXP or FOG_EXP2 mode, as a value between 0 and 1. The default is 0.001.
linearStart	Distance in world units at which linear fog starts to encroach. Only applicable if mode is FOG_LINEAR.
linearEnd	Distance in world units at which linear fog becomes completely opaque. Only applicable if mode is FOG_LINEAR.

◆ getFogMode()

FogMode Ogre::SceneManager::getFogMode ( void ) const

inherited

Returns the fog mode for the scene.

◆ getFogColour()

const ColourValue& Ogre::SceneManager::getFogColour ( void ) const

inherited

Returns the fog colour for the scene.

◆ getFogStart()

Real Ogre::SceneManager::getFogStart ( void ) const

inherited

Returns the fog start distance for the scene.

◆ getFogEnd()

Real Ogre::SceneManager::getFogEnd ( void ) const

inherited

Returns the fog end distance for the scene.

◆ getFogDensity()

Real Ogre::SceneManager::getFogDensity ( void ) const

inherited

Returns the fog density for the scene.

◆ createBillboardSet() [1/2]

BillboardSet* Ogre::SceneManager::createBillboardSet ( unsigned int poolSize = 20 )

inherited

Creates a new BillboardSet for use with this scene manager.

Remarks: This method creates a new BillboardSet which is registered with the SceneManager. The SceneManager will destroy this object when it shuts down or when the SceneManager::clearScene method is called, so the caller does not have to worry about destroying this object (in fact, it definitely should not do this).

: See the BillboardSet documentations for full details of the returned class.

Parameters

poolSize The initial size of the pool of billboards (see BillboardSet for more information)

See also: BillboardSet

◆ createBillboardSet() [2/2]

BillboardSet* Ogre::SceneManager::createBillboardSet	(	const String &	name,
		unsigned int	poolSize = `20`
	)

inherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

name	The name to give to this billboard set. Must be unique.

◆ getBillboardSet()

BillboardSet* Ogre::SceneManager::getBillboardSet ( const String & name ) const

inherited

Retrieves a pointer to the named BillboardSet.

Note: Throws an exception if the named instance does not exist

◆ hasBillboardSet()

bool Ogre::SceneManager::hasBillboardSet ( const String & name ) const

inherited

Returns whether a billboardset with the given name exists.

◆ destroyBillboardSet() [1/2]

void Ogre::SceneManager::destroyBillboardSet ( BillboardSet * set )

inherited

Removes & destroys an BillboardSet from the SceneManager.

Warning: Must only be done if the BillboardSet is not attached to a SceneNode. It may be safer to wait to clear the whole scene. If you are unsure, use clearScene.

◆ destroyBillboardSet() [2/2]

void Ogre::SceneManager::destroyBillboardSet ( const String & name )

inherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ destroyAllBillboardSets()

void Ogre::SceneManager::destroyAllBillboardSets ( void )

inherited

Removes & destroys all BillboardSets.

Warning: Again, use caution since no BillboardSet must be referred to elsewhere e.g. attached to a SceneNode otherwise a crash is likely. Use clearScene if you are unsure (it clears SceneNode entries too.)

See also: SceneManager::clearScene

◆ setDisplaySceneNodes()

void Ogre::SceneManager::setDisplaySceneNodes ( bool display )

inherited

Tells the SceneManager whether it should render the SceneNodes which make up the scene as well as the objects in the scene.

Remarks: This method is mainly for debugging purposes. If you set this to 'true', each node will be rendered as a set of 3 axes to allow you to easily see the orientation of the nodes.

◆ getDisplaySceneNodes()

bool Ogre::SceneManager::getDisplaySceneNodes ( void ) const

inlineinherited

Returns true if all scene nodes axis are to be displayed.

◆ createAnimation()

Animation* Ogre::SceneManager::createAnimation	(	const String &	name,
		Real	length
	)

inherited

Creates an animation which can be used to animate scene nodes.

Remarks: An animation is a collection of 'tracks' which over time change the position / orientation of Node objects. In this case, the animation will likely have tracks to modify the position / orientation of SceneNode objects, e.g. to make objects move along a path.

: You don't need to use an Animation object to move objects around - you can do it yourself using the methods of the Node in your FrameListener class. However, when you need relatively complex scripted animation, this is the class to use since it will interpolate between keyframes for you and generally make the whole process easier to manage.

: A single animation can affect multiple Node objects (each AnimationTrack affects a single Node). In addition, through animation blending a single Node can be affected by multiple animations, athough this is more useful when performing skeletal animation (see Skeleton::createAnimation).

: Note that whilst it uses the same classes, the animations created here are kept separate from the skeletal animations of meshes (each Skeleton owns those animations).

Parameters

name	The name of the animation, must be unique within this SceneManager.
length	The total length of the animation.

◆ getAnimation()

Animation* Ogre::SceneManager::getAnimation ( const String & name ) const

inherited

Looks up an Animation object previously created with createAnimation.

Note: Throws an exception if the named instance does not exist

◆ hasAnimation()

bool Ogre::SceneManager::hasAnimation ( const String & name ) const

inherited

Returns whether an animation with the given name exists.

◆ destroyAnimation()

void Ogre::SceneManager::destroyAnimation ( const String & name )

inherited

Destroys an Animation.

Remarks: You should ensure that none of your code is referencing this animation objects since the memory will be freed.

◆ destroyAllAnimations()

void Ogre::SceneManager::destroyAllAnimations ( void )

inherited

Removes all animations created using this SceneManager.

◆ createAnimationState()

AnimationState* Ogre::SceneManager::createAnimationState ( const String & animName )

inherited

Create an AnimationState object for managing application of animations.

Remarks: You can create Animation objects for animating SceneNode obejcts using the createAnimation method. However, in order to actually apply those animations you have to call methods on Node and Animation in a particular order (namely Node::resetToInitialState and Animation::apply). To make this easier and to help track the current time position of animations, the AnimationState object is provided. So if you don't want to control animation application manually, call this method, update the returned object as you like every frame and let SceneManager apply the animation state for you.

: Remember, AnimationState objects are disabled by default at creation time. Turn them on when you want them using their setEnabled method.

: Note that any SceneNode affected by this automatic animation will have it's state reset to it's initial position before application of the animation. Unless specifically modified using Node::setInitialState the Node assumes it's initial state is at the origin. If you want the base state of the SceneNode to be elsewhere, make your changes to the node using the standard transform methods, then call setInitialState to 'bake' this reference position into the node.

: If the target of your animation is to be a generic AnimableValue, you should ensure that it has a base value set (unlike nodes this has no default).

See also: AnimableValue::setAsBaseValue.

Parameters

animName The name of an animation created already with createAnimation.

◆ getAnimationState()

AnimationState* Ogre::SceneManager::getAnimationState ( const String & animName ) const

inherited

Retrieves animation state as previously created using createAnimationState.

Note: Throws an exception if the named instance does not exist

◆ hasAnimationState()

bool Ogre::SceneManager::hasAnimationState ( const String & name ) const

inherited

Returns whether an animation state with the given name exists.

◆ destroyAnimationState()

void Ogre::SceneManager::destroyAnimationState ( const String & name )

inherited

Destroys an AnimationState.

Remarks: You should ensure that none of your code is referencing this animation state object since the memory will be freed.

◆ destroyAllAnimationStates()

void Ogre::SceneManager::destroyAllAnimationStates ( void )

inherited

Removes all animation states created using this SceneManager.

◆ manualRender() [1/2]

void Ogre::SceneManager::manualRender	(	RenderOperation *	rend,
		Pass *	pass,
		Viewport *	vp,
		const Matrix4 &	worldMatrix,
		const Matrix4 &	viewMatrix,
		const Matrix4 &	projMatrix,
		bool	doBeginEndFrame = `false`
	)

inherited

Manual rendering method, for advanced users only.

Remarks: This method allows you to send rendering commands through the pipeline on demand, bypassing OGRE's normal world processing. You should only use this if you really know what you're doing; OGRE does lots of things for you that you really should let it do. However, there are times where it may be useful to have this manual interface, for example overlaying something on top of the scene rendered by OGRE.

: Because this is an instant rendering method, timing is important. The best time to call it is from a RenderTargetListener event handler.

: Don't call this method a lot, it's designed for rare (1 or 2 times per frame) use. Calling it regularly per frame will cause frame rate drops!

Parameters

rend	A RenderOperation object describing the rendering op
pass	The Pass to use for this render
vp	Pointer to the viewport to render to, or 0 to use the current viewport
worldMatrix	The transform to apply from object to world space
viewMatrix	The transform to apply from world to view space
projMatrix	The transform to apply from view to screen space
doBeginEndFrame	If true, beginFrame() and endFrame() are called, otherwise not. You should leave this as false if you are calling this within the main render loop.

◆ manualRender() [2/2]

void Ogre::SceneManager::manualRender	(	Renderable *	rend,
		const Pass *	pass,
		Viewport *	vp,
		const Matrix4 &	viewMatrix,
		const Matrix4 &	projMatrix,
		bool	doBeginEndFrame = `false`,
		bool	lightScissoringClipping = `true`,
		bool	doLightIteration = `true`,
		const LightList *	manualLightList = `0`
	)

inherited

Manual rendering method for rendering a single object.

Parameters

rend	The renderable to issue to the pipeline
pass	The pass to use
vp	Pointer to the viewport to render to, or 0 to use the existing viewport
doBeginEndFrame	If true, beginFrame() and endFrame() are called, otherwise not. You should leave this as false if you are calling this within the main render loop.
viewMatrix	The transform to apply from world to view space
projMatrix	The transform to apply from view to screen space
lightScissoringClipping	If true, passes that have the getLightScissorEnabled and/or getLightClipPlanesEnabled flags will cause calculation and setting of scissor rectangle and user clip planes.
doLightIteration	If true, this method will issue the renderable to the pipeline possibly multiple times, if the pass indicates it should be done once per light
manualLightList	Only applicable if doLightIteration is false, this method allows you to pass in a previously determined set of lights which will be used for a single render of this object.

◆ getRenderQueue()

RenderQueue* Ogre::SceneManager::getRenderQueue ( void )

inherited

Retrieves the internal render queue, for advanced users only.

Remarks: The render queue is mainly used internally to manage the scene object rendering queue, it also exports some methods to allow advanced users to configure the behavior of rendering process. Most methods provided by RenderQueue are supposed to be used internally only, you should reference to the RenderQueue API for more information. Do not access this directly unless you know what you are doing.

◆ addRenderQueueListener()

void Ogre::SceneManager::addRenderQueueListener ( RenderQueueListener * newListener )

inherited

Registers a new RenderQueueListener which will be notified when render queues are processed.

◆ removeRenderQueueListener()

void Ogre::SceneManager::removeRenderQueueListener ( RenderQueueListener * delListener )

inherited

Removes a listener previously added with addRenderQueueListener.

◆ addRenderObjectListener()

void Ogre::SceneManager::addRenderObjectListener ( RenderObjectListener * newListener )

inherited

Registers a new Render Object Listener which will be notified when rendering an object.

◆ removeRenderObjectListener()

void Ogre::SceneManager::removeRenderObjectListener ( RenderObjectListener * delListener )

inherited

Removes a listener previously added with addRenderObjectListener.

◆ addSpecialCaseRenderQueue()

void Ogre::SceneManager::addSpecialCaseRenderQueue ( uint8 qid )

inherited

Adds an item to the 'special case' render queue list.

Remarks: Normally all render queues are rendered, in their usual sequence, only varying if a RenderQueueListener nominates for the queue to be repeated or skipped. This method allows you to add a render queue to a 'special case' list, which varies the behaviour. The effect of this list depends on the 'mode' in which this list is in, which might be to exclude these render queues, or to include them alone (excluding all other queues). This allows you to perform broad selective rendering without requiring a RenderQueueListener.

Parameters

qid	The identifier of the queue which should be added to the special case list. Nothing happens if the queue is already in the list.

◆ removeSpecialCaseRenderQueue()

void Ogre::SceneManager::removeSpecialCaseRenderQueue ( uint8 qid )

inherited

Removes an item to the 'special case' render queue list.

See also: SceneManager::addSpecialCaseRenderQueue

Parameters

qid	The identifier of the queue which should be removed from the special case list. Nothing happens if the queue is not in the list.

◆ clearSpecialCaseRenderQueues()

void Ogre::SceneManager::clearSpecialCaseRenderQueues ( void )

inherited

Clears the 'special case' render queue list.

See also: SceneManager::addSpecialCaseRenderQueue

◆ setSpecialCaseRenderQueueMode()

void Ogre::SceneManager::setSpecialCaseRenderQueueMode ( SpecialCaseRenderQueueMode mode )

inherited

Sets the way the special case render queue list is processed.

See also: SceneManager::addSpecialCaseRenderQueue

Parameters

mode	The mode of processing

◆ getSpecialCaseRenderQueueMode()

SpecialCaseRenderQueueMode Ogre::SceneManager::getSpecialCaseRenderQueueMode ( void )

inherited

Gets the way the special case render queue list is processed.

◆ isRenderQueueToBeProcessed()

bool Ogre::SceneManager::isRenderQueueToBeProcessed ( uint8 qid )

inherited

Returns whether or not the named queue will be rendered based on the current 'special case' render queue list and mode.

See also: SceneManager::addSpecialCaseRenderQueue

Parameters

qid	The identifier of the queue which should be tested

Returns: true if the queue will be rendered, false otherwise

◆ getWorldGeometryRenderQueue()

uint8 Ogre::SceneManager::getWorldGeometryRenderQueue ( void )

inherited

Gets the render queue that the world geometry (if any) this SceneManager renders will be associated with.

Remarks: SceneManagers which provide 'world geometry' should place it in a specialised render queue in order to make it possible to enable / disable it easily using the addSpecialCaseRenderQueue method. Even if the SceneManager does not use the render queues to render the world geometry, it should still pick a queue to represent it's manual rendering, and check isRenderQueueToBeProcessed before rendering.

◆ showBoundingBoxes()

void Ogre::SceneManager::showBoundingBoxes ( bool bShow )

inherited

Allows all bounding boxes of scene nodes to be displayed.

◆ getShowBoundingBoxes()

bool Ogre::SceneManager::getShowBoundingBoxes ( ) const

inherited

Returns if all bounding boxes of scene nodes are to be displayed.

◆ _notifyAutotrackingSceneNode()

void Ogre::SceneManager::_notifyAutotrackingSceneNode	(	SceneNode *	node,
		bool	autoTrack
	)

inherited

Internal method for notifying the manager that a SceneNode is autotracking.

◆ destroyQuery()

void Ogre::SceneManager::destroyQuery ( SceneQuery * query )

inherited

Destroys a scene query of any type.

◆ getCameraIterator()

CameraIterator Ogre::SceneManager::getCameraIterator ( void )

inlineinherited

Returns a specialised MapIterator over all cameras in the scene.

Deprecated:: use getCameras()

◆ getCameras()

const CameraList& Ogre::SceneManager::getCameras ( ) const

inlineinherited

Returns a const version of the camera list.

◆ getAnimationIterator()

AnimationIterator Ogre::SceneManager::getAnimationIterator ( void )

inlineinherited

Returns a specialised MapIterator over all animations in the scene.

Deprecated:: use getAnimations()

◆ getAnimations()

const AnimationList& Ogre::SceneManager::getAnimations ( ) const

inlineinherited

Returns a const version of the animation list.

◆ getAnimationStateIterator()

AnimationStateIterator Ogre::SceneManager::getAnimationStateIterator ( void )

inlineinherited

Returns a specialised MapIterator over all animation states in the scene.

Deprecated:: use getAnimationStates()

References Ogre::AnimationStateSet::getAnimationStateIterator().

◆ getAnimationStates()

const AnimationStateMap& Ogre::SceneManager::getAnimationStates ( )

inlineinherited

Returns a specialised Map over all animation states in the scene.

References Ogre::AnimationStateSet::getAnimationStates().

◆ setShadowTechnique()

void Ogre::SceneManager::setShadowTechnique ( ShadowTechnique technique )

inherited

Sets the general shadow technique to be used in this scene.

Remarks

There are multiple ways to generate shadows in a scene, and each has strengths and weaknesses.

Stencil-based approaches can be used to draw very long, extreme shadows without loss of precision and the 'additive' version can correctly show the shadowing of complex effects like bump mapping because they physically exclude the light from those areas. However, the edges are very sharp and stencils cannot handle transparency, and they involve a fair amount of CPU work in order to calculate the shadow volumes, especially when animated objects are involved.
Texture-based approaches are good for handling transparency (they can, for example, correctly shadow a mesh which uses alpha to represent holes), and they require little CPU overhead, and can happily shadow geometry which is deformed by a vertex program, unlike stencil shadows. However, they have a fixed precision which can introduce 'jaggies' at long range and have fillrate issues of their own.

: We support 2 kinds of stencil shadows, and 2 kinds of texture-based shadows, and one simple decal approach. The 2 stencil approaches differ in the amount of multipass work that is required - the modulative approach simply 'darkens' areas in shadow after the main render, which is the least expensive, whilst the additive approach has to perform a render per light and adds the cumulative effect, which is more expensive but more accurate. The texture based shadows both work in roughly the same way, the only difference is that the shadowmap approach is slightly more accurate, but requires a more recent graphics card.

: Note that because mixing many shadow techniques can cause problems, only one technique is supported at once. Also, you should call this method at the start of the scene setup.

Parameters

technique The shadowing technique to use for the scene.

◆ getShadowTechnique()

ShadowTechnique Ogre::SceneManager::getShadowTechnique ( void ) const

inlineinherited

Gets the current shadow technique.

◆ setShowDebugShadows()

void Ogre::SceneManager::setShowDebugShadows ( bool debug )

inlineinherited

Enables / disables the rendering of debug information for shadows.

◆ getShowDebugShadows()

bool Ogre::SceneManager::getShowDebugShadows ( void ) const

inlineinherited

Are debug shadows shown?

◆ setShadowColour()

void Ogre::SceneManager::setShadowColour ( const ColourValue & colour )

inherited

Set the colour used to modulate areas in shadow.

Remarks: This is only applicable for shadow techniques which involve darkening the area in shadow, as opposed to masking out the light. This colour provided is used as a modulative value to darken the areas.

◆ getShadowColour()

const ColourValue& Ogre::SceneManager::getShadowColour ( void ) const

inherited

Get the colour used to modulate areas in shadow.

Remarks: This is only applicable for shadow techniques which involve darkening the area in shadow, as opposed to masking out the light. This colour provided is used as a modulative value to darken the areas.

◆ setShadowDirectionalLightExtrusionDistance()

void Ogre::SceneManager::setShadowDirectionalLightExtrusionDistance ( Real dist )

inherited

Sets the distance a shadow volume is extruded for a directional light.

Remarks: Although directional lights are essentially infinite, there are many reasons to limit the shadow extrusion distance to a finite number, not least of which is compatibility with older cards (which do not support infinite positions), and shadow caster elimination.

: The default value is 10,000 world units. This does not apply to point lights or spotlights, since they extrude up to their attenuation range.

◆ getShadowDirectionalLightExtrusionDistance()

Real Ogre::SceneManager::getShadowDirectionalLightExtrusionDistance ( void ) const

inherited

Gets the distance a shadow volume is extruded for a directional light.

◆ setShadowFarDistance()

void Ogre::SceneManager::setShadowFarDistance ( Real distance )

inherited

Sets the default maximum distance away from the camera that shadows will be visible.

You have to call this function before you create lights or the default distance of zero will be used.

Remarks: Shadow techniques can be expensive, therefore it is a good idea to limit them to being rendered close to the camera if possible, and to skip the expense of rendering shadows for distance objects. This method allows you to set the distance at which shadows will no longer be rendered.

Note: Each shadow technique can interpret this subtely differently. For example, one technique may use this to eliminate casters, another might use it to attenuate the shadows themselves. You should tweak this value to suit your chosen shadow technique and scene setup.

◆ getShadowFarDistance()

Real Ogre::SceneManager::getShadowFarDistance ( void ) const

inlineinherited

Gets the default maximum distance away from the camera that shadows will be visible.

◆ getShadowFarDistanceSquared()

Real Ogre::SceneManager::getShadowFarDistanceSquared ( void ) const

inlineinherited

◆ setShadowIndexBufferSize()

void Ogre::SceneManager::setShadowIndexBufferSize ( size_t size )

inherited

Sets the maximum size of the index buffer used to render shadow primitives.

Remarks: This method allows you to tweak the size of the index buffer used to render shadow primitives (including stencil shadow volumes). The default size is 51,200 entries, which is 100k of GPU memory, or enough to render approximately 17,000 triangles. You can reduce this as long as you do not have any models / world geometry chunks which could require more than the amount you set.

: The maximum number of triangles required to render a single shadow volume (including light and dark caps when needed) will be 3x the number of edges on the light silhouette, plus the number of light-facing triangles. On average, half the triangles will be facing toward the light, but the number of triangles in the silhouette entirely depends on the mesh - angular meshes will have a higher silhouette tris/mesh tris ratio than a smooth mesh. You can estimate the requirements for your particular mesh by rendering it alone in a scene with shadows enabled and a single light - rotate it or the light and make a note of how high the triangle count goes (remembering to subtract the mesh triangle count)

Parameters

size	The number of indexes; divide this by 3 to determine the number of triangles.

◆ getShadowIndexBufferSize()

size_t Ogre::SceneManager::getShadowIndexBufferSize ( void ) const

inlineinherited

Get the size of the shadow index buffer.

◆ setShadowTextureSize()

void Ogre::SceneManager::setShadowTextureSize ( unsigned short size )

inherited

Set the size of the texture used for all texture-based shadows.

Remarks: The larger the shadow texture, the better the detail on texture based shadows, but obviously this takes more memory. The default size is 512. Sizes must be a power of 2.

Note: This is the simple form, see setShadowTextureConfig for the more complex form.

◆ setShadowTextureConfig() [1/2]

void Ogre::SceneManager::setShadowTextureConfig	(	size_t	shadowIndex,
		unsigned short	width,
		unsigned short	height,
		PixelFormat	format,
		unsigned short	fsaa = `0`,
		uint16	depthBufferPoolId = `1`
	)

inherited

Set the detailed configuration for a shadow texture.

Parameters

shadowIndex	The index of the texture to configure, must be < the number of shadow textures setting
width	The width of the texture
height	The height of the texture
format	The pixel format of the texture
fsaa	The level of multisampling to use. Ignored if the device does not support it.
depthBufferPoolId	The pool # it should query the depth buffers from

◆ setShadowTextureConfig() [2/2]

void Ogre::SceneManager::setShadowTextureConfig	(	size_t	shadowIndex,
		const ShadowTextureConfig &	config
	)

inherited

Set the detailed configuration for a shadow texture.

Parameters

shadowIndex	The index of the texture to configure, must be < the number of shadow textures setting
config	Configuration structure

◆ getShadowTextureConfigIterator()

ConstShadowTextureConfigIterator Ogre::SceneManager::getShadowTextureConfigIterator ( ) const

inherited

Get an iterator over the current shadow texture settings.

◆ setShadowTexturePixelFormat()

void Ogre::SceneManager::setShadowTexturePixelFormat ( PixelFormat fmt )

inherited

Set the pixel format of the textures used for texture-based shadows.

Remarks: By default, a colour texture is used (PF_X8R8G8B8) for texture shadows, but if you want to use more advanced texture shadow types you can alter this. If you do, you will have to also call setShadowTextureCasterMaterial and setShadowTextureReceiverMaterial to provide shader-based materials to use these customised shadow texture formats.

Note: This is the simple form, see setShadowTextureConfig for the more complex form.

◆ setShadowTextureFSAA()

void Ogre::SceneManager::setShadowTextureFSAA ( unsigned short fsaa )

inherited

Set the level of multisample AA of the textures used for texture-based shadows.

Remarks: By default, the level of multisample AA is zero.

Note: This is the simple form, see setShadowTextureConfig for the more complex form.

◆ setShadowTextureCount()

void Ogre::SceneManager::setShadowTextureCount ( size_t count )

inherited

Set the number of textures allocated for texture-based shadows.

Remarks: The default number of textures assigned to deal with texture based shadows is 1; however this means you can only have one light casting shadows at the same time. You can increase this number in order to make this more flexible, but be aware of the texture memory it will use.

◆ getShadowTextureCount()

size_t Ogre::SceneManager::getShadowTextureCount ( void ) const

inlineinherited

Get the number of the textures allocated for texture based shadows.

◆ setShadowTextureCountPerLightType()

void Ogre::SceneManager::setShadowTextureCountPerLightType	(	Light::LightTypes	type,
		size_t	count
	)

inlineinherited

Set the number of shadow textures a light type uses.

Remarks: The default for all light types is 1. This means that each light uses only 1 shadow texture. Call this if you need more than 1 shadow texture per light, E.G. PSSM.

Note: This feature only works with the Integrated shadow technique. Also remember to increase the total number of shadow textures you request appropriately (e.g. via setShadowTextureCount)!!

◆ getShadowTextureCountPerLightType()

size_t Ogre::SceneManager::getShadowTextureCountPerLightType ( Light::LightTypes type ) const

inlineinherited

Get the number of shadow textures is assigned for the given light type.

References Ogre::PF_X8R8G8B8.

◆ setShadowTextureSettings()

void Ogre::SceneManager::setShadowTextureSettings	(	unsigned short	size,
		unsigned short	count,
		PixelFormat	fmt = `PF_X8R8G8B8`,
		unsigned short	fsaa = `0`,
		uint16	depthBufferPoolId = `1`
	)

inherited

Sets the size and count of textures used in texture-based shadows.

See also: setShadowTextureSize and setShadowTextureCount for details, this method just allows you to change both at once, which can save on reallocation if the textures have already been created.

Note: This is the simple form, see setShadowTextureConfig for the more complex form.

◆ getShadowTexture()

const TexturePtr& Ogre::SceneManager::getShadowTexture ( size_t shadowIndex )

inherited

Get a reference to the shadow texture currently in use at the given index.

Note: If you change shadow settings, this reference may no longer be correct, so be sure not to hold the returned reference over texture shadow configuration changes.

◆ setShadowDirLightTextureOffset()

void Ogre::SceneManager::setShadowDirLightTextureOffset ( Real offset )

inlineinherited

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.

Remarks: When generating a shadow texture from a directional light, an approximation is used since it is not possible to render the entire scene to one texture. The texture is projected onto an area centred on the camera, and is the shadow far distance * 2 in length (it is square). This wastes a lot of texture space outside the frustum though, so this offset allows you to move the texture in front of the camera more. However, be aware that this can cause a little shadow 'jittering' during rotation, and that if you move it too far then you'll start to get artefacts close to the camera. The value is represented as a proportion of the shadow far distance, and the default is 0.6.

◆ getShadowDirLightTextureOffset()

Real Ogre::SceneManager::getShadowDirLightTextureOffset ( void ) const

inlineinherited

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.

◆ setShadowTextureFadeStart()

void Ogre::SceneManager::setShadowTextureFadeStart ( Real fadeStart )

inlineinherited

Sets the proportional distance at which texture shadows begin to fade out.

Remarks: To hide the edges where texture shadows end (in directional lights) Ogre will fade out the shadow in the distance. This value is a proportional distance of the entire shadow visibility distance at which the shadow begins to fade out. The default is 0.7

◆ setShadowTextureFadeEnd()

void Ogre::SceneManager::setShadowTextureFadeEnd ( Real fadeEnd )

inlineinherited

Sets the proportional distance at which texture shadows finish to fading out.

Remarks: To hide the edges where texture shadows end (in directional lights) Ogre will fade out the shadow in the distance. This value is a proportional distance of the entire shadow visibility distance at which the shadow is completely invisible. The default is 0.9.

◆ setShadowTextureSelfShadow()

void Ogre::SceneManager::setShadowTextureSelfShadow ( bool selfShadow )

inherited

Sets whether or not texture shadows should attempt to self-shadow.

Remarks: The default implementation of texture shadows uses a fixed-function colour texture projection approach for maximum compatibility, and as such cannot support self-shadowing. However, if you decide to implement a more complex shadowing technique using the setShadowTextureCasterMaterial and setShadowTextureReceiverMaterial there is a possibility you may be able to support self-shadowing (e.g by implementing a shader-based shadow map). In this case you might want to enable this option.

Parameters

selfShadow Whether to attempt self-shadowing with texture shadows

◆ getShadowTextureSelfShadow()

bool Ogre::SceneManager::getShadowTextureSelfShadow ( void ) const

inlineinherited

Gets whether or not texture shadows attempt to self-shadow.

◆ setShadowTextureCasterMaterial() [1/2]

void Ogre::SceneManager::setShadowTextureCasterMaterial ( const MaterialPtr & mat )

inherited

Sets the default material to use for rendering shadow casters.

Remarks: By default shadow casters are rendered into the shadow texture using an automatically generated fixed-function pass. This allows basic projective texture shadows, but it's possible to use more advanced shadow techniques by overriding the caster and receiver materials, for example providing vertex and fragment programs to implement shadow maps.

: You can rely on the ambient light in the scene being set to the requested texture shadow colour, if that's useful.

Note: Individual objects may also override the vertex program in your default material if their materials include shadow_caster_vertex_program_ref, shadow_receiver_vertex_program_ref shadow_caster_material entries, so if you use both make sure they are compatible.; Only a single pass is allowed in your material, although multiple techniques may be used for hardware fallback.

◆ setShadowTextureCasterMaterial() [2/2]

void Ogre::SceneManager::setShadowTextureCasterMaterial ( const String & name )

inherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Deprecated:: use setShadowTextureCasterMaterial(const MaterialPtr&)

◆ setShadowTextureReceiverMaterial() [1/2]

void Ogre::SceneManager::setShadowTextureReceiverMaterial ( const MaterialPtr & mat )

inherited

Sets the default material to use for rendering shadow receivers.

Remarks: By default shadow receivers are rendered as a post-pass using basic modulation. This allows basic projective texture shadows, but it's possible to use more advanced shadow techniques by overriding the caster and receiver materials, for example providing vertex and fragment programs to implement shadow maps.

: You can rely on texture unit 0 containing the shadow texture, and for the unit to be set to use projective texturing from the light (only useful if you're using fixed-function, which is unlikely; otherwise you should rely on the texture_viewproj_matrix auto binding)

Note: Individual objects may also override the vertex program in your default material if their materials include shadow_caster_vertex_program_ref shadow_receiver_vertex_program_ref shadow_receiver_material entries, so if you use both make sure they are compatible.; Only a single pass is allowed in your material, although multiple techniques may be used for hardware fallback.

◆ setShadowTextureReceiverMaterial() [2/2]

void Ogre::SceneManager::setShadowTextureReceiverMaterial ( const String & name )

inherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Deprecated:: use setShadowTextureReceiverMaterial(const MaterialPtr&)

◆ setShadowCasterRenderBackFaces()

void Ogre::SceneManager::setShadowCasterRenderBackFaces ( bool bf )

inlineinherited

Sets whether or not shadow casters should be rendered into shadow textures using their back faces rather than their front faces.

Remarks: Rendering back faces rather than front faces into a shadow texture can help minimise depth comparison issues, if you're using depth shadowmapping. You will probably still need some biasing but you won't need as much. For solid objects the result is the same anyway, if you have objects with holes you may want to turn this option off. The default is to enable this option.

◆ getShadowCasterRenderBackFaces()

bool Ogre::SceneManager::getShadowCasterRenderBackFaces ( ) const

inlineinherited

Gets whether or not shadow casters should be rendered into shadow textures using their back faces rather than their front faces.

◆ setShadowCameraSetup()

void Ogre::SceneManager::setShadowCameraSetup ( const ShadowCameraSetupPtr & shadowSetup )

inherited

Set the shadow camera setup to use for all lights which don't have their own shadow camera setup.

See also: ShadowCameraSetup

◆ getShadowCameraSetup()

const ShadowCameraSetupPtr& Ogre::SceneManager::getShadowCameraSetup ( ) const

inherited

Get the shadow camera setup in use for all lights which don't have their own shadow camera setup.

See also: ShadowCameraSetup

◆ setShadowUseInfiniteFarPlane()

void Ogre::SceneManager::setShadowUseInfiniteFarPlane ( bool enable )

inlineinherited

Sets whether we should use an inifinite camera far plane when rendering stencil shadows.

Remarks: Stencil shadow coherency is very reliant on the shadow volume not being clipped by the far plane. If this clipping happens, you get a kind of 'negative' shadow effect. The best way to achieve coherency is to move the far plane of the camera out to infinity, thus preventing the far plane from clipping the shadow volumes. When combined with vertex program extrusion of the volume to infinity, which Ogre does when available, this results in very robust shadow volumes. For this reason, when you enable stencil shadows, Ogre automatically changes your camera settings to project to infinity if the card supports it. You can disable this behaviour if you like by calling this method; although you can never enable infinite projection if the card does not support it.

: If you disable infinite projection, or it is not available, you need to be far more careful with your light attenuation / directional light extrusion distances to avoid clipping artefacts at the far plane.

Note

Recent cards will generally support infinite far plane projection. However, we have found some cases where they do not, especially on Direct3D. There is no standard capability we can check to validate this, so we use some heuristics based on experience:

OpenGL always seems to support it no matter what the card
Direct3D on non-vertex program capable systems (including vertex program capable cards on Direct3D7) does not support it
Direct3D on GeForce3 and GeForce4 Ti does not seem to support infinite projection

Therefore in the RenderSystem implementation, we may veto the use of an infinite far plane based on these heuristics.

◆ isShadowTechniqueStencilBased()

bool Ogre::SceneManager::isShadowTechniqueStencilBased ( void ) const

inlineinherited

Is there a stencil shadow based shadowing technique in use?

References Ogre::SHADOWDETAILTYPE_STENCIL.

◆ isShadowTechniqueTextureBased()

bool Ogre::SceneManager::isShadowTechniqueTextureBased ( void ) const

inlineinherited

Is there a texture shadow based shadowing technique in use?

References Ogre::SHADOWDETAILTYPE_TEXTURE.

◆ isShadowTechniqueModulative()

bool Ogre::SceneManager::isShadowTechniqueModulative ( void ) const

inlineinherited

Is there a modulative shadowing technique in use?

References Ogre::SHADOWDETAILTYPE_MODULATIVE.

◆ isShadowTechniqueAdditive()

bool Ogre::SceneManager::isShadowTechniqueAdditive ( void ) const

inlineinherited

Is there an additive shadowing technique in use?

References Ogre::SHADOWDETAILTYPE_ADDITIVE.

◆ isShadowTechniqueIntegrated()

bool Ogre::SceneManager::isShadowTechniqueIntegrated ( void ) const

inlineinherited

Is the shadow technique integrated into primary materials?

References Ogre::SHADOWDETAILTYPE_INTEGRATED.

◆ isShadowTechniqueInUse()

bool Ogre::SceneManager::isShadowTechniqueInUse ( void ) const

inlineinherited

Is there any shadowing technique in use?

References Ogre::SHADOWTYPE_NONE.

◆ setShadowUseLightClipPlanes()

void Ogre::SceneManager::setShadowUseLightClipPlanes ( bool enabled )

inlineinherited

Sets whether when using a built-in additive shadow mode, user clip planes should be used to restrict light rendering.

◆ getShadowUseLightClipPlanes()

bool Ogre::SceneManager::getShadowUseLightClipPlanes ( ) const

inlineinherited

Gets whether when using a built-in additive shadow mode, user clip planes should be used to restrict light rendering.

◆ _setActiveCompositorChain()

void Ogre::SceneManager::_setActiveCompositorChain ( CompositorChain * chain )

inlineinherited

Sets the active compositor chain of the current scene being rendered.

Note: CompositorChain does this automatically, no need to call manually.

◆ setLateMaterialResolving()

void Ogre::SceneManager::setLateMaterialResolving ( bool isLate )

inlineinherited

Sets whether to use late material resolving or not.

If set, materials will be resolved from the materials at the pass-setting stage and not at the render queue building stage. This is useful when the active material scheme during the render queue building stage is different from the one during the rendering stage.

◆ isLateMaterialResolving()

bool Ogre::SceneManager::isLateMaterialResolving ( ) const

inlineinherited

Gets whether using late material resolving or not.

See also: setLateMaterialResolving

◆ _getActiveCompositorChain()

CompositorChain* Ogre::SceneManager::_getActiveCompositorChain ( ) const

inlineinherited

Gets the active compositor chain of the current scene being rendered.

◆ addListener()

void Ogre::SceneManager::addListener ( Listener * s )

inherited

Add a listener which will get called back on scene manager events.

◆ removeListener()

void Ogre::SceneManager::removeListener ( Listener * s )

inherited

Remove a listener.

◆ createStaticGeometry()

StaticGeometry* Ogre::SceneManager::createStaticGeometry ( const String & name )

inherited

Creates a StaticGeometry instance suitable for use with this SceneManager.

Remarks: StaticGeometry is a way of batching up geometry into a more efficient form at the expense of being able to move it. Please read the StaticGeometry class documentation for full information.

Parameters

name	The name to give the new object

Returns: The new StaticGeometry instance

◆ getStaticGeometry()

StaticGeometry* Ogre::SceneManager::getStaticGeometry ( const String & name ) const

inherited

Retrieve a previously created StaticGeometry instance.

Note: Throws an exception if the named instance does not exist

◆ hasStaticGeometry()

bool Ogre::SceneManager::hasStaticGeometry ( const String & name ) const

inherited

Returns whether a static geometry instance with the given name exists.

◆ destroyStaticGeometry() [1/2]

void Ogre::SceneManager::destroyStaticGeometry ( StaticGeometry * geom )

inherited

Remove & destroy a StaticGeometry instance.

◆ destroyStaticGeometry() [2/2]

void Ogre::SceneManager::destroyStaticGeometry ( const String & name )

inherited

Remove & destroy a StaticGeometry instance.

◆ destroyAllStaticGeometry()

void Ogre::SceneManager::destroyAllStaticGeometry ( void )

inherited

Remove & destroy all StaticGeometry instances.

◆ createInstancedGeometry()

InstancedGeometry* Ogre::SceneManager::createInstancedGeometry ( const String & name )

inherited

Creates a InstancedGeometry instance suitable for use with this SceneManager.

Remarks: InstancedGeometry is a way of batching up geometry into a more efficient form, and still be able to move it. Please read the InstancedGeometry class documentation for full information.

Parameters

name	The name to give the new object

Returns: The new InstancedGeometry instance

Deprecated:: use createInstanceManager() with InstanceManager::ShaderBased instead

◆ getInstancedGeometry()

InstancedGeometry* Ogre::SceneManager::getInstancedGeometry ( const String & name ) const

inherited

Retrieve a previously created InstancedGeometry instance.

◆ destroyInstancedGeometry() [1/2]

void Ogre::SceneManager::destroyInstancedGeometry ( InstancedGeometry * geom )

inherited

Remove & destroy a InstancedGeometry instance.

◆ destroyInstancedGeometry() [2/2]

void Ogre::SceneManager::destroyInstancedGeometry ( const String & name )

inherited

Remove & destroy a InstancedGeometry instance.

◆ destroyAllInstancedGeometry()

void Ogre::SceneManager::destroyAllInstancedGeometry ( void )

inherited

Remove & destroy all InstancedGeometry instances.

◆ createInstanceManager()

InstanceManager* Ogre::SceneManager::createInstanceManager	(	const String &	customName,
		const String &	meshName,
		const String &	groupName,
		InstanceManager::InstancingTechnique	technique,
		size_t	numInstancesPerBatch,
		uint16	flags = `0`,
		unsigned short	subMeshIdx = `0`
	)

inherited

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.

Remarks: Instancing is a way of batching up geometry into a much more efficient form, but with some limitations, and still be able to move & animate it. Please

See also: InstanceManager class documentation for full information.

Parameters

customName	Custom name for referencing. Must be unique
meshName	The mesh name the instances will be based upon
groupName	The resource name where the mesh lives
technique	Technique to use, which may be shader based, or hardware based.
numInstancesPerBatch	Suggested number of instances per batch. The actual number may end up being lower if the technique doesn't support having so many. It can't be zero
flags	Flags to pass to the InstanceManager

See also: InstanceManagerFlags

Parameters

subMeshIdx InstanceManager only supports using one submesh from the base mesh. This parameter says which submesh to pick (must be <= Mesh::getNumSubMeshes())

Returns: The new InstanceManager instance

◆ getInstanceManager()

InstanceManager* Ogre::SceneManager::getInstanceManager ( const String & managerName ) const

inherited

Retrieves an existing InstanceManager by it's name.

Note: Throws an exception if the named InstanceManager does not exist

◆ hasInstanceManager()

bool Ogre::SceneManager::hasInstanceManager ( const String & managerName ) const

inherited

Returns whether an InstanceManager with the given name exists.

◆ destroyInstanceManager() [1/2]

void Ogre::SceneManager::destroyInstanceManager ( const String & name )

inherited

Destroys an InstanceManager if it was created with createInstanceManager()

Remarks: Be sure you don't have any InstancedEntity referenced somewhere which was created with this manager, since it will become a dangling pointer.

Parameters

name	Name of the manager to remove

◆ destroyInstanceManager() [2/2]

void Ogre::SceneManager::destroyInstanceManager ( InstanceManager * instanceManager )

inherited

◆ destroyAllInstanceManagers()

void Ogre::SceneManager::destroyAllInstanceManagers ( void )

inherited

◆ getNumInstancesPerBatch()

size_t Ogre::SceneManager::getNumInstancesPerBatch	(	const String &	meshName,
		const String &	groupName,
		const String &	materialName,
		InstanceManager::InstancingTechnique	technique,
		size_t	numInstancesPerBatch,
		uint16	flags = `0`,
		unsigned short	subMeshIdx = `0`
	)

inherited

See also: InstanceManager::getMaxOrBestNumInstancesPerBatch

Remarks: If you've already created an InstanceManager, you can call it's getMaxOrBestNumInstancesPerBatch() function directly. Another (not recommended) way to know if the technique is unsupported is by creating an InstanceManager and use createInstancedEntity, which will return null pointer. The input parameter "numInstancesPerBatch" is a suggested value when using IM_VTFBESTFIT flag (in that case it should be non-zero)

Returns: The ideal (or maximum, depending on flags) number of instances per batch for the given technique. Zero if technique is unsupported or errors were spotted

◆ createInstancedEntity()

InstancedEntity* Ogre::SceneManager::createInstancedEntity	(	const String &	materialName,
		const String &	managerName
	)

inherited

Creates an InstancedEntity based on an existing InstanceManager (.

See also: createInstanceManager)

Remarks: Return value may be null if the InstanceManger technique isn't supported Try to keep the number of entities with different materials to a minimum For more information

See also: InstancedManager; InstancedBatch,; InstancedEntity Alternatively you can call InstancedManager::createInstanceEntity using the returned pointer from createInstanceManager

Parameters

materialName	Material name
managerName	Name of the instance manager

Returns: An InstancedEntity ready to be attached to a SceneNode

◆ destroyInstancedEntity()

void Ogre::SceneManager::destroyInstancedEntity ( InstancedEntity * instancedEntity )

inherited

Removes an InstancedEntity,.

See also: SceneManager::createInstancedEntity &; InstanceBatch::removeInstancedEntity

Parameters

instancedEntity Instance to remove

◆ _addDirtyInstanceManager()

void Ogre::SceneManager::_addDirtyInstanceManager ( InstanceManager * dirtyManager )

inherited

Called by an InstanceManager when it has at least one InstanceBatch that needs their bounds to be updated for proper culling.

Parameters

dirtyManager The manager with dirty batches to update

◆ createMovableObject() [1/2]

MovableObject* Ogre::SceneManager::createMovableObject	(	const String &	name,
		const String &	typeName,
		const NameValuePairList *	params = `0`
	)

inherited

Create a movable object of the type specified.

Remarks: This is the generalised form of MovableObject creation where you can create a MovableObject of any specialised type generically, including any new types registered using plugins.

Parameters

name	The name to give the object. Must be unique within type.
typeName	The type of object to create
params	Optional name/value pair list to give extra parameters to the created object.

◆ createMovableObject() [2/2]

MovableObject* Ogre::SceneManager::createMovableObject	(	const String &	typeName,
		const NameValuePairList *	params = `0`
	)

inherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ destroyMovableObject() [1/2]

void Ogre::SceneManager::destroyMovableObject	(	const String &	name,
		const String &	typeName
	)

inherited

Destroys a MovableObject with the name specified, of the type specified.

Remarks: The MovableObject will automatically detach itself from any nodes on destruction.

◆ destroyMovableObject() [2/2]

void Ogre::SceneManager::destroyMovableObject ( MovableObject * m )

inherited

Destroys a MovableObject.

Remarks: The MovableObject will automatically detach itself from any nodes on destruction.

◆ destroyAllMovableObjectsByType()

void Ogre::SceneManager::destroyAllMovableObjectsByType ( const String & typeName )

inherited

Destroy all MovableObjects of a given type.

◆ destroyAllMovableObjects()

void Ogre::SceneManager::destroyAllMovableObjects ( void )

inherited

Destroy all MovableObjects.

◆ getMovableObject()

MovableObject* Ogre::SceneManager::getMovableObject	(	const String &	name,
		const String &	typeName
	)		const

inherited

Get a reference to a previously created MovableObject.

Note: Throws an exception if the named instance does not exist

◆ hasMovableObject()

bool Ogre::SceneManager::hasMovableObject	(	const String &	name,
		const String &	typeName
	)		const

inherited

Returns whether a movable object instance with the given name exists.

◆ getMovableObjectIterator()

MovableObjectIterator Ogre::SceneManager::getMovableObjectIterator ( const String & typeName )

inherited

Get an iterator over all MovableObect instances of a given type.

Note: The iterator returned from this method is not thread safe, do not use this if you are creating or deleting objects of this type in another thread.

◆ injectMovableObject()

void Ogre::SceneManager::injectMovableObject ( MovableObject * m )

inherited

Inject a MovableObject instance created externally.

Remarks: This method 'injects' a MovableObject instance created externally into the MovableObject instance registry held in the SceneManager. You might want to use this if you have a MovableObject which you don't want to register a factory for; for example a MovableObject which cannot be generally constructed by clients.

Note: It is important that the MovableObject has a unique name for the type, and that its getMovableType() method returns a proper type name.

◆ extractMovableObject() [1/2]

void Ogre::SceneManager::extractMovableObject	(	const String &	name,
		const String &	typeName
	)

inherited

Extract a previously injected MovableObject.

Remarks: Essentially this does the same as destroyMovableObject, but only removes the instance from the internal lists, it does not attempt to destroy it.

◆ extractMovableObject() [2/2]

void Ogre::SceneManager::extractMovableObject ( MovableObject * m )

inherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ extractAllMovableObjectsByType()

void Ogre::SceneManager::extractAllMovableObjectsByType ( const String & typeName )

inherited

Extract all injected MovableObjects of a given type.

Remarks: Essentially this does the same as destroyAllMovableObjectsByType, but only removes the instances from the internal lists, it does not attempt to destroy them.

◆ setVisibilityMask()

void Ogre::SceneManager::setVisibilityMask ( uint32 vmask )

inlineinherited

Sets a mask which is bitwise 'and'ed with objects own visibility masks to determine if the object is visible.

Remarks: Note that this is combined with any per-viewport visibility mask through an 'and' operation.

See also: Viewport::setVisibilityMask

◆ getVisibilityMask()

uint32 Ogre::SceneManager::getVisibilityMask ( void )

inlineinherited

Gets a mask which is bitwise 'and'ed with objects own visibility masks to determine if the object is visible.

◆ _getCombinedVisibilityMask()

uint32 Ogre::SceneManager::_getCombinedVisibilityMask ( void ) const

inherited

Internal method for getting the combination between the global visibility mask and the per-viewport visibility mask.

◆ setFindVisibleObjects()

void Ogre::SceneManager::setFindVisibleObjects ( bool find )

inlineinherited

Sets whether the SceneManager should search for visible objects, or whether they are being manually handled.

Remarks: This is an advanced function, you should not use this unless you know what you are doing.

◆ getFindVisibleObjects()

bool Ogre::SceneManager::getFindVisibleObjects ( void )

inlineinherited

Gets whether the SceneManager should search for visible objects, or whether they are being manually handled.

◆ setNormaliseNormalsOnScale()

void Ogre::SceneManager::setNormaliseNormalsOnScale ( bool n )

inlineinherited

Set whether to automatically normalise normals on objects whenever they are scaled.

Remarks: Scaling can distort normals so the default behaviour is to compensate for this, but it has a cost. If you would prefer to manually manage this, set this option to 'false' and use Pass::setNormaliseNormals only when needed.

◆ getNormaliseNormalsOnScale()

bool Ogre::SceneManager::getNormaliseNormalsOnScale ( ) const

inlineinherited

Get whether to automatically normalise normals on objects whenever they are scaled.

◆ setFlipCullingOnNegativeScale()

void Ogre::SceneManager::setFlipCullingOnNegativeScale ( bool n )

inlineinherited

Set whether to automatically flip the culling mode on objects whenever they are negatively scaled.

Remarks: Negativelyl scaling an object has the effect of flipping the triangles, so the culling mode should probably be inverted to deal with this. If you would prefer to manually manage this, set this option to 'false' and use different materials with Pass::setCullingMode set manually as needed.

◆ getFlipCullingOnNegativeScale()

bool Ogre::SceneManager::getFlipCullingOnNegativeScale ( ) const

inlineinherited

Get whether to automatically flip the culling mode on objects whenever they are negatively scaled.

◆ _injectRenderWithPass()

void Ogre::SceneManager::_injectRenderWithPass	(	Pass *	pass,
		Renderable *	rend,
		bool	shadowDerivation = `true`,
		bool	doLightIteration = `false`,
		const LightList *	manualLightList = `0`
	)

inherited

Render something as if it came from the current queue.

Parameters

pass	Material pass to use for setting up this quad.
rend	Renderable to render
shadowDerivation	Whether passes should be replaced with shadow caster / receiver passes

◆ _suppressRenderStateChanges()

void Ogre::SceneManager::_suppressRenderStateChanges ( bool suppress )

inherited

Indicates to the SceneManager whether it should suppress changing the RenderSystem states when rendering objects.

Remarks: This method allows you to tell the SceneManager not to change any RenderSystem state until you tell it to. This method is only intended for advanced use, don't use it if you're unsure of the effect. The only RenderSystems calls made are to set the world matrix for each object (note - view an projection matrices are NOT SET - they are under your control) and to render the object; it is up to the caller to do everything else, including enabling any vertex / fragment programs and updating their parameter state, and binding parameters to the RenderSystem.

Note: Calling this implicitly disables shadow processing since no shadows can be rendered without changing state.

Parameters

suppress If true, no RenderSystem state changes will be issued until this method is called again with a parameter of false.

◆ _areRenderStateChangesSuppressed()

bool Ogre::SceneManager::_areRenderStateChangesSuppressed ( void ) const

inlineinherited

Are render state changes suppressed?

See also: _suppressRenderStateChanges

◆ _setPass()

const Pass* Ogre::SceneManager::_setPass	(	const Pass *	pass,
		bool	evenIfSuppressed = `false`,
		bool	shadowDerivation = `true`
	)

inherited

Internal method for setting up the renderstate for a rendering pass.

Parameters

pass	The Pass details to set.
evenIfSuppressed	Sets the pass details even if render state changes are suppressed; if you are using this to manually set state when render state changes are suppressed, you should set this to true.
shadowDerivation	If false, disables the derivation of shadow passes from original passes

Returns: A Pass object that was used instead of the one passed in, can happen when rendering shadow passes

◆ _markGpuParamsDirty()

void Ogre::SceneManager::_markGpuParamsDirty ( uint16 mask )

inherited

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.

Only really useful if you're controlling parameter state in inner rendering loop callbacks.

Parameters

mask	Some combination of GpuParamVariability which is bitwise OR'ed with the current dirty state.

◆ _suppressShadows()

void Ogre::SceneManager::_suppressShadows ( bool suppress )

inherited

Indicates to the SceneManager whether it should suppress the active shadow rendering technique until told otherwise.

Remarks: This is a temporary alternative to setShadowTechnique to suppress the rendering of shadows and forcing all processing down the standard rendering path. This is intended for internal use only.

Parameters

suppress If true, no shadow rendering will occur until this method is called again with a parameter of false.

◆ _areShadowsSuppressed()

bool Ogre::SceneManager::_areShadowsSuppressed ( void ) const

inlineinherited

Are shadows suppressed?

See also: _suppressShadows

◆ _renderQueueGroupObjects()

void Ogre::SceneManager::_renderQueueGroupObjects	(	RenderQueueGroup *	group,
		QueuedRenderableCollection::OrganisationMode	om
	)

inherited

Render the objects in a given queue group.

Remarks: You should only call this from a RenderQueueInvocation implementation

◆ setQueuedRenderableVisitor()

void Ogre::SceneManager::setQueuedRenderableVisitor ( SceneMgrQueuedRenderableVisitor * visitor )

inherited

Advanced method for supplying an alternative visitor, used for parsing the render queues and sending the results to the renderer.

Remarks: You can use this method to insert your own implementation of the QueuedRenderableVisitor interface, which receives calls as the queued renderables are parsed in a given order (determined by RenderQueueInvocationSequence) and are sent to the renderer. If you provide your own implementation of this visitor, you are responsible for either calling the rendersystem, or passing the calls on to the base class implementation.

Note: Ownership is not taken of this pointer, you are still required to delete it yourself once you're finished.

Parameters

visitor Your implementation of SceneMgrQueuedRenderableVisitor. If you pass 0, the default implementation will be used.

◆ getQueuedRenderableVisitor()

SceneMgrQueuedRenderableVisitor* Ogre::SceneManager::getQueuedRenderableVisitor ( void ) const

inherited

Gets the current visitor object which processes queued renderables.

◆ getDestinationRenderSystem()

RenderSystem* Ogre::SceneManager::getDestinationRenderSystem ( )

inherited

Get the rendersystem subclass to which the output of this Scene Manager gets sent.

◆ getCurrentViewport()

Viewport* Ogre::SceneManager::getCurrentViewport ( void ) const

inlineinherited

Gets the current viewport being rendered (advanced use only, only valid during viewport update.

◆ getVisibleObjectsBoundsInfo()

const VisibleObjectsBoundsInfo& Ogre::SceneManager::getVisibleObjectsBoundsInfo ( const Camera * cam ) const

inherited

Returns a visibility boundary box for a specific camera.

◆ getShadowCasterBoundsInfo()

const VisibleObjectsBoundsInfo& Ogre::SceneManager::getShadowCasterBoundsInfo	(	const Light *	light,
		size_t	iteration = `0`
	)		const

inherited

Returns the shadow caster AAB for a specific light-camera combination.

◆ setCameraRelativeRendering()

void Ogre::SceneManager::setCameraRelativeRendering ( bool rel )

inlineinherited

Set whether to use camera-relative co-ordinates when rendering, ie to always place the camera at the origin and move the world around it.

Remarks: This is a technique to alleviate some of the precision issues associated with rendering far from the origin, where single-precision floats as used in most GPUs begin to lose their precision. Instead of including the camera translation in the view matrix, it only includes the rotation, and the world matrices of objects must be expressed relative to this.

Note: If you need this option, you will probably also need to enable double-precision mode in Ogre (OGRE_DOUBLE_PRECISION), since even though this will alleviate the rendering precision, the source camera and object positions will still suffer from precision issues leading to jerky movement.

◆ getCameraRelativeRendering()

bool Ogre::SceneManager::getCameraRelativeRendering ( ) const

inlineinherited

Get whether to use camera-relative co-ordinates when rendering, ie to always place the camera at the origin and move the world around it.

◆ addLodListener()

void Ogre::SceneManager::addLodListener ( LodListener * listener )

inherited

Add a level of detail listener.

◆ removeLodListener()

void Ogre::SceneManager::removeLodListener ( LodListener * listener )

inherited

Remove a level of detail listener.

Remarks: Do not call from inside an LodListener callback method.

◆ _notifyMovableObjectLodChanged()

void Ogre::SceneManager::_notifyMovableObjectLodChanged ( MovableObjectLodChangedEvent & evt )

inherited

Notify that a movable object LOD change event has occurred.

◆ _notifyEntityMeshLodChanged()

void Ogre::SceneManager::_notifyEntityMeshLodChanged ( EntityMeshLodChangedEvent & evt )

inherited

Notify that an entity mesh LOD change event has occurred.

◆ _notifyEntityMaterialLodChanged()

void Ogre::SceneManager::_notifyEntityMaterialLodChanged ( EntityMaterialLodChangedEvent & evt )

inherited

Notify that an entity material LOD change event has occurred.

◆ _handleLodEvents()

void Ogre::SceneManager::_handleLodEvents ( )

inherited

Handle LOD events.

◆ _getCurrentRenderStage()

IlluminationRenderStage Ogre::SceneManager::_getCurrentRenderStage ( )

inlineinherited

Friends And Related Function Documentation

◆ PCZIntersectionSceneQuery

friend class PCZIntersectionSceneQuery

friend

◆ PCZRaySceneQuery

friend class PCZRaySceneQuery

friend

◆ PCZSphereSceneQuery

friend class PCZSphereSceneQuery

friend

◆ PCZAxisAlignedBoxSceneQuery

friend class PCZAxisAlignedBoxSceneQuery

friend

◆ PCZPlaneBoundedVolumeListSceneQuery

friend class PCZPlaneBoundedVolumeListSceneQuery

friend

Member Data Documentation

◆ WORLD_GEOMETRY_TYPE_MASK

uint32 Ogre::SceneManager::WORLD_GEOMETRY_TYPE_MASK

staticinherited

Query type mask which will be used for world geometry.

See also: SceneQuery

◆ ENTITY_TYPE_MASK

uint32 Ogre::SceneManager::ENTITY_TYPE_MASK

staticinherited

Query type mask which will be used for entities.

See also: SceneQuery

◆ FX_TYPE_MASK

uint32 Ogre::SceneManager::FX_TYPE_MASK

staticinherited

Query type mask which will be used for effects like billboardsets / particle systems.

See also: SceneQuery

◆ STATICGEOMETRY_TYPE_MASK

uint32 Ogre::SceneManager::STATICGEOMETRY_TYPE_MASK

staticinherited

Query type mask which will be used for StaticGeometry.

See also: SceneQuery

◆ LIGHT_TYPE_MASK

uint32 Ogre::SceneManager::LIGHT_TYPE_MASK

staticinherited

Query type mask which will be used for lights.

See also: SceneQuery

◆ FRUSTUM_TYPE_MASK

uint32 Ogre::SceneManager::FRUSTUM_TYPE_MASK

staticinherited

Query type mask which will be used for frusta and cameras.

See also: SceneQuery

◆ USER_TYPE_MASK_LIMIT

uint32 Ogre::SceneManager::USER_TYPE_MASK_LIMIT

staticinherited

User type mask limit.

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

OgrePCZSceneManager.h

Public Types

Public Member Functions

Static Public Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ ZoneIterator

◆ CameraList

◆ AnimationList

◆ CameraIterator

◆ AnimationIterator

◆ MovableObjectIterator

Member Enumeration Documentation

◆ IlluminationRenderStage

◆ SpecialCaseRenderQueueMode

◆ PrefabType

Constructor & Destructor Documentation

◆ PCZSceneManager()

◆ ~PCZSceneManager()

Member Function Documentation

◆ getTypeName()

◆ init()

◆ createPortal()

◆ destroyPortal() [1/2]

◆ destroyPortal() [2/2]

◆ createAntiPortal()

◆ destroyAntiPortal() [1/2]

◆ destroyAntiPortal() [2/2]

◆ createZoneFromFile()

◆ setZoneGeometry()

◆ createSceneNodeImpl() [1/2]

◆ createSceneNodeImpl() [2/2]

◆ createSceneNode() [1/2]

◆ createSceneNode() [2/2]

◆ createCamera()

◆ destroySceneNode() [1/2]

◆ destroySceneNode() [2/2]

◆ clearScene()

◆ setWorldGeometryRenderQueue()

◆ _renderScene()

◆ enableSky()

◆ setSkyZone()

◆ _updateSceneGraph()

◆ _findVisibleObjects()

◆ _alertVisibleObjects()

◆ createLight() [1/2]

◆ getLight()

◆ hasLight()

◆ destroyLight() [1/2]

◆ destroyAllLights()

◆ _updatePortalZoneData()

◆ _dirtyNodeByMovingPortals()

◆ _updatePCZSceneNodes()

◆ _calcZonesAffectedByLights()

◆ connectPortalsToTargetZonesByLocation()

◆ _updatePCZSceneNode()

◆ removeSceneNode()

◆ addPCZSceneNode()

◆ createZone()

◆ destroyZone()

◆ _updateHomeZone()

◆ findZoneForPoint()

◆ createZoneSpecificNodeData() [1/2]

◆ createZoneSpecificNodeData() [2/2]

◆ setNodeHomeZone()

◆ findNodesIn() [1/4]

◆ findNodesIn() [2/4]

◆ findNodesIn() [3/4]

◆ findNodesIn() [4/4]

◆ getDefaultZone()

◆ getZoneByName()

◆ setShowPortals()

◆ setOption()

◆ getOption()

◆ getOptionValues()

◆ getOptionKeys()

◆ createAABBQuery()

◆ createSphereQuery()

◆ createPlaneBoundedVolumeQuery()

◆ createRayQuery()