KIGFX::PCB_VIEW Class Reference

#include <pcb_view.h>

Inheritance diagram for KIGFX::PCB_VIEW:

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

Public Member Functions
	PCB_VIEW (bool aIsDynamic=true)
virtual	~PCB_VIEW ()
virtual void	Add (VIEW_ITEM *aItem, int aDrawPriority=-1) override
	Add a VIEW_ITEM to the view. More...
virtual void	Remove (VIEW_ITEM *aItem) override
	Remove a VIEW_ITEM from the view. More...
virtual void	Update (const VIEW_ITEM *aItem, int aUpdateFlags) const override
	For dynamic VIEWs, inform the associated VIEW that the graphical representation of this item has changed. More...
virtual void	Update (const VIEW_ITEM *aItem) const override
	For dynamic VIEWs, inform the associated VIEW that the graphical representation of this item has changed. More...
void	UpdateDisplayOptions (const PCB_DISPLAY_OPTIONS &aOptions)
virtual int	Query (const BOX2I &aRect, std::vector< LAYER_ITEM_PAIR > &aResult) const
	Find all visible items that touch or are within the rectangle aRect. More...
void	SetVisible (VIEW_ITEM *aItem, bool aIsVisible=true)
	Set the item visibility. More...
void	Hide (VIEW_ITEM *aItem, bool aHide=true)
	Temporarily hide the item in the view (e.g. More...
bool	IsVisible (const VIEW_ITEM *aItem) const
	Return information if the item is visible (or not). More...
bool	HasItem (const VIEW_ITEM *aItem) const
	Indicates whether or not the given item has been added to the view. More...
void	SetRequired (int aLayerId, int aRequiredId, bool aRequired=true)
	Mark the aRequiredId layer as required for the aLayerId layer. More...
void	CopySettings (const VIEW *aOtherView)
	Copy layers and visibility settings from another view. More...
void	SetGAL (GAL *aGal)
	Assign a rendering device for the VIEW. More...
GAL *	GetGAL () const
	Return the #GAL this view is using to draw graphical primitives. More...
void	SetPainter (PAINTER *aPainter)
	Set the painter object used by the view for drawing #VIEW_ITEMS. More...
PAINTER *	GetPainter () const
	Return the painter object used by the view for drawing #VIEW_ITEMS. More...
void	SetViewport (const BOX2D &aViewport)
	Set the visible area of the VIEW. More...
BOX2D	GetViewport () const
	Return the current viewport visible area rectangle. More...
void	SetMirror (bool aMirrorX, bool aMirrorY)
	Control the mirroring of the VIEW. More...
bool	IsMirroredX () const
	Return true if view is flipped across the X axis. More...
bool	IsMirroredY () const
	Return true if view is flipped across the Y axis. More...
virtual void	SetScale (double aScale, VECTOR2D aAnchor={ 0, 0 })
	Set the scaling factor, zooming around a given anchor point. More...
double	GetScale () const
void	SetBoundary (const BOX2D &aBoundary)
	Set limits for view area. More...
void	SetBoundary (const BOX2I &aBoundary)
	Set limits for view area. More...
const BOX2D &	GetBoundary () const
void	SetScaleLimits (double aMaximum, double aMinimum)
	Set minimum and maximum values for scale. More...
void	SetCenter (const VECTOR2D &aCenter)
	Set the center point of the VIEW (i.e. More...
void	SetCenter (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). More...
const VECTOR2D &	GetCenter () const
	Return the center point of this VIEW (in world space coordinates). More...
VECTOR2D	ToWorld (const VECTOR2D &aCoord, bool aAbsolute=true) const
	Converts a screen space point/vector to a point/vector in world space coordinates. More...
double	ToWorld (double aSize) const
	Converts a screen space one dimensional size to a one dimensional size in world space coordinates. More...
VECTOR2D	ToScreen (const VECTOR2D &aCoord, bool aAbsolute=true) const
	Convert a world space point/vector to a point/vector in screen space coordinates. More...
double	ToScreen (double aSize) const
	Convert a world space one dimensional size to a one dimensional size in screen space. More...
const VECTOR2I &	GetScreenPixelSize () const
	Return the size of the our rendering area in pixels. More...
void	Clear ()
	Remove all items from the view. More...
void	SetLayerVisible (int aLayer, bool aVisible=true)
	Control the visibility of a particular layer. More...
bool	IsLayerVisible (int aLayer) const
	Return information about visibility of a particular layer. More...
void	SetLayerDiff (int aLayer, bool aDiff=true)
	Set the whether the layer should drawn differentially. More...
void	SetLayerHasNegatives (int aLayer, bool aNegatives=true)
	Set the status of negatives presense in a particular layer. More...
void	SetLayerDisplayOnly (int aLayer, bool aDisplayOnly=true)
	Set a layer display-only (ie: to be rendered but not returned by hit test queries). More...
void	SetLayerTarget (int aLayer, RENDER_TARGET aTarget)
	Change the rendering target for a particular layer. More...
void	SetLayerOrder (int aLayer, int aRenderingOrder)
	Set rendering order of a particular layer. More...
int	GetLayerOrder (int aLayer) const
	Return rendering order of a particular layer. More...
void	SortLayers (int aLayers[], int &aCount) const
	Change the order of given layer ids, so after sorting the order corresponds to layers rendering order (descending, ie. More...
void	ReorderLayerData (std::unordered_map< int, int > aReorderMap)
	Remap the data between layer ids without invalidating that data. More...
void	UpdateLayerColor (int aLayer)
	Apply the new coloring scheme held by RENDER_SETTINGS in case that it has changed. More...
void	UpdateAllLayersColor ()
	Apply the new coloring scheme to all layers. More...
virtual void	SetTopLayer (int aLayer, bool aEnabled=true)
	Set given layer to be displayed on the top or sets back the default order of layers. More...
virtual void	EnableTopLayer (bool aEnable)
	Enable or disable display of the top layer. More...
virtual int	GetTopLayer () const
void	ClearTopLayers ()
	Remove all layers from the on-the-top set (they are no longer displayed over the rest of layers). More...
void	UpdateAllLayersOrder ()
	Do everything that is needed to apply the rendering order of layers. More...
void	ClearTargets ()
	Clear targets that are marked as dirty. More...
virtual void	Redraw ()
	Immediately redraws the whole view. More...
void	RecacheAllItems ()
	Rebuild GAL display lists. More...
bool	IsDynamic () const
	Tell if the VIEW is dynamic (ie. More...
bool	IsDirty () const
	Return true if any of the VIEW layers needs to be refreshened. More...
bool	IsTargetDirty (int aTarget) const
	Return true if any of layers belonging to the target or the target itself should be redrawn. More...
void	MarkTargetDirty (int aTarget)
	Set or clear target 'dirty' flag. More...
bool	IsCached (int aLayer) const
	Return true if the layer is cached. More...
void	MarkDirty ()
	Force redraw of view on the next rendering. More...
void	MarkClean ()
	Force redraw of view on the next rendering. More...
void	UpdateItems ()
	Iterate through the list of items that asked for updating and updates them. More...
void	UpdateAllItems (int aUpdateFlags)
	Update all items in the view according to the given flags. More...
void	UpdateAllItemsConditionally (int aUpdateFlags, std::function< bool(VIEW_ITEM *)> aCondition)
	Update items in the view according to the given flags and condition. More...
void	UpdateAllItemsConditionally (std::function< int(VIEW_ITEM *)> aItemFlagsProvider)
	Update items in the view according to the flags returned by the callback. More...
bool	IsUsingDrawPriority () const
void	UseDrawPriority (bool aFlag)
void	ReverseDrawOrder (bool aFlag)
	Only takes effect if UseDrawPriority is true. More...
std::shared_ptr< VIEW_OVERLAY >	MakeOverlay ()
void	InitPreview ()
void	ClearPreview ()
void	AddToPreview (EDA_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. More...

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

Static Public Attributes
static constexpr int	VIEW_MAX_LAYERS = 512
	Rendering order modifier for layers that are marked as top layers. More...
static constexpr int	TOP_LAYER_MODIFIER = -VIEW_MAX_LAYERS

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

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

Protected Attributes
std::unique_ptr< KIGFX::VIEW_GROUP >	m_preview
std::vector< EDA_ITEM * >	m_ownedItems
	Whether to use rendering order modifier or not. More...
bool	m_enableOrderModifier
	The set of possible displayed layers and its properties. More...
std::vector< VIEW_LAYER >	m_layers
	Sorted list of pointers to members of m_layers. More...
std::vector< VIEW_LAYER * >	m_orderedLayers
	Flat list of all items. More...
std::shared_ptr< std::vector< VIEW_ITEM * > >	m_allItems
	The set of layers that are displayed on the top. More...
std::set< unsigned int >	m_topLayers
	Center point of the VIEW (the point at which we are looking at). More...
VECTOR2D	m_center
double	m_scale
BOX2D	m_boundary
double	m_minScale
double	m_maxScale
bool	m_mirrorX
bool	m_mirrorY
	PAINTER contains information how do draw items. More...
PAINTER *	m_painter
	Interface to #PAINTER that is used to draw items. More...
GAL *	m_gal
	Dynamic VIEW (eg. More...
bool	m_dynamic
	Flag to mark targets as dirty so they have to be redrawn on the next refresh event. More...
bool	m_dirtyTargets [TARGETS_NUMBER]
	Flag to respect draw priority when drawing items. More...
bool	m_useDrawPriority
	The next sequential drawing priority. More...
int	m_nextDrawPriority
	Flag to reverse the draw order when using draw priority. More...
bool	m_reverseDrawOrder

Detailed Description

Definition at line 36 of file pcb_view.h.

Member Typedef Documentation

LAYER_ITEM_PAIR

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

inherited

Definition at line 73 of file view.h.

Constructor & Destructor Documentation

PCB_VIEW()

KIGFX::PCB_VIEW::PCB_VIEW

(

bool

aIsDynamic = true

)

Definition at line 38 of file pcb_view.cpp.

 :
 VIEW( aIsDynamic )
{
 // Set m_boundary to define the max area size. The default value is acceptable for Pcbnew
 // and Gerbview.
 // However, ensure this area has the right size (max size allowed by integer coordinates) in
 // case of the default value is changed. Could be a size depending on the drawing-sheet size.
 typedef std::numeric_limits<int> coord_limits;
 double pos = coord_limits::lowest() / 2 + coord_limits::epsilon();
 double size = coord_limits::max() - coord_limits::epsilon();
 m_boundary.SetOrigin( pos, pos );
 m_boundary.SetSize( size, size );
}

References KIGFX::VIEW::m_boundary, BOX2< Vec >::SetOrigin(), and BOX2< Vec >::SetSize().

~PCB_VIEW()

KIGFX::PCB_VIEW::~PCB_VIEW ( )

virtual

Definition at line 53 of file pcb_view.cpp.

{
}

Member Function Documentation

Add()

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

overridevirtual

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 from KIGFX::VIEW.

Definition at line 58 of file pcb_view.cpp.

{
 BOARD_ITEM* boardItem = dynamic_cast<BOARD_ITEM*>( aItem );
 
 if( boardItem && boardItem->Type() == PCB_FOOTPRINT_T )
 {
 FOOTPRINT* footprint = static_cast<FOOTPRINT*>( boardItem );
 footprint->RunOnChildren( [this]( BOARD_ITEM* aChild )
 {
 VIEW::Add( aChild );
 } );
 }
 
 VIEW::Add( aItem, aDrawPriority );
}

References KIGFX::VIEW::Add(), PCB_FOOTPRINT_T, FOOTPRINT::RunOnChildren(), and EDA_ITEM::Type().

Referenced by PCB_TOOL_BASE::doInteractiveItemPlacement(), MICROWAVE_TOOL::drawMicrowaveInductor(), PCB_EDIT_FRAME::ImportSpecctraSession(), PCB_VIEWER_TOOLS::MeasureTool(), FOOTPRINT_PREVIEW_PANEL::renderFootprint(), PCB_SELECTION_TOOL::Reset(), PCB_EDIT_FRAME::ResolveDRCExclusions(), DIALOG_FOOTPRINT_CHECKER::runChecks(), PCB_SELECTION_TOOL::selectMultiple(), PCB_BASE_FRAME::ShowSolderMask(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataFromWindow(), and PCB_SELECTION_TOOL::zoomFitSelection().

AddToPreview()

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

inherited

Definition at line 1635 of file view.cpp.

{
 Hide( aItem, false );
 m_preview->Add( aItem );
 
 if( aTakeOwnership )
 m_ownedItems.push_back( aItem );
 
 SetVisible( m_preview.get(), true );
 Hide( m_preview.get(), false );
 Update( m_preview.get() );
}

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

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

areRequiredLayersEnabled()

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

protectedinherited

Definition at line 1367 of file view.cpp.

{
 wxCHECK( (unsigned) aLayerId < m_layers.size(), false );
 
 std::set<int>::const_iterator it, it_end;
 
 for( int layer : m_layers.at( aLayerId ).requiredLayers )
 {
 // That is enough if just one layer is not enabled
 if( !m_layers.at( layer ).visible || !areRequiredLayersEnabled( layer ) )
 return false;
 }
 
 return true;
}

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

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

Clear()

void KIGFX::VIEW::Clear ( )

inherited

Remove all items from the view.

Definition at line 1099 of file view.cpp.

{
 BOX2I r;
 r.SetMaximum();
 m_allItems->clear();
 
 for( VIEW_LAYER& layer : m_layers )
 layer.items->RemoveAll();
 
 m_nextDrawPriority = 0;
 
 m_gal->ClearCache();
}

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

Referenced by KIGFX::SCH_VIEW::Cleanup(), GERBVIEW_FRAME::Clear_DrawLayers(), PCB_DRAW_PANEL_GAL::DisplayBoard(), PL_DRAW_PANEL_GAL::DisplayDrawingSheet(), SCH_DRAW_PANEL::DisplaySheet(), SCH_DRAW_PANEL::DisplaySymbol(), KIGFX::SCH_VIEW::DisplaySymbol(), GERBVIEW_FRAME::doCloseWindow(), DISPLAY_FOOTPRINTS_FRAME::InitDisplay(), PCB_EDIT_FRAME::RebuildAndRefresh(), FOOTPRINT_PREVIEW_PANEL::renderFootprint(), DS_PROXY_UNDO_ITEM::Restore(), PCB_BASE_EDIT_FRAME::SetBoard(), SYMBOL_EDIT_FRAME::SetCurSymbol(), GERBVIEW_DRAW_PANEL_GAL::SwitchBackend(), DISPLAY_FOOTPRINTS_FRAME::~DISPLAY_FOOTPRINTS_FRAME(), FOOTPRINT_PREVIEW_PANEL::~FOOTPRINT_PREVIEW_PANEL(), FOOTPRINT_VIEWER_FRAME::~FOOTPRINT_VIEWER_FRAME(), GERBVIEW_FRAME::~GERBVIEW_FRAME(), and PCB_BASE_EDIT_FRAME::~PCB_BASE_EDIT_FRAME().

clearGroupCache()

void KIGFX::VIEW::clearGroupCache ( )

protectedinherited

Definition at line 1190 of file view.cpp.

{
 BOX2I r;
 
 r.SetMaximum();
 CLEAR_LAYER_CACHE_VISITOR visitor( this );
 
 for( VIEW_LAYER& layer : m_layers )
 layer.items->Query( r, visitor );
}

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

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

ClearPreview()

void KIGFX::VIEW::ClearPreview ( )

inherited

Definition at line 1613 of file view.cpp.

{
 if( !m_preview )
 return;
 
 m_preview->Clear();
 
 for( EDA_ITEM *item : m_ownedItems )
 delete item;
 
 m_ownedItems.clear();
 Update( m_preview.get() );
}

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

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

ClearTargets()

void KIGFX::VIEW::ClearTargets ( )

inherited

Clear targets that are marked as dirty.

Definition at line 1114 of file view.cpp.

{
 if( IsTargetDirty( TARGET_CACHED ) || IsTargetDirty( TARGET_NONCACHED ) )
 {
 // TARGET_CACHED and TARGET_NONCACHED have to be redrawn together, as they contain
 // layers that rely on each other (eg. netnames are noncached, but tracks - are cached)
 m_gal->ClearTarget( TARGET_NONCACHED );
 m_gal->ClearTarget( TARGET_CACHED );
 
 MarkDirty();
 }
 
 if( IsTargetDirty( TARGET_OVERLAY ) )
 {
 m_gal->ClearTarget( TARGET_OVERLAY );
 }
}

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

Referenced by EDA_DRAW_PANEL_GAL::DoRePaint().

ClearTopLayers()

void KIGFX::VIEW::ClearTopLayers ( )

inherited

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

Definition at line 877 of file view.cpp.

{
 std::set<unsigned int>::iterator it;
 
 if( m_enableOrderModifier )
 {
 // Restore the previous rendering order for layers that were marked as top
 for( it = m_topLayers.begin(); it != m_topLayers.end(); ++it )
 m_layers[*it].renderingOrder -= TOP_LAYER_MODIFIER;
 }
 
 m_topLayers.clear();
}

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

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

compareRenderingOrder()

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

inlinestaticprotectedinherited

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

Definition at line 819 of file view.h.

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

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

CopySettings()

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

inherited

Copy layers and visibility settings from another view.

Parameters

aOtherView

view from which settings will be copied.

Definition at line 486 of file view.cpp.

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

DataReference()

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

inherited

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

GAL, PAINTER and other properties are left uninitialized. Maximum number of layers that may be shown

Definition at line 1519 of file view.cpp.

{
 std::unique_ptr<VIEW> ret = std::make_unique<VIEW>();
 ret->m_allItems = m_allItems;
 ret->m_layers = m_layers;
 ret->sortLayers();
 return ret;
}

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

Referenced by BOARD_PRINTOUT::DrawPage().

draw() [1/3]

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

protectedinherited

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

Definition at line 1058 of file view.cpp.

{
 for( unsigned int i = 0; i < aGroup->GetSize(); i++)
 draw( aGroup->GetItem(i), aImmediate );
}

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

draw() [2/3]

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

protectedinherited

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

{
 int layers[VIEW_MAX_LAYERS], layers_count;
 
 aItem->ViewGetLayers( layers, layers_count );
 
 // Sorting is needed for drawing order dependent GALs (like Cairo)
 SortLayers( layers, layers_count );
 
 for( int i = 0; i < layers_count; ++i )
 {
 m_gal->SetLayerDepth( m_layers.at( layers[i] ).renderingOrder );
 draw( aItem, layers[i], aImmediate );
 }
}

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

draw() [3/3]

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

protectedinherited

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

{
 VIEW_ITEM_DATA* viewData = aItem->viewPrivData();
 
 if( !viewData )
 return;
 
 if( IsCached( aLayer ) && !aImmediate )
 {
 // Draw using cached information or create one
 int group = viewData->getGroup( aLayer );
 
 if( group >= 0 )
 m_gal->DrawGroup( group );
 else
 Update( aItem );
 }
 else
 {
 // Immediate mode
 if( !m_painter->Draw( aItem, aLayer ) )
 aItem->ViewDraw( aLayer, this ); // Alternative drawing method
 }
}

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

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

EnableTopLayer()

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

virtualinherited

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

{
 if( aEnable == m_enableOrderModifier )
 return;
 
 m_enableOrderModifier = aEnable;
 
 std::set<unsigned int>::iterator it;
 
 if( aEnable )
 {
 for( it = m_topLayers.begin(); it != m_topLayers.end(); ++it )
 m_layers[*it].renderingOrder += TOP_LAYER_MODIFIER;
 }
 else
 {
 for( it = m_topLayers.begin(); it != m_topLayers.end(); ++it )
 m_layers[*it].renderingOrder -= TOP_LAYER_MODIFIER;
 }
 
 UpdateAllLayersOrder();
 UpdateAllLayersColor();
}

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

Referenced by PCB_DRAW_PANEL_GAL::SetTopLayer().

GetBoundary()

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

inlineinherited

Returns

Current view area boundary.

Definition at line 298 of file view.h.

 {
 return m_boundary;
 }

References KIGFX::VIEW::m_boundary.

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

GetCenter()

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

inlineinherited

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

Returns

center point of the view

Definition at line 339 of file view.h.

 {
 return m_center;
 }

References KIGFX::VIEW::m_center.

Referenced by EDA_DRAW_PANEL_GAL::DoRePaint(), NL_SCHEMATIC_PLUGIN_IMPL::GetCameraMatrix(), NL_PCBNEW_PLUGIN_IMPL::GetCameraMatrix(), KIGFX::WX_VIEW_CONTROLS::onMotion(), KIGFX::WX_VIEW_CONTROLS::onScroll(), KIGFX::WX_VIEW_CONTROLS::onTimer(), KIGFX::WX_VIEW_CONTROLS::onWheel(), SYMBOL_EDITOR_DRAWING_TOOLS::PlaceAnchor(), NL_SCHEMATIC_PLUGIN_IMPL::SetCameraMatrix(), NL_PCBNEW_PLUGIN_IMPL::SetCameraMatrix(), NL_SCHEMATIC_PLUGIN_IMPL::SetViewExtents(), and NL_PCBNEW_PLUGIN_IMPL::SetViewExtents().

GetGAL()

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

inlineinherited

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

Returns

Pointer to the currently used GAL instance.

Definition at line 195 of file view.h.

 {
 return m_gal;
 }

References KIGFX::VIEW::m_gal.

Referenced by EE_GRID_HELPER::BestDragOrigin(), PCB_GRID_HELPER::BestDragOrigin(), PCB_GRID_HELPER::BestSnapAnchor(), GRID_HELPER::canUseGrid(), KIGFX::WX_VIEW_CONTROLS::CenterOnCursor(), PNS_PCBNEW_DEBUG_DECORATOR::Clear(), COMMON_TOOLS::CursorControl(), PCB_CONTROL::DoSetGridOrigin(), COMMON_TOOLS::doZoomInOut(), drawBacksideTicks(), KIGFX::PREVIEW::CENTRELINE_RECT_ITEM::drawPreviewShape(), KIGFX::PREVIEW::POLYGON_ITEM::drawPreviewShape(), KIGFX::PREVIEW::DrawTextNextToCursor(), drawTicksAlongLine(), KIGFX::VIEW_OVERLAY::COMMAND_LINE::Execute(), KIGFX::VIEW_OVERLAY::COMMAND_RECTANGLE::Execute(), KIGFX::VIEW_OVERLAY::COMMAND_CIRCLE::Execute(), KIGFX::VIEW_OVERLAY::COMMAND_ARC::Execute(), KIGFX::VIEW_OVERLAY::COMMAND_POLYGON::Execute(), KIGFX::VIEW_OVERLAY::COMMAND_POLY_POLYGON::Execute(), KIGFX::VIEW_OVERLAY::COMMAND_POINT_POLYGON::Execute(), KIGFX::VIEW_OVERLAY::COMMAND_SET_STROKE::Execute(), KIGFX::VIEW_OVERLAY::COMMAND_SET_FILL::Execute(), KIGFX::VIEW_OVERLAY::COMMAND_SET_COLOR::Execute(), KIGFX::VIEW_OVERLAY::COMMAND_SET_WIDTH::Execute(), KIGFX::VIEW_OVERLAY::COMMAND_GLYPH_SIZE::Execute(), KIGFX::VIEW_OVERLAY::COMMAND_BITMAP_TEXT::Execute(), GRID_HELPER::GetGrid(), GRID_HELPER::GetOrigin(), KIGFX::WX_VIEW_CONTROLS::GetRawCursorPosition(), GRID_HELPER::GetVisibleGrid(), ROUTER_TOOL::handleCommonEvents(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), PCB_VIEWER_TOOLS::MeasureTool(), PNS_PCBNEW_DEBUG_DECORATOR::nextDepth(), COMMON_TOOLS::OnGridChanged(), COMMON_TOOLS::PanControl(), DIALOG_PAD_PROPERTIES::prepareCanvas(), SCH_BASE_FRAME::RefreshZoomDependentItems(), KIGFX::WX_VIEW_CONTROLS::SetCrossHairCursorPosition(), PNS_PCBNEW_DEBUG_DECORATOR::SetView(), KIGFX::VIEW_CONTROLS::ShowCursor(), DIALOG_ERC::testErc(), PNS::TOOL_BASE::updateEndItem(), PNS::TOOL_BASE::updateStartItem(), DS_PROXY_VIEW_ITEM::ViewDraw(), KIGFX::PREVIEW::SIMPLE_OVERLAY_ITEM::ViewDraw(), EDIT_POINTS::ViewDraw(), RATSNEST_VIEW_ITEM::ViewDraw(), ROUTER_PREVIEW_ITEM::ViewDraw(), MY_DRAWING::ViewDraw(), KIGFX::PREVIEW::ARC_ASSISTANT::ViewDraw(), KIGFX::PREVIEW::RULER_ITEM::ViewDraw(), KIGFX::PREVIEW::SELECTION_AREA::ViewDraw(), KIGFX::PREVIEW::TWO_POINT_ASSISTANT::ViewDraw(), KIGFX::ORIGIN_VIEWITEM::ViewDraw(), KIGFX::VIEW_GROUP::ViewDraw(), KIGFX::VIEW_OVERLAY::ViewDraw(), and KIGFX::WX_VIEW_CONTROLS::WarpMouseCursor().

GetLayerOrder()

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

inherited

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

{
 return m_layers.at( aLayer ).renderingOrder;
}

References KIGFX::VIEW::m_layers.

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

GetPainter()

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

inlineinherited

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

Returns

Pointer to the currently used Painter instance.

Definition at line 213 of file view.h.

 {
 return m_painter;
 }

References KIGFX::VIEW::m_painter.

Referenced by PCB_BASE_FRAME::ActivateGalCanvas(), GERBVIEW_FRAME::ApplyDisplaySettingsToGAL(), EDITOR_CONDITIONS::bboxesFunc(), DS_PROXY_VIEW_ITEM::buildDrawList(), DIALOG_NET_INSPECTOR::buildNetsList(), GERBVIEW_CONTROL::ClearAllLayers(), BOARD_INSPECTION_TOOL::ClearHighlight(), SCH_BASE_FRAME::CommonSettingsChanged(), PCB_BASE_FRAME::CommonSettingsChanged(), PL_EDITOR_FRAME::CommonSettingsChanged(), PCB_EDIT_FRAME::CommonSettingsChanged(), PCB_GRID_HELPER::computeAnchors(), SYMBOL_PREVIEW_WIDGET::DisplayPart(), PNS_KICAD_IFACE::DisplayRatline(), SYMBOL_PREVIEW_WIDGET::DisplaySymbol(), BOARD_INSPECTION_TOOL::doHideRatsnestNet(), KIGFX::PREVIEW::POLYGON_ITEM::drawPreviewShape(), KIGFX::PREVIEW::DrawTextNextToCursor(), PAD_TOOL::EditPad(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), FOOTPRINT_PREVIEW_PANEL::GetBackgroundColor(), FOOTPRINT_PREVIEW_PANEL::GetForegroundColor(), ROUTER_PREVIEW_ITEM::getLayerColor(), GERBVIEW_CONTROL::HighlightControl(), BOARD_INSPECTION_TOOL::HighlightNet(), BOARD_INSPECTION_TOOL::highlightNet(), PNS::TOOL_BASE::highlightNets(), ROUTER_TOOL::Init(), DRAWING_TOOL::Init(), PCB_SELECTION_TOOL::Init(), PNS_KICAD_IFACE::IsItemVisible(), PCB_EDIT_FRAME::LoadProjectSettings(), PCB_BASE_FRAME::LoadSettings(), DIALOG_PAD_PROPERTIES::onChangePadMode(), ZONE_CREATE_HELPER::OnFirstPoint(), GERBER_LAYER_WIDGET::OnLayerColorChange(), GERBER_LAYER_WIDGET::OnLayerSelect(), APPEARANCE_CONTROLS::onNetclassColorChanged(), APPEARANCE_CONTROLS::onNetclassContextMenu(), DIALOG_NET_INSPECTOR::onSelChanged(), GERBVIEW_FRAME::OnSelectActiveDCode(), GERBVIEW_FRAME::OnSelectActiveLayer(), PCB_DRAW_PANEL_GAL::OnShow(), DIALOG_NET_INSPECTOR::onSortingChanged(), PCB_GRID_HELPER::PCB_GRID_HELPER(), DIALOG_PAD_PROPERTIES::prepareCanvas(), PCB_GRID_HELPER::queryVisible(), NET_GRID_TABLE::Rebuild(), APPEARANCE_CONTROLS::rebuildNets(), DIALOG_PAD_PROPERTIES::redraw(), FOOTPRINT_PREVIEW_PANEL::renderFootprint(), EE_SELECTION_TOOL::Reset(), GERBVIEW_SELECTION_TOOL::Reset(), PCB_SELECTION_TOOL::Reset(), PCB_EDIT_FRAME::SaveProjectSettings(), SCH_EDIT_FRAME::SCH_EDIT_FRAME(), PCB_SELECTION_TOOL::Selectable(), NETS_SEARCH_HANDLER::SelectItems(), PCB_BASE_FRAME::SetBoard(), EDA_DRAW_PANEL_GAL::SetHighContrastLayer(), GERBVIEW_DRAW_PANEL_GAL::SetHighContrastLayer(), PCB_DRAW_PANEL_GAL::SetHighContrastLayer(), PCB_EDIT_FRAME::setupUIConditions(), PCBNEW_PRINTOUT::setupViewLayers(), SYMBOL_PREVIEW_WIDGET::SYMBOL_PREVIEW_WIDGET(), COMMON_TOOLS::ToggleBoundingBoxes(), PCB_DRAW_PANEL_GAL::UpdateColors(), UpdateDisplayOptions(), NET_GRID_TABLE::updateNetColor(), PANEL_EESCHEMA_COLOR_SETTINGS::updatePreview(), PANEL_PCBNEW_COLOR_SETTINGS::updatePreview(), DS_PROXY_VIEW_ITEM::ViewDraw(), EDIT_POINTS::ViewDraw(), RATSNEST_VIEW_ITEM::ViewDraw(), KIGFX::PREVIEW::RULER_ITEM::ViewDraw(), KIGFX::PREVIEW::SELECTION_AREA::ViewDraw(), KIGFX::VIEW_GROUP::ViewDraw(), FP_TEXTBOX::ViewGetLOD(), PAD::ViewGetLOD(), PCB_SHAPE::ViewGetLOD(), PCB_TEXT::ViewGetLOD(), PCB_TEXTBOX::ViewGetLOD(), PCB_TRACK::ViewGetLOD(), and PCB_VIA::ViewGetLOD().

GetScale()

double KIGFX::VIEW::GetScale ( ) const

inlineinherited

Returns

Current scale factor of this VIEW.

Definition at line 269 of file view.h.

 {
 return m_scale;
 }

References KIGFX::VIEW::m_scale.

Referenced by SCH_NAVIGATE_TOOL::changeSheet(), PCB_GRID_HELPER::computeAnchors(), COMMON_TOOLS::doZoomFit(), PCB_SELECTION_TOOL::FindItem(), PNS_KICAD_IFACE::IsItemVisible(), KIGFX::WX_VIEW_CONTROLS::onMotion(), SCH_EDIT_FRAME::OnPageSettingsChange(), KIGFX::WX_VIEW_CONTROLS::onWheel(), EE_GRID_HELPER::queryVisible(), PCB_GRID_HELPER::queryVisible(), PCB_EDIT_FRAME::redrawNetnames(), SCH_EDITOR_CONTROL::Revert(), DISPLAY_FOOTPRINTS_FRAME::SaveSettings(), FOOTPRINT_VIEWER_FRAME::SaveSettings(), ZOOM_TOOL::selectRegion(), NL_SCHEMATIC_PLUGIN_IMPL::SetViewExtents(), NL_PCBNEW_PLUGIN_IMPL::SetViewExtents(), KIGFX::VIEW::SetViewport(), PCB_SELECTION_TOOL::ZoomFitCrossProbeBBox(), PANEL_EESCHEMA_COLOR_SETTINGS::zoomFitPreview(), PANEL_PCBNEW_COLOR_SETTINGS::zoomFitPreview(), and PCB_SELECTION_TOOL::zoomFitSelection().

GetScreenPixelSize()

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

inherited

Return the size of the our rendering area in pixels.

Returns

viewport screen size.

Definition at line 1166 of file view.cpp.

{
 return m_gal->GetScreenPixelSize();
}

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

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

GetTopLayer()

int KIGFX::VIEW::GetTopLayer ( ) const

virtualinherited

Definition at line 816 of file view.cpp.

{
 if( m_topLayers.size() == 0 )
 return 0;
 
 return *m_topLayers.begin();
}

References KIGFX::VIEW::m_topLayers.

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

GetViewport()

BOX2D KIGFX::VIEW::GetViewport ( ) const

inherited

Return the current viewport visible area rectangle.

Returns

Current viewport rectangle.

Definition at line 511 of file view.cpp.

{
 BOX2D rect;
 VECTOR2D screenSize = m_gal->GetScreenPixelSize();
 
 rect.SetOrigin( ToWorld( VECTOR2D( 0, 0 ) ) );
 rect.SetEnd( ToWorld( screenSize ) );
 
 return rect.Normalize();
}

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

Referenced by drawBacksideTicks(), drawTicksAlongLine(), PCB_SELECTION_TOOL::FindItem(), PCB_BASE_FRAME::FocusOnItems(), EDA_DRAW_FRAME::FocusOnLocation(), NL_SCHEMATIC_PLUGIN_IMPL::GetViewExtents(), NL_PCBNEW_PLUGIN_IMPL::GetViewExtents(), PCB_SELECTION_TOOL::hitTestDistance(), APPEARANCE_CONTROLS::onViewportChanged(), NL_SCHEMATIC_PLUGIN_IMPL::SetViewExtents(), NL_PCBNEW_PLUGIN_IMPL::SetViewExtents(), KIGFX::WX_VIEW_CONTROLS::UpdateScrollbars(), PCB_TRACK::ViewGetLOD(), and EE_SELECTION_TOOL::ZoomFitCrossProbeBBox().

HasItem()

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

inherited

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

Definition at line 1577 of file view.cpp.

{
 const VIEW_ITEM_DATA* viewData = aItem->viewPrivData();
 
 return viewData && viewData->m_view == this;
}

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

Referenced by PCB_BASE_FRAME::HideSolderMask(), and PCB_BASE_FRAME::ShowSolderMask().

Hide()

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

inherited

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

for overlaying).

Parameters

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

Definition at line 1550 of file view.cpp.

{
 VIEW_ITEM_DATA* viewData = aItem->viewPrivData();
 
 if( !viewData )
 return;
 
 if( !( viewData->m_flags & VISIBLE ) )
 return;
 
 if( aHide )
 viewData->m_flags |= HIDDEN;
 else
 viewData->m_flags &= ~HIDDEN;
 
 Update( aItem, APPEARANCE );
}

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

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

InitPreview()

void KIGFX::VIEW::InitPreview ( )

inherited

Definition at line 1628 of file view.cpp.

{
 m_preview.reset( new KIGFX::VIEW_GROUP() );
 Add( m_preview.get() );
}

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

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

invalidateItem()

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

protectedinherited

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. Update colors that are used for an item to be drawn

Definition at line 1202 of file view.cpp.

{
 if( aUpdateFlags & INITIAL_ADD )
 {
 // Don't update layers or bbox, since it was done in VIEW::Add()
 // Now that we have initialized, set flags to ALL for the code below
 aUpdateFlags = ALL;
 }
 else
 {
 // updateLayers updates geometry too, so we do not have to update both of them at the
 // same time
 if( aUpdateFlags & LAYERS )
 updateLayers( aItem );
 else if( aUpdateFlags & GEOMETRY )
 updateBbox( aItem );
 }
 
 int layers[VIEW_MAX_LAYERS], layers_count;
 aItem->ViewGetLayers( layers, layers_count );
 
 // Iterate through layers used by the item and recache it immediately
 for( int i = 0; i < layers_count; ++i )
 {
 int layerId = layers[i];
 
 if( IsCached( layerId ) )
 {
 if( aUpdateFlags & ( GEOMETRY | LAYERS | REPAINT ) )
 updateItemGeometry( aItem, layerId );
 else if( aUpdateFlags & COLOR )
 updateItemColor( aItem, layerId );
 }
 
 // Mark those layers as dirty, so the VIEW will be refreshed
 MarkTargetDirty( m_layers[layerId].target );
 }
 
 aItem->viewPrivData()->clearUpdateFlags();
}

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

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

IsCached()

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

inlineinherited

Return true if the layer is cached.

Definition at line 624 of file view.h.

 {
 wxCHECK( aLayer < (int) m_layers.size(), false );
 
 try
 {
 return m_layers.at( aLayer ).target == TARGET_CACHED;
 }
 catch( const std::out_of_range& )
 {
 return false;
 }
 }

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

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

IsDirty()

bool KIGFX::VIEW::IsDirty ( ) const

inlineinherited

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

 {
 for( int i = 0; i < TARGETS_NUMBER; ++i )
 {
 if( IsTargetDirty( i ) )
 return true;
 }
 
 return false;
 }

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

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

IsDynamic()

bool KIGFX::VIEW::IsDynamic ( ) const

inlineinherited

Tell if the VIEW is dynamic (ie.

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

Definition at line 579 of file view.h.

 {
 return m_dynamic;
 }

References KIGFX::VIEW::m_dynamic.

IsLayerVisible()

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

inlineinherited

Return information about visibility of a particular layer.

Parameters

aLayer

true if the layer is visible, false otherwise.

Definition at line 410 of file view.h.

 {
 wxCHECK( aLayer >= 0, false);
 wxCHECK( aLayer < (int) m_layers.size(), false );
 
 return m_layers.at( aLayer ).visible;
 }

References KIGFX::VIEW::m_layers.

Referenced by DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawShape(), DRAWING_TOOL::DrawZone(), GERBVIEW_DRAW_PANEL_GAL::GetDefaultViewBBox(), PCB_DRAW_PANEL_GAL::GetDefaultViewBBox(), APPEARANCE_CONTROLS::getVisibleLayers(), GERBVIEW_FRAME::GetVisibleLayers(), APPEARANCE_CONTROLS::getVisibleObjects(), SCH_EDIT_TOOL::Init(), EDIT_TOOL::Init(), PNS_KICAD_IFACE::IsAnyLayerVisible(), DRAWING_TOOL::PlaceText(), EDIT_TOOL::Properties(), GERBER_LAYER_WIDGET::ReFill(), PCB_SELECTION_TOOL::Selectable(), GERBVIEW_FRAME::SetElementVisibility(), GERBVIEW_FRAME::UpdateXORLayers(), RATSNEST_VIEW_ITEM::ViewDraw(), KIGFX::VIEW_GROUP::ViewDraw(), PCB_GROUP::ViewGetLOD(), FOOTPRINT::ViewGetLOD(), FP_SHAPE::ViewGetLOD(), FP_TEXT::ViewGetLOD(), FP_TEXTBOX::ViewGetLOD(), PAD::ViewGetLOD(), PCB_BITMAP::ViewGetLOD(), PCB_SHAPE::ViewGetLOD(), PCB_TEXT::ViewGetLOD(), PCB_TEXTBOX::ViewGetLOD(), PCB_TRACK::ViewGetLOD(), PCB_VIA::ViewGetLOD(), ZONE::ViewGetLOD(), and FP_ZONE::ViewGetLOD().

IsMirroredX()

bool KIGFX::VIEW::IsMirroredX ( ) const

inlineinherited

Return true if view is flipped across the X axis.

Definition at line 243 of file view.h.

 {
 return m_mirrorX;
 }

References KIGFX::VIEW::m_mirrorX.

Referenced by APPEARANCE_CONTROLS::APPEARANCE_CONTROLS(), COMMON_TOOLS::CursorControl(), drawTicksAlongLine(), NL_SCHEMATIC_PLUGIN_IMPL::GetCameraMatrix(), NL_PCBNEW_PLUGIN_IMPL::GetCameraMatrix(), KIGFX::WX_VIEW_CONTROLS::onScroll(), EE_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::selectMultiple(), FOOTPRINT_EDIT_FRAME::setupUIConditions(), PCB_EDIT_FRAME::setupUIConditions(), APPEARANCE_CONTROLS::UpdateDisplayOptions(), KIGFX::WX_VIEW_CONTROLS::UpdateScrollbars(), and KIGFX::PREVIEW::SELECTION_AREA::ViewDraw().

IsMirroredY()

bool KIGFX::VIEW::IsMirroredY ( ) const

inlineinherited

Return true if view is flipped across the Y axis.

Definition at line 251 of file view.h.

 {
 return m_mirrorY;
 }

References KIGFX::VIEW::m_mirrorY.

Referenced by NL_SCHEMATIC_PLUGIN_IMPL::GetCameraMatrix(), and NL_PCBNEW_PLUGIN_IMPL::GetCameraMatrix().

IsTargetDirty()

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

inlineinherited

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

 {
 wxCHECK( aTarget < TARGETS_NUMBER, false );
 return m_dirtyTargets[aTarget];
 }

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

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

IsUsingDrawPriority()

bool KIGFX::VIEW::IsUsingDrawPriority ( ) const

inlineinherited

Returns

true if draw priority is being respected while redrawing.

Definition at line 687 of file view.h.

 {
 return m_useDrawPriority;
 }

References KIGFX::VIEW::m_useDrawPriority.

IsVisible()

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

inherited

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

{
 const VIEW_ITEM_DATA* viewData = aItem->viewPrivData();
 
 return viewData && ( viewData->m_flags & VISIBLE );
}

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

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

MakeOverlay()

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

inherited

Definition at line 1604 of file view.cpp.

{
 std::shared_ptr<VIEW_OVERLAY> overlay = std::make_shared<VIEW_OVERLAY>();
 
 Add( overlay.get() );
 return overlay;
}

References KIGFX::VIEW::Add(), and overlay.

Referenced by AUTOPLACE_TOOL::autoplace().

MarkClean()

void KIGFX::VIEW::MarkClean ( )

inlineinherited

Force redraw of view on the next rendering.

Definition at line 650 of file view.h.

 {
 for( int i = 0; i < TARGETS_NUMBER; ++i )
 m_dirtyTargets[i] = false;
 }

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

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

MarkDirty()

void KIGFX::VIEW::MarkDirty ( )

inlineinherited

Force redraw of view on the next rendering.

Definition at line 641 of file view.h.

 {
 for( int i = 0; i < TARGETS_NUMBER; ++i )
 m_dirtyTargets[i] = true;
 }

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

Referenced by KIGFX::VIEW::ClearTargets(), EDA_DRAW_PANEL_GAL::DoRePaint(), BOARD_EDITOR_CONTROL::DoSetDrillOrigin(), PCB_CONTROL::DoSetGridOrigin(), EDA_DRAW_FRAME::OnMove(), SCH_EDITOR_CONTROL::PageSetup(), refreshCallback(), KIGFX::VIEW::SetCenter(), KIGFX::VIEW::SetGAL(), KIGFX::VIEW::SetMirror(), KIGFX::VIEW::SetScale(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), KIGFX::VIEW::sortLayers(), KIGFX::VIEW::UpdateAllLayersColor(), KIGFX::VIEW::UpdateAllLayersOrder(), GERBVIEW_FRAME::UpdateXORLayers(), and KIGFX::VIEW::VIEW().

markTargetClean()

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

inlineprotectedinherited

Definition at line 754 of file view.h.

 {
 wxCHECK( aTarget < TARGETS_NUMBER, /* void */ );
 m_dirtyTargets[aTarget] = false;
 }

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

MarkTargetDirty()

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

inlineinherited

Set or clear target 'dirty' flag.

Parameters

aTarget

is the target to set.

Definition at line 617 of file view.h.

 {
 wxCHECK( aTarget < TARGETS_NUMBER, /* void */ );
 m_dirtyTargets[aTarget] = true;
 }

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

Referenced by KIGFX::VIEW::Add(), GERBVIEW_FRAME::ApplyDisplaySettingsToGAL(), DRC_INTERACTIVE_COURTYARD_CLEARANCE::ClearConflicts(), SCH_BASE_FRAME::CommonSettingsChanged(), GERBVIEW_FRAME::CommonSettingsChanged(), FOOTPRINT_EDIT_FRAME::CommonSettingsChanged(), PCB_EDIT_FRAME::CommonSettingsChanged(), PCB_SELECTION_TOOL::highlight(), KIGFX::VIEW::invalidateItem(), BOARD_INSPECTION_TOOL::LocalRatsnestTool(), COMMON_TOOLS::OnGridChanged(), APPEARANCE_CONTROLS::onObjectVisibilityChanged(), GERBER_LAYER_WIDGET::OnRenderEnable(), EDA_DRAW_PANEL_GAL::onSize(), KIGFX::VIEW::Remove(), EDA_DRAW_FRAME::SetGridVisibility(), KIGFX::VIEW::SetLayerDiff(), KIGFX::VIEW::SetLayerHasNegatives(), KIGFX::VIEW::SetLayerVisible(), PCB_SELECTION_TOOL::unhighlight(), KIGFX::VIEW::updateBbox(), DRC_INTERACTIVE_COURTYARD_CLEARANCE::UpdateConflicts(), KIGFX::VIEW::UpdateItems(), KIGFX::VIEW::UpdateLayerColor(), and KIGFX::VIEW::updateLayers().

OnDestroy()

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

staticinherited

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

{
 VIEW_ITEM_DATA* data = aItem->viewPrivData();
 
 if( !data )
 return;
 
 if( data->m_view )
 data->m_view->VIEW::Remove( aItem );
 
 delete data;
 aItem->ClearViewPrivData();
}

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

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

Query()

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

virtualinherited

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

Parameters

aRect	area to search for items
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 425 of file view.cpp.

{
 if( m_orderedLayers.empty() )
 return 0;
 
 std::vector<VIEW_LAYER*>::const_reverse_iterator i;
 
 // execute queries in reverse direction, so that items that are on the top of
 // the rendering stack are returned first.
 for( i = m_orderedLayers.rbegin(); i != m_orderedLayers.rend(); ++i )
 {
 // ignore layers that do not contain actual items (i.e. the selection box, menus, floats)
 if( ( *i )->displayOnly || !( *i )->visible )
 continue;
 
 QUERY_VISITOR<std::vector<LAYER_ITEM_PAIR> > visitor( aResult, ( *i )->id );
 ( *i )->items->Query( aRect, visitor );
 }
 
 return aResult.size();
}

References KIGFX::VIEW::m_orderedLayers.

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

RecacheAllItems()

void KIGFX::VIEW::RecacheAllItems ( )

inherited

Rebuild GAL display lists.

Definition at line 1384 of file view.cpp.

{
 BOX2I r;
 
 r.SetMaximum();
 
 for( const VIEW_LAYER& l : m_layers )
 {
 if( IsCached( l.id ) )
 {
 RECACHE_ITEM_VISITOR visitor( this, m_gal, l.id );
 l.items->Query( r, visitor );
 }
 }
}

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

Referenced by GERBVIEW_FRAME::ActivateGalCanvas(), PCB_BASE_FRAME::ActivateGalCanvas(), SCH_BASE_FRAME::CommonSettingsChanged(), PCB_CONTROL::FlipPcbView(), PCB_EDIT_FRAME::ImportSpecctraSession(), SCH_EDIT_TOOL::Mirror(), GERBVIEW_DRAW_PANEL_GAL::OnShow(), SYMBOL_EDITOR_DRAWING_TOOLS::PlaceAnchor(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImage(), SCH_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Rotate(), PCB_BASE_EDIT_FRAME::ShowBitmapPropertiesDialog(), and GERBVIEW_FRAME::UpdateXORLayers().

Redraw()

void KIGFX::VIEW::Redraw ( )

virtualinherited

Immediately redraws the whole view.

Definition at line 1133 of file view.cpp.

{
#ifdef KICAD_GAL_PROFILE
 PROF_TIMER totalRealTime;
#endif /* KICAD_GAL_PROFILE */
 
 VECTOR2D screenSize = m_gal->GetScreenPixelSize();
 BOX2D rect( ToWorld( VECTOR2D( 0, 0 ) ),
 ToWorld( screenSize ) - ToWorld( VECTOR2D( 0, 0 ) ) );
 
 rect.Normalize();
 BOX2I recti( rect.GetPosition(), rect.GetSize() );
 
 // The view rtree uses integer positions. Large screens can overflow this size so in
 // this case, simply set the rectangle to the full rtree.
 if( rect.GetWidth() > std::numeric_limits<int>::max()
 || rect.GetHeight() > std::numeric_limits<int>::max() )
 {
 recti.SetMaximum();
 }
 
 redrawRect( recti );
 
 // All targets were redrawn, so nothing is dirty
 MarkClean();
 
#ifdef KICAD_GAL_PROFILE
 totalRealTime.Stop();
 wxLogTrace( traceGalProfile, wxS( "VIEW::Redraw(): %.1f ms" ), totalRealTime.msecs() );
#endif /* KICAD_GAL_PROFILE */
}

References BOX2< Vec >::GetHeight(), BOX2< Vec >::GetPosition(), KIGFX::GAL::GetScreenPixelSize(), BOX2< Vec >::GetSize(), BOX2< Vec >::GetWidth(), KIGFX::VIEW::m_gal, KIGFX::VIEW::MarkClean(), PROF_TIMER::msecs(), BOX2< Vec >::Normalize(), KIGFX::VIEW::redrawRect(), BOX2< Vec >::SetMaximum(), PROF_TIMER::Stop(), KIGFX::VIEW::ToWorld(), and traceGalProfile.

Referenced by EDA_DRAW_PANEL_GAL::DoRePaint().

redrawRect()

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

protectedinherited

• Redraws contents within rect aRect

Definition at line 982 of file view.cpp.

{
 for( VIEW_LAYER* l : m_orderedLayers )
 {
 if( l->visible && IsTargetDirty( l->target ) && areRequiredLayersEnabled( l->id ) )
 {
 DRAW_ITEM_VISITOR drawFunc( this, l->id, m_useDrawPriority, m_reverseDrawOrder );
 
 m_gal->SetTarget( l->target );
 m_gal->SetLayerDepth( l->renderingOrder );
 
 // Differential layer also work for the negatives, since both special layer types
 // will composite on separate layers (at least in Cairo)
 if( l->diffLayer )
 m_gal->StartDiffLayer();
 else if( l->hasNegatives )
 m_gal->StartNegativesLayer();
 
 
 l->items->Query( aRect, drawFunc );
 
 if( m_useDrawPriority )
 drawFunc.deferredDraw();
 
 if( l->diffLayer )
 m_gal->EndDiffLayer();
 else if( l->hasNegatives )
 m_gal->EndNegativesLayer();
 }
 }
}

References KIGFX::VIEW::areRequiredLayersEnabled(), KIGFX::VIEW::DRAW_ITEM_VISITOR::deferredDraw(), KIGFX::GAL::EndDiffLayer(), KIGFX::GAL::EndNegativesLayer(), KIGFX::VIEW::IsTargetDirty(), KIGFX::VIEW::m_gal, KIGFX::VIEW::m_orderedLayers, KIGFX::VIEW::m_reverseDrawOrder, KIGFX::VIEW::m_useDrawPriority, KIGFX::GAL::SetLayerDepth(), KIGFX::GAL::SetTarget(), KIGFX::GAL::StartDiffLayer(), and KIGFX::GAL::StartNegativesLayer().

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

Remove()

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

overridevirtual

Remove a VIEW_ITEM from the view.

Parameters

aItem

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

Reimplemented from KIGFX::VIEW.

Definition at line 75 of file pcb_view.cpp.

{
 BOARD_ITEM* boardItem = dynamic_cast<BOARD_ITEM*>( aItem );
 
 if( boardItem && boardItem->Type() == PCB_FOOTPRINT_T )
 {
 FOOTPRINT* footprint = static_cast<FOOTPRINT*>( boardItem );
 footprint->RunOnChildren( [this]( BOARD_ITEM* aChild )
 {
 VIEW::Remove( aChild );
 } );
 }
 
 VIEW::Remove( aItem );
}

References PCB_FOOTPRINT_T, KIGFX::VIEW::Remove(), FOOTPRINT::RunOnChildren(), and EDA_ITEM::Type().

Referenced by PCB_TOOL_BASE::doInteractiveItemPlacement(), MICROWAVE_TOOL::drawMicrowaveInductor(), PCB_BASE_FRAME::HideSolderMask(), PCB_EDIT_FRAME::ImportSpecctraSession(), PCB_VIEWER_TOOLS::MeasureTool(), DIALOG_DRC::OnDRCItemRClick(), FOOTPRINT_PREVIEW_PANEL::renderFootprint(), PCB_SELECTION_TOOL::Reset(), PCB_EDIT_FRAME::ResolveDRCExclusions(), PCB_SELECTION_TOOL::selectMultiple(), PCB_BASE_FRAME::ShowSolderMask(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataFromWindow(), and FOOTPRINT_PREVIEW_PANEL::~FOOTPRINT_PREVIEW_PANEL().

ReorderLayerData()

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

inherited

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

{
 std::vector<VIEW_LAYER> new_map;
 new_map.reserve( m_layers.size() );
 
 for( const VIEW_LAYER& layer : m_layers )
 new_map.push_back( layer );
 
 for( auto& pair : aReorderMap )
 {
 new_map[pair.second] = m_layers[pair.first];
 new_map[pair.second].id = pair.second;
 }
 
 m_layers = new_map;
 
 for( VIEW_ITEM* item : *m_allItems )
 {
 VIEW_ITEM_DATA* viewData = item->viewPrivData();
 
 if( !viewData )
 continue;
 
 int layers[VIEW::VIEW_MAX_LAYERS], layers_count;
 
 item->ViewGetLayers( layers, layers_count );
 viewData->saveLayers( layers, layers_count );
 
 viewData->reorderGroups( aReorderMap );
 
 viewData->m_requiredUpdate |= COLOR;
 }
 
 UpdateItems();
}

References KIGFX::COLOR, KIGFX::VIEW::m_allItems, KIGFX::VIEW::m_layers, KIGFX::VIEW_ITEM_DATA::m_requiredUpdate, KIGFX::VIEW_ITEM_DATA::reorderGroups(), KIGFX::VIEW_ITEM_DATA::saveLayers(), KIGFX::VIEW::UpdateItems(), and KIGFX::VIEW::VIEW_MAX_LAYERS.

Referenced by GERBVIEW_FRAME::RemapLayers().

ReverseDrawOrder()

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

inlineinherited

Only takes effect if UseDrawPriority is true.

Parameters

aFlag

is true if draw order should be reversed

Definition at line 705 of file view.h.

 {
 m_reverseDrawOrder = aFlag;
 }

References KIGFX::VIEW::m_reverseDrawOrder.

Referenced by EDA_DRAW_PANEL_GAL::SwitchBackend().

SetBoundary() [1/2]

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

inlineinherited

Set limits for view area.

Parameters

aBoundary

is the box that limits view area.

Definition at line 279 of file view.h.

 {
 m_boundary = aBoundary;
 }

References KIGFX::VIEW::m_boundary.

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

SetBoundary() [2/2]

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

inlineinherited

Set limits for view area.

Parameters

aBoundary

is the box that limits view area.

Definition at line 289 of file view.h.

 {
 m_boundary.SetOrigin( aBoundary.GetOrigin() );
 m_boundary.SetEnd( aBoundary.GetEnd() );
 }

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

SetCenter() [1/2]

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

inherited

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

{
 m_center = aCenter;
 
 if( !m_boundary.Contains( aCenter ) )
 {
 if( m_center.x < m_boundary.GetLeft() )
 m_center.x = m_boundary.GetLeft();
 else if( aCenter.x > m_boundary.GetRight() )
 m_center.x = m_boundary.GetRight();
 
 if( m_center.y < m_boundary.GetTop() )
 m_center.y = m_boundary.GetTop();
 else if( m_center.y > m_boundary.GetBottom() )
 m_center.y = m_boundary.GetBottom();
 }
 
 m_gal->SetLookAtPoint( m_center );
 m_gal->ComputeWorldScreenMatrix();
 
 // Redraw everything after the viewport has changed
 MarkDirty();
}

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

Referenced by COMMON_TOOLS::CenterContents(), KIGFX::WX_VIEW_CONTROLS::CenterOnCursor(), COMMON_TOOLS::doZoomFit(), SYMBOL_PREVIEW_WIDGET::fitOnDrawArea(), EDA_DRAW_FRAME::FocusOnLocation(), KIGFX::WX_VIEW_CONTROLS::onMotion(), KIGFX::WX_VIEW_CONTROLS::onScroll(), EDA_DRAW_PANEL_GAL::onSize(), KIGFX::WX_VIEW_CONTROLS::onTimer(), KIGFX::WX_VIEW_CONTROLS::onWheel(), SYMBOL_EDITOR_DRAWING_TOOLS::PlaceAnchor(), SCH_BASE_FRAME::RedrawScreen(), ZOOM_TOOL::selectRegion(), NL_SCHEMATIC_PLUGIN_IMPL::SetCameraMatrix(), NL_PCBNEW_PLUGIN_IMPL::SetCameraMatrix(), KIGFX::VIEW::SetCenter(), KIGFX::WX_VIEW_CONTROLS::SetCrossHairCursorPosition(), KIGFX::VIEW::SetGAL(), KIGFX::VIEW::SetScale(), KIGFX::VIEW::SetViewport(), KIGFX::WX_VIEW_CONTROLS::WarpMouseCursor(), PANEL_EESCHEMA_COLOR_SETTINGS::zoomFitPreview(), PANEL_PCBNEW_COLOR_SETTINGS::zoomFitPreview(), and PCB_SELECTION_TOOL::zoomFitSelection().

SetCenter() [2/2]

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

inherited

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

{
 if( obscuringScreenRects.empty() )
 return SetCenter( aCenter );
 
 BOX2D screenRect( { 0, 0 }, m_gal->GetScreenPixelSize() );
 SHAPE_POLY_SET unobscuredPoly( screenRect );
 VECTOR2D unobscuredCenter = screenRect.Centre();
 
 for( const BOX2D& obscuringScreenRect : obscuringScreenRects )
 {
 SHAPE_POLY_SET obscuringPoly( obscuringScreenRect );
 unobscuredPoly.BooleanSubtract( obscuringPoly, SHAPE_POLY_SET::PM_FAST );
 }
 
 /*
 * Perform a step-wise deflate to find the center of the largest unobscured area
 */
 
 BOX2I bbox = unobscuredPoly.BBox();
 int step = std::min( bbox.GetWidth(), bbox.GetHeight() ) / 10;
 
 while( !unobscuredPoly.IsEmpty() )
 {
 unobscuredCenter = unobscuredPoly.BBox().Centre();
 unobscuredPoly.Deflate( step, 4 );
 }
 
 SetCenter( aCenter - ToWorld( unobscuredCenter - screenRect.Centre(), false ) );
}

References SHAPE_POLY_SET::BBox(), SHAPE_POLY_SET::BooleanSubtract(), BOX2< Vec >::Centre(), SHAPE_POLY_SET::Deflate(), BOX2< Vec >::GetHeight(), KIGFX::GAL::GetScreenPixelSize(), BOX2< Vec >::GetWidth(), SHAPE_POLY_SET::IsEmpty(), KIGFX::VIEW::m_gal, SHAPE_POLY_SET::PM_FAST, KIGFX::VIEW::SetCenter(), and KIGFX::VIEW::ToWorld().

SetGAL()

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

inherited

Assign a rendering device for the VIEW.

Parameters

aGal	pointer to the GAL output device.

Definition at line 492 of file view.cpp.

{
 bool recacheGroups = ( m_gal != nullptr ); // recache groups only if GAL is reassigned
 m_gal = aGal;
 
 // clear group numbers, so everything is going to be recached
 if( recacheGroups )
 clearGroupCache();
 
 // every target has to be refreshed
 MarkDirty();
 
 // force the new GAL to display the current viewport.
 SetCenter( m_center );
 SetScale( m_scale );
 SetMirror( m_mirrorX, m_mirrorY );
}

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

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

SetLayerDiff()

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

inlineinherited

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

 {
 wxCHECK( aLayer < (int) m_layers.size(), /*void*/ );
 
 if( m_layers[aLayer].diffLayer != aDiff )
 {
 // Target has to be redrawn after changing its layers' diff status
 MarkTargetDirty( m_layers[aLayer].target );
 m_layers[aLayer].diffLayer = aDiff;
 }
 }

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

Referenced by GERBVIEW_FRAME::UpdateXORLayers().

SetLayerDisplayOnly()

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

inlineinherited

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

Definition at line 457 of file view.h.

 {
 wxCHECK( aLayer < (int) m_layers.size(), /*void*/ );
 m_layers[aLayer].displayOnly = aDisplayOnly;
 }

References KIGFX::VIEW::m_layers.

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

SetLayerHasNegatives()

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

inlineinherited

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

 {
 wxCHECK( aLayer < (int) m_layers.size(), /*void*/ );
 
 if( m_layers[aLayer].hasNegatives != aNegatives )
 {
 // Target has to be redrawn after changing a layers' negatives
 MarkTargetDirty( m_layers[aLayer].target );
 m_layers[aLayer].hasNegatives = aNegatives;
 }
 }

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

Referenced by GERBVIEW_FRAME::unarchiveFiles().

SetLayerOrder()

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

inherited

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

{
 m_layers[aLayer].renderingOrder = aRenderingOrder;
 
 sortLayers();
}

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

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

SetLayerTarget()

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

inlineinherited

Change the rendering target for a particular layer.

Parameters

aLayer	is the layer.
aTarget	is the rendering target.

Definition at line 469 of file view.h.

 {
 wxCHECK( aLayer < (int) m_layers.size(), /*void*/ );
 m_layers[aLayer].target = aTarget;
 }

References KIGFX::VIEW::m_layers.

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

SetLayerVisible()

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

inlineinherited

Control the visibility of a particular layer.

Parameters

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

Definition at line 393 of file view.h.

 {
 wxCHECK( aLayer < (int) m_layers.size(), /*void*/ );
 
 if( m_layers[aLayer].visible != aVisible )
 {
 // Target has to be redrawn after changing its visibility
 MarkTargetDirty( m_layers[aLayer].target );
 m_layers[aLayer].visible = aVisible;
 }
 }

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

Referenced by SCH_EDIT_FRAME::CommonSettingsChanged(), APPEARANCE_CONTROLS::onLayerVisibilityToggled(), APPEARANCE_CONTROLS::onObjectVisibilityChanged(), GERBER_LAYER_WIDGET::OnRenderEnable(), PL_EDITOR_FRAME::OnSelectPage(), PL_DRAW_PANEL_GAL::PL_DRAW_PANEL_GAL(), PCB_EDIT_FRAME::SetElementVisibility(), GERBVIEW_FRAME::SetElementVisibility(), APPEARANCE_CONTROLS::SetLayerVisible(), APPEARANCE_CONTROLS::SetObjectVisible(), BOARD_PRINTOUT::setupViewLayers(), GERBVIEW_PRINTOUT::setupViewLayers(), PCBNEW_PRINTOUT::setupViewLayers(), GERBVIEW_FRAME::SetVisibleLayers(), APPEARANCE_CONTROLS::setVisibleLayers(), APPEARANCE_CONTROLS::setVisibleObjects(), SCH_EDIT_FRAME::ShowAllIntersheetRefs(), PCB_DRAW_PANEL_GAL::SyncLayersVisibility(), SCH_EDITOR_CONTROL::ToggleERCErrors(), SCH_EDITOR_CONTROL::ToggleERCExclusions(), SCH_EDITOR_CONTROL::ToggleERCWarnings(), and PCB_EDIT_FRAME::UpdateUserInterface().

SetMirror()

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

inherited

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

{
 wxASSERT_MSG( !aMirrorY, _( "Mirroring for Y axis is not supported yet" ) );
 
 m_mirrorX = aMirrorX;
 m_mirrorY = aMirrorY;
 m_gal->SetFlip( aMirrorX, aMirrorY );
 
 // Redraw everything
 MarkDirty();
}

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

Referenced by GERBVIEW_CONTROL::DisplayControl(), PCB_CONTROL::FlipPcbView(), SCH_DRAW_PANEL::SCH_DRAW_PANEL(), SCH_PREVIEW_PANEL::SCH_PREVIEW_PANEL(), and KIGFX::VIEW::SetGAL().

SetPainter()

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

inlineinherited

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

Definition at line 203 of file view.h.

 {
 m_painter = aPainter;
 }

References KIGFX::VIEW::m_painter.

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

SetRequired()

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

inherited

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

{
 wxCHECK( (unsigned) aLayerId < m_layers.size(), /*void*/ );
 wxCHECK( (unsigned) aRequiredId < m_layers.size(), /*void*/ );
 
 if( aRequired )
 m_layers[aLayerId].requiredLayers.insert( aRequiredId );
 else
 m_layers[aLayerId].requiredLayers.erase( aRequired );
}

References KIGFX::VIEW::m_layers.

Referenced by PCB_DRAW_PANEL_GAL::setDefaultLayerDeps().

SetScale()

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

virtualinherited

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

{
 if( aAnchor == VECTOR2D( 0, 0 ) )
 aAnchor = m_center;
 
 VECTOR2D a = ToScreen( aAnchor );
 
 if( aScale < m_minScale )
 m_scale = m_minScale;
 else if( aScale > m_maxScale )
 m_scale = m_maxScale;
 else
 m_scale = aScale;
 
 m_gal->SetZoomFactor( m_scale );
 m_gal->ComputeWorldScreenMatrix();
 
 VECTOR2D delta = ToWorld( a ) - aAnchor;
 
 SetCenter( m_center - delta );
 
 // Redraw everything after the viewport has changed
 MarkDirty();
}

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

Referenced by COMMON_TOOLS::doZoomFit(), COMMON_TOOLS::doZoomToPreset(), PCB_SELECTION_TOOL::FindItem(), SYMBOL_PREVIEW_WIDGET::fitOnDrawArea(), KIGFX::WX_VIEW_CONTROLS::onMotion(), KIGFX::WX_VIEW_CONTROLS::onWheel(), FOOTPRINT_PREVIEW_PANEL::renderFootprint(), ZOOM_TOOL::selectRegion(), KIGFX::VIEW::SetGAL(), KIGFX::SCH_VIEW::SetScale(), NL_PCBNEW_PLUGIN_IMPL::SetViewExtents(), KIGFX::VIEW::SetViewport(), EE_SELECTION_TOOL::ZoomFitCrossProbeBBox(), PCB_SELECTION_TOOL::ZoomFitCrossProbeBBox(), PANEL_EESCHEMA_COLOR_SETTINGS::zoomFitPreview(), PANEL_PCBNEW_COLOR_SETTINGS::zoomFitPreview(), and PCB_SELECTION_TOOL::zoomFitSelection().

SetScaleLimits()

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

inlineinherited

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

 {
 wxASSERT_MSG( aMaximum > aMinimum, wxT( "I guess you passed parameters in wrong order" ) );
 
 m_minScale = aMinimum;
 m_maxScale = aMaximum;
 }

References KIGFX::VIEW::m_maxScale, and KIGFX::VIEW::m_minScale.

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

SetTopLayer()

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

virtualinherited

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

{
 if( aEnabled )
 {
 if( m_topLayers.count( aLayer ) == 1 )
 return;
 
 m_topLayers.insert( aLayer );
 
 // Move the layer closer to front
 if( m_enableOrderModifier )
 m_layers[aLayer].renderingOrder += TOP_LAYER_MODIFIER;
 }
 else
 {
 if( m_topLayers.count( aLayer ) == 0 )
 return;
 
 m_topLayers.erase( aLayer );
 
 // Restore the previous rendering order
 if( m_enableOrderModifier )
 m_layers[aLayer].renderingOrder -= TOP_LAYER_MODIFIER;
 }
}

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

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

SetViewport()

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

inherited

Set the visible area of the VIEW.

Parameters

aViewport

desired visible area, in world space coordinates.

Definition at line 523 of file view.cpp.

{
 VECTOR2D ssize = ToWorld( m_gal->GetScreenPixelSize(), false );
 
 wxCHECK( ssize.x > 0 && ssize.y > 0, /*void*/ );
 
 VECTOR2D centre = aViewport.Centre();
 VECTOR2D vsize = aViewport.GetSize();
 double zoom = 1.0 / std::max( fabs( vsize.x / ssize.x ), fabs( vsize.y / ssize.y ) );
 
 SetCenter( centre );
 SetScale( GetScale() * zoom );
}

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

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

SetVisible()

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

inherited

Set the item visibility.

Parameters

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

Definition at line 1529 of file view.cpp.

{
 VIEW_ITEM_DATA* viewData = aItem->viewPrivData();
 
 if( !viewData )
 return;
 
 bool cur_visible = viewData->m_flags & VISIBLE;
 
 if( cur_visible != aIsVisible )
 {
 if( aIsVisible )
 viewData->m_flags |= VISIBLE;
 else
 viewData->m_flags &= ~VISIBLE;
 
 Update( aItem, APPEARANCE | COLOR );
 }
}

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

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

ShowPreview()

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

inherited

Definition at line 1649 of file view.cpp.

{
 SetVisible( m_preview.get(), aShow );
}

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

Referenced by SCH_EDIT_FRAME::AddJunction(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SCH_LINE_WIRE_BUS_TOOL::finishSegments(), ROUTER_TOOL::InlineDrag(), DRAWING_TOOL::InteractivePlaceWithPreview(), and DRAWING_TOOL::PlaceImage().

sortLayers()

void KIGFX::VIEW::sortLayers ( )

protectedinherited

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

Definition at line 1244 of file view.cpp.

{
 int n = 0;
 
 m_orderedLayers.resize( m_layers.size() );
 
 for( VIEW_LAYER& layer : m_layers )
 m_orderedLayers[n++] = &layer;
 
 sort( m_orderedLayers.begin(), m_orderedLayers.end(), compareRenderingOrder );
 
 MarkDirty();
}

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

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

SortLayers()

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

inherited

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.
aCount	stores the number of layers.

Definition at line 648 of file view.cpp.

{
 int maxLay, maxOrd, maxIdx;
 
 for( int i = 0; i < aCount; ++i )
 {
 maxLay = aLayers[i];
 maxOrd = GetLayerOrder( maxLay );
 maxIdx = i;
 
 // Look for the max element in the range (j..aCount)
 for( int j = i; j < aCount; ++j )
 {
 if( maxOrd < GetLayerOrder( aLayers[j] ) )
 {
 maxLay = aLayers[j];
 maxOrd = GetLayerOrder( maxLay );
 maxIdx = j;
 }
 }
 
 // Swap elements
 aLayers[maxIdx] = aLayers[i];
 aLayers[i] = maxLay;
 }
}

References KIGFX::VIEW::GetLayerOrder().

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

ToScreen() [1/2]

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

inherited

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

{
 const MATRIX3x3D& matrix = m_gal->GetWorldScreenMatrix();
 
 if( aAbsolute )
 return VECTOR2D( matrix * aCoord );
 else
 return VECTOR2D( matrix.GetScale().x * aCoord.x, matrix.GetScale().y * aCoord.y );
}

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

Referenced by KIGFX::WX_VIEW_CONTROLS::handleAutoPanning(), ROUTER_TOOL::handleLayerSwitch(), KIGFX::WX_VIEW_CONTROLS::SetCrossHairCursorPosition(), KIGFX::VIEW::SetScale(), and KIGFX::WX_VIEW_CONTROLS::WarpMouseCursor().

ToScreen() [2/2]

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

inherited

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

{
 const MATRIX3x3D& matrix = m_gal->GetWorldScreenMatrix();
 
 return matrix.GetScale().x * aSize;
}

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

ToWorld() [1/2]

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

inherited

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

{
 const MATRIX3x3D& matrix = m_gal->GetScreenWorldMatrix();
 
 if( aAbsolute )
 return VECTOR2D( matrix * aCoord );
 else
 return VECTOR2D( matrix.GetScale().x * aCoord.x, matrix.GetScale().y * aCoord.y );
}

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

Referenced by EE_POINT_EDITOR::addCornerCondition(), COMMON_TOOLS::CenterContents(), COMMON_TOOLS::doZoomFit(), KIGFX::PREVIEW::POLYGON_ITEM::drawPreviewShape(), EDIT_POINTS::FindPoint(), SYMBOL_PREVIEW_WIDGET::fitOnDrawArea(), PCB_BASE_FRAME::FocusOnItems(), GENERAL_COLLECTORS_GUIDE::GENERAL_COLLECTORS_GUIDE(), KIGFX::WX_VIEW_CONTROLS::GetMousePosition(), KIGFX::VIEW::GetViewport(), DS_PROXY_VIEW_ITEM::HitTestDrawingSheetItems(), KIGFX::WX_VIEW_CONTROLS::onMotion(), KIGFX::WX_VIEW_CONTROLS::onScroll(), EDA_DRAW_PANEL_GAL::onSize(), KIGFX::WX_VIEW_CONTROLS::onTimer(), KIGFX::WX_VIEW_CONTROLS::onWheel(), KIGFX::WX_VIEW_CONTROLS::PinCursorInsideNonAutoscrollArea(), KIGFX::VIEW::Redraw(), KIGFX::WX_VIEW_CONTROLS::refreshMouse(), EE_SELECTION_TOOL::selectionContains(), PL_SELECTION_TOOL::selectionContains(), ZOOM_TOOL::selectRegion(), KIGFX::VIEW::SetCenter(), KIGFX::VIEW::SetScale(), KIGFX::VIEW::SetViewport(), EDIT_POINTS::ViewDraw(), KIGFX::ORIGIN_VIEWITEM::ViewDraw(), PCB_SELECTION_TOOL::ZoomFitCrossProbeBBox(), PANEL_EESCHEMA_COLOR_SETTINGS::zoomFitPreview(), PANEL_PCBNEW_COLOR_SETTINGS::zoomFitPreview(), and PCB_SELECTION_TOOL::zoomFitSelection().

ToWorld() [2/2]

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

inherited

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

{
 const MATRIX3x3D& matrix = m_gal->GetScreenWorldMatrix();
 
 return fabs( matrix.GetScale().x * aSize );
}

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

Update() [1/2]

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

overridevirtual

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 from KIGFX::VIEW.

Definition at line 119 of file pcb_view.cpp.

{
 PCB_VIEW::Update( aItem, KIGFX::ALL );
}

References KIGFX::ALL, and Update().

Update() [2/2]

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

overridevirtual

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 from KIGFX::VIEW.

Definition at line 92 of file pcb_view.cpp.

{
 const BOARD_ITEM* boardItem = dynamic_cast<const BOARD_ITEM*>( aItem );
 
 if( boardItem && boardItem->Type() == PCB_FOOTPRINT_T )
 {
 const FOOTPRINT* footprint = static_cast<const FOOTPRINT*>( boardItem );
 footprint->RunOnChildren(
 [this, aUpdateFlags]( BOARD_ITEM* child )
 {
 VIEW::Update( child, aUpdateFlags );
 } );
 }
 else if( boardItem && boardItem->Type() == PCB_GROUP_T )
 {
 const PCB_GROUP* group = static_cast<const PCB_GROUP*>( boardItem );
 group->RunOnChildren(
 [this, aUpdateFlags]( BOARD_ITEM* child )
 {
 Update( child, aUpdateFlags );
 } );
 }
 
 VIEW::Update( aItem, aUpdateFlags );
}

References group, PCB_FOOTPRINT_T, PCB_GROUP_T, FOOTPRINT::RunOnChildren(), EDA_ITEM::Type(), KIGFX::VIEW::Update(), and Update().

Referenced by PCB_SELECTION_TOOL::ClearSelection(), PCB_TOOL_BASE::doInteractiveItemPlacement(), MICROWAVE_TOOL::drawMicrowaveInductor(), PCB_EDIT_FRAME::Edit_Zone_Params(), PCB_SELECTION_TOOL::EnterGroup(), DIALOG_DRC::ExcludeMarker(), PCB_SELECTION_TOOL::ExitGroup(), PCB_BASE_FRAME::FocusOnItems(), PCB_VIEWER_TOOLS::GraphicOutlines(), PCB_SELECTION_TOOL::highlight(), PCB_VIEWER_TOOLS::MeasureTool(), DIALOG_DRC::OnDRCItemRClick(), PCB_VIEWER_TOOLS::PadDisplayMode(), DIALOG_BOARD_REANNOTATE::ReannotateBoard(), refreshCallback(), FOOTPRINT_PREVIEW_PANEL::renderFootprint(), FOOTPRINT_EDITOR_CONTROL::Save(), FOOTPRINT_EDITOR_CONTROL::SaveAs(), PCB_SELECTION_TOOL::selectMultiple(), PCB_VIEWER_TOOLS::ShowPadNumbers(), GLOBAL_EDIT_TOOL::swapBoardItem(), GLOBAL_EDIT_TOOL::SwapLayers(), PCB_VIEWER_TOOLS::TextOutlines(), PCB_CONTROL::TrackDisplayMode(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataFromWindow(), PCB_SELECTION_TOOL::unhighlight(), Update(), PCB_POINT_EDITOR::updateItem(), PCB_CONTROL::ViaDisplayMode(), and PCB_CONTROL::ZoneDisplayMode().

UpdateAllItems()

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

inherited

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

Parameters

aUpdateFlags

is is according to KIGFX::VIEW_UPDATE_FLAGS

Definition at line 1484 of file view.cpp.

{
 for( VIEW_ITEM* item : *m_allItems )
 {
 if( item->viewPrivData() )
 item->viewPrivData()->m_requiredUpdate |= aUpdateFlags;
 }
}

References KIGFX::VIEW::m_allItems.

Referenced by SCH_BASE_FRAME::CommonSettingsChanged(), SYMBOL_EDIT_FRAME::CommonSettingsChanged(), GERBVIEW_FRAME::CommonSettingsChanged(), PCB_BASE_FRAME::CommonSettingsChanged(), PL_EDITOR_FRAME::CommonSettingsChanged(), GERBVIEW_CONTROL::DisplayControl(), SCH_BASE_FRAME::HardRedraw(), GERBVIEW_CONTROL::HighlightControl(), SCH_EDIT_FRAME::KiwayMailIn(), PCB_EDIT_FRAME::onBoardLoaded(), GERBER_LAYER_WIDGET::OnLayerSelect(), DIALOG_NET_INSPECTOR::onRenameNet(), GERBVIEW_FRAME::OnSelectActiveDCode(), GERBVIEW_FRAME::OnSelectActiveLayer(), SCH_EDITOR_CONTROL::PageSetup(), SYMBOL_EDIT_FRAME::RebuildView(), SYMBOL_EDIT_FRAME::ShowChangedLanguage(), SYMBOL_EDITOR_CONTROL::ShowElectricalTypes(), SYMBOL_EDITOR_CONTROL::ShowPinNumbers(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), SCH_BASE_FRAME::SyncView(), COMMON_TOOLS::ToggleBoundingBoxes(), SCH_EDITOR_CONTROL::ToggleHiddenFields(), SCH_EDITOR_CONTROL::ToggleHiddenPins(), 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  )

inherited

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

{
 for( VIEW_ITEM* item : *m_allItems )
 {
 if( aCondition( item ) )
 {
 if( item->viewPrivData() )
 item->viewPrivData()->m_requiredUpdate |= aUpdateFlags;
 }
 }
}

References KIGFX::VIEW::m_allItems.

Referenced by PCB_BASE_FRAME::CommonSettingsChanged(), GERBVIEW_CONTROL::DisplayControl(), PAD_TOOL::EditPad(), DIALOG_NET_INSPECTOR::onDeleteNet(), PCB_EDIT_FRAME::OnNetlistChanged(), BOARD_EDITOR_CONTROL::PageSettings(), SCH_EDIT_FRAME::RecalculateConnections(), ZONE_FILLER_TOOL::refresh(), PCB_EDIT_FRAME::SetActiveLayer(), PCB_BASE_FRAME::SetDisplayOptions(), GERBVIEW_FRAME::SetElementVisibility(), APPEARANCE_CONTROLS::setVisibleLayers(), and PCB_EDIT_FRAME::ShowBoardSetupDialog().

UpdateAllItemsConditionally() [2/2]

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

inherited

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

{
 for( VIEW_ITEM* item : *m_allItems )
 {
 if( item->viewPrivData() )
 item->viewPrivData()->m_requiredUpdate |= aItemFlagsProvider( item );
 }
}

References KIGFX::VIEW::m_allItems.

UpdateAllLayersColor()

void KIGFX::VIEW::UpdateAllLayersColor ( )

inherited

Apply the new coloring scheme to all layers.

The used scheme is held by #RENDER_SETTINGS.

See also

RENDER_SETTINGS

Definition at line 761 of file view.cpp.

{
 if( m_gal->IsVisible() )
 {
 GAL_UPDATE_CONTEXT ctx( m_gal );
 
 for( VIEW_ITEM* item : *m_allItems )
 {
 VIEW_ITEM_DATA* viewData = item->viewPrivData();
 
 if( !viewData )
 continue;
 
 int layers[VIEW::VIEW_MAX_LAYERS], layers_count;
 viewData->getLayers( layers, layers_count );
 
 for( int i = 0; i < layers_count; ++i )
 {
 const COLOR4D color = m_painter->GetSettings()->GetColor( item, layers[i] );
 int group = viewData->getGroup( layers[i] );
 
 if( group >= 0 )
 m_gal->ChangeGroupColor( group, color );
 }
 }
 }
 
 MarkDirty();
}

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

Referenced by DIALOG_NET_INSPECTOR::buildNetsList(), BOARD_INSPECTION_TOOL::ClearHighlight(), FOOTPRINT_EDIT_FRAME::CommonSettingsChanged(), PCB_SELECTION_TOOL::doSyncSelection(), KIGFX::VIEW::EnableTopLayer(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), BOARD_INSPECTION_TOOL::HighlightNet(), BOARD_INSPECTION_TOOL::highlightNet(), PNS::TOOL_BASE::highlightNets(), APPEARANCE_CONTROLS::onNetclassColorChanged(), APPEARANCE_CONTROLS::onNetclassContextMenu(), APPEARANCE_CONTROLS::onNetColorMode(), DIALOG_NET_INSPECTOR::onSelChanged(), DIALOG_NET_INSPECTOR::onSortingChanged(), NETS_SEARCH_HANDLER::SelectItems(), EDA_DRAW_PANEL_GAL::SetHighContrastLayer(), GERBVIEW_DRAW_PANEL_GAL::SetHighContrastLayer(), PCB_DRAW_PANEL_GAL::SetHighContrastLayer(), and NET_GRID_TABLE::updateNetColor().

UpdateAllLayersOrder()

void KIGFX::VIEW::UpdateAllLayersOrder ( )

inherited

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

{
 sortLayers();
 
 if( m_gal->IsVisible() )
 {
 GAL_UPDATE_CONTEXT ctx( m_gal );
 
 for( VIEW_ITEM* item : *m_allItems )
 {
 VIEW_ITEM_DATA* viewData = item->viewPrivData();
 
 if( !viewData )
 continue;
 
 int layers[VIEW::VIEW_MAX_LAYERS], layers_count;
 viewData->getLayers( layers, layers_count );
 
 for( int i = 0; i < layers_count; ++i )
 {
 int group = viewData->getGroup( layers[i] );
 
 if( group >= 0 )
 m_gal->ChangeGroupDepth( group, m_layers[layers[i]].renderingOrder );
 }
 }
 }
 
 MarkDirty();
}

References KIGFX::GAL::ChangeGroupDepth(), KIGFX::VIEW_ITEM_DATA::getGroup(), KIGFX::VIEW_ITEM_DATA::getLayers(), group, KIGFX::GAL::IsVisible(), KIGFX::VIEW::m_allItems, KIGFX::VIEW::m_gal, KIGFX::VIEW::m_layers, KIGFX::VIEW::MarkDirty(), KIGFX::VIEW::sortLayers(), and KIGFX::VIEW::VIEW_MAX_LAYERS.

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

updateBbox()

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

protectedinherited

Update set of layers that an item occupies.

Definition at line 1308 of file view.cpp.

{
 int layers[VIEW_MAX_LAYERS], layers_count;
 
 aItem->ViewGetLayers( layers, layers_count );
 
 for( int i = 0; i < layers_count; ++i )
 {
 VIEW_LAYER& l = m_layers[layers[i]];
 l.items->Remove( aItem );
 l.items->Insert( aItem );
 MarkTargetDirty( l.target );
 }
}

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

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

UpdateDisplayOptions()

void KIGFX::PCB_VIEW::UpdateDisplayOptions

(

const PCB_DISPLAY_OPTIONS &

aOptions

)

Definition at line 125 of file pcb_view.cpp.

{
 auto painter = static_cast<KIGFX::PCB_PAINTER*>( GetPainter() );
 auto settings = static_cast<KIGFX::PCB_RENDER_SETTINGS*>( painter->GetSettings() );
 
 settings->LoadDisplayOptions( aOptions );
}

References KIGFX::VIEW::GetPainter(), and KIGFX::PCB_RENDER_SETTINGS::LoadDisplayOptions().

Referenced by PCB_DRAW_PANEL_GAL::PCB_DRAW_PANEL_GAL(), and PCB_BASE_FRAME::SetDisplayOptions().

updateItemColor()

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

protectedinherited

Update all information needed to draw an item.

Definition at line 1259 of file view.cpp.

{
 VIEW_ITEM_DATA* viewData = aItem->viewPrivData();
 wxCHECK( (unsigned) aLayer < m_layers.size(), /*void*/ );
 wxCHECK( IsCached( aLayer ), /*void*/ );
 
 if( !viewData )
 return;
 
 // Obtain the color that should be used for coloring the item on the specific layerId
 const COLOR4D color = m_painter->GetSettings()->GetColor( aItem, aLayer );
 int group = viewData->getGroup( aLayer );
 
 // Change the color, only if it has group assigned
 if( group >= 0 )
 m_gal->ChangeGroupColor( group, color );
}

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

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

updateItemGeometry()

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

protectedinherited

Update bounding box of an item.

Definition at line 1278 of file view.cpp.

{
 VIEW_ITEM_DATA* viewData = aItem->viewPrivData();
 wxCHECK( (unsigned) aLayer < m_layers.size(), /*void*/ );
 wxCHECK( IsCached( aLayer ), /*void*/ );
 
 if( !viewData )
 return;
 
 VIEW_LAYER& l = m_layers.at( aLayer );
 
 m_gal->SetTarget( l.target );
 m_gal->SetLayerDepth( l.renderingOrder );
 
 // Redraw the item from scratch
 int group = viewData->getGroup( aLayer );
 
 if( group >= 0 )
 m_gal->DeleteGroup( group );
 
 group = m_gal->BeginGroup();
 viewData->setGroup( aLayer, group );
 
 if( !m_painter->Draw( static_cast<EDA_ITEM*>( aItem ), aLayer ) )
 aItem->ViewDraw( aLayer, this ); // Alternative drawing method
 
 m_gal->EndGroup();
}

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

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

UpdateItems()

void KIGFX::VIEW::UpdateItems ( )

inherited

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

Definition at line 1401 of file view.cpp.

{
 if( !m_gal->IsVisible() )
 return;
 
 unsigned int cntGeomUpdate = 0;
 bool anyUpdated = false;
 
 for( VIEW_ITEM* item : *m_allItems )
 {
 auto vpd = item->viewPrivData();
 
 if( !vpd )
 continue;
 
 if( vpd->m_requiredUpdate != NONE )
 {
 anyUpdated = true;
 
 if( vpd->m_requiredUpdate & ( GEOMETRY | LAYERS ) )
 {
 cntGeomUpdate++;
 }
 }
 }
 
 unsigned int cntTotal = m_allItems->size();
 
 double ratio = (double) cntGeomUpdate / (double) cntTotal;
 
 // Optimization to improve view update time. If a lot of items (say, 30%) have their
 // bboxes/geometry changed it's way faster (around 10 times) to rebuild the R-Trees
 // from scratch rather than update the bbox of each changed item. Pcbnew does multiple
 // full geometry updates during file load, this can save a solid 30 seconds on load time
 // for larger designs...
 
 if( ratio > 0.3 )
 {
 auto allItems = *m_allItems;
 int layers[VIEW_MAX_LAYERS], layers_count;
 
 // kill all Rtrees
 for( VIEW_LAYER& layer : m_layers )
 layer.items->RemoveAll();
 
 // and re-insert items from scratch
 for( VIEW_ITEM* item : allItems )
 {
 item->ViewGetLayers( layers, layers_count );
 item->viewPrivData()->saveLayers( layers, layers_count );
 
 for( int i = 0; i < layers_count; ++i )
 {
 wxCHECK2_MSG( layers[i] >= 0 && static_cast<unsigned>( layers[i] ) < m_layers.size(),
 continue, wxS( "Invalid layer" ) );
 VIEW_LAYER& l = m_layers[layers[i]];
 l.items->Insert( item );
 MarkTargetDirty( l.target );
 }
 
 item->viewPrivData()->m_requiredUpdate &= ~( LAYERS | GEOMETRY );
 }
 }
 
 if( anyUpdated )
 {
 GAL_UPDATE_CONTEXT ctx( m_gal );
 
 for( VIEW_ITEM* item : *m_allItems.get() )
 {
 if( item->viewPrivData() && item->viewPrivData()->m_requiredUpdate != NONE )
 {
 invalidateItem( item, item->viewPrivData()->m_requiredUpdate );
 item->viewPrivData()->m_requiredUpdate = NONE;
 }
 }
 }
 
 KI_TRACE( traceGalProfile, wxS( "View update: total items %u, geom %u anyUpdated %u\n" ), cntTotal,
 cntGeomUpdate, (unsigned) anyUpdated );
}

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

Referenced by EDA_DRAW_PANEL_GAL::DoRePaint(), SELECTION_TOOL::doSelectionMenu(), SCH_DRAW_PANEL::OnShow(), PCB_DRAW_PANEL_GAL::OnShow(), KIGFX::VIEW::ReorderLayerData(), and SCH_FIND_REPLACE_TOOL::UpdateFind().

UpdateLayerColor()

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

inherited

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

{
 // There is no point in updating non-cached layers
 if( !IsCached( aLayer ) )
 return;
 
 BOX2I r;
 
 r.SetMaximum();
 
 if( m_gal->IsVisible() )
 {
 GAL_UPDATE_CONTEXT ctx( m_gal );
 
 UPDATE_COLOR_VISITOR visitor( aLayer, m_painter, m_gal );
 m_layers[aLayer].items->Query( r, visitor );
 MarkTargetDirty( m_layers[aLayer].target );
 }
}

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

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

updateLayers()

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

protectedinherited

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

Definition at line 1324 of file view.cpp.

{
 VIEW_ITEM_DATA* viewData = aItem->viewPrivData();
 int layers[VIEW_MAX_LAYERS], layers_count;
 
 if( !viewData )
 return;
 
 // Remove the item from previous layer set
 viewData->getLayers( layers, layers_count );
 
 for( int i = 0; i < layers_count; ++i )
 {
 VIEW_LAYER& l = m_layers[layers[i]];
 l.items->Remove( aItem );
 MarkTargetDirty( l.target );
 
 if( IsCached( l.id ) )
 {
 // Redraw the item from scratch
 int prevGroup = viewData->getGroup( layers[i] );
 
 if( prevGroup >= 0 )
 {
 m_gal->DeleteGroup( prevGroup );
 viewData->setGroup( l.id, -1 );
 }
 }
 }
 
 // Add the item to new layer set
 aItem->ViewGetLayers( layers, layers_count );
 viewData->saveLayers( layers, layers_count );
 
 for( int i = 0; i < layers_count; i++ )
 {
 VIEW_LAYER& l = m_layers[layers[i]];
 l.items->Insert( aItem );
 MarkTargetDirty( l.target );
 }
}

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

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

UseDrawPriority()

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

inlineinherited

Parameters

aFlag

is true if draw priority should be respected while redrawing.

Definition at line 695 of file view.h.

 {
 m_useDrawPriority = aFlag;
 }

References KIGFX::VIEW::m_useDrawPriority.

Member Data Documentation

m_allItems

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

protectedinherited

The set of layers that are displayed on the top.

Definition at line 847 of file view.h.

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

m_boundary

BOX2D KIGFX::VIEW::m_boundary

protectedinherited

Definition at line 856 of file view.h.

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

m_center

VECTOR2D KIGFX::VIEW::m_center

protectedinherited

Definition at line 853 of file view.h.

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

m_dirtyTargets

bool KIGFX::VIEW::m_dirtyTargets[TARGETS_NUMBER]

protectedinherited

Flag to respect draw priority when drawing items.

Definition at line 874 of file view.h.

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

m_dynamic

bool KIGFX::VIEW::m_dynamic

protectedinherited

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

Definition at line 871 of file view.h.

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

m_enableOrderModifier

bool KIGFX::VIEW::m_enableOrderModifier

protectedinherited

The set of possible displayed layers and its properties.

Definition at line 838 of file view.h.

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

m_gal

GAL* KIGFX::VIEW::m_gal

protectedinherited

Dynamic VIEW (eg.

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

Definition at line 867 of file view.h.

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

m_layers

std::vector<VIEW_LAYER> KIGFX::VIEW::m_layers

protectedinherited

Sorted list of pointers to members of m_layers.

Definition at line 841 of file view.h.

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

m_maxScale

double KIGFX::VIEW::m_maxScale

protectedinherited

Definition at line 858 of file view.h.

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

m_minScale

double KIGFX::VIEW::m_minScale

protectedinherited

Definition at line 857 of file view.h.

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

m_mirrorX

bool KIGFX::VIEW::m_mirrorX

protectedinherited

Definition at line 860 of file view.h.

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

m_mirrorY

bool KIGFX::VIEW::m_mirrorY

protectedinherited

PAINTER contains information how do draw items.

Definition at line 861 of file view.h.

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

m_nextDrawPriority

int KIGFX::VIEW::m_nextDrawPriority

protectedinherited

Flag to reverse the draw order when using draw priority.

Definition at line 880 of file view.h.

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

m_orderedLayers

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

protectedinherited

Flat list of all items.

Definition at line 844 of file view.h.

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

m_ownedItems

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

protectedinherited

Whether to use rendering order modifier or not.

Definition at line 835 of file view.h.

Referenced by KIGFX::VIEW::AddToPreview(), and KIGFX::VIEW::ClearPreview().

m_painter

PAINTER* KIGFX::VIEW::m_painter

protectedinherited

Interface to #PAINTER that is used to draw items.

Definition at line 864 of file view.h.

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

m_preview

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

protectedinherited

Definition at line 834 of file view.h.

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

m_reverseDrawOrder

bool KIGFX::VIEW::m_reverseDrawOrder

protectedinherited

Definition at line 883 of file view.h.

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

m_scale

double KIGFX::VIEW::m_scale

protectedinherited

Definition at line 855 of file view.h.

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

m_topLayers

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

protectedinherited

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

Definition at line 850 of file view.h.

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

m_useDrawPriority

bool KIGFX::VIEW::m_useDrawPriority

protectedinherited

The next sequential drawing priority.

Definition at line 877 of file view.h.

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

TOP_LAYER_MODIFIER

constexpr int KIGFX::VIEW::TOP_LAYER_MODIFIER = -VIEW_MAX_LAYERS

staticconstexprinherited

Definition at line 730 of file view.h.

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

VIEW_MAX_LAYERS

constexpr int KIGFX::VIEW::VIEW_MAX_LAYERS = 512

staticconstexprinherited

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

Definition at line 727 of file view.h.

Referenced by KIGFX::VIEW::Add(), KIGFX::SCH_PAINTER::draw(), KIGFX::VIEW::draw(), KIGFX::VIEW::invalidateItem(), KIGFX::VIEW::Remove(), KIGFX::VIEW::ReorderLayerData(), KIGFX::VIEW_ITEM_DATA::saveLayers(), SCH_DRAW_PANEL::setDefaultLayerDeps(), SCH_PREVIEW_PANEL::setDefaultLayerDeps(), GERBVIEW_DRAW_PANEL_GAL::setDefaultLayerDeps(), PL_DRAW_PANEL_GAL::setDefaultLayerDeps(), PCB_DRAW_PANEL_GAL::setDefaultLayerDeps(), SCH_DRAW_PANEL::setDefaultLayerOrder(), SCH_PREVIEW_PANEL::setDefaultLayerOrder(), PCB_DRAW_PANEL_GAL::setDefaultLayerOrder(), BOARD_PRINTOUT::setupViewLayers(), KIGFX::VIEW::UpdateAllLayersColor(), KIGFX::VIEW::UpdateAllLayersOrder(), KIGFX::VIEW::updateBbox(), KIGFX::VIEW::UpdateItems(), KIGFX::VIEW::updateLayers(), KIGFX::VIEW::VIEW(), and KIGFX::VIEW_GROUP::ViewDraw().

---

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

• pcb_view.h
• pcb_view.cpp