RayTracing_DebugTool/RTDebugFSM.py at master · iras/RayTracing_DebugTool · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
'''
Created on June 6, 2013
@author: ivano.ras@gmail.com
MIT license
'''

from main import Ui_Form
from RTEngine import REngineThread
from OpenGLCompo import OGLViewer


# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

class State:
    '''
    Abstract State class
    '''
    def __init__(self, fsm):

        # protected var. It'll be inherited by the subclass DebugStateMachine's instances.
        self._fsm    = fsm

    def startRendering (self):  assert 0, "start-rendering not implemented"
    def pauseRendering (self):  assert 0, "pause-rendering not implemented"
    def resetRendering (self):  assert 0, "reset-rendering not implemented"
    def finaliseRender (self):  assert 0, "finalise-render not implemented"


class Reset (State):
    '''
    Reset State class
    '''
    def __init__(self, fsm):
        State.__init__ (self, fsm)

    def startRendering (self):

        self._fsm.delegateUIButtonsEnabling ({'renderBtn'   :False,  'pauseBtn'   :True,   'stopBtn'    :True,   'upBtn'      :False,
                                              'downBtn'     :False,  'moreDownBtn':False,  'moreUpBtn'  :False,  'rightBtn'   :False,
                                              'moreRightBtn':False,  'leftBtn'    :False,  'furtherLeft':False,  'progressBar':'reset'})
        self._fsm.delegateCameraAddition ()
        self._fsm.delegateScreenshotAddition ()
        self._fsm.delegateEnginePrepAndStart ()

        return self._fsm.getPlayingState()

    def resetRendering (self):
        raise ValueError ("Already reset. This message shouldn't appear as the reset button should be greyed out.")

    def pauseRendering (self):
        raise ValueError ("Can't pause when state is reset. This message shouldn't appear as the reset button should be greyed out.")

    def finaliseRender (self):
        raise ValueError ("Can't finalise rendering when state is 'reset'.")


class Started (State):
    '''
    Started State class
    '''
    def __init__(self, fsm):
        State.__init__ (self, fsm)

    def startRendering (self):
        raise ValueError ("Already rendering. This message shouldn't appear as the reset button should be greyed out.")

    def resetRendering (self):

        self._fsm.delegateUIButtonsEnabling ({'renderBtn'   :True,   'pauseBtn'   :False,  'stopBtn'    :False,  'upBtn'      :False,
                                              'downBtn'     :False,  'moreDownBtn':False,  'moreUpBtn'  :False,  'rightBtn'   :False,
                                              'moreRightBtn':False,  'leftBtn'    :False,  'furtherLeft':False,  'progressBar':''})
        self._fsm.delegateIsStoppedFlagSetting (True)

        return self._fsm.getStoppedState ()

    def pauseRendering (self):

        self._fsm.delegateUIButtonsEnabling ({'renderBtn'   :True,   'pauseBtn'   :False,  'stopBtn'    :False,  'upBtn'      :True,
                                              'downBtn'     :True,   'moreDownBtn':True,   'moreUpBtn'  :True,   'rightBtn'   :True,
                                              'moreRightBtn':True,   'leftBtn'    :True,   'furtherLeft':True,   'progressBar':''})
        self._fsm.delegateIsPausedFlagSetting (True)
        self._fsm.delegateRenderBtnNameChanging ('Resume')

        return self._fsm.getPausedState ()

    def finaliseRender (self):

        self._fsm.delegateUIButtonsEnabling ({'renderBtn'   :True,   'pauseBtn'   :False,  'stopBtn'    :False,  'upBtn'      :False,
                                              'downBtn'     :False,  'moreDownBtn':False,  'moreUpBtn'  :False,  'rightBtn'   :False,
                                              'moreRightBtn':False,  'leftBtn'    :False,  'furtherLeft':False,  'progressBar':'completed'})
        return self._fsm.getStoppedState ()


class Paused (State):
    '''
    Paused State class
    '''
    def __init__(self, fsm):
        State.__init__ (self, fsm)

    def startRendering (self):

        self._fsm.delegateUIButtonsEnabling ({'renderBtn'   :False,  'pauseBtn'   :True,   'stopBtn'    :True,   'upBtn'      :False,
                                              'downBtn'     :False,  'moreDownBtn':False,  'moreUpBtn'  :False,  'rightBtn'   :False,
                                              'moreRightBtn':False,  'leftBtn'    :False,  'furtherLeft':False,  'progressBar':'reset'})
        self._fsm.delegateIsPausedFlagSetting (False)
        self._fsm.delegateRenderBtnNameChanging ('Render')

        return self._fsm.getPlayingState()

    def pauseRendering (self):
        raise ValueError ("Already paused. This message shouldn't appear as the reset button should be greyed out.")

    def resetRendering (self):


        self._fsm.delegateUIButtonsEnabling ({'renderBtn'   :True,   'pauseBtn'   :False,  'stopBtn'    :False,  'upBtn'      :False,
                                              'downBtn'     :False,  'moreDownBtn':False,  'moreUpBtn'  :False,  'rightBtn'   :False,
                                              'moreRightBtn':False,  'leftBtn'    :False,  'furtherLeft':False,  'progressBar':''})
        self._fsm.delegateIsPausedFlagSetting (False)
        self._fsm.delegateIsStoppedFlagSetting (True)
        self._fsm.delegateRenderBtnNameChanging ('Render')

        return self._fsm.getStoppedState ()

    def finaliseRender (self):
        raise ValueError ("Can't finalise rendering when state is 'paused'.")


# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -


class DebugStateMachine ():
    '''
    Debug State Machine class
    '''
    def __init__ (self, ui):

        self.__ui = ui

        self.__state_stopped = Reset   (self)
        self.__state_paused  = Paused  (self)
        self.__state_playing = Started (self)

        self.__currentState  = self.__state_stopped

    def startRendering (self): self.__currentState = self.__currentState.startRendering ()
    def pauseRendering (self): self.__currentState = self.__currentState.pauseRendering ()
    def stopRendering  (self): self.__currentState = self.__currentState.resetRendering ()
    def finaliseRender (self): self.__currentState = self.__currentState.finaliseRender ()

    # delegates
    def delegateIsStoppedFlagSetting  (self, boo):     self.__ui.setIsStoppedFlag (boo)
    def delegateIsPausedFlagSetting   (self, boo):     self.__ui.setIsPausedFlag  (boo)
    def delegateUIButtonsEnabling     (self, dict_ui): self.__ui.enableUIButtons (dict_ui)
    def delegateEnginePrepAndStart    (self):          self.__ui.prepAndStartEngineUp ()
    def delegateScreenshotAddition    (self):          self.__ui.addScreenshot ()
    def delegateCameraAddition        (self):          self.__ui.addCamera ()
    def delegateRenderBtnNameChanging (self, title):   self.__ui.changeRenderBtnName (title)

    # state getters
    def getStoppedState (self): return self.__state_stopped
    def getPausedState  (self): return self.__state_paused
    def getPlayingState (self): return self.__state_playing