Wiki Documentation Site

User Tools

Site Tools

You are here: Main Page » visual3d » documentation » pipeline » file_commands » File Open
visual3d:documentation:pipeline:file_commands:file_open

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
visual3d:documentation:pipeline:file_commands:file_open [2025/05/16 14:10] – wikisysopvisual3d:documentation:pipeline:file_commands:file_open [2026/07/15 15:03] (current) – [File Search Filter Types] wikisysop
Line 4: Line 4:
 The **File_Open** pipeline command is used to load a file into the Visual3D workspace. The **File_Open** pipeline command is used to load a file into the Visual3D workspace.
   * Usually, this command is the first step in a pipeline as all subsequent operations rely on having an active file loaded.   * Usually, this command is the first step in a pipeline as all subsequent operations rely on having an active file loaded.
 +  * For supported files and filter types, see the notes section.
  
 ===== Pipeline Command ===== ===== Pipeline Command =====
Line 30: Line 31:
 |**/SUFFIX=**                |Optional suffix to append to the base file name.| |**/SUFFIX=**                |Optional suffix to append to the base file name.|
 |**/SET_PROMPT=File_Open**   |If provided, prompts the user with a dialog box titled with this label to choose a file manually.| |**/SET_PROMPT=File_Open**   |If provided, prompts the user with a dialog box titled with this label to choose a file manually.|
 +|**/ON_FILE_NOT_FOUND=PROMPT**|If the file is not found, 'PROMPT' or 'SKIP'|
 +|**/FILE_TYPES_ON_PROMPT**    |Filter for the file types when using prompt.|
  
-**File_Open** +===== Dialog Box ===== 
-/File_Name= File_Name is the file name or file mask including the path. +The command can be edited in a text editor or in a dialog form. To edit in the dialog, either click on the **Edit** button in the pipeline workshop or double-click on the pipeline command.
-/File_Path= The path string that will be pre-pended to the File_Name +
-/Search_Subfolder= Search all subfolders for files matching the filename or file mask +
-!/Suffix= Text here will be added to the end of the C3D file which is loaded. +
-!/Set_Prompt= This parameters sets the text in the upper left hand corner of the browse window +
-!/On_File_Not_Found=PROMPT +
-!/File_Types_On_Prompt= This parameter sets the type of files the dialog will show (CMO, C3D, ASCII, etc) +
-**;** +
-**Note:** If **/File_Name=** is blank, a dialog pops up to allow the user to browse to the file. Wildcards (*) can be used in place of the file name.+
  
-==== File_Types ====+The dialog is shown below:
  
-The following file types are supported and can be added within Visual3D:+{{:visual3d:documentation:pipeline:file_commands:file_open_emptydlgbox.png?550|}}
  
-  * .c3d - C3D File or [[[http://www.c3d.org|www.c3d.org]]] +  * **Select Filename**: Manually browse for and select the specific file you want to open. 
-  * .cmo - Visual3D Workspace File +  * **Select Filepath (Optional)**: Choose the folder where the file is stored. 
-  * .txt - Visual3D TAB delimited text File +  * **Suffix**: If a file with this suffix exists in the folder, it will be automatically added to the file name. 
-  * .gcd - Vicon GCD File +  * **Search Subfolders**: If checked, Visual3D will search within subfolders of the specified file path to find the file. 
-  * .ndi - NDI Aurora File +  * **Prompt**: Sets the title shown in the file selection dialog when prompting the user to choose a file. 
-  * .p2d - P2D File+  * **Action on File Not Found**: What Visual3D should do if the file is not found. Options include PROMPT or SKIP 
 +  * **File Mask on Prompt**: A filter for which file types appear in the dialog.
  
-==== Filter ====+===== Examples =====
  
-You can filter using the following filter types:+The following examples will go through the use of the **File_Open** command within the Visual3D application. 
  
-  * C3D +=== Example 1: Prompt the user for the filename ===
-  * CMO +
-  * VND +
-  * P2D +
-  * ASCII +
-  * XML +
-  * NDI +
-  * GCD +
-  * MVNX +
- +
-Multiple file types can be specified by using a plus sign (ex. C3D+CMO+P2D) +
- +
-==== Examples ==== +
- +
-This page lists several examples for this command. +
- +
-=== Prompt the user for the filename ===+
  
 This example will prompt the user for the files by opening a dialog box for selection. This example will prompt the user for the files by opening a dialog box for selection.
Line 79: Line 59:
 <code> <code>
 File_Open File_Open
-/File_Name=+/FILE_NAME= 
 +! /FILE_PATH= 
 +! /SEARCH_SUBFOLDERS=FALSE 
 +! /SUFFIX= 
 +! /SET_PROMPT=File_Open 
 +! /ON_FILE_NOT_FOUND=PROMPT 
 +! /FILE_TYPES_ON_PROMPT=
 ; ;
 </code> </code>
  
-=== Specify the filename ===+=== Example 2: Specify the filename ===
  
 This example specifies the filename explicitly. Note that the filename should contain the complete path to the file. This example specifies the filename explicitly. Note that the filename should contain the complete path to the file.
  
 <code> <code>
-File_Open= +File_Open 
-/File_Name= c:\demo_files\walking.c3d +/FILE_NAME= c:\demo_files\walking.c3d  
 +! /FILE_PATH= 
 +! /SEARCH_SUBFOLDERS=FALSE 
 +! /SUFFIX= 
 +! /SET_PROMPT=File_Open 
 +! /ON_FILE_NOT_FOUND=PROMPT 
 +! /FILE_TYPES_ON_PROMPT=
 ; ;
 </code> </code>
  
-=== Specify the filename using wildcards ===+=== Example 3: Specify the filename using wildcards ===
  
 This example specifies the filename by using a wildcard. All C3D files in the c:\demo_files folder will be opened. This example specifies the filename by using a wildcard. All C3D files in the c:\demo_files folder will be opened.
  
 <code> <code>
-File_Open=  +File_Open 
-/File_Name= c:\demo_files\*.c3d  +/FILE_NAME= c:\demo_files\*.c3d  
-;+! /FILE_PATH= 
 +! /SEARCH_SUBFOLDERS=FALSE 
 +! /SUFFIX= 
 +! /SET_PROMPT=File_Open 
 +! /ON_FILE_NOT_FOUND=PROMPT 
 +! /FILE_TYPES_ON_PROMPT=
 </code> </code>
  
-=== Specify the filename using a pipeline parameter and wildcards ===+=== Example 4: Specify the filename using a pipeline parameter and wildcards ===
  
 This example uses [[Visual3D:Documentation:Pipeline:General_Information:Pipeline_Parameters|Pipeline Parameters]] to specify the folder containing the data files and uses a wildcard in the filename This example uses [[Visual3D:Documentation:Pipeline:General_Information:Pipeline_Parameters|Pipeline Parameters]] to specify the folder containing the data files and uses a wildcard in the filename
Line 114: Line 111:
  
 ! Now open the file. ! Now open the file.
-File_Open= +File_Open 
-/File_Name= ::DATA_FOLDER&*.c3d  +/FILE_NAME= ::DATA_FOLDER&*.c3d  
-;+! /FILE_PATH= 
 +! /SEARCH_SUBFOLDERS=FALSE 
 +! /SUFFIX= 
 +! /SET_PROMPT=File_Open 
 +! /ON_FILE_NOT_FOUND=PROMPT 
 +! /FILE_TYPES_ON_PROMPT=
 </code> </code>
  
-=== Specify the filename using the default data folder and wildcards ===+=== Example 5: Specify the filename using the default data folder and wildcards ===
  
 This example uses [[Visual3D:Documentation:Pipeline:General_Information:Pipeline_Parameters|Pipeline Parameters]] to specify the [[Visual3D:Documentation:Dialogs:Program_Options#Default_Folders|default data folder]] containing the data files and uses a wildcard in the filename. This example uses [[Visual3D:Documentation:Pipeline:General_Information:Pipeline_Parameters|Pipeline Parameters]] to specify the [[Visual3D:Documentation:Dialogs:Program_Options#Default_Folders|default data folder]] containing the data files and uses a wildcard in the filename.
Line 131: Line 133:
 ! Now open the file. ! Now open the file.
 File_Open= File_Open=
-/File_Name= ::DATA_FOLDER&*.c3d  +File_Open 
-;+/FILE_NAME= ::DATA_FOLDER&*.c3d  
 +! /FILE_PATH= 
 +! /SEARCH_SUBFOLDERS=FALSE 
 +! /SUFFIX= 
 +! /SET_PROMPT=File_Open 
 +! /ON_FILE_NOT_FOUND=PROMPT 
 +! /FILE_TYPES_ON_PROMPT=
 </code> </code>
  
-\\ +===== Notes =====
-\\ +
-[[Visual3D:Documentation:Pipeline:General_Information:Pipeline_Commands_Reference|Back to Pipeline Commands Reference]]+
  
 +==== File Types ====
  
 +The following file types are supported and can be added within Visual3D:
 +
 +  * .c3d - C3D File or [[http://www.c3d.org|www.c3d.org]]
 +  * .cmz - Visual3D Workspace File
 +  * .h5 - Visual3D [[..:..:definitions:file_formats:hdf5|HDF5]] Workspace File
 +  * .txt - Visual3D TAB delimited text File
 +  * .gcd - Vicon GCD File
 +  * .ndi - NDI Aurora File
 +  * .p2d - P2D File
 +
 +==== File Search Filter Types ====
 +
 +You can filter using the following filter types:
 +
 +  * C3D
 +  * CMZ
 +  * HDF5
 +  * VND
 +  * P2D
 +  * ASCII
 +  * XML
 +  * NDI
 +  * GCD
 +  * MVNX
 +
 +Multiple file types can be specified by using a plus sign (ex. C3D+CMO+P2D)
 +
 +[[Visual3D:Documentation:Pipeline:General_Information:Pipeline_Commands_Reference|Back to Pipeline Commands Reference]]
  
visual3d/documentation/pipeline/file_commands/file_open.1747404619.txt.gz · Last modified: by wikisysop