<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>JSDoc: Class: FeaturePoint</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: FeaturePoint</h1> <section> <header> <h2> FeaturePoint </h2> </header> <article> <div class="container-overview"> <dt> <h4 class="name" id="FeaturePoint"><span class="type-signature"></span>new FeaturePoint<span class="signature">()</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> Feature point. <br/><br/> This struct represents a feature point definition. If the feature points are defined on a 3D model, each feature point maps to a vertex of the model. The following information is specified per each feature point: - vertex position (an array of 3 floats) - vertex identifier (mesh identifier and vertex index), if the feature point is defined on a 3D model - normalization factors (useful for algorithms that normalize the face, such as facial motion cloning) <br/><br/> <b>Note</b>: After the end of use FeaturePoint object needs to be deleted to release the allocated memory. Example: <pre class="prettyprint source"><code> <script> FeaturePoint = new VisageModule.FeaturePoint(); ... FeaturePoint.delete(); </script> </code></pre> <br/><br/> </div> <dl class="details"> <dt class="tag-see">See:</dt> <dd class="tag-see"> <ul> <li><a href="FDP.html">FDP</a></li> </ul> </dd> </dl> </dd> </div> <h3 class="subsection-title">Members</h3> <dl> <dt> <h4 class="name" id="defined"><span class="type-signature"></span>defined<span class="type-signature"> :number</span></h4> </dt> <dd> <div class="description"> Set with regards to the 3D model used. More information about 3D models used in tracking can be found in <a href="VisageTracker Configuration Manual.pdf">VisageTracker Configuration Manual</a>. <br/><br/> Set to 1 if feature point is defined in the corresponding <i>.fdp</i> file. Otherwise, the feature point should not be used. </div> <h5>Type:</h5> <ul> <li> <span class="param-type">number</span> </li> </ul> <dl class="details"> </dl> </dd> <dt> <h4 class="name" id="detected"><span class="type-signature"></span>detected<span class="type-signature"> :number</span></h4> </dt> <dd> <div class="description"> Set with regards to the tracking algorithm used. <br/><br/> If 1, indicates that the feature point is obtained from a 2D image using the tracking algorithm. 0 indicates that the feature point is estimated from fitting a 3D model onto the detected feature points of the face. <br/><br/> NOTE: This information is returned exclusively within FaceData::featurePoints2D. </div> <h5>Type:</h5> <ul> <li> <span class="param-type">number</span> </li> </ul> <dl class="details"> </dl> </dd> <dt> <h4 class="name" id="quality"><span class="type-signature"></span>quality<span class="type-signature"> :number</span></h4> </dt> <dd> <div class="description"> Information about the accuracy of the tracking algorithm for this feature point in the current frame. <br/><br/> Quality is returned as a value from 0 to 1, where 0 is the worst and 1 is the best quality. If -1 is returned, quality is not estimated. <br/><br/> This information is returned for all feature points' groups except for group 10 (ears) for which the returned value will always be -1. <br/><br/> NOTE: This information is returned exclusively within FaceData::featurePoints2D. </div> <h5>Type:</h5> <ul> <li> <span class="param-type">number</span> </li> </ul> <dl class="details"> </dl> </dd> <dt> <h4 class="name" id="surf"><span class="type-signature"></span>surf<span class="type-signature"> :string</span></h4> </dt> <dd> <div class="description"> Identifier of the polygon mesh (surface) to which the vertex corresponding to the feature point belongs. If the feature points are not defined on a 3D model (e.g. if they represent points in a 2D image), this is not used. </div> <h5>Type:</h5> <ul> <li> <span class="param-type">string</span> </li> </ul> <dl class="details"> </dl> </dd> <dt> <h4 class="name" id="vert"><span class="type-signature"></span>vert<span class="type-signature"> :number</span></h4> </dt> <dd> <div class="description"> Identifier of the vertex to which the vertex corresponding to the feature point belongs. This is the vertex index within the polygon mesh (surface) identified by <a href="FeaturePoint.html#surf">surf</a>. If the feature points are not defined on a 3D model (e.g. if they represent points in a 2D image), this is not used. </div> <h5>Type:</h5> <ul> <li> <span class="param-type">number</span> </li> </ul> <dl class="details"> </dl> </dd> </dl> <h3 class="subsection-title">Methods</h3> <dl> <dt> <h4 class="name" id="getPos"><span class="type-signature"></span>getPos<span class="signature">(position)</span><span class="type-signature"> → {number}</span></h4> </dt> <dd> <div class="description"> Get one of the feature point positions (x,y,z). <br/><br/> x, y, z coordinates of the feature point. If the feature point is 2-dimensional (e.g. feature points in an image) the z coordinate is ignored. </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>position</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last">specifies desired position to get of the pos array, 0 for x, 1 fox y or 2 for z coordinate.</td> </tr> </tbody> </table> <dl class="details"> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">number</span> </dd> </dl> </dd> <dt> <h4 class="name" id="setPos"><span class="type-signature"></span>setPos<span class="signature">(position, value)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> Set one of the feature point positions (x,y,z). <br/><br/> x, y, z coordinates of the feature point. If the feature point is 2-dimensional (e.g. feature points in an image) the z coordinate is ignored. </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>position</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last">specifies desired position to set of the pos array, 0 for x, 1 fox y or 2 for z coordinate.</td> </tr> <tr> <td class="name"><code>value</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last">coordinate value.</td> </tr> </tbody> </table> <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:28 GMT-0000 (GMT) </footer> <script> prettyPrint(); </script> <script src="scripts/linenumber.js"> </script> </body> </html>