You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
OtterPlayGround/Docs/class_otter_1_1_tile_info.html

363 lines
20 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.5"/>
<title>Otter: Otter.TileInfo 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="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/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</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="projectlogo"><img alt="Logo" src="otterlogosmall.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">Otter
&#160;<span id="projectnumber">0.9.8.91</span>
</div>
<div id="projectbrief">2d Game Development Framework based on SFML.Net</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<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><a href="namespaces.html"><span>Packages</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</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="hierarchy.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_otter_1_1_tile_info.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)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Properties</a></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="#pub-attribs">Public Attributes</a> &#124;
<a href="#properties">Properties</a> &#124;
<a href="class_otter_1_1_tile_info-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Otter.TileInfo Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A class containing all the info to describe a specific tile.
<a href="class_otter_1_1_tile_info.html#details">More...</a></p>
<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:aa13fb851559a666790bea1cfc60dce6d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa13fb851559a666790bea1cfc60dce6d"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>TileInfo</b> (int x, int y, int tx, int ty, int width, int height, <a class="el" href="class_otter_1_1_color.html">Color</a> color=null, float alpha=1)</td></tr>
<tr class="separator:aa13fb851559a666790bea1cfc60dce6d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a001b1e8e31346829aa0f1640a7785335"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_tile_info.html#a001b1e8e31346829aa0f1640a7785335">GetIndex</a> (<a class="el" href="class_otter_1_1_tilemap.html">Tilemap</a> tilemap)</td></tr>
<tr class="memdesc:a001b1e8e31346829aa0f1640a7785335"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the index of the tile on the source <a class="el" href="class_otter_1_1_texture.html" title="Class representing a texture. Can perform pixel operations on the CPU, but those will be pretty slow ...">Texture</a> of a <a class="el" href="class_otter_1_1_tilemap.html" title="Graphic used for loading and rendering a tilemap. Renders tiles using a vertex array. ">Tilemap</a>. <a href="#a001b1e8e31346829aa0f1640a7785335">More...</a><br/></td></tr>
<tr class="separator:a001b1e8e31346829aa0f1640a7785335"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a09fe24ce60968861c3b0263244596be1"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_tile_info.html#a09fe24ce60968861c3b0263244596be1">X</a></td></tr>
<tr class="memdesc:a09fe24ce60968861c3b0263244596be1"><td class="mdescLeft">&#160;</td><td class="mdescRight">The X position of the tile. <a href="#a09fe24ce60968861c3b0263244596be1">More...</a><br/></td></tr>
<tr class="separator:a09fe24ce60968861c3b0263244596be1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab7aaabc282d67a15d08ac5ff0d1ea820"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_tile_info.html#ab7aaabc282d67a15d08ac5ff0d1ea820">Y</a></td></tr>
<tr class="memdesc:ab7aaabc282d67a15d08ac5ff0d1ea820"><td class="mdescLeft">&#160;</td><td class="mdescRight">The Y position of the tile. <a href="#ab7aaabc282d67a15d08ac5ff0d1ea820">More...</a><br/></td></tr>
<tr class="separator:ab7aaabc282d67a15d08ac5ff0d1ea820"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a18a2f2e464d0081185e966ac3cbc2afd"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_tile_info.html#a18a2f2e464d0081185e966ac3cbc2afd">TX</a></td></tr>
<tr class="memdesc:a18a2f2e464d0081185e966ac3cbc2afd"><td class="mdescLeft">&#160;</td><td class="mdescRight">The X position of the source texture to render the tile from. <a href="#a18a2f2e464d0081185e966ac3cbc2afd">More...</a><br/></td></tr>
<tr class="separator:a18a2f2e464d0081185e966ac3cbc2afd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abae12997b6f7a4991afb8ec1db50ad6b"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_tile_info.html#abae12997b6f7a4991afb8ec1db50ad6b">TY</a></td></tr>
<tr class="memdesc:abae12997b6f7a4991afb8ec1db50ad6b"><td class="mdescLeft">&#160;</td><td class="mdescRight">The Y position of the source texture to render the tile from. <a href="#abae12997b6f7a4991afb8ec1db50ad6b">More...</a><br/></td></tr>
<tr class="separator:abae12997b6f7a4991afb8ec1db50ad6b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a599c0e461cb25e361e7725ec8d443e9f"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_tile_info.html#a599c0e461cb25e361e7725ec8d443e9f">Width</a></td></tr>
<tr class="memdesc:a599c0e461cb25e361e7725ec8d443e9f"><td class="mdescLeft">&#160;</td><td class="mdescRight">The width of the tile. <a href="#a599c0e461cb25e361e7725ec8d443e9f">More...</a><br/></td></tr>
<tr class="separator:a599c0e461cb25e361e7725ec8d443e9f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa0117da38a8dcae51b5d0751afd62e7f"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_tile_info.html#aa0117da38a8dcae51b5d0751afd62e7f">Height</a></td></tr>
<tr class="memdesc:aa0117da38a8dcae51b5d0751afd62e7f"><td class="mdescLeft">&#160;</td><td class="mdescRight">The height of the tile. <a href="#aa0117da38a8dcae51b5d0751afd62e7f">More...</a><br/></td></tr>
<tr class="separator:aa0117da38a8dcae51b5d0751afd62e7f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa5db7dfe5c3570065b02f5b262c6f216"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_tile_info.html#aa5db7dfe5c3570065b02f5b262c6f216">FlipX</a></td></tr>
<tr class="memdesc:aa5db7dfe5c3570065b02f5b262c6f216"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flipped tile options. <a href="#aa5db7dfe5c3570065b02f5b262c6f216">More...</a><br/></td></tr>
<tr class="separator:aa5db7dfe5c3570065b02f5b262c6f216"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae06e62e56cc9fe03e0ec2aa62a99aecf"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae06e62e56cc9fe03e0ec2aa62a99aecf"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>FlipY</b></td></tr>
<tr class="separator:ae06e62e56cc9fe03e0ec2aa62a99aecf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a93f7473062bc188d36f6ea01ce5348ee"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_tile_info.html#a93f7473062bc188d36f6ea01ce5348ee">FlipD</a></td></tr>
<tr class="memdesc:a93f7473062bc188d36f6ea01ce5348ee"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flips the tile anti-diagonally, equivalent to a 90 degree rotation and a horizontal flip. Combined with FlipX and FlipY you can rotate the tile any direction. <a href="#a93f7473062bc188d36f6ea01ce5348ee">More...</a><br/></td></tr>
<tr class="separator:a93f7473062bc188d36f6ea01ce5348ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeb1a4738bbacba672ef55781ccaf8f7a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_otter_1_1_color.html">Color</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_tile_info.html#aeb1a4738bbacba672ef55781ccaf8f7a">Color</a></td></tr>
<tr class="memdesc:aeb1a4738bbacba672ef55781ccaf8f7a"><td class="mdescLeft">&#160;</td><td class="mdescRight">The color of the tile, or the color to tint the texture. <a href="#aeb1a4738bbacba672ef55781ccaf8f7a">More...</a><br/></td></tr>
<tr class="separator:aeb1a4738bbacba672ef55781ccaf8f7a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a>
Properties</h2></td></tr>
<tr class="memitem:ad2c73573ea42c0ef80d8fcfc88ea8c59"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_tile_info.html#ad2c73573ea42c0ef80d8fcfc88ea8c59">Alpha</a><code> [get, set]</code></td></tr>
<tr class="memdesc:ad2c73573ea42c0ef80d8fcfc88ea8c59"><td class="mdescLeft">&#160;</td><td class="mdescRight">The alpha of the tile. <a href="#ad2c73573ea42c0ef80d8fcfc88ea8c59">More...</a><br/></td></tr>
<tr class="separator:ad2c73573ea42c0ef80d8fcfc88ea8c59"><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 class containing all the info to describe a specific tile. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a001b1e8e31346829aa0f1640a7785335"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Otter.TileInfo.GetIndex </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_otter_1_1_tilemap.html">Tilemap</a>&#160;</td>
<td class="paramname"><em>tilemap</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the index of the tile on the source <a class="el" href="class_otter_1_1_texture.html" title="Class representing a texture. Can perform pixel operations on the CPU, but those will be pretty slow ...">Texture</a> of a <a class="el" href="class_otter_1_1_tilemap.html" title="Graphic used for loading and rendering a tilemap. Renders tiles using a vertex array. ">Tilemap</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">tilemap</td><td>The <a class="el" href="class_otter_1_1_tilemap.html" title="Graphic used for loading and rendering a tilemap. Renders tiles using a vertex array. ">Tilemap</a> that uses the <a class="el" href="class_otter_1_1_texture.html" title="Class representing a texture. Can perform pixel operations on the CPU, but those will be pretty slow ...">Texture</a> to be tested against.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The index of the tile on the <a class="el" href="class_otter_1_1_tilemap.html" title="Graphic used for loading and rendering a tilemap. Renders tiles using a vertex array. ">Tilemap</a>'s <a class="el" href="class_otter_1_1_texture.html" title="Class representing a texture. Can perform pixel operations on the CPU, but those will be pretty slow ...">Texture</a>.</dd></dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="aeb1a4738bbacba672ef55781ccaf8f7a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_otter_1_1_color.html">Color</a> Otter.TileInfo.Color</td>
</tr>
</table>
</div><div class="memdoc">
<p>The color of the tile, or the color to tint the texture. </p>
</div>
</div>
<a class="anchor" id="a93f7473062bc188d36f6ea01ce5348ee"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Otter.TileInfo.FlipD</td>
</tr>
</table>
</div><div class="memdoc">
<p>Flips the tile anti-diagonally, equivalent to a 90 degree rotation and a horizontal flip. Combined with FlipX and FlipY you can rotate the tile any direction. </p>
</div>
</div>
<a class="anchor" id="aa5db7dfe5c3570065b02f5b262c6f216"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Otter.TileInfo.FlipX</td>
</tr>
</table>
</div><div class="memdoc">
<p>Flipped tile options. </p>
</div>
</div>
<a class="anchor" id="aa0117da38a8dcae51b5d0751afd62e7f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Otter.TileInfo.Height</td>
</tr>
</table>
</div><div class="memdoc">
<p>The height of the tile. </p>
</div>
</div>
<a class="anchor" id="a18a2f2e464d0081185e966ac3cbc2afd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Otter.TileInfo.TX</td>
</tr>
</table>
</div><div class="memdoc">
<p>The X position of the source texture to render the tile from. </p>
</div>
</div>
<a class="anchor" id="abae12997b6f7a4991afb8ec1db50ad6b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Otter.TileInfo.TY</td>
</tr>
</table>
</div><div class="memdoc">
<p>The Y position of the source texture to render the tile from. </p>
</div>
</div>
<a class="anchor" id="a599c0e461cb25e361e7725ec8d443e9f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Otter.TileInfo.Width</td>
</tr>
</table>
</div><div class="memdoc">
<p>The width of the tile. </p>
</div>
</div>
<a class="anchor" id="a09fe24ce60968861c3b0263244596be1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Otter.TileInfo.X</td>
</tr>
</table>
</div><div class="memdoc">
<p>The X position of the tile. </p>
</div>
</div>
<a class="anchor" id="ab7aaabc282d67a15d08ac5ff0d1ea820"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Otter.TileInfo.Y</td>
</tr>
</table>
</div><div class="memdoc">
<p>The Y position of the tile. </p>
</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
<a class="anchor" id="ad2c73573ea42c0ef80d8fcfc88ea8c59"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">float Otter.TileInfo.Alpha</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The alpha of the tile. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>Otter/Graphics/Drawables/Tilemap.cs</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"><a class="el" href="namespace_otter.html">Otter</a></li><li class="navelem"><a class="el" href="class_otter_1_1_tile_info.html">TileInfo</a></li>
<li class="footer">Generated on Thu May 12 2016 18:16:52 for Otter by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.5 </li>
</ul>
</div>
</body>
</html>