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

855 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:34 CEST 2013 -->
<title>Rectangle</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="Rectangle";
}
//-->
</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/Rectangle.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/Ray.html" title="class in Microsoft.Xna.Framework"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../Microsoft/Xna/Framework/TitleContainer.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/Rectangle.html" target="_top">Frames</a></li>
<li><a href="Rectangle.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 Rectangle" class="title">Class Rectangle</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.Rectangle</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/Rectangle.html" title="class in Microsoft.Xna.Framework">Rectangle</a>&gt;</dd>
</dl>
<hr>
<br>
<pre>public final class <span class="strong">Rectangle</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/Rectangle.html" title="class in Microsoft.Xna.Framework">Rectangle</a>&gt;</pre>
<div class="block">Defines a rectangle.</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>static <a href="../../../Microsoft/Xna/Framework/Rectangle.html" title="class in Microsoft.Xna.Framework">Rectangle</a></code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/Rectangle.html#Empty">Empty</a></strong></code>
<div class="block">Returns a Rectangle with all of its values set to zero.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/Rectangle.html#Height">Height</a></strong></code>
<div class="block">Specifies the height of the rectangle.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/Rectangle.html#Width">Width</a></strong></code>
<div class="block">Specifies the width of the rectangle.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/Rectangle.html#X">X</a></strong></code>
<div class="block">Specifies the x-coordinate of the rectangle.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/Rectangle.html#Y">Y</a></strong></code>
<div class="block">Specifies the y-coordinate of the rectangle.</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/Rectangle.html#Rectangle()">Rectangle</a></strong>()</code>
<div class="block">Initializes a new instance of Rectangle.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../Microsoft/Xna/Framework/Rectangle.html#Rectangle(int, int, int, int)">Rectangle</a></strong>(int&nbsp;x,
int&nbsp;y,
int&nbsp;width,
int&nbsp;height)</code>
<div class="block">Initializes a new instance of Rectangle.</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>int</code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/Rectangle.html#Bottom()">Bottom</a></strong>()</code>
<div class="block">Returns the y-coordinate of the bottom of the rectangle.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../Microsoft/Xna/Framework/Point.html" title="class in Microsoft.Xna.Framework">Point</a></code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/Rectangle.html#Center()">Center</a></strong>()</code>
<div class="block">Gets the Point that specifies the center of the rectangle.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/Rectangle.html#Contains(int, int)">Contains</a></strong>(int&nbsp;x,
int&nbsp;y)</code>
<div class="block">Determines whether this Rectangle contains a specified point represented by its x- and y-coordinates.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/Rectangle.html#Contains(Microsoft.Xna.Framework.Point)">Contains</a></strong>(<a href="../../../Microsoft/Xna/Framework/Point.html" title="class in Microsoft.Xna.Framework">Point</a>&nbsp;value)</code>
<div class="block">Determines whether this Rectangle contains a specified Point.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/Rectangle.html#Contains(Microsoft.Xna.Framework.Point, boolean)">Contains</a></strong>(<a href="../../../Microsoft/Xna/Framework/Point.html" title="class in Microsoft.Xna.Framework">Point</a>&nbsp;value,
boolean&nbsp;result)</code>
<div class="block">Determines whether this Rectangle contains a specified Point.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/Rectangle.html#Contains(Microsoft.Xna.Framework.Rectangle)">Contains</a></strong>(<a href="../../../Microsoft/Xna/Framework/Rectangle.html" title="class in Microsoft.Xna.Framework">Rectangle</a>&nbsp;value)</code>
<div class="block">Determines whether this Rectangle entirely contains a specified Rectangle.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/Rectangle.html#Contains(Microsoft.Xna.Framework.Rectangle, boolean)">Contains</a></strong>(<a href="../../../Microsoft/Xna/Framework/Rectangle.html" title="class in Microsoft.Xna.Framework">Rectangle</a>&nbsp;value,
boolean&nbsp;result)</code>
<div class="block">Determines whether this Rectangle entirely contains a specified Rectangle.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/Rectangle.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 current instance.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/Rectangle.html#Equals(Microsoft.Xna.Framework.Rectangle)">Equals</a></strong>(<a href="../../../Microsoft/Xna/Framework/Rectangle.html" title="class in Microsoft.Xna.Framework">Rectangle</a>&nbsp;other)</code>
<div class="block">Determines whether the specified Object is equal to the Rectangle.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/Rectangle.html#GetHashCode()">GetHashCode</a></strong>()</code>
<div class="block">Gets the hash code for this object.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../Microsoft/Xna/Framework/Point.html" title="class in Microsoft.Xna.Framework">Point</a></code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/Rectangle.html#getLocation()">getLocation</a></strong>()</code>
<div class="block">Gets the upper-left value of the Rectangle.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/Rectangle.html#Inflate(int, int)">Inflate</a></strong>(int&nbsp;horizontalAmount,
int&nbsp;verticalAmount)</code>
<div class="block">Pushes the edges of the Rectangle out by the horizontal and vertical values specified.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../Microsoft/Xna/Framework/Rectangle.html" title="class in Microsoft.Xna.Framework">Rectangle</a></code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/Rectangle.html#Intersect(Microsoft.Xna.Framework.Rectangle, Microsoft.Xna.Framework.Rectangle)">Intersect</a></strong>(<a href="../../../Microsoft/Xna/Framework/Rectangle.html" title="class in Microsoft.Xna.Framework">Rectangle</a>&nbsp;value1,
<a href="../../../Microsoft/Xna/Framework/Rectangle.html" title="class in Microsoft.Xna.Framework">Rectangle</a>&nbsp;value2)</code>
<div class="block">Creates a Rectangle defining the area where one rectangle overlaps with another rectangle.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/Rectangle.html#Intersect(Microsoft.Xna.Framework.Rectangle, Microsoft.Xna.Framework.Rectangle, Microsoft.Xna.Framework.Rectangle)">Intersect</a></strong>(<a href="../../../Microsoft/Xna/Framework/Rectangle.html" title="class in Microsoft.Xna.Framework">Rectangle</a>&nbsp;value1,
<a href="../../../Microsoft/Xna/Framework/Rectangle.html" title="class in Microsoft.Xna.Framework">Rectangle</a>&nbsp;value2,
<a href="../../../Microsoft/Xna/Framework/Rectangle.html" title="class in Microsoft.Xna.Framework">Rectangle</a>&nbsp;result)</code>
<div class="block">Creates a Rectangle defining the area where one rectangle overlaps with another rectangle.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/Rectangle.html#Intersects(Microsoft.Xna.Framework.Rectangle)">Intersects</a></strong>(<a href="../../../Microsoft/Xna/Framework/Rectangle.html" title="class in Microsoft.Xna.Framework">Rectangle</a>&nbsp;value)</code>
<div class="block">Determines whether a specified Rectangle intersects with this Rectangle.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/Rectangle.html#Intersects(Microsoft.Xna.Framework.Rectangle, boolean)">Intersects</a></strong>(<a href="../../../Microsoft/Xna/Framework/Rectangle.html" title="class in Microsoft.Xna.Framework">Rectangle</a>&nbsp;value,
boolean&nbsp;result)</code>
<div class="block">Determines whether a specified Rectangle intersects with this Rectangle.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/Rectangle.html#IsEmpty()">IsEmpty</a></strong>()</code>
<div class="block">Gets a value that indicates whether the Rectangle is empty.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/Rectangle.html#Left()">Left</a></strong>()</code>
<div class="block">Returns the x-coordinate of the left side of the rectangle.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/Rectangle.html#Offset(int, int)">Offset</a></strong>(int&nbsp;offsetX,
int&nbsp;offsetY)</code>
<div class="block">Changes the position of the Rectangle.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/Rectangle.html#Offset(Microsoft.Xna.Framework.Point)">Offset</a></strong>(<a href="../../../Microsoft/Xna/Framework/Point.html" title="class in Microsoft.Xna.Framework">Point</a>&nbsp;amount)</code>
<div class="block">Changes the position of the Rectangle.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/Rectangle.html#Right()">Right</a></strong>()</code>
<div class="block">Returns the x-coordinate of the right side of the rectangle.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/Rectangle.html#setLocation(Microsoft.Xna.Framework.Point)">setLocation</a></strong>(<a href="../../../Microsoft/Xna/Framework/Point.html" title="class in Microsoft.Xna.Framework">Point</a>&nbsp;newLocation)</code>
<div class="block">Sets the upper-left value of the Rectangle.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/Rectangle.html#Top()">Top</a></strong>()</code>
<div class="block">Returns the y-coordinate of the top of the rectangle.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/Rectangle.html#toString()">toString</a></strong>()</code>
<div class="block">Retrieves a string representation of the current object.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../Microsoft/Xna/Framework/Rectangle.html" title="class in Microsoft.Xna.Framework">Rectangle</a></code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/Rectangle.html#Union(Microsoft.Xna.Framework.Rectangle, Microsoft.Xna.Framework.Rectangle)">Union</a></strong>(<a href="../../../Microsoft/Xna/Framework/Rectangle.html" title="class in Microsoft.Xna.Framework">Rectangle</a>&nbsp;value1,
<a href="../../../Microsoft/Xna/Framework/Rectangle.html" title="class in Microsoft.Xna.Framework">Rectangle</a>&nbsp;value2)</code>
<div class="block">Creates a new Rectangle that exactly contains two other rectangles.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/Rectangle.html#Union(Microsoft.Xna.Framework.Rectangle, Microsoft.Xna.Framework.Rectangle, Microsoft.Xna.Framework.Rectangle)">Union</a></strong>(<a href="../../../Microsoft/Xna/Framework/Rectangle.html" title="class in Microsoft.Xna.Framework">Rectangle</a>&nbsp;value1,
<a href="../../../Microsoft/Xna/Framework/Rectangle.html" title="class in Microsoft.Xna.Framework">Rectangle</a>&nbsp;value2,
<a href="../../../Microsoft/Xna/Framework/Rectangle.html" title="class in Microsoft.Xna.Framework">Rectangle</a>&nbsp;result)</code>
<div class="block">Creates a new Rectangle that exactly contains two other rectangles.</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, hashCode, 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="Empty">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Empty</h4>
<pre>public static final&nbsp;<a href="../../../Microsoft/Xna/Framework/Rectangle.html" title="class in Microsoft.Xna.Framework">Rectangle</a> Empty</pre>
<div class="block">Returns a Rectangle with all of its values set to zero.</div>
</li>
</ul>
<a name="Height">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Height</h4>
<pre>public&nbsp;int Height</pre>
<div class="block">Specifies the height of the rectangle.</div>
</li>
</ul>
<a name="Width">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Width</h4>
<pre>public&nbsp;int Width</pre>
<div class="block">Specifies the width of the rectangle.</div>
</li>
</ul>
<a name="X">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>X</h4>
<pre>public&nbsp;int X</pre>
<div class="block">Specifies the x-coordinate of the rectangle.</div>
</li>
</ul>
<a name="Y">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Y</h4>
<pre>public&nbsp;int Y</pre>
<div class="block">Specifies the y-coordinate of the rectangle.</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Rectangle(int, int, int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Rectangle</h4>
<pre>public&nbsp;Rectangle(int&nbsp;x,
int&nbsp;y,
int&nbsp;width,
int&nbsp;height)</pre>
<div class="block">Initializes a new instance of Rectangle.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>x</code> - The x-coordinate of the rectangle.</dd><dd><code>y</code> - The y-coordinate of the rectangle.</dd><dd><code>width</code> - Width of the rectangle.</dd><dd><code>height</code> - Height of the rectangle.</dd></dl>
</li>
</ul>
<a name="Rectangle()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Rectangle</h4>
<pre>public&nbsp;Rectangle()</pre>
<div class="block">Initializes a new instance of Rectangle.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="Bottom()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Bottom</h4>
<pre>public&nbsp;int&nbsp;Bottom()</pre>
<div class="block">Returns the y-coordinate of the bottom of the rectangle.</div>
</li>
</ul>
<a name="Center()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Center</h4>
<pre>public&nbsp;<a href="../../../Microsoft/Xna/Framework/Point.html" title="class in Microsoft.Xna.Framework">Point</a>&nbsp;Center()</pre>
<div class="block">Gets the Point that specifies the center of the rectangle.</div>
</li>
</ul>
<a name="IsEmpty()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>IsEmpty</h4>
<pre>public&nbsp;boolean&nbsp;IsEmpty()</pre>
<div class="block">Gets a value that indicates whether the Rectangle is empty.</div>
</li>
</ul>
<a name="Left()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Left</h4>
<pre>public&nbsp;int&nbsp;Left()</pre>
<div class="block">Returns the x-coordinate of the left side of the rectangle.</div>
</li>
</ul>
<a name="getLocation()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLocation</h4>
<pre>public&nbsp;<a href="../../../Microsoft/Xna/Framework/Point.html" title="class in Microsoft.Xna.Framework">Point</a>&nbsp;getLocation()</pre>
<div class="block">Gets the upper-left value of the Rectangle.</div>
</li>
</ul>
<a name="setLocation(Microsoft.Xna.Framework.Point)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLocation</h4>
<pre>public&nbsp;void&nbsp;setLocation(<a href="../../../Microsoft/Xna/Framework/Point.html" title="class in Microsoft.Xna.Framework">Point</a>&nbsp;newLocation)</pre>
<div class="block">Sets the upper-left value of the Rectangle.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>newLocation</code> - The new location of the upper-left value of the Rectangle.</dd></dl>
</li>
</ul>
<a name="Right()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Right</h4>
<pre>public&nbsp;int&nbsp;Right()</pre>
<div class="block">Returns the x-coordinate of the right side of the rectangle.</div>
</li>
</ul>
<a name="Top()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Top</h4>
<pre>public&nbsp;int&nbsp;Top()</pre>
<div class="block">Returns the y-coordinate of the top of the rectangle.</div>
</li>
</ul>
<a name="Contains(Microsoft.Xna.Framework.Point)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Contains</h4>
<pre>public&nbsp;boolean&nbsp;Contains(<a href="../../../Microsoft/Xna/Framework/Point.html" title="class in Microsoft.Xna.Framework">Point</a>&nbsp;value)</pre>
<div class="block">Determines whether this Rectangle contains a specified Point.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - The Point to evaluate.</dd></dl>
</li>
</ul>
<a name="Contains(Microsoft.Xna.Framework.Rectangle)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Contains</h4>
<pre>public&nbsp;boolean&nbsp;Contains(<a href="../../../Microsoft/Xna/Framework/Rectangle.html" title="class in Microsoft.Xna.Framework">Rectangle</a>&nbsp;value)</pre>
<div class="block">Determines whether this Rectangle entirely contains a specified Rectangle.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - The Rectangle to evaluate.</dd></dl>
</li>
</ul>
<a name="Contains(Microsoft.Xna.Framework.Rectangle, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Contains</h4>
<pre>public&nbsp;void&nbsp;Contains(<a href="../../../Microsoft/Xna/Framework/Rectangle.html" title="class in Microsoft.Xna.Framework">Rectangle</a>&nbsp;value,
boolean&nbsp;result)</pre>
<div class="block">Determines whether this Rectangle entirely contains a specified Rectangle.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - The Rectangle to evaluate.</dd><dd><code>result</code> - [OutAttribute] On exit, is true if this Rectangle entirely contains the specified Rectangle, or false if not.</dd></dl>
</li>
</ul>
<a name="Contains(int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Contains</h4>
<pre>public&nbsp;boolean&nbsp;Contains(int&nbsp;x,
int&nbsp;y)</pre>
<div class="block">Determines whether this Rectangle contains a specified point represented by its x- and y-coordinates.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>x</code> - The x-coordinate of the specified point.</dd><dd><code>y</code> - The y-coordinate of the specified point.</dd></dl>
</li>
</ul>
<a name="Contains(Microsoft.Xna.Framework.Point, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Contains</h4>
<pre>public&nbsp;void&nbsp;Contains(<a href="../../../Microsoft/Xna/Framework/Point.html" title="class in Microsoft.Xna.Framework">Point</a>&nbsp;value,
boolean&nbsp;result)</pre>
<div class="block">Determines whether this Rectangle contains a specified Point.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - The Point to evaluate.</dd><dd><code>result</code> - [OutAttribute] true if the specified Point is contained within this Rectangle; false otherwise.</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 current instance.</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 Ray.</dd></dl>
</li>
</ul>
<a name="Equals(Microsoft.Xna.Framework.Rectangle)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Equals</h4>
<pre>public&nbsp;boolean&nbsp;Equals(<a href="../../../Microsoft/Xna/Framework/Rectangle.html" title="class in Microsoft.Xna.Framework">Rectangle</a>&nbsp;other)</pre>
<div class="block">Determines whether the specified Object is equal to the Rectangle.</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/Rectangle.html" title="class in Microsoft.Xna.Framework">Rectangle</a>&gt;</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>other</code> - The Object to compare with the current Rectangle.</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="GetHashCode()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>GetHashCode</h4>
<pre>public&nbsp;int&nbsp;GetHashCode()</pre>
<div class="block">Gets the hash code for this object.</div>
</li>
</ul>
<a name="Inflate(int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Inflate</h4>
<pre>public&nbsp;void&nbsp;Inflate(int&nbsp;horizontalAmount,
int&nbsp;verticalAmount)</pre>
<div class="block">Pushes the edges of the Rectangle out by the horizontal and vertical values specified.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>horizontalAmount</code> - Value to push the sides out by.</dd><dd><code>verticalAmount</code> - Value to push the top and bottom out by.</dd></dl>
</li>
</ul>
<a name="Intersect(Microsoft.Xna.Framework.Rectangle, Microsoft.Xna.Framework.Rectangle)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Intersect</h4>
<pre>public static&nbsp;<a href="../../../Microsoft/Xna/Framework/Rectangle.html" title="class in Microsoft.Xna.Framework">Rectangle</a>&nbsp;Intersect(<a href="../../../Microsoft/Xna/Framework/Rectangle.html" title="class in Microsoft.Xna.Framework">Rectangle</a>&nbsp;value1,
<a href="../../../Microsoft/Xna/Framework/Rectangle.html" title="class in Microsoft.Xna.Framework">Rectangle</a>&nbsp;value2)</pre>
<div class="block">Creates a Rectangle defining the area where one rectangle overlaps with another rectangle.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value1</code> - The first Rectangle to compare.</dd><dd><code>value2</code> - The second Rectangle to compare.</dd>
<dt><span class="strong">Returns:</span></dt><dd></dd></dl>
</li>
</ul>
<a name="Intersect(Microsoft.Xna.Framework.Rectangle, Microsoft.Xna.Framework.Rectangle, Microsoft.Xna.Framework.Rectangle)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Intersect</h4>
<pre>public static&nbsp;void&nbsp;Intersect(<a href="../../../Microsoft/Xna/Framework/Rectangle.html" title="class in Microsoft.Xna.Framework">Rectangle</a>&nbsp;value1,
<a href="../../../Microsoft/Xna/Framework/Rectangle.html" title="class in Microsoft.Xna.Framework">Rectangle</a>&nbsp;value2,
<a href="../../../Microsoft/Xna/Framework/Rectangle.html" title="class in Microsoft.Xna.Framework">Rectangle</a>&nbsp;result)</pre>
<div class="block">Creates a Rectangle defining the area where one rectangle overlaps with another rectangle.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value1</code> - The first Rectangle to compare.</dd><dd><code>value2</code> - The second Rectangle to compare.</dd><dd><code>result</code> - [OutAttribute] The area where the two first parameters overlap.</dd></dl>
</li>
</ul>
<a name="Intersects(Microsoft.Xna.Framework.Rectangle)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Intersects</h4>
<pre>public&nbsp;boolean&nbsp;Intersects(<a href="../../../Microsoft/Xna/Framework/Rectangle.html" title="class in Microsoft.Xna.Framework">Rectangle</a>&nbsp;value)</pre>
<div class="block">Determines whether a specified Rectangle intersects with this Rectangle.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - The Rectangle to evaluate.</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if the specified Rectangle intersects with this one; false otherwise.</dd></dl>
</li>
</ul>
<a name="Intersects(Microsoft.Xna.Framework.Rectangle, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Intersects</h4>
<pre>public&nbsp;void&nbsp;Intersects(<a href="../../../Microsoft/Xna/Framework/Rectangle.html" title="class in Microsoft.Xna.Framework">Rectangle</a>&nbsp;value,
boolean&nbsp;result)</pre>
<div class="block">Determines whether a specified Rectangle intersects with this Rectangle.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - The Rectangle to evaluate</dd><dd><code>result</code> - [OutAttribute] true if the specified Rectangle intersects with this one; false otherwise.</dd></dl>
</li>
</ul>
<a name="Offset(Microsoft.Xna.Framework.Point)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Offset</h4>
<pre>public&nbsp;void&nbsp;Offset(<a href="../../../Microsoft/Xna/Framework/Point.html" title="class in Microsoft.Xna.Framework">Point</a>&nbsp;amount)</pre>
<div class="block">Changes the position of the Rectangle.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>amount</code> - The values to adjust the position of the Rectangle by.</dd></dl>
</li>
</ul>
<a name="Offset(int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Offset</h4>
<pre>public&nbsp;void&nbsp;Offset(int&nbsp;offsetX,
int&nbsp;offsetY)</pre>
<div class="block">Changes the position of the Rectangle.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>offsetX</code> - Change in the x-position.</dd><dd><code>offsetY</code> - Change in the y-position.</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">Retrieves a string representation of the current object.</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 that represents the object.</dd></dl>
</li>
</ul>
<a name="Union(Microsoft.Xna.Framework.Rectangle, Microsoft.Xna.Framework.Rectangle)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Union</h4>
<pre>public static&nbsp;<a href="../../../Microsoft/Xna/Framework/Rectangle.html" title="class in Microsoft.Xna.Framework">Rectangle</a>&nbsp;Union(<a href="../../../Microsoft/Xna/Framework/Rectangle.html" title="class in Microsoft.Xna.Framework">Rectangle</a>&nbsp;value1,
<a href="../../../Microsoft/Xna/Framework/Rectangle.html" title="class in Microsoft.Xna.Framework">Rectangle</a>&nbsp;value2)</pre>
<div class="block">Creates a new Rectangle that exactly contains two other rectangles.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value1</code> - The first Rectangle to contain.</dd><dd><code>value2</code> - The second Rectangle to contain.</dd></dl>
</li>
</ul>
<a name="Union(Microsoft.Xna.Framework.Rectangle, Microsoft.Xna.Framework.Rectangle, Microsoft.Xna.Framework.Rectangle)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Union</h4>
<pre>public static&nbsp;void&nbsp;Union(<a href="../../../Microsoft/Xna/Framework/Rectangle.html" title="class in Microsoft.Xna.Framework">Rectangle</a>&nbsp;value1,
<a href="../../../Microsoft/Xna/Framework/Rectangle.html" title="class in Microsoft.Xna.Framework">Rectangle</a>&nbsp;value2,
<a href="../../../Microsoft/Xna/Framework/Rectangle.html" title="class in Microsoft.Xna.Framework">Rectangle</a>&nbsp;result)</pre>
<div class="block">Creates a new Rectangle that exactly contains two other rectangles.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value1</code> - The first Rectangle to contain.</dd><dd><code>value2</code> - The second Rectangle to contain.</dd><dd><code>result</code> - [OutAttribute] The Rectangle that must be the union of the first two rectangles.</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/Rectangle.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/Ray.html" title="class in Microsoft.Xna.Framework"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../Microsoft/Xna/Framework/TitleContainer.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/Rectangle.html" target="_top">Frames</a></li>
<li><a href="Rectangle.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