Differences

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

--- visual3d:getting_started:commandline [2024/07/12 14:08] – created sgranger
+++ visual3d:getting_started:commandline [2024/08/29 17:24] (current) – Fixed formatting and added some important notes. wikisysop
@@ Line 1: / Line 1: @@
-====== CommandLine ======
+====== Command Line ======
-==== Launching Visual3D & Pipeline Externally ====
+Although Visual3D is primarily controlled through the graphical user interface (whether interacting directly with the interface or running pipeline scripts) it is also possible to launch Visual3D from a DOS Command Line or an external program.
-Launching Visual3D from a DOS Command Line (or an external program)
 If you have a DOS PATH set to the Visual3D directory you can type
+<code>
+Visual3D.exe
+</code>
-**Visual3D.exe**
+If not, you must specify the full path to Visual3D, for example
-If not, you must specify the full path to Visual3D.
+<code>
+C:\Program Files\Visual3D\Visual3D.exe
+</code>
-**c:\Program Files\Visual3D\Visual3D.exe**
 ==== Command Line Parameters ====
-Several parameters can be passed to visual when it is being launched from the command line:\\
+Several parameters can be passed to Visual3D when it is being launched from the command line. All parameters should be quoted when passed in so that any spaces in the parameter's value are not separated into different parameters.
-\\
-**-s <pipeline path and file name>:** This can be used to run a saved pipeline immediately after opening V3d from the command line.\\
+**-s <pipeline path and file name>:** This can be used to run a saved pipeline immediately after opening Visual3D from the command line.
 <code>
    Visual3D.exe -s "C:\Users\user\Documents\scripts\pipeline.v3s"
 </code>
-\\
+**-c <Pipeline command>:** This can be used to execute a specific pipeline command, unaltered default parameters can be excluded. This parameter can be used multiple times to execute multiple pipeline commands.
-**-c <Pipeline command>:** This can be used to execute a specific pipeline command, unaltered default parameters can be excluded. This parameter can be used multiple times to execute multiple pipeline commands.\\
 <code>
    Visual3D.exe -c "File_Open/FILE_NAME=motion_file.c3d;"
 </code>
-\\
+**-f <Default Folder>:** This can be used to set the DefaultDataPath. This parameter can be used three times, subsequent uses define the DefaultModelPath and the DefaultReportPath.
-**-f <Default Folder>:** This can be used to set the DefaultDataPath. This parameter can be used three times, subsequent uses define the DefaultModelPath and the DefaultReportPath.\\
 <code>
    Visual3D.exe -f "C:\Users\user\Documents\data_folder" -f "C:\Users\user\Documents\model_folder" -f "C:\Users\user\Documents\report_folder"
 </code>
-\\
+**/CalTesterStandalone:** This specifies that Visual3D should be launched in a simple, CalTester only mode.
-**/CalTesterStandalone:** This specifies that Visual3D should be launched in a simple, CalTester only mode.\\
 <code>
    Visual3D.exe /CalTesterStandalone
 </code>
-\\
+**/HideProtocols:** This specifies that the pop up command wizard should not be shown (This is usually default setting)
-**/HideProtocols:** This specifies that the pop up command wizard should not be shown (This is usually default setting)\\
 <code>
    Visual3D.exe /HideProtocols
 </code>
+==== Important Notes ====
+Visual3D was not truly developed with command line batch processing in mind, so there are limitations to what is possible from this mode compared to the full application. One thing to note is that pipeline parameters do not persist between scripts from the command line - each script is treated as an independent session.
+A more complete console application experience for multiple [[visual3d:documentation:definitions:file_formats:cmz_format|CMZ]] files can be found in [[sift:sift_overview|Sift]].