root/trunk/RBSkinning/RBSkinning/wxTools/GLViewSetup.py

#!/usr/bin/env python
##~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
##~ License 
##~ 
##- The RuneBlade Foundation library is intended to ease some 
##- aspects of writing intricate Jabber, XML, and User Interface (wxPython, etc.) 
##- applications, while providing the flexibility to modularly change the 
##- architecture. Enjoy.
##~ 
##~ Copyright (C) 2002  TechGame Networks, LLC.
##~ 
##~ This library is free software; you can redistribute it and/or
##~ modify it under the terms of the BSD style License as found in the 
##~ LICENSE file included with this distribution.
##~ 
##~ TechGame Networks, LLC can be reached at:
##~ 3578 E. Hartsel Drive #211
##~ Colorado Springs, Colorado, USA, 80920
##~
##~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#~ Imports 
#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

from __future__ import division
import time
from wxPython import wx
from RBFoundation.SubObs.Event import ObjectEventSubject, ObjectEventProperty

#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#~ Definitions 
#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

class InorderObjectEventSubject(ObjectEventSubject):
    prepend = False
class InorderObjectEventProperty(ObjectEventProperty):
    EventFactory = InorderObjectEventSubject

#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

class GLViewSetup(object):
    #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    #~ Constants / Variables / Etc. 
    #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

    OnRender = InorderObjectEventProperty() #(glviewsetup, canvas)
    OnRenderingError = ObjectEventProperty() #(glviewsetup, error)
    _PendingRefresh = False

    #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    #~ Public Methods
    #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

    def __init__(self, canvas, fps=33):
        self.canvas = canvas

        timerId = wx.wxNewId()
        timerOwner = self.canvas.GetEventHandler()
        self._timer = wx.wxTimer(timerOwner, timerId)
        wx.EVT_TIMER(timerOwner, timerId, self.OnTimer)

        self.SetTargetFPS(fps)

        wx.EVT_ERASE_BACKGROUND(self.canvas, self.OnEraseViewBackground)
        wx.EVT_PAINT(self.canvas, self.OnPaint)

    def GetTargetFrameRate(self):
        return self.rate
    def SetTargetFrameRate(self, rate):
        self.rate = rate
        self._ratedirty = True

    def GetTargetFPS(self):
        if self.rate:
            return 1./self.rate
        else: return None
    def SetTargetFPS(self, framesPerSecond):
        if framesPerSecond:
            self.SetTargetFrameRate(1./framesPerSecond)
        else:
            self.SetTargetFrameRate(None)

    def IsRendering(self):
        return self._timer.IsRunning()

    def StartRendering(self):
        self._ratedirty = False
        if self.rate:
            self._timer.Start(int(1000*self.rate))
        else:
            self._timer.Stop()
            self._Refresh()

    def StopRendering(self):
        self._timer.Stop()

    def _Refresh(self):
        if self.canvas:
            if not self._PendingRefresh:
                self.canvas.Refresh()
                self._PendingRefresh = True
            if self._ratedirty:
                self.StartRendering()
        else:
            self.StopRendering()

    #~ wx Events ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

    def OnTimer(self, evt):
        self._Refresh()

    def OnPaint(self, evt):
        self._PendingRefresh = False
        try:
            dc = wx.wxPaintDC(self.canvas)
            self.canvas.SetCurrent()
            self.OnRender(self.canvas)
            self.canvas.SwapBuffers()
        except Exception, e:
            self.ErrorHandled = False
            self.OnRenderingError(e)
            if not self.ErrorHandled:
                self.StopRendering()
                raise

    def OnEraseViewBackground(self, evt):
        pass