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

545  :
547 {
548  m_TextBase = aTextBase;
549  m_IncrementLabel = 1;
552  m_Italic = false;
553  m_Bold = false;
554  m_Orient = 0.0;
555  m_LineWidth = 0.0; // 0 means use default value
556 }
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 388 of file ws_data_item.cpp.

389 {
390  wxString name;
391 
392  switch( GetType() )
393  {
394  case WS_TEXT: name = wxT( "Text" ); break;
395  case WS_SEGMENT: name = wxT( "Line" ); break;
396  case WS_RECT: name = wxT( "Rectangle" ); break;
397  case WS_POLYPOLYGON: name = wxT( "Imported Shape" ); break;
398  case WS_BITMAP: name = wxT( "Image" ); break;
399  }
400 
401  return name;
402 }
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.

Referenced by PROPERTIES_FRAME::CopyPrmsFromItemToPanel().

◆ GetDrawItems()

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

◆ GetEndPos()

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

Definition at line 329 of file ws_data_item.cpp.

330 {
331  DPOINT pos( m_End.m_Pos.x + ( m_IncrementVector.x * ii ),
332  m_End.m_Pos.y + ( m_IncrementVector.y * ii ) );
333 
334  switch( m_End.m_Anchor )
335  {
336  case RB_CORNER: // right bottom corner
338  break;
339 
340  case RT_CORNER: // right top corner
341  pos.x = WS_DATA_MODEL::GetTheInstance().m_RB_Corner.x - pos.x;
342  pos.y = WS_DATA_MODEL::GetTheInstance().m_LT_Corner.y + pos.y;
343  break;
344 
345  case LB_CORNER: // left bottom corner
346  pos.x = WS_DATA_MODEL::GetTheInstance().m_LT_Corner.x + pos.x;
347  pos.y = WS_DATA_MODEL::GetTheInstance().m_RB_Corner.y - pos.y;
348  break;
349 
350  case LT_CORNER: // left top corner
352  break;
353  }
354 
355  return pos;
356 }
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, 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 359 of file ws_data_item.cpp.

360 {
361  DPOINT pos = GetEndPos( ii );
363  return wxPoint( KiROUND( pos.x ), KiROUND( pos.y ) );
364 }
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:68

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 PROPERTIES_FRAME::CopyPrmsFromItemToPanel(), 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 631 of file ws_data_item.cpp.

632 {
634 
635  if( m_LineWidth != 0 )
636  return KiROUND( m_LineWidth * model.m_WSunits2Iu );
637  else
638  return KiROUND( model.m_DefaultTextThickness * model.m_WSunits2Iu );
639 }
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:68
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 291 of file ws_data_item.cpp.

292 {
294  DPOINT pos( m_Pos.m_Pos.x + ( m_IncrementVector.x * ii ),
295  m_Pos.m_Pos.y + ( m_IncrementVector.y * ii ) );
296 
297  switch( m_Pos.m_Anchor )
298  {
299  case RB_CORNER: // right bottom corner
300  pos = model.m_RB_Corner - pos;
301  break;
302 
303  case RT_CORNER: // right top corner
304  pos.x = model.m_RB_Corner.x - pos.x;
305  pos.y = model.m_LT_Corner.y + pos.y;
306  break;
307 
308  case LB_CORNER: // left bottom corner
309  pos.x = model.m_LT_Corner.x + pos.x;
310  pos.y = model.m_RB_Corner.y - pos.y;
311  break;
312 
313  case LT_CORNER: // left top corner
314  pos = model.m_LT_Corner + pos;
315  break;
316  }
317 
318  return pos;
319 }
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, 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 322 of file ws_data_item.cpp.

323 {
325  return wxPoint( KiROUND( pos.x ), KiROUND( pos.y ) );
326 }
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: util.h:68

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

Referenced by PL_EDIT_TOOL::moveItem(), WS_DATA_ITEM::MoveTo(), PL_DRAWING_TOOLS::PlaceItem(), 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 642 of file ws_data_item.cpp.

643 {
644  int last = m_TextBase.Len() -1;
645 
646  wxChar lbchar = m_TextBase[last];
648  m_FullText.RemoveLast();
649 
650  if( lbchar >= '0' && lbchar <= '9' )
651  // A number is expected:
652  m_FullText << (int)( aIncr + lbchar - '0' );
653  else
654  m_FullText << (wxChar) ( aIncr + lbchar );
655 }

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

368 {
370 
371  DPOINT pos = GetStartPos( ii );
372 
373  for( int kk = 0; kk < 1; kk++ )
374  {
375  if( model.m_RB_Corner.x < pos.x || model.m_LT_Corner.x > pos.x )
376  return false;
377 
378  if( model.m_RB_Corner.y < pos.y || model.m_LT_Corner.y > pos.y )
379  return false;
380 
381  pos = GetEndPos( ii );
382  }
383 
384  return true;
385 }
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 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 233 of file ws_data_item.cpp.

234 {
236  DPOINT position;
237 
238  // Calculate the position of the starting point
239  // relative to the reference corner
240  // aPosition is the position relative to the right top paper corner
241  switch( m_End.m_Anchor )
242  {
243  case RB_CORNER:
244  position = model.m_RB_Corner - aPosition;
245  break;
246 
247  case RT_CORNER:
248  position.x = model.m_RB_Corner.x - aPosition.x;
249  position.y = aPosition.y - model.m_LT_Corner.y;
250  break;
251 
252  case LB_CORNER:
253  position.x = aPosition.x - model.m_LT_Corner.x;
254  position.y = model.m_RB_Corner.y - aPosition.y;
255  break;
256 
257  case LT_CORNER:
258  position = aPosition - model.m_LT_Corner;
259  break;
260  }
261 
262  // Modify m_End only for items having 2 coordinates
263  switch( GetType() )
264  {
265  case WS_SEGMENT:
266  case WS_RECT:
267  m_End.m_Pos = position;
268  break;
269 
270  default:
271  break;
272  }
273 }
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(), 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 281 of file ws_data_item.cpp.

282 {
283  DPOINT pos_mm;
284  pos_mm.x = aPosition.x / WS_DATA_MODEL::GetTheInstance().m_WSunits2Iu;
285  pos_mm.y = aPosition.y / WS_DATA_MODEL::GetTheInstance().m_WSunits2Iu;
286 
287  MoveEndPointTo( pos_mm );
288 }
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 182 of file ws_data_item.cpp.

183 {
185  DPOINT position;
186 
187  // Calculate the position of the starting point
188  // relative to the reference corner
189  // aPosition is the position relative to the right top paper corner
190  switch( m_Pos.m_Anchor )
191  {
192  case RB_CORNER:
193  position = model.m_RB_Corner - aPosition;
194  break;
195 
196  case RT_CORNER:
197  position.x = model.m_RB_Corner.x - aPosition.x;
198  position.y = aPosition.y - model.m_LT_Corner.y;
199  break;
200 
201  case LB_CORNER:
202  position.x = aPosition.x - model.m_LT_Corner.x;
203  position.y = model.m_RB_Corner.y - aPosition.y;
204  break;
205 
206  case LT_CORNER:
207  position = aPosition - model.m_LT_Corner;
208  break;
209  }
210 
211  m_Pos.m_Pos = position;
212 }
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, 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 218 of file ws_data_item.cpp.

219 {
220  DPOINT pos_mm( aPosition.x / WS_DATA_MODEL::GetTheInstance().m_WSunits2Iu,
222 
223  MoveStartPointTo( pos_mm );
224 }
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.

Referenced by PL_DRAWING_TOOLS::PlaceItem().

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

154 {
155  DPOINT pos_mm;
156  pos_mm.x = aPosition.x / WS_DATA_MODEL::GetTheInstance().m_WSunits2Iu;
157  pos_mm.y = aPosition.y / WS_DATA_MODEL::GetTheInstance().m_WSunits2Iu;
158 
159  MoveTo( pos_mm );
160 }
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.

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

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

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

References m_FullText.

Referenced by PROPERTIES_FRAME::CopyPrmsFromItemToPanel(), and 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 696 of file ws_data_item.cpp.

697 {
699 
700  if( m_ConstrainedTextSize.x == 0 )
702 
703  if( m_ConstrainedTextSize.y == 0 )
705 
707  {
708  // to know the X and Y size of the line, we should use
709  // EDA_TEXT::GetTextBox()
710  // but this function uses integers
711  // So, to avoid truncations with our unit in mm, use microns.
712  wxSize size_micron;
713  #define FSCALE 1000.0
714  int linewidth = 0;
715  size_micron.x = KiROUND( m_ConstrainedTextSize.x * FSCALE );
716  size_micron.y = KiROUND( m_ConstrainedTextSize.y * FSCALE );
717  WS_DRAW_ITEM_TEXT dummy( WS_DRAW_ITEM_TEXT( this, 0, this->m_FullText, wxPoint( 0, 0 ),
718  size_micron, linewidth, m_Italic, m_Bold ) );
719  dummy.SetMultilineAllowed( true );
720  dummy.SetHorizJustify( m_Hjustify ) ;
721  dummy.SetVertJustify( m_Vjustify );
722  dummy.SetTextAngle( m_Orient * 10 );
723 
724  EDA_RECT rect = dummy.GetTextBox();
725  DSIZE size;
726  size.x = rect.GetWidth() / FSCALE;
727  size.y = rect.GetHeight() / FSCALE;
728 
729  if( m_BoundingBoxSize.x && size.x > m_BoundingBoxSize.x )
731 
732  if( m_BoundingBoxSize.y && size.y > m_BoundingBoxSize.y )
734  }
735 }
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:68
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 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 
)
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 559 of file ws_data_item.cpp.

560 {
561  int pensize = GetPenSizeUi();
562  bool multilines = false;
563 
564  if( WS_DATA_MODEL::GetTheInstance().m_EditMode )
566  else
567  {
568  m_FullText = aCollector ? aCollector->BuildFullText( m_TextBase ) : wxString();
569  multilines = ReplaceAntiSlashSequence();
570  }
571 
572  if( pensize == 0 )
573  pensize = aCollector ? aCollector->GetDefaultPenSize() : 1;
574 
576  wxSize textsize;
577 
580 
581  if( m_Bold )
582  pensize = GetPenSizeForBold( std::min( textsize.x, textsize.y ) );
583 
584  std::map<int, STATUS_FLAGS> itemFlags;
585  WS_DRAW_ITEM_TEXT* text = nullptr;
586 
587  for( size_t i = 0; i < m_drawItems.size(); ++i )
588  {
589  text = (WS_DRAW_ITEM_TEXT*) m_drawItems[ i ];
590  itemFlags[ i ] = text->GetFlags();
591 
592  if( aCollector )
593  aCollector->Remove( text );
594 
595  if( aView )
596  aView->Remove( text );
597 
598  delete text;
599  }
600 
601  m_drawItems.clear();
602 
603  for( int j = 0; j < m_RepeatCount; ++j )
604  {
605  if( j > 0 && !IsInsidePage( j ) )
606  continue;
607 
608  text = new WS_DRAW_ITEM_TEXT( this, j, m_FullText, GetStartPosUi( j ), textsize, pensize,
609  m_Italic, m_Bold );
610  text->SetFlags( itemFlags[ j ] );
611  m_drawItems.push_back( text );
612 
613  if( aCollector )
614  aCollector->Append( text );
615 
616  if( aView )
617  aView->Add( text );
618 
619  text->SetHorizJustify( m_Hjustify ) ;
620  text->SetVertJustify( m_Vjustify );
621  text->SetTextAngle( m_Orient * 10 ); // graphic text orient unit = 0.1 degree
622  text->SetMultilineAllowed( multilines );
623 
624  // Increment label for the next text (has no meaning for multiline texts)
625  if( m_RepeatCount > 1 && !multilines )
626  IncrementLabel(( j + 1 ) * m_IncrementLabel );
627  }
628 }
void Remove(WS_DRAW_ITEM_BASE *aItem)
Definition: ws_draw_item.h:463
virtual bool IsInsidePage(int ii) const
int GetPenSizeForBold(int aTextSize)
Function GetPensizeForBold.
Definition: gr_text.cpp:51
virtual void Remove(VIEW_ITEM *aItem)
Function Remove() Removes a VIEW_ITEM from the view.
Definition: view.cpp:375
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:458
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 SetTextAngle(double aAngle) override
Definition: ws_draw_item.h:295
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:232
void SetVertJustify(EDA_TEXT_VJUSTIFY_T aType)
Definition: eda_text.h:203
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:196
double m_WSunits2Iu
Definition: ws_data_model.h:51
void SetHorizJustify(EDA_TEXT_HJUSTIFY_T aType)
Definition: eda_text.h:202
wxString BuildFullText(const wxString &aTextbase)
Function BuildFullText returns the full text corresponding to the aTextbase, after replacing format s...
Definition: ws_painter.cpp:117
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:68
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:345
STATUS_FLAGS GetFlags() const
Definition: base_struct.h:234
int GetDefaultPenSize() const
Definition: ws_draw_item.h:429

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

◆ 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

◆ m_pageOption

PAGE_OPTION WS_DATA_ITEM::m_pageOption
protectedinherited

◆ m_Pos

◆ m_RepeatCount

◆ m_TextBase

◆ 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: