kicad/include/class_board_design_settings.h

206 lines
7.2 KiB
C
Raw Normal View History

2009-10-28 11:48:47 +00:00
/**********************************************************/
/* class_board_design_settings.h : handle board options */
/**********************************************************/
2012-02-06 07:14:51 +00:00
#ifndef BOARD_DESIGN_SETTINGS_H_
#define BOARD_DESIGN_SETTINGS_H_
2009-10-28 11:48:47 +00:00
#include <pcbstruct.h> // NB_COLORS
2012-02-19 04:02:19 +00:00
#include <class_pad.h>
#include <param_config.h>
2010-01-21 07:41:30 +00:00
2012-02-19 04:02:19 +00:00
/**
* Class BOARD_DESIGN_SETTINGS
* contains design settings for a BOARD object.
*/
class BOARD_DESIGN_SETTINGS
2009-10-28 11:48:47 +00:00
{
public:
bool m_MicroViasAllowed; ///< true to allow micro vias
bool m_BlindBuriedViaAllowed; ///< true to allow blind/buried vias
int m_CurrentViaType; ///< via type (VIA_BLIND_BURIED, VIA_THROUGH VIA_MICROVIA)
++PCBNew * Removed Pcb_Frame argument from BOARD() constructor, since it precludes having a BOARD being edited by more than one editor, it was a bad design. And this meant removing m_PcbFrame from BOARD. * removed BOARD::SetWindowFrame(), and BOARD::m_PcbFrame * Removed the global BOARD_DESIGN_SETTINGS which was in class_board.cpp * added BOARD_DESIGN_SETTINGS to the BOARD class, a full instance * a couple dialogs now only change BOARD_DESIGN_SETTINGS when OK is pressed, such as dialog_mask_clearance, dialog_drc, etc. * Removed common/pcbcommon.cpp's int g_CurrentVersionPCB = 1 and replaced it with build_version.h's #define BOARD_FILE_VERSION, although there may be a better place for this constant. * Made the public functions in PARAM_CFG_ARRAY be type const. void SaveParam(..) const and void ReadParam(..) const * PARAM_CFG_BASE now has virtual destructor since we have various way of destroying the derived class and boost::ptr_vector must be told about this. * Pass const PARAM_CFG_ARRAY& instead of PARAM_CFG_ARRAY so that we can use an automatic PARAM_CFG_ARRAY which is on the stack.\ * PCB_EDIT_FRAME::GetProjectFileParameters() may no longer cache the array, since it has to access the current BOARD and the BOARD can change. Remember BOARD_DESIGN_SETTINGS are now in the BOARD. * Made the m_BoundingBox member private, this was a brutally hard task, and indicative of the lack of commitment to accessors and object oriented design on the part of KiCad developers. We must do better. Added BOARD::GetBoundingBox, SetBoundingBox(), ComputeBoundingBox(). * Added PCB_BASE_FRAME::GetBoardBoundingBox() which calls BOARD::ComputeBoundingBox()
2011-12-05 06:15:33 +00:00
/// if true, when creating a new track starting on an existing track, use this track width
bool m_UseConnectedTrackWidth;
int m_DrawSegmentWidth; ///< current graphic line width (not EDGE layer)
int m_EdgeSegmentWidth; ///< current graphic line width (EDGE layer only)
int m_PcbTextWidth; ///< current Pcb (not module) Text width
wxSize m_PcbTextSize; ///< current Pcb (not module) Text size
int m_TrackMinWidth; ///< track min value for width ((min copper size value
int m_ViasMinSize; ///< vias (not micro vias) min diameter
int m_ViasMinDrill; ///< vias (not micro vias) min drill diameter
int m_MicroViasMinSize; ///< micro vias (not vias) min diameter
int m_MicroViasMinDrill; ///< micro vias (not vias) min drill diameter
// Global mask margins:
int m_SolderMaskMargin; ///< Solder mask margin
int m_SolderMaskMinWidth; ///< Solder mask min width
// 2 areas near than m_SolderMaskMinWidth
// are merged
int m_SolderPasteMargin; ///< Solder paste margin absolute value
double m_SolderPasteMarginRatio; ///< Solder pask margin ratio value of pad size
///< The final margin is the sum of these 2 values
// Variables used in footprint handling
wxSize m_ModuleTextSize; ///< Default footprint texts size
int m_ModuleTextWidth;
int m_ModuleSegmentWidth;
wxPoint m_AuxOrigin; ///< origin for plot exports
wxPoint m_GridOrigin; ///< origin for grid offsets
2009-10-28 11:48:47 +00:00
2012-02-19 04:02:19 +00:00
D_PAD m_Pad_Master;
2009-10-28 11:48:47 +00:00
public:
BOARD_DESIGN_SETTINGS();
2009-10-28 11:48:47 +00:00
/**
* Function GetVisibleLayers
* returns a bit-mask of all the layers that are visible
* @return int - the visible layers in bit-mapped form.
*/
LAYER_MSK GetVisibleLayers() const;
2009-10-28 11:48:47 +00:00
/**
* Function SetVisibleAlls
2012-02-06 05:44:19 +00:00
* Set the bit-mask of all visible elements categories,
* including enabled layers
*/
2012-02-06 05:44:19 +00:00
void SetVisibleAlls();
2009-10-28 11:48:47 +00:00
/**
* Function SetVisibleLayers
* changes the bit-mask of visible layers
* @param aMask = The new bit-mask of visible layers
*/
void SetVisibleLayers( LAYER_MSK aMask );
2009-10-28 11:48:47 +00:00
/**
* Function IsLayerVisible
* tests whether a given layer is visible
* @param aLayer = The layer to be tested
2009-10-28 11:48:47 +00:00
* @return bool - true if the layer is visible.
*/
bool IsLayerVisible( LAYER_NUM aLayer ) const
2009-10-28 11:48:47 +00:00
{
// If a layer is disabled, it is automatically invisible
return m_VisibleLayers & m_EnabledLayers & GetLayerMask( aLayer );
2009-10-28 11:48:47 +00:00
}
/**
* Function SetLayerVisibility
* changes the visibility of a given layer
* @param aLayer = The layer to be changed
2009-10-28 11:48:47 +00:00
* @param aNewState = The new visibility state of the layer
*/
void SetLayerVisibility( LAYER_NUM aLayer, bool aNewState );
2009-10-28 11:48:47 +00:00
/**
* Function GetVisibleElements
* returns a bit-mask of all the element categories that are visible
* @return int - the visible element categories in bit-mapped form.
*/
int GetVisibleElements() const
2009-10-28 11:48:47 +00:00
{
return m_VisibleElements;
}
/**
* Function SetVisibleElements
* changes the bit-mask of visible element categories
* @param aMask = The new bit-mask of visible element categories
*/
void SetVisibleElements( int aMask )
2009-10-28 11:48:47 +00:00
{
m_VisibleElements = aMask;
}
/**
* Function IsElementVisible
2010-01-21 20:53:01 +00:00
* tests whether a given element category is visible. Keep this as an
* inline function.
* @param aElementCategory is from the enum by the same name
2009-10-28 11:48:47 +00:00
* @return bool - true if the element is visible.
2010-01-21 20:53:01 +00:00
* @see enum PCB_VISIBLE
2009-10-28 11:48:47 +00:00
*/
bool IsElementVisible( int aElementCategory ) const
2009-10-28 11:48:47 +00:00
{
assert( aElementCategory >= 0 && aElementCategory < END_PCB_VISIBLE_LIST );
return ( m_VisibleElements & ( 1 << aElementCategory ) );
2009-10-28 11:48:47 +00:00
}
/**
* Function SetElementVisibility
* changes the visibility of an element category
* @param aElementCategory is from the enum by the same name
2009-10-28 11:48:47 +00:00
* @param aNewState = The new visibility state of the element category
2010-01-21 20:53:01 +00:00
* @see enum PCB_VISIBLE
2009-10-28 11:48:47 +00:00
*/
void SetElementVisibility( int aElementCategory, bool aNewState );
2009-10-28 11:48:47 +00:00
/**
* Function GetEnabledLayers
* returns a bit-mask of all the layers that are enabled
* @return int - the enabled layers in bit-mapped form.
*/
inline LAYER_MSK GetEnabledLayers() const
2009-10-28 11:48:47 +00:00
{
return m_EnabledLayers;
}
/**
* Function SetEnabledLayers
* changes the bit-mask of enabled layers
* @param aMask = The new bit-mask of enabled layers
*/
void SetEnabledLayers( LAYER_MSK aMask );
2009-10-28 11:48:47 +00:00
/**
* Function IsLayerEnabled
* tests whether a given layer is enabled
* @param aLayer = The of the layer to be tested
2009-10-28 11:48:47 +00:00
* @return bool - true if the layer is enabled
*/
bool IsLayerEnabled( LAYER_NUM aLayer ) const
2009-10-28 11:48:47 +00:00
{
return m_EnabledLayers & GetLayerMask( aLayer );
2009-10-28 11:48:47 +00:00
}
/**
* Function GetCopperLayerCount
* @return int - the number of neabled copper layers
*/
int GetCopperLayerCount() const
2009-10-28 11:48:47 +00:00
{
return m_CopperLayerCount;
}
/**
* Function SetCopperLayerCount
* do what its name says...
* @param aNewLayerCount = The new number of enabled copper layers
*/
void SetCopperLayerCount( int aNewLayerCount );
2012-02-19 04:02:19 +00:00
/**
* Function AppendConfigs
* appends to @a aResult the configuration setting accessors which will later
* allow reading or writing of configuration file information directly into
* this object.
*/
void AppendConfigs( PARAM_CFG_ARRAY* aResult );
2009-10-28 11:48:47 +00:00
int GetBoardThickness() const { return m_boardThickness; }
void SetBoardThickness( int aThickness ) { m_boardThickness = aThickness; }
2012-02-06 05:44:19 +00:00
private:
int m_CopperLayerCount; ///< Number of copper layers for this design
LAYER_MSK m_EnabledLayers; ///< Bit-mask for layer enabling
LAYER_MSK m_VisibleLayers; ///< Bit-mask for layer visibility
int m_VisibleElements; ///< Bit-mask for element category visibility
int m_boardThickness; ///< Board thickness for 3D viewer
2009-10-28 11:48:47 +00:00
};
2012-02-06 07:14:51 +00:00
#endif // BOARD_DESIGN_SETTINGS_H_