KiCad PCB EDA Suite
KIGFX::SCH_VIEW Class Reference

#include <sch_view.h>

Inheritance diagram for KIGFX::SCH_VIEW:
KIGFX::VIEW

Public Types

typedef std::pair< VIEW_ITEM *, int > LAYER_ITEM_PAIR
 

Public Member Functions

 SCH_VIEW (bool aIsDynamic)
 
 ~SCH_VIEW ()
 
void DisplaySheet (SCH_SHEET *aSheet)
 
void DisplaySheet (SCH_SCREEN *aSheet)
 
void DisplayComponent (LIB_PART *aPart)
 
KIGFX::PREVIEW::SELECTION_AREAGetSelectionArea () const
 
KIGFX::VIEW_GROUPGetPreview () const
 
void ClearPreview ()
 
void AddToPreview (EDA_ITEM *aItem, bool takeOwnership=true)
 
void ShowSelectionArea (bool aShow=true)
 
void ShowPreview (bool aShow=true)
 
void ClearHiddenFlags ()
 
void HideWorksheet ()
 
virtual void Add (VIEW_ITEM *aItem, int aDrawPriority=-1)
 Function Add() Adds a VIEW_ITEM to the view. More...
 
virtual void Remove (VIEW_ITEM *aItem)
 Function Remove() Removes a VIEW_ITEM from the view. More...
 
virtual int Query (const BOX2I &aRect, std::vector< LAYER_ITEM_PAIR > &aResult) const
 Function Query() Finds all visible items that touch or are within the rectangle aRect. More...
 
void SetVisible (VIEW_ITEM *aItem, bool aIsVisible=true)
 Sets the item visibility. More...
 
void Hide (VIEW_ITEM *aItem, bool aHide=true)
 Temporarily hides the item in the view (e.g. More...
 
bool IsVisible (const VIEW_ITEM *aItem) const
 Returns information if the item is visible (or not). More...
 
virtual void Update (VIEW_ITEM *aItem, int aUpdateFlags)
 For dynamic VIEWs, informs the associated VIEW that the graphical representation of this item has changed. More...
 
virtual void Update (VIEW_ITEM *aItem)
 
void SetRequired (int aLayerId, int aRequiredId, bool aRequired=true)
 Function SetRequired() Marks the aRequiredId layer as required for the aLayerId layer. More...
 
void CopySettings (const VIEW *aOtherView)
 Function CopySettings() Copies layers and visibility settings from another view. More...
 
void SetGAL (GAL *aGal)
 Function SetGAL() Assigns a rendering device for the VIEW. More...
 
GALGetGAL () const
 Function GetGAL() Returns the GAL this view is using to draw graphical primitives. More...
 
void SetPainter (PAINTER *aPainter)
 Function SetPainter() Sets the painter object used by the view for drawing VIEW_ITEMS. More...
 
PAINTERGetPainter () const
 Function GetPainter() Returns the painter object used by the view for drawing VIEW_ITEMS. More...
 
void SetViewport (const BOX2D &aViewport)
 Function SetViewport() Sets the visible area of the VIEW. More...
 
BOX2D GetViewport () const
 Function GetViewport() Returns the current viewport visible area rectangle. More...
 
void SetMirror (bool aMirrorX, bool aMirrorY)
 Function SetMirror() Controls the mirroring of the VIEW. More...
 
bool IsMirroredX () const
 Function IsMirroredX() Returns true if view is flipped across the X axis. More...
 
bool IsMirroredY () const
 Function IsMirroredX() Returns true if view is flipped across the Y axis. More...
 
void SetScale (double aScale)
 Function SetScale() Sets the scaling factor. More...
 
void SetScale (double aScale, const VECTOR2D &aAnchor)
 Function SetScale() Sets the scaling factor, zooming around a given anchor point. More...
 
double GetScale () const
 Function GetScale() More...
 
void SetBoundary (const BOX2D &aBoundary)
 Function SetBoundary() Sets limits for view area. More...
 
void SetBoundary (const BOX2I &aBoundary)
 Function SetBoundary() Sets limits for view area. More...
 
const BOX2DGetBoundary () const
 Function GetBoundary() More...
 
void SetScaleLimits (double aMaximum, double aMinimum)
 Function SetScaleLimits() Sets minimum and maximum values for scale. More...
 
void SetCenter (const VECTOR2D &aCenter)
 Function SetCenter() Sets the center point of the VIEW (i.e. More...
 
void SetCenter (VECTOR2D aCenter, const BOX2D &occultingScreenRect)
 Function SetCenter() Sets the center point of the VIEW, attempting to avoid occultingScreenRect (for instance, the screen rect of a modeless dialog in front of the VIEW). More...
 
const VECTOR2DGetCenter () const
 Function GetCenter() Returns the center point of this VIEW (in world space coordinates) More...
 
VECTOR2D ToWorld (const VECTOR2D &aCoord, bool aAbsolute=true) const
 Function ToWorld() Converts a screen space point/vector to a point/vector in world space coordinates. More...
 
double ToWorld (double aSize) const
 Function ToWorld() Converts a screen space one dimensional size to a one dimensional size in world space coordinates. More...
 
VECTOR2D ToScreen (const VECTOR2D &aCoord, bool aAbsolute=true) const
 Function ToScreen() Converts a world space point/vector to a point/vector in screen space coordinates. More...
 
double ToScreen (double aSize) const
 Function ToScreen() Converts a world space one dimensionsal size to a one dimensional size in screen space. More...
 
const VECTOR2IGetScreenPixelSize () const
 Function GetScreenPixelSize() Returns the size of the our rendering area, in pixels. More...
 
void AddLayer (int aLayer, bool aDisplayOnly=false)
 Function AddLayer() Adds a new layer to the view. More...
 
void ClearLayer (int aLayer)
 Function ClearLayer() Removes all items from a given layer. More...
 
void Clear ()
 Function Clear() Removes all items from the view. More...
 
void SetLayerVisible (int aLayer, bool aVisible=true)
 Function SetLayerVisible() Controls the visibility of a particular layer. More...
 
bool IsLayerVisible (int aLayer) const
 Function IsLayerVisible() Returns information about visibility of a particular layer. More...
 
void SetLayerDisplayOnly (int aLayer, bool aDisplayOnly=true)
 
void SetLayerTarget (int aLayer, RENDER_TARGET aTarget)
 Function SetLayerTarget() Changes the rendering target for a particular layer. More...
 
void SetLayerOrder (int aLayer, int aRenderingOrder)
 Function SetLayerOrder() Sets rendering order of a particular layer. More...
 
int GetLayerOrder (int aLayer) const
 Function GetLayerOrder() Returns rendering order of a particular layer. More...
 
void SortLayers (int aLayers[], int &aCount) const
 Function SortLayers() Changes the order of given layer ids, so after sorting the order corresponds to layers rendering order (descending, ie. More...
 
void ReorderLayerData (std::unordered_map< int, int > aReorderMap)
 Remaps the data between layer ids without invalidating that data. More...
 
void UpdateLayerColor (int aLayer)
 Function UpdateLayerColor() Applies the new coloring scheme held by RENDER_SETTINGS in case that it has changed. More...
 
void UpdateAllLayersColor ()
 Function UpdateAllLayersColor() Applies the new coloring scheme to all layers. More...
 
virtual void SetTopLayer (int aLayer, bool aEnabled=true)
 Function SetTopLayer() Sets given layer to be displayed on the top or sets back the default order of layers. More...
 
virtual void EnableTopLayer (bool aEnable)
 Function EnableTopLayer() Enables or disables display of the top layer. More...
 
virtual int GetTopLayer () const
 
void ClearTopLayers ()
 Function ClearTopLayers() Removes all layers from the on-the-top set (they are no longer displayed over the rest of layers). More...
 
void UpdateAllLayersOrder ()
 Function UpdateLayerOrder() Does everything that is needed to apply the rendering order of layers. More...
 
void ClearTargets ()
 Function ClearTargets() Clears targets that are marked as dirty. More...
 
virtual void Redraw ()
 Function Redraw() Immediately redraws the whole view. More...
 
void RecacheAllItems ()
 Function RecacheAllItems() Rebuilds GAL display lists. More...
 
bool IsDynamic () const
 Function IsDynamic() Tells if the VIEW is dynamic (ie. More...
 
bool IsDirty () const
 Function IsDirty() Returns true if any of the VIEW layers needs to be refreshened. More...
 
bool IsTargetDirty (int aTarget) const
 Function IsTargetDirty() Returns true if any of layers belonging to the target or the target itself should be redrawn. More...
 
void MarkTargetDirty (int aTarget)
 Function MarkTargetDirty() Sets or clears target 'dirty' flag. More...
 
bool IsCached (int aLayer) const
 Returns true if the layer is cached. More...
 
void MarkDirty ()
 Function MarkDirty() Forces redraw of view on the next rendering. More...
 
void MarkForUpdate (VIEW_ITEM *aItem)
 Function MarkForUpdate() Adds an item to a list of items that are going to be refreshed upon the next frame rendering. More...
 
void UpdateItems ()
 Function UpdateItems() Iterates through the list of items that asked for updating and updates them. More...
 
void UpdateAllItems (int aUpdateFlags)
 Updates all items in the view according to the given flags. More...
 
void UpdateAllItemsConditionally (int aUpdateFlags, std::function< bool(VIEW_ITEM *)> aCondition)
 Updates items in the view according to the given flags and condition. More...
 
bool IsUsingDrawPriority () const
 Function IsUsingDrawPriority() More...
 
void UseDrawPriority (bool aFlag)
 Function UseDrawPriority() More...
 
bool IsDrawOrderReversed () const
 Function IsDrawOrderReversed() More...
 
void ReverseDrawOrder (bool aFlag)
 Function ReverseDrawOrder() Only takes effect if UseDrawPriority is true. More...
 
std::shared_ptr< VIEW_OVERLAYMakeOverlay ()
 
std::unique_ptr< VIEWDataReference () const
 Returns a new VIEW object that shares the same set of VIEW_ITEMs and LAYERs. More...
 

Static Public Member Functions

static void OnDestroy (VIEW_ITEM *aItem)
 

Static Public Attributes

static constexpr int VIEW_MAX_LAYERS = 512
 maximum number of layers that may be shown More...
 

Protected Types

typedef std::unordered_map< int, VIEW_LAYERLAYER_MAP
 
typedef LAYER_MAP::iterator LAYER_MAP_ITER
 
typedef std::vector< VIEW_LAYER * > LAYER_ORDER
 
typedef std::vector< VIEW_LAYER * >::iterator LAYER_ORDER_ITER
 

Protected Member Functions

void redrawRect (const BOX2I &aRect)
 
void markTargetClean (int aTarget)
 
void draw (VIEW_ITEM *aItem, int aLayer, bool aImmediate=false)
 Function draw() Draws an item, but on a specified layers. More...
 
void draw (VIEW_ITEM *aItem, bool aImmediate=false)
 Function draw() Draws an item on all layers that the item uses. More...
 
void draw (VIEW_GROUP *aGroup, bool aImmediate=false)
 Function draw() Draws a group of items on all layers that those items use. More...
 
void sortLayers ()
 
void clearGroupCache ()
 
void invalidateItem (VIEW_ITEM *aItem, int aUpdateFlags)
 Function invalidateItem() Manages dirty flags & redraw queueing when updating an item. More...
 
void updateItemColor (VIEW_ITEM *aItem, int aLayer)
 Updates colors that are used for an item to be drawn. More...
 
void updateItemGeometry (VIEW_ITEM *aItem, int aLayer)
 Updates all informations needed to draw an item. More...
 
void updateBbox (VIEW_ITEM *aItem)
 Updates bounding box of an item. More...
 
void updateLayers (VIEW_ITEM *aItem)
 Updates set of layers that an item occupies. More...
 
bool areRequiredLayersEnabled (int aLayerId) const
 Checks if every layer required by the aLayerId layer is enabled. More...
 

Static Protected Member Functions

static bool compareRenderingOrder (VIEW_LAYER *aI, VIEW_LAYER *aJ)
 Determines rendering order of layers. Used in display order sorting function. More...
 

Protected Attributes

bool m_enableOrderModifier
 
LAYER_MAP m_layers
 Contains set of possible displayed layers and its properties. More...
 
std::shared_ptr< std::vector< VIEW_ITEM * > > m_allItems
 Flat list of all items. More...
 
LAYER_ORDER m_orderedLayers
 Sorted list of pointers to members of m_layers. More...
 
std::set< unsigned int > m_topLayers
 Stores set of layers that are displayed on the top. More...
 
VECTOR2D m_center
 Center point of the VIEW (the point at which we are looking at) More...
 
double m_scale
 Scale of displayed VIEW_ITEMs. More...
 
BOX2D m_boundary
 View boundaries. More...
 
double m_minScale
 Scale lower limit. More...
 
double m_maxScale
 Scale upper limit. More...
 
bool m_mirrorX
 

Horizontal flip flag

More...
 
bool m_mirrorY
 

Vertical flip flag

More...
 
PAINTERm_painter
 PAINTER contains information how do draw items. More...
 
GALm_gal
 Gives interface to PAINTER, that is used to draw items. More...
 
bool m_dynamic
 Dynamic VIEW (eg. More...
 
bool m_dirtyTargets [TARGETS_NUMBER]
 Flags to mark targets as dirty, so they have to be redrawn on the next refresh event. More...
 
bool m_useDrawPriority
 Flat list of all items Flag to respect draw priority when drawing items. More...
 
int m_nextDrawPriority
 The next sequential drawing priority. More...
 
bool m_reverseDrawOrder
 Flag to reverse the draw order when using draw priority. More...
 

Static Protected Attributes

static const int TOP_LAYER_MODIFIER = -VIEW_MAX_LAYERS
 Rendering order modifier for layers that are marked as top layers. More...
 

Private Attributes

std::unique_ptr< WORKSHEET_VIEWITEMm_worksheet
 
std::unique_ptr< KIGFX::PREVIEW::SELECTION_AREAm_selectionArea
 
std::unique_ptr< KIGFX::VIEW_GROUPm_preview
 
std::vector< EDA_ITEM * > m_ownedItems
 

Detailed Description

Definition at line 68 of file sch_view.h.

Member Typedef Documentation

typedef std::pair<VIEW_ITEM*, int> KIGFX::VIEW::LAYER_ITEM_PAIR
inherited

Definition at line 66 of file view.h.

typedef std::unordered_map<int, VIEW_LAYER> KIGFX::VIEW::LAYER_MAP
protectedinherited

Definition at line 714 of file view.h.

typedef LAYER_MAP::iterator KIGFX::VIEW::LAYER_MAP_ITER
protectedinherited

Definition at line 715 of file view.h.

typedef std::vector<VIEW_LAYER*> KIGFX::VIEW::LAYER_ORDER
protectedinherited

Definition at line 716 of file view.h.

typedef std::vector<VIEW_LAYER*>::iterator KIGFX::VIEW::LAYER_ORDER_ITER
protectedinherited

Definition at line 717 of file view.h.

Constructor & Destructor Documentation

KIGFX::SCH_VIEW::SCH_VIEW ( bool  aIsDynamic)

Definition at line 44 of file sch_view.cpp.

44  :
45  VIEW( aIsDynamic )
46 {
47 }
VIEW(bool aIsDynamic=true)
Constructor.
Definition: view.cpp:285
KIGFX::SCH_VIEW::~SCH_VIEW ( )

Definition at line 50 of file sch_view.cpp.

51 {
52 }

Member Function Documentation

void KIGFX::VIEW::Add ( VIEW_ITEM aItem,
int  aDrawPriority = -1 
)
virtualinherited

Function Add() Adds a VIEW_ITEM to the view.

Set aDrawPriority to -1 to assign sequential priorities.

Parameters
aItemitem to be added. No ownership is given
aDrawPrioritypriority to draw this item on its layer, lowest first.

Reimplemented in KIGFX::PCB_VIEW.

Definition at line 335 of file view.cpp.

References i, KIGFX::INITIAL_ADD, KIGFX::VIEW::VIEW_LAYER::items, KIGFX::VIEW::m_allItems, KIGFX::VIEW_ITEM_DATA::m_drawPriority, KIGFX::VIEW::m_layers, KIGFX::VIEW::m_nextDrawPriority, KIGFX::VIEW_ITEM_DATA::m_view, KIGFX::VIEW_ITEM::m_viewPrivData, KIGFX::VIEW::MarkTargetDirty(), KIGFX::VIEW_ITEM_DATA::saveLayers(), KIGFX::VIEW::SetVisible(), KIGFX::VIEW::VIEW_LAYER::target, KIGFX::VIEW::Update(), KIGFX::VIEW::VIEW_MAX_LAYERS, KIGFX::VIEW_ITEM::ViewGetLayers(), and KIGFX::VIEW_ITEM::viewPrivData().

Referenced by KIGFX::PCB_VIEW::Add(), SCH_BASE_FRAME::AddToScreen(), GERBVIEW_SELECTION_TOOL::disambiguationMenu(), PCB_DRAW_PANEL_GAL::DisplayBoard(), DisplayComponent(), SYMBOL_PREVIEW_WIDGET::DisplayPart(), DisplaySheet(), SYMBOL_PREVIEW_WIDGET::DisplaySymbol(), SELECTION_TOOL::doSelectionMenu(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::drawSegment(), GRID_HELPER::GRID_HELPER(), KIGFX::VIEW::MakeOverlay(), POINT_EDITOR::OnSelectionChange(), DRAWING_TOOL::PlaceDXF(), DIALOG_PAD_PROPERTIES::prepareCanvas(), BOARD_COMMIT::Push(), GERBVIEW_FRAME::Read_EXCELLON_File(), PCB_EDIT_FRAME::ReadPcbNetlist(), DIALOG_PAD_PROPERTIES::redraw(), FOOTPRINT_PREVIEW_PANEL::renderFootprint(), PCB_EDITOR_CONTROL::Reset(), PCBNEW_CONTROL::Reset(), GERBVIEW_SELECTION_TOOL::Reset(), BOARD_COMMIT::Revert(), SCH_EDIT_FRAME::SaveWireImage(), GERBVIEW_SELECTION_TOOL::select(), GERBVIEW_SELECTION_TOOL::selectMultiple(), SELECTION_TOOL::selectMultiple(), PCB_DRAW_PANEL_GAL::SetWorksheet(), GERBVIEW_DRAW_PANEL_GAL::SetWorksheet(), DIALOG_ERC::TestErc(), POINT_EDITOR::updatePoints(), LIB_VIEW_FRAME::updatePreviewSymbol(), and ZONE_CREATE_HELPER::ZONE_CREATE_HELPER().

336 {
337  int layers[VIEW_MAX_LAYERS], layers_count;
338 
339  if( aDrawPriority < 0 )
340  aDrawPriority = m_nextDrawPriority++;
341 
342  if( !aItem->m_viewPrivData )
343  aItem->m_viewPrivData = new VIEW_ITEM_DATA;
344 
345  aItem->m_viewPrivData->m_view = this;
346  aItem->m_viewPrivData->m_drawPriority = aDrawPriority;
347 
348  aItem->ViewGetLayers( layers, layers_count );
349  aItem->viewPrivData()->saveLayers( layers, layers_count );
350 
351  m_allItems->push_back( aItem );
352 
353  for( int i = 0; i < layers_count; ++i )
354  {
355  VIEW_LAYER& l = m_layers[layers[i]];
356  l.items->Insert( aItem );
357  MarkTargetDirty( l.target );
358  }
359 
360  SetVisible( aItem, true );
361  Update( aItem, KIGFX::INITIAL_ADD );
362 }
Layers have changed.
Definition: view_item.h:59
static constexpr int VIEW_MAX_LAYERS
maximum number of layers that may be shown
Definition: view.h:699
std::shared_ptr< std::vector< VIEW_ITEM * > > m_allItems
Flat list of all items.
Definition: view.h:813
void MarkTargetDirty(int aTarget)
Function MarkTargetDirty() Sets or clears target &#39;dirty&#39; flag.
Definition: view.h:596
virtual void Update(VIEW_ITEM *aItem, int aUpdateFlags)
For dynamic VIEWs, informs the associated VIEW that the graphical representation of this item has cha...
Definition: view.cpp:1521
int m_nextDrawPriority
The next sequential drawing priority.
Definition: view.h:863
size_t i
Definition: json11.cpp:597
void SetVisible(VIEW_ITEM *aItem, bool aIsVisible=true)
Sets the item visibility.
Definition: view.cpp:1467
LAYER_MAP m_layers
Contains set of possible displayed layers and its properties.
Definition: view.h:810
void KIGFX::VIEW::AddLayer ( int  aLayer,
bool  aDisplayOnly = false 
)
inherited

Function AddLayer() Adds a new layer to the view.

Parameters
aLayerunique ID of the layer to be added.
aDisplayOnlylayer is display-only (example: selection boxes, floating hints/menus). Objects belonging to this layer are not taken into account by Query() method.

Definition at line 320 of file view.cpp.

References KIGFX::VIEW::m_layers, and KIGFX::TARGET_CACHED.

Referenced by KIGFX::VIEW::GetCenter(), and KIGFX::VIEW::VIEW().

321 {
322  if( m_layers.find( aLayer ) == m_layers.end() )
323  {
324  m_layers[aLayer] = VIEW_LAYER();
325  m_layers[aLayer].items.reset( new VIEW_RTREE() );
326  m_layers[aLayer].id = aLayer;
327  m_layers[aLayer].renderingOrder = aLayer;
328  m_layers[aLayer].visible = true;
329  m_layers[aLayer].displayOnly = aDisplayOnly;
330  m_layers[aLayer].target = TARGET_CACHED;
331  }
332 }
Main rendering target (cached)
Definition: definitions.h:41
LAYER_MAP m_layers
Contains set of possible displayed layers and its properties.
Definition: view.h:810
void KIGFX::SCH_VIEW::AddToPreview ( EDA_ITEM aItem,
bool  takeOwnership = true 
)

Definition at line 107 of file sch_view.cpp.

References KIGFX::VIEW::Hide(), m_ownedItems, m_preview, KIGFX::VIEW::SetVisible(), and KIGFX::VIEW::Update().

108 {
109  Hide( aItem, false );
110  m_preview->Add( aItem );
111 
112  if( takeOwnership )
113  m_ownedItems.push_back( aItem );
114 
115  SetVisible( m_preview.get(), true );
116  Hide( m_preview.get(), false );
117  Update( m_preview.get() );
118 }
void Hide(VIEW_ITEM *aItem, bool aHide=true)
Temporarily hides the item in the view (e.g.
Definition: view.cpp:1488
std::vector< EDA_ITEM * > m_ownedItems
Definition: sch_view.h:95
virtual void Update(VIEW_ITEM *aItem, int aUpdateFlags)
For dynamic VIEWs, informs the associated VIEW that the graphical representation of this item has cha...
Definition: view.cpp:1521
void SetVisible(VIEW_ITEM *aItem, bool aIsVisible=true)
Sets the item visibility.
Definition: view.cpp:1467
std::unique_ptr< KIGFX::VIEW_GROUP > m_preview
Definition: sch_view.h:94
bool KIGFX::VIEW::areRequiredLayersEnabled ( int  aLayerId) const
protectedinherited

Checks if every layer required by the aLayerId layer is enabled.

Definition at line 1365 of file view.cpp.

References KIGFX::VIEW::m_layers.

Referenced by KIGFX::VIEW::compareRenderingOrder(), and KIGFX::VIEW::redrawRect().

1366 {
1367  wxCHECK( (unsigned) aLayerId < m_layers.size(), false );
1368 
1369  std::set<int>::const_iterator it, it_end;
1370 
1371  for( it = m_layers.at( aLayerId ).requiredLayers.begin(),
1372  it_end = m_layers.at( aLayerId ).requiredLayers.end(); it != it_end; ++it )
1373  {
1374  // That is enough if just one layer is not enabled
1375  if( !m_layers.at( *it ).visible || !areRequiredLayersEnabled( *it ) )
1376  return false;
1377  }
1378 
1379  return true;
1380 }
bool areRequiredLayersEnabled(int aLayerId) const
Checks if every layer required by the aLayerId layer is enabled.
Definition: view.cpp:1365
LAYER_MAP m_layers
Contains set of possible displayed layers and its properties.
Definition: view.h:810
void KIGFX::VIEW::Clear ( )
inherited

Function Clear() Removes all items from the view.

Definition at line 1099 of file view.cpp.

References KIGFX::GAL::ClearCache(), i, KIGFX::VIEW::m_allItems, KIGFX::VIEW::m_gal, KIGFX::VIEW::m_layers, KIGFX::VIEW::m_nextDrawPriority, and BOX2< Vec >::SetMaximum().

Referenced by PCB_DRAW_PANEL_GAL::DisplayBoard(), DisplayComponent(), KIGFX::VIEW::GetCenter(), GERBVIEW_FRAME::OnCloseWindow(), FOOTPRINT_PREVIEW_PANEL::renderFootprint(), PCB_BASE_EDIT_FRAME::SetBoard(), DISPLAY_FOOTPRINTS_FRAME::~DISPLAY_FOOTPRINTS_FRAME(), FOOTPRINT_VIEWER_FRAME::~FOOTPRINT_VIEWER_FRAME(), and GERBVIEW_FRAME::~GERBVIEW_FRAME().

1100 {
1101  BOX2I r;
1102  r.SetMaximum();
1103  m_allItems->clear();
1104 
1105  for( LAYER_MAP_ITER i = m_layers.begin(); i != m_layers.end(); ++i )
1106  i->second.items->RemoveAll();
1107 
1108  m_nextDrawPriority = 0;
1109 
1110  m_gal->ClearCache();
1111 }
GAL * m_gal
Gives interface to PAINTER, that is used to draw items.
Definition: view.h:846
std::shared_ptr< std::vector< VIEW_ITEM * > > m_allItems
Flat list of all items.
Definition: view.h:813
void SetMaximum()
Definition: box2.h:71
int m_nextDrawPriority
The next sequential drawing priority.
Definition: view.h:863
LAYER_MAP::iterator LAYER_MAP_ITER
Definition: view.h:715
size_t i
Definition: json11.cpp:597
LAYER_MAP m_layers
Contains set of possible displayed layers and its properties.
Definition: view.h:810
virtual void ClearCache()
Delete all data created during caching of graphic items.
void KIGFX::VIEW::clearGroupCache ( )
protectedinherited

Definition at line 1182 of file view.cpp.

References i, KIGFX::VIEW::VIEW_LAYER::items, KIGFX::VIEW::m_layers, and BOX2< Vec >::SetMaximum().

Referenced by KIGFX::VIEW::markTargetClean(), and KIGFX::VIEW::SetGAL().

1183 {
1184  BOX2I r;
1185 
1186  r.SetMaximum();
1187  clearLayerCache visitor( this );
1188 
1189  for( LAYER_MAP_ITER i = m_layers.begin(); i != m_layers.end(); ++i )
1190  {
1191  VIEW_LAYER* l = &( ( *i ).second );
1192  l->items->Query( r, visitor );
1193  }
1194 }
void SetMaximum()
Definition: box2.h:71
LAYER_MAP::iterator LAYER_MAP_ITER
Definition: view.h:715
size_t i
Definition: json11.cpp:597
LAYER_MAP m_layers
Contains set of possible displayed layers and its properties.
Definition: view.h:810
void KIGFX::SCH_VIEW::ClearHiddenFlags ( )

Definition at line 141 of file sch_view.cpp.

References KIGFX::VIEW::Hide(), and KIGFX::VIEW::m_allItems.

Referenced by LIB_EDIT_FRAME::HandleBlockPlace(), SCH_EDIT_FRAME::HandleBlockPlace(), SCH_EDIT_FRAME::OnCancelCurrentCommand(), SCH_EDIT_FRAME::OnLeftClick(), and LIB_EDIT_FRAME::RebuildView().

142 {
143  for( auto item : *m_allItems )
144  Hide ( item, false );
145 }
void Hide(VIEW_ITEM *aItem, bool aHide=true)
Temporarily hides the item in the view (e.g.
Definition: view.cpp:1488
std::shared_ptr< std::vector< VIEW_ITEM * > > m_allItems
Flat list of all items.
Definition: view.h:813
void KIGFX::VIEW::ClearLayer ( int  aLayer)
inherited

Function ClearLayer() Removes all items from a given layer.

Parameters
aLayerID of the layer to be cleared

Referenced by KIGFX::VIEW::GetCenter().

void KIGFX::SCH_VIEW::ClearPreview ( )

Definition at line 95 of file sch_view.cpp.

References m_ownedItems, m_preview, and KIGFX::VIEW::Update().

Referenced by SCH_EDIT_FRAME::AddJunction(), SCH_EDIT_FRAME::AddNoConnect(), SCH_EDIT_FRAME::EndSegment(), ExitSheet(), LIB_EDIT_FRAME::HandleBlockPlace(), SCH_EDIT_FRAME::HandleBlockPlace(), SCH_EDIT_FRAME::OnCancelCurrentCommand(), and SCH_EDIT_FRAME::OnLeftClick().

96 {
97  m_preview->Clear();
98 
99  for( auto item : m_ownedItems )
100  delete item;
101 
102  m_ownedItems.clear();
103  Update( m_preview.get() );
104 }
std::vector< EDA_ITEM * > m_ownedItems
Definition: sch_view.h:95
virtual void Update(VIEW_ITEM *aItem, int aUpdateFlags)
For dynamic VIEWs, informs the associated VIEW that the graphical representation of this item has cha...
Definition: view.cpp:1521
std::unique_ptr< KIGFX::VIEW_GROUP > m_preview
Definition: sch_view.h:94
void KIGFX::VIEW::ClearTargets ( )
inherited

Function ClearTargets() Clears targets that are marked as dirty.

Definition at line 1114 of file view.cpp.

References KIGFX::GAL::ClearTarget(), KIGFX::VIEW::IsTargetDirty(), KIGFX::VIEW::m_gal, KIGFX::VIEW::MarkDirty(), KIGFX::TARGET_CACHED, KIGFX::TARGET_NONCACHED, and KIGFX::TARGET_OVERLAY.

Referenced by EDA_DRAW_PANEL_GAL::onPaint(), and KIGFX::VIEW::SetLayerTarget().

1115 {
1117  {
1118  // TARGET_CACHED and TARGET_NONCACHED have to be redrawn together, as they contain
1119  // layers that rely on each other (eg. netnames are noncached, but tracks - are cached)
1122 
1123  MarkDirty();
1124  }
1125 
1126  if( IsTargetDirty( TARGET_OVERLAY ) )
1127  {
1129  }
1130 }
GAL * m_gal
Gives interface to PAINTER, that is used to draw items.
Definition: view.h:846
Auxiliary rendering target (noncached)
Definition: definitions.h:42
virtual void ClearTarget(RENDER_TARGET aTarget)
Clears the target for rendering.
bool IsTargetDirty(int aTarget) const
Function IsTargetDirty() Returns true if any of layers belonging to the target or the target itself s...
Definition: view.h:585
Items that may change while the view stays the same (noncached)
Definition: definitions.h:43
Main rendering target (cached)
Definition: definitions.h:41
void MarkDirty()
Function MarkDirty() Forces redraw of view on the next rendering.
Definition: view.h:621
void KIGFX::VIEW::ClearTopLayers ( )
inherited

Function ClearTopLayers() Removes all layers from the on-the-top set (they are no longer displayed over the rest of layers).

Definition at line 900 of file view.cpp.

References KIGFX::VIEW::m_enableOrderModifier, KIGFX::VIEW::m_layers, KIGFX::VIEW::m_topLayers, and KIGFX::VIEW::TOP_LAYER_MODIFIER.

Referenced by KIGFX::VIEW::SetLayerTarget(), GERBVIEW_DRAW_PANEL_GAL::SetTopLayer(), PCB_DRAW_PANEL_GAL::SetTopLayer(), and EDA_DRAW_PANEL_GAL::SetTopLayer().

901 {
902  std::set<unsigned int>::iterator it;
903 
905  {
906  // Restore the previous rendering order for layers that were marked as top
907  for( it = m_topLayers.begin(); it != m_topLayers.end(); ++it )
908  m_layers[*it].renderingOrder -= TOP_LAYER_MODIFIER;
909  }
910 
911  m_topLayers.clear();
912 }
static const int TOP_LAYER_MODIFIER
Rendering order modifier for layers that are marked as top layers.
Definition: view.h:856
std::set< unsigned int > m_topLayers
Stores set of layers that are displayed on the top.
Definition: view.h:819
bool m_enableOrderModifier
Definition: view.h:807
LAYER_MAP m_layers
Contains set of possible displayed layers and its properties.
Definition: view.h:810
static bool KIGFX::VIEW::compareRenderingOrder ( VIEW_LAYER aI,
VIEW_LAYER aJ 
)
inlinestaticprotectedinherited

Determines rendering order of layers. Used in display order sorting function.

Definition at line 798 of file view.h.

References KIGFX::VIEW::areRequiredLayersEnabled(), and KIGFX::VIEW::VIEW_LAYER::renderingOrder.

Referenced by KIGFX::VIEW::sortLayers().

799  {
800  return aI->renderingOrder > aJ->renderingOrder;
801  }
void KIGFX::VIEW::CopySettings ( const VIEW aOtherView)
inherited

Function CopySettings() Copies layers and visibility settings from another view.

Parameters
aOtherViewview from which settings will be copied.

Definition at line 502 of file view.cpp.

503 {
504  wxASSERT_MSG( false, wxT( "This is not implemented" ) );
505 }
std::unique_ptr< VIEW > KIGFX::VIEW::DataReference ( ) const
inherited

Returns a new VIEW object that shares the same set of VIEW_ITEMs and LAYERs.

GAL, PAINTER and other properties are left uninitialized.

Definition at line 1457 of file view.cpp.

References KIGFX::VIEW::m_allItems, and KIGFX::VIEW::m_layers.

Referenced by BOARD_PRINTOUT::DrawPage(), and KIGFX::VIEW::ReverseDrawOrder().

1458 {
1459  auto ret = std::make_unique<VIEW>();
1460  ret->m_allItems = m_allItems;
1461  ret->m_layers = m_layers;
1462  ret->sortLayers();
1463  return ret;
1464 }
std::shared_ptr< std::vector< VIEW_ITEM * > > m_allItems
Flat list of all items.
Definition: view.h:813
LAYER_MAP m_layers
Contains set of possible displayed layers and its properties.
Definition: view.h:810
void KIGFX::SCH_VIEW::DisplayComponent ( LIB_PART aPart)

Definition at line 78 of file sch_view.cpp.

References KIGFX::VIEW::Add(), KIGFX::VIEW::Clear(), LIB_PART::GetDrawItems(), m_preview, and m_selectionArea.

79 {
80  Clear();
81 
82  if( !aPart )
83  return;
84 
85  for ( auto &item : aPart->GetDrawItems() )
86  Add( &item );
87 
89  m_preview.reset( new KIGFX::VIEW_GROUP () );
90  Add( m_selectionArea.get() );
91  Add( m_preview.get() );
92 }
std::unique_ptr< KIGFX::PREVIEW::SELECTION_AREA > m_selectionArea
Definition: sch_view.h:93
void Clear()
Function Clear() Removes all items from the view.
Definition: view.cpp:1099
LIB_ITEMS_CONTAINER & GetDrawItems()
Return a reference to the draw item list.
Class SELECTION_AREA.
virtual void Add(VIEW_ITEM *aItem, int aDrawPriority=-1)
Function Add() Adds a VIEW_ITEM to the view.
Definition: view.cpp:335
std::unique_ptr< KIGFX::VIEW_GROUP > m_preview
Definition: sch_view.h:94
void KIGFX::SCH_VIEW::DisplaySheet ( SCH_SHEET aSheet)

Definition at line 72 of file sch_view.cpp.

References DisplaySheet(), and SCH_SHEET::GetScreen().

Referenced by DisplaySheet().

73 {
74  DisplaySheet( aSheet->GetScreen() );
75 }
void DisplaySheet(SCH_SHEET *aSheet)
Definition: sch_view.cpp:72
SCH_SCREEN * GetScreen()
Definition: sch_sheet.h:279
void KIGFX::SCH_VIEW::DisplaySheet ( SCH_SCREEN aSheet)

Definition at line 55 of file sch_view.cpp.

References KIGFX::VIEW::Add(), SCH_SCREEN::GetDrawItems(), SCH_SCREEN::GetPageSettings(), SCH_SCREEN::GetTitleBlock(), m_preview, m_selectionArea, m_worksheet, and SCH_ITEM::Next().

56 {
57 
58  for( auto item = aSheet->GetDrawItems(); item; item = item->Next() )
59  Add( item );
60 
61  m_worksheet.reset( new KIGFX::WORKSHEET_VIEWITEM( 1, &aSheet->GetPageSettings(),
62  &aSheet->GetTitleBlock() ) );
64  m_preview.reset( new KIGFX::VIEW_GROUP () );
65 
66  Add( m_worksheet.get() );
67  Add( m_selectionArea.get() );
68  Add( m_preview.get() );
69 }
std::unique_ptr< KIGFX::PREVIEW::SELECTION_AREA > m_selectionArea
Definition: sch_view.h:93
SCH_ITEM * Next() const
const TITLE_BLOCK & GetTitleBlock() const
Definition: sch_screen.h:136
SCH_ITEM * GetDrawItems() const
Definition: sch_screen.h:160
std::unique_ptr< WORKSHEET_VIEWITEM > m_worksheet
Definition: sch_view.h:92
const PAGE_INFO & GetPageSettings() const
Definition: sch_screen.h:126
Class SELECTION_AREA.
virtual void Add(VIEW_ITEM *aItem, int aDrawPriority=-1)
Function Add() Adds a VIEW_ITEM to the view.
Definition: view.cpp:335
std::unique_ptr< KIGFX::VIEW_GROUP > m_preview
Definition: sch_view.h:94
void KIGFX::VIEW::draw ( VIEW_ITEM aItem,
int  aLayer,
bool  aImmediate = false 
)
protectedinherited

Function draw() Draws an item, but on a specified layers.

It has to be marked that some of drawing settings are based on the layer on which an item is drawn.

Parameters
aItemis the item to be drawn.
aLayeris the layer which should be drawn.
aImmediatedictates the way of drawing - it allows one to force immediate drawing mode for cached items.

Definition at line 1017 of file view.cpp.

References KIGFX::PAINTER::Draw(), KIGFX::GAL::DrawGroup(), KIGFX::VIEW_ITEM_DATA::getGroup(), KIGFX::VIEW::IsCached(), KIGFX::VIEW::m_gal, KIGFX::VIEW::m_painter, KIGFX::VIEW::Update(), KIGFX::VIEW_ITEM::ViewDraw(), and KIGFX::VIEW_ITEM::viewPrivData().

Referenced by KIGFX::VIEW::draw(), and KIGFX::VIEW::markTargetClean().

1018 {
1019  auto viewData = aItem->viewPrivData();
1020 
1021  if( !viewData )
1022  return;
1023 
1024  if( IsCached( aLayer ) && !aImmediate )
1025  {
1026  // Draw using cached information or create one
1027  int group = viewData->getGroup( aLayer );
1028 
1029  if( group >= 0 )
1030  m_gal->DrawGroup( group );
1031  else
1032  Update( aItem );
1033  }
1034  else
1035  {
1036  // Immediate mode
1037  if( !m_painter->Draw( aItem, aLayer ) )
1038  aItem->ViewDraw( aLayer, this ); // Alternative drawing method
1039  }
1040 }
virtual void DrawGroup(int aGroupNumber)
Draw the stored group.
GAL * m_gal
Gives interface to PAINTER, that is used to draw items.
Definition: view.h:846
PAINTER * m_painter
PAINTER contains information how do draw items.
Definition: view.h:843
virtual void Update(VIEW_ITEM *aItem, int aUpdateFlags)
For dynamic VIEWs, informs the associated VIEW that the graphical representation of this item has cha...
Definition: view.cpp:1521
virtual bool Draw(const VIEW_ITEM *aItem, int aLayer)=0
Function Draw Takes an instance of VIEW_ITEM and passes it to a function that know how to draw the it...
bool IsCached(int aLayer) const
Returns true if the layer is cached.
Definition: view.h:603
void KIGFX::VIEW::draw ( VIEW_ITEM aItem,
bool  aImmediate = false 
)
protectedinherited

Function draw() Draws an item on all layers that the item uses.

Parameters
aItemis the item to be drawn.
aImmediatedictates the way of drawing - it allows one to force immediate drawing mode for cached items.

Definition at line 1043 of file view.cpp.

References KIGFX::VIEW::draw(), i, KIGFX::VIEW::m_gal, KIGFX::VIEW::m_layers, KIGFX::GAL::SetLayerDepth(), KIGFX::VIEW::SortLayers(), KIGFX::VIEW::VIEW_MAX_LAYERS, and KIGFX::VIEW_ITEM::ViewGetLayers().

1044 {
1045  int layers[VIEW_MAX_LAYERS], layers_count;
1046 
1047  aItem->ViewGetLayers( layers, layers_count );
1048 
1049  // Sorting is needed for drawing order dependent GALs (like Cairo)
1050  SortLayers( layers, layers_count );
1051 
1052  for( int i = 0; i < layers_count; ++i )
1053  {
1054  m_gal->SetLayerDepth( m_layers.at( layers[i] ).renderingOrder );
1055  draw( aItem, layers[i], aImmediate );
1056  }
1057 }
GAL * m_gal
Gives interface to PAINTER, that is used to draw items.
Definition: view.h:846
virtual void SetLayerDepth(double aLayerDepth)
Set the depth of the layer (position on the z-axis)
static constexpr int VIEW_MAX_LAYERS
maximum number of layers that may be shown
Definition: view.h:699
void SortLayers(int aLayers[], int &aCount) const
Function SortLayers() Changes the order of given layer ids, so after sorting the order corresponds to...
Definition: view.cpp:666
size_t i
Definition: json11.cpp:597
void draw(VIEW_ITEM *aItem, int aLayer, bool aImmediate=false)
Function draw() Draws an item, but on a specified layers.
Definition: view.cpp:1017
LAYER_MAP m_layers
Contains set of possible displayed layers and its properties.
Definition: view.h:810
void KIGFX::VIEW::draw ( VIEW_GROUP aGroup,
bool  aImmediate = false 
)
protectedinherited

Function draw() Draws a group of items on all layers that those items use.

Parameters
aGroupis the group to be drawn.
aImmediatedictates the way of drawing - it allows one to force immediate drawing mode for cached items.

Definition at line 1060 of file view.cpp.

References KIGFX::VIEW::draw(), KIGFX::VIEW_GROUP::GetItem(), KIGFX::VIEW_GROUP::GetSize(), and i.

1061 {
1062  for( unsigned int i = 0; i < aGroup->GetSize(); i++)
1063  draw( aGroup->GetItem(i), aImmediate );
1064 }
size_t i
Definition: json11.cpp:597
void draw(VIEW_ITEM *aItem, int aLayer, bool aImmediate=false)
Function draw() Draws an item, but on a specified layers.
Definition: view.cpp:1017
void KIGFX::VIEW::EnableTopLayer ( bool  aEnable)
virtualinherited

Function EnableTopLayer() Enables or disables display of the top layer.

When disabled - layers are rendered as usual with no influence from SetTopLayer function. Otherwise on the top there is displayed the layer set previously with SetTopLayer function.

Parameters
aEnablewhether to enable or disable display of the top layer.

Definition at line 875 of file view.cpp.

References KIGFX::VIEW::m_enableOrderModifier, KIGFX::VIEW::m_layers, KIGFX::VIEW::m_topLayers, KIGFX::VIEW::TOP_LAYER_MODIFIER, KIGFX::VIEW::UpdateAllLayersColor(), and KIGFX::VIEW::UpdateAllLayersOrder().

Referenced by KIGFX::VIEW::SetLayerTarget().

876 {
877  if( aEnable == m_enableOrderModifier )
878  return;
879 
880  m_enableOrderModifier = aEnable;
881 
882  std::set<unsigned int>::iterator it;
883 
884  if( aEnable )
885  {
886  for( it = m_topLayers.begin(); it != m_topLayers.end(); ++it )
887  m_layers[*it].renderingOrder += TOP_LAYER_MODIFIER;
888  }
889  else
890  {
891  for( it = m_topLayers.begin(); it != m_topLayers.end(); ++it )
892  m_layers[*it].renderingOrder -= TOP_LAYER_MODIFIER;
893  }
894 
897 }
static const int TOP_LAYER_MODIFIER
Rendering order modifier for layers that are marked as top layers.
Definition: view.h:856
std::set< unsigned int > m_topLayers
Stores set of layers that are displayed on the top.
Definition: view.h:819
void UpdateAllLayersOrder()
Function UpdateLayerOrder() Does everything that is needed to apply the rendering order of layers...
Definition: view.cpp:915
bool m_enableOrderModifier
Definition: view.h:807
LAYER_MAP m_layers
Contains set of possible displayed layers and its properties.
Definition: view.h:810
void UpdateAllLayersColor()
Function UpdateAllLayersColor() Applies the new coloring scheme to all layers.
Definition: view.cpp:786
const BOX2D& KIGFX::VIEW::GetBoundary ( ) const
inlineinherited

Function GetBoundary()

Returns
Current view area boundary.

Definition at line 298 of file view.h.

References KIGFX::VIEW::m_boundary.

Referenced by KIGFX::WX_VIEW_CONTROLS::onScroll(), and KIGFX::WX_VIEW_CONTROLS::UpdateScrollbars().

299  {
300  return m_boundary;
301  }
BOX2D m_boundary
View boundaries.
Definition: view.h:828
const VECTOR2D& KIGFX::VIEW::GetCenter ( ) const
inlineinherited

Function GetCenter() Returns the center point of this VIEW (in world space coordinates)

Returns
center point of the view

Definition at line 339 of file view.h.

References KIGFX::VIEW::AddLayer(), KIGFX::VIEW::Clear(), KIGFX::VIEW::ClearLayer(), KIGFX::VIEW::GetScreenPixelSize(), KIGFX::VIEW::m_center, KIGFX::VIEW::ToScreen(), and KIGFX::VIEW::ToWorld().

Referenced by KIGFX::WX_VIEW_CONTROLS::onButton(), EDA_DRAW_PANEL_GAL::onPaint(), KIGFX::WX_VIEW_CONTROLS::onScroll(), KIGFX::WX_VIEW_CONTROLS::onTimer(), KIGFX::WX_VIEW_CONTROLS::onWheel(), SCH_BASE_FRAME::Zoom_Automatique(), and COMMON_TOOLS::ZoomFitScreen().

340  {
341  return m_center;
342  }
VECTOR2D m_center
Center point of the VIEW (the point at which we are looking at)
Definition: view.h:822
GAL* KIGFX::VIEW::GetGAL ( ) const
inlineinherited

Function GetGAL() Returns the GAL this view is using to draw graphical primitives.

Returns
Pointer to the currently used GAL instance.

Definition at line 180 of file view.h.

References KIGFX::VIEW::m_gal.

Referenced by KIGFX::WX_VIEW_CONTROLS::CenterOnCursor(), DIALOG_SET_GRID::DIALOG_SET_GRID(), PCBNEW_CONTROL::DoSetGridOrigin(), drawArcWithHilight(), drawLineWithHilight(), KIGFX::PREVIEW::CENTRELINE_RECT_ITEM::drawPreviewShape(), KIGFX::PREVIEW::POLYGON_ITEM::drawPreviewShape(), KIGFX::PREVIEW::DrawTextNextToCursor(), drawTicksAlongLine(), KIGFX::VIEW_OVERLAY::COMMAND_LINE::Execute(), KIGFX::VIEW_OVERLAY::COMMAND_CIRCLE::Execute(), KIGFX::VIEW_OVERLAY::COMMAND_ARC::Execute(), KIGFX::VIEW_OVERLAY::COMMAND_SET_STROKE::Execute(), KIGFX::VIEW_OVERLAY::COMMAND_SET_FILL::Execute(), KIGFX::VIEW_OVERLAY::COMMAND_SET_COLOR::Execute(), KIGFX::VIEW_OVERLAY::COMMAND_SET_WIDTH::Execute(), KIGFX::WX_VIEW_CONTROLS::GetRawCursorPosition(), DIALOG_PAD_PROPERTIES::prepareCanvas(), KIGFX::WX_VIEW_CONTROLS::SetCrossHairCursorPosition(), EDA_DRAW_FRAME::SetPresetGrid(), KIGFX::VIEW_CONTROLS::ShowCursor(), COMMON_TOOLS::updateGrid(), PCBNEW_CONTROL::updateGrid(), PCB_BRIGHT_BOX::ViewDraw(), KIGFX::PREVIEW::ARC_ASSISTANT::ViewDraw(), KIGFX::RATSNEST_VIEWITEM::ViewDraw(), KIGFX::PREVIEW::RULER_ITEM::ViewDraw(), KIGFX::ORIGIN_VIEWITEM::ViewDraw(), BRIGHT_BOX::ViewDraw(), KIGFX::PREVIEW::SIMPLE_OVERLAY_ITEM::ViewDraw(), KIGFX::PREVIEW::SELECTION_AREA::ViewDraw(), KIGFX::VIEW_GROUP::ViewDraw(), ROUTER_PREVIEW_ITEM::ViewDraw(), KIGFX::WORKSHEET_VIEWITEM::ViewDraw(), EDIT_POINTS::ViewDraw(), and KIGFX::WX_VIEW_CONTROLS::WarpCursor().

181  {
182  return m_gal;
183  }
GAL * m_gal
Gives interface to PAINTER, that is used to draw items.
Definition: view.h:846
int KIGFX::VIEW::GetLayerOrder ( int  aLayer) const
inherited

Function GetLayerOrder() Returns rendering order of a particular layer.

Lower values are rendered first.

Parameters
aLayerthe layer
Returns
Rendering order of a particular layer.

Definition at line 660 of file view.cpp.

References KIGFX::VIEW::m_layers.

Referenced by KIGFX::VIEW::SetLayerTarget(), PCB_DRAW_PANEL_GAL::SetTopLayer(), and KIGFX::VIEW::SortLayers().

661 {
662  return m_layers.at( aLayer ).renderingOrder;
663 }
LAYER_MAP m_layers
Contains set of possible displayed layers and its properties.
Definition: view.h:810
PAINTER* KIGFX::VIEW::GetPainter ( ) const
inlineinherited

Function GetPainter() Returns the painter object used by the view for drawing VIEW_ITEMS.

Returns
Pointer to the currently used Painter instance.

Definition at line 199 of file view.h.

References KIGFX::VIEW::GetViewport(), KIGFX::VIEW::m_painter, KIGFX::VIEW::SetMirror(), and KIGFX::VIEW::SetViewport().

Referenced by FOOTPRINT_VIEWER_FRAME::ApplyDisplaySettingsToGAL(), DISPLAY_FOOTPRINTS_FRAME::ApplyDisplaySettingsToGAL(), PCB_EDITOR_CONTROL::ClearHighlight(), SYMBOL_PREVIEW_WIDGET::DisplayPart(), SYMBOL_PREVIEW_WIDGET::DisplaySymbol(), drawArcWithHilight(), drawLineWithHilight(), BOARD_PRINTOUT::DrawPage(), KIGFX::PREVIEW::POLYGON_ITEM::drawPreviewShape(), KIGFX::PREVIEW::DrawTextNextToCursor(), drawTicksAlongLine(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), GERBVIEW_DRAW_PANEL_GAL::GERBVIEW_DRAW_PANEL_GAL(), ROUTER_PREVIEW_ITEM::getLayerColor(), SCH_BASE_FRAME::GetRenderSettings(), GERBVIEW_CONTROL::HighlightControl(), PNS::TOOL_BASE::highlightNet(), PCB_EDITOR_CONTROL::HighlightNet(), highlightNet(), PCBNEW_CONTROL::LayerAlphaDec(), PCBNEW_CONTROL::LayerAlphaInc(), SCH_EDIT_FRAME::LoadSettings(), LIB_EDIT_FRAME::LoadSettings(), FOOTPRINT_PREVIEW_PANEL::New(), DIALOG_PAD_PROPERTIES::onChangePadMode(), ZONE_CREATE_HELPER::OnFirstPoint(), PCB_LAYER_WIDGET::OnLayerColorChange(), GERBER_LAYER_WIDGET::OnLayerColorChange(), PCB_LAYER_WIDGET::OnRenderColorChange(), GERBER_LAYER_WIDGET::OnRenderColorChange(), GERBVIEW_FRAME::OnSelectHighlightChoice(), SCH_EDIT_FRAME::OnSelectOptionToolbar(), GERBVIEW_DRAW_PANEL_GAL::OnShow(), PCB_DRAW_PANEL_GAL::OnShow(), DIALOG_PAD_PROPERTIES::prepareCanvas(), GRID_HELPER::queryVisible(), DIALOG_PAD_PROPERTIES::redraw(), GERBVIEW_SELECTION_TOOL::Reset(), SELECTION_TOOL::Reset(), GERBVIEW_SELECTION_TOOL::selectable(), SELECTION_TOOL::selectable(), GERBVIEW_DRAW_PANEL_GAL::SetHighContrastLayer(), PCB_DRAW_PANEL_GAL::SetHighContrastLayer(), EDA_DRAW_PANEL_GAL::SetHighContrastLayer(), PCB_LAYER_WIDGET::SyncLayerAlphaIndicators(), PANEL_PCBNEW_DISPLAY_OPTIONS::TransferDataFromWindow(), PANEL_PCBNEW_SETTINGS::TransferDataFromWindow(), KIGFX::PCB_VIEW::UpdateDisplayOptions(), GERBVIEW_DRAW_PANEL_GAL::UseColorScheme(), PCB_DRAW_PANEL_GAL::UseColorScheme(), PCB_BASE_FRAME::UseGalCanvas(), KIGFX::PREVIEW::ARC_ASSISTANT::ViewDraw(), KIGFX::RATSNEST_VIEWITEM::ViewDraw(), KIGFX::PREVIEW::RULER_ITEM::ViewDraw(), KIGFX::PREVIEW::SELECTION_AREA::ViewDraw(), KIGFX::VIEW_GROUP::ViewDraw(), and KIGFX::WORKSHEET_VIEWITEM::ViewDraw().

200  {
201  return m_painter;
202  }
PAINTER * m_painter
PAINTER contains information how do draw items.
Definition: view.h:843
KIGFX::VIEW_GROUP* KIGFX::SCH_VIEW::GetPreview ( ) const
inline

Definition at line 80 of file sch_view.h.

Referenced by DrawMovingBlockOutlines().

80 { return m_preview.get(); }
std::unique_ptr< KIGFX::VIEW_GROUP > m_preview
Definition: sch_view.h:94
double KIGFX::VIEW::GetScale ( ) const
inlineinherited

Function GetScale()

Returns
Current scale factor of this VIEW.

Definition at line 268 of file view.h.

References KIGFX::VIEW::m_scale.

Referenced by KIGFX::WX_VIEW_CONTROLS::onWheel(), DIALOG_PAD_PROPERTIES::redraw(), KIGFX::VIEW::SetViewport(), SCH_BASE_FRAME::Window_Zoom(), SCH_BASE_FRAME::Zoom_Automatique(), COMMON_TOOLS::ZoomFitScreen(), and SELECTION_TOOL::zoomFitSelection().

269  {
270  return m_scale;
271  }
double m_scale
Scale of displayed VIEW_ITEMs.
Definition: view.h:825
const VECTOR2I & KIGFX::VIEW::GetScreenPixelSize ( ) const
inherited

Function GetScreenPixelSize() Returns the size of the our rendering area, in pixels.

Returns
viewport screen size

Definition at line 1158 of file view.cpp.

References KIGFX::GAL::GetScreenPixelSize(), and KIGFX::VIEW::m_gal.

Referenced by KIGFX::VIEW::GetCenter(), KIGFX::WX_VIEW_CONTROLS::handleAutoPanning(), KIGFX::WX_VIEW_CONTROLS::onScroll(), KIGFX::WX_VIEW_CONTROLS::onTimer(), and KIGFX::WX_VIEW_CONTROLS::onWheel().

1159 {
1160  return m_gal->GetScreenPixelSize();
1161 }
GAL * m_gal
Gives interface to PAINTER, that is used to draw items.
Definition: view.h:846
const VECTOR2I & GetScreenPixelSize() const
Returns GAL canvas size in pixels.
KIGFX::PREVIEW::SELECTION_AREA* KIGFX::SCH_VIEW::GetSelectionArea ( ) const
inline

Definition at line 78 of file sch_view.h.

Referenced by DrawAndSizingBlockOutlines(), and LIB_EDIT_FRAME::HandleBlockEnd().

78 { return m_selectionArea.get(); }
std::unique_ptr< KIGFX::PREVIEW::SELECTION_AREA > m_selectionArea
Definition: sch_view.h:93
int KIGFX::VIEW::GetTopLayer ( ) const
virtualinherited

Definition at line 839 of file view.cpp.

References KIGFX::VIEW::m_topLayers.

Referenced by ROUTER_TOOL::getStartLayer(), SELECTION_TOOL::guessSelectionCandidates(), PNS::TOOL_BASE::pickSingleItem(), KIGFX::VIEW::SetLayerTarget(), and PNS::TOOL_BASE::updateStartItem().

840 {
841  if( m_topLayers.size() == 0 )
842  return 0;
843 
844  return *m_topLayers.begin();
845 }
std::set< unsigned int > m_topLayers
Stores set of layers that are displayed on the top.
Definition: view.h:819
BOX2D KIGFX::VIEW::GetViewport ( ) const
inherited

Function GetViewport() Returns the current viewport visible area rectangle.

Returns
Current viewport rectangle

Definition at line 527 of file view.cpp.

References KIGFX::GAL::GetScreenPixelSize(), KIGFX::VIEW::m_gal, BOX2< Vec >::Normalize(), BOX2< Vec >::SetEnd(), BOX2< Vec >::SetOrigin(), and KIGFX::VIEW::ToWorld().

Referenced by KIGFX::VIEW::GetPainter(), SELECTION_TOOL::guessSelectionCandidates(), and KIGFX::WX_VIEW_CONTROLS::UpdateScrollbars().

528 {
529  BOX2D rect;
530  VECTOR2D screenSize = m_gal->GetScreenPixelSize();
531 
532  rect.SetOrigin( ToWorld( VECTOR2D( 0, 0 ) ) );
533  rect.SetEnd( ToWorld( screenSize ) );
534 
535  return rect.Normalize();
536 }
VECTOR2D ToWorld(const VECTOR2D &aCoord, bool aAbsolute=true) const
Function ToWorld() Converts a screen space point/vector to a point/vector in world space coordinates...
Definition: view.cpp:464
GAL * m_gal
Gives interface to PAINTER, that is used to draw items.
Definition: view.h:846
VECTOR2< double > VECTOR2D
Definition: vector2d.h:586
BOX2< Vec > & Normalize()
Function Normalize ensures that the height ant width are positive.
Definition: box2.h:127
void SetEnd(coord_type x, coord_type y)
Definition: box2.h:223
const VECTOR2I & GetScreenPixelSize() const
Returns GAL canvas size in pixels.
void SetOrigin(const Vec &pos)
Definition: box2.h:208
void KIGFX::VIEW::Hide ( VIEW_ITEM aItem,
bool  aHide = true 
)
inherited

Temporarily hides the item in the view (e.g.

for overlaying)

Parameters
aItemthe item to modify.
aHidewhether the item is hidden (on all layers), or not.

Definition at line 1488 of file view.cpp.

References KIGFX::APPEARANCE, KIGFX::HIDDEN, KIGFX::VIEW_ITEM_DATA::m_flags, KIGFX::VIEW::Update(), KIGFX::VIEW_ITEM::viewPrivData(), and KIGFX::VISIBLE.

Referenced by AddToPreview(), ClearHiddenFlags(), GERBVIEW_SELECTION_TOOL::disambiguationMenu(), DrawMovePin(), DrawMovingBlockOutlines(), SELECTION_TOOL::highlight(), resizeSheetWithMouseCursor(), GERBVIEW_SELECTION_TOOL::selectVisually(), LIB_EDIT_FRAME::StartMoveDrawSymbol(), SELECTION_TOOL::unhighlight(), and GERBVIEW_SELECTION_TOOL::unselectVisually().

1489 {
1490  auto viewData = aItem->viewPrivData();
1491 
1492  if( !viewData )
1493  return;
1494 
1495  if( !( viewData->m_flags & VISIBLE ) )
1496  return;
1497 
1498  if( aHide )
1499  viewData->m_flags |= HIDDEN;
1500  else
1501  viewData->m_flags &= ~HIDDEN;
1502 
1503  Update( aItem, APPEARANCE );
1504 }
Item is visible (in general)
Definition: view_item.h:70
No updates are required.
Definition: view_item.h:55
virtual void Update(VIEW_ITEM *aItem, int aUpdateFlags)
For dynamic VIEWs, informs the associated VIEW that the graphical representation of this item has cha...
Definition: view.cpp:1521
void KIGFX::SCH_VIEW::HideWorksheet ( )

Definition at line 148 of file sch_view.cpp.

Referenced by LIB_EDIT_FRAME::RebuildView().

149 {
150 // SetVisible( m_worksheet.get(), false );
151 }
void KIGFX::VIEW::invalidateItem ( VIEW_ITEM aItem,
int  aUpdateFlags 
)
protectedinherited

Function invalidateItem() Manages dirty flags & redraw queueing when updating an item.

Parameters
aItemis the item to be updated.
aUpdateFlagsdetermines the way an item is refreshed.

Definition at line 1197 of file view.cpp.

References KIGFX::ALL, KIGFX::VIEW_ITEM_DATA::clearUpdateFlags(), KIGFX::COLOR, KIGFX::GEOMETRY, i, KIGFX::INITIAL_ADD, KIGFX::VIEW::IsCached(), KIGFX::LAYERS, KIGFX::VIEW::m_layers, KIGFX::VIEW::MarkTargetDirty(), KIGFX::REPAINT, KIGFX::VIEW::updateBbox(), KIGFX::VIEW::updateItemColor(), KIGFX::VIEW::updateItemGeometry(), KIGFX::VIEW::updateLayers(), KIGFX::VIEW::VIEW_MAX_LAYERS, KIGFX::VIEW_ITEM::ViewGetLayers(), and KIGFX::VIEW_ITEM::viewPrivData().

Referenced by KIGFX::VIEW::markTargetClean(), and KIGFX::VIEW::UpdateItems().

1198 {
1199  if( aUpdateFlags & INITIAL_ADD )
1200  {
1201  // Don't update layers or bbox, since it was done in VIEW::Add()
1202  // Now that we have initialized, set flags to ALL for the code below
1203  aUpdateFlags = ALL;
1204  }
1205  else
1206  {
1207  // updateLayers updates geometry too, so we do not have to update both of them at the same time
1208  if( aUpdateFlags & LAYERS )
1209  {
1210  updateLayers( aItem );
1211  }
1212  else if( aUpdateFlags & GEOMETRY )
1213  {
1214  updateBbox( aItem );
1215  }
1216  }
1217 
1218  int layers[VIEW_MAX_LAYERS], layers_count;
1219  aItem->ViewGetLayers( layers, layers_count );
1220 
1221  // Iterate through layers used by the item and recache it immediately
1222  for( int i = 0; i < layers_count; ++i )
1223  {
1224  int layerId = layers[i];
1225 
1226  if( IsCached( layerId ) )
1227  {
1228  if( aUpdateFlags & ( GEOMETRY | LAYERS | REPAINT ) )
1229  updateItemGeometry( aItem, layerId );
1230  else if( aUpdateFlags & COLOR )
1231  updateItemColor( aItem, layerId );
1232  }
1233 
1234  // Mark those layers as dirty, so the VIEW will be refreshed
1235  MarkTargetDirty( m_layers[layerId].target );
1236  }
1237 
1238  aItem->viewPrivData()->clearUpdateFlags();
1239 }
Layers have changed.
Definition: view_item.h:59
void updateLayers(VIEW_ITEM *aItem)
Updates set of layers that an item occupies.
Definition: view.cpp:1322
void updateItemColor(VIEW_ITEM *aItem, int aLayer)
Updates colors that are used for an item to be drawn.
Definition: view.cpp:1257
Visibility flag has changed.
Definition: view_item.h:56
Item needs to be redrawn.
Definition: view_item.h:61
static constexpr int VIEW_MAX_LAYERS
maximum number of layers that may be shown
Definition: view.h:699
Item is being added to the view.
Definition: view_item.h:60
void MarkTargetDirty(int aTarget)
Function MarkTargetDirty() Sets or clears target &#39;dirty&#39; flag.
Definition: view.h:596
void updateBbox(VIEW_ITEM *aItem)
Updates bounding box of an item.
Definition: view.cpp:1306
void updateItemGeometry(VIEW_ITEM *aItem, int aLayer)
Updates all informations needed to draw an item.
Definition: view.cpp:1276
bool IsCached(int aLayer) const
Returns true if the layer is cached.
Definition: view.h:603
size_t i
Definition: json11.cpp:597
LAYER_MAP m_layers
Contains set of possible displayed layers and its properties.
Definition: view.h:810
Position or shape has changed.
Definition: view_item.h:58
Color has changed.
Definition: view_item.h:57
bool KIGFX::VIEW::IsCached ( int  aLayer) const
inlineinherited

Returns true if the layer is cached.

Definition at line 603 of file view.h.

References KIGFX::VIEW::m_layers, and KIGFX::TARGET_CACHED.

Referenced by KIGFX::VIEW::draw(), KIGFX::VIEW::invalidateItem(), KIGFX::VIEW::RecacheAllItems(), KIGFX::VIEW::updateItemColor(), KIGFX::VIEW::updateItemGeometry(), KIGFX::VIEW::UpdateLayerColor(), and KIGFX::VIEW::updateLayers().

604  {
605  wxCHECK( aLayer < (int) m_layers.size(), false );
606 
607  try
608  {
609  return m_layers.at( aLayer ).target == TARGET_CACHED;
610  }
611  catch( const std::out_of_range& )
612  {
613  return false;
614  }
615  }
Main rendering target (cached)
Definition: definitions.h:41
LAYER_MAP m_layers
Contains set of possible displayed layers and its properties.
Definition: view.h:810
bool KIGFX::VIEW::IsDirty ( ) const
inlineinherited

Function IsDirty() Returns true if any of the VIEW layers needs to be refreshened.

Returns
True in case if any of layers is marked as dirty.

Definition at line 568 of file view.h.

References i, KIGFX::VIEW::IsTargetDirty(), and KIGFX::TARGETS_NUMBER.

Referenced by EDA_DRAW_PANEL_GAL::onPaint(), and TOOL_MANAGER::ProcessEvent().

569  {
570  for( int i = 0; i < TARGETS_NUMBER; ++i )
571  {
572  if( IsTargetDirty( i ) )
573  return true;
574  }
575 
576  return false;
577  }
Number of available rendering targets.
Definition: definitions.h:44
bool IsTargetDirty(int aTarget) const
Function IsTargetDirty() Returns true if any of layers belonging to the target or the target itself s...
Definition: view.h:585
size_t i
Definition: json11.cpp:597
bool KIGFX::VIEW::IsDrawOrderReversed ( ) const
inlineinherited

Function IsDrawOrderReversed()

Returns
true if draw order is reversed

Definition at line 676 of file view.h.

References KIGFX::VIEW::m_reverseDrawOrder.

677  {
678  return m_reverseDrawOrder;
679  }
bool m_reverseDrawOrder
Flag to reverse the draw order when using draw priority.
Definition: view.h:866
bool KIGFX::VIEW::IsDynamic ( ) const
inlineinherited

Function IsDynamic() Tells if the VIEW is dynamic (ie.

can be changed, for example displaying PCBs in a window) or static (that cannot be modified, eg. displaying image/PDF).

Definition at line 558 of file view.h.

References KIGFX::VIEW::m_dynamic.

559  {
560  return m_dynamic;
561  }
bool m_dynamic
Dynamic VIEW (eg.
Definition: view.h:850
bool KIGFX::VIEW::IsLayerVisible ( int  aLayer) const
inlineinherited

Function IsLayerVisible() Returns information about visibility of a particular layer.

Parameters
aLayertrue if the layer is visible, false otherwise

Definition at line 427 of file view.h.

References KIGFX::VIEW::m_layers.

Referenced by KIGFX::VIEW_GROUP::ViewDraw(), EDGE_MODULE::ViewGetLOD(), TEXTE_MODULE::ViewGetLOD(), TRACK::ViewGetLOD(), MODULE::ViewGetLOD(), and D_PAD::ViewGetLOD().

428  {
429  wxCHECK( aLayer < (int) m_layers.size(), false );
430  return m_layers.at( aLayer ).visible;
431  }
LAYER_MAP m_layers
Contains set of possible displayed layers and its properties.
Definition: view.h:810
bool KIGFX::VIEW::IsMirroredX ( ) const
inlineinherited

Function IsMirroredX() Returns true if view is flipped across the X axis.

Definition at line 230 of file view.h.

References KIGFX::VIEW::m_mirrorX.

Referenced by COMMON_TOOLS::CursorControl(), KIGFX::WX_VIEW_CONTROLS::onScroll(), SELECTION_TOOL::selectMultiple(), KIGFX::WX_VIEW_CONTROLS::UpdateScrollbars(), and KIGFX::PREVIEW::SELECTION_AREA::ViewDraw().

231  {
232  return m_mirrorX;
233  }
bool m_mirrorX
Horizontal flip flag
Definition: view.h:837
bool KIGFX::VIEW::IsMirroredY ( ) const
inlineinherited

Function IsMirroredX() Returns true if view is flipped across the Y axis.

Definition at line 239 of file view.h.

References KIGFX::VIEW::m_mirrorY.

240  {
241  return m_mirrorY;
242  }
bool m_mirrorY
Vertical flip flag
Definition: view.h:840
bool KIGFX::VIEW::IsTargetDirty ( int  aTarget) const
inlineinherited

Function IsTargetDirty() Returns true if any of layers belonging to the target or the target itself should be redrawn.

Returns
True if the above condition is fulfilled.

Definition at line 585 of file view.h.

References KIGFX::VIEW::m_dirtyTargets, and KIGFX::TARGETS_NUMBER.

Referenced by KIGFX::VIEW::ClearTargets(), KIGFX::VIEW::IsDirty(), EDA_DRAW_PANEL_GAL::onPaint(), and KIGFX::VIEW::redrawRect().

586  {
587  wxCHECK( aTarget < TARGETS_NUMBER, false );
588  return m_dirtyTargets[aTarget];
589  }
Number of available rendering targets.
Definition: definitions.h:44
bool m_dirtyTargets[TARGETS_NUMBER]
Flags to mark targets as dirty, so they have to be redrawn on the next refresh event.
Definition: view.h:853
bool KIGFX::VIEW::IsUsingDrawPriority ( ) const
inlineinherited

Function IsUsingDrawPriority()

Returns
true if draw priority is being respected while redrawing.

Definition at line 658 of file view.h.

References KIGFX::VIEW::m_useDrawPriority.

659  {
660  return m_useDrawPriority;
661  }
bool m_useDrawPriority
Flat list of all items Flag to respect draw priority when drawing items.
Definition: view.h:860
bool KIGFX::VIEW::IsVisible ( const VIEW_ITEM aItem) const
inherited

Returns information if the item is visible (or not).

Parameters
aItemthe item to test.
Returns
when true, the item is visible (i.e. to be displayed, not visible in the current viewport)

Definition at line 1507 of file view.cpp.

References KIGFX::VIEW_ITEM_DATA::m_flags, KIGFX::VIEW_ITEM::viewPrivData(), and KIGFX::VISIBLE.

Referenced by GRID_HELPER::BestSnapAnchor(), and SELECTION_TOOL::selectable().

1508 {
1509  const auto viewData = aItem->viewPrivData();
1510 
1511  return viewData->m_flags & VISIBLE;
1512 }
std::shared_ptr< VIEW_OVERLAY > KIGFX::VIEW::MakeOverlay ( )
inherited

Definition at line 1535 of file view.cpp.

References KIGFX::VIEW::Add(), KIGFX::VIEW::TOP_LAYER_MODIFIER, and KIGFX::VIEW::VIEW_MAX_LAYERS.

Referenced by AUTOPLACE_TOOL::autoplace(), and KIGFX::VIEW::ReverseDrawOrder().

1536 {
1537  std::shared_ptr<VIEW_OVERLAY> overlay( new VIEW_OVERLAY );
1538 
1539  Add( overlay.get() );
1540  return overlay;
1541 }
virtual void Add(VIEW_ITEM *aItem, int aDrawPriority=-1)
Function Add() Adds a VIEW_ITEM to the view.
Definition: view.cpp:335
void KIGFX::VIEW::MarkForUpdate ( VIEW_ITEM aItem)
inherited

Function MarkForUpdate() Adds an item to a list of items that are going to be refreshed upon the next frame rendering.

Parameters
aItemis the item to be refreshed.

Referenced by KIGFX::VIEW::MarkDirty().

void KIGFX::VIEW::markTargetClean ( int  aTarget)
inlineprotectedinherited

Definition at line 732 of file view.h.

References KIGFX::VIEW::clearGroupCache(), KIGFX::VIEW::draw(), KIGFX::VIEW::invalidateItem(), KIGFX::VIEW::m_dirtyTargets, KIGFX::VIEW::sortLayers(), KIGFX::TARGETS_NUMBER, KIGFX::VIEW::updateBbox(), KIGFX::VIEW::updateItemColor(), KIGFX::VIEW::updateItemGeometry(), and KIGFX::VIEW::updateLayers().

Referenced by KIGFX::VIEW::Redraw().

733  {
734  wxCHECK( aTarget < TARGETS_NUMBER, /* void */ );
735  m_dirtyTargets[aTarget] = false;
736  }
Number of available rendering targets.
Definition: definitions.h:44
bool m_dirtyTargets[TARGETS_NUMBER]
Flags to mark targets as dirty, so they have to be redrawn on the next refresh event.
Definition: view.h:853
void KIGFX::VIEW::MarkTargetDirty ( int  aTarget)
inlineinherited
void KIGFX::VIEW::OnDestroy ( VIEW_ITEM aItem)
staticinherited

Definition at line 271 of file view.cpp.

References KIGFX::VIEW_ITEM_DATA::m_view, and KIGFX::VIEW_ITEM::viewPrivData().

Referenced by KIGFX::VIEW_ITEM::~VIEW_ITEM().

272 {
273  auto data = aItem->viewPrivData();
274 
275  if( !data )
276  return;
277 
278  if( data->m_view )
279  data->m_view->VIEW::Remove( aItem );
280 
281  delete data;
282 }
int KIGFX::VIEW::Query ( const BOX2I aRect,
std::vector< LAYER_ITEM_PAIR > &  aResult 
) const
virtualinherited

Function Query() Finds all visible items that touch or are within the rectangle aRect.

Parameters
aRectarea to search for items
aResultresult of the search, containing VIEW_ITEMs associated with their layers. Sorted according to the rendering order (items that are on top of the rendering stack as first).
Returns
Number of found items.

Definition at line 441 of file view.cpp.

References i, and KIGFX::VIEW::m_orderedLayers.

Referenced by GERBVIEW_SELECTION_TOOL::selectMultiple(), and SELECTION_TOOL::selectMultiple().

442 {
443  if( m_orderedLayers.empty() )
444  return 0;
445 
446  std::vector<VIEW_LAYER*>::const_reverse_iterator i;
447 
448  // execute queries in reverse direction, so that items that are on the top of
449  // the rendering stack are returned first.
450  for( i = m_orderedLayers.rbegin(); i != m_orderedLayers.rend(); ++i )
451  {
452  // ignore layers that do not contain actual items (i.e. the selection box, menus, floats)
453  if( ( *i )->displayOnly || !( *i )->visible )
454  continue;
455 
456  queryVisitor<std::vector<LAYER_ITEM_PAIR> > visitor( aResult, ( *i )->id );
457  ( *i )->items->Query( aRect, visitor );
458  }
459 
460  return aResult.size();
461 }
LAYER_ORDER m_orderedLayers
Sorted list of pointers to members of m_layers.
Definition: view.h:816
size_t i
Definition: json11.cpp:597
void KIGFX::VIEW::RecacheAllItems ( )
inherited

Function RecacheAllItems() Rebuilds GAL display lists.

Definition at line 1383 of file view.cpp.

References i, KIGFX::VIEW::VIEW_LAYER::id, KIGFX::VIEW::IsCached(), KIGFX::VIEW::VIEW_LAYER::items, KIGFX::VIEW::m_gal, KIGFX::VIEW::m_layers, and BOX2< Vec >::SetMaximum().

Referenced by SCH_EDIT_FRAME::ExecuteRemoteCommand(), SCH_EDIT_FRAME::HighlightConnectionAtPosition(), GERBVIEW_DRAW_PANEL_GAL::OnShow(), KIGFX::VIEW::SetLayerTarget(), PANEL_PCBNEW_DISPLAY_OPTIONS::TransferDataFromWindow(), PANEL_MODEDIT_DISPLAY_OPTIONS::TransferDataFromWindow(), PANEL_LIBEDIT_DISPLAY_OPTIONS::TransferDataFromWindow(), PCB_BASE_FRAME::UseGalCanvas(), and GERBVIEW_FRAME::UseGalCanvas().

1384 {
1385  BOX2I r;
1386 
1387  r.SetMaximum();
1388 
1389  for( LAYER_MAP_ITER i = m_layers.begin(); i != m_layers.end(); ++i )
1390  {
1391  VIEW_LAYER* l = &( ( *i ).second );
1392 
1393  if( IsCached( l->id ) )
1394  {
1395  recacheItem visitor( this, m_gal, l->id );
1396  l->items->Query( r, visitor );
1397  }
1398  }
1399 }
GAL * m_gal
Gives interface to PAINTER, that is used to draw items.
Definition: view.h:846
void SetMaximum()
Definition: box2.h:71
LAYER_MAP::iterator LAYER_MAP_ITER
Definition: view.h:715
bool IsCached(int aLayer) const
Returns true if the layer is cached.
Definition: view.h:603
size_t i
Definition: json11.cpp:597
LAYER_MAP m_layers
Contains set of possible displayed layers and its properties.
Definition: view.h:810
void KIGFX::VIEW::Redraw ( )
virtualinherited

Function Redraw() Immediately redraws the whole view.

Definition at line 1133 of file view.cpp.

References KIGFX::GAL::GetScreenPixelSize(), KIGFX::VIEW::m_gal, KIGFX::VIEW::markTargetClean(), PROF_COUNTER::msecs(), BOX2< Vec >::Normalize(), KIGFX::VIEW::redrawRect(), PROF_COUNTER::Stop(), KIGFX::TARGET_CACHED, KIGFX::TARGET_NONCACHED, KIGFX::TARGET_OVERLAY, and KIGFX::VIEW::ToWorld().

Referenced by EDA_DRAW_PANEL_GAL::onPaint(), and KIGFX::VIEW::SetLayerTarget().

1134 {
1135 #ifdef __WXDEBUG__
1136  PROF_COUNTER totalRealTime;
1137 #endif /* __WXDEBUG__ */
1138 
1139  VECTOR2D screenSize = m_gal->GetScreenPixelSize();
1140  BOX2I rect( ToWorld( VECTOR2D( 0, 0 ) ),
1141  ToWorld( screenSize ) - ToWorld( VECTOR2D( 0, 0 ) ) );
1142  rect.Normalize();
1143 
1144  redrawRect( rect );
1145 
1146  // All targets were redrawn, so nothing is dirty
1150 
1151 #ifdef __WXDEBUG__
1152  totalRealTime.Stop();
1153  wxLogTrace( "GAL_PROFILE", "VIEW::Redraw(): %.1f ms", totalRealTime.msecs() );
1154 #endif /* __WXDEBUG__ */
1155 }
void Stop()
save the time when this function was called, and set the counter stane to stop
Definition: profile.h:82
VECTOR2D ToWorld(const VECTOR2D &aCoord, bool aAbsolute=true) const
Function ToWorld() Converts a screen space point/vector to a point/vector in world space coordinates...
Definition: view.cpp:464
GAL * m_gal
Gives interface to PAINTER, that is used to draw items.
Definition: view.h:846
The class PROF_COUNTER is a small class to help profiling.
Definition: profile.h:45
Auxiliary rendering target (noncached)
Definition: definitions.h:42
VECTOR2< double > VECTOR2D
Definition: vector2d.h:586
Items that may change while the view stays the same (noncached)
Definition: definitions.h:43
void markTargetClean(int aTarget)
Definition: view.h:732
const VECTOR2I & GetScreenPixelSize() const
Returns GAL canvas size in pixels.
double msecs() const
Definition: profile.h:124
void redrawRect(const BOX2I &aRect)
Definition: view.cpp:998
Main rendering target (cached)
Definition: definitions.h:41
void KIGFX::VIEW::redrawRect ( const BOX2I aRect)
protectedinherited
  • Redraws contents within rect aRect

Definition at line 998 of file view.cpp.

References KIGFX::VIEW::areRequiredLayersEnabled(), KIGFX::VIEW::drawItem::deferredDraw(), KIGFX::VIEW::IsTargetDirty(), KIGFX::VIEW::m_gal, KIGFX::VIEW::m_orderedLayers, KIGFX::VIEW::m_reverseDrawOrder, KIGFX::VIEW::m_useDrawPriority, KIGFX::GAL::SetLayerDepth(), and KIGFX::GAL::SetTarget().

Referenced by KIGFX::VIEW::Redraw().

999 {
1000  for( VIEW_LAYER* l : m_orderedLayers )
1001  {
1002  if( l->visible && IsTargetDirty( l->target ) && areRequiredLayersEnabled( l->id ) )
1003  {
1004  drawItem drawFunc( this, l->id, m_useDrawPriority, m_reverseDrawOrder );
1005 
1006  m_gal->SetTarget( l->target );
1007  m_gal->SetLayerDepth( l->renderingOrder );
1008  l->items->Query( aRect, drawFunc );
1009 
1010  if( m_useDrawPriority )
1011  drawFunc.deferredDraw();
1012  }
1013  }
1014 }
bool m_useDrawPriority
Flat list of all items Flag to respect draw priority when drawing items.
Definition: view.h:860
GAL * m_gal
Gives interface to PAINTER, that is used to draw items.
Definition: view.h:846
virtual void SetLayerDepth(double aLayerDepth)
Set the depth of the layer (position on the z-axis)
bool IsTargetDirty(int aTarget) const
Function IsTargetDirty() Returns true if any of layers belonging to the target or the target itself s...
Definition: view.h:585
LAYER_ORDER m_orderedLayers
Sorted list of pointers to members of m_layers.
Definition: view.h:816
bool m_reverseDrawOrder
Flag to reverse the draw order when using draw priority.
Definition: view.h:866
bool areRequiredLayersEnabled(int aLayerId) const
Checks if every layer required by the aLayerId layer is enabled.
Definition: view.cpp:1365
virtual void SetTarget(RENDER_TARGET aTarget)
Sets the target for rendering.
void KIGFX::VIEW::Remove ( VIEW_ITEM aItem)
virtualinherited

Function Remove() Removes a VIEW_ITEM from the view.

Parameters
aItemitem to be removed. Caller must dispose the removed item if necessary

Reimplemented in KIGFX::PCB_VIEW.

Definition at line 365 of file view.cpp.

References KIGFX::GAL::DeleteGroup(), i, KIGFX::VIEW::VIEW_LAYER::items, KIGFX::VIEW::m_allItems, KIGFX::VIEW::m_gal, KIGFX::VIEW::m_layers, KIGFX::VIEW::MarkTargetDirty(), KIGFX::VIEW::VIEW_LAYER::target, KIGFX::VIEW::VIEW_MAX_LAYERS, and KIGFX::VIEW_ITEM::viewPrivData().

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), SYMBOL_PREVIEW_WIDGET::DisplayPart(), SYMBOL_PREVIEW_WIDGET::DisplaySymbol(), SELECTION_TOOL::doSelectionMenu(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::drawSegment(), POINT_EDITOR::OnSelectionChange(), DRAWING_TOOL::PlaceDXF(), BOARD_COMMIT::Push(), SCH_EDIT_FRAME::PutDataInPreviousState(), PCB_EDIT_FRAME::ReadPcbNetlist(), KIGFX::PCB_VIEW::Remove(), EDIT_TOOL::Remove(), SCH_BASE_FRAME::RemoveFromScreen(), PCB_EDITOR_CONTROL::Reset(), PCBNEW_CONTROL::Reset(), GERBVIEW_SELECTION_TOOL::Reset(), BOARD_COMMIT::Revert(), SCH_EDIT_FRAME::SaveWireImage(), GERBVIEW_SELECTION_TOOL::selectMultiple(), SELECTION_TOOL::selectMultiple(), GERBVIEW_SELECTION_TOOL::unselect(), POINT_EDITOR::updatePoints(), LIB_VIEW_FRAME::updatePreviewSymbol(), CVPCB_SELECTION_TOOL::~CVPCB_SELECTION_TOOL(), GERBVIEW_SELECTION_TOOL::~GERBVIEW_SELECTION_TOOL(), LIB_VIEW_FRAME::~LIB_VIEW_FRAME(), SELECTION_TOOL::~SELECTION_TOOL(), SYMBOL_PREVIEW_WIDGET::~SYMBOL_PREVIEW_WIDGET(), and ZONE_CREATE_HELPER::~ZONE_CREATE_HELPER().

366 {
367  if( !aItem )
368  return;
369 
370  auto viewData = aItem->viewPrivData();
371 
372  if( !viewData )
373  return;
374 
375  wxCHECK( viewData->m_view == this, /*void*/ );
376  auto item = std::find( m_allItems->begin(), m_allItems->end(), aItem );
377 
378  if( item != m_allItems->end() )
379  {
380  m_allItems->erase( item );
381  viewData->clearUpdateFlags();
382  }
383 
384  int layers[VIEW::VIEW_MAX_LAYERS], layers_count;
385  viewData->getLayers( layers, layers_count );
386 
387  for( int i = 0; i < layers_count; ++i )
388  {
389  VIEW_LAYER& l = m_layers[layers[i]];
390  l.items->Remove( aItem );
391  MarkTargetDirty( l.target );
392 
393  // Clear the GAL cache
394  int prevGroup = viewData->getGroup( layers[i] );
395 
396  if( prevGroup >= 0 )
397  m_gal->DeleteGroup( prevGroup );
398  }
399 
400  viewData->deleteGroups();
401  viewData->m_view = nullptr;
402 }
virtual void DeleteGroup(int aGroupNumber)
Delete the group from the memory.
GAL * m_gal
Gives interface to PAINTER, that is used to draw items.
Definition: view.h:846
static constexpr int VIEW_MAX_LAYERS
maximum number of layers that may be shown
Definition: view.h:699
std::shared_ptr< std::vector< VIEW_ITEM * > > m_allItems
Flat list of all items.
Definition: view.h:813
void MarkTargetDirty(int aTarget)
Function MarkTargetDirty() Sets or clears target &#39;dirty&#39; flag.
Definition: view.h:596
size_t i
Definition: json11.cpp:597
LAYER_MAP m_layers
Contains set of possible displayed layers and its properties.
Definition: view.h:810
void KIGFX::VIEW::ReorderLayerData ( std::unordered_map< int, int >  aReorderMap)
inherited

Remaps the data between layer ids without invalidating that data.

Used by GerbView for the "Sort by X2" functionality

Parameters
aReorderMapis a mapping of old to new layer ids

Definition at line 694 of file view.cpp.

References KIGFX::COLOR, KIGFX::VIEW::VIEW_LAYER::id, KIGFX::VIEW::m_allItems, KIGFX::VIEW::m_layers, KIGFX::VIEW::UpdateItems(), and KIGFX::VIEW::VIEW_MAX_LAYERS.

Referenced by KIGFX::VIEW::SetLayerTarget(), and GERBVIEW_FRAME::SortLayersByX2Attributes().

695 {
696  LAYER_MAP new_map;
697 
698  for( const auto& it : m_layers )
699  {
700  int orig_idx = it.first;
701  VIEW_LAYER layer = it.second;
702  int new_idx;
703 
704  try
705  {
706  new_idx = aReorderMap.at( orig_idx );
707  }
708  catch( const std::out_of_range& )
709  {
710  new_idx = orig_idx;
711  }
712 
713  layer.id = new_idx;
714  new_map[new_idx] = layer;
715  }
716 
717  m_layers = new_map;
718 
719  for( VIEW_ITEM* item : *m_allItems )
720  {
721  auto viewData = item->viewPrivData();
722 
723  if( !viewData )
724  continue;
725 
726  int layers[VIEW::VIEW_MAX_LAYERS], layers_count;
727 
728  item->ViewGetLayers( layers, layers_count );
729  viewData->saveLayers( layers, layers_count );
730 
731  viewData->reorderGroups( aReorderMap );
732 
733  viewData->m_requiredUpdate |= COLOR;
734  }
735 
736  UpdateItems();
737 }
friend class VIEW_ITEM
Definition: view.h:64
Visibility flag has changed.
Definition: view_item.h:56
static constexpr int VIEW_MAX_LAYERS
maximum number of layers that may be shown
Definition: view.h:699
std::shared_ptr< std::vector< VIEW_ITEM * > > m_allItems
Flat list of all items.
Definition: view.h:813
std::unordered_map< int, VIEW_LAYER > LAYER_MAP
Definition: view.h:714
void UpdateItems()
Function UpdateItems() Iterates through the list of items that asked for updating and updates them...
Definition: view.cpp:1402
LAYER_MAP m_layers
Contains set of possible displayed layers and its properties.
Definition: view.h:810
void KIGFX::VIEW::ReverseDrawOrder ( bool  aFlag)
inlineinherited

Function ReverseDrawOrder() Only takes effect if UseDrawPriority is true.

Parameters
aFlagis true if draw order should be reversed

Definition at line 686 of file view.h.

References KIGFX::VIEW::DataReference(), KIGFX::VIEW::m_reverseDrawOrder, and KIGFX::VIEW::MakeOverlay().

Referenced by EDA_DRAW_PANEL_GAL::SwitchBackend().

687  {
688  m_reverseDrawOrder = aFlag;
689  }
bool m_reverseDrawOrder
Flag to reverse the draw order when using draw priority.
Definition: view.h:866
void KIGFX::VIEW::SetBoundary ( const BOX2D aBoundary)
inlineinherited

Function SetBoundary() Sets limits for view area.

Parameters
aBoundaryis the box that limits view area.

Definition at line 278 of file view.h.

References KIGFX::VIEW::m_boundary.

Referenced by DIALOG_PAD_PROPERTIES::redraw().

279  {
280  m_boundary = aBoundary;
281  }
BOX2D m_boundary
View boundaries.
Definition: view.h:828
void KIGFX::VIEW::SetBoundary ( const BOX2I aBoundary)
inlineinherited

Function SetBoundary() Sets limits for view area.

Parameters
aBoundaryis the box that limits view area.

Definition at line 288 of file view.h.

References BOX2< Vec >::GetEnd(), BOX2< Vec >::GetOrigin(), KIGFX::VIEW::m_boundary, BOX2< Vec >::SetEnd(), and BOX2< Vec >::SetOrigin().

289  {
290  m_boundary.SetOrigin( aBoundary.GetOrigin() );
291  m_boundary.SetEnd( aBoundary.GetEnd() );
292  }
const Vec & GetOrigin() const
Definition: box2.h:191
const Vec GetEnd() const
Definition: box2.h:193
void SetEnd(coord_type x, coord_type y)
Definition: box2.h:223
BOX2D m_boundary
View boundaries.
Definition: view.h:828
void SetOrigin(const Vec &pos)
Definition: box2.h:208
void KIGFX::VIEW::SetCenter ( const VECTOR2D aCenter)
inherited

Function SetCenter() Sets the center point of the VIEW (i.e.

the point in world space that will be drawn in the middle of the screen).

Parameters
aCenterthe new center point, in world space coordinates.

Definition at line 590 of file view.cpp.

References KIGFX::GAL::ComputeWorldScreenMatrix(), BOX2< Vec >::Contains(), BOX2< Vec >::GetBottom(), BOX2< Vec >::GetLeft(), BOX2< Vec >::GetRight(), BOX2< Vec >::GetTop(), KIGFX::VIEW::m_boundary, KIGFX::VIEW::m_center, KIGFX::VIEW::m_gal, KIGFX::VIEW::MarkDirty(), KIGFX::GAL::SetLookAtPoint(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by COMMON_TOOLS::CenterContents(), KIGFX::WX_VIEW_CONTROLS::CenterOnCursor(), SCH_BASE_FRAME::CenterScreen(), PCB_EDITOR_CONTROL::CrossProbeSchToPcb(), SELECTION_TOOL::findCallback(), SYMBOL_PREVIEW_WIDGET::fitOnDrawArea(), PCB_BASE_FRAME::FocusOnLocation(), KIGFX::WX_VIEW_CONTROLS::onMotion(), KIGFX::WX_VIEW_CONTROLS::onScroll(), KIGFX::WX_VIEW_CONTROLS::onTimer(), KIGFX::WX_VIEW_CONTROLS::onWheel(), KIGFX::VIEW::SetCenter(), KIGFX::WX_VIEW_CONTROLS::SetCrossHairCursorPosition(), KIGFX::VIEW::SetGAL(), KIGFX::VIEW::SetScale(), KIGFX::VIEW::SetScaleLimits(), KIGFX::VIEW::SetViewport(), EDA_DRAW_FRAME::UseGalCanvas(), KIGFX::WX_VIEW_CONTROLS::WarpCursor(), SCH_BASE_FRAME::Window_Zoom(), SCH_BASE_FRAME::Zoom_Automatique(), COMMON_TOOLS::ZoomFitScreen(), and SELECTION_TOOL::zoomFitSelection().

591 {
592  m_center = aCenter;
593 
594  if( !m_boundary.Contains( aCenter ) )
595  {
596  if( m_center.x < m_boundary.GetLeft() )
598  else if( aCenter.x > m_boundary.GetRight() )
600 
601  if( m_center.y < m_boundary.GetTop() )
603  else if( m_center.y > m_boundary.GetBottom() )
605  }
606 
609 
610  // Redraw everything after the viewport has changed
611  MarkDirty();
612 }
bool Contains(const Vec &aPoint) const
Function Contains.
Definition: box2.h:149
GAL * m_gal
Gives interface to PAINTER, that is used to draw items.
Definition: view.h:846
coord_type GetRight() const
Definition: box2.h:197
virtual void ComputeWorldScreenMatrix()
Compute the world <-> screen transformation matrix.
coord_type GetTop() const
Definition: box2.h:202
VECTOR2D m_center
Center point of the VIEW (the point at which we are looking at)
Definition: view.h:822
coord_type GetBottom() const
Definition: box2.h:198
BOX2D m_boundary
View boundaries.
Definition: view.h:828
void SetLookAtPoint(const VECTOR2D &aPoint)
Set the Point in world space to look at.
coord_type GetLeft() const
Definition: box2.h:201
void MarkDirty()
Function MarkDirty() Forces redraw of view on the next rendering.
Definition: view.h:621
void KIGFX::VIEW::SetCenter ( VECTOR2D  aCenter,
const BOX2D occultingScreenRect 
)
inherited

Function SetCenter() Sets the center point of the VIEW, attempting to avoid occultingScreenRect (for instance, the screen rect of a modeless dialog in front of the VIEW).

Parameters
aCenterthe new center point, in world space coordinates.
occultingScreenRectthe occulting rect, in screen space coordinates.

Definition at line 615 of file view.cpp.

References BOX2< Vec >::GetBottom(), BOX2< Vec >::GetHeight(), BOX2< Vec >::GetLeft(), BOX2< Vec >::GetRight(), KIGFX::GAL::GetScreenPixelSize(), BOX2< Vec >::GetTop(), BOX2< Vec >::GetWidth(), BOX2< Vec >::Intersect(), KIGFX::VIEW::m_gal, max, KIGFX::VIEW::SetCenter(), KIGFX::VIEW::ToWorld(), VECTOR2< T >::x, and VECTOR2< T >::y.

616 {
617  BOX2D screenRect( VECTOR2D( 0, 0 ), m_gal->GetScreenPixelSize() );
618 
619  if( !screenRect.Intersects( occultingScreenRect ) )
620  {
621  SetCenter( aCenter );
622  return;
623  }
624 
625  BOX2D occultedRect = screenRect.Intersect( occultingScreenRect );
626  VECTOR2D offset( occultedRect.GetWidth() / 2, occultedRect.GetHeight() / 2 );
627 
628  double topExposed = occultedRect.GetTop() - screenRect.GetTop();
629  double bottomExposed = screenRect.GetBottom() - occultedRect.GetBottom();
630  double leftExposed = occultedRect.GetLeft() - screenRect.GetLeft();
631  double rightExposed = screenRect.GetRight() - occultedRect.GetRight();
632 
633  if( std::max( topExposed, bottomExposed ) > std::max( leftExposed, rightExposed ) )
634  {
635  if( topExposed > bottomExposed )
636  aCenter.y += ToWorld( occultedRect.GetHeight() / 2 );
637  else
638  aCenter.y -= ToWorld( occultedRect.GetHeight() / 2 );
639  }
640  else
641  {
642  if( leftExposed > rightExposed )
643  aCenter.x += ToWorld( occultedRect.GetWidth() / 2 );
644  else
645  aCenter.x -= ToWorld( occultedRect.GetWidth() / 2 );
646  }
647 
648  SetCenter( aCenter );
649 }
VECTOR2D ToWorld(const VECTOR2D &aCoord, bool aAbsolute=true) const
Function ToWorld() Converts a screen space point/vector to a point/vector in world space coordinates...
Definition: view.cpp:464
GAL * m_gal
Gives interface to PAINTER, that is used to draw items.
Definition: view.h:846
coord_type GetRight() const
Definition: box2.h:197
coord_type GetTop() const
Definition: box2.h:202
coord_type GetWidth() const
Definition: box2.h:195
void SetCenter(const VECTOR2D &aCenter)
Function SetCenter() Sets the center point of the VIEW (i.e.
Definition: view.cpp:590
VECTOR2< double > VECTOR2D
Definition: vector2d.h:586
coord_type GetBottom() const
Definition: box2.h:198
const VECTOR2I & GetScreenPixelSize() const
Returns GAL canvas size in pixels.
coord_type GetHeight() const
Definition: box2.h:196
#define max(a, b)
Definition: auxiliary.h:86
coord_type GetLeft() const
Definition: box2.h:201
BOX2< Vec > Intersect(const BOX2< Vec > &aRect)
Function Intersect Returns the intersection of this with another rectangle.
Definition: box2.h:266
void KIGFX::VIEW::SetGAL ( GAL aGal)
inherited

Function SetGAL() Assigns a rendering device for the VIEW.

Parameters
aGalpointer to the GAL output device

Definition at line 508 of file view.cpp.

References KIGFX::VIEW::clearGroupCache(), KIGFX::VIEW::m_center, KIGFX::VIEW::m_gal, KIGFX::VIEW::m_mirrorX, KIGFX::VIEW::m_mirrorY, KIGFX::VIEW::m_scale, KIGFX::VIEW::MarkDirty(), KIGFX::VIEW::SetCenter(), KIGFX::VIEW::SetMirror(), and KIGFX::VIEW::SetScale().

Referenced by GERBVIEW_DRAW_PANEL_GAL::GERBVIEW_DRAW_PANEL_GAL(), PCB_DRAW_PANEL_GAL::PCB_DRAW_PANEL_GAL(), SCH_PREVIEW_PANEL::SCH_PREVIEW_PANEL(), and EDA_DRAW_PANEL_GAL::SwitchBackend().

509 {
510  bool recacheGroups = ( m_gal != nullptr ); // recache groups only if GAL is reassigned
511  m_gal = aGal;
512 
513  // clear group numbers, so everything is going to be recached
514  if( recacheGroups )
515  clearGroupCache();
516 
517  // every target has to be refreshed
518  MarkDirty();
519 
520  // force the new GAL to display the current viewport.
521  SetCenter( m_center );
522  SetScale( m_scale );
524 }
GAL * m_gal
Gives interface to PAINTER, that is used to draw items.
Definition: view.h:846
void SetMirror(bool aMirrorX, bool aMirrorY)
Function SetMirror() Controls the mirroring of the VIEW.
Definition: view.cpp:554
void SetScale(double aScale)
Function SetScale() Sets the scaling factor.
Definition: view.h:250
VECTOR2D m_center
Center point of the VIEW (the point at which we are looking at)
Definition: view.h:822
void SetCenter(const VECTOR2D &aCenter)
Function SetCenter() Sets the center point of the VIEW (i.e.
Definition: view.cpp:590
bool m_mirrorX
Horizontal flip flag
Definition: view.h:837
void clearGroupCache()
Definition: view.cpp:1182
bool m_mirrorY
Vertical flip flag
Definition: view.h:840
double m_scale
Scale of displayed VIEW_ITEMs.
Definition: view.h:825
void MarkDirty()
Function MarkDirty() Forces redraw of view on the next rendering.
Definition: view.h:621
void KIGFX::VIEW::SetLayerDisplayOnly ( int  aLayer,
bool  aDisplayOnly = true 
)
inlineinherited

Definition at line 433 of file view.h.

References KIGFX::VIEW::m_layers.

Referenced by GERBVIEW_DRAW_PANEL_GAL::setDefaultLayerDeps(), SCH_PREVIEW_PANEL::setDefaultLayerDeps(), and PCB_DRAW_PANEL_GAL::setDefaultLayerDeps().

434  {
435  wxCHECK( aLayer < (int) m_layers.size(), /*void*/ );
436  m_layers[aLayer].displayOnly = aDisplayOnly;
437  }
LAYER_MAP m_layers
Contains set of possible displayed layers and its properties.
Definition: view.h:810
void KIGFX::VIEW::SetLayerOrder ( int  aLayer,
int  aRenderingOrder 
)
inherited

Function SetLayerOrder() Sets rendering order of a particular layer.

Lower values are rendered first.

Parameters
aLayerthe layer
aRenderingOrderarbitrary number denoting the rendering order.

Definition at line 652 of file view.cpp.

References KIGFX::VIEW::m_layers, and KIGFX::VIEW::sortLayers().

Referenced by SCH_PREVIEW_PANEL::setDefaultLayerOrder(), PCB_DRAW_PANEL_GAL::setDefaultLayerOrder(), KIGFX::VIEW::SetLayerTarget(), GERBVIEW_DRAW_PANEL_GAL::SetTopLayer(), and PCB_DRAW_PANEL_GAL::SetTopLayer().

653 {
654  m_layers[aLayer].renderingOrder = aRenderingOrder;
655 
656  sortLayers();
657 }
void sortLayers()
Definition: view.cpp:1242
LAYER_MAP m_layers
Contains set of possible displayed layers and its properties.
Definition: view.h:810
void KIGFX::VIEW::SetLayerTarget ( int  aLayer,
RENDER_TARGET  aTarget 
)
inlineinherited

Function SetLayerTarget() Changes the rendering target for a particular layer.

Parameters
aLayeris the layer.
aTargetis the rendering target.

Definition at line 445 of file view.h.

References KIGFX::VIEW::ClearTargets(), KIGFX::VIEW::ClearTopLayers(), KIGFX::VIEW::EnableTopLayer(), KIGFX::VIEW::GetLayerOrder(), KIGFX::VIEW::GetTopLayer(), KIGFX::VIEW::m_layers, KIGFX::VIEW::RecacheAllItems(), KIGFX::VIEW::Redraw(), KIGFX::VIEW::ReorderLayerData(), KIGFX::VIEW::SetLayerOrder(), KIGFX::VIEW::SetTopLayer(), KIGFX::VIEW::SortLayers(), KIGFX::VIEW::UpdateAllLayersColor(), KIGFX::VIEW::UpdateAllLayersOrder(), and KIGFX::VIEW::UpdateLayerColor().

Referenced by GERBVIEW_DRAW_PANEL_GAL::setDefaultLayerDeps(), SCH_PREVIEW_PANEL::setDefaultLayerDeps(), and PCB_DRAW_PANEL_GAL::setDefaultLayerDeps().

446  {
447  wxCHECK( aLayer < (int) m_layers.size(), /*void*/ );
448  m_layers[aLayer].target = aTarget;
449  }
LAYER_MAP m_layers
Contains set of possible displayed layers and its properties.
Definition: view.h:810
void KIGFX::VIEW::SetLayerVisible ( int  aLayer,
bool  aVisible = true 
)
inlineinherited

Function SetLayerVisible() Controls the visibility of a particular layer.

Parameters
aLayerthe layer to show/hide.
aVisiblethe obvious.

Definition at line 410 of file view.h.

References KIGFX::VIEW::m_layers, and KIGFX::VIEW::MarkTargetDirty().

Referenced by PCB_LAYER_WIDGET::OnLayerVisible(), PCB_LAYER_WIDGET::OnRenderEnable(), FOOTPRINT_EDIT_FRAME::SetElementVisibility(), and PCB_DRAW_PANEL_GAL::SyncLayersVisibility().

411  {
412  wxCHECK( aLayer < (int) m_layers.size(), /*void*/ );
413 
414  if( m_layers[aLayer].visible != aVisible )
415  {
416  // Target has to be redrawn after changing its visibility
417  MarkTargetDirty( m_layers[aLayer].target );
418  m_layers[aLayer].visible = aVisible;
419  }
420  }
void MarkTargetDirty(int aTarget)
Function MarkTargetDirty() Sets or clears target &#39;dirty&#39; flag.
Definition: view.h:596
LAYER_MAP m_layers
Contains set of possible displayed layers and its properties.
Definition: view.h:810
void KIGFX::VIEW::SetMirror ( bool  aMirrorX,
bool  aMirrorY 
)
inherited

Function SetMirror() Controls the mirroring of the VIEW.

Parameters
aMirrorXwhen true, the X axis is mirrored
aMirrorYwhen true, the Y axis is mirrored.

Definition at line 554 of file view.cpp.

References KIGFX::VIEW::m_gal, KIGFX::VIEW::m_mirrorX, KIGFX::VIEW::m_mirrorY, KIGFX::VIEW::MarkDirty(), and KIGFX::GAL::SetFlip().

Referenced by KIGFX::VIEW::GetPainter(), SCH_PREVIEW_PANEL::SCH_PREVIEW_PANEL(), and KIGFX::VIEW::SetGAL().

555 {
556  wxASSERT_MSG( !aMirrorY, _( "Mirroring for Y axis is not supported yet" ) );
557 
558  m_mirrorX = aMirrorX;
559  m_mirrorY = aMirrorY;
560  m_gal->SetFlip( aMirrorX, aMirrorY );
561 
562  // Redraw everything
563  MarkDirty();
564 }
void SetFlip(bool xAxis, bool yAxis)
Sets flipping of the screen.
GAL * m_gal
Gives interface to PAINTER, that is used to draw items.
Definition: view.h:846
bool m_mirrorX
Horizontal flip flag
Definition: view.h:837
bool m_mirrorY
Vertical flip flag
Definition: view.h:840
void MarkDirty()
Function MarkDirty() Forces redraw of view on the next rendering.
Definition: view.h:621
void KIGFX::VIEW::SetPainter ( PAINTER aPainter)
inlineinherited

Function SetPainter() Sets the painter object used by the view for drawing VIEW_ITEMS.

Definition at line 189 of file view.h.

References KIGFX::VIEW::m_painter.

Referenced by GERBVIEW_DRAW_PANEL_GAL::GERBVIEW_DRAW_PANEL_GAL(), PCB_DRAW_PANEL_GAL::PCB_DRAW_PANEL_GAL(), and SCH_PREVIEW_PANEL::SCH_PREVIEW_PANEL().

190  {
191  m_painter = aPainter;
192  }
PAINTER * m_painter
PAINTER contains information how do draw items.
Definition: view.h:843
void KIGFX::VIEW::SetRequired ( int  aLayerId,
int  aRequiredId,
bool  aRequired = true 
)
inherited

Function SetRequired() Marks the aRequiredId layer as required for the aLayerId layer.

In order to display the layer, all of its required layers have to be enabled.

Parameters
aLayerIdis the id of the layer for which we enable/disable the required layer.
aRequiredIdis the id of the required layer.
aRequiredtells if the required layer should be added or removed from the list.

Definition at line 405 of file view.cpp.

References KIGFX::VIEW::m_layers.

Referenced by PCB_DRAW_PANEL_GAL::setDefaultLayerDeps().

406 {
407  wxCHECK( (unsigned) aLayerId < m_layers.size(), /*void*/ );
408  wxCHECK( (unsigned) aRequiredId < m_layers.size(), /*void*/ );
409 
410  if( aRequired )
411  m_layers[aLayerId].requiredLayers.insert( aRequiredId );
412  else
413  m_layers[aLayerId].requiredLayers.erase( aRequired );
414 }
LAYER_MAP m_layers
Contains set of possible displayed layers and its properties.
Definition: view.h:810
void KIGFX::VIEW::SetScale ( double  aScale)
inlineinherited

Function SetScale() Sets the scaling factor.

Scale = 1 corresponds to the real world size of the objects (depending on correct GAL unit length & DPI settings).

Parameters
aScalethe scalefactor

Definition at line 250 of file view.h.

References KIGFX::VIEW::m_center.

Referenced by COMMON_TOOLS::doZoomToPreset(), SYMBOL_PREVIEW_WIDGET::fitOnDrawArea(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), KIGFX::WX_VIEW_CONTROLS::onWheel(), EDA_DRAW_FRAME::OnZoom(), DIALOG_PAD_PROPERTIES::redraw(), SCH_BASE_FRAME::RedrawScreen(), SCH_BASE_FRAME::RedrawScreen2(), FOOTPRINT_PREVIEW_PANEL::renderFootprint(), KIGFX::VIEW::SetGAL(), KIGFX::VIEW::SetViewport(), EDA_DRAW_FRAME::UseGalCanvas(), SCH_BASE_FRAME::Window_Zoom(), SCH_BASE_FRAME::Zoom_Automatique(), COMMON_TOOLS::ZoomFitScreen(), and SELECTION_TOOL::zoomFitSelection().

251  {
252  SetScale( aScale, m_center );
253  }
void SetScale(double aScale)
Function SetScale() Sets the scaling factor.
Definition: view.h:250
VECTOR2D m_center
Center point of the VIEW (the point at which we are looking at)
Definition: view.h:822
void KIGFX::VIEW::SetScale ( double  aScale,
const VECTOR2D aAnchor 
)
inherited

Function SetScale() Sets the scaling factor, zooming around a given anchor point.

(depending on correct GAL unit length & DPI settings).

Parameters
aAnchorthe zooming anchor point
aScalethe scale factor

Definition at line 567 of file view.cpp.

References KIGFX::GAL::ComputeWorldScreenMatrix(), delta, KIGFX::VIEW::m_center, KIGFX::VIEW::m_gal, KIGFX::VIEW::m_maxScale, KIGFX::VIEW::m_minScale, KIGFX::VIEW::m_scale, KIGFX::VIEW::MarkDirty(), KIGFX::VIEW::SetCenter(), KIGFX::GAL::SetZoomFactor(), KIGFX::VIEW::ToScreen(), and KIGFX::VIEW::ToWorld().

568 {
569  VECTOR2D a = ToScreen( aAnchor );
570 
571  if( aScale < m_minScale )
573  else if( aScale > m_maxScale )
575  else
576  m_scale = aScale;
577 
580 
581  VECTOR2D delta = ToWorld( a ) - aAnchor;
582 
583  SetCenter( m_center - delta );
584 
585  // Redraw everything after the viewport has changed
586  MarkDirty();
587 }
VECTOR2D ToWorld(const VECTOR2D &aCoord, bool aAbsolute=true) const
Function ToWorld() Converts a screen space point/vector to a point/vector in world space coordinates...
Definition: view.cpp:464
GAL * m_gal
Gives interface to PAINTER, that is used to draw items.
Definition: view.h:846
virtual void ComputeWorldScreenMatrix()
Compute the world <-> screen transformation matrix.
static const int delta[8][2]
Definition: solve.cpp:112
VECTOR2D m_center
Center point of the VIEW (the point at which we are looking at)
Definition: view.h:822
double m_minScale
Scale lower limit.
Definition: view.h:831
void SetCenter(const VECTOR2D &aCenter)
Function SetCenter() Sets the center point of the VIEW (i.e.
Definition: view.cpp:590
double m_maxScale
Scale upper limit.
Definition: view.h:834
VECTOR2D ToScreen(const VECTOR2D &aCoord, bool aAbsolute=true) const
Function ToScreen() Converts a world space point/vector to a point/vector in screen space coordinates...
Definition: view.cpp:483
void SetZoomFactor(double aZoomFactor)
Set the zoom factor of the scene.
double m_scale
Scale of displayed VIEW_ITEMs.
Definition: view.h:825
void MarkDirty()
Function MarkDirty() Forces redraw of view on the next rendering.
Definition: view.h:621
void KIGFX::VIEW::SetScaleLimits ( double  aMaximum,
double  aMinimum 
)
inlineinherited

Function SetScaleLimits() Sets minimum and maximum values for scale.

Parameters
aMaximumis the maximum value for scale.
aMinimumis the minimum value for scale.

Definition at line 309 of file view.h.

References KIGFX::VIEW::m_maxScale, KIGFX::VIEW::m_minScale, and KIGFX::VIEW::SetCenter().

Referenced by SCH_PREVIEW_PANEL::SCH_PREVIEW_PANEL().

310  {
311  wxASSERT_MSG( aMaximum > aMinimum, wxT( "I guess you passed parameters in wrong order" ) );
312 
313  m_minScale = aMinimum;
314  m_maxScale = aMaximum;
315  }
double m_minScale
Scale lower limit.
Definition: view.h:831
double m_maxScale
Scale upper limit.
Definition: view.h:834
void KIGFX::VIEW::SetTopLayer ( int  aLayer,
bool  aEnabled = true 
)
virtualinherited

Function SetTopLayer() Sets given layer to be displayed on the top or sets back the default order of layers.

Parameters
aEnabled= true to display aLayer on the top.
aLayerthe layer or -1 in case when no particular layer should be displayed on the top.

Definition at line 848 of file view.cpp.

References KIGFX::VIEW::m_enableOrderModifier, KIGFX::VIEW::m_layers, KIGFX::VIEW::m_topLayers, and KIGFX::VIEW::TOP_LAYER_MODIFIER.

Referenced by DIALOG_PAD_PROPERTIES::redraw(), KIGFX::VIEW::SetLayerTarget(), GERBVIEW_DRAW_PANEL_GAL::SetTopLayer(), PCB_DRAW_PANEL_GAL::SetTopLayer(), and EDA_DRAW_PANEL_GAL::SetTopLayer().

849 {
850  if( aEnabled )
851  {
852  if( m_topLayers.count( aLayer ) == 1 )
853  return;
854 
855  m_topLayers.insert( aLayer );
856 
857  // Move the layer closer to front
859  m_layers[aLayer].renderingOrder += TOP_LAYER_MODIFIER;
860  }
861  else
862  {
863  if( m_topLayers.count( aLayer ) == 0 )
864  return;
865 
866  m_topLayers.erase( aLayer );
867 
868  // Restore the previous rendering order
870  m_layers[aLayer].renderingOrder -= TOP_LAYER_MODIFIER;
871  }
872 }
static const int TOP_LAYER_MODIFIER
Rendering order modifier for layers that are marked as top layers.
Definition: view.h:856
std::set< unsigned int > m_topLayers
Stores set of layers that are displayed on the top.
Definition: view.h:819
bool m_enableOrderModifier
Definition: view.h:807
LAYER_MAP m_layers
Contains set of possible displayed layers and its properties.
Definition: view.h:810
void KIGFX::VIEW::SetViewport ( const BOX2D aViewport)
inherited

Function SetViewport() Sets the visible area of the VIEW.

Parameters
aViewportdesired visible area, in world space coordinates.

Definition at line 539 of file view.cpp.

References BOX2< Vec >::Centre(), KIGFX::VIEW::GetScale(), KIGFX::GAL::GetScreenPixelSize(), BOX2< Vec >::GetSize(), KIGFX::VIEW::m_gal, max, KIGFX::VIEW::SetCenter(), KIGFX::VIEW::SetScale(), KIGFX::VIEW::ToWorld(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by KIGFX::VIEW::GetPainter(), DIALOG_PAD_PROPERTIES::redraw(), and FOOTPRINT_PREVIEW_PANEL::renderFootprint().

540 {
541  VECTOR2D ssize = ToWorld( m_gal->GetScreenPixelSize(), false );
542 
543  wxCHECK( ssize.x > 0 && ssize.y > 0, /*void*/ );
544 
545  VECTOR2D centre = aViewport.Centre();
546  VECTOR2D vsize = aViewport.GetSize();
547  double zoom = 1.0 / std::max( fabs( vsize.x / ssize.x ), fabs( vsize.y / ssize.y ) );
548 
549  SetCenter( centre );
550  SetScale( GetScale() * zoom );
551 }
VECTOR2D ToWorld(const VECTOR2D &aCoord, bool aAbsolute=true) const
Function ToWorld() Converts a screen space point/vector to a point/vector in world space coordinates...
Definition: view.cpp:464
GAL * m_gal
Gives interface to PAINTER, that is used to draw items.
Definition: view.h:846
const Vec & GetSize() const
Definition: box2.h:187
void SetScale(double aScale)
Function SetScale() Sets the scaling factor.
Definition: view.h:250
void SetCenter(const VECTOR2D &aCenter)
Function SetCenter() Sets the center point of the VIEW (i.e.
Definition: view.cpp:590
Vec Centre() const
Definition: box2.h:77
const VECTOR2I & GetScreenPixelSize() const
Returns GAL canvas size in pixels.
#define max(a, b)
Definition: auxiliary.h:86
double GetScale() const
Function GetScale()
Definition: view.h:268
void KIGFX::VIEW::SetVisible ( VIEW_ITEM aItem,
bool  aIsVisible = true 
)
inherited

Sets the item visibility.

Parameters
aItemthe item to modify.
aIsVisiblewhether the item is visible (on all layers), or not.

Definition at line 1467 of file view.cpp.

References KIGFX::APPEARANCE, KIGFX::COLOR, KIGFX::VIEW_ITEM_DATA::m_flags, KIGFX::VIEW::Update(), KIGFX::VIEW_ITEM::viewPrivData(), and KIGFX::VISIBLE.

Referenced by KIGFX::VIEW::Add(), AddToPreview(), GRID_HELPER::BestSnapAnchor(), MICROWAVE_TOOL::drawMicrowaveInductor(), DrawMovingBlockOutlines(), GRID_HELPER::GRID_HELPER(), EDIT_TOOL::MeasureTool(), ZONE_CREATE_HELPER::OnComplete(), ZONE_CREATE_HELPER::OnFirstPoint(), FOOTPRINT_PREVIEW_PANEL::renderFootprint(), GERBVIEW_SELECTION_TOOL::selectMultiple(), SELECTION_TOOL::selectMultiple(), GRID_HELPER::SetAuxAxes(), ShowPreview(), ShowSelectionArea(), and ZONE_CREATE_HELPER::~ZONE_CREATE_HELPER().

1468 {
1469  auto viewData = aItem->viewPrivData();
1470 
1471  if( !viewData )
1472  return;
1473 
1474  bool cur_visible = viewData->m_flags & VISIBLE;
1475 
1476  if( cur_visible != aIsVisible )
1477  {
1478  if( aIsVisible )
1479  viewData->m_flags |= VISIBLE;
1480  else
1481  viewData->m_flags &= ~VISIBLE;
1482 
1483  Update( aItem, APPEARANCE | COLOR );
1484  }
1485 }
No updates are required.
Definition: view_item.h:55
Visibility flag has changed.
Definition: view_item.h:56
virtual void Update(VIEW_ITEM *aItem, int aUpdateFlags)
For dynamic VIEWs, informs the associated VIEW that the graphical representation of this item has cha...
Definition: view.cpp:1521
void KIGFX::SCH_VIEW::ShowPreview ( bool  aShow = true)

Definition at line 135 of file sch_view.cpp.

References m_preview, and KIGFX::VIEW::SetVisible().

Referenced by SCH_EDIT_FRAME::OnCancelCurrentCommand().

136 {
137  SetVisible( m_preview.get(), aShow );
138 }
void SetVisible(VIEW_ITEM *aItem, bool aIsVisible=true)
Sets the item visibility.
Definition: view.cpp:1467
std::unique_ptr< KIGFX::VIEW_GROUP > m_preview
Definition: sch_view.h:94
void KIGFX::SCH_VIEW::ShowSelectionArea ( bool  aShow = true)

Definition at line 121 of file sch_view.cpp.

References m_selectionArea, and KIGFX::VIEW::SetVisible().

Referenced by SCH_BASE_FRAME::HandleBlockBegin(), and SCH_EDIT_FRAME::HandleBlockEnd().

122 {
123  if( aShow )
124  {
125  // Reset seleciton area so the previous one doesn't flash before the first
126  // mouse move updates it
127  m_selectionArea->SetOrigin( VECTOR2I() );
128  m_selectionArea->SetEnd( VECTOR2I() );
129  }
130 
131  SetVisible( m_selectionArea.get(), aShow );
132 }
VECTOR2< int > VECTOR2I
Definition: vector2d.h:587
std::unique_ptr< KIGFX::PREVIEW::SELECTION_AREA > m_selectionArea
Definition: sch_view.h:93
void SetVisible(VIEW_ITEM *aItem, bool aIsVisible=true)
Sets the item visibility.
Definition: view.cpp:1467
void KIGFX::VIEW::SortLayers ( int  aLayers[],
int &  aCount 
) const
inherited

Function SortLayers() Changes the order of given layer ids, so after sorting the order corresponds to layers rendering order (descending, ie.

order in which layers should be drawn - from the bottom to the top).

Parameters
aLayersstores id of layers to be sorted.
aCountstores the number of layers.

Definition at line 666 of file view.cpp.

References KIGFX::VIEW::GetLayerOrder(), and i.

Referenced by KIGFX::VIEW::draw(), KIGFX::VIEW::SetLayerTarget(), and KIGFX::VIEW_GROUP::ViewDraw().

667 {
668  int maxLay, maxOrd, maxIdx;
669 
670  for( int i = 0; i < aCount; ++i )
671  {
672  maxLay = aLayers[i];
673  maxOrd = GetLayerOrder( maxLay );
674  maxIdx = i;
675 
676  // Look for the max element in the range (j..aCount)
677  for( int j = i; j < aCount; ++j )
678  {
679  if( maxOrd < GetLayerOrder( aLayers[j] ) )
680  {
681  maxLay = aLayers[j];
682  maxOrd = GetLayerOrder( maxLay );
683  maxIdx = j;
684  }
685  }
686 
687  // Swap elements
688  aLayers[maxIdx] = aLayers[i];
689  aLayers[i] = maxLay;
690  }
691 }
int GetLayerOrder(int aLayer) const
Function GetLayerOrder() Returns rendering order of a particular layer.
Definition: view.cpp:660
size_t i
Definition: json11.cpp:597
void KIGFX::VIEW::sortLayers ( )
protectedinherited
  • Sorts m_orderedLayers when layer rendering order has changed

Definition at line 1242 of file view.cpp.

References KIGFX::VIEW::compareRenderingOrder(), i, KIGFX::VIEW::m_layers, KIGFX::VIEW::m_orderedLayers, and KIGFX::VIEW::MarkDirty().

Referenced by KIGFX::VIEW::markTargetClean(), KIGFX::VIEW::SetLayerOrder(), KIGFX::VIEW::UpdateAllLayersOrder(), and KIGFX::VIEW::VIEW().

1243 {
1244  int n = 0;
1245 
1246  m_orderedLayers.resize( m_layers.size() );
1247 
1248  for( LAYER_MAP_ITER i = m_layers.begin(); i != m_layers.end(); ++i )
1249  m_orderedLayers[n++] = &i->second;
1250 
1251  sort( m_orderedLayers.begin(), m_orderedLayers.end(), compareRenderingOrder );
1252 
1253  MarkDirty();
1254 }
LAYER_ORDER m_orderedLayers
Sorted list of pointers to members of m_layers.
Definition: view.h:816
LAYER_MAP::iterator LAYER_MAP_ITER
Definition: view.h:715
size_t i
Definition: json11.cpp:597
LAYER_MAP m_layers
Contains set of possible displayed layers and its properties.
Definition: view.h:810
static bool compareRenderingOrder(VIEW_LAYER *aI, VIEW_LAYER *aJ)
Determines rendering order of layers. Used in display order sorting function.
Definition: view.h:798
void MarkDirty()
Function MarkDirty() Forces redraw of view on the next rendering.
Definition: view.h:621
VECTOR2D KIGFX::VIEW::ToScreen ( const VECTOR2D aCoord,
bool  aAbsolute = true 
) const
inherited

Function ToScreen() Converts a world space point/vector to a point/vector in screen space coordinates.

Parameters
aCoordthe point/vector to be converted
aAbsolutewhen true, aCoord is treated as a point, otherwise - as a direction (vector)

Definition at line 483 of file view.cpp.

References MATRIX3x3< T >::GetScale(), KIGFX::GAL::GetWorldScreenMatrix(), KIGFX::VIEW::m_gal, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by KIGFX::VIEW::GetCenter(), TOOL_DISPATCHER::handleMouseButton(), KIGFX::WX_VIEW_CONTROLS::SetCrossHairCursorPosition(), KIGFX::VIEW::SetScale(), and KIGFX::WX_VIEW_CONTROLS::WarpCursor().

484 {
485  const MATRIX3x3D& matrix = m_gal->GetWorldScreenMatrix();
486 
487  if( aAbsolute )
488  return VECTOR2D( matrix * aCoord );
489  else
490  return VECTOR2D( matrix.GetScale().x * aCoord.x, matrix.GetScale().y * aCoord.y );
491 }
GAL * m_gal
Gives interface to PAINTER, that is used to draw items.
Definition: view.h:846
const MATRIX3x3D & GetWorldScreenMatrix() const
Get the world <-> screen transformation matrix.
VECTOR2< double > VECTOR2D
Definition: vector2d.h:586
VECTOR2< T > GetScale() const
Get the scale components of the matrix.
Definition: matrix3x3.h:269
double KIGFX::VIEW::ToScreen ( double  aSize) const
inherited

Function ToScreen() Converts a world space one dimensionsal size to a one dimensional size in screen space.

Parameters
aSizethe size to be transformed.

Definition at line 494 of file view.cpp.

References MATRIX3x3< T >::GetScale(), KIGFX::GAL::GetWorldScreenMatrix(), KIGFX::VIEW::m_gal, and VECTOR2< T >::x.

495 {
496  const MATRIX3x3D& matrix = m_gal->GetWorldScreenMatrix();
497 
498  return matrix.GetScale().x * aSize;
499 }
GAL * m_gal
Gives interface to PAINTER, that is used to draw items.
Definition: view.h:846
const MATRIX3x3D & GetWorldScreenMatrix() const
Get the world <-> screen transformation matrix.
VECTOR2< T > GetScale() const
Get the scale components of the matrix.
Definition: matrix3x3.h:269
VECTOR2D KIGFX::VIEW::ToWorld ( const VECTOR2D aCoord,
bool  aAbsolute = true 
) const
inherited

Function ToWorld() Converts a screen space point/vector to a point/vector in world space coordinates.

Parameters
aCoordthe point/vector to be converted
aAbsolutewhen true, aCoord is treated as a point, otherwise - as a direction (vector)

Definition at line 464 of file view.cpp.

References MATRIX3x3< T >::GetScale(), KIGFX::GAL::GetScreenWorldMatrix(), KIGFX::VIEW::m_gal, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by COMMON_TOOLS::CenterContents(), EDIT_POINTS::FindPoint(), SYMBOL_PREVIEW_WIDGET::fitOnDrawArea(), KIGFX::VIEW::GetCenter(), KIGFX::WX_VIEW_CONTROLS::GetMousePosition(), KIGFX::VIEW::GetViewport(), KIGFX::WX_VIEW_CONTROLS::onMotion(), KIGFX::WX_VIEW_CONTROLS::onScroll(), KIGFX::WX_VIEW_CONTROLS::onTimer(), KIGFX::WX_VIEW_CONTROLS::onWheel(), KIGFX::VIEW::Redraw(), KIGFX::WX_VIEW_CONTROLS::refreshMouse(), GERBVIEW_SELECTION_TOOL::selectionContains(), SELECTION_TOOL::selectionContains(), KIGFX::VIEW::SetCenter(), KIGFX::VIEW::SetScale(), KIGFX::VIEW::SetViewport(), KIGFX::ORIGIN_VIEWITEM::ViewDraw(), EDIT_POINTS::ViewDraw(), SCH_BASE_FRAME::Window_Zoom(), SCH_BASE_FRAME::Zoom_Automatique(), COMMON_TOOLS::ZoomFitScreen(), and SELECTION_TOOL::zoomFitSelection().

465 {
466  const MATRIX3x3D& matrix = m_gal->GetScreenWorldMatrix();
467 
468  if( aAbsolute )
469  return VECTOR2D( matrix * aCoord );
470  else
471  return VECTOR2D( matrix.GetScale().x * aCoord.x, matrix.GetScale().y * aCoord.y );
472 }
const MATRIX3x3D & GetScreenWorldMatrix() const
Get the screen <-> world transformation matrix.
GAL * m_gal
Gives interface to PAINTER, that is used to draw items.
Definition: view.h:846
VECTOR2< double > VECTOR2D
Definition: vector2d.h:586
VECTOR2< T > GetScale() const
Get the scale components of the matrix.
Definition: matrix3x3.h:269
double KIGFX::VIEW::ToWorld ( double  aSize) const
inherited

Function ToWorld() Converts a screen space one dimensional size to a one dimensional size in world space coordinates.

Parameters
aSize: the size to be converted

Definition at line 475 of file view.cpp.

References MATRIX3x3< T >::GetScale(), KIGFX::GAL::GetScreenWorldMatrix(), KIGFX::VIEW::m_gal, and VECTOR2< T >::x.

476 {
477  const MATRIX3x3D& matrix = m_gal->GetScreenWorldMatrix();
478 
479  return fabs( matrix.GetScale().x * aSize );
480 }
const MATRIX3x3D & GetScreenWorldMatrix() const
Get the screen <-> world transformation matrix.
GAL * m_gal
Gives interface to PAINTER, that is used to draw items.
Definition: view.h:846
VECTOR2< T > GetScale() const
Get the scale components of the matrix.
Definition: matrix3x3.h:269
void KIGFX::VIEW::Update ( VIEW_ITEM aItem,
int  aUpdateFlags 
)
virtualinherited

For dynamic VIEWs, informs the associated VIEW that the graphical representation of this item has changed.

For static views calling has no effect.

Parameters
aItemthe item to update.
aUpdateFlagshow much the object has changed.

Reimplemented in KIGFX::PCB_VIEW.

Definition at line 1521 of file view.cpp.

References KIGFX::NONE, and KIGFX::VIEW_ITEM::viewPrivData().

Referenced by KIGFX::VIEW::Add(), AddToPreview(), GRID_HELPER::BestSnapAnchor(), ClearPreview(), KIGFX::VIEW::draw(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), DrawMovingBlockOutlines(), DRAWING_TOOL::drawSegment(), PCB_EDIT_FRAME::Edit_Zone_Params(), LIB_EDIT_FRAME::EditField(), LIB_EDIT_FRAME::EditGraphicSymbol(), SCH_EDIT_FRAME::EditSheet(), LIB_EDIT_FRAME::EditSymbolText(), MODULE_EDITOR_TOOLS::EnumeratePads(), SCH_EDIT_FRAME::HandleBlockPlace(), KIGFX::VIEW::Hide(), SCH_EDIT_FRAME::MirrorSheet(), EDIT_TOOL::MoveExact(), LIB_EDIT_FRAME::OnEditPin(), SCH_EDIT_FRAME::OnFindReplace(), ZONE_CREATE_HELPER::OnGeometryChange(), LIB_EDIT_FRAME::OnOrient(), LIB_EDIT_FRAME::OnRotate(), DIALOG_UPDATE_PCB::PerformUpdate(), DRAWING_TOOL::PlaceDXF(), PCB_EDITOR_CONTROL::PlaceModule(), DRAWING_TOOL::PlaceText(), processBoardItem(), BOARD_COMMIT::Push(), PCB_EDIT_FRAME::ReadPcbNetlist(), DIALOG_PAD_PROPERTIES::redraw(), PCB_DRAW_PANEL_GAL::RedrawRatsnest(), SCH_BASE_FRAME::RefreshItem(), FOOTPRINT_PREVIEW_PANEL::renderFootprint(), SCH_EDIT_FRAME::RotateHierarchicalSheet(), GERBVIEW_SELECTION_TOOL::selectMultiple(), SELECTION_TOOL::selectMultiple(), GERBVIEW_SELECTION_TOOL::selectVisually(), KIGFX::VIEW::SetVisible(), SCH_EDIT_FRAME::TestDanglingEnds(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataFromWindow(), GERBVIEW_SELECTION_TOOL::unselectVisually(), KIGFX::PCB_VIEW::Update(), KIGFX::VIEW::Update(), POINT_EDITOR::updatePoints(), and SELECTION_TOOL::updateSelection().

1522 {
1523  auto viewData = aItem->viewPrivData();
1524 
1525  if( !viewData )
1526  return;
1527 
1528  assert( aUpdateFlags != NONE );
1529 
1530  viewData->m_requiredUpdate |= aUpdateFlags;
1531 
1532 }
void KIGFX::VIEW::Update ( VIEW_ITEM aItem)
virtualinherited

Reimplemented in KIGFX::PCB_VIEW.

Definition at line 1515 of file view.cpp.

References KIGFX::ALL, and KIGFX::VIEW::Update().

1516 {
1517  Update( aItem, ALL );
1518 }
Item needs to be redrawn.
Definition: view_item.h:61
virtual void Update(VIEW_ITEM *aItem, int aUpdateFlags)
For dynamic VIEWs, informs the associated VIEW that the graphical representation of this item has cha...
Definition: view.cpp:1521
void KIGFX::VIEW::UpdateAllItems ( int  aUpdateFlags)
inherited

Updates all items in the view according to the given flags.

Parameters
aUpdateFlagsis is according to KIGFX::VIEW_UPDATE_FLAGS

Definition at line 1425 of file view.cpp.

References KIGFX::VIEW::m_allItems.

Referenced by FOOTPRINT_VIEWER_FRAME::ApplyDisplaySettingsToGAL(), DISPLAY_FOOTPRINTS_FRAME::ApplyDisplaySettingsToGAL(), GERBVIEW_CONTROL::HighlightControl(), SCH_EDIT_FRAME::KiwayMailIn(), KIGFX::VIEW::MarkDirty(), GERBVIEW_FRAME::OnSelectHighlightChoice(), SCH_EDIT_FRAME::OnSelectOptionToolbar(), LIB_EDIT_FRAME::OnShowElectricalType(), SCH_EDIT_FRAME::PutDataInPreviousState(), and SCH_BASE_FRAME::SyncView().

1426 {
1427  for( VIEW_ITEM* item : *m_allItems )
1428  {
1429  auto viewData = item->viewPrivData();
1430 
1431  if( !viewData )
1432  continue;
1433 
1434  viewData->m_requiredUpdate |= aUpdateFlags;
1435  }
1436 }
friend class VIEW_ITEM
Definition: view.h:64
std::shared_ptr< std::vector< VIEW_ITEM * > > m_allItems
Flat list of all items.
Definition: view.h:813
void KIGFX::VIEW::UpdateAllItemsConditionally ( int  aUpdateFlags,
std::function< bool(VIEW_ITEM *)>  aCondition 
)
inherited

Updates items in the view according to the given flags and condition.

Parameters
aUpdateFlagsis is according to KIGFX::VIEW_UPDATE_FLAGS
aConditionis a function returning true if the item should be updated

Definition at line 1439 of file view.cpp.

References KIGFX::VIEW::m_allItems.

Referenced by KIGFX::VIEW::MarkDirty(), GERBVIEW_FRAME::SetElementVisibility(), and GERBVIEW_FRAME::UpdateDisplayOptions().

1441 {
1442  for( VIEW_ITEM* item : *m_allItems )
1443  {
1444  if( aCondition( item ) )
1445  {
1446  auto viewData = item->viewPrivData();
1447 
1448  if( !viewData )
1449  continue;
1450 
1451  viewData->m_requiredUpdate |= aUpdateFlags;
1452  }
1453  }
1454 }
friend class VIEW_ITEM
Definition: view.h:64
std::shared_ptr< std::vector< VIEW_ITEM * > > m_allItems
Flat list of all items.
Definition: view.h:813
void KIGFX::VIEW::UpdateAllLayersColor ( )
inherited

Function UpdateAllLayersColor() Applies the new coloring scheme to all layers.

The used scheme is held by RENDER_SETTINGS.

See also
RENDER_SETTINGS

Definition at line 786 of file view.cpp.

References KIGFX::GAL::ChangeGroupColor(), color, KIGFX::RENDER_SETTINGS::GetColor(), KIGFX::PAINTER::GetSettings(), i, KIGFX::GAL::IsVisible(), KIGFX::VIEW::m_allItems, KIGFX::VIEW::m_gal, KIGFX::VIEW::m_painter, KIGFX::VIEW::MarkDirty(), and KIGFX::VIEW::VIEW_MAX_LAYERS.

Referenced by PCB_EDITOR_CONTROL::ClearHighlight(), KIGFX::VIEW::EnableTopLayer(), PNS::TOOL_BASE::highlightNet(), PCB_EDITOR_CONTROL::HighlightNet(), highlightNet(), GERBVIEW_DRAW_PANEL_GAL::SetHighContrastLayer(), PCB_DRAW_PANEL_GAL::SetHighContrastLayer(), EDA_DRAW_PANEL_GAL::SetHighContrastLayer(), and KIGFX::VIEW::SetLayerTarget().

787 {
788  if( m_gal->IsVisible() )
789  {
790  GAL_UPDATE_CONTEXT ctx( m_gal );
791 
792  for( VIEW_ITEM* item : *m_allItems )
793  {
794  auto viewData = item->viewPrivData();
795 
796  if( !viewData )
797  continue;
798 
799  int layers[VIEW::VIEW_MAX_LAYERS], layers_count;
800  viewData->getLayers( layers, layers_count );
801 
802  for( int i = 0; i < layers_count; ++i )
803  {
804  const COLOR4D color = m_painter->GetSettings()->GetColor( item, layers[i] );
805  int group = viewData->getGroup( layers[i] );
806 
807  if( group >= 0 )
808  m_gal->ChangeGroupColor( group, color );
809  }
810  }
811  }
812 
813  MarkDirty();
814 }
friend class VIEW_ITEM
Definition: view.h:64
int color
Definition: DXF_plotter.cpp:62
GAL * m_gal
Gives interface to PAINTER, that is used to draw items.
Definition: view.h:846
virtual bool IsVisible() const
Returns true if the GAL canvas is visible on the screen.
static constexpr int VIEW_MAX_LAYERS
maximum number of layers that may be shown
Definition: view.h:699
virtual const COLOR4D & GetColor(const VIEW_ITEM *aItem, int aLayer) const =0
Function GetColor Returns the color that should be used to draw the specific VIEW_ITEM on the specifi...
std::shared_ptr< std::vector< VIEW_ITEM * > > m_allItems
Flat list of all items.
Definition: view.h:813
virtual void ChangeGroupColor(int aGroupNumber, const COLOR4D &aNewColor)
Changes the color used to draw the group.
PAINTER * m_painter
PAINTER contains information how do draw items.
Definition: view.h:843
virtual RENDER_SETTINGS * GetSettings()=0
Function GetSettings Returns pointer to current settings that are going to be used when drawing items...
size_t i
Definition: json11.cpp:597
void MarkDirty()
Function MarkDirty() Forces redraw of view on the next rendering.
Definition: view.h:621
Class COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:39
void KIGFX::VIEW::UpdateAllLayersOrder ( )
inherited

Function UpdateLayerOrder() Does everything that is needed to apply the rendering order of layers.

It has to be called after modification of renderingOrder field of LAYER.

Definition at line 915 of file view.cpp.

References KIGFX::GAL::ChangeGroupDepth(), i, KIGFX::GAL::IsVisible(), KIGFX::VIEW::m_allItems, KIGFX::VIEW::m_gal, KIGFX::VIEW::m_layers, KIGFX::VIEW::MarkDirty(), KIGFX::VIEW::sortLayers(), and KIGFX::VIEW::VIEW_MAX_LAYERS.

Referenced by KIGFX::VIEW::EnableTopLayer(), SCH_PREVIEW_PANEL::SCH_PREVIEW_PANEL(), KIGFX::VIEW::SetLayerTarget(), GERBVIEW_DRAW_PANEL_GAL::SetTopLayer(), PCB_DRAW_PANEL_GAL::SetTopLayer(), and EDA_DRAW_PANEL_GAL::SetTopLayer().

916 {
917  sortLayers();
918 
919  if( m_gal->IsVisible() )
920  {
921  GAL_UPDATE_CONTEXT ctx( m_gal );
922 
923  for( VIEW_ITEM* item : *m_allItems )
924  {
925  auto viewData = item->viewPrivData();
926 
927  if( !viewData )
928  continue;
929 
930  int layers[VIEW::VIEW_MAX_LAYERS], layers_count;
931  viewData->getLayers( layers, layers_count );
932 
933  for( int i = 0; i < layers_count; ++i )
934  {
935  int group = viewData->getGroup( layers[i] );
936 
937  if( group >= 0 )
938  m_gal->ChangeGroupDepth( group, m_layers[layers[i]].renderingOrder );
939  }
940  }
941  }
942 
943  MarkDirty();
944 }
void sortLayers()
Definition: view.cpp:1242
friend class VIEW_ITEM
Definition: view.h:64
GAL * m_gal
Gives interface to PAINTER, that is used to draw items.
Definition: view.h:846
virtual bool IsVisible() const
Returns true if the GAL canvas is visible on the screen.
static constexpr int VIEW_MAX_LAYERS
maximum number of layers that may be shown
Definition: view.h:699
std::shared_ptr< std::vector< VIEW_ITEM * > > m_allItems
Flat list of all items.
Definition: view.h:813
size_t i
Definition: json11.cpp:597
virtual void ChangeGroupDepth(int aGroupNumber, int aDepth)
Changes the depth (Z-axis position) of the group.
LAYER_MAP m_layers
Contains set of possible displayed layers and its properties.
Definition: view.h:810
void MarkDirty()
Function MarkDirty() Forces redraw of view on the next rendering.
Definition: view.h:621
void KIGFX::VIEW::updateBbox ( VIEW_ITEM aItem)
protectedinherited

Updates bounding box of an item.

Definition at line 1306 of file view.cpp.

References i, KIGFX::VIEW::VIEW_LAYER::items, KIGFX::VIEW::m_layers, KIGFX::VIEW::MarkTargetDirty(), KIGFX::VIEW::VIEW_LAYER::target, KIGFX::VIEW::VIEW_MAX_LAYERS, and KIGFX::VIEW_ITEM::ViewGetLayers().

Referenced by KIGFX::VIEW::invalidateItem(), and KIGFX::VIEW::markTargetClean().

1307 {
1308  int layers[VIEW_MAX_LAYERS], layers_count;
1309 
1310  aItem->ViewGetLayers( layers, layers_count );
1311 
1312  for( int i = 0; i < layers_count; ++i )
1313  {
1314  VIEW_LAYER& l = m_layers[layers[i]];
1315  l.items->Remove( aItem );
1316  l.items->Insert( aItem );
1317  MarkTargetDirty( l.target );
1318  }
1319 }
static constexpr int VIEW_MAX_LAYERS
maximum number of layers that may be shown
Definition: view.h:699
void MarkTargetDirty(int aTarget)
Function MarkTargetDirty() Sets or clears target &#39;dirty&#39; flag.
Definition: view.h:596
size_t i
Definition: json11.cpp:597
LAYER_MAP m_layers
Contains set of possible displayed layers and its properties.
Definition: view.h:810
void KIGFX::VIEW::updateItemColor ( VIEW_ITEM aItem,
int  aLayer 
)
protectedinherited

Updates colors that are used for an item to be drawn.

Definition at line 1257 of file view.cpp.

References KIGFX::GAL::ChangeGroupColor(), color, KIGFX::RENDER_SETTINGS::GetColor(), KIGFX::PAINTER::GetSettings(), KIGFX::VIEW::IsCached(), KIGFX::VIEW::m_gal, KIGFX::VIEW::m_layers, KIGFX::VIEW::m_painter, and KIGFX::VIEW_ITEM::viewPrivData().

Referenced by KIGFX::VIEW::invalidateItem(), and KIGFX::VIEW::markTargetClean().

1258 {
1259  auto viewData = aItem->viewPrivData();
1260  wxCHECK( (unsigned) aLayer < m_layers.size(), /*void*/ );
1261  wxCHECK( IsCached( aLayer ), /*void*/ );
1262 
1263  if( !viewData )
1264  return;
1265 
1266  // Obtain the color that should be used for coloring the item on the specific layerId
1267  const COLOR4D color = m_painter->GetSettings()->GetColor( aItem, aLayer );
1268  int group = viewData->getGroup( aLayer );
1269 
1270  // Change the color, only if it has group assigned
1271  if( group >= 0 )
1272  m_gal->ChangeGroupColor( group, color );
1273 }
int color
Definition: DXF_plotter.cpp:62
GAL * m_gal
Gives interface to PAINTER, that is used to draw items.
Definition: view.h:846
virtual const COLOR4D & GetColor(const VIEW_ITEM *aItem, int aLayer) const =0
Function GetColor Returns the color that should be used to draw the specific VIEW_ITEM on the specifi...
virtual void ChangeGroupColor(int aGroupNumber, const COLOR4D &aNewColor)
Changes the color used to draw the group.
PAINTER * m_painter
PAINTER contains information how do draw items.
Definition: view.h:843
virtual RENDER_SETTINGS * GetSettings()=0
Function GetSettings Returns pointer to current settings that are going to be used when drawing items...
bool IsCached(int aLayer) const
Returns true if the layer is cached.
Definition: view.h:603
LAYER_MAP m_layers
Contains set of possible displayed layers and its properties.
Definition: view.h:810
Class COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:39
void KIGFX::VIEW::updateItemGeometry ( VIEW_ITEM aItem,
int  aLayer 
)
protectedinherited

Updates all informations needed to draw an item.

Definition at line 1276 of file view.cpp.

References KIGFX::GAL::BeginGroup(), KIGFX::GAL::DeleteGroup(), KIGFX::PAINTER::Draw(), KIGFX::GAL::EndGroup(), KIGFX::VIEW::IsCached(), KIGFX::VIEW::m_gal, KIGFX::VIEW::m_layers, KIGFX::VIEW::m_painter, KIGFX::VIEW::VIEW_LAYER::renderingOrder, KIGFX::GAL::SetLayerDepth(), KIGFX::GAL::SetTarget(), KIGFX::VIEW::VIEW_LAYER::target, KIGFX::VIEW_ITEM::ViewDraw(), and KIGFX::VIEW_ITEM::viewPrivData().

Referenced by KIGFX::VIEW::invalidateItem(), and KIGFX::VIEW::markTargetClean().

1277 {
1278  auto viewData = aItem->viewPrivData();
1279  wxCHECK( (unsigned) aLayer < m_layers.size(), /*void*/ );
1280  wxCHECK( IsCached( aLayer ), /*void*/ );
1281 
1282  if( !viewData )
1283  return;
1284 
1285  VIEW_LAYER& l = m_layers.at( aLayer );
1286 
1287  m_gal->SetTarget( l.target );
1288  m_gal->SetLayerDepth( l.renderingOrder );
1289 
1290  // Redraw the item from scratch
1291  int group = viewData->getGroup( aLayer );
1292 
1293  if( group >= 0 )
1294  m_gal->DeleteGroup( group );
1295 
1296  group = m_gal->BeginGroup();
1297  viewData->setGroup( aLayer, group );
1298 
1299  if( !m_painter->Draw( static_cast<EDA_ITEM*>( aItem ), aLayer ) )
1300  aItem->ViewDraw( aLayer, this ); // Alternative drawing method
1301 
1302  m_gal->EndGroup();
1303 }
virtual void DeleteGroup(int aGroupNumber)
Delete the group from the memory.
GAL * m_gal
Gives interface to PAINTER, that is used to draw items.
Definition: view.h:846
virtual void SetLayerDepth(double aLayerDepth)
Set the depth of the layer (position on the z-axis)
virtual void EndGroup()
End the group.
virtual int BeginGroup()
Begin a group.
PAINTER * m_painter
PAINTER contains information how do draw items.
Definition: view.h:843
virtual bool Draw(const VIEW_ITEM *aItem, int aLayer)=0
Function Draw Takes an instance of VIEW_ITEM and passes it to a function that know how to draw the it...
bool IsCached(int aLayer) const
Returns true if the layer is cached.
Definition: view.h:603
LAYER_MAP m_layers
Contains set of possible displayed layers and its properties.
Definition: view.h:810
virtual void SetTarget(RENDER_TARGET aTarget)
Sets the target for rendering.
void KIGFX::VIEW::UpdateItems ( )
inherited

Function UpdateItems() Iterates through the list of items that asked for updating and updates them.

Definition at line 1402 of file view.cpp.

References KIGFX::VIEW::invalidateItem(), KIGFX::GAL::IsVisible(), KIGFX::VIEW::m_allItems, KIGFX::VIEW::m_gal, and KIGFX::NONE.

Referenced by KIGFX::VIEW::MarkDirty(), EDA_DRAW_PANEL_GAL::onPaint(), PCB_DRAW_PANEL_GAL::OnShow(), and KIGFX::VIEW::ReorderLayerData().

1403 {
1404  if( m_gal->IsVisible() )
1405  {
1406  GAL_UPDATE_CONTEXT ctx( m_gal );
1407 
1408  for( VIEW_ITEM* item : *m_allItems )
1409  {
1410  auto viewData = item->viewPrivData();
1411 
1412  if( !viewData )
1413  continue;
1414 
1415  if( viewData->m_requiredUpdate != NONE )
1416  {
1417  invalidateItem( item, viewData->m_requiredUpdate );
1418  viewData->m_requiredUpdate = NONE;
1419  }
1420  }
1421  }
1422 }
friend class VIEW_ITEM
Definition: view.h:64
GAL * m_gal
Gives interface to PAINTER, that is used to draw items.
Definition: view.h:846
virtual bool IsVisible() const
Returns true if the GAL canvas is visible on the screen.
std::shared_ptr< std::vector< VIEW_ITEM * > > m_allItems
Flat list of all items.
Definition: view.h:813
void invalidateItem(VIEW_ITEM *aItem, int aUpdateFlags)
Function invalidateItem() Manages dirty flags & redraw queueing when updating an item.
Definition: view.cpp:1197
void KIGFX::VIEW::UpdateLayerColor ( int  aLayer)
inherited

Function UpdateLayerColor() Applies the new coloring scheme held by RENDER_SETTINGS in case that it has changed.

Parameters
aLayeris a number of the layer to be updated.
See also
RENDER_SETTINGS

Definition at line 765 of file view.cpp.

References KIGFX::VIEW::IsCached(), KIGFX::GAL::IsVisible(), KIGFX::VIEW::m_gal, KIGFX::VIEW::m_layers, KIGFX::VIEW::m_painter, KIGFX::VIEW::MarkTargetDirty(), and BOX2< Vec >::SetMaximum().

Referenced by PCBNEW_CONTROL::LayerAlphaDec(), PCBNEW_CONTROL::LayerAlphaInc(), PCB_LAYER_WIDGET::OnLayerColorChange(), GERBER_LAYER_WIDGET::OnLayerColorChange(), PCB_LAYER_WIDGET::OnRenderColorChange(), and KIGFX::VIEW::SetLayerTarget().

766 {
767  // There is no point in updating non-cached layers
768  if( !IsCached( aLayer ) )
769  return;
770 
771  BOX2I r;
772 
773  r.SetMaximum();
774 
775  if( m_gal->IsVisible() )
776  {
777  GAL_UPDATE_CONTEXT ctx( m_gal );
778 
779  updateItemsColor visitor( aLayer, m_painter, m_gal );
780  m_layers[aLayer].items->Query( r, visitor );
781  MarkTargetDirty( m_layers[aLayer].target );
782  }
783 }
GAL * m_gal
Gives interface to PAINTER, that is used to draw items.
Definition: view.h:846
virtual bool IsVisible() const
Returns true if the GAL canvas is visible on the screen.
void MarkTargetDirty(int aTarget)
Function MarkTargetDirty() Sets or clears target &#39;dirty&#39; flag.
Definition: view.h:596
void SetMaximum()
Definition: box2.h:71
PAINTER * m_painter
PAINTER contains information how do draw items.
Definition: view.h:843
bool IsCached(int aLayer) const
Returns true if the layer is cached.
Definition: view.h:603
LAYER_MAP m_layers
Contains set of possible displayed layers and its properties.
Definition: view.h:810
void KIGFX::VIEW::updateLayers ( VIEW_ITEM aItem)
protectedinherited

Updates set of layers that an item occupies.

Definition at line 1322 of file view.cpp.

References KIGFX::GAL::DeleteGroup(), KIGFX::VIEW_ITEM_DATA::getLayers(), i, KIGFX::VIEW::VIEW_LAYER::id, KIGFX::VIEW::IsCached(), KIGFX::VIEW::VIEW_LAYER::items, KIGFX::VIEW::m_gal, KIGFX::VIEW::m_layers, KIGFX::VIEW::MarkTargetDirty(), KIGFX::VIEW::VIEW_LAYER::target, KIGFX::VIEW::VIEW_MAX_LAYERS, KIGFX::VIEW_ITEM::ViewGetLayers(), and KIGFX::VIEW_ITEM::viewPrivData().

Referenced by KIGFX::VIEW::invalidateItem(), and KIGFX::VIEW::markTargetClean().

1323 {
1324  auto viewData = aItem->viewPrivData();
1325  int layers[VIEW_MAX_LAYERS], layers_count;
1326 
1327  if( !viewData )
1328  return;
1329 
1330  // Remove the item from previous layer set
1331  viewData->getLayers( layers, layers_count );
1332 
1333  for( int i = 0; i < layers_count; ++i )
1334  {
1335  VIEW_LAYER& l = m_layers[layers[i]];
1336  l.items->Remove( aItem );
1337  MarkTargetDirty( l.target );
1338 
1339  if( IsCached( l.id ) )
1340  {
1341  // Redraw the item from scratch
1342  int prevGroup = viewData->getGroup( layers[i] );
1343 
1344  if( prevGroup >= 0 )
1345  {
1346  m_gal->DeleteGroup( prevGroup );
1347  viewData->setGroup( l.id, -1 );
1348  }
1349  }
1350  }
1351 
1352  // Add the item to new layer set
1353  aItem->ViewGetLayers( layers, layers_count );
1354  viewData->saveLayers( layers, layers_count );
1355 
1356  for( int i = 0; i < layers_count; i++ )
1357  {
1358  VIEW_LAYER& l = m_layers[layers[i]];
1359  l.items->Insert( aItem );
1360  MarkTargetDirty( l.target );
1361  }
1362 }
virtual void DeleteGroup(int aGroupNumber)
Delete the group from the memory.
GAL * m_gal
Gives interface to PAINTER, that is used to draw items.
Definition: view.h:846
static constexpr int VIEW_MAX_LAYERS
maximum number of layers that may be shown
Definition: view.h:699
void MarkTargetDirty(int aTarget)
Function MarkTargetDirty() Sets or clears target &#39;dirty&#39; flag.
Definition: view.h:596
bool IsCached(int aLayer) const
Returns true if the layer is cached.
Definition: view.h:603
size_t i
Definition: json11.cpp:597
LAYER_MAP m_layers
Contains set of possible displayed layers and its properties.
Definition: view.h:810
void KIGFX::VIEW::UseDrawPriority ( bool  aFlag)
inlineinherited

Function UseDrawPriority()

Parameters
aFlagis true if draw priority should be respected while redrawing.

Definition at line 667 of file view.h.

References KIGFX::VIEW::m_useDrawPriority.

Referenced by GERBVIEW_FRAME::GERBVIEW_FRAME().

668  {
669  m_useDrawPriority = aFlag;
670  }
bool m_useDrawPriority
Flat list of all items Flag to respect draw priority when drawing items.
Definition: view.h:860

Member Data Documentation

BOX2D KIGFX::VIEW::m_boundary
protectedinherited

View boundaries.

Definition at line 828 of file view.h.

Referenced by KIGFX::VIEW::GetBoundary(), KIGFX::VIEW::SetBoundary(), KIGFX::VIEW::SetCenter(), and KIGFX::VIEW::VIEW().

VECTOR2D KIGFX::VIEW::m_center
protectedinherited

Center point of the VIEW (the point at which we are looking at)

Definition at line 822 of file view.h.

Referenced by KIGFX::VIEW::GetCenter(), KIGFX::VIEW::SetCenter(), KIGFX::VIEW::SetGAL(), and KIGFX::VIEW::SetScale().

bool KIGFX::VIEW::m_dirtyTargets[TARGETS_NUMBER]
protectedinherited

Flags to mark targets as dirty, so they have to be redrawn on the next refresh event.

Definition at line 853 of file view.h.

Referenced by KIGFX::VIEW::IsTargetDirty(), KIGFX::VIEW::MarkDirty(), KIGFX::VIEW::markTargetClean(), and KIGFX::VIEW::MarkTargetDirty().

bool KIGFX::VIEW::m_dynamic
protectedinherited

Dynamic VIEW (eg.

display PCB in window) allows changes once it is built, static (eg. image/PDF) - does not.

Definition at line 850 of file view.h.

Referenced by KIGFX::VIEW::IsDynamic().

bool KIGFX::VIEW::m_enableOrderModifier
protectedinherited
  • Whether to use rendering order modifier or not

Definition at line 807 of file view.h.

Referenced by KIGFX::VIEW::ClearTopLayers(), KIGFX::VIEW::EnableTopLayer(), and KIGFX::VIEW::SetTopLayer().

double KIGFX::VIEW::m_maxScale
protectedinherited

Scale upper limit.

Definition at line 834 of file view.h.

Referenced by KIGFX::VIEW::SetScale(), and KIGFX::VIEW::SetScaleLimits().

double KIGFX::VIEW::m_minScale
protectedinherited

Scale lower limit.

Definition at line 831 of file view.h.

Referenced by KIGFX::VIEW::SetScale(), and KIGFX::VIEW::SetScaleLimits().

bool KIGFX::VIEW::m_mirrorX
protectedinherited

Horizontal flip flag

Definition at line 837 of file view.h.

Referenced by KIGFX::VIEW::IsMirroredX(), KIGFX::VIEW::SetGAL(), and KIGFX::VIEW::SetMirror().

bool KIGFX::VIEW::m_mirrorY
protectedinherited

Vertical flip flag

Definition at line 840 of file view.h.

Referenced by KIGFX::VIEW::IsMirroredY(), KIGFX::VIEW::SetGAL(), and KIGFX::VIEW::SetMirror().

int KIGFX::VIEW::m_nextDrawPriority
protectedinherited

The next sequential drawing priority.

Definition at line 863 of file view.h.

Referenced by KIGFX::VIEW::Add(), and KIGFX::VIEW::Clear().

LAYER_ORDER KIGFX::VIEW::m_orderedLayers
protectedinherited

Sorted list of pointers to members of m_layers.

Definition at line 816 of file view.h.

Referenced by KIGFX::VIEW::Query(), KIGFX::VIEW::redrawRect(), and KIGFX::VIEW::sortLayers().

std::vector<EDA_ITEM *> KIGFX::SCH_VIEW::m_ownedItems
private

Definition at line 95 of file sch_view.h.

Referenced by AddToPreview(), and ClearPreview().

PAINTER* KIGFX::VIEW::m_painter
protectedinherited
std::unique_ptr<KIGFX::VIEW_GROUP> KIGFX::SCH_VIEW::m_preview
private

Definition at line 94 of file sch_view.h.

Referenced by AddToPreview(), ClearPreview(), DisplayComponent(), DisplaySheet(), and ShowPreview().

bool KIGFX::VIEW::m_reverseDrawOrder
protectedinherited

Flag to reverse the draw order when using draw priority.

Definition at line 866 of file view.h.

Referenced by KIGFX::VIEW::IsDrawOrderReversed(), KIGFX::VIEW::redrawRect(), and KIGFX::VIEW::ReverseDrawOrder().

double KIGFX::VIEW::m_scale
protectedinherited

Scale of displayed VIEW_ITEMs.

Definition at line 825 of file view.h.

Referenced by KIGFX::VIEW::GetScale(), KIGFX::VIEW::SetGAL(), and KIGFX::VIEW::SetScale().

std::unique_ptr<KIGFX::PREVIEW::SELECTION_AREA> KIGFX::SCH_VIEW::m_selectionArea
private

Definition at line 93 of file sch_view.h.

Referenced by DisplayComponent(), DisplaySheet(), and ShowSelectionArea().

std::set<unsigned int> KIGFX::VIEW::m_topLayers
protectedinherited

Stores set of layers that are displayed on the top.

Definition at line 819 of file view.h.

Referenced by KIGFX::VIEW::ClearTopLayers(), KIGFX::VIEW::EnableTopLayer(), KIGFX::VIEW::GetTopLayer(), and KIGFX::VIEW::SetTopLayer().

bool KIGFX::VIEW::m_useDrawPriority
protectedinherited

Flat list of all items Flag to respect draw priority when drawing items.

Definition at line 860 of file view.h.

Referenced by KIGFX::VIEW::IsUsingDrawPriority(), KIGFX::VIEW::redrawRect(), and KIGFX::VIEW::UseDrawPriority().

std::unique_ptr<WORKSHEET_VIEWITEM> KIGFX::SCH_VIEW::m_worksheet
private

Definition at line 92 of file sch_view.h.

Referenced by DisplaySheet().

const int KIGFX::VIEW::TOP_LAYER_MODIFIER = -VIEW_MAX_LAYERS
staticprotectedinherited

Rendering order modifier for layers that are marked as top layers.

Definition at line 856 of file view.h.

Referenced by KIGFX::VIEW::ClearTopLayers(), KIGFX::VIEW::EnableTopLayer(), KIGFX::VIEW::MakeOverlay(), and KIGFX::VIEW::SetTopLayer().


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