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

391 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>ewol Library</h1>
<div id="menu">
<h2>ewol</h2>
<ul class="niveau1">
<li class="sousmenu"><a>compositing</a>
<ul class="niveau2">
<li><a href="ewol__Compositing.html">Compositing</a></li>
<li><a href="ewol__compositing__Area.html">Area</a></li>
<li><a href="ewol__compositing__Drawing.html">Drawing</a></li>
<li><a href="ewol__compositing__Image.html">Image</a></li>
<li><a href="ewol__compositing__Shaper.html">Shaper</a></li>
<li><a href="ewol__compositing__Sprite.html">Sprite</a></li>
<li><a href="ewol__compositing__Text.html">Text</a></li>
</ul>
</li>
<li class="sousmenu"><a>context</a>
<ul class="niveau2">
<li><a href="ewol__Context.html">Context</a></li>
<li><a href="ewol__context__CommandLine.html">CommandLine</a></li>
<li><a href="ewol__context__ConfigFont.html">ConfigFont</a></li>
<li><a href="ewol__context__InputManager.html">InputManager</a></li>
<li class="sousmenu"><a href="ewol__context__clipBoard.html">clipBoard</a>
<ul class="niveau3">
<li><a href="ewol__context__clipBoard.html::clipboardListe">clipboardListe</a></li>
</ul>
</li>
<li><a href="ewol__context__cursorDisplay.html">cursorDisplay</a></li>
</ul>
</li>
<li class="sousmenu"><a>event</a>
<ul class="niveau2">
<li><a href="ewol__event__Entry.html">Entry</a></li>
<li><a href="ewol__event__EntrySystem.html">EntrySystem</a></li>
<li><a href="ewol__event__Input.html">Input</a></li>
<li><a href="ewol__event__InputSystem.html">InputSystem</a></li>
<li><a href="ewol__event__Time.html">Time</a></li>
</ul>
</li>
<li class="sousmenu"><a>key</a>
<ul class="niveau2">
<li><a href="ewol__key__Special.html">Special</a></li>
<li><a href="ewol__key__keyboard.html">keyboard</a></li>
<li><a href="ewol__key__status.html">status</a></li>
<li><a href="ewol__key__type.html">type</a></li>
</ul>
</li>
<li class="sousmenu"><a>object</a>
<ul class="niveau2">
<li><a href="ewol__Object.html">Object</a></li>
<li><a href="ewol__object__Config.html">Config</a></li>
<li><a href="ewol__object__ConfigElement.html">ConfigElement</a></li>
<li><a href="ewol__object__Manager.html">Manager</a></li>
<li><a href="ewol__object__Message.html">Message</a></li>
<li class="sousmenu"><a href="ewol__object__MultiCast.html">MultiCast</a>
<ul class="niveau3">
<li><a href="ewol__object__MultiCast.html::MessageList">MessageList</a></li>
</ul>
</li>
</ul>
</li>
<li class="sousmenu"><a>openGL</a>
<ul class="niveau2">
<li><a href="ewol__openGL__openGlFlags.html">openGlFlags</a></li>
</ul>
</li>
<li class="sousmenu"><a>resource</a>
<ul class="niveau2">
<li><a href="ewol__Resource.html">Resource</a></li>
<li><a href="ewol__resource__Colored3DObject.html">Colored3DObject</a></li>
<li><a href="ewol__resource__ConfigFile.html">ConfigFile</a></li>
<li><a href="ewol__resource__FontBase.html">FontBase</a></li>
<li><a href="ewol__resource__FontFreeType.html">FontFreeType</a></li>
<li><a href="ewol__resource__Manager.html">Manager</a></li>
<li><a href="ewol__resource__Program.html">Program</a></li>
<li><a href="ewol__resource__Shader.html">Shader</a></li>
<li><a href="ewol__resource__Texture.html">Texture</a></li>
<li><a href="ewol__resource__TextureFile.html">TextureFile</a></li>
<li><a href="ewol__resource__TexturedFont.html">TexturedFont</a></li>
<li><a href="ewol__resource__VirtualBufferObject.html">VirtualBufferObject</a></li>
</ul>
</li>
<li class="sousmenu"><a>widget</a>
<ul class="niveau2">
<li><a href="ewol__Widget.html">Widget</a></li>
<li><a href="ewol__widget__Button.html">Button</a></li>
<li><a href="ewol__widget__ButtonColor.html">ButtonColor</a></li>
<li><a href="ewol__widget__CheckBox.html">CheckBox</a></li>
<li><a href="ewol__widget__ColorBar.html">ColorBar</a></li>
<li><a href="ewol__widget__ColorChooser.html">ColorChooser</a></li>
<li><a href="ewol__widget__Composer.html">Composer</a></li>
<li><a href="ewol__widget__Container.html">Container</a></li>
<li><a href="ewol__widget__ContainerN.html">ContainerN</a></li>
<li><a href="ewol__widget__ContextMenu.html">ContextMenu</a></li>
<li><a href="ewol__widget__Entry.html">Entry</a></li>
<li><a href="ewol__widget__FileChooser.html">FileChooser</a></li>
<li class="sousmenu"><a href="ewol__widget__Gird.html">Gird</a>
<ul class="niveau3">
<li><a href="ewol__widget__Gird.html::GirdProperties">GirdProperties</a></li>
</ul>
</li>
<li><a href="ewol__widget__Image.html">Image</a></li>
<li><a href="ewol__widget__Joystick.html">Joystick</a></li>
<li><a href="ewol__widget__Label.html">Label</a></li>
<li><a href="ewol__widget__Layer.html">Layer</a></li>
<li><a href="ewol__widget__List.html">List</a></li>
<li><a href="ewol__widget__ListFileSystem.html">ListFileSystem</a></li>
<li><a href="ewol__widget__Manager.html">Manager</a></li>
<li><a href="ewol__widget__Menu.html">Menu</a></li>
<li><a href="ewol__widget__MenuElement.html">MenuElement</a></li>
<li><a href="ewol__widget__Parameter.html">Parameter</a></li>
<li><a href="ewol__widget__ParameterList.html">ParameterList</a></li>
<li><a href="ewol__widget__PopUp.html">PopUp</a></li>
<li><a href="ewol__widget__ProgressBar.html">ProgressBar</a></li>
<li><a href="ewol__widget__Scroll.html">Scroll</a></li>
<li><a href="ewol__widget__Sizer.html">Sizer</a></li>
<li><a href="ewol__widget__Slider.html">Slider</a></li>
<li><a href="ewol__widget__Spacer.html">Spacer</a></li>
<li><a href="ewol__widget__StdPopUp.html">StdPopUp</a></li>
<li><a href="ewol__widget__WSlider.html">WSlider</a></li>
<li><a href="ewol__widget__WidgetScrooled.html">WidgetScrooled</a></li>
<li><a href="ewol__widget__Windows.html">Windows</a></li>
<li><a href="ewol__widget__elementPL.html">elementPL</a></li>
</ul>
</li>
<ul>
<h3> </h3>
</div>
</div>
</div>
<div class="container" id="content">
<h1>Class: ewol::compositing::Shaper</h1>
<br/>
<h2>Constructor and Destructor:</h2>
<pre>
+ <a class="code-function" href="#Shaper">Shaper</a> (<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_shaperName</span>);<br>+ ~<a class="code-function" href="#Shaper">Shaper</a> (<span class="code-type">void</span>);<br></pre>
<h2>Synopsis:</h2>
<pre>
+ <span class="code-type">void</span> <a class="code-function" href="#draw">draw</a> (<span class="code-type">bool</span> <span class="code-argument">_disableDepthTest</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#clear">clear</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">bool</span> <a class="code-function" href="#changeStatusIn">changeStatusIn</a> (<span class="code-type">int32_t</span> <span class="code-argument">_newStatusId</span>);<br>+ <span class="code-type">int32_t</span> <a class="code-function" href="#getCurrentDisplayedStatus">getCurrentDisplayedStatus</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">int32_t</span> <a class="code-function" href="#getNextDisplayedStatus">getNextDisplayedStatus</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">float</span> <a class="code-function" href="#getTransitionStatus">getTransitionStatus</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">bool</span> <a class="code-function" href="#periodicCall">periodicCall</a> (<span class="code-storage-keyword">const</span> <a href="ewol__event__Time.html" class="code-type">ewol::event::Time</a> & <span class="code-argument">_event</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#setOrigin">setOrigin</a> (<span class="code-storage-keyword">const</span> vec2 & <span class="code-argument">_newOri</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#setSize">setSize</a> (<span class="code-storage-keyword">const</span> vec2 & <span class="code-argument">_newSize</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#setInsideSize">setInsideSize</a> (<span class="code-storage-keyword">const</span> vec2 & <span class="code-argument">_newInsideSize</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#setInsidePos">setInsidePos</a> (<span class="code-storage-keyword">const</span> vec2 & <span class="code-argument">_newInsidePos</span>);<br>+ vec2 <a class="code-function" href="#getPadding">getPadding</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#setSource">setSource</a> (<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_newFile</span>);<br>+ <span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <a class="code-function" href="#getSource">getSource</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">bool</span> <a class="code-function" href="#hasSources">hasSources</a> (<span class="code-type">void</span>);<br>- <span class="code-type">void</span> <a class="code-function" href="#loadProgram">loadProgram</a> (<span class="code-type">void</span>);<br>- <span class="code-type">void</span> <a class="code-function" href="#unLoadProgram">unLoadProgram</a> (<span class="code-type">void</span>);<br>- <span class="code-type">void</span> <a class="code-function" href="#updateVertex">updateVertex</a> (<span class="code-type">void</span>);<br></pre>
<h2>Object Hierarchy:</h2>
<pre>
<a href="ewol__Compositing.html">ewol::Compositing</a>
+--> <b>ewol::compositing::Shaper</b>
</pre>
<br/>
<h2>Description:</h2>
/**
* @brief the Shaper system is a basic theme configuration for every widget, it corespond at a background display described by a pool of files
*/<h2>Detail:<h2>
<h3>ewol::compositing::<a id="Shaper">Shaper</a> ()</h3>
<pre>
<span class="code-function">Shaper</span>(<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_shaperName</span>);</pre>
<br/>
generic constructor
<br/><ul>
<b>Parameter [input]:</b> <span class="code-argument">_shaperName</span> Name of the file that might be loaded
<br/></ul>
<br/>
<hr/>
<h3>ewol::compositing::~<a id="Shaper">Shaper</a> ()</h3>
<pre>
~<span class="code-function">Shaper</span>(<span class="code-type">void</span>);</pre>
<br/>
generic destructor
<br/><br/>
<hr/>
<h3><a id="draw">draw</a> ()</h3>
<pre>
<span class="code-type">void</span> <span class="code-function">draw</span>(<span class="code-type">bool</span> <span class="code-argument">_disableDepthTest</span>);</pre>
<br/>
draw All the refistered text in the current element on openGL
<br/><br/>
<hr/>
<h3><a id="clear">clear</a> ()</h3>
<pre>
<span class="code-type">void</span> <span class="code-function">clear</span>(<span class="code-type">void</span>);</pre>
<br/>
clear alll tre registered element in the current element
<br/><br/>
<hr/>
<h3><a id="changeStatusIn">changeStatusIn</a> ()</h3>
<pre>
<span class="code-type">bool</span> <span class="code-function">changeStatusIn</span>(<span class="code-type">int32_t</span> <span class="code-argument">_newStatusId</span>);</pre>
<br/>
change the current status in an other
<br/><ul>
<b>Parameter [input]:</b> <span class="code-argument">_newStatusId</span> the next new status requested
<br/><b>Return:</b> true The widget must call this fuction periodicly (and redraw itself)
<br/><b>Return:</b> false No need to request the periodic call.
<br/></ul>
<br/>
<hr/>
<h3><a id="getCurrentDisplayedStatus">getCurrentDisplayedStatus</a> ()</h3>
<pre>
<span class="code-type">int32_t</span> <span class="code-function">getCurrentDisplayedStatus</span>(<span class="code-type">void</span>);</pre>
<br/>
get the current displayed status of the shaper
<br/><ul>
<b>Return:</b> The Status Id
<br/></ul>
<br/>
<hr/>
<h3><a id="getNextDisplayedStatus">getNextDisplayedStatus</a> ()</h3>
<pre>
<span class="code-type">int32_t</span> <span class="code-function">getNextDisplayedStatus</span>(<span class="code-type">void</span>);</pre>
<br/>
get the next displayed status of the shaper
<br/><ul>
<b>Return:</b> The next status Id (-1 if no status in next)
<br/></ul>
<br/>
<hr/>
<h3><a id="getTransitionStatus">getTransitionStatus</a> ()</h3>
<pre>
<span class="code-type">float</span> <span class="code-function">getTransitionStatus</span>(<span class="code-type">void</span>);</pre>
<br/>
get the current trasion status
<br/><ul>
<b>Return:</b> value of the transition status (0.0f when no activity)
<br/></ul>
<br/>
<hr/>
<h3><a id="periodicCall">periodicCall</a> ()</h3>
<pre>
<span class="code-type">bool</span> <span class="code-function">periodicCall</span>(<span class="code-storage-keyword">const</span> <a href="ewol__event__Time.html" class="code-type">ewol::event::Time</a> & <span class="code-argument">_event</span>);</pre>
<br/>
Same as the widfget periodic call (this is for change display)
<br/><ul>
<b>Parameter [input]:</b> <span class="code-argument">_event</span> The current time of the call.
<br/><b>Return:</b> true The widget must call this fuction periodicly (and redraw itself)
<br/><b>Return:</b> false No need to request the periodic call.
<br/></ul>
<br/>
<hr/>
<h3><a id="setOrigin">setOrigin</a> ()</h3>
<pre>
<span class="code-type">void</span> <span class="code-function">setOrigin</span>(<span class="code-storage-keyword">const</span> vec2 & <span class="code-argument">_newOri</span>);</pre>
<br/>
set the widget origin (needed fot the display)
<br/><ul>
<b>Parameter [input]:</b> <span class="code-argument">_newOri</span> : the new widget origin
<br/></ul>
<br/>
<hr/>
<h3><a id="setSize">setSize</a> ()</h3>
<pre>
<span class="code-type">void</span> <span class="code-function">setSize</span>(<span class="code-storage-keyword">const</span> vec2 & <span class="code-argument">_newSize</span>);</pre>
<br/>
set the widget size (needed fot the display)
<br/><ul>
<b>Parameter [input]:</b> <span class="code-argument">_newSize</span> : the new widget size
<br/></ul>
<br/>
<hr/>
<h3><a id="setInsideSize">setInsideSize</a> ()</h3>
<pre>
<span class="code-type">void</span> <span class="code-function">setInsideSize</span>(<span class="code-storage-keyword">const</span> vec2 & <span class="code-argument">_newInsideSize</span>);</pre>
<br/>
set the internal widget size
<br/><ul>
<b>Parameter [input]:</b> <span class="code-argument">_newInsidePos</span> : the subelement size.
<br/></ul>
<br/>
<hr/>
<h3><a id="setInsidePos">setInsidePos</a> ()</h3>
<pre>
<span class="code-type">void</span> <span class="code-function">setInsidePos</span>(<span class="code-storage-keyword">const</span> vec2 & <span class="code-argument">_newInsidePos</span>);</pre>
<br/>
set the internal widget position
<br/><ul>
<b>Parameter [input]:</b> <span class="code-argument">_newInsidePos</span> : the subelement position
<br/></ul>
<br/>
<hr/>
<h3><a id="getPadding">getPadding</a> ()</h3>
<pre>
vec2 <span class="code-function">getPadding</span>(<span class="code-type">void</span>);</pre>
<br/>
get the padding declared by the user in the config file
<br/><ul>
<b>Return:</b> the padding property
<br/></ul>
<br/>
<hr/>
<h3><a id="setSource">setSource</a> ()</h3>
<pre>
<span class="code-type">void</span> <span class="code-function">setSource</span>(<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_newFile</span>);</pre>
<br/>
change the shaper Source
<br/><ul>
<b>Parameter [input]:</b> <span class="code-argument">_newFile</span> New file of the shaper
<br/></ul>
<br/>
<hr/>
<h3><a id="getSource">getSource</a> ()</h3>
<pre>
<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-function">getSource</span>(<span class="code-type">void</span>);</pre>
<br/>
get the shaper file Source
<br/><ul>
<b>Return:</b> the shapper file name
<br/></ul>
<br/>
<hr/>
<h3><a id="hasSources">hasSources</a> ()</h3>
<pre>
<span class="code-type">bool</span> <span class="code-function">hasSources</span>(<span class="code-type">void</span>);</pre>
<br/>
Sometimes the user declare an image but not allocate the ressources all the time, this is to know it ..
<br/><ul>
<b>Return:</b> the validity od the resources.
<br/></ul>
<br/>
<hr/>
<h3><a id="loadProgram">loadProgram</a> ()</h3>
<pre>
<span class="code-type">void</span> <span class="code-function">loadProgram</span>(<span class="code-type">void</span>);</pre>
<br/>
load the openGL program and get all the ID needed
<br/><br/>
<hr/>
<h3><a id="unLoadProgram">unLoadProgram</a> ()</h3>
<pre>
<span class="code-type">void</span> <span class="code-function">unLoadProgram</span>(<span class="code-type">void</span>);</pre>
<br/>
Un-Load the openGL program and get all the ID needed
<br/><br/>
<hr/>
<h3><a id="updateVertex">updateVertex</a> ()</h3>
<pre>
<span class="code-type">void</span> <span class="code-function">updateVertex</span>(<span class="code-type">void</span>);</pre>
<br/>
update the internal vertex table.
<br/><br/>
<hr/>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink