<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Fox::FXRegion
— FXRuby API Documentation
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" />
<link rel="stylesheet" href="../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Fox::FXRegion";
relpath = '../';
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../_index.html">Index (F)</a> »
<span class='title'><span class='object_link'><a href="../Fox.html" title="Fox (module)">Fox</a></span></span>
»
<span class="title">FXRegion</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Fox::FXRegion
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">Fox::FXRegion</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>rdoc-sources/FXRegion.rb</dd>
</dl>
</div>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#*-instance_method" title="#* (instance method)">#<strong>*</strong>(other) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Return a new FXRegion which is the intersection of this region and <em>other</em> (another FXRegion instance).</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#%2B-instance_method" title="#+ (instance method)">#<strong>+</strong>(other) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Return a new FXRegion which is the union of this region and <em>other</em> (another FXRegion instance).</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#--instance_method" title="#- (instance method)">#<strong>-</strong>(other) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Return a new FXRegion which is the difference of this region and <em>other</em> (another FXRegion instance).</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#==-instance_method" title="#== (instance method)">#<strong>==</strong>(other) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Return <code>true</code> if this region is equal to <em>other</em> (another FXRegion instance).</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#%5E-instance_method" title="#^ (instance method)">#<strong>^</strong>(other) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Return a new FXRegion which is the exclusive-or (XOR) of this region with <em>other</em> (another FXRegion instance).</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#bounds-instance_method" title="#bounds (instance method)">#<strong>bounds</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Return the bounding box (an FXRectangle instance) for this region.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#contains%3F-instance_method" title="#contains? (instance method)">#<strong>contains?</strong>(x, y, w, h) ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Return <code>true</code> if this region contains the rectangle whose upper left corner is at (<em>x</em>, <em>y</em>) and whose width and height are (<em>w</em>, <em>h</em>).</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#empty%3F-instance_method" title="#empty? (instance method)">#<strong>empty?</strong> ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Return <code>true</code> if this region is empty.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(points, winding = false) ⇒ FXRegion </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>Construct polygon region from an array of points.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#offset!-instance_method" title="#offset! (instance method)">#<strong>offset!</strong>(dx, dy) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Offset this region by (<em>dx</em>, <em>dy</em>) units, and return a reference to this region.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#reset-instance_method" title="#reset (instance method)">#<strong>reset</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Reset this region to empty.</p>
</div></span>
</li>
</ul>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
#<strong>initialize</strong>(points, winding = false) ⇒ <tt><span class='object_link'><a href="" title="Fox::FXRegion (class)">FXRegion</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Construct polygon region from an array of points. Here, <em>points</em> is an array of FXPoint instances.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
4</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXRegion.rb', line 4</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="*-instance_method">
#<strong>*</strong>(other) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return a new FXRegion which is the intersection of this region and <em>other</em> (another FXRegion instance).</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
47</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXRegion.rb', line 47</span>
<span class='kw'>def</span> <span class='op'>*</span><span class='lparen'>(</span><span class='id identifier rubyid_other'>other</span><span class='rparen'>)</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="+-instance_method">
#<strong>+</strong>(other) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return a new FXRegion which is the union of this region and <em>other</em> (another FXRegion instance).</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
43</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXRegion.rb', line 43</span>
<span class='kw'>def</span> <span class='op'>+</span><span class='lparen'>(</span><span class='id identifier rubyid_other'>other</span><span class='rparen'>)</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="--instance_method">
#<strong>-</strong>(other) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return a new FXRegion which is the difference of this region and <em>other</em> (another FXRegion instance).</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
51</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXRegion.rb', line 51</span>
<span class='kw'>def</span> <span class='op'>-</span><span class='lparen'>(</span><span class='id identifier rubyid_other'>other</span><span class='rparen'>)</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="==-instance_method">
#<strong>==</strong>(other) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return <code>true</code> if this region is equal to <em>other</em> (another FXRegion instance).</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
58</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXRegion.rb', line 58</span>
<span class='kw'>def</span> <span class='op'>==</span><span class='lparen'>(</span><span class='id identifier rubyid_other'>other</span><span class='rparen'>)</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="^-instance_method">
#<strong>^</strong>(other) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return a new FXRegion which is the exclusive-or (XOR) of this region with <em>other</em> (another FXRegion instance).</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
55</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXRegion.rb', line 55</span>
<span class='kw'>def</span> <span class='op'>^</span><span class='lparen'>(</span><span class='id identifier rubyid_other'>other</span><span class='rparen'>)</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="bounds-instance_method">
#<strong>bounds</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return the bounding box (an FXRectangle instance) for this region.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
35</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXRegion.rb', line 35</span>
<span class='kw'>def</span> <span class='id identifier rubyid_bounds'>bounds</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="contains?-instance_method">
#<strong>contains?</strong>(x, y, w, h) ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return <code>true</code> if this region contains the rectangle whose upper left corner is at (<em>x</em>, <em>y</em>) and whose width and height are (<em>w</em>, <em>h</em>).</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
28</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXRegion.rb', line 28</span>
<span class='kw'>def</span> <span class='id identifier rubyid_contains?'>contains?</span><span class='lparen'>(</span><span class='id identifier rubyid_x'>x</span><span class='comma'>,</span> <span class='id identifier rubyid_y'>y</span><span class='rparen'>)</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="empty?-instance_method">
#<strong>empty?</strong> ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return <code>true</code> if this region is empty</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
25</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXRegion.rb', line 25</span>
<span class='kw'>def</span> <span class='id identifier rubyid_empty?'>empty?</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="offset!-instance_method">
#<strong>offset!</strong>(dx, dy) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Offset this region by (<em>dx</em>, <em>dy</em>) units, and return a reference to this region.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
39</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXRegion.rb', line 39</span>
<span class='kw'>def</span> <span class='id identifier rubyid_offset!'>offset!</span><span class='lparen'>(</span><span class='id identifier rubyid_dx'>dx</span><span class='comma'>,</span> <span class='id identifier rubyid_dy'>dy</span><span class='rparen'>)</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="reset-instance_method">
#<strong>reset</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Reset this region to empty.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
61</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXRegion.rb', line 61</span>
<span class='kw'>def</span> <span class='id identifier rubyid_reset'>reset</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Mon Jan 2 11:47:31 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.28 (ruby-3.1.2).
</div>
</div>
</body>
</html>