threear
Version:
A marker based Augmented Reality library for Three.js
288 lines • 15.4 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>BarcodeMarkerParameters | threear</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">threear</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
<input type="checkbox" id="tsd-filter-only-exported" />
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../globals.html">Globals</a>
</li>
<li>
<a href="barcodemarkerparameters.html">BarcodeMarkerParameters</a>
</li>
</ul>
<h1>Interface BarcodeMarkerParameters</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>BarcodeMarker take a given predtermined barcode as the pattern to detect. Each barcode has
a predetermined number, for example the 3x3 matrix has 64 possible markers. You can find copies
of these markers in the artoolkit GitHub repository. This approach is faster than using
PatternMarker. The barcodes can be used to place a three.js Object3D and pin it to
the barcode marker.</p>
</div>
<dl class="tsd-comment-tags">
<dt>param</dt>
<dd><p>parameters for determing things like the barcode number and the minimum confidence</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">BarcodeMarkerParameters</span>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section tsd-is-external tsd-is-not-exported">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external tsd-is-not-exported"><a href="barcodemarkerparameters.html#barcodevalue" class="tsd-kind-icon">barcode<wbr>Value</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external tsd-is-not-exported"><a href="barcodemarkerparameters.html#markerobject" class="tsd-kind-icon">marker<wbr>Object</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external tsd-is-not-exported"><a href="barcodemarkerparameters.html#minconfidence" class="tsd-kind-icon">min<wbr>Confidence</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external tsd-is-not-exported"><a href="barcodemarkerparameters.html#size" class="tsd-kind-icon">size</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-external tsd-is-not-exported">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external tsd-is-not-exported">
<a name="barcodevalue" class="tsd-anchor"></a>
<h3>barcode<wbr>Value</h3>
<div class="tsd-signature tsd-kind-icon">barcode<wbr>Value<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/JamesMilnerUK/THREEAR/blob/6620e61/src/BarcodeMarker.ts#L14">BarcodeMarker.ts:14</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external tsd-is-not-exported">
<a name="markerobject" class="tsd-anchor"></a>
<h3>marker<wbr>Object</h3>
<div class="tsd-signature tsd-kind-icon">marker<wbr>Object<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Object3D</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/JamesMilnerUK/THREEAR/blob/6620e61/src/BarcodeMarker.ts#L15">BarcodeMarker.ts:15</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external tsd-is-not-exported">
<a name="minconfidence" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> min<wbr>Confidence</h3>
<div class="tsd-signature tsd-kind-icon">min<wbr>Confidence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/JamesMilnerUK/THREEAR/blob/6620e61/src/BarcodeMarker.ts#L17">BarcodeMarker.ts:17</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external tsd-is-not-exported">
<a name="size" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> size</h3>
<div class="tsd-signature tsd-kind-icon">size<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/JamesMilnerUK/THREEAR/blob/6620e61/src/BarcodeMarker.ts#L16">BarcodeMarker.ts:16</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals ">
<a href="../globals.html"><em>Globals</em></a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-class tsd-is-external">
<a href="../classes/barcodemarker.html" class="tsd-kind-icon">Barcode<wbr>Marker</a>
</li>
<li class=" tsd-kind-class tsd-is-external">
<a href="../classes/controller.html" class="tsd-kind-icon">Controller</a>
</li>
<li class=" tsd-kind-class tsd-is-external">
<a href="../classes/patternmarker.html" class="tsd-kind-icon">Pattern<wbr>Marker</a>
</li>
<li class=" tsd-kind-class tsd-is-external">
<a href="../classes/source.html" class="tsd-kind-icon">Source</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-is-external tsd-is-not-exported">
<a href="barcodemarkerparameters.html" class="tsd-kind-icon">Barcode<wbr>Marker<wbr>Parameters</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external tsd-is-not-exported">
<a href="barcodemarkerparameters.html#barcodevalue" class="tsd-kind-icon">barcode<wbr>Value</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external tsd-is-not-exported">
<a href="barcodemarkerparameters.html#markerobject" class="tsd-kind-icon">marker<wbr>Object</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external tsd-is-not-exported">
<a href="barcodemarkerparameters.html#minconfidence" class="tsd-kind-icon">min<wbr>Confidence</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external tsd-is-not-exported">
<a href="barcodemarkerparameters.html#size" class="tsd-kind-icon">size</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface tsd-is-external">
<a href="controllerparameters.html" class="tsd-kind-icon">Controller<wbr>Parameters</a>
</li>
<li class=" tsd-kind-interface tsd-is-external">
<a href="markerpositioningparameters.html" class="tsd-kind-icon">Marker<wbr>Positioning<wbr>Parameters</a>
</li>
<li class=" tsd-kind-interface tsd-is-external tsd-is-not-exported">
<a href="markers.html" class="tsd-kind-icon">Markers</a>
</li>
<li class=" tsd-kind-interface tsd-is-external tsd-is-not-exported">
<a href="patternmarkerparameters.html" class="tsd-kind-icon">Pattern<wbr>Marker<wbr>Parameters</a>
</li>
<li class=" tsd-kind-interface tsd-is-external tsd-is-not-exported">
<a href="sourceparameters.html" class="tsd-kind-icon">Source<wbr>Parameters</a>
</li>
<li class=" tsd-kind-variable tsd-is-external tsd-is-not-exported">
<a href="../globals.html#controller" class="tsd-kind-icon">controller</a>
</li>
<li class=" tsd-kind-function tsd-is-external tsd-is-not-exported">
<a href="../globals.html#initialize" class="tsd-kind-icon">initialize</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
</body>
</html>