pxmlw6n2f/Gazebo_Distributed_TCP/gazebo/gui/AlignWidget.hh

109 lines
3.3 KiB
C++

/*
* Copyright (C) 2014 Open Source Robotics Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
#ifndef _GAZEBO_ALIGN_WIDGET_HH_
#define _GAZEBO_ALIGN_WIDGET_HH_
#include <string>
#include "gazebo/gui/qt.h"
#include "gazebo/util/system.hh"
namespace gazebo
{
namespace gui
{
class AlignWidgetPrivate;
/// \class AlignWidget AlignWidget.hh gui/Gui.hh
/// \brief A gui widget for aligning models
class GZ_GUI_VISIBLE AlignWidget : public QWidget
{
Q_OBJECT
public: enum AlignAxis
{
/// X
ALIGN_X,
/// Y
ALIGN_Y,
/// Z
ALIGN_Z
};
public: enum AlignConfig
{
/// minimum
ALIGN_MIN,
/// center
ALIGN_CENTER,
/// maximum
ALIGN_MAX
};
/// \brief Constructor
/// \param[in] _parent Parent Qt widget.
public: AlignWidget(QWidget *_parent = 0);
/// \brief Destructor
public: virtual ~AlignWidget();
/// \brief Add a Qt alignment action to the widget.
/// \param[in] _axis Axis of alignment.
/// \param[in] _config Alignment configuration.
/// \param[in] _action The Qt alignment action to add.
public: void Add(AlignAxis _axis, AlignConfig _config, QAction *_action);
/// \brief Qt callback when a specific alignment configuration is
/// triggered.
private slots: void OnAlignMode(QString _mode);
/// \brief Qt callback when the align target reference is changed.
/// \param[in] _index Index in a combo box which indicates if alignment
/// is now relative to the 'first' or 'last' selected entity.
private slots: void OnAlignTargetChanged(int _index);
/// \brief Qt callback when the align direction is changed.
/// \param[in] _checked Whether the button was checked or unchecked. False
/// means the default alignment (min to min / max to max), true means
/// min to max.
private slots: void OnDirectionChanged(bool _checked);
/// \brief Helper method to convert axis enum to string
/// \param[in] _axis input alignment axis enum
/// \return axis string
private: std::string GetAxisAsString(AlignAxis _axis);
/// \brief Helper method to convert config enum to string
/// \param[in] _config input alignment config enum
/// \return config string
private: std::string GetConfigAsString(AlignConfig _config);
/// \brief Qt event filter currently used for filtering enter and leave
/// events.
/// param[in] _obj Qt object watched by the event filter
/// param[in] _event Qt event to be filtered.
/// \return True to stop event propagation.
private: bool eventFilter(QObject *_obj, QEvent *_event);
/// \internal
/// \brief Pointer to private data.
private: AlignWidgetPrivate *dataPtr;
};
}
}
#endif