VTK
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 =========================================================================*/
31 #ifndef vtkSeedRepresentation_h
32 #define vtkSeedRepresentation_h
33 
34 #include "vtkInteractionWidgetsModule.h" // For export macro
36 
37 class vtkHandleList;
39 
40 
41 class VTKINTERACTIONWIDGETS_EXPORT vtkSeedRepresentation : public vtkWidgetRepresentation
42 {
43 public:
48 
50 
54  void PrintSelf(ostream& os, vtkIndent indent) override;
56 
58 
64  virtual void GetSeedWorldPosition( unsigned int seedNum, double pos[3] );
65  virtual void SetSeedWorldPosition( unsigned int seedNum, double pos[3] );
66  virtual void SetSeedDisplayPosition( unsigned int seedNum, double pos[3] );
67  virtual void GetSeedDisplayPosition( unsigned int seedNum, double pos[3] );
69 
74 
84 
91 
93 
97  {
98  return this->HandleRepresentation;
99  };
101 
103 
108  vtkSetClampMacro( Tolerance, int, 1, 100 );
109  vtkGetMacro( Tolerance, int );
111 
112  // Used to communicate about the state of the representation
113  enum
114  {
115  Outside = 0,
116  NearSeed
117  };
118 
120 
124  virtual int GetActiveHandle();
125  virtual void SetActiveHandle( int handleId );
126  // Returns the id of the seed created, -1 on failure. e is the display position.
127  virtual int CreateHandle( double e[2] );
128  // Delete last handle created
129  virtual void RemoveLastHandle();
130  // Delete the currently active handle
131  virtual void RemoveActiveHandle();
133 
137  virtual void RemoveHandle( int n );
138 
140 
143  void BuildRepresentation() override;
144  int ComputeInteractionState( int X, int Y, int modify = 0 ) override;
146 
147 protected:
150 
151  // The handle and the rep used to close the handles
153  vtkHandleList *Handles;
154 
155  // Selection tolerance for the handles
157 
158  // The active seed (handle) based on the last ComputeInteractionState()
160 
161 private:
163  void operator=(const vtkSeedRepresentation&) = delete;
164 };
165 
166 #endif
vtkWidgetRepresentation.h
vtkSeedRepresentation::ComputeInteractionState
int ComputeInteractionState(int X, int Y, int modify=0) override
vtkSeedRepresentation::GetSeedDisplayPosition
virtual void GetSeedDisplayPosition(unsigned int seedNum, double pos[3])
vtkSeedRepresentation::~vtkSeedRepresentation
~vtkSeedRepresentation() override
vtkSeedRepresentation::GetNumberOfSeeds
int GetNumberOfSeeds()
Return the number of seeds (or handles) that have been created.
vtkWidgetRepresentation
abstract class defines interface between the widget and widget representation classes
Definition: vtkWidgetRepresentation.h:61
vtkHandleRepresentation
abstract class for representing widget handles
Definition: vtkHandleRepresentation.h:59
vtkSeedRepresentation::GetSeedWorldPosition
virtual void GetSeedWorldPosition(unsigned int seedNum, double pos[3])
Methods to Set/Get the coordinates of seed points defining this representation.
vtkSeedRepresentation::BuildRepresentation
void BuildRepresentation() override
These are methods that satisfy vtkWidgetRepresentation's API.
vtkSeedRepresentation::SetActiveHandle
virtual void SetActiveHandle(int handleId)
vtkSeedRepresentation::SetSeedDisplayPosition
virtual void SetSeedDisplayPosition(unsigned int seedNum, double pos[3])
vtkSeedRepresentation::GetHandleRepresentation
vtkHandleRepresentation * GetHandleRepresentation()
Returns the model HandleRepresentation.
Definition: vtkSeedRepresentation.h:96
vtkSeedRepresentation::Handles
vtkHandleList * Handles
Definition: vtkSeedRepresentation.h:153
vtkSeedRepresentation::vtkSeedRepresentation
vtkSeedRepresentation()
vtkSeedRepresentation::SetSeedWorldPosition
virtual void SetSeedWorldPosition(unsigned int seedNum, double pos[3])
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:40
vtkSeedRepresentation::HandleRepresentation
vtkHandleRepresentation * HandleRepresentation
Definition: vtkSeedRepresentation.h:152
vtkSeedRepresentation::CreateHandle
virtual int CreateHandle(double e[2])
vtkSeedRepresentation::New
static vtkSeedRepresentation * New()
Instantiate class.
vtkSeedRepresentation::ActiveHandle
int ActiveHandle
Definition: vtkSeedRepresentation.h:159
vtkSeedRepresentation::GetHandleRepresentation
vtkHandleRepresentation * GetHandleRepresentation(unsigned int num)
Get the handle representations used for a particular seed.
vtkSeedRepresentation::GetActiveHandle
virtual int GetActiveHandle()
These are methods specific to vtkSeedRepresentation and which are invoked from vtkSeedWidget.
vtkSeedRepresentation::RemoveHandle
virtual void RemoveHandle(int n)
Remove the nth handle.
vtkSeedRepresentation
represent the vtkSeedWidget
Definition: vtkSeedRepresentation.h:42
vtkSeedRepresentation::RemoveLastHandle
virtual void RemoveLastHandle()
vtkSeedRepresentation::SetHandleRepresentation
void SetHandleRepresentation(vtkHandleRepresentation *handle)
This method is used to specify the type of handle representation to use for the internal vtkHandleWid...
vtkSeedRepresentation::RemoveActiveHandle
virtual void RemoveActiveHandle()
vtkSeedRepresentation::Tolerance
int Tolerance
Definition: vtkSeedRepresentation.h:156
vtkSeedRepresentation::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.