Package guideme.scene.annotation

Class OverlayAnnotation

java.lang.Object

guideme.scene.annotation.SceneAnnotation

guideme.scene.annotation.OverlayAnnotation

All Implemented Interfaces:

guideme.internal.siteexport.ExportableResourceProvider

Direct Known Subclasses:

DiamondAnnotation

public abstract class OverlayAnnotation
extends SceneAnnotation

A SceneAnnotation that renders as part of the user-interface, overlaid on top of the in-world scene.

Constructor Summary

Constructors

Constructor	Description
OverlayAnnotation()

Method Summary

Modifier and Type	Method	Description
abstract LytRect	getBoundingRect(GuidebookScene scene, LytRect viewport)	Returns the bounding rectangle in document layout coordinates, given the scene and viewport.
abstract void	render(GuidebookScene scene, RenderContext context, LytRect viewport)

Methods inherited from class guideme.scene.annotation.SceneAnnotation

exportResources, getTooltip, hasTooltip, isHovered, setHovered, setTooltip, setTooltipContent, setTooltipContent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

OverlayAnnotation

public OverlayAnnotation()

Method Details

getBoundingRect

public abstract LytRect getBoundingRect(GuidebookScene scene,
 LytRect viewport)

Returns the bounding rectangle in document layout coordinates, given the scene and viewport.

render

public abstract void render(GuidebookScene scene,
 RenderContext context,
 LytRect viewport)