AuboStudio SDK 0.6.3

Public 类型 | Public 成员函数 | Private 成员函数 | Private 属性 | 友元 | 所有成员列表
arcs::aubo_scope::RenderInterface类 参考

`#include <render_interface.h>`

## 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 ()
void | setRenderEmbeded (bool is_embeded, QGridLayout *gly)
| 设置 Render 窗口嵌入/移除(isEmbeded) 布局 gly 中 更多...
void | setShowOptions (uint16_t options)
| 设置显示模式，控制各种元素的显隐 更多...
void | addPointCloud (const std::string &name, const std::vector< std::vector< double >> &points, const std::vector< double > &color)
| 添加/修改点云 更多...
void | removePointCloud (const std::string &name)
| 移除指定名称的点云 更多...
bool | hasPointCloud (const std::string &name)
| 查找制定名称的点云是否存在 更多...
void | clearPointCloud ()
| 移除所有的点云 更多...
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)
| 添加/修改路点 更多...
void | removeWaypoint (void *wp)
| 移除指定路点 更多...
bool | hasWaypoint (void *wp)
| 查找指定路点是否存在 更多...
void | clearWaypoints ()
| 移除所有的路点 更多...
void | setMoveTrack (void *wp, const std::vector< std::vector< double >> &track)
| 添加/修改指定路点的交融轨迹 更多...
void | setBlendTrack (void *wp, const std::vector< std::vector< double >> &track)
void | setMoveTrack (void *wp, const std::vector< std::vector< double >> &track, const std::vector< double > &color)
void | setBlendTrack (void *wp, const std::vector< std::vector< double >> &track, const std::vector< double > &color)
void | addCoordinate (const std::string &name, const std::vector< double > &pose)
| 添加/修改坐标轴 更多...
void | removeCoordinate (const std::string &name)
| 移除指定坐标轴 更多...
bool | hasCoordinate (const std::string &name)
| 查找指定坐标轴是否存在 更多...
void | addLine (const std::string &name, const std::vector< std::vector< double >> &points, const std::vector< double > &color)
| 添加/修改线 更多...
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)
void | removeLine (const std::string &name)
| 移除指定线 更多...
void | clearLines ()
| 移除所有的线 更多...
void | addPlane (const std::string &name, const std::vector< double > &pose, const std::vector< double > &size, const std::vector< double > &color)
| 添加/修改平面 更多...
void | addPlane (const std::string &name, int link_num, const std::vector< double > &pose, const std::vector< double > &size, const std::vector< double > &color)
void | removePlane (const std::string &name)
| 移除指定平面 更多...
void | clearPlanes ()
| 移除所有的平面 更多...
void | addCube (const std::string &name, const std::vector< double > &pose, const std::vector< double > &size, const std::vector< double > &color, int type=0)
| 添加/修改立方体 更多...
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)
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)
| 添加/修改立方体 更多...
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)
void | removeCube (const std::string &name)
| 移除指定立方体 更多...
void | clearCubes ()
| 移除所有的立方体 更多...
int | addMesh (const std::string &name, int link_num, const std::string &model_path, const std::vector< double > &pose)
| addMesh 添加任意模型文件 更多...
std::vector< std::string > | getMeshes (int link_num)
| getMeshes 获取关节 link_num 的外设模型名字 更多...
int | removeMesh (const std::string &name)
int | clearMeshes (int link_num)

## Private 成员函数
| RenderInterface ()

## Private 属性
void * | d_ { nullptr }

## 友元
class | DataSwitch

## 详细描述

在文件 render_interface.h 第 14 行定义.

## 成员枚举类型说明

## ◆ ShowOptions

enum arcs::aubo_scope::RenderInterface::ShowOptions : uint16_t

枚举值
None |
Ground |
TargetRobot |
RealRobot |
Coordinate |
Track |
Point |
View |
Obstacle |
SafetyPlane |
ToolPosition |
PointCloud |
All |

在文件 render_interface.h 第 17 行定义.

## 构造及析构函数说明

## ◆ RenderInterface() [1/3]

arcs::aubo_scope::RenderInterface::RenderInterface | ( | RenderInterface & | f | ) |

## ◆ RenderInterface() [2/3]

arcs::aubo_scope::RenderInterface::RenderInterface | ( | RenderInterface && | f | ) |

## ◆ ~RenderInterface()

virtual arcs::aubo_scope::RenderInterface::~RenderInterface | ( |  | ) |
| virtual

## ◆ RenderInterface() [3/3]

arcs::aubo_scope::RenderInterface::RenderInterface | ( |  | ) |
| private

## 成员函数说明

## ◆ addCoordinate()

void arcs::aubo_scope::RenderInterface::addCoordinate | ( | const std::string & | name,
|  | const std::vector< double > & | pose
| ) |  |

添加/修改坐标轴

参数

  name | 坐标轴名称
  pose | 位姿 x,y,z,rx,ry,rz

返回值

  无 |

## ◆ addCube() [1/4]

void arcs::aubo_scope::RenderInterface::addCube | ( | const std::string & | name,
|  | const std::vector< double > & | pose,
|  | const std::vector< double > & | size,
|  | const std::vector< double > & | color,
|  | int | type = `0`
| ) |  |

添加/修改立方体

参数

  name | 立方体名称
  link_num | -1: TCP; 0: 底座; 1~6: 关节;
  pose | 位置
  size | 立方体大小（长，宽，高）
  color | 立方体颜色 {r, g, b, a}, 范围是 0.0~1.0
  type | 立方体绘制类型 0 代表画 6 个平面，1 代表只画边框线

返回值

  无 |

## ◆ addCube() [2/4]

void arcs::aubo_scope::RenderInterface::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`
| ) |  |

添加/修改立方体

参数

  name | 立方体名称
  pose | 位置
  length_min |
  length_max |
  width_min |
  width_max |
  height_min |
  height_max |
  color | 立方体颜色 {r, g, b, a}, 范围是 0.0~1.0
  type | 立方体绘制类型 0 代表画 6 个平面，1 代表只画边框线

返回值

  无 |

## ◆ addCube() [3/4]

void arcs::aubo_scope::RenderInterface::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`
| ) |  |

## ◆ addCube() [4/4]

void arcs::aubo_scope::RenderInterface::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`
| ) |  |

## ◆ addLine() [1/2]

void arcs::aubo_scope::RenderInterface::addLine | ( | const std::string & | name,
|  | const std::vector< std::vector< double >> & | points,
|  | const std::vector< double > & | color
| ) |  |

添加/修改线

参数

  name | 线名称
  link_num | -1: TCP; 0: 底座; 1~6: 关节;
  pose | 点的参考坐标系, 默认 6 个 0
  points | 点集合
  color | 线颜色 {r, g, b, a}, 范围是 0.0~1.0

返回值

  无 |

## ◆ addLine() [2/2]

void arcs::aubo_scope::RenderInterface::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
| ) |  |

## ◆ addMesh()

int arcs::aubo_scope::RenderInterface::addMesh | ( | const std::string & | name,
|  | int | link_num,
|  | const std::string & | model_path,
|  | const std::vector< double > & | pose
| ) |  |

addMesh 添加任意模型文件

参数

  name | 唯一标识
  link_num | -1: TCP; 0: 底座; 1~6: 关节;
  model_path | 3ds 文件绝对路径
  pose | 模型文件安装位置 {x, y, z, rx, ry, rz}

返回
  0: 成功; 其他失败

## ◆ addPlane() [1/2]

void arcs::aubo_scope::RenderInterface::addPlane | ( | const std::string & | name,
|  | const std::vector< double > & | pose,
|  | const std::vector< double > & | size,
|  | const std::vector< double > & | color
| ) |  |

添加/修改平面

参数

  name | 平面名称
  link_num | -1: TCP; 0: 底座; 1~6: 关节;
  pose | 位置
  size | 平面大小（长，宽）
  color | 线颜色 {r, g, b, a}, 范围是 0.0~1.0

返回值

  无 |

## ◆ addPlane() [2/2]

void arcs::aubo_scope::RenderInterface::addPlane | ( | const std::string & | name,
|  | int | link_num,
|  | const std::vector< double > & | pose,
|  | const std::vector< double > & | size,
|  | const std::vector< double > & | color
| ) |  |

## ◆ addPointCloud()

void arcs::aubo_scope::RenderInterface::addPointCloud | ( | const std::string & | name,
|  | const std::vector< std::vector< double >> & | points,
|  | const std::vector< double > & | color
| ) |  |

添加/修改点云

参数

  name | 点云名称
  points | 点集合
  color | 点云颜色 rgba

返回
  无

## ◆ addWaypoint()

bool arcs::aubo_scope::RenderInterface::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`
| ) |  |

添加/修改路点

参数

  wp | 代表路点的唯一对象
  pose | 路点位姿 x,y,z,rx,ry,rz
  color | 路点颜色 {r, g, b, a}, 范围是 0.0~1.0
  axis_visible | 路点上是否显示位姿方向箭头

返回值

  true | 成功
  false | 失败

## ◆ clearCubes()

void arcs::aubo_scope::RenderInterface::clearCubes | ( |  | ) |

移除所有的立方体

参数

  无 |

返回值

  无 |

## ◆ clearLines()

void arcs::aubo_scope::RenderInterface::clearLines | ( |  | ) |

移除所有的线

参数

  无 |

返回值

  无 |

## ◆ clearMeshes()

int arcs::aubo_scope::RenderInterface::clearMeshes | ( | int | link_num | ) |

## ◆ clearPlanes()

void arcs::aubo_scope::RenderInterface::clearPlanes | ( |  | ) |

移除所有的平面

参数

  无 |

返回值

  无 |

## ◆ clearPointCloud()

void arcs::aubo_scope::RenderInterface::clearPointCloud | ( |  | ) |

移除所有的点云

参数

  无 |

返回值

  无 |

## ◆ clearWaypoints()

void arcs::aubo_scope::RenderInterface::clearWaypoints | ( |  | ) |

移除所有的路点

参数

  无 |

返回值

  无 |

## ◆ getMeshes()

std::vector<std::string> arcs::aubo_scope::RenderInterface::getMeshes | ( | int | link_num | ) |

getMeshes 获取关节 link_num 的外设模型名字

参数

  link_num | -1: TCP; 0: 底座; 1~6: 关节;

返回
  名字列表

## ◆ hasCoordinate()

bool arcs::aubo_scope::RenderInterface::hasCoordinate | ( | const std::string & | name | ) |

查找指定坐标轴是否存在

参数

  name | 坐标轴名称

返回值

  true | 存在
  false | 不存在

## ◆ hasPointCloud()

bool arcs::aubo_scope::RenderInterface::hasPointCloud | ( | const std::string & | name | ) |

查找制定名称的点云是否存在

参数

  name | 点云名称

返回值

  true | 存在
  false | 不存在

## ◆ hasWaypoint()

bool arcs::aubo_scope::RenderInterface::hasWaypoint | ( | void * | wp | ) |

查找指定路点是否存在

参数

  wp | 代表路点的唯一对象

返回值

  true | 存在
  false | 不存在

## ◆ removeCoordinate()

void arcs::aubo_scope::RenderInterface::removeCoordinate | ( | const std::string & | name | ) |

移除指定坐标轴

参数

  name | 坐标轴名称

返回值

  无 |

## ◆ removeCube()

void arcs::aubo_scope::RenderInterface::removeCube | ( | const std::string & | name | ) |

移除指定立方体

参数

  name | 立方体名称

返回值

  无 |

## ◆ removeLine()

void arcs::aubo_scope::RenderInterface::removeLine | ( | const std::string & | name | ) |

移除指定线

参数

  name | 线名称

返回值

  无 |

## ◆ removeMesh()

int arcs::aubo_scope::RenderInterface::removeMesh | ( | const std::string & | name | ) |

## ◆ removePlane()

void arcs::aubo_scope::RenderInterface::removePlane | ( | const std::string & | name | ) |

移除指定平面

参数

  name | 名称

返回值

  无 |

## ◆ removePointCloud()

void arcs::aubo_scope::RenderInterface::removePointCloud | ( | const std::string & | name | ) |

移除指定名称的点云

参数

  name | 点云名称

返回
  无

## ◆ removeWaypoint()

void arcs::aubo_scope::RenderInterface::removeWaypoint | ( | void * | wp | ) |

移除指定路点

参数

  wp | 代表路点的唯一对象

返回值

  无 |

## ◆ setBlendTrack() [1/2]

void arcs::aubo_scope::RenderInterface::setBlendTrack | ( | void * | wp,
|  | const std::vector< std::vector< double >> & | track
| ) |  |

## ◆ setBlendTrack() [2/2]

void arcs::aubo_scope::RenderInterface::setBlendTrack | ( | void * | wp,
|  | const std::vector< std::vector< double >> & | track,
|  | const std::vector< double > & | color
| ) |  |

## ◆ setMoveTrack() [1/2]

void arcs::aubo_scope::RenderInterface::setMoveTrack | ( | void * | wp,
|  | const std::vector< std::vector< double >> & | track
| ) |  |

添加/修改指定路点的交融轨迹

参数

  wp | 代表路点的唯一对象
  track | 路点位姿 x,y,z,rx,ry,rz 集合

返回值

  无 |

## ◆ setMoveTrack() [2/2]

void arcs::aubo_scope::RenderInterface::setMoveTrack | ( | void * | wp,
|  | const std::vector< std::vector< double >> & | track,
|  | const std::vector< double > & | color
| ) |  |

## ◆ setRenderEmbeded()

void arcs::aubo_scope::RenderInterface::setRenderEmbeded | ( | bool | is_embeded,
|  | QGridLayout * | gly
| ) |  |

设置 Render 窗口嵌入/移除(isEmbeded) 布局 gly 中

参数

  is_embeded | 是否嵌入
  gly | 布局

返回
  无

## ◆ setShowOptions()

void arcs::aubo_scope::RenderInterface::setShowOptions | ( | uint16_t | options | ) |

设置显示模式，控制各种元素的显隐

参数

  options | 选项值，详情查看 ShowOptions 枚举

返回
  无

## 友元及相关函数文档

## ◆ DataSwitch

friend class DataSwitch
| friend

在文件 render_interface.h 第 323 行定义.

## 类成员变量说明

## ◆ d_

void* arcs::aubo_scope::RenderInterface::d_ { nullptr }
| private

在文件 render_interface.h 第 325 行定义.

该类的文档由以下文件生成:

- include/aubo_caps/domain/user_interface/render_interface.h