Panda3D
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
FourStateAI Class Reference

Public Member Functions

 __init__ (self, names, durations=[0, 1, None, 1, 1])
 
 changedOnState (self, isOn)
 
 delete (self)
 
 distributeStateChange (self)
 
 enterState0 (self)
 state 0 #####
 
 enterState1 (self)
 state 1 #####
 
 enterState2 (self)
 state 2 #####
 
 enterState3 (self)
 state 3 #####
 
 enterState4 (self)
 state 4 #####
 
 enterStateN (self, stateIndex, nextStateIndex)
 
 exitState0 (self)
 
 exitState1 (self)
 
 exitState2 (self)
 
 exitState3 (self)
 
 exitState4 (self)
 
 exitStateN (self)
 
 getState (self)
 
 isOn (self)
 
 sendState (self)
 
 setIsOn (self, isOn)
 
 switchToNextStateTask (self, task)
 states #####
 

Public Attributes

 doLaterTask
 
 durations
 
 enterState0
 
 enterState1
 
 enterState2
 
 enterState3
 
 enterState4
 
 exitState0
 
 exitState1
 
 exitState2
 
 exitState3
 
 exitState4
 
 fsm
 
 names
 
 nextStateIndex
 
 stateIndex
 
 states
 
 switchToNextStateTask
 

Static Public Attributes

 notify = DirectNotifyGlobal.directNotify.newCategory('FourStateAI')
 

Detailed Description

Generic four state ClassicFSM base class.

This is a mix-in class that expects that your derived class
is a DistributedObjectAI.

Inherit from FourStateFSM and pass in your states.  Two of
the states should be oposites of each other and the other
two should be the transition states between the first two.
E.g::

                +--------+
             -->| closed | --
            |   +--------+   |
            |                |
            |                v
      +---------+       +---------+
      | closing |<----->| opening |
      +---------+       +---------+
            ^                |
            |                |
            |    +------+    |
             ----| open |<---
                 +------+

There is a fifth off state, but that is an implementation
detail (and that's why it's not called a five state ClassicFSM).

I found that this pattern repeated in several things I was
working on, so this base class was created.

Constructor & Destructor Documentation

◆ __init__()

__init__ ( self,
names,
durations = [0, 1, None, 1, 1] )
Names is a list of state names.  Some examples are::

    ['off', 'opening', 'open', 'closing', 'closed',]

    ['off', 'locking', 'locked', 'unlocking', 'unlocked',]

    ['off', 'deactivating', 'deactive', 'activating', 'activated',]

durations is a list of durations in seconds or None values.
The list of duration values should be the same length
as the list of state names and the lists correspond.
For each state, after n seconds, the ClassicFSM will move to
the next state.  That does not happen for any duration
values of None.

.. rubric:: More Details

Here is a diagram showing the where the names from the list
are used::

    +---------+
    | 0 (off) |----> (any other state and vice versa).
    +---------+

               +--------+
            -->| 4 (on) |---
           |   +--------+   |
           |                |
           |                v
     +---------+       +---------+
     | 3 (off) |<----->| 1 (off) |
     +---------+       +---------+
           ^                |
           |                |
           |  +---------+   |
            --| 2 (off) |<--
              +---------+

Each states also has an associated on or off value.  The only
state that is 'on' is state 4.  So, the transition states
between off and on (states 1 and 3) are also considered
off (and so is state 2 which is oposite of state 4 and therefore
oposite of 'on').

Member Function Documentation

◆ changedOnState()

changedOnState ( self,
isOn )
Allow derived classes to overide this.
The self.isOn value has toggled.  Call getIsOn() to
get the current state.

◆ delete()

delete ( self)

◆ distributeStateChange()

distributeStateChange ( self)
This function is intentionaly simple so that derived classes
may easily alter the network message.

◆ enterState0()

enterState0 ( self)

state 0 #####

◆ enterState1()

enterState1 ( self)

state 1 #####

◆ enterState2()

enterState2 ( self)

state 2 #####

◆ enterState3()

enterState3 ( self)

state 3 #####

◆ enterState4()

enterState4 ( self)

state 4 #####

◆ enterStateN()

enterStateN ( self,
stateIndex,
nextStateIndex )

◆ exitState0()

exitState0 ( self)

◆ exitState1()

exitState1 ( self)

◆ exitState2()

exitState2 ( self)

◆ exitState3()

exitState3 ( self)

◆ exitState4()

exitState4 ( self)

◆ exitStateN()

exitStateN ( self)

◆ getState()

getState ( self)

◆ isOn()

isOn ( self)

◆ sendState()

sendState ( self)

◆ setIsOn()

setIsOn ( self,
isOn )

◆ switchToNextStateTask()

switchToNextStateTask ( self,
task )

states #####

Member Data Documentation

◆ doLaterTask

doLaterTask

◆ durations

durations

◆ enterState0

enterState0

◆ enterState1

enterState1

◆ enterState2

enterState2

◆ enterState3

enterState3

◆ enterState4

enterState4

◆ exitState0

exitState0

◆ exitState1

exitState1

◆ exitState2

exitState2

◆ exitState3

exitState3

◆ exitState4

exitState4

◆ fsm

fsm

◆ names

names

◆ nextStateIndex

nextStateIndex

◆ notify

notify = DirectNotifyGlobal.directNotify.newCategory('FourStateAI')
static

◆ stateIndex

stateIndex

◆ states

states

◆ switchToNextStateTask

switchToNextStateTask