Differences

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

--- visual3d:documentation:pipeline:pipeline_commands:prompt_for_pipeline_parameter_value [2024/06/26 20:06] – removed sgranger
+++ visual3d: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.
+{{:Prompt_For_Pipeline_Parameter_Value.png}}
+<code>
+Prompt_For_Pipeline_Parameter_Value
+/PIPELINE_PARAMETER_NAME= The parameter name
+/PROMPT=The text instructions to the user
+! /DATA_TYPE= Data type of the parameter
+! /DEFAULT_VALUE= Default value of the parameter
+! /USE_POSSIBLE_VALUES=FALSE
+! /POSSIBLE_VALUES=
+! /USE_UNITS=FALSE
+! /DEFAULT_UNITS=
+! /USE_POSSIBLE_UNITS=FALSE
+! /POSSIBLE_UNITS=
+! /CONVERSIONS=
+;
+</code>
+===== 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
+/ = ;
+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.
+/PROMTP= {\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
+===== 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.
+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 =====
+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**.