vtkBorderWidget.h

Go to the documentation of this file.

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

  Program:   Visualization Toolkit
  Module:    vtkBorderWidget.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 vtkBorderWidget_h
#define vtkBorderWidget_h

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

class vtkBorderRepresentation;


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


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


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



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


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

  vtkBorderRepresentation *GetBorderRepresentation()
    {return reinterpret_cast<vtkBorderRepresentation*>(this->WidgetRep);}

  void CreateDefaultRepresentation() override;

protected:
  vtkBorderWidget();
  ~vtkBorderWidget() override;

  virtual void SelectRegion(double eventPos[2]);

  //enable the selection of the region interior to the widget
  vtkTypeBool Selectable;
  vtkTypeBool Resizable;

  //processes the registered events
  static void SelectAction(vtkAbstractWidget*);
  static void TranslateAction(vtkAbstractWidget*);
  static void EndSelectAction(vtkAbstractWidget*);
  static void MoveAction(vtkAbstractWidget*);

  // Special internal methods to support subclasses handling events.
  // If a non-zero value is returned, the subclass is handling the event.
  virtual int SubclassSelectAction() {return 0;}
  virtual int SubclassTranslateAction() {return 0;}
  virtual int SubclassEndSelectAction() {return 0;}
  virtual int SubclassMoveAction() {return 0;}

  // helper methods for cursoe management
  void SetCursor(int State) override;

  //widget state
  int WidgetState;
  enum _WidgetState{Start=0,Define,Manipulate,Selected};

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

#endif