bpy.ops.gpencil.annotation_add

描述

在当前活动的贝塞尔曲线或2D笔画对象上创建2D Annotations（注解）。

语法

bpy.ops.gpencil.annotation_add(type='POINT', placement='RELATIVE', stroke=None)

参数

• type (string, optional) – Annotation type to create. Enum in ['POINT', 'STRAIGHT_LINE', 'CURVE_LINE', 'ARROW', 'DOUBLE_ARROW', 'CIRCLE', 'ELLIPSE', 'RECTANGLE', 'IMAGE'], (默认值 'POINT').
• placement (string, optional) – Placement mode for the annotation.
  • 'ABSOLUTE': user-defined coordinates from the 3D cursor position.
  • 'RELATIVE': coordinates relative to the starting point of the active GPencil stroke. Enum in ['ABSOLUTE', 'RELATIVE'], (默认值 'RELATIVE').
• stroke (GPencilStroke, optional) – Stroke to parent annotation to.

返回值

• 返回一个 set 对象，表示执行操作的结果。

示例

import bpy

# 获取激活的2D笔划对象 
g_stroke = bpy.context.scene.grease_pencil.layers.active.active_frame.strokes.active

# 创建箭头注解 
bpy.ops.gpencil.annotation_add(type='ARROW', placement='RELATIVE', stroke=g_stroke)

异常

• AttributeError – 当激活的图层没有激活的帧时，或当激活的帧没有笔划时抛出，或者笔划无效。

备注

• 注解默认是相对于选定的笔划的起点。如果您想相对于固定的位置或3D光标创建注释，请使用 'ABSOLUTE' 放置选项。
• 注释不能单独创建。 它必须与一个有效的笔画关联。如果未指定笔画，则需要首先创建笔画。

参考

https://docs.blender.org/api/current/bpy.ops.gpencil.html#bpy.ops.gpencil.annotation_add