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...
 
std::vector< int > getAllGroups () const
 Function getAllGroups() Returns all group ids for the item (collected from all layers the item occupies). 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 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::bitset< VIEW::VIEW_MAX_LAYERSm_layers
 Stores layer numbers used by the item. More...
 

Friends

class VIEW
 

Detailed Description

Definition at line 46 of file view.cpp.

Member Typedef Documentation

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

Helper for storing cached items group ids

Definition at line 96 of file view.cpp.

Constructor & Destructor Documentation

KIGFX::VIEW_ITEM_DATA::VIEW_ITEM_DATA ( )
inline

Definition at line 49 of file view.cpp.

49  :
50  m_view( nullptr ),
53  m_drawPriority( 0 ),
54  m_groups( nullptr ),
55  m_groupsSize( 0 ) {}
VIEW * m_view
Current dynamic view the item is assigned to.
Definition: view.cpp:90
int m_drawPriority
Order to draw this item in a layer, lowest first.
Definition: view.cpp:93
GroupPair * m_groups
Indexes of cached GAL display lists corresponding to the item (for every layer it occupies)...
Definition: view.cpp:100
int m_flags
Visibility flags.
Definition: view.cpp:91
int m_requiredUpdate
Flag required for updating.
Definition: view.cpp:92
KIGFX::VIEW_ITEM_DATA::~VIEW_ITEM_DATA ( )
inline

Definition at line 57 of file view.cpp.

References deleteGroups().

58  {
59  deleteGroups();
60  }
void deleteGroups()
Function deleteGroups() Removes all of the stored group ids.
Definition: view.cpp:176

Member Function Documentation

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

References KIGFX::NONE.

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

232  {
234  }
int m_requiredUpdate
Flag required for updating.
Definition: view.cpp:92
void KIGFX::VIEW_ITEM_DATA::deleteGroups ( )
inlineprivate

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

Forces recaching of the item.

Definition at line 176 of file view.cpp.

References m_groups.

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

177  {
178  delete[] m_groups;
179  m_groups = nullptr;
180  m_groupsSize = 0;
181  }
GroupPair * m_groups
Indexes of cached GAL display lists corresponding to the item (for every layer it occupies)...
Definition: view.cpp:100
std::vector<int> KIGFX::VIEW_ITEM_DATA::getAllGroups ( ) const
inlineprivate

Function getAllGroups() Returns all group ids for the item (collected from all layers the item occupies).

Returns
vector of group ids.

Definition at line 127 of file view.cpp.

References m_groupsSize.

128  {
129  std::vector<int> groups( m_groupsSize );
130 
131  for( int i = 0; i < m_groupsSize; ++i )
132  {
133  groups[i] = m_groups[i].second;
134  }
135 
136  return groups;
137  }
GroupPair * m_groups
Indexes of cached GAL display lists corresponding to the item (for every layer it occupies)...
Definition: view.cpp:100
int KIGFX::VIEW_ITEM_DATA::getFlags ( ) const
inline

Definition at line 62 of file view.cpp.

References m_flags.

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

63  {
64  return m_flags;
65  }
int m_flags
Visibility flags.
Definition: view.cpp:91
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 110 of file view.cpp.

References m_groupsSize.

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

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

References m_layers.

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

78  {
79  int* layersPtr = aLayers;
80 
81  for( unsigned int i = 0; i < m_layers.size(); ++i )
82  {
83  if( m_layers[i] )
84  *layersPtr++ = i;
85  }
86 
87  aCount = m_layers.count();
88  }
std::bitset< VIEW::VIEW_MAX_LAYERS > m_layers
Stores layer numbers used by the item.
Definition: view.cpp:196
bool KIGFX::VIEW_ITEM_DATA::isRenderable ( ) const
inlineprivate

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

Definition at line 240 of file view.cpp.

References KIGFX::VISIBLE.

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

241  {
242  return m_flags == VISIBLE;
243  }
int m_flags
Visibility flags.
Definition: view.cpp:91
int KIGFX::VIEW_ITEM_DATA::requiredUpdate ( ) const
inlineprivate

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

Definition at line 222 of file view.cpp.

References m_requiredUpdate.

223  {
224  return m_requiredUpdate;
225  }
int m_requiredUpdate
Flag required for updating.
Definition: view.cpp:92
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 205 of file view.cpp.

References KIGFX::VIEW::VIEW_MAX_LAYERS.

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

206  {
207  m_layers.reset();
208 
209  for( int i = 0; i < aCount; ++i )
210  {
211  // this fires on some eagle board after EAGLE_PLUGIN::Load()
212  wxASSERT( unsigned( aLayers[i] ) <= unsigned( VIEW::VIEW_MAX_LAYERS ) );
213 
214  m_layers.set( aLayers[i] );
215  }
216  }
static const int VIEW_MAX_LAYERS
maximum number of layers that may be shown
Definition: view.h:652
std::bitset< VIEW::VIEW_MAX_LAYERS > m_layers
Stores layer numbers used by the item.
Definition: view.cpp:196
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 146 of file view.cpp.

References m_groups, and m_groupsSize.

147  {
148  // Look if there is already an entry for the layer
149  for( int i = 0; i < m_groupsSize; ++i )
150  {
151  if( m_groups[i].first == aLayer )
152  {
153  m_groups[i].second = aGroup;
154  return;
155  }
156  }
157 
158  // If there was no entry for the given layer - create one
159  GroupPair* newGroups = new GroupPair[m_groupsSize + 1];
160 
161  if( m_groupsSize > 0 )
162  {
163  std::copy( m_groups, m_groups + m_groupsSize, newGroups );
164  delete[] m_groups;
165  }
166 
167  m_groups = newGroups;
168  newGroups[m_groupsSize++] = GroupPair( aLayer, aGroup );
169  }
GroupPair * m_groups
Indexes of cached GAL display lists corresponding to the item (for every layer it occupies)...
Definition: view.cpp:100
std::pair< int, int > GroupPair
Helper for storing cached items group ids
Definition: view.cpp:96
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 190 of file view.cpp.

191  {
192  return m_groupsSize > 0;
193  }

Friends And Related Function Documentation

friend class VIEW
friend

Definition at line 68 of file view.cpp.

Member Data Documentation

int KIGFX::VIEW_ITEM_DATA::m_drawPriority
private

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

Definition at line 93 of file view.cpp.

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

int KIGFX::VIEW_ITEM_DATA::m_flags
private

Visibility flags.

Definition at line 91 of file view.cpp.

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

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

Referenced by deleteGroups(), and setGroup().

int KIGFX::VIEW_ITEM_DATA::m_groupsSize
private

Definition at line 101 of file view.cpp.

Referenced by getAllGroups(), getGroup(), and setGroup().

std::bitset<VIEW::VIEW_MAX_LAYERS> KIGFX::VIEW_ITEM_DATA::m_layers
private

Stores layer numbers used by the item.

Definition at line 196 of file view.cpp.

Referenced by getLayers().

int KIGFX::VIEW_ITEM_DATA::m_requiredUpdate
private

Flag required for updating.

Definition at line 92 of file view.cpp.

Referenced by requiredUpdate().

VIEW* KIGFX::VIEW_ITEM_DATA::m_view
private

Current dynamic view the item is assigned to.

Definition at line 90 of file view.cpp.

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


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