CSOGenerator.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 "CSOBaseModule.h"
#include "CSOGeneratorBase.h"
 
ML_START_NAMESPACE

class MLCSO_EXPORT CSOGenerator : public CSOBaseModule, public CSOGeneratorBase
{
 
public:

  CSOGenerator(std::string type="CSOGenerator", int numInImg=0, int numOutImg=0);

  inline std::string getType() const { return _type; }
 
protected:
 
  /* FIELDS */

  BoolField* _emptyGroupBeforeGenerationFld;

  TypedEnumField<CSOAddToGroupModes>* _addCSOToGroupMode;

  StringField* _addCSOToGroupWithLabelFld;

  IntField* _addCSOToGroupWithIdFld;

  IntField*    _idFld;

  TypedEnumField<CSOPathPointsStyle>* _pathPointStyleFld;
  FloatField* _pathPointWidthFld;
  ColorField* _pathPointColorFld;
  FloatField* _pathPointAlphaFld;

  TypedEnumField<CSOSeedPointStyle>* _seedPointStyleFld;
  FloatField* _seedPointSizeFld;
  ColorField* _seedPointColorFld;
  FloatField* _seedPointAlphaFld;

  TypedEnumField<CSOVoxelWriteModes>* _voxelWriteModeFld;
  FloatField* _voxelWriteValueFld;
 
 
  /* MEMBER VARIABLES */
 
 
  /* METHODS */
 
  // The indirection of the following three methods is not really necessary, we
  // could call those methods implemented in CSOGeneratorBase directly where needed.
 
  // The indirection is here because we do not want to change all calls in all
  // other modules (which may be implemented by external colleagues).
 

  CSO* _addCSO(CSOList* csoList, bool useUndoRedo=true) { return generatorAddCSO(csoList, useUndoRedo); }
  CSO* _addCSONoEvent(CSOList* csoList, bool useUndoRedo = true) { return generatorAddCSONoEvent(csoList, useUndoRedo); }
  CSOGroup* _getParentGroup(CSOList* csoList, bool useUndoRedo=false, bool generate=false) { return generatorGetParentGroup(csoList, useUndoRedo, generate); }
  void _emptyGroupOnDemand(CSOList* csoList) { generatorEmptyGroupOnDemand(csoList); }

  int getModuleCreatorId() const override { return static_cast<int>(_idFld->getIntValue()); }
  std::string getModuleType() const override { return getType(); }

  bool getShouldEmptyBeforeGeneration() const override { return _emptyGroupBeforeGenerationFld->getBoolValue(); }
  int getAddCSOToGroupMode() const override { return _addCSOToGroupMode->getEnumValue(); }
  std::string getAddCSOToGroupLabel() const override { return _addCSOToGroupWithLabelFld->getStringValue(); }
  int getAddCSOToGroupId() const override { return static_cast<int>(_addCSOToGroupWithIdFld->getIntValue()); }

  int getDefaultPathPointStyle() const override { return _pathPointStyleFld->getEnumValue(); }
  float getDefaultPathPointWidth() const override { return _pathPointWidthFld->getFloatValue(); }
  Vector3 getDefaultPathPointColor() const override { return _pathPointColorFld->getVector3Value(); }
  float getDefaultPathPointAlpha() const override { return _pathPointAlphaFld->getFloatValue(); }

  int getDefaultSeedPointStyle() const override { return _seedPointStyleFld->getEnumValue(); }
  float getDefaultSeedPointSize() const override { return _seedPointSizeFld->getFloatValue(); }
  Vector3 getDefaultSeedPointColor() const override { return _seedPointColorFld->getVector3Value(); }
  float getDefaultSeedPointAlpha() const override { return _seedPointAlphaFld->getFloatValue(); }

  int getDefaultVoxelWriteMode() const override { return _voxelWriteModeFld->getEnumValue(); }
  float getDefaultVoxelWriteValue() const override { return _voxelWriteValueFld->getFloatValue(); }

  ~CSOGenerator() override;
 
private:
 
  ML_MODULE_CLASS_HEADER(CSOGenerator);
};

 
ML_END_NAMESPACE