kicad/pcbnew/class_edge_mod.h

/**************************************************************/
/* class_edge_module.h : description des contours d'un module */
/**************************************************************/

class Pcb3D_GLCanvas;


/* description des contours (empreintes ) et TYPES des CONTOURS : */

class EDGE_MODULE : public BOARD_ITEM
{
public:
    int     m_Width;        // 0 = line, > 0 = tracks, bus ...
    wxPoint m_Start;        // Line start point
    wxPoint m_End;          // Line end point

    int     m_Shape;        // voir "enum Track_Shapes"
    wxPoint m_Start0;       // coord relatives a l'ancre du point de depart(Orient 0)
    wxPoint m_End0;         // coord relatives a l'ancre du point de fin (Orient 0)

    int     m_Angle;        // pour les arcs de cercle: longueur de l'arc en 0,1 degres

    int     m_PolyCount;    // For polygons: number of points (> 2)
    int*    m_PolyList;     // For polygons: coord list (1 point = 2 coord)
                            // Coord are relative to Origin, orient 0

public:
    EDGE_MODULE( MODULE* parent );
    EDGE_MODULE( EDGE_MODULE* edge );
    ~EDGE_MODULE();


    /**
     * Function GetPosition
     * returns the position of this object.
     * @return const wxPoint& - The position of this object.
     */
    wxPoint& GetPosition()
    {
        return m_Start;
    }


    /* supprime du chainage la structure Struct */
    void    UnLink();

    void    Copy( EDGE_MODULE* source );    // copy structure

    /**
     * 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;

    int     ReadDescr( char* Line, FILE* File, int* LineNum = NULL );

    // Mise a jour des coordon<6F>s pour l'affichage
    void    SetDrawCoord();

    /* drawing functions */
    void    Draw( WinEDA_DrawPanel* panel, wxDC* DC, const wxPoint& offset,
                  int draw_mode );
    void    Draw3D( Pcb3D_GLCanvas* glcanvas );


    /**
     * Function Display_Infos
     * 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_BaseStruct.
     * @param frame A WinEDA_DrawFrame in which to print status information.
     */
    void    Display_Infos( WinEDA_DrawFrame* frame );


    /**
     * 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
     */
    bool    HitTest( const wxPoint& refPos );

    /**
     * Function GetClass
     * returns the class name.
     * @return wxString
     */
    virtual wxString GetClass() const
    {
        return wxT( "MGRAPHIC" );
        // return wxT( "EDGE" );  ?
    }

#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 ShowShape
     * converts the enum Track_Shapes integer value to a C string.
     */
    static const char* ShowShape( int aShape );

#endif
};