VTK  9.0.1
vtkRectilinearWipeRepresentation.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkRectilinearWipeRepresentation.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 =========================================================================*/
39 #ifndef vtkRectilinearWipeRepresentation_h
40 #define vtkRectilinearWipeRepresentation_h
41 
42 #include "vtkInteractionWidgetsModule.h" // For export macro
44 
46 class vtkImageActor;
47 class vtkPoints;
48 class vtkCellArray;
49 class vtkPolyData;
50 class vtkProperty2D;
52 class vtkActor2D;
53 
54 class VTKINTERACTIONWIDGETS_EXPORT vtkRectilinearWipeRepresentation : public vtkWidgetRepresentation
55 {
56 public:
61 
63 
67  void PrintSelf(ostream& os, vtkIndent indent) override;
69 
71 
74  void SetRectilinearWipe(vtkImageRectilinearWipe* wipe);
75  vtkGetObjectMacro(RectilinearWipe, vtkImageRectilinearWipe);
77 
79 
82  void SetImageActor(vtkImageActor* imageActor);
83  vtkGetObjectMacro(ImageActor, vtkImageActor);
85 
87 
92  vtkSetClampMacro(Tolerance, int, 1, 10);
93  vtkGetMacro(Tolerance, int);
95 
97 
101  vtkGetObjectMacro(Property, vtkProperty2D);
103 
105 
110  void BuildRepresentation() override;
111  void StartWidgetInteraction(double eventPos[2]) override;
112  void WidgetInteraction(double eventPos[2]) override;
113  int ComputeInteractionState(int X, int Y, int modify = 0) override;
115 
116  // Enums define the state of the prop relative to the mouse pointer
117  // position. Used by ComputeInteractionState() to communicate with the
118  // widget.
120  {
121  Outside = 0,
124  MovingCenter
125  };
126 
128 
131  void GetActors2D(vtkPropCollection*) override;
132  void ReleaseGraphicsResources(vtkWindow*) override;
133  int RenderOverlay(vtkViewport* viewport) override;
134  int RenderOpaqueGeometry(vtkViewport* viewport) override;
135  int RenderTranslucentPolygonalGeometry(vtkViewport* viewport) override;
138 
139 protected:
142 
143  // Instances that this class manipulates
146 
147  // The pick tolerance of the widget in pixels
149 
150  // This is used to track the beginning of interaction with the prop
151  double StartWipePosition[2];
152 
153  // Indicates which part of widget is currently active based on the
154  // state of the instance of the vtkImageRectilinearWipe.
156 
157  // Geometric structure of widget
158  vtkPoints* Points; // The nine points defining the widget geometry
159  vtkCellArray* Lines; // lines defining the boundary
164 
165  // These are used to track the coordinates (in display coordinate system)
166  // of the mid-edge and center point of the widget
167  double DP4[3];
168  double DP5[3];
169  double DP6[3];
170  double DP7[3];
171  double DP8[3];
172 
173  int Dims[3]; // Dimensions of the input image to the wipe
174  int I; // the i-j define the plane that is being displayed
175  int J;
176 
177 private:
179  void operator=(const vtkRectilinearWipeRepresentation&) = delete;
180 };
181 
182 #endif
vtkPoints
represent and manipulate 3D points
Definition: vtkPoints.h:33
vtkWidgetRepresentation::StartWidgetInteraction
virtual void StartWidgetInteraction(double eventPos[2])
Definition: vtkWidgetRepresentation.h:135
vtkWidgetRepresentation.h
vtkPolyDataMapper2D
draw vtkPolyData onto the image plane
Definition: vtkPolyDataMapper2D.h:44
vtkRectilinearWipeRepresentation::WipeActor
vtkActor2D * WipeActor
Definition: vtkRectilinearWipeRepresentation.h:162
vtkRectilinearWipeRepresentation
represent a vtkRectilinearWipeWidget
Definition: vtkRectilinearWipeRepresentation.h:54
vtkObject::New
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
vtkWidgetRepresentation
abstract class defines interface between the widget and widget representation classes
Definition: vtkWidgetRepresentation.h:59
vtkImageRectilinearWipe
make a rectilinear combination of two images.
Definition: vtkImageRectilinearWipe.h:61
vtkRectilinearWipeRepresentation::ActiveParts
int ActiveParts
Definition: vtkRectilinearWipeRepresentation.h:155
vtkWidgetRepresentation::BuildRepresentation
virtual void BuildRepresentation()=0
vtkWidgetRepresentation::GetActors2D
void GetActors2D(vtkPropCollection *) override
Definition: vtkWidgetRepresentation.h:211
vtkWindow
window superclass for vtkRenderWindow
Definition: vtkWindow.h:37
vtkRectilinearWipeRepresentation::RectilinearWipe
vtkImageRectilinearWipe * RectilinearWipe
Definition: vtkRectilinearWipeRepresentation.h:144
vtkWidgetRepresentation::RenderTranslucentPolygonalGeometry
int RenderTranslucentPolygonalGeometry(vtkViewport *vtkNotUsed(viewport)) override
Definition: vtkWidgetRepresentation.h:216
vtkWidgetRepresentation::ReleaseGraphicsResources
void ReleaseGraphicsResources(vtkWindow *) override
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being...
Definition: vtkWidgetRepresentation.h:213
vtkRectilinearWipeRepresentation::Points
vtkPoints * Points
Definition: vtkRectilinearWipeRepresentation.h:158
vtkWidgetRepresentation::WidgetInteraction
virtual void WidgetInteraction(double newEventPos[2])
Definition: vtkWidgetRepresentation.h:136
vtkRectilinearWipeRepresentation::ImageActor
vtkImageActor * ImageActor
Definition: vtkRectilinearWipeRepresentation.h:145
vtkRectilinearWipeRepresentation::WipeMapper
vtkPolyDataMapper2D * WipeMapper
Definition: vtkRectilinearWipeRepresentation.h:161
vtkRectilinearWipeRepresentation::MovingHPane
@ MovingHPane
Definition: vtkRectilinearWipeRepresentation.h:122
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:33
vtkCellArray
object to represent cell connectivity
Definition: vtkCellArray.h:179
vtkRectilinearWipeRepresentation::MovingVPane
@ MovingVPane
Definition: vtkRectilinearWipeRepresentation.h:123
vtkRectilinearWipeRepresentation::Property
vtkProperty2D * Property
Definition: vtkRectilinearWipeRepresentation.h:163
vtkViewport
abstract specification for Viewports
Definition: vtkViewport.h:44
vtkRectilinearWipeRepresentation::_InteractionState
_InteractionState
Definition: vtkRectilinearWipeRepresentation.h:119
vtkProperty2D
represent surface properties of a 2D image
Definition: vtkProperty2D.h:37
vtkActor2D
a actor that draws 2D data
Definition: vtkActor2D.h:39
vtkWidgetRepresentation::RenderOverlay
int RenderOverlay(vtkViewport *vtkNotUsed(viewport)) override
Definition: vtkWidgetRepresentation.h:214
vtkWidgetRepresentation::RenderOpaqueGeometry
int RenderOpaqueGeometry(vtkViewport *vtkNotUsed(viewport)) override
Definition: vtkWidgetRepresentation.h:215
vtkRectilinearWipeRepresentation::J
int J
Definition: vtkRectilinearWipeRepresentation.h:175
vtkRectilinearWipeRepresentation::I
int I
Definition: vtkRectilinearWipeRepresentation.h:174
vtkRectilinearWipeRepresentation::Lines
vtkCellArray * Lines
Definition: vtkRectilinearWipeRepresentation.h:159
vtkImageActor
draw an image in a rendered 3D scene
Definition: vtkImageActor.h:42
vtkPolyData
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:84
vtkWidgetRepresentation::HasTranslucentPolygonalGeometry
vtkTypeBool HasTranslucentPolygonalGeometry() override
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDE...
Definition: vtkWidgetRepresentation.h:218
vtkPropCollection
an ordered list of Props
Definition: vtkPropCollection.h:35
vtkRectilinearWipeRepresentation::Wipe
vtkPolyData * Wipe
Definition: vtkRectilinearWipeRepresentation.h:160
vtkTypeBool
int vtkTypeBool
Definition: vtkABI.h:69
vtkWidgetRepresentation::ComputeInteractionState
virtual int ComputeInteractionState(int X, int Y, int modify=0)
vtkWidgetRepresentation::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkRectilinearWipeRepresentation::Tolerance
int Tolerance
Definition: vtkRectilinearWipeRepresentation.h:148