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_ogmo_layer....

347 lines
18 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.OgmoLayer 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_ogmo_layer.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="class_otter_1_1_ogmo_layer-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Otter.OgmoLayer Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Class representing a layer loaded from Ogmo.
<a href="class_otter_1_1_ogmo_layer.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:a717609aa257fb225c9bc9ad68011881f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_ogmo_layer.html#a717609aa257fb225c9bc9ad68011881f">OgmoLayer</a> (string name, string type)</td></tr>
<tr class="memdesc:a717609aa257fb225c9bc9ad68011881f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new <a class="el" href="class_otter_1_1_ogmo_layer.html" title="Class representing a layer loaded from Ogmo. ">OgmoLayer</a>. <a href="#a717609aa257fb225c9bc9ad68011881f">More...</a><br/></td></tr>
<tr class="separator:a717609aa257fb225c9bc9ad68011881f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8b50a1c30ffe3a61b8593778c8fedc7b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_ogmo_layer.html#a8b50a1c30ffe3a61b8593778c8fedc7b">OgmoLayer</a> (XmlElement xml)</td></tr>
<tr class="memdesc:a8b50a1c30ffe3a61b8593778c8fedc7b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new <a class="el" href="class_otter_1_1_ogmo_layer.html" title="Class representing a layer loaded from Ogmo. ">OgmoLayer</a> by parsing an XmlElement. <a href="#a8b50a1c30ffe3a61b8593778c8fedc7b">More...</a><br/></td></tr>
<tr class="separator:a8b50a1c30ffe3a61b8593778c8fedc7b"><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:a85a8985b5ecbb63d7456609710c6610e"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_ogmo_layer.html#a85a8985b5ecbb63d7456609710c6610e">Name</a></td></tr>
<tr class="memdesc:a85a8985b5ecbb63d7456609710c6610e"><td class="mdescLeft">&#160;</td><td class="mdescRight">The name of the layer. <a href="#a85a8985b5ecbb63d7456609710c6610e">More...</a><br/></td></tr>
<tr class="separator:a85a8985b5ecbb63d7456609710c6610e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0d85d42574f84578da6ae1e3f3ecf2ce"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_ogmo_layer.html#a0d85d42574f84578da6ae1e3f3ecf2ce">ExportMode</a></td></tr>
<tr class="memdesc:a0d85d42574f84578da6ae1e3f3ecf2ce"><td class="mdescLeft">&#160;</td><td class="mdescRight">The export mode of the layer from Ogmo Editor. <a href="#a0d85d42574f84578da6ae1e3f3ecf2ce">More...</a><br/></td></tr>
<tr class="separator:a0d85d42574f84578da6ae1e3f3ecf2ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac00a309e38b6fec49c56243563e19597"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_ogmo_layer.html#ac00a309e38b6fec49c56243563e19597">Type</a></td></tr>
<tr class="memdesc:ac00a309e38b6fec49c56243563e19597"><td class="mdescLeft">&#160;</td><td class="mdescRight">The type of the layer from Ogmo Editor. <a href="#ac00a309e38b6fec49c56243563e19597">More...</a><br/></td></tr>
<tr class="separator:ac00a309e38b6fec49c56243563e19597"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0d03b1d5c543220c951df715a693c028"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_ogmo_layer.html#a0d03b1d5c543220c951df715a693c028">GridWidth</a></td></tr>
<tr class="memdesc:a0d03b1d5c543220c951df715a693c028"><td class="mdescLeft">&#160;</td><td class="mdescRight">The width of each grid cell. <a href="#a0d03b1d5c543220c951df715a693c028">More...</a><br/></td></tr>
<tr class="separator:a0d03b1d5c543220c951df715a693c028"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a222bbffdfc905086c1854cc8ea4c6deb"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_ogmo_layer.html#a222bbffdfc905086c1854cc8ea4c6deb">GridHeight</a></td></tr>
<tr class="memdesc:a222bbffdfc905086c1854cc8ea4c6deb"><td class="mdescLeft">&#160;</td><td class="mdescRight">The height of each grid cell. <a href="#a222bbffdfc905086c1854cc8ea4c6deb">More...</a><br/></td></tr>
<tr class="separator:a222bbffdfc905086c1854cc8ea4c6deb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a072e06ad6316bd2433d42445eb5a7c8b"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_ogmo_layer.html#a072e06ad6316bd2433d42445eb5a7c8b">ScrollX</a> = 1</td></tr>
<tr class="memdesc:a072e06ad6316bd2433d42445eb5a7c8b"><td class="mdescLeft">&#160;</td><td class="mdescRight">The horizontal parallax of the layer. <a href="#a072e06ad6316bd2433d42445eb5a7c8b">More...</a><br/></td></tr>
<tr class="separator:a072e06ad6316bd2433d42445eb5a7c8b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad83a12ed14d6c3d533aa379542aeb125"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_ogmo_layer.html#ad83a12ed14d6c3d533aa379542aeb125">ScrollY</a> = 1</td></tr>
<tr class="memdesc:ad83a12ed14d6c3d533aa379542aeb125"><td class="mdescLeft">&#160;</td><td class="mdescRight">The vertical parallax of the layer. <a href="#ad83a12ed14d6c3d533aa379542aeb125">More...</a><br/></td></tr>
<tr class="separator:ad83a12ed14d6c3d533aa379542aeb125"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a855e4085068d60fb345d5441947bdb53"><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_ogmo_layer.html#a855e4085068d60fb345d5441947bdb53">Color</a></td></tr>
<tr class="memdesc:a855e4085068d60fb345d5441947bdb53"><td class="mdescLeft">&#160;</td><td class="mdescRight">The color of layer from Ogmo Editor. <a href="#a855e4085068d60fb345d5441947bdb53">More...</a><br/></td></tr>
<tr class="separator:a855e4085068d60fb345d5441947bdb53"><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>Class representing a layer loaded from Ogmo. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a717609aa257fb225c9bc9ad68011881f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Otter.OgmoLayer.OgmoLayer </td>
<td>(</td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>type</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new <a class="el" href="class_otter_1_1_ogmo_layer.html" title="Class representing a layer loaded from Ogmo. ">OgmoLayer</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>The name of the layer.</td></tr>
<tr><td class="paramname">type</td><td>The type of the layer.</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a8b50a1c30ffe3a61b8593778c8fedc7b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Otter.OgmoLayer.OgmoLayer </td>
<td>(</td>
<td class="paramtype">XmlElement&#160;</td>
<td class="paramname"><em>xml</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new <a class="el" href="class_otter_1_1_ogmo_layer.html" title="Class representing a layer loaded from Ogmo. ">OgmoLayer</a> by parsing an XmlElement. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">xml</td><td>An XmlElement from an Ogmo Editor project file.</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a855e4085068d60fb345d5441947bdb53"></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.OgmoLayer.Color</td>
</tr>
</table>
</div><div class="memdoc">
<p>The color of layer from Ogmo Editor. </p>
</div>
</div>
<a class="anchor" id="a0d85d42574f84578da6ae1e3f3ecf2ce"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string Otter.OgmoLayer.ExportMode</td>
</tr>
</table>
</div><div class="memdoc">
<p>The export mode of the layer from Ogmo Editor. </p>
</div>
</div>
<a class="anchor" id="a222bbffdfc905086c1854cc8ea4c6deb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Otter.OgmoLayer.GridHeight</td>
</tr>
</table>
</div><div class="memdoc">
<p>The height of each grid cell. </p>
</div>
</div>
<a class="anchor" id="a0d03b1d5c543220c951df715a693c028"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Otter.OgmoLayer.GridWidth</td>
</tr>
</table>
</div><div class="memdoc">
<p>The width of each grid cell. </p>
</div>
</div>
<a class="anchor" id="a85a8985b5ecbb63d7456609710c6610e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string Otter.OgmoLayer.Name</td>
</tr>
</table>
</div><div class="memdoc">
<p>The name of the layer. </p>
</div>
</div>
<a class="anchor" id="a072e06ad6316bd2433d42445eb5a7c8b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float Otter.OgmoLayer.ScrollX = 1</td>
</tr>
</table>
</div><div class="memdoc">
<p>The horizontal parallax of the layer. </p>
</div>
</div>
<a class="anchor" id="ad83a12ed14d6c3d533aa379542aeb125"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float Otter.OgmoLayer.ScrollY = 1</td>
</tr>
</table>
</div><div class="memdoc">
<p>The vertical parallax of the layer. </p>
</div>
</div>
<a class="anchor" id="ac00a309e38b6fec49c56243563e19597"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string Otter.OgmoLayer.Type</td>
</tr>
</table>
</div><div class="memdoc">
<p>The type of the layer from Ogmo Editor. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>Otter/Utility/OgmoProject.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_ogmo_layer.html">OgmoLayer</a></li>
<li class="footer">Generated on Thu May 12 2016 18:16:53 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>