Annotation - Руководство по Вердж3Д - Софт Эйт Софт
Description: Узнайте как использовать Annotation в интерактивных 3Д-веб-приложениях сделанных на Вердж3Д

Object3D → AnnotationControl →

# Annotation

Этот класс используется для создания и отображения 2D HTML спрайтов, называемых аннотациями. Аннотация может содержать необязательный текст в диалоговом окне (или HTML-макет), который появляется, когда пользователь нажимает на метку аннотации.

## Пример

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

## Стили

«Вердж3Д» предлагает 3 класса CSS для определения внешнего вида аннотаций:

- .v3d-annotation — для меток аннотаций.
- .v3d-annotation-transparent — для полупрозрачных метод аннотаций.
- .v3d-annotation-dialog — для диалогов аннотаций.

Вы можете переопределить эти классы в своих собственных приложениях. Для получения дополнительной информации обратитесь к соответствующему разделу:

## Конструктор

### Annotation(container : HTMLElement, character : String, dialogContents : String)

container
  Идентификатор HTML-элемента или сам HTML-элемент, который будет содержать аннотацию.
character
  Символ, отображаемый внутри метки аннотации, например, "1", "2", "3" или "A", "B", "C". Фактически, символ метки может быть строкой любой длины.
dialogContents
  Текст, отображаемый во всплывающем окне аннотации. Это окно появляется, когда пользователь щелкает по аннотации. Он может содержать также текст в формате HTML. Укажите пустую строку, чтобы отключить функцию всплывающего диалогового окна.

## Свойства

Общие свойства смотрите в базовом классе AnnotationControl.

### # .character : String

Символ аннотации.

### # .dialogContents : String

Текст всплывающего диалога аннотации.

### # .annotation : HTMLElement

Элемент метки аннотации (обычно div).

### # .annotationDialog : HTMLElement

Элемент диалогового окна аннотации (обычно div).

### # .annotationDialogVisible : Boolean

Параметр видимости диалогового окна аннотации. Вычисляется методом AnnotationControl.update.

### # .fadeObscured : Boolean

Обесцвечивать (делать полупрозрачной) аннотацию, если она заслонена другими объектами. По умолчанию `true`.

### # .isAnnotation : Boolean

Используется для проверки того, является ли данный или производные классы аннотациями. Вы не должны изменять этот параметр, так как он используется внутри движка для оптимизации.

## Методы

Общие методы смотрите в базовом классе Object3D.

### # .clone() → Annotation

Возвращает клон данного объекта-аннотации и всех его потомков.

### # .dispose()

Удаляет HTML-макет и соответствующие обработчики событий, связанные с аннотацией.

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

Пока не реализовано.

## Пазлы

Используйте следующие пазлы для создания/удаления и открытия/закрытия аннотаций:

- add annotation
- remove annotation
- open annotation
- close annotation

## Исходный файл

О том как получить исходный код этого модуля читайте тут.