Skip to content

Commit 3e241bf

Browse files
[docs] Add CueProgBar documentation to Cuetopia monitoring guide (#1962)
**Link the Issue(s) this Pull Request is related to.** - #1800 **Summarize your change.** [docs] Add CueProgBar documentation to Cuetopia monitoring guide - Document CueProgBar standalone progress window functionality - Add sections for launching methods, interface overview, and color coding - Include interactive features: left-click status and right-click controls - Document window features, auto-update mechanism, and visual indicators - Add use cases, technical details, and best practices - Include keyboard shortcuts and memory usage information - Add screenshot images
1 parent c46d962 commit 3e241bf

File tree

5 files changed

+129
-2
lines changed

5 files changed

+129
-2
lines changed

docs/_docs/user-guides/cuetopia-monitoring-guide.md

Lines changed: 129 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,9 @@ This guide provides comprehensive documentation for Cuetopia, which includes the
2323
- [Job Color Organization](#job-color-organization)
2424
2. [Monitor Job Details Plugin](#monitor-job-details-plugin)
2525
3. [Job Graph Plugin](#job-graph-plugin)
26-
4. [Filters and Search Capabilities](#filters-and-search-capabilities)
27-
5. [Data Processing and Updates](#data-processing-and-updates)
26+
4. [CueProgBar - Progress Bar Window](#cueprogbar---progress-bar-window)
27+
5. [Filters and Search Capabilities](#filters-and-search-capabilities)
28+
6. [Data Processing and Updates](#data-processing-and-updates)
2829

2930
---
3031

@@ -347,6 +348,132 @@ Right-click on nodes provides:
347348

348349
---
349350

351+
## CueProgBar - Progress Bar Window
352+
353+
CueProgBar is a lightweight, standalone progress monitoring window that provides a visual representation of job frame status. It offers a minimalist interface for quick job monitoring without the overhead of the full CueGUI application.
354+
355+
### Launching CueProgBar
356+
357+
From CueGUI Job Context Menu:
358+
- Right-click on any job in the Monitor Jobs view
359+
- Select "Show Progress Bar" from the context menu
360+
- A separate progress bar window opens for that job
361+
362+
### Interface Overview
363+
364+
![CueProgBar Window Interface](/assets/images/cuegui/cueprogbar/cueprogbar_window.png)
365+
366+
The CueProgBar window consists of three main components:
367+
368+
1. **Visual Progress Bar**: A horizontal bar showing frame states through color coding
369+
2. **Status Label**: Displays current progress (e.g., "150 of 200 done, 10 running")
370+
3. **Job Name Label**: Shows the full job name
371+
372+
### Frame State Color Coding
373+
374+
The progress bar uses distinct colors to represent different frame states:
375+
376+
| State | Color | Description |
377+
|-------|-------|-------------|
378+
| **SUCCEEDED** | Green (#37C837) | Frames that completed successfully |
379+
| **RUNNING** | Yellow (#C8C837) | Frames currently being processed |
380+
| **WAITING** | Light Blue (#87CFEB) | Frames ready to run when resources are available |
381+
| **DEPEND** | Purple (#A020F0) | Frames waiting on dependencies |
382+
| **DEAD** | Red (#FF0000) | Frames that failed and exceeded retry attempts |
383+
| **EATEN** | Dark Red (#960000) | Frames manually marked as complete |
384+
385+
![CueProgBar Color Legend](/assets/images/cuegui/cueprogbar/cueprogbar_colors.png)
386+
387+
### Interactive Features
388+
389+
#### Left-Click Menu
390+
391+
Clicking the left mouse button on the progress bar displays a breakdown of frame states:
392+
393+
![CueProgBar Frame Status Menu](/assets/images/cuegui/cueprogbar/cueprogbar_left_click.png)
394+
395+
- Shows count for each frame state
396+
- Color-coded icons match the progress bar colors
397+
- Only displays states with non-zero counts
398+
399+
#### Right-Click Context Menu
400+
401+
Right-clicking the progress bar reveals job control actions:
402+
403+
![CueProgBar Context Menu](/assets/images/cuegui/cueprogbar/cueprogbar_right_click.png)
404+
405+
Available actions include:
406+
407+
1. **Pause/Unpause Job**:
408+
- Toggles job execution state
409+
- Paused jobs show "Paused" overlay on the progress bar
410+
- Prevents new frames from starting while allowing running frames to complete
411+
412+
2. **Retry Dead Frames** (NEW):
413+
- Appears only when dead frames exist
414+
- Shows confirmation dialog with dead frame count
415+
- Retries all frames in DEAD state
416+
- Displays success/failure notification
417+
418+
![Retry Dead Frames Confirmation](/assets/images/cuegui/cueprogbar/cueprogbar_retry_confirm.png)
419+
420+
3. **Kill Job**:
421+
- Terminates the job and all running frames
422+
- Requires confirmation dialog
423+
- Logs the action with username and timestamp
424+
425+
### Window Features
426+
427+
#### Auto-Update
428+
- Refreshes every 5 seconds (configurable)
429+
- Updates frame counts and progress bar in real-time
430+
- Stops updating when job completes
431+
432+
#### Window Title
433+
The window title dynamically updates to show:
434+
- **Percentage**: "75% job_name" (for running jobs)
435+
- **DONE**: "DONE job_name" (for completed jobs)
436+
- **ERR**: "ERR job_name" (when dead frames exist and no frames are running)
437+
438+
#### Visual Indicators
439+
- **COMPLETE** overlay: Displayed when job finishes successfully
440+
- **Paused** overlay: Shown when job is paused
441+
- **Job Not Found** message: Appears if job is deleted or becomes inaccessible
442+
443+
### Use Cases
444+
445+
CueProgBar is ideal for:
446+
447+
1. **Quick Monitoring**: Artists who want to monitor specific jobs without full CueGUI
448+
2. **Multi-Job Tracking**: Opening multiple progress bars for different jobs simultaneously
449+
3. **Desktop Integration**: Minimal windows that can be arranged on secondary monitors
450+
4. **Resource Efficiency**: Lower memory and CPU usage compared to full CueGUI
451+
452+
### Technical Details
453+
454+
#### Memory Usage
455+
- Minimal memory footprint
456+
- No layer or frame detail caching
457+
- Simple RPC calls for job statistics only
458+
459+
#### Update Mechanism
460+
```python
461+
# Update cycle (every 5 seconds)
462+
1. Fetch job statistics via RPC
463+
2. Calculate frame state totals
464+
3. Repaint progress bar
465+
4. Update labels and title
466+
```
467+
468+
### Best Practices
469+
470+
1. **Multiple Windows**: Open separate progress bars for critical jobs
471+
2. **Window Arrangement**: Stack vertically for space-efficient monitoring
472+
3. **Close When Done**: Windows can be safely closed without affecting jobs
473+
4. **Retry Strategy**: Use "Retry Dead Frames" before marking jobs complete
474+
475+
---
476+
350477
## Filters and Search Capabilities
351478

352479
### Job Search Patterns
105 KB
Loading
248 KB
Loading
139 KB
Loading
44.3 KB
Loading

0 commit comments

Comments
 (0)