vtkRulerSourceRepresentation.h

Go to the documentation of this file.

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

  Program:   ParaView
  Module:    vtkRulerSourceRepresentation.h

  Copyright (c) Kitware, Inc.
  All rights reserved.
  See Copyright.txt or http://www.paraview.org/HTML/Copyright.html for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.

=========================================================================*/
#ifndef vtkRulerSourceRepresentation_h
#define vtkRulerSourceRepresentation_h

#include "vtkNew.h" //needed for instances of vtkPolyData
#include "vtkPVDataRepresentation.h"
#include "vtkRemotingViewsModule.h" //needed for exports

class vtkDistanceRepresentation2D;
class vtkPolyData;
class vtkProperty2D;
class vtkTextProperty;

class VTKREMOTINGVIEWS_EXPORT vtkRulerSourceRepresentation : public vtkPVDataRepresentation
{
public:
  static vtkRulerSourceRepresentation* New();
  vtkTypeMacro(vtkRulerSourceRepresentation, vtkPVDataRepresentation);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  void SetDistanceRepresentation(vtkDistanceRepresentation2D*);
  vtkGetObjectMacro(DistanceRepresentation, vtkDistanceRepresentation2D);

  void SetTextProperty(vtkTextProperty* prop);

  void SetAxisLineWidth(float width);

  void SetAxisColor(double red, double green, double blue);

  void SetVisibility(bool) override;

  void SetLabelFormat(char* labelFormat);


  void SetRulerMode(int choice);
  int GetRulerMode();


  void SetRulerDistance(double distance);
  double GetRulerDistance();


  void SetScale(double distance);
  double GetScale();

  void SetNumberOfRulerTicks(int numberOfRulerTicks);

  int ProcessViewRequest(vtkInformationRequestKey* request_type, vtkInformation* inInfo,
    vtkInformation* outInfo) override;

protected:
  vtkRulerSourceRepresentation();
  ~vtkRulerSourceRepresentation() override;

  int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;

  int FillInputPortInformation(int port, vtkInformation* info) override;

  bool AddToView(vtkView* view) override;

  bool RemoveFromView(vtkView* view) override;

  vtkDistanceRepresentation2D* DistanceRepresentation;
  vtkNew<vtkPolyData> Clone;

private:
  vtkRulerSourceRepresentation(const vtkRulerSourceRepresentation&) = delete;
  void operator=(const vtkRulerSourceRepresentation&) = delete;
};

#endif