construction_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) 2024 KiCad Developers, see AUTHORS.txt for contributors.
 *
 * @author Maciej Suminski <[email protected]>
 *
 * 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
 */
#pragma once
 
#include <vector>
#include <deque>
 
#include <preview_items/construction_geom.h>
 
class EDA_ITEM;
 
class CONSTRUCTION_MANAGER
{
public:
 CONSTRUCTION_MANAGER( KIGFX::CONSTRUCTION_GEOM& aHelper );
 
 enum class SOURCE
 {
 FROM_ITEMS,
 FROM_SNAP_LINE,
 };
 
 struct CONSTRUCTION_ITEM
 {
 SOURCE Source;
 EDA_ITEM* Item;
 std::vector<KIGFX::CONSTRUCTION_GEOM::DRAWABLE> Constructions;
 };
 
 // A single batch of construction items. Once batch contains all the items (and associated
 // construction geometry) that should be shown for one point of interest.
 // More than one batch may be shown on the screen at the same time.
 using CONSTRUCTION_ITEM_BATCH = std::vector<CONSTRUCTION_ITEM>;
 
 void AddConstructionItems( CONSTRUCTION_ITEM_BATCH aBatch, bool aIsPersistent );
 
 bool InvolvesAllGivenRealItems( const std::vector<EDA_ITEM*>& aItems ) const;
 
 void SetReferenceOnlyPoints( std::vector<VECTOR2I> aPoints )
 {
 m_referenceOnlyPoints = std::move( aPoints );
 }
 
 const std::vector<VECTOR2I>& GetReferenceOnlyPoints() const { return m_referenceOnlyPoints; }
 
 void SetSnapLineOrigin( const VECTOR2I& aOrigin );
 
 void SetSnapLineEnd( const OPT_VECTOR2I& aSnapPoint );
 
 void ClearSnapLine();
 
 std::optional<VECTOR2I> GetSnapLineOrigin() const { return m_snapLineOrigin; }
 
 void SetSnappedAnchor( const VECTOR2I& aAnchorPos );
 
 // Get the list of additional geometry items that should be considered
 std::vector<CONSTRUCTION_ITEM_BATCH> GetConstructionItems() const;
 
 OPT_VECTOR2I GetNearestSnapLinePoint( const VECTOR2I& aCursor, const VECTOR2I& aNearestGrid,
 std::optional<int> aDistToNearest, int snapRange ) const;
 
 using GFX_UPDATE_CALLBACK = std::function<void( bool )>;
 void SetUpdateCallback( GFX_UPDATE_CALLBACK aCallback ) { m_updateCallback = aCallback; }
 
private:
 void updateView();
 
 // An (external) construction helper view item, that this manager adds/removes
 // construction objects to/from.
 KIGFX::CONSTRUCTION_GEOM& m_constructionGeomPreview;
 
 // Within one "operation", there is one set of construction items that are
 // "persistent", and are always shown. Usually the original item and any
 // extensions.
 std::optional<CONSTRUCTION_ITEM_BATCH> m_persistentConstructionBatch;
 
 // Temporary construction items are added and removed as needed
 std::deque<CONSTRUCTION_ITEM_BATCH> m_temporaryConstructionBatches;
 
 // Set of all items for which construction geometry has been added
 std::set<EDA_ITEM*> m_involvedItems;
 
 std::vector<VECTOR2I> m_referenceOnlyPoints;
 
 // If a snap point is "active", extra construction geometry is added to the helper
 // extending from the snap point to the cursor.
 OPT_VECTOR2I m_snapLineOrigin;
 OPT_VECTOR2I m_snapLineEnd;
 
 GFX_UPDATE_CALLBACK m_updateCallback;
};