User Tools

Site Tools


visual3d:documentation:pipeline:pipeline_commands:prompt_for_multiple_pipeline_parameter_values

Prompt For Multiple Pipeline Parameter Values

This command prompts a dialog for the user to create multiple pipeline parameters with the specified parameter values. The Prompt for Pipeline Parameter Value command can be used to prompt for just one value.

Pipeline Command

The Prompt For Pipeline Multiple Parameter Values command can be found in the Pipeline Workshop within the Pipeline Control folder as so:

Prompt_For_Multiple_Pipeline_Parameter_Values
/PIPELINE_PARAMETER_NAME=
/DATATYPE=
! /DEFAULT_VALUE=
! /DEFAULT_VALUE_COUNT=1
! /PROMPT_TEXT=Modify Pipeline Parameters
;

Command Parameters

The following table shows the command parameters that can be used to define the command and their descriptions:

Parameter Description
Prompt TextThe prompt given to the user
Pipeline Parameter NameThe name(s) of the parameter value(s) to be set
Default ValueSpecify the default data value
Default Value CountSpecify the number of default values
DatatypeSpecify the parameter's data type (valid types are Boolean, float, string, and integer)

Dialog

This command can be controlled by modifying the parameters above or using the dialog box below:

Example 1: Prompting 2 Parameter Values

This example will prompt the user for 2 values. The resulting pipeline parameters PARAM1 and PARAM2 will contain the inputs from the dialog. In this example, PARAM1 is an INTEGER type with 1 as the default value and PARAM2 is an INTEGER type with 2 as the default value.

The command can be edited by dialog boxes as shown in this example. Double-click on the command and the dialog will appear. To add a parameter:

- Click on the Add New Parameter button.
- In the pop-up window (shown on far right), specify the parameter name PARAM2
- Specify the data type int
- Specify the default data value 2

The completed command should look like the following:

Prompt_For_Multiple_Pipeline_Parameter_Values
/PIPELINE_PARAMETER_NAME=PARAM1+PARAM2
/DATATYPE=int+int
/DEFAULT_VALUE=1+2
;
When the command is executed the following dialog appears. The user can modify the Default Values by selecting each item.

Example 2: Modifying Default Value Count


Using the DEFAULT_VALUE_COUNT parameter:


If the DEFAULT_VALUE_COUNT parameter is set to 1 (this is the default value), each pipeline parameter can only be set to one value.
Using the DEFAULT_VALUE_COUNT parameter command (shown on the right) allows the user to set a pipeline parameter to a list of values.
An example of the prompt using this parameter is shown below.
Prompt_For_Multiple_Pipeline_Parameter_Values
/PIPELINE_PARAMETER_NAME=SCOTT+SCOTT2
/DATATYPE=string+int
/DEFAULT_VALUE=one+two+3+4+5+6
/DEFAULT_VALUE_COUNT=2+4;


visual3d/documentation/pipeline/pipeline_commands/prompt_for_multiple_pipeline_parameter_values.txt · Last modified: by wikisysop