direct.tkpanels.FSMInspector

from direct.tkpanels.FSMInspector import FSMInspector, StateInspector

Defines the FSMInspector class, which opens a Tkinter window for inspecting Finite State Machines.

Using the Finite State Inspector

1. In your Config.prc add:

   want-tk #t
   

2. Start up the show and create a Finite State Machine:

   from direct.showbase.ShowBaseGlobal import *
   
   from direct.fsm import ClassicFSM
   from direct.fsm import State
   
   def enterState():
       print('enterState')
   
   def exitState():
       print 'exitState'
   
   fsm = ClassicFSM.ClassicFSM('stopLight',
             [State.State('red', enterState, exitState, ['green']),
               State.State('yellow', enterState, exitState, ['red']),
               State.State('green', enterState, exitState, ['yellow'])],
             'red',
             'red')
   
   import FSMInspector
   
   inspector = FSMInspector.FSMInspector(fsm, title = fsm.getName())
   
   # Note, the inspectorPos argument is optional, the inspector will
   # automagically position states on startup
   fsm = ClassicFSM.ClassicFSM('stopLight', [
       State.State('yellow',
                   enterState,
                   exitState,
                   ['red'],
                   inspectorPos = [95.9, 48.0]),
       State.State('red',
                   enterState,
                   exitState,
                   ['green'],
                   inspectorPos = [0.0, 0.0]),
       State.State('green',
                   enterState,
                   exitState,
                   ['yellow'],
                   inspectorPos = [0.0, 95.9])],
           'red',
           'red')
   

3. Pop open a viewer:

   import FSMInspector
   insp = FSMInspector.FSMInspector(fsm)
   

or if you wish to be fancy:

insp = FSMInspector.FSMInspector(fsm, title = fsm.getName())

Features

• Right mouse button over a state pops up a menu allowing you to request a transition to that state

• Middle mouse button will grab the canvas and slide things around if your state machine is bigger than the viewing area

• There are some self explanatory menu options up at the top, the most useful being: “print ClassicFSM layout” which will print out Python code which will create an ClassicFSM augmented with layout information for the viewer so everything shows up in the same place the next time you inspect the state machine

Caveat

There is an unexplained problem with using Tk and emacs right now which occasionally results in everything locking up. This procedure seems to avoid the problem for me:

# Start up the show
from direct.showbase.ShowBaseGlobal import *

# You will see the window and a Tk panel pop open

# Type a number at the emacs prompt
>>> 123

# At this point everything will lock up and you won't get your prompt back

# Hit a bunch of Control-C's in rapid succession, in most cases
# this will break you out of whatever badness you were in and
# from that point on everything will behave normally


# This is how you pop up an inspector
import FSMInspector
inspector = FSMInspector.FSMInspector(fsm, title = fsm.getName())

Inheritance diagram

class FSMInspector(fsm, **kw)

Bases: AppShell

__init__(self, fsm, **kw)

addState(self, state)

appInit(self)

appname = 'ClassicFSM Inspector'

canvas(self)

computeEndpoints(self, fromState, toState)

computePoint(self, radius, angle)

connectStates(self, fromState, toState)

createInterface(self)

createStateInspectors(self)

drawConnections(self, event=None)

enteredState(self, stateName)

exitedState(self, stateName)

findAngle(self, fromPoint, toPoint)

frameHeight = 450

frameWidth = 400

getStateInspector(self, name)

mouse2Down(self, event)

mouse2Motion(self, event)

onDestroy(self, event)

Called on ClassicFSM Panel shutdown

popupGridDialog(self)

printLayout(self)

scrolledCanvas(self)

setFontSize(self, size)

setGridSize(self, size)

setMarkerSize(self, size)

toggleBalloon(self)

toggleGridSnap(self)

usecommandarea = 0

usestatusarea = 0

class StateInspector(inspector, state, **kw)

Bases: MegaArchetype

__init__(self, inspector, state, **kw)

center(self)

enteredState(self)

exitedState(self)

getName(self)

inspectSubMachine(self)

mouseDown(self, event)

mouseEnter(self, event)

mouseLeave(self, event)

mouseMotion(self, event)

mouseRelease(self, event)

popupStateMenu(self, event)

setGridSize(self, size)

setPos(self, x, y, snapToGrid=0)

setRadius(self, size)

setText(self, text=None)

transitionTo(self)