rviz::ImageDisplay Class Reference

#include <image_display.h>

Inheritance diagram for rviz::ImageDisplay:

Public Slots
virtual void	updateNormalizeOptions ()
Public Slots inherited from rviz::Display
virtual void	onEnableChanged ()
void	queueRender ()
	Convenience function which calls context_->queueRender(). More...
void	setEnabled (bool enabled)
	Enable or disable this Display. More...
virtual void	setIcon (const QIcon &icon)
	Set the Display's icon. More...
Public Slots inherited from rviz::BoolProperty
bool	setBool (bool value)

Public Member Functions
	ImageDisplay ()
virtual void	onInitialize ()
	Override this function to do subclass-specific initialization. More...
virtual void	reset ()
	Reset display. More...
virtual void	update (float wall_dt, float ros_dt)
	Called periodically by the visualization manager. More...
virtual	~ImageDisplay ()
Public Member Functions inherited from rviz::ImageDisplayBase
	ImageDisplayBase ()
	Constructor. More...
virtual void	setTopic (const QString &topic, const QString &datatype)
	Set the ROS topic to listen to for this display. More...
virtual	~ImageDisplayBase ()
Public Member Functions inherited from rviz::Display
virtual void	deleteStatus (const QString &name)
	Delete the status entry with the given name. This is thread-safe. More...
void	deleteStatusStd (const std::string &name)
	Delete the status entry with the given std::string name. This is thread-safe. More...
	Display ()
void	emitTimeSignal (ros::Time time)
	Emit a time signal that other Displays can synchronize to. More...
QWidget *	getAssociatedWidget () const
	Return the current associated widget, or NULL if there is none. More...
PanelDockWidget *	getAssociatedWidgetPanel ()
	Return the panel containing the associated widget, or NULL if there is none. More...
virtual QString	getClassId () const
	Return the class identifier which was used to create this instance. This version just returns whatever was set with setClassId(). More...
Ogre::SceneNode *	getSceneNode () const
	Return the Ogre::SceneNode holding all 3D scene elements shown by this Display. More...
virtual QVariant	getViewData (int column, int role) const
	Return data appropriate for the given column (0 or 1) and role for this Display. More...
virtual Qt::ItemFlags	getViewFlags (int column) const
	Return item flags appropriate for the given column (0 or 1) for this Display. More...
uint32_t	getVisibilityBits ()
void	initialize (DisplayContext *context)
	Main initialization, called after constructor, before load() or setEnabled(). More...
bool	isEnabled () const
	Return true if this Display is enabled, false if not. More...
virtual void	load (const Config &config)
	Load the settings for this display from the given Config node, which must be a map. More...
virtual void	save (Config config) const
	Write this display to the given Config node. More...
void	setAssociatedWidget (QWidget *widget)
	Associate the given widget with this Display. More...
virtual void	setClassId (const QString &class_id)
	Set the class identifier used to create this instance. Typically this will be set by the factory object which created it. More...
void	setFixedFrame (const QString &fixed_frame)
	Set the fixed frame in this display. More...
void	setName (const QString &name)
	Overridden from Property to set associated widget title to the new name. More...
virtual void	setStatus (StatusProperty::Level level, const QString &name, const QString &text)
	Show status level and text. This is thread-safe. More...
void	setStatusStd (StatusProperty::Level level, const std::string &name, const std::string &text)
	Show status level and text, using a std::string. Convenience function which converts std::string to QString and calls setStatus(). This is thread-safe. More...
void	setVisibilityBits (uint32_t bits)
void	unsetVisibilityBits (uint32_t bits)
virtual	~Display ()
Public Member Functions inherited from rviz::BoolProperty
	BoolProperty (const QString &name=QString(), bool default_value=false, const QString &description=QString(), Property *parent=0, const char *changed_slot=0, QObject *receiver=0)
virtual bool	getBool () const
virtual bool	getDisableChildren ()
	If true, the children of this property should set their ItemIsEnabled flag to false. More...
bool	getDisableChildrenIfFalse ()
void	setDisableChildrenIfFalse (bool disable)
virtual	~BoolProperty ()
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	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...
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=0, const char *changed_slot=0, QObject *receiver=0)
	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...
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...
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. 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...
virtual	~Property ()
	Destructor. Removes this property from its parent's list of children. More...

Protected Member Functions
virtual void	onDisable ()
	Derived classes override this to do the actual work of disabling themselves. More...
virtual void	onEnable ()
	Derived classes override this to do the actual work of enabling themselves. More...
virtual void	processMessage (const sensor_msgs::Image::ConstPtr &msg)
	Implement this to process the contents of a message. More...
Protected Member Functions inherited from rviz::ImageDisplayBase
void	enableTFFilter (std::string &targetFrame)
	Enabling TF filtering by defining a target frame. More...
virtual void	fixedFrameChanged ()
	Called by setFixedFrame(). Override to respond to changes to fixed_frame_. More...
void	incomingMessage (const sensor_msgs::Image::ConstPtr &msg)
	Incoming message callback. Checks if the message pointer is valid, increments messages_received_, then calls processMessage(). More...
void	scanForTransportSubscriberPlugins ()
virtual void	subscribe ()
	ROS topic management. More...
virtual void	unsubscribe ()
Protected Member Functions inherited from rviz::Display
virtual void	clearStatuses ()
	Delete all status children. This is thread-safe. More...
bool	initialized () const
	Returns true if the display has been initialized. More...
Protected Member Functions inherited from rviz::Property
void	loadValue (const Config &config)
	Load the value of this property specifically, not including children. More...

Private Member Functions
void	clear ()
void	updateStatus ()

Private Attributes
bool	got_float_image_
Ogre::SceneManager *	img_scene_manager_
Ogre::SceneNode *	img_scene_node_
Ogre::MaterialPtr	material_
FloatProperty *	max_property_
IntProperty *	median_buffer_size_property_
FloatProperty *	min_property_
BoolProperty *	normalize_property_
RenderPanel *	render_panel_
Ogre::Rectangle2D *	screen_rect_
ROSImageTexture	texture_

Additional Inherited Members
Signals inherited from rviz::Display
void	timeSignal (rviz::Display *display, ros::Time time)
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 Slots inherited from rviz::ImageDisplayBase
void	fillTransportOptionList (EnumProperty *property)
	Fill list of available and working transport options. More...
virtual void	updateQueueSize ()
	Update queue size of tf filter. More...
virtual void	updateTopic ()
	Update topic and resubscribe. More...
Protected Attributes inherited from rviz::ImageDisplayBase
boost::scoped_ptr< image_transport::ImageTransport >	it_
uint32_t	messages_received_
IntProperty *	queue_size_property_
boost::shared_ptr< image_transport::SubscriberFilter >	sub_
std::string	targetFrame_
boost::shared_ptr< tf::MessageFilter< sensor_msgs::Image > >	tf_filter_
RosTopicProperty *	topic_property_
std::string	transport_
std::set< std::string >	transport_plugin_types_
EnumProperty *	transport_property_
BoolProperty *	unreliable_property_
Protected Attributes inherited from rviz::Display
DisplayContext *	context_
	This DisplayContext pointer is the main connection a Display has into the rest of rviz. This is how the FrameManager is accessed, the SelectionManager, etc. When a Display subclass wants to signal that a new render should be done right away, call context_->queueRender(). More...
QString	fixed_frame_
	A convenience variable equal to context_->getFixedFrame(). More...
Ogre::SceneManager *	scene_manager_
	A convenience variable equal to context_->getSceneManager(). More...
Ogre::SceneNode *	scene_node_
	The Ogre::SceneNode to hold all 3D scene elements shown by this Display. More...
ros::NodeHandle	threaded_nh_
	A NodeHandle whose CallbackQueue is run from a different thread than the GUI. More...
ros::NodeHandle	update_nh_
	A NodeHandle whose CallbackQueue is run from the main GUI thread (the "update" thread). 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

Definition at line 63 of file image_display.h.

Constructor & Destructor Documentation

rviz::ImageDisplay::ImageDisplay

(

)

Definition at line 59 of file image_display.cpp.

rviz::ImageDisplay::~ImageDisplay ( )

virtual

Definition at line 134 of file image_display.cpp.

Member Function Documentation

void rviz::ImageDisplay::clear ( )

private

Definition at line 180 of file image_display.cpp.

void rviz::ImageDisplay::onDisable ( )

protectedvirtual

Derived classes override this to do the actual work of disabling themselves.

Reimplemented from rviz::Display.

Definition at line 150 of file image_display.cpp.

void rviz::ImageDisplay::onEnable ( )

protectedvirtual

Derived classes override this to do the actual work of enabling themselves.

Reimplemented from rviz::Display.

Definition at line 144 of file image_display.cpp.

void rviz::ImageDisplay::onInitialize ( )

virtual

Override this function to do subclass-specific initialization.

This is called after vis_manager_ and scene_manager_ are set, and before load() or setEnabled().

setName() may or may not have been called before this.

Reimplemented from rviz::ImageDisplayBase.

Definition at line 77 of file image_display.cpp.

void rviz::ImageDisplay::processMessage ( const sensor_msgs::Image::ConstPtr &  msg )

protectedvirtual

Implement this to process the contents of a message.

This is called by incomingMessage().

Implements rviz::ImageDisplayBase.

Definition at line 233 of file image_display.cpp.

void rviz::ImageDisplay::reset ( )

virtual

Reset display.

Reimplemented from rviz::ImageDisplayBase.

Definition at line 226 of file image_display.cpp.

void rviz::ImageDisplay::update ( float  wall_dt, float  ros_dt  )

virtual

Called periodically by the visualization manager.

Parameters

wall_dt	Wall-clock time, in seconds, since the last time the update list was run through.
ros_dt	ROS time, in seconds, since the last time the update list was run through.

Reimplemented from rviz::Display.

Definition at line 190 of file image_display.cpp.

void rviz::ImageDisplay::updateNormalizeOptions ( )

virtualslot

Definition at line 157 of file image_display.cpp.

void rviz::ImageDisplay::updateStatus ( )

private

Member Data Documentation

bool rviz::ImageDisplay::got_float_image_

private

Definition at line 103 of file image_display.h.

Ogre::SceneManager* rviz::ImageDisplay::img_scene_manager_

private

Definition at line 90 of file image_display.h.

Ogre::SceneNode* rviz::ImageDisplay::img_scene_node_

private

Definition at line 91 of file image_display.h.

Ogre::MaterialPtr rviz::ImageDisplay::material_

private

Definition at line 93 of file image_display.h.

FloatProperty* rviz::ImageDisplay::max_property_

private

Definition at line 101 of file image_display.h.

IntProperty* rviz::ImageDisplay::median_buffer_size_property_

private

Definition at line 102 of file image_display.h.

FloatProperty* rviz::ImageDisplay::min_property_

private

Definition at line 100 of file image_display.h.

BoolProperty* rviz::ImageDisplay::normalize_property_

private

Definition at line 99 of file image_display.h.

RenderPanel* rviz::ImageDisplay::render_panel_

private

Definition at line 97 of file image_display.h.

Ogre::Rectangle2D* rviz::ImageDisplay::screen_rect_

private

Definition at line 92 of file image_display.h.

ROSImageTexture rviz::ImageDisplay::texture_

private

Definition at line 95 of file image_display.h.

---

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

• image_display.h
• image_display.cpp