Commit 7924c7dd authored by Jonas Lukasczyk's avatar Jonas Lukasczyk

Update README.md

parent 9a7af834
...@@ -50,18 +50,15 @@ First get and build the source code. ...@@ -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/` + 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 + 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 + 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 input of the filter inherits from `vtkPointSet`.
+ The output of the filter is a `vtkUnstructuredGrid`. + The output of the filter is a `vtkUnstructuredGrid`.
+ The constructor sets default parameters. + The constructor sets default parameters.
+ The **vtk** wrapper holds a private instance of the **core** code class. + 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/` + 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). + 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. + 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). + Finally, it convert the output to a `vtkUnstructuredGrid` (as promised in the header).
+ Lastly, open the `.xml` file in `ttk/paraview/YourModuleName/` + Lastly, open the `.xml` file in `ttk/paraview/YourModuleName/`
+ A lot of the things you can specify here are unfortunately unintuitive. + 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. + 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.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment