KiCad PCB EDA Suite
KIGFX::VIEW Class Reference

Class VIEW. More...

#include <view.h>

Classes

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

Static Public Member Functions

static void OnDestroy (VIEW_ITEM *aItem)
 

Static Public Attributes

static const int VIEW_MAX_LAYERS = 256
 maximum number of layers that may be shown More...
 

Private Types

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

Private Member Functions

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

Static Private Member Functions

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

Private Attributes

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

Horizontal flip flag

More...
 
bool m_mirrorY
 

Vertical flip flag

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

Static Private Attributes

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

Friends

class VIEW_ITEM
 

Detailed Description

Class VIEW.

Holds 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 allow 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 58 of file view.h.

Member Typedef Documentation

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

Definition at line 63 of file view.h.

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

Definition at line 655 of file view.h.

typedef LAYER_MAP::iterator KIGFX::VIEW::LAYER_MAP_ITER
private

Definition at line 656 of file view.h.

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

Definition at line 657 of file view.h.

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

Definition at line 658 of file view.h.

Constructor & Destructor Documentation

KIGFX::VIEW::VIEW ( bool  aIsDynamic = true)

Constructor.

Parameters
aIsDynamicdecides whether we are creating a static or a dynamic VIEW.

Definition at line 260 of file view.cpp.

References AddLayer(), m_allItems, m_boundary, MarkDirty(), BOX2< Vec >::SetMaximum(), and VIEW_MAX_LAYERS.

260  :
261  m_enableOrderModifier( true ),
262  m_scale( 4.0 ),
263  m_minScale( 4.0 ), m_maxScale( 15000 ),
264  m_mirrorX( false ), m_mirrorY( false ),
265  m_painter( NULL ),
266  m_gal( NULL ),
267  m_dynamic( aIsDynamic ),
268  m_useDrawPriority( false ),
269  m_nextDrawPriority( 0 )
270 {
272  m_allItems.reserve( 32768 );
273 
274  // Redraw everything at the beginning
275  MarkDirty();
276 
277  // View uses layers to display EDA_ITEMs (item may be displayed on several layers, for example
278  // pad may be shown on pad, pad hole and solder paste layers). There are usual copper layers
279  // (eg. F.Cu, B.Cu, internal and so on) and layers for displaying objects such as texts,
280  // silkscreen, pads, vias, etc.
281  for( int i = 0; i < VIEW_MAX_LAYERS; i++ )
282  AddLayer( i );
283 }
void AddLayer(int aLayer, bool aDisplayOnly=false)
Function AddLayer() Adds a new layer to the view.
Definition: view.cpp:293
bool m_useDrawPriority
Flag to respect draw priority when drawing items.
Definition: view.h:801
GAL * m_gal
Gives interface to PAINTER, that is used to draw items.
Definition: view.h:785
double m_minScale
Scale lower limit.
Definition: view.h:770
BOX2I m_boundary
View boundaries.
Definition: view.h:767
void SetMaximum()
Definition: box2.h:61
static const int VIEW_MAX_LAYERS
maximum number of layers that may be shown
Definition: view.h:640
bool m_mirrorX
Horizontal flip flag
Definition: view.h:776
bool m_dynamic
Dynamic VIEW (eg.
Definition: view.h:789
PAINTER * m_painter
PAINTER contains information how do draw items.
Definition: view.h:782
int m_nextDrawPriority
The next sequential drawing priority.
Definition: view.h:804
double m_maxScale
Scale upper limit.
Definition: view.h:773
bool m_enableOrderModifier
Definition: view.h:749
std::vector< VIEW_ITEM * > m_allItems
Flat list of all items.
Definition: view.h:798
bool m_mirrorY
Vertical flip flag
Definition: view.h:779
double m_scale
Scale of displayed VIEW_ITEMs.
Definition: view.h:764
void MarkDirty()
Function MarkDirty() Forces redraw of view on the next rendering.
Definition: view.h:601
KIGFX::VIEW::~VIEW ( )

Definition at line 286 of file view.cpp.

References m_layers.

287 {
288  for( LAYER_MAP::value_type& l : m_layers )
289  delete l.second.items;
290 }
LAYER_MAP m_layers
Contains set of possible displayed layers and its properties.
Definition: view.h:752

Member Function Documentation

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

Function Add() Adds a VIEW_ITEM to the view.

Set aDrawPriority to -1 to assign sequential priorities.

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

Definition at line 310 of file view.cpp.

References KIGFX::ALL, KIGFX::VIEW_RTREE::Insert(), 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 DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), SELECTION_TOOL::disambiguationMenu(), PCB_DRAW_PANEL_GAL::DisplayBoard(), PCB_TOOL::doInteractiveItemPlacement(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::drawSegment(), EDIT_TOOL::MeasureTool(), POINT_EDITOR::OnSelectionChange(), MODULE_EDITOR_TOOLS::PasteItems(), DRAWING_TOOL::PlaceDXF(), PCB_EDITOR_CONTROL::PlaceModule(), MODULE_EDITOR_TOOLS::PlacePad(), PCB_EDITOR_CONTROL::PlaceTarget(), DRAWING_TOOL::PlaceText(), BOARD_COMMIT::Push(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), PCB_EDIT_FRAME::ReadPcbNetlist(), FOOTPRINT_PREVIEW_PANEL::renderFootprint(), PCB_EDITOR_CONTROL::Reset(), PCBNEW_CONTROL::Reset(), SELECTION_TOOL::Reset(), BOARD_COMMIT::Revert(), SELECTION_TOOL::selectMultiple(), PNS_KICAD_IFACE::SetView(), PNS_PCBNEW_DEBUG_DECORATOR::SetView(), PCB_DRAW_PANEL_GAL::SetWorksheet(), POINT_EDITOR::updatePoints(), ZONE_CREATE_HELPER::ZONE_CREATE_HELPER(), and SELECTION_TOOL::zoomFitSelection().

311 {
312  int layers[VIEW_MAX_LAYERS], layers_count;
313 
314  if( aDrawPriority < 0 )
315  aDrawPriority = m_nextDrawPriority++;
316 
317  if( !aItem->m_viewPrivData )
318  aItem->m_viewPrivData = new VIEW_ITEM_DATA;
319 
320  aItem->m_viewPrivData->m_view = this;
321  aItem->m_viewPrivData->m_drawPriority = aDrawPriority;
322 
323  aItem->ViewGetLayers( layers, layers_count );
324  aItem->viewPrivData()->saveLayers( layers, layers_count );
325 
326  m_allItems.push_back( aItem );
327 
328  for( int i = 0; i < layers_count; ++i )
329  {
330  VIEW_LAYER& l = m_layers[layers[i]];
331  l.items->Insert( aItem );
332  MarkTargetDirty( l.target );
333  }
334 
335  SetVisible( aItem, true );
336  Update( aItem, KIGFX::ALL );
337 }
Layers have changed.
Definition: view_item.h:59
void MarkTargetDirty(int aTarget)
Function MarkTargetDirty() Sets or clears target 'dirty' flag.
Definition: view.h:575
static const int VIEW_MAX_LAYERS
maximum number of layers that may be shown
Definition: view.h:640
int m_nextDrawPriority
The next sequential drawing priority.
Definition: view.h:804
void Update(VIEW_ITEM *aItem)
Function Update() For dynamic VIEWs, informs the associated VIEW that the graphical representation of...
Definition: view.cpp:1378
std::vector< VIEW_ITEM * > m_allItems
Flat list of all items.
Definition: view.h:798
void SetVisible(VIEW_ITEM *aItem, bool aIsVisible=true)
Function SetVisible() Sets the item visibility.
Definition: view.cpp:1330
LAYER_MAP m_layers
Contains set of possible displayed layers and its properties.
Definition: view.h:752
void KIGFX::VIEW::AddLayer ( int  aLayer,
bool  aDisplayOnly = false 
)

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

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

Definition at line 293 of file view.cpp.

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

Referenced by VIEW().

294 {
295  if( m_layers.find( aLayer ) == m_layers.end() )
296  {
297  m_layers[aLayer] = VIEW_LAYER();
298  m_layers[aLayer].id = aLayer;
299  m_layers[aLayer].items = new VIEW_RTREE();
300  m_layers[aLayer].renderingOrder = aLayer;
301  m_layers[aLayer].visible = true;
302  m_layers[aLayer].displayOnly = aDisplayOnly;
303  m_layers[aLayer].target = TARGET_CACHED;
304  }
305 
306  sortLayers();
307 }
void sortLayers()
Definition: view.cpp:1111
Main rendering target (cached)
Definition: definitions.h:41
LAYER_MAP m_layers
Contains set of possible displayed layers and its properties.
Definition: view.h:752
bool KIGFX::VIEW::areRequiredLayersEnabled ( int  aLayerId) const
private

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

Definition at line 1234 of file view.cpp.

References m_layers.

Referenced by redrawRect().

1235 {
1236  wxASSERT( (unsigned) aLayerId < m_layers.size() );
1237 
1238  std::set<int>::const_iterator it, it_end;
1239 
1240  for( it = m_layers.at( aLayerId ).requiredLayers.begin(),
1241  it_end = m_layers.at( aLayerId ).requiredLayers.end(); it != it_end; ++it )
1242  {
1243  // That is enough if just one layer is not enabled
1244  if( !m_layers.at( *it ).visible || !areRequiredLayersEnabled( *it ) )
1245  return false;
1246  }
1247 
1248  return true;
1249 }
bool areRequiredLayersEnabled(int aLayerId) const
Checks if every layer required by the aLayerId layer is enabled.
Definition: view.cpp:1234
LAYER_MAP m_layers
Contains set of possible displayed layers and its properties.
Definition: view.h:752
const BOX2I KIGFX::VIEW::CalculateExtents ( )

Definition at line 1315 of file view.cpp.

References KIGFX::VIEW::extentsVisitor::extents, m_orderedLayers, and BOX2< Vec >::SetMaximum().

1316 {
1317  extentsVisitor v;
1318  BOX2I fullScene;
1319  fullScene.SetMaximum();
1320 
1321  for( VIEW_LAYER* l : m_orderedLayers )
1322  {
1323  l->items->Query( fullScene, v );
1324  }
1325 
1326  return v.extents;
1327 }
void SetMaximum()
Definition: box2.h:61
LAYER_ORDER m_orderedLayers
Sorted list of pointers to members of m_layers.
Definition: view.h:755
void KIGFX::VIEW::ChangeLayerDepth ( int  aLayer,
int  aDepth 
)

Function ChangeLayerDepth() Changes the depth of items on the given layer.

Parameters
aLayeris a number of the layer to be updated.
aDepthis the new depth.

Definition at line 719 of file view.cpp.

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

Referenced by UpdateAllLayersOrder().

720 {
721  // There is no point in updating non-cached layers
722  if( !IsCached( aLayer ) )
723  return;
724 
725  BOX2I r;
726 
727  r.SetMaximum();
728 
729  m_gal->BeginUpdate();
730  changeItemsDepth visitor( aLayer, aDepth, m_gal );
731  m_layers[aLayer].items->Query( r, visitor );
732  m_gal->EndUpdate();
733 
734  MarkTargetDirty( m_layers[aLayer].target );
735 }
virtual void EndUpdate()
Disables item update mode.
GAL * m_gal
Gives interface to PAINTER, that is used to draw items.
Definition: view.h:785
void MarkTargetDirty(int aTarget)
Function MarkTargetDirty() Sets or clears target 'dirty' flag.
Definition: view.h:575
void SetMaximum()
Definition: box2.h:61
virtual void BeginUpdate()
Enables item update mode.
bool IsCached(int aLayer) const
Returns true if the layer is cached.
Definition: view.h:583
LAYER_MAP m_layers
Contains set of possible displayed layers and its properties.
Definition: view.h:752
void KIGFX::VIEW::Clear ( )

Function Clear() Removes all items from the view.

Definition at line 981 of file view.cpp.

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

Referenced by PCB_DRAW_PANEL_GAL::DisplayBoard(), FOOTPRINT_PREVIEW_PANEL::renderFootprint(), and PCB_BASE_EDIT_FRAME::SetBoard().

982 {
983  BOX2I r;
984  r.SetMaximum();
985  m_allItems.clear();
986 
987  for( LAYER_MAP_ITER i = m_layers.begin(); i != m_layers.end(); ++i )
988  i->second.items->RemoveAll();
989 
990  m_nextDrawPriority = 0;
991 
992  m_gal->ClearCache();
993 }
GAL * m_gal
Gives interface to PAINTER, that is used to draw items.
Definition: view.h:785
void SetMaximum()
Definition: box2.h:61
int m_nextDrawPriority
The next sequential drawing priority.
Definition: view.h:804
LAYER_MAP::iterator LAYER_MAP_ITER
Definition: view.h:656
std::vector< VIEW_ITEM * > m_allItems
Flat list of all items.
Definition: view.h:798
LAYER_MAP m_layers
Contains set of possible displayed layers and its properties.
Definition: view.h:752
virtual void ClearCache()
Delete all data created during caching of graphic items.
void KIGFX::VIEW::clearGroupCache ( )
private

Definition at line 1064 of file view.cpp.

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

Referenced by SetGAL().

1065 {
1066  BOX2I r;
1067 
1068  r.SetMaximum();
1069  clearLayerCache visitor( this );
1070 
1071  for( LAYER_MAP_ITER i = m_layers.begin(); i != m_layers.end(); ++i )
1072  {
1073  VIEW_LAYER* l = &( ( *i ).second );
1074  l->items->Query( r, visitor );
1075  }
1076 }
void SetMaximum()
Definition: box2.h:61
LAYER_MAP::iterator LAYER_MAP_ITER
Definition: view.h:656
LAYER_MAP m_layers
Contains set of possible displayed layers and its properties.
Definition: view.h:752
void KIGFX::VIEW::ClearLayer ( int  aLayer)

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

Parameters
aLayerID of the layer to be cleared
void KIGFX::VIEW::ClearTargets ( )

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

Definition at line 996 of file view.cpp.

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

Referenced by EDA_DRAW_PANEL_GAL::onPaint().

997 {
999  {
1000  // TARGET_CACHED and TARGET_NONCACHED have to be redrawn together, as they contain
1001  // layers that rely on each other (eg. netnames are noncached, but tracks - are cached)
1004 
1005  MarkDirty();
1006  }
1007 
1008  if( IsTargetDirty( TARGET_OVERLAY ) )
1009  {
1011  }
1012 }
GAL * m_gal
Gives interface to PAINTER, that is used to draw items.
Definition: view.h:785
Auxiliary rendering target (noncached)
Definition: definitions.h:42
virtual void ClearTarget(RENDER_TARGET aTarget)
Clears the target for rendering.
bool IsTargetDirty(int aTarget) const
Function IsTargetDirty() Returns true if any of layers belonging to the target or the target itself s...
Definition: view.h:563
Items that may change while the view stays the same (noncached)
Definition: definitions.h:43
Main rendering target (cached)
Definition: definitions.h:41
void MarkDirty()
Function MarkDirty() Forces redraw of view on the next rendering.
Definition: view.h:601
void KIGFX::VIEW::ClearTopLayers ( )

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

Definition at line 799 of file view.cpp.

References m_enableOrderModifier, m_layers, m_topLayers, and TOP_LAYER_MODIFIER.

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

800 {
801  std::set<unsigned int>::iterator it;
802 
804  {
805  // Restore the previous rendering order for layers that were marked as top
806  for( it = m_topLayers.begin(); it != m_topLayers.end(); ++it )
807  m_layers[*it].renderingOrder -= TOP_LAYER_MODIFIER;
808  }
809 
810  m_topLayers.clear();
811 }
static const int TOP_LAYER_MODIFIER
Rendering order modifier for layers that are marked as top layers.
Definition: view.h:795
std::set< unsigned int > m_topLayers
Stores set of layers that are displayed on the top.
Definition: view.h:758
bool m_enableOrderModifier
Definition: view.h:749
LAYER_MAP m_layers
Contains set of possible displayed layers and its properties.
Definition: view.h:752
static bool KIGFX::VIEW::compareRenderingOrder ( VIEW_LAYER aI,
VIEW_LAYER aJ 
)
inlinestaticprivate

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

Definition at line 740 of file view.h.

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

Referenced by sortLayers().

741  {
742  return aI->renderingOrder > aJ->renderingOrder;
743  }
void KIGFX::VIEW::CopySettings ( const VIEW aOtherView)

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

Parameters
aOtherViewview from which settings will be copied.

Definition at line 477 of file view.cpp.

478 {
479  wxASSERT_MSG( false, wxT( "This is not implemented" ) );
480 }
void KIGFX::VIEW::draw ( VIEW_ITEM aItem,
int  aLayer,
bool  aImmediate = false 
)
private

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

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

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

Definition at line 889 of file view.cpp.

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

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

890 {
891  auto viewData = aItem->viewPrivData();
892 
893  if( !viewData )
894  return;
895 
896  if( IsCached( aLayer ) && !aImmediate )
897  {
898  // Draw using cached information or create one
899  int group = viewData->getGroup( aLayer );
900 
901  if( group >= 0 )
902  {
903  m_gal->DrawGroup( group );
904  }
905  else
906  {
907  group = m_gal->BeginGroup();
908  viewData->setGroup( aLayer, group );
909 
910  if( !m_painter->Draw( aItem, aLayer ) )
911  aItem->ViewDraw( aLayer, this ); // Alternative drawing method
912 
913  m_gal->EndGroup();
914  }
915  }
916  else
917  {
918  // Immediate mode
919  if( !m_painter->Draw( aItem, aLayer ) )
920  aItem->ViewDraw( aLayer, this ); // Alternative drawing method
921  }
922 }
virtual void DrawGroup(int aGroupNumber)
Draw the stored group.
GAL * m_gal
Gives interface to PAINTER, that is used to draw items.
Definition: view.h:785
virtual void EndGroup()
End the group.
virtual int BeginGroup()
Begin a group.
PAINTER * m_painter
PAINTER contains information how do draw items.
Definition: view.h:782
virtual bool Draw(const VIEW_ITEM *aItem, int aLayer)=0
Function Draw Takes an instance of VIEW_ITEM and passes it to a function that know how to draw the it...
bool IsCached(int aLayer) const
Returns true if the layer is cached.
Definition: view.h:583
void KIGFX::VIEW::draw ( VIEW_ITEM aItem,
bool  aImmediate = false 
)
private

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

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

Definition at line 925 of file view.cpp.

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

926 {
927  int layers[VIEW_MAX_LAYERS], layers_count;
928 
929  aItem->ViewGetLayers( layers, layers_count );
930 
931  // Sorting is needed for drawing order dependent GALs (like Cairo)
932  SortLayers( layers, layers_count );
933 
934  for( int i = 0; i < layers_count; ++i )
935  {
936  m_gal->SetLayerDepth( m_layers.at( layers[i] ).renderingOrder );
937  draw( aItem, layers[i], aImmediate );
938  }
939 }
GAL * m_gal
Gives interface to PAINTER, that is used to draw items.
Definition: view.h:785
virtual void SetLayerDepth(double aLayerDepth)
Set the depth of the layer (position on the z-axis)
void SortLayers(int aLayers[], int &aCount) const
Function SortLayers() Changes the order of given layer ids, so after sorting the order corresponds to...
Definition: view.cpp:602
static const int VIEW_MAX_LAYERS
maximum number of layers that may be shown
Definition: view.h:640
void draw(VIEW_ITEM *aItem, int aLayer, bool aImmediate=false)
Function draw() Draws an item, but on a specified layers.
Definition: view.cpp:889
LAYER_MAP m_layers
Contains set of possible displayed layers and its properties.
Definition: view.h:752
void KIGFX::VIEW::draw ( VIEW_GROUP aGroup,
bool  aImmediate = false 
)
private

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

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

Definition at line 942 of file view.cpp.

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

943 {
944  for( unsigned int i = 0; i < aGroup->GetSize(); i++)
945  draw( aGroup->GetItem(i), aImmediate );
946 }
void draw(VIEW_ITEM *aItem, int aLayer, bool aImmediate=false)
Function draw() Draws an item, but on a specified layers.
Definition: view.cpp:889
void KIGFX::VIEW::EnableTopLayer ( bool  aEnable)

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

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

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

Definition at line 774 of file view.cpp.

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

775 {
776  if( aEnable == m_enableOrderModifier )
777  return;
778 
779  m_enableOrderModifier = aEnable;
780 
781  std::set<unsigned int>::iterator it;
782 
783  if( aEnable )
784  {
785  for( it = m_topLayers.begin(); it != m_topLayers.end(); ++it )
786  m_layers[*it].renderingOrder += TOP_LAYER_MODIFIER;
787  }
788  else
789  {
790  for( it = m_topLayers.begin(); it != m_topLayers.end(); ++it )
791  m_layers[*it].renderingOrder -= TOP_LAYER_MODIFIER;
792  }
793 
796 }
static const int TOP_LAYER_MODIFIER
Rendering order modifier for layers that are marked as top layers.
Definition: view.h:795
std::set< unsigned int > m_topLayers
Stores set of layers that are displayed on the top.
Definition: view.h:758
void UpdateAllLayersOrder()
Function UpdateLayerOrder() Does everything that is needed to apply the rendering order of layers...
Definition: view.cpp:814
bool m_enableOrderModifier
Definition: view.h:749
LAYER_MAP m_layers
Contains set of possible displayed layers and its properties.
Definition: view.h:752
void UpdateAllLayersColor()
Function UpdateAllLayersColor() Applies the new coloring scheme to all layers.
Definition: view.cpp:673
const BOX2I& KIGFX::VIEW::GetBoundary ( ) const
inline

Function GetBoundary()

Returns
Current view area boundary.

Definition at line 284 of file view.h.

References m_boundary.

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

285  {
286  return m_boundary;
287  }
BOX2I m_boundary
View boundaries.
Definition: view.h:767
const VECTOR2D& KIGFX::VIEW::GetCenter ( ) const
inline

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

Returns
center point of the view

Definition at line 316 of file view.h.

References m_center.

Referenced by PCBNEW_CONTROL::CursorControl(), KIGFX::WX_VIEW_CONTROLS::onButton(), KIGFX::WX_VIEW_CONTROLS::onScroll(), KIGFX::WX_VIEW_CONTROLS::onTimer(), KIGFX::WX_VIEW_CONTROLS::onWheel(), EDA_DRAW_FRAME::UseGalCanvas(), and COMMON_TOOLS::ZoomFitScreen().

317  {
318  return m_center;
319  }
VECTOR2D m_center
Center point of the VIEW (the point at which we are looking at)
Definition: view.h:761
int KIGFX::VIEW::GetLayerOrder ( int  aLayer) const

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

Lower values are rendered first.

Parameters
aLayerthe layer
Returns
Rendering order of a particular layer.

Definition at line 596 of file view.cpp.

References m_layers.

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

597 {
598  return m_layers.at( aLayer ).renderingOrder;
599 }
LAYER_MAP m_layers
Contains set of possible displayed layers and its properties.
Definition: view.h:752
double KIGFX::VIEW::GetScale ( ) const
inline
const VECTOR2I & KIGFX::VIEW::GetScreenPixelSize ( ) const

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

Returns
viewport screen size

Definition at line 1040 of file view.cpp.

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

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

1041 {
1042  return m_gal->GetScreenPixelSize();
1043 }
GAL * m_gal
Gives interface to PAINTER, that is used to draw items.
Definition: view.h:785
const VECTOR2I & GetScreenPixelSize() const
Returns GAL canvas size in pixels.
int KIGFX::VIEW::GetTopLayer ( ) const

Definition at line 738 of file view.cpp.

References m_topLayers.

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

739 {
740  if( m_topLayers.size() == 0 )
741  return 0;
742 
743  return *m_topLayers.begin();
744 }
std::set< unsigned int > m_topLayers
Stores set of layers that are displayed on the top.
Definition: view.h:758
BOX2D KIGFX::VIEW::GetViewport ( ) const

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

Returns
Current viewport rectangle

Definition at line 500 of file view.cpp.

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

Referenced by KIGFX::WX_VIEW_CONTROLS::UpdateScrollbars().

501 {
502  BOX2D rect;
503  VECTOR2D screenSize = m_gal->GetScreenPixelSize();
504 
505  rect.SetOrigin( ToWorld( VECTOR2D( 0, 0 ) ) );
506  rect.SetEnd( ToWorld( screenSize ) );
507 
508  return rect.Normalize();
509 }
VECTOR2D ToWorld(const VECTOR2D &aCoord, bool aAbsolute=true) const
Function ToWorld() Converts a screen space point/vector to a point/vector in world space coordinates...
Definition: view.cpp:439
GAL * m_gal
Gives interface to PAINTER, that is used to draw items.
Definition: view.h:785
Class BOX2 handles a 2-D bounding box, built on top of an origin point and size vector, both of templated class Vec.
Definition: box2.h:41
VECTOR2< double > VECTOR2D
Definition: vector2d.h:589
BOX2< Vec > & Normalize()
Function Normalize ensures that the height ant width are positive.
Definition: box2.h:117
void SetEnd(coord_type x, coord_type y)
Definition: box2.h:213
const VECTOR2I & GetScreenPixelSize() const
Returns GAL canvas size in pixels.
void SetOrigin(const Vec &pos)
Definition: box2.h:198
void KIGFX::VIEW::Hide ( VIEW_ITEM aItem,
bool  aHide = true 
)

Function Hide() Temporarily hides the item in the view (e.g.

for overlaying)

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

Definition at line 1351 of file view.cpp.

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

Referenced by SELECTION_TOOL::selectVisually(), and SELECTION_TOOL::unselectVisually().

1352 {
1353  auto viewData = aItem->viewPrivData();
1354 
1355  if( !viewData )
1356  return;
1357 
1358  if( !( viewData->m_flags & VISIBLE ) )
1359  return;
1360 
1361  if( aHide )
1362  viewData->m_flags |= HIDDEN;
1363  else
1364  viewData->m_flags &= ~HIDDEN;
1365 
1366  Update( aItem, APPEARANCE );
1367 }
Item is visible (in general)
Definition: view_item.h:68
No updates are required.
Definition: view_item.h:55
void Update(VIEW_ITEM *aItem)
Function Update() For dynamic VIEWs, informs the associated VIEW that the graphical representation of...
Definition: view.cpp:1378
void KIGFX::VIEW::invalidateItem ( VIEW_ITEM aItem,
int  aUpdateFlags 
)
private

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

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

Definition at line 1079 of file view.cpp.

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

Referenced by UpdateItems().

1080 {
1081  // updateLayers updates geometry too, so we do not have to update both of them at the same time
1082  if( aUpdateFlags & LAYERS )
1083  updateLayers( aItem );
1084  else if( aUpdateFlags & GEOMETRY )
1085  updateBbox( aItem );
1086 
1087  int layers[VIEW_MAX_LAYERS], layers_count;
1088  aItem->ViewGetLayers( layers, layers_count );
1089 
1090  // Iterate through layers used by the item and recache it immediately
1091  for( int i = 0; i < layers_count; ++i )
1092  {
1093  int layerId = layers[i];
1094 
1095  if( IsCached( layerId ) )
1096  {
1097  if( aUpdateFlags & ( GEOMETRY | LAYERS ) )
1098  updateItemGeometry( aItem, layerId );
1099  else if( aUpdateFlags & COLOR )
1100  updateItemColor( aItem, layerId );
1101  }
1102 
1103  // Mark those layers as dirty, so the VIEW will be refreshed
1104  MarkTargetDirty( m_layers[layerId].target );
1105  }
1106 
1107  aItem->viewPrivData()->clearUpdateFlags();
1108 }
void updateLayers(VIEW_ITEM *aItem)
Updates set of layers that an item occupies.
Definition: view.cpp:1191
void updateItemColor(VIEW_ITEM *aItem, int aLayer)
Updates colors that are used for an item to be drawn.
Definition: view.cpp:1126
Visibility flag has changed.
Definition: view_item.h:56
void MarkTargetDirty(int aTarget)
Function MarkTargetDirty() Sets or clears target 'dirty' flag.
Definition: view.h:575
static const int VIEW_MAX_LAYERS
maximum number of layers that may be shown
Definition: view.h:640
void updateBbox(VIEW_ITEM *aItem)
Updates bounding box of an item.
Definition: view.cpp:1175
void updateItemGeometry(VIEW_ITEM *aItem, int aLayer)
Updates all informations needed to draw an item.
Definition: view.cpp:1145
bool IsCached(int aLayer) const
Returns true if the layer is cached.
Definition: view.h:583
LAYER_MAP m_layers
Contains set of possible displayed layers and its properties.
Definition: view.h:752
Position or shape has changed.
Definition: view_item.h:58
Color has changed.
Definition: view_item.h:57
bool KIGFX::VIEW::IsCached ( int  aLayer) const
inline

Returns true if the layer is cached.

Definition at line 583 of file view.h.

References m_layers, and KIGFX::TARGET_CACHED.

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

584  {
585  wxASSERT( aLayer < (int) m_layers.size() );
586 
587  try
588  {
589  return m_layers.at( aLayer ).target == TARGET_CACHED;
590  }
591  catch( std::out_of_range )
592  {
593  return false;
594  }
595  }
Main rendering target (cached)
Definition: definitions.h:41
LAYER_MAP m_layers
Contains set of possible displayed layers and its properties.
Definition: view.h:752
bool KIGFX::VIEW::IsDirty ( ) const
inline

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

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

Definition at line 546 of file view.h.

References IsTargetDirty(), and KIGFX::TARGETS_NUMBER.

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

547  {
548  for( int i = 0; i < TARGETS_NUMBER; ++i )
549  {
550  if( IsTargetDirty( i ) )
551  return true;
552  }
553 
554  return false;
555  }
Number of available rendering targets.
Definition: definitions.h:44
bool IsTargetDirty(int aTarget) const
Function IsTargetDirty() Returns true if any of layers belonging to the target or the target itself s...
Definition: view.h:563
bool KIGFX::VIEW::IsDynamic ( ) const
inline

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

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

Definition at line 536 of file view.h.

References m_dynamic.

537  {
538  return m_dynamic;
539  }
bool m_dynamic
Dynamic VIEW (eg.
Definition: view.h:789
bool KIGFX::VIEW::IsLayerVisible ( int  aLayer) const
inline

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

Parameters
aLayertrue if the layer is visible, false otherwise

Definition at line 404 of file view.h.

References m_layers.

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

405  {
406  wxASSERT( aLayer < (int) m_layers.size() );
407 
408  return m_layers.at( aLayer ).visible;
409  }
LAYER_MAP m_layers
Contains set of possible displayed layers and its properties.
Definition: view.h:752
bool KIGFX::VIEW::IsMirroredX ( ) const
inline

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

Definition at line 227 of file view.h.

References m_mirrorX.

Referenced by PCBNEW_CONTROL::CursorControl().

228  {
229  return m_mirrorX;
230  }
bool m_mirrorX
Horizontal flip flag
Definition: view.h:776
bool KIGFX::VIEW::IsMirroredY ( ) const
inline

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

Definition at line 236 of file view.h.

References m_mirrorY.

237  {
238  return m_mirrorY;
239  }
bool m_mirrorY
Vertical flip flag
Definition: view.h:779
bool KIGFX::VIEW::IsTargetDirty ( int  aTarget) const
inline

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

Returns
True if the above condition is fulfilled.

Definition at line 563 of file view.h.

References m_dirtyTargets, and KIGFX::TARGETS_NUMBER.

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

564  {
565  wxASSERT( aTarget < TARGETS_NUMBER );
566 
567  return m_dirtyTargets[aTarget];
568  }
Number of available rendering targets.
Definition: definitions.h:44
bool m_dirtyTargets[TARGETS_NUMBER]
Flags to mark targets as dirty, so they have to be redrawn on the next refresh event.
Definition: view.h:792
bool KIGFX::VIEW::IsUsingDrawPriority ( ) const
inline

Function IsUsingDrawPriority()

Returns
true if draw priority is being respected while redrawing.

Definition at line 626 of file view.h.

References m_useDrawPriority.

627  {
628  return m_useDrawPriority;
629  }
bool m_useDrawPriority
Flag to respect draw priority when drawing items.
Definition: view.h:801
bool KIGFX::VIEW::IsVisible ( const VIEW_ITEM aItem) const

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

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

Definition at line 1370 of file view.cpp.

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

Referenced by PNS_KICAD_IFACE::HideItem(), and SELECTION_TOOL::selectable().

1371 {
1372  const auto viewData = aItem->viewPrivData();
1373 
1374  return viewData->m_flags & VISIBLE;
1375 }
void KIGFX::VIEW::MarkDirty ( )
inline

Function MarkDirty() Forces redraw of view on the next rendering.

Definition at line 601 of file view.h.

References m_dirtyTargets, and KIGFX::TARGETS_NUMBER.

Referenced by ClearTargets(), SetCenter(), setDrillOrigin(), SetGAL(), SetMirror(), setOrigin(), SetScale(), sortLayers(), UpdateAllLayersColor(), UpdateAllLayersOrder(), and VIEW().

602  {
603  for( int i = 0; i < TARGETS_NUMBER; ++i )
604  m_dirtyTargets[i] = true;
605  }
Number of available rendering targets.
Definition: definitions.h:44
bool m_dirtyTargets[TARGETS_NUMBER]
Flags to mark targets as dirty, so they have to be redrawn on the next refresh event.
Definition: view.h:792
void KIGFX::VIEW::MarkForUpdate ( VIEW_ITEM aItem)

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

Parameters
aItemis the item to be refreshed.
void KIGFX::VIEW::markTargetClean ( int  aTarget)
inlineprivate

Definition at line 673 of file view.h.

References m_dirtyTargets, and KIGFX::TARGETS_NUMBER.

Referenced by Redraw().

674  {
675  wxASSERT( aTarget < TARGETS_NUMBER );
676 
677  m_dirtyTargets[aTarget] = false;
678  }
Number of available rendering targets.
Definition: definitions.h:44
bool m_dirtyTargets[TARGETS_NUMBER]
Flags to mark targets as dirty, so they have to be redrawn on the next refresh event.
Definition: view.h:792
void KIGFX::VIEW::MarkTargetDirty ( int  aTarget)
inline

Function MarkTargetDirty() Sets or clears target 'dirty' flag.

Parameters
aTargetis the target to set.

Definition at line 575 of file view.h.

References m_dirtyTargets, and KIGFX::TARGETS_NUMBER.

Referenced by Add(), ChangeLayerDepth(), SELECTION_TOOL::disambiguationMenu(), invalidateItem(), PCB_LAYER_WIDGET::OnRenderEnable(), EDA_DRAW_PANEL_GAL::onSize(), EDA_DRAW_FRAME::OnToggleGridState(), Remove(), SetLayerVisible(), DIALOG_DISPLAY_OPTIONS::TransferDataFromWindow(), DIALOG_MODEDIT_DISPLAY_OPTIONS::TransferDataFromWindow(), updateBbox(), COMMON_TOOLS::updateGrid(), PCBNEW_CONTROL::updateGrid(), UpdateLayerColor(), and updateLayers().

576  {
577  wxASSERT( aTarget < TARGETS_NUMBER );
578 
579  m_dirtyTargets[aTarget] = true;
580  }
Number of available rendering targets.
Definition: definitions.h:44
bool m_dirtyTargets[TARGETS_NUMBER]
Flags to mark targets as dirty, so they have to be redrawn on the next refresh event.
Definition: view.h:792
void KIGFX::VIEW::OnDestroy ( VIEW_ITEM aItem)
static

Definition at line 246 of file view.cpp.

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

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

247 {
248  auto data = aItem->viewPrivData();
249 
250  if( !data )
251  return;
252 
253  if( data->m_view )
254  data->m_view->Remove( aItem );
255 
256  delete data;
257 }
int KIGFX::VIEW::Query ( const BOX2I aRect,
std::vector< LAYER_ITEM_PAIR > &  aResult 
) const

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

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

References m_orderedLayers.

Referenced by GRID_HELPER::queryVisible(), and SELECTION_TOOL::selectMultiple().

417 {
418  if( m_orderedLayers.empty() )
419  return 0;
420 
421  std::vector<VIEW_LAYER*>::const_reverse_iterator i;
422 
423  // execute queries in reverse direction, so that items that are on the top of
424  // the rendering stack are returned first.
425  for( i = m_orderedLayers.rbegin(); i != m_orderedLayers.rend(); ++i )
426  {
427  // ignore layers that do not contain actual items (i.e. the selection box, menus, floats)
428  if( ( *i )->displayOnly )
429  continue;
430 
431  queryVisitor<std::vector<LAYER_ITEM_PAIR> > visitor( aResult, ( *i )->id );
432  ( *i )->items->Query( aRect, visitor );
433  }
434 
435  return aResult.size();
436 }
LAYER_ORDER m_orderedLayers
Sorted list of pointers to members of m_layers.
Definition: view.h:755
void KIGFX::VIEW::RecacheAllItems ( )

Function RecacheAllItems() Rebuilds GAL display lists.

Definition at line 1252 of file view.cpp.

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

Referenced by PCB_DRAW_PANEL_GAL::OnShow(), DIALOG_DISPLAY_OPTIONS::TransferDataFromWindow(), DIALOG_MODEDIT_DISPLAY_OPTIONS::TransferDataFromWindow(), and PCB_BASE_FRAME::UseGalCanvas().

1253 {
1254  BOX2I r;
1255 
1256  r.SetMaximum();
1257 
1258  for( LAYER_MAP_ITER i = m_layers.begin(); i != m_layers.end(); ++i )
1259  {
1260  VIEW_LAYER* l = &( ( *i ).second );
1261 
1262  if( IsCached( l->id ) )
1263  {
1264  recacheItem visitor( this, m_gal, l->id );
1265  l->items->Query( r, visitor );
1266  }
1267  }
1268 }
GAL * m_gal
Gives interface to PAINTER, that is used to draw items.
Definition: view.h:785
void SetMaximum()
Definition: box2.h:61
LAYER_MAP::iterator LAYER_MAP_ITER
Definition: view.h:656
bool IsCached(int aLayer) const
Returns true if the layer is cached.
Definition: view.h:583
LAYER_MAP m_layers
Contains set of possible displayed layers and its properties.
Definition: view.h:752
void KIGFX::VIEW::Redraw ( )

Function Redraw() Immediately redraws the whole view.

Definition at line 1015 of file view.cpp.

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

Referenced by EDA_DRAW_PANEL_GAL::onPaint().

1016 {
1017 #ifdef __WXDEBUG__
1018  PROF_COUNTER totalRealTime;
1019 #endif /* __WXDEBUG__ */
1020 
1021  VECTOR2D screenSize = m_gal->GetScreenPixelSize();
1022  BOX2I rect( ToWorld( VECTOR2D( 0, 0 ) ),
1023  ToWorld( screenSize ) - ToWorld( VECTOR2D( 0, 0 ) ) );
1024  rect.Normalize();
1025 
1026  redrawRect( rect );
1027 
1028  // All targets were redrawn, so nothing is dirty
1032 
1033 #ifdef __WXDEBUG__
1034  totalRealTime.Stop();
1035  wxLogTrace( "GAL_PROFILE", wxT( "VIEW::Redraw(): %.1f ms" ), totalRealTime.msecs() );
1036 #endif /* __WXDEBUG__ */
1037 }
void Stop()
save the time when this function was called, and set the counter stane to stop
Definition: profile.h:82
VECTOR2D ToWorld(const VECTOR2D &aCoord, bool aAbsolute=true) const
Function ToWorld() Converts a screen space point/vector to a point/vector in world space coordinates...
Definition: view.cpp:439
GAL * m_gal
Gives interface to PAINTER, that is used to draw items.
Definition: view.h:785
The class PROF_COUNTER is a small class to help profiling.
Definition: profile.h:45
Auxiliary rendering target (noncached)
Definition: definitions.h:42
VECTOR2< double > VECTOR2D
Definition: vector2d.h:589
Items that may change while the view stays the same (noncached)
Definition: definitions.h:43
void markTargetClean(int aTarget)
Definition: view.h:673
const VECTOR2I & GetScreenPixelSize() const
Returns GAL canvas size in pixels.
double msecs() const
Definition: profile.h:121
void redrawRect(const BOX2I &aRect)
Definition: view.cpp:870
Main rendering target (cached)
Definition: definitions.h:41
void KIGFX::VIEW::redrawRect ( const BOX2I aRect)
private
  • Redraws contents within rect aRect

Definition at line 870 of file view.cpp.

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

Referenced by Redraw().

871 {
872  for( VIEW_LAYER* l : m_orderedLayers )
873  {
874  if( l->visible && IsTargetDirty( l->target ) && areRequiredLayersEnabled( l->id ) )
875  {
876  drawItem drawFunc( this, l->id, m_useDrawPriority );
877 
878  m_gal->SetTarget( l->target );
879  m_gal->SetLayerDepth( l->renderingOrder );
880  l->items->Query( aRect, drawFunc );
881 
882  if( m_useDrawPriority )
883  drawFunc.deferredDraw();
884  }
885  }
886 }
bool m_useDrawPriority
Flag to respect draw priority when drawing items.
Definition: view.h:801
GAL * m_gal
Gives interface to PAINTER, that is used to draw items.
Definition: view.h:785
virtual void SetLayerDepth(double aLayerDepth)
Set the depth of the layer (position on the z-axis)
bool IsTargetDirty(int aTarget) const
Function IsTargetDirty() Returns true if any of layers belonging to the target or the target itself s...
Definition: view.h:563
LAYER_ORDER m_orderedLayers
Sorted list of pointers to members of m_layers.
Definition: view.h:755
bool areRequiredLayersEnabled(int aLayerId) const
Checks if every layer required by the aLayerId layer is enabled.
Definition: view.cpp:1234
virtual void SetTarget(RENDER_TARGET aTarget)
Sets the target for rendering.
void KIGFX::VIEW::Remove ( VIEW_ITEM aItem)

Function Remove() Removes a VIEW_ITEM from the view.

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

Definition at line 340 of file view.cpp.

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

Referenced by SELECTION_TOOL::disambiguationMenu(), PCB_TOOL::doInteractiveItemPlacement(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::drawSegment(), EDIT_TOOL::MeasureTool(), OnDestroy(), POINT_EDITOR::OnSelectionChange(), MODULE_EDITOR_TOOLS::PasteItems(), DRAWING_TOOL::PlaceDXF(), PCB_EDITOR_CONTROL::PlaceModule(), MODULE_EDITOR_TOOLS::PlacePad(), PCB_EDITOR_CONTROL::PlaceTarget(), DRAWING_TOOL::PlaceText(), BOARD_COMMIT::Push(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), PCB_EDIT_FRAME::ReadPcbNetlist(), PCB_EDITOR_CONTROL::Reset(), PCBNEW_CONTROL::Reset(), SELECTION_TOOL::Reset(), BOARD_COMMIT::Revert(), SELECTION_TOOL::selectMultiple(), POINT_EDITOR::updatePoints(), SELECTION_TOOL::~SELECTION_TOOL(), and ZONE_CREATE_HELPER::~ZONE_CREATE_HELPER().

341 {
342  if( !aItem )
343  return;
344 
345  auto viewData = aItem->viewPrivData();
346 
347  if( !viewData )
348  return;
349 
350  wxASSERT( viewData->m_view == this );
351  auto item = std::find( m_allItems.begin(), m_allItems.end(), aItem );
352 
353  if( item != m_allItems.end() )
354  {
355  m_allItems.erase( item );
356  viewData->clearUpdateFlags();
357  }
358 
359  int layers[VIEW::VIEW_MAX_LAYERS], layers_count;
360  viewData->getLayers( layers, layers_count );
361 
362  for( int i = 0; i < layers_count; ++i )
363  {
364  VIEW_LAYER& l = m_layers[layers[i]];
365  l.items->Remove( aItem );
366  MarkTargetDirty( l.target );
367 
368  // Clear the GAL cache
369  int prevGroup = viewData->getGroup( layers[i] );
370 
371  if( prevGroup >= 0 )
372  m_gal->DeleteGroup( prevGroup );
373  }
374 
375  viewData->deleteGroups();
376  viewData->m_view = nullptr;
377 }
virtual void DeleteGroup(int aGroupNumber)
Delete the group from the memory.
GAL * m_gal
Gives interface to PAINTER, that is used to draw items.
Definition: view.h:785
void MarkTargetDirty(int aTarget)
Function MarkTargetDirty() Sets or clears target 'dirty' flag.
Definition: view.h:575
static const int VIEW_MAX_LAYERS
maximum number of layers that may be shown
Definition: view.h:640
std::vector< VIEW_ITEM * > m_allItems
Flat list of all items.
Definition: view.h:798
LAYER_MAP m_layers
Contains set of possible displayed layers and its properties.
Definition: view.h:752
void KIGFX::VIEW::SetBoundary ( const BOX2I aBoundary)
inline

Function SetBoundary() Sets limits for view area.

Parameters
aBoundaryis the box that limits view area.

Definition at line 275 of file view.h.

References m_boundary.

Referenced by DIALOG_PAD_PROPERTIES::redraw().

276  {
277  m_boundary = aBoundary;
278  }
BOX2I m_boundary
View boundaries.
Definition: view.h:767
void KIGFX::VIEW::SetCenter ( const VECTOR2D aCenter)

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

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

Parameters
aCenterthe new center point, in world space coordinates.

Definition at line 563 of file view.cpp.

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 KIGFX::WX_VIEW_CONTROLS::CenterOnCursor(), PCB_EDITOR_CONTROL::CrossProbeSchToPcb(), PCBNEW_CONTROL::CursorControl(), DIALOG_DRC_CONTROL::OnLeftDClickClearance(), DIALOG_DRC_CONTROL::OnLeftDClickUnconnected(), DIALOG_DRC_CONTROL::OnMarkerSelectionEvent(), KIGFX::WX_VIEW_CONTROLS::onMotion(), DIALOG_DRC_CONTROL::OnPopupMenu(), KIGFX::WX_VIEW_CONTROLS::onScroll(), KIGFX::WX_VIEW_CONTROLS::onTimer(), DIALOG_DRC_CONTROL::OnUnconnectedSelectionEvent(), KIGFX::WX_VIEW_CONTROLS::onWheel(), SetGAL(), SetScale(), SetViewport(), EDA_DRAW_FRAME::UseGalCanvas(), KIGFX::WX_VIEW_CONTROLS::WarpCursor(), COMMON_TOOLS::ZoomFitScreen(), and SELECTION_TOOL::zoomFitSelection().

564 {
565  m_center = aCenter;
566 
567  if( !m_boundary.Contains( aCenter ) )
568  {
569  if( m_center.x < m_boundary.GetLeft() )
571  else if( aCenter.x > m_boundary.GetRight() )
573 
574  if( m_center.y < m_boundary.GetTop() )
576  else if( m_center.y > m_boundary.GetBottom() )
578  }
579 
582 
583  // Redraw everything after the viewport has changed
584  MarkDirty();
585 }
bool Contains(const Vec &aPoint) const
Function Contains.
Definition: box2.h:139
GAL * m_gal
Gives interface to PAINTER, that is used to draw items.
Definition: view.h:785
coord_type GetRight() const
Definition: box2.h:187
virtual void ComputeWorldScreenMatrix()
Compute the world <-> screen transformation matrix.
coord_type GetTop() const
Definition: box2.h:192
VECTOR2D m_center
Center point of the VIEW (the point at which we are looking at)
Definition: view.h:761
BOX2I m_boundary
View boundaries.
Definition: view.h:767
coord_type GetBottom() const
Definition: box2.h:188
void SetLookAtPoint(const VECTOR2D &aPoint)
Set the Point in world space to look at.
coord_type GetLeft() const
Definition: box2.h:191
void MarkDirty()
Function MarkDirty() Forces redraw of view on the next rendering.
Definition: view.h:601
void KIGFX::VIEW::SetGAL ( GAL aGal)

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

Parameters
aGalpointer to the GAL output device

Definition at line 483 of file view.cpp.

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

Referenced by EDA_DRAW_PANEL_GAL::EDA_DRAW_PANEL_GAL(), and EDA_DRAW_PANEL_GAL::SwitchBackend().

484 {
485  m_gal = aGal;
486 
487  // clear group numbers, so everything is going to be recached
488  clearGroupCache();
489 
490  // every target has to be refreshed
491  MarkDirty();
492 
493  // force the new GAL to display the current viewport.
494  SetCenter( m_center );
495  SetScale( m_scale );
497 }
GAL * m_gal
Gives interface to PAINTER, that is used to draw items.
Definition: view.h:785
void SetMirror(bool aMirrorX, bool aMirrorY)
Function SetMirror() Controls the mirroring of the VIEW.
Definition: view.cpp:527
void SetScale(double aScale)
Function SetScale() Sets the scaling factor.
Definition: view.h:247
VECTOR2D m_center
Center point of the VIEW (the point at which we are looking at)
Definition: view.h:761
void SetCenter(const VECTOR2D &aCenter)
Function SetCenter() Sets the center point of the VIEW (i.e.
Definition: view.cpp:563
bool m_mirrorX
Horizontal flip flag
Definition: view.h:776
void clearGroupCache()
Definition: view.cpp:1064
bool m_mirrorY
Vertical flip flag
Definition: view.h:779
double m_scale
Scale of displayed VIEW_ITEMs.
Definition: view.h:764
void MarkDirty()
Function MarkDirty() Forces redraw of view on the next rendering.
Definition: view.h:601
void KIGFX::VIEW::SetLayerDisplayOnly ( int  aLayer,
bool  aDisplayOnly = true 
)
inline

Definition at line 411 of file view.h.

References m_layers.

Referenced by PCB_DRAW_PANEL_GAL::setDefaultLayerDeps().

412  {
413  wxASSERT( aLayer < (int) m_layers.size() );
414 
415  m_layers[aLayer].displayOnly = aDisplayOnly;
416  }
LAYER_MAP m_layers
Contains set of possible displayed layers and its properties.
Definition: view.h:752
void KIGFX::VIEW::SetLayerOrder ( int  aLayer,
int  aRenderingOrder 
)

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

Lower values are rendered first.

Parameters
aLayerthe layer
aRenderingOrderarbitrary number denoting the rendering order.

Definition at line 588 of file view.cpp.

References m_layers, and sortLayers().

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

589 {
590  m_layers[aLayer].renderingOrder = aRenderingOrder;
591 
592  sortLayers();
593 }
void sortLayers()
Definition: view.cpp:1111
LAYER_MAP m_layers
Contains set of possible displayed layers and its properties.
Definition: view.h:752
void KIGFX::VIEW::SetLayerTarget ( int  aLayer,
RENDER_TARGET  aTarget 
)
inline

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

Parameters
aLayeris the layer.
aTargetis the rendering target.

Definition at line 424 of file view.h.

References m_layers.

Referenced by PCB_DRAW_PANEL_GAL::setDefaultLayerDeps().

425  {
426  wxASSERT( aLayer < (int) m_layers.size() );
427 
428  m_layers[aLayer].target = aTarget;
429  }
LAYER_MAP m_layers
Contains set of possible displayed layers and its properties.
Definition: view.h:752
void KIGFX::VIEW::SetLayerVisible ( int  aLayer,
bool  aVisible = true 
)
inline

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

Parameters
aLayerthe layer to show/hide.
aVisiblethe obvious.

Definition at line 387 of file view.h.

References m_layers, and MarkTargetDirty().

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

388  {
389  wxASSERT( aLayer < (int) m_layers.size() );
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)
Function MarkTargetDirty() Sets or clears target 'dirty' flag.
Definition: view.h:575
LAYER_MAP m_layers
Contains set of possible displayed layers and its properties.
Definition: view.h:752
void KIGFX::VIEW::SetMirror ( bool  aMirrorX,
bool  aMirrorY 
)

Function SetMirror() Controls the mirroring of the VIEW.

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

Definition at line 527 of file view.cpp.

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

Referenced by SetGAL().

528 {
529  wxASSERT_MSG( !aMirrorY, _( "Mirroring for Y axis is not supported yet" ) );
530 
531  m_mirrorX = aMirrorX;
532  m_mirrorY = aMirrorY;
533  m_gal->SetFlip( aMirrorX, aMirrorY );
534 
535  // Redraw everything
536  MarkDirty();
537 }
void SetFlip(bool xAxis, bool yAxis)
Sets flipping of the screen.
GAL * m_gal
Gives interface to PAINTER, that is used to draw items.
Definition: view.h:785
bool m_mirrorX
Horizontal flip flag
Definition: view.h:776
bool m_mirrorY
Vertical flip flag
Definition: view.h:779
void MarkDirty()
Function MarkDirty() Forces redraw of view on the next rendering.
Definition: view.h:601
void KIGFX::VIEW::SetPainter ( PAINTER aPainter)
inline

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

Definition at line 186 of file view.h.

References m_painter.

Referenced by PCB_DRAW_PANEL_GAL::PCB_DRAW_PANEL_GAL().

187  {
188  m_painter = aPainter;
189  }
PAINTER * m_painter
PAINTER contains information how do draw items.
Definition: view.h:782
void KIGFX::VIEW::SetRequired ( int  aLayerId,
int  aRequiredId,
bool  aRequired = true 
)

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

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

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

Definition at line 380 of file view.cpp.

References m_layers.

Referenced by PCB_DRAW_PANEL_GAL::setDefaultLayerDeps().

381 {
382  wxASSERT( (unsigned) aLayerId < m_layers.size() );
383  wxASSERT( (unsigned) aRequiredId < m_layers.size() );
384 
385  if( aRequired )
386  m_layers[aLayerId].requiredLayers.insert( aRequiredId );
387  else
388  m_layers[aLayerId].requiredLayers.erase( aRequired );
389 }
LAYER_MAP m_layers
Contains set of possible displayed layers and its properties.
Definition: view.h:752
void KIGFX::VIEW::SetScale ( double  aScale)
inline

Function SetScale() Sets the scaling factor.

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

Parameters
aScalethe scalefactor

Definition at line 247 of file view.h.

References m_center.

Referenced by KIGFX::WX_VIEW_CONTROLS::onWheel(), DIALOG_PAD_PROPERTIES::redraw(), FOOTPRINT_PREVIEW_PANEL::renderFootprint(), SetGAL(), SetViewport(), EDA_DRAW_FRAME::UseGalCanvas(), COMMON_TOOLS::ZoomFitScreen(), SELECTION_TOOL::zoomFitSelection(), COMMON_TOOLS::ZoomInOut(), COMMON_TOOLS::ZoomInOutCenter(), and COMMON_TOOLS::ZoomPreset().

248  {
249  SetScale( aScale, m_center );
250  }
void SetScale(double aScale)
Function SetScale() Sets the scaling factor.
Definition: view.h:247
VECTOR2D m_center
Center point of the VIEW (the point at which we are looking at)
Definition: view.h:761
void KIGFX::VIEW::SetScale ( double  aScale,
const VECTOR2D aAnchor 
)

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

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

Parameters
aAnchorthe zooming anchor point
aScalethe scale factor

Definition at line 540 of file view.cpp.

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

541 {
542  VECTOR2D a = ToScreen( aAnchor );
543 
544  if( aScale < m_minScale )
546  else if( aScale > m_maxScale )
548  else
549  m_scale = aScale;
550 
553 
554  VECTOR2D delta = ToWorld( a ) - aAnchor;
555 
556  SetCenter( m_center - delta );
557 
558  // Redraw everything after the viewport has changed
559  MarkDirty();
560 }
VECTOR2D ToWorld(const VECTOR2D &aCoord, bool aAbsolute=true) const
Function ToWorld() Converts a screen space point/vector to a point/vector in world space coordinates...
Definition: view.cpp:439
GAL * m_gal
Gives interface to PAINTER, that is used to draw items.
Definition: view.h:785
virtual void ComputeWorldScreenMatrix()
Compute the world <-> screen transformation matrix.
static const int delta[8][2]
Definition: solve.cpp:112
VECTOR2D m_center
Center point of the VIEW (the point at which we are looking at)
Definition: view.h:761
double m_minScale
Scale lower limit.
Definition: view.h:770
void SetCenter(const VECTOR2D &aCenter)
Function SetCenter() Sets the center point of the VIEW (i.e.
Definition: view.cpp:563
double m_maxScale
Scale upper limit.
Definition: view.h:773
VECTOR2D ToScreen(const VECTOR2D &aCoord, bool aAbsolute=true) const
Function ToScreen() Converts a world space point/vector to a point/vector in screen space coordinates...
Definition: view.cpp:458
void SetZoomFactor(double aZoomFactor)
Set the zoom factor of the scene.
double m_scale
Scale of displayed VIEW_ITEMs.
Definition: view.h:764
void MarkDirty()
Function MarkDirty() Forces redraw of view on the next rendering.
Definition: view.h:601
void KIGFX::VIEW::SetScaleLimits ( double  aMaximum,
double  aMinimum 
)
inline

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

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

Definition at line 295 of file view.h.

References m_maxScale, and m_minScale.

296  {
297  wxASSERT_MSG( aMaximum > aMinimum, wxT( "I guess you passed parameters in wrong order" ) );
298 
299  m_minScale = aMinimum;
300  m_maxScale = aMaximum;
301  }
double m_minScale
Scale lower limit.
Definition: view.h:770
double m_maxScale
Scale upper limit.
Definition: view.h:773
void KIGFX::VIEW::SetTopLayer ( int  aLayer,
bool  aEnabled = true 
)

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

Parameters
aLayerthe layer or -1 in case when no particular layer should be displayed on the top.

Definition at line 747 of file view.cpp.

References m_enableOrderModifier, m_layers, m_topLayers, and TOP_LAYER_MODIFIER.

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

748 {
749  if( aEnabled )
750  {
751  if( m_topLayers.count( aLayer ) == 1 )
752  return;
753 
754  m_topLayers.insert( aLayer );
755 
756  // Move the layer closer to front
758  m_layers[aLayer].renderingOrder += TOP_LAYER_MODIFIER;
759  }
760  else
761  {
762  if( m_topLayers.count( aLayer ) == 0 )
763  return;
764 
765  m_topLayers.erase( aLayer );
766 
767  // Restore the previous rendering order
769  m_layers[aLayer].renderingOrder -= TOP_LAYER_MODIFIER;
770  }
771 }
static const int TOP_LAYER_MODIFIER
Rendering order modifier for layers that are marked as top layers.
Definition: view.h:795
std::set< unsigned int > m_topLayers
Stores set of layers that are displayed on the top.
Definition: view.h:758
bool m_enableOrderModifier
Definition: view.h:749
LAYER_MAP m_layers
Contains set of possible displayed layers and its properties.
Definition: view.h:752
void KIGFX::VIEW::SetViewport ( const BOX2D aViewport)

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

Parameters
aViewportdesired visible area, in world space coordinates.

Definition at line 512 of file view.cpp.

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

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

513 {
514  VECTOR2D ssize = ToWorld( m_gal->GetScreenPixelSize(), false );
515 
516  wxASSERT( ssize.x > 0 && ssize.y > 0 );
517 
518  VECTOR2D centre = aViewport.Centre();
519  VECTOR2D vsize = aViewport.GetSize();
520  double zoom = 1.0 / std::max( fabs( vsize.x / ssize.x ), fabs( vsize.y / ssize.y ) );
521 
522  SetCenter( centre );
523  SetScale( GetScale() * zoom );
524 }
VECTOR2D ToWorld(const VECTOR2D &aCoord, bool aAbsolute=true) const
Function ToWorld() Converts a screen space point/vector to a point/vector in world space coordinates...
Definition: view.cpp:439
GAL * m_gal
Gives interface to PAINTER, that is used to draw items.
Definition: view.h:785
const Vec & GetSize() const
Definition: box2.h:177
void SetScale(double aScale)
Function SetScale() Sets the scaling factor.
Definition: view.h:247
void SetCenter(const VECTOR2D &aCenter)
Function SetCenter() Sets the center point of the VIEW (i.e.
Definition: view.cpp:563
Vec Centre() const
Definition: box2.h:67
const VECTOR2I & GetScreenPixelSize() const
Returns GAL canvas size in pixels.
#define max(a, b)
Definition: auxiliary.h:86
double GetScale() const
Function GetScale()
Definition: view.h:265
void KIGFX::VIEW::SetVisible ( VIEW_ITEM aItem,
bool  aIsVisible = true 
)

Function SetVisible() Sets the item visibility.

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

Definition at line 1330 of file view.cpp.

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

Referenced by Add(), SELECTION_TOOL::disambiguationMenu(), MICROWAVE_TOOL::drawMicrowaveInductor(), PNS_KICAD_IFACE::EraseView(), PNS_KICAD_IFACE::HideItem(), EDIT_TOOL::MeasureTool(), ZONE_CREATE_HELPER::OnComplete(), ZONE_CREATE_HELPER::OnFirstPoint(), FOOTPRINT_PREVIEW_PANEL::renderFootprint(), SELECTION_TOOL::selectMultiple(), and ZONE_CREATE_HELPER::~ZONE_CREATE_HELPER().

1331 {
1332  auto viewData = aItem->viewPrivData();
1333 
1334  if( !viewData )
1335  return;
1336 
1337  bool cur_visible = viewData->m_flags & VISIBLE;
1338 
1339  if( cur_visible != aIsVisible )
1340  {
1341  if( aIsVisible )
1342  viewData->m_flags |= VISIBLE;
1343  else
1344  viewData->m_flags &= ~VISIBLE;
1345 
1346  Update( aItem, APPEARANCE | COLOR );
1347  }
1348 }
No updates are required.
Definition: view_item.h:55
Visibility flag has changed.
Definition: view_item.h:56
void Update(VIEW_ITEM *aItem)
Function Update() For dynamic VIEWs, informs the associated VIEW that the graphical representation of...
Definition: view.cpp:1378
void KIGFX::VIEW::SortLayers ( int  aLayers[],
int &  aCount 
) const

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

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

References GetLayerOrder().

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

603 {
604  int maxLay, maxOrd, maxIdx;
605 
606  for( int i = 0; i < aCount; ++i )
607  {
608  maxLay = aLayers[i];
609  maxOrd = GetLayerOrder( maxLay );
610  maxIdx = i;
611 
612  // Look for the max element in the range (j..aCount)
613  for( int j = i; j < aCount; ++j )
614  {
615  if( maxOrd < GetLayerOrder( aLayers[j] ) )
616  {
617  maxLay = aLayers[j];
618  maxOrd = GetLayerOrder( maxLay );
619  maxIdx = j;
620  }
621  }
622 
623  // Swap elements
624  aLayers[maxIdx] = aLayers[i];
625  aLayers[i] = maxLay;
626  }
627 }
int GetLayerOrder(int aLayer) const
Function GetLayerOrder() Returns rendering order of a particular layer.
Definition: view.cpp:596
void KIGFX::VIEW::sortLayers ( )
private
  • Sorts m_orderedLayers when layer rendering order has changed

Definition at line 1111 of file view.cpp.

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

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

1112 {
1113  int n = 0;
1114 
1115  m_orderedLayers.resize( m_layers.size() );
1116 
1117  for( LAYER_MAP_ITER i = m_layers.begin(); i != m_layers.end(); ++i )
1118  m_orderedLayers[n++] = &i->second;
1119 
1120  sort( m_orderedLayers.begin(), m_orderedLayers.end(), compareRenderingOrder );
1121 
1122  MarkDirty();
1123 }
LAYER_ORDER m_orderedLayers
Sorted list of pointers to members of m_layers.
Definition: view.h:755
LAYER_MAP::iterator LAYER_MAP_ITER
Definition: view.h:656
LAYER_MAP m_layers
Contains set of possible displayed layers and its properties.
Definition: view.h:752
static bool compareRenderingOrder(VIEW_LAYER *aI, VIEW_LAYER *aJ)
Determines rendering order of layers. Used in display order sorting function.
Definition: view.h:740
void MarkDirty()
Function MarkDirty() Forces redraw of view on the next rendering.
Definition: view.h:601
VECTOR2D KIGFX::VIEW::ToScreen ( const VECTOR2D aCoord,
bool  aAbsolute = true 
) const

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

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

Definition at line 458 of file view.cpp.

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

Referenced by PCBNEW_CONTROL::CursorControl(), TOOL_DISPATCHER::handleMouseButton(), SetScale(), and KIGFX::WX_VIEW_CONTROLS::WarpCursor().

459 {
460  const MATRIX3x3D& matrix = m_gal->GetWorldScreenMatrix();
461 
462  if( aAbsolute )
463  return VECTOR2D( matrix * aCoord );
464  else
465  return VECTOR2D( matrix.GetScale().x * aCoord.x, matrix.GetScale().y * aCoord.y );
466 }
GAL * m_gal
Gives interface to PAINTER, that is used to draw items.
Definition: view.h:785
const MATRIX3x3D & GetWorldScreenMatrix() const
Get the world <-> screen transformation matrix.
VECTOR2< double > VECTOR2D
Definition: vector2d.h:589
VECTOR2< T > GetScale() const
Get the scale components of the matrix.
Definition: matrix3x3.h:269
double KIGFX::VIEW::ToScreen ( double  aSize) const

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

Parameters
aCoordthe size to be transformed.

Definition at line 469 of file view.cpp.

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

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

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

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

Definition at line 439 of file view.cpp.

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

Referenced by PCBNEW_CONTROL::CursorControl(), TOOL_DISPATCHER::DispatchWxEvent(), EDIT_POINTS::FindPoint(), KIGFX::WX_VIEW_CONTROLS::GetCursorPosition(), GetViewport(), KIGFX::WX_VIEW_CONTROLS::onMotion(), KIGFX::WX_VIEW_CONTROLS::onTimer(), KIGFX::WX_VIEW_CONTROLS::onWheel(), Redraw(), SELECTION_TOOL::selectionContains(), SetScale(), SetViewport(), PNS::TOOL_BASE::updateEndItem(), KIGFX::ORIGIN_VIEWITEM::ViewDraw(), EDIT_POINTS::ViewDraw(), COMMON_TOOLS::ZoomFitScreen(), and SELECTION_TOOL::zoomFitSelection().

440 {
441  const MATRIX3x3D& matrix = m_gal->GetScreenWorldMatrix();
442 
443  if( aAbsolute )
444  return VECTOR2D( matrix * aCoord );
445  else
446  return VECTOR2D( matrix.GetScale().x * aCoord.x, matrix.GetScale().y * aCoord.y );
447 }
const MATRIX3x3D & GetScreenWorldMatrix() const
Get the screen <-> world transformation matrix.
GAL * m_gal
Gives interface to PAINTER, that is used to draw items.
Definition: view.h:785
VECTOR2< double > VECTOR2D
Definition: vector2d.h:589
VECTOR2< T > GetScale() const
Get the scale components of the matrix.
Definition: matrix3x3.h:269
double KIGFX::VIEW::ToWorld ( double  aSize) const

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

Parameters
aSize: the size to be converted

Definition at line 450 of file view.cpp.

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

451 {
452  const MATRIX3x3D& matrix = m_gal->GetScreenWorldMatrix();
453 
454  return matrix.GetScale().x * aSize;
455 }
const MATRIX3x3D & GetScreenWorldMatrix() const
Get the screen <-> world transformation matrix.
GAL * m_gal
Gives interface to PAINTER, that is used to draw items.
Definition: view.h:785
VECTOR2< T > GetScale() const
Get the scale components of the matrix.
Definition: matrix3x3.h:269
void KIGFX::VIEW::Update ( VIEW_ITEM aItem)

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

For static views calling has no effect.

Parameters
aUpdateFlagshow much the object has changed.

Definition at line 1378 of file view.cpp.

References KIGFX::ALL.

Referenced by Add(), PNS_PCBNEW_DEBUG_DECORATOR::AddLine(), PNS_PCBNEW_DEBUG_DECORATOR::Clear(), SELECTION_TOOL::disambiguationMenu(), PNS_KICAD_IFACE::DisplayItem(), PCB_TOOL::doInteractiveItemPlacement(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::drawSegment(), PCB_EDIT_FRAME::Edit_Zone_Params(), MODULE_EDITOR_TOOLS::EnumeratePads(), PNS_KICAD_IFACE::EraseView(), PCB_EDIT_FRAME::Fill_Zone(), Hide(), PNS_KICAD_IFACE::HideItem(), EDIT_TOOL::Main(), EDIT_TOOL::MeasureTool(), MODULE_EDITOR_TOOLS::ModuleEdgeOutlines(), MODULE_EDITOR_TOOLS::ModuleTextOutlines(), EDIT_TOOL::MoveExact(), ZONE_CREATE_HELPER::OnGeometryChange(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::OnOkClick(), KIGFX::VIEW::recacheItem::operator()(), PCBNEW_CONTROL::PadDisplayMode(), MODULE_EDITOR_TOOLS::PasteItems(), DRAWING_TOOL::PlaceDXF(), PCB_EDITOR_CONTROL::PlaceModule(), MODULE_EDITOR_TOOLS::PlacePad(), PCB_EDITOR_CONTROL::PlaceTarget(), DRAWING_TOOL::PlaceText(), PCB_EDIT_FRAME::Process_Config(), BOARD_COMMIT::Push(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), PCB_BASE_FRAME::RecalculateAllTracksNetcode(), DIALOG_PAD_PROPERTIES::redraw(), FOOTPRINT_PREVIEW_PANEL::renderFootprint(), SELECTION_TOOL::selectMultiple(), SELECTION_TOOL::selectVisually(), SetVisible(), PCBNEW_CONTROL::TrackDisplayMode(), SELECTION_TOOL::unselectVisually(), POINT_EDITOR::updatePoints(), PCBNEW_CONTROL::ViaDisplayMode(), PCBNEW_CONTROL::ZoneDisplayMode(), PCB_EDITOR_CONTROL::ZoneFill(), PCB_EDITOR_CONTROL::ZoneFillAll(), PCB_EDITOR_CONTROL::ZoneUnfill(), and PCB_EDITOR_CONTROL::ZoneUnfillAll().

1379 {
1380  Update( aItem, ALL );
1381 }
Layers have changed.
Definition: view_item.h:59
void Update(VIEW_ITEM *aItem)
Function Update() For dynamic VIEWs, informs the associated VIEW that the graphical representation of...
Definition: view.cpp:1378
void KIGFX::VIEW::Update ( VIEW_ITEM aItem,
int  aUpdateFlags 
)

Definition at line 1384 of file view.cpp.

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

1385 {
1386  auto viewData = aItem->viewPrivData();
1387 
1388  if( !viewData )
1389  return;
1390 
1391  assert( aUpdateFlags != NONE );
1392 
1393  viewData->m_requiredUpdate |= aUpdateFlags;
1394 
1395 }
void KIGFX::VIEW::UpdateAllLayersColor ( )

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

The used scheme is held by RENDER_SETTINGS.

See also
RENDER_SETTINGS

Definition at line 673 of file view.cpp.

References KIGFX::GAL::BeginUpdate(), KIGFX::GAL::EndUpdate(), KIGFX::VIEW::VIEW_LAYER::id, IsCached(), KIGFX::VIEW::VIEW_LAYER::items, m_gal, m_layers, m_painter, MarkDirty(), KIGFX::VIEW_RTREE::Query(), and BOX2< Vec >::SetMaximum().

Referenced by EnableTopLayer(), PNS::TOOL_BASE::highlightNet(), PCB_EDITOR_CONTROL::HighlightNet(), highlightNet(), PCB_EDIT_FRAME::ListNetsAndSelect(), PCB_DRAW_PANEL_GAL::SetHighContrastLayer(), and EDA_DRAW_PANEL_GAL::SetHighContrastLayer().

674 {
675  BOX2I r;
676 
677  r.SetMaximum();
678  m_gal->BeginUpdate();
679 
680  for( LAYER_MAP_ITER i = m_layers.begin(); i != m_layers.end(); ++i )
681  {
682  VIEW_LAYER* l = &( ( *i ).second );
683 
684  // There is no point in updating non-cached layers
685  if( !IsCached( l->id ) )
686  continue;
687 
688  updateItemsColor visitor( l->id, m_painter, m_gal );
689  l->items->Query( r, visitor );
690  }
691 
692  m_gal->EndUpdate();
693  MarkDirty();
694 }
virtual void EndUpdate()
Disables item update mode.
GAL * m_gal
Gives interface to PAINTER, that is used to draw items.
Definition: view.h:785
void SetMaximum()
Definition: box2.h:61
virtual void BeginUpdate()
Enables item update mode.
PAINTER * m_painter
PAINTER contains information how do draw items.
Definition: view.h:782
LAYER_MAP::iterator LAYER_MAP_ITER
Definition: view.h:656
bool IsCached(int aLayer) const
Returns true if the layer is cached.
Definition: view.h:583
LAYER_MAP m_layers
Contains set of possible displayed layers and its properties.
Definition: view.h:752
void MarkDirty()
Function MarkDirty() Forces redraw of view on the next rendering.
Definition: view.h:601
void KIGFX::VIEW::UpdateAllLayersOrder ( )

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

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

Definition at line 814 of file view.cpp.

References ChangeLayerDepth(), m_layers, MarkDirty(), and sortLayers().

Referenced by EnableTopLayer(), PCB_DRAW_PANEL_GAL::SetTopLayer(), and EDA_DRAW_PANEL_GAL::SetTopLayer().

815 {
816  sortLayers();
817 
818  for( LAYER_MAP::value_type& l : m_layers )
819  {
820  ChangeLayerDepth( l.first, l.second.renderingOrder );
821  }
822 
823  MarkDirty();
824 }
void sortLayers()
Definition: view.cpp:1111
void ChangeLayerDepth(int aLayer, int aDepth)
Function ChangeLayerDepth() Changes the depth of items on the given layer.
Definition: view.cpp:719
LAYER_MAP m_layers
Contains set of possible displayed layers and its properties.
Definition: view.h:752
void MarkDirty()
Function MarkDirty() Forces redraw of view on the next rendering.
Definition: view.h:601
void KIGFX::VIEW::updateBbox ( VIEW_ITEM aItem)
private

Updates bounding box of an item.

Definition at line 1175 of file view.cpp.

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

Referenced by invalidateItem().

1176 {
1177  int layers[VIEW_MAX_LAYERS], layers_count;
1178 
1179  aItem->ViewGetLayers( layers, layers_count );
1180 
1181  for( int i = 0; i < layers_count; ++i )
1182  {
1183  VIEW_LAYER& l = m_layers[layers[i]];
1184  l.items->Remove( aItem );
1185  l.items->Insert( aItem );
1186  MarkTargetDirty( l.target );
1187  }
1188 }
void MarkTargetDirty(int aTarget)
Function MarkTargetDirty() Sets or clears target 'dirty' flag.
Definition: view.h:575
static const int VIEW_MAX_LAYERS
maximum number of layers that may be shown
Definition: view.h:640
LAYER_MAP m_layers
Contains set of possible displayed layers and its properties.
Definition: view.h:752
void KIGFX::VIEW::updateItemColor ( VIEW_ITEM aItem,
int  aLayer 
)
private

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

Definition at line 1126 of file view.cpp.

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

Referenced by invalidateItem().

1127 {
1128  auto viewData = aItem->viewPrivData();
1129  wxASSERT( (unsigned) aLayer < m_layers.size() );
1130  wxASSERT( IsCached( aLayer ) );
1131 
1132  if( !viewData )
1133  return;
1134 
1135  // Obtain the color that should be used for coloring the item on the specific layerId
1136  const COLOR4D color = m_painter->GetSettings()->GetColor( aItem, aLayer );
1137  int group = viewData->getGroup( aLayer );
1138 
1139  // Change the color, only if it has group assigned
1140  if( group >= 0 )
1141  m_gal->ChangeGroupColor( group, color );
1142 }
GAL * m_gal
Gives interface to PAINTER, that is used to draw items.
Definition: view.h:785
virtual const COLOR4D & GetColor(const VIEW_ITEM *aItem, int aLayer) const =0
Function GetColor Returns the color that should be used to draw the specific VIEW_ITEM on the specifi...
virtual void ChangeGroupColor(int aGroupNumber, const COLOR4D &aNewColor)
Changes the color used to draw the group.
PAINTER * m_painter
PAINTER contains information how do draw items.
Definition: view.h:782
virtual RENDER_SETTINGS * GetSettings()=0
Function GetSettings Returns pointer to current settings that are going to be used when drawing items...
bool IsCached(int aLayer) const
Returns true if the layer is cached.
Definition: view.h:583
LAYER_MAP m_layers
Contains set of possible displayed layers and its properties.
Definition: view.h:752
Class COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:39
void KIGFX::VIEW::updateItemGeometry ( VIEW_ITEM aItem,
int  aLayer 
)
private

Updates all informations needed to draw an item.

Definition at line 1145 of file view.cpp.

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().

1146 {
1147  auto viewData = aItem->viewPrivData();
1148  wxASSERT( (unsigned) aLayer < m_layers.size() );
1149  wxASSERT( IsCached( aLayer ) );
1150 
1151  if( !viewData )
1152  return;
1153 
1154  VIEW_LAYER& l = m_layers.at( aLayer );
1155 
1156  m_gal->SetTarget( l.target );
1157  m_gal->SetLayerDepth( l.renderingOrder );
1158 
1159  // Redraw the item from scratch
1160  int group = viewData->getGroup( aLayer );
1161 
1162  if( group >= 0 )
1163  m_gal->DeleteGroup( group );
1164 
1165  group = m_gal->BeginGroup();
1166  viewData->setGroup( aLayer, group );
1167 
1168  if( !m_painter->Draw( static_cast<EDA_ITEM*>( aItem ), aLayer ) )
1169  aItem->ViewDraw( aLayer, this ); // Alternative drawing method
1170 
1171  m_gal->EndGroup();
1172 }
virtual void DeleteGroup(int aGroupNumber)
Delete the group from the memory.
GAL * m_gal
Gives interface to PAINTER, that is used to draw items.
Definition: view.h:785
virtual void SetLayerDepth(double aLayerDepth)
Set the depth of the layer (position on the z-axis)
virtual void EndGroup()
End the group.
virtual int BeginGroup()
Begin a group.
PAINTER * m_painter
PAINTER contains information how do draw items.
Definition: view.h:782
virtual bool Draw(const VIEW_ITEM *aItem, int aLayer)=0
Function Draw Takes an instance of VIEW_ITEM and passes it to a function that know how to draw the it...
bool IsCached(int aLayer) const
Returns true if the layer is cached.
Definition: view.h:583
LAYER_MAP m_layers
Contains set of possible displayed layers and its properties.
Definition: view.h:752
virtual void SetTarget(RENDER_TARGET aTarget)
Sets the target for rendering.
void KIGFX::VIEW::UpdateItems ( )

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

Definition at line 1271 of file view.cpp.

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

Referenced by EDA_DRAW_PANEL_GAL::onPaint().

1272 {
1273  m_gal->BeginUpdate();
1274 
1275  for( VIEW_ITEM* item : m_allItems )
1276  {
1277  auto viewData = item->viewPrivData();
1278 
1279  if( !viewData )
1280  continue;
1281 
1282  if( viewData->m_requiredUpdate != NONE )
1283  {
1284  invalidateItem( item, viewData->m_requiredUpdate );
1285  viewData->m_requiredUpdate = NONE;
1286  }
1287  }
1288 
1289  m_gal->EndUpdate();
1290 }
friend class VIEW_ITEM
Definition: view.h:61
virtual void EndUpdate()
Disables item update mode.
GAL * m_gal
Gives interface to PAINTER, that is used to draw items.
Definition: view.h:785
void invalidateItem(VIEW_ITEM *aItem, int aUpdateFlags)
Function invalidateItem() Manages dirty flags & redraw queueing when updating an item.
Definition: view.cpp:1079
virtual void BeginUpdate()
Enables item update mode.
std::vector< VIEW_ITEM * > m_allItems
Flat list of all items.
Definition: view.h:798
void KIGFX::VIEW::UpdateLayerColor ( int  aLayer)

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

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

Definition at line 655 of file view.cpp.

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

Referenced by PCBNEW_CONTROL::LayerAlphaDec(), PCBNEW_CONTROL::LayerAlphaInc(), PCB_LAYER_WIDGET::OnLayerColorChange(), and PCB_LAYER_WIDGET::OnRenderColorChange().

656 {
657  // There is no point in updating non-cached layers
658  if( !IsCached( aLayer ) )
659  return;
660 
661  BOX2I r;
662 
663  r.SetMaximum();
664 
665  m_gal->BeginUpdate();
666  updateItemsColor visitor( aLayer, m_painter, m_gal );
667  m_layers[aLayer].items->Query( r, visitor );
668  MarkTargetDirty( m_layers[aLayer].target );
669  m_gal->EndUpdate();
670 }
virtual void EndUpdate()
Disables item update mode.
GAL * m_gal
Gives interface to PAINTER, that is used to draw items.
Definition: view.h:785
void MarkTargetDirty(int aTarget)
Function MarkTargetDirty() Sets or clears target 'dirty' flag.
Definition: view.h:575
void SetMaximum()
Definition: box2.h:61
virtual void BeginUpdate()
Enables item update mode.
PAINTER * m_painter
PAINTER contains information how do draw items.
Definition: view.h:782
bool IsCached(int aLayer) const
Returns true if the layer is cached.
Definition: view.h:583
LAYER_MAP m_layers
Contains set of possible displayed layers and its properties.
Definition: view.h:752
void KIGFX::VIEW::updateLayers ( VIEW_ITEM aItem)
private

Updates set of layers that an item occupies.

Definition at line 1191 of file view.cpp.

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

Referenced by invalidateItem().

1192 {
1193  auto viewData = aItem->viewPrivData();
1194  int layers[VIEW_MAX_LAYERS], layers_count;
1195 
1196  if( !viewData )
1197  return;
1198 
1199  // Remove the item from previous layer set
1200  viewData->getLayers( layers, layers_count );
1201 
1202  for( int i = 0; i < layers_count; ++i )
1203  {
1204  VIEW_LAYER& l = m_layers[layers[i]];
1205  l.items->Remove( aItem );
1206  MarkTargetDirty( l.target );
1207 
1208  if( IsCached( l.id ) )
1209  {
1210  // Redraw the item from scratch
1211  int prevGroup = viewData->getGroup( layers[i] );
1212 
1213  if( prevGroup >= 0 )
1214  {
1215  m_gal->DeleteGroup( prevGroup );
1216  viewData->setGroup( l.id, -1 );
1217  }
1218  }
1219  }
1220 
1221  // Add the item to new layer set
1222  aItem->ViewGetLayers( layers, layers_count );
1223  viewData->saveLayers( layers, layers_count );
1224 
1225  for( int i = 0; i < layers_count; i++ )
1226  {
1227  VIEW_LAYER& l = m_layers[layers[i]];
1228  l.items->Insert( aItem );
1229  MarkTargetDirty( l.target );
1230  }
1231 }
virtual void DeleteGroup(int aGroupNumber)
Delete the group from the memory.
GAL * m_gal
Gives interface to PAINTER, that is used to draw items.
Definition: view.h:785
void MarkTargetDirty(int aTarget)
Function MarkTargetDirty() Sets or clears target 'dirty' flag.
Definition: view.h:575
static const int VIEW_MAX_LAYERS
maximum number of layers that may be shown
Definition: view.h:640
bool IsCached(int aLayer) const
Returns true if the layer is cached.
Definition: view.h:583
LAYER_MAP m_layers
Contains set of possible displayed layers and its properties.
Definition: view.h:752
void KIGFX::VIEW::UseDrawPriority ( bool  aFlag)
inline

Function UseDrawPriority()

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

Definition at line 635 of file view.h.

References m_useDrawPriority.

636  {
637  m_useDrawPriority = aFlag;
638  }
bool m_useDrawPriority
Flag to respect draw priority when drawing items.
Definition: view.h:801

Friends And Related Function Documentation

friend class VIEW_ITEM
friend

Definition at line 61 of file view.h.

Member Data Documentation

std::vector<VIEW_ITEM*> KIGFX::VIEW::m_allItems
private

Flat list of all items.

Definition at line 798 of file view.h.

Referenced by Add(), Clear(), Remove(), UpdateItems(), and VIEW().

BOX2I KIGFX::VIEW::m_boundary
private

View boundaries.

Definition at line 767 of file view.h.

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

VECTOR2D KIGFX::VIEW::m_center
private

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

Definition at line 761 of file view.h.

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

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

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

Definition at line 792 of file view.h.

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

bool KIGFX::VIEW::m_dynamic
private

Dynamic VIEW (eg.

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

Definition at line 789 of file view.h.

Referenced by IsDynamic().

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

Definition at line 749 of file view.h.

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

double KIGFX::VIEW::m_maxScale
private

Scale upper limit.

Definition at line 773 of file view.h.

Referenced by SetScale(), and SetScaleLimits().

double KIGFX::VIEW::m_minScale
private

Scale lower limit.

Definition at line 770 of file view.h.

Referenced by SetScale(), and SetScaleLimits().

bool KIGFX::VIEW::m_mirrorX
private

Horizontal flip flag

Definition at line 776 of file view.h.

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

bool KIGFX::VIEW::m_mirrorY
private

Vertical flip flag

Definition at line 779 of file view.h.

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

int KIGFX::VIEW::m_nextDrawPriority
private

The next sequential drawing priority.

Definition at line 804 of file view.h.

Referenced by Add(), and Clear().

LAYER_ORDER KIGFX::VIEW::m_orderedLayers
private

Sorted list of pointers to members of m_layers.

Definition at line 755 of file view.h.

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

PAINTER* KIGFX::VIEW::m_painter
private

PAINTER contains information how do draw items.

Definition at line 782 of file view.h.

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

double KIGFX::VIEW::m_scale
private

Scale of displayed VIEW_ITEMs.

Definition at line 764 of file view.h.

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

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

Stores set of layers that are displayed on the top.

Definition at line 758 of file view.h.

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

bool KIGFX::VIEW::m_useDrawPriority
private

Flag to respect draw priority when drawing items.

Definition at line 801 of file view.h.

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

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

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

Definition at line 795 of file view.h.

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

const int KIGFX::VIEW::VIEW_MAX_LAYERS = 256
static

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