pcb_point.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2004 Jean-Pierre Charras, jp.charras at wanadoo.fr
 * Copyright The 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, see <https://www.gnu.org/licenses/>.
 */
 
#pragma once
 
#include <board_item.h>
 

class PCB_POINT : public BOARD_ITEM
{
public:
 
    PCB_POINT( BOARD_ITEM* aParent );

    PCB_POINT( BOARD_ITEM* aParent, const VECTOR2I& aPos, const int aSize);
 
    static inline bool ClassOf( const EDA_ITEM* aItem )
    {
        return aItem && PCB_POINT_T == aItem->Type();
    }
 
    struct cmp_points
    {
        bool operator()( const PCB_POINT* a, const PCB_POINT* b ) const;
    };
 
    void     SetPosition( const VECTOR2I& aPos ) override;
    VECTOR2I GetPosition() const override { return m_pos; }
    VECTOR2I GetLibraryPosition() const { return m_libPos; }
 
    void SetParent( EDA_ITEM* aParent ) override;

    void OnFootprintTransformed() override;
 
    void SetSize( const int aSize ) { m_size = aSize; }
    int  GetSize() const { return m_size; }
 
    void Move( const VECTOR2I& aMoveVector ) override { SetPosition( GetPosition() + aMoveVector ); }
 
    double ViewGetLOD( int aLayer, const KIGFX::VIEW* aView ) const override;
    std::vector<int> ViewGetLayers() const override;
 
    void Rotate( const VECTOR2I& aRotCentre, const EDA_ANGLE& aAngle ) override;
 
    void Flip( const VECTOR2I& aCentre, FLIP_DIRECTION aFlipDirection ) override;
 
    wxString GetClass() const override
    {
        return wxT( "PCB_POINT" );
    }
 
    bool HitTest( const VECTOR2I& aPosition, int aAccuracy = 0 ) const override;
    bool HitTest( const BOX2I& aRect, bool aContained, int aAccuracy = 0 ) const override;
 
    // Virtual function
    const BOX2I GetBoundingBox() const override;
 
    std::shared_ptr<SHAPE> GetEffectiveShape( PCB_LAYER_ID aLayer = UNDEFINED_LAYER,
                                              FLASHING aFlash = FLASHING::DEFAULT,
                                              DRC_CONSTRAINT_T aUsage = NULL_CONSTRAINT ) const override;
 
    wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider, bool aFull ) const override;
 
    BITMAPS GetMenuImage() const override;
 
    EDA_ITEM* Clone() const override;
 
    void CopyFrom( const BOARD_ITEM* aOther ) override;
 
    void Serialize( google::protobuf::Any& aContainer ) const override;
    bool Deserialize( const google::protobuf::Any& aContainer ) override;
 
    void GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList ) override;

    void TransformShapeToPolygon( SHAPE_POLY_SET& aBuffer, PCB_LAYER_ID aLayer, int aClearance,
                                  int aError, ERROR_LOC aErrorLoc,
                                  bool ignoreLineWidth = false ) const override;
 
    double Similarity( const BOARD_ITEM& aBoardItem ) const override;
 
    bool operator==( const PCB_POINT& aOther ) const;
    bool operator==( const BOARD_ITEM& aBoardItem ) const override;
 
#if defined( DEBUG )
    void Show( int nestLevel, std::ostream& os ) const override { ShowDummy( os ); }
#endif
 
protected:
    virtual void swapData( BOARD_ITEM* aImage ) override;
 
private:
    void recomputePosition();
 
    // Position in parent footprint's library frame (or board space if no parent footprint)
    VECTOR2I m_libPos;
    // Cached board-space position, refreshed when the parent footprint transform changes
    VECTOR2I m_pos;
    // Visual size of the point in board space
    int m_size;
};