KiCad PCB EDA Suite
DIALOG_CREATE_ARRAY::ARRAY_CIRCULAR_OPTIONS Struct Reference

#include <dialog_create_array.h>

Inheritance diagram for DIALOG_CREATE_ARRAY::ARRAY_CIRCULAR_OPTIONS:
DIALOG_CREATE_ARRAY::ARRAY_OPTIONS

Public Member Functions

 ARRAY_CIRCULAR_OPTIONS ()
 
void TransformItem (int n, BOARD_ITEM *item, const wxPoint &rotPoint) const override
 
int GetArraySize () const override
 
wxString GetItemNumber (int n) const override
 
virtual wxString InterpolateNumberIntoString (int n, const wxString &pattern) const
 
bool ShouldNumberItems () const
 
bool NumberingStartIsSpecified () const
 

Public Attributes

long m_nPts
 
double m_angle
 
wxPoint m_centre
 
bool m_rotateItems
 
NUMBERING_TYPE_T m_numberingType
 
long m_numberingOffset
 
ARRAY_TYPE_T m_type
 

Static Protected Member Functions

static wxString getCoordinateNumber (int n, NUMBERING_TYPE_T type)
 

Protected Attributes

bool m_shouldNumber
 True if this array numbers the new items. More...
 
bool m_numberingStartIsSpecified
 True if this array's number starts from the preset point False if the array numbering starts from some externally provided point. More...
 

Detailed Description

Definition at line 313 of file dialog_create_array.h.

Constructor & Destructor Documentation

DIALOG_CREATE_ARRAY::ARRAY_CIRCULAR_OPTIONS::ARRAY_CIRCULAR_OPTIONS ( )
inline

Member Function Documentation

int DIALOG_CREATE_ARRAY::ARRAY_CIRCULAR_OPTIONS::GetArraySize ( ) const
overridevirtual

Implements DIALOG_CREATE_ARRAY::ARRAY_OPTIONS.

Definition at line 547 of file dialog_create_array.cpp.

wxString DIALOG_CREATE_ARRAY::ARRAY_OPTIONS::getCoordinateNumber ( int  n,
NUMBERING_TYPE_T  type 
)
staticprotectedinherited

Definition at line 435 of file dialog_create_array.cpp.

References alphabetFromNumberingScheme(), and schemeNonUnitColsStartAt0().

437 {
438  wxString itemNum;
439  const wxString& alphabet = alphabetFromNumberingScheme( type );
440 
441  const bool nonUnitColsStartAt0 = schemeNonUnitColsStartAt0( type );
442 
443  bool firstRound = true;
444  int radix = alphabet.Length();
445 
446  do {
447  int modN = n % radix;
448 
449  if( nonUnitColsStartAt0 && !firstRound )
450  modN--; // Start the "tens/hundreds/etc column" at "Ax", not "Bx"
451 
452  itemNum.insert( 0, 1, alphabet[modN] );
453 
454  n /= radix;
455  firstRound = false;
456  } while( n );
457 
458  return itemNum;
459 }
static bool schemeNonUnitColsStartAt0(DIALOG_CREATE_ARRAY::NUMBERING_TYPE_T type)
static const wxString & alphabetFromNumberingScheme(DIALOG_CREATE_ARRAY::NUMBERING_TYPE_T type)
wxString DIALOG_CREATE_ARRAY::ARRAY_CIRCULAR_OPTIONS::GetItemNumber ( int  n) const
overridevirtual
wxString DIALOG_CREATE_ARRAY::ARRAY_OPTIONS::InterpolateNumberIntoString ( int  n,
const wxString &  pattern 
) const
virtualinherited

Definition at line 462 of file dialog_create_array.cpp.

464 {
465  wxString newStr( aPattern );
466  newStr.Replace( "%s", GetItemNumber( aN ), false );
467 
468  return newStr;
469 }
virtual wxString GetItemNumber(int n) const =0
bool DIALOG_CREATE_ARRAY::ARRAY_OPTIONS::NumberingStartIsSpecified ( ) const
inlineinherited
Returns
is the numbering is enabled and should start at a point specified in these options or is it implicit according to the calling code?

Definition at line 260 of file dialog_create_array.h.

References CONFIG_SAVE_RESTORE_WINDOW::CONFIG_CTRL_T::type.

Referenced by ARRAY_CREATOR::Invoke().

261  {
263  }
bool m_numberingStartIsSpecified
True if this array&#39;s number starts from the preset point False if the array numbering starts from som...
bool m_shouldNumber
True if this array numbers the new items.
bool DIALOG_CREATE_ARRAY::ARRAY_OPTIONS::ShouldNumberItems ( ) const
inlineinherited
Returns
are the items in this array numberred, or are all the items numbered the same

Definition at line 250 of file dialog_create_array.h.

Referenced by ARRAY_CREATOR::Invoke().

251  {
252  return m_shouldNumber;
253  }
bool m_shouldNumber
True if this array numbers the new items.
void DIALOG_CREATE_ARRAY::ARRAY_CIRCULAR_OPTIONS::TransformItem ( int  n,
BOARD_ITEM item,
const wxPoint rotPoint 
) const
overridevirtual

Function GetArrayPositions Returns the set of points that represent the array in order, if that is important

TODO: Can/should this be done with some sort of iterator?

Implements DIALOG_CREATE_ARRAY::ARRAY_OPTIONS.

Definition at line 553 of file dialog_create_array.cpp.

References PNS::angle(), BOARD_ITEM::GetCenter(), and BOARD_ITEM::Rotate().

555 {
556  double angle;
557 
558  if( m_angle == 0 )
559  // angle is zero, divide evenly into m_nPts
560  angle = 3600.0 * n / double( m_nPts );
561  else
562  // n'th step
563  angle = m_angle * n;
564 
565  item->Rotate( m_centre, angle );
566 
567  // take off the rotation (but not the translation) if needed
568  if( !m_rotateItems )
569  item->Rotate( item->GetCenter(), -angle );
570 }
virtual const wxPoint GetCenter() const
Function GetCenter()
virtual void Rotate(const wxPoint &aRotCentre, double aAngle)
Function Rotate Rotate this object.
static DIRECTION_45::AngleType angle(const VECTOR2I &a, const VECTOR2I &b)

Member Data Documentation

double DIALOG_CREATE_ARRAY::ARRAY_CIRCULAR_OPTIONS::m_angle

Definition at line 325 of file dialog_create_array.h.

Referenced by DIALOG_CREATE_ARRAY::TransferDataFromWindow().

wxPoint DIALOG_CREATE_ARRAY::ARRAY_CIRCULAR_OPTIONS::m_centre

Definition at line 326 of file dialog_create_array.h.

Referenced by DIALOG_CREATE_ARRAY::TransferDataFromWindow().

long DIALOG_CREATE_ARRAY::ARRAY_CIRCULAR_OPTIONS::m_nPts

Definition at line 324 of file dialog_create_array.h.

Referenced by DIALOG_CREATE_ARRAY::TransferDataFromWindow().

long DIALOG_CREATE_ARRAY::ARRAY_CIRCULAR_OPTIONS::m_numberingOffset

Definition at line 329 of file dialog_create_array.h.

Referenced by DIALOG_CREATE_ARRAY::TransferDataFromWindow().

bool DIALOG_CREATE_ARRAY::ARRAY_OPTIONS::m_numberingStartIsSpecified
protectedinherited

True if this array's number starts from the preset point False if the array numbering starts from some externally provided point.

Definition at line 276 of file dialog_create_array.h.

Referenced by DIALOG_CREATE_ARRAY::TransferDataFromWindow().

NUMBERING_TYPE_T DIALOG_CREATE_ARRAY::ARRAY_CIRCULAR_OPTIONS::m_numberingType

Definition at line 328 of file dialog_create_array.h.

Referenced by DIALOG_CREATE_ARRAY::TransferDataFromWindow().

bool DIALOG_CREATE_ARRAY::ARRAY_CIRCULAR_OPTIONS::m_rotateItems

Definition at line 327 of file dialog_create_array.h.

Referenced by DIALOG_CREATE_ARRAY::TransferDataFromWindow().

bool DIALOG_CREATE_ARRAY::ARRAY_OPTIONS::m_shouldNumber
protectedinherited

True if this array numbers the new items.

Definition at line 272 of file dialog_create_array.h.

Referenced by DIALOG_CREATE_ARRAY::TransferDataFromWindow().

ARRAY_TYPE_T DIALOG_CREATE_ARRAY::ARRAY_OPTIONS::m_type
inherited

Definition at line 229 of file dialog_create_array.h.


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