/usr/share/makehuman-doc/html/module_guicommon.html is in makehuman-doc 1.1.0~git20150707-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 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 | <!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 Guicommon Module — MakeHuman 1.0 documentation</title>
<link rel="stylesheet" href="_static/default.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
};
</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="top" title="MakeHuman 1.0 documentation" href="index.html" />
<link rel="next" title="The Managed_file Module" href="module_managed_file.html" />
<link rel="prev" title="The Gui3D Module" href="module_gui3d.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="module_managed_file.html" title="The Managed_file Module"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="module_gui3d.html" title="The Gui3D Module"
accesskey="P">previous</a> |</li>
<li><a href="index.html">MakeHuman 1.0 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="module-guicommon">
<span id="the-guicommon-module"></span><span id="moduleguicommon"></span><h1>The Guicommon Module<a class="headerlink" href="#module-guicommon" 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> Manuel Bastioni, Marc Flerackers</p>
<p><strong>Copyright(c):</strong> MakeHuman Team 2001-2015</p>
<p><strong>Licensing:</strong> AGPL3 (<a class="reference external" href="http://www.makehuman.org/doc/node/the_makehuman_application.html">http://www.makehuman.org/doc/node/the_makehuman_application.html</a>)</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>
<p><strong>Coding Standards:</strong> See <a class="reference external" href="http://www.makehuman.org/node/165">http://www.makehuman.org/node/165</a></p>
<div class="section" id="abstract">
<h2>Abstract<a class="headerlink" href="#abstract" title="Permalink to this headline">¶</a></h2>
<p>Common GUI elements extracted from gui3d to minimize coupling with gui backend.</p>
<dl class="class">
<dt id="guicommon.Object">
<em class="property">class </em><tt class="descclassname">guicommon.</tt><tt class="descname">Object</tt><big>(</big><em>mesh, position=[0.0, 0.0, 0.0], visible=True</em><big>)</big><a class="reference internal" href="_modules/guicommon.html#Object"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#guicommon.Object" title="Permalink to this definition">¶</a></dt>
<dd><p>An object on the screen.</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"><ul class="first last simple">
<li><strong>position</strong> (<em>list or tuple</em>) – The position in 3d space.</li>
<li><strong>mesh</strong> – The mesh object.</li>
<li><strong>visible</strong> (<em>Boolean</em>) – Wether the object should be initially visible.</li>
</ul>
</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="guicommon.Object.changeVertexMask">
<tt class="descname">changeVertexMask</tt><big>(</big><em>vertsMask</em><big>)</big><a class="reference internal" href="_modules/guicommon.html#Object.changeVertexMask"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#guicommon.Object.changeVertexMask" title="Permalink to this definition">¶</a></dt>
<dd><p>Apply a face mask to the meshes (original seed mesh, subdivided mesh
and proxied meshes) specified by a vertex mask.
The vertex mask is a list of booleans, one for each vertex, where True
means not masked (visible), and False means masked (hidden).
A face is masked if all of the vertices that define it are masked.</p>
</dd></dl>
<dl class="method">
<dt id="guicommon.Object.clearTexture">
<tt class="descname">clearTexture</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/guicommon.html#Object.clearTexture"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#guicommon.Object.clearTexture" title="Permalink to this definition">¶</a></dt>
<dd><p>This method is used to clear an object’s texture.</p>
</dd></dl>
<dl class="method">
<dt id="guicommon.Object.configureShading">
<tt class="descname">configureShading</tt><big>(</big><em>diffuse=None</em>, <em>bump=None</em>, <em>normal=None</em>, <em>displacement=None</em>, <em>spec=None</em>, <em>vertexColors=None</em><big>)</big><a class="reference internal" href="_modules/guicommon.html#Object.configureShading"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#guicommon.Object.configureShading" title="Permalink to this definition">¶</a></dt>
<dd><p>Configure shader options and set the necessary properties based on
the material configuration of this object.
This can be done without an actual shader being set for this object.
Call this method when changes are made to the material property.</p>
</dd></dl>
<dl class="method">
<dt id="guicommon.Object.getSubdivisionMesh">
<tt class="descname">getSubdivisionMesh</tt><big>(</big><em>update=True</em><big>)</big><a class="reference internal" href="_modules/guicommon.html#Object.getSubdivisionMesh"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#guicommon.Object.getSubdivisionMesh" title="Permalink to this definition">¶</a></dt>
<dd><p>Create or update the Catmull-Clark subdivided (or smoothed) mesh for
this mesh.
This does not change the status of isSubdivided(), use setSubdivided()
for that.</p>
<p>If this mesh is doubled by a proxy, when isProxied() is true, a
subdivision mesh for the proxy is used.</p>
<p>Returns the subdivided mesh data.</p>
</dd></dl>
<dl class="method">
<dt id="guicommon.Object.isSubdivided">
<tt class="descname">isSubdivided</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/guicommon.html#Object.isSubdivided"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#guicommon.Object.isSubdivided" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns whether this mesh is currently set to be subdivided
(or smoothed).</p>
</dd></dl>
<dl class="method">
<dt id="guicommon.Object.setCull">
<tt class="descname">setCull</tt><big>(</big><em>cull</em><big>)</big><a class="reference internal" href="_modules/guicommon.html#Object.setCull"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#guicommon.Object.setCull" title="Permalink to this definition">¶</a></dt>
<dd><p>This method is used to specify whether or not the object is back-face culled.</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>cull</strong> (<em>0 => no culling, >0 => draw front faces, <0 => draw back faces</em>) – Whether and how to cull</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="guicommon.Object.setDepthless">
<tt class="descname">setDepthless</tt><big>(</big><em>depthless</em><big>)</big><a class="reference internal" href="_modules/guicommon.html#Object.setDepthless"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#guicommon.Object.setDepthless" title="Permalink to this definition">¶</a></dt>
<dd><p>This method is used to specify whether or not the object occludes or is occluded
by other objects</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>depthless</strong> (<em>Boolean</em>) – Whether or not the object is occluded or occludes.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="guicommon.Object.setLoc">
<tt class="descname">setLoc</tt><big>(</big><em>locx</em>, <em>locy</em>, <em>locz</em><big>)</big><a class="reference internal" href="_modules/guicommon.html#Object.setLoc"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#guicommon.Object.setLoc" title="Permalink to this definition">¶</a></dt>
<dd><p>This method is used to set the location of the object in the 3D coordinate space of the scene.</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"><ul class="first last simple">
<li><strong>locx</strong> (<em>float</em>) – The x coordinate of the object.</li>
<li><strong>locy</strong> (<em>float</em>) – The y coordinate of the object.</li>
<li><strong>locz</strong> (<em>float</em>) – The z coordinate of the object.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="guicommon.Object.setRot">
<tt class="descname">setRot</tt><big>(</big><em>rx</em>, <em>ry</em>, <em>rz</em><big>)</big><a class="reference internal" href="_modules/guicommon.html#Object.setRot"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#guicommon.Object.setRot" title="Permalink to this definition">¶</a></dt>
<dd><p>This method sets the orientation of the object in the 3D coordinate space of the scene.</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"><ul class="first last simple">
<li><strong>rx</strong> (<em>float</em>) – Rotation around the x-axis.</li>
<li><strong>ry</strong> (<em>float</em>) – Rotation around the y-axis.</li>
<li><strong>rz</strong> (<em>float</em>) – Rotation around the z-axis.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="guicommon.Object.setScale">
<tt class="descname">setScale</tt><big>(</big><em>scale</em>, <em>scaleY=None</em>, <em>scaleZ=1</em><big>)</big><a class="reference internal" href="_modules/guicommon.html#Object.setScale"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#guicommon.Object.setScale" title="Permalink to this definition">¶</a></dt>
<dd><p>This method sets the scale of the object in the 3D coordinate space of
the scene, relative to the initially defined size of the object.</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"><ul class="first last simple">
<li><strong>scale</strong> (<em>float</em>) – Scale along the x-axis, uniform scale if other params not
specified.</li>
<li><strong>scaleY</strong> (<em>float</em>) – Scale along the x-axis.</li>
<li><strong>scaleZ</strong> (<em>float</em>) – Scale along the x-axis.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="guicommon.Object.setShadeless">
<tt class="descname">setShadeless</tt><big>(</big><em>shadeless</em><big>)</big><a class="reference internal" href="_modules/guicommon.html#Object.setShadeless"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#guicommon.Object.setShadeless" title="Permalink to this definition">¶</a></dt>
<dd><p>This method is used to specify whether or not the object is affected by lights.
This is used for certain GUI controls to give them a more 2D type
appearance (predominantly the top bar of GUI controls).</p>
<p>NOTE enabling this option disables the use of the shader configured in the material.</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>shadeless</strong> (<em>Boolean</em>) – Whether or not the object is unaffected by lights.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="guicommon.Object.setShader">
<tt class="descname">setShader</tt><big>(</big><em>shader</em><big>)</big><a class="reference internal" href="_modules/guicommon.html#Object.setShader"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#guicommon.Object.setShader" title="Permalink to this definition">¶</a></dt>
<dd><p>This method is used to specify the shader.</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>shader</strong> (<em>string</em>) – The path to a pair of shader files.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="guicommon.Object.setShaderParameter">
<tt class="descname">setShaderParameter</tt><big>(</big><em>name</em>, <em>value</em><big>)</big><a class="reference internal" href="_modules/guicommon.html#Object.setShaderParameter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#guicommon.Object.setShaderParameter" title="Permalink to this definition">¶</a></dt>
<dd><p>Updates the shader parameters.</p>
</dd></dl>
<dl class="method">
<dt id="guicommon.Object.setSolid">
<tt class="descname">setSolid</tt><big>(</big><em>solid</em><big>)</big><a class="reference internal" href="_modules/guicommon.html#Object.setSolid"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#guicommon.Object.setSolid" title="Permalink to this definition">¶</a></dt>
<dd><p>This method is used to specify whether or not the object is drawn solid or wireframe.</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>solid</strong> (<em>Boolean</em>) – Whether or not the object is drawn solid or wireframe.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="guicommon.Object.setSubdivided">
<tt class="descname">setSubdivided</tt><big>(</big><em>flag</em>, <em>update=True</em><big>)</big><a class="reference internal" href="_modules/guicommon.html#Object.setSubdivided"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#guicommon.Object.setSubdivided" title="Permalink to this definition">¶</a></dt>
<dd><p>Set whether this mesh is to be subdivided (or smoothed).
When set to true, the subdivision mesh is automatically created or
updated.</p>
</dd></dl>
<dl class="method">
<dt id="guicommon.Object.setTexture">
<tt class="descname">setTexture</tt><big>(</big><em>path</em><big>)</big><a class="reference internal" href="_modules/guicommon.html#Object.setTexture"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#guicommon.Object.setTexture" title="Permalink to this definition">¶</a></dt>
<dd><p>This method is used to specify the path of a file on disk containing the object texture.</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"><ul class="first last simple">
<li><strong>path</strong> (<em>str</em>) – The path of a texture file.</li>
<li><strong>cache</strong> (<em>dict</em>) – The texture cache to use.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">The Guicommon Module</a><ul>
<li><a class="reference internal" href="#abstract">Abstract</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="module_gui3d.html"
title="previous chapter">The Gui3D Module</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="module_managed_file.html"
title="next chapter">The Managed_file Module</a></p>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="module_managed_file.html" title="The Managed_file Module"
>next</a> |</li>
<li class="right" >
<a href="module_gui3d.html" title="The Gui3D Module"
>previous</a> |</li>
<li><a href="index.html">MakeHuman 1.0 documentation</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2015, MHteam.
Last updated on August 14, 2015.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
</div>
</body>
</html>
|