<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Fox::FXSpheref
— 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::FXSpheref";
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">FXSpheref</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::FXSpheref
</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::FXSpheref</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>rdoc-sources/FXSpheref.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Spherical bounds</p>
</div>
</div>
<div class="tags">
</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="#center-instance_method" title="#center (instance method)">#<strong>center</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Sphere center <span class='object_link'><a href="FXVec3f.html" title="Fox::FXVec3f (class)">FXVec3f</a></span>.</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>Sphere radius [Float].</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="#contains%3F-instance_method" title="#contains? (instance method)">#<strong>contains?</strong>(sphere) ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Return <code>true</code> if this sphere properly contains <em>sphere</em> (another FXSpheref instance).</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 the diameter of this sphere.</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 sphere is empty (i.e. has zero radius).</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#include!-instance_method" title="#include! (instance method)">#<strong>include!</strong>(sphere) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Include the sphere <em>sphere</em> (an FXSpheref instance) into this sphere and return self.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#includeInRadius!-instance_method" title="#includeInRadius! (instance method)">#<strong>includeInRadius!</strong>(sphere) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Expand radius to include sphere (an FXSpheref instance) and return self.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(bounds) ⇒ FXSpheref </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>Initialize sphere to fully contain the given bounding box (an FXRangef instance).</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#intersect-instance_method" title="#intersect (instance method)">#<strong>intersect</strong>(plane) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Intersect this sphere with the plane <em>ax+by+cz+w</em> and return -1, 0 or +1.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#intersects%3F-instance_method" title="#intersects? (instance method)">#<strong>intersects?</strong>(u, v) ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Return <code>true</code> if this sphere intersects the ray between points <em>u</em> and <em>v</em> (both FXVec3f instances).</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#overlaps%3F-instance_method" title="#overlaps? (instance method)">#<strong>overlaps?</strong>(sphere) ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Return <code>true</code> if this sphere overlaps with another sphere.</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>(bounds) ⇒ <tt><span class='object_link'><a href="" title="Fox::FXSpheref (class)">FXSpheref</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Initialize sphere to fully contain the given bounding box (an FXRangef instance).</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
13</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXSpheref.rb', line 13</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="center=-instance_method"></span>
<div class="method_details first">
<h3 class="signature first" id="center-instance_method">
#<strong>center</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Sphere center <span class='object_link'><a href="FXVec3f.html" title="Fox::FXVec3f (class)">Fox::FXVec3f</a></span></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/FXSpheref.rb', line 7</span>
<span class='kw'>def</span> <span class='id identifier rubyid_center'>center</span>
<span class='ivar'>@center</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="radius=-instance_method"></span>
<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>Sphere radius [Float]</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
10
11
12</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXSpheref.rb', line 10</span>
<span class='kw'>def</span> <span class='id identifier rubyid_radius'>radius</span>
<span class='ivar'>@radius</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="contains?-instance_method">
#<strong>contains?</strong>(sphere) ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return <code>true</code> if this sphere properly contains <em>sphere</em> (another FXSpheref 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">
34</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXSpheref.rb', line 34</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='comma'>,</span> <span class='id identifier rubyid_z'>z</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="diameter-instance_method">
#<strong>diameter</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return the diameter of this sphere.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
28</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXSpheref.rb', line 28</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 this sphere is empty (i.e. has zero radius).</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">
31</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXSpheref.rb', line 31</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="include!-instance_method">
#<strong>include!</strong>(sphere) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Include the sphere <em>sphere</em> (an FXSpheref instance) into this sphere and return self.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
46</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXSpheref.rb', line 46</span>
<span class='kw'>def</span> <span class='id identifier rubyid_include!'>include!</span><span class='lparen'>(</span><span class='id identifier rubyid_p'>p</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="includeInRadius!-instance_method">
#<strong>includeInRadius!</strong>(sphere) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Expand radius to include sphere (an FXSpheref instance) and return self.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
49</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXSpheref.rb', line 49</span>
<span class='kw'>def</span> <span class='id identifier rubyid_includeInRadius!'>includeInRadius!</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='comma'>,</span> <span class='id identifier rubyid_z'>z</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-instance_method">
#<strong>intersect</strong>(plane) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Intersect this sphere with the plane <em>ax+by+cz+w</em> and return -1, 0 or +1. Here, <em>plane</em> is an FXVec4f instance describing the plane.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
68</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXSpheref.rb', line 68</span>
<span class='kw'>def</span> <span class='id identifier rubyid_intersect'>intersect</span><span class='lparen'>(</span><span class='id identifier rubyid_plane'>plane</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="intersects?-instance_method">
#<strong>intersects?</strong>(u, v) ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return <code>true</code> if this sphere intersects the ray between points <em>u</em> and <em>v</em> (both FXVec3f instances).</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">
72</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXSpheref.rb', line 72</span>
<span class='kw'>def</span> <span class='id identifier rubyid_intersects?'>intersects?</span><span class='lparen'>(</span><span class='id identifier rubyid_u'>u</span><span class='comma'>,</span> <span class='id identifier rubyid_v'>v</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="overlaps?-instance_method">
#<strong>overlaps?</strong>(sphere) ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return <code>true</code> if this sphere overlaps with another sphere.</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">
75</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXSpheref.rb', line 75</span>
<span class='kw'>def</span> <span class='id identifier rubyid_overlaps?'>overlaps?</span><span class='lparen'>(</span><span class='id identifier rubyid_box'>box</span><span class='rparen'>)</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:37 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>