KiCad PCB EDA Suite
WS_DATA_ITEM_TEXT Class Reference

#include <ws_data_item.h>

Inheritance diagram for WS_DATA_ITEM_TEXT:
WS_DATA_ITEM

Public Types

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

Public Member Functions

 WS_DATA_ITEM_TEXT (const wxString &aTextBase)
 
void SyncDrawItems (WS_DRAW_ITEM_LIST *aCollector, KIGFX::VIEW *aView) override
 
virtual int GetPenSizeUi () override
 
void MoveTo (DPOINT aPosition)
 move item to a new position More...
 
void IncrementLabel (int aIncr)
 Try to build text wihich is an increment of m_TextBase has meaning only if m_TextBase is a basic text (one char) If the basic char is a digit, build a number If the basic char is a letter, use the letter with ascii code aIncr + (basic char ascc code) More...
 
void SetConstrainedTextSize ()
 Calculates m_ConstrainedTextSize from m_TextSize to keep the X size and the full Y size of the text smaller than m_BoundingBoxSize if m_BoundingBoxSize.x or m_BoundingBoxSize.y > 0 if m_BoundingBoxSize.x or m_BoundingBoxSize.y == 0 the corresponding text size is not constrained. More...
 
bool ReplaceAntiSlashSequence ()
 Replace the '\''n' sequence by EOL and the sequence '\''\' by only one '\' inside m_FullText. More...
 
const std::vector< WS_DRAW_ITEM_BASE * > & GetDrawItems () const
 
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
 
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_TextBase
 
wxString m_FullText
 
double m_Orient
 
EDA_TEXT_HJUSTIFY_T m_Hjustify
 
EDA_TEXT_VJUSTIFY_T m_Vjustify
 
bool m_Italic
 
bool m_Bold
 
DSIZE m_TextSize
 
DSIZE m_BoundingBoxSize
 
DSIZE m_ConstrainedTextSize
 
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

Definition at line 298 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_TEXT()

WS_DATA_ITEM_TEXT::WS_DATA_ITEM_TEXT ( const wxString &  aTextBase)

Definition at line 538 of file ws_data_item.cpp.

538  :
540 {
541  m_TextBase = aTextBase;
542  m_IncrementLabel = 1;
545  m_Italic = false;
546  m_Bold = false;
547  m_Orient = 0.0;
548  m_LineWidth = 0.0; // 0 means use default value
549 }
EDA_TEXT_HJUSTIFY_T m_Hjustify
Definition: ws_data_item.h:304
WS_DATA_ITEM(WS_ITEM_TYPE aType)
EDA_TEXT_VJUSTIFY_T m_Vjustify
Definition: ws_data_item.h:305
double m_LineWidth
Definition: ws_data_item.h:117
int m_IncrementLabel
Definition: ws_data_item.h:121

References GR_TEXT_HJUSTIFY_LEFT, GR_TEXT_VJUSTIFY_CENTER, m_Bold, m_Hjustify, WS_DATA_ITEM::m_IncrementLabel, m_Italic, WS_DATA_ITEM::m_LineWidth, m_Orient, m_TextBase, and m_Vjustify.

Member Function Documentation

◆ GetClassName()

const wxString WS_DATA_ITEM::GetClassName ( ) const
inherited

Definition at line 381 of file ws_data_item.cpp.

382 {
383  wxString name;
384 
385  switch( GetType() )
386  {
387  case WS_TEXT: name = wxT( "Text" ); break;
388  case WS_SEGMENT: name = wxT( "Line" ); break;
389  case WS_RECT: name = wxT( "Rectangle" ); break;
390  case WS_POLYPOLYGON: name = wxT( "Imported Shape" ); break;
391  case WS_BITMAP: name = wxT( "Image" ); break;
392  }
393 
394  return name;
395 }
WS_ITEM_TYPE GetType() const
Definition: ws_data_item.h:147
const char * name
Definition: DXF_plotter.cpp:60

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

◆ GetDrawItems()

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

Definition at line 128 of file ws_data_item.h.

128 { return m_drawItems; }
std::vector< WS_DRAW_ITEM_BASE * > m_drawItems
Definition: ws_data_item.h:108

References WS_DATA_ITEM::m_drawItems.

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

◆ GetEndPos()

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

Definition at line 322 of file ws_data_item.cpp.

323 {
324  DPOINT pos( m_End.m_Pos.x + ( m_IncrementVector.x * ii ),
325  m_End.m_Pos.y + ( m_IncrementVector.y * ii ) );
326 
327  switch( m_End.m_Anchor )
328  {
329  case RB_CORNER: // right bottom corner
331  break;
332 
333  case RT_CORNER: // right top corner
334  pos.x = WS_DATA_MODEL::GetTheInstance().m_RB_Corner.x - pos.x;
335  pos.y = WS_DATA_MODEL::GetTheInstance().m_LT_Corner.y + pos.y;
336  break;
337 
338  case LB_CORNER: // left bottom corner
339  pos.x = WS_DATA_MODEL::GetTheInstance().m_LT_Corner.x + pos.x;
340  pos.y = WS_DATA_MODEL::GetTheInstance().m_RB_Corner.y - pos.y;
341  break;
342 
343  case LT_CORNER: // left top corner
345  break;
346  }
347 
348  return pos;
349 }
DPOINT m_RB_Corner
Definition: ws_data_model.h:53
VECTOR2 defines a general 2D-vector/point.
Definition: vector2d.h:61
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, WS_DATA_ITEM::m_End, WS_DATA_ITEM::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 WS_DATA_ITEM::GetEndPosUi(), WS_DATA_ITEM::IsInsidePage(), and WS_DATA_ITEM::MoveTo().

◆ GetEndPosUi()

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

Definition at line 352 of file ws_data_item.cpp.

353 {
354  DPOINT pos = GetEndPos( ii );
356  return wxPoint( KiROUND( pos.x ), KiROUND( pos.y ) );
357 }
VECTOR2 defines a general 2D-vector/point.
Definition: vector2d.h:61
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: util.h:61

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

Referenced by WS_DATA_ITEM::MoveTo(), and WS_DATA_ITEM::SyncDrawItems().

◆ GetPage1Option()

PAGE_OPTION WS_DATA_ITEM::GetPage1Option ( ) const
inlineinherited
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 WS_DATA_ITEM::m_pageOption.

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

◆ GetPenSizeUi()

int WS_DATA_ITEM_TEXT::GetPenSizeUi ( )
overridevirtual

Reimplemented from WS_DATA_ITEM.

Definition at line 624 of file ws_data_item.cpp.

625 {
627 
628  if( m_LineWidth != 0 )
629  return KiROUND( m_LineWidth * model.m_WSunits2Iu );
630  else
631  return KiROUND( model.m_DefaultTextThickness * model.m_WSunits2Iu );
632 }
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_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: util.h:61
double m_DefaultTextThickness
Definition: ws_data_model.h:57

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

Referenced by SyncDrawItems().

◆ GetStartPos()

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

Definition at line 284 of file ws_data_item.cpp.

285 {
287  DPOINT pos( m_Pos.m_Pos.x + ( m_IncrementVector.x * ii ),
288  m_Pos.m_Pos.y + ( m_IncrementVector.y * ii ) );
289 
290  switch( m_Pos.m_Anchor )
291  {
292  case RB_CORNER: // right bottom corner
293  pos = model.m_RB_Corner - pos;
294  break;
295 
296  case RT_CORNER: // right top corner
297  pos.x = model.m_RB_Corner.x - pos.x;
298  pos.y = model.m_LT_Corner.y + pos.y;
299  break;
300 
301  case LB_CORNER: // left bottom corner
302  pos.x = model.m_LT_Corner.x + pos.x;
303  pos.y = model.m_RB_Corner.y - pos.y;
304  break;
305 
306  case LT_CORNER: // left top corner
307  pos = model.m_LT_Corner + pos;
308  break;
309  }
310 
311  return pos;
312 }
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
VECTOR2 defines a general 2D-vector/point.
Definition: vector2d.h:61
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, WS_DATA_ITEM::m_IncrementVector, WS_DATA_MODEL::m_LT_Corner, POINT_COORD::m_Pos, WS_DATA_ITEM::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(), WS_DATA_ITEM::GetStartPosUi(), WS_DATA_ITEM::IsInsidePage(), WS_DATA_ITEM_POLYGONS::IsInsidePage(), and WS_DATA_ITEM::MoveTo().

◆ GetStartPosUi()

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

Definition at line 315 of file ws_data_item.cpp.

316 {
318  return wxPoint( KiROUND( pos.x ), KiROUND( pos.y ) );
319 }
const DPOINT GetStartPos(int ii=0) const
VECTOR2 defines a general 2D-vector/point.
Definition: vector2d.h:61
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: util.h:61

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

Referenced by WS_DATA_ITEM::MoveTo(), WS_DATA_ITEM::SyncDrawItems(), WS_DATA_ITEM_POLYGONS::SyncDrawItems(), SyncDrawItems(), and WS_DATA_ITEM_BITMAP::SyncDrawItems().

◆ GetType()

◆ IncrementLabel()

void WS_DATA_ITEM_TEXT::IncrementLabel ( int  aIncr)

Try to build text wihich is an increment of m_TextBase has meaning only if m_TextBase is a basic text (one char) If the basic char is a digit, build a number If the basic char is a letter, use the letter with ascii code aIncr + (basic char ascc code)

Parameters
aIncr= the increment value return the incremented label in m_FullText

Definition at line 635 of file ws_data_item.cpp.

636 {
637  int last = m_TextBase.Len() -1;
638 
639  wxChar lbchar = m_TextBase[last];
641  m_FullText.RemoveLast();
642 
643  if( lbchar >= '0' && lbchar <= '9' )
644  // A number is expected:
645  m_FullText << (int)( aIncr + lbchar - '0' );
646  else
647  m_FullText << (wxChar) ( aIncr + lbchar );
648 }

References m_FullText, and m_TextBase.

Referenced by SyncDrawItems().

◆ IsInsidePage()

bool WS_DATA_ITEM::IsInsidePage ( int  ii) const
virtualinherited
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 360 of file ws_data_item.cpp.

361 {
363 
364  DPOINT pos = GetStartPos( ii );
365 
366  for( int kk = 0; kk < 1; kk++ )
367  {
368  if( model.m_RB_Corner.x < pos.x || model.m_LT_Corner.x > pos.x )
369  return false;
370 
371  if( model.m_RB_Corner.y < pos.y || model.m_LT_Corner.y > pos.y )
372  return false;
373 
374  pos = GetEndPos( ii );
375  }
376 
377  return true;
378 }
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
VECTOR2 defines a general 2D-vector/point.
Definition: vector2d.h:61
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 WS_DATA_ITEM::GetEndPos(), WS_DATA_ITEM::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 WS_DATA_ITEM::SyncDrawItems(), SyncDrawItems(), and WS_DATA_ITEM_BITMAP::SyncDrawItems().

◆ MoveEndPointTo()

void WS_DATA_ITEM::MoveEndPointTo ( DPOINT  aPosition)
inherited

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 226 of file ws_data_item.cpp.

227 {
229  DPOINT position;
230 
231  // Calculate the position of the starting point
232  // relative to the reference corner
233  // aPosition is the position relative to the right top paper corner
234  switch( m_End.m_Anchor )
235  {
236  case RB_CORNER:
237  position = model.m_RB_Corner - aPosition;
238  break;
239 
240  case RT_CORNER:
241  position.x = model.m_RB_Corner.x - aPosition.x;
242  position.y = aPosition.y - model.m_LT_Corner.y;
243  break;
244 
245  case LB_CORNER:
246  position.x = aPosition.x - model.m_LT_Corner.x;
247  position.y = model.m_RB_Corner.y - aPosition.y;
248  break;
249 
250  case LT_CORNER:
251  position = aPosition - model.m_LT_Corner;
252  break;
253  }
254 
255  // Modify m_End only for items having 2 coordinates
256  switch( GetType() )
257  {
258  case WS_SEGMENT:
259  case WS_RECT:
260  m_End.m_Pos = position;
261  break;
262 
263  default:
264  break;
265  }
266 }
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
VECTOR2 defines a general 2D-vector/point.
Definition: vector2d.h:61
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(), WS_DATA_ITEM::GetType(), LB_CORNER, LT_CORNER, POINT_COORD::m_Anchor, WS_DATA_ITEM::m_End, WS_DATA_MODEL::m_LT_Corner, POINT_COORD::m_Pos, WS_DATA_MODEL::m_RB_Corner, RB_CORNER, RT_CORNER, WS_DATA_ITEM::WS_RECT, WS_DATA_ITEM::WS_SEGMENT, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by WS_DATA_ITEM::MoveEndPointToUi(), and WS_DATA_ITEM::MoveTo().

◆ MoveEndPointToUi()

void WS_DATA_ITEM::MoveEndPointToUi ( wxPoint  aPosition)
inherited

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 274 of file ws_data_item.cpp.

275 {
276  DPOINT pos_mm;
277  pos_mm.x = aPosition.x / WS_DATA_MODEL::GetTheInstance().m_WSunits2Iu;
278  pos_mm.y = aPosition.y / WS_DATA_MODEL::GetTheInstance().m_WSunits2Iu;
279 
280  MoveEndPointTo( pos_mm );
281 }
VECTOR2 defines a general 2D-vector/point.
Definition: vector2d.h:61
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, WS_DATA_ITEM::MoveEndPointTo(), wxPoint::x, VECTOR2< T >::x, wxPoint::y, and VECTOR2< T >::y.

◆ MoveStartPointTo()

void WS_DATA_ITEM::MoveStartPointTo ( DPOINT  aPosition)
inherited

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 175 of file ws_data_item.cpp.

176 {
178  DPOINT position;
179 
180  // Calculate the position of the starting point
181  // relative to the reference corner
182  // aPosition is the position relative to the right top paper corner
183  switch( m_Pos.m_Anchor )
184  {
185  case RB_CORNER:
186  position = model.m_RB_Corner - aPosition;
187  break;
188 
189  case RT_CORNER:
190  position.x = model.m_RB_Corner.x - aPosition.x;
191  position.y = aPosition.y - model.m_LT_Corner.y;
192  break;
193 
194  case LB_CORNER:
195  position.x = aPosition.x - model.m_LT_Corner.x;
196  position.y = model.m_RB_Corner.y - aPosition.y;
197  break;
198 
199  case LT_CORNER:
200  position = aPosition - model.m_LT_Corner;
201  break;
202  }
203 
204  m_Pos.m_Pos = position;
205 }
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
VECTOR2 defines a general 2D-vector/point.
Definition: vector2d.h:61
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, WS_DATA_ITEM::m_Pos, WS_DATA_MODEL::m_RB_Corner, RB_CORNER, RT_CORNER, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by WS_DATA_ITEM::MoveStartPointToUi(), and WS_DATA_ITEM::MoveTo().

◆ MoveStartPointToUi()

void WS_DATA_ITEM::MoveStartPointToUi ( wxPoint  aPosition)
inherited

move the starting point of the item to a new position

Parameters
aPosition= the new position of item in graphic units

Definition at line 211 of file ws_data_item.cpp.

212 {
213  DPOINT pos_mm( aPosition.x / WS_DATA_MODEL::GetTheInstance().m_WSunits2Iu,
215 
216  MoveStartPointTo( pos_mm );
217 }
VECTOR2 defines a general 2D-vector/point.
Definition: vector2d.h:61
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, WS_DATA_ITEM::MoveStartPointTo(), wxPoint::x, and wxPoint::y.

◆ MoveTo()

void WS_DATA_ITEM_TEXT::MoveTo ( DPOINT  aPosition)

move item to a new position

Parameters
aPosition= the new position of item

◆ MoveToUi()

void WS_DATA_ITEM::MoveToUi ( wxPoint  aPosition)
inherited

move item to a new position

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

Definition at line 146 of file ws_data_item.cpp.

147 {
148  DPOINT pos_mm;
149  pos_mm.x = aPosition.x / WS_DATA_MODEL::GetTheInstance().m_WSunits2Iu;
150  pos_mm.y = aPosition.y / WS_DATA_MODEL::GetTheInstance().m_WSunits2Iu;
151 
152  MoveTo( pos_mm );
153 }
VECTOR2 defines a general 2D-vector/point.
Definition: vector2d.h:61
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, WS_DATA_ITEM::MoveTo(), wxPoint::x, VECTOR2< T >::x, wxPoint::y, and VECTOR2< T >::y.

◆ ReplaceAntiSlashSequence()

bool WS_DATA_ITEM_TEXT::ReplaceAntiSlashSequence ( )

Replace the '\''n' sequence by EOL and the sequence '\''\' by only one '\' inside m_FullText.

Returns
true if the EOL symbol is found or is inserted (multiline text)

Definition at line 654 of file ws_data_item.cpp.

655 {
656  bool multiline = false;
657 
658  for( unsigned ii = 0; ii < m_FullText.Len(); ii++ )
659  {
660  if( m_FullText[ii] == '\n' )
661  multiline = true;
662 
663  else if( m_FullText[ii] == '\\' )
664  {
665  if( ++ii >= m_FullText.Len() )
666  break;
667 
668  if( m_FullText[ii] == '\\' )
669  {
670  // a double \\ sequence is replaced by a single \ char
671  m_FullText.Remove(ii, 1);
672  ii--;
673  }
674  else if( m_FullText[ii] == 'n' )
675  {
676  // Replace the "\n" sequence by a EOL char
677  multiline = true;
678  m_FullText[ii] = '\n';
679  m_FullText.Remove(ii-1, 1);
680  ii--;
681  }
682  }
683  }
684 
685  return multiline;
686 }

References m_FullText.

Referenced by SyncDrawItems().

◆ SetConstrainedTextSize()

void WS_DATA_ITEM_TEXT::SetConstrainedTextSize ( )

Calculates m_ConstrainedTextSize from m_TextSize to keep the X size and the full Y size of the text smaller than m_BoundingBoxSize if m_BoundingBoxSize.x or m_BoundingBoxSize.y > 0 if m_BoundingBoxSize.x or m_BoundingBoxSize.y == 0 the corresponding text size is not constrained.

Definition at line 689 of file ws_data_item.cpp.

690 {
692 
693  if( m_ConstrainedTextSize.x == 0 )
695 
696  if( m_ConstrainedTextSize.y == 0 )
698 
700  {
701  // to know the X and Y size of the line, we should use
702  // EDA_TEXT::GetTextBox()
703  // but this function uses integers
704  // So, to avoid truncations with our unit in mm, use microns.
705  wxSize size_micron;
706  #define FSCALE 1000.0
707  int linewidth = 0;
708  size_micron.x = KiROUND( m_ConstrainedTextSize.x * FSCALE );
709  size_micron.y = KiROUND( m_ConstrainedTextSize.y * FSCALE );
710  WS_DRAW_ITEM_TEXT dummy( WS_DRAW_ITEM_TEXT( this, 0, this->m_FullText, wxPoint( 0, 0 ),
711  size_micron, linewidth, m_Italic, m_Bold ) );
712  dummy.SetMultilineAllowed( true );
713  dummy.SetHorizJustify( m_Hjustify ) ;
714  dummy.SetVertJustify( m_Vjustify );
715  dummy.SetTextAngle( m_Orient * 10 );
716 
717  EDA_RECT rect = dummy.GetTextBox();
718  DSIZE size;
719  size.x = rect.GetWidth() / FSCALE;
720  size.y = rect.GetHeight() / FSCALE;
721 
722  if( m_BoundingBoxSize.x && size.x > m_BoundingBoxSize.x )
724 
725  if( m_BoundingBoxSize.y && size.y > m_BoundingBoxSize.y )
727  }
728 }
int GetWidth() const
Definition: eda_rect.h:119
DSIZE m_DefaultTextSize
Definition: ws_data_model.h:56
EDA_TEXT_HJUSTIFY_T m_Hjustify
Definition: ws_data_item.h:304
static WS_DATA_MODEL & GetTheInstance()
static function: returns the instance of WS_DATA_MODEL used in the application
EDA_TEXT_VJUSTIFY_T m_Vjustify
Definition: ws_data_item.h:305
int GetHeight() const
Definition: eda_rect.h:120
static LIB_PART * dummy()
Used to draw a dummy shape when a LIB_PART is not found in library.
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: util.h:61
DSIZE m_ConstrainedTextSize
Definition: ws_data_item.h:314
#define FSCALE

References dummy(), FSCALE, EDA_RECT::GetHeight(), WS_DATA_MODEL::GetTheInstance(), EDA_RECT::GetWidth(), KiROUND(), m_Bold, m_BoundingBoxSize, m_ConstrainedTextSize, WS_DATA_MODEL::m_DefaultTextSize, m_FullText, m_Hjustify, m_Italic, m_Orient, m_TextSize, m_Vjustify, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by SyncDrawItems().

◆ SetEnd()

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

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, WS_DATA_ITEM::m_End, POINT_COORD::m_Pos, VECTOR2< T >::x, and VECTOR2< T >::y.

◆ SetPage1Option()

void WS_DATA_ITEM::SetPage1Option ( PAGE_OPTION  aChoice)
inlineinherited

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 WS_DATA_ITEM::m_pageOption.

Referenced by PAGE_LAYOUT_READER_PARSER::readOption().

◆ SetStart()

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

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, WS_DATA_ITEM::m_Pos, VECTOR2< T >::x, and VECTOR2< T >::y.

◆ SyncDrawItems()

void WS_DATA_ITEM_TEXT::SyncDrawItems ( WS_DRAW_ITEM_LIST aCollector,
KIGFX::VIEW aView 
)
overridevirtual

Reimplemented from WS_DATA_ITEM.

Definition at line 552 of file ws_data_item.cpp.

553 {
554  int pensize = GetPenSizeUi();
555  bool multilines = false;
556 
557  if( WS_DATA_MODEL::GetTheInstance().m_EditMode )
559  else
560  {
561  m_FullText = aCollector ? aCollector->BuildFullText( m_TextBase ) : wxString();
562  multilines = ReplaceAntiSlashSequence();
563  }
564 
565  if( pensize == 0 )
566  pensize = aCollector ? aCollector->GetDefaultPenSize() : 1;
567 
569  wxSize textsize;
570 
573 
574  if( m_Bold )
575  pensize = GetPenSizeForBold( std::min( textsize.x, textsize.y ) );
576 
577  std::map<int, STATUS_FLAGS> itemFlags;
578  WS_DRAW_ITEM_TEXT* text = nullptr;
579 
580  for( size_t i = 0; i < m_drawItems.size(); ++i )
581  {
582  text = (WS_DRAW_ITEM_TEXT*) m_drawItems[ i ];
583  itemFlags[ i ] = text->GetFlags();
584 
585  if( aCollector )
586  aCollector->Remove( text );
587 
588  if( aView )
589  aView->Remove( text );
590 
591  delete text;
592  }
593 
594  m_drawItems.clear();
595 
596  for( int j = 0; j < m_RepeatCount; ++j )
597  {
598  if( j > 0 && !IsInsidePage( j ) )
599  continue;
600 
601  text = new WS_DRAW_ITEM_TEXT( this, j, m_FullText, GetStartPosUi( j ), textsize, pensize,
602  m_Italic, m_Bold );
603  text->SetFlags( itemFlags[ j ] );
604  m_drawItems.push_back( text );
605 
606  if( aCollector )
607  aCollector->Append( text );
608 
609  if( aView )
610  aView->Add( text );
611 
612  text->SetHorizJustify( m_Hjustify ) ;
613  text->SetVertJustify( m_Vjustify );
614  text->SetTextAngle( m_Orient * 10 ); // graphic text orient unit = 0.1 degree
615  text->SetMultilineAllowed( multilines );
616 
617  // Increment label for the next text (has no meaning for multiline texts)
618  if( m_RepeatCount > 1 && !multilines )
619  IncrementLabel(( j + 1 ) * m_IncrementLabel );
620  }
621 }
void Remove(WS_DRAW_ITEM_BASE *aItem)
Definition: ws_draw_item.h:460
virtual bool IsInsidePage(int ii) const
int GetPenSizeForBold(int aTextSize)
Function GetPensizeForBold.
Definition: gr_text.cpp:66
virtual void Remove(VIEW_ITEM *aItem)
Function Remove() Removes a VIEW_ITEM from the view.
Definition: view.cpp:376
virtual int GetPenSizeUi() override
void IncrementLabel(int aIncr)
Try to build text wihich is an increment of m_TextBase has meaning only if m_TextBase is a basic text...
void Append(WS_DRAW_ITEM_BASE *aItem)
Definition: ws_draw_item.h:455
EDA_TEXT_HJUSTIFY_T m_Hjustify
Definition: ws_data_item.h:304
bool ReplaceAntiSlashSequence()
Replace the '\''n' sequence by EOL and the sequence '\''\' by only one '\' inside m_FullText.
static WS_DATA_MODEL & GetTheInstance()
static function: returns the instance of WS_DATA_MODEL used in the application
const wxPoint GetStartPosUi(int ii=0) const
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:255
void SetVertJustify(EDA_TEXT_VJUSTIFY_T aType)
Definition: eda_text.h:187
EDA_TEXT_VJUSTIFY_T m_Vjustify
Definition: ws_data_item.h:305
std::vector< WS_DRAW_ITEM_BASE * > m_drawItems
Definition: ws_data_item.h:108
void SetMultilineAllowed(bool aAllow)
Definition: eda_text.h:180
void SetTextAngle(double aAngle)
Definition: ws_draw_item.h:295
double m_WSunits2Iu
Definition: ws_data_model.h:51
void SetHorizJustify(EDA_TEXT_HJUSTIFY_T aType)
Definition: eda_text.h:186
wxString BuildFullText(const wxString &aTextbase)
Function BuildFullText returns the full text corresponding to the aTextbase, after replacing format s...
Definition: ws_painter.cpp:75
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: util.h:61
DSIZE m_ConstrainedTextSize
Definition: ws_data_item.h:314
void SetConstrainedTextSize()
Calculates m_ConstrainedTextSize from m_TextSize to keep the X size and the full Y size of the text s...
int m_IncrementLabel
Definition: ws_data_item.h:121
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:257
int GetDefaultPenSize() const
Definition: ws_draw_item.h:426

References KIGFX::VIEW::Add(), WS_DRAW_ITEM_LIST::Append(), WS_DRAW_ITEM_LIST::BuildFullText(), WS_DRAW_ITEM_LIST::GetDefaultPenSize(), EDA_ITEM::GetFlags(), GetPenSizeForBold(), GetPenSizeUi(), WS_DATA_ITEM::GetStartPosUi(), WS_DATA_MODEL::GetTheInstance(), IncrementLabel(), WS_DATA_ITEM::IsInsidePage(), KiROUND(), m_Bold, m_ConstrainedTextSize, WS_DATA_ITEM::m_drawItems, m_FullText, m_Hjustify, WS_DATA_ITEM::m_IncrementLabel, m_Italic, m_Orient, WS_DATA_ITEM::m_RepeatCount, m_TextBase, m_Vjustify, WS_DATA_MODEL::m_WSunits2Iu, KIGFX::VIEW::Remove(), WS_DRAW_ITEM_LIST::Remove(), ReplaceAntiSlashSequence(), SetConstrainedTextSize(), EDA_ITEM::SetFlags(), EDA_TEXT::SetHorizJustify(), EDA_TEXT::SetMultilineAllowed(), WS_DRAW_ITEM_TEXT::SetTextAngle(), EDA_TEXT::SetVertJustify(), VECTOR2< T >::x, and VECTOR2< T >::y.

Member Data Documentation

◆ m_Bold

◆ m_BoundingBoxSize

DSIZE WS_DATA_ITEM_TEXT::m_BoundingBoxSize

◆ m_ConstrainedTextSize

DSIZE WS_DATA_ITEM_TEXT::m_ConstrainedTextSize

Definition at line 314 of file ws_data_item.h.

Referenced by SetConstrainedTextSize(), and SyncDrawItems().

◆ m_drawItems

◆ m_End

◆ m_FullText

wxString WS_DATA_ITEM_TEXT::m_FullText

◆ m_Hjustify

◆ m_IncrementLabel

◆ m_IncrementVector

◆ m_Info

◆ m_Italic

◆ m_LineWidth

◆ m_Name

◆ m_Orient

double WS_DATA_ITEM_TEXT::m_Orient

◆ m_pageOption

PAGE_OPTION WS_DATA_ITEM::m_pageOption
protectedinherited

◆ m_Pos

◆ m_RepeatCount

◆ m_TextBase

wxString WS_DATA_ITEM_TEXT::m_TextBase

◆ m_TextSize

DSIZE WS_DATA_ITEM_TEXT::m_TextSize

◆ m_type

WS_ITEM_TYPE WS_DATA_ITEM::m_type
protectedinherited

◆ m_Vjustify


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