ImPlant-STL Installation and User Guide.pdf

AVEVA ImPlant - STL

Installation and User Guide

DisclaimerInformation of a technical nature, and particulars of the product and its use, is given by AVEVASolutions Ltd and its subsidiaries without warranty. AVEVA Solutions Ltd and its subsidiaries disclaimany 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 orentity 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.

CopyrightCopyright and all other intellectual property rights in this manual and the associated software, and everypart of it (including source code, object code, any data contained in it, the manual and any otherdocumentation 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 inthis document is commercially sensitive, and shall not be copied, reproduced, stored in a retrievalsystem, or transmitted without the prior written permission of AVEVA Solutions Ltd. Where suchpermission is granted, it expressly requires that this Disclaimer and Copyright notice is prominentlydisplayed at the beginning of every copy that is made.

The manual and associated documentation may not be adapted, reproduced, or copied, in any materialor electronic form, without the prior written permission of AVEVA Solutions Ltd. The user may also notreverse engineer, decompile, copy, or adapt the associated software. Neither the whole, nor part of theproduct 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 bylaw. Any such unauthorised action is strictly prohibited, and may give rise to civil liabilities and criminalprosecution.

The AVEVA products described in this guide are to be installed and operated strictly in accordance withthe terms and conditions of the respective licence agreements, and in accordance with the relevantUser Documentation. Unauthorised or unlicensed use of the product is strictly prohibited.

First published September 2007

© AVEVA Solutions Ltd, and its subsidiaries 2007

AVEVA Solutions Ltd, High Cross, Madingley Road, Cambridge, CB3 0HB, United Kingdom

TrademarksAVEVA and Tribon are registered trademarks of AVEVA Solutions Ltd or its subsidiaries. Unauthoriseduse of the AVEVA or Tribon trademarks is strictly forbidden.

AVEVA product names are trademarks or registered trademarks of AVEVA Solutions Ltd or itssubsidiaries, 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 orlogo belongs to its respective owner.

AVEVA Solutions Ltd

AVEVA ImPLANT-STL Installation and User Guide

Contents Page


AVEVA ImPlant - STLIntroduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1General . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1Input to ImPlant - STL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1Output from ImPlant - STL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1Compatibility with DESIGN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:2Solid Polyhedron Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:2

How this Guide is Organised . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:2

Installing ImPlant - STL. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:1Basic Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:1NET Framework Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:1Flexman License Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:1Running in a Command Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:2Electronic Manuals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:2

Testing your ImPlant - STL Installation. . . . . . . . . . . . . . . . . . . . . . . 3:1General . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:1Running and Checking the Test . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:1

Using ImPlant - STL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:1Modes of Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:1ImPlant - STL User Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:1

12.0© 2007 AVEVA Solutions Ltd i


More >> Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:4

Interactive Mode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:6Batch Mode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:6Running the Macro File into DESIGN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:8

Controlling the Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:1Translation Process. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:1Controlling the Quantity of STL Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:2Controlling the Quality of STL Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:2Controlling the DESIGN Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:3Reviewing and Improving the DESIGN Model . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:3Typical STL Files and Resultant Models . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:4

STL Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:1Mechanical CAD Systems and STL File Production. . . . . . . . . . . . . . . . . . . . . . 6:1Units and Scalar Factors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:2

Macro Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:1General . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:1Data Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:1Geometry Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:1

Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8:1

Error Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9:1System Errors. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9:1Licensing Errors. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9:1Parameter Setting Errors. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9:1File Access Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9:2Data Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9:2Data Processing Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9:2

Limitations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:1

12.0© 2007 AVEVA Solutions Ltd ii

AVEVA ImPLANT-STL Installation and User GuideIntroduction

1 Introduction

STL format provides an approximation of a curved surface model, with accuracy and level ofdetail controlled through a tolerance setting. ImPlant - STL maps this format onto AVEVA 3Dprimitives. Hence a 100% accurate translation of the source model into PDMS or Outfittinggeometry cannot be guaranteed.

1.1 GeneralAVEVA ImPlant - STL is a standalone program for translating stereolithography (STL) files,that have been generated from non-AVEVA Mechanical CAD systems, into macro files thatcan be input to AVEVA PDMS or AVEVA Marine Outfitting.

ImPlant - STL is available for the Windows XP platform.

To operate, AVEVA software must be able to access the correct Flexman 3.1 licence file,which should be installed on either the Server, on your workstation, or on a networkedworkstation.

Note: Although the disk may contain several AVEVA products, you will only be able to usethe items that are licensed to you.

1.2 Input to ImPlant - STLThe input to ImPlant - STL consists of STL files generated from/by non-AVEVA MechanicalCAD systems. Some non-AVEVA Mechanical CAD systems have an inbuilt facility forgenerating STL files, others do not, and the generation of STL files from these systemsinvolves the use of a separate translator program, such as CADfix® from ITI TranscenData(http://www.transcendata.com).

The STL files will normally have the extension .stl and can be either ASCII or binary informat. ImPlant - STL reads both ASCII and binary STL files.

The ImPlant - STL program works in read-only mode and the original STL files will not bechanged in any way.

1.3 Output from ImPlant - STLThe output from ImPlant - STL consists of an ASCII format macro file that is suitable forinput to DESIGN. The format of the output file means that the program does not create anydatabases within DESIGN.

12.0© 2007 AVEVA Solutions Ltd 1:1

AVEVA ImPLANT-STL Installation and User GuideIntroduction

1.4 Compatibility with DESIGNThe files generated by ImPlant - STL are compatible with all versions of DESIGN fromPDMS 11.2 upwards, and from AVEVA Marine Outfitting Version 12.0. PDMS/Outfitting doesnot need to be installed on the machine running ImPlant - STL.

Note: If Solid Polyhedra are used (see below) the macro file will not load in a version ofDESIGN that is not solid polyhedra enabled (PDMS 11.3 and older)

1.4.1 Solid Polyhedron DefinitionThe definition of the Solid Polyhedron is a set of faces that have to make a complete solid, ieall edges of the faces have to have corresponding edges from other faces. The SolidPolyhedron has the following characteristics:

1. It is more economical to store in DESIGN databases than a corresponding POHE/POGO arrangement.

2. It is faster to manipulate in the DESIGN module.3. The clash detection is better than POHE/POGO because it can detect parts that are

completely inside the polyhedron.4. It allows the use of 'invisible edges'. This is a facility that:

1. Edges are not displayed in wireline mode in DESIGN.2. In colour-shaded mode in DESIGN the parts are displayed with smooth shading

between faces that share invisible edges.3. Drawings produced using the DRAFT module show the visible edges and any

silhouette edges only.

By default Solid Polyhedron generation is switched on. See Section 5: Using ImPlant - I formore detailed descriptions of all available settings and switches

1.5 How this Guide is OrganisedThis guide is divided into chapters as follows:

Installing ImPlant - STL explains the installation procedure.

Testing your ImPlant -STL Installation

explains the test procedure to be carried out after installation.

Controlling the Process explains controlling processes.

Using ImPlant - STL explains how to use Implant - STL

STL Input explains STL input.

Macro Output explains Macro Output.

Reports explains Reports.

Error Messages displays a list of errors.

Limitations explains the limitations of ImPlant - STL


AVEVA ImPLANT-STL Installation and User GuideInstalling ImPlant - STL

2 Installing ImPlant - STL

2.1 Basic InstallationAVEVA ImPlant - STL 1.2 is supplied on DVD or CD. The disk contains the installer, and aninstallable version of Microsoft's .NET 2.0. Also on the disk is a folder containing theInstallation instructions and user documentation, and it is recommended that you carefullyread all of the Installation instructions before installing the software.

To install ImPlant - STL first insert the disk in your Workstation's DVD drive, click forContents, then select a product, and then follow the Installer instructions.

If the disk does not start, click Start>Run, and then browse for the Start.htm file.

During the installation sequence, follow the on-screen instructions as they appear. You willbe given a choice between two levels of installation:

• Standard installationInstalls all available product components in the default location.

• Advanced installation

Presents you with a list of all available product components from which you can select thoseto be installed, and allows you to choose the Installation folder.

It is recommended that you use the default settings for folder paths etc. unless you havegood reasons for doing otherwise.

Note that the default installation disk is the largest disk, and this is not always appropriate.This can be checked an changed by clicking the Advanced button on the installer.

The process needs at least 4Mb of free disk space for a full installation of all options.

When the process is complete, select Start>All Programs>AVEVA>AVEVA ImpLANT-STL1.2 to reach the program and this documentation.

Note: If the installer detects an existing ImPlant - STL installation, it will display a set ofoptions for modifying/repairing/removing these existing files in place of the standardinstallation options.

2.2 NET Framework InstallationImPlant - STL requires that Microsoft's .NET Framework 2.0 be installed. If the installer isstarted from setup.exe, then the .NET Framework is installed automatically, if required.

2.3 Flexman License ManagerYou must install and set up the Flexman license system before launching the installedsoftware. This will usually be done only on the server. Please see the Flexman 3.1.SP1


AVEVA ImPLANT-STL Installation and User GuideInstalling ImPlant - STL

Installation and Configuration Guide. News and update information is also available forFlexman on the AVEVA support web-site.

2.4 Running in a Command WindowIn order to make ImPlant - STL available as a command in a command window, the AVEVAImPlant - STL installation folder may be added to the PATH environment variable. Fordetailed instructions on how to do this refer to Windows Help.

2.5 Electronic ManualsElectronic versions of the ImPlant - STL Manuals are available on the CD-ROM/DVD as.pdf files. In order to display these Manuals you must have the Adobe Acrobat Readersoftware installed on your PC. This software is also included on the CD-ROM/DVD.Installing this software will enable you to view and print the ImPlant - STL Manuals.


AVEVA ImPLANT-STL Installation and User GuideTesting your ImPlant - STL Installation

3 Testing your ImPlant - STL Installation

3.1 GeneralThe following test procedure should be carried out after installing AVEVA ImPlant - STL tomake sure that the installation is complete and correct. The test material is stored in thesubdirectory test. This comprises a single .stl file called slide_gate1.stl.

3.2 Running and Checking the Test

STEP 1 Start up the ImPlant - STL program by executing the following:

Start>All Programs>AVEVA>ImPLANT-STL 1.2>ImPLANT-STL Dialog

STEP 2 On the User Interface enter or select, using the browser, the name of the testSTL file - typically:

C:\AVEVA\ImPLANT-STL1.2\test\slide_gate1.stl

STEP 3 On the User Interface set the STL Mode field to Binary.

STEP 4 On the User Interface, click on the Create button to start the translationprocess. If the installation has been successful the following message willappear in the box at the bottom of the form:

AVEVA ImPLANT-STL REPORT

------------------------

Date of run: Mon Jun 02 23:17:08 2008

Input StereoLithography Binary file: C:\AVEVA\ImPLANT-STL1.2\Test\slide_gate1.stl

Output PDMS macro : C:\AVEVA\ImPLANT-STL1.2\Test\slide_gate1.mac

Solid polyhedra are created


AVEVA ImPLANT-STL Installation and User GuideTesting your ImPlant - STL Installation

Primitives Processed

--------------------

Number of faces read is 5380

Number of primitives recognised is 40

Number of Solid Shells is 15

Number of Boxes is 2

Number of Extrusions is 14

Number of Cylinders is 9

The smallest hole diameter exported is: 10

This will create a DESIGN macro file called slide_gate1.mac in the test directory (if thisdirectory is writable - if it is not you can choose another outpout location).

STEP 5 When the process is complete click on the Exit button.


AVEVA ImPLANT-STL Installation and User GuideUsing ImPlant - STL

4 Using ImPlant - STL

4.1 Modes of OperationImPlant - STL has two modes of operation:

• interactive mode• batch mode

In the interactive mode you input your requirements to the ImPlant - STL program via theuser interface.

In the batch mode you input your requirements to the ImPlant - STL program via a batch(.bat) file.

The normal mode of operation is the interactive mode.

4.2 ImPlant - STL User Interface

Figure 4:1. ImPlant - STL User Interface - Basic Dialog Box

The default ImPlant - STL dialog box is shown in Figure 5-1 and comprises the followingsections/fields and buttons:



The Input File, PDMS Macro File and Report File sections also contain browser buttons

( ). This is to enable you to browse and select file locations and names. Thismay be a simpler way to specify a particular location and filename where the full path andfilename is a complex string.

Default locationscheckbox

If checked, the locations of the macro file and the Report File willautomatically be set to being at the same location as the input STLFile. Note the when this option is checked, the user is no longerallowed to select or modify Locations for either the Macro orReport files manually.

Default filenamescheckbox

If checked, the filenames of the Macro file and the Report file willautomatically become the same as the input STL file but with .macand .log extensions, respectively. Note the when this option ischecked, the user is no longer allowed to select or modifyFilenames for either the Macro or Report files manually.

Input File Section

Select STL file this field is used to specify the full path and filename of theSTL file to be translated.

STL Mode this field is used to specify the format of the STL file, ASCIIor Binary. ASCII is the default value of this field.

Destination Section

PDMS Macro File This field is split into two sections; the Location andFilename. If a location is not a valid the last valid locationwill automatically replace the location that was entered.(This macro file is compatible with outfitting, as well asPDMS)

Report File Again, this section has separate location/file sections and isused to select where ImPlant - STL should create its' log fileand the name of the file.

PDMS Model Section

Holes this field is used to set how the ImPlant - STL program dealswith holes. The options are:

On the default value for this field. Where the program finds holesin objects in the STL file, corresponding negative primitives(holes) are generated in the MAC file.

Off when this option is selected, where the program finds holes inobjects in the STL file, these are all ignored and no holes aregenerated in the MAC file.



<Diameter> when this option is selected, you are able to specify themaximum size of hole that is to be translated as a hole.Where the program finds holes in objects in the STL file witha diameter smaller than the value entered, these are ignoredand corresponding holes are not generated in the MAC file.Where the program finds holes in objects in the STL file witha diameter equal to or greater than the value entered,corresponding holes are generated in the MAC file.

Scale factor this field is used to specify an enlargement or reduction factorthat the ImPLANT?STL program is to apply. The default valuefor this field is 1.0.

Note: Within the ImPlant - STL program there is no concept of units. During thetranslation process the ImPlant - STL program maintains the physicalrelationships of objects in the STL file, resultant primitives in the MAC file aretherefore of the same relative size. If the units used in the originating program,from which the STL file was generated, are known, the Scale factor field can beused to scale up or down the resultant MAC file objects to suit the DESIGNproject units.

Create button Clicking on this button initiates the translation process withinthe ImPlant - STL program.

Exit button Clicking on this button closes the user interface andterminates the ImPlant - STL program.

Output Summary This is the area to the right of the setup window and is usedfor displaying messages and status reports when translatinga file

Hide Output Summary Use this button to show/hide the Output Summary display

More >> clicking on this button calls up additional 'advanced'parameter options, shown in Figure 5-2.



4.2.1 More >> Options

Figure 4:2. ImPlant - STL User Interface-Advanced Dialog Box

When More >> is selected, additional fields become available to the user in the PDMSModel section:

Min. sides per cylinder this field is used to specify the minimum number of sidesrequired in order for the program to recognise and map acylinder. The program determines that an object is acylinder by inference, it actually detects a cylinder as anextrusion having a circular profile. The circular profile ismapped by intersecting vertices, and the value set in thisfield represents the minimum number of intersectingvertices that the program is required to use to map a circularprofile.

Compressed Geometry this field is used to set how the ImPlant - STL program is todeal with coplanar faces. The options are:

On the default value for this field. With this option selected theprogram combines coplanar faces with shared edges intobigger faces. It also maps geometric solids into PDMSprimitives. This option produces the smallest resultant MACfile.



Off when off, the program does not combine coplanar faceswith shared edges into bigger faces and does not mapgeometric solids into primitives. This option produces amuch larger MAC file than the when CompressedGeometry is switched on.

Wrapper this field is used to set how the program is to treat objectswith internal parts. The options are:

On with this option selected the program creates a wrapperaround all solid parts. It will then remove from the MAC fileany parts that are wholly inside other parts. Internal featurescreated by solid parts overlapping are also removed fromthe MAC file. This option is useful if the STL file containsparts that have lots of internal parts that can be recognisedby ImPlant - STL as solids.

Off the default value for this field. With this option selected theprogram does not perform the wrapping operation.

Solid polyhedron This field is used to set how the program is to map solidparts to PDMS/Outfitting. The options are:

On With this option selected the program creates solidpolyhedra for solid parts that can not be mapped ontoBoxes, Cylinders and other PDMS primitives. This is thedefault value

Off With this option selected the program does not create solidpolyhedra but maps these parts to POHE/POGO.

Edge visibility This field is used to set the mode by which the program canset edges to be visible or invisible. The options are:

On The default value for this field. With this option selected theprogram sets all edges to be visible.

Off With this option selected the program sets all edges to beinvisible.

Angle > With this option selected you can set an angle by which theprogram computes if an edge will become visible orinvisible. The default value is set to 60 degrees. If the angleis greater than the angle between the normals of the twofaces that share an edge then the edge becomes invisibleotherwise it will become visible.

Create VOLM element This option allows the output primitives in the Macro file tobe created under a VOLM element rather than an EQUI

The options are:

On Create output primitives under a VOLM element



4.3 Interactive ModeThe following procedure represents the minimum interaction that is required in order togenerate a macro file from an STL file.

The above procedure will create one or more macro files suitable for input to DESIGN. Eachof the macro files will by default have the same root name as the associated originating STLfile, with the extension of .mac.

In addition, there will be also be a report file (log) created for each translation file operation.Each of the report files will by default have the same root name as the associated originatingSTL file, with the extension of .log.

All file names are validated by the ImPlant - STL program prior to the translation operationstarting. You can rename the macro files and report files using Windows Explorer.

4.4 Batch ModeImPlant - STL may be run from a a command window, or from a batch file - allowing multipleSTL files to be translated into macro files in the background.

In order to run ImPlant - STL from a batch file it is first necessary to create a batch (.bat) filecontaining the instructions to initiate the ImPlant - STL program and also the options toapply to the program. The options available are described in more detail in ImPlant - STLUser Interface.

The format of the batch file is shown below:

ImPLANT-STL.exe <stl_filename> [-b] [-o <output_filename>] -r <report_filename>][-w] [-t] [-h holes_diameter>] [-c <cylinder_sides>] [-s <scale_factor>] [-spoff][-i <invisibility_angle>] [-volm] [-?]

where:

Off Create output primitives under a EQUI element. This is thedefault.

<< Less clicking on this button removed the 'advanced' options fromthe display.

STEP 1 Start up the ImPlant - STL program by executing the following:

Start>All Programs>AVEVA>AVEVA ImPLANT-STL 1.2>ImPLANT-SDialog

STEP 2 Enter or select, using the browser, the name of the STL file to be translated.

STEP 3 Specify whether the STL file is in ASCII or binary format.

STEP 4 Click on the Create button to start the translation process.

STEP 5 Repeat STEPS 2 to 4 for each STL file that is to be translated. Click the Exitbutton to terminate the ImPlant - STL program.

<stl_filename> is the filename of the input STL file.



The options to be applied are included in the batch file in the form of command lineswitches, where:

-b indicates that the input STL file is a binary file. If this switchis not used the program uses the default value, in this caseASCII.

-o <output_filename> indicates that the following filename is to be used for theoutput MAC file. If this switch is not used the program usesthe default value which is the same root as the input STL filewith the extension .mac.

-r <report_filename> indicates that <report_filename> is to be used for the reportor log file. If this switch is not used the program uses thedefault value which is the same root as the input STL filewith the extension .log.

-w indicates that the Wrapper option is to be used. If thisswitch is not used the program does not apply the Wrapper.

-t indicates that the Geometry option is to be set toUncompressed. If this switch is not used the program willuse the default value, Compressed.

-h <holes_diameter> indicates that holes are to be translated and that<holes_diameter> is to be applied as the minimum size ofhole that is to be translated, ie holes with a diameter of lessthan the value specified will be ignored. If <holes_diameter>is set to -1.0 then all holes will be ignored.

-c <cylinder_sides> indicates the minimum number <cylinder_sides> of sides tobe used to recognise and map cylinders or negativecylinders. The default value is 6.

-s <scale_factor> indicates that the following <scale_factor> is to be appliedduring the translation in order to enlarge or reduce theresultant model in the MAC file.

-spoff indicates that solid polyhedra should not be created

-i <invisibility_angle> indicates that <invisibility_angle> is to be applied to decide ifan edge is visible or invisible when a Solid Polyhedron iscreated. If the angle given is greater than the angle betweenthe normals of the two faces that share the edge then theedge becomes invisible, otherwise it will become visible.

-volm indicates that all elements in the macro file should becreated under VOLM elements instead of EQUI

-dpdms113 indicates that solid polyhedra are to be created. This is nowobsolete as solid polyhedra are created by default

-d <directory_path> this option can be used to translate every stl file in aspecified directory <directory_path>.

-? Help



Several STL input files may be processed at once if you create a batch file with a series ofImPlant - STL commands, or use the -d option.

4.5 Running the Macro File into DESIGNThe output from ImPlant - STL is a macro file, ready to be read into the DESIGN mode ofPDMS or Outfitting. This is done using the following procedure:

Large MAC files should be read into DESIGN by entering DESIGN in 'dev tty' mode andentering the command 'trace off' before the read command.

Reading in the macro may take some time, especially with large files.

STEP 1 Start up DESIGN and make sure that the database is at the appropriateZONE level.

STEP 2 Read in each MAC file as:

$m <filename>


AVEVA ImPLANT-STL Installation and User GuideControlling the Process

5 Controlling the Process

5.1 Translation ProcessWithin the STL format all objects are represented by triangles, the triangle being the shapewith the minimum number of sides that can be used to represent a three-dimensional object.Unfortunately, reducing a shape to triangles increases the quantity of electronic datanecessary to define the shape. For example, a square drawn in a CAD system is defined byits four corners or vertices. The same square in STL format is represented by two triangles,each triangle having three vertices, totalling six vertices, representing a 50% increase indata needed to define the square.

Figure 5:1. Data Volume Comparison

Taking this analogy a step further, a cube within a CAD system is defined by its eightvertices. The surface of the same cube in STL format is represented by 12 triangles, two foreach of the six faces of the cube, each triangle having three vertices, totalling 36 vertices.This represents a 450% increase in data needed to define the cube.

Shapes within a CAD system more complex than a cube result in even greater dataincrease factors. It can therefore be seen that STL files can be very large in terms of datavolume or file size. This has two main effects:

• Large STL files may take several hours to map into DESIGN.• Highly detailed models in PDMS/Outfitting may drag down the performance of the

computer and will be slow to manipulate.

It is very important that the detail in the source CAD file used to generate the STL file andthe amount of detail required in the PDMS/Outfitting Model should be considered verycarefully.



It is impossible to give any definite instructions as to what should be done as there are toomany possible combinations of source CAD systems and PDMS/Outfitting DESIGN modeluses to define parameters for. The most suitable combination of parameters and settings isbest determined by trial and error, however, the following guidelines may be useful:

• control the quantity of STL data• control the quality of STL data• control the DESIGN model• review and improve the DESIGN model.

5.2 Controlling the Quantity of STL DataAVEVA ImPlant - STL processes STL data intelligently, attempting to recognise groups oftriangular facets that equate to particular standard shapes defined in PDMS/Outfitting asprimitives (box/cylinder/pyramid/extrusions and negative versions of these). Facet data thatcannot be mapped to any of these primitives is dealt with by creating the facets as POHE(polyhedron) primitives, a less efficient form of handling the data. If, however, the 'solidpolyhedron' mode is used (see below) and ImPlant - STL recognises a solid then this ismore efficient.

A good indicator of a successful operation using ImPlant - STL is the quantity of POHEprimitives within the resultant model. The fewer the number of POHEs the easier it is tomanipulate the data in DESIGN and drafting modules.

There are therefore two factors that directly affect the performance of model manipulation inDESIGN. These are:

• The ability of ImPlant - STL to recognise and map triangular facet groups to PDMSprimitives.

• The quantity of data to be translated.

It is a good working practice to minimise the amount of data that needs to be translated; thiscan be done by applying the following guidelines:

• Remove all non-essential aspects of the source model, eg in the case of a gearbox,export the gearbox casing but not the gearbox internals.

• Remove or disable features in the originating Mechanical CAD System thatautomatically generate many curved surfaces, such as fillets and chamfers. SomeMechanical CAD Systems allow these features to be disabled temporarily, while theexport to STL file operation is in progress.

• Use an appropriate tolerance setting when exporting to the STL file. It is impossible tostipulate an exact tolerance setting since this depends very much upon yourrequirements for the DESIGN model. The looser the tolerance factor setting the lessaccurate will be the resultant model and vice versa. The recommended approach is tostart with a loose tolerance setting, inspect the resultant model, and re-import all orpart of the model at a tighter tolerance setting, as necessary.

5.3 Controlling the Quality of STL DataThe integrity of the source model has a direct bearing on the quality of the data producedduring an STL export operation. For example, if a solid in the original model is not properlyclosed prior to being exported, then ImPlant - STL will not recognise the resultant triangularfacet group as a single primitive and will map the solid inefficiently with POHE primitives.Most Mechanical CAD Systems have a healing facility that will process the model and checkit for inconsistencies such as solids that are not properly closed. It is therefore strongly



recommended that source models are healed in their originating Mechanical CAD Systemprior to the data being exported in STL format. Where the Mechanical CAD System does nothave this facility, another application such as CADfix may be used to provide the healingfunction and to carry out the export to STL format.

The STL format is an approximation of a curved surface model, the accuracy and level ofdetail of which may be controlled through tolerance setting. A balance must be struckbetween too great and too low tolerance settings. This can be done by reviewing and wherenecessary improving the model created.

• Too great a tolerance setting may result in errors in the STL file.• Too low a tolerance setting may result in the STL translation operation failing, eg where

holes are located close to the edge of a solid.

5.4 Controlling the DESIGN ModelIf you are aware that holes below a certain diameter need not be transferred to the modelthen the option to remove these holes should be selected. For example, you may choose toremove bolt-holes. This may enable ImPlant - STL to recognise and map more parts toprimitives, making it easier to manipulate the model. There may be occasions, however,when ImPlant - STL cannot remove the holes in a part because in doing so it wouldinvalidate the part.

You can obtain the value of the minimum hole size that has been exported by viewing theImPlant - STL report. You can then use a higher value than this to remove these holes andre-run the export operation through ImPlant - STL to review the changes this makes to themodel.

The Wrapper option should be used only when you are sure that most or all solid parts areinside other parts and can therefore be removed without affecting the appearance of themodel. If the Wrapper option is used when this is not the case, then the resultant modelmay be too difficult to manipulate. This is due to the fact that Wrapping prevents anyprimitive recognition, increasing the amount of data that has to be transferred.

5.5 Reviewing and Improving the DESIGN ModelThe extent to which the resultant imported model may require to be modified dependsentirely upon your end requirements. A crude representation may be sufficient for spacemanagement or clash checking purposes, whereas a highly detailed model is required forrealistic visualisation. Alternatively, if the intention is to actively work on and manipulate theimported data, then an efficient and compact data structure is of paramount importance.Whatever the intention it is best to review the DESIGN model. The review can range from asuperficial visual check to a detailed scrutiny of the graphics and database hierarchy.

Reviewing the model allows you to:• verify that the level of detail in the model is sufficient for your purposes• identify areas where the data structure could be improved• identify any problem areas

If the model is generated through ImPlant - STL with a loose tolerance setting, the modelneeds to be checked visually to locate errors due to failings in the STL export process.Identified problem areas can then be re-exported at a higher tolerance setting. If this doesnot correct the errors or there is geometry missing from the model, then there may be faultswith the source model. In this case check that the source model has been healed prior toexport.



If the model is visually acceptable but is slow to manipulate it should be checked to see ifthere are any areas where geometry can be remodelled more efficiently using fewerprimitives. Viewing the model in wireline mode will effectively display areas that are denselypacked with POHE primitives, ie areas where it has not been possible for ImPlant - STL togenerate a more efficient representation based on primitives.

5.6 Typical STL Files and Resultant ModelsThe following Figures are examples of typical STL files and the models resulting from theirimport into PDMS/Outfitting with various option changes in ImPlant - STL.

Figures 4-2 to 4-5 are examples of a model generated from a Pro/ENGINEER source file.

Figure 5:2. Original Model as Triangles

Figure 5:3. Solid Model with All Holes Translated



Figure 5:4. Solid Model with Holes Smaller than 40 mm Diameter Removed

Figure 5:5. Solid Model with All Holes Removed

Figures 4-6 to 4-8 are examples of a Model generated from a CATIA source file.



Figure 5:6. Original Model as Triangles

Figure 5:7. Solid Model with All Holes Translated



Figure 5:8. Solid Model with All Holes Removed




AVEVA ImPLANT-STL Installation and User GuideSTL Input

6 STL Input

6.1 Mechanical CAD Systems and STL File ProductionImPlant - STL addresses the problem of transferring 3D model data from Mechanical CADSystems to PDMS, where the model can be manipulated more easily in the DESIGNmodule and drawings can be produced via the DRAFT module. Popular Mechanical CADSystems include:

CATIA

Pro/ENGINEER

I-DEAS

SolidWorks

ACIS based systems

Parasolid based systems

Unigraphics

Solid Edge

CADAM

ROBCAD

CADDS5

AutoCAD.

The output files from some other popular Mechanical CAD Systems, such as Microstation,may be imported into DESIGN using product specific translators.

Most of these Mechanical CAD Systems have the capability to export files in the STL formatdirect or some other standard format or CAD native format such as IGES, STEP AP203/AP214, etc. Translator programs are available which can read these other export fileformats and generate STL files. One such Translator Program is CADfix from ITITranscenData. The possible routes to generating STL files are shown in below.


AVEVA ImPLANT-STL Installation and User GuideSTL Input

Figure 6:1. STL File Input to ImPlant - STL

The method of production of the STL files is an important factor in minimising the volume ofdata that needs to be transferred. Applying the following factors will help to reduce thevolume of data:

• All curved parts are approximated as planar faces (triangles) in the process of beingexported to the STL file. All STL translator programs offer an approximation/tolerancefactor to achieve this. It is very important to control the number of triangles produced,keeping these to the minimum to produce an acceptable model in DESIGN.

• All parts of the model that are not essential should be excluded from the transfer, inparticular any internal parts that will not be used in PDMS.

• Many features, such as chamfers, are not needed in PDMS and these also should beexcluded from the transfer.

6.2 Units and Scalar FactorsWithin STL there is no concept of units and therefore ImPlant - STL generates macro fileswith no reference to any units. The translation operation maintains the physical size of partsas they were in the originating program.

The size of the parts as they appear in PDMS/Outfitting can be adjusted by applying a scalefactor to the STL file within ImPlant - STL.


AVEVA ImPLANT-STL Installation and User GuideMacro Output

7 Macro Output

7.1 GeneralThe data output from ImPlant - STL is presented in the form of a macro file that can be readinto DESIGN in order to create the corresponding primitives and associated hierarchy.

7.2 Data StructureWhen an STL file is translated into a MAC file and this is read into PDMS/Outfitting, allgeometric parts are converted to primitives which form a single EQUIPMENT or VOLUME(VOLM) per STL file. ImPlant - STL uses the name from the MAC file as the EQUIPMENT(or VOLM) name.

7.2.1 Geometry HierarchyIf a BOX, PYRAMID, CYLINDER or EXTRUSION is recognised by ImPlant - STL, thenthese primitives are added to the EQUIPMENT or VOLM element. Negative primitives areadded below these primitives.

Any Solid Polyhedron (POLYHE) elements are also created directly under the EQUIPMENTor VOLM element.

Any other closed volumes that are not recognised as being any of the above PDMSprimitive types are added to the EQUIPMENT (or VOLM) element as a SUBEQUIPMENT(or SVOLM). Each face with one or more holes in it is represented as an EXTRUSION witheach hole represented by a NEXTRUSION. All remaining faces, with no holes, arerepresented by PDMS POHEs, each face of a POHE being represented by a single POGO(polygon) element. The POHEs are added under the SUBEQUIPMENT.

All non-closed volumes are split into non-manifold surfaces. Each non-manifold surface isthen treated as a closed volume as detailed previously.

The geometry hierarchy is as shown in Figure 7-1.


AVEVA ImPLANT-STL Installation and User GuideMacro Output

Figure 7:1. PDMS Geometry Hierarchy


AVEVA ImPLANT-STL Installation and User GuideReports

8 Reports

The standard report or log generated by ImPlant - STL following a translation operationprovides the following information:

• a count of the primitives found and translated• a list of errors or warnings

An example of a report is given below:

AVEVA ImPLANT-STL REPORT

------------------------

Date of run: Wed May 14 10:18:37 2008

Input StereoLithography file: C:\AVEVA\ImPLANT-STL1.2.0\test\slide_gate1.stl

Output PDMS Design macro file: C:\AVEVA\ImPLANT-STL1.2.0\Macros\slide_gate1.mac

Solid polyhedra are created

Primitives Processed

--------------------

Number of faces read is 5380

Number of primitives recognised is 40

Number of Solid Shells is 15

Number of Boxes is 2

Number of Extrusions is 14

Number of Cylinders is 9

The smallest hole diameter exported is: 10


AVEVA ImPLANT-STL Installation and User GuideReports


AVEVA ImPLANT-STL Installation and User GuideError Messages

9 Error Messages

9.1 System ErrorsThese errors indicate that there is something wrong with the ImPlant - STL programinstallation. In the first instance try re-installing the program.

Process cannot be initialised - check installation

Cannot find process for ImPlant - STL user interface - check installation

9.2 Licensing ErrorsEither you do not have a valid license for the product, or all your licenses are in use.

***** FATAL SITEFILE ERROR *****

Please contact your AVEVA Support representative

Cannot get license for this version, error =

** Warning **: PDMS ImPlant - STL license expires in %d days

9.3 Parameter Setting ErrorsThe following errors may appear when operating ImPlant - STL in Interactive Mode:

Must provide a file name for STL file input

Must provide a file name for PDMS Macro output

You have not provided a report filename

Output file has same name as STL file input

Report file has same name as STL file input

Diameter must be a value >0.0

Scalar factor must be a value >0.0

Number of cylinder sides must be an integer >=3

The following errors may appear when operating ImPlant - STL in batch mode:

**Warning**: No scale factor for -s argument

**Warning**: Invalid scale factor for -s argument: <value>

**Warning**: No argument for output file name

**Warning**: Invalid name for -o argument: <name>


AVEVA ImPLANT-STL Installation and User GuideError Messages

**Warning**: No argument for report file name

**Warning**: Invalid name for -r argument: <name>

**Warning**: No number for holes diameter argument

**Warning**: Invalid number for -h argument: <value>

**Warning**: No argument for sides in a cylinder

**Warning**: Invalid number for -c argument: <value>

**Warning**: Invalid number for -i argument: <value>

**Warning**: Unexpected argument: <text>

**Warning**: No Input File Name Supplied

9.4 File Access ErrorsEither you have not provided a filename where it is needed, or the file cannot be found, ordoes not have the correct access rights set.

**Warning**: Cannot open input STL file <name>

**Warning**: Cannot open output PDMS macro file <name>

9.5 Data Errors**Error**: Unexpected end of file <name>

**Error**: This file does not start with 'solid': It may not be an STL ASCII file

**Error**: Non-triangular facet(s) detected

**Error**: This File is incomplete (or not a binary file)

9.6 Data Processing Errors**Warning**: Wrapper failed

**Warning**: The wrapper model did not create a solid model

**Warning**: Object <n> has not been recognised as solid

**Warning**: No holes have been removed from primitive <n> because too many faces were to be removed


AVEVA ImPLANT-STL Installation and User GuideLimitations

10 Limitations

• ImPlant - STL is not capable of mapping all PDMS/Outfitting primitives. In particular itcannot map to Surfaces of Revolution.

• Occasionally ImPlant - STL does not recognise solid parts.• ImPlant - STL may fail when attempting to translate surfaces that overlap or are

duplicated for open skin surfaces.


AVEVA ImPLANT-STL Installation and User GuideLimitations


Index


CCommand Window

running in . . . . . . . . . . . . . . . . . . . . . 2:2Compatibility

with DESIGN . . . . . . . . . . . . . . . . . . 1:2

DDESIGN Model

Controlling . . . . . . . . . . . . . . . . . . . . 5:3reviewing and improving . . . . . . . . . . 5:3

EError Message

data . . . . . . . . . . . . . . . . . . . . . . . . . 9:2file access . . . . . . . . . . . . . . . . . . . . . 9:2licensing . . . . . . . . . . . . . . . . . . . . . . 9:1parameter setting . . . . . . . . . . . . . . . 9:1system . . . . . . . . . . . . . . . . . . . . . . . 9:1

FFlexman License Manager . . . . . . . . . . . 2:1

IImPlant - STL

using . . . . . . . . . . . . . . . . . . . . . . . . . 4:1Installation

basic . . . . . . . . . . . . . . . . . . . . . . . . . 2:1NET Framework . . . . . . . . . . . . . . . . 2:1test . . . . . . . . . . . . . . . . . . . . . . . . . . 3:1

MMode

batch . . . . . . . . . . . . . . . . . . . . . . . . 4:6interactive . . . . . . . . . . . . . . . . . . . . 4:6

Modes of Operation . . . . . . . . . . . . . . . . 4:1

OOutput

Macro . . . . . . . . . . . . . . . . . . . . . . . . 7:1

PProcess

controlling . . . . . . . . . . . . . . . . . . . . 5:1translation . . . . . . . . . . . . . . . . . . . . 5:1

RReports . . . . . . . . . . . . . . . . . . . . . . . . . . 8:1Resultant Models . . . . . . . . . . . . . . . . . . 5:4Running Macro File . . . . . . . . . . . . . . . . 4:8

SSolid Polyhedron

definition . . . . . . . . . . . . . . . . . . . . . 1:2STL

input . . . . . . . . . . . . . . . . . . . . . . . . . 6:1STL Data

Controlling the quality . . . . . . . . . . . 5:2Controlling the quantity . . . . . . . . . . 5:2

12.0© 2007 AVEVA Solutions Ltd Index page 1


TTest

runnning and checking . . . . . . . . . . . 3:1

12.0© 2007 AVEVA Solutions Ltd Index page 2

ImPlant-STL Installation and User Guide.pdf

Documents