vtk-m/vtkm/rendering/View.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 2015 Sandia Corporation.
//  Copyright 2015 UT-Battelle, LLC.
//  Copyright 2015 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_View_h
#define vtk_m_rendering_View_h

#include <vtkm/cont/DataSet.h>
#include <vtkm/rendering/BoundingBoxAnnotation.h>
#include <vtkm/rendering/AxisAnnotation3D.h>
#include <vtkm/rendering/AxisAnnotation2D.h>
#include <vtkm/rendering/Camera.h>
#include <vtkm/rendering/Color.h>
#include <vtkm/rendering/ColorBarAnnotation.h>
#include <vtkm/rendering/TextAnnotation.h>
#include <vtkm/rendering/Scene.h>

namespace vtkm {
namespace rendering {

class View
{
public:
  template<typename MapperType,
           typename CanvasType>
  View(const vtkm::rendering::Scene &scene,
       const MapperType &mapper,
       const CanvasType &canvas,
       const vtkm::rendering::Color &backgroundColor =
         vtkm::rendering::Color(0,0,0,1))
    : Scene(scene),
      MapperPointer(new MapperType(mapper)),
      CanvasPointer(new CanvasType(canvas))
  {
    this->CanvasPointer->SetBackgroundColor(backgroundColor);
    this->WorldAnnotatorPointer = this->CanvasPointer->CreateWorldAnnotator();

    vtkm::Bounds spatialBounds = this->Scene.GetSpatialBounds();
    this->Camera.ResetToBounds(spatialBounds);
    if (spatialBounds.Z.Length() > 0.0)
    {
      this->Camera.SetModeTo3D();
    }
    else
    {
      this->Camera.SetModeTo2D();
    }
  }

  template<typename MapperType,
           typename CanvasType>
  View(const vtkm::rendering::Scene &scene,
       const MapperType &mapper,
       const CanvasType &canvas,
       const vtkm::rendering::Camera &camera,
       const vtkm::rendering::Color &backgroundColor =
         vtkm::rendering::Color(0,0,0,1))
    : Scene(scene),
      MapperPointer(new MapperType(mapper)),
      CanvasPointer(new CanvasType(canvas)),
      Camera(camera)
  {
    this->CanvasPointer->SetBackgroundColor(backgroundColor);
    this->WorldAnnotatorPointer = this->CanvasPointer->CreateWorldAnnotator();
  }

  template<typename MapperType,
           typename CanvasType,
           typename WorldAnnotatorType>
  View(const vtkm::rendering::Scene &scene,
       const MapperType &mapper,
       const CanvasType &canvas,
       const WorldAnnotatorType &annotator,
       const vtkm::rendering::Camera &camera,
       const vtkm::rendering::Color &backgroundColor =
         vtkm::rendering::Color(0,0,0,1))
    : Scene(scene),
      MapperPointer(new MapperType(mapper)),
      CanvasPointer(new CanvasType(canvas)),
      WorldAnnotatorPointer(new WorldAnnotatorType(annotator)),
      Camera(camera)
  {
    this->CanvasPointer->SetBackgroundColor(backgroundColor);
  }

  virtual ~View()
  {
    delete this->MapperPointer;
    delete this->CanvasPointer;
    delete this->WorldAnnotatorPointer;
  }

  VTKM_CONT_EXPORT
  const vtkm::rendering::Scene &GetScene() const { return this->Scene; }
  VTKM_CONT_EXPORT
  vtkm::rendering::Scene &GetScene() { return this->Scene; }
  VTKM_CONT_EXPORT
  void SetScene(const vtkm::rendering::Scene &scene) { this->Scene = scene; }

  VTKM_CONT_EXPORT
  const vtkm::rendering::Mapper &GetMapper() const
  {
    return *this->MapperPointer;
  }
  VTKM_CONT_EXPORT
  vtkm::rendering::Mapper &GetMapper()
  {
    return *this->MapperPointer;
  }

  VTKM_CONT_EXPORT
  const vtkm::rendering::Canvas &GetCanvas() const
  {
    return *this->CanvasPointer;
  }
  VTKM_CONT_EXPORT
  vtkm::rendering::Canvas &GetCanvas()
  {
    return *this->CanvasPointer;
  }

  VTKM_CONT_EXPORT
  const vtkm::rendering::WorldAnnotator &GetWorldAnnotator() const
  {
    return *this->WorldAnnotatorPointer;
  }

  VTKM_CONT_EXPORT
  const vtkm::rendering::Camera &GetCamera() const
  {
    return this->Camera;
  }
  VTKM_CONT_EXPORT
  vtkm::rendering::Camera &GetCamera()
  {
    return this->Camera;
  }
  VTKM_CONT_EXPORT
  void SetCamera(const vtkm::rendering::Camera &camera)
  {
    this->Camera = camera;
  }

  VTKM_CONT_EXPORT
  const vtkm::rendering::Color &GetBackgroundColor() const
  {
    return this->CanvasPointer->GetBackgroundColor();
  }

  VTKM_CONT_EXPORT
  void SetBackgroundColor(const vtkm::rendering::Color &color)
  {
    this->CanvasPointer->SetBackgroundColor(color);
  }

  VTKM_CONT_EXPORT
  virtual void Initialize() {this->GetCanvas().Initialize();}

  VTKM_CONT_EXPORT
  virtual void Paint() = 0;
  VTKM_CONT_EXPORT
  virtual void RenderScreenAnnotations() {}
  VTKM_CONT_EXPORT
  virtual void RenderWorldAnnotations() {}

  VTKM_CONT_EXPORT
  void SaveAs(const std::string &fileName)
  {
    this->GetCanvas().SaveAs(fileName);
  }

protected:
  VTKM_CONT_EXPORT
  void SetupForWorldSpace(bool viewportClip=true)
  {
    //this->Camera.SetupMatrices();
    this->GetCanvas().SetViewToWorldSpace(this->Camera,viewportClip);
  }

  VTKM_CONT_EXPORT
  void SetupForScreenSpace(bool viewportClip=false)
  {
    //this->Camera.SetupMatrices();
    this->GetCanvas().SetViewToScreenSpace(this->Camera,viewportClip);
  }

private:
  vtkm::rendering::Scene Scene;
  vtkm::rendering::Mapper *MapperPointer;
  vtkm::rendering::Canvas *CanvasPointer;
  vtkm::rendering::WorldAnnotator *WorldAnnotatorPointer;
  vtkm::rendering::Camera Camera;
};

// View2D View3D
class View3D : public vtkm::rendering::View
{
public:
  template<typename MapperType,
           typename CanvasType>
  VTKM_CONT_EXPORT
  View3D(const vtkm::rendering::Scene &scene,
         const MapperType &mapper,
         const CanvasType &canvas,
         const vtkm::rendering::Color &backgroundColor =
           vtkm::rendering::Color(0,0,0,1))
    : View(scene, mapper, canvas, backgroundColor)
  {
  }

  template<typename MapperType,
           typename CanvasType>
  VTKM_CONT_EXPORT
  View3D(const vtkm::rendering::Scene &scene,
         const MapperType &mapper,
         const CanvasType &canvas,
         const vtkm::rendering::Camera &camera,
         const vtkm::rendering::Color &backgroundColor =
           vtkm::rendering::Color(0,0,0,1))
    : View(scene, mapper, canvas, camera, backgroundColor)
  {
  }

  template<typename MapperType,
           typename CanvasType,
           typename WorldAnnotatorType>
  VTKM_CONT_EXPORT
  View3D(const vtkm::rendering::Scene &scene,
         const MapperType &mapper,
         const CanvasType &canvas,
         const WorldAnnotatorType &annotator,
         const vtkm::rendering::Camera &camera,
         const vtkm::rendering::Color &backgroundColor =
           vtkm::rendering::Color(0,0,0,1))
    : View(scene, mapper, canvas, annotator, camera, backgroundColor)
  {
  }

  VTKM_CONT_EXPORT
  virtual void Paint()
  {
    this->GetCanvas().Activate();
    this->GetCanvas().Clear();
    this->SetupForWorldSpace();
    this->GetScene().Render(
          this->GetMapper(), this->GetCanvas(), this->GetCamera());
    this->RenderWorldAnnotations();

    this->SetupForScreenSpace();
    this->RenderScreenAnnotations();

    this->GetCanvas().Finish();
  }

  VTKM_CONT_EXPORT
  virtual void RenderScreenAnnotations()
  {
    if (this->GetScene().GetNumberOfActors() > 0)
    {
      //this->ColorBarAnnotation.SetAxisColor(vtkm::rendering::Color(1,1,1));
      this->ColorBarAnnotation.SetRange(this->GetScene().GetActor(0).GetScalarRange(), 5);
      this->ColorBarAnnotation.SetColorTable(this->GetScene().GetActor(0).GetColorTable());
      this->ColorBarAnnotation.Render(
            this->GetCamera(), this->GetWorldAnnotator(), this->GetCanvas());
    }
  }

  VTKM_CONT_EXPORT
  virtual void RenderWorldAnnotations()
  {
    vtkm::Bounds bounds = this->GetScene().GetSpatialBounds();
    vtkm::Float64 xmin = bounds.X.Min, xmax = bounds.X.Max;
    vtkm::Float64 ymin = bounds.Y.Min, ymax = bounds.Y.Max;
    vtkm::Float64 zmin = bounds.Z.Min, zmax = bounds.Z.Max;
    vtkm::Float64 dx = xmax-xmin, dy = ymax-ymin, dz = zmax-zmin;
    vtkm::Float64 size = vtkm::Sqrt(dx*dx + dy*dy + dz*dz);

    this->BoxAnnotation.SetColor(Color(.5f,.5f,.5f));
    this->BoxAnnotation.SetExtents(this->GetScene().GetSpatialBounds());
    this->BoxAnnotation.Render(this->GetCamera(), this->GetWorldAnnotator());

    vtkm::Vec<vtkm::Float32,3> lookAt = this->GetCamera().GetLookAt();
    vtkm::Vec<vtkm::Float32,3> position = this->GetCamera().GetPosition();
    bool xtest = lookAt[0] > position[0];
    bool ytest = lookAt[1] > position[1];
    bool ztest = lookAt[2] > position[2];

    const bool outsideedges = true; // if false, do closesttriad
    if (outsideedges)
    {
      xtest = !xtest;
      //ytest = !ytest;
    }

    vtkm::Float64 xrel = vtkm::Abs(dx) / size;
    vtkm::Float64 yrel = vtkm::Abs(dy) / size;
    vtkm::Float64 zrel = vtkm::Abs(dz) / size;

    this->XAxisAnnotation.SetAxis(0);
    this->XAxisAnnotation.SetColor(Color(1,1,1));
    this->XAxisAnnotation.SetTickInvert(xtest,ytest,ztest);
    this->XAxisAnnotation.SetWorldPosition(xmin,
                                           ytest ? ymin : ymax,
                                           ztest ? zmin : zmax,
                                           xmax,
                                           ytest ? ymin : ymax,
                                           ztest ? zmin : zmax);
    this->XAxisAnnotation.SetRange(xmin, xmax);
    this->XAxisAnnotation.SetMajorTickSize(size / 40.f, 0);
    this->XAxisAnnotation.SetMinorTickSize(size / 80.f, 0);
    this->XAxisAnnotation.SetLabelFontOffset(vtkm::Float32(size / 15.f));
    this->XAxisAnnotation.SetMoreOrLessTickAdjustment(xrel < .3 ? -1 : 0);
    this->XAxisAnnotation.Render(
          this->GetCamera(), this->GetWorldAnnotator(), this->GetCanvas());

    this->YAxisAnnotation.SetAxis(1);
    this->YAxisAnnotation.SetColor(Color(1,1,1));
    this->YAxisAnnotation.SetTickInvert(xtest,ytest,ztest);
    this->YAxisAnnotation.SetWorldPosition(xtest ? xmin : xmax,
                                           ymin,
                                           ztest ? zmin : zmax,
                                           xtest ? xmin : xmax,
                                           ymax,
                                           ztest ? zmin : zmax);
    this->YAxisAnnotation.SetRange(ymin, ymax);
    this->YAxisAnnotation.SetMajorTickSize(size / 40.f, 0);
    this->YAxisAnnotation.SetMinorTickSize(size / 80.f, 0);
    this->YAxisAnnotation.SetLabelFontOffset(vtkm::Float32(size / 15.f));
    this->YAxisAnnotation.SetMoreOrLessTickAdjustment(yrel < .3 ? -1 : 0);
    this->YAxisAnnotation.Render(
          this->GetCamera(), this->GetWorldAnnotator(), this->GetCanvas());

    this->ZAxisAnnotation.SetAxis(2);
    this->ZAxisAnnotation.SetColor(Color(1,1,1));
    this->ZAxisAnnotation.SetTickInvert(xtest,ytest,ztest);
    this->ZAxisAnnotation.SetWorldPosition(xtest ? xmin : xmax,
                                           ytest ? ymin : ymax,
                                           zmin,
                                           xtest ? xmin : xmax,
                                           ytest ? ymin : ymax,
                                           zmax);
    this->ZAxisAnnotation.SetRange(zmin, zmax);
    this->ZAxisAnnotation.SetMajorTickSize(size / 40.f, 0);
    this->ZAxisAnnotation.SetMinorTickSize(size / 80.f, 0);
    this->ZAxisAnnotation.SetLabelFontOffset(vtkm::Float32(size / 15.f));
    this->ZAxisAnnotation.SetMoreOrLessTickAdjustment(zrel < .3 ? -1 : 0);
    this->ZAxisAnnotation.Render(
          this->GetCamera(), this->GetWorldAnnotator(), this->GetCanvas());
  }

private:
  // 3D-specific annotations
  vtkm::rendering::BoundingBoxAnnotation BoxAnnotation;
  vtkm::rendering::AxisAnnotation3D XAxisAnnotation;
  vtkm::rendering::AxisAnnotation3D YAxisAnnotation;
  vtkm::rendering::AxisAnnotation3D ZAxisAnnotation;
  vtkm::rendering::ColorBarAnnotation ColorBarAnnotation;
};

class View2D : public vtkm::rendering::View
{
public:
  template<typename MapperType,
           typename CanvasType>
  VTKM_CONT_EXPORT
  View2D(const vtkm::rendering::Scene &scene,
         const MapperType &mapper,
         const CanvasType &canvas,
         const vtkm::rendering::Color &backgroundColor =
           vtkm::rendering::Color(0,0,0,1))
    : View(scene, mapper, canvas, backgroundColor)
  {
  }

  template<typename MapperType,
           typename CanvasType>
  VTKM_CONT_EXPORT
  View2D(const vtkm::rendering::Scene &scene,
         const MapperType &mapper,
         const CanvasType &canvas,
         const vtkm::rendering::Camera &camera,
         const vtkm::rendering::Color &backgroundColor =
           vtkm::rendering::Color(0,0,0,1))
    : View(scene, mapper, canvas, camera, backgroundColor)
  {
  }

  template<typename MapperType,
           typename CanvasType,
           typename WorldAnnotatorType>
  VTKM_CONT_EXPORT
  View2D(const vtkm::rendering::Scene &scene,
         const MapperType &mapper,
         const CanvasType &canvas,
         const WorldAnnotatorType annotator,
         const vtkm::rendering::Camera &camera,
         const vtkm::rendering::Color &backgroundColor =
           vtkm::rendering::Color(0,0,0,1))
    : View(scene, mapper, canvas, annotator, camera, backgroundColor)
  {
  }

  VTKM_CONT_EXPORT
  virtual void Paint()
  {
    this->GetCanvas().Activate();
    this->GetCanvas().Clear();
    this->SetupForWorldSpace();

    this->GetScene().Render(
          this->GetMapper(), this->GetCanvas(), this->GetCamera());
    this->RenderWorldAnnotations();

    this->SetupForScreenSpace();
    this->RenderScreenAnnotations();

    this->GetCanvas().Finish();
  }

  VTKM_CONT_EXPORT
  void RenderScreenAnnotations()
  {
    vtkm::Float32 viewportLeft;
    vtkm::Float32 viewportRight;
    vtkm::Float32 viewportTop;
    vtkm::Float32 viewportBottom;
    this->GetCamera().GetRealViewport(
          this->GetCanvas().GetWidth(), this->GetCanvas().GetHeight(),
          viewportLeft, viewportRight, viewportBottom, viewportTop);

    this->HorizontalAxisAnnotation.SetColor(vtkm::rendering::Color(1,1,1));
    this->HorizontalAxisAnnotation.SetScreenPosition(
          viewportLeft, viewportBottom, viewportRight, viewportBottom);
    vtkm::Bounds viewRange = this->GetCamera().GetViewRange2D();
    this->HorizontalAxisAnnotation.SetRangeForAutoTicks(viewRange.X.Min,
                                                        viewRange.X.Max);
    this->HorizontalAxisAnnotation.SetMajorTickSize(0, .05, 1.0);
    this->HorizontalAxisAnnotation.SetMinorTickSize(0, .02, 1.0);
    this->HorizontalAxisAnnotation.SetLabelAlignment(TextAnnotation::HCenter,
                                                     TextAnnotation::Top);
    this->HorizontalAxisAnnotation.Render(
          this->GetCamera(), this->GetWorldAnnotator(), this->GetCanvas());

    vtkm::Float32 windowaspect =
        vtkm::Float32(this->GetCanvas().GetWidth()) /
        vtkm::Float32(this->GetCanvas().GetHeight());

    this->VerticalAxisAnnotation.SetColor(Color(1,1,1));
    this->VerticalAxisAnnotation.SetScreenPosition(
          viewportLeft, viewportBottom, viewportLeft, viewportTop);
    this->VerticalAxisAnnotation.SetRangeForAutoTicks(viewRange.Y.Min,
                                                      viewRange.Y.Max);
    this->VerticalAxisAnnotation.SetMajorTickSize(.05 / windowaspect, 0, 1.0);
    this->VerticalAxisAnnotation.SetMinorTickSize(.02 / windowaspect, 0, 1.0);
    this->VerticalAxisAnnotation.SetLabelAlignment(TextAnnotation::Right,
                                                   TextAnnotation::VCenter);
    this->VerticalAxisAnnotation.Render(
          this->GetCamera(), this->GetWorldAnnotator(), this->GetCanvas());

    const vtkm::rendering::Scene &scene = this->GetScene();
    if (scene.GetNumberOfActors() > 0)
    {
      //this->ColorBarAnnotation.SetAxisColor(vtkm::rendering::Color(1,1,1));
      this->ColorBarAnnotation.SetRange(scene.GetActor(0).GetScalarRange().Min,
                                        scene.GetActor(0).GetScalarRange().Max,
                                        5);
      this->ColorBarAnnotation.SetColorTable(scene.GetActor(0).GetColorTable());
      this->ColorBarAnnotation.Render(
            this->GetCamera(), this->GetWorldAnnotator(), this->GetCanvas());
    }
  }

private:
  // 2D-specific annotations
  vtkm::rendering::AxisAnnotation2D HorizontalAxisAnnotation;
  vtkm::rendering::AxisAnnotation2D VerticalAxisAnnotation;
  vtkm::rendering::ColorBarAnnotation ColorBarAnnotation;
};

}} //namespace vtkm::rendering

#endif //vtk_m_rendering_View_h