This class is used to create and display 2D HTML sprites called annotations. Annotation may contain an optional dialog text (or HTML layout) which appears when the user clicks on the annotation label.


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


Verge3D offers two CSS classes to define annotation look:

You can override these classes in your own applications. For example, to make your annotations red: .v3d-annotation { background: red; } .v3d-annotation-dialog { background: red; }


Annotation(container, character, text)

container - the id of an HTML-element or the HTML-element itself which will contain the annotation.
character - a symbol displayed inside the annotation label e.g "1", "2", "3" or "A", "B", "C". In fact, the label character can be a string of any length.
text - a text displayed in the annotation popup dialog. This dialog appears when the user clicks on the annotation. It may contain HTML formatted text as well. Specify an empty line to disable the popup dialog feature.


See the base AnnotationControl class for common properties.

.character : String

Annotation character.

.text : String

Annotation dialog text.

.annotation : HTMLElement

Annotation label element (usually div).

.annotationText : HTMLElement

Annotation dialog element (usually div).

.annotationTextVisible : Boolean

Annotation dialog visibility flag. Calculated by the update method.

.fadeObscured : Boolean

Fade (make semi-transparent) the annotation if obscured by other objects. Default is true.

.isAnnotation : Boolean

Used to check whether this or derived classes are annotations.
You should not change this, as it is used internally for optimization.


See the base Object3D class for common methods.

.clone () : Annotation

Returns a clone of this Annotation object and any descendants.

.dispose () : null

Removes the HTML layout and the corresponding event listeners.

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

Not implemented yet.


Use add annotation or remove annotation to manage annotations in the Puzzles editor.


For more info on how to obtain the source code of this module see this page.