IRockyPluginData Class Reference
Last update: 08.07.2024
IRockyPluginData Class Reference
#include <rocky_plugin_data.h>
Public Member Functions | |
| IRockyPluginDataEntry | get_model () const |
| bool | has_material_interaction_data () const |
| int | get_number_material_interactions () const |
| IRockyPluginDataEntry | get_material_interaction_data (int index) const |
| bool | has_geometry_data () const |
| int | get_number_geometries () const |
| IRockyPluginDataEntry | get_geometry_data (int index) const |
| bool | has_particle_group_data () const |
| int | get_number_particle_groups () const |
| IRockyPluginDataEntry | get_particle_group_data (int index) const |
| bool | has_material_data () const |
| int | get_number_materials () const |
| IRockyPluginDataEntry | get_material_data (int index) const |
Detailed Description
IRockyPluginData gathers custom module data entered manually through the Rocky UI. In order to appear on the Rocky UI, custom modules parameters must be specified in the Python file that defines the components of the module. An IRockyPluginData object is only available during the configuration step in ROCKY_PLUGIN_CONFIGURE.
Member Function Documentation
◆ get_geometry_data()
| IRockyPluginDataEntry IRockyPluginData::get_geometry_data | ( | int | index | ) | const |
- Returns
- An
IRockyPluginDataEntryobject that gives access to the values entered through the Rocky UI, if they exist, for all parameters associated specifically to the module defined in the geometry (boundaries) section.
- Parameters
-
index The index that uniquely identifies the specific geometry whose data must be retrieved.
◆ get_material_data()
| IRockyPluginDataEntry IRockyPluginData::get_material_data | ( | int | index | ) | const |
- Returns
- An
IRockyPluginDataEntryobject that gives access to the values entered through the Rocky UI, if they exist, for all parameters associated specifically to the module defined in the material section.
- Parameters
-
index The index that uniquely identifies the specific material whose data must be retrieved.
◆ get_material_interaction_data()
| IRockyPluginDataEntry IRockyPluginData::get_material_interaction_data | ( | int | index | ) | const |
- Returns
- An
IRockyPluginDataEntryobject that gives access to the values entered through the Rocky UI, if they exist, for all parameters defined in the material interactions section of the module.
- Parameters
-
index The index that uniquely identifies the specific material interaction whose data must be retrieved.
◆ get_model()
| IRockyPluginDataEntry IRockyPluginData::get_model | ( | ) | const |
- Returns
- An
IRockyPluginDataEntryobject that gives access to the values entered through the Rocky UI for all parameters in the model section of the module. These parameters are displayed in the [Data Editors] panel when the module is selected in the data tree.
◆ get_number_geometries()
| int IRockyPluginData::get_number_geometries | ( | ) | const |
- Returns
- The total number of geometries (boundaries) in the project.
◆ get_number_material_interactions()
| int IRockyPluginData::get_number_material_interactions | ( | ) | const |
- Returns
- The total number of material interactions that it is possible to define with the current materials defined in the Rocky project.
◆ get_number_materials()
| int IRockyPluginData::get_number_materials | ( | ) | const |
- Returns
- The total number of materials defined in the project.
◆ get_number_particle_groups()
| int IRockyPluginData::get_number_particle_groups | ( | ) | const |
- Returns
- The total number of particle groups defined in the project.
◆ get_particle_group_data()
| IRockyPluginDataEntry IRockyPluginData::get_particle_group_data | ( | int | index | ) | const |
- Returns
- An
IRockyPluginDataEntryobject that gives access to the values entered through the Rocky UI, if they exist, for all parameters associated specifically to the module defined in the particle group section.
- Parameters
-
index The index that uniquely identifies the specific particle group whose data must be retrieved.
◆ has_geometry_data()
| bool IRockyPluginData::has_geometry_data | ( | ) | const |
- Returns
- True if there is geometry data defined for the module, false otherwise.
◆ has_material_data()
| bool IRockyPluginData::has_material_data | ( | ) | const |
- Returns
- True if there is any material property data defined for the module, false otherwise.
◆ has_material_interaction_data()
| bool IRockyPluginData::has_material_interaction_data | ( | ) | const |
- Returns
- True if there is custom material interaction data defined for the module, false otherwise.
◆ has_particle_group_data()
| bool IRockyPluginData::has_particle_group_data | ( | ) | const |
- Returns
- True if there is particle group data defined for the module, false otherwise.