===============
contoursFromDir
===============



.. contents:: Table of Contents
   :backlinks: top


------------
Introduction
------------


Loops through source directory inspecting all .msr files for shells
elements (surfaces and solids). If shell elements are found, contours
them into new cooresponding objects in target directory.  If successful,
for each object with shells in source directory, there will be an object
with groups of contours, one group for each shell element, in target
directory.
  
This script must be run from MS3D.  (because there is no stand-alone
contouring engine)   

There is an option to constrain to polygon. The bounding polygon can be
selected from the MS3D screen or from an msr that contains only one
polygon.

New geometry objects are assigned the same material as the source
objects and new polylines (contours) are assigned the same name and
material as the original shell element.

Response file, named 'scriptName'.ini is read to populate initial
values. If the .ini file does not exist, default initial values are
used.

Prints an audit, including parameters used to contour, to MS3D message
window, which is mirrored in msaudit.txt.           
           
Target directory will need DataManager refresh to see new objects after
the script processing completes.

The search tree for selecting source directory is _msresources of
current project. 

The script supports multiple runs, ie: after one directory is processed,
another directory can be selected and processed. 

::

           Target (Output contours) File Naming Convention:
           =============================================== 
            
              source:           target:
              pit3solid.msr --> con-pit3solid.msr
                  where "con" is TARGET_PREFIX
              If TARGET_PREFIX is not entered by user, "con-" is used    
              If target file already exists, it will be removed & recreated.
              If Prefix entered is empty or spaces, default prefix is used.
              
           Presents GUI
           ============

            Enter/Select:
             - Source directory full path (where .msr shell files are located)
               Source directory must exist. 
             - Target directory full path (where .msr contour files are put)
               If target directory does not exist, it will be created.
             - Start Elevation  (float)
             - End Elevation    (float)
             - Elev. increment  (float) 
             - Smooth contours with spline (true/false)
             - Nodes per segment - nodes to add (integer) [if smoothing]
             - Contour coincident faces and edges (true/false)
                  1 = exact contours (OK to contour along edges)
                  0 = not OK to contour along edges    
          

------------
Dependencies
------------

::

  Python: 2.2.[3-*]
  MineSight 3D: 3.50.*
  MineSight Grail: 3.50.*

----------------
Revision History
----------------

None.

-----------------
License Agreement
-----------------

The Original Code is contoursFromDir.py.

The Initial Developer of the Original Code is Leica Geosystems.
Portions created by Leica Geosystems are Copyright (C) 2014 year.
Leica Geosystems. All Rights Reserved.