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=========================================================================*/
92#ifndef vtkCoordinateFrameWidget_h
93#define vtkCoordinateFrameWidget_h
94
95#include "vtkAbstractWidget.h"
96#include "vtkDeprecation.h" // For VTK_DEPRECATED_IN_9_2_0
97#include "vtkInteractionWidgetsModule.h" // For export macro
98
100class vtkCoordinateFrameWidgetInteractionCallback;
101
102class VTKINTERACTIONWIDGETS_EXPORT vtkCoordinateFrameWidget : public vtkAbstractWidget
103{
104 friend class vtkCoordinateFrameWidgetInteractionCallback;
105
106public:
111
113
117 void PrintSelf(ostream& os, vtkIndent indent) override;
119
126
127 // Description:
128 // Disable/Enable the widget if needed.
129 // Unobserved the camera if the widget is disabled.
130 void SetEnabled(int enabling) override;
131
136 {
137 return reinterpret_cast<vtkCoordinateFrameRepresentation*>(this->WidgetRep);
138 }
139
144
145protected:
148
149 // Manage the state of the widget
152 {
153 Start = 0,
154 Active
155 };
156#if !defined(VTK_LEGACY_REMOVE)
157 VTK_DEPRECATED_IN_9_2_0("because leading underscore is reserved")
159#endif
160
161 // These methods handle events
171
176 int UpdateCursorShape(int interactionState);
177
179
182 vtkCoordinateFrameWidgetInteractionCallback* InteractionCallback;
185private:
187 void operator=(const vtkCoordinateFrameWidget&) = delete;
188};
189
190#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.
vtkCoordinateFrameRepresentation * GetCoordinateFrameRepresentation()
Return the representation as a vtkCoordinateFrameRepresentation.
~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 vtkCoordinateFrameWidget * New()
Instantiate the object.
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.
void InvokeInteractionCallback()
Handle the interaction callback that may come from the representation.
static void TranslationAxisUnLock(vtkAbstractWidget *)
a simple class to control print indentation
Definition vtkIndent.h:34
#define VTK_DEPRECATED_IN_9_2_0(reason)