AugmentedImage.State

public final class AugmentedImage.State implements Trackable.State

The representation of the current state of an AugmentedImage. An AugmentedImage is represented as a finite 2D bounding box around a centerPose

Summary

Public methods
boolean
equals(Object other)
final @NonNull Pose

the Pose of the center of the detected image's bounding box in the world coordinate space.
final @NonNull FloatSize2d

the dimensions of the bounding box of the detected image
final int

the id of the detected image which correlates to its zero-based positional index from its originating image database
final @NonNull AugmentedImage

self-reference to the object that owns this state
@NonNull TrackingState

whether this image is being tracked or not
int
@NonNull String

Returns a string representation of AugmentedImage.State for debugging.

Public methods

equals

public boolean equals(Object other)

getCenterPose

Added in 1.0.0-beta02
public final @NonNull Pose getCenterPose()

the Pose of the center of the detected image's bounding box in the world coordinate space. The +Y axis relative to the centerPose is equivalent to the normal of the AugmentedImage

getExtents

Added in 1.0.0-beta02
public final @NonNull FloatSize2d getExtents()

the dimensions of the bounding box of the detected image

getIndex

Added in 1.0.0-beta02
public final int getIndex()

the id of the detected image which correlates to its zero-based positional index from its originating image database

getOwner

Added in 1.0.0-beta02
public final @NonNull AugmentedImage getOwner()

self-reference to the object that owns this state

getTrackingState

public @NonNull TrackingState getTrackingState()

whether this image is being tracked or not

hashCode

public int hashCode()

toString

public @NonNull String toString()

Returns a string representation of AugmentedImage.State for debugging.

Note: Not intended for production use.