VTK  9.2.6
vtkSeedRepresentation.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkSeedRepresentation.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=========================================================================*/
40#ifndef vtkSeedRepresentation_h
41#define vtkSeedRepresentation_h
42
43#include "vtkInteractionWidgetsModule.h" // For export macro
45
46class vtkHandleList;
48
49class VTKINTERACTIONWIDGETS_EXPORT vtkSeedRepresentation : public vtkWidgetRepresentation
50{
51public:
56
58
62 void PrintSelf(ostream& os, vtkIndent indent) override;
64
66
72 virtual void GetSeedWorldPosition(unsigned int seedNum, double pos[3]);
73 virtual void SetSeedWorldPosition(unsigned int seedNum, double pos[3]);
74 virtual void SetSeedDisplayPosition(unsigned int seedNum, double pos[3]);
75 virtual void GetSeedDisplayPosition(unsigned int seedNum, double pos[3]);
77
82
92
99
101
104 vtkHandleRepresentation* GetHandleRepresentation() { return this->HandleRepresentation; };
106
108
113 vtkSetClampMacro(Tolerance, int, 1, 100);
114 vtkGetMacro(Tolerance, int);
116
117 // Used to communicate about the state of the representation
118 enum
119 {
120 Outside = 0,
121 NearSeed
122 };
123
125
129 virtual int GetActiveHandle();
130 virtual void SetActiveHandle(int handleId);
131 // Returns the id of the seed created, -1 on failure. e is the display position.
132 virtual int CreateHandle(double e[2]);
133 // Delete last handle created
134 virtual void RemoveLastHandle();
135 // Delete the currently active handle
136 virtual void RemoveActiveHandle();
138
142 virtual void RemoveHandle(int n);
143
145
148 void BuildRepresentation() override;
149 int ComputeInteractionState(int X, int Y, int modify = 0) override;
152
153protected:
156
157 // The handle and the rep used to close the handles
159 vtkHandleList* Handles;
160
161 // Selection tolerance for the handles
163
164 // The active seed (handle) based on the last ComputeInteractionState()
166
167private:
169 void operator=(const vtkSeedRepresentation&) = delete;
170};
171
172#endif
abstract class for representing widget handles
a simple class to control print indentation
Definition vtkIndent.h:49
an ordered list of Props
represent the vtkSeedWidget
virtual int CreateHandle(double e[2])
These are methods specific to vtkSeedRepresentation and which are invoked from vtkSeedWidget.
int GetNumberOfSeeds()
Return the number of seeds (or handles) that have been created.
~vtkSeedRepresentation() override
virtual void SetActiveHandle(int handleId)
These are methods specific to vtkSeedRepresentation and which are invoked from vtkSeedWidget.
virtual void GetSeedWorldPosition(unsigned int seedNum, double pos[3])
Methods to Set/Get the coordinates of seed points defining this representation.
virtual int GetActiveHandle()
These are methods specific to vtkSeedRepresentation and which are invoked from vtkSeedWidget.
vtkHandleRepresentation * HandleRepresentation
virtual void SetSeedWorldPosition(unsigned int seedNum, double pos[3])
Methods to Set/Get the coordinates of seed points defining this representation.
void BuildRepresentation() override
These are methods that satisfy vtkWidgetRepresentation's API.
virtual void RemoveLastHandle()
These are methods specific to vtkSeedRepresentation and which are invoked from vtkSeedWidget.
virtual void RemoveHandle(int n)
Remove the nth handle.
vtkHandleRepresentation * GetHandleRepresentation()
Returns the model HandleRepresentation.
void SetHandleRepresentation(vtkHandleRepresentation *handle)
This method is used to specify the type of handle representation to use for the internal vtkHandleWid...
vtkHandleRepresentation * GetHandleRepresentation(unsigned int num)
Get the handle representations used for a particular seed.
void GetActors(vtkPropCollection *) override
These are methods that satisfy vtkWidgetRepresentation's API.
virtual void RemoveActiveHandle()
These are methods specific to vtkSeedRepresentation and which are invoked from vtkSeedWidget.
int ComputeInteractionState(int X, int Y, int modify=0) override
These are methods that satisfy vtkWidgetRepresentation's API.
void PrintSelf(ostream &os, vtkIndent indent) override
Standard VTK methods.
virtual void SetSeedDisplayPosition(unsigned int seedNum, double pos[3])
Methods to Set/Get the coordinates of seed points defining this representation.
virtual void GetSeedDisplayPosition(unsigned int seedNum, double pos[3])
Methods to Set/Get the coordinates of seed points defining this representation.
static vtkSeedRepresentation * New()
Instantiate class.
abstract class defines interface between the widget and widget representation classes