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 <deque>
#include <memory>
#include <mutex>
#include <vector>
 
#include <preview_items/construction_geom.h>
 
template <typename T>
class ACTIVATION_HELPER;
class EDA_ITEM;
 
 
class CONSTRUCTION_VIEW_HANDLER
{
public:
    CONSTRUCTION_VIEW_HANDLER( KIGFX::CONSTRUCTION_GEOM& aHelper ) :
            m_constructionGeomPreview( aHelper )
    {
    }
 
    virtual void updateView() = 0;
 
    KIGFX::CONSTRUCTION_GEOM& GetViewItem() { return m_constructionGeomPreview; }
 
private:
    // An (external) construction helper view item, that this manager adds/removes
    // construction objects to/from.
    KIGFX::CONSTRUCTION_GEOM& m_constructionGeomPreview;
};
 
 
class SNAP_LINE_MANAGER
{
public:
    SNAP_LINE_MANAGER( CONSTRUCTION_VIEW_HANDLER& aViewHandler );
    void SetSnapLineOrigin( const VECTOR2I& aOrigin );
 
    void SetSnapLineEnd( const OPT_VECTOR2I& aSnapPoint );
 
    void ClearSnapLine();
 
    const OPT_VECTOR2I& GetSnapLineOrigin() const { return m_snapLineOrigin; }
 
    bool HasCompleteSnapLine() const { return m_snapLineOrigin && m_snapLineEnd; }
 
    void SetSnappedAnchor( const VECTOR2I& aAnchorPos );
 
    OPT_VECTOR2I GetNearestSnapLinePoint( const VECTOR2I& aCursor, const VECTOR2I& aNearestGrid,
                                          std::optional<int> aDistToNearest, int snapRange ) const;
 
private:
    // 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;
 
    // The view handler to update when the snap line changes
    CONSTRUCTION_VIEW_HANDLER& m_viewHandler;
};
 
 
class CONSTRUCTION_MANAGER
{
public:
    CONSTRUCTION_MANAGER( CONSTRUCTION_VIEW_HANDLER& aViewHandler );
    ~CONSTRUCTION_MANAGER();
 
    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 ProposeConstructionItems( std::unique_ptr<CONSTRUCTION_ITEM_BATCH> aBatch,
                                   bool                                     aIsPersistent );
 
    void CancelProposal();
 
    bool InvolvesAllGivenRealItems( const std::vector<EDA_ITEM*>& aItems ) const;
 
    // Get the list of additional geometry items that should be considered
    void GetConstructionItems( std::vector<CONSTRUCTION_ITEM_BATCH>& aToExtend ) const;
 
    bool HasActiveConstruction() const;
 
private:
    struct PENDING_BATCH;
 
    void acceptConstructionItems( std::unique_ptr<PENDING_BATCH> aAcceptedBatchHash );
 
    CONSTRUCTION_VIEW_HANDLER& m_viewHandler;
 
    // 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::unique_ptr<ACTIVATION_HELPER<std::unique_ptr<PENDING_BATCH>>> m_activationHelper;
 
    // Protects the persistent and temporary construction batches
    mutable std::mutex m_batchesMutex;
};
 
 
class SNAP_MANAGER : public CONSTRUCTION_VIEW_HANDLER
{
public:
    using GFX_UPDATE_CALLBACK = std::function<void( bool aShowAnything )>;
 
    SNAP_MANAGER( KIGFX::CONSTRUCTION_GEOM& aHelper );
 
    void SetUpdateCallback( GFX_UPDATE_CALLBACK aCallback ) { m_updateCallback = aCallback; }
 
    SNAP_LINE_MANAGER& GetSnapLineManager() { return m_snapLineManager; }
 
    CONSTRUCTION_MANAGER& GetConstructionManager() { return m_constructionManager; }
 
    void SetReferenceOnlyPoints( std::vector<VECTOR2I> aPoints )
    {
        m_referenceOnlyPoints = std::move( aPoints );
    }
 
    const std::vector<VECTOR2I>& GetReferenceOnlyPoints() const { return m_referenceOnlyPoints; }
 
    std::vector<CONSTRUCTION_MANAGER::CONSTRUCTION_ITEM_BATCH> GetConstructionItems() const;
 
public:
    void updateView() override;
 
    GFX_UPDATE_CALLBACK m_updateCallback;
 
    SNAP_LINE_MANAGER    m_snapLineManager;
    CONSTRUCTION_MANAGER m_constructionManager;
 
    std::vector<VECTOR2I> m_referenceOnlyPoints;
};