atria-soft/ege
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
ege/class_ege__widget__Scene.html

290 lines
25 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>ege 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">ege library</a></h1>
<h4><a href="http://github.com/heeroyui/ege/">&nbsp;&nbsp;&nbsp;[ sources ]</a></h4>
<h3>API:</h3> <div id="menu">
<ul class="niveau1">
<li class="sousmenu"><a href="namespace_ege.html">ege</a>
<ul class="niveau2">
<li><a href="namespace_ege__collision.html">collision</a>
</li>
<li><a href="namespace_ege__widget.html">widget</a>
</li>
<li><a href="namespace_ege__resource.html">resource</a>
</li>
</ul>
</li>
</ul>
</div>
<br/><h3>Associate libraries:</h3><div id="menu">
<ul class="niveau1"><li><a href="../ewol/index.html">ewol</a></li>
</ul><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="../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: ege::widget::Scene</h1><hr/><h2>Description:</h2>
<br/><br/>
<h2>Constructor and Destructor:</h2>
<pre>
+ <a class="code-function" href="#6699">Scene</a> (<span class="code-type" >bool</span> <span class="code-argument">_setAutoBullet</span>,<br/> <span class="code-type" >bool</span> <span class="code-argument">_setAutoCamera</span>);<br/>+ <span class="code-storage-keyword">virtual</span> <a class="code-function" href="#6702">~Scene</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
<br/>
<h2>Synopsis:</h2>
<pre>
+ <span class="code-storage-keyword">const</span> <span class="code-type" >char</span>* <span class="code-storage-keyword">const</span> <a class="code-member" href="#6696">eventPlayTimeChange</a>;<br/>+ <span class="code-storage-keyword">const</span> <span class="code-type" >char</span>* <span class="code-storage-keyword">const</span> <a class="code-member" href="#6697">eventKillEnemy</a>;<br/># <a class="code-type" href="class_ege__Environement.html">ege::Environement</a> <a class="code-member" href="#6698">m_env</a>;<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#6704">setBulletConfig</a> (btDefaultCollisionConfiguration* <span class="code-argument">_collisionConfiguration</span>,<br/> btCollisionDispatcher* <span class="code-argument">_dispatcher</span>,<br/> btBroadphaseInterface* <span class="code-argument">_broadphase</span>,<br/> btConstraintSolver* <span class="code-argument">_solver</span>,<br/> btDynamicsWorld* <span class="code-argument">_dynamicsWorld</span>);<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#6710">setCamera</a> (<a class="code-type" href="class_ege__Camera.html">ege::Camera</a>* <span class="code-argument">_camera</span>);<br/># <span class="code-type" >float</span> <a class="code-member" href="#6713">m_angleView</a>;<br/># btDefaultCollisionConfiguration* <a class="code-member" href="#6714">m_collisionConfiguration</a>;<br/># btCollisionDispatcher* <a class="code-member" href="#6715">m_dispatcher</a>;<br/># btBroadphaseInterface* <a class="code-member" href="#6716">m_broadphase</a>;<br/># btConstraintSolver* <a class="code-member" href="#6717">m_solver</a>;<br/># btDynamicsWorld* <a class="code-member" href="#6718">m_dynamicsWorld</a>;<br/># <a class="code-type" href="class_ege__Camera.html">ege::Camera</a>* <a class="code-member" href="#6719">m_camera</a>;<br/># <span class="code-type" >bool</span> <a class="code-member" href="#6720">m_isRunning</a>;<br/># <span class="code-type" >float</span> <a class="code-member" href="#6721">m_ratioTime</a>;<br/># <a class="code-type" href="http://www.cplusplus.com/reference/vector/vector/">std::vector</a>&lt;ege::Environement::ResultNearestElement&gt; <a class="code-member" href="#6722">m_displayElementOrdered</a>;<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#6723">pause</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#6725">resume</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#6727">pauseToggle</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/># <span class="code-type" >bool</span> <a class="code-member" href="#6729">m_debugMode</a>;<br/># <a class="code-type" href="class_ewol__resource__Colored3DObject.html">ewol::resource::Colored3DObject</a>* <a class="code-member" href="#6730">m_debugDrawing</a>;<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#6731">debugToggle</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/># <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#6733">ScenePeriodicCall</a> (<span class="code-type" >int64_t</span> <span class="code-argument">_localTime</span>,<br/> <span class="code-type" >int32_t</span> <span class="code-argument">_deltaTime</span>);<br/>+ vec2 <a class="code-function" href="#6736">calculateDeltaAngle</a> (<span class="code-storage-keyword">const</span> vec2 & <span class="code-argument">_posScreen</span>);<br/>+ vec3 <a class="code-function" href="#6738">convertScreenPositionInMapPosition</a> (<span class="code-storage-keyword">const</span> vec2 & <span class="code-argument">_posScreen</span>);<br/>+ <a class="code-type" href="class_ege__Camera.html">ege::Camera</a> & <a class="code-function" href="#6740">getCamera</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#6742">setRatioTime</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="#6744">renderscene</a> (<span class="code-type" >int</span> <span class="code-argument">pass</span>);<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#6746">drawOpenGL</a> (btScalar* <span class="code-argument">m</span>,<br/> <span class="code-storage-keyword">const</span> btCollisionShape* <span class="code-argument">_shape</span>,<br/> <span class="code-storage-keyword">const</span> btVector3 & <span class="code-argument">_color</span>,<br/> <span class="code-type" >int32_t</span> <span class="code-argument">_debugMode</span>,<br/> <span class="code-storage-keyword">const</span> btVector3 & <span class="code-argument">_worldBoundsMin</span>,<br/> <span class="code-storage-keyword">const</span> btVector3 & <span class="code-argument">_worldBoundsMax</span>);<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#6753">drawSphere</a> (btScalar <span class="code-argument">_radius</span>,<br/> <span class="code-type" >int</span> <span class="code-argument">_lats</span>,<br/> <span class="code-type" >int</span> <span class="code-argument">_longs</span>,<br/> mat4 & <span class="code-argument">_transformationMatrix</span>,<br/> <a class="code-type" href="class_etk__Color.html">etk::Color</a>&lt;float&gt; & <span class="code-argument">_tmpColor</span>);<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#6759">getElementAroundNewElement</a> (vec3 <span class="code-argument">_sourcePosition</span>,<br/> <a class="code-type" href="http://www.cplusplus.com/reference/vector/vector/">std::vector</a>&lt;ege::Environement::ResultNearestElement&gt; & <span class="code-argument">_resultList</span>);<br/># <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#6762">onDraw</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#6764">systemDraw</a> (<span class="code-storage-keyword">const</span> <a class="code-type" href="class_ewol__DrawProperty.html">ewol::DrawProperty</a> & <span class="code-argument">_displayProp</span>);<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#6766">onRegenerateDisplay</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#6768">periodicCall</a> (<span class="code-storage-keyword">const</span> <a class="code-type" href="class_ewol__event__Time.html">ewol::event::Time</a> & <span class="code-argument">_event</span>);<br/></pre>
<br/>
<h2>Object Hierarchy:<h2>
<pre>
+<a href="../ewol/class_ewol__Object.html">ewol::Object</a><br/> +--> +<a href="../ewol/class_ewol__Widget.html">ewol::Widget</a><br/> +--> ege::widget::Scene<br/></pre>
<h2>Detail:</h2>
<a id="6696"/><a id="6697"/><h3>eventPlayTimeChange</h3><pre>
+ <span class="code-storage-keyword">const</span> <span class="code-type" >char</span>* <span class="code-storage-keyword">const</span> <span class="code-member">eventPlayTimeChange</span>;<br/></pre>
<br/>
<br/>
<hr/>
<a id="6698"/><h3>eventKillEnemy</h3><pre>
+ <span class="code-storage-keyword">const</span> <span class="code-type" >char</span>* <span class="code-storage-keyword">const</span> <span class="code-member">eventKillEnemy</span>;<br/></pre>
<br/>
<br/>
<hr/>
<a id="6699"/><h3>m_env</h3><pre>
# <a class="code-type" href="class_ege__Environement.html">ege::Environement</a> <span class="code-member">m_env</span>;<br/></pre>
<br/>
<br/>
<hr/>
<a id="6702"/><h3>Scene</h3><pre>
+ <span class="code-function">Scene</span> (<span class="code-type" >bool</span> <span class="code-argument">_setAutoBullet</span>,<br/> <span class="code-type" >bool</span> <span class="code-argument">_setAutoCamera</span>);<br/></pre>
Constructor of the widget classes<br/><ul>
<table class="parameter-list">
<tr><td><b>Return: </b></td><td></td><td>(no execption generated (not managed in embended platform))</td></tr></table>
</ul>
<br/>
<hr/>
<a id="6704"/><h3>~Scene</h3><pre>
+ <span class="code-storage-keyword">virtual</span> <span class="code-function">~Scene</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
Destructor of the widget classes<br/>
<br/>
<hr/>
<a id="6710"/><h3>setBulletConfig</h3><pre>
+ <span class="code-type" >void</span> <span class="code-function">setBulletConfig</span> (btDefaultCollisionConfiguration* <span class="code-argument">_collisionConfiguration</span>,<br/> btCollisionDispatcher* <span class="code-argument">_dispatcher</span>,<br/> btBroadphaseInterface* <span class="code-argument">_broadphase</span>,<br/> btConstraintSolver* <span class="code-argument">_solver</span>,<br/> btDynamicsWorld* <span class="code-argument">_dynamicsWorld</span>);<br/></pre>
<br/>
<br/>
<hr/>
<a id="6713"/><h3>setCamera</h3><pre>
+ <span class="code-type" >void</span> <span class="code-function">setCamera</span> (<a class="code-type" href="class_ege__Camera.html">ege::Camera</a>* <span class="code-argument">_camera</span>);<br/></pre>
<br/>
<br/>
<hr/>
<a id="6714"/><h3>m_angleView</h3><pre>
# <span class="code-type" >float</span> <span class="code-member">m_angleView</span>;<br/></pre>
<br/>
<br/>
<hr/>
<a id="6715"/><h3>m_collisionConfiguration</h3><pre>
# btDefaultCollisionConfiguration* <span class="code-member">m_collisionConfiguration</span>;<br/></pre>
this is the most important class<br/>
<br/>
<hr/>
<a id="6716"/><h3>m_dispatcher</h3><pre>
# btCollisionDispatcher* <span class="code-member">m_dispatcher</span>;<br/></pre>
<br/>
<br/>
<hr/>
<a id="6717"/><h3>m_broadphase</h3><pre>
# btBroadphaseInterface* <span class="code-member">m_broadphase</span>;<br/></pre>
<br/>
<br/>
<hr/>
<a id="6718"/><h3>m_solver</h3><pre>
# btConstraintSolver* <span class="code-member">m_solver</span>;<br/></pre>
<br/>
<br/>
<hr/>
<a id="6719"/><h3>m_dynamicsWorld</h3><pre>
# btDynamicsWorld* <span class="code-member">m_dynamicsWorld</span>;<br/></pre>
<br/>
<br/>
<hr/>
<a id="6720"/><h3>m_camera</h3><pre>
# <a class="code-type" href="class_ege__Camera.html">ege::Camera</a>* <span class="code-member">m_camera</span>;<br/></pre>
display point of view.<br/>
<br/>
<hr/>
<a id="6721"/><h3>m_isRunning</h3><pre>
# <span class="code-type" >bool</span> <span class="code-member">m_isRunning</span>;<br/></pre>
the display is running (not in pause)<br/>
<br/>
<hr/>
<a id="6722"/><h3>m_ratioTime</h3><pre>
# <span class="code-type" >float</span> <span class="code-member">m_ratioTime</span>;<br/></pre>
Ratio time for the speed of the game ...<br/>
<br/>
<hr/>
<a id="6723"/><h3>m_displayElementOrdered</h3><pre>
# <a class="code-type" href="http://www.cplusplus.com/reference/vector/vector/">std::vector</a>&lt;ege::Environement::ResultNearestElement&gt; <span class="code-member">m_displayElementOrdered</span>;<br/></pre>
<br/>
<br/>
<hr/>
<a id="6725"/><h3>pause</h3><pre>
+ <span class="code-type" >void</span> <span class="code-function">pause</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
set the scene in pause for a while<br/>
<br/>
<hr/>
<a id="6727"/><h3>resume</h3><pre>
+ <span class="code-type" >void</span> <span class="code-function">resume</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
resume the scene activity<br/>
<br/>
<hr/>
<a id="6729"/><h3>pauseToggle</h3><pre>
+ <span class="code-type" >void</span> <span class="code-function">pauseToggle</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
Toggle between pause and running<br/>
<br/>
<hr/>
<a id="6730"/><h3>m_debugMode</h3><pre>
# <span class="code-type" >bool</span> <span class="code-member">m_debugMode</span>;<br/></pre>
<br/>
<br/>
<hr/>
<a id="6731"/><h3>m_debugDrawing</h3><pre>
# <a class="code-type" href="class_ewol__resource__Colored3DObject.html">ewol::resource::Colored3DObject</a>* <span class="code-member">m_debugDrawing</span>;<br/></pre>
for the debug draw elements<br/>
<br/>
<hr/>
<a id="6733"/><h3>debugToggle</h3><pre>
+ <span class="code-type" >void</span> <span class="code-function">debugToggle</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
Toggle the debug mode == &gt; usefull for DEBUG only ...<br/>
<br/>
<hr/>
<a id="6736"/><h3>ScenePeriodicCall</h3><pre>
# <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">ScenePeriodicCall</span> (<span class="code-type" >int64_t</span> <span class="code-argument">_localTime</span>,<br/> <span class="code-type" >int32_t</span> <span class="code-argument">_deltaTime</span>);<br/></pre>
<br/>
<br/>
<hr/>
<a id="6738"/><h3>calculateDeltaAngle</h3><pre>
+ vec2 <span class="code-function">calculateDeltaAngle</span> (<span class="code-storage-keyword">const</span> vec2 & <span class="code-argument">_posScreen</span>);<br/></pre>
<br/>
<br/>
<hr/>
<a id="6740"/><h3>convertScreenPositionInMapPosition</h3><pre>
+ vec3 <span class="code-function">convertScreenPositionInMapPosition</span> (<span class="code-storage-keyword">const</span> vec2 & <span class="code-argument">_posScreen</span>);<br/></pre>
<br/>
<br/>
<hr/>
<a id="6742"/><h3>getCamera</h3><pre>
+ <a class="code-type" href="class_ege__Camera.html">ege::Camera</a> & <span class="code-function">getCamera</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
get the current camera reference for the scene rendering<br/>
<br/>
<hr/>
<a id="6744"/><h3>setRatioTime</h3><pre>
+ <span class="code-type" >void</span> <span class="code-function">setRatioTime</span> (<span class="code-type" >float</span> <span class="code-argument">_newRatio</span>);<br/></pre>
set the curent Time Ratio (default 1)<br/>
<br/>
<hr/>
<a id="6746"/><h3>renderscene</h3><pre>
+ <span class="code-type" >void</span> <span class="code-function">renderscene</span> (<span class="code-type" >int</span> <span class="code-argument">pass</span>);<br/></pre>
<br/>
<br/>
<hr/>
<a id="6753"/><h3>drawOpenGL</h3><pre>
+ <span class="code-type" >void</span> <span class="code-function">drawOpenGL</span> (btScalar* <span class="code-argument">m</span>,<br/> <span class="code-storage-keyword">const</span> btCollisionShape* <span class="code-argument">_shape</span>,<br/> <span class="code-storage-keyword">const</span> btVector3 & <span class="code-argument">_color</span>,<br/> <span class="code-type" >int32_t</span> <span class="code-argument">_debugMode</span>,<br/> <span class="code-storage-keyword">const</span> btVector3 & <span class="code-argument">_worldBoundsMin</span>,<br/> <span class="code-storage-keyword">const</span> btVector3 & <span class="code-argument">_worldBoundsMax</span>);<br/></pre>
<br/>
<br/>
<hr/>
<a id="6759"/><h3>drawSphere</h3><pre>
+ <span class="code-type" >void</span> <span class="code-function">drawSphere</span> (btScalar <span class="code-argument">_radius</span>,<br/> <span class="code-type" >int</span> <span class="code-argument">_lats</span>,<br/> <span class="code-type" >int</span> <span class="code-argument">_longs</span>,<br/> mat4 & <span class="code-argument">_transformationMatrix</span>,<br/> <a class="code-type" href="class_etk__Color.html">etk::Color</a>&lt;float&gt; & <span class="code-argument">_tmpColor</span>);<br/></pre>
<br/>
<br/>
<hr/>
<a id="6762"/><h3>getElementAroundNewElement</h3><pre>
+ <span class="code-type" >void</span> <span class="code-function">getElementAroundNewElement</span> (vec3 <span class="code-argument">_sourcePosition</span>,<br/> <a class="code-type" href="http://www.cplusplus.com/reference/vector/vector/">std::vector</a>&lt;ege::Environement::ResultNearestElement&gt; & <span class="code-argument">_resultList</span>);<br/></pre>
<br/>
<br/>
<hr/>
<a id="6764"/><h3>onDraw</h3><pre>
# <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">onDraw</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
Common widget drawing function (called by the drawing thread [Android, X11, ...])<br/>
<br/>
<hr/>
<a id="6766"/><h3>systemDraw</h3><pre>
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">systemDraw</span> (<span class="code-storage-keyword">const</span> <a class="code-type" href="class_ewol__DrawProperty.html">ewol::DrawProperty</a> & <span class="code-argument">_displayProp</span>);<br/></pre>
{SYSTEM} extern interface to request a draw ... (called by the drawing thread [Android, X11, ...])
This function generate a clipping with the viewport openGL system. Like this a widget draw can not draw over an other widget<br/><b>Note:</b> This function is virtual for the scrolled widget, and the more complicated openGl widget<br/> <b>Note:</b> : INTERNAL EWOL SYSTEM<br/> <ul>
<table class="parameter-list">
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_displayProp</span> </td><td> properties of the current display</td></tr>
</table>
</ul>
<br/>
<hr/>
<a id="6768"/><h3>onRegenerateDisplay</h3><pre>
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">onRegenerateDisplay</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
Event generated when a redraw is needed<br/>
<br/>
<hr/>
<h3>periodicCall</h3><pre>
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">periodicCall</span> (<span class="code-storage-keyword">const</span> <a class="code-type" href="class_ewol__event__Time.html">ewol::event::Time</a> & <span class="code-argument">_event</span>);<br/></pre>
periodic call of this widget<br/><ul>
<table class="parameter-list">
<td><b>Parameter:</b></td><td><span class="code-argument">_event</span> </td><td> Current time property</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