panda3d/direct/src/interval/Interval.py

"""Interval module: contains the Interval class"""

from DirectObject import *
import ClockObject
import Task

# Interval events
IVAL_NONE = 0
IVAL_INIT = 1

class Interval(DirectObject):
    """Interval class: Base class for timeline functionality"""

    # create Interval DirectNotify category
    notify = directNotify.newCategory("Interval")
    #notify.setDebug(1)

    # special methods
    
    def __init__(self, name, duration, openEnded = 1):
        """__init__(name, duration)
        """
	self.name = name
	self.duration = duration
	self.clock = ClockObject.ClockObject.getGlobalClock()
	self.curr_t = 0.0
	self.prev_t = 0.0
        self.setTHooks = []
        # Set true if interval responds to setT(t): t>duration
        self.fOpenEnded = openEnded

    def getName(self):
	""" getName()
	"""
	return self.name

    def getDuration(self):
	""" getDuration()
	"""
	return self.duration

    def setfOpenEnded(self, openEnded):
        """ setfOpenEnded(openEnded)
        """
        self.fOpenEnded = openEnded

    def getfOpenEnded(self):
        """ getfOpenEnded()
        """
        return self.fOpenEnded

    def setT(self, t, event = IVAL_NONE):
	""" setT(t, event)
	    Go to time t
	"""
        # Update current time
	self.curr_t = t
        # Perform interval actions
        self.updateFunc(t, event)
        # Call setT Hook
        for func in self.setTHooks:
            func(t)
        # Record t for next time around
        self.prev_t = self.curr_t

    def updateFunc(self, t, event = IVAL_NONE):
        pass

    def setTHook(self, t):
        pass

    def setFinalT(self):
	""" setFinalT()
	"""
	self.setT(self.getDuration(), event=IVAL_NONE)

    def play(self, t0=0.0, duration=0.0, scale=1.0):
        """ play(t0, duration)
        """
        # Kill ongoing play task
        self.stop()
        # Start new one
	self.offset = t0
        self.startT = self.clock.getFrameTime()
	assert(scale > 0.0)
	self.scale = scale
	self.firstTime = 1
        if (duration == 0.0):
            # If no play duration specified, use duration of Interval
            self.endTime = self.duration
        else:
            # Otherwise use min of interval duration and offset + play duration
            self.endTime = min(self.duration, self.offset + duration)
	assert(t0 <= self.endTime)
        taskMgr.spawnMethodNamed(self.__playTask, self.name + '-play')

    def stop(self):
        """ stop()
        """
        taskMgr.removeTasksNamed(self.name + '-play')
	return self.curr_t

    def __playTask(self, task):
        """ __playTask(task)
        """
        t = self.clock.getFrameTime()
        te = self.offset + ((t - self.startT) * self.scale)
        if (te < self.endTime):
	    if (self.firstTime):
		self.setT(te, event = IVAL_INIT)
		self.firstTime = 0
	    else:
            	self.setT(te)
            return Task.cont
        else:
	    self.setT(self.endTime)
            return Task.done

    def __repr__(self, indent=0):
	""" __repr__(indent)
	"""
	space = ''
	for l in range(indent):
	    space = space + ' '
	return (space + self.name + ' dur: %.2f' % self.duration)

    def popupControls(self):
        import fpformat
        import string
        # I moved this here because Toontown does not ship Tk
        from Tkinter import *
        import Pmw
        import EntryScale
        tl = Toplevel()
        tl.title(self.getName() + ' Interval Controls')
        self.es = es = EntryScale.EntryScale(
            tl, text = 'Time',
            min = 0, max = string.atof(fpformat.fix(self.duration, 2)),
            command = lambda t, s = self: s.setT(t))
        es.onRelease = lambda s=self, es = es: s.setT(es.get(),
                                                      event = IVAL_INIT)
        es.onReturnRelease = lambda s=self, es = es: s.setT(es.get(),
                                                            event = IVAL_INIT)
        es.pack(expand = 1, fill = X)
        f = Frame(tl)
        def toStart(s=self, es=es):
            s.stop()
            s.setT(0.0, event = IVAL_INIT)
        def toEnd(s=self):
            s.stop()
            s.setT(s.getDuration(), event = IVAL_INIT)
        jumpToStart = Button(tl, text = '<<', command = toStart)
        stop = Button(tl, text = 'Stop',
                      command = lambda s=self: s.stop())
        play = Button(
            tl, text = 'Play',
            command = lambda s=self, es=es: s.play(es.get()))
        jumpToEnd = Button(tl, text = '>>', command = toEnd)
        jumpToStart.pack(side = LEFT, expand = 1, fill = X)
        play.pack(side = LEFT, expand = 1, fill = X)
        stop.pack(side = LEFT, expand = 1, fill = X)
        jumpToEnd.pack(side = LEFT, expand = 1, fill = X)
        f.pack(expand = 1, fill = X)
        # Add hook to update slider on changes in curr_t
        def update(t,es=es):
            es.set(t, fCommand = 0)
        self.setTHooks.append(update)
        # Clear out hook on destroy
        def onDestroy(e, s=self, u=update):
            if u in s.setTHooks:
                s.setTHooks.remove(u)
        tl.bind('<Destroy>', onDestroy)