#include <MicrovesselVtkScene.hpp>

Collaboration diagram for MicrovesselVtkScene< DIM >:

Public Member Functions
	MicrovesselVtkScene ()

	~MicrovesselVtkScene ()

void	End ()

boost::shared_ptr< PartActorGenerator< DIM > >	GetPartActorGenerator ()

boost::shared_ptr< DiscreteContinuumMeshActorGenerator< DIM > >	GetDiscreteContinuumMeshActorGenerator ()

boost::shared_ptr< RegularGridActorGenerator< DIM > >	GetRegularGridActorGenerator ()

boost::shared_ptr< VesselNetworkActorGenerator< DIM > >	GetVesselNetworkActorGenerator ()

boost::shared_ptr< CellPopulationActorGenerator< DIM > >	GetCellPopulationActorGenerator ()

void	ResetRenderer (unsigned timeStep=0)

void	Start ()

void	SetCellPopulation (boost::shared_ptr< AbstractCellPopulation< DIM > > pCellPopulation)

void	SetOutputFilePath (const std::string &rPath)

void	SetIsInteractive (bool isInteractive)

void	SetSaveAsAnimation (bool saveAsAnimation)

void	SetSaveAsImages (bool saveAsImages)

void	StartInteractiveEventHandler ()

void	SetPart (boost::shared_ptr< Part< DIM > > pPart)

void	SetVesselNetwork (boost::shared_ptr< VesselNetwork< DIM > > pNetwork)

void	SetRegularGrid (boost::shared_ptr< RegularGrid< DIM > > pGrid)

void	SetMesh (boost::shared_ptr< DiscreteContinuumMesh< DIM > > pMesh)

Private Attributes
vtkSmartPointer< vtkRenderer >	mpRenderer

vtkSmartPointer< vtkRenderWindow >	mpRenderWindow

vtkSmartPointer< vtkRenderWindowInteractor >	mpRenderWindowInteractor

std::string	mOutputFilePath

vtkSmartPointer< vtkLookupTable >	mpColorLookUpTable

vtkSmartPointer< vtkWindowToImageFilter >	mWindowToImageFilter

bool	mIsInteractive

bool	mSaveAsAnimation

bool	mSaveAsImages

bool	mHasStarted

bool	mAddAnnotations

unsigned	mOutputFrequency

bool	mIncludeAxes

boost::shared_ptr< CellPopulationActorGenerator< DIM > >	mpCellPopulationGenerator

boost::shared_ptr< PartActorGenerator< DIM > >	mpPartGenerator

boost::shared_ptr< VesselNetworkActorGenerator< DIM > >	mpNetworkGenerator

boost::shared_ptr< DiscreteContinuumMeshActorGenerator< DIM > >	mpDiscreteContinuumMeshGenerator

boost::shared_ptr< RegularGridActorGenerator< DIM > >	mpGridGenerator

units::quantity< unit::length >	mLengthScale

Detailed Description

template<unsigned DIM>
class MicrovesselVtkScene< DIM >

A simple vtk renderer for simulation outputs

Definition at line 72 of file MicrovesselVtkScene.hpp.

Constructor & Destructor Documentation

template<unsigned DIM>

MicrovesselVtkScene< DIM >::MicrovesselVtkScene ( )

Constructor

Definition at line 113 of file MicrovesselVtkScene.cpp.

References MicrovesselVtkScene< DIM >::mpRenderer, MicrovesselVtkScene< DIM >::mpRenderWindow, and MicrovesselVtkScene< DIM >::mpRenderWindowInteractor.

template<unsigned DIM>

MicrovesselVtkScene< DIM >::~MicrovesselVtkScene ( )

Destructor

Definition at line 147 of file MicrovesselVtkScene.cpp.

References MicrovesselVtkScene< DIM >::mpCellPopulationGenerator, MicrovesselVtkScene< DIM >::mpDiscreteContinuumMeshGenerator, MicrovesselVtkScene< DIM >::mpGridGenerator, MicrovesselVtkScene< DIM >::mpNetworkGenerator, and MicrovesselVtkScene< DIM >::mpPartGenerator.

Member Function Documentation

template<unsigned DIM>

void MicrovesselVtkScene< DIM >::End ( )

Shut down the scene and close the animation

Definition at line 332 of file MicrovesselVtkScene.cpp.

References MicrovesselVtkScene< DIM >::mHasStarted, and MicrovesselVtkScene< DIM >::mSaveAsAnimation.

template<unsigned DIM>

void MicrovesselVtkScene< DIM >::ResetRenderer ( unsigned timeStep = 0 )

Update the renderer, this will update the population actor and write output images

Parameters

timeStep the curren time step, for annotating output files

Definition at line 183 of file MicrovesselVtkScene.cpp.

Referenced by MicrovesselVtkScene< DIM >::Start().

template<unsigned DIM>

void MicrovesselVtkScene< DIM >::SetCellPopulation ( boost::shared_ptr< AbstractCellPopulation< DIM > > pCellPopulation )

Set the cell population

Parameters

pCellPopulation the cell population for rendering

Definition at line 314 of file MicrovesselVtkScene.cpp.

References MicrovesselVtkScene< DIM >::mpCellPopulationGenerator, MicrovesselVtkScene< DIM >::mpDiscreteContinuumMeshGenerator, and MicrovesselVtkScene< DIM >::mpGridGenerator.

template<unsigned DIM>

void MicrovesselVtkScene< DIM >::SetOutputFilePath ( const std::string & rPath )

Set the path for output

Parameters

rPath the path for output

Definition at line 278 of file MicrovesselVtkScene.cpp.

References MicrovesselVtkScene< DIM >::mIsInteractive, MicrovesselVtkScene< DIM >::mOutputFilePath, MicrovesselVtkScene< DIM >::mpNetworkGenerator, MicrovesselVtkScene< DIM >::mpPartGenerator, MicrovesselVtkScene< DIM >::mSaveAsAnimation, and MicrovesselVtkScene< DIM >::mSaveAsImages.

template<unsigned DIM>

void MicrovesselVtkScene< DIM >::Start ( )

Render the scene

Definition at line 343 of file MicrovesselVtkScene.cpp.

References MicrovesselVtkScene< DIM >::mHasStarted, MicrovesselVtkScene< DIM >::mIsInteractive, MicrovesselVtkScene< DIM >::mOutputFilePath, MicrovesselVtkScene< DIM >::mpRenderer, MicrovesselVtkScene< DIM >::mpRenderWindow, MicrovesselVtkScene< DIM >::mpRenderWindowInteractor, MicrovesselVtkScene< DIM >::mSaveAsAnimation, MicrovesselVtkScene< DIM >::mSaveAsImages, MicrovesselVtkScene< DIM >::mWindowToImageFilter, and MicrovesselVtkScene< DIM >::ResetRenderer().

Referenced by MicrovesselVtkScene< DIM >::ResetRenderer().

Member Data Documentation

template<unsigned DIM>

bool MicrovesselVtkScene< DIM >::mAddAnnotations

private

Add annotation

Definition at line 134 of file MicrovesselVtkScene.hpp.

template<unsigned DIM>

bool MicrovesselVtkScene< DIM >::mHasStarted

private

Has the renderer started

Definition at line 129 of file MicrovesselVtkScene.hpp.

Referenced by MicrovesselVtkScene< DIM >::End(), MicrovesselVtkScene< DIM >::ResetRenderer(), and MicrovesselVtkScene< DIM >::Start().

template<unsigned DIM>

bool MicrovesselVtkScene< DIM >::mIsInteractive

private

Is the rendering interactive

Definition at line 114 of file MicrovesselVtkScene.hpp.

Referenced by MicrovesselVtkScene< DIM >::ResetRenderer(), MicrovesselVtkScene< DIM >::SetOutputFilePath(), and MicrovesselVtkScene< DIM >::Start().

template<unsigned DIM>

units::quantity<unit::length> MicrovesselVtkScene< DIM >::mLengthScale

private

Scale features using this length. e.g. set to micron if we want to render features in microns

Definition at line 172 of file MicrovesselVtkScene.hpp.

template<unsigned DIM>

std::string MicrovesselVtkScene< DIM >::mOutputFilePath

private

The path for output

Definition at line 92 of file MicrovesselVtkScene.hpp.

Referenced by MicrovesselVtkScene< DIM >::ResetRenderer(), MicrovesselVtkScene< DIM >::SetOutputFilePath(), and MicrovesselVtkScene< DIM >::Start().

template<unsigned DIM>

unsigned MicrovesselVtkScene< DIM >::mOutputFrequency

private

How often to update the renderer during a simulation

Definition at line 139 of file MicrovesselVtkScene.hpp.

template<unsigned DIM>

boost::shared_ptr<CellPopulationActorGenerator<DIM> > MicrovesselVtkScene< DIM >::mpCellPopulationGenerator

private

The cell population

Definition at line 146 of file MicrovesselVtkScene.hpp.

Referenced by MicrovesselVtkScene< DIM >::ResetRenderer(), MicrovesselVtkScene< DIM >::SetCellPopulation(), and MicrovesselVtkScene< DIM >::~MicrovesselVtkScene().

template<unsigned DIM>

vtkSmartPointer<vtkLookupTable> MicrovesselVtkScene< DIM >::mpColorLookUpTable

private

The color lookup

Definition at line 97 of file MicrovesselVtkScene.hpp.

template<unsigned DIM>

boost::shared_ptr<DiscreteContinuumMeshActorGenerator<DIM> > MicrovesselVtkScene< DIM >::mpDiscreteContinuumMeshGenerator

private

The mesh

Definition at line 161 of file MicrovesselVtkScene.hpp.

Referenced by MicrovesselVtkScene< DIM >::ResetRenderer(), MicrovesselVtkScene< DIM >::SetCellPopulation(), and MicrovesselVtkScene< DIM >::~MicrovesselVtkScene().

template<unsigned DIM>

boost::shared_ptr<RegularGridActorGenerator<DIM> > MicrovesselVtkScene< DIM >::mpGridGenerator

private

The regular grid actor generator

Definition at line 166 of file MicrovesselVtkScene.hpp.

Referenced by MicrovesselVtkScene< DIM >::ResetRenderer(), MicrovesselVtkScene< DIM >::SetCellPopulation(), and MicrovesselVtkScene< DIM >::~MicrovesselVtkScene().

template<unsigned DIM>

boost::shared_ptr<VesselNetworkActorGenerator<DIM> > MicrovesselVtkScene< DIM >::mpNetworkGenerator

private

The vessel network

Definition at line 156 of file MicrovesselVtkScene.hpp.

Referenced by MicrovesselVtkScene< DIM >::ResetRenderer(), MicrovesselVtkScene< DIM >::SetOutputFilePath(), and MicrovesselVtkScene< DIM >::~MicrovesselVtkScene().

template<unsigned DIM>

boost::shared_ptr<PartActorGenerator<DIM> > MicrovesselVtkScene< DIM >::mpPartGenerator

private

The part generator

Definition at line 151 of file MicrovesselVtkScene.hpp.

Referenced by MicrovesselVtkScene< DIM >::ResetRenderer(), MicrovesselVtkScene< DIM >::SetOutputFilePath(), and MicrovesselVtkScene< DIM >::~MicrovesselVtkScene().

template<unsigned DIM>

vtkSmartPointer<vtkRenderer> MicrovesselVtkScene< DIM >::mpRenderer

private

The vtk renderer

Definition at line 77 of file MicrovesselVtkScene.hpp.

Referenced by MicrovesselVtkScene< DIM >::MicrovesselVtkScene(), MicrovesselVtkScene< DIM >::ResetRenderer(), and MicrovesselVtkScene< DIM >::Start().

template<unsigned DIM>

vtkSmartPointer<vtkRenderWindow> MicrovesselVtkScene< DIM >::mpRenderWindow

private

The vtk render window

Definition at line 82 of file MicrovesselVtkScene.hpp.

Referenced by MicrovesselVtkScene< DIM >::MicrovesselVtkScene(), MicrovesselVtkScene< DIM >::ResetRenderer(), and MicrovesselVtkScene< DIM >::Start().

template<unsigned DIM>

vtkSmartPointer<vtkRenderWindowInteractor> MicrovesselVtkScene< DIM >::mpRenderWindowInteractor

private

The vtk render window interactor

Definition at line 87 of file MicrovesselVtkScene.hpp.

Referenced by MicrovesselVtkScene< DIM >::MicrovesselVtkScene(), and MicrovesselVtkScene< DIM >::Start().

template<unsigned DIM>

bool MicrovesselVtkScene< DIM >::mSaveAsAnimation

private

Save as an animation

Definition at line 119 of file MicrovesselVtkScene.hpp.

Referenced by MicrovesselVtkScene< DIM >::End(), MicrovesselVtkScene< DIM >::ResetRenderer(), MicrovesselVtkScene< DIM >::SetOutputFilePath(), and MicrovesselVtkScene< DIM >::Start().

template<unsigned DIM>

bool MicrovesselVtkScene< DIM >::mSaveAsImages

private

Save as an image

Definition at line 124 of file MicrovesselVtkScene.hpp.

Referenced by MicrovesselVtkScene< DIM >::ResetRenderer(), MicrovesselVtkScene< DIM >::SetOutputFilePath(), and MicrovesselVtkScene< DIM >::Start().

template<unsigned DIM>

vtkSmartPointer<vtkWindowToImageFilter> MicrovesselVtkScene< DIM >::mWindowToImageFilter

private

The image to window filter

Definition at line 109 of file MicrovesselVtkScene.hpp.

Referenced by MicrovesselVtkScene< DIM >::ResetRenderer(), and MicrovesselVtkScene< DIM >::Start().

The documentation for this class was generated from the following files:

projects/MicrovesselChaste/src/utility/visualization/MicrovesselVtkScene.hpp
projects/MicrovesselChaste/src/utility/visualization/MicrovesselVtkScene.cpp

Public Member Functions

Private Attributes

Detailed Description

template<unsigned DIM> class MicrovesselVtkScene< DIM >

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<unsigned DIM>
class MicrovesselVtkScene< DIM >