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

#include <tf_frame_property.h>

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

Public Member Functions

QString getFrame () const
 
FrameManagergetFrameManager () const
 
std::string getFrameStd () const
 
void setFrameManager (FrameManager *frame_manager)
 
bool setValue (const QVariant &new_value) override
 Override from Property to resolve the frame name on the way in. More...
 
 TfFrameProperty (const QString &name=QString(), const QString &default_value=QString(), const QString &description=QString(), Property *parent=nullptr, FrameManager *frame_manager=nullptr, bool include_fixed_frame_string=false, const char *changed_slot=nullptr, QObject *receiver=nullptr)
 
- Public Member Functions inherited from rviz::EditableEnumProperty
virtual void addOption (const QString &option)
 
void addOptionStd (const std::string &option)
 
virtual void clearOptions ()
 
QWidget * createEditor (QWidget *parent, const QStyleOptionViewItem &option) override
 Create an editor widget to edit the value of this property. More...
 
 EditableEnumProperty (const QString &name=QString(), const QString &default_value=QString(), const QString &description=QString(), Property *parent=nullptr, const char *changed_slot=nullptr, QObject *receiver=nullptr)
 
void sortOptions ()
 Sort the option strings. More...
 
- Public Member Functions inherited from rviz::StringProperty
std::string getStdString ()
 
QString getString ()
 
 StringProperty (const QString &name=QString(), const QString &default_value=QString(), 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 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 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 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...
 

Static Public Attributes

static const QString FIXED_FRAME_STRING = "<Fixed Frame>"
 

Private Slots

void fillFrameList ()
 
void handleFixedFrameChange ()
 If this property is currently set to FIXED_FRAME_STRING, this emits changed() to let users know that a call to getFrame() will now return something different. More...
 

Private Attributes

FrameManagerframe_manager_
 
bool include_fixed_frame_string_
 

Additional Inherited Members

- Public Slots inherited from rviz::EditableEnumProperty
virtual void setString (const QString &str)
 
- Public Slots inherited from rviz::StringProperty
bool setStdString (const std::string &std_str)
 
bool setString (const QString &str)
 
- Signals inherited from rviz::EditableEnumProperty
void requestOptions (EditableEnumProperty *property_in_need_of_options)
 requestOptions() is emitted each time createEditor() is called. More...
 
- 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::EditableEnumProperty
QStringList strings_
 
- 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 41 of file tf_frame_property.h.

Constructor & Destructor Documentation

◆ TfFrameProperty()

rviz::TfFrameProperty::TfFrameProperty ( const QString &  name = QString(),
const QString &  default_value = QString(),
const QString &  description = QString(),
Property parent = nullptr,
FrameManager frame_manager = nullptr,
bool  include_fixed_frame_string = false,
const char *  changed_slot = nullptr,
QObject *  receiver = nullptr 
)

Definition at line 40 of file tf_frame_property.cpp.

Member Function Documentation

◆ fillFrameList

void rviz::TfFrameProperty::fillFrameList ( )
privateslot

Definition at line 82 of file tf_frame_property.cpp.

◆ getFrame()

QString rviz::TfFrameProperty::getFrame ( ) const

Definition at line 109 of file tf_frame_property.cpp.

◆ getFrameManager()

FrameManager* rviz::TfFrameProperty::getFrameManager ( ) const
inline

Definition at line 61 of file tf_frame_property.h.

◆ getFrameStd()

std::string rviz::TfFrameProperty::getFrameStd ( ) const

Definition at line 119 of file tf_frame_property.cpp.

◆ handleFixedFrameChange

void rviz::TfFrameProperty::handleFixedFrameChange ( )
privateslot

If this property is currently set to FIXED_FRAME_STRING, this emits changed() to let users know that a call to getFrame() will now return something different.

Definition at line 124 of file tf_frame_property.cpp.

◆ setFrameManager()

void rviz::TfFrameProperty::setFrameManager ( FrameManager frame_manager)

Definition at line 69 of file tf_frame_property.cpp.

◆ setValue()

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

Override from Property to resolve the frame name on the way in.

Reimplemented from rviz::Property.

Definition at line 57 of file tf_frame_property.cpp.

Member Data Documentation

◆ FIXED_FRAME_STRING

const QString rviz::TfFrameProperty::FIXED_FRAME_STRING = "<Fixed Frame>"
static

Definition at line 66 of file tf_frame_property.h.

◆ frame_manager_

FrameManager* rviz::TfFrameProperty::frame_manager_
private

Definition at line 77 of file tf_frame_property.h.

◆ include_fixed_frame_string_

bool rviz::TfFrameProperty::include_fixed_frame_string_
private

Definition at line 78 of file tf_frame_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