kicad/pcbnew/class_text_mod.h

236 lines
7.3 KiB
C
Raw Normal View History

/*
* 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-2017 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
*/
/**
* @file class_text_mod.h
* @brief Footprint text class description.
*/
#ifndef TEXT_MODULE_H_
#define TEXT_MODULE_H_
#include <eda_text.h>
#include <class_board_item.h>
class LINE_READER;
class EDA_RECT;
class EDA_DRAW_PANEL;
class MODULE;
class MSG_PANEL_ITEM;
#define UMBILICAL_COLOR LIGHTBLUE
class TEXTE_MODULE : public BOARD_ITEM, public EDA_TEXT
{
public:
/** Text module type: there must be only one (and only one) for each
* of the reference and value texts in one module; others could be
* added for the user (DIVERS is French for 'others'). Reference and
* value always live on silkscreen (on the module side); other texts
* are planned to go on whatever layer the user wants (except
* copper, probably) */
enum TEXT_TYPE
{
TEXT_is_REFERENCE = 0,
TEXT_is_VALUE = 1,
TEXT_is_DIVERS = 2
};
TEXTE_MODULE( MODULE* parent, TEXT_TYPE text_type = TEXT_is_DIVERS );
// Do not create a copy constructor & operator=.
// The ones generated by the compiler are adequate.
2007-09-01 12:00:30 +00:00
~TEXTE_MODULE();
static inline bool ClassOf( const EDA_ITEM* aItem )
{
return aItem && PCB_MODULE_TEXT_T == aItem->Type();
}
2016-09-24 18:53:15 +00:00
virtual const wxPoint& GetPosition() const override
{
return EDA_TEXT::GetTextPos();
}
2016-09-24 18:53:15 +00:00
virtual void SetPosition( const wxPoint& aPos ) override
{
EDA_TEXT::SetTextPos( aPos );
SetLocalCoord();
}
void SetTextAngle( double aAngle );
/// Rotate text, in footprint editor
/// (for instance in footprint rotation transform)
2016-09-24 18:53:15 +00:00
void Rotate( const wxPoint& aOffset, double aAngle ) override;
/// Flip entity during module flip
2016-09-24 18:53:15 +00:00
void Flip( const wxPoint& aCentre ) override;
/// Mirror text position in footprint edition
/// the text itself is not mirrored, and the layer not modified,
/// only position is mirrored.
/// (use Flip to change layer to its paired and mirror the text in fp editor).
void Mirror( const wxPoint& aCentre, bool aMirrorAroundXAxis );
/// move text in move transform, in footprint editor
2016-09-24 18:53:15 +00:00
void Move( const wxPoint& aMoveVector ) override;
/// @deprecated it seems (but the type is used to 'protect'
// reference and value from deletion, and for identification)
void SetType( TEXT_TYPE aType ) { m_Type = aType; }
TEXT_TYPE GetType() const { return m_Type; }
/**
* Function SetEffects
* sets the text effects from another instance.
*/
void SetEffects( const TEXTE_MODULE& aSrc )
{
EDA_TEXT::SetEffects( aSrc );
SetLocalCoord();
// SetType( aSrc.GetType() );
}
/**
* Function SwapEffects
* swaps the text effects of the two involved instances.
*/
void SwapEffects( TEXTE_MODULE& aTradingPartner )
{
EDA_TEXT::SwapEffects( aTradingPartner );
SetLocalCoord();
aTradingPartner.SetLocalCoord();
// std::swap( m_Type, aTradingPartner.m_Type );
}
// The Pos0 accessors are for module-relative coordinates
void SetPos0( const wxPoint& aPos ) { m_Pos0 = aPos; SetDrawCoord(); }
2012-05-22 17:51:18 +00:00
const wxPoint& GetPos0() const { return m_Pos0; }
int GetLength() const; // text length
2010-11-12 15:17:10 +00:00
/**
* @return the text rotation for drawings and plotting
* the footprint rotation is taken in account
2008-04-01 05:21:50 +00:00
*/
double GetDrawRotation() const;
double GetDrawRotationRadians() const { return GetDrawRotation() * M_PI/1800; }
// Virtual function
2016-09-24 18:53:15 +00:00
const EDA_RECT GetBoundingBox() const override;
///> Set absolute coordinates.
void SetDrawCoord();
///> Set relative coordinates.
void SetLocalCoord();
/* drawing functions */
/**
* Function Draw
* Draw the text according to the footprint pos and orient
* @param aPanel = draw panel, Used to know the clip box
* @param aDC = Current Device Context
* @param aOffset = draw offset (usually wxPoint(0,0)
* @param aDrawMode = GR_OR, GR_XOR..
*/
void Draw( EDA_DRAW_PANEL* aPanel,
wxDC* aDC,
GR_DRAWMODE aDrawMode,
2016-09-24 18:53:15 +00:00
const wxPoint& aOffset = ZeroOffset ) override;
2008-04-01 05:21:50 +00:00
/**
* Function DrawUmbilical
* draws a line from the TEXTE_MODULE origin
* to parent MODULE origin.
* @param aPanel = the current DrawPanel
* @param aDC = the current device context
* @param aDrawMode = drawing mode, typically GR_XOR
* @param aOffset = offset for TEXTE_MODULE
*/
void DrawUmbilical( EDA_DRAW_PANEL* aPanel,
wxDC* aDC,
GR_DRAWMODE aDrawMode,
const wxPoint& aOffset = ZeroOffset );
2016-09-24 18:53:15 +00:00
void GetMsgPanelInfo( std::vector< MSG_PANEL_ITEM >& aList ) override;
2017-05-02 06:44:41 +00:00
virtual bool TextHitTest( const wxPoint& aPoint, int aAccuracy = 0 ) const override;
virtual bool TextHitTest( const EDA_RECT& aRect, bool aContains = false, int aAccuracy = 0 ) const override;
virtual bool HitTest( const wxPoint& aPosition ) const override
{
return TextHitTest( aPosition );
}
virtual bool HitTest( const EDA_RECT& aRect, bool aContained = false, int aAccuracy = 0 ) const override
{
return TextHitTest( aRect, aContained, aAccuracy );
}
2008-04-01 05:21:50 +00:00
2016-09-24 18:53:15 +00:00
wxString GetClass() const override
{
return wxT( "MTEXT" );
}
2016-09-24 18:53:15 +00:00
wxString GetSelectMenuText() const override;
BITMAP_DEF GetMenuImage() const override;
2016-09-24 18:53:15 +00:00
EDA_ITEM* Clone() const override;
2016-09-24 18:53:15 +00:00
virtual wxString GetShownText() const override;
2016-09-24 18:53:15 +00:00
virtual const BOX2I ViewBBox() const override;
2014-01-07 13:09:27 +00:00
2016-09-24 18:53:15 +00:00
virtual void ViewGetLayers( int aLayers[], int& aCount ) const override;
Introduction of Graphics Abstraction Layer based rendering for pcbnew. New classes: - VIEW - represents view that is seen by user, takes care of layer ordering & visibility and how it is displayed (which location, how much zoomed, etc.) - VIEW_ITEM - Base class for every item that can be displayed on VIEW (the biggest change is that now it may be necessary to override ViewBBox & ViewGetLayers method for derived classes). - EDA_DRAW_PANEL_GAL - Inherits after EDA_DRAW_PANEL, displays VIEW output, right now it is not editable (in opposite to usual EDA_DRAW_PANEL). - GAL/OPENGL_GAL/CAIRO_GAL - Base Graphics Abstraction Layer class + two different flavours (Cairo is not fully supported yet), that offers methods to draw primitives using different libraries. - WX_VIEW_CONTROLS - Controller for VIEW, handles user events, allows zooming, panning, etc. - PAINTER/PCB_PAINTER - Classes that uses GAL interface to draw items (as you may have already guessed - PCB_PAINTER is a class for drawing PCB specific object, PAINTER is an abstract class). Its methods are invoked by VIEW, when an item has to be drawn. To display a new type of item - you need to implement draw(ITEM_TYPE*) method that draws it using GAL methods. - STROKE_FONT - Implements stroke font drawing using GAL methods. Most important changes to Kicad original code: * EDA_ITEM now inherits from VIEW_ITEM, which is a base class for all drawable objects. * EDA_DRAW_FRAME contains both usual EDA_DRAW_PANEL and new EDA_DRAW_PANEL_GAL, that can be switched anytime. * There are some new layers for displaying multilayer pads, vias & pads holes (these are not shown yet on the right sidebar in pcbnew) * Display order of layers is different than in previous versions (if you are curious - you may check m_galLayerOrder@pcbnew/basepcbframe.cpp). Preserving usual order would result in not very natural display, such as showing silkscreen texts on the bottom. * Introduced new hotkey (Alt+F12) and new menu option (View->Switch canvas) for switching canvas during runtime. * Some of classes (mostly derived from BOARD_ITEM) now includes ViewBBox & ViewGetLayers methods. * Removed tools/class_painter.h, as now it is extended and included in source code. Build changes: * GAL-based rendering option is turned on by a new compilation CMake option KICAD_GAL. * When compiling with CMake option KICAD_GAL=ON, GLEW and Cairo libraries are required. * GAL-related code is compiled into a static library (common/libgal). * Build with KICAD_GAL=OFF should not need any new libraries and should come out as a standard version of Kicad Currently most of items in pcbnew can be displayed using OpenGL (to be done are DIMENSIONS and MARKERS). More details about GAL can be found in: http://www.ohwr.org/attachments/1884/view-spec.pdf
2013-04-02 06:54:03 +00:00
virtual unsigned int ViewGetLOD( int aLayer, KIGFX::VIEW* aView ) const override;
#if defined(DEBUG)
2016-09-24 18:53:15 +00:00
virtual void Show( int nestLevel, std::ostream& os ) const override { ShowDummy( os ); }
#endif
private:
/* Note: orientation in 1/10 deg relative to the footprint
* Physical orient is m_Orient + m_Parent->m_Orient
*/
TEXT_TYPE m_Type; ///< 0=ref, 1=val, etc.
wxPoint m_Pos0; ///< text coordinates relative to the footprint anchor, orient 0.
///< text coordinate ref point is the text center
};
#endif // TEXT_MODULE_H_