KiCad PCB EDA Suite
KIGFX::VIEW Class Reference

Hold a (potentially large) number of VIEW_ITEMs and renders them on a graphics device provided by the GAL. More...

#include <view.h>

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

Classes

struct  changeItemsDepth
 
struct  clearLayerCache
 
struct  drawItem
 
struct  recacheItem
 
struct  updateItemsColor
 
struct  VIEW_LAYER
 

Public Types

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

Public Member Functions

 VIEW (bool aIsDynamic=true)
 
virtual ~VIEW ()
 
virtual void Add (VIEW_ITEM *aItem, int aDrawPriority=-1)
 Add a VIEW_ITEM to the view. More...
 
virtual void Remove (VIEW_ITEM *aItem)
 Remove a VIEW_ITEM from the view. More...
 
virtual int Query (const BOX2I &aRect, std::vector< LAYER_ITEM_PAIR > &aResult) const
 Find all visible items that touch or are within the rectangle aRect. More...
 
void SetVisible (VIEW_ITEM *aItem, bool aIsVisible=true)
 Set the item visibility. More...
 
void Hide (VIEW_ITEM *aItem, bool aHide=true)
 Temporarily hide the item in the view (e.g. More...
 
bool IsVisible (const VIEW_ITEM *aItem) const
 Return information if the item is visible (or not). More...
 
virtual void Update (const VIEW_ITEM *aItem, int aUpdateFlags) const
 For dynamic VIEWs, inform the associated VIEW that the graphical representation of this item has changed. More...
 
virtual void Update (const VIEW_ITEM *aItem) const
 
void SetRequired (int aLayerId, int aRequiredId, bool aRequired=true)
 Mark the aRequiredId layer as required for the aLayerId layer. More...
 
void CopySettings (const VIEW *aOtherView)
 Copy layers and visibility settings from another view. More...
 
void SetGAL (GAL *aGal)
 Assign a rendering device for the VIEW. More...
 
GALGetGAL () const
 Return the #GAL this view is using to draw graphical primitives. More...
 
void SetPainter (PAINTER *aPainter)
 Set the painter object used by the view for drawing #VIEW_ITEMS. More...
 
PAINTERGetPainter () const
 Return the painter object used by the view for drawing #VIEW_ITEMS. More...
 
void SetViewport (const BOX2D &aViewport)
 Set the visible area of the VIEW. More...
 
BOX2D GetViewport () const
 Return the current viewport visible area rectangle. More...
 
void SetMirror (bool aMirrorX, bool aMirrorY)
 Control the mirroring of the VIEW. More...
 
bool IsMirroredX () const
 Return true if view is flipped across the X axis. More...
 
bool IsMirroredY () const
 Return true if view is flipped across the Y axis. More...
 
virtual void SetScale (double aScale, VECTOR2D aAnchor={ 0, 0 })
 Set the scaling factor, zooming around a given anchor point. More...
 
double GetScale () const
 
void SetBoundary (const BOX2D &aBoundary)
 Set limits for view area. More...
 
void SetBoundary (const BOX2I &aBoundary)
 Set limits for view area. More...
 
const BOX2DGetBoundary () const
 
void SetScaleLimits (double aMaximum, double aMinimum)
 Set minimum and maximum values for scale. More...
 
void SetCenter (const VECTOR2D &aCenter)
 Set the center point of the VIEW (i.e. More...
 
void SetCenter (VECTOR2D aCenter, const BOX2D &occultingScreenRect)
 Set 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
 Return the center point of this VIEW (in world space coordinates). More...
 
VECTOR2D ToWorld (const VECTOR2D &aCoord, bool aAbsolute=true) const
 Converts a screen space point/vector to a point/vector in world space coordinates. More...
 
double ToWorld (double aSize) const
 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
 Convert a world space point/vector to a point/vector in screen space coordinates. More...
 
double ToScreen (double aSize) const
 Convert a world space one dimensional size to a one dimensional size in screen space. More...
 
const VECTOR2IGetScreenPixelSize () const
 Return the size of the our rendering area in pixels. More...
 
void Clear ()
 Remove all items from the view. More...
 
void SetLayerVisible (int aLayer, bool aVisible=true)
 Control the visibility of a particular layer. More...
 
bool IsLayerVisible (int aLayer) const
 Return information about visibility of a particular layer. More...
 
void SetLayerDisplayOnly (int aLayer, bool aDisplayOnly=true)
 
void SetLayerTarget (int aLayer, RENDER_TARGET aTarget)
 Change the rendering target for a particular layer. More...
 
void SetLayerOrder (int aLayer, int aRenderingOrder)
 Set rendering order of a particular layer. More...
 
int GetLayerOrder (int aLayer) const
 Return rendering order of a particular layer. More...
 
void SortLayers (int aLayers[], int &aCount) const
 Change 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)
 Remap the data between layer ids without invalidating that data. More...
 
void UpdateLayerColor (int aLayer)
 Apply the new coloring scheme held by RENDER_SETTINGS in case that it has changed. More...
 
void UpdateAllLayersColor ()
 Apply the new coloring scheme to all layers. More...
 
virtual void SetTopLayer (int aLayer, bool aEnabled=true)
 Set given layer to be displayed on the top or sets back the default order of layers. More...
 
virtual void EnableTopLayer (bool aEnable)
 Enable or disable display of the top layer. More...
 
virtual int GetTopLayer () const
 
void ClearTopLayers ()
 Remove all layers from the on-the-top set (they are no longer displayed over the rest of layers). More...
 
void UpdateAllLayersOrder ()
 Do everything that is needed to apply the rendering order of layers. More...
 
void ClearTargets ()
 Clear targets that are marked as dirty. More...
 
virtual void Redraw ()
 Immediately redraws the whole view. More...
 
void RecacheAllItems ()
 Rebuild GAL display lists. More...
 
bool IsDynamic () const
 Tell if the VIEW is dynamic (ie. More...
 
bool IsDirty () const
 Return true if any of the VIEW layers needs to be refreshened. More...
 
bool IsTargetDirty (int aTarget) const
 Return true if any of layers belonging to the target or the target itself should be redrawn. More...
 
void MarkTargetDirty (int aTarget)
 Set or clear target 'dirty' flag. More...
 
bool IsCached (int aLayer) const
 Return true if the layer is cached. More...
 
void MarkDirty ()
 Force redraw of view on the next rendering. More...
 
void MarkForUpdate (VIEW_ITEM *aItem)
 Add an item to a list of items that are going to be refreshed upon the next frame rendering. More...
 
void UpdateItems ()
 Iterate through the list of items that asked for updating and updates them. More...
 
void UpdateAllItems (int aUpdateFlags)
 Update all items in the view according to the given flags. More...
 
void UpdateAllItemsConditionally (int aUpdateFlags, std::function< bool(VIEW_ITEM *)> aCondition)
 Update items in the view according to the given flags and condition. More...
 
bool IsUsingDrawPriority () const
 
void UseDrawPriority (bool aFlag)
 
bool IsDrawOrderReversed () const
 
void ReverseDrawOrder (bool aFlag)
 Only takes effect if UseDrawPriority is true. More...
 
std::shared_ptr< VIEW_OVERLAYMakeOverlay ()
 
void InitPreview ()
 
void ClearPreview ()
 
void AddToPreview (EDA_ITEM *aItem, bool aTakeOwnership=true)
 
void ShowPreview (bool aShow=true)
 
std::unique_ptr< VIEWDataReference () const
 Return a new VIEW object that shares the same set of VIEW_ITEMs and LAYERs. More...
 
int GetPrintMode ()
 Get the current print mode. More...
 
void SetPrintMode (int aPrintMode)
 Set the printing mode. More...
 

Static Public Member Functions

static void OnDestroy (VIEW_ITEM *aItem)
 Nasty hack, invoked by the destructor of VIEW_ITEM to auto-remove the item from the owning VIEW if there is any. More...
 

Static Public Attributes

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

Protected Member Functions

 VIEW (const VIEW &)=delete
 
void redrawRect (const BOX2I &aRect)
 
void markTargetClean (int aTarget)
 
void draw (VIEW_ITEM *aItem, int aLayer, bool aImmediate=false)
 Draw an item, but on a specified layers. More...
 
void draw (VIEW_ITEM *aItem, bool aImmediate=false)
 Draw an item on all layers that the item uses. More...
 
void draw (VIEW_GROUP *aGroup, bool aImmediate=false)
 Draw a group of items on all layers that those items use. More...
 
void sortLayers ()
 Clear cached GAL group numbers (ONLY numbers stored in VIEW_ITEMs, not group objects used by GAL) More...
 
void clearGroupCache ()
 
void invalidateItem (VIEW_ITEM *aItem, int aUpdateFlags)
 Manage dirty flags & redraw queuing when updating an item. More...
 
void updateItemColor (VIEW_ITEM *aItem, int aLayer)
 Update all information needed to draw an item. More...
 
void updateItemGeometry (VIEW_ITEM *aItem, int aLayer)
 Update bounding box of an item. More...
 
void updateBbox (VIEW_ITEM *aItem)
 Update set of layers that an item occupies. More...
 
void updateLayers (VIEW_ITEM *aItem)
 Determine rendering order of layers. Used in display order sorting function. More...
 
bool areRequiredLayersEnabled (int aLayerId) const
 

Static Protected Member Functions

static bool compareRenderingOrder (VIEW_LAYER *aI, VIEW_LAYER *aJ)
 Check if every layer required by the aLayerId layer is enabled. More...
 

Protected Attributes

std::unique_ptr< KIGFX::VIEW_GROUPm_preview
 
std::vector< EDA_ITEM * > m_ownedItems
 Whether to use rendering order modifier or not. More...
 
bool m_enableOrderModifier
 The set of possible displayed layers and its properties. More...
 
std::vector< VIEW_LAYERm_layers
 Sorted list of pointers to members of m_layers. More...
 
std::vector< VIEW_LAYER * > m_orderedLayers
 Flat list of all items. More...
 
std::shared_ptr< std::vector< VIEW_ITEM * > > m_allItems
 The set of layers that are displayed on the top. More...
 
std::set< unsigned int > m_topLayers
 Center point of the VIEW (the point at which we are looking at). More...
 
VECTOR2D m_center
 Scale of displayed VIEW_ITEMs. More...
 
double m_scale
 View boundaries. More...
 
BOX2D m_boundary
 Scale lower limit. More...
 
double m_minScale
 Scale upper limit. More...
 
double m_maxScale
 Horizontal flip flag. More...
 
bool m_mirrorX
 Vertical flip flag. More...
 
bool m_mirrorY
 PAINTER contains information how do draw items. More...
 
PAINTERm_painter
 Interface to #PAINTER that is used to draw items. More...
 
GALm_gal
 Dynamic VIEW (eg. More...
 
bool m_dynamic
 Flag to mark targets as dirty so they have to be redrawn on the next refresh event. More...
 
bool m_dirtyTargets [TARGETS_NUMBER]
 Rendering order modifier for layers that are marked as top layers. More...
 
bool m_useDrawPriority
 The next sequential drawing priority. More...
 
int m_nextDrawPriority
 Flag to reverse the draw order when using draw priority. More...
 
bool m_reverseDrawOrder
 A control for printing: m_printMode <= 0 means no printing mode (normal draw mode m_printMode > 0 is a printing mode (currently means "we are in printing mode"). More...
 
int m_printMode
 

Static Protected Attributes

static const int TOP_LAYER_MODIFIER = -VIEW_MAX_LAYERS
 Flag to respect draw priority when drawing items. More...
 

Friends

class VIEW_ITEM
 

Detailed Description

Hold a (potentially large) number of VIEW_ITEMs and renders them on a graphics device provided by the GAL.

VIEWs can exist in two flavors:

  • dynamic - where items can be added, removed or changed anytime, intended for the main editing panel. Each VIEW_ITEM can be added to a single dynamic view.
  • static - where items are added once at the startup and are not linked with the VIEW. Foreseen for preview windows and printing.

Items in a view are grouped in layers (not to be confused with Kicad's PCB layers). Each layer is identified by an integer number. Visibility and rendering order can be set individually for each of the layers. Future versions of the VIEW will also allows one to assign different layers to different rendering targets, which will be composited at the final stage by the GAL. The VIEW class also provides fast methods for finding all visible objects that are within a given rectangular area, useful for object selection/hit testing.

Definition at line 67 of file view.h.

Member Typedef Documentation

◆ LAYER_ITEM_PAIR

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

Definition at line 72 of file view.h.

Constructor & Destructor Documentation

◆ VIEW() [1/2]

KIGFX::VIEW::VIEW ( bool  aIsDynamic = true)
Parameters
aIsDynamicdecides whether we are creating a static or a dynamic VIEW.

Definition at line 268 of file view.cpp.

268  :
269  m_enableOrderModifier( true ),
270  m_scale( 4.0 ),
271  m_minScale( 0.2 ), m_maxScale( 5000.0 ),
272  m_mirrorX( false ), m_mirrorY( false ),
273  m_painter( NULL ),
274  m_gal( NULL ),
275  m_dynamic( aIsDynamic ),
276  m_useDrawPriority( false ),
277  m_nextDrawPriority( 0 ),
278  m_reverseDrawOrder( false )
279 {
280  // Set m_boundary to define the max area size. The default area size
281  // is defined here as the max value of a int.
282  // this is a default value acceptable for Pcbnew and Gerbview, but too large for Eeschema.
283  // So in eeschema a call to SetBoundary() with a smaller value will be needed.
284  typedef std::numeric_limits<int> coord_limits;
285  double pos = coord_limits::lowest() / 2 + coord_limits::epsilon();
286  double size = coord_limits::max() - coord_limits::epsilon();
287  m_boundary.SetOrigin( pos, pos );
288  m_boundary.SetSize( size, size );
289  SetPrintMode( 0 );
290 
291  m_allItems.reset( new std::vector<VIEW_ITEM*> );
292  m_allItems->reserve( 32768 );
293 
294  // Redraw everything at the beginning
295  MarkDirty();
296 
297  m_layers.reserve( VIEW_MAX_LAYERS );
298 
299  // View uses layers to display EDA_ITEMs (item may be displayed on several layers, for example
300  // pad may be shown on pad, pad hole and solder paste layers). There are usual copper layers
301  // (eg. F.Cu, B.Cu, internal and so on) and layers for displaying objects such as texts,
302  // silkscreen, pads, vias, etc.
303  for( int ii = 0; ii < VIEW_MAX_LAYERS; ++ii )
304  {
305  m_layers.emplace_back();
306  m_layers[ii].items = std::make_shared<VIEW_RTREE>();
307  m_layers[ii].id = ii;
308  m_layers[ii].renderingOrder = ii;
309  m_layers[ii].visible = true;
310  m_layers[ii].displayOnly = false;
311  m_layers[ii].target = TARGET_CACHED;
312  }
313 
314  sortLayers();
315 
316  m_preview.reset( new KIGFX::VIEW_GROUP() );
317  Add( m_preview.get() );
318 }
bool m_useDrawPriority
The next sequential drawing priority.
Definition: view.h:856
std::unique_ptr< KIGFX::VIEW_GROUP > m_preview
Definition: view.h:798
void sortLayers()
Clear cached GAL group numbers (ONLY numbers stored in VIEW_ITEMs, not group objects used by GAL)
Definition: view.cpp:1236
GAL * m_gal
Dynamic VIEW (eg.
Definition: view.h:843
void SetSize(const Vec &size)
Definition: box2.h:212
static constexpr int VIEW_MAX_LAYERS
maximum number of layers that may be shown
Definition: view.h:696
std::shared_ptr< std::vector< VIEW_ITEM * > > m_allItems
The set of layers that are displayed on the top.
Definition: view.h:813
double m_minScale
Scale upper limit.
Definition: view.h:828
void SetPrintMode(int aPrintMode)
Set the printing mode.
Definition: view.h:694
#define NULL
bool m_mirrorX
Vertical flip flag.
Definition: view.h:834
bool m_dynamic
Flag to mark targets as dirty so they have to be redrawn on the next refresh event.
Definition: view.h:847
Extend VIEW_ITEM by possibility of grouping items into a single object.
Definition: view_group.h:46
PAINTER * m_painter
Interface to #PAINTER that is used to draw items.
Definition: view.h:840
bool m_reverseDrawOrder
A control for printing: m_printMode <= 0 means no printing mode (normal draw mode m_printMode > 0 is ...
Definition: view.h:862
int m_nextDrawPriority
Flag to reverse the draw order when using draw priority.
Definition: view.h:859
std::vector< VIEW_LAYER > m_layers
Sorted list of pointers to members of m_layers.
Definition: view.h:807
double m_maxScale
Horizontal flip flag.
Definition: view.h:831
Main rendering target (cached)
Definition: definitions.h:48
bool m_enableOrderModifier
The set of possible displayed layers and its properties.
Definition: view.h:804
BOX2D m_boundary
Scale lower limit.
Definition: view.h:825
void SetOrigin(const Vec &pos)
Definition: box2.h:210
bool m_mirrorY
PAINTER contains information how do draw items.
Definition: view.h:837
double m_scale
View boundaries.
Definition: view.h:822
virtual void Add(VIEW_ITEM *aItem, int aDrawPriority=-1)
Add a VIEW_ITEM to the view.
Definition: view.cpp:327
void MarkDirty()
Force redraw of view on the next rendering.
Definition: view.h:594

References Add(), m_allItems, m_boundary, m_layers, m_preview, MarkDirty(), BOX2< Vec >::SetOrigin(), SetPrintMode(), BOX2< Vec >::SetSize(), sortLayers(), KIGFX::TARGET_CACHED, and VIEW_MAX_LAYERS.

◆ ~VIEW()

KIGFX::VIEW::~VIEW ( )
virtual

Definition at line 321 of file view.cpp.

322 {
323  Remove( m_preview.get() );
324 }
std::unique_ptr< KIGFX::VIEW_GROUP > m_preview
Definition: view.h:798
virtual void Remove(VIEW_ITEM *aItem)
Remove a VIEW_ITEM from the view.
Definition: view.cpp:357

References m_preview, and Remove().

◆ VIEW() [2/2]

KIGFX::VIEW::VIEW ( const VIEW )
protecteddelete

Member Function Documentation

◆ Add()

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

Add 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 327 of file view.cpp.

328 {
329  int layers[VIEW_MAX_LAYERS], layers_count;
330 
331  if( aDrawPriority < 0 )
332  aDrawPriority = m_nextDrawPriority++;
333 
334  if( !aItem->m_viewPrivData )
335  aItem->m_viewPrivData = new VIEW_ITEM_DATA;
336 
337  aItem->m_viewPrivData->m_view = this;
338  aItem->m_viewPrivData->m_drawPriority = aDrawPriority;
339 
340  aItem->ViewGetLayers( layers, layers_count );
341  aItem->viewPrivData()->saveLayers( layers, layers_count );
342 
343  m_allItems->push_back( aItem );
344 
345  for( int i = 0; i < layers_count; ++i )
346  {
347  VIEW_LAYER& l = m_layers[layers[i]];
348  l.items->Insert( aItem );
349  MarkTargetDirty( l.target );
350  }
351 
352  SetVisible( aItem, true );
353  Update( aItem, KIGFX::INITIAL_ADD );
354 }
Item is being added to the view.
Definition: view_item.h:56
static constexpr int VIEW_MAX_LAYERS
maximum number of layers that may be shown
Definition: view.h:696
std::shared_ptr< std::vector< VIEW_ITEM * > > m_allItems
The set of layers that are displayed on the top.
Definition: view.h:813
void MarkTargetDirty(int aTarget)
Set or clear target 'dirty' flag.
Definition: view.h:570
int m_nextDrawPriority
Flag to reverse the draw order when using draw priority.
Definition: view.h:859
std::vector< VIEW_LAYER > m_layers
Sorted list of pointers to members of m_layers.
Definition: view.h:807
void SetVisible(VIEW_ITEM *aItem, bool aIsVisible=true)
Set the item visibility.
Definition: view.cpp:1459
virtual void Update(const VIEW_ITEM *aItem, int aUpdateFlags) const
For dynamic VIEWs, inform the associated VIEW that the graphical representation of this item has chan...
Definition: view.cpp:1513

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

Referenced by KIGFX::PCB_VIEW::Add(), SCH_BASE_FRAME::AddToScreen(), PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), EDA_DRAW_PANEL_GAL::DebugOverlay(), GERBVIEW_SELECTION_TOOL::disambiguationMenu(), PCB_DRAW_PANEL_GAL::DisplayBoard(), KIGFX::SCH_VIEW::DisplayComponent(), SYMBOL_PREVIEW_WIDGET::DisplayPart(), KIGFX::SCH_VIEW::DisplaySheet(), SYMBOL_PREVIEW_WIDGET::DisplaySymbol(), PL_DRAW_PANEL_GAL::DisplayWorksheet(), PCB_SELECTION_TOOL::doSelectionMenu(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawSegment(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), EE_GRID_HELPER::EE_GRID_HELPER(), InitPreview(), EE_POINT_EDITOR::Main(), PL_POINT_EDITOR::Main(), MakeOverlay(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), PCB_GRID_HELPER::PCB_GRID_HELPER(), DRAWING_TOOL::PlaceImportedGraphics(), DIALOG_PAD_PROPERTIES::prepareCanvas(), BOARD_COMMIT::Push(), GERBVIEW_FRAME::Read_EXCELLON_File(), GERBVIEW_FRAME::Read_GERBER_File(), DIALOG_PAD_PROPERTIES::redraw(), BOARD_EDITOR_CONTROL::Reset(), PCB_CONTROL::Reset(), GERBVIEW_SELECTION_TOOL::Reset(), EE_SELECTION_TOOL::Reset(), BOARD_COMMIT::Revert(), GERBVIEW_SELECTION_TOOL::select(), PL_SELECTION_TOOL::selectMultiple(), EE_SELECTION_TOOL::selectMultiple(), ZOOM_TOOL::selectRegion(), PNS_KICAD_IFACE::SetView(), PNS_PCBNEW_DEBUG_DECORATOR::SetView(), PCB_DRAW_PANEL_GAL::SetWorksheet(), GERBVIEW_DRAW_PANEL_GAL::SetWorksheet(), GERBVIEW_DRAW_PANEL_GAL::SwitchBackend(), WS_DATA_ITEM::SyncDrawItems(), WS_DATA_ITEM_POLYGONS::SyncDrawItems(), WS_DATA_ITEM_TEXT::SyncDrawItems(), WS_DATA_ITEM_BITMAP::SyncDrawItems(), DIALOG_ERC::testErc(), EE_POINT_EDITOR::updatePoints(), PCB_POINT_EDITOR::updatePoints(), SYMBOL_VIEWER_FRAME::updatePreviewSymbol(), VIEW(), and ZONE_CREATE_HELPER::ZONE_CREATE_HELPER().

◆ AddToPreview()

void KIGFX::VIEW::AddToPreview ( EDA_ITEM aItem,
bool  aTakeOwnership = true 
)

Definition at line 1554 of file view.cpp.

1555 {
1556  Hide( aItem, false );
1557  m_preview->Add( aItem );
1558 
1559  if( aTakeOwnership )
1560  m_ownedItems.push_back( aItem );
1561 
1562  SetVisible( m_preview.get(), true );
1563  Hide( m_preview.get(), false );
1564  Update( m_preview.get() );
1565 }
void Hide(VIEW_ITEM *aItem, bool aHide=true)
Temporarily hide the item in the view (e.g.
Definition: view.cpp:1480
std::unique_ptr< KIGFX::VIEW_GROUP > m_preview
Definition: view.h:798
std::vector< EDA_ITEM * > m_ownedItems
Whether to use rendering order modifier or not.
Definition: view.h:801
void SetVisible(VIEW_ITEM *aItem, bool aIsVisible=true)
Set the item visibility.
Definition: view.cpp:1459
virtual void Update(const VIEW_ITEM *aItem, int aUpdateFlags) const
For dynamic VIEWs, inform the associated VIEW that the graphical representation of this item has chan...
Definition: view.cpp:1513

References Hide(), m_ownedItems, m_preview, SetVisible(), and Update().

Referenced by SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), ROUTER_TOOL::InlineDrag(), SCH_DRAWING_TOOLS::PlaceComponent(), SCH_DRAWING_TOOLS::PlaceImage(), SCH_DRAWING_TOOLS::SingleClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ areRequiredLayersEnabled()

bool KIGFX::VIEW::areRequiredLayersEnabled ( int  aLayerId) const
protected

Definition at line 1359 of file view.cpp.

1360 {
1361  wxCHECK( (unsigned) aLayerId < m_layers.size(), false );
1362 
1363  std::set<int>::const_iterator it, it_end;
1364 
1365  for( it = m_layers.at( aLayerId ).requiredLayers.begin(),
1366  it_end = m_layers.at( aLayerId ).requiredLayers.end(); it != it_end; ++it )
1367  {
1368  // That is enough if just one layer is not enabled
1369  if( !m_layers.at( *it ).visible || !areRequiredLayersEnabled( *it ) )
1370  return false;
1371  }
1372 
1373  return true;
1374 }
bool areRequiredLayersEnabled(int aLayerId) const
Definition: view.cpp:1359
std::vector< VIEW_LAYER > m_layers
Sorted list of pointers to members of m_layers.
Definition: view.h:807

References m_layers.

Referenced by redrawRect().

◆ Clear()

void KIGFX::VIEW::Clear ( )

Remove all items from the view.

Definition at line 1089 of file view.cpp.

1090 {
1091  BOX2I r;
1092  r.SetMaximum();
1093  m_allItems->clear();
1094 
1095  for( VIEW_LAYER& layer : m_layers )
1096  layer.items->RemoveAll();
1097 
1098  m_nextDrawPriority = 0;
1099 
1100  m_gal->ClearCache();
1101 }
GAL * m_gal
Dynamic VIEW (eg.
Definition: view.h:843
std::shared_ptr< std::vector< VIEW_ITEM * > > m_allItems
The set of layers that are displayed on the top.
Definition: view.h:813
void SetMaximum()
Definition: box2.h:73
int m_nextDrawPriority
Flag to reverse the draw order when using draw priority.
Definition: view.h:859
std::vector< VIEW_LAYER > m_layers
Sorted list of pointers to members of m_layers.
Definition: view.h:807
virtual void ClearCache()
Delete all data created during caching of graphic items.

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

Referenced by KIGFX::SCH_VIEW::Cleanup(), GERBVIEW_FRAME::Clear_DrawLayers(), PCB_DRAW_PANEL_GAL::DisplayBoard(), SCH_DRAW_PANEL::DisplayComponent(), KIGFX::SCH_VIEW::DisplayComponent(), SCH_DRAW_PANEL::DisplaySheet(), PL_DRAW_PANEL_GAL::DisplayWorksheet(), GERBVIEW_FRAME::doCloseWindow(), DISPLAY_FOOTPRINTS_FRAME::InitDisplay(), FOOTPRINT_PREVIEW_PANEL::renderFootprint(), WS_PROXY_UNDO_ITEM::Restore(), PCB_BASE_EDIT_FRAME::SetBoard(), SYMBOL_EDIT_FRAME::SetCurPart(), GERBVIEW_DRAW_PANEL_GAL::SwitchBackend(), DISPLAY_FOOTPRINTS_FRAME::~DISPLAY_FOOTPRINTS_FRAME(), FOOTPRINT_PREVIEW_PANEL::~FOOTPRINT_PREVIEW_PANEL(), FOOTPRINT_VIEWER_FRAME::~FOOTPRINT_VIEWER_FRAME(), GERBVIEW_FRAME::~GERBVIEW_FRAME(), and PCB_BASE_EDIT_FRAME::~PCB_BASE_EDIT_FRAME().

◆ clearGroupCache()

void KIGFX::VIEW::clearGroupCache ( )
protected

Definition at line 1179 of file view.cpp.

1180 {
1181  BOX2I r;
1182 
1183  r.SetMaximum();
1184  clearLayerCache visitor( this );
1185 
1186  for( VIEW_LAYER& layer : m_layers )
1187  layer.items->Query( r, visitor );
1188 }
void SetMaximum()
Definition: box2.h:73
std::vector< VIEW_LAYER > m_layers
Sorted list of pointers to members of m_layers.
Definition: view.h:807

References m_layers, and BOX2< Vec >::SetMaximum().

Referenced by SetGAL().

◆ ClearPreview()

void KIGFX::VIEW::ClearPreview ( )

Definition at line 1535 of file view.cpp.

1536 {
1537  m_preview->Clear();
1538 
1539  for( EDA_ITEM* item : m_ownedItems )
1540  delete item;
1541 
1542  m_ownedItems.clear();
1543  Update( m_preview.get() );
1544 }
std::unique_ptr< KIGFX::VIEW_GROUP > m_preview
Definition: view.h:798
std::vector< EDA_ITEM * > m_ownedItems
Whether to use rendering order modifier or not.
Definition: view.h:801
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:148
virtual void Update(const VIEW_ITEM *aItem, int aUpdateFlags) const
For dynamic VIEWs, inform the associated VIEW that the graphical representation of this item has chan...
Definition: view.cpp:1513

References m_ownedItems, m_preview, and Update().

Referenced by SCH_EDIT_FRAME::AddJunction(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), SCH_LINE_WIRE_BUS_TOOL::finishSegments(), ROUTER_TOOL::InlineDrag(), SCH_DRAWING_TOOLS::PlaceComponent(), SCH_DRAWING_TOOLS::PlaceImage(), SCH_DRAWING_TOOLS::SingleClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ ClearTargets()

void KIGFX::VIEW::ClearTargets ( )

Clear targets that are marked as dirty.

Definition at line 1104 of file view.cpp.

1105 {
1107  {
1108  // TARGET_CACHED and TARGET_NONCACHED have to be redrawn together, as they contain
1109  // layers that rely on each other (eg. netnames are noncached, but tracks - are cached)
1112 
1113  MarkDirty();
1114  }
1115 
1116  if( IsTargetDirty( TARGET_OVERLAY ) )
1117  {
1119  }
1120 }
GAL * m_gal
Dynamic VIEW (eg.
Definition: view.h:843
Auxiliary rendering target (noncached)
Definition: definitions.h:49
bool IsTargetDirty(int aTarget) const
Return true if any of layers belonging to the target or the target itself should be redrawn.
Definition: view.h:559
virtual void ClearTarget(RENDER_TARGET aTarget)
Clears the target for rendering.
Items that may change while the view stays the same (noncached)
Definition: definitions.h:50
Main rendering target (cached)
Definition: definitions.h:48
void MarkDirty()
Force redraw of view on the next rendering.
Definition: view.h:594

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

Referenced by EDA_DRAW_PANEL_GAL::DoRePaint().

◆ ClearTopLayers()

void KIGFX::VIEW::ClearTopLayers ( )

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

Definition at line 890 of file view.cpp.

891 {
892  std::set<unsigned int>::iterator it;
893 
895  {
896  // Restore the previous rendering order for layers that were marked as top
897  for( it = m_topLayers.begin(); it != m_topLayers.end(); ++it )
898  m_layers[*it].renderingOrder -= TOP_LAYER_MODIFIER;
899  }
900 
901  m_topLayers.clear();
902 }
static const int TOP_LAYER_MODIFIER
Flag to respect draw priority when drawing items.
Definition: view.h:853
std::set< unsigned int > m_topLayers
Center point of the VIEW (the point at which we are looking at).
Definition: view.h:816
std::vector< VIEW_LAYER > m_layers
Sorted list of pointers to members of m_layers.
Definition: view.h:807
bool m_enableOrderModifier
The set of possible displayed layers and its properties.
Definition: view.h:804

References m_enableOrderModifier, m_layers, m_topLayers, and TOP_LAYER_MODIFIER.

Referenced by GERBVIEW_DRAW_PANEL_GAL::SetTopLayer(), PL_DRAW_PANEL_GAL::SetTopLayer(), PCB_DRAW_PANEL_GAL::SetTopLayer(), and EDA_DRAW_PANEL_GAL::SetTopLayer().

◆ compareRenderingOrder()

static bool KIGFX::VIEW::compareRenderingOrder ( VIEW_LAYER aI,
VIEW_LAYER aJ 
)
inlinestaticprotected

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

Definition at line 783 of file view.h.

References KIGFX::VIEW::VIEW_LAYER::renderingOrder.

Referenced by sortLayers().

◆ CopySettings()

void KIGFX::VIEW::CopySettings ( const VIEW aOtherView)

Copy layers and visibility settings from another view.

Parameters
aOtherViewview from which settings will be copied.

Definition at line 494 of file view.cpp.

495 {
496  wxASSERT_MSG( false, wxT( "This is not implemented" ) );
497 }

◆ DataReference()

std::unique_ptr< VIEW > KIGFX::VIEW::DataReference ( ) const

Return 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 1449 of file view.cpp.

1450 {
1451  auto ret = std::make_unique<VIEW>();
1452  ret->m_allItems = m_allItems;
1453  ret->m_layers = m_layers;
1454  ret->sortLayers();
1455  return ret;
1456 }
std::shared_ptr< std::vector< VIEW_ITEM * > > m_allItems
The set of layers that are displayed on the top.
Definition: view.h:813
std::vector< VIEW_LAYER > m_layers
Sorted list of pointers to members of m_layers.
Definition: view.h:807

References m_allItems, and m_layers.

Referenced by BOARD_PRINTOUT::DrawPage().

◆ draw() [1/3]

void KIGFX::VIEW::draw ( VIEW_ITEM aItem,
int  aLayer,
bool  aImmediate = false 
)
protected

Draw 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 1007 of file view.cpp.

1008 {
1009  auto viewData = aItem->viewPrivData();
1010 
1011  if( !viewData )
1012  return;
1013 
1014  if( IsCached( aLayer ) && !aImmediate )
1015  {
1016  // Draw using cached information or create one
1017  int group = viewData->getGroup( aLayer );
1018 
1019  if( group >= 0 )
1020  m_gal->DrawGroup( group );
1021  else
1022  Update( aItem );
1023  }
1024  else
1025  {
1026  // Immediate mode
1027  if( !m_painter->Draw( aItem, aLayer ) )
1028  aItem->ViewDraw( aLayer, this ); // Alternative drawing method
1029  }
1030 }
virtual void DrawGroup(int aGroupNumber)
Draw the stored group.
GAL * m_gal
Dynamic VIEW (eg.
Definition: view.h:843
PAINTER * m_painter
Interface to #PAINTER that is used to draw items.
Definition: view.h:840
virtual bool Draw(const VIEW_ITEM *aItem, int aLayer)=0
Takes an instance of VIEW_ITEM and passes it to a function that knows how to draw the item.
bool IsCached(int aLayer) const
Return true if the layer is cached.
Definition: view.h:577
virtual void Update(const VIEW_ITEM *aItem, int aUpdateFlags) const
For dynamic VIEWs, inform the associated VIEW that the graphical representation of this item has chan...
Definition: view.cpp:1513

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

Referenced by KIGFX::VIEW::drawItem::deferredDraw(), draw(), and KIGFX::VIEW::drawItem::operator()().

◆ draw() [2/3]

void KIGFX::VIEW::draw ( VIEW_ITEM aItem,
bool  aImmediate = false 
)
protected

Draw 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 1033 of file view.cpp.

1034 {
1035  int layers[VIEW_MAX_LAYERS], layers_count;
1036 
1037  aItem->ViewGetLayers( layers, layers_count );
1038 
1039  // Sorting is needed for drawing order dependent GALs (like Cairo)
1040  SortLayers( layers, layers_count );
1041 
1042  for( int i = 0; i < layers_count; ++i )
1043  {
1044  m_gal->SetLayerDepth( m_layers.at( layers[i] ).renderingOrder );
1045  draw( aItem, layers[i], aImmediate );
1046  }
1047 }
GAL * m_gal
Dynamic VIEW (eg.
Definition: view.h:843
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:696
void SortLayers(int aLayers[], int &aCount) const
Change the order of given layer ids, so after sorting the order corresponds to layers rendering order...
Definition: view.cpp:659
std::vector< VIEW_LAYER > m_layers
Sorted list of pointers to members of m_layers.
Definition: view.h:807
void draw(VIEW_ITEM *aItem, int aLayer, bool aImmediate=false)
Draw an item, but on a specified layers.
Definition: view.cpp:1007

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

◆ draw() [3/3]

void KIGFX::VIEW::draw ( VIEW_GROUP aGroup,
bool  aImmediate = false 
)
protected

Draw 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.Sort m_orderedLayers when layer rendering order has changed

Definition at line 1050 of file view.cpp.

1051 {
1052  for( unsigned int i = 0; i < aGroup->GetSize(); i++)
1053  draw( aGroup->GetItem(i), aImmediate );
1054 }
void draw(VIEW_ITEM *aItem, int aLayer, bool aImmediate=false)
Draw an item, but on a specified layers.
Definition: view.cpp:1007

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

◆ EnableTopLayer()

void KIGFX::VIEW::EnableTopLayer ( bool  aEnable)
virtual

Enable or disable 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 865 of file view.cpp.

866 {
867  if( aEnable == m_enableOrderModifier )
868  return;
869 
870  m_enableOrderModifier = aEnable;
871 
872  std::set<unsigned int>::iterator it;
873 
874  if( aEnable )
875  {
876  for( it = m_topLayers.begin(); it != m_topLayers.end(); ++it )
877  m_layers[*it].renderingOrder += TOP_LAYER_MODIFIER;
878  }
879  else
880  {
881  for( it = m_topLayers.begin(); it != m_topLayers.end(); ++it )
882  m_layers[*it].renderingOrder -= TOP_LAYER_MODIFIER;
883  }
884 
887 }
static const int TOP_LAYER_MODIFIER
Flag to respect draw priority when drawing items.
Definition: view.h:853
std::set< unsigned int > m_topLayers
Center point of the VIEW (the point at which we are looking at).
Definition: view.h:816
void UpdateAllLayersOrder()
Do everything that is needed to apply the rendering order of layers.
Definition: view.cpp:905
std::vector< VIEW_LAYER > m_layers
Sorted list of pointers to members of m_layers.
Definition: view.h:807
bool m_enableOrderModifier
The set of possible displayed layers and its properties.
Definition: view.h:804
void UpdateAllLayersColor()
Apply the new coloring scheme to all layers.
Definition: view.cpp:776

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

Referenced by PCB_DRAW_PANEL_GAL::SetTopLayer().

◆ GetBoundary()

const BOX2D& KIGFX::VIEW::GetBoundary ( ) const
inline
Returns
Current view area boundary.

Definition at line 292 of file view.h.

293  {
294  return m_boundary;
295  }
BOX2D m_boundary
Scale lower limit.
Definition: view.h:825

References m_boundary.

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

◆ GetCenter()

const VECTOR2D& KIGFX::VIEW::GetCenter ( ) const
inline

Return the center point of this VIEW (in world space coordinates).

Returns
center point of the view

Definition at line 333 of file view.h.

334  {
335  return m_center;
336  }
VECTOR2D m_center
Scale of displayed VIEW_ITEMs.
Definition: view.h:819

References m_center.

Referenced by EDA_DRAW_PANEL_GAL::DoRePaint(), KIGFX::WX_VIEW_CONTROLS::onButton(), KIGFX::WX_VIEW_CONTROLS::onScroll(), KIGFX::WX_VIEW_CONTROLS::onTimer(), KIGFX::WX_VIEW_CONTROLS::onWheel(), and SYMBOL_EDITOR_DRAWING_TOOLS::PlaceAnchor().

◆ GetGAL()

GAL* KIGFX::VIEW::GetGAL ( ) const
inline

Return the #GAL this view is using to draw graphical primitives.

Returns
Pointer to the currently used GAL instance.

Definition at line 189 of file view.h.

190  {
191  return m_gal;
192  }
GAL * m_gal
Dynamic VIEW (eg.
Definition: view.h:843

References m_gal.

Referenced by GRID_HELPER::Align(), PCB_GRID_HELPER::BestDragOrigin(), EE_GRID_HELPER::BestDragOrigin(), PCB_GRID_HELPER::BestSnapAnchor(), KIGFX::WX_VIEW_CONTROLS::CenterOnCursor(), COMMON_TOOLS::CursorControl(), PCB_CONTROL::DoSetGridOrigin(), COMMON_TOOLS::doZoomInOut(), drawBacksideTicks(), 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_RECTANGLE::Execute(), KIGFX::VIEW_OVERLAY::COMMAND_CIRCLE::Execute(), KIGFX::VIEW_OVERLAY::COMMAND_ARC::Execute(), KIGFX::VIEW_OVERLAY::COMMAND_POLYGON::Execute(), KIGFX::VIEW_OVERLAY::COMMAND_POLY_POLYGON::Execute(), KIGFX::VIEW_OVERLAY::COMMAND_POINT_POLYGON::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(), GRID_HELPER::GetGrid(), GRID_HELPER::GetOrigin(), KIGFX::WX_VIEW_CONTROLS::GetRawCursorPosition(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), PCB_VIEWER_TOOLS::MeasureTool(), COMMON_TOOLS::OnGridChanged(), PCB_POINT_EDITOR::OnSelectionChange(), COMMON_TOOLS::PanControl(), DIALOG_PAD_PROPERTIES::prepareCanvas(), KIGFX::WX_VIEW_CONTROLS::SetCrossHairCursorPosition(), KIGFX::VIEW_CONTROLS::ShowCursor(), PNS::TOOL_BASE::updateEndItem(), PNS::TOOL_BASE::updateStartItem(), PCB_BRIGHT_BOX::ViewDraw(), KIGFX::RATSNEST_VIEWITEM::ViewDraw(), KIGFX::PREVIEW::ARC_ASSISTANT::ViewDraw(), KIGFX::PREVIEW::RULER_ITEM::ViewDraw(), BRIGHT_BOX::ViewDraw(), KIGFX::ORIGIN_VIEWITEM::ViewDraw(), KIGFX::PREVIEW::TWO_POINT_ASSISTANT::ViewDraw(), KIGFX::PREVIEW::SIMPLE_OVERLAY_ITEM::ViewDraw(), MY_DRAWING::ViewDraw(), KIGFX::PREVIEW::SELECTION_AREA::ViewDraw(), KIGFX::VIEW_GROUP::ViewDraw(), ROUTER_PREVIEW_ITEM::ViewDraw(), KIGFX::WS_PROXY_VIEW_ITEM::ViewDraw(), EDIT_POINTS::ViewDraw(), and KIGFX::WX_VIEW_CONTROLS::WarpCursor().

◆ GetLayerOrder()

int KIGFX::VIEW::GetLayerOrder ( int  aLayer) const

Return rendering order of a particular layer.

Lower values are rendered first.

Parameters
aLayeris the layer.
Returns
Rendering order of a particular layer.

Definition at line 653 of file view.cpp.

654 {
655  return m_layers.at( aLayer ).renderingOrder;
656 }
std::vector< VIEW_LAYER > m_layers
Sorted list of pointers to members of m_layers.
Definition: view.h:807

References m_layers.

Referenced by PCB_DRAW_PANEL_GAL::SetTopLayer(), and SortLayers().

◆ GetPainter()

PAINTER* KIGFX::VIEW::GetPainter ( ) const
inline

Return the painter object used by the view for drawing #VIEW_ITEMS.

Returns
Pointer to the currently used Painter instance.

Definition at line 207 of file view.h.

208  {
209  return m_painter;
210  }
PAINTER * m_painter
Interface to #PAINTER that is used to draw items.
Definition: view.h:840

References m_painter.

Referenced by PCB_BASE_FRAME::ActivateGalCanvas(), KIGFX::WS_PROXY_VIEW_ITEM::buildDrawList(), DIALOG_NET_INSPECTOR::buildNetsList(), BOARD_INSPECTION_TOOL::ClearHighlight(), PL_EDITOR_FRAME::CommonSettingsChanged(), PCB_BASE_FRAME::CommonSettingsChanged(), PCB_GRID_HELPER::computeAnchors(), SYMBOL_PREVIEW_WIDGET::DisplayPart(), SYMBOL_PREVIEW_WIDGET::DisplaySymbol(), PL_DRAW_PANEL_GAL::DisplayWorksheet(), BOARD_INSPECTION_TOOL::doHideNet(), KIGFX::PREVIEW::POLYGON_ITEM::drawPreviewShape(), KIGFX::PREVIEW::DrawTextNextToCursor(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), GERBVIEW_DRAW_PANEL_GAL::GERBVIEW_DRAW_PANEL_GAL(), FOOTPRINT_PREVIEW_PANEL::GetBackgroundColor(), FOOTPRINT_PREVIEW_PANEL::GetForegroundColor(), ROUTER_PREVIEW_ITEM::getLayerColor(), SCH_BASE_FRAME::GetRenderSettings(), PNS::TOOL_BASE::highlightNet(), BOARD_INSPECTION_TOOL::HighlightNet(), BOARD_INSPECTION_TOOL::highlightNet(), PNS_KICAD_IFACE::IsItemVisible(), PCB_BASE_FRAME::LoadSettings(), DIALOG_PAD_PROPERTIES::onChangePadMode(), ZONE_CREATE_HELPER::OnFirstPoint(), APPEARANCE_CONTROLS::OnLayerAlphaChanged(), GERBER_LAYER_WIDGET::OnLayerColorChange(), APPEARANCE_CONTROLS::onNetclassColorChanged(), APPEARANCE_CONTROLS::onNetclassContextMenu(), DIALOG_NET_INSPECTOR::onSelChanged(), GERBVIEW_DRAW_PANEL_GAL::OnShow(), PCB_DRAW_PANEL_GAL::OnShow(), DIALOG_NET_INSPECTOR::onSortingChanged(), PCB_GRID_HELPER::PCB_GRID_HELPER(), DIALOG_PAD_PROPERTIES::prepareCanvas(), PCB_GRID_HELPER::queryVisible(), NET_GRID_TABLE::Rebuild(), APPEARANCE_CONTROLS::rebuildNets(), DIALOG_PAD_PROPERTIES::redraw(), FOOTPRINT_PREVIEW_PANEL::renderFootprint(), GERBVIEW_SELECTION_TOOL::Reset(), EE_SELECTION_TOOL::Reset(), PCB_SELECTION_TOOL::Reset(), PCB_SELECTION_TOOL::Selectable(), GERBVIEW_DRAW_PANEL_GAL::SetHighContrastLayer(), PCB_DRAW_PANEL_GAL::SetHighContrastLayer(), EDA_DRAW_PANEL_GAL::SetHighContrastLayer(), SYMBOL_PREVIEW_WIDGET::SYMBOL_PREVIEW_WIDGET(), PANEL_DISPLAY_OPTIONS::TransferDataFromWindow(), PANEL_PL_EDITOR_COLOR_SETTINGS::TransferDataFromWindow(), PANEL_EDIT_OPTIONS::TransferDataFromWindow(), PANEL_SYM_COLOR_SETTINGS::TransferDataFromWindow(), PANEL_EESCHEMA_COLOR_SETTINGS::TransferDataFromWindow(), PCB_DRAW_PANEL_GAL::UpdateColors(), KIGFX::PCB_VIEW::UpdateDisplayOptions(), NET_GRID_TABLE::updateNetColor(), PANEL_PCBNEW_COLOR_SETTINGS::updatePreview(), PANEL_EESCHEMA_COLOR_SETTINGS::updatePreview(), KIGFX::RATSNEST_VIEWITEM::ViewDraw(), KIGFX::PREVIEW::RULER_ITEM::ViewDraw(), KIGFX::PREVIEW::SELECTION_AREA::ViewDraw(), KIGFX::VIEW_GROUP::ViewDraw(), KIGFX::WS_PROXY_VIEW_ITEM::ViewDraw(), and EDIT_POINTS::ViewDraw().

◆ GetPrintMode()

int KIGFX::VIEW::GetPrintMode ( )
inline

Get the current print mode.

Return values less than or equal to zero indicate the current mode is the draw mode. Return values greater than zero indicate print mode.

Returns
the printing mode.

Definition at line 686 of file view.h.

686 { return m_printMode; }
int m_printMode
Definition: view.h:866

References m_printMode.

Referenced by PAD::ViewGetLOD().

◆ GetScale()

◆ GetScreenPixelSize()

const VECTOR2I & KIGFX::VIEW::GetScreenPixelSize ( ) const

Return the size of the our rendering area in pixels.

Returns
viewport screen size.

Definition at line 1155 of file view.cpp.

1156 {
1157  return m_gal->GetScreenPixelSize();
1158 }
GAL * m_gal
Dynamic VIEW (eg.
Definition: view.h:843
const VECTOR2I & GetScreenPixelSize() const
Returns GAL canvas size in pixels.

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

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

◆ GetTopLayer()

int KIGFX::VIEW::GetTopLayer ( ) const
virtual

Definition at line 829 of file view.cpp.

830 {
831  if( m_topLayers.size() == 0 )
832  return 0;
833 
834  return *m_topLayers.begin();
835 }
std::set< unsigned int > m_topLayers
Center point of the VIEW (the point at which we are looking at).
Definition: view.h:816

References m_topLayers.

Referenced by ROUTER_TOOL::getStartLayer(), PCB_SELECTION_TOOL::GuessSelectionCandidates(), PNS::TOOL_BASE::pickSingleItem(), and PNS::TOOL_BASE::updateStartItem().

◆ GetViewport()

BOX2D KIGFX::VIEW::GetViewport ( ) const

Return the current viewport visible area rectangle.

Returns
Current viewport rectangle.

Definition at line 519 of file view.cpp.

520 {
521  BOX2D rect;
522  VECTOR2D screenSize = m_gal->GetScreenPixelSize();
523 
524  rect.SetOrigin( ToWorld( VECTOR2D( 0, 0 ) ) );
525  rect.SetEnd( ToWorld( screenSize ) );
526 
527  return rect.Normalize();
528 }
VECTOR2D ToWorld(const VECTOR2D &aCoord, bool aAbsolute=true) const
Converts a screen space point/vector to a point/vector in world space coordinates.
Definition: view.cpp:456
GAL * m_gal
Dynamic VIEW (eg.
Definition: view.h:843
const VECTOR2I & GetScreenPixelSize() const
Returns GAL canvas size in pixels.
VECTOR2< double > VECTOR2D
Definition: vector2d.h:629
BOX2< Vec > & Normalize()
Function Normalize ensures that the height ant width are positive.
Definition: box2.h:129
void SetEnd(coord_type x, coord_type y)
Definition: box2.h:225
void SetOrigin(const Vec &pos)
Definition: box2.h:210

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

Referenced by drawBacksideTicks(), drawTicksAlongLine(), SCH_EDITOR_CONTROL::FindComponentAndItem(), EDA_DRAW_FRAME::FocusOnLocation(), PCB_SELECTION_TOOL::hitTestDistance(), and KIGFX::WX_VIEW_CONTROLS::UpdateScrollbars().

◆ Hide()

void KIGFX::VIEW::Hide ( VIEW_ITEM aItem,
bool  aHide = true 
)

Temporarily hide 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 1480 of file view.cpp.

1481 {
1482  auto viewData = aItem->viewPrivData();
1483 
1484  if( !viewData )
1485  return;
1486 
1487  if( !( viewData->m_flags & VISIBLE ) )
1488  return;
1489 
1490  if( aHide )
1491  viewData->m_flags |= HIDDEN;
1492  else
1493  viewData->m_flags &= ~HIDDEN;
1494 
1495  Update( aItem, APPEARANCE );
1496 }
Item is temporarily hidden (e.g.
Definition: view_item.h:66
Visibility flag has changed.
Definition: view_item.h:52
Item is visible (in general)
Definition: view_item.h:65
virtual void Update(const VIEW_ITEM *aItem, int aUpdateFlags) const
For dynamic VIEWs, inform the associated VIEW that the graphical representation of this item has chan...
Definition: view.cpp:1513

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

Referenced by AddToPreview(), KIGFX::SCH_VIEW::ClearHiddenFlags(), GERBVIEW_SELECTION_TOOL::disambiguationMenu(), PCB_SELECTION_TOOL::highlightInternal(), ROUTER_TOOL::InlineDrag(), SCH_MOVE_TOOL::moveItem(), SCH_EDITOR_CONTROL::Paste(), GERBVIEW_SELECTION_TOOL::selectVisually(), PCB_SELECTION_TOOL::unhighlightInternal(), and GERBVIEW_SELECTION_TOOL::unselectVisually().

◆ InitPreview()

void KIGFX::VIEW::InitPreview ( )

Definition at line 1547 of file view.cpp.

1548 {
1549  m_preview.reset( new KIGFX::VIEW_GROUP() );
1550  Add( m_preview.get() );
1551 }
std::unique_ptr< KIGFX::VIEW_GROUP > m_preview
Definition: view.h:798
Extend VIEW_ITEM by possibility of grouping items into a single object.
Definition: view_group.h:46
virtual void Add(VIEW_ITEM *aItem, int aDrawPriority=-1)
Add a VIEW_ITEM to the view.
Definition: view.cpp:327

References Add(), and m_preview.

Referenced by KIGFX::SCH_VIEW::DisplayComponent(), KIGFX::SCH_VIEW::DisplaySheet(), ROUTER_TOOL::InlineDrag(), and PCB_BASE_EDIT_FRAME::SetBoard().

◆ invalidateItem()

void KIGFX::VIEW::invalidateItem ( VIEW_ITEM aItem,
int  aUpdateFlags 
)
protected

Manage dirty flags & redraw queuing when updating an item.

Parameters
aItemis the item to be updated.
aUpdateFlagsdetermines the way an item is refreshed.Update colors that are used for an item to be drawn

Definition at line 1191 of file view.cpp.

1192 {
1193  if( aUpdateFlags & INITIAL_ADD )
1194  {
1195  // Don't update layers or bbox, since it was done in VIEW::Add()
1196  // Now that we have initialized, set flags to ALL for the code below
1197  aUpdateFlags = ALL;
1198  }
1199  else
1200  {
1201  // updateLayers updates geometry too, so we do not have to update both of them at the same time
1202  if( aUpdateFlags & LAYERS )
1203  {
1204  updateLayers( aItem );
1205  }
1206  else if( aUpdateFlags & GEOMETRY )
1207  {
1208  updateBbox( aItem );
1209  }
1210  }
1211 
1212  int layers[VIEW_MAX_LAYERS], layers_count;
1213  aItem->ViewGetLayers( layers, layers_count );
1214 
1215  // Iterate through layers used by the item and recache it immediately
1216  for( int i = 0; i < layers_count; ++i )
1217  {
1218  int layerId = layers[i];
1219 
1220  if( IsCached( layerId ) )
1221  {
1222  if( aUpdateFlags & ( GEOMETRY | LAYERS | REPAINT ) )
1223  updateItemGeometry( aItem, layerId );
1224  else if( aUpdateFlags & COLOR )
1225  updateItemColor( aItem, layerId );
1226  }
1227 
1228  // Mark those layers as dirty, so the VIEW will be refreshed
1229  MarkTargetDirty( m_layers[layerId].target );
1230  }
1231 
1232  aItem->viewPrivData()->clearUpdateFlags();
1233 }
Item is being added to the view.
Definition: view_item.h:56
void updateLayers(VIEW_ITEM *aItem)
Determine rendering order of layers. Used in display order sorting function.
Definition: view.cpp:1316
void updateItemColor(VIEW_ITEM *aItem, int aLayer)
Update all information needed to draw an item.
Definition: view.cpp:1251
Color has changed.
Definition: view_item.h:53
All except INITIAL_ADD.
Definition: view_item.h:58
static constexpr int VIEW_MAX_LAYERS
maximum number of layers that may be shown
Definition: view.h:696
Item needs to be redrawn.
Definition: view_item.h:57
void MarkTargetDirty(int aTarget)
Set or clear target 'dirty' flag.
Definition: view.h:570
void updateBbox(VIEW_ITEM *aItem)
Update set of layers that an item occupies.
Definition: view.cpp:1300
std::vector< VIEW_LAYER > m_layers
Sorted list of pointers to members of m_layers.
Definition: view.h:807
void updateItemGeometry(VIEW_ITEM *aItem, int aLayer)
Update bounding box of an item.
Definition: view.cpp:1270
bool IsCached(int aLayer) const
Return true if the layer is cached.
Definition: view.h:577
Layers have changed.
Definition: view_item.h:55
Position or shape has changed.
Definition: view_item.h:54

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

Referenced by UpdateItems().

◆ IsCached()

bool KIGFX::VIEW::IsCached ( int  aLayer) const
inline

Return true if the layer is cached.

Definition at line 577 of file view.h.

578  {
579  wxCHECK( aLayer < (int) m_layers.size(), false );
580 
581  try
582  {
583  return m_layers.at( aLayer ).target == TARGET_CACHED;
584  }
585  catch( const std::out_of_range& )
586  {
587  return false;
588  }
589  }
std::vector< VIEW_LAYER > m_layers
Sorted list of pointers to members of m_layers.
Definition: view.h:807
Main rendering target (cached)
Definition: definitions.h:48

References m_layers, and KIGFX::TARGET_CACHED.

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

◆ IsDirty()

bool KIGFX::VIEW::IsDirty ( ) const
inline

Return 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 542 of file view.h.

543  {
544  for( int i = 0; i < TARGETS_NUMBER; ++i )
545  {
546  if( IsTargetDirty( i ) )
547  return true;
548  }
549 
550  return false;
551  }
Number of available rendering targets.
Definition: definitions.h:51
bool IsTargetDirty(int aTarget) const
Return true if any of layers belonging to the target or the target itself should be redrawn.
Definition: view.h:559

References IsTargetDirty(), and KIGFX::TARGETS_NUMBER.

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

◆ IsDrawOrderReversed()

bool KIGFX::VIEW::IsDrawOrderReversed ( ) const
inline
Returns
true if draw order is reversed

Definition at line 647 of file view.h.

648  {
649  return m_reverseDrawOrder;
650  }
bool m_reverseDrawOrder
A control for printing: m_printMode <= 0 means no printing mode (normal draw mode m_printMode > 0 is ...
Definition: view.h:862

References m_reverseDrawOrder.

◆ IsDynamic()

bool KIGFX::VIEW::IsDynamic ( ) const
inline

Tell 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 532 of file view.h.

533  {
534  return m_dynamic;
535  }
bool m_dynamic
Flag to mark targets as dirty so they have to be redrawn on the next refresh event.
Definition: view.h:847

References m_dynamic.

◆ IsLayerVisible()

bool KIGFX::VIEW::IsLayerVisible ( int  aLayer) const
inline

◆ IsMirroredX()

◆ IsMirroredY()

bool KIGFX::VIEW::IsMirroredY ( ) const
inline

Return true if view is flipped across the Y axis.

Definition at line 245 of file view.h.

246  {
247  return m_mirrorY;
248  }
bool m_mirrorY
PAINTER contains information how do draw items.
Definition: view.h:837

References m_mirrorY.

◆ IsTargetDirty()

bool KIGFX::VIEW::IsTargetDirty ( int  aTarget) const
inline

Return 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 559 of file view.h.

560  {
561  wxCHECK( aTarget < TARGETS_NUMBER, false );
562  return m_dirtyTargets[aTarget];
563  }
Number of available rendering targets.
Definition: definitions.h:51
bool m_dirtyTargets[TARGETS_NUMBER]
Rendering order modifier for layers that are marked as top layers.
Definition: view.h:850

References m_dirtyTargets, and KIGFX::TARGETS_NUMBER.

Referenced by ClearTargets(), EDA_DRAW_PANEL_GAL::DoRePaint(), IsDirty(), and redrawRect().

◆ IsUsingDrawPriority()

bool KIGFX::VIEW::IsUsingDrawPriority ( ) const
inline
Returns
true if draw priority is being respected while redrawing.

Definition at line 631 of file view.h.

632  {
633  return m_useDrawPriority;
634  }
bool m_useDrawPriority
The next sequential drawing priority.
Definition: view.h:856

References m_useDrawPriority.

◆ IsVisible()

bool KIGFX::VIEW::IsVisible ( const VIEW_ITEM aItem) const

Return 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 1499 of file view.cpp.

1500 {
1501  const auto viewData = aItem->viewPrivData();
1502 
1503  return viewData && ( viewData->m_flags & VISIBLE );
1504 }
Item is visible (in general)
Definition: view_item.h:65

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

Referenced by EE_GRID_HELPER::BestSnapAnchor(), PCB_GRID_HELPER::BestSnapAnchor(), PCB_GRID_HELPER::computeAnchors(), PNS_KICAD_IFACE::HideItem(), PNS_KICAD_IFACE::IsItemVisible(), EE_GRID_HELPER::queryVisible(), PCB_GRID_HELPER::queryVisible(), and PCB_SELECTION_TOOL::Selectable().

◆ MakeOverlay()

std::shared_ptr< VIEW_OVERLAY > KIGFX::VIEW::MakeOverlay ( )

Definition at line 1526 of file view.cpp.

1527 {
1528  std::shared_ptr<VIEW_OVERLAY> overlay( new VIEW_OVERLAY );
1529 
1530  Add( overlay.get() );
1531  return overlay;
1532 }
virtual void Add(VIEW_ITEM *aItem, int aDrawPriority=-1)
Add a VIEW_ITEM to the view.
Definition: view.cpp:327

References Add().

Referenced by AUTOPLACE_TOOL::autoplace().

◆ MarkDirty()

void KIGFX::VIEW::MarkDirty ( )
inline

Force redraw of view on the next rendering.

Definition at line 594 of file view.h.

595  {
596  for( int i = 0; i < TARGETS_NUMBER; ++i )
597  m_dirtyTargets[i] = true;
598  }
Number of available rendering targets.
Definition: definitions.h:51
bool m_dirtyTargets[TARGETS_NUMBER]
Rendering order modifier for layers that are marked as top layers.
Definition: view.h:850

References m_dirtyTargets, and KIGFX::TARGETS_NUMBER.

Referenced by ClearTargets(), EDA_DRAW_PANEL_GAL::DoRePaint(), BOARD_EDITOR_CONTROL::DoSetDrillOrigin(), PCB_CONTROL::DoSetGridOrigin(), EDA_DRAW_FRAME::OnMove(), refreshCallback(), SetCenter(), SetGAL(), SetMirror(), SetScale(), sortLayers(), PANEL_EESCHEMA_DISPLAY_OPTIONS::TransferDataFromWindow(), PANEL_SETUP_FORMATTING::TransferDataFromWindow(), UpdateAllLayersColor(), UpdateAllLayersOrder(), and VIEW().

◆ MarkForUpdate()

void KIGFX::VIEW::MarkForUpdate ( VIEW_ITEM aItem)

Add 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.

◆ markTargetClean()

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

Definition at line 718 of file view.h.

719  {
720  wxCHECK( aTarget < TARGETS_NUMBER, /* void */ );
721  m_dirtyTargets[aTarget] = false;
722  }
Number of available rendering targets.
Definition: definitions.h:51
bool m_dirtyTargets[TARGETS_NUMBER]
Rendering order modifier for layers that are marked as top layers.
Definition: view.h:850

References m_dirtyTargets, and KIGFX::TARGETS_NUMBER.

Referenced by Redraw().

◆ MarkTargetDirty()

◆ OnDestroy()

void KIGFX::VIEW::OnDestroy ( VIEW_ITEM aItem)
static

Nasty hack, invoked by the destructor of VIEW_ITEM to auto-remove the item from the owning VIEW if there is any.

KiCad relies too much on this mechanism. This is the only linking dependency now between EDA_ITEM and VIEW class. In near future I'll replace it with observers.

Definition at line 253 of file view.cpp.

254 {
255  auto data = aItem->viewPrivData();
256 
257  if( !data )
258  return;
259 
260  if( data->m_view )
261  data->m_view->VIEW::Remove( aItem );
262 
263  delete data;
264  aItem->ClearViewPrivData();
265 }

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

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

◆ Query()

int KIGFX::VIEW::Query ( const BOX2I aRect,
std::vector< LAYER_ITEM_PAIR > &  aResult 
) const
virtual

Find 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 433 of file view.cpp.

434 {
435  if( m_orderedLayers.empty() )
436  return 0;
437 
438  std::vector<VIEW_LAYER*>::const_reverse_iterator i;
439 
440  // execute queries in reverse direction, so that items that are on the top of
441  // the rendering stack are returned first.
442  for( i = m_orderedLayers.rbegin(); i != m_orderedLayers.rend(); ++i )
443  {
444  // ignore layers that do not contain actual items (i.e. the selection box, menus, floats)
445  if( ( *i )->displayOnly || !( *i )->visible )
446  continue;
447 
448  queryVisitor<std::vector<LAYER_ITEM_PAIR> > visitor( aResult, ( *i )->id );
449  ( *i )->items->Query( aRect, visitor );
450  }
451 
452  return aResult.size();
453 }
std::vector< VIEW_LAYER * > m_orderedLayers
Flat list of all items.
Definition: view.h:810

References m_orderedLayers.

Referenced by DRAWING_TOOL::DrawVia(), EE_GRID_HELPER::queryVisible(), PCB_GRID_HELPER::queryVisible(), PCB_SELECTION_TOOL::SelectAll(), EE_SELECTION_TOOL::SelectAll(), EE_SELECTION_TOOL::selectMultiple(), and PCB_SELECTION_TOOL::selectMultiple().

◆ RecacheAllItems()

void KIGFX::VIEW::RecacheAllItems ( )

Rebuild GAL display lists.

Definition at line 1377 of file view.cpp.

1378 {
1379  BOX2I r;
1380 
1381  r.SetMaximum();
1382 
1383  for( const VIEW_LAYER& l : m_layers )
1384  {
1385  if( IsCached( l.id ) )
1386  {
1387  recacheItem visitor( this, m_gal, l.id );
1388  l.items->Query( r, visitor );
1389  }
1390  }
1391 }
GAL * m_gal
Dynamic VIEW (eg.
Definition: view.h:843
void SetMaximum()
Definition: box2.h:73
std::vector< VIEW_LAYER > m_layers
Sorted list of pointers to members of m_layers.
Definition: view.h:807
bool IsCached(int aLayer) const
Return true if the layer is cached.
Definition: view.h:577

References IsCached(), m_gal, m_layers, and BOX2< Vec >::SetMaximum().

Referenced by PCB_BASE_FRAME::ActivateGalCanvas(), GERBVIEW_FRAME::ActivateGalCanvas(), BOARD_EDITOR_CONTROL::FlipPcbView(), SCH_EDIT_TOOL::Mirror(), GERBVIEW_DRAW_PANEL_GAL::OnShow(), SYMBOL_EDITOR_DRAWING_TOOLS::PlaceAnchor(), SCH_DRAWING_TOOLS::PlaceImage(), SCH_EDIT_TOOL::Properties(), SCH_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_TOOL::Rotate(), PANEL_DISPLAY_OPTIONS::TransferDataFromWindow(), PANEL_GAL_DISPLAY_OPTIONS::TransferDataFromWindow(), and PANEL_EDIT_OPTIONS::TransferDataFromWindow().

◆ Redraw()

void KIGFX::VIEW::Redraw ( )
virtual

Immediately redraws the whole view.

Definition at line 1123 of file view.cpp.

1124 {
1125 #ifdef __WXDEBUG__
1126  PROF_COUNTER totalRealTime;
1127 #endif /* __WXDEBUG__ */
1128 
1129  VECTOR2D screenSize = m_gal->GetScreenPixelSize();
1130  BOX2D rect( ToWorld( VECTOR2D( 0, 0 ) ),
1131  ToWorld( screenSize ) - ToWorld( VECTOR2D( 0, 0 ) ) );
1132 
1133  rect.Normalize();
1134  BOX2I recti( rect.GetPosition(), rect.GetSize() );
1135 
1136  // The view rtree uses integer positions. Large screens can overflow
1137  // this size so in this case, simply set the rectangle to the full rtree
1138  if( rect.GetWidth() > std::numeric_limits<int>::max() ||
1139  rect.GetHeight() > std::numeric_limits<int>::max() )
1140  recti.SetMaximum();
1141 
1142  redrawRect( recti );
1143  // All targets were redrawn, so nothing is dirty
1147 
1148 #ifdef __WXDEBUG__
1149  totalRealTime.Stop();
1150  wxLogTrace( "GAL_PROFILE", "VIEW::Redraw(): %.1f ms", totalRealTime.msecs() );
1151 #endif /* __WXDEBUG__ */
1152 }
void Stop()
Save the time when this function was called, and set the counter stane to stop.
Definition: profile.h:85
VECTOR2D ToWorld(const VECTOR2D &aCoord, bool aAbsolute=true) const
Converts a screen space point/vector to a point/vector in world space coordinates.
Definition: view.cpp:456
double msecs(bool aSinceLast=false)
Definition: profile.h:146
GAL * m_gal
Dynamic VIEW (eg.
Definition: view.h:843
A small class to help profiling.
Definition: profile.h:45
Auxiliary rendering target (noncached)
Definition: definitions.h:49
const VECTOR2I & GetScreenPixelSize() const
Returns GAL canvas size in pixels.
VECTOR2< double > VECTOR2D
Definition: vector2d.h:629
void SetMaximum()
Definition: box2.h:73
Items that may change while the view stays the same (noncached)
Definition: definitions.h:50
void markTargetClean(int aTarget)
Definition: view.h:718
void redrawRect(const BOX2I &aRect)
Definition: view.cpp:988
Main rendering target (cached)
Definition: definitions.h:48

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

Referenced by EDA_DRAW_PANEL_GAL::DoRePaint().

◆ redrawRect()

void KIGFX::VIEW::redrawRect ( const BOX2I aRect)
protected
  • Redraws contents within rect aRect

Definition at line 988 of file view.cpp.

989 {
990  for( VIEW_LAYER* l : m_orderedLayers )
991  {
992  if( l->visible && IsTargetDirty( l->target ) && areRequiredLayersEnabled( l->id ) )
993  {
994  drawItem drawFunc( this, l->id, m_useDrawPriority, m_reverseDrawOrder );
995 
996  m_gal->SetTarget( l->target );
997  m_gal->SetLayerDepth( l->renderingOrder );
998  l->items->Query( aRect, drawFunc );
999 
1000  if( m_useDrawPriority )
1001  drawFunc.deferredDraw();
1002  }
1003  }
1004 }
bool m_useDrawPriority
The next sequential drawing priority.
Definition: view.h:856
GAL * m_gal
Dynamic VIEW (eg.
Definition: view.h:843
bool areRequiredLayersEnabled(int aLayerId) const
Definition: view.cpp:1359
virtual void SetLayerDepth(double aLayerDepth)
Set the depth of the layer (position on the z-axis)
bool IsTargetDirty(int aTarget) const
Return true if any of layers belonging to the target or the target itself should be redrawn.
Definition: view.h:559
bool m_reverseDrawOrder
A control for printing: m_printMode <= 0 means no printing mode (normal draw mode m_printMode > 0 is ...
Definition: view.h:862
std::vector< VIEW_LAYER * > m_orderedLayers
Flat list of all items.
Definition: view.h:810
virtual void SetTarget(RENDER_TARGET aTarget)
Sets the target for rendering.

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

Referenced by Redraw().

◆ Remove()

void KIGFX::VIEW::Remove ( VIEW_ITEM aItem)
virtual

Remove 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 357 of file view.cpp.

358 {
359  if( !aItem )
360  return;
361 
362  auto viewData = aItem->viewPrivData();
363 
364  if( !viewData )
365  return;
366 
367  wxCHECK( viewData->m_view == this, /*void*/ );
368  auto item = std::find( m_allItems->begin(), m_allItems->end(), aItem );
369 
370  if( item != m_allItems->end() )
371  {
372  m_allItems->erase( item );
373  viewData->clearUpdateFlags();
374  }
375 
376  int layers[VIEW::VIEW_MAX_LAYERS], layers_count;
377  viewData->getLayers( layers, layers_count );
378 
379  for( int i = 0; i < layers_count; ++i )
380  {
381  VIEW_LAYER& l = m_layers[layers[i]];
382  l.items->Remove( aItem );
383  MarkTargetDirty( l.target );
384 
385  // Clear the GAL cache
386  int prevGroup = viewData->getGroup( layers[i] );
387 
388  if( prevGroup >= 0 )
389  m_gal->DeleteGroup( prevGroup );
390  }
391 
392  viewData->deleteGroups();
393  viewData->m_view = nullptr;
394 }
virtual void DeleteGroup(int aGroupNumber)
Delete the group from the memory.
GAL * m_gal
Dynamic VIEW (eg.
Definition: view.h:843
static constexpr int VIEW_MAX_LAYERS
maximum number of layers that may be shown
Definition: view.h:696
std::shared_ptr< std::vector< VIEW_ITEM * > > m_allItems
The set of layers that are displayed on the top.
Definition: view.h:813
void MarkTargetDirty(int aTarget)
Set or clear target 'dirty' flag.
Definition: view.h:570
std::vector< VIEW_LAYER > m_layers
Sorted list of pointers to members of m_layers.
Definition: view.h:807

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

Referenced by EDA_DRAW_PANEL_GAL::ClearDebugOverlay(), GERBVIEW_SELECTION_TOOL::disambiguationMenu(), SYMBOL_PREVIEW_WIDGET::DisplayPart(), SYMBOL_PREVIEW_WIDGET::DisplaySymbol(), PL_EDIT_TOOL::DoDelete(), PCB_SELECTION_TOOL::doSelectionMenu(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawSegment(), EE_POINT_EDITOR::Main(), PL_POINT_EDITOR::Main(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), DRAWING_TOOL::PlaceImportedGraphics(), BOARD_COMMIT::Push(), KIGFX::PCB_VIEW::Remove(), EDIT_TOOL::Remove(), SCH_BASE_FRAME::RemoveFromScreen(), BOARD_EDITOR_CONTROL::Reset(), PCB_CONTROL::Reset(), GERBVIEW_SELECTION_TOOL::Reset(), EE_SELECTION_TOOL::Reset(), BOARD_COMMIT::Revert(), PL_SELECTION_TOOL::selectMultiple(), EE_SELECTION_TOOL::selectMultiple(), ZOOM_TOOL::selectRegion(), WS_DATA_ITEM::SyncDrawItems(), WS_DATA_ITEM_POLYGONS::SyncDrawItems(), WS_DATA_ITEM_TEXT::SyncDrawItems(), WS_DATA_ITEM_BITMAP::SyncDrawItems(), DIALOG_ERC::testErc(), GERBVIEW_SELECTION_TOOL::unselect(), EE_POINT_EDITOR::updatePoints(), PCB_POINT_EDITOR::updatePoints(), SYMBOL_VIEWER_FRAME::updatePreviewSymbol(), EE_SELECTION_TOOL::~EE_SELECTION_TOOL(), GERBVIEW_SELECTION_TOOL::~GERBVIEW_SELECTION_TOOL(), PCB_SELECTION_TOOL::~PCB_SELECTION_TOOL(), SYMBOL_PREVIEW_WIDGET::~SYMBOL_PREVIEW_WIDGET(), SYMBOL_VIEWER_FRAME::~SYMBOL_VIEWER_FRAME(), ~VIEW(), and ZONE_CREATE_HELPER::~ZONE_CREATE_HELPER().

◆ ReorderLayerData()

void KIGFX::VIEW::ReorderLayerData ( std::unordered_map< int, int >  aReorderMap)

Remap 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 687 of file view.cpp.

688 {
689  std::vector<VIEW_LAYER> new_map;
690  new_map.reserve( m_layers.size() );
691 
692  for( int ii = 0; ii < VIEW_MAX_LAYERS; ++ii )
693  new_map.emplace_back();
694 
695  for( const VIEW_LAYER& layer : m_layers )
696  {
697  int orig_idx = layer.id;
698  int new_idx = orig_idx;
699 
700  if( aReorderMap.count( orig_idx ) )
701  new_idx = aReorderMap.at( orig_idx );
702 
703  new_map[new_idx] = layer;
704  new_map[new_idx].id = new_idx;
705  }
706 
707  m_layers = new_map;
708 
709  for( VIEW_ITEM* item : *m_allItems )
710  {
711  auto viewData = item->viewPrivData();
712 
713  if( !viewData )
714  continue;
715 
716  int layers[VIEW::VIEW_MAX_LAYERS], layers_count;
717 
718  item->ViewGetLayers( layers, layers_count );
719  viewData->saveLayers( layers, layers_count );
720 
721  viewData->reorderGroups( aReorderMap );
722 
723  viewData->m_requiredUpdate |= COLOR;
724  }
725 
726  UpdateItems();
727 }
friend class VIEW_ITEM
Definition: view.h:70
Color has changed.
Definition: view_item.h:53
static constexpr int VIEW_MAX_LAYERS
maximum number of layers that may be shown
Definition: view.h:696
std::shared_ptr< std::vector< VIEW_ITEM * > > m_allItems
The set of layers that are displayed on the top.
Definition: view.h:813
void UpdateItems()
Iterate through the list of items that asked for updating and updates them.
Definition: view.cpp:1394
std::vector< VIEW_LAYER > m_layers
Sorted list of pointers to members of m_layers.
Definition: view.h:807

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

Referenced by GERBVIEW_FRAME::SortLayersByX2Attributes().

◆ ReverseDrawOrder()

void KIGFX::VIEW::ReverseDrawOrder ( bool  aFlag)
inline

Only takes effect if UseDrawPriority is true.

Parameters
aFlagis true if draw order should be reversed

Definition at line 657 of file view.h.

658  {
659  m_reverseDrawOrder = aFlag;
660  }
bool m_reverseDrawOrder
A control for printing: m_printMode <= 0 means no printing mode (normal draw mode m_printMode > 0 is ...
Definition: view.h:862

References m_reverseDrawOrder.

Referenced by EDA_DRAW_PANEL_GAL::SwitchBackend().

◆ SetBoundary() [1/2]

void KIGFX::VIEW::SetBoundary ( const BOX2D aBoundary)
inline

Set limits for view area.

Parameters
aBoundaryis the box that limits view area.

Definition at line 273 of file view.h.

274  {
275  m_boundary = aBoundary;
276  }
BOX2D m_boundary
Scale lower limit.
Definition: view.h:825

References m_boundary.

Referenced by PL_DRAW_PANEL_GAL::DisplayWorksheet(), DIALOG_PAD_PROPERTIES::redraw(), and SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME().

◆ SetBoundary() [2/2]

void KIGFX::VIEW::SetBoundary ( const BOX2I aBoundary)
inline

Set limits for view area.

Parameters
aBoundaryis the box that limits view area.

Definition at line 283 of file view.h.

284  {
285  m_boundary.SetOrigin( aBoundary.GetOrigin() );
286  m_boundary.SetEnd( aBoundary.GetEnd() );
287  }
const Vec GetEnd() const
Definition: box2.h:195
void SetEnd(coord_type x, coord_type y)
Definition: box2.h:225
BOX2D m_boundary
Scale lower limit.
Definition: view.h:825
void SetOrigin(const Vec &pos)
Definition: box2.h:210
const Vec & GetOrigin() const
Definition: box2.h:193

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

◆ SetCenter() [1/2]

void KIGFX::VIEW::SetCenter ( const VECTOR2D aCenter)

Set 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 585 of file view.cpp.

586 {
587  m_center = aCenter;
588 
589  if( !m_boundary.Contains( aCenter ) )
590  {
591  if( m_center.x < m_boundary.GetLeft() )
593  else if( aCenter.x > m_boundary.GetRight() )
595 
596  if( m_center.y < m_boundary.GetTop() )
598  else if( m_center.y > m_boundary.GetBottom() )
600  }
601 
604 
605  // Redraw everything after the viewport has changed
606  MarkDirty();
607 }
coord_type GetTop() const
Definition: box2.h:204
GAL * m_gal
Dynamic VIEW (eg.
Definition: view.h:843
coord_type GetRight() const
Definition: box2.h:199
coord_type GetBottom() const
Definition: box2.h:200
virtual void ComputeWorldScreenMatrix()
Compute the world <-> screen transformation matrix.
VECTOR2D m_center
Scale of displayed VIEW_ITEMs.
Definition: view.h:819
bool Contains(const Vec &aPoint) const
Function Contains.
Definition: box2.h:151
BOX2D m_boundary
Scale lower limit.
Definition: view.h:825
void SetLookAtPoint(const VECTOR2D &aPoint)
Set the Point in world space to look at.
coord_type GetLeft() const
Definition: box2.h:203
void MarkDirty()
Force redraw of view on the next rendering.
Definition: view.h:594

References KIGFX::GAL::ComputeWorldScreenMatrix(), BOX2< Vec >::Contains(), BOX2< Vec >::GetBottom(), BOX2< Vec >::GetLeft(), BOX2< Vec >::GetRight(), BOX2< Vec >::GetTop(), m_boundary, m_center, m_gal, 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(), COMMON_TOOLS::doZoomFit(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), SYMBOL_PREVIEW_WIDGET::fitOnDrawArea(), EDA_DRAW_FRAME::FocusOnLocation(), KIGFX::WX_VIEW_CONTROLS::onMotion(), KIGFX::WX_VIEW_CONTROLS::onScroll(), EDA_DRAW_PANEL_GAL::onSize(), KIGFX::WX_VIEW_CONTROLS::onTimer(), KIGFX::WX_VIEW_CONTROLS::onWheel(), SYMBOL_EDITOR_DRAWING_TOOLS::PlaceAnchor(), SCH_BASE_FRAME::RedrawScreen(), ZOOM_TOOL::selectRegion(), SetCenter(), KIGFX::WX_VIEW_CONTROLS::SetCrossHairCursorPosition(), SetGAL(), SetScale(), SetViewport(), KIGFX::WX_VIEW_CONTROLS::WarpCursor(), PANEL_PCBNEW_COLOR_SETTINGS::zoomFitPreview(), and PCB_SELECTION_TOOL::zoomFitSelection().

◆ SetCenter() [2/2]

void KIGFX::VIEW::SetCenter ( VECTOR2D  aCenter,
const BOX2D occultingScreenRect 
)

Set 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 610 of file view.cpp.

611 {
612  BOX2D screenRect( VECTOR2D( 0, 0 ), m_gal->GetScreenPixelSize() );
613 
614  if( !screenRect.Intersects( occultingScreenRect ) )
615  {
616  SetCenter( aCenter );
617  return;
618  }
619 
620  BOX2D occultedRect = screenRect.Intersect( occultingScreenRect );
621  double topExposed = occultedRect.GetTop() - screenRect.GetTop();
622  double bottomExposed = screenRect.GetBottom() - occultedRect.GetBottom();
623  double leftExposed = occultedRect.GetLeft() - screenRect.GetLeft();
624  double rightExposed = screenRect.GetRight() - occultedRect.GetRight();
625 
626  if( std::max( topExposed, bottomExposed ) > std::max( leftExposed, rightExposed ) )
627  {
628  if( topExposed > bottomExposed )
629  aCenter.y += ToWorld( screenRect.GetHeight() / 2 - topExposed / 2 );
630  else
631  aCenter.y -= ToWorld( screenRect.GetHeight() / 2 - bottomExposed / 2 );
632  }
633  else
634  {
635  if( leftExposed > rightExposed )
636  aCenter.x += ToWorld( screenRect.GetWidth() / 2 - leftExposed / 2 );
637  else
638  aCenter.x -= ToWorld( screenRect.GetWidth() / 2 - rightExposed / 2 );
639  }
640 
641  SetCenter( aCenter );
642 }
VECTOR2D ToWorld(const VECTOR2D &aCoord, bool aAbsolute=true) const
Converts a screen space point/vector to a point/vector in world space coordinates.
Definition: view.cpp:456
coord_type GetTop() const
Definition: box2.h:204
GAL * m_gal
Dynamic VIEW (eg.
Definition: view.h:843
coord_type GetRight() const
Definition: box2.h:199
coord_type GetBottom() const
Definition: box2.h:200
const VECTOR2I & GetScreenPixelSize() const
Returns GAL canvas size in pixels.
void SetCenter(const VECTOR2D &aCenter)
Set the center point of the VIEW (i.e.
Definition: view.cpp:585
VECTOR2< double > VECTOR2D
Definition: vector2d.h:629
coord_type GetLeft() const
Definition: box2.h:203
BOX2< Vec > Intersect(const BOX2< Vec > &aRect)
Function Intersect Returns the intersection of this with another rectangle.
Definition: box2.h:268

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

◆ SetGAL()

void KIGFX::VIEW::SetGAL ( GAL aGal)

Assign a rendering device for the VIEW.

Parameters
aGalpointer to the GAL output device.

Definition at line 500 of file view.cpp.

501 {
502  bool recacheGroups = ( m_gal != nullptr ); // recache groups only if GAL is reassigned
503  m_gal = aGal;
504 
505  // clear group numbers, so everything is going to be recached
506  if( recacheGroups )
507  clearGroupCache();
508 
509  // every target has to be refreshed
510  MarkDirty();
511 
512  // force the new GAL to display the current viewport.
513  SetCenter( m_center );
514  SetScale( m_scale );
516 }
GAL * m_gal
Dynamic VIEW (eg.
Definition: view.h:843
void SetMirror(bool aMirrorX, bool aMirrorY)
Control the mirroring of the VIEW.
Definition: view.cpp:546
VECTOR2D m_center
Scale of displayed VIEW_ITEMs.
Definition: view.h:819
void SetCenter(const VECTOR2D &aCenter)
Set the center point of the VIEW (i.e.
Definition: view.cpp:585
bool m_mirrorX
Vertical flip flag.
Definition: view.h:834
virtual void SetScale(double aScale, VECTOR2D aAnchor={ 0, 0 })
Set the scaling factor, zooming around a given anchor point.
Definition: view.cpp:559
void clearGroupCache()
Definition: view.cpp:1179
bool m_mirrorY
PAINTER contains information how do draw items.
Definition: view.h:837
double m_scale
View boundaries.
Definition: view.h:822
void MarkDirty()
Force redraw of view on the next rendering.
Definition: view.h:594

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

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

◆ SetLayerDisplayOnly()

void KIGFX::VIEW::SetLayerDisplayOnly ( int  aLayer,
bool  aDisplayOnly = true 
)
inline

Definition at line 410 of file view.h.

411  {
412  wxCHECK( aLayer < (int) m_layers.size(), /*void*/ );
413  m_layers[aLayer].displayOnly = aDisplayOnly;
414  }
std::vector< VIEW_LAYER > m_layers
Sorted list of pointers to members of m_layers.
Definition: view.h:807

References m_layers.

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

◆ SetLayerOrder()

void KIGFX::VIEW::SetLayerOrder ( int  aLayer,
int  aRenderingOrder 
)

Set rendering order of a particular layer.

Lower values are rendered first.

Parameters
aLayeris the layer.
aRenderingOrderis an arbitrary number denoting the rendering order.

Definition at line 645 of file view.cpp.

646 {
647  m_layers[aLayer].renderingOrder = aRenderingOrder;
648 
649  sortLayers();
650 }
void sortLayers()
Clear cached GAL group numbers (ONLY numbers stored in VIEW_ITEMs, not group objects used by GAL)
Definition: view.cpp:1236
std::vector< VIEW_LAYER > m_layers
Sorted list of pointers to members of m_layers.
Definition: view.h:807

References m_layers, and sortLayers().

Referenced by SCH_DRAW_PANEL::setDefaultLayerOrder(), SCH_PREVIEW_PANEL::setDefaultLayerOrder(), PCB_DRAW_PANEL_GAL::setDefaultLayerOrder(), GERBVIEW_DRAW_PANEL_GAL::SetTopLayer(), and PCB_DRAW_PANEL_GAL::SetTopLayer().

◆ SetLayerTarget()

void KIGFX::VIEW::SetLayerTarget ( int  aLayer,
RENDER_TARGET  aTarget 
)
inline

Change the rendering target for a particular layer.

Parameters
aLayeris the layer.
aTargetis the rendering target.

Definition at line 422 of file view.h.

423  {
424  wxCHECK( aLayer < (int) m_layers.size(), /*void*/ );
425  m_layers[aLayer].target = aTarget;
426  }
std::vector< VIEW_LAYER > m_layers
Sorted list of pointers to members of m_layers.
Definition: view.h:807

References m_layers.

Referenced by PL_DRAW_PANEL_GAL::setDefaultLayerDeps(), SCH_DRAW_PANEL::setDefaultLayerDeps(), SCH_PREVIEW_PANEL::setDefaultLayerDeps(), GERBVIEW_DRAW_PANEL_GAL::setDefaultLayerDeps(), PCB_DRAW_PANEL_GAL::setDefaultLayerDeps(), and BOARD_PRINTOUT::setupViewLayers().

◆ SetLayerVisible()

void KIGFX::VIEW::SetLayerVisible ( int  aLayer,
bool  aVisible = true 
)
inline

Control the visibility of a particular layer.

Parameters
aLayeris the layer to show/hide.
aVisibleis the layer visibility state.

Definition at line 387 of file view.h.

388  {
389  wxCHECK( aLayer < (int) m_layers.size(), /*void*/ );
390 
391  if( m_layers[aLayer].visible != aVisible )
392  {
393  // Target has to be redrawn after changing its visibility
394  MarkTargetDirty( m_layers[aLayer].target );
395  m_layers[aLayer].visible = aVisible;
396  }
397  }
void MarkTargetDirty(int aTarget)
Set or clear target 'dirty' flag.
Definition: view.h:570
std::vector< VIEW_LAYER > m_layers
Sorted list of pointers to members of m_layers.
Definition: view.h:807

References m_layers, and MarkTargetDirty().

Referenced by APPEARANCE_CONTROLS::onLayerVisibilityChanged(), APPEARANCE_CONTROLS::onObjectVisibilityChanged(), GERBER_LAYER_WIDGET::OnRenderEnable(), PL_EDITOR_FRAME::OnSelectPage(), PL_DRAW_PANEL_GAL::PL_DRAW_PANEL_GAL(), GERBVIEW_FRAME::SetElementVisibility(), APPEARANCE_CONTROLS::SetLayerVisible(), APPEARANCE_CONTROLS::SetObjectVisible(), GERBVIEW_PRINTOUT::setupViewLayers(), PCBNEW_PRINTOUT::setupViewLayers(), BOARD_PRINTOUT::setupViewLayers(), GERBVIEW_FRAME::SetVisibleLayers(), APPEARANCE_CONTROLS::setVisibleLayers(), APPEARANCE_CONTROLS::setVisibleObjects(), PCB_DRAW_PANEL_GAL::SyncLayersVisibility(), and PCB_EDIT_FRAME::UpdateUserInterface().

◆ SetMirror()

void KIGFX::VIEW::SetMirror ( bool  aMirrorX,
bool  aMirrorY 
)

Control the mirroring of the VIEW.

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

Definition at line 546 of file view.cpp.

547 {
548  wxASSERT_MSG( !aMirrorY, _( "Mirroring for Y axis is not supported yet" ) );
549 
550  m_mirrorX = aMirrorX;
551  m_mirrorY = aMirrorY;
552  m_gal->SetFlip( aMirrorX, aMirrorY );
553 
554  // Redraw everything
555  MarkDirty();
556 }
void SetFlip(bool xAxis, bool yAxis)
Sets flipping of the screen.
GAL * m_gal
Dynamic VIEW (eg.
Definition: view.h:843
bool m_mirrorX
Vertical flip flag.
Definition: view.h:834
#define _(s)
Definition: 3d_actions.cpp:33
bool m_mirrorY
PAINTER contains information how do draw items.
Definition: view.h:837
void MarkDirty()
Force redraw of view on the next rendering.
Definition: view.h:594

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

Referenced by GERBVIEW_CONTROL::DisplayControl(), BOARD_EDITOR_CONTROL::FlipPcbView(), SCH_DRAW_PANEL::SCH_DRAW_PANEL(), SCH_PREVIEW_PANEL::SCH_PREVIEW_PANEL(), and SetGAL().

◆ SetPainter()

void KIGFX::VIEW::SetPainter ( PAINTER aPainter)
inline

Set the painter object used by the view for drawing #VIEW_ITEMS.

Definition at line 197 of file view.h.

198  {
199  m_painter = aPainter;
200  }
PAINTER * m_painter
Interface to #PAINTER that is used to draw items.
Definition: view.h:840

References m_painter.

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

◆ SetPrintMode()

void KIGFX::VIEW::SetPrintMode ( int  aPrintMode)
inline

Set the printing mode.

Parameters
aPrintModeis the printing mode. If 0, the current mode is not a printing mode, just the draw mode

Definition at line 694 of file view.h.

694 { m_printMode = aPrintMode; }
int m_printMode
Definition: view.h:866

References m_printMode.

Referenced by VIEW().

◆ SetRequired()

void KIGFX::VIEW::SetRequired ( int  aLayerId,
int  aRequiredId,
bool  aRequired = true 
)

Mark 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 397 of file view.cpp.

398 {
399  wxCHECK( (unsigned) aLayerId < m_layers.size(), /*void*/ );
400  wxCHECK( (unsigned) aRequiredId < m_layers.size(), /*void*/ );
401 
402  if( aRequired )
403  m_layers[aLayerId].requiredLayers.insert( aRequiredId );
404  else
405  m_layers[aLayerId].requiredLayers.erase( aRequired );
406 }
std::vector< VIEW_LAYER > m_layers
Sorted list of pointers to members of m_layers.
Definition: view.h:807

References m_layers.

Referenced by PCB_DRAW_PANEL_GAL::setDefaultLayerDeps().

◆ SetScale()

void KIGFX::VIEW::SetScale ( double  aScale,
VECTOR2D  aAnchor = { 0, 0 } 
)
virtual

Set the scaling factor, zooming around a given anchor point.

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

Parameters
aAnchoris the zooming anchor point.
aScaleis the scale factor.

Reimplemented in KIGFX::SCH_VIEW.

Definition at line 559 of file view.cpp.

560 {
561  if( aAnchor == VECTOR2D( 0, 0 ) )
562  aAnchor = m_center;
563 
564  VECTOR2D a = ToScreen( aAnchor );
565 
566  if( aScale < m_minScale )
568  else if( aScale > m_maxScale )
570  else
571  m_scale = aScale;
572 
575 
576  VECTOR2D delta = ToWorld( a ) - aAnchor;
577 
578  SetCenter( m_center - delta );
579 
580  // Redraw everything after the viewport has changed
581  MarkDirty();
582 }
VECTOR2D ToWorld(const VECTOR2D &aCoord, bool aAbsolute=true) const
Converts a screen space point/vector to a point/vector in world space coordinates.
Definition: view.cpp:456
GAL * m_gal
Dynamic VIEW (eg.
Definition: view.h:843
virtual void ComputeWorldScreenMatrix()
Compute the world <-> screen transformation matrix.
VECTOR2D m_center
Scale of displayed VIEW_ITEMs.
Definition: view.h:819
double m_minScale
Scale upper limit.
Definition: view.h:828
void SetCenter(const VECTOR2D &aCenter)
Set the center point of the VIEW (i.e.
Definition: view.cpp:585
VECTOR2< double > VECTOR2D
Definition: vector2d.h:629
VECTOR2D ToScreen(const VECTOR2D &aCoord, bool aAbsolute=true) const
Convert a world space point/vector to a point/vector in screen space coordinates.
Definition: view.cpp:475
double m_maxScale
Horizontal flip flag.
Definition: view.h:831
void SetZoomFactor(double aZoomFactor)
Set the zoom factor of the scene.
double m_scale
View boundaries.
Definition: view.h:822
void MarkDirty()
Force redraw of view on the next rendering.
Definition: view.h:594

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

Referenced by COMMON_TOOLS::doZoomFit(), COMMON_TOOLS::doZoomToPreset(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), SCH_EDITOR_CONTROL::FindComponentAndItem(), SYMBOL_PREVIEW_WIDGET::fitOnDrawArea(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), KIGFX::WX_VIEW_CONTROLS::onMotion(), KIGFX::WX_VIEW_CONTROLS::onWheel(), FOOTPRINT_PREVIEW_PANEL::renderFootprint(), ZOOM_TOOL::selectRegion(), SetGAL(), KIGFX::SCH_VIEW::SetScale(), SetViewport(), PANEL_PCBNEW_COLOR_SETTINGS::zoomFitPreview(), PANEL_EESCHEMA_COLOR_SETTINGS::zoomFitPreview(), and PCB_SELECTION_TOOL::zoomFitSelection().

◆ SetScaleLimits()

void KIGFX::VIEW::SetScaleLimits ( double  aMaximum,
double  aMinimum 
)
inline

Set minimum and maximum values for scale.

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

Definition at line 303 of file view.h.

304  {
305  wxASSERT_MSG( aMaximum > aMinimum, wxT( "I guess you passed parameters in wrong order" ) );
306 
307  m_minScale = aMinimum;
308  m_maxScale = aMaximum;
309  }
double m_minScale
Scale upper limit.
Definition: view.h:828
double m_maxScale
Horizontal flip flag.
Definition: view.h:831

References m_maxScale, and m_minScale.

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

◆ SetTopLayer()

void KIGFX::VIEW::SetTopLayer ( int  aLayer,
bool  aEnabled = true 
)
virtual

Set 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.
aLayeris the layer or -1 in case when no particular layer should be displayed on the top.

Definition at line 838 of file view.cpp.

839 {
840  if( aEnabled )
841  {
842  if( m_topLayers.count( aLayer ) == 1 )
843  return;
844 
845  m_topLayers.insert( aLayer );
846 
847  // Move the layer closer to front
849  m_layers[aLayer].renderingOrder += TOP_LAYER_MODIFIER;
850  }
851  else
852  {
853  if( m_topLayers.count( aLayer ) == 0 )
854  return;
855 
856  m_topLayers.erase( aLayer );
857 
858  // Restore the previous rendering order
860  m_layers[aLayer].renderingOrder -= TOP_LAYER_MODIFIER;
861  }
862 }
static const int TOP_LAYER_MODIFIER
Flag to respect draw priority when drawing items.
Definition: view.h:853
std::set< unsigned int > m_topLayers
Center point of the VIEW (the point at which we are looking at).
Definition: view.h:816
std::vector< VIEW_LAYER > m_layers
Sorted list of pointers to members of m_layers.
Definition: view.h:807
bool m_enableOrderModifier
The set of possible displayed layers and its properties.
Definition: view.h:804

References m_enableOrderModifier, m_layers, m_topLayers, and TOP_LAYER_MODIFIER.

Referenced by DIALOG_PAD_PROPERTIES::redraw(), GERBVIEW_DRAW_PANEL_GAL::SetTopLayer(), PL_DRAW_PANEL_GAL::SetTopLayer(), PCB_DRAW_PANEL_GAL::SetTopLayer(), EDA_DRAW_PANEL_GAL::SetTopLayer(), PCBNEW_PRINTOUT::setupViewLayers(), and BOARD_PRINTOUT::setupViewLayers().

◆ SetViewport()

void KIGFX::VIEW::SetViewport ( const BOX2D aViewport)

Set the visible area of the VIEW.

Parameters
aViewportdesired visible area, in world space coordinates.

Definition at line 531 of file view.cpp.

532 {
533  VECTOR2D ssize = ToWorld( m_gal->GetScreenPixelSize(), false );
534 
535  wxCHECK( ssize.x > 0 && ssize.y > 0, /*void*/ );
536 
537  VECTOR2D centre = aViewport.Centre();
538  VECTOR2D vsize = aViewport.GetSize();
539  double zoom = 1.0 / std::max( fabs( vsize.x / ssize.x ), fabs( vsize.y / ssize.y ) );
540 
541  SetCenter( centre );
542  SetScale( GetScale() * zoom );
543 }
VECTOR2D ToWorld(const VECTOR2D &aCoord, bool aAbsolute=true) const
Converts a screen space point/vector to a point/vector in world space coordinates.
Definition: view.cpp:456
GAL * m_gal
Dynamic VIEW (eg.
Definition: view.h:843
const VECTOR2I & GetScreenPixelSize() const
Returns GAL canvas size in pixels.
void SetCenter(const VECTOR2D &aCenter)
Set the center point of the VIEW (i.e.
Definition: view.cpp:585
virtual void SetScale(double aScale, VECTOR2D aAnchor={ 0, 0 })
Set the scaling factor, zooming around a given anchor point.
Definition: view.cpp:559
Vec Centre() const
Definition: box2.h:79
const Vec & GetSize() const
Definition: box2.h:189
double GetScale() const
Definition: view.h:263

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

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

◆ SetVisible()

void KIGFX::VIEW::SetVisible ( VIEW_ITEM aItem,
bool  aIsVisible = true 
)

Set the item visibility.

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

Definition at line 1459 of file view.cpp.

1460 {
1461  auto viewData = aItem->viewPrivData();
1462 
1463  if( !viewData )
1464  return;
1465 
1466  bool cur_visible = viewData->m_flags & VISIBLE;
1467 
1468  if( cur_visible != aIsVisible )
1469  {
1470  if( aIsVisible )
1471  viewData->m_flags |= VISIBLE;
1472  else
1473  viewData->m_flags &= ~VISIBLE;
1474 
1475  Update( aItem, APPEARANCE | COLOR );
1476  }
1477 }
Visibility flag has changed.
Definition: view_item.h:52
Color has changed.
Definition: view_item.h:53
Item is visible (in general)
Definition: view_item.h:65
virtual void Update(const VIEW_ITEM *aItem, int aUpdateFlags) const
For dynamic VIEWs, inform the associated VIEW that the graphical representation of this item has chan...
Definition: view.cpp:1513

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

Referenced by Add(), AddToPreview(), EE_GRID_HELPER::BestSnapAnchor(), PCB_GRID_HELPER::BestSnapAnchor(), MICROWAVE_TOOL::drawMicrowaveInductor(), EE_GRID_HELPER::EE_GRID_HELPER(), PNS_KICAD_IFACE::EraseView(), PNS_KICAD_IFACE::HideItem(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), ZONE_CREATE_HELPER::OnComplete(), ZONE_CREATE_HELPER::OnFirstPoint(), PCB_GRID_HELPER::PCB_GRID_HELPER(), FOOTPRINT_PREVIEW_PANEL::renderFootprint(), PL_SELECTION_TOOL::selectMultiple(), EE_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::selectMultiple(), ZOOM_TOOL::selectRegion(), GRID_HELPER::SetAuxAxes(), ShowPreview(), and ZONE_CREATE_HELPER::~ZONE_CREATE_HELPER().

◆ ShowPreview()

void KIGFX::VIEW::ShowPreview ( bool  aShow = true)

Definition at line 1568 of file view.cpp.

1569 {
1570  SetVisible( m_preview.get(), aShow );
1571 }
std::unique_ptr< KIGFX::VIEW_GROUP > m_preview
Definition: view.h:798
void SetVisible(VIEW_ITEM *aItem, bool aIsVisible=true)
Set the item visibility.
Definition: view.cpp:1459

References m_preview, and SetVisible().

Referenced by SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SCH_LINE_WIRE_BUS_TOOL::finishSegments(), and ROUTER_TOOL::InlineDrag().

◆ SortLayers()

void KIGFX::VIEW::SortLayers ( int  aLayers[],
int &  aCount 
) const

Change 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 659 of file view.cpp.

660 {
661  int maxLay, maxOrd, maxIdx;
662 
663  for( int i = 0; i < aCount; ++i )
664  {
665  maxLay = aLayers[i];
666  maxOrd = GetLayerOrder( maxLay );
667  maxIdx = i;
668 
669  // Look for the max element in the range (j..aCount)
670  for( int j = i; j < aCount; ++j )
671  {
672  if( maxOrd < GetLayerOrder( aLayers[j] ) )
673  {
674  maxLay = aLayers[j];
675  maxOrd = GetLayerOrder( maxLay );
676  maxIdx = j;
677  }
678  }
679 
680  // Swap elements
681  aLayers[maxIdx] = aLayers[i];
682  aLayers[i] = maxLay;
683  }
684 }
int GetLayerOrder(int aLayer) const
Return rendering order of a particular layer.
Definition: view.cpp:653

References GetLayerOrder().

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

◆ sortLayers()

void KIGFX::VIEW::sortLayers ( )
protected

Clear cached GAL group numbers (ONLY numbers stored in VIEW_ITEMs, not group objects used by GAL)

Definition at line 1236 of file view.cpp.

1237 {
1238  int n = 0;
1239 
1240  m_orderedLayers.resize( m_layers.size() );
1241 
1242  for( VIEW_LAYER& layer : m_layers )
1243  m_orderedLayers[n++] = &layer;
1244 
1245  sort( m_orderedLayers.begin(), m_orderedLayers.end(), compareRenderingOrder );
1246 
1247  MarkDirty();
1248 }
std::vector< VIEW_LAYER > m_layers
Sorted list of pointers to members of m_layers.
Definition: view.h:807
std::vector< VIEW_LAYER * > m_orderedLayers
Flat list of all items.
Definition: view.h:810
static bool compareRenderingOrder(VIEW_LAYER *aI, VIEW_LAYER *aJ)
Check if every layer required by the aLayerId layer is enabled.
Definition: view.h:783
void MarkDirty()
Force redraw of view on the next rendering.
Definition: view.h:594

References compareRenderingOrder(), m_layers, m_orderedLayers, and MarkDirty().

Referenced by SetLayerOrder(), UpdateAllLayersOrder(), and VIEW().

◆ ToScreen() [1/2]

VECTOR2D KIGFX::VIEW::ToScreen ( const VECTOR2D aCoord,
bool  aAbsolute = true 
) const

Convert a world space point/vector to a point/vector in screen space coordinates.

Parameters
aCoordis the point/vector to be converted.
aAbsolutewhen true aCoord is treated as a point, otherwise as a direction (vector).

Definition at line 475 of file view.cpp.

476 {
477  const MATRIX3x3D& matrix = m_gal->GetWorldScreenMatrix();
478 
479  if( aAbsolute )
480  return VECTOR2D( matrix * aCoord );
481  else
482  return VECTOR2D( matrix.GetScale().x * aCoord.x, matrix.GetScale().y * aCoord.y );
483 }
GAL * m_gal
Dynamic VIEW (eg.
Definition: view.h:843
VECTOR2< T > GetScale() const
Get the scale components of the matrix.
Definition: matrix3x3.h:269
VECTOR2< double > VECTOR2D
Definition: vector2d.h:629
const MATRIX3x3D & GetWorldScreenMatrix() const
Get the world <-> screen transformation matrix.

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

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

◆ ToScreen() [2/2]

double KIGFX::VIEW::ToScreen ( double  aSize) const

Convert a world space one dimensional size to a one dimensional size in screen space.

Parameters
aSizethe size to be transformed.

Definition at line 486 of file view.cpp.

487 {
488  const MATRIX3x3D& matrix = m_gal->GetWorldScreenMatrix();
489 
490  return matrix.GetScale().x * aSize;
491 }
GAL * m_gal
Dynamic VIEW (eg.
Definition: view.h:843
VECTOR2< T > GetScale() const
Get the scale components of the matrix.
Definition: matrix3x3.h:269
const MATRIX3x3D & GetWorldScreenMatrix() const
Get the world <-> screen transformation matrix.

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

◆ ToWorld() [1/2]

VECTOR2D KIGFX::VIEW::ToWorld ( const VECTOR2D aCoord,
bool  aAbsolute = true 
) const

Converts a screen space point/vector to a point/vector in world space coordinates.

Parameters
aCoordis the point/vector to be converted.
aAbsolutewhen true aCoord is treated as a point, otherwise as a direction (vector).

Definition at line 456 of file view.cpp.

457 {
458  const MATRIX3x3D& matrix = m_gal->GetScreenWorldMatrix();
459 
460  if( aAbsolute )
461  return VECTOR2D( matrix * aCoord );
462  else
463  return VECTOR2D( matrix.GetScale().x * aCoord.x, matrix.GetScale().y * aCoord.y );
464 }
const MATRIX3x3D & GetScreenWorldMatrix() const
Get the screen <-> world transformation matrix.
GAL * m_gal
Dynamic VIEW (eg.
Definition: view.h:843
VECTOR2< T > GetScale() const
Get the scale components of the matrix.
Definition: matrix3x3.h:269
VECTOR2< double > VECTOR2D
Definition: vector2d.h:629

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

Referenced by EE_POINT_EDITOR::addCornerCondition(), COMMON_TOOLS::CenterContents(), COMMON_TOOLS::doZoomFit(), KIGFX::PREVIEW::POLYGON_ITEM::drawPreviewShape(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), EDIT_POINTS::FindPoint(), SYMBOL_PREVIEW_WIDGET::fitOnDrawArea(), GENERAL_COLLECTORS_GUIDE::GENERAL_COLLECTORS_GUIDE(), KIGFX::WX_VIEW_CONTROLS::GetMousePosition(), GetViewport(), KIGFX::WS_PROXY_VIEW_ITEM::HitTestWorksheetItems(), KIGFX::WX_VIEW_CONTROLS::onMotion(), KIGFX::WX_VIEW_CONTROLS::onScroll(), EDA_DRAW_PANEL_GAL::onSize(), KIGFX::WX_VIEW_CONTROLS::onTimer(), KIGFX::WX_VIEW_CONTROLS::onWheel(), Redraw(), KIGFX::WX_VIEW_CONTROLS::refreshMouse(), PL_SELECTION_TOOL::selectionContains(), EE_SELECTION_TOOL::selectionContains(), ZOOM_TOOL::selectRegion(), SetCenter(), SetScale(), SetViewport(), KIGFX::ORIGIN_VIEWITEM::ViewDraw(), EDIT_POINTS::ViewDraw(), PANEL_PCBNEW_COLOR_SETTINGS::zoomFitPreview(), and PCB_SELECTION_TOOL::zoomFitSelection().

◆ ToWorld() [2/2]

double KIGFX::VIEW::ToWorld ( double  aSize) const

Converts a screen space one dimensional size to a one dimensional size in world space coordinates.

Parameters
aSizeis the size to be converted.

Definition at line 467 of file view.cpp.

468 {
469  const MATRIX3x3D& matrix = m_gal->GetScreenWorldMatrix();
470 
471  return fabs( matrix.GetScale().x * aSize );
472 }
const MATRIX3x3D & GetScreenWorldMatrix() const
Get the screen <-> world transformation matrix.
GAL * m_gal
Dynamic VIEW (eg.
Definition: view.h:843
VECTOR2< T > GetScale() const
Get the scale components of the matrix.
Definition: matrix3x3.h:269

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

◆ Update() [1/2]

void KIGFX::VIEW::Update ( const VIEW_ITEM aItem,
int  aUpdateFlags 
) const
virtual

For dynamic VIEWs, inform 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 1513 of file view.cpp.

1514 {
1515  VIEW_ITEM_DATA* viewData = aItem->viewPrivData();
1516 
1517  if( !viewData )
1518  return;
1519 
1520  assert( aUpdateFlags != NONE );
1521 
1522  viewData->m_requiredUpdate |= aUpdateFlags;
1523 }
No updates are required.
Definition: view_item.h:51

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

Referenced by Add(), PNS_PCBNEW_DEBUG_DECORATOR::AddLine(), AddToPreview(), EE_GRID_HELPER::BestSnapAnchor(), PCB_GRID_HELPER::BestSnapAnchor(), SCH_EDIT_TOOL::ChangeTextType(), PNS_PCBNEW_DEBUG_DECORATOR::Clear(), ClearPreview(), PL_SELECTION_TOOL::ClearSelection(), EE_SELECTION_TOOL::ClearSelection(), PNS_KICAD_IFACE::DisplayItem(), PNS_KICAD_IFACE::DisplayRatline(), draw(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawSegment(), PL_DRAWING_TOOLS::DrawShape(), PAD_TOOL::EnumeratePads(), PNS_KICAD_IFACE::EraseView(), DIALOG_ERC::ExcludeMarker(), Hide(), PNS_KICAD_IFACE::HideItem(), PL_SELECTION_TOOL::highlight(), EE_SELECTION_TOOL::highlight(), EE_SELECTION_TOOL::Main(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), EDIT_TOOL::MoveExact(), PL_EDIT_TOOL::moveItem(), PROPERTIES_FRAME::OnAcceptPrms(), DIALOG_ERC::OnERCItemRClick(), ZONE_CREATE_HELPER::OnGeometryChange(), PCB_POINT_EDITOR::OnSelectionChange(), KIGFX::VIEW::recacheItem::operator()(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), BOARD_EDITOR_CONTROL::PlaceModule(), DRAWING_TOOL::PlaceText(), BOARD_COMMIT::Push(), SCH_EDIT_FRAME::RecalculateConnections(), SCH_EDIT_FRAME::RecomputeIntersheetRefs(), DIALOG_PAD_PROPERTIES::redraw(), PCB_DRAW_PANEL_GAL::RedrawRatsnest(), SCH_BASE_FRAME::RefreshSelection(), PL_SELECTION_TOOL::selectMultiple(), EE_SELECTION_TOOL::selectMultiple(), ZOOM_TOOL::selectRegion(), GERBVIEW_SELECTION_TOOL::selectVisually(), SetVisible(), SCH_EDIT_FRAME::TestDanglingEnds(), DIALOG_JUNCTION_PROPS::TransferDataFromWindow(), PL_SELECTION_TOOL::unhighlight(), EE_SELECTION_TOOL::unhighlight(), PCB_BASE_EDIT_FRAME::unitsChangeRefresh(), GERBVIEW_SELECTION_TOOL::unselectVisually(), KIGFX::PCB_VIEW::Update(), Update(), PL_POINT_EDITOR::updateItem(), PCB_POINT_EDITOR::updateItem(), EE_TOOL_BASE< SCH_BASE_FRAME >::updateItem(), SCH_BASE_FRAME::UpdateItem(), SCH_EDITOR_CONTROL::UpdateNetHighlighting(), EE_POINT_EDITOR::updateParentItem(), EE_POINT_EDITOR::updatePoints(), PL_POINT_EDITOR::updatePoints(), PCB_POINT_EDITOR::updatePoints(), PCB_SELECTION_TOOL::updateSelection(), and SCH_EDIT_FRAME::UpdateSymbolFromEditor().

◆ Update() [2/2]

void KIGFX::VIEW::Update ( const VIEW_ITEM aItem) const
virtual

Reimplemented in KIGFX::PCB_VIEW.

Definition at line 1507 of file view.cpp.

1508 {
1509  Update( aItem, ALL );
1510 }
All except INITIAL_ADD.
Definition: view_item.h:58
virtual void Update(const VIEW_ITEM *aItem, int aUpdateFlags) const
For dynamic VIEWs, inform the associated VIEW that the graphical representation of this item has chan...
Definition: view.cpp:1513

References KIGFX::ALL, and Update().

◆ UpdateAllItems()

void KIGFX::VIEW::UpdateAllItems ( int  aUpdateFlags)

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

Parameters
aUpdateFlagsis is according to KIGFX::VIEW_UPDATE_FLAGS

Definition at line 1417 of file view.cpp.

1418 {
1419  for( VIEW_ITEM* item : *m_allItems )
1420  {
1421  auto viewData = item->viewPrivData();
1422 
1423  if( !viewData )
1424  continue;
1425 
1426  viewData->m_requiredUpdate |= aUpdateFlags;
1427  }
1428 }
friend class VIEW_ITEM
Definition: view.h:70
std::shared_ptr< std::vector< VIEW_ITEM * > > m_allItems
The set of layers that are displayed on the top.
Definition: view.h:813

References m_allItems.

Referenced by PL_EDITOR_FRAME::CommonSettingsChanged(), SCH_BASE_FRAME::CommonSettingsChanged(), PCB_BASE_FRAME::CommonSettingsChanged(), SCH_BASE_FRAME::HardRedraw(), GERBVIEW_CONTROL::HighlightControl(), SCH_EDIT_FRAME::KiwayMailIn(), DIALOG_NET_INSPECTOR::onRenameNet(), SYMBOL_EDITOR_CONTROL::ShowElectricalTypes(), SCH_BASE_FRAME::SyncView(), SCH_EDITOR_CONTROL::ToggleHiddenFields(), SCH_EDITOR_CONTROL::ToggleHiddenPins(), PANEL_EESCHEMA_DISPLAY_OPTIONS::TransferDataFromWindow(), PANEL_SETUP_FORMATTING::TransferDataFromWindow(), PANEL_PCBNEW_COLOR_SETTINGS::updatePreview(), and PANEL_EESCHEMA_COLOR_SETTINGS::updatePreview().

◆ UpdateAllItemsConditionally()

void KIGFX::VIEW::UpdateAllItemsConditionally ( int  aUpdateFlags,
std::function< bool(VIEW_ITEM *)>  aCondition 
)

Update 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 1431 of file view.cpp.

1433 {
1434  for( VIEW_ITEM* item : *m_allItems )
1435  {
1436  if( aCondition( item ) )
1437  {
1438  auto viewData = item->viewPrivData();
1439 
1440  if( !viewData )
1441  continue;
1442 
1443  viewData->m_requiredUpdate |= aUpdateFlags;
1444  }
1445  }
1446 }
friend class VIEW_ITEM
Definition: view.h:70
std::shared_ptr< std::vector< VIEW_ITEM * > > m_allItems
The set of layers that are displayed on the top.
Definition: view.h:813

References m_allItems.

Referenced by SCH_EDIT_FRAME::OnModify(), PCB_BASE_FRAME::SetDisplayOptions(), GERBVIEW_FRAME::SetElementVisibility(), and GERBVIEW_FRAME::UpdateDisplayOptions().

◆ UpdateAllLayersColor()

void KIGFX::VIEW::UpdateAllLayersColor ( )

Apply the new coloring scheme to all layers.

The used scheme is held by #RENDER_SETTINGS.

See also
RENDER_SETTINGS

Definition at line 776 of file view.cpp.

777 {
778  if( m_gal->IsVisible() )
779  {
780  GAL_UPDATE_CONTEXT ctx( m_gal );
781 
782  for( VIEW_ITEM* item : *m_allItems )
783  {
784  auto viewData = item->viewPrivData();
785 
786  if( !viewData )
787  continue;
788 
789  int layers[VIEW::VIEW_MAX_LAYERS], layers_count;
790  viewData->getLayers( layers, layers_count );
791 
792  for( int i = 0; i < layers_count; ++i )
793  {
794  const COLOR4D color = m_painter->GetSettings()->GetColor( item, layers[i] );
795  int group = viewData->getGroup( layers[i] );
796 
797  if( group >= 0 )
798  m_gal->ChangeGroupColor( group, color );
799  }
800  }
801  }
802 
803  MarkDirty();
804 }
friend class VIEW_ITEM
Definition: view.h:70
int color
Definition: DXF_plotter.cpp:60
GAL * m_gal
Dynamic VIEW (eg.
Definition: view.h:843
static constexpr int VIEW_MAX_LAYERS
maximum number of layers that may be shown
Definition: view.h:696
std::shared_ptr< std::vector< VIEW_ITEM * > > m_allItems
The set of layers that are displayed on the top.
Definition: view.h:813
virtual void ChangeGroupColor(int aGroupNumber, const COLOR4D &aNewColor)
Changes the color used to draw the group.
PAINTER * m_painter
Interface to #PAINTER that is used to draw items.
Definition: view.h:840
virtual COLOR4D GetColor(const VIEW_ITEM *aItem, int aLayer) const =0
Returns the color that should be used to draw the specific VIEW_ITEM on the specific layer using curr...
virtual RENDER_SETTINGS * GetSettings()=0
Return a pointer to current settings that are going to be used when drawing items.
virtual bool IsVisible() const
Returns true if the GAL canvas is visible on the screen.
void MarkDirty()
Force redraw of view on the next rendering.
Definition: view.h:594
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:98

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

Referenced by DIALOG_NET_INSPECTOR::buildNetsList(), BOARD_INSPECTION_TOOL::ClearHighlight(), FOOTPRINT_EDIT_FRAME::CommonSettingsChanged(), EnableTopLayer(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), PNS::TOOL_BASE::highlightNet(), BOARD_INSPECTION_TOOL::HighlightNet(), BOARD_INSPECTION_TOOL::highlightNet(), APPEARANCE_CONTROLS::onNetclassColorChanged(), APPEARANCE_CONTROLS::onNetclassContextMenu(), APPEARANCE_CONTROLS::onNetColorModeChanged(), DIALOG_NET_INSPECTOR::onSelChanged(), DIALOG_NET_INSPECTOR::onSortingChanged(), GERBVIEW_DRAW_PANEL_GAL::SetHighContrastLayer(), PCB_DRAW_PANEL_GAL::SetHighContrastLayer(), EDA_DRAW_PANEL_GAL::SetHighContrastLayer(), and NET_GRID_TABLE::updateNetColor().

◆ UpdateAllLayersOrder()

void KIGFX::VIEW::UpdateAllLayersOrder ( )

Do 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 905 of file view.cpp.

906 {
907  sortLayers();
908 
909  if( m_gal->IsVisible() )
910  {
911  GAL_UPDATE_CONTEXT ctx( m_gal );
912 
913  for( VIEW_ITEM* item : *m_allItems )
914  {
915  auto viewData = item->viewPrivData();
916 
917  if( !viewData )
918  continue;
919 
920  int layers[VIEW::VIEW_MAX_LAYERS], layers_count;
921  viewData->getLayers( layers, layers_count );
922 
923  for( int i = 0; i < layers_count; ++i )
924  {
925  int group = viewData->getGroup( layers[i] );
926 
927  if( group >= 0 )
928  m_gal->ChangeGroupDepth( group, m_layers[layers[i]].renderingOrder );
929  }
930  }
931  }
932 
933  MarkDirty();
934 }
void sortLayers()
Clear cached GAL group numbers (ONLY numbers stored in VIEW_ITEMs, not group objects used by GAL)
Definition: view.cpp:1236
friend class VIEW_ITEM
Definition: view.h:70
GAL * m_gal
Dynamic VIEW (eg.
Definition: view.h:843
static constexpr int VIEW_MAX_LAYERS
maximum number of layers that may be shown
Definition: view.h:696
std::shared_ptr< std::vector< VIEW_ITEM * > > m_allItems
The set of layers that are displayed on the top.
Definition: view.h:813
std::vector< VIEW_LAYER > m_layers
Sorted list of pointers to members of m_layers.
Definition: view.h:807
virtual bool IsVisible() const
Returns true if the GAL canvas is visible on the screen.
virtual void ChangeGroupDepth(int aGroupNumber, int aDepth)
Changes the depth (Z-axis position) of the group.
void MarkDirty()
Force redraw of view on the next rendering.
Definition: view.h:594

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

Referenced by EnableTopLayer(), SCH_DRAW_PANEL::SCH_DRAW_PANEL(), SCH_PREVIEW_PANEL::SCH_PREVIEW_PANEL(), GERBVIEW_DRAW_PANEL_GAL::SetTopLayer(), PL_DRAW_PANEL_GAL::SetTopLayer(), PCB_DRAW_PANEL_GAL::SetTopLayer(), and EDA_DRAW_PANEL_GAL::SetTopLayer().

◆ updateBbox()

void KIGFX::VIEW::updateBbox ( VIEW_ITEM aItem)
protected

Update set of layers that an item occupies.

Definition at line 1300 of file view.cpp.

1301 {
1302  int layers[VIEW_MAX_LAYERS], layers_count;
1303 
1304  aItem->ViewGetLayers( layers, layers_count );
1305 
1306  for( int i = 0; i < layers_count; ++i )
1307  {
1308  VIEW_LAYER& l = m_layers[layers[i]];
1309  l.items->Remove( aItem );
1310  l.items->Insert( aItem );
1311  MarkTargetDirty( l.target );
1312  }
1313 }
static constexpr int VIEW_MAX_LAYERS
maximum number of layers that may be shown
Definition: view.h:696
void MarkTargetDirty(int aTarget)
Set or clear target 'dirty' flag.
Definition: view.h:570
std::vector< VIEW_LAYER > m_layers
Sorted list of pointers to members of m_layers.
Definition: view.h:807

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

Referenced by invalidateItem().

◆ updateItemColor()

void KIGFX::VIEW::updateItemColor ( VIEW_ITEM aItem,
int  aLayer 
)
protected

Update all information needed to draw an item.

Definition at line 1251 of file view.cpp.

1252 {
1253  auto viewData = aItem->viewPrivData();
1254  wxCHECK( (unsigned) aLayer < m_layers.size(), /*void*/ );
1255  wxCHECK( IsCached( aLayer ), /*void*/ );
1256 
1257  if( !viewData )
1258  return;
1259 
1260  // Obtain the color that should be used for coloring the item on the specific layerId
1261  const COLOR4D color = m_painter->GetSettings()->GetColor( aItem, aLayer );
1262  int group = viewData->getGroup( aLayer );
1263 
1264  // Change the color, only if it has group assigned
1265  if( group >= 0 )
1266  m_gal->ChangeGroupColor( group, color );
1267 }
int color
Definition: DXF_plotter.cpp:60
GAL * m_gal
Dynamic VIEW (eg.
Definition: view.h:843
virtual void ChangeGroupColor(int aGroupNumber, const COLOR4D &aNewColor)
Changes the color used to draw the group.
PAINTER * m_painter
Interface to #PAINTER that is used to draw items.
Definition: view.h:840
std::vector< VIEW_LAYER > m_layers
Sorted list of pointers to members of m_layers.
Definition: view.h:807
virtual COLOR4D GetColor(const VIEW_ITEM *aItem, int aLayer) const =0
Returns the color that should be used to draw the specific VIEW_ITEM on the specific layer using curr...
virtual RENDER_SETTINGS * GetSettings()=0
Return a pointer to current settings that are going to be used when drawing items.
bool IsCached(int aLayer) const
Return true if the layer is cached.
Definition: view.h:577
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:98

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

Referenced by invalidateItem().

◆ updateItemGeometry()

void KIGFX::VIEW::updateItemGeometry ( VIEW_ITEM aItem,
int  aLayer 
)
protected

Update bounding box of an item.

Definition at line 1270 of file view.cpp.

1271 {
1272  auto viewData = aItem->viewPrivData();
1273  wxCHECK( (unsigned) aLayer < m_layers.size(), /*void*/ );
1274  wxCHECK( IsCached( aLayer ), /*void*/ );
1275 
1276  if( !viewData )
1277  return;
1278 
1279  VIEW_LAYER& l = m_layers.at( aLayer );
1280 
1281  m_gal->SetTarget( l.target );
1282  m_gal->SetLayerDepth( l.renderingOrder );
1283 
1284  // Redraw the item from scratch
1285  int group = viewData->getGroup( aLayer );
1286 
1287  if( group >= 0 )
1288  m_gal->DeleteGroup( group );
1289 
1290  group = m_gal->BeginGroup();
1291  viewData->setGroup( aLayer, group );
1292 
1293  if( !m_painter->Draw( static_cast<EDA_ITEM*>( aItem ), aLayer ) )
1294  aItem->ViewDraw( aLayer, this ); // Alternative drawing method
1295 
1296  m_gal->EndGroup();
1297 }
virtual void DeleteGroup(int aGroupNumber)
Delete the group from the memory.
GAL * m_gal
Dynamic VIEW (eg.
Definition: view.h:843
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
Interface to #PAINTER that is used to draw items.
Definition: view.h:840
std::vector< VIEW_LAYER > m_layers
Sorted list of pointers to members of m_layers.
Definition: view.h:807
virtual bool Draw(const VIEW_ITEM *aItem, int aLayer)=0
Takes an instance of VIEW_ITEM and passes it to a function that knows how to draw the item.
bool IsCached(int aLayer) const
Return true if the layer is cached.
Definition: view.h:577
virtual void SetTarget(RENDER_TARGET aTarget)
Sets the target for rendering.

References KIGFX::GAL::BeginGroup(), KIGFX::GAL::DeleteGroup(), KIGFX::PAINTER::Draw(), KIGFX::GAL::EndGroup(), IsCached(), m_gal, m_layers, 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 invalidateItem().

◆ UpdateItems()

void KIGFX::VIEW::UpdateItems ( )

Iterate through the list of items that asked for updating and updates them.

Definition at line 1394 of file view.cpp.

1395 {
1396  if( m_gal->IsVisible() )
1397  {
1398  GAL_UPDATE_CONTEXT ctx( m_gal );
1399 
1400  for( VIEW_ITEM* item : *m_allItems )
1401  {
1402  auto viewData = item->viewPrivData();
1403 
1404  if( !viewData )
1405  continue;
1406 
1407  if( viewData->m_requiredUpdate != NONE )
1408  {
1409  invalidateItem( item, viewData->m_requiredUpdate );
1410  viewData->m_requiredUpdate = NONE;
1411  }
1412  }
1413  }
1414 }
friend class VIEW_ITEM
Definition: view.h:70
GAL * m_gal
Dynamic VIEW (eg.
Definition: view.h:843
std::shared_ptr< std::vector< VIEW_ITEM * > > m_allItems
The set of layers that are displayed on the top.
Definition: view.h:813
void invalidateItem(VIEW_ITEM *aItem, int aUpdateFlags)
Manage dirty flags & redraw queuing when updating an item.
Definition: view.cpp:1191
No updates are required.
Definition: view_item.h:51
virtual bool IsVisible() const
Returns true if the GAL canvas is visible on the screen.

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

Referenced by EDA_DRAW_PANEL_GAL::DoRePaint(), PL_SELECTION_TOOL::doSelectionMenu(), EE_SELECTION_TOOL::doSelectionMenu(), SCH_DRAW_PANEL::OnShow(), PCB_DRAW_PANEL_GAL::OnShow(), ReorderLayerData(), and SCH_EDITOR_CONTROL::UpdateFind().

◆ UpdateLayerColor()

void KIGFX::VIEW::UpdateLayerColor ( int  aLayer)

Apply 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 755 of file view.cpp.

756 {
757  // There is no point in updating non-cached layers
758  if( !IsCached( aLayer ) )
759  return;
760 
761  BOX2I r;
762 
763  r.SetMaximum();
764 
765  if( m_gal->IsVisible() )
766  {
767  GAL_UPDATE_CONTEXT ctx( m_gal );
768 
769  updateItemsColor visitor( aLayer, m_painter, m_gal );
770  m_layers[aLayer].items->Query( r, visitor );
771  MarkTargetDirty( m_layers[aLayer].target );
772  }
773 }
GAL * m_gal
Dynamic VIEW (eg.
Definition: view.h:843
void MarkTargetDirty(int aTarget)
Set or clear target 'dirty' flag.
Definition: view.h:570
void SetMaximum()
Definition: box2.h:73
PAINTER * m_painter
Interface to #PAINTER that is used to draw items.
Definition: view.h:840
std::vector< VIEW_LAYER > m_layers
Sorted list of pointers to members of m_layers.
Definition: view.h:807
bool IsCached(int aLayer) const
Return true if the layer is cached.
Definition: view.h:577
virtual bool IsVisible() const
Returns true if the GAL canvas is visible on the screen.

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

Referenced by PCB_CONTROL::LayerAlphaDec(), PCB_CONTROL::LayerAlphaInc(), APPEARANCE_CONTROLS::OnColorSwatchChanged(), and GERBER_LAYER_WIDGET::OnLayerColorChange().

◆ updateLayers()

void KIGFX::VIEW::updateLayers ( VIEW_ITEM aItem)
protected

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

Definition at line 1316 of file view.cpp.

1317 {
1318  auto viewData = aItem->viewPrivData();
1319  int layers[VIEW_MAX_LAYERS], layers_count;
1320 
1321  if( !viewData )
1322  return;
1323 
1324  // Remove the item from previous layer set
1325  viewData->getLayers( layers, layers_count );
1326 
1327  for( int i = 0; i < layers_count; ++i )
1328  {
1329  VIEW_LAYER& l = m_layers[layers[i]];
1330  l.items->Remove( aItem );
1331  MarkTargetDirty( l.target );
1332 
1333  if( IsCached( l.id ) )
1334  {
1335  // Redraw the item from scratch
1336  int prevGroup = viewData->getGroup( layers[i] );
1337 
1338  if( prevGroup >= 0 )
1339  {
1340  m_gal->DeleteGroup( prevGroup );
1341  viewData->setGroup( l.id, -1 );
1342  }
1343  }
1344  }
1345 
1346  // Add the item to new layer set
1347  aItem->ViewGetLayers( layers, layers_count );
1348  viewData->saveLayers( layers, layers_count );
1349 
1350  for( int i = 0; i < layers_count; i++ )
1351  {
1352  VIEW_LAYER& l = m_layers[layers[i]];
1353  l.items->Insert( aItem );
1354  MarkTargetDirty( l.target );
1355  }
1356 }
virtual void DeleteGroup(int aGroupNumber)
Delete the group from the memory.
GAL * m_gal
Dynamic VIEW (eg.
Definition: view.h:843
static constexpr int VIEW_MAX_LAYERS
maximum number of layers that may be shown
Definition: view.h:696
void MarkTargetDirty(int aTarget)
Set or clear target 'dirty' flag.
Definition: view.h:570
std::vector< VIEW_LAYER > m_layers
Sorted list of pointers to members of m_layers.
Definition: view.h:807
bool IsCached(int aLayer) const
Return true if the layer is cached.
Definition: view.h:577

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

Referenced by invalidateItem().

◆ UseDrawPriority()

void KIGFX::VIEW::UseDrawPriority ( bool  aFlag)
inline
Parameters
aFlagis true if draw priority should be respected while redrawing.

Definition at line 639 of file view.h.

640  {
641  m_useDrawPriority = aFlag;
642  }
bool m_useDrawPriority
The next sequential drawing priority.
Definition: view.h:856

References m_useDrawPriority.

Friends And Related Function Documentation

◆ VIEW_ITEM

friend class VIEW_ITEM
friend

Definition at line 70 of file view.h.

Member Data Documentation

◆ m_allItems

std::shared_ptr<std::vector<VIEW_ITEM*> > KIGFX::VIEW::m_allItems
protected

◆ m_boundary

BOX2D KIGFX::VIEW::m_boundary
protected

◆ m_center

VECTOR2D KIGFX::VIEW::m_center
protected

Scale of displayed VIEW_ITEMs.

Definition at line 819 of file view.h.

Referenced by GetCenter(), SetCenter(), SetGAL(), and SetScale().

◆ m_dirtyTargets

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

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

Definition at line 850 of file view.h.

Referenced by IsTargetDirty(), MarkDirty(), markTargetClean(), and MarkTargetDirty().

◆ m_dynamic

bool KIGFX::VIEW::m_dynamic
protected

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

Definition at line 847 of file view.h.

Referenced by IsDynamic().

◆ m_enableOrderModifier

bool KIGFX::VIEW::m_enableOrderModifier
protected

The set of possible displayed layers and its properties.

Definition at line 804 of file view.h.

Referenced by ClearTopLayers(), EnableTopLayer(), and SetTopLayer().

◆ m_gal

GAL* KIGFX::VIEW::m_gal
protected

◆ m_layers

◆ m_maxScale

double KIGFX::VIEW::m_maxScale
protected

Horizontal flip flag.

Definition at line 831 of file view.h.

Referenced by SetScale(), and SetScaleLimits().

◆ m_minScale

double KIGFX::VIEW::m_minScale
protected

Scale upper limit.

Definition at line 828 of file view.h.

Referenced by SetScale(), and SetScaleLimits().

◆ m_mirrorX

bool KIGFX::VIEW::m_mirrorX
protected

Vertical flip flag.

Definition at line 834 of file view.h.

Referenced by IsMirroredX(), SetGAL(), and SetMirror().

◆ m_mirrorY

bool KIGFX::VIEW::m_mirrorY
protected

PAINTER contains information how do draw items.

Definition at line 837 of file view.h.

Referenced by IsMirroredY(), SetGAL(), and SetMirror().

◆ m_nextDrawPriority

int KIGFX::VIEW::m_nextDrawPriority
protected

Flag to reverse the draw order when using draw priority.

Definition at line 859 of file view.h.

Referenced by Add(), and Clear().

◆ m_orderedLayers

std::vector<VIEW_LAYER*> KIGFX::VIEW::m_orderedLayers
protected

Flat list of all items.

Definition at line 810 of file view.h.

Referenced by Query(), redrawRect(), and sortLayers().

◆ m_ownedItems

std::vector<EDA_ITEM *> KIGFX::VIEW::m_ownedItems
protected

Whether to use rendering order modifier or not.

Definition at line 801 of file view.h.

Referenced by AddToPreview(), and ClearPreview().

◆ m_painter

PAINTER* KIGFX::VIEW::m_painter
protected

Interface to #PAINTER that is used to draw items.

Definition at line 840 of file view.h.

Referenced by draw(), GetPainter(), SetPainter(), UpdateAllLayersColor(), updateItemColor(), updateItemGeometry(), and UpdateLayerColor().

◆ m_preview

std::unique_ptr<KIGFX::VIEW_GROUP> KIGFX::VIEW::m_preview
protected

◆ m_printMode

int KIGFX::VIEW::m_printMode
protected

Definition at line 866 of file view.h.

Referenced by GetPrintMode(), and SetPrintMode().

◆ m_reverseDrawOrder

bool KIGFX::VIEW::m_reverseDrawOrder
protected

A control for printing: m_printMode <= 0 means no printing mode (normal draw mode m_printMode > 0 is a printing mode (currently means "we are in printing mode").

Definition at line 862 of file view.h.

Referenced by IsDrawOrderReversed(), redrawRect(), and ReverseDrawOrder().

◆ m_scale

double KIGFX::VIEW::m_scale
protected

View boundaries.

Definition at line 822 of file view.h.

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

◆ m_topLayers

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

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

Definition at line 816 of file view.h.

Referenced by ClearTopLayers(), EnableTopLayer(), GetTopLayer(), and SetTopLayer().

◆ m_useDrawPriority

bool KIGFX::VIEW::m_useDrawPriority
protected

The next sequential drawing priority.

Definition at line 856 of file view.h.

Referenced by IsUsingDrawPriority(), redrawRect(), and UseDrawPriority().

◆ TOP_LAYER_MODIFIER

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

Flag to respect draw priority when drawing items.

Definition at line 853 of file view.h.

Referenced by ClearTopLayers(), EnableTopLayer(), and SetTopLayer().

◆ VIEW_MAX_LAYERS


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