shape_draw_behavior.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/>.
 */
 
#pragma once
 
#include <eda_item.h>
#include <eda_units.h>
#include <math/vector2d.h>
 
class EDA_SHAPE;
 

enum class SHAPE_DRAW_RESULT
{
    CANCELLED,   
    NEXT_SHAPE,  
    FINISHED     
};
 

class SHAPE_DRAW_BEHAVIOR
{
public:
    virtual ~SHAPE_DRAW_BEHAVIOR() = default;
 
    //
    // Non-geometric state interfaces
    //

    virtual bool IsComplete() const = 0;

    virtual bool HasGeometryChanged() const = 0;

    virtual void ClearGeometryChanged() = 0;

    virtual int GetStep() const = 0;

    virtual void Reset() = 0;
 
    //
    // Interactive operations called from a TOOL framework event loop
    //

    virtual void AddPoint( const VECTOR2I& aPosition ) = 0;

    virtual void SetCursorPosition( const VECTOR2I& aPosition ) = 0;

    virtual void RemoveLastPoint() = 0;

    virtual void ToggleClockwise() {}

    virtual void SetAngleSnap( bool aSnap ) {}

    virtual bool OnProperties( EDA_SHAPE& aShape ) { return false; }
 
    //
    // Geometry access
    //

    virtual void ApplyToShape( EDA_SHAPE& aShape ) const = 0;

    virtual EDA_ITEM& GetAssistant() = 0;

    virtual void SetUnits( EDA_UNITS aUnits ) = 0;
};