204 lines
7.1 KiB
C++
204 lines
7.1 KiB
C++
/**********************************************************/
|
|
/* class_board_design_settings.h : handle board options */
|
|
/**********************************************************/
|
|
|
|
#ifndef BOARD_DESIGN_SETTINGS_H_
|
|
#define BOARD_DESIGN_SETTINGS_H_
|
|
|
|
#include <pcbstruct.h> // NB_COLORS
|
|
#include <class_pad.h>
|
|
#include <config_params.h>
|
|
|
|
|
|
/**
|
|
* Class BOARD_DESIGN_SETTINGS
|
|
* contains design settings for a BOARD object.
|
|
*/
|
|
class BOARD_DESIGN_SETTINGS
|
|
{
|
|
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)
|
|
|
|
/// 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
|
|
|
|
D_PAD m_Pad_Master;
|
|
|
|
public:
|
|
BOARD_DESIGN_SETTINGS();
|
|
|
|
/**
|
|
* 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;
|
|
|
|
/**
|
|
* Function SetVisibleAlls
|
|
* Set the bit-mask of all visible elements categories,
|
|
* including enabled layers
|
|
*/
|
|
void SetVisibleAlls();
|
|
|
|
/**
|
|
* Function SetVisibleLayers
|
|
* changes the bit-mask of visible layers
|
|
* @param aMask = The new bit-mask of visible layers
|
|
*/
|
|
void SetVisibleLayers( LAYER_MSK aMask );
|
|
|
|
/**
|
|
* Function IsLayerVisible
|
|
* tests whether a given layer is visible
|
|
* @param aLayer = The layer to be tested
|
|
* @return bool - true if the layer is visible.
|
|
*/
|
|
bool IsLayerVisible( LAYER_NUM aLayer ) const
|
|
{
|
|
// If a layer is disabled, it is automatically invisible
|
|
return m_VisibleLayers & m_EnabledLayers & GetLayerMask( aLayer );
|
|
}
|
|
|
|
/**
|
|
* Function SetLayerVisibility
|
|
* changes the visibility of a given layer
|
|
* @param aLayer = The layer to be changed
|
|
* @param aNewState = The new visibility state of the layer
|
|
*/
|
|
void SetLayerVisibility( LAYER_NUM aLayer, bool aNewState );
|
|
|
|
/**
|
|
* 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
|
|
{
|
|
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 )
|
|
{
|
|
m_VisibleElements = aMask;
|
|
}
|
|
|
|
/**
|
|
* Function IsElementVisible
|
|
* tests whether a given element category is visible. Keep this as an
|
|
* inline function.
|
|
* @param aPCB_VISIBLE is from the enum by the same name
|
|
* @return bool - true if the element is visible.
|
|
* @see enum PCB_VISIBLE
|
|
*/
|
|
bool IsElementVisible( int aPCB_VISIBLE ) const
|
|
{
|
|
return bool( m_VisibleElements & (1 << aPCB_VISIBLE) );
|
|
}
|
|
|
|
/**
|
|
* Function SetElementVisibility
|
|
* changes the visibility of an element category
|
|
* @param aPCB_VISIBLE is from the enum by the same name
|
|
* @param aNewState = The new visibility state of the element category
|
|
* @see enum PCB_VISIBLE
|
|
*/
|
|
void SetElementVisibility( int aPCB_VISIBLE, bool aNewState );
|
|
|
|
/**
|
|
* 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
|
|
{
|
|
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 );
|
|
|
|
/**
|
|
* Function IsLayerEnabled
|
|
* tests whether a given layer is enabled
|
|
* @param aLayer = The of the layer to be tested
|
|
* @return bool - true if the layer is enabled
|
|
*/
|
|
bool IsLayerEnabled( LAYER_NUM aLayer ) const
|
|
{
|
|
return m_EnabledLayers & GetLayerMask( aLayer );
|
|
}
|
|
|
|
/**
|
|
* Function GetCopperLayerCount
|
|
* @return int - the number of neabled copper layers
|
|
*/
|
|
int GetCopperLayerCount() const
|
|
{
|
|
return m_CopperLayerCount;
|
|
}
|
|
|
|
/**
|
|
* Function SetCopperLayerCount
|
|
* do what its name says...
|
|
* @param aNewLayerCount = The new number of enabled copper layers
|
|
*/
|
|
void SetCopperLayerCount( int aNewLayerCount );
|
|
|
|
/**
|
|
* 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 );
|
|
|
|
int GetBoardThickness() const { return m_boardThickness; }
|
|
void SetBoardThickness( int aThickness ) { m_boardThickness = aThickness; }
|
|
|
|
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
|
|
};
|
|
|
|
#endif // BOARD_DESIGN_SETTINGS_H_
|