CTK/Libs/Visualization/VTK/Widgets/ctkVTKSliceView.cpp

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

  Library:   CTK
 
  Copyright (c) 2010  Kitware Inc.

  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.
  You may obtain a copy of the License at

      http://www.commontk.org/LICENSE

  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.
 
=========================================================================*/

// Qt includes
#include <QTimer>
#include <QVBoxLayout>
#include <QDebug>
#include <QResizeEvent>

// CTK includes
#include "ctkVTKSliceView.h"
#include "ctkVTKSliceView_p.h"
#include "ctkLogger.h"

// VTK includes
#include <vtkRendererCollection.h>
#include <vtkRenderWindowInteractor.h>
#include <vtkTextProperty.h>
#include <vtkProperty2D.h>
#include <vtkCamera.h>
#include <vtkImageData.h>
#include <vtkCellArray.h>
#include <vtkPoints.h>
#include <vtkPolyData.h>
#include <vtkPolyDataMapper2D.h>

// Convenient macro
#define VTK_CREATE(type, name) \
  vtkSmartPointer<type> name = vtkSmartPointer<type>::New()

//--------------------------------------------------------------------------
static ctkLogger logger("org.commontk.visualization.vtk.widgets.ctkVTKSliceView");
//--------------------------------------------------------------------------

// --------------------------------------------------------------------------
// RenderWindowItem methods

//-----------------------------------------------------------------------------
RenderWindowItem::RenderWindowItem(const QColor& rendererBackgroundColor,
                                   double colorWindow, double colorLevel)
{
  // Instanciate a renderer
  this->Renderer = vtkSmartPointer<vtkRenderer>::New();
  this->Renderer->SetBackground(rendererBackgroundColor.redF(),
                                rendererBackgroundColor.greenF(),
                                rendererBackgroundColor.blueF());

  this->setupImageMapperActor(colorWindow, colorLevel);
  this->setupHighlightBoxActor();
}

//-----------------------------------------------------------------------------
void RenderWindowItem::setViewport(double xMin, double yMin,
                                   double viewportWidth, double viewportHeight)
{
  Q_ASSERT(this->Renderer);
  this->Renderer->SetViewport( xMin, yMin, (xMin + viewportWidth), (yMin + viewportHeight));
}

//---------------------------------------------------------------------------
void RenderWindowItem::setupImageMapperActor(double colorWindow, double colorLevel)
{
  Q_ASSERT(this->Renderer);
  Q_ASSERT(!this->ImageMapper);

  // Instanciate an image mapper
  this->ImageMapper = vtkSmartPointer<vtkImageMapper>::New();
  this->ImageMapper->SetColorWindow(colorWindow);
  this->ImageMapper->SetColorLevel(colorLevel);

  // .. and its corresponding 2D actor
  VTK_CREATE(vtkActor2D, actor2D);
  actor2D->SetMapper(this->ImageMapper);
  actor2D->GetProperty()->SetDisplayLocationToBackground();

  // .. and add it to the renderer
  this->Renderer->AddActor2D(actor2D);
}

//---------------------------------------------------------------------------
void RenderWindowItem::setupHighlightBoxActor(bool visible)
{
  Q_ASSERT(this->Renderer);
  Q_ASSERT(!this->HighlightBoxActor);
  
  // Create a highlight actor (2D box around viewport)
  VTK_CREATE(vtkPolyData, poly);
  VTK_CREATE(vtkPoints, points);
  double eps = 0.0;
  points->InsertNextPoint(eps, eps, 0);
  points->InsertNextPoint(1, eps, 0);
  points->InsertNextPoint(1, 1, 0);
  points->InsertNextPoint(eps, 1, 0);

  VTK_CREATE(vtkCellArray, cells);
  cells->InsertNextCell(5);
  cells->InsertCellPoint(0);
  cells->InsertCellPoint(1);
  cells->InsertCellPoint(2);
  cells->InsertCellPoint(3);
  cells->InsertCellPoint(0);
  poly->SetPoints(points);
  poly->SetLines(cells);

  VTK_CREATE(vtkCoordinate, coordinate);
  coordinate->SetCoordinateSystemToNormalizedViewport();
  coordinate->SetViewport(this->Renderer);

  VTK_CREATE(vtkPolyDataMapper2D, polyDataMapper);
  polyDataMapper->SetInput(poly);
  polyDataMapper->SetTransformCoordinate(coordinate);

  this->HighlightBoxActor = vtkSmartPointer<vtkActor2D>::New();
  this->HighlightBoxActor->SetMapper(polyDataMapper);
  this->HighlightBoxActor->GetProperty()->SetColor(1, 1, 0);
  this->HighlightBoxActor->GetProperty()->SetDisplayLocationToForeground();
  this->HighlightBoxActor->GetProperty()->SetLineWidth(3); // wide enough so not clipped
  this->HighlightBoxActor->SetVisibility(visible);

  this->Renderer->AddActor2D(this->HighlightBoxActor);
}

// --------------------------------------------------------------------------
// ctkVTKSliceViewPrivate methods

// --------------------------------------------------------------------------
ctkVTKSliceViewPrivate::ctkVTKSliceViewPrivate()
{
  this->RenderWindow = vtkSmartPointer<vtkRenderWindow>::New();
  this->Axes = vtkSmartPointer<vtkAxesActor>::New();
  this->Orientation = vtkSmartPointer<vtkOrientationMarkerWidget>::New();
  this->CornerAnnotation = vtkSmartPointer<vtkCornerAnnotation>::New();
  this->RenderPending = false;
  this->RenderEnabled = false;
  this->RenderWindowRowCount = 0;
  this->RenderWindowColumnCount = 0;
  this->RenderWindowLayoutType = ctkVTKSliceView::LeftRightTopBottom;
  this->ColorWindow = 255;
  this->ColorLevel = 127.5;
  this->RendererBackgroundColor = QColor(Qt::black);
}

// --------------------------------------------------------------------------
void ctkVTKSliceViewPrivate::setupCornerAnnotation()
{
  foreach(const QSharedPointer<RenderWindowItem>& item, this->RenderWindowItemList)
    {
    if (!item->Renderer->HasViewProp(this->CornerAnnotation))
      {
      item->Renderer->AddViewProp(this->CornerAnnotation);
      this->CornerAnnotation->SetMaximumLineHeight(0.07);
      vtkTextProperty *tprop = this->CornerAnnotation->GetTextProperty();
      tprop->ShadowOn();
      }
    this->CornerAnnotation->ClearAllTexts();
    }
}

//---------------------------------------------------------------------------
void ctkVTKSliceViewPrivate::setupRendering()
{
  CTK_P(ctkVTKSliceView);

  Q_ASSERT(this->RenderWindow);
  this->RenderWindow->SetAlphaBitPlanes(1);
  this->RenderWindow->SetMultiSamples(0);
  this->RenderWindow->StereoCapableWindowOn();
  
  this->RenderWindow->GetRenderers()->RemoveAllItems();

  // Compute the width and height of each RenderWindowItem
  double viewportWidth  = 1.0 / static_cast<double>(this->RenderWindowColumnCount);
  double viewportHeight = 1.0 / static_cast<double>(this->RenderWindowRowCount);

  // Postion of the Top-Left corner of the RenderWindowItem
  float xMin, yMin;

  // Loop through RenderWindowItem
  for ( int rowId = 0; rowId < this->RenderWindowRowCount; ++rowId )
    {
    yMin = (this->RenderWindowRowCount - 1 - rowId) * viewportHeight;
    xMin = 0.0;

    for ( int columnId = 0; columnId < this->RenderWindowColumnCount; ++columnId )
      {
      // Get reference to the renderWindowItem
      RenderWindowItem * item  =
          this->RenderWindowItemList.at(p->renderWindowItemId(rowId, columnId)).data();

      // Set viewport
      item->setViewport(xMin, yMin, viewportWidth, viewportHeight);

      // Add to RenderWindow
      this->RenderWindow->AddRenderer(item->Renderer);

      xMin += viewportWidth;
      }
    }

  this->VTKWidget->SetRenderWindow(this->RenderWindow);
}

//---------------------------------------------------------------------------
void ctkVTKSliceViewPrivate::setupDefaultInteractor()
{
  CTK_P(ctkVTKSliceView);
  p->setInteractor(this->RenderWindow->GetInteractor());
}

// --------------------------------------------------------------------------
void ctkVTKSliceViewPrivate::updateRenderWindowItemsZIndex(
    ctkVTKSliceView::RenderWindowLayoutType layoutType)
{
  CTK_P(ctkVTKSliceView);

  for (int rowId = 0; rowId < this->RenderWindowRowCount; ++rowId)
    {
    for (int columnId = 0; columnId < this->RenderWindowColumnCount; ++columnId)
      {
      int itemId = p->renderWindowItemId(rowId, columnId);
      Q_ASSERT(itemId <= this->RenderWindowItemList.size());

      RenderWindowItem * item = this->RenderWindowItemList.at(itemId).data();
      Q_ASSERT(item->ImageMapper->GetInput());

      // Default to ctkVTKSliceView::LeftRightTopBottom
      int zSliceIndex = rowId * this->RenderWindowColumnCount + columnId;

      if (layoutType == ctkVTKSliceView::LeftRightBottomTop)
        {
        zSliceIndex = (this->RenderWindowRowCount - rowId - 1) *
                      this->RenderWindowColumnCount + columnId;
        }

      item->ImageMapper->SetZSlice(zSliceIndex);
      }
    }
}

//---------------------------------------------------------------------------
// ctkVTKSliceView methods

// --------------------------------------------------------------------------
ctkVTKSliceView::ctkVTKSliceView(QWidget* _parent) : Superclass(_parent)
{
  CTK_INIT_PRIVATE(ctkVTKSliceView);
  CTK_D(ctkVTKSliceView);
  
  d->VTKWidget = new QVTKWidget(this);
  this->setLayout(new QVBoxLayout);
  this->layout()->setMargin(0);
  this->layout()->setSpacing(0);
  this->layout()->addWidget(d->VTKWidget);

  this->setRenderWindowLayout(1, 1);
  d->setupDefaultInteractor();
}

// --------------------------------------------------------------------------
ctkVTKSliceView::~ctkVTKSliceView()
{
}

//----------------------------------------------------------------------------
void ctkVTKSliceView::scheduleRender()
{
  CTK_D(ctkVTKSliceView);

  logger.trace("scheduleRender");
  if (!d->RenderEnabled)
    {
    return;
    }
  if (!d->RenderPending)
    {
    d->RenderPending = true;
    QTimer::singleShot(0, this, SLOT(forceRender()));
    }
}

//----------------------------------------------------------------------------
void ctkVTKSliceView::forceRender()
{
  CTK_D(ctkVTKSliceView);
  if (!d->RenderEnabled)
    {
    return;
    }
  logger.trace("forceRender");
  d->RenderWindow->Render();
  d->RenderPending = false;
}

//----------------------------------------------------------------------------
CTK_GET_CXX(ctkVTKSliceView, vtkRenderWindow*, renderWindow, RenderWindow);

//----------------------------------------------------------------------------
CTK_GET_CXX(ctkVTKSliceView, vtkRenderWindowInteractor*, interactor, CurrentInteractor);

//----------------------------------------------------------------------------
void ctkVTKSliceView::setInteractor(vtkRenderWindowInteractor* newInteractor)
{
  CTK_D(ctkVTKSliceView);
  d->RenderWindow->SetInteractor(newInteractor);
  //d->Orientation->SetOrientationMarker(d->Axes);
  //d->Orientation->SetInteractor(newInteractor);
  //d->Orientation->SetEnabled(1);
  //d->Orientation->InteractiveOff();
  d->CurrentInteractor = newInteractor;
}

//----------------------------------------------------------------------------
vtkInteractorObserver* ctkVTKSliceView::interactorStyle()
{
  CTK_D(ctkVTKSliceView);
  if (d->CurrentInteractor)
    {
    return d->CurrentInteractor->GetInteractorStyle();
    }
  else
    {
    return 0;
    }
}

//----------------------------------------------------------------------------
void ctkVTKSliceView::setCornerAnnotationText(const QString& text)
{
  CTK_D(ctkVTKSliceView);
  d->CornerAnnotation->ClearAllTexts();
  d->CornerAnnotation->SetText(2, text.toLatin1());
}

//----------------------------------------------------------------------------
QString ctkVTKSliceView::cornerAnnotationText() const
{
  CTK_D(const ctkVTKSliceView);
  return QLatin1String(d->CornerAnnotation->GetText(2));
}

// --------------------------------------------------------------------------
void ctkVTKSliceView::setBackgroundColor(const QColor& newBackgroundColor)
{
  CTK_D(ctkVTKSliceView);

  foreach(const QSharedPointer<RenderWindowItem>& item, d->RenderWindowItemList)
    {
    item->Renderer->SetBackground(newBackgroundColor.redF(),
                                  newBackgroundColor.greenF(),
                                  newBackgroundColor.blueF());
    }

  d->RendererBackgroundColor = newBackgroundColor;
}

//----------------------------------------------------------------------------
CTK_GET_CXX(ctkVTKSliceView, QColor, backgroundColor, RendererBackgroundColor);

//----------------------------------------------------------------------------
vtkCamera* ctkVTKSliceView::activeCamera()
{
  CTK_D(ctkVTKSliceView);
  if (d->RenderWindowItemList.size() == 0)
    {
    return 0;
    }

  // Obtain reference of the first renderer
  vtkRenderer * firstRenderer = d->RenderWindowItemList.at(0)->Renderer;
  if (firstRenderer->IsActiveCameraCreated())
    {
    return firstRenderer->GetActiveCamera();
    }
  else
    {
    return 0;
    }
  return 0;
}

//----------------------------------------------------------------------------
void ctkVTKSliceView::setActiveCamera(vtkCamera* newActiveCamera)
{
  CTK_D(ctkVTKSliceView);

  if (newActiveCamera == this->activeCamera())
    {
    return;
    }

  newActiveCamera->ParallelProjectionOn();

  foreach(const QSharedPointer<RenderWindowItem>& item, d->RenderWindowItemList)
    {
    item->Renderer->SetActiveCamera(newActiveCamera);
    }
}

//----------------------------------------------------------------------------
void ctkVTKSliceView::resetCamera()
{
  CTK_D(ctkVTKSliceView);
  foreach(const QSharedPointer<RenderWindowItem>& item, d->RenderWindowItemList)
    {
    item->Renderer->ResetCamera();
    }
}

//----------------------------------------------------------------------------
int ctkVTKSliceView::rendererCount()
{
  CTK_D(ctkVTKSliceView);
  return d->RenderWindowItemList.size();
}

//----------------------------------------------------------------------------
vtkRenderer* ctkVTKSliceView::renderer(int id)
{
  CTK_D(ctkVTKSliceView);
  if (id < 0 || id >= d->RenderWindowItemList.size())
    {
    return 0;
    }
  return d->RenderWindowItemList.at(id)->Renderer;
}

//----------------------------------------------------------------------------
vtkRenderer* ctkVTKSliceView::renderer(int rowId, int columnId)
{
  return this->renderer(this->renderWindowItemId(rowId, columnId));
}

//----------------------------------------------------------------------------
CTK_SET_CXX(ctkVTKSliceView, bool, setRenderEnabled, RenderEnabled);
CTK_GET_CXX(ctkVTKSliceView, bool, renderEnabled, RenderEnabled);

//----------------------------------------------------------------------------
int ctkVTKSliceView::renderWindowItemId(int rowId, int columnId)
{
  CTK_D(ctkVTKSliceView);
  return d->RenderWindowColumnCount * rowId + columnId;
}

//----------------------------------------------------------------------------
void ctkVTKSliceView::setRenderWindowLayoutType(ctkVTKSliceView::RenderWindowLayoutType layoutType)
{
  CTK_D(ctkVTKSliceView);
  if (d->RenderWindowLayoutType == layoutType)
    {
    return;
    }

  if (d->ImageData)
    {
    d->updateRenderWindowItemsZIndex(layoutType);
    }

  d->RenderWindowLayoutType = layoutType;
}

//----------------------------------------------------------------------------
CTK_GET_CXX(ctkVTKSliceView, ctkVTKSliceView::RenderWindowLayoutType,
            renderWindowLayoutType, RenderWindowLayoutType);

//----------------------------------------------------------------------------
void ctkVTKSliceView::setRenderWindowLayout(int rowCount, int columnCount)
{
  CTK_D(ctkVTKSliceView);
  //qDebug() << "setRenderWindowLayout" << rowCount << columnCount;

  // Sanity checks
  Q_ASSERT(rowCount >= 0 && columnCount >= 0);
  if(!(rowCount >= 0 && columnCount >= 0))
    {
    return;
    }

  if (d->RenderWindowRowCount == rowCount && d->RenderWindowColumnCount == columnCount)
    {
    return;
    }

  int extraItem = (rowCount * columnCount) - d->RenderWindowItemList.size();
  if (extraItem > 0)
    {
    //logger.debug(QString("Creating %1 RenderWindowItem").arg(extraItem));

    // Create extra RenderWindowItem(s)
    while(extraItem > 0)
      {
      RenderWindowItem * item =
          new RenderWindowItem(d->RendererBackgroundColor, d->ColorWindow, d->ColorLevel);
      item->ImageMapper->SetInput(d->ImageData);
      d->RenderWindowItemList.append(QSharedPointer<RenderWindowItem>(item));
      --extraItem;
      }
    }
  else
    {
    //logger.debug(QString("Removing %1 RenderWindowItem").arg(extraItem));

    // Remove extra RenderWindowItem(s)
    extraItem = qAbs(extraItem);
    while(extraItem > 0)
      {
      d->RenderWindowItemList.removeLast();
      --extraItem;
      }
    }

  d->RenderWindowRowCount = rowCount;
  d->RenderWindowColumnCount = columnCount;

  d->setupRendering();
  d->setupCornerAnnotation();

  if (d->ImageData)
    {
    d->updateRenderWindowItemsZIndex(d->RenderWindowLayoutType);
    }
}

//----------------------------------------------------------------------------
void ctkVTKSliceView::setHighlightedById(int id, bool value)
{
  CTK_D(ctkVTKSliceView);
  if (id < 0 || id >= d->RenderWindowItemList.size())
    {
    return;
    }
  d->RenderWindowItemList.at(id)->HighlightBoxActor->SetVisibility(value);
}

//----------------------------------------------------------------------------
void ctkVTKSliceView::setHighlighted(int rowId, int columnId, bool value)
{
  this->setHighlightedById(this->renderWindowItemId(rowId, columnId), value);
}

//----------------------------------------------------------------------------
CTK_GET_CXX(ctkVTKSliceView, double, colorWindow, ColorWindow);
CTK_GET_CXX(ctkVTKSliceView, double, colorLevel, ColorLevel);

//----------------------------------------------------------------------------
void ctkVTKSliceView::setImageData(vtkImageData* newImageData)
{
  CTK_D(ctkVTKSliceView);

  foreach(const QSharedPointer<RenderWindowItem>& item, d->RenderWindowItemList)
    {
    item->ImageMapper->SetInput(newImageData);
    }

  if (newImageData)
    {
    d->updateRenderWindowItemsZIndex(d->RenderWindowLayoutType);
    }

  d->ImageData = newImageData;
}


//----------------------------------------------------------------------------
void ctkVTKSliceView::resizeEvent(QResizeEvent * event)
{
  this->QWidget::resizeEvent(event);
  emit this->resized(event->size(), event->oldSize());
}