Property specialized to enforce floating point max/min. More...
#include <float_property.h>
Inheritance diagram for rviz::FloatProperty:
Public Slots | |
| bool | add (float delta) |
| Add the given delta to the property value. More... | |
| bool | multiply (float factor) |
| Multiply the property value by the given factor. More... | |
| bool | setFloat (float new_value) |
| Float-typed "SLOT" version of setValue(). More... | |
Public Member Functions | |
| FloatProperty (const QString &name=QString(), float default_value=0, const QString &description=QString(), Property *parent=nullptr, const char *changed_slot=nullptr, QObject *receiver=nullptr) | |
| virtual float | getFloat () const |
| float | getMax () |
| float | getMin () |
| void | setMax (float max) |
| void | setMin (float min) |
| bool | setValue (const QVariant &new_value) override |
| Set the new value for this property. Returns true if the new value is different from the old value, false if same. More... | |
 Public Member Functions inherited from rviz::Property | |
| virtual void | addChild (Property *child, int index=-1) |
| Add a child property. More... | |
| Property * | childAt (int index) const |
| Return the child Property with the given index, or NULL if the index is out of bounds or if the child at that index is not a Property. More... | |
| virtual Property * | childAtUnchecked (int index) const |
| Return the child Property with the given index, without checking whether the index is within bounds. More... | |
| virtual void | collapse () |
| Collapse (hide the children of) this Property. More... | |
| bool | contains (Property *possible_child) const |
| Return true if the list of children includes possible_child, false if not. More... | |
| virtual QWidget * | createEditor (QWidget *parent, const QStyleOptionViewItem &option) |
| Create an editor widget to edit the value of this property. More... | |
| virtual void | expand () |
| Expand (show the children of) this Property. More... | |
| virtual QString | getDescription () const |
| Return the description. More... | |
| virtual bool | getDisableChildren () |
| If true, the children of this property should set their ItemIsEnabled flag to false. More... | |
| virtual bool | getHidden () const |
| Return the hidden/shown state. True means hidden, false means visible. More... | |
| virtual QIcon | getIcon () const |
| PropertyTreeModel * | getModel () const |
| Return the model managing this Property and its childrent. More... | |
| virtual QString | getName () const |
| Return the name of this Property as a QString. More... | |
| std::string | getNameStd () const |
| Return the name of this Property as a std::string. More... | |
| Property * | getParent () const |
| Return the parent Property. More... | |
| virtual bool | getReadOnly () |
| Return the read-only-ness of this property. More... | |
| virtual QVariant | getValue () const |
| Return the value of this Property as a QVariant. If the value has never been set, an invalid QVariant is returned. More... | |
| virtual QVariant | getViewData (int column, int role) const |
| Return data appropriate for the given column (0 or 1) and role for this Property. More... | |
| virtual Qt::ItemFlags | getViewFlags (int column) const |
| Return item flags appropriate for the given column (0 or 1) for this Property. More... | |
| void | hide () |
| Hide this Property in any PropertyTreeWidgets. More... | |
| void | insertChildSorted (Property *child) |
| Insert a child property, sorted by name. More... | |
| bool | isAncestorOf (Property *possible_child) const |
Returns true if this is an ancestor of possible_child, meaning is the parent or parent of parent etc. More... | |
| virtual void | load (const Config &config) |
| Load the value of this property and/or its children from the given Config reference. More... | |
| virtual void | moveChild (int from_index, int to_index) |
| Move the child at from_index to to_index. More... | |
| virtual int | numChildren () const |
| Return the number of child objects (Property or otherwise). More... | |
| virtual bool | paint (QPainter *painter, const QStyleOptionViewItem &option) const |
| Hook to provide custom painting of the value data (right-hand column) in a subclass. More... | |
| Property (const QString &name=QString(), const QVariant default_value=QVariant(), const QString &description=QString(), Property *parent=nullptr, const char *changed_slot=nullptr, QObject *receiver=nullptr) | |
| Constructor. More... | |
| virtual void | removeChildren (int start_index=0, int count=-1) |
| Remove and delete some or all child Properties. Does not change the value of this Property. More... | |
| int | rowNumberInParent () const |
| Return the row number of this property within its parent, or -1 if it has no parent. More... | |
| virtual void | save (Config config) const |
| Write the value of this property and/or its children into the given Config reference. More... | |
| virtual void | setDescription (const QString &description) |
| Set the description. More... | |
| virtual void | setHidden (bool hidden) |
| Hide or show this property in any PropertyTreeWidget viewing its parent. More... | |
| virtual void | setIcon (const QIcon &icon) |
| Set the icon to be displayed next to the property. More... | |
| void | setModel (PropertyTreeModel *model) |
| Set the model managing this Property and all its child properties, recursively. More... | |
| virtual void | setName (const QString &name) |
| Set the name. More... | |
| void | setParent (Property *new_parent) |
| Set parent property, without telling the parent. More... | |
| virtual void | setReadOnly (bool read_only) |
| Prevent or allow users to edit this property from a PropertyTreeWidget. More... | |
| void | setShouldBeSaved (bool save) |
| If save is true and getReadOnly() is false, shouldBeSaved will return true; otherwise false. Default is true. More... | |
| bool | shouldBeSaved () const |
| Returns true if the property is not read-only AND has data worth saving. More... | |
| void | show () |
| Show this Property in any PropertyTreeWidgets. More... | |
| virtual Property * | subProp (const QString &sub_name) |
| Return the first child Property with the given name, or the FailureProperty if no child has the name. More... | |
| Property * | takeChild (Property *child) |
| Remove a given child object and return a pointer to it. More... | |
| virtual Property * | takeChildAt (int index) |
| Take a child out of the child list, but don't destroy it. More... | |
| ~Property () override | |
| Destructor. Removes this property from its parent's list of children. More... | |
Private Attributes | |
| float | max_ |
| float | min_ |
Additional Inherited Members | |
| Signals inherited from rviz::Property | |
| void | aboutToChange () |
| Emitted by setValue() just before the value has changed. More... | |
| void | changed () |
| Emitted by setValue() just after the value has changed. More... | |
| void | childListChanged (Property *this_property) |
| Emitted after insertions and deletions of child Properties. More... | |
| Protected Member Functions inherited from rviz::Property | |
| void | loadValue (const Config &config) |
| Load the value of this property specifically, not including children. More... | |
| Protected Attributes inherited from rviz::Property | |
| bool | child_indexes_valid_ |
| True if row_number_within_parent_ of all children is valid, false if not. More... | |
| QIcon | icon_ |
| PropertyTreeModel * | model_ |
| Pointer to the PropertyTreeModel managing this property tree. More... | |
| QVariant | value_ |
| This is the central property value. If you set it directly in a subclass, do so with care because many things depend on the aboutToChange() and changed() events emitted by setValue(). More... | |
Detailed Description
Property specialized to enforce floating point max/min.
Definition at line 37 of file float_property.h.
Constructor & Destructor Documentation
◆ FloatProperty()
| rviz::FloatProperty::FloatProperty | ( | const QString & | name = QString(), |
| float | default_value = 0, |
||
| const QString & | description = QString(), |
||
| Property * | parent = nullptr, |
||
| const char * | changed_slot = nullptr, |
||
| QObject * | receiver = nullptr |
||
| ) |
Definition at line 38 of file float_property.cpp.
Member Function Documentation
◆ add
|
inlineslot |
Add the given delta to the property value.
Definition at line 81 of file float_property.h.
◆ getFloat()
|
inlinevirtual |
Definition at line 57 of file float_property.h.
◆ getMax()
|
inline |
Definition at line 68 of file float_property.h.
◆ getMin()
|
inline |
Definition at line 63 of file float_property.h.
◆ multiply
|
inlineslot |
Multiply the property value by the given factor.
Definition at line 87 of file float_property.h.
◆ setFloat
|
inlineslot |
Float-typed "SLOT" version of setValue().
Definition at line 75 of file float_property.h.
◆ setMax()
| void rviz::FloatProperty::setMax | ( | float | max | ) |
Definition at line 61 of file float_property.cpp.
◆ setMin()
| void rviz::FloatProperty::setMin | ( | float | min | ) |
Definition at line 55 of file float_property.cpp.
◆ setValue()
|
overridevirtual |
Set the new value for this property. Returns true if the new value is different from the old value, false if same.
If the new value is different from the old value, this emits aboutToChange() before changing the value and changed() after.
Overridden from Property::setValue() to enforce minimum and maximum.
Reimplemented from rviz::Property.
Definition at line 50 of file float_property.cpp.
Member Data Documentation
◆ max_
|
private |
Definition at line 94 of file float_property.h.
◆ min_
|
private |
Definition at line 93 of file float_property.h.
The documentation for this class was generated from the following files: