Vtkski development: Difference between revisions

From bone.wiki
Jump to navigation Jump to search
← Older edit

Enodwell (talk | contribs)

2 user groups
2,111 edits
undo
No edit summary
 
(28 intermediate revisions by 2 users not shown)
Line 1: Line 1:
==Installation==
==Documentation for vtkski==
 
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:
On-line documentation for vtkski is available at http://mike.kin.ucalgary.ca/vtkski/ .


mkdir build
==Building vtkski==
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>.
See [[Bone lab libraries#Build Instructions]] .


===Building Doxygen documentation===
==Checklist for new vtkski classes==


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.
* 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.
==Documentation for vtkski==
* 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]].


On-line documentation for vtkski... coming soon.  For now, you can build the Doxygen documentation yourself.
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.

Latest revision as of 15:43, 8 November 2010

Documentation for vtkski

[edit]

On-line documentation for vtkski is available at http://mike.kin.ucalgary.ca/vtkski/ .

Building vtkski

[edit]

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.

Retrieved from "https://bone.wiki/index.php?title=Vtkski_development&oldid=4635"