blob: eb083d524734931401425f0ac0b9a3fdf6fa43f6 (
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
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
|
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Aim Helper — ARTv2 2.0.1 documentation</title>
<script type="text/javascript" src="../../../_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></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/language_data.js"></script>
<script type="text/javascript" src="../../../_static/js/theme.js"></script>
<link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.html" />
<link rel="next" title="Base Classes" href="base_classes.html" />
<link rel="prev" title="Joint Mover" href="joint_mover.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../../../index.html" class="icon icon-home"> ARTv2
</a>
<div class="version">
2.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../../../installing.html">Installing ARTv2</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../using_rigging_tools.html">Using the Rigging Tools</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../using_anim_tools.html">Using the Animation Tools</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../../../technical_documentation.html">Technical Documentation</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../useful_scripting_commands.html">Useful Scripting Commands</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="components.html">Components</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="components_overview.html">Components Overview</a></li>
<li class="toctree-l3 current"><a class="reference internal" href="base_classes.html">Base Classes</a><ul class="current">
<li class="toctree-l4"><a class="reference internal" href="component_base.html">Component Base Class</a></li>
<li class="toctree-l4"><a class="reference internal" href="rig_asset.html">Assets</a></li>
<li class="toctree-l4"><a class="reference internal" href="joint_mover.html">Joint Mover</a></li>
<li class="toctree-l4 current"><a class="current reference internal" href="#">Aim Helper</a></li>
<li class="toctree-l4"><a class="reference internal" href="pose.html">Pose</a></li>
<li class="toctree-l4"><a class="reference internal" href="template.html">Template</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="component_classes.html">Component Classes</a></li>
<li class="toctree-l3"><a class="reference internal" href="creating_custom_component.html">Creating Your Own Component</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../utilities/utilities.html">Utilities</a></li>
<li class="toctree-l2"><a class="reference internal" href="../rigging_tools/rigging_tools.html">Rigging Tools</a></li>
<li class="toctree-l2"><a class="reference internal" href="../running_tests.html">Running Tests</a></li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../../index.html">ARTv2</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../../index.html">Docs</a> »</li>
<li><a href="../../../technical_documentation.html">Technical Documentation</a> »</li>
<li><a href="components.html">Components</a> »</li>
<li><a href="components_overview.html">Components Overview</a> »</li>
<li>Aim Helper</li>
<li class="wy-breadcrumbs-aside">
<a href="../../../_sources/sections/tech_docs/components/aim_helper.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="aim-helper">
<h1>Aim Helper<a class="headerlink" href="#aim-helper" title="Permalink to this headline">¶</a></h1>
<p><em>Code author: Jeremy Ernst</em></p>
<dl class="class">
<dt id="artv2.components.base_components.aim_helper.AimHelper">
<em class="property">class </em><code class="descname">AimHelper</code><span class="sig-paren">(</span><em>metanode</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/components/base_components/aim_helper.html#AimHelper"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.components.base_components.aim_helper.AimHelper" title="Permalink to this definition">¶</a></dt>
<dd><blockquote>
<div><p>Class that handles toggling aim mode on a component. This class is instantiated on a JointMover object.
Aim mode is a mode that can be toggled that determines whether joints aim at their children when the joint mover
controls are moved or rotated. This setup is done using the joint mover markup tool and setting the attributes it
adds concerning aim mode.</p>
<p>The relevant attributes are:</p>
<blockquote>
<div><ul class="simple">
<li>Can Aim</li>
<li>Aim Joint</li>
<li>Aim Axis</li>
<li>Invert Aim Axis</li>
<li>Up Axis</li>
<li>Maintain Offset</li>
</ul>
</div></blockquote>
<dl class="glossary docutils">
</dl>
</div></blockquote>
<p><strong>Can Aim</strong></p>
<blockquote>
<div>Whether this joint should aim at another joint when aim mode is turned on.</div></blockquote>
<p><strong>Aim Joint</strong></p>
<blockquote>
<div>Which joint this joint should aim at when aim mode is turned on. (This is ignored if Can Aim is False)</div></blockquote>
<p><strong>Aim Axis</strong></p>
<blockquote>
<div>Which axis represents the aim axis. (This is ignored if Can Aim is False)</div></blockquote>
<p><strong>Invert Aim Axis</strong></p>
<blockquote>
<div>If the aim axis should be inverted. (If your aim axis is set to X, but needs to be -X, this would be True)
(This is ignored if Can Aim is False)</div></blockquote>
<p><strong>Up Axis</strong></p>
<blockquote>
<div>The axis of the joint that is closes to the world up axis. (This is ignored if Can Aim is False)</div></blockquote>
<p><strong>Maintain Offset</strong></p>
<blockquote>
<div>This will probably not ever need to be used, but in the case of some special circumstance, this will create the
aim constraint while maintaining offsets.
(This is ignored if Can Aim is False)</div></blockquote>
<dl class="method">
<dt id="artv2.components.base_components.aim_helper.AimHelper.setup_aim_mode">
<code class="descname">setup_aim_mode</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/components/base_components/aim_helper.html#AimHelper.setup_aim_mode"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.components.base_components.aim_helper.AimHelper.setup_aim_mode" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets up the aim constraints on the joint mover controls that have aim mode setup.</p>
</dd></dl>
<dl class="method">
<dt id="artv2.components.base_components.aim_helper.AimHelper.tear_down_aim_mode">
<code class="descname">tear_down_aim_mode</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/components/base_components/aim_helper.html#AimHelper.tear_down_aim_mode"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.components.base_components.aim_helper.AimHelper.tear_down_aim_mode" title="Permalink to this definition">¶</a></dt>
<dd><p>Removes the aim constraints from the joint mover controls.</p>
</dd></dl>
<dl class="method">
<dt id="artv2.components.base_components.aim_helper.AimHelper.toggle_aim_mode">
<code class="descname">toggle_aim_mode</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/artv2/components/base_components/aim_helper.html#AimHelper.toggle_aim_mode"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#artv2.components.base_components.aim_helper.AimHelper.toggle_aim_mode" title="Permalink to this definition">¶</a></dt>
<dd><p>Toggles aim mode on a component. Aim mode determines whether joints aim at their children when the joint
mover controls are moved or rotated. Which joints and their settings are setup using the joint mover markup
tool.</p>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="base_classes.html" class="btn btn-neutral float-right" title="Base Classes" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="joint_mover.html" class="btn btn-neutral float-left" title="Joint Mover" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2018, Jeremy Ernst
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
|