vtkMRMLAbstractWidget.h

Go to the documentation of this file.

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

 Copyright (c) ProxSim ltd., Kwun Tong, Hong Kong. All Rights Reserved.

 See COPYRIGHT.txt
 or http://www.slicer.org/copyright/copyright.txt for details.

 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.

 This file was originally developed by Davide Punzo, punzodavide@hotmail.it,
 and development was supported by ProxSim ltd.

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

#ifndef vtkMRMLAbstractWidget_h
#define vtkMRMLAbstractWidget_h

#include "vtkMRMLDisplayableManagerExport.h"
#include "vtkObject.h"
#include "vtkSmartPointer.h"
#include "vtkWeakPointer.h"
#include <vector>

class vtkMRMLAbstractViewNode;
class vtkMRMLApplicationLogic;
class vtkMRMLInteractionEventData;
class vtkMRMLInteractionNode;
class vtkMRMLNode;
class vtkMRMLAbstractWidgetRepresentation;
class vtkRenderer;
class vtkWidgetEventTranslator;

class VTK_MRML_DISPLAYABLEMANAGER_EXPORT vtkMRMLAbstractWidget : public vtkObject
{
public:
  vtkTypeMacro(vtkMRMLAbstractWidget, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  virtual void SetMRMLApplicationLogic(vtkMRMLApplicationLogic* applicationLogic);
  vtkMRMLApplicationLogic* GetMRMLApplicationLogic();

  virtual void SetRepresentation(vtkMRMLAbstractWidgetRepresentation *r);

  virtual vtkMRMLAbstractWidgetRepresentation *GetRepresentation();

  virtual void UpdateFromMRML(vtkMRMLNode* caller, unsigned long event, void *callData = nullptr);

  vtkSetMacro(WidgetState,int);

  vtkGetMacro(WidgetState,int);

  enum
  {
    WidgetStateAny, 
    WidgetStateIdle, 
    WidgetStateOnWidget, 
    WidgetStateTranslate, 
    WidgetStateRotate, 
    WidgetStateScale, 
    WidgetStateUser 
  };

  enum WidgetEvents
  {
    WidgetEventNone,
    WidgetEventMouseMove,
    WidgetEventTranslateStart,
    WidgetEventTranslateEnd,
    WidgetEventRotateStart,
    WidgetEventRotateEnd,
    WidgetEventScaleStart,
    WidgetEventScaleEnd,
    // MRML events
    WidgetEventPick, 
    WidgetEventJumpCursor, 
    WidgetEventAction, // generates a MRML Action event (e.g., left double-click)
    WidgetEventCustomAction1, 
    WidgetEventCustomAction2, 
    WidgetEventCustomAction3, 
    WidgetEventCustomAction4, 
    WidgetEventCustomAction5, 
    WidgetEventCustomAction6, 
    WidgetEventSelect, 
    WidgetEventUnselect, 
    WidgetEventToggleSelect, 
    // Other actions
    WidgetEventMenu, 
    WidgetEventReset, 
    WidgetEventUser 
  };

  virtual bool CanProcessInteractionEvent(vtkMRMLInteractionEventData* eventData, double &distance2);

  virtual bool ProcessInteractionEvent(vtkMRMLInteractionEventData* eventData);

  void SetEventTranslation(int widgetState, unsigned long interactionEvent, int modifiers, unsigned long widgetEvent);

  void SetEventTranslationClickAndDrag(int widgetState, unsigned long startInteractionEvent, int modifiers,
    int widgetStateDragging, unsigned long widgetStartEvent, unsigned long widgetEndEvent);

  void SetEventTranslation(unsigned long interactionEvent, int modifiers, unsigned long widgetEvent);

  void SetKeyboardEventTranslation(int modifier, char keyCode, int repeatCount, const char* keySym, unsigned long widgetEvent);

  void SetKeyboardEventTranslation(int widgetState, int modifier, char keyCode, int repeatCount, const char* keySym, unsigned long widgetEvent);

  virtual unsigned long TranslateInteractionEventToWidgetEvent(vtkMRMLInteractionEventData* eventData);

  virtual void Leave(vtkMRMLInteractionEventData* eventData);

  void SetRenderer(vtkRenderer* renderer);
  vtkRenderer* GetRenderer();

  vtkMRMLInteractionNode* GetInteractionNode();

  // Allows the widget to request a cursor shape
  virtual int GetMouseCursor();

  // Allows the widget to request grabbing of all events (even when the mouse pointer moves out of view)
  virtual bool GetGrabFocus();

  // Allows the widget to request interactive mode (faster updates)
  virtual bool GetInteractive();

  // Allows the widget to request render
  virtual bool GetNeedToRender();

  // Acknowledge rendering request (rendering completed)
  virtual void NeedToRenderOff();

  virtual vtkWidgetEventTranslator* GetEventTranslator(int widgetState);

  virtual int GetNumberOfEventTranslators();

protected:
  vtkMRMLAbstractWidget();
  ~vtkMRMLAbstractWidget() override;

  const char* GetAssociatedNodeID(vtkMRMLInteractionEventData* eventData);

  unsigned long TranslateInteractionEventToWidgetEvent(
    vtkWidgetEventTranslator* translator, vtkMRMLInteractionEventData* eventData);

  bool CanProcessButtonClickEvent(vtkMRMLInteractionEventData* eventData, double& distance2);

  virtual int ProcessButtonClickEvent(vtkMRMLInteractionEventData* eventData);

  vtkWeakPointer<vtkRenderer> Renderer;

  vtkWeakPointer<vtkMRMLApplicationLogic> ApplicationLogic;

  // Translates interaction event to widget event.
  // In the future, a vector of event translators could be added
  // (one for each state) to be able to define events
  // that are only allowed in a specific state.
  std::vector< vtkSmartPointer<vtkWidgetEventTranslator> > EventTranslators;

  int WidgetState;

  vtkSmartPointer<vtkMRMLAbstractWidgetRepresentation> WidgetRep;

//  bool NeedToRender;

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

#endif