User Tools

Site Tools


visual3d:documentation:pipeline:pipeline_commands:set_pipeline_parameter_to_folder_path

Set Pipeline Parameter To Folder Path

The command Set_Pipeline_Parameter_To_Folder_Path can be used to define a new parameter and set its value to a specific folder path. This path can either be to an existing folder on the computer disk or a folder in the Visual3D workspace.

Pipeline Command

The command can be found in the Pipeline Workshop within the Pipeline Control Folder as so:

Set_Pipeline_Parameter_To_Folder_Path
/PARAMETER_NAME=
! /PARAMETER_VALUE=VISUAL3D_DEFAULT_DATA_FOLDER
! /FROM_MOTION_FILE_IN_WORKSPACE=
! /PARAMETER_VALUE_SEARCH_FOR=
! /PARAMETER_VALUE_REPLACE_WITH=
! /PARAMETER_VALUE_APPEND=
! /SET_PROMPT=Select a directory
! /ALPHABETIZE=TRUE
;

Command Parameters

The following table shows the command parameters that can be used to define the command and their descriptions:

Parameter Description
Parameter NameThe name of the Pipeline Parameter. The parameter is referred to by other commands using two colons (::) in front of the parameter name
Parameter ValueThe data folder path
Parameter Value Motion FileSpecify the name of the intended motion file
Parameter Value Search forThe value to search for
Parameter Value Replace WithThe value to replace searched value with
Parameter Value AppendParameter value to append

If the /Parameter_Value is left blank, the user is prompted for the folder. For example, these commands will prompt the user for the folder path, which could then be used to open all of the C3D files in a folder as follows.

Dialog

This command can be edited as text or by using the dialog box shown below:

Example: Export Multiple Files

The example found on the page below shows how the Set Pipeline Parameter to Folder Path command can be used with other commands to export multiple files at once:
Export multiple files

Example: Select Folder and Open C3Ds from Specified Folder

This example shows how the command can be used to specify the name/location of a specific folder and open .c3d files within that folder using the Open File command:

Set_Pipeline_Parameter_To_Folder_Path
/PARAMETER_NAME=FOLDER
/PARAMETER_VALUE=
! /PARAMETER_VALUE_SEARCH_FOR=
! /PARAMETER_VALUE_REPLACE_WITH=
! /PARAMETER_VALUE_APPEND=
;

Open_File
/File_Name=::FOLDER&*.c3d
;

Notes

Version 5

In version 5 a new parameter /PARAMETER_VALUE_MOTION_FILE was added.

If the /PARAMETER_VALUE is empty, but the /PARAMETER_VALUE_MOTION_FILE has a string, this string is assumed to be one of the motion files in the workspace. If the motion file is found, its path is used for the folder path.

Set_Pipeline_Parameter_To_Folder_Path
/PARAMETER_NAME=FOLDER
/PARAMETER_VALUE=
/PARAMETER_VALUE_MOTION_FILE=*walk01.c3d
! /PARAMETER_VALUE_SEARCH_FOR=
! /PARAMETER_VALUE_REPLACE_WITH=
! /PARAMETER_VALUE_APPEND=
;

If the /PARAMETER_VALUE_MOTION_FILE=*.cmo the folder path for the current cmo file is used for the folder path.

Set_Pipeline_Parameter_To_Folder_Path
/PARAMETER_NAME=FOLDER
/PARAMETER_VALUE=
/PARAMETER_VALUE_MOTION_FILE=*.cmo
! /PARAMETER_VALUE_SEARCH_FOR=
! /PARAMETER_VALUE_REPLACE_WITH=
! /PARAMETER_VALUE_APPEND=
;

Default Folders

There are four default folders that are set in the program options that can be referred to:

VISUAL3D_DEFAULT_DATA_FOLDER VISUAL3D_DEFAULT_REPORT_FOLDER VISUAL3D_DEFAULT_MODEL_FOLDER VISUAL3D_DEFAULT_PIPELINE_FOLDER MOST_RECENT_VISUAL3D_PIPELINE_FOLDER MOST_RECENT_VISUAL3D_FILE_OPEN_FOLDER For example, to refer to the default data folder:

Set_Pipeline_Parameter_To_Folder_Path
/PARAMETER_NAME=
! /PARAMETER_VALUE=VISUAL3D_DEFAULT_DATA_FOLDER
! /PARAMETER_VALUE_MOTION_FILE=
! /PARAMETER_VALUE_SEARCH_FOR=
! /PARAMETER_VALUE_REPLACE_WITH=
! /PARAMETER_VALUE_APPEND=
;

For example, to refer to the default report template folder:

Set_Pipeline_Parameter_To_Folder_Path
/PARAMETER_NAME=FOLDER
/PARAMETER_VALUE=VISUAL3D_DEFAULT_REPORT_FOLDER
/PARAMETER_VALUE_MOTION_FILE=
! /PARAMETER_VALUE_SEARCH_FOR=
! /PARAMETER_VALUE_REPLACE_WITH=
! /PARAMETER_VALUE_APPEND=
;
visual3d/documentation/pipeline/pipeline_commands/set_pipeline_parameter_to_folder_path.txt · Last modified: 2026/02/09 19:39 by wikisysop