Hosted by: BerliOS Developer Logo

OpenMBV C++ Interface

BerliOS Project Page
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes
OpenMBV::Arrow Class Reference

A arrow with zero, one or two heads. More...

#include <arrow.h>

Inheritance diagram for OpenMBV::Arrow:
OpenMBV::DynamicColoredBody OpenMBV::Body OpenMBV::Object

List of all members.

Public Types

enum  Type {
  line, fromHead, toHead, bothHeads,
  fromDoubleHead, toDoubleHead, bothDoubleHeads
}
enum  ReferencePoint { toPoint, fromPoint, midPoint }

Public Member Functions

 Arrow ()
 Default Constructor.
std::string getClassName ()
 Retrun the class name.
void setPath (bool p)
 Draw path of this object in the viewer if true (the default)
bool getPath ()
void append (const std::vector< double > &row)
 Append the data row to the end of the dataset.
int getRows ()
 Get the number of rows of the default data.
std::vector< double > getRow (int i)
 Get row number i of the default data.
void setArrowHead (ScalarParameter diameter, ScalarParameter length)
 Convenience; see setHeadDiameter and setHeadLength.
void setHeadDiameter (ScalarParameter diameter)
 Set the diameter of the arrow head (which is a cone)
double getHeadDiameter ()
void setHeadLength (ScalarParameter length)
 Set the length of the arrow head (which is a cone)
double getHeadLength ()
void setDiameter (ScalarParameter diameter_)
 Set the diameter of the arrow (which is a cylinder)
double getDiameter ()
void setType (Type type_)
 Set the type of the arrow.
Type getType ()
void setReferencePoint (ReferencePoint referencePoint_)
 Set the reference point of the arrow.
ReferencePoint getReferencePoint ()
void setScaleLength (ScalarParameter scale)
 Scale the length of the arrow.
double getScaleLength ()
virtual void initializeUsingXML (MBXMLUtils::TiXmlElement *element)
 Initializes the time invariant part of the object using a XML node.
MBXMLUtils::TiXmlElement * writeXMLFile (MBXMLUtils::TiXmlNode *parent)

Protected Member Functions

void createHDF5File ()
void openHDF5File ()
virtual ~Arrow ()
 Destructor.

Protected Attributes

std::string pathStr
H5::VectorSerie< double > * data
ScalarParameter headDiameter
ScalarParameter headLength
ScalarParameter diameter
ScalarParameter scaleLength
Type type
ReferencePoint referencePoint

Detailed Description

A arrow with zero, one or two heads.

HDF5-Dataset: The HDF5 dataset of this object is a 2D array of double precision values. Each row represents one dataset in time. A row consists of the following columns in order given in world frame: time, "to" point x, "to" point y, "to" point z, delta x, delta y, delta z, color


Member Function Documentation

std::vector<double> OpenMBV::Arrow::getRow ( int  i) [inline, virtual]

Get row number i of the default data.

NOTE: see also append()

Implements OpenMBV::Body.

int OpenMBV::Arrow::getRows ( ) [inline, virtual]

Get the number of rows of the default data.

Returns -1, if no default data is avaliable. NOTE: see also append()

Implements OpenMBV::Body.

void OpenMBV::Arrow::setReferencePoint ( ReferencePoint  referencePoint_) [inline]

Set the reference point of the arrow.

The reference point is the point being stored in the HDF5 file. Use "toPoint" (the default) if the 'to' point is store in the HDF5 file; Use "fromPoint" if the 'from' point is store in the HDF5 file; Use "midPoint" if the 'mid' point is store in the HDF5 file;

void OpenMBV::Arrow::setType ( Type  type_) [inline]

Set the type of the arrow.

Use "line" to draw the arrow as a simple line; Use "fromHead" to draw the arrow with a head at the 'from' point; Use "toHead" to draw the arrow with a head at the 'to' point; Use "bothHeads" to draw the arrow with a head at the 'from' and 'to' point; Use "fromDoubleHead" to draw the arrow with a double head at the 'from' point; Use "toDoubleHead" to draw the arrow with a double head at the 'to' point; Use "bothDoubleHeads" to draw the arrow with a double head at the 'from' and 'to' point;


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