Public Member Functions | Private Slots | Private Member Functions | Private Attributes | List of all members
rviz::VectorProperty Class Reference

#include <vector_property.h>

Inheritance diagram for rviz::VectorProperty:
Inheritance graph
[legend]

Public Member Functions

bool add (const Ogre::Vector3 &offset)
 
virtual Ogre::Vector3 getVector () const
 
void load (const Config &config) override
 Load the value of this property and/or its children from the given Config reference. More...
 
void save (Config config) const override
 Write the value of this property and/or its children into the given Config reference. More...
 
void setReadOnly (bool read_only) override
 Overridden from Property to propagate read-only-ness to children. More...
 
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...
 
virtual bool setVector (const Ogre::Vector3 &vector)
 
 VectorProperty (const QString &name=QString(), const Ogre::Vector3 &default_value=Ogre::Vector3::ZERO, const QString &description=QString(), Property *parent=nullptr, const char *changed_slot=nullptr, QObject *receiver=nullptr)
 
- Public Member Functions inherited from rviz::Property
virtual void addChild (Property *child, int index=-1)
 Add a child property. More...
 
PropertychildAt (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 PropertychildAtUnchecked (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
 
PropertyTreeModelgetModel () 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...
 
PropertygetParent () 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...
 
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 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 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...
 
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 PropertysubProp (const QString &sub_name)
 Return the first child Property with the given name, or the FailureProperty if no child has the name. More...
 
PropertytakeChild (Property *child)
 Remove a given child object and return a pointer to it. More...
 
virtual PropertytakeChildAt (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 Slots

void emitAboutToChange ()
 
void updateFromChildren ()
 

Private Member Functions

void updateString ()
 

Private Attributes

bool ignore_child_updates_
 
Ogre::Vector3 vector_
 
Propertyx_
 
Propertyy_
 
Propertyz_
 

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_
 
PropertyTreeModelmodel_
 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

Definition at line 39 of file vector_property.h.

Constructor & Destructor Documentation

◆ VectorProperty()

rviz::VectorProperty::VectorProperty ( const QString &  name = QString(),
const Ogre::Vector3 &  default_value = Ogre::Vector3::ZERO,
const QString &  description = QString(),
Property parent = nullptr,
const char *  changed_slot = nullptr,
QObject *  receiver = nullptr 
)

Definition at line 37 of file vector_property.cpp.

Member Function Documentation

◆ add()

bool rviz::VectorProperty::add ( const Ogre::Vector3 &  offset)
inline

Definition at line 55 of file vector_property.h.

◆ emitAboutToChange

void rviz::VectorProperty::emitAboutToChange ( )
privateslot

Definition at line 110 of file vector_property.cpp.

◆ getVector()

virtual Ogre::Vector3 rviz::VectorProperty::getVector ( ) const
inlinevirtual

Definition at line 51 of file vector_property.h.

◆ load()

void rviz::VectorProperty::load ( const Config config)
overridevirtual

Load the value of this property and/or its children from the given Config reference.

Reimplemented from rviz::Property.

Definition at line 124 of file vector_property.cpp.

◆ save()

void rviz::VectorProperty::save ( Config  config) const
overridevirtual

Write the value of this property and/or its children into the given Config reference.

Reimplemented from rviz::Property.

Definition at line 136 of file vector_property.cpp.

◆ setReadOnly()

void rviz::VectorProperty::setReadOnly ( bool  read_only)
overridevirtual

Overridden from Property to propagate read-only-ness to children.

Reimplemented from rviz::Property.

Definition at line 145 of file vector_property.cpp.

◆ setValue()

bool rviz::VectorProperty::setValue ( const QVariant &  new_value)
overridevirtual

Set the new value for this property. Returns true if the new value is different from the old value, false if same.

Parameters
new_valueThe new value to store.
Returns
Returns true if new_value is different from current value, false if they are the same.

If the new value is different from the old value, this emits aboutToChange() before changing the value and emits changed() after.

If the value set is an invalid QVariant (QVariant::isValid() returns false), the value will not be editable in a PropertyTreeWidget.

Reimplemented from rviz::Property.

Definition at line 79 of file vector_property.cpp.

◆ setVector()

bool rviz::VectorProperty::setVector ( const Ogre::Vector3 &  vector)
virtual

Definition at line 59 of file vector_property.cpp.

◆ updateFromChildren

void rviz::VectorProperty::updateFromChildren ( )
privateslot

Definition at line 98 of file vector_property.cpp.

◆ updateString()

void rviz::VectorProperty::updateString ( )
private

Definition at line 118 of file vector_property.cpp.

Member Data Documentation

◆ ignore_child_updates_

bool rviz::VectorProperty::ignore_child_updates_
private

Definition at line 80 of file vector_property.h.

◆ vector_

Ogre::Vector3 rviz::VectorProperty::vector_
private

Definition at line 75 of file vector_property.h.

◆ x_

Property* rviz::VectorProperty::x_
private

Definition at line 76 of file vector_property.h.

◆ y_

Property* rviz::VectorProperty::y_
private

Definition at line 77 of file vector_property.h.

◆ z_

Property* rviz::VectorProperty::z_
private

Definition at line 78 of file vector_property.h.


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


rviz
Author(s): Dave Hershberger, David Gossow, Josh Faust
autogenerated on Mon Aug 15 2022 02:05:18