rviz::VectorProperty Class Reference

#include <vector_property.h>

Inheritance diagram for rviz::VectorProperty:

List of all members.

Public Member Functions
bool	add (const Ogre::Vector3 &offset)
virtual Ogre::Vector3	getVector () const
virtual void	load (const Config &config)
	Load the value of this property and/or its children from the given Config reference.
virtual void	save (Config config) const
	Write the value of this property and/or its children into the given Config reference.
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_
Property *	x_
Property *	y_
Property *	z_

---

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 37 of file vector_property.cpp.

---

Member Function Documentation

bool rviz::VectorProperty::add

(

const Ogre::Vector3 &

offset

)

[inline]

Definition at line 52 of file vector_property.h.

void rviz::VectorProperty::emitAboutToChange

(

)

[private, slot]

Definition at line 107 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 Config &

config

)

[virtual]

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

Reimplemented from rviz::Property.

Definition at line 123 of file vector_property.cpp.

void rviz::VectorProperty::save

(

Config

config

)

const [virtual]

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

Reimplemented from rviz::Property.

Definition at line 137 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 146 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 76 of file vector_property.cpp.

bool rviz::VectorProperty::setVector

(

const Ogre::Vector3 &

vector

)

[virtual]

Definition at line 59 of file vector_property.cpp.

void rviz::VectorProperty::updateFromChildren

(

)

[private, slot]

Definition at line 95 of file vector_property.cpp.

void rviz::VectorProperty::updateString

(

)

[private]

Definition at line 115 of file vector_property.cpp.

---

Member Data Documentation

bool rviz::VectorProperty::ignore_child_updates_ [private]

Definition at line 74 of file vector_property.h.

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

Definition at line 69 of file vector_property.h.

Property* rviz::VectorProperty::x_ [private]

Definition at line 70 of file vector_property.h.

Property* rviz::VectorProperty::y_ [private]

Definition at line 71 of file vector_property.h.

Property* rviz::VectorProperty::z_ [private]

Definition at line 72 of file vector_property.h.

---

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

• vector_property.h
• vector_property.cpp