Panda3D Manual: Tasks
<<prev | top | next>> |
Tasks are special functions that are called once, each frame, while your application executes. They are similar in concept to threads, but in Panda, tasks are not separate threads; instead, all tasks are run cooperatively, one at a time, within the main thread. This design simplifies game programming considerably by removing the requirement to protect critical sections of code from mutual access. When you start Panda3D by importing DirectStart, a handful of tasks are created by default, but you are free to add as many additional tasks as you like. ## The task function A task is defined with a function or class method; this function is the main entry point for the task and will be called once per frame while the task is running. By default, the function receives one parameter, which is the task object; the task object carries information about the task itself, such as the amount of time that the task has been running. Your task function should return when it has finished processing for the frame. Because all tasks are run in the same thread, you must not spend too much time processing any one task function; the entire application will be locked up until the function returns. The task function may return either `Task.cont` to indicate that the task should be called again next frame, or `Task.done` to indicate that it should not be called again. If it returns None (which is to say, it does not return anything), then the default behavior is to call the task function again. The below example imports the Task module and shows a function used as a task.
from direct.task import Task #This task runs for two seconds, then prints done def exampleTask(task): if task.time < 2.0: return Task.cont print 'Done' return Task.done
## The Task Manager All tasks are handled through the global Task Manager object, called `taskMgr` in Panda3D. The Task Manager keeps a list of all currently-running tasks. To add your task function to the task list, call `taskMgr.add()` with your function and an arbitrary name for the task.
taskMgr.add(exampleTask, 'MyTaskName')
To remove the task and stop it from executing, call taskMgr.remove(). You can pass in either the name of the task, or the task object (which was returned by `taskMgr.add()`, above).
taskMgr.remove('MyTaskName')
To print the list of tasks currently running, simply print out `taskMgr`. Among your own tasks, you may see the following system tasks listed:
dataloop | Processes the keyboard and mouse inputs
tkloop | Processes Tk GUI events
eventManager | Processes events generated by C++ code, such as collision events
igloop | Draws the scene
## Task timing To see the specific timing information for each task when you print taskMgr, add the following line to your Config.prc file
task-timer-verbose #t
(see The Configuration File for config syntax) ## The do-later task A useful special kind of task is the do-later: this is similar to a task, but rather than being called every frame it will be called only once, after a certain amount of time (in seconds) has elapsed. You can, of course, implement a do-later task with a regular task that simply does nothing until a certain amount of time has elapsed (as in the above example), but using a do-later is a much more efficient way to achieve the same thing, especially if you will have many such tasks waiting around.
taskMgr.doMethodLater(delayTime, myFunction, 'Task Name')
In this case myFunction must accept a task variable. If you wish to use a function that does not accept a task variable:
taskMgr.doMethodLater(delayTime, myFunction, 'Task Name', extraArgs = [variables])
Note: if you wish to call a function which takes no variables simply pass extraArgs = []
<<prev | top | next>> |