43#include <unordered_map>
47#ifdef KICAD_GAL_PROFILE
116 std::pair<int, int>* newGroups =
new std::pair<int, int>[
m_groupsSize + 1];
161 int new_layer = orig_layer;
163 if( aReorderMap.count( orig_layer ) )
164 new_layer = aReorderMap.at( orig_layer );
180 for(
int layer : aLayers )
183 wxString::Format( wxT(
"Invalid layer number: %d" ), layer ) );
257 typedef std::numeric_limits<int> coord_limits;
258 double pos = coord_limits::lowest() / 2 + coord_limits::epsilon();
259 double size = coord_limits::max() - coord_limits::epsilon();
263 m_allItems.reset(
new std::vector<VIEW_ITEM*> );
278 l.
items = std::make_shared<VIEW_RTREE>();
303 if( aDrawPriority < 0 )
310 wxS(
"Already in a different view!" ) );
320 std::erase_if( layers, [](
int layer )
332 for(
int layer : layers )
335 l.
items->Insert( aItem, bbox );
347 std::unordered_map<int, std::vector<std::pair<VIEW_ITEM*, BOX2I>>> layerBulk;
356 if( !item->m_viewPrivData )
359 item->m_viewPrivData->
m_view =
this;
360 item->m_viewPrivData->m_drawPriority = drawPriority;
361 const BOX2I bbox = item->ViewBBox();
362 item->m_viewPrivData->m_bbox = bbox;
363 item->m_viewPrivData->m_cachedIndex =
m_allItems->size();
365 std::vector<int> layers = item->ViewGetLayers();
367 std::erase_if( layers, [](
int layer )
375 item->viewPrivData()->saveLayers( layers );
378 for(
int layer : layers )
379 layerBulk[layer].emplace_back( item, bbox );
383 for(
auto& [layerId, items] : layerBulk )
386 l.
items->BulkLoad( items );
396 if( !item || !item->m_viewPrivData || item->m_viewPrivData->m_view !=
this )
407 static int s_gcCounter = 0;
413 wxLogDebug( wxT(
"VIEW::Remove: item %s belongs to a different view" ), aItem->
GetClass() );
417 std::vector<VIEW_ITEM*>::iterator item =
m_allItems->end();
421 && cachedIndex <
static_cast<ssize_t
>(
m_allItems->size() )
438 if( s_gcCounter > 4096 )
444 return it ==
nullptr;
448 for(
size_t idx = 0; idx <
m_allItems->size(); idx++ )
449 ( *
m_allItems )[idx]->m_viewPrivData->m_cachedIndex = idx;
460 l.
items->Remove( aItem, bbox );
467 m_gal->DeleteGroup( prevGroup );
478 wxCHECK( (
unsigned) aLayerId <
m_layers.size(), );
479 wxCHECK( (
unsigned) aRequiredId <
m_layers.size(), );
482 m_layers[aLayerId].requiredLayers.insert( aRequiredId );
484 m_layers[aLayerId].requiredLayers.erase( aRequired );
501 std::vector<VIEW_LAYER*>::const_reverse_iterator i;
508 if( ( *i )->displayOnly || !( *i )->visible )
512 ( *i )->items->Query( aRect, visitor );
515 return aResult.size();
527 if( i->displayOnly || !i->visible )
530 i->items->Query( aRect, aFunc );
550 return fabs( matrix.
GetScale().
x * aSize );
575 wxASSERT_MSG(
false, wxT(
"This is not implemented" ) );
581 bool recacheGroups = (
m_gal != nullptr );
614 wxCHECK( fabs(ssize.
x) > 0 && fabs(ssize.
y) > 0, );
618 double zoom = 1.0 / std::max( fabs( vsize.
x / ssize.
x ), fabs( vsize.
y / ssize.
y ) );
627 wxASSERT_MSG( !aMirrorY,
_(
"Mirroring for Y axis is not supported yet" ) );
631 m_gal->SetFlip( aMirrorX, aMirrorY );
653 m_gal->ComputeWorldScreenMatrix();
682 m_gal->ComputeWorldScreenMatrix();
691 if( obscuringScreenRects.empty() )
694 BOX2D screenRect( { 0, 0 },
m_gal->GetScreenPixelSize() );
698 for(
const BOX2D& obscuringScreenRect : obscuringScreenRects )
714 while( !unobscuredPoly.
IsEmpty() )
716 unobscuredCenter = unobscuredPoly.
BBox().
Centre();
726 m_layers[aLayer].renderingOrder = aRenderingOrder;
735 return m_layers.at( aLayer ).renderingOrder;
741 std::sort( aLayers.begin(), aLayers.end(),
742 [
this](
int a,
int b )
744 return GetLayerOrder( a ) > GetLayerOrder( b );
751 std::map<int,VIEW_LAYER> new_map;
755 auto reorder_it = aReorderMap.find( layer.id );
759 if( reorder_it == aReorderMap.end() || reorder_it->second == layer.id )
761 new_map.emplace( layer.id, layer );
765 auto [new_it,__] = new_map.emplace( reorder_it->second, layer );
766 new_it->second.id = reorder_it->second;
784 std::vector<int> layers = item->ViewGetLayers();
813 gal->ChangeGroupColor(
group, color );
834 if(
m_gal->IsVisible() )
839 m_layers[aLayer].items->Query( r, visitor );
847 if(
m_gal->IsVisible() )
861 for(
int layer : viewData->
m_layers )
943 std::set<unsigned int>::iterator it;
963 std::set<unsigned int>::iterator it;
980 if(
m_gal->IsVisible() )
994 for(
int layer : viewData->
m_layers )
1035 if( !drawCondition )
1053 return b->viewPrivData()->m_drawPriority
1054 < a->viewPrivData()->m_drawPriority;
1062 return a->viewPrivData()->m_drawPriority
1063 < b->viewPrivData()->m_drawPriority;
1088 m_gal->SetTarget( l->target );
1089 m_gal->SetLayerDepth( l->renderingOrder );
1094 m_gal->StartDiffLayer();
1095 else if( l->hasNegatives )
1096 m_gal->StartNegativesLayer();
1098 l->items->Query( aRect, drawFunc );
1104 m_gal->EndDiffLayer();
1105 else if( l->hasNegatives )
1106 m_gal->EndNegativesLayer();
1113 m_gal->EnableDepthTest(
true );
1114 m_gal->SetLayerDepth( l->renderingOrder );
1116 l->items->Query( aRect, drawFunc );
1130 if(
IsCached( aLayer ) && !aImmediate )
1157 for(
int layer : layers )
1165 m_gal->SetLayerDepth( it->second.renderingOrder );
1167 draw( aItem, layer, aImmediate );
1174 for(
unsigned int i = 0; i < aGroup->
GetSize(); i++ )
1223 if( item && item->m_viewPrivData )
1224 item->m_viewPrivData->m_view =
nullptr;
1230 layer.items->RemoveAll();
1234 m_gal->ClearCache();
1259#ifdef KICAD_GAL_PROFILE
1275#ifdef KICAD_GAL_PROFILE
1276 totalRealTime.
Stop();
1284 return m_gal->GetScreenPixelSize();
1314 layer.items->Query( r, visitor );
1330 if( aUpdateFlags &
LAYERS )
1339 for(
int layer : layers )
1345 else if( aUpdateFlags &
COLOR )
1363 for(
auto& [layer_id, layer] :
m_layers )
1436 if( new_bbox == old_bbox )
1441 for(
int layer : layers )
1449 l.
items->Remove( aItem, &old_bbox );
1450 l.
items->Insert( aItem, new_bbox );
1467 if( newLayers == viewData->
m_layers && new_bbox == viewData->
m_bbox )
1481 l.
items->Remove( aItem, &old_bbox );
1487 int prevGroup = viewData->
getGroup( layer );
1489 if( prevGroup >= 0 )
1491 m_gal->DeleteGroup( prevGroup );
1500 for(
int layer : newLayers )
1508 l.
items->Insert( aItem, new_bbox );
1516 auto it =
m_layers.find( aLayerId );
1521 for(
int layer : it->second.requiredLayers )
1527 if( it2 ==
m_layers.end() || !it2->second.visible )
1549 l.items->Query( r, visitor );
1557 if( !
m_gal->IsVisible() || !
m_gal->IsInitialized() )
1563 unsigned int cntGeomUpdate = 0;
1564 bool anyUpdated =
false;
1571 auto vpd = item->viewPrivData();
1576 if( vpd->m_requiredUpdate !=
NONE )
1587 double ratio = (double) cntGeomUpdate / (
double) cntTotal;
1598 layer.items->RemoveAll();
1601 std::unordered_map<int, std::vector<std::pair<VIEW_ITEM*, BOX2I>>> layerBulk;
1608 const BOX2I bbox = item->ViewBBox();
1609 item->m_viewPrivData->m_bbox = bbox;
1611 std::vector<int> layers = item->ViewGetLayers();
1612 item->viewPrivData()->saveLayers( layers );
1614 for(
int layer : layers )
1618 wxCHECK2_MSG( it !=
m_layers.end(),
continue, wxS(
"Invalid layer" ) );
1619 layerBulk[layer].emplace_back( item, bbox );
1625 if( item->viewPrivData()->m_requiredUpdate & (
LAYERS |
GEOMETRY ) )
1627 item->viewPrivData()->m_requiredUpdate &= ~(
LAYERS |
GEOMETRY );
1628 item->viewPrivData()->m_requiredUpdate |=
REPAINT;
1633 for(
auto& [layerId, items] : layerBulk )
1635 auto it =
m_layers.find( layerId );
1639 it->second.items->BulkLoad( items );
1651 if( item && item->viewPrivData() && item->viewPrivData()->m_requiredUpdate !=
NONE )
1654 item->viewPrivData()->m_requiredUpdate =
NONE;
1660 cntTotal, cntGeomUpdate, (
unsigned) anyUpdated );
1668 if( aUpdateFlags ==
NONE )
1673 if( item && item->viewPrivData() )
1675 item->viewPrivData()->m_requiredUpdate |= aUpdateFlags;
1683 std::function<
bool(
VIEW_ITEM* )> aCondition )
1685 if( aUpdateFlags ==
NONE )
1693 if( aCondition( item ) )
1695 if( item->viewPrivData() )
1697 item->viewPrivData()->m_requiredUpdate |= aUpdateFlags;
1712 if( item->viewPrivData() )
1714 int flags = aItemFlagsProvider( item );
1715 item->viewPrivData()->m_requiredUpdate |= flags;
1727 std::unique_ptr<VIEW> ret = std::make_unique<VIEW>();
1731 ret->SortOrderedLayers();
1745 if( cur_visible != aIsVisible )
1799 return viewData && viewData->
m_view ==
this;
1816 assert( aUpdateFlags !=
NONE );
1825 std::shared_ptr<VIEW_OVERLAY>
overlay = std::make_shared<VIEW_OVERLAY>();
1856 Hide( aItem,
false );
1859 if( aTakeOwnership )
constexpr int ARC_LOW_DEF
constexpr BOX2I BOX2ISafe(const BOX2D &aInput)
constexpr void SetMaximum()
constexpr void SetOrigin(const Vec &pos)
constexpr BOX2< Vec > & Normalize()
Ensure that the height and width are positive.
constexpr size_type GetWidth() const
constexpr Vec Centre() const
constexpr size_type GetHeight() const
constexpr const SizeVec & GetSize() const
constexpr void SetEnd(coord_type x, coord_type y)
A color representation with 4 components: red, green, blue, alpha.
Abstract interface for drawing on a 2D-surface.
Contains all the knowledge about how to draw graphical object onto any particular output device.
Extend VIEW_ITEM by possibility of grouping items into a single object.
virtual unsigned int GetSize() const
Return the number of stored items.
virtual VIEW_ITEM * GetItem(unsigned int aIdx) const
bool storesGroups() const
Return information if the item uses at least one group id (ie.
std::vector< int > m_layers
int requiredUpdate() const
Return current update flag for an item.
int m_requiredUpdate
Flag required for updating.
int m_flags
Visibility flags.
void reorderGroups(std::unordered_map< int, int > aReorderMap)
Reorder the stored groups (to facilitate reordering of layers).
int m_cachedIndex
Cached index in m_allItems.
void deleteGroups()
Remove all of the stored group ids.
bool isRenderable() const
Return if the item should be drawn or not.
int m_drawPriority
Order to draw this item in a layer, lowest first.
VIEW * m_view
Current dynamic view the item is assigned to.
std::pair< int, int > * m_groups
layer_number:group_id pairs for each layer the item occupies.
int getGroup(int aLayer) const
Return number of the group id for the given layer, or -1 in case it was not cached before.
BOX2I m_bbox
Stores layer numbers used by the item.
void setGroup(int aLayer, int aGroup)
Set a group id for the item and the layer combination.
void saveLayers(const std::vector< int > &aLayers)
Save layers used by the item.
void clearUpdateFlags()
Mark an item as already updated, so it is not going to be redrawn.
virtual const BOX2I ViewBBox() const =0
Return the bounding box of the item covering all its layers.
double m_forcedTransparency
Additional transparency for diff'ing items.
VIEW_ITEM_DATA * viewPrivData() const
virtual void ViewDraw(int aLayer, VIEW *aView) const
Draw the parts of the object belonging to layer aLayer.
virtual std::vector< int > ViewGetLayers() const =0
Return the all the layers within the VIEW the object is painted on.
virtual wxString GetClass() const =0
Return the class name.
virtual double ViewGetLOD(int aLayer, const VIEW *aView) const
Return the level of detail (LOD) of the item.
VIEW_ITEM_DATA * m_viewPrivData
Hold a (potentially large) number of VIEW_ITEMs and renders them on a graphics device provided by the...
void SetMirror(bool aMirrorX, bool aMirrorY)
Control the mirroring of the VIEW.
void ShowPreview(bool aShow=true)
BOX2D GetViewport() const
Return the current viewport visible area rectangle.
void CopySettings(const VIEW *aOtherView)
Copy layers and visibility settings from another view.
virtual void SetScale(double aScale, VECTOR2D aAnchor={ 0, 0 })
Set the scaling factor, zooming around a given anchor point.
static constexpr int TOP_LAYER_MODIFIER
Rendering order modifier for layers that are marked as top layers.
void draw(VIEW_ITEM *aItem, int aLayer, bool aImmediate=false)
Draw an item, but on a specified layers.
bool m_reverseDrawOrder
Flag to reverse the draw order when using draw priority.
void UpdateAllLayersOrder()
Do everything that is needed to apply the rendering order of layers.
void updateItemColor(VIEW_ITEM *aItem, int aLayer)
Update colors that are used for an item to be drawn.
void SetViewport(const BOX2D &aViewport)
Set the visible area of the VIEW.
void SetRequired(int aLayerId, int aRequiredId, bool aRequired=true)
Mark the aRequiredId layer as required for the aLayerId layer.
VECTOR2D ToScreen(const VECTOR2D &aCoord, bool aAbsolute=true) const
Convert a world space point/vector to a point/vector in screen space coordinates.
static bool compareRenderingOrder(VIEW_LAYER *aI, VIEW_LAYER *aJ)
Determine rendering order of layers. Used in display order sorting function.
int GetLayerOrder(int aLayer) const
Return rendering order of a particular layer.
virtual void Add(VIEW_ITEM *aItem, int aDrawPriority=-1)
Add a VIEW_ITEM to the view.
virtual void Remove(VIEW_ITEM *aItem)
Remove a VIEW_ITEM from the view.
void ClearTargets()
Clear targets that are marked as dirty.
virtual void EnableTopLayer(bool aEnable)
Enable or disable display of the top layer.
void UpdateAllLayersColor()
Apply the new coloring scheme to all layers.
std::shared_ptr< std::vector< VIEW_ITEM * > > m_allItems
Flat list of all items.
std::shared_ptr< VIEW_OVERLAY > MakeOverlay()
void SetGAL(GAL *aGal)
Assign a rendering device for the VIEW.
int Query(const BOX2I &aRect, std::vector< LAYER_ITEM_PAIR > &aResult) const
Find all visible items that touch or are within the rectangle aRect.
std::vector< VIEW_ITEM * > m_ownedItems
virtual void Update(const VIEW_ITEM *aItem, int aUpdateFlags) const
For dynamic VIEWs, inform the associated VIEW that the graphical representation of this item has chan...
void invalidateItem(VIEW_ITEM *aItem, int aUpdateFlags)
Manage dirty flags & redraw queuing when updating an item.
const VECTOR2I & GetScreenPixelSize() const
Return the size of the our rendering area in pixels.
bool HasItem(const VIEW_ITEM *aItem) const
Indicates whether or not the given item has been added to the view.
virtual int GetTopLayer() const
PAINTER * m_painter
PAINTER contains information how do draw items.
virtual void Redraw()
Immediately redraws the whole view.
void Clear()
Remove all items from the view.
std::set< unsigned int > m_topLayers
The set of layers that are displayed on the top.
bool m_enableOrderModifier
Whether to use rendering order modifier or not.
VECTOR2D ToWorld(const VECTOR2D &aCoord, bool aAbsolute=true) const
Converts a screen space point/vector to a point/vector in world space coordinates.
bool IsHiddenOnOverlay(const VIEW_ITEM *aItem) const
void ClearTopLayers()
Remove all layers from the on-the-top set (they are no longer displayed over the rest of layers).
void SetLayerOrder(int aLayer, int aRenderingOrder, bool aAutoSort=true)
Set rendering order of a particular layer.
void MarkClean()
Force redraw of view on the next rendering.
void updateItemGeometry(VIEW_ITEM *aItem, int aLayer)
Update all information needed to draw an item.
static constexpr int VIEW_MAX_LAYERS
Maximum number of layers that may be shown.
void updateLayers(VIEW_ITEM *aItem)
Update set of layers that an item occupies.
void RecacheAllItems()
Rebuild GAL display lists.
bool areRequiredLayersEnabled(int aLayerId) const
Check if every layer required by the aLayerId layer is enabled.
bool IsTargetDirty(int aTarget) const
Return true if any of layers belonging to the target or the target itself should be redrawn.
int m_nextDrawPriority
The next sequential drawing priority.
bool m_useDrawPriority
Flag to respect draw priority when drawing items.
void UpdateItems()
Iterate through the list of items that asked for updating and updates them.
bool IsCached(int aLayer) const
Return true if the layer is cached.
void AddBatch(const std::vector< VIEW_ITEM * > &aItems)
Add a batch of items to the view, using bulk-loaded R-trees for initial population.
std::pair< VIEW_ITEM *, int > LAYER_ITEM_PAIR
void SortLayers(std::vector< int > &aLayers) const
Change the order of given layer ids, so after sorting the order corresponds to layers rendering order...
void UpdateAllItems(int aUpdateFlags)
Update all items in the view according to the given flags.
bool m_hasPendingItemUpdates
True when at least one item has deferred update flags that still need processing.
std::unique_ptr< KIGFX::VIEW_GROUP > m_preview
static void OnDestroy(VIEW_ITEM *aItem)
Nasty hack, invoked by the destructor of VIEW_ITEM to auto-remove the item from the owning VIEW if th...
GAL * m_gal
Interface to PAINTER that is used to draw items.
std::map< int, VIEW_LAYER > m_layers
The set of possible displayed layers and its properties.
std::unique_ptr< VIEW > DataReference() const
Return a new VIEW object that shares the same set of VIEW_ITEMs and LAYERs.
void Hide(VIEW_ITEM *aItem, bool aHide=true, bool aHideOverlay=false)
Temporarily hide the item in the view (e.g.
virtual void SetTopLayer(int aLayer, bool aEnabled=true)
Set given layer to be displayed on the top or sets back the default order of layers.
void AddToPreview(VIEW_ITEM *aItem, bool aTakeOwnership=true)
void UpdateLayerColor(int aLayer)
Apply the new coloring scheme held by RENDER_SETTINGS in case that it has changed.
void MarkDirty()
Force redraw of view on the next rendering.
void SetCenter(const VECTOR2D &aCenter)
Set the center point of the VIEW (i.e.
std::vector< VIEW_LAYER * > m_orderedLayers
Sorted list of pointers to members of m_layers.
void clearGroupCache()
Clear cached GAL group numbers (ONLY numbers stored in VIEW_ITEMs, not group objects used by GAL).
VECTOR2D m_center
Center point of the VIEW (the point at which we are looking at).
void SortOrderedLayers()
Sorts m_orderedLayers after layer rendering order has changed.
void MarkTargetDirty(int aTarget)
Set or clear target 'dirty' flag.
void updateBbox(VIEW_ITEM *aItem)
Update bounding box of an item.
bool IsVisible(const VIEW_ITEM *aItem) const
Return information if the item is visible (or not).
void UpdateAllItemsConditionally(int aUpdateFlags, std::function< bool(VIEW_ITEM *)> aCondition)
Update items in the view according to the given flags and condition.
void SetVisible(VIEW_ITEM *aItem, bool aIsVisible=true)
Set the item visibility.
void ReorderLayerData(std::unordered_map< int, int > aReorderMap)
Remap the data between layer ids without invalidating that data.
void redrawRect(const BOX2I &aRect)
Redraw contents within rectangle aRect.
VECTOR2< T > GetScale() const
Get the scale components of the matrix.
A small class to help profiling.
void Stop()
Save the time when this function was called, and set the counter stane to stop.
double msecs(bool aSinceLast=false)
Represent a set of closed polygons.
bool IsEmpty() const
Return true if the set is empty (no polygons at all)
void Deflate(int aAmount, CORNER_STRATEGY aCornerStrategy, int aMaxError)
void BooleanSubtract(const SHAPE_POLY_SET &b)
Perform boolean polyset difference.
const BOX2I BBox(int aClearance=0) const override
Compute a bounding box of the shape, with a margin of aClearance a collision.
@ ALLOW_ACUTE_CORNERS
just inflate the polygon. Acute angles create spikes
const wxChar *const traceGalProfile
Flag to enable debug output of GAL performance profiling.
MATRIX3x3< double > MATRIX3x3D
The Cairo implementation of the graphics abstraction layer.
@ COLOR
Color has changed.
@ INITIAL_ADD
Item is being added to the view.
@ NONE
No updates are required.
@ REPAINT
Item needs to be redrawn.
@ APPEARANCE
Visibility flag has changed.
@ GEOMETRY
Position or shape has changed.
@ LAYERS
Layers have changed.
@ ALL
All except INITIAL_ADD.
@ TARGET_NONCACHED
Auxiliary rendering target (noncached)
@ TARGET_CACHED
Main rendering target (cached)
@ TARGET_OVERLAY
Items that may change while the view stays the same (noncached)
@ HIDDEN
Item is temporarily hidden (usually in favor of a being drawn from an overlay, such as a SELECTION).
@ OVERLAY_HIDDEN
Item is temporarily hidden from being drawn on an overlay.
@ VISIBLE
Item is visible (in general)
std::shared_ptr< PNS_LOG_VIEWER_OVERLAY > overlay
bool operator()(VIEW_ITEM *aItem)
CLEAR_LAYER_CACHE_VISITOR(VIEW *aView)
bool operator()(VIEW_ITEM *aItem)
DRAW_ITEM_VISITOR(VIEW *aView, int aLayer, bool aUseDrawPriority, bool aReverseDrawOrder)
bool foundForcedTransparent
int layers[VIEW_MAX_LAYERS]
bool drawForcedTransparent
std::vector< VIEW_ITEM * > drawItems
bool operator()(VIEW_ITEM *aItem)
RECACHE_ITEM_VISITOR(VIEW *aView, GAL *aGal, int aLayer)
bool operator()(VIEW_ITEM *aItem)
UPDATE_COLOR_VISITOR(int aLayer, PAINTER *aPainter, GAL *aGal)
UPDATE_DEPTH_VISITOR(int aLayer, int aDepth, GAL *aGal)
bool operator()(VIEW_ITEM *aItem)
bool diffLayer
Layer should be drawn differentially over lower layers.
int renderingOrder
Rendering order of this layer.
bool hasNegatives
Layer should be drawn separately to not delete lower layers.
bool visible
Is the layer to be rendered?
bool displayOnly
Is the layer display only?
std::shared_ptr< VIEW_RTREE > items
R-tree indexing all items on this layer.
RENDER_TARGET target
Where the layer should be rendered.
wxLogTrace helper definitions.
#define KI_TRACE(aWhat,...)
VECTOR2< int32_t > VECTOR2I
VECTOR2< double > VECTOR2D