mpFXY Class Reference

Abstract base class providing plot and labeling functionality for a locus plot F:N->X,Y. More...

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

Inheritance diagram for mpFXY:

[legend]

Collaboration diagram for mpFXY:

[legend]

List of all members.

Public Member Functions
	mpFXY (wxString name=wxEmptyString, int flags=mpALIGN_NE)
virtual void	Rewind ()=0
	Rewind value enumeration with mpFXY::GetNextXY.
virtual bool	GetNextXY (double &x, double &y)=0
	Get locus value for next N.
virtual void	Plot (wxDC &dc, mpWindow &w)
	Layer plot handler.
Protected Member Functions
void	UpdateViewBoundary (wxCoord xnew, wxCoord ynew)
	Update label positioning data.
Protected Attributes
int	m_flags
	Holds label alignment.
wxCoord	maxDrawX
wxCoord	minDrawX
wxCoord	maxDrawY
wxCoord	minDrawY

---

Detailed Description

Abstract base class providing plot and labeling functionality for a locus plot F:N->X,Y.

Locus argument N is assumed to be in range 0 .. MAX_N, and implicitly derived by enumerating all locus values. Override mpFXY::Rewind and mpFXY::GetNextXY to implement a locus. Optionally implement a constructor and pass a name (label) and a label alignment to the constructor mpFXY::mpFXY. If the layer name is empty, no label will be plotted.

Definition at line 596 of file mathplot.h.

---

Constructor & Destructor Documentation

mpFXY::mpFXY	(	wxString	name = wxEmptyString,
		int	flags = mpALIGN_NE
	)

Parameters:

	name	Label
	flags	Label alignment, pass one of mpALIGN_NE, mpALIGN_NW, mpALIGN_SW, mpALIGN_SE.

---

Member Function Documentation

virtual bool mpFXY::GetNextXY	(	double &	x,
		double &	y
	)			[pure virtual]

Get locus value for next N.

Override this function in your implementation.

Parameters:

	x	Returns X value
	y	Returns Y value

Implemented in mpFXYVector.

virtual void mpFXY::Plot	(	wxDC &	dc,
		mpWindow &	w
	)			[virtual]

Layer plot handler.

This implementation will plot the locus in the visible area and put a label according to the alignment specified.

Implements mpLayer.

virtual void mpFXY::Rewind

(

)

[pure virtual]

Rewind value enumeration with mpFXY::GetNextXY.

Override this function in your implementation.

Implemented in mpFXYVector.

void mpFXY::UpdateViewBoundary	(	wxCoord	xnew,
		wxCoord	ynew
	)			[protected]

Update label positioning data.

Parameters:

	xnew	New x coordinate
	ynew	New y coordinate

---

Member Data Documentation

int mpFXY::m_flags [protected]

Holds label alignment.

Reimplemented in mpFXYVector.

Definition at line 624 of file mathplot.h.

wxCoord mpFXY::maxDrawX [protected]

Definition at line 627 of file mathplot.h.

wxCoord mpFXY::maxDrawY [protected]

Definition at line 627 of file mathplot.h.

wxCoord mpFXY::minDrawX [protected]

Definition at line 627 of file mathplot.h.

wxCoord mpFXY::minDrawY [protected]

Definition at line 627 of file mathplot.h.