226 lines
21 KiB
HTML
226 lines
21 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>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/"> [ 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::Environement</h1><hr/><h2>Description:</h2>
|
|
|
|
<br/><br/>
|
|
<h2>class:</h2>
|
|
<ul>
|
|
<li><a href="class_ege__Environement__ResultNearestElement.html">ResultNearestElement</a></li></ul>
|
|
<h2>Constructor and Destructor:</h2>
|
|
<pre>
|
|
+ <a class="code-function" href="#6596">Environement</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/>+ <span class="code-storage-keyword">virtual</span> <a class="code-function" href="#6598">~Environement</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
|
|
<br/>
|
|
<h2>Synopsis:</h2>
|
|
<pre>
|
|
+ <span class="code-type" >void</span> <a class="code-function" href="#6600">addCreator</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">_type</span>,<br/> ege::createElement_tf <span class="code-argument">_creator</span>);<br/>+ <a class="code-type" href="class_ege__ElementGame.html">ege::ElementGame</a>* <a class="code-function" href="#6603">createElement</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">_type</span>,<br/> <span class="code-type" >bool</span> <span class="code-argument">_autoAddElement</span>,<br/> <span class="code-storage-keyword">enum</span> <a class="code-type" href="enum_ege__property.html">ege::property</a> <span class="code-argument">_property</span>,<br/> <span class="code-type" >void</span>* <span class="code-argument">_value</span>);<br/>+ <a class="code-type" href="class_ege__ElementGame.html">ege::ElementGame</a>* <a class="code-function" href="#6608">createElement</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">_type</span>,<br/> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> & <span class="code-argument">_description</span>,<br/> <span class="code-type" >bool</span> <span class="code-argument">_autoAddElement</span>);<br/>+ <a class="code-type" href="class_ege__ElementGame.html">ege::ElementGame</a>* <a class="code-function" href="#6612">createElement</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">_type</span>,<br/> <a class="code-type" href="class_ejson__Value.html">ejson::Value</a>* <span class="code-argument">_value</span>,<br/> <span class="code-type" >bool</span> <span class="code-argument">_autoAddElement</span>);<br/>+ <a class="code-type" href="class_ege__ElementGame.html">ege::ElementGame</a>* <a class="code-function" href="#6616">createElement</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">_type</span>,<br/> <a class="code-type" href="class_exml__Node.html">exml::Node</a>* <span class="code-argument">_node</span>,<br/> <span class="code-type" >bool</span> <span class="code-argument">_autoAddElement</span>);<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#6623">setDynamicWorld</a> (btDynamicsWorld* <span class="code-argument">_newWorld</span>);<br/>+ btDynamicsWorld* <a class="code-function" href="#6625">getDynamicWorld</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/>+ <a class="code-type" href="http://www.cplusplus.com/reference/vector/vector/">std::vector</a><ege::ElementGame*> & <a class="code-function" href="#6627">getElementGame</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/>+ <a class="code-type" href="class_ege__ElementGame.html">ege::ElementGame</a>* <a class="code-function" href="#6629">getElementNearest</a> (<a class="code-type" href="class_ege__ElementGame.html">ege::ElementGame</a>* <span class="code-argument">_sourceRequest</span>,<br/> <span class="code-type" >float</span> & <span class="code-argument">_distance</span>);<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#6632">getElementNearest</a> (<span class="code-storage-keyword">const</span> vec3 & <span class="code-argument">_sourcePosition</span>,<br/> <span class="code-type" >float</span> <span class="code-argument">_distanceMax</span>,<br/> <a class="code-type" href="http://www.cplusplus.com/reference/vector/vector/">std::vector</a><ege::Environement::ResultNearestElement> & <span class="code-argument">_resultList</span>);<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#6636">getElementNearestFixed</a> (<span class="code-storage-keyword">const</span> vec3 & <span class="code-argument">_sourcePosition</span>,<br/> <span class="code-type" >float</span> <span class="code-argument">_distanceMax</span>,<br/> <a class="code-type" href="http://www.cplusplus.com/reference/vector/vector/">std::vector</a><ege::Environement::ResultNearestElement> & <span class="code-argument">_resultList</span>);<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#6640">addElementGame</a> (<a class="code-type" href="class_ege__ElementGame.html">ege::ElementGame</a>* <span class="code-argument">_newElement</span>);<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#6642">rmElementGame</a> (<a class="code-type" href="class_ege__ElementGame.html">ege::ElementGame</a>* <span class="code-argument">_removeElement</span>);<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#6644">getOrderedElementForDisplay</a> (<a class="code-type" href="http://www.cplusplus.com/reference/vector/vector/">std::vector</a><ege::Environement::ResultNearestElement> & <span class="code-argument">_resultList</span>,<br/> <span class="code-storage-keyword">const</span> vec3 & <span class="code-argument">_position</span>,<br/> <span class="code-storage-keyword">const</span> vec3 & <span class="code-argument">_direction</span>);<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#6648">generateInteraction</a> (<a class="code-type" href="class_ege__ElementInteraction.html">ege::ElementInteraction</a> & <span class="code-argument">_event</span>);<br/>+ <a class="code-type" href="class_ege__ParticuleEngine.html">ege::ParticuleEngine</a> & <a class="code-function" href="#6651">getParticuleEngine</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
|
|
<br/>
|
|
<h2>Detail:</h2>
|
|
<a id="6596"/><a id="6598"/><h3>Environement</h3><pre>
|
|
+ <span class="code-function">Environement</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
|
|
|
|
<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="6600"/><h3>~Environement</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-function">~Environement</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
|
|
|
|
<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="6603"/><h3>addCreator</h3><pre>
|
|
+ <span class="code-type" >void</span> <span class="code-function">addCreator</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">_type</span>,<br/> ege::createElement_tf <span class="code-argument">_creator</span>);<br/></pre>
|
|
add a creator element system<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_type</span> </td><td> Type of the element.</td></tr>
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_creator</span> </td><td> Function pointer that reference the element creating.</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="6608"/><h3>createElement</h3><pre>
|
|
+ <a class="code-type" href="class_ege__ElementGame.html">ege::ElementGame</a>* <span class="code-function">createElement</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">_type</span>,<br/> <span class="code-type" >bool</span> <span class="code-argument">_autoAddElement</span>,<br/> <span class="code-storage-keyword">enum</span> <a class="code-type" href="enum_ege__property.html">ege::property</a> <span class="code-argument">_property</span>,<br/> <span class="code-type" >void</span>* <span class="code-argument">_value</span>);<br/></pre>
|
|
Create an element on the curent scene.<br/><b>Note:</b> Pointer is return in case of setting properties on it...<br/> <ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_type</span> </td><td> Type of the element that might be created.</td></tr>
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_description</span> </td><td> String that describe the content of the element properties.</td></tr>
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_autoAddElement</span> </td><td> this permit to add the element if it is created == > no more action ...</td></tr>
|
|
<tr><td><b>Return: </b></td><td></td><td>NULL if an error occured OR the pointer on the element and it is already added on the system.</td></tr></table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="6612"/><h3>createElement</h3><pre>
|
|
+ <a class="code-type" href="class_ege__ElementGame.html">ege::ElementGame</a>* <span class="code-function">createElement</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">_type</span>,<br/> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> & <span class="code-argument">_description</span>,<br/> <span class="code-type" >bool</span> <span class="code-argument">_autoAddElement</span>);<br/></pre>
|
|
|
|
<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="6616"/><h3>createElement</h3><pre>
|
|
+ <a class="code-type" href="class_ege__ElementGame.html">ege::ElementGame</a>* <span class="code-function">createElement</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">_type</span>,<br/> <a class="code-type" href="class_ejson__Value.html">ejson::Value</a>* <span class="code-argument">_value</span>,<br/> <span class="code-type" >bool</span> <span class="code-argument">_autoAddElement</span>);<br/></pre>
|
|
|
|
<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="6623"/><h3>createElement</h3><pre>
|
|
+ <a class="code-type" href="class_ege__ElementGame.html">ege::ElementGame</a>* <span class="code-function">createElement</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">_type</span>,<br/> <a class="code-type" href="class_exml__Node.html">exml::Node</a>* <span class="code-argument">_node</span>,<br/> <span class="code-type" >bool</span> <span class="code-argument">_autoAddElement</span>);<br/></pre>
|
|
|
|
<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="6625"/><h3>setDynamicWorld</h3><pre>
|
|
+ <span class="code-type" >void</span> <span class="code-function">setDynamicWorld</span> (btDynamicsWorld* <span class="code-argument">_newWorld</span>);<br/></pre>
|
|
set the curent world<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_newWorld</span> </td><td> Pointer on the current world</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="6627"/><h3>getDynamicWorld</h3><pre>
|
|
+ btDynamicsWorld* <span class="code-function">getDynamicWorld</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
|
|
get the curent world<br/><ul>
|
|
<table class="parameter-list">
|
|
<tr><td><b>Return: </b></td><td></td><td>pointer on the current world</td></tr></table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="6629"/><h3>getElementGame</h3><pre>
|
|
+ <a class="code-type" href="http://www.cplusplus.com/reference/vector/vector/">std::vector</a><ege::ElementGame*> & <span class="code-function">getElementGame</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
|
|
<ul>
|
|
<table class="parameter-list">
|
|
<tr><td><b>Return: </b></td><td></td><td>all element list</td></tr></table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="6632"/><h3>getElementNearest</h3><pre>
|
|
+ <a class="code-type" href="class_ege__ElementGame.html">ege::ElementGame</a>* <span class="code-function">getElementNearest</span> (<a class="code-type" href="class_ege__ElementGame.html">ege::ElementGame</a>* <span class="code-argument">_sourceRequest</span>,<br/> <span class="code-type" >float</span> & <span class="code-argument">_distance</span>);<br/></pre>
|
|
get the nearest Element<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_sourceRequest</span> </td><td> Pointer on the element that request this.</td></tr>
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_distance</span> </td><td> Maximum distance search == > return the element distance</td></tr>
|
|
<tr><td><b>Return: </b></td><td></td><td>Pointer on the neares element OR NULL</td></tr></table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="6636"/><h3>getElementNearest</h3><pre>
|
|
+ <span class="code-type" >void</span> <span class="code-function">getElementNearest</span> (<span class="code-storage-keyword">const</span> vec3 & <span class="code-argument">_sourcePosition</span>,<br/> <span class="code-type" >float</span> <span class="code-argument">_distanceMax</span>,<br/> <a class="code-type" href="http://www.cplusplus.com/reference/vector/vector/">std::vector</a><ege::Environement::ResultNearestElement> & <span class="code-argument">_resultList</span>);<br/></pre>
|
|
|
|
<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="6640"/><h3>getElementNearestFixed</h3><pre>
|
|
+ <span class="code-type" >void</span> <span class="code-function">getElementNearestFixed</span> (<span class="code-storage-keyword">const</span> vec3 & <span class="code-argument">_sourcePosition</span>,<br/> <span class="code-type" >float</span> <span class="code-argument">_distanceMax</span>,<br/> <a class="code-type" href="http://www.cplusplus.com/reference/vector/vector/">std::vector</a><ege::Environement::ResultNearestElement> & <span class="code-argument">_resultList</span>);<br/></pre>
|
|
|
|
<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="6642"/><h3>addElementGame</h3><pre>
|
|
+ <span class="code-type" >void</span> <span class="code-function">addElementGame</span> (<a class="code-type" href="class_ege__ElementGame.html">ege::ElementGame</a>* <span class="code-argument">_newElement</span>);<br/></pre>
|
|
add an element on the list availlable.<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_newElement</span> </td><td> Element to add.</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="6644"/><h3>rmElementGame</h3><pre>
|
|
+ <span class="code-type" >void</span> <span class="code-function">rmElementGame</span> (<a class="code-type" href="class_ege__ElementGame.html">ege::ElementGame</a>* <span class="code-argument">_removeElement</span>);<br/></pre>
|
|
remove an element on the list availlable.<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_removeElement</span> </td><td> Element to remove.</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="6648"/><h3>getOrderedElementForDisplay</h3><pre>
|
|
+ <span class="code-type" >void</span> <span class="code-function">getOrderedElementForDisplay</span> (<a class="code-type" href="http://www.cplusplus.com/reference/vector/vector/">std::vector</a><ege::Environement::ResultNearestElement> & <span class="code-argument">_resultList</span>,<br/> <span class="code-storage-keyword">const</span> vec3 & <span class="code-argument">_position</span>,<br/> <span class="code-storage-keyword">const</span> vec3 & <span class="code-argument">_direction</span>);<br/></pre>
|
|
get the element order from the nearest to the farest, and remove all element that are not in the camera angle and axes.<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input] [output]:</b></td><td><span class="code-argument">_resultList</span> </td><td> List of the element ordered.</td></tr>
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_position</span> </td><td> Camera position in the space.</td></tr>
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_direction</span> </td><td> Camera direction of the view.</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="6651"/><h3>generateInteraction</h3><pre>
|
|
+ <span class="code-type" >void</span> <span class="code-function">generateInteraction</span> (<a class="code-type" href="class_ege__ElementInteraction.html">ege::ElementInteraction</a> & <span class="code-argument">_event</span>);<br/></pre>
|
|
generate an event on all the sub element of the game == > usefull for explosion, or lazer fire ...<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_event</span> </td><td> event that might be apply ...</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<h3>getParticuleEngine</h3><pre>
|
|
+ <a class="code-type" href="class_ege__ParticuleEngine.html">ege::ParticuleEngine</a> & <span class="code-function">getParticuleEngine</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
|
|
get the particule engine reference.<br/><ul>
|
|
<table class="parameter-list">
|
|
<tr><td><b>Return: </b></td><td></td><td>The requested reference on the engine</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>
|