KIGFX::VIEW_GROUP Class Reference

Extend VIEW_ITEM by possibility of grouping items into a single object. More...

#include <view_group.h>

Inheritance diagram for KIGFX::VIEW_GROUP:

Public Member Functions
	VIEW_GROUP (VIEW *aView=nullptr)
virtual	~VIEW_GROUP ()
virtual unsigned int	GetSize () const
	Return the number of stored items. More...
virtual void	Add (VIEW_ITEM *aItem)
	Add an item to the group. More...
virtual void	Remove (VIEW_ITEM *aItem)
	Remove an item from the group. More...
virtual void	Clear ()
	Remove all the stored items from the group. More...
virtual VIEW_ITEM *	GetItem (unsigned int aIdx) const
virtual const BOX2I	ViewBBox () const override
	Return the bounding box for all stored items covering all its layers. More...
virtual void	ViewDraw (int aLayer, VIEW *aView) const override
	Draw all the stored items in the group on the given layer. More...
virtual void	ViewGetLayers (int aLayers[], int &aCount) const override
	Return all the layers used by the stored items. More...
virtual void	SetLayer (int aLayer)
	Set layer used to draw the group. More...
void	FreeItems ()
	Free all the items that were added to the group. More...
virtual double	ViewGetLOD (int aLayer, VIEW *aView) const
	Return the level of detail (LOD) of the item. More...
VIEW_ITEM_DATA *	viewPrivData () const
void	ClearViewPrivData ()
bool	Set (PROPERTY_BASE *aProperty, wxAny &aValue)
template<typename T >
bool	Set (PROPERTY_BASE *aProperty, T aValue)
template<typename T >
bool	Set (const wxString &aProperty, T aValue)
wxAny	Get (PROPERTY_BASE *aProperty)
template<typename T >
T	Get (PROPERTY_BASE *aProperty)
template<typename T >
boost::optional< T >	Get (const wxString &aProperty)

Protected Member Functions
virtual const std::vector< VIEW_ITEM * >	updateDrawList () const

Protected Attributes
int	m_layer
std::vector< VIEW_ITEM * >	m_groupItems

Detailed Description

Extend VIEW_ITEM by possibility of grouping items into a single object.

VIEW_GROUP does not take over ownership of the held items. The main purpose of this class is to group items and draw them on a single layer (in particular the overlay).

Definition at line 46 of file view_group.h.

Constructor & Destructor Documentation

VIEW_GROUP()

VIEW_GROUP::VIEW_GROUP

(

VIEW *

aView = nullptr

)

Definition at line 44 of file view_group.cpp.

 :
 VIEW_ITEM(),
 m_layer( LAYER_SELECT_OVERLAY )
{
}

~VIEW_GROUP()

VIEW_GROUP::~VIEW_GROUP ( )

virtual

Definition at line 51 of file view_group.cpp.

{
 // VIEW_ITEM destructor removes the object from its parent view
}

Member Function Documentation

Add()

void VIEW_GROUP::Add ( VIEW_ITEM *  aItem )

virtual

Add an item to the group.

Definition at line 57 of file view_group.cpp.

{
 m_groupItems.push_back( aItem );
}

References m_groupItems.

Referenced by PNS_PCBNEW_DEBUG_DECORATOR::AddLine(), GERBVIEW_SELECTION_TOOL::disambiguationMenu(), PNS_KICAD_IFACE::DisplayItem(), PNS_KICAD_IFACE::DisplayRatline(), PCB_TOOL_BASE::doInteractiveItemPlacement(), PCB_SELECTION_TOOL::EnterGroup(), and BOARD_EDITOR_CONTROL::PlaceTarget().

Clear()

void VIEW_GROUP::Clear ( )

virtual

Remove all the stored items from the group.

Reimplemented in SELECTION.

Definition at line 69 of file view_group.cpp.

{
 m_groupItems.clear();
}

References m_groupItems.

Referenced by PCB_SELECTION_TOOL::ExitGroup(), FreeItems(), BOARD_EDITOR_CONTROL::PlaceTarget(), and PCB_SELECTION_TOOL::RebuildSelection().

ClearViewPrivData()

void KIGFX::VIEW_ITEM::ClearViewPrivData ( )

inlineinherited

Definition at line 143 of file view_item.h.

 {
 m_viewPrivData = nullptr;
 }

References KIGFX::VIEW_ITEM::m_viewPrivData.

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

FreeItems()

void VIEW_GROUP::FreeItems

(

)

Free all the items that were added to the group.

Definition at line 192 of file view_group.cpp.

{
 for( unsigned int i = 0 ; i < GetSize(); i++ )
 delete GetItem( i );

 Clear();
}

References Clear(), GetItem(), and GetSize().

Referenced by PNS_PCBNEW_DEBUG_DECORATOR::Clear(), PNS_KICAD_IFACE::EraseView(), PNS_KICAD_IFACE::SetView(), and PNS_KICAD_IFACE::~PNS_KICAD_IFACE().

Get() [1/3]

wxAny INSPECTABLE::Get ( PROPERTY_BASE *  aProperty )

inlineinherited

Definition at line 86 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 TYPE_ID thisType = TYPE_HASH( *this );
 void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );
 return object ? aProperty->getter( object ) : wxAny();
 }

References PROPERTY_BASE::getter(), PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

Referenced by BOOST_AUTO_TEST_CASE(), CLASS_D_DESC::CLASS_D_DESC(), PCB_EXPR_VAR_REF::GetValue(), and PAD_DESC::PAD_DESC().

Get() [2/3]

template<typename T >

T INSPECTABLE::Get ( PROPERTY_BASE *  aProperty )

inlineinherited

Definition at line 95 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 TYPE_ID thisType = TYPE_HASH( *this );
 void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );
 return object ? aProperty->get<T>( object ) : T();
 }

References PROPERTY_BASE::get(), PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

Get() [3/3]

template<typename T >

boost::optional<T> INSPECTABLE::Get ( const wxString &  aProperty )

inlineinherited

Definition at line 104 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 TYPE_ID thisType = TYPE_HASH( *this );
 PROPERTY_BASE* prop = propMgr.GetProperty( thisType, aProperty );
 boost::optional<T> ret = T();

 if( prop )
 {
 void* object = propMgr.TypeCast( this, thisType, prop->OwnerHash() );

 if( object )
 ret = prop->get<T>( object );
 }

 return ret;
 }

References PROPERTY_BASE::get(), PROPERTY_MANAGER::GetProperty(), PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

GetItem()

VIEW_ITEM * VIEW_GROUP::GetItem ( unsigned int  aIdx ) const

virtual

Reimplemented in SELECTION.

Definition at line 81 of file view_group.cpp.

{
 return m_groupItems[idx];
}

References m_groupItems.

Referenced by KIGFX::VIEW::draw(), and FreeItems().

GetSize()

unsigned int VIEW_GROUP::GetSize ( ) const

virtual

Return the number of stored items.

Reimplemented in SELECTION.

Definition at line 75 of file view_group.cpp.

{
 return m_groupItems.size();
}

References m_groupItems.

Referenced by KIGFX::VIEW::draw(), and FreeItems().

Remove()

void VIEW_GROUP::Remove ( VIEW_ITEM *  aItem )

virtual

Remove an item from the group.

Definition at line 63 of file view_group.cpp.

{
 alg::delete_matching( m_groupItems, aItem );
}

References alg::delete_matching(), and m_groupItems.

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), and BOARD_EDITOR_CONTROL::PlaceTarget().

Set() [1/3]

bool INSPECTABLE::Set ( PROPERTY_BASE *  aProperty, wxAny &  aValue  )

inlineinherited

Definition at line 42 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 TYPE_ID thisType = TYPE_HASH( *this );
 void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );

 if( object )
 aProperty->setter( object, aValue );

 return object != nullptr;
 }

References PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), PROPERTY_BASE::setter(), TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

Set() [2/3]

template<typename T >

bool INSPECTABLE::Set ( PROPERTY_BASE *  aProperty, T  aValue  )

inlineinherited

Definition at line 55 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 TYPE_ID thisType = TYPE_HASH( *this );
 void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );

 if( object )
 aProperty->set<T>( object, aValue );

 return object != nullptr;
 }

References PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), PROPERTY_BASE::set(), TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

Set() [3/3]

template<typename T >

bool INSPECTABLE::Set ( const wxString &  aProperty, T  aValue  )

inlineinherited

Definition at line 68 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 TYPE_ID thisType = TYPE_HASH( *this );
 PROPERTY_BASE* prop = propMgr.GetProperty( thisType, aProperty );
 void* object = nullptr;

 if( prop )
 {
 object = propMgr.TypeCast( this, thisType, prop->OwnerHash() );

 if( object )
 prop->set<T>( object, aValue );
 }

 return object != nullptr;
 }

References PROPERTY_MANAGER::GetProperty(), PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), PROPERTY_BASE::set(), TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

SetLayer()

virtual void KIGFX::VIEW_GROUP::SetLayer ( int  aLayer )

inlinevirtual

Set layer used to draw the group.

Definition at line 98 of file view_group.h.

 {
 m_layer = aLayer;
 }

References m_layer.

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), PCB_SELECTION_TOOL::doSelectionMenu(), PNS_KICAD_IFACE::SetView(), and PNS_PCBNEW_DEBUG_DECORATOR::SetView().

updateDrawList()

const std::vector< VIEW_ITEM * > VIEW_GROUP::updateDrawList ( ) const

protectedvirtual

Reimplemented in SELECTION, and PCB_SELECTION.

Definition at line 201 of file view_group.cpp.

{
 return m_groupItems;
}

References m_groupItems.

Referenced by ViewDraw().

ViewBBox()

const BOX2I VIEW_GROUP::ViewBBox ( ) const

overridevirtual

Return the bounding box for all stored items covering all its layers.

Implements KIGFX::VIEW_ITEM.

Reimplemented in SELECTION, and GERBVIEW_SELECTION.

Definition at line 87 of file view_group.cpp.

{
 BOX2I bb;

 if( !m_groupItems.size() )
 {
 bb.SetMaximum();
 }
 else
 {
 bb = m_groupItems[0]->ViewBBox();

 for( VIEW_ITEM* item : m_groupItems )
 bb.Merge( item->ViewBBox() );
 }

 return bb;
}

References m_groupItems, BOX2< Vec >::Merge(), and BOX2< Vec >::SetMaximum().

ViewDraw()

void VIEW_GROUP::ViewDraw ( int  aLayer, VIEW *  aView  ) const

overridevirtual

Draw all the stored items in the group on the given layer.

Parameters

aLayer	is the layer which should be drawn.
aView	is the VIEW that should be used for drawing.

Reimplemented from KIGFX::VIEW_ITEM.

Definition at line 107 of file view_group.cpp.

{
 KIGFX::GAL* gal = aView->GetGAL();
 PAINTER* painter = aView->GetPainter();
 bool isSelection = m_layer == LAYER_SELECT_OVERLAY;

 const std::vector<VIEW_ITEM*> drawList = updateDrawList();

 std::unordered_map<int, std::vector<VIEW_ITEM*>> layer_item_map;

 // Build a list of layers used by the items in the group
 for( VIEW_ITEM* item : drawList )
 {
 int item_layers[VIEW::VIEW_MAX_LAYERS], item_layers_count;
 item->ViewGetLayers( item_layers, item_layers_count );

 for( int i = 0; i < item_layers_count; i++ )
 {
 if( layer_item_map.count( item_layers[i] ) == 0 )
 {
 layer_item_map.emplace( std::make_pair( item_layers[i],
 std::vector<VIEW_ITEM*>() ) );
 }

 layer_item_map[ item_layers[i] ].push_back( item );
 }
 }

 int layers[VIEW::VIEW_MAX_LAYERS] = { 0 };
 int layers_count = 0;

 for( const std::pair<const int, std::vector<VIEW_ITEM*>>& entry : layer_item_map )
 layers[ layers_count++ ] = entry.first;

 aView->SortLayers( layers, layers_count );

 // Now draw the layers in sorted order

 gal->PushDepth();

 for( int i = 0; i < layers_count; i++ )
 {
 int layer = layers[i];
 bool draw = aView->IsLayerVisible( layer );

 if( isSelection )
 {
 switch( layer )
 {
 case LAYER_PADS_TH:
 case LAYER_PAD_PLATEDHOLES:
 case LAYER_PAD_HOLEWALLS:
 case LAYER_PAD_FR:
 case LAYER_PAD_BK:
 draw = true;
 break;
 default:
 break;
 }
 }

 if( draw )
 {
 gal->AdvanceDepth();

 for( VIEW_ITEM* item : layer_item_map[ layers[i] ] )
 {
 if( !painter->Draw( item, layers[i] ) )
 item->ViewDraw( layers[i], aView ); // Alternative drawing method
 }
 }
 }

 gal->PopDepth();
}

References KIGFX::GAL::AdvanceDepth(), KIGFX::PAINTER::Draw(), KIGFX::VIEW::GetGAL(), KIGFX::VIEW::GetPainter(), KIGFX::VIEW::IsLayerVisible(), LAYER_PAD_BK, LAYER_PAD_FR, LAYER_PAD_HOLEWALLS, LAYER_PAD_PLATEDHOLES, LAYER_PADS_TH, LAYER_SELECT_OVERLAY, m_layer, KIGFX::GAL::PopDepth(), KIGFX::GAL::PushDepth(), KIGFX::VIEW::SortLayers(), updateDrawList(), and KIGFX::VIEW::VIEW_MAX_LAYERS.

ViewGetLayers()

void VIEW_GROUP::ViewGetLayers ( int  aLayers[], int &  aCount  ) const

overridevirtual

Return all the layers used by the stored items.

Parameters

aLayers[]	is the output layer index array.
aCount	is the number of layer indices in aLayers[].

Implements KIGFX::VIEW_ITEM.

Definition at line 184 of file view_group.cpp.

{
 // Everything is displayed on a single layer
 aLayers[0] = m_layer;
 aCount = 1;
}

References m_layer.

ViewGetLOD()

virtual double KIGFX::VIEW_ITEM::ViewGetLOD ( int  aLayer, VIEW *  aView  ) const

inlinevirtualinherited

Return the level of detail (LOD) of the item.

A level of detail is the minimal VIEW scale that is sufficient for an item to be shown on a given layer.

Parameters

aLayer	is the current drawing layer.
aView	is a pointer to the VIEW device we are drawing on.

Returns

the level of detail. 0 always show the item, because the actual zoom level (or VIEW scale) is always > 0

Reimplemented in FP_ZONE, PAD, FOOTPRINT, PCB_VIA, GERBER_DRAW_ITEM, FP_TEXT, PCB_TRACK, ZONE, PCB_GROUP, and FP_SHAPE.

Definition at line 132 of file view_item.h.

 {
 // By default always show the item
 return 0.0;
 }

Referenced by PNS_KICAD_IFACE::IsItemVisible(), KIGFX::VIEW::DRAW_ITEM_VISITOR::operator()(), EE_GRID_HELPER::queryVisible(), PCB_GRID_HELPER::queryVisible(), and PCB_SELECTION_TOOL::Selectable().

viewPrivData()

VIEW_ITEM_DATA* KIGFX::VIEW_ITEM::viewPrivData ( ) const

inlineinherited

Definition at line 138 of file view_item.h.

 {
 return m_viewPrivData;
 }

References KIGFX::VIEW_ITEM::m_viewPrivData.

Referenced by KIGFX::VIEW::Add(), KIGFX::VIEW::DRAW_ITEM_VISITOR::deferredDraw(), KIGFX::VIEW::draw(), KIGFX::VIEW::Hide(), KIGFX::VIEW::invalidateItem(), KIGFX::VIEW::IsVisible(), KIGFX::VIEW::OnDestroy(), KIGFX::QUERY_VISITOR< CONTAINER >::operator()(), KIGFX::VIEW::UPDATE_COLOR_VISITOR::operator()(), KIGFX::VIEW::UPDATE_DEPTH_VISITOR::operator()(), KIGFX::VIEW::DRAW_ITEM_VISITOR::operator()(), KIGFX::VIEW::RECACHE_ITEM_VISITOR::operator()(), KIGFX::VIEW::CLEAR_LAYER_CACHE_VISITOR::operator()(), KIGFX::VIEW::Remove(), KIGFX::VIEW::SetVisible(), KIGFX::VIEW::Update(), KIGFX::VIEW::updateItemColor(), KIGFX::VIEW::updateItemGeometry(), and KIGFX::VIEW::updateLayers().

Member Data Documentation

m_groupItems

std::vector<VIEW_ITEM*> KIGFX::VIEW_GROUP::m_groupItems

protected

Definition at line 113 of file view_group.h.

Referenced by Add(), Clear(), GetItem(), GetSize(), Remove(), updateDrawList(), and ViewBBox().

m_layer

int KIGFX::VIEW_GROUP::m_layer

protected

Definition at line 112 of file view_group.h.

Referenced by SetLayer(), ViewDraw(), and ViewGetLayers().

---

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

• view_group.h
• view_group.cpp