human/typedoc/interfaces/DrawOptions.html

475 lines
23 KiB
HTML

<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>DrawOptions | @vladmandic/human - v2.2.0</title>
<meta name="description" content="Documentation for @vladmandic/human - v2.2.0">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</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.json" 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">@vladmandic/human - v2.2.0</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>
</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="../index.html">@vladmandic/human - v2.2.0</a>
</li>
<li>
<a href="DrawOptions.html">DrawOptions</a>
</li>
</ul>
<h1>Interface DrawOptions</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>Draw Options
Accessed via <code>human.draw.options</code> or provided per each draw method as the drawOptions optional parameter
-color: draw color
-labelColor: color for labels
-shadowColor: optional shadow color for labels
-font: font for labels
-lineHeight: line height for labels, used for multi-line labels,
-lineWidth: width of any lines,
-pointSize: size of any point,
-roundRect: for boxes, round corners by this many pixels,
-drawPoints: should points be drawn,
-drawLabels: should labels be drawn,
-drawBoxes: should boxes be drawn,
-drawPolygons: should polygons be drawn,
-fillPolygons: should drawn polygons be filled,
-useDepth: use z-axis coordinate as color shade,
-useCurves: draw polygons as cures or as lines,
-bufferedOutput: experimental: allows to call draw methods multiple times for each detection and interpolate results between results thus achieving smoother animations</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">DrawOptions</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 ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="DrawOptions.html#bufferedOutput" class="tsd-kind-icon">buffered<wbr>Output</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="DrawOptions.html#color" class="tsd-kind-icon">color</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="DrawOptions.html#drawBoxes" class="tsd-kind-icon">draw<wbr>Boxes</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="DrawOptions.html#drawGaze" class="tsd-kind-icon">draw<wbr>Gaze</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="DrawOptions.html#drawLabels" class="tsd-kind-icon">draw<wbr>Labels</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="DrawOptions.html#drawPoints" class="tsd-kind-icon">draw<wbr>Points</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="DrawOptions.html#drawPolygons" class="tsd-kind-icon">draw<wbr>Polygons</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="DrawOptions.html#fillPolygons" class="tsd-kind-icon">fill<wbr>Polygons</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="DrawOptions.html#font" class="tsd-kind-icon">font</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="DrawOptions.html#labelColor" class="tsd-kind-icon">label<wbr>Color</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="DrawOptions.html#lineHeight" class="tsd-kind-icon">line<wbr>Height</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="DrawOptions.html#lineWidth" class="tsd-kind-icon">line<wbr>Width</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="DrawOptions.html#pointSize" class="tsd-kind-icon">point<wbr>Size</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="DrawOptions.html#roundRect" class="tsd-kind-icon">round<wbr>Rect</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="DrawOptions.html#shadowColor" class="tsd-kind-icon">shadow<wbr>Color</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="DrawOptions.html#useCurves" class="tsd-kind-icon">use<wbr>Curves</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="DrawOptions.html#useDepth" class="tsd-kind-icon">use<wbr>Depth</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="bufferedOutput" class="tsd-anchor"></a>
<h3>buffered<wbr>Output</h3>
<div class="tsd-signature tsd-kind-icon">buffered<wbr>Output<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/human/blob/main/src/draw/draw.ts#L46">draw/draw.ts:46</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="color" class="tsd-anchor"></a>
<h3>color</h3>
<div class="tsd-signature tsd-kind-icon">color<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/human/blob/main/src/draw/draw.ts#L30">draw/draw.ts:30</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="drawBoxes" class="tsd-anchor"></a>
<h3>draw<wbr>Boxes</h3>
<div class="tsd-signature tsd-kind-icon">draw<wbr>Boxes<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/human/blob/main/src/draw/draw.ts#L40">draw/draw.ts:40</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="drawGaze" class="tsd-anchor"></a>
<h3>draw<wbr>Gaze</h3>
<div class="tsd-signature tsd-kind-icon">draw<wbr>Gaze<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/human/blob/main/src/draw/draw.ts#L42">draw/draw.ts:42</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="drawLabels" class="tsd-anchor"></a>
<h3>draw<wbr>Labels</h3>
<div class="tsd-signature tsd-kind-icon">draw<wbr>Labels<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/human/blob/main/src/draw/draw.ts#L39">draw/draw.ts:39</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="drawPoints" class="tsd-anchor"></a>
<h3>draw<wbr>Points</h3>
<div class="tsd-signature tsd-kind-icon">draw<wbr>Points<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/human/blob/main/src/draw/draw.ts#L38">draw/draw.ts:38</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="drawPolygons" class="tsd-anchor"></a>
<h3>draw<wbr>Polygons</h3>
<div class="tsd-signature tsd-kind-icon">draw<wbr>Polygons<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/human/blob/main/src/draw/draw.ts#L41">draw/draw.ts:41</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="fillPolygons" class="tsd-anchor"></a>
<h3>fill<wbr>Polygons</h3>
<div class="tsd-signature tsd-kind-icon">fill<wbr>Polygons<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/human/blob/main/src/draw/draw.ts#L43">draw/draw.ts:43</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="font" class="tsd-anchor"></a>
<h3>font</h3>
<div class="tsd-signature tsd-kind-icon">font<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/human/blob/main/src/draw/draw.ts#L33">draw/draw.ts:33</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="labelColor" class="tsd-anchor"></a>
<h3>label<wbr>Color</h3>
<div class="tsd-signature tsd-kind-icon">label<wbr>Color<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/human/blob/main/src/draw/draw.ts#L31">draw/draw.ts:31</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="lineHeight" class="tsd-anchor"></a>
<h3>line<wbr>Height</h3>
<div class="tsd-signature tsd-kind-icon">line<wbr>Height<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/vladmandic/human/blob/main/src/draw/draw.ts#L34">draw/draw.ts:34</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="lineWidth" class="tsd-anchor"></a>
<h3>line<wbr>Width</h3>
<div class="tsd-signature tsd-kind-icon">line<wbr>Width<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/vladmandic/human/blob/main/src/draw/draw.ts#L35">draw/draw.ts:35</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="pointSize" class="tsd-anchor"></a>
<h3>point<wbr>Size</h3>
<div class="tsd-signature tsd-kind-icon">point<wbr>Size<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/vladmandic/human/blob/main/src/draw/draw.ts#L36">draw/draw.ts:36</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="roundRect" class="tsd-anchor"></a>
<h3>round<wbr>Rect</h3>
<div class="tsd-signature tsd-kind-icon">round<wbr>Rect<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/vladmandic/human/blob/main/src/draw/draw.ts#L37">draw/draw.ts:37</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="shadowColor" class="tsd-anchor"></a>
<h3>shadow<wbr>Color</h3>
<div class="tsd-signature tsd-kind-icon">shadow<wbr>Color<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/human/blob/main/src/draw/draw.ts#L32">draw/draw.ts:32</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="useCurves" class="tsd-anchor"></a>
<h3>use<wbr>Curves</h3>
<div class="tsd-signature tsd-kind-icon">use<wbr>Curves<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/human/blob/main/src/draw/draw.ts#L45">draw/draw.ts:45</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="useDepth" class="tsd-anchor"></a>
<h3>use<wbr>Depth</h3>
<div class="tsd-signature tsd-kind-icon">use<wbr>Depth<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/human/blob/main/src/draw/draw.ts#L44">draw/draw.ts:44</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=" ">
<a href="../index.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-reference">
<a href="../index.html#default" class="tsd-kind-icon">default</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/Human.html" class="tsd-kind-icon">Human</a>
</li>
<li class=" tsd-kind-interface">
<a href="BodyConfig.html" class="tsd-kind-icon">Body<wbr>Config</a>
</li>
<li class=" tsd-kind-interface">
<a href="BodyResult.html" class="tsd-kind-icon">Body<wbr>Result</a>
</li>
<li class=" tsd-kind-interface">
<a href="Config.html" class="tsd-kind-icon">Config</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-interface">
<a href="DrawOptions.html" class="tsd-kind-icon">Draw<wbr>Options</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="DrawOptions.html#bufferedOutput" class="tsd-kind-icon">buffered<wbr>Output</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="DrawOptions.html#color" class="tsd-kind-icon">color</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="DrawOptions.html#drawBoxes" class="tsd-kind-icon">draw<wbr>Boxes</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="DrawOptions.html#drawGaze" class="tsd-kind-icon">draw<wbr>Gaze</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="DrawOptions.html#drawLabels" class="tsd-kind-icon">draw<wbr>Labels</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="DrawOptions.html#drawPoints" class="tsd-kind-icon">draw<wbr>Points</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="DrawOptions.html#drawPolygons" class="tsd-kind-icon">draw<wbr>Polygons</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="DrawOptions.html#fillPolygons" class="tsd-kind-icon">fill<wbr>Polygons</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="DrawOptions.html#font" class="tsd-kind-icon">font</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="DrawOptions.html#labelColor" class="tsd-kind-icon">label<wbr>Color</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="DrawOptions.html#lineHeight" class="tsd-kind-icon">line<wbr>Height</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="DrawOptions.html#lineWidth" class="tsd-kind-icon">line<wbr>Width</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="DrawOptions.html#pointSize" class="tsd-kind-icon">point<wbr>Size</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="DrawOptions.html#roundRect" class="tsd-kind-icon">round<wbr>Rect</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="DrawOptions.html#shadowColor" class="tsd-kind-icon">shadow<wbr>Color</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="DrawOptions.html#useCurves" class="tsd-kind-icon">use<wbr>Curves</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="DrawOptions.html#useDepth" class="tsd-kind-icon">use<wbr>Depth</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface">
<a href="FaceConfig.html" class="tsd-kind-icon">Face<wbr>Config</a>
</li>
<li class=" tsd-kind-interface">
<a href="FaceDescriptionConfig.html" class="tsd-kind-icon">Face<wbr>Description<wbr>Config</a>
</li>
<li class=" tsd-kind-interface">
<a href="FaceDetectorConfig.html" class="tsd-kind-icon">Face<wbr>Detector<wbr>Config</a>
</li>
<li class=" tsd-kind-interface">
<a href="FaceEmotionConfig.html" class="tsd-kind-icon">Face<wbr>Emotion<wbr>Config</a>
</li>
<li class=" tsd-kind-interface">
<a href="FaceIrisConfig.html" class="tsd-kind-icon">Face<wbr>Iris<wbr>Config</a>
</li>
<li class=" tsd-kind-interface">
<a href="FaceMeshConfig.html" class="tsd-kind-icon">Face<wbr>Mesh<wbr>Config</a>
</li>
<li class=" tsd-kind-interface">
<a href="FaceResult.html" class="tsd-kind-icon">Face<wbr>Result</a>
</li>
<li class=" tsd-kind-interface">
<a href="FilterConfig.html" class="tsd-kind-icon">Filter<wbr>Config</a>
</li>
<li class=" tsd-kind-interface">
<a href="GestureConfig.html" class="tsd-kind-icon">Gesture<wbr>Config</a>
</li>
<li class=" tsd-kind-interface">
<a href="HandConfig.html" class="tsd-kind-icon">Hand<wbr>Config</a>
</li>
<li class=" tsd-kind-interface">
<a href="HandResult.html" class="tsd-kind-icon">Hand<wbr>Result</a>
</li>
<li class=" tsd-kind-interface">
<a href="ObjectConfig.html" class="tsd-kind-icon">Object<wbr>Config</a>
</li>
<li class=" tsd-kind-interface">
<a href="ObjectResult.html" class="tsd-kind-icon">Object<wbr>Result</a>
</li>
<li class=" tsd-kind-interface">
<a href="PersonResult.html" class="tsd-kind-icon">Person<wbr>Result</a>
</li>
<li class=" tsd-kind-interface">
<a href="Result.html" class="tsd-kind-icon">Result</a>
</li>
<li class=" tsd-kind-interface">
<a href="SegmentationConfig.html" class="tsd-kind-icon">Segmentation<wbr>Config</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="../index.html#Error" class="tsd-kind-icon">Error</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="../index.html#Events" class="tsd-kind-icon">Events</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="../index.html#GestureResult" class="tsd-kind-icon">Gesture<wbr>Result</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="../index.html#Input" class="tsd-kind-icon">Input</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="../index.html#TensorFlow" class="tsd-kind-icon">Tensor<wbr>Flow</a>
</li>
<li class=" tsd-kind-variable">
<a href="../index.html#defaults" class="tsd-kind-icon">defaults</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<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>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>