zoriya/Bomberman
1
0
Fork 0
mirror of https://github.com/zoriya/Bomberman.git synced 2026-06-03 10:26:29 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
Documentation
Bomberman/classBBM_1_1AnimationsComponent.html
T
AnonymusRaccoon adc7dd8d5c Deploying the documentation
2021-06-26 11:31:13 +00:00

606 lines
36 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Bomberman: BBM::AnimationsComponent Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Bomberman
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceBBM.html">BBM</a></li><li class="navelem"><a class="el" href="classBBM_1_1AnimationsComponent.html">AnimationsComponent</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classBBM_1_1AnimationsComponent-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">BBM::AnimationsComponent Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="AnimationsComponent_8hpp_source.html">AnimationsComponent.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for BBM::AnimationsComponent:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classBBM_1_1AnimationsComponent__inherit__graph.svg" width="266" height="522"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
<div class="dynheader">
Collaboration diagram for BBM::AnimationsComponent:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classBBM_1_1AnimationsComponent__coll__graph.svg" width="480" height="1418"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ab11abcdf13c666cffab59ef36ad303a4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWAL_1_1Component.html">WAL::Component</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBBM_1_1AnimationsComponent.html#ab11abcdf13c666cffab59ef36ad303a4">clone</a> (<a class="el" href="classWAL_1_1Entity.html">WAL::Entity</a> &amp;entity) const override</td></tr>
<tr class="memdesc:ab11abcdf13c666cffab59ef36ad303a4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clone a component for another or the same entity. <a href="classBBM_1_1AnimationsComponent.html#ab11abcdf13c666cffab59ef36ad303a4">More...</a><br /></td></tr>
<tr class="separator:ab11abcdf13c666cffab59ef36ad303a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5c756faf75bed0628c6a65b3b61026ff"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBBM_1_1AnimationsComponent.html#a5c756faf75bed0628c6a65b3b61026ff">getCurrentAnimIndex</a> () const</td></tr>
<tr class="memdesc:a5c756faf75bed0628c6a65b3b61026ff"><td class="mdescLeft">&#160;</td><td class="mdescRight">get the current animation index <a href="classBBM_1_1AnimationsComponent.html#a5c756faf75bed0628c6a65b3b61026ff">More...</a><br /></td></tr>
<tr class="separator:a5c756faf75bed0628c6a65b3b61026ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa3e39c1ba0e3dfbcd2b00fbd05bd6be1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBBM_1_1AnimationsComponent.html#aa3e39c1ba0e3dfbcd2b00fbd05bd6be1">setAnimIndex</a> (int animIndex)</td></tr>
<tr class="memdesc:aa3e39c1ba0e3dfbcd2b00fbd05bd6be1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the animation index to use. <a href="classBBM_1_1AnimationsComponent.html#aa3e39c1ba0e3dfbcd2b00fbd05bd6be1">More...</a><br /></td></tr>
<tr class="separator:aa3e39c1ba0e3dfbcd2b00fbd05bd6be1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1020f013fbd8136ec23513fc822f8b9c"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBBM_1_1AnimationsComponent.html#a1020f013fbd8136ec23513fc822f8b9c">getCurrentAnimFrameCounter</a> () const</td></tr>
<tr class="memdesc:a1020f013fbd8136ec23513fc822f8b9c"><td class="mdescLeft">&#160;</td><td class="mdescRight">get animation frame counter <a href="classBBM_1_1AnimationsComponent.html#a1020f013fbd8136ec23513fc822f8b9c">More...</a><br /></td></tr>
<tr class="separator:a1020f013fbd8136ec23513fc822f8b9c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7d3558300048cbd1242e1789913180e6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classRAY_1_1ModelAnimation.html">RAY::ModelAnimation</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBBM_1_1AnimationsComponent.html#a7d3558300048cbd1242e1789913180e6">getCurrentModelAnim</a> ()</td></tr>
<tr class="memdesc:a7d3558300048cbd1242e1789913180e6"><td class="mdescLeft">&#160;</td><td class="mdescRight">get the current <a href="classBBM_1_1AnimationsComponent.html#a7d3558300048cbd1242e1789913180e6">More...</a><br /></td></tr>
<tr class="separator:a7d3558300048cbd1242e1789913180e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7b63a50a3966cfe21eeb68eb7bab8a4b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBBM_1_1AnimationsComponent.html#a7b63a50a3966cfe21eeb68eb7bab8a4b">setCurrentAnimFrameCounter</a> (size_t animFrameCounter)</td></tr>
<tr class="memdesc:a7b63a50a3966cfe21eeb68eb7bab8a4b"><td class="mdescLeft">&#160;</td><td class="mdescRight">set the anim frame counter <a href="classBBM_1_1AnimationsComponent.html#a7b63a50a3966cfe21eeb68eb7bab8a4b">More...</a><br /></td></tr>
<tr class="separator:a7b63a50a3966cfe21eeb68eb7bab8a4b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6a619cb3651d566aac825a83de81c9fe"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBBM_1_1AnimationsComponent.html#a6a619cb3651d566aac825a83de81c9fe">resetCurrentAnimFrameCounter</a> ()</td></tr>
<tr class="memdesc:a6a619cb3651d566aac825a83de81c9fe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the internal anim counter to 0. <a href="classBBM_1_1AnimationsComponent.html#a6a619cb3651d566aac825a83de81c9fe">More...</a><br /></td></tr>
<tr class="separator:a6a619cb3651d566aac825a83de81c9fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1b830f97048016908efd456f6ac82570"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBBM_1_1AnimationsComponent.html#a1b830f97048016908efd456f6ac82570">incCurrentAnimFrameCounter</a> ()</td></tr>
<tr class="memdesc:a1b830f97048016908efd456f6ac82570"><td class="mdescLeft">&#160;</td><td class="mdescRight">Increment the internal anim counter. <a href="classBBM_1_1AnimationsComponent.html#a1b830f97048016908efd456f6ac82570">More...</a><br /></td></tr>
<tr class="separator:a1b830f97048016908efd456f6ac82570"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a84309d66583fbf29a346a2cc64b5b228"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBBM_1_1AnimationsComponent.html#a84309d66583fbf29a346a2cc64b5b228">setAnimDisabled</a> (bool disable)</td></tr>
<tr class="memdesc:a84309d66583fbf29a346a2cc64b5b228"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow to play pause animations. <a href="classBBM_1_1AnimationsComponent.html#a84309d66583fbf29a346a2cc64b5b228">More...</a><br /></td></tr>
<tr class="separator:a84309d66583fbf29a346a2cc64b5b228"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a25fd0cc4b28d3633104ba6815d55988f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBBM_1_1AnimationsComponent.html#a25fd0cc4b28d3633104ba6815d55988f">isAnimDisabled</a> () const</td></tr>
<tr class="memdesc:a25fd0cc4b28d3633104ba6815d55988f"><td class="mdescLeft">&#160;</td><td class="mdescRight">To know if the animation will be updated or not. <a href="classBBM_1_1AnimationsComponent.html#a25fd0cc4b28d3633104ba6815d55988f">More...</a><br /></td></tr>
<tr class="separator:a25fd0cc4b28d3633104ba6815d55988f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8ea40cb4e9247ff61ee6c6c69785eb20"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBBM_1_1AnimationsComponent.html#a8ea40cb4e9247ff61ee6c6c69785eb20">AnimationsComponent</a> (<a class="el" href="classWAL_1_1Entity.html">WAL::Entity</a> &amp;entity, const std::string &amp;path, int animIndex, bool play=true)</td></tr>
<tr class="memdesc:a8ea40cb4e9247ff61ee6c6c69785eb20"><td class="mdescLeft">&#160;</td><td class="mdescRight">ctor entity and the path of the animation file <a href="classBBM_1_1AnimationsComponent.html#a8ea40cb4e9247ff61ee6c6c69785eb20">More...</a><br /></td></tr>
<tr class="separator:a8ea40cb4e9247ff61ee6c6c69785eb20"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a10e022abaf8293837056f20720034801"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBBM_1_1AnimationsComponent.html#a10e022abaf8293837056f20720034801">AnimationsComponent</a> (const <a class="el" href="classBBM_1_1AnimationsComponent.html">AnimationsComponent</a> &amp;)=default</td></tr>
<tr class="memdesc:a10e022abaf8293837056f20720034801"><td class="mdescLeft">&#160;</td><td class="mdescRight">copy ctor <a href="classBBM_1_1AnimationsComponent.html#a10e022abaf8293837056f20720034801">More...</a><br /></td></tr>
<tr class="separator:a10e022abaf8293837056f20720034801"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac6d66c38a4f58d3d6be0980d2982d976"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBBM_1_1AnimationsComponent.html#ac6d66c38a4f58d3d6be0980d2982d976">~AnimationsComponent</a> () override=default</td></tr>
<tr class="memdesc:ac6d66c38a4f58d3d6be0980d2982d976"><td class="mdescLeft">&#160;</td><td class="mdescRight">dtor <a href="classBBM_1_1AnimationsComponent.html#ac6d66c38a4f58d3d6be0980d2982d976">More...</a><br /></td></tr>
<tr class="separator:ac6d66c38a4f58d3d6be0980d2982d976"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a73a5af2dd0578598aa4bf62d2f0be062"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classBBM_1_1AnimationsComponent.html">AnimationsComponent</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBBM_1_1AnimationsComponent.html#a73a5af2dd0578598aa4bf62d2f0be062">operator=</a> (const <a class="el" href="classBBM_1_1AnimationsComponent.html">AnimationsComponent</a> &amp;)=delete</td></tr>
<tr class="memdesc:a73a5af2dd0578598aa4bf62d2f0be062"><td class="mdescLeft">&#160;</td><td class="mdescRight">assignment operator <a href="classBBM_1_1AnimationsComponent.html#a73a5af2dd0578598aa4bf62d2f0be062">More...</a><br /></td></tr>
<tr class="separator:a73a5af2dd0578598aa4bf62d2f0be062"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classWAL_1_1Component"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classWAL_1_1Component')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classWAL_1_1Component.html">WAL::Component</a></td></tr>
<tr class="memitem:a155fb97f22714a0f489af7442d7d3253 inherit pub_methods_classWAL_1_1Component"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWAL_1_1Component.html">Component</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWAL_1_1Component.html#a155fb97f22714a0f489af7442d7d3253">operator=</a> (const <a class="el" href="classWAL_1_1Component.html">Component</a> &amp;)=delete</td></tr>
<tr class="memdesc:a155fb97f22714a0f489af7442d7d3253 inherit pub_methods_classWAL_1_1Component"><td class="mdescLeft">&#160;</td><td class="mdescRight">A component can't be assigned. <a href="classWAL_1_1Component.html#a155fb97f22714a0f489af7442d7d3253">More...</a><br /></td></tr>
<tr class="separator:a155fb97f22714a0f489af7442d7d3253 inherit pub_methods_classWAL_1_1Component"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3d8e13fdc53a63b0b1f8d15576f98cf8 inherit pub_methods_classWAL_1_1Component"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWAL_1_1Component.html#a3d8e13fdc53a63b0b1f8d15576f98cf8">~Component</a> ()=default</td></tr>
<tr class="memdesc:a3d8e13fdc53a63b0b1f8d15576f98cf8 inherit pub_methods_classWAL_1_1Component"><td class="mdescLeft">&#160;</td><td class="mdescRight">A virtual destructor. <a href="classWAL_1_1Component.html#a3d8e13fdc53a63b0b1f8d15576f98cf8">More...</a><br /></td></tr>
<tr class="separator:a3d8e13fdc53a63b0b1f8d15576f98cf8 inherit pub_methods_classWAL_1_1Component"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4acae0960f4232caf8395b2465dde8cc inherit pub_methods_classWAL_1_1Component"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWAL_1_1Component.html#a4acae0960f4232caf8395b2465dde8cc">onStart</a> ()</td></tr>
<tr class="memdesc:a4acae0960f4232caf8395b2465dde8cc inherit pub_methods_classWAL_1_1Component"><td class="mdescLeft">&#160;</td><td class="mdescRight">The entity or this component has just been enabled. <a href="classWAL_1_1Component.html#a4acae0960f4232caf8395b2465dde8cc">More...</a><br /></td></tr>
<tr class="separator:a4acae0960f4232caf8395b2465dde8cc inherit pub_methods_classWAL_1_1Component"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0f3f4fe54fd06de1e685835977fef050 inherit pub_methods_classWAL_1_1Component"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWAL_1_1Component.html#a0f3f4fe54fd06de1e685835977fef050">onStop</a> ()</td></tr>
<tr class="memdesc:a0f3f4fe54fd06de1e685835977fef050 inherit pub_methods_classWAL_1_1Component"><td class="mdescLeft">&#160;</td><td class="mdescRight">The entity or this component has just been disable. <a href="classWAL_1_1Component.html#a0f3f4fe54fd06de1e685835977fef050">More...</a><br /></td></tr>
<tr class="separator:a0f3f4fe54fd06de1e685835977fef050 inherit pub_methods_classWAL_1_1Component"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a78b8d643fe336a32989cd3cd46505e1c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classRAY_1_1ModelAnimations.html">RAY::ModelAnimations</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBBM_1_1AnimationsComponent.html#a78b8d643fe336a32989cd3cd46505e1c">_modelAnimation</a></td></tr>
<tr class="memdesc:a78b8d643fe336a32989cd3cd46505e1c"><td class="mdescLeft">&#160;</td><td class="mdescRight">To get the animation data. <a href="classBBM_1_1AnimationsComponent.html#a78b8d643fe336a32989cd3cd46505e1c">More...</a><br /></td></tr>
<tr class="separator:a78b8d643fe336a32989cd3cd46505e1c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3d104c36a297af2da59789cf787cb7cf"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBBM_1_1AnimationsComponent.html#a3d104c36a297af2da59789cf787cb7cf">_currentAnimIndex</a></td></tr>
<tr class="memdesc:a3d104c36a297af2da59789cf787cb7cf"><td class="mdescLeft">&#160;</td><td class="mdescRight">The index of the. <a href="classBBM_1_1AnimationsComponent.html#a3d104c36a297af2da59789cf787cb7cf">More...</a><br /></td></tr>
<tr class="separator:a3d104c36a297af2da59789cf787cb7cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a733298ab9653d04c76ba1b22813860cf"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBBM_1_1AnimationsComponent.html#a733298ab9653d04c76ba1b22813860cf">_animDisabled</a></td></tr>
<tr class="memdesc:a733298ab9653d04c76ba1b22813860cf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Bool allowing to play pause an animation. <a href="classBBM_1_1AnimationsComponent.html#a733298ab9653d04c76ba1b22813860cf">More...</a><br /></td></tr>
<tr class="separator:a733298ab9653d04c76ba1b22813860cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_methods_classWAL_1_1Component"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classWAL_1_1Component')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="classWAL_1_1Component.html">WAL::Component</a></td></tr>
<tr class="memitem:ad27cb4b0bdc95b6245f6b5a8c56cc78a inherit pro_methods_classWAL_1_1Component"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWAL_1_1Component.html#ad27cb4b0bdc95b6245f6b5a8c56cc78a">Component</a> (<a class="el" href="classWAL_1_1Entity.html">Entity</a> &amp;entity)</td></tr>
<tr class="memdesc:ad27cb4b0bdc95b6245f6b5a8c56cc78a inherit pro_methods_classWAL_1_1Component"><td class="mdescLeft">&#160;</td><td class="mdescRight">A component can't be instantiated, it should be derived. <a href="classWAL_1_1Component.html#ad27cb4b0bdc95b6245f6b5a8c56cc78a">More...</a><br /></td></tr>
<tr class="separator:ad27cb4b0bdc95b6245f6b5a8c56cc78a inherit pro_methods_classWAL_1_1Component"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3a3306df3733bfa77c70d789b650984b inherit pro_methods_classWAL_1_1Component"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWAL_1_1Component.html#a3a3306df3733bfa77c70d789b650984b">Component</a> (const <a class="el" href="classWAL_1_1Component.html">Component</a> &amp;)=default</td></tr>
<tr class="memdesc:a3a3306df3733bfa77c70d789b650984b inherit pro_methods_classWAL_1_1Component"><td class="mdescLeft">&#160;</td><td class="mdescRight">A component can't be instantiated, it should be derived. <a href="classWAL_1_1Component.html#a3a3306df3733bfa77c70d789b650984b">More...</a><br /></td></tr>
<tr class="separator:a3a3306df3733bfa77c70d789b650984b inherit pro_methods_classWAL_1_1Component"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_attribs_classWAL_1_1Component"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classWAL_1_1Component')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="classWAL_1_1Component.html">WAL::Component</a></td></tr>
<tr class="memitem:a3841f7c8cc4eeb9d1e97b3182976d89f inherit pro_attribs_classWAL_1_1Component"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWAL_1_1Entity.html">Entity</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWAL_1_1Component.html#a3841f7c8cc4eeb9d1e97b3182976d89f">_entity</a></td></tr>
<tr class="memdesc:a3841f7c8cc4eeb9d1e97b3182976d89f inherit pro_attribs_classWAL_1_1Component"><td class="mdescLeft">&#160;</td><td class="mdescRight">The entity that own this component. <a href="classWAL_1_1Component.html#a3841f7c8cc4eeb9d1e97b3182976d89f">More...</a><br /></td></tr>
<tr class="separator:a3841f7c8cc4eeb9d1e97b3182976d89f inherit pro_attribs_classWAL_1_1Component"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a8ea40cb4e9247ff61ee6c6c69785eb20"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8ea40cb4e9247ff61ee6c6c69785eb20">&#9670;&nbsp;</a></span>AnimationsComponent() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">BBM::AnimationsComponent::AnimationsComponent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classWAL_1_1Entity.html">WAL::Entity</a> &amp;&#160;</td>
<td class="paramname"><em>entity</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>path</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>animIndex</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>play</em> = <code>true</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>ctor entity and the path of the animation file </p>
</div>
</div>
<a id="a10e022abaf8293837056f20720034801"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a10e022abaf8293837056f20720034801">&#9670;&nbsp;</a></span>AnimationsComponent() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">BBM::AnimationsComponent::AnimationsComponent </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classBBM_1_1AnimationsComponent.html">AnimationsComponent</a> &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>copy ctor </p>
</div>
</div>
<a id="ac6d66c38a4f58d3d6be0980d2982d976"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac6d66c38a4f58d3d6be0980d2982d976">&#9670;&nbsp;</a></span>~AnimationsComponent()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">BBM::AnimationsComponent::~AnimationsComponent </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>dtor </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ab11abcdf13c666cffab59ef36ad303a4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab11abcdf13c666cffab59ef36ad303a4">&#9670;&nbsp;</a></span>clone()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWAL_1_1Component.html">WAL::Component</a> * BBM::AnimationsComponent::clone </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classWAL_1_1Entity.html">WAL::Entity</a> &amp;&#160;</td>
<td class="paramname"><em>entity</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Clone a component for another or the same entity. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">entity</td><td>The entity that owns the ne component. </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classWAL_1_1Component.html#a0bbee4f657e10fd190a28d15afe63e93">WAL::Component</a>.</p>
</div>
</div>
<a id="a1020f013fbd8136ec23513fc822f8b9c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1020f013fbd8136ec23513fc822f8b9c">&#9670;&nbsp;</a></span>getCurrentAnimFrameCounter()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t BBM::AnimationsComponent::getCurrentAnimFrameCounter </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>get animation frame counter </p>
</div>
</div>
<a id="a5c756faf75bed0628c6a65b3b61026ff"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5c756faf75bed0628c6a65b3b61026ff">&#9670;&nbsp;</a></span>getCurrentAnimIndex()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t BBM::AnimationsComponent::getCurrentAnimIndex </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>get the current animation index </p>
</div>
</div>
<a id="a7d3558300048cbd1242e1789913180e6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7d3558300048cbd1242e1789913180e6">&#9670;&nbsp;</a></span>getCurrentModelAnim()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classRAY_1_1ModelAnimation.html">RAY::ModelAnimation</a> &amp; BBM::AnimationsComponent::getCurrentModelAnim </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>get the current </p>
</div>
</div>
<a id="a1b830f97048016908efd456f6ac82570"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1b830f97048016908efd456f6ac82570">&#9670;&nbsp;</a></span>incCurrentAnimFrameCounter()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void BBM::AnimationsComponent::incCurrentAnimFrameCounter </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Increment the internal anim counter. </p>
</div>
</div>
<a id="a25fd0cc4b28d3633104ba6815d55988f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a25fd0cc4b28d3633104ba6815d55988f">&#9670;&nbsp;</a></span>isAnimDisabled()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool BBM::AnimationsComponent::isAnimDisabled </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>To know if the animation will be updated or not. </p>
</div>
</div>
<a id="a73a5af2dd0578598aa4bf62d2f0be062"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a73a5af2dd0578598aa4bf62d2f0be062">&#9670;&nbsp;</a></span>operator=()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classBBM_1_1AnimationsComponent.html">AnimationsComponent</a>&amp; BBM::AnimationsComponent::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classBBM_1_1AnimationsComponent.html">AnimationsComponent</a> &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>assignment operator </p>
</div>
</div>
<a id="a6a619cb3651d566aac825a83de81c9fe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6a619cb3651d566aac825a83de81c9fe">&#9670;&nbsp;</a></span>resetCurrentAnimFrameCounter()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void BBM::AnimationsComponent::resetCurrentAnimFrameCounter </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the internal anim counter to 0. </p>
</div>
</div>
<a id="a84309d66583fbf29a346a2cc64b5b228"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a84309d66583fbf29a346a2cc64b5b228">&#9670;&nbsp;</a></span>setAnimDisabled()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void BBM::AnimationsComponent::setAnimDisabled </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>disable</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Allow to play pause animations. </p>
</div>
</div>
<a id="aa3e39c1ba0e3dfbcd2b00fbd05bd6be1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa3e39c1ba0e3dfbcd2b00fbd05bd6be1">&#9670;&nbsp;</a></span>setAnimIndex()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void BBM::AnimationsComponent::setAnimIndex </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>animIndex</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the animation index to use. </p>
</div>
</div>
<a id="a7b63a50a3966cfe21eeb68eb7bab8a4b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7b63a50a3966cfe21eeb68eb7bab8a4b">&#9670;&nbsp;</a></span>setCurrentAnimFrameCounter()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void BBM::AnimationsComponent::setCurrentAnimFrameCounter </td>
<td>(</td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>animFrameCounter</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>set the anim frame counter </p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a733298ab9653d04c76ba1b22813860cf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a733298ab9653d04c76ba1b22813860cf">&#9670;&nbsp;</a></span>_animDisabled</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool BBM::AnimationsComponent::_animDisabled</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Bool allowing to play pause an animation. </p>
</div>
</div>
<a id="a3d104c36a297af2da59789cf787cb7cf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3d104c36a297af2da59789cf787cb7cf">&#9670;&nbsp;</a></span>_currentAnimIndex</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int BBM::AnimationsComponent::_currentAnimIndex</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The index of the. </p>
</div>
</div>
<a id="a78b8d643fe336a32989cd3cd46505e1c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a78b8d643fe336a32989cd3cd46505e1c">&#9670;&nbsp;</a></span>_modelAnimation</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classRAY_1_1ModelAnimations.html">RAY::ModelAnimations</a> BBM::AnimationsComponent::_modelAnimation</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>To get the animation data. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>sources/Component/Animation/<a class="el" href="AnimationsComponent_8hpp_source.html">AnimationsComponent.hpp</a></li>
<li>sources/Component/Animation/<a class="el" href="AnimationsComponent_8cpp.html">AnimationsComponent.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink