<?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.FlowControl.FunctionController</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> <a href="VisionEgg-module.html">Home</a> </th> <!-- Tree link --> <th> <a href="module-tree.html">Trees</a> </th> <!-- Index link --> <th> <a href="identifier-index.html">Indices</a> </th> <!-- Help link --> <th> <a href="help.html">Help</a> </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 VisionEgg</a> :: <a href="VisionEgg.FlowControl-module.html">Module FlowControl</a> :: Class FunctionController </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 >] | <a href="VisionEgg.FlowControl.FunctionController-class.html" target="_top">no frames</a>]</span></td></tr> </table> </td> </tr> </table> <!-- ==================== CLASS DESCRIPTION ==================== --> <h1 class="epydoc">Class FunctionController</h1><span class="codelink"><a href="VisionEgg.FlowControl-pysrc.html#FunctionController">source code</a></span><br /><br /> <pre class="base-tree"> object --+ | <a href="VisionEgg.FlowControl.Controller-class.html">Controller</a> --+ | <strong class="uidshort">FunctionController</strong> </pre> <hr /> <pre class="literalblock"> Set parameters using a Python function. This is a very commonly used subclass of Controller, because it is very intuitive and requires a minimum of code to set up. Many of the Vision Egg demo programs create instances of FunctionController. A number of parameters are passed to the function depending on the value of temporal_variables: The function can make use of temporal variables, which are made available by passingkeyword argument(s) depending on the controller's temporal_variables attribute. Note that only the absolute temporal variables are available when the go loop is not running. flag(s) present argument description ----------------- -------- ---------------------------------- TIME_SEC_ABSOLUTE t_abs seconds, continuously increasing TIME_SEC_SINCE_GO t seconds, reset to 0.0 each go loop FRAMES_ABSOLUTE f_abs frames, continuously increasing FRAMES_SINCE_GO f frames, reset to 0 each go loop </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"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a href="VisionEgg.FlowControl.FunctionController-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">during_go_func</span>=<span class="summary-sig-default">None</span>, <span class="summary-sig-arg">between_go_func</span>=<span class="summary-sig-default">None</span>, <span class="summary-sig-arg">**kw</span>)</span><br /> Create an instance of FunctionController.</td> <td align="right" valign="top"> <span class="codelink"><a href="VisionEgg.FlowControl-pysrc.html#FunctionController.__init__">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a href="VisionEgg.FlowControl.FunctionController-class.html#during_go_eval" class="summary-sig-name">during_go_eval</a>(<span class="summary-sig-arg">self</span>)</span><br /> Called by Presentation.</td> <td align="right" valign="top"> <span class="codelink"><a href="VisionEgg.FlowControl-pysrc.html#FunctionController.during_go_eval">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a href="VisionEgg.FlowControl.FunctionController-class.html#between_go_eval" class="summary-sig-name">between_go_eval</a>(<span class="summary-sig-arg">self</span>)</span><br /> Called by Presentation.</td> <td align="right" valign="top"> <span class="codelink"><a href="VisionEgg.FlowControl-pysrc.html#FunctionController.between_go_eval">source 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.FlowControl.Controller-class.html">Controller</a></code></b>: <code><a href="VisionEgg.FlowControl.Controller-class.html#evaluate_now">evaluate_now</a></code>, <code><a href="VisionEgg.FlowControl.Controller-class.html#returns_type">returns_type</a></code>, <code><a href="VisionEgg.FlowControl.Controller-class.html#set_eval_frequency">set_eval_frequency</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 colspan="2" class="summary"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="VisionEgg.FlowControl.Controller-class.html">Controller</a></code></b>: <code><a href="VisionEgg.FlowControl.Controller-class.html#EVERY_FRAME">EVERY_FRAME</a></code>, <code><a href="VisionEgg.FlowControl.Controller-class.html#FRAMES_ABSOLUTE">FRAMES_ABSOLUTE</a></code>, <code><a href="VisionEgg.FlowControl.Controller-class.html#FRAMES_SINCE_GO">FRAMES_SINCE_GO</a></code>, <code><a href="VisionEgg.FlowControl.Controller-class.html#NEVER">NEVER</a></code>, <code><a href="VisionEgg.FlowControl.Controller-class.html#NOT_BETWEEN_GO">NOT_BETWEEN_GO</a></code>, <code><a href="VisionEgg.FlowControl.Controller-class.html#NOT_DURING_GO">NOT_DURING_GO</a></code>, <code><a href="VisionEgg.FlowControl.Controller-class.html#ONCE">ONCE</a></code>, <code><a href="VisionEgg.FlowControl.Controller-class.html#TIME_INDEPENDENT">TIME_INDEPENDENT</a></code>, <code><a href="VisionEgg.FlowControl.Controller-class.html#TIME_SEC_ABSOLUTE">TIME_SEC_ABSOLUTE</a></code>, <code><a href="VisionEgg.FlowControl.Controller-class.html#TIME_SEC_SINCE_GO">TIME_SEC_SINCE_GO</a></code>, <code><a href="VisionEgg.FlowControl.Controller-class.html#TRANSITIONS">TRANSITIONS</a></code>, <code><a href="VisionEgg.FlowControl.Controller-class.html#flag_dictionary">flag_dictionary</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">during_go_func</span>=<span class="sig-default">None</span>, <span class="sig-arg">between_go_func</span>=<span class="sig-default">None</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.FlowControl-pysrc.html#FunctionController.__init__">source code</a></span> </td> </table> <pre class="literalblock"> Create an instance of FunctionController. Arguments: during_go_func -- function evaluted during go loop between_go_func -- function evaluted not during go loop </pre> <dl class="fields"> <dt>Overrides: <a href="VisionEgg.FlowControl.Controller-class.html#__init__">Controller.__init__</a> </dt> </dl> </td></tr></table> </div> <a name="during_go_eval"></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">during_go_eval</span>(<span class="sig-arg">self</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="VisionEgg.FlowControl-pysrc.html#FunctionController.during_go_eval">source code</a></span> </td> </table> <pre class="literalblock"> Called by Presentation. Overrides method in Controller base class. </pre> <dl class="fields"> <dt>Overrides: <a href="VisionEgg.FlowControl.Controller-class.html#during_go_eval">Controller.during_go_eval</a> </dt> </dl> </td></tr></table> </div> <a name="between_go_eval"></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">between_go_eval</span>(<span class="sig-arg">self</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="VisionEgg.FlowControl-pysrc.html#FunctionController.between_go_eval">source code</a></span> </td> </table> <pre class="literalblock"> Called by Presentation. Overrides method in Controller base class. </pre> <dl class="fields"> <dt>Overrides: <a href="VisionEgg.FlowControl.Controller-class.html#between_go_eval">Controller.between_go_eval</a> </dt> </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> <a href="VisionEgg-module.html">Home</a> </th> <!-- Tree link --> <th> <a href="module-tree.html">Trees</a> </th> <!-- Index link --> <th> <a href="identifier-index.html">Indices</a> </th> <!-- Help link --> <th> <a href="help.html">Help</a> </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>