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 / timer.py < prev    next >
Encoding:
Python Source  |  2007-01-11  |  7.6 KB  |  264 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: timer.py,v 1.1.1.1 2004/12/12 14:31:27 mbaas Exp $
  36.  
  37. ## \file timer.py
  38. ## Contains the Timer class.
  39.  
  40. import time
  41. from component import Component
  42. from eventmanager import eventManager
  43. import slots, events
  44.  
  45. # Timer
  46. class Timer(Component):
  47.     """%Timer class that manages the virtual time.
  48.  
  49.     Attributes:
  50.  
  51.     - time (Slot) - Current virtual time
  52.     - timestep - Delta time step
  53.     - duration - Total duration of the animation/simulation
  54.     
  55.     - frame - Current frame number (as float)
  56.     - fps - Frame rate (as float)
  57.     - framecount - Total number of frames (as float)
  58.     
  59.     - clock - Contains the real time (this is a real stop watch)
  60.  
  61.     The actual slot object of each slot attribute can be accessed by appending
  62.     "_slot" the attribute name.
  63.     """
  64.  
  65.     def __init__(self, name="Timer", auto_insert=True):
  66.         Component.__init__(self, name=name, auto_insert=auto_insert)
  67.  
  68.         # The time() value when the clock was started
  69.         self._clock_start  = 0.0
  70.         # This offset is added to the returned clock value. It stores the
  71.         # clock value at the time the clock was stopped
  72.         self._clock_offset = 0.0
  73.         # This flag indicates if the clock is running or not
  74.         self._clock_running = False
  75.  
  76.         self._duration = 1.0
  77.         self._framecount = 25
  78.         self._fps = 25
  79.         self._timestep = 0.04
  80.         
  81.         # Virtual time...
  82.         self.time_slot = slots.DoubleSlot()
  83.         self.addSlot("time", self.time_slot)
  84.  
  85.         eventManager().connect(events.RESET, self)
  86.         
  87.  
  88.     def startClock(self):
  89.         self._clock_start = time.time()
  90.         self._clock_running = True        
  91.  
  92.     def stopClock(self):
  93.         self._clock_offset = self.clock
  94.         self._clock_running = False
  95.  
  96.     def step(self):
  97.         t = self.time_slot.getValue() + self._timestep
  98.         self.time_slot.setValue(t)
  99.         eventManager().event(events.STEP_FRAME)
  100.  
  101.     ## protected:
  102.  
  103.     def onReset(self):
  104.         """Reset callback."""
  105.         self.time = 0.0
  106.         
  107.     # "time" property...
  108.     
  109.     def _getTime(self):
  110.         """Return the current virtual time.
  111.  
  112.         This method is used for retrieving the \a time property.
  113.  
  114.         \return Virtual time (\c float)
  115.         """
  116.         return self.time_slot.getValue()
  117.  
  118.     def _setTime(self, t):
  119.         """Set the virtual time.
  120.  
  121.         This method is used for setting the \a time property.
  122.  
  123.         \param t (\c float) Time value
  124.         """
  125.         self.time_slot.setValue(t)
  126.  
  127.     time = property(_getTime, _setTime, None, "Virtual time")
  128.  
  129.     # "frame" property...
  130.     
  131.     def _getFrame(self):
  132.         """Return the current frame number.
  133.  
  134.         This method is used for retrieving the \a frame property.
  135.  
  136.         \return Frame number (\c float)
  137.         """
  138.         return self.time_slot.getValue()/self._timestep
  139.  
  140.     def _setFrame(self, f):
  141.         """Set the frame number.
  142.  
  143.         This method is used for setting the \a frame property.
  144.  
  145.         \param f (\c float) Frame number
  146.         """
  147.         self.time_slot.setValue(f*self._timestep)
  148.  
  149.     frame = property(_getFrame, _setFrame, None, "Frame number")
  150.  
  151.     # "clock" property...
  152.  
  153.     def _getClock(self):
  154.         """Return the current clock value (real time).
  155.  
  156.         This method is used for retrieving the \a clock property.
  157.  
  158.         \return Real time (\c float)
  159.         """
  160.         if self._clock_running:
  161.             return self._clock_offset + time.time()-self._clock_start
  162.         else:
  163.             return self._clock_offset
  164.  
  165.     def _setClock(self, t):
  166.         """Set the clock value.
  167.  
  168.         This method is used for setting the \a clock property.
  169.  
  170.         \param t (\c float) Time value
  171.         """
  172.         self._clock_offset = float(t)
  173.         self._clock_start = time.time()
  174.  
  175.     clock = property(_getClock, _setClock, None, "Real time")
  176.  
  177.     # "timestep" property...
  178.     
  179.     def _getTimeStep(self):
  180.         """Return the current time step.
  181.  
  182.         This method is used for retrieving the \a timestep property.
  183.  
  184.         \return Time step (\c float)
  185.         """
  186.         return self._timestep
  187.  
  188.     def _setTimeStep(self, dt):
  189.         """Set the time step.
  190.  
  191.         This method is used for setting the \a timestep property.
  192.  
  193.         \param t (\c float) Time value
  194.         """
  195.         self._timestep = float(dt)
  196.  
  197.     timestep = property(_getTimeStep, _setTimeStep, None, "Time step")
  198.  
  199.     # "fps" property...
  200.     
  201.     def _getFPS(self):
  202.         """Return the current frame rate.
  203.  
  204.         This method is used for retrieving the \a fps property.
  205.  
  206.         \return Frame rate (\c float)
  207.         """
  208.         return 1.0/self._timestep
  209.  
  210.     def _setFPS(self, fps):
  211.         """Set the frame rate.
  212.  
  213.         This method is used for setting the \a fps property.
  214.  
  215.         \param fps (\c float) New frame rate
  216.         """
  217.         self._timestep = 1.0/float(fps)
  218.  
  219.     fps = property(_getFPS, _setFPS, None, "Frames per second")
  220.  
  221.     # "duration" property...
  222.     
  223.     def _getDuration(self):
  224.         """Return the duration of the animation/simulation.
  225.  
  226.         This method is used for retrieving the \a duration property.
  227.  
  228.         \return Duration (\c float)
  229.         """
  230.         return self._duration
  231.  
  232.     def _setDuration(self, d):
  233.         """Set the duration.
  234.  
  235.         This method is used for setting the \a duration property.
  236.  
  237.         \param d (\c float) New duration
  238.         """
  239.         self._duration = float(d)
  240.  
  241.     duration = property(_getDuration, _setDuration, None, "Total duration")
  242.  
  243.     # "framecount" property...
  244.     
  245.     def _getFrameCount(self):
  246.         """Return the total number of frames.
  247.  
  248.         This method is used for retrieving the \a framecount property.
  249.  
  250.         \return Total Number of frames (\c float)
  251.         """
  252.         return self._duration/self._timestep
  253.  
  254.     def _setFrameCount(self, n):
  255.         """Set the total number of frames.
  256.  
  257.         This method is used for setting the \a framecount property.
  258.  
  259.         \param n (\c float) Total number of frames
  260.         """
  261.         self._duration = float(n)*self._timestep
  262.  
  263.     framecount = property(_getFrameCount, _setFrameCount, None, "Total number of frames")
  264.