#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. | |
| 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. | |
| const Quaternion & | getWorldOrientation (void) const |
| | |
| const Vector3 & | getWorldPosition (void) const |
| | |
| 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. | |
Protected Member Functions | |
| void | updateTransform (void) const |
| Internal lazy update method. | |
| void | initialise (void) |
| Internal method for initialising an overlay. | |
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 61 of file OgreOverlay.h.
|
|
Returns an iterator over all 2D elements in this manager.
Definition at line 259 of file OgreOverlay.h. Referenced by get2DElementsIterator(). |
|
|
Definition at line 65 of file OgreOverlay.h. |
|
|
Constructor: do not call direct, use OverlayManager::create.
|
|
|
|
|
||||||||||||
|
Internal method to put the overlay contents onto the render queue.
|
|
|
Used to transform the overlay when scrolling, scaling etc.
|
|
|
Notify this overlay of it's origin.
Definition at line 272 of file OgreOverlay.h. References Ogre::String. |
|
|
Adds a 2D 'container' to the overlay.
|
|
|
Adds a node capable of holding 3D objects to the overlay.
|
|
|
Clears the overlay of all attached items.
|
|
||||||||||||
|
This returns a OverlayElement at position x,y.
|
|
|
Definition at line 260 of file OgreOverlay.h. References Overlay2DElementsIterator. |
|
|
|
|
|
Gets the name of this overlay.
|
|
|
Get the origin of this overlay, e.g. a script file name.
Definition at line 270 of file OgreOverlay.h. References Ogre::String. |
|
|
Gets the rotation applied to this overlay, in degrees.
Definition at line 217 of file OgreOverlay.h. |
|
|
Gets the current X scale value.
|
|
|
Gets the current Y scale value.
|
|
|
Gets the current X scroll value.
|
|
|
Gets the current Y scroll value.
|
|
|
|
|
|
|
|
|
Gets the ZOrder of this overlay.
|
|
|
Hides the overlay if it was visible.
|
|
|
Internal method for initialising an overlay.
|
|
|
Gets whether the overlay is initialised or not.
Definition at line 116 of file OgreOverlay.h. |
|
|
Gets whether the overlay is displayed or not.
|
|
|
Removes a 2D container from the overlay.
|
|
|
Removes a 3D element from the overlay.
|
|
|
Adds the passed in angle to the rotation applied to this overlay.
|
|
||||||||||||
|
Scrolls the overlay by the offsets provided.
|
|
|
Sets the rotation applied to this overlay.
|
|
||||||||||||
|
Sets the scaling factor of this overlay.
|
|
||||||||||||
|
Sets the scrolling factor of this overlay.
|
|
|
Alters the ZOrder of this overlay.
|
|
|
Shows the overlay if it was hidden.
|
|
|
Internal lazy update method.
|
|
|
Definition at line 73 of file OgreOverlay.h. |
|
|
Definition at line 87 of file OgreOverlay.h. |
|
|
Definition at line 67 of file OgreOverlay.h. |
|
|
Definition at line 88 of file OgreOverlay.h. |
|
|
Internal root node, used as parent for 3D objects.
Definition at line 69 of file OgreOverlay.h. |
|
|
Definition at line 76 of file OgreOverlay.h. |
|
|
Definition at line 80 of file OgreOverlay.h. |
|
|
Definition at line 80 of file OgreOverlay.h. |
|
|
Definition at line 78 of file OgreOverlay.h. |
|
|
Definition at line 78 of file OgreOverlay.h. |
|
|
Definition at line 82 of file OgreOverlay.h. |
|
|
Definition at line 83 of file OgreOverlay.h. |
|
|
Definition at line 84 of file OgreOverlay.h. |
|
|
Definition at line 86 of file OgreOverlay.h. |
|
|
Definition at line 85 of file OgreOverlay.h. |
Copyright © 2000-2005 by The OGRE Team
Last modified Sun Nov 20 12:37:41 2005