225 lines
6.8 KiB
C++
225 lines
6.8 KiB
C++
/*
|
|
* 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-2011 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 <class_board_item.h>
|
|
|
|
|
|
class LINE_READER;
|
|
class EDA_RECT;
|
|
class EDA_DRAW_PANEL;
|
|
class EDA_DRAW_FRAME;
|
|
class MODULE;
|
|
|
|
|
|
#define TEXT_is_REFERENCE 0
|
|
#define TEXT_is_VALUE 1
|
|
#define TEXT_is_DIVERS 2
|
|
|
|
#define UMBILICAL_COLOR LIGHTBLUE
|
|
|
|
|
|
class TEXTE_MODULE : public BOARD_ITEM, public EDA_TEXT
|
|
{
|
|
// @todo eliminate these friends, make them use accessors
|
|
friend class MODULE;
|
|
friend class FOOTPRINT_EDIT_FRAME;
|
|
|
|
/* Note: orientation in 1/10 deg relative to the footprint
|
|
* Physical orient is m_Orient + m_Parent->m_Orient
|
|
*/
|
|
|
|
int m_Type; ///< 0=ref, 1=val, etc.
|
|
bool m_NoShow; ///< true = invisible
|
|
|
|
wxPoint m_Pos0; ///< text coordinates relatives to the footprint anchor, orient 0.
|
|
///< text coordinate ref point is the text centre
|
|
|
|
public:
|
|
TEXTE_MODULE( MODULE* parent, int text_type = TEXT_is_DIVERS );
|
|
|
|
// Do not create a copy constructor. The one generated by the compiler is adequate.
|
|
|
|
~TEXTE_MODULE();
|
|
|
|
TEXTE_MODULE* Next() const { return (TEXTE_MODULE*) Pnext; }
|
|
|
|
TEXTE_MODULE* Back() const { return (TEXTE_MODULE*) Pback; }
|
|
|
|
void SetPosition( const wxPoint& aPos ) // was overload
|
|
{
|
|
m_Pos = aPos; // in EDA_TEXT
|
|
}
|
|
|
|
const wxPoint& GetPosition() const // was overload
|
|
{
|
|
return m_Pos; // from EDA_TEXT
|
|
}
|
|
|
|
/// @deprecated it seems
|
|
void SetType( int aType ) { m_Type = aType; }
|
|
int GetType() const { return m_Type; }
|
|
|
|
void SetVisible( bool isVisible ) { m_NoShow = !isVisible; }
|
|
bool IsVisible() const { return !m_NoShow; }
|
|
|
|
void SetPos0( const wxPoint& aPos ) { m_Pos0 = aPos; }
|
|
const wxPoint& GetPos0() const { return m_Pos0; }
|
|
|
|
void Copy( TEXTE_MODULE* source ); // copy structure
|
|
|
|
int GetLength() const; /* text length */
|
|
|
|
int GetDrawRotation() const; // Return text rotation for drawings and plotting
|
|
|
|
/**
|
|
* Function GetTextRect
|
|
* @return an EDA_RECT which gives the position and size of the text area
|
|
* (for the 0 orient text and footprint)
|
|
*/
|
|
EDA_RECT GetTextRect( void ) const;
|
|
|
|
/**
|
|
* Function GetBoundingBox
|
|
* returns the bounding box of this Text (according to text and footprint
|
|
* orientation)
|
|
*/
|
|
EDA_RECT GetBoundingBox() const;
|
|
|
|
void SetDrawCoord(); // Set absolute coordinates.
|
|
|
|
void SetLocalCoord(); // Set relative coordinates.
|
|
|
|
/**
|
|
* Function Save
|
|
* writes the data structures for this object out to a FILE in "*.brd"
|
|
* format.
|
|
* @param aFile The FILE to write to.
|
|
* @return bool - true if success writing else false.
|
|
*/
|
|
bool Save( FILE* aFile ) const;
|
|
|
|
/**
|
|
* Function ReadDescr
|
|
* Read description from a given line in "*.brd" format.
|
|
* @param aReader is a pointer to a LINE_READER to read from.
|
|
* @return int - > 0 if success reading else 0.
|
|
*/
|
|
int ReadDescr( LINE_READER* aReader );
|
|
|
|
/* drawing functions */
|
|
void Draw( EDA_DRAW_PANEL* panel,
|
|
wxDC* DC,
|
|
int aDrawMode,
|
|
const wxPoint& offset = ZeroOffset );
|
|
|
|
/**
|
|
* 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,
|
|
int aDrawMode,
|
|
const wxPoint& aOffset = ZeroOffset );
|
|
|
|
/**
|
|
* Function DisplayInfo
|
|
* has knowledge about the frame and how and where to put status
|
|
* information about this object into the frame's message panel.
|
|
* Is virtual from EDA_ITEM.
|
|
* @param frame A EDA_DRAW_FRAME in which to print status information.
|
|
*/
|
|
void DisplayInfo( EDA_DRAW_FRAME* frame );
|
|
|
|
|
|
/**
|
|
* Function HitTest
|
|
* tests if the given wxPoint is within the bounds of this object.
|
|
* @param aRefPos A wxPoint to test
|
|
* @return bool - true if a hit, else false
|
|
*/
|
|
bool HitTest( const wxPoint& aRefPos );
|
|
|
|
/**
|
|
* Function IsOnLayer
|
|
* tests to see if this object is on the given layer. Is virtual so
|
|
* objects like D_PAD, which reside on multiple layers can do their own
|
|
* form of testing.
|
|
* virtual inheritance from BOARD_ITEM.
|
|
* @param aLayer The layer to test for.
|
|
* @return bool - true if on given layer, else false.
|
|
*/
|
|
bool IsOnLayer( int aLayer ) const;
|
|
|
|
/*
|
|
* Function IsOnOneOfTheseLayers
|
|
* returns true if this object is on one of the given layers. Is virtual
|
|
* so objects like D_PAD, which reside on multiple layers, can do their own
|
|
* form of testing.
|
|
* virtual inheritance from BOARD_ITEM. (not yet written)
|
|
* @param aLayerMask The bit-mapped set of layers to test for.
|
|
* @return bool - true if on one of the given layers, else false.
|
|
* bool IsOnOneOfTheseLayers( int aLayerMask ) const;
|
|
*/
|
|
|
|
|
|
/**
|
|
* Function GetClass
|
|
* returns the class name.
|
|
* @return wxString = "MTEXT"
|
|
*/
|
|
virtual wxString GetClass() const
|
|
{
|
|
return wxT( "MTEXT" );
|
|
}
|
|
|
|
|
|
virtual wxString GetSelectMenuText() const;
|
|
|
|
virtual BITMAP_DEF GetMenuImage() const { return footprint_text_xpm; }
|
|
|
|
#if defined(DEBUG)
|
|
void Show( int nestLevel, std::ostream& os ) const; // overload
|
|
#endif
|
|
|
|
private:
|
|
virtual EDA_ITEM* doClone() const;
|
|
};
|
|
|
|
#endif // TEXT_MODULE_H_
|