mpInfoCoords Class Reference

Detailed Description

Implements an overlay box which shows the mouse coordinates in plot units.

When an mpInfoCoords layer is activated, when mouse is moved over the mpWindow, its coordinates (in mpWindow units, not pixels) are continuously reported inside the layer box.

Definition at line 413 of file mathplot.h.

#include <mrpt/otherlibs/mathplot/mathplot.h>

Inheritance diagram for mpInfoCoords:

Public Member Functions
	mpInfoCoords ()
	Default constructor.
	mpInfoCoords (wxRect rect, const wxBrush *brush=wxTRANSPARENT_BRUSH)
	Complete constructor, setting initial rectangle and background brush.
	~mpInfoCoords ()
	Default destructor.
virtual void	UpdateInfo (mpWindow &w, wxEvent &event)
	Updates the content of the info box.
virtual void	Plot (wxDC &dc, mpWindow &w)
	Plot method.
virtual bool	HasBBox ()
	mpInfoLayer has not bounding box.
virtual bool	IsInfo ()
	Specifies that this is an Info box layer.
virtual bool	Inside (wxPoint &point)
	Checks whether a point is inside the info box rectangle.
virtual void	Move (wxPoint delta)
	Moves the layer rectangle of given pixel deltas.
virtual void	UpdateReference ()
	Updates the rectangle reference point.
wxPoint	GetPosition ()
	Returns the position of the upper left corner of the box (in pixels)
wxSize	GetSize ()
	Returns the size of the box (in pixels)
const wxRect &	GetRectangle ()
	Returns the current rectangle coordinates.
virtual double	GetMinX ()
	Get inclusive left border of bounding box.
virtual double	GetMaxX ()
	Get inclusive right border of bounding box.
virtual double	GetMinY ()
	Get inclusive bottom border of bounding box.
virtual double	GetMaxY ()
	Get inclusive top border of bounding box.
wxString	GetName () const
	Get layer name.
const wxFont &	GetFont () const
	Get font set for this layer.
const wxPen &	GetPen () const
	Get pen set for this layer.
void	SetContinuity (bool continuity)
	Set the 'continuity' property of the layer (true:draws a continuous line, false:draws separate points).
bool	GetContinuity () const
	Gets the 'continuity' property of the layer.
void	ShowName (bool show)
	Shows or hides the text label with the name of the layer (default is visible).
void	SetName (wxString name)
	Set layer name.
void	SetFont (wxFont &font)
	Set layer font.
void	SetPen (wxPen pen)
	Set layer pen.
void	SetDrawOutsideMargins (bool drawModeOutside)
	Set Draw mode: inside or outside margins.
bool	GetDrawOutsideMargins ()
	Get Draw mode: inside or outside margins.
wxBitmap	GetColourSquare (int side=16)
	Get a small square bitmap filled with the colour of the pen used in the layer.
mpLayerType	GetLayerType ()
	Get layer type: a Layer can be of different types: plot lines, axis, info boxes, etc, this method returns the right value.
bool	IsVisible ()
	Checks whether the layer is visible or not.
void	SetVisible (bool show)
	Sets layer visibility.
const wxBrush &	GetBrush () const
	Get brush set for this layer.
void	SetBrush (wxBrush brush)
	Set layer brush.

Protected Attributes
wxString	m_content
	string holding the coordinates to be drawn.
wxRect	m_dim
	The bounding rectangle of the box. It may be resized dynamically by the Plot method.
wxPoint	m_reference
	Holds the reference point for movements.
wxBrush	m_brush
	The brush to be used for the background.
int	m_winX
int	m_winY
	Holds the mpWindow size. Used to rescale position when window is resized.
wxFont	m_font
	Layer's font.
wxPen	m_pen
	Layer's pen.
wxString	m_name
	Layer's name.
bool	m_continuous
	Specify if the layer will be plotted as a continuous line or a set of points.
bool	m_showName
	States whether the name of the layer must be shown (default is true).
bool	m_drawOutsideMargins
	select if the layer should draw only inside margins or over all DC
mpLayerType	m_type
	Define layer type, which is assigned by constructor.
bool	m_visible
	Toggles layer visibility.

Constructor & Destructor Documentation

mpInfoCoords::mpInfoCoords

(

)

Default constructor.

mpInfoCoords::mpInfoCoords	(	wxRect	rect,
		const wxBrush *	brush = wxTRANSPARENT_BRUSH
	)

Complete constructor, setting initial rectangle and background brush.

Parameters

rect	The initial bounding rectangle.
brush	The wxBrush to be used for box background: default is transparent

mpInfoCoords::~mpInfoCoords

(

)

Default destructor.

Member Function Documentation

const wxBrush& mpLayer::GetBrush ( ) const

inlineinherited

Get brush set for this layer.

Returns

brush.

Definition at line 314 of file mathplot.h.

wxBitmap mpLayer::GetColourSquare ( int  side = 16 )

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

side	side length in pixels

Returns

a wxBitmap filled with layer's colour

bool mpLayer::GetContinuity ( ) const

inlineinherited

Gets the 'continuity' property of the layer.

See Also

SetContinuity

Definition at line 266 of file mathplot.h.

bool mpLayer::GetDrawOutsideMargins ( )

inlineinherited

Get Draw mode: inside or outside margins.

Returns

The draw mode

Definition at line 293 of file mathplot.h.

const wxFont& mpLayer::GetFont ( ) const

inlineinherited

Get font set for this layer.

Returns

Font

Definition at line 251 of file mathplot.h.

mpLayerType mpLayer::GetLayerType ( )

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 302 of file mathplot.h.

virtual double mpLayer::GetMaxX ( )

inlinevirtualinherited

Get inclusive right border of bounding box.

Returns

Value

Reimplemented in mpBitmapLayer, mpMovableObject, and mpFXYVector.

Definition at line 188 of file mathplot.h.

virtual double mpLayer::GetMaxY ( )

inlinevirtualinherited

Get inclusive top border of bounding box.

Returns

Value

Reimplemented in mpBitmapLayer, mpMovableObject, and mpFXYVector.

Definition at line 198 of file mathplot.h.

virtual double mpLayer::GetMinX ( )

inlinevirtualinherited

Get inclusive left border of bounding box.

Returns

Value

Reimplemented in mpBitmapLayer, mpMovableObject, and mpFXYVector.

Definition at line 183 of file mathplot.h.

virtual double mpLayer::GetMinY ( )

inlinevirtualinherited

Get inclusive bottom border of bounding box.

Returns

Value

Reimplemented in mpBitmapLayer, mpMovableObject, and mpFXYVector.

Definition at line 193 of file mathplot.h.

wxString mpLayer::GetName ( ) const

inlineinherited

Get layer name.

Returns

Name

Definition at line 246 of file mathplot.h.

const wxPen& mpLayer::GetPen ( ) const

inlineinherited

Get pen set for this layer.

Returns

Pen

Definition at line 256 of file mathplot.h.

wxPoint mpInfoLayer::GetPosition ( )

inherited

Returns the position of the upper left corner of the box (in pixels)

Returns

The rectangle position

const wxRect& mpInfoLayer::GetRectangle ( )

inlineinherited

Returns the current rectangle coordinates.

Returns

The info layer rectangle

Definition at line 399 of file mathplot.h.

wxSize mpInfoLayer::GetSize ( )

inherited

Returns the size of the box (in pixels)

Returns

The rectangle size

virtual bool mpInfoLayer::HasBBox ( )

inlinevirtualinherited

mpInfoLayer has not bounding box.

See Also

mpLayer::HasBBox

Returns

always FALSE

Reimplemented from mpLayer.

Definition at line 364 of file mathplot.h.

virtual bool mpInfoLayer::Inside ( wxPoint &  point )

virtualinherited

Checks whether a point is inside the info box rectangle.

Parameters

point

The point to be checked

Returns

true if the point is inside the bounding box

virtual bool mpInfoLayer::IsInfo ( )

inlinevirtualinherited

Specifies that this is an Info box layer.

Returns

always TRUE

See Also

mpLayer::IsInfo

Reimplemented from mpLayer.

Definition at line 375 of file mathplot.h.

bool mpLayer::IsVisible ( )

inlineinherited

Checks whether the layer is visible or not.

Returns

true if visible

Definition at line 306 of file mathplot.h.

virtual void mpInfoLayer::Move ( wxPoint  delta )

virtualinherited

Moves the layer rectangle of given pixel deltas.

Parameters

delta

The wxPoint container for delta coordinates along x and y. Units are in pixels.

virtual void mpInfoCoords::Plot ( wxDC &  dc, mpWindow &  w  )

virtual

Plot method.

Parameters

dc	the device content where to plot
w	the window to plot

See Also

mpLayer::Plot

Reimplemented from mpInfoLayer.

void mpLayer::SetBrush ( wxBrush  brush )

inlineinherited

Set layer brush.

Parameters

brush

brush, will be copied to internal class member

Definition at line 318 of file mathplot.h.

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 261 of file mathplot.h.

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

drawModeOutside

The draw mode to be set

Definition at line 289 of file mathplot.h.

void mpLayer::SetFont ( wxFont &  font )

inlineinherited

Set layer font.

Parameters

font	Font, will be copied to internal class member

Definition at line 280 of file mathplot.h.

void mpLayer::SetName ( wxString  name )

inlineinherited

Set layer name.

Parameters

name	Name, will be copied to internal class member

Definition at line 275 of file mathplot.h.

void mpLayer::SetPen ( wxPen  pen )

inlineinherited

Set layer pen.

Parameters

pen	Pen, will be copied to internal class member

Definition at line 285 of file mathplot.h.

void mpLayer::SetVisible ( bool  show )

inlineinherited

Sets layer visibility.

Parameters

show	visibility bool.

Definition at line 310 of file mathplot.h.

void mpLayer::ShowName ( bool  show )

inlineinherited

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

Definition at line 270 of file mathplot.h.

virtual void mpInfoCoords::UpdateInfo ( mpWindow &  w, wxEvent &  event  )

virtual

Updates the content of the info box.

It is used to update coordinates.

Parameters

w	parent mpWindow from which to obtain information
event	The event which called the update.

Reimplemented from mpInfoLayer.

virtual void mpInfoLayer::UpdateReference ( )

virtualinherited

Updates the rectangle reference point.

Used by internal methods of mpWindow to correctly move mpInfoLayers.

Member Data Documentation

wxBrush mpInfoLayer::m_brush

protectedinherited

The brush to be used for the background.

Definition at line 404 of file mathplot.h.

wxString mpInfoCoords::m_content

protected

string holding the coordinates to be drawn.

Definition at line 438 of file mathplot.h.

bool mpLayer::m_continuous

protectedinherited

Specify if the layer will be plotted as a continuous line or a set of points.

Definition at line 325 of file mathplot.h.

wxRect mpInfoLayer::m_dim

protectedinherited

The bounding rectangle of the box. It may be resized dynamically by the Plot method.

Definition at line 399 of file mathplot.h.

bool mpLayer::m_drawOutsideMargins

protectedinherited

select if the layer should draw only inside margins or over all DC

Definition at line 327 of file mathplot.h.

wxFont mpLayer::m_font

protectedinherited

Layer's font.

Definition at line 318 of file mathplot.h.

wxString mpLayer::m_name

protectedinherited

Layer's name.

Definition at line 324 of file mathplot.h.

wxPen mpLayer::m_pen

protectedinherited

Layer's pen.

Definition at line 322 of file mathplot.h.

wxPoint mpInfoLayer::m_reference

protectedinherited

Holds the reference point for movements.

Definition at line 403 of file mathplot.h.

bool mpLayer::m_showName

protectedinherited

States whether the name of the layer must be shown (default is true).

Definition at line 326 of file mathplot.h.

mpLayerType mpLayer::m_type

protectedinherited

Define layer type, which is assigned by constructor.

Definition at line 328 of file mathplot.h.

bool mpLayer::m_visible

protectedinherited

Toggles layer visibility.

Definition at line 329 of file mathplot.h.

int mpInfoLayer::m_winX

protectedinherited

Definition at line 405 of file mathplot.h.

int mpInfoLayer::m_winY

protectedinherited

Holds the mpWindow size. Used to rescale position when window is resized.

Definition at line 405 of file mathplot.h.