dimension.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, jaen-pierre.charras@gipsa-lab.inpg.com
 * Copyright (C) 1992-2020 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 DIMENSION_H
#define DIMENSION_H


#include <board_item.h>
#include <pcb_text.h>
#include <geometry/shape.h>
#include <geometry/circle.h>

class LINE_READER;
class MSG_PANEL_ITEM;


enum class DIM_UNITS_FORMAT
{
    NO_SUFFIX,      // 1234.0
    BARE_SUFFIX,    // 1234.0 mm
    PAREN_SUFFIX    // 1234.0 (mm)
};

enum class DIM_TEXT_POSITION
{
    OUTSIDE,    
    INLINE,     
    MANUAL      
};

enum class DIM_UNITS_MODE
{
    INCHES,
    MILS,
    MILLIMETRES,
    AUTOMATIC
};

enum class DIM_TEXT_FRAME
{
    NONE,
    RECTANGLE,
    CIRCLE,
    ROUNDRECT
};

class DIMENSION_BASE : public BOARD_ITEM
{
public:
    DIMENSION_BASE( BOARD_ITEM* aParent, KICAD_T aType = PCB_DIMENSION_T );

    bool IsType( const KICAD_T aScanTypes[] ) const override
    {
        if( BOARD_ITEM::IsType( aScanTypes ) )
            return true;

        for( const KICAD_T* p = aScanTypes; *p != EOT; ++p )
        {
            if( *p == PCB_LOCATE_GRAPHIC_T )
                return true;
        }

        return false;
    }

    void SetParent( EDA_ITEM* aParent ) override;

    virtual const wxPoint& GetStart() const { return m_start; }
    virtual void SetStart( const wxPoint& aPoint ) { m_start = aPoint; }

    virtual const wxPoint& GetEnd() const { return m_end; }
    virtual void SetEnd( const wxPoint& aPoint ) { m_end = aPoint; }

    wxPoint GetPosition() const override { return m_start; }
    void SetPosition( const wxPoint& aPos ) override { m_start = aPos; }

    bool GetOverrideTextEnabled() const { return m_overrideTextEnabled; }
    void SetOverrideTextEnabled( bool aOverride ) { m_overrideTextEnabled = aOverride; }

    wxString GetOverrideText() const { return m_valueString; }
    void SetOverrideText( const wxString& aValue ) { m_valueString = aValue; }

    int GetMeasuredValue() const { return m_measuredValue; }

    wxString GetValueText() const;

    void Update()
    {
        updateGeometry();
        updateText();
    }

    wxString GetPrefix() const { return m_prefix; }
    void SetPrefix( const wxString& aPrefix );

    wxString GetSuffix() const { return m_suffix; }
    void SetSuffix( const wxString& aSuffix );

    void GetUnits( EDA_UNITS& aUnits ) const { aUnits = m_units; }
    void SetUnits( EDA_UNITS aUnits );

    DIM_UNITS_MODE GetUnitsMode() const;
    void SetUnitsMode( DIM_UNITS_MODE aMode );

    void SetAutoUnits( bool aAuto = true ) { m_autoUnits = aAuto; }

    DIM_UNITS_FORMAT GetUnitsFormat() const { return m_unitsFormat; }
    void SetUnitsFormat( const DIM_UNITS_FORMAT aFormat ) { m_unitsFormat = aFormat; }

    int GetPrecision() const { return m_precision; }
    void SetPrecision( int aPrecision ) { m_precision = aPrecision; }

    bool GetSuppressZeroes() const { return m_suppressZeroes; }
    void SetSuppressZeroes( bool aSuppress ) { m_suppressZeroes = aSuppress; }

    bool GetKeepTextAligned() const { return m_keepTextAligned; }
    void SetKeepTextAligned( bool aKeepAligned ) { m_keepTextAligned = aKeepAligned; }

    void SetTextPositionMode( DIM_TEXT_POSITION aMode ) { m_textPosition = aMode; }
    DIM_TEXT_POSITION GetTextPositionMode() const { return m_textPosition; }

    int GetArrowLength() const { return m_arrowLength; }
    void SetArrowLength( int aLength ) { m_arrowLength = aLength; }

    void SetExtensionOffset( int aOffset ) { m_extensionOffset = aOffset; }
    int GetExtensionOffset() const { return m_extensionOffset; }

    int GetLineThickness() const        { return m_lineThickness; }
    void SetLineThickness( int aWidth ) { m_lineThickness = aWidth; }

    void SetLayer( PCB_LAYER_ID aLayer ) override;

    void SetTextSize( const wxSize& aTextSize )
    {
        m_text.SetTextSize( aTextSize );
    }

    void           SetText( const wxString& aNewText );

    const wxString GetText() const;

    PCB_TEXT& Text() { return m_text; }
    const PCB_TEXT& Text() const { return m_text; }

    const std::vector<std::shared_ptr<SHAPE>>& GetShapes() const { return m_shapes; }

    // BOARD_ITEM overrides

    void Move( const wxPoint& offset ) override;
    void Rotate( const wxPoint& aRotCentre, double aAngle ) override;
    void Flip( const wxPoint& aCentre, bool aFlipLeftRight ) override;

    void Mirror( const wxPoint& axis_pos, bool aMirrorLeftRight = false );

    void GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList ) override;

    bool HitTest( const wxPoint& aPosition, int aAccuracy ) const override;
    bool HitTest( const EDA_RECT& aRect, bool aContained, int aAccuracy = 0 ) const override;

    const EDA_RECT GetBoundingBox() const override;

    std::shared_ptr<SHAPE> GetEffectiveShape( PCB_LAYER_ID aLayer ) const override;

    wxString GetSelectMenuText( EDA_UNITS aUnits ) const override;

    const BOX2I ViewBBox() const override;

    void TransformShapeWithClearanceToPolygon( SHAPE_POLY_SET& aCornerBuffer, PCB_LAYER_ID aLayer,
                                               int aClearance, int aError, ERROR_LOC aErrorLoc,
                                               bool aIgnoreLineWidth ) const override;

#if defined(DEBUG)
    virtual void Show( int nestLevel, std::ostream& os ) const override { ShowDummy( os ); }
#endif

protected:

    virtual void updateGeometry() = 0;

    virtual void updateText();

    template<typename ShapeType>
    void addShape( const ShapeType& aShape );

    static OPT_VECTOR2I segPolyIntersection( const SHAPE_POLY_SET& aPoly, const SEG& aSeg, bool aStart = true );
    static OPT_VECTOR2I segCircleIntersection( CIRCLE& aCircle, SEG& aSeg, bool aStart = true );
    
    // Value format
    bool              m_overrideTextEnabled;   
    wxString          m_valueString;     
    wxString          m_prefix;          
    wxString          m_suffix;          
    EDA_UNITS         m_units;           
    bool              m_autoUnits;       
    DIM_UNITS_FORMAT  m_unitsFormat;     
    int               m_precision;       
    bool              m_suppressZeroes;  

    // Geometry
    int               m_lineThickness;    
    int               m_arrowLength;      
    int               m_extensionOffset;  
    DIM_TEXT_POSITION m_textPosition;     
    bool              m_keepTextAligned;  

    // Internal
    PCB_TEXT          m_text;             
    int               m_measuredValue;    
    wxPoint           m_start;
    wxPoint           m_end;

    std::vector<std::shared_ptr<SHAPE>> m_shapes;

    static constexpr float s_arrowAngle = 27.5;
};

class ALIGNED_DIMENSION : public DIMENSION_BASE
{
protected:
    // Geometry
    int          m_height;           
    int          m_extensionHeight;  

    wxPoint      m_crossBarStart;    
    wxPoint      m_crossBarEnd;      

public:
    ALIGNED_DIMENSION( BOARD_ITEM* aParent, KICAD_T aType = PCB_DIM_ALIGNED_T );

    // Do not create a copy constructor & operator=.
    // The ones generated by the compiler are adequate.

    ~ALIGNED_DIMENSION() = default;

    static inline bool ClassOf( const EDA_ITEM* aItem )
    {
        return aItem && PCB_DIM_ALIGNED_T == aItem->Type();
    }

    EDA_ITEM* Clone() const override;

    virtual void SwapData( BOARD_ITEM* aImage ) override;

    BITMAPS GetMenuImage() const override;

    const wxPoint& GetCrossbarStart() const { return m_crossBarStart; }

    const wxPoint& GetCrossbarEnd() const { return m_crossBarEnd; }

    void SetHeight( int aHeight ) { m_height = aHeight; }
    int GetHeight() const {  return m_height; }

    void UpdateHeight( const wxPoint& aCrossbarStart, const wxPoint& aCrossbarEnd );

    void SetExtensionHeight( int aHeight ) { m_extensionHeight = aHeight; }
    int GetExtensionHeight() const { return m_extensionHeight; }

    double GetAngle() const
    {
        wxPoint delta( m_end - m_start );

        return atan2( (double)delta.y, (double)delta.x );
    }

    wxString GetClass() const override
    {
        return wxT( "ALIGNED_DIMENSION" );
    }

    void GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList ) override;

protected:

    void updateGeometry() override;

    void updateText() override;
};


class ORTHOGONAL_DIMENSION : public ALIGNED_DIMENSION
{
public:
    enum class DIR
    {
        HORIZONTAL, // Aligned with x-axis
        VERTICAL    // Aligned with y-axis
    };

private:
    // Geometry
    DIR      m_orientation;     

public:
    ORTHOGONAL_DIMENSION( BOARD_ITEM* aParent );

    ~ORTHOGONAL_DIMENSION() = default;

    static inline bool ClassOf( const EDA_ITEM* aItem )
    {
        return aItem && PCB_DIM_ORTHOGONAL_T == aItem->Type();
    }

    EDA_ITEM* Clone() const override;

    void SwapData( BOARD_ITEM* aImage ) override;

    BITMAPS GetMenuImage() const override;

    void SetOrientation( DIR aOrientation ) { m_orientation = aOrientation; }
    DIR GetOrientation() const { return m_orientation; }

    wxString GetClass() const override
    {
        return wxT( "ORTHOGONAL_DIMENSION" );
    }
    void     Rotate( const wxPoint& aRotCentre, double aAngle ) override;

protected:

    void updateGeometry() override;

    void updateText() override;
};


class LEADER : public DIMENSION_BASE
{
    DIM_TEXT_FRAME m_textFrame;

public:
    LEADER( BOARD_ITEM* aParent );

    static inline bool ClassOf( const EDA_ITEM* aItem )
    {
        return aItem && PCB_DIM_LEADER_T == aItem->Type();
    }

    EDA_ITEM* Clone() const override;

    virtual void SwapData( BOARD_ITEM* aImage ) override;

    BITMAPS GetMenuImage() const override;

    wxString GetClass() const override
    {
        return wxT( "LEADER" );
    }

    void SetTextFrame( DIM_TEXT_FRAME aFrame ) { m_textFrame = aFrame; }
    DIM_TEXT_FRAME GetTextFrame() const { return m_textFrame; }

    void GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList ) override;

protected:

    void updateGeometry() override;
};


class CENTER_DIMENSION : public DIMENSION_BASE
{

public:
    CENTER_DIMENSION( BOARD_ITEM* aParent );

    static inline bool ClassOf( const EDA_ITEM* aItem )
    {
        return aItem && PCB_DIM_CENTER_T == aItem->Type();
    }

    EDA_ITEM* Clone() const override;

    virtual void SwapData( BOARD_ITEM* aImage ) override;

    BITMAPS GetMenuImage() const override;

    wxString GetClass() const override
    {
        return wxT( "CENTER_DIMENSION" );
    }

    const EDA_RECT GetBoundingBox() const override;

    const BOX2I ViewBBox() const override;

protected:

    void updateGeometry() override;
};

#endif    // DIMENSION_H