kicad/pcbnew/class_dimension.h

152 lines
4.1 KiB
C
Raw Normal View History

/**
* @file class_dimension.h
* @brief DIMENSION class definition.
*/
#ifndef DIMENSION_H
#define DIMENSION_H
#include "class_board_item.h"
class LINE_READER;
class EDA_DRAW_PANEL;
class TEXTE_PCB;
class DIMENSION : public BOARD_ITEM
{
2007-08-08 20:51:08 +00:00
public:
int m_Width;
wxPoint m_Pos;
int m_Shape;
int m_Unit; /* 0 = inches, 1 = mm */
int m_Value; /* value of PCB dimensions. */
TEXTE_PCB* m_Text;
int m_crossBarOx, m_crossBarOy, m_crossBarFx, m_crossBarFy;
int m_featureLineGOx, m_featureLineGOy, m_featureLineGFx, m_featureLineGFy;
int m_featureLineDOx, m_featureLineDOy, m_featureLineDFx, m_featureLineDFy;
int m_arrowD1Ox, m_arrowD1Oy, m_arrowD1Fx, m_arrowD1Fy;
int m_arrowD2Ox, m_arrowD2Oy, m_arrowD2Fx, m_arrowD2Fy;
int m_arrowG1Ox, m_arrowG1Oy, m_arrowG1Fx, m_arrowG1Fy;
int m_arrowG2Ox, m_arrowG2Oy, m_arrowG2Fx, m_arrowG2Fy;
2007-08-08 20:51:08 +00:00
public:
DIMENSION( BOARD_ITEM* aParent );
~DIMENSION();
2007-12-01 03:42:52 +00:00
wxPoint& GetPosition()
{
return m_Pos;
}
2008-04-01 05:21:50 +00:00
2009-08-03 07:55:08 +00:00
/**
* Function SetLayer
* sets the layer this item is on.
* @param aLayer The layer number.
*/
void SetLayer( int aLayer );
2009-08-03 07:55:08 +00:00
2010-11-12 15:17:10 +00:00
/**
* Function AdjustDimensionDetails
* Calculate coordinates of segments used to draw the dimension.
* @param aDoNotChangeText (bool) if false, the dimension text is initialized
*/
void AdjustDimensionDetails( bool aDoNotChangeText = false );
bool ReadDimensionDescr( LINE_READER* aReader );
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;
2008-04-01 05:21:50 +00:00
void SetText( const wxString& NewText );
wxString GetText( void ) const;
void Copy( DIMENSION* source );
void Draw( EDA_DRAW_PANEL* panel, wxDC* DC,
int aColorMode, const wxPoint& offset = ZeroOffset );
2008-04-01 05:21:50 +00:00
/**
* Function Move
* @param offset : moving vector
*/
void Move(const wxPoint& offset);
2008-04-01 05:21:50 +00:00
/**
* Function Rotate
2009-08-01 19:26:05 +00:00
* 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.
2008-04-01 05:21:50 +00:00
*/
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 );
2008-04-01 05:21:50 +00:00
/**
* Function Mirror
* Mirror the Dimension , relative to a given horizontal axis
* the text is not mirrored. only its position (and angle) is mirrored
* the layer is not changed
* @param axis_pos : vertical axis position
*/
void Mirror( const wxPoint& axis_pos );
/**
* 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 EDA_DRAW_FRAME in which to print status information.
2008-04-01 05:21:50 +00:00
*/
void DisplayInfo( EDA_DRAW_FRAME* frame );
2008-04-01 05:21:50 +00:00
2007-08-08 20:51:08 +00:00
/**
* Function HitTest
* 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 HitTest( const wxPoint& ref_pos );
2008-04-01 05:21:50 +00:00
2008-01-06 12:43:57 +00:00
/**
* Function HitTest (overlaid)
* tests if the given EDA_RECT intersect this object.
2008-04-01 05:21:50 +00:00
* For now, the anchor must be inside this rect.
* @param refArea : the given EDA_RECT
2008-01-06 12:43:57 +00:00
* @return bool - true if a hit, else false
*/
bool HitTest( EDA_RECT& refArea );
2008-01-06 12:43:57 +00:00
2008-04-01 05:21:50 +00:00
2007-08-08 20:51:08 +00:00
/**
* Function GetClass
* returns the class name.
* @return wxString
*/
wxString GetClass() const
{
return wxT( "DIMENSION" );
}
EDA_RECT GetBoundingBox() const;
virtual wxString GetSelectMenuText() const;
virtual BITMAP_DEF GetMenuImage() const { return add_dimension_xpm; }
};
#endif // #define DIMENSION_H