Differences

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

--- visual3d:documentation:pipeline:file_commands:export_3d_animation_to_image [2024/06/19 12:50] – sgranger
+++ visual3d:documentation:pipeline:file_commands:export_3d_animation_to_image [2024/07/17 15:45] (current) – created sgranger
@@ Line 1: / Line 1: @@
-{{{{{{export a snapshot of the 3d viewer and save the file to disk.
+====== Export 3D Animation To Image ======
+Export a snapshot of the 3D viewer and save the file to disk.
   * multiple files in the workspace can be selected
   * multiple frames of data can be exported to individual files
-**note: if there are multiple output files (either because of multiple files or multiple frames), the name of the file is used as a prefix on the output file and the frame number is appended.**
+**Note: if there are multiple output files (either because of multiple files or multiple frames), the name of the file is used as a prefix on the output file and the frame number is appended.**
-===== contents =====
+==== Contents ====
-  * [[#pipeline_command|1 pipeline command]]
+  * [[#Pipeline_Command|1 Pipeline Command]]
-    * [[#exporting_one_image|1.1 exporting one image]]
+    * [[#Exporting_one_image|1.1 Exporting one image]]
-    * [[#exporting_multiple_images|1.2 exporting multiple images]]
+    * [[#Exporting_multiple_images|1.2 Exporting multiple images]]
-  * [[#version_4_implementation|2 version 4 implementation]]
+  * [[#Version_4_Implementation|2 Version 4 Implementation]]
-===== pipeline command =====
+==== Pipeline Command ====
-**export_3d_animation_to_image**
+**Export_3D_Animation_To_Image**
-/file_name=
+/FILE_NAME=
-/image_file_name=
+/IMAGE_FILE_NAME=
-/append_frame_to_filename=
+/APPEND_FRAME_TO_FILENAME=
-/start_frame=1
+/START_FRAME=1
-/end_frame=
+/END_FRAME=
-/event_sequence=
+/EVENT_SEQUENCE=
-/exclude_events=
+/EXCLUDE_EVENTS=
-/output_width=640
+/OUTPUT_WIDTH=640
-/output_height=480
+/OUTPUT_HEIGHT=480
 **;**
-==== exporting one image ====
+=== Exporting one image ===
-in the following example:
+In the following example:
-  * one image is exported from the first file that matches the wildcard specificat
+  * One Image is exported from the first file that matches the wildcard specificat
-  * frame 10 is exported
+  * Frame 10 is exported
-  * the output file is specified using the image_file_name parameter
+  * The output file is specified using the IMAGE_FILE_NAME parameter
 \\
-**export_3d_animation_to_image**
+**Export_3D_Animation_To_Image**
-/file_name=*2.c3d
+/FILE_NAME=*2.c3d
-/image_file_name=z:\temp\outimage.png
+/IMAGE_FILE_NAME=Z:\temp\outImage.png
-/append_frame_to_filename=false
+/APPEND_FRAME_TO_FILENAME=FALSE
-! /image_format=png
+! /IMAGE_FORMAT=png
-/start_frame=10
+/START_FRAME=10
-/end_frame=
+/END_FRAME=
-/event_sequence=
+/EVENT_SEQUENCE=
-/exclude_events=
+/EXCLUDE_EVENTS=
-! /output_width=640
+! /OUTPUT_WIDTH=640
-! /output_height=480
+! /OUTPUT_HEIGHT=480
 **;**
-exportimagedlg2.jpg
+{{:ExportImageDlg2.jpg}}
-mvc002_61.png
+{{:mvc002_61.png}}
-==== exporting multiple images ====
+=== Exporting multiple images ===
-in the following example:
+In the following example:
-  * images are exported from all files in the workspace.
+  * Images are exported from all files in the workspace.
-  * frames 1 and 2 are exported
+  * Frames 1 and 2 are exported
-  * all frames within the event_sequence (lhs-lto) are exported
+  * All frames within the Event_Sequence (LHS-LTO) are exported
-  * the target folder for the files is specified using the image_file_name parameter
+  * The target folder for the files is specified using the IMAGE_FILE_NAME parameter
-  * the exported file contains the name of the original file appended with the frame number
+  * The exported file contains the name of the original file appended with the frame number
 \\
-**export_3d_animation_to_image**
+**Export_3D_Animation_To_Image**
-/file_name=*.c3d
+/FILE_NAME=*.c3d
-/image_file_name=z:\temp\
+/IMAGE_FILE_NAME=Z:\temp\
-/append_frame_to_filename=true
+/APPEND_FRAME_TO_FILENAME=TRUE
-/start_frame=1
+/START_FRAME=1
-/end_frame=2
+/END_FRAME=2
-/event_sequence=lhs+lto
+/EVENT_SEQUENCE=LHS+LTO
-/exclude_events=
+/EXCLUDE_EVENTS=
-/output_width=640
+/OUTPUT_WIDTH=640
-/output_height=480
+/OUTPUT_HEIGHT=480
 **;**
-exportimagedlg.jpg
+{{:ExportImageDlg.jpg}}
-===== version 4 implementation =====
+==== Version 4 Implementation ====
-export a snapshot of the 3d viewer and save the file to disk.
+Export a snapshot of the 3D viewer and save the file to disk.
-in version 4:
+in Version 4:
   * only one file in the workspace can be selected
@@ Line 88: / Line 90: @@
   * only one exported filename can be specified.
-**export_3d_animation_to_image**
+**Export_3D_Animation_To_Image**
-! /file_name=
+! /FILE_NAME=
-! /image_file_name=
+! /IMAGE_FILE_NAME=
-! /frame=1
+! /FRAME=1
-! /output_width=640
+! /OUTPUT_WIDTH=640
-! /output_height=480
+! /OUTPUT_HEIGHT=480
 **;**
-this is consistent with the export option under the [[[https://www.c-motion.com/v3dwiki/index.php?title=menus#file_menu|file menu item]]]
+This is consistent with the export option under the [[[https://www.c-motion.com/v3dwiki/index.php?title=Menus#File_Menu|File Menu Item]]]
 \\
-[[visual3d:documentation:pipeline:general_information:pipeline_commands_reference|back to pipeline commands reference]]
+[[Visual3D:Documentation:Pipeline:General_Information:Pipeline_Commands_Reference|Back to Pipeline Commands Reference]]
-}}}}}}