Differences

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

--- visual3d:documentation:pipeline:other_commands:set_default_folders [2024/06/19 12:52] – sgranger
+++ visual3d:documentation:pipeline:other_commands:set_default_folders [2025/06/26 13:00] (current) – Add link to Program Options dialog page and moved dialog-related information there. wikisysop
@@ Line 1: / Line 1: @@
-{{**set_default_folders**
+====== Set Default Folders ======
-! /plugins=
-! /segment_graphics=
-! /pipeline=
-! /report_template=
-! /model_template=
-! /motion_file=
-! /default_data=
-! /cmo_library_path=
-! /default_report_template=
-! /default_model_template=
-**;**
-\\
-defaultdatafolders.png
-|plugin folder           |visual3d searches this folder for visual3d plugins. these plugins may be processing plugins that will appear in the list of pipeline commands, or they may be real_time plugins that will appear in the options for real-time streaming|
+The Set_Default_Parameters command allows users to set various default folder paths that control where Visual3D will look for certain resources. The folder paths can also be viewed and modified in the [[visual3d:documentation:dialogs:program_options#default_folders|Program Options dialog]].
-|segment graphics folder |the animation models associated with the model segments are stored in. if no path to an object file is selected in the segment properties dialog, visual3d searches hear for the file.                                                 |
-|script repository folder|default folder for pipelines. used mainly for the popup wizard.                                                                                                                                                                        |
-|report template folder  |current default folder for the report template. reset every time a report template is opened.                                                                                                                                          |
-|model folder            |current default folder for the standing trial. reset every time a hybrid model is created.                                                                                                                                             |
-|motion file folder      |current default folder for the motion trial. reset every time a movement file is opened.                                                                                                                                               |
-|default data folder     |the pipeline commands may refer to the default data folder as\\ visual3d_default_folder                                                                                                                                                |
-===== example =====
+===== Pipeline Command =====
-to refer to the default folder
+<code>
+Set_Default_Folders
+! /PLUGINS=
+! /SEGMENT_GRAPHICS=
+! /PIPELINE=
+! /REPORT_TEMPLATE=
+! /MODEL_TEMPLATE=
+! /MOTION_FILE=
+! /DEFAULT_DATA=
+! /CMO_LIBRARY_PATH=
+! /DEFAULT_REPORT_TEMPLATE=
+! /DEFAULT_MODEL_TEMPLATE=
+;
+</code>
-**set_pipeline_parameter_to_folder_path**
+^ Parameter ^ Description ^
-/parameter_name=folder
+| Plugins | Visual3D searches this folder for Visual3D Plugins. These plugins may be processing plugins that will appear in the list of Pipeline commands, or they may be Real_Time plugins that will appear in the options for Real-Time Streaming|
-/parameter_value=visual3d_default_folder
+| Segment Graphics | The animation models associated with the model segments are stored in. If no path to an object file is selected in the Segment Properties dialog, Visual3D searches hear for the file.                                                 |
-**;**
+| Pipeline | Default folder for Pipelines. Used mainly for the Popup Wizard.                                                                                                                                                                        |
-to identify all the cmo files in this folder and all sub folders:
+| Report Template |Current default FOLDER for the report template. Reset every time a Report Template is opened.                                                                                                                                          |
+| Model Template | Current default FOLDER for the standing trial. Reset every time a Hybrid Model is created.                                                                                                                                             |
+| Motion File | Current default FOLDER for the motion trial. Reset every time a movement file is opened.                                                                                                                                               |
+| Default Data | The pipeline commands may refer to the default data folder as //VISUAL3D_DEFAULT_FOLDER//.                                                                                                                                                |
+===== Example: Referencing Default Folders =====
+Certain default folder paths can be referred to within a pipeline script. This example identifies all the CMZ files in Visual3D's default folder and all of its sub-folders:
+<code>
+Set_Pipeline_Parameter_To_Folder_Path
+/PARAMETER_NAME=FOLDER
+/PARAMETER_VALUE=VISUAL3D_DEFAULT_FOLDER
+;
+Set_Pipeline_Parameter_To_List_Of_Files
+/PARAMETER_NAME= the name of the Pipeline Parameter created
+/FOLDER= The folder from which to start the search
+/SEARCH_SUBFOLDERS=TRUE
+/FILE_MASK=*.cmz
+;
+</code>
-**set_pipeline_parameter_to_list_of_files**
-/parameter_name= the name of the pipeline parameter created
-/folder= the folder from which to start the search
-/search_subfolders=true
-! /file_mask=*.cmo
-**;**
-}}