home *** CD-ROM | disk | FTP | other *** search
/ Hackers Magazine 57 / CdHackersMagazineNr57.iso / Software / Multimedia / k3d-setup-0.7.11.0.exe / lib / site-packages / cgkit / expression.py < prev    next >
Encoding:
Python Source  |  2007-01-11  |  7.0 KB  |  213 lines
  1. # ***** BEGIN LICENSE BLOCK *****
  2. # Version: MPL 1.1/GPL 2.0/LGPL 2.1
  3. #
  4. # The contents of this file are subject to the Mozilla Public License Version
  5. # 1.1 (the "License"); you may not use this file except in compliance with
  6. # the License. You may obtain a copy of the License at
  7. # http://www.mozilla.org/MPL/
  8. #
  9. # Software distributed under the License is distributed on an "AS IS" basis,
  10. # WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  11. # for the specific language governing rights and limitations under the
  12. # License.
  13. #
  14. # The Original Code is the Python Computer Graphics Kit.
  15. #
  16. # The Initial Developer of the Original Code is Matthias Baas.
  17. # Portions created by the Initial Developer are Copyright (C) 2004
  18. # the Initial Developer. All Rights Reserved.
  19. #
  20. # Contributor(s):
  21. #
  22. # Alternatively, the contents of this file may be used under the terms of
  23. # either the GNU General Public License Version 2 or later (the "GPL"), or
  24. # the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  25. # in which case the provisions of the GPL or the LGPL are applicable instead
  26. # of those above. If you wish to allow use of your version of this file only
  27. # under the terms of either the GPL or the LGPL, and not to allow others to
  28. # use your version of this file under the terms of the MPL, indicate your
  29. # decision by deleting the provisions above and replace them with the notice
  30. # and other provisions required by the GPL or the LGPL. If you do not delete
  31. # the provisions above, a recipient may use your version of this file under
  32. # the terms of any one of the MPL, the GPL or the LGPL.
  33. #
  34. # ***** END LICENSE BLOCK *****
  35. # $Id: expression.py,v 1.3 2005/10/18 07:02:39 mbaas Exp $
  36.  
  37. ## \file expression.py
  38. ## Contains the Expression class.
  39.  
  40. """This module contains the Expression class."""
  41.  
  42. from Interfaces import *
  43. import protocols
  44. import slots
  45. from eventmanager import eventManager
  46. from scene import getScene
  47. import events
  48. from cgtypes import *
  49. from component import *
  50. from sl import *
  51. from math import *
  52. import _core
  53.        
  54.  
  55. # Expression
  56. class Expression(Component):
  57.     """Compute an output value using a user defined expression.
  58.  
  59.     This component outputs a single value that is driven by a user defined
  60.     expression. The expression is specified by a string and can use an
  61.     arbitrary number of parameters. The parameters and their default values
  62.     have to be provided to the constructor via keyword arguments. An exception
  63.     is the special variable "t" which will always hold the current time
  64.     (unless you declare it explicitly).
  65.     For each parameter a slot is created (<name>_slot), so it is also
  66.     possible to animate the parameters. The output value can be accessed via
  67.     the "output" and "output_slot" attributes.
  68.  
  69.     Example:
  70.  
  71.     \code
  72.     s = Sphere()
  73.     e = Expression("1.0 + amp*sin(freq*t)", amp=0.2, freq=2.0)
  74.     e.output_slot.connect(s.radius_slot)
  75.     \endcode
  76.     
  77.     """
  78.  
  79.     protocols.advise(instancesProvide=[ISceneItem])
  80.  
  81.     def __init__(self,
  82.                  expr = "",
  83.                  exprtype = None,
  84.                  name = "Expression",
  85.                  **keyargs
  86.                  ):
  87.         """Constructor.
  88.  
  89.         If no expression type is given the component tries to determine
  90.         the type itself by executing the expression and inspecting the
  91.         return type.
  92.  
  93.         \param expr (\c str) Expression
  94.         \param exprtype (\c str) Output type or None
  95.         \param name (\c str) Component name
  96.         \param keyargs Parameters used in the expression
  97.         """
  98.         Component.__init__(self, name=name)
  99.  
  100.         self.expr = expr
  101.         self.exprtype = exprtype
  102.  
  103.         # Create a parameter slot for every extra key arg...
  104.         for k in keyargs:
  105.             T = type(keyargs[k])
  106.             if T==float or T==int:
  107.                 typ = "double"
  108.                 valstr = str(keyargs[k])
  109.             elif T==vec3:
  110.                 typ = "vec3"
  111.                 x, y, z = keyargs[k]
  112.                 valstr = "vec3(%s, %s, %s)"%(x,y,z)
  113.             elif T==vec4:
  114.                 typ = "vec4"
  115.                 x, y, z, w = keyargs[k]
  116.                 valstr = "vec4(%s, %s, %s, %s)"%(x,y,z,w)
  117.             elif T==mat3:
  118.                 typ = "mat3"
  119.                 valstr = "mat3(%s)"%keyargs[k].toList(rowmajor=True)
  120.             elif T==mat4:
  121.                 typ = "mat4"
  122.                 valstr = "mat4(%s)"%keyargs[k].toList(rowmajor=True)
  123.             elif T==quat:
  124.                 typ = "quat"
  125.                 w, x, y, z = keyargs[k]
  126.                 valstr = "quat(%s, %s, %s, %s)"%(w,x,y,z)
  127.             else:
  128.                 typ = "py"
  129.                 valstr = "keyargs[k]"
  130. #                raise ValueError, "Unsupported type: %s"%T
  131.             # Create slot
  132.             exec "self.%s_slot = %sSlot(%s)"%(k, typ.capitalize(), valstr)
  133.             exec "self.addSlot(k, self.%s_slot)"%k
  134.  
  135.         # If t was not explicitly given use the timer...
  136.         if "t" not in keyargs:
  137.             self.t_slot = DoubleSlot()
  138.             getScene().timer().time_slot.connect(self.t_slot)
  139.             self.addSlot("t", self.t_slot)
  140.  
  141.         # Store a list of all parameter names
  142.         self.vars = keyargs.keys()
  143.         if "t" not in self.vars:
  144.             self.vars.append("t")
  145.  
  146.         if self.exprtype==None:
  147.             self.exprtype = self._determineReturnType()
  148.  
  149.         # Create the output slot
  150.         e = self.exprtype
  151.         if e.lower()=="float":
  152.             e = "double"
  153.         exec "self.output_slot = Procedural%sSlot(self.outProc)"%e.capitalize()
  154.         self.addSlot("output", self.output_slot)
  155.  
  156.         # Create dependencies
  157.         for v in self.vars:
  158.             exec "self.%s_slot.addDependent(self.output_slot)"%(v)
  159.  
  160.             
  161.  
  162.     def protocols(self):
  163.         return [ISceneItem, IComponent]
  164.  
  165.     def outProc(self):
  166.         for _v in self.vars:
  167.             exec "%s = self.%s_slot.getValue()"%(_v, _v)
  168.         return eval("%s(%s)"%(self.exprtype, self.expr))
  169.      
  170.     ## protected:
  171.         
  172.     # "output" property...
  173.     exec slotPropertyCode("output")
  174.  
  175.     def _determineReturnType(self):
  176.         """Try to execute the stored expression and return the output type.
  177.         """
  178.         for _v in self.vars:
  179.             exec "%s = self.%s_slot.getValue()"%(_v, _v)
  180.         out = eval(self.expr)
  181.         T = type(out)
  182.         if T==float or T==int:
  183.             return "float"
  184.         if isinstance(out, _core.vec3):
  185.             return "vec3"
  186.         if isinstance(out, _core.vec4):
  187.             return "vec4"
  188.         if isinstance(out, _core.mat3):
  189.             return "mat3"
  190.         if isinstance(out, _core.mat4):
  191.             return "mat4"
  192.         if isinstance(out, _core.quat):
  193.             return "quat"
  194.  
  195.         if T==tuple or T==list:
  196.             if len(out)==3:
  197.                 return "vec3"
  198.             if len(out)==4:
  199.                 return "vec4"
  200.             if len(out)==9:
  201.                 return "mat3"
  202.             if len(out)==16:
  203.                 return "mat4"
  204.             raise ValueError, "Unsupported sequence size: %d"%len(out)
  205.  
  206.         raise ValueError, "Unknown expression type: %s"%T
  207.         
  208.         
  209.         
  210.  
  211.         
  212.  
  213.