array_options.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2019-2021 KiCad Developers, see AUTHORS.txt for contributors.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, you may find one here:
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * or you may search the http://www.gnu.org website for the version 2 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
 */

#ifndef PCBNEW_ARRAY_OPTIONS__H
#define PCBNEW_ARRAY_OPTIONS__H

#include <math/vector2d.h>

#include <array_axis.h>

class ARRAY_OPTIONS
{
public:
 enum ARRAY_TYPE_T
 {
 ARRAY_GRID, 
 ARRAY_CIRCULAR, 
 };

 ARRAY_OPTIONS( ARRAY_TYPE_T aType ) :
 m_type( aType ),
 m_shouldNumber( false ),
 m_reannotateFootprints( false ),
 m_numberingStartIsSpecified( false )
 {
 }

 virtual ~ARRAY_OPTIONS(){};

 struct TRANSFORM
 {
 VECTOR2I m_offset;
 double m_rotation; // in degrees
 };

 virtual TRANSFORM GetTransform( int aN, const VECTOR2I& aPos ) const = 0;

 virtual int GetArraySize() const = 0;

 virtual wxString GetItemNumber( int n ) const = 0;

 bool ShouldNumberItems() const
 {
 return m_shouldNumber;
 }

 void SetShouldNumber( bool aShouldNumber )
 {
 m_shouldNumber = aShouldNumber;
 }

 bool ShouldReannotateFootprints() const
 {
 return m_reannotateFootprints;
 }

 void SetSShouldReannotateFootprints( bool aShouldReannotate )
 {
 m_reannotateFootprints = aShouldReannotate;
 }

 bool GetNumberingStartIsSpecified() const
 {
 return m_shouldNumber && m_numberingStartIsSpecified;
 }

 void SetNumberingStartIsSpecified( bool aIsSpecified )
 {
 m_numberingStartIsSpecified = aIsSpecified;
 }

protected:

 ARRAY_TYPE_T m_type;

 bool m_shouldNumber;

 bool m_reannotateFootprints;

 bool m_numberingStartIsSpecified;
};


struct ARRAY_GRID_OPTIONS : public ARRAY_OPTIONS
{
 ARRAY_GRID_OPTIONS()
 : ARRAY_OPTIONS( ARRAY_GRID ),
 m_nx( 0 ),
 m_ny( 0 ),
 m_horizontalThenVertical( true ),
 m_reverseNumberingAlternate( false ),
 m_stagger( 0 ),
 m_stagger_rows( true ),
 m_2dArrayNumbering( false )
 {
 }

 long m_nx, m_ny;
 bool m_horizontalThenVertical, m_reverseNumberingAlternate;
 VECTOR2I m_delta;
 VECTOR2I m_offset;
 long m_stagger;
 bool m_stagger_rows;
 bool m_2dArrayNumbering;
 ARRAY_AXIS m_pri_axis, m_sec_axis;

 TRANSFORM GetTransform( int aN, const VECTOR2I& aPos ) const override;
 int GetArraySize() const override;
 wxString GetItemNumber( int n ) const override;

private:
 VECTOR2I getGridCoords( int n ) const;
};


struct ARRAY_CIRCULAR_OPTIONS : public ARRAY_OPTIONS
{
 ARRAY_CIRCULAR_OPTIONS()
 : ARRAY_OPTIONS( ARRAY_CIRCULAR ),
 m_nPts( 0 ),
 m_angle( 0.0f ),
 m_rotateItems( false )
 {
 }

 long m_nPts;
 double m_angle;
 VECTOR2I m_centre;
 bool m_rotateItems;
 ARRAY_AXIS m_axis;

 TRANSFORM GetTransform( int aN, const VECTOR2I& aPos ) const override;
 int GetArraySize() const override;
 wxString GetItemNumber( int n ) const override;
};


#endif // PCBNEW_ARRAY_OPTIONS__H