MicrovesselVtkScene.cpp

/*

Copyright (c) 2005-2016, University of Oxford.
 All rights reserved.

 University of Oxford means the Chancellor, Masters and Scholars of the
 University of Oxford, having an administrative office at Wellington
 Square, Oxford OX1 2JD, UK.

 This file is part of Chaste.

 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:
 * Redistributions of source code must retain the above copyright notice,
 this list of conditions and the following disclaimer.
 * Redistributions in binary form must reproduce the above copyright notice,
 this list of conditions and the following disclaimer in the documentation
 and/or other materials provided with the distribution.
 * Neither the name of the University of Oxford nor the names of its
 contributors may be used to endorse or promote products derived from this
 software without specific prior written permission.

 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
 GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

 */

#include <boost/filesystem.hpp>
#include <boost/lexical_cast.hpp>
#define _BACKWARD_BACKWARD_WARNING_H 1 //Cut out the vtk deprecated warning
#include <vtkWindowToImageFilter.h>
#include <vtkPNGWriter.h>
#include <vtkPoints.h>
#include <vtkPolyData.h>
#include <vtkPolyDataMapper.h>
#include <vtkActor.h>
#include <vtkProperty.h>
#include <vtkUnsignedCharArray.h>
#if VTK_MAJOR_VERSION > 5
    #include <vtkNamedColors.h>
#endif
#include <vtkSphereSource.h>
#include <vtkGlyph3D.h>
#include <vtkGlyph2D.h>
#include <vtkCubeAxesActor2D.h>
#include <vtkImageData.h>
#include <vtkInteractorStyleTrackballCamera.h>
#include <vtkObjectFactory.h>
#include <vtkActorCollection.h>
#include <vtkUnstructuredGrid.h>
#include <vtkGeometryFilter.h>
#include <vtkTubeFilter.h>
#include <vtkExtractEdges.h>
#include <vtkCamera.h>
#include <vtkVertexGlyphFilter.h>
#include <vtkUnstructuredGrid.h>
#include <vtkCell.h>
#include <vtkPolygon.h>
#include <vtkConvexPointSet.h>
#include <vtkIdList.h>
#include <vtkGeometryFilter.h>
#include <vtkTetra.h>
#include <vtkTriangle.h>
#include <vtkLine.h>
#include <vtkFeatureEdges.h>
#include <vtkTextProperty.h>
#include <vtkCubeAxesActor.h>
#include "UblasIncludes.hpp"
#include "UblasVectorInclude.hpp"
#include "Exception.hpp"
#include "MicrovesselVtkScene.hpp"
#include "BaseUnits.hpp"
#include "VesselNetworkWriter.hpp"

// For some reason an explicit interactor style is needed capture mouse events
class customMouseInteractorStyle : public vtkInteractorStyleTrackballCamera
{
  public:
    static customMouseInteractorStyle* New();
    vtkTypeMacro(customMouseInteractorStyle, vtkInteractorStyleTrackballCamera);

    virtual void OnLeftButtonDown()
    {
      // Forward events
      vtkInteractorStyleTrackballCamera::OnLeftButtonDown();
    }

    virtual void OnMiddleButtonDown()
    {
      // Forward events
      vtkInteractorStyleTrackballCamera::OnMiddleButtonDown();
    }

    virtual void OnRightButtonDown()
    {
      // Forward events
      vtkInteractorStyleTrackballCamera::OnRightButtonDown();
    }

};

vtkStandardNewMacro(customMouseInteractorStyle);

template<unsigned DIM>
MicrovesselVtkScene<DIM>::MicrovesselVtkScene()
    : mpRenderer(vtkSmartPointer<vtkRenderer>::New()),
      mpRenderWindow(vtkSmartPointer<vtkRenderWindow>::New()),
      mpRenderWindowInteractor(vtkSmartPointer<vtkRenderWindowInteractor>::New()),
      mOutputFilePath(),
      mpColorLookUpTable(vtkSmartPointer<vtkLookupTable>::New()),
    #if VTK_MAJOR_VERSION > 5
      mAnimationWriter(vtkSmartPointer<vtkOggTheoraWriter>::New()),
    #endif
      mWindowToImageFilter(vtkSmartPointer<vtkWindowToImageFilter>::New()),
      mIsInteractive(true),
      mSaveAsAnimation(false),
      mSaveAsImages(false),
      mHasStarted(false),
      mAddAnnotations(false),
      mOutputFrequency(1),
      mIncludeAxes(false),
      mpCellPopulationGenerator(boost::shared_ptr<CellPopulationActorGenerator<DIM> >(new CellPopulationActorGenerator<DIM>())),
      mpPartGenerator(boost::shared_ptr<PartActorGenerator<DIM> >(new PartActorGenerator<DIM>())),
      mpNetworkGenerator(boost::shared_ptr<VesselNetworkActorGenerator<DIM> >(new VesselNetworkActorGenerator<DIM>())),
      mpDiscreteContinuumMeshGenerator(boost::shared_ptr<DiscreteContinuumMeshActorGenerator<DIM> >(new DiscreteContinuumMeshActorGenerator<DIM>())),
      mpGridGenerator(boost::shared_ptr<RegularGridActorGenerator<DIM> >(new RegularGridActorGenerator<DIM>())),
      mLengthScale(BaseUnits::Instance()->GetReferenceLengthScale())
{
    mpRenderer->SetBackground(1.0, 1.0, 1.0);
    mpRenderWindow->AddRenderer(mpRenderer);
    mpRenderWindow->SetSize(800.0, 600.0);
    mpRenderWindowInteractor->SetRenderWindow(mpRenderWindow);

    vtkSmartPointer<customMouseInteractorStyle> style = vtkSmartPointer<customMouseInteractorStyle>::New();
    mpRenderWindowInteractor->SetInteractorStyle(style);
}

template<unsigned DIM>
MicrovesselVtkScene<DIM>::~MicrovesselVtkScene()
{

}

template<unsigned DIM>
boost::shared_ptr<PartActorGenerator<DIM> > MicrovesselVtkScene<DIM>::GetPartActorGenerator()
{
    return mpPartGenerator;
}

template<unsigned DIM>
boost::shared_ptr<DiscreteContinuumMeshActorGenerator<DIM> > MicrovesselVtkScene<DIM>::GetDiscreteContinuumMeshActorGenerator()
{
    return mpDiscreteContinuumMeshGenerator;
}

template<unsigned DIM>
boost::shared_ptr<RegularGridActorGenerator<DIM> > MicrovesselVtkScene<DIM>::GetRegularGridActorGenerator()
{
    return mpGridGenerator;
}

template<unsigned DIM>
boost::shared_ptr<VesselNetworkActorGenerator<DIM> > MicrovesselVtkScene<DIM>::GetVesselNetworkActorGenerator()
{
    return mpNetworkGenerator;
}

template<unsigned DIM>
boost::shared_ptr<CellPopulationActorGenerator<DIM> > MicrovesselVtkScene<DIM>::GetCellPopulationActorGenerator()
{
    return mpCellPopulationGenerator;
}

template<unsigned DIM>
void MicrovesselVtkScene<DIM>::ResetRenderer(unsigned time_step)
{
    if(!mHasStarted)
    {
        Start();
    }

    vtkSmartPointer<vtkActorCollection> p_actors = mpRenderer->GetActors();
    vtkActor *p_actor;
    for( p_actors->InitTraversal(); (p_actor = p_actors->GetNextItem())!=NULL; )
    {
        mpRenderer->RemoveActor(p_actor);
    }
    mpRenderer->Clear();

    if(mpCellPopulationGenerator)
    {
        mpCellPopulationGenerator->AddActor(mpRenderer);
    }
    if(mpPartGenerator)
    {
        mpPartGenerator->AddActor(mpRenderer);
    }
    if(mpNetworkGenerator)
    {
        mpNetworkGenerator->AddActor(mpRenderer);
    }
    if(mpDiscreteContinuumMeshGenerator)
    {
        mpDiscreteContinuumMeshGenerator->AddActor(mpRenderer);
    }
    if(mpGridGenerator)
    {
        mpGridGenerator->AddActor(mpRenderer);
    }
    mpRenderer->ResetCamera();

    if(mIncludeAxes)
    {
        vtkSmartPointer<vtkCubeAxesActor> p_cubeAxesActor = vtkSmartPointer<vtkCubeAxesActor>::New();
        p_cubeAxesActor->SetBounds(mpRenderer->ComputeVisiblePropBounds());
        p_cubeAxesActor->SetCamera(mpRenderer->GetActiveCamera());
        p_cubeAxesActor->GetTitleTextProperty(0)->SetColor(0.0, 0.0, 0.0);
        p_cubeAxesActor->GetLabelTextProperty(0)->SetColor(0.0, 0.0, 0.0);
        p_cubeAxesActor->GetTitleTextProperty(1)->SetColor(0.0, 0.0, 0.0);
        p_cubeAxesActor->GetLabelTextProperty(1)->SetColor(0.0, 0.0, 0.0);
        p_cubeAxesActor->GetTitleTextProperty(2)->SetColor(0.0, 0.0, 0.0);
        p_cubeAxesActor->GetLabelTextProperty(2)->SetColor(0.0, 0.0, 0.0);
        p_cubeAxesActor->GetXAxesLinesProperty()->SetColor(0.0, 0.0, 0.0);
        p_cubeAxesActor->GetYAxesLinesProperty()->SetColor(0.0, 0.0, 0.0);
        p_cubeAxesActor->GetZAxesLinesProperty()->SetColor(0.0, 0.0, 0.0);
        p_cubeAxesActor->DrawXGridlinesOff();
        p_cubeAxesActor->DrawYGridlinesOff();
        p_cubeAxesActor->DrawZGridlinesOff();
        p_cubeAxesActor->XAxisMinorTickVisibilityOff();
        p_cubeAxesActor->YAxisMinorTickVisibilityOff();
        p_cubeAxesActor->ZAxisMinorTickVisibilityOff();
        mpRenderer->AddActor(p_cubeAxesActor);
    }

    if(mSaveAsImages)
    {
        mpRenderWindow->SetOffScreenRendering(1);
        mpRenderWindow->Render();
        mWindowToImageFilter->Modified();
        vtkSmartPointer<vtkPNGWriter> p_writer = vtkSmartPointer<vtkPNGWriter>::New();
        p_writer->SetWriteToMemory(1);
        p_writer->SetInputConnection(mWindowToImageFilter->GetOutputPort());
        if(!mOutputFilePath.empty())
        {
            p_writer->SetWriteToMemory(0);
            p_writer->SetFileName((mOutputFilePath+"_"+boost::lexical_cast<std::string>(time_step)+".png").c_str());
            p_writer->Write();
        }
    }
    #if VTK_MAJOR_VERSION > 5
    if(mSaveAsAnimation)
    {
        if(!mSaveAsImages)
        {
            mpRenderWindow->SetOffScreenRendering(1);
            mpRenderWindow->Render();
            mWindowToImageFilter->Modified();
        }
        mAnimationWriter->Write();
    }
    #endif
    if(mIsInteractive)
    {
        mpRenderWindow->SetOffScreenRendering(0);
        mpRenderWindow->Render();
    }
}

template<unsigned DIM>
void MicrovesselVtkScene<DIM>::SetOutputFilePath(const std::string& rPath)
{
    mOutputFilePath = rPath;
}

template<unsigned DIM>
void MicrovesselVtkScene<DIM>::SetSaveAsAnimation(bool saveAsAnimation)
{
    mSaveAsAnimation = saveAsAnimation;
}

template<unsigned DIM>
void MicrovesselVtkScene<DIM>::SetSaveAsImages(bool saveAsImages)
{
    mSaveAsImages = saveAsImages;
}

template<unsigned DIM>
void MicrovesselVtkScene<DIM>::SetIsInteractive(bool isInteractive)
{
    mIsInteractive = isInteractive;
}

template<unsigned DIM>
void MicrovesselVtkScene<DIM>::SetPart(boost::shared_ptr<Part<DIM> > pPart)
{
    mpPartGenerator->SetPart(pPart);
}

template<unsigned DIM>
void MicrovesselVtkScene<DIM>::SetVesselNetwork(boost::shared_ptr<VesselNetwork<DIM> > pNetwork)
{
    mpNetworkGenerator->SetVesselNetwork(pNetwork);
}

template<unsigned DIM>
void MicrovesselVtkScene<DIM>::SetCellPopulation(boost::shared_ptr<AbstractCellPopulation<DIM> > pCellPopulation)
{
    mpCellPopulationGenerator->SetCellPopulation(pCellPopulation);
}

template<unsigned DIM>
void MicrovesselVtkScene<DIM>::SetRegularGrid(boost::shared_ptr<RegularGrid<DIM> > pGrid)
{
    mpGridGenerator->SetRegularGrid(pGrid);
}

template<unsigned DIM>
void MicrovesselVtkScene<DIM>::SetMesh(boost::shared_ptr<DiscreteContinuumMesh<DIM> > pMesh)
{
    mpDiscreteContinuumMeshGenerator->SetDiscreteContinuumMesh(pMesh);
}

template<unsigned DIM>
void MicrovesselVtkScene<DIM>::End()
{
    #if VTK_MAJOR_VERSION > 5
    if(mSaveAsAnimation and mHasStarted)
    {
        mAnimationWriter->End();
    }
    #endif
}

template<unsigned DIM>
void MicrovesselVtkScene<DIM>::Start()
{
    mpRenderer->ResetCamera();
    if(DIM==3)
    {
        mpRenderer->GetActiveCamera()->Azimuth(45.0);
    }

    if(mSaveAsImages or mSaveAsAnimation)
    {
        mpRenderWindow->SetOffScreenRendering(1);
        mWindowToImageFilter->SetInput(mpRenderWindow);
        mWindowToImageFilter->Update();
    }

    if(mSaveAsAnimation)
    {
        #if VTK_MAJOR_VERSION > 5
        mAnimationWriter->SetInputConnection(mWindowToImageFilter->GetOutputPort());
        mAnimationWriter->SetFileName((mOutputFilePath+".ogg").c_str());
        mAnimationWriter->SetRate(1.0);
        mAnimationWriter->Start();
        #endif
    }

    mHasStarted = true;
    ResetRenderer();

    if(mIsInteractive)
    {
        mpRenderWindowInteractor->Initialize();
    }

}

template<unsigned DIM>
void MicrovesselVtkScene<DIM>::StartInteractiveEventHandler()
{
    mpRenderWindowInteractor->Start();
}

template class MicrovesselVtkScene<2>;
template class MicrovesselVtkScene<3>;