1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Crazy Eddies GUI System: CEGUI::BaseDim Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.4 -->
<script type="text/javascript">
function hasClass(ele,cls) {
return ele.className.match(new RegExp('(\\s|^)'+cls+'(\\s|$)'));
}
function addClass(ele,cls) {
if (!this.hasClass(ele,cls)) ele.className += " "+cls;
}
function removeClass(ele,cls) {
if (hasClass(ele,cls)) {
var reg = new RegExp('(\\s|^)'+cls+'(\\s|$)');
ele.className=ele.className.replace(reg,' ');
}
}
function toggleVisibility(linkObj) {
var base = linkObj.getAttribute('id');
var summary = document.getElementById(base + '-summary');
var content = document.getElementById(base + '-content');
var trigger = document.getElementById(base + '-trigger');
if ( hasClass(linkObj,'closed') ) {
summary.style.display = 'none';
content.style.display = 'block';
trigger.src = 'open.png';
removeClass(linkObj,'closed');
addClass(linkObj,'opened');
} else if ( hasClass(linkObj,'opened') ) {
summary.style.display = 'block';
content.style.display = 'none';
trigger.src = 'closed.png';
removeClass(linkObj,'opened');
addClass(linkObj,'closed');
}
return false;
}
</script>
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Crazy Eddies GUI System <span id="projectnumber">0.7.6</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceCEGUI.html">CEGUI</a> </li>
<li class="navelem"><a class="el" href="classCEGUI_1_1BaseDim.html">BaseDim</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> </div>
<div class="headertitle">
<div class="title">CEGUI::BaseDim Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::BaseDim" -->
<p>Abstract interface for a generic 'dimension' class.
<a href="classCEGUI_1_1BaseDim.html#details">More...</a></p>
<p>Inherited by <a class="el" href="classCEGUI_1_1AbsoluteDim.html">CEGUI::AbsoluteDim</a>, <a class="el" href="classCEGUI_1_1FontDim.html">CEGUI::FontDim</a>, <a class="el" href="classCEGUI_1_1ImageDim.html">CEGUI::ImageDim</a>, <a class="el" href="classCEGUI_1_1PropertyDim.html">CEGUI::PropertyDim</a>, <a class="el" href="classCEGUI_1_1UnifiedDim.html">CEGUI::UnifiedDim</a>, and <a class="el" href="classCEGUI_1_1WidgetDim.html">CEGUI::WidgetDim</a>.</p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png"/> Collaboration diagram for CEGUI::BaseDim:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classCEGUI_1_1BaseDim__coll__graph.gif" border="0" usemap="#CEGUI_1_1BaseDim_coll__map" alt="Collaboration graph"/></div>
<map name="CEGUI_1_1BaseDim_coll__map" id="CEGUI_1_1BaseDim_coll__map">
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classCEGUI_1_1BaseDim-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1BaseDim.html#ae9c71469ab45f470b90999c262fac332">getValue</a> (const <a class="el" href="classCEGUI_1_1Window.html">Window</a> &wnd) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a value that represents this dimension as absolute pixels. <a href="#ae9c71469ab45f470b90999c262fac332"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1BaseDim.html#a7c973d57eeff59a27c909d62bb5560cf">getValue</a> (const <a class="el" href="classCEGUI_1_1Window.html">Window</a> &wnd, const <a class="el" href="classCEGUI_1_1Rect.html">Rect</a> &container) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a value that represents this dimension as absolute pixels. <a href="#a7c973d57eeff59a27c909d62bb5560cf"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCEGUI_1_1BaseDim.html">BaseDim</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1BaseDim.html#a0f4223e16dcd1cd97ef778fa7df51db2">clone</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create an exact copy of the specialised class and return it as a pointer to a <a class="el" href="classCEGUI_1_1BaseDim.html" title="Abstract interface for a generic 'dimension' class.">BaseDim</a> object. <a href="#a0f4223e16dcd1cd97ef778fa7df51db2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceCEGUI.html#a83eeabd743af4692fae93272f0e3be72">DimensionOperator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1BaseDim.html#a31b5b6aa7480cef5fbff94cffd84fe26">getDimensionOperator</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the DimensionOperator set for this <a class="el" href="classCEGUI_1_1BaseDim.html" title="Abstract interface for a generic 'dimension' class.">BaseDim</a> based object. <a href="#a31b5b6aa7480cef5fbff94cffd84fe26"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1BaseDim.html#a406ff20afd449fb926903048dec5c5d4">setDimensionOperator</a> (<a class="el" href="namespaceCEGUI.html#a83eeabd743af4692fae93272f0e3be72">DimensionOperator</a> op)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the DimensionOperator set for this <a class="el" href="classCEGUI_1_1BaseDim.html" title="Abstract interface for a generic 'dimension' class.">BaseDim</a> based object. <a href="#a406ff20afd449fb926903048dec5c5d4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classCEGUI_1_1BaseDim.html">BaseDim</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1BaseDim.html#a26e50c8bea15ead52115196277d0ca35">getOperand</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a pointer to the <a class="el" href="classCEGUI_1_1BaseDim.html" title="Abstract interface for a generic 'dimension' class.">BaseDim</a> set to be used as the other operand. <a href="#a26e50c8bea15ead52115196277d0ca35"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1BaseDim.html#a19995a84bbfc6cf9f9a936c520427256">setOperand</a> (const <a class="el" href="classCEGUI_1_1BaseDim.html">BaseDim</a> &operand)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the <a class="el" href="classCEGUI_1_1BaseDim.html" title="Abstract interface for a generic 'dimension' class.">BaseDim</a> set to be used as the other operand in calculations for this <a class="el" href="classCEGUI_1_1BaseDim.html" title="Abstract interface for a generic 'dimension' class.">BaseDim</a>. <a href="#a19995a84bbfc6cf9f9a936c520427256"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1BaseDim.html#a82e737d0073299a43e3920b78229d381">writeXMLToStream</a> (<a class="el" href="classCEGUI_1_1XMLSerializer.html">XMLSerializer</a> &xml_stream) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Writes an xml representation of this <a class="el" href="classCEGUI_1_1BaseDim.html" title="Abstract interface for a generic 'dimension' class.">BaseDim</a> to <em>out_stream</em>. <a href="#a82e737d0073299a43e3920b78229d381"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aec28a97ab6a6df6c8195e4897cbc591e"></a><!-- doxytag: member="CEGUI::BaseDim::getValue_impl" ref="aec28a97ab6a6df6c8195e4897cbc591e" args="(const Window &wnd) const =0" -->
virtual float </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1BaseDim.html#aec28a97ab6a6df6c8195e4897cbc591e">getValue_impl</a> (const <a class="el" href="classCEGUI_1_1Window.html">Window</a> &wnd) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Implementataion method to return the base value for this <a class="el" href="classCEGUI_1_1BaseDim.html" title="Abstract interface for a generic 'dimension' class.">BaseDim</a>. This method should not attempt to apply the mathematical operator; this is handled automatically. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3dbf7dc4d0abcfa2f85656c8338f7b40"></a><!-- doxytag: member="CEGUI::BaseDim::getValue_impl" ref="a3dbf7dc4d0abcfa2f85656c8338f7b40" args="(const Window &wnd, const Rect &container) const =0" -->
virtual float </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1BaseDim.html#a3dbf7dc4d0abcfa2f85656c8338f7b40">getValue_impl</a> (const <a class="el" href="classCEGUI_1_1Window.html">Window</a> &wnd, const <a class="el" href="classCEGUI_1_1Rect.html">Rect</a> &container) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Implementataion method to return the base value for this <a class="el" href="classCEGUI_1_1BaseDim.html" title="Abstract interface for a generic 'dimension' class.">BaseDim</a>. This method should not attempt to apply the mathematical operator; this is handled automatically by <a class="el" href="classCEGUI_1_1BaseDim.html" title="Abstract interface for a generic 'dimension' class.">BaseDim</a>. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a80ca3317f244a87d46d179a60c0247be"></a><!-- doxytag: member="CEGUI::BaseDim::clone_impl" ref="a80ca3317f244a87d46d179a60c0247be" args="() const =0" -->
virtual <a class="el" href="classCEGUI_1_1BaseDim.html">BaseDim</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1BaseDim.html#a80ca3317f244a87d46d179a60c0247be">clone_impl</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Implementataion method to return a clone of this sub-class of <a class="el" href="classCEGUI_1_1BaseDim.html" title="Abstract interface for a generic 'dimension' class.">BaseDim</a>. This method should not attempt to clone the mathematical operator or operand; theis is handled automatically by <a class="el" href="classCEGUI_1_1BaseDim.html" title="Abstract interface for a generic 'dimension' class.">BaseDim</a>. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a742a0bc655e81a7c585d8745ce67e43c"></a><!-- doxytag: member="CEGUI::BaseDim::writeXMLElementName_impl" ref="a742a0bc655e81a7c585d8745ce67e43c" args="(XMLSerializer &xml_stream) const =0" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1BaseDim.html#a742a0bc655e81a7c585d8745ce67e43c">writeXMLElementName_impl</a> (<a class="el" href="classCEGUI_1_1XMLSerializer.html">XMLSerializer</a> &xml_stream) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Implementataion method to output real xml element name. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae912ef1bb64d8ed59d3b3fbc74a7fa2e"></a><!-- doxytag: member="CEGUI::BaseDim::writeXMLElementAttributes_impl" ref="ae912ef1bb64d8ed59d3b3fbc74a7fa2e" args="(XMLSerializer &xml_stream) const =0" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1BaseDim.html#ae912ef1bb64d8ed59d3b3fbc74a7fa2e">writeXMLElementAttributes_impl</a> (<a class="el" href="classCEGUI_1_1XMLSerializer.html">XMLSerializer</a> &xml_stream) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Implementataion method to create the element attributes. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Abstract interface for a generic 'dimension' class. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a0f4223e16dcd1cd97ef778fa7df51db2"></a><!-- doxytag: member="CEGUI::BaseDim::clone" ref="a0f4223e16dcd1cd97ef778fa7df51db2" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCEGUI_1_1BaseDim.html">BaseDim</a>* CEGUI::BaseDim::clone </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create an exact copy of the specialised class and return it as a pointer to a <a class="el" href="classCEGUI_1_1BaseDim.html" title="Abstract interface for a generic 'dimension' class.">BaseDim</a> object. </p>
<p>Since the system needs to be able to copy objects derived from <a class="el" href="classCEGUI_1_1BaseDim.html" title="Abstract interface for a generic 'dimension' class.">BaseDim</a>, but only has knowledge of the <a class="el" href="classCEGUI_1_1BaseDim.html" title="Abstract interface for a generic 'dimension' class.">BaseDim</a> interface, this clone method is provided to prevent slicing issues.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classCEGUI_1_1BaseDim.html" title="Abstract interface for a generic 'dimension' class.">BaseDim</a> object pointer </dd></dl>
</div>
</div>
<a class="anchor" id="a31b5b6aa7480cef5fbff94cffd84fe26"></a><!-- doxytag: member="CEGUI::BaseDim::getDimensionOperator" ref="a31b5b6aa7480cef5fbff94cffd84fe26" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceCEGUI.html#a83eeabd743af4692fae93272f0e3be72">DimensionOperator</a> CEGUI::BaseDim::getDimensionOperator </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the DimensionOperator set for this <a class="el" href="classCEGUI_1_1BaseDim.html" title="Abstract interface for a generic 'dimension' class.">BaseDim</a> based object. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>One of the DimensionOperator enumerated values representing a mathematical operation to be performed upon this <a class="el" href="classCEGUI_1_1BaseDim.html" title="Abstract interface for a generic 'dimension' class.">BaseDim</a> using the set operand. </dd></dl>
</div>
</div>
<a class="anchor" id="a26e50c8bea15ead52115196277d0ca35"></a><!-- doxytag: member="CEGUI::BaseDim::getOperand" ref="a26e50c8bea15ead52115196277d0ca35" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classCEGUI_1_1BaseDim.html">BaseDim</a>* CEGUI::BaseDim::getOperand </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return a pointer to the <a class="el" href="classCEGUI_1_1BaseDim.html" title="Abstract interface for a generic 'dimension' class.">BaseDim</a> set to be used as the other operand. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to the <a class="el" href="classCEGUI_1_1BaseDim.html" title="Abstract interface for a generic 'dimension' class.">BaseDim</a> object. </dd></dl>
</div>
</div>
<a class="anchor" id="a7c973d57eeff59a27c909d62bb5560cf"></a><!-- doxytag: member="CEGUI::BaseDim::getValue" ref="a7c973d57eeff59a27c909d62bb5560cf" args="(const Window &wnd, const Rect &container) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float CEGUI::BaseDim::getValue </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1Window.html">Window</a> & </td>
<td class="paramname"><em>wnd</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1Rect.html">Rect</a> & </td>
<td class="paramname"><em>container</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return a value that represents this dimension as absolute pixels. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">wnd</td><td><a class="el" href="classCEGUI_1_1Window.html" title="An abstract base class providing common functionality and specifying the required interface for deriv...">Window</a> object that may be used by the specialised class to aid in calculating the final value (typically would be used to obtain window/widget dimensions).</td></tr>
<tr><td class="paramname">container</td><td><a class="el" href="classCEGUI_1_1Rect.html" title="Class encapsulating operations on a Rectangle.">Rect</a> object which describes an area to be considered as the base area when calculating the final value. Basically this means that relative values are calculated from the dimensions of this <a class="el" href="classCEGUI_1_1Rect.html" title="Class encapsulating operations on a Rectangle.">Rect</a>.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>float value which represents, in pixels, the same value as this <a class="el" href="classCEGUI_1_1BaseDim.html" title="Abstract interface for a generic 'dimension' class.">BaseDim</a>. </dd></dl>
</div>
</div>
<a class="anchor" id="ae9c71469ab45f470b90999c262fac332"></a><!-- doxytag: member="CEGUI::BaseDim::getValue" ref="ae9c71469ab45f470b90999c262fac332" args="(const Window &wnd) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float CEGUI::BaseDim::getValue </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1Window.html">Window</a> & </td>
<td class="paramname"><em>wnd</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return a value that represents this dimension as absolute pixels. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">wnd</td><td><a class="el" href="classCEGUI_1_1Window.html" title="An abstract base class providing common functionality and specifying the required interface for deriv...">Window</a> object that may be used by the specialised class to aid in calculating the final value.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>float value which represents, in pixels, the same value as this <a class="el" href="classCEGUI_1_1BaseDim.html" title="Abstract interface for a generic 'dimension' class.">BaseDim</a>. </dd></dl>
</div>
</div>
<a class="anchor" id="a406ff20afd449fb926903048dec5c5d4"></a><!-- doxytag: member="CEGUI::BaseDim::setDimensionOperator" ref="a406ff20afd449fb926903048dec5c5d4" args="(DimensionOperator op)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::BaseDim::setDimensionOperator </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceCEGUI.html#a83eeabd743af4692fae93272f0e3be72">DimensionOperator</a> </td>
<td class="paramname"><em>op</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the DimensionOperator set for this <a class="el" href="classCEGUI_1_1BaseDim.html" title="Abstract interface for a generic 'dimension' class.">BaseDim</a> based object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">op</td><td>One of the DimensionOperator enumerated values representing a mathematical operation to be performed upon this <a class="el" href="classCEGUI_1_1BaseDim.html" title="Abstract interface for a generic 'dimension' class.">BaseDim</a> using the set operand.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
</div>
</div>
<a class="anchor" id="a19995a84bbfc6cf9f9a936c520427256"></a><!-- doxytag: member="CEGUI::BaseDim::setOperand" ref="a19995a84bbfc6cf9f9a936c520427256" args="(const BaseDim &operand)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::BaseDim::setOperand </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1BaseDim.html">BaseDim</a> & </td>
<td class="paramname"><em>operand</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the <a class="el" href="classCEGUI_1_1BaseDim.html" title="Abstract interface for a generic 'dimension' class.">BaseDim</a> set to be used as the other operand in calculations for this <a class="el" href="classCEGUI_1_1BaseDim.html" title="Abstract interface for a generic 'dimension' class.">BaseDim</a>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">operand</td><td>sub-class of <a class="el" href="classCEGUI_1_1BaseDim.html" title="Abstract interface for a generic 'dimension' class.">BaseDim</a> representing the 'other' operand. The given object will be cloned; no transfer of ownership occurrs for the passed object.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
</div>
</div>
<a class="anchor" id="a82e737d0073299a43e3920b78229d381"></a><!-- doxytag: member="CEGUI::BaseDim::writeXMLToStream" ref="a82e737d0073299a43e3920b78229d381" args="(XMLSerializer &xml_stream) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::BaseDim::writeXMLToStream </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1XMLSerializer.html">XMLSerializer</a> & </td>
<td class="paramname"><em>xml_stream</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Writes an xml representation of this <a class="el" href="classCEGUI_1_1BaseDim.html" title="Abstract interface for a generic 'dimension' class.">BaseDim</a> to <em>out_stream</em>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">xml_stream</td><td>Stream where xml data should be output.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Sun Jan 22 2012 16:07:42 for Crazy Eddies GUI System by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>
|