XVL Player Def

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 Lattice Technology Co.,Ltd. All rights reserved.
1
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................................................................................................................................8
4 Insert Assembly Tree Control...............................................................................................................13
4.1 HTML .............................................................................................................................................13
5 Properties ..............................................................................................................................................14
5.1 General ..........................................................................................................................................15
5.2 Graphics ........................................................................................................................................16
5.3 Custom ..........................................................................................................................................19
5.4 Display Element ............................................................................................................................20
5.5 Display Options .............................................................................................................................21
5.6 Event ..............................................................................................................................................22
5.7 Others ............................................................................................................................................23
6 Configuration Files ................................................................................................................................25
6.1 Server Configuration File..............................................................................................................25
6.2 Client Configuration File ...............................................................................................................25
6.3 Configuration File Format .............................................................................................................25
7 Description of Parameters....................................................................................................................28
7.1 Notes for the Table ........................................................................................................................28
7.2 Parameters ....................................................................................................................................29
7.2.1 General ..................................................................................................................................30
7.2.2 Menu [File] .............................................................................................................................31
7.2.3 Menu [View]...........................................................................................................................32
7.2.4 Menu [Help] ...........................................................................................................................34
7.2.5 View controls .........................................................................................................................36
7.2.6 View controls [Style]..............................................................................................................44
7.2.7 View controls [Others]...........................................................................................................45
7.2.8 Option setup ..........................................................................................................................47
7.2.9 Option setup [Others]............................................................................................................52
7.2.10 Customization .....................................................................................................................52
7.2.11 Animation .............................................................................................................................54
7.2.12 Event play............................................................................................................................56
7.2.13 Cross-sections ....................................................................................................................57
7.2.14 6-plane cross-section..........................................................................................................57
7.2.15 Visualization of shape comparison ....................................................................................58
7.2.16 Others ..................................................................................................................................58
2
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
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 “6.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 “6.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
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
WEB Serv er
HTML Internet
XVL Install directory
Explorer
P roperty Lattice3D Client
specification configuration file
Server Play er
configuration
file
Specify with relative URL
Refer with absolute URL Refer to install directory
MS Office
Drectory
MS
XVL MS Office file Install directory
Of f ice
P roperty Lattice3D Client

Server specification Play er configuration file
configuration
file
Specify with relative path Refer with absolute path Refer to install directory
Visual Basic Application
Visual Basic
application
Lattice3D
XVL Player Install directory
Client
Server configuration file
configuration
file
Property
specification
Via Execute method with absolute path Refer to install directory
5
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:
 In Internet Explorer:
<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.
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
OnAnimation Specifies the JavaScript function to catch ANIMATION_EVENT events that XVL
OnAction Specifies the JavaScript function to catch ACTION_EVENT events that XVL
6
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
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 “7.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 ”7.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)
7

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
Using Microsoft PowerPoint as an example, the following describes how to insert XVL Player into
a Microsoft Office 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]
8
3. Execute the following items on Microsoft PowerPoint.

Developer tab >> Controls group >> More Controls
9
4. Select XVL Player View Control on More Controls dialog box and execute "OK.”
1. On a slide, specify the area to insert XVL Player.
2. In order to display the Properties dialog of XVL Player, right-click and select
XVL Player View Control Object -> Properties…
10
3. 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
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.
XVL Player SDK is a separately available product, so please purchase it separately.
12
4 Insert Assembly Tree Control
4.1 HTML
When using an assembly tree control in HTML, it is not enough just to embed the control. Rather,
you also need to specify the link between the assembly tree control and XVL Player.
The link between the assembly tree control and XVL Player is specified by a link ID.
The link ID specifies which XVL Player the assembly tree control is linked to.
Define a link ID in XVL Player to identify it as the one to which the assembly tree control is linked.
When using an assembly tree control in HTML, specify an OBJECT tag in the same way as is
done for Latitce3D Player. Specify the link ID of the XVL Player being linked to in the UI_LINKID
Options property value of the PARAM tag of the OBJECT tag.
The following coding example (for Internet Explorer) links to the XVL Player specified by link ID
“player1”.
<object classid="CLSID:07DED67C-AA39-43A1-9132-035A1CB16B03"
id="xvlassy1" width="30%" height="30%">
<param name="Options" value="UI_LINKID(player1)">
</object>
Note:
The link does not work if no UI_LINKID is specified or if no XVL Player with the specified link
ID exists.
This section needs to be the first section a link ID in XVL Player that can be used to identify it in the
assembly tree control. Specify the link ID in the UI_LINKID Options property of the PARAM tag of
the OBJECT tag.
The following coding example (for Internet Explorer) links to an assembly tree control that has
“player1” specified as the link ID.
<object classid="CLSID:A7307292-9343-4de6-80F9-2DCEBAA7CF9C"
id="xvlplayer" width="100%" height="100%">
<param name="src" value="ToyTractor.xv2">
<param name="Options" value=" UI_LINKID(player1)">
</object>
Note:
When content contains multiple XVL Player instances, specify a unique link ID for each
instance so that the assembly tree can identify which one it is to link to.
Limitation:
Use of assembly tree controls in HTML are restricted to Internet Explorer only.
There is a one-to-one relationship between assembly tree controls and XVL Player instances.
13
The same XVL Player cannot link to multiple assembly tree controls. Similarly, if more than
one assembly tree control specifies the same XVL Player, only one of them will link to the
XVL Player.
5 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
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.
14
5.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.
15

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 the view Specifies whether to fit shapes to the view when the VIEW_INIT_FIT
active camera is applied.
5.2 Graphics
16

Rendering Mode Specifies the rendering mode. VIEW_ACCELERATE
(Display Mode
Setting)
Use vertex buffer Specifies whether to use a vertex VIEW_VERTEX_BUFFER_OBJECT
object buffer object.
17

Enable navigation Specifies whether to perform SELECTION_NAVIGATE
when selecting navigation for element selection. SELECTION_NAVIGATE_
elements The marker color, how to set MARKER_COLOR
marker colors, and the size of SELECTION_NAVIGATE_
vertex, center, and line markers MARKER_COLOR_TYPE
can also be specified. SELECTION_NAVIGATE_
VERTEX_MARKER_SIZE
SELECTION_NAVIGATE_
CENTER_MARKER_SIZE
SELECTION_NAVIGATE_
LINE_MARKER_SIZE
Show bounding box Specifies whether to show a SELECTION_BOX
when a part is bounding box when a part or body SELECTION_BOX_FRONT
selected 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
18
5.3 Custom

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.
High-resolution Specifies whether to use UI_HIGH_DPI_MODE
mode high-resolution mode.
19
5.4 Display Element

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
(LOD Off) using LOD.
Use LOD Specifies whether to execute LOD. VIEW_QUALITY_LOD
Display accuracy Specifies display accuracy when using VIEW_QUALITY_LOD_TYPE
(LOD On) LOD.
20
5.5 Display Options

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.
21
5.6 Event

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.
22

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.
5.7 Others

Import display Specifies whether to import display FILE_READ_VIEW_DATA
options settings of XVL files
Show XVL file Specifies whether to show error FILE_ERROR_DIALOG
read error messages upon XVL file reading.
messages
23

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.
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
Initial operation Specifies the mouse menus upon UI_STARTUP_OPERATION_MODE
mode activation.
Disable shortcut Disables shortcut functions applied UI_DISABLE_SHORTCUT
keys to keys or mouse buttons.
24
6 Configuration Files
6.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 “5.1 General” for Microsoft Office
applications.
6.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.”
6.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 “7.2 Parameters.”
25
Cell Description
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.
Caution
In the case of the server configuration file, the OPT_DEF_FILE_MODE
startup option needs to be set to 1 to enable this operation.
If not specified, the configuration file setting applies.
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.

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).
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).
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).
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.

Logical value Specifies a logical value by TRUE or FALSE. This value is not
(Logical) case-sensitive.
26

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.
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.
27
7 Description of Parameters
7.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
28
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.
7.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.
API license
The parameters include items that can only be used when the API license can be found.
For details of API licensing, refer to the XVL Player SDK Reference Manual.
XVL Player SDK is an independent product and must be purchased separately.
29
7.2.1 General
Control Change ID Type Inherit Lock Mandatory Specification Description

Number
P0001 OPT_DEF_FILE String - - N Options Specify the server configuration file path.
P0003 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.
P0002 14.1a+ OPT_DEF_FILE_MO Integer - - N Options Specifies how to interpret the change flag in the server
DE configuration file.
0 : Always use the value specified in the server
configuration file, regardless of the change flag
value.
However, the registry settings take priority in the
following cases
VIEW_DISPLAY_TYPE
VIEW_SHOW_ISO_PT
VIEW_SHOW_ISO_CV
1 : Use the change flag value.

P0004 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.
P0005 OPT_API_LIC_DATA String - - N Options Specify the license string that authorizes the use of API in
XVL Player SDK-based HTML contents.
P0006 MODE_VIEW_OP Integer Y N N Mode /Server Specifies the view emulation mode.
/Client 0 : Examine
1 : Walk
2 : Fly
P0007 MODE_BEHAVIOR Integer Y N N Mode /Server Specifies the behavior of XVL Player.
/Client 0 : View Mode
1 : Edit Mode
30
7.2.2 Menu [File]

Number
00002 FILE_READ_VIEW_DATA Logical - - N Options Specifies whether to read view information at the time of
reading.
P0008 13.0+ FILE_ERROR_DIALOG Logical - - N Options Specifies whether to show error messages upon XVL file
reading.
Note:
If False is specified for this parameter, a dialog box for
password input upon encrypted XVL file reading and other
boxes will be shown. An error message will also be
displayed when an open-key-encrypted XVL file is read.
00025 FILE_ATTRIBUTE_PRIORITY Integer Y Y N Server Specifies the priority about properties referenced when an
/Client assembly file is imported.
0 : Upper file
1 : Lower file
00006 12.2+ FILE_READ_WARNING_ Logical - - N Options Specifies whether to show a warning message when there
LACK_OF_CHILDREN are insufficient files.
P0009 OPT_SAVE_HTTP Logical - - N Options Specifies whether to permit saving a file read via HTTP or
HTTPS server.
31

Number
P0010 14.0+ FILE_IMPORT_XVL_ATTRIBUTE Integer - - N Options Specifies whether to use the attributes from the existing
model or from the imported file in the case when an XVA file
or XVL file is specified in the Files property.
1 : Use attributes from existing model

2 : Use attributes from imported file
3 : Both
Note:
Using attributes from the imported file is not possible in
the case of attributes with names consisting of digits
only.
7.2.3 Menu [View]

Number
00095 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
32

Number
P0011 11.0a+ VIEW_INIT_ACTIVE_CAMERA Logical N N N Displays / Specifies whether to apply the valid camera to the initial
Server / viewpoint.
Client
P0012 12.2* VIEW_INIT_FIT Logical N N N Displays / Specifies whether to fit shapes to the view when the active
Server / camera is used as the initial viewpoint.
Client
00097 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
00098 VIEW_SHOW_POINT Logical Y N Y Displays / Specifies whether to display vertices.
Server /
Client
00102 12.2* VIEW_QUALITY_LOD Logical Y N Y Displays / Specifies whether to perform LOD display.
Server
00103 12.2* 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
00122 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
00123 VIEW_SHOW_ISO_PT Logical Y N Y Displays / Specifies whether to display independent points.
Server /
Client
33

Number
00124 VIEW_SHOW_ISO_CV Logical Y N Y Displays / Specifies whether to display independent edges.
Server /
Client
00125 VIEW_SHOW_INFINITE_LINE Logical Y N Y Displays / Specifies whether to display infinite lines.
Server /
Client
00126 VIEW_SHOW_INFINITE_ Logical Y N Y Displays / Specifies whether to display infinite planes.
PLANE Server /
Client
00127 VIEW_SHOW_COMMENT Logical Y N Y Displays / Specifies whether to display notes.
Server /
Client
00128 VIEW_SHOW_DIMENSION Logical Y N Y Displays / Specifies whether to display dimensions.
Server /
Client
00129 VIEW_SHOW_AXIS_USER Logical Y N Y Displays / Specifies whether to display the user coordinate system.
Server /
Client
00130 10.2a+ VIEW_SHOW_TRACE_LINE Logical Y N Y Displays / Specifies whether to display the trace lines.
Server /
Client
00133 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.
7.2.4 Menu [Help]

Number
34

Number
00140 SYSTEM_LICENSE_TYPE Integer Y Y N Client Specifies the license type:
0 : Uses the license server.
1 : Uses the license folder.
00141 SYSTEM_LICENSE_SERVER String Y Y N Client Specifies the license server using the following format:
<PortNo>@<ServerName>
00142 14.1+ SYSTEM_LICENSE_IPV6 Logical Y Y N Client Specifies whether to use IPv6.
00143 SYSTEM_LICENSE_BORROW Logical N Y N Client Specifies whether to accept the use of license outside.
00144 15.1* 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
6 : PointCloud
This parameter corresponds to the settings on the
License dialog box.
00145 15.1* 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
6 : PointCloud
00146 15.1* 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.
P0013 SYSTEM_LICENSE_DISP_MENU Logical Y Y N Client Specifies whether to display consumed license name
on the menu.
35
7.2.5 View controls

Number
00595 13.1* VIEW_COORDINATE_TYPE Integer Y Y Y Displays / Specifies the base coordinate system for the
Server / view:
Client 0 : CG coordinate system
1 : CAD coordinate system
The display attributes in the XVL file always

apply to this item.
The setting specified here applies when data
does not include this item.
00596 13.1* VIEW_PROJECTION_TYPE Integer Y Y Y Displays / Specifies the projection type:
Server / 0 : Perspective projection
Client 1 : Parallel projection

apply to this item.
00597 13.1* VIEW_MATERIAL_PRIORITY Integer Y Y Y Displays / Priority of the material:
Server / 0 : Face
Client 1 : Lower part
2 : Upper part

apply to this item.
36

Number
00598 13.1* VIEW_EXAM_FIX_UP Logical Y Y Y Displays / Specifies whether to lock the upper direction
Server / during 3D view rotation.
Client
apply to this item.
does not include this item, or when the modify
flag is set to 5.
00599 VIEW_AXIS_WORLD Logical Y Y Y Server Specifies whether to display the world
/Client coordinate system.
00600 VIEW_AXIS_PART Logical Y Y Y Server Specifies whether to display the part coordinate
/Client system.
00601 VIEW_AXIS_CURRENT Logical Y Y Y Server Specifies whether to display the current
/Client coordinate system.
00602 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
P0014 VIEW_AXIS_NAME_TYPE Integer Y Y Y Server Specifies the name of the coordinate axis:
/Client 0 : XYZ format
1 : LWH format
00603 VIEW_GRID_PITCH Integer Y Y Y Server Specifies the pitch of the grid.
/Client
00604 VIEW_GRID_DIVNUM Integer Y Y Y Server Specifies the number of divisions for the grid.
/Client
00605 VIEW_GRID_MIN_X Real Y Y Y Server Specifies the minimum value for the grid display
/Client range in the X-axis direction.
00606 VIEW_GRID_MAX_X Real Y Y Y Server Specifies the maximum value for the grid
/Client display range in the X-axis direction
37

Number
00607 VIEW_GRID_MIN_Y Real Y Y Y Server Specifies the minimum value for the grid display
/Client range in the Y-axis direction.
00608 VIEW_GRID_MAX_Y Real Y Y Y Server Specifies the maximum value for the grid
/Client display range in the Y-axis direction.
00609 VIEW_GRID_MIN_Z Real Y Y Y Server Specifies the minimum value for the grid display
/Client range in the Z-axis direction.
00610 VIEW_GRID_MAX_Z Real Y Y Y Server Specifies the maximum value for the grid
/Client display range in the Z-axis direction.
00611 VIEW_GRID_ADJUST Logical Y Y Y Server Specifies whether to automatically adjust the
/Client grid display range.
00612 VIEW_GRID_SHOW_NAME Logical Y Y Y Server Specifies whether to display the grid name at
/Client the grid.
00613 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.
00614 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.
00615 VIEW_QUALITY_ROUGH Logical Y Y Y Server Specifies whether to perform rough display
/Client during view operation.
00616 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.
00617 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.
00618 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.
00619 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.
38

Number
00620 VIEW_QUALITY_VCONST_FPS Integer Y Y Y Server Specifies the drawing frame rate in view
/Client operations.
00621 VIEW_QUALITY_PRIORITY Integer Y Y Y Server Specifies the priority of the view quality.
/Client 0 : Speed
1 : Quality
2 : Automatic
00622 VIEW_ANTIALIAS_POLY Logical Y Y Y Server Specifies whether to perform anti-alias for the
/Client polygon.
00623 VIEW_ANTIALIAS_TEXTURE Logical Y Y Y Server Specifies whether to perform anti-alias for the
/Client texture.
00624 12.0a+ VIEW_MIPMAP_TEXTURE Logical Y Y Y Server Specifies whether to use mipmaps for texture
/Client display.
00625 14.0+ VIEW_HIGH_QUALITY_DRAW Logical Y Y N Displays / Specifies whether to perform high-quality
Server / rendering.
Client Note:
This item can only be used when the API
license can be found.
00626 14.0+ VIEW_AMBIENT_OCCLUSION Logical Y Y N Displays / Specifies whether to apply ambient occlusion.
Server /
Client
00627 14.0+ VIEW_SHADOW_MAPPING Logical Y Y N Displays / Specifies whether to shadow mapping.
Server /
Client
00628 14.0+ VIEW_SHADOW_INTENSITY Integer Y Y N Displays / Specifies the intensity of shadow.
Server /
Client
00713 17.1+ VIEW_DEFAULT_LIGHT_SUPPRESS_R Logical Y Y Y Displays / Specifies whether to suppress the reflection of
EFLECTION Server / the default light.
Client
39

Number
00629 VIEW_BACKGROUND_COLOR Integer Y Y Y Displays / Specifies the background color.
Server /
Client
00630 VIEW_BG_GRADATION Logical Y Y Y Displays / Specifies whether to show the background in
Server / gradation.
Client
00631 VIEW_BG2_COLOR Integer Y Y Y Displays / Specifies the background color 2.
Server /
Client
00635 VIEW_PROFILE_COLOR Integer Y Y Y Server Specifies the color of the cross-section in edit.
/Client
00636 10.1* VIEW_HIDDENLINE_COLOR Integer Y Y Y Displays / Specifies the color of hidden lines.
Server /
Client
00637 VIEW_FACE_COLOR Integer Y Y Y Server Specifies the color of faces.
/Client
00638 VIEW_EDGE_COLOR Integer Y Y Y Server Specifies the color of edges.
/Client
00639 VIEW_VERTEX_COLOR Integer Y Y Y Server Specifies the color of vertices.
/Client
00640 10.2a* VIEW_CM_DM_COLOR Integer Y Y Y Displays / Specifies the color of notes and dimensions.
Server /
Client
00641 VIEW_CM_DM_FONT_NAME String Y Y Y Server Specifies the font name for notes and
/Client dimensions.
00642 VIEW_CM_DM_FONT_SIZE Integer Y Y Y Server Specifies the font size for notes and dimensions.
/Client
00643 VIEW_CM_DM_FONT_BOLD Logical Y Y Y Server Specifies whether to display notes and
/Client dimensions in bold.
00644 VIEW_CM_DM_FONT_ITALIC Logical Y Y Y Server Specifies whether to display notes and
/Client dimensions in italic.
40

Number
00645 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
00646 VIEW_CM_DM_ARROW_SCALE1 Real N N Y Server Specifies the ratio (0-1) of the arrowhead shape
/Client (arrow) for dimensions.
00647 VIEW_CM_DM_ARROW_SCALE2 Real N N Y Server Specifies the ratio (0-1) of the arrowhead shape
/Client (black circle) for dimensions.
00648 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.
00649 16.0+ VIEW_CM_DM_3D_OPTIMIZE Integer N N Y Server Specifies the display method for 3D notes and
/Client 3D dimensions in view:
0: Same as earlier versions than Ver. 16.0
1: Use optimization
00651 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
00652 VIEW_SHOW_TEXTURE Logical Y Y Y Server Specifies whether to display texture.
/Client
00653 VIEW_WIRE_COLOR_TYPE Integer Y Y Y Server Specifies the color of edges:
/Client 0 : Fixed color
1 : Part color
00654 VIEW_SHOW_SHELL_ATTRIBUTE Logical Y Y Y Server Specifies whether to reflect display options of
/Client shells.
00655 10.3a+ VIEW_SHOW_PROFILE_SHELL_ATTRI Logical N N N Server Specifies whether to always show display
BUTE /Client attributes of profile line shells regardless of the
reflection of shell display settings.
00656 VIEW_DRAW_HLINE Logical Y Y Y Server Specifies whether to show hidden lines with
/Client dotted lines.
41

Number
00658 VIEW_PROFILE_COLOR_TYPE Integer Y Y Y Server Specifies the display color of cross-sections:
/Client 0 : Fixed color
1 : Part color
00659 17.1a+ VIEW_PROFILE_LINE_COLOR_TYPE Integer Y Y Y Server Specifies profile line display color:
/Client 0: Fixed color
1: Part color
00660 14.0+ VIEW_IGNORE_LUMINANCE_LIMIT Logical Y Y N Server Specifies whether to reverse note/dimension
/Client colors coinciding with black or white
backgrounds.
00661 VIEW_SHOW_CM_DM_ANGLE Real Y Y Y Server Specifies the display angle for notes and
/Client dimensions.
00662 VIEW_SHOW_CM_DM_FRONT Logical Y Y Y Server Specifies whether to show notes and
/Client dimensions in front of other elements.
00663 14.0+ VIEW_SHOW_CM_DM_LINE_FRONT Logical N N N Server Specifies whether to draw 2D note leader lines
/Client in front of 3D notes.
00671 VIEW_POINT_SIZE1 Integer N N Y Server Specifies the size of vertices.
/Client
00672 VIEW_POINT_SIZE2 Integer Y Y Y Server Specifies the size of independent points.
/Client
00673 VIEW_SHOW_ISO_CVPT_FRONT Logical Y Y Y Server Specifies whether to show independent edges
/Client and points in front of other elements.
00681 14.0+ VIEW_HLINE_EFFECT Logical Y Y Y Server Specifies availability of the setting for the hidden
/Client line.
Note:
00682 14.0+ VIEW_HLINE_TYPE Integer Y Y Y Server Specifies the type of the path for displaying
/Client hidden lines:
0: Illustration
1: Displays all the borderlines.
42

Number
00691 14.0+ VIEW_HLINE_SHOW_SHADING_IMAGE Logical Y Y Y Server Specifies the size of independent edge lines for
/Client displaying hidden lines.
Note:
02246 18.1+ VIEW_HLINE_SHOW_SHADING_FRONT Logical Y Y Y Server Specifies whether to show shells in front, for
/Client which shaded image display is specified upon
hidden line display.
Note:
00683 14.0+ VIEW_HLINE_SIZE_EDGE Integer Y Y Y Server Specifies the size of independent edge lines for
00684 14.0+ VIEW_HLINE_SIZE_SILHOUETTE Integer Y Y Y Server Specifies the size of silhouette lines for
00685 14.0+ VIEW_HLINE_SIZE_BOUND Integer Y Y Y Server Specifies the size of surface borderlines for
00686 14.0+ VIEW_HLINE_SIZE_INNER Integer Y Y Y Server Specifies the size of concave and convex edges
/Client for displaying hidden lines.
00687 14.0+ VIEW_HLINE_DEGREE_CONCAVE_MAX Real Y Y Y Server Specifies the maximum extraction angle of
/Client concave edges for displaying hidden lines.
00688 14.0+ VIEW_HLINE_DEGREE_CONVEX_MAX Real Y Y Y Server Specifies the maximum extraction angle of
/Client convex edges for displaying hidden lines.
00689 14.0+ VIEW_HLINE_WRITE_SMOOTH Logical Y Y Y Server Specifies whether to display smooth edges as
/Client rough edges for hidden line display.
00690 14.0+ VIEW_HLINE_SMOOTH_EXTRACT_VAL Real Y Y Y Server Extraction coefficient to use when identifying
/Client smooth edges as rough edges for hidden line
display.
43

Number
00692 15.0+ VIEW_HLINE_SHOW_MARKUP_COLOR Logical Y Y Y Displays / Specifies whether to enable display colors of
Server markups when hidden line display is active.
/Client
Note:
00657 15.0+ VIEW_BILLBOARD Logical Y Y Y Displays / Specifies whether to enable billboard display.
Server
/Client
7.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.

Number
P0015 VIEW_STYLE_NAME String N N N Server Specifies the name corresponding to the color
/Client sets 1 to 4.
P0016 VIEW_STYLE_BACKGROUND_ Integer Y N N Server Specifies the background color corresponding to
COLOR /Client the color sets 1 to 4.
P0017 VIEW_STYLE_BG_GRADATION Logical Y N N Server Specifies whether to show the background in
/Client gradation concerning the color sets 1 to 4.
P0018 VIEW_STYLE_BG2_COLOR Integer Y N N Server Specifies the background color 2 corresponding
/Client to the color sets 1 to 4.
P0019 VIEW_STYLE_PROFILE_COLOR Integer Y N N Server Specifies the color of cross-section shown during
/Client editing, corresponding to the color sets 1 to 4.
P0020 VIEW_STYLE_HIDDENLINE_COLOR Integer Y N N Server Specifies the color of hidden lines corresponding
/Client to the color sets 1 to 4.
44

Number
P0021 VIEW_STYLE_FACE_COLOR Integer Y N N Server Specifies the color of faces corresponding to the
/Client color sets 1 to 4.
P0022 VIEW_STYLE_EDGE_COLOR Integer Y N N Server Specifies the color of edges corresponding to the
/Client color sets 1 to 4.
P0023 VIEW_STYLE_VERTEX_COLOR Integer Y N N Server Specifies the color of vertices corresponding to
/Client the color sets 1 to 4.
P0024 VIEW_STYLE_CM_DM_COLOR Integer Y N N Server Specifies the color of notes and dimensions
/Client corresponding to the color sets 1 to 4.
7.2.7 View controls [Others]

Number
00703 10.1+ VIEW_AXIS_X Integer N N Y Server / Specifies the color of the X-coordinate axis.
Client
00704 10.1+ VIEW_AXIS_Y Integer N N Y Server / Specifies the color of the Y-coordinate axis.
Client
00705 10.1+ VIEW_AXIS_Z Integer N N Y Server / Specifies the color of the Z-coordinate axis.
Client
00706 10.1+ VIEW_AXIS_SCALE Real N N Y Server / Specifies the scale factor of the coordinate axis length
Client shown in the 3D space against the vertical direction of
the graphic window.
00709 11.0a+ VIEW_USER_AXIS_SCALE Real N N Y 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
00707 10.1+ VIEW_MANIPULATOR_SCALE Real N N Y Server / Specifies the scale factor of the manipulator size
Client shown in the 3D space against the vertical direction of
the graphic window.
45

Number
00708 10.1+ VIEW_MANIPULATOR_ Integer N N N Server / Specifies the selection color of the manipulator.
SELECTION_COLOR Client
P0025 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.
P0026 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
00712 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.
00714 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.
00715 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.
00716 17.1a+ VIEW_QUALITY_ROUGH_MANIP Logical N N N Server Specifies whether to enable rough display quality
ULATOR /Client when the manipulator is used.
00717 17.1a+ VIEW_QUALITY_ROUGH_PROFI Logical N N N Server Specifies whether to apply rough display quality to
LE_TARGET /Client cutting targets during view control and manipulator
operations in cross-section editing.
00718 17.1a+ VIEW_PROFILE_FILL_HIGHLIGH Logical N N N Server Specifies whether to highlight cap areas in addition to
T /Client parts when parts are selected during cross-section
display.
46

Number
02206 18.0+ VIEW_COMMENT_LINE_POS_MO Integer N N N Server Specifies the location of 2D note leader lines on note
DE /Client character strings:
0 : Conforms to the direction of leader lines.
1 : Lies on the center of note character strings.
7.2.8 Option setup

Number
00899 12.2+ FILE_SAVE_TEXT_FORMAT Integer Y Y N Server Specifies the character code to be used upon file
/Client saving:
0 : ANSI
1 : Unicode
00890 10.0+ VIEW_CAPTURE_SIZE Logical Y Y N Server Specifies whether to copy the screen image with the
/Client specified size.
00891 10.0+ VIEW_CAPTURE_TYPE Integer Y Y N Server Specifies how to set the size upon screen copy:
/Client 0 : Pixel
1 : mm
00892 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.
00893 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.
00894 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.
00895 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.
00897 MEASURE_UNIT Integer Y Y N Server Specifies the unit for measurement.
/Client 0 : mm
1 : inch
47

Number
00906 12.0a+ VIEW_RENDERING_TIME Integer N N N Server Specifies the interval between each drawing
/Client process (in milliseconds).
00908 12.1* VIEW_ACCELERATE Integer Y Y N Options / Specifies the rendering mode.
(Logical) Server / 0 : Software rendering
Client 1 : Hardware rendering
2 : Hardware rendering (applicable environments
only)
The following logical values can also be used:

True : Hardware rendering
False : Software rendering
00909 10.0+ VIEW_VERTEX_BUFFER_ Logical Y Y N Options / Specifies whether to use vertex buffer.
OBJECT Server /
Client
00910 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.
00912 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.
00911 12.2a+ VIEW_OPTIMIZE_ Integer N N N Server Specifies whether to optimize polygons in priority to
POLYGON_PRIMITIVE /Client drawing efficiency more than memory efficiency:
0: Do not always optimize polygons including the

case when the accelerator is Intel HD.
1: Always optimize polygons including when the
case when the accelerator is Intel HD.
2: Optimize polygons only in the case of Intel HD
as the system automatically judges accelerator.
48

Number
02210 18.0+ VIEW_VERTEX_BUFFER_OBJE Logical N N N Server Specifies whether to ignore settings for vertex buffer
CT_ /Client object usage when an Intel graphic accelerator is
IGNORE_INTEL used..
TRUE : Do not use vertex buffer object with Intel
graphics accelerator.
FALSE: In accordance with application settings.
00916 SELECTION_NAVIGATE Logical Y Y N Options / Specifies whether to perform navigation for
Server / selecting an element.
Client
00919 16.0+ SELECTION_NAVIGATE_MARKE Integer Y Y N Options / Specifies the marker color for navigation.
R_COLOR Server /
Client
00920 16.0+ SELECTION_NAVIGATE_MARKE Integer Y Y N Options / Specifies how to assign the marker color for
R_COLOR_TYPE Server / navigation.
Client 0: Inverted color
1: Fixed color
00921 16.0+ SELECTION_NAVIGATE_VERTE Integer Y Y N Options / Specifies the size of vertex markers displayed
X_MARKER_SIZE Server / during navigation.
Client 0: Small
1: Medium
2: Large
00922 16.0+ SELECTION_NAVIGATE_CENTE Integer Y Y N Options / Specifies the size of center markers displayed
R_MARKER_SIZE Server / during navigation.
Client 0: Small
1: Medium
2: Large
00923 16.0+ SELECTION_NAVIGATE_LINE_ Integer Y Y N Options / Specifies the size of line markers displayed during
MARKER_SIZE Server / navigation.
Client
00924 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
49

Number
00925 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
00926 VIEW_SELECTION1_COLOR Integer Y Y N Options / Specifies the color to highlight selected elements.
Server /
Client
00927 VIEW_SELECTION2_COLOR Integer Y Y N Options / Specifies the color to highlight instances.
Server /
Client
00928 10.1+ VIEW_SELECTION_COLOR_ Integer Y Y N Options / Specifies the highlight ratio of the selection color.
WEIGHT Server /
Client
00900 14.1* FILE_EXT_MODE Integer Y Y N Server Specifies optimization of cameras, layouts,
/Client snapshots and process resources:
0: Disable
1: Enable
2: As is
00937 FILE_NEW_TYPE Integer Y Y N Server Specifies the type of the new model:
/Client 0 : P-XVL
1 : V-XVL
00938 14.1* FILE_XVL_VERSION Integer Y Y N Server V-XVL version to use for new V-XVL．
/Client Specify one of the following.
9 10 11
00944 14.1* FILE_XVL_PRIORITY Integer Y Y N Server Specifies how to convert P-XVL data to V-XVL Ver.
/Client 10/11:
0 : Priority is given to drawing speed.
1 : Priority is given to file size.
50

Number
00957 15.1* UI_VIEWING_MODE Integer Y Y N Mode Specifies the viewing operation compatibility:
/Server 0 : XVL classic
/Client 1 : CATIA V5
2 : Creo Parametric
3 : NX
4 : SOLIDWORKS
5 : Architectural CAD
P0027 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
P0028 UI_VIEWING_STOP_COLLIDE Logical Y Y N Mode Specifies whether to stop in walk/fly through.
/Server
/Client
P0029 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
P0030 UI_CHECK_PICK Logical Y Y N Mode Specifies whether to change mouse cursor when
/Server elements can be picked in view mode.
/Client
P0031 16.1+ UI_HIGH_DPI_MODE Integer Y Y N Options / Specifies whether to use high-resolution mode.
Server / 0 : Do not use
Client 1 : Use
2 : Auto
00902 14.1+ FILE_SAVE_ILLUST_DATA Integer Y Y N Server Specifies whether to save data for illustration
/Client display in an XVL file:
0: As is
1: Save
2: Do not save
* It is recommended to specify VIEW_CAPTURE_TYPE, VIEW_CAPTURE_WIDTH, VIEW_CAPTURE_HEIGHT and VIEW_CAPTURE_DPI together.
51
7.2.9 Option setup [Others]

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

Number
02158 UI_KEY_PAN String N N N Client Specifies the shortcut key for the pan control.
02159 UI_KEY_EXAM String N N N Client Specifies the shortcut key for the rotation control.
02160 UI_KEY_ZOOM String N N N Client Specifies the shortcut key for the zoom control.
02161 UI_KEY_AREA String N N N Client Specifies the shortcut key for specifying a view area.
02165 UI_KEY_SELECT_ASSY String N N N Client Specifies the shortcut key corresponding to assembly
selection.
02166 UI_KEY_SELECT_PART String N N N Client Specifies the shortcut key corresponding to part selection.
02167 UI_KEY_SELECT_BODY String N N N Client Specifies the shortcut key corresponding to body selection.
02168 UI_KEY_SELECT_ELEM String N N N Client Specifies the shortcut key corresponding to element
election.
02171 13.0+ UI_KEY_LANGUAGE Integer N N N Client Specifies the keyboard layout for shortcut key application:
0: English layout (QWERTY)
1: German layout (QWERTZ)
52

Number
02172 UI_RATIO_PAN Real N N N Client Specifies the ratio of pan to the amount of mouse
movement (0.1 – 10.0).
02173 UI_RATIO_EXAM Real N N N Client Specifies the ratio of rotation to the amount of mouse
movement (0.1 – 10.0).
02174 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).
02175 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 (0.1 –
10.0).
02176 UI_RATIO_WALK Real N N N Client Specifies the ratio of walk to the amount of mouse
10.0).
02177 UI_RATIO_LOOK Real N N N Client Specifies the ratio of look-around to the amount of mouse
10.0).
02178 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.
02179 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.
02180 17.1a UI_WHEEL_ZOOM_MODE Integer N N N Server Specifies the display mode adopted during zooming
+ /Client operations using the mouse wheel:
0: Enables rough display.
1: Disables rough display.
53

Number
02181 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).
02182 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.
02195 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.
02196 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.
02200 12.2+ UI_STARTUP_OPERATION_ Integer N N N Mode Specifies the operation menus upon activation:
MODE /Server 0: Viewing mode
/Client 1: Selection mode
02204 12.2+ XVL_DEFAULT_FILE_PATH String N N N Server Specifies the absolute path with the file name for the XVL
/Client common setting file. ‘\’ is a special character whose
meaning depends on the characters appearing after it as
follows:
\\ : Single ‘\’
\\\\ : Two-letter ‘\\’
Character strings starting with ‘\’ other than the above are
interpreted as they are.
For shortcut keys and other keys, the first letter of the specified string is applied.
7.2.11 Animation
54

Number
01391 10.0+ ANIMATION_FPS Integer N N N Mode /Server Specifies an FPS value: 1, 5, 10, 20, 30 or 60.
/Client
P0033 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
P0034 10.0+ PROCESS_ANIM_PLAY_UNIT Integer Y Y N Server /Client Specifies the unit for playing process animation:
0 : Entire range
1 : Task
P0035 10.0a+ PROCESS_ANIM_JUMP_UNIT Integer Y Y N Server /Client Specifies the unit for moving process animation:
0 : Process
1 : Task
P0036 10.0+ PROCESS_ANIM_PLAY_LOOP Logical Y Y N Server /Client Specifies whether to enable loop play of process
animation.
P0037 14.0* PROCESS_ANIM_ALERT_ Real N N N Server /Client Highlight display interval
INTERVAL
Note:
This item is not recommended.
The setting operates in the same way as when
the duration and number of blinks settings for
highlighted display are specified such that:
interval = duration/number of blinks
01585 14.0+ PROCESS_ANIM_ Real Y Y N Server /Client Duration of highlighted display.
DISP_BLINK_TIME
01586 14.0+ PROCESS_ANIM_ Integer Y Y N Server /Client Number of blinks for highlighted display.
DISP_BLINK_NUM
01587 14.0* PROCESS_ANIM_ALERT_ Integer Y Y N Server /Client Highlight color of highlighted display.
PART_COLOR
P0038 10.0+ PROCESS_ANIM_DISP_ Logical Y Y N Server /Client Specifies whether to show paths during process
TRAJECTORY animation play.
P0039 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.
55

Number
P0040 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.
7.2.12 Event play

Number
P0041 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:
x00000004 : Mouse down
x00000008 : Mouse up
x00000010 : Mouse move
x00000020 : Mouse drag
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
P0042 10.0+ EVENT_ALWAYS_EDIT Logical N N N Mode Specifies whether to issue the event specified at
EVENT_ALWAYS in edit mode.
P0043 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.
56
7.2.13 Cross-sections

Number
01041 11.1+ PROFILE_DISPLAY_TYPE Integer Y N N Server Specifies the method for showing
/Client cross-sections 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.
01068 13.0 PROFILE_HIDE_CM_DM Logical N N N Server Specifies whether to hide notes and dimensions
/Client that are completely cut by a cross-section.
7.2.14 6-plane cross-section

Number
01091 15.0+ UI_6CLIPPING_SECTION String N N N Server Specifies the section name of a property used to
/Client identify cutting targets.
01092 15.0+ UI_6CLIPPING_KEY String N N N Server Specifies the name of a property used to identify
/Client cutting targets.
57

Number
01093 15.0+ UI_6CLIPPING_VALUE String N N N Server Specifies the value of a property used to identify
/Client cutting targets.
7.2.15 Visualization of shape comparison
Control Chang ID Type Inheri Loc Mandator Specificatio Description

Numbe e t k y n
r
01274 10.1+ VISUAL_COMPARISON_COLOR1 Intege N N N Server Specifies the color of Target 1.
r /Client
01275 10.1+ VISUAL_COMPARISON_COLOR2 Intege N N N Server Specifies the color of Target 2.
r /Client
01276 10.1+ VISUAL_COMPARISON_COLOR3 Intege N N N Server Specifies the color used for sections where two
r /Client parts are judged to coincide.
01277 10.1+ VISUAL_COMPARISON_VIEW_BEHAVI Intege N N N Server Specifies the timing for display of sections
OR r /Client where two parts are judged to coincide:
0: No display during view operations.
1: Display during view operations.
7.2.16 Others
Number
58

Number
P0044 13.1* EVENT_UI Integer - - - Options Notification of event changes in UI. Specify the logical
sum of the following values to control events:
x0001 : Selection change
x0002 : History operation
x0004 : Command change
x0008 : Display setting change
x0010 : Selection control change
x0040 : Operation mode change
x0080 : Animation operation change
x0400 : Element visibility
x0800 : Specifies view operation mode
P0045 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
P0046 12.2+ UI_DISABLE_SHORTCUT Integer - - - Mode Specifies whether to disable shortcut functions applied to
/Server keys or mouse buttons. The target functions are
/Client specified using the following logical sums:
x00000001: Selection mode
x00000002: Viewing mode
59

Number
P0047 13.0b* OPT_SAFE_MODE Integer - - - Options Specifies XVL Player behavior when HTML contents are
(Logical) /Server uploaded on an untrusted web site.
Value Description
0 Goes into save mode where some
operations are restricted. The
corresponding message will be shown
when safe mode starts.
1 Starts XVL Player in safe mode where
some operations are restricted,
regardless of the location of HTML
contents.
2 Goes into safe mode where some
operations are restricted. The
corresponding message will not be
shown when safe mode starts.
It is advisable to specify this ID with an integer, but the

following logical values are also available:
TRUE : Behaves as if 1 is specified.
FALSE : Behaves as if 0 is specified.
P0048 15.1a+ UI_LINKID String - - - Options Specifies the link ID for linking with assembly tree control.
Permitted characters are '0' (0x30) to '9' (0x39), 'A' (0x41)
to 'Z' (0x5a), '_' (0x5f), and 'a' (0x61) to 'z'(0x7a).
60

XVL Player Def

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

XVL Player Def

Uploaded by

Copyright:

Available Formats

XVL Player / XVL Player Pro Start-Up Options Manual

XVL Player / XVL Player Pro

THIS DOCUMENT INCLUDES TECHNICAL INFORMATION THAT IS THE INTELLECTUAL

For product support, please contact your sales agent.

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

Trademarks and registered trademarks

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

Priority Specification Description

Display settings follow the following rules:

Specification method Operations

P roperty Lattice3D Client

Visual Basic Application

3 XVL Player Insertion

The following start-up properties are available:

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

Type of value Description

Type of value Description

3.2 Microsoft Office

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

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

3. Execute the following items on Microsoft PowerPoint.

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

XVL Player SDK is a separately available product, so please purchase it separately.

4 Insert Assembly Tree Control

Type Status Description

Item Description Start-up option

Clicking the … button displays the file dialog, allowing

Clicking the … button displays the file dialog, allowing

Item Description Start-up option

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

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

Item Description Start-up option

Item Description Start-up option

Item Description Start-up option

5.4 Display Element

Item Description Start-up option

5.5 Display Options

Item Description Start-up option

Item Description Start-up option

Clicking [Set] specifies the actions issued. The

For details, refer to XVL Player SDK Reference

Item Description Start-up option

Item Description Start-up option

Item Description Start-up option

Clicking the […] button opens the

Clicking […] opens the file dialog

6.1 Server Configuration File

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

6.2 Client Configuration File

6.3 Configuration File Format

Parameter ID, Change flag, Default value

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.

Type of value Description

Type of value Description

The 1st line

The 2nd line

The 3rd line

7.1 Notes for the Table

Control Change ID Type Inherit Lock Mandatory Specification Description

1 : Use the change flag value.

7.2.2 Menu [File]