aboutsummaryrefslogtreecommitdiff
path: root/html/SmootLight.inputs.PygameInput-pysrc.html
blob: dafcbff08d12383af80f0305a10846267acaea7e (plain)
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
<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>SmootLight.inputs.PygameInput</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="SmootLight-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="SmootLight-module.html">Package&nbsp;SmootLight</a> ::
        <a href="SmootLight.inputs-module.html">Package&nbsp;inputs</a> ::
        Module&nbsp;PygameInput
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="SmootLight.inputs.PygameInput-pysrc.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<h1 class="epydoc">Source Code for <a href="SmootLight.inputs.PygameInput-module.html">Module SmootLight.inputs.PygameInput</a></h1>
<pre class="py-src">
<a name="L1"></a><tt class="py-lineno"> 1</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt id="link-0" class="py-name" targets="Function SmootLight.util.TimeOps.time()=SmootLight.util.TimeOps-module.html#time"><a title="SmootLight.util.TimeOps.time" class="py-name" href="#" onclick="return doclink('link-0', 'time', 'link-0');">time</a></tt> </tt>
<a name="L2"></a><tt class="py-lineno"> 2</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt id="link-1" class="py-name" targets="Package SmootLight.util=SmootLight.util-module.html"><a title="SmootLight.util" class="py-name" href="#" onclick="return doclink('link-1', 'util', 'link-1');">util</a></tt><tt class="py-op">.</tt><tt id="link-2" class="py-name" targets="Module SmootLight.util.Strings=SmootLight.util.Strings-module.html"><a title="SmootLight.util.Strings" class="py-name" href="#" onclick="return doclink('link-2', 'Strings', 'link-2');">Strings</a></tt> <tt class="py-keyword">as</tt> <tt id="link-3" class="py-name"><a title="SmootLight.util.Strings" class="py-name" href="#" onclick="return doclink('link-3', 'Strings', 'link-2');">Strings</a></tt> </tt>
<a name="L3"></a><tt class="py-lineno"> 3</tt>  <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-4" class="py-name" targets="Package SmootLight.operationscore=SmootLight.operationscore-module.html"><a title="SmootLight.operationscore" class="py-name" href="#" onclick="return doclink('link-4', 'operationscore', 'link-4');">operationscore</a></tt><tt class="py-op">.</tt><tt id="link-5" class="py-name" targets="Module SmootLight.operationscore.Input=SmootLight.operationscore.Input-module.html,Class SmootLight.operationscore.Input.Input=SmootLight.operationscore.Input.Input-class.html"><a title="SmootLight.operationscore.Input
SmootLight.operationscore.Input.Input" class="py-name" href="#" onclick="return doclink('link-5', 'Input', 'link-5');">Input</a></tt> <tt class="py-keyword">import</tt> <tt class="py-op">*</tt> </tt>
<a name="L4"></a><tt class="py-lineno"> 4</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">pygame</tt> </tt>
<a name="L5"></a><tt class="py-lineno"> 5</tt>  <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-name">pygame</tt><tt class="py-op">.</tt><tt class="py-name">locals</tt> <tt class="py-keyword">import</tt> <tt class="py-op">*</tt> </tt>
<a name="L6"></a><tt class="py-lineno"> 6</tt>  <tt class="py-line"><tt class="py-comment">#This class processes input from an already running pygame instance and passes</tt> </tt>
<a name="L7"></a><tt class="py-lineno"> 7</tt>  <tt class="py-line"><tt class="py-comment">#it to the parent.  This class requires an already running pygame instance.</tt> </tt>
<a name="PygameInput"></a><div id="PygameInput-def"><a name="L8"></a><tt class="py-lineno"> 8</tt> <a class="py-toggle" href="#" id="PygameInput-toggle" onclick="return toggle('PygameInput');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="SmootLight.inputs.PygameInput.PygameInput-class.html">PygameInput</a><tt class="py-op">(</tt><tt class="py-base-class">Input</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="PygameInput-collapsed" style="display:none;" pad="++" indent="++++"></div><div id="PygameInput-expanded"><a name="L9"></a><tt class="py-lineno"> 9</tt>  <tt class="py-line">    <tt class="py-docstring">"""PygameInput is an input tied to the PygameDisplay.  Specify:</tt> </tt>
<a name="L10"></a><tt class="py-lineno">10</tt>  <tt class="py-line"><tt class="py-docstring">    &lt;FollowMouse&gt;True&lt;/FollowMouse&gt; to receive an input every frame specifying the current mouse</tt> </tt>
<a name="L11"></a><tt class="py-lineno">11</tt>  <tt class="py-line"><tt class="py-docstring">    position.</tt> </tt>
<a name="L12"></a><tt class="py-lineno">12</tt>  <tt class="py-line"><tt class="py-docstring">    &lt;Keyboard&gt;True&lt;/Keyboard&gt; to grab keystrokes</tt> </tt>
<a name="L13"></a><tt class="py-lineno">13</tt>  <tt class="py-line"><tt class="py-docstring">    &lt;Clicks&gt;True&lt;/Clicks&gt; to grab clicks.</tt> </tt>
<a name="L14"></a><tt class="py-lineno">14</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L15"></a><tt class="py-lineno">15</tt>  <tt class="py-line"><tt class="py-docstring">    NB: If follow mouse is enabled, PygameInput will not return mouse and keypresses.  You can, however,</tt> </tt>
<a name="L16"></a><tt class="py-lineno">16</tt>  <tt class="py-line"><tt class="py-docstring">    instantiate other PygameInputs in the XML that will capture mouse and keypresses."""</tt> </tt>
<a name="PygameInput.sensingLoop"></a><div id="PygameInput.sensingLoop-def"><a name="L17"></a><tt class="py-lineno">17</tt> <a class="py-toggle" href="#" id="PygameInput.sensingLoop-toggle" onclick="return toggle('PygameInput.sensingLoop');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="SmootLight.inputs.PygameInput.PygameInput-class.html#sensingLoop">sensingLoop</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="PygameInput.sensingLoop-collapsed" style="display:none;" pad="++" indent="++++++++"></div><div id="PygameInput.sensingLoop-expanded"><a name="L18"></a><tt class="py-lineno">18</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-string">'Scale'</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">:</tt> </tt>
<a name="L19"></a><tt class="py-lineno">19</tt>  <tt class="py-line">            <tt id="link-6" class="py-name" targets="Method SmootLight.operationscore.PixelEvent.PixelEvent.scale()=SmootLight.operationscore.PixelEvent.PixelEvent-class.html#scale"><a title="SmootLight.operationscore.PixelEvent.PixelEvent.scale" class="py-name" href="#" onclick="return doclink('link-6', 'scale', 'link-6');">scale</a></tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">[</tt><tt class="py-string">'Scale'</tt><tt class="py-op">]</tt> </tt>
<a name="L20"></a><tt class="py-lineno">20</tt>  <tt class="py-line">        <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L21"></a><tt class="py-lineno">21</tt>  <tt class="py-line">            <tt id="link-7" class="py-name"><a title="SmootLight.operationscore.PixelEvent.PixelEvent.scale" class="py-name" href="#" onclick="return doclink('link-7', 'scale', 'link-6');">scale</a></tt> <tt class="py-op">=</tt> <tt class="py-number">1</tt> </tt>
<a name="L22"></a><tt class="py-lineno">22</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">[</tt><tt class="py-string">'FollowMouse'</tt><tt class="py-op">]</tt><tt class="py-op">:</tt> </tt>
<a name="L23"></a><tt class="py-lineno">23</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-8" class="py-name" targets="Method SmootLight.operationscore.Input.Input.respond()=SmootLight.operationscore.Input.Input-class.html#respond,Method SmootLight.pixelcore.Screen.Screen.respond()=SmootLight.pixelcore.Screen.Screen-class.html#respond"><a title="SmootLight.operationscore.Input.Input.respond
SmootLight.pixelcore.Screen.Screen.respond" class="py-name" href="#" onclick="return doclink('link-8', 'respond', 'link-8');">respond</a></tt><tt class="py-op">(</tt><tt class="py-op">{</tt><tt id="link-9" class="py-name"><a title="SmootLight.util.Strings" class="py-name" href="#" onclick="return doclink('link-9', 'Strings', 'link-2');">Strings</a></tt><tt class="py-op">.</tt><tt id="link-10" class="py-name" targets="Variable SmootLight.util.Strings.LOCATION=SmootLight.util.Strings-module.html#LOCATION"><a title="SmootLight.util.Strings.LOCATION" class="py-name" href="#" onclick="return doclink('link-10', 'LOCATION', 'link-10');">LOCATION</a></tt><tt class="py-op">:</tt> <tt class="py-name">pygame</tt><tt class="py-op">.</tt><tt class="py-name">mouse</tt><tt class="py-op">.</tt><tt class="py-name">get_pos</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">}</tt><tt class="py-op">)</tt> </tt>
<a name="L24"></a><tt class="py-lineno">24</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> </tt>
<a name="L25"></a><tt class="py-lineno">25</tt>  <tt class="py-line">        <tt class="py-keyword">for</tt> <tt class="py-name">event</tt> <tt class="py-keyword">in</tt> <tt class="py-name">pygame</tt><tt class="py-op">.</tt><tt class="py-name">event</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L26"></a><tt class="py-lineno">26</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-name">event</tt><tt class="py-op">.</tt><tt class="py-name">type</tt> <tt class="py-keyword">is</tt> <tt id="link-11" class="py-name" targets="Variable SmootLight.inputs.PygameInput.KEYDOWN=SmootLight.inputs.PygameInput-module.html#KEYDOWN,Variable SmootLight.renderers.PygameRenderer.KEYDOWN=SmootLight.renderers.PygameRenderer-module.html#KEYDOWN"><a title="SmootLight.inputs.PygameInput.KEYDOWN
SmootLight.renderers.PygameRenderer.KEYDOWN" class="py-name" href="#" onclick="return doclink('link-11', 'KEYDOWN', 'link-11');">KEYDOWN</a></tt><tt class="py-op">:</tt> </tt>
<a name="L27"></a><tt class="py-lineno">27</tt>  <tt class="py-line">                <tt class="py-keyword">if</tt> <tt class="py-name">event</tt><tt class="py-op">.</tt><tt class="py-name">key</tt> <tt class="py-op">==</tt> <tt class="py-number">27</tt><tt class="py-op">:</tt> </tt>
<a name="L28"></a><tt class="py-lineno">28</tt>  <tt class="py-line">                    <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-12" class="py-name" targets="Method SmootLight.operationscore.SmootCoreObject.SmootCoreObject.die()=SmootLight.operationscore.SmootCoreObject.SmootCoreObject-class.html#die"><a title="SmootLight.operationscore.SmootCoreObject.SmootCoreObject.die" class="py-name" href="#" onclick="return doclink('link-12', 'die', 'link-12');">die</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L29"></a><tt class="py-lineno">29</tt>  <tt class="py-line">                <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">[</tt><tt class="py-string">'Keyboard'</tt><tt class="py-op">]</tt><tt class="py-op">:</tt> </tt>
<a name="L30"></a><tt class="py-lineno">30</tt>  <tt class="py-line">                    <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L31"></a><tt class="py-lineno">31</tt>  <tt class="py-line">                        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-13" class="py-name"><a title="SmootLight.operationscore.Input.Input.respond
SmootLight.pixelcore.Screen.Screen.respond" class="py-name" href="#" onclick="return doclink('link-13', 'respond', 'link-8');">respond</a></tt><tt class="py-op">(</tt><tt class="py-op">{</tt><tt class="py-string">'Key'</tt><tt class="py-op">:</tt> <tt class="py-name">event</tt><tt class="py-op">.</tt><tt class="py-name">key</tt><tt class="py-op">,</tt> <tt class="py-string">'KeyChar'</tt><tt class="py-op">:</tt> <tt class="py-name">chr</tt><tt class="py-op">(</tt><tt class="py-name">event</tt><tt class="py-op">.</tt><tt class="py-name">key</tt><tt class="py-op">)</tt><tt class="py-op">}</tt><tt class="py-op">)</tt> </tt>
<a name="L32"></a><tt class="py-lineno">32</tt>  <tt class="py-line">                    <tt class="py-keyword">except</tt><tt class="py-op">:</tt> </tt>
<a name="L33"></a><tt class="py-lineno">33</tt>  <tt class="py-line">                        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-14" class="py-name"><a title="SmootLight.operationscore.Input.Input.respond
SmootLight.pixelcore.Screen.Screen.respond" class="py-name" href="#" onclick="return doclink('link-14', 'respond', 'link-8');">respond</a></tt><tt class="py-op">(</tt><tt class="py-op">{</tt><tt class="py-string">'Key'</tt><tt class="py-op">:</tt> <tt class="py-name">event</tt><tt class="py-op">.</tt><tt class="py-name">key</tt><tt class="py-op">}</tt><tt class="py-op">)</tt> </tt>
<a name="L34"></a><tt class="py-lineno">34</tt>  <tt class="py-line">                    <tt class="py-keyword">return</tt> </tt>
<a name="L35"></a><tt class="py-lineno">35</tt>  <tt class="py-line">                <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L36"></a><tt class="py-lineno">36</tt>  <tt class="py-line">                    <tt class="py-name">pygame</tt><tt class="py-op">.</tt><tt class="py-name">event</tt><tt class="py-op">.</tt><tt class="py-name">post</tt><tt class="py-op">(</tt><tt class="py-name">event</tt><tt class="py-op">)</tt> </tt>
<a name="L37"></a><tt class="py-lineno">37</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-name">event</tt><tt class="py-op">.</tt><tt class="py-name">type</tt> <tt class="py-keyword">is</tt> <tt id="link-15" class="py-name" targets="Variable SmootLight.inputs.PygameInput.MOUSEBUTTONDOWN=SmootLight.inputs.PygameInput-module.html#MOUSEBUTTONDOWN,Variable SmootLight.renderers.PygameRenderer.MOUSEBUTTONDOWN=SmootLight.renderers.PygameRenderer-module.html#MOUSEBUTTONDOWN"><a title="SmootLight.inputs.PygameInput.MOUSEBUTTONDOWN
SmootLight.renderers.PygameRenderer.MOUSEBUTTONDOWN" class="py-name" href="#" onclick="return doclink('link-15', 'MOUSEBUTTONDOWN', 'link-15');">MOUSEBUTTONDOWN</a></tt><tt class="py-op">:</tt> </tt>
<a name="L38"></a><tt class="py-lineno">38</tt>  <tt class="py-line">                <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">[</tt><tt class="py-string">'Clicks'</tt><tt class="py-op">]</tt><tt class="py-op">:</tt> </tt>
<a name="L39"></a><tt class="py-lineno">39</tt>  <tt class="py-line">                    <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-16" class="py-name"><a title="SmootLight.operationscore.Input.Input.respond
SmootLight.pixelcore.Screen.Screen.respond" class="py-name" href="#" onclick="return doclink('link-16', 'respond', 'link-8');">respond</a></tt><tt class="py-op">(</tt><tt class="py-op">{</tt><tt id="link-17" class="py-name"><a title="SmootLight.util.Strings" class="py-name" href="#" onclick="return doclink('link-17', 'Strings', 'link-2');">Strings</a></tt><tt class="py-op">.</tt><tt id="link-18" class="py-name"><a title="SmootLight.util.Strings.LOCATION" class="py-name" href="#" onclick="return doclink('link-18', 'LOCATION', 'link-10');">LOCATION</a></tt><tt class="py-op">:</tt> <tt class="py-name">pygame</tt><tt class="py-op">.</tt><tt class="py-name">mouse</tt><tt class="py-op">.</tt><tt class="py-name">get_pos</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">}</tt><tt class="py-op">)</tt> </tt>
<a name="L40"></a><tt class="py-lineno">40</tt>  <tt class="py-line">                <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L41"></a><tt class="py-lineno">41</tt>  <tt class="py-line">                    <tt class="py-name">pygame</tt><tt class="py-op">.</tt><tt class="py-name">event</tt><tt class="py-op">.</tt><tt class="py-name">post</tt><tt class="py-op">(</tt><tt class="py-name">event</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L42"></a><tt class="py-lineno">42</tt>  <tt class="py-line"> </tt><script type="text/javascript">
<!--
expandto(location.href);
// -->
</script>
</pre>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="SmootLight-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Fri Feb 18 16:55:26 2011
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>