GUI CREATION

Plugin GUI are defined in XML files. Here is a basic example :

MORE ABOUT TYPES

Parameters type

Please refer to the API documentation to find all the parameters types available in the Python API, and to see a preview of the associated GUI widget:

Here is an example for the FilePath type, which is a file browser :

Structure

Declare your own structured types using the decltype and struct keywords:

<decltype name="Structure">

   <struct>

     <field name="BoolParameter" type="Bool" default="True"/>

     <field name="AngleParameter" type="Angle" default="0.1"/>

   </struct>

 </decltype>

…

<parameter name="Structure" type="Structure" description=""/>

Enumerators

Declare Enumerator types using the enum keyword. Enumerators take the form of dropdown menus:

<decltype name="Enumerator">

   <enum type="Int">

     <value name="Enum_1" value="1"/>

     <value name="Enum_2" value="2"/>

   </enum>

</decltype>

…

<parameter name="Enumerator" type="Enumerator" description=""/>

Selector

Use the select keyword to create dropdown selection menus giving inputs choice:

Advanced usecases

• Optional parameters: optional="True"

<parameter name="OptionalParameter" type="OutputDirectoryPath" optional="True" description=""/>

• Disabled parameters:        disableValue="-1"

<parameter name="DisabledValue" type="Int" disableValue="-1" description=""/>