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 / joystick.py < prev    next >
Encoding:
Python Source  |  2007-01-11  |  7.7 KB  |  257 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: joystick.py,v 1.1.1.1 2004/12/12 14:31:05 mbaas Exp $
  36.  
  37. ## \file joystick.py
  38. ## Contains the Joystick class.
  39.  
  40. from eventmanager import eventManager
  41. from events import *
  42.  
  43. # Joystick
  44. class Joystick:
  45.     """Generic joystick class.
  46.  
  47.     Attributes:
  48.  
  49.     - id
  50.     - name
  51.     - numaxes
  52.     - numhats
  53.     - numballs
  54.     - numbuttons
  55.  
  56.     """
  57.     
  58.     def __init__(self, id, name,
  59.                  numaxes=0, numhats=0, numballs=0, numbuttons=0):
  60.         """Constructor.
  61.  
  62.         \param id (\c int) Device ID (0,1,2...)
  63.         \param name (\c str) The name of the joystick device
  64.         \param numaxes (\c int) The number of axes this joystick has
  65.         \param numhats (\c int) The number of hats this joystick has
  66.         \param numballs (\c int) The number of balls this joystick has
  67.         \param numbuttons (\c int) The number of buttons this joystick has
  68.         """
  69.  
  70.         self.id = id
  71.         self.name = name
  72.         self.numaxes = numaxes
  73.         self.numhats = numhats
  74.         self.numballs = numballs
  75.         self.numbuttons = numbuttons
  76.  
  77.         # Current uncalibrated axis values
  78.         self.axis = numaxes*[0.0]
  79.         # Current hat values
  80.         self.hat = numhats*[(0,0)]
  81.         # Current ball values
  82.         self.ball = numballs*[0.0]
  83.         # Current button states
  84.         self.button = numbuttons*[False]
  85.  
  86.         # Minimum axis values
  87.         self.axis_min = numaxes*[999.0]
  88.         # Maximum axis values
  89.         self.axis_max = numaxes*[-999.0]
  90.         # Middle axis values
  91.         self.axis_mid = numaxes*[0.0]
  92.  
  93.     def __str__(self):
  94.         return '<Joystick id:%d name:"%s" axes:%d hats:%d balls:%d buttons:%d>'%(self.id, self.name, self.numaxes, self.numhats, self.numballs, self.numbuttons)
  95.  
  96.     # getAxis
  97.     def getAxis(self, axis):
  98.         """Return an axis value.
  99.  
  100.         \return Calibrated axis value (\c float).
  101.         """
  102.         if axis>=self.numaxes:
  103.             return 0.0
  104.             
  105.         return self._calibratedAxis(axis, self.axis[axis])
  106.  
  107.     # getHat
  108.     def getHat(self, hat):
  109.         """Return a hat value.
  110.  
  111.         \return A tuple (x, y) (\c int, \c int)
  112.         """
  113.         if hat>=self.numhats:
  114.             return 0,0
  115.         
  116.         return self.hat[hat]
  117.  
  118.     # getBall
  119.     def getBall(self, ball):
  120.         """Return a ball value.
  121.  
  122.         \return Ball value (\c float)
  123.         """
  124.         if ball>=self.numballs:
  125.             return 0.0
  126.         
  127.         return self.ball[ball]
  128.  
  129.     # getButton
  130.     def getButton(self, button):
  131.         """Return a button state.
  132.  
  133.         \return Button state (\c bool)
  134.         """
  135.         if button>=self.numbuttons:
  136.             return False
  137.         
  138.         return self.button[button]
  139.  
  140.     # setAxis
  141.     def setAxis(self, axis, value):
  142.         """Set a new value for a particular axis.
  143.  
  144.         The value is the raw (uncalibrated) value from the joystick.
  145.  
  146.         This method sends a JOYSTICK_AXIS event which contains the
  147.         \em calibrated axis value.
  148.  
  149.         \param axis (\c int) Axis index
  150.         \param value (\c float) Uncalibrated axis value
  151.         
  152.         \todo Sollte diese Methode setRawAxis() heissen?
  153.         """
  154.         self.axis[axis] = value
  155.  
  156.         # Adjust min/max values
  157.         if value<self.axis_min[axis]:
  158.             self.axis_min[axis] = value
  159.         if value>self.axis_max[axis]:
  160.             self.axis_max[axis] = value
  161.         
  162.         e = JoystickAxisEvent(self.id, axis, self._calibratedAxis(axis, value))
  163.         eventManager().event(JOYSTICK_AXIS, e)
  164.  
  165.     # setHat
  166.     def setHat(self, hat, x, y):
  167.         """Set a new value for a particular hat.
  168.  
  169.         This method sends a JOYSTICK_HAT event.
  170.  
  171.         \param hat (\c int) Hat index
  172.         \param x (\c int) X value
  173.         \param y (\c int) Y value        
  174.         """
  175.         self.hat[hat]=(x,y)
  176.         e = JoystickHatEvent(self.id, hat, x, y)
  177.         eventManager().event(JOYSTICK_HAT, e)
  178.  
  179.     # setBall
  180.     def setBall(self, ball, value):
  181.         """Set a new value for a particular ball.
  182.  
  183.         This method sends a JOYSTICK_BALL event.
  184.  
  185.         \param ball (\c int) Ball index
  186.         \param value (\c float) Ball value
  187.         """
  188.         self.ball[ball] = value
  189.         e = JoystickBallEvent(self.id, ball, value)
  190.         eventManager().event(JOYSTICK_BALL, e)
  191.  
  192.     # setButton
  193.     def setButton(self, button, value):
  194.         """Set the state of a particular button.
  195.  
  196.         This method sends either a JOYSTICK_BUTTON_DOWN or
  197.         JOYSTICK_BUTTON_UP event.
  198.  
  199.         \param button (\c int) Button index
  200.         \param value (\c bool) State of the button (True = pressed)
  201.         """
  202.         self.button[button] = value
  203.         e = JoystickButtonEvent(self.id, button)
  204.         if value:
  205.             eventManager().event(JOYSTICK_BUTTON_DOWN, e)                
  206.         else:
  207.             eventManager().event(JOYSTICK_BUTTON_UP, e)
  208.  
  209.     # setAxisMiddle
  210.     def setAxisMiddle(self, axis=None, mid=None):
  211.         """Set the middle position of an axis or all axes.
  212.  
  213.         Sets the joystick position that will be mapped to the value 0.0.
  214.         This means, if the joystick outputs the (uncalibrated) value
  215.         \a mid, then the calibrated value will just be 0.0.
  216.         
  217.         \param axis (\c int) Axis index (None = all axes)
  218.         \param mid (\c float) Middle value (None = take current value)
  219.         """
  220.         if axis==None:
  221.             axes = range(self.numaxes)
  222.         else:
  223.             axes = [axis]
  224.  
  225.         for i in axes:
  226.             if mid==None:
  227.                 mid = self.axis[i]
  228.  
  229.             self.axis_mid[i] = mid
  230.  
  231.     ## protected:
  232.  
  233.     def _calibratedAxis(self, axis, rawvalue):
  234.         """Return the calibrated axis value.
  235.  
  236.         \param axis (\c int) Axis index
  237.         \param rawvalue (\c float) Uncalibrated axis value
  238.         \return Calibrated axis value (\c float).
  239.         """
  240.         amid = self.axis_mid[axis]
  241.         amin = self.axis_min[axis]
  242.         amax = self.axis_max[axis]
  243.         
  244.         if rawvalue<amid:
  245.             d = amid-amin
  246.             if d>0:
  247.                 return (rawvalue-amid)/d
  248.             else:
  249.                 return 0.0
  250.         else:
  251.             d = amax-amid
  252.             if d>0:
  253.                 return (rawvalue-amid)/d
  254.             else:
  255.                 return 0.0
  256.         
  257.