KiCad PCB EDA Suite
Loading...
Searching...
No Matches
mpBitmapLayer Class Reference

This virtual class represents objects that can be moved to an arbitrary 2D location+rotation. More...

#include <mathplot.h>

Inheritance diagram for mpBitmapLayer:
mpLayer

Public Member Functions

 mpBitmapLayer ()
 Default constructor. More...
 
virtual ~mpBitmapLayer ()
 
void GetBitmapCopy (wxImage &outBmp) const
 Returns a copy of the current bitmap assigned to the layer. More...
 
void SetBitmap (const wxImage &inBmp, double x, double y, double lx, double ly)
 Change the bitmap associated with the layer (to update the screen, refresh the mpWindow). More...
 
virtual bool HasBBox () const override
 Check whether this layer has a bounding box. More...
 
virtual double GetMinX () const override
 Get inclusive left border of bounding box. More...
 
virtual double GetMaxX () const override
 Get inclusive right border of bounding box. More...
 
virtual double GetMinY () const override
 Get inclusive bottom border of bounding box. More...
 
virtual double GetMaxY () const override
 Get inclusive top border of bounding box. More...
 
virtual void Plot (wxDC &dc, mpWindow &w) override
 Plot given view of layer to the given device context. More...
 
void SetAlign (int align)
 Set label axis alignment. More...
 
virtual bool IsInfo () const
 Check whether the layer is an info box. More...
 
const wxString & GetName () const
 Get layer name. More...
 
const wxString & GetDisplayName () const
 
const wxFont & GetFont () const
 Get font set for this layer. More...
 
const wxPen & GetPen () const
 Get pen set for this layer. More...
 
void SetContinuity (bool continuity)
 Set the 'continuity' property of the layer (true:draws a continuous line, false:draws separate points). More...
 
bool GetContinuity () const
 Gets the 'continuity' property of the layer. More...
 
void ShowName (bool show)
 Shows or hides the text label with the name of the layer (default is visible). More...
 
virtual void SetName (const wxString &name)
 Set layer name. More...
 
void SetFont (wxFont &font)
 Set layer font. More...
 
void SetPen (wxPen pen)
 Set layer pen. More...
 
void SetDrawOutsideMargins (bool drawModeOutside)
 Set Draw mode: inside or outside margins. More...
 
bool GetDrawOutsideMargins ()
 Get Draw mode: inside or outside margins. More...
 
wxBitmap GetColourSquare (int side=16) const
 Get a small square bitmap filled with the colour of the pen used in the layer. More...
 
mpLayerType GetLayerType () const
 Get layer type: a Layer can be of different types: plot lines, axis, info boxes, etc, this method returns the right value. More...
 
bool IsVisible () const
 Checks whether the layer is visible or not. More...
 
void SetVisible (bool show)
 Sets layer visibility. More...
 
const wxBrush & GetBrush () const
 Get brush set for this layer. More...
 
void SetBrush (wxBrush brush)
 Set layer brush. More...
 

Protected Attributes

int m_flags
 
wxImage m_bitmap
 The internal copy of the Bitmap: More...
 
wxBitmap m_scaledBitmap
 
wxCoord m_scaledBitmap_offset_x
 
wxCoord m_scaledBitmap_offset_y
 
bool m_validImg
 
double m_min_x
 The shape of the bitmap: More...
 
double m_max_x
 
double m_min_y
 
double m_max_y
 
wxFont m_font
 
wxPen m_pen
 
wxBrush m_brush
 
wxString m_name
 
wxString m_displayName
 
bool m_continuous
 
bool m_showName
 
bool m_drawOutsideMargins
 
mpLayerType m_type
 
bool m_visible
 

Detailed Description

This virtual class represents objects that can be moved to an arbitrary 2D location+rotation.

The current transformation is set through SetCoordinateBase. To ease the implementation of descendent classes, mpMovableObject will be in charge of Bounding Box computation and layer render, assuming that the object updates its shape in m_shape_xs & m_shape_ys.

Definition at line 1968 of file mathplot.h.

Constructor & Destructor Documentation

◆ mpBitmapLayer()

mpBitmapLayer::mpBitmapLayer ( )
inline

Default constructor.

Definition at line 1973 of file mathplot.h.

References mpLAYER_BITMAP.

◆ ~mpBitmapLayer()

virtual mpBitmapLayer::~mpBitmapLayer ( )
inlinevirtual

Definition at line 1983 of file mathplot.h.

Member Function Documentation

◆ GetBitmapCopy()

void mpBitmapLayer::GetBitmapCopy ( wxImage &  outBmp) const

Returns a copy of the current bitmap assigned to the layer.

Definition at line 3421 of file mathplot.cpp.

References m_bitmap, and m_validImg.

◆ GetBrush()

const wxBrush & mpLayer::GetBrush ( ) const
inlineinherited

Get brush set for this layer.

Returns
brush.

Definition at line 315 of file mathplot.h.

◆ GetColourSquare()

wxBitmap mpLayer::GetColourSquare ( int  side = 16) const
inherited

Get a small square bitmap filled with the colour of the pen used in the layer.

Useful to create legends or similar reference to the layers.

Parameters
sideside length in pixels
Returns
a wxBitmap filled with layer's colour

Definition at line 76 of file mathplot.cpp.

References mpLayer::m_pen, and square().

◆ GetContinuity()

bool mpLayer::GetContinuity ( ) const
inlineinherited

Gets the 'continuity' property of the layer.

See also
SetContinuity

Definition at line 267 of file mathplot.h.

◆ GetDisplayName()

const wxString & mpLayer::GetDisplayName ( ) const
inlineinherited

Definition at line 244 of file mathplot.h.

Referenced by mpInfoLegend::Plot().

◆ GetDrawOutsideMargins()

bool mpLayer::GetDrawOutsideMargins ( )
inlineinherited

Get Draw mode: inside or outside margins.

Returns
The draw mode

Definition at line 294 of file mathplot.h.

◆ GetFont()

const wxFont & mpLayer::GetFont ( ) const
inlineinherited

Get font set for this layer.

Returns
Font

Definition at line 252 of file mathplot.h.

◆ GetLayerType()

mpLayerType mpLayer::GetLayerType ( ) const
inlineinherited

Get layer type: a Layer can be of different types: plot lines, axis, info boxes, etc, this method returns the right value.

Returns
An integer indicating layer type

Definition at line 303 of file mathplot.h.

Referenced by mpInfoLegend::Plot().

◆ GetMaxX()

virtual double mpBitmapLayer::GetMaxX ( ) const
inlineoverridevirtual

Get inclusive right border of bounding box.

Reimplemented from mpLayer.

Definition at line 2006 of file mathplot.h.

◆ GetMaxY()

virtual double mpBitmapLayer::GetMaxY ( ) const
inlineoverridevirtual

Get inclusive top border of bounding box.

Reimplemented from mpLayer.

Definition at line 2014 of file mathplot.h.

◆ GetMinX()

virtual double mpBitmapLayer::GetMinX ( ) const
inlineoverridevirtual

Get inclusive left border of bounding box.

Reimplemented from mpLayer.

Definition at line 2002 of file mathplot.h.

◆ GetMinY()

virtual double mpBitmapLayer::GetMinY ( ) const
inlineoverridevirtual

Get inclusive bottom border of bounding box.

Reimplemented from mpLayer.

Definition at line 2010 of file mathplot.h.

◆ GetName()

const wxString & mpLayer::GetName ( ) const
inlineinherited

◆ GetPen()

const wxPen & mpLayer::GetPen ( ) const
inlineinherited

Get pen set for this layer.

Returns
Pen

Definition at line 257 of file mathplot.h.

Referenced by CURSOR::Plot(), mpInfoLegend::Plot(), and SIMULATOR_FRAME::rebuildSignalsGrid().

◆ HasBBox()

virtual bool mpBitmapLayer::HasBBox ( ) const
inlineoverridevirtual

Check whether this layer has a bounding box.

The default implementation returns true. Override and return false if your mpLayer implementation should be ignored by the calculation of the global bounding box for all layers in a mpWindow.

Return values
trueHas bounding box
falseHas not bounding box

Reimplemented from mpLayer.

Definition at line 1998 of file mathplot.h.

Referenced by Plot().

◆ IsInfo()

virtual bool mpLayer::IsInfo ( ) const
inlinevirtualinherited

Check whether the layer is an info box.

The default implementation returns false. It is overridden to true for mpInfoLayer class and its derivative. It is necessary to define mouse actions behaviour over info boxes.

Returns
whether the layer is an info boxes
See also
mpInfoLayer::IsInfo

Reimplemented in mpInfoLayer.

Definition at line 174 of file mathplot.h.

◆ IsVisible()

bool mpLayer::IsVisible ( ) const
inlineinherited

Checks whether the layer is visible or not.

Returns
true if visible

Definition at line 307 of file mathplot.h.

Referenced by mpWindow::IsLayerVisible(), SIM_PLOT_PANEL::IsLegendShown(), and mpInfoLegend::Plot().

◆ Plot()

void mpBitmapLayer::Plot ( wxDC &  dc,
mpWindow w 
)
overridevirtual

Plot given view of layer to the given device context.

An implementation of this function has to transform layer coordinates to wxDC coordinates based on the view parameters retrievable from the mpWindow passed in w. Note that the public methods of mpWindow: x2p,y2p and p2x,p2y are already provided which transform layer coordinates to DC pixel coordinates, and user code should rely on them for portability and future changes to be applied transparently, instead of implementing the following formulas manually.

The passed device context dc has its coordinate origin set to the top-left corner of the visible area (the default). The coordinate orientation is as shown in the following picture:

(wxDC origin 0,0)
x-------------> ascending X ----------------+
|                                           |
|                                           |
|  V ascending Y                            |
|                                           |
|                                           |
|                                           |
|+------------------------------------------+  <-- right-bottom corner of the mpWindow visible area.

Note that Y ascends in downward direction, whereas the usual vertical orientation for mathematical plots is vice versa. Thus Y-orientation will be swapped usually, when transforming between wxDC and mpLayer coordinates. This change of coordinates is taken into account in the methods p2x,p2y,x2p,y2p.

Rules for transformation between mpLayer and wxDC coordinates

dc_X = (layer_X - mpWindow::GetPosX()) * mpWindow::GetScaleX()
dc_Y = (mpWindow::GetPosY() - layer_Y) * mpWindow::GetScaleY() // swapping Y-orientation
layer_X = (dc_X / mpWindow::GetScaleX()) + mpWindow::GetPosX() // scale guaranteed to be not 0
layer_Y = mpWindow::GetPosY() - (dc_Y / mpWindow::GetScaleY()) // swapping Y-orientation
double GetPosY(void) const
Definition: mathplot.h:1143
double GetScaleX(void) const
Definition: mathplot.h:1122
double GetScaleY(void) const
Definition: mathplot.h:1129
double GetPosX(void) const
Definition: mathplot.h:1136
Parameters
dcDevice context to plot to.
wView to plot. The visible area can be retrieved from this object.
See also
mpWindow::p2x,mpWindow::p2y,mpWindow::x2p,mpWindow::y2p

Implements mpLayer.

Definition at line 3442 of file mathplot.cpp.

References mpWindow::GetPosX(), mpWindow::GetPosY(), mpWindow::GetScaleX(), mpWindow::GetScaleY(), mpWindow::GetScrX(), mpWindow::GetScrY(), HasBBox(), m_bitmap, m_flags, mpLayer::m_font, m_max_x, m_max_y, m_min_x, m_min_y, mpLayer::m_name, m_scaledBitmap, m_scaledBitmap_offset_x, m_scaledBitmap_offset_y, mpLayer::m_showName, m_validImg, mpLayer::m_visible, mpALIGN_NE, mpALIGN_NW, mpALIGN_SW, mpALIGNMASK, mpWindow::x2p(), and mpWindow::y2p().

◆ SetAlign()

void mpBitmapLayer::SetAlign ( int  align)
inline

Set label axis alignment.

Parameters
alignalignment (choose between mpALIGN_NE, mpALIGN_NW, mpALIGN_SW, mpALIGN_SE

Definition at line 2021 of file mathplot.h.

◆ SetBitmap()

void mpBitmapLayer::SetBitmap ( const wxImage &  inBmp,
double  x,
double  y,
double  lx,
double  ly 
)

Change the bitmap associated with the layer (to update the screen, refresh the mpWindow).

Parameters
inBmpThe bitmap to associate. A copy is made, thus it can be released after calling this.
xThe left corner X coordinate (in plot units).
yThe top corner Y coordinate (in plot units).
lxThe width in plot units.
lyThe height in plot units.

Definition at line 3428 of file mathplot.cpp.

References m_bitmap, m_max_x, m_max_y, m_min_x, m_min_y, and m_validImg.

◆ SetBrush()

void mpLayer::SetBrush ( wxBrush  brush)
inlineinherited

Set layer brush.

Parameters
brushbrush, will be copied to internal class member

Definition at line 319 of file mathplot.h.

◆ SetContinuity()

void mpLayer::SetContinuity ( bool  continuity)
inlineinherited

Set the 'continuity' property of the layer (true:draws a continuous line, false:draws separate points).

See also
GetContinuity

Definition at line 262 of file mathplot.h.

Referenced by TRACE::TRACE().

◆ SetDrawOutsideMargins()

void mpLayer::SetDrawOutsideMargins ( bool  drawModeOutside)
inlineinherited

Set Draw mode: inside or outside margins.

Default is outside, which allows the layer to draw up to the mpWindow border.

Parameters
drawModeOutsideThe draw mode to be set

Definition at line 290 of file mathplot.h.

Referenced by CURSOR::CURSOR(), and TRACE::TRACE().

◆ SetFont()

void mpLayer::SetFont ( wxFont &  font)
inlineinherited

Set layer font.

Parameters
fontFont, will be copied to internal class member

Definition at line 281 of file mathplot.h.

◆ SetName()

virtual void mpLayer::SetName ( const wxString &  name)
inlinevirtualinherited

Set layer name.

Parameters
nameName, will be copied to internal class member

Reimplemented in TRACE.

Definition at line 276 of file mathplot.h.

References name.

Referenced by SIM_PLOT_PANEL::prepareDCAxes(), TRACE::SetName(), and SIM_PLOT_PANEL::updateAxes().

◆ SetPen()

void mpLayer::SetPen ( wxPen  pen)
inlineinherited

Set layer pen.

Parameters
penPen, will be copied to internal class member

Definition at line 286 of file mathplot.h.

Referenced by SIM_PLOT_PANEL::UpdateTraceStyle().

◆ SetVisible()

void mpLayer::SetVisible ( bool  show)
inlineinherited

Sets layer visibility.

Parameters
showvisibility bool.

Definition at line 311 of file mathplot.h.

Referenced by mpWindow::SetLayerVisible(), SIM_PLOT_PANEL::ShowLegend(), and SIM_PLOT_PANEL::SIM_PLOT_PANEL().

◆ ShowName()

void mpLayer::ShowName ( bool  show)
inlineinherited

Shows or hides the text label with the name of the layer (default is visible).

Definition at line 271 of file mathplot.h.

Referenced by TRACE::TRACE().

Member Data Documentation

◆ m_bitmap

wxImage mpBitmapLayer::m_bitmap
protected

The internal copy of the Bitmap:

Definition at line 2028 of file mathplot.h.

Referenced by GetBitmapCopy(), Plot(), and SetBitmap().

◆ m_brush

wxBrush mpLayer::m_brush
protectedinherited

Definition at line 325 of file mathplot.h.

◆ m_continuous

bool mpLayer::m_continuous
protectedinherited

Definition at line 328 of file mathplot.h.

Referenced by CURSOR::Plot(), mpFXY::Plot(), and mpMovableObject::Plot().

◆ m_displayName

wxString mpLayer::m_displayName
protectedinherited

Definition at line 327 of file mathplot.h.

Referenced by TRACE::SetName().

◆ m_drawOutsideMargins

◆ m_flags

int mpBitmapLayer::m_flags
protected

Definition at line 2024 of file mathplot.h.

Referenced by Plot().

◆ m_font

◆ m_max_x

double mpBitmapLayer::m_max_x
protected

Definition at line 2036 of file mathplot.h.

Referenced by Plot(), and SetBitmap().

◆ m_max_y

double mpBitmapLayer::m_max_y
protected

Definition at line 2036 of file mathplot.h.

Referenced by Plot(), and SetBitmap().

◆ m_min_x

double mpBitmapLayer::m_min_x
protected

The shape of the bitmap:

Definition at line 2036 of file mathplot.h.

Referenced by Plot(), and SetBitmap().

◆ m_min_y

double mpBitmapLayer::m_min_y
protected

Definition at line 2036 of file mathplot.h.

Referenced by Plot(), and SetBitmap().

◆ m_name

wxString mpLayer::m_name
protectedinherited

◆ m_pen

◆ m_scaledBitmap

wxBitmap mpBitmapLayer::m_scaledBitmap
protected

Definition at line 2029 of file mathplot.h.

Referenced by Plot().

◆ m_scaledBitmap_offset_x

wxCoord mpBitmapLayer::m_scaledBitmap_offset_x
protected

Definition at line 2030 of file mathplot.h.

Referenced by Plot().

◆ m_scaledBitmap_offset_y

wxCoord mpBitmapLayer::m_scaledBitmap_offset_y
protected

Definition at line 2030 of file mathplot.h.

Referenced by Plot().

◆ m_showName

bool mpLayer::m_showName
protectedinherited

Definition at line 329 of file mathplot.h.

Referenced by mpFX::Plot(), mpFY::Plot(), mpFXY::Plot(), mpMovableObject::Plot(), and Plot().

◆ m_type

mpLayerType mpLayer::m_type
protectedinherited

Definition at line 331 of file mathplot.h.

Referenced by mpInfoLayer::mpInfoLayer().

◆ m_validImg

bool mpBitmapLayer::m_validImg
protected

Definition at line 2032 of file mathplot.h.

Referenced by GetBitmapCopy(), Plot(), and SetBitmap().

◆ m_visible


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