diff --git a/src/Plugins/TestOne/src/TestOne/Filters/ExampleFilter2Filter.cpp b/src/Plugins/TestOne/src/TestOne/Filters/ExampleFilter2Filter.cpp index ba99137ece..bfab6737df 100644 --- a/src/Plugins/TestOne/src/TestOne/Filters/ExampleFilter2Filter.cpp +++ b/src/Plugins/TestOne/src/TestOne/Filters/ExampleFilter2Filter.cpp @@ -11,6 +11,7 @@ #include "simplnx/Parameters/DynamicTableParameter.hpp" #include "simplnx/Parameters/GeometrySelectionParameter.hpp" #include "simplnx/Parameters/MultiArraySelectionParameter.hpp" +#include "simplnx/Parameters/AttributeMatrixSelectionParameter.hpp" #include using namespace nx::core; @@ -30,6 +31,7 @@ constexpr StringLiteral k_Param10 = "param10_path"; constexpr StringLiteral k_Param11 = "param11_path"; constexpr StringLiteral k_Param12 = "param12s"; constexpr StringLiteral k_Param13 = "param13"; +constexpr StringLiteral k_Param30 = "param30"; } // namespace @@ -81,6 +83,19 @@ Parameters ExampleFilter2Filter::parameters() const params.insert(std::make_unique(k_Param13, "Dynamic Table Parameter", "DynamicTableParameter Example Help Text", defaultTable, tableInfo)); // These should show up under the "Required Objects" Section in the GUI + + + // params.linkParameters(k_Param3, k_Param10, std::make_any(0)); + // params.linkParameters(k_Param3, k_Param6, std::make_any(1)); + // params.linkParameters(k_Param3, k_Param11, std::make_any(2)); + + // These should show up under the "Created Objects" section in the GUI + + params.insertSeparator(Parameters::Separator{"Data Object Parameters"}); + + params.insert(std::make_unique(k_Param8, "DataGroup Creation Parameter", "Example data group creation help text", DataPath{})); + params.insert(std::make_unique(k_Param5, "Array Creation", "Example array creation help text", ArrayCreationParameter::ValueType{})); + params.insert(std::make_unique(k_Param9, "DataGroup Selection Parameter", "Example data group selection help text", DataPath{}, DataGroupSelectionParameter::AllowedTypes{BaseGroup::GroupType::DataGroup})); params.insert(std::make_unique(k_Param10, "DataPath Selection Parameter", "Example data path selection help text", DataPath{})); @@ -89,16 +104,10 @@ Parameters ExampleFilter2Filter::parameters() const std::make_unique(k_Param11, "Geometry Selection Parameter", "Example geometry selection help text", DataPath{}, GeometrySelectionParameter::AllowedTypes{})); params.insert(std::make_unique(k_Param12, "MultiArray Selection Parameter", "Example multiarray selection help text", MultiArraySelectionParameter::ValueType{}, MultiArraySelectionParameter::AllowedTypes{IArray::ArrayType::Any}, nx::core::GetAllDataTypes())); + params.insert(std::make_unique(k_Param30, "Attribute Matrix Selection", "Example Help Text", DataPath{})); - params.linkParameters(k_Param7, k_Param9, std::make_any(true)); - - params.linkParameters(k_Param3, k_Param10, std::make_any(0)); - params.linkParameters(k_Param3, k_Param6, std::make_any(1)); - params.linkParameters(k_Param3, k_Param11, std::make_any(2)); - // These should show up under the "Created Objects" section in the GUI - params.insert(std::make_unique(k_Param8, "DataGroup Creation Parameter", "Example data group creation help text", DataPath{})); - params.insert(std::make_unique(k_Param5, "Array Creation", "Example array creation help text", ArrayCreationParameter::ValueType{})); + params.linkParameters(k_Param7, k_Param9, std::make_any(true)); return params; } diff --git a/wrapping/python/docs/source/Developer_API.rst b/wrapping/python/docs/source/Developer_API.rst index 45f5e1faa5..7718754765 100644 --- a/wrapping/python/docs/source/Developer_API.rst +++ b/wrapping/python/docs/source/Developer_API.rst @@ -7,6 +7,11 @@ General Parameters .. _ArrayCreationParameter: .. py:class:: ArrayCreationParameter + The figure shows what the parameter looks like in the user interface. + + .. figure:: Images/ArrayCreationParameter.png + :alt: Array Creation Parameter + Declaration ~~~~~~~~~~~ @@ -49,6 +54,12 @@ General Parameters .. _ArraySelectionParameter: .. py:class:: ArraySelectionParameter + The figure shows what the parameter looks like in the user interface. + + .. figure:: Images/ArraySelectionParameter.png + :alt: Array Creation Parameter + + Declaration ~~~~~~~~~~~ .. code-block:: python @@ -102,6 +113,11 @@ General Parameters .. _ArrayThresholdsParameter: .. py:class:: ArrayThresholdsParameter + The figure shows what the parameter looks like in the user interface. + + .. figure:: Images/ArrayThresholdsParameter.png + :alt: Array Creation Parameter + Declaration ~~~~~~~~~~~ .. code-block:: python @@ -220,6 +236,11 @@ General Parameters .. _AttributeMatrixSelectionParameter: .. py:class:: AttributeMatrixSelectionParameter + The figure shows what the parameter looks like in the user interface. + + .. figure:: Images/AttributeMatrixSelectionParameter.png + :alt: Array Creation Parameter + Declaration ~~~~~~~~~~~ .. code-block:: python @@ -260,6 +281,11 @@ General Parameters .. _BoolParameter: .. py:class:: BoolParameter + The figure shows what the parameter looks like in the user interface. + + .. figure:: Images/BoolParameter.png + :alt: Array Creation Parameter + Declaration ~~~~~~~~~~~ .. code-block:: python @@ -315,6 +341,11 @@ General Parameters .. _CalculatorParameter: .. py:class:: CalculatorParameter + The figure shows what the parameter looks like in the user interface. + + .. figure:: Images/CalculatorParameter.png + :alt: Array Creation Parameter + Declaration ~~~~~~~~~~~ .. code-block:: python @@ -368,6 +399,11 @@ General Parameters .. _ChoicesParameter: .. py:class:: ChoicesParameter + The figure shows what the parameter looks like in the user interface. + + .. figure:: Images/ChoicesParameter.png + :alt: Array Creation Parameter + Declaration ~~~~~~~~~~~ .. code-block:: python @@ -425,6 +461,11 @@ General Parameters .. _DataGroupCreationParameter: .. py:class:: DataGroupCreationParameter + The figure shows what the parameter looks like in the user interface. + + .. figure:: Images/DataGroupCreationParameter.png + :alt: Array Creation Parameter + Declaration ~~~~~~~~~~~ .. code-block:: python @@ -465,6 +506,11 @@ General Parameters .. _DataGroupSelectionParameter: .. py:class:: DataGroupSelectionParameter + The figure shows what the parameter looks like in the user interface. + + .. figure:: Images/DataGroupSelectionParameter.png + :alt: Array Creation Parameter + Declaration ~~~~~~~~~~~ .. code-block:: python diff --git a/wrapping/python/docs/source/Images/ArrayCreationParameter.png b/wrapping/python/docs/source/Images/ArrayCreationParameter.png new file mode 100644 index 0000000000..d076d38197 Binary files /dev/null and b/wrapping/python/docs/source/Images/ArrayCreationParameter.png differ diff --git a/wrapping/python/docs/source/Images/ArraySelectionParameter.png b/wrapping/python/docs/source/Images/ArraySelectionParameter.png new file mode 100644 index 0000000000..2c6ce295ab Binary files /dev/null and b/wrapping/python/docs/source/Images/ArraySelectionParameter.png differ diff --git a/wrapping/python/docs/source/Images/ArrayThresholdsParameter.png b/wrapping/python/docs/source/Images/ArrayThresholdsParameter.png new file mode 100644 index 0000000000..744e994731 Binary files /dev/null and b/wrapping/python/docs/source/Images/ArrayThresholdsParameter.png differ diff --git a/wrapping/python/docs/source/Images/AttributeMatrixSelectionParameter.png b/wrapping/python/docs/source/Images/AttributeMatrixSelectionParameter.png new file mode 100644 index 0000000000..5bde8cdd78 Binary files /dev/null and b/wrapping/python/docs/source/Images/AttributeMatrixSelectionParameter.png differ diff --git a/wrapping/python/docs/source/Images/BoolParameter.png b/wrapping/python/docs/source/Images/BoolParameter.png new file mode 100644 index 0000000000..714cd5d3cf Binary files /dev/null and b/wrapping/python/docs/source/Images/BoolParameter.png differ diff --git a/wrapping/python/docs/source/Images/CalculatorParameter.png b/wrapping/python/docs/source/Images/CalculatorParameter.png new file mode 100644 index 0000000000..37c26454ba Binary files /dev/null and b/wrapping/python/docs/source/Images/CalculatorParameter.png differ diff --git a/wrapping/python/docs/source/Images/ChoicesParameter.png b/wrapping/python/docs/source/Images/ChoicesParameter.png new file mode 100644 index 0000000000..33f65d117d Binary files /dev/null and b/wrapping/python/docs/source/Images/ChoicesParameter.png differ diff --git a/wrapping/python/docs/source/Images/DataGroupCreationParameter.png b/wrapping/python/docs/source/Images/DataGroupCreationParameter.png new file mode 100644 index 0000000000..6bac6c40c3 Binary files /dev/null and b/wrapping/python/docs/source/Images/DataGroupCreationParameter.png differ diff --git a/wrapping/python/docs/source/Images/DataGroupSelectionParameter.png b/wrapping/python/docs/source/Images/DataGroupSelectionParameter.png new file mode 100644 index 0000000000..c14b710c40 Binary files /dev/null and b/wrapping/python/docs/source/Images/DataGroupSelectionParameter.png differ