libAthena
/
athena
mirror of https://github.com/libAthena/athena.git
2
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
athena/docs/class_athena_1_1_sakura_1_1...

255 lines
19 KiB
HTML
Raw Normal View History

Add documentation (prelim)
2015-05-21 09:00:28 +00:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.9.1"/>
<title>Athena IO Library: Athena::Sakura::Sprite 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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</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>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</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 style="padding-left: 0.5em;">
<div id="projectname">Athena IO Library
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('class_athena_1_1_sakura_1_1_sprite.html','');});
</script>
<div id="doc-content">
<!-- 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 class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_athena_1_1_sakura_1_1_sprite-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Athena::Sakura::Sprite Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Collaboration diagram for Athena::Sakura::Sprite:</div>
<div class="dyncontent">
<div class="center"><img src="class_athena_1_1_sakura_1_1_sprite__coll__graph.png" border="0" usemap="#_athena_1_1_sakura_1_1_sprite_coll__map" alt="Collaboration graph"/></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:a3714ce90ba0a50e82cb9c4c05ab1bb35"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3714ce90ba0a50e82cb9c4c05ab1bb35"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>Sprite</b> (<a class="el" href="class_athena_1_1_sakura_1_1_sprite_file.html">SpriteFile</a> *root)</td></tr>
<tr class="separator:a3714ce90ba0a50e82cb9c4c05ab1bb35"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5e7f2457927256c52998147ce8c68aeb"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5e7f2457927256c52998147ce8c68aeb"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>Sprite</b> (<a class="el" href="class_athena_1_1_sakura_1_1_sprite_file.html">SpriteFile</a> *root, const std::string &amp;name)</td></tr>
<tr class="separator:a5e7f2457927256c52998147ce8c68aeb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a61e8cf2b592fbf53c8c3dff828899b24"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a61e8cf2b592fbf53c8c3dff828899b24"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>setPosition</b> (const float x, const float y)</td></tr>
<tr class="separator:a61e8cf2b592fbf53c8c3dff828899b24"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a01ba17724dbdc7ba2079b7a644587202"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a01ba17724dbdc7ba2079b7a644587202"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>setPosition</b> (const <a class="el" href="class_athena_1_1_sakura_1_1_vector2_d.html">Vector2Df</a> &amp;pos)</td></tr>
<tr class="separator:a01ba17724dbdc7ba2079b7a644587202"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad04224c771bf4dfcdea4c1acea5f5508"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad04224c771bf4dfcdea4c1acea5f5508"></a>
virtual <a class="el" href="class_athena_1_1_sakura_1_1_vector2_d.html">Vector2Df</a>&#160;</td><td class="memItemRight" valign="bottom"><b>position</b> () const </td></tr>
<tr class="separator:ad04224c771bf4dfcdea4c1acea5f5508"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3ffd5bdf4f9a509a86f6fc7651d9c559"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3ffd5bdf4f9a509a86f6fc7651d9c559"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>setName</b> (const std::string &amp;name)</td></tr>
<tr class="separator:a3ffd5bdf4f9a509a86f6fc7651d9c559"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a55d8272f32d43fc973a466b3b947ffcc"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a55d8272f32d43fc973a466b3b947ffcc"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><b>name</b> () const </td></tr>
<tr class="separator:a55d8272f32d43fc973a466b3b947ffcc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a16093b6c58b6d501e63878cdef5039cf"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a16093b6c58b6d501e63878cdef5039cf"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>addStateId</b> (int id)</td></tr>
<tr class="separator:a16093b6c58b6d501e63878cdef5039cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8717ac9b9947b356cdca8b227457b9b3"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_athena_1_1_sakura_1_1_sprite.html#a8717ac9b9947b356cdca8b227457b9b3">stateId</a> (int index) const </td></tr>
<tr class="memdesc:a8717ac9b9947b356cdca8b227457b9b3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the texture id of a given state. <a href="#a8717ac9b9947b356cdca8b227457b9b3">More...</a><br /></td></tr>
<tr class="separator:a8717ac9b9947b356cdca8b227457b9b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a064575f10c9b410614370b28342eb290"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a064575f10c9b410614370b28342eb290"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>setStateIds</b> (std::vector&lt; int &gt; ids)</td></tr>
<tr class="separator:a064575f10c9b410614370b28342eb290"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7587b8c9421c7acf4c89f2f9017c957b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7587b8c9421c7acf4c89f2f9017c957b"></a>
std::vector&lt; int &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>stateIds</b> () const </td></tr>
<tr class="separator:a7587b8c9421c7acf4c89f2f9017c957b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab7131032dde39f5a9a2d854a3c42b2f1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab7131032dde39f5a9a2d854a3c42b2f1"></a>
atUint32&#160;</td><td class="memItemRight" valign="bottom"><b>stateCount</b> () const </td></tr>
<tr class="separator:ab7131032dde39f5a9a2d854a3c42b2f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa06a8a062e5e7eb45765f901577c81fd"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa06a8a062e5e7eb45765f901577c81fd"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>setCurrentState</b> (atUint32 id)</td></tr>
<tr class="separator:aa06a8a062e5e7eb45765f901577c81fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a81435ce7a0f6b9b6772257fef265bacc"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a81435ce7a0f6b9b6772257fef265bacc"></a>
atUint32&#160;</td><td class="memItemRight" valign="bottom"><b>currentState</b> () const </td></tr>
<tr class="separator:a81435ce7a0f6b9b6772257fef265bacc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac7663f799b3c81c0adc7eb06e3003ca9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac7663f799b3c81c0adc7eb06e3003ca9"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>addFrame</b> (<a class="el" href="class_athena_1_1_sakura_1_1_sprite_frame.html">SpriteFrame</a> *Frame)</td></tr>
<tr class="separator:ac7663f799b3c81c0adc7eb06e3003ca9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae7ecdb5931b148dce9343148ce0dd1a2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae7ecdb5931b148dce9343148ce0dd1a2"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>removeFrame</b> (<a class="el" href="class_athena_1_1_sakura_1_1_sprite_frame.html">SpriteFrame</a> *Frame)</td></tr>
<tr class="separator:ae7ecdb5931b148dce9343148ce0dd1a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae215ca7352b108b82c5b0292fdb00d68"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae215ca7352b108b82c5b0292fdb00d68"></a>
<a class="el" href="class_athena_1_1_sakura_1_1_sprite_frame.html">SpriteFrame</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>Frame</b> (atUint32 id)</td></tr>
<tr class="separator:ae215ca7352b108b82c5b0292fdb00d68"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a16615fd87dcc820b6ac05d8f9b9d8a7a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a16615fd87dcc820b6ac05d8f9b9d8a7a"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>setFrame</b> (atUint32 id)</td></tr>
<tr class="separator:a16615fd87dcc820b6ac05d8f9b9d8a7a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a37a5924bc43977a101a0842788cde725"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a37a5924bc43977a101a0842788cde725"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>setFrames</b> (std::vector&lt; <a class="el" href="class_athena_1_1_sakura_1_1_sprite_frame.html">SpriteFrame</a> * &gt; frames)</td></tr>
<tr class="separator:a37a5924bc43977a101a0842788cde725"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a867bd300573879a266bc9de4dae622cf"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a867bd300573879a266bc9de4dae622cf"></a>
atUint32&#160;</td><td class="memItemRight" valign="bottom"><b>frameCount</b> () const </td></tr>
<tr class="separator:a867bd300573879a266bc9de4dae622cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a62c6886d3f95d5961e3a91d91c5af101"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a62c6886d3f95d5961e3a91d91c5af101"></a>
std::vector&lt; <a class="el" href="class_athena_1_1_sakura_1_1_sprite_frame.html">SpriteFrame</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>frames</b> () const </td></tr>
<tr class="separator:a62c6886d3f95d5961e3a91d91c5af101"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa5374e2757ba23a46f784b14e4881692"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa5374e2757ba23a46f784b14e4881692"></a>
<a class="el" href="class_athena_1_1_sakura_1_1_sprite_file.html">SpriteFile</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>container</b> () const </td></tr>
<tr class="separator:aa5374e2757ba23a46f784b14e4881692"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5e7974600dff457040683b8ec7613733"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5e7974600dff457040683b8ec7613733"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>setCurrentFrame</b> (<a class="el" href="class_athena_1_1_sakura_1_1_sprite_frame.html">SpriteFrame</a> *frame)</td></tr>
<tr class="separator:a5e7974600dff457040683b8ec7613733"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a30922311b28662601c8c552677879ab5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a30922311b28662601c8c552677879ab5"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>setCurrentFrame</b> (atUint32 id)</td></tr>
<tr class="separator:a30922311b28662601c8c552677879ab5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a68851adee874e3917afd38751c2c0dfb"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a68851adee874e3917afd38751c2c0dfb"></a>
<a class="el" href="class_athena_1_1_sakura_1_1_sprite_frame.html">SpriteFrame</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>currentFrame</b> () const </td></tr>
<tr class="separator:a68851adee874e3917afd38751c2c0dfb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8ac892903d266c2a4d87c66fbf35df27"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8ac892903d266c2a4d87c66fbf35df27"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>advanceFrame</b> ()</td></tr>
<tr class="separator:a8ac892903d266c2a4d87c66fbf35df27"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a849d875c4a8931ef79166c1c9b4f2493"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a849d875c4a8931ef79166c1c9b4f2493"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>retreatFrame</b> ()</td></tr>
<tr class="separator:a849d875c4a8931ef79166c1c9b4f2493"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afe0d7d26bc8183514aa037ed0793861f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afe0d7d26bc8183514aa037ed0793861f"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>setRoot</b> (<a class="el" href="class_athena_1_1_sakura_1_1_sprite_file.html">SpriteFile</a> *root)</td></tr>
<tr class="separator:afe0d7d26bc8183514aa037ed0793861f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a74f15ba7c643ef057fb1e5cb56ec6cfe"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a74f15ba7c643ef057fb1e5cb56ec6cfe"></a>
<a class="el" href="class_athena_1_1_sakura_1_1_sprite_file.html">SpriteFile</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>root</b> () const </td></tr>
<tr class="separator:a74f15ba7c643ef057fb1e5cb56ec6cfe"><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>Definition at line <a class="el" href="_sprite_8hpp_source.html#l00039">39</a> of file <a class="el" href="_sprite_8hpp_source.html">Sprite.hpp</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a8717ac9b9947b356cdca8b227457b9b3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Athena::Sakura::Sprite::stateId </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>index</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the texture id of a given state. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">index</td><td>The index of the id. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>return the state id if it exists, -1 otherwise </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/Athena/<a class="el" href="_sprite_8hpp_source.html">Sprite.hpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><b>Athena</b></li><li class="navelem"><b>Sakura</b></li><li class="navelem"><a class="el" href="class_athena_1_1_sakura_1_1_sprite.html">Sprite</a></li>
<li class="footer">Generated on Thu May 21 2015 01:59:43 for Athena IO Library by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9.1 </li>
</ul>
</div>
</body>
</html>