kicad/pcbnew/class_marker_pcb.h

128 lines
3.4 KiB
C
Raw Normal View History

/**
* @file class_marker_pcb.h
* @brief Markers used to show a drc problem on boards.
*/
2009-08-01 19:26:05 +00:00
#ifndef CLASS_MARKER_PCB_H
#define CLASS_MARKER_PCB_H
#include "class_board_item.h"
#include "class_marker_base.h"
2009-08-01 19:26:05 +00:00
class MARKER_PCB : public BOARD_ITEM, public MARKER_BASE
{
2008-04-01 05:21:50 +00:00
public:
2007-12-01 03:42:52 +00:00
2009-08-01 19:26:05 +00:00
MARKER_PCB( BOARD_ITEM* aParent );
2007-12-01 03:42:52 +00:00
/**
* Constructor
* @param aErrorCode The categorizing identifier for an error
2009-08-01 19:26:05 +00:00
* @param aMarkerPos The position of the MARKER_PCB on the BOARD
2007-12-01 03:42:52 +00:00
* @param aText Text describing the first of two objects
* @param aPos The position of the first of two objects
* @param bText Text describing the second of the two conflicting objects
* @param bPos The position of the second of two objects
*/
2009-08-01 19:26:05 +00:00
MARKER_PCB( int aErrorCode, const wxPoint& aMarkerPos,
const wxString& aText, const wxPoint& aPos,
const wxString& bText, const wxPoint& bPos );
2009-09-10 15:22:26 +00:00
/**
* Constructor
* @param aErrorCode The categorizing identifier for an error
2009-08-01 19:26:05 +00:00
* @param aMarkerPos The position of the MARKER_PCB on the BOARD
* @param aText Text describing the object
* @param aPos The position of the object
*/
2009-08-01 19:26:05 +00:00
MARKER_PCB( int aErrorCode, const wxPoint& aMarkerPos,
const wxString& aText, const wxPoint& aPos );
2009-08-01 19:26:05 +00:00
~MARKER_PCB();
2008-04-01 05:21:50 +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)
{
m_Pos += aMoveVector;
}
2007-11-27 22:49:35 +00:00
2009-08-01 19:26:05 +00:00
/**
* 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 );
2007-12-01 03:42:52 +00:00
2010-11-12 15:17:10 +00:00
/**
* Function Draw
2007-12-01 03:42:52 +00:00
*/
void Draw( EDA_DRAW_PANEL* aPanel, wxDC* aDC, int aDrawMode,
const wxPoint& aOffset = ZeroOffset )
2007-12-01 03:42:52 +00:00
{
DrawMarker( aPanel, aDC, aDrawMode, aOffset );
2007-12-01 03:42:52 +00:00
}
/**
* Function GetPosition
2009-08-01 19:26:05 +00:00
* returns the position of this MARKER_PCB.
2007-12-01 03:42:52 +00:00
*/
wxPoint& GetPosition()
2007-12-01 03:42:52 +00:00
{
return (wxPoint&) m_Pos;
2007-12-01 03:42:52 +00:00
}
2008-04-01 05:21:50 +00:00
2010-11-12 15:17:10 +00:00
/**
* Function HitTest
* @return true if the point aPosRef is within item area
* @param aPosRef = a wxPoint to test
2007-12-01 03:42:52 +00:00
*/
bool HitTest( const wxPoint& aPosRef )
2007-12-01 03:42:52 +00:00
{
return HitTestMarker( aPosRef );
2007-12-01 03:42:52 +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.
* @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-10-30 21:30:58 +00:00
/**
* Function Save
2007-10-31 14:14:21 +00:00
* 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
{
// not implemented, this is here to satisfy BOARD_ITEM::Save()
// "pure" virtual-ness
return true;
}
virtual wxString GetSelectMenuText() const;
virtual BITMAP_DEF GetMenuImage() const { return drc_xpm; }
};
2009-08-01 19:26:05 +00:00
#endif // CLASS_MARKER_PCB_H