DREAM.3D v6 User Manual
DevHelper

DevHelper is a developer tool that allows the user to generate the skeleton code necessary to create a new Plugin or Filter. DevHelper does not create a functioning Filter automatically, and is not a development environment. Instead, it streamlines the development process by auto-generating most of the "boiler plate" code that is necessary for a working Plugin or Filter.

DevHelper is divided into two sub-tools:

  • PluginMaker: Generates skeleton code for new Plugins
  • FilterMaker: Generates skeleton code for new Filters in existing Plugins

It is highly recommended that developers use DevHelper to create their Plugins and Filters, because it provides all of the necessary skeleton code required for compilation in DREAM.3D. Additionally, the code created adheres to the DREAM.3D styles and standards.

PluginMaker


DevHelper-image001.png
DevHelper Main Window - PluginMaker

The PluginMaker tab of the DevHelper interface is quite simple. This tab contains all the elements needed to create a new plugin.

  • The two fields called Plugin Name and Output Dir allow the user to set the new Plugin name and the output directory where the new Plugin will ultimately be generated
  • The two buttons in the bottom left corner of the screen labeled Add Filter and Remove Filter will add or remove additional Filters to/from the new Plugin
  • The structure of the new Plugin and the contents of the selected file is displayed in the center
  • The Generate button generates the new Plugin and its files in the output directory specified

Using PluginMaker

  1. Choose a Plugin name and type it in the Plugin Name field
  2. Choose an output directory by selecting it with the Select button or typing it in the Output Dir field
  3. Press the Add Filter button in the bottom left corner to add additional Filters. After pressing the button, the Add New Filter Dialog will appear. Type in the new Filter's name, select either public or private, and then press OK
    DevHelper-image003.png
    Add New Filter Dialog
  4. Continue adding new Filters as needed
  5. If a Filter has been added erroneously and needs to be removed, just select one of the Filter's files in the tree (the Filter's .cpp, .h, or .md files) and press Remove Filter
  6. Peruse the tree and look over the files that will be generated for accuracy
  7. When everything is correct, press the Generate button.

The Plugin now exists in the directory that was specified in the Output Dir field.

FilterMaker


DevHelper-image002.png
DevHelper Main Window - FilterMaker

The FilterMaker tab contains all the elements needed to create a new Filter inside an existing plugin.

  • The two fields called Filter Name and Plugin Directory allow the user to set the name of the new Filter and the top level directory of the Plugin where the Filter will be stored
  • The left pane contains the table of current Filter parameters. This is empty when DevHelper first starts up
  • The green plus and red minus icons along the left side are buttons that add and remove Filter parameters to/from the Filter parameter table
  • An option just above the Filter parameters buttons allows the user to select whether the Filter will be public or private
  • The right pane allows the user to see what will be generated in each file before clicking the Generate button.
  • The combo box in the right pane displays which file is currently being viewed

Using FilterMaker

  1. Choose a Filter name and type it in the Filter Name field
  2. Choose the top level directory of the Plugin that you want to add the Filter to, and type it in the Plugin Directory field. The directory can also be selected using the Select button
  3. Choose whether to make the Filter public or private using buttons in the left pane
  4. Press the green plus icon to add a new Filter parameter. The Add Filter Parameter Dialog will appear
    DevHelper-image004.png
    Add Filter Parameter Dialog
  5. In the Add Filter Parameter Dialog, choose a Variable Name, Human Name, and Initial Value, and type them in the appropriate fields. Choose the widget type that your new filter parameter will be using. Press Add.
  6. The new Filter parameter will appear in the Filter parameters table. Any value except Type can be changed inline, so feel free to rename values as necessary
  7. If a Filter parameter has been added erroneously and needs to be removed, just select the Filter parameter's row and press the red minus icon.
  8. Use the combo box in the right pane to look at each file's contents for accuracy. The Filter parameters in the table in the left pane should be created and initialized in the code in the right pane.
  9. When everything is correct, press the Generate button.

The Filter now exists in the top level plugin folder that was specified in the Plugin Directory field. Additionally, the SourceList.cmake file for that Plugin is automatically updated with the new Filter.