vtkCoordinateFrameWidget.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkCoordinateFrameWidget_h
#define vtkCoordinateFrameWidget_h
 
#include "vtkAbstractWidget.h"
#include "vtkDeprecation.h"              // For VTK_DEPRECATED_IN_9_2_0
#include "vtkInteractionWidgetsModule.h" // For export macro
#include "vtkLegacy.h"                   // for VTK_LEGACY_REMOVE
 
VTK_ABI_NAMESPACE_BEGIN
class vtkCoordinateFrameRepresentation;
class vtkCoordinateFrameWidgetInteractionCallback;
 
class VTKINTERACTIONWIDGETS_EXPORT vtkCoordinateFrameWidget : public vtkAbstractWidget
{
  friend class vtkCoordinateFrameWidgetInteractionCallback;
 
public:
  static vtkCoordinateFrameWidget* New();
 
 
  vtkTypeMacro(vtkCoordinateFrameWidget, vtkAbstractWidget);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  void SetRepresentation(vtkCoordinateFrameRepresentation* rep);
 
  // Description:
  // Disable/Enable the widget if needed.
  // Unobserved the camera if the widget is disabled.
  void SetEnabled(int enabling) override;
 
  vtkCoordinateFrameRepresentation* GetCoordinateFrameRepresentation()
  {
    return reinterpret_cast<vtkCoordinateFrameRepresentation*>(this->WidgetRep);
  }
 
  void CreateDefaultRepresentation() override;
 
protected:
  vtkCoordinateFrameWidget();
  ~vtkCoordinateFrameWidget() override;
 
  // Manage the state of the widget
  int WidgetState;
  enum WidgetStateType
  {
    Start = 0,
    Active
  };
#if !defined(VTK_LEGACY_REMOVE)
  VTK_DEPRECATED_IN_9_2_0("because leading underscore is reserved")
  typedef WidgetStateType _WidgetState;
#endif
 
  // These methods handle events
  static void SelectAction(vtkAbstractWidget*);
  static void PickOriginAction(vtkAbstractWidget*);
  static void PickNormalAction(vtkAbstractWidget*);
  static void PickDirectionPointAction(vtkAbstractWidget* w);
  static void TranslateAction(vtkAbstractWidget*);
  static void EndSelectAction(vtkAbstractWidget*);
  static void MoveAction(vtkAbstractWidget*);
  static void TranslationAxisLock(vtkAbstractWidget*);
  static void TranslationAxisUnLock(vtkAbstractWidget*);
 
  int UpdateCursorShape(int interactionState);
 
 
  vtkCoordinateFrameWidgetInteractionCallback* InteractionCallback;
  void InvokeInteractionCallback();
private:
  vtkCoordinateFrameWidget(const vtkCoordinateFrameWidget&) = delete;
  void operator=(const vtkCoordinateFrameWidget&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif