HAS-Motion Software Documentation

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 15:59] – [Command Parameters] wikisysopvisual3d:documentation:pipeline:file_commands:file_open [2025/05/16 16:28] (current) – 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 file and filter types, see the notes section.
  
 ===== Pipeline Command ===== ===== Pipeline Command =====
Line 48: Line 49:
   * **File Mask on Prompt**: A filter for which file types appear in the dialog.   * **File Mask on Prompt**: A filter for which file types appear in the dialog.
  
-==== File_Types ====+===== Examples =====
  
-The following file types are supported and can be added within Visual3D: +The following examples will go through the use of the **File_Open** command within the Visual3D application. 
- +
-  * .c3d - C3D File or [[[http://www.c3d.org|www.c3d.org]]] +
-  * .cmo - Visual3D Workspace File +
-  * .txt - Visual3D TAB delimited text File +
-  * .gcd - Vicon GCD File +
-  * .ndi - NDI Aurora File +
-  * .p2d - P2D File+
  
-==== Filter ==== +=== Example 1: Prompt the user for the filename ===
- +
-You can filter using the following filter types: +
- +
-  * C3D +
-  * 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 85: 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 120: 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 137: 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]]]
 +  * .cmo - Visual3D Workspace File
 +  * .txt - Visual3D TAB delimited text File
 +  * .gcd - Vicon GCD File
 +  * .ndi - NDI Aurora File
 +  * .p2d - P2D File
 +
 +=== Filter ===
 +
 +You can filter using the following filter types:
 +
 +  * C3D
 +  * CMO
 +  * 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.1747411182.txt.gz · Last modified: 2025/05/16 15:59 by wikisysop