233 lines
10 KiB
HTML
233 lines
10 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">
|
|
</head>
|
|
<body>
|
|
<div class="navbar navbar-fixed-top">
|
|
<div class="container">
|
|
<h1>ege Library</h1>
|
|
<li>ege</li>
|
|
<ul>
|
|
<li><a href="ege__Camera.html">Camera</a></li>
|
|
<li><a href="ege__ElementGame.html">ElementGame</a></li>
|
|
<li><a href="ege__ElementGame__localIA.html">ElementGame::localIA</a></li>
|
|
<li><a href="ege__ElementInteraction.html">ElementInteraction</a></li>
|
|
<li><a href="ege__Environement.html">Environement</a></li>
|
|
<li><a href="ege__Environement__ResultNearestElement.html">Environement::ResultNearestElement</a></li>
|
|
<li><a href="ege__Particule.html">Particule</a></li>
|
|
<li><a href="ege__ParticuleEngine.html">ParticuleEngine</a></li>
|
|
<li><a href="ege__ParticuleSimple.html">ParticuleSimple</a></li>
|
|
<li><a href="ege__Scene.html">Scene</a></li>
|
|
<li><a href="ege__resource__ParticuleMesh.html">resource::ParticuleMesh</a></li>
|
|
</ul>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="container" id="content">
|
|
<h1>Class: ege::Camera</h1>
|
|
<br/>
|
|
<h2>Synopsis:</h2>
|
|
<pre>
|
|
+ <a class="code-function" href="#Camera">Camera</a> (<span class="code-storage-keyword">const</span> vec3 & <span class="code-argument">_eye</span>,<br/> <span class="code-type">float</span> <span class="code-argument">_angleZ</span>,<br/> <span class="code-type">float</span> <span class="code-argument">_angleTeta</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="#setEye">setEye</a> (<span class="code-storage-keyword">const</span> vec3 & <span class="code-argument">_eye</span>);<br>+ <span class="code-storage-keyword">const</span> vec3 & <a class="code-function" href="#getEye">getEye</a> (<span class="code-type">void</span>);<br>+ <span class="code-storage-keyword">const</span> vec3 & <a class="code-function" href="#getOrigin">getOrigin</a> (<span class="code-type">void</span>);<br>+ <span class="code-storage-keyword">const</span> vec3 & <a class="code-function" href="#getViewVector">getViewVector</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#setAngleZ">setAngleZ</a> (<span class="code-type">float</span> <span class="code-argument">_angleZ</span>);<br>+ <span class="code-type">float</span> <a class="code-function" href="#getAngleZ">getAngleZ</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#setAngleTeta">setAngleTeta</a> (<span class="code-type">float</span> <span class="code-argument">_angleTeta</span>);<br>+ <span class="code-type">float</span> <a class="code-function" href="#getAngleTeta">getAngleTeta</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#setDistance">setDistance</a> (<span class="code-type">float</span> <span class="code-argument">_distance</span>);<br>+ <span class="code-type">float</span> <a class="code-function" href="#getDistance">getDistance</a> (<span class="code-type">void</span>);<br>+ <span class="code-storage-keyword">const</span> mat4 & <a class="code-function" href="#getMatrix">getMatrix</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#setForcingViewTop">setForcingViewTop</a> (<span class="code-type">bool</span> <span class="code-argument">_newState</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#periodicCall">periodicCall</a> (<span class="code-type">float</span> <span class="code-argument">_step</span>);<br>+ vec3 <a class="code-function" href="#projectOnZGround">projectOnZGround</a> (<span class="code-storage-keyword">const</span> vec2 & <span class="code-argument">_cameraDeltaAngle</span>,<br/> <span class="code-type">float</span> <span class="code-argument">_zValue</span>);<br># <span class="code-type">void</span> <a class="code-function" href="#update">update</a> (<span class="code-type">void</span>);<br></pre>
|
|
|
|
|
|
<h2>Detail:<h2>
|
|
<h3>ege::<a id="Camera">Camera</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-function">Camera</span>(<span class="code-storage-keyword">const</span> vec3 & <span class="code-argument">_eye</span>,
|
|
<span class="code-type">float</span> <span class="code-argument">_angleZ</span>,
|
|
<span class="code-type">float</span> <span class="code-argument">_angleTeta</span>,
|
|
<span class="code-type">float</span> <span class="code-argument">_distance</span>);</pre>
|
|
<br/>
|
|
Constructor.
|
|
<br/><ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_eye</span> Position of the camera destination view.
|
|
<br/><b>Parameter [input]:</b> <span class="code-argument">_angleZ</span> Z rotation angle.
|
|
<br/><b>Parameter [input]:</b> <span class="code-argument">_angleTeta</span> Angle of the camera inclinason.
|
|
<br/><b>Parameter [input]:</b> <span class="code-argument">_distance</span> distance to the eye point
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="setEye">setEye</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">void</span> <span class="code-function">setEye</span>(<span class="code-storage-keyword">const</span> vec3 & <span class="code-argument">_eye</span>);</pre>
|
|
<br/>
|
|
set the position of the camera.
|
|
<br/><ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">pos</span> Position of the camera.
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="getEye">getEye</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-storage-keyword">const</span> vec3 & <span class="code-function">getEye</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
get the curent Camera Eye position.
|
|
<br/><ul>
|
|
<b>Return:</b> the current position.
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="getOrigin">getOrigin</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-storage-keyword">const</span> vec3 & <span class="code-function">getOrigin</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
get the curent Camera origin position.
|
|
<br/><ul>
|
|
<b>Return:</b> the current position.
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="getViewVector">getViewVector</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-storage-keyword">const</span> vec3 & <span class="code-function">getViewVector</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
Get the camera viewing vector.
|
|
<br/><ul>
|
|
<b>Return:</b> the current position.
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="setAngleZ">setAngleZ</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">void</span> <span class="code-function">setAngleZ</span>(<span class="code-type">float</span> <span class="code-argument">_angleZ</span>);</pre>
|
|
<br/>
|
|
set the angle on the camera
|
|
<br/><ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_angleZ</span> Rotation angle in Z
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="getAngleZ">getAngleZ</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">float</span> <span class="code-function">getAngleZ</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
get the curent Camera angles.
|
|
<br/><ul>
|
|
<b>Return:</b> the current angles Z.
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="setAngleTeta">setAngleTeta</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">void</span> <span class="code-function">setAngleTeta</span>(<span class="code-type">float</span> <span class="code-argument">_angleTeta</span>);</pre>
|
|
<br/>
|
|
set the angle on the camera
|
|
<br/><ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_angleTeta</span> Rotation angle in Teta
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="getAngleTeta">getAngleTeta</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">float</span> <span class="code-function">getAngleTeta</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
get the curent Camera angles.
|
|
<br/><ul>
|
|
<b>Return:</b> the current angles Teta.
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="setDistance">setDistance</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">void</span> <span class="code-function">setDistance</span>(<span class="code-type">float</span> <span class="code-argument">_distance</span>);</pre>
|
|
<br/>
|
|
set the angle on the camera
|
|
<br/><ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_distance</span> Distance to the eye
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="getDistance">getDistance</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">float</span> <span class="code-function">getDistance</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
get the curent Camera angles.
|
|
<br/><ul>
|
|
<b>Return:</b> the current distance to the eye.
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="getMatrix">getMatrix</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-storage-keyword">const</span> mat4 & <span class="code-function">getMatrix</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
get the transformation matix for the camera.
|
|
<br/><ul>
|
|
<b>Return:</b> the current transformation matrix
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="setForcingViewTop">setForcingViewTop</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">void</span> <span class="code-function">setForcingViewTop</span>(<span class="code-type">bool</span> <span class="code-argument">_newState</span>);</pre>
|
|
<br/>
|
|
change camera mode of view == > force to the top view
|
|
<br/><ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_newState</span> The new state of this mode...
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="periodicCall">periodicCall</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">void</span> <span class="code-function">periodicCall</span>(<span class="code-type">float</span> <span class="code-argument">_step</span>);</pre>
|
|
<br/>
|
|
It is really needed to call the camera periodicly for performing automatic movement
|
|
<br/><ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_step</span> step time of moving
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="projectOnZGround">projectOnZGround</a> ()</h3>
|
|
|
|
<pre>
|
|
vec3 <span class="code-function">projectOnZGround</span>(<span class="code-storage-keyword">const</span> vec2 & <span class="code-argument">_cameraDeltaAngle</span>,
|
|
<span class="code-type">float</span> <span class="code-argument">_zValue</span>);</pre>
|
|
<br/>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="update">update</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">void</span> <span class="code-function">update</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
update the matrix property
|
|
<br/><br/>
|
|
|
|
<hr/>
|
|
</div>
|
|
</body>
|
|
</html>
|