Vtkski development

Installation

Get the sources from the subversion repository.

svn checkout svn://splatter.kin.ucalgary.ca/trunk/vtkski

See the section on svn for more info: Subversion (SVN)

From the vtkski project directory, create a build directory and use cmake to configure the build:

mkdir build
cd build
cmake-gui ..

The most important cmake variable is VTK_DIR. If you intend to also build the paraview plugins, then you must build vtkski against the internal version of VTK inside the paraview build directory. (See Paraview development if you need to install ParaView). As an example, on my system I set VTK_DIR to /home/eric/source/paraview-3.6.1/build/VTK.

Building Doxygen documentation

To build the Doxygen documentation, set the cmake variable BUILD_DOCUMENTATION to ON. This variable is marked as advanced. So far, building documentation has only been tested on Linux.

Documentation for vtkski

On-line documentation for vtkski... coming soon. For now, you can build the Doxygen documentation yourself.

Checklist for new vtkski Classes

• Select a category for your new class, for example 'IO', and put your source files in that directory.
• Modify the CmakeLists.txt file in that directory to add your new source files to the list of source files.
• Build vtkski and make sure that your class compiles.
• Document your header file(s) using Doxygen style comments. The easiest is to look at an existing header file and copy the comment style.

For writing VTK classes, refer to the book "VTK User's Guide", Part III, "Developer's Guide". There are a couple of copies in the lab.