user_interaction.h

浏览该文件的文档.

#ifndef AUBO_SCOPE_USER_INTERACTION_H
#define AUBO_SCOPE_USER_INTERACTION_H
 
#include <vector>
#include <functional>
 
#include <aubo_caps/class_forward.h>
#include <aubo_caps/domain/user_interface/keyboard_manager.h>
#include <aubo_caps/domain/user_interface/render_interface.h>
#include <aubo_caps/domain/user_interface/popup_manager.h>
 
namespace arcs {
namespace aubo_scope {
 
ARCS_CLASS_FORWARD(UserInteraction);
ARCS_CLASS_FORWARD(TCP);
 
using RobotPositionCallback = std::function<void(
    bool accepted, const std::vector<double> &pose,
    const std::vector<double> &q, const std::vector<double> &offset)>;
using RobotMovementCallback = std::function<void(bool accepted, int error)>;
 
/**
 * @ingroup UserInterfaceApi
 * \chinese
 * 用户交互接口
 * 此接口提供向终端用户请求输入或操作的功能。
 * \endchinese
 * \english
 * UserInteraction
 * This interface provides functionality for requesting input or actions from
 * end users.
 * \endenglish
 */
class ARCS_ABI_EXPORT UserInteraction
{
public:
    UserInteraction(UserInteraction &f);
    UserInteraction(UserInteraction &&f);
    virtual ~UserInteraction();
 
    /**
     * @ingroup UserInteraction
     * <p>
     * Request the end user to use the robot to define a robot position.
     * Override the
     * {@link RobotPositionCallback2#onOk(PositionParameters)} method to execute
     * code once the end user is done. Optionally override the {@link
     * RobotPositionCallback2#onCancel()} method to execute code if the end user
     * cancels the operation.
     * </p>
     *
     * <p>
     * This method is asynchronous, i.e. the method will return immediately.
     * Only when the end user is done, either
     * {@link RobotPositionCallback2#onOk(PositionParameters)} or {@link
     * RobotPositionCallback2#onCancel()} will be called.
     * </p>
     *
     * NOTE: This functionality should not be used in a toolbar contribution
     * (see {@link ToolbarService}).
     *
     * @param callback the instance callbacks will be made to.
     */
    void getUserDefinedRobotPosition(RobotPositionCallback callback);
 
    /**
     * @ingroup UserInteraction
     * \chinese
     * 指定 tcpOffset 获取用户定义的机器人位置
     *
     * @param tcpOffset TCP 偏移量
     * @param callback 回调函数
     * \endchinese
     * \english
     * Request the end user to define a robot position with specified tcpOffset.
     *
     * @param tcpOffset
     * @param callback
     * \endenglish
     */
    void getUserDefinedRobotPosition(const std::vector<double> &tcpOffset,
                                     RobotPositionCallback callback);
 
    /**
     * @ingroup UserInteraction
     * \chinese
     * 指定 tcpOffset 字符串获取用户定义的机器人位置
     *
     * @param tcpOffset TCP 偏移量名称
     * @param callback 回调函数
     * \endchinese
     * \english
     * Request the end user to define a robot position with specified tcpOffset string.
     *
     * @param tcpOffset
     * @param callback
     * \endenglish
     */
    void getUserDefinedRobotPosition(const std::string &tcpOffset,
                                     RobotPositionCallback callback);
 
    /**
     * @ingroup UserInteraction
     * \chinese
     * 指定 TCP 对象获取用户定义的机器人位置
     *
     * @param tcpOffset TCP 对象
     * @param callback 回调函数
     * \endchinese
     * \english
     * Request the end user to define a robot position with specified TCP object.
     *
     * @param tcpOffset
     * @param callback
     * \endenglish
     */
    void getUserDefinedRobotPosition(const TCPPtr tcpOffset,
                                     RobotPositionCallback callback);
 
    /**
     * @ingroup UserInteraction
     * <p>
     * This method provides a factory for creating keyboard inputs which are
     * used to configure a virtual keyboard/keypad and to request it to be
     * displayed for a Qt GUI component.
     * </p>
     *
     * NOTE: This functionality is only relevant for AuboCap nodes with a
     * Qt-based user interface (see {@link ProgramNodeService},
     * {@link InstallationNodeService} and {@link ToolbarService}).
     *
     * @return factory providing access to keyboard inputs.
     */
    KeyboardManagerPtr getKeyboardManager();
 
    /**
     * @ingroup UserInteraction
     * <p>
     * Transition to the move tab widget to allow/request the end user to move
     * the robot (either automatically or manually) to a desired target position
     * specified by joint positions.
     * </p>
     *
     * <p>
     * The Automove function will move the robot to the target joint positions
     * linearly in joint space.
     * </p>
     *
     * <b>NOTE:</b> This method does not take the currently active TCP offset
     * into account, i.e. the Automove function will have the specified joint
     * positions as target.
     *
     * @param q The target joint positions to move to.
     * @param callback The instance which callbacks will be made to.
     * @throws IllegalStateException If the plugin screen is not active
     * (visible).
     */
    int requestUserToMoveJoint(const std::vector<double> &q,
                               RobotMovementCallback callback);
    /**
     * @ingroup UserInteraction
     * @brief requestUserToMoveJoint
     * @param q
     * @param callback
     * @return
     */
    int requestUserToMoveJoint(const std::string &q,
                               RobotMovementCallback callback);
    /**
     * @ingroup UserInteraction
     * @param pose The target pose the robot TCP will move to.
     * @param q The reference joint Angle.
     * @param callback The instance which callbacks will be made to.
     * @throws IllegalStateException If the plugin screen is not active
     * (visible).
     */
    int requestUserToMoveJoint(const std::vector<double> &pose,
                               const std::vector<double> &q,
                               RobotMovementCallback callback);
 
    /**
     * @ingroup UserInteraction
     * <p>
     * Transition to the move tab widget to allow/request the end user to move
     * the robot (either automatically or manually) to a desired target position
     * specified by a pose.
     * </p>
     *
     * <p>
     * The Automove function will move the robot TCP to the target position
     * linearly in Cartesian space. If this it not possible, the robot will move
     * to the target linearly in joint space.
     * </p>
     *
     * The current joint positions of the robot will be used as starting point
     * for inverse kinematics to calculate a target joint vector corresponding
     * to desired pose, taking the currently active TCP offset into account.
     *
     * @param pose The target pose the robot TCP will move to.
     * @param callback The instance which callbacks will be made to.
     * @throws IllegalStateException If the plugin screen is not active
     * (visible).
     */
    QT_DEPRECATED int requestUserToMoveLine(const std::vector<double> &pose,
                                            RobotMovementCallback callback);
 
    /**
     * @ingroup UserInteraction
     * <p>
     * Transition to the move tab widget to allow/request the end user to move
     * the robot (either automatically or manually) to a desired target position
     * specified by a pose.
     * </p>
     *
     * <p>
     * The Automove function will move the robot TCP to the target position
     * linearly in Cartesian space. If this it not possible, the robot will move
     * to the target linearly in joint space.
     * </p>
     *
     * The current joint positions of the robot will be used as starting point
     * for inverse kinematics to calculate a target joint vector corresponding
     * to desired pose, taking the currently active TCP offset into account.
     *
     * @param pose The target pose the robot TCP will move to.
     * @param tcpOffset
     * @param callback The instance which callbacks will be made to.
     * @throws IllegalStateException If the plugin screen is not active
     * (visible).
     */
    int requestUserToMoveLine(const std::vector<double> &pose,
                              const std::vector<double> &tcpOffset,
                              RobotMovementCallback callback);
 
    /**
     * @ingroup UserInteraction
     * \chinese
     * 获取机器人缩略图
     *
     * @param q 关节角度
     * @param pose 位姿
     * @return 机器人缩略图
     * \endchinese
     * \english
     * Get robot thumbnail.
     *
     * @param q joint angles
     * @param pose pose
     * @return robot thumbnail
     * \endenglish
     */
    QPixmap *getRobotThumb(const std::vector<double> &q,
                           const std::vector<double> &pose);
 
    /**
     * @ingroup UserInteraction
     * \chinese
     * @brief setOperationLogDisplayName 设置操作日志显示名称
     * @param pbn 界面按钮
     * @param name 显示名称
     * \endchinese
     * \english
     * @brief setOperationLogDisplayName
     * @param pbn
     * @param name
     * \endenglish
     */
    void setOperationLogDisplayName(QWidget *pbn, const std::string &name);
 
    /**
     * @ingroup UserInteraction
     * @return This method provides robot model drawing objects.
     */
    RenderInterfacePtr getRenderInterface();
 
    /**
     * @return This method provides popup manager.
     */
    PopupManagerPtr getPopupManager();
 
private:
    friend class DataSwitch;
    UserInteraction();
    void *d_{ nullptr };
};
 
} // namespace aubo_scope
} // namespace arcs
 
#endif // USERINTERACTION_H