Region.h

Go to the documentation of this file.

/******************************************************************************
 * Project:  libspatialindex - A C++ library for spatial indexing
 * Author:   Marios Hadjieleftheriou, mhadji@gmail.com
 ******************************************************************************
 * Copyright (c) 2004, Marios Hadjieleftheriou
 *
 * All rights reserved.
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included
 * in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
******************************************************************************/

#pragma once

namespace SpatialIndex
{
    class SIDX_DLL Region : public Tools::IObject, public virtual IShape
    {
    public:
        Region();
        Region(const double* pLow, const double* pHigh, uint32_t dimension);
        Region(const Point& low, const Point& high);
        Region(const Region& in);
        ~Region() override;

        virtual Region& operator=(const Region& r);
        virtual bool operator==(const Region&) const;

        //
        // IObject interface
        //
        Region* clone() override;

        //
        // ISerializable interface
        //
        uint32_t getByteArraySize() override;
        void loadFromByteArray(const uint8_t* data) override;
        void storeToByteArray(uint8_t** data, uint32_t& length) override;

        //
        // IShape interface
        //
        bool intersectsShape(const IShape& in) const override;
        bool containsShape(const IShape& in) const override;
        bool touchesShape(const IShape& in) const override;
        void getCenter(Point& out) const override;
        uint32_t getDimension() const override;
        void getMBR(Region& out) const override;
        double getArea() const override;
        double getMinimumDistance(const IShape& in) const override;

        virtual bool intersectsRegion(const Region& in) const;
        virtual bool containsRegion(const Region& in) const;
        virtual bool touchesRegion(const Region& in) const;
        virtual double getMinimumDistance(const Region& in) const;

        virtual bool intersectsLineSegment(const LineSegment& in) const;

        virtual bool containsPoint(const Point& in) const;
        virtual bool touchesPoint(const Point& in) const;
        virtual double getMinimumDistance(const Point& in) const;

        virtual Region getIntersectingRegion(const Region& r) const;
        virtual double getIntersectingArea(const Region& in) const;
        virtual double getMargin() const;

        virtual void combineRegion(const Region& in);
        virtual void combinePoint(const Point& in);
        virtual void getCombinedRegion(Region& out, const Region& in) const;

        virtual double getLow(uint32_t index) const;
        virtual double getHigh(uint32_t index) const;

        virtual void makeInfinite(uint32_t dimension);
        virtual void makeDimension(uint32_t dimension);

    private:
        void initialize(const double* pLow, const double* pHigh, uint32_t dimension);

    public:
        uint32_t m_dimension{0};
        double* m_pLow{nullptr};
        double* m_pHigh{nullptr};

        friend SIDX_DLL std::ostream& operator<<(std::ostream& os, const Region& r);
    }; // Region
    
    typedef Tools::PoolPointer<Region> RegionPtr;
    SIDX_DLL std::ostream& operator<<(std::ostream& os, const Region& r);
}