Package guideme.scene.annotation

Class InWorldAnnotation

java.lang.Object

guideme.scene.annotation.SceneAnnotation

guideme.scene.annotation.InWorldAnnotation

All Implemented Interfaces:

guideme.internal.siteexport.ExportableResourceProvider

Direct Known Subclasses:

InWorldBoxAnnotation, InWorldLineAnnotation

public abstract class InWorldAnnotation
extends SceneAnnotation

A SceneAnnotation that renders in-world.

Constructor Summary

Constructors

Constructor	Description
InWorldAnnotation()

Method Summary

Modifier and Type	Method	Description
abstract org.apache.commons.lang3.tuple.Pair<org.joml.Vector2f,org.joml.Vector2f>	getScreenBounds(org.joml.Matrix4f viewMatrix)
abstract OptionalDouble	intersect(org.joml.Vector3f rayOrigin, org.joml.Vector3f rayDir)	Test intersection between a 3D ray and this in-world annotations shape.
boolean	isAlwaysOnTop()
void	setAlwaysOnTop(boolean alwaysOnTop)

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

InWorldAnnotation

public InWorldAnnotation()

Method Details

intersect

public abstract OptionalDouble intersect(org.joml.Vector3f rayOrigin,
 org.joml.Vector3f rayDir)

Test intersection between a 3D ray and this in-world annotations shape.

Returns:

Absent if no intersection exists, otherwise a number between 0 and 1 indicating the distance from the ray origin (along the ray) that the intersection closest to the origin occurred.

getScreenBounds

public abstract org.apache.commons.lang3.tuple.Pair<org.joml.Vector2f,org.joml.Vector2f> getScreenBounds(org.joml.Matrix4f viewMatrix)

isAlwaysOnTop

public boolean isAlwaysOnTop()

setAlwaysOnTop

public void setAlwaysOnTop(boolean alwaysOnTop)