Taskviewer
- Last UpdatedMay 27, 2024
- 5 minute read
This topic is part of Specialized 2D Nodes.
Taskviewer node
The Taskviewer node presents the tasks of a TaskManager inside a fully navigable tree list.
-
Task are presented with different colors depending on their status.
-
Tasks that have children tasks are presented with a [+] if collapsed or with [-] if exploded.
-
Under the task area, there is a description area that shows the description of the currently selected task.
-
You can use the highlightedTaskName parameter to link a behavior to the selection of a specific task in the list. For example, to show the hints of the currently selected objects.
Platform support
This node is supported on XR-Windows platform only.
|
XR-WIN |
XR-P-WIN |
XR-P-IOS |
XR-P-AND |
XR-P-WASM |
|---|---|---|---|---|
|
Full support |
No support |
No support |
No support |
No support |
|
|
|
|
|
|
Code example
This is a code example for the Taskviewer node.
<Taskviewer name="taskviewer"
taskmanagerNode="currentTaskmanager"
viewFromTask="mission"
visible="false"
position="1398 10"
animationMode="right"
size="512 256"
descriptionSize="512 64"
descriptionPos="0 261"
textArea="16 16 480 224"
descriptionArea="16 16 480 96"
iconSize="16 16" iconUpPos="491 5"
iconDownPos="491 235"
lineSize="23"
lineFont="Arial,Normal,23"
descriptionFont="Arial,Normal,20" />
Taskviewer fields
These are the fields for Taskviewer node. Only the node-specific fields are indicated, not fields obtained by inheritance.
Field inheritance: NodeBase > Taskviewer
|
Fields |
Type |
Use |
Default value |
Description |
|---|---|---|---|---|
|
animationMode |
senum |
Optional |
Top |
Defines the TaskViewer appearing/disappearing animation mode as Left, Right, Top, Bottom, or Fade. |
|
backgroundImage |
sstring |
Optional |
Not set |
Name of the image used for the background. |
|
collapseAll |
sevent |
Optional |
Not set |
Causes TaskViewer to collapse all exploded tasks. |
|
cursorColor |
svec3 |
Optional |
1 0 0 |
Text color for selection cursor. The color is expressed in normalized (0-1) RGB (0 0 0 for black, 1 1 1 for white). |
|
descriptionSize |
svec2 |
Optional |
512 256 |
Size of the TaskViewer description area. |
|
descriptionPosition |
svec2 |
Optional |
0 0 |
Position of the top left corner of the taskviewer description area, in reference to the screen top left corner. |
|
descriptionImage |
sstring |
Optional |
Not set |
Name of the image for the description area background. |
|
descriptionArea |
svec4 |
Optional |
16 16 480 224 |
Top left corner and size of the text in the description area, in reference to top left corner of the TaskViewer description area. |
|
descriptionFont |
sstring |
Optional |
Arial,Bold,32 |
The font to use for text in the TaskViewer description area. The font name must be a system font. Only Bold and Regular parameters are accepted. |
|
hightlightedTaskName |
sstring |
Optional |
Contains the name of currently highlighted task. |
|
|
iconDownImage |
sstring |
Optional |
Not set |
Name of the image used for the down arrow. |
|
iconDownPos |
sstring |
Optional |
0 496 |
Position of the down icon referred to the position of the TaskViewer. |
|
iconSize |
svec2 |
Optional |
16 16 |
Size of the up and down icons. |
|
iconUpImage |
sstring |
Optional |
Not set |
Name of the image used for the up arrow. |
|
iconUpPos |
sbec2 |
Optional |
0 0 |
Position of the up icon referred to the position of the TaskViewer. |
|
lineFont |
sstring |
Optional |
Arial,Bold,32 |
The font to use for text in the TaskViewer. The font name must be a system font. Only Bold and Regular parameters are accepted. |
|
lineSize |
sfloat |
Optional |
32 |
Task selector cursor height. This usually matches lineFont height. |
|
moveCursorDelay |
sfloat |
Optional |
0.1 |
Minimum wait time among two accepted movements. |
|
moveCursorY |
sfloat |
Optional |
Not set |
Set 1 to move up and -1 to move down the selector line. Usually routed from the gamepad or keyboard. |
|
order |
sint |
Optional |
100 |
The node z order that defines the display order of different children. The range is 0-255. |
|
position |
svec2 |
Optional |
0 0 |
Position of the top left corner of TaskViewer, in reference to the screen top left corner. |
|
refresh |
sevent |
Optional |
Not set |
Usually routed to TaskManager stateChanged. Causes the TaskViewer to update task colors. |
|
select |
sevent |
Optional |
Not set |
Perform selection action on the currently selected task. Selection action causes task children explosion or collapse, if the task has children. |
|
size |
svec2 |
Optional |
512 512 |
The size of the TaskViewer. |
|
taskmanagerNode |
sstring |
Mandatory |
Not set |
Name of the TaskManager node to connect for performance evaluation. |
|
textArea |
svec4 |
Optional |
16 16 480 480 |
Top left corner and size of the textArea referred to top left corner of the TaskViewer. |
|
textColorFail |
svec3 |
Optional |
1 0 0 |
Text color for tasks in fail status. The color is expressed in normalized (0-1) RGB (0 0 0 for black, 1 1 1 for white). |
|
textColorDescription |
svec3 |
Optional |
1 0 0 |
Text color for description text. The color is expressed in normalized (0-1) RGB (0 0 0 for black, 1 1 1 for white). |
|
textColorRunning |
svec3 |
Optional |
1 1 1 |
Text color for tasks in running status. The color is expressed in normalized (0-1) RGB (0 0 0 for black, 1 1 1 for white). |
|
textColorSuccess |
svec3 |
Optional |
0 1 0 |
Text color for tasks in success status. The color is expressed in normalized (0-1) RGB (0 0 0 for black, 1 1 1 for white). |
|
textColorWaiting |
svec3 |
Optional |
0.5 0.5 0.5 |
Text color for tasks in waiting status. The color is expressed in normalized (0-1) RGB (0 0 0 for black, 1 1 1 for white). |
|
timeTransition |
sfloat |
Optional |
0.3 |
The animation time. |
|
useCursorColorInactive |
sbool |
Optional |
true |
If set to true then highlighted task is kept highlighted (alpha set to 0.4) when TaskViewer is not in use. |
|
viewFromTask |
sstring |
Mandatory |
Not set |
The node inside the TaskManager to use as root for performance evaluation. This is usually the mission base task. |
|
visible |
sbool |
Optional |
false |
Set or get the TaskViewer visibility state. |