rviz::VectorProperty Class Reference

#include <vector_property.h>

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

List of all members.

Public Member Functions

virtual Ogre::Vector3 getVector () const
virtual void load (const YAML::Node &yaml_node)
 Load the value of this property and/or its children from the given YAML node.
virtual void save (YAML::Emitter &emitter)
 Write the value of this property and/or its children to the given YAML emitter.
virtual void setReadOnly (bool read_only)
 Overridden from Property to propagate read-only-ness to children.
virtual bool setValue (const QVariant &new_value)
 Set the new value for this property. Returns true if the new value is different from the old value, false if same.
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=0, const char *changed_slot=0, QObject *receiver=0)

Private Slots

void emitAboutToChange ()
void updateFromChildren ()

Private Member Functions

void updateString ()

Private Attributes

bool ignore_child_updates_
Ogre::Vector3 vector_
Propertyx_
Propertyy_
Propertyz_

Detailed Description

Definition at line 39 of file vector_property.h.


Constructor & Destructor Documentation

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

Definition at line 40 of file vector_property.cpp.


Member Function Documentation

void rviz::VectorProperty::emitAboutToChange (  )  [private, slot]

Definition at line 110 of file vector_property.cpp.

virtual Ogre::Vector3 rviz::VectorProperty::getVector (  )  const [inline, virtual]

Definition at line 51 of file vector_property.h.

void rviz::VectorProperty::load ( const YAML::Node &  yaml_node  )  [virtual]

Load the value of this property and/or its children from the given YAML node.

Reimplemented from rviz::Property.

Definition at line 126 of file vector_property.cpp.

void rviz::VectorProperty::save ( YAML::Emitter &  emitter  )  [virtual]

Write the value of this property and/or its children to the given YAML emitter.

Reimplemented from rviz::Property.

Definition at line 135 of file vector_property.cpp.

void rviz::VectorProperty::setReadOnly ( bool  read_only  )  [virtual]

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

Reimplemented from rviz::Property.

Definition at line 148 of file vector_property.cpp.

bool rviz::VectorProperty::setValue ( const QVariant &  new_value  )  [virtual]

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

Parameters:
new_value The 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.

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

Definition at line 62 of file vector_property.cpp.

void rviz::VectorProperty::updateFromChildren (  )  [private, slot]

Definition at line 98 of file vector_property.cpp.

void rviz::VectorProperty::updateString (  )  [private]

Definition at line 118 of file vector_property.cpp.


Member Data Documentation

Definition at line 73 of file vector_property.h.

Ogre::Vector3 rviz::VectorProperty::vector_ [private]

Definition at line 68 of file vector_property.h.

Definition at line 69 of file vector_property.h.

Definition at line 70 of file vector_property.h.

Definition at line 71 of file vector_property.h.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Defines


rviz
Author(s): Dave Hershberger, Josh Faust
autogenerated on Wed Jun 6 11:25:48 2012