231 lines
14 KiB
HTML
231 lines
14 KiB
HTML
<!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/"> [ 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::widget::Joystick</h1><hr/><h2>enum:</h2>
|
|
<ul>
|
|
<li><a href="enum_ewol__widget__Joystick__joystickMode.html">joystickMode</a></li></ul>
|
|
<h2>Constructor and Destructor:</h2>
|
|
<pre>
|
|
# <a class="code-function" href="#469">Joystick</a> ();<br/>+ <span class="code-storage-keyword">virtual</span> <a class="code-function" href="#474">~Joystick</a> ();<br/></pre>
|
|
<br/>
|
|
<h2>Synopsis:</h2>
|
|
<pre>
|
|
+ <a class="code-type" href="class_ewol__object__Signal.html">ewol::object::Signal</a><void> <a class="code-member" href="#455">signalEnable</a>;<br/>+ <a class="code-type" href="class_ewol__object__Signal.html">ewol::object::Signal</a><void> <a class="code-member" href="#456">signalDisable</a>;<br/>+ <a class="code-type" href="class_ewol__object__Signal.html">ewol::object::Signal</a><vec2> <a class="code-member" href="#457">signalMove</a>;<br/># <span class="code-type" >void</span> <a class="code-function" href="#470">init</a> ();<br/>+ <a class="code-function" href="#471">DECLARE_WIDGET_FACTORY</a> (Joystick <span class="code-argument"></span>,<br/> "Joystick" <span class="code-argument"></span>);<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#475">setLockMode</a> (<span class="code-type" >bool</span> <span class="code-argument">_lockWhenOut</span>);<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#477">setDisplayMode</a> (<span class="code-storage-keyword">enum</span> joystickMode <span class="code-argument">_newMode</span>);<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#479">ratio</a> (<span class="code-type" >float</span> <span class="code-argument">_newRatio</span>);<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#481">background</a> (<a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> <span class="code-argument">_imageNameInData</span>,<br/> <span class="code-type" >bool</span> <span class="code-argument">_display</span>);<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#484">foreground</a> (<a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> <span class="code-argument">_imageNameInData</span>);<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#486">getProperty</a> (<span class="code-type" >float</span> & <span class="code-argument">_distance</span>,<br/> <span class="code-type" >float</span> & <span class="code-argument">_angle</span>);<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#489">calculateSize</a> (<span class="code-storage-keyword">const</span> vec2 & <span class="code-argument">_availlable</span>);<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#491">onRegenerateDisplay</a> ();<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >bool</span> <a class="code-function" href="#492">onEventInput</a> (<span class="code-storage-keyword">const</span> <a class="code-type" href="class_ewol__event__Input.html">ewol::event::Input</a> & <span class="code-argument">_event</span>);<br/></pre>
|
|
<br/>
|
|
<h2>Object Hierarchy:<h2>
|
|
<pre>
|
|
+std::enable_shared_from_this<Object><br/>+<a href="class_ewol__object__ParameterList.html">ewol::object::ParameterList</a><br/>+<a href="class_ewol__object__SignalList.html">ewol::object::SignalList</a><br/> +--> +<a href="class_ewol__Object.html">ewol::Object</a><br/> +--> +<a href="class_ewol__Widget.html">ewol::Widget</a><br/> +--> ewol::widget::Joystick<br/></pre>
|
|
<h2>Detail:</h2>
|
|
<a id="455"/><a id="456"/><h3>signalEnable</h3><pre>
|
|
+ <a class="code-type" href="class_ewol__object__Signal.html">ewol::object::Signal</a><void> <span class="code-member">signalEnable</span>;<br/></pre>
|
|
|
|
<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="457"/><h3>signalDisable</h3><pre>
|
|
+ <a class="code-type" href="class_ewol__object__Signal.html">ewol::object::Signal</a><void> <span class="code-member">signalDisable</span>;<br/></pre>
|
|
|
|
<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="469"/><h3>signalMove</h3><pre>
|
|
+ <a class="code-type" href="class_ewol__object__Signal.html">ewol::object::Signal</a><vec2> <span class="code-member">signalMove</span>;<br/></pre>
|
|
|
|
<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="470"/><h3>Joystick</h3><pre>
|
|
# <span class="code-function">Joystick</span> ();<br/></pre>
|
|
|
|
<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="471"/><h3>init</h3><pre>
|
|
# <span class="code-type" >void</span> <span class="code-function">init</span> ();<br/></pre>
|
|
|
|
<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="474"/><h3>DECLARE_WIDGET_FACTORY</h3><pre>
|
|
+ <span class="code-function">DECLARE_WIDGET_FACTORY</span> (Joystick <span class="code-argument"></span>,<br/> "Joystick" <span class="code-argument"></span>);<br/></pre>
|
|
|
|
<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="475"/><h3>~Joystick</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-function">~Joystick</span> ();<br/></pre>
|
|
|
|
<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="477"/><h3>setLockMode</h3><pre>
|
|
+ <span class="code-type" >void</span> <span class="code-function">setLockMode</span> (<span class="code-type" >bool</span> <span class="code-argument">_lockWhenOut</span>);<br/></pre>
|
|
|
|
<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="479"/><h3>setDisplayMode</h3><pre>
|
|
+ <span class="code-type" >void</span> <span class="code-function">setDisplayMode</span> (<span class="code-storage-keyword">enum</span> joystickMode <span class="code-argument">_newMode</span>);<br/></pre>
|
|
|
|
<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="481"/><h3>ratio</h3><pre>
|
|
+ <span class="code-type" >void</span> <span class="code-function">ratio</span> (<span class="code-type" >float</span> <span class="code-argument">_newRatio</span>);<br/></pre>
|
|
set the ratio of the widget joystick<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_newRatio</span> </td><td> the new ratio that might be set</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="484"/><h3>background</h3><pre>
|
|
+ <span class="code-type" >void</span> <span class="code-function">background</span> (<a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> <span class="code-argument">_imageNameInData</span>,<br/> <span class="code-type" >bool</span> <span class="code-argument">_display</span>);<br/></pre>
|
|
set the Background of the widget joystick<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_imageNameInData</span> </td><td> the new rbackground that might be set</td></tr>
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_displa</span> </td><td>y</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="486"/><h3>foreground</h3><pre>
|
|
+ <span class="code-type" >void</span> <span class="code-function">foreground</span> (<a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> <span class="code-argument">_imageNameInData</span>);<br/></pre>
|
|
set the Foreground of the widget joystick<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_imageNameInData</span> </td><td> the new Foreground that might be set</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="489"/><h3>getProperty</h3><pre>
|
|
+ <span class="code-type" >void</span> <span class="code-function">getProperty</span> (<span class="code-type" >float</span> & <span class="code-argument">_distance</span>,<br/> <span class="code-type" >float</span> & <span class="code-argument">_angle</span>);<br/></pre>
|
|
get the property of the joystick<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [output]:</b></td><td><span class="code-argument">_distance</span> </td><td> distance to the center</td></tr>
|
|
<td><b>Parameter [output]:</b></td><td><span class="code-argument">_angle</span> </td><td> angle of the joy</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="491"/><h3>calculateSize</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">calculateSize</span> (<span class="code-storage-keyword">const</span> vec2 & <span class="code-argument">_availlable</span>);<br/></pre>
|
|
Parent set the possible diplay size of the current widget whith his own possibilities
|
|
By default this save the widget available size in the widget size<br/><b>Note:</b> : INTERNAL EWOL SYSTEM<br/> <ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_available</span> </td><td> Available x&y pixel size</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="492"/><h3>onRegenerateDisplay</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">onRegenerateDisplay</span> ();<br/></pre>
|
|
Event generated when a redraw is needed<br/>
|
|
<br/>
|
|
<hr/>
|
|
<h3>onEventInput</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >bool</span> <span class="code-function">onEventInput</span> (<span class="code-storage-keyword">const</span> <a class="code-type" href="class_ewol__event__Input.html">ewol::event::Input</a> & <span class="code-argument">_event</span>);<br/></pre>
|
|
Event on an input of this Widget (finger, mouse, stilet)<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_event</span> </td><td> Event properties</td></tr>
|
|
<tr><td><b>Return: </b></td><td></td><td>true the event is used<br/>false the event is not used</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>
|