aboutsummaryrefslogtreecommitdiff
path: root/html/SmootLight.operationscore.PixelEvent-pysrc.html
blob: 6e8b9c06e3b7dfcbbaf5d39cfdfe2bbf12e56dc5 (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
<?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.operationscore.PixelEvent</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.operationscore-module.html">Package&nbsp;operationscore</a> ::
        Module&nbsp;PixelEvent
      </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.operationscore.PixelEvent-pysrc.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<h1 class="epydoc">Source Code for <a href="SmootLight.operationscore.PixelEvent-module.html">Module SmootLight.operationscore.PixelEvent</a></h1>
<pre class="py-src">
<a name="L1"></a><tt class="py-lineno"> 1</tt>  <tt class="py-line"><tt class="py-docstring">"""PixelEvent is a class defining a light response.  Inheriting classes should define state,</tt> </tt>
<a name="L2"></a><tt class="py-lineno"> 2</tt>  <tt class="py-line"><tt class="py-docstring">which should return a color, or None if the response is complete.  Consider</tt> </tt>
<a name="L3"></a><tt class="py-lineno"> 3</tt>  <tt class="py-line"><tt class="py-docstring">requiring a generate event."""</tt> </tt>
<a name="L4"></a><tt class="py-lineno"> 4</tt>  <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-0" class="py-name" targets="Package SmootLight.operationscore=SmootLight.operationscore-module.html"><a title="SmootLight.operationscore" class="py-name" href="#" onclick="return doclink('link-0', 'operationscore', 'link-0');">operationscore</a></tt><tt class="py-op">.</tt><tt id="link-1" class="py-name" targets="Module SmootLight.operationscore.SmootCoreObject=SmootLight.operationscore.SmootCoreObject-module.html,Class SmootLight.operationscore.SmootCoreObject.SmootCoreObject=SmootLight.operationscore.SmootCoreObject.SmootCoreObject-class.html"><a title="SmootLight.operationscore.SmootCoreObject
SmootLight.operationscore.SmootCoreObject.SmootCoreObject" class="py-name" href="#" onclick="return doclink('link-1', 'SmootCoreObject', 'link-1');">SmootCoreObject</a></tt> <tt class="py-keyword">import</tt> <tt class="py-op">*</tt> </tt>
<a name="L5"></a><tt class="py-lineno"> 5</tt>  <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-2" class="py-name" targets="Package SmootLight.pixelevents=SmootLight.pixelevents-module.html"><a title="SmootLight.pixelevents" class="py-name" href="#" onclick="return doclink('link-2', 'pixelevents', 'link-2');">pixelevents</a></tt><tt class="py-op">.</tt><tt id="link-3" class="py-name" targets="Module SmootLight.pixelevents.StepEvent=SmootLight.pixelevents.StepEvent-module.html,Class SmootLight.pixelevents.StepEvent.StepEvent=SmootLight.pixelevents.StepEvent.StepEvent-class.html"><a title="SmootLight.pixelevents.StepEvent
SmootLight.pixelevents.StepEvent.StepEvent" class="py-name" href="#" onclick="return doclink('link-3', 'StepEvent', 'link-3');">StepEvent</a></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-keyword">import</tt> <tt id="link-4" class="py-name" targets="Package SmootLight.util=SmootLight.util-module.html"><a title="SmootLight.util" class="py-name" href="#" onclick="return doclink('link-4', 'util', 'link-4');">util</a></tt><tt class="py-op">.</tt><tt id="link-5" class="py-name" targets="Module SmootLight.util.ColorOps=SmootLight.util.ColorOps-module.html"><a title="SmootLight.util.ColorOps" class="py-name" href="#" onclick="return doclink('link-5', 'ColorOps', 'link-5');">ColorOps</a></tt> <tt class="py-keyword">as</tt> <tt class="py-name">color</tt> </tt>
<a name="PixelEvent"></a><div id="PixelEvent-def"><a name="L7"></a><tt class="py-lineno"> 7</tt> <a class="py-toggle" href="#" id="PixelEvent-toggle" onclick="return toggle('PixelEvent');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="SmootLight.operationscore.PixelEvent.PixelEvent-class.html">PixelEvent</a><tt class="py-op">(</tt><tt class="py-base-class">SmootCoreObject</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="PixelEvent-collapsed" style="display:none;" pad="++" indent="++++"></div><div id="PixelEvent-expanded"><a name="PixelEvent.init"></a><div id="PixelEvent.init-def"><a name="L8"></a><tt class="py-lineno"> 8</tt> <a class="py-toggle" href="#" id="PixelEvent.init-toggle" onclick="return toggle('PixelEvent.init');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="SmootLight.operationscore.PixelEvent.PixelEvent-class.html#init">init</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="PixelEvent.init-collapsed" style="display:none;" pad="++" indent="++++++++"></div><div id="PixelEvent.init-expanded"><a name="L9"></a><tt class="py-lineno"> 9</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-6" class="py-name" targets="Method SmootLight.operationscore.SmootCoreObject.SmootCoreObject.validateArgs()=SmootLight.operationscore.SmootCoreObject.SmootCoreObject-class.html#validateArgs"><a title="SmootLight.operationscore.SmootCoreObject.SmootCoreObject.validateArgs" class="py-name" href="#" onclick="return doclink('link-6', 'validateArgs', 'link-6');">validateArgs</a></tt><tt class="py-op">(</tt><tt class="py-string">'PixelEvent.params'</tt><tt class="py-op">)</tt> </tt>
<a name="L10"></a><tt class="py-lineno">10</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-7" class="py-name" targets="Method SmootLight.operationscore.PixelEvent.PixelEvent.initEvent()=SmootLight.operationscore.PixelEvent.PixelEvent-class.html#initEvent,Method SmootLight.pixelevents.DecayEvent.DecayEvent.initEvent()=SmootLight.pixelevents.DecayEvent.DecayEvent-class.html#initEvent,Method SmootLight.pixelevents.SingleFrameEvent.SingleFrameEvent.initEvent()=SmootLight.pixelevents.SingleFrameEvent.SingleFrameEvent-class.html#initEvent,Method SmootLight.pixelevents.StepEvent.StepEvent.initEvent()=SmootLight.pixelevents.StepEvent.StepEvent-class.html#initEvent,Method SmootLight.pixelevents.SynchTestEvent.SynchTestEvent.initEvent()=SmootLight.pixelevents.SynchTestEvent.SynchTestEvent-class.html#initEvent"><a title="SmootLight.operationscore.PixelEvent.PixelEvent.initEvent
SmootLight.pixelevents.DecayEvent.DecayEvent.initEvent
SmootLight.pixelevents.SingleFrameEvent.SingleFrameEvent.initEvent
SmootLight.pixelevents.StepEvent.StepEvent.initEvent
SmootLight.pixelevents.SynchTestEvent.SynchTestEvent.initEvent" class="py-name" href="#" onclick="return doclink('link-7', 'initEvent', 'link-7');">initEvent</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="PixelEvent.initEvent"></a><div id="PixelEvent.initEvent-def"><a name="L11"></a><tt class="py-lineno">11</tt> <a class="py-toggle" href="#" id="PixelEvent.initEvent-toggle" onclick="return toggle('PixelEvent.initEvent');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="SmootLight.operationscore.PixelEvent.PixelEvent-class.html#initEvent">initEvent</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="PixelEvent.initEvent-collapsed" style="display:none;" pad="++" indent="++++++++"></div><div id="PixelEvent.initEvent-expanded"><a name="L12"></a><tt class="py-lineno">12</tt>  <tt class="py-line">        <tt class="py-keyword">pass</tt> </tt>
</div><a name="L13"></a><tt class="py-lineno">13</tt>  <tt class="py-line">    <tt class="py-comment">#Returns  a new PixelEvent, but with a response scaled by c.</tt> </tt>
<a name="PixelEvent.scale"></a><div id="PixelEvent.scale-def"><a name="L14"></a><tt class="py-lineno">14</tt> <a class="py-toggle" href="#" id="PixelEvent.scale-toggle" onclick="return toggle('PixelEvent.scale');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="SmootLight.operationscore.PixelEvent.PixelEvent-class.html#scale">scale</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt><tt class="py-param">c</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="PixelEvent.scale-collapsed" style="display:none;" pad="++" indent="++++++++"></div><div id="PixelEvent.scale-expanded"><a name="L15"></a><tt class="py-lineno">15</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">c</tt> <tt class="py-op">==</tt> <tt class="py-number">1</tt><tt class="py-op">:</tt> </tt>
<a name="L16"></a><tt class="py-lineno">16</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> <tt class="py-name">self</tt> </tt>
<a name="L17"></a><tt class="py-lineno">17</tt>  <tt class="py-line">        <tt class="py-name">newDict</tt> <tt class="py-op">=</tt> <tt class="py-name">dict</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-8" class="py-name" targets="Variable SmootLight.util.PacketComposition.argDict=SmootLight.util.PacketComposition-module.html#argDict"><a title="SmootLight.util.PacketComposition.argDict" class="py-name" href="#" onclick="return doclink('link-8', 'argDict', 'link-8');">argDict</a></tt><tt class="py-op">)</tt>  </tt>
<a name="L18"></a><tt class="py-lineno">18</tt>  <tt class="py-line">        <tt class="py-name">newDict</tt><tt class="py-op">[</tt><tt class="py-string">'Color'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">color</tt><tt class="py-op">.</tt><tt id="link-9" class="py-name" targets="Function SmootLight.util.ColorOps.multiplyColor()=SmootLight.util.ColorOps-module.html#multiplyColor"><a title="SmootLight.util.ColorOps.multiplyColor" class="py-name" href="#" onclick="return doclink('link-9', 'multiplyColor', 'link-9');">multiplyColor</a></tt><tt class="py-op">(</tt><tt class="py-name">newDict</tt><tt class="py-op">[</tt><tt class="py-string">'Color'</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-name">c</tt><tt class="py-op">)</tt> </tt>
<a name="L19"></a><tt class="py-lineno">19</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__class__</tt><tt class="py-op">(</tt><tt class="py-name">newDict</tt><tt class="py-op">)</tt> </tt>
</div><a name="PixelEvent.state"></a><div id="PixelEvent.state-def"><a name="L20"></a><tt class="py-lineno">20</tt> <a class="py-toggle" href="#" id="PixelEvent.state-toggle" onclick="return toggle('PixelEvent.state');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="SmootLight.operationscore.PixelEvent.PixelEvent-class.html#state">state</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt><tt class="py-param">timeDelay</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="PixelEvent.state-collapsed" style="display:none;" pad="++" indent="++++++++"></div><div id="PixelEvent.state-expanded"><a name="L21"></a><tt class="py-lineno">21</tt>  <tt class="py-line">        <tt class="py-keyword">pass</tt> </tt>
</div><a name="L22"></a><tt class="py-lineno">22</tt>  <tt class="py-line">    <tt class="py-decorator">@</tt><tt class="py-decorator">staticmethod</tt>  </tt>
<a name="PixelEvent.addPixelEventIfMissing"></a><div id="PixelEvent.addPixelEventIfMissing-def"><a name="L23"></a><tt class="py-lineno">23</tt> <a class="py-toggle" href="#" id="PixelEvent.addPixelEventIfMissing-toggle" onclick="return toggle('PixelEvent.addPixelEventIfMissing');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="SmootLight.operationscore.PixelEvent.PixelEvent-class.html#addPixelEventIfMissing">addPixelEventIfMissing</a><tt class="py-op">(</tt><tt class="py-param">responseDict</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="PixelEvent.addPixelEventIfMissing-collapsed" style="display:none;" pad="++" indent="++++++++"></div><div id="PixelEvent.addPixelEventIfMissing-expanded"><a name="L24"></a><tt class="py-lineno">24</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-string">'PixelEvent'</tt> <tt class="py-keyword">in</tt> <tt class="py-name">responseDict</tt><tt class="py-op">:</tt> </tt>
<a name="L25"></a><tt class="py-lineno">25</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-string">'Color'</tt> <tt class="py-keyword">in</tt> <tt class="py-name">responseDict</tt><tt class="py-op">:</tt> </tt>
<a name="L26"></a><tt class="py-lineno">26</tt>  <tt class="py-line">                <tt class="py-name">color</tt> <tt class="py-op">=</tt> <tt class="py-name">responseDict</tt><tt class="py-op">[</tt><tt class="py-string">'Color'</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">else</tt><tt class="py-op">:</tt> </tt>
<a name="L28"></a><tt class="py-lineno">28</tt>  <tt class="py-line">                <tt class="py-keyword">raise</tt> <tt class="py-name">Exception</tt><tt class="py-op">(</tt><tt class="py-string">'Need Color.  Probably'</tt><tt class="py-op">)</tt> </tt>
<a name="L29"></a><tt class="py-lineno">29</tt>  <tt class="py-line">            <tt class="py-name">responseDict</tt><tt class="py-op">[</tt><tt class="py-string">'PixelEvent'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt id="link-10" class="py-name"><a title="SmootLight.pixelevents.StepEvent
SmootLight.pixelevents.StepEvent.StepEvent" class="py-name" href="#" onclick="return doclink('link-10', 'StepEvent', 'link-3');">StepEvent</a></tt><tt class="py-op">.</tt><tt id="link-11" class="py-name" targets="Static Method SmootLight.pixelevents.DecayEvent.DecayEvent.generate()=SmootLight.pixelevents.DecayEvent.DecayEvent-class.html#generate,Static Method SmootLight.pixelevents.StepEvent.StepEvent.generate()=SmootLight.pixelevents.StepEvent.StepEvent-class.html#generate"><a title="SmootLight.pixelevents.DecayEvent.DecayEvent.generate
SmootLight.pixelevents.StepEvent.StepEvent.generate" class="py-name" href="#" onclick="return doclink('link-11', 'generate', 'link-11');">generate</a></tt><tt class="py-op">(</tt><tt class="py-number">300</tt><tt class="py-op">,</tt> <tt class="py-name">color</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L30"></a><tt class="py-lineno">30</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:27 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>