696 lines
23 KiB
C++
696 lines
23 KiB
C++
/*********************************************************************/
|
|
/* base_struct.h : Basic classes for most kicad item descriptions */
|
|
/*********************************************************************/
|
|
|
|
#ifndef BASE_STRUCT_H
|
|
#define BASE_STRUCT_H
|
|
|
|
#include "colors.h"
|
|
|
|
#if defined(DEBUG)
|
|
#include <iostream> // needed for Show()
|
|
extern std::ostream& operator <<( std::ostream& out, const wxSize& size );
|
|
|
|
extern std::ostream& operator <<( std::ostream& out, const wxPoint& pt );
|
|
|
|
#endif
|
|
|
|
/* Id for class identification, at run time */
|
|
enum KICAD_T {
|
|
NOT_USED = -1, // the 3d code uses this value
|
|
|
|
EOT = 0, // search types array terminator (End Of Types)
|
|
|
|
TYPE_NOT_INIT = 0,
|
|
TYPE_PCB,
|
|
TYPE_SCREEN, // not really an item, used to identify a screen
|
|
|
|
// Items in pcb
|
|
TYPE_MODULE, // a footprint
|
|
TYPE_PAD, // a pad in a footprint
|
|
TYPE_DRAWSEGMENT, // a segment not on copper layers
|
|
TYPE_TEXTE, // a text on a layer
|
|
TYPE_TEXTE_MODULE, // a text in a footprint
|
|
TYPE_EDGE_MODULE, // a footprint edge
|
|
TYPE_TRACK, // a track segment (segment on a copper layer)
|
|
TYPE_VIA, // a via (like atrack segment on a copper layer)
|
|
TYPE_ZONE, // a segment used to fill a zone area (segment on a
|
|
// copper layer)
|
|
TYPE_MARKER_PCB, // a marker used to show something
|
|
TYPE_DIMENSION, // a dimension (graphic item)
|
|
TYPE_MIRE, // a target (graphic item)
|
|
TYPE_ZONE_EDGE_CORNER, // in zone outline: a point to define an outline
|
|
TYPE_ZONE_CONTAINER, // a zone area
|
|
TYPE_BOARD_ITEM_LIST, // a list of board items
|
|
|
|
// Draw Items in schematic
|
|
DRAW_POLYLINE_STRUCT_TYPE,
|
|
DRAW_JUNCTION_STRUCT_TYPE,
|
|
TYPE_SCH_TEXT,
|
|
TYPE_SCH_LABEL,
|
|
TYPE_SCH_GLOBALLABEL,
|
|
TYPE_SCH_HIERLABEL,
|
|
TYPE_SCH_COMPONENT,
|
|
DRAW_SEGMENT_STRUCT_TYPE,
|
|
DRAW_BUSENTRY_STRUCT_TYPE,
|
|
DRAW_SHEET_STRUCT_TYPE,
|
|
DRAW_HIERARCHICAL_PIN_SHEET_STRUCT_TYPE,
|
|
TYPE_SCH_MARKER,
|
|
DRAW_NOCONNECT_STRUCT_TYPE,
|
|
DRAW_PART_TEXT_STRUCT_TYPE,
|
|
|
|
// General
|
|
SCREEN_STRUCT_TYPE,
|
|
BLOCK_LOCATE_STRUCT_TYPE,
|
|
|
|
/*
|
|
* Draw items in library component.
|
|
*
|
|
* The order of these items effects the sort order for items inside the
|
|
* "DRAW/ENDDRAW" section of the component definition in a library file.
|
|
* If you add a new draw item, type, please make sure you add it so the
|
|
* sort order is logical.
|
|
*/
|
|
LIB_COMPONENT_T,
|
|
LIB_ALIAS_T,
|
|
COMPONENT_ARC_DRAW_TYPE,
|
|
COMPONENT_CIRCLE_DRAW_TYPE,
|
|
COMPONENT_GRAPHIC_TEXT_DRAW_TYPE,
|
|
COMPONENT_RECT_DRAW_TYPE,
|
|
COMPONENT_POLYLINE_DRAW_TYPE,
|
|
COMPONENT_LINE_DRAW_TYPE,
|
|
COMPONENT_BEZIER_DRAW_TYPE,
|
|
COMPONENT_PIN_DRAW_TYPE,
|
|
|
|
/*
|
|
* Fields are not saved inside the "DRAW/ENDDRAW". Add new draw item
|
|
* types before this line.
|
|
*/
|
|
COMPONENT_FIELD_DRAW_TYPE,
|
|
|
|
/*
|
|
* For Gerbview: items type:
|
|
*/
|
|
TYPE_GERBER_DRAW_ITEM,
|
|
|
|
// End value
|
|
MAX_STRUCT_TYPE_ID
|
|
};
|
|
|
|
|
|
enum SEARCH_RESULT {
|
|
SEARCH_QUIT,
|
|
SEARCH_CONTINUE
|
|
};
|
|
|
|
|
|
class EDA_BaseStruct;
|
|
class WinEDA_DrawFrame;
|
|
class BOARD;
|
|
class EDA_Rect;
|
|
class WinEDA_DrawPanel;
|
|
|
|
/**
|
|
* Class INSPECTOR
|
|
* is an abstract class that is used to inspect and possibly collect the
|
|
* (search) results of Iterating over a list or tree of KICAD_T objects.
|
|
* Extend from this class and implement the Inspect function and provide for
|
|
* a way for the extension to collect the results of the search/scan data and
|
|
* provide them to the caller.
|
|
*/
|
|
class INSPECTOR
|
|
{
|
|
public:
|
|
virtual ~INSPECTOR()
|
|
{
|
|
}
|
|
|
|
|
|
/**
|
|
* Function Inspect
|
|
* is the examining function within the INSPECTOR which is passed to the
|
|
* Iterate function. It is used primarily for searching, but not limited
|
|
*to
|
|
* that. It can also collect or modify the scanned objects.
|
|
*
|
|
* @param testItem An EDA_BaseStruct to examine.
|
|
* @param testData is arbitrary data needed by the inspector to determine
|
|
* if the BOARD_ITEM under test meets its match criteria.
|
|
* @return SEARCH_RESULT - SEARCH_QUIT if the Iterator is to stop the scan,
|
|
* else SCAN_CONTINUE;
|
|
*/
|
|
SEARCH_RESULT virtual Inspect( EDA_BaseStruct* testItem,
|
|
const void* testData ) = 0;
|
|
};
|
|
|
|
|
|
/**
|
|
* Class EDA_Rect
|
|
* handles the component boundary box.
|
|
* This class is similar to wxRect, but some wxRect functions are very curious,
|
|
* so I prefer this suitable class
|
|
*/
|
|
class EDA_Rect
|
|
{
|
|
public:
|
|
wxPoint m_Pos; // Rectangle Origin
|
|
wxSize m_Size; // Rectangle Size
|
|
|
|
public:
|
|
EDA_Rect() { };
|
|
|
|
EDA_Rect( const wxPoint& aPos, const wxSize& aSize ) :
|
|
m_Pos( aPos ),
|
|
m_Size( aSize )
|
|
{ }
|
|
|
|
wxPoint Centre()
|
|
{
|
|
return wxPoint( m_Pos.x + ( m_Size.x >> 1 ),
|
|
m_Pos.y + ( m_Size.y >> 1 ) );
|
|
}
|
|
|
|
|
|
/* Move this by the aMoveVector value (this is a relative move
|
|
*/
|
|
void Move( const wxPoint& aMoveVector );
|
|
|
|
void Normalize(); // Ensure the height and width are >= 0
|
|
bool Inside( const wxPoint& point ); // Return TRUE if point is in Rect
|
|
|
|
bool Inside( int x, int y ) { return Inside( wxPoint( x, y ) ); }
|
|
wxSize GetSize() { return m_Size; }
|
|
int GetX() const { return m_Pos.x; }
|
|
int GetY() const { return m_Pos.y; }
|
|
wxPoint GetOrigin() { return m_Pos; }
|
|
wxPoint GetPosition() { return m_Pos; }
|
|
wxPoint GetEnd() const { return wxPoint( GetRight(), GetBottom() ); }
|
|
int GetWidth() const { return m_Size.x; }
|
|
int GetHeight() const { return m_Size.y; }
|
|
int GetRight() const { return m_Pos.x + m_Size.x; }
|
|
int GetBottom() const { return m_Pos.y + m_Size.y; }
|
|
void SetOrigin( const wxPoint& pos ) { m_Pos = pos; }
|
|
void SetOrigin( int x, int y ) { m_Pos.x = x; m_Pos.y = y; }
|
|
void SetSize( const wxSize& size ) { m_Size = size; }
|
|
void SetSize( int w, int h ) { m_Size.x = w; m_Size.y = h; }
|
|
void Offset( int dx, int dy ) { m_Pos.x += dx; m_Pos.y += dy; }
|
|
void Offset( const wxPoint& offset ) { m_Pos.x += offset.x; m_Pos.y +=
|
|
offset.y; }
|
|
void SetX( int val ) { m_Pos.x = val; }
|
|
void SetY( int val ) { m_Pos.y = val; }
|
|
void SetWidth( int val ) { m_Size.x = val; }
|
|
void SetHeight( int val ) { m_Size.y = val; }
|
|
void SetEnd( int x, int y ) { SetEnd( wxPoint( x, y ) ); }
|
|
void SetEnd( const wxPoint& pos )
|
|
{
|
|
m_Size.x = pos.x - m_Pos.x; m_Size.y = pos.y - m_Pos.y;
|
|
}
|
|
|
|
|
|
/**
|
|
* Function Intersects
|
|
* @return bool - true if the argument rectangle intersects this rectangle.
|
|
*/
|
|
bool Intersects( const EDA_Rect aRect ) const;
|
|
|
|
|
|
/**
|
|
* Function operator(wxRect)
|
|
* overloads the cast operator to return a wxRect
|
|
*/
|
|
operator wxRect() const { return wxRect( m_Pos, m_Size ); }
|
|
|
|
/** Inflate
|
|
* Inflate this object: move each horizontal edge by dx and each vertical
|
|
* edge by dy toward rect outside
|
|
* if dx and/or dy is negative, move toward rect inside (deflate)
|
|
* Works for positive and negative rect size
|
|
*/
|
|
EDA_Rect& Inflate( wxCoord dx, wxCoord dy );
|
|
|
|
/** Inflate
|
|
* Inflate this object: move each horizontal edge and each vertical edge by
|
|
* aDelta toward rect outside
|
|
* if aDelta is negative, move toward rect inside (deflate)
|
|
* Works for positive and negative rect size
|
|
*/
|
|
EDA_Rect& Inflate( int aDelta );
|
|
|
|
/**
|
|
* Function Merge
|
|
* Modify Position and Size of this in order to contain the given rect
|
|
* mainly used to calculate bounding boxes
|
|
* @param aRect = given rect to merge with this
|
|
*/
|
|
void Merge( const EDA_Rect& aRect );
|
|
|
|
/**
|
|
* Function Merge
|
|
* Modify Position and Size of this in order to contain the given point
|
|
* mainly used to calculate bounding boxes
|
|
* @param aPoint = given point to merge with this
|
|
*/
|
|
void Merge( const wxPoint& aPoint );
|
|
};
|
|
|
|
|
|
/******************************************************/
|
|
/* Basic Classes : used classes are derived from them */
|
|
/******************************************************/
|
|
|
|
class DHEAD;
|
|
|
|
/**
|
|
* Class EDA_BaseStruct
|
|
* is a base class for most all the kicad significant classes, used in
|
|
* schematics and boards.
|
|
*/
|
|
|
|
// These define are used for the .m_Flags and .m_UndoRedoStatus member of the
|
|
// class EDA_BaseStruct
|
|
#define IS_CHANGED (1 << 0)
|
|
#define IS_LINKED (1 << 1)
|
|
#define IN_EDIT (1 << 2)
|
|
#define IS_MOVED (1 << 3)
|
|
#define IS_NEW (1 << 4)
|
|
#define IS_RESIZED (1 << 5)
|
|
#define IS_DRAGGED (1 << 6)
|
|
#define IS_DELETED (1 << 7)
|
|
#define IS_WIRE_IMAGE (1 << 8)
|
|
#define STARTPOINT (1 << 9)
|
|
#define ENDPOINT (1 << 10)
|
|
#define SELECTED (1 << 11)
|
|
#define SELECTEDNODE (1 << 12) ///< flag indicating that the structure has already selected
|
|
#define STRUCT_DELETED (1 << 13) ///< flag indication structures to be erased
|
|
#define CANDIDATE (1 << 14) ///< flag indicating that the structure is connected
|
|
#define SKIP_STRUCT (1 << 15) ///< flag indicating that the structure should be ignored
|
|
#define DO_NOT_DRAW (1 << 16) ///< Used to disable draw function
|
|
#define IS_CANCELLED (1 << 17) ///< flag set when edit dialogs are canceled when editing a
|
|
///< new object
|
|
|
|
class EDA_BaseStruct
|
|
{
|
|
private:
|
|
|
|
/**
|
|
* Run time identification, _keep private_ so it can never be changed after
|
|
* a constructor sets it. See comment near SetType() regarding virtual
|
|
*functions.
|
|
*/
|
|
KICAD_T m_StructType;
|
|
|
|
protected:
|
|
EDA_BaseStruct* Pnext; /* Linked list: Link (next struct) */
|
|
EDA_BaseStruct* Pback; /* Linked list: Link (previous struct) */
|
|
EDA_BaseStruct* m_Parent; /* Linked list: Link (parent struct) */
|
|
EDA_BaseStruct* m_Son; /* Linked list: Link (son struct) */
|
|
DHEAD* m_List; ///< which DLIST I am on.
|
|
|
|
|
|
public:
|
|
int m_Flags; // flags for editing and other uses.
|
|
|
|
unsigned long m_TimeStamp; // Time stamp used for logical links
|
|
int m_Selected; /* Used by block commands, and selective
|
|
* editing */
|
|
|
|
// member used in undo/redo function
|
|
EDA_BaseStruct* m_Image; // Link to an image copy to save a copy of
|
|
// old parameters values
|
|
|
|
private:
|
|
int m_Status;
|
|
|
|
private:
|
|
void InitVars();
|
|
|
|
|
|
public:
|
|
|
|
EDA_BaseStruct( EDA_BaseStruct* parent, KICAD_T idType );
|
|
EDA_BaseStruct( KICAD_T idType );
|
|
EDA_BaseStruct( const EDA_BaseStruct& base );
|
|
virtual ~EDA_BaseStruct() { };
|
|
|
|
/**
|
|
* Function Type
|
|
* returns the type of object. This attribute should never be changed
|
|
* after a constructor sets it, so there is no public "setter" method.
|
|
* @return KICAD_T - the type of object.
|
|
*/
|
|
KICAD_T Type() const { return m_StructType; }
|
|
|
|
|
|
EDA_BaseStruct* Next() const { return (EDA_BaseStruct*) Pnext; }
|
|
EDA_BaseStruct* Back() const { return (EDA_BaseStruct*) Pback; }
|
|
EDA_BaseStruct* GetParent() const { return m_Parent; }
|
|
EDA_BaseStruct* GetSon() const { return m_Son; }
|
|
DHEAD* GetList() const { return m_List; }
|
|
|
|
void SetNext( EDA_BaseStruct* aNext ) { Pnext = aNext; }
|
|
void SetBack( EDA_BaseStruct* aBack ) { Pback = aBack; }
|
|
void SetParent( EDA_BaseStruct* aParent ) { m_Parent = aParent; }
|
|
void SetSon( EDA_BaseStruct* aSon ) { m_Son = aSon; }
|
|
void SetList( DHEAD* aList ) { m_List = aList; }
|
|
|
|
inline bool IsNew() const { return m_Flags & IS_NEW; }
|
|
inline bool IsModified() const { return m_Flags & IS_CHANGED; }
|
|
inline bool IsMoving() const { return m_Flags & IS_MOVED; }
|
|
inline bool IsDragging() const { return m_Flags & IS_DRAGGED; }
|
|
inline bool IsSelected() const { return m_Flags & SELECTED; }
|
|
|
|
int GetState( int type ) const
|
|
{
|
|
return m_Status & type;
|
|
}
|
|
|
|
|
|
void SetState( int type, int state )
|
|
{
|
|
if( state )
|
|
m_Status |= type; // state = ON or OFF
|
|
else
|
|
m_Status &= ~type;
|
|
}
|
|
|
|
|
|
int ReturnStatus() const { return m_Status; }
|
|
|
|
void SetStatus( int new_status )
|
|
{
|
|
m_Status = new_status;
|
|
}
|
|
|
|
void SetFlags( int aFlags ) { m_Flags = aFlags; }
|
|
|
|
int GetFlags() { return m_Flags; }
|
|
|
|
/**
|
|
* 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 WinEDA_DrawFrame in which to print status information.
|
|
*/
|
|
virtual void DisplayInfo( WinEDA_DrawFrame* frame )
|
|
{
|
|
// derived classes may implement this
|
|
}
|
|
|
|
|
|
/**
|
|
* 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
|
|
*/
|
|
virtual bool HitTest( const wxPoint& refPos )
|
|
{
|
|
return false; // derived classes should override this function
|
|
}
|
|
|
|
|
|
/**
|
|
* Function HitTest (overlaid)
|
|
* tests if the given EDA_Rect intersect this object.
|
|
* For now, an ending point must be inside this rect.
|
|
* @param refArea : the given EDA_Rect
|
|
* @return bool - true if a hit, else false
|
|
*/
|
|
virtual bool HitTest( EDA_Rect& refArea )
|
|
{
|
|
return false; // derived classes should override this function
|
|
}
|
|
|
|
|
|
/**
|
|
* Function GetBoundingBox
|
|
* returns the orthogonal, bounding box of this object for display
|
|
* purposes.
|
|
* This box should be an enclosing perimeter for visible components of this
|
|
* object, and the units should be in the pcb or schematic coordinate
|
|
* system.
|
|
* It is OK to overestimate the size by a few counts.
|
|
*/
|
|
virtual EDA_Rect GetBoundingBox()
|
|
{
|
|
#if defined(DEBUG)
|
|
printf( "Missing GetBoundingBox()\n" );
|
|
Show( 0, std::cout ); // tell me which classes still need
|
|
// GetBoundingBox support
|
|
#endif
|
|
|
|
// return a zero-sized box per default. derived classes should override
|
|
// this
|
|
return EDA_Rect( wxPoint( 0, 0 ), wxSize( 0, 0 ) );
|
|
}
|
|
|
|
|
|
/**
|
|
* Function IterateForward
|
|
* walks through the object tree calling the inspector() on each object
|
|
* type requested in scanTypes.
|
|
*
|
|
* @param listStart The first in a list of EDA_BaseStructs to iterate over.
|
|
* @param inspector Is an INSPECTOR to call on each object that is one of
|
|
* the requested scanTypes.
|
|
* @param testData Is an aid to testFunc, and should be sufficient to
|
|
* allow it to fully determine if an item meets the match criteria, but it
|
|
* may also be used to collect output.
|
|
* @param scanTypes A KICAD_T array that is EOT
|
|
* terminated, and provides both the order and interest level of of
|
|
* the types of objects to be iterated over.
|
|
* @return SEARCH_RESULT - SEARCH_QUIT if the called INSPECTOR returned
|
|
* SEARCH_QUIT, else SCAN_CONTINUE;
|
|
*/
|
|
static SEARCH_RESULT IterateForward( EDA_BaseStruct* listStart,
|
|
INSPECTOR* inspector,
|
|
const void* testData,
|
|
const KICAD_T scanTypes[] );
|
|
|
|
|
|
/**
|
|
* Function Visit
|
|
* may be re-implemented for each derived class in order to handle
|
|
* all the types given by its member data. Implementations should call
|
|
* inspector->Inspect() on types in scanTypes[], and may use
|
|
* IterateForward()
|
|
* to do so on lists of such data.
|
|
* @param inspector An INSPECTOR instance to use in the inspection.
|
|
* @param testData Arbitrary data used by the inspector.
|
|
* @param scanTypes Which KICAD_T types are of interest and the order
|
|
* is significant too, terminated by EOT.
|
|
* @return SEARCH_RESULT - SEARCH_QUIT if the Iterator is to stop the scan,
|
|
* else SCAN_CONTINUE, and determined by the inspector.
|
|
*/
|
|
virtual SEARCH_RESULT Visit( INSPECTOR* inspector, const void* testData,
|
|
const KICAD_T scanTypes[] );
|
|
|
|
|
|
/**
|
|
* Function GetClass
|
|
* returns the class name.
|
|
* @return wxString
|
|
*/
|
|
virtual wxString GetClass() const
|
|
{
|
|
return wxT( "EDA_BaseStruct" );
|
|
}
|
|
|
|
|
|
#if defined(DEBUG)
|
|
|
|
/**
|
|
* Function Show
|
|
* is used to output the object tree, currently for debugging only.
|
|
* @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 );
|
|
|
|
|
|
/**
|
|
* Function NestedSpace
|
|
* outputs nested space for pretty indenting.
|
|
* @param nestLevel The nest count
|
|
* @param os The ostream&, where to output
|
|
* @return std::ostream& - for continuation.
|
|
**/
|
|
static std::ostream& NestedSpace( int nestLevel, std::ostream& os );
|
|
|
|
#endif
|
|
};
|
|
|
|
|
|
// Graphic Text justify:
|
|
// Values -1,0,1 are used in computations, do not change them
|
|
enum GRTextHorizJustifyType {
|
|
GR_TEXT_HJUSTIFY_LEFT = -1,
|
|
GR_TEXT_HJUSTIFY_CENTER = 0,
|
|
GR_TEXT_HJUSTIFY_RIGHT = 1
|
|
};
|
|
|
|
|
|
enum GRTextVertJustifyType {
|
|
GR_TEXT_VJUSTIFY_TOP = -1,
|
|
GR_TEXT_VJUSTIFY_CENTER = 0,
|
|
GR_TEXT_VJUSTIFY_BOTTOM = 1
|
|
};
|
|
|
|
/* Options to show solid segments (segments, texts...) */
|
|
enum GRTraceMode {
|
|
FILAIRE = 0, // segments are drawn as lines
|
|
FILLED, // normal mode: segments have thickness
|
|
SKETCH // sketcg mode: segments have thickness, but are not
|
|
// filled
|
|
};
|
|
|
|
/**
|
|
* Enum FILL_T
|
|
* is the set of fill types used in plotting or drawing enclosed areas.
|
|
*/
|
|
enum FILL_T {
|
|
NO_FILL, // Poly, Square, Circle, Arc = option No Fill
|
|
FILLED_SHAPE, /* Poly, Square, Circle, Arc = option Fill
|
|
* with current color ("Solid shape") */
|
|
FILLED_WITH_BG_BODYCOLOR /* Poly, Square, Circle, Arc = option Fill
|
|
* with background body color, translucent
|
|
* (texts inside this shape can be seen)
|
|
* not filled in B&W mode when plotting or
|
|
* printing */
|
|
};
|
|
|
|
|
|
#define DEFAULT_SIZE_TEXT 60 /* default text height (in mils or 1/1000") */
|
|
|
|
/**
|
|
* Class EDA_TextStruct
|
|
* is a basic class to handle texts (labels, texts on components or footprints
|
|
* ..) not used directly.
|
|
* The text classes are derived from EDA_BaseStruct and EDA_TextStruct
|
|
*/
|
|
class EDA_TextStruct
|
|
{
|
|
public:
|
|
wxString m_Text; /* text! */
|
|
wxPoint m_Pos; /* XY position of anchor text. */
|
|
wxSize m_Size; /* XY size of text */
|
|
int m_Width; /* pen size used to draw this text */
|
|
int m_Orient; /* Orient in 0.1 degrees */
|
|
bool m_Mirror; /* Display Normal / mirror */
|
|
int m_Attributs; /* flags (visible...) */
|
|
bool m_Italic; /* true to simulate (or use if exists)
|
|
* an italic font... */
|
|
bool m_Bold; /* true to simulate a bold font ... */
|
|
GRTextHorizJustifyType m_HJustify; /* Horiz justification */
|
|
GRTextVertJustifyType m_VJustify; /* Vertical justification */
|
|
bool m_MultilineAllowed; /* true to use multiline option, false
|
|
* to use only single line text
|
|
* Single line is faster in
|
|
* calculations than multiline */
|
|
|
|
public:
|
|
EDA_TextStruct( const wxString& text = wxEmptyString );
|
|
virtual ~EDA_TextStruct();
|
|
|
|
int GetLength() const { return m_Text.Length(); };
|
|
|
|
/**
|
|
* Function Draw
|
|
* @param aPanel = the current DrawPanel
|
|
* @param aDC = the current Device Context
|
|
* @param aOffset = draw offset (usually (0,0))
|
|
* @param EDA_Colors aColor = text color
|
|
* @param aDrawMode = GR_OR, GR_XOR.., -1 to use the current mode.
|
|
* @param GRTraceMode aDisplay_mode = FILAIRE, FILLED or SKETCH
|
|
* @param EDA_Colors aAnchor_color = anchor color ( UNSPECIFIED_COLOR = do
|
|
* not draw anchor ).
|
|
*/
|
|
void Draw( WinEDA_DrawPanel* aPanel, wxDC* aDC,
|
|
const wxPoint& aOffset, EDA_Colors aColor,
|
|
int aDrawMode, GRTraceMode aDisplay_mode = FILAIRE,
|
|
EDA_Colors aAnchor_color = UNSPECIFIED_COLOR );
|
|
|
|
private:
|
|
|
|
/**
|
|
* Function DrawOneLineOfText
|
|
* Draw a single text line.
|
|
* Used to draw each line of this EDA_TextStruct, that can be multiline
|
|
* @param aPanel = the current DrawPanel
|
|
* @param aDC = the current Device Context
|
|
* @param aOffset = draw offset (usually (0,0))
|
|
* @param EDA_Colors aColor = text color
|
|
* @param aDrawMode = GR_OR, GR_XOR.., -1 to use the current mode.
|
|
* @param aFillMode = FILAIRE, FILLED or SKETCH
|
|
* @param EDA_Colors aAnchor_color = anchor color ( UNSPECIFIED_COLOR = do
|
|
* not draw anchor ).
|
|
* @param EDA_Colors aText = the single line of text to draw.
|
|
* @param EDA_Colors aPos = the position of this line ).
|
|
*/
|
|
void DrawOneLineOfText( WinEDA_DrawPanel* aPanel, wxDC* aDC,
|
|
const wxPoint& aOffset, EDA_Colors aColor,
|
|
int aDrawMode, GRTraceMode aFillMode,
|
|
EDA_Colors aAnchor_color, wxString& aText,
|
|
wxPoint aPos );
|
|
|
|
public:
|
|
|
|
/**
|
|
* Function TextHitTest
|
|
* tests if the given wxPoint is within the bounds of this object.
|
|
* @param ref_pos A wxPoint to test
|
|
* @return bool - true if a hit, else false
|
|
*/
|
|
bool TextHitTest( const wxPoint& ref_pos );
|
|
|
|
/**
|
|
* Function TextHitTest (overloaded)
|
|
* tests if the given EDA_Rect intersect this object.
|
|
* For now, the anchor must be inside this rect.
|
|
* @param refArea : the given EDA_Rect
|
|
* @return bool - true if a hit, else false
|
|
*/
|
|
bool TextHitTest( EDA_Rect& refArea );
|
|
|
|
/**
|
|
* Function LenSize
|
|
* @return the text length in internal units
|
|
* @param aLine : the line of text to consider.
|
|
* For single line text, this parameter is always m_Text
|
|
*/
|
|
int LenSize( const wxString& aLine ) const;
|
|
|
|
/**
|
|
* Function GetTextBox
|
|
* useful in multiline texts to calculate the full text or a line area (for
|
|
* zones filling, locate functions....)
|
|
* @return the rect containing the line of text (i.e. the position and the
|
|
* size of one line)
|
|
* this rectangle is calculated for 0 orient text. if orient is not 0 the
|
|
* rect must be rotated to match the physical area
|
|
* @param aLine : the line of text to consider.
|
|
* for single line text, aLine is unused
|
|
* If aLine == -1, the full area (considering all lines) is returned
|
|
*/
|
|
EDA_Rect GetTextBox( int aLine = -1 );
|
|
|
|
/**
|
|
* Function GetInterline
|
|
* return the distance between 2 text lines
|
|
* has meaning only for multiline texts
|
|
*/
|
|
int GetInterline()
|
|
{
|
|
return (( m_Size.y * 14 ) / 10) + m_Width;
|
|
}
|
|
|
|
/**
|
|
* Function GetTextStyleName
|
|
* @return a wwString withe the style name( Normal, Italic, Bold, Bold+Italic)
|
|
*/
|
|
wxString GetTextStyleName();
|
|
};
|
|
|
|
#endif /* BASE_STRUCT_H */
|