visual3d:documentation:pipeline:pipeline_commands:pipeline_breakpoint
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
visual3d:documentation:pipeline:pipeline_commands:pipeline_breakpoint [2024/06/17 17:08] – removed sgranger | visual3d:documentation:pipeline:pipeline_commands:pipeline_breakpoint [2025/06/20 20:00] (current) – Cleaned up page. wikisysop | ||
---|---|---|---|
Line 1: | Line 1: | ||
+ | ====== 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. The command is as follows: | ||
+ | |||
+ | < | ||
+ | Pipeline_Breakpoint | ||
+ | / | ||
+ | ; | ||
+ | </ | ||
+ | |||
+ | ===== Formatting Message in RTF ===== | ||
+ | |||
+ | 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_Breakpoint | ||
+ | / | ||
+ | \pard One\par | ||
+ | \pard Two\par | ||
+ | \pard Three\par | ||
+ | \pard Four\par | ||
+ | } | ||
+ | ; | ||
+ | </ | ||
+ | |||
+ | ===== Syntax Considerations ===== | ||
+ | |||
+ | Consider the following command: | ||
+ | |||
+ | < | ||
+ | Pipeline_Breakpoint | ||
+ | / | ||
+ | ; | ||
+ | </ | ||
+ | |||
+ | 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, " | ||
+ | |||
+ | In this example, Visual3D searches for an equals sign after each slash because this logically indicates that the user has specified a parameter. The / | ||
+ | |||
+ | The solution to this syntax issue is to either remove the " | ||
+ | < | ||
+ | / | ||
+ | </ | ||
+ | |||
+ | or to specify two equals signs " | ||
+ | < | ||
+ | / | ||
+ | </ | ||
+ | |||
+ | ===== Example ===== | ||
+ | |||
+ | < | ||
+ | !============================================================== | ||
+ | ! 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 | ||
+ | File_New | ||
+ | ; | ||
+ | |||
+ | !-------------------------------------------------------------------------------- | ||
+ | ! Apply model to motion files - | ||
+ | ! Bring in static file and apply model template. Open motion files and assign model | ||
+ | !-------------------------------------------------------------------------------- | ||
+ | |||
+ | ! Create hybrid model from static file | ||
+ | Create_Hybrid_Model | ||
+ | ! / | ||
+ | ! /SUFFIX= | ||
+ | ! / | ||
+ | ; | ||
+ | |||
+ | ! Apply model template. The user will browse for the model file | ||
+ | Apply_Model_Template | ||
+ | ! / | ||
+ | ! / | ||
+ | ; | ||
+ | |||
+ | ! Breakpoint for reviewing model | ||
+ | Pipeline_Breakpoint | ||
+ | / | ||
+ | ; | ||
+ | |||
+ | ! Open motion files. The user will browse for the files | ||
+ | File_Open | ||
+ | ! /FILE_NAME= | ||
+ | ! /SUFFIX= | ||
+ | / | ||
+ | ; | ||
+ | |||
+ | ! Assign tags to motion files | ||
+ | Assign_Tags_To_Files | ||
+ | / | ||
+ | /TAGS=WALK | ||
+ | ; | ||
+ | |||
+ | ! Assign the model to the motion files | ||
+ | Assign_Model_File | ||
+ | ! / | ||
+ | ! / | ||
+ | ! / | ||
+ | ; | ||
+ | </ | ||
+ | |||
+ | |||
visual3d/documentation/pipeline/pipeline_commands/pipeline_breakpoint.1718644085.txt.gz · Last modified: 2024/06/17 17:08 by sgranger