Represents a layer which is rendered on top of the 'normal' scene contents. More...
#include <OgreOverlay.h>
Public Types | |
typedef VectorIterator < OverlayContainerList > | Overlay2DElementsIterator |
Returns an iterator over all 2D elements in this manager. More... | |
typedef list< OverlayContainer * > ::type | OverlayContainerList |
Public Member Functions | |
Overlay (const String &name) | |
Constructor: do not call direct, use OverlayManager::create. More... | |
virtual | ~Overlay () |
void | _findVisibleObjects (Camera *cam, RenderQueue *queue) |
Internal method to put the overlay contents onto the render queue. More... | |
void | _getWorldTransforms (Matrix4 *xform) const |
Used to transform the overlay when scrolling, scaling etc. More... | |
void | _notifyOrigin (const String &origin) |
Notify this overlay of it's origin. More... | |
void | add2D (OverlayContainer *cont) |
Adds a 2D 'container' to the overlay. More... | |
void | add3D (SceneNode *node) |
Adds a node capable of holding 3D objects to the overlay. More... | |
void | clear () |
Clears the overlay of all attached items. More... | |
virtual OverlayElement * | findElementAt (Real x, Real y) |
This returns a OverlayElement at position x,y. More... | |
Overlay2DElementsIterator | get2DElementsIterator () |
OverlayContainer * | getChild (const String &name) |
const String & | getName (void) const |
Gets the name of this overlay. More... | |
const String & | getOrigin (void) const |
Get the origin of this overlay, e.g. More... | |
const Radian & | getRotate (void) const |
Gets the rotation applied to this overlay, in degrees. More... | |
Real | getScaleX (void) const |
Gets the current X scale value. More... | |
Real | getScaleY (void) const |
Gets the current Y scale value. More... | |
Real | getScrollX (void) const |
Gets the current X scroll value. More... | |
Real | getScrollY (void) const |
Gets the current Y scroll value. More... | |
ushort | getZOrder (void) const |
Gets the Z-order of this overlay. More... | |
void | hide (void) |
Hides the overlay if it was visible. More... | |
bool | isInitialised (void) const |
Gets whether the overlay is initialised or not. More... | |
bool | isVisible (void) const |
Gets whether the overlay is displayed or not. More... | |
void | operator delete (void *ptr) |
void | operator delete (void *ptr, void *) |
void | operator delete (void *ptr, const char *, int, const char *) |
void | operator delete[] (void *ptr) |
void | operator delete[] (void *ptr, const char *, int, const char *) |
void * | operator new (size_t sz, const char *file, int line, const char *func) |
operator new, with debug line info More... | |
void * | operator new (size_t sz) |
void * | operator new (size_t sz, void *ptr) |
placement operator new More... | |
void * | operator new[] (size_t sz, const char *file, int line, const char *func) |
array operator new, with debug line info More... | |
void * | operator new[] (size_t sz) |
void | remove2D (OverlayContainer *cont) |
Removes a 2D container from the overlay. More... | |
void | remove3D (SceneNode *node) |
Removes a 3D element from the overlay. More... | |
void | rotate (const Radian &angle) |
Adds the passed in angle to the rotation applied to this overlay. More... | |
void | scroll (Real xoff, Real yoff) |
Scrolls the overlay by the offsets provided. More... | |
void | setRotate (const Radian &angle) |
Sets the rotation applied to this overlay. More... | |
void | setScale (Real x, Real y) |
Sets the scaling factor of this overlay. More... | |
void | setScroll (Real x, Real y) |
Sets the scrolling factor of this overlay. More... | |
void | setZOrder (ushort zorder) |
Alters the Z-order of this overlay. More... | |
void | show (void) |
Shows the overlay if it was hidden. More... | |
Protected Member Functions | |
void | assignZOrders (void) |
Internal method for updating container elements' Z-ordering. More... | |
void | initialise (void) |
Internal method for initialising an overlay. More... | |
void | updateTransform (void) const |
Internal lazy update method. More... | |
Protected Attributes | |
OverlayContainerList | m2DElements |
2D elements OverlayContainers, linked list for easy sorting by zorder later Not a map because sort can be saved since changes infrequent (unlike render queue) More... | |
bool | mInitialised |
String | mName |
String | mOrigin |
SceneNode * | mRootNode |
Internal root node, used as parent for 3D objects. More... | |
Radian | mRotate |
Degrees of rotation around center. More... | |
Real | mScaleX |
Scale values. More... | |
Real | mScaleY |
Real | mScrollX |
Scroll values, offsets. More... | |
Real | mScrollY |
Matrix4 | mTransform |
bool | mTransformOutOfDate |
bool | mTransformUpdated |
bool | mVisible |
ulong | mZOrder |
Represents a layer which is rendered on top of the 'normal' scene contents.
Definition at line 70 of file OgreOverlay.h.
Returns an iterator over all 2D elements in this manager.
Definition at line 257 of file OgreOverlay.h.
typedef list<OverlayContainer*>::type Ogre::Overlay::OverlayContainerList |
Definition at line 74 of file OgreOverlay.h.
Ogre::Overlay::Overlay | ( | const String & | name | ) |
Constructor: do not call direct, use OverlayManager::create.
|
virtual |
void Ogre::Overlay::_findVisibleObjects | ( | Camera * | cam, |
RenderQueue * | queue | ||
) |
Internal method to put the overlay contents onto the render queue.
void Ogre::Overlay::_getWorldTransforms | ( | Matrix4 * | xform | ) | const |
Used to transform the overlay when scrolling, scaling etc.
|
inline |
Notify this overlay of it's origin.
Definition at line 270 of file OgreOverlay.h.
void Ogre::Overlay::add2D | ( | OverlayContainer * | cont | ) |
Adds a 2D 'container' to the overlay.
cont | Pointer to a container to add, created using OverlayManager. |
void Ogre::Overlay::add3D | ( | SceneNode * | node | ) |
Adds a node capable of holding 3D objects to the overlay.
|
protected |
Internal method for updating container elements' Z-ordering.
void Ogre::Overlay::clear | ( | ) |
Clears the overlay of all attached items.
|
virtual |
This returns a OverlayElement at position x,y.
|
inline |
Definition at line 258 of file OgreOverlay.h.
OverlayContainer* Ogre::Overlay::getChild | ( | const String & | name | ) |
const String& Ogre::Overlay::getName | ( | void | ) | const |
Gets the name of this overlay.
|
inline |
Get the origin of this overlay, e.g.
a script file name.
Definition at line 268 of file OgreOverlay.h.
|
inline |
Gets the rotation applied to this overlay, in degrees.
Definition at line 224 of file OgreOverlay.h.
Real Ogre::Overlay::getScaleX | ( | void | ) | const |
Gets the current X scale value.
Real Ogre::Overlay::getScaleY | ( | void | ) | const |
Gets the current Y scale value.
Real Ogre::Overlay::getScrollX | ( | void | ) | const |
Gets the current X scroll value.
Real Ogre::Overlay::getScrollY | ( | void | ) | const |
Gets the current Y scroll value.
ushort Ogre::Overlay::getZOrder | ( | void | ) | const |
Gets the Z-order of this overlay.
void Ogre::Overlay::hide | ( | void | ) |
Hides the overlay if it was visible.
|
protected |
Internal method for initialising an overlay.
|
inline |
Gets whether the overlay is initialised or not.
Definition at line 128 of file OgreOverlay.h.
bool Ogre::Overlay::isVisible | ( | void | ) | const |
Gets whether the overlay is displayed or not.
|
inlineinherited |
Definition at line 96 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 102 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 108 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 113 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 119 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
operator new, with debug line info
Definition at line 68 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 73 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
placement operator new
Definition at line 79 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
array operator new, with debug line info
Definition at line 86 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 91 of file OgreMemoryAllocatedObject.h.
void Ogre::Overlay::remove2D | ( | OverlayContainer * | cont | ) |
Removes a 2D container from the overlay.
void Ogre::Overlay::remove3D | ( | SceneNode * | node | ) |
Removes a 3D element from the overlay.
void Ogre::Overlay::rotate | ( | const Radian & | angle | ) |
Adds the passed in angle to the rotation applied to this overlay.
Scrolls the overlay by the offsets provided.
void Ogre::Overlay::setRotate | ( | const Radian & | angle | ) |
Sets the rotation applied to this overlay.
Sets the scaling factor of this overlay.
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 |
Sets the scrolling factor of this overlay.
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. |
void Ogre::Overlay::setZOrder | ( | ushort | zorder | ) |
Alters the Z-order of this overlay.
void Ogre::Overlay::show | ( | void | ) |
Shows the overlay if it was hidden.
|
protected |
Internal lazy update method.
|
protected |
2D elements OverlayContainers, linked list for easy sorting by zorder later Not a map because sort can be saved since changes infrequent (unlike render queue)
Definition at line 82 of file OgreOverlay.h.
|
protected |
Definition at line 96 of file OgreOverlay.h.
|
protected |
Definition at line 76 of file OgreOverlay.h.
|
protected |
Definition at line 97 of file OgreOverlay.h.
|
protected |
Internal root node, used as parent for 3D objects.
Definition at line 78 of file OgreOverlay.h.
|
protected |
Degrees of rotation around center.
Definition at line 85 of file OgreOverlay.h.
|
protected |
Scale values.
Definition at line 89 of file OgreOverlay.h.
|
protected |
Definition at line 89 of file OgreOverlay.h.
|
protected |
Scroll values, offsets.
Definition at line 87 of file OgreOverlay.h.
|
protected |
Definition at line 87 of file OgreOverlay.h.
|
mutableprotected |
Definition at line 91 of file OgreOverlay.h.
|
mutableprotected |
Definition at line 92 of file OgreOverlay.h.
|
protected |
Definition at line 93 of file OgreOverlay.h.
|
protected |
Definition at line 95 of file OgreOverlay.h.
|
protected |
Definition at line 94 of file OgreOverlay.h.