VTK  9.1.0
vtkProgressBarRepresentation.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkProgressBarRepresentation.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
25 #ifndef vtkProgressBarRepresentation_h
26 #define vtkProgressBarRepresentation_h
27 
29 #include "vtkInteractionWidgetsModule.h" // For export macro
30 
31 class vtkActor2D;
32 class vtkPoints;
33 class vtkPolyData;
34 class vtkProperty2D;
36 
37 class VTKINTERACTIONWIDGETS_EXPORT vtkProgressBarRepresentation : public vtkBorderRepresentation
38 {
39 public:
44 
46 
50  void PrintSelf(ostream& os, vtkIndent indent) override;
52 
54 
58  vtkGetObjectMacro(Property, vtkProperty2D);
60 
62 
66  vtkSetClampMacro(ProgressRate, double, 0, 1);
67  vtkGetMacro(ProgressRate, double);
69 
71 
76  vtkSetVector2Macro(Padding, double);
77  vtkGetVector2Macro(Padding, double);
79 
81 
85  vtkSetMacro(DrawFrame, bool);
86  vtkGetMacro(DrawFrame, bool);
87  vtkBooleanMacro(DrawFrame, bool);
89 
91 
95  vtkSetVector3Macro(ProgressBarColor, double);
96  vtkGetVector3Macro(ProgressBarColor, double);
98 
100 
104  vtkSetVector3Macro(BackgroundColor, double);
105  vtkGetVector3Macro(BackgroundColor, double);
107 
109 
113  vtkSetMacro(DrawBackground, bool);
114  vtkGetMacro(DrawBackground, bool);
115  vtkBooleanMacro(DrawBackground, bool);
117 
119 
122  void BuildRepresentation() override;
124 
126 
132  int RenderOverlay(vtkViewport*) override;
137 
138 protected:
141 
142  double ProgressRate;
143  double ProgressBarColor[3];
144  double BackgroundColor[3];
145  double Padding[2];
147  bool DrawFrame;
148 
155 
156 private:
158  void operator=(const vtkProgressBarRepresentation&) = delete;
159 };
160 
161 #endif
a actor that draws 2D data
Definition: vtkActor2D.h:40
represent a vtkBorderWidget
a simple class to control print indentation
Definition: vtkIndent.h:34
represent and manipulate 3D points
Definition: vtkPoints.h:34
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:86
represent a vtkProgressBarWidget
vtkTypeBool HasTranslucentPolygonalGeometry() override
These methods are necessary to make this representation behave as a vtkProp.
void PrintSelf(ostream &os, vtkIndent indent) override
Standard VTK class methods.
int RenderTranslucentPolygonalGeometry(vtkViewport *) override
These methods are necessary to make this representation behave as a vtkProp.
int RenderOverlay(vtkViewport *) override
These methods are necessary to make this representation behave as a vtkProp.
void ReleaseGraphicsResources(vtkWindow *) override
These methods are necessary to make this representation behave as a vtkProp.
void GetActors2D(vtkPropCollection *) override
These methods are necessary to make this representation behave as a vtkProp.
int RenderOpaqueGeometry(vtkViewport *) override
These methods are necessary to make this representation behave as a vtkProp.
static vtkProgressBarRepresentation * New()
Instantiate this class.
void BuildRepresentation() override
Satisfy the superclasses' API.
~vtkProgressBarRepresentation() override
an ordered list of Props
represent surface properties of a 2D image
Definition: vtkProperty2D.h:38
dynamic, self-adjusting array of unsigned char
abstract specification for Viewports
Definition: vtkViewport.h:47
window superclass for vtkRenderWindow
Definition: vtkWindow.h:39
int vtkTypeBool
Definition: vtkABI.h:69