=============================
``grail.ms3d.project`` Module
=============================
.. include:: ../../version.h
.. include:: ref.h


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


--------
Overview
--------

Provides read-only access to the settings for the current MineSightŪ-3D project.


---------
Functions
---------

:df:`get_origin()`
   Returns the origin of the project. In MS3D the origin is equivalent to the
   minimum X, Y and Z coordinates.

:df:`get_unit_type()`
   Returns :d:`project.METRIC` for metric projects and :d:`project.IMPERIAL`
   for imperial projects.

:df:`get_xmin()`
   Returns the project's minimum x coordinate.

:df:`get_xmax()`
   Returns the project's maximum x coordinate.

:df:`get_ymin()`
   Returns the project's minimum y coordinate.

:df:`get_ymax()`
   Returns the project's maximum y coordinate.

:df:`get_zmin()`
   Returns the project's minimum z coordinate.

:df:`get_zmax()`
   Returns the project's maximum z coordinate.

---------
Constants
---------

:dd:`IMPERIAL`
  Indicates an imperial project.

:dd:`METRIC`
  Indicates a metric project.

:dd:`RESOURCE_DIRECTORY`
  A full path to the resource directory (_msresource) for the current
  project.

:dd:`PROJECT_DIRECTORY`
  A full path to the project directory for the current project.