vtkHandleWidget.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Visualization Toolkit
  Module:    vtkHandleWidget.h

  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.

=========================================================================*/
#ifndef vtkHandleWidget_h
#define vtkHandleWidget_h

#include "vtkInteractionWidgetsModule.h" // For export macro
#include "vtkAbstractWidget.h"

class vtkHandleRepresentation;


class VTKINTERACTIONWIDGETS_EXPORT vtkHandleWidget : public vtkAbstractWidget
{
public:
  static vtkHandleWidget *New();


  vtkTypeMacro(vtkHandleWidget,vtkAbstractWidget);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  void SetRepresentation(vtkHandleRepresentation *r)
    {this->Superclass::SetWidgetRepresentation(reinterpret_cast<vtkWidgetRepresentation*>(r));}

  vtkHandleRepresentation *GetHandleRepresentation()
    {return reinterpret_cast<vtkHandleRepresentation*>(this->WidgetRep);}

  void CreateDefaultRepresentation() override;


  vtkSetMacro( EnableAxisConstraint, vtkTypeBool );
  vtkGetMacro( EnableAxisConstraint, vtkTypeBool );
  vtkBooleanMacro( EnableAxisConstraint, vtkTypeBool );


  vtkSetMacro(EnableTranslation, vtkTypeBool);
  vtkGetMacro(EnableTranslation, vtkTypeBool);
  vtkBooleanMacro(EnableTranslation, vtkTypeBool);


  vtkSetMacro( AllowHandleResize, vtkTypeBool );
  vtkGetMacro( AllowHandleResize, vtkTypeBool );
  vtkBooleanMacro( AllowHandleResize, vtkTypeBool );


  vtkGetMacro( WidgetState, int );


  vtkSetMacro( ShowInactive, vtkTypeBool );
  vtkGetMacro( ShowInactive, vtkTypeBool );
  vtkBooleanMacro( ShowInactive, vtkTypeBool );

  // Manage the state of the widget
  enum _WidgetState {Start=0,Active,Inactive};

  void SetEnabled(int enabling) override;

protected:
  vtkHandleWidget();
  ~vtkHandleWidget() override;

  // These are the callbacks for this widget
  static void GenericAction(vtkHandleWidget*);
  static void SelectAction(vtkAbstractWidget*);
  static void EndSelectAction(vtkAbstractWidget*);
  static void TranslateAction(vtkAbstractWidget*);
  static void ScaleAction(vtkAbstractWidget*);
  static void MoveAction(vtkAbstractWidget*);
  static void SelectAction3D(vtkAbstractWidget*);
  static void MoveAction3D(vtkAbstractWidget*);

  // helper methods for cursor management
  void SetCursor(int state) override;

  int WidgetState;
  vtkTypeBool EnableAxisConstraint;
  vtkTypeBool EnableTranslation;

  // Allow resizing of handles.
  vtkTypeBool AllowHandleResize;

  // Keep representation visible when disabled
  vtkTypeBool ShowInactive;

private:
  vtkHandleWidget(const vtkHandleWidget&) = delete;
  void operator=(const vtkHandleWidget&) = delete;
};

#endif