backup/JavaXNA
1
0
Fork 0
Code Issues Pull Requests Projects Releases Activity
JavaXNA/Microsoft.Xna.Framework/doc/Microsoft/Xna/Framework/Plane.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

784 lines
40 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:34 CEST 2013 -->
<title>Plane</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="Plane";
}
//-->
</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/Plane.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><a href="../../../Microsoft/Xna/Framework/Matrix.html" title="class in Microsoft.Xna.Framework"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../Microsoft/Xna/Framework/PlaneIntersectionType.html" title="enum in Microsoft.Xna.Framework"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?Microsoft/Xna/Framework/Plane.html" target="_top">Frames</a></li>
<li><a href="Plane.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 Plane" class="title">Class Plane</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.Plane</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/Plane.html" title="class in Microsoft.Xna.Framework">Plane</a>&gt;</dd>
</dl>
<hr>
<br>
<pre>public final class <span class="strong">Plane</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/Plane.html" title="class in Microsoft.Xna.Framework">Plane</a>&gt;</pre>
<div class="block">Defines a plane.</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>float</code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/Plane.html#D">D</a></strong></code>
<div class="block">The distance of the Plane along its normal from the origin.</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/Plane.html#Normal">Normal</a></strong></code>
<div class="block">The normal vector of the Plane.</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/Plane.html#Plane()">Plane</a></strong>()</code>
<div class="block">Creates a new instance of Plane.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../Microsoft/Xna/Framework/Plane.html#Plane(float, float, float, float)">Plane</a></strong>(float&nbsp;a,
float&nbsp;b,
float&nbsp;c,
float&nbsp;d)</code>
<div class="block">Creates a new instance of Plane.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../Microsoft/Xna/Framework/Plane.html#Plane(Microsoft.Xna.Framework.Vector3, float)">Plane</a></strong>(<a href="../../../Microsoft/Xna/Framework/Vector3.html" title="class in Microsoft.Xna.Framework">Vector3</a>&nbsp;normal,
float&nbsp;d)</code>
<div class="block">Creates a new instance of Plane.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../Microsoft/Xna/Framework/Plane.html#Plane(Microsoft.Xna.Framework.Vector3, Microsoft.Xna.Framework.Vector3, Microsoft.Xna.Framework.Vector3)">Plane</a></strong>(<a href="../../../Microsoft/Xna/Framework/Vector3.html" title="class in Microsoft.Xna.Framework">Vector3</a>&nbsp;point1,
<a href="../../../Microsoft/Xna/Framework/Vector3.html" title="class in Microsoft.Xna.Framework">Vector3</a>&nbsp;point2,
<a href="../../../Microsoft/Xna/Framework/Vector3.html" title="class in Microsoft.Xna.Framework">Vector3</a>&nbsp;point3)</code>
<div class="block">Creates a new instance of Plane.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../Microsoft/Xna/Framework/Plane.html#Plane(Microsoft.Xna.Framework.Vector4)">Plane</a></strong>(<a href="../../../Microsoft/Xna/Framework/Vector4.html" title="class in Microsoft.Xna.Framework">Vector4</a>&nbsp;value)</code>
<div class="block">Creates a new instance of Plane.</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>float</code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/Plane.html#Dot(Microsoft.Xna.Framework.Vector4)">Dot</a></strong>(<a href="../../../Microsoft/Xna/Framework/Vector4.html" title="class in Microsoft.Xna.Framework">Vector4</a>&nbsp;value)</code>
<div class="block">Calculates the dot product of a specified Vector4 and this Plane.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/Plane.html#Dot(Microsoft.Xna.Framework.Vector4, float)">Dot</a></strong>(<a href="../../../Microsoft/Xna/Framework/Vector4.html" title="class in Microsoft.Xna.Framework">Vector4</a>&nbsp;value,
float&nbsp;result)</code>
<div class="block">Calculates the dot product of a specified Vector4 and this Plane.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/Plane.html#DotCoordinate(Microsoft.Xna.Framework.Vector3)">DotCoordinate</a></strong>(<a href="../../../Microsoft/Xna/Framework/Vector3.html" title="class in Microsoft.Xna.Framework">Vector3</a>&nbsp;value)</code>
<div class="block">Returns the dot product of a specified Vector3 and the Normal vector of this Plane plus the distance (D) value of the Plane.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/Plane.html#DotCoordinate(Microsoft.Xna.Framework.Vector3, float)">DotCoordinate</a></strong>(<a href="../../../Microsoft/Xna/Framework/Vector3.html" title="class in Microsoft.Xna.Framework">Vector3</a>&nbsp;value,
float&nbsp;result)</code>
<div class="block">Returns the dot product of a specified Vector3 and the Normal vector of this Plane plus the distance (D) value of the Plane.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/Plane.html#DotNormal(Microsoft.Xna.Framework.Vector3)">DotNormal</a></strong>(<a href="../../../Microsoft/Xna/Framework/Vector3.html" title="class in Microsoft.Xna.Framework">Vector3</a>&nbsp;value)</code>
<div class="block">Returns the dot product of a specified Vector3 and the Normal vector of this Plane.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/Plane.html#DotNormal(Microsoft.Xna.Framework.Vector3, float)">DotNormal</a></strong>(<a href="../../../Microsoft/Xna/Framework/Vector3.html" title="class in Microsoft.Xna.Framework">Vector3</a>&nbsp;value,
float&nbsp;result)</code>
<div class="block">Returns the dot product of a specified Vector3 and the Normal vector of this Plane.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/Plane.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object&nbsp;obj)</code>
<div class="block">Determines whether the specified Object is equal to the Plane.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/Plane.html#Equals(Microsoft.Xna.Framework.Plane)">Equals</a></strong>(<a href="../../../Microsoft/Xna/Framework/Plane.html" title="class in Microsoft.Xna.Framework">Plane</a>&nbsp;other)</code>
<div class="block">Determines whether the specified Plane is equal to the Plane.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/Plane.html#hashCode()">hashCode</a></strong>()</code>
<div class="block">Gets the hash code for this object.</div>
</td>
</tr>
<tr class="rowColor">
<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/Plane.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 Plane intersects a specified BoundingBox.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/Plane.html#Intersects(Microsoft.Xna.Framework.BoundingBox, Microsoft.Xna.Framework.PlaneIntersectionType)">Intersects</a></strong>(<a href="../../../Microsoft/Xna/Framework/BoundingBox.html" title="class in Microsoft.Xna.Framework">BoundingBox</a>&nbsp;box,
<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 Plane intersects a BoundingBox.</div>
</td>
</tr>
<tr class="rowColor">
<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/Plane.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 Plane intersects a specified BoundingSphere.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/Plane.html#Intersects(Microsoft.Xna.Framework.BoundingSphere, Microsoft.Xna.Framework.PlaneIntersectionType)">Intersects</a></strong>(<a href="../../../Microsoft/Xna/Framework/BoundingSphere.html" title="class in Microsoft.Xna.Framework">BoundingSphere</a>&nbsp;sphere,
<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 Plane 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/Plane.html#Normalize()">Normalize</a></strong>()</code>
<div class="block">Changes the coefficients of the Normal vector of this Plane to make it of unit length.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../Microsoft/Xna/Framework/Plane.html" title="class in Microsoft.Xna.Framework">Plane</a></code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/Plane.html#Normalize(Microsoft.Xna.Framework.Plane)">Normalize</a></strong>(<a href="../../../Microsoft/Xna/Framework/Plane.html" title="class in Microsoft.Xna.Framework">Plane</a>&nbsp;value)</code>
<div class="block">Changes the coefficients of the Normal vector of a Plane to make it of unit length.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/Plane.html#Normalize(Microsoft.Xna.Framework.Plane, Microsoft.Xna.Framework.Plane)">Normalize</a></strong>(<a href="../../../Microsoft/Xna/Framework/Plane.html" title="class in Microsoft.Xna.Framework">Plane</a>&nbsp;value,
<a href="../../../Microsoft/Xna/Framework/Plane.html" title="class in Microsoft.Xna.Framework">Plane</a>&nbsp;result)</code>
<div class="block">Changes the coefficients of the Normal vector of a Plane to make it of unit length.</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/Plane.html#toString()">toString</a></strong>()</code>
<div class="block">Returns a String that represents the current Plane.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../Microsoft/Xna/Framework/Plane.html" title="class in Microsoft.Xna.Framework">Plane</a></code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/Plane.html#Transform(Microsoft.Xna.Framework.Plane, Microsoft.Xna.Framework.Matrix)">Transform</a></strong>(<a href="../../../Microsoft/Xna/Framework/Plane.html" title="class in Microsoft.Xna.Framework">Plane</a>&nbsp;plane,
<a href="../../../Microsoft/Xna/Framework/Matrix.html" title="class in Microsoft.Xna.Framework">Matrix</a>&nbsp;matrix)</code>
<div class="block">Transforms a normalized Plane by a Matrix.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/Plane.html#Transform(Microsoft.Xna.Framework.Plane, Microsoft.Xna.Framework.Matrix, Microsoft.Xna.Framework.Plane)">Transform</a></strong>(<a href="../../../Microsoft/Xna/Framework/Plane.html" title="class in Microsoft.Xna.Framework">Plane</a>&nbsp;plane,
<a href="../../../Microsoft/Xna/Framework/Matrix.html" title="class in Microsoft.Xna.Framework">Matrix</a>&nbsp;matrix,
<a href="../../../Microsoft/Xna/Framework/Plane.html" title="class in Microsoft.Xna.Framework">Plane</a>&nbsp;result)</code>
<div class="block">Transforms a normalized Plane by a Matrix.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../Microsoft/Xna/Framework/Plane.html" title="class in Microsoft.Xna.Framework">Plane</a></code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/Plane.html#Transform(Microsoft.Xna.Framework.Plane, Microsoft.Xna.Framework.Quaternion)">Transform</a></strong>(<a href="../../../Microsoft/Xna/Framework/Plane.html" title="class in Microsoft.Xna.Framework">Plane</a>&nbsp;plane,
<a href="../../../Microsoft/Xna/Framework/Quaternion.html" title="class in Microsoft.Xna.Framework">Quaternion</a>&nbsp;rotation)</code>
<div class="block">Transforms a normalized Plane by a Quaternion rotation.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/Plane.html#Transform(Microsoft.Xna.Framework.Plane, Microsoft.Xna.Framework.Quaternion, Microsoft.Xna.Framework.Plane)">Transform</a></strong>(<a href="../../../Microsoft/Xna/Framework/Plane.html" title="class in Microsoft.Xna.Framework">Plane</a>&nbsp;plane,
<a href="../../../Microsoft/Xna/Framework/Quaternion.html" title="class in Microsoft.Xna.Framework">Quaternion</a>&nbsp;rotation,
<a href="../../../Microsoft/Xna/Framework/Plane.html" title="class in Microsoft.Xna.Framework">Plane</a>&nbsp;result)</code>
<div class="block">Transforms a normalized Plane by a Quaternion rotation.</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="Normal">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Normal</h4>
<pre>public&nbsp;<a href="../../../Microsoft/Xna/Framework/Vector3.html" title="class in Microsoft.Xna.Framework">Vector3</a> Normal</pre>
<div class="block">The normal vector of the Plane.</div>
</li>
</ul>
<a name="D">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>D</h4>
<pre>public&nbsp;float D</pre>
<div class="block">The distance of the Plane along its normal from the origin.</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Plane(float, float, float, float)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Plane</h4>
<pre>public&nbsp;Plane(float&nbsp;a,
float&nbsp;b,
float&nbsp;c,
float&nbsp;d)</pre>
<div class="block">Creates a new instance of Plane.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>a</code> - X component of the normal defining the Plane.</dd><dd><code>b</code> - Y component of the normal defining the Plane.</dd><dd><code>c</code> - Z component of the normal defining the Plane.</dd><dd><code>d</code> - Distance of the Plane along its normal from the origin.</dd></dl>
</li>
</ul>
<a name="Plane(Microsoft.Xna.Framework.Vector3, float)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Plane</h4>
<pre>public&nbsp;Plane(<a href="../../../Microsoft/Xna/Framework/Vector3.html" title="class in Microsoft.Xna.Framework">Vector3</a>&nbsp;normal,
float&nbsp;d)</pre>
<div class="block">Creates a new instance of Plane.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>normal</code> - The normal vector to the Plane.</dd><dd><code>d</code> - The Plane's distance along its normal from the origin.</dd></dl>
</li>
</ul>
<a name="Plane(Microsoft.Xna.Framework.Vector4)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Plane</h4>
<pre>public&nbsp;Plane(<a href="../../../Microsoft/Xna/Framework/Vector4.html" title="class in Microsoft.Xna.Framework">Vector4</a>&nbsp;value)</pre>
<div class="block">Creates a new instance of Plane.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - Vector4 with X, Y, and Z components defining the normal of the Plane. The W component defines the distance of the Plane along the normal from the origin.</dd></dl>
</li>
</ul>
<a name="Plane(Microsoft.Xna.Framework.Vector3, Microsoft.Xna.Framework.Vector3, Microsoft.Xna.Framework.Vector3)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Plane</h4>
<pre>public&nbsp;Plane(<a href="../../../Microsoft/Xna/Framework/Vector3.html" title="class in Microsoft.Xna.Framework">Vector3</a>&nbsp;point1,
<a href="../../../Microsoft/Xna/Framework/Vector3.html" title="class in Microsoft.Xna.Framework">Vector3</a>&nbsp;point2,
<a href="../../../Microsoft/Xna/Framework/Vector3.html" title="class in Microsoft.Xna.Framework">Vector3</a>&nbsp;point3)</pre>
<div class="block">Creates a new instance of Plane.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>point1</code> - One point of a triangle defining the Plane.</dd><dd><code>point2</code> - One point of a triangle defining the Plane.</dd><dd><code>point3</code> - One point of a triangle defining the Plane.</dd></dl>
</li>
</ul>
<a name="Plane()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Plane</h4>
<pre>public&nbsp;Plane()</pre>
<div class="block">Creates a new instance of Plane.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="Dot(Microsoft.Xna.Framework.Vector4)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Dot</h4>
<pre>public&nbsp;float&nbsp;Dot(<a href="../../../Microsoft/Xna/Framework/Vector4.html" title="class in Microsoft.Xna.Framework">Vector4</a>&nbsp;value)</pre>
<div class="block">Calculates the dot product of a specified Vector4 and this Plane.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - The Vector4 to multiply this Plane by.</dd></dl>
</li>
</ul>
<a name="Dot(Microsoft.Xna.Framework.Vector4, float)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Dot</h4>
<pre>public&nbsp;void&nbsp;Dot(<a href="../../../Microsoft/Xna/Framework/Vector4.html" title="class in Microsoft.Xna.Framework">Vector4</a>&nbsp;value,
float&nbsp;result)</pre>
<div class="block">Calculates the dot product of a specified Vector4 and this Plane.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - The Vector4 to multiply this Plane by.</dd><dd><code>result</code> - [OutAttribute] The dot product of the specified Vector4 and this Plane.</dd></dl>
</li>
</ul>
<a name="DotCoordinate(Microsoft.Xna.Framework.Vector3)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DotCoordinate</h4>
<pre>public&nbsp;float&nbsp;DotCoordinate(<a href="../../../Microsoft/Xna/Framework/Vector3.html" title="class in Microsoft.Xna.Framework">Vector3</a>&nbsp;value)</pre>
<div class="block">Returns the dot product of a specified Vector3 and the Normal vector of this Plane plus the distance (D) value of the Plane.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - The Vector3 to multiply by.</dd></dl>
</li>
</ul>
<a name="DotCoordinate(Microsoft.Xna.Framework.Vector3, float)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DotCoordinate</h4>
<pre>public&nbsp;void&nbsp;DotCoordinate(<a href="../../../Microsoft/Xna/Framework/Vector3.html" title="class in Microsoft.Xna.Framework">Vector3</a>&nbsp;value,
float&nbsp;result)</pre>
<div class="block">Returns the dot product of a specified Vector3 and the Normal vector of this Plane plus the distance (D) value of the Plane.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - The Vector3 to multiply by.</dd><dd><code>result</code> - [OutAttribute] The resulting value.</dd></dl>
</li>
</ul>
<a name="DotNormal(Microsoft.Xna.Framework.Vector3)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DotNormal</h4>
<pre>public&nbsp;float&nbsp;DotNormal(<a href="../../../Microsoft/Xna/Framework/Vector3.html" title="class in Microsoft.Xna.Framework">Vector3</a>&nbsp;value)</pre>
<div class="block">Returns the dot product of a specified Vector3 and the Normal vector of this Plane.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - The Vector3 to multiply by.</dd></dl>
</li>
</ul>
<a name="DotNormal(Microsoft.Xna.Framework.Vector3, float)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DotNormal</h4>
<pre>public&nbsp;void&nbsp;DotNormal(<a href="../../../Microsoft/Xna/Framework/Vector3.html" title="class in Microsoft.Xna.Framework">Vector3</a>&nbsp;value,
float&nbsp;result)</pre>
<div class="block">Returns the dot product of a specified Vector3 and the Normal vector of this Plane.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - The Vector3 to multiply by.</dd><dd><code>result</code> - [OutAttribute] The resulting dot product.</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 the specified Object is equal to the Plane.</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 Plane.</dd></dl>
</li>
</ul>
<a name="Equals(Microsoft.Xna.Framework.Plane)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Equals</h4>
<pre>public&nbsp;boolean&nbsp;Equals(<a href="../../../Microsoft/Xna/Framework/Plane.html" title="class in Microsoft.Xna.Framework">Plane</a>&nbsp;other)</pre>
<div class="block">Determines whether the specified Plane is equal to the Plane.</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/Plane.html" title="class in Microsoft.Xna.Framework">Plane</a>&gt;</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>other</code> - The Plane to compare with the current Plane.</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if the current object is equal to the other parameter; otherwise, false.</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 object.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>hashCode</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a name="Intersects(Microsoft.Xna.Framework.BoundingBox)">
<!-- -->
</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/BoundingBox.html" title="class in Microsoft.Xna.Framework">BoundingBox</a>&nbsp;box)</pre>
<div class="block">Checks whether the current Plane intersects a specified BoundingBox.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>box</code> - The BoundingBox to test for intersection with.</dd></dl>
</li>
</ul>
<a name="Intersects(Microsoft.Xna.Framework.BoundingSphere)">
<!-- -->
</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/BoundingSphere.html" title="class in Microsoft.Xna.Framework">BoundingSphere</a>&nbsp;sphere)</pre>
<div class="block">Checks whether the current Plane intersects a specified BoundingSphere.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sphere</code> - The BoundingSphere to check for intersection with.</dd></dl>
</li>
</ul>
<a name="Intersects(Microsoft.Xna.Framework.BoundingBox, 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/BoundingBox.html" title="class in Microsoft.Xna.Framework">BoundingBox</a>&nbsp;box,
<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 Plane intersects a 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] An enumeration indicating whether the Plane intersects the BoundingBox.</dd></dl>
</li>
</ul>
<a name="Intersects(Microsoft.Xna.Framework.BoundingSphere, 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/BoundingSphere.html" title="class in Microsoft.Xna.Framework">BoundingSphere</a>&nbsp;sphere,
<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 Plane 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] An enumeration indicating whether the Plane intersects the BoundingSphere.</dd></dl>
</li>
</ul>
<a name="Normalize()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Normalize</h4>
<pre>public&nbsp;void&nbsp;Normalize()</pre>
<div class="block">Changes the coefficients of the Normal vector of this Plane to make it of unit length.</div>
</li>
</ul>
<a name="Normalize(Microsoft.Xna.Framework.Plane)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Normalize</h4>
<pre>public static&nbsp;<a href="../../../Microsoft/Xna/Framework/Plane.html" title="class in Microsoft.Xna.Framework">Plane</a>&nbsp;Normalize(<a href="../../../Microsoft/Xna/Framework/Plane.html" title="class in Microsoft.Xna.Framework">Plane</a>&nbsp;value)</pre>
<div class="block">Changes the coefficients of the Normal vector of a Plane to make it of unit length.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - The Plane to normalize.</dd></dl>
</li>
</ul>
<a name="Normalize(Microsoft.Xna.Framework.Plane, Microsoft.Xna.Framework.Plane)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Normalize</h4>
<pre>public static&nbsp;void&nbsp;Normalize(<a href="../../../Microsoft/Xna/Framework/Plane.html" title="class in Microsoft.Xna.Framework">Plane</a>&nbsp;value,
<a href="../../../Microsoft/Xna/Framework/Plane.html" title="class in Microsoft.Xna.Framework">Plane</a>&nbsp;result)</pre>
<div class="block">Changes the coefficients of the Normal vector of a Plane to make it of unit length.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - The Plane to normalize.</dd><dd><code>result</code> - [OutAttribute] An existing plane Plane filled in with a normalized version of the specified plane.</dd></dl>
</li>
</ul>
<a name="toString()">
<!-- -->
</a>
<ul class="blockList">
<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 Plane.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a name="Transform(Microsoft.Xna.Framework.Plane, Microsoft.Xna.Framework.Matrix)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Transform</h4>
<pre>public static&nbsp;<a href="../../../Microsoft/Xna/Framework/Plane.html" title="class in Microsoft.Xna.Framework">Plane</a>&nbsp;Transform(<a href="../../../Microsoft/Xna/Framework/Plane.html" title="class in Microsoft.Xna.Framework">Plane</a>&nbsp;plane,
<a href="../../../Microsoft/Xna/Framework/Matrix.html" title="class in Microsoft.Xna.Framework">Matrix</a>&nbsp;matrix)</pre>
<div class="block">Transforms a normalized Plane by a Matrix.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>plane</code> - The normalized Plane to transform. This Plane must already be normalized, so that its Normal vector is of unit length, before this method is called.</dd><dd><code>matrix</code> - The transform Matrix to apply to the Plane.</dd></dl>
</li>
</ul>
<a name="Transform(Microsoft.Xna.Framework.Plane, Microsoft.Xna.Framework.Quaternion)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Transform</h4>
<pre>public static&nbsp;<a href="../../../Microsoft/Xna/Framework/Plane.html" title="class in Microsoft.Xna.Framework">Plane</a>&nbsp;Transform(<a href="../../../Microsoft/Xna/Framework/Plane.html" title="class in Microsoft.Xna.Framework">Plane</a>&nbsp;plane,
<a href="../../../Microsoft/Xna/Framework/Quaternion.html" title="class in Microsoft.Xna.Framework">Quaternion</a>&nbsp;rotation)</pre>
<div class="block">Transforms a normalized Plane by a Quaternion rotation.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>plane</code> - The normalized Plane to transform. This Plane must already be normalized, so that its Normal vector is of unit length, before this method is called.</dd><dd><code>rotation</code> - The Quaternion rotation to apply to the Plane.</dd></dl>
</li>
</ul>
<a name="Transform(Microsoft.Xna.Framework.Plane, Microsoft.Xna.Framework.Matrix, Microsoft.Xna.Framework.Plane)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Transform</h4>
<pre>public static&nbsp;void&nbsp;Transform(<a href="../../../Microsoft/Xna/Framework/Plane.html" title="class in Microsoft.Xna.Framework">Plane</a>&nbsp;plane,
<a href="../../../Microsoft/Xna/Framework/Matrix.html" title="class in Microsoft.Xna.Framework">Matrix</a>&nbsp;matrix,
<a href="../../../Microsoft/Xna/Framework/Plane.html" title="class in Microsoft.Xna.Framework">Plane</a>&nbsp;result)</pre>
<div class="block">Transforms a normalized Plane by a Matrix.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>plane</code> - The normalized Plane to transform. This Plane must already be normalized, so that its Normal vector is of unit length, before this method is called.</dd><dd><code>matrix</code> - The transform Matrix to apply to the Plane.</dd><dd><code>result</code> - [OutAttribute] An existing Plane filled in with the results of applying the transform.</dd></dl>
</li>
</ul>
<a name="Transform(Microsoft.Xna.Framework.Plane, Microsoft.Xna.Framework.Quaternion, Microsoft.Xna.Framework.Plane)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Transform</h4>
<pre>public static&nbsp;void&nbsp;Transform(<a href="../../../Microsoft/Xna/Framework/Plane.html" title="class in Microsoft.Xna.Framework">Plane</a>&nbsp;plane,
<a href="../../../Microsoft/Xna/Framework/Quaternion.html" title="class in Microsoft.Xna.Framework">Quaternion</a>&nbsp;rotation,
<a href="../../../Microsoft/Xna/Framework/Plane.html" title="class in Microsoft.Xna.Framework">Plane</a>&nbsp;result)</pre>
<div class="block">Transforms a normalized Plane by a Quaternion rotation.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>plane</code> - The normalized Plane to transform. This Plane must already be normalized, so that its Normal vector is of unit length, before this method is called.</dd><dd><code>rotation</code> - The Quaternion rotation to apply to the Plane.</dd><dd><code>result</code> - [OutAttribute] An existing Plane filled in with the results of applying the rotation.</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/Plane.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><a href="../../../Microsoft/Xna/Framework/Matrix.html" title="class in Microsoft.Xna.Framework"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../Microsoft/Xna/Framework/PlaneIntersectionType.html" title="enum in Microsoft.Xna.Framework"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?Microsoft/Xna/Framework/Plane.html" target="_top">Frames</a></li>
<li><a href="Plane.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