vtkSlicerUnitsLogic.h

Go to the documentation of this file.

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

  Program: 3D Slicer

  Copyright (c) Kitware Inc.

  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 Johan Andruejol, Kitware Inc.
  and was partially funded by NIH grant 3P41RR013218-12S1

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


#ifndef __vtkSlicerUnitsLogic_h
#define __vtkSlicerUnitsLogic_h

// Slicer includes
#include "vtkMRMLAbstractLogic.h"

// MRML includes
class vtkMRMLUnitNode;

#include "vtkSlicerUnitsModuleLogicExport.h"

// STD includes
#include <map>

class VTK_SLICER_UNITS_MODULE_LOGIC_EXPORT vtkSlicerUnitsLogic
  : public vtkMRMLAbstractLogic
{
public:
  static vtkSlicerUnitsLogic *New();
  typedef vtkSlicerUnitsLogic Self;
  vtkTypeMacro(vtkSlicerUnitsLogic, vtkMRMLAbstractLogic);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  vtkMRMLUnitNode* AddUnitNode(const char* name,
    const char* quantity = "length",
    const char* prefix = "",
    const char* suffix = "",
    int precision = 3,
    double min = -10000.,
    double max = 10000.);

  void SetDefaultUnit(const char* quantity, const char* id);

  vtkMRMLScene* GetUnitsScene() const;

  static double GetSIPrefixCoefficient(const char* prefix);

  static double GetDisplayCoefficient(const char* displayPrefix, const char* valuePrefix = "", double power=1);

protected:
  vtkSlicerUnitsLogic();
  ~vtkSlicerUnitsLogic() override;

  void ObserveMRMLScene() override;
  void OnMRMLSceneStartBatchProcess() override;
  void UpdateFromMRMLScene() override;
  void OnMRMLNodeModified(vtkMRMLNode* modifiedNode) override;

  virtual void AddDefaultsUnits();

  virtual void AddBuiltInUnits(vtkMRMLScene* scene);

  void SetMRMLSceneInternal(vtkMRMLScene* newScene) override;

  void RegisterNodes() override;
  virtual void RegisterNodesInternal(vtkMRMLScene* scene);

  vtkMRMLUnitNode* AddUnitNodeToScene(vtkMRMLScene* scene,
    const char* name,
    const char* quantity = "length",
    const char* prefix = "",
    const char* suffix = "",
    int precision = 3,
    double min = -10000.,
    double max = 10000.,
    double displayCoeff = 1.0,
    double displayOffset = 0.0);

  void SaveDefaultUnits();

  void RestoreDefaultUnits();

  // Variables
  vtkMRMLScene* UnitsScene;
private:
  vtkSlicerUnitsLogic(const vtkSlicerUnitsLogic&) = delete;
  void operator=(const vtkSlicerUnitsLogic&) = delete;

  std::map<std::string, std::string> CachedDefaultUnits;
  bool RestoringDefaultUnits;
};

#endif