diff options
Diffstat (limited to 'doc/org/jogamp/vecmath/Tuple2i.html')
| -rw-r--r-- | doc/org/jogamp/vecmath/Tuple2i.html | 1096 |
1 files changed, 1096 insertions, 0 deletions
diff --git a/doc/org/jogamp/vecmath/Tuple2i.html b/doc/org/jogamp/vecmath/Tuple2i.html new file mode 100644 index 0000000..5fe765e --- /dev/null +++ b/doc/org/jogamp/vecmath/Tuple2i.html @@ -0,0 +1,1096 @@ +<!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 (1.8.0_25) on Tue May 02 14:01:53 NZST 2017 --> +<title>Tuple2i</title> +<meta name="date" content="2017-05-02"> +<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="Tuple2i"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../org/jogamp/vecmath/package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/Tuple2i.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="../../../org/jogamp/vecmath/Tuple2f.html" title="class in org.jogamp.vecmath"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/jogamp/vecmath/Tuple3b.html" title="class in org.jogamp.vecmath"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/jogamp/vecmath/Tuple2i.html" target="_top">Frames</a></li> +<li><a href="Tuple2i.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">org.jogamp.vecmath</div> +<h2 title="Class Tuple2i" class="title">Class Tuple2i</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.jogamp.vecmath.Tuple2i</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable, java.lang.Cloneable</dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../org/jogamp/vecmath/Point2i.html" title="class in org.jogamp.vecmath">Point2i</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="typeNameLabel">Tuple2i</span> +extends java.lang.Object +implements java.io.Serializable, java.lang.Cloneable</pre> +<div class="block">A 2-element tuple represented by signed integer x,y + coordinates.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>vecmath 1.4</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../serialized-form.html#org.jogamp.vecmath.Tuple2i">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="memberSummary" 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>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jogamp/vecmath/Tuple2i.html#x">x</a></span></code> +<div class="block">The x coordinate.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jogamp/vecmath/Tuple2i.html#y">y</a></span></code> +<div class="block">The y coordinate.</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="memberSummary" 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><span class="memberNameLink"><a href="../../../org/jogamp/vecmath/Tuple2i.html#Tuple2i--">Tuple2i</a></span>()</code> +<div class="block">Constructs and initializes a Tuple2i to (0,0).</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../org/jogamp/vecmath/Tuple2i.html#Tuple2i-int:A-">Tuple2i</a></span>(int[] t)</code> +<div class="block">Constructs and initializes a Tuple2i from the array of length 2.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../org/jogamp/vecmath/Tuple2i.html#Tuple2i-int-int-">Tuple2i</a></span>(int x, + int y)</code> +<div class="block">Constructs and initializes a Tuple2i from the specified + x and y coordinates.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../org/jogamp/vecmath/Tuple2i.html#Tuple2i-org.jogamp.vecmath.Tuple2i-">Tuple2i</a></span>(<a href="../../../org/jogamp/vecmath/Tuple2i.html" title="class in org.jogamp.vecmath">Tuple2i</a> t1)</code> +<div class="block">Constructs and initializes a Tuple2i from the specified Tuple2i.</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jogamp/vecmath/Tuple2i.html#absolute--">absolute</a></span>()</code> +<div class="block">Sets each component of this tuple to its absolute value.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jogamp/vecmath/Tuple2i.html#absolute-org.jogamp.vecmath.Tuple2i-">absolute</a></span>(<a href="../../../org/jogamp/vecmath/Tuple2i.html" title="class in org.jogamp.vecmath">Tuple2i</a> t)</code> +<div class="block">Sets each component of the tuple parameter to its absolute + value and places the modified values into this tuple.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jogamp/vecmath/Tuple2i.html#add-org.jogamp.vecmath.Tuple2i-">add</a></span>(<a href="../../../org/jogamp/vecmath/Tuple2i.html" title="class in org.jogamp.vecmath">Tuple2i</a> t1)</code> +<div class="block">Sets the value of this tuple to the sum of itself and t1.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jogamp/vecmath/Tuple2i.html#add-org.jogamp.vecmath.Tuple2i-org.jogamp.vecmath.Tuple2i-">add</a></span>(<a href="../../../org/jogamp/vecmath/Tuple2i.html" title="class in org.jogamp.vecmath">Tuple2i</a> t1, + <a href="../../../org/jogamp/vecmath/Tuple2i.html" title="class in org.jogamp.vecmath">Tuple2i</a> t2)</code> +<div class="block">Sets the value of this tuple to the sum of tuples t1 and t2.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jogamp/vecmath/Tuple2i.html#clamp-int-int-">clamp</a></span>(int min, + int max)</code> +<div class="block">Clamps this tuple to the range [low, high].</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jogamp/vecmath/Tuple2i.html#clamp-int-int-org.jogamp.vecmath.Tuple2i-">clamp</a></span>(int min, + int max, + <a href="../../../org/jogamp/vecmath/Tuple2i.html" title="class in org.jogamp.vecmath">Tuple2i</a> t)</code> +<div class="block">Clamps the tuple parameter to the range [low, high] and + places the values into this tuple.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jogamp/vecmath/Tuple2i.html#clampMax-int-">clampMax</a></span>(int max)</code> +<div class="block">Clamps the maximum value of this tuple to the max parameter.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jogamp/vecmath/Tuple2i.html#clampMax-int-org.jogamp.vecmath.Tuple2i-">clampMax</a></span>(int max, + <a href="../../../org/jogamp/vecmath/Tuple2i.html" title="class in org.jogamp.vecmath">Tuple2i</a> t)</code> +<div class="block">Clamps the maximum value of the tuple parameter to the max + parameter and places the values into this tuple.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jogamp/vecmath/Tuple2i.html#clampMin-int-">clampMin</a></span>(int min)</code> +<div class="block">Clamps the minimum value of this tuple to the min parameter.</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jogamp/vecmath/Tuple2i.html#clampMin-int-org.jogamp.vecmath.Tuple2i-">clampMin</a></span>(int min, + <a href="../../../org/jogamp/vecmath/Tuple2i.html" title="class in org.jogamp.vecmath">Tuple2i</a> t)</code> +<div class="block">Clamps the minimum value of the tuple parameter to the min + parameter and places the values into this tuple.</div> +</td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jogamp/vecmath/Tuple2i.html#clone--">clone</a></span>()</code> +<div class="block">Creates a new object of the same class as this object.</div> +</td> +</tr> +<tr id="i11" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jogamp/vecmath/Tuple2i.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object t1)</code> +<div class="block">Returns true if the Object t1 is of type Tuple2i and all of the + data members of t1 are equal to the corresponding data members in + this Tuple2i.</div> +</td> +</tr> +<tr id="i12" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jogamp/vecmath/Tuple2i.html#get-int:A-">get</a></span>(int[] t)</code> +<div class="block">Copies the values of this tuple into the array t.</div> +</td> +</tr> +<tr id="i13" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jogamp/vecmath/Tuple2i.html#get-org.jogamp.vecmath.Tuple2i-">get</a></span>(<a href="../../../org/jogamp/vecmath/Tuple2i.html" title="class in org.jogamp.vecmath">Tuple2i</a> t)</code> +<div class="block">Copies the values of this tuple into the tuple t.</div> +</td> +</tr> +<tr id="i14" class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jogamp/vecmath/Tuple2i.html#getX--">getX</a></span>()</code> +<div class="block">Get the <i>x</i> coordinate.</div> +</td> +</tr> +<tr id="i15" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jogamp/vecmath/Tuple2i.html#getY--">getY</a></span>()</code> +<div class="block">Get the <i>y</i> coordinate.</div> +</td> +</tr> +<tr id="i16" class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jogamp/vecmath/Tuple2i.html#hashCode--">hashCode</a></span>()</code> +<div class="block">Returns a hash code value based on the data values in this + object.</div> +</td> +</tr> +<tr id="i17" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jogamp/vecmath/Tuple2i.html#negate--">negate</a></span>()</code> +<div class="block">Negates the value of this tuple in place.</div> +</td> +</tr> +<tr id="i18" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jogamp/vecmath/Tuple2i.html#negate-org.jogamp.vecmath.Tuple2i-">negate</a></span>(<a href="../../../org/jogamp/vecmath/Tuple2i.html" title="class in org.jogamp.vecmath">Tuple2i</a> t1)</code> +<div class="block">Sets the value of this tuple to the negation of tuple t1.</div> +</td> +</tr> +<tr id="i19" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jogamp/vecmath/Tuple2i.html#scale-int-">scale</a></span>(int s)</code> +<div class="block">Sets the value of this tuple to the scalar multiplication + of the scale factor with this.</div> +</td> +</tr> +<tr id="i20" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jogamp/vecmath/Tuple2i.html#scale-int-org.jogamp.vecmath.Tuple2i-">scale</a></span>(int s, + <a href="../../../org/jogamp/vecmath/Tuple2i.html" title="class in org.jogamp.vecmath">Tuple2i</a> t1)</code> +<div class="block">Sets the value of this tuple to the scalar multiplication + of tuple t1.</div> +</td> +</tr> +<tr id="i21" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jogamp/vecmath/Tuple2i.html#scaleAdd-int-org.jogamp.vecmath.Tuple2i-">scaleAdd</a></span>(int s, + <a href="../../../org/jogamp/vecmath/Tuple2i.html" title="class in org.jogamp.vecmath">Tuple2i</a> t1)</code> +<div class="block">Sets the value of this tuple to the scalar multiplication + of itself and then adds tuple t1 (this = s*this + t1).</div> +</td> +</tr> +<tr id="i22" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jogamp/vecmath/Tuple2i.html#scaleAdd-int-org.jogamp.vecmath.Tuple2i-org.jogamp.vecmath.Tuple2i-">scaleAdd</a></span>(int s, + <a href="../../../org/jogamp/vecmath/Tuple2i.html" title="class in org.jogamp.vecmath">Tuple2i</a> t1, + <a href="../../../org/jogamp/vecmath/Tuple2i.html" title="class in org.jogamp.vecmath">Tuple2i</a> t2)</code> +<div class="block">Sets the value of this tuple to the scalar multiplication + of tuple t1 plus tuple t2 (this = s*t1 + t2).</div> +</td> +</tr> +<tr id="i23" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jogamp/vecmath/Tuple2i.html#set-int:A-">set</a></span>(int[] t)</code> +<div class="block">Sets the value of this tuple to the specified coordinates in the + array of length 2.</div> +</td> +</tr> +<tr id="i24" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jogamp/vecmath/Tuple2i.html#set-int-int-">set</a></span>(int x, + int y)</code> +<div class="block">Sets the value of this tuple to the specified x and y + coordinates.</div> +</td> +</tr> +<tr id="i25" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jogamp/vecmath/Tuple2i.html#set-org.jogamp.vecmath.Tuple2i-">set</a></span>(<a href="../../../org/jogamp/vecmath/Tuple2i.html" title="class in org.jogamp.vecmath">Tuple2i</a> t1)</code> +<div class="block">Sets the value of this tuple to the value of tuple t1.</div> +</td> +</tr> +<tr id="i26" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jogamp/vecmath/Tuple2i.html#setX-int-">setX</a></span>(int x)</code> +<div class="block">Set the <i>x</i> coordinate.</div> +</td> +</tr> +<tr id="i27" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jogamp/vecmath/Tuple2i.html#setY-int-">setY</a></span>(int y)</code> +<div class="block">Set the <i>y</i> coordinate.</div> +</td> +</tr> +<tr id="i28" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jogamp/vecmath/Tuple2i.html#sub-org.jogamp.vecmath.Tuple2i-">sub</a></span>(<a href="../../../org/jogamp/vecmath/Tuple2i.html" title="class in org.jogamp.vecmath">Tuple2i</a> t1)</code> +<div class="block">Sets the value of this tuple to the difference + of itself and t1 (this = this - t1).</div> +</td> +</tr> +<tr id="i29" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jogamp/vecmath/Tuple2i.html#sub-org.jogamp.vecmath.Tuple2i-org.jogamp.vecmath.Tuple2i-">sub</a></span>(<a href="../../../org/jogamp/vecmath/Tuple2i.html" title="class in org.jogamp.vecmath">Tuple2i</a> t1, + <a href="../../../org/jogamp/vecmath/Tuple2i.html" title="class in org.jogamp.vecmath">Tuple2i</a> t2)</code> +<div class="block">Sets the value of this tuple to the difference + of tuples t1 and t2 (this = t1 - t2).</div> +</td> +</tr> +<tr id="i30" class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jogamp/vecmath/Tuple2i.html#toString--">toString</a></span>()</code> +<div class="block">Returns a string that contains the values of this Tuple2i.</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 java.lang.Object</h3> +<code>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="x"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>x</h4> +<pre>public int x</pre> +<div class="block">The x coordinate.</div> +</li> +</ul> +<a name="y"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>y</h4> +<pre>public int y</pre> +<div class="block">The y coordinate.</div> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="Tuple2i-int-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>Tuple2i</h4> +<pre>public Tuple2i(int x, + int y)</pre> +<div class="block">Constructs and initializes a Tuple2i from the specified + x and y coordinates.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>x</code> - the x coordinate</dd> +<dd><code>y</code> - the y coordinate</dd> +</dl> +</li> +</ul> +<a name="Tuple2i-int:A-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>Tuple2i</h4> +<pre>public Tuple2i(int[] t)</pre> +<div class="block">Constructs and initializes a Tuple2i from the array of length 2.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>t</code> - the array of length 2 containing x and y in order.</dd> +</dl> +</li> +</ul> +<a name="Tuple2i-org.jogamp.vecmath.Tuple2i-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>Tuple2i</h4> +<pre>public Tuple2i(<a href="../../../org/jogamp/vecmath/Tuple2i.html" title="class in org.jogamp.vecmath">Tuple2i</a> t1)</pre> +<div class="block">Constructs and initializes a Tuple2i from the specified Tuple2i.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>t1</code> - the Tuple2i containing the initialization x and y + data.</dd> +</dl> +</li> +</ul> +<a name="Tuple2i--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>Tuple2i</h4> +<pre>public Tuple2i()</pre> +<div class="block">Constructs and initializes a Tuple2i to (0,0).</div> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="set-int-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>set</h4> +<pre>public final void set(int x, + int y)</pre> +<div class="block">Sets the value of this tuple to the specified x and y + coordinates.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>x</code> - the x coordinate</dd> +<dd><code>y</code> - the y coordinate</dd> +</dl> +</li> +</ul> +<a name="set-int:A-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>set</h4> +<pre>public final void set(int[] t)</pre> +<div class="block">Sets the value of this tuple to the specified coordinates in the + array of length 2.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>t</code> - the array of length 2 containing x and y in order.</dd> +</dl> +</li> +</ul> +<a name="set-org.jogamp.vecmath.Tuple2i-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>set</h4> +<pre>public final void set(<a href="../../../org/jogamp/vecmath/Tuple2i.html" title="class in org.jogamp.vecmath">Tuple2i</a> t1)</pre> +<div class="block">Sets the value of this tuple to the value of tuple t1.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>t1</code> - the tuple to be copied</dd> +</dl> +</li> +</ul> +<a name="get-int:A-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public final void get(int[] t)</pre> +<div class="block">Copies the values of this tuple into the array t.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>t</code> - is the array</dd> +</dl> +</li> +</ul> +<a name="get-org.jogamp.vecmath.Tuple2i-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public final void get(<a href="../../../org/jogamp/vecmath/Tuple2i.html" title="class in org.jogamp.vecmath">Tuple2i</a> t)</pre> +<div class="block">Copies the values of this tuple into the tuple t.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>t</code> - is the target tuple</dd> +</dl> +</li> +</ul> +<a name="add-org.jogamp.vecmath.Tuple2i-org.jogamp.vecmath.Tuple2i-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>add</h4> +<pre>public final void add(<a href="../../../org/jogamp/vecmath/Tuple2i.html" title="class in org.jogamp.vecmath">Tuple2i</a> t1, + <a href="../../../org/jogamp/vecmath/Tuple2i.html" title="class in org.jogamp.vecmath">Tuple2i</a> t2)</pre> +<div class="block">Sets the value of this tuple to the sum of tuples t1 and t2.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>t1</code> - the first tuple</dd> +<dd><code>t2</code> - the second tuple</dd> +</dl> +</li> +</ul> +<a name="add-org.jogamp.vecmath.Tuple2i-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>add</h4> +<pre>public final void add(<a href="../../../org/jogamp/vecmath/Tuple2i.html" title="class in org.jogamp.vecmath">Tuple2i</a> t1)</pre> +<div class="block">Sets the value of this tuple to the sum of itself and t1.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>t1</code> - the other tuple</dd> +</dl> +</li> +</ul> +<a name="sub-org.jogamp.vecmath.Tuple2i-org.jogamp.vecmath.Tuple2i-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>sub</h4> +<pre>public final void sub(<a href="../../../org/jogamp/vecmath/Tuple2i.html" title="class in org.jogamp.vecmath">Tuple2i</a> t1, + <a href="../../../org/jogamp/vecmath/Tuple2i.html" title="class in org.jogamp.vecmath">Tuple2i</a> t2)</pre> +<div class="block">Sets the value of this tuple to the difference + of tuples t1 and t2 (this = t1 - t2).</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>t1</code> - the first tuple</dd> +<dd><code>t2</code> - the second tuple</dd> +</dl> +</li> +</ul> +<a name="sub-org.jogamp.vecmath.Tuple2i-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>sub</h4> +<pre>public final void sub(<a href="../../../org/jogamp/vecmath/Tuple2i.html" title="class in org.jogamp.vecmath">Tuple2i</a> t1)</pre> +<div class="block">Sets the value of this tuple to the difference + of itself and t1 (this = this - t1).</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>t1</code> - the other tuple</dd> +</dl> +</li> +</ul> +<a name="negate-org.jogamp.vecmath.Tuple2i-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>negate</h4> +<pre>public final void negate(<a href="../../../org/jogamp/vecmath/Tuple2i.html" title="class in org.jogamp.vecmath">Tuple2i</a> t1)</pre> +<div class="block">Sets the value of this tuple to the negation of tuple t1.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>t1</code> - the source tuple</dd> +</dl> +</li> +</ul> +<a name="negate--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>negate</h4> +<pre>public final void negate()</pre> +<div class="block">Negates the value of this tuple in place.</div> +</li> +</ul> +<a name="scale-int-org.jogamp.vecmath.Tuple2i-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>scale</h4> +<pre>public final void scale(int s, + <a href="../../../org/jogamp/vecmath/Tuple2i.html" title="class in org.jogamp.vecmath">Tuple2i</a> t1)</pre> +<div class="block">Sets the value of this tuple to the scalar multiplication + of tuple t1.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>s</code> - the scalar value</dd> +<dd><code>t1</code> - the source tuple</dd> +</dl> +</li> +</ul> +<a name="scale-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>scale</h4> +<pre>public final void scale(int s)</pre> +<div class="block">Sets the value of this tuple to the scalar multiplication + of the scale factor with this.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>s</code> - the scalar value</dd> +</dl> +</li> +</ul> +<a name="scaleAdd-int-org.jogamp.vecmath.Tuple2i-org.jogamp.vecmath.Tuple2i-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>scaleAdd</h4> +<pre>public final void scaleAdd(int s, + <a href="../../../org/jogamp/vecmath/Tuple2i.html" title="class in org.jogamp.vecmath">Tuple2i</a> t1, + <a href="../../../org/jogamp/vecmath/Tuple2i.html" title="class in org.jogamp.vecmath">Tuple2i</a> t2)</pre> +<div class="block">Sets the value of this tuple to the scalar multiplication + of tuple t1 plus tuple t2 (this = s*t1 + t2).</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>s</code> - the scalar value</dd> +<dd><code>t1</code> - the tuple to be multipled</dd> +<dd><code>t2</code> - the tuple to be added</dd> +</dl> +</li> +</ul> +<a name="scaleAdd-int-org.jogamp.vecmath.Tuple2i-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>scaleAdd</h4> +<pre>public final void scaleAdd(int s, + <a href="../../../org/jogamp/vecmath/Tuple2i.html" title="class in org.jogamp.vecmath">Tuple2i</a> t1)</pre> +<div class="block">Sets the value of this tuple to the scalar multiplication + of itself and then adds tuple t1 (this = s*this + t1).</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>s</code> - the scalar value</dd> +<dd><code>t1</code> - the tuple to be added</dd> +</dl> +</li> +</ul> +<a name="toString--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString()</pre> +<div class="block">Returns a string that contains the values of this Tuple2i. + The form is (x,y).</div> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code>toString</code> in class <code>java.lang.Object</code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the String representation</dd> +</dl> +</li> +</ul> +<a name="equals-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equals</h4> +<pre>public boolean equals(java.lang.Object t1)</pre> +<div class="block">Returns true if the Object t1 is of type Tuple2i and all of the + data members of t1 are equal to the corresponding data members in + this Tuple2i.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code>equals</code> in class <code>java.lang.Object</code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>t1</code> - the object with which the comparison is made</dd> +</dl> +</li> +</ul> +<a name="hashCode--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hashCode</h4> +<pre>public int hashCode()</pre> +<div class="block">Returns a hash code value based on the data values in this + object. Two different Tuple2i objects with identical data values + (i.e., Tuple2i.equals returns true) will return the same hash + code value. Two objects with different data members may return the + same hash value, although this is not likely.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code>hashCode</code> in class <code>java.lang.Object</code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the integer hash code value</dd> +</dl> +</li> +</ul> +<a name="clamp-int-int-org.jogamp.vecmath.Tuple2i-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>clamp</h4> +<pre>public final void clamp(int min, + int max, + <a href="../../../org/jogamp/vecmath/Tuple2i.html" title="class in org.jogamp.vecmath">Tuple2i</a> t)</pre> +<div class="block">Clamps the tuple parameter to the range [low, high] and + places the values into this tuple.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>min</code> - the lowest value in the tuple after clamping</dd> +<dd><code>max</code> - the highest value in the tuple after clamping</dd> +<dd><code>t</code> - the source tuple, which will not be modified</dd> +</dl> +</li> +</ul> +<a name="clampMin-int-org.jogamp.vecmath.Tuple2i-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>clampMin</h4> +<pre>public final void clampMin(int min, + <a href="../../../org/jogamp/vecmath/Tuple2i.html" title="class in org.jogamp.vecmath">Tuple2i</a> t)</pre> +<div class="block">Clamps the minimum value of the tuple parameter to the min + parameter and places the values into this tuple.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>min</code> - the lowest value in the tuple after clamping</dd> +<dd><code>t</code> - the source tuple, which will not be modified</dd> +</dl> +</li> +</ul> +<a name="clampMax-int-org.jogamp.vecmath.Tuple2i-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>clampMax</h4> +<pre>public final void clampMax(int max, + <a href="../../../org/jogamp/vecmath/Tuple2i.html" title="class in org.jogamp.vecmath">Tuple2i</a> t)</pre> +<div class="block">Clamps the maximum value of the tuple parameter to the max + parameter and places the values into this tuple.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>max</code> - the highest value in the tuple after clamping</dd> +<dd><code>t</code> - the source tuple, which will not be modified</dd> +</dl> +</li> +</ul> +<a name="absolute-org.jogamp.vecmath.Tuple2i-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>absolute</h4> +<pre>public final void absolute(<a href="../../../org/jogamp/vecmath/Tuple2i.html" title="class in org.jogamp.vecmath">Tuple2i</a> t)</pre> +<div class="block">Sets each component of the tuple parameter to its absolute + value and places the modified values into this tuple.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>t</code> - the source tuple, which will not be modified</dd> +</dl> +</li> +</ul> +<a name="clamp-int-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>clamp</h4> +<pre>public final void clamp(int min, + int max)</pre> +<div class="block">Clamps this tuple to the range [low, high].</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>min</code> - the lowest value in this tuple after clamping</dd> +<dd><code>max</code> - the highest value in this tuple after clamping</dd> +</dl> +</li> +</ul> +<a name="clampMin-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>clampMin</h4> +<pre>public final void clampMin(int min)</pre> +<div class="block">Clamps the minimum value of this tuple to the min parameter.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>min</code> - the lowest value in this tuple after clamping</dd> +</dl> +</li> +</ul> +<a name="clampMax-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>clampMax</h4> +<pre>public final void clampMax(int max)</pre> +<div class="block">Clamps the maximum value of this tuple to the max parameter.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>max</code> - the highest value in the tuple after clamping</dd> +</dl> +</li> +</ul> +<a name="absolute--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>absolute</h4> +<pre>public final void absolute()</pre> +<div class="block">Sets each component of this tuple to its absolute value.</div> +</li> +</ul> +<a name="clone--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>clone</h4> +<pre>public java.lang.Object clone()</pre> +<div class="block">Creates a new object of the same class as this object.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code>clone</code> in class <code>java.lang.Object</code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a clone of this instance.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.OutOfMemoryError</code> - if there is not enough memory.</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><code>Cloneable</code></dd> +</dl> +</li> +</ul> +<a name="getX--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getX</h4> +<pre>public final int getX()</pre> +<div class="block">Get the <i>x</i> coordinate.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the x coordinate.</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>vecmath 1.5</dd> +</dl> +</li> +</ul> +<a name="setX-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setX</h4> +<pre>public final void setX(int x)</pre> +<div class="block">Set the <i>x</i> coordinate.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>x</code> - value to <i>x</i> coordinate.</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>vecmath 1.5</dd> +</dl> +</li> +</ul> +<a name="getY--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getY</h4> +<pre>public final int getY()</pre> +<div class="block">Get the <i>y</i> coordinate.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the <i>y</i> coordinate.</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>vecmath 1.5</dd> +</dl> +</li> +</ul> +<a name="setY-int-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>setY</h4> +<pre>public final void setY(int y)</pre> +<div class="block">Set the <i>y</i> coordinate.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>y</code> - value to <i>y</i> coordinate.</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>vecmath 1.5</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> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../org/jogamp/vecmath/package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/Tuple2i.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="../../../org/jogamp/vecmath/Tuple2f.html" title="class in org.jogamp.vecmath"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/jogamp/vecmath/Tuple3b.html" title="class in org.jogamp.vecmath"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/jogamp/vecmath/Tuple2i.html" target="_top">Frames</a></li> +<li><a href="Tuple2i.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 ======= --> +</body> +</html> |