![]() |
OGRE 1.12.10
Object-Oriented Graphics Rendering Engine
|
Represents a layer which is rendered on top of the 'normal' scene contents. More...
#include <OgreOverlay.h>
Public Types | |
typedef std::list< OverlayContainer * > | OverlayContainerList |
Public Member Functions | |
Overlay (const String &name) | |
Constructor: do not call direct, use OverlayManager::create. | |
virtual | ~Overlay () |
virtual void | _findVisibleObjects (Camera *cam, RenderQueue *queue, Viewport *vp) |
Internal method to put the overlay contents onto the render queue. | |
void | _getWorldTransforms (Matrix4 *xform) const |
Used to transform the overlay when scrolling, scaling etc. | |
void | _notifyOrigin (const String &origin) |
Notify this overlay of it's origin. | |
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 | clear () |
Clears the overlay of all attached items. | |
virtual OverlayElement * | findElementAt (Real x, Real y) |
This returns a OverlayElement at position x,y. | |
const OverlayContainerList & | get2DElements () const |
Returns all 2D elements in this manager. | |
OverlayContainer * | getChild (const String &name) |
const String & | getName (void) const |
Gets the name of this overlay. | |
const String & | getOrigin (void) const |
Get the origin of this overlay, e.g. | |
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. | |
ushort | getZOrder (void) const |
Gets the Z-order of this overlay. | |
void | hide (void) |
Hides the overlay if it was visible. | |
bool | isInitialised (void) const |
Gets whether the overlay is initialised or not. | |
bool | isVisible (void) const |
Gets whether the overlay is displayed or not. | |
void | remove2D (OverlayContainer *cont) |
Removes a 2D container from the overlay. | |
void | remove3D (SceneNode *node) |
Removes a 3D element from the overlay. | |
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 | 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 | setZOrder (ushort zorder) |
Alters the Z-order of this overlay. | |
void | show (void) |
Shows the overlay if it was hidden. | |
Represents a layer which is rendered on top of the 'normal' scene contents.
Constructor: do not call direct, use OverlayManager::create.
|
virtual |
OverlayContainer * Ogre::Overlay::getChild | ( | const String & | name | ) |
Alters the Z-order of this overlay.
Gets whether the overlay is initialised or not.
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 | ) |
Removes a 2D container from the overlay.
Adds a node capable of holding 3D objects to 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. |
Scrolls the overlay by the offsets provided.
Gets the rotation applied to this overlay, in degrees.
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 |
Used to transform the overlay when scrolling, scaling etc.
|
virtual |
Internal method to put the overlay contents onto the render queue.
Reimplemented in Ogre::ImGuiOverlay.
|
virtual |
This returns a OverlayElement at position x,y.
|
inline |
Returns all 2D elements in this manager.
Get the origin of this overlay, e.g.
a script file name.
Notify this overlay of it's origin.