KiCad PCB EDA Suite
KIGFX::VIEW_ITEM_DATA Class Reference

Public Member Functions

 VIEW_ITEM_DATA ()
 
 ~VIEW_ITEM_DATA ()
 
int getFlags () const
 

Private Types

typedef std::pair< int, int > GroupPair
 

Helper for storing cached items group ids

More...
 

Private Member Functions

void getLayers (int *aLayers, int &aCount) const
 Function getLayers() Returns layer numbers used by the item. More...
 
int getGroup (int aLayer) const
 Function getGroup() Returns number of the group id for the given layer, or -1 in case it was not cached before. More...
 
void setGroup (int aLayer, int aGroup)
 Function setGroup() Sets a group id for the item and the layer combination. More...
 
void deleteGroups ()
 Function deleteGroups() Removes all of the stored group ids. More...
 
bool storesGroups () const
 Function storesGroups() Returns information if the item uses at least one group id (ie. More...
 
void reorderGroups (std::unordered_map< int, int > aReorderMap)
 Reorders the stored groups (to facilitate reordering of layers) More...
 
void saveLayers (int *aLayers, int aCount)
 Function saveLayers() Saves layers used by the item. More...
 
int requiredUpdate () const
 Function viewRequiredUpdate() Returns current update flag for an item. More...
 
void clearUpdateFlags ()
 Function clearUpdateFlags() Marks an item as already updated, so it is not going to be redrawn. More...
 
bool isRenderable () const
 Function isRenderable() Returns if the item should be drawn or not. More...
 

Private Attributes

VIEWm_view
 Current dynamic view the item is assigned to. More...
 
int m_flags
 Visibility flags. More...
 
int m_requiredUpdate
 Flag required for updating. More...
 
int m_drawPriority
 Order to draw this item in a layer, lowest first. More...
 
GroupPairm_groups
 

Indexes of cached GAL display lists corresponding to the item (for every layer it occupies).

More...
 
int m_groupsSize
 
std::vector< int > m_layers
 Stores layer numbers used by the item. More...
 

Friends

class VIEW
 

Detailed Description

Definition at line 48 of file view.cpp.

Member Typedef Documentation

◆ GroupPair

typedef std::pair<int, int> KIGFX::VIEW_ITEM_DATA::GroupPair
private

Helper for storing cached items group ids

Definition at line 95 of file view.cpp.

Constructor & Destructor Documentation

◆ VIEW_ITEM_DATA()

KIGFX::VIEW_ITEM_DATA::VIEW_ITEM_DATA ( )
inline

Definition at line 51 of file view.cpp.

51  :
52  m_view( nullptr ),
55  m_drawPriority( 0 ),
56  m_groups( nullptr ),
57  m_groupsSize( 0 ) {}
VIEW * m_view
Current dynamic view the item is assigned to.
Definition: view.cpp:89
int m_drawPriority
Order to draw this item in a layer, lowest first.
Definition: view.cpp:92
GroupPair * m_groups
Indexes of cached GAL display lists corresponding to the item (for every layer it occupies).
Definition: view.cpp:99
int m_flags
Visibility flags.
Definition: view.cpp:90
int m_requiredUpdate
Flag required for updating.
Definition: view.cpp:91

◆ ~VIEW_ITEM_DATA()

KIGFX::VIEW_ITEM_DATA::~VIEW_ITEM_DATA ( )
inline

Definition at line 59 of file view.cpp.

60  {
61  deleteGroups();
62  }
void deleteGroups()
Function deleteGroups() Removes all of the stored group ids.
Definition: view.cpp:157

References deleteGroups().

Member Function Documentation

◆ clearUpdateFlags()

void KIGFX::VIEW_ITEM_DATA::clearUpdateFlags ( )
inlineprivate

Function clearUpdateFlags() Marks an item as already updated, so it is not going to be redrawn.

Definition at line 237 of file view.cpp.

238  {
240  }
int m_requiredUpdate
Flag required for updating.
Definition: view.cpp:91

References m_requiredUpdate, and KIGFX::NONE.

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

◆ deleteGroups()

void KIGFX::VIEW_ITEM_DATA::deleteGroups ( )
inlineprivate

Function deleteGroups() Removes all of the stored group ids.

Forces recaching of the item.

Definition at line 157 of file view.cpp.

158  {
159  delete[] m_groups;
160  m_groups = nullptr;
161  m_groupsSize = 0;
162  }
GroupPair * m_groups
Indexes of cached GAL display lists corresponding to the item (for every layer it occupies).
Definition: view.cpp:99

References m_groups, and m_groupsSize.

Referenced by KIGFX::VIEW::clearLayerCache::operator()(), and ~VIEW_ITEM_DATA().

◆ getFlags()

int KIGFX::VIEW_ITEM_DATA::getFlags ( ) const
inline

Definition at line 64 of file view.cpp.

65  {
66  return m_flags;
67  }
int m_flags
Visibility flags.
Definition: view.cpp:90

References m_flags.

Referenced by KIGFX::queryVisitor< Container >::operator()().

◆ getGroup()

int KIGFX::VIEW_ITEM_DATA::getGroup ( int  aLayer) const
inlineprivate

Function getGroup() Returns number of the group id for the given layer, or -1 in case it was not cached before.

Parameters
aLayeris the layer number for which group id is queried.
Returns
group id or -1 in case there is no group id (ie. item is not cached).

Definition at line 109 of file view.cpp.

110  {
111  for( int i = 0; i < m_groupsSize; ++i )
112  {
113  if( m_groups[i].first == aLayer )
114  return m_groups[i].second;
115  }
116 
117  return -1;
118  }
GroupPair * m_groups
Indexes of cached GAL display lists corresponding to the item (for every layer it occupies).
Definition: view.cpp:99

References m_groups, and m_groupsSize.

Referenced by KIGFX::VIEW::draw(), KIGFX::VIEW::updateItemsColor::operator()(), KIGFX::VIEW::changeItemsDepth::operator()(), and KIGFX::VIEW::recacheItem::operator()().

◆ getLayers()

void KIGFX::VIEW_ITEM_DATA::getLayers ( int *  aLayers,
int &  aCount 
) const
inlineprivate

Function getLayers() Returns layer numbers used by the item.

Parameters
aLayers[]output layer index array
aCountnumber of layer indices in aLayers[]

Definition at line 79 of file view.cpp.

80  {
81  int* layersPtr = aLayers;
82 
83  for( auto layer : m_layers )
84  *layersPtr++ = layer;
85 
86  aCount = m_layers.size();
87  }
std::vector< int > m_layers
Stores layer numbers used by the item.
Definition: view.cpp:202

References m_layers.

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

◆ isRenderable()

bool KIGFX::VIEW_ITEM_DATA::isRenderable ( ) const
inlineprivate

Function isRenderable() Returns if the item should be drawn or not.

Definition at line 246 of file view.cpp.

247  {
248  return m_flags == VISIBLE;
249  }
int m_flags
Visibility flags.
Definition: view.cpp:90

References m_flags, and KIGFX::VISIBLE.

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

◆ reorderGroups()

void KIGFX::VIEW_ITEM_DATA::reorderGroups ( std::unordered_map< int, int >  aReorderMap)
inlineprivate

Reorders the stored groups (to facilitate reordering of layers)

See also
VIEW::ReorderLayerData
Parameters
aReorderMapis the mapping of old to new layer ids

Definition at line 183 of file view.cpp.

184  {
185  for( int i = 0; i < m_groupsSize; ++i )
186  {
187  int orig_layer = m_groups[i].first;
188  int new_layer = orig_layer;
189 
190  try
191  {
192  new_layer = aReorderMap.at( orig_layer );
193  }
194  catch( const std::out_of_range& ) {}
195 
196  m_groups[i].first = new_layer;
197  }
198  }
GroupPair * m_groups
Indexes of cached GAL display lists corresponding to the item (for every layer it occupies).
Definition: view.cpp:99

References m_groups, and m_groupsSize.

◆ requiredUpdate()

int KIGFX::VIEW_ITEM_DATA::requiredUpdate ( ) const
inlineprivate

Function viewRequiredUpdate() Returns current update flag for an item.

Definition at line 228 of file view.cpp.

229  {
230  return m_requiredUpdate;
231  }
int m_requiredUpdate
Flag required for updating.
Definition: view.cpp:91

References m_requiredUpdate.

◆ saveLayers()

void KIGFX::VIEW_ITEM_DATA::saveLayers ( int *  aLayers,
int  aCount 
)
inlineprivate

Function saveLayers() Saves layers used by the item.

Parameters
aLayersis an array containing layer numbers to be saved.
aCountis the size of the array.

Definition at line 211 of file view.cpp.

212  {
213  m_layers.clear();
214 
215  for( int i = 0; i < aCount; ++i )
216  {
217  // this fires on some eagle board after EAGLE_PLUGIN::Load()
218  wxASSERT( unsigned( aLayers[i] ) <= unsigned( VIEW::VIEW_MAX_LAYERS ) );
219 
220  m_layers.push_back( aLayers[i] );
221  }
222  }
static constexpr int VIEW_MAX_LAYERS
maximum number of layers that may be shown
Definition: view.h:694
std::vector< int > m_layers
Stores layer numbers used by the item.
Definition: view.cpp:202

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

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

◆ setGroup()

void KIGFX::VIEW_ITEM_DATA::setGroup ( int  aLayer,
int  aGroup 
)
inlineprivate

Function setGroup() Sets a group id for the item and the layer combination.

Parameters
aLayeris the layer numbe.
aGroupis the group id.

Definition at line 127 of file view.cpp.

128  {
129  // Look if there is already an entry for the layer
130  for( int i = 0; i < m_groupsSize; ++i )
131  {
132  if( m_groups[i].first == aLayer )
133  {
134  m_groups[i].second = aGroup;
135  return;
136  }
137  }
138 
139  // If there was no entry for the given layer - create one
140  GroupPair* newGroups = new GroupPair[m_groupsSize + 1];
141 
142  if( m_groupsSize > 0 )
143  {
144  std::copy( m_groups, m_groups + m_groupsSize, newGroups );
145  delete[] m_groups;
146  }
147 
148  m_groups = newGroups;
149  newGroups[m_groupsSize++] = GroupPair( aLayer, aGroup );
150  }
GroupPair * m_groups
Indexes of cached GAL display lists corresponding to the item (for every layer it occupies).
Definition: view.cpp:99
std::pair< int, int > GroupPair
Helper for storing cached items group ids
Definition: view.cpp:95

References m_groups, and m_groupsSize.

◆ storesGroups()

bool KIGFX::VIEW_ITEM_DATA::storesGroups ( ) const
inlineprivate

Function storesGroups() Returns information if the item uses at least one group id (ie.

if it is cached at all).

Returns
true in case it is cached at least for one layer.

Definition at line 171 of file view.cpp.

172  {
173  return m_groupsSize > 0;
174  }

References m_groupsSize.

Friends And Related Function Documentation

◆ VIEW

friend class VIEW
friend

Definition at line 70 of file view.cpp.

Member Data Documentation

◆ m_drawPriority

int KIGFX::VIEW_ITEM_DATA::m_drawPriority
private

Order to draw this item in a layer, lowest first.

Definition at line 92 of file view.cpp.

Referenced by KIGFX::VIEW::Add(), and KIGFX::VIEW::drawItem::deferredDraw().

◆ m_flags

int KIGFX::VIEW_ITEM_DATA::m_flags
private

Visibility flags.

Definition at line 90 of file view.cpp.

Referenced by getFlags(), KIGFX::VIEW::Hide(), isRenderable(), and KIGFX::VIEW::SetVisible().

◆ m_groups

GroupPair* KIGFX::VIEW_ITEM_DATA::m_groups
private

Indexes of cached GAL display lists corresponding to the item (for every layer it occupies).

(in the std::pair "first" stores layer number, "second" stores group id).

Definition at line 99 of file view.cpp.

Referenced by deleteGroups(), getGroup(), reorderGroups(), and setGroup().

◆ m_groupsSize

int KIGFX::VIEW_ITEM_DATA::m_groupsSize
private

Definition at line 100 of file view.cpp.

Referenced by deleteGroups(), getGroup(), reorderGroups(), setGroup(), and storesGroups().

◆ m_layers

std::vector<int> KIGFX::VIEW_ITEM_DATA::m_layers
private

Stores layer numbers used by the item.

Definition at line 202 of file view.cpp.

Referenced by getLayers(), and saveLayers().

◆ m_requiredUpdate

int KIGFX::VIEW_ITEM_DATA::m_requiredUpdate
private

Flag required for updating.

Definition at line 91 of file view.cpp.

Referenced by clearUpdateFlags(), requiredUpdate(), and KIGFX::VIEW::Update().

◆ m_view

VIEW* KIGFX::VIEW_ITEM_DATA::m_view
private

Current dynamic view the item is assigned to.

Definition at line 89 of file view.cpp.

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


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