symb_transforms_utils.cpp

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Author Jean-Pierre Charras, jp.charras at wanadoo.fr
 * Copyright (C) 2024 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 3 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, see <http://www.gnu.org/licenses/>.
 */
 
#include "symb_transforms_utils.h"
 
#include <lib_symbol.h>
#include <sch_symbol.h>
 
struct ORIENT_MIRROR
{
    int flag;
    int n_rots;
    int mirror_x;
    int mirror_y;
};
 
 
// symbols_orientations_list is the list of possible orientation+mirror values
// like returned by SCH_SYMBOL::GetOrientation()
// Some transforms are equivalent, like rotation 180 + mirror X = mirror Y
 
static ORIENT_MIRROR symbols_orientations_list[] =
{
    { SYM_ORIENT_0,                  0, 0, 0 },
    { SYM_ORIENT_90,                 1, 0, 0 },
    { SYM_ORIENT_180,                2, 0, 0 },
    { SYM_ORIENT_270,                3, 0, 0 },
    { SYM_MIRROR_X + SYM_ORIENT_0,   0, 1, 0 },
    { SYM_MIRROR_X + SYM_ORIENT_90,  1, 1, 0 },
    { SYM_MIRROR_Y,                  0, 0, 1 },
    { SYM_MIRROR_X + SYM_ORIENT_270, 3, 1, 0 },
    { SYM_MIRROR_Y + SYM_ORIENT_0,   0, 0, 1 },
    { SYM_MIRROR_Y + SYM_ORIENT_90,  1, 0, 1 },
    { SYM_MIRROR_Y + SYM_ORIENT_180, 2, 0, 1 },
    { SYM_MIRROR_Y + SYM_ORIENT_270, 3, 0, 1 }
};
 
 
void OrientAndMirrorSymbolItems( LIB_SYMBOL* aSymbol, int aOrientation )
{
    ORIENT_MIRROR o = symbols_orientations_list[ 0 ];
 
    for( ORIENT_MIRROR& i : symbols_orientations_list )
    {
        if( i.flag == aOrientation )
        {
            o = i;
            break;
        }
    }
 
    for( SCH_ITEM& item : aSymbol->GetDrawItems() )
    {
        for( int i = 0; i < o.n_rots; i++ )
            item.Rotate( VECTOR2I( 0, 0 ), true );
 
        if( o.mirror_x )
            item.MirrorVertically( 0 );
 
        if( o.mirror_y )
            item.MirrorHorizontally( 0 );
    }
}
 
 
 
// Rotate and/or mirror a SCH_PIN according to aOrientMirror.
// aOrientMirror is the orientation/mirror of the parent symbol.
// The modified pin orientation is the actual pin orientation/mirror
// when the parent symbol is drawn.
void RotateAndMirrorPin( SCH_PIN& aPin, int aOrientMirror )
{
    ORIENT_MIRROR o = symbols_orientations_list[ 0 ];
 
    for( ORIENT_MIRROR& i : symbols_orientations_list )
    {
        if( i.flag == aOrientMirror )
        {
            o = i;
            break;
        }
    }
 
    for( int i = 0; i < o.n_rots; i++ )
        aPin.RotatePin( VECTOR2I( 0, 0 ), true );
 
    if( o.mirror_x )
        aPin.MirrorVerticallyPin( 0 );
 
    if( o.mirror_y )
        aPin.MirrorHorizontallyPin( 0 );
}
 
SPIN_STYLE GetPinSpinStyle( const SCH_PIN& aPin, const SCH_SYMBOL& aSymbol )
{
    SPIN_STYLE ret = SPIN_STYLE::UP;
 
    if( aPin.GetOrientation() == PIN_ORIENTATION::PIN_RIGHT )
        ret = SPIN_STYLE::LEFT;
    else if( aPin.GetOrientation() == PIN_ORIENTATION::PIN_LEFT )
        ret = SPIN_STYLE::RIGHT;
    else if( aPin.GetOrientation() == PIN_ORIENTATION::PIN_UP )
        ret = SPIN_STYLE::BOTTOM;
    else if( aPin.GetOrientation() == PIN_ORIENTATION::PIN_DOWN )
        ret = SPIN_STYLE::UP;
 
    switch( static_cast<SYMBOL_ORIENTATION_T>( aSymbol.GetOrientation()
                                               & ( ~( SYM_MIRROR_X | SYM_MIRROR_Y ) ) ) )
    {
    case SYM_ROTATE_CLOCKWISE:
    case SYM_ORIENT_90:
        if( ret == SPIN_STYLE::UP )
            ret = SPIN_STYLE::LEFT;
        else if( ret == SPIN_STYLE::BOTTOM )
            ret = SPIN_STYLE::RIGHT;
        else if( ret == SPIN_STYLE::LEFT )
            ret = SPIN_STYLE::BOTTOM;
        else if( ret == SPIN_STYLE::RIGHT )
            ret = SPIN_STYLE::UP;
 
        if( aSymbol.GetOrientation() & SYM_MIRROR_X )
        {
            if( ret == SPIN_STYLE::UP )
                ret = SPIN_STYLE::BOTTOM;
            else if( ret == SPIN_STYLE::BOTTOM )
                ret = SPIN_STYLE::UP;
        }
 
        if( aSymbol.GetOrientation() & SYM_MIRROR_Y )
        {
            if( ret == SPIN_STYLE::LEFT )
                ret = SPIN_STYLE::RIGHT;
            else if( ret == SPIN_STYLE::RIGHT )
                ret = SPIN_STYLE::LEFT;
        }
        break;
    case SYM_ROTATE_COUNTERCLOCKWISE:
    case SYM_ORIENT_270:
        if( ret == SPIN_STYLE::UP )
            ret = SPIN_STYLE::RIGHT;
        else if( ret == SPIN_STYLE::BOTTOM )
            ret = SPIN_STYLE::LEFT;
        else if( ret == SPIN_STYLE::LEFT )
            ret = SPIN_STYLE::UP;
        else if( ret == SPIN_STYLE::RIGHT )
            ret = SPIN_STYLE::BOTTOM;
 
        if( aSymbol.GetOrientation() & SYM_MIRROR_X )
        {
            if( ret == SPIN_STYLE::UP )
                ret = SPIN_STYLE::BOTTOM;
            else if( ret == SPIN_STYLE::BOTTOM )
                ret = SPIN_STYLE::UP;
        }
 
        if( aSymbol.GetOrientation() & SYM_MIRROR_Y )
        {
            if( ret == SPIN_STYLE::LEFT )
                ret = SPIN_STYLE::RIGHT;
            else if( ret == SPIN_STYLE::RIGHT )
                ret = SPIN_STYLE::LEFT;
        }
        break;
    case SYM_ORIENT_180:
        if( ret == SPIN_STYLE::UP )
            ret = SPIN_STYLE::BOTTOM;
        else if( ret == SPIN_STYLE::BOTTOM )
            ret = SPIN_STYLE::UP;
        else if( ret == SPIN_STYLE::LEFT )
            ret = SPIN_STYLE::RIGHT;
        else if( ret == SPIN_STYLE::RIGHT )
            ret = SPIN_STYLE::LEFT;
 
        if( aSymbol.GetOrientation() & SYM_MIRROR_X )
        {
            if( ret == SPIN_STYLE::UP )
                ret = SPIN_STYLE::BOTTOM;
            else if( ret == SPIN_STYLE::BOTTOM )
                ret = SPIN_STYLE::UP;
        }
 
        if( aSymbol.GetOrientation() & SYM_MIRROR_Y )
        {
            if( ret == SPIN_STYLE::LEFT )
                ret = SPIN_STYLE::RIGHT;
            else if( ret == SPIN_STYLE::RIGHT )
                ret = SPIN_STYLE::LEFT;
        }
        break;
    case SYM_ORIENT_0:
    case SYM_NORMAL:
    default:
        if( aSymbol.GetOrientation() & SYM_MIRROR_X )
        {
            if( ret == SPIN_STYLE::UP )
                ret = SPIN_STYLE::BOTTOM;
            else if( ret == SPIN_STYLE::BOTTOM )
                ret = SPIN_STYLE::UP;
        }
 
        if( aSymbol.GetOrientation() & SYM_MIRROR_Y )
        {
            if( ret == SPIN_STYLE::LEFT )
                ret = SPIN_STYLE::RIGHT;
            else if( ret == SPIN_STYLE::RIGHT )
                ret = SPIN_STYLE::LEFT;
        }
        break;
    }
 
    return ret;
}