source: OGRE/trunk/ogrenew/Docs/api/html/classOgre_1_1Overlay.html @ 692

Revision 692, 75.5 KB checked in by mattausch, 18 years ago (diff)

adding ogre 1.2 and dependencies
Line 
1<html>
2<head>
3<title>Ogre::Overlay class Reference - OGRE Documentation</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
4<link type="text/css" rel="stylesheet" href="style.css">
5</head>
6
7<body>
8<!-- Generated by Doxygen 1.3.6 -->
9<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a></div>
10<h1>Ogre::Overlay Class Reference</h1>Represents a layer which is rendered on top of the 'normal' scene contents. 
11<a href="#_details">More...</a>
12<p>
13<code>#include &lt;<a class="el" href="OgreOverlay_8h-source.html">OgreOverlay.h</a>&gt;</code>
14<p>
15<a href="classOgre_1_1Overlay-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
16<tr><td></td></tr>
17<tr><td colspan=2><br><h2>Public Types</h2></td></tr>
18<tr><td class="memItemLeft" nowrap align=right valign=top>typedef std::list&lt; <a class="el" href="classOgre_1_1OverlayContainer.html">OverlayContainer</a> * &gt;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Overlay.html#Ogre_1_1Overlayw0">OverlayContainerList</a></td></tr>
19
20<tr><td class="memItemLeft" nowrap align=right valign=top>typedef <a class="el" href="classOgre_1_1VectorIterator.html">VectorIterator</a>&lt; <a class="el" href="classOgre_1_1Overlay.html#Ogre_1_1Overlayw0">OverlayContainerList</a> &gt;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Overlay.html#Ogre_1_1Overlayw1">Overlay2DElementsIterator</a></td></tr>
21
22<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns an iterator over all 2D elements in this manager.  <a href="#Ogre_1_1Overlayw1"></a><br><br></td></tr>
23<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
24<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Overlay.html#Ogre_1_1Overlaya0">Overlay</a> (const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;name)</td></tr>
25
26<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor: do not call direct, use <a class="el" href="classOgre_1_1OverlayManager.html#Ogre_1_1OverlayManagera5">OverlayManager::create</a>.  <a href="#Ogre_1_1Overlaya0"></a><br><br></td></tr>
27<tr><td class="memItemLeft" nowrap align=right valign=top>virtual&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Overlay.html#Ogre_1_1Overlaya1">~Overlay</a> ()</td></tr>
28
29<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1OverlayContainer.html">OverlayContainer</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Overlay.html#Ogre_1_1Overlaya2">getChild</a> (const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;name)</td></tr>
30
31<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Overlay.html#Ogre_1_1Overlaya3">getName</a> (void) const </td></tr>
32
33<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the name of this overlay.  <a href="#Ogre_1_1Overlaya3"></a><br><br></td></tr>
34<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Overlay.html#Ogre_1_1Overlaya4">setZOrder</a> (<a class="el" href="namespaceOgre.html#a467">ushort</a> zorder)</td></tr>
35
36<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Alters the ZOrder of this overlay.  <a href="#Ogre_1_1Overlaya4"></a><br><br></td></tr>
37<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a467">ushort</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Overlay.html#Ogre_1_1Overlaya5">getZOrder</a> (void) const </td></tr>
38
39<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the ZOrder of this overlay.  <a href="#Ogre_1_1Overlaya5"></a><br><br></td></tr>
40<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Overlay.html#Ogre_1_1Overlaya6">isVisible</a> (void) const </td></tr>
41
42<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets whether the overlay is displayed or not.  <a href="#Ogre_1_1Overlaya6"></a><br><br></td></tr>
43<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Overlay.html#Ogre_1_1Overlaya7">isInitialised</a> (void) const </td></tr>
44
45<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets whether the overlay is initialised or not.  <a href="#Ogre_1_1Overlaya7"></a><br><br></td></tr>
46<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Overlay.html#Ogre_1_1Overlaya8">show</a> (void)</td></tr>
47
48<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Shows the overlay if it was hidden.  <a href="#Ogre_1_1Overlaya8"></a><br><br></td></tr>
49<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Overlay.html#Ogre_1_1Overlaya9">hide</a> (void)</td></tr>
50
51<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Hides the overlay if it was visible.  <a href="#Ogre_1_1Overlaya9"></a><br><br></td></tr>
52<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Overlay.html#Ogre_1_1Overlaya10">add2D</a> (<a class="el" href="classOgre_1_1OverlayContainer.html">OverlayContainer</a> *cont)</td></tr>
53
54<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Adds a 2D 'container' to the overlay.  <a href="#Ogre_1_1Overlaya10"></a><br><br></td></tr>
55<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Overlay.html#Ogre_1_1Overlaya11">remove2D</a> (<a class="el" href="classOgre_1_1OverlayContainer.html">OverlayContainer</a> *cont)</td></tr>
56
57<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Removes a 2D container from the overlay.  <a href="#Ogre_1_1Overlaya11"></a><br><br></td></tr>
58<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Overlay.html#Ogre_1_1Overlaya12">add3D</a> (<a class="el" href="classOgre_1_1SceneNode.html">SceneNode</a> *node)</td></tr>
59
60<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Adds a node capable of holding 3D objects to the overlay.  <a href="#Ogre_1_1Overlaya12"></a><br><br></td></tr>
61<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Overlay.html#Ogre_1_1Overlaya13">remove3D</a> (<a class="el" href="classOgre_1_1SceneNode.html">SceneNode</a> *node)</td></tr>
62
63<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Removes a 3D element from the overlay.  <a href="#Ogre_1_1Overlaya13"></a><br><br></td></tr>
64<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Overlay.html#Ogre_1_1Overlaya14">clear</a> ()</td></tr>
65
66<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Clears the overlay of all attached items.  <a href="#Ogre_1_1Overlaya14"></a><br><br></td></tr>
67<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Overlay.html#Ogre_1_1Overlaya15">setScroll</a> (<a class="el" href="namespaceOgre.html#a465">Real</a> x, <a class="el" href="namespaceOgre.html#a465">Real</a> y)</td></tr>
68
69<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the scrolling factor of this overlay.  <a href="#Ogre_1_1Overlaya15"></a><br><br></td></tr>
70<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a465">Real</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Overlay.html#Ogre_1_1Overlaya16">getScrollX</a> (void) const </td></tr>
71
72<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the current X scroll value.  <a href="#Ogre_1_1Overlaya16"></a><br><br></td></tr>
73<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a465">Real</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Overlay.html#Ogre_1_1Overlaya17">getScrollY</a> (void) const </td></tr>
74
75<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the current Y scroll value.  <a href="#Ogre_1_1Overlaya17"></a><br><br></td></tr>
76<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Overlay.html#Ogre_1_1Overlaya18">scroll</a> (<a class="el" href="namespaceOgre.html#a465">Real</a> xoff, <a class="el" href="namespaceOgre.html#a465">Real</a> yoff)</td></tr>
77
78<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Scrolls the overlay by the offsets provided.  <a href="#Ogre_1_1Overlaya18"></a><br><br></td></tr>
79<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Overlay.html#Ogre_1_1Overlaya19">setRotate</a> (const <a class="el" href="classOgre_1_1Radian.html">Radian</a> &amp;angle)</td></tr>
80
81<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the rotation applied to this overlay.  <a href="#Ogre_1_1Overlaya19"></a><br><br></td></tr>
82<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="classOgre_1_1Radian.html">Radian</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Overlay.html#Ogre_1_1Overlaya20">getRotate</a> (void) const </td></tr>
83
84<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the rotation applied to this overlay, in degrees.  <a href="#Ogre_1_1Overlaya20"></a><br><br></td></tr>
85<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Overlay.html#Ogre_1_1Overlaya21">rotate</a> (const <a class="el" href="classOgre_1_1Radian.html">Radian</a> &amp;angle)</td></tr>
86
87<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Adds the passed in angle to the rotation applied to this overlay.  <a href="#Ogre_1_1Overlaya21"></a><br><br></td></tr>
88<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Overlay.html#Ogre_1_1Overlaya22">setScale</a> (<a class="el" href="namespaceOgre.html#a465">Real</a> x, <a class="el" href="namespaceOgre.html#a465">Real</a> y)</td></tr>
89
90<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the scaling factor of this overlay.  <a href="#Ogre_1_1Overlaya22"></a><br><br></td></tr>
91<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a465">Real</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Overlay.html#Ogre_1_1Overlaya23">getScaleX</a> (void) const </td></tr>
92
93<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the current X scale value.  <a href="#Ogre_1_1Overlaya23"></a><br><br></td></tr>
94<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a465">Real</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Overlay.html#Ogre_1_1Overlaya24">getScaleY</a> (void) const </td></tr>
95
96<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the current Y scale value.  <a href="#Ogre_1_1Overlaya24"></a><br><br></td></tr>
97<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Overlay.html#Ogre_1_1Overlaya25">_getWorldTransforms</a> (<a class="el" href="classOgre_1_1Matrix4.html">Matrix4</a> *xform) const </td></tr>
98
99<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Used to transform the overlay when scrolling, scaling etc.  <a href="#Ogre_1_1Overlaya25"></a><br><br></td></tr>
100<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="classOgre_1_1Quaternion.html">Quaternion</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Overlay.html#Ogre_1_1Overlaya26">getWorldOrientation</a> (void) const </td></tr>
101
102<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">  <a href="#Ogre_1_1Overlaya26"></a><br><br></td></tr>
103<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="classOgre_1_1Vector3.html">Vector3</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Overlay.html#Ogre_1_1Overlaya27">getWorldPosition</a> (void) const </td></tr>
104
105<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">  <a href="#Ogre_1_1Overlaya27"></a><br><br></td></tr>
106<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Overlay.html#Ogre_1_1Overlaya28">_findVisibleObjects</a> (<a class="el" href="classOgre_1_1Camera.html">Camera</a> *cam, <a class="el" href="classOgre_1_1RenderQueue.html">RenderQueue</a> *queue)</td></tr>
107
108<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Internal method to put the overlay contents onto the render queue.  <a href="#Ogre_1_1Overlaya28"></a><br><br></td></tr>
109<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="classOgre_1_1OverlayElement.html">OverlayElement</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Overlay.html#Ogre_1_1Overlaya29">findElementAt</a> (<a class="el" href="namespaceOgre.html#a465">Real</a> x, <a class="el" href="namespaceOgre.html#a465">Real</a> y)</td></tr>
110
111<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This returns a <a class="el" href="classOgre_1_1OverlayElement.html">OverlayElement</a> at position x,y.  <a href="#Ogre_1_1Overlaya29"></a><br><br></td></tr>
112<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1VectorIterator.html">Overlay2DElementsIterator</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Overlay.html#Ogre_1_1Overlaya30">get2DElementsIterator</a> ()</td></tr>
113
114<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Overlay.html#Ogre_1_1Overlaya31">getOrigin</a> (void) const </td></tr>
115
116<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the origin of this overlay, e.g.  <a href="#Ogre_1_1Overlaya31"></a><br><br></td></tr>
117<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Overlay.html#Ogre_1_1Overlaya32">_notifyOrigin</a> (const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;origin)</td></tr>
118
119<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Notify this overlay of it's origin.  <a href="#Ogre_1_1Overlaya32"></a><br><br></td></tr>
120<tr><td colspan=2><br><h2>Protected Member Functions</h2></td></tr>
121<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Overlay.html#Ogre_1_1Overlayb0">updateTransform</a> (void) const </td></tr>
122
123<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Internal lazy update method.  <a href="#Ogre_1_1Overlayb0"></a><br><br></td></tr>
124<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Overlay.html#Ogre_1_1Overlayb1">initialise</a> (void)</td></tr>
125
126<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Internal method for initialising an overlay.  <a href="#Ogre_1_1Overlayb1"></a><br><br></td></tr>
127<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
128<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a471">String</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Overlay.html#Ogre_1_1Overlayp0">mName</a></td></tr>
129
130<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1SceneNode.html">SceneNode</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Overlay.html#Ogre_1_1Overlayp1">mRootNode</a></td></tr>
131
132<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Internal root node, used as parent for 3D objects.  <a href="#Ogre_1_1Overlayp1"></a><br><br></td></tr>
133<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1Overlay.html#Ogre_1_1Overlayw0">OverlayContainerList</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Overlay.html#Ogre_1_1Overlayp2">m2DElements</a></td></tr>
134
135<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1Radian.html">Radian</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Overlay.html#Ogre_1_1Overlayp3">mRotate</a></td></tr>
136
137<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a465">Real</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Overlay.html#Ogre_1_1Overlayp4">mScrollX</a></td></tr>
138
139<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a465">Real</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Overlay.html#Ogre_1_1Overlayp5">mScrollY</a></td></tr>
140
141<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a465">Real</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Overlay.html#Ogre_1_1Overlayp6">mScaleX</a></td></tr>
142
143<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a465">Real</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Overlay.html#Ogre_1_1Overlayp7">mScaleY</a></td></tr>
144
145<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1Matrix4.html">Matrix4</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Overlay.html#Ogre_1_1Overlayp8">mTransform</a></td></tr>
146
147<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Overlay.html#Ogre_1_1Overlayp9">mTransformOutOfDate</a></td></tr>
148
149<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Overlay.html#Ogre_1_1Overlayp10">mTransformUpdated</a></td></tr>
150
151<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a469">ulong</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Overlay.html#Ogre_1_1Overlayp11">mZOrder</a></td></tr>
152
153<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Overlay.html#Ogre_1_1Overlayp12">mVisible</a></td></tr>
154
155<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Overlay.html#Ogre_1_1Overlayp13">mInitialised</a></td></tr>
156
157<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a471">String</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Overlay.html#Ogre_1_1Overlayp14">mOrigin</a></td></tr>
158
159</table>
160<hr><a name="_details"></a><h2>Detailed Description</h2>
161Represents a layer which is rendered on top of the 'normal' scene contents.
162<p>
163<dl compact><dt><b>Remarks:</b></dt><dd>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. </dd></dl>
164<dl compact><dt><b></b></dt><dd>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. </dd></dl>
165<dl compact><dt><b></b></dt><dd>Overlays are created by calling <a class="el" href="classOgre_1_1OverlayManager.html#Ogre_1_1OverlayManagera5">OverlayManager::create</a>, 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. </dd></dl>
166<dl compact><dt><b></b></dt><dd>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. </dd></dl>
167
168<p>
169
170<p>
171Definition at line <a class="el" href="OgreOverlay_8h-source.html#l00061">61</a> of file <a class="el" href="OgreOverlay_8h-source.html">OgreOverlay.h</a>.<hr><h2>Member Typedef Documentation</h2>
172<a class="anchor" name="Ogre_1_1Overlayw1" doxytag="Ogre::Overlay::Overlay2DElementsIterator" ></a><p>
173<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
174  <tr>
175    <td class="mdRow">
176      <table cellpadding="0" cellspacing="0" border="0">
177        <tr>
178          <td class="md" nowrap valign="top"> typedef <a class="el" href="classOgre_1_1VectorIterator.html">VectorIterator</a>&lt;<a class="el" href="classOgre_1_1Overlay.html#Ogre_1_1Overlayw0">OverlayContainerList</a>&gt; <a class="el" href="classOgre_1_1VectorIterator.html">Ogre::Overlay::Overlay2DElementsIterator</a>
179      </table>
180    </td>
181  </tr>
182</table>
183<table cellspacing=5 cellpadding=0 border=0>
184  <tr>
185    <td>
186      &nbsp;
187    </td>
188    <td>
189
190<p>
191Returns an iterator over all 2D elements in this manager.
192<p>
193<dl compact><dt><b>Remarks:</b></dt><dd><a class="el" href="classOgre_1_1VectorIterator.html">VectorIterator</a> is actually a too generic name, since it also works for lists. </dd></dl>
194
195<p>
196Definition at line <a class="el" href="OgreOverlay_8h-source.html#l00259">259</a> of file <a class="el" href="OgreOverlay_8h-source.html">OgreOverlay.h</a>.
197<p>
198Referenced by <a class="el" href="OgreOverlay_8h-source.html#l00260">get2DElementsIterator()</a>.    </td>
199  </tr>
200</table>
201<a class="anchor" name="Ogre_1_1Overlayw0" doxytag="Ogre::Overlay::OverlayContainerList" ></a><p>
202<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
203  <tr>
204    <td class="mdRow">
205      <table cellpadding="0" cellspacing="0" border="0">
206        <tr>
207          <td class="md" nowrap valign="top"> typedef std::list&lt;<a class="el" href="classOgre_1_1OverlayContainer.html">OverlayContainer</a>*&gt; <a class="el" href="classOgre_1_1Overlay.html#Ogre_1_1Overlayw0">Ogre::Overlay::OverlayContainerList</a>
208      </table>
209    </td>
210  </tr>
211</table>
212<table cellspacing=5 cellpadding=0 border=0>
213  <tr>
214    <td>
215      &nbsp;
216    </td>
217    <td>
218
219<p>
220
221<p>
222Definition at line <a class="el" href="OgreOverlay_8h-source.html#l00065">65</a> of file <a class="el" href="OgreOverlay_8h-source.html">OgreOverlay.h</a>.    </td>
223  </tr>
224</table>
225<hr><h2>Constructor &amp; Destructor Documentation</h2>
226<a class="anchor" name="Ogre_1_1Overlaya0" doxytag="Ogre::Overlay::Overlay" ></a><p>
227<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
228  <tr>
229    <td class="mdRow">
230      <table cellpadding="0" cellspacing="0" border="0">
231        <tr>
232          <td class="md" nowrap valign="top"> Ogre::Overlay::Overlay </td>
233          <td class="md" valign="top">(&nbsp;</td>
234          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;&nbsp;</td>
235          <td class="mdname1" valign="top" nowrap> <em>name</em>          </td>
236          <td class="md" valign="top">&nbsp;)&nbsp;</td>
237          <td class="md" nowrap></td>
238        </tr>
239
240      </table>
241    </td>
242  </tr>
243</table>
244<table cellspacing=5 cellpadding=0 border=0>
245  <tr>
246    <td>
247      &nbsp;
248    </td>
249    <td>
250
251<p>
252Constructor: do not call direct, use <a class="el" href="classOgre_1_1OverlayManager.html#Ogre_1_1OverlayManagera5">OverlayManager::create</a>.
253<p>
254    </td>
255  </tr>
256</table>
257<a class="anchor" name="Ogre_1_1Overlaya1" doxytag="Ogre::Overlay::~Overlay" ></a><p>
258<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
259  <tr>
260    <td class="mdRow">
261      <table cellpadding="0" cellspacing="0" border="0">
262        <tr>
263          <td class="md" nowrap valign="top"> virtual Ogre::Overlay::~<a class="el" href="classOgre_1_1Overlay.html">Overlay</a> </td>
264          <td class="md" valign="top">(&nbsp;</td>
265          <td class="mdname1" valign="top" nowrap>          </td>
266          <td class="md" valign="top">&nbsp;)&nbsp;</td>
267          <td class="md" nowrap><code> [virtual]</code></td>
268        </tr>
269
270      </table>
271    </td>
272  </tr>
273</table>
274<table cellspacing=5 cellpadding=0 border=0>
275  <tr>
276    <td>
277      &nbsp;
278    </td>
279    <td>
280
281<p>
282    </td>
283  </tr>
284</table>
285<hr><h2>Member Function Documentation</h2>
286<a class="anchor" name="Ogre_1_1Overlaya28" doxytag="Ogre::Overlay::_findVisibleObjects" ></a><p>
287<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
288  <tr>
289    <td class="mdRow">
290      <table cellpadding="0" cellspacing="0" border="0">
291        <tr>
292          <td class="md" nowrap valign="top"> void Ogre::Overlay::_findVisibleObjects </td>
293          <td class="md" valign="top">(&nbsp;</td>
294          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1Camera.html">Camera</a> *&nbsp;</td>
295          <td class="mdname" nowrap> <em>cam</em>, </td>
296        </tr>
297        <tr>
298          <td class="md" nowrap align="right"></td>
299          <td></td>
300          <td class="md" nowrap><a class="el" href="classOgre_1_1RenderQueue.html">RenderQueue</a> *&nbsp;</td>
301          <td class="mdname" nowrap> <em>queue</em></td>
302        </tr>
303        <tr>
304          <td></td>
305          <td class="md">)&nbsp;</td>
306          <td class="md" colspan="2"></td>
307        </tr>
308
309      </table>
310    </td>
311  </tr>
312</table>
313<table cellspacing=5 cellpadding=0 border=0>
314  <tr>
315    <td>
316      &nbsp;
317    </td>
318    <td>
319
320<p>
321Internal method to put the overlay contents onto the render queue.
322<p>
323    </td>
324  </tr>
325</table>
326<a class="anchor" name="Ogre_1_1Overlaya25" doxytag="Ogre::Overlay::_getWorldTransforms" ></a><p>
327<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
328  <tr>
329    <td class="mdRow">
330      <table cellpadding="0" cellspacing="0" border="0">
331        <tr>
332          <td class="md" nowrap valign="top"> void Ogre::Overlay::_getWorldTransforms </td>
333          <td class="md" valign="top">(&nbsp;</td>
334          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1Matrix4.html">Matrix4</a> *&nbsp;</td>
335          <td class="mdname1" valign="top" nowrap> <em>xform</em>          </td>
336          <td class="md" valign="top">&nbsp;)&nbsp;</td>
337          <td class="md" nowrap> const</td>
338        </tr>
339
340      </table>
341    </td>
342  </tr>
343</table>
344<table cellspacing=5 cellpadding=0 border=0>
345  <tr>
346    <td>
347      &nbsp;
348    </td>
349    <td>
350
351<p>
352Used to transform the overlay when scrolling, scaling etc.
353<p>
354    </td>
355  </tr>
356</table>
357<a class="anchor" name="Ogre_1_1Overlaya32" doxytag="Ogre::Overlay::_notifyOrigin" ></a><p>
358<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
359  <tr>
360    <td class="mdRow">
361      <table cellpadding="0" cellspacing="0" border="0">
362        <tr>
363          <td class="md" nowrap valign="top"> void Ogre::Overlay::_notifyOrigin </td>
364          <td class="md" valign="top">(&nbsp;</td>
365          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;&nbsp;</td>
366          <td class="mdname1" valign="top" nowrap> <em>origin</em>          </td>
367          <td class="md" valign="top">&nbsp;)&nbsp;</td>
368          <td class="md" nowrap></td>
369        </tr>
370
371      </table>
372    </td>
373  </tr>
374</table>
375<table cellspacing=5 cellpadding=0 border=0>
376  <tr>
377    <td>
378      &nbsp;
379    </td>
380    <td>
381
382<p>
383Notify this overlay of it's origin.
384<p>
385
386<p>
387Definition at line <a class="el" href="OgreOverlay_8h-source.html#l00272">272</a> of file <a class="el" href="OgreOverlay_8h-source.html">OgreOverlay.h</a>.
388<p>
389References <a class="el" href="OgrePrerequisites_8h-source.html#l00156">Ogre::String</a>.    </td>
390  </tr>
391</table>
392<a class="anchor" name="Ogre_1_1Overlaya10" doxytag="Ogre::Overlay::add2D" ></a><p>
393<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
394  <tr>
395    <td class="mdRow">
396      <table cellpadding="0" cellspacing="0" border="0">
397        <tr>
398          <td class="md" nowrap valign="top"> void Ogre::Overlay::add2D </td>
399          <td class="md" valign="top">(&nbsp;</td>
400          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1OverlayContainer.html">OverlayContainer</a> *&nbsp;</td>
401          <td class="mdname1" valign="top" nowrap> <em>cont</em>          </td>
402          <td class="md" valign="top">&nbsp;)&nbsp;</td>
403          <td class="md" nowrap></td>
404        </tr>
405
406      </table>
407    </td>
408  </tr>
409</table>
410<table cellspacing=5 cellpadding=0 border=0>
411  <tr>
412    <td>
413      &nbsp;
414    </td>
415    <td>
416
417<p>
418Adds a 2D 'container' to the overlay.
419<p>
420<dl compact><dt><b>Remarks:</b></dt><dd>Containers are created and managed using the <a class="el" href="classOgre_1_1OverlayManager.html">OverlayManager</a>. 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. </dd></dl>
421<dl compact><dt><b>Parameters:</b></dt><dd>
422  <table border="0" cellspacing="2" cellpadding="0">
423    <tr><td valign=top><em>cont</em>&nbsp;</td><td>Pointer to a container to add, created using <a class="el" href="classOgre_1_1OverlayManager.html">OverlayManager</a>. </td></tr>
424  </table>
425</dl>
426    </td>
427  </tr>
428</table>
429<a class="anchor" name="Ogre_1_1Overlaya12" doxytag="Ogre::Overlay::add3D" ></a><p>
430<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
431  <tr>
432    <td class="mdRow">
433      <table cellpadding="0" cellspacing="0" border="0">
434        <tr>
435          <td class="md" nowrap valign="top"> void Ogre::Overlay::add3D </td>
436          <td class="md" valign="top">(&nbsp;</td>
437          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1SceneNode.html">SceneNode</a> *&nbsp;</td>
438          <td class="mdname1" valign="top" nowrap> <em>node</em>          </td>
439          <td class="md" valign="top">&nbsp;)&nbsp;</td>
440          <td class="md" nowrap></td>
441        </tr>
442
443      </table>
444    </td>
445  </tr>
446</table>
447<table cellspacing=5 cellpadding=0 border=0>
448  <tr>
449    <td>
450      &nbsp;
451    </td>
452    <td>
453
454<p>
455Adds a node capable of holding 3D objects to the overlay.
456<p>
457<dl compact><dt><b>Remarks:</b></dt><dd>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). </dd></dl>
458<dl compact><dt><b></b></dt><dd>A <a class="el" href="classOgre_1_1SceneNode.html">SceneNode</a> can have nay number of 3D objects attached to it. SceneNodes are usually created using <a class="el" href="classOgre_1_1SceneManager.html#Ogre_1_1SceneManagera15">SceneManager::createSceneNode</a>, but in this case you should create a standard <a class="el" href="classOgre_1_1SceneNode.html">SceneNode</a> instance <b>manually</b>; this is because these scene nodes are not managed by the <a class="el" href="classOgre_1_1SceneManager.html">SceneManager</a> and some custom <a class="el" href="classOgre_1_1SceneManager.html">SceneManager</a> plugins will rely on specialist behaviour the overlay does not support. By attaching a <a class="el" href="classOgre_1_1SceneNode.html">SceneNode</a> to an overlay, you indicate that:<ol>
459<li>
460You want the contents of this node to only appear when the overlay is active </li>
461<li>
462You want the node to inherit a coordinate space relative to the camera, rather than relative to the root scene node </li>
463<li>
464You want these objects to be rendered after the contents of the main scene to ensure they are rendered on top </li>
465</ol>
466One 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. </dd></dl>
467    </td>
468  </tr>
469</table>
470<a class="anchor" name="Ogre_1_1Overlaya14" doxytag="Ogre::Overlay::clear" ></a><p>
471<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
472  <tr>
473    <td class="mdRow">
474      <table cellpadding="0" cellspacing="0" border="0">
475        <tr>
476          <td class="md" nowrap valign="top"> void Ogre::Overlay::clear </td>
477          <td class="md" valign="top">(&nbsp;</td>
478          <td class="mdname1" valign="top" nowrap>          </td>
479          <td class="md" valign="top">&nbsp;)&nbsp;</td>
480          <td class="md" nowrap></td>
481        </tr>
482
483      </table>
484    </td>
485  </tr>
486</table>
487<table cellspacing=5 cellpadding=0 border=0>
488  <tr>
489    <td>
490      &nbsp;
491    </td>
492    <td>
493
494<p>
495Clears the overlay of all attached items.
496<p>
497    </td>
498  </tr>
499</table>
500<a class="anchor" name="Ogre_1_1Overlaya29" doxytag="Ogre::Overlay::findElementAt" ></a><p>
501<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
502  <tr>
503    <td class="mdRow">
504      <table cellpadding="0" cellspacing="0" border="0">
505        <tr>
506          <td class="md" nowrap valign="top"> virtual <a class="el" href="classOgre_1_1OverlayElement.html">OverlayElement</a>* Ogre::Overlay::findElementAt </td>
507          <td class="md" valign="top">(&nbsp;</td>
508          <td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a465">Real</a>&nbsp;</td>
509          <td class="mdname" nowrap> <em>x</em>, </td>
510        </tr>
511        <tr>
512          <td class="md" nowrap align="right"></td>
513          <td></td>
514          <td class="md" nowrap><a class="el" href="namespaceOgre.html#a465">Real</a>&nbsp;</td>
515          <td class="mdname" nowrap> <em>y</em></td>
516        </tr>
517        <tr>
518          <td></td>
519          <td class="md">)&nbsp;</td>
520          <td class="md" colspan="2"><code> [virtual]</code></td>
521        </tr>
522
523      </table>
524    </td>
525  </tr>
526</table>
527<table cellspacing=5 cellpadding=0 border=0>
528  <tr>
529    <td>
530      &nbsp;
531    </td>
532    <td>
533
534<p>
535This returns a <a class="el" href="classOgre_1_1OverlayElement.html">OverlayElement</a> at position x,y.
536<p>
537    </td>
538  </tr>
539</table>
540<a class="anchor" name="Ogre_1_1Overlaya30" doxytag="Ogre::Overlay::get2DElementsIterator" ></a><p>
541<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
542  <tr>
543    <td class="mdRow">
544      <table cellpadding="0" cellspacing="0" border="0">
545        <tr>
546          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1VectorIterator.html">Overlay2DElementsIterator</a> Ogre::Overlay::get2DElementsIterator </td>
547          <td class="md" valign="top">(&nbsp;</td>
548          <td class="mdname1" valign="top" nowrap>          </td>
549          <td class="md" valign="top">&nbsp;)&nbsp;</td>
550          <td class="md" nowrap></td>
551        </tr>
552
553      </table>
554    </td>
555  </tr>
556</table>
557<table cellspacing=5 cellpadding=0 border=0>
558  <tr>
559    <td>
560      &nbsp;
561    </td>
562    <td>
563
564<p>
565
566<p>
567Definition at line <a class="el" href="OgreOverlay_8h-source.html#l00260">260</a> of file <a class="el" href="OgreOverlay_8h-source.html">OgreOverlay.h</a>.
568<p>
569References <a class="el" href="OgreOverlay_8h-source.html#l00259">Overlay2DElementsIterator</a>.    </td>
570  </tr>
571</table>
572<a class="anchor" name="Ogre_1_1Overlaya2" doxytag="Ogre::Overlay::getChild" ></a><p>
573<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
574  <tr>
575    <td class="mdRow">
576      <table cellpadding="0" cellspacing="0" border="0">
577        <tr>
578          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1OverlayContainer.html">OverlayContainer</a>* Ogre::Overlay::getChild </td>
579          <td class="md" valign="top">(&nbsp;</td>
580          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;&nbsp;</td>
581          <td class="mdname1" valign="top" nowrap> <em>name</em>          </td>
582          <td class="md" valign="top">&nbsp;)&nbsp;</td>
583          <td class="md" nowrap></td>
584        </tr>
585
586      </table>
587    </td>
588  </tr>
589</table>
590<table cellspacing=5 cellpadding=0 border=0>
591  <tr>
592    <td>
593      &nbsp;
594    </td>
595    <td>
596
597<p>
598    </td>
599  </tr>
600</table>
601<a class="anchor" name="Ogre_1_1Overlaya3" doxytag="Ogre::Overlay::getName" ></a><p>
602<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
603  <tr>
604    <td class="mdRow">
605      <table cellpadding="0" cellspacing="0" border="0">
606        <tr>
607          <td class="md" nowrap valign="top"> const <a class="el" href="namespaceOgre.html#a471">String</a>&amp; Ogre::Overlay::getName </td>
608          <td class="md" valign="top">(&nbsp;</td>
609          <td class="md" nowrap valign="top">void&nbsp;</td>
610          <td class="mdname1" valign="top" nowrap>          </td>
611          <td class="md" valign="top">&nbsp;)&nbsp;</td>
612          <td class="md" nowrap> const</td>
613        </tr>
614
615      </table>
616    </td>
617  </tr>
618</table>
619<table cellspacing=5 cellpadding=0 border=0>
620  <tr>
621    <td>
622      &nbsp;
623    </td>
624    <td>
625
626<p>
627Gets the name of this overlay.
628<p>
629    </td>
630  </tr>
631</table>
632<a class="anchor" name="Ogre_1_1Overlaya31" doxytag="Ogre::Overlay::getOrigin" ></a><p>
633<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
634  <tr>
635    <td class="mdRow">
636      <table cellpadding="0" cellspacing="0" border="0">
637        <tr>
638          <td class="md" nowrap valign="top"> const <a class="el" href="namespaceOgre.html#a471">String</a>&amp; Ogre::Overlay::getOrigin </td>
639          <td class="md" valign="top">(&nbsp;</td>
640          <td class="md" nowrap valign="top">void&nbsp;</td>
641          <td class="mdname1" valign="top" nowrap>          </td>
642          <td class="md" valign="top">&nbsp;)&nbsp;</td>
643          <td class="md" nowrap> const</td>
644        </tr>
645
646      </table>
647    </td>
648  </tr>
649</table>
650<table cellspacing=5 cellpadding=0 border=0>
651  <tr>
652    <td>
653      &nbsp;
654    </td>
655    <td>
656
657<p>
658Get the origin of this overlay, e.g.
659<p>
660a script file name. <dl compact><dt><b>Remarks:</b></dt><dd>This property will only contain something if the creator of this overlay chose to populate it. Script loaders are advised to populate it.</dd></dl>
661
662<p>
663Definition at line <a class="el" href="OgreOverlay_8h-source.html#l00270">270</a> of file <a class="el" href="OgreOverlay_8h-source.html">OgreOverlay.h</a>.
664<p>
665References <a class="el" href="OgrePrerequisites_8h-source.html#l00156">Ogre::String</a>.    </td>
666  </tr>
667</table>
668<a class="anchor" name="Ogre_1_1Overlaya20" doxytag="Ogre::Overlay::getRotate" ></a><p>
669<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
670  <tr>
671    <td class="mdRow">
672      <table cellpadding="0" cellspacing="0" border="0">
673        <tr>
674          <td class="md" nowrap valign="top"> const <a class="el" href="classOgre_1_1Radian.html">Radian</a>&amp; Ogre::Overlay::getRotate </td>
675          <td class="md" valign="top">(&nbsp;</td>
676          <td class="md" nowrap valign="top">void&nbsp;</td>
677          <td class="mdname1" valign="top" nowrap>          </td>
678          <td class="md" valign="top">&nbsp;)&nbsp;</td>
679          <td class="md" nowrap> const</td>
680        </tr>
681
682      </table>
683    </td>
684  </tr>
685</table>
686<table cellspacing=5 cellpadding=0 border=0>
687  <tr>
688    <td>
689      &nbsp;
690    </td>
691    <td>
692
693<p>
694Gets the rotation applied to this overlay, in degrees.
695<p>
696
697<p>
698Definition at line <a class="el" href="OgreOverlay_8h-source.html#l00217">217</a> of file <a class="el" href="OgreOverlay_8h-source.html">OgreOverlay.h</a>.    </td>
699  </tr>
700</table>
701<a class="anchor" name="Ogre_1_1Overlaya23" doxytag="Ogre::Overlay::getScaleX" ></a><p>
702<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
703  <tr>
704    <td class="mdRow">
705      <table cellpadding="0" cellspacing="0" border="0">
706        <tr>
707          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a465">Real</a> Ogre::Overlay::getScaleX </td>
708          <td class="md" valign="top">(&nbsp;</td>
709          <td class="md" nowrap valign="top">void&nbsp;</td>
710          <td class="mdname1" valign="top" nowrap>          </td>
711          <td class="md" valign="top">&nbsp;)&nbsp;</td>
712          <td class="md" nowrap> const</td>
713        </tr>
714
715      </table>
716    </td>
717  </tr>
718</table>
719<table cellspacing=5 cellpadding=0 border=0>
720  <tr>
721    <td>
722      &nbsp;
723    </td>
724    <td>
725
726<p>
727Gets the current X scale value.
728<p>
729    </td>
730  </tr>
731</table>
732<a class="anchor" name="Ogre_1_1Overlaya24" doxytag="Ogre::Overlay::getScaleY" ></a><p>
733<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
734  <tr>
735    <td class="mdRow">
736      <table cellpadding="0" cellspacing="0" border="0">
737        <tr>
738          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a465">Real</a> Ogre::Overlay::getScaleY </td>
739          <td class="md" valign="top">(&nbsp;</td>
740          <td class="md" nowrap valign="top">void&nbsp;</td>
741          <td class="mdname1" valign="top" nowrap>          </td>
742          <td class="md" valign="top">&nbsp;)&nbsp;</td>
743          <td class="md" nowrap> const</td>
744        </tr>
745
746      </table>
747    </td>
748  </tr>
749</table>
750<table cellspacing=5 cellpadding=0 border=0>
751  <tr>
752    <td>
753      &nbsp;
754    </td>
755    <td>
756
757<p>
758Gets the current Y scale value.
759<p>
760    </td>
761  </tr>
762</table>
763<a class="anchor" name="Ogre_1_1Overlaya16" doxytag="Ogre::Overlay::getScrollX" ></a><p>
764<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
765  <tr>
766    <td class="mdRow">
767      <table cellpadding="0" cellspacing="0" border="0">
768        <tr>
769          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a465">Real</a> Ogre::Overlay::getScrollX </td>
770          <td class="md" valign="top">(&nbsp;</td>
771          <td class="md" nowrap valign="top">void&nbsp;</td>
772          <td class="mdname1" valign="top" nowrap>          </td>
773          <td class="md" valign="top">&nbsp;)&nbsp;</td>
774          <td class="md" nowrap> const</td>
775        </tr>
776
777      </table>
778    </td>
779  </tr>
780</table>
781<table cellspacing=5 cellpadding=0 border=0>
782  <tr>
783    <td>
784      &nbsp;
785    </td>
786    <td>
787
788<p>
789Gets the current X scroll value.
790<p>
791    </td>
792  </tr>
793</table>
794<a class="anchor" name="Ogre_1_1Overlaya17" doxytag="Ogre::Overlay::getScrollY" ></a><p>
795<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
796  <tr>
797    <td class="mdRow">
798      <table cellpadding="0" cellspacing="0" border="0">
799        <tr>
800          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a465">Real</a> Ogre::Overlay::getScrollY </td>
801          <td class="md" valign="top">(&nbsp;</td>
802          <td class="md" nowrap valign="top">void&nbsp;</td>
803          <td class="mdname1" valign="top" nowrap>          </td>
804          <td class="md" valign="top">&nbsp;)&nbsp;</td>
805          <td class="md" nowrap> const</td>
806        </tr>
807
808      </table>
809    </td>
810  </tr>
811</table>
812<table cellspacing=5 cellpadding=0 border=0>
813  <tr>
814    <td>
815      &nbsp;
816    </td>
817    <td>
818
819<p>
820Gets the current Y scroll value.
821<p>
822    </td>
823  </tr>
824</table>
825<a class="anchor" name="Ogre_1_1Overlaya26" doxytag="Ogre::Overlay::getWorldOrientation" ></a><p>
826<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
827  <tr>
828    <td class="mdRow">
829      <table cellpadding="0" cellspacing="0" border="0">
830        <tr>
831          <td class="md" nowrap valign="top"> const <a class="el" href="classOgre_1_1Quaternion.html">Quaternion</a>&amp; Ogre::Overlay::getWorldOrientation </td>
832          <td class="md" valign="top">(&nbsp;</td>
833          <td class="md" nowrap valign="top">void&nbsp;</td>
834          <td class="mdname1" valign="top" nowrap>          </td>
835          <td class="md" valign="top">&nbsp;)&nbsp;</td>
836          <td class="md" nowrap> const</td>
837        </tr>
838
839      </table>
840    </td>
841  </tr>
842</table>
843<table cellspacing=5 cellpadding=0 border=0>
844  <tr>
845    <td>
846      &nbsp;
847    </td>
848    <td>
849
850<p>
851 
852<p>
853    </td>
854  </tr>
855</table>
856<a class="anchor" name="Ogre_1_1Overlaya27" doxytag="Ogre::Overlay::getWorldPosition" ></a><p>
857<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
858  <tr>
859    <td class="mdRow">
860      <table cellpadding="0" cellspacing="0" border="0">
861        <tr>
862          <td class="md" nowrap valign="top"> const <a class="el" href="classOgre_1_1Vector3.html">Vector3</a>&amp; Ogre::Overlay::getWorldPosition </td>
863          <td class="md" valign="top">(&nbsp;</td>
864          <td class="md" nowrap valign="top">void&nbsp;</td>
865          <td class="mdname1" valign="top" nowrap>          </td>
866          <td class="md" valign="top">&nbsp;)&nbsp;</td>
867          <td class="md" nowrap> const</td>
868        </tr>
869
870      </table>
871    </td>
872  </tr>
873</table>
874<table cellspacing=5 cellpadding=0 border=0>
875  <tr>
876    <td>
877      &nbsp;
878    </td>
879    <td>
880
881<p>
882 
883<p>
884    </td>
885  </tr>
886</table>
887<a class="anchor" name="Ogre_1_1Overlaya5" doxytag="Ogre::Overlay::getZOrder" ></a><p>
888<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
889  <tr>
890    <td class="mdRow">
891      <table cellpadding="0" cellspacing="0" border="0">
892        <tr>
893          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a467">ushort</a> Ogre::Overlay::getZOrder </td>
894          <td class="md" valign="top">(&nbsp;</td>
895          <td class="md" nowrap valign="top">void&nbsp;</td>
896          <td class="mdname1" valign="top" nowrap>          </td>
897          <td class="md" valign="top">&nbsp;)&nbsp;</td>
898          <td class="md" nowrap> const</td>
899        </tr>
900
901      </table>
902    </td>
903  </tr>
904</table>
905<table cellspacing=5 cellpadding=0 border=0>
906  <tr>
907    <td>
908      &nbsp;
909    </td>
910    <td>
911
912<p>
913Gets the ZOrder of this overlay.
914<p>
915    </td>
916  </tr>
917</table>
918<a class="anchor" name="Ogre_1_1Overlaya9" doxytag="Ogre::Overlay::hide" ></a><p>
919<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
920  <tr>
921    <td class="mdRow">
922      <table cellpadding="0" cellspacing="0" border="0">
923        <tr>
924          <td class="md" nowrap valign="top"> void Ogre::Overlay::hide </td>
925          <td class="md" valign="top">(&nbsp;</td>
926          <td class="md" nowrap valign="top">void&nbsp;</td>
927          <td class="mdname1" valign="top" nowrap>          </td>
928          <td class="md" valign="top">&nbsp;)&nbsp;</td>
929          <td class="md" nowrap></td>
930        </tr>
931
932      </table>
933    </td>
934  </tr>
935</table>
936<table cellspacing=5 cellpadding=0 border=0>
937  <tr>
938    <td>
939      &nbsp;
940    </td>
941    <td>
942
943<p>
944Hides the overlay if it was visible.
945<p>
946    </td>
947  </tr>
948</table>
949<a class="anchor" name="Ogre_1_1Overlayb1" doxytag="Ogre::Overlay::initialise" ></a><p>
950<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
951  <tr>
952    <td class="mdRow">
953      <table cellpadding="0" cellspacing="0" border="0">
954        <tr>
955          <td class="md" nowrap valign="top"> void Ogre::Overlay::initialise </td>
956          <td class="md" valign="top">(&nbsp;</td>
957          <td class="md" nowrap valign="top">void&nbsp;</td>
958          <td class="mdname1" valign="top" nowrap>          </td>
959          <td class="md" valign="top">&nbsp;)&nbsp;</td>
960          <td class="md" nowrap><code> [protected]</code></td>
961        </tr>
962
963      </table>
964    </td>
965  </tr>
966</table>
967<table cellspacing=5 cellpadding=0 border=0>
968  <tr>
969    <td>
970      &nbsp;
971    </td>
972    <td>
973
974<p>
975Internal method for initialising an overlay.
976<p>
977    </td>
978  </tr>
979</table>
980<a class="anchor" name="Ogre_1_1Overlaya7" doxytag="Ogre::Overlay::isInitialised" ></a><p>
981<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
982  <tr>
983    <td class="mdRow">
984      <table cellpadding="0" cellspacing="0" border="0">
985        <tr>
986          <td class="md" nowrap valign="top"> bool Ogre::Overlay::isInitialised </td>
987          <td class="md" valign="top">(&nbsp;</td>
988          <td class="md" nowrap valign="top">void&nbsp;</td>
989          <td class="mdname1" valign="top" nowrap>          </td>
990          <td class="md" valign="top">&nbsp;)&nbsp;</td>
991          <td class="md" nowrap> const</td>
992        </tr>
993
994      </table>
995    </td>
996  </tr>
997</table>
998<table cellspacing=5 cellpadding=0 border=0>
999  <tr>
1000    <td>
1001      &nbsp;
1002    </td>
1003    <td>
1004
1005<p>
1006Gets whether the overlay is initialised or not.
1007<p>
1008
1009<p>
1010Definition at line <a class="el" href="OgreOverlay_8h-source.html#l00116">116</a> of file <a class="el" href="OgreOverlay_8h-source.html">OgreOverlay.h</a>.    </td>
1011  </tr>
1012</table>
1013<a class="anchor" name="Ogre_1_1Overlaya6" doxytag="Ogre::Overlay::isVisible" ></a><p>
1014<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1015  <tr>
1016    <td class="mdRow">
1017      <table cellpadding="0" cellspacing="0" border="0">
1018        <tr>
1019          <td class="md" nowrap valign="top"> bool Ogre::Overlay::isVisible </td>
1020          <td class="md" valign="top">(&nbsp;</td>
1021          <td class="md" nowrap valign="top">void&nbsp;</td>
1022          <td class="mdname1" valign="top" nowrap>          </td>
1023          <td class="md" valign="top">&nbsp;)&nbsp;</td>
1024          <td class="md" nowrap> const</td>
1025        </tr>
1026
1027      </table>
1028    </td>
1029  </tr>
1030</table>
1031<table cellspacing=5 cellpadding=0 border=0>
1032  <tr>
1033    <td>
1034      &nbsp;
1035    </td>
1036    <td>
1037
1038<p>
1039Gets whether the overlay is displayed or not.
1040<p>
1041    </td>
1042  </tr>
1043</table>
1044<a class="anchor" name="Ogre_1_1Overlaya11" doxytag="Ogre::Overlay::remove2D" ></a><p>
1045<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1046  <tr>
1047    <td class="mdRow">
1048      <table cellpadding="0" cellspacing="0" border="0">
1049        <tr>
1050          <td class="md" nowrap valign="top"> void Ogre::Overlay::remove2D </td>
1051          <td class="md" valign="top">(&nbsp;</td>
1052          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1OverlayContainer.html">OverlayContainer</a> *&nbsp;</td>
1053          <td class="mdname1" valign="top" nowrap> <em>cont</em>          </td>
1054          <td class="md" valign="top">&nbsp;)&nbsp;</td>
1055          <td class="md" nowrap></td>
1056        </tr>
1057
1058      </table>
1059    </td>
1060  </tr>
1061</table>
1062<table cellspacing=5 cellpadding=0 border=0>
1063  <tr>
1064    <td>
1065      &nbsp;
1066    </td>
1067    <td>
1068
1069<p>
1070Removes a 2D container from the overlay.
1071<p>
1072<dl compact><dt><b>Remarks:</b></dt><dd>NOT FAST. Consider <a class="el" href="classOgre_1_1OverlayElement.html#Ogre_1_1TextAreaOverlayElementa26">OverlayElement::hide</a>. </dd></dl>
1073    </td>
1074  </tr>
1075</table>
1076<a class="anchor" name="Ogre_1_1Overlaya13" doxytag="Ogre::Overlay::remove3D" ></a><p>
1077<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1078  <tr>
1079    <td class="mdRow">
1080      <table cellpadding="0" cellspacing="0" border="0">
1081        <tr>
1082          <td class="md" nowrap valign="top"> void Ogre::Overlay::remove3D </td>
1083          <td class="md" valign="top">(&nbsp;</td>
1084          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1SceneNode.html">SceneNode</a> *&nbsp;</td>
1085          <td class="mdname1" valign="top" nowrap> <em>node</em>          </td>
1086          <td class="md" valign="top">&nbsp;)&nbsp;</td>
1087          <td class="md" nowrap></td>
1088        </tr>
1089
1090      </table>
1091    </td>
1092  </tr>
1093</table>
1094<table cellspacing=5 cellpadding=0 border=0>
1095  <tr>
1096    <td>
1097      &nbsp;
1098    </td>
1099    <td>
1100
1101<p>
1102Removes a 3D element from the overlay.
1103<p>
1104    </td>
1105  </tr>
1106</table>
1107<a class="anchor" name="Ogre_1_1Overlaya21" doxytag="Ogre::Overlay::rotate" ></a><p>
1108<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1109  <tr>
1110    <td class="mdRow">
1111      <table cellpadding="0" cellspacing="0" border="0">
1112        <tr>
1113          <td class="md" nowrap valign="top"> void Ogre::Overlay::rotate </td>
1114          <td class="md" valign="top">(&nbsp;</td>
1115          <td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1Radian.html">Radian</a> &amp;&nbsp;</td>
1116          <td class="mdname1" valign="top" nowrap> <em>angle</em>          </td>
1117          <td class="md" valign="top">&nbsp;)&nbsp;</td>
1118          <td class="md" nowrap></td>
1119        </tr>
1120
1121      </table>
1122    </td>
1123  </tr>
1124</table>
1125<table cellspacing=5 cellpadding=0 border=0>
1126  <tr>
1127    <td>
1128      &nbsp;
1129    </td>
1130    <td>
1131
1132<p>
1133Adds the passed in angle to the rotation applied to this overlay.
1134<p>
1135    </td>
1136  </tr>
1137</table>
1138<a class="anchor" name="Ogre_1_1Overlaya18" doxytag="Ogre::Overlay::scroll" ></a><p>
1139<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1140  <tr>
1141    <td class="mdRow">
1142      <table cellpadding="0" cellspacing="0" border="0">
1143        <tr>
1144          <td class="md" nowrap valign="top"> void Ogre::Overlay::scroll </td>
1145          <td class="md" valign="top">(&nbsp;</td>
1146          <td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a465">Real</a>&nbsp;</td>
1147          <td class="mdname" nowrap> <em>xoff</em>, </td>
1148        </tr>
1149        <tr>
1150          <td class="md" nowrap align="right"></td>
1151          <td></td>
1152          <td class="md" nowrap><a class="el" href="namespaceOgre.html#a465">Real</a>&nbsp;</td>
1153          <td class="mdname" nowrap> <em>yoff</em></td>
1154        </tr>
1155        <tr>
1156          <td></td>
1157          <td class="md">)&nbsp;</td>
1158          <td class="md" colspan="2"></td>
1159        </tr>
1160
1161      </table>
1162    </td>
1163  </tr>
1164</table>
1165<table cellspacing=5 cellpadding=0 border=0>
1166  <tr>
1167    <td>
1168      &nbsp;
1169    </td>
1170    <td>
1171
1172<p>
1173Scrolls the overlay by the offsets provided.
1174<p>
1175<dl compact><dt><b>Remarks:</b></dt><dd>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. </dd></dl>
1176    </td>
1177  </tr>
1178</table>
1179<a class="anchor" name="Ogre_1_1Overlaya19" doxytag="Ogre::Overlay::setRotate" ></a><p>
1180<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1181  <tr>
1182    <td class="mdRow">
1183      <table cellpadding="0" cellspacing="0" border="0">
1184        <tr>
1185          <td class="md" nowrap valign="top"> void Ogre::Overlay::setRotate </td>
1186          <td class="md" valign="top">(&nbsp;</td>
1187          <td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1Radian.html">Radian</a> &amp;&nbsp;</td>
1188          <td class="mdname1" valign="top" nowrap> <em>angle</em>          </td>
1189          <td class="md" valign="top">&nbsp;)&nbsp;</td>
1190          <td class="md" nowrap></td>
1191        </tr>
1192
1193      </table>
1194    </td>
1195  </tr>
1196</table>
1197<table cellspacing=5 cellpadding=0 border=0>
1198  <tr>
1199    <td>
1200      &nbsp;
1201    </td>
1202    <td>
1203
1204<p>
1205Sets the rotation applied to this overlay.
1206<p>
1207    </td>
1208  </tr>
1209</table>
1210<a class="anchor" name="Ogre_1_1Overlaya22" doxytag="Ogre::Overlay::setScale" ></a><p>
1211<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1212  <tr>
1213    <td class="mdRow">
1214      <table cellpadding="0" cellspacing="0" border="0">
1215        <tr>
1216          <td class="md" nowrap valign="top"> void Ogre::Overlay::setScale </td>
1217          <td class="md" valign="top">(&nbsp;</td>
1218          <td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a465">Real</a>&nbsp;</td>
1219          <td class="mdname" nowrap> <em>x</em>, </td>
1220        </tr>
1221        <tr>
1222          <td class="md" nowrap align="right"></td>
1223          <td></td>
1224          <td class="md" nowrap><a class="el" href="namespaceOgre.html#a465">Real</a>&nbsp;</td>
1225          <td class="mdname" nowrap> <em>y</em></td>
1226        </tr>
1227        <tr>
1228          <td></td>
1229          <td class="md">)&nbsp;</td>
1230          <td class="md" colspan="2"></td>
1231        </tr>
1232
1233      </table>
1234    </td>
1235  </tr>
1236</table>
1237<table cellspacing=5 cellpadding=0 border=0>
1238  <tr>
1239    <td>
1240      &nbsp;
1241    </td>
1242    <td>
1243
1244<p>
1245Sets the scaling factor of this overlay.
1246<p>
1247<dl compact><dt><b>Remarks:</b></dt><dd>You can use this to set an scale factor to be used to zoom an overlay. </dd></dl>
1248<dl compact><dt><b>Parameters:</b></dt><dd>
1249  <table border="0" cellspacing="2" cellpadding="0">
1250    <tr><td valign=top><em>x</em>&nbsp;</td><td>Horizontal scale value, where 1.0 = normal, 0.5 = half size etc </td></tr>
1251    <tr><td valign=top><em>y</em>&nbsp;</td><td>Vertical scale value, where 1.0 = normal, 0.5 = half size etc </td></tr>
1252  </table>
1253</dl>
1254    </td>
1255  </tr>
1256</table>
1257<a class="anchor" name="Ogre_1_1Overlaya15" doxytag="Ogre::Overlay::setScroll" ></a><p>
1258<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1259  <tr>
1260    <td class="mdRow">
1261      <table cellpadding="0" cellspacing="0" border="0">
1262        <tr>
1263          <td class="md" nowrap valign="top"> void Ogre::Overlay::setScroll </td>
1264          <td class="md" valign="top">(&nbsp;</td>
1265          <td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a465">Real</a>&nbsp;</td>
1266          <td class="mdname" nowrap> <em>x</em>, </td>
1267        </tr>
1268        <tr>
1269          <td class="md" nowrap align="right"></td>
1270          <td></td>
1271          <td class="md" nowrap><a class="el" href="namespaceOgre.html#a465">Real</a>&nbsp;</td>
1272          <td class="mdname" nowrap> <em>y</em></td>
1273        </tr>
1274        <tr>
1275          <td></td>
1276          <td class="md">)&nbsp;</td>
1277          <td class="md" colspan="2"></td>
1278        </tr>
1279
1280      </table>
1281    </td>
1282  </tr>
1283</table>
1284<table cellspacing=5 cellpadding=0 border=0>
1285  <tr>
1286    <td>
1287      &nbsp;
1288    </td>
1289    <td>
1290
1291<p>
1292Sets the scrolling factor of this overlay.
1293<p>
1294<dl compact><dt><b>Remarks:</b></dt><dd>You can use this to set an offset to be used to scroll an overlay around the screen. </dd></dl>
1295<dl compact><dt><b>Parameters:</b></dt><dd>
1296  <table border="0" cellspacing="2" cellpadding="0">
1297    <tr><td valign=top><em>x</em>&nbsp;</td><td>Horizontal scroll value, where 0 = normal, -0.5 = scroll so that only the right half the screen is visible etc </td></tr>
1298    <tr><td valign=top><em>y</em>&nbsp;</td><td>Vertical scroll value, where 0 = normal, 0.5 = scroll down by half a screen etc. </td></tr>
1299  </table>
1300</dl>
1301    </td>
1302  </tr>
1303</table>
1304<a class="anchor" name="Ogre_1_1Overlaya4" doxytag="Ogre::Overlay::setZOrder" ></a><p>
1305<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1306  <tr>
1307    <td class="mdRow">
1308      <table cellpadding="0" cellspacing="0" border="0">
1309        <tr>
1310          <td class="md" nowrap valign="top"> void Ogre::Overlay::setZOrder </td>
1311          <td class="md" valign="top">(&nbsp;</td>
1312          <td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a467">ushort</a>&nbsp;</td>
1313          <td class="mdname1" valign="top" nowrap> <em>zorder</em>          </td>
1314          <td class="md" valign="top">&nbsp;)&nbsp;</td>
1315          <td class="md" nowrap></td>
1316        </tr>
1317
1318      </table>
1319    </td>
1320  </tr>
1321</table>
1322<table cellspacing=5 cellpadding=0 border=0>
1323  <tr>
1324    <td>
1325      &nbsp;
1326    </td>
1327    <td>
1328
1329<p>
1330Alters the ZOrder of this overlay.
1331<p>
1332<dl compact><dt><b>Remarks:</b></dt><dd>Values between 0 and 650 are valid here. </dd></dl>
1333    </td>
1334  </tr>
1335</table>
1336<a class="anchor" name="Ogre_1_1Overlaya8" doxytag="Ogre::Overlay::show" ></a><p>
1337<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1338  <tr>
1339    <td class="mdRow">
1340      <table cellpadding="0" cellspacing="0" border="0">
1341        <tr>
1342          <td class="md" nowrap valign="top"> void Ogre::Overlay::show </td>
1343          <td class="md" valign="top">(&nbsp;</td>
1344          <td class="md" nowrap valign="top">void&nbsp;</td>
1345          <td class="mdname1" valign="top" nowrap>          </td>
1346          <td class="md" valign="top">&nbsp;)&nbsp;</td>
1347          <td class="md" nowrap></td>
1348        </tr>
1349
1350      </table>
1351    </td>
1352  </tr>
1353</table>
1354<table cellspacing=5 cellpadding=0 border=0>
1355  <tr>
1356    <td>
1357      &nbsp;
1358    </td>
1359    <td>
1360
1361<p>
1362Shows the overlay if it was hidden.
1363<p>
1364    </td>
1365  </tr>
1366</table>
1367<a class="anchor" name="Ogre_1_1Overlayb0" doxytag="Ogre::Overlay::updateTransform" ></a><p>
1368<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1369  <tr>
1370    <td class="mdRow">
1371      <table cellpadding="0" cellspacing="0" border="0">
1372        <tr>
1373          <td class="md" nowrap valign="top"> void Ogre::Overlay::updateTransform </td>
1374          <td class="md" valign="top">(&nbsp;</td>
1375          <td class="md" nowrap valign="top">void&nbsp;</td>
1376          <td class="mdname1" valign="top" nowrap>          </td>
1377          <td class="md" valign="top">&nbsp;)&nbsp;</td>
1378          <td class="md" nowrap> const<code> [protected]</code></td>
1379        </tr>
1380
1381      </table>
1382    </td>
1383  </tr>
1384</table>
1385<table cellspacing=5 cellpadding=0 border=0>
1386  <tr>
1387    <td>
1388      &nbsp;
1389    </td>
1390    <td>
1391
1392<p>
1393Internal lazy update method.
1394<p>
1395    </td>
1396  </tr>
1397</table>
1398<hr><h2>Member Data Documentation</h2>
1399<a class="anchor" name="Ogre_1_1Overlayp2" doxytag="Ogre::Overlay::m2DElements" ></a><p>
1400<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1401  <tr>
1402    <td class="mdRow">
1403      <table cellpadding="0" cellspacing="0" border="0">
1404        <tr>
1405          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1Overlay.html#Ogre_1_1Overlayw0">OverlayContainerList</a> <a class="el" href="classOgre_1_1Overlay.html#Ogre_1_1Overlayp2">Ogre::Overlay::m2DElements</a><code> [protected]</code>
1406      </table>
1407    </td>
1408  </tr>
1409</table>
1410<table cellspacing=5 cellpadding=0 border=0>
1411  <tr>
1412    <td>
1413      &nbsp;
1414    </td>
1415    <td>
1416
1417<p>
1418
1419<p>
1420Definition at line <a class="el" href="OgreOverlay_8h-source.html#l00073">73</a> of file <a class="el" href="OgreOverlay_8h-source.html">OgreOverlay.h</a>.    </td>
1421  </tr>
1422</table>
1423<a class="anchor" name="Ogre_1_1Overlayp13" doxytag="Ogre::Overlay::mInitialised" ></a><p>
1424<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1425  <tr>
1426    <td class="mdRow">
1427      <table cellpadding="0" cellspacing="0" border="0">
1428        <tr>
1429          <td class="md" nowrap valign="top"> bool <a class="el" href="classOgre_1_1Overlay.html#Ogre_1_1Overlayp13">Ogre::Overlay::mInitialised</a><code> [protected]</code>
1430      </table>
1431    </td>
1432  </tr>
1433</table>
1434<table cellspacing=5 cellpadding=0 border=0>
1435  <tr>
1436    <td>
1437      &nbsp;
1438    </td>
1439    <td>
1440
1441<p>
1442
1443<p>
1444Definition at line <a class="el" href="OgreOverlay_8h-source.html#l00087">87</a> of file <a class="el" href="OgreOverlay_8h-source.html">OgreOverlay.h</a>.    </td>
1445  </tr>
1446</table>
1447<a class="anchor" name="Ogre_1_1Overlayp0" doxytag="Ogre::Overlay::mName" ></a><p>
1448<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1449  <tr>
1450    <td class="mdRow">
1451      <table cellpadding="0" cellspacing="0" border="0">
1452        <tr>
1453          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a471">String</a> <a class="el" href="classOgre_1_1Overlay.html#Ogre_1_1Overlayp0">Ogre::Overlay::mName</a><code> [protected]</code>
1454      </table>
1455    </td>
1456  </tr>
1457</table>
1458<table cellspacing=5 cellpadding=0 border=0>
1459  <tr>
1460    <td>
1461      &nbsp;
1462    </td>
1463    <td>
1464
1465<p>
1466
1467<p>
1468Definition at line <a class="el" href="OgreOverlay_8h-source.html#l00067">67</a> of file <a class="el" href="OgreOverlay_8h-source.html">OgreOverlay.h</a>.    </td>
1469  </tr>
1470</table>
1471<a class="anchor" name="Ogre_1_1Overlayp14" doxytag="Ogre::Overlay::mOrigin" ></a><p>
1472<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1473  <tr>
1474    <td class="mdRow">
1475      <table cellpadding="0" cellspacing="0" border="0">
1476        <tr>
1477          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a471">String</a> <a class="el" href="classOgre_1_1Overlay.html#Ogre_1_1Overlayp14">Ogre::Overlay::mOrigin</a><code> [protected]</code>
1478      </table>
1479    </td>
1480  </tr>
1481</table>
1482<table cellspacing=5 cellpadding=0 border=0>
1483  <tr>
1484    <td>
1485      &nbsp;
1486    </td>
1487    <td>
1488
1489<p>
1490
1491<p>
1492Definition at line <a class="el" href="OgreOverlay_8h-source.html#l00088">88</a> of file <a class="el" href="OgreOverlay_8h-source.html">OgreOverlay.h</a>.    </td>
1493  </tr>
1494</table>
1495<a class="anchor" name="Ogre_1_1Overlayp1" doxytag="Ogre::Overlay::mRootNode" ></a><p>
1496<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1497  <tr>
1498    <td class="mdRow">
1499      <table cellpadding="0" cellspacing="0" border="0">
1500        <tr>
1501          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1SceneNode.html">SceneNode</a>* <a class="el" href="classOgre_1_1Overlay.html#Ogre_1_1Overlayp1">Ogre::Overlay::mRootNode</a><code> [protected]</code>
1502      </table>
1503    </td>
1504  </tr>
1505</table>
1506<table cellspacing=5 cellpadding=0 border=0>
1507  <tr>
1508    <td>
1509      &nbsp;
1510    </td>
1511    <td>
1512
1513<p>
1514Internal root node, used as parent for 3D objects.
1515<p>
1516
1517<p>
1518Definition at line <a class="el" href="OgreOverlay_8h-source.html#l00069">69</a> of file <a class="el" href="OgreOverlay_8h-source.html">OgreOverlay.h</a>.    </td>
1519  </tr>
1520</table>
1521<a class="anchor" name="Ogre_1_1Overlayp3" doxytag="Ogre::Overlay::mRotate" ></a><p>
1522<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1523  <tr>
1524    <td class="mdRow">
1525      <table cellpadding="0" cellspacing="0" border="0">
1526        <tr>
1527          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1Radian.html">Radian</a> <a class="el" href="classOgre_1_1Overlay.html#Ogre_1_1Overlayp3">Ogre::Overlay::mRotate</a><code> [protected]</code>
1528      </table>
1529    </td>
1530  </tr>
1531</table>
1532<table cellspacing=5 cellpadding=0 border=0>
1533  <tr>
1534    <td>
1535      &nbsp;
1536    </td>
1537    <td>
1538
1539<p>
1540
1541<p>
1542Definition at line <a class="el" href="OgreOverlay_8h-source.html#l00076">76</a> of file <a class="el" href="OgreOverlay_8h-source.html">OgreOverlay.h</a>.    </td>
1543  </tr>
1544</table>
1545<a class="anchor" name="Ogre_1_1Overlayp6" doxytag="Ogre::Overlay::mScaleX" ></a><p>
1546<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1547  <tr>
1548    <td class="mdRow">
1549      <table cellpadding="0" cellspacing="0" border="0">
1550        <tr>
1551          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a465">Real</a> <a class="el" href="classOgre_1_1Overlay.html#Ogre_1_1Overlayp6">Ogre::Overlay::mScaleX</a><code> [protected]</code>
1552      </table>
1553    </td>
1554  </tr>
1555</table>
1556<table cellspacing=5 cellpadding=0 border=0>
1557  <tr>
1558    <td>
1559      &nbsp;
1560    </td>
1561    <td>
1562
1563<p>
1564
1565<p>
1566Definition at line <a class="el" href="OgreOverlay_8h-source.html#l00080">80</a> of file <a class="el" href="OgreOverlay_8h-source.html">OgreOverlay.h</a>.    </td>
1567  </tr>
1568</table>
1569<a class="anchor" name="Ogre_1_1Overlayp7" doxytag="Ogre::Overlay::mScaleY" ></a><p>
1570<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1571  <tr>
1572    <td class="mdRow">
1573      <table cellpadding="0" cellspacing="0" border="0">
1574        <tr>
1575          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a465">Real</a> <a class="el" href="classOgre_1_1Overlay.html#Ogre_1_1Overlayp7">Ogre::Overlay::mScaleY</a><code> [protected]</code>
1576      </table>
1577    </td>
1578  </tr>
1579</table>
1580<table cellspacing=5 cellpadding=0 border=0>
1581  <tr>
1582    <td>
1583      &nbsp;
1584    </td>
1585    <td>
1586
1587<p>
1588
1589<p>
1590Definition at line <a class="el" href="OgreOverlay_8h-source.html#l00080">80</a> of file <a class="el" href="OgreOverlay_8h-source.html">OgreOverlay.h</a>.    </td>
1591  </tr>
1592</table>
1593<a class="anchor" name="Ogre_1_1Overlayp4" doxytag="Ogre::Overlay::mScrollX" ></a><p>
1594<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1595  <tr>
1596    <td class="mdRow">
1597      <table cellpadding="0" cellspacing="0" border="0">
1598        <tr>
1599          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a465">Real</a> <a class="el" href="classOgre_1_1Overlay.html#Ogre_1_1Overlayp4">Ogre::Overlay::mScrollX</a><code> [protected]</code>
1600      </table>
1601    </td>
1602  </tr>
1603</table>
1604<table cellspacing=5 cellpadding=0 border=0>
1605  <tr>
1606    <td>
1607      &nbsp;
1608    </td>
1609    <td>
1610
1611<p>
1612
1613<p>
1614Definition at line <a class="el" href="OgreOverlay_8h-source.html#l00078">78</a> of file <a class="el" href="OgreOverlay_8h-source.html">OgreOverlay.h</a>.    </td>
1615  </tr>
1616</table>
1617<a class="anchor" name="Ogre_1_1Overlayp5" doxytag="Ogre::Overlay::mScrollY" ></a><p>
1618<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1619  <tr>
1620    <td class="mdRow">
1621      <table cellpadding="0" cellspacing="0" border="0">
1622        <tr>
1623          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a465">Real</a> <a class="el" href="classOgre_1_1Overlay.html#Ogre_1_1Overlayp5">Ogre::Overlay::mScrollY</a><code> [protected]</code>
1624      </table>
1625    </td>
1626  </tr>
1627</table>
1628<table cellspacing=5 cellpadding=0 border=0>
1629  <tr>
1630    <td>
1631      &nbsp;
1632    </td>
1633    <td>
1634
1635<p>
1636
1637<p>
1638Definition at line <a class="el" href="OgreOverlay_8h-source.html#l00078">78</a> of file <a class="el" href="OgreOverlay_8h-source.html">OgreOverlay.h</a>.    </td>
1639  </tr>
1640</table>
1641<a class="anchor" name="Ogre_1_1Overlayp8" doxytag="Ogre::Overlay::mTransform" ></a><p>
1642<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1643  <tr>
1644    <td class="mdRow">
1645      <table cellpadding="0" cellspacing="0" border="0">
1646        <tr>
1647          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1Matrix4.html">Matrix4</a> <a class="el" href="classOgre_1_1Overlay.html#Ogre_1_1Overlayp8">Ogre::Overlay::mTransform</a><code> [mutable, protected]</code>
1648      </table>
1649    </td>
1650  </tr>
1651</table>
1652<table cellspacing=5 cellpadding=0 border=0>
1653  <tr>
1654    <td>
1655      &nbsp;
1656    </td>
1657    <td>
1658
1659<p>
1660
1661<p>
1662Definition at line <a class="el" href="OgreOverlay_8h-source.html#l00082">82</a> of file <a class="el" href="OgreOverlay_8h-source.html">OgreOverlay.h</a>.    </td>
1663  </tr>
1664</table>
1665<a class="anchor" name="Ogre_1_1Overlayp9" doxytag="Ogre::Overlay::mTransformOutOfDate" ></a><p>
1666<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1667  <tr>
1668    <td class="mdRow">
1669      <table cellpadding="0" cellspacing="0" border="0">
1670        <tr>
1671          <td class="md" nowrap valign="top"> bool <a class="el" href="classOgre_1_1Overlay.html#Ogre_1_1Overlayp9">Ogre::Overlay::mTransformOutOfDate</a><code> [mutable, protected]</code>
1672      </table>
1673    </td>
1674  </tr>
1675</table>
1676<table cellspacing=5 cellpadding=0 border=0>
1677  <tr>
1678    <td>
1679      &nbsp;
1680    </td>
1681    <td>
1682
1683<p>
1684
1685<p>
1686Definition at line <a class="el" href="OgreOverlay_8h-source.html#l00083">83</a> of file <a class="el" href="OgreOverlay_8h-source.html">OgreOverlay.h</a>.    </td>
1687  </tr>
1688</table>
1689<a class="anchor" name="Ogre_1_1Overlayp10" doxytag="Ogre::Overlay::mTransformUpdated" ></a><p>
1690<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1691  <tr>
1692    <td class="mdRow">
1693      <table cellpadding="0" cellspacing="0" border="0">
1694        <tr>
1695          <td class="md" nowrap valign="top"> bool <a class="el" href="classOgre_1_1Overlay.html#Ogre_1_1Overlayp10">Ogre::Overlay::mTransformUpdated</a><code> [protected]</code>
1696      </table>
1697    </td>
1698  </tr>
1699</table>
1700<table cellspacing=5 cellpadding=0 border=0>
1701  <tr>
1702    <td>
1703      &nbsp;
1704    </td>
1705    <td>
1706
1707<p>
1708
1709<p>
1710Definition at line <a class="el" href="OgreOverlay_8h-source.html#l00084">84</a> of file <a class="el" href="OgreOverlay_8h-source.html">OgreOverlay.h</a>.    </td>
1711  </tr>
1712</table>
1713<a class="anchor" name="Ogre_1_1Overlayp12" doxytag="Ogre::Overlay::mVisible" ></a><p>
1714<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1715  <tr>
1716    <td class="mdRow">
1717      <table cellpadding="0" cellspacing="0" border="0">
1718        <tr>
1719          <td class="md" nowrap valign="top"> bool <a class="el" href="classOgre_1_1Overlay.html#Ogre_1_1Overlayp12">Ogre::Overlay::mVisible</a><code> [protected]</code>
1720      </table>
1721    </td>
1722  </tr>
1723</table>
1724<table cellspacing=5 cellpadding=0 border=0>
1725  <tr>
1726    <td>
1727      &nbsp;
1728    </td>
1729    <td>
1730
1731<p>
1732
1733<p>
1734Definition at line <a class="el" href="OgreOverlay_8h-source.html#l00086">86</a> of file <a class="el" href="OgreOverlay_8h-source.html">OgreOverlay.h</a>.    </td>
1735  </tr>
1736</table>
1737<a class="anchor" name="Ogre_1_1Overlayp11" doxytag="Ogre::Overlay::mZOrder" ></a><p>
1738<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1739  <tr>
1740    <td class="mdRow">
1741      <table cellpadding="0" cellspacing="0" border="0">
1742        <tr>
1743          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a469">ulong</a> <a class="el" href="classOgre_1_1Overlay.html#Ogre_1_1Overlayp11">Ogre::Overlay::mZOrder</a><code> [protected]</code>
1744      </table>
1745    </td>
1746  </tr>
1747</table>
1748<table cellspacing=5 cellpadding=0 border=0>
1749  <tr>
1750    <td>
1751      &nbsp;
1752    </td>
1753    <td>
1754
1755<p>
1756
1757<p>
1758Definition at line <a class="el" href="OgreOverlay_8h-source.html#l00085">85</a> of file <a class="el" href="OgreOverlay_8h-source.html">OgreOverlay.h</a>.    </td>
1759  </tr>
1760</table>
1761<hr>The documentation for this class was generated from the following file:<ul>
1762<li><a class="el" href="OgreOverlay_8h-source.html">OgreOverlay.h</a></ul>
1763<hr>
1764<p>
1765Copyright &copy; 2000-2005 by The OGRE Team<br />
1766<!--Creative Commons License--><a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/"><img alt="Creative Commons License" border="0" src="http://creativecommons.org/images/public/somerights20.png"/></a><br/>
1767This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/">Creative Commons Attribution-ShareAlike 2.5 License</a>.<br/>
1768                <!--/Creative Commons License--><!-- <rdf:RDF xmlns="http://web.resource.org/cc/" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
1769                <Work rdf:about="">
1770                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
1771        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
1772                </Work>
1773                <License rdf:about="http://creativecommons.org/licenses/by-sa/2.5/"><permits rdf:resource="http://web.resource.org/cc/Reproduction"/><permits rdf:resource="http://web.resource.org/cc/Distribution"/><requires rdf:resource="http://web.resource.org/cc/Notice"/><requires rdf:resource="http://web.resource.org/cc/Attribution"/><permits rdf:resource="http://web.resource.org/cc/DerivativeWorks"/><requires rdf:resource="http://web.resource.org/cc/ShareAlike"/></License></rdf:RDF> -->
1774
1775Last modified Sun Mar 12 14:40:41 2006
1776</p>
1777</body>
1778</html>
Note: See TracBrowser for help on using the repository browser.