236 lines
9.6 KiB
C++
236 lines
9.6 KiB
C++
/*
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
*
|
|
* Copyright (C) 2006 Jean-Pierre Charras, jaen-pierre.charras@gipsa-lab.inpg.com
|
|
* Copyright (C) 2011 Wayne Stambaugh <stambaughw@verizon.net>
|
|
* Copyright (C) 1992-2011 KiCad Developers, see AUTHORS.txt for contributors.
|
|
*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License
|
|
* as published by the Free Software Foundation; either version 2
|
|
* of the License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, you may find one here:
|
|
* http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
|
|
* or you may search the http://www.gnu.org website for the version 2 license,
|
|
* or you may write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
|
|
*/
|
|
|
|
/**
|
|
* @file gr_basic.h
|
|
*/
|
|
|
|
#ifndef GR_BASIC
|
|
#define GR_BASIC
|
|
|
|
#include <colors.h>
|
|
#include <vector>
|
|
class EDA_RECT;
|
|
|
|
|
|
#define GR_COPY 0
|
|
#define GR_OR 0x01000000
|
|
#define GR_XOR 0x02000000
|
|
#define GR_AND 0x04000000
|
|
#define GR_NXOR 0x08000000
|
|
#define GR_INVERT 0x10000000
|
|
#define GR_ALLOW_HIGHCONTRAST 0x20000000
|
|
|
|
#define GR_HIGHLIGHT 0x80000000
|
|
|
|
#define GR_M_LEFT_DOWN 0x10000000
|
|
#define GR_M_RIGHT_DOWN 0x20000000
|
|
#define GR_M_MIDDLE_DOWN 0x40000000
|
|
#define GR_M_DCLICK 0x80000000
|
|
|
|
//wxWidgets 2.8 compatibility
|
|
#if !wxCHECK_VERSION(2,9,0)
|
|
#define wxPENSTYLE_SOLID wxSOLID
|
|
#define wxPENSTYLE_SHORT_DASH wxSHORT_DASH
|
|
#define wxPENSTYLE_DOT_DASH wxDOT_DASH
|
|
typedef int wxPenStyle;
|
|
#endif
|
|
|
|
|
|
extern int g_XorMode;
|
|
extern int g_DrawBgColor;
|
|
|
|
|
|
typedef enum {
|
|
/* Line styles for Get/SetLineStyle. */
|
|
GR_SOLID_LINE = 0,
|
|
GR_DOTTED_LINE = 1,
|
|
GR_DASHED_LINE = 3
|
|
} GRLineStypeType;
|
|
|
|
|
|
class EDA_DRAW_PANEL;
|
|
|
|
void GRSetDrawMode( wxDC* DC, int mode );
|
|
int GRGetDrawMode( wxDC* DC );
|
|
void GRResetPenAndBrush( wxDC* DC );
|
|
void GRSetColorPen( wxDC* DC, int Color, int width = 1, wxPenStyle stype = wxPENSTYLE_SOLID );
|
|
void GRSetBrush( wxDC* DC, int Color, int fill = 0 );
|
|
|
|
/**
|
|
* Function GRForceBlackPen
|
|
* @param flagforce True to force a black pen whenever the asked color
|
|
*/
|
|
void GRForceBlackPen( bool flagforce );
|
|
|
|
/**
|
|
* Function GetGRForceBlackPenState
|
|
* @return ForceBlackPen (True if a black pen was forced)
|
|
*/
|
|
bool GetGRForceBlackPenState( void );
|
|
|
|
void GRLine( EDA_RECT* aClipBox, wxDC* aDC, wxPoint aStart, wxPoint aEnd, int aWidth, int aColor );
|
|
void GRLine( EDA_RECT* ClipBox, wxDC* DC, int x1, int y1, int x2, int y2, int width, int Color );
|
|
void GRMixedLine( EDA_RECT* ClipBox, wxDC* DC, int x1, int y1, int x2, int y2,
|
|
int width, int Color );
|
|
void GRDashedLine( EDA_RECT* ClipBox, wxDC* DC, int x1, int y1, int x2, int y2,
|
|
int width, int Color );
|
|
void GRDashedLineTo( EDA_RECT* ClipBox, wxDC* DC, int x2, int y2, int width, int Color );
|
|
void GRMoveTo( int x, int y );
|
|
void GRLineTo( EDA_RECT* ClipBox, wxDC* DC, int x, int y, int width, int Color );
|
|
|
|
void GRPoly( EDA_RECT* ClipBox, wxDC* DC, int n, wxPoint Points[], bool Fill,
|
|
int width, int Color, int BgColor );
|
|
|
|
void GRBezier( EDA_RECT* ClipBox, wxDC* DC, int x1, int y1, int x2, int y2,
|
|
int x3, int y3, int width, int Color );
|
|
void GRBezier( EDA_RECT* ClipBox, wxDC* DC, int x1, int y1, int x2, int y2,
|
|
int x3, int y3, int x4, int y4, int width, int Color );
|
|
|
|
/**
|
|
* Function GRClosedPoly
|
|
* draws a closed polygon onto the drawing context \a aDC and optionally fills
|
|
* and/or draws a border around it.
|
|
* @param ClipBox defines a rectangular boundary outside of which no drawing will occur.
|
|
* @param aDC the device context into which drawing should occur.
|
|
* @param aPointCount the number of points in the array \a aPoints.
|
|
* @param aPoints The points to draw.
|
|
* @param doFill true if polygon is to be filled, else false and only the boundary is drawn.
|
|
* @param aPenColor the color index of the border.
|
|
* @param aFillColor the fill color of the polygon's interior.
|
|
*/
|
|
void GRClosedPoly( EDA_RECT* ClipBox,
|
|
wxDC * aDC,
|
|
int aPointCount,
|
|
wxPoint aPoints[],
|
|
bool doFill,
|
|
int aPenColor,
|
|
int aFillColor );
|
|
|
|
// @todo could make these 2 closed polygons calls a single function and default
|
|
// the aPenWidth argument
|
|
|
|
/**
|
|
* Function GRClosedPoly
|
|
* draws a closed polygon onto the drawing context \a aDC and optionally fills
|
|
* and/or draws a border around it.
|
|
* @param ClipBox defines a rectangular boundary outside of which no drawing will occur.
|
|
* @param aDC the device context into which drawing should occur.
|
|
* @param aPointCount the number of points in the array \a aPointArray.
|
|
* @param aPoints the points to draw.
|
|
* @param doFill true if polygon is to be filled, else false and only the boundary is drawn.
|
|
* @param aPenWidth is the width of the pen to use on the perimeter, can be zero.
|
|
* @param aPenColor the color index of the border.
|
|
* @param aFillColor the fill color of the polygon's interior.
|
|
*/
|
|
void GRClosedPoly( EDA_RECT* ClipBox,
|
|
wxDC* aDC,
|
|
int aPointCount,
|
|
wxPoint aPoints[],
|
|
bool doFill,
|
|
int aPenWidth,
|
|
int aPenColor,
|
|
int aFillColor );
|
|
|
|
|
|
/**
|
|
* Function GRCircle
|
|
* draws a circle onto the drawing context \a aDC centered at the user
|
|
* coordinates (x,y)
|
|
*
|
|
* @param ClipBox defines a rectangular boundary outside of which no drawing will occur.
|
|
* @param aDC the device context into which drawing should occur.
|
|
* @param x The x coordinate in user space of the center of the circle.
|
|
* @param y The y coordinate in user space of the center of the circle.
|
|
* @param aRadius is the radius of the circle.
|
|
* @param aColor is an index into our color table of RGB colors.
|
|
* @see EDA_COLOR_T and colors.h
|
|
*/
|
|
void GRCircle( EDA_RECT* ClipBox, wxDC* aDC, int x, int y, int aRadius, int aColor );
|
|
void GRCircle( EDA_RECT* ClipBox, wxDC* DC, int x, int y, int r, int width, int Color );
|
|
void GRFilledCircle( EDA_RECT* ClipBox, wxDC* DC, int x, int y, int r, int width,
|
|
int Color, int BgColor );
|
|
void GRFilledCircle( EDA_RECT* aClipBox, wxDC* aDC, wxPoint aPos, int aRadius, int aColor );
|
|
void GRCircle( EDA_RECT* aClipBox, wxDC* aDC, wxPoint aPos, int aRadius, int aWidth, int aColor );
|
|
|
|
void GRArc( EDA_RECT* ClipBox, wxDC* DC, int x, int y, int StAngle,
|
|
int EndAngle, int r, int Color );
|
|
void GRArc( EDA_RECT* ClipBox, wxDC* DC, int x, int y, int StAngle,
|
|
int EndAngle, int r, int width, int Color );
|
|
void GRArc1( EDA_RECT* ClipBox, wxDC* DC, int x1, int y1, int x2, int y2,
|
|
int xc, int yc, int Color );
|
|
void GRArc1( EDA_RECT* ClipBox, wxDC* DC, int x1, int y1, int x2, int y2,
|
|
int xc, int yc, int width, int Color );
|
|
void GRArc1( EDA_RECT* aClipBox, wxDC* aDC, wxPoint aStart, wxPoint aEnd,
|
|
wxPoint aCenter, int aWidth, int aColor );
|
|
void GRFilledArc( EDA_RECT* ClipBox, wxDC* DC, int x, int y,
|
|
int StAngle, int EndAngle, int r, int Color, int BgColor );
|
|
void GRFilledArc( EDA_RECT* ClipBox, wxDC* DC, int x, int y, int StAngle,
|
|
int EndAngle, int r, int width, int Color, int BgColor );
|
|
void GRCSegm( EDA_RECT* ClipBox, wxDC* DC, int x1, int y1, int x2, int y2, int width, int Color );
|
|
|
|
void GRFillCSegm( EDA_RECT* ClipBox, wxDC* DC, int x1, int y1, int x2, int y2,
|
|
int width, int Color );
|
|
void GRFilledSegment( EDA_RECT* aClipBox, wxDC* aDC, wxPoint aStart, wxPoint aEnd,
|
|
int aWidth, int aColor );
|
|
|
|
void GRCSegm( EDA_RECT* ClipBox, wxDC* DC, int x1, int y1, int x2, int y2,
|
|
int width, int aPenSize, int Color );
|
|
void GRCSegm( EDA_RECT* aClipBox, wxDC* aDC, wxPoint aStart, wxPoint aEnd,
|
|
int aWidth, int aColor );
|
|
|
|
void GRSetColor( int Color );
|
|
void GRSetDefaultPalette();
|
|
int GRGetColor();
|
|
void GRPutPixel( EDA_RECT* ClipBox, wxDC* DC, int x, int y, int color );
|
|
void GRFilledRect( EDA_RECT* ClipBox, wxDC* DC, int x1, int y1,
|
|
int x2, int y2, int Color, int BgColor );
|
|
void GRFilledRect( EDA_RECT* ClipBox, wxDC* DC, int x1, int y1,
|
|
int x2, int y2, int width, int Color, int BgColor );
|
|
void GRRect( EDA_RECT* ClipBox, wxDC* DC, int x1, int y1, int x2, int y2, int Color );
|
|
void GRRect( EDA_RECT* ClipBox, wxDC* DC,const EDA_RECT& aRect, int aWidth, int Color );
|
|
void GRRect( EDA_RECT* ClipBox, wxDC* DC, int x1, int y1,
|
|
int x2, int y2, int width, int Color );
|
|
void GRRectPs( EDA_RECT* aClipBox, wxDC* aDC,const EDA_RECT& aRect,
|
|
int aWidth, int aColor, wxPenStyle aStyle = wxPENSTYLE_SOLID );
|
|
|
|
void GRSFilledRect( EDA_RECT* ClipBox, wxDC* DC, int x1, int y1,
|
|
int x2, int y2, int width, int Color, int BgColor );
|
|
|
|
/**
|
|
* Function GRLineArray
|
|
* draws an array of lines (not a polygon).
|
|
* @param aClipBox = the clip box
|
|
* @param aDC = the device context into which drawing should occur.
|
|
* @param aLines = a list of pair of coordinate in user space: a pair for each line.
|
|
* @param aWidth = the width of each line.
|
|
* @param aColor = an index into our color table of RGB colors.
|
|
* @see EDA_COLOR_T and colors.h
|
|
*/
|
|
void GRLineArray( EDA_RECT* aClipBox, wxDC* aDC,std::vector<wxPoint>& aLines,
|
|
int aWidth, int aColor );
|
|
|
|
#endif /* define GR_BASIC */
|