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

Static Public Member Functions
static void	OnDestroy (VIEW_ITEM *aItem)

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

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

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

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

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

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 68 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 worksheet 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 54 of file pcb_view.cpp.

{
}

Member Function Documentation

Add()

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

overridevirtual

Function Add() Adds 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 59 of file pcb_view.cpp.

{
    auto item = static_cast<BOARD_ITEM*>( aItem );

    if( item->Type() == PCB_FOOTPRINT_T )
    {
        FOOTPRINT* footprint = static_cast<FOOTPRINT*>( item );
        footprint->RunOnChildren( [this]( BOARD_ITEM* aChild )
                                  {
                                      VIEW::Add( aChild );
                                  } );
    }

    VIEW::Add( item, aDrawPriority );
}

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

Referenced by PCB_TOOL_BASE::doInteractiveItemPlacement(), MICROWAVE_TOOL::drawMicrowaveInductor(), PCB_VIEWER_TOOLS::MeasureTool(), POINT_EDITOR::OnSelectionChange(), PCB_EDITOR_CONTROL::PlaceTarget(), FOOTPRINT_PREVIEW_PANEL::renderFootprint(), SELECTION_TOOL::Reset(), DIALOG_FOOTPRINT_CHECKER::runChecks(), SELECTION_TOOL::selectMultiple(), and SELECTION_TOOL::zoomFitSelection().

AddToPreview()

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

inherited

Definition at line 1554 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(), LIB_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), ROUTER_TOOL::InlineDrag(), SCH_DRAWING_TOOLS::PlaceComponent(), SCH_DRAWING_TOOLS::PlaceImage(), SCH_DRAWING_TOOLS::SingleClickPlace(), LIB_DRAWING_TOOLS::TwoClickPlace(), and SCH_DRAWING_TOOLS::TwoClickPlace().

areRequiredLayersEnabled()

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

protectedinherited

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

Definition at line 1359 of file view.cpp.

{
    wxCHECK( (unsigned) aLayerId < m_layers.size(), false );

    std::set<int>::const_iterator it, it_end;

    for( it = m_layers.at( aLayerId ).requiredLayers.begin(),
         it_end = m_layers.at( aLayerId ).requiredLayers.end(); it != it_end; ++it )
    {
        // That is enough if just one layer is not enabled
        if( !m_layers.at( *it ).visible || !areRequiredLayersEnabled( *it ) )
            return false;
    }

    return true;
}

References KIGFX::VIEW::m_layers.

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

Clear()

void KIGFX::VIEW::Clear ( )

inherited

Function Clear() Removes all items from the view.

Definition at line 1089 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(), SCH_DRAW_PANEL::DisplayComponent(), KIGFX::SCH_VIEW::DisplayComponent(), SCH_DRAW_PANEL::DisplaySheet(), PL_DRAW_PANEL_GAL::DisplayWorksheet(), GERBVIEW_FRAME::doCloseWindow(), DISPLAY_FOOTPRINTS_FRAME::InitDisplay(), FOOTPRINT_PREVIEW_PANEL::renderFootprint(), WS_PROXY_UNDO_ITEM::Restore(), PCB_BASE_EDIT_FRAME::SetBoard(), 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 1179 of file view.cpp.

{
    BOX2I r;

    r.SetMaximum();
    clearLayerCache 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 1535 of file view.cpp.

{
   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(), LIB_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), SCH_LINE_WIRE_BUS_TOOL::finishSegments(), ROUTER_TOOL::InlineDrag(), SCH_DRAWING_TOOLS::PlaceComponent(), SCH_DRAWING_TOOLS::PlaceImage(), SCH_DRAWING_TOOLS::SingleClickPlace(), LIB_DRAWING_TOOLS::TwoClickPlace(), and SCH_DRAWING_TOOLS::TwoClickPlace().

ClearTargets()

void KIGFX::VIEW::ClearTargets ( )

inherited

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

Definition at line 1104 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

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

Definition at line 890 of file view.cpp.

{
    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 GERBVIEW_DRAW_PANEL_GAL::SetTopLayer(), PL_DRAW_PANEL_GAL::SetTopLayer(), PCB_DRAW_PANEL_GAL::SetTopLayer(), and EDA_DRAW_PANEL_GAL::SetTopLayer().

compareRenderingOrder()

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

inlinestaticprotectedinherited

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

Definition at line 789 of file view.h.

    {
        return aI->renderingOrder > aJ->renderingOrder;
    }

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

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

CopySettings()

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

inherited

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

Parameters

aOtherView

view from which settings will be copied.

Definition at line 494 of file view.cpp.

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

DataReference()

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

inherited

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

GAL, PAINTER and other properties are left uninitialized.

Definition at line 1449 of file view.cpp.

{
    auto 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_ITEM *  aItem, int  aLayer, bool  aImmediate = false  )

protectedinherited

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

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

Parameters

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

{
    auto 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(), 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::drawItem::deferredDraw(), KIGFX::VIEW::draw(), and KIGFX::VIEW::drawItem::operator()().

draw() [2/3]

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

protectedinherited

Function draw() Draws 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 1033 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_GROUP *  aGroup, bool  aImmediate = false  )

protectedinherited

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

Parameters

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

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

EnableTopLayer()

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

virtualinherited

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

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

Parameters

aEnable

whether to enable or disable display of the top layer.

Definition at line 865 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

Function GetBoundary()

Returns

Current view area boundary.

Definition at line 289 of file view.h.

    {
        return m_boundary;
    }

References KIGFX::VIEW::m_boundary.

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

GetCenter()

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

inlineinherited

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

Returns

center point of the view

Definition at line 330 of file view.h.

    {
        return m_center;
    }

References KIGFX::VIEW::m_center.

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

GetGAL()

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

inlineinherited

Function GetGAL() Returns the GAL this view is using to draw graphical primitives.

Returns

Pointer to the currently used GAL instance.

Definition at line 182 of file view.h.

    {
        return m_gal;
    }

References KIGFX::VIEW::m_gal.

Referenced by EE_GRID_HELPER::Align(), GRID_HELPER::BestDragOrigin(), EE_GRID_HELPER::BestDragOrigin(), KIGFX::WX_VIEW_CONTROLS::CenterOnCursor(), COMMON_TOOLS::CursorControl(), PCBNEW_CONTROL::DoSetGridOrigin(), COMMON_TOOLS::doZoomInOut(), KIGFX::PREVIEW::CENTRELINE_RECT_ITEM::drawPreviewShape(), KIGFX::PREVIEW::POLYGON_ITEM::drawPreviewShape(), KIGFX::PREVIEW::DrawTextNextToCursor(), 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_POLYLINE::Execute(), KIGFX::VIEW_OVERLAY::COMMAND_POLY_POLYLINE::Execute(), KIGFX::VIEW_OVERLAY::COMMAND_POINT_POLYLINE::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(), EE_GRID_HELPER::GetGrid(), GRID_HELPER::GetGrid(), EE_GRID_HELPER::GetOrigin(), GRID_HELPER::GetOrigin(), KIGFX::WX_VIEW_CONTROLS::GetRawCursorPosition(), COMMON_TOOLS::OnGridChanged(), COMMON_TOOLS::PanControl(), DIALOG_PAD_PROPERTIES::prepareCanvas(), KIGFX::WX_VIEW_CONTROLS::SetCrossHairCursorPosition(), KIGFX::VIEW_CONTROLS::ShowCursor(), PNS::TOOL_BASE::updateEndItem(), PNS::TOOL_BASE::updateStartItem(), PCB_BRIGHT_BOX::ViewDraw(), KIGFX::RATSNEST_VIEWITEM::ViewDraw(), KIGFX::PREVIEW::RULER_ITEM::ViewDraw(), KIGFX::PREVIEW::ARC_ASSISTANT::ViewDraw(), BRIGHT_BOX::ViewDraw(), KIGFX::ORIGIN_VIEWITEM::ViewDraw(), KIGFX::PREVIEW::TWO_POINT_ASSISTANT::ViewDraw(), KIGFX::PREVIEW::SIMPLE_OVERLAY_ITEM::ViewDraw(), MY_DRAWING::ViewDraw(), KIGFX::PREVIEW::SELECTION_AREA::ViewDraw(), KIGFX::VIEW_GROUP::ViewDraw(), ROUTER_PREVIEW_ITEM::ViewDraw(), KIGFX::WS_PROXY_VIEW_ITEM::ViewDraw(), EDIT_POINTS::ViewDraw(), and KIGFX::WX_VIEW_CONTROLS::WarpCursor().

GetLayerOrder()

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

inherited

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

Lower values are rendered first.

Parameters

aLayer

the layer

Returns

Rendering order of a particular layer.

Definition at line 653 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

Function GetPainter() Returns the painter object used by the view for drawing VIEW_ITEMS.

Returns

Pointer to the currently used Painter instance.

Definition at line 201 of file view.h.

    {
        return m_painter;
    }

References KIGFX::VIEW::m_painter.

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

GetPrintMode()

int KIGFX::VIEW::GetPrintMode ( )

inlineinherited

Returns

the printing mode. if return <= 0, the current mode is not a printing mode, just the draw mode

Definition at line 685 of file view.h.

{ return m_printMode; }

References KIGFX::VIEW::m_printMode.

Referenced by PAD::ViewGetLOD().

GetScale()

double KIGFX::VIEW::GetScale ( ) const

inlineinherited

Function GetScale()

Returns

Current scale factor of this VIEW.

Definition at line 259 of file view.h.

    {
        return m_scale;
    }

References KIGFX::VIEW::m_scale.

Referenced by GRID_HELPER::computeAnchors(), COMMON_TOOLS::doZoomFit(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), PNS_KICAD_IFACE::IsItemVisible(), KIGFX::WX_VIEW_CONTROLS::onButton(), KIGFX::WX_VIEW_CONTROLS::onWheel(), EE_GRID_HELPER::queryVisible(), GRID_HELPER::queryVisible(), DISPLAY_FOOTPRINTS_FRAME::SaveSettings(), FOOTPRINT_VIEWER_FRAME::SaveSettings(), SELECTION_TOOL::Selectable(), ZOOM_TOOL::selectRegion(), KIGFX::VIEW::SetViewport(), PANEL_PCBNEW_COLOR_SETTINGS::zoomFitPreview(), and SELECTION_TOOL::zoomFitSelection().

GetScreenPixelSize()

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

inherited

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

Returns

viewport screen size

Definition at line 1155 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(), and KIGFX::WX_VIEW_CONTROLS::onWheel().

GetTopLayer()

int KIGFX::VIEW::GetTopLayer ( ) const

virtualinherited

Definition at line 829 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(), SELECTION_TOOL::GuessSelectionCandidates(), PNS::TOOL_BASE::pickSingleItem(), and PNS::TOOL_BASE::updateStartItem().

GetViewport()

BOX2D KIGFX::VIEW::GetViewport ( ) const

inherited

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

Returns

Current viewport rectangle

Definition at line 519 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 SCH_EDITOR_CONTROL::FindComponentAndItem(), EDA_DRAW_FRAME::FocusOnLocation(), SELECTION_TOOL::GuessSelectionCandidates(), and KIGFX::WX_VIEW_CONTROLS::UpdateScrollbars().

Hide()

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

inherited

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

{
    auto 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(), GERBVIEW_SELECTION_TOOL::disambiguationMenu(), SELECTION_TOOL::highlightInternal(), ROUTER_TOOL::InlineDrag(), SCH_MOVE_TOOL::moveItem(), SCH_EDITOR_CONTROL::Paste(), GERBVIEW_SELECTION_TOOL::selectVisually(), SELECTION_TOOL::unhighlightInternal(), and GERBVIEW_SELECTION_TOOL::unselectVisually().

InitPreview()

void KIGFX::VIEW::InitPreview ( )

inherited

Definition at line 1547 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::DisplayComponent(), KIGFX::SCH_VIEW::DisplaySheet(), ROUTER_TOOL::InlineDrag(), and PCB_BASE_EDIT_FRAME::SetBoard().

invalidateItem()

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

protectedinherited

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

Parameters

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

Definition at line 1191 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

Returns true if the layer is cached.

Definition at line 578 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

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

Returns

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

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

IsDrawOrderReversed()

bool KIGFX::VIEW::IsDrawOrderReversed ( ) const

inlineinherited

Function IsDrawOrderReversed()

Returns

true if draw order is reversed

Definition at line 651 of file view.h.

    {
        return m_reverseDrawOrder;
    }

References KIGFX::VIEW::m_reverseDrawOrder.

IsDynamic()

bool KIGFX::VIEW::IsDynamic ( ) const

inlineinherited

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

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

Definition at line 533 of file view.h.

    {
        return m_dynamic;
    }

References KIGFX::VIEW::m_dynamic.

IsLayerVisible()

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

inlineinherited

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

Parameters

aLayer

true if the layer is visible, false otherwise

Definition at line 402 of file view.h.

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

References KIGFX::VIEW::m_layers.

Referenced by GERBVIEW_DRAW_PANEL_GAL::GetDefaultViewBBox(), PCB_DRAW_PANEL_GAL::GetDefaultViewBBox(), GERBVIEW_FRAME::GetVisibleLayers(), APPEARANCE_CONTROLS::getVisibleLayers(), APPEARANCE_CONTROLS::getVisibleObjects(), PNS_KICAD_IFACE::IsAnyLayerVisible(), SCH_EDIT_TOOL::Properties(), EDIT_TOOL::Properties(), GERBER_LAYER_WIDGET::ReFill(), KIGFX::RATSNEST_VIEWITEM::ViewDraw(), KIGFX::VIEW_GROUP::ViewDraw(), FP_SHAPE::ViewGetLOD(), PCB_GROUP::ViewGetLOD(), ZONE::ViewGetLOD(), FP_TEXT::ViewGetLOD(), TRACK::ViewGetLOD(), VIA::ViewGetLOD(), FOOTPRINT::ViewGetLOD(), PAD::ViewGetLOD(), and FP_ZONE::ViewGetLOD().

IsMirroredX()

bool KIGFX::VIEW::IsMirroredX ( ) const

inlineinherited

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

Definition at line 232 of file view.h.

    {
        return m_mirrorX;
    }

References KIGFX::VIEW::m_mirrorX.

Referenced by APPEARANCE_CONTROLS::APPEARANCE_CONTROLS(), COMMON_TOOLS::CursorControl(), KIGFX::WX_VIEW_CONTROLS::onScroll(), EE_SELECTION_TOOL::selectMultiple(), SELECTION_TOOL::selectMultiple(), APPEARANCE_CONTROLS::UpdateDisplayOptions(), KIGFX::WX_VIEW_CONTROLS::UpdateScrollbars(), and KIGFX::PREVIEW::SELECTION_AREA::ViewDraw().

IsMirroredY()

bool KIGFX::VIEW::IsMirroredY ( ) const

inlineinherited

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

Definition at line 241 of file view.h.

    {
        return m_mirrorY;
    }

References KIGFX::VIEW::m_mirrorY.

IsTargetDirty()

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

inlineinherited

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

Returns

True if the above condition is fulfilled.

Definition at line 560 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

Function IsUsingDrawPriority()

Returns

true if draw priority is being respected while redrawing.

Definition at line 633 of file view.h.

    {
        return m_useDrawPriority;
    }

References KIGFX::VIEW::m_useDrawPriority.

IsVisible()

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

inherited

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

{
    const auto viewData = aItem->viewPrivData();

    return viewData && ( viewData->m_flags & VISIBLE );
}

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

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

MakeOverlay()

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

inherited

Definition at line 1526 of file view.cpp.

{
    std::shared_ptr<VIEW_OVERLAY> overlay( new VIEW_OVERLAY );

    Add( overlay.get() );
    return overlay;
}

References KIGFX::VIEW::Add().

Referenced by AUTOPLACE_TOOL::autoplace().

MarkDirty()

void KIGFX::VIEW::MarkDirty ( )

inlineinherited

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

Definition at line 596 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(), PCB_EDITOR_CONTROL::DoSetDrillOrigin(), PCBNEW_CONTROL::DoSetGridOrigin(), EDA_DRAW_FRAME::OnMove(), refreshCallback(), KIGFX::VIEW::SetCenter(), KIGFX::VIEW::SetGAL(), KIGFX::VIEW::SetMirror(), KIGFX::VIEW::SetScale(), KIGFX::VIEW::sortLayers(), PANEL_EESCHEMA_DISPLAY_OPTIONS::TransferDataFromWindow(), PANEL_SETUP_FORMATTING::TransferDataFromWindow(), KIGFX::VIEW::UpdateAllLayersColor(), KIGFX::VIEW::UpdateAllLayersOrder(), and KIGFX::VIEW::VIEW().

MarkForUpdate()

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

inherited

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

Parameters

aItem

is the item to be refreshed.

markTargetClean()

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

inlineprotectedinherited

Definition at line 723 of file view.h.

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

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

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

MarkTargetDirty()

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

inlineinherited

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

Parameters

aTarget

is the target to set.

Definition at line 571 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(), GERBVIEW_SELECTION_TOOL::disambiguationMenu(), SELECTION_TOOL::highlight(), KIGFX::VIEW::invalidateItem(), PCB_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::SetLayerVisible(), PANEL_DISPLAY_OPTIONS::TransferDataFromWindow(), PANEL_GAL_DISPLAY_OPTIONS::TransferDataFromWindow(), PANEL_EDIT_OPTIONS::TransferDataFromWindow(), PANEL_GERBVIEW_DISPLAY_OPTIONS::TransferDataFromWindow(), SELECTION_TOOL::unhighlight(), KIGFX::VIEW::updateBbox(), KIGFX::VIEW::UpdateLayerColor(), and KIGFX::VIEW::updateLayers().

OnDestroy()

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

staticinherited

Definition at line 253 of file view.cpp.

{
    auto 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

Function Query() Finds 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 433 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;

        queryVisitor<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(), GRID_HELPER::queryVisible(), SELECTION_TOOL::SelectAll(), EE_SELECTION_TOOL::SelectAll(), EE_SELECTION_TOOL::selectMultiple(), and SELECTION_TOOL::selectMultiple().

RecacheAllItems()

void KIGFX::VIEW::RecacheAllItems ( )

inherited

Function RecacheAllItems() Rebuilds GAL display lists.

Definition at line 1377 of file view.cpp.

{
    BOX2I r;

    r.SetMaximum();

    for( const VIEW_LAYER& l : m_layers )
    {
        if( IsCached( l.id ) )
        {
            recacheItem 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 PCB_BASE_FRAME::ActivateGalCanvas(), GERBVIEW_FRAME::ActivateGalCanvas(), PCB_EDITOR_CONTROL::FlipPcbView(), SCH_EDIT_TOOL::Mirror(), GERBVIEW_DRAW_PANEL_GAL::OnShow(), LIB_DRAWING_TOOLS::PlaceAnchor(), SCH_DRAWING_TOOLS::PlaceImage(), SCH_EDIT_TOOL::Properties(), SCH_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_TOOL::Rotate(), PANEL_DISPLAY_OPTIONS::TransferDataFromWindow(), PANEL_GAL_DISPLAY_OPTIONS::TransferDataFromWindow(), and PANEL_EDIT_OPTIONS::TransferDataFromWindow().

Redraw()

void KIGFX::VIEW::Redraw ( )

virtualinherited

Function Redraw() Immediately redraws the whole view.

Definition at line 1123 of file view.cpp.

{
#ifdef __WXDEBUG__
    PROF_COUNTER totalRealTime;
#endif /* __WXDEBUG__ */

    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
    markTargetClean( TARGET_CACHED );
    markTargetClean( TARGET_NONCACHED );
    markTargetClean( TARGET_OVERLAY );

#ifdef __WXDEBUG__
    totalRealTime.Stop();
    wxLogTrace( "GAL_PROFILE", "VIEW::Redraw(): %.1f ms", totalRealTime.msecs() );
#endif /* __WXDEBUG__ */
}

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

Referenced by EDA_DRAW_PANEL_GAL::DoRePaint().

redrawRect()

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

protectedinherited

• Redraws contents within rect aRect

Definition at line 988 of file view.cpp.

{
    for( VIEW_LAYER* l : m_orderedLayers )
    {
        if( l->visible && IsTargetDirty( l->target ) && areRequiredLayersEnabled( l->id ) )
        {
            drawItem drawFunc( this, l->id, m_useDrawPriority, m_reverseDrawOrder );

            m_gal->SetTarget( l->target );
            m_gal->SetLayerDepth( l->renderingOrder );
            l->items->Query( aRect, drawFunc );

            if( m_useDrawPriority )
                drawFunc.deferredDraw();
        }
    }
}

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

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

Remove()

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

overridevirtual

Function Remove() Removes 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 76 of file pcb_view.cpp.

{
    auto item = static_cast<BOARD_ITEM*>( aItem );


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

    VIEW::Remove( item );
}

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

Referenced by PCB_TOOL_BASE::doInteractiveItemPlacement(), MICROWAVE_TOOL::drawMicrowaveInductor(), PCB_VIEWER_TOOLS::MeasureTool(), DIALOG_DRC::OnDRCItemRClick(), POINT_EDITOR::OnSelectionChange(), PCB_EDITOR_CONTROL::PlaceTarget(), FOOTPRINT_PREVIEW_PANEL::renderFootprint(), SELECTION_TOOL::Reset(), SELECTION_TOOL::selectMultiple(), and FOOTPRINT_PREVIEW_PANEL::~FOOTPRINT_PREVIEW_PANEL().

ReorderLayerData()

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

inherited

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

{
    std::vector<VIEW_LAYER> new_map;
    new_map.reserve( m_layers.size() );

    for( int ii = 0; ii < VIEW_MAX_LAYERS; ++ii )
        new_map.emplace_back();

    for( const VIEW_LAYER& layer : m_layers )
    {
        int orig_idx = layer.id;
        int new_idx = orig_idx;

        if( aReorderMap.count( orig_idx ) )
            new_idx = aReorderMap.at( orig_idx );

        new_map[new_idx] = layer;
        new_map[new_idx].id = new_idx;
    }

    m_layers = new_map;

    for( VIEW_ITEM* item : *m_allItems )
    {
        auto 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::UpdateItems(), and KIGFX::VIEW::VIEW_MAX_LAYERS.

Referenced by GERBVIEW_FRAME::SortLayersByX2Attributes().

ReverseDrawOrder()

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

inlineinherited

Function ReverseDrawOrder() Only takes effect if UseDrawPriority is true.

Parameters

aFlag

is true if draw order should be reversed

Definition at line 661 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

Function SetBoundary() Sets limits for view area.

Parameters

aBoundary

is the box that limits view area.

Definition at line 269 of file view.h.

    {
        m_boundary = aBoundary;
    }

References KIGFX::VIEW::m_boundary.

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

SetBoundary() [2/2]

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

inlineinherited

Function SetBoundary() Sets limits for view area.

Parameters

aBoundary

is the box that limits view area.

Definition at line 279 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

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

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

Parameters

aCenter

the new center point, in world space coordinates.

Definition at line 585 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(), SCH_BASE_FRAME::CenterScreen(), COMMON_TOOLS::doZoomFit(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), SYMBOL_PREVIEW_WIDGET::fitOnDrawArea(), EDA_DRAW_FRAME::FocusOnLocation(), KIGFX::WX_VIEW_CONTROLS::onMotion(), KIGFX::WX_VIEW_CONTROLS::onScroll(), EDA_DRAW_PANEL_GAL::onSize(), KIGFX::WX_VIEW_CONTROLS::onTimer(), KIGFX::WX_VIEW_CONTROLS::onWheel(), LIB_DRAWING_TOOLS::PlaceAnchor(), SCH_BASE_FRAME::RedrawScreen(), ZOOM_TOOL::selectRegion(), KIGFX::VIEW::SetCenter(), KIGFX::WX_VIEW_CONTROLS::SetCrossHairCursorPosition(), KIGFX::VIEW::SetGAL(), KIGFX::VIEW::SetScale(), KIGFX::VIEW::SetViewport(), KIGFX::WX_VIEW_CONTROLS::WarpCursor(), PANEL_PCBNEW_COLOR_SETTINGS::zoomFitPreview(), and SELECTION_TOOL::zoomFitSelection().

SetCenter() [2/2]

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

inherited

Function SetCenter() Sets the center point of the VIEW, attempting to avoid occultingScreenRect (for instance, the screen rect of a modeless dialog in front of the VIEW).

Parameters

aCenter	the new center point, in world space coordinates.
occultingScreenRect	the occulting rect, in screen space coordinates.

Definition at line 610 of file view.cpp.

{
    BOX2D screenRect( VECTOR2D( 0, 0 ), m_gal->GetScreenPixelSize() );

    if( !screenRect.Intersects( occultingScreenRect ) )
    {
        SetCenter( aCenter );
        return;
    }

    BOX2D  occultedRect  = screenRect.Intersect( occultingScreenRect );
    double topExposed    = occultedRect.GetTop() - screenRect.GetTop();
    double bottomExposed = screenRect.GetBottom() - occultedRect.GetBottom();
    double leftExposed   = occultedRect.GetLeft() - screenRect.GetLeft();
    double rightExposed  = screenRect.GetRight() - occultedRect.GetRight();

    if( std::max( topExposed, bottomExposed ) > std::max( leftExposed, rightExposed ) )
    {
        if( topExposed > bottomExposed )
            aCenter.y += ToWorld( screenRect.GetHeight() / 2 - topExposed / 2 );
        else
            aCenter.y -= ToWorld( screenRect.GetHeight() / 2 - bottomExposed / 2 );
    }
    else
    {
        if( leftExposed > rightExposed )
            aCenter.x += ToWorld( screenRect.GetWidth() / 2 - leftExposed / 2 );
        else
            aCenter.x -= ToWorld( screenRect.GetWidth() / 2 - rightExposed / 2 );
    }

    SetCenter( aCenter );
}

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

SetGAL()

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

inherited

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

Parameters

aGal	pointer to the GAL output device

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

SetLayerDisplayOnly()

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

inlineinherited

Definition at line 408 of file view.h.

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

References KIGFX::VIEW::m_layers.

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

SetLayerOrder()

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

inherited

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

Lower values are rendered first.

Parameters

aLayer	the layer
aRenderingOrder	arbitrary number denoting the rendering order.

Definition at line 645 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

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

Parameters

aLayer	is the layer.
aTarget	is the rendering target.

Definition at line 420 of file view.h.

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

References KIGFX::VIEW::m_layers.

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

SetLayerVisible()

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

inlineinherited

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

Parameters

aLayer	the layer to show/hide.
aVisible	the obvious.

Definition at line 385 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 APPEARANCE_CONTROLS::onLayerVisibilityChanged(), APPEARANCE_CONTROLS::onObjectVisibilityChanged(), GERBER_LAYER_WIDGET::OnRenderEnable(), PL_EDITOR_FRAME::OnSelectPage(), PL_DRAW_PANEL_GAL::PL_DRAW_PANEL_GAL(), GERBVIEW_FRAME::SetElementVisibility(), APPEARANCE_CONTROLS::SetLayerVisible(), APPEARANCE_CONTROLS::SetObjectVisible(), GERBVIEW_PRINTOUT::setupViewLayers(), PCBNEW_PRINTOUT::setupViewLayers(), BOARD_PRINTOUT::setupViewLayers(), GERBVIEW_FRAME::SetVisibleLayers(), APPEARANCE_CONTROLS::setVisibleLayers(), APPEARANCE_CONTROLS::setVisibleObjects(), PCB_DRAW_PANEL_GAL::SyncLayersVisibility(), and PCB_EDIT_FRAME::UpdateUserInterface().

SetMirror()

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

inherited

Function SetMirror() Controls 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 546 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_EDITOR_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

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

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

SetPrintMode()

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

inlineinherited

Set the printing mode.

Parameters

aPrintMode

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

Definition at line 692 of file view.h.

{ m_printMode = aPrintMode; }

References KIGFX::VIEW::m_printMode.

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

SetRequired()

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

inherited

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

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

Parameters

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 397 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

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

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

Parameters

aAnchor	the zooming anchor point
aScale	the scale factor

Reimplemented in KIGFX::SCH_VIEW.

Definition at line 559 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(), 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_EDIT_FRAME::ExecuteRemoteCommand(), SCH_EDITOR_CONTROL::FindComponentAndItem(), SYMBOL_PREVIEW_WIDGET::fitOnDrawArea(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), KIGFX::WX_VIEW_CONTROLS::onMotion(), KIGFX::WX_VIEW_CONTROLS::onWheel(), FOOTPRINT_PREVIEW_PANEL::renderFootprint(), ZOOM_TOOL::selectRegion(), KIGFX::VIEW::SetGAL(), KIGFX::SCH_VIEW::SetScale(), KIGFX::VIEW::SetViewport(), PANEL_PCBNEW_COLOR_SETTINGS::zoomFitPreview(), PANEL_EESCHEMA_COLOR_SETTINGS::zoomFitPreview(), and SELECTION_TOOL::zoomFitSelection().

SetScaleLimits()

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

inlineinherited

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

Parameters

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

Definition at line 300 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 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

Function SetTopLayer() Sets 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	the layer or -1 in case when no particular layer should be displayed on the top.

Definition at line 838 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(), GERBVIEW_DRAW_PANEL_GAL::SetTopLayer(), PL_DRAW_PANEL_GAL::SetTopLayer(), PCB_DRAW_PANEL_GAL::SetTopLayer(), EDA_DRAW_PANEL_GAL::SetTopLayer(), PCBNEW_PRINTOUT::setupViewLayers(), and BOARD_PRINTOUT::setupViewLayers().

SetViewport()

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

inherited

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

Parameters

aViewport

desired visible area, in world space coordinates.

Definition at line 531 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, and VECTOR2< T >::y.

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

SetVisible()

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

inherited

Sets the item visibility.

Parameters

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

Definition at line 1459 of file view.cpp.

{
    auto 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(), EE_GRID_HELPER::BestSnapAnchor(), GRID_HELPER::BestSnapAnchor(), MICROWAVE_TOOL::drawMicrowaveInductor(), EE_GRID_HELPER::EE_GRID_HELPER(), PNS_KICAD_IFACE::EraseView(), GRID_HELPER::GRID_HELPER(), PNS_KICAD_IFACE::HideItem(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), ZONE_CREATE_HELPER::OnComplete(), ZONE_CREATE_HELPER::OnFirstPoint(), FOOTPRINT_PREVIEW_PANEL::renderFootprint(), PL_SELECTION_TOOL::selectMultiple(), EE_SELECTION_TOOL::selectMultiple(), SELECTION_TOOL::selectMultiple(), ZOOM_TOOL::selectRegion(), GRID_HELPER::SetAuxAxes(), EE_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 1568 of file view.cpp.

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

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

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

SortLayers()

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

inherited

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

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

Parameters

aLayers	stores id of layers to be sorted.
aCount	stores the number of layers.

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

sortLayers()

void KIGFX::VIEW::sortLayers ( )

protectedinherited

• Sorts m_orderedLayers when layer rendering order has changed

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

ToScreen() [1/2]

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

inherited

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

Parameters

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

Definition at line 475 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(), TOOL_DISPATCHER::handleMouseButton(), KIGFX::WX_VIEW_CONTROLS::SetCrossHairCursorPosition(), KIGFX::VIEW::SetScale(), and KIGFX::WX_VIEW_CONTROLS::WarpCursor().

ToScreen() [2/2]

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

inherited

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

Parameters

aSize

the size to be transformed.

Definition at line 486 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

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

Parameters

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

Definition at line 456 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(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), EDIT_POINTS::FindPoint(), SYMBOL_PREVIEW_WIDGET::fitOnDrawArea(), GENERAL_COLLECTORS_GUIDE::GENERAL_COLLECTORS_GUIDE(), KIGFX::WX_VIEW_CONTROLS::GetMousePosition(), KIGFX::VIEW::GetViewport(), KIGFX::WS_PROXY_VIEW_ITEM::HitTestWorksheetItems(), KIGFX::WX_VIEW_CONTROLS::onMotion(), KIGFX::WX_VIEW_CONTROLS::onScroll(), EDA_DRAW_PANEL_GAL::onSize(), KIGFX::WX_VIEW_CONTROLS::onTimer(), KIGFX::WX_VIEW_CONTROLS::onWheel(), KIGFX::VIEW::Redraw(), KIGFX::WX_VIEW_CONTROLS::refreshMouse(), PL_SELECTION_TOOL::selectionContains(), EE_SELECTION_TOOL::selectionContains(), SELECTION_TOOL::selectionContains(), ZOOM_TOOL::selectRegion(), KIGFX::VIEW::SetCenter(), KIGFX::VIEW::SetScale(), KIGFX::VIEW::SetViewport(), KIGFX::ORIGIN_VIEWITEM::ViewDraw(), EDIT_POINTS::ViewDraw(), PANEL_PCBNEW_COLOR_SETTINGS::zoomFitPreview(), and SELECTION_TOOL::zoomFitSelection().

ToWorld() [2/2]

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

inherited

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

Parameters

aSize

: the size to be converted

Definition at line 467 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, int  aUpdateFlags  ) const

overridevirtual

For dynamic VIEWs, informs 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 94 of file pcb_view.cpp.

{
    const BOARD_ITEM* item = static_cast<const BOARD_ITEM*>( aItem );

    if( item->Type() == PCB_FOOTPRINT_T )
    {
        const FOOTPRINT* footprint = static_cast<const FOOTPRINT*>( item );

        footprint->RunOnChildren( [this, aUpdateFlags]( BOARD_ITEM* aModItem )
                                  {
                                      VIEW::Update( aModItem, aUpdateFlags );
                                  } );
    }

    VIEW::Update( item, aUpdateFlags );
}

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

Referenced by SELECTION_TOOL::ClearSelection(), PCB_TOOL_BASE::doInteractiveItemPlacement(), MICROWAVE_TOOL::drawMicrowaveInductor(), PCB_EDIT_FRAME::Edit_Zone_Params(), PAD_TOOL::EnumeratePads(), PCB_BASE_FRAME::FocusOnItem(), PCB_VIEWER_TOOLS::GraphicOutlines(), SELECTION_TOOL::highlight(), PCB_VIEWER_TOOLS::MeasureTool(), DIALOG_DRC::OnDRCItemRClick(), PCB_VIEWER_TOOLS::PadDisplayMode(), PCB_EDITOR_CONTROL::PlaceTarget(), DIALOG_BOARD_REANNOTATE::ReannotateBoard(), refreshCallback(), FOOTPRINT_PREVIEW_PANEL::renderFootprint(), FOOTPRINT_EDITOR_TOOLS::Save(), FOOTPRINT_EDITOR_TOOLS::SaveAs(), SELECTION_TOOL::selectMultiple(), PCB_VIEWER_TOOLS::ShowPadNumbers(), GLOBAL_EDIT_TOOL::swapBoardItem(), GLOBAL_EDIT_TOOL::SwapLayers(), PCB_VIEWER_TOOLS::TextOutlines(), PCBNEW_CONTROL::TrackDisplayMode(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataFromWindow(), SELECTION_TOOL::unhighlight(), SELECTION_TOOL::unhighlightInternal(), Update(), PCBNEW_CONTROL::ViaDisplayMode(), and PCBNEW_CONTROL::ZoneDisplayMode().

Update() [2/2]

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

overridevirtual

For dynamic VIEWs, informs 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 112 of file pcb_view.cpp.

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

References KIGFX::ALL, and Update().

UpdateAllItems()

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

inherited

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

Parameters

aUpdateFlags

is is according to KIGFX::VIEW_UPDATE_FLAGS

Definition at line 1417 of file view.cpp.

{
    for( VIEW_ITEM* item : *m_allItems )
    {
        auto viewData = item->viewPrivData();

        if( !viewData )
            continue;

        viewData->m_requiredUpdate |= aUpdateFlags;
    }
}

References KIGFX::VIEW::m_allItems.

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

UpdateAllItemsConditionally()

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

inherited

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

{
    for( VIEW_ITEM* item : *m_allItems )
    {
        if( aCondition( item ) )
        {
            auto viewData = item->viewPrivData();

            if( !viewData )
                continue;

            viewData->m_requiredUpdate |= aUpdateFlags;
        }
    }
}

References KIGFX::VIEW::m_allItems.

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

UpdateAllLayersColor()

void KIGFX::VIEW::UpdateAllLayersColor ( )

inherited

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

The used scheme is held by RENDER_SETTINGS.

See also

RENDER_SETTINGS

Definition at line 776 of file view.cpp.

{
    if( m_gal->IsVisible() )
    {
        GAL_UPDATE_CONTEXT ctx( m_gal );

        for( VIEW_ITEM* item : *m_allItems )
        {
            auto 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::PAINTER::GetSettings(), 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(), PCB_INSPECTION_TOOL::ClearHighlight(), FOOTPRINT_EDIT_FRAME::CommonSettingsChanged(), KIGFX::VIEW::EnableTopLayer(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), PNS::TOOL_BASE::highlightNet(), PCB_INSPECTION_TOOL::HighlightNet(), PCB_INSPECTION_TOOL::highlightNet(), APPEARANCE_CONTROLS::onNetclassColorChanged(), APPEARANCE_CONTROLS::onNetclassContextMenu(), APPEARANCE_CONTROLS::onNetColorModeChanged(), DIALOG_NET_INSPECTOR::onSelChanged(), DIALOG_NET_INSPECTOR::onSortingChanged(), GERBVIEW_DRAW_PANEL_GAL::SetHighContrastLayer(), PCB_DRAW_PANEL_GAL::SetHighContrastLayer(), EDA_DRAW_PANEL_GAL::SetHighContrastLayer(), and NET_GRID_TABLE::updateNetColor().

UpdateAllLayersOrder()

void KIGFX::VIEW::UpdateAllLayersOrder ( )

inherited

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

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

Definition at line 905 of file view.cpp.

{
    sortLayers();

    if( m_gal->IsVisible() )
    {
        GAL_UPDATE_CONTEXT ctx( m_gal );

        for( VIEW_ITEM* item : *m_allItems )
        {
            auto 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::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(), GERBVIEW_DRAW_PANEL_GAL::SetTopLayer(), PL_DRAW_PANEL_GAL::SetTopLayer(), PCB_DRAW_PANEL_GAL::SetTopLayer(), and EDA_DRAW_PANEL_GAL::SetTopLayer().

updateBbox()

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

protectedinherited

Updates bounding box of an item.

Definition at line 1300 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 118 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, settings->GetShowPageLimits() );
}

References KIGFX::VIEW::GetPainter().

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

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

Definition at line 1251 of file view.cpp.

{
    auto 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::PAINTER::GetSettings(), 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

Updates all informations needed to draw an item.

Definition at line 1270 of file view.cpp.

{
    auto 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::IsCached(), KIGFX::VIEW::m_gal, KIGFX::VIEW::m_layers, KIGFX::VIEW::m_painter, KIGFX::VIEW::VIEW_LAYER::renderingOrder, KIGFX::GAL::SetLayerDepth(), KIGFX::GAL::SetTarget(), KIGFX::VIEW::VIEW_LAYER::target, KIGFX::VIEW_ITEM::ViewDraw(), and KIGFX::VIEW_ITEM::viewPrivData().

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

UpdateItems()

void KIGFX::VIEW::UpdateItems ( )

inherited

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

Definition at line 1394 of file view.cpp.

{
    if( m_gal->IsVisible() )
    {
        GAL_UPDATE_CONTEXT ctx( m_gal );

        for( VIEW_ITEM* item : *m_allItems )
        {
            auto viewData = item->viewPrivData();

            if( !viewData )
                continue;

            if( viewData->m_requiredUpdate != NONE )
            {
                invalidateItem( item, viewData->m_requiredUpdate );
                viewData->m_requiredUpdate = NONE;
            }
        }
    }
}

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

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

UpdateLayerColor()

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

inherited

Function UpdateLayerColor() Applies 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 755 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 );

        updateItemsColor 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 PCBNEW_CONTROL::LayerAlphaDec(), PCBNEW_CONTROL::LayerAlphaInc(), APPEARANCE_CONTROLS::OnColorSwatchChanged(), and GERBER_LAYER_WIDGET::OnLayerColorChange().

updateLayers()

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

protectedinherited

Updates set of layers that an item occupies.

Definition at line 1316 of file view.cpp.

{
    auto 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::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::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

Function UseDrawPriority()

Parameters

aFlag

is true if draw priority should be respected while redrawing.

Definition at line 642 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

Flat list of all items.

Definition at line 807 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

View boundaries.

Definition at line 819 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

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

Definition at line 813 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

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

Definition at line 844 of file view.h.

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

m_dynamic

bool KIGFX::VIEW::m_dynamic

protectedinherited

Dynamic VIEW (eg.

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

Definition at line 841 of file view.h.

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

m_enableOrderModifier

bool KIGFX::VIEW::m_enableOrderModifier

protectedinherited

• Whether to use rendering order modifier or not

Definition at line 798 of file view.h.

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

m_gal

GAL* KIGFX::VIEW::m_gal

protectedinherited

Gives interface to PAINTER, that is used to draw items.

Definition at line 837 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

Contains set of possible displayed layers and its properties.

Definition at line 801 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::SetLayerDisplayOnly(), 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::UpdateLayerColor(), KIGFX::VIEW::updateLayers(), and KIGFX::VIEW::VIEW().

m_maxScale

double KIGFX::VIEW::m_maxScale

protectedinherited

Scale upper limit.

Definition at line 825 of file view.h.

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

m_minScale

double KIGFX::VIEW::m_minScale

protectedinherited

Scale lower limit.

Definition at line 822 of file view.h.

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

m_mirrorX

bool KIGFX::VIEW::m_mirrorX

protectedinherited

Horizontal flip flag

Definition at line 828 of file view.h.

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

m_mirrorY

bool KIGFX::VIEW::m_mirrorY

protectedinherited

Vertical flip flag

Definition at line 831 of file view.h.

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

m_nextDrawPriority

int KIGFX::VIEW::m_nextDrawPriority

protectedinherited

The next sequential drawing priority.

Definition at line 854 of file view.h.

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

m_orderedLayers

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

protectedinherited

Sorted list of pointers to members of m_layers.

Definition at line 804 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

Definition at line 718 of file view.h.

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

m_painter

PAINTER* KIGFX::VIEW::m_painter

protectedinherited

PAINTER contains information how do draw items.

Definition at line 834 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 715 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_printMode

int KIGFX::VIEW::m_printMode

protectedinherited

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

Definition at line 861 of file view.h.

Referenced by KIGFX::VIEW::GetPrintMode(), and KIGFX::VIEW::SetPrintMode().

m_reverseDrawOrder

bool KIGFX::VIEW::m_reverseDrawOrder

protectedinherited

Flag to reverse the draw order when using draw priority.

Definition at line 857 of file view.h.

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

m_scale

double KIGFX::VIEW::m_scale

protectedinherited

Scale of displayed VIEW_ITEMs.

Definition at line 816 of file view.h.

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

m_topLayers

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

protectedinherited

Stores set of layers that are displayed on the top.

Definition at line 810 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

Flat list of all items Flag to respect draw priority when drawing items.

Definition at line 851 of file view.h.

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

TOP_LAYER_MODIFIER

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

staticprotectedinherited

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

Definition at line 847 of file view.h.

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

VIEW_MAX_LAYERS

constexpr int KIGFX::VIEW::VIEW_MAX_LAYERS = 512

staticinherited

maximum number of layers that may be shown

Definition at line 694 of file view.h.

Referenced by KIGFX::VIEW::Add(), KIGFX::SCH_PAINTER::draw(), KIGFX::VIEW::draw(), FOOTPRINT::GetAllDrawingLayers(), KIGFX::VIEW::invalidateItem(), KIGFX::VIEW::Remove(), KIGFX::VIEW::ReorderLayerData(), KIGFX::VIEW_ITEM_DATA::saveLayers(), PL_DRAW_PANEL_GAL::setDefaultLayerDeps(), SCH_DRAW_PANEL::setDefaultLayerDeps(), SCH_PREVIEW_PANEL::setDefaultLayerDeps(), GERBVIEW_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::updateLayers(), KIGFX::VIEW::VIEW(), KIGFX::VIEW_GROUP::ViewDraw(), and PCB_GROUP::ViewGetLayers().

---

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

• pcb_view.h
• pcb_view.cpp