grid_geometry.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation, either version 3 of the License, or (at your
 * option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef GRID_GEOMETRY_H
#define GRID_GEOMETRY_H
 
#include <math/vector2d.h>
 

struct GRID_GEOMETRY
{
    enum class KIND
    {
        CARTESIAN,
        POLAR
    };
 
    KIND     kind = KIND::CARTESIAN;
    VECTOR2D origin;
    VECTOR2D pitch;             
    double   orientation = 0.0; 
    VECTOR2D extent;            
    unsigned priority = 0;      

    VECTOR2D Snap( const VECTOR2D& aPoint ) const;

    bool Contains( const VECTOR2D& aPoint, double aTolerance = 0.0 ) const;

    double Area() const;

    bool TakesPrecedenceOver( const GRID_GEOMETRY& aOther ) const
    {
        if( priority != aOther.priority )
            return priority > aOther.priority;
 
        return Area() < aOther.Area();
    }
};
 
 
#endif