joseph-aquino
/
2d-platformer
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
2d-platformer/vendor/SFML-3.0.0/doc/html/classsf_1_1Rect.html

548 lines
32 KiB
HTML
Raw Blame History

<!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>
<title>SFML - Simple and Fast Multimedia Library</title>
<meta http-equiv="Content-Type" content="text/html;charset=UTF-8" />
<link rel="stylesheet" type="text/css" href="doxygen.css" title="default" media="screen,print" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link rel="stylesheet" type="text/css" href="search/search.css" />
<link rel="stylesheet" type="text/css" href="searchOverrides.css" />
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_search(); });
/* @license-end */
</script>
</head>
<body>
<div id="banner-container">
<div id="banner">
<span id="sfml">SFML 3.0.0</span>
</div>
</div>
<div id="content">
<div>
<!-- Generated by Doxygen 1.12.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="topics.html"><span>Topics</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</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">
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
<input type="text" id="MSearchField" value="" placeholder="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.svg" 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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){ initResizable(false); });
/* @license-end */
</script>
<!-- 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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacesf.html">sf</a></li><li class="navelem"><a class="el" href="classsf_1_1Rect.html">Rect</a></li> </ul>
</div>
</div><!-- top -->
<div id="doc-content">
<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="#related">Related Symbols</a> &#124;
<a href="classsf_1_1Rect-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">sf::Rect&lt; T &gt; Class Template Reference<div class="ingroups"><a class="el" href="group__graphics.html">Graphics module</a></div></div></div>
</div><!--header-->
<div class="contents">
<p>Utility class for manipulating 2D axis aligned rectangles.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="Rect_8hpp_source.html">SFML/Graphics/Rect.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a6f3f354000c9141599b34ed2e63ee9aa" id="r_a6f3f354000c9141599b34ed2e63ee9aa"><td class="memItemLeft" align="right" valign="top">constexpr&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6f3f354000c9141599b34ed2e63ee9aa">Rect</a> ()=default</td></tr>
<tr class="memdesc:a6f3f354000c9141599b34ed2e63ee9aa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor. <br /></td></tr>
<tr class="separator:a6f3f354000c9141599b34ed2e63ee9aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a18ce7808a7cf4b1b98f6b997301fe5e7" id="r_a18ce7808a7cf4b1b98f6b997301fe5e7"><td class="memItemLeft" align="right" valign="top">constexpr&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a18ce7808a7cf4b1b98f6b997301fe5e7">Rect</a> (<a class="el" href="classsf_1_1Vector2.html">Vector2</a>&lt; T &gt; <a class="el" href="#a561ce610acfafc975647c19db1c76bce">position</a>, <a class="el" href="classsf_1_1Vector2.html">Vector2</a>&lt; T &gt; <a class="el" href="#a39912541f559c5f780e4400831595acc">size</a>)</td></tr>
<tr class="memdesc:a18ce7808a7cf4b1b98f6b997301fe5e7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct the rectangle from position and size. <br /></td></tr>
<tr class="separator:a18ce7808a7cf4b1b98f6b997301fe5e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a006f1450f51ed7bec69f2b45966b33ac" id="r_a006f1450f51ed7bec69f2b45966b33ac"><td class="memTemplParams" colspan="2">template&lt;typename U &gt; </td></tr>
<tr class="memitem:a006f1450f51ed7bec69f2b45966b33ac"><td class="memTemplItemLeft" align="right" valign="top">constexpr&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a006f1450f51ed7bec69f2b45966b33ac">operator Rect&lt; U &gt;</a> () const</td></tr>
<tr class="memdesc:a006f1450f51ed7bec69f2b45966b33ac"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts the rectangle to another type of rectangle. <br /></td></tr>
<tr class="separator:a006f1450f51ed7bec69f2b45966b33ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad18bdd7a9c322178c50a8893d8b15995" id="r_ad18bdd7a9c322178c50a8893d8b15995"><td class="memItemLeft" align="right" valign="top">constexpr bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad18bdd7a9c322178c50a8893d8b15995">contains</a> (<a class="el" href="classsf_1_1Vector2.html">Vector2</a>&lt; T &gt; point) const</td></tr>
<tr class="memdesc:ad18bdd7a9c322178c50a8893d8b15995"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if a point is inside the rectangle's area. <br /></td></tr>
<tr class="separator:ad18bdd7a9c322178c50a8893d8b15995"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7ef2a5f472d397bc4835a4fb7df99518" id="r_a7ef2a5f472d397bc4835a4fb7df99518"><td class="memItemLeft" align="right" valign="top">constexpr std::optional&lt; <a class="el" href="classsf_1_1Rect.html">Rect</a>&lt; T &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7ef2a5f472d397bc4835a4fb7df99518">findIntersection</a> (const <a class="el" href="classsf_1_1Rect.html">Rect</a>&lt; T &gt; &amp;rectangle) const</td></tr>
<tr class="memdesc:a7ef2a5f472d397bc4835a4fb7df99518"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check the intersection between two rectangles. <br /></td></tr>
<tr class="separator:a7ef2a5f472d397bc4835a4fb7df99518"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab37812f2b0ffd121d666c5859fc9fab6" id="r_ab37812f2b0ffd121d666c5859fc9fab6"><td class="memItemLeft" align="right" valign="top">constexpr <a class="el" href="classsf_1_1Vector2.html">Vector2</a>&lt; T &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab37812f2b0ffd121d666c5859fc9fab6">getCenter</a> () const</td></tr>
<tr class="memdesc:ab37812f2b0ffd121d666c5859fc9fab6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the position of the center of the rectangle. <br /></td></tr>
<tr class="separator:ab37812f2b0ffd121d666c5859fc9fab6"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a561ce610acfafc975647c19db1c76bce" id="r_a561ce610acfafc975647c19db1c76bce"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1Vector2.html">Vector2</a>&lt; T &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a561ce610acfafc975647c19db1c76bce">position</a> {}</td></tr>
<tr class="memdesc:a561ce610acfafc975647c19db1c76bce"><td class="mdescLeft">&#160;</td><td class="mdescRight">Position of the top-left corner of the rectangle. <br /></td></tr>
<tr class="separator:a561ce610acfafc975647c19db1c76bce"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a39912541f559c5f780e4400831595acc" id="r_a39912541f559c5f780e4400831595acc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1Vector2.html">Vector2</a>&lt; T &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a39912541f559c5f780e4400831595acc">size</a> {}</td></tr>
<tr class="memdesc:a39912541f559c5f780e4400831595acc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Size of the rectangle. <br /></td></tr>
<tr class="separator:a39912541f559c5f780e4400831595acc"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="related" name="related"></a>
Related Symbols</h2></td></tr>
<tr><td class="ititle" colspan="2"><p>(Note that these are not member symbols.) </p>
</td></tr>
<tr class="memitem:a9fd43df62132ae04873de6d034591895" id="r_a9fd43df62132ae04873de6d034591895"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:a9fd43df62132ae04873de6d034591895"><td class="memTemplItemLeft" align="right" valign="top">constexpr bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a9fd43df62132ae04873de6d034591895">operator==</a> (const <a class="el" href="classsf_1_1Rect.html">Rect</a>&lt; T &gt; &amp;lhs, const <a class="el" href="classsf_1_1Rect.html">Rect</a>&lt; T &gt; &amp;rhs)</td></tr>
<tr class="memdesc:a9fd43df62132ae04873de6d034591895"><td class="mdescLeft">&#160;</td><td class="mdescRight">Overload of binary <code>operator==</code> <br /></td></tr>
<tr class="separator:a9fd43df62132ae04873de6d034591895"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3e687a68a85f552a6b253dd068e9a007" id="r_a3e687a68a85f552a6b253dd068e9a007"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:a3e687a68a85f552a6b253dd068e9a007"><td class="memTemplItemLeft" align="right" valign="top">constexpr bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a3e687a68a85f552a6b253dd068e9a007">operator!=</a> (const <a class="el" href="classsf_1_1Rect.html">Rect</a>&lt; T &gt; &amp;lhs, const <a class="el" href="classsf_1_1Rect.html">Rect</a>&lt; T &gt; &amp;rhs)</td></tr>
<tr class="memdesc:a3e687a68a85f552a6b253dd068e9a007"><td class="mdescLeft">&#160;</td><td class="mdescRight">Overload of binary <code>operator!=</code> <br /></td></tr>
<tr class="separator:a3e687a68a85f552a6b253dd068e9a007"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><div class="compoundTemplParams">template&lt;typename T&gt;<br />
class sf::Rect&lt; T &gt;</div><p>Utility class for manipulating 2D axis aligned rectangles. </p>
<p>A rectangle is defined by its top-left corner and its size.</p>
<p>It is a very simple class defined for convenience, so its member variables (position and size) are public and can be accessed directly, just like the vector classes (<code><a class="el" href="classsf_1_1Vector2.html" title="Class template for manipulating 2-dimensional vectors.">Vector2</a></code> and <code><a class="el" href="classsf_1_1Vector3.html" title="Utility template class for manipulating 3-dimensional vectors.">Vector3</a></code>).</p>
<p>To keep things simple, <code><a class="el" href="classsf_1_1Rect.html" title="Utility class for manipulating 2D axis aligned rectangles.">sf::Rect</a></code> doesn't define functions to emulate the properties that are not directly members (such as right, bottom, etc.), it rather only provides intersection functions.</p>
<p><code><a class="el" href="classsf_1_1Rect.html" title="Utility class for manipulating 2D axis aligned rectangles.">sf::Rect</a></code> uses the usual rules for its boundaries: </p><ul>
<li>The left and top edges are included in the rectangle's area </li>
<li>The right and bottom edges are excluded from the rectangle's area</li>
</ul>
<p>This means that <code><a class="el" href="namespacesf.html#add1cf75a734c8414680b0424145c30b1">sf::IntRect</a>({0, 0}, {1, 1})</code> and <code><a class="el" href="namespacesf.html#add1cf75a734c8414680b0424145c30b1">sf::IntRect</a>({1, 1}, {1, 1})</code> don't intersect.</p>
<p><code><a class="el" href="classsf_1_1Rect.html" title="Utility class for manipulating 2D axis aligned rectangles.">sf::Rect</a></code> is a template and may be used with any numeric type, but for simplicity type aliases for the instantiations used by SFML are given: </p><ul>
<li><code><a class="el" href="classsf_1_1Rect.html" title="Utility class for manipulating 2D axis aligned rectangles.">sf::Rect</a>&lt;int&gt;</code> is <code><a class="el" href="namespacesf.html#add1cf75a734c8414680b0424145c30b1">sf::IntRect</a></code> </li>
<li><code><a class="el" href="classsf_1_1Rect.html" title="Utility class for manipulating 2D axis aligned rectangles.">sf::Rect</a>&lt;float&gt;</code> is <code><a class="el" href="namespacesf.html#a701020eb396e62ba560619e68c689a38">sf::FloatRect</a></code></li>
</ul>
<p>So that you don't have to care about the template syntax.</p>
<p>Usage example: </p><div class="fragment"><div class="line"><span class="comment">// Define a rectangle, located at (0, 0) with a size of 20x5</span></div>
<div class="line"><a class="code hl_class" href="classsf_1_1Rect.html">sf::IntRect</a> r1({0, 0}, {20, 5});</div>
<div class="line"> </div>
<div class="line"><span class="comment">// Define another rectangle, located at (4, 2) with a size of 18x10</span></div>
<div class="line"><a class="code hl_class" href="classsf_1_1Vector2.html">sf::Vector2i</a> <a class="code hl_variable" href="#a561ce610acfafc975647c19db1c76bce">position</a>(4, 2);</div>
<div class="line"><a class="code hl_class" href="classsf_1_1Vector2.html">sf::Vector2i</a> <a class="code hl_variable" href="#a39912541f559c5f780e4400831595acc">size</a>(18, 10);</div>
<div class="line"><a class="code hl_class" href="classsf_1_1Rect.html">sf::IntRect</a> r2(<a class="code hl_variable" href="#a561ce610acfafc975647c19db1c76bce">position</a>, <a class="code hl_variable" href="#a39912541f559c5f780e4400831595acc">size</a>);</div>
<div class="line"> </div>
<div class="line"><span class="comment">// Test intersections with the point (3, 1)</span></div>
<div class="line"><span class="keywordtype">bool</span> b1 = r1.contains({3, 1}); <span class="comment">// true</span></div>
<div class="line"><span class="keywordtype">bool</span> b2 = r2.contains({3, 1}); <span class="comment">// false</span></div>
<div class="line"> </div>
<div class="line"><span class="comment">// Test the intersection between r1 and r2</span></div>
<div class="line">std::optional&lt;sf::IntRect&gt; result = r1.findIntersection(r2);</div>
<div class="line"><span class="comment">// result.has_value() == true</span></div>
<div class="line"><span class="comment">// result.value() == sf::IntRect({4, 2}, {16, 3})</span></div>
<div class="ttc" id="aclasssf_1_1Rect_html"><div class="ttname"><a href="classsf_1_1Rect.html">sf::Rect&lt; int &gt;</a></div></div>
<div class="ttc" id="aclasssf_1_1Rect_html_a39912541f559c5f780e4400831595acc"><div class="ttname"><a href="#a39912541f559c5f780e4400831595acc">sf::Rect::size</a></div><div class="ttdeci">Vector2&lt; T &gt; size</div><div class="ttdoc">Size of the rectangle.</div><div class="ttdef"><b>Definition</b> <a href="Rect_8hpp_source.html#l00112">Rect.hpp:112</a></div></div>
<div class="ttc" id="aclasssf_1_1Rect_html_a561ce610acfafc975647c19db1c76bce"><div class="ttname"><a href="#a561ce610acfafc975647c19db1c76bce">sf::Rect::position</a></div><div class="ttdeci">Vector2&lt; T &gt; position</div><div class="ttdoc">Position of the top-left corner of the rectangle.</div><div class="ttdef"><b>Definition</b> <a href="Rect_8hpp_source.html#l00111">Rect.hpp:111</a></div></div>
<div class="ttc" id="aclasssf_1_1Vector2_html"><div class="ttname"><a href="classsf_1_1Vector2.html">sf::Vector2&lt; int &gt;</a></div></div>
</div><!-- fragment -->
<p class="definition">Definition at line <a class="el" href="Rect_8hpp_source.html#l00042">42</a> of file <a class="el" href="Rect_8hpp_source.html">Rect.hpp</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a6f3f354000c9141599b34ed2e63ee9aa" name="a6f3f354000c9141599b34ed2e63ee9aa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6f3f354000c9141599b34ed2e63ee9aa">&#9670;&#160;</a></span>Rect() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classsf_1_1Rect.html">sf::Rect</a>&lt; T &gt;::Rect </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">constexpr</span><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Default constructor. </p>
<p>Creates an empty rectangle (it is equivalent to calling <code><a class="el" href="classsf_1_1Rect.html" title="Utility class for manipulating 2D axis aligned rectangles.">Rect</a>({0, 0}, {0, 0})</code>). </p>
</div>
</div>
<a id="a18ce7808a7cf4b1b98f6b997301fe5e7" name="a18ce7808a7cf4b1b98f6b997301fe5e7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a18ce7808a7cf4b1b98f6b997301fe5e7">&#9670;&#160;</a></span>Rect() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classsf_1_1Rect.html">sf::Rect</a>&lt; T &gt;::Rect </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classsf_1_1Vector2.html">Vector2</a>&lt; T &gt;</td> <td class="paramname"><span class="paramname"><em>position</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classsf_1_1Vector2.html">Vector2</a>&lt; T &gt;</td> <td class="paramname"><span class="paramname"><em>size</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">constexpr</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct the rectangle from position and size. </p>
<p>Be careful, the last parameter is the size, not the bottom-right corner!</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">position</td><td>Position of the top-left corner of the rectangle </td></tr>
<tr><td class="paramname">size</td><td>Size of the rectangle </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ad18bdd7a9c322178c50a8893d8b15995" name="ad18bdd7a9c322178c50a8893d8b15995"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad18bdd7a9c322178c50a8893d8b15995">&#9670;&#160;</a></span>contains()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classsf_1_1Rect.html">sf::Rect</a>&lt; T &gt;::contains </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classsf_1_1Vector2.html">Vector2</a>&lt; T &gt;</td> <td class="paramname"><span class="paramname"><em>point</em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">nodiscard</span><span class="mlabel">constexpr</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if a point is inside the rectangle's area. </p>
<p>This check is non-inclusive. If the point lies on the edge of the rectangle, this function will return <code>false</code>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">point</td><td>Point to test</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if the point is inside, <code>false</code> otherwise</dd></dl>
<dl class="section see"><dt>See also</dt><dd><code><a class="el" href="#a7ef2a5f472d397bc4835a4fb7df99518" title="Check the intersection between two rectangles.">findIntersection</a></code> </dd></dl>
</div>
</div>
<a id="a7ef2a5f472d397bc4835a4fb7df99518" name="a7ef2a5f472d397bc4835a4fb7df99518"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7ef2a5f472d397bc4835a4fb7df99518">&#9670;&#160;</a></span>findIntersection()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::optional&lt; <a class="el" href="classsf_1_1Rect.html">Rect</a>&lt; T &gt; &gt; <a class="el" href="classsf_1_1Rect.html">sf::Rect</a>&lt; T &gt;::findIntersection </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classsf_1_1Rect.html">Rect</a>&lt; T &gt; &amp;</td> <td class="paramname"><span class="paramname"><em>rectangle</em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">nodiscard</span><span class="mlabel">constexpr</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Check the intersection between two rectangles. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">rectangle</td><td>Rectangle to test</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Intersection rectangle if intersecting, <code>std::nullopt</code> otherwise</dd></dl>
<dl class="section see"><dt>See also</dt><dd><code><a class="el" href="#ad18bdd7a9c322178c50a8893d8b15995" title="Check if a point is inside the rectangle&#39;s area.">contains</a></code> </dd></dl>
</div>
</div>
<a id="ab37812f2b0ffd121d666c5859fc9fab6" name="ab37812f2b0ffd121d666c5859fc9fab6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab37812f2b0ffd121d666c5859fc9fab6">&#9670;&#160;</a></span>getCenter()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classsf_1_1Vector2.html">Vector2</a>&lt; T &gt; <a class="el" href="classsf_1_1Rect.html">sf::Rect</a>&lt; T &gt;::getCenter </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">nodiscard</span><span class="mlabel">constexpr</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the position of the center of the rectangle. </p>
<dl class="section return"><dt>Returns</dt><dd>Center of rectangle </dd></dl>
</div>
</div>
<a id="a006f1450f51ed7bec69f2b45966b33ac" name="a006f1450f51ed7bec69f2b45966b33ac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a006f1450f51ed7bec69f2b45966b33ac">&#9670;&#160;</a></span>operator Rect&lt; U &gt;()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<div class="memtemplate">
template&lt;typename U &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classsf_1_1Rect.html">sf::Rect</a>&lt; T &gt;::operator <a class="el" href="classsf_1_1Rect.html">Rect</a>&lt; U &gt; </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span><span class="mlabel">constexpr</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Converts the rectangle to another type of rectangle. </p>
</div>
</div>
<h2 class="groupheader">Friends And Related Symbol Documentation</h2>
<a id="a3e687a68a85f552a6b253dd068e9a007" name="a3e687a68a85f552a6b253dd068e9a007"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3e687a68a85f552a6b253dd068e9a007">&#9670;&#160;</a></span>operator!=()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool operator!= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classsf_1_1Rect.html">Rect</a>&lt; T &gt; &amp;</td> <td class="paramname"><span class="paramname"><em>lhs</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classsf_1_1Rect.html">Rect</a>&lt; T &gt; &amp;</td> <td class="paramname"><span class="paramname"><em>rhs</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">related</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Overload of binary <code>operator!=</code> </p>
<p>This operator compares strict difference between two rectangles.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">lhs</td><td>Left operand (a rectangle) </td></tr>
<tr><td class="paramname">rhs</td><td>Right operand (a rectangle)</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if <em>lhs</em> is not equal to <em>rhs</em> </dd></dl>
</div>
</div>
<a id="a9fd43df62132ae04873de6d034591895" name="a9fd43df62132ae04873de6d034591895"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9fd43df62132ae04873de6d034591895">&#9670;&#160;</a></span>operator==()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classsf_1_1Rect.html">Rect</a>&lt; T &gt; &amp;</td> <td class="paramname"><span class="paramname"><em>lhs</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classsf_1_1Rect.html">Rect</a>&lt; T &gt; &amp;</td> <td class="paramname"><span class="paramname"><em>rhs</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">related</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Overload of binary <code>operator==</code> </p>
<p>This operator compares strict equality between two rectangles.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">lhs</td><td>Left operand (a rectangle) </td></tr>
<tr><td class="paramname">rhs</td><td>Right operand (a rectangle)</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if <em>lhs</em> is equal to <em>rhs</em> </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a561ce610acfafc975647c19db1c76bce" name="a561ce610acfafc975647c19db1c76bce"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a561ce610acfafc975647c19db1c76bce">&#9670;&#160;</a></span>position</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classsf_1_1Vector2.html">Vector2</a>&lt;T&gt; <a class="el" href="classsf_1_1Rect.html">sf::Rect</a>&lt; T &gt;::position {}</td>
</tr>
</table>
</div><div class="memdoc">
<p>Position of the top-left corner of the rectangle. </p>
<p class="definition">Definition at line <a class="el" href="Rect_8hpp_source.html#l00111">111</a> of file <a class="el" href="Rect_8hpp_source.html">Rect.hpp</a>.</p>
</div>
</div>
<a id="a39912541f559c5f780e4400831595acc" name="a39912541f559c5f780e4400831595acc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a39912541f559c5f780e4400831595acc">&#9670;&#160;</a></span>size</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classsf_1_1Vector2.html">Vector2</a>&lt;T&gt; <a class="el" href="classsf_1_1Rect.html">sf::Rect</a>&lt; T &gt;::size {}</td>
</tr>
</table>
</div><div class="memdoc">
<p>Size of the rectangle. </p>
<p class="definition">Definition at line <a class="el" href="Rect_8hpp_source.html#l00112">112</a> of file <a class="el" href="Rect_8hpp_source.html">Rect.hpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="Rect_8hpp_source.html">Rect.hpp</a></li>
</ul>
</div><!-- contents -->
</div>
<div id="footer-container">
<div id="footer">
SFML is licensed under the terms and conditions of the <a href="https://www.sfml-dev.org/license.php">zlib/png license</a>.<br />
Copyright &copy; Laurent Gomila &nbsp;::&nbsp;
Documentation generated by <a href="http://www.doxygen.org/" title="doxygen website">doxygen</a> &nbsp;::&nbsp;
</div>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink