/usr/share/makehuman-doc/html/module_algos3d.html is in makehuman-doc 1.1.1-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>The Algos3D Module — MakeHuman 1.0 documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '1.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="shortcut icon" href="_static/favicon.ico"/>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="The Animation3D Module" href="module_animation3d.html" />
<link rel="prev" title="The Main Module" href="module_mhmain.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
</head>
<body role="document">
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="module-algos3d">
<span id="the-algos3d-module"></span><span id="modulealgos3d"></span><h1>The Algos3D Module<a class="headerlink" href="#module-algos3d" title="Permalink to this headline">¶</a></h1>
<p>MakeHuman 3D Transformation functions.</p>
<p><strong>Project Name:</strong> MakeHuman</p>
<p><strong>Product Home Page:</strong> <a class="reference external" href="http://www.makehuman.org/">http://www.makehuman.org/</a></p>
<p><strong>Code Home Page:</strong> <a class="reference external" href="https://bitbucket.org/MakeHuman/makehuman/">https://bitbucket.org/MakeHuman/makehuman/</a></p>
<p><strong>Authors:</strong> Joel Palmius, Marc Flerackers, Jonas Hauquier</p>
<p><strong>Copyright(c):</strong> MakeHuman Team 2001-2017</p>
<p><strong>Licensing:</strong> AGPL3</p>
<blockquote>
<div><p>This file is part of MakeHuman (www.makehuman.org).</p>
<p>This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.</p>
<p>This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.</p>
<p>You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <<a class="reference external" href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>>.</p>
</div></blockquote>
<div class="section" id="abstract">
<h2>Abstract<a class="headerlink" href="#abstract" title="Permalink to this headline">¶</a></h2>
<p>This module contains algorithms used to perform high-level 3D
transformations on the 3D mesh that is used to represent the human
figure in the MakeHuman application.</p>
<p>These currently include:</p>
<blockquote>
<div><ul class="simple">
<li>morphing for anatomical variations</li>
<li>pose deformations</li>
<li>mesh coherency tests (for use during the development cycle)</li>
<li>visualisation functions (for use during the development cycle)</li>
</ul>
</div></blockquote>
<p>This will also be where any future mesh transformation
algorithms will be coded. For example:</p>
<blockquote>
<div><ul class="simple">
<li>collision deformations</li>
<li>etc..</li>
</ul>
</div></blockquote>
<dl class="class">
<dt id="algos3d.Target">
<em class="property">class </em><code class="descclassname">algos3d.</code><code class="descname">Target</code><span class="sig-paren">(</span><em>obj</em>, <em>name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/algos3d.html#Target"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#algos3d.Target" title="Permalink to this definition">¶</a></dt>
<dd><p>This class is used to store morph targets.</p>
</dd></dl>
<dl class="function">
<dt id="algos3d.defaultTargetLicense">
<code class="descclassname">algos3d.</code><code class="descname">defaultTargetLicense</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/algos3d.html#defaultTargetLicense"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#algos3d.defaultTargetLicense" title="Permalink to this definition">¶</a></dt>
<dd><p>Default license for targets, shared for all targets that do not specify
their own custom license, which is useful for saving storage space as this
license is globally referenced by and applies to the majority of targets.</p>
</dd></dl>
<dl class="function">
<dt id="algos3d.getTarget">
<code class="descclassname">algos3d.</code><code class="descname">getTarget</code><span class="sig-paren">(</span><em>obj</em>, <em>targetPath</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/algos3d.html#getTarget"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#algos3d.getTarget" title="Permalink to this definition">¶</a></dt>
<dd><p>This function retrieves a set of translation vectors from a morphing
target file and stores them in a buffer. It is usually only called if
the translation vectors from this file have not yet been buffered during
the current session.</p>
<p>The translation target files contain lists of vertex indices and corresponding
3D translation vectors. The buffer is structured as a list of lists
(a dictionary of dictionaries) indexed using the morph target file name, so:
“targetBuffer[targetPath] = targetData” and targetData is a list of vectors
keyed on their vertex indices.</p>
<p>For example, a translation direction vector
of [0,5.67,2.34] for vertex 345 would be stored using
“targetData[345] = [0,5.67,2.34]”.
If this is taken from target file “foo.target”, then this targetData could be
assigned to the buffer with ‘targetBuffer[“c:/MH/foo.target”] = targetData’.</p>
<dl class="docutils">
<dt>obj:</dt>
<dd><em>3d object</em>. The target object to which the translations are to be applied.
This object is read by this function to define a list of the vertices
affected by this morph target file.</dd>
<dt>targetPath:</dt>
<dd><em>string</em>. The file system path to the file containing the morphing targets.
The precise format of this string will be operating system dependant.</dd>
</dl>
</dd></dl>
<dl class="function">
<dt id="algos3d.loadTranslationTarget">
<code class="descclassname">algos3d.</code><code class="descname">loadTranslationTarget</code><span class="sig-paren">(</span><em>obj, targetPath, morphFactor, faceGroupToUpdateName=None, update=1, calcNorm=1, scale=[1.0, 1.0, 1.0], animatedMesh=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/algos3d.html#loadTranslationTarget"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#algos3d.loadTranslationTarget" title="Permalink to this definition">¶</a></dt>
<dd><p>This function retrieves a set of translation vectors and applies those
translations to the specified vertices of the mesh object. This set of
translations corresponds to a particular morph target file.
If the file has already been loaded into memory then the translation
vectors are read from the target data buffer, otherwise a function is
first called to load the target data from disk into a buffer for
future use.</p>
<p>The translation target files contain lists of vertex indices and corresponding
3D translation vectors. The translation vector for each vertex is multiplied
by a common factor (morphFactor) before being applied to the specified vertex.</p>
<dl class="docutils">
<dt>obj:</dt>
<dd><em>3d object</em>. The target object to which the translations are to be applied.
This object is read and updated by this function.</dd>
<dt>targetPath:</dt>
<dd><em>string</em>. The file system path to the file containing the morphing targets.
The precise format of this string will be operating system dependant.</dd>
<dt>morphFactor:</dt>
<dd><em>float</em>. A factor between 0 and 1 controlling the proportion of the translations
to be applied. If 0 then the object remains unmodified. If 1 the ‘full’ translations
are applied. This parameter would normally be in the range 0-1 but can be greater
than 1 or less than 0 when used to produce extreme deformations (deformations
that extend beyond those modelled by the original artist).</dd>
<dt>faceGroupToUpdateName:</dt>
<dd><em>string</em>. Optional: The name of a single facegroup to be affected by the target.
If specified, then only transformations to faces contained by the specified
facegroup are applied. If not specified, all transformations contained within the
morph target file are applied. This permits a single morph target file to contain
transformations that affect multiple facegroups, but to only be selectively applied
to individual facegroups.</dd>
<dt>update:</dt>
<dd><em>int flag</em>. A flag to indicate whether the update method on the object should be called.</dd>
<dt>calcNorm:</dt>
<dd><em>int flag</em>. A flag to indicate whether the normals are to be recalculated (1/true)
or not (0/false).</dd>
<dt>scale:</dt>
<dd><em>float</em>. Scale the target offsets with this vector. Defaults to unit vector.</dd>
<dt>animatedMesh:</dt>
<dd><em>AnimatedMesh</em>. Posed state of the basemesh with which the target should
be transformed before being applied.</dd>
</dl>
</dd></dl>
<dl class="function">
<dt id="algos3d.refreshCachedTarget">
<code class="descclassname">algos3d.</code><code class="descname">refreshCachedTarget</code><span class="sig-paren">(</span><em>targetPath</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/algos3d.html#refreshCachedTarget"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#algos3d.refreshCachedTarget" title="Permalink to this definition">¶</a></dt>
<dd><p>Invalidate the cache for the specified target, so that it will be reloaded
next time it is requested.
Generally this only has effect if the target was loaded from an ascii file,
not from npz archive.</p>
</dd></dl>
<dl class="function">
<dt id="algos3d.resetObj">
<code class="descclassname">algos3d.</code><code class="descname">resetObj</code><span class="sig-paren">(</span><em>obj</em>, <em>update=None</em>, <em>calcNorm=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/algos3d.html#resetObj"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#algos3d.resetObj" title="Permalink to this definition">¶</a></dt>
<dd><p>This function resets the positions of the vertices of an object to their original base positions.</p>
<dl class="docutils">
<dt>obj:</dt>
<dd><em>3D object</em>. The object whose vertices are to be reset.</dd>
<dt>update:</dt>
<dd><em>int</em>. An indicator to control whether to call the vectors update method.</dd>
<dt>calcNorm:</dt>
<dd><em>int</em>. An indicator to control whether or not the normals should be recalculated</dd>
</dl>
</dd></dl>
<dl class="function">
<dt id="algos3d.saveTranslationTarget">
<code class="descclassname">algos3d.</code><code class="descname">saveTranslationTarget</code><span class="sig-paren">(</span><em>obj</em>, <em>targetPath</em>, <em>groupToSave=None</em>, <em>epsilon=0.001</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/algos3d.html#saveTranslationTarget"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#algos3d.saveTranslationTarget" title="Permalink to this definition">¶</a></dt>
<dd><p>This function analyses an object to determine the differences between the current
set of vertices and the vertices contained in the <em>originalVerts</em> list, writing the
differences out to disk as a morphing target file.</p>
<dl class="docutils">
<dt>obj:</dt>
<dd><em>3d object</em>. The object from which the current set of vertices is to be determined.</dd>
<dt>targetPath:</dt>
<dd><em>string</em>. The file system path to the output file into which the morphing targets
will be written.</dd>
<dt>groupToSave:</dt>
<dd><em>faceGroup</em>. It’s possible to save only the changes made to a specific part of the
mesh object by indicating the face group to save.</dd>
<dt>epsilon:</dt>
<dd><em>float</em>. The distance that a vertex has to have been moved for it to be
considered ‘moved’
by this function. The difference between the original vertex position and
the current vertex position is compared to this value. If that difference is greater
than the value of epsilon, the vertex is considered to have been modified and will be
saved in the output file as a morph target.</dd>
</dl>
</dd></dl>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">The Algos3D Module</a><ul>
<li><a class="reference internal" href="#abstract">Abstract</a></li>
</ul>
</li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li>Previous: <a href="module_mhmain.html" title="previous chapter">The Main Module</a></li>
<li>Next: <a href="module_animation3d.html" title="next chapter">The Animation3D Module</a></li>
</ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
©2017, MHteam.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.5.6</a>
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
</div>
</body>
</html>
|