vtkMRMLMarkupsDisplayableManager.h

Go to the documentation of this file.

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

  Program: 3D Slicer

  Portions (c) Copyright Brigham and Women's Hospital (BWH) 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.

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

#ifndef __vtkMRMLMarkupsDisplayableManager_h
#define __vtkMRMLMarkupsDisplayableManager_h

// MarkupsModule includes
#include "vtkSlicerMarkupsModuleMRMLDisplayableManagerExport.h"

// MarkupsModule/MRMLDisplayableManager includes
#include "vtkMRMLMarkupsDisplayableManagerHelper.h"

// MRMLDisplayableManager includes
#include <vtkMRMLAbstractDisplayableManager.h>

// VTK includes
#include <vtkSlicerMarkupsWidget.h>

// STD includes
#include <map>

class vtkMRMLMarkupsNode;
class vtkSlicerViewerWidget;
class vtkMRMLMarkupsDisplayNode;
class vtkAbstractWidget;

class  VTK_SLICER_MARKUPS_MODULE_MRMLDISPLAYABLEMANAGER_EXPORT vtkMRMLMarkupsDisplayableManager :
    public vtkMRMLAbstractDisplayableManager
{
public:

  // Allow the helper to call protected methods of displayable manager
  friend class vtkMRMLMarkupsDisplayableManagerHelper;

  static vtkMRMLMarkupsDisplayableManager *New();
  vtkTypeMacro(vtkMRMLMarkupsDisplayableManager, vtkMRMLAbstractDisplayableManager);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  virtual bool Is2DDisplayableManager();
  vtkMRMLSliceNode * GetMRMLSliceNode();

  vtkMRMLMarkupsDisplayableManagerHelper *  GetHelper() { return this->Helper; };

  bool CanProcessInteractionEvent(vtkMRMLInteractionEventData* eventData, double &closestDistance2) override;
  bool ProcessInteractionEvent(vtkMRMLInteractionEventData* eventData) override;

  void SetHasFocus(bool hasFocus, vtkMRMLInteractionEventData* eventData) override;
  bool GetGrabFocus() override;
  bool GetInteractive() override;
  int GetMouseCursor() override;

  // Updates markup point preview position.
  // Returns true if the event is processed.
  vtkSlicerMarkupsWidget* GetWidgetForPlacement();

  vtkMRMLMarkupsNode* GetActiveMarkupsNodeForPlacement();

  int GetCurrentInteractionMode();

  // Methods from vtkMRMLAbstractSliceViewDisplayableManager

  void ConvertDeviceToXYZ(double x, double y, double xyz[3]);

  vtkSlicerMarkupsWidget* GetWidget(vtkMRMLMarkupsDisplayNode * node);

protected:

  vtkMRMLMarkupsDisplayableManager();
  ~vtkMRMLMarkupsDisplayableManager() override;

  vtkSlicerMarkupsWidget* FindClosestWidget(vtkMRMLInteractionEventData *callData, double &closestDistance2);

  void ProcessMRMLNodesEvents(vtkObject *caller, unsigned long event, void *callData) override;

  virtual void RequestRender();

  void UpdateFromMRML() override;

  void SetMRMLSceneInternal(vtkMRMLScene* newScene) override;

  void UpdateFromMRMLScene() override;
  void OnMRMLSceneEndClose() override;
  void OnMRMLSceneEndImport() override;
  void OnMRMLSceneNodeAdded(vtkMRMLNode* node) override;
  void OnMRMLSceneNodeRemoved(vtkMRMLNode* node) override;

  vtkSlicerMarkupsWidget* CreateWidget(vtkMRMLMarkupsDisplayNode* node);

  void OnMRMLDisplayableNodeModifiedEvent(vtkObject* caller) override;

  virtual void OnMRMLSliceNodeModifiedEvent();

  void AddObserversToInteractionNode();
  void RemoveObserversFromInteractionNode();

  virtual bool IsCorrectDisplayableManager();

  virtual bool IsManageable(vtkMRMLNode* node);
  virtual bool IsManageable(const char* nodeClassName);

  void OnInteractorStyleEvent(int eventid) override;

  vtkGetMacro(DisableInteractorStyleEventsProcessing, int);

  vtkSmartPointer<vtkMRMLMarkupsDisplayableManagerHelper> Helper;

  double LastClickWorldCoordinates[4];

  vtkWeakPointer<vtkSlicerMarkupsWidget> LastActiveWidget;

private:
  vtkMRMLMarkupsDisplayableManager(const vtkMRMLMarkupsDisplayableManager&) = delete;
  void operator=(const vtkMRMLMarkupsDisplayableManager&) = delete;

  int DisableInteractorStyleEventsProcessing;

  // by default, this displayableManager handles a 2d view, so the SliceNode
  // must be set when it's assigned to a viewer
  vtkWeakPointer<vtkMRMLSliceNode> SliceNode;
};

#endif