Main MRPT website > C++ reference
MRPT logo
Public Member Functions | Protected Member Functions | Protected Attributes

mpMovableObject Class Reference


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 rendering, assuming that the object updates its shape in m_shape_xs & m_shape_ys.

Definition at line 1433 of file mathplot.h.

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

Inheritance diagram for mpMovableObject:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 mpMovableObject ()
 Default constructor (sets location and rotation to (0,0,0))
virtual ~mpMovableObject ()
void GetCoordinateBase (double &x, double &y, double &phi) const
 Get the current coordinate transformation.
void SetCoordinateBase (double x, double y, double phi=0)
 Set the coordinate transformation (phi in radians, 0 means no rotation).
virtual bool HasBBox ()
 Check whether this layer has a bounding box.
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.
virtual void Plot (wxDC &dc, mpWindow &w)
 Plot given view of layer to the given device context.
void SetAlign (int align)
 Set label axis alignment.

Protected Member Functions

void TranslatePoint (double x, double y, double &out_x, double &out_y)
 A method for 2D translation and rotation, using the current transformation stored in m_reference_x,m_reference_y,m_reference_phi.
void ShapeUpdated ()
 Must be called by the descendent class after updating the shape (m_shape_xs/ys), or when the transformation changes.

Protected Attributes

int m_flags
 Holds label alignment.
double m_reference_x
 The coordinates of the object (orientation "phi" is in radians).
double m_reference_y
double m_reference_phi
std::vector< double > m_shape_xs
 This contains the object points, in local coordinates (to be transformed by the current transformation).
std::vector< double > m_shape_ys
std::vector< double > m_trans_shape_xs
 The buffer for the translated & rotated points (to avoid recomputing them with each mpWindow refresh).
std::vector< double > m_trans_shape_ys
double m_bbox_min_x
 The precomputed bounding box:
double m_bbox_max_x
double m_bbox_min_y
double m_bbox_max_y

Constructor & Destructor Documentation

mpMovableObject::mpMovableObject (  ) [inline]

Default constructor (sets location and rotation to (0,0,0))

Definition at line 1438 of file mathplot.h.

References mpLAYER_PLOT.

virtual mpMovableObject::~mpMovableObject (  ) [inline, virtual]

Definition at line 1448 of file mathplot.h.


Member Function Documentation

void mpMovableObject::GetCoordinateBase ( double &  x,
double &  y,
double &  phi 
) const [inline]

Get the current coordinate transformation.

Definition at line 1452 of file mathplot.h.

virtual double mpMovableObject::GetMaxX (  ) [inline, virtual]

Get inclusive right border of bounding box.

Reimplemented from mpLayer.

Definition at line 1478 of file mathplot.h.

virtual double mpMovableObject::GetMaxY (  ) [inline, virtual]

Get inclusive top border of bounding box.

Reimplemented from mpLayer.

Definition at line 1486 of file mathplot.h.

virtual double mpMovableObject::GetMinX (  ) [inline, virtual]

Get inclusive left border of bounding box.

Reimplemented from mpLayer.

Definition at line 1474 of file mathplot.h.

virtual double mpMovableObject::GetMinY (  ) [inline, virtual]

Get inclusive bottom border of bounding box.

Reimplemented from mpLayer.

Definition at line 1482 of file mathplot.h.

virtual bool mpMovableObject::HasBBox (  ) [inline, virtual]

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

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

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
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.

void mpMovableObject::SetAlign ( int  align ) [inline]

Set label axis alignment.

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

Definition at line 1493 of file mathplot.h.

void mpMovableObject::SetCoordinateBase ( double  x,
double  y,
double  phi = 0 
) [inline]

Set the coordinate transformation (phi in radians, 0 means no rotation).

Definition at line 1461 of file mathplot.h.

References mpALIGN_NE, and internal::y.

void mpMovableObject::ShapeUpdated (  ) [protected]

Must be called by the descendent class after updating the shape (m_shape_xs/ys), or when the transformation changes.

This method updates the buffers m_trans_shape_xs/ys, and the precomputed bounding box.

void mpMovableObject::TranslatePoint ( double  x,
double  y,
double &  out_x,
double &  out_y 
) [protected]

A method for 2D translation and rotation, using the current transformation stored in m_reference_x,m_reference_y,m_reference_phi.


Member Data Documentation

double mpMovableObject::m_bbox_max_x [protected]

Definition at line 1518 of file mathplot.h.

double mpMovableObject::m_bbox_max_y [protected]

Definition at line 1518 of file mathplot.h.

double mpMovableObject::m_bbox_min_x [protected]

The precomputed bounding box:

See also:
ShapeUpdated

Definition at line 1518 of file mathplot.h.

double mpMovableObject::m_bbox_min_y [protected]

Definition at line 1518 of file mathplot.h.

int mpMovableObject::m_flags [protected]

Holds label alignment.

Definition at line 1493 of file mathplot.h.

Definition at line 1500 of file mathplot.h.

double mpMovableObject::m_reference_x [protected]

The coordinates of the object (orientation "phi" is in radians).

Definition at line 1500 of file mathplot.h.

double mpMovableObject::m_reference_y [protected]

Definition at line 1500 of file mathplot.h.

std::vector<double> mpMovableObject::m_shape_xs [protected]

This contains the object points, in local coordinates (to be transformed by the current transformation).

Definition at line 1508 of file mathplot.h.

std::vector<double> mpMovableObject::m_shape_ys [protected]

Definition at line 1508 of file mathplot.h.

std::vector<double> mpMovableObject::m_trans_shape_xs [protected]

The buffer for the translated & rotated points (to avoid recomputing them with each mpWindow refresh).

Definition at line 1513 of file mathplot.h.

std::vector<double> mpMovableObject::m_trans_shape_ys [protected]

Definition at line 1513 of file mathplot.h.




Page generated by Doxygen 1.7.2 for MRPT 0.9.4 SVN: at Mon Jan 10 22:46:17 UTC 2011