@davepagurek/flo-mat

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>"find-mats" | FloMat</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">FloMat</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-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="_find_mats_.html">"find-mats"</a> </li> </ul> <h1>External module "find-mats"</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content">  <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-not-exported"> <h3>Functions</h3> <ul class="tsd-index-list"> <li class="tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"><a href="_find_mats_.html#findmats" class="tsd-kind-icon">find<wbr>Mats</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group tsd-is-not-exported"> <h2>Functions</h2> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"> <a name="findmats" class="tsd-anchor"></a> <h3>find<wbr>Mats</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon">find<wbr>Mats<span class="tsd-signature-symbol">(</span>bezierLoops<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">[]</span>, maxFlatness<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, maxLength<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../classes/_mat_.mat.html" class="tsd-signature-type">Mat</a><span class="tsd-signature-symbol">[]</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/FlorisSteenkamp/MAT/blob/de18fdb/src/find-mats.ts#L43">find-mats.ts:43</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Find the Medial Axis Transforms (MATs) from the given array of bezier loops representing shape boundaries.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>bezierLoops: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">[]</span></h5> <div class="tsd-comment tsd-typography"> <p>An array of (possibly intersecting) loops with each loop representing one or more piecewise smooth closed curves (i.e. shapes). Each loop consists of an array of beziers represented by an array of control points with 2,3 or 4 elements corresponding to linear, quadratic and cubic beziers respectively. Each point is a two-element array (ordered pair), the first of which is the x-coordinate and the second the y-coordinate.</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagDefault value">Default value</span> maxFlatness: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 1.01</span></h5> <div class="tsd-comment tsd-typography"> <p>The maximum value the flatness of a curve can have before an additional MAT point is added in between. Defaults to 1.01. (Flatness is measured as the total distance between control points of a curve divided by the length of the curve. The value cannot be lower than 1.001 and must be less than 2.</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagDefault value">Default value</span> maxLength: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 10</span></h5> <div class="tsd-comment tsd-typography"> <p>The maximum length a curve can have before an additional MAT point is added in between. Together with maxFlatness it represents a tolerance for the accuracy of the MAT. Defaults to 10. The value cannot be lower than 1 or higher than 1000.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="../classes/_mat_.mat.html" class="tsd-signature-type">Mat</a><span class="tsd-signature-symbol">[]</span></h4> </li> </ul> </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> <li class=" tsd-kind-external-module"> <a href="_beziers_to_svg_path_str_.html">"beziers-<wbr>to-<wbr>svg-<wbr>path-<wbr>str"</a> </li> <li class=" tsd-kind-external-module"> <a href="_circle_.html">"circle"</a> </li> <li class=" tsd-kind-external-module"> <a href="_contact_point_.html">"contact-<wbr>point"</a> </li> <li class=" tsd-kind-external-module"> <a href="_cp_node_.html">"cp-<wbr>node"</a> </li> <li class=" tsd-kind-external-module"> <a href="_curve_.html">"curve"</a> </li> <li class="current tsd-kind-external-module"> <a href="_find_mats_.html">"find-<wbr>mats"</a> </li> <li class=" tsd-kind-external-module"> <a href="_get_boundary_bezier_parts_to_next_.html">"get-<wbr>boundary-<wbr>bezier-<wbr>parts-<wbr>to-<wbr>next"</a> </li> <li class=" tsd-kind-external-module"> <a href="_get_boundary_beziers_to_next_.html">"get-<wbr>boundary-<wbr>beziers-<wbr>to-<wbr>next"</a> </li> <li class=" tsd-kind-external-module"> <a href="_get_branches_.html">"get-<wbr>branches"</a> </li> <li class=" tsd-kind-external-module"> <a href="_get_curve_to_next_.html">"get-<wbr>curve-<wbr>to-<wbr>next"</a> </li> <li class=" tsd-kind-external-module"> <a href="_get_paths_from_str_.html">"get-<wbr>paths-<wbr>from-<wbr>str"</a> </li> <li class=" tsd-kind-external-module"> <a href="_loop_.html">"loop"</a> </li> <li class=" tsd-kind-external-module"> <a href="_mat_.html">"mat"</a> </li> <li class=" tsd-kind-external-module"> <a href="_point_on_shape_.html">"point-<wbr>on-<wbr>shape"</a> </li> <li class=" tsd-kind-external-module"> <a href="_simplify_mat_.html">"simplify-<wbr>mat"</a> </li> <li class=" tsd-kind-external-module"> <a href="_to_scale_axis_.html">"to-<wbr>scale-<wbr>axis"</a> </li> <li class=" tsd-kind-external-module"> <a href="_traverse_edges_.html">"traverse-<wbr>edges"</a> </li> <li class=" tsd-kind-external-module"> <a href="_traverse_vertices_.html">"traverse-<wbr>vertices"</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> <li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"> <a href="_find_mats_.html#findmats" class="tsd-kind-icon">find<wbr>Mats</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>