xref: /aosp_15_r20/external/zxing/docs/apidocs/com/google/zxing/ResultPoint.html (revision 513427e33d61bc67fc40bc261642ac0b2a686b45)
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!-- NewPage -->
3<html lang="en">
4<head>
5<!-- Generated by javadoc -->
6<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
7<title>ResultPoint (ZXing 3.5.1 API)</title>
8<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
9<script type="text/javascript" src="../../../script.js"></script>
10</head>
11<body>
12<script type="text/javascript"><!--
13    try {
14        if (location.href.indexOf('is-external=true') == -1) {
15            parent.document.title="ResultPoint (ZXing 3.5.1 API)";
16        }
17    }
18    catch(err) {
19    }
20//-->
21var methods = {"i0":9,"i1":10,"i2":10,"i3":10,"i4":10,"i5":9,"i6":10};
22var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
23var altColor = "altColor";
24var rowColor = "rowColor";
25var tableTab = "tableTab";
26var activeTableTab = "activeTableTab";
27</script>
28<noscript>
29<div>JavaScript is disabled on your browser.</div>
30</noscript>
31<!-- ========= START OF TOP NAVBAR ======= -->
32<div class="topNav"><a name="navbar.top">
33<!--   -->
34</a>
35<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
36<a name="navbar.top.firstrow">
37<!--   -->
38</a>
39<ul class="navList" title="Navigation">
40<li><a href="../../../overview-summary.html">Overview</a></li>
41<li><a href="package-summary.html">Package</a></li>
42<li class="navBarCell1Rev">Class</li>
43<li><a href="class-use/ResultPoint.html">Use</a></li>
44<li><a href="package-tree.html">Tree</a></li>
45<li><a href="../../../deprecated-list.html">Deprecated</a></li>
46<li><a href="../../../index-all.html">Index</a></li>
47<li><a href="../../../help-doc.html">Help</a></li>
48</ul>
49</div>
50<div class="subNav">
51<ul class="navList">
52<li><a href="../../../com/google/zxing/ResultMetadataType.html" title="enum in com.google.zxing"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
53<li><a href="../../../com/google/zxing/ResultPointCallback.html" title="interface in com.google.zxing"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
54</ul>
55<ul class="navList">
56<li><a href="../../../index.html?com/google/zxing/ResultPoint.html" target="_top">Frames</a></li>
57<li><a href="ResultPoint.html" target="_top">No&nbsp;Frames</a></li>
58</ul>
59<ul class="navList" id="allclasses_navbar_top">
60<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
61</ul>
62<div>
63<script type="text/javascript"><!--
64  allClassesLink = document.getElementById("allclasses_navbar_top");
65  if(window==top) {
66    allClassesLink.style.display = "block";
67  }
68  else {
69    allClassesLink.style.display = "none";
70  }
71  //-->
72</script>
73</div>
74<div>
75<ul class="subNavList">
76<li>Summary:&nbsp;</li>
77<li>Nested&nbsp;|&nbsp;</li>
78<li>Field&nbsp;|&nbsp;</li>
79<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
80<li><a href="#method.summary">Method</a></li>
81</ul>
82<ul class="subNavList">
83<li>Detail:&nbsp;</li>
84<li>Field&nbsp;|&nbsp;</li>
85<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
86<li><a href="#method.detail">Method</a></li>
87</ul>
88</div>
89<a name="skip.navbar.top">
90<!--   -->
91</a></div>
92<!-- ========= END OF TOP NAVBAR ========= -->
93<!-- ======== START OF CLASS DATA ======== -->
94<div class="header">
95<div class="subTitle">com.google.zxing</div>
96<h2 title="Class ResultPoint" class="title">Class ResultPoint</h2>
97</div>
98<div class="contentContainer">
99<ul class="inheritance">
100<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
101<li>
102<ul class="inheritance">
103<li>com.google.zxing.ResultPoint</li>
104</ul>
105</li>
106</ul>
107<div class="description">
108<ul class="blockList">
109<li class="blockList">
110<dl>
111<dt>Direct Known Subclasses:</dt>
112<dd><a href="../../../com/google/zxing/qrcode/detector/AlignmentPattern.html" title="class in com.google.zxing.qrcode.detector">AlignmentPattern</a>, <a href="../../../com/google/zxing/qrcode/detector/FinderPattern.html" title="class in com.google.zxing.qrcode.detector">FinderPattern</a></dd>
113</dl>
114<hr>
115<br>
116<pre>public class <span class="typeNameLabel">ResultPoint</span>
117extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
118<div class="block"><p>Encapsulates a point of interest in an image containing a barcode. Typically, this
119 would be the location of a finder pattern or the corner of the barcode, for example.</p></div>
120<dl>
121<dt><span class="simpleTagLabel">Author:</span></dt>
122<dd>Sean Owen</dd>
123</dl>
124</li>
125</ul>
126</div>
127<div class="summary">
128<ul class="blockList">
129<li class="blockList">
130<!-- ======== CONSTRUCTOR SUMMARY ======== -->
131<ul class="blockList">
132<li class="blockList"><a name="constructor.summary">
133<!--   -->
134</a>
135<h3>Constructor Summary</h3>
136<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
137<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
138<tr>
139<th class="colOne" scope="col">Constructor and Description</th>
140</tr>
141<tr class="altColor">
142<td class="colOne"><code><span class="memberNameLink"><a href="../../../com/google/zxing/ResultPoint.html#ResultPoint-float-float-">ResultPoint</a></span>(float&nbsp;x,
143           float&nbsp;y)</code>&nbsp;</td>
144</tr>
145</table>
146</li>
147</ul>
148<!-- ========== METHOD SUMMARY =========== -->
149<ul class="blockList">
150<li class="blockList"><a name="method.summary">
151<!--   -->
152</a>
153<h3>Method Summary</h3>
154<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
155<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
156<tr>
157<th class="colFirst" scope="col">Modifier and Type</th>
158<th class="colLast" scope="col">Method and Description</th>
159</tr>
160<tr id="i0" class="altColor">
161<td class="colFirst"><code>static float</code></td>
162<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/zxing/ResultPoint.html#distance-com.google.zxing.ResultPoint-com.google.zxing.ResultPoint-">distance</a></span>(<a href="../../../com/google/zxing/ResultPoint.html" title="class in com.google.zxing">ResultPoint</a>&nbsp;pattern1,
163        <a href="../../../com/google/zxing/ResultPoint.html" title="class in com.google.zxing">ResultPoint</a>&nbsp;pattern2)</code>&nbsp;</td>
164</tr>
165<tr id="i1" class="rowColor">
166<td class="colFirst"><code>boolean</code></td>
167<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/zxing/ResultPoint.html#equals-java.lang.Object-">equals</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;other)</code>&nbsp;</td>
168</tr>
169<tr id="i2" class="altColor">
170<td class="colFirst"><code>float</code></td>
171<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/zxing/ResultPoint.html#getX--">getX</a></span>()</code>&nbsp;</td>
172</tr>
173<tr id="i3" class="rowColor">
174<td class="colFirst"><code>float</code></td>
175<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/zxing/ResultPoint.html#getY--">getY</a></span>()</code>&nbsp;</td>
176</tr>
177<tr id="i4" class="altColor">
178<td class="colFirst"><code>int</code></td>
179<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/zxing/ResultPoint.html#hashCode--">hashCode</a></span>()</code>&nbsp;</td>
180</tr>
181<tr id="i5" class="rowColor">
182<td class="colFirst"><code>static void</code></td>
183<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/zxing/ResultPoint.html#orderBestPatterns-com.google.zxing.ResultPoint:A-">orderBestPatterns</a></span>(<a href="../../../com/google/zxing/ResultPoint.html" title="class in com.google.zxing">ResultPoint</a>[]&nbsp;patterns)</code>
184<div class="block">Orders an array of three ResultPoints in an order [A,B,C] such that AB is less than AC
185 and BC is less than AC, and the angle between BC and BA is less than 180 degrees.</div>
186</td>
187</tr>
188<tr id="i6" class="altColor">
189<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
190<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/zxing/ResultPoint.html#toString--">toString</a></span>()</code>&nbsp;</td>
191</tr>
192</table>
193<ul class="blockList">
194<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
195<!--   -->
196</a>
197<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
198<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
199</ul>
200</li>
201</ul>
202</li>
203</ul>
204</div>
205<div class="details">
206<ul class="blockList">
207<li class="blockList">
208<!-- ========= CONSTRUCTOR DETAIL ======== -->
209<ul class="blockList">
210<li class="blockList"><a name="constructor.detail">
211<!--   -->
212</a>
213<h3>Constructor Detail</h3>
214<a name="ResultPoint-float-float-">
215<!--   -->
216</a>
217<ul class="blockListLast">
218<li class="blockList">
219<h4>ResultPoint</h4>
220<pre>public&nbsp;ResultPoint(float&nbsp;x,
221                   float&nbsp;y)</pre>
222</li>
223</ul>
224</li>
225</ul>
226<!-- ============ METHOD DETAIL ========== -->
227<ul class="blockList">
228<li class="blockList"><a name="method.detail">
229<!--   -->
230</a>
231<h3>Method Detail</h3>
232<a name="getX--">
233<!--   -->
234</a>
235<ul class="blockList">
236<li class="blockList">
237<h4>getX</h4>
238<pre>public final&nbsp;float&nbsp;getX()</pre>
239</li>
240</ul>
241<a name="getY--">
242<!--   -->
243</a>
244<ul class="blockList">
245<li class="blockList">
246<h4>getY</h4>
247<pre>public final&nbsp;float&nbsp;getY()</pre>
248</li>
249</ul>
250<a name="equals-java.lang.Object-">
251<!--   -->
252</a>
253<ul class="blockList">
254<li class="blockList">
255<h4>equals</h4>
256<pre>public final&nbsp;boolean&nbsp;equals(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;other)</pre>
257<dl>
258<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
259<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
260</dl>
261</li>
262</ul>
263<a name="hashCode--">
264<!--   -->
265</a>
266<ul class="blockList">
267<li class="blockList">
268<h4>hashCode</h4>
269<pre>public final&nbsp;int&nbsp;hashCode()</pre>
270<dl>
271<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
272<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
273</dl>
274</li>
275</ul>
276<a name="toString--">
277<!--   -->
278</a>
279<ul class="blockList">
280<li class="blockList">
281<h4>toString</h4>
282<pre>public final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;toString()</pre>
283<dl>
284<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
285<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
286</dl>
287</li>
288</ul>
289<a name="orderBestPatterns-com.google.zxing.ResultPoint:A-">
290<!--   -->
291</a>
292<ul class="blockList">
293<li class="blockList">
294<h4>orderBestPatterns</h4>
295<pre>public static&nbsp;void&nbsp;orderBestPatterns(<a href="../../../com/google/zxing/ResultPoint.html" title="class in com.google.zxing">ResultPoint</a>[]&nbsp;patterns)</pre>
296<div class="block">Orders an array of three ResultPoints in an order [A,B,C] such that AB is less than AC
297 and BC is less than AC, and the angle between BC and BA is less than 180 degrees.</div>
298<dl>
299<dt><span class="paramLabel">Parameters:</span></dt>
300<dd><code>patterns</code> - array of three <code>ResultPoint</code> to order</dd>
301</dl>
302</li>
303</ul>
304<a name="distance-com.google.zxing.ResultPoint-com.google.zxing.ResultPoint-">
305<!--   -->
306</a>
307<ul class="blockListLast">
308<li class="blockList">
309<h4>distance</h4>
310<pre>public static&nbsp;float&nbsp;distance(<a href="../../../com/google/zxing/ResultPoint.html" title="class in com.google.zxing">ResultPoint</a>&nbsp;pattern1,
311                             <a href="../../../com/google/zxing/ResultPoint.html" title="class in com.google.zxing">ResultPoint</a>&nbsp;pattern2)</pre>
312<dl>
313<dt><span class="paramLabel">Parameters:</span></dt>
314<dd><code>pattern1</code> - first pattern</dd>
315<dd><code>pattern2</code> - second pattern</dd>
316<dt><span class="returnLabel">Returns:</span></dt>
317<dd>distance between two points</dd>
318</dl>
319</li>
320</ul>
321</li>
322</ul>
323</li>
324</ul>
325</div>
326</div>
327<!-- ========= END OF CLASS DATA ========= -->
328<!-- ======= START OF BOTTOM NAVBAR ====== -->
329<div class="bottomNav"><a name="navbar.bottom">
330<!--   -->
331</a>
332<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
333<a name="navbar.bottom.firstrow">
334<!--   -->
335</a>
336<ul class="navList" title="Navigation">
337<li><a href="../../../overview-summary.html">Overview</a></li>
338<li><a href="package-summary.html">Package</a></li>
339<li class="navBarCell1Rev">Class</li>
340<li><a href="class-use/ResultPoint.html">Use</a></li>
341<li><a href="package-tree.html">Tree</a></li>
342<li><a href="../../../deprecated-list.html">Deprecated</a></li>
343<li><a href="../../../index-all.html">Index</a></li>
344<li><a href="../../../help-doc.html">Help</a></li>
345</ul>
346</div>
347<div class="subNav">
348<ul class="navList">
349<li><a href="../../../com/google/zxing/ResultMetadataType.html" title="enum in com.google.zxing"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
350<li><a href="../../../com/google/zxing/ResultPointCallback.html" title="interface in com.google.zxing"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
351</ul>
352<ul class="navList">
353<li><a href="../../../index.html?com/google/zxing/ResultPoint.html" target="_top">Frames</a></li>
354<li><a href="ResultPoint.html" target="_top">No&nbsp;Frames</a></li>
355</ul>
356<ul class="navList" id="allclasses_navbar_bottom">
357<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
358</ul>
359<div>
360<script type="text/javascript"><!--
361  allClassesLink = document.getElementById("allclasses_navbar_bottom");
362  if(window==top) {
363    allClassesLink.style.display = "block";
364  }
365  else {
366    allClassesLink.style.display = "none";
367  }
368  //-->
369</script>
370</div>
371<div>
372<ul class="subNavList">
373<li>Summary:&nbsp;</li>
374<li>Nested&nbsp;|&nbsp;</li>
375<li>Field&nbsp;|&nbsp;</li>
376<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
377<li><a href="#method.summary">Method</a></li>
378</ul>
379<ul class="subNavList">
380<li>Detail:&nbsp;</li>
381<li>Field&nbsp;|&nbsp;</li>
382<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
383<li><a href="#method.detail">Method</a></li>
384</ul>
385</div>
386<a name="skip.navbar.bottom">
387<!--   -->
388</a></div>
389<!-- ======== END OF BOTTOM NAVBAR ======= -->
390<p class="legalCopy"><small>Copyright &#169; 2007&#x2013;2022. All rights reserved.</small></p>
391</body>
392</html>
393