Professional Documents
Culture Documents
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
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.
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
5
XVL Player / XVL Player Pro Start-Up Options Manual
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:
<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.
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.
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
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).
(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.”
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.
9
XVL Player / XVL Player Pro Start-Up Options Manual
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.
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.
12
XVL Player / XVL Player Pro Start-Up Options Manual
13
XVL Player / XVL Player Pro Start-Up Options Manual
4. Select XVL Player View Control on More Controls dialog box and execute "OK.”
14
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 2010 document and to specify start-up options.
15
XVL Player / XVL Player Pro Start-Up Options Manual
16
XVL Player / XVL Player Pro Start-Up Options Manual
4. Select XVL Player View Control on More Controls dialog box and execute "OK.”
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.
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
19
XVL Player / XVL Player Pro Start-Up Options Manual
4.2 Graphics
20
XVL Player / XVL Player Pro Start-Up Options Manual
21
XVL Player / XVL Player Pro Start-Up Options Manual
4.3 Custom
22
XVL Player / XVL Player Pro Start-Up Options Manual
23
XVL Player / XVL Player Pro Start-Up Options Manual
24
XVL Player / XVL Player Pro Start-Up Options Manual
4.6 Event
25
XVL Player / XVL Player Pro Start-Up Options Manual
4.7 Others
26
XVL Player / XVL Player Pro Start-Up Options Manual
27
XVL Player / XVL Player Pro Start-Up Options Manual
5 Configuration Files
Specify with Options property OPT_DEF_FILE. The following description is used for HTML
specification.
Specify server settings with “Setting file” in the figure in “4.1 General” for Microsoft Office
applications.
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.”
The configuration file is in CSV file format. A single line corresponds to a single parameter, and
each line consists of the following cells.
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.
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.
29
XVL Player / XVL Player Pro Start-Up Options Manual
Coding example:
#Sample,,
VIEW_BACKGROUND_COLOR,7,xFFFFFF
VIEW_DISPLAY_TYPE,0,2
30
XVL Player / XVL Player Pro Start-Up Options Manual
6 Description of Parameters
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
33
XVL Player / XVL Player Pro Start-Up Options Manual
34
XVL Player / XVL Player Pro Start-Up Options Manual
35
XVL Player / XVL Player Pro Start-Up Options Manual
36
XVL Player / XVL Player Pro Start-Up Options Manual
37
XVL Player / XVL Player Pro Start-Up Options Manual
38
XVL Player / XVL Player Pro Start-Up Options Manual
39
XVL Player / XVL Player Pro Start-Up Options Manual
40
XVL Player / XVL Player Pro Start-Up Options Manual
41
XVL Player / XVL Player Pro Start-Up Options Manual
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.
42
XVL Player / XVL Player Pro Start-Up Options Manual
43
XVL Player / XVL Player Pro Start-Up Options Manual
44
XVL Player / XVL Player Pro Start-Up Options Manual
45
XVL Player / XVL Player Pro Start-Up Options Manual
46
XVL Player / XVL Player Pro Start-Up Options Manual
47
XVL Player / XVL Player Pro Start-Up Options Manual
6.2.10 Customization
48
XVL Player / XVL Player Pro Start-Up Options Manual
49
XVL Player / XVL Player Pro Start-Up Options Manual
For shortcut keys and other keys, the first letter of the specified string is applied.
6.2.11 Animation
50
XVL Player / XVL Player Pro Start-Up Options Manual
51
XVL Player / XVL Player Pro Start-Up Options Manual
6.2.13 Cross-sections
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
52
XVL Player / XVL Player Pro Start-Up Options Manual
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