VTK  9.2.5
vtkCameraOrientationWidget.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkCameraOrientationWidget.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 =========================================================================*/
157 #ifndef vtkCameraOrientationWidget_h
158 #define vtkCameraOrientationWidget_h
159 
160 #include "vtkAbstractWidget.h"
161 #include "vtkInteractionWidgetsModule.h" // needed for export macro
162 #include "vtkWeakPointer.h" // for weak pointer ivar
163 
166 class vtkRenderer;
167 
168 class VTKINTERACTIONWIDGETS_EXPORT vtkCameraOrientationWidget : public vtkAbstractWidget
169 {
170 public:
173  void PrintSelf(ostream& os, vtkIndent indent) override;
174 
176 
180  vtkSetMacro(Animate, bool);
181  vtkGetMacro(Animate, bool);
182  vtkBooleanMacro(Animate, bool);
184 
186 
189  vtkSetClampMacro(AnimatorTotalFrames, int, 2, VTK_INT_MAX);
190  vtkGetMacro(AnimatorTotalFrames, int);
192 
197 
201  void SquareResize();
202 
204 
214 
215 protected:
217  ~vtkCameraOrientationWidget() override = default;
218 
219  // These methods handle events
220  void ComputeWidgetState(int X, int Y, int modify = 0);
224 
225  // These control the representation and parent renderer's camera.
226  void OrientParentCamera(double back[3], double up[3]);
228  void InterpolateCamera(int t);
229 
230  // Manage the state of the widget
231  enum class WidgetStateType : int
232  {
233  Inactive, // mouse is not over the widget, none of the handles are selected.
234  Hot, // mouse is over the widget but none of the handles are selected
235  Active // any one handle is selected, representation could be rotating.
236  };
237  WidgetStateType WidgetState = WidgetStateType::Inactive;
238 
240 
241  // Store camera interpolations.
243 
244  bool Animate = true;
245  int AnimatorTotalFrames = 20;
246 
247  int ResizeObserverTag = -1;
248 
249 private:
251  void operator=(const vtkCameraOrientationWidget&) = delete;
252 };
253 
254 #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:119
abstract specification for renderers
Definition: vtkRenderer.h:182
#define VTK_INT_MAX
Definition: vtkType.h:155