core
/
expressed
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
expressed/v_dl/sdk/doc/VisageAR.html

525 lines
7.8 KiB
HTML
Raw Normal View History

work
2023-11-20 16:39:21 +00:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: VisageAR</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Class: VisageAR</h1>
<section>
<header>
<h2>
VisageAR
</h2>
</header>
<article>
<div class="container-overview">
<dt>
<h4 class="name" id="VisageAR"><span class="type-signature"></span>new VisageAR<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
VisageAR <br/><br/>
</div>
<dl class="details">
</dl>
</dd>
</div>
<h3 class="subsection-title">Members</h3>
<dl>
<dt>
<h4 class="name" id="initialize"><span class="type-signature"></span>initialize<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
Initializes Visage AR and sets up rendering and tracking. The video resolution is used for the canvas resolution.
</div>
<dl class="details">
</dl>
</dd>
<dt>
<h4 class="name" id="loadOccluder"><span class="type-signature"></span>loadOccluder<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
Loads the occlusion mask in OBJ format and its material in MTL format. <br><br
</div>
<dl class="details">
</dl>
</dd>
<dt>
<h4 class="name" id="loadObject"><span class="type-signature"></span>loadObject<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
Loads the 3D object and adds it to the main scene to be rendered from the given URL and makes it active. The object should be in OBJ format and the material should be in MTL format. The MTL file should have the same name as the OBJ file. See the <a href="eyewear_model_guide.html">modeling guide</a> on how to prepare models for use with VisageAR.
</div>
<dl class="details">
</dl>
</dd>
<dt>
<h4 class="name" id="clear"><span class="type-signature"></span>clear<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
Clears the scene, 3D objects, pixels buffer and canvas for displaying the frame
</div>
<dl class="details">
</dl>
</dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<dl>
<dt>
<h4 class="name" id="clearOccluder"><span class="type-signature"></span>clearOccluder<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
Clears the current active occlusion mask and removes it from the occlusion scene.
</div>
<dl class="details">
</dl>
</dd>
<dt>
<h4 class="name" id="startTracking"><span class="type-signature"></span>startTracking<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
Starts tracking the face and displaying (rendering) any 3D objects loaded using loadObject() function. Object is overlayed on the face.
</div>
<dl class="details">
</dl>
</dd>
<dt>
<h4 class="name" id="stopTracking"><span class="type-signature"></span>stopTracking<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
Stops tracking.
</div>
<dl class="details">
</dl>
</dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Index</a></h2><h3>Modules</h3><ul><li><a href="module-VisageTrackerUnityPlugin.html">VisageTrackerUnityPlugin</a></li><li><a href="module-VisageAnalyserUnityPlugin.html">VisageAnalyserUnityPlugin</a></li></ul><h3>Classes</h3><ul><li><a href="FaceData.html">FaceData</a></li><li><a href="ScreenSpaceGazeData.html">ScreenSpaceGazeData</a></li><li><a href="VectorFloat.html">VectorFloat</a></li><li><a href="VectorShort.html">VectorShort</a></li><li><a href="VectorString.html">VectorString</a></li><li><a href="VisageFaceAnalyser.html">VisageFaceAnalyser</a></li><li><a href="AnalysisData.html">AnalysisData</a></li><li><a href="FeaturePoint.html">FeaturePoint</a></li><li><a href="FDP.html">FDP</a></li><li><a href="VisageDetector.html">VisageDetector</a></li><li><a href="FaceDataVector.html">FaceDataVector</a></li><li><a href="VSRectVector.html">VSRectVector</a></li><li><a href="VSRect.html">VSRect</a></li><li><a href="VisageGazeTracker.html">VisageGazeTracker</a></li><li><a href="VisageFaceRecognition.html">VisageFaceRecognition</a></li><li><a href="VisageTracker.html">VisageTracker</a></li><li><a href="VisageConfiguration.html">VisageConfiguration</a></li><li><a href="VisageLivenessBlink.html">VisageLivenessBlink</a></li><li><a href="VisageLivenessSmile.html">VisageLivenessSmile</a></li><li><a href="VisageLivenessBrowRaise.html">VisageLivenessBrowRaise</a></li><li><a href="VisageAR.html">VisageAR</a></li></ul><h3>Global</h3><ul><li><a href="global.html#FP_START_GROUP_INDEX">FP_START_GROUP_INDEX</a></li><li><a href="global.html#FP_END_GROUP_INDEX">FP_END_GROUP_INDEX</a></li><li><a href="global.html#FP_NUMBER_OF_GROUPS">FP_NUMBER_OF_GROUPS</a></li><li><a href="global.html#initializeLicenseManager">initializeLicenseManager</a></li><li><a href="global.html#VisageTrackerStatus">VisageTrackerStatus</a></li><li><a href="global.html#VisageTrackerImageFormat">VisageTrackerImageFormat</a></li><li><a href="global.html#VisageTrackerOrigin">VisageTrackerOrigin</a></li><li><a href="global.html#getSDKVersion">getSDKVersion</a></li></ul>
</nav>
<br clear="both">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0</a> on Sat Jul 29 2023 01:38:30 GMT-0000 (GMT)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>