openmbvcppinterface 3.1.0 OpenMBV C++ Interface

Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
OpenMBV::Object Class Referenceabstract

`#include <object.h>`

Inheritance diagram for OpenMBV::Object:
[legend]

## Public Member Functions

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 ()
void | setEnvironment (bool env)
bool | getEnvironment ()
virtual void | initializeUsingXML (xercesc::DOMElement *element)
virtual xercesc::DOMElement * | writeXMLFile (xercesc::DOMNode *parent)
std::shared_ptr< Group > | getTopLevelGroup ()
std::weak_ptr< Group > | getParent ()
H5::GroupBase * | getHDF5Group ()
std::string | getID () const
void | setID (std::string ID_)

## Protected Member Functions

virtual void | createHDF5File ()=0
virtual void | openHDF5File ()=0

## Protected Attributes

std::string | name
std::string | enableStr
std::string | boundingBoxStr
std::string | ID
std::string | environmentStr
std::weak_ptr< Group > | parent
H5::GroupBase * | hdf5Group {nullptr}
std::string | fullName

## Friends

class | Group

## Detailed Description

Abstract base class

## Member Function Documentation

## ◆ getEnvironment()

bool OpenMBV::Object::getEnvironment | ( |  | ) |

Returns true if this or any parent object is an environment objects

## ◆ getFullName()

string OpenMBV::Object::getFullName | ( |  | ) |

virtual

Returns the full name (path) of the object

Reimplemented in OpenMBV::RigidBody, and OpenMBV::Group.

## ◆ getID()

std::string OpenMBV::Object::getID | ( |  | ) | const

inline

get the ID sting of the Object (Note: the ID is metadata and stored as a processing instruction in XML)

## ◆ getTopLevelGroup()

std::shared_ptr< Group > OpenMBV::Object::getTopLevelGroup | ( |  | ) |

return the top level Group

## ◆ initializeUsingXML()

void OpenMBV::Object::initializeUsingXML | ( | xercesc::DOMElement * | element | ) |

virtual

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

Reimplemented in OpenMBV::RigidBody, OpenMBV::Arrow, OpenMBV::NurbsDisk, OpenMBV::CoilSpring, OpenMBV::Group, OpenMBV::SpineExtrusion, OpenMBV::DynamicColoredBody, OpenMBV::CylindricalGear, OpenMBV::Extrusion, OpenMBV::BevelGear, OpenMBV::PlanarGear, OpenMBV::Rack, OpenMBV::Path, OpenMBV::Frustum, OpenMBV::Body, OpenMBV::DynamicNurbsSurface, OpenMBV::Rotation, OpenMBV::IvBody, OpenMBV::DynamicNurbsCurve, OpenMBV::Grid, OpenMBV::IvScreenAnnotation, OpenMBV::FlexibleBody, OpenMBV::CompoundRigidBody, OpenMBV::NurbsSurface, OpenMBV::Cuboid, OpenMBV::IndexedFaceSet, OpenMBV::IndexedLineSet, OpenMBV::NurbsCurve, OpenMBV::Frame, OpenMBV::DynamicIndexedFaceSet, OpenMBV::DynamicIndexedLineSet, OpenMBV::Cylinder, OpenMBV::PointSet, OpenMBV::Cube, OpenMBV::Sphere, and OpenMBV::InvisibleBody.

## ◆ setBoundingBox()

void OpenMBV::Object::setBoundingBox | ( | bool | bbox | ) |

inline

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

## ◆ setEnable()

void OpenMBV::Object::setEnable | ( | bool | enable | ) |

inline

Enable this object in the viewer if true (the default)

## ◆ setEnvironment()

void OpenMBV::Object::setEnvironment | ( | bool | env | ) |

inline

If set to true than this object is an environment object: a static object which has no time dependent part (does not read anything from the h5 file).

## ◆ setID()

void OpenMBV::Object::setID | ( | std::string | ID_ | ) |

inline

set the ID sting of the Object (Note: the ID is metadata and stored as a processing instruction in XML)

## ◆ setName()

void OpenMBV::Object::setName | ( | const std::string & | name_ | ) |

inline

Set the name of this object

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

- /mbsim-env/openmbv/openmbvcppinterface/openmbvcppinterface/object.h
- /mbsim-env/openmbv/openmbvcppinterface/openmbvcppinterface/object.cc