# annotation_helper

Python API: `depthai_nodes.utils.annotation_helper`

## 类

### AnnotationHelper

简化 `dai.ImgAnnotation` 的创建。

调用所需的绘图方法后，调用 `build` 方法创建 `ImgAnnotations` 消息。

#### 方法

##### init

```python
def __init__(viewport_clipper: ViewportClipper | None = None):
```

创建一个空的注释构建器。

参数

 * `viewport_clipper` (`ViewportClipper | None`): 可选的裁剪边界。默认为两个轴上的归一化单位视口 [0, 1]。

##### build

```python
def build(timestamp: timedelta, sequence_num: int) -> dai.ImgAnnotations:
```

创建 ImgAnnotations 消息。

参数

 * `timestamp` (`timedelta`): 消息时间戳
 * `sequence_num` (`int`): 消息序列号

返回

 * `dai.ImgAnnotations`: 创建的 ImgAnnotations 消息

##### draw_circle

```python
def draw_circle(center: Point | dai.Point2f, radius: float, outline_color: ColorRGBA | dai.Color = PRIMARY_COLOR, fill_color: ColorRGBA | None | dai.Color | None = None, thickness: float = 1.0) -> AnnotationHelper:
```

绘制一个圆。

参数

 * `center` (`Point | dai.Point2f`): 圆心
 * `radius` (`float`): 圆的半径
 * `outline_color` (`ColorRGBA | dai.Color`): 轮廓颜色
 * `fill_color` (`ColorRGBA | None | dai.Color | None`): 填充颜色（无填充则为 None）
 * `thickness` (`float`): 轮廓粗细

返回

 * `AnnotationHelper`: self

##### draw_line

```python
def draw_line(pt1: Point | dai.Point2f, pt2: Point | dai.Point2f, color: ColorRGBA | dai.Color = PRIMARY_COLOR, thickness: float = 2.0, clip_to_viewport: bool = False) -> AnnotationHelper:
```

在两点之间绘制一条线。

参数

 * `pt1` (`Point | dai.Point2f`): 线的起点
 * `pt2` (`Point | dai.Point2f`): 线的终点
 * `color` (`ColorRGBA | dai.Color`): 线颜色
 * `thickness` (`float`): 线粗细
 * `clip_to_viewport` (`bool`): 指示是否将线裁剪到视口

返回

 * `AnnotationHelper`: self

##### draw_points

```python
def draw_points(points: list[Point] | list[dai.Point2f] | dai.VectorPoint2f, color: ColorRGBA | dai.Color = PRIMARY_COLOR, thickness: float = 2.0) -> AnnotationHelper:
```

绘制点。

参数

 * `points` (`list[Point] | list[dai.Point2f] | dai.VectorPoint2f`): 要绘制的点列表
 * `color` (`ColorRGBA | dai.Color`): 点的颜色
 * `thickness` (`float`): 点的大小

返回

 * `AnnotationHelper`: self

##### draw_polyline

```python
def draw_polyline(points: list[Point] | list[dai.Point2f], outline_color: ColorRGBA | dai.Color = PRIMARY_COLOR, fill_color: ColorRGBA | None | dai.Color | None = TRANSPARENT_PRIMARY_COLOR, thickness: float = 1.0, closed: bool = False) -> AnnotationHelper:
```

绘制一条折线。

参数

 * `points` (`list[Point] | list[dai.Point2f]`): 折线的点列表
 * `outline_color` (`ColorRGBA | dai.Color`): 轮廓颜色
 * `fill_color` (`ColorRGBA | None | dai.Color | None`): 填充颜色（无填充则为 None）
 * `thickness` (`float`): 线粗细
 * `closed` (`bool`): 如果为 True，则创建多边形而不是折线

返回

 * `AnnotationHelper`: self

##### draw_rectangle

```python
def draw_rectangle(top_left: Point | dai.Point2f, bottom_right: Point | dai.Point2f, outline_color: ColorRGBA | dai.Color = PRIMARY_COLOR, fill_color: ColorRGBA | None | dai.Color | None = TRANSPARENT_PRIMARY_COLOR, thickness: float = 1.0, clip_to_viewport: bool = False) -> AnnotationHelper:
```

绘制一个矩形。

参数

 * `top_left` (`Point | dai.Point2f`): 矩形的左上角
 * `bottom_right` (`Point | dai.Point2f`): 矩形的右下角
 * `outline_color` (`ColorRGBA | dai.Color`): 轮廓颜色
 * `fill_color` (`ColorRGBA | None | dai.Color | None`): 填充颜色（无填充则为 None）
 * `thickness` (`float`): 轮廓粗细
 * `clip_to_viewport` (`bool`): 指示是否将线裁剪到视口

返回

 * `AnnotationHelper`: self

##### draw_rotated_rect

```python
def draw_rotated_rect(center: Point | dai.Point2f, size: tuple[float, float] | dai.Size2f, angle: float, outline_color: ColorRGBA | dai.Color = PRIMARY_COLOR, fill_color: ColorRGBA | None | dai.Color | None = TRANSPARENT_PRIMARY_COLOR, thickness: float = 1.0, clip_to_viewport: bool = False) -> AnnotationHelper:
```

绘制一个旋转的矩形。

参数

 * `center` (`Point | dai.Point2f`): 矩形中心
 * `size` (`tuple[float, float] | dai.Size2f`): 矩形大小（宽度，高度）
 * `angle` (`float`): 旋转角度（度）
 * `outline_color` (`ColorRGBA | dai.Color`): 轮廓颜色
 * `fill_color` (`ColorRGBA | None | dai.Color | None`): 填充颜色（无填充则为 None）
 * `thickness` (`float`): 轮廓粗细
 * `clip_to_viewport` (`bool`): 指示是否将线裁剪到视口

返回

 * `AnnotationHelper`: self

##### draw_text

```python
def draw_text(text: str, position: Point | dai.Point2f, color: ColorRGBA | dai.Color = PRIMARY_COLOR, background_color: ColorRGBA | None | dai.Color | None = None, size: float = 32) -> AnnotationHelper:
```

绘制文本。

参数

 * `text` (`str`): 文本字符串
 * `position` (`Point | dai.Point2f`): 文本位置
 * `color` (`ColorRGBA | dai.Color`): 文本颜色
 * `background_color` (`ColorRGBA | None | dai.Color | None`): 背景颜色（无背景则为 None）
 * `size` (`float`): 文本大小

返回

 * `AnnotationHelper`: self

#### 属性

##### annotation

## 属性

### ColorRGBA

### Point
