OverlayLabel.h

Go to the documentation of this file.

/**********************************************************************
 *
 * GEOS - Geometry Engine Open Source
 * http://geos.osgeo.org
 *
 * Copyright (C) 2020 Paul Ramsey <pramsey@cleverelephant.ca>
 *
 * This is free software; you can redistribute and/or modify it under
 * the terms of the GNU Lesser General Public Licence as published
 * by the Free Software Foundation.
 * See the COPYING file for more information.
 *
 **********************************************************************/

#pragma once

#include <geos/geom/Location.h>
#include <geos/geom/Position.h>
#include <geos/export.h>


namespace geos {      // geos.
namespace operation { // geos.operation
namespace overlayng { // geos.operation.overlayng


using geos::geom::Location;
using geos::geom::Position;


class GEOS_DLL OverlayLabel {

private:

    // Members
    int aDim = DIM_NOT_PART;
    bool aIsHole = false;
    Location aLocLeft = LOC_UNKNOWN;
    Location aLocRight = LOC_UNKNOWN;
    Location aLocLine = LOC_UNKNOWN;
    int bDim = DIM_NOT_PART;
    bool bIsHole = false;
    Location bLocLeft = LOC_UNKNOWN;
    Location bLocRight = LOC_UNKNOWN;
    Location bLocLine = LOC_UNKNOWN;


    std::string dimensionSymbol(int dim) const;
    void locationString(int index, bool isForward, std::ostream& os) const;


public:

    static constexpr Location LOC_UNKNOWN = Location::NONE;

    enum {
        DIM_UNKNOWN = -1,
        DIM_NOT_PART = -1,
        DIM_LINE = 1,
        DIM_BOUNDARY = 2,
        DIM_COLLAPSE = 3
    };

    OverlayLabel()
        : aDim(DIM_NOT_PART)
        , aIsHole(false)
        , aLocLeft(LOC_UNKNOWN)
        , aLocRight(LOC_UNKNOWN)
        , aLocLine(LOC_UNKNOWN)
        , bDim(DIM_NOT_PART)
        , bIsHole(false)
        , bLocLeft(LOC_UNKNOWN)
        , bLocRight(LOC_UNKNOWN)
        , bLocLine(LOC_UNKNOWN) {};

    OverlayLabel(int p_index)
        : OverlayLabel()
    {
        initLine(p_index);
    };

    OverlayLabel(int p_index, Location p_locLeft, Location p_locRight, bool p_isHole)
        : OverlayLabel()
    {
        initBoundary(p_index, p_locLeft, p_locRight, p_isHole);
    };

    int dimension(int index) const { return index == 0 ? aDim : bDim; };
    void initBoundary(int index, Location locLeft, Location locRight, bool p_isHole);
    void initCollapse(int index, bool p_isHole);
    void initLine(int index);
    void initNotPart(int index);

    void setLocationLine(int index, Location loc);
    void setLocationAll(int index, Location loc);
    void setLocationCollapse(int index);

    /*
    * Tests whether at least one of the sources is a Line.
    *
    * @return true if at least one source is a line
    */
    bool isLine() const;
    bool isLine(int index) const;
    bool isLinear(int index) const;
    bool isKnown(int index) const;
    bool isNotPart(int index) const;
    bool isBoundaryEither() const;
    bool isBoundaryBoth() const;

    bool isBoundaryCollapse() const;

    bool isBoundaryTouch() const;
    bool isBoundary(int index) const;
    bool isLineLocationUnknown(int index) const;

    bool isBoundarySingleton() const;

    bool isLineInArea(int index) const;
    bool isHole(int index) const;
    bool isCollapse(int index) const;
    Location getLineLocation(int index) const;

    bool isInteriorCollapse() const;

    bool isCollapseAndNotPartInterior() const;

    bool isLineInterior(int index) const;

    Location getLocationBoundaryOrLine(int index, int position, bool isForward) const;

    Location getLocation(int index) const;
    Location getLocation(int index, int position, bool isForward) const;
    bool hasSides(int index) const;

    OverlayLabel copy() const;


    friend std::ostream& operator<<(std::ostream& os, const OverlayLabel& ol);
    void toString(bool isForward, std::ostream& os) const;


};


} // namespace geos.operation.overlayng
} // namespace geos.operation
} // namespace geos