forked from Kitware/VTK
-
Notifications
You must be signed in to change notification settings - Fork 0
/
vtkButtonRepresentation.h
121 lines (103 loc) · 3.61 KB
/
vtkButtonRepresentation.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
/*=========================================================================
Program: Visualization Toolkit
Module: vtkButtonRepresentation.h
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
All rights reserved.
See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
/**
* @class vtkButtonRepresentation
* @brief abstract class defines the representation for a vtkButtonWidget
*
* This abstract class is used to specify how the vtkButtonWidget should
* interact with representations of the vtkButtonWidget. This class may be
* subclassed so that alternative representations can be created. The class
* defines an API, and a default implementation, that the vtkButtonWidget
* interacts with to render itself in the scene.
*
* The vtkButtonWidget assumes an n-state button so that traveral methods
* are available for changing, querying and manipulating state. Derived
* classed determine the actual appearance. The state is represented by an
* integral value 0<=state<numStates.
*
* To use this representation, always begin by specifying the number of states.
* Then follow with the necessary information to represent each state (done through
* a subclass API).
*
* @sa
* vtkButtonWidget
*/
#ifndef vtkButtonRepresentation_h
#define vtkButtonRepresentation_h
#include "vtkInteractionWidgetsModule.h" // For export macro
#include "vtkWidgetRepresentation.h"
class VTKINTERACTIONWIDGETS_EXPORT vtkButtonRepresentation : public vtkWidgetRepresentation
{
public:
//@{
/**
* Standard methods for the class.
*/
vtkTypeMacro(vtkButtonRepresentation,vtkWidgetRepresentation);
void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;
//@}
//@{
/**
* Retrieve the current button state.
*/
vtkSetClampMacro(NumberOfStates,int,1,VTK_INT_MAX);
//@}
//@{
/**
* Retrieve the current button state.
*/
vtkGetMacro(State,int);
//@}
//@{
/**
* Manipulate the state. Note that the NextState() and PreviousState() methods
* use modulo traveral. The "state" integral value will be clamped within
* the possible state values (0<=state<NumberOfStates). Note that subclasses
* will override these methods in many cases.
*/
virtual void SetState(int state);
virtual void NextState();
virtual void PreviousState();
//@}
enum _InteractionState
{
Outside=0,
Inside
};
//@{
/**
* These methods control the appearance of the button as it is being
* interacted with. Subclasses will behave differently depending on their
* particulars. HighlightHovering is used when the mouse pointer moves
* over the button. HighlightSelecting is set when the button is selected.
* Otherwise, the HighlightNormal is used. The Highlight() method will throw
* a vtkCommand::HighlightEvent.
*/
enum _HighlightState {HighlightNormal,HighlightHovering,HighlightSelecting};
void Highlight(int) VTK_OVERRIDE;
vtkGetMacro(HighlightState,int);
//@}
/**
* Satisfy some of vtkProp's API.
*/
void ShallowCopy(vtkProp *prop) VTK_OVERRIDE;
protected:
vtkButtonRepresentation();
~vtkButtonRepresentation() VTK_OVERRIDE;
// Values
int NumberOfStates;
int State;
int HighlightState;
private:
vtkButtonRepresentation(const vtkButtonRepresentation&) VTK_DELETE_FUNCTION;
void operator=(const vtkButtonRepresentation&) VTK_DELETE_FUNCTION;
};
#endif