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 = NULL);
  virtual ~qSlicerSegmentEditorScriptedEffect();

  Q_INVOKABLE QString pythonSource()const;

  Q_INVOKABLE bool setPythonSource(const QString newPythonSource);

  Q_INVOKABLE PyObject* self() const;

  virtual void setName(QString name);

  virtual void setPerSegment(bool perSegment);

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

  virtual const QString helpText()const;

  virtual qSlicerSegmentEditorAbstractEffect* clone();

  virtual void activate();

  virtual void deactivate();

  virtual void setupOptionsFrame();

  virtual QCursor createCursor(qMRMLWidget* viewWidget);

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

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

  virtual void setMRMLDefaults();

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

public slots:
  virtual void updateGUIFromMRML();

  virtual void updateMRMLFromGUI();

protected:
  QScopedPointer<qSlicerSegmentEditorScriptedEffectPrivate> d_ptr;

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

#endif