vtkAnnotationRulerRepresentation3D.h

Go to the documentation of this file.

/*=auto=========================================================================

 Portions (c) Copyright 2005 Brigham and Women's Hospital (BWH) All Rights Reserved.

 See COPYRIGHT.txt
 or http://www.slicer.org/copyright/copyright.txt for details.

 Program:   3D Slicer
 Module:    $RCSfile: vtkMRMLAnnotationDisplayableManagerHelper,v $
 Date:      $Date: Aug 4, 2010 10:44:52 AM $
 Version:   $Revision: 1.0 $

 =========================================================================auto=*/

#ifndef __vtkAnnotationRulerRepresentation3D_h
#define __vtkAnnotationRulerRepresentation3D_h

// Annotations includes
#include "vtkSlicerAnnotationsModuleVTKWidgetsExport.h"

// VTK includes
#include <vtkDistanceRepresentation3D.h>

class VTK_SLICER_ANNOTATIONS_MODULE_VTKWIDGETS_EXPORT
vtkAnnotationRulerRepresentation3D
  : public vtkDistanceRepresentation3D
{
public:

  static vtkAnnotationRulerRepresentation3D *New();
  vtkTypeMacro(vtkAnnotationRulerRepresentation3D, vtkDistanceRepresentation3D);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  void SetDistance(double distance);

  // Description:
  // Get the line actor property
  vtkProperty *GetLineProperty() override;

  // Description:
  // Set/Get position of the label title. 0 is at the start of the
  // line whereas 1 is at the end.
  //vtkSetMacro(LabelPosition, double);
  void SetLabelPosition(double labelPosition);

  // Description:
  // Set/Get the maximum number of ticks in ruler mode
  vtkSetMacro(MaxTicks, int);
  vtkGetMacro(MaxTicks, int);

  // Description:
  // Change the polydata displayed as tick markers
  void UpdateGlyphPolyData(vtkPolyData *polyData);

  // Required by the rendering process, check if the glyph and label actors
  // have translucency and return true if so. Fixes a bug when the label
  // was set to a non 1 opacity but was not being rendered.
  int HasTranslucentPolygonalGeometry() override;

protected:

  vtkAnnotationRulerRepresentation3D();
  ~vtkAnnotationRulerRepresentation3D() override;

  void BuildRepresentation() override;

  // Internal use: set the label actor's position from current world point 1
  // and 2 positions and label position factor
  void UpdateLabelActorPosition();


private:

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

  double m_Distance;

  // Maximum number of ticks on the 3d ruler
  int MaxTicks;

};

#endif /* __vtkAnnotationRulerRepresentation3D_h */