backup/JavaXNA
1
0
Fork 0
Code Issues Pull Requests Projects Releases Activity
JavaXNA/Microsoft.Xna.Framework/doc/Microsoft/Xna/Framework/BoundingBox.html
Tom Lint 92e29ba3dd Fixed compiler errors 
Regenerated JavaDoc
Updated whitespace usage
Added LWJGL libraries and binaries
2013-10-15 12:34:51 +02:00

744 lines
38 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="nl">
<head>
<!-- Generated by javadoc (version 1.7.0_40) on Tue Oct 15 12:25:33 CEST 2013 -->
<title>BoundingBox</title>
<meta name="date" content="2013-10-15">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="BoundingBox";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/BoundingBox.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li><a href="../../../Microsoft/Xna/Framework/BoundingSphere.html" title="class in Microsoft.Xna.Framework"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?Microsoft/Xna/Framework/BoundingBox.html" target="_top">Frames</a></li>
<li><a href="BoundingBox.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">Microsoft.Xna.Framework</div>
<h2 title="Class BoundingBox" class="title">Class BoundingBox</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../System/ValueType.html" title="class in System">System.ValueType</a></li>
<li>
<ul class="inheritance">
<li>Microsoft.Xna.Framework.BoundingBox</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../System/IEquatable.html" title="interface in System">IEquatable</a>&lt;<a href="../../../Microsoft/Xna/Framework/BoundingBox.html" title="class in Microsoft.Xna.Framework">BoundingBox</a>&gt;</dd>
</dl>
<hr>
<br>
<pre>public final class <span class="strong">BoundingBox</span>
extends <a href="../../../System/ValueType.html" title="class in System">ValueType</a>
implements <a href="../../../System/IEquatable.html" title="interface in System">IEquatable</a>&lt;<a href="../../../Microsoft/Xna/Framework/BoundingBox.html" title="class in Microsoft.Xna.Framework">BoundingBox</a>&gt;</pre>
<div class="block">Defines an axis-aligned box-shaped 3D volume.</div>
<dl><dt><span class="strong">Author:</span></dt>
<dd>Halofreak1990</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/BoundingBox.html#CornerCount">CornerCount</a></strong></code>
<div class="block">Specifies the total number of corners (8) in the BoundingBox.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../Microsoft/Xna/Framework/Vector3.html" title="class in Microsoft.Xna.Framework">Vector3</a></code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/BoundingBox.html#Max">Max</a></strong></code>
<div class="block">The maximum point the BoundingBox contains.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../Microsoft/Xna/Framework/Vector3.html" title="class in Microsoft.Xna.Framework">Vector3</a></code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/BoundingBox.html#Min">Min</a></strong></code>
<div class="block">The minimum point the BoundingBox contains.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../Microsoft/Xna/Framework/BoundingBox.html#BoundingBox()">BoundingBox</a></strong>()</code>
<div class="block">Creates an instance of BoundingBox.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../Microsoft/Xna/Framework/BoundingBox.html#BoundingBox(Microsoft.Xna.Framework.Vector3, Microsoft.Xna.Framework.Vector3)">BoundingBox</a></strong>(<a href="../../../Microsoft/Xna/Framework/Vector3.html" title="class in Microsoft.Xna.Framework">Vector3</a>&nbsp;min,
<a href="../../../Microsoft/Xna/Framework/Vector3.html" title="class in Microsoft.Xna.Framework">Vector3</a>&nbsp;max)</code>
<div class="block">Creates an instance of BoundingBox.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../Microsoft/Xna/Framework/ContainmentType.html" title="enum in Microsoft.Xna.Framework">ContainmentType</a></code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/BoundingBox.html#Contains(Microsoft.Xna.Framework.BoundingBox)">Contains</a></strong>(<a href="../../../Microsoft/Xna/Framework/BoundingBox.html" title="class in Microsoft.Xna.Framework">BoundingBox</a>&nbsp;box)</code>
<div class="block">Tests whether the BoundingBox contains another BoundingBox.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../Microsoft/Xna/Framework/ContainmentType.html" title="enum in Microsoft.Xna.Framework">ContainmentType</a></code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/BoundingBox.html#Contains(Microsoft.Xna.Framework.BoundingSphere)">Contains</a></strong>(<a href="../../../Microsoft/Xna/Framework/BoundingSphere.html" title="class in Microsoft.Xna.Framework">BoundingSphere</a>&nbsp;sphere)</code>
<div class="block">Tests whether the BoundingBox contains a BoundingSphere.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../Microsoft/Xna/Framework/ContainmentType.html" title="enum in Microsoft.Xna.Framework">ContainmentType</a></code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/BoundingBox.html#Contains(Microsoft.Xna.Framework.Vector3)">Contains</a></strong>(<a href="../../../Microsoft/Xna/Framework/Vector3.html" title="class in Microsoft.Xna.Framework">Vector3</a>&nbsp;point)</code>
<div class="block">Tests whether the BoundingBox contains a point.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../Microsoft/Xna/Framework/BoundingBox.html" title="class in Microsoft.Xna.Framework">BoundingBox</a></code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/BoundingBox.html#CreateFromSphere(Microsoft.Xna.Framework.BoundingSphere)">CreateFromSphere</a></strong>(<a href="../../../Microsoft/Xna/Framework/BoundingSphere.html" title="class in Microsoft.Xna.Framework">BoundingSphere</a>&nbsp;sphere)</code>
<div class="block">Creates the smallest BoundingBox that will contain the specified BoundingSphere.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/BoundingBox.html#CreateFromSphere(Microsoft.Xna.Framework.BoundingSphere, Microsoft.Xna.Framework.BoundingBox)">CreateFromSphere</a></strong>(<a href="../../../Microsoft/Xna/Framework/BoundingSphere.html" title="class in Microsoft.Xna.Framework">BoundingSphere</a>&nbsp;sphere,
<a href="../../../Microsoft/Xna/Framework/BoundingBox.html" title="class in Microsoft.Xna.Framework">BoundingBox</a>&nbsp;result)</code>
<div class="block">Creates the smallest BoundingBox that will contain the specified BoundingSphere.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../Microsoft/Xna/Framework/BoundingBox.html" title="class in Microsoft.Xna.Framework">BoundingBox</a></code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/BoundingBox.html#CreateMerged(Microsoft.Xna.Framework.BoundingBox, Microsoft.Xna.Framework.BoundingBox)">CreateMerged</a></strong>(<a href="../../../Microsoft/Xna/Framework/BoundingBox.html" title="class in Microsoft.Xna.Framework">BoundingBox</a>&nbsp;original,
<a href="../../../Microsoft/Xna/Framework/BoundingBox.html" title="class in Microsoft.Xna.Framework">BoundingBox</a>&nbsp;additional)</code>
<div class="block">Creates the smallest BoundingBox that contains the two specified BoundingBox instances.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/BoundingBox.html#CreateMerged(Microsoft.Xna.Framework.BoundingBox, Microsoft.Xna.Framework.BoundingBox, Microsoft.Xna.Framework.BoundingBox)">CreateMerged</a></strong>(<a href="../../../Microsoft/Xna/Framework/BoundingBox.html" title="class in Microsoft.Xna.Framework">BoundingBox</a>&nbsp;original,
<a href="../../../Microsoft/Xna/Framework/BoundingBox.html" title="class in Microsoft.Xna.Framework">BoundingBox</a>&nbsp;additional,
<a href="../../../Microsoft/Xna/Framework/BoundingBox.html" title="class in Microsoft.Xna.Framework">BoundingBox</a>&nbsp;result)</code>
<div class="block">Creates the smallest BoundingBox that contains the two specified BoundingBox instances.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/BoundingBox.html#Equals(Microsoft.Xna.Framework.BoundingBox)">Equals</a></strong>(<a href="../../../Microsoft/Xna/Framework/BoundingBox.html" title="class in Microsoft.Xna.Framework">BoundingBox</a>&nbsp;other)</code>
<div class="block">Determines whether two instances of BoundingBox are equal.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/BoundingBox.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object&nbsp;obj)</code>
<div class="block">Determines whether two instances of BoundingBox are equal.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../Microsoft/Xna/Framework/Vector3.html" title="class in Microsoft.Xna.Framework">Vector3</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/BoundingBox.html#GetCorners()">GetCorners</a></strong>()</code>
<div class="block">Gets an array of points that make up the corners of the BoundingBox.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/BoundingBox.html#GetCorners(Microsoft.Xna.Framework.Vector3[])">GetCorners</a></strong>(<a href="../../../Microsoft/Xna/Framework/Vector3.html" title="class in Microsoft.Xna.Framework">Vector3</a>[]&nbsp;corners)</code>
<div class="block">Defines an axis-aligned box-shaped 3D volume.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/BoundingBox.html#hashCode()">hashCode</a></strong>()</code>
<div class="block">Gets the hash code for this instance.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/BoundingBox.html#Intersects(Microsoft.Xna.Framework.BoundingBox)">Intersects</a></strong>(<a href="../../../Microsoft/Xna/Framework/BoundingBox.html" title="class in Microsoft.Xna.Framework">BoundingBox</a>&nbsp;box)</code>
<div class="block">Checks whether the current BoundingBox intersects another BoundingBox.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/BoundingBox.html#Intersects(Microsoft.Xna.Framework.BoundingBox, boolean)">Intersects</a></strong>(<a href="../../../Microsoft/Xna/Framework/BoundingBox.html" title="class in Microsoft.Xna.Framework">BoundingBox</a>&nbsp;box,
boolean&nbsp;result)</code>
<div class="block">Checks whether the current BoundingBox intersects another BoundingBox.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/BoundingBox.html#Intersects(Microsoft.Xna.Framework.BoundingSphere)">Intersects</a></strong>(<a href="../../../Microsoft/Xna/Framework/BoundingSphere.html" title="class in Microsoft.Xna.Framework">BoundingSphere</a>&nbsp;sphere)</code>
<div class="block">Checks whether the current BoundingBox intersects a BoundingSphere.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/BoundingBox.html#Intersects(Microsoft.Xna.Framework.BoundingSphere, boolean)">Intersects</a></strong>(<a href="../../../Microsoft/Xna/Framework/BoundingSphere.html" title="class in Microsoft.Xna.Framework">BoundingSphere</a>&nbsp;sphere,
boolean&nbsp;result)</code>
<div class="block">Checks whether the current BoundingBox intersects a BoundingSphere.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../Microsoft/Xna/Framework/PlaneIntersectionType.html" title="enum in Microsoft.Xna.Framework">PlaneIntersectionType</a></code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/BoundingBox.html#Intersects(Microsoft.Xna.Framework.Plane)">Intersects</a></strong>(<a href="../../../Microsoft/Xna/Framework/Plane.html" title="class in Microsoft.Xna.Framework">Plane</a>&nbsp;plane)</code>
<div class="block">Checks whether the current BoundingBox intersects a Plane.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/BoundingBox.html#Intersects(Microsoft.Xna.Framework.Plane, Microsoft.Xna.Framework.PlaneIntersectionType)">Intersects</a></strong>(<a href="../../../Microsoft/Xna/Framework/Plane.html" title="class in Microsoft.Xna.Framework">Plane</a>&nbsp;plane,
<a href="../../../Microsoft/Xna/Framework/PlaneIntersectionType.html" title="enum in Microsoft.Xna.Framework">PlaneIntersectionType</a>&nbsp;result)</code>
<div class="block">Checks whether the current BoundingBox intersects a Plane.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.Float</code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/BoundingBox.html#Intersects(Microsoft.Xna.Framework.Ray)">Intersects</a></strong>(<a href="../../../Microsoft/Xna/Framework/Ray.html" title="class in Microsoft.Xna.Framework">Ray</a>&nbsp;ray)</code>
<div class="block">Checks whether the current BoundingBox intersects a Ray.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/BoundingBox.html#Intersects(Microsoft.Xna.Framework.Ray, java.lang.Float)">Intersects</a></strong>(<a href="../../../Microsoft/Xna/Framework/Ray.html" title="class in Microsoft.Xna.Framework">Ray</a>&nbsp;ray,
java.lang.Float&nbsp;result)</code>
<div class="block">Checks whether the current BoundingBox intersects a Ray.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/BoundingBox.html#toString()">toString</a></strong>()</code>
<div class="block">Returns a String that represents the current BoundingBox.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="CornerCount">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CornerCount</h4>
<pre>public final&nbsp;int CornerCount</pre>
<div class="block">Specifies the total number of corners (8) in the BoundingBox.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#Microsoft.Xna.Framework.BoundingBox.CornerCount">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="Max">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Max</h4>
<pre>public&nbsp;<a href="../../../Microsoft/Xna/Framework/Vector3.html" title="class in Microsoft.Xna.Framework">Vector3</a> Max</pre>
<div class="block">The maximum point the BoundingBox contains.</div>
</li>
</ul>
<a name="Min">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Min</h4>
<pre>public&nbsp;<a href="../../../Microsoft/Xna/Framework/Vector3.html" title="class in Microsoft.Xna.Framework">Vector3</a> Min</pre>
<div class="block">The minimum point the BoundingBox contains.</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="BoundingBox(Microsoft.Xna.Framework.Vector3, Microsoft.Xna.Framework.Vector3)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>BoundingBox</h4>
<pre>public&nbsp;BoundingBox(<a href="../../../Microsoft/Xna/Framework/Vector3.html" title="class in Microsoft.Xna.Framework">Vector3</a>&nbsp;min,
<a href="../../../Microsoft/Xna/Framework/Vector3.html" title="class in Microsoft.Xna.Framework">Vector3</a>&nbsp;max)</pre>
<div class="block">Creates an instance of BoundingBox.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>min</code> - The minimum point the BoundingBox includes.</dd><dd><code>max</code> - The maximum point the BoundingBox includes.</dd></dl>
</li>
</ul>
<a name="BoundingBox()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>BoundingBox</h4>
<pre>public&nbsp;BoundingBox()</pre>
<div class="block">Creates an instance of BoundingBox.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="Contains(Microsoft.Xna.Framework.BoundingBox)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Contains</h4>
<pre>public&nbsp;<a href="../../../Microsoft/Xna/Framework/ContainmentType.html" title="enum in Microsoft.Xna.Framework">ContainmentType</a>&nbsp;Contains(<a href="../../../Microsoft/Xna/Framework/BoundingBox.html" title="class in Microsoft.Xna.Framework">BoundingBox</a>&nbsp;box)</pre>
<div class="block">Tests whether the BoundingBox contains another BoundingBox.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>box</code> - The BoundingBox to test for overlap.</dd></dl>
</li>
</ul>
<a name="Contains(Microsoft.Xna.Framework.BoundingSphere)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Contains</h4>
<pre>public&nbsp;<a href="../../../Microsoft/Xna/Framework/ContainmentType.html" title="enum in Microsoft.Xna.Framework">ContainmentType</a>&nbsp;Contains(<a href="../../../Microsoft/Xna/Framework/BoundingSphere.html" title="class in Microsoft.Xna.Framework">BoundingSphere</a>&nbsp;sphere)</pre>
<div class="block">Tests whether the BoundingBox contains a BoundingSphere.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sphere</code> - The BoundingSphere to test for overlap.</dd></dl>
</li>
</ul>
<a name="Contains(Microsoft.Xna.Framework.Vector3)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Contains</h4>
<pre>public&nbsp;<a href="../../../Microsoft/Xna/Framework/ContainmentType.html" title="enum in Microsoft.Xna.Framework">ContainmentType</a>&nbsp;Contains(<a href="../../../Microsoft/Xna/Framework/Vector3.html" title="class in Microsoft.Xna.Framework">Vector3</a>&nbsp;point)</pre>
<div class="block">Tests whether the BoundingBox contains a point.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>point</code> - The point to test for overlap.</dd></dl>
</li>
</ul>
<a name="CreateFromSphere(Microsoft.Xna.Framework.BoundingSphere)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CreateFromSphere</h4>
<pre>public static&nbsp;<a href="../../../Microsoft/Xna/Framework/BoundingBox.html" title="class in Microsoft.Xna.Framework">BoundingBox</a>&nbsp;CreateFromSphere(<a href="../../../Microsoft/Xna/Framework/BoundingSphere.html" title="class in Microsoft.Xna.Framework">BoundingSphere</a>&nbsp;sphere)</pre>
<div class="block">Creates the smallest BoundingBox that will contain the specified BoundingSphere.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sphere</code> - The BoundingSphere to contain.</dd></dl>
</li>
</ul>
<a name="CreateFromSphere(Microsoft.Xna.Framework.BoundingSphere, Microsoft.Xna.Framework.BoundingBox)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CreateFromSphere</h4>
<pre>public static&nbsp;void&nbsp;CreateFromSphere(<a href="../../../Microsoft/Xna/Framework/BoundingSphere.html" title="class in Microsoft.Xna.Framework">BoundingSphere</a>&nbsp;sphere,
<a href="../../../Microsoft/Xna/Framework/BoundingBox.html" title="class in Microsoft.Xna.Framework">BoundingBox</a>&nbsp;result)</pre>
<div class="block">Creates the smallest BoundingBox that will contain the specified BoundingSphere.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sphere</code> - The BoundingSphere to contain.</dd><dd><code>result</code> - [OutAttribute] The created BoundingBox.</dd></dl>
</li>
</ul>
<a name="CreateMerged(Microsoft.Xna.Framework.BoundingBox, Microsoft.Xna.Framework.BoundingBox)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CreateMerged</h4>
<pre>public static&nbsp;<a href="../../../Microsoft/Xna/Framework/BoundingBox.html" title="class in Microsoft.Xna.Framework">BoundingBox</a>&nbsp;CreateMerged(<a href="../../../Microsoft/Xna/Framework/BoundingBox.html" title="class in Microsoft.Xna.Framework">BoundingBox</a>&nbsp;original,
<a href="../../../Microsoft/Xna/Framework/BoundingBox.html" title="class in Microsoft.Xna.Framework">BoundingBox</a>&nbsp;additional)</pre>
<div class="block">Creates the smallest BoundingBox that contains the two specified BoundingBox instances.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>original</code> - One of the BoundingBoxs to contain.</dd><dd><code>additional</code> - One of the BoundingBoxs to contain.</dd></dl>
</li>
</ul>
<a name="CreateMerged(Microsoft.Xna.Framework.BoundingBox, Microsoft.Xna.Framework.BoundingBox, Microsoft.Xna.Framework.BoundingBox)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CreateMerged</h4>
<pre>public static&nbsp;void&nbsp;CreateMerged(<a href="../../../Microsoft/Xna/Framework/BoundingBox.html" title="class in Microsoft.Xna.Framework">BoundingBox</a>&nbsp;original,
<a href="../../../Microsoft/Xna/Framework/BoundingBox.html" title="class in Microsoft.Xna.Framework">BoundingBox</a>&nbsp;additional,
<a href="../../../Microsoft/Xna/Framework/BoundingBox.html" title="class in Microsoft.Xna.Framework">BoundingBox</a>&nbsp;result)</pre>
<div class="block">Creates the smallest BoundingBox that contains the two specified BoundingBox instances.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>original</code> - One of the BoundingBoxs to contain.</dd><dd><code>additional</code> - One of the BoundingBoxs to contain.</dd><dd><code>result</code> - [OutAttribute] The created BoundingBox.</dd></dl>
</li>
</ul>
<a name="equals(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>public&nbsp;boolean&nbsp;equals(java.lang.Object&nbsp;obj)</pre>
<div class="block">Determines whether two instances of BoundingBox are equal.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>obj</code> - The Object to compare with the current BoundingBox.</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if the specified Object is equal to the current BoundingBox; false otherwise.</dd></dl>
</li>
</ul>
<a name="Equals(Microsoft.Xna.Framework.BoundingBox)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Equals</h4>
<pre>public&nbsp;boolean&nbsp;Equals(<a href="../../../Microsoft/Xna/Framework/BoundingBox.html" title="class in Microsoft.Xna.Framework">BoundingBox</a>&nbsp;other)</pre>
<div class="block">Determines whether two instances of BoundingBox are equal.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../System/IEquatable.html#Equals(T)">Equals</a></code>&nbsp;in interface&nbsp;<code><a href="../../../System/IEquatable.html" title="interface in System">IEquatable</a>&lt;<a href="../../../Microsoft/Xna/Framework/BoundingBox.html" title="class in Microsoft.Xna.Framework">BoundingBox</a>&gt;</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>other</code> - The BoundingBox to compare with the current BoundingBox.</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if the specified BoundingBox is equal to the current BoundingBox; false otherwise.</dd></dl>
</li>
</ul>
<a name="GetCorners()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>GetCorners</h4>
<pre>public&nbsp;<a href="../../../Microsoft/Xna/Framework/Vector3.html" title="class in Microsoft.Xna.Framework">Vector3</a>[]&nbsp;GetCorners()</pre>
<div class="block">Gets an array of points that make up the corners of the BoundingBox.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>An array of Vector3 points that represent the corners of the BoundingBox.</dd></dl>
</li>
</ul>
<a name="GetCorners(Microsoft.Xna.Framework.Vector3[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>GetCorners</h4>
<pre>public&nbsp;void&nbsp;GetCorners(<a href="../../../Microsoft/Xna/Framework/Vector3.html" title="class in Microsoft.Xna.Framework">Vector3</a>[]&nbsp;corners)</pre>
<div class="block">Defines an axis-aligned box-shaped 3D volume.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>corners</code> - An existing array of at least 8 Vector3 points where the corners of the BoundingBox are written.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../System/ArgumentNullException.html" title="class in System">ArgumentNullException</a></code></dd>
<dd><code><a href="../../../System/ArgumentOutOfRangeException.html" title="class in System">ArgumentOutOfRangeException</a></code></dd></dl>
</li>
</ul>
<a name="hashCode()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hashCode</h4>
<pre>public&nbsp;int&nbsp;hashCode()</pre>
<div class="block">Gets the hash code for this instance.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>hashCode</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>A hash code for the current BoundingBox.</dd></dl>
</li>
</ul>
<a name="Intersects(Microsoft.Xna.Framework.BoundingBox)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Intersects</h4>
<pre>public&nbsp;boolean&nbsp;Intersects(<a href="../../../Microsoft/Xna/Framework/BoundingBox.html" title="class in Microsoft.Xna.Framework">BoundingBox</a>&nbsp;box)</pre>
<div class="block">Checks whether the current BoundingBox intersects another BoundingBox.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>box</code> - The BoundingBox to check for intersection with.</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if the BoundingBoxs intersect; false otherwise.</dd></dl>
</li>
</ul>
<a name="Intersects(Microsoft.Xna.Framework.BoundingSphere)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Intersects</h4>
<pre>public&nbsp;boolean&nbsp;Intersects(<a href="../../../Microsoft/Xna/Framework/BoundingSphere.html" title="class in Microsoft.Xna.Framework">BoundingSphere</a>&nbsp;sphere)</pre>
<div class="block">Checks whether the current BoundingBox intersects a BoundingSphere.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sphere</code> - The BoundingSphere to check for intersection with.</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if the BoundingBox and BoundingSphere intersect; false otherwise.</dd></dl>
</li>
</ul>
<a name="Intersects(Microsoft.Xna.Framework.Plane)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Intersects</h4>
<pre>public&nbsp;<a href="../../../Microsoft/Xna/Framework/PlaneIntersectionType.html" title="enum in Microsoft.Xna.Framework">PlaneIntersectionType</a>&nbsp;Intersects(<a href="../../../Microsoft/Xna/Framework/Plane.html" title="class in Microsoft.Xna.Framework">Plane</a>&nbsp;plane)</pre>
<div class="block">Checks whether the current BoundingBox intersects a Plane.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>plane</code> - The Plane to check for intersection with.</dd>
<dt><span class="strong">Returns:</span></dt><dd>An enumeration indicating whether the BoundingBox intersects the Plane.</dd></dl>
</li>
</ul>
<a name="Intersects(Microsoft.Xna.Framework.Ray)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Intersects</h4>
<pre>public&nbsp;java.lang.Float&nbsp;Intersects(<a href="../../../Microsoft/Xna/Framework/Ray.html" title="class in Microsoft.Xna.Framework">Ray</a>&nbsp;ray)</pre>
<div class="block">Checks whether the current BoundingBox intersects a Ray.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ray</code> - The Ray to check for intersection with.</dd>
<dt><span class="strong">Returns:</span></dt><dd>Distance at which the ray intersects the BoundingBox, or null if there is no intersection.</dd></dl>
</li>
</ul>
<a name="Intersects(Microsoft.Xna.Framework.BoundingBox, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Intersects</h4>
<pre>public&nbsp;void&nbsp;Intersects(<a href="../../../Microsoft/Xna/Framework/BoundingBox.html" title="class in Microsoft.Xna.Framework">BoundingBox</a>&nbsp;box,
boolean&nbsp;result)</pre>
<div class="block">Checks whether the current BoundingBox intersects another BoundingBox.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>box</code> - The BoundingBox to check for intersection with.</dd><dd><code>result</code> - [OutAttribute] true if the BoundingBox instances intersect; false otherwise.</dd></dl>
</li>
</ul>
<a name="Intersects(Microsoft.Xna.Framework.BoundingSphere, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Intersects</h4>
<pre>public&nbsp;void&nbsp;Intersects(<a href="../../../Microsoft/Xna/Framework/BoundingSphere.html" title="class in Microsoft.Xna.Framework">BoundingSphere</a>&nbsp;sphere,
boolean&nbsp;result)</pre>
<div class="block">Checks whether the current BoundingBox intersects a BoundingSphere.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sphere</code> - The BoundingSphere to check for intersection with.</dd><dd><code>result</code> - [OutAttribute] true if the BoundingBox and BoundingSphere intersect; false otherwise.</dd></dl>
</li>
</ul>
<a name="Intersects(Microsoft.Xna.Framework.Plane, Microsoft.Xna.Framework.PlaneIntersectionType)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Intersects</h4>
<pre>public&nbsp;void&nbsp;Intersects(<a href="../../../Microsoft/Xna/Framework/Plane.html" title="class in Microsoft.Xna.Framework">Plane</a>&nbsp;plane,
<a href="../../../Microsoft/Xna/Framework/PlaneIntersectionType.html" title="enum in Microsoft.Xna.Framework">PlaneIntersectionType</a>&nbsp;result)</pre>
<div class="block">Checks whether the current BoundingBox intersects a Plane.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>plane</code> - The Plane to check for intersection with.</dd><dd><code>result</code> - [OutAttribute] An enumeration indicating whether the BoundingBox intersects the Plane.</dd></dl>
</li>
</ul>
<a name="Intersects(Microsoft.Xna.Framework.Ray, java.lang.Float)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Intersects</h4>
<pre>public&nbsp;void&nbsp;Intersects(<a href="../../../Microsoft/Xna/Framework/Ray.html" title="class in Microsoft.Xna.Framework">Ray</a>&nbsp;ray,
java.lang.Float&nbsp;result)</pre>
<div class="block">Checks whether the current BoundingBox intersects a Ray.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ray</code> - The Ray to check for intersection with.</dd><dd><code>result</code> - [OutAttribute] Distance at which the ray intersects the BoundingBox, or null if there is no intersection.</dd></dl>
</li>
</ul>
<a name="toString()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
<div class="block">Returns a String that represents the current BoundingBox.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>String representation of the current BoundingBox.</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/BoundingBox.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li><a href="../../../Microsoft/Xna/Framework/BoundingSphere.html" title="class in Microsoft.Xna.Framework"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?Microsoft/Xna/Framework/BoundingBox.html" target="_top">Frames</a></li>
<li><a href="BoundingBox.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink