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/classRAY_1_1ModelAnimation.html
T
AnonymusRaccoon adc7dd8d5c Deploying the documentation
2021-06-26 11:31:13 +00:00

402 lines
19 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: RAY::ModelAnimation 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="namespaceRAY.html">RAY</a></li><li class="navelem"><a class="el" href="classRAY_1_1ModelAnimation.html">ModelAnimation</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="classRAY_1_1ModelAnimation-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">RAY::ModelAnimation Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A Holder for Model Animations.
<a href="classRAY_1_1ModelAnimation.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="ModelAnimation_8hpp_source.html">ModelAnimation.hpp</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for RAY::ModelAnimation:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classRAY_1_1ModelAnimation__coll__graph.svg" width="323" height="206"><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:ad5eddcb7ed4e7e238910fde745a4b338"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRAY_1_1ModelAnimation.html#ad5eddcb7ed4e7e238910fde745a4b338">ModelAnimation</a> (::<a class="el" href="classRAY_1_1ModelAnimation.html">ModelAnimation</a> animation)</td></tr>
<tr class="memdesc:ad5eddcb7ed4e7e238910fde745a4b338"><td class="mdescLeft">&#160;</td><td class="mdescRight">A Model animation constructor. <a href="classRAY_1_1ModelAnimation.html#ad5eddcb7ed4e7e238910fde745a4b338">More...</a><br /></td></tr>
<tr class="separator:ad5eddcb7ed4e7e238910fde745a4b338"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa5d5d64332d780a2429e6618a24b31f8"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRAY_1_1ModelAnimation.html#aa5d5d64332d780a2429e6618a24b31f8">ModelAnimation</a> (const <a class="el" href="classRAY_1_1ModelAnimation.html">ModelAnimation</a> &amp;)=default</td></tr>
<tr class="memdesc:aa5d5d64332d780a2429e6618a24b31f8"><td class="mdescLeft">&#160;</td><td class="mdescRight">A default copy-constructor. <a href="classRAY_1_1ModelAnimation.html#aa5d5d64332d780a2429e6618a24b31f8">More...</a><br /></td></tr>
<tr class="separator:aa5d5d64332d780a2429e6618a24b31f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac53c54161396d06326826485e5108575"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classRAY_1_1ModelAnimation.html">ModelAnimation</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRAY_1_1ModelAnimation.html#ac53c54161396d06326826485e5108575">operator=</a> (const <a class="el" href="classRAY_1_1ModelAnimation.html">ModelAnimation</a> &amp;)=default</td></tr>
<tr class="memdesc:ac53c54161396d06326826485e5108575"><td class="mdescLeft">&#160;</td><td class="mdescRight">A model animation is assignable. <a href="classRAY_1_1ModelAnimation.html#ac53c54161396d06326826485e5108575">More...</a><br /></td></tr>
<tr class="separator:ac53c54161396d06326826485e5108575"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5e548ba387930541f0c86f5b612d84eb"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRAY_1_1ModelAnimation.html#a5e548ba387930541f0c86f5b612d84eb">getFrameCounter</a> () const</td></tr>
<tr class="memdesc:a5e548ba387930541f0c86f5b612d84eb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the current frame the animation is at. <a href="classRAY_1_1ModelAnimation.html#a5e548ba387930541f0c86f5b612d84eb">More...</a><br /></td></tr>
<tr class="separator:a5e548ba387930541f0c86f5b612d84eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5683de73335fb04d1bea8549daf363ef"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRAY_1_1ModelAnimation.html#a5683de73335fb04d1bea8549daf363ef">getFrameCount</a> () const</td></tr>
<tr class="memdesc:a5683de73335fb04d1bea8549daf363ef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the number of frame in the animation. <a href="classRAY_1_1ModelAnimation.html#a5683de73335fb04d1bea8549daf363ef">More...</a><br /></td></tr>
<tr class="separator:a5683de73335fb04d1bea8549daf363ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a318e345dd16cea46197dd54787b45e97"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classRAY_1_1ModelAnimation.html">ModelAnimation</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRAY_1_1ModelAnimation.html#a318e345dd16cea46197dd54787b45e97">setFrameCounter</a> (size_t frameCounter)</td></tr>
<tr class="memdesc:a318e345dd16cea46197dd54787b45e97"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the frame the position is at. <a href="classRAY_1_1ModelAnimation.html#a318e345dd16cea46197dd54787b45e97">More...</a><br /></td></tr>
<tr class="separator:a318e345dd16cea46197dd54787b45e97"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a84350b1ba37b6960104d9eaea45bd2a7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classRAY_1_1ModelAnimation.html">ModelAnimation</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRAY_1_1ModelAnimation.html#a84350b1ba37b6960104d9eaea45bd2a7">incrementFrameCounter</a> ()</td></tr>
<tr class="memdesc:a84350b1ba37b6960104d9eaea45bd2a7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Increment the frame counter. <a href="classRAY_1_1ModelAnimation.html#a84350b1ba37b6960104d9eaea45bd2a7">More...</a><br /></td></tr>
<tr class="separator:a84350b1ba37b6960104d9eaea45bd2a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a14a4b379364f0c36fc875826e28ef18e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRAY_1_1ModelAnimation.html#a14a4b379364f0c36fc875826e28ef18e">~ModelAnimation</a> ()=default</td></tr>
<tr class="memdesc:a14a4b379364f0c36fc875826e28ef18e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default destructor. <a href="classRAY_1_1ModelAnimation.html#a14a4b379364f0c36fc875826e28ef18e">More...</a><br /></td></tr>
<tr class="separator:a14a4b379364f0c36fc875826e28ef18e"><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:a815c3c698edb40e0992df87282170c2f"><td class="memItemLeft" align="right" valign="top">::<a class="el" href="classRAY_1_1ModelAnimation.html">ModelAnimation</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRAY_1_1ModelAnimation.html#a815c3c698edb40e0992df87282170c2f">_animation</a></td></tr>
<tr class="separator:a815c3c698edb40e0992df87282170c2f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acdc078d1b381e8ff8e022c698c77020a"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRAY_1_1ModelAnimation.html#acdc078d1b381e8ff8e022c698c77020a">_frameCounter</a></td></tr>
<tr class="separator:acdc078d1b381e8ff8e022c698c77020a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeebdbe6f1e5064aa91493033cc80b3f7"><td class="memItemLeft" align="right" valign="top">INTERNAL&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRAY_1_1ModelAnimation.html#aeebdbe6f1e5064aa91493033cc80b3f7">__pad0__</a>: operator ::<a class="el" href="classRAY_1_1ModelAnimation.html">ModelAnimation</a>() const</td></tr>
<tr class="separator:aeebdbe6f1e5064aa91493033cc80b3f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A Holder for Model Animations. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ad5eddcb7ed4e7e238910fde745a4b338"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad5eddcb7ed4e7e238910fde745a4b338">&#9670;&nbsp;</a></span>ModelAnimation() <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">RAY::ModelAnimation::ModelAnimation </td>
<td>(</td>
<td class="paramtype">::<a class="el" href="classRAY_1_1ModelAnimation.html">ModelAnimation</a>&#160;</td>
<td class="paramname"><em>animation</em></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>A Model animation constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">animationPtr</td><td>an animation pointer, returned by the nimation-loading function </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aa5d5d64332d780a2429e6618a24b31f8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa5d5d64332d780a2429e6618a24b31f8">&#9670;&nbsp;</a></span>ModelAnimation() <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">RAY::ModelAnimation::ModelAnimation </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classRAY_1_1ModelAnimation.html">ModelAnimation</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>A default copy-constructor. </p>
</div>
</div>
<a id="a14a4b379364f0c36fc875826e28ef18e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a14a4b379364f0c36fc875826e28ef18e">&#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">RAY::ModelAnimation::~ModelAnimation </td>
<td>(</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>Default destructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a5683de73335fb04d1bea8549daf363ef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5683de73335fb04d1bea8549daf363ef">&#9670;&nbsp;</a></span>getFrameCount()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t RAY::ModelAnimation::getFrameCount </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the number of frame in the animation. </p>
</div>
</div>
<a id="a5e548ba387930541f0c86f5b612d84eb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5e548ba387930541f0c86f5b612d84eb">&#9670;&nbsp;</a></span>getFrameCounter()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t RAY::ModelAnimation::getFrameCounter </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the current frame the animation is at. </p>
</div>
</div>
<a id="a84350b1ba37b6960104d9eaea45bd2a7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a84350b1ba37b6960104d9eaea45bd2a7">&#9670;&nbsp;</a></span>incrementFrameCounter()</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; RAY::ModelAnimation::incrementFrameCounter </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Increment the frame counter. </p>
</div>
</div>
<a id="ac53c54161396d06326826485e5108575"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac53c54161396d06326826485e5108575">&#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="classRAY_1_1ModelAnimation.html">ModelAnimation</a>&amp; RAY::ModelAnimation::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classRAY_1_1ModelAnimation.html">ModelAnimation</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>A model animation is assignable. </p>
</div>
</div>
<a id="a318e345dd16cea46197dd54787b45e97"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a318e345dd16cea46197dd54787b45e97">&#9670;&nbsp;</a></span>setFrameCounter()</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; RAY::ModelAnimation::setFrameCounter </td>
<td>(</td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>frameCounter</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the frame the position is at. </p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="aeebdbe6f1e5064aa91493033cc80b3f7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeebdbe6f1e5064aa91493033cc80b3f7">&#9670;&nbsp;</a></span>__pad0__</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">INTERNAL RAY::ModelAnimation::__pad0__</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a815c3c698edb40e0992df87282170c2f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a815c3c698edb40e0992df87282170c2f">&#9670;&nbsp;</a></span>_animation</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_1ModelAnimation.html">ModelAnimation</a> RAY::ModelAnimation::_animation</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="acdc078d1b381e8ff8e022c698c77020a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acdc078d1b381e8ff8e022c698c77020a">&#9670;&nbsp;</a></span>_frameCounter</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t RAY::ModelAnimation::_frameCounter</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>lib/Ray/sources/Model/<a class="el" href="ModelAnimation_8hpp_source.html">ModelAnimation.hpp</a></li>
<li>lib/Ray/sources/Model/<a class="el" href="ModelAnimation_8cpp.html">ModelAnimation.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