|
|
| (18 intermediate revisions by 2 users not shown) |
| Line 1: |
Line 1: |
| ==Documentation for vtkski== | | ==Documentation for vtkski== |
|
| |
|
| On-line documentation for vtkski... coming soon. For now, you can build the Doxygen documentation yourself. | | On-line documentation for vtkski is available at http://mike.kin.ucalgary.ca/vtkski/ . |
|
| |
|
| Also, see:
| | ==Building vtkski== |
|
| |
|
| [[Class List for vtkski]]
| | See [[Bone lab libraries#Build Instructions]] . |
| | |
| [[vtkMeshModel]]
| |
| | |
| ==Compiling and Installation==
| |
| | |
| ===Getting the source code===
| |
| | |
| Get the sources from the subversion repository.
| |
| | |
| svn checkout https://mike.kin.ucalgary.ca/svn/bonelab/trunk/vtkski
| |
| | |
| See the section on svn for more info: [[Subversion (SVN)]] | |
| | |
| ===Compiling===
| |
| | |
| 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 <tt>VTK_DIR</tt>. 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 <tt>VTK_DIR</tt> to <tt>/home/eric/source/paraview-3.6.1/build/VTK</tt>. On the other hand, the internal version of VTK that paraview uses is generally not accessible to outisde of Paraview, so this will make your vtkski library unusable outside of Paraview. There are two possible solutions:
| |
| * Make two build directories (eg. 'build' and 'build-paraview') and build vtkski twice - once against the internal version of VTK inside Paraview, and once against your installed version of VTK. You then have to manage which one is actually used with the environment variable LD_LIBRARY_PATH (or DYLD_LIBRARY_PATH on OS-X). This solution probably won't work if you want to install the vtkski libraries to a standard library search path.
| |
| * Build your installed version of VTK from the VTK directory in the paraview source tree. Something like this:
| |
| cd ~/source/paraview
| |
| mkdir build-VTK
| |
| cd build-VTK
| |
| cmake-gui ../VTK
| |
| make
| |
| sudo make install
| |
| (You probably end up with two build directories inside your paraview source tree then, one, probably named just 'build', for paraview, and one 'build-VTK' for building VTK alone.)
| |
| | |
| Another possible solution would be for me to modify the build so that two libraries, with different names, get created.
| |
| | |
| ===Building Doxygen documentation===
| |
| | |
| To build the Doxygen documentation, set the cmake variable BUILD_DOCUMENTATION to ON. This variable is marked as advanced. You will need to have installed Doxygen ( http://www.doxygen.org/ ) in order to build the documentation.
| |
| | |
| The documentation is not automatically built with make (it takes a very long time to build). Instead, you will need to explicitly request it, like this:
| |
| make vtkskiDoxygenDoc
| |
|
| |
|
| ==Checklist for new vtkski classes== | | ==Checklist for new vtkski classes== |
Documentation for vtkski
[edit]On-line documentation for vtkski is available at http://mike.kin.ucalgary.ca/vtkski/ .
See Bone lab libraries#Build Instructions .
Checklist for new vtkski classes
[edit]- 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.
- Refer to Creating VTK Classes for important coding style tips.
- Add your class, with a brief description, to Class List for vtkski.
For help 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.