#include <dialog_create_array.h>

Inheritance diagram for DIALOG_CREATE_ARRAY::ARRAY_CIRCULAR_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

ARRAY_NUMBERING_TYPE_T	m_numberingType

long	m_numberingOffset

ARRAY_TYPE_T	m_type

Static Protected Member Functions
static wxString	getCoordinateNumber (int n, ARRAY_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 295 of file dialog_create_array.h.

Constructor & Destructor Documentation

DIALOG_CREATE_ARRAY::ARRAY_CIRCULAR_OPTIONS::ARRAY_CIRCULAR_OPTIONS ( )

inline

Definition at line 297 of file dialog_create_array.h.

                                  :
             ARRAY_OPTIONS( ARRAY_CIRCULAR ),
             m_nPts( 0 ),
             m_angle( 0.0f ),
             m_rotateItems( false ),
             m_numberingType( NUMBERING_NUMERIC ),
             m_numberingOffset( 0 )
         {}

Member Function Documentation

int DIALOG_CREATE_ARRAY::ARRAY_CIRCULAR_OPTIONS::GetArraySize ( ) const

overridevirtual

Implements DIALOG_CREATE_ARRAY::ARRAY_OPTIONS.

Definition at line 583 of file dialog_create_array.cpp.

 {
     return m_nPts;
 }

wxString DIALOG_CREATE_ARRAY::ARRAY_OPTIONS::getCoordinateNumber	(	int	n,
		ARRAY_NUMBERING_TYPE_T	type
	)

staticprotectedinherited

Definition at line 471 of file dialog_create_array.cpp.

References alphabetFromNumberingScheme(), and schemeNonUnitColsStartAt0().

 {
     wxString itemNum;
     const wxString& alphabet = alphabetFromNumberingScheme( type );
 
     const bool nonUnitColsStartAt0 = schemeNonUnitColsStartAt0( type );
 
     bool    firstRound = true;
     int     radix = alphabet.Length();
 
     do {
         int modN = n % radix;
 
         if( nonUnitColsStartAt0 && !firstRound )
             modN--;    // Start the "tens/hundreds/etc column" at "Ax", not "Bx"
 
         itemNum.insert( 0, 1, alphabet[modN] );
 
         n /= radix;
         firstRound = false;
     } while( n );
 
     return itemNum;
 }

wxString DIALOG_CREATE_ARRAY::ARRAY_CIRCULAR_OPTIONS::GetItemNumber ( int n ) const

overridevirtual

Implements DIALOG_CREATE_ARRAY::ARRAY_OPTIONS.

Definition at line 609 of file dialog_create_array.cpp.

 {
     return getCoordinateNumber( aN + m_numberingOffset, m_numberingType );
 }

wxString DIALOG_CREATE_ARRAY::ARRAY_OPTIONS::InterpolateNumberIntoString	(	int	n,
		const wxString &	pattern
	)		const

virtualinherited

Definition at line 498 of file dialog_create_array.cpp.

 {
     wxString newStr( aPattern );
     newStr.Replace( "%s", GetItemNumber( aN ), false );
 
     return newStr;
 }

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 242 of file dialog_create_array.h.

References CONFIG_SAVE_RESTORE_WINDOW::CONFIG_CTRL_T::type.

Referenced by ARRAY_CREATOR::Invoke().

         {
             return m_shouldNumber && m_numberingStartIsSpecified;
         }

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 232 of file dialog_create_array.h.

Referenced by ARRAY_CREATOR::Invoke().

         {
             return m_shouldNumber;
         }

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 589 of file dialog_create_array.cpp.

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

 {
     double angle;
 
     if( m_angle == 0 )
         // angle is zero, divide evenly into m_nPts
         angle = 3600.0 * n / double( m_nPts );
     else
         // n'th step
         angle = m_angle * n;
 
     item->Rotate( m_centre, angle );
 
     // take off the rotation (but not the translation) if needed
     if( !m_rotateItems )
         item->Rotate( item->GetCenter(), -angle );
 }