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

#include <view.h>

Inheritance diagram for KIGFX::VIEW:

Classes
struct	CLEAR_LAYER_CACHE_VISITOR

struct	DRAW_ITEM_VISITOR

struct	RECACHE_ITEM_VISITOR

struct	UPDATE_COLOR_VISITOR

struct	UPDATE_DEPTH_VISITOR

struct	VIEW_LAYER

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

Public Member Functions
	VIEW ()

virtual	~VIEW ()

	VIEW (const VIEW &)=delete

VIEW &	operator= (const VIEW &)=delete

virtual void	Add (VIEW_ITEM *aItem, int aDrawPriority=-1)
	Add a VIEW_ITEM to the view.

virtual void	Remove (VIEW_ITEM *aItem)
	Remove a VIEW_ITEM from the view.

int	Query (const BOX2I &aRect, std::vector< LAYER_ITEM_PAIR > &aResult) const
	Find all visible items that touch or are within the rectangle aRect.

void	Query (const BOX2I &aRect, const std::function< bool(VIEW_ITEM *)> &aFunc) const
	Run a function on all visible items that touch or are within the rectangle aRect.

void	SetVisible (VIEW_ITEM *aItem, bool aIsVisible=true)
	Set the item visibility.

void	Hide (VIEW_ITEM *aItem, bool aHide=true, bool aHideOverlay=false)
	Temporarily hide the item in the view (e.g.

bool	IsVisible (const VIEW_ITEM *aItem) const
	Return information if the item is visible (or not).

bool	IsHiddenOnOverlay (const VIEW_ITEM *aItem) const

bool	HasItem (const VIEW_ITEM *aItem) const
	Indicates whether or not the given item has been added to the view.

virtual void	Update (const VIEW_ITEM *aItem, int aUpdateFlags) const
	For dynamic VIEWs, inform the associated VIEW that the graphical representation of this item has changed.

virtual void	Update (const VIEW_ITEM *aItem) const

void	SetRequired (int aLayerId, int aRequiredId, bool aRequired=true)
	Mark the aRequiredId layer as required for the aLayerId layer.

void	CopySettings (const VIEW *aOtherView)
	Copy layers and visibility settings from another view.

void	SetGAL (GAL *aGal)
	Assign a rendering device for the VIEW.

GAL *	GetGAL () const
	Return the GAL this view is using to draw graphical primitives.

void	SetPainter (PAINTER *aPainter)
	Set the painter object used by the view for drawing #VIEW_ITEMS.

PAINTER *	GetPainter () const
	Return the painter object used by the view for drawing #VIEW_ITEMS.

void	SetViewport (const BOX2D &aViewport)
	Set the visible area of the VIEW.

BOX2D	GetViewport () const
	Return the current viewport visible area rectangle.

void	SetMirror (bool aMirrorX, bool aMirrorY)
	Control the mirroring of the VIEW.

bool	IsMirroredX () const
	Return true if view is flipped across the X axis.

bool	IsMirroredY () const
	Return true if view is flipped across the Y axis.

virtual void	SetScale (double aScale, VECTOR2D aAnchor={ 0, 0 })
	Set the scaling factor, zooming around a given anchor point.

double	GetScale () const

void	SetBoundary (const BOX2D &aBoundary)
	Set limits for view area.

void	SetBoundary (const BOX2I &aBoundary)
	Set limits for view area.

const BOX2D &	GetBoundary () const

void	SetScaleLimits (double aMaximum, double aMinimum)
	Set minimum and maximum values for scale.

void	SetCenter (const VECTOR2D &aCenter)
	Set the center point of the VIEW (i.e.

void	SetCenter (const VECTOR2D &aCenter, const std::vector< BOX2D > &obscuringScreenRects)
	Set the center point of the VIEW, attempting to avoid obscuringScreenRects (for instance, the screen rect of a modeless dialog in front of the VIEW).

const VECTOR2D &	GetCenter () const
	Return the center point of this VIEW (in world space coordinates).

VECTOR2D	ToWorld (const VECTOR2D &aCoord, bool aAbsolute=true) const
	Converts a screen space point/vector to a point/vector in world space coordinates.

double	ToWorld (double aSize) const
	Converts a screen space one dimensional size to a one dimensional size in world space coordinates.

VECTOR2D	ToScreen (const VECTOR2D &aCoord, bool aAbsolute=true) const
	Convert a world space point/vector to a point/vector in screen space coordinates.

double	ToScreen (double aSize) const
	Convert a world space one dimensional size to a one dimensional size in screen space.

const VECTOR2I &	GetScreenPixelSize () const
	Return the size of the our rendering area in pixels.

void	Clear ()
	Remove all items from the view.

void	SetLayerVisible (int aLayer, bool aVisible=true)
	Control the visibility of a particular layer.

bool	IsLayerVisible (int aLayer) const
	Return information about visibility of a particular layer.

void	SetLayerDiff (int aLayer, bool aDiff=true)
	Set the whether the layer should drawn differentially.

void	SetLayerHasNegatives (int aLayer, bool aNegatives=true)
	Set the status of negatives presense in a particular layer.

void	SetLayerDisplayOnly (int aLayer, bool aDisplayOnly=true)
	Set a layer display-only (ie: to be rendered but not returned by hit test queries).

void	SetLayerTarget (int aLayer, RENDER_TARGET aTarget)
	Change the rendering target for a particular layer.

void	SetLayerOrder (int aLayer, int aRenderingOrder)
	Set rendering order of a particular layer.

int	GetLayerOrder (int aLayer) const
	Return rendering order of a particular layer.

void	SortLayers (std::vector< int > &aLayers) const
	Change the order of given layer ids, so after sorting the order corresponds to layers rendering order (descending, ie.

void	ReorderLayerData (std::unordered_map< int, int > aReorderMap)
	Remap the data between layer ids without invalidating that data.

void	UpdateLayerColor (int aLayer)
	Apply the new coloring scheme held by RENDER_SETTINGS in case that it has changed.

void	UpdateAllLayersColor ()
	Apply the new coloring scheme to all layers.

virtual void	SetTopLayer (int aLayer, bool aEnabled=true)
	Set given layer to be displayed on the top or sets back the default order of layers.

virtual void	EnableTopLayer (bool aEnable)
	Enable or disable display of the top layer.

virtual int	GetTopLayer () const

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

void	UpdateAllLayersOrder ()
	Do everything that is needed to apply the rendering order of layers.

void	ClearTargets ()
	Clear targets that are marked as dirty.

virtual void	Redraw ()
	Immediately redraws the whole view.

void	RecacheAllItems ()
	Rebuild GAL display lists.

bool	IsDirty () const
	Return true if any of the VIEW layers needs to be refreshened.

bool	IsTargetDirty (int aTarget) const
	Return true if any of layers belonging to the target or the target itself should be redrawn.

void	MarkTargetDirty (int aTarget)
	Set or clear target 'dirty' flag.

bool	IsCached (int aLayer) const
	Return true if the layer is cached.

void	MarkDirty ()
	Force redraw of view on the next rendering.

void	MarkClean ()
	Force redraw of view on the next rendering.

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

void	UpdateAllItems (int aUpdateFlags)
	Update all items in the view according to the given flags.

void	UpdateAllItemsConditionally (int aUpdateFlags, std::function< bool(VIEW_ITEM *)> aCondition)
	Update items in the view according to the given flags and condition.

void	UpdateAllItemsConditionally (std::function< int(VIEW_ITEM *)> aItemFlagsProvider)
	Update items in the view according to the flags returned by the callback.

bool	IsUsingDrawPriority () const

void	UseDrawPriority (bool aFlag)

void	ReverseDrawOrder (bool aFlag)
	Only takes effect if UseDrawPriority is true.

std::shared_ptr< VIEW_OVERLAY >	MakeOverlay ()

void	InitPreview ()

void	ClearPreview ()

void	AddToPreview (VIEW_ITEM *aItem, bool aTakeOwnership=true)

void	ShowPreview (bool aShow=true)

std::unique_ptr< VIEW >	DataReference () const
	Return a new VIEW object that shares the same set of VIEW_ITEMs and LAYERs.

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

Static Public Attributes
static constexpr int	VIEW_MAX_LAYERS = MAX_LAYERS_FOR_VIEW
	Maximum number of layers that may be shown.

static constexpr int	TOP_LAYER_MODIFIER = -MAX_LAYERS_FOR_VIEW
	Rendering order modifier for layers that are marked as top layers.

Protected Member Functions
void	redrawRect (const BOX2I &aRect)
	Redraw contents within rectangle aRect.

void	markTargetClean (int aTarget)

void	draw (VIEW_ITEM *aItem, int aLayer, bool aImmediate=false)
	Draw an item, but on a specified layers.

void	draw (VIEW_ITEM *aItem, bool aImmediate=false)
	Draw an item on all layers that the item uses.

void	draw (VIEW_GROUP *aGroup, bool aImmediate=false)
	Draw a group of items on all layers that those items use.

void	sortOrderedLayers ()
	Sort m_orderedLayers when layer rendering order has changed.

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

void	invalidateItem (VIEW_ITEM *aItem, int aUpdateFlags)
	Manage dirty flags & redraw queuing when updating an item.

void	updateItemColor (VIEW_ITEM *aItem, int aLayer)
	Update colors that are used for an item to be drawn.

void	updateItemGeometry (VIEW_ITEM *aItem, int aLayer)
	Update all information needed to draw an item.

void	updateBbox (VIEW_ITEM *aItem)
	Update bounding box of an item.

void	updateLayers (VIEW_ITEM *aItem)
	Update set of layers that an item occupies.

bool	areRequiredLayersEnabled (int aLayerId) const
	Check if every layer required by the aLayerId layer is enabled.

Static Protected Member Functions
static bool	compareRenderingOrder (VIEW_LAYER aI, VIEW_LAYER aJ)
	Determine rendering order of layers. Used in display order sorting function.

Protected Attributes
std::unique_ptr< KIGFX::VIEW_GROUP >	m_preview

std::vector< VIEW_ITEM * >	m_ownedItems

bool	m_enableOrderModifier
	Whether to use rendering order modifier or not.

std::map< int, VIEW_LAYER >	m_layers
	The set of possible displayed layers and its properties.

std::vector< VIEW_LAYER * >	m_orderedLayers
	Sorted list of pointers to members of m_layers.

std::shared_ptr< std::vector< VIEW_ITEM * > >	m_allItems
	Flat list of all items.

std::set< unsigned int >	m_topLayers
	The set of layers that are displayed on the top.

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

double	m_scale

BOX2D	m_boundary

double	m_minScale

double	m_maxScale

bool	m_mirrorX

bool	m_mirrorY

PAINTER *	m_painter
	PAINTER contains information how do draw items.

GAL *	m_gal
	Interface to PAINTER that is used to draw items.

bool	m_dirtyTargets [TARGETS_NUMBER]
	Flag to mark targets as dirty so they have to be redrawn on the next refresh event.

bool	m_useDrawPriority
	Flag to respect draw priority when drawing items.

int	m_nextDrawPriority
	The next sequential drawing priority.

bool	m_reverseDrawOrder
	Flag to reverse the draw order when using draw priority.

Friends
class	VIEW_ITEM

Detailed Description

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

VIEWs can exist in two flavors:

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

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

Definition at line 65 of file view.h.

Member Typedef Documentation

◆ LAYER_ITEM_PAIR

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

Definition at line 70 of file view.h.

Constructor & Destructor Documentation

◆ VIEW() [1/2]

KIGFX::VIEW::VIEW ( )

Definition at line 239 of file view.cpp.

Referenced by KIGFX::VIEW::CLEAR_LAYER_CACHE_VISITOR::CLEAR_LAYER_CACHE_VISITOR(), CopySettings(), KIGFX::VIEW::DRAW_ITEM_VISITOR::DRAW_ITEM_VISITOR(), operator=(), KIGFX::PCB_VIEW::PCB_VIEW(), KIGFX::VIEW::RECACHE_ITEM_VISITOR::RECACHE_ITEM_VISITOR(), KIGFX::SCH_VIEW::SCH_VIEW(), and VIEW().

◆ ~VIEW()

KIGFX::VIEW::~VIEW ( )

virtual

Definition at line 292 of file view.cpp.

References m_preview, and Remove().

◆ VIEW() [2/2]

KIGFX::VIEW::VIEW ( const VIEW & )

delete

References VIEW().

Member Function Documentation

◆ Add()

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

virtual

Add a VIEW_ITEM to the view.

Set aDrawPriority to -1 to assign sequential priorities.

Parameters

aItem	item to be added. No ownership is given
aDrawPriority	priority to draw this item on its layer, lowest first.

Reimplemented in KIGFX::PCB_VIEW.

Definition at line 298 of file view.cpp.

References KIGFX::INITIAL_ADD, KIGFX::VIEW::VIEW_LAYER::items, m_allItems, KIGFX::VIEW_ITEM_DATA::m_bbox, KIGFX::VIEW_ITEM_DATA::m_cachedIndex, 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_ITEM, VIEW_MAX_LAYERS, KIGFX::VIEW_ITEM::ViewBBox(), KIGFX::VIEW_ITEM::ViewGetLayers(), and KIGFX::VIEW_ITEM::viewPrivData().

Referenced by KIGFX::PCB_VIEW::Add(), SCH_BASE_FRAME::AddToScreen(), PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), PCB_DESIGN_BLOCK_PREVIEW_WIDGET::DisplayDesignBlock(), SCH_DESIGN_BLOCK_PREVIEW_WIDGET::DisplayDesignBlock(), SYMBOL_DIFF_WIDGET::DisplayDiff(), SYMBOL_PREVIEW_WIDGET::DisplayPart(), KIGFX::SCH_VIEW::DisplaySheet(), KIGFX::SCH_VIEW::DisplaySymbol(), SYMBOL_PREVIEW_WIDGET::DisplaySymbol(), SELECTION_TOOL::doSelectionMenu(), EE_GRID_HELPER::EE_GRID_HELPER(), GRID_HELPER::enableAndGetAnchorDebug(), InitPreview(), PL_POINT_EDITOR::Main(), SCH_POINT_EDITOR::Main(), MakeOverlay(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_POINT_EDITOR::OnSelectionChange(), operator=(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), PCB_GRID_HELPER::PCB_GRID_HELPER(), DIALOG_PAD_PROPERTIES::prepareCanvas(), SCH_COMMIT::pushSchEdit(), GERBVIEW_FRAME::Read_EXCELLON_File(), GERBVIEW_FRAME::Read_GERBER_File(), BOARD_EDITOR_CONTROL::Reset(), GERBVIEW_SELECTION_TOOL::Reset(), PCB_CONTROL::Reset(), SCH_SELECTION_TOOL::Reset(), BOARD_COMMIT::Revert(), SCH_COMMIT::Revert(), GERBVIEW_SELECTION_TOOL::select(), SCH_SELECTION_TOOL::selectLasso(), PL_SELECTION_TOOL::selectMultiple(), SCH_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::SelectPolyArea(), ZOOM_TOOL::selectRegion(), DS_DATA_ITEM::SyncDrawItems(), DS_DATA_ITEM_BITMAP::SyncDrawItems(), DS_DATA_ITEM_POLYGONS::SyncDrawItems(), DS_DATA_ITEM_TEXT::SyncDrawItems(), SYMBOL_VIEWER_FRAME::updatePreviewSymbol(), and VIEW().

◆ AddToPreview()

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

Definition at line 1729 of file view.cpp.

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

Referenced by ROUTER_TOOL::InlineDrag(), SCH_EDITOR_CONTROL::Paste(), and ROUTER_TOOL::performDragging().

◆ areRequiredLayersEnabled()

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

protected

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

Definition at line 1427 of file view.cpp.

References areRequiredLayersEnabled(), and m_layers.

Referenced by areRequiredLayersEnabled(), and redrawRect().

◆ Clear()

void KIGFX::VIEW::Clear ( )

Remove all items from the view.

Definition at line 1143 of file view.cpp.

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

Referenced by KIGFX::SCH_VIEW::Cleanup(), GERBVIEW_FRAME::Clear_DrawLayers(), FOOTPRINT_EDIT_FRAME::Clear_Pcb(), PCB_EDIT_FRAME::Clear_Pcb(), FOOTPRINT_PREVIEW_PANEL::ClearViewAndData(), PCB_DESIGN_BLOCK_PREVIEW_WIDGET::DisplayDesignBlock(), SCH_DESIGN_BLOCK_PREVIEW_WIDGET::DisplayDesignBlock(), FOOTPRINT_PREVIEW_PANEL::DisplayFootprint(), FOOTPRINT_PREVIEW_PANEL::DisplayFootprints(), SCH_DRAW_PANEL::DisplaySheet(), KIGFX::SCH_VIEW::DisplaySymbol(), DISPLAY_FOOTPRINTS_FRAME::InitDisplay(), PCB_EDIT_FRAME::RebuildAndRefresh(), DISPLAY_FOOTPRINTS_FRAME::ReloadFootprint(), DS_PROXY_UNDO_ITEM::Restore(), PCB_BASE_EDIT_FRAME::SetBoard(), SYMBOL_EDIT_FRAME::SetCurSymbol(), DISPLAY_FOOTPRINTS_FRAME::~DISPLAY_FOOTPRINTS_FRAME(), FOOTPRINT_VIEWER_FRAME::~FOOTPRINT_VIEWER_FRAME(), GERBVIEW_FRAME::~GERBVIEW_FRAME(), and PCB_BASE_EDIT_FRAME::~PCB_BASE_EDIT_FRAME().

◆ clearGroupCache()

void KIGFX::VIEW::clearGroupCache ( )

protected

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

Definition at line 1226 of file view.cpp.

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

Referenced by SetGAL().

◆ ClearPreview()

void KIGFX::VIEW::ClearPreview ( )

Definition at line 1707 of file view.cpp.

References m_ownedItems, m_preview, Update(), and VIEW_ITEM.

Referenced by ROUTER_TOOL::InlineDrag(), SCH_EDITOR_CONTROL::Paste(), and ROUTER_TOOL::performDragging().

◆ ClearTargets()

void KIGFX::VIEW::ClearTargets ( )

Clear targets that are marked as dirty.

Definition at line 1158 of file view.cpp.

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

◆ ClearTopLayers()

void KIGFX::VIEW::ClearTopLayers ( )

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

Definition at line 891 of file view.cpp.

References m_enableOrderModifier, m_layers, m_topLayers, and TOP_LAYER_MODIFIER.

Referenced by DIALOG_PAD_PROPERTIES::redraw().

◆ compareRenderingOrder()

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

inlinestaticprotected

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

Definition at line 843 of file view.h.

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

Referenced by sortOrderedLayers().

◆ CopySettings()

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

Copy layers and visibility settings from another view.

Parameters

aOtherView view from which settings will be copied.

Definition at line 505 of file view.cpp.

References VIEW().

Referenced by operator=().

◆ DataReference()

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

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

GAL, PAINTER and other properties are left uninitialized.

Definition at line 1602 of file view.cpp.

References m_allItems, and m_layers.

◆ draw() [1/3]

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

protected

Draw a group of items on all layers that those items use.

Parameters

aGroup	is the group to be drawn.
aImmediate	dictates the way of drawing - it allows one to force immediate drawing mode for cached items.

Definition at line 1102 of file view.cpp.

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

◆ draw() [2/3]

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

protected

Draw an item on all layers that the item uses.

Parameters

aItem	is the item to be drawn.
aImmediate	dictates the way of drawing - it allows one to force immediate drawing mode for cached items.

Definition at line 1079 of file view.cpp.

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

◆ draw() [3/3]

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

protected

Draw an item, but on a specified layers.

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

Parameters

aItem	is the item to be drawn.
aLayer	is the layer which should be drawn.
aImmediate	dictates the way of drawing - it allows one to force immediate drawing mode for cached items.

Definition at line 1053 of file view.cpp.

References KIGFX::VIEW_ITEM_DATA::getGroup(), group, IsCached(), m_gal, m_painter, Update(), VIEW_ITEM, KIGFX::VIEW_ITEM::ViewDraw(), and KIGFX::VIEW_ITEM::viewPrivData().

Referenced by draw(), and draw().

◆ EnableTopLayer()

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

virtual

Enable or disable display of the top layer.

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

Parameters

aEnable whether to enable or disable display of the top layer.

Definition at line 866 of file view.cpp.

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

◆ GetBoundary()

const BOX2D & KIGFX::VIEW::GetBoundary ( ) const

inline

Returns: Current view area boundary.

Definition at line 305 of file view.h.

References m_boundary.

◆ GetCenter()

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

inline

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

Returns: center point of the view

Definition at line 346 of file view.h.

References m_center.

Referenced by EDA_DRAW_PANEL_GAL::DoRePaint().

◆ GetGAL()

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

inline

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

Returns: Pointer to the currently used GAL instance.

Definition at line 202 of file view.h.

References m_gal.

◆ GetLayerOrder()

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

Return rendering order of a particular layer.

Lower values are rendered first.

Parameters

aLayer is the layer.

Returns: Rendering order of a particular layer.

Definition at line 664 of file view.cpp.

References m_layers.

Referenced by ROUTER_PREVIEW_ITEM::ROUTER_PREVIEW_ITEM().

◆ GetPainter()

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

inline

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

Returns: Pointer to the currently used Painter instance.

Definition at line 220 of file view.h.

References m_painter.

Referenced by PCB_BASE_FRAME::ActivateGalCanvas(), GERBVIEW_FRAME::ApplyDisplaySettingsToGAL(), EDITOR_CONDITIONS::bboxesFunc(), DS_PROXY_VIEW_ITEM::buildDrawList(), GERBVIEW_CONTROL::ClearAllLayers(), PCB_BASE_FRAME::CommonSettingsChanged(), PL_EDITOR_FRAME::CommonSettingsChanged(), SCH_BASE_FRAME::CommonSettingsChanged(), PCB_GRID_HELPER::computeAnchors(), SYMBOL_DIFF_WIDGET::DisplayDiff(), KIGFX::PREVIEW::ANGLE_ITEM::drawPreviewShape(), KIGFX::PREVIEW::POLYGON_ITEM::drawPreviewShape(), KIGFX::PREVIEW::DrawTextNextToCursor(), PAD_TOOL::EditPad(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), PAD_TOOL::ExitPadEditMode(), PCB_SELECTION_TOOL::FilterCollectorForFootprints(), FOOTPRINT_PREVIEW_PANEL::GetBackgroundColor(), FOOTPRINT_PREVIEW_PANEL::GetForegroundColor(), PCB_SELECTION_TOOL::GuessSelectionCandidates(), GERBVIEW_CONTROL::HighlightControl(), BOARD_INSPECTION_TOOL::highlightNet(), PNS::TOOL_BASE::highlightNets(), PCB_EDIT_FRAME::LoadProjectSettings(), PCB_BASE_FRAME::LoadSettings(), KIGFX::VIEW_ITEM::lodScaleForThreshold(), DIALOG_PAD_PROPERTIES::onChangePadMode(), GERBER_LAYER_WIDGET::OnLayerColorChange(), APPEARANCE_CONTROLS::onNetclassContextMenu(), GERBVIEW_FRAME::OnSelectActiveDCode(), GERBVIEW_FRAME::OnSelectActiveLayer(), PAD_TOOL::OnUndoRedo(), PCB_DESIGN_BLOCK_PREVIEW_WIDGET::PCB_DESIGN_BLOCK_PREVIEW_WIDGET(), PCB_GRID_HELPER::PCB_GRID_HELPER(), DIALOG_PAD_PROPERTIES::prepareCanvas(), PCB_SELECTION_TOOL::pruneObscuredSelectionCandidates(), PCB_GRID_HELPER::queryVisible(), DIALOG_PAD_PROPERTIES::redraw(), FOOTPRINT_PREVIEW_PANEL::renderFootprint(), GERBVIEW_SELECTION_TOOL::Reset(), PCB_SELECTION_TOOL::Reset(), SCH_SELECTION_TOOL::Reset(), PCB_EDIT_FRAME::SaveProjectLocalSettings(), PCB_EDIT_FRAME::saveProjectSettings(), SCH_DESIGN_BLOCK_PREVIEW_WIDGET::SCH_DESIGN_BLOCK_PREVIEW_WIDGET(), SCH_EDIT_FRAME::SCH_EDIT_FRAME(), PCB_SELECTION_TOOL::Selectable(), PCB_BASE_FRAME::SetBoard(), SCH_EDIT_FRAME::SetSchematic(), PCB_EDIT_FRAME::setupUIConditions(), PCBNEW_PRINTOUT::setupViewLayers(), SYMBOL_PREVIEW_WIDGET::SYMBOL_PREVIEW_WIDGET(), COMMON_TOOLS::ToggleBoundingBoxes(), KIGFX::PCB_VIEW::UpdateDisplayOptions(), PANEL_EESCHEMA_COLOR_SETTINGS::updatePreview(), PANEL_PCBNEW_COLOR_SETTINGS::updatePreview(), DS_PROXY_VIEW_ITEM::ViewDraw(), EDIT_POINTS::ViewDraw(), KIGFX::ANCHOR_DEBUG::ViewDraw(), KIGFX::PREVIEW::RULER_ITEM::ViewDraw(), KIGFX::PREVIEW::SELECTION_AREA::ViewDraw(), KIGFX::VIEW_GROUP::ViewDraw(), RATSNEST_VIEW_ITEM::ViewDraw(), PAD::ViewGetLOD(), PCB_FIELD::ViewGetLOD(), PCB_REFERENCE_IMAGE::ViewGetLOD(), PCB_SHAPE::ViewGetLOD(), PCB_TEXT::ViewGetLOD(), PCB_TEXTBOX::ViewGetLOD(), PCB_TRACK::ViewGetLOD(), and PCB_VIA::ViewGetLOD().

◆ GetScale()

double KIGFX::VIEW::GetScale ( ) const

inline

Returns: Current scale factor of this VIEW.

Definition at line 276 of file view.h.

References m_scale.

Referenced by PCB_GRID_HELPER::computeAnchors(), COMMON_TOOLS::doZoomFit(), PCB_SELECTION_TOOL::FindItem(), SCH_EDIT_FRAME::OnPageSettingsChange(), EE_GRID_HELPER::queryVisible(), PCB_GRID_HELPER::queryVisible(), PCB_EDIT_FRAME::redrawNetnames(), DISPLAY_FOOTPRINTS_FRAME::SaveSettings(), FOOTPRINT_VIEWER_FRAME::SaveSettings(), ZOOM_TOOL::selectRegion(), SetViewport(), PANEL_EESCHEMA_COLOR_SETTINGS::zoomFitPreview(), and PANEL_PCBNEW_COLOR_SETTINGS::zoomFitPreview().

◆ GetScreenPixelSize()

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

Return the size of the our rendering area in pixels.

Returns: viewport screen size.

Definition at line 1202 of file view.cpp.

References m_gal.

◆ GetTopLayer()

int KIGFX::VIEW::GetTopLayer ( ) const

virtual

Definition at line 830 of file view.cpp.

References m_topLayers.

Referenced by ROUTER_TOOL::getStartLayer(), and BOARD_INSPECTION_TOOL::highlightNet().

◆ GetViewport()

BOX2D KIGFX::VIEW::GetViewport ( ) const

Return the current viewport visible area rectangle.

Returns: Current viewport rectangle.

Definition at line 530 of file view.cpp.

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

Referenced by drawBacksideTicks(), drawTicksAlongLine(), PCB_SELECTION_TOOL::FilterCollectorForFootprints(), PCB_SELECTION_TOOL::FindItem(), PCB_BASE_FRAME::FocusOnItems(), EDA_DRAW_FRAME::FocusOnLocation(), PCB_SELECTION_TOOL::hitTestDistance(), PCB_EDIT_FRAME::redrawNetnames(), DS_PROXY_VIEW_ITEM::ViewDraw(), KIGFX::ANCHOR_DEBUG::ViewDraw(), KIGFX::CONSTRUCTION_GEOM::ViewDraw(), PCB_TRACK::ViewGetLOD(), and SCH_SELECTION_TOOL::ZoomFitCrossProbeBBox().

◆ HasItem()

bool KIGFX::VIEW::HasItem ( const VIEW_ITEM * aItem ) const

Indicates whether or not the given item has been added to the view.

Definition at line 1671 of file view.cpp.

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

Referenced by PCB_BASE_FRAME::HideSolderMask(), operator=(), BOARD_COMMIT::Push(), and PCB_BASE_FRAME::ShowSolderMask().

◆ Hide()

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

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

for overlaying).

Parameters

aItem	the item to modify.
aHide	whether the item is hidden, or not.
aHideOverlay	whether the item should also be hidden on overlays.

Definition at line 1633 of file view.cpp.

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

Referenced by AddToPreview(), KIGFX::SCH_VIEW::ClearHiddenFlags(), PCB_TUNING_PATTERN::EditFinish(), PCB_SELECTION_TOOL::EnterGroup(), SCH_SELECTION_TOOL::EnterGroup(), PCB_SELECTION_TOOL::ExitGroup(), SCH_SELECTION_TOOL::ExitGroup(), SCH_SELECTION_TOOL::highlight(), PCB_SELECTION_TOOL::highlightInternal(), PCB_TEST_SELECTION_TOOL::highlightInternal(), ROUTER_TOOL::InlineDrag(), operator=(), SCH_EDITOR_CONTROL::Paste(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), GERBVIEW_SELECTION_TOOL::selectVisually(), SCH_SELECTION_TOOL::unhighlight(), PCB_SELECTION_TOOL::unhighlightInternal(), PCB_TEST_SELECTION_TOOL::unhighlightInternal(), GERBVIEW_SELECTION_TOOL::unselectVisually(), and PCB_TUNING_PATTERN::Update().

◆ InitPreview()

void KIGFX::VIEW::InitPreview ( )

Definition at line 1722 of file view.cpp.

References Add(), and m_preview.

Referenced by KIGFX::SCH_VIEW::DisplaySheet(), KIGFX::SCH_VIEW::DisplaySymbol(), ROUTER_TOOL::InlineDrag(), ROUTER_TOOL::performDragging(), PCB_EDIT_FRAME::RebuildAndRefresh(), and PCB_BASE_EDIT_FRAME::SetBoard().

◆ invalidateItem()

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

protected

Manage dirty flags & redraw queuing when updating an item.

Parameters

aItem	is the item to be updated.
aUpdateFlags	determines the way an item is refreshed.

Definition at line 1238 of file view.cpp.

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

Referenced by UpdateItems().

◆ IsCached()

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

inline

Return true if the layer is cached.

Definition at line 646 of file view.h.

References m_layers, and KIGFX::TARGET_CACHED.

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

◆ IsDirty()

bool KIGFX::VIEW::IsDirty ( ) const

inline

Return true if any of the VIEW layers needs to be refreshened.

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

Definition at line 611 of file view.h.

References IsTargetDirty(), and KIGFX::TARGETS_NUMBER.

◆ IsHiddenOnOverlay()

bool KIGFX::VIEW::IsHiddenOnOverlay ( const VIEW_ITEM * aItem ) const

Definition at line 1663 of file view.cpp.

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

Referenced by operator=(), and KIGFX::VIEW_GROUP::ViewDraw().

◆ IsLayerVisible()

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

inline

Return information about visibility of a particular layer.

Parameters

aLayer true if the layer is visible, false otherwise.

Definition at line 422 of file view.h.

References m_layers.

Referenced by PCB_GRID_HELPER::computeAnchors(), GERBVIEW_FRAME::GetVisibleLayers(), APPEARANCE_CONTROLS::getVisibleLayers(), APPEARANCE_CONTROLS::getVisibleObjects(), PCB_SELECTION_TOOL::Selectable(), GERBVIEW_FRAME::SetElementVisibility(), GERBVIEW_FRAME::UpdateXORLayers(), KIGFX::VIEW_GROUP::ViewDraw(), RATSNEST_VIEW_ITEM::ViewDraw(), FOOTPRINT::ViewGetLOD(), PAD::ViewGetLOD(), PCB_FIELD::ViewGetLOD(), PCB_GROUP::ViewGetLOD(), PCB_POINT::ViewGetLOD(), PCB_REFERENCE_IMAGE::ViewGetLOD(), PCB_SHAPE::ViewGetLOD(), PCB_TEXT::ViewGetLOD(), PCB_TEXTBOX::ViewGetLOD(), PCB_TRACK::ViewGetLOD(), PCB_VIA::ViewGetLOD(), SCH_GROUP::ViewGetLOD(), and ZONE::ViewGetLOD().

◆ IsMirroredX()

bool KIGFX::VIEW::IsMirroredX ( ) const

inline

Return true if view is flipped across the X axis.

Definition at line 250 of file view.h.

References m_mirrorX.

Referenced by COMMON_TOOLS::CursorControl(), APPEARANCE_CONTROLS::doApplyLayerPreset(), drawBacksideTicks(), drawTicksAlongLine(), API_HANDLER_PCB::handleSetBoardEditorAppearanceSettings(), SCH_SELECTION_TOOL::selectMultiple(), FOOTPRINT_EDIT_FRAME::setupUIConditions(), and PCB_EDIT_FRAME::setupUIConditions().

◆ IsMirroredY()

bool KIGFX::VIEW::IsMirroredY ( ) const

inline

Return true if view is flipped across the Y axis.

Definition at line 258 of file view.h.

References m_mirrorY.

Referenced by APPEARANCE_CONTROLS::doApplyLayerPreset(), and API_HANDLER_PCB::handleSetBoardEditorAppearanceSettings().

◆ IsTargetDirty()

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

inline

Return true if any of layers belonging to the target or the target itself should be redrawn.

Returns: True if the above condition is fulfilled.

Definition at line 628 of file view.h.

References m_dirtyTargets, and KIGFX::TARGETS_NUMBER.

Referenced by ClearTargets(), IsDirty(), and redrawRect().

◆ IsUsingDrawPriority()

bool KIGFX::VIEW::IsUsingDrawPriority ( ) const

inline

Returns: true if draw priority is being respected while redrawing.

Definition at line 705 of file view.h.

References m_useDrawPriority.

◆ IsVisible()

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

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

Parameters

aItem the item to test.

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

Definition at line 1655 of file view.cpp.

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

Referenced by PCB_GRID_HELPER::computeAnchors(), operator=(), EE_GRID_HELPER::queryVisible(), and PCB_GRID_HELPER::queryVisible().

◆ MakeOverlay()

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

Definition at line 1698 of file view.cpp.

References Add(), and overlay.

Referenced by AUTOPLACE_TOOL::autoplace().

◆ MarkClean()

void KIGFX::VIEW::MarkClean ( )

inline

Force redraw of view on the next rendering.

Definition at line 668 of file view.h.

References m_dirtyTargets, and KIGFX::TARGETS_NUMBER.

Referenced by Redraw().

◆ MarkDirty()

void KIGFX::VIEW::MarkDirty ( )

inline

Force redraw of view on the next rendering.

Definition at line 659 of file view.h.

References m_dirtyTargets, and KIGFX::TARGETS_NUMBER.

Referenced by ClearTargets(), BOARD_EDITOR_CONTROL::DoSetDrillOrigin(), PCB_CONTROL::DoSetGridOrigin(), EDA_DRAW_FRAME::OnMove(), GERBVIEW_FRAME::RemapLayers(), SetCenter(), SetGAL(), GERBVIEW_FRAME::SetLayerDrawPrms(), SetMirror(), SetScale(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), sortOrderedLayers(), UpdateAllLayersColor(), UpdateAllLayersOrder(), GERBVIEW_FRAME::UpdateXORLayers(), and VIEW().

◆ markTargetClean()

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

inlineprotected

Definition at line 778 of file view.h.

References m_dirtyTargets, and KIGFX::TARGETS_NUMBER.

◆ MarkTargetDirty()

void KIGFX::VIEW::MarkTargetDirty ( int aTarget )

inline

Set or clear target 'dirty' flag.

Parameters

aTarget is the target to set.

Definition at line 639 of file view.h.

References m_dirtyTargets, and KIGFX::TARGETS_NUMBER.

Referenced by Add(), GERBVIEW_FRAME::ApplyDisplaySettingsToGAL(), DRC_INTERACTIVE_COURTYARD_CLEARANCE::ClearConflicts(), FOOTPRINT_EDIT_FRAME::CommonSettingsChanged(), GERBVIEW_FRAME::CommonSettingsChanged(), PCB_EDIT_FRAME::CommonSettingsChanged(), SCH_BASE_FRAME::CommonSettingsChanged(), PCB_SELECTION_TOOL::highlight(), invalidateItem(), COMMON_TOOLS::OnGridChanged(), Remove(), DIALOG_FP_EDIT_PAD_TABLE::RestoreOriginalPadState(), EDA_DRAW_FRAME::SetGridVisibility(), SetLayerDiff(), SetLayerHasNegatives(), SetLayerVisible(), PCB_SELECTION_TOOL::unhighlight(), PCB_TEST_SELECTION_TOOL::unhighlight(), updateBbox(), DRC_INTERACTIVE_COURTYARD_CLEARANCE::UpdateConflicts(), UpdateItems(), UpdateLayerColor(), and updateLayers().

◆ OnDestroy()

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

static

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

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

Definition at line 226 of file view.cpp.

References KIGFX::VIEW_ITEM_DATA::m_view, KIGFX::VIEW_ITEM::m_viewPrivData, and VIEW_ITEM.

Referenced by operator=(), and KIGFX::VIEW_ITEM::~VIEW_ITEM().

◆ operator=()

VIEW & KIGFX::VIEW::operator= ( const VIEW & )

delete

References Add(), CopySettings(), HasItem(), Hide(), IsHiddenOnOverlay(), IsVisible(), OnDestroy(), Query(), Remove(), SetGAL(), SetRequired(), SetVisible(), Update(), VIEW(), and VIEW_ITEM.

◆ Query() [1/2]

void KIGFX::VIEW::Query	(	const BOX2I &	aRect,
		const std::function< bool(VIEW_ITEM *)> &	aFunc ) const

Run a function on all visible items that touch or are within the rectangle aRect.

Parameters

aFunc the function to be executed; return true to continue, false to end query.

Definition at line 451 of file view.cpp.

References m_orderedLayers, and VIEW_ITEM.

◆ Query() [2/2]

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

Find all visible items that touch or are within the rectangle aRect.

Parameters

aResult result 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 420 of file view.cpp.

References m_orderedLayers, UNDEFINED_LAYER, and VIEW_ITEM.

Referenced by operator=(), EE_GRID_HELPER::queryVisible(), PCB_GRID_HELPER::queryVisible(), PCB_SELECTION_TOOL::SelectAll(), SCH_SELECTION_TOOL::SelectAll(), SCH_SELECTION_TOOL::SelectMultiple(), PCB_SELECTION_TOOL::UnselectAll(), SCH_SELECTION_TOOL::UnselectAll(), and SCH_EDIT_FRAME::UpdateHopOveredWires().

◆ RecacheAllItems()

void KIGFX::VIEW::RecacheAllItems ( )

◆ Redraw()

void KIGFX::VIEW::Redraw ( )

virtual

Immediately redraws the whole view.

Definition at line 1177 of file view.cpp.

References BOX2ISafe(), m_gal, MarkClean(), PROF_TIMER::msecs(), BOX2< Vec >::Normalize(), redrawRect(), PROF_TIMER::Stop(), ToWorld(), and traceGalProfile.

◆ redrawRect()

void KIGFX::VIEW::redrawRect ( const BOX2I & aRect )

protected

Redraw contents within rectangle aRect.

Definition at line 1010 of file view.cpp.

References areRequiredLayersEnabled(), KIGFX::VIEW::DRAW_ITEM_VISITOR::deferredDraw(), KIGFX::VIEW::DRAW_ITEM_VISITOR::drawForcedTransparent, KIGFX::VIEW::DRAW_ITEM_VISITOR::foundForcedTransparent, IsTargetDirty(), m_gal, m_orderedLayers, m_reverseDrawOrder, m_useDrawPriority, and KIGFX::TARGET_NONCACHED.

Referenced by Redraw().

◆ Remove()

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

virtual

Remove a VIEW_ITEM from the view.

Parameters

aItem item to be removed. Caller must dispose the removed item if necessary

Reimplemented in KIGFX::PCB_VIEW.

Definition at line 341 of file view.cpp.

References KIGFX::VIEW_ITEM_DATA::clearUpdateFlags(), KIGFX::VIEW_ITEM_DATA::deleteGroups(), KIGFX::VIEW_ITEM::GetClass(), KIGFX::VIEW_ITEM_DATA::getGroup(), KIGFX::VIEW::VIEW_LAYER::items, m_allItems, KIGFX::VIEW_ITEM_DATA::m_bbox, KIGFX::VIEW_ITEM_DATA::m_cachedIndex, m_gal, m_layers, KIGFX::VIEW_ITEM_DATA::m_layers, KIGFX::VIEW_ITEM_DATA::m_view, KIGFX::VIEW_ITEM::m_viewPrivData, MarkTargetDirty(), KIGFX::VIEW::VIEW_LAYER::target, and VIEW_ITEM.

Referenced by SYMBOL_DIFF_WIDGET::DisplayDiff(), SYMBOL_PREVIEW_WIDGET::DisplayPart(), SYMBOL_PREVIEW_WIDGET::DisplaySymbol(), PL_EDIT_TOOL::DoDelete(), SELECTION_TOOL::doSelectionMenu(), PL_POINT_EDITOR::Main(), SCH_POINT_EDITOR::Main(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_POINT_EDITOR::OnSelectionChange(), operator=(), SCH_COMMIT::pushSchEdit(), KIGFX::PCB_VIEW::Remove(), SCH_BASE_FRAME::RemoveFromScreen(), BOARD_EDITOR_CONTROL::Reset(), GERBVIEW_SELECTION_TOOL::Reset(), PCB_CONTROL::Reset(), SCH_SELECTION_TOOL::Reset(), BOARD_COMMIT::Revert(), SCH_COMMIT::Revert(), SCH_SELECTION_TOOL::selectLasso(), PL_SELECTION_TOOL::selectMultiple(), SCH_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::SelectPolyArea(), ZOOM_TOOL::selectRegion(), DS_DATA_ITEM::SyncDrawItems(), DS_DATA_ITEM_BITMAP::SyncDrawItems(), DS_DATA_ITEM_POLYGONS::SyncDrawItems(), DS_DATA_ITEM_TEXT::SyncDrawItems(), GERBVIEW_SELECTION_TOOL::unselect(), SYMBOL_VIEWER_FRAME::updatePreviewSymbol(), EE_GRID_HELPER::~EE_GRID_HELPER(), GERBVIEW_SELECTION_TOOL::~GERBVIEW_SELECTION_TOOL(), GRID_HELPER::~GRID_HELPER(), PCB_GRID_HELPER::~PCB_GRID_HELPER(), PCB_SELECTION_TOOL::~PCB_SELECTION_TOOL(), SCH_SELECTION_TOOL::~SCH_SELECTION_TOOL(), SYMBOL_VIEWER_FRAME::~SYMBOL_VIEWER_FRAME(), and ~VIEW().

◆ ReorderLayerData()

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

Remap the data between layer ids without invalidating that data.

Used by GerbView for the "Sort by X2" functionality.

Parameters

aReorderMap is a mapping of old to new layer ids.

Definition at line 680 of file view.cpp.

References _, KIGFX::COLOR, m_allItems, m_layers, KIGFX::VIEW_ITEM_DATA::m_requiredUpdate, KIGFX::VIEW_ITEM_DATA::reorderGroups(), KIGFX::VIEW_ITEM_DATA::saveLayers(), sortOrderedLayers(), UpdateItems(), and VIEW_ITEM.

Referenced by GERBVIEW_FRAME::RemapLayers().

◆ ReverseDrawOrder()

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

inline

Only takes effect if UseDrawPriority is true.

Parameters

aFlag is true if draw order should be reversed

Definition at line 723 of file view.h.

References m_reverseDrawOrder.

◆ SetBoundary() [1/2]

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

inline

Set limits for view area.

Parameters

aBoundary is the box that limits view area.

Definition at line 286 of file view.h.

References m_boundary.

Referenced by DIALOG_PAD_PROPERTIES::redraw().

◆ SetBoundary() [2/2]

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

inline

Set limits for view area.

Parameters

aBoundary is the box that limits view area.

Definition at line 296 of file view.h.

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

◆ SetCenter() [1/2]

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

Set the center point of the VIEW (i.e.

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

Parameters

aCenter the new center point, in world space coordinates.

Definition at line 596 of file view.cpp.

References m_boundary, m_center, m_gal, MarkDirty(), and VECTOR2< T >::x.

Referenced by SCH_EDIT_FRAME::DisplayCurrentSheet(), COMMON_TOOLS::doCenter(), COMMON_TOOLS::doZoomFit(), PCB_DESIGN_BLOCK_PREVIEW_WIDGET::fitOnDrawArea(), SCH_DESIGN_BLOCK_PREVIEW_WIDGET::fitOnDrawArea(), SYMBOL_PREVIEW_WIDGET::fitOnDrawArea(), EDA_DRAW_FRAME::FocusOnLocation(), SCH_BASE_FRAME::RedrawScreen(), ZOOM_TOOL::selectRegion(), SetCenter(), SetGAL(), SetScale(), SetViewport(), PANEL_EESCHEMA_COLOR_SETTINGS::zoomFitPreview(), and PANEL_PCBNEW_COLOR_SETTINGS::zoomFitPreview().

◆ SetCenter() [2/2]

void KIGFX::VIEW::SetCenter	(	const VECTOR2D &	aCenter,
		const std::vector< BOX2D > &	obscuringScreenRects )

Set the center point of the VIEW, attempting to avoid obscuringScreenRects (for instance, the screen rect of a modeless dialog in front of the VIEW).

Parameters

aCenter	the new center point, in world space coordinates.
obscuringScreenRects	the obscuring rects, in screen space coordinates.

Definition at line 621 of file view.cpp.

References ALLOW_ACUTE_CORNERS, ARC_LOW_DEF, SHAPE_POLY_SET::BBox(), SHAPE_POLY_SET::BooleanSubtract(), BOX2< Vec >::Centre(), SHAPE_POLY_SET::Deflate(), BOX2< Vec >::GetHeight(), BOX2< Vec >::GetWidth(), SHAPE_POLY_SET::IsEmpty(), m_gal, SetCenter(), and ToWorld().

◆ SetGAL()

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

Assign a rendering device for the VIEW.

Parameters

aGal	pointer to the GAL output device.

Definition at line 511 of file view.cpp.

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

Referenced by operator=().

◆ SetLayerDiff()

void KIGFX::VIEW::SetLayerDiff	(	int	aLayer,
		bool	aDiff = true )

inline

Set the whether the layer should drawn differentially.

Parameters

aLayer	is the layer to set to be draw differentially
aDiff	is the layer diff'ing state.

Definition at line 438 of file view.h.

References KIGFX::VIEW::VIEW_LAYER::diffLayer, m_layers, MarkTargetDirty(), and KIGFX::VIEW::VIEW_LAYER::target.

Referenced by GERBVIEW_FRAME::UpdateXORLayers().

◆ SetLayerDisplayOnly()

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

inline

Set a layer display-only (ie: to be rendered but not returned by hit test queries).

Definition at line 481 of file view.h.

References m_layers.

◆ SetLayerHasNegatives()

void KIGFX::VIEW::SetLayerHasNegatives	(	int	aLayer,
		bool	aNegatives = true )

inline

Set the status of negatives presense in a particular layer.

Parameters

aLayer	is the layer to set as containing negatives (or not).
aNegatives	is the layer negatives state.

Definition at line 461 of file view.h.

References KIGFX::VIEW::VIEW_LAYER::hasNegatives, m_layers, MarkTargetDirty(), and KIGFX::VIEW::VIEW_LAYER::target.

Referenced by GERBVIEW_FRAME::unarchiveFiles().

◆ SetLayerOrder()

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

Set rendering order of a particular layer.

Lower values are rendered first.

Parameters

aLayer	is the layer.
aRenderingOrder	is an arbitrary number denoting the rendering order.

Definition at line 656 of file view.cpp.

References m_layers, and sortOrderedLayers().

◆ SetLayerTarget()

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

inline

Change the rendering target for a particular layer.

Parameters

aLayer	is the layer.
aTarget	is the rendering target.

Definition at line 497 of file view.h.

References m_layers.

Referenced by BOARD_PRINTOUT::setupViewLayers(), and GERBVIEW_FRAME::UpdateXORLayers().

◆ SetLayerVisible()

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

inline

Control the visibility of a particular layer.

Parameters

aLayer	is the layer to show/hide.
aVisible	is the layer visibility state.

Definition at line 400 of file view.h.

References m_layers, MarkTargetDirty(), KIGFX::VIEW::VIEW_LAYER::target, and KIGFX::VIEW::VIEW_LAYER::visible.

Referenced by SCH_EDIT_FRAME::CommonSettingsChanged(), PL_EDITOR_FRAME::OnSelectPage(), DIALOG_PAD_PROPERTIES::prepareCanvas(), SCH_EDIT_FRAME::SCH_EDIT_FRAME(), FOOTPRINT_EDIT_FRAME::SetActiveLayer(), PCB_EDIT_FRAME::SetActiveLayer(), GERBVIEW_FRAME::SetElementVisibility(), PCB_EDIT_FRAME::SetElementVisibility(), BOARD_PRINTOUT::setupViewLayers(), GERBVIEW_PRINTOUT::setupViewLayers(), PCBNEW_PRINTOUT::setupViewLayers(), GERBVIEW_FRAME::SetVisibleLayers(), APPEARANCE_CONTROLS::setVisibleLayers(), APPEARANCE_CONTROLS::setVisibleObjects(), SCH_EDIT_FRAME::ShowAllIntersheetRefs(), SCH_EDITOR_CONTROL::ToggleERCErrors(), SCH_EDITOR_CONTROL::ToggleERCWarnings(), SCH_EDITOR_CONTROL::ToggleOPCurrents(), SCH_EDITOR_CONTROL::ToggleOPVoltages(), FOOTPRINT_EDIT_FRAME::updateEnabledLayers(), and PCB_EDIT_FRAME::UpdateUserInterface().

◆ SetMirror()

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

Control the mirroring of the VIEW.

Parameters

aMirrorX	when true, the X axis is mirrored.
aMirrorY	when true, the Y axis is mirrored.

Definition at line 557 of file view.cpp.

References _, m_gal, m_mirrorX, m_mirrorY, and MarkDirty().

Referenced by GERBVIEW_CONTROL::DisplayControl(), APPEARANCE_CONTROLS::doApplyLayerPreset(), PCB_CONTROL::FlipPcbView(), API_HANDLER_PCB::handleSetBoardEditorAppearanceSettings(), and SetGAL().

◆ SetPainter()

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

inline

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

Definition at line 210 of file view.h.

References m_painter.

◆ SetRequired()

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

Mark the aRequiredId layer as required for the aLayerId layer.

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

Parameters

aLayerId	is the id of the layer for which we enable/disable the required layer.
aRequiredId	is the id of the required layer.
aRequired	tells if the required layer should be added or removed from the list.

Definition at line 408 of file view.cpp.

References m_layers.

Referenced by operator=().

◆ SetScale()

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

virtual

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

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

Parameters

aAnchor	is the zooming anchor point.
aScale	is the scale factor.

Reimplemented in KIGFX::SCH_VIEW.

Definition at line 570 of file view.cpp.

References delta, m_center, m_gal, m_maxScale, m_minScale, m_scale, MarkDirty(), SetCenter(), ToScreen(), and ToWorld().

Referenced by COMMON_TOOLS::doZoomFit(), COMMON_TOOLS::doZoomToPreset(), PCB_SELECTION_TOOL::FindItem(), PCB_DESIGN_BLOCK_PREVIEW_WIDGET::fitOnDrawArea(), SCH_DESIGN_BLOCK_PREVIEW_WIDGET::fitOnDrawArea(), SYMBOL_PREVIEW_WIDGET::fitOnDrawArea(), FOOTPRINT_PREVIEW_PANEL::fitToCurrentFootprint(), ZOOM_TOOL::selectRegion(), SetGAL(), KIGFX::SCH_VIEW::SetScale(), SetViewport(), SCH_SELECTION_TOOL::ZoomFitCrossProbeBBox(), PANEL_EESCHEMA_COLOR_SETTINGS::zoomFitPreview(), and PANEL_PCBNEW_COLOR_SETTINGS::zoomFitPreview().

◆ SetScaleLimits()

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

inline

Set minimum and maximum values for scale.

Parameters

aMaximum	is the maximum value for scale.
aMinimum	is the minimum value for scale.

Definition at line 316 of file view.h.

References m_maxScale, and m_minScale.

◆ SetTopLayer()

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

virtual

Set given layer to be displayed on the top or sets back the default order of layers.

Parameters

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

Definition at line 839 of file view.cpp.

References m_enableOrderModifier, m_layers, m_topLayers, and TOP_LAYER_MODIFIER.

Referenced by DIALOG_PAD_PROPERTIES::redraw(), BOARD_PRINTOUT::setupViewLayers(), and PCBNEW_PRINTOUT::setupViewLayers().

◆ SetViewport()

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

Set the visible area of the VIEW.

Parameters

aViewport desired visible area, in world space coordinates.

Definition at line 542 of file view.cpp.

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

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

◆ SetVisible()

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

Set the item visibility.

Parameters

aItem	the item to modify.
aIsVisible	whether the item is visible (on all layers), or not.

Definition at line 1612 of file view.cpp.

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

Referenced by Add(), AddToPreview(), EE_GRID_HELPER::EE_GRID_HELPER(), GRID_HELPER::enableAndGetAnchorDebug(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), operator=(), SCH_EDITOR_CONTROL::Paste(), PCB_GRID_HELPER::PCB_GRID_HELPER(), FOOTPRINT_PREVIEW_PANEL::renderFootprint(), SCH_SELECTION_TOOL::selectLasso(), PL_SELECTION_TOOL::selectMultiple(), SCH_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::SelectPolyArea(), ZOOM_TOOL::selectRegion(), and ShowPreview().

◆ ShowPreview()

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

Definition at line 1743 of file view.cpp.

References m_preview, and SetVisible().

Referenced by ROUTER_TOOL::InlineDrag(), and ROUTER_TOOL::performDragging().

◆ SortLayers()

void KIGFX::VIEW::SortLayers ( std::vector< int > & aLayers ) const

Change the order of given layer ids, so after sorting the order corresponds to layers rendering order (descending, ie.

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

Parameters

aLayers stores id of layers to be sorted.

Definition at line 670 of file view.cpp.

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

◆ sortOrderedLayers()

void KIGFX::VIEW::sortOrderedLayers ( )

protected

Sort m_orderedLayers when layer rendering order has changed.

Definition at line 1277 of file view.cpp.

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

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

◆ ToScreen() [1/2]

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

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

Parameters

aCoord	is the point/vector to be converted.
aAbsolute	when true aCoord is treated as a point, otherwise as a direction (vector).

Definition at line 486 of file view.cpp.

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

Referenced by SetScale().

◆ ToScreen() [2/2]

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

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

Parameters

aSize the size to be transformed.

Definition at line 497 of file view.cpp.

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

◆ ToWorld() [1/2]

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

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

Parameters

aCoord	is the point/vector to be converted.
aAbsolute	when true aCoord is treated as a point, otherwise as a direction (vector).

Definition at line 467 of file view.cpp.

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

Referenced by SCH_POINT_EDITOR::addCornerCondition(), COMMON_TOOLS::doCenter(), COMMON_TOOLS::doZoomFit(), KIGFX::PREVIEW::ANGLE_ITEM::drawPreviewShape(), KIGFX::PREVIEW::POLYGON_ITEM::drawPreviewShape(), EDIT_POINTS::FindPoint(), PCB_DESIGN_BLOCK_PREVIEW_WIDGET::fitOnDrawArea(), SCH_DESIGN_BLOCK_PREVIEW_WIDGET::fitOnDrawArea(), SYMBOL_PREVIEW_WIDGET::fitOnDrawArea(), PCB_BASE_FRAME::FocusOnItems(), GENERAL_COLLECTORS_GUIDE::GENERAL_COLLECTORS_GUIDE(), GetViewport(), DS_PROXY_VIEW_ITEM::HitTestDrawingSheetItems(), Redraw(), PL_SELECTION_TOOL::selectionContains(), ZOOM_TOOL::selectRegion(), SetCenter(), SetScale(), SetViewport(), EDIT_POINTS::ViewDraw(), KIGFX::ANCHOR_DEBUG::ViewDraw(), KIGFX::CONSTRUCTION_GEOM::ViewDraw(), KIGFX::ORIGIN_VIEWITEM::ViewDraw(), KIGFX::PREVIEW::BEZIER_ASSISTANT::ViewDraw(), KIGFX::SNAP_INDICATOR::ViewDraw(), PCB_TUNING_PATTERN::ViewDraw(), PANEL_EESCHEMA_COLOR_SETTINGS::zoomFitPreview(), and PANEL_PCBNEW_COLOR_SETTINGS::zoomFitPreview().

◆ ToWorld() [2/2]

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

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

Parameters

aSize is the size to be converted.

Definition at line 478 of file view.cpp.

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

◆ Update() [1/2]

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

virtual

Reimplemented in KIGFX::PCB_VIEW, and KIGFX::SCH_VIEW.

Definition at line 1679 of file view.cpp.

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

◆ Update() [2/2]

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

virtual

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

For static views calling has no effect.

Parameters

aItem	the item to update.
aUpdateFlags	how much the object has changed.

Reimplemented in KIGFX::PCB_VIEW, and KIGFX::SCH_VIEW.

Definition at line 1685 of file view.cpp.

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

◆ UpdateAllItems()

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

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

Parameters

aUpdateFlags is is according to KIGFX::VIEW_UPDATE_FLAGS

Definition at line 1561 of file view.cpp.

References m_allItems, and VIEW_ITEM.

Referenced by GERBVIEW_FRAME::CommonSettingsChanged(), PCB_BASE_FRAME::CommonSettingsChanged(), PL_EDITOR_FRAME::CommonSettingsChanged(), SCH_BASE_FRAME::CommonSettingsChanged(), SYMBOL_EDIT_FRAME::CommonSettingsChanged(), GERBVIEW_CONTROL::DisplayControl(), SCH_BASE_FRAME::HardRedraw(), GERBVIEW_CONTROL::HighlightControl(), SCH_EDIT_FRAME::KiwayMailIn(), SYMBOL_VIEWER_FRAME::KiwayMailIn(), SYMBOL_EDIT_FRAME::LoadOneLibrarySymbolAux(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), PCB_EDIT_FRAME::OnBoardLoaded(), GERBVIEW_FRAME::OnSelectActiveDCode(), GERBVIEW_FRAME::OnSelectActiveLayer(), SYMBOL_EDIT_FRAME::RebuildView(), FOOTPRINT_PREVIEW_PANEL::RefreshAll(), GERBVIEW_FRAME::RemapLayers(), GERBVIEW_FRAME::SetLayerDrawPrms(), SYMBOL_EDIT_FRAME::ShowChangedLanguage(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), SCH_BASE_FRAME::SyncView(), COMMON_TOOLS::ToggleBoundingBoxes(), SCH_EDITOR_CONTROL::ToggleDirectiveLabels(), SCH_EDITOR_CONTROL::ToggleHiddenFields(), SYMBOL_EDITOR_CONTROL::ToggleHiddenFields(), SCH_EDITOR_CONTROL::ToggleHiddenPins(), SYMBOL_EDITOR_CONTROL::ToggleHiddenPins(), SCH_EDITOR_CONTROL::TogglePinAltIcons(), SYMBOL_EDITOR_CONTROL::TogglePinAltIcons(), PANEL_EESCHEMA_COLOR_SETTINGS::updatePreview(), PANEL_PCBNEW_COLOR_SETTINGS::updatePreview(), and GERBVIEW_FRAME::UpdateXORLayers().

◆ UpdateAllItemsConditionally() [1/2]

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

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

Parameters

aUpdateFlags	is is according to KIGFX::VIEW_UPDATE_FLAGS.
aCondition	is a function returning true if the item should be updated.

Definition at line 1571 of file view.cpp.

References m_allItems, and VIEW_ITEM.

Referenced by PCB_BASE_FRAME::CommonSettingsChanged(), GERBVIEW_CONTROL::DisplayControl(), PAD_TOOL::enterPadEditMode(), PAD_TOOL::ExitPadEditMode(), PCB_EDIT_FRAME::OnNetlistChanged(), SCH_EDIT_FRAME::RecalculateConnections(), ZONE_FILLER_TOOL::refresh(), SCH_EDIT_FRAME::RefreshOperatingPointDisplay(), PCB_EDIT_FRAME::SetActiveLayer(), PCB_BASE_FRAME::SetDisplayOptions(), GERBVIEW_FRAME::SetElementVisibility(), PCB_BASE_FRAME::SetPlotSettings(), APPEARANCE_CONTROLS::setVisibleLayers(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), and KIGFX::PCB_VIEW::UpdateCollidingItems().

◆ UpdateAllItemsConditionally() [2/2]

void KIGFX::VIEW::UpdateAllItemsConditionally ( std::function< int(VIEW_ITEM *)> aItemFlagsProvider )

Update items in the view according to the flags returned by the callback.

Parameters

aItemFlagsProvider is a function returning any KIGFX::VIEW_UPDATE_FLAGS that should be set on the VIEW_ITEM.

Definition at line 1588 of file view.cpp.

References m_allItems, and VIEW_ITEM.

◆ UpdateAllLayersColor()

void KIGFX::VIEW::UpdateAllLayersColor ( )

Apply the new coloring scheme to all layers.

The used scheme is held by RENDER_SETTINGS.

See also: RENDER_SETTINGS

Definition at line 775 of file view.cpp.

References color, KIGFX::VIEW_ITEM_DATA::getGroup(), group, m_allItems, m_gal, KIGFX::VIEW_ITEM_DATA::m_layers, m_painter, MarkDirty(), and VIEW_ITEM.

Referenced by FOOTPRINT_EDIT_FRAME::CommonSettingsChanged(), PCB_SELECTION_TOOL::doSyncSelection(), EnableTopLayer(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), API_HANDLER_PCB::handleSetBoardEditorAppearanceSettings(), PNS::TOOL_BASE::highlightNets(), and APPEARANCE_CONTROLS::onNetclassContextMenu().

◆ UpdateAllLayersOrder()

void KIGFX::VIEW::UpdateAllLayersOrder ( )

Do everything that is needed to apply the rendering order of layers.

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

Definition at line 906 of file view.cpp.

References KIGFX::VIEW_ITEM_DATA::getGroup(), group, m_allItems, m_gal, m_layers, KIGFX::VIEW_ITEM_DATA::m_layers, MarkDirty(), sortOrderedLayers(), and VIEW_ITEM.

Referenced by EnableTopLayer(), SCH_DRAW_PANEL::SCH_DRAW_PANEL(), and SCH_PREVIEW_PANEL::SCH_PREVIEW_PANEL().

◆ updateBbox()

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

protected

Update bounding box of an item.

Definition at line 1347 of file view.cpp.

References KIGFX::VIEW::VIEW_LAYER::items, KIGFX::VIEW_ITEM_DATA::m_bbox, m_layers, KIGFX::VIEW_ITEM::m_viewPrivData, MarkTargetDirty(), KIGFX::VIEW::VIEW_LAYER::target, VIEW_ITEM, KIGFX::VIEW_ITEM::ViewBBox(), and KIGFX::VIEW_ITEM::ViewGetLayers().

Referenced by invalidateItem().

◆ updateItemColor()

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

protected

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

Definition at line 1292 of file view.cpp.

References color, KIGFX::VIEW_ITEM_DATA::getGroup(), group, IsCached(), m_gal, m_painter, VIEW_ITEM, and KIGFX::VIEW_ITEM::viewPrivData().

Referenced by invalidateItem().

◆ updateItemGeometry()

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

protected

Update all information needed to draw an item.

Definition at line 1310 of file view.cpp.

References KIGFX::VIEW_ITEM_DATA::getGroup(), group, m_gal, m_layers, m_painter, KIGFX::VIEW::VIEW_LAYER::renderingOrder, KIGFX::VIEW_ITEM_DATA::setGroup(), KIGFX::VIEW::VIEW_LAYER::target, KIGFX::TARGET_CACHED, VIEW_ITEM, KIGFX::VIEW_ITEM::ViewDraw(), and KIGFX::VIEW_ITEM::viewPrivData().

Referenced by invalidateItem().

◆ UpdateItems()

void KIGFX::VIEW::UpdateItems ( )

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

Definition at line 1468 of file view.cpp.

References _, KIGFX::GEOMETRY, invalidateItem(), KIGFX::VIEW::VIEW_LAYER::items, KI_TRACE, KIGFX::LAYERS, m_allItems, m_gal, m_layers, MarkTargetDirty(), KIGFX::NONE, KIGFX::VIEW::VIEW_LAYER::target, traceGalProfile, and VIEW_ITEM.

Referenced by SELECTION_TOOL::doSelectionMenu(), ReorderLayerData(), and SCH_FIND_REPLACE_TOOL::UpdateFind().

◆ UpdateLayerColor()

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

Apply the new coloring scheme held by RENDER_SETTINGS in case that it has changed.

Parameters

aLayer is a number of the layer to be updated.

See also: RENDER_SETTINGS

Definition at line 754 of file view.cpp.

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

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

◆ updateLayers()

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

protected

Update set of layers that an item occupies.

Definition at line 1372 of file view.cpp.

References KIGFX::VIEW_ITEM_DATA::getGroup(), KIGFX::VIEW::VIEW_LAYER::id, IsCached(), KIGFX::VIEW::VIEW_LAYER::items, KIGFX::VIEW_ITEM_DATA::m_bbox, m_gal, m_layers, KIGFX::VIEW_ITEM_DATA::m_layers, KIGFX::VIEW_ITEM::m_viewPrivData, MarkTargetDirty(), KIGFX::VIEW_ITEM_DATA::saveLayers(), KIGFX::VIEW_ITEM_DATA::setGroup(), KIGFX::VIEW::VIEW_LAYER::target, VIEW_ITEM, KIGFX::VIEW_ITEM::ViewBBox(), KIGFX::VIEW_ITEM::ViewGetLayers(), and KIGFX::VIEW_ITEM::viewPrivData().

Referenced by invalidateItem().

◆ UseDrawPriority()

void KIGFX::VIEW::UseDrawPriority ( bool aFlag )

inline

Parameters

aFlag is true if draw priority should be respected while redrawing.

Definition at line 713 of file view.h.

References m_useDrawPriority.

Friends And Related Symbol Documentation

◆ VIEW_ITEM

friend class VIEW_ITEM

friend

Definition at line 68 of file view.h.

References VIEW_ITEM.

Referenced by Add(), AddToPreview(), KIGFX::SCH_VIEW::ClearHiddenFlags(), ClearPreview(), KIGFX::VIEW::DRAW_ITEM_VISITOR::deferredDraw(), draw(), draw(), HasItem(), Hide(), invalidateItem(), IsHiddenOnOverlay(), IsVisible(), OnDestroy(), KIGFX::VIEW::CLEAR_LAYER_CACHE_VISITOR::operator()(), KIGFX::VIEW::DRAW_ITEM_VISITOR::operator()(), KIGFX::VIEW::RECACHE_ITEM_VISITOR::operator()(), KIGFX::VIEW::UPDATE_COLOR_VISITOR::operator()(), KIGFX::VIEW::UPDATE_DEPTH_VISITOR::operator()(), operator=(), Query(), Query(), Remove(), ReorderLayerData(), SetVisible(), Update(), Update(), UpdateAllItems(), UpdateAllItemsConditionally(), UpdateAllItemsConditionally(), UpdateAllLayersColor(), UpdateAllLayersOrder(), updateBbox(), updateItemColor(), updateItemGeometry(), UpdateItems(), updateLayers(), and VIEW_ITEM.

Member Data Documentation

◆ m_allItems

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

protected

Flat list of all items.

Definition at line 871 of file view.h.

Referenced by Add(), Clear(), KIGFX::SCH_VIEW::ClearHiddenFlags(), DataReference(), Remove(), ReorderLayerData(), UpdateAllItems(), UpdateAllItemsConditionally(), UpdateAllItemsConditionally(), UpdateAllLayersColor(), UpdateAllLayersOrder(), UpdateItems(), and VIEW().

◆ m_boundary

BOX2D KIGFX::VIEW::m_boundary

protected

Definition at line 880 of file view.h.

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

◆ m_center

VECTOR2D KIGFX::VIEW::m_center

protected

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

Definition at line 877 of file view.h.

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

◆ m_dirtyTargets

bool KIGFX::VIEW::m_dirtyTargets[TARGETS_NUMBER]

protected

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

Definition at line 894 of file view.h.

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

◆ m_enableOrderModifier

bool KIGFX::VIEW::m_enableOrderModifier

protected

Whether to use rendering order modifier or not.

Definition at line 862 of file view.h.

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

◆ m_gal

GAL* KIGFX::VIEW::m_gal

protected

Interface to PAINTER that is used to draw items.

Definition at line 891 of file view.h.

Referenced by Clear(), ClearTargets(), draw(), draw(), GetGAL(), GetScreenPixelSize(), GetViewport(), RecacheAllItems(), Redraw(), redrawRect(), Remove(), SetCenter(), SetCenter(), SetGAL(), SetMirror(), SetScale(), SetViewport(), ToScreen(), ToScreen(), ToWorld(), ToWorld(), UpdateAllLayersColor(), UpdateAllLayersOrder(), updateItemColor(), updateItemGeometry(), UpdateItems(), UpdateLayerColor(), updateLayers(), and VIEW().

◆ m_layers

std::map<int, VIEW_LAYER> KIGFX::VIEW::m_layers

protected

The set of possible displayed layers and its properties.

Definition at line 865 of file view.h.

Referenced by Add(), areRequiredLayersEnabled(), Clear(), clearGroupCache(), ClearTopLayers(), DataReference(), draw(), EnableTopLayer(), GetLayerOrder(), invalidateItem(), IsCached(), IsLayerVisible(), RecacheAllItems(), Remove(), ReorderLayerData(), SetLayerDiff(), SetLayerDisplayOnly(), SetLayerHasNegatives(), SetLayerOrder(), SetLayerTarget(), SetLayerVisible(), SetRequired(), SetTopLayer(), sortOrderedLayers(), UpdateAllLayersOrder(), updateBbox(), updateItemGeometry(), UpdateItems(), UpdateLayerColor(), updateLayers(), and VIEW().

◆ m_maxScale

double KIGFX::VIEW::m_maxScale

protected

Definition at line 882 of file view.h.

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

◆ m_minScale

double KIGFX::VIEW::m_minScale

protected

Definition at line 881 of file view.h.

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

◆ m_mirrorX

bool KIGFX::VIEW::m_mirrorX

protected

Definition at line 884 of file view.h.

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

◆ m_mirrorY

bool KIGFX::VIEW::m_mirrorY

protected

Definition at line 885 of file view.h.

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

◆ m_nextDrawPriority

int KIGFX::VIEW::m_nextDrawPriority

protected

The next sequential drawing priority.

Definition at line 900 of file view.h.

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

◆ m_orderedLayers

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

protected

Sorted list of pointers to members of m_layers.

Definition at line 868 of file view.h.

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

◆ m_ownedItems

std::vector<VIEW_ITEM*> KIGFX::VIEW::m_ownedItems

protected

Definition at line 859 of file view.h.

Referenced by AddToPreview(), and ClearPreview().

◆ m_painter

PAINTER* KIGFX::VIEW::m_painter

protected

PAINTER contains information how do draw items.

Definition at line 888 of file view.h.

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

◆ m_preview

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

protected

Definition at line 858 of file view.h.

Referenced by AddToPreview(), KIGFX::SCH_VIEW::Cleanup(), ClearPreview(), InitPreview(), ShowPreview(), VIEW(), and ~VIEW().

◆ m_reverseDrawOrder

bool KIGFX::VIEW::m_reverseDrawOrder

protected

Flag to reverse the draw order when using draw priority.

Definition at line 903 of file view.h.

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

◆ m_scale

double KIGFX::VIEW::m_scale

protected

Definition at line 879 of file view.h.

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

◆ m_topLayers

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

protected

The set of layers that are displayed on the top.

Definition at line 874 of file view.h.

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

◆ m_useDrawPriority

bool KIGFX::VIEW::m_useDrawPriority

protected

Flag to respect draw priority when drawing items.

Definition at line 897 of file view.h.

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

◆ TOP_LAYER_MODIFIER

int KIGFX::VIEW::TOP_LAYER_MODIFIER = -MAX_LAYERS_FOR_VIEW

staticconstexpr

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

Definition at line 748 of file view.h.

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

◆ VIEW_MAX_LAYERS

int KIGFX::VIEW::VIEW_MAX_LAYERS = MAX_LAYERS_FOR_VIEW

staticconstexpr

Maximum number of layers that may be shown.

Definition at line 745 of file view.h.

Referenced by Add(), SCH_PRINTOUT::PrintPage(), KIGFX::VIEW_ITEM_DATA::saveLayers(), GERBVIEW_DRAW_PANEL_GAL::setDefaultLayerDeps(), PCB_DRAW_PANEL_GAL::setDefaultLayerDeps(), PL_DRAW_PANEL_GAL::setDefaultLayerDeps(), SCH_DRAW_PANEL::setDefaultLayerDeps(), SCH_PREVIEW_PANEL::setDefaultLayerDeps(), PCB_DRAW_PANEL_GAL::setDefaultLayerOrder(), SCH_DRAW_PANEL::setDefaultLayerOrder(), SCH_PREVIEW_PANEL::setDefaultLayerOrder(), BOARD_PRINTOUT::setupViewLayers(), and VIEW().

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

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ LAYER_ITEM_PAIR

Constructor & Destructor Documentation

◆ VIEW() [1/2]

◆ ~VIEW()

◆ VIEW() [2/2]

Member Function Documentation

◆ Add()

◆ AddToPreview()

◆ areRequiredLayersEnabled()

◆ Clear()

◆ clearGroupCache()

◆ ClearPreview()

◆ ClearTargets()

◆ ClearTopLayers()

◆ compareRenderingOrder()

◆ CopySettings()

◆ DataReference()

◆ draw() [1/3]

◆ draw() [2/3]

◆ draw() [3/3]

◆ EnableTopLayer()

◆ GetBoundary()

◆ GetCenter()

◆ GetGAL()

◆ GetLayerOrder()

◆ GetPainter()

◆ GetScale()

◆ GetScreenPixelSize()

◆ GetTopLayer()

◆ GetViewport()

◆ HasItem()

◆ Hide()

◆ InitPreview()

◆ invalidateItem()

◆ IsCached()

◆ IsDirty()

◆ IsHiddenOnOverlay()

◆ IsLayerVisible()

◆ IsMirroredX()

◆ IsMirroredY()

◆ IsTargetDirty()

◆ IsUsingDrawPriority()

◆ IsVisible()

◆ MakeOverlay()

◆ MarkClean()

◆ MarkDirty()

◆ markTargetClean()

◆ MarkTargetDirty()

◆ OnDestroy()

◆ operator=()

◆ Query() [1/2]

◆ Query() [2/2]

◆ RecacheAllItems()

◆ Redraw()

◆ redrawRect()

◆ Remove()

◆ ReorderLayerData()

◆ ReverseDrawOrder()

◆ SetBoundary() [1/2]

◆ SetBoundary() [2/2]

◆ SetCenter() [1/2]

◆ SetCenter() [2/2]

◆ SetGAL()

◆ SetLayerDiff()

◆ SetLayerDisplayOnly()

◆ SetLayerHasNegatives()

◆ SetLayerOrder()

◆ SetLayerTarget()

◆ SetLayerVisible()