Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > b4347e6708d280a7ffb2b5b2ea3cdb9d > files > 265

visionegg-1.1.1-3mdv2010.0.i586.rpm

<?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>VisionEgg.Dots.DotArea2D</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="VisionEgg-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>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://www.visionegg.org">Vision Egg</a></th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="VisionEgg-module.html">Package&nbsp;VisionEgg</a> ::
        <a href="VisionEgg.Dots-module.html">Module&nbsp;Dots</a> ::
        Class&nbsp;DotArea2D
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="VisionEgg.Dots.DotArea2D-class.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class DotArea2D</h1><span class="codelink"><a href="VisionEgg.Dots-pysrc.html#DotArea2D">source&nbsp;code</a></span><br /><br />
<pre class="base-tree">
         object --+        
                  |        
<a href="VisionEgg.ClassWithParameters-class.html">ClassWithParameters</a> --+    
                      |    
          <a href="VisionEgg.Core.Stimulus-class.html">Core.Stimulus</a> --+
                          |
                         <strong class="uidshort">DotArea2D</strong>
</pre>

<hr />
<pre class="literalblock">
Random dots of constant velocity

Every dot has the same velocity. Some fraction of the dots all
move in the one direction, while the rest move in random
directions. Dots wrap around edges. Each dot has a lifespan.

This is just one example of the endless variations on drawing random dots.

Parameters
==========
anchor                  -- (String)
                           Default: center
anti_aliasing           -- (Boolean)
                           Default: True
color                   -- (AnyOf(Sequence3 of Real or Sequence4 of Real))
                           Default: (1.0, 1.0, 1.0)
depth                   -- (Real)
                           Default: (determined at runtime)
dot_lifespan_sec        -- (Real)
                           Default: 5.0
dot_size                -- (Real)
                           Default: 4.0
on                      -- (Boolean)
                           Default: True
position                -- (Sequence2 of Real)
                           Default: (320.0, 240.0)
signal_direction_deg    -- (Real)
                           Default: 90.0
signal_fraction         -- (Real)
                           Default: 0.5
size                    -- (Sequence2 of Real)
                           Default: (300.0, 300.0)
velocity_pixels_per_sec -- (Real)
                           Default: 10.0

Constant Parameters
===================
num_dots -- (UnsignedInteger)
            Default: 100

</pre><br /><br />

<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Instance Methods</span></td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="VisionEgg.Dots.DotArea2D-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">**kw</span>)</span><br />
      Instantiate and get ready to draw.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="VisionEgg.Dots-pysrc.html#DotArea2D.__init__">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="VisionEgg.Dots.DotArea2D-class.html#draw" class="summary-sig-name">draw</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Draw the stimulus.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="VisionEgg.Dots-pysrc.html#DotArea2D.draw">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="VisionEgg.ClassWithParameters-class.html">ClassWithParameters</a></code></b>:
      <code><a href="VisionEgg.ClassWithParameters-class.html#__getstate__">__getstate__</a></code>,
      <code><a href="VisionEgg.ClassWithParameters-class.html#__setstate__">__setstate__</a></code>,
      <code><a href="VisionEgg.ClassWithParameters-class.html#get_specified_type">get_specified_type</a></code>,
      <code><a href="VisionEgg.ClassWithParameters-class.html#is_constant_parameter">is_constant_parameter</a></code>,
      <code><a href="VisionEgg.ClassWithParameters-class.html#set">set</a></code>,
      <code><a href="VisionEgg.ClassWithParameters-class.html#verify_parameters">verify_parameters</a></code>
      </p>
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__delattr__</code>,
      <code>__getattribute__</code>,
      <code>__hash__</code>,
      <code>__new__</code>,
      <code>__reduce__</code>,
      <code>__reduce_ex__</code>,
      <code>__repr__</code>,
      <code>__setattr__</code>,
      <code>__str__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== CLASS VARIABLES ==================== -->
<a name="section-ClassVariables"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Class Variables</span></td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="VisionEgg.Dots.DotArea2D-class.html#parameters_and_defaults" class="summary-name">parameters_and_defaults</a> = <code title="{'on':(True, ve_types.Boolean), 'position':((320.0, 240.0), ve_types.S\
equence2(ve_types.Real)), 'anchor':('center', ve_types.String), 'size'\
:((300.0, 300.0), ve_types.Sequence2(ve_types.Real)), 'signal_fraction\
':(0.5, ve_types.Real), 'signal_direction_deg':(90.0, ve_types.Real), \
'velocity_pixels_per_sec':(10.0, ve_types.Real), 'dot_lifespan_sec':(5\
.0, ve_types.Real), 'color':((1.0, 1.0, 1.0), ve_types.AnyOf(ve_types.\
Sequence3(ve_types.Real), ve_types.Sequence4(ve_types.Real))), 'dot_si\
ze':(4.0, ve_types.Real), 'anti_aliasing':(True, ve_types.Boolean), 'd\
...">{'on':(True, ve_types.Boolean), 'pos<code class="variable-ellipsis">...</code></code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="VisionEgg.Dots.DotArea2D-class.html#constant_parameters_and_defaults" class="summary-name">constant_parameters_and_defaults</a> = <code title="{'num_dots':(100, ve_types.UnsignedInteger),}">{'num_dots':(100, ve_types.<code class="variable-ellipsis">...</code></code>
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="VisionEgg.ClassWithParameters-class.html">ClassWithParameters</a></code></b>:
      <code><a href="VisionEgg.ClassWithParameters-class.html#__safe_for_unpickling__">__safe_for_unpickling__</a></code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Properties</span></td>
</tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__class__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Method Details</span></td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">**kw</span>)</span>
    <br /><em class="fname">(Constructor)</em>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="VisionEgg.Dots-pysrc.html#DotArea2D.__init__">source&nbsp;code</a></span>&nbsp;
    </td>
  </table>
  
  <pre class="literalblock">
Instantiate and get ready to draw.

Set parameter values and create anything needed to draw the
stimulus including OpenGL state variables such display lists
and texture objects.

</pre>
  <dl class="fields">
    <dt>Overrides:
      <a href="VisionEgg.Core.Stimulus-class.html#__init__">Core.Stimulus.__init__</a>
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="draw"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">draw</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="VisionEgg.Dots-pysrc.html#DotArea2D.draw">source&nbsp;code</a></span>&nbsp;
    </td>
  </table>
  
  <pre class="literalblock">
Draw the stimulus. (Called by Viewport instance.)

This method is called every frame.  This method actually
performs the OpenGL calls to draw the stimulus.

</pre>
  <dl class="fields">
    <dt>Overrides:
      <a href="VisionEgg.Core.Stimulus-class.html#draw">Core.Stimulus.draw</a>
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== CLASS VARIABLE DETAILS ==================== -->
<a name="section-ClassVariableDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Class Variable Details</span></td>
</tr>
</table>
<a name="parameters_and_defaults"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">parameters_and_defaults</h3>
  
  <dl class="fields">
  </dl>
  <dl class="fields">
    <dt>Value:</dt>
      <dd><table><tr><td><pre class="variable">
{'on':(True, ve_types.Boolean), 'position':((320.0, 240.0), ve_types.S<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
equence2(ve_types.Real)), 'anchor':('center', ve_types.String), 'size'<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
:((300.0, 300.0), ve_types.Sequence2(ve_types.Real)), 'signal_fraction<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
':(0.5, ve_types.Real), 'signal_direction_deg':(90.0, ve_types.Real), <span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
'velocity_pixels_per_sec':(10.0, ve_types.Real), 'dot_lifespan_sec':(5<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
.0, ve_types.Real), 'color':((1.0, 1.0, 1.0), ve_types.AnyOf(ve_types.<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
Sequence3(ve_types.Real), ve_types.Sequence4(ve_types.Real))), 'dot_si<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
ze':(4.0, ve_types.Real), 'anti_aliasing':(True, ve_types.Boolean), 'd<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
<code class="variable-ellipsis">...</code>
</pre></td></tr></table>
</dd>
  </dl>
</td></tr></table>
</div>
<a name="constant_parameters_and_defaults"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">constant_parameters_and_defaults</h3>
  
  <dl class="fields">
  </dl>
  <dl class="fields">
    <dt>Value:</dt>
      <dd><table><tr><td><pre class="variable">
{'num_dots':(100, ve_types.UnsignedInteger),}
</pre></td></tr></table>
</dd>
  </dl>
</td></tr></table>
</div>
<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="VisionEgg-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>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://www.visionegg.org">Vision Egg</a></th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0beta1 on Sat Jun  7 15:40:10 2008
    </td>
    <td align="right" class="footer">
      <a 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>