<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Fox::FXExtentd
— 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::FXExtentd";
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">FXExtentd</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::FXExtentd
</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::FXExtentd</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>rdoc-sources/FXExtentd.rb</dd>
</dl>
</div>
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#lower-instance_method" title="#lower (instance method)">#<strong>lower</strong> ⇒ Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Lower corner of this extent (an FXVec2d instance).</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#upper-instance_method" title="#upper (instance method)">#<strong>upper</strong> ⇒ Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Upper corner of this extent (an FXVec2d instance).</p>
</div></span>
</li>
</ul>
<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>(i) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Indexing with 0..1 (returns an FXVec2d instance).</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#center-instance_method" title="#center (instance method)">#<strong>center</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Return center of box (as an FXVec2d).</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#contains%3F-instance_method" title="#contains? (instance method)">#<strong>contains?</strong>(ext) ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Return <code>true</code> if box properly contains another box (where <em>ext</em> is another FXExtentd instance).</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#corner-instance_method" title="#corner (instance method)">#<strong>corner</strong>(c) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Return corner number 0, 1, 2 or 3 (as a FXVec2d instance).</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#diagonal-instance_method" title="#diagonal (instance method)">#<strong>diagonal</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Compute diagonal vector (returns an FXVec2d).</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#diameter-instance_method" title="#diameter (instance method)">#<strong>diameter</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Return length of diagonal.</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 empty.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#height-instance_method" title="#height (instance method)">#<strong>height</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Return height of box.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#include!-instance_method" title="#include! (instance method)">#<strong>include!</strong>(ext) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Include given range into extent (where <em>ext</em> is another FXExtentd instance) and return a reference to self.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(xlo, xhi, ylo, yhi) ⇒ FXExtentd </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>Initialize from four numbers.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#intersect_with-instance_method" title="#intersect_with (instance method)">#<strong>intersect_with</strong>(other) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Return a new FXExtentd that is the intersection of this extent and <em>other</em>.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#longest-instance_method" title="#longest (instance method)">#<strong>longest</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Return length of longest side.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#overlap%3F-instance_method" title="#overlap? (instance method)">#<strong>overlap?</strong>(other) ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Return <code>true</code> if this extent’s bounds overlap with <em>other</em> extent’s bounds.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#radius-instance_method" title="#radius (instance method)">#<strong>radius</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Return radius of box.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#shortest-instance_method" title="#shortest (instance method)">#<strong>shortest</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Return length of shortest side.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#unite_with-instance_method" title="#unite_with (instance method)">#<strong>unite_with</strong>(other) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Return a new FXExtentd that is the union of this extent and <em>other</em>.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#width-instance_method" title="#width (instance method)">#<strong>width</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Return width of box.</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>(xlo, xhi, ylo, yhi) ⇒ <tt><span class='object_link'><a href="" title="Fox::FXExtentd (class)">FXExtentd</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Initialize from four numbers</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
10</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXExtentd.rb', line 10</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_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
<span id=""></span>
<div class="method_details first">
<h3 class="signature first" id="lower-instance_method">
#<strong>lower</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Lower corner of this extent (an FXVec2d instance).</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
4
5
6</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXExtentd.rb', line 4</span>
<span class='kw'>def</span> <span class='id identifier rubyid_lower'>lower</span>
<span class='ivar'>@lower</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="upper-instance_method">
#<strong>upper</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Upper corner of this extent (an FXVec2d instance).</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
7
8
9</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXExtentd.rb', line 7</span>
<span class='kw'>def</span> <span class='id identifier rubyid_upper'>upper</span>
<span class='ivar'>@upper</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>(i) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Indexing with 0..1 (returns an FXVec2d instance).</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
23</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXExtentd.rb', line 23</span>
<span class='kw'>def</span> <span class='op'>[]</span><span class='lparen'>(</span><span class='id identifier rubyid_i'>i</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="center-instance_method">
#<strong>center</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return center of box (as an FXVec2d)</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/FXExtentd.rb', line 47</span>
<span class='kw'>def</span> <span class='id identifier rubyid_center'>center</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>(ext) ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return <code>true</code> if box properly contains another box (where <em>ext</em> is another FXExtentd instance).</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">
53</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXExtentd.rb', line 53</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="corner-instance_method">
#<strong>corner</strong>(c) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return corner number 0, 1, 2 or 3 (as a FXVec2d instance).</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
76</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXExtentd.rb', line 76</span>
<span class='kw'>def</span> <span class='id identifier rubyid_corner'>corner</span><span class='lparen'>(</span><span class='id identifier rubyid_c'>c</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="diagonal-instance_method">
#<strong>diagonal</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Compute diagonal vector (returns an FXVec2d)</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
44</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXExtentd.rb', line 44</span>
<span class='kw'>def</span> <span class='id identifier rubyid_diagonal'>diagonal</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="diameter-instance_method">
#<strong>diameter</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return length of diagonal</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
38</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXExtentd.rb', line 38</span>
<span class='kw'>def</span> <span class='id identifier rubyid_diameter'>diameter</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 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">
50</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXExtentd.rb', line 50</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="height-instance_method">
#<strong>height</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return height of box</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
29</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXExtentd.rb', line 29</span>
<span class='kw'>def</span> <span class='id identifier rubyid_height'>height</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="include!-instance_method">
#<strong>include!</strong>(ext) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Include given range into extent (where <em>ext</em> is another FXExtentd instance) and return a reference to self.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
63</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXExtentd.rb', line 63</span>
<span class='kw'>def</span> <span class='id identifier rubyid_include!'>include!</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="intersect_with-instance_method">
#<strong>intersect_with</strong>(other) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return a new FXExtentd that is the intersection of this extent and <em>other</em>.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
82</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXExtentd.rb', line 82</span>
<span class='kw'>def</span> <span class='id identifier rubyid_intersect_with'>intersect_with</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="longest-instance_method">
#<strong>longest</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return length of longest side</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
32</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXExtentd.rb', line 32</span>
<span class='kw'>def</span> <span class='id identifier rubyid_longest'>longest</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="overlap?-instance_method">
#<strong>overlap?</strong>(other) ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return <code>true</code> if this extent’s bounds overlap with <em>other</em> extent’s bounds.</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">
73</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXExtentd.rb', line 73</span>
<span class='kw'>def</span> <span class='id identifier rubyid_overlap?'>overlap?</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="radius-instance_method">
#<strong>radius</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return radius of box</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
41</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXExtentd.rb', line 41</span>
<span class='kw'>def</span> <span class='id identifier rubyid_radius'>radius</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="shortest-instance_method">
#<strong>shortest</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return length of shortest side</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/FXExtentd.rb', line 35</span>
<span class='kw'>def</span> <span class='id identifier rubyid_shortest'>shortest</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="unite_with-instance_method">
#<strong>unite_with</strong>(other) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return a new FXExtentd that is the union of this extent and <em>other</em>.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
79</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXExtentd.rb', line 79</span>
<span class='kw'>def</span> <span class='id identifier rubyid_unite_with'>unite_with</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="width-instance_method">
#<strong>width</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return width of box</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
26</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXExtentd.rb', line 26</span>
<span class='kw'>def</span> <span class='id identifier rubyid_width'>width</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:34 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>