vtkMRMLRulerDisplayableManager.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 Andras Lasso, PerkLab, Queen's University.

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

#ifndef __vtkMRMLRulerDisplayableManager_h
#define __vtkMRMLRulerDisplayableManager_h

// MRMLDisplayableManager includes
#include "vtkMRMLAbstractDisplayableManager.h"
#include "vtkMRMLDisplayableManagerExport.h"

// STL includes
#include <vector>

class VTK_MRML_DISPLAYABLEMANAGER_EXPORT vtkMRMLRulerDisplayableManager
  : public vtkMRMLAbstractDisplayableManager
{
  friend class vtkRulerRendererUpdateObserver;

public:
  static vtkMRMLRulerDisplayableManager* New();
  vtkTypeMacro(vtkMRMLRulerDisplayableManager,vtkMRMLAbstractDisplayableManager);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  void AddRulerScalePreset(double length, int numberOfMajorDivisons, int numberOfMinorDivisions, const std::string& displayedUnitName, double displayedScale);
  void RemoveAllRulerScalePresets();

protected:

  vtkMRMLRulerDisplayableManager();
  ~vtkMRMLRulerDisplayableManager() override;

  void Create() override;

  void OnMRMLDisplayableNodeModifiedEvent(vtkObject* caller) override;

  void UpdateFromViewNode();

  void UpdateFromRenderer();

  struct RulerScalePreset
  {
    double Length; // actual length of the ruler (in world coordinates)
    int NumberOfMajorDivisions; // number of major divisions of the ruler
    int NumberOfMinorDivisions; // number of divisions of each major division
    std::string DisplayedUnitName; // label that will be shown after the scaled length
    double DisplayedScale; // displayed length is Length*Scale
  };

  // List of ruler presets, ordered based on length.
  std::vector<RulerScalePreset> RulerScalePresets;

private:

  vtkMRMLRulerDisplayableManager(const vtkMRMLRulerDisplayableManager&) = delete;
  void operator=(const vtkMRMLRulerDisplayableManager&) = delete;

  class vtkInternal;
  vtkInternal * Internal;
};

#endif