vtk-m/vtkm/rendering/AxisAnnotation2D.h

//============================================================================
//  Copyright (c) Kitware, Inc.
//  All rights reserved.
//  See LICENSE.txt 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.
//
//  Copyright 2016 Sandia Corporation.
//  Copyright 2016 UT-Battelle, LLC.
//  Copyright 2016 Los Alamos National Security.
//
//  Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
//  the U.S. Government retains certain rights in this software.
//
//  Under the terms of Contract DE-AC52-06NA25396 with Los Alamos National
//  Laboratory (LANL), the U.S. Government retains certain rights in
//  this software.
//============================================================================
#ifndef vtk_m_rendering_AxisAnnotation2D_h
#define vtk_m_rendering_AxisAnnotation2D_h

#include <vtkm/rendering/vtkm_rendering_export.h>

#include <vtkm/Range.h>
#include <vtkm/cont/DataSet.h>
#include <vtkm/rendering/AxisAnnotation.h>
#include <vtkm/rendering/Camera.h>
#include <vtkm/rendering/Canvas.h>
#include <vtkm/rendering/Color.h>
#include <vtkm/rendering/WorldAnnotator.h>
#include <vtkm/rendering/TextAnnotation.h>

namespace vtkm {
namespace rendering {

class AxisAnnotation2D : public AxisAnnotation
{
protected:
  vtkm::Float64 MajorTickSizeX, MajorTickSizeY, MajorTickOffset;
  vtkm::Float64 MinorTickSizeX, MinorTickSizeY, MinorTickOffset;
  vtkm::Float64 PosX0, PosY0, PosX1, PosY1;
  vtkm::Range TickRange;
  vtkm::Float32 FontScale;
  vtkm::Float32 LineWidth;
  vtkm::rendering::Color Color;
  bool Logarithmic;

  TextAnnotation::HorizontalAlignment AlignH;
  TextAnnotation::VerticalAlignment AlignV;
  std::vector<TextAnnotation*> Labels;


  std::vector<vtkm::Float64> PositionsMajor;
  std::vector<vtkm::Float64> ProportionsMajor;

  std::vector<vtkm::Float64> PositionsMinor;
  std::vector<vtkm::Float64> ProportionsMinor;

  int MoreOrLessTickAdjustment;
public:
  VTKM_RENDERING_EXPORT
  AxisAnnotation2D();

  VTKM_RENDERING_EXPORT
  ~AxisAnnotation2D();

#if 0
  VTKM_RENDERING_EXPORT
  void SetLogarithmic(bool l)
  {
    this->Logarithmic = l;
  }
#endif

  VTKM_RENDERING_EXPORT
  void SetMoreOrLessTickAdjustment(int offset)
  {
    this->MoreOrLessTickAdjustment = offset;
  }

  VTKM_RENDERING_EXPORT
  void SetColor(vtkm::rendering::Color c)
  {
    this->Color = c;
  }

  VTKM_RENDERING_EXPORT
  void SetLineWidth(vtkm::Float32 lw)
  {
    this->LineWidth = lw;
  }

  VTKM_RENDERING_EXPORT
  void SetMajorTickSize(vtkm::Float64 xlen, vtkm::Float64 ylen, vtkm::Float64 offset)
  {
    /// offset of 0 means the tick is inside the frame
    /// offset of 1 means the tick is outside the frame
    /// offset of 0.5 means the tick is centered on the frame
    this->MajorTickSizeX=xlen;
    this->MajorTickSizeY=ylen;
    this->MajorTickOffset = offset;
  }

  VTKM_RENDERING_EXPORT
  void SetMinorTickSize(vtkm::Float64 xlen, vtkm::Float64 ylen, vtkm::Float64 offset)
  {
    this->MinorTickSizeX=xlen;
    this->MinorTickSizeY=ylen;
    this->MinorTickOffset = offset;
  }

  ///\todo: rename, since it might be screen OR world position?
  VTKM_RENDERING_EXPORT
  void SetScreenPosition(vtkm::Float64 x0, vtkm::Float64 y0,
                         vtkm::Float64 x1, vtkm::Float64 y1)
  {
    this->PosX0 = x0;
    this->PosY0 = y0;

    this->PosX1 = x1;
    this->PosY1 = y1;
  }

  VTKM_RENDERING_EXPORT
  void SetLabelAlignment(TextAnnotation::HorizontalAlignment h,
                         TextAnnotation::VerticalAlignment v)
  {
    this->AlignH = h;
    this->AlignV = v;
  }

  VTKM_RENDERING_EXPORT
  void SetLabelFontScale(vtkm::Float32 s)
  {
    this->FontScale = s;
    for (unsigned int i=0; i<this->Labels.size(); i++)
      this->Labels[i]->SetScale(s);
  }

  VTKM_RENDERING_EXPORT
  void SetRangeForAutoTicks(const vtkm::Range &range);
  VTKM_RENDERING_EXPORT
  void SetRangeForAutoTicks(vtkm::Float64 lower, vtkm::Float64 upper)
  {
    this->SetRangeForAutoTicks(vtkm::Range(lower, upper));
  }

  VTKM_RENDERING_EXPORT
  void SetMajorTicks(const std::vector<vtkm::Float64> &positions,
                     const std::vector<vtkm::Float64> &proportions);

  VTKM_RENDERING_EXPORT
  void SetMinorTicks(const std::vector<vtkm::Float64> &positions,
                     const std::vector<vtkm::Float64> &proportions);

  VTKM_RENDERING_EXPORT
  void Render(const vtkm::rendering::Camera &camera,
              const vtkm::rendering::WorldAnnotator &worldAnnotator,
              vtkm::rendering::Canvas &canvas) VTKM_OVERRIDE;
};

}} //namespace vtkm::rendering

#endif // vtk_m_rendering_AxisAnnotation2D_h