ork::LoopTask Class Reference
[scenegraph]
An AbstractTask to execute a task on a set of scene nodes. More...
#include <LoopTask.h>
Inheritance diagram for ork::LoopTask:
Public Member Functions | |
| LoopTask (const string &var, const string &flag, bool cull, bool parallel, ptr< TaskFactory > subtask) | |
| Creates a new LoopTask. | |
| virtual | ~LoopTask () |
| Deletes this LoopTask. | |
| virtual ptr< Task > | getTask (ptr< Object > context) |
| Creates a new task. | |
Protected Member Functions | |
| LoopTask () | |
| Creates an empty LoopTask. | |
| void | init (const string &var, const string &flag, bool cull, bool parallel, ptr< TaskFactory > subtask) |
| Initializes this LoopTask. | |
| void | swap (ptr< LoopTask > t) |
| Swaps this LoopTask with the given one. | |
Detailed Description
An AbstractTask to execute a task on a set of scene nodes.
Constructor & Destructor Documentation
| ork::LoopTask::LoopTask | ( | const string & | var, | |
| const string & | flag, | |||
| bool | cull, | |||
| bool | parallel, | |||
| ptr< TaskFactory > | subtask | |||
| ) |
Creates a new LoopTask.
- Parameters:
-
var the loop variable name. flag a flag that specifies the scene nodes to which the loop must be applied. cull true to apply the loop only on the visible scene nodes. parallel true the apply the loop to all scene nodes in parallel. subtask the task that must be executed on each SceneNode.
| virtual ork::LoopTask::~LoopTask | ( | ) | [virtual] |
Deletes this LoopTask.
| ork::LoopTask::LoopTask | ( | ) | [protected] |
Creates an empty LoopTask.
Member Function Documentation
Creates a new task.
- Parameters:
-
context an optional parameter to control the task creation.
- Returns:
- the created task.
Implements ork::TaskFactory.
| void ork::LoopTask::init | ( | const string & | var, | |
| const string & | flag, | |||
| bool | cull, | |||
| bool | parallel, | |||
| ptr< TaskFactory > | subtask | |||
| ) | [protected] |
Initializes this LoopTask.
- Parameters:
-
var the loo variable name. flag a flag that specifies the scene nodes to which the loop must be applied. cull true to apply the loop only on the visible scene nodes. parallel true the apply the loop to all scene nodes in parallel. subtask the task that must be executed on each SceneNode.
