KiCad PCB EDA Suite
|
Options that govern the setup of an "array" of multiple item. More...
#include <array_options.h>
Classes | |
struct | TRANSFORM |
Transform applied to an object by this array. More... | |
Public Types | |
enum | ARRAY_TYPE_T { ARRAY_GRID , ARRAY_CIRCULAR } |
Public Member Functions | |
ARRAY_OPTIONS (ARRAY_TYPE_T aType) | |
virtual | ~ARRAY_OPTIONS () |
virtual TRANSFORM | GetTransform (int aN, const VECTOR2I &aPos) const =0 |
Get the transform of the n-th point in the array. More... | |
virtual int | GetArraySize () const =0 |
The number of points in this array. More... | |
virtual wxString | GetItemNumber (int n) const =0 |
Get the position number (name) for the n'th array point. More... | |
bool | ShouldNumberItems () const |
void | SetShouldNumber (bool aShouldNumber) |
bool | ShouldReannotateFootprints () const |
void | SetSShouldReannotateFootprints (bool aShouldReannotate) |
bool | GetNumberingStartIsSpecified () const |
void | SetNumberingStartIsSpecified (bool aIsSpecified) |
Protected Attributes | |
ARRAY_TYPE_T | m_type |
bool | m_shouldNumber |
True if this array numbers the new items. More... | |
bool | m_reannotateFootprints |
True if this array will rename any footprints to be unique. 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... | |
Options that govern the setup of an "array" of multiple item.
The base ARRAY_OPTIONS do not encode a specific geometry or numbering method, this is done by derived classes.
Definition at line 36 of file array_options.h.
Enumerator | |
---|---|
ARRAY_GRID | A grid (x*y) array. |
ARRAY_CIRCULAR | A circular array. |
Definition at line 39 of file array_options.h.
|
inline |
Definition at line 45 of file array_options.h.
|
inlinevirtual |
Definition at line 53 of file array_options.h.
|
pure virtual |
The number of points in this array.
Implemented in ARRAY_GRID_OPTIONS, and ARRAY_CIRCULAR_OPTIONS.
Referenced by CheckArrayNumbering(), and CheckArrayTransforms().
|
pure virtual |
Get the position number (name) for the n'th array point.
n | array point index, from 0 to GetArraySize() - 1 |
Implemented in ARRAY_GRID_OPTIONS, and ARRAY_CIRCULAR_OPTIONS.
Referenced by CheckArrayNumbering(), and ARRAY_PAD_NUMBER_PROVIDER::getNextNumber().
|
inline |
Definition at line 117 of file array_options.h.
References m_numberingStartIsSpecified, and m_shouldNumber.
Referenced by ARRAY_PAD_NUMBER_PROVIDER::ARRAY_PAD_NUMBER_PROVIDER().
Get the transform of the n-th point in the array.
aN | the index of the array point (0 is the original point) |
aPos | the existing item position |
Implemented in ARRAY_GRID_OPTIONS, and ARRAY_CIRCULAR_OPTIONS.
Referenced by CheckArrayTransforms(), and TransformItem().
|
inline |
Definition at line 122 of file array_options.h.
References m_numberingStartIsSpecified.
|
inline |
Definition at line 93 of file array_options.h.
References m_shouldNumber.
|
inline |
Definition at line 107 of file array_options.h.
References m_reannotateFootprints.
|
inline |
Definition at line 88 of file array_options.h.
References m_shouldNumber.
|
inline |
Definition at line 102 of file array_options.h.
References m_reannotateFootprints.
|
protected |
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 139 of file array_options.h.
Referenced by GetNumberingStartIsSpecified(), and SetNumberingStartIsSpecified().
|
protected |
True if this array will rename any footprints to be unique.
Definition at line 135 of file array_options.h.
Referenced by SetSShouldReannotateFootprints(), and ShouldReannotateFootprints().
|
protected |
True if this array numbers the new items.
Definition at line 132 of file array_options.h.
Referenced by GetNumberingStartIsSpecified(), SetShouldNumber(), and ShouldNumberItems().
|
protected |
Definition at line 129 of file array_options.h.