VTK  9.3.0
vtkCameraOrientationWidget.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
55 #ifndef vtkCameraOrientationWidget_h
56 #define vtkCameraOrientationWidget_h
57 
58 #include "vtkAbstractWidget.h"
59 #include "vtkInteractionWidgetsModule.h" // needed for export macro
60 #include "vtkWeakPointer.h" // for weak pointer ivar
61 
62 VTK_ABI_NAMESPACE_BEGIN
65 class vtkRenderer;
66 
67 class VTKINTERACTIONWIDGETS_EXPORT vtkCameraOrientationWidget : public vtkAbstractWidget
68 {
69 public:
72  void PrintSelf(ostream& os, vtkIndent indent) override;
73 
75 
79  vtkSetMacro(Animate, bool);
80  vtkGetMacro(Animate, bool);
81  vtkBooleanMacro(Animate, bool);
83 
85 
88  vtkSetClampMacro(AnimatorTotalFrames, int, 2, VTK_INT_MAX);
89  vtkGetMacro(AnimatorTotalFrames, int);
91 
95  void CreateDefaultRepresentation() override;
96 
100  void SquareResize();
101 
103 
113 
114 protected:
116  ~vtkCameraOrientationWidget() override = default;
117 
118  // These methods handle events
119  void ComputeWidgetState(int X, int Y, int modify = 0);
123 
124  // These control the representation and parent renderer's camera.
125  void OrientParentCamera(double back[3], double up[3]);
127  void InterpolateCamera(int t);
128 
129  // Manage the state of the widget
130  enum class WidgetStateType : int
131  {
132  Inactive, // mouse is not over the widget, none of the handles are selected.
133  Hot, // mouse is over the widget but none of the handles are selected
134  Active // any one handle is selected, representation could be rotating.
135  };
136  WidgetStateType WidgetState = WidgetStateType::Inactive;
137 
139 
140  // Store camera interpolations.
142 
143  bool Animate = true;
144  int AnimatorTotalFrames = 20;
145 
146  int ResizeObserverTag = -1;
147 
148 private:
150  void operator=(const vtkCameraOrientationWidget&) = delete;
151 };
152 
153 VTK_ABI_NAMESPACE_END
154 #endif
define the API for widget / widget representation
interpolate a series of cameras to update a new camera
A 3D representation for vtkCameraOrientationWidget.
A widget to manipulate vtkCameraOrientationWidget.
vtkWeakPointer< vtkRenderer > ParentRenderer
vtkNew< vtkCameraInterpolator > CameraInterpolator
~vtkCameraOrientationWidget() override=default
static vtkCameraOrientationWidget * New()
static void SelectAction(vtkAbstractWidget *)
void PrintSelf(ostream &os, vtkIndent indent) override
Standard macros implementing standard VTK methods.
static void MoveAction(vtkAbstractWidget *)
void CreateDefaultRepresentation() override
Create a vtkCameraOrientationRepresentation.
static void EndSelectAction(vtkAbstractWidget *)
void ComputeWidgetState(int X, int Y, int modify=0)
vtkRenderer * GetParentRenderer()
This widget shows and manipulates the orientation of the parent renderer's active camera.
void SetParentRenderer(vtkRenderer *renderer)
This widget shows and manipulates the orientation of the parent renderer's active camera.
void OrientParentCamera(double back[3], double up[3])
void SquareResize()
Fits the widget's renderer to a square viewport.
a simple class to control print indentation
Definition: vtkIndent.h:38
abstract specification for renderers
Definition: vtkRenderer.h:71
#define VTK_INT_MAX
Definition: vtkType.h:144