LATTICE TECHNOLOGY, INC. For Version 9.0 and later XVL Web Master Tutorial For Version 9.0 and later

LATTICE TECHNOLOGY, INC.

XVL Web Master TutorialFor Version 9.0 and laterFor Version 9.0 and later

August 2012 Lattice Technology, Inc. 2

Objectives

• By the end of this tutorial, you will be able to:

– install XVL Web master– create a web page with 3D data– configure parameters to change outputs– execute the program from a command line– integrate with other systems and applications


Agenda

• XVL Web Master Installation• XVL Web Master Templates• XVL Web Master Usage• Advanced Features

XVL Web Master Installation


XVL Web Master Installation

• Double-click on XVL_WebMaster-*_*.exe to start installation.– where *_* corresponds to the version number such as 9_0E.


Adobe SVG Viewer Installation

• In order to view 2D illustrations, you need to install Lattice3D SVG Viewer.

• Lattice3D SVG Viewer Installer:– Lattice3D_SVG_Viewer-*_*.exe

2D Illustration


XVL Web Master License Installation

1. Locate your license file. Its name will be xvlwm.ltl.

2. Open the XVL Web Master license folder by selecting Start > All Programs > XVL Web Master > License Folder.

3. Copy the license file to the folder.

• XVL Web Master expects the license folder to be relative to its installation directory as follows:

C:\Program Files\Lattice

WebMaster (XVL Web Master main modules)

License (license folder)

XVL Web Master Templates


Template2

3D View

Parts List

Assembly Tree

• Each view is cross-linked.– If you select a part in the assembly tree, the corresponding item on the parts list

and 3D view are highlighted.


Template2.2DIllust

3D View

Parts ListAssembly Tree

• Includes SVG Illustrations.– Parts in the 2D illustration are cross-linked between the illustration and other

information.

2D Illustration


Template2.2DImage

3D View

Parts List

Assembly Tree

• A separate image of a selected part is displayed.– Thumbnails are displayed in the parts list. Also selected parts are displayed as an

image in the small window.

Image of selected part


Template2.3DParts

3D View

Parts List

Assembly Tree

• Selected parts are displayed in another 3D view.

3D view of selected part


Template2.All

3D View

Parts List

Assembly Tree

• Both 2D illustrations and the 3D view are included in the HTML.

3D view of selected part

2D Illustration


Template2.Process

3D View

Parts List

Assembly Tree

• 3D work instructions are generated.– The process list is included in the HTML. By using the animation control buttons,

you can play process animations.

Process List

Animation Options

Template2.Disassembly

3D View

Parts ListDisassembly Tree

• The parts list is generated based on the Disassembly Tree.– Parts list is generated based on the Disassembly Tree defined in XVL Studio. Also

the Disassembly Tree is displayed as a structure tree.

2D Illustration


XVL Web Master Usage


• Open an XVL file with either of the following operations:– from the menu icon – drag-and-drop

Opening an XVL file

Drag and drop an XVL file

Open an XVL file


Basic Configuration for Web Pages

1. Click on the “Setup” icon to configure output files.

2. Choose a template, such as “Template2”.

3. Specify the output folder.

4. Click OK.

2

31

4


Generating a Webpage

• Click on the “Execute” icon to generate XVL Web Master output files.

Click on Execute to generate a web page.


Viewing the Results

• Click on the “View” icon to display the generated HTML file.

Click on View to see the published web page.


Generated Web Page: “Template2”

• Each view is cross-linked.– If you select “shovel” in the assembly tree, for example, the

corresponding line on the parts list and 3D view are highlighted.

Parts list

3D viewAssembly

tree

Cross-linking


Output Folder

• The output folder contains data necessary to view the 3D in a browser.

• In the example:– MainAssembly.html

• Main HTML file for viewing the entire data. The view button in the Web Master window has a link to this file.

– MainAssembly.xv3• XVL file that is embedded inside the HTML

window.

– MainAssembly_external.js• Eternal JavaScript codes to control

behaviors of mouse operations.

– MainAssembly_table.html• The source file for the parts list table.

– MainAssembly_tree.html• The source file for the assembly tree

structure.

– MainAssembly_xvl.html• The source file to embed the XVL file.

Configuration Details: General 1/2

1. Animation control• Automatic explosion animation can be defined by “Set auto

disassembly animation”. (Requires Automatic Disassembly Animation Option)

• If you have defined process steps in XVL Studio, by checking on the “Set process animation”, you can create a process animation. (Requires Process Planning Option)

2. Property priority• Select whether to give priority to properties in upper level

files or those in lower level files when configuration files are read. .

3. Template selection• Various templates are available, depending on the options

you purchase.

4. Output control• You can choose whether to create/update files or not.

5. Output location• By clicking on “Set folder”, you can browse for the desired

output folder.• You can click on “Output to sub folder” to create a new

folder for the XVL file.

3

4

1

5

2



Configuration Details: General 2/2

Template• Two different types of template are available:

Template.xxxxx – Classic Player templates (for XVL Player 8.x or before)

Template2.xxxxx – New Player templates (for XVL Player 9.x or after)

Classic Player templates New Player templates Template2


Configuring Details: Details 1/6

Target hierarchy of groups• Control the depth of the assembly tree structure to

show detail branches by specifying the “Others” and the Target indenture level.

• Hide the bottom levels of the branches.

12

2

34

4

3

3

3

2 3

4

4

4

5

5

Structure in the 3D model

12

2

2

Top: 2, Bottom: -1

12

2

3

Top: 3, Bottom: -2

12

2

34

4

3

3

3

2

Default

(Top: All, Bottom: -1)

Example) : Assembly : Part : Body


Configuration Details: Details 2/6

Process1. Check on “Output process parts” when you create the process tree based on tasks.

If the process tree is created based on intermediate processes, check this off.

2. Check on “Output valid processes only” when you want to output valid processes only.

12

Process tree based on intermediate processes

Process tree based on tasks



2

HTML1. Choose how to sort the Assembly Tree.

2. When you sort the tree by Property, specify the property name.

3. Select these checkboxes to use the contents of a CSV file instead of the information in an XVL file when creating output files.

1

3



Animation: Auto disassemblyYou can set parameters for an automatic disassemblyanimation generated by XVL Web Master.

a) Click on the Set details button to open the Auto disassembly animation dialog.

b) In the dialog, specify the parameters for Disassembly Factor, Level of indenture, Animation duration, keys to trigger animations, etc. You need to uncheck the “Use default ...” checkbox to give specific selections.

c) “Disassemble/reassemble parts by selection” will allow web viewers to click on a part and play back the animation.

d) “Step by step and reverse by indenture” will follow the indenture of the assembly structure for disassembly and assembly animations.

a d

c

b



Animation: ProcessYou can set parameters for a Process Animationgenerated by XVL Web Master.

a) Click on the Set details button to open the Process animation dialog.

b) In the dialog, specify the parameters for Disassembly Factor, Interpolation, and Intervals. You need to uncheck the “Use default ...” checkbox to make specific selections.

a

b

Snapshota) Specify the name of snapshot that you

want to apply.b) The specified snapshot is applied to

the disassembly animation/illustration.



XVL Studio Snapshot

a

b

XVL Web Master output

Auto DisassemblyEnabling this option will automatically create a

disassembled view of the illustration. Type in the factor for distances and level.

a) Switch on “Use default values for disassembly” to use the preset default values.

b) Factor: Distance between two parts. This is a relative value to the entire model size.

c) Level: The level of indenture of the assembly structure.


Configuration Details: Illustration 1/4

a

b

c



Batch Modea) During illustration creation, by default, you are

prompted to define a 2D view. With this check box on, however, you can set the view in the Quality and Parameters sections.

b) Quality: Set the desired output illustration quality.

c) Parameters: Specify the Projection, Coordinate, and angle vector to set the view for the 2D illustration. “Apply valid camera” will use the camera view saved in the XVL data.

a

b

c



Illustration SettingsYou can choose to generate vector and/or

raster images.

a) Specify Concave Edge and Convex Edge angles to control visible lines in the output illustrations.

b) You can also display trace lines, hidden lines and outlines.

c) More settings to improve the quality of the output illustrations.

a

b

c



a) “Specify size” will set the output illustration size.

b) Select “Leader lines” when you want to add balloons to each component automatically. Specify the leader line parameters.

c) When you check on “Notes”, notes will be displayed at the specified size in the illustration.

d) When you check on “Dimension”, dimensions will be displayed at the specified size in the illustration.

e) When “Adjust viewing area” is turned on, Web Master zooms out to the entire view to include all leader lines.

a

b

c

d

e


Configuring 2D Illustrations

Determine the 2D illustration view and settings. Then click “OK”.

--- Rotates the image 3-dimensionally.

--- Scales the image up/down.

--- Moves the image.

--- Displays the image to fit the Preview dialog box.

* Specified snapshot is applied to the 2D illustration

Advanced Features

By placing the CSV input file inside the same folder as the input XVL file, you can use this external data in the output HTML.


Using CSV to input data

1. Create a CSV input file.Specify the key ID in the first column. Information listed in the second column will be placed in the “Data” column of the table.

2. Place the XVL file and CSV input file in the same folder.

3. Execute XVL Web Master for the XVL file.4. Parameters in the CSV are set in the

parts list.

12

4


Creating a CGM File

You can create a CGM file.

1. Create xvlwm.ini file and write the following lines:Generate_CGM 2

Output_Dir C:\temp

– A sample xvlwm.ini file can be found in “C:\Program Files\Lattice\WebMaster\Samples”

2. Open a command line and execute the following:C:\Program Files\Lattice\

WebMaster>xvlwm.exe /autoexec /init xvlwm.ini [XVL_FILE]

where [XVL_FILE] is the target XVL file.

3. Find the output in the c:\temp folder.

Notes:– Please note that you can generate CGM files only

from command line executions.

– No standard template is provided for CGM outputs as of Web Master version 9.0.

Example of an integrated CGM output into a Web Master template. Here, we are using VizexReader for the CGM viewer.


Command Line Execution

• By default, the XVL Web Master execution command is found at C:\Program Files\Lattice\WebMaster

• Command line formatxvlwm.exe 　 [/autoexec] 　 [/english] [/init init_file] 　

[files_dirs ...]


Using XVL Web Master Post Processing

With XVL Converter Server post processing, XVL Web Master can automatically generate web pages.

1. Specify a post processing command

2. Create post_wm.bat in c:\work with the following contents:"c:\Program Files\Lattice\webmaster\

xvlwm.exe" /automatic /init wm.ini %1

3. Create wm.ini in c:\work with the following contents to specify a template: Template Template2.Process

4. Execute conversion in XVL Converter Server.

Argument: ${XVL.FILE}

Command: C:\work\post_wm.batt

XVL Converter Server


Questions?

E. [email protected] T. +1.415.274.1670 F. +1.415.274.1671 W. www.lattice3d.com

Documents

LATTICE TECHNOLOGY, INC. For Version 9.0 and later XVL Web Master Tutorial For Version 9.0 and later