Public Types | Public Member Functions | Protected Slots | Protected Member Functions | Protected Attributes | List of all members
jsk_rviz_plugins::OverlayMenuDisplay Class Reference

#include <overlay_menu_display.h>

Inheritance diagram for jsk_rviz_plugins::OverlayMenuDisplay:
Inheritance graph
[legend]

Public Types

enum  AnimationState { CLOSED, OPENED, OPENING, CLOSING }
 

Public Member Functions

virtual int getX ()
 
virtual int getY ()
 
virtual bool isInRegion (int x, int y)
 
virtual void movePosition (int x, int y)
 
 OverlayMenuDisplay ()
 
virtual void setPosition (int x, int y)
 
virtual ~OverlayMenuDisplay ()
 
- Public Member Functions inherited from rviz::Display
virtual void deleteStatus (const QString &name)
 
void deleteStatusStd (const std::string &name)
 
 Display ()
 
void emitTimeSignal (ros::Time time)
 
QWidget * getAssociatedWidget () const
 
PanelDockWidget * getAssociatedWidgetPanel ()
 
virtual QString getClassId () const
 
Ogre::SceneNode * getSceneNode () const
 
QVariant getViewData (int column, int role) const override
 
Qt::ItemFlags getViewFlags (int column) const override
 
uint32_t getVisibilityBits ()
 
void initialize (DisplayContext *context)
 
bool isEnabled () const
 
void load (const Config &config) override
 
virtual void reset ()
 
void save (Config config) const override
 
void setAssociatedWidget (QWidget *widget)
 
virtual void setClassId (const QString &class_id)
 
void setFixedFrame (const QString &fixed_frame)
 
void setName (const QString &name) override
 
virtual void setStatus (StatusProperty::Level level, const QString &name, const QString &text)
 
void setStatusStd (StatusProperty::Level level, const std::string &name, const std::string &text)
 
virtual void setTopic (const QString &topic, const QString &datatype)
 
void setVisibilityBits (uint32_t bits)
 
void unsetVisibilityBits (uint32_t bits)
 
 ~Display () override
 
- Public Member Functions inherited from rviz::BoolProperty
 BoolProperty (const QString &name=QString(), bool default_value=false, const QString &description=QString(), Property *parent=nullptr, const char *changed_slot=nullptr, QObject *receiver=nullptr)
 
virtual bool getBool () const
 
bool getDisableChildren () override
 
bool getDisableChildrenIfFalse ()
 
void setDisableChildrenIfFalse (bool disable)
 
 ~BoolProperty () override
 
- Public Member Functions inherited from rviz::Property
virtual void addChild (Property *child, int index=-1)
 
Property * childAt (int index) const
 
virtual Property * childAtUnchecked (int index) const
 
virtual void collapse ()
 
bool contains (Property *possible_child) const
 
virtual QWidget * createEditor (QWidget *parent, const QStyleOptionViewItem &option)
 
virtual void expand ()
 
virtual QString getDescription () const
 
virtual bool getHidden () const
 
virtual QIcon getIcon () const
 
PropertyTreeModel * getModel () const
 
virtual QString getName () const
 
std::string getNameStd () const
 
Property * getParent () const
 
virtual bool getReadOnly ()
 
virtual QVariant getValue () const
 
void hide ()
 
void insertChildSorted (Property *child)
 
bool isAncestorOf (Property *possible_child) const
 
virtual void moveChild (int from_index, int to_index)
 
virtual int numChildren () const
 
virtual bool paint (QPainter *painter, const QStyleOptionViewItem &option) const
 
 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)
 
virtual void removeChildren (int start_index=0, int count=-1)
 
int rowNumberInParent () const
 
virtual void setDescription (const QString &description)
 
virtual void setHidden (bool hidden)
 
virtual void setIcon (const QIcon &icon)
 
void setModel (PropertyTreeModel *model)
 
void setParent (Property *new_parent)
 
virtual void setReadOnly (bool read_only)
 
void setShouldBeSaved (bool save)
 
virtual bool setValue (const QVariant &new_value)
 
bool shouldBeSaved () const
 
void show ()
 
virtual Property * subProp (const QString &sub_name)
 
Property * takeChild (Property *child)
 
virtual Property * takeChildAt (int index)
 
 ~Property () override
 

Protected Slots

void updateBGAlpha ()
 
void updateBGColor ()
 
void updateFGAlpha ()
 
void updateFGColor ()
 
void updateKeepCentered ()
 
void updateLeft ()
 
void updateOvertakeBGColorProperties ()
 
void updateOvertakeFGColorProperties ()
 
void updateTop ()
 
void updateTopic ()
 

Protected Member Functions

virtual int drawAreaHeight (const jsk_rviz_plugins::OverlayMenu::ConstPtr &msg)
 
virtual int drawAreaWidth (const jsk_rviz_plugins::OverlayMenu::ConstPtr &msg)
 
virtual QFont font ()
 
virtual QFontMetrics fontMetrics ()
 
virtual std::string getMenuString (const jsk_rviz_plugins::OverlayMenu::ConstPtr &msg, size_t index)
 
virtual bool isNeedToRedraw ()
 
virtual bool isNeedToResize ()
 
virtual void onDisable ()
 
virtual void onEnable ()
 
virtual void onInitialize ()
 
virtual void openingAnimation ()
 
virtual void prepareOverlay ()
 
virtual void processMessage (const jsk_rviz_plugins::OverlayMenu::ConstPtr &msg)
 
virtual void redraw ()
 
virtual void setMenuLocation ()
 
virtual void subscribe ()
 
virtual void unsubscribe ()
 
virtual void update (float wall_dt, float ros_dt)
 
- Protected Member Functions inherited from rviz::Display
virtual void clearStatuses ()
 
virtual void fixedFrameChanged ()
 
bool initialized () const
 
- Protected Member Functions inherited from rviz::Property
void loadValue (const Config &config)
 

Protected Attributes

AnimationState animation_state_
 
double animation_t_
 
rviz::FloatProperty * bg_alpha_property_
 
QColor bg_color_
 
rviz::ColorProperty * bg_color_property_
 
jsk_rviz_plugins::OverlayMenu::ConstPtr current_menu_
 
rviz::FloatProperty * fg_alpha_property_
 
QColor fg_color_
 
rviz::ColorProperty * fg_color_property_
 
bool keep_centered_
 
rviz::BoolProperty * keep_centered_property_
 
int left_
 
rviz::IntProperty * left_property_
 
boost::mutex mutex_
 
jsk_rviz_plugins::OverlayMenu::ConstPtr next_menu_
 
OverlayObject::Ptr overlay_
 
bool overtake_bg_color_properties_
 
rviz::BoolProperty * overtake_bg_color_properties_property_
 
bool overtake_fg_color_properties_
 
rviz::BoolProperty * overtake_fg_color_properties_property_
 
bool require_update_texture_
 
ros::Subscriber sub_
 
int top_
 
rviz::IntProperty * top_property_
 
rviz::RosTopicProperty * update_topic_property_
 
- Protected Attributes inherited from rviz::Display
DisplayContext * context_
 
QString fixed_frame_
 
Ogre::SceneManager * scene_manager_
 
Ogre::SceneNode * scene_node_
 
ros::NodeHandle threaded_nh_
 
ros::NodeHandle update_nh_
 
- Protected Attributes inherited from rviz::Property
bool child_indexes_valid_
 
QIcon icon_
 
PropertyTreeModel * model_
 
QVariant value_
 

Additional Inherited Members

- Public Slots inherited from rviz::Display
virtual void onEnableChanged ()
 
void queueRender ()
 
void setEnabled (bool enabled)
 
void setIcon (const QIcon &icon) override
 
- Public Slots inherited from rviz::BoolProperty
bool setBool (bool value)
 
- Signals inherited from rviz::Display
void timeSignal (ros::Time time, QPrivateSignal)
 
- Signals inherited from rviz::Property
void aboutToChange ()
 
void changed ()
 
void childListChanged (Property *this_property)
 

Detailed Description

Definition at line 60 of file overlay_menu_display.h.

Member Enumeration Documentation

◆ AnimationState

enum jsk_rviz_plugins::OverlayMenuDisplay::AnimationState
Enumerator
CLOSED 
OPENED 
OPENING 
CLOSING 

Definition at line 67 of file overlay_menu_display.h.

Constructor & Destructor Documentation

◆ OverlayMenuDisplay()

jsk_rviz_plugins::OverlayMenuDisplay::OverlayMenuDisplay ( )

Definition at line 56 of file overlay_menu_display.cpp.

◆ ~OverlayMenuDisplay()

jsk_rviz_plugins::OverlayMenuDisplay::~OverlayMenuDisplay ( )
virtual

Definition at line 106 of file overlay_menu_display.cpp.

Member Function Documentation

◆ drawAreaHeight()

int jsk_rviz_plugins::OverlayMenuDisplay::drawAreaHeight ( const jsk_rviz_plugins::OverlayMenu::ConstPtr &  msg)
protectedvirtual

Definition at line 254 of file overlay_menu_display.cpp.

◆ drawAreaWidth()

int jsk_rviz_plugins::OverlayMenuDisplay::drawAreaWidth ( const jsk_rviz_plugins::OverlayMenu::ConstPtr &  msg)
protectedvirtual

Definition at line 235 of file overlay_menu_display.cpp.

◆ font()

QFont jsk_rviz_plugins::OverlayMenuDisplay::font ( )
protectedvirtual

Definition at line 222 of file overlay_menu_display.cpp.

◆ fontMetrics()

QFontMetrics jsk_rviz_plugins::OverlayMenuDisplay::fontMetrics ( )
protectedvirtual

Definition at line 229 of file overlay_menu_display.cpp.

◆ getMenuString()

std::string jsk_rviz_plugins::OverlayMenuDisplay::getMenuString ( const jsk_rviz_plugins::OverlayMenu::ConstPtr &  msg,
size_t  index 
)
protectedvirtual

Definition at line 348 of file overlay_menu_display.cpp.

◆ getX()

virtual int jsk_rviz_plugins::OverlayMenuDisplay::getX ( )
inlinevirtual

Definition at line 79 of file overlay_menu_display.h.

◆ getY()

virtual int jsk_rviz_plugins::OverlayMenuDisplay::getY ( )
inlinevirtual

Definition at line 80 of file overlay_menu_display.h.

◆ isInRegion()

bool jsk_rviz_plugins::OverlayMenuDisplay::isInRegion ( int  x,
int  y 
)
virtual

Definition at line 578 of file overlay_menu_display.cpp.

◆ isNeedToRedraw()

bool jsk_rviz_plugins::OverlayMenuDisplay::isNeedToRedraw ( )
protectedvirtual

Definition at line 344 of file overlay_menu_display.cpp.

◆ isNeedToResize()

bool jsk_rviz_plugins::OverlayMenuDisplay::isNeedToResize ( )
protectedvirtual

Definition at line 183 of file overlay_menu_display.cpp.

◆ movePosition()

void jsk_rviz_plugins::OverlayMenuDisplay::movePosition ( int  x,
int  y 
)
virtual

Definition at line 585 of file overlay_menu_display.cpp.

◆ onDisable()

void jsk_rviz_plugins::OverlayMenuDisplay::onDisable ( )
protectedvirtual

Reimplemented from rviz::Display.

Definition at line 144 of file overlay_menu_display.cpp.

◆ onEnable()

void jsk_rviz_plugins::OverlayMenuDisplay::onEnable ( )
protectedvirtual

Reimplemented from rviz::Display.

Definition at line 136 of file overlay_menu_display.cpp.

◆ onInitialize()

void jsk_rviz_plugins::OverlayMenuDisplay::onInitialize ( )
protectedvirtual

Reimplemented from rviz::Display.

Definition at line 121 of file overlay_menu_display.cpp.

◆ openingAnimation()

void jsk_rviz_plugins::OverlayMenuDisplay::openingAnimation ( )
protectedvirtual

Definition at line 377 of file overlay_menu_display.cpp.

◆ prepareOverlay()

void jsk_rviz_plugins::OverlayMenuDisplay::prepareOverlay ( )
protectedvirtual

Definition at line 360 of file overlay_menu_display.cpp.

◆ processMessage()

void jsk_rviz_plugins::OverlayMenuDisplay::processMessage ( const jsk_rviz_plugins::OverlayMenu::ConstPtr &  msg)
protectedvirtual

Definition at line 168 of file overlay_menu_display.cpp.

◆ redraw()

void jsk_rviz_plugins::OverlayMenuDisplay::redraw ( )
protectedvirtual

Definition at line 405 of file overlay_menu_display.cpp.

◆ setMenuLocation()

void jsk_rviz_plugins::OverlayMenuDisplay::setMenuLocation ( )
protectedvirtual

Definition at line 455 of file overlay_menu_display.cpp.

◆ setPosition()

void jsk_rviz_plugins::OverlayMenuDisplay::setPosition ( int  x,
int  y 
)
virtual

Definition at line 594 of file overlay_menu_display.cpp.

◆ subscribe()

void jsk_rviz_plugins::OverlayMenuDisplay::subscribe ( )
protectedvirtual

Definition at line 157 of file overlay_menu_display.cpp.

◆ unsubscribe()

void jsk_rviz_plugins::OverlayMenuDisplay::unsubscribe ( )
protectedvirtual

Definition at line 152 of file overlay_menu_display.cpp.

◆ update()

void jsk_rviz_plugins::OverlayMenuDisplay::update ( float  wall_dt,
float  ros_dt 
)
protectedvirtual

Reimplemented from rviz::Display.

Definition at line 263 of file overlay_menu_display.cpp.

◆ updateBGAlpha

void jsk_rviz_plugins::OverlayMenuDisplay::updateBGAlpha ( )
protectedslot

Definition at line 570 of file overlay_menu_display.cpp.

◆ updateBGColor

void jsk_rviz_plugins::OverlayMenuDisplay::updateBGColor ( )
protectedslot

Definition at line 559 of file overlay_menu_display.cpp.

◆ updateFGAlpha

void jsk_rviz_plugins::OverlayMenuDisplay::updateFGAlpha ( )
protectedslot

Definition at line 551 of file overlay_menu_display.cpp.

◆ updateFGColor

void jsk_rviz_plugins::OverlayMenuDisplay::updateFGColor ( )
protectedslot

Definition at line 540 of file overlay_menu_display.cpp.

◆ updateKeepCentered

void jsk_rviz_plugins::OverlayMenuDisplay::updateKeepCentered ( )
protectedslot

Definition at line 489 of file overlay_menu_display.cpp.

◆ updateLeft

void jsk_rviz_plugins::OverlayMenuDisplay::updateLeft ( )
protectedslot

Definition at line 477 of file overlay_menu_display.cpp.

◆ updateOvertakeBGColorProperties

void jsk_rviz_plugins::OverlayMenuDisplay::updateOvertakeBGColorProperties ( )
protectedslot

Definition at line 520 of file overlay_menu_display.cpp.

◆ updateOvertakeFGColorProperties

void jsk_rviz_plugins::OverlayMenuDisplay::updateOvertakeFGColorProperties ( )
protectedslot

Definition at line 500 of file overlay_menu_display.cpp.

◆ updateTop

void jsk_rviz_plugins::OverlayMenuDisplay::updateTop ( )
protectedslot

Definition at line 483 of file overlay_menu_display.cpp.

◆ updateTopic

void jsk_rviz_plugins::OverlayMenuDisplay::updateTopic ( )
protectedslot

Definition at line 470 of file overlay_menu_display.cpp.

Member Data Documentation

◆ animation_state_

AnimationState jsk_rviz_plugins::OverlayMenuDisplay::animation_state_
protected

Definition at line 96 of file overlay_menu_display.h.

◆ animation_t_

double jsk_rviz_plugins::OverlayMenuDisplay::animation_t_
protected

Definition at line 102 of file overlay_menu_display.h.

◆ bg_alpha_property_

rviz::FloatProperty* jsk_rviz_plugins::OverlayMenuDisplay::bg_alpha_property_
protected

Definition at line 93 of file overlay_menu_display.h.

◆ bg_color_

QColor jsk_rviz_plugins::OverlayMenuDisplay::bg_color_
protected

Definition at line 105 of file overlay_menu_display.h.

◆ bg_color_property_

rviz::ColorProperty* jsk_rviz_plugins::OverlayMenuDisplay::bg_color_property_
protected

Definition at line 92 of file overlay_menu_display.h.

◆ current_menu_

jsk_rviz_plugins::OverlayMenu::ConstPtr jsk_rviz_plugins::OverlayMenuDisplay::current_menu_
protected

Definition at line 100 of file overlay_menu_display.h.

◆ fg_alpha_property_

rviz::FloatProperty* jsk_rviz_plugins::OverlayMenuDisplay::fg_alpha_property_
protected

Definition at line 95 of file overlay_menu_display.h.

◆ fg_color_

QColor jsk_rviz_plugins::OverlayMenuDisplay::fg_color_
protected

Definition at line 106 of file overlay_menu_display.h.

◆ fg_color_property_

rviz::ColorProperty* jsk_rviz_plugins::OverlayMenuDisplay::fg_color_property_
protected

Definition at line 94 of file overlay_menu_display.h.

◆ keep_centered_

bool jsk_rviz_plugins::OverlayMenuDisplay::keep_centered_
protected

Definition at line 98 of file overlay_menu_display.h.

◆ keep_centered_property_

rviz::BoolProperty* jsk_rviz_plugins::OverlayMenuDisplay::keep_centered_property_
protected

Definition at line 89 of file overlay_menu_display.h.

◆ left_

int jsk_rviz_plugins::OverlayMenuDisplay::left_
protected

Definition at line 99 of file overlay_menu_display.h.

◆ left_property_

rviz::IntProperty* jsk_rviz_plugins::OverlayMenuDisplay::left_property_
protected

Definition at line 87 of file overlay_menu_display.h.

◆ mutex_

boost::mutex jsk_rviz_plugins::OverlayMenuDisplay::mutex_
protected

Definition at line 80 of file overlay_menu_display.h.

◆ next_menu_

jsk_rviz_plugins::OverlayMenu::ConstPtr jsk_rviz_plugins::OverlayMenuDisplay::next_menu_
protected

Definition at line 101 of file overlay_menu_display.h.

◆ overlay_

OverlayObject::Ptr jsk_rviz_plugins::OverlayMenuDisplay::overlay_
protected

Definition at line 84 of file overlay_menu_display.h.

◆ overtake_bg_color_properties_

bool jsk_rviz_plugins::OverlayMenuDisplay::overtake_bg_color_properties_
protected

Definition at line 104 of file overlay_menu_display.h.

◆ overtake_bg_color_properties_property_

rviz::BoolProperty* jsk_rviz_plugins::OverlayMenuDisplay::overtake_bg_color_properties_property_
protected

Definition at line 91 of file overlay_menu_display.h.

◆ overtake_fg_color_properties_

bool jsk_rviz_plugins::OverlayMenuDisplay::overtake_fg_color_properties_
protected

Definition at line 103 of file overlay_menu_display.h.

◆ overtake_fg_color_properties_property_

rviz::BoolProperty* jsk_rviz_plugins::OverlayMenuDisplay::overtake_fg_color_properties_property_
protected

Definition at line 90 of file overlay_menu_display.h.

◆ require_update_texture_

bool jsk_rviz_plugins::OverlayMenuDisplay::require_update_texture_
protected

Definition at line 97 of file overlay_menu_display.h.

◆ sub_

ros::Subscriber jsk_rviz_plugins::OverlayMenuDisplay::sub_
protected

Definition at line 85 of file overlay_menu_display.h.

◆ top_

int jsk_rviz_plugins::OverlayMenuDisplay::top_
protected

Definition at line 99 of file overlay_menu_display.h.

◆ top_property_

rviz::IntProperty* jsk_rviz_plugins::OverlayMenuDisplay::top_property_
protected

Definition at line 88 of file overlay_menu_display.h.

◆ update_topic_property_

rviz::RosTopicProperty* jsk_rviz_plugins::OverlayMenuDisplay::update_topic_property_
protected

Definition at line 86 of file overlay_menu_display.h.

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

jsk_rviz_plugins
Author(s): Kei Okada , Yohei Kakiuchi , Shohei Fujii , Ryohei Ueda
autogenerated on Thu Jun 1 2023 02:45:58