Represents a layer which is rendered on top of the 'normal' scene contents. More...

#include <OgreOverlay.h>

Inheritance diagram for Ogre::v1::Overlay:

Public Types
typedef FastArray< MovableObject * >	MovableObjectArray
	@See SceneManager::cullFrustum

typedef VectorIterator< OverlayContainerList >	Overlay2DElementsIterator
	Returns an iterator over all 2D elements in this manager.

typedef list< OverlayContainer * >::type	OverlayContainerList

Public Member Functions
	Overlay (const String &name, IdType id, ObjectMemoryManager *objectMemoryManager, uint8 renderQueueId)
	Constructor: do not call direct, use OverlayManager::create.

virtual	~Overlay ()

LightList *	_getLightList ()
	Returns a pointer to the current list of lights for this object.

SceneManager *	_getManager (void) const
	Get the manager of this object, if any (internal use only)

ObjectData &	_getObjectData ()
	Returns a direct access to the ObjectData state.

const Matrix4 &	_getParentNodeFullTransform (void) const
	Returns the full transformation of the parent sceneNode or the attachingPoint node.

void	_getWorldTransforms (Matrix4 *xform) const
	Used to transform the overlay when scrolling, scaling etc.

virtual void	_notifyAttached (Node *parent)
	Internal method called to notify the object that it has been attached to a node.

void	_notifyManager (SceneManager *man)
	Notify the object of it's manager (internal use only)

void	_notifyOrigin (const String &origin)
	Notify this overlay of it's origin.

virtual void	_notifyParentNodeMemoryChanged (void)
	@See Node::_callMemoryChangeListeners

virtual void	_notifyStaticDirty (void) const
	Called by SceneManager when it is telling we're a static MovableObject being dirty Don't call this directly.

virtual void	_releaseManualHardwareResources ()
	Notifies the movable object that hardware resources were lost.

virtual void	_restoreManualHardwareResources ()
	Notifies the movable object that hardware resources should be restored.

virtual void	_updateRenderQueue (RenderQueue queue, Camera camera, const Camera *lodCamera)
	Internal method by which the movable object must add Renderable subclass instances to the rendering queue.

virtual void	_updateRenderQueue (RenderQueue queue, Camera camera, const Camera lodCamera, Viewport vp)
	Internal method to put the overlay contents onto the render queue.

void	add2D (OverlayContainer *cont)
	Adds a 2D 'container' to the overlay.

void	add3D (SceneNode *node)
	Adds a node capable of holding 3D objects to the overlay.

void	addQueryFlags (uint32 flags)
	As setQueryFlags, except the flags passed as parameters are appended to the existing flags on this object.

void	addVisibilityFlags (uint32 flags)
	As setVisibilityFlags, except the flags passed as parameters are appended to the existing flags on this object.

void	clear ()
	Clears the overlay of all attached items.

virtual AnimableValuePtr	createAnimableValue (const String &valueName)
	Create a reference-counted AnimableValuePtr for the named value.

void	detachFromParent (void)
	Detaches an object from a parent SceneNode if attached.

virtual OverlayElement *	findElementAt (Real x, Real y)
	This returns a OverlayElement at position x,y.

Overlay2DElementsIterator	get2DElementsIterator ()

const StringVector &	getAnimableValueNames (void) const
	Gets a list of animable value names for this object.

RealAsUint	getCachedDistanceToCamera (void) const
	Returns the distance to camera as calculated in @cullFrustum.

Real	getCachedDistanceToCameraAsReal (void) const
	Returns the distance to camera as calculated in @cullFrustum.

bool	getCastShadows (void) const
	Returns whether shadow casting is enabled for this object.

OverlayContainer *	getChild (const String &name)

unsigned char	getCurrentMeshLod (void) const

IdType	getId () const
	Get the unique id of this object.

uint32	getLightMask () const
	Get a bitwise mask which will filter the lights affecting this object.

Listener *	getListener (void) const
	Gets the current listener for this object.

Aabb	getLocalAabb (void) const
	Retrieves the local axis-aligned bounding box for this object.

float	getLocalRadius (void) const
	See getLocalAabb and getWorldRadius.

virtual const String &	getMovableType (void) const
	Returns the type name of this object.

const String &	getName (void) const
	Returns the name of this object.

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

Node *	getParentNode (void) const
	Returns the node to which this object is attached.

SceneNode *	getParentSceneNode (void) const

uint32	getQueryFlags (void) const
	Returns the query flags relevant for this object.

Real	getRenderingDistance (void) const
	Gets the distance at which batches are no longer rendered.

Real	getRenderingMinPixelSize () const
	Returns the minimum pixel size an object needs to be in both screen axes in order to be rendered.

uint8	getRenderQueueGroup (void) const
	Gets the queue group for this entity, see setRenderQueueGroup for full details.

const Radian &	getRotate (void) const
	Gets the rotation applied to this overlay, in degrees.

Real	getScaleX (void) const
	Gets the current X scale value.

Real	getScaleY (void) const
	Gets the current Y scale value.

Real	getScrollX (void) const
	Gets the current X scroll value.

Real	getScrollY (void) const
	Gets the current Y scroll value.

Real	getShadowRenderingDistance (void) const
	Gets the distance at which batches are no longer casting shadows.

SkeletonInstance *	getSkeletonInstance (void) const

UserObjectBindings &	getUserObjectBindings ()
	Return an instance of user objects binding associated with this class.

const UserObjectBindings &	getUserObjectBindings () const
	Return an instance of user objects binding associated with this class.

uint32	getVisibilityFlags (void) const
	Returns the visibility flags relevant for this object.

bool	getVisible (void) const
	Gets this object whether to be visible or not, if it has a renderable component.

Aabb	getWorldAabb () const
	Gets the axis aligned box in world space.

Aabb	getWorldAabbUpdated ()
	Gets the axis aligned box in world space.

float	getWorldRadius () const
	Gets the bounding Radius scaled by max( scale.x, scale.y, scale.z ).

float	getWorldRadiusUpdated ()
	Gets the bounding Radius scaled by max( scale.x, scale.y, scale.z ).

uint16	getZOrder (void) const
	Gets the Z-order of this overlay.

void	hide (void)
	Hides the overlay if it was visible.

virtual void	instanceBatchCullFrustumThreaded (const Frustum frustum, const Camera lodCamera, uint32 combinedVisibilityFlags)
	@See InstancingTheadedCullingMethod,

bool	isAttached (void) const
	Returns true if this object is attached to a Node.

bool	isInitialised (void) const
	Gets whether the overlay is initialised or not.

bool	isStatic () const
	Checks whether this MovableObject is static. @See setStatic.

bool	isVisible (void) const
	Returns whether or not this object is supposed to be visible or not.

void	operator delete (void *ptr)

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

void	operator delete (void ptr, void )

void	operator delete[] (void *ptr)

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

void *	operator new (size_t sz)

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

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

void *	operator new[] (size_t sz)

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

bool	operator() (const IdObject &left, const IdObject &right)

bool	operator() (const IdObject left, const IdObject right)

const LightList &	queryLights (void) const
	Gets a list of lights, ordered relative to how close they are to this movable object.

void	remove2D (OverlayContainer *cont)
	Removes a 2D container from the overlay.

void	remove3D (SceneNode *node)
	Removes a 3D element from the overlay.

void	removeQueryFlags (uint32 flags)
	As setQueryFlags, except the flags passed as parameters are removed from the existing flags on this object.

void	removeVisibilityFlags (uint32 flags)
	As setVisibilityFlags, except the flags passed as parameters are removed from the existing flags on this object.

void	rotate (const Radian &angle)
	Adds the passed in angle to the rotation applied to this overlay.

void	scroll (Real xoff, Real yoff)
	Scrolls the overlay by the offsets provided.

void	setCastShadows (bool enabled)
	Sets whether or not this object will cast shadows.

void	setLightMask (uint32 lightMask)
	Set a bitwise mask which will filter the lights affecting this object.

void	setListener (Listener *listener)
	Sets a listener for this object.

void	setLocalAabb (const Aabb box)
	Sets the local axis-aligned bounding box for this object.

void	setName (const String &name)
	Sets a custom name for this node.

void	setQueryFlags (uint32 flags)
	Sets the query flags for this object.

void	setRenderingDistance (Real dist)
	Sets the distance at which the object is no longer rendered.

void	setRenderingMinPixelSize (Real pixelSize)
	Sets the minimum pixel size an object needs to be in both screen axes in order to be rendered.

virtual void	setRenderQueueGroup (uint8 queueID)
	Sets the render queue group this entity will be rendered through.

void	setRotate (const Radian &angle)
	Sets the rotation applied to this overlay.

void	setScale (Real x, Real y)
	Sets the scaling factor of this overlay.

void	setScroll (Real x, Real y)
	Sets the scrolling factor of this overlay.

void	setShadowRenderingDistance (Real dist)
	Sets the distance at which the object is no longer casting shadows.

bool	setStatic (bool bStatic)
	Turns this Node into static or dynamic.

void	setVisibilityFlags (uint32 flags)
	Sets the visibility flags for this object.

void	setVisible (bool visible)
	Tells this object whether to be visible or not, if it has a renderable component.

void	setZOrder (uint16 zorder)
	Alters the Z-order of this overlay.

void	show (void)
	Shows the overlay if it was hidden.

Static Public Member Functions
static void	buildLightList (const size_t numNodes, ObjectData t, const LightListInfo &globalLightList)
	@See SceneManager::buildLightList

static void	calculateCastersBox (const size_t numNodes, ObjectData t, uint32 sceneVisibilityFlags, AxisAlignedBox *outBox)

static void	cullFrustum (const size_t numNodes, ObjectData t, const Camera frustum, uint32 sceneVisibilityFlags, MovableObjectArray &outCulledObjects, const Camera lodCamera)

static void	cullLights (const size_t numNodes, ObjectData t, LightListInfo &outGlobalLightList, const FrustumVec &frustums, const FrustumVec &cubemapFrustums)
	@See SceneManager::cullLights &

static uint32	getDefaultQueryFlags ()
	Get the default query flags for all future MovableObject instances.

static uint32	getDefaultVisibilityFlags ()
	Get the default visibility flags for all future MovableObject instances.

static void	setDefaultQueryFlags (uint32 flags)
	Set the default query flags for all future MovableObject instances.

static void	setDefaultVisibilityFlags (uint32 flags)
	Set the default visibility flags for all future MovableObject instances.

static void	updateAllBounds (const size_t numNodes, ObjectData t)
	@See SceneManager::updateAllBounds

Public Attributes
size_t	mGlobalIndex
	Index in the vector holding this MO reference (could be our parent node, or a global array tracking all movable objecst to avoid memory leaks).

size_t	mParentIndex
	Index in the vector holding this MO reference (could be our parent node, or a global array tracking all movable objecst to avoid memory leaks).

RenderableArray	mRenderables

Static Public Attributes
static const FastArray< Real >	c_DefaultLodMesh

Detailed Description

Represents a layer which is rendered on top of the 'normal' scene contents.

Remarks: An overlay is a container for visual components (2D and 3D) which will be rendered after the main scene in order to composite heads-up-displays, menus or other layers on top of the contents of the scene.

: An overlay always takes up the entire size of the viewport, although the components attached to it do not have to. An overlay has no visual element in itself, it it merely a container for visual elements.

: Overlays are created by calling OverlayManager::create, or by defining them in special text scripts (.overlay files). As many overlays as you like can be defined; after creation an overlay is hidden i.e. not visible until you specifically enable it by calling 'show'. This allows you to have multiple overlays predefined (menus etc) which you make visible only when you want. It is possible to have multiple overlays enabled at once; in this case the relative 'zorder' parameter of the overlays determine which one is displayed on top.

: By default overlays are rendered into all viewports. This is fine when you only have fullscreen viewports, but if you have picture-in-picture views, you probably don't want the overlay displayed in the smaller viewports. You turn this off for a specific viewport by calling the Viewport::setDisplayOverlays method.

Member Typedef Documentation

◆ MovableObjectArray

typedef FastArray<MovableObject*> Ogre::MovableObject::MovableObjectArray

inherited

@See SceneManager::cullFrustum

Remarks: We don't pass by reference on purpose (avoid implicit aliasing) We perform frustum culling AND test visibility mask at the same time

Parameters

frustum	Frustum to clip against
sceneVisibilityFlags	Combined scene's visibility flags (i.e. viewport \| scene). Set LAYER_SHADOW_CASTER bit if you want to exclude non-shadow casters.
outCulledObjects	Out. List of objects that are (fully or partially) inside the frustum and should be rendered
lodCamera	Camera in which lod levels calculations are based (i.e. during shadow pass renders) Note however, we only use this camera to calulate if should be visible according to mUpperDistance

◆ Overlay2DElementsIterator

typedef VectorIterator<OverlayContainerList> Ogre::v1::Overlay::Overlay2DElementsIterator

Returns an iterator over all 2D elements in this manager.

Remarks: VectorIterator is actually a too generic name, since it also works for lists.

◆ OverlayContainerList

typedef list<OverlayContainer*>::type Ogre::v1::Overlay::OverlayContainerList

Constructor & Destructor Documentation

◆ Overlay()

Ogre::v1::Overlay::Overlay	(	const String &	name,
		IdType	id,
		ObjectMemoryManager *	objectMemoryManager,
		uint8	renderQueueId
	)

Constructor: do not call direct, use OverlayManager::create.

◆ ~Overlay()

virtual Ogre::v1::Overlay::~Overlay ( )

virtual

Member Function Documentation

◆ _getLightList()

LightList * Ogre::MovableObject::_getLightList ( )

inlineinherited

Returns a pointer to the current list of lights for this object.

Remarks: You should not modify this list outside of MovableObject::Listener::objectQueryLights (say if you want to use it to implement this method, and use the pointer as a return value) and for reading it's only accurate as at the last frame.

◆ _getManager()

SceneManager * Ogre::MovableObject::_getManager ( void ) const

inlineinherited

Get the manager of this object, if any (internal use only)

◆ _getObjectData()

ObjectData & Ogre::MovableObject::_getObjectData ( )

inlineinherited

Returns a direct access to the ObjectData state.

◆ _getParentNodeFullTransform()

const Matrix4 & Ogre::MovableObject::_getParentNodeFullTransform ( void ) const

inherited

Returns the full transformation of the parent sceneNode or the attachingPoint node.

◆ _getWorldTransforms()

void Ogre::v1::Overlay::_getWorldTransforms ( Matrix4 * xform ) const

Used to transform the overlay when scrolling, scaling etc.

◆ _notifyAttached()

virtual void Ogre::MovableObject::_notifyAttached ( Node * parent )

virtualinherited

Internal method called to notify the object that it has been attached to a node.

Reimplemented in Ogre::v1::Entity, Ogre::v1::InstancedEntity, and Ogre::ParticleSystem.

◆ _notifyManager()

void Ogre::MovableObject::_notifyManager ( SceneManager * man )

inlineinherited

Notify the object of it's manager (internal use only)

◆ _notifyOrigin()

void Ogre::v1::Overlay::_notifyOrigin ( const String & origin )

inline

Notify this overlay of it's origin.

◆ _notifyParentNodeMemoryChanged()

virtual void Ogre::MovableObject::_notifyParentNodeMemoryChanged ( void )

inlinevirtualinherited

@See Node::_callMemoryChangeListeners

Reimplemented in Ogre::v1::InstancedEntity, and Ogre::Item.

◆ _notifyStaticDirty()

virtual void Ogre::MovableObject::_notifyStaticDirty ( void ) const

inlinevirtualinherited

Called by SceneManager when it is telling we're a static MovableObject being dirty Don't call this directly.

See also: SceneManager::notifyStaticDirty

Reimplemented in Ogre::v1::InstancedEntity.

◆ _releaseManualHardwareResources()

virtual void Ogre::MovableObject::_releaseManualHardwareResources ( )

inlinevirtualinherited

Notifies the movable object 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 nested shadow renderables, ManualObjects, etc.

Reimplemented in Ogre::v1::BillboardSet, and Ogre::v1::ManualObject.

◆ _restoreManualHardwareResources()

virtual void Ogre::MovableObject::_restoreManualHardwareResources ( )

inlinevirtualinherited

Notifies the movable object 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 nested shadow renderables, ManualObjects, etc.

◆ _updateRenderQueue() [1/2]

virtual void Ogre::MovableObject::_updateRenderQueue	(	RenderQueue *	queue,
		Camera *	camera,
		const Camera *	lodCamera
	)

inlinevirtualinherited

Internal method by which the movable object must add Renderable subclass instances to the rendering queue.

Remarks: The engine will call this method when this object is to be rendered. The object must then create one or more Renderable subclass instances which it places on the passed in Queue for rendering.

Reimplemented in Ogre::v1::BillboardChain, Ogre::MovablePlane, Ogre::v1::BillboardSet, Ogre::v1::Entity, Ogre::v1::InstanceBatchHW, Ogre::v1::InstanceBatchHW_VTF, Ogre::v1::BaseInstanceBatchVTF, Ogre::v1::InstancedEntity, Ogre::Light, Ogre::v1::ManualObject, Ogre::ParticleSystem, and Ogre::v1::StaticGeometry::Region.

◆ _updateRenderQueue() [2/2]

virtual void Ogre::v1::Overlay::_updateRenderQueue	(	RenderQueue *	queue,
		Camera *	camera,
		const Camera *	lodCamera,
		Viewport *	vp
	)

virtual

Internal method to put the overlay contents onto the render queue.

◆ add2D()

void Ogre::v1::Overlay::add2D ( OverlayContainer * cont )

Adds a 2D 'container' to the overlay.

Remarks: Containers are created and managed using the OverlayManager. A container could be as simple as a square panel, or something more complex like a grid or tree view. Containers group collections of other elements, giving them a relative coordinate space and a common z-order. If you want to attach a GUI widget to an overlay, you have to do it via a container.

Parameters

cont	Pointer to a container to add, created using OverlayManager.

◆ add3D()

void Ogre::v1::Overlay::add3D ( SceneNode * node )

Adds a node capable of holding 3D objects to the overlay.

Remarks: Although overlays are traditionally associated with 2D elements, there are reasons why you might want to attach 3D elements to the overlay too. For example, if you wanted to have a 3D cockpit, which was overlaid with a HUD, then you would create 2 overlays, one with a 3D object attached for the cockpit, and one with the HUD elements attached (the zorder of the HUD overlay would be higher than the cockpit to ensure it was always on top).

A SceneNode can have any number of 3D objects attached to it. SceneNodes are usually created using SceneManager::createSceneNode, but in this case you should create a standard SceneNode instance manually; this is because these scene nodes are not managed by the SceneManager and some custom SceneManager plugins will rely on specialist behaviour the overlay does not support. By attaching a SceneNode to an overlay, you indicate that:

You want the contents of this node to only appear when the overlay is active
You want the node to inherit a coordinate space relative to the camera, rather than relative to the root scene node
You want these objects to be rendered after the contents of the main scene to ensure they are rendered on top

One major consideration when using 3D objects in overlays is the behaviour of the depth buffer. Overlays should use materials with depth checking off, to ensure that their contents are always displayed on top of the main scene (to do otherwise would result in objects 'poking through' the overlay). The problem with using 3D objects is that if they are concave, or self-overlap, then you can get artefacts because of the lack of depth buffer checking. So you should ensure that any 3D objects you us in the overlay are convex, and don't overlap each other. If they must overlap, split them up and put them in 2 overlays. Alternatively, use a 2D element underneath them which will clear the depth buffer values underneath ready for the 3D element to be rendered correctly.

◆ addQueryFlags()

void Ogre::MovableObject::addQueryFlags ( uint32 flags )

inlineinherited

As setQueryFlags, except the flags passed as parameters are appended to the existing flags on this object.

◆ addVisibilityFlags()

void Ogre::MovableObject::addVisibilityFlags ( uint32 flags )

inlineinherited

As setVisibilityFlags, except the flags passed as parameters are appended to the existing flags on this object.

◆ buildLightList()

static void Ogre::MovableObject::buildLightList	(	const size_t	numNodes,
		ObjectData	t,
		const LightListInfo &	globalLightList
	)

staticinherited

@See SceneManager::buildLightList

Remarks: We don't pass by reference on purpose (avoid implicit aliasing)

Parameters

globalLightList List of lights already culled against all possible frustums and reorganized contiguously for SoA

◆ calculateCastersBox()

static void Ogre::MovableObject::calculateCastersBox	(	const size_t	numNodes,
		ObjectData	t,
		uint32	sceneVisibilityFlags,
		AxisAlignedBox *	outBox
	)

staticinherited

◆ clear()

void Ogre::v1::Overlay::clear ( )

Clears the overlay of all attached items.

◆ createAnimableValue()

virtual AnimableValuePtr Ogre::AnimableObject::createAnimableValue ( const String & valueName )

inlinevirtualinherited

Create a reference-counted AnimableValuePtr for the named value.

Remarks: You can use the returned object to animate a value on this object, using AnimationTrack. Subclasses must override this if they wish to support animation of their values.

Reimplemented in Ogre::Light.

References Ogre::Exception::ERR_ITEM_NOT_FOUND, and OGRE_EXCEPT.

◆ cullFrustum()

static void Ogre::MovableObject::cullFrustum	(	const size_t	numNodes,
		ObjectData	t,
		const Camera *	frustum,
		uint32	sceneVisibilityFlags,
		MovableObjectArray &	outCulledObjects,
		const Camera *	lodCamera
	)

staticinherited

◆ cullLights()

static void Ogre::MovableObject::cullLights	(	const size_t	numNodes,
		ObjectData	t,
		LightListInfo &	outGlobalLightList,
		const FrustumVec &	frustums,
		const FrustumVec &	cubemapFrustums
	)

staticinherited

@See SceneManager::cullLights &

See also: MovableObject::cullFrustum Produces the global list of visible lights that is needed in buildLightList

Remarks: We don't pass ObjectData by reference on purpose (avoid implicit aliasing) It's declared here because all affected elements are from MovableObject IMPORTANT: It is assumed that all objects in ObjectData are Lights.

Parameters

outGlobalLightList	Output, a list of lights, contiguously placed
frustums	An array of all frustums we need to check against
cubemapFrustums	An array of all frustums that are used at least once as cubemaps (@See SceneManager::createCamera)

◆ detachFromParent()

void Ogre::MovableObject::detachFromParent ( void )

inherited

Detaches an object from a parent SceneNode if attached.

◆ findElementAt()

virtual OverlayElement * Ogre::v1::Overlay::findElementAt	(	Real	x,
		Real	y
	)

virtual

This returns a OverlayElement at position x,y.

◆ get2DElementsIterator()

Overlay2DElementsIterator Ogre::v1::Overlay::get2DElementsIterator ( )

inline

◆ getAnimableValueNames()

const StringVector & Ogre::AnimableObject::getAnimableValueNames ( void ) const

inlineinherited

Gets a list of animable value names for this object.

References Ogre::Exception::ERR_ITEM_NOT_FOUND, and OGRE_EXCEPT.

◆ getCachedDistanceToCamera()

RealAsUint Ogre::MovableObject::getCachedDistanceToCamera ( void ) const

inlineinherited

Returns the distance to camera as calculated in @cullFrustum.

◆ getCachedDistanceToCameraAsReal()

Real Ogre::MovableObject::getCachedDistanceToCameraAsReal ( void ) const

inlineinherited

Returns the distance to camera as calculated in @cullFrustum.

◆ getCastShadows()

bool Ogre::MovableObject::getCastShadows ( void ) const

inlineinherited

Returns whether shadow casting is enabled for this object.

◆ getChild()

OverlayContainer * Ogre::v1::Overlay::getChild ( const String & name )

◆ getCurrentMeshLod()

unsigned char Ogre::MovableObject::getCurrentMeshLod ( void ) const

inlineinherited

◆ getDefaultQueryFlags()

static uint32 Ogre::MovableObject::getDefaultQueryFlags ( )

inlinestaticinherited

Get the default query flags for all future MovableObject instances.

◆ getDefaultVisibilityFlags()

static uint32 Ogre::MovableObject::getDefaultVisibilityFlags ( )

inlinestaticinherited

Get the default visibility flags for all future MovableObject instances.

◆ getId()

IdType Ogre::IdObject::getId ( ) const

inlineinherited

Get the unique id of this object.

◆ getLightMask()

uint32 Ogre::MovableObject::getLightMask ( ) const

inlineinherited

Get a bitwise mask which will filter the lights affecting this object.

Remarks: By default, this mask is fully set meaning all lights will affect this object

◆ getListener()

Listener * Ogre::MovableObject::getListener ( void ) const

inlineinherited

Gets the current listener for this object.

◆ getLocalAabb()

Aabb Ogre::MovableObject::getLocalAabb ( void ) const

inherited

Retrieves the local axis-aligned bounding box for this object.

Remarks: This bounding box is in local coordinates.

◆ getLocalRadius()

float Ogre::MovableObject::getLocalRadius ( void ) const

inherited

See getLocalAabb and getWorldRadius.

◆ getMovableType()

virtual const String & Ogre::v1::Overlay::getMovableType ( void ) const

virtual

Returns the type name of this object.

Implements Ogre::MovableObject.

◆ getName()

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

inlineinherited

Returns the name of this object.

◆ getOrigin()

const String & Ogre::v1::Overlay::getOrigin ( void ) const

inline

Get the origin of this overlay, e.g.

a script file name.

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

◆ getParentNode()

Node * Ogre::MovableObject::getParentNode ( void ) const

inlineinherited

Returns the node to which this object is attached.

◆ getParentSceneNode()

SceneNode * Ogre::MovableObject::getParentSceneNode ( void ) const

inlineinherited

◆ getQueryFlags()

uint32 Ogre::MovableObject::getQueryFlags ( void ) const

inlineinherited

Returns the query flags relevant for this object.

◆ getRenderingDistance()

Real Ogre::MovableObject::getRenderingDistance ( void ) const

inlineinherited

Gets the distance at which batches are no longer rendered.

◆ getRenderingMinPixelSize()

Real Ogre::MovableObject::getRenderingMinPixelSize ( ) const

inlineinherited

Returns the minimum pixel size an object needs to be in both screen axes in order to be rendered.

◆ getRenderQueueGroup()

uint8 Ogre::MovableObject::getRenderQueueGroup ( void ) const

inlineinherited

Gets the queue group for this entity, see setRenderQueueGroup for full details.

◆ getRotate()

const Radian & Ogre::v1::Overlay::getRotate ( void ) const

inline

Gets the rotation applied to this overlay, in degrees.

◆ getScaleX()

Real Ogre::v1::Overlay::getScaleX ( void ) const

Gets the current X scale value.

◆ getScaleY()

Real Ogre::v1::Overlay::getScaleY ( void ) const

Gets the current Y scale value.

◆ getScrollX()

Real Ogre::v1::Overlay::getScrollX ( void ) const

Gets the current X scroll value.

◆ getScrollY()

Real Ogre::v1::Overlay::getScrollY ( void ) const

Gets the current Y scroll value.

◆ getShadowRenderingDistance()

Real Ogre::MovableObject::getShadowRenderingDistance ( void ) const

inlineinherited

Gets the distance at which batches are no longer casting shadows.

◆ getSkeletonInstance()

SkeletonInstance * Ogre::MovableObject::getSkeletonInstance ( void ) const

inlineinherited

◆ getUserObjectBindings() [1/2]

UserObjectBindings & Ogre::MovableObject::getUserObjectBindings ( )

inlineinherited

Return an instance of user objects binding associated with this class.

You can use it to associate one or more custom objects with this class instance.

See also: UserObjectBindings::setUserAny.

◆ getUserObjectBindings() [2/2]

const UserObjectBindings & Ogre::MovableObject::getUserObjectBindings ( ) const

inlineinherited

Return an instance of user objects binding associated with this class.

You can use it to associate one or more custom objects with this class instance.

See also: UserObjectBindings::setUserAny.

◆ getVisibilityFlags()

uint32 Ogre::MovableObject::getVisibilityFlags ( void ) const

inlineinherited

Returns the visibility flags relevant for this object.

Reserved visibility flags are not returned.

◆ getVisible()

bool Ogre::MovableObject::getVisible ( void ) const

inlineinherited

Gets this object whether to be visible or not, if it has a renderable component.

Remarks: Returns the value set by MovableObject::setVisible only.

◆ getWorldAabb()

Aabb Ogre::MovableObject::getWorldAabb ( ) const

inherited

Gets the axis aligned box in world space.

Remarks: Assumes the caches are already updated. Will trigger an assert otherwise. @See getWorldAabbUpdated if you need the update process to be guaranteed

◆ getWorldAabbUpdated()

Aabb Ogre::MovableObject::getWorldAabbUpdated ( )

inherited

Gets the axis aligned box in world space.

Remarks: Unlike getWorldAabb, this function guarantees the cache stays up to date. It is STRONGLY advised against calling this function for a large number of MovableObject. Refactor your queries so that they happen after SceneManager::updateAllBounds() has been called

◆ getWorldRadius()

float Ogre::MovableObject::getWorldRadius ( ) const

inherited

Gets the bounding Radius scaled by max( scale.x, scale.y, scale.z ).

Remarks: Assumes the caches are already updated. Will trigger an assert otherwise. @See getWorldRadiusUpdated if you need the update process to be guaranteed

◆ getWorldRadiusUpdated()

float Ogre::MovableObject::getWorldRadiusUpdated ( )

inherited

Gets the bounding Radius scaled by max( scale.x, scale.y, scale.z ).

Remarks: Unlike getWorldRadius, this function guarantees the cache stays up to date. It is STRONGLY advised against calling this function for a large number of MovableObject. Refactor your queries so that they happen after SceneManager::updateAllBounds() has been called

◆ getZOrder()

uint16 Ogre::v1::Overlay::getZOrder ( void ) const

Gets the Z-order of this overlay.

◆ hide()

void Ogre::v1::Overlay::hide ( void )

Hides the overlay if it was visible.

◆ instanceBatchCullFrustumThreaded()

virtual void Ogre::MovableObject::instanceBatchCullFrustumThreaded	(	const Frustum *	frustum,
		const Camera *	lodCamera,
		uint32	combinedVisibilityFlags
	)

inlinevirtualinherited

@See InstancingTheadedCullingMethod,

See also: InstanceBatch::instanceBatchCullFrustumThreaded

◆ isAttached()

bool Ogre::MovableObject::isAttached ( void ) const

inlineinherited

Returns true if this object is attached to a Node.

◆ isInitialised()

bool Ogre::v1::Overlay::isInitialised ( void ) const

inline

Gets whether the overlay is initialised or not.

◆ isStatic()

bool Ogre::MovableObject::isStatic ( ) const

inherited

Checks whether this MovableObject is static. @See setStatic.

◆ isVisible()

bool Ogre::MovableObject::isVisible ( void ) const

inherited

Returns whether or not this object is supposed to be visible or not.

Remarks: Takes into account visibility flags and the setVisible, but not rendering distance.

◆ operator delete() [1/3]

template<class Alloc >

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

inlineinherited

◆ operator delete() [2/3]

template<class Alloc >

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

inlineinherited

◆ operator delete() [3/3]

template<class Alloc >

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

inlineinherited

◆ operator delete[]() [1/2]

template<class Alloc >

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

inlineinherited

◆ operator delete[]() [2/2]

template<class Alloc >

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

inlineinherited

◆ operator new() [1/3]

template<class Alloc >

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

inlineinherited

◆ operator new() [2/3]

template<class Alloc >

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

inlineinherited

operator new, with debug line info

◆ operator new() [3/3]

template<class Alloc >

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

inlineinherited

placement operator new

◆ operator new[]() [1/2]

template<class Alloc >

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

inlineinherited

◆ operator new[]() [2/2]

template<class Alloc >

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

inlineinherited

array operator new, with debug line info

◆ operator()() [1/2]

bool Ogre::IdObject::operator()	(	const IdObject &	left,
		const IdObject &	right
	)

inlineinherited

◆ operator()() [2/2]

bool Ogre::IdObject::operator()	(	const IdObject *	left,
		const IdObject *	right
	)

inlineinherited

◆ queryLights()

const LightList & Ogre::MovableObject::queryLights ( void ) const

inlineinherited

Gets a list of lights, ordered relative to how close they are to this movable object.

Remarks: The lights are filled in

See also: buildLightList

Returns: The list of lights use to lighting this object.

◆ remove2D()

void Ogre::v1::Overlay::remove2D ( OverlayContainer * cont )

Removes a 2D container from the overlay.

Remarks: NOT FAST. Consider OverlayElement::hide.

◆ remove3D()

void Ogre::v1::Overlay::remove3D ( SceneNode * node )

Removes a 3D element from the overlay.

◆ removeQueryFlags()

void Ogre::MovableObject::removeQueryFlags ( uint32 flags )

inlineinherited

As setQueryFlags, except the flags passed as parameters are removed from the existing flags on this object.

◆ removeVisibilityFlags()

void Ogre::MovableObject::removeVisibilityFlags ( uint32 flags )

inlineinherited

As setVisibilityFlags, except the flags passed as parameters are removed from the existing flags on this object.

◆ rotate()

void Ogre::v1::Overlay::rotate ( const Radian & angle )

Adds the passed in angle to the rotation applied to this overlay.

◆ scroll()

void Ogre::v1::Overlay::scroll	(	Real	xoff,
		Real	yoff
	)

Scrolls the overlay by the offsets provided.

Remarks: This method moves the overlay by the amounts provided. As with other methods on this object, a full screen width / height is represented by the value 1.0.

◆ setCastShadows()

void Ogre::MovableObject::setCastShadows ( bool enabled )

inlineinherited

Sets whether or not this object will cast shadows.

Remarks: This setting simply allows you to turn on/off shadows for a given object. An object will not cast shadows unless the scene supports it in any case (see SceneManager::setShadowTechnique), and also the material which is in use must also have shadow casting enabled. By default all entities cast shadows. If, however, for some reason you wish to disable this for a single object then you can do so using this method.

Note: This method normally refers to objects which block the light, but since Light is also a subclass of MovableObject, in that context it means whether the light causes shadows itself.

◆ setDefaultQueryFlags()

static void Ogre::MovableObject::setDefaultQueryFlags ( uint32 flags )

inlinestaticinherited

Set the default query flags for all future MovableObject instances.

◆ setDefaultVisibilityFlags()

static void Ogre::MovableObject::setDefaultVisibilityFlags ( uint32 flags )

inlinestaticinherited

Set the default visibility flags for all future MovableObject instances.

◆ setLightMask()

void Ogre::MovableObject::setLightMask ( uint32 lightMask )

inlineinherited

Set a bitwise mask which will filter the lights affecting this object.

Remarks: This mask will be compared against the mask held against Light to determine if a light should affect a given object. By default, this mask is fully set meaning all lights will affect this object

◆ setListener()

void Ogre::MovableObject::setListener ( Listener * listener )

inlineinherited

Sets a listener for this object.

Remarks: Note for size and performance reasons only one listener per object is allowed.

◆ setLocalAabb()

void Ogre::MovableObject::setLocalAabb ( const Aabb box )

inherited

Sets the local axis-aligned bounding box for this object.

Remarks: This bounding box is in local coordinates.

◆ setName()

void Ogre::MovableObject::setName ( const String & name )

inlineinherited

Sets a custom name for this node.

Doesn't have to be unique

◆ setQueryFlags()

void Ogre::MovableObject::setQueryFlags ( uint32 flags )

inlineinherited

Sets the query flags for this object.

Remarks: When performing a scene query, this object will be included or excluded according to flags on the object and flags on the query. This is a bitwise value, so only when a bit on these flags is set, will it be included in a query asking for that flag. The meaning of the bits is application-specific.

◆ setRenderingDistance()

void Ogre::MovableObject::setRenderingDistance ( Real dist )

inlineinherited

Sets the distance at which the object is no longer rendered.

Parameters

dist	Distance beyond which the object will not be rendered (the default is FLT_MAX, which means objects are always rendered). Values equal or below zero will be ignored, and cause an assertion in debug mode.

◆ setRenderingMinPixelSize()

void Ogre::MovableObject::setRenderingMinPixelSize ( Real pixelSize )

inlineinherited

Sets the minimum pixel size an object needs to be in both screen axes in order to be rendered.

Note: Camera::setUseMinPixelSize() needs to be called for this parameter to be used.

Parameters

pixelSize Number of minimum pixels (the default is 0, which means objects are always rendered).

◆ setRenderQueueGroup()

virtual void Ogre::MovableObject::setRenderQueueGroup ( uint8 queueID )

virtualinherited

Sets the render queue group this entity will be rendered through.

Remarks: Render queues are grouped to allow you to more tightly control the ordering of rendered objects. If you do not call this method, all Entity objects default to the default queue (RenderQueue::getDefaultQueueGroup), which is fine for most objects. You may want to alter this if you want this entity to always appear in front of other objects, e.g. for a 3D menu system or such.

: See RenderQueue for more details.

Parameters

queueID Enumerated value of the queue group to use. See the enum RenderQueueGroupID for what kind of values can be used here.

: Valid render queue ids are between 0 & 254 inclusive

Reimplemented in Ogre::Decal, Ogre::v1::Entity, Ogre::Light, and Ogre::ParticleSystem.

◆ setRotate()

void Ogre::v1::Overlay::setRotate ( const Radian & angle )

Sets the rotation applied to this overlay.

◆ setScale()

void Ogre::v1::Overlay::setScale	(	Real	x,
		Real	y
	)

Sets the scaling factor of this overlay.

Remarks: You can use this to set an scale factor to be used to zoom an overlay.

Parameters

x	Horizontal scale value, where 1.0 = normal, 0.5 = half size etc
y	Vertical scale value, where 1.0 = normal, 0.5 = half size etc

◆ setScroll()

void Ogre::v1::Overlay::setScroll	(	Real	x,
		Real	y
	)

Sets the scrolling factor of this overlay.

Remarks: You can use this to set an offset to be used to scroll an overlay around the screen.

Parameters

x	Horizontal scroll value, where 0 = normal, -0.5 = scroll so that only the right half the screen is visible etc
y	Vertical scroll value, where 0 = normal, 0.5 = scroll down by half a screen etc.

◆ setShadowRenderingDistance()

void Ogre::MovableObject::setShadowRenderingDistance ( Real dist )

inlineinherited

Sets the distance at which the object is no longer casting shadows.

Parameters

dist	Distance beyond which the object will not cast shadows (the default is FLT_MAX, which means objects are always casting shadows). Values equal or below zero will be ignored, and cause an assertion in debug mode.

Note: ShadowRenderingDistance will be clamped to RenderingDistance value

See also: setRenderingDistance

◆ setStatic()

bool Ogre::MovableObject::setStatic ( bool bStatic )

inherited

Turns this Node into static or dynamic.

Remarks: Switching between dynamic and static has some overhead and forces to update all static scene when converted to static. So don't do it frequently. Static objects are not updated every frame, only when requested explicitly. Use this feature if you plan to have this object unaltered for a very long times

: Note all MovableObjects support switching between static & dynamic after they have been created (eg. InstancedEntity)

: Changing this attribute will cause to switch the attribute to our parent node, and as a result, all of its other attached entities. @See Node::setStatic

Returns: True if setStatic made an actual change. False otherwise. Can fail because the object was already static/dynamic, or because switching is not supported

◆ setVisibilityFlags()

void Ogre::MovableObject::setVisibilityFlags ( uint32 flags )

inlineinherited

Sets the visibility flags for this object.

Remarks: As well as a simple true/false value for visibility (as seen in setVisible), you can also set visibility flags that is applied a binary 'and' with the SceneManager's mask and a compositor node pass. To exclude particular objects from rendering. Changes to reserved visibility flags are ignored (won't take effect).

◆ setVisible()

void Ogre::MovableObject::setVisible ( bool visible )

inlineinherited

Tells this object whether to be visible or not, if it has a renderable component.

Note: An alternative approach of making an object invisible is to detach it from it's SceneNode, or to remove the SceneNode entirely. Detaching a node means that structurally the scene graph changes. Once this change has taken place, the objects / nodes that have been removed have less overhead to the visibility detection pass than simply making the object invisible, so if you do this and leave the objects out of the tree for a long time, it's faster. However, the act of detaching / reattaching nodes is in itself more expensive than setting an object visibility flag, since in the latter case structural changes are not made. Therefore, small or frequent visibility changes are best done using this method; large or more longer term changes are best done by detaching.

◆ setZOrder()

void Ogre::v1::Overlay::setZOrder ( uint16 zorder )

Alters the Z-order of this overlay.

Remarks: Values between 0 and 2^DepthBits - 1 are valid here. DepthBits is defined in RenderQueue.cpp

◆ show()

void Ogre::v1::Overlay::show ( void )

Shows the overlay if it was hidden.

◆ updateAllBounds()

static void Ogre::MovableObject::updateAllBounds	(	const size_t	numNodes,
		ObjectData	t
	)

staticinherited

@See SceneManager::updateAllBounds

Remarks: We don't pass by reference on purpose (avoid implicit aliasing)

Member Data Documentation

◆ c_DefaultLodMesh

const FastArray<Real> Ogre::MovableObject::c_DefaultLodMesh

staticinherited

◆ mGlobalIndex

size_t Ogre::MovableObject::mGlobalIndex

inherited

Index in the vector holding this MO reference (could be our parent node, or a global array tracking all movable objecst to avoid memory leaks).

Used for O(1) removals.

Remarks: It is the parent (or our creator) the one that sets this value, not ourselves. Do NOT modify it manually.

◆ mParentIndex

size_t Ogre::MovableObject::mParentIndex

inherited

Index in the vector holding this MO reference (could be our parent node, or a global array tracking all movable objecst to avoid memory leaks).

Used for O(1) removals.

Remarks: It is the parent (or our creator) the one that sets this value, not ourselves. Do NOT modify it manually.

◆ mRenderables

RenderableArray Ogre::MovableObject::mRenderables

inherited

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

OgreOverlay.h

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Member Typedef Documentation

◆ MovableObjectArray

◆ Overlay2DElementsIterator

◆ OverlayContainerList

Constructor & Destructor Documentation

◆ Overlay()

◆ ~Overlay()

Member Function Documentation

◆ _getLightList()

◆ _getManager()

◆ _getObjectData()

◆ _getParentNodeFullTransform()

◆ _getWorldTransforms()

◆ _notifyAttached()

◆ _notifyManager()

◆ _notifyOrigin()

◆ _notifyParentNodeMemoryChanged()

◆ _notifyStaticDirty()

◆ _releaseManualHardwareResources()

◆ _restoreManualHardwareResources()

◆ _updateRenderQueue() [1/2]

◆ _updateRenderQueue() [2/2]

◆ add2D()

◆ add3D()

◆ addQueryFlags()

◆ addVisibilityFlags()

◆ buildLightList()

◆ calculateCastersBox()

◆ clear()

◆ createAnimableValue()

◆ cullFrustum()

◆ cullLights()

◆ detachFromParent()

◆ findElementAt()

◆ get2DElementsIterator()

◆ getAnimableValueNames()

◆ getCachedDistanceToCamera()

◆ getCachedDistanceToCameraAsReal()

◆ getCastShadows()

◆ getChild()

◆ getCurrentMeshLod()

◆ getDefaultQueryFlags()

◆ getDefaultVisibilityFlags()

◆ getId()

◆ getLightMask()

◆ getListener()

◆ getLocalAabb()

◆ getLocalRadius()

◆ getMovableType()

◆ getName()

◆ getOrigin()

◆ getParentNode()

◆ getParentSceneNode()

◆ getQueryFlags()

◆ getRenderingDistance()

◆ getRenderingMinPixelSize()

◆ getRenderQueueGroup()

◆ getRotate()

◆ getScaleX()

◆ getScaleY()

◆ getScrollX()

◆ getScrollY()

◆ getShadowRenderingDistance()

◆ getSkeletonInstance()

◆ getUserObjectBindings() [1/2]

◆ getUserObjectBindings() [2/2]

◆ getVisibilityFlags()

◆ getVisible()

◆ getWorldAabb()

◆ getWorldAabbUpdated()

◆ getWorldRadius()

◆ getWorldRadiusUpdated()

◆ getZOrder()

◆ hide()