From 7924c7dd607fc639aef520f6659d6a632dd65ca0 Mon Sep 17 00:00:00 2001 From: Jonas Lukasczyk Date: Tue, 21 May 2019 14:04:47 +0200 Subject: [PATCH] Update README.md --- README.md | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/README.md b/README.md index 049dc2b..d826c29 100644 --- a/README.md +++ b/README.md @@ -50,18 +50,15 @@ First get and build the source code. + Start by looking at the `.h` and `.cpp` file at the **core** layer in `ttk/core/base/YourModuleName/` + The method `computeBoundingBox` just generates a bounding box that is scaled by a parameter + Note that the function writes its output into the `boundingBoxCoords` array that is passed as an argument - - + Next, go to the `.h` file of the **vtk** layer in `ttk/core/vtk/ttkYourModuleName/` and confirm for yourself that + + Next, go to the `.h` file of the **vtk** layer in `ttk/core/vtk/ttkYourModuleName/` and confirm for yourself that + The input of the filter inherits from `vtkPointSet`. + The output of the filter is a `vtkUnstructuredGrid`. + The constructor sets default parameters. + The **vtk** wrapper holds a private instance of the **core** code class. - + Now check out the `.cpp` file of the **vtk** layer in `ttk/core/vtk/ttkYourModuleName/` + The `RequestData` method first fetches the input and output of the VTK filter (which is automatically provided by the VTK pipeline based on the information we specified in the header). + Next, the method initializes vectors that are passed to the function of the **base** code. + Finally, it convert the output to a `vtkUnstructuredGrid` (as promised in the header). - + Lastly, open the `.xml` file in `ttk/paraview/YourModuleName/` + A lot of the things you can specify here are unfortunately unintuitive. + Have a look at the XML files of other filters to see how to specify text, double, integer, and bool input UI elements. The Cinema filters are a good resource as they cover a lot of different input/output scenarios. -- 2.18.0