KiCad PCB EDA Suite
Public Member Functions | Private Attributes | Friends | List of all members
KIGFX::VIEW_ITEM Class Referenceabstract

An abstract base class for deriving all objects that can be added to a VIEW. More...

#include <view_item.h>

Inheritance diagram for KIGFX::VIEW_ITEM:
INSPECTABLE EDA_ITEM KIGFX::VIEW_GROUP KIGFX::VIEW_OVERLAY BASE_SCREEN BOARD_ITEM DS_DRAW_ITEM_BASE DS_PROXY_UNDO_ITEM DS_PROXY_VIEW_ITEM EDIT_POINTS GBR_LAYOUT GERBER_DRAW_ITEM GERBER_FILE_IMAGE KIGFX::ORIGIN_VIEWITEM KIGFX::PREVIEW::ARC_ASSISTANT KIGFX::PREVIEW::RULER_ITEM KIGFX::PREVIEW::SIMPLE_OVERLAY_ITEM KIGFX::PREVIEW::TWO_POINT_ASSISTANT LIB_ITEM LIB_SYMBOL MY_DRAWING RATSNEST_VIEW_ITEM ROUTER_PREVIEW_ITEM SCHEMATIC SCH_ITEM SELECTION PNS_LOG_VIEWER_OVERLAY

Public Member Functions

 VIEW_ITEM ()
 
virtual ~VIEW_ITEM ()
 
 VIEW_ITEM (const VIEW_ITEM &aOther)=delete
 
VIEW_ITEM & operator= (const VIEW_ITEM &aOther)=delete
 
virtual const BOX2I ViewBBox () const =0
 Return the bounding box of the item covering all its layers. More...
 
virtual void ViewDraw (int aLayer, VIEW *aView) const
 Draw the parts of the object belonging to layer aLayer. More...
 
virtual void ViewGetLayers (int aLayers[], int &aCount) const =0
 Return the all the layers within the VIEW the object is painted on. 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) const
 
template<typename T >
T Get (PROPERTY_BASE *aProperty) const
 
template<typename T >
std::optional< T > Get (const wxString &aProperty) const
 

Private Attributes

VIEW_ITEM_DATA * m_viewPrivData
 

Friends

class VIEW
 

Detailed Description

An abstract base class for deriving all objects that can be added to a VIEW.

Its role is to:

  • communicate geometry, appearance and visibility updates to the associated dynamic VIEW,
  • provide a bounding box for redraw area calculation,
  • (optional) draw the object using the #GAL API functions for #PAINTER-less implementations.

VIEW_ITEM objects are never owned by a VIEW. A single VIEW_ITEM can belong to any number of static VIEWs, but only one dynamic VIEW due to storage of only one VIEW reference.

Definition at line 76 of file view_item.h.

Constructor & Destructor Documentation

◆ VIEW_ITEM() [1/2]

KIGFX::VIEW_ITEM::VIEW_ITEM ( )
inline

Definition at line 79 of file view_item.h.

79 : m_viewPrivData( nullptr )
80 {
81 }
KIGFX::VIEW_ITEM::m_viewPrivData
VIEW_ITEM_DATA * m_viewPrivData
Definition: view_item.h:151

◆ ~VIEW_ITEM()

VIEW_ITEM::~VIEW_ITEM ( )
virtual

Definition at line 31 of file view_item.cpp.

32{
33 VIEW::OnDestroy( this );
34 m_viewPrivData = nullptr;
35}
KIGFX::VIEW::OnDestroy
static void OnDestroy(VIEW_ITEM *aItem)
Nasty hack, invoked by the destructor of VIEW_ITEM to auto-remove the item from the owning VIEW if th...
Definition: view.cpp:241

References m_viewPrivData, and KIGFX::VIEW::OnDestroy().

◆ VIEW_ITEM() [2/2]

KIGFX::VIEW_ITEM::VIEW_ITEM ( const VIEW_ITEM &  aOther)
delete

Member Function Documentation

◆ ClearViewPrivData()

void KIGFX::VIEW_ITEM::ClearViewPrivData ( )
inline

Definition at line 143 of file view_item.h.

144 {
145 m_viewPrivData = nullptr;
146 }

References m_viewPrivData.

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

◆ Get() [1/3]

template<typename T >
std::optional< T > INSPECTABLE::Get ( const wxString &  aProperty) const
inlineinherited

Definition at line 104 of file inspectable.h.

105 {
106 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
107 TYPE_ID thisType = TYPE_HASH( *this );
108 PROPERTY_BASE* prop = propMgr.GetProperty( thisType, aProperty );
109 std::optional<T> ret;
110
111 if( prop )
112 {
113 const void* object = propMgr.TypeCast( this, thisType, prop->OwnerHash() );
114
115 if( object )
116 ret = prop->get<T>( object );
117 }
118
119 return ret;
120 }
PROPERTY_BASE
Definition: property.h:178
PROPERTY_BASE::OwnerHash
virtual size_t OwnerHash() const =0
Return type-id of the Owner class.
PROPERTY_BASE::get
T get(const void *aObject) const
Definition: property.h:352
PROPERTY_MANAGER
Provide class metadata.Helper macro to map type hashes to names.
Definition: property_mgr.h:74
PROPERTY_MANAGER::Instance
static PROPERTY_MANAGER & Instance()
Definition: property_mgr.h:76
PROPERTY_MANAGER::GetProperty
PROPERTY_BASE * GetProperty(TYPE_ID aType, const wxString &aProperty) const
Return a property for a specific type.
Definition: property_mgr.cpp:46
PROPERTY_MANAGER::TypeCast
const void * TypeCast(const void *aSource, TYPE_ID aBase, TYPE_ID aTarget) const
Cast a type to another type.
Definition: property_mgr.cpp:113
TYPE_HASH
#define TYPE_HASH(x)
Definition: property.h:63
TYPE_ID
size_t TYPE_ID
Unique type identifier.
Definition: property_mgr.h:46

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

◆ Get() [2/3]

wxAny INSPECTABLE::Get ( PROPERTY_BASE *  aProperty) const
inlineinherited

Definition at line 84 of file inspectable.h.

85 {
86 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
87 const void* object = propMgr.TypeCast( this, TYPE_HASH( *this ), aProperty->OwnerHash() );
88 return object ? aProperty->getter( object ) : wxAny();
89 }
PROPERTY_BASE::getter
virtual wxAny getter(const void *aObject) const =0

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(), EDA_SHAPE_DESC::EDA_SHAPE_DESC(), PROPERTIES_PANEL::getItemValue(), PCB_EXPR_VAR_REF::GetValue(), and PAD_DESC::PAD_DESC().

◆ Get() [3/3]

template<typename T >
T INSPECTABLE::Get ( PROPERTY_BASE *  aProperty) const
inlineinherited

Definition at line 92 of file inspectable.h.

93 {
94 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
95 const void* object = propMgr.TypeCast( this, TYPE_HASH( *this ), aProperty->OwnerHash() );
96
97 if( !object )
98 throw std::runtime_error( "Could not cast INSPECTABLE to the requested type" );
99
100 return aProperty->get<T>( object );
101 }

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

◆ operator=()

VIEW_ITEM & KIGFX::VIEW_ITEM::operator= ( const VIEW_ITEM &  aOther)
delete

◆ Set() [1/3]

template<typename T >
bool INSPECTABLE::Set ( const wxString &  aProperty,
T  aValue 
)
inlineinherited

Definition at line 66 of file inspectable.h.

67 {
68 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
69 TYPE_ID thisType = TYPE_HASH( *this );
70 PROPERTY_BASE* prop = propMgr.GetProperty( thisType, aProperty );
71 void* object = nullptr;
72
73 if( prop )
74 {
75 object = propMgr.TypeCast( this, thisType, prop->OwnerHash() );
76
77 if( object )
78 prop->set<T>( object, aValue );
79 }
80
81 return object != nullptr;
82 }
PROPERTY_BASE::set
void set(void *aObject, T aValue)
Definition: property.h:325

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

◆ Set() [2/3]

template<typename T >
bool INSPECTABLE::Set ( PROPERTY_BASE *  aProperty,
T  aValue 
)
inlineinherited

Definition at line 54 of file inspectable.h.

55 {
56 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
57 void* object = propMgr.TypeCast( this, TYPE_HASH( *this ), aProperty->OwnerHash() );
58
59 if( object )
60 aProperty->set<T>( object, aValue );
61
62 return object != nullptr;
63 }

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

◆ Set() [3/3]

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

Definition at line 42 of file inspectable.h.

43 {
44 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
45 void* object = propMgr.TypeCast( this, TYPE_HASH( *this ), aProperty->OwnerHash() );
46
47 if( object )
48 aProperty->setter( object, aValue );
49
50 return object != nullptr;
51 }
PROPERTY_BASE::setter
virtual void setter(void *aObject, wxAny &aValue)=0

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

Referenced by PCB_PROPERTIES_PANEL::valueChanged().

◆ ViewBBox()

virtual const BOX2I KIGFX::VIEW_ITEM::ViewBBox ( ) const
pure virtual

Return the bounding box of the item covering all its layers.

Returns
the current bounding box.

Implemented in LIB_PIN, SCH_PIN, GERBER_DRAW_ITEM, GERBVIEW_SELECTION, DS_PROXY_VIEW_ITEM, EDA_ITEM, KIGFX::ORIGIN_VIEWITEM, KIGFX::PREVIEW::ARC_ASSISTANT, KIGFX::PREVIEW::CENTRELINE_RECT_ITEM, KIGFX::PREVIEW::POLYGON_ITEM, KIGFX::PREVIEW::RULER_ITEM, KIGFX::PREVIEW::SELECTION_AREA, KIGFX::PREVIEW::TWO_POINT_ASSISTANT, EDIT_POINTS, SELECTION, KIGFX::VIEW_GROUP, KIGFX::VIEW_OVERLAY, FOOTPRINT, FP_TEXT, PAD, PCB_DIMENSION_BASE, PCB_DIM_CENTER, PCB_MARKER, PCB_SHAPE, PCB_TRACK, RATSNEST_VIEW_ITEM, ROUTER_PREVIEW_ITEM, and MY_DRAWING.

Referenced by KIGFX::VIEW_RTREE::Insert().

◆ ViewDraw()

virtual void KIGFX::VIEW_ITEM::ViewDraw ( int  aLayer,
VIEW *  aView 
) const
inlinevirtual

Draw the parts of the object belonging to layer aLayer.

An alternative way for drawing objects if there is no #PAINTER assigned for the view or if the PAINTER doesn't know how to paint this particular implementation of VIEW_ITEM. The preferred way of drawing is to design an appropriate PAINTER object, the method below is intended only for quick hacks and debugging purposes.

Parameters
aLayeris the current drawing layer.
aViewis a pointer to the VIEW device we are drawing on.

Reimplemented in DS_PROXY_VIEW_ITEM, KIGFX::PREVIEW::SIMPLE_OVERLAY_ITEM, EDIT_POINTS, RATSNEST_VIEW_ITEM, ROUTER_PREVIEW_ITEM, MY_DRAWING, KIGFX::PREVIEW::ARC_ASSISTANT, KIGFX::PREVIEW::RULER_ITEM, KIGFX::PREVIEW::SELECTION_AREA, KIGFX::PREVIEW::TWO_POINT_ASSISTANT, KIGFX::ORIGIN_VIEWITEM, KIGFX::VIEW_GROUP, and KIGFX::VIEW_OVERLAY.

Definition at line 106 of file view_item.h.

107 {}

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

◆ ViewGetLayers()

virtual void KIGFX::VIEW_ITEM::ViewGetLayers ( int  aLayers[],
int &  aCount 
) const
pure virtual

Return the all the layers within the VIEW the object is painted on.

For instance, a PAD spans zero or more copper layers and a few technical layers. ViewDraw() or PAINTER::Draw() is repeatedly called for each of the layers returned by ViewGetLayers(), depending on the rendering order.

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

Implemented in LIB_FIELD, LIB_ITEM, LIB_PIN, LIB_SHAPE, LIB_SYMBOL, LIB_TEXT, LIB_TEXTBOX, SCH_BITMAP, SCH_BUS_ENTRY_BASE, SCH_ITEM, SCH_JUNCTION, SCH_LABEL_BASE, SCH_GLOBALLABEL, SCH_LINE, SCH_MARKER, SCH_NO_CONNECT, SCH_PIN, SCH_SHAPE, SCH_SHEET, SCH_SYMBOL, SCH_TEXT, GERBER_DRAW_ITEM, BOARD_ITEM, DS_DRAW_ITEM_BASE, DS_PROXY_VIEW_ITEM, EDA_ITEM, KIGFX::ORIGIN_VIEWITEM, PCB_GROUP, KIGFX::PREVIEW::ARC_ASSISTANT, KIGFX::PREVIEW::RULER_ITEM, KIGFX::PREVIEW::SIMPLE_OVERLAY_ITEM, KIGFX::PREVIEW::TWO_POINT_ASSISTANT, EDIT_POINTS, KIGFX::VIEW_GROUP, KIGFX::VIEW_OVERLAY, FOOTPRINT, FP_TEXT, FP_TEXTBOX, PAD, PCB_BITMAP, PCB_MARKER, PCB_TRACK, PCB_VIA, RATSNEST_VIEW_ITEM, ROUTER_PREVIEW_ITEM, ZONE, and MY_DRAWING.

Referenced by KIGFX::VIEW::Add(), KIGFX::VIEW::draw(), KIGFX::VIEW::invalidateItem(), KIGFX::VIEW::updateBbox(), and KIGFX::VIEW::updateLayers().

◆ ViewGetLOD()

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

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
aLayeris the current drawing layer.
aViewis 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 SCH_LINE, GERBER_DRAW_ITEM, PCB_GROUP, FOOTPRINT, FP_SHAPE, FP_TEXT, FP_TEXTBOX, PAD, PCB_BITMAP, PCB_SHAPE, PCB_TEXT, PCB_TEXTBOX, PCB_TRACK, PCB_VIA, ZONE, and FP_ZONE.

Definition at line 132 of file view_item.h.

133 {
134 // By default always show the item
135 return 0.0;
136 }

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

◆ viewPrivData()

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

Definition at line 138 of file view_item.h.

139 {
140 return m_viewPrivData;
141 }

References m_viewPrivData.

Referenced by KIGFX::VIEW::Add(), KIGFX::VIEW::draw(), KIGFX::VIEW::HasItem(), 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().

Friends And Related Function Documentation

◆ VIEW

friend class VIEW
friend

Definition at line 149 of file view_item.h.

Member Data Documentation

◆ m_viewPrivData

VIEW_ITEM_DATA* KIGFX::VIEW_ITEM::m_viewPrivData
private

Definition at line 151 of file view_item.h.

Referenced by KIGFX::VIEW::Add(), ClearViewPrivData(), viewPrivData(), and ~VIEW_ITEM().

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