Laser Model Interface Reference Manual
Laser Model Interface Reference Manual
Reference Manual
Disclaimer
Information of a technical nature, and particulars of the product and its use, is given by AVEVA
Solutions Ltd and its subsidiaries without warranty. AVEVA Solutions Ltd and its subsidiaries disclaim
any and all warranties and conditions, expressed or implied, to the fullest extent permitted by law.
Neither the author nor AVEVA Solutions Ltd, or any of its subsidiaries, shall be liable to any person or
entity for any actions, claims, loss or damage arising from the use or possession of any information,
particulars, or errors in this publication, or any incorrect use of the product, whatsoever.
Copyright
Copyright and all other intellectual property rights in this manual and the associated software, and every
part of it (including source code, object code, any data contained in it, the manual and any other
documentation supplied with it) belongs to AVEVA Solutions Ltd or its subsidiaries.
All other rights are reserved to AVEVA Solutions Ltd and its subsidiaries. The information contained in
this document is commercially sensitive, and shall not be copied, reproduced, stored in a retrieval
system, or transmitted without the prior written permission of AVEVA Solutions Ltd Where such
permission is granted, it expressly requires that this Disclaimer and Copyright notice is prominently
displayed at the beginning of every copy that is made.
The manual and associated documentation may not be adapted, reproduced, or copied, in any material
or electronic form, without the prior written permission of AVEVA Solutions Ltd. The user may also not
reverse engineer, decompile, copy, or adapt the associated software. Neither the whole, nor part of the
product described in this publication may be incorporated into any third-party software, product,
machine, or system without the prior written permission of AVEVA Solutions Ltd, save as permitted by
law. Any such unauthorised action is strictly prohibited, and may give rise to civil liabilities and criminal
prosecution.
The AVEVA products described in this guide are to be installed and operated strictly in accordance with
the terms and conditions of the respective license agreements, and in accordance with the relevant
User Documentation. Unauthorised or unlicensed use of the product is strictly prohibited.
First published September 2007
AVEVA Solutions Ltd, and its subsidiaries
AVEVA Solutions Ltd, High Cross, Madingley Road, Cambridge, CB3 0HB, United Kingdom
Trademarks
AVEVA and Tribon are registered trademarks of AVEVA Solutions Ltd or its subsidiaries. Unauthorised
use of the AVEVA or Tribon trademarks is strictly forbidden.
AVEVA product names are trademarks or registered trademarks of AVEVA Solutions Ltd or its
subsidiaries, registered in the UK, Europe and other countries (worldwide).
The copyright, trade mark rights, or other intellectual property rights in any other product, its name or
logo belongs to its respective owner.
Contents
Page
Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:1
Driver Subcommand - Accessing Drivers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:1
Querying Driver Attributes and Capabilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:1
Opening and Accessing Laser Models . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:3
Creating an External Geometry Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:3
Importing Models . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:4
Using the Vendors Model Browse Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:5
12.0
ii
12.0
Introduction
The Laser Model Interface (LMI) is a separately licenced module within the AVEVA Plant
DESIGN AVEVA Marine Outfitting products. Used in conjunction with a supported Laser
Model server application, it allows:
1.1
the display of Laser Models within PDMS, combined with normal PDMS geometry
clashing calculations between Laser Models and PDMS geometry, and display of the
resulting clashing regions
picking of points within Laser Models, and creating tie-in points between Laser
Models and geometry
1.2
1.3
Product Compatibility
In addition to the Windows operating system, other AVEVA and non-AVEVA products are
required for the Reference Manual of Laser Model functionality.
For all users:
1.4
PDMS
Installation
For an introductory guide and installation information, refer to the appropriate Laser Model
Server Application.
1:1
12.0
1:2
12.0
Commands
All Laser Model commands use the command verb LMI. The following sections detail the
various sub-commands available.
2.1
2.2
2:1
12.0
{var}
{string}
PDMS variable
driver name and connection details in the following format,
enclosed in single quotes:
APIVERSION
DRIVERVERSION
BANNER
LAST ERRORMESSAGE
MAXIMUM MODELS
MAXIMUM VIEWS
MAXIMUM
REGIONSOFINTEREST
MAXIMUM
HIGHLIGHTREGIONS
MAXIMUM
CLASHVOLUMES
MAXIMUM
VIEWQUALITY
MAXIMUM VIEWPORT
WIDTH / HEIGHT
SUPPORT
FBCLIPPING
SUPPORT
RENDERFAST
SUPPORT
LOWRESEVERYWHERE
2:2
12.0
SUPPORT
TESTVOLUMEFAST
SUPPORT
TESTGEOMETRYEXACT
2.3
2.3.1
This command creates a new XGEOM element at the current geometry level, and makes it
the current element. The current geometry level must be at or below a ZONE. The vendors
identification string can optionally be supplied (see note below), as can the model
identification string. These attributes can also be supplied using separate VENID and
MODID commands after the XGEOM has been created.
The vendor identification string should identify the Laser Model server application where the
actual point cloud data resides. The model identification string should identify a model within
the vendors model database.
2:3
12.0
Once the XGEOM has been created and the attributes set, PDMS adds the XGEOM to the
display. This happens automatically, both when the full form of the command above is used,
and when the attributes are set individually. (It also happens if the value of an attribute is
changed.) At this point, the values of the attributes are checked for validity, and if valid, the
XGEOM is made visible and the display is updated. If any attribute(s) are invalid or missing,
an error condition results, and the XGEOM is not added to the display.
Note: The vendor identification string format is described in Driver Subcommand Accessing Drivers. The VENID can be provided as either the long form of the string,
specifying the path to the vendor DLL and the vendors connect string, or the short
form that includes just the tag. The former provides all the information necessary to
open the Laser Model and add the XGEOM to the display. However, it suffers the
drawback that any change to the DLL path (which may happen for example when
accessing the database from a different node) or the vendor connect string (which
might for example contain embedded username / password information) will cause
the load to fail and the XGEOM not to be added to the display. For these reasons,
the short form of the VENID string is preferred. Note, however, that an XGEOM with
the short form VENID string can only be added to the display after another LMI
DRIVER {string} command has been used with the long form string, thus setting
the association between the tag and the other parameters for the session.
Once an XGEOM element has been created by the NEW command, the spatial occupancy
map can be built using the command:
LMI REMAP
The XGEOM should be the current element when this command is used.
LMI REMAP can be re-applied if the spatial occupancy map becomes out of date, for
example if the laser model is extended with extra scans. However users of Clash Manager
should be aware that identification of clash details with the laser model relies on the
persistence of the Dabacon REFNO of the clashing XCELL elements. Re-application of the
REMAP command will re-assign REFNOs and hence any related clash history will be
broken.
2.3.2
Importing Models
{string}
This command creates a new XGEOM element to represent the selected model, and opens
the model in the vendor driver.
The current element must be at or below a ZONE: if at a ZONE, the XGEOM will be created
as the first element in the list; if below a ZONE the XGEOM will be created as the next
element in the ZONE list. The new XGEOM becomes the current element.
2:4
12.0
2.3.3
the XGEOMs MODID attribute is set to the vendor defined model name (i.e. the name
necessary to access the model in the vendors database without using the browse
function)
the spatial map is calculated, and stored below the XGEOM (as XCLTN, XCELS and
XCELL elements).
{string}
2.4
Driver Extensions
{var}
{string}
PDMS variable
driver name and connection details in the following format, enclosed in
single quotes:
{command}
This command executes the driver specific command in the named driver. The result string
(if any) is returned in variable {var}, or if this is omitted, output in the PDMS command
window.
2:5
12.0
2.5
Licensing
{var}
PDMS variable
This command retrieves the licence status of the LMI module. The result string is returned in
variable {var}, or if omitted, output in the PDMS command window.
2.6
Manipulating Views
This section is provisional, as the syntax and functionality of the LMI VIEW commands has
not yet been finalised. It is possible that these commands may change, or be completely
removed at a later date, as views are not LMI specific, and an existing syntax exists within
PML to access and manipulate views and view parameters.
{in}
{out}
This command sets the view quality inside / outside the regions of interest within the view
specified (or all views if none specified). The % quality specified is translated as near as
possible to a view quality supported by each vendors software. Where a precise match is
not possible, the view quality is rounded up.
LMI VIEW ADD {type}
X/LENGTH {len} Y/LENGTH {len} Z/LENGTH {len}
AT E/AST {pos} N/ORTH {pos} U/P {pos}
LMI VIEW REM/OVE {type}
VAR {var} LMI VIEW {type} {COU/NT | {n}}
{view}
{type}
view number
one of:
REGIONSOFI/NTEREST, HIGHL/IGHTREGIONS
2:6
12.0
{len}
{pos}
{n}
a length value
a position value
index of the item in the list of {type} items
These commands create, delete and query regions of the type specified, within the view
specified (or all views if none specified).
The ADD command adds a region, preserving any regions of the same type already
present. The REMOVE command removes all regions of the type specified.
The COUNT subcommand returns the number of regions of the type specified. The {n}
subcommand returns the bounds (volume) of the n-th region.
2.7
Clash Testing
This section provides addition options for detecting and displaying clashes between PDMS
primitives and the external laser model. Before the XGEOM element can be clashed the
spatial occupancy map must be up to date, once the map has been built there generally is
no need to regenerate it.
DESCLASH LMI [TEST {option} | [DISP/LAY {display}] EXIT
{option} one of:
CELLS, EXACT/GEOMETRY
{display} one of:
CELLS, EXPAND/CELLS {off}, TIGHTBOXES, EXACT/GEOMETRY
The TEST command determines the level the clash test will take place, if CELLS the
primitive will test for clash with the spatial occupancy map only (default). Using the
EXACTGEOMETRY option the primitive will be clashed against the spatial occupancy map,
if there is a clash then the primitive will be clashed against the laser external model. The use
of EXACTGEOMETRY clash will produce a more accurate result however it will take longer
to process the data.
The DISPLAY command determines the manner in which the graphical feedback of the
clash will be displayed. By default the CELLS display option will be used: if there is a clash
then all points within the spatial occupancy cell will be highlighted as clashing. The
EXPANDCELLS option will highlight points within the spatial occupancy cell expanded by
the additional offset as clashing. The TIGHTBOXES option will highlight points within the
overlap between the spatial occupancy cell and the containment box for the PDMS primitive.
The EXACTGEOMETRY option will only highlight the points of the laser model that clash
with the primitive itself: as a result the clash display will normally be obscured by the
primitive. The use of the EXACTGEOMETRY display option may reduce the performance of
the display (or initial update of the display).
2:7
12.0
2:8
12.0
Quick Reference
A:1
12.0
A:2
12.0
Index
Symbols
DRIVERVERSION . . . . . . . . . . . . . . . . . 2:2
{in} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:6
{len} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:7
{n} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:7
{out} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:6
{pos} . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:7
{type} . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:6
{view} . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:6
E
EXACTGEOMETRY . . . . . . . . . . . . . . . . 2:7
EXPANDCELLS . . . . . . . . . . . . . . . . . . . 2:7
External Geometry Element . . . . . . . . . . 2:3
FBCLIPPING . . . . . . . . . . . . . . . . . . . . . 2:2
Flexman . . . . . . . . . . . . . . . . . . . . . . . . . 1:1
HIGHLIGHTREGIONS . . . . . . . . . . . . . . 2:2
B
BANNER . . . . . . . . . . . . . . . . . . . . . . . . . 2:2
C
CELLS . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:7
Clash Testing . . . . . . . . . . . . . . . . . . . . . 2:7
CLASHVOLUMES . . . . . . . . . . . . . . . . . 2:2
Commands . . . . . . . . . . . . . . . . . . . . . . . 2:1
COUNT . . . . . . . . . . . . . . . . . . . . . . . . . . 2:7
D
DESI . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:3
DISPLAY . . . . . . . . . . . . . . . . . . . . . . . . . 2:7
Driver . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:1
Driver Attributes . . . . . . . . . . . . . . . . . . . 2:1
Driver Extensions . . . . . . . . . . . . . . . . . . 2:5
I
Importing Models . . . . . . . . . . . . . . . . . .
Installation . . . . . . . . . . . . . . . . . . . . . . .
Introduction . . . . . . . . . . . . . . . . . . . . . .
Introduction#_Introduction . . . . . . . . . . .
2:4
1:1
1:1
1:1
L
LAST ERRORMESSAGE . . . . . . . . . . .
Licensing . . . . . . . . . . . . . . . . . . . . . . . .
LMI . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
LOWRESEVERYWHERE . . . . . . . . . . .
2:2
2:6
2:1
2:2
M
Manipulating Views . . . . . . . . . . . . . . . . 2:6
MAXIMUM MODELS . . . . . . . . . . . . . . . 2:2
Index page 1
12.0
O
Opening . . . . . . . . . . . . . . . . . . . . . . . . . 2:3
R
REGIONSOFINTEREST . . . . . . . . . . . . . 2:2
REMAP . . . . . . . . . . . . . . . . . . . . . . . . . . 2:4
RENDERFAST . . . . . . . . . . . . . . . . . . . . 2:2
T
TEST . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:7
TESTGEOMETRYEXACT . . . . . . . . . . . 2:3
TESTVOLUMEFAST . . . . . . . . . . . . . . . 2:3
TIGHTBOXES . . . . . . . . . . . . . . . . . . . . . 2:7
V
VENID . . . . . . . . . . . . . . . . . . . . . . . 2:3, 2:4
VIEWQUALITY . . . . . . . . . . . . . . . . . . . . 2:2
X
XCELL . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:3
XCELS . . . . . . . . . . . . . . . . . . . . . . . . . . 2:3
XCLTN . . . . . . . . . . . . . . . . . . . . . . . . . . 2:3
XGEOM . . . . . . . . . . . . . . . . . . . . . . 2:3, 2:7
Index page 2
12.0