globalmapper.SpatialPredicate
=============================

.. currentmodule:: globalmapper
.. py:function:: SpatialPredicate (GM_SpatialPredicates_t16 aPredicate, GM_LayerHandle_t32 aLayer1, GM_LayerHandle_t32 aLayer2, GM_SpatialOps_Params_t aParams) -> GM_Error_t32

	General predicate function. Can be used to perform any of the two-layer spatial predicate functions available in
	Global Mapper. These are functions in which the order of the input layers matter, as opposed to
	:doc:`spatial operations <globalmapper.SpatialOperation>`, which will have the same result regardless of order.

	Currently, the available predicate functions and their parameter values are:

	-   :doc:`SpatialIntersects <globalmapper.SpatialIntersects>` - *GM_SpatialPredicates_Intersects*
	-   :doc:`SpatialOverlaps <globalmapper.SpatialOverlaps>` - *GM_SpatialPredicates_Overlaps*
	-   :doc:`SpatialTouches <globalmapper.SpatialTouches>` - *GM_SpatialPredicates_Touches*
	-   :doc:`SpatialContains <globalmapper.SpatialContains>` - *GM_SpatialPredicates_Contains*
	-   :doc:`SpatialEquals <globalmapper.SpatialEquals>` - *GM_SpatialPredicates_IsEqual*
	-   :doc:`SpatialWithin <globalmapper.SpatialWithin>` - *GM_SpatialPredicates_IsWithin*
	-   :doc:`SpatialDisjoint <globalmapper.SpatialSymmetricDifference>` - *GM_SpatialPredicates_IsDisjoint*
	
	:param GM_SpatialPredicates_t16 aPredicate: Predicate(s) to use
	:param GM_LayerHandle_t32 aLayer1: First layer in predicate
	:param GM_LayerHandle_t32 aLayer2: Second layer in predicate
	:param GM_SpatialOps_Params_t aParams: Parameters
	:returns: Error Code
	:rtype: GM_Error_t32