You are on page 1of 53

XVL Player / XVL Player Pro Start-Up Options Manual

XVL Player / XVL Player Pro


Start-Up Options 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.

1
XVL Player / XVL Player Pro Start-Up Options Manual

Table of contents

1 Introduction .......................................................................................................................................... 4
2 Start-up Options................................................................................................................................... 4
2.1 Priority .......................................................................................................................................... 4
2.2 Usage........................................................................................................................................... 5
3 XVL Player Insertion............................................................................................................................ 6
3.1 HTML ........................................................................................................................................... 6
3.2 Microsoft Office 2000-2003 ......................................................................................................... 8
3.3 Microsoft Office 2007................................................................................................................. 12
3.4 Microsoft Office 2010................................................................................................................. 15
4 Properties........................................................................................................................................... 17
4.1 General ...................................................................................................................................... 19
4.2 Graphics..................................................................................................................................... 20
4.3 Custom....................................................................................................................................... 22
4.4 Display Element......................................................................................................................... 23
4.5 Display Options.......................................................................................................................... 24
4.6 Event .......................................................................................................................................... 25
4.7 Others......................................................................................................................................... 26
5 Configuration Files............................................................................................................................. 28
5.1 Server Configuration File........................................................................................................... 28
5.2 Client Configuration File ............................................................................................................ 28
5.3 Configuration File Format.......................................................................................................... 28
6 Description of Parameters ................................................................................................................ 31
6.1 Notes for the Table..................................................................................................................... 31
6.2 Parameters ................................................................................................................................ 32
6.2.1 General............................................................................................................................... 33
6.2.2 Menu [File].......................................................................................................................... 33
6.2.3 Menu [View] ....................................................................................................................... 34
6.2.4 Menu [Help]........................................................................................................................ 36
6.2.5 View controls...................................................................................................................... 37
6.2.6 View controls [Style]........................................................................................................... 42
6.2.7 View controls [Others]........................................................................................................ 43
6.2.8 Option setup....................................................................................................................... 45
6.2.9 Option setup [Others]......................................................................................................... 48
6.2.10 Customization .................................................................................................................. 48
6.2.11 Animation.......................................................................................................................... 50
6.2.12 Event play......................................................................................................................... 51
6.2.13 Cross-sections ................................................................................................................. 52
6.2.14 Visualization of shape comparison.................................................................................. 52
6.2.15 Others............................................................................................................................... 53

2
XVL Player / XVL Player Pro Start-Up Options Manual

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.

3
XVL Player / XVL Player Pro Start-Up Options Manual

1 Introduction

This manual describes XVL Player / XVL Player Pro start-up options (properties) and configuration
files.
In this manual, XVL Player / XVL Player Pro is generally called “XVL Player.”

2 Start-up Options

Start-up options are parameters that determine the behavior of XVL Player when it is started.

2.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 Property Specifies XVL Player properties directly via API or the Properties
specification dialog of the XVL Player View Control Object.
Server Specifies XVL Player properties using the OPT_DEF_FILE option or a
configuration server configuration file.
file For more information, refer to “5.3 Configuration File Format.”
Client Specifies XVL Player properties using <Install
configuration directory>\Env\Default.csv or a client configuration file.
file For more information, refer to “5.3 Configuration File Format.”
Application Specifies XVL Player properties with user-specified application
setting settings..
Low Application settings are saved in the registry.

Display settings follow the following rules:

Specification method Operations


Property specification XVL Player properties that are directly specified are always given
priority over display attributes in XVL files.
Server configuration file Only configuration file properties that are marked “mandatory” are
given priority over display attributes in XVL files.
XVL file display attributes have priority over configuration file properties
that are not marked “mandatory.”
Client configuration file Only configuration file properties that are marked “mandatory” are
given priority over display attributes in XVL files.
XVL file display attributes have priority over configuration file properties
that are not marked “mandatory.”
Application setting XVL file display attributes always have priority over application settings.

4
XVL Player / XVL Player Pro Start-Up Options Manual

2.2 Usage

The following diagrams show the usage of start-up options for each container supported by XVL
Player. For details of the priority order of specification methods, refer to “2.1 Priority.”

Internet Explorer

MS Office

Visual Basic Application

5
XVL Player / XVL Player Pro Start-Up Options Manual

3 XVL Player Insertion

The following sections describe the procedures for inserting XVL Player into each container.

3.1 HTML

In order to embed XVL Player inside HTML, use the OBJECT tag. Inside the OBJECT tag,
start-up options can be specified by using the PARAM tag. The following example shows the
use of the OBJECT tag with the PARAM tags:

 When only Internet Explorer is the target:

<object classid="CLSID:A7307292-9343-4de6-80F9-2DCEBAA7CF9C"
id="xvlplayer" width="100%" height="100%">
<param name="src" value="ToyTractor.xv2">
<param name="Options" value=" VIEW_ACCELERATE(TRUE)">
<param name="Mode" value="MODE_BEHAVIOR(0), MODE_VIEW_OP(0)">
<param name="Displays" value=" VIEW_DISPLAY_TYPE(3)">
</object>

Note:
If the OBJECT tag is written directly in HTML, Internet Explorer inactivates XVL Player, and
the user has to click on XVL Player to activate it. This is the general behavior of Internet
Explorer for ActiveX controls. For more details, please refer to the Microsoft website.

 When both Internet Explorer and Mozilla Firefox are targets:

<object type="application/x-xvlplayer" id="xvlplayer" width="100%" height="100%">


<param name="src" value="ToyTractor.xv2">
<param name="Options" value=" VIEW_ACCELERATE(TRUE)">
<param name="Mode" value="MODE_BEHAVIOR(0), MODE_VIEW_OP(0)">
<param name="Displays" value=" VIEW_DISPLAY_TYPE(3)">
</object>

Note
If both XVL Player Ver. 8.6 or earlier and Ver. 12.0 or later are installed, the code above may
cause XVL files to be opened in XVL Player Ver. 8.6.

 When both Internet Explorer and Mozilla Firefox are targets and XVL Player Ver. 8.6 or earlier
is not installed:

6
XVL Player / XVL Player Pro Start-Up Options Manual

<object classid="CLSID:A7307292-9343-4de6-80F9-2DCEBAA7CF9C"
id="xvlplayer" width="100%" height="100%">
<param name="src" value="ToyTractor.xv2">
<param name="Options" value=" VIEW_ACCELERATE(TRUE)">
<param name="Mode" value="MODE_BEHAVIOR(0), MODE_VIEW_OP(0)">
<param name="Displays" value=" VIEW_DISPLAY_TYPE(3)">
<object type="application/x-xvlplayer" id="xvlplayer" width="100%" height="100%">
<param name="src" value="ToyTractor.xv2">
<param name="Options" value=" VIEW_ACCELERATE(TRUE)">
<param name="Mode" value="MODE_BEHAVIOR(0), MODE_VIEW_OP(0)">
<param name="Displays" value=" VIEW_DISPLAY_TYPE(3)">
</object>
</object>

Note
With this specification method, both Internet Explorer and Mozilla Firefox are set as targets at
the same time, and XVL Player Ver. 8.6 or earlier is not launched. The item of the classid
attribute specified for the OBJECT tag gives the startup options for Internet Explorer. The
item of the type attribute specified for the OBJECT tag gives those for Mozilla Firefox.

If HTML files written with the specification method described above are opened using Internet
Explorer Ver. 6.0, XVL Player will not be launched.

The following start-up properties are available:

Property Description
src The target XVL file to be loaded.
It can be specified by absolute path, relative path, or URL.
Files XVL file imported at start-up
It can be specified by absolute path, relative path or URL. Multiple files can be
specified by separating them with “;”(semicolon). If loading the XVL file
specified by the src property fails, they will not be read.
Options General options
Mode Operation options
Displays Display options
The parameters specified in this property are prioritized over the display settings
embedded inside the XVL file.
OnHandler Specifies the JavaScript function to catch HANDLER_EVENT events that XVL
Player issues in Mozilla Firefox.
OnStatus Specifies the JavaScript function to catch STATUS_EVENT events that XVL
Player issues in Mozilla Firefox.
OnAnimation Specifies the JavaScript function to catch ANIMATION_EVENT events that XVL
Player issues in Mozilla Firefox.
OnAction Specifies the JavaScript function to catch ACTION_EVENT events that XVL
Player issues in Mozilla Firefox.
OnError Specifies the JavaScript function called when an error occurs upon API calling
provided by XVL Player SDK in Mozilla Firefox.

Note
For details of events issued by XVL Player, refer to the XVL Player SDK Reference Manual

7
XVL Player / XVL Player Pro Start-Up Options Manual

and Tutorial. XVL Player SDK is sold separately.

In order to specify parameters for the Options, Mode, and Displays properties, a parameter name
must be followed by its value such as “Parameter(value).” Multiple parameters can be specified
separated by “,” (comma).

<param name="Displays" value =" VIEW_DISPLAY_TYPE(3), VIEW_SHOW_POINT(TRUE)">


(1) (2) (3) (4) (5)

(1) Property
(2), (4) Parameter ID
(3), (5) Values for parameter ID

In the above example, the initial display type (VIEW_DISPLAY_TYPE) and the vertex display
setting (VIEW_SHOW_POINT) of the loaded XVL file are ignored,. Hidden line display (3) is
chosen by the VIEW_DISPLAY_TYPE parameter, and the vertex display is set to “TRUE” in the
VIEW_SHOW_POINT parameter.

For details on parameter IDs for the Options, Mode, and Displays properties, refer to the “ID”
section in “6.2 Parameters.” The format of the values specified for parameter IDs are the same
for configuration files. For details, refer to the “Description” section in ”6.2 Parameters.”

The possible types of the parameter ID are “Logical value,” “Integer value,” “Real number value”
and “String value.”

Type of value Description


Logical value Specifies a logical value by TRUE or FALSE. This value is not case-sensitive.
(Logical)
Integer value Specifies an integer. To specify the value in hexadecimal, the first character
(Integer) must be ‘x’ or ‘X’. The RGB color information can be also specified by integers.
The 3 byte integers can express red, green, and blue colors from the upper byte.
Real number Specifies a real value.
value
(Real)
String value Specifies a string. A string in a cell must be specified in the CSV file format.
(String) For example, if a string includes a comma, the cell in the file must be enclosed by
double quotation marks. ’\’ is an escape character and is interpreted differently
according to the letter after ‘\’ as follows:
\\: As single letter ‘\’
\n: As Line feed character
\(: As single letter ‘(’
\): As single letter ‘)’
Strings starting with ‘\’ other than the above are interpreted as they are. Please
note that some parameters may not interpret the line feed characters correctly.

3.2 Microsoft Office 2000-2003

8
XVL Player / XVL Player Pro Start-Up Options Manual

Using Microsoft PowerPoint as an example, the following describes how to insert XVL Player into
a Microsoft Office 2000-2003 document and to specify start-up options.

1. Select the following from the Microsoft PowerPoint menu.


View -> Toolbars -> Control Toolbox

2. Select the following from the Control Toolbar.


Control Toolbox toolbar -> More Controls -> XVL Player View Control

9
XVL Player / XVL Player Pro Start-Up Options Manual

3. On a slide, specify the area to insert XVL Player.

4. In order to display the Properties dialog of XVL Player, right-click and select
XVL Player View Control Object -> Properties…

10
XVL Player / XVL Player Pro Start-Up Options Manual

5. In the Properties dialog, set the start-up options of the XVL file.

When you are in Microsoft Office design mode, selecting Properties from the right-click menu of
the ActiveX Control causes the following Properties window to appear.

11
XVL Player / XVL Player Pro Start-Up Options Manual

The Properties dialog can also be displayed from the .. button in the (Custom) field of the
Properties window.

Limitations
Specifying the start-up options of XVL Player inside the Properties window may not work
correctly.

In Visual Basic, start-up options can be specified in a similar manner as Microsoft Office. For
details, refer to the XVL Player SDK Tutorial.

3.3 Microsoft Office 2007

Using Microsoft PowerPoint as an example, the following describes how to insert XVL Player into
a Microsoft Office 2007 document and to specify start-up options.

1. Click Office button on Microsoft PowerPoint and execute PowerPoint Options.

12
XVL Player / XVL Player Pro Start-Up Options Manual

2. Check the following item on PowerPoint Options dialog box.


Popular >> Show [Developer] tab in the Ribbon

13
XVL Player / XVL Player Pro Start-Up Options Manual

3. Execute the following items on Microsoft PowerPoint.


Developer tab >> Controls group >> More Controls

4. Select XVL Player View Control on More Controls dialog box and execute "OK.”

5. Same as steps 3 to 5 in "3.2 Microsoft Office 2000-2003.”

14
XVL Player / XVL Player Pro Start-Up Options Manual

3.4 Microsoft Office 2010

Using Microsoft PowerPoint as an example, the following describes how to insert XVL Player into
a Microsoft Office 2010 document and to specify start-up options.

1. Click File tab on Microsoft PowerPoint and execute Options.

2. Check the following item on PowerPoint Options dialog box.


Customize Ribbon >> Customize the Ribbon >> [Developer]

15
XVL Player / XVL Player Pro Start-Up Options Manual

3. Execute the following items on Microsoft PowerPoint.


Developer tab >> Controls group >> More Controls

16
XVL Player / XVL Player Pro Start-Up Options Manual

4. Select XVL Player View Control on More Controls dialog box and execute "OK.”

5. Same as steps 3 to 5 in "3.2 Microsoft Office 2000-2003.”

The method for specifying the option at the startup on Visual Basic is same as the specification
method on Microsoft Office. For details, please refer to the tutorial of XVL Player SDK.
XVL Player SDK is a separately available product, so please purchase it separately.

4 Properties

The OK and Apply buttons in the Properties dialog don’t change behaviors or display settings of
XVL Player when they are clicked; these buttons only change the parameter values for the
start-up of XVL Player.

The following table explains when the parameter values specified in the Properties dialog are
applied for each container.

Container When
Microsoft Office  Switches from the Design Mode to the User Mode
 Reads from saved document
Visual Basic  Starts application with the debug mode
 Starts built application

17
XVL Player / XVL Player Pro Start-Up Options Manual

When checkboxes precede parameters, XVL Player behaves according to the following table.

Type Status Description


ON / OFF ON The parameter is enabled as a start-up option. Associated
parameters are also enabled.
OFF The parameter is disabled for a start-up option.
3 State ON The parameter is enabled as a start-up option.
OFF The parameter is disabled for a start-up option.
Inactive The parameter is not a start-up option.

Limitation:
Switching tabs in the Properties dialog will apply the parameter changes even before the OK
or Apply button is clicked.

Limitation:
In a Microsoft Office document, if a parameter is disabled for a start-up option, this change
may not be reflected when the application is changed from the Design Mode to the User
Mode. In such a case, the parameter change is reflected after the document is saved and
reloaded.

Limitation:
If Properties is displayed on Microsoft Office, activating other applications closes the
Properties dialog.
This limitation is a general behavior of an ActiveX Control.

18
XVL Player / XVL Player Pro Start-Up Options Manual

4.1 General

Item Description Start-up option


XVL File Specifies the XVL file path at start-up. Cannot specify src
on Visual Basic.

Clicking the … button displays the file dialog, allowing


XVL files to be specified. This button cannot be used
when the Microsoft Office document is a new
document.
Setting File Specifies the server side configuration file. Cannot OPT_DEF_FILE
specify in Visual Basic.

Clicking the … button displays the file dialog, allowing


server side configuration files to be specified. This
button cannot be used when the Microsoft Office
document is a new document.

19
XVL Player / XVL Player Pro Start-Up Options Manual

Item Description Start-up option


Menu File Specifies the menu file on the server side. This OPT_MENU_FILE
cannot be specified in Visual Basic.

Clicking the […] button opens the file dialog box to


enable specification of the menu file on the server side.
This button is disabled when a new Microsoft Office
document has not been saved.

For details of the menu file, refer to the Menu File


Manual.
Behavior Specifies the behavior mode. MODE_BEHAVIOR
View Operation Specifies the view operation mode. MODE_VIEW_OP
Mode
View direction Specifies the view direction of the initial viewpoint. VIEW_DIRECTION_
TYPE
Apply active If the current XVL file contains an active camera, check VIEW_INIT_ACTIVE_
camera this box to apply the camera to the initial viewpoint. CAMERA
Fit Check this box to fit objects in a view area in the VIEW_INIT_FIT
specified view direction upon initial viewpoint setup.

4.2 Graphics

20
XVL Player / XVL Player Pro Start-Up Options Manual

Item Description Start-up option


Use Graphics Specifies whether or not to use VIEW_ACCERATE
Accelerator the graphics accelerator.
Use vertex buffer Specifies whether to use a vertex VIEW_VERTEX_BUFFER_OBJECT
object buffer object.
Enable navigation Specifies whether to perform SELECTION_NAVIGATE
when selecting navigation for element selection.
elements
Show bounding box Specifies whether to show a SELECTION_BOX
when a part is bounding box when a part or SELECTION_BOX_FRONT
selected body is selected. Checking the
[Show the bounding box in front]
box shows the bounding box in
front of other elements.
Highlight color Specifies selection color/instance VIEW_SELECTION1_COLOR
color. Enter a value for [Highlight VIEW_SELECTION2_COLOR
Ratio] to specify the highlight ratio. VIEW_SELECTION_COLOR_
WEIGHT

21
XVL Player / XVL Player Pro Start-Up Options Manual

4.3 Custom

Item Description Start-up option


View Emulation Specifies the viewing operation UI_VIEWING_MODE
Mode compatibility.
Enable collision Specifies whether to stop when UI_VIEWING_STOP_COLLIDE
detection running into an object in walk/fly mode.
Link Processing Specifies the link display method. UI_LINK_PICK_MODE
Change mouse Specifies whether or not to change the UI_CHECK_PICK
cursor to indicate mouse cursor when elements can be
selectable elements picked.

22
XVL Player / XVL Player Pro Start-Up Options Manual

4.4 Display Element

Item Description Start-up option


Display Set display type and vertex display ONVIEW_DISPLAY_TYPE
/ OFF. VIEW_SHOW_POINT
Display Element Set display element ON/OFF. VIEW_SHOW_ISO_PT
VIEW_SHOW_ISO_CV
VIEW_SHOW_INFINITE_LINE
VIEW_SHOW_INFINITE_PLANE
VIEW_SHOW_COMMENT
VIEW_SHOW_DIMENSION
VIEW_SHOW_AXIS_USER
VIEW_SHOW_TRACE_LINE
Grid Specifies the grid display method. VIEW_GRID_TYPE
Display accuracy Specifies display accuracy when not VIEW_QUALITY_TYPE
(Unused LOD) using LOD.
Use LOD Specifies whether to execute LOD. VIEW_QUALITY_LOD
Display accuracy Specifies display accuracy when using VIEW_QUALITY_LOD_TYPE
(Used LOD ) LOD.

23
XVL Player / XVL Player Pro Start-Up Options Manual

4.5 Display Options

Item Description Start-up option


Coordinate System Specifies the base coordinate VIEW_COORDINATE_TYPE
system for the view.
Projection Method Specifies the projection type. VIEW_PROJECTION_TYPE
Material Priority Specifies priority of the material. VIEW_MATERIAL_PRIORITY
Display view with its Specifies whether to lock the upper VIEW_EXAM_FIX_UP
upper direction fixed direction during 3D view rotation.
Background Specifies the background color. VIEW_BACKGROUND_COLOR
Graded background Specifies whether to show the VIEW_BG_GRADATION
background in gradation.
Lower background Specifies the background color 2. VIEW_BG2_COLOR
This is only valid when Graded
background is ON.
Hidden Line Specifies the color of hidden lines. VIEW_HIDDENLINE_COLOR
Note/Dimension Specifies the color of notes and VIEW_CM_DM_COLOR
dimensions.

24
XVL Player / XVL Player Pro Start-Up Options Manual

4.6 Event

Item Description Start-up option


Event Specifies event conditions issued. EVENT_UI
For details, refer to XVL Player SDK Reference
Manual.
Always issue Specifies whether to always issue an action as an EVENT_ALWAYS
events event.

Clicking [Set] specifies the actions issued. The


specified actions are listed below [Set].

For details, refer to XVL Player SDK Reference


Manual.
Issue in edit Specifies whether to issue the specified action in EVENT_ALWAYS_EDIT
mode event mode. This is enabled only when [Always
issue events] is checked.

25
XVL Player / XVL Player Pro Start-Up Options Manual

Item Description Start-up option


Do the Specifies the performance when a body-pick or EVENT_PART_PICK_SEL
following when part-pick event is issued.
a body is For details, refer to XVL Player SDK Reference
clicked Manual.

4.7 Others

Item Description Start-up option


Import display Specifies whether to import display FILE_READ_VIEW_DATA
options settings of XVL files
Axis File Specifies an XVL file of coordinate VIEW_AXIS_FILE
axes. This file cannot be specified
in Visual Basic.

Clicking the […] button opens the


File dialog box to enable specification
of the XVL geometry file of
coordinate axes. When a new
Microsoft Office document is open,
this button is disabled.

26
XVL Player / XVL Player Pro Start-Up Options Manual

Item Description Start-up option


Background Specifies a background image file. VIEW_BG_IMG_FILE
image This file cannot be specified in Visual
Basic.

Clicking […] opens the file dialog box


for specifying a picture file for the
background image. When a new
Microsoft Office document is open,
this button is disabled.
GUI Specifies the display of menu / SHOW_UI
toolbar

27
XVL Player / XVL Player Pro Start-Up Options Manual

5 Configuration Files

5.1 Server Configuration File

Specify with Options property OPT_DEF_FILE. The following description is used for HTML
specification.

<param name = "Options " value = OPT_DEF_FILE(“Default.csv”)>

Specify server settings with “Setting file” in the figure in “4.1 General” for Microsoft Office
applications.

5.2 Client Configuration File

The client configuration file is created as “Default.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 configuration file referenced will be “C:\Program
Files\Lattice\Player3\Env\Default.csv.”

5.3 Configuration File Format

The configuration file is in CSV file format. A single line corresponds to a single parameter, and
each line consists of the following cells.

Parameter ID, Change flag, Default value

The table below describes each cell. Note that lines that begin with ‘#’ are comment lines and are
ignored.

Cell Description
Parameter ID A string that uniquely identifies the parameter. For details of the specifiable
parameters, see “6.2 Parameters.”
Change flag Specifies how to handle the default parameter by using the logical sum of the
following values:

0 (or none): The setting stored in the registry at start-up has the first priority.
If there is no registry setting, the setting in the configuration file is applied.

1: Always uses the setting in the configuration file at start-up.

2: Locks the parameter change in GUI (prevents making changes).

4: Specified settings override XVL file display attributes.

28
XVL Player / XVL Player Pro Start-Up Options Manual

Cell Description
Default value Default value for the parameter

The following shows the available values for the change flag and the effect of each flag.

Value Description
0 The setting stored in the registry at start-up has the first priority. If there is no registry
setting, the setting in the configuration file is applied. Parameter controls in the GUI are
enabled (changes are allowed).
1 Always uses the setting in the configuration file at start-up. Parameter controls in the
GUI are enabled (changes are allowed).
2 The setting stored in the registry at start-up has the first priority. If there is no registry
setting, the setting in the configuration file is applied. Parameter controls in the GUI are
disabled (changes are prevented).
3 Always uses the setting in the configuration file at start-up. Parameter controls in the
GUI are disabled (changes are prevented).
4 The setting stored in the registry at start-up has the first priority. If there is no registry
setting, the setting in the configuration file is applied. Specified settings override XVL file
display attributes. Parameter controls in the GUI are enabled (changes are allowed).
5 Always uses the setting in the configuration file at start-up. Specified settings override
XVL file display attributes. Parameter controls in the GUI are enabled (changes are
allowed).
6 The setting stored in the registry at start-up has the first priority. If there is no registry
setting, the setting in the configuration file is applied. Specified settings override XVL file
display attributes. Parameter controls in the GUI are disabled (changes are prevented).
7 Always uses the setting in the configuration file at start-up. Specified settings override
XVL file display attributes. Parameter controls in the GUI are disabled (changes are
prevented).

Default value for the parameter is classified into the following depending on the type; logical value,
integer value, real number value, and string value.

Type of value Description


Logical value Specifies a logical value by TRUE or FALSE. This value is not
(Logical) case-sensitive.
Integer value Specifies an integer. If the first character is ‘x’ or ‘X’, the value is considered
(Integer) as hexadecimal. The RGB color information can be also specified by
integers. The 3-byte integers can express red, green, and blue colors from
the upper byte.
Real number value Specifies a real value.
(Real)
String value Specifies a string. A string in a cell must be specified in the CSV file format.
(String) For example, if a string includes a comma, the cell in the file must be
enclosed by double quotation marks. ’\’ is an escape character and is
interpreted differently according to the letter after ‘\’ as follows:
\\: As single letter ‘\’
\n: As Line feed character
\(: As single letter ‘(’
\): As single letter ‘)’
Strings starting with ‘\’ other than the above are interpreted as they are.
Please note that some parameters may not interpret the line feed
characters correctly.

29
XVL Player / XVL Player Pro Start-Up Options Manual

Coding example:
#Sample,,
VIEW_BACKGROUND_COLOR,7,xFFFFFF
VIEW_DISPLAY_TYPE,0,2

The 1st line


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

The 2nd line


Specifies the color whose RGB constituents are expressed by the hexadecimal values,
FF, FF, and FF (which indicate white), as the default value for
BACK_GROUND_COLOR. Because the change flag is “7,” this value will always be
applied at start-up. It is not possible to change parameters in GUI.

The 3rd line


Specifies 2 as the default value for VIEW_DISPLAY_TYPE. Because the change flag
is “0,” priority will be given to details stored in the registry for this value (default display
value). If the value is not stored in the registry, the value in the configuration file (default
display type = Shaded + Wireframe) is applied.

30
XVL Player / XVL Player Pro Start-Up Options Manual

6 Description of Parameters

6.1 Notes for the Table

Inheriting a parameter:
If the “Inherit” column says unavailable (-), the parameter is set up only once at start-up and is
not inherited.

Locking a parameter:
The “Lock” column indicates whether a parameter is lockable or not. The parameters to be
locked are as follows:
1. A parameter that can be changed in GUI and affect overall behaviors of the application.
2. A parameter that can be changed in GUI and be applied to the same operations.

Mandatory parameters
The “Mandatory” column shows whether a parameter can be forced to read the value of the
configuration file by ignoring the setting embedded inside the XVL file. If parameters are set
mandatory, specified values in the configuration file are used when XVL Player reads an XVL
file while ignoring display settings embedded in the XVL file. The possible values for the
mandatory setting are “4,” “5,” “6” or “7.”

The set of following items does not operate properly if "forcible" flag is set to a different value.
Be sure to make a setting so that the flag is same in the set.

Item Description
VIEW_DISPLAY_TYPE Display type
VIEW_SHOW_ISO_PT
VIEW_SHOW_ISO_CV
VIEW_SHOW_POINT Display size of vertex
VIEW_POINT_SIZE1
VIEW_ANTIALIAS_POLY Drawing quality
VIEW_ANTIALIAS_TEXTURE
VIEW_SHOW_AXIS_USER Coordinate system
VIEW_AXIS_WORD
VIEW_AXIS_PART
VIEW_GRID_SHOW_NAME Name of coordinate axis of grid
VIEW_GRID_SHOW_NAME_WR
VIEW_GRID_MIN_X Display range of grid
VIEW_GRID_MAX_X
VIEW_GRID_MIN_Y
VIEW_GRID_MAX_Y
VIEW_GRID_MIN_Z
VIEW_GRID_MAX_Z
VIEW_CM_DM_COLOR Font
VIEW_CM_DM_FONT_NAME
VIEW_CM_DM_FONT_SIZE
VIEW_CM_DM_FONT_BOLD
VIEW_CM_DM_FONT_ITALIC

31
XVL Player / XVL Player Pro Start-Up Options Manual

Specification of parameters
The “Specification” column shows the following:
- If the parameter can be specified by a property, “Options,” “Mode” or “Displays” is
available.
- If the server configuration file can be used to set the parameter, “Server” is available.
- If the client configuration file can be used to set the parameter, ”Client” is available.

6.2 Parameters

The following subsections list and describe the parameters that can be specified in the
configuration file.

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 10.0+, it indicates that the corresponding item has
been added in Ver. 10.0.

32
XVL Player / XVL Player Pro Start-Up Options Manual

6.2.1 General

Change ID Type Inherit Lock Mandatory Specification Description


OPT_DEF_FILE String - - N Options Specify the server configuration file path.
11.0a+ OPT_MENU_FILE String - - N Options Specifies the path for the menu file on the server side.
For details of the menu file, refer to the Menu File
Manual.
OPT_API_LIC_FILE String - - N Options Specify the license file path that authorizes the use of
API in XVL Player SDK-based HTML contents.
OPT_API_LIC_DATA String - - N Options Specify the license string that authorizes the use of API
in XVL Player SDK-based HTML contents.
MODE_VIEW_OP Integer Y N N Mode /Server Specifies the view emulation mode.
/Client 0 : Examine
1 : Walk
2 : Fly
MODE_BEHAVIOR Integer Y N N Mode /Server Specifies the behavior of XVL Player.
/Client 0 : View Mode
1 : Edit Mode

6.2.2 Menu [File]

Change ID Type Inherit Lock Mandatory Specification Description


FILE_READ_VIEW_DATA Logical - - N Options Specifies whether to read view information at the time of
reading.
FILE_ATTRIBUTE_PRIORITY Integer Y Y N Server Specifies the priority about properties referenced when
/Client an assembly file is imported.
0 : Upper file
1 : Lower file
OPT_SAVE_HTTP Logical - - N Options Specifies whether to permit saving a file read via HTTP
or HTTPS server.

33
XVL Player / XVL Player Pro Start-Up Options Manual

6.2.3 Menu [View]

Change ID Type Inherit Lock Mandatory Specification Description


12.1* VIEW_DIRECTION_TYPE Integer N N N Displays / Specifies the initial view direction.
Server /
Client -1 : Existing behavior
0 : Front
1 : Back
2 : Right
3 : Left
4 : Top
5 : Bottom
6 : ISO 1
7 : ISO 2
8 : ISO 3
9 : ISO 4
11.0a+ VIEW_INIT_ACTIVE_CAMERA Logical N N N Displays / Specifies whether to apply the valid camera to the initial
Server / viewpoint.
Client
11.0a+ VIEW_INIT_FIT Logical N N N Displays / Specifies whether to fit objects in a view area in the
Server / specified initial view direction.
Client
VIEW_DISPLAY_TYPE Integer Y N Y Displays / Specifies the initial display type:
Server / 0 : Wireframe
Client 1 : Shaded
2 : Shaded + Wireframe
3 : Hidden Line
VIEW_SHOW_POINT Logical Y N Y Displays / Specifies whether to display vertices.
Server /
Client

34
XVL Player / XVL Player Pro Start-Up Options Manual

Change ID Type Inherit Lock Mandatory Specification Description


12.1* VIEW_QUALITY_LOD Logical Y N Y Displays / Specifies whether to perform LOD display.
Server
From Ver. 12.1, can no longer be specified using the
client settings file.
Unless specified by some other means, always starts with
LOD display disabled.
12.1* VIEW_QUALITY_TYPE Integer Y N Y Displays / Specifies the display accuracy of the initial view when
Server LOD is disabled:
0 : Rough
1 : Normal
2 : Fine
3 : Extra fine

From Ver. 12.1, can no longer be specified using the


client settings file.
Unless specified by some other means, always starts with
display precision set to "Normal".
VIEW_QUALITY_LOD_TYPE Integer Y N Y Displays / Specifies the display accuracy of the initial view when
Server / LOD is enabled.
Client 0 : Rough
1 : Normal
2 : Fine
3 : Extra fine
VIEW_SHOW_ISO_PT Logical Y N Y Displays / Specifies whether to display independent points.
Server /
Client
VIEW_SHOW_ISO_CV Logical Y N Y Displays / Specifies whether to display independent edges.
Server /
Client
VIEW_SHOW_INFINITE_LINE Logical Y N Y Displays / Specifies whether to display infinite lines.
Server /
Client

35
XVL Player / XVL Player Pro Start-Up Options Manual

Change ID Type Inherit Lock Mandatory Specification Description


VIEW_SHOW_INFINITE_ Logical Y N Y Displays / Specifies whether to display infinite planes.
PLANE Server /
Client
VIEW_SHOW_COMMENT Logical Y N Y Displays / Specifies whether to display notes.
Server /
Client
VIEW_SHOW_DIMENSION Logical Y N Y Displays / Specifies whether to display dimensions.
Server /
Client
VIEW_SHOW_AXIS_USER Logical Y N Y Displays / Specifies whether to display the user coordinate system.
Server /
Client
10.2a+ VIEW_SHOW_TRACE_LINE Logical Y N Y Displays / Specifies whether to display the trace lines.
Server /
Client
VIEW_GRID_TYPE Integer Y N Y Displays / Specifies the type for the initial grid view:
Server / 0 : Does not display.
Client 1 : Displays the XY plane grid.
2 : Displays the YZ plane grid.
3 : Displays the ZX plane grid.
4 : Displays only for a standard direction view.

6.2.4 Menu [Help]

Change ID Type Inherit Lock Mandatory Specification Description


SYSTEM_LICENSE_TYPE Integer Y Y N Client Specifies the license type:
0 : Uses the license server.
1 : Uses the license folder.
SYSTEM_LICENSE_SERVER String Y Y N Client Specifies the license server using the following format:
<PortNo>@<ServerName>
SYSTEM_LICENSE_BORROW Logical N Y N Client Specifies whether to accept the use of license outside.

36
XVL Player / XVL Player Pro Start-Up Options Manual

Change ID Type Inherit Lock Mandatory Specification Description


11.0a* SYSTEM_LICENSE_GRADE1 Integer Y Y N Client Specifies the highest-priority grade in which XVL Studio
starts:
0 : Auto
1 : Pro
2 : Standard
3 : Basic
4 : Installation grade
This parameter corresponds to the settings on the
License dialog box.
11.0a* SYSTEM_LICENSE_GRADE2 Integer N N N Client Specifies the 2nd-highest-priority grade in which XVL
Studio starts:
0 : None
1 : Pro
2 : Standard
3 : Basic
4 : Installation grade
11.0a* SYSTEM_LICENSE_GRADE3 Integer N N N Client Specifies the 3rd-highest-priority grade in which XVL
Studio starts. The same values as
SYSTEM_LICENSE_GRADE2 are applied.
SYSTEM_LICENSE_DISP_MENU Logical Y Y N Client Specifies whether to display consumed license name
on the menu.

6.2.5 View controls

Change ID Type Inherit Lock Mandatory Specification Description


VIEW_COORDINATE_TYPE Integer N Y Y Displays / Specifies the base coordinate system for the
Server / view:
Client 0 : CG coordinate system
1 : CAD coordinate system

37
XVL Player / XVL Player Pro Start-Up Options Manual

Change ID Type Inherit Lock Mandatory Specification Description


VIEW_PROJECTION_TYPE Integer N Y Y Displays / Specifies the projection type:
Server / 0 : Perspective projection
Client 1 : Parallel projection
VIEW_MATERIAL_PRIORITY Integer N Y Y Displays / Priority of the material:
Server / 0 : Face
Client 1 : Lower part
2 : Upper part
VIEW_EXAM_FIX_UP Logical N Y Y Displays / Specifies whether to lock the upper direction
Server / during 3D view rotation.
Client
VIEW_AXIS_WORLD Logical Y Y Y Server Specifies whether to display the world
/Client coordinate system.
VIEW_AXIS_PART Logical Y Y Y Server Specifies whether to display the part coordinate
/Client system.
VIEW_AXIS_CURRENT Logical Y Y Y Server Specifies whether to display the current
/Client coordinate system.
VIEW_AXIS_CURRENT_POSITION Integer Y Y Y Server Specifies the display position for the current
/Client coordinate axis:
0 : Lower left
1 : Lower right
2 : Upper right
3 : Upper left
VIEW_AXIS_NAME_TYPE Integer Y Y Y Server Specifies the name of the coordinate axis:
/Client 0 : XYZ format
1 : LWH format
VIEW_GRID_PITCH Integer Y Y Y Server Specifies the pitch of the grid.
/Client
VIEW_GRID_DIVNUM Integer Y Y Y Server Specifies the number of divisions for the grid.
/Client
VIEW_GRID_MIN_X Real Y Y Y Server Specifies the minimum value for the grid display
/Client range in the X-axis direction.
VIEW_GRID_MAX_X Real Y Y Y Server Specifies the maximum value for the grid
/Client display range in the X-axis direction

38
XVL Player / XVL Player Pro Start-Up Options Manual

Change ID Type Inherit Lock Mandatory Specification Description


VIEW_GRID_MIN_Y Real Y Y Y Server Specifies the minimum value for the grid display
/Client range in the Y-axis direction.
VIEW_GRID_MAX_Y Real Y Y Y Server Specifies the maximum value for the grid
/Client display range in the Y-axis direction.
VIEW_GRID_MIN_Z Real Y Y Y Server Specifies the minimum value for the grid display
/Client range in the Z-axis direction.
VIEW_GRID_MAX_Z Real Y Y Y Server Specifies the maximum value for the grid
/Client display range in the Z-axis direction.
VIEW_GRID_ADJUST Logical Y Y Y Server Specifies whether to automatically adjust the
/Client grid display range.
VIEW_GRID_SHOW_NAME Logical Y Y Y Server Specifies whether to display the grid name at
/Client the grid.
VIEW_GRID_SHOW_NAME_WR Logical Y Y Y Server Specifies whether to add the R indication to the
/Client W grid name for the grid.
VIEW_QUALITY_HIDE_SIZE Integer Y Y Y Server Specifies the maximum pixel size of the small
/Client shapes that is not displayed. Specifying 0
shows all the shapes.
VIEW_QUALITY_ROUGH Logical Y Y Y Server Specifies whether to perform rough display
/Client during view operation.
VIEW_QUALITY_ROUGH_SIZE Integer Y Y Y Server Specifies the maximum pixel size of the small
/Client shapes to which rough display is applied.
Specifying 0 shows all the shapes normally.
VIEW_QUALITY_VHIDE_SURF_SIZE Integer Y Y Y Server Specifies the maximum pixel size of the
/Client surface/solid shape that is not displayed during
view operation.
The recommended value is 16.
VIEW_QUALITY_VHIDE_WIRE_SIZE Integer Y Y Y Server Specifies the maximum pixel size of the
/Client wireframe shape that is not displayed during
view operation.
The recommended value is 256.
VIEW_QUALITY_VHIDE_ISO_PT Integer Y Y Y Server Specifies whether to draw independent points in
/Client view operations when rough display is applied.

39
XVL Player / XVL Player Pro Start-Up Options Manual

Change ID Type Inherit Lock Mandatory Specification Description


VIEW_QUALITY_VCONST_FPS Integer Y Y Y Server Specifies the drawing frame rate in view
/Client operations.
The recommended value is 30.
VIEW_QUALITY_PRIORITY Integer Y Y Y Server Specifies the priority of the view quality.
/Client 0 : Speed
1 : Quality
2 : Automatic
VIEW_ANTIALIAS_POLY Logical Y Y Y Server Specifies whether to perform anti-alias for the
/Client polygon.
VIEW_ANTIALIAS_TEXTURE Logical Y Y Y Server Specifies whether to perform anti-alias for the
/Client texture.
12.0a+ VIEW_MIPMAP_TEXTURE Logical Y Y Y Server Specifies whether to use mipmaps for texture
/Client display.
VIEW_BACKGROUND_COLOR Integer Y Y Y Displays / Specifies the background color.
Server /
Client
VIEW_BG_GRADATION Logical Y Y Y Displays / Specifies whether to show the background in
Server / gradation.
Client
VIEW_BG2_COLOR Integer Y Y Y Displays / Specifies the background color 2.
Server /
Client
VIEW_PROFILE_COLOR Integer Y Y Y Server Specifies the color of the cross-section in edit.
/Client
10.1* VIEW_HIDDENLINE_COLOR Integer Y Y Y Displays / Specifies the color of hidden lines.
Server /
Client
VIEW_FACE_COLOR Integer Y Y Y Server Specifies the color of faces.
/Client
VIEW_EDGE_COLOR Integer Y Y Y Server Specifies the color of edges.
/Client
VIEW_VERTEX_COLOR Integer Y Y Y Server Specifies the color of vertices.
/Client

40
XVL Player / XVL Player Pro Start-Up Options Manual

Change ID Type Inherit Lock Mandatory Specification Description


10.2a* VIEW_CM_DM_COLOR Integer Y Y Y Displays / Specifies the color of notes and dimensions.
Server /
Client
VIEW_CM_DM_FONT_NAME String Y Y Y Server Specifies the font name for notes and
/Client dimensions.
VIEW_CM_DM_FONT_SIZE Integer Y Y Y Server Specifies the font size for notes and
/Client dimensions.
VIEW_CM_DM_FONT_BOLD Logical Y Y Y Server Specifies whether to display notes and
/Client dimensions in bold.
VIEW_CM_DM_FONT_ITALIC Logical Y Y Y Server Specifies whether to display notes and
/Client dimensions in italic.
VIEW_CM_DM_ARROW_TYPE Integer Y Y Y Server Specifies the arrow type of notes and
/Client dimensions:
0 : 3D arrow
1 : 2D arrow
2 : Black circle
3 : No arrow
VIEW_CM_DM_ARROW_SCALE1 Real N N Y Server Specifies the ratio (0-1) of the arrowhead shape
/Client (arrow) for dimensions.
VIEW_CM_DM_ARROW_SCALE2 Real N N Y Server Specifies the ratio (0-1) of the arrowhead shape
/Client (black circle) for dimensions.
10.3a+ VIEW_CM_DM_CIRCLE_SCALE Real N N Y Server Specifies the ratio (0-1) of the leader line head
/Client shape (black circle) for dimension texts.
VIEW_BACKFACE_TYPE Integer Y Y Y Server Specifies a display type for back faces:
/Client 0 : Does not display.
1 : Same color with front
2 : Fixed color
VIEW_SHOW_TEXTURE Logical Y Y Y Server Specifies whether to display texture.
/Client
VIEW_WIRE_COLOR_TYPE Integer Y Y Y Server Specifies the color of edges:
/Client 0 : Fixed color
1 : Part color

41
XVL Player / XVL Player Pro Start-Up Options Manual

Change ID Type Inherit Lock Mandatory Specification Description


VIEW_SHOW_SHELL_ATTRIBUTE Logical Y Y Y Server Specifies whether to reflect display options of
/Client shells.
10.3a+ VIEW_SHOW_PROFILE_SHELL Logical N N N Server Specifies whether to always show display
ATTRIBUTE /Client attributes of profile line shells regardless of the
reflection of shell display settings.
VIEW_DRAW_HLINE Logical Y Y Y Server Specifies whether to show hidden lines with
/Client dotted lines.
VIEW_PROFILE_COLOR_TYPE Integer Y Y Y Server Specifies the display color of cross-sections
/Client during editing:
0 : Fixed color
1 : Part color
VIEW_SHOW_CM_DM_ANGLE Real Y Y Y Server Specifies the display angle for notes and
/Client dimensions.
VIEW_SHOW_CM_DM_FRONT Logical Y Y Y Server Specifies whether to show notes and
/Client dimensions in front of other elements.
VIEW_POINT_SIZE1 Integer N N Y Server Specifies the size of vertices.
/Client
VIEW_POINT_SIZE2 Integer Y Y Y Server Specifies the size of independent points.
/Client
VIEW_SHOW_ISO_CV_PT_FRONT Logical Y Y Y Server Specifies whether to show independent edges
/Client and points in front of other elements.

6.2.6 View controls [Style]

The indices 1 to 4 can be attached to the following parameters. For example, when VIEW_STYLE_NAME is specified, the four parameters
VIEW_STYLE_NAME1, …_NAME2, … _NAME3 and …_NAME4 are available.

Change ID Type Inherit Lock Mandatory Specification Description


VIEW_STYLE_NAME String N N N Server Specifies the name corresponding to the color
/Client sets 1 to 4.

42
XVL Player / XVL Player Pro Start-Up Options Manual

Change ID Type Inherit Lock Mandatory Specification Description


VIEW_STYLE_BACKGROUND_ Integer N N N Server Specifies the background color corresponding to
COLOR /Client the color sets 1 to 4.
VIEW_STYLE_BG_GRADATION Logical N N N Server Specifies whether to show the background in
/Client gradation concerning the color sets 1 to 4.
VIEW_STYLE_BG2_COLOR Integer N N N Server Specifies the background color 2 corresponding to
/Client the color sets 1 to 4.
VIEW_STYLE_PROFILE_COLOR Integer N N N Server Specifies the color of cross-section shown during
/Client editing, corresponding to the color sets 1 to 4.
VIEW_STYLE_HIDDENLINE_COLOR Integer N N N Server Specifies the color of hidden lines corresponding
/Client to the color sets 1 to 4.
VIEW_STYLE_FACE_COLOR Integer N N N Server Specifies the color of faces corresponding to the
/Client color sets 1 to 4.
VIEW_STYLE_EDGE_COLOR Integer N N N Server Specifies the color of edges corresponding to the
/Client color sets 1 to 4.
VIEW_STYLE_VERTEX_COLOR Integer N N N Server Specifies the color of vertices corresponding to the
/Client color sets 1 to 4.
VIEW_STYLE_CM_DM_COLOR Integer N N N Server Specifies the color of notes and dimensions
/Client corresponding to the color sets 1 to 4.

6.2.7 View controls [Others]

Change ID Type Inherit Lock Mandatory Specification Description


10.1+ VIEW_AXIS_X Integer N N N Server / Specifies the color of the X-coordinate axis.
Client
10.1+ VIEW_AXIS_Y Integer N N N Server / Specifies the color of the Y-coordinate axis.
Client
10.1+ VIEW_AXIS_Z Integer N N N Server / Specifies the color of the Z-coordinate axis.
Client
10.1+ VIEW_AXIS_SCALE Real N N N Server / Specifies the scale factor of the coordinate axis length
Client shown in the 3D space against the vertical direction of
the graphic window.

43
XVL Player / XVL Player Pro Start-Up Options Manual

Change ID Type Inherit Lock Mandatory Specification Description


11.0a+ VIEW_USER_AXIS_SCALE Real N N N Server / Specifies the size of the user coordinate axis shown in
Client the 3D space.

-1.0: as per performance in Ver. 10.3 in the world


coordinate system
0 to 1.0: ratio to the screen height
10.1+ VIEW_MANIPULATOR_SCALE Real N N N Server / Specifies the scale factor of the manipulator size
Client shown in the 3D space against the vertical direction of
the graphic window.
10.1+ VIEW_MANIPULATOR_ Integer N N N Server / Specifies the selection color of the manipulator.
SELECTION_COLOR Client
10.0+ VIEW_AXIS_FILE String N N N Displays Specifies the path for the XVL geometry file to show
the current coordinate system as a shape.
11.1+ VIEW_BG_IMG_FILE String N N N Displays Specifies the background image file path. The
allowable file formats are as follows:
- PNG
- JPEG
- BMP
- TIFF
10.3a+ VIEW_DEFAULT_LIGHT_MODE Integer N N N Server / Specifies the default light type:
Client 0 : Display settings saved in a file.
1 : Light without adjustment
2 : Light with intensity adjustment
When 1 or 2 is specified and the display settings are
saved in a file, the light settings are also saved in the
file.
12.0a+ VIEW_OBJECT_DRAW_ORDER Logical N N N Server / Specifies whether to draw shapes in the same order
Client as that of the assembly tree.
12.0a+ VIEW_LINE_LUMINANCE_LIMIT Real N N N Server / Specifies the reference value for adjusting the colors
Client of letters and lines when the background color is close
to black or white. Specify a non-negative number
smaller than 0.5. Specify 0.0 to set color adjustment
when the background is pure black or white.

44
XVL Player / XVL Player Pro Start-Up Options Manual

6.2.8 Option setup

Change ID Type Inherit Lock Mandatory Specification Description


10.0+ VIEW_CAPTURE_SIZE Logical Y Y N Server Specifies whether to copy the screen image with
/Client the specified size.
10.0+ VIEW_CAPTURE_TYPE Integer Y Y N Server Specifies how to set the size upon screen copy:
/Client 0 : Pixel
1 : mm
10.0+ VIEW_CAPTURE_WIDTH Real Y Y N Server Specifies the width for screen copy. The unit is set
/Client to either pixels or millimeters, and is specified with
VIEW_CAPTURE_TYPE.
10.0+ VIEW_CAPTURE_HEIGHT Real Y Y N Server Specifies the height for screen copy. The unit is
/Client set to either pixels or millimeters, and is specified
with VIEW_CAPTURE_TYPE.
10.0+ VIEW_CAPTURE_DPI Integer Y Y N Server Specifies the resolution for screen copy (in dpi).
/Client Input a value from 72 to 1200.
10.0+ VIEW_CAPTURE_SCALE_FONT Logical Y Y N Server Specifies whether to adjust font size to the display
/Client ratio of the view when an image is copied.
MEASURE_UNIT Integer Y Y N Server Specifies the unit for measurement.
/Client 0 : mm
1 : inch
12.0a+ VIEW_RENDERING_TIME Integer N N N Server Specifies the interval between each drawing
/Client process (in milliseconds).

45
XVL Player / XVL Player Pro Start-Up Options Manual

Change ID Type Inherit Lock Mandatory Specification Description


12.1* VIEW_ACCELERATE Integer Y Y N Options / Specifies whether to use hardware acceleration.
(Logical) Server / 0 : Do not use
Client 1 : Use
2 : Auto

Although specifying an integer is recommended,


Boolean values can also be specified. If a Boolean
value is specified, it is not possible to specify that a
graphics accelerator be used automatically.
10.0+ VIEW_VERTEX_BUFFER_ Logical Y Y N Options / Specifies whether to use vertex buffer.
OBJECT Server /
Client
12.0a+ VIEW_CURVE_BUFFER_ Logical N N N Server Specifies whether to use vertex buffer objects of
OBJECT /Client edges for hardware acceleration. This is enabled
only when VIEW_VERTEX_BUFFER_OBJECT is
set to TRUE.
12.0a+ VIEW_SURFACE_INDEX_ Logical N N N Server Specifies whether to use vertex buffer objects of
BUFFER_OBJECT /Client face indices for hardware acceleration. This is
enabled only when
VIEW_VERTEX_BUFFER_OBJECT is set to
TRUE.
SELECTION_NAVIGATE Logical Y Y N Options / Specifies whether to perform navigation for
Server / selecting an element.
Client
10.1+ SELECTION_BOX Logical Y Y N Options / Specifies whether to show a bounding box when a
Server / part or body is selected.
Client
10.1+ SELECTION_BOX_FRONT Logical Y Y N Options / Specifies whether to show the bounding box in front
Server / of other elements when a part or body is selected.
Client
VIEW_SELECTION1_COLOR Integer Y Y N Options / Specifies the color to highlight selected elements.
Server /
Client

46
XVL Player / XVL Player Pro Start-Up Options Manual

Change ID Type Inherit Lock Mandatory Specification Description


VIEW_SELECTION2_COLOR Integer Y Y N Options / Specifies the color to highlight instances.
Server /
Client
10.1+ VIEW_SELECTION_COLOR_ Integer Y Y N Options / Specifies the highlight ratio of the selection color.
WEIGHT Server /
Client
10.0+ FILE_XVL_VERSION Integer Y Y N Server Specifies one of the following V-XVL versions
/Client applied when P-XVL is output to a V-XVL file and
when a new V-XVL file is created.
9 10
10.0+ FILE_XVL_PRIORITY Integer Y Y N Server Specifies how to convert P-XVL data to V-XVL Ver.
/Client 10:
0 : Priority is given to drawing speed.
1 : Priority is given to file size.
10.3a+ FILE_EXT_MODE Integer Y Y N Server Specifies the data mode of cameras, layouts,
/Client snapshots and process resources:
0 : Normal
1 : Optimized
FILE_NEW_TYPE Integer Y Y N Server Specifies the type of the new model:
/Client 0 : P-XVL
1 : V-XVL
UI_VIEWING_MODE Integer Y Y N Mode Specifies the viewing operation compatibility:
/Server 0 : XVL Classic
/Client 1 : CATIA V5
2 : Pro/ENGINEER
10.2b* HTTP_TIMEOUT Integer Y Y N Options / Number of seconds to time-out in HTTP reading.
Server / Specify between 1 and 600.
Client
UI_VIEWING_STOP_COLLIDE Logical Y Y N Mode Specifies whether to stop in walk/fly through.
/Server
/Client

47
XVL Player / XVL Player Pro Start-Up Options Manual

Change ID Type Inherit Lock Mandatory Specification Description


UI_PICK_LINK_MODE Integer Y Y N Mode Display of links
/Server 0 : Ignore
/Client 1 : Show in current window
2 : Show in new window
UI_CHECK_PICK Logical Y Y N Mode Specifies whether to change mouse cursor when
/Server elements can be picked in view mode.
/Client

* It is recommended to specify VIEW_CAPTURE_TYPE, VIEW_CAPTURE_WIDTH, VIEW_CAPTURE_HEIGHT and VIEW_CAPTURE_DPI together.

6.2.9 Option setup [Others]

Change ID Type Inherit Lock Mandatory Specification Description


10.0+ UI_PICK_LINK_EDIT Logical Y Y N Mode /Server /Client Specifies whether to show link destinations in edit mode.

6.2.10 Customization

Change ID Type Inherit Lock Mandatory Specification Description


UI_KEY_PAN String N N N Client Specifies the shortcut key for the pan control.
UI_KEY_EXAM String N N N Client Specifies the shortcut key for the rotation control.
UI_KEY_ZOOM String N N N Client Specifies the shortcut key for the zoom control.
UI_KEY_AREA String N N N Client Specifies the shortcut key for specifying a view area.
UI_KEY_SELECT_ASSY String N N N Client Specifies the shortcut key corresponding to assembly
selection.
UI_KEY_SELECT_PART String N N N Client Specifies the shortcut key corresponding to part selection.
UI_KEY_SELECT_BODY String N N N Client Specifies the shortcut key corresponding to body selection.
UI_KEY_SELECT_ELEM String N N N Client Specifies the shortcut key corresponding to element
election.

48
XVL Player / XVL Player Pro Start-Up Options Manual

Change ID Type Inherit Lock Mandatory Specification Description


UI_RATIO_PAN Real N N N Client Specifies the ratio of pan to the amount of mouse
movement (0.1 – 10.0).
UI_RATIO_EXAM Real N N N Client Specifies the ratio of rotation to the amount of mouse
movement (0.1 – 10.0).
UI_RATIO_ZOOM Real N N N Client Specifies the ratio of zoom to the amount of mouse
movement and wheel rotation (0.1 – 10.0).
UI_RATIO_TRANSLATE Real N N N Client Specifies the ratio of translation to the amount of mouse
movement in the walk-through and fly-through mode.
UI_RATIO_WALK Real N N N Client Specifies the ratio of walk to the amount of mouse
movement in the walk-through and fly-through mode.
UI_RATIO_LOOK Real N N N Client Specifies the ratio of look-around to the amount of mouse
movement in the walk-through and fly-through mode.
UI_DRAG_ZOOM_TYPE Integer N N N Client Specifies the dragging direction for zooming in:
0 : Lower position -> Up
1 : Upper position -> Down
2 : Right -> Left
3 : Left -> Right
4 : Auto
If Auto is specified, the direction is set to adapt the screen
control mode specified at UI_VIEWING_MODE.
UI_WHEEL_ZOOM_TYPE Integer N N N Client Specifies the wheel rotation direction for zooming:
0 : Forward direction
1 : Reverse direction
2 : Auto
If Auto is specified, the direction is set to adapt the screen
control mode specified at UI_VIEWING_MODE.
UI_WALK_INTERVAL Real N N N Client Specifies the interval for updating the view at walk in the
walk-through and fly-through mode (in milliseconds).

49
XVL Player / XVL Player Pro Start-Up Options Manual

Change ID Type Inherit Lock Mandatory Specification Description


UI_VIEW_SELECT_CTRL Logical N N N Client Specifies whether to use the XOR mode when the Ctrl key
is pressed in the view to select an element:
TRUE: If the key is not pressed, the new select mode is
specified. If the key is pressed, the XOR select mode is
specified.
FALSE: If the key is not pressed, the XOR select mode is
specified. If the key is pressed, the new select mode is
specified.
10.1+ UI_TREE_SET_ALT_NAME Logical N N N Server Specifies whether to show the property value for the branch
/Client name of the assembly tree.
10.1+ UI_TREE_ALT_NAME_ Logical N N N Server Specifies the format of the property value used for the
FORMAT /Client branch name of the assembly tree.

For shortcut keys and other keys, the first letter of the specified string is applied.

6.2.11 Animation

Change ID Type Inherit Lock Mandatory Specification Description


10.0+ ANIMATION_FPS Integer N N N Mode /Server Specifies an FPS value: 1, 5, 10, 20, 30 or 60.
/Client
10.0+ PROCESS_ANIM_PLAY_SCOPE Integer Y Y N Server /Client Specifies the range for playing process
animation:
0 : Entire animation
1 : Selected process only
10.0+ PROCESS_ANIM_PLAY_UNIT Integer Y Y N Server /Client Specifies the unit for playing process animation:
0 : Entire range
1 : Task
10.0a+ PROCESS_ANIM_JUMP_UNIT Integer Y Y N Server /Client Specifies the unit for moving process animation:
0 : Process
1 : Task

50
XVL Player / XVL Player Pro Start-Up Options Manual

Change ID Type Inherit Lock Mandatory Specification Description


10.0+ PROCESS_ANIM_PLAY_LOOP Logical Y Y N Server /Client Specifies whether to enable loop play of process
animation.
11.0a+ PROCESS_ANIM_ALERT_ Integer Y Y N Server /Client Specifies the interval for alert highlight display.
INTERVAL
11.0a+ PROCESS_ANIM_ALERT_ Integer Y Y N Server /Client Specifies the color of the pick target part for alert
PART_COLOR highlight display.
10.0+ PROCESS_ANIM_DISP_ Logical Y Y N Server /Client Specifies whether to show paths during process
TRAJECTORY animation play.
12.1+ PROCESS_ANIM_DISP_ALL_ Logical Y Y N Server /Client Whether or not to display all paths and alerts
TRJ_ALERT under a process.
12.1+ PROCESS_ANIM_DISP_ALL_ Logical Y Y N Server /Client Whether or not to display all paths and alerts
STOP_ONLY under a process only when the process status is
applied.

6.2.12 Event play

Change ID Type Inherit Lock Mandatory Specification Description


10.0+ EVENT_ALWAYS Integer N N N Mode Specifies whether to always issue the specified event although it
is not specified in a file. Specify the logical sum of the following
values to control events:
x00000040 : Double-clicking
x00000100 : Body pick
x00000200 : Shell pick
x00000400 : Face pick
x00010000 : Body over
x00020000 : Shell over
x00040000 : Face over
x01000000 : Body out
x02000000 : Shell out
x04000000 : Face out

51
XVL Player / XVL Player Pro Start-Up Options Manual

Change ID Type Inherit Lock Mandatory Specification Description


10.0+ EVENT_ALWAYS_EDIT Logical N N N Mode Specifies whether to issue the event specified at
EVENT_ALWAYS in edit mode.
10.1+ EVENT_PART_PICK_SEL Logical N N N Mode Controls selection when a body/part pick event is issued:
0: Does not change selection.
1: Selects the target body or part.
2: Issues a selection filtering event.

6.2.13 Cross-sections

Change ID Type Inherit Lock Mandatory Specification Description


11.1+ PROFILE_DISPLAY_TYPE Integer Y N N Server Specifies the method for showing cross-sections
/Client using the logical sum of the following values:

0 : Not specified
1 : Volume display
2 : Fill options
4 : Cross-section plane
8 : Profile line
16 : Cut solid/surface
32 : Cut independent point/edge

Specify 1 (volume display) to automatically


enable 16 or 32.

6.2.14 Visualization of shape comparison

Change ID Type Inherit Lock Mandatory Specification Description


10.1+ VISUAL_COMPARISON_COLOR1 Integer N N N Server Specifies the color of Target 1.
/Client

52
XVL Player / XVL Player Pro Start-Up Options Manual

Change ID Type Inherit Lock Mandatory Specification Description


10.1+ VISUAL_COMPARISON_COLOR2 Integer N N N Server Specifies the color of Target 2.
/Client
10.1+ VISUAL_COMPARISON_COLOR3 Integer N N N Server Specifies the color used for sections where two
/Client parts are judged to coincide.
10.1+ VISUAL_COMPARISON_VIEW_BEHAVIOR Integer N N N Server Specifies the timing for display of sections where
/Client two parts are judged to coincide:
0: No display during view operations.
1: Display during view operations.

6.2.15 Others
Change ID Type Inherit Lock Mandatory Specification Description
10.2a* EVENT_UI Integer - - - Options Notification of event changes in UI. Specify the logical sum of the
following values to control events:
1 : Selection change
2 : History operation
4 : Command change
8 : Display setting change
16 : Selection control change
64 : Operation mode change
128 : Animation operation change
SHOW_UI Integer - - - Options Display UIs in the specified mode. Can be specified using logical
sum.
1 : Right-click menu (excluding edit commands)
2 : Toolbar

53

You might also like