aboutsummaryrefslogtreecommitdiff
path: root/Documentation/build/boneCounter.html
blob: 37c0732494b533e28e350cd2b669ed97877c4a29 (plain) (blame)
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
<!doctype html>


<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    
    <title>ART_BoneCounter &#8212; ARTv2 1.0 documentation</title>
    
    <link rel="stylesheet" href="_static/bizstyle.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>
    <script type="text/javascript" src="_static/bizstyle.js"></script>
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="next" title="ART_BuildProgressUI" href="buildProgress.html" />
    <link rel="prev" title="ART_BakeOffsetsUI" href="bakeOffsets.html" />
    <meta name="viewport" content="width=device-width,initial-scale=1.0">
    <!--[if lt IE 9]>
    <script type="text/javascript" src="_static/css3-mediaqueries.js"></script>
    <![endif]-->
  </head>
  <body role="document">
    <div class="related" role="navigation" aria-label="related navigation">
      <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="buildProgress.html" title="ART_BuildProgressUI"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="bakeOffsets.html" title="ART_BakeOffsetsUI"
             accesskey="P">previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="index.html">ARTv2 1.0 documentation</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="rigTools.html" accesskey="U">Rigging Tools</a> &#187;</li> 
      </ul>
    </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
  <h4>Previous topic</h4>
  <p class="topless"><a href="bakeOffsets.html"
                        title="previous chapter">ART_BakeOffsetsUI</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="buildProgress.html"
                        title="next chapter">ART_BuildProgressUI</a></p>
  <div role="note" aria-label="source link">
    <h3>This Page</h3>
    <ul class="this-page-menu">
      <li><a href="_sources/boneCounter.rst.txt"
            rel="nofollow">Show Source</a></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="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <div class="section" id="module-Interfaces.ART_BoneCounter">
<span id="art-bonecounter"></span><h1>ART_BoneCounter<a class="headerlink" href="#module-Interfaces.ART_BoneCounter" title="Permalink to this headline"></a></h1>
<p>Author: Jeremy Ernst</p>
<dl class="class">
<dt id="Interfaces.ART_BoneCounter.ART_BoneCounter">
<em class="property">class </em><code class="descclassname">Interfaces.ART_BoneCounter.</code><code class="descname">ART_BoneCounter</code><span class="sig-paren">(</span><em>mainUI</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/Interfaces/ART_BoneCounter.html#ART_BoneCounter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#Interfaces.ART_BoneCounter.ART_BoneCounter" title="Permalink to this definition"></a></dt>
<dd><p>This class builds a simple interface that allows a user to see what the total bone count of their asset will be
given the current module settings. It also allows the user to set a bone count target.</p>
<dl class="docutils">
<dt>It can be found on the Rig Creator toolbar with this icon:</dt>
<dd><img alt="_images/boneCounterButton.png" class="first last" src="_images/boneCounterButton.png" />
</dd>
<dt>The interface looks like this:</dt>
<dd><img alt="_images/boneCounter.png" class="first last" src="_images/boneCounter.png" />
</dd>
</dl>
<dl class="method">
<dt id="Interfaces.ART_BoneCounter.ART_BoneCounter.__init__">
<code class="descname">__init__</code><span class="sig-paren">(</span><em>mainUI</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/Interfaces/ART_BoneCounter.html#ART_BoneCounter.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#Interfaces.ART_BoneCounter.ART_BoneCounter.__init__" title="Permalink to this definition"></a></dt>
<dd><p>Instantiates this class, getting the QSettings and calling on the method to build the interface for the tool.</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>mainUI</strong> &#8211; The instance of the Rig Creator UI from which this class was called.</td>
</tr>
</tbody>
</table>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<p class="last">ART_BoneCounter.buildBoneCounterUI</p>
</div>
</dd></dl>

<dl class="method">
<dt id="Interfaces.ART_BoneCounter.ART_BoneCounter.buildBoneCounterUI">
<code class="descname">buildBoneCounterUI</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/Interfaces/ART_BoneCounter.html#ART_BoneCounter.buildBoneCounterUI"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#Interfaces.ART_BoneCounter.ART_BoneCounter.buildBoneCounterUI" title="Permalink to this definition"></a></dt>
<dd><p>Builds the interface for the bone counter tool, which is comprised off a QLineEdit that shows the current
bone count, a QPushButton to launch another simple UI that allows the user to set a bone count target,
and QProgressBar that shows a percentage to target bone count.</p>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<p class="last">ART_BoneCounter.setBoneCountTarget</p>
</div>
</dd></dl>

<dl class="method">
<dt id="Interfaces.ART_BoneCounter.ART_BoneCounter.setBoneCountTarget">
<code class="descname">setBoneCountTarget</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/Interfaces/ART_BoneCounter.html#ART_BoneCounter.setBoneCountTarget"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#Interfaces.ART_BoneCounter.ART_BoneCounter.setBoneCountTarget" title="Permalink to this definition"></a></dt>
<dd><p>Builds a UI that allows the user to set the target bone count.</p>
<blockquote>
<div><img alt="_images/boneCountTarget.png" src="_images/boneCountTarget.png" />
</div></blockquote>
</dd></dl>

<dl class="method">
<dt id="Interfaces.ART_BoneCounter.ART_BoneCounter.setBoneCountTarget_Confirm">
<code class="descname">setBoneCountTarget_Confirm</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/Interfaces/ART_BoneCounter.html#ART_BoneCounter.setBoneCountTarget_Confirm"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#Interfaces.ART_BoneCounter.ART_BoneCounter.setBoneCountTarget_Confirm" title="Permalink to this definition"></a></dt>
<dd><p>Take the QSpinBox value for the new target and refresh the main UI with the new data.</p>
</dd></dl>

<dl class="method">
<dt id="Interfaces.ART_BoneCounter.ART_BoneCounter.updateBoneCount">
<code class="descname">updateBoneCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/Interfaces/ART_BoneCounter.html#ART_BoneCounter.updateBoneCount"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#Interfaces.ART_BoneCounter.ART_BoneCounter.updateBoneCount" title="Permalink to this definition"></a></dt>
<dd><p>Updates the interface based on new module information. Usually triggered when a module has had its settings
changed.</p>
</dd></dl>

</dd></dl>

</div>


          </div>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="related navigation">
      <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="buildProgress.html" title="ART_BuildProgressUI"
             >next</a> |</li>
        <li class="right" >
          <a href="bakeOffsets.html" title="ART_BakeOffsetsUI"
             >previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="index.html">ARTv2 1.0 documentation</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="rigTools.html" >Rigging Tools</a> &#187;</li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
        &#169; Copyright 2017, Jeremy Ernst.
      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.2.
    </div>
  </body>
</html>