qSlicerSegmentEditorScriptedEffect.h

Go to the documentation of this file.

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

  Program: 3D Slicer

  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 __qSlicerSegmentEditorScriptedEffect_h
#define __qSlicerSegmentEditorScriptedEffect_h

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

#include "qSlicerSegmentationsEditorEffectsExport.h"

// Forward Declare PyObject*
#ifndef PyObject_HEAD
struct _object;
typedef _object PyObject;
#endif
class qSlicerSegmentEditorScriptedEffectPrivate;

class Q_SLICER_SEGMENTATIONS_EFFECTS_EXPORT qSlicerSegmentEditorScriptedEffect
  : public qSlicerSegmentEditorAbstractEffect
{
  Q_OBJECT

public:
  typedef qSlicerSegmentEditorAbstractEffect Superclass;
  qSlicerSegmentEditorScriptedEffect(QObject* parent = nullptr);
  ~qSlicerSegmentEditorScriptedEffect() override;

  Q_INVOKABLE QString pythonSource()const;

  Q_INVOKABLE bool setPythonSource(const QString newPythonSource);

  Q_INVOKABLE PyObject* self() const;

  void setName(QString name) override;

  void setPerSegment(bool perSegment) override;

  void setRequireSegments(bool requireSegments) override;

// API: Methods that are to be reimplemented in the effect subclasses
public:
  QIcon icon() override;

  const QString helpText()const override;

  qSlicerSegmentEditorAbstractEffect* clone() override;

  void activate() override;

  void deactivate() override;

  void setupOptionsFrame() override;

  QCursor createCursor(qMRMLWidget* viewWidget) override;

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

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

  void setMRMLDefaults() override;

  void referenceGeometryChanged() override;
  void masterVolumeNodeChanged() override;
  void layoutChanged() override;
  void interactionNodeModified(vtkMRMLInteractionNode* interactionNode) override;

public slots:
  void updateGUIFromMRML() override;

  void updateMRMLFromGUI() override;

protected:
  QScopedPointer<qSlicerSegmentEditorScriptedEffectPrivate> d_ptr;

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

#endif