VTK  9.2.6
vtkButtonRepresentation.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkButtonRepresentation.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 =========================================================================*/
41 #ifndef vtkButtonRepresentation_h
42 #define vtkButtonRepresentation_h
43 
44 #include "vtkDeprecation.h" // For VTK_DEPRECATED_IN_9_2_0
45 #include "vtkInteractionWidgetsModule.h" // For export macro
47 
48 class VTKINTERACTIONWIDGETS_EXPORT vtkButtonRepresentation : public vtkWidgetRepresentation
49 {
50 public:
52 
56  void PrintSelf(ostream& os, vtkIndent indent) override;
58 
60 
63  vtkSetClampMacro(NumberOfStates, int, 1, VTK_INT_MAX);
65 
67 
70  vtkGetMacro(State, int);
72 
74 
80  virtual void SetState(int state);
81  virtual void NextState();
82  virtual void PreviousState();
84 
86  {
87  Outside = 0,
88  Inside
89  };
90 #if !defined(VTK_LEGACY_REMOVE)
91  VTK_DEPRECATED_IN_9_2_0("because leading underscore is reserved")
93 #endif
94 
96 
105  {
108  HighlightSelecting
109  };
110 #if !defined(VTK_LEGACY_REMOVE)
111  VTK_DEPRECATED_IN_9_2_0("because leading underscore is reserved")
113 #endif
114  void Highlight(int) override;
115  vtkGetMacro(HighlightState, int);
117 
121  void ShallowCopy(vtkProp* prop) override;
122 
123 protected:
125  ~vtkButtonRepresentation() override;
126 
127  // Values
129  int State;
131 
132 private:
134  void operator=(const vtkButtonRepresentation&) = delete;
135 };
136 
137 #endif
abstract superclass for all actors, volumes and annotations
Definition: vtkProp.h:56
void PrintSelf(ostream &os, vtkIndent indent) override
Standard methods for instances of this class.
void ShallowCopy(vtkProp *prop) override
Shallow copy of this vtkProp.
HighlightStateType
These methods control the appearance of the button as it is being interacted with.
#define VTK_DEPRECATED_IN_9_2_0(reason)
#define VTK_INT_MAX
Definition: vtkType.h:155
abstract class defines interface between the widget and widget representation classes ...
a simple class to control print indentation
Definition: vtkIndent.h:39
abstract class defines the representation for a vtkButtonWidget
virtual void Highlight(int vtkNotUsed(highlightOn))