Annotation - Verge3D 用户手册 - Soft8Soft
Description: 了解如何在使用 Verge3D 制作的交互式 3D 应用程序中使用 Annotation

Object3D → AnnotationControl →

# Annotation

这个类用于创建和显示2D HTML精灵，称为annotation。注释可能包含用户单击注释标签时出现的可选对话框文本(或HTML布局)。

## 示例

`var annotation = new v3d.Annotation(container, 'A', 'Hello! ...'); app.scene.add(annotation);`

## 样式

Verge3D提供了两个类用于定义注释的外观：

- .v3d-annotation - 用于注释的标签。
- .v3d-annotation-dialog - 用于注释的对话框。

可以在自己的应用程序中覆盖这些类。例如，让注释变为红色： `.v3d-annotation { background: red; } .v3d-annotation-dialog { background: red; }`

## 构造函数

### Annotation(container, character, text)

container - 将包含注释的 HTML 元素或 HTML 元素本身的 id。
character - 注释标签内显示的符号，例如“1”、“2”、“3”或“A”、“B”、“C”。实际上，标签字符可以是任意长度的字符串。
text - 注释弹出对话框中显示的文本。当用户单击注释时会出现此对话框。它也可能包含 HTML 格式的文本。指定一个空行以禁用弹出对话框功能。

## 属性

通用属性查看AnnotationControl基类。

### # .character : String

注释字符。

### # .text : String

注释对话框文本。

### # .annotation : HTMLElement

注释标签元素（通常是div）。

### # .annotationText : HTMLElement

注释对话框元素（通常是div）。

### # .annotationTextVisible : Boolean

注释对话框显示标签。 通过update 方法计算。

### # .fadeObscured : Boolean

如果注释被其他物体遮挡，则淡出(使其成为半透明)。默认是true。

### # .isAnnotation : Boolean

用于检查这个类或派生类是否是注释。
不要更改此设置，因为它在内部用于优化。

## 方法

通用方法查看 Object3D基类。

### # .clone() → Annotation

返回此 Annotation 对象和任何后代的克隆。

### # .dispose() → null

删除 HTML 布局和相应的事件侦听器。

### # .raycast(raycaster : Raycaster, intersects : Array) → null

尚未实现。

## 拼图

在拼图编辑器中使用 add annotation 或 remove annotation来控制注释。

## 源代码

关于如何获取此模块的源代码，请查看 本页。