0% found this document useful (0 votes)
40 views7 pages

XVL Player / XVL Player Pro Lattice3D Reporter Menu File Manual

Download as pdf or txt
Download as pdf or txt
Download as pdf or txt
You are on page 1/ 7

XVL Player / XVL Player Pro

Lattice3D Reporter
Menu File Manual

THIS DOCUMENT INCLUDES TECHNICAL INFORMATION THAT IS THE INTELLECTUAL


PROPERTY OF THE DEVELOPER OF THIS PRODUCT, LATTICE TECHNOLOGY CO.,LTD.
DO NOT DISTRIBUTE OR POST THIS DOCUMENT WITHOUT PRIOR WRITTEN PERMISSION
FROM LATTICE TECHNOLOGY CO.,LTD.

For product support, please contact your sales agent.

Copyright © 2007-2012 Lattice Technology Co.,Ltd. All rights reserved.


Table of contents

1 Introduction ...........................................................................................................................................4
2 Menu File..............................................................................................................................................4
2.1 Specification of the menu file in XVL Player ................................................................................4
2.1.1 Priority....................................................................................................................................4
2.1.2 Server Menu File...................................................................................................................4
2.1.3 Client Menu File ....................................................................................................................4
2.2 Specification of the menu file in Lattice3D Reporter....................................................................5
2.3 Menu File Format .........................................................................................................................5
3 Description of Parameters ...................................................................................................................6
3.1 Customization Parameters...........................................................................................................6
3.2 Menu ID.........................................................................................................................................6
Trademarks and registered trademarks

XVL is a registered trademark of Lattice Technology Co.,Ltd.


OpenGL is a registered trademark of Silicon Graphics, Inc.
Microsoft, Windows, Microsoft Internet Explorer, Microsoft Office, Visual Basic for Application, Visual
Basic, Visual C++, Microsoft Developer Network are registered trademarks of Microsoft Corporation
in the U.S. and/or other countries.
The official name for Windows is Microsoft Windows Operating System.
The official name for MSDN is Microsoft Developer Network.
The names of actual companies and products mentioned herein may be the trademarks or the
registered trademarks of their respective owners.
1 Introduction

This manual describes the menu file of XVL Player / XVL Player Pro and Lattice3D Reporter.
In this manual, XVL Player / XVL Player Pro is generally called “XVL Player.”

2 Menu File

The menu file enables the settings outlined below for XVL Player and Lattice3D Reporter 3D model
menu items.

z Menu titles, toolbar tool tips, and messages shown in the status bar upon menu item selection
z Whether to execute menu items

2.1 Specification of the menu file in XVL Player

2.1.1 Priority

The XVL Player start-up options can be specified using the following methods.
If the same option is specified using several methods, the highest-priority specification will be
adopted.

Priority Specification Description


method
High Server menu Specifies the menu file using OPT_MENU_FILE among the Options
file properties set upon startup.
For more information, refer to “2.3 Menu File Format”.
Client menu Specifies the menu file path <Installation_directory>¥Env¥Menu.csv.
file For more information, refer to “2.3 Menu File Format”.
Low

2.1.2 Server Menu File

The file is specified for OPT_MENU_FILE among the Options properties set upon startup.
The following description is used for HTML specification.

<param name = "Options" value =”OPT_MENU_FILE(Menu.csv)”>

For details on start-up options, refer to “XVL Player / XVL Player Pro Start-Up Options Manual”.

2.1.3 Client Menu File


The client menu file is created as “Menu.csv” in the subdirectory “Env” of the installation directory.
For example, if the program (xvlplay3.ocx) is located in the “C:¥Program Files¥Lattice¥Player3”
directory, the menu file referenced will be “C:¥Program Files¥Lattice¥Player3¥Env¥Menu.csv”.

2.2 Specification of the menu file in Lattice3D Reporter

In Lattice3D Reporter, the client menu file is created as “Menu.csv” in the subdirectory “Env” of the
installation directory. For example, if the program (l3dreporter.dll) is located in the “C:¥Program
Files¥Lattice¥Lattice3D Repoter” directory, the menu file referenced will be “C:¥Program
Files¥Lattice¥ Lattice3D Repoter¥Env¥Menu.csv”.

2.3 Menu File Format

The configuration file is in CSV format, with each line corresponding to a single parameter.
The first column shows customization parameters, and the meaning of the subsequent columns
depends on its content. Lines whose first column starts with ‘#’ are regarded as comment lines and
ignored.

When the customization parameter is “TITLE”:


Specifying the customization parameter as “TITLE” sets a character string for the menu item or
title. Each line is given as follows:

Customization parameter, menu ID, title, tool tip, status message

The details of each cell are as follows:

Cell Meaning
Customization Specified as “TITLE”
parameter
Menu ID Character string to identify menu item.
Title Title character string to be shown for the menu item. If this is empty, the
standard title is shown.
Tool tip Tool tip character string to be shown on the toolbar. If this is empty, the
standard tool tip is shown.
Status Message character string to be shown on the status bar. If this is empty, the
message standard status message is shown.

When the customization parameter is “STATUS”:


Specifying the customization parameter as “STATUS” enables setting of whether to execute the
specified menu item. Each line is given as follows:

Customization parameter, menu ID, invalidity


The details of each cell are as follows:

Cell Meaning
Customization Specified as “STATUS”
parameter
Menu ID Character string to identify menu item
Invalidity Specifying “TRUE” disables the menu item at all times.
Specifying “FALSE” enables menu item execution.

Coding example:
#Sample,,
TITLE,ID_VIEW_FRONT,Left view,Left,Left view
STATUS,ID_TOOL_MEDIT,TRUE

The 1st line


Because the first cell begins with ‘#’, this line is considered as a comment line and is
ignored.

The 2nd line


Changes the title, tool tip and status message of “ID_VIEW_FRONT” to “Left view,” “Left”
and “Left view,” respectively.

The 3rd line


Enables execution of “ID_TOOL_MEDIT” at any time.

3 Description of Parameters

3.1 Customization Parameters

The table below lists the currently available parameters. If other parameters are specified, the
corresponding lines will be ignored.

Parameter Function
TITLE Changes the specified menu item notation.
STATUS Specifies whether to execute the specified menu item.

The number of customization parameters will be increased in the future.

3.2 Menu ID

Available parameters for menu IDs in the menu file are listed in the table below.

The “Customization parameter” column describes the customization parameter values available for
the corresponding menu IDs.

The Change column shows the version in which handling of the parameter has been changed, and
a letter that indicates the type of change. The table below shows description of each letter that
indicates the type of change:

Letter Description
+ The item has been added.
- The item has been deleted.
* The item whose name or operation has been modified

For example, if the Change column shows 11.1+, it indicates that the corresponding item has been
added in Ver. 11.1.

‘Change P’ indicates versions of XVL Player where modifications have been made, and ‘Change R’
indicates the same for Lattice3D Reporter.

Change Change Menu ID Menu Customization


P R parameter
ID_VIEW_FRONT View → Front TITLE
ID_VIEW_BACK View → Back TITLE
ID_VIEW_RIGHT View → Right TITLE
ID_VIEW_LEFT View → Left TITLE
ID_VIEW_TOP View → Top TITLE
ID_VIEW_BOTTOM View → Bottom TITLE
ID_VIEW_ISO View → ISO TITLE
ID_TOOL_OEXAM View Operation Mode → STATUS
Examine
ID_TOOL_OWALK View Operation Mode → STATUS
Walk
ID_TOOL_OFLY View Operation Mode → Fly STATUS
ID_TOOL_MPLY Switch to View Mode STATUS
ID_TOOL_MEDIT Switch to Edit Mode STATUS
ID_FILE_SAVE_AS File → Save As STATUS
IDC_XT_TOOLBAR View → Toolbar STATUS
IDC_XT_TREEDOCKWIN View → Assembly Tree STATUS
ID_FILE_PROP File → Properties STATUS
ID_EDIT_PROP Edit → Properties STATUS

You might also like