VTK  9.2.6
vtkCoordinateFrameWidget.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkCoordinateFrameWidget.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 =========================================================================*/
95 #ifndef vtkCoordinateFrameWidget_h
96 #define vtkCoordinateFrameWidget_h
97 
98 #include "vtkAbstractWidget.h"
99 #include "vtkDeprecation.h" // For VTK_DEPRECATED_IN_9_2_0
100 #include "vtkInteractionWidgetsModule.h" // For export macro
101 
103 class vtkCoordinateFrameWidgetInteractionCallback;
104 
105 class VTKINTERACTIONWIDGETS_EXPORT vtkCoordinateFrameWidget : public vtkAbstractWidget
106 {
107  friend class vtkCoordinateFrameWidgetInteractionCallback;
108 
109 public:
114 
116 
120  void PrintSelf(ostream& os, vtkIndent indent) override;
122 
129 
130  // Description:
131  // Disable/Enable the widget if needed.
132  // Unobserved the camera if the widget is disabled.
133  void SetEnabled(int enabling) override;
134 
139  {
140  return reinterpret_cast<vtkCoordinateFrameRepresentation*>(this->WidgetRep);
141  }
142 
147 
148 protected:
151 
152  // Manage the state of the widget
155  {
156  Start = 0,
157  Active
158  };
159 #if !defined(VTK_LEGACY_REMOVE)
160  VTK_DEPRECATED_IN_9_2_0("because leading underscore is reserved")
162 #endif
163 
164  // These methods handle events
174 
179  int UpdateCursorShape(int interactionState);
180 
182 
185  vtkCoordinateFrameWidgetInteractionCallback* InteractionCallback;
188 private:
190  void operator=(const vtkCoordinateFrameWidget&) = delete;
191 };
192 
193 #endif
define the API for widget / widget representation
vtkWidgetRepresentation * WidgetRep
a class defining the representation for a vtkCoordinateFrameWidget
3D widget for manipulating a display sized coordinate frame widget
static void PickDirectionPointAction(vtkAbstractWidget *w)
void CreateDefaultRepresentation() override
Create the default widget representation if one is not set.
static void EndSelectAction(vtkAbstractWidget *)
int UpdateCursorShape(int interactionState)
Update the cursor shape based on the interaction state.
~vtkCoordinateFrameWidget() override
static void MoveAction(vtkAbstractWidget *)
static void TranslateAction(vtkAbstractWidget *)
vtkCoordinateFrameWidgetInteractionCallback * InteractionCallback
Handle the interaction callback that may come from the representation.
static void SelectAction(vtkAbstractWidget *)
static void PickNormalAction(vtkAbstractWidget *)
static void TranslationAxisLock(vtkAbstractWidget *)
void PrintSelf(ostream &os, vtkIndent indent) override
Standard vtkObject methods.
static void PickOriginAction(vtkAbstractWidget *)
void SetRepresentation(vtkCoordinateFrameRepresentation *rep)
Specify an instance of vtkWidgetRepresentation used to represent this widget in the scene.
void SetEnabled(int enabling) override
Methods for activating this widget.
vtkCoordinateFrameRepresentation * GetCoordinateFrameRepresentation()
Return the representation as a vtkCoordinateFrameRepresentation.
void InvokeInteractionCallback()
Handle the interaction callback that may come from the representation.
static vtkCoordinateFrameWidget * New()
Instantiate the object.
static void TranslationAxisUnLock(vtkAbstractWidget *)
a simple class to control print indentation
Definition: vtkIndent.h:119
#define VTK_DEPRECATED_IN_9_2_0(reason)