a2dMarker Class Reference
[a2dCanvasObject related objects, complex canvasobject's, complex canvasobject's for drawing sets of curves]

For Markers on a Curve. More...

#include <marker.h>

Inheritance diagram for a2dMarker:

Collaboration diagram for a2dMarker:

List of all members.

Public Member Functions

a2dMarker (const wxString &format=_T("%f %f"), a2dCurve *curve=0)

marker formatted

a2dMarker (const wxString &format, a2dCurve *curve, double atx, double height=0)

marker formatted

a2dMarker (const wxString &format, a2dCurve *curve, double atx, const a2dFont &font)

marker formatted

a2dMarker (const a2dMarker &other, CloneOptions options)

clone constructor

void CalculatePositionMarker (double &xw, double &yw)

bool GetPositionCurvePoint (a2dPoint2D &point)

get point at position of marker.

virtual a2dObject * Clone (CloneOptions options) const

This is here so that this class cannot be used directly.

void SetCurve (a2dCurve *curve)

a2dCurve * GetCurve () const

return curve of the marker

virtual const wxString & GetMarkerString ()

string for maker, as is rendered when entering marker with cursor.

Static Public Attributes

static a2dPropertyIdCanvasObject * PROPID_curve = NULL

Protected Member Functions

void OnChar (wxKeyEvent &event)

default handler for character events

void DoWalker (wxObject *parent, a2dWalkerIOHandler &handler)

iterate over this object and its children

void DoAddPending (a2dIterC &ic)

called by addPending

void OnCanvasObjectMouseEvent (a2dCanvasObjectMouseEvent &event)

default handler for mouse events, sent to the object from the a2dCanvasView.

virtual void DoSave (wxObject *parent, a2dIOHandlerXmlSerOut &out, a2dXmlSer_flag xmlparts, a2dObjectList *towrite)

write object specific CVGL data

void DoLoad (wxObject *parent, a2dIOHandlerXmlSerIn &parser, a2dXmlSer_flag xmlparts)

load object specific CVG data

void DependencyPending (a2dWalkerIOHandler *handler)

called by to check if this object becomes pending as a result of other objects

bool DoUpdate (UpdateMode mode, const a2dBoundingBox &childbox, const a2dBoundingBox &clipbox, const a2dBoundingBox &propbox)

Update derived Object specific things ( mainly boundingbox).

Protected Attributes

a2dSmrtPtr< a2dCurve > m_curve

Detailed Description

For Markers on a Curve.

A marker is a shape which can be dragged along the curve. The marker has a pointer to the curve, but is placed one level higher in a a2dCurveArea.

Definition at line 242 of file marker.h.

Constructor & Destructor Documentation

a2dMarker::a2dMarker	(	const wxString &	format = `_T("%f %f")`,
		a2dCurve *	curve = `0`
	)

marker formatted

Parameters:

	format	printf format string for position of marker
	curve	pointer to curve object to follow

Definition at line 984 of file marker.cpp.

a2dMarker::a2dMarker	(	const wxString &	format,
		a2dCurve *	curve,
		double	atx,
		double	height = `0`
	)

marker formatted

Parameters:

	format	printf format string for position of marker
	curve	pointer to curve object to follow
	atx	x position on curve
	height	text height for format string

Definition at line 990 of file marker.cpp.

a2dMarker::a2dMarker	(	const wxString &	format,
		a2dCurve *	curve,
		double	atx,
		const a2dFont &	font
	)

marker formatted

Parameters:

	format	printf format string for position of marker
	curve	pointer to curve object to follow
	atx	x position on curve
	font	text font for format string

Definition at line 996 of file marker.cpp.

Member Function Documentation

bool a2dMarker::GetPositionCurvePoint ( a2dPoint2D & point )

get point at position of marker.

If x,y on curve is a function of frequency, m_position stands for the frequency. What is returned, is the x,y at m_position in curve coordinates.

Reimplemented in a2dBandMarker.

Definition at line 1035 of file marker.cpp.

void a2dMarker::DoWalker	(	wxObject *	parent,
		a2dWalkerIOHandler &	handler
	)			`[protected, virtual]`

iterate over this object and its children

This function allows you to extend the functionality of all a2dCanvasObject classes in a a2dCanvasDocument, without adding extra members to these objects.

Default functions are called on the a2dWalkerIOHandler, which redirect the calls to other functions based on this object its classname. On can register classes to a2dWalkerIOHandler or derived classes. This way for each unique object in the document there can be a function in a2dWalkerIOHandler.

Returns:: false if some object did not have a function attached via a2dWalkerIOHandler.

See a2dWalkerIOHandler for more.

Reimplemented from a2dCanvasObject.

Definition at line 773 of file marker.cpp.

void a2dMarker::OnCanvasObjectMouseEvent ( a2dCanvasObjectMouseEvent & event ) [protected]

default handler for mouse events, sent to the object from the a2dCanvasView.

Mouse events are sent to the object when the mouse pointer is hiting the object. The default is used when the object is in edit mode. Else it will detect if the special object tip property named __OBJECTTIP__ is available, and switch it on or off when the mouse eneter or leaves the object.

&& m_flags.m_subEditAsChild )

Reimplemented from a2dCanvasObject.

Definition at line 790 of file marker.cpp.

void a2dMarker::DoLoad	(	wxObject *	parent,
		a2dIOHandlerXmlSerIn &	parser,
		a2dXmlSer_flag	xmlparts
	)			`[protected, virtual]`

load object specific CVG data

todo ignore until this down here is fully converted.

Reimplemented from a2dBaseMarker.

Reimplemented in a2dBandMarker.

Definition at line 1099 of file marker.cpp.

void a2dMarker::DependencyPending ( a2dWalkerIOHandler * handler ) [protected, virtual]

called by to check if this object becomes pending as a result of other objects

You can Override DependencyPending() to set your object pending, when another object was set pending.

Reimplemented from a2dCanvasObject.

Definition at line 1055 of file marker.cpp.

bool a2dMarker::DoUpdate	(	UpdateMode	mode,
		const a2dBoundingBox &	childbox,
		const a2dBoundingBox &	clipbox,
		const a2dBoundingBox &	propbox
	)			`[protected, virtual]`

Update derived Object specific things ( mainly boundingbox).

Calculates the boundingbox of the object (exclusif base class child objects but with other nested objects).

Parameters:

	mode	way to update the objects
	childbox	size of children boundingbox
	clipbox	clip to this
	propbox	size of properties boundingbox

Remarks:: in a derived class this function can also be used to update object specific cache data.
force may or may not have direct influence on the object itself, if this function is called directly for some reason (e.g from derived objects), you must invalidate the boudingbox yourself. GetDrawerBox()->SetValid( false );

Reimplemented from a2dCurveObject.

Definition at line 1064 of file marker.cpp.

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


Public Member Functions
	a2dMarker (const wxString &format=_T("%f %f"), a2dCurve *curve=0)
	marker formatted
	a2dMarker (const wxString &format, a2dCurve *curve, double atx, double height=0)
	marker formatted
	a2dMarker (const wxString &format, a2dCurve *curve, double atx, const a2dFont &font)
	marker formatted
	a2dMarker (const a2dMarker &other, CloneOptions options)
	clone constructor
void	CalculatePositionMarker (double &xw, double &yw)
bool	GetPositionCurvePoint (a2dPoint2D &point)
	get point at position of marker.
virtual a2dObject *	Clone (CloneOptions options) const
	This is here so that this class cannot be used directly.
void	SetCurve (a2dCurve *curve)
a2dCurve *	GetCurve () const
	return curve of the marker
virtual const wxString &	GetMarkerString ()
	string for maker, as is rendered when entering marker with cursor.
Static Public Attributes
static a2dPropertyIdCanvasObject *	PROPID_curve = NULL
Protected Member Functions
void	OnChar (wxKeyEvent &event)
	default handler for character events
void	DoWalker (wxObject *parent, a2dWalkerIOHandler &handler)
	iterate over this object and its children
void	DoAddPending (a2dIterC &ic)
	called by addPending
void	OnCanvasObjectMouseEvent (a2dCanvasObjectMouseEvent &event)
	default handler for mouse events, sent to the object from the a2dCanvasView.
virtual void	DoSave (wxObject parent, a2dIOHandlerXmlSerOut &out, a2dXmlSer_flag xmlparts, a2dObjectList towrite)
	write object specific CVGL data
void	DoLoad (wxObject *parent, a2dIOHandlerXmlSerIn &parser, a2dXmlSer_flag xmlparts)
	load object specific CVG data
void	DependencyPending (a2dWalkerIOHandler *handler)
	called by to check if this object becomes pending as a result of other objects
bool	DoUpdate (UpdateMode mode, const a2dBoundingBox &childbox, const a2dBoundingBox &clipbox, const a2dBoundingBox &propbox)
	Update derived Object specific things ( mainly boundingbox).
Protected Attributes
a2dSmrtPtr< a2dCurve >	m_curve

a2dMarker Class Reference [a2dCanvasObject related objects, complex canvasobject's, complex canvasobject's for drawing sets of curves]

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

a2dMarker Class Reference
[a2dCanvasObject related objects, complex canvasobject's, complex canvasobject's for drawing sets of curves]