PCB_LAYER_PRESENTATION Class Reference

Class that manages the presentation of PCB layers in a PCB frame. More...

#include <pcb_layer_presentation.h>

Inheritance diagram for PCB_LAYER_PRESENTATION:

Public Member Functions
	PCB_LAYER_PRESENTATION (PCB_BASE_FRAME *aFrame)
COLOR4D	getLayerColor (int aLayer) const override
wxString	getLayerName (int aLayer) const override
LSEQ	getOrderedEnabledLayers () const
void	SetBoardFrame (PCB_BASE_FRAME *aFrame)
	Annoying post-ctor initialization (for when PCB_LAYER_BOX_SELECTOR doesn't have access to the PCB_BASE_FRAME at construction time).
wxString	getLayerPairName (const LAYER_PAIR &aPair) const
void	DrawColorSwatch (wxBitmap &aLayerbmp, int aLayer) const
	Fill the layer bitmap aLayerbmp with the layer color for the layer ID.
std::unique_ptr< wxBitmap >	CreateLayerPairIcon (int aLeftLayer, int aRightLayer, int aScale) const
	Create a layer pair "side-by-side swatch" icon for the given layer pair with the style of this presentation.

Static Public Member Functions
static void	DrawColorSwatch (wxBitmap &aLayerbmp, const COLOR4D &aBackground, const COLOR4D &aColor)
static std::unique_ptr< wxBitmap >	CreateLayerPairIcon (const KIGFX::COLOR4D &aBgColor, const KIGFX::COLOR4D &aTopColor, const KIGFX::COLOR4D &aBottomColor, int aScale)
	Create a layer pair "side-by-side swatch" icon.

Private Attributes
PCB_BASE_FRAME *	m_boardFrame

Detailed Description

Class that manages the presentation of PCB layers in a PCB frame.

Definition at line 36 of file pcb_layer_presentation.h.

Constructor & Destructor Documentation

PCB_LAYER_PRESENTATION()

PCB_LAYER_PRESENTATION::PCB_LAYER_PRESENTATION

(

PCB_BASE_FRAME *

aFrame

)

Definition at line 57 of file sel_layer.cpp.

References m_boardFrame.

Member Function Documentation

CreateLayerPairIcon() [1/2]

std::unique_ptr< wxBitmap > LAYER_PRESENTATION::CreateLayerPairIcon ( const KIGFX::COLOR4D & aBgColor, const KIGFX::COLOR4D & aTopColor, const KIGFX::COLOR4D & aBottomColor, int aScale )

staticinherited

Create a layer pair "side-by-side swatch" icon.

Definition at line 109 of file layer_presentation.cpp.

References BM_LAYERICON_SIZE, ICON_BLACK, ICON_WHITE, image, s_BitmapLayerIcon, KIGFX::COLOR4D::ToColour(), and KIGFX::COLOR4D::WithAlpha().

Referenced by CreateLayerPairIcon(), and PCB_EDIT_FRAME::PrepareLayerIndicator().

CreateLayerPairIcon() [2/2]

std::unique_ptr< wxBitmap > LAYER_PRESENTATION::CreateLayerPairIcon ( int aLeftLayer, int aRightLayer, int aScale ) const

inherited

Create a layer pair "side-by-side swatch" icon for the given layer pair with the style of this presentation.

Definition at line 166 of file layer_presentation.cpp.

References CreateLayerPairIcon(), getLayerColor(), and LAYER_PCB_BACKGROUND.

DrawColorSwatch() [1/2]

void LAYER_PRESENTATION::DrawColorSwatch ( wxBitmap & aLayerbmp, const COLOR4D & aBackground, const COLOR4D & aColor )

staticinherited

Definition at line 35 of file layer_presentation.cpp.

References KIGFX::COLOR4D::ToColour(), COLOR4D::UNSPECIFIED, and KIGFX::COLOR4D::WithAlpha().

Referenced by PANEL_SETUP_BOARD_STACKUP::createColorBox(), GRID_CELL_LAYER_RENDERER::Draw(), DrawColorSwatch(), PANEL_SETUP_BOARD_STACKUP::onColorSelected(), and PANEL_SETUP_BOARD_STACKUP::synchronizeWithBoard().

DrawColorSwatch() [2/2]

void LAYER_PRESENTATION::DrawColorSwatch ( wxBitmap & aLayerbmp, int aLayer ) const

inherited

Fill the layer bitmap aLayerbmp with the layer color for the layer ID.

Definition at line 64 of file layer_presentation.cpp.

References color, DrawColorSwatch(), getLayerColor(), and LAYER_PCB_BACKGROUND.

getLayerColor()

COLOR4D PCB_LAYER_PRESENTATION::getLayerColor ( int aLayer ) const

overridevirtual

Implements LAYER_PRESENTATION.

Definition at line 61 of file sel_layer.cpp.

References DEFAULT_THEME, GetAppSettings(), COLOR_SETTINGS::GetColor(), GetColorSettings(), m_boardFrame, and APP_SETTINGS_BASE::m_ColorTheme.

getLayerName()

wxString PCB_LAYER_PRESENTATION::getLayerName ( int aLayer ) const

overridevirtual

Implements LAYER_PRESENTATION.

Definition at line 76 of file sel_layer.cpp.

References BOARD::GetStandardLayerName(), m_boardFrame, and ToLAYER_ID().

Referenced by getLayerPairName().

getLayerPairName()

wxString PCB_LAYER_PRESENTATION::getLayerPairName

(

const LAYER_PAIR &

aPair

)

const

Definition at line 89 of file sel_layer.cpp.

References LAYER_PAIR::GetLayerA(), LAYER_PAIR::GetLayerB(), and getLayerName().

Referenced by PCB_CONTROL::LayerPresetFeedback().

getOrderedEnabledLayers()

LSEQ PCB_LAYER_PRESENTATION::getOrderedEnabledLayers

(

)

const

Definition at line 84 of file sel_layer.cpp.

References m_boardFrame.

SetBoardFrame()

void PCB_LAYER_PRESENTATION::SetBoardFrame ( PCB_BASE_FRAME * aFrame )

inline

Annoying post-ctor initialization (for when PCB_LAYER_BOX_SELECTOR doesn't have access to the PCB_BASE_FRAME at construction time).

Definition at line 51 of file pcb_layer_presentation.h.

References m_boardFrame.

Member Data Documentation

m_boardFrame

PCB_BASE_FRAME* PCB_LAYER_PRESENTATION::m_boardFrame

private

Definition at line 56 of file pcb_layer_presentation.h.

Referenced by getLayerColor(), getLayerName(), getOrderedEnabledLayers(), PCB_LAYER_PRESENTATION(), and SetBoardFrame().

---

The documentation for this class was generated from the following files:

• pcb_layer_presentation.h
• sel_layer.cpp