-
Notifications
You must be signed in to change notification settings - Fork 4
/
bge.types.SCA_MouseActuator.html
334 lines (301 loc) · 17.6 KB
/
bge.types.SCA_MouseActuator.html
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
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>SCA_MouseActuator(SCA_IActuator) — Blender Python API</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme_overrides.css" type="text/css" />
<link rel="stylesheet" href="_static/css/version_switch.css" type="text/css" />
<link rel="shortcut icon" href="_static/favicon.ico"/>
<link rel="canonical" href="https://upbge.org/docs/latest/api/bge.types.SCA_MouseActuator.html" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=715c20a1"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/version_switch.js?v=fa006b38"></script>
<script src="_static/js/theme.js"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Blender Python API"
href="_static/opensearch.xml"/>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="SCA_MouseFocusSensor(SCA_MouseSensor)" href="bge.types.SCA_MouseFocusSensor.html" />
<link rel="prev" title="SCA_KeyboardSensor(SCA_ISensor)" href="bge.types.SCA_KeyboardSensor.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">
UPBGE 0.3+ + Blender 4.0.0 Alpha Python API
<img src="_static/upbge_logo.png" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="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="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Application Modules</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="bpy.context.html">Context Access (bpy.context)</a></li>
<li class="toctree-l1"><a class="reference internal" href="bpy.data.html">Data Access (bpy.data)</a></li>
<li class="toctree-l1"><a class="reference internal" href="bpy.msgbus.html">Message Bus (bpy.msgbus)</a></li>
<li class="toctree-l1"><a class="reference internal" href="bpy.ops.html">Operators (bpy.ops)</a></li>
<li class="toctree-l1"><a class="reference internal" href="bpy.types.html">Types (bpy.types)</a></li>
<li class="toctree-l1"><a class="reference internal" href="bpy.utils.html">Utilities (bpy.utils)</a></li>
<li class="toctree-l1"><a class="reference internal" href="bpy.path.html">Path Utilities (bpy.path)</a></li>
<li class="toctree-l1"><a class="reference internal" href="bpy.app.html">Application Data (bpy.app)</a></li>
<li class="toctree-l1"><a class="reference internal" href="bpy.props.html">Property Definitions (bpy.props)</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Game Engine Modules</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="bge.types.html">Game Types (bge.types)</a></li>
<li class="toctree-l1"><a class="reference internal" href="bge.logic.html">Game Logic (bge.logic)</a></li>
<li class="toctree-l1"><a class="reference internal" href="bge.render.html">Rasterizer (bge.render)</a></li>
<li class="toctree-l1"><a class="reference internal" href="bge.texture.html">Video Texture (bge.texture)</a></li>
<li class="toctree-l1"><a class="reference internal" href="bge.texture.html#ffmpeg-video-and-image-status">FFmpeg Video and Image Status</a></li>
<li class="toctree-l1"><a class="reference internal" href="bge.texture.html#image-blending-modes">Image Blending Modes</a></li>
<li class="toctree-l1"><a class="reference internal" href="bge.events.html">Game Keys (bge.events)</a></li>
<li class="toctree-l1"><a class="reference internal" href="bge.constraints.html">Physics Constraints (bge.constraints)</a></li>
<li class="toctree-l1"><a class="reference internal" href="bge.app.html">Application Data (bge.app)</a></li>
<li class="toctree-l1"><a class="reference internal" href="bgui.html">Game GUI (bgui)</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Standalone Modules</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="aud.html">Audio System (aud)</a></li>
<li class="toctree-l1"><a class="reference internal" href="bgl.html">OpenGL Wrapper (bgl)</a></li>
<li class="toctree-l1"><a class="reference internal" href="bl_math.html">Additional Math Functions (bl_math)</a></li>
<li class="toctree-l1"><a class="reference internal" href="blf.html">Font Drawing (blf)</a></li>
<li class="toctree-l1"><a class="reference internal" href="bmesh.html">BMesh Module (bmesh)</a></li>
<li class="toctree-l1"><a class="reference internal" href="bpy_extras.html">Extra Utilities (bpy_extras)</a></li>
<li class="toctree-l1"><a class="reference internal" href="freestyle.html">Freestyle Module (freestyle)</a></li>
<li class="toctree-l1"><a class="reference internal" href="gpu.html">GPU Module (gpu)</a></li>
<li class="toctree-l1"><a class="reference internal" href="gpu_extras.html">GPU Utilities (gpu_extras)</a></li>
<li class="toctree-l1"><a class="reference internal" href="idprop.types.html">ID Property Access (idprop.types)</a></li>
<li class="toctree-l1"><a class="reference internal" href="imbuf.html">Image Buffer (imbuf)</a></li>
<li class="toctree-l1"><a class="reference internal" href="mathutils.html">Math Types & Utilities (mathutils)</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">UPBGE 0.3+ + Blender 4.0.0 Alpha Python API</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="bge.types.html">Game Types (bge.types)</a></li>
<li class="breadcrumb-item active">SCA_MouseActuator(SCA_IActuator)</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="sca-mouseactuator-sca-iactuator">
<h1>SCA_MouseActuator(SCA_IActuator)<a class="headerlink" href="#sca-mouseactuator-sca-iactuator" title="Link to this heading"></a></h1>
<p>base class — <a class="reference internal" href="bge.types.SCA_IActuator.html#bge.types.SCA_IActuator" title="bge.types.SCA_IActuator"><code class="xref py py-class docutils literal notranslate"><span class="pre">SCA_IActuator</span></code></a></p>
<dl class="py class">
<dt class="sig sig-object py" id="bge.types.SCA_MouseActuator">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">bge.types.</span></span><span class="sig-name descname"><span class="pre">SCA_MouseActuator</span></span><a class="headerlink" href="#bge.types.SCA_MouseActuator" title="Link to this definition"></a></dt>
<dd><p>The mouse actuator gives control over the visibility of the mouse cursor and rotates the parent object according to mouse movement.</p>
<dl class="py method">
<dt class="sig sig-object py" id="bge.types.SCA_MouseActuator.reset">
<span class="sig-name descname"><span class="pre">reset</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#bge.types.SCA_MouseActuator.reset" title="Link to this definition"></a></dt>
<dd><p>Undoes the rotation caused by the mouse actuator.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="bge.types.SCA_MouseActuator.visible">
<span class="sig-name descname"><span class="pre">visible</span></span><a class="headerlink" href="#bge.types.SCA_MouseActuator.visible" title="Link to this definition"></a></dt>
<dd><p>The visibility of the mouse cursor.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>boolean</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="bge.types.SCA_MouseActuator.use_axis_x">
<span class="sig-name descname"><span class="pre">use_axis_x</span></span><a class="headerlink" href="#bge.types.SCA_MouseActuator.use_axis_x" title="Link to this definition"></a></dt>
<dd><p>Mouse movement along the x axis effects object rotation.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>boolean</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="bge.types.SCA_MouseActuator.use_axis_y">
<span class="sig-name descname"><span class="pre">use_axis_y</span></span><a class="headerlink" href="#bge.types.SCA_MouseActuator.use_axis_y" title="Link to this definition"></a></dt>
<dd><p>Mouse movement along the y axis effects object rotation.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>boolean</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="bge.types.SCA_MouseActuator.threshold">
<span class="sig-name descname"><span class="pre">threshold</span></span><a class="headerlink" href="#bge.types.SCA_MouseActuator.threshold" title="Link to this definition"></a></dt>
<dd><p>Amount of movement from the mouse required before rotation is triggered.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>list (vector of 2 floats)</p>
</dd>
</dl>
<p>The values in the list should be between 0.0 and 0.5.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="bge.types.SCA_MouseActuator.reset_x">
<span class="sig-name descname"><span class="pre">reset_x</span></span><a class="headerlink" href="#bge.types.SCA_MouseActuator.reset_x" title="Link to this definition"></a></dt>
<dd><p>Mouse is locked to the center of the screen on the x axis.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>boolean</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="bge.types.SCA_MouseActuator.reset_y">
<span class="sig-name descname"><span class="pre">reset_y</span></span><a class="headerlink" href="#bge.types.SCA_MouseActuator.reset_y" title="Link to this definition"></a></dt>
<dd><p>Mouse is locked to the center of the screen on the y axis.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>boolean</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="bge.types.SCA_MouseActuator.object_axis">
<span class="sig-name descname"><span class="pre">object_axis</span></span><a class="headerlink" href="#bge.types.SCA_MouseActuator.object_axis" title="Link to this definition"></a></dt>
<dd><p>The object’s 3D axis to rotate with the mouse movement. ([x, y])</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>list (vector of 2 integers from 0 to 2)</p>
</dd>
</dl>
<ul class="simple">
<li><p>KX_ACT_MOUSE_OBJECT_AXIS_X</p></li>
<li><p>KX_ACT_MOUSE_OBJECT_AXIS_Y</p></li>
<li><p>KX_ACT_MOUSE_OBJECT_AXIS_Z</p></li>
</ul>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="bge.types.SCA_MouseActuator.local_x">
<span class="sig-name descname"><span class="pre">local_x</span></span><a class="headerlink" href="#bge.types.SCA_MouseActuator.local_x" title="Link to this definition"></a></dt>
<dd><p>Rotation caused by mouse movement along the x axis is local.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>boolean</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="bge.types.SCA_MouseActuator.local_y">
<span class="sig-name descname"><span class="pre">local_y</span></span><a class="headerlink" href="#bge.types.SCA_MouseActuator.local_y" title="Link to this definition"></a></dt>
<dd><p>Rotation caused by mouse movement along the y axis is local.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>boolean</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="bge.types.SCA_MouseActuator.sensitivity">
<span class="sig-name descname"><span class="pre">sensitivity</span></span><a class="headerlink" href="#bge.types.SCA_MouseActuator.sensitivity" title="Link to this definition"></a></dt>
<dd><p>The amount of rotation caused by mouse movement along the x and y axis.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>list (vector of 2 floats)</p>
</dd>
</dl>
<p>Negative values invert the rotation.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="bge.types.SCA_MouseActuator.limit_x">
<span class="sig-name descname"><span class="pre">limit_x</span></span><a class="headerlink" href="#bge.types.SCA_MouseActuator.limit_x" title="Link to this definition"></a></dt>
<dd><p>The minimum and maximum angle of rotation caused by mouse movement along the x axis in degrees.
limit_x[0] is minimum, limit_x[1] is maximum.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>list (vector of 2 floats)</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="bge.types.SCA_MouseActuator.limit_y">
<span class="sig-name descname"><span class="pre">limit_y</span></span><a class="headerlink" href="#bge.types.SCA_MouseActuator.limit_y" title="Link to this definition"></a></dt>
<dd><p>The minimum and maximum angle of rotation caused by mouse movement along the y axis in degrees.
limit_y[0] is minimum, limit_y[1] is maximum.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>list (vector of 2 floats)</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="bge.types.SCA_MouseActuator.angle">
<span class="sig-name descname"><span class="pre">angle</span></span><a class="headerlink" href="#bge.types.SCA_MouseActuator.angle" title="Link to this definition"></a></dt>
<dd><p>The current rotational offset caused by the mouse actuator in degrees.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>list (vector of 2 floats)</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="bge.types.SCA_KeyboardSensor.html" class="btn btn-neutral float-left" title="SCA_KeyboardSensor(SCA_ISensor)" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="bge.types.SCA_MouseFocusSensor.html" class="btn btn-neutral float-right" title="SCA_MouseFocusSensor(SCA_MouseSensor)" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright Blender Authors.
<span class="commit">Revision <code><a href=https://projects.blender.org/blender/blender/commit/4fd142408b81>4fd142408b81</a> - 12/09/2023</code>.
</span></p>
</div>
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="document versions">
<ul id="versionwrap" role="presentation">
<li role="presentation">
<span id="version-popover" class="version-btn" tabindex="0" role="button" aria-label="versions selector" aria-haspopup="true" aria-controls="version-vsnlist" aria-disabled="true">
4.0
</span>
<div class="version-dialog" aria-hidden="true">
<div class="version-arrow" aria-hidden="true"></div>
<div class="version-title">Versions</div>
<ul id="version-vsnlist" class="version-list" role="menu" aria-labelledby="version-popover" aria-hidden="true">
<li role="presentation">Loading...</li>
</ul>
</div>
</li>
</ul>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(false);
});
</script>
</body>
</html>