IRockyGeometriesMotionData Struct Reference
Last update: 08.07.2024
IRockyGeometriesMotionData Struct Reference
#include <rocky_boundary_api.hpp>
Public Member Functions | |
| unsigned int | get_number_of_geometries () const |
| IRockyGeometryMotionData | get_geometry (unsigned int id) const |
| IRockyGeometryMotionData | get_geometry (const std::string &name) const |
| bool | has_linked_motion_frame (unsigned int id) const |
Detailed Description
IRockyGeometriesMotionData is an interface for a list of geometries motions in Rocky. The list of geometries motions represented by this interface contains all geometries in Rocky, and they may or may not have a motion applied in Rocky's last simulation timestep. The geometries motions can be generated based upon the IDs of the geometries, which are numbered sequentially starting from zero, or from the names assigned to the geometries in the Rocky UI.
Member Function Documentation
◆ get_geometry() [1/2]
| IRockyGeometryMotionData IRockyGeometriesMotionData::get_geometry | ( | const std::string & | name | ) | const |
- Gets a geometry's motion given the geometry's name.
- If the provided name does not correspond to an existing geometry in Rocky, this method will raise an exception.
- Parameters
-
name The name assigned in Rocky to an existing geometry.
- Returns
- A geometry's motion.
◆ get_geometry() [2/2]
| IRockyGeometryMotionData IRockyGeometriesMotionData::get_geometry | ( | unsigned int | id | ) | const |
- Gets a geometry's motion given the geometry's Rocky ID.
- If the provided ID does not correspond to an existing geometry in Rocky, this method will raise an exception.
- Parameters
-
id The index assigned in Rocky to an existing geometry.
- Returns
- A geometry's motion.
◆ get_number_of_geometries()
| unsigned int IRockyGeometriesMotionData::get_number_of_geometries | ( | ) | const |
- Returns
- The number of geometries in the Rocky project.
◆ has_linked_motion_frame()
| bool IRockyGeometriesMotionData::has_linked_motion_frame | ( | unsigned int | id | ) | const |
- Parameters
-
id The index assigned in Rocky to an existing geometry.
- Returns
- True if the geometry with the passed id has motion from the Rocky's internal motion kernel implementation. False otherwise.