Table of Contents
Prompt For Pipeline Parameter Value
This command can be used to prompt a dialog for user to create a pipeline parameter with the specified parameter value. A list of default values may be entered, separated by “+” to create a list of default options. Valid data types are Boolean, float, string, and integer.
Pipeline Command
The Prompt For Pipeline Parameter Value command can be found in the Pipeline Workshop within the Pipeline Control folder as so:
Prompt_For_Pipeline_Parameter_Value /PIPELINE_PARAMETER_NAME= ! /PROMPT= ! /PROMPT_SIZE=90 ! /SHOW_PARAMETER_NAME=FALSE ! /USE_POSSIBLE_VALUES=FALSE ! /DEFAULT_VALUE= ! /POSSIBLE_VALUES= ! /SHOW_DATA_TYPE=FALSE ! /DATA_TYPE= ! /MINIMUM_VALUE= ! /MAXIMUM_VALUE= ! /SPECIFY_UNITS=FALSE ! /USE_UNITS=FALSE ! /USE_POSSIBLE_UNITS=FALSE ! /POSSIBLE_UNITS= ! /DEFAULT_UNITS= ! /CONVERSIONS= ;
Command Parameters
The following table shows the command parameters that can be used to define the command and their descriptions:
| Parameter | Description |
| Prompt | The prompt given to the user |
| Prompt Size | Size of the prompt given |
| Show Parameter Name | True or False: Show name of specified parameter |
| Use Possible Values | True or False: Use the possible values as specified |
| Default Value | Specify the default data value |
| Possible Values | Specify possible values |
| Show Data Type | True or False: Show parameter data type |
| Data Type | Specify the parameter's data type (Boolean, float, string, and integer) |
| Minimum Value | Minimum parameter value |
| Maximum Value | Maximum parameter value |
| Specify Units | True or False: Specify the units for the parameter value |
| Use Units | True or False: Use the specified units |
| Use Possible Units | True or False: Use the possible units listed |
| Possible Units | Specify possible units for the parameter value |
| Default Units | Default units to be used |
| Conversions | Conversions to be applied |
Dialog
This command can be controlled by modifying the parameters above or using the dialog box below:
Example: Obstacle Height
This example will prompt the user for the height of an obstacle in inches. The resulting pipeline parameter OBSTACLE_HEIGHT will contain the user input from the dialog in meters.
Example: User input the initials of the Patient
This example will prompt the user for the initials of the subject. The resulting pipeline parameter GP_INITIALS will contain the user input from the dialog.
Prompt_For_Pipeline_Parameter_Value /PIPELINE_PARAMETER_NAME= GP_INITIALS /PROMPT= Enter the Initials of the Patient ! /PROMPT_SIZE=90 ! /SHOW_PARAMETER_NAME=FALSE ! /USE_POSSIBLE_VALUES=FALSE /DEFAULT_VALUE=0 ! /POSSIBLE_VALUES= ! /SHOW_DATA_TYPE=FALSE /DATA_TYPE=STRING ! /MINIMUM_VALUE= ! /MAXIMUM_VALUE= ! /SPECIFY_UNITS=FALSE ! /USE_UNITS=FALSE ! /USE_POSSIBLE_UNITS=FALSE ! /POSSIBLE_UNITS= ! /DEFAULT_UNITS= ! /CONVERSIONS= ;
When the command is executed, a dialog prompt will appear asking the user to input the initials of the patient as shown below:
RTF Format
The prompt can be expressed as an RTF format but because of the parsing of commands in Visual3D the user must be careful not to include the following reserved characters:
Reserved characters: / = ;
Saving RTF from MS Word for example is full of these characters. With simple RTF formatting, however, it is straightforward to avoid using these characters.
/PROMPT= {\rtf1\ansi\deff0
\pard\qc Centered\par
\pard\ql Left\par
\pard\qr Right\par
\pard\qj Justified\par
}
Using color
{\rtf1\ansi\deff0
{\colortbl;\red0\green0\blue0;\red255\green0\blue0;}
This line is the default color\line
\cf2
This line is red\line
\cf1
This line is the default color
}
Other useful formatting commands include:
\fs? for font size (where ? is twice the font size such that \fs24 results in a 12 point font)
\i to turn italics on and \i0 to turn italics off
\b to turn bold on and \b0 to turn bold off
\scaps to turn small caps on and \scaps to turn small caps off
\strike to turn strike through on and \strike0 to turn strike through off
\caps to turn all capitals on and \caps0 to turn all capitals off
\outl to turn outline on and \outl0 to turn outline off