KiCad PCB EDA Suite
•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages Concepts
Public Types | Public Member Functions | Public Attributes | Protected Attributes | List of all members
ARRAY_CIRCULAR_OPTIONS Struct Reference

#include <array_options.h>

Inheritance diagram for ARRAY_CIRCULAR_OPTIONS:
ARRAY_OPTIONS

Public Types

enum  ARRAY_TYPE_T { ARRAY_GRID , ARRAY_CIRCULAR }
 

Public Member Functions

 ARRAY_CIRCULAR_OPTIONS ()
 
TRANSFORM GetTransform (int aN, const VECTOR2I &aPos) const override
 Get the transform of the n-th point in the array.
 
int GetArraySize () const override
 The number of points in this array.
 
wxString GetItemNumber (int n) const override
 Get the position number (name) for the n'th array point.
 
bool ShouldNumberItems () const
 
void SetShouldNumber (bool aShouldNumber)
 
bool ShouldArrangeSelection () const
 
void SetShouldArrangeSelection (bool aShouldArrange)
 
bool ShouldReannotateFootprints () const
 
void SetSShouldReannotateFootprints (bool aShouldReannotate)
 
bool GetNumberingStartIsSpecified () const
 
void SetNumberingStartIsSpecified (bool aIsSpecified)
 

Public Attributes

long m_nPts
 number of point in the array
 
EDA_ANGLE m_angle
 angle between points, or 0 for each point separated by this value (decideg)
 
VECTOR2I m_centre
 
bool m_rotateItems
 
ARRAY_AXIS m_axis
 

Protected Attributes

ARRAY_TYPE_T m_type
 
bool m_shouldNumber
 True if this array numbers the new items.
 
bool m_arrangeSelection
 True if this array should arrange the selected items instead of creating an array of copies of the selection.
 
bool m_reannotateFootprints
 True if this array will rename any footprints to be unique.
 
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.
 

Detailed Description

Definition at line 200 of file array_options.h.

Member Enumeration Documentation

◆ ARRAY_TYPE_T

enum ARRAY_OPTIONS::ARRAY_TYPE_T
inherited
Enumerator
ARRAY_GRID 

A grid (x*y) array.

ARRAY_CIRCULAR 

A circular array.

Definition at line 41 of file array_options.h.

Constructor & Destructor Documentation

◆ ARRAY_CIRCULAR_OPTIONS()

ARRAY_CIRCULAR_OPTIONS::ARRAY_CIRCULAR_OPTIONS ( )
inline

Definition at line 202 of file array_options.h.

Member Function Documentation

◆ GetArraySize()

int ARRAY_CIRCULAR_OPTIONS::GetArraySize ( ) const
overridevirtual

The number of points in this array.

Implements ARRAY_OPTIONS.

Definition at line 119 of file array_options.cpp.

References m_nPts.

◆ GetItemNumber()

wxString ARRAY_CIRCULAR_OPTIONS::GetItemNumber ( int  n) const
overridevirtual

Get the position number (name) for the n'th array point.

Parameters
narray point index, from 0 to GetArraySize() - 1.
Returns
the point's name.

Implements ARRAY_OPTIONS.

Definition at line 147 of file array_options.cpp.

References ARRAY_AXIS::GetItemNumber(), and m_axis.

◆ GetNumberingStartIsSpecified()

bool ARRAY_OPTIONS::GetNumberingStartIsSpecified ( ) 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 134 of file array_options.h.

Referenced by ARRAY_PAD_NUMBER_PROVIDER::ARRAY_PAD_NUMBER_PROVIDER().

◆ GetTransform()

ARRAY_OPTIONS::TRANSFORM ARRAY_CIRCULAR_OPTIONS::GetTransform ( int  aN,
const VECTOR2I &  aPos 
) const
overridevirtual

Get the transform of the n-th point in the array.

Parameters
aNthe index of the array point (0 is the original point).
aPosthe existing item position.
Returns
a transform (an offset and a rotation)/

Implements ARRAY_OPTIONS.

Definition at line 125 of file array_options.cpp.

References ANGLE_0, EDA_ANGLE::AsDegrees(), DEGREES_T, EDA_ANGLE::IsZero(), m_angle, m_centre, m_nPts, m_rotateItems, and RotatePoint().

◆ SetNumberingStartIsSpecified()

void ARRAY_OPTIONS::SetNumberingStartIsSpecified ( bool  aIsSpecified)
inlineinherited

Definition at line 139 of file array_options.h.

◆ SetShouldArrangeSelection()

void ARRAY_OPTIONS::SetShouldArrangeSelection ( bool  aShouldArrange)
inlineinherited

Definition at line 110 of file array_options.h.

◆ SetShouldNumber()

void ARRAY_OPTIONS::SetShouldNumber ( bool  aShouldNumber)
inlineinherited

Definition at line 97 of file array_options.h.

◆ SetSShouldReannotateFootprints()

void ARRAY_OPTIONS::SetSShouldReannotateFootprints ( bool  aShouldReannotate)
inlineinherited

Definition at line 124 of file array_options.h.

◆ ShouldArrangeSelection()

bool ARRAY_OPTIONS::ShouldArrangeSelection ( ) const
inlineinherited
Returns
true if arranging selection, false if creating an array of copies

Definition at line 105 of file array_options.h.

◆ ShouldNumberItems()

bool ARRAY_OPTIONS::ShouldNumberItems ( ) const
inlineinherited
Returns
are the items in this array numbered, or are all the items numbered the same?

Definition at line 92 of file array_options.h.

◆ ShouldReannotateFootprints()

bool ARRAY_OPTIONS::ShouldReannotateFootprints ( ) const
inlineinherited
Returns
are the footprints in this array reannotated to be unique (true), or do they keep the original annotation (false)?

Definition at line 119 of file array_options.h.

Member Data Documentation

◆ m_angle

EDA_ANGLE ARRAY_CIRCULAR_OPTIONS::m_angle

angle between points, or 0 for each point separated by this value (decideg)

Definition at line 214 of file array_options.h.

Referenced by BOOST_AUTO_TEST_CASE(), and GetTransform().

◆ m_arrangeSelection

bool ARRAY_OPTIONS::m_arrangeSelection
protectedinherited

True if this array should arrange the selected items instead of creating an array of copies of the selection.

Definition at line 153 of file array_options.h.

◆ m_axis

ARRAY_AXIS ARRAY_CIRCULAR_OPTIONS::m_axis

Definition at line 217 of file array_options.h.

Referenced by GetItemNumber().

◆ m_centre

VECTOR2I ARRAY_CIRCULAR_OPTIONS::m_centre

Definition at line 215 of file array_options.h.

Referenced by BOOST_AUTO_TEST_CASE(), and GetTransform().

◆ m_nPts

long ARRAY_CIRCULAR_OPTIONS::m_nPts

number of point in the array

Definition at line 211 of file array_options.h.

Referenced by BOOST_AUTO_TEST_CASE(), GetArraySize(), and GetTransform().

◆ m_numberingStartIsSpecified

bool 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 160 of file array_options.h.

◆ m_reannotateFootprints

bool ARRAY_OPTIONS::m_reannotateFootprints
protectedinherited

True if this array will rename any footprints to be unique.

Definition at line 156 of file array_options.h.

◆ m_rotateItems

bool ARRAY_CIRCULAR_OPTIONS::m_rotateItems

Definition at line 216 of file array_options.h.

Referenced by BOOST_AUTO_TEST_CASE(), and GetTransform().

◆ m_shouldNumber

bool ARRAY_OPTIONS::m_shouldNumber
protectedinherited

True if this array numbers the new items.

Definition at line 149 of file array_options.h.

◆ m_type

ARRAY_TYPE_T ARRAY_OPTIONS::m_type
protectedinherited

Definition at line 146 of file array_options.h.

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