atria-soft/ewol
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
ewol/class_ewol__Dimension.html
Edouard DUPIN e39f62d9f6 [DOC] update doc
2014-10-18 09:23:18 +02:00

326 lines
19 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
<title>ewol Library</title>
<link rel="stylesheet" href="base.css">
<link rel="stylesheet" href="menu.css">
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="container">
<h1><a href="index.html">ewol library</a></h1>
<h4><a href="http://github.com/heeroyui/ewol/">&nbsp;&nbsp;&nbsp;[ sources ]</a></h4>
<h3>API:</h3> <div id="menu">
<ul class="niveau1">
<li class="sousmenu"><a href="namespace_ewol.html">ewol</a>
<ul class="niveau2">
<li><a href="namespace_ewol__translate.html">translate</a>
</li>
<li><a href="namespace_ewol__key.html">key</a>
</li>
<li><a href="namespace_ewol__widget.html">widget</a>
</li>
<li><a href="namespace_ewol__openGL.html">openGL</a>
</li>
<li class="sousmenu"><a href="namespace_ewol__context.html">context</a>
<ul class="niveau3">
<li><a href="namespace_ewol__context__clipBoard.html">clipBoard</a>
</li>
</ul>
</li>
<li><a href="namespace_ewol__compositing.html">compositing</a>
</li>
<li><a href="namespace_ewol__object.html">object</a>
</li>
<li><a href="namespace_ewol__resource.html">resource</a>
</li>
<li><a href="namespace_ewol__font.html">font</a>
</li>
<li><a href="namespace_ewol__event.html">event</a>
</li>
</ul>
</li>
<li><a href="namespace_MacOs.html">MacOs</a>
</li>
<li><a href="namespace_IOs.html">IOs</a>
</li>
</ul>
</div>
<h3>Documentation:</h3><div id="menu">
<ul class="niveau1"><li><a href="001_bases.html">Bases</a></li>
</ul><ul class="niveau1"><li><a href="faq.html">Faq</a></li>
</ul></div>
<h3>Tutorials:</h3><div id="menu">
<ul class="niveau1"><li><a href="tutorial_000_Build.html">Build</a></li>
</ul><ul class="niveau1"><li><a href="tutorial_001_HelloWord.html">Hello word</a></li>
</ul><ul class="niveau1"><li><a href="tutorial_010_ObjectModel.html">Object model</a></li>
</ul><ul class="niveau1"><li><a href="tutorial_011_ObjectConfig.html">Object config</a></li>
</ul><ul class="niveau1"><li><a href="tutorial_012_ObjectMessage.html">Object message</a></li>
</ul><ul class="niveau1"><li><a href="tutorial_020_FileAccess.html">File access</a></li>
</ul><ul class="niveau1"><li><a href="tutorial_021_Resources.html">Resources</a></li>
</ul><ul class="niveau1"><li><a href="tutorial_030_ConplexeXmlGui.html">Conplexe xml gui</a></li>
</ul><ul class="niveau1"><li><a href="tutorial_050_CreateCustomWidget.html">Create custom widget</a></li>
</ul><ul class="niveau1"><li><a href="tutorial_051_AddWidgetCustumInXML.html">Add widget custum in x m l</a></li>
</ul></div>
<br/><h3>Associate libraries:</h3><div id="menu">
<ul class="niveau1"><li><a href="../ejson/index.html">ejson</a></li>
</ul><ul class="niveau1"><li><a href="../egami/index.html">egami</a></li>
</ul><ul class="niveau1"><li><a href="../ege/index.html">ege</a></li>
</ul><ul class="niveau1"><li><a href="../esvg/index.html">esvg</a></li>
</ul><ul class="niveau1"><li><a href="../etk/index.html">etk</a></li>
</ul><ul class="niveau1"><li><a href="../exml/index.html">exml</a></li>
</ul></div>
<br/>
<br/>
<br/>
<br/>
<br/>
<br/>
</div>
</div>
<div class="container" id="content">
<h1>class: ewol::Dimension</h1><hr/><h2>Description:</h2>
in the dimention class we store the data as the more usefull unit (pixel)
but one case need to be dynamic the %, then when requested in % the register the % value<br/><br/>
<h2>enum:</h2>
<ul>
<li><a href="enum_ewol__Dimension__distance.html">distance</a></li></ul>
<h2>Constructor and Destructor:</h2>
<pre>
+ <a class="code-function" href="#59">Dimension</a> ();<br/>+ <a class="code-function" href="#60">Dimension</a> (<span class="code-storage-keyword">const</span> vec2 & <span class="code-argument">_size</span>,<br/> <span class="code-storage-keyword">enum</span> <a class="code-type" href="enum_ewol__Dimension__distance.html">ewol::Dimension::distance</a> <span class="code-argument">_type</span>);<br/>+ <a class="code-function" href="#63">Dimension</a> (<span class="code-storage-keyword">const</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> & <span class="code-argument">_config</span>);<br/>+ <a class="code-function" href="#65">Dimension</a> (<span class="code-storage-keyword">const</span> <span class="code-type" >char</span>* <span class="code-argument">_config</span>);<br/>+ <a class="code-function" href="#67">~Dimension</a> ();<br/></pre>
<br/>
<h2>Synopsis:</h2>
<pre>
+ <a class="code-function" href="#68">operator std::string</a> () <span class="code-storage-keyword">const</span>;<br/>+ vec2 <a class="code-function" href="#69">get</a> (<span class="code-storage-keyword">enum</span> distance <span class="code-argument">_type</span>) <span class="code-storage-keyword">const</span>;<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#71">set</a> (<span class="code-storage-keyword">const</span> vec2 & <span class="code-argument">_size</span>,<br/> <span class="code-storage-keyword">enum</span> distance <span class="code-argument">_type</span>);<br/>+ vec2 <a class="code-function" href="#76">getPixel</a> () <span class="code-storage-keyword">const</span>;<br/>+ vec2 <a class="code-function" href="#77">getPourcent</a> () <span class="code-storage-keyword">const</span>;<br/>+ vec2 <a class="code-function" href="#78">getMeter</a> () <span class="code-storage-keyword">const</span>;<br/>+ vec2 <a class="code-function" href="#79">getCentimeter</a> () <span class="code-storage-keyword">const</span>;<br/>+ vec2 <a class="code-function" href="#80">getMillimeter</a> () <span class="code-storage-keyword">const</span>;<br/>+ vec2 <a class="code-function" href="#81">getKilometer</a> () <span class="code-storage-keyword">const</span>;<br/>+ vec2 <a class="code-function" href="#82">getInch</a> () <span class="code-storage-keyword">const</span>;<br/>+ vec2 <a class="code-function" href="#83">getFoot</a> () <span class="code-storage-keyword">const</span>;<br/>+ <span class="code-storage-keyword">const</span> Dimension & <a class="code-function" href="#84">operator =</a> (<span class="code-storage-keyword">const</span> Dimension & <span class="code-argument">_obj</span>);<br/>+ <span class="code-type" >bool</span> <a class="code-function" href="#86">operator ==</a> (<span class="code-storage-keyword">const</span> Dimension & <span class="code-argument">_obj</span>) <span class="code-storage-keyword">const</span>;<br/>+ <span class="code-type" >bool</span> <a class="code-function" href="#88">operator !=</a> (<span class="code-storage-keyword">const</span> Dimension & <span class="code-argument">_obj</span>) <span class="code-storage-keyword">const</span>;<br/>+ <span class="code-storage-keyword">enum</span> distance <a class="code-function" href="#90">getType</a> () <span class="code-storage-keyword">const</span>;<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#91">init</a> ();<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#92">unInit</a> ();<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#93">setPixelRatio</a> (<span class="code-storage-keyword">const</span> vec2 & <span class="code-argument">_ratio</span>,<br/> <span class="code-storage-keyword">enum</span> <a class="code-type" href="enum_ewol__Dimension__distance.html">ewol::Dimension::distance</a> <span class="code-argument">_type</span>);<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#96">setPixelWindowsSize</a> (<span class="code-storage-keyword">const</span> vec2 & <span class="code-argument">_size</span>);<br/>+ vec2 <a class="code-function" href="#98">getWindowsSize</a> (<span class="code-storage-keyword">enum</span> <a class="code-type" href="enum_ewol__Dimension__distance.html">ewol::Dimension::distance</a> <span class="code-argument">_type</span>);<br/>+ <span class="code-type" >float</span> <a class="code-function" href="#100">getWindowsDiag</a> (<span class="code-storage-keyword">enum</span> <a class="code-type" href="enum_ewol__Dimension__distance.html">ewol::Dimension::distance</a> <span class="code-argument">_type</span>);<br/></pre>
<br/>
<h2>Detail:</h2>
<a id="59"/><a id="60"/><h3>Dimension</h3><pre>
+ <span class="code-function">Dimension</span> ();<br/></pre>
Constructor (default :0,0 mode pixel)<br/>
<br/>
<hr/>
<a id="63"/><h3>Dimension</h3><pre>
+ <span class="code-function">Dimension</span> (<span class="code-storage-keyword">const</span> vec2 & <span class="code-argument">_size</span>,<br/> <span class="code-storage-keyword">enum</span> <a class="code-type" href="enum_ewol__Dimension__distance.html">ewol::Dimension::distance</a> <span class="code-argument">_type</span>);<br/></pre>
Constructor<br/><ul>
<table class="parameter-list">
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_size</span> </td><td> Requested dimention</td></tr>
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_type</span> </td><td> Unit of the Dimention</td></tr>
</table>
</ul>
<br/>
<hr/>
<a id="65"/><h3>Dimension</h3><pre>
+ <span class="code-function">Dimension</span> (<span class="code-storage-keyword">const</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> & <span class="code-argument">_config</span>);<br/></pre>
Constructor<br/><ul>
<table class="parameter-list">
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_config</span> </td><td> dimension configuration.</td></tr>
</table>
</ul>
<br/>
<hr/>
<a id="67"/><h3>Dimension</h3><pre>
+ <span class="code-function">Dimension</span> (<span class="code-storage-keyword">const</span> <span class="code-type" >char</span>* <span class="code-argument">_config</span>);<br/></pre>
Constructor<br/><ul>
<table class="parameter-list">
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_config</span> </td><td> dimension configuration.</td></tr>
</table>
</ul>
<br/>
<hr/>
<a id="68"/><h3>~Dimension</h3><pre>
+ <span class="code-function">~Dimension</span> ();<br/></pre>
Destructor<br/>
<br/>
<hr/>
<a id="69"/><h3>operator std::string</h3><pre>
+ <span class="code-function">operator std::string</span> () <span class="code-storage-keyword">const</span>;<br/></pre>
string cast :<br/>
<br/>
<hr/>
<a id="71"/><h3>get</h3><pre>
+ vec2 <span class="code-function">get</span> (<span class="code-storage-keyword">enum</span> distance <span class="code-argument">_type</span>) <span class="code-storage-keyword">const</span>;<br/></pre>
get the current dimention in requested type<br/><ul>
<table class="parameter-list">
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_type</span> </td><td> Type of unit requested.</td></tr>
<tr><td><b>Return: </b></td><td></td><td>dimention requested.</td></tr></table>
</ul>
<br/>
<hr/>
<a id="76"/><h3>set</h3><pre>
+ <span class="code-type" >void</span> <span class="code-function">set</span> (<span class="code-storage-keyword">const</span> vec2 & <span class="code-argument">_size</span>,<br/> <span class="code-storage-keyword">enum</span> distance <span class="code-argument">_type</span>);<br/></pre>
set the current dimention in requested type<br/><ul>
<table class="parameter-list">
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_size</span> </td><td> Dimention to set</td></tr>
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_type</span> </td><td> Type of unit requested.</td></tr>
</table>
</ul>
<br/>
<hr/>
<a id="77"/><h3>getPixel</h3><pre>
+ vec2 <span class="code-function">getPixel</span> () <span class="code-storage-keyword">const</span>;<br/></pre>
get the current dimention in pixel<br/><ul>
<table class="parameter-list">
<tr><td><b>Return: </b></td><td></td><td>dimention in Pixel</td></tr></table>
</ul>
<br/>
<hr/>
<a id="78"/><h3>getPourcent</h3><pre>
+ vec2 <span class="code-function">getPourcent</span> () <span class="code-storage-keyword">const</span>;<br/></pre>
get the current dimention in Pourcent<br/><ul>
<table class="parameter-list">
<tr><td><b>Return: </b></td><td></td><td>dimention in Pourcent</td></tr></table>
</ul>
<br/>
<hr/>
<a id="79"/><h3>getMeter</h3><pre>
+ vec2 <span class="code-function">getMeter</span> () <span class="code-storage-keyword">const</span>;<br/></pre>
get the current dimention in Meter<br/><ul>
<table class="parameter-list">
<tr><td><b>Return: </b></td><td></td><td>dimention in Meter</td></tr></table>
</ul>
<br/>
<hr/>
<a id="80"/><h3>getCentimeter</h3><pre>
+ vec2 <span class="code-function">getCentimeter</span> () <span class="code-storage-keyword">const</span>;<br/></pre>
get the current dimention in Centimeter<br/><ul>
<table class="parameter-list">
<tr><td><b>Return: </b></td><td></td><td>dimention in Centimeter</td></tr></table>
</ul>
<br/>
<hr/>
<a id="81"/><h3>getMillimeter</h3><pre>
+ vec2 <span class="code-function">getMillimeter</span> () <span class="code-storage-keyword">const</span>;<br/></pre>
get the current dimention in Millimeter<br/><ul>
<table class="parameter-list">
<tr><td><b>Return: </b></td><td></td><td>dimention in Millimeter</td></tr></table>
</ul>
<br/>
<hr/>
<a id="82"/><h3>getKilometer</h3><pre>
+ vec2 <span class="code-function">getKilometer</span> () <span class="code-storage-keyword">const</span>;<br/></pre>
get the current dimention in Kilometer<br/><ul>
<table class="parameter-list">
<tr><td><b>Return: </b></td><td></td><td>dimention in Kilometer</td></tr></table>
</ul>
<br/>
<hr/>
<a id="83"/><h3>getInch</h3><pre>
+ vec2 <span class="code-function">getInch</span> () <span class="code-storage-keyword">const</span>;<br/></pre>
get the current dimention in Inch<br/><ul>
<table class="parameter-list">
<tr><td><b>Return: </b></td><td></td><td>dimention in Inch</td></tr></table>
</ul>
<br/>
<hr/>
<a id="84"/><h3>getFoot</h3><pre>
+ vec2 <span class="code-function">getFoot</span> () <span class="code-storage-keyword">const</span>;<br/></pre>
get the current dimention in Foot<br/><ul>
<table class="parameter-list">
<tr><td><b>Return: </b></td><td></td><td>dimention in Foot</td></tr></table>
</ul>
<br/>
<hr/>
<a id="86"/><h3>operator =</h3><pre>
+ <span class="code-storage-keyword">const</span> Dimension & <span class="code-function">operator =</span> (<span class="code-storage-keyword">const</span> Dimension & <span class="code-argument">_obj</span>);<br/></pre>
= assigment<br/>
<br/>
<hr/>
<a id="88"/><h3>operator ==</h3><pre>
+ <span class="code-type" >bool</span> <span class="code-function">operator ==</span> (<span class="code-storage-keyword">const</span> Dimension & <span class="code-argument">_obj</span>) <span class="code-storage-keyword">const</span>;<br/></pre>
== operator<br/>
<br/>
<hr/>
<a id="90"/><h3>operator !=</h3><pre>
+ <span class="code-type" >bool</span> <span class="code-function">operator !=</span> (<span class="code-storage-keyword">const</span> Dimension & <span class="code-argument">_obj</span>) <span class="code-storage-keyword">const</span>;<br/></pre>
!= operator<br/>
<br/>
<hr/>
<a id="91"/><h3>getType</h3><pre>
+ <span class="code-storage-keyword">enum</span> distance <span class="code-function">getType</span> () <span class="code-storage-keyword">const</span>;<br/></pre>
<ul>
<table class="parameter-list">
<tr><td><b>Return: </b></td><td></td><td>the type</td></tr></table>
</ul>
<br/>
<hr/>
<a id="92"/><h3>init</h3><pre>
+ <span class="code-type" >void</span> <span class="code-function">init</span> ();<br/></pre>
basic init<br/>
<br/>
<hr/>
<a id="93"/><h3>unInit</h3><pre>
+ <span class="code-type" >void</span> <span class="code-function">unInit</span> ();<br/></pre>
basic un-init<br/>
<br/>
<hr/>
<a id="96"/><h3>setPixelRatio</h3><pre>
+ <span class="code-type" >void</span> <span class="code-function">setPixelRatio</span> (<span class="code-storage-keyword">const</span> vec2 & <span class="code-argument">_ratio</span>,<br/> <span class="code-storage-keyword">enum</span> <a class="code-type" href="enum_ewol__Dimension__distance.html">ewol::Dimension::distance</a> <span class="code-argument">_type</span>);<br/></pre>
set the Milimeter ratio for calculation<br/><ul>
<table class="parameter-list">
<td><b>Parameter [input]:</b></td><td><span class="code-argument">Ratio</span> </td><td> Milimeter ration for the screen calculation interpolation</td></tr>
<td><b>Parameter [input]:</b></td><td><span class="code-argument">type</span> </td><td> Unit type requested.</td></tr>
</table>
</ul>
<br/>
<hr/>
<a id="98"/><h3>setPixelWindowsSize</h3><pre>
+ <span class="code-type" >void</span> <span class="code-function">setPixelWindowsSize</span> (<span class="code-storage-keyword">const</span> vec2 & <span class="code-argument">_size</span>);<br/></pre>
set the current Windows size<br/><ul>
<table class="parameter-list">
<td><b>Parameter [input]:</b></td><td><span class="code-argument">size</span> </td><td> size of the current windows in pixel.</td></tr>
</table>
</ul>
<br/>
<hr/>
<a id="100"/><h3>getWindowsSize</h3><pre>
+ vec2 <span class="code-function">getWindowsSize</span> (<span class="code-storage-keyword">enum</span> <a class="code-type" href="enum_ewol__Dimension__distance.html">ewol::Dimension::distance</a> <span class="code-argument">_type</span>);<br/></pre>
get the Windows size in the request unit<br/><ul>
<table class="parameter-list">
<td><b>Parameter [input]:</b></td><td><span class="code-argument">type</span> </td><td> Unit type requested.</td></tr>
<tr><td><b>Return: </b></td><td></td><td>the requested size</td></tr></table>
</ul>
<br/>
<hr/>
<h3>getWindowsDiag</h3><pre>
+ <span class="code-type" >float</span> <span class="code-function">getWindowsDiag</span> (<span class="code-storage-keyword">enum</span> <a class="code-type" href="enum_ewol__Dimension__distance.html">ewol::Dimension::distance</a> <span class="code-argument">_type</span>);<br/></pre>
get the Windows diagonal size in the request unit<br/><ul>
<table class="parameter-list">
<td><b>Parameter [input]:</b></td><td><span class="code-argument">type</span> </td><td> Unit type requested.</td></tr>
<tr><td><b>Return: </b></td><td></td><td>the requested size</td></tr></table>
</ul>
<br/>
<hr/>
</div>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-46753803-1', 'heeroyui.github.io');
ga('send', 'pageview');
</script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink