Differences

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

--- visual3d:documentation:pipeline:pipeline_commands:pipeline_breakpoint [2024/06/19 12:52] – sgranger
+++ visual3d:documentation:pipeline:pipeline_commands:pipeline_breakpoint [2026/02/04 16:44] (current) – [Command Parameters] wikisysop
@@ Line 1: / Line 1: @@
-this command will place a breakpoint in the pipeline that will allow the user assess their current progress before continuing. a dialog will pop-up and a custom message will be shown to the user along with two buttons: one allowing you to resume and the other if you wish to halt. the command is as follows:
+====== Pipeline Breakpoint ======
-**pipeline_breakpoint**
+This command will place a breakpoint in the pipeline that will allow the user assess their current progress before continuing. A dialog will pop-up and a custom message will be shown to the user along with two buttons: one allowing you to resume and the other if you wish to halt.
-/pause_message=
-**;**
-the message can be formatted using a simple version of the rtf file format.
-for example, the following command will output four separate lines in the breakpoint prompt dialg
+====Pipeline Syntax====
+The command appears in the Pipeline Workshop within the Pipeline Control folder as so:
+<code>
+Pipeline_Breakpoint
+/PAUSE_MESSAGE=
+;
+</code>
-**pipeline_breakpoint**
+====Command Parameters====
-/pause_message= {\rtf1\ansi\deff0
+The command can be modified by changing the following parameter:
-\pard one\par
+|**Pause Message**|The message that is shown to the user at the breakpoint|
-\pard two\par
-\pard three\par
+=====Example: Formatting Message in RTF =====
-\pard four\par
+The message can be formatted using a simple version of the rtf file format. For example, the following command will output four separate lines in the breakpoint prompt dialog
+<code>
+Pipeline_Breakpoint
+/PAUSE_MESSAGE= {\rtf1\ansi\deff0
+\pard One\par
+\pard Two\par
+\pard Three\par
+\pard Four\par
 }
-**;**
+;
-====== syntax issue ======
+</code>
-consider the following:
+===== Syntax Considerations =====
+Consider the following command:
+<code>
+Pipeline_Breakpoint
+/PAUSE_MESSAGE=08/09/2017 by WSS Speed = 0.4
+;
+</code>
+This pause message includes several special characters, notably the forward slash (/) which is a special character for pipeline commands indicating that a parameter name follows immediately afterwards. If an equals sign, "=", follows Visual3D confirms that a parameter was specified. Two equals signs, "==", however, does confirm that a parameter was specified.
+In this example, Visual3D searches for an equals sign after each slash because this logically indicates that the user has specified a parameter. The /Pause_Message parameter is assigned the string 08/09 and then Visual3D finds an equals sign after the next slash, so interprets the rest of the string as a new parameter "/2017 by WSS Speed = 0.4". Visual3D won't do anything with this parameter because it doesn't recognize it.
+The solution to this syntax issue is to either remove the "=" sign:
+<code>
+/PAUSE_MESSAGE=08/09/2017 by WSS Speed 0.4
+</code>
+or to specify two equals signs "==":
+<code>
+/PAUSE_MESSAGE=08/09/2017 by WSS Speed == 0.4
+</code>
-/pause_message=08/09/2017 by wss speed = 0.4
+===== Example =====
-a forward slash (/) is a special character for pipeline commands that indicates that a parameter_name follows immediately afterwards.
-if an equals sign (=) follows visual3d confirms that a parameter was specified.
-two equals signs (==), however, does confirm that a parameter was specified.
-visual3d searches for an equals sign after each slash because this logically indicates that the user has specified a parameter.
-pause_message is assigned the string 08/09
-visual3d finds an equals sign after the next slash, so interprets the rest of the string as a new parameter
-/2017 by mjt using modify_speed_metric_ver01 speed = 0.4
-it doesn't do anything with this parameter because it doesn't recognize it.
-solution
-remove the = sign
-/pause_message=08/09/2017 by wss speed 0.4
-or specify two equals signs
-/pause_message=08/09/2017 by wss speed == 0.4
-====== example pipeline ======
 <code>
 !==============================================================
-! this script is an example using the pipeline breakpoint command to allow
+! This script is an example using the Pipeline breakpoint command to allow
 ! the user to review the model and make adjustments before continuing.
 !==============================================================
-! fresh workspace
+! Fresh Workspace
-file_new
+File_New
 ;
 !--------------------------------------------------------------------------------
-! apply model to motion files -
+! Apply model to motion files -
-! bring in static file and apply model template. open motion files and assign model
+! Bring in static file and apply model template. Open motion files and assign model
 !--------------------------------------------------------------------------------
-! create hybrid model from static file
+! Create hybrid model from static file
-create_hybrid_model
+Create_Hybrid_Model
-! /calibration_file=
+! /CALIBRATION_FILE=
-! /suffix=
+! /SUFFIX=
-! /range=all_frames
+! /RANGE=ALL_FRAMES
 ;
-! apply model template. the user will browse for the model file
+! Apply model template. The user will browse for the model file
-apply_model_template
+Apply_Model_Template
-! /model_template=
+! /MODEL_TEMPLATE=
-! /calibration_file=
+! /CALIBRATION_FILE=
 ;
-! breakpoint for reviewing model
+! Breakpoint for reviewing model
-pipeline_breakpoint
+Pipeline_Breakpoint
-/pause_message=review the model and make any adjustments before continuing.
+/PAUSE_MESSAGE=Review the model and make any adjustments before continuing.
 ;
-! open motion files. the user will browse for the files
+! Open motion files. The user will browse for the files
-file_open
+File_Open
-! /file_name=
+! /FILE_NAME=
-! /suffix=
+! /SUFFIX=
-/set_prompt=open motion files
+/SET_PROMPT=Open motion files
 ;
-! assign tags to motion files
+! Assign tags to motion files
-assign_tags_to_files
+Assign_Tags_To_Files
-/motion_file_names=*walk*
+/MOTION_FILE_NAMES=*walk*
-/tags=walk
+/TAGS=WALK
 ;
-! assign the model to the motion files
+! Assign the model to the motion files
-assign_model_file
+Assign_Model_File
-! /calibration_file=
+! /CALIBRATION_FILE=
-! /motion_file_names=
+! /MOTION_FILE_NAMES=
-! /remove_existing_assignments=false
+! /REMOVE_EXISTING_ASSIGNMENTS=FALSE
 ;
 </code>