========
ip-label
========



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


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


Default MineSight Interactive Planner (MSIP) Plotting Script.

Takes the cuts within a given cut design and generates labels based on
configuration parameters.  The attributes for a cut are generated via a
label and plotted in the center of the bounding box for the cut.  The
attributes displayed on the label are customizable via the following
configuration options.

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

::

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

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

28-Feb-2011 REF#8829 (ADF)
    - make breakout totals optional
    - add ability to print grade and tons for selected materials

07.10.2008, REF#8886
  - Set IS_CURRENT_CUT_ONLY = 0 as default

01.05.2007, REF#5191
 - Add swell factor options.

02.03.2006, REF#7128
 - Have 'Tons' or 'Tonnes' print by default by checking the IP imperial
   flag for metric or imperial projects.

02.03.2006, REF#6611
 - Reopened because the config options that were changed are not clearly
   documented in the script.

13.10.2006, REF#6611
 - Label alignment is now *more* correct.

13.10.2006, REF#6142
 -  Modify so no blank line when excluding stuff in label started with
    (4.00).

13.10.2006
 - Add equal sign to all Tons lines in ore,ox,met code.
 - Take out option for putting label at center of mass because it
   actually puts it at center of boundingbox & not used.

06.21.2006, REF#6138
 - Add user config for not/report waste tonnage.

06.21.2006, REF#6137
 - Use FORMAT_GRADE on ore grades.


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

The Original Code is "ip-label.py".

Copyright (C) 2014 Leica Geosystems. All Rights Reserved.
MineSight(R) is a registered trademark of Leica Geosystems.

--------------------------
User Configuration Options
--------------------------

If the configuration options are changed, this script should be saved
under a new name to prevent your setting from being overwritten when
new releases are installed.