## VCollabWeb Viewer Help

VCollabWeb Viewer is a web application to view VCollab 3D report with viewpoints (similar to VCollab Presenter Lite) in any browser without installing any plugins. VCollabWeb Viewer can display viewpoints from a wCAX file, a proprietary format which can be exported from VCollab Pro.The user can launch this web application from any browser and load a wCAX file from a local system or from a server.

- This new application will simplify 3D CAE data sharing as there is no need to install VCollab Presenter Lite plugin by the client.
- This initiative can significantly improve the ability of the enterprises to share the product performance data and improve the collaboration among the simulation engineers, designers, chief engineers, testing teams and suppliers, leading to shorter cycles of decision making and improving the quality of the product and reducing the time to bring the product to the market.

The concept of viewpoints in VCollab enables the designers and analysts review 3D CAE report without much effort. The VCollabWeb viewer using wCAX report also enables similar viewing options. Focus here is viewing predefined viewpoints with labels, only viewing functions are supported.

### Quick Links

- wCAX File
- Viewer GUI
- How to create wCAX file?
- Supported Visualization Features
- Supported Browsers
- Work Flow
- Embedding VCollabWeb Viewer in a web page
- Open Source Softwares

### wCAX File

VCollabWeb Viewer uses VCollab proprietary format called wCAX to render the 3D model into the Web Pages.The wCAX format contains minimal data required for rendering viewpoints with minimal processing on the browser. VCollab Pro has the function to export wCAX file. The size of a wCAX file depends on the content in the viewpoint. If only a few parts and results are used in viewpoints then the wCAX file will be smaller than CAX file. If all the results and all the instances (for transient animation) from a CAX file are used in viewpoints, then wCAX file size may be larger than CAX file.

Note: Web applications use java scripts and have certain limitations in computation as compared to standalone applications. Try to avoid using large models (> 1million elements) with many instances.

### Viewer GUI

When VCollabWeb Viewer is opened in a browser, GUI of the viewer will look like a below image

Desktop View.
Mobile View.

GUI functionalities

- Viewer logo
- File open
- Menu bar
- 3D Slide UI
- Mouse interface
- Touch interface

Viewer logo

Click the "Viewer logo" icon to display the Version Dialog Box.

File open

Click the "File open" icon to open WCax file in the viewer. Using this option user can provide WCAX files from local hard disk or from a network.

Note: This icon will not be visible when it is disabled in configuration.

This "Menu bar" provides different functionality for the viewer. The number of icons available on the menu bar depends on the configuration.

Note: This menu bar will not be visible when it is disabled in configuration or Query string parameter of GUI is false.

Menu Icons

- Viewpoints
- CAE Animation
- Display Modes
- Clip_Plane
- Explode
- Product Tree
- Settings
- Probe
- Fit View
- Reset Viewpoints
- Full Screen
- Popup Menu

Viewpoints

Click this icon to display the Viewpoint list sidebar.

Viewpoint

In the Viewpoints bar, list of all viewpoints of the selected viewpath is displayed.The user can select different viewpoint from the list by clicking on any of the viewpoint images.

Note: Only viewpoint names will be displayed instead of images when WCAX file is saved with thumbnail option unchecked.

CAE Animation

Click this icon to display the CAE Animation sidebar. CAE Animation icon will be disabled for CAD models/animation is unavailable.

CAE Animation
CAE Animation disabled

In the CAE Animation sidebar, the user can play/pause the animation, move between frames, controls the animation speed and can change the scale factor.

Note: The Transient animation will play only when the viewpoint is saved with transient animation ON else linear/eigen animation will be played.

Display Modes

Click this icon to display the Display Modes sidebar.

Display Modes

In the Display Modes sidebar, the user can select different mesh display modes.

Clip Plane

Click this icon to display the Clip Plane sidebar.

Clip Plane

Select plane - Click on the Plane1/Plane2/Plane3 button to select the corresponding plane.

Click on this control to align the plane to the selected three point.
Click on this control to align the plane to the selected face.
XY - Click on this control to align the plane to XY axis.
YZ - Click on this control to align the plane to YZ axis.
XZ - Click on this control to align the plane to XZ axis.
Enable Plane - Click on this control to enable/disable the corresponding plane.
Show Plane - Click on this control to show/hide the corresponding plane.
Show Caps - Click on this control to enable/disable the cap for the corresponding plane.
Flip - Click on this button to flip the clip plane direction.
Offset - Move the slider to translate the clip plane position.
Tilt 1 - Move the slider to rotate the clip plane in one direction.
Tilt 2 - Move the slider to rotate the clip plane position in another direction.
Reset - Click this button to reset the clip plane.

Explode

Click this icon to display the Explode sidebar.

Explode

Control - Move the slider to change the explode value.
Sensitivity - Click the +/- button to increase/decrease the explode range.
Explode - Click this button to explode the model.
Reset - Click this button to reset the exploded model.

Product Tree

Click this icon to display the Product Tree sidebar.

Product Tree

Show/Hide parts - Click the check box to enable/disable the part visibility.
Select/Unselect parts - Click on the part name to select/unselect the part.
Filter parts - Click on the 'filter parts' text box and start typing to filter the parts.
Clear Filtering - Click on 'X' button to clear the filtering.
Sort parts - Click on the 'Sort Parts' toggle button to sort the parts in ascending/descending order.
Show Selected - Click this button to show all the selected parts.
Hide Selected - Click this button to hide all the selected parts.
Show others - Click this button to show all the unselected parts.
Hide others - Click this button to hide all the unselected parts.
Invert - Click this button to invert the parts visibility.

Settings

Click this icon to display the settings sidebar.

Settings
Camera - Click on this control to lock/unlock the camera position across the viewpoints.
Scale Factor - Click on this control to lock/unlock the scale factor across the viewpoints.
Animation Speed - Click on this control to lock/unlock the animation speed across the viewpoints.
Hide labels - Click on this control to show/hide the labels.
Hide XY-Plots - Click on this control to show/hide the XY-Plots.
Hide Ruler - Click on this control to show/hide the ruler.
Sync Rotation - Click on this control to Sync the rotation of the merged (multi) model. This control will be disabled for single model file.

Probe

Click this icon to enable/disable the Probe mode.

Probe

Fit View

Click this icon to fit the model into screen display.

Fit View

Reset Viewpoints

Click this icon to reset the view to the current viewpoint.

Reset Viewpoints

Full Screen

Click this icon to toggle between the full screen display mode and normal display mode.The user can also exit from full screen display mode by pressing Esc key in the keyboard.

Full Screen display mode
Exit full screen display mode

Click this icon to view the additional menu icons.

Popup Menu

Addition Menu Icons

- Capture
- Legend
- Frame Info
- Help

Capture

Click this icon to display the Capture sidebar.

Capture

In the capture sidebar, the user can select an image format (png, jpg, bmp), provide a file name and click save button to save the current display as an image.

Legend

Click this icon to toggle the legend visibility. Legend icon will be disabled for CAD models.

Legend visible
Legend not visible

Frame Info

Click this icon to display the frame information dialog box. Frame Info icon will be disabled for CAD models.

Frame info
Frame info disabled

Help

Click this icon to view the help page.

Help

3D Slide UI

These controls allow the user to view different viewpoints in the current viewpath. Left arrow loads previous viewpoint and right arrow loads next viewpoint in the current viewpath.

Note: These controls will not be visible when there are no viewpoints or only one viewpoint exists.

Mouse interface

Once the model is loaded into the viewer, User can interact with model using following mouse actions
Rotate: Click the left mouse button, hold and move.
Zoom: Click the middle mouse button, hold and move / Rotate the mouse scroll wheel.
Pan: Click the right mouse button, hold and move.

Set Rotation Point: Press "Alt" button and click left mouse button on model to set the pivot point for rotation.

Touch interface

User can interact with the model using one / two fingers in a touch-enabled device.
Rotate: Use one finger for rotating.
Zoom: Use two fingers to pinch-in / pinch-out for zooming in / zooming out.
Pan: Use two fingers for panning.

### How to create wCAX file?

1. Converting native file to CAX file.
2. Creating viewpoint in CAX File.
3. Creating wCAX File.

The wCAX files can be created from native files using a set of VCollab Tools and python scripts. The following steps explain wCAX file creation process in detail,

Converting Native file to CAX file

Native CAE/CAD files are translated to CAX file using VMoveCAE/VMoveCAD.

For CAE Files,

Interactive Mode

1. Open VMoveCAE ->Load model ->"select a native file"
2. Change the geometry (part) and result, if required.
3. File -> Save CAx

Batch Mode

"VMoveCAEBatch.exe [option=value] <model_file> [results_file] <CAX_file>"

For CAD Files,

Interactive Mode

1. Open VMoveCAD ->click "Input CAD File" ->"select a file"
2. Change the options, if required.
3. Click "Translate" button.

Batch Mode

"VMoveCADBatch.exe [option=value] input_cad_file output_cax_file

Creating viewpoint in CAX File

Viewpoints can be created in two different ways using VCollabPro. One method is to use python script with VCollabPro for creating Viewpoints and another method is to create manually using VCollabPro GUI.

Method 1

Interactive Mode using Python Script

1. Open model in VCollabPro
2. File -> Import ->Select the python script to create viewpoint
3. Save the Cax File.

Batch Mode using Python Script

'VCollabPro.exe -b "C:\Temp\MyReport_A.py"'

Method 2

Using VCollabPro GUI

1. Open model in VCollabPro
2. Click on Viewpoints Tab on Product explorer windows
3. Right Click on Viewpoints windows and select "Add viewpoint/Add path" to add new viewpoint or path.
4. Save the Cax File

Creating wCAX File

The wCAX files are created from CAX file using VCollabPro. These files can be created by running python script in VCollabPro or by manually export the files as wCAX from VCollabPro.

Method 1

Interactive Mode using Python Script

1. Open model in VCollabPro
2. File -> Import ->Select the python script to save as wCAX.
3. wCAX File will be saved.

Batch Mode using Python Script

'VCollabPro.exe -b "C:\Temp\export.py"'

Method 2

VCollabPro GUI

1. Open model in VCollabPro
2. Create viewpoints if required
3. File -> Export -> wCAX
4. wCAX file will be saved.

### Supported Visualization Features

- Most of the viewpoint entities or contents of VCollab (CAX) viewpoints are currently supported in wCAX. More features will be supported in the next release. The following table gives more detail on wCAX supported features.
- There can be certain limitations for problems when mesh changes from instance to instance (Moving or adaptive mesh). When sections and iso-surfaces entities are present.
- The file size of wCAX is influenced by following factors:
  - Number of viewpoints (from all viewpaths) stored in wCAX and their contents (parts, results and instances)
  - CAE Transient Animations stored in viewpoints (or number of instances and results used for animation)
  - Thumbnail images for viewpoints stored in wCAX

#### Supported viewpoint states in wCAX as compared to CAX/VCollabPro.

Viewpoints | Selected Viewpoints are stored (One / All Viewpoints in a path / All Paths)
Part display Modes | All parts used in viewpoints are stored in wCAX. Part colors and display modes are supported. Transparent mode need to be improved (when part surfaces overlap). Exploded state for the parts is saved in viewpoint.
CAE State/Plots | The most of the CAE states such as color plots, deformed plots, undeformed plots, Legend display are supported. Vector plots, Contour line plots are not supported in current version.
CAE Animation | Linear, Eigen/Modal and Transient animations stored in viewpoint are supported. If animation is not stored in viewpoint, Only Linear or Eigen animations can be displayed. Note that when transient animations are stored in viewpoint, all used instances are also stored in wCAX file.The user can select only required instances in VCollabpro (animation settings) to reduce file size. Note that when displacement result is present, undeformed and deformed shapes are stored in wCAX file for linear animation. The transient animation will play only when the viewpoint is saved with transient animation on. The contour color won't change during Complex Eigen Vector animation. Linear interpolation, pivot point and pivot plane are supported.
XYPlot | All XYPlots stored in viewpoints are supported in wCAX.Colors for the curves may look different.
Section | Section plot with all the display options is supported in wCAX. Display of Section curves may look very thick in certain cases (to be improved). Section cap is supported for closed part/model (to be improved).
Probe Labels | All type of probed labels are supported in viewpoints.
User Annotation Labels | All annotations in viewpoints are supported. But fonts and colors may look different.
Measurement Labels | Measurement labels are supported
Background | The Background displayed in viewpoint (including images) are supported.

### Supported Browsers

VCollabWeb Viewer is supported in all Web Browsers that have support for HTML5 + WebGL 1.0.The user can check if WebGL is enabled or not, by visiting the following link in any browser.

Note: Internet Explorer 11 may not support certain animation displays (when mesh is changing during animation)
VCollabWeb Viewer may not work properly when "Use hardware acceleration when available" option is disabled in chrome browser.

### Work Flow

Here are a few simple steps to share simulation data with others through a web interface.

- One needs to use VCollab tools to publish the simulation data/information into the VCollab Web format.
- Put the file on an HTTP server/PLM/SDM/SLM system
- Share the link to the file with others
- Others can click on the link and then view and interact with the 3D file in their browser.

A process can be defined in the PLM/SLM systems or on a server to convert the native CAE/CAD files into the VCollab Web format using the VCollab tools. It is advised to run this process on the same system where the native file resides. Native files are usually very large in size and moving them around, from system to system is a pain. Instead, one can convert the large native file into a lightweight CAX file on the same system and then one can move the lightweight CAX files easily. It is advised to also create Viewpoints and save them into the CAX file before one share the CAX file. Once viewpoints are added to the CAX files, the CAX file becomes a very useful simulation information that can be easily consumed by the non-experts.The experts (ex. CAE Analysts) can create the viewpoints manually and save them into CAX or one can execute VCollab Python scripts to create such viewpoints automatically, in batch mode. As mentioned earlier, this process converts raw simulation data into a very useful and intelligent simulation information that can be easily consumed by other stakeholders.Once these files are created, the link to these files can be shared with the others for easier Web viewing. Once the end user receives the link, they can click on the link to view these files in their WebGL enabled Browsers, without installing any plug-ins.

Note: VCollabWeb Application is a set of static HTML and javascript files that provide support for viewing 3D Models in browsers at the client side. It will currently be available only on VCollab Server.

### Embedding VCollabWeb Viewer in a web page

The following html code is used to embed VCollab Web Viewer in a web page

<iframe name="VCollabWeb" id="VCollabWeb"
src="https://apps.vcollab.com/vcollabweb/viewer.html?file=https://apps.vcollab.com/vcollabweb/samples/beam.wcax"
width="700" height="600"
seamless="seamless"
frameborder="0"
allowfullscreen="allowfullscreen">
</iframe>

Here, the URL for the wCAX file should be passed to the 'src' field
src="https://apps.vcollab.com/vcollabweb/viewer.html?file=URL-of-wCAX-to-be-passed"

Note: VCollabWeb Application will currently be available only on VCollab Server. The html file that is referred in 'src' field is located on VCollab Server.
src="https://apps.vcollab.com/vcollabweb/viewer.html?file=https://apps.vcollab.com/vcollabweb/samples/beam.wcax"
The users can keep the wCAX files on their server and the URL for wCAX can be passed to the 'src' field.

Cross-origin resource request

As VCollabWeb Application currently resides at VCollab server, the wCAX files from different server can't be accessed by VCollabWeb Application due to security reasons. It's recommended to add 'CORS' (Cross Origin Resource Sharing) header at their server in order to provide file access to VCollabWeb Application. If CORS header is not defined for cross-origin requests, VCollabWeb Viewer throws the following message,

"Cross-Origin Request Blocked (Reason: CORS header 'Access-Control-Allow-Origin' missing).

Click here to view how to set CORS Header.

### Open Source Softwares

Click Here for the open source software used by VCollabWeb Viewer.