lib_item.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2015 Jean-Pierre Charras, jaen-pierre.charras at wanadoo.fr
 * Copyright (C) 2015 Wayne Stambaugh <[email protected]>
 * Copyright (C) 2004-2023 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 _LIB_ITEM_H_
#define _LIB_ITEM_H_
 
#include <eda_item.h>
#include <eda_shape.h>
#include <transform.h>
#include <render_settings.h>
 
class LINE_READER;
class OUTPUTFORMATTER;
class LIB_SYMBOL;
class PLOTTER;
class LIB_PIN;
class MSG_PANEL_ITEM;
 
namespace KIFONT
{
class FONT;
class METRICS;
}
 
 
using KIGFX::RENDER_SETTINGS;
 
extern const int fill_tab[];
 
 
#define MINIMUM_SELECTION_DISTANCE 2 // Minimum selection distance in internal units
 
 
typedef std::vector< LIB_PIN* > LIB_PINS;
 
 
class LIB_ITEM : public EDA_ITEM
{
public:
 LIB_ITEM( KICAD_T aType, LIB_SYMBOL* aSymbol = nullptr, int aUnit = 0, int aConvert = 0 );
 
 // Do not create a copy constructor. The one generated by the compiler is adequate.
 
 virtual ~LIB_ITEM() { }
 
 // Define the enums for basic
 enum LIB_CONVERT : int { BASE = 1, DEMORGAN = 2 };
 
 enum COMPARE_FLAGS : int
 {
 UNIT = 0x01,
 EQUALITY = 0x02,
 ERC = 0x04
 };
 
 virtual wxString GetTypeName() const = 0;
 
 static inline bool ClassOf( const EDA_ITEM* aItem )
 {
 if( !aItem )
 return false;
 
 switch ( aItem->Type() )
 {
 case LIB_SHAPE_T:
 case LIB_TEXT_T:
 case LIB_TEXTBOX_T:
 case LIB_PIN_T:
 case LIB_FIELD_T:
 return true;
 default:
 break;
 }
 
 return false;
 }
 
 LIB_ITEM* Duplicate() const;
 
 virtual void BeginEdit( const VECTOR2I& aPosition ) {}
 
 virtual bool ContinueEdit( const VECTOR2I& aPosition ) { return false; }
 
 virtual void EndEdit( bool aClosed = false ) {}
 
 virtual void CalcEdit( const VECTOR2I& aPosition ) {}
 
 virtual void Print( const RENDER_SETTINGS* aSettings, const VECTOR2I& aOffset, void* aData,
 const TRANSFORM& aTransform, bool aDimmed );
 
 virtual int GetPenWidth() const = 0;
 
 const wxString& GetDefaultFont() const;
 
 const KIFONT::METRICS& GetFontMetrics() const;
 
 virtual int GetEffectivePenWidth( const RENDER_SETTINGS* aSettings ) const
 {
 // For historical reasons, a stored value of 0 means "default width" and negative
 // numbers meant "don't stroke".
 
 if( GetPenWidth() < 0 )
 return 0;
 else if( GetPenWidth() == 0 )
 return std::max( aSettings->GetDefaultPenWidth(), aSettings->GetMinPenWidth() );
 else
 return std::max( GetPenWidth(), aSettings->GetMinPenWidth() );
 }
 
 LIB_SYMBOL* GetParent() const
 {
 return (LIB_SYMBOL*) m_parent;
 }
 
 void ViewGetLayers( int aLayers[], int& aCount ) const override;
 
 bool HitTest( const VECTOR2I& aPosition, int aAccuracy = 0 ) const override
 {
 // This is just here to prevent annoying compiler warnings about hidden overloaded
 // virtual functions
 return EDA_ITEM::HitTest( aPosition, aAccuracy );
 }
 
 bool HitTest( const BOX2I& aRect, bool aContained, int aAccuracy = 0 ) const override;
 
 const BOX2I GetBoundingBox() const override { return EDA_ITEM::GetBoundingBox(); }
 
 void GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList ) override;
 
 bool operator==( const LIB_ITEM& aOther ) const;
 bool operator==( const LIB_ITEM* aOther ) const
 {
 return *this == *aOther;
 }
 
 bool operator<( const LIB_ITEM& aOther) const;
 
 virtual void Offset( const VECTOR2I& aOffset ) = 0;
 
 virtual void MoveTo( const VECTOR2I& aPosition ) = 0;
 
 void SetPosition( const VECTOR2I& aPosition ) override { MoveTo( aPosition ); }
 
 virtual void MirrorHorizontal( const VECTOR2I& aCenter ) = 0;
 
 virtual void MirrorVertical( const VECTOR2I& aCenter ) = 0;
 
 virtual void Rotate( const VECTOR2I& aCenter, bool aRotateCCW = true ) = 0;
 
 virtual void Plot( PLOTTER* aPlotter, bool aBackground, const VECTOR2I& aOffset,
 const TRANSFORM& aTransform, bool aDimmed ) const = 0;
 
 void SetUnit( int aUnit ) { m_unit = aUnit; }
 int GetUnit() const { return m_unit; }
 
 void SetConvert( int aConvert ) { m_convert = aConvert; }
 int GetConvert() const { return m_convert; }
 
 void SetPrivate( bool aPrivate ) { m_private = aPrivate; }
 bool IsPrivate() const { return m_private; }
 
 struct cmp_items
 {
 bool operator()( const LIB_ITEM* aFirst, const LIB_ITEM* aSecond ) const;
 };
 
#if defined(DEBUG)
 void Show( int nestLevel, std::ostream& os ) const override { ShowDummy( os ); }
#endif
 
protected:
 virtual int compare( const LIB_ITEM& aOther, int aCompareFlags = 0 ) const;
 
 virtual void print( const RENDER_SETTINGS* aSettings, const VECTOR2I& aOffset, void* aData,
 const TRANSFORM& aTransform, bool aDimmed ) = 0;
 
private:
 friend class LIB_SYMBOL;
 
protected:
 int m_unit;
 
 int m_convert;
 
 bool m_private;
};
 
 
#endif // _LIB_ITEM_H_