254 lines
7.6 KiB
C++
254 lines
7.6 KiB
C++
/**
|
|
* @file class_drawsegment.h
|
|
* @brief Class to handle a graphic segment.
|
|
*/
|
|
|
|
#ifndef CLASS_DRAWSEGMENT_H_
|
|
#define CLASS_DRAWSEGMENT_H_
|
|
|
|
|
|
#include "class_board_item.h"
|
|
#include "PolyLine.h"
|
|
|
|
|
|
class LINE_READER;
|
|
class EDA_DRAW_FRAME;
|
|
class MODULE;
|
|
|
|
|
|
class DRAWSEGMENT : public BOARD_ITEM
|
|
{
|
|
public:
|
|
int m_Width; // thickness of lines ...
|
|
wxPoint m_Start; // Line start point or Circle and Arc center
|
|
wxPoint m_End; // Line end point or circle and arc start point
|
|
|
|
int m_Shape; // Shape: line, Circle, Arc
|
|
int m_Type; // Used in complex associations ( Dimensions.. )
|
|
int m_Angle; // Used only for Arcs: Arc angle in 1/10 deg
|
|
wxPoint m_BezierC1; // Bezier Control Point 1
|
|
wxPoint m_BezierC2; // Bezier Control Point 1
|
|
|
|
protected:
|
|
std::vector<wxPoint> m_BezierPoints;
|
|
std::vector<wxPoint> m_PolyPoints;
|
|
|
|
public:
|
|
DRAWSEGMENT( BOARD_ITEM* aParent, KICAD_T idtype = PCB_LINE_T );
|
|
~DRAWSEGMENT();
|
|
|
|
DRAWSEGMENT* Next() const { return (DRAWSEGMENT*) Pnext; }
|
|
DRAWSEGMENT* Back() const { return (DRAWSEGMENT*) Pback; }
|
|
|
|
void SetWidth( int aWidth ) { m_Width = aWidth; }
|
|
int GetWidth() const { return m_Width; }
|
|
|
|
void SetStart( const wxPoint& aStart ) { m_Start = aStart; }
|
|
|
|
void SetEnd( const wxPoint& aEnd ) { m_End = aEnd; }
|
|
|
|
/**
|
|
* Function SetAngle
|
|
* sets the angle for arcs, and normalizes it within the range 0 - 360 degrees.
|
|
* @param aAngle is tenths of degrees, but will soon be degrees.
|
|
*/
|
|
void SetAngle( double aAngle ); // encapsulates the transition to degrees
|
|
double GetAngle() const { return m_Angle; }
|
|
|
|
void SetType( int aType ) { m_Type = aType; }
|
|
|
|
void SetShape( int aShape ) { m_Shape = aShape; }
|
|
int GetShape() const { return m_Shape; }
|
|
|
|
void SetBezControl1( const wxPoint& aPoint ) { m_BezierC1 = aPoint; }
|
|
void SetBezControl2( const wxPoint& aPoint ) { m_BezierC2 = aPoint; }
|
|
|
|
/**
|
|
* Function GetPosition
|
|
* returns the position of this object.
|
|
* Required by pure virtual BOARD_ITEM::GetPosition()
|
|
* @return const wxPoint - The position of this object.
|
|
*/
|
|
const wxPoint GetPosition() const
|
|
{
|
|
return m_Start;
|
|
}
|
|
|
|
void SetPosition( const wxPoint& aPos ) { m_Start = aPos; }
|
|
|
|
/**
|
|
* Function GetStart
|
|
* returns the starting point of the graphic
|
|
*/
|
|
wxPoint GetStart() const;
|
|
|
|
/**
|
|
* Function GetEnd
|
|
* returns the ending point of the graphic
|
|
*/
|
|
wxPoint GetEnd() const;
|
|
|
|
/**
|
|
* Function GetRadius
|
|
* returns the radius of this item
|
|
* Has meaning only for arc and circle
|
|
*/
|
|
int GetRadius() const
|
|
{
|
|
double radius = hypot( (double) (m_End.x - m_Start.x), (double) (m_End.y - m_Start.y) );
|
|
return wxRound( radius );
|
|
}
|
|
|
|
/**
|
|
* Function GetParentModule
|
|
* returns a pointer to the parent module, or NULL if DRAWSEGMENT does not
|
|
* belong to a module.
|
|
* @return MODULE* - pointer to the parent module or NULL.
|
|
*/
|
|
MODULE* GetParentModule() const;
|
|
|
|
const std::vector<wxPoint>& GetBezierPoints() const { return m_BezierPoints; };
|
|
const std::vector<wxPoint>& GetPolyPoints() const { return m_PolyPoints; };
|
|
|
|
void SetBezierPoints( std::vector<wxPoint>& aPoints )
|
|
{
|
|
m_BezierPoints = aPoints;
|
|
}
|
|
|
|
void SetPolyPoints( std::vector<wxPoint>& aPoints )
|
|
{
|
|
m_PolyPoints = aPoints;
|
|
}
|
|
|
|
/**
|
|
* 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;
|
|
|
|
bool ReadDrawSegmentDescr( LINE_READER* aReader );
|
|
|
|
void Copy( DRAWSEGMENT* source );
|
|
|
|
|
|
void Draw( EDA_DRAW_PANEL* panel, wxDC* DC,
|
|
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 PCB_BASE_FRAME in which to print status information.
|
|
*/
|
|
virtual void DisplayInfo( EDA_DRAW_FRAME* frame );
|
|
|
|
|
|
/**
|
|
* 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() const;
|
|
|
|
|
|
/**
|
|
* 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 HitTest (overlayed)
|
|
* 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 to test
|
|
* @return bool - true if a hit, else false
|
|
*/
|
|
bool HitTest( EDA_RECT& refArea );
|
|
|
|
/**
|
|
* Function GetClass
|
|
* returns the class name.
|
|
* @return wxString
|
|
*/
|
|
wxString GetClass() const
|
|
{
|
|
return wxT( "DRAWSEGMENT" );
|
|
}
|
|
|
|
|
|
/**
|
|
* Function GetLength
|
|
* returns the length of the track using the hypotenuse calculation.
|
|
* @return double - the length of the track
|
|
*/
|
|
double GetLength() const
|
|
{
|
|
wxPoint delta = GetEnd() - GetStart();
|
|
|
|
return hypot( double( delta.x ), double( delta.y ) );
|
|
}
|
|
|
|
|
|
/**
|
|
* Function Move
|
|
* move this object.
|
|
* @param aMoveVector - the move vector for this object.
|
|
*/
|
|
virtual void Move( const wxPoint& aMoveVector )
|
|
{
|
|
m_Start += aMoveVector;
|
|
m_End += aMoveVector;
|
|
}
|
|
|
|
|
|
/**
|
|
* Function Rotate
|
|
* Rotate this object.
|
|
* @param aRotCentre - the rotation point.
|
|
* @param aAngle - the rotation angle in 0.1 degree.
|
|
*/
|
|
virtual void Rotate( const wxPoint& aRotCentre, int aAngle );
|
|
|
|
/**
|
|
* Function Flip
|
|
* Flip this object, i.e. change the board side for this object
|
|
* @param aCentre - the rotation point.
|
|
*/
|
|
virtual void Flip( const wxPoint& aCentre );
|
|
|
|
/**
|
|
* 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_dashed_line_xpm; }
|
|
|
|
#if defined(DEBUG)
|
|
void Show( int nestLevel, std::ostream& os );
|
|
#endif
|
|
};
|
|
|
|
#endif // CLASS_DRAWSEGMENT_H_
|