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 / flockofbirds.py < prev    next >
Encoding:
Python Source  |  2007-01-11  |  7.5 KB  |  202 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: flockofbirds.py,v 1.2 2005/07/07 08:24:57 mbaas Exp $
  36.  
  37. ## \file flockofbirds.py
  38. ## Contains the FlockOfBirds class.
  39.  
  40. import types
  41. import component
  42. import eventmanager, events
  43. from slots import *
  44. from cgtypes import *
  45. import fob
  46.  
  47. # FlockOfBirds
  48. class FlockOfBirds(component.Component):
  49.     """Receives tracker values from a Flock of Birds motion tracker.
  50.  
  51.     For each bird the component creates the following four slots:
  52.  
  53.     - \c pos<n>_slot (\c Vec3Slot) - Position
  54.     - \c angle<n>_slot (\c Vec3Slot) - Euler angles
  55.     - \c matrix<n>_slot (\c Mat3Slot) - Rotation matrix
  56.     - \c quat<n>_slot (\c QuatSlot) - Quaternion
  57.  
  58.     where <n> is the number of the bird (1-based). Not all of the slots
  59.     are active at the same time. You can select which slot should carry
  60.     the corresponding value via the bird mode (see constructor).
  61.  
  62.     """
  63.  
  64.     def __init__(self,
  65.                  name = "FlockOfBirds",
  66.                  com_port = 0,
  67.                  baud_rate = 115200,
  68.                  timeout = 2.0,
  69.                  num_birds = 1,
  70.                  bird_mode = "p",
  71.                  hemisphere = "forward",
  72.                  auto_insert = True):
  73.         """Constructor.
  74.  
  75.         The bird mode is one of "p" (position), "a" (angles), "m" (matrix),
  76.         "q" (quaternion) or a combination like "pa", "pm" and "pq".
  77.         The argument \a bird_mode can either be a mode string that will
  78.         be used for all birds, or it can be a list of mode strings for
  79.         every bird.
  80.  
  81.         \param name (\c str) Component name
  82.         \param com_port (\c int) COM port to use for communicating with the flock (0,1,...)
  83.         \param baud_rate (\c int) Baud rate
  84.         \param timeout (\c float) Time out value in seconds for RS232 operations
  85.         \param num_birds (\c int) Number of birds to use (including the ERC)
  86.         \param bird_mode (\c str or \c list) Tracker mode (selects what kind of data the birds will send)
  87.         \param hemisphere (\c str) Hemisphere setting for the transmitter ("forward", "aft", "upper", "lower", "left", "right")
  88.         \param auto_insert (\c bool) True if the component should be inserted into the scene automatically
  89.         """
  90.         
  91.         component.Component.__init__(self, name, auto_insert)
  92.  
  93.         self.com_port = com_port
  94.         self.baud_rate = baud_rate
  95.         self.timeout = timeout
  96.         self.num_birds = num_birds
  97.         self.hemisphere = hemisphere
  98.  
  99.         if isinstance(bird_mode, types.StringTypes):
  100.             self.bird_mode = self.num_birds*[bird_mode]
  101.         else:
  102.             self.bird_mode = bird_mode
  103.  
  104.         self.bird_mode = map(lambda x: x.upper(), self.bird_mode)
  105.  
  106.         if len(self.bird_mode)!=self.num_birds:
  107.             raise ValueError, "%d bird modes expected (got %d)"%(self.num_birds, len(self.bird_mode))
  108.  
  109.         # Create slots
  110.         self._slots = []
  111.         for i in range(self.num_birds):
  112.             p = Vec3Slot()
  113.             a = Vec3Slot()
  114.             m = Mat3Slot(mat3(1))
  115.             q = QuatSlot(quat(1))
  116.             self._slots.append((p,a,m,q))
  117.             setattr(self, "pos%d_slot"%(i+1), p)
  118.             setattr(self, "angle%d_slot"%(i+1), a)
  119.             setattr(self, "matrix%d_slot"%(i+1), m)
  120.             setattr(self, "quat%d_slot"%(i+1), q)
  121.             self.addSlot("pos%d"%(i+1), p)
  122.             self.addSlot("angle%d"%(i+1), a)
  123.             self.addSlot("matrix%d"%(i+1), m)
  124.             self.addSlot("quat%d"%(i+1), q)
  125.  
  126.         # Initialize the FOB...
  127.         
  128.         self._fob = fob.FOB()
  129.         self._fob.open(self.com_port, self.baud_rate, self.timeout)
  130.         
  131.         self._fob.fbbAutoConfig(numbirds=self.num_birds)
  132.         self._fob.fbbReset()
  133.         hs = { "forward":fob.FORWARD,
  134.                "aft":fob.AFT,
  135.                "upper":fob.UPPER,
  136.                "lower":fob.LOWER,
  137.                "left":fob.LEFT,
  138.                "right":fob.RIGHT }
  139.         for i in range(1, self.num_birds):
  140.             self._fob.hemisphere(hs[self.hemisphere.lower()], addr=i+1)
  141.             self.setTrackerMode(self.bird_mode[i], i+1)
  142.         self._fob.run()
  143.         
  144.         eventmanager.eventManager().connect(events.STEP_FRAME, self)
  145.         
  146.  
  147.     ## protected:
  148.  
  149.     def onStepFrame(self):
  150.         # Poll values
  151.         for i in range(1, self.num_birds):
  152.             values = self._fob.point(i+1)
  153.             if values==None:
  154.                 print "No values received from bird %d."%(i+1)                
  155.             else:
  156.                 # 1. Convert values into proper types
  157.                 #    (position, angles, matrix, quat)
  158.                 # 2. Set the values on the corresponding slots
  159. #                print values
  160.                 ps,as,ms,qs = self._slots[i]
  161.                 m = self.bird_mode[i]
  162.                 if m[0]=="P":
  163.                     p = vec3(values[:3])
  164.                     ps.setValue(p)
  165.                 c = m[-1]                    
  166.                 if c=="A":
  167.                     a = vec3(values[-3:])
  168.                     as.setValue(a)
  169.                 elif c=="M":
  170.                     m = mat3(values[-9:])
  171.                     ms.setValue(m)
  172.                 elif c=="Q":
  173.                     q = quat(values[-4:])
  174.                     qs.setValue(q)
  175.                     
  176.  
  177.  
  178.     # setTrackerMode
  179.     def setTrackerMode(self, mode, addr):
  180.         """Issue the appropriate fob command to set the tracker mode.
  181.  
  182.         \param mode (\c str) Tracker mode ("P", "A", "M", "Q", "PA", "PM", "PQ")
  183.         \param addr (\c int) Bird address
  184.         """
  185.         if mode=="P":
  186.             self._fob.position(addr)
  187.         elif mode=="A":
  188.             self._fob.angles(addr)
  189.         elif mode=="M":
  190.             self._fob.matrix(addr)
  191.         elif mode=="Q":
  192.             self._fob.quaternion(addr)
  193.         elif mode=="PA":
  194.             self._fob.position_angles(addr)            
  195.         elif mode=="PM":
  196.             self._fob.position_matrix(addr)
  197.         elif mode=="PQ":
  198.             self._fob.position_quaternion(addr)
  199.         else:
  200.             raise ValueError, "Invalid tracker mode: %s"%mode
  201.         
  202.