mirror of https://github.com/libAthena/athena.git
257 lines
19 KiB
HTML
257 lines
19 KiB
HTML
<!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.11"/>
|
|
<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 id="projectalign" 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.11 -->
|
|
<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 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 List</span></a></li>
|
|
<li><a href="classes.html"><span>Class Index</span></a></li>
|
|
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="functions.html"><span>Class 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('classathena_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> |
|
|
<a href="classathena_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="classathena_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>
|
|
<map name="athena_1_1_sakura_1_1_sprite_coll__map" id="athena_1_1_sakura_1_1_sprite_coll__map">
|
|
</map>
|
|
</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:afd892fd7ced4018084075b8ef58a54c1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afd892fd7ced4018084075b8ef58a54c1"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>Sprite</b> (<a class="el" href="classathena_1_1_sakura_1_1_sprite_file.html">SpriteFile</a> *root)</td></tr>
|
|
<tr class="separator:afd892fd7ced4018084075b8ef58a54c1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a68331f90d1c5ccf7b68a7f2df22f546d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a68331f90d1c5ccf7b68a7f2df22f546d"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>Sprite</b> (<a class="el" href="classathena_1_1_sakura_1_1_sprite_file.html">SpriteFile</a> *root, const std::string &name)</td></tr>
|
|
<tr class="separator:a68331f90d1c5ccf7b68a7f2df22f546d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a40bfcdad73bd519410b263f7fc4e1d4f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a40bfcdad73bd519410b263f7fc4e1d4f"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><b>setPosition</b> (const float x, const float y)</td></tr>
|
|
<tr class="separator:a40bfcdad73bd519410b263f7fc4e1d4f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad23770841b894a07c53f2f22ec4c809d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad23770841b894a07c53f2f22ec4c809d"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><b>setPosition</b> (const <a class="el" href="classathena_1_1_sakura_1_1_vector2_d.html">Vector2Df</a> &pos)</td></tr>
|
|
<tr class="separator:ad23770841b894a07c53f2f22ec4c809d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a82fc2a1b31ded13ec6fad63f700683dc"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a82fc2a1b31ded13ec6fad63f700683dc"></a>
|
|
virtual <a class="el" href="classathena_1_1_sakura_1_1_vector2_d.html">Vector2Df</a> </td><td class="memItemRight" valign="bottom"><b>position</b> () const </td></tr>
|
|
<tr class="separator:a82fc2a1b31ded13ec6fad63f700683dc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a003fc0c7f2a76d92e55361cc97baebeb"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a003fc0c7f2a76d92e55361cc97baebeb"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>setName</b> (const std::string &name)</td></tr>
|
|
<tr class="separator:a003fc0c7f2a76d92e55361cc97baebeb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2d5dc9b18ff0d610ba2cd3e2514c958d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2d5dc9b18ff0d610ba2cd3e2514c958d"></a>
|
|
std::string </td><td class="memItemRight" valign="bottom"><b>name</b> () const </td></tr>
|
|
<tr class="separator:a2d5dc9b18ff0d610ba2cd3e2514c958d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af59d6be9e7778628766c612113407d99"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af59d6be9e7778628766c612113407d99"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>addStateId</b> (int id)</td></tr>
|
|
<tr class="separator:af59d6be9e7778628766c612113407d99"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad749c5e5614514af307d6d4e8e421a96"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classathena_1_1_sakura_1_1_sprite.html#ad749c5e5614514af307d6d4e8e421a96">stateId</a> (int index) const </td></tr>
|
|
<tr class="memdesc:ad749c5e5614514af307d6d4e8e421a96"><td class="mdescLeft"> </td><td class="mdescRight">Returns the texture id of a given state. <a href="#ad749c5e5614514af307d6d4e8e421a96">More...</a><br /></td></tr>
|
|
<tr class="separator:ad749c5e5614514af307d6d4e8e421a96"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aeaf2192d7b356085c864c47475eb3007"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aeaf2192d7b356085c864c47475eb3007"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>setStateIds</b> (std::vector< int > ids)</td></tr>
|
|
<tr class="separator:aeaf2192d7b356085c864c47475eb3007"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a78b7779118f8865b528e008be396c077"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a78b7779118f8865b528e008be396c077"></a>
|
|
std::vector< int > </td><td class="memItemRight" valign="bottom"><b>stateIds</b> () const </td></tr>
|
|
<tr class="separator:a78b7779118f8865b528e008be396c077"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a60436c1eac17d02ef191ae3b3e98a1e3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a60436c1eac17d02ef191ae3b3e98a1e3"></a>
|
|
atUint32 </td><td class="memItemRight" valign="bottom"><b>stateCount</b> () const </td></tr>
|
|
<tr class="separator:a60436c1eac17d02ef191ae3b3e98a1e3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a19a80adcf21919c1f9558811d4f092fe"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a19a80adcf21919c1f9558811d4f092fe"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>setCurrentState</b> (atUint32 id)</td></tr>
|
|
<tr class="separator:a19a80adcf21919c1f9558811d4f092fe"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab3685a499fe97abad53022b1d8a83715"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab3685a499fe97abad53022b1d8a83715"></a>
|
|
atUint32 </td><td class="memItemRight" valign="bottom"><b>currentState</b> () const </td></tr>
|
|
<tr class="separator:ab3685a499fe97abad53022b1d8a83715"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adf04ceda8946f9d2ba068289c3ba6662"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adf04ceda8946f9d2ba068289c3ba6662"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><b>addFrame</b> (<a class="el" href="classathena_1_1_sakura_1_1_sprite_frame.html">SpriteFrame</a> *Frame)</td></tr>
|
|
<tr class="separator:adf04ceda8946f9d2ba068289c3ba6662"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6f6c4a84aa8b89431e5189110909a123"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6f6c4a84aa8b89431e5189110909a123"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><b>removeFrame</b> (<a class="el" href="classathena_1_1_sakura_1_1_sprite_frame.html">SpriteFrame</a> *Frame)</td></tr>
|
|
<tr class="separator:a6f6c4a84aa8b89431e5189110909a123"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8895036aeb93c039a15ec16741cef9f5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8895036aeb93c039a15ec16741cef9f5"></a>
|
|
<a class="el" href="classathena_1_1_sakura_1_1_sprite_frame.html">SpriteFrame</a> * </td><td class="memItemRight" valign="bottom"><b>Frame</b> (atUint32 id)</td></tr>
|
|
<tr class="separator:a8895036aeb93c039a15ec16741cef9f5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adc12003f5ec592349b8379d3ecf167e5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adc12003f5ec592349b8379d3ecf167e5"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>setFrame</b> (atUint32 id)</td></tr>
|
|
<tr class="separator:adc12003f5ec592349b8379d3ecf167e5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a120c52bab01726c831e8451adb79e15d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a120c52bab01726c831e8451adb79e15d"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>setFrames</b> (std::vector< <a class="el" href="classathena_1_1_sakura_1_1_sprite_frame.html">SpriteFrame</a> * > frames)</td></tr>
|
|
<tr class="separator:a120c52bab01726c831e8451adb79e15d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac764f4e89c8e7ba72234afddc7513806"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac764f4e89c8e7ba72234afddc7513806"></a>
|
|
atUint32 </td><td class="memItemRight" valign="bottom"><b>frameCount</b> () const </td></tr>
|
|
<tr class="separator:ac764f4e89c8e7ba72234afddc7513806"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a38197742c9748c2eac710ca0d5f7448e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a38197742c9748c2eac710ca0d5f7448e"></a>
|
|
std::vector< <a class="el" href="classathena_1_1_sakura_1_1_sprite_frame.html">SpriteFrame</a> * > </td><td class="memItemRight" valign="bottom"><b>frames</b> () const </td></tr>
|
|
<tr class="separator:a38197742c9748c2eac710ca0d5f7448e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a627e4d967b9eb6df055bb180436faa43"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a627e4d967b9eb6df055bb180436faa43"></a>
|
|
<a class="el" href="classathena_1_1_sakura_1_1_sprite_file.html">SpriteFile</a> * </td><td class="memItemRight" valign="bottom"><b>container</b> () const </td></tr>
|
|
<tr class="separator:a627e4d967b9eb6df055bb180436faa43"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a83f4829fcc6d0db9a08a2a3cabf77e7b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a83f4829fcc6d0db9a08a2a3cabf77e7b"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>setCurrentFrame</b> (<a class="el" href="classathena_1_1_sakura_1_1_sprite_frame.html">SpriteFrame</a> *frame)</td></tr>
|
|
<tr class="separator:a83f4829fcc6d0db9a08a2a3cabf77e7b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3d4ea56b287117de0cf9734c72268e31"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3d4ea56b287117de0cf9734c72268e31"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>setCurrentFrame</b> (atUint32 id)</td></tr>
|
|
<tr class="separator:a3d4ea56b287117de0cf9734c72268e31"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a76347a609eda25ad3cac2a9b7de5acab"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a76347a609eda25ad3cac2a9b7de5acab"></a>
|
|
<a class="el" href="classathena_1_1_sakura_1_1_sprite_frame.html">SpriteFrame</a> * </td><td class="memItemRight" valign="bottom"><b>currentFrame</b> () const </td></tr>
|
|
<tr class="separator:a76347a609eda25ad3cac2a9b7de5acab"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a212f48ea518a797316efbcba26bce6a7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a212f48ea518a797316efbcba26bce6a7"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>advanceFrame</b> ()</td></tr>
|
|
<tr class="separator:a212f48ea518a797316efbcba26bce6a7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acc3b157bf05a67ae02c3a9b40e31bbde"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acc3b157bf05a67ae02c3a9b40e31bbde"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>retreatFrame</b> ()</td></tr>
|
|
<tr class="separator:acc3b157bf05a67ae02c3a9b40e31bbde"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aee99d95f9931253fbed2441d14bee353"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aee99d95f9931253fbed2441d14bee353"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>setRoot</b> (<a class="el" href="classathena_1_1_sakura_1_1_sprite_file.html">SpriteFile</a> *root)</td></tr>
|
|
<tr class="separator:aee99d95f9931253fbed2441d14bee353"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5430962605172d726381af93b219c6f1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5430962605172d726381af93b219c6f1"></a>
|
|
<a class="el" href="classathena_1_1_sakura_1_1_sprite_file.html">SpriteFile</a> * </td><td class="memItemRight" valign="bottom"><b>root</b> () const </td></tr>
|
|
<tr class="separator:a5430962605172d726381af93b219c6f1"><td class="memSeparator" colspan="2"> </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#l00023">23</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="ad749c5e5614514af307d6d4e8e421a96"></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 </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="classathena_1_1_sakura_1_1_sprite.html">Sprite</a></li>
|
|
<li class="footer">Generated on Sat Sep 17 2016 13:10:09 for Athena IO Library by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|