ds_data_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) 2013-2019 Jean-Pierre Charras, jp.charras at wanadoo.fr
 * Copyright (C) 1992-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 DS_DATA_ITEM_H
#define DS_DATA_ITEM_H

#include <math/vector2d.h>
#include <eda_text.h>
#include <bitmap_base.h>
#include "drawing_sheet/ds_draw_item.h"

class DS_DRAW_ITEM_TEXT; // Forward declaration

#define TB_DEFAULT_TEXTSIZE 1.5 // default drawing sheet text size in mm

namespace KIGFX
{
class VIEW;
}

enum CORNER_ANCHOR
{
 RB_CORNER, // right bottom corner
 RT_CORNER, // right top corner
 LB_CORNER, // left bottom corner
 LT_CORNER, // left top corner
};

enum PAGE_OPTION
{
 ALL_PAGES,
 FIRST_PAGE_ONLY,
 SUBSEQUENT_PAGES
};

class POINT_COORD
{
public:
 POINT_COORD() { m_Anchor = RB_CORNER; }

 POINT_COORD( const DPOINT& aPos, enum CORNER_ANCHOR aAnchor = RB_CORNER )
 {
 m_Pos = aPos;
 m_Anchor = aAnchor;
 }

 DPOINT m_Pos;
 int m_Anchor;
};


class DS_DATA_ITEM
{
public:
 enum DS_ITEM_TYPE {
 DS_TEXT,
 DS_SEGMENT,
 DS_RECT,
 DS_POLYPOLYGON,
 DS_BITMAP
 };

 DS_DATA_ITEM( DS_ITEM_TYPE aType );

 virtual ~DS_DATA_ITEM();

 const std::vector<DS_DRAW_ITEM_BASE*>& GetDrawItems() const { return m_drawItems; }

 virtual void SyncDrawItems( DS_DRAW_ITEM_LIST* aCollector, KIGFX::VIEW* aView );

 void SetStart( double aPosx, double aPosy, enum CORNER_ANCHOR aAnchor = RB_CORNER )
 {
 m_Pos.m_Pos.x = aPosx;
 m_Pos.m_Pos.y = aPosy;
 m_Pos.m_Anchor = aAnchor;
 }

 void SetEnd( double aPosx, double aPosy, enum CORNER_ANCHOR aAnchor = RB_CORNER )
 {
 m_End.m_Pos.x = aPosx;
 m_End.m_Pos.y = aPosy;
 m_End.m_Anchor = aAnchor;
 }

 DS_ITEM_TYPE GetType() const { return m_type; }

 PAGE_OPTION GetPage1Option() const { return m_pageOption; }
 void SetPage1Option( PAGE_OPTION aChoice ) { m_pageOption = aChoice; }

 // Coordinate handling
 const wxPoint GetStartPosUi( int ii = 0 ) const;
 const wxPoint GetEndPosUi( int ii = 0 ) const;
 const DPOINT GetStartPos( int ii = 0 ) const;
 const DPOINT GetEndPos( int ii = 0 ) const;

 virtual int GetPenSizeUi();

 void MoveTo( const DPOINT& aPosition );

 void MoveToUi( const wxPoint& aPosition );

 void MoveStartPointTo( const DPOINT& aPosition );

 void MoveStartPointToUi( const wxPoint& aPosition );


 void MoveEndPointTo( const DPOINT& aPosition );

 void MoveEndPointToUi( const wxPoint& aPosition );

 virtual bool IsInsidePage( int ii ) const;

 const wxString GetClassName() const;

 wxString m_Name; // a name used in drawing sheet editor to identify items
 wxString m_Info; // a comment, only useful in drawing sheet editor
 POINT_COORD m_Pos;
 POINT_COORD m_End;
 double m_LineWidth;
 int m_RepeatCount; // repeat count for duplicate items
 DPOINT m_IncrementVector; // for duplicate items: move vector for position increment
 int m_IncrementLabel;

protected:
 DS_ITEM_TYPE m_type;
 PAGE_OPTION m_pageOption;

 std::vector<DS_DRAW_ITEM_BASE*> m_drawItems;
};


class DS_DATA_ITEM_POLYGONS : public DS_DATA_ITEM
{
public:
 DS_DATA_ITEM_POLYGONS( );

 void SyncDrawItems( DS_DRAW_ITEM_LIST* aCollector, KIGFX::VIEW* aView ) override;

 virtual int GetPenSizeUi() override;

 void AppendCorner( const DPOINT& aCorner )
 {
 m_Corners.push_back( aCorner );
 }

 void CloseContour()
 {
 m_polyIndexEnd.push_back( m_Corners.size() -1 );
 }

 int GetPolyCount() const { return (int) m_polyIndexEnd.size(); }

 unsigned GetPolyIndexStart( unsigned aContour ) const
 {
 if( aContour == 0 )
 return 0;
 else
 return m_polyIndexEnd[aContour-1] + 1;
 }

 unsigned GetPolyIndexEnd( unsigned aContour ) const
 {
 return m_polyIndexEnd[aContour];
 }

 const DPOINT GetCornerPosition( unsigned aIdx, int aRepeat = 0 ) const;

 const wxPoint GetCornerPositionUi( unsigned aIdx, int aRepeat = 0 ) const;

 void SetBoundingBox();

 bool IsInsidePage( int ii ) const override;

 double m_Orient; // Orientation in degrees
 std::vector<DPOINT> m_Corners; // corner list

private:
 std::vector<unsigned> m_polyIndexEnd; // index of the last point of each polygon
 DPOINT m_minCoord; // min coord of corners, relative to m_Pos
 DPOINT m_maxCoord; // max coord of corners, relative to m_Pos
};


class DS_DATA_ITEM_TEXT : public DS_DATA_ITEM
{
public:
 DS_DATA_ITEM_TEXT( const wxString& aTextBase );

 void SyncDrawItems( DS_DRAW_ITEM_LIST* aCollector, KIGFX::VIEW* aView ) override;

 virtual int GetPenSizeUi() override;

 void IncrementLabel( int aIncr );

 void SetConstrainedTextSize();

 bool ReplaceAntiSlashSequence();

public:
 wxString m_TextBase; // The basic text, with format symbols
 wxString m_FullText; // The expanded text, shown on screen
 double m_Orient; // Orientation in degrees
 EDA_TEXT_HJUSTIFY_T m_Hjustify;
 EDA_TEXT_VJUSTIFY_T m_Vjustify;
 bool m_Italic;
 bool m_Bold;
 DSIZE  m_TextSize;
 DSIZE m_BoundingBoxSize; // When not null, this is the max size of the
 // full text. The text size will be modified
 // to keep the full text inside this bound.
 DSIZE m_ConstrainedTextSize; // Actual text size, if constrained by
 // the m_BoundingBoxSize constraint
};


class BITMAP_BASE;

class DS_DATA_ITEM_BITMAP : public DS_DATA_ITEM
{
public:
 DS_DATA_ITEM_BITMAP( BITMAP_BASE* aImage ) :
 DS_DATA_ITEM( DS_BITMAP )
 {
 m_ImageBitmap = aImage;
 }

 void SyncDrawItems( DS_DRAW_ITEM_LIST* aCollector, KIGFX::VIEW* aView ) override;

 int GetPPI() const;
 void SetPPI( int aBitmapPPI );

public:
 BITMAP_BASE* m_ImageBitmap;
};


#endif // DS_DATA_ITEM_H