User Tools

Site Tools


visual3d:documentation:pipeline:pipeline_commands:prompt_for_pipeline_parameter_value

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
visual3d:documentation:pipeline:pipeline_commands:prompt_for_pipeline_parameter_value [2024/06/18 13:33] sgrangervisual3d:documentation:pipeline:pipeline_commands:prompt_for_pipeline_parameter_value [2025/03/18 16:54] (current) wikisysop
Line 1: Line 1:
 +====== Prompt For Pipeline Parameter Value ======
 +
 Prompts a dialog for user to create a pipeline parameter with the specified parameter value. Prompts a dialog for user to create a pipeline parameter with the specified parameter value.
  
-{{Prompt_For_Pipeline_Parameter_Value.png}}+{{:Prompt_For_Pipeline_Parameter_Value.png}}
  
 <code> <code>
Line 19: Line 21:
 </code> </code>
  
-====== RTF Format ======+===== 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 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
Line 48: Line 50:
 \caps to turn all capitals on and \caps0 to turn all capitals 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 \outl to turn outline on and \outl0 to turn outline off
-====== Example: User input the initials of the Patient ====== +===== Example: User input the initials of the Patient ===== 
 +{{ :SetPipelineParameterDlg.png}}
 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. 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.
  
-|\\ \\ \\ <code>\\ Prompt_For_Pipeline_Parameter_Value\\ /PIPELINE_PARAMETER_NAME= GP_INITIALS\\ /PROMPT= Enter the Initials of the Patient\\ /DATA_TYPE=STRING\\ /DEFAULT_VALUE=\\ ;\\ </code>\\ \\ \\ When the command is exectued, a dialog prompt will appear asking the user to input the initials of the patient (see image on right)  |{{SetPipelineParameterDlg.png}}  |+Prompt_For_Pipeline_Parameter_Value\\ 
 +/PIPELINE_PARAMETER_NAME= GP_INITIALS\\ 
 +/PROMPT= Enter the Initials of the Patient\\ 
 +/DATA_TYPE=STRING\\ 
 +/DEFAULT_VALUE=\\ 
 +; 
 + 
 +When the command is executed, a dialog prompt will appear asking the user to input the initials of the patient (see image on right)
  
-====== Example: Obstacle Height ======+===== 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**. 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**.
visual3d/documentation/pipeline/pipeline_commands/prompt_for_pipeline_parameter_value.1718717595.txt.gz · Last modified: 2024/06/18 13:33 by sgranger