2c3569dd39
Former-commit-id:2b462d8665[formerly133dc97f67] [formerlya02aeb236c] [formerlya02aeb236c[formerly9f19e3f712]] [formerly06a8b51d6d[formerlya02aeb236c[formerly9f19e3f712] [formerly06a8b51d6d[formerly 64fa9254b946eae7e61bbc3f513b7c3696c4f54f]]]] Former-commit-id:06a8b51d6dFormer-commit-id:e2ecdcfe33[formerly377dcd10b9] [formerly8e80217e59[formerly3360eb6c5f]] Former-commit-id:8e80217e59Former-commit-id:9bb8decbcf
332 lines
12 KiB
HTML
Executable file
332 lines
12 KiB
HTML
Executable file
<?xml version="1.0" encoding="ascii"?>
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
"DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
<head>
|
|
<title>Scientific.Geometry.Objects3D.GeometricalObject3D</title>
|
|
<link rel="stylesheet" href="epydoc.css" type="text/css" />
|
|
<script type="text/javascript" src="epydoc.js"></script>
|
|
</head>
|
|
|
|
<body bgcolor="white" text="black" link="blue" vlink="#204080"
|
|
alink="#204080">
|
|
<!-- ==================== NAVIGATION BAR ==================== -->
|
|
<table class="navbar" border="0" width="100%" cellpadding="0"
|
|
bgcolor="#a0c0ff" cellspacing="0">
|
|
<tr valign="middle">
|
|
<!-- Home link -->
|
|
<th> <a
|
|
href="Scientific-module.html">Home</a> </th>
|
|
|
|
<!-- Tree link -->
|
|
<th> <a
|
|
href="module-tree.html">Trees</a> </th>
|
|
|
|
<!-- Index link -->
|
|
<th> <a
|
|
href="identifier-index.html">Indices</a> </th>
|
|
|
|
<!-- Help link -->
|
|
<th> <a
|
|
href="help.html">Help</a> </th>
|
|
|
|
<!-- Project homepage -->
|
|
<th class="navbar" align="right" width="100%">
|
|
<table border="0" cellpadding="0" cellspacing="0">
|
|
<tr><th class="navbar" align="center"
|
|
><a class="navbar" target="_top" href="http://dirac.cnrs-orleans.fr/ScientificPython/">Scientific Python</a></th>
|
|
</tr></table></th>
|
|
</tr>
|
|
</table>
|
|
<table width="100%" cellpadding="0" cellspacing="0">
|
|
<tr valign="top">
|
|
<td width="100%">
|
|
<span class="breadcrumbs">
|
|
<a href="Scientific-module.html">Package Scientific</a> ::
|
|
<a href="Scientific.Geometry-module.html">Package Geometry</a> ::
|
|
<a href="Scientific.Geometry.Objects3D-module.html">Module Objects3D</a> ::
|
|
Class GeometricalObject3D
|
|
</span>
|
|
</td>
|
|
<td>
|
|
<table cellpadding="0" cellspacing="0">
|
|
<!-- hide/show private -->
|
|
<tr><td align="right"><span class="options"
|
|
>[<a href="frames.html" target="_top">frames</a
|
|
>] | <a href="Scientific.Geometry.Objects3D.GeometricalObject3D-class.html"
|
|
target="_top">no frames</a>]</span></td></tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<!-- ==================== CLASS DESCRIPTION ==================== -->
|
|
<h1 class="epydoc">Class GeometricalObject3D</h1><p class="nomargin-top"></p>
|
|
<dl><dt>Known Subclasses:</dt>
|
|
<dd>
|
|
<ul class="subclass-list">
|
|
<li><a href="Scientific.Geometry.Objects3D.Circle-class.html">Circle</a></li><li>, <a href="Scientific.Geometry.Objects3D.Cone-class.html">Cone</a></li><li>, <a href="Scientific.Geometry.Objects3D.Line-class.html">Line</a></li><li>, <a href="Scientific.Geometry.Objects3D.Plane-class.html">Plane</a></li><li>, <a href="Scientific.Geometry.Objects3D.Sphere-class.html">Sphere</a></li> </ul>
|
|
</dd></dl>
|
|
|
|
<hr />
|
|
<p>Geometrical object in 3D space</p>
|
|
<p>This is an abstract base class; to create instances, use one of the
|
|
subclasses.</p>
|
|
|
|
<!-- ==================== INSTANCE METHODS ==================== -->
|
|
<a name="section-InstanceMethods"></a>
|
|
<table class="summary" border="1" cellpadding="3"
|
|
cellspacing="0" width="100%" bgcolor="white">
|
|
<tr bgcolor="#70b0f0" class="table-header">
|
|
<td align="left" colspan="2" class="table-header">
|
|
<span class="table-header">Instance Methods</span></td>
|
|
</tr>
|
|
<tr>
|
|
<td width="15%" align="right" valign="top" class="summary">
|
|
<span class="summary-type"><code>float</code></span>
|
|
</td><td class="summary">
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td><span class="summary-sig"><a href="Scientific.Geometry.Objects3D.GeometricalObject3D-class.html#distanceFrom" class="summary-sig-name">distanceFrom</a>(<span class="summary-sig-arg">self</span>,
|
|
<span class="summary-sig-arg">point</span>)</span></td>
|
|
<td align="right" valign="top">
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td width="15%" align="right" valign="top" class="summary">
|
|
<span class="summary-type"><code>bool</code></span>
|
|
</td><td class="summary">
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td><span class="summary-sig"><a href="Scientific.Geometry.Objects3D.GeometricalObject3D-class.html#hasPoint" class="summary-sig-name">hasPoint</a>(<span class="summary-sig-arg">self</span>,
|
|
<span class="summary-sig-arg">point</span>)</span><br />
|
|
Returns:
|
|
<code>True</code> if point is in the object</td>
|
|
<td align="right" valign="top">
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td width="15%" align="right" valign="top" class="summary">
|
|
<span class="summary-type"><a
|
|
href="Scientific.Geometry.Objects3D.GeometricalObject3D-class.html"
|
|
class="link">GeometricalObject3D</a> or <code>NoneType</code></span>
|
|
</td><td class="summary">
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td><span class="summary-sig"><a href="Scientific.Geometry.Objects3D.GeometricalObject3D-class.html#intersectWith" class="summary-sig-name">intersectWith</a>(<span class="summary-sig-arg">self</span>,
|
|
<span class="summary-sig-arg">other</span>)</span><br />
|
|
Returns:
|
|
the geometrical object that results from the intersection with other.</td>
|
|
<td align="right" valign="top">
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td width="15%" align="right" valign="top" class="summary">
|
|
<span class="summary-type"><code>float</code> or <code>NoneType</code></span>
|
|
</td><td class="summary">
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td><span class="summary-sig"><a href="Scientific.Geometry.Objects3D.GeometricalObject3D-class.html#volume" class="summary-sig-name">volume</a>(<span class="summary-sig-arg">self</span>)</span><br />
|
|
Returns:
|
|
the volume of the object.</td>
|
|
<td align="right" valign="top">
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<!-- ==================== METHOD DETAILS ==================== -->
|
|
<a name="section-MethodDetails"></a>
|
|
<table class="details" border="1" cellpadding="3"
|
|
cellspacing="0" width="100%" bgcolor="white">
|
|
<tr bgcolor="#70b0f0" class="table-header">
|
|
<td align="left" colspan="2" class="table-header">
|
|
<span class="table-header">Method Details</span></td>
|
|
</tr>
|
|
</table>
|
|
<a name="distanceFrom"></a>
|
|
<div>
|
|
<table class="details" border="1" cellpadding="3"
|
|
cellspacing="0" width="100%" bgcolor="white">
|
|
<tr><td>
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr valign="top"><td>
|
|
<h3 class="epydoc"><span class="sig"><span class="sig-name">distanceFrom</span>(<span class="sig-arg">self</span>,
|
|
<span class="sig-arg">point</span>)</span>
|
|
</h3>
|
|
</td><td align="right" valign="top"
|
|
>
|
|
</td>
|
|
</tr></table>
|
|
|
|
|
|
<dl class="fields">
|
|
<dt>Parameters:</dt>
|
|
<dd><ul class="nomargin-top">
|
|
<li><strong class="pname"><code>point</code></strong> (<a href="Scientific.Geometry.Vector-class.html"
|
|
class="link">Scientific.Geometry.Vector</a> @returns the distance
|
|
of point from the closest point of the object) - a point in space</li>
|
|
</ul></dd>
|
|
<dt>Returns: <code>float</code></dt>
|
|
</dl>
|
|
</td></tr></table>
|
|
</div>
|
|
<a name="hasPoint"></a>
|
|
<div>
|
|
<table class="details" border="1" cellpadding="3"
|
|
cellspacing="0" width="100%" bgcolor="white">
|
|
<tr><td>
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr valign="top"><td>
|
|
<h3 class="epydoc"><span class="sig"><span class="sig-name">hasPoint</span>(<span class="sig-arg">self</span>,
|
|
<span class="sig-arg">point</span>)</span>
|
|
</h3>
|
|
</td><td align="right" valign="top"
|
|
>
|
|
</td>
|
|
</tr></table>
|
|
|
|
|
|
<dl class="fields">
|
|
<dt>Parameters:</dt>
|
|
<dd><ul class="nomargin-top">
|
|
<li><strong class="pname"><code>point</code></strong> (<a href="Scientific.Geometry.Vector-class.html"
|
|
class="link">Scientific.Geometry.Vector</a>) - a point in space</li>
|
|
</ul></dd>
|
|
<dt>Returns: <code>bool</code></dt>
|
|
<dd><code>True</code> if point is in the object</dd>
|
|
</dl>
|
|
</td></tr></table>
|
|
</div>
|
|
<a name="intersectWith"></a>
|
|
<div>
|
|
<table class="details" border="1" cellpadding="3"
|
|
cellspacing="0" width="100%" bgcolor="white">
|
|
<tr><td>
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr valign="top"><td>
|
|
<h3 class="epydoc"><span class="sig"><span class="sig-name">intersectWith</span>(<span class="sig-arg">self</span>,
|
|
<span class="sig-arg">other</span>)</span>
|
|
</h3>
|
|
</td><td align="right" valign="top"
|
|
>
|
|
</td>
|
|
</tr></table>
|
|
|
|
|
|
<dl class="fields">
|
|
<dt>Parameters:</dt>
|
|
<dd><ul class="nomargin-top">
|
|
<li><strong class="pname"><code>other</code></strong> (<a
|
|
href="Scientific.Geometry.Objects3D.GeometricalObject3D-class.html"
|
|
class="link">GeometricalObject3D</a>) - another geometrical object</li>
|
|
</ul></dd>
|
|
<dt>Returns: <a
|
|
href="Scientific.Geometry.Objects3D.GeometricalObject3D-class.html"
|
|
class="link">GeometricalObject3D</a> or <code>NoneType</code></dt>
|
|
<dd>the geometrical object that results from the intersection with
|
|
other. If there is no intersection, the result is
|
|
<code>None</code>.</dd>
|
|
</dl>
|
|
<div class="fields"> <p><strong>Note:</strong>
|
|
Intersection is not implemented for all possible pairs of objects.
|
|
A 'ValueError' is raised for combinations that haven't been
|
|
implemented yet.
|
|
</p>
|
|
</div></td></tr></table>
|
|
</div>
|
|
<a name="volume"></a>
|
|
<div>
|
|
<table class="details" border="1" cellpadding="3"
|
|
cellspacing="0" width="100%" bgcolor="white">
|
|
<tr><td>
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr valign="top"><td>
|
|
<h3 class="epydoc"><span class="sig"><span class="sig-name">volume</span>(<span class="sig-arg">self</span>)</span>
|
|
</h3>
|
|
</td><td align="right" valign="top"
|
|
>
|
|
</td>
|
|
</tr></table>
|
|
|
|
|
|
<dl class="fields">
|
|
<dt>Returns: <code>float</code> or <code>NoneType</code></dt>
|
|
<dd>the volume of the object. The result is <code>None</code> for
|
|
unbounded objects and zero for lower-dimensional objects.</dd>
|
|
</dl>
|
|
</td></tr></table>
|
|
</div>
|
|
<br />
|
|
<!-- ==================== NAVIGATION BAR ==================== -->
|
|
<table class="navbar" border="0" width="100%" cellpadding="0"
|
|
bgcolor="#a0c0ff" cellspacing="0">
|
|
<tr valign="middle">
|
|
<!-- Home link -->
|
|
<th> <a
|
|
href="Scientific-module.html">Home</a> </th>
|
|
|
|
<!-- Tree link -->
|
|
<th> <a
|
|
href="module-tree.html">Trees</a> </th>
|
|
|
|
<!-- Index link -->
|
|
<th> <a
|
|
href="identifier-index.html">Indices</a> </th>
|
|
|
|
<!-- Help link -->
|
|
<th> <a
|
|
href="help.html">Help</a> </th>
|
|
|
|
<!-- Project homepage -->
|
|
<th class="navbar" align="right" width="100%">
|
|
<table border="0" cellpadding="0" cellspacing="0">
|
|
<tr><th class="navbar" align="center"
|
|
><a class="navbar" target="_top" href="http://dirac.cnrs-orleans.fr/ScientificPython/">Scientific Python</a></th>
|
|
</tr></table></th>
|
|
</tr>
|
|
</table>
|
|
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
|
<tr>
|
|
<td align="left" class="footer">
|
|
Generated by Epydoc 3.0 on Tue Oct 28 14:16:04 2008
|
|
</td>
|
|
<td align="right" class="footer">
|
|
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
|
>http://epydoc.sourceforge.net</a>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<script type="text/javascript">
|
|
<!--
|
|
// Private objects are initially displayed (because if
|
|
// javascript is turned off then we want them to be
|
|
// visible); but by default, we want to hide them. So hide
|
|
// them unless we have a cookie that says to show them.
|
|
checkCookie();
|
|
// -->
|
|
</script>
|
|
</body>
|
|
</html>
|