<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_17) on Sun Nov 03 15:35:42 CET 2013 -->
<title>Rectangle (libgdx API)
</title>
<meta name="date" content="2013-11-03">
<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 (libgdx API)";
}
//-->
</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-all.html">Index
</a></li>
<li><a href="../../../../help-doc.html">Help
</a></li>
</ul>
<div class="aboutLanguage"><em>
libgdx API
<style>
body, td, th { font-family:Helvetica, Tahoma, Arial, sans-serif; font-size:10pt }
pre, code, tt { font-size:9pt; font-family:Lucida Console, Courier New, sans-serif }
h1, h2, h3, .FrameTitleFont, .FrameHeadingFont, .TableHeadingColor font { font-size:105%; font-weight:bold }
.TableHeadingColor { background:#EEEEFF; }
a { text-decoration:none }
a:hover { text-decoration:underline }
a:link, a:visited { color:blue }
table { border:0px }
.TableRowColor td:first-child { border-left:1px solid black }
.TableRowColor td { border:0px; border-bottom:1px solid black; border-right:1px solid black }
hr { border:0px; border-bottom:1px solid #333366; }
</style>
</em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../com/badlogic/gdx/math/Quaternion.html" title="class in com.badlogic.gdx.math"><span class="strong">Prev Class
</span></a></li>
<li><a href="../../../../com/badlogic/gdx/math/Vector.html" title="interface in com.badlogic.gdx.math"><span class="strong">Next Class
</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/badlogic/gdx/math/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:
</li>
<li>Nested
|
</li>
<li><a href="#field_summary">Field
</a> |
</li>
<li><a href="#constructor_summary">Constr
</a> |
</li>
<li><a href="#method_summary">Method
</a></li>
</ul>
<ul class="subNavList">
<li>Detail:
</li>
<li><a href="#field_detail">Field
</a> |
</li>
<li><a href="#constructor_detail">Constr
</a> |
</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">com.badlogic.gdx.math
</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>com.badlogic.gdx.math.Rectangle
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:
</dt>
<dd>java.io.Serializable
</dd>
</dl>
<hr>
<br>
<pre>public class
<span class="strong">Rectangle
</span>
extends java.lang.Object
implements java.io.Serializable
</pre>
<div class="block">Encapsulates a 2D rectangle defined by it's bottom corner point and its extends in x (width) and y (height).
</div>
<dl><dt><span class="strong">Author:
</span></dt>
<dd>badlogicgames@gmail.com
</dd>
<dt><span class="strong">See Also:
</span></dt><dd><a href="../../../../serialized-form.html#com.badlogic.gdx.math.Rectangle">Serialized Form
</a></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"> </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="../../../../com/badlogic/gdx/math/Rectangle.html#height">height
</a></strong></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static
<a href="../../../../com/badlogic/gdx/math/Rectangle.html" title="class in com.badlogic.gdx.math">Rectangle
</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/math/Rectangle.html#tmp">tmp
</a></strong></code>
<div class="block">Static temporary rectangle.
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static
<a href="../../../../com/badlogic/gdx/math/Rectangle.html" title="class in com.badlogic.gdx.math">Rectangle
</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/math/Rectangle.html#tmp2">tmp2
</a></strong></code>
<div class="block">Static temporary rectangle.
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>float
</code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/math/Rectangle.html#width">width
</a></strong></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>float
</code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/math/Rectangle.html#x">x
</a></strong></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>float
</code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/math/Rectangle.html#y">y
</a></strong></code> </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"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description
</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../com/badlogic/gdx/math/Rectangle.html#Rectangle()">Rectangle
</a></strong>()
</code>
<div class="block">Constructs a new rectangle with all values set to zero
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../com/badlogic/gdx/math/Rectangle.html#Rectangle(float, float, float, float)">Rectangle
</a></strong>(float
x,
float
y,
float
width,
float
height)
</code>
<div class="block">Constructs a new rectangle with the given corner point in the bottom left and dimensions.
</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../com/badlogic/gdx/math/Rectangle.html#Rectangle(com.badlogic.gdx.math.Rectangle)">Rectangle
</a></strong>(
<a href="../../../../com/badlogic/gdx/math/Rectangle.html" title="class in com.badlogic.gdx.math">Rectangle
</a> rect)
</code>
<div class="block">Constructs a rectangle based on the given 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"> </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>boolean
</code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/math/Rectangle.html#contains(float, float)">contains
</a></strong>(float
x,
float
y)
</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean
</code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/math/Rectangle.html#contains(com.badlogic.gdx.math.Rectangle)">contains
</a></strong>(
<a href="../../../../com/badlogic/gdx/math/Rectangle.html" title="class in com.badlogic.gdx.math">Rectangle
</a> rectangle)
</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean
</code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/math/Rectangle.html#contains(com.badlogic.gdx.math.Vector2)">contains
</a></strong>(
<a href="../../../../com/badlogic/gdx/math/Vector2.html" title="class in com.badlogic.gdx.math">Vector2
</a> vector)
</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../com/badlogic/gdx/math/Rectangle.html" title="class in com.badlogic.gdx.math">Rectangle
</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/math/Rectangle.html#fitInside(com.badlogic.gdx.math.Rectangle)">fitInside
</a></strong>(
<a href="../../../../com/badlogic/gdx/math/Rectangle.html" title="class in com.badlogic.gdx.math">Rectangle
</a> rect)
</code>
<div class="block">Fits this rectangle into another rectangle while maintaining aspect ratio.
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../com/badlogic/gdx/math/Rectangle.html" title="class in com.badlogic.gdx.math">Rectangle
</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/math/Rectangle.html#fitOutside(com.badlogic.gdx.math.Rectangle)">fitOutside
</a></strong>(
<a href="../../../../com/badlogic/gdx/math/Rectangle.html" title="class in com.badlogic.gdx.math">Rectangle
</a> rect)
</code>
<div class="block">Fits this rectangle around another rectangle while maintaining aspect ratio
This scales and centers the rectangle to the other rectangle
(e.g.
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>float
</code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/math/Rectangle.html#getAspectRatio()">getAspectRatio
</a></strong>()
</code>
<div class="block">Calculates the aspect ratio ( width / height ) of this rectangle
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../com/badlogic/gdx/math/Vector2.html" title="class in com.badlogic.gdx.math">Vector2
</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/math/Rectangle.html#getCenter(com.badlogic.gdx.math.Vector2)">getCenter
</a></strong>(
<a href="../../../../com/badlogic/gdx/math/Vector2.html" title="class in com.badlogic.gdx.math">Vector2
</a> vector)
</code>
<div class="block">Calculates the center of the rectangle.
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>float
</code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/math/Rectangle.html#getHeight()">getHeight
</a></strong>()
</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../com/badlogic/gdx/math/Vector2.html" title="class in com.badlogic.gdx.math">Vector2
</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/math/Rectangle.html#getPosition(com.badlogic.gdx.math.Vector2)">getPosition
</a></strong>(
<a href="../../../../com/badlogic/gdx/math/Vector2.html" title="class in com.badlogic.gdx.math">Vector2
</a> position)
</code>
<div class="block">return the Vector2 with coordinates of this rectangle
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../com/badlogic/gdx/math/Vector2.html" title="class in com.badlogic.gdx.math">Vector2
</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/math/Rectangle.html#getSize(com.badlogic.gdx.math.Vector2)">getSize
</a></strong>(
<a href="../../../../com/badlogic/gdx/math/Vector2.html" title="class in com.badlogic.gdx.math">Vector2
</a> size)
</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>float
</code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/math/Rectangle.html#getWidth()">getWidth
</a></strong>()
</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>float
</code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/math/Rectangle.html#getX()">getX
</a></strong>()
</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>float
</code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/math/Rectangle.html#getY()">getY
</a></strong>()
</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../com/badlogic/gdx/math/Rectangle.html" title="class in com.badlogic.gdx.math">Rectangle
</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/math/Rectangle.html#merge(com.badlogic.gdx.math.Rectangle)">merge
</a></strong>(
<a href="../../../../com/badlogic/gdx/math/Rectangle.html" title="class in com.badlogic.gdx.math">Rectangle
</a> rect)
</code>
<div class="block">Merges this rectangle with the other rectangle.
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean
</code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/math/Rectangle.html#overlaps(com.badlogic.gdx.math.Rectangle)">overlaps
</a></strong>(
<a href="../../../../com/badlogic/gdx/math/Rectangle.html" title="class in com.badlogic.gdx.math">Rectangle
</a> r)
</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../com/badlogic/gdx/math/Rectangle.html" title="class in com.badlogic.gdx.math">Rectangle
</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/math/Rectangle.html#set(float, float, float, float)">set
</a></strong>(float
x,
float
y,
float
width,
float
height)
</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../com/badlogic/gdx/math/Rectangle.html" title="class in com.badlogic.gdx.math">Rectangle
</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/math/Rectangle.html#set(com.badlogic.gdx.math.Rectangle)">set
</a></strong>(
<a href="../../../../com/badlogic/gdx/math/Rectangle.html" title="class in com.badlogic.gdx.math">Rectangle
</a> rect)
</code>
<div class="block">Sets the values of the given rectangle to this rectangle.
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../com/badlogic/gdx/math/Rectangle.html" title="class in com.badlogic.gdx.math">Rectangle
</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/math/Rectangle.html#setCenter(float, float)">setCenter
</a></strong>(float
x,
float
y)
</code>
<div class="block">Moves this rectangle so that its center point is located at a given position
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../com/badlogic/gdx/math/Rectangle.html" title="class in com.badlogic.gdx.math">Rectangle
</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/math/Rectangle.html#setCenter(com.badlogic.gdx.math.Vector2)">setCenter
</a></strong>(
<a href="../../../../com/badlogic/gdx/math/Vector2.html" title="class in com.badlogic.gdx.math">Vector2
</a> position)
</code>
<div class="block">Moves this rectangle so that its center point is located at a given position
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../com/badlogic/gdx/math/Rectangle.html" title="class in com.badlogic.gdx.math">Rectangle
</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/math/Rectangle.html#setHeight(float)">setHeight
</a></strong>(float
height)
</code>
<div class="block">Sets the height of this rectangle
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../com/badlogic/gdx/math/Rectangle.html" title="class in com.badlogic.gdx.math">Rectangle
</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/math/Rectangle.html#setPosition(float, float)">setPosition
</a></strong>(float
x,
float
y)
</code>
<div class="block">Sets the x and y-coordinates of the bottom left corner
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../com/badlogic/gdx/math/Rectangle.html" title="class in com.badlogic.gdx.math">Rectangle
</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/math/Rectangle.html#setPosition(com.badlogic.gdx.math.Vector2)">setPosition
</a></strong>(
<a href="../../../../com/badlogic/gdx/math/Vector2.html" title="class in com.badlogic.gdx.math">Vector2
</a> position)
</code>
<div class="block">Sets the x and y-coordinates of the bottom left corner from vector
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../com/badlogic/gdx/math/Rectangle.html" title="class in com.badlogic.gdx.math">Rectangle
</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/math/Rectangle.html#setSize(float)">setSize
</a></strong>(float
sizeXY)
</code>
<div class="block">Sets the squared size of this rectangle
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../com/badlogic/gdx/math/Rectangle.html" title="class in com.badlogic.gdx.math">Rectangle
</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/math/Rectangle.html#setSize(float, float)">setSize
</a></strong>(float
width,
float
height)
</code>
<div class="block">Sets the width and height of this rectangle
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../com/badlogic/gdx/math/Rectangle.html" title="class in com.badlogic.gdx.math">Rectangle
</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/math/Rectangle.html#setWidth(float)">setWidth
</a></strong>(float
width)
</code>
<div class="block">Sets the width of this rectangle
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../com/badlogic/gdx/math/Rectangle.html" title="class in com.badlogic.gdx.math">Rectangle
</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/math/Rectangle.html#setX(float)">setX
</a></strong>(float
x)
</code>
<div class="block">Sets the x-coordinate of the bottom left corner
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../com/badlogic/gdx/math/Rectangle.html" title="class in com.badlogic.gdx.math">Rectangle
</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/math/Rectangle.html#setY(float)">setY
</a></strong>(float
y)
</code>
<div class="block">Sets the y-coordinate of the bottom left corner
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String
</code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/math/Rectangle.html#toString()">toString
</a></strong>()
</code> </td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class
java.lang.Object
</h3>
<code>clone, equals, 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="tmp">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>tmp
</h4>
<pre>public static final
<a href="../../../../com/badlogic/gdx/math/Rectangle.html" title="class in com.badlogic.gdx.math">Rectangle
</a> tmp
</pre>
<div class="block">Static temporary rectangle. Use with care! Use only when sure other code will not also use this.
</div>
</li>
</ul>
<a name="tmp2">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>tmp2
</h4>
<pre>public static final
<a href="../../../../com/badlogic/gdx/math/Rectangle.html" title="class in com.badlogic.gdx.math">Rectangle
</a> tmp2
</pre>
<div class="block">Static temporary rectangle. Use with care! Use only when sure other code will not also use this.
</div>
</li>
</ul>
<a name="x">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>x
</h4>
<pre>public
float x
</pre>
</li>
</ul>
<a name="y">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>y
</h4>
<pre>public
float y
</pre>
</li>
</ul>
<a name="width">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>width
</h4>
<pre>public
float width
</pre>
</li>
</ul>
<a name="height">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>height
</h4>
<pre>public
float height
</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail
</h3>
<a name="Rectangle()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Rectangle
</h4>
<pre>public
Rectangle()
</pre>
<div class="block">Constructs a new rectangle with all values set to zero
</div>
</li>
</ul>
<a name="Rectangle(float, float, float, float)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Rectangle
</h4>
<pre>public
Rectangle(float
x,
float
y,
float
width,
float
height)
</pre>
<div class="block">Constructs a new rectangle with the given corner point in the bottom left and dimensions.
</div>
<dl><dt><span class="strong">Parameters:
</span></dt><dd><code>x
</code> - The corner point x-coordinate
</dd><dd><code>y
</code> - The corner point y-coordinate
</dd><dd><code>width
</code> - The width
</dd><dd><code>height
</code> - The height
</dd></dl>
</li>
</ul>
<a name="Rectangle(com.badlogic.gdx.math.Rectangle)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Rectangle
</h4>
<pre>public
Rectangle(
<a href="../../../../com/badlogic/gdx/math/Rectangle.html" title="class in com.badlogic.gdx.math">Rectangle
</a> rect)
</pre>
<div class="block">Constructs a rectangle based on the given rectangle
</div>
<dl><dt><span class="strong">Parameters:
</span></dt><dd><code>rect
</code> - The rectangle
</dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail
</h3>
<a name="set(float, float, float, float)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>set
</h4>
<pre>public
<a href="../../../../com/badlogic/gdx/math/Rectangle.html" title="class in com.badlogic.gdx.math">Rectangle
</a> set(float
x,
float
y,
float
width,
float
height)
</pre>
<dl><dt><span class="strong">Parameters:
</span></dt><dd><code>x
</code> - bottom-left x coordinate
</dd><dd><code>y
</code> - bottom-left y coordinate
</dd><dd><code>width
</code> - width
</dd><dd><code>height
</code> - height
</dd>
<dt><span class="strong">Returns:
</span></dt><dd>this rectangle for chaining
</dd></dl>
</li>
</ul>
<a name="getX()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getX
</h4>
<pre>public
float
getX()
</pre>
<dl><dt><span class="strong">Returns:
</span></dt><dd>the x-coordinate of the bottom left corner
</dd></dl>
</li>
</ul>
<a name="setX(float)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setX
</h4>
<pre>public
<a href="../../../../com/badlogic/gdx/math/Rectangle.html" title="class in com.badlogic.gdx.math">Rectangle
</a> setX(float
x)
</pre>
<div class="block">Sets the x-coordinate of the bottom left corner
</div>
<dl><dt><span class="strong">Parameters:
</span></dt><dd><code>x
</code> - The x-coordinate
</dd>
<dt><span class="strong">Returns:
</span></dt><dd>this rectangle for chaining
</dd></dl>
</li>
</ul>
<a name="getY()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getY
</h4>
<pre>public
float
getY()
</pre>
<dl><dt><span class="strong">Returns:
</span></dt><dd>the y-coordinate of the bottom left corner
</dd></dl>
</li>
</ul>
<a name="setY(float)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setY
</h4>
<pre>public
<a href="../../../../com/badlogic/gdx/math/Rectangle.html" title="class in com.badlogic.gdx.math">Rectangle
</a> setY(float
y)
</pre>
<div class="block">Sets the y-coordinate of the bottom left corner
</div>
<dl><dt><span class="strong">Parameters:
</span></dt><dd><code>y
</code> - The y-coordinate
</dd>
<dt><span class="strong">Returns:
</span></dt><dd>this rectangle for chaining
</dd></dl>
</li>
</ul>
<a name="getWidth()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWidth
</h4>
<pre>public
float
getWidth()
</pre>
<dl><dt><span class="strong">Returns:
</span></dt><dd>the width
</dd></dl>
</li>
</ul>
<a name="setWidth(float)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setWidth
</h4>
<pre>public
<a href="../../../../com/badlogic/gdx/math/Rectangle.html" title="class in com.badlogic.gdx.math">Rectangle
</a> setWidth(float
width)
</pre>
<div class="block">Sets the width of this rectangle
</div>
<dl><dt><span class="strong">Parameters:
</span></dt><dd><code>width
</code> - The width
</dd>
<dt><span class="strong">Returns:
</span></dt><dd>this rectangle for chaining
</dd></dl>
</li>
</ul>
<a name="getHeight()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHeight
</h4>
<pre>public
float
getHeight()
</pre>
<dl><dt><span class="strong">Returns:
</span></dt><dd>the height
</dd></dl>
</li>
</ul>
<a name="setHeight(float)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setHeight
</h4>
<pre>public
<a href="../../../../com/badlogic/gdx/math/Rectangle.html" title="class in com.badlogic.gdx.math">Rectangle
</a> setHeight(float
height)
</pre>
<div class="block">Sets the height of this rectangle
</div>
<dl><dt><span class="strong">Parameters:
</span></dt><dd><code>height
</code> - The height
</dd>
<dt><span class="strong">Returns:
</span></dt><dd>this rectangle for chaining
</dd></dl>
</li>
</ul>
<a name="getPosition(com.badlogic.gdx.math.Vector2)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPosition
</h4>
<pre>public
<a href="../../../../com/badlogic/gdx/math/Vector2.html" title="class in com.badlogic.gdx.math">Vector2
</a> getPosition(
<a href="../../../../com/badlogic/gdx/math/Vector2.html" title="class in com.badlogic.gdx.math">Vector2
</a> position)
</pre>
<div class="block">return the Vector2 with coordinates of this rectangle
</div>
<dl><dt><span class="strong">Parameters:
</span></dt><dd><code>position
</code> - The Vector2
</dd></dl>
</li>
</ul>
<a name="setPosition(com.badlogic.gdx.math.Vector2)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPosition
</h4>
<pre>public
<a href="../../../../com/badlogic/gdx/math/Rectangle.html" title="class in com.badlogic.gdx.math">Rectangle
</a> setPosition(
<a href="../../../../com/badlogic/gdx/math/Vector2.html" title="class in com.badlogic.gdx.math">Vector2
</a> position)
</pre>
<div class="block">Sets the x and y-coordinates of the bottom left corner from vector
</div>
<dl><dt><span class="strong">Parameters:
</span></dt><dd><code>position
</code> - The position vector
</dd>
<dt><span class="strong">Returns:
</span></dt><dd>this rectangle for chaining
</dd></dl>
</li>
</ul>
<a name="setPosition(float, float)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPosition
</h4>
<pre>public
<a href="../../../../com/badlogic/gdx/math/Rectangle.html" title="class in com.badlogic.gdx.math">Rectangle
</a> setPosition(float
x,
float
y)
</pre>
<div class="block">Sets the x and y-coordinates of the bottom left corner
</div>
<dl><dt><span class="strong">Parameters:
</span></dt><dd><code>x
</code> - The x-coordinate
</dd><dd><code>y
</code> - The y-coordinate
</dd>
<dt><span class="strong">Returns:
</span></dt><dd>this rectangle for chaining
</dd></dl>
</li>
</ul>
<a name="setSize(float, float)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSize
</h4>
<pre>public
<a href="../../../../com/badlogic/gdx/math/Rectangle.html" title="class in com.badlogic.gdx.math">Rectangle
</a> setSize(float
width,
float
height)
</pre>
<div class="block">Sets the width and height of this rectangle
</div>
<dl><dt><span class="strong">Parameters:
</span></dt><dd><code>width
</code> - The width
</dd><dd><code>height
</code> - The height
</dd>
<dt><span class="strong">Returns:
</span></dt><dd>this rectangle for chaining
</dd></dl>
</li>
</ul>
<a name="setSize(float)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSize
</h4>
<pre>public
<a href="../../../../com/badlogic/gdx/math/Rectangle.html" title="class in com.badlogic.gdx.math">Rectangle
</a> setSize(float
sizeXY)
</pre>
<div class="block">Sets the squared size of this rectangle
</div>
<dl><dt><span class="strong">Parameters:
</span></dt><dd><code>sizeXY
</code> - The size
</dd>
<dt><span class="strong">Returns:
</span></dt><dd>this rectangle for chaining
</dd></dl>
</li>
</ul>
<a name="getSize(com.badlogic.gdx.math.Vector2)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSize
</h4>
<pre>public
<a href="../../../../com/badlogic/gdx/math/Vector2.html" title="class in com.badlogic.gdx.math">Vector2
</a> getSize(
<a href="../../../../com/badlogic/gdx/math/Vector2.html" title="class in com.badlogic.gdx.math">Vector2
</a> size)
</pre>
<dl><dt><span class="strong">Parameters:
</span></dt><dd><code>size
</code> - The Vector2
</dd>
<dt><span class="strong">Returns:
</span></dt><dd>the Vector2 with size of this rectangle
</dd></dl>
</li>
</ul>
<a name="contains(float, float)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>contains
</h4>
<pre>public
boolean
contains(float
x,
float
y)
</pre>
<dl><dt><span class="strong">Parameters:
</span></dt><dd><code>x
</code> - point x coordinate
</dd><dd><code>y
</code> - point y coordinate
</dd>
<dt><span class="strong">Returns:
</span></dt><dd>whether the point is contained in the rectangle
</dd></dl>
</li>
</ul>
<a name="contains(com.badlogic.gdx.math.Vector2)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>contains
</h4>
<pre>public
boolean
contains(
<a href="../../../../com/badlogic/gdx/math/Vector2.html" title="class in com.badlogic.gdx.math">Vector2
</a> vector)
</pre>
<dl><dt><span class="strong">Parameters:
</span></dt><dd><code>vector
</code> - The coordinates vector
</dd>
<dt><span class="strong">Returns:
</span></dt><dd>whether the vector is contained in the rectangle
</dd></dl>
</li>
</ul>
<a name="contains(com.badlogic.gdx.math.Rectangle)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>contains
</h4>
<pre>public
boolean
contains(
<a href="../../../../com/badlogic/gdx/math/Rectangle.html" title="class in com.badlogic.gdx.math">Rectangle
</a> rectangle)
</pre>
<dl><dt><span class="strong">Parameters:
</span></dt><dd><code>rectangle
</code> - the other
<a href="../../../../com/badlogic/gdx/math/Rectangle.html" title="class in com.badlogic.gdx.math"><code>Rectangle
</code></a>.
</dd>
<dt><span class="strong">Returns:
</span></dt><dd>whether the other rectangle is contained in this rectangle.
</dd></dl>
</li>
</ul>
<a name="overlaps(com.badlogic.gdx.math.Rectangle)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>overlaps
</h4>
<pre>public
boolean
overlaps(
<a href="../../../../com/badlogic/gdx/math/Rectangle.html" title="class in com.badlogic.gdx.math">Rectangle
</a> r)
</pre>
<dl><dt><span class="strong">Parameters:
</span></dt><dd><code>r
</code> - the other
<a href="../../../../com/badlogic/gdx/math/Rectangle.html" title="class in com.badlogic.gdx.math"><code>Rectangle
</code></a></dd>
<dt><span class="strong">Returns:
</span></dt><dd>whether this rectangle overlaps the other rectangle.
</dd></dl>
</li>
</ul>
<a name="set(com.badlogic.gdx.math.Rectangle)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>set
</h4>
<pre>public
<a href="../../../../com/badlogic/gdx/math/Rectangle.html" title="class in com.badlogic.gdx.math">Rectangle
</a> set(
<a href="../../../../com/badlogic/gdx/math/Rectangle.html" title="class in com.badlogic.gdx.math">Rectangle
</a> rect)
</pre>
<div class="block">Sets the values of the given rectangle to this rectangle.
</div>
<dl><dt><span class="strong">Parameters:
</span></dt><dd><code>rect
</code> - the other rectangle
</dd>
<dt><span class="strong">Returns:
</span></dt><dd>this rectangle for chaining
</dd></dl>
</li>
</ul>
<a name="merge(com.badlogic.gdx.math.Rectangle)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>merge
</h4>
<pre>public
<a href="../../../../com/badlogic/gdx/math/Rectangle.html" title="class in com.badlogic.gdx.math">Rectangle
</a> merge(
<a href="../../../../com/badlogic/gdx/math/Rectangle.html" title="class in com.badlogic.gdx.math">Rectangle
</a> rect)
</pre>
<div class="block">Merges this rectangle with the other rectangle.
</div>
<dl><dt><span class="strong">Parameters:
</span></dt><dd><code>rect
</code> - the other rectangle
</dd>
<dt><span class="strong">Returns:
</span></dt><dd>this rectangle for chaining
</dd></dl>
</li>
</ul>
<a name="getAspectRatio()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAspectRatio
</h4>
<pre>public
float
getAspectRatio()
</pre>
<div class="block">Calculates the aspect ratio ( width / height ) of this rectangle
</div>
<dl><dt><span class="strong">Returns:
</span></dt><dd>the aspect ratio of this rectangle.
Returns Float.NaN if height is 0 to avoid ArithmeticException
</dd></dl>
</li>
</ul>
<a name="getCenter(com.badlogic.gdx.math.Vector2)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCenter
</h4>
<pre>public
<a href="../../../../com/badlogic/gdx/math/Vector2.html" title="class in com.badlogic.gdx.math">Vector2
</a> getCenter(
<a href="../../../../com/badlogic/gdx/math/Vector2.html" title="class in com.badlogic.gdx.math">Vector2
</a> vector)
</pre>
<div class="block">Calculates the center of the rectangle. Results are located in the given Vector2
</div>
<dl><dt><span class="strong">Parameters:
</span></dt><dd><code>vector
</code> - the Vector2 to use
</dd>
<dt><span class="strong">Returns:
</span></dt><dd>the given vector with results stored inside
</dd></dl>
</li>
</ul>
<a name="setCenter(float, float)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCenter
</h4>
<pre>public
<a href="../../../../com/badlogic/gdx/math/Rectangle.html" title="class in com.badlogic.gdx.math">Rectangle
</a> setCenter(float
x,
float
y)
</pre>
<div class="block">Moves this rectangle so that its center point is located at a given position
</div>
<dl><dt><span class="strong">Parameters:
</span></dt><dd><code>x
</code> - the position's x
</dd><dd><code>y
</code> - the position's y
</dd>
<dt><span class="strong">Returns:
</span></dt><dd>this for chaining
</dd></dl>
</li>
</ul>
<a name="setCenter(com.badlogic.gdx.math.Vector2)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCenter
</h4>
<pre>public
<a href="../../../../com/badlogic/gdx/math/Rectangle.html" title="class in com.badlogic.gdx.math">Rectangle
</a> setCenter(
<a href="../../../../com/badlogic/gdx/math/Vector2.html" title="class in com.badlogic.gdx.math">Vector2
</a> position)
</pre>
<div class="block">Moves this rectangle so that its center point is located at a given position
</div>
<dl><dt><span class="strong">Parameters:
</span></dt><dd><code>position
</code> - the position
</dd>
<dt><span class="strong">Returns:
</span></dt><dd>this for chaining
</dd></dl>
</li>
</ul>
<a name="fitOutside(com.badlogic.gdx.math.Rectangle)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fitOutside
</h4>
<pre>public
<a href="../../../../com/badlogic/gdx/math/Rectangle.html" title="class in com.badlogic.gdx.math">Rectangle
</a> fitOutside(
<a href="../../../../com/badlogic/gdx/math/Rectangle.html" title="class in com.badlogic.gdx.math">Rectangle
</a> rect)
</pre>
<div class="block">Fits this rectangle around another rectangle while maintaining aspect ratio
This scales and centers the rectangle to the other rectangle
(e.g. Having a camera translate and scale to show a given area)
</div>
<dl><dt><span class="strong">Parameters:
</span></dt><dd><code>rect
</code> - the other rectangle to fit this rectangle around
</dd>
<dt><span class="strong">Returns:
</span></dt><dd>this rectangle for chaining
</dd></dl>
</li>
</ul>
<a name="fitInside(com.badlogic.gdx.math.Rectangle)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fitInside
</h4>
<pre>public
<a href="../../../../com/badlogic/gdx/math/Rectangle.html" title="class in com.badlogic.gdx.math">Rectangle
</a> fitInside(
<a href="../../../../com/badlogic/gdx/math/Rectangle.html" title="class in com.badlogic.gdx.math">Rectangle
</a> rect)
</pre>
<div class="block">Fits this rectangle into another rectangle while maintaining aspect ratio.
This scales and centers the rectangle to the other rectangle
(e.g. Scaling a texture within a arbitrary cell without squeezing)
</div>
<dl><dt><span class="strong">Parameters:
</span></dt><dd><code>rect
</code> - the other rectangle to fit this rectangle inside
</dd>
<dt><span class="strong">Returns:
</span></dt><dd>this rectangle for chaining
</dd></dl>
</li>
</ul>
<a name="toString()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString
</h4>
<pre>public
java.lang.String
toString()
</pre>
<dl>
<dt><strong>Overrides:
</strong></dt>
<dd><code>toString
</code> in class
<code>java.lang.Object
</code></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-all.html">Index
</a></li>
<li><a href="../../../../help-doc.html">Help
</a></li>
</ul>
<div class="aboutLanguage"><em>libgdx API
</em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../com/badlogic/gdx/math/Quaternion.html" title="class in com.badlogic.gdx.math"><span class="strong">Prev Class
</span></a></li>
<li><a href="../../../../com/badlogic/gdx/math/Vector.html" title="interface in com.badlogic.gdx.math"><span class="strong">Next Class
</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/badlogic/gdx/math/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:
</li>
<li>Nested
|
</li>
<li><a href="#field_summary">Field
</a> |
</li>
<li><a href="#constructor_summary">Constr
</a> |
</li>
<li><a href="#method_summary">Method
</a></li>
</ul>
<ul class="subNavList">
<li>Detail:
</li>
<li><a href="#field_detail">Field
</a> |
</li>
<li><a href="#constructor_detail">Constr
</a> |
</li>
<li><a href="#method_detail">Method
</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>
<div style="font-size:9pt"><i>
Copyright
© 2010-2013 Mario Zechner (contact@badlogicgames.com), Nathan Sweet (admin@esotericsoftware.com)
</i></div>
</small></p>
</body>
</html>