render_interface.h

Go to the documentation of this file.

#ifndef AUBO_CAPS_INTERFACE_RENDER_INTERFACE_H
#define AUBO_CAPS_INTERFACE_RENDER_INTERFACE_H
 
#include <vector>
#include <aubo_caps/class_forward.h>
 
class QGridLayout;
 
namespace arcs {
namespace aubo_scope {
 
ARCS_CLASS_FORWARD(RenderInterface);
 
/**
 * @ingroup UserInterfaceApi
 * \chinese
 * 渲染接口
 * 提供 3D 渲染相关的显示选项控制，包括地面、机器人模型、坐标系、轨迹和点等元素的
 * 显示/隐藏。
 * \endchinese
 * \english
 * RenderInterface
 * Provides display option controls related to 3D rendering, including show/hide
 * of ground, robot models, coordinate systems, trajectories and points.
 * \endenglish
 */
 
class ARCS_ABI_EXPORT RenderInterface
{
public:
    enum ShowOptions : uint16_t
    {
        None = 0,
        Ground = 0x01,
        TargetRobot = 0x02,
        RealRobot = 0x04,
        Coordinate = 0x08,
        Track = 0x10,
        Point = 0x20,
        View = 0x40,
        Obstacle = 0x80,
        SafetyPlane = 0x0100,
        ToolPosition = 0x0200,
        PointCloud = 0x0400,
        All = 0xFFFF,
    };
 
public:
    RenderInterface(RenderInterface &f);
    RenderInterface(RenderInterface &&f);
    virtual ~RenderInterface();
 
    /**
     * @ingroup RenderInterface
     * \chinese
     * 设置 Render 窗口嵌入/移除(isEmbeded) 布局 gly 中
     *
     * @param is_embeded 是否嵌入
     * @param gly 布局
     * \endchinese
     * \english
     * Set the render window to be embedded/removed in the layout gly.
     *
     * @param is_embeded whether to embed
     * @param gly the layout
     * \endenglish
     */
    void setRenderEmbeded(bool is_embeded, QGridLayout *gly);
 
    /**
     * @ingroup RenderInterface
     * \chinese
     * 设置显示模式，控制各种元素的显隐
     *
     * @param options 选项值，详情查看 ShowOptions 枚举
     * \endchinese
     * \english
     * Set the display mode to control the visibility of various elements.
     *
     * @param options option value, see ShowOptions enum for details
     * \endenglish
     */
    void setShowOptions(uint16_t options);
 
    /**
     * @ingroup RenderInterface
     * \chinese
     * 添加/修改点云
     *
     * @param name 点云名称
     * @param points 点集合
     * @param color 点云颜色 rgba
     * \endchinese
     * \english
     * Add/modify point cloud.
     *
     * @param name point cloud name
     * @param points point collection
     * @param color point cloud color rgba
     * \endenglish
     */
    void addPointCloud(const std::string &name,
                       const std::vector<std::vector<double>> &points,
                       const std::vector<double> &color);
 
    /**
     * @ingroup RenderInterface
     * \chinese
     * 移除指定名称的点云
     *
     * @param name 点云名称
     * \endchinese
     * \english
     * Remove the point cloud with the specified name.
     *
     * @param name point cloud name
     * \endenglish
     */
    void removePointCloud(const std::string &name);
 
    /**
     * @ingroup RenderInterface
     * \chinese
     * 查找指定名称的点云是否存在
     *
     * @param name 点云名称
     * @retval true 存在
     * @retval false 不存在
     * \endchinese
     * \english
     * Check whether the point cloud with the specified name exists.
     *
     * @param name point cloud name
     * @retval true exists
     * @retval false does not exist
     * \endenglish
     */
    bool hasPointCloud(const std::string &name);
 
    /**
     * @ingroup RenderInterface
     * \chinese
     * 移除所有的点云
     * \endchinese
     * \english
     * Remove all point clouds.
     * \endenglish
     */
    void clearPointCloud();
 
    /**
     * @ingroup RenderInterface
     * \chinese
     * 添加/修改路点
     *
     * @param wp 代表路点的唯一对象
     * @param pose 路点位姿 x,y,z,rx,ry,rz
     * @param color 路点颜色 {r, g, b, a},  范围是 0.0~1.0
     * @param axis_visible 路点上是否显示位姿方向箭头
     * @retval true 成功
     * @retval false 失败
     * \endchinese
     * \english
     * Add/modify waypoint.
     *
     * @param wp the unique object representing the waypoint
     * @param pose waypoint pose x,y,z,rx,ry,rz
     * @param color waypoint color {r, g, b, a}, range 0.0~1.0
     * @param axis_visible whether to show pose direction arrows on the waypoint
     * @retval true success
     * @retval false failure
     * \endenglish
     */
    bool addWaypoint(void *wp, const std::vector<double> &pose,
                     const std::vector<double> &color = { 0.0, 1.0, 0.0, 1.0 },
                     bool axis_visible = false);
 
    /**
     * @ingroup RenderInterface
     * \chinese
     * 移除指定路点
     *
     * @param wp 代表路点的唯一对象
     * \endchinese
     * \english
     * Remove the specified waypoint.
     *
     * @param wp the unique object representing the waypoint
     * \endenglish
     */
    void removeWaypoint(void *wp);
 
    /**
     * @ingroup RenderInterface
     * \chinese
     * 查找指定路点是否存在
     *
     * @param wp 代表路点的唯一对象
     * @retval true 存在
     * @retval false 不存在
     * \endchinese
     * \english
     * Check whether the specified waypoint exists.
     *
     * @param wp the unique object representing the waypoint
     * @retval true exists
     * @retval false does not exist
     * \endenglish
     */
    bool hasWaypoint(void *wp);
 
    /**
     * @ingroup RenderInterface
     * \chinese
     * 移除所有的路点
     * \endchinese
     * \english
     * Remove all waypoints.
     * \endenglish
     */
    void clearWaypoints();
 
    /**
     * @ingroup RenderInterface
     * \chinese
     * 添加/修改指定路点的交融轨迹
     *
     * @param wp 代表路点的唯一对象
     * @param track 路点位姿 x,y,z,rx,ry,rz 集合
     * \endchinese
     * \english
     * Add/modify the move track for the specified waypoint.
     *
     * @param wp the unique object representing the waypoint
     * @param track waypoint pose collection x,y,z,rx,ry,rz
     * \endenglish
     */
    void setMoveTrack(void *wp, const std::vector<std::vector<double>> &track);
 
    /**
     * @ingroup RenderInterface
     * \chinese
     * @brief setBlendTrack 设置混合轨迹
     * @param wp 路点对象
     * @param track 轨迹集合
     * \endchinese
     * \english
     * @brief setBlendTrack
     * @param wp
     * @param track
     * \endenglish
     */
    void setBlendTrack(void *wp, const std::vector<std::vector<double>> &track);
 
    /**
     * @ingroup RenderInterface
     * \chinese
     * @brief setMoveTrack 设置移动轨迹
     * @param wp 路点对象
     * @param track 轨迹集合
     * @param color 颜色
     * \endchinese
     * \english
     * @brief setMoveTrack
     * @param wp
     * @param track
     * @param color
     * \endenglish
     */
    void setMoveTrack(void *wp, const std::vector<std::vector<double>> &track,
                      const std::vector<double> &color);
 
    /**
     * @ingroup RenderInterface
     * \chinese
     * @brief setBlendTrack 设置混合轨迹
     * @param wp 路点对象
     * @param track 轨迹集合
     * @param color 颜色
     * \endchinese
     * \english
     * @brief setBlendTrack
     * @param wp
     * @param track
     * @param color
     * \endenglish
     */
    void setBlendTrack(void *wp, const std::vector<std::vector<double>> &track,
                       const std::vector<double> &color);
 
    /**
     * @ingroup RenderInterface
     * \chinese
     * 添加/修改坐标轴
     *
     * @param name 坐标轴名称
     * @param pose 位姿 x,y,z,rx,ry,rz
     * \endchinese
     * \english
     * Add/modify coordinate axis.
     *
     * @param name coordinate name
     * @param pose pose x,y,z,rx,ry,rz
     * \endenglish
     */
    void addCoordinate(const std::string &name,
                       const std::vector<double> &pose);
 
    /**
     * @ingroup RenderInterface
     * \chinese
     * 移除指定坐标轴
     *
     * @param name 坐标轴名称
     * \endchinese
     * \english
     * Remove the specified coordinate axis.
     *
     * @param name coordinate name
     * \endenglish
     */
    void removeCoordinate(const std::string &name);
 
    /**
     * @ingroup RenderInterface
     * \chinese
     * 查找指定坐标轴是否存在
     *
     * @param name 坐标轴名称
     * @retval true 存在
     * @retval false 不存在
     * \endchinese
     * \english
     * Check whether the specified coordinate axis exists.
     *
     * @param name coordinate name
     * @retval true exists
     * @retval false does not exist
     * \endenglish
     */
    bool hasCoordinate(const std::string &name);
 
    /**
     * @ingroup RenderInterface
     * \chinese
     * 添加/修改线
     *
     * @param name 线名称
     * @param link_num: -1: TCP; 0: 底座; 1~6: 关节;
     * @param pose: 点的参考坐标系, 默认 6 个 0
     * @param points 点集合
     * @param color 线颜色 {r, g, b, a}, 范围是 0.0~1.0
     * \endchinese
     * \english
     * Add/modify line.
     *
     * @param name line name
     * @param link_num: -1: TCP; 0: base; 1~6: joints;
     * @param pose: reference coordinate system for points, default 6 zeros
     * @param points point collection
     * @param color line color {r, g, b, a}, range 0.0~1.0
     * \endenglish
     */
    void addLine(const std::string &name,
                 const std::vector<std::vector<double>> &points,
                 const std::vector<double> &color);
 
    /**
     * @ingroup RenderInterface
     * \chinese
     * @brief addLine 添加线
     * @param name 线名称
     * @param link_num 关节编号
     * @param pose 位姿
     * @param points 点集合
     * @param color 颜色
     * \endchinese
     * \english
     * @brief addLine
     * @param name
     * @param link_num
     * @param pose
     * @param points
     * @param color
     * \endenglish
     */
    void addLine(const std::string &name, int link_num,
                 const std::vector<double> &pose,
                 const std::vector<std::vector<double>> &points,
                 const std::vector<double> &color);
 
    /**
     * @ingroup RenderInterface
     * \chinese
     * 移除指定线
     *
     * @param name 线名称
     * \endchinese
     * \english
     * Remove the specified line.
     *
     * @param name line name
     * \endenglish
     */
    void removeLine(const std::string &name);
 
    /**
     * @ingroup RenderInterface
     * \chinese
     * 移除所有的线
     * \endchinese
     * \english
     * Remove all lines.
     * \endenglish
     */
    void clearLines();
 
    /**
     * @ingroup RenderInterface
     * \chinese
     * 添加/修改平面
     *
     * @param name 平面名称
     * @param link_num: -1: TCP; 0: 底座; 1~6: 关节;
     * @param pose 位置
     * @param size 平面大小（长，宽）
     * @param color 线颜色 {r, g, b, a}, 范围是 0.0~1.0
     * \endchinese
     * \english
     * Add/modify plane.
     *
     * @param name plane name
     * @param link_num: -1: TCP; 0: base; 1~6: joints;
     * @param pose position
     * @param size plane size (length, width)
     * @param color color {r, g, b, a}, range 0.0~1.0
     * \endenglish
     */
    void addPlane(const std::string &name, const std::vector<double> &pose,
                  const std::vector<double> &size,
                  const std::vector<double> &color);
 
    /**
     * @ingroup RenderInterface
     * \chinese
     * @brief addPlane 添加平面
     * @param name 平面名称
     * @param link_num 关节编号
     * @param pose 位姿
     * @param size 大小
     * @param color 颜色
     * \endchinese
     * \english
     * @brief addPlane
     * @param name
     * @param link_num
     * @param pose
     * @param size
     * @param color
     * \endenglish
     */
    void addPlane(const std::string &name, int link_num,
                  const std::vector<double> &pose,
                  const std::vector<double> &size,
                  const std::vector<double> &color);
 
    /**
     * @ingroup RenderInterface
     * \chinese
     * 移除指定平面
     *
     * @param name 名称
     * \endchinese
     * \english
     * Remove the specified plane.
     *
     * @param name plane name
     * \endenglish
     */
    void removePlane(const std::string &name);
 
    /**
     * @ingroup RenderInterface
     * \chinese
     * 移除所有的平面
     * \endchinese
     * \english
     * Remove all planes.
     * \endenglish
     */
    void clearPlanes();
 
    /**
     * @ingroup RenderInterface
     * \chinese
     * 添加/修改立方体
     *
     * @param name 立方体名称
     * @param link_num: -1: TCP; 0: 底座; 1~6: 关节;
     * @param pose 位置
     * @param size 立方体大小（长，宽，高）
     * @param color 立方体颜色 {r, g, b, a}, 范围是 0.0~1.0
     * @param type 立方体绘制类型  0 代表画 6 个平面，1 代表只画边框线
     * \endchinese
     * \english
     * Add/modify cube.
     *
     * @param name cube name
     * @param link_num: -1: TCP; 0: base; 1~6: joints;
     * @param pose position
     * @param size cube size (length, width, height)
     * @param color cube color {r, g, b, a}, range 0.0~1.0
     * @param type cube rendering type: 0 for 6 planes, 1 for wireframe
     * \endenglish
     */
    void addCube(const std::string &name, const std::vector<double> &pose,
                 const std::vector<double> &size,
                 const std::vector<double> &color, int type = 0);
    /**
     * @ingroup RenderInterface
     * \chinese
     * @brief addCube 添加立方体
     * @param name 立方体名称
     * @param link_num 关节编号
     * @param pose 位姿
     * @param size 大小
     * @param color 颜色
     * @param type 类型
     * \endchinese
     * \english
     * @brief addCube
     * @param name
     * @param link_num
     * @param pose
     * @param size
     * @param color
     * @param type
     * \endenglish
     */
    void addCube(const std::string &name, int link_num,
                 const std::vector<double> &pose,
                 const std::vector<double> &size,
                 const std::vector<double> &color, int type = 0);
 
    /**
     * @ingroup RenderInterface
     * \chinese
     * 添加/修改立方体（带尺寸范围）
     *
     * @param name 立方体名称
     * @param pose 位置
     * @param length_min 最小长度
     * @param length_max 最大长度
     * @param width_min 最小宽度
     * @param width_max 最大宽度
     * @param height_min 最小高度
     * @param height_max 最大高度
     * @param color 立方体颜色 {r, g, b, a}, 范围是 0.0~1.0
     * @param type 立方体绘制类型  0 代表画 6 个平面，1 代表只画边框线
     * \endchinese
     * \english
     * Add/modify cube with size ranges.
     *
     * @param name cube name
     * @param pose position
     * @param length_min
     * @param length_max
     * @param width_min
     * @param width_max
     * @param height_min
     * @param height_max
     * @param color cube color {r, g, b, a}, range 0.0~1.0
     * @param type cube rendering type: 0 for 6 planes, 1 for wireframe
     * \endenglish
     */
    void addCube(const std::string &name, const std::vector<double> &pose,
                 float length_min, float length_max, float width_min,
                 float width_max, float height_min, float height_max,
                 const std::vector<double> &color, int type = 0);
 
    /**
     * @ingroup RenderInterface
     * \chinese
     * @brief addCube 添加立方体
     * @param name 立方体名称
     * @param link_num 关节编号
     * @param pose 位姿
     * @param length_min 最小长度
     * @param length_max 最大长度
     * @param width_min 最小宽度
     * @param width_max 最大宽度
     * @param height_min 最小高度
     * @param height_max 最大高度
     * @param color 颜色
     * @param type 类型
     * \endchinese
     * \english
     * @brief addCube
     * @param name
     * @param link_num
     * @param pose
     * @param length_min
     * @param length_max
     * @param width_min
     * @param width_max
     * @param height_min
     * @param height_max
     * @param color
     * @param type
     * \endenglish
     */
    void addCube(const std::string &name, int link_num,
                 const std::vector<double> &pose, float length_min,
                 float length_max, float width_min, float width_max,
                 float height_min, float height_max,
                 const std::vector<double> &color, int type = 0);
 
    /**
     * @ingroup RenderInterface
     * \chinese
     * 移除指定立方体
     *
     * @param name 立方体名称
     * \endchinese
     * \english
     * Remove the specified cube.
     *
     * @param name cube name
     * \endenglish
     */
    void removeCube(const std::string &name);
 
    /**
     * @ingroup RenderInterface
     * \chinese
     * 移除所有的立方体
     * \endchinese
     * \english
     * Remove all cubes.
     * \endenglish
     */
    void clearCubes();
 
    // 模型文件
    /**
     * @ingroup RenderInterface
     * @brief addMesh 添加任意模型文件
     * @param name: 唯一标识
     * @param link_num: -1: TCP; 0: 底座; 1~6: 关节;
     * @param model_path: 3ds 文件绝对路径
     * @param pose: 模型文件安装位置 {x, y, z, rx, ry, rz}
     * @return 0: 成功; 其他失败
     */
    int addMesh(const std::string &name, int link_num,
                const std::string &model_path, const std::vector<double> &pose);
 
    /**
     * @ingroup RenderInterface
     * @brief getMeshes 获取关节 link_num 的外设模型名字
     * @param link_num: -1: TCP; 0: 底座; 1~6: 关节;
     * @return 名字列表
     */
    std::vector<std::string> getMeshes(int link_num);
 
    /**
     * @ingroup RenderInterface
     * @brief removeMesh
     * @param name
     * @return
     */
    int removeMesh(const std::string &name);
 
    /**
     * @ingroup RenderInterface
     * @brief clearMeshes
     * @param link_num
     * @return
     */
    int clearMeshes(int link_num);
 
private:
    friend class DataSwitch;
    RenderInterface();
    void *d_{ nullptr };
};
 
} // namespace aubo_scope
} // namespace arcs
 
#endif // AUBO_CAPS_INTERFACE_RENDER_INTERFACE_H