A class that manages "construction" objects and geometry. More...

#include <construction_manager.h>

Classes
struct	CONSTRUCTION_ITEM
	Items to be used for the construction of "virtual" anchors, for example, when snapping to a point involving an extension of an existing line or arc. More...

struct	PENDING_BATCH

Public Types
enum class	SOURCE { FROM_ITEMS , FROM_SNAP_LINE }

using	CONSTRUCTION_ITEM_BATCH = std::vector<CONSTRUCTION_ITEM>

Public Member Functions
	CONSTRUCTION_MANAGER (CONSTRUCTION_VIEW_HANDLER &aViewHandler)

	~CONSTRUCTION_MANAGER ()

void	ProposeConstructionItems (std::unique_ptr< CONSTRUCTION_ITEM_BATCH > aBatch, bool aIsPersistent)
	Add a batch of construction items to the helper.

void	CancelProposal ()
	Cancel outstanding proposals for new geometry.

void	Clear ()
	Clear all construction items.

bool	InvolvesAllGivenRealItems (const std::vector< EDA_ITEM * > &aItems) const
	Check if all 'real' (non-null = constructed) the items in the batch are in the list of items currently 'involved' in an active construction.

void	GetConstructionItems (std::vector< CONSTRUCTION_ITEM_BATCH > &aToExtend) const
	Get the list of additional geometry items that should be considered.

void	GetPendingConstructionItems (std::vector< CONSTRUCTION_ITEM_BATCH > &aToExtend) const
	Get the construction proposal awaiting activation.

bool	HasActiveConstruction () const

Private Member Functions
void	acceptConstructionItems (std::unique_ptr< PENDING_BATCH > aAcceptedBatchHash)

unsigned	getMaxTemporaryBatches () const
	How many batches of temporary construction items can be active at once.

Private Attributes
CONSTRUCTION_VIEW_HANDLER &	m_viewHandler

std::optional< CONSTRUCTION_ITEM_BATCH >	m_persistentConstructionBatch
	Within one "operation", there is one set of construction items that are "persistent", and are always shown.

std::deque< CONSTRUCTION_ITEM_BATCH >	m_temporaryConstructionBatches
	Temporary construction items are added and removed as needed.

std::set< EDA_ITEM * >	m_involvedItems
	Set of all items for which construction geometry has been added.

std::unique_ptr< ACTIVATION_HELPER< std::unique_ptr< PENDING_BATCH > > >	m_activationHelper

std::mutex	m_batchesMutex
	Protects the persistent and temporary construction batches.

Detailed Description

A class that manages "construction" objects and geometry.

These are things like line extensions, arc centers, etc.

Definition at line 154 of file construction_manager.h.

Member Typedef Documentation

◆ CONSTRUCTION_ITEM_BATCH

using CONSTRUCTION_MANAGER::CONSTRUCTION_ITEM_BATCH = std::vector<CONSTRUCTION_ITEM>

Definition at line 190 of file construction_manager.h.

Member Enumeration Documentation

◆ SOURCE

enum class CONSTRUCTION_MANAGER::SOURCE

strong

Enumerator
FROM_ITEMS
FROM_SNAP_LINE

Definition at line 160 of file construction_manager.h.

Constructor & Destructor Documentation

◆ CONSTRUCTION_MANAGER()

CONSTRUCTION_MANAGER::CONSTRUCTION_MANAGER ( CONSTRUCTION_VIEW_HANDLER & aViewHandler )

Definition at line 180 of file construction_manager.cpp.

References acceptConstructionItems(), ADVANCED_CFG::GetCfg(), m_activationHelper, m_batchesMutex, m_involvedItems, m_persistentConstructionBatch, m_temporaryConstructionBatches, and m_viewHandler.

◆ ~CONSTRUCTION_MANAGER()

CONSTRUCTION_MANAGER::~CONSTRUCTION_MANAGER ( )

Definition at line 203 of file construction_manager.cpp.

Member Function Documentation

◆ acceptConstructionItems()

void CONSTRUCTION_MANAGER::acceptConstructionItems ( std::unique_ptr< PENDING_BATCH > aAcceptedBatchHash )

private

Definition at line 258 of file construction_manager.cpp.

References KIGFX::CONSTRUCTION_GEOM::AddDrawable(), KIGFX::CONSTRUCTION_GEOM::ClearDrawables(), CONSTRUCTION_MANAGER::CONSTRUCTION_ITEM::DRAWABLE_ENTRY::Drawable, getMaxTemporaryBatches(), CONSTRUCTION_MANAGER::CONSTRUCTION_ITEM::Item, CONSTRUCTION_MANAGER::CONSTRUCTION_ITEM::DRAWABLE_ENTRY::LineWidth, m_batchesMutex, m_involvedItems, m_persistentConstructionBatch, m_temporaryConstructionBatches, and m_viewHandler.

Referenced by CONSTRUCTION_MANAGER().

◆ CancelProposal()

void CONSTRUCTION_MANAGER::CancelProposal ( )

Cancel outstanding proposals for new geometry.

Definition at line 244 of file construction_manager.cpp.

References m_activationHelper.

Referenced by Clear(), EE_GRID_HELPER::ResolveSnap(), and PCB_GRID_HELPER::ResolveSnap().

◆ Clear()

void CONSTRUCTION_MANAGER::Clear ( )

Clear all construction items.

Definition at line 887 of file construction_manager.cpp.

References CancelProposal(), m_batchesMutex, m_involvedItems, m_persistentConstructionBatch, and m_temporaryConstructionBatches.

Referenced by EE_GRID_HELPER::ResolveSnap(), and PCB_GRID_HELPER::ResolveSnap().

◆ GetConstructionItems()

void CONSTRUCTION_MANAGER::GetConstructionItems ( std::vector< CONSTRUCTION_ITEM_BATCH > & aToExtend ) const

Get the list of additional geometry items that should be considered.

Definition at line 365 of file construction_manager.cpp.

References m_batchesMutex, m_persistentConstructionBatch, and m_temporaryConstructionBatches.

◆ getMaxTemporaryBatches()

unsigned CONSTRUCTION_MANAGER::getMaxTemporaryBatches ( ) const

private

How many batches of temporary construction items can be active at once.

This is to prevent too much clutter.

Definition at line 250 of file construction_manager.cpp.

Referenced by acceptConstructionItems().

◆ GetPendingConstructionItems()

void CONSTRUCTION_MANAGER::GetPendingConstructionItems ( std::vector< CONSTRUCTION_ITEM_BATCH > & aToExtend ) const

Get the construction proposal awaiting activation.

Definition at line 381 of file construction_manager.cpp.

References m_activationHelper.

◆ HasActiveConstruction()

bool CONSTRUCTION_MANAGER::HasActiveConstruction ( ) const

Definition at line 392 of file construction_manager.cpp.

References m_batchesMutex, m_persistentConstructionBatch, and m_temporaryConstructionBatches.

◆ InvolvesAllGivenRealItems()

bool CONSTRUCTION_MANAGER::InvolvesAllGivenRealItems ( const std::vector< EDA_ITEM * > & aItems ) const

Check if all 'real' (non-null = constructed) the items in the batch are in the list of items currently 'involved' in an active construction.

Definition at line 350 of file construction_manager.cpp.

References m_involvedItems.

Referenced by PCB_GRID_HELPER::nearestAnchor().

◆ ProposeConstructionItems()

void CONSTRUCTION_MANAGER::ProposeConstructionItems	(	std::unique_ptr< CONSTRUCTION_ITEM_BATCH >	aBatch,
		bool	aIsPersistent )

Add a batch of construction items to the helper.

Parameters

aBatch	The batch of construction items to add.
aIsPersistent	If true, the batch is considered "persistent" and will always be shown (and it will replace any previous persistent batch). If false, the batch is temporary and may be pushed out by other batches.

Definition at line 225 of file construction_manager.cpp.

References HashConstructionBatchSources(), and m_activationHelper.

Referenced by EE_GRID_HELPER::AddConstructionItems(), and PCB_GRID_HELPER::AddConstructionItems().

Member Data Documentation

◆ m_activationHelper

std::unique_ptr<ACTIVATION_HELPER<std::unique_ptr<PENDING_BATCH> > > CONSTRUCTION_MANAGER::m_activationHelper

private

Definition at line 256 of file construction_manager.h.

Referenced by CancelProposal(), CONSTRUCTION_MANAGER(), GetPendingConstructionItems(), and ProposeConstructionItems().

◆ m_batchesMutex

std::mutex CONSTRUCTION_MANAGER::m_batchesMutex

mutableprivate

Protects the persistent and temporary construction batches.

Definition at line 259 of file construction_manager.h.

Referenced by acceptConstructionItems(), Clear(), CONSTRUCTION_MANAGER(), GetConstructionItems(), and HasActiveConstruction().

◆ m_involvedItems

std::set<EDA_ITEM*> CONSTRUCTION_MANAGER::m_involvedItems

private

Set of all items for which construction geometry has been added.

Definition at line 254 of file construction_manager.h.

Referenced by acceptConstructionItems(), Clear(), CONSTRUCTION_MANAGER(), and InvolvesAllGivenRealItems().

◆ m_persistentConstructionBatch

std::optional<CONSTRUCTION_ITEM_BATCH> CONSTRUCTION_MANAGER::m_persistentConstructionBatch

private

Within one "operation", there is one set of construction items that are "persistent", and are always shown.

Usually the original item and any extensions.

Definition at line 248 of file construction_manager.h.

Referenced by acceptConstructionItems(), Clear(), CONSTRUCTION_MANAGER(), GetConstructionItems(), and HasActiveConstruction().

◆ m_temporaryConstructionBatches

std::deque<CONSTRUCTION_ITEM_BATCH> CONSTRUCTION_MANAGER::m_temporaryConstructionBatches

private

Temporary construction items are added and removed as needed.

Definition at line 251 of file construction_manager.h.

Referenced by acceptConstructionItems(), Clear(), CONSTRUCTION_MANAGER(), GetConstructionItems(), and HasActiveConstruction().

◆ m_viewHandler

CONSTRUCTION_VIEW_HANDLER& CONSTRUCTION_MANAGER::m_viewHandler

private

Definition at line 243 of file construction_manager.h.

Referenced by acceptConstructionItems(), and CONSTRUCTION_MANAGER().

The documentation for this class was generated from the following files:

Classes

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ CONSTRUCTION_ITEM_BATCH

Member Enumeration Documentation

◆ SOURCE

Constructor & Destructor Documentation

◆ CONSTRUCTION_MANAGER()

◆ ~CONSTRUCTION_MANAGER()

Member Function Documentation

◆ acceptConstructionItems()

◆ CancelProposal()

◆ Clear()

◆ GetConstructionItems()

◆ getMaxTemporaryBatches()

◆ GetPendingConstructionItems()

◆ HasActiveConstruction()

◆ InvolvesAllGivenRealItems()

◆ ProposeConstructionItems()

Member Data Documentation

◆ m_activationHelper

◆ m_batchesMutex

◆ m_involvedItems

◆ m_persistentConstructionBatch

◆ m_temporaryConstructionBatches

◆ m_viewHandler