kicad/pcbnew/class_pcb_text.h

156 lines
4.4 KiB
C
Raw Normal View History

/**
* @file class_pcb_text.h
* @brief TEXTE_PCB class definition.
*/
#ifndef CLASS_PCB_TEXT_H
#define CLASS_PCB_TEXT_H
#include "class_board_item.h"
#include "PolyLine.h"
class LINE_READER;
class EDA_DRAW_PANEL;
class TEXTE_PCB : public BOARD_ITEM, public EDA_TEXT
{
public:
2008-04-01 05:21:50 +00:00
TEXTE_PCB( BOARD_ITEM* parent );
TEXTE_PCB( TEXTE_PCB* textepcb );
~TEXTE_PCB();
2007-12-01 03:42:52 +00:00
/**
* Function GetPosition
* returns the position of this object.
* @return wxPoint& - The position of this object, non-const so it can be changed
2007-12-01 03:42:52 +00:00
*/
wxPoint& GetPosition()
{
return m_Pos; // within EDA_TEXT
2007-12-01 03:42:52 +00:00
}
2009-08-01 19:26:05 +00:00
/**
* Function Move
* move this object.
2010-12-29 17:47:32 +00:00
* @param aMoveVector - the move vector for this object.
2009-08-01 19:26:05 +00:00
*/
virtual void Move( const wxPoint& aMoveVector )
2009-08-01 19:26:05 +00:00
{
m_Pos += aMoveVector;
}
/**
* Function Rotate
* Rotate this object.
2010-12-29 17:47:32 +00:00
* @param aRotCentre - the rotation point.
2009-08-01 19:26:05 +00:00
* @param aAngle - the rotation angle in 0.1 degree.
*/
virtual void Rotate( const wxPoint& aRotCentre, int aAngle );
2009-08-01 19:26:05 +00:00
/**
* Function Flip
* Flip this object, i.e. change the board side for this object
2010-12-29 17:47:32 +00:00
* @param aCentre - the rotation point.
2009-08-01 19:26:05 +00:00
*/
virtual void Flip( const wxPoint& aCentre );
2009-08-01 19:26:05 +00:00
2008-04-01 05:21:50 +00:00
/* duplicate structure */
void Copy( TEXTE_PCB* source );
void Draw( EDA_DRAW_PANEL* panel, wxDC* DC, int aDrawMode,
const wxPoint& offset = ZeroOffset );
2008-04-01 05:21:50 +00:00
// File Operations:
int ReadTextePcbDescr( LINE_READER* aReader );
2007-10-30 21:30:58 +00:00
/**
* Function Save
* writes the data structures for this object out to a FILE in "*.brd" format.
2007-10-30 21:30:58 +00:00
* @param aFile The FILE to write to.
* @return bool - true if success writing else false.
2008-04-01 05:21:50 +00:00
*/
2007-10-30 21:30:58 +00:00
bool Save( FILE* aFile ) const;
2008-04-01 05:21:50 +00:00
/**
* 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.
2008-04-01 05:21:50 +00:00
*/
void DisplayInfo( EDA_DRAW_FRAME* frame );
2007-08-22 05:11:01 +00:00
/**
* Function HitTest
* tests if the given wxPoint is within the bounds of this object.
* @param refPos A wxPoint to test
* @return bool - true if a hit, else false
*/
bool HitTest( const wxPoint& refPos )
2007-08-22 05:11:01 +00:00
{
return TextHitTest( refPos );
2007-08-22 05:11:01 +00:00
}
2008-04-01 05:21:50 +00:00
/**
* Function HitTest (overloaded)
* tests if the given EDA_RECT intersect this object.
* @param refArea the given EDA_RECT to test
2008-04-01 05:21:50 +00:00
* @return bool - true if a hit, else false
*/
bool HitTest( EDA_RECT& refArea )
2008-01-06 12:43:57 +00:00
{
return TextHitTest( refArea );
2008-01-06 12:43:57 +00:00
}
2008-04-01 05:21:50 +00:00
/**
* Function GetClass
* returns the class name.
* @return wxString
*/
virtual wxString GetClass() const
{
return wxT("PTEXT");
}
2010-11-12 15:17:10 +00:00
/**
* Function TransformShapeWithClearanceToPolygon
* Convert the track shape to a closed polygon
* Used in filling zones calculations
* Circles and arcs are approximated by segments
* @param aCornerBuffer = a buffer to store the polygon
* @param aClearanceValue = the clearance around the pad
* @param aCircleToSegmentsCount = the number of segments to approximate a circle
* @param aCorrectionFactor = the correction to apply to circles radius to keep
* clearance when the circle is approximated by segment bigger or equal
* to the real clearance value (usually near from 1.0)
*/
void TransformShapeWithClearanceToPolygon( std::vector <CPolyPt>& aCornerBuffer,
int aClearanceValue,
int aCircleToSegmentsCount,
double aCorrectionFactor );
virtual wxString GetSelectMenuText() const;
virtual BITMAP_DEF GetMenuImage() const { return add_text_xpm; }
virtual EDA_RECT GetBoundingBox() const { return GetTextBox(); };
#if defined(DEBUG)
/**
* Function Show
* is used to output the object tree, currently for debugging only.
2008-04-01 05:21:50 +00:00
* @param nestLevel An aid to prettier tree indenting, and is the level
* of nesting of this object within the overall tree.
* @param os The ostream& to output to.
*/
virtual void Show( int nestLevel, std::ostream& os );
#endif
2008-04-01 05:21:50 +00:00
};
#endif // #define CLASS_PCB_TEXT_H