VTK  9.3.0
vtkSeedRepresentation.h
Go to the documentation of this file.
1// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2// SPDX-License-Identifier: BSD-3-Clause
19#ifndef vtkSeedRepresentation_h
20#define vtkSeedRepresentation_h
21
22#include "vtkInteractionWidgetsModule.h" // For export macro
24
25VTK_ABI_NAMESPACE_BEGIN
26class vtkHandleList;
28
29class VTKINTERACTIONWIDGETS_EXPORT vtkSeedRepresentation : public vtkWidgetRepresentation
30{
31public:
36
38
42 void PrintSelf(ostream& os, vtkIndent indent) override;
44
46
52 virtual void GetSeedWorldPosition(unsigned int seedNum, double pos[3]);
53 virtual void SetSeedWorldPosition(unsigned int seedNum, double pos[3]);
54 virtual void SetSeedDisplayPosition(unsigned int seedNum, double pos[3]);
55 virtual void GetSeedDisplayPosition(unsigned int seedNum, double pos[3]);
57
62
72
79
81
84 vtkHandleRepresentation* GetHandleRepresentation() { return this->HandleRepresentation; };
86
88
93 vtkSetClampMacro(Tolerance, int, 1, 100);
94 vtkGetMacro(Tolerance, int);
96
97 // Used to communicate about the state of the representation
98 enum
99 {
100 Outside = 0,
101 NearSeed
102 };
103
105
109 virtual int GetActiveHandle();
110 virtual void SetActiveHandle(int handleId);
111 // Returns the id of the seed created, -1 on failure. e is the display position.
112 virtual int CreateHandle(double e[2]);
113 // Delete last handle created
114 virtual void RemoveLastHandle();
115 // Delete the currently active handle
116 virtual void RemoveActiveHandle();
118
122 virtual void RemoveHandle(int n);
123
125
128 void BuildRepresentation() override;
129 int ComputeInteractionState(int X, int Y, int modify = 0) override;
132
133protected:
136
137 // The handle and the rep used to close the handles
139 vtkHandleList* Handles;
140
141 // Selection tolerance for the handles
143
144 // The active seed (handle) based on the last ComputeInteractionState()
146
147private:
149 void operator=(const vtkSeedRepresentation&) = delete;
150};
151
152VTK_ABI_NAMESPACE_END
153#endif
abstract class for representing widget handles
a simple class to control print indentation
Definition vtkIndent.h:29
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