CSOModificator.h

Go to the documentation of this file.

/*************************************************************************************
**
** Copyright 2007, MeVis Medical Solutions AG
**
** The user may use this file in accordance with the license agreement provided with
** the Software or, alternatively, in accordance with the terms contained in a
** written agreement between the user and MeVis Medical Solutions AG.
**
** For further information use the contact form at https://www.mevislab.de/contact
**
**************************************************************************************/
 

 
#pragma once
 
 
#include "CSOGenerator.h"
#include <set>
#include <vector>
 
ML_START_NAMESPACE


class MLCSO_EXPORT CSOModificator : public CSOGenerator
{
 
public:

  CSOModificator(const std::string& type="CSOModificator", int numInImages=0,int numOutImages=0);
 
protected:

  ~CSOModificator() override;

  void activateAttachments() override;

  void handleNotification(Field* field) override;

  virtual void resetParsedIds();

  virtual void process();

  virtual void clearOutput();

  virtual std::vector<CSO*> getCSOsToBeProcessed(const std::vector<CSO *> &csosFromIdList);

  virtual bool shouldUseUndoRedo() const;

  virtual bool canProcessInput();

  virtual void _setupCSOList();

  virtual void _applyModificator();

  virtual void _applyModificatorOnCSOs(const std::vector<CSO*>& csosToBeProcessed);

  virtual void _applyModificatorOn(CSO& outputCSO);

  virtual void _updateCSOType(CSO& outputCSO);

  virtual void _notifyObservers(bool didSomething);

  virtual bool shouldTriggerInputChanged(Field* field) const;

  virtual bool shouldTriggerParameterApplied(Field* field) const;
 
  bool _isChangeSettingField(Field *field) const;

  virtual void _onInputChanged();
  virtual void _onParameterApplied();
  virtual void _onCSOIdListChanged();
  virtual void _onWorkDirectlyOnInputChanged();
  virtual void _onApply();

  bool _isInIdList(CSO *cso);

  void _parseCSOIds(std::set<unsigned int>& ids);
 
  std::vector<CSO *> _getModifyCSOsFromIdList();
 
  void _storeCurrentStateInUndoManager(std::vector<CSO*> csosToBeProcessed);

  void _applyChangedSettings(CSO &cso) const;

  static void _csoListNotifyObserverCB(void* userData, int notificationFlag);
 
  /* FIELDS */

  BaseField* _inputCSOListFld;
  BaseField* _outputCSOListFld;

  StringField* _csoIdListFld;

  BoolField* _workDirectlyOnInputListFld;

  BoolField* _useUndoRedoFld;

  BoolField* _listenToFinishingNotificationsFld;
  BoolField* _listenToSelectionNotificationsFld;

  BoolField* _changeSettingsForModifiedCSOsFld;
 
  /* MEMBER VARIABLES */

  CSOListPtr _inCSOList;
  CSOListPtr _outCSOList;
  bool _isInNotificationCB;
  bool _isNotifyingMyself;

  std::set<unsigned int> _parsedIDs;
  bool _parsedIDsValid;

  bool _outCSOListChanged;

  bool _isOutputCSOListOwner;
  bool _isWorkingDirectlyOnInputCSOList;
 
  ML_ABSTRACT_MODULE_CLASS_HEADER(CSOModificator);
 
private:
  bool _shouldBaseParameterFieldTriggerUpdate(Field *field) const;
  bool _isAutomaticallyUpdating();
  bool _isAutomaticallyClearing();
};
 
ML_END_NAMESPACE