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 = 512
 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 656 of file view.h.

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

Definition at line 657 of file view.h.

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

Definition at line 658 of file view.h.

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

Definition at line 659 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 261 of file view.cpp.

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

261  :
262  m_enableOrderModifier( true ),
263  m_scale( 4.0 ),
264  m_minScale( 4.0 ), m_maxScale( 15000 ),
265  m_mirrorX( false ), m_mirrorY( false ),
266  m_painter( NULL ),
267  m_gal( NULL ),
268  m_dynamic( aIsDynamic ),
269  m_useDrawPriority( false ),
270  m_nextDrawPriority( 0 )
271 {
273  m_allItems.reserve( 32768 );
274 
275  // Redraw everything at the beginning
276  MarkDirty();
277 
278  // View uses layers to display EDA_ITEMs (item may be displayed on several layers, for example
279  // pad may be shown on pad, pad hole and solder paste layers). There are usual copper layers
280  // (eg. F.Cu, B.Cu, internal and so on) and layers for displaying objects such as texts,
281  // silkscreen, pads, vias, etc.
282  for( int i = 0; i < VIEW_MAX_LAYERS; i++ )
283  AddLayer( i );
284 }
void AddLayer(int aLayer, bool aDisplayOnly=false)
Function AddLayer() Adds a new layer to the view.
Definition: view.cpp:294
bool m_useDrawPriority
Flag to respect draw priority when drawing items.
Definition: view.h:802
GAL * m_gal
Gives interface to PAINTER, that is used to draw items.
Definition: view.h:786
double m_minScale
Scale lower limit.
Definition: view.h:771
BOX2I m_boundary
View boundaries.
Definition: view.h:768
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:777
bool m_dynamic
Dynamic VIEW (eg.
Definition: view.h:790
PAINTER * m_painter
PAINTER contains information how do draw items.
Definition: view.h:783
int m_nextDrawPriority
The next sequential drawing priority.
Definition: view.h:805
double m_maxScale
Scale upper limit.
Definition: view.h:774
bool m_enableOrderModifier
Definition: view.h:750
std::vector< VIEW_ITEM * > m_allItems
Flat list of all items.
Definition: view.h:799
bool m_mirrorY
Vertical flip flag
Definition: view.h:780
double m_scale
Scale of displayed VIEW_ITEMs.
Definition: view.h:765
void MarkDirty()
Function MarkDirty() Forces redraw of view on the next rendering.
Definition: view.h:601
KIGFX::VIEW::~VIEW ( )

Definition at line 287 of file view.cpp.

References m_layers.

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

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

312 {
313  int layers[VIEW_MAX_LAYERS], layers_count;
314 
315  if( aDrawPriority < 0 )
316  aDrawPriority = m_nextDrawPriority++;
317 
318  if( !aItem->m_viewPrivData )
319  aItem->m_viewPrivData = new VIEW_ITEM_DATA;
320 
321  aItem->m_viewPrivData->m_view = this;
322  aItem->m_viewPrivData->m_drawPriority = aDrawPriority;
323 
324  aItem->ViewGetLayers( layers, layers_count );
325  aItem->viewPrivData()->saveLayers( layers, layers_count );
326 
327  m_allItems.push_back( aItem );
328 
329  for( int i = 0; i < layers_count; ++i )
330  {
331  VIEW_LAYER& l = m_layers[layers[i]];
332  l.items->Insert( aItem );
333  MarkTargetDirty( l.target );
334  }
335 
336  SetVisible( aItem, true );
337  Update( aItem, KIGFX::ALL );
338 }
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:805
void Update(VIEW_ITEM *aItem)
Function Update() For dynamic VIEWs, informs the associated VIEW that the graphical representation of...
Definition: view.cpp:1379
std::vector< VIEW_ITEM * > m_allItems
Flat list of all items.
Definition: view.h:799
void SetVisible(VIEW_ITEM *aItem, bool aIsVisible=true)
Function SetVisible() Sets the item visibility.
Definition: view.cpp:1331
LAYER_MAP m_layers
Contains set of possible displayed layers and its properties.
Definition: view.h:753
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 294 of file view.cpp.

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

Referenced by VIEW().

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

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

Definition at line 1235 of file view.cpp.

References m_layers.

Referenced by redrawRect().

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

Definition at line 1316 of file view.cpp.

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

1317 {
1318  extentsVisitor v;
1319  BOX2I fullScene;
1320  fullScene.SetMaximum();
1321 
1322  for( VIEW_LAYER* l : m_orderedLayers )
1323  {
1324  l->items->Query( fullScene, v );
1325  }
1326 
1327  return v.extents;
1328 }
void SetMaximum()
Definition: box2.h:61
LAYER_ORDER m_orderedLayers
Sorted list of pointers to members of m_layers.
Definition: view.h:756
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 720 of file view.cpp.

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

Referenced by UpdateAllLayersOrder().

721 {
722  // There is no point in updating non-cached layers
723  if( !IsCached( aLayer ) )
724  return;
725 
726  BOX2I r;
727 
728  r.SetMaximum();
729 
730  m_gal->BeginUpdate();
731  changeItemsDepth visitor( aLayer, aDepth, m_gal );
732  m_layers[aLayer].items->Query( r, visitor );
733  m_gal->EndUpdate();
734 
735  MarkTargetDirty( m_layers[aLayer].target );
736 }
virtual void EndUpdate()
Disables item update mode.
GAL * m_gal
Gives interface to PAINTER, that is used to draw items.
Definition: view.h:786
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:753
void KIGFX::VIEW::Clear ( )

Function Clear() Removes all items from the view.

Definition at line 982 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().

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

Definition at line 1065 of file view.cpp.

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

Referenced by SetGAL().

1066 {
1067  BOX2I r;
1068 
1069  r.SetMaximum();
1070  clearLayerCache visitor( this );
1071 
1072  for( LAYER_MAP_ITER i = m_layers.begin(); i != m_layers.end(); ++i )
1073  {
1074  VIEW_LAYER* l = &( ( *i ).second );
1075  l->items->Query( r, visitor );
1076  }
1077 }
void SetMaximum()
Definition: box2.h:61
LAYER_MAP::iterator LAYER_MAP_ITER
Definition: view.h:657
LAYER_MAP m_layers
Contains set of possible displayed layers and its properties.
Definition: view.h:753
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 997 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().

998 {
1000  {
1001  // TARGET_CACHED and TARGET_NONCACHED have to be redrawn together, as they contain
1002  // layers that rely on each other (eg. netnames are noncached, but tracks - are cached)
1005 
1006  MarkDirty();
1007  }
1008 
1009  if( IsTargetDirty( TARGET_OVERLAY ) )
1010  {
1012  }
1013 }
GAL * m_gal
Gives interface to PAINTER, that is used to draw items.
Definition: view.h:786
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 800 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().

801 {
802  std::set<unsigned int>::iterator it;
803 
805  {
806  // Restore the previous rendering order for layers that were marked as top
807  for( it = m_topLayers.begin(); it != m_topLayers.end(); ++it )
808  m_layers[*it].renderingOrder -= TOP_LAYER_MODIFIER;
809  }
810 
811  m_topLayers.clear();
812 }
static const int TOP_LAYER_MODIFIER
Rendering order modifier for layers that are marked as top layers.
Definition: view.h:796
std::set< unsigned int > m_topLayers
Stores set of layers that are displayed on the top.
Definition: view.h:759
bool m_enableOrderModifier
Definition: view.h:750
LAYER_MAP m_layers
Contains set of possible displayed layers and its properties.
Definition: view.h:753
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 741 of file view.h.

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

Referenced by sortLayers().

742  {
743  return aI->renderingOrder > aJ->renderingOrder;
744  }
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 478 of file view.cpp.

479 {
480  wxASSERT_MSG( false, wxT( "This is not implemented" ) );
481 }
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 890 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()().

891 {
892  auto viewData = aItem->viewPrivData();
893 
894  if( !viewData )
895  return;
896 
897  if( IsCached( aLayer ) && !aImmediate )
898  {
899  // Draw using cached information or create one
900  int group = viewData->getGroup( aLayer );
901 
902  if( group >= 0 )
903  {
904  m_gal->DrawGroup( group );
905  }
906  else
907  {
908  group = m_gal->BeginGroup();
909  viewData->setGroup( aLayer, group );
910 
911  if( !m_painter->Draw( aItem, aLayer ) )
912  aItem->ViewDraw( aLayer, this ); // Alternative drawing method
913 
914  m_gal->EndGroup();
915  }
916  }
917  else
918  {
919  // Immediate mode
920  if( !m_painter->Draw( aItem, aLayer ) )
921  aItem->ViewDraw( aLayer, this ); // Alternative drawing method
922  }
923 }
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:786
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:783
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 926 of file view.cpp.

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

927 {
928  int layers[VIEW_MAX_LAYERS], layers_count;
929 
930  aItem->ViewGetLayers( layers, layers_count );
931 
932  // Sorting is needed for drawing order dependent GALs (like Cairo)
933  SortLayers( layers, layers_count );
934 
935  for( int i = 0; i < layers_count; ++i )
936  {
937  m_gal->SetLayerDepth( m_layers.at( layers[i] ).renderingOrder );
938  draw( aItem, layers[i], aImmediate );
939  }
940 }
GAL * m_gal
Gives interface to PAINTER, that is used to draw items.
Definition: view.h:786
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:603
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:890
LAYER_MAP m_layers
Contains set of possible displayed layers and its properties.
Definition: view.h:753
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 943 of file view.cpp.

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

944 {
945  for( unsigned int i = 0; i < aGroup->GetSize(); i++)
946  draw( aGroup->GetItem(i), aImmediate );
947 }
void draw(VIEW_ITEM *aItem, int aLayer, bool aImmediate=false)
Function draw() Draws an item, but on a specified layers.
Definition: view.cpp:890
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 775 of file view.cpp.

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

776 {
777  if( aEnable == m_enableOrderModifier )
778  return;
779 
780  m_enableOrderModifier = aEnable;
781 
782  std::set<unsigned int>::iterator it;
783 
784  if( aEnable )
785  {
786  for( it = m_topLayers.begin(); it != m_topLayers.end(); ++it )
787  m_layers[*it].renderingOrder += TOP_LAYER_MODIFIER;
788  }
789  else
790  {
791  for( it = m_topLayers.begin(); it != m_topLayers.end(); ++it )
792  m_layers[*it].renderingOrder -= TOP_LAYER_MODIFIER;
793  }
794 
797 }
static const int TOP_LAYER_MODIFIER
Rendering order modifier for layers that are marked as top layers.
Definition: view.h:796
std::set< unsigned int > m_topLayers
Stores set of layers that are displayed on the top.
Definition: view.h:759
void UpdateAllLayersOrder()
Function UpdateLayerOrder() Does everything that is needed to apply the rendering order of layers...
Definition: view.cpp:815
bool m_enableOrderModifier
Definition: view.h:750
LAYER_MAP m_layers
Contains set of possible displayed layers and its properties.
Definition: view.h:753
void UpdateAllLayersColor()
Function UpdateAllLayersColor() Applies the new coloring scheme to all layers.
Definition: view.cpp:674
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:768
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:762
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 597 of file view.cpp.

References m_layers.

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

598 {
599  return m_layers.at( aLayer ).renderingOrder;
600 }
LAYER_MAP m_layers
Contains set of possible displayed layers and its properties.
Definition: view.h:753
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 1041 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().

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

Definition at line 739 of file view.cpp.

References m_topLayers.

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

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

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

Returns
Current viewport rectangle

Definition at line 501 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().

502 {
503  BOX2D rect;
504  VECTOR2D screenSize = m_gal->GetScreenPixelSize();
505 
506  rect.SetOrigin( ToWorld( VECTOR2D( 0, 0 ) ) );
507  rect.SetEnd( ToWorld( screenSize ) );
508 
509  return rect.Normalize();
510 }
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:440
GAL * m_gal
Gives interface to PAINTER, that is used to draw items.
Definition: view.h:786
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 1352 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().

1353 {
1354  auto viewData = aItem->viewPrivData();
1355 
1356  if( !viewData )
1357  return;
1358 
1359  if( !( viewData->m_flags & VISIBLE ) )
1360  return;
1361 
1362  if( aHide )
1363  viewData->m_flags |= HIDDEN;
1364  else
1365  viewData->m_flags &= ~HIDDEN;
1366 
1367  Update( aItem, APPEARANCE );
1368 }
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:1379
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 1080 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().

1081 {
1082  // updateLayers updates geometry too, so we do not have to update both of them at the same time
1083  if( aUpdateFlags & LAYERS )
1084  updateLayers( aItem );
1085  else if( aUpdateFlags & GEOMETRY )
1086  updateBbox( aItem );
1087 
1088  int layers[VIEW_MAX_LAYERS], layers_count;
1089  aItem->ViewGetLayers( layers, layers_count );
1090 
1091  // Iterate through layers used by the item and recache it immediately
1092  for( int i = 0; i < layers_count; ++i )
1093  {
1094  int layerId = layers[i];
1095 
1096  if( IsCached( layerId ) )
1097  {
1098  if( aUpdateFlags & ( GEOMETRY | LAYERS ) )
1099  updateItemGeometry( aItem, layerId );
1100  else if( aUpdateFlags & COLOR )
1101  updateItemColor( aItem, layerId );
1102  }
1103 
1104  // Mark those layers as dirty, so the VIEW will be refreshed
1105  MarkTargetDirty( m_layers[layerId].target );
1106  }
1107 
1108  aItem->viewPrivData()->clearUpdateFlags();
1109 }
void updateLayers(VIEW_ITEM *aItem)
Updates set of layers that an item occupies.
Definition: view.cpp:1192
void updateItemColor(VIEW_ITEM *aItem, int aLayer)
Updates colors that are used for an item to be drawn.
Definition: view.cpp:1127
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:1176
void updateItemGeometry(VIEW_ITEM *aItem, int aLayer)
Updates all informations needed to draw an item.
Definition: view.cpp:1146
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:753
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:753
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:790
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:753
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:777
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:780
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:793
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:802
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 1371 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().

1372 {
1373  const auto viewData = aItem->viewPrivData();
1374 
1375  return viewData->m_flags & VISIBLE;
1376 }
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:793
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 674 of file view.h.

References m_dirtyTargets, and KIGFX::TARGETS_NUMBER.

Referenced by Redraw().

675  {
676  wxASSERT( aTarget < TARGETS_NUMBER );
677 
678  m_dirtyTargets[aTarget] = false;
679  }
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:793
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::OnRenderColorChange(), 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:793
void KIGFX::VIEW::OnDestroy ( VIEW_ITEM aItem)
static

Definition at line 247 of file view.cpp.

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

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

248 {
249  auto data = aItem->viewPrivData();
250 
251  if( !data )
252  return;
253 
254  if( data->m_view )
255  data->m_view->Remove( aItem );
256 
257  delete data;
258 }
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 417 of file view.cpp.

References m_orderedLayers.

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

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

Function RecacheAllItems() Rebuilds GAL display lists.

Definition at line 1253 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().

1254 {
1255  BOX2I r;
1256 
1257  r.SetMaximum();
1258 
1259  for( LAYER_MAP_ITER i = m_layers.begin(); i != m_layers.end(); ++i )
1260  {
1261  VIEW_LAYER* l = &( ( *i ).second );
1262 
1263  if( IsCached( l->id ) )
1264  {
1265  recacheItem visitor( this, m_gal, l->id );
1266  l->items->Query( r, visitor );
1267  }
1268  }
1269 }
GAL * m_gal
Gives interface to PAINTER, that is used to draw items.
Definition: view.h:786
void SetMaximum()
Definition: box2.h:61
LAYER_MAP::iterator LAYER_MAP_ITER
Definition: view.h:657
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:753
void KIGFX::VIEW::Redraw ( )

Function Redraw() Immediately redraws the whole view.

Definition at line 1016 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().

1017 {
1018 #ifdef __WXDEBUG__
1019  PROF_COUNTER totalRealTime;
1020 #endif /* __WXDEBUG__ */
1021 
1022  VECTOR2D screenSize = m_gal->GetScreenPixelSize();
1023  BOX2I rect( ToWorld( VECTOR2D( 0, 0 ) ),
1024  ToWorld( screenSize ) - ToWorld( VECTOR2D( 0, 0 ) ) );
1025  rect.Normalize();
1026 
1027  redrawRect( rect );
1028 
1029  // All targets were redrawn, so nothing is dirty
1033 
1034 #ifdef __WXDEBUG__
1035  totalRealTime.Stop();
1036  wxLogTrace( "GAL_PROFILE", wxT( "VIEW::Redraw(): %.1f ms" ), totalRealTime.msecs() );
1037 #endif /* __WXDEBUG__ */
1038 }
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:440
GAL * m_gal
Gives interface to PAINTER, that is used to draw items.
Definition: view.h:786
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:674
const VECTOR2I & GetScreenPixelSize() const
Returns GAL canvas size in pixels.
double msecs() const
Definition: profile.h:124
void redrawRect(const BOX2I &aRect)
Definition: view.cpp:871
Main rendering target (cached)
Definition: definitions.h:41
void KIGFX::VIEW::redrawRect ( const BOX2I aRect)
private
  • Redraws contents within rect aRect

Definition at line 871 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().

872 {
873  for( VIEW_LAYER* l : m_orderedLayers )
874  {
875  if( l->visible && IsTargetDirty( l->target ) && areRequiredLayersEnabled( l->id ) )
876  {
877  drawItem drawFunc( this, l->id, m_useDrawPriority );
878 
879  m_gal->SetTarget( l->target );
880  m_gal->SetLayerDepth( l->renderingOrder );
881  l->items->Query( aRect, drawFunc );
882 
883  if( m_useDrawPriority )
884  drawFunc.deferredDraw();
885  }
886  }
887 }
bool m_useDrawPriority
Flag to respect draw priority when drawing items.
Definition: view.h:802
GAL * m_gal
Gives interface to PAINTER, that is used to draw items.
Definition: view.h:786
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:756
bool areRequiredLayersEnabled(int aLayerId) const
Checks if every layer required by the aLayerId layer is enabled.
Definition: view.cpp:1235
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 341 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().

342 {
343  if( !aItem )
344  return;
345 
346  auto viewData = aItem->viewPrivData();
347 
348  if( !viewData )
349  return;
350 
351  wxASSERT( viewData->m_view == this );
352  auto item = std::find( m_allItems.begin(), m_allItems.end(), aItem );
353 
354  if( item != m_allItems.end() )
355  {
356  m_allItems.erase( item );
357  viewData->clearUpdateFlags();
358  }
359 
360  int layers[VIEW::VIEW_MAX_LAYERS], layers_count;
361  viewData->getLayers( layers, layers_count );
362 
363  for( int i = 0; i < layers_count; ++i )
364  {
365  VIEW_LAYER& l = m_layers[layers[i]];
366  l.items->Remove( aItem );
367  MarkTargetDirty( l.target );
368 
369  // Clear the GAL cache
370  int prevGroup = viewData->getGroup( layers[i] );
371 
372  if( prevGroup >= 0 )
373  m_gal->DeleteGroup( prevGroup );
374  }
375 
376  viewData->deleteGroups();
377  viewData->m_view = nullptr;
378 }
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:786
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:799
LAYER_MAP m_layers
Contains set of possible displayed layers and its properties.
Definition: view.h:753
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:768
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 564 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().

565 {
566  m_center = aCenter;
567 
568  if( !m_boundary.Contains( aCenter ) )
569  {
570  if( m_center.x < m_boundary.GetLeft() )
572  else if( aCenter.x > m_boundary.GetRight() )
574 
575  if( m_center.y < m_boundary.GetTop() )
577  else if( m_center.y > m_boundary.GetBottom() )
579  }
580 
583 
584  // Redraw everything after the viewport has changed
585  MarkDirty();
586 }
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:786
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:762
BOX2I m_boundary
View boundaries.
Definition: view.h:768
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 484 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().

485 {
486  m_gal = aGal;
487 
488  // clear group numbers, so everything is going to be recached
489  clearGroupCache();
490 
491  // every target has to be refreshed
492  MarkDirty();
493 
494  // force the new GAL to display the current viewport.
495  SetCenter( m_center );
496  SetScale( m_scale );
498 }
GAL * m_gal
Gives interface to PAINTER, that is used to draw items.
Definition: view.h:786
void SetMirror(bool aMirrorX, bool aMirrorY)
Function SetMirror() Controls the mirroring of the VIEW.
Definition: view.cpp:528
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:762
void SetCenter(const VECTOR2D &aCenter)
Function SetCenter() Sets the center point of the VIEW (i.e.
Definition: view.cpp:564
bool m_mirrorX
Horizontal flip flag
Definition: view.h:777
void clearGroupCache()
Definition: view.cpp:1065
bool m_mirrorY
Vertical flip flag
Definition: view.h:780
double m_scale
Scale of displayed VIEW_ITEMs.
Definition: view.h:765
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:753
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 589 of file view.cpp.

References m_layers, and sortLayers().

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

590 {
591  m_layers[aLayer].renderingOrder = aRenderingOrder;
592 
593  sortLayers();
594 }
void sortLayers()
Definition: view.cpp:1112
LAYER_MAP m_layers
Contains set of possible displayed layers and its properties.
Definition: view.h:753
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:753
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:753
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 528 of file view.cpp.

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

Referenced by SetGAL().

529 {
530  wxASSERT_MSG( !aMirrorY, _( "Mirroring for Y axis is not supported yet" ) );
531 
532  m_mirrorX = aMirrorX;
533  m_mirrorY = aMirrorY;
534  m_gal->SetFlip( aMirrorX, aMirrorY );
535 
536  // Redraw everything
537  MarkDirty();
538 }
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:786
bool m_mirrorX
Horizontal flip flag
Definition: view.h:777
bool m_mirrorY
Vertical flip flag
Definition: view.h:780
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:783
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 381 of file view.cpp.

References m_layers.

Referenced by PCB_DRAW_PANEL_GAL::setDefaultLayerDeps().

382 {
383  wxASSERT( (unsigned) aLayerId < m_layers.size() );
384  wxASSERT( (unsigned) aRequiredId < m_layers.size() );
385 
386  if( aRequired )
387  m_layers[aLayerId].requiredLayers.insert( aRequiredId );
388  else
389  m_layers[aLayerId].requiredLayers.erase( aRequired );
390 }
LAYER_MAP m_layers
Contains set of possible displayed layers and its properties.
Definition: view.h:753
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:762
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 541 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().

542 {
543  VECTOR2D a = ToScreen( aAnchor );
544 
545  if( aScale < m_minScale )
547  else if( aScale > m_maxScale )
549  else
550  m_scale = aScale;
551 
554 
555  VECTOR2D delta = ToWorld( a ) - aAnchor;
556 
557  SetCenter( m_center - delta );
558 
559  // Redraw everything after the viewport has changed
560  MarkDirty();
561 }
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:440
GAL * m_gal
Gives interface to PAINTER, that is used to draw items.
Definition: view.h:786
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:762
double m_minScale
Scale lower limit.
Definition: view.h:771
void SetCenter(const VECTOR2D &aCenter)
Function SetCenter() Sets the center point of the VIEW (i.e.
Definition: view.cpp:564
double m_maxScale
Scale upper limit.
Definition: view.h:774
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:459
void SetZoomFactor(double aZoomFactor)
Set the zoom factor of the scene.
double m_scale
Scale of displayed VIEW_ITEMs.
Definition: view.h:765
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:771
double m_maxScale
Scale upper limit.
Definition: view.h:774
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 748 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().

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

514 {
515  VECTOR2D ssize = ToWorld( m_gal->GetScreenPixelSize(), false );
516 
517  wxASSERT( ssize.x > 0 && ssize.y > 0 );
518 
519  VECTOR2D centre = aViewport.Centre();
520  VECTOR2D vsize = aViewport.GetSize();
521  double zoom = 1.0 / std::max( fabs( vsize.x / ssize.x ), fabs( vsize.y / ssize.y ) );
522 
523  SetCenter( centre );
524  SetScale( GetScale() * zoom );
525 }
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:440
GAL * m_gal
Gives interface to PAINTER, that is used to draw items.
Definition: view.h:786
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:564
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 1331 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().

1332 {
1333  auto viewData = aItem->viewPrivData();
1334 
1335  if( !viewData )
1336  return;
1337 
1338  bool cur_visible = viewData->m_flags & VISIBLE;
1339 
1340  if( cur_visible != aIsVisible )
1341  {
1342  if( aIsVisible )
1343  viewData->m_flags |= VISIBLE;
1344  else
1345  viewData->m_flags &= ~VISIBLE;
1346 
1347  Update( aItem, APPEARANCE | COLOR );
1348  }
1349 }
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:1379
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 603 of file view.cpp.

References GetLayerOrder().

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

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

Definition at line 1112 of file view.cpp.

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

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

1113 {
1114  int n = 0;
1115 
1116  m_orderedLayers.resize( m_layers.size() );
1117 
1118  for( LAYER_MAP_ITER i = m_layers.begin(); i != m_layers.end(); ++i )
1119  m_orderedLayers[n++] = &i->second;
1120 
1121  sort( m_orderedLayers.begin(), m_orderedLayers.end(), compareRenderingOrder );
1122 
1123  MarkDirty();
1124 }
LAYER_ORDER m_orderedLayers
Sorted list of pointers to members of m_layers.
Definition: view.h:756
LAYER_MAP::iterator LAYER_MAP_ITER
Definition: view.h:657
LAYER_MAP m_layers
Contains set of possible displayed layers and its properties.
Definition: view.h:753
static bool compareRenderingOrder(VIEW_LAYER *aI, VIEW_LAYER *aJ)
Determines rendering order of layers. Used in display order sorting function.
Definition: view.h:741
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 459 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().

460 {
461  const MATRIX3x3D& matrix = m_gal->GetWorldScreenMatrix();
462 
463  if( aAbsolute )
464  return VECTOR2D( matrix * aCoord );
465  else
466  return VECTOR2D( matrix.GetScale().x * aCoord.x, matrix.GetScale().y * aCoord.y );
467 }
GAL * m_gal
Gives interface to PAINTER, that is used to draw items.
Definition: view.h:786
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 470 of file view.cpp.

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

471 {
472  const MATRIX3x3D& matrix = m_gal->GetWorldScreenMatrix();
473 
474  return matrix.GetScale().x * aSize;
475 }
GAL * m_gal
Gives interface to PAINTER, that is used to draw items.
Definition: view.h:786
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 440 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().

441 {
442  const MATRIX3x3D& matrix = m_gal->GetScreenWorldMatrix();
443 
444  if( aAbsolute )
445  return VECTOR2D( matrix * aCoord );
446  else
447  return VECTOR2D( matrix.GetScale().x * aCoord.x, matrix.GetScale().y * aCoord.y );
448 }
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:786
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 451 of file view.cpp.

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

452 {
453  const MATRIX3x3D& matrix = m_gal->GetScreenWorldMatrix();
454 
455  return matrix.GetScale().x * aSize;
456 }
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:786
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 1379 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(), SELECTION_TOOL::updateSelection(), PCBNEW_CONTROL::ViaDisplayMode(), PCBNEW_CONTROL::ZoneDisplayMode(), PCB_EDITOR_CONTROL::ZoneFill(), PCB_EDITOR_CONTROL::ZoneFillAll(), PCB_EDITOR_CONTROL::ZoneUnfill(), and PCB_EDITOR_CONTROL::ZoneUnfillAll().

1380 {
1381  Update( aItem, ALL );
1382 }
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:1379
void KIGFX::VIEW::Update ( VIEW_ITEM aItem,
int  aUpdateFlags 
)

Definition at line 1385 of file view.cpp.

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

1386 {
1387  auto viewData = aItem->viewPrivData();
1388 
1389  if( !viewData )
1390  return;
1391 
1392  assert( aUpdateFlags != NONE );
1393 
1394  viewData->m_requiredUpdate |= aUpdateFlags;
1395 
1396 }
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 674 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().

675 {
676  BOX2I r;
677 
678  r.SetMaximum();
679  m_gal->BeginUpdate();
680 
681  for( LAYER_MAP_ITER i = m_layers.begin(); i != m_layers.end(); ++i )
682  {
683  VIEW_LAYER* l = &( ( *i ).second );
684 
685  // There is no point in updating non-cached layers
686  if( !IsCached( l->id ) )
687  continue;
688 
689  updateItemsColor visitor( l->id, m_painter, m_gal );
690  l->items->Query( r, visitor );
691  }
692 
693  m_gal->EndUpdate();
694  MarkDirty();
695 }
virtual void EndUpdate()
Disables item update mode.
GAL * m_gal
Gives interface to PAINTER, that is used to draw items.
Definition: view.h:786
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:783
LAYER_MAP::iterator LAYER_MAP_ITER
Definition: view.h:657
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:753
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 815 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().

816 {
817  sortLayers();
818 
819  for( LAYER_MAP::value_type& l : m_layers )
820  {
821  ChangeLayerDepth( l.first, l.second.renderingOrder );
822  }
823 
824  MarkDirty();
825 }
void sortLayers()
Definition: view.cpp:1112
void ChangeLayerDepth(int aLayer, int aDepth)
Function ChangeLayerDepth() Changes the depth of items on the given layer.
Definition: view.cpp:720
LAYER_MAP m_layers
Contains set of possible displayed layers and its properties.
Definition: view.h:753
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 1176 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().

1177 {
1178  int layers[VIEW_MAX_LAYERS], layers_count;
1179 
1180  aItem->ViewGetLayers( layers, layers_count );
1181 
1182  for( int i = 0; i < layers_count; ++i )
1183  {
1184  VIEW_LAYER& l = m_layers[layers[i]];
1185  l.items->Remove( aItem );
1186  l.items->Insert( aItem );
1187  MarkTargetDirty( l.target );
1188  }
1189 }
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:753
void KIGFX::VIEW::updateItemColor ( VIEW_ITEM aItem,
int  aLayer 
)
private

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

Definition at line 1127 of file view.cpp.

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

Referenced by invalidateItem().

1128 {
1129  auto viewData = aItem->viewPrivData();
1130  wxASSERT( (unsigned) aLayer < m_layers.size() );
1131  wxASSERT( IsCached( aLayer ) );
1132 
1133  if( !viewData )
1134  return;
1135 
1136  // Obtain the color that should be used for coloring the item on the specific layerId
1137  const COLOR4D color = m_painter->GetSettings()->GetColor( aItem, aLayer );
1138  int group = viewData->getGroup( aLayer );
1139 
1140  // Change the color, only if it has group assigned
1141  if( group >= 0 )
1142  m_gal->ChangeGroupColor( group, color );
1143 }
GAL * m_gal
Gives interface to PAINTER, that is used to draw items.
Definition: view.h:786
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:783
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:753
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 1146 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().

1147 {
1148  auto viewData = aItem->viewPrivData();
1149  wxASSERT( (unsigned) aLayer < m_layers.size() );
1150  wxASSERT( IsCached( aLayer ) );
1151 
1152  if( !viewData )
1153  return;
1154 
1155  VIEW_LAYER& l = m_layers.at( aLayer );
1156 
1157  m_gal->SetTarget( l.target );
1158  m_gal->SetLayerDepth( l.renderingOrder );
1159 
1160  // Redraw the item from scratch
1161  int group = viewData->getGroup( aLayer );
1162 
1163  if( group >= 0 )
1164  m_gal->DeleteGroup( group );
1165 
1166  group = m_gal->BeginGroup();
1167  viewData->setGroup( aLayer, group );
1168 
1169  if( !m_painter->Draw( static_cast<EDA_ITEM*>( aItem ), aLayer ) )
1170  aItem->ViewDraw( aLayer, this ); // Alternative drawing method
1171 
1172  m_gal->EndGroup();
1173 }
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:786
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:783
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:753
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 1272 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().

1273 {
1274  m_gal->BeginUpdate();
1275 
1276  for( VIEW_ITEM* item : m_allItems )
1277  {
1278  auto viewData = item->viewPrivData();
1279 
1280  if( !viewData )
1281  continue;
1282 
1283  if( viewData->m_requiredUpdate != NONE )
1284  {
1285  invalidateItem( item, viewData->m_requiredUpdate );
1286  viewData->m_requiredUpdate = NONE;
1287  }
1288  }
1289 
1290  m_gal->EndUpdate();
1291 }
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:786
void invalidateItem(VIEW_ITEM *aItem, int aUpdateFlags)
Function invalidateItem() Manages dirty flags & redraw queueing when updating an item.
Definition: view.cpp:1080
virtual void BeginUpdate()
Enables item update mode.
std::vector< VIEW_ITEM * > m_allItems
Flat list of all items.
Definition: view.h:799
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 656 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().

657 {
658  // There is no point in updating non-cached layers
659  if( !IsCached( aLayer ) )
660  return;
661 
662  BOX2I r;
663 
664  r.SetMaximum();
665 
666  m_gal->BeginUpdate();
667  updateItemsColor visitor( aLayer, m_painter, m_gal );
668  m_layers[aLayer].items->Query( r, visitor );
669  MarkTargetDirty( m_layers[aLayer].target );
670  m_gal->EndUpdate();
671 }
virtual void EndUpdate()
Disables item update mode.
GAL * m_gal
Gives interface to PAINTER, that is used to draw items.
Definition: view.h:786
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:783
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:753
void KIGFX::VIEW::updateLayers ( VIEW_ITEM aItem)
private

Updates set of layers that an item occupies.

Definition at line 1192 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().

1193 {
1194  auto viewData = aItem->viewPrivData();
1195  int layers[VIEW_MAX_LAYERS], layers_count;
1196 
1197  if( !viewData )
1198  return;
1199 
1200  // Remove the item from previous layer set
1201  viewData->getLayers( layers, layers_count );
1202 
1203  for( int i = 0; i < layers_count; ++i )
1204  {
1205  VIEW_LAYER& l = m_layers[layers[i]];
1206  l.items->Remove( aItem );
1207  MarkTargetDirty( l.target );
1208 
1209  if( IsCached( l.id ) )
1210  {
1211  // Redraw the item from scratch
1212  int prevGroup = viewData->getGroup( layers[i] );
1213 
1214  if( prevGroup >= 0 )
1215  {
1216  m_gal->DeleteGroup( prevGroup );
1217  viewData->setGroup( l.id, -1 );
1218  }
1219  }
1220  }
1221 
1222  // Add the item to new layer set
1223  aItem->ViewGetLayers( layers, layers_count );
1224  viewData->saveLayers( layers, layers_count );
1225 
1226  for( int i = 0; i < layers_count; i++ )
1227  {
1228  VIEW_LAYER& l = m_layers[layers[i]];
1229  l.items->Insert( aItem );
1230  MarkTargetDirty( l.target );
1231  }
1232 }
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:786
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:753
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:802

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

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

BOX2I KIGFX::VIEW::m_boundary
private

View boundaries.

Definition at line 768 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 762 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 793 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 790 of file view.h.

Referenced by IsDynamic().

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

Definition at line 750 of file view.h.

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

double KIGFX::VIEW::m_maxScale
private

Scale upper limit.

Definition at line 774 of file view.h.

Referenced by SetScale(), and SetScaleLimits().

double KIGFX::VIEW::m_minScale
private

Scale lower limit.

Definition at line 771 of file view.h.

Referenced by SetScale(), and SetScaleLimits().

bool KIGFX::VIEW::m_mirrorX
private

Horizontal flip flag

Definition at line 777 of file view.h.

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

bool KIGFX::VIEW::m_mirrorY
private

Vertical flip flag

Definition at line 780 of file view.h.

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

int KIGFX::VIEW::m_nextDrawPriority
private

The next sequential drawing priority.

Definition at line 805 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 756 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 783 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 765 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 759 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 802 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 796 of file view.h.

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

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

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