All Classes Namespaces Functions Variables Typedefs Enumerations Pages
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
OpenMBV::Arrow Class Reference

#include <arrow.h>

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

Public Types

enum  Type {
  line, fromHead, toHead, bothHeads,
  fromDoubleHead, toDoubleHead, bothDoubleHeads
}
 
enum  ReferencePoint { toPoint, fromPoint, midPoint }
 
- Public Types inherited from OpenMBV::Body
enum  DrawStyle { filled, lines, points }
 
- Public Types inherited from fmatvec::Atom
enum  MsgType
 

Public Member Functions

std::string getClassName ()
 
void setPath (bool p)
 
bool getPath ()
 
template<typename T >
void append (const T &row)
 
int getRows ()
 
std::vector< double > getRow (int i)
 
void setArrowHead (double diameter, double length)
 
void setHeadDiameter (double diameter)
 
double getHeadDiameter ()
 
void setHeadLength (double length)
 
double getHeadLength ()
 
void setDiameter (double diameter_)
 
double getDiameter ()
 
void setType (Type type_)
 
Type getType ()
 
void setReferencePoint (ReferencePoint referencePoint_)
 
ReferencePoint getReferencePoint ()
 
void setScaleLength (double scale)
 
double getScaleLength ()
 
virtual void initializeUsingXML (xercesc::DOMElement *element)
 
xercesc::DOMElement * writeXMLFile (xercesc::DOMNode *parent)
 
- Public Member Functions inherited from OpenMBV::DynamicColoredBody
void setMinimalColorValue (double min)
 
double getMinimalColorValue ()
 
void setMaximalColorValue (double max)
 
double getMaximalColorValue ()
 
void setDynamicColor (const double col)
 
double getDynamicColor ()
 
void setDiffuseColor (const std::vector< double > &hsv)
 
void setDiffuseColor (double h, double s, double v)
 
std::vector< double > getDiffuseColor ()
 
void setTransparency (double t)
 
double getTransparency ()
 
xercesc::DOMElement * writeXMLFile (xercesc::DOMNode *parent)
 
- Public Member Functions inherited from OpenMBV::Body
std::string getClassName ()
 
void setHDF5LinkTarget (const boost::shared_ptr< Body > &dest)
 
boost::shared_ptr< Body > & getHDF5LinkTarget ()
 
bool isHDF5Link ()
 
void setOutLine (bool ol)
 
bool getOutLine ()
 
void setShilouetteEdge (bool ol)
 
bool getShilouetteEdge ()
 
void setDrawMethod (DrawStyle ds)
 
DrawStyle getDrawMethod ()
 
- Public Member Functions inherited from OpenMBV::Object
void setEnable (bool enable)
 
bool getEnable ()
 
void setBoundingBox (bool bbox)
 
bool getBoundingBox ()
 
void setName (const std::string &name_)
 
std::string getName ()
 
virtual std::string getFullName (bool includingFileName=false, bool stopAtSeparateFile=false)
 
boost::shared_ptr< GroupgetSeparateGroup ()
 
boost::shared_ptr< GroupgetTopLevelGroup ()
 
boost::weak_ptr< GroupgetParent ()
 
H5::GroupBasegetHDF5Group ()
 
std::string getID () const
 
void setID (std::string ID_)
 
bool getSelected () const
 
void setSelected (bool selected_)
 
- Public Member Functions inherited from fmatvec::Atom
Atomoperator= (const Atom &)
 
void setMessageStreamActive (MsgType type, bool active)
 
void getMessageStream (MsgType type, boost::shared_ptr< bool > &a, boost::shared_ptr< std::ostream > &s)
 
void adoptMessageStreams (const Atom *src=NULL)
 
std::ostream & msg (MsgType type)
 
bool msgAct (MsgType type)
 

Protected Member Functions

void createHDF5File ()
 
void openHDF5File ()
 
- Protected Member Functions inherited from OpenMBV::Body
void createHDF5File ()
 
void openHDF5File ()
 
void terminate ()
 
- Protected Member Functions inherited from fmatvec::Atom
 Atom (const Atom &src)
 

Protected Attributes

std::string pathStr
 
H5::VectorSerie< double > * data
 
double headDiameter
 
double headLength
 
double diameter
 
double scaleLength
 
Type type
 
ReferencePoint referencePoint
 
- Protected Attributes inherited from OpenMBV::DynamicColoredBody
double minimalColorValue
 
double maximalColorValue
 
double dynamicColor
 
std::vector< double > diffuseColor
 
double transparency
 
- Protected Attributes inherited from OpenMBV::Body
std::string outLineStr
 
std::string shilouetteEdgeStr
 
DrawStyle drawMethod
 
boost::shared_ptr< Bodyhdf5LinkBody
 
std::string hdf5LinkStr
 
- Protected Attributes inherited from OpenMBV::Object
std::string name
 
std::string enableStr
 
std::string boundingBoxStr
 
std::string ID
 
bool selected
 
boost::weak_ptr< Groupparent
 
H5::GroupBasehdf5Group
 

Friends

class ObjectFactory
 

Additional Inherited Members

- Static Public Member Functions inherited from OpenMBV::Object
static double getDouble (xercesc::DOMElement *e)
 
static std::vector< double > getVec (xercesc::DOMElement *e, unsigned int rows=0)
 
static std::vector
< std::vector< double > > 
getMat (xercesc::DOMElement *e, unsigned int rows=0, unsigned int cols=0)
 
static std::string numtostr (int i)
 
static std::string numtostr (double d)
 
template<class T >
static void addElementText (xercesc::DOMElement *parent, const MBXMLUtils::FQN &name, const T &value)
 
static void addElementText (xercesc::DOMElement *parent, const MBXMLUtils::FQN &name, double value, double def)
 
static void addElementText (xercesc::DOMElement *parent, const MBXMLUtils::FQN &name, const std::vector< double > &value)
 
static void addElementText (xercesc::DOMElement *parent, const MBXMLUtils::FQN &name, const std::vector< std::vector< double > > &value)
 
template<class T >
static void addAttribute (xercesc::DOMNode *node, std::string name, T value)
 
template<class T >
static void addAttribute (xercesc::DOMNode *node, std::string name, T value, std::string def)
 
- Static Public Member Functions inherited from fmatvec::Atom
static void setCurrentMessageStream (MsgType type, const boost::shared_ptr< bool > &a=boost::make_shared< bool >(true), const boost::shared_ptr< std::ostream > &s=boost::make_shared< std::ostream >(std::cout.rdbuf()))
 
static std::ostream & msgStatic (MsgType type)
 
static bool msgActStatic (MsgType type)
 
- Static Protected Member Functions inherited from OpenMBV::Object
static std::vector< double > toVector (std::string str)
 
static std::vector
< std::vector< double > > 
toMatrix (std::string str)
 

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

template<typename T >
void OpenMBV::Arrow::append ( const T &  row)
inline

Append the data row to the end of the dataset

std::string OpenMBV::Arrow::getClassName ( )
inlinevirtual

Retrun the class name

Implements OpenMBV::Object.

std::vector<double> OpenMBV::Arrow::getRow ( int  i)
inlinevirtual

Get row number i of the default data. NOTE: see also append()

Implements OpenMBV::Body.

int OpenMBV::Arrow::getRows ( )
inlinevirtual

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::initializeUsingXML ( xercesc::DOMElement *  element)
virtual

Initializes the time invariant part of the object using a XML node

Reimplemented from OpenMBV::DynamicColoredBody.

void OpenMBV::Arrow::setArrowHead ( double  diameter,
double  length 
)
inline

Convenience; see setHeadDiameter and setHeadLength

void OpenMBV::Arrow::setDiameter ( double  diameter_)
inline

Set the diameter of the arrow (which is a cylinder)

void OpenMBV::Arrow::setHeadDiameter ( double  diameter)
inline

Set the diameter of the arrow head (which is a cone)

void OpenMBV::Arrow::setHeadLength ( double  length)
inline

Set the length of the arrow head (which is a cone)

void OpenMBV::Arrow::setPath ( bool  p)
inline

Draw path of this object in the viewer if true (the default)

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::setScaleLength ( double  scale)
inline

Scale the length of the arrow

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 files:

Impressum / Disclaimer / Datenschutz Generated by doxygen 1.8.5 Valid HTML