/usr/share/makehuman-doc/html/module_selection.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 | <!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 Selection 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 Transformations Module" href="module_transformations.html" />
<link rel="prev" title="The Module3D Module" href="module_module3d.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-selection">
<span id="the-selection-module"></span><span id="moduleselection"></span><h1>The Selection Module<a class="headerlink" href="#module-selection" title="Permalink to this headline">¶</a></h1>
<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> Glynn Clements</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>TODO</p>
<dl class="class">
<dt id="selection.SelectionColorMap">
<em class="property">class </em><code class="descclassname">selection.</code><code class="descname">SelectionColorMap</code><a class="reference internal" href="_modules/selection.html#SelectionColorMap"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#selection.SelectionColorMap" title="Permalink to this definition">¶</a></dt>
<dd><p>The objects support the use of a technique called <em>Selection Using Unique
Color IDs</em>, that internally uses color-coding of components within the
scene to support the selection of objects by the user using the mouse.</p>
<p>This technique generates a sequence of colors (color IDs), assigning a
unique color to each uniquely selectable object or component in the scene.
These colors are not displayed, but are used by MakeHuman to generates an
unseen image of the various selectable elements. This image uses the same
camera settings currently being used for the actual, on-screen image.
When the mouse is clicked, the position of the mouse is used with the
unseen image to retrieve a color. MakeHuman uses this color as an ID to
identify which object or component the user clicked with the mouse.</p>
<p>This technique uses glReadPixels() to read the single pixel at the
current mouse location, using the unseen, color-coded image.</p>
<p>For further information on this technique, see:</p>
<blockquote>
<div><ul class="simple">
<li><a class="reference external" href="http://www.opengl.org/resources/faq/technical/selection.htm">http://www.opengl.org/resources/faq/technical/selection.htm</a> and</li>
<li><a class="reference external" href="http://wiki.gamedev.net/index.php/OpenGL_Selection_Using_Unique_Color_IDs">http://wiki.gamedev.net/index.php/OpenGL_Selection_Using_Unique_Color_IDs</a></li>
</ul>
</div></blockquote>
<p><strong>Note.</strong> Because the 3D engine uses glDrawElements in a highly opimized
way and each vertex can have only one color ID, there there is a known
problem with selecting individual faces with very small FaceGroups using
this technique. However, this is not a major problem for MakeHuman, which
doesn’t use such low polygon groupings.</p>
<ul class="simple">
<li><strong>self.colorIDToFaceGroup</strong>: <em>Dictionary of colors IDs</em> A dictionary of the color IDs used for
selection (see MakeHuman Selectors, above).</li>
<li><strong>self.colorID</strong>: <em>float list</em> A progressive color ID.</li>
</ul>
<p>The attributes <em>self.colorID</em> and <em>self.colorIDToFaceGroup</em>
support a technique called <em>Selection Using Unique Color IDs</em> to make each
FaceGroup independently clickable.</p>
<p>The attribute <em>self.colorID</em> stores a progressive color that is incremented for each successive
FaceGroup added to the scene.
The <em>self.colorIDToFaceGroup</em> attribute contains a list that serves as a directory to map
each color back to the corresponding FaceGroup by using its color ID.</p>
<dl class="method">
<dt id="selection.SelectionColorMap.assignSelectionID">
<code class="descname">assignSelectionID</code><span class="sig-paren">(</span><em>obj</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/selection.html#SelectionColorMap.assignSelectionID"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#selection.SelectionColorMap.assignSelectionID" title="Permalink to this definition">¶</a></dt>
<dd><p>This method generates a new, unique color ID for each FaceGroup,
within a particular Object3D object, that forms a part of this scene3D
object. This color ID can subsequently be used in a non-displayed
image map to determine the FaceGroup that a mouse click was made in.</p>
<p>This method loops through the FaceGroups, assigning the next color
in the sequence to each subsequent FaceGroup. The color value is
written into a ‘dictionary’ to serve as a color ID that can be
translated back into the corresponding FaceGroup name when a mouse
click is detected.
This is part of a technique called <em>Selection Using Unique Color IDs</em>
to make each FaceGroup independently clickable.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>obj</strong> (<em>module3d.Object 3D</em>) – The object3D object for which color dictionary entries need to be generated.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="selection.SelectionColorMap.getSelectedFaceGroup">
<code class="descname">getSelectedFaceGroup</code><span class="sig-paren">(</span><em>picked</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/selection.html#SelectionColorMap.getSelectedFaceGroup"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#selection.SelectionColorMap.getSelectedFaceGroup" title="Permalink to this definition">¶</a></dt>
<dd><p>This method uses a non-displayed image containing color-coded faces
to return the index of the FaceGroup selected by the user with the mouse.
This is part of a technique called <em>Selection Using Unique Color IDs</em> to make each
FaceGroup independently clickable.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The selected face group.</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="module_module3d.html#module3d.FaceGroup" title="module3d.FaceGroup"><code class="xref py py-class docutils literal"><span class="pre">module3d.FaceGroup</span></code></a></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="selection.SelectionColorMap.getSelectedFaceGroupAndObject">
<code class="descname">getSelectedFaceGroupAndObject</code><span class="sig-paren">(</span><em>picked</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/selection.html#SelectionColorMap.getSelectedFaceGroupAndObject"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#selection.SelectionColorMap.getSelectedFaceGroupAndObject" title="Permalink to this definition">¶</a></dt>
<dd><p>This method determines whether a FaceGroup or a non-selectable zone has been
clicked with the mouse. It returns a tuple, showing the FaceGroup and the parent
Object3D object, or None.
If no object is picked, this method will simply print “no clickable zone.”</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The selected face group and object.</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">(<a class="reference internal" href="module_module3d.html#module3d.FaceGroup" title="module3d.FaceGroup"><code class="xref py py-class docutils literal"><span class="pre">module3d.FaceGroup</span></code></a>, <code class="xref py py-class docutils literal"><span class="pre">module3d.Object3d</span></code>)</td>
</tr>
</tbody>
</table>
</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 Selection 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_module3d.html" title="previous chapter">The Module3D Module</a></li>
<li>Next: <a href="module_transformations.html" title="next chapter">The Transformations 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>
|