qSlicerSegmentEditorPaintEffect.h

Go to the documentation of this file.

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

  Copyright (c) Laboratory for Percutaneous Surgery (PerkLab)
  Queen's University, Kingston, ON, Canada. 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 Csaba Pinter, PerkLab, Queen's University
  and was supported through the Applied Cancer Research Unit program of Cancer Care
  Ontario with funds provided by the Ontario Ministry of Health and Long-Term Care

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

#ifndef __qSlicerSegmentEditorPaintEffect_h
#define __qSlicerSegmentEditorPaintEffect_h

// Segmentations Editor Effects includes
#include "qSlicerSegmentationsEditorEffectsExport.h"

#include "qSlicerSegmentEditorAbstractLabelEffect.h"

class qSlicerSegmentEditorPaintEffectPrivate;
class vtkPolyData;

class Q_SLICER_SEGMENTATIONS_EFFECTS_EXPORT qSlicerSegmentEditorPaintEffect :
  public qSlicerSegmentEditorAbstractLabelEffect
{
  Q_OBJECT

public:
  Q_PROPERTY(double minimumPaintPointDistance READ minimumPaintPointDistance WRITE setMinimumPaintPointDistance)
  Q_PROPERTY(bool delayedPaint READ delayedPaint WRITE setDelayedPaint)

  typedef qSlicerSegmentEditorAbstractLabelEffect Superclass;
  qSlicerSegmentEditorPaintEffect(QObject* parent = nullptr);
  ~qSlicerSegmentEditorPaintEffect() override;

public:
  QIcon icon() override;

  const QString helpText()const override;

  qSlicerSegmentEditorAbstractEffect* clone() override;

  void deactivate() override;

  bool processInteractionEvents(vtkRenderWindowInteractor* callerInteractor, unsigned long eid, qMRMLWidget* viewWidget) override;

  void processViewNodeEvents(vtkMRMLAbstractViewNode* callerViewNode, unsigned long eid, qMRMLWidget* viewWidget) override;

  void setupOptionsFrame() override;

  void setMRMLDefaults() override;

  void referenceGeometryChanged() override;

  Q_INVOKABLE double minimumPaintPointDistance();

  Q_INVOKABLE bool delayedPaint();

  // returns extent of the brushes
  Q_INVOKABLE QList<int> paintBrushesIntoLabelmap(vtkOrientedImageData* labelmap, qMRMLWidget* viewWidget);

  Q_INVOKABLE void clearBrushes();

  Q_INVOKABLE QFrame* paintOptionsFrame();

  Q_INVOKABLE void setColorSmudgeCheckboxVisible(bool show);

  Q_INVOKABLE virtual void paintApply(qMRMLWidget* viewWidget);

public slots:
  void updateGUIFromMRML() override;

  void updateMRMLFromGUI() override;

  void setMinimumPaintPointDistance(double dist);

  void setDelayedPaint(bool delayed);

protected:
  bool m_AlwaysErase;

  bool m_Erase;

protected:
  QScopedPointer<qSlicerSegmentEditorPaintEffectPrivate> d_ptr;

private:
  Q_DECLARE_PRIVATE(qSlicerSegmentEditorPaintEffect);
  Q_DISABLE_COPY(qSlicerSegmentEditorPaintEffect);
};

#endif