Alex
/
OtterPlayGround
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
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.
main
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'ceafb5d381'
${ noResults }
OtterPlayGround/Docs/class_otter_1_1_range.html

334 lines
17 KiB
HTML
Raw Normal View History Unescape Escape

Initial Commit für Otter2D Framework
2 years ago
<!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.Range 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_range.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_range-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Otter.Range Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Class used to represent a range using a min and max.
<a href="class_otter_1_1_range.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:afb7846ff2207447e48028c91b8434f93"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_range.html#afb7846ff2207447e48028c91b8434f93">Range</a> (float min, float max)</td></tr>
<tr class="memdesc:afb7846ff2207447e48028c91b8434f93"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new <a class="el" href="class_otter_1_1_range.html" title="Class used to represent a range using a min and max. ">Range</a>. <a href="#afb7846ff2207447e48028c91b8434f93">More...</a><br/></td></tr>
<tr class="separator:afb7846ff2207447e48028c91b8434f93"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acbe35fb39cdf8233f7fc31cc031b2817"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_range.html#acbe35fb39cdf8233f7fc31cc031b2817">Range</a> (float max)</td></tr>
<tr class="memdesc:acbe35fb39cdf8233f7fc31cc031b2817"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new <a class="el" href="class_otter_1_1_range.html" title="Class used to represent a range using a min and max. ">Range</a>. <a href="#acbe35fb39cdf8233f7fc31cc031b2817">More...</a><br/></td></tr>
<tr class="separator:acbe35fb39cdf8233f7fc31cc031b2817"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a66233a6d22f3131781a1b12cebd50f83"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_range.html#a66233a6d22f3131781a1b12cebd50f83">Overlap</a> (<a class="el" href="class_otter_1_1_range.html">Range</a> r)</td></tr>
<tr class="memdesc:a66233a6d22f3131781a1b12cebd50f83"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test if this <a class="el" href="class_otter_1_1_range.html" title="Class used to represent a range using a min and max. ">Range</a> overlaps another <a class="el" href="class_otter_1_1_range.html" title="Class used to represent a range using a min and max. ">Range</a>. <a href="#a66233a6d22f3131781a1b12cebd50f83">More...</a><br/></td></tr>
<tr class="separator:a66233a6d22f3131781a1b12cebd50f83"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a494990a57e0d8db7faf1d744dcc36527"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a494990a57e0d8db7faf1d744dcc36527"></a>
override string&#160;</td><td class="memItemRight" valign="bottom"><b>ToString</b> ()</td></tr>
<tr class="separator:a494990a57e0d8db7faf1d744dcc36527"><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:a5b227ff0ac5d556a1f26af9cf2afa67e"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_range.html#a5b227ff0ac5d556a1f26af9cf2afa67e">Min</a></td></tr>
<tr class="memdesc:a5b227ff0ac5d556a1f26af9cf2afa67e"><td class="mdescLeft">&#160;</td><td class="mdescRight">The minimum of the range. <a href="#a5b227ff0ac5d556a1f26af9cf2afa67e">More...</a><br/></td></tr>
<tr class="separator:a5b227ff0ac5d556a1f26af9cf2afa67e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4809439d777d0b3b880aff7e8303adb1"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_range.html#a4809439d777d0b3b880aff7e8303adb1">Max</a></td></tr>
<tr class="memdesc:a4809439d777d0b3b880aff7e8303adb1"><td class="mdescLeft">&#160;</td><td class="mdescRight">The maximum of the range. <a href="#a4809439d777d0b3b880aff7e8303adb1">More...</a><br/></td></tr>
<tr class="separator:a4809439d777d0b3b880aff7e8303adb1"><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:a4defb3ec5551cdcbda1125304a412e6a"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_range.html#a4defb3ec5551cdcbda1125304a412e6a">RandInt</a><code> [get]</code></td></tr>
<tr class="memdesc:a4defb3ec5551cdcbda1125304a412e6a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a random int from the range. Floors the Min and Ceils the Max. <a href="#a4defb3ec5551cdcbda1125304a412e6a">More...</a><br/></td></tr>
<tr class="separator:a4defb3ec5551cdcbda1125304a412e6a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5c6dfa4f5592f8566d8d86f96f9aab6b"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_range.html#a5c6dfa4f5592f8566d8d86f96f9aab6b">RandFloat</a><code> [get]</code></td></tr>
<tr class="memdesc:a5c6dfa4f5592f8566d8d86f96f9aab6b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a random float from the range. <a href="#a5c6dfa4f5592f8566d8d86f96f9aab6b">More...</a><br/></td></tr>
<tr class="separator:a5c6dfa4f5592f8566d8d86f96f9aab6b"><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 used to represent a range using a min and max. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="afb7846ff2207447e48028c91b8434f93"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Otter.Range.Range </td>
<td>(</td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>min</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>max</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_range.html" title="Class used to represent a range using a min and max. ">Range</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">min</td><td>Minimum value.</td></tr>
<tr><td class="paramname">max</td><td>Maximum value.</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="acbe35fb39cdf8233f7fc31cc031b2817"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Otter.Range.Range </td>
<td>(</td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>max</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new <a class="el" href="class_otter_1_1_range.html" title="Class used to represent a range using a min and max. ">Range</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">max</td><td>Maximum value. Minimum is -Maximum.</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a66233a6d22f3131781a1b12cebd50f83"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Otter.Range.Overlap </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_otter_1_1_range.html">Range</a>&#160;</td>
<td class="paramname"><em>r</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Test if this <a class="el" href="class_otter_1_1_range.html" title="Class used to represent a range using a min and max. ">Range</a> overlaps another <a class="el" href="class_otter_1_1_range.html" title="Class used to represent a range using a min and max. ">Range</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">r</td><td>The <a class="el" href="class_otter_1_1_range.html" title="Class used to represent a range using a min and max. ">Range</a> to test against.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if the ranges overlap.</dd></dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a4809439d777d0b3b880aff7e8303adb1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float Otter.Range.Max</td>
</tr>
</table>
</div><div class="memdoc">
<p>The maximum of the range. </p>
</div>
</div>
<a class="anchor" id="a5b227ff0ac5d556a1f26af9cf2afa67e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float Otter.Range.Min</td>
</tr>
</table>
</div><div class="memdoc">
<p>The minimum of the range. </p>
</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
<a class="anchor" id="a5c6dfa4f5592f8566d8d86f96f9aab6b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">float Otter.Range.RandFloat</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a random float from the range. </p>
<dl class="section return"><dt>Returns</dt><dd>A random float.</dd></dl>
</div>
</div>
<a class="anchor" id="a4defb3ec5551cdcbda1125304a412e6a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int Otter.Range.RandInt</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a random int from the range. Floors the Min and Ceils the Max. </p>
<dl class="section return"><dt>Returns</dt><dd>A random int.</dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>Otter/Utility/Range.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_range.html">Range</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>