======================
Module viiaConnections
======================
The relation between shapes are called the connections. In MRS or the connection can be rigid, hinged or free. In the
NLTH the possibilities for connections are more extended. Refer to the UPR for more information on this topic. This
module ``viiaConnections`` contains the functions to create connections.

Before you want to create connections, be sure that the shapes are all aligned. Use functions in module
``viiaShapeOperations`` first to set up the model in the right way. Then apply functions to connect the shapes on all
points of the shapes (when in DIANA, this will be by imprinting functions).

--------------
Connect shapes
--------------

.. autofunction:: viiapackage.viiaConnections._viia_connect_shape

.. autofunction:: viiapackage.viiaConnections._viia_connect_all_shapes

------------------
Create connections
------------------

.. autofunction:: viiapackage.viiaConnections.viia_create_connection

.. autofunction:: viiapackage.viiaConnections.viia_create_tying

--------------------
Handling connections
--------------------

.. autofunction:: viiapackage.viiaConnections._viia_connections_get_mappings

.. autofunction:: viiapackage.viiaConnections._viia_remove_connection

.. autofunction:: viiapackage.viiaConnections._viia_remove_floor_connections

.. autofunction:: viiapackage.viiaConnections._viia_restore_floor_connections

.. autofunction:: viiapackage.viiaConnections._viia_reconnect_floor_connecting_shapes

------------------------------
Auto-functions for connections
------------------------------

.. automodule:: viiapackage.connections.auto_hinges
   :members:

.. automodule:: viiapackage.connections.auto_interfaces
   :members:

----------------------
Functions for checking
----------------------

.. autofunction:: viiapackage.viiaConnections.viia_node_data_diana

---------------------------------
Functions for disconnecting shape
---------------------------------

.. autofunction:: viiapackage.viiaConnections.viia_disconnect_shape

-----------------
Detail class VIIA
-----------------

.. currentmodule:: viiapackage.connections.details

.. autoclass:: Detail
   :members:

   .. automethod:: __init__

.. currentmodule:: viiapackage.connections.interface_detail

.. autoclass:: InterfaceDetail
   :members:

   .. automethod:: __init__


.. currentmodule:: viiapackage.connections.no_connection_detail

.. autoclass:: NoConnectionDetail
   :members:

   .. automethod:: __init__

.. currentmodule:: viiapackage.connections.unite_detail

.. autoclass:: UniteDetail
   :members:

   .. automethod:: __init__

----------------
Helper-functions
----------------

.. automodule:: viiapackage.connections.get_dimensions
   :members:

.. automodule:: viiapackage.connections.helper_functions
   :members:

.. automodule:: viiapackage.connections.node_data_diana
   :members: