/********************** * class_base_screen.h **********************/ /* define : * class BASE_SCREEN to handle how to draw a screen (a board, a schematic ...) */ #ifndef __CLASS_BASE_SCREEN_H__ #define __CLASS_BASE_SCREEN_H__ #include "base_struct.h" #include "class_undoredo_container.h" #include "block_commande.h" #include "common.h" // Forward declarations: class SCH_ITEM; class Ki_PageDescr; /* Simple class for handling grid arrays. */ class GRID_TYPE { public: int m_Id; wxRealPoint m_Size; GRID_TYPE& operator=( const GRID_TYPE& item ) { if( this != &item ) { m_Id = item.m_Id; m_Size = item.m_Size; } return *this; } const bool operator==( const GRID_TYPE& item ) const { return m_Size == item.m_Size && m_Id == item.m_Id; } }; /* Declare array of wxSize for grid list implementation. */ #include WX_DECLARE_OBJARRAY( GRID_TYPE, GridArray ); /*******************************************************************/ /* Class to handle how to draw a screen (a board, a schematic ...) */ /*******************************************************************/ class BASE_SCREEN : public EDA_BaseStruct { public: wxPoint m_DrawOrg; /* offsets for drawing the circuit on the * screen */ wxPoint m_Curseur; /* Screen cursor coordinate (on grid) in user * units. */ wxPoint m_MousePosition; /* Mouse cursor coordinate (off grid) in user * units. */ wxPoint m_MousePositionInPixels; wxPoint m_O_Curseur; /* Relative Screen cursor coordinate (on grid) * in user units. * (coordinates from last reset position)*/ // Scrollbars management: int m_ScrollPixelsPerUnitX; /* Pixels per scroll unit in the horizontal direction. */ int m_ScrollPixelsPerUnitY; /* Pixels per scroll unit in the vertical direction. */ wxSize m_ScrollbarNumber; /* Current virtual draw area size in scroll * units. * m_ScrollbarNumber * m_ScrollPixelsPerUnit = virtual draw area size in pixels */ wxPoint m_ScrollbarPos; /* Current scroll bar position in scroll * units. */ wxPoint m_StartVisu; /* Coordinates in drawing units of the current * view position (upper left corner of device) */ wxSize m_SizeVisu; /* taille en pixels de l'ecran (fenetre de visu * Utile pour recadrer les affichages lors de la * navigation dans la hierarchie */ bool m_Center; /* Center on screen. If TRUE (0.0) is centered * on screen coordinates can be < 0 and * > 0 except for schematics. * FALSE: when coordinates can only be >= 0 * Schematic */ bool m_FirstRedraw; SCH_ITEM* EEDrawList; /* Object list (main data) for schematic */ // Undo/redo list of commands UNDO_REDO_CONTAINER m_UndoList; /* Objects list for the undo * command (old data) */ UNDO_REDO_CONTAINER m_RedoList; /* Objects list for the redo * command (old data) */ unsigned m_UndoRedoCountMax; // undo/Redo command Max depth /* block control */ BLOCK_SELECTOR m_BlockLocate; /* Block description for block * commands */ /* Page description */ Ki_PageDescr* m_CurrentSheetDesc; int m_ScreenNumber; int m_NumberOfScreen; wxString m_FileName; wxString m_Title; wxString m_Date; wxString m_Revision; wxString m_Company; wxString m_Commentaire1; wxString m_Commentaire2; wxString m_Commentaire3; wxString m_Commentaire4; private: char m_FlagRefreshReq; /* indicates that the screen should * be redrawn */ char m_FlagModified; // indicates current drawing has // been modified char m_FlagSave; // Perform automatica file save. EDA_BaseStruct* m_CurrentItem; ///< Currently selected object GRID_TYPE m_Grid; ///< Current grid selection. /* Grid and zoom values. */ public: wxPoint m_GridOrigin; GridArray m_GridList; wxArrayInt m_ZoomList; /* Array of standard zoom coefficients. */ int m_Zoom; /* Current zoom coefficient. */ int m_ZoomScalar; /* Allow zooming to non-integer increments. */ bool m_IsPrinting; public: BASE_SCREEN( KICAD_T aType = SCREEN_STRUCT_TYPE ); ~BASE_SCREEN(); BASE_SCREEN* Next() const { return (BASE_SCREEN*) Pnext; } BASE_SCREEN* Back() const { return (BASE_SCREEN*) Pback; } /** * Function setCurItem * sets the currently selected object, m_CurrentItem. * @param current Any object derived from EDA_BaseStruct */ void SetCurItem( EDA_BaseStruct* current ) { m_CurrentItem = current; } EDA_BaseStruct* GetCurItem() const { return m_CurrentItem; } void InitDatas(); void SetPageSize( wxSize& aPageSize ); wxSize ReturnPageSize( void ); virtual int GetInternalUnits( void ); /** Function CursorRealPosition * @return the position in user units of location ScreenPos * @param ScreenPos = the screen (in pixel) position co convert */ wxPoint CursorRealPosition( const wxPoint& ScreenPos ); /* general Undo/Redo command control */ /** function ClearUndoORRedoList (virtual). * this function must remove the aItemCount old commands from aList * and delete commands, pickers and picked items if needed * Because picked items must be deleted only if they are not in use, this * is a virtual pure function that must be created for SCH_SCREEN and * PCB_SCREEN * @param aList = the UNDO_REDO_CONTAINER of commands * @param aItemCount = number of old commands to delete. -1 to remove all * old commands this will empty the list of commands. * Commands are deleted from the older to the last. */ virtual void ClearUndoORRedoList( UNDO_REDO_CONTAINER& aList, int aItemCount = -1 ) = 0; /** Function ClearUndoRedoList * clear undo and redo list, using ClearUndoORRedoList() * picked items are deleted by ClearUndoORRedoList() according to their * status */ virtual void ClearUndoRedoList(); /** function PushCommandToUndoList * add a command to undo in undo list * delete the very old commands when the max count of undo commands is * reached * ( using ClearUndoORRedoList) */ virtual void PushCommandToUndoList( PICKED_ITEMS_LIST* aItem ); /** function PushCommandToRedoList * add a command to redo in redo list * delete the very old commands when the max count of redo commands is * reached * ( using ClearUndoORRedoList) */ virtual void PushCommandToRedoList( PICKED_ITEMS_LIST* aItem ); /** PopCommandFromUndoList * return the last command to undo and remove it from list * nothing is deleted. */ virtual PICKED_ITEMS_LIST* PopCommandFromUndoList(); /** PopCommandFromRedoList * return the last command to undo and remove it from list * nothing is deleted. */ virtual PICKED_ITEMS_LIST* PopCommandFromRedoList(); int GetUndoCommandCount() { return m_UndoList.m_CommandsList.size(); } int GetRedoCommandCount() { return m_RedoList.m_CommandsList.size(); } void SetRefreshReq() { m_FlagRefreshReq = 1; } void ClrRefreshReq() { m_FlagRefreshReq = 0; } void SetModify() { m_FlagModified = 1; m_FlagSave = 0; } void ClrModify() { m_FlagModified = 0; m_FlagSave = 1; } void SetSave() { m_FlagSave = 1; } void ClrSave() { m_FlagSave = 0; } int IsModify() { return m_FlagModified & 1; } int IsRefreshReq() { return m_FlagRefreshReq & 1; } int IsSave() { return m_FlagSave & 1; } //------------------------------------------------------------- /** Function GetScalingFactor * @return the the current scale used to draw items on screen * draw coordinates are user coordinates * GetScalingFactor( ) */ double GetScalingFactor() { return (double) m_ZoomScalar / (double) GetZoom(); } /** Function SetScalingFactor * @param the the current scale used to draw items on screen * draw coordinates are user coordinates * GetScalingFactor( ) */ void SetScalingFactor( double aScale ); /** Function GetZoom * @return the current zoom factor * Note: the zoom factor is NOT the scaling factor * the scaling factor is m_ZoomScalar * GetZoom() */ int GetZoom() const; /** * Function SetZoom * adjusts the current zoom factor */ bool SetZoom( int coeff ); /** * Function SetZoomList * sets the list of zoom factors. * @param aZoomList An array of zoom factors in ascending order, zero * terminated */ void SetZoomList( const wxArrayInt& zoomlist ); int Scale( int coord ); double Scale( double coord ); void Scale( wxPoint& pt ); void Scale( wxSize& sz ); void Scale( wxRealPoint& sz ); int Unscale( int coord ); void Unscale( wxPoint& pt ); void Unscale( wxSize& sz ); bool SetNextZoom(); bool SetPreviousZoom(); bool SetFirstZoom(); bool SetLastZoom(); //-------------------------------------------------------------- /** * Return the command ID of the currently selected grid. * * @return int - Currently selected grid command ID. */ int GetGridId(); /** * Return the grid size of the currently selected grid. * * @return wxRealPoint - The currently selected grid size. */ wxRealPoint GetGridSize(); /** * Return the grid object of the currently selected grid. * * @return GRID_TYPE - The currently selected grid. */ GRID_TYPE GetGrid(); const wxPoint &GetGridOrigin(); void SetGrid( const wxRealPoint& size ); void SetGrid( int id ); void SetGridList( GridArray& sizelist ); void AddGrid( const GRID_TYPE& grid ); void AddGrid( const wxRealPoint& size, int id ); void AddGrid( const wxRealPoint& size, UserUnitType aUnit, int id ); /** * Function RefPos * Return the reference position, coming from either the mouse position * or the cursor position. * * @param useMouse If true, return mouse position, else cursor's. * * @return wxPoint - The reference point, either the mouse position or * the cursor position. */ wxPoint RefPos( bool useMouse ) { return useMouse ? m_MousePosition : m_Curseur; } /** * Function GetClass * returns the class name. * @return wxString */ virtual wxString GetClass() const { return wxT( "BASE_SCREEN" ); } #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. */ void Show( int nestLevel, std::ostream& os ); #endif }; #endif /* #ifndef __CLASS_BASE_SCREEN_H__ */