Differences

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

--- visual3d:getting_started:toolbar [2024/09/06 19:28] – wikisysop
+++ visual3d:getting_started:toolbar [2025/07/08 15:35] (current) – wikisysop
@@ Line 1: / Line 1: @@
-====== Toolbar ======
+====== Visual3D Toolbar ======
-The toolbar provides common buttons/tasks that can be done within Visual3D.
+In the Visual3D application, a toolbar is available on the top of the screen providing buttons which execute common tasks required by users. Depending on the tab that is currently open, (Workspace, Signals and Events, Models, Reports, etc.), more buttons can appear displaying common processes for the tab.
-Depending on the current tab (Workspace, Signals and Events, Models, Reports, etc.), the toolbar options will change.
+This page will provide a description of the buttons available on the toolbar in order for users to understand the functionality. Equivalent commands will also be included if working through the pipeline rather than the user interface.
 ==== Workspace Tab ====
-{{:Buttons1_Arrow.JPG}}
+The workspace tab toolbar includes the main buttons to control the workspace, the following is displayed:
-=== New Workspace ===
+{{:visual3d:getting_started:workspacetab_buttons.png?900|}}
-Empties the current workspace and creates a new one.
+|**Toolbar Button**|**Functionality**|
-=== Open Files ===
+|New Workspace: \\ {{:visual3d:getting_started:new_workspace.png?30|}}|Empties current workspace and creates a new one. \\ Can also be selected to close files shown in the **Active File Combo Box**, an alternative method of closing files is to use the pipeline command called [[Visual3D:Documentation:Pipeline:File_Commands:File_Close|File_Close]]|
+|Open Files: \\ {{:visual3d:getting_started:open_files.png?30|}}|Opens movement files. \\ **NOTE**: Although default mask shows .c3d and .cmz files, this button can also open other file types such as ASCII files. The pipeline equivalent is the [[visual3d:documentation:pipeline:file_commands:file_open|File_Open]] command.|
+|Save File: \\ {{:visual3d:getting_started:save_file.png?30|}}|Saves workspace as a .cmz file, works the same as [[visual3d:documentation:pipeline:file_commands:file_save|File_Save]]|
+|Print: \\ {{:visual3d:getting_started:print.png?30|}}|Opens the print dialog box.|
+|Recalculate: \\ {{:visual3d:getting_started:recalculate.png?30|}}|Recalculates model and event data, can be pressed when changes are made to signals in order to apply it to the model, alternative to [[visual3d:documentation:pipeline:file_commands:recalc|Recalc]]|
+|Pipeline Workshop: \\ {{:visual3d:getting_started:pipeline.png?30|}}|Opens the pipeline workshop dialog box, more information can be found at the following link: [[Visual3D:Documentation:Pipeline:Pipeline_Overview|Visual3D Pipeline]]|
-Opens movement files. Note that although the default mask shows .c3d and .cmo files, this button can also open other file types such as ASCII files.
-{{:OpenFilesButton.jpg}}
-=== Save Files ===
+==== Signals And Events Tab ====
-Saves the workspace as a .cmo file in the [[Visual3D:Documentation:Definitions:File_Formats:CMO_Format|CMO Format]].
+When switched to the signals and events tab, an extension of additional buttons are added to the toolbar.
-{{:SaveFilesButton.jpg}}
-=== Close Files ===
+{{:visual3d:getting_started:signals_eventstab_buttons.png?900|}}
-There isn't a tool bar icon for closing motion trials, but this is a common process.
+|**Toolbar Button**|**Functionality**|
-The File Menu item "Close File" does NOT close the highlighted file in the workspace tab. It closes the [[Visual3D:Documentation:Definitions:Active_Files|active files]] shown in the selector box in the toolbar.
+|Event Editing: \\ {{:visual3d:getting_started:event_editing.png?70|}}|Manually adjust events: Edit Events (Pencil), Add Events (Plus Sign)|
-There is also a pipeline command called [[Visual3D:Documentation:Pipeline:File_Commands:File_Close|File_Close]] to close the active file(s).
+|Camera Reset: \\ {{:visual3d:getting_started:camera_reset.png?30|}}|Reset the 3D View to the default size.|
-{{:CloseFilesButton.jpg}}
+|Force Vector Size: \\ {{:visual3d:getting_started:force_vector_size.png?70|}} |Adjust the scale of the force vectors in the 3D viewer.|
+|Target Labels: \\ {{:visual3d:getting_started:target_labels.png?30|}} |Turn on/off target labels in 3D viewer.|
+|Targets: \\ {{:visual3d:getting_started:targets.png?30|}}|Turn targets on/off in 3D viewer|
+|Bones: {{:visual3d:getting_started:bones.png?30|}}|Turn the bones on/off in the 3D viewer. This is a toggle button, so the button loops through the following options: \\  - Item All Bones On \\ - Kinetic Bones On \\ - Kinematic Bones On \\ - All Bones Off|
+|Segment Geometry: {{:visual3d:getting_started:segment_geometry.png?30|}}|Turn the Segment Geometry on/off in 3D viewer|
+|Segment Lines: {{:visual3d:getting_started:segment_lines.png?30|}}|Turn Segment Lines on/off|
+|Active File: \\ {{:visual3d:getting_started:active_file_combo_box.png?200|}}|Active file defines what file is being processed and what file is displayed in the 3D viewer|
+|Query: \\ {{:visual3d:getting_started:query.png?200|}}|[[Sift:Documentation:Query|Query]] a set of files|
-=== Print ===
+==== Models Tab ====
-Opens the print dialog box.
+When switched to the Models tab, if a CMZ file with a model is already loaded in, the toolbar extends to show the following options.
-{{:PrintFilesButton.jpg}}
-===  Recalculate ===
+{{:visual3d:getting_started:model_tab_button.png?950|}}
-Recalculates model and event data.
+|**Toolbar Button**|**Functionality**|
-{{:RecalculateButton.jpg}}
+|Select Model Creation Method: \\ {{:visual3d:getting_started:select_model_creation_method_button.png?50|}}|Opens a dialog to create a new subject model using either a live camera snapshot or a saved static C3D file. Allows selection of a model template for calibration.|
+|Real-Time Model Building: \\ {{:visual3d:getting_started:real_time_model_building_button.png?50|}}| Opens a plugin to stream real-time motion capture data and build a model snapshot from the live scene. Includes tools for creating functional joints and digitizing landmarks.|
+|Model Builder Advanced Post Processing: \\ {{:visual3d:getting_started:model_builder_adv_postprocessing.png?50|}}| Tool for digitizing anatomical landmarks and creating functional joints from pointer motion files in post-processing.|
+|Frontal/Sagittal View Mode: \\ {{:visual3d:getting_started:frontal_saggital_view_button.png?50|}}| Changes the 3D model display to either front-facing (coronal plane) or side-facing (sagittal plane) perspectives.|
+|Perspective View Mode: \\ {{:visual3d:getting_started:perspective_view_mode_button.png?50|}}|Enables free manipulation of the 3D model display, allowing full perspective control.|
+|Animation Mode: \\ {{:visual3d:getting_started:animation_mode_button.png?50|}}|Activates VCR playback controls, allowing users to animate and view the trial with the 3D model.|
+|Load Model Template File: \\ {{:visual3d:getting_started:load_model_template_button.png?50|}}|Prompts the user to load a model template file (.mdh) into the workspace for use in model building.|
+|Open Model Template File: \\ {{:visual3d:getting_started:add_model_template_button.png?50|}}|Allows the user to add an additional model template file (.mdh) to the workspace without replacing the existing model.|
+|Save Model Template File: \\ {{:visual3d:getting_started:save_model_template_button.png?50|}}|Saves the current model template (.mdh), including any modifications made in the workspace.|
-=== Visual3D Pipeline ===
-Opens the Pipeline Workshop dialog box. More information on the Pipeline can be found at the [[Visual3D:Documentation:Pipeline:Pipeline_Overview|Visual3D Pipeline]] link.
+==== Reports Tab ====
-{{:V3DPipelineButton.jpg}}
-\\
+Next, the reports tab extends the toolbar with a few more buttons. This is shown in the following:
+{{:visual3d:getting_started:reportstab_button.png?900|}}
-==== Signals And Events Toolbar ====
-{{:SignalsAndEvents_Toolbar_v6.png}}
+|**Toolbar Buttons**|**Functionality**|
+|Zoom In/Out: \\ {{:visual3d:getting_started:zoom_in_out_button_reports.png?50|}}| Increases/Decreases the zoom level of the report page for closer/broader viewing.|
+|Show/Hide Report Dialog: \\ {{:visual3d:getting_started:show_hide_reportdialog_button.png?50|}}| Toggles the visibility of the report-building dialog used to edit and structure the report.|
+|Open Report Template: \\ {{:visual3d:getting_started:open_report_template_button.png?50|}}|Opens an existing report template file (.rgt) to use as a structure for the current report.|
+|Save Report Template: \\ {{:visual3d:getting_started:save_template_file_button.png?50|}}|Saves the current report layout as a .rgt template file for future use.|
-=== A. Event Editing ===
-Manually Adjust Events:
+==== CalTester Tab ====
-Edit Events (Pencil)
-Add Events (Plus Sign)
-=== B. Camera Reset ===
-Reset the 3D Viewer to the default view
+This tab extends the toolbar to show options for integration with the CalTester hardware equipment.
-=== C. Force Vector Size ===
-Adjust the scale of the force vectors in the 3D viewer
+{{:visual3d:getting_started:caltester_tab_button.png?900|}}
-=== D. Target Labels ===
-Turn on/off target labels in 3D viewer
+|**Toolbar Buttons**|**Functionality**|
-=== E. Targets ===
+|View CalTester Report Summary: \\ {{:visual3d:getting_started:view_caltester_report_button.png?50|}}|Displays the first summary page of the CalTester report, showing key calibration results and performance metrics from the CalTester hardware.|
+|View CalTester Report Graphs: \\ {{:visual3d:getting_started:view_caltester_reportgraphs_buttons.png?50|}}|Opens graphical report pages from the CalTester, displaying waveform and signal plots used to evaluate hardware calibration performance.|
+|Modify Caltester Rod Dimensions: \\ {{:visual3d:getting_started:modify_caltester_rod_dimensions.png?50|}}|Opens a dialog to define marker labels, adjust rod dimensions, set force thresholds, and update CalTester segment parameters.|
+|Modify Force Platform Parameters: \\ {{:visual3d:getting_started:modify_force_platform_parameter_button.png?50|}}| Opens a dialog to adjust settings related to force platform data if loaded.|
+|Modify Force Structure Parameters: \\ {{:visual3d:getting_started:modify_force_structure_parameters_button.png?50|}}|Opens a dialog to define and edit force structures, which group force platforms and their properties for combined analysis.|
+|Force Platform Locator: \\ {{:visual3d:getting_started:force_platform_locator_button.png?50|}}| Launches a tool to visually identify and confirm the physical location and orientation of force platforms in the capture volume.|
-Turn targets on/off in 3D viewer
-=== F. Bones ===
-Turn the bones on/off in the 3D viewer. This is a toggle button, so the button loops through the following options:
+==== Real-Time Plug-in Tab ====
-  - All Bones On
-  - Kinetic Bones On
-  - Kinematic Bones On
-  - All Bones Off
-=== G. Segment Geometry ===
+Finally, the real-time tab shows the toolbar with extended options for manipulation of the real-time plug-in to the Visual3D application.
-Turn the Segment Geometry on/off in 3D viewer
+{{:visual3d:getting_started:real_time_plugin_buttons.png?600|}}
-=== H. Stick Figure ===
-Turn Segment Lines on/off
+|**Toolbar Buttons**|**Functionality**|
-=== I. Active File ===
+|Modify Force Platform Parameters (Real Time): \\ {{:visual3d:getting_started:force_platform_parameters_button.png?50|}}|Opens a dialog to configure force platform parameters specifically for use with real-time streaming data.|
+|Modify Force Structure Parameters (Real Time): \\ {{:visual3d:getting_started:real_time_modifyforcestructure_button.png?50|}}| Configure force structure parameters for use with real-time streaming data.|
+|Toggle View RT Full Screen: \\ {{:visual3d:getting_started:toggle_view_rt_button.png?50|}}| Expands the Real-time streaming window to full screen by hiding or showing the side settings panel. Useful for focused visualization or adjusting RT parameters.|
-Set the active file
-Active file defines what file is being processed and what file is displayed in the 3D viewer
-=== J. Query ===
-[[Sift:Documentation:Query|Query]] a set of files