HAS-Motion Software Documentation

User Tools

Site Tools

You are here: Main Page » other » visual3dserver » documentation » Visual3DServer Documentation
other:visual3dserver:documentation:visual3dserver_documentation

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
other:visual3dserver:documentation:visual3dserver_documentation [2024/07/16 19:23] – created sgrangerother:visual3dserver:documentation:visual3dserver_documentation [2024/07/17 15:44] (current) – created sgranger
Line 1: Line 1:
-====== Visual3DServer_Documentation ======+====== Visual3DServer Documentation ======
  
 \\ \\
Line 10: Line 10:
 ==== Shell ==== ==== Shell ====
  
-{{V3DSFullScreen3.png}}\\+{{:V3DSFullScreen3.png}}\\
  
  
 === Connecting === === Connecting ===
  
-{{C3DConnected.png}}\\+{{:C3DConnected.png}}\\
 The "Connect to Hardware" buttons are located on the hardware tabs at the top of the program on the left hand side. There will be one tab for each of the hardware options that you selected when you installed the Server. A blank circle to the left of the name indicates that the hardware is not connected and a green circle indicates that there is a live connection. In the example above the C3D file is connected and the other three are not. Clicking on the circle will either connect or disconnect the hardware depending on its status. Multiple types of hardware can all be connected at the same time. The "Connect to Hardware" buttons are located on the hardware tabs at the top of the program on the left hand side. There will be one tab for each of the hardware options that you selected when you installed the Server. A blank circle to the left of the name indicates that the hardware is not connected and a green circle indicates that there is a live connection. In the example above the C3D file is connected and the other three are not. Clicking on the circle will either connect or disconnect the hardware depending on its status. Multiple types of hardware can all be connected at the same time.
  
Line 22: Line 22:
 Near the bottom of the Visual3DServer window are the controls that are used to record and save data to disk. Near the bottom of the Visual3DServer window are the controls that are used to record and save data to disk.
  
-{{A3DCollectionControls.png}}+{{:A3DCollectionControls.png}}
  
 At the top of the record controls is the file path and the browse button. The file path, where it reads C:/Users/c-motion, tells you where the file you collect is going to be saved. The browse button allows the user to change where the file collected will be saved. To the bottom left is the text field where the file name the file is to be named is specified, in the example it reads static002. Visual3DServer will automatically increase the count at the end of the file name by one. To the bottom right is the timer, in the example it reads 10.00 s. This controls the length of the capture and can be set at any number between 0 and 9,999.99. However, recording for lengthy periods of time requires a computer with sufficient speed. To the far right is the start recording button which is only active when the program is connected to a hardware system. At the top of the record controls is the file path and the browse button. The file path, where it reads C:/Users/c-motion, tells you where the file you collect is going to be saved. The browse button allows the user to change where the file collected will be saved. To the bottom left is the text field where the file name the file is to be named is specified, in the example it reads static002. Visual3DServer will automatically increase the count at the end of the file name by one. To the bottom right is the timer, in the example it reads 10.00 s. This controls the length of the capture and can be set at any number between 0 and 9,999.99. However, recording for lengthy periods of time requires a computer with sufficient speed. To the far right is the start recording button which is only active when the program is connected to a hardware system.
  
-{{A3DCollectionControlsDone.png}}+{{:A3DCollectionControlsDone.png}}
  
 The collection controls will turn to the above once the data collection is over. The Start Recording button to the far right will change to the Next and Delete buttons. Next will finish saving the file to disk and Delete will permanently remove the file from memory. Both will return the right hand button back to the Start Recording button. The collection controls will turn to the above once the data collection is over. The Start Recording button to the far right will change to the Next and Delete buttons. Next will finish saving the file to disk and Delete will permanently remove the file from memory. Both will return the right hand button back to the Start Recording button.
Line 32: Line 32:
 === 3D-View === === 3D-View ===
  
-|{{3DViewTab_Buttons.png}}|+|{{:3DViewTab_Buttons.png}}|
  
 The first tab to the left, regardless of which hardware plugins have been installed, is the 3-D View tab. This presents a graphical representation of the data being received by the system. It shows what is presented in the 3D view in the plugin tabs with the exception that the 3-D View tab amalgamates the data received from all hardware sources. As such you can see both force and marker data at the same time even if they originate from different hardware systems.\\ The first tab to the left, regardless of which hardware plugins have been installed, is the 3-D View tab. This presents a graphical representation of the data being received by the system. It shows what is presented in the 3D view in the plugin tabs with the exception that the 3-D View tab amalgamates the data received from all hardware sources. As such you can see both force and marker data at the same time even if they originate from different hardware systems.\\
Line 42: Line 42:
 == Save 3D View == == Save 3D View ==
  
-{{Save3DView2.png}}+{{:Save3DView2.png}}
  
 This button allows you to save what is currently being displayed in the 3D view graphics area. The image can be saved in a number of standard formats, such as .bmp, .ico, .jpeg, .jpg, .pbm, .pgm, .png, .ppm, .tif, .tiff, .wbmp, .xbm, or .xpm. This function is ideal for producing graphics for papers or presentations. Saved images can be edited with 3rd party graphics programs if needed. This button allows you to save what is currently being displayed in the 3D view graphics area. The image can be saved in a number of standard formats, such as .bmp, .ico, .jpeg, .jpg, .pbm, .pgm, .png, .ppm, .tif, .tiff, .wbmp, .xbm, or .xpm. This function is ideal for producing graphics for papers or presentations. Saved images can be edited with 3rd party graphics programs if needed.
Line 48: Line 48:
 == Copy 3D View to clipboard == == Copy 3D View to clipboard ==
  
-{{Copy3DViewToClipboardSmall2.png}}+{{:Copy3DViewToClipboardSmall2.png}}
  
 This button allows you to copy what is currently being displayed in the 3D view graphics area to the clipboard. This allows you to paste the image into any program that supports copy and paste. This is useful for working with presentation or graphics editing software. This button allows you to copy what is currently being displayed in the 3D view graphics area to the clipboard. This allows you to paste the image into any program that supports copy and paste. This is useful for working with presentation or graphics editing software.
Line 54: Line 54:
 == Reset camera 3D View == == Reset camera 3D View ==
  
-{{ResetCamera3DViewColor2.png}}+{{:ResetCamera3DViewColor2.png}}
  
 This button brings the 3D viewer back to it's beginning position. You may find that having used the rotation, translation, and zooming capabilities of the 3D view you have lost track of where you are in the graphics, which can make returning to a proper view of your data challenging. The reset view button removes this frustration and reorients you. This button brings the 3D viewer back to it's beginning position. You may find that having used the rotation, translation, and zooming capabilities of the 3D view you have lost track of where you are in the graphics, which can make returning to a proper view of your data challenging. The reset view button removes this frustration and reorients you.
Line 60: Line 60:
 == 3D View Preferences == == 3D View Preferences ==
  
-{{3DViewPreferences.png}}+{{:3DViewPreferences.png}}
  
 This button allows you to change how the graphics that are presented to you. Changes happen in real time. At the bottom is the "Restore Defaults" button which resets all of the options to their standard setting. This button allows you to change how the graphics that are presented to you. Changes happen in real time. At the bottom is the "Restore Defaults" button which resets all of the options to their standard setting.
Line 66: Line 66:
 = Scene = = Scene =
  
-|{{3DViewSettings.png}}|+|{{:3DViewSettings.png}}|
  
 Lighting on - When selected graphics that are suppose to be 3 dimensional have shadows to help simulate shape. When not selected objects are one solid color.\\ Lighting on - When selected graphics that are suppose to be 3 dimensional have shadows to help simulate shape. When not selected objects are one solid color.\\
Line 128: Line 128:
 = Segment Markers = = Segment Markers =
  
-|{{ColourDialogBox.png}}|+|{{:ColourDialogBox.png}}|
  
 When the check box next to the segment markers is not checked the segment markers will not appear in the 3D View. In this case all the bellow options will be greyed out as they will have no effect if the segment markers are not present. When the check box next to the segment markers is not checked the segment markers will not appear in the 3D View. In this case all the bellow options will be greyed out as they will have no effect if the segment markers are not present.
Line 166: Line 166:
 == Pause Display == == Pause Display ==
  
-{{PauseDisplayButton2.png}}\\+{{:PauseDisplayButton2.png}}\\
 The Pause Display button freezes all of the active 3D-view screens. Once paused the Pause Display button will become the Resume Display button. Data continues to stream to and from the server when the 3D-views are paused. The Pause Display button freezes all of the active 3D-view screens. Once paused the Pause Display button will become the Resume Display button. Data continues to stream to and from the server when the 3D-views are paused.
  
 == Settings == == Settings ==
  
-|{{SettingsButtonSmall.png}}|+|{{:SettingsButtonSmall.png}}|
  
 \\ \\
Line 179: Line 179:
 The Settings window, shown on the right, is opened using the Settings button, shown above. The Settings window, shown on the right, is opened using the Settings button, shown above.
  
-|{{SettingsWindow2.png}}|+|{{:SettingsWindow2.png}}|
  
 = Stream = = Stream =
Line 188: Line 188:
 The code that acquires frames operates in a separate thread of execution (much like a separate program). Each thread (or program) on a computer has a priority. In fact, if you start the Windows task manager (right click the Task bar at the bottom of the screen) you'll see, under the processes tab, that you can view and set the "priority" of any program. Normal Priority is usually fine for most threads (and programs). The code that acquires frames operates in a separate thread of execution (much like a separate program). Each thread (or program) on a computer has a priority. In fact, if you start the Windows task manager (right click the Task bar at the bottom of the screen) you'll see, under the processes tab, that you can view and set the "priority" of any program. Normal Priority is usually fine for most threads (and programs).
  
-{{thread_priority.png}}+{{:thread_priority.png}}
  
 **Thread Sleep**\\ **Thread Sleep**\\
Line 197: Line 197:
 It is likely that these features will be either hidden or removed at some point as this level of user control is not that useful now that the frame acquisition code has been refined. It is likely that these features will be either hidden or removed at some point as this level of user control is not that useful now that the frame acquisition code has been refined.
  
-{{threadsleep.png}}+{{:threadsleep.png}}
  
 **Apply Stream Changes** **Apply Stream Changes**
Line 203: Line 203:
 When you make changes to the Thread Priority or the Thread Sleep the Apply Stream Changes button will become active. You will need to press it in order to apply the changes. This is in place to prevent users from accidentally interrupting their session by inputting an incorrect setting. When you make changes to the Thread Priority or the Thread Sleep the Apply Stream Changes button will become active. You will need to press it in order to apply the changes. This is in place to prevent users from accidentally interrupting their session by inputting an incorrect setting.
  
-{{ApplyStreamChangesButton.png}}+{{:ApplyStreamChangesButton.png}}
  
 = Display = = Display =
Line 209: Line 209:
 The display portion of the settings dialogue allows you to control the program outputs by personalizing the graphics. The display portion of the settings dialogue allows you to control the program outputs by personalizing the graphics.
  
-|{{Display_settings.png}}|+|{{:Display_settings.png}}|
  
 **Text Size**\\ **Text Size**\\
Line 224: Line 224:
 The record portion of the settings dialogue controls record function which allows for signal when recordings begin and end as well as saving preferences. The record portion of the settings dialogue controls record function which allows for signal when recordings begin and end as well as saving preferences.
  
-|{{V3DSRecordSettings2.png}}|+|{{:V3DSRecordSettings2.png}}|
  
 **Countdown**\\ **Countdown**\\
Line 250: Line 250:
 == Help == == Help ==
  
-{{HelpButton.png}}\\+{{:HelpButton.png}}\\
 The "Help" button leads to the Visual3DServer Overview web page should you need to reference this documentation in the future. The "Help" button leads to the Visual3DServer Overview web page should you need to reference this documentation in the future.
  
 == About == == About ==
  
-|{{AboutV3DServerDeactivate.png}}|+|{{:AboutV3DServerDeactivate.png}}|
  
-{{AboutButtonLarge.png}}+{{:AboutButtonLarge.png}}
  
 The "About" button opens a window that has details on Visual3DServer including version number, release date, copy right information, support contact information, and if the program has been licensed and is able to broadcast to custom clients. If the Visual3DServer SDK has also be installed the About window also have either the "Deactivate" button or the "Activate" button. Purchasing, installing and activating Visual3DServer allows it to be used to stream to clients other than Visual3D. Deactivating the licence allows users to move the program from one computer to another instead of purchasing another licensing key. The "About" button opens a window that has details on Visual3DServer including version number, release date, copy right information, support contact information, and if the program has been licensed and is able to broadcast to custom clients. If the Visual3DServer SDK has also be installed the About window also have either the "Deactivate" button or the "Activate" button. Purchasing, installing and activating Visual3DServer allows it to be used to stream to clients other than Visual3D. Deactivating the licence allows users to move the program from one computer to another instead of purchasing another licensing key.
other/visual3dserver/documentation/visual3dserver_documentation.1721157787.txt.gz · Last modified: 2024/07/16 19:23 by sgranger