144 lines
4.6 KiB
C++
144 lines
4.6 KiB
C++
/**************************************************************/
|
|
/* Lib component definitions (libentry) definition of fields */
|
|
/**************************************************************/
|
|
|
|
#ifndef CLASS_LIBENTRY_FIELDS_H
|
|
#define CLASS_LIBENTRY_FIELDS_H
|
|
|
|
|
|
#include "classes_body_items.h"
|
|
|
|
|
|
/* Fields , same as component fields.
|
|
* can be defined in libraries (mandatory for ref and value, ca be useful for
|
|
* footprints)
|
|
* 2 Fields are always defined :
|
|
* Prefix (U, IC..) with gives the reference in schematic)
|
|
* Name (74LS00..) used to find the component in libraries, and give the
|
|
* default value in schematic
|
|
*/
|
|
|
|
class LibDrawField : public LIB_DRAW_ITEM,
|
|
public EDA_TextStruct
|
|
{
|
|
public:
|
|
int m_FieldId; /* 0 = REFERENCE
|
|
* 1 = VALUE
|
|
* 3 = FOOTPRINT (default Footprint)
|
|
* 4 = DOCUMENTATION (user doc link)
|
|
* others = free fields
|
|
*/
|
|
wxString m_Name; /* Field Name (not the field text itself, that is
|
|
* .m_Text) */
|
|
|
|
public:
|
|
|
|
LibDrawField* Next() const { return (LibDrawField*) Pnext; }
|
|
LibDrawField* Back() const { return (LibDrawField*) Pback; }
|
|
|
|
|
|
LibDrawField( int idfield = 2 );
|
|
LibDrawField( LIB_COMPONENT * aParent, int idfield = 2 );
|
|
LibDrawField( const LibDrawField& field );
|
|
~LibDrawField();
|
|
virtual wxString GetClass() const
|
|
{
|
|
return wxT( "LibDrawField" );
|
|
}
|
|
|
|
|
|
/** Function GetPenSize virtual pure
|
|
* @return the size of the "pen" that be used to draw or plot this item
|
|
*/
|
|
int GetPenSize( );
|
|
|
|
/**
|
|
* 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.
|
|
*/
|
|
virtual bool Save( FILE* aFile ) const;
|
|
virtual bool Load( char* line, wxString& errorMsg );
|
|
|
|
/** Function Copy
|
|
* copy parameters of this to Target. Pointers are not copied
|
|
* @param aTarget = the LibDrawField to set with "this" values
|
|
*/
|
|
void Copy( LibDrawField* aTarget ) const;
|
|
|
|
void SetFields( const std::vector <LibDrawField> aFields );
|
|
|
|
void Draw( WinEDA_DrawPanel * aPanel, wxDC * aDC, const wxPoint &aOffset,
|
|
int aColor, int aDrawMode, void* aData,
|
|
const int aTransformMatrix[2][2] );
|
|
|
|
/**
|
|
* Return the bounding rectangle of the field text.
|
|
*
|
|
* @return EDA_Rect - Bounding rectangle.
|
|
*/
|
|
virtual EDA_Rect GetBoundingBox();
|
|
|
|
/**
|
|
* Function HitTest
|
|
* tests if the given wxPoint is within the bounds of this object.
|
|
* @param refPos A wxPoint to test, in Field coordinate system
|
|
* @return bool - true if a hit, else false
|
|
*/
|
|
bool HitTest( const wxPoint& refPos );
|
|
|
|
/**
|
|
* Function HitTest
|
|
* @return true if the point aPosRef is near this object
|
|
* @param aPosRef = a wxPoint to test
|
|
* @param aThreshold = max distance to this object (usually the half
|
|
* thickness of a line)
|
|
* @param aTransMat = the transform matrix
|
|
*/
|
|
virtual bool HitTest( wxPoint aPosRef, int aThreshold,
|
|
const int aTransMat[2][2] );
|
|
|
|
void operator=( const LibDrawField& field )
|
|
{
|
|
m_FieldId = field.m_FieldId;
|
|
m_Text = field.m_Text;
|
|
m_Pos = field.m_Pos;
|
|
m_Size = field.m_Size;
|
|
m_Width = field.m_Width;
|
|
m_Orient = field.m_Orient;
|
|
m_Mirror = field.m_Mirror;
|
|
m_Attributs = field.m_Attributs;
|
|
m_Italic = field.m_Italic;
|
|
m_Bold = field.m_Bold;
|
|
m_HJustify = field.m_HJustify;
|
|
m_VJustify = field.m_VJustify;
|
|
m_Parent = field.m_Parent;
|
|
}
|
|
|
|
/**
|
|
* Return the text of a field.
|
|
*
|
|
* If the field is the reference field, the unit number is used to
|
|
* create a pseudo reference text. If the base reference field is U,
|
|
* the string U?A will be returned for unit = 1.
|
|
*
|
|
* @param unit - The package unit number. Only effects reference field.
|
|
*
|
|
* @return wxString - Field text.
|
|
*/
|
|
wxString GetFullText( int unit = 1 );
|
|
|
|
protected:
|
|
virtual LIB_DRAW_ITEM* DoGenCopy();
|
|
virtual int DoCompare( const LIB_DRAW_ITEM& other ) const;
|
|
virtual void DoOffset( const wxPoint& offset );
|
|
virtual bool DoTestInside( EDA_Rect& rect );
|
|
virtual void DoMove( const wxPoint& newPosition );
|
|
virtual wxPoint DoGetPosition( void ) { return m_Pos; }
|
|
virtual void DoMirrorHorizontal( const wxPoint& center );
|
|
};
|
|
|
|
#endif // CLASS_LIBENTRY_FIELDS_H
|