VTK  9.3.1
vtkProgressBarRepresentation.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2 // SPDX-License-Identifier: BSD-3-Clause
16 #ifndef vtkProgressBarRepresentation_h
17 #define vtkProgressBarRepresentation_h
18 
20 #include "vtkInteractionWidgetsModule.h" // For export macro
21 
22 VTK_ABI_NAMESPACE_BEGIN
23 class vtkActor2D;
24 class vtkPoints;
25 class vtkPolyData;
26 class vtkProperty2D;
28 
29 class VTKINTERACTIONWIDGETS_EXPORT vtkProgressBarRepresentation : public vtkBorderRepresentation
30 {
31 public:
36 
38 
42  void PrintSelf(ostream& os, vtkIndent indent) override;
44 
46 
50  vtkGetObjectMacro(Property, vtkProperty2D);
52 
54 
58  vtkSetClampMacro(ProgressRate, double, 0, 1);
59  vtkGetMacro(ProgressRate, double);
61 
63 
68  vtkSetVector2Macro(Padding, double);
69  vtkGetVector2Macro(Padding, double);
71 
73 
77  vtkSetMacro(DrawFrame, bool);
78  vtkGetMacro(DrawFrame, bool);
79  vtkBooleanMacro(DrawFrame, bool);
81 
83 
87  vtkSetVector3Macro(ProgressBarColor, double);
88  vtkGetVector3Macro(ProgressBarColor, double);
90 
92 
96  vtkSetVector3Macro(BackgroundColor, double);
97  vtkGetVector3Macro(BackgroundColor, double);
99 
101 
105  vtkSetMacro(DrawBackground, bool);
106  vtkGetMacro(DrawBackground, bool);
107  vtkBooleanMacro(DrawBackground, bool);
109 
111 
114  void BuildRepresentation() override;
116 
118 
122  void GetActors2D(vtkPropCollection*) override;
123  void ReleaseGraphicsResources(vtkWindow*) override;
124  int RenderOverlay(vtkViewport*) override;
125  int RenderOpaqueGeometry(vtkViewport*) override;
129 
130 protected:
132  ~vtkProgressBarRepresentation() override;
133 
134  double ProgressRate;
135  double ProgressBarColor[3];
136  double BackgroundColor[3];
137  double Padding[2];
139  bool DrawFrame;
140 
147 
148 private:
150  void operator=(const vtkProgressBarRepresentation&) = delete;
151 };
152 
153 VTK_ABI_NAMESPACE_END
154 #endif
int RenderOverlay(vtkViewport *) override
These methods are necessary to make this representation behave as a vtkProp.
represent a vtkProgressBarWidget
vtkTypeBool HasTranslucentPolygonalGeometry() override
These methods are necessary to make this representation behave as a vtkProp.
abstract specification for Viewports
Definition: vtkViewport.h:44
a actor that draws 2D data
Definition: vtkActor2D.h:34
int RenderOpaqueGeometry(vtkViewport *) 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.
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:79
static vtkBorderRepresentation * New()
Instantiate this class.
an ordered list of Props
void PrintSelf(ostream &os, vtkIndent indent) override
Define standard methods.
int vtkTypeBool
Definition: vtkABI.h:64
window superclass for vtkRenderWindow
Definition: vtkWindow.h:27
int RenderTranslucentPolygonalGeometry(vtkViewport *) override
These methods are necessary to make this representation behave as a vtkProp.
void BuildRepresentation() override
Subclasses should implement these methods.
a simple class to control print indentation
Definition: vtkIndent.h:28
void ReleaseGraphicsResources(vtkWindow *) override
These methods are necessary to make this representation behave as a vtkProp.
represent a vtkBorderWidget
dynamic, self-adjusting array of unsigned char
represent surface properties of a 2D image
Definition: vtkProperty2D.h:29
represent and manipulate 3D points
Definition: vtkPoints.h:28