a2dPlot Class Reference

plot a group of curves on a given area in world coordinates. More...

#include <plotbox.h>

Inheritance diagram for a2dPlot:

Inheritance graph
[legend]
Collaboration diagram for a2dPlot:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 a2dPlot (double x=0, double y=0)
 a2dPlot (const a2dPlot &other, CloneOptions options)
a2dObjectClone (CloneOptions options) const
 to clone object
void SetTitle (const wxString &title)
 set title above plot, empty string removes it
void SetTitleTextDc (a2dText *title)
 set title above plot using a text object, NULL removes it
void SetMarkerShow (a2dMarkerShow *showm)
 set markerShow under plot using a a2dMarkerShow object, NULL removes it
void SetXLabel (const wxString &xlabel, const wxColour &color=wxNullColour)
 set X label on axis, empty string removes it
void SetXLabelTextDc (a2dText *xLabelTextDc)
 set X label on axis as text object, NULL removes it
void SetYLabel (const wxString &ylabel, const wxColour &color=wxNullColour)
 set Y label on axis, empty string removes it
void SetYLabelTextDc (a2dText *yLabelTextDc)
 set Y label on axis as text object, NULL removes it
void SetY1Label (const wxString &ylabel, const wxColour &color=wxNullColour)
 set Y label on axis, empty string removes it
void SetY1LabelTextDc (a2dText *yLabelTextDc)
 set Y label on axis as text object, NULL removes it
void SetY2Label (const wxString &ylabel, const wxColour &color=wxNullColour)
 set Y label on axis, empty string removes it
void SetY2LabelTextDc (a2dText *yLabelTextDc)
 set Y label on axis as text object, NULL removes it
void SetAutoPlace (bool autoPlace)
 if true text objects title xlabel and ylabel will be set in position automatically
void SetAutoYAxesNames (bool autoYNames)
 if true text ylabel will be set according curves area name
void SetPadding (double leftPadding, double rightPadding, double topPadding, double bottomPadding)
 extra distance around plot

Protected Member Functions

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 DoRender (a2dIterC &ic, OVERLAP clipparent)
 render derived object
bool DoUpdate (UpdateMode mode, const a2dBoundingBox &childbox, const a2dBoundingBox &clipbox, const a2dBoundingBox &propbox)
 Update derived Object specific things ( mainly boundingbox).
a2dBoundingBox DoGetUnTransformedBbox (a2dBboxFlags flags=a2dCANOBJ_BBOX_NON) const
void SetPosYLabel (a2dText *yLabelTextDc, double x, double y, double tHeight, bool left)

Protected Attributes

double m_leftPadding
 padding.
double m_bottomPadding
 padding.
double m_topPadding
 padding.
double m_rightPadding
 padding.
bool m_autoPlace
bool m_autoYNames


Detailed Description

plot a group of curves on a given area in world coordinates.

Definition at line 31 of file plotbox.h.


Member Function Documentation

void a2dPlot::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 a2dCanvasXYDisplayGroupAreas.

Definition at line 612 of file plotbox.cpp.

void a2dPlot::DoRender ( a2dIterC ic,
OVERLAP  clipparent 
) [protected, virtual]

render derived object

if the object has sub objects (apart from the childobject which are handled here), those subobject most rendered by iterating on layer when needed/wanted, simular to child objects. We do not iterate here, since that is only needed if indeed there or subobjects. This will be know in a "wxDerivedCanvasObject DoRender".

SO parent objects that call this function, must:

  • 1- clip object against area to redraw.
  • 2- iterate on layers when needed.
A a2dCanvasObject is rendered as a + (plus sign) when there or no children.

Reimplemented from a2dCanvasXYDisplayGroupAreas.

Definition at line 255 of file plotbox.cpp.

bool a2dPlot::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 a2dCanvasXYDisplayGroupAreas.

Definition at line 314 of file plotbox.cpp.


The documentation for this class was generated from the following files:
a2dPlot Class Reference -- Tue Aug 31 18:32:01 2010 -- 31 Aug 2010 -- 1.5.5 -- wxArt2D -- . -- Main Page Reference Documentation