arc_geom_manager.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 2
 * 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 <https://www.gnu.org/licenses/>.
 */
 
#ifndef PREVIEW_ITEMS_ARC_GEOMETRY_MANAGER_H
#define PREVIEW_ITEMS_ARC_GEOMETRY_MANAGER_H
 
#include <array>
 
#include <preview_items/multistep_geom_manager.h>
#include <geometry/arc_construction.h>
#include <geometry/eda_angle.h>
#include <tool/arc_draw_mode.h>
 
namespace KIGFX {
namespace PREVIEW {

class ARC_GEOM_MANAGER: public MULTISTEP_GEOM_MANAGER
{
public:
    ARC_GEOM_MANAGER()
    {}

    enum ARC_STEPS
    {
        FIRST_POINT = 0,    
        SECOND_POINT,       
        THIRD_POINT,        
        COMPLETE
    };
 
    int getMaxStep() const override
    {
        return HasTangentSeed() ? SECOND_POINT : COMPLETE;
    }

    ARC_STEPS GetStep() const
    {
        return IsComplete() ? COMPLETE : static_cast<ARC_STEPS>( getStep() );
    }

    void Reset() override;

    void SetMode( ARC_DRAW_MODE aMode );
 
    ARC_DRAW_MODE GetMode() const { return m_mode; }

    void SetTangentSeed( const VECTOR2I& aStart, const VECTOR2D& aDirection, bool aDirectionIsAxis = false );

    bool HasTangentSeed() const { return m_mode == ARC_DRAW_MODE::TANGENT && m_hasSeed; }

    bool HasPreview() const { return !IsReset() || HasTangentSeed(); }
 

    void ToggleClockwise();

    void SetAngleSnap( bool aSnap )
    {
        m_angleSnap = aSnap;
    }
 
    /*
     * Geometry query interface - used by clients of the manager
     */

    VECTOR2I GetOrigin() const;

    VECTOR2I GetStartRadiusEnd() const;

    VECTOR2I GetEndRadiusEnd() const;

    double GetRadius() const;

    EDA_ANGLE GetStartAngle() const;

    EDA_ANGLE GetSubtended() const;

    bool UsesExactEndpoints() const { return m_mode != ARC_DRAW_MODE::CENTER_START_END; }

    const KIGEOM::ARC_SOLUTION& GetSolution() const { return m_solution; }

    int GetPointIndex() const { return getStep() + ( HasTangentSeed() ? 1 : 0 ); }

    const VECTOR2I& GetPoint( int aIndex ) const { return m_pts[aIndex]; }

    const VECTOR2D& GetTangentDirection() const { return m_dir; }

    bool UsesDirectionClick() const
    {
        return m_mode == ARC_DRAW_MODE::START_DIR_END || ( m_mode == ARC_DRAW_MODE::TANGENT && !m_hasSeed );
    }
 
protected:
    bool acceptPoint( const VECTOR2I& aPt ) override;
 
private:
    bool rejectRegresses() const override { return m_mode == ARC_DRAW_MODE::CENTER_START_END; }

    bool acceptExactPoint( const VECTOR2I& aPt );

    void applySolution( const KIGEOM::ARC_SOLUTION& aSolution );

    void clearSolution();

    bool setDirection( const VECTOR2I& aPt );
 
    /*
     * Point acceptor functions
     */

    bool setOrigin( const VECTOR2I& aOrigin );

    bool setStart( const VECTOR2I& aEnd );

    bool setEnd( const VECTOR2I& aCursor );
 
    /*
     * Arc geometry
     */
    bool      m_clockwise  = true;
    VECTOR2I  m_origin;
    double    m_radius = 0.0;
    EDA_ANGLE m_startAngle;
    EDA_ANGLE m_endAngle;
 
    /*
     * construction parameters
     */
    bool m_angleSnap = false;
    bool m_directionLocked = false;
 
    ARC_DRAW_MODE m_mode = ARC_DRAW_MODE::CENTER_START_END;

    std::array<VECTOR2I, 3> m_pts;
    VECTOR2D                m_dir;
    bool                    m_hasSeed = false;
    bool                    m_seedIsAxis = false;
    bool                    m_axisFlipped = false;
    VECTOR2D                m_axis;
    bool                    m_major = false;
    KIGEOM::ARC_SOLUTION    m_solution;
};
 
}       // PREVIEW
}       // KIGFX
 
#endif  // PREVIEW_ITEMS_ARC_GEOMETRY_MANAGER_H