VTK
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 =========================================================================*/
28 #ifndef vtkProgressBarRepresentation_h
29 #define vtkProgressBarRepresentation_h
30 
31 #include "vtkInteractionWidgetsModule.h" // For export macro
33 
34 class vtkActor2D;
35 class vtkPoints;
36 class vtkPolyData;
37 class vtkProperty2D;
39 
40 class VTKINTERACTIONWIDGETS_EXPORT vtkProgressBarRepresentation : public vtkBorderRepresentation
41 {
42 public:
47 
49 
53  void PrintSelf(ostream& os, vtkIndent indent) override;
55 
57 
61  vtkGetObjectMacro(Property, vtkProperty2D);
63 
65 
69  vtkSetClampMacro(ProgressRate, double, 0, 1);
70  vtkGetMacro(ProgressRate, double);
72 
74 
78  vtkSetVector3Macro(ProgressBarColor, double);
79  vtkGetVector3Macro(ProgressBarColor, double);
81 
83 
87  vtkSetVector3Macro(BackgroundColor, double);
88  vtkGetVector3Macro(BackgroundColor, double);
90 
92 
96  vtkSetMacro(DrawBackground, bool);
97  vtkGetMacro(DrawBackground, bool);
98  vtkBooleanMacro(DrawBackground, bool);
100 
102 
105  void BuildRepresentation() override;
106  void GetSize(double size[2]) override;
108 
110 
114  void GetActors2D(vtkPropCollection*) override;
115  void ReleaseGraphicsResources(vtkWindow*) override;
116  int RenderOverlay(vtkViewport*) override;
117  int RenderOpaqueGeometry(vtkViewport*) override;
121 
122 protected:
124  ~vtkProgressBarRepresentation() override;
125 
126  double ProgressRate;
127  double ProgressBarColor[3];
128  double BackgroundColor[3];
130 
136 
137 private:
139  void operator=(const vtkProgressBarRepresentation&) = delete;
140 };
141 
142 #endif
vtkPoints
represent and manipulate 3D points
Definition: vtkPoints.h:39
vtkBorderRepresentation
represent a vtkBorderWidget
Definition: vtkBorderRepresentation.h:58
vtkProgressBarRepresentation::ProgressBarData
vtkUnsignedCharArray * ProgressBarData
Definition: vtkProgressBarRepresentation.h:132
vtkBorderRepresentation::RenderOpaqueGeometry
int RenderOpaqueGeometry(vtkViewport *) override
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDE...
vtkBorderRepresentation::New
static vtkBorderRepresentation * New()
Instantiate this class.
vtkUnsignedCharArray
dynamic, self-adjusting array of unsigned char
Definition: vtkUnsignedCharArray.h:41
vtkProgressBarRepresentation::Property
vtkProperty2D * Property
Definition: vtkProgressBarRepresentation.h:133
vtkBorderRepresentation::BuildRepresentation
void BuildRepresentation() override
Subclasses should implement these methods.
vtkBorderRepresentation::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkWindow
window superclass for vtkRenderWindow
Definition: vtkWindow.h:37
vtkProgressBarRepresentation::ProgressRate
double ProgressRate
Definition: vtkProgressBarRepresentation.h:126
vtkBorderRepresentation::GetActors2D
void GetActors2D(vtkPropCollection *) override
These methods are necessary to make this representation behave as a vtkProp.
vtkBorderRepresentation.h
vtkProgressBarRepresentation
represent a vtkProgressBarWidget
Definition: vtkProgressBarRepresentation.h:40
vtkBorderRepresentation::ReleaseGraphicsResources
void ReleaseGraphicsResources(vtkWindow *) override
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being...
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:39
vtkBorderRepresentation::GetSize
virtual void GetSize(double size[2])
Definition: vtkBorderRepresentation.h:221
vtkBorderRepresentation::RenderTranslucentPolygonalGeometry
int RenderTranslucentPolygonalGeometry(vtkViewport *) override
vtkX3D::size
Definition: vtkX3D.h:253
vtkProgressBarRepresentation::DrawBackground
bool DrawBackground
Definition: vtkProgressBarRepresentation.h:129
vtkProgressBarRepresentation::Points
vtkPoints * Points
Definition: vtkProgressBarRepresentation.h:131
vtkViewport
abstract specification for Viewports
Definition: vtkViewport.h:47
vtkProgressBarRepresentation::BackgroundActor
vtkActor2D * BackgroundActor
Definition: vtkProgressBarRepresentation.h:135
vtkProperty2D
represent surface properties of a 2D image
Definition: vtkProperty2D.h:40
vtkActor2D
a actor that draws 2D data
Definition: vtkActor2D.h:45
vtkProgressBarRepresentation::Actor
vtkActor2D * Actor
Definition: vtkProgressBarRepresentation.h:134
vtkPolyData
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:85
vtkBorderRepresentation::RenderOverlay
int RenderOverlay(vtkViewport *) override
vtkPropCollection
an ordered list of Props
Definition: vtkPropCollection.h:41
vtkTypeBool
int vtkTypeBool
Definition: vtkABI.h:69
vtkBorderRepresentation::HasTranslucentPolygonalGeometry
vtkTypeBool HasTranslucentPolygonalGeometry() override
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDE...