KiCad PCB EDA Suite
WS_DATA_ITEM Class Reference

Work sheet structure type definitions. More...

#include <ws_data_item.h>

Inheritance diagram for WS_DATA_ITEM:
WS_DATA_ITEM_BITMAP WS_DATA_ITEM_POLYGONS WS_DATA_ITEM_TEXT

Public Types

enum  WS_ITEM_TYPE {
  WS_TEXT, WS_SEGMENT, WS_RECT, WS_POLYPOLYGON,
  WS_BITMAP
}
 

Public Member Functions

 WS_DATA_ITEM (WS_ITEM_TYPE aType)
 
virtual ~WS_DATA_ITEM ()
 
const std::vector< WS_DRAW_ITEM_BASE * > & GetDrawItems () const
 
virtual void SyncDrawItems (WS_DRAW_ITEM_LIST *aCollector, KIGFX::VIEW *aView)
 
void SetStart (double aPosx, double aPosy, enum CORNER_ANCHOR aAnchor=RB_CORNER)
 
void SetEnd (double aPosx, double aPosy, enum CORNER_ANCHOR aAnchor=RB_CORNER)
 
WS_ITEM_TYPE GetType () const
 
PAGE_OPTION GetPage1Option () const
 
void SetPage1Option (PAGE_OPTION aChoice)
 
const wxPoint GetStartPosUi (int ii=0) const
 
const wxPoint GetEndPosUi (int ii=0) const
 
const DPOINT GetStartPos (int ii=0) const
 
const DPOINT GetEndPos (int ii=0) const
 
virtual int GetPenSizeUi ()
 
void MoveTo (DPOINT aPosition)
 move item to a new position More...
 
void MoveToUi (wxPoint aPosition)
 move item to a new position More...
 
void MoveStartPointTo (DPOINT aPosition)
 move the starting point of the item to a new position More...
 
void MoveStartPointToUi (wxPoint aPosition)
 move the starting point of the item to a new position More...
 
void MoveEndPointTo (DPOINT aPosition)
 move the ending point of the item to a new position has meaning only for items defined by 2 points (segments and rectangles) More...
 
void MoveEndPointToUi (wxPoint aPosition)
 move the ending point of the item to a new position has meaning only for items defined by 2 points (segments and rectangles) More...
 
virtual bool IsInsidePage (int ii) const
 
const wxString GetClassName () const
 

Public Attributes

wxString m_Name
 
wxString m_Info
 
POINT_COORD m_Pos
 
POINT_COORD m_End
 
double m_LineWidth
 
int m_RepeatCount
 
DPOINT m_IncrementVector
 
int m_IncrementLabel
 

Protected Attributes

WS_ITEM_TYPE m_type
 
PAGE_OPTION m_pageOption
 
std::vector< WS_DRAW_ITEM_BASE * > m_drawItems
 

Detailed Description

Work sheet structure type definitions.

Basic items are:

  • segment and rect (defined by 2 points)
  • text (defined by a coordinate), the text and its justifications
  • poly polygon defined by a coordinate, and a set of list of corners ( because we use it for logos, there are more than one polygon in this description

Definition at line 93 of file ws_data_item.h.

Member Enumeration Documentation

◆ WS_ITEM_TYPE

Enumerator
WS_TEXT 
WS_SEGMENT 
WS_RECT 
WS_POLYPOLYGON 
WS_BITMAP 

Definition at line 96 of file ws_data_item.h.

Constructor & Destructor Documentation

◆ WS_DATA_ITEM()

WS_DATA_ITEM::WS_DATA_ITEM ( WS_ITEM_TYPE  aType)

Definition at line 65 of file ws_data_item.cpp.

66 {
68  m_type = aType;
69  m_RepeatCount = 1;
70  m_IncrementLabel = 1;
71  m_LineWidth = 0;
72 }
WS_ITEM_TYPE m_type
Definition: ws_data_item.h:105
double m_LineWidth
Definition: ws_data_item.h:117
int m_IncrementLabel
Definition: ws_data_item.h:121
PAGE_OPTION m_pageOption
Definition: ws_data_item.h:106

References ALL_PAGES, m_IncrementLabel, m_LineWidth, m_pageOption, m_RepeatCount, and m_type.

◆ ~WS_DATA_ITEM()

virtual WS_DATA_ITEM::~WS_DATA_ITEM ( )
inlinevirtual

Definition at line 126 of file ws_data_item.h.

126 {}

Member Function Documentation

◆ GetClassName()

const wxString WS_DATA_ITEM::GetClassName ( ) const

Definition at line 375 of file ws_data_item.cpp.

376 {
377  wxString name;
378 
379  switch( GetType() )
380  {
381  case WS_TEXT: name = wxT( "Text" ); break;
382  case WS_SEGMENT: name = wxT( "Line" ); break;
383  case WS_RECT: name = wxT( "Rectangle" ); break;
384  case WS_POLYPOLYGON: name = wxT( "Imported Shape" ); break;
385  case WS_BITMAP: name = wxT( "Image" ); break;
386  }
387 
388  return name;
389 }
WS_ITEM_TYPE GetType() const
Definition: ws_data_item.h:147
const char * name
Definition: DXF_plotter.cpp:61

References GetType(), name, WS_BITMAP, WS_POLYPOLYGON, WS_RECT, WS_SEGMENT, and WS_TEXT.

Referenced by PROPERTIES_FRAME::CopyPrmsFromItemToPanel().

◆ GetDrawItems()

const std::vector<WS_DRAW_ITEM_BASE*>& WS_DATA_ITEM::GetDrawItems ( ) const
inline

◆ GetEndPos()

const DPOINT WS_DATA_ITEM::GetEndPos ( int  ii = 0) const

Definition at line 316 of file ws_data_item.cpp.

317 {
318  DPOINT pos( m_End.m_Pos.x + ( m_IncrementVector.x * ii ),
319  m_End.m_Pos.y + ( m_IncrementVector.y * ii ) );
320 
321  switch( m_End.m_Anchor )
322  {
323  case RB_CORNER: // right bottom corner
325  break;
326 
327  case RT_CORNER: // right top corner
328  pos.x = WS_DATA_MODEL::GetTheInstance().m_RB_Corner.x - pos.x;
329  pos.y = WS_DATA_MODEL::GetTheInstance().m_LT_Corner.y + pos.y;
330  break;
331 
332  case LB_CORNER: // left bottom corner
333  pos.x = WS_DATA_MODEL::GetTheInstance().m_LT_Corner.x + pos.x;
334  pos.y = WS_DATA_MODEL::GetTheInstance().m_RB_Corner.y - pos.y;
335  break;
336 
337  case LT_CORNER: // left top corner
339  break;
340  }
341 
342  return pos;
343 }
DPOINT m_RB_Corner
Definition: ws_data_model.h:53
POINT_COORD m_End
Definition: ws_data_item.h:116
DPOINT m_LT_Corner
Definition: ws_data_model.h:54
static WS_DATA_MODEL & GetTheInstance()
static function: returns the instance of WS_DATA_MODEL used in the application
DPOINT m_Pos
Definition: ws_data_item.h:71
DPOINT m_IncrementVector
Definition: ws_data_item.h:119

References WS_DATA_MODEL::GetTheInstance(), LB_CORNER, LT_CORNER, POINT_COORD::m_Anchor, m_End, m_IncrementVector, WS_DATA_MODEL::m_LT_Corner, POINT_COORD::m_Pos, WS_DATA_MODEL::m_RB_Corner, RB_CORNER, RT_CORNER, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by GetEndPosUi(), IsInsidePage(), and MoveTo().

◆ GetEndPosUi()

const wxPoint WS_DATA_ITEM::GetEndPosUi ( int  ii = 0) const

Definition at line 346 of file ws_data_item.cpp.

347 {
348  DPOINT pos = GetEndPos( ii );
350  return wxPoint( KiROUND( pos.x ), KiROUND( pos.y ) );
351 }
static WS_DATA_MODEL & GetTheInstance()
static function: returns the instance of WS_DATA_MODEL used in the application
const DPOINT GetEndPos(int ii=0) const
double m_WSunits2Iu
Definition: ws_data_model.h:51
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: common.h:114

References GetEndPos(), WS_DATA_MODEL::GetTheInstance(), KiROUND(), WS_DATA_MODEL::m_WSunits2Iu, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by MoveTo(), and SyncDrawItems().

◆ GetPage1Option()

PAGE_OPTION WS_DATA_ITEM::GetPage1Option ( ) const
inline
Returns
true if the item has a end point (segment; rect) of false (text, polugon)

Definition at line 153 of file ws_data_item.h.

153 { return m_pageOption; }
PAGE_OPTION m_pageOption
Definition: ws_data_item.h:106

References m_pageOption.

Referenced by PROPERTIES_FRAME::CopyPrmsFromItemToPanel(), WS_DATA_MODEL_IO::formatOptions(), WS_DRAW_ITEM_BASE::GetMsgPanelInfo(), and WS_DRAW_ITEM_BASE::ViewGetLayers().

◆ GetPenSizeUi()

int WS_DATA_ITEM::GetPenSizeUi ( )
virtual

Reimplemented in WS_DATA_ITEM_TEXT, and WS_DATA_ITEM_POLYGONS.

Definition at line 123 of file ws_data_item.cpp.

124 {
126 
127  if( m_LineWidth != 0 )
128  return KiROUND( m_LineWidth * model.m_WSunits2Iu );
129  else
130  return KiROUND( model.m_DefaultLineWidth * model.m_WSunits2Iu );
131 }
WS_DATA_MODEL handles the graphic items list to draw/plot the frame and title block.
Definition: ws_data_model.h:39
static WS_DATA_MODEL & GetTheInstance()
static function: returns the instance of WS_DATA_MODEL used in the application
double m_LineWidth
Definition: ws_data_item.h:117
double m_DefaultLineWidth
Definition: ws_data_model.h:55
double m_WSunits2Iu
Definition: ws_data_model.h:51
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: common.h:114

References WS_DATA_MODEL::GetTheInstance(), KiROUND(), WS_DATA_MODEL::m_DefaultLineWidth, m_LineWidth, and WS_DATA_MODEL::m_WSunits2Iu.

Referenced by SyncDrawItems().

◆ GetStartPos()

const DPOINT WS_DATA_ITEM::GetStartPos ( int  ii = 0) const

Definition at line 278 of file ws_data_item.cpp.

279 {
281  DPOINT pos( m_Pos.m_Pos.x + ( m_IncrementVector.x * ii ),
282  m_Pos.m_Pos.y + ( m_IncrementVector.y * ii ) );
283 
284  switch( m_Pos.m_Anchor )
285  {
286  case RB_CORNER: // right bottom corner
287  pos = model.m_RB_Corner - pos;
288  break;
289 
290  case RT_CORNER: // right top corner
291  pos.x = model.m_RB_Corner.x - pos.x;
292  pos.y = model.m_LT_Corner.y + pos.y;
293  break;
294 
295  case LB_CORNER: // left bottom corner
296  pos.x = model.m_LT_Corner.x + pos.x;
297  pos.y = model.m_RB_Corner.y - pos.y;
298  break;
299 
300  case LT_CORNER: // left top corner
301  pos = model.m_LT_Corner + pos;
302  break;
303  }
304 
305  return pos;
306 }
WS_DATA_MODEL handles the graphic items list to draw/plot the frame and title block.
Definition: ws_data_model.h:39
DPOINT m_RB_Corner
Definition: ws_data_model.h:53
DPOINT m_LT_Corner
Definition: ws_data_model.h:54
static WS_DATA_MODEL & GetTheInstance()
static function: returns the instance of WS_DATA_MODEL used in the application
DPOINT m_Pos
Definition: ws_data_item.h:71
DPOINT m_IncrementVector
Definition: ws_data_item.h:119
POINT_COORD m_Pos
Definition: ws_data_item.h:115

References WS_DATA_MODEL::GetTheInstance(), LB_CORNER, LT_CORNER, POINT_COORD::m_Anchor, m_IncrementVector, WS_DATA_MODEL::m_LT_Corner, POINT_COORD::m_Pos, m_Pos, WS_DATA_MODEL::m_RB_Corner, RB_CORNER, RT_CORNER, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by WS_DATA_ITEM_POLYGONS::GetCornerPosition(), GetStartPosUi(), IsInsidePage(), WS_DATA_ITEM_POLYGONS::IsInsidePage(), and MoveTo().

◆ GetStartPosUi()

const wxPoint WS_DATA_ITEM::GetStartPosUi ( int  ii = 0) const

Definition at line 309 of file ws_data_item.cpp.

310 {
312  return wxPoint( KiROUND( pos.x ), KiROUND( pos.y ) );
313 }
const DPOINT GetStartPos(int ii=0) const
static WS_DATA_MODEL & GetTheInstance()
static function: returns the instance of WS_DATA_MODEL used in the application
double m_WSunits2Iu
Definition: ws_data_model.h:51
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: common.h:114

References GetStartPos(), WS_DATA_MODEL::GetTheInstance(), KiROUND(), WS_DATA_MODEL::m_WSunits2Iu, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by PL_EDIT_TOOL::moveItem(), MoveTo(), PL_DRAWING_TOOLS::PlaceItem(), SyncDrawItems(), WS_DATA_ITEM_POLYGONS::SyncDrawItems(), WS_DATA_ITEM_TEXT::SyncDrawItems(), and WS_DATA_ITEM_BITMAP::SyncDrawItems().

◆ GetType()

◆ IsInsidePage()

bool WS_DATA_ITEM::IsInsidePage ( int  ii) const
virtual
Returns
true if the item is inside the rectangle defined by the 4 corners, false otherwise.

Reimplemented in WS_DATA_ITEM_POLYGONS.

Definition at line 354 of file ws_data_item.cpp.

355 {
357 
358  DPOINT pos = GetStartPos( ii );
359 
360  for( int kk = 0; kk < 1; kk++ )
361  {
362  if( model.m_RB_Corner.x < pos.x || model.m_LT_Corner.x > pos.x )
363  return false;
364 
365  if( model.m_RB_Corner.y < pos.y || model.m_LT_Corner.y > pos.y )
366  return false;
367 
368  pos = GetEndPos( ii );
369  }
370 
371  return true;
372 }
WS_DATA_MODEL handles the graphic items list to draw/plot the frame and title block.
Definition: ws_data_model.h:39
DPOINT m_RB_Corner
Definition: ws_data_model.h:53
const DPOINT GetStartPos(int ii=0) const
DPOINT m_LT_Corner
Definition: ws_data_model.h:54
static WS_DATA_MODEL & GetTheInstance()
static function: returns the instance of WS_DATA_MODEL used in the application
const DPOINT GetEndPos(int ii=0) const

References GetEndPos(), GetStartPos(), WS_DATA_MODEL::GetTheInstance(), WS_DATA_MODEL::m_LT_Corner, WS_DATA_MODEL::m_RB_Corner, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by SyncDrawItems(), WS_DATA_ITEM_TEXT::SyncDrawItems(), and WS_DATA_ITEM_BITMAP::SyncDrawItems().

◆ MoveEndPointTo()

void WS_DATA_ITEM::MoveEndPointTo ( DPOINT  aPosition)

move the ending point of the item to a new position has meaning only for items defined by 2 points (segments and rectangles)

move the ending point of the item to a new position has meaning only for items defined by 2 points (segments and rectangles) aPosition = the new position of the ending point, in mm

Parameters
aPosition= the new position of the ending point, in mm

Definition at line 220 of file ws_data_item.cpp.

221 {
223  DPOINT position;
224 
225  // Calculate the position of the starting point
226  // relative to the reference corner
227  // aPosition is the position relative to the right top paper corner
228  switch( m_End.m_Anchor )
229  {
230  case RB_CORNER:
231  position = model.m_RB_Corner - aPosition;
232  break;
233 
234  case RT_CORNER:
235  position.x = model.m_RB_Corner.x - aPosition.x;
236  position.y = aPosition.y - model.m_LT_Corner.y;
237  break;
238 
239  case LB_CORNER:
240  position.x = aPosition.x - model.m_LT_Corner.x;
241  position.y = model.m_RB_Corner.y - aPosition.y;
242  break;
243 
244  case LT_CORNER:
245  position = aPosition - model.m_LT_Corner;
246  break;
247  }
248 
249  // Modify m_End only for items having 2 coordinates
250  switch( GetType() )
251  {
252  case WS_SEGMENT:
253  case WS_RECT:
254  m_End.m_Pos = position;
255  break;
256 
257  default:
258  break;
259  }
260 }
WS_DATA_MODEL handles the graphic items list to draw/plot the frame and title block.
Definition: ws_data_model.h:39
DPOINT m_RB_Corner
Definition: ws_data_model.h:53
POINT_COORD m_End
Definition: ws_data_item.h:116
DPOINT m_LT_Corner
Definition: ws_data_model.h:54
static WS_DATA_MODEL & GetTheInstance()
static function: returns the instance of WS_DATA_MODEL used in the application
DPOINT m_Pos
Definition: ws_data_item.h:71
WS_ITEM_TYPE GetType() const
Definition: ws_data_item.h:147

References WS_DATA_MODEL::GetTheInstance(), GetType(), LB_CORNER, LT_CORNER, POINT_COORD::m_Anchor, m_End, WS_DATA_MODEL::m_LT_Corner, POINT_COORD::m_Pos, WS_DATA_MODEL::m_RB_Corner, RB_CORNER, RT_CORNER, WS_RECT, WS_SEGMENT, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by MoveEndPointToUi(), and MoveTo().

◆ MoveEndPointToUi()

void WS_DATA_ITEM::MoveEndPointToUi ( wxPoint  aPosition)

move the ending point of the item to a new position has meaning only for items defined by 2 points (segments and rectangles)

Parameters
aPosition= the new position of the ending point in graphic units

Definition at line 268 of file ws_data_item.cpp.

269 {
270  DPOINT pos_mm;
271  pos_mm.x = aPosition.x / WS_DATA_MODEL::GetTheInstance().m_WSunits2Iu;
272  pos_mm.y = aPosition.y / WS_DATA_MODEL::GetTheInstance().m_WSunits2Iu;
273 
274  MoveEndPointTo( pos_mm );
275 }
void MoveEndPointTo(DPOINT aPosition)
move the ending point of the item to a new position has meaning only for items defined by 2 points (s...
static WS_DATA_MODEL & GetTheInstance()
static function: returns the instance of WS_DATA_MODEL used in the application
double m_WSunits2Iu
Definition: ws_data_model.h:51

References WS_DATA_MODEL::GetTheInstance(), WS_DATA_MODEL::m_WSunits2Iu, MoveEndPointTo(), VECTOR2< T >::x, and VECTOR2< T >::y.

◆ MoveStartPointTo()

void WS_DATA_ITEM::MoveStartPointTo ( DPOINT  aPosition)

move the starting point of the item to a new position

Parameters
aPosition= the new position of the starting point, in mm

Definition at line 169 of file ws_data_item.cpp.

170 {
172  DPOINT position;
173 
174  // Calculate the position of the starting point
175  // relative to the reference corner
176  // aPosition is the position relative to the right top paper corner
177  switch( m_Pos.m_Anchor )
178  {
179  case RB_CORNER:
180  position = model.m_RB_Corner - aPosition;
181  break;
182 
183  case RT_CORNER:
184  position.x = model.m_RB_Corner.x - aPosition.x;
185  position.y = aPosition.y - model.m_LT_Corner.y;
186  break;
187 
188  case LB_CORNER:
189  position.x = aPosition.x - model.m_LT_Corner.x;
190  position.y = model.m_RB_Corner.y - aPosition.y;
191  break;
192 
193  case LT_CORNER:
194  position = aPosition - model.m_LT_Corner;
195  break;
196  }
197 
198  m_Pos.m_Pos = position;
199 }
WS_DATA_MODEL handles the graphic items list to draw/plot the frame and title block.
Definition: ws_data_model.h:39
DPOINT m_RB_Corner
Definition: ws_data_model.h:53
DPOINT m_LT_Corner
Definition: ws_data_model.h:54
static WS_DATA_MODEL & GetTheInstance()
static function: returns the instance of WS_DATA_MODEL used in the application
DPOINT m_Pos
Definition: ws_data_item.h:71
POINT_COORD m_Pos
Definition: ws_data_item.h:115

References WS_DATA_MODEL::GetTheInstance(), LB_CORNER, LT_CORNER, POINT_COORD::m_Anchor, WS_DATA_MODEL::m_LT_Corner, POINT_COORD::m_Pos, m_Pos, WS_DATA_MODEL::m_RB_Corner, RB_CORNER, RT_CORNER, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by MoveStartPointToUi(), and MoveTo().

◆ MoveStartPointToUi()

void WS_DATA_ITEM::MoveStartPointToUi ( wxPoint  aPosition)

move the starting point of the item to a new position

Parameters
aPosition= the new position of item in graphic units

Definition at line 205 of file ws_data_item.cpp.

206 {
207  DPOINT pos_mm( aPosition.x / WS_DATA_MODEL::GetTheInstance().m_WSunits2Iu,
209 
210  MoveStartPointTo( pos_mm );
211 }
void MoveStartPointTo(DPOINT aPosition)
move the starting point of the item to a new position
static WS_DATA_MODEL & GetTheInstance()
static function: returns the instance of WS_DATA_MODEL used in the application
double m_WSunits2Iu
Definition: ws_data_model.h:51

References WS_DATA_MODEL::GetTheInstance(), WS_DATA_MODEL::m_WSunits2Iu, and MoveStartPointTo().

Referenced by PL_DRAWING_TOOLS::PlaceItem().

◆ MoveTo()

void WS_DATA_ITEM::MoveTo ( DPOINT  aPosition)

move item to a new position

Parameters
aPosition= the new position of item, in mm

Definition at line 150 of file ws_data_item.cpp.

151 {
152  DPOINT vector = aPosition - GetStartPos();
153  DPOINT endpos = vector + GetEndPos();
154 
155  MoveStartPointTo( aPosition );
156  MoveEndPointTo( endpos );
157 
158  for( WS_DRAW_ITEM_BASE* drawItem : m_drawItems )
159  {
160  drawItem->SetPosition( GetStartPosUi( drawItem->GetIndexInPeer() ) );
161  drawItem->SetEnd( GetEndPosUi( drawItem->GetIndexInPeer() ) );
162  }
163 }
const DPOINT GetStartPos(int ii=0) const
void MoveEndPointTo(DPOINT aPosition)
move the ending point of the item to a new position has meaning only for items defined by 2 points (s...
void MoveStartPointTo(DPOINT aPosition)
move the starting point of the item to a new position
const wxPoint GetStartPosUi(int ii=0) const
const DPOINT GetEndPos(int ii=0) const
std::vector< WS_DRAW_ITEM_BASE * > m_drawItems
Definition: ws_data_item.h:108
const wxPoint GetEndPosUi(int ii=0) const

References GetEndPos(), GetEndPosUi(), GetStartPos(), GetStartPosUi(), m_drawItems, MoveEndPointTo(), and MoveStartPointTo().

Referenced by MoveToUi().

◆ MoveToUi()

void WS_DATA_ITEM::MoveToUi ( wxPoint  aPosition)

move item to a new position

Parameters
aPosition= the new position of the starting point in graphic units

Definition at line 140 of file ws_data_item.cpp.

141 {
142  DPOINT pos_mm;
143  pos_mm.x = aPosition.x / WS_DATA_MODEL::GetTheInstance().m_WSunits2Iu;
144  pos_mm.y = aPosition.y / WS_DATA_MODEL::GetTheInstance().m_WSunits2Iu;
145 
146  MoveTo( pos_mm );
147 }
static WS_DATA_MODEL & GetTheInstance()
static function: returns the instance of WS_DATA_MODEL used in the application
double m_WSunits2Iu
Definition: ws_data_model.h:51
void MoveTo(DPOINT aPosition)
move item to a new position

References WS_DATA_MODEL::GetTheInstance(), WS_DATA_MODEL::m_WSunits2Iu, MoveTo(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by PL_DRAWING_TOOLS::DrawShape(), and PL_EDIT_TOOL::moveItem().

◆ SetEnd()

void WS_DATA_ITEM::SetEnd ( double  aPosx,
double  aPosy,
enum CORNER_ANCHOR  aAnchor = RB_CORNER 
)
inline

Definition at line 139 of file ws_data_item.h.

140  {
141  m_End.m_Pos.x = aPosx;
142  m_End.m_Pos.y = aPosy;
143  m_End.m_Anchor = aAnchor;
144  }
POINT_COORD m_End
Definition: ws_data_item.h:116
DPOINT m_Pos
Definition: ws_data_item.h:71

References POINT_COORD::m_Anchor, m_End, POINT_COORD::m_Pos, VECTOR2< T >::x, and VECTOR2< T >::y.

◆ SetPage1Option()

void WS_DATA_ITEM::SetPage1Option ( PAGE_OPTION  aChoice)
inline

Definition at line 154 of file ws_data_item.h.

154 { m_pageOption = aChoice; }
PAGE_OPTION m_pageOption
Definition: ws_data_item.h:106

References m_pageOption.

Referenced by PROPERTIES_FRAME::CopyPrmsFromPanelToItem(), and PAGE_LAYOUT_READER_PARSER::readOption().

◆ SetStart()

void WS_DATA_ITEM::SetStart ( double  aPosx,
double  aPosy,
enum CORNER_ANCHOR  aAnchor = RB_CORNER 
)
inline

Definition at line 132 of file ws_data_item.h.

133  {
134  m_Pos.m_Pos.x = aPosx;
135  m_Pos.m_Pos.y = aPosy;
136  m_Pos.m_Anchor = aAnchor;
137  }
DPOINT m_Pos
Definition: ws_data_item.h:71
POINT_COORD m_Pos
Definition: ws_data_item.h:115

References POINT_COORD::m_Anchor, POINT_COORD::m_Pos, m_Pos, VECTOR2< T >::x, and VECTOR2< T >::y.

◆ SyncDrawItems()

void WS_DATA_ITEM::SyncDrawItems ( WS_DRAW_ITEM_LIST aCollector,
KIGFX::VIEW aView 
)
virtual

Reimplemented in WS_DATA_ITEM_BITMAP, WS_DATA_ITEM_TEXT, and WS_DATA_ITEM_POLYGONS.

Definition at line 75 of file ws_data_item.cpp.

76 {
77  int pensize = GetPenSizeUi();
78 
79  if( pensize == 0 )
80  pensize = aCollector ? aCollector->GetDefaultPenSize() : 0;
81 
82  std::map<int, STATUS_FLAGS> itemFlags;
83  WS_DRAW_ITEM_BASE* item = nullptr;
84 
85  for( size_t i = 0; i < m_drawItems.size(); ++i )
86  {
87  item = m_drawItems[ i ];
88  itemFlags[ i ] = item->GetFlags();
89 
90  if( aCollector )
91  aCollector->Remove( item );
92 
93  if( aView )
94  aView->Remove( item );
95 
96  delete item;
97  }
98 
99  m_drawItems.clear();
100 
101  for( int j = 0; j < m_RepeatCount; j++ )
102  {
103  if( j && ! IsInsidePage( j ) )
104  continue;
105 
106  if( m_type == WS_SEGMENT )
107  item = new WS_DRAW_ITEM_LINE( this, j, GetStartPosUi( j ), GetEndPosUi( j ), pensize );
108  else if( m_type == WS_RECT )
109  item = new WS_DRAW_ITEM_RECT( this, j, GetStartPosUi( j ), GetEndPosUi( j ), pensize );
110 
111  item->SetFlags( itemFlags[ j ] );
112  m_drawItems.push_back( item );
113 
114  if( aCollector )
115  aCollector->Append( item );
116 
117  if( aView )
118  aView->Add( item );
119  }
120 }
void Remove(WS_DRAW_ITEM_BASE *aItem)
Definition: ws_draw_item.h:460
virtual bool IsInsidePage(int ii) const
virtual void Remove(VIEW_ITEM *aItem)
Function Remove() Removes a VIEW_ITEM from the view.
Definition: view.cpp:376
void Append(WS_DRAW_ITEM_BASE *aItem)
Definition: ws_draw_item.h:455
virtual int GetPenSizeUi()
const wxPoint GetStartPosUi(int ii=0) const
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:265
WS_ITEM_TYPE m_type
Definition: ws_data_item.h:105
std::vector< WS_DRAW_ITEM_BASE * > m_drawItems
Definition: ws_data_item.h:108
const wxPoint GetEndPosUi(int ii=0) const
size_t i
Definition: json11.cpp:649
virtual void Add(VIEW_ITEM *aItem, int aDrawPriority=-1)
Function Add() Adds a VIEW_ITEM to the view.
Definition: view.cpp:346
STATUS_FLAGS GetFlags() const
Definition: base_struct.h:267
int GetDefaultPenSize() const
Definition: ws_draw_item.h:426

References KIGFX::VIEW::Add(), WS_DRAW_ITEM_LIST::Append(), WS_DRAW_ITEM_LIST::GetDefaultPenSize(), GetEndPosUi(), EDA_ITEM::GetFlags(), GetPenSizeUi(), GetStartPosUi(), i, IsInsidePage(), m_drawItems, m_RepeatCount, m_type, KIGFX::VIEW::Remove(), WS_DRAW_ITEM_LIST::Remove(), EDA_ITEM::SetFlags(), WS_RECT, and WS_SEGMENT.

Referenced by PL_EDITOR_FRAME::AddPageLayoutItem(), and WS_PROXY_UNDO_ITEM::Restore().

Member Data Documentation

◆ m_drawItems

◆ m_End

◆ m_IncrementLabel

◆ m_IncrementVector

◆ m_Info

◆ m_LineWidth

◆ m_Name

◆ m_pageOption

PAGE_OPTION WS_DATA_ITEM::m_pageOption
protected

Definition at line 106 of file ws_data_item.h.

Referenced by GetPage1Option(), SetPage1Option(), and WS_DATA_ITEM().

◆ m_Pos

◆ m_RepeatCount

◆ m_type

WS_ITEM_TYPE WS_DATA_ITEM::m_type
protected

Definition at line 105 of file ws_data_item.h.

Referenced by GetType(), SyncDrawItems(), and WS_DATA_ITEM().


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