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
|
<!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::UnifiedDim 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_1UnifiedDim.html">UnifiedDim</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::UnifiedDim Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::UnifiedDim" --><!-- doxytag: inherits="CEGUI::BaseDim" -->
<p><a class="el" href="classCEGUI_1_1Dimension.html" title="Class representing some kind of dimension.">Dimension</a> type that represents an Unified dimension. Implements <a class="el" href="classCEGUI_1_1BaseDim.html" title="Abstract interface for a generic 'dimension' class.">BaseDim</a> interface.
<a href="classCEGUI_1_1UnifiedDim.html#details">More...</a></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png"/> Inheritance diagram for CEGUI::UnifiedDim:</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_1UnifiedDim__inherit__graph.gif" border="0" usemap="#CEGUI_1_1UnifiedDim_inherit__map" alt="Inheritance graph"/></div>
<map name="CEGUI_1_1UnifiedDim_inherit__map" id="CEGUI_1_1UnifiedDim_inherit__map">
<area shape="rect" id="node2" href="classCEGUI_1_1BaseDim.html" title="Abstract interface for a generic 'dimension' class." alt="" coords="12,5,137,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div id="dynsection-1" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-1-trigger" src="closed.png"/> Collaboration diagram for CEGUI::UnifiedDim:</div>
<div id="dynsection-1-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-1-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classCEGUI_1_1UnifiedDim__coll__graph.gif" border="0" usemap="#CEGUI_1_1UnifiedDim_coll__map" alt="Collaboration graph"/></div>
<map name="CEGUI_1_1UnifiedDim_coll__map" id="CEGUI_1_1UnifiedDim_coll__map">
<area shape="rect" id="node2" href="classCEGUI_1_1BaseDim.html" title="Abstract interface for a generic 'dimension' class." alt="" coords="5,5,131,35"/><area shape="rect" id="node5" href="classCEGUI_1_1UDim.html" title="Class representing a unified dimension; that is a dimension that has both a relative 'scale' portion ..." alt="" coords="240,5,347,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classCEGUI_1_1UnifiedDim-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1UnifiedDim.html#a7d752a286526a14b09291db287fdbeef">UnifiedDim</a> (const <a class="el" href="classCEGUI_1_1UDim.html">UDim</a> &value, <a class="el" href="namespaceCEGUI.html#ad6bcb4f4d32891fc48d05605b4c6b059">DimensionType</a> dim)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a7d752a286526a14b09291db287fdbeef"></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="a605a673dee60af8ef528146efc75496c"></a><!-- doxytag: member="CEGUI::UnifiedDim::getValue_impl" ref="a605a673dee60af8ef528146efc75496c" args="(const Window &wnd) const " -->
float </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1UnifiedDim.html#a605a673dee60af8ef528146efc75496c">getValue_impl</a> (const <a class="el" href="classCEGUI_1_1Window.html">Window</a> &wnd) const </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="a25a6af18fbbcb3fa0e75aa0e5b7b3e9c"></a><!-- doxytag: member="CEGUI::UnifiedDim::getValue_impl" ref="a25a6af18fbbcb3fa0e75aa0e5b7b3e9c" args="(const Window &wnd, const Rect &container) const " -->
float </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1UnifiedDim.html#a25a6af18fbbcb3fa0e75aa0e5b7b3e9c">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 </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="ac5c860d505e0bb00773f4a9bb92b7b99"></a><!-- doxytag: member="CEGUI::UnifiedDim::writeXMLElementName_impl" ref="ac5c860d505e0bb00773f4a9bb92b7b99" args="(XMLSerializer &xml_stream) const " -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1UnifiedDim.html#ac5c860d505e0bb00773f4a9bb92b7b99">writeXMLElementName_impl</a> (<a class="el" href="classCEGUI_1_1XMLSerializer.html">XMLSerializer</a> &xml_stream) const </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="aca8f0aca21442bff4d2bc90efc5db2a9"></a><!-- doxytag: member="CEGUI::UnifiedDim::writeXMLElementAttributes_impl" ref="aca8f0aca21442bff4d2bc90efc5db2a9" args="(XMLSerializer &xml_stream) const " -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1UnifiedDim.html#aca8f0aca21442bff4d2bc90efc5db2a9">writeXMLElementAttributes_impl</a> (<a class="el" href="classCEGUI_1_1XMLSerializer.html">XMLSerializer</a> &xml_stream) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Implementataion method to create the element attributes. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a35c0d78105022888087587a30773e936"></a><!-- doxytag: member="CEGUI::UnifiedDim::clone_impl" ref="a35c0d78105022888087587a30773e936" args="() const " -->
<a class="el" href="classCEGUI_1_1BaseDim.html">BaseDim</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1UnifiedDim.html#a35c0d78105022888087587a30773e936">clone_impl</a> () const </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>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classCEGUI_1_1Dimension.html" title="Class representing some kind of dimension.">Dimension</a> type that represents an Unified dimension. Implements <a class="el" href="classCEGUI_1_1BaseDim.html" title="Abstract interface for a generic 'dimension' class.">BaseDim</a> interface. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a7d752a286526a14b09291db287fdbeef"></a><!-- doxytag: member="CEGUI::UnifiedDim::UnifiedDim" ref="a7d752a286526a14b09291db287fdbeef" args="(const UDim &value, DimensionType dim)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CEGUI::UnifiedDim::UnifiedDim </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1UDim.html">UDim</a> & </td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceCEGUI.html#ad6bcb4f4d32891fc48d05605b4c6b059">DimensionType</a> </td>
<td class="paramname"><em>dim</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td><a class="el" href="classCEGUI_1_1UDim.html" title="Class representing a unified dimension; that is a dimension that has both a relative 'scale' portion ...">UDim</a> holding the value to assign to this <a class="el" href="classCEGUI_1_1UnifiedDim.html" title="Dimension type that represents an Unified dimension. Implements BaseDim interface.">UnifiedDim</a>.</td></tr>
<tr><td class="paramname">dim</td><td>DimensionType value indicating what this <a class="el" href="classCEGUI_1_1UnifiedDim.html" title="Dimension type that represents an Unified dimension. Implements BaseDim interface.">UnifiedDim</a> is to represent. This is required because we need to know what part of the base <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> that the <a class="el" href="classCEGUI_1_1UDim.html" title="Class representing a unified dimension; that is a dimension that has both a relative 'scale' portion ...">UDim</a> scale component is to operate against. </td></tr>
</table>
</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>
|