multistep_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 (C) 2017-2023 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, you may find one here:
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * or you may search the http://www.gnu.org website for the version 2 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
 */
 
#ifndef PREVIEW_ITEMS_MULTISTEP_GEOMETRY_MANAGER_H
#define PREVIEW_ITEMS_MULTISTEP_GEOMETRY_MANAGER_H
 
#include <math/vector2d.h>
#include <algorithm>
#include <core/kicad_algo.h>
 
namespace KIGFX {
namespace PREVIEW {
 
class MULTISTEP_GEOM_MANAGER
{
public:
 virtual ~MULTISTEP_GEOM_MANAGER()
 {}
 
 void AddPoint( const VECTOR2I& aPt, bool aLockIn )
 {
 // hold onto the raw point separately to the managed geometry
 m_lastPoint = aPt;
 
 // update the geometry
 bool accepted = acceptPoint( aPt );
 
 // advance or regress the manager
 if( aLockIn )
 performStep( accepted );
 
 setGeometryChanged();
 }
 
 void RemoveLastPoint()
 {
 performStep( false );
 
 // process the last point again, but in the previous step mode it doesn't matter if
 // accepted or not, as long as the geometry is regenerated if needed.
 acceptPoint( GetLastPoint() );
 setGeometryChanged();
 }
 
 bool IsReset() const
 {
 return m_step == 0;
 }
 
 void Reset()
 {
 m_step = 0;
 setGeometryChanged();
 }
 
 bool IsComplete() const
 {
 return m_step == getMaxStep();
 }
 
 VECTOR2I GetLastPoint() const
 {
 return m_lastPoint;
 }
 
 bool HasGeometryChanged() const
 {
 return m_changed;
 }
 
 void ClearGeometryChanged()
 {
 m_changed = false;
 }
 
protected:
 
 void setGeometryChanged()
 {
 m_changed = true;
 }
 
 int getStep() const
 {
 return m_step;
 }
 
private:
 
 virtual bool acceptPoint( const VECTOR2I& aPt ) = 0;
 
 virtual int getMaxStep() const = 0;
 
 void performStep( bool aForward )
 {
 m_step += aForward ? 1 : -1;
 
 // clamp to allowed values
 m_step = alg::clamp( 0, m_step, getMaxStep() );
 }
 
 bool m_changed = false;
 
 VECTOR2I m_lastPoint;
 
 int m_step = 0;
};
 
} // PREVIEW
} // KIGFX
 
#endif // PREVIEW_ITEMS_MULTIPOINT_GEOMETRY_MANAGER_H