 |
NDEVR
API Documentation
|
|
NDEVR
API Documentation
|
Describes special options/parameters for a GeometryRegistration engine. More...
Public Member Functions | |
| GeometryRegistrationDescription (const TranslatedString &name, const String &filter_id) | |
| Constructs a GeometryRegistrationDescription with a display name and filter identifier. | |
| Public Member Functions inherited from GenericOptionGroup | |
| GenericOptionGroup ()=default | |
| Default constructor. | |
| GenericOptionGroup (const TranslatedString &group_name, const StringView &group_id=StringView()) | |
| Constructs an option group with the given name and optional identifier. | |
| virtual | ~GenericOptionGroup () |
| Virtual destructor. | |
| void | addOption (const GenericOption &option) |
| Adds a fully configured GenericOption to this group. | |
| template<class t_type> | |
| void | addOption (const TranslatedString &name, const t_type &value, bool is_editable=true) |
| Adds a new option to this group with the given name and typed value. | |
| void | addOptionsToINI (INIFactory &factory) |
| Adds all options in this group to an existing INIFactory for serialization. | |
| void | clear () |
| Removes all options from this group. | |
| virtual void | fromJSONNode (const JSONNode &node) |
| Deserializes this option group from a JSON node. | |
| GenericOption & | getOption (const TranslatedString &n) |
| Retrieves a mutable reference to the option with the given translated name. | |
| const GenericOption & | getOption (const TranslatedString &n) const |
| Retrieves a const reference to the option with the given translated name. | |
| template<class t_type> | |
| t_type | getValue (const StringView &name) const |
| Retrieves the value of an option converted to the requested type, looked up by string identifier. | |
| template<class t_type> | |
| t_type | getValue (const StringView &name, const t_type &value_if_not_exist) const |
| Retrieves the value of an option by string identifier, returning a fallback if the option does not exist. | |
| template<class t_type> | |
| t_type | getValue (const TranslatedString &name) const |
| Retrieves the value of an option converted to the requested type, looked up by translated name. | |
| template<class t_type> | |
| t_type | getValue (const TranslatedString &name, const t_type &value_if_not_exist) const |
| Retrieves the value of an option by translated name, returning a fallback if the option does not exist. | |
| bool | hasOption (const StringView &option_name) const |
| Checks whether an option with the given string identifier exists in this group. | |
| bool | hasOption (const TranslatedString &option_name) const |
| Checks whether an option with the given translated name exists in this group. | |
| INIFactory | ini () |
| Creates an INIFactory for serializing this option group to INI format. | |
| bool | operator!= (const GenericOptionGroup &option_group) const |
| Checks inequality between two option groups. | |
| bool | operator== (const GenericOptionGroup &option_group) const |
| Checks equality between two option groups by comparing all option values. | |
| void | setOption (const GenericOption &option) |
| Replaces an existing option with the given GenericOption, matched by its identifier. | |
| template<class t_type> | |
| void | setValue (const StringView &name, const t_type &value) |
| Sets the value of an existing option identified by its string name. | |
| template<class t_type> | |
| void | setValue (const TranslatedString &name, const t_type &value) |
| Sets the value of an existing option identified by its translated name. | |
| virtual JSONNode | toJSONNode (bool only_value=true) const |
| Serializes this option group to a JSON node. | |
Additional Inherited Members | |
| Public Attributes inherited from GenericOptionGroup | |
| String | id |
| The unique identifier for this option group. | |
| TranslatedString | name |
| The user-facing display name of this option group. | |
| Dictionary< String, GenericOption > | options |
| The dictionary mapping option identifiers to their GenericOption instances. | |
| Buffer< String > | ordered_options |
| The insertion-ordered list of option identifiers for preserving display order. | |
Describes special options/parameters for a GeometryRegistration engine.
Wraps a named option group with a filter identifier so that each registration engine can expose its own set of user-configurable parameters.
Definition at line 22 of file GeometryRegistration.h.
| GeometryRegistrationDescription::GeometryRegistrationDescription | ( | const TranslatedString & | name, |
| const String & | filter_id ) |
Constructs a GeometryRegistrationDescription with a display name and filter identifier.
| [in] | name | The translated display name for this registration description. |
| [in] | filter_id | A unique string identifier for the associated registration engine. |
References GenericOptionGroup::name.