#include <OgreOverlay.h>
Public Types | |
typedef std::list < OverlayContainer * > | OverlayContainerList |
typedef VectorIterator < OverlayContainerList > | Overlay2DElementsIterator |
Returns an iterator over all 2D elements in this manager. | |
Public Member Functions | |
Overlay (const String &name) | |
Constructor: do not call direct, use OverlayManager::create. | |
virtual | ~Overlay () |
OverlayContainer * | getChild (const String &name) |
const String & | getName (void) const |
Gets the name of this overlay. | |
void | setZOrder (ushort zorder) |
Alters the ZOrder of this overlay. | |
ushort | getZOrder (void) const |
Gets the ZOrder of this overlay. | |
bool | isVisible (void) const |
Gets whether the overlay is displayed or not. | |
bool | isInitialised (void) const |
Gets whether the overlay is initialised or not. | |
void | show (void) |
Shows the overlay if it was hidden. | |
void | hide (void) |
Hides the overlay if it was visible. | |
void | add2D (OverlayContainer *cont) |
Adds a 2D 'container' to the overlay. | |
void | remove2D (OverlayContainer *cont) |
Removes a 2D container from the overlay. | |
void | add3D (SceneNode *node) |
Adds a node capable of holding 3D objects to the overlay. | |
void | remove3D (SceneNode *node) |
Removes a 3D element from the overlay. | |
void | clear () |
Clears the overlay of all attached items. | |
void | setScroll (Real x, Real y) |
Sets the scrolling factor of this overlay. | |
Real | getScrollX (void) const |
Gets the current X scroll value. | |
Real | getScrollY (void) const |
Gets the current Y scroll value. | |
void | scroll (Real xoff, Real yoff) |
Scrolls the overlay by the offsets provided. | |
void | setRotate (const Radian &angle) |
Sets the rotation applied to this overlay. | |
const Radian & | getRotate (void) const |
Gets the rotation applied to this overlay, in degrees. | |
void | rotate (const Radian &angle) |
Adds the passed in angle to the rotation applied to this overlay. | |
void | setScale (Real x, Real y) |
Sets the scaling factor of this overlay. | |
Real | getScaleX (void) const |
Gets the current X scale value. | |
Real | getScaleY (void) const |
Gets the current Y scale value. | |
void | _getWorldTransforms (Matrix4 *xform) const |
Used to transform the overlay when scrolling, scaling etc. | |
void | _findVisibleObjects (Camera *cam, RenderQueue *queue) |
Internal method to put the overlay contents onto the render queue. | |
virtual OverlayElement * | findElementAt (Real x, Real y) |
This returns a OverlayElement at position x,y. | |
Overlay2DElementsIterator | get2DElementsIterator () |
const String & | getOrigin (void) const |
Get the origin of this overlay, e.g. | |
void | _notifyOrigin (const String &origin) |
Notify this overlay of it's origin. | |
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 * | operator new (size_t sz, void *ptr) |
placement operator new | |
void * | operator new[] (size_t sz, const char *file, int line, const char *func) |
array operator new, with debug line info | |
void * | operator new[] (size_t sz) |
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 *) |
Protected Member Functions | |
void | updateTransform (void) const |
Internal lazy update method. | |
void | initialise (void) |
Internal method for initialising an overlay. | |
void | assignZOrders (void) |
Internal method for updating container elements' Z-ordering. | |
Protected Attributes | |
String | mName |
SceneNode * | mRootNode |
Internal root node, used as parent for 3D objects. | |
OverlayContainerList | m2DElements |
Radian | mRotate |
Real | mScrollX |
Real | mScrollY |
Real | mScaleX |
Real | mScaleY |
Matrix4 | mTransform |
bool | mTransformOutOfDate |
bool | mTransformUpdated |
ulong | mZOrder |
bool | mVisible |
bool | mInitialised |
String | mOrigin |
Definition at line 65 of file OgreOverlay.h.
typedef std::list<OverlayContainer*> Ogre::Overlay::OverlayContainerList |
Definition at line 69 of file OgreOverlay.h.
Returns an iterator over all 2D elements in this manager.
Definition at line 251 of file OgreOverlay.h.
Ogre::Overlay::Overlay | ( | const String & | name | ) |
Constructor: do not call direct, use OverlayManager::create.
virtual Ogre::Overlay::~Overlay | ( | ) | [virtual] |
void Ogre::Overlay::updateTransform | ( | void | ) | const [protected] |
Internal lazy update method.
void Ogre::Overlay::initialise | ( | void | ) | [protected] |
Internal method for initialising an overlay.
void Ogre::Overlay::assignZOrders | ( | void | ) | [protected] |
Internal method for updating container elements' Z-ordering.
OverlayContainer* Ogre::Overlay::getChild | ( | const String & | name | ) |
const String& Ogre::Overlay::getName | ( | void | ) | const |
Gets the name of this overlay.
void Ogre::Overlay::setZOrder | ( | ushort | zorder | ) |
Alters the ZOrder of this overlay.
ushort Ogre::Overlay::getZOrder | ( | void | ) | const |
Gets the ZOrder of this overlay.
bool Ogre::Overlay::isVisible | ( | void | ) | const |
Gets whether the overlay is displayed or not.
bool Ogre::Overlay::isInitialised | ( | void | ) | const |
void Ogre::Overlay::show | ( | void | ) |
Shows the overlay if it was hidden.
void Ogre::Overlay::hide | ( | void | ) |
Hides the overlay if it was visible.
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::remove2D | ( | OverlayContainer * | cont | ) |
void Ogre::Overlay::add3D | ( | SceneNode * | node | ) |
Adds a node capable of holding 3D objects to the overlay.
void Ogre::Overlay::remove3D | ( | SceneNode * | node | ) |
Removes a 3D element from the overlay.
void Ogre::Overlay::clear | ( | ) |
Clears the overlay of all attached items.
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. |
Real Ogre::Overlay::getScrollX | ( | void | ) | const |
Gets the current X scroll value.
Real Ogre::Overlay::getScrollY | ( | void | ) | const |
Gets the current Y scroll value.
Scrolls the overlay by the offsets provided.
void Ogre::Overlay::setRotate | ( | const Radian & | angle | ) |
Sets the rotation applied to this overlay.
const Radian& Ogre::Overlay::getRotate | ( | void | ) | const |
Gets the rotation applied to this overlay, in degrees.
Definition at line 218 of file OgreOverlay.h.
void Ogre::Overlay::rotate | ( | const Radian & | angle | ) |
Adds the passed in angle to 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 |
Real Ogre::Overlay::getScaleX | ( | void | ) | const |
Gets the current X scale value.
Real Ogre::Overlay::getScaleY | ( | void | ) | const |
Gets the current Y scale value.
void Ogre::Overlay::_getWorldTransforms | ( | Matrix4 * | xform | ) | const |
Used to transform the overlay when scrolling, scaling etc.
void Ogre::Overlay::_findVisibleObjects | ( | Camera * | cam, | |
RenderQueue * | queue | |||
) |
Internal method to put the overlay contents onto the render queue.
virtual OverlayElement* Ogre::Overlay::findElementAt | ( | Real | x, | |
Real | y | |||
) | [virtual] |
This returns a OverlayElement at position x,y.
Overlay2DElementsIterator Ogre::Overlay::get2DElementsIterator | ( | ) |
Definition at line 252 of file OgreOverlay.h.
const String& Ogre::Overlay::getOrigin | ( | void | ) | const |
Get the origin of this overlay, e.g.
a script file name.
Definition at line 262 of file OgreOverlay.h.
void Ogre::Overlay::_notifyOrigin | ( | const String & | origin | ) |
void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz, | |
const char * | file, | |||
int | line, | |||
const char * | func | |||
) | [inherited] |
void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz | ) | [inherited] |
Definition at line 67 of file OgreMemoryAllocatedObject.h.
void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz, | |
void * | ptr | |||
) | [inherited] |
void* Ogre::AllocatedObject< Alloc >::operator new[] | ( | size_t | sz, | |
const char * | file, | |||
int | line, | |||
const char * | func | |||
) | [inherited] |
void* Ogre::AllocatedObject< Alloc >::operator new[] | ( | size_t | sz | ) | [inherited] |
Definition at line 84 of file OgreMemoryAllocatedObject.h.
void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr | ) | [inherited] |
Definition at line 89 of file OgreMemoryAllocatedObject.h.
void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr, | |
void * | ||||
) | [inherited] |
Definition at line 95 of file OgreMemoryAllocatedObject.h.
void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr, | |
const char * | , | |||
int | , | |||
const char * | ||||
) | [inherited] |
Definition at line 101 of file OgreMemoryAllocatedObject.h.
void Ogre::AllocatedObject< Alloc >::operator delete[] | ( | void * | ptr | ) | [inherited] |
Definition at line 106 of file OgreMemoryAllocatedObject.h.
void Ogre::AllocatedObject< Alloc >::operator delete[] | ( | void * | ptr, | |
const char * | , | |||
int | , | |||
const char * | ||||
) | [inherited] |
Definition at line 112 of file OgreMemoryAllocatedObject.h.
String Ogre::Overlay::mName [protected] |
Definition at line 71 of file OgreOverlay.h.
SceneNode* Ogre::Overlay::mRootNode [protected] |
OverlayContainerList Ogre::Overlay::m2DElements [protected] |
Definition at line 77 of file OgreOverlay.h.
Radian Ogre::Overlay::mRotate [protected] |
Definition at line 80 of file OgreOverlay.h.
Real Ogre::Overlay::mScrollX [protected] |
Definition at line 82 of file OgreOverlay.h.
Real Ogre::Overlay::mScrollY [protected] |
Definition at line 82 of file OgreOverlay.h.
Real Ogre::Overlay::mScaleX [protected] |
Definition at line 84 of file OgreOverlay.h.
Real Ogre::Overlay::mScaleY [protected] |
Definition at line 84 of file OgreOverlay.h.
Matrix4 Ogre::Overlay::mTransform [mutable, protected] |
Definition at line 86 of file OgreOverlay.h.
bool Ogre::Overlay::mTransformOutOfDate [mutable, protected] |
Definition at line 87 of file OgreOverlay.h.
bool Ogre::Overlay::mTransformUpdated [protected] |
Definition at line 88 of file OgreOverlay.h.
ulong Ogre::Overlay::mZOrder [protected] |
Definition at line 89 of file OgreOverlay.h.
bool Ogre::Overlay::mVisible [protected] |
Definition at line 90 of file OgreOverlay.h.
bool Ogre::Overlay::mInitialised [protected] |
Definition at line 91 of file OgreOverlay.h.
String Ogre::Overlay::mOrigin [protected] |
Definition at line 92 of file OgreOverlay.h.
Copyright © 2008 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Sep 27 22:04:32 2009