gg_core.h

Go to the documentation of this file.

/*
 gg_core.h -- Gaia common support for geometries: core functions
  
 version 5.0, 2020 August 1

 Author: Sandro Furieri a.furieri@lqt.it

 ------------------------------------------------------------------------------
 
 Version: MPL 1.1/GPL 2.0/LGPL 2.1
 
 The contents of this file are subject to the Mozilla Public License Version
 1.1 (the "License"); you may not use this file except in compliance with
 the License. You may obtain a copy of the License at
 http://www.mozilla.org/MPL/
 
Software distributed under the License is distributed on an "AS IS" basis,
WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
for the specific language governing rights and limitations under the
License.

The Original Code is the SpatiaLite library

The Initial Developer of the Original Code is Alessandro Furieri
 
Portions created by the Initial Developer are Copyright (C) 2008-2020
the Initial Developer. All Rights Reserved.

Contributor(s):


Alternatively, the contents of this file may be used under the terms of
either the GNU General Public License Version 2 or later (the "GPL"), or
the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
in which case the provisions of the GPL or the LGPL are applicable instead
of those above. If you wish to allow use of your version of this file only
under the terms of either the GPL or the LGPL, and not to allow others to
use your version of this file under the terms of the MPL, indicate your
decision by deleting the provisions above and replace them with the notice
and other provisions required by the GPL or the LGPL. If you do not delete
the provisions above, a recipient may use your version of this file under
the terms of any one of the MPL, the GPL or the LGPL.
 
*/


#ifndef _GG_CORE_H
#ifndef DOXYGEN_SHOULD_SKIP_THIS
#define _GG_CORE_H
#endif

#ifdef __cplusplus
extern "C"
{
#endif

/* constant values for gaiaGeodesicArcLength return_type */

#define GAIA_GEODESIC_ARC_LENGTH_DEGREES        0

#define GAIA_GEODESIC_ARC_LENGTH_METERS         1

#define GAIA_GEODESIC_CHORD_LENGTH_DEGREES      2

#define GAIA_GEODESIC_CHORD_LENGTH_METERS       3

#define GAIA_GEODESIC_CENTRAL_ANGLE_RADIANS     4

#define GAIA_GEODESIC_CENTRAL_ANGLE_DEGREES     5

#define GAIA_GEODESIC_ARC_AREA_METERS           6

#define GAIA_GEODESIC_ARC_HEIGHT_METERS         7


/* function prototypes */

    GAIAGEO_DECLARE void gaiaFree (void *ptr);

    GAIAGEO_DECLARE gaiaPointPtr gaiaAllocPoint (double x, double y);

    GAIAGEO_DECLARE gaiaPointPtr gaiaAllocPointXYZ (double x, double y,
                                                    double z);

    GAIAGEO_DECLARE gaiaPointPtr gaiaAllocPointXYM (double x, double y,
                                                    double m);

    GAIAGEO_DECLARE gaiaPointPtr gaiaAllocPointXYZM (double x, double y,
                                                     double z, double m);

    GAIAGEO_DECLARE void gaiaFreePoint (gaiaPointPtr ptr);

    GAIAGEO_DECLARE gaiaLinestringPtr gaiaAllocLinestring (int vert);

    GAIAGEO_DECLARE gaiaLinestringPtr gaiaAllocLinestringXYZ (int vert);

    GAIAGEO_DECLARE gaiaLinestringPtr gaiaAllocLinestringXYM (int vert);

    GAIAGEO_DECLARE gaiaLinestringPtr gaiaAllocLinestringXYZM (int vert);

    GAIAGEO_DECLARE void gaiaFreeLinestring (gaiaLinestringPtr ptr);

    GAIAGEO_DECLARE void gaiaCopyLinestringCoords (gaiaLinestringPtr dst,
                                                   gaiaLinestringPtr src);

    GAIAGEO_DECLARE void gaiaCopyLinestringCoordsEx (gaiaLinestringPtr dst,
                                                     gaiaLinestringPtr src,
                                                     double z_no_data,
                                                     double m_no_data);

    GAIAGEO_DECLARE void gaiaCopyLinestringCoordsReverse (gaiaLinestringPtr
                                                          dst,
                                                          gaiaLinestringPtr
                                                          src);

    GAIAGEO_DECLARE gaiaRingPtr gaiaAllocRing (int vert);

    GAIAGEO_DECLARE gaiaRingPtr gaiaAllocRingXYZ (int vert);

    GAIAGEO_DECLARE gaiaRingPtr gaiaAllocRingXYM (int vert);

    GAIAGEO_DECLARE gaiaRingPtr gaiaAllocRingXYZM (int vert);

    GAIAGEO_DECLARE void gaiaFreeRing (gaiaRingPtr ptr);

    GAIAGEO_DECLARE void gaiaCopyRingCoords (gaiaRingPtr dst, gaiaRingPtr src);

    GAIAGEO_DECLARE void gaiaCopyRingCoordsEx (gaiaRingPtr dst, gaiaRingPtr src,
                                               double z_no_data,
                                               double m_no_data);

    GAIAGEO_DECLARE void gaiaCopyRingCoordsReverse (gaiaRingPtr dst,
                                                    gaiaRingPtr src);

    GAIAGEO_DECLARE gaiaPolygonPtr gaiaAllocPolygon (int vert, int holes);

    GAIAGEO_DECLARE gaiaPolygonPtr gaiaAllocPolygonXYZ (int vert, int holes);

    GAIAGEO_DECLARE gaiaPolygonPtr gaiaAllocPolygonXYM (int vert, int holes);

    GAIAGEO_DECLARE gaiaPolygonPtr gaiaAllocPolygonXYZM (int vert, int holes);

    GAIAGEO_DECLARE gaiaPolygonPtr gaiaCreatePolygon (gaiaRingPtr ring);

    GAIAGEO_DECLARE void gaiaFreePolygon (gaiaPolygonPtr polyg);

    GAIAGEO_DECLARE gaiaGeomCollPtr gaiaAllocGeomColl (void);

    GAIAGEO_DECLARE gaiaGeomCollPtr gaiaAllocGeomCollXYZ (void);

    GAIAGEO_DECLARE gaiaGeomCollPtr gaiaAllocGeomCollXYM (void);

    GAIAGEO_DECLARE gaiaGeomCollPtr gaiaAllocGeomCollXYZM (void);

    GAIAGEO_DECLARE void gaiaFreeGeomColl (gaiaGeomCollPtr geom);

    GAIAGEO_DECLARE void gaiaAddPointToGeomColl (gaiaGeomCollPtr p, double x,
                                                 double y);

    GAIAGEO_DECLARE void gaiaAddPointToGeomCollXYZ (gaiaGeomCollPtr p,
                                                    double x, double y,
                                                    double z);

    GAIAGEO_DECLARE void gaiaAddPointToGeomCollXYM (gaiaGeomCollPtr p,
                                                    double x, double y,
                                                    double m);

    GAIAGEO_DECLARE void gaiaAddPointToGeomCollXYZM (gaiaGeomCollPtr p,
                                                     double x, double y,
                                                     double z, double m);

    GAIAGEO_DECLARE gaiaLinestringPtr
        gaiaAddLinestringToGeomColl (gaiaGeomCollPtr p, int vert);

    GAIAGEO_DECLARE void gaiaInsertLinestringInGeomColl (gaiaGeomCollPtr p,
                                                         gaiaLinestringPtr
                                                         line);

    GAIAGEO_DECLARE gaiaPolygonPtr gaiaAddPolygonToGeomColl (gaiaGeomCollPtr
                                                             p, int vert,
                                                             int interiors);

    GAIAGEO_DECLARE gaiaPolygonPtr
        gaiaInsertPolygonInGeomColl (gaiaGeomCollPtr p, gaiaRingPtr ring);

    GAIAGEO_DECLARE gaiaRingPtr gaiaAddInteriorRing (gaiaPolygonPtr p,
                                                     int pos, int vert);

    GAIAGEO_DECLARE void gaiaInsertInteriorRing (gaiaPolygonPtr p,
                                                 gaiaRingPtr ring);

    GAIAGEO_DECLARE void gaiaAddRingToPolyg (gaiaPolygonPtr polyg,
                                             gaiaRingPtr ring);

    GAIAGEO_DECLARE gaiaLinestringPtr gaiaCloneLinestring (gaiaLinestringPtr
                                                           line);
    GAIAGEO_DECLARE gaiaLinestringPtr
        gaiaCloneLinestringSpecial (gaiaLinestringPtr line, int mode);

    GAIAGEO_DECLARE gaiaRingPtr gaiaCloneRing (gaiaRingPtr ring);

    GAIAGEO_DECLARE gaiaRingPtr gaiaCloneRingSpecial (gaiaRingPtr ring,
                                                      int mode);

    GAIAGEO_DECLARE gaiaPolygonPtr gaiaClonePolygon (gaiaPolygonPtr polyg);

    GAIAGEO_DECLARE gaiaPolygonPtr gaiaClonePolygonSpecial (gaiaPolygonPtr
                                                            polyg, int mode);

    GAIAGEO_DECLARE gaiaGeomCollPtr gaiaCloneGeomColl (gaiaGeomCollPtr geom);

    GAIAGEO_DECLARE gaiaGeomCollPtr gaiaCloneGeomCollSpecial (gaiaGeomCollPtr
                                                              geom, int mode);

    GAIAGEO_DECLARE gaiaGeomCollPtr gaiaCloneGeomCollPoints (gaiaGeomCollPtr
                                                             geom);

    GAIAGEO_DECLARE gaiaGeomCollPtr
        gaiaCloneGeomCollLinestrings (gaiaGeomCollPtr geom);

    GAIAGEO_DECLARE gaiaGeomCollPtr gaiaCloneGeomCollPolygons (gaiaGeomCollPtr
                                                               geom);

    GAIAGEO_DECLARE gaiaGeomCollPtr gaiaCastGeomCollToXY (gaiaGeomCollPtr geom);

    GAIAGEO_DECLARE gaiaGeomCollPtr gaiaCastGeomCollToXYZ (gaiaGeomCollPtr
                                                           geom);

    GAIAGEO_DECLARE gaiaGeomCollPtr gaiaCastGeomCollToXYM (gaiaGeomCollPtr
                                                           geom);

    GAIAGEO_DECLARE gaiaGeomCollPtr gaiaCastGeomCollToXYZM (gaiaGeomCollPtr
                                                            geom);

    GAIAGEO_DECLARE gaiaGeomCollPtr gaiaCastGeomCollToXYZnoData (gaiaGeomCollPtr
                                                                 geom,
                                                                 double
                                                                 no_data);

    GAIAGEO_DECLARE gaiaGeomCollPtr gaiaCastGeomCollToXYMnoData (gaiaGeomCollPtr
                                                                 geom,
                                                                 double
                                                                 no_data);

    GAIAGEO_DECLARE gaiaGeomCollPtr
        gaiaCastGeomCollToXYZMnoData (gaiaGeomCollPtr geom, double z_no_data,
                                      double m_no_data);

    GAIAGEO_DECLARE int gaiaLineGetPoint (gaiaLinestringPtr ln, int v,
                                          double *x, double *y, double *z,
                                          double *m);

    GAIAGEO_DECLARE int gaiaLineSetPoint (gaiaLinestringPtr ln, int v,
                                          double x, double y, double z,
                                          double m);

    GAIAGEO_DECLARE int gaiaRingGetPoint (gaiaRingPtr rng, int v, double *x,
                                          double *y, double *z, double *m);

    GAIAGEO_DECLARE int gaiaRingSetPoint (gaiaRingPtr rng, int v, double x,
                                          double y, double z, double m);

    GAIAGEO_DECLARE int gaiaDimension (gaiaGeomCollPtr geom);

    GAIAGEO_DECLARE int gaiaGeometryType (gaiaGeomCollPtr geom);

    GAIAGEO_DECLARE int gaiaGeometryAliasType (gaiaGeomCollPtr geom);

    GAIAGEO_DECLARE int gaiaIsEmpty (gaiaGeomCollPtr geom);

    GAIAGEO_DECLARE int gaiaCheckClockwise (gaiaGeomCollPtr geom);

    GAIAGEO_DECLARE int gaiaCheckCounterClockwise (gaiaGeomCollPtr geom);

    GAIAGEO_DECLARE int gaiaIsToxic (gaiaGeomCollPtr geom);

    GAIAGEO_DECLARE int gaiaIsToxic_r (const void *p_cache,
                                       gaiaGeomCollPtr geom);

    GAIAGEO_DECLARE int gaiaIsNotClosedRing (gaiaRingPtr ring);

    GAIAGEO_DECLARE int gaiaIsNotClosedRing_r (const void *p_data,
                                               gaiaRingPtr ring);

    GAIAGEO_DECLARE int gaiaIsNotClosedGeomColl (gaiaGeomCollPtr geom);

    GAIAGEO_DECLARE int gaiaIsNotClosedGeomColl_r (const void *p_data,
                                                   gaiaGeomCollPtr geom);

    GAIAGEO_DECLARE gaiaGeomCollPtr gaiaSanitize (gaiaGeomCollPtr org);

    GAIAGEO_DECLARE gaiaGeomCollPtr gaiaEnsureClosedRings (gaiaGeomCollPtr org);

    GAIAGEO_DECLARE gaiaGeomCollPtr gaiaRemoveRepeatedPoints (gaiaGeomCollPtr
                                                              org,
                                                              double tolerance);

    GAIAGEO_DECLARE gaiaGeomCollPtr gaiaLinearize (gaiaGeomCollPtr geom,
                                                   int force_multi);

    GAIAGEO_DECLARE gaiaGeomCollPtr gaiaDissolveSegments (gaiaGeomCollPtr geom);

    GAIAGEO_DECLARE gaiaGeomCollPtr gaiaDissolvePoints (gaiaGeomCollPtr geom);

    GAIAGEO_DECLARE gaiaGeomCollPtr
        gaiaExtractPointsFromGeomColl (gaiaGeomCollPtr geom);

    GAIAGEO_DECLARE gaiaGeomCollPtr
        gaiaExtractLinestringsFromGeomColl (gaiaGeomCollPtr geom);

    GAIAGEO_DECLARE gaiaGeomCollPtr
        gaiaExtractPolygonsFromGeomColl (gaiaGeomCollPtr geom);

    GAIAGEO_DECLARE gaiaGeomCollPtr gaiaMergeGeometries (gaiaGeomCollPtr
                                                         geom1,
                                                         gaiaGeomCollPtr geom2);

    GAIAGEO_DECLARE gaiaGeomCollPtr gaiaMergeGeometries_r (const void
                                                           *p_cache,
                                                           gaiaGeomCollPtr
                                                           geom1,
                                                           gaiaGeomCollPtr
                                                           geom2);

    GAIAGEO_DECLARE gaiaGeomCollPtr
        gaiaAddMeasure (gaiaGeomCollPtr geom, double m_start, double m_end);

    GAIAGEO_DECLARE int
        gaiaInterpolatePoint (const void *p_cache, gaiaGeomCollPtr line,
                              gaiaGeomCollPtr point, double *m_value);

    GAIAGEO_DECLARE gaiaGeomCollPtr
        gaiaLocateBetweenMeasures (gaiaGeomCollPtr geom, double m_start,
                                   double m_end);

    GAIAGEO_DECLARE int gaiaIsValidTrajectory (gaiaGeomCollPtr geom);

    GAIAGEO_DECLARE gaiaGeomCollPtr
        gaiaTrajectoryInterpolatePoint (gaiaGeomCollPtr geom, double m);

    GAIAGEO_DECLARE double gaiaMeasureLength (int dims, double *coords,
                                              int vert);

    GAIAGEO_DECLARE double gaiaMeasureArea (gaiaRingPtr ring);

    GAIAGEO_DECLARE void gaiaRingCentroid (gaiaRingPtr ring, double *rx,
                                           double *ry);

    GAIAGEO_DECLARE void gaiaClockwise (gaiaRingPtr p);

    GAIAGEO_DECLARE int gaiaIsPointOnRingSurface (gaiaRingPtr ring,
                                                  double pt_x, double pt_y);

    GAIAGEO_DECLARE int gaiaIsPointOnPolygonSurface (gaiaPolygonPtr polyg,
                                                     double x, double y);

    GAIAGEO_DECLARE double gaiaMinDistance (double x0, double y0,
                                            int dims, double *coords, int vert);

    GAIAGEO_DECLARE int gaiaIntersect (double *x0, double *y0, double x1,
                                       double y1, double x2, double y2,
                                       double x3, double y3, double x4,
                                       double y4);

    GAIAGEO_DECLARE void gaiaShiftCoords (gaiaGeomCollPtr geom,
                                          double shift_x, double shift_y);

    GAIAGEO_DECLARE void gaiaShiftCoords3D (gaiaGeomCollPtr geom,
                                            double shift_x, double shift_y,
                                            double shift_z);

    GAIAGEO_DECLARE void gaiaShiftLongitude (gaiaGeomCollPtr geom);

    GAIAGEO_DECLARE void gaiaNormalizeLonLat (gaiaGeomCollPtr geom);


    GAIAGEO_DECLARE void gaiaScaleCoords (gaiaGeomCollPtr geom,
                                          double scale_x, double scale_y);

    GAIAGEO_DECLARE void gaiaRotateCoords (gaiaGeomCollPtr geom, double angle);

    GAIAGEO_DECLARE void gaiaReflectCoords (gaiaGeomCollPtr geom, int x_axis,
                                            int y_axis);

    GAIAGEO_DECLARE void gaiaSwapCoords (gaiaGeomCollPtr geom);

    GAIAGEO_DECLARE int gaiaLinestringEquals (gaiaLinestringPtr line1,
                                              gaiaLinestringPtr line2);

    GAIAGEO_DECLARE int gaiaPolygonEquals (gaiaPolygonPtr polyg1,
                                           gaiaPolygonPtr polyg2);

    GAIAGEO_DECLARE int gaiaEllipseParams (const char *name, double *a,
                                           double *b, double *rf);

    GAIAGEO_DECLARE double gaiaGreatCircleDistance (double a, double b,
                                                    double lat1, double lon1,
                                                    double lat2, double lon2);

    GAIAGEO_DECLARE double gaiaGeodesicDistance (double a, double b,
                                                 double rf, double lat1,
                                                 double lon1, double lat2,
                                                 double lon2);

    GAIAGEO_DECLARE double gaiaGreatCircleTotalLength (double a, double b,
                                                       int dims,
                                                       double *coords,
                                                       int vert);

    GAIAGEO_DECLARE double gaiaGeodesicTotalLength (double a, double b,
                                                    double rf, int dims,
                                                    double *coords, int vert);

    GAIAGEO_DECLARE int gaiaConvertLength (double value, int unit_from,
                                           int unit_to, double *cvt);

    GAIAGEO_DECLARE int gaiaGeodesicArcLength (sqlite3 * sqlite,
                                               const void *cache,
                                               gaiaGeomCollPtr geom1,
                                               gaiaGeomCollPtr geom2,
                                               int return_type, double *retval);

    GAIAGEO_DECLARE gaiaGeomCollPtr gaiaMakeCircle (double center_x,
                                                    double center_y,
                                                    double radius, double step);

    GAIAGEO_DECLARE gaiaGeomCollPtr gaiaMakeEllipse (double center_x,
                                                     double center_y,
                                                     double x_axis,
                                                     double y_axis,
                                                     double step);

    GAIAGEO_DECLARE gaiaGeomCollPtr gaiaMakeArc (double center_x,
                                                 double center_y,
                                                 double radius, double start,
                                                 double stop, double step);

    GAIAGEO_DECLARE gaiaGeomCollPtr gaiaMakeEllipticArc (double center_x,
                                                         double center_y,
                                                         double x_axis,
                                                         double y_axis,
                                                         double start,
                                                         double stop,
                                                         double step);

    GAIAGEO_DECLARE gaiaGeomCollPtr gaiaMakePolygon (gaiaGeomCollPtr exterior,
                                                     gaiaGeomCollPtr interiors);

    GAIAGEO_DECLARE double gaiaCurvosityIndex (const void *p_cache,
                                               gaiaLinestringPtr line,
                                               int extra_points);

    GAIAGEO_DECLARE void gaiaUpDownHeight (gaiaLinestringPtr line, double *up,
                                           double *down);

#ifdef __cplusplus
}
#endif

#endif                          /* _GG_CORE_H */