[vtk-developers] callData documentation, please review it

[Francois Bertel]

Hi,

On March 5 2008, I added a new section in Common/vtkCommand.h about the callData passed by classes when they invoke some specific event.

http://www.vtk.org/doc/nightly/html/classvtkCommand.html

Before this change, the only way to figure out what this callData contained was to read the implementation file of the class invoking the event you want to observe.

I actually added this documentation by doing a grep about InvokeEvent on the whole VTK source tree and read all the implementation files in a text editor (yes, painful task).


I like to point out that sometimes some events are invoked with different kind of calldata by different classes. In the documentation, I just reported the current status of the events in VTK.

Please review the list of calldata per event and tell if anything shock your eyes.

For instance, I don't like the fact that Infovis/vtkFixedWidthTextReader returns something different from any other class for a vtkCommand::ProgressEvent. float value, instead of double, and not a value
between 0.0 and 1.0 but "the number of lines read so far".


-- 
François Bertel, PhD  | Kitware Inc. Suite 204
1 (518) 371 3971 x113 | 28 Corporate Drive
                       | Clifton Park NY 12065, USA