VTK  9.2.20221001
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 =========================================================================*/
70 #ifndef vtkSeedRepresentation_h
71 #define vtkSeedRepresentation_h
72 
73 #include "vtkInteractionWidgetsModule.h" // For export macro
75 
76 VTK_ABI_NAMESPACE_BEGIN
77 class vtkHandleList;
79 
80 class VTKINTERACTIONWIDGETS_EXPORT vtkSeedRepresentation : public vtkWidgetRepresentation
81 {
82 public:
87 
89 
93  void PrintSelf(ostream& os, vtkIndent indent) override;
95 
97 
103  virtual void GetSeedWorldPosition(unsigned int seedNum, double pos[3]);
104  virtual void SetSeedWorldPosition(unsigned int seedNum, double pos[3]);
105  virtual void SetSeedDisplayPosition(unsigned int seedNum, double pos[3]);
106  virtual void GetSeedDisplayPosition(unsigned int seedNum, double pos[3]);
108 
113 
123 
130 
132 
135  vtkHandleRepresentation* GetHandleRepresentation() { return this->HandleRepresentation; };
137 
139 
144  vtkSetClampMacro(Tolerance, int, 1, 100);
145  vtkGetMacro(Tolerance, int);
147 
148  // Used to communicate about the state of the representation
149  enum
150  {
151  Outside = 0,
152  NearSeed
153  };
154 
156 
160  virtual int GetActiveHandle();
161  virtual void SetActiveHandle(int handleId);
162  // Returns the id of the seed created, -1 on failure. e is the display position.
163  virtual int CreateHandle(double e[2]);
164  // Delete last handle created
165  virtual void RemoveLastHandle();
166  // Delete the currently active handle
167  virtual void RemoveActiveHandle();
169 
173  virtual void RemoveHandle(int n);
174 
176 
179  void BuildRepresentation() override;
180  int ComputeInteractionState(int X, int Y, int modify = 0) override;
181  void GetActors(vtkPropCollection*) override;
183 
184 protected:
187 
188  // The handle and the rep used to close the handles
190  vtkHandleList* Handles;
191 
192  // Selection tolerance for the handles
194 
195  // The active seed (handle) based on the last ComputeInteractionState()
197 
198 private:
200  void operator=(const vtkSeedRepresentation&) = delete;
201 };
202 
203 VTK_ABI_NAMESPACE_END
204 #endif
abstract class for representing widget handles
a simple class to control print indentation
Definition: vtkIndent.h:120
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.
static vtkSeedRepresentation * New()
Instantiate class.
vtkHandleRepresentation * GetHandleRepresentation(unsigned int num)
Get the handle representations used for a particular seed.
virtual void RemoveLastHandle()
These are methods specific to vtkSeedRepresentation and which are invoked from vtkSeedWidget.
virtual void RemoveHandle(int n)
Remove the nth handle.
void SetHandleRepresentation(vtkHandleRepresentation *handle)
This method is used to specify the type of handle representation to use for the internal vtkHandleWid...
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.
vtkHandleRepresentation * GetHandleRepresentation()
Returns the model HandleRepresentation.
abstract class defines interface between the widget and widget representation classes