Using a Nikon Metrology Probe

(Legacy) in PolyWorks
 PolyWorks|Inspector™

Complement to the
PolyWorks|Inspector Reference Guide
© 2018–2020 InnovMetric Software Inc. All rights reserved. PolyWorks® is a registered
trademark of InnovMetric Software Inc. InnovMetric, PolyWorks|Inspector,
PolyWorks|Modeler, PolyWorks|Talisman, PolyWorks|Reviewer, IMAlign, IMMerge,
PolyWorks|DataLoop, PolyWorks|PMI+Loop, PolyWorks|AR, PolyWorks|ReportLoop, "The
Universal 3D Metrology Software Platform", "The Smart 3D Metrology Digital Ecosystem",
and "Interconnecting Hardware, Software and People" are trademarks of InnovMetric
Software Inc.

SmartGD&T is a trademark of Multi Metrics Inc. NX is a trademark or registered trademark of

Siemens Product Lifecycle Management Software Inc. or its subsidiaries in the United States
and in other countries. Teamcenter is a trademark or registered trademark of Siemens
Product Lifecycle Management Software Inc. or its subsidiaries in the United States and in
other countries. All other trademarks are the property of their respective owners.

This manual, as well as the software described in it, is furnished under license and may be
used or copied only in accordance with the terms of such license. The content of this
document is furnished for informational use only, and is subject to change without notice.
InnovMetric Software Inc. assumes no responsibility or liability for any errors or inaccuracies
that may appear in this document.

Except as permitted by such license, reproduction in whole or in part in any way without
written permission from InnovMetric Software is strictly prohibited.

Using a Nikon Metrology Probe (Legacy) in PolyWorks

2020/03/18
PolyWorks® Metrology Suite 2020
Contents

Contents

4 Introduction

5 1. Requirements
5 1.1 Hardware and software components
6 1.2 Drivers

7 2. Configuring Device Properties and Probing Options

7 2.1 Choosing the device
7 2.2 Configuring device properties
9 2.3 Configuring probing options
9 2.3.1 Setting device-specific probing options

11 3. Probing in PolyWorks|Inspector
11 3.1 Connecting to the device
11 3.2 Probing objects
12 3.2.1 Launching a probing operation
13 3.2.2 Using the device buttons
15 3.3 Moving the device
15 3.4 Disconnecting from the device

16 4. Scripting and Additional Functionalities

16 4.1 Introduction to scripting
19 4.2 Functionalities only available by scripting

20 Appendix A: Probing Toolbars

20 A.1 Devices toolbar
21 A.2 Probing Device toolbar
22 A.3 Probing Control toolbar

Using a Nikon Metrology Probe (Legacy) in PolyWorks 2020 3

Introduction

The PolyWorks® Metrology Suite is a complete reverse-engineering and inspection

solution for high-density point clouds. It offers a wide choice of plug-ins that allow the
capture of 3D coordinate points by way of probing devices.

This document explains how to configure the devices supported by the Handheld API
Runtime (HHAPI) and by the Nikon Metrology API Runtime (NMAPI) V3.7. It explains
how to use these devices with the PolyWorks|Inspector module, provides an overview
of probing in the module, and describes device-specific parameters as well as the
probing toolbars configured for these devices. If using NMAPI V4.4 or later, see the
Nikon Metrology Probe plug-in guide, offered on the Help > Reference Guides submenu
of PolyWorks|Inspector module. For any questions or issues related to a device or its
setup, contact a Nikon Metrology representative.

Related documentation

Each PolyWorks Metrology Suite module has its own complete reference guide in PDF
format. It can be accessed by pressing the ? symbol in the title bar of any open module
dialog box, or by looking under a module’s Help menu. The following documents are
closely related to the current one:

Reference
Description
guide

PolyWorks Contains a complete description of the Workspace Manager and

Reference explains how to customize the user interface.
Guide

Explains the different functionalities in the PolyWorks|Inspector

module of the PolyWorks Metrology Suite. More specifically, it
PolyWorks|
contains a chapter on how to probe in PolyWorks|Inspector (see the
Inspector
“Probing” chapter). The content of the chapter is generic (applies to
Reference
all devices). For information on probing with the device described in
Guide
this document, see the “Probing in PolyWorks|Inspector” chapter in
the present document.

Using a Nikon Metrology Probe (Legacy) in PolyWorks 2020 4

1. Requirements
This chapter provides requirements when probing with a device supported by HHAPI
V3.3.0.9328 or later, or NMAPI V3.7, in the PolyWorks|Inspector module of the
PolyWorks Metrology Suite.

1.1 Hardware and software components

Before probing, the following requirements must be met:

 The PolyWorks Metrology Suite 2020 with the latest intermediate release must be
installed to ensure having the most up-to-date plug-ins (available from the Technical
Support Zone of InnovMetric’s website).

For the Nikon Metrology Probe and Scanner (Legacy) plug-in, the
NikonMetrologyProbeAndScannerLegacy.dll file is installed in the Plugins subfolder of
the PolyWorks Metrology Suite installation folder.

 Nikon Metrology Probe and Scanner (Legacy) must be selected on the Plug-ins
page of the Workspace Manager Options dialog box. This dialog box is displayed the
first time that the PolyWorks Metrology Suite is opened. It is also available at any time
by clicking the Workspace Manager Options button (shown to the right) in the
Workspace Manager.

For information about the different options available in the previously mentioned
dialog box, see the “Setting PolyWorks options” section of the PolyWorks Reference
Guide.

 HHAPI V3.3.0.9328 or later, or NMAPI V3.7, is required. It is available at the following

location:

ftp://ftp.innovmetric.com/pub/drivers/Nikon/Legacy/

Using a Nikon Metrology Probe (Legacy) in PolyWorks 2020 5

Requirements Drivers

1.2 Drivers
The required driver depends on which device is used. For more information, see the
manufacturer’s recommendations.

Using a Nikon Metrology Probe (Legacy) in PolyWorks 2020 6

2. Configuring Device Properties and
Probing Options
This chapter explains how to set up the probing environment. The first step consists of
choosing the device that will be used. Then, the device properties can be configured,
and many aspects of the probing operations can be customized.

2.1 Choosing the device

Probing in PolyWorks|Inspector is supported through plug-ins. Choose the appropriate
plug-in by means of the Devices toolbar, which is available in the lower-left part of the
window. Click the menu button to the right of the first button to open the Device list
box (shown to the right). Choose Nikon Metrology Probe (Legacy). The following
toolbars are displayed, configured for the device:

 The Probing Device toolbar.

 The Probing Control toolbar. It allows deleting the last acquired point, and reprobing
the last probed object.

These toolbars are described in Appendix A Probing Toolbars.

2.2 Configuring device properties

On the Probing Device toolbar, the Device Properties button (shown to the right)
allows accessing the Probing Device Properties dialog box, shown in Figure 2.1 that
allows choosing, creating, and managing hardware profiles. Note that where the term
“localiser” is used in interfaces, which is specific to Nikon, the term “device” is used in
the current documentation. The dialog box offers the items that follow.

Hardware profile
A group box that offers items that allow choosing, creating, and managing
hardware profiles, which specify a localiser.

Name
A list box that allows selecting a predefined hardware profile. The default
choice is the last-selected profile.

Three buttons are offered to manage the profiles:

Using a Nikon Metrology Probe (Legacy) in PolyWorks 2020 7

Configuring Device Properties and Probing Options Configuring device properties

Figure 2.1 The Probing Device Properties dialog box, and the one used to create profiles.

New
A button that displays a dialog box, shown to the right in Figure 2.1, that
allows creating a new profile. It offers the items that follow:

Name
A text box that allows specifying a unique profile name (i.e.,
different from that of existing profiles). By default, this text box is
empty. If no name is provided, one is created using the name of
the localiser.

Localiser
A list box that offers all the localisers (i.e., devices) supported by
the runtime from Nikon.

Press the OK button to create the profile or the Cancel button to cancel
the profile creation.

Delete
A button that allows deleting the selected profile.

Configure
A button that allows configuring the selected profile by accessing the
runtime configuration dialog box specific to the selected profile. Values

Using a Nikon Metrology Probe (Legacy) in PolyWorks 2020 8

Configuring Device Properties and Probing Options Configuring probing options

Figure 2.3 The Objects > Probing page of the PolyWorks|Inspector Options dialog box.

modified in the runtime configuration dialog box are automatically

transferred to the plug-in.

For complete information on this dialog box, refer to the Handheld API
Runtime documentation.

Press the Close button to dismiss the dialog box.

2.3 Configuring probing options

A probing session can be customized to suit specific needs, from choosing a
measurement method to the display in the 3D scene. The PolyWorks|Inspector Options
dialog box offers many probing-related options. For an overview of where probing
options are located in the PolyWorks|Inspector Options dialog box, see Figure 2.2.

2.3.1 Setting device-specific probing options

For the Nikon Metrology plug-in, a particularity applies to one of the options on the
Objects > Probing page of the PolyWorks|Inspector Options dialog box: the end of
acquisition button must be used instead of the acquisition button for the object
measurement confirmation (see Figure 2.3).

Using a Nikon Metrology Probe (Legacy) in PolyWorks 2020 9

Configuring Device Properties and Probing Options Configuring probing options

Figure 2.2 Pages within the PolyWorks|Inspector Options dialog box that offer probing options.

Display > Probing and Scanning page:

Options related to how information is displayed when
probing and scanning (e.g., device origin, text size, and
color mode).

Display > Probing and Scanning > Probing page:

Options related to the 3D scene display (e.g., refresh
delay, probe aspect, and usage of a guiding line).

Display > Probing and Scanning > Digital Readout

page:
Options related to the Digital Readout window, which
provides real-time probing information (e.g., probe
position, distance from an object, and statistics).

Probe pages:
Options related to probing the measured component of
measurement objects.

Objects > Probing page:

Options related to object measurements (e.g., tolerance
thresholds for features, action to confirm the probing of
a new object, and out-of-tolerance warning type).

Probing Device page:

Options specific to the selected device and to how
probing is performed. Certain device properties are also
offered.

Using a Nikon Metrology Probe (Legacy) in PolyWorks 2020 10

3. Probing in PolyWorks|Inspector
This chapter presents an overview of probing in the PolyWorks|Inspector module. It
explains how to connect to the device, presents the environment for probing (e.g.,
toolbars and elements of the graphical user interface), and describes how to launch the
probing of objects. It also explains how the plug-in makes use of the device’s buttons (if
any).

For information on other subjects related to probing, see the “Probing” chapter in the
PolyWorks|Inspector Reference Guide, which is available from the Help > Reference
Guides submenu of this module.

3.1 Connecting to the device

Prior to performing a probing session, a connection must be established with the
device.

The connection is automatically established on starting the plug-in. When automatic

connection fails, the connection is made by clicking the Connect to Nikon Metrology
Probe (Legacy) button on the Devices toolbar, shown to the right.

If profiles exist, the last-selected profile is used. Otherwise, a dialog box is displayed to
create a new profile which will be used; for more information, see Section 2.2
Configuring device properties.

Note that any line scanning session (or other probing session) that currently uses the
Nikon Metrology software is ended when connecting to the device.

See the “Connecting to a device” section of the PolyWorks|Inspector Reference Guide

for information concerning the connection procedure.

3.2 Probing objects

PolyWorks|Inspector allows probing surface point clouds and boundary point clouds,
as well as probing the measured component of the following existing measurement
objects:

 Features, except surface and slab features; can also probe nominal components.

 Cross-sections; can also probe new cross-sections.

 Comparison points; can also probe new comparison points.

 Flush & gap gauges and profile gauges.

Using a Nikon Metrology Probe (Legacy) in PolyWorks 2020 11

Probing in PolyWorks|Inspector Probing objects

Figure 3.1 The Create Features dialog box, shown in (a), is available by choosing Measure >
Features > Create menu item; it is also available through the Features toolbar. In (a),
the dialog box is configured to create a circle using the Probe creation method. In (b),
the split button allows choosing the desired feature type.

(a)

(b)

3.2.1 Launching a probing operation

Probing operations are offered on the main menu, and on the shortcut menu, of
objects that can be probed.

For an example, see Figure 3.1 and Figure 3.2.

Using a Nikon Metrology Probe (Legacy) in PolyWorks 2020 12

Probing in PolyWorks|Inspector Probing objects

Figure 3.3 A snapshot of probing data for a surface comparison point. A red guiding line links
the probe’s current position and the comparison point being probed.

Once the probing operation is launched, a dialog box is displayed to configure the
probing operation; see Figure 3.3. It features a Probe button to begin the actual point
measurement; if the device is already connected, the button is made unavailable and
the probing can begin.

The 3D scene features the Probing Status window that displays an icon of the object
being probed and the number of points measured so far. An automatic viewpoint
mode is offered that places the object to probe in a good viewing position for the
operator. In most cases, a virtual probe represents the current position of the actual
probe. The DRO window displays information pertinent to the current probing
operation. These items can be customized using the probing options offered in the
PolyWorks|Inspector Options dialog box.

3.2.2 Using the device buttons

The Nikon Metrology Probe plug-in allows probing with any device supported by the
Handheld API Runtime. The table that follows explains how the buttons are used by this
plug-in.

Using a Nikon Metrology Probe (Legacy) in PolyWorks 2020 13

Probing in PolyWorks|Inspector Probing objects

Figure 3.2 Probing data for existing measurement objects is offered on the main menu (a), the
object’s shortcut menu (b), and the Probe Measured Components toolbar (c).

(a)

(b)

(c)

Using a Nikon Metrology Probe (Legacy) in PolyWorks 2020 14

Probing in PolyWorks|Inspector Moving the device

Note that in the table, the “acquisition button” and “end of acquisition button” terms
are generic. If the device has no acquisition or end of acquisition button, it is necessary
to use the buttons on the Probing Device toolbar. The toolbar buttons are detailed in
Appendix A Probing Toolbars.

Operation Information

To acquire individual
Push the acquisition button.
points

In Compensation Point mode:

• If the number of points to acquire is undefined, push the
end of acquisition button when the probe is above and
To end the current away from the surface.
acquisition session • If the number of points to acquire is fixed, push any button
when the probe is above and away from the surface.

In Probe Orientation mode, push the end of acquisition

button.

To terminate the
Push the end of acquisition button.
acquisition sessions

3.3 Moving the device

For users that acquire data by line scanning or probing using a plug-in, and the device
has to be moved one or more times, the PolyWorks Metrology Suite offers a mechanism
of device positions. Device positions allow typical data acquisition scenarios, such as
moving a device several times around a large object, combining different devices
located at fixed positions, and so on, while continuing to acquire aligned data.

For more information, see the “Device Positions” chapter of the PolyWorks|Inspector
Reference Guide.

3.4 Disconnecting from the device

The plug-in will be disconnected from the device when one of the following situations
occurs:

 The Disconnect from Nikon Metrology Probe (Legacy) button (shown to the right)
is clicked on the Devices toolbar.

 Another probing session uses the Nikon Metrology software.

 A line scanning session uses the Nikon Metrology software.

Using a Nikon Metrology Probe (Legacy) in PolyWorks 2020 15

4. Scripting and Additional Functionalities
PolyWorks offers full scripting possibilities which allow automating tasks in part or
entirely, depending on the nature of the task to perform. Basic scripts contain
application commands that allow performing operations identical to those performed
directly using the GUI of an application, such as PolyWorks|Inspector (e.g., menu items,
toolbar buttons). Enhanced scripts include elements of the Macro Script Control
Language (MSCL) such as variables, IF/WHILE commands, dialog boxes to query users,
and commands to write to and read from text files.

Most application commands are easy to find. For each action performed through the
GUI of an application, the corresponding application command can be seen in the
Command History pane. However, some application commands may not be offered in
the GUI, as they offer functionalities to address only specific needs.

This chapter presents a short introduction to scripting and explains how to quickly find
the application commands for your device that are mapped to the GUI. Then, the
functionalities that are only available through application commands, if any, are
presented.

4.1 Introduction to scripting

Actions performed using the GUI of an application have a corresponding application
command that can be viewed in the Command History pane. These commands can be
pasted into the Macro Script Editor of the application, saved to a file, and then be
recalled and executed in the Macro Script Editor. For an example, see Figure 4.1.

For each command, a description of the command, the command syntax, and a
description of each command argument (e.g., type) is provided. An example of the
command help that is available for this plug-in is shown in Figure 4.2. The editor offers
help in HTML format for all the MSCL commands, as well as application commands that
are found in the specific application/module. To access the HTML help file, choose the
Help > Commands menu item in the Macro Script Editor.

The Macro Script Editor is offered in the main PolyWorks Metrology Suite modules, such
as PolyWorks|Inspector™. Scripts must be executed in the Macro Script Editor. The
editor offers automatic indentation and an intelligent color scheme to, for example,
differentiate between MSCL and application commands. In addition, blocks of
commands can be quickly commented in and out. Finally, several script execution
modes are offered. Scripts can be executed step by step, or to user-specified break
points, which is useful when debugging a script.

The MSCL commands include common programming structures, such as IF and WHILE
for the conditional execution of commands. Variables are offered to store information,
including array variables. There are also commands to query the user and to get
information from a project (e.g., the number of objects under a given branch). These
commands provide just a sample of the possibilities available through scripting.

Using a Nikon Metrology Probe (Legacy) in PolyWorks 2020 16

Scripting and Additional Functionalities Introduction to scripting

Figure 4.1 The Command History pane shows the application commands that result from user
actions performed through the GUI. Here, a probing device was selected and the
Connect to Device button was pressed. In (a), the arrow shows the corresponding
commands that appear in the Command History pane. In (b), the commands were
copied and pasted into a new script in the Macro Script Editor.

(a)

(b)

Complete information on scripting in PolyWorks is provided in the Macro Script

Reference Guide in PDF format, available from the editor’s Help menu.

Using a Nikon Metrology Probe (Legacy) in PolyWorks 2020 17

Scripting and Additional Functionalities Introduction to scripting

Figure 4.2 The list of application commands for the plug-in in the HTML command help.

Using a Nikon Metrology Probe (Legacy) in PolyWorks 2020 18

Scripting and Additional Functionalities Functionalities only available by scripting

4.2 Functionalities only available by scripting

The table that follows provides a brief description of application commands that offer
functionalities that are only available through scripting. For complete command
information, including command syntax, arguments, and notes, see the HTML help file.

Command Description

No commands available.

Using a Nikon Metrology Probe (Legacy) in PolyWorks 2020 19

A. Probing Toolbars
This appendix describes the utility toolbars for probing that are offered on choosing
the Nikon Metrology Probe (Legacy) probing device plug-in. They are present for the
entire probing session (i.e., until the plug-in is deselected from the list). Certain
parameters may be configured on connecting to the device.

A.1 Devices toolbar

The Devices toolbar offers buttons that are described in the table that follows:

Item Description

Connect to Device / Disconnect from [device name]

A split button whose button establishes a connection with the selected
probing device. To select a device, click the split button’s adjacent arrow and
choose a probing device plug-in from the list that is displayeda. Then, press the
button to establish a connection. The first choice is a dummy default value
(None). For more information, see the “Specifying a probing device” section of
the PolyWorks|Inspector Reference Guide.
If the connection is established, the button background changes from gray to
orange to demonstrate the connection. Pressing the button again disconnects
the probing device, and the original icon is displayed. For more information,
see the “Connecting to a device” section of the PolyWorks|Inspector Reference
Guide.

Scan
A split button whose button establishes a connection with the selected
scanning device.

Activate Offline Simulation

A button that activates the Offline Simulation mode, which allows realizing a
complete inspection project offline (i.e., without being connected to a physical
device), using simulated data for probing and scanning operations. For more
information, see the “Using the Offline Simulation mode” section of the
PolyWorks|Inspector Reference Guide.

a. For the probing device to be offered, the corresponding DLL file must exist in
the Plugins subfolder of the PolyWorks Metrology Suite installation folder (e.g.,
C:\Program Files\InnovMetric\PolyWorks MS 2020\plugins), and it must be
selected on the Plug-ins page of the Workspace Manager Options dialog box.

Using a Nikon Metrology Probe (Legacy) in PolyWorks 2020 20

Probing Toolbars Probing Device toolbar

A.2 Probing Device toolbar

The Probing Device toolbar offers buttons that are described in the table that follows:

Item Description

The Device Properties button.

It gives immediate access to the property dialog box of the device. Device-
specific properties are described in the Chapter 2 of the present document.
Note that a Properties button that displays the same dialog box is offered
on the Probing Device page of the PolyWorks|Inspector Options dialog
box.

The Probe Name list box that contains the probes supported by the
device. The choice (Auto-Detect) indicates that the device will
automatically the probe. Hovering the mouse pointer over the list box
displays a tooltip that shows the complete name of the selected probe.

The Tip Diameter. The diameter of the probe expressed in the project’s units
of length. In the case of probes with shanks, the tip diameter and the shank
diameter are displayed in that order.
This value may be updated automatically, or manually, on the Probing
Device page of the PolyWorks|Inspector Options dialog box. For more
information, see the “Probing device options” section of the
PolyWorks|Inspector Reference Guide.

The Probing Mode list box. It lists the probing modes offered by the
selected device, and can be used to specify a different mode. The modes
are explained in the “Measurement mode options” section of the
PolyWorks|Inspector Reference Guide. Hovering the mouse pointer over
the list box displays a tooltip that shows the complete name of the selected
probing mode.

The Probing Options menu button. It offers quick access to frequently used
probing options. For more information on these options, see the “Probing
device options” section of the PolyWorks|Inspector Reference Guide.

Using a Nikon Metrology Probe (Legacy) in PolyWorks 2020 21

Probing Toolbars Probing Control toolbar

A.3 Probing Control toolbar

The Probing Control toolbar allows controlling the probing that is being performed.
The buttons are described in the table that follows.

Item Description

The Undo Last Probed Point button.

It deletes the last acquired point. A sound is played after a successful point
deletion.

The Reprobe Object button.

It allows the reprobing of the last probed object, and only that object.
Reprobing is available for most objects. For complete information, see the
“Reprobing the last-probed object” section of the PolyWorks|Inspector
Reference Guide.

Using a Nikon Metrology Probe (Legacy) in PolyWorks 2020 22