diff options
Diffstat (limited to 'doc/org/jogamp/vecmath/AxisAngle4f.html')
| -rw-r--r-- | doc/org/jogamp/vecmath/AxisAngle4f.html | 1092 |
1 files changed, 1092 insertions, 0 deletions
diff --git a/doc/org/jogamp/vecmath/AxisAngle4f.html b/doc/org/jogamp/vecmath/AxisAngle4f.html new file mode 100644 index 0000000..840034f --- /dev/null +++ b/doc/org/jogamp/vecmath/AxisAngle4f.html @@ -0,0 +1,1092 @@ +<!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:52 NZST 2017 --> +<title>AxisAngle4f</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="AxisAngle4f"; + } + } + 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}; +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/AxisAngle4f.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/AxisAngle4d.html" title="class in org.jogamp.vecmath"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/jogamp/vecmath/Color3b.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/AxisAngle4f.html" target="_top">Frames</a></li> +<li><a href="AxisAngle4f.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 AxisAngle4f" class="title">Class AxisAngle4f</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.jogamp.vecmath.AxisAngle4f</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> +<hr> +<br> +<pre>public class <span class="typeNameLabel">AxisAngle4f</span> +extends java.lang.Object +implements java.io.Serializable, java.lang.Cloneable</pre> +<div class="block">A four-element axis angle represented by single-precision floating point + x,y,z,angle components. An axis angle is a rotation of angle (radians) + about the vector (x,y,z).</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../serialized-form.html#org.jogamp.vecmath.AxisAngle4f">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>float</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jogamp/vecmath/AxisAngle4f.html#angle">angle</a></span></code> +<div class="block">The angle of rotation in radians.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>float</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jogamp/vecmath/AxisAngle4f.html#x">x</a></span></code> +<div class="block">The x coordinate.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>float</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jogamp/vecmath/AxisAngle4f.html#y">y</a></span></code> +<div class="block">The y coordinate.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>float</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jogamp/vecmath/AxisAngle4f.html#z">z</a></span></code> +<div class="block">The z 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/AxisAngle4f.html#AxisAngle4f--">AxisAngle4f</a></span>()</code> +<div class="block">Constructs and initializes an AxisAngle4f to (0,0,1,0).</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../org/jogamp/vecmath/AxisAngle4f.html#AxisAngle4f-org.jogamp.vecmath.AxisAngle4d-">AxisAngle4f</a></span>(<a href="../../../org/jogamp/vecmath/AxisAngle4d.html" title="class in org.jogamp.vecmath">AxisAngle4d</a> a1)</code> +<div class="block">Constructs and initializes an AxisAngle4f from the specified AxisAngle4d.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../org/jogamp/vecmath/AxisAngle4f.html#AxisAngle4f-org.jogamp.vecmath.AxisAngle4f-">AxisAngle4f</a></span>(<a href="../../../org/jogamp/vecmath/AxisAngle4f.html" title="class in org.jogamp.vecmath">AxisAngle4f</a> a1)</code> +<div class="block">Constructs and initializes an AxisAngle4f from the specified + AxisAngle4f.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../org/jogamp/vecmath/AxisAngle4f.html#AxisAngle4f-float:A-">AxisAngle4f</a></span>(float[] a)</code> +<div class="block">Constructs and initializes an AxisAngle4f from the array of length 4.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../org/jogamp/vecmath/AxisAngle4f.html#AxisAngle4f-float-float-float-float-">AxisAngle4f</a></span>(float x, + float y, + float z, + float angle)</code> +<div class="block">Constructs and initializes a AxisAngle4f from the specified xyzw coordinates.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../org/jogamp/vecmath/AxisAngle4f.html#AxisAngle4f-org.jogamp.vecmath.Vector3f-float-">AxisAngle4f</a></span>(<a href="../../../org/jogamp/vecmath/Vector3f.html" title="class in org.jogamp.vecmath">Vector3f</a> axis, + float angle)</code> +<div class="block">Constructs and initializes an AxisAngle4f from the specified + axis and angle.</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>java.lang.Object</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jogamp/vecmath/AxisAngle4f.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="i1" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jogamp/vecmath/AxisAngle4f.html#epsilonEquals-org.jogamp.vecmath.AxisAngle4f-float-">epsilonEquals</a></span>(<a href="../../../org/jogamp/vecmath/AxisAngle4f.html" title="class in org.jogamp.vecmath">AxisAngle4f</a> a1, + float epsilon)</code> +<div class="block">Returns true if the L-infinite distance between this axis-angle + and axis-angle a1 is less than or equal to the epsilon parameter, + otherwise returns false.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jogamp/vecmath/AxisAngle4f.html#equals-org.jogamp.vecmath.AxisAngle4f-">equals</a></span>(<a href="../../../org/jogamp/vecmath/AxisAngle4f.html" title="class in org.jogamp.vecmath">AxisAngle4f</a> a1)</code> +<div class="block">Returns true if all of the data members of AxisAngle4f a1 are + equal to the corresponding data members in this AxisAngle4f.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jogamp/vecmath/AxisAngle4f.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object o1)</code> +<div class="block">Returns true if the Object o1 is of type AxisAngle4f and all of the + data members of o1 are equal to the corresponding data members in + this AxisAngle4f.</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/AxisAngle4f.html#get-float:A-">get</a></span>(float[] a)</code> +<div class="block">Copies the value of this axis-angle into the array a.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>float</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jogamp/vecmath/AxisAngle4f.html#getAngle--">getAngle</a></span>()</code> +<div class="block">Get the axis angle, in radians.<br> + An axis angle is a rotation angle about the vector (x,y,z).</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>float</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jogamp/vecmath/AxisAngle4f.html#getX--">getX</a></span>()</code> +<div class="block">Get value of <i>x</i> coordinate.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>float</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jogamp/vecmath/AxisAngle4f.html#getY--">getY</a></span>()</code> +<div class="block">Get value of <i>y</i> coordinate.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>float</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jogamp/vecmath/AxisAngle4f.html#getZ--">getZ</a></span>()</code> +<div class="block">Get value of <i>z</i> coordinate.</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jogamp/vecmath/AxisAngle4f.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="i10" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jogamp/vecmath/AxisAngle4f.html#set-org.jogamp.vecmath.AxisAngle4d-">set</a></span>(<a href="../../../org/jogamp/vecmath/AxisAngle4d.html" title="class in org.jogamp.vecmath">AxisAngle4d</a> a1)</code> +<div class="block">Sets the value of this axis-angle to the value of axis-angle a1.</div> +</td> +</tr> +<tr id="i11" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jogamp/vecmath/AxisAngle4f.html#set-org.jogamp.vecmath.AxisAngle4f-">set</a></span>(<a href="../../../org/jogamp/vecmath/AxisAngle4f.html" title="class in org.jogamp.vecmath">AxisAngle4f</a> a1)</code> +<div class="block">Sets the value of this axis-angle to the value of axis-angle a1.</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/AxisAngle4f.html#set-float:A-">set</a></span>(float[] a)</code> +<div class="block">Sets the value of this axis-angle to the specified values in the + array of length 4.</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/AxisAngle4f.html#set-float-float-float-float-">set</a></span>(float x, + float y, + float z, + float angle)</code> +<div class="block">Sets the value of this axis-angle to the specified x,y,z,angle.</div> +</td> +</tr> +<tr id="i14" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jogamp/vecmath/AxisAngle4f.html#set-org.jogamp.vecmath.Matrix3d-">set</a></span>(<a href="../../../org/jogamp/vecmath/Matrix3d.html" title="class in org.jogamp.vecmath">Matrix3d</a> m1)</code> +<div class="block">Sets the value of this axis-angle to the rotational component of + the passed matrix.</div> +</td> +</tr> +<tr id="i15" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jogamp/vecmath/AxisAngle4f.html#set-org.jogamp.vecmath.Matrix3f-">set</a></span>(<a href="../../../org/jogamp/vecmath/Matrix3f.html" title="class in org.jogamp.vecmath">Matrix3f</a> m1)</code> +<div class="block">Sets the value of this axis-angle to the rotational component of + the passed matrix.</div> +</td> +</tr> +<tr id="i16" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jogamp/vecmath/AxisAngle4f.html#set-org.jogamp.vecmath.Matrix4d-">set</a></span>(<a href="../../../org/jogamp/vecmath/Matrix4d.html" title="class in org.jogamp.vecmath">Matrix4d</a> m1)</code> +<div class="block">Sets the value of this axis-angle to the rotational component of + the passed matrix.</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/AxisAngle4f.html#set-org.jogamp.vecmath.Matrix4f-">set</a></span>(<a href="../../../org/jogamp/vecmath/Matrix4f.html" title="class in org.jogamp.vecmath">Matrix4f</a> m1)</code> +<div class="block">Sets the value of this axis-angle to the rotational component of + the passed matrix.</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/AxisAngle4f.html#set-org.jogamp.vecmath.Quat4d-">set</a></span>(<a href="../../../org/jogamp/vecmath/Quat4d.html" title="class in org.jogamp.vecmath">Quat4d</a> q1)</code> +<div class="block">Sets the value of this axis-angle to the rotational equivalent + of the passed quaternion.</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/AxisAngle4f.html#set-org.jogamp.vecmath.Quat4f-">set</a></span>(<a href="../../../org/jogamp/vecmath/Quat4f.html" title="class in org.jogamp.vecmath">Quat4f</a> q1)</code> +<div class="block">Sets the value of this axis-angle to the rotational equivalent + of the passed quaternion.</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/AxisAngle4f.html#set-org.jogamp.vecmath.Vector3f-float-">set</a></span>(<a href="../../../org/jogamp/vecmath/Vector3f.html" title="class in org.jogamp.vecmath">Vector3f</a> axis, + float angle)</code> +<div class="block">Sets the value of this AxisAngle4f to the specified + axis and angle.</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/AxisAngle4f.html#setAngle-float-">setAngle</a></span>(float angle)</code> +<div class="block">Set the axis angle, in radians.<br> + An axis angle is a rotation angle about the vector (x,y,z).</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/AxisAngle4f.html#setX-float-">setX</a></span>(float x)</code> +<div class="block">Set a new value for <i>x</i> coordinate.</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/AxisAngle4f.html#setY-float-">setY</a></span>(float y)</code> +<div class="block">Set a new value for <i>y</i> coordinate.</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/AxisAngle4f.html#setZ-float-">setZ</a></span>(float z)</code> +<div class="block">Set a new value for <i>z</i> coordinate.</div> +</td> +</tr> +<tr id="i25" class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jogamp/vecmath/AxisAngle4f.html#toString--">toString</a></span>()</code> +<div class="block">Returns a string that contains the values of this AxisAngle4f.</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 float x</pre> +<div class="block">The x coordinate.</div> +</li> +</ul> +<a name="y"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>y</h4> +<pre>public float y</pre> +<div class="block">The y coordinate.</div> +</li> +</ul> +<a name="z"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>z</h4> +<pre>public float z</pre> +<div class="block">The z coordinate.</div> +</li> +</ul> +<a name="angle"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>angle</h4> +<pre>public float angle</pre> +<div class="block">The angle of rotation in radians.</div> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="AxisAngle4f-float-float-float-float-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>AxisAngle4f</h4> +<pre>public AxisAngle4f(float x, + float y, + float z, + float angle)</pre> +<div class="block">Constructs and initializes a AxisAngle4f from the specified xyzw 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> +<dd><code>z</code> - the z coordinate</dd> +<dd><code>angle</code> - the angle of rotation in radians</dd> +</dl> +</li> +</ul> +<a name="AxisAngle4f-float:A-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>AxisAngle4f</h4> +<pre>public AxisAngle4f(float[] a)</pre> +<div class="block">Constructs and initializes an AxisAngle4f from the array of length 4.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>a</code> - the array of length 4 containing x,y,z,angle in order</dd> +</dl> +</li> +</ul> +<a name="AxisAngle4f-org.jogamp.vecmath.AxisAngle4f-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>AxisAngle4f</h4> +<pre>public AxisAngle4f(<a href="../../../org/jogamp/vecmath/AxisAngle4f.html" title="class in org.jogamp.vecmath">AxisAngle4f</a> a1)</pre> +<div class="block">Constructs and initializes an AxisAngle4f from the specified + AxisAngle4f.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>a1</code> - the AxisAngle4f containing the initialization x y z angle data</dd> +</dl> +</li> +</ul> +<a name="AxisAngle4f-org.jogamp.vecmath.AxisAngle4d-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>AxisAngle4f</h4> +<pre>public AxisAngle4f(<a href="../../../org/jogamp/vecmath/AxisAngle4d.html" title="class in org.jogamp.vecmath">AxisAngle4d</a> a1)</pre> +<div class="block">Constructs and initializes an AxisAngle4f from the specified AxisAngle4d.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>a1</code> - the AxisAngle4d containing the initialization x y z angle data</dd> +</dl> +</li> +</ul> +<a name="AxisAngle4f-org.jogamp.vecmath.Vector3f-float-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>AxisAngle4f</h4> +<pre>public AxisAngle4f(<a href="../../../org/jogamp/vecmath/Vector3f.html" title="class in org.jogamp.vecmath">Vector3f</a> axis, + float angle)</pre> +<div class="block">Constructs and initializes an AxisAngle4f from the specified + axis and angle.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>axis</code> - the axis</dd> +<dd><code>angle</code> - the angle of rotation in radians</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>vecmath 1.2</dd> +</dl> +</li> +</ul> +<a name="AxisAngle4f--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>AxisAngle4f</h4> +<pre>public AxisAngle4f()</pre> +<div class="block">Constructs and initializes an AxisAngle4f to (0,0,1,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-float-float-float-float-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>set</h4> +<pre>public final void set(float x, + float y, + float z, + float angle)</pre> +<div class="block">Sets the value of this axis-angle to the specified x,y,z,angle.</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> +<dd><code>z</code> - the z coordinate</dd> +<dd><code>angle</code> - the angle of rotation in radians</dd> +</dl> +</li> +</ul> +<a name="set-float:A-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>set</h4> +<pre>public final void set(float[] a)</pre> +<div class="block">Sets the value of this axis-angle to the specified values in the + array of length 4.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>a</code> - the array of length 4 containing x,y,z,angle in order</dd> +</dl> +</li> +</ul> +<a name="set-org.jogamp.vecmath.AxisAngle4f-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>set</h4> +<pre>public final void set(<a href="../../../org/jogamp/vecmath/AxisAngle4f.html" title="class in org.jogamp.vecmath">AxisAngle4f</a> a1)</pre> +<div class="block">Sets the value of this axis-angle to the value of axis-angle a1.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>a1</code> - the axis-angle to be copied</dd> +</dl> +</li> +</ul> +<a name="set-org.jogamp.vecmath.AxisAngle4d-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>set</h4> +<pre>public final void set(<a href="../../../org/jogamp/vecmath/AxisAngle4d.html" title="class in org.jogamp.vecmath">AxisAngle4d</a> a1)</pre> +<div class="block">Sets the value of this axis-angle to the value of axis-angle a1.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>a1</code> - the axis-angle to be copied</dd> +</dl> +</li> +</ul> +<a name="set-org.jogamp.vecmath.Vector3f-float-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>set</h4> +<pre>public final void set(<a href="../../../org/jogamp/vecmath/Vector3f.html" title="class in org.jogamp.vecmath">Vector3f</a> axis, + float angle)</pre> +<div class="block">Sets the value of this AxisAngle4f to the specified + axis and angle.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>axis</code> - the axis</dd> +<dd><code>angle</code> - the angle of rotation in radians</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>vecmath 1.2</dd> +</dl> +</li> +</ul> +<a name="get-float:A-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public final void get(float[] a)</pre> +<div class="block">Copies the value of this axis-angle into the array a.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>a</code> - the array</dd> +</dl> +</li> +</ul> +<a name="set-org.jogamp.vecmath.Quat4f-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>set</h4> +<pre>public final void set(<a href="../../../org/jogamp/vecmath/Quat4f.html" title="class in org.jogamp.vecmath">Quat4f</a> q1)</pre> +<div class="block">Sets the value of this axis-angle to the rotational equivalent + of the passed quaternion. + If the specified quaternion has no rotational component, the value + of this AxisAngle4f is set to an angle of 0 about an axis of (0,1,0).</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>q1</code> - the Quat4f</dd> +</dl> +</li> +</ul> +<a name="set-org.jogamp.vecmath.Quat4d-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>set</h4> +<pre>public final void set(<a href="../../../org/jogamp/vecmath/Quat4d.html" title="class in org.jogamp.vecmath">Quat4d</a> q1)</pre> +<div class="block">Sets the value of this axis-angle to the rotational equivalent + of the passed quaternion. + If the specified quaternion has no rotational component, the value + of this AxisAngle4f is set to an angle of 0 about an axis of (0,1,0).</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>q1</code> - the Quat4d</dd> +</dl> +</li> +</ul> +<a name="set-org.jogamp.vecmath.Matrix4f-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>set</h4> +<pre>public final void set(<a href="../../../org/jogamp/vecmath/Matrix4f.html" title="class in org.jogamp.vecmath">Matrix4f</a> m1)</pre> +<div class="block">Sets the value of this axis-angle to the rotational component of + the passed matrix. + If the specified matrix has no rotational component, the value + of this AxisAngle4f is set to an angle of 0 about an axis of (0,1,0).</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>m1</code> - the matrix4f</dd> +</dl> +</li> +</ul> +<a name="set-org.jogamp.vecmath.Matrix4d-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>set</h4> +<pre>public final void set(<a href="../../../org/jogamp/vecmath/Matrix4d.html" title="class in org.jogamp.vecmath">Matrix4d</a> m1)</pre> +<div class="block">Sets the value of this axis-angle to the rotational component of + the passed matrix. + If the specified matrix has no rotational component, the value + of this AxisAngle4f is set to an angle of 0 about an axis of (0,1,0).</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>m1</code> - the matrix4d</dd> +</dl> +</li> +</ul> +<a name="set-org.jogamp.vecmath.Matrix3f-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>set</h4> +<pre>public final void set(<a href="../../../org/jogamp/vecmath/Matrix3f.html" title="class in org.jogamp.vecmath">Matrix3f</a> m1)</pre> +<div class="block">Sets the value of this axis-angle to the rotational component of + the passed matrix. + If the specified matrix has no rotational component, the value + of this AxisAngle4f is set to an angle of 0 about an axis of (0,1,0).</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>m1</code> - the matrix3f</dd> +</dl> +</li> +</ul> +<a name="set-org.jogamp.vecmath.Matrix3d-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>set</h4> +<pre>public final void set(<a href="../../../org/jogamp/vecmath/Matrix3d.html" title="class in org.jogamp.vecmath">Matrix3d</a> m1)</pre> +<div class="block">Sets the value of this axis-angle to the rotational component of + the passed matrix. + If the specified matrix has no rotational component, the value + of this AxisAngle4f is set to an angle of 0 about an axis of (0,1,0).</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>m1</code> - the matrix3d</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 AxisAngle4f. + The form is (x,y,z,angle).</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-org.jogamp.vecmath.AxisAngle4f-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equals</h4> +<pre>public boolean equals(<a href="../../../org/jogamp/vecmath/AxisAngle4f.html" title="class in org.jogamp.vecmath">AxisAngle4f</a> a1)</pre> +<div class="block">Returns true if all of the data members of AxisAngle4f a1 are + equal to the corresponding data members in this AxisAngle4f.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>a1</code> - the axis-angle with which the comparison is made</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true or false</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 o1)</pre> +<div class="block">Returns true if the Object o1 is of type AxisAngle4f and all of the + data members of o1 are equal to the corresponding data members in + this AxisAngle4f.</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>o1</code> - the object with which the comparison is made</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true or false</dd> +</dl> +</li> +</ul> +<a name="epsilonEquals-org.jogamp.vecmath.AxisAngle4f-float-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>epsilonEquals</h4> +<pre>public boolean epsilonEquals(<a href="../../../org/jogamp/vecmath/AxisAngle4f.html" title="class in org.jogamp.vecmath">AxisAngle4f</a> a1, + float epsilon)</pre> +<div class="block">Returns true if the L-infinite distance between this axis-angle + and axis-angle a1 is less than or equal to the epsilon parameter, + otherwise returns false. The L-infinite + distance is equal to + MAX[abs(x1-x2), abs(y1-y2), abs(z1-z2), abs(angle1-angle2)].</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>a1</code> - the axis-angle to be compared to this axis-angle</dd> +<dd><code>epsilon</code> - the threshold value</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 AxisAngle4f objects with identical data values + (i.e., AxisAngle4f.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="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="simpleTagLabel">Since:</span></dt> +<dd>vecmath 1.3</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><code>Cloneable</code></dd> +</dl> +</li> +</ul> +<a name="getAngle--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAngle</h4> +<pre>public final float getAngle()</pre> +<div class="block">Get the axis angle, in radians.<br> + An axis angle is a rotation angle about the vector (x,y,z).</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>Returns the angle, in radians.</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>vecmath 1.5</dd> +</dl> +</li> +</ul> +<a name="setAngle-float-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setAngle</h4> +<pre>public final void setAngle(float angle)</pre> +<div class="block">Set the axis angle, in radians.<br> + An axis angle is a rotation angle about the vector (x,y,z).</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>angle</code> - The angle to set, in radians.</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>vecmath 1.5</dd> +</dl> +</li> +</ul> +<a name="getX--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getX</h4> +<pre>public final float getX()</pre> +<div class="block">Get value of <i>x</i> coordinate.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the <i>x</i> coordinate.</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>vecmath 1.5</dd> +</dl> +</li> +</ul> +<a name="setX-float-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setX</h4> +<pre>public final void setX(float x)</pre> +<div class="block">Set a new value for <i>x</i> coordinate.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>x</code> - the <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 float getY()</pre> +<div class="block">Get value of <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-float-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setY</h4> +<pre>public final void setY(float y)</pre> +<div class="block">Set a new value for <i>y</i> coordinate.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>y</code> - the <i>y</i> coordinate.</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>vecmath 1.5</dd> +</dl> +</li> +</ul> +<a name="getZ--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getZ</h4> +<pre>public final float getZ()</pre> +<div class="block">Get value of <i>z</i> coordinate.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the <i>z</i> coordinate.</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>vecmath 1.5</dd> +</dl> +</li> +</ul> +<a name="setZ-float-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>setZ</h4> +<pre>public final void setZ(float z)</pre> +<div class="block">Set a new value for <i>z</i> coordinate.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>z</code> - the <i>z</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/AxisAngle4f.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/AxisAngle4d.html" title="class in org.jogamp.vecmath"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/jogamp/vecmath/Color3b.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/AxisAngle4f.html" target="_top">Frames</a></li> +<li><a href="AxisAngle4f.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> |