Class ImageTarget

Namespace

easyar

Assembly

EasyAR.Sense.dll

ImageTarget represents a target for a planar image, which can be tracked by `ImageTracker`_. Values in ImageTarget must first be filled by create... methods before they can be read. Then, after it is successfully loaded into `ImageTracker`_ through `ImageTracker.loadTarget`_, it can be detected and tracked by `ImageTracker`_.

public class ImageTarget : Target, IDisposable

Inheritance

object

RefBase

Target

ImageTarget

Implements

IDisposable

Inherited Members

RefBase.Dispose()

Constructors

ImageTarget()

public ImageTarget()

Methods

Clone()

public ImageTarget Clone()

aspectRatio()

Aspect ratio of the image.

public virtual float aspectRatio()

createFromImageFile(string, StorageType, string, string, string, float)

Creates from an image. If not needed, name, uid, and meta can be empty strings, and scale can use the default value 1. jpeg or png files are supported.

public static Optional<ImageTarget> createFromImageFile(string path, StorageType storageType, string name, string uid, string meta, float scale)

Parameters

path

storageType

name

uid

meta

scale

createFromParameters(ImageTargetParameters)

Creates from parameters.

public static Optional<ImageTarget> createFromParameters(ImageTargetParameters parameters)

Parameters

parameters

createFromTargetData(Buffer)

Creates from an etd data buffer.

public static Optional<ImageTarget> createFromTargetData(Buffer buffer)

Parameters

buffer

createFromTargetFile(string, StorageType)

Creates from an etd file.

public static Optional<ImageTarget> createFromTargetFile(string path, StorageType storageType)

Parameters

path

storageType

images()

Gets the list of images stored in the target. This method is usually used to get the recognition images of a target returned from the cloud.

public virtual List<Image> images()

meta()

Gets the meta data set by setMetaData. Or, in a target returned by cloud recognition, gets the meta data set by the server.

public override string meta()

name()

Gets the target name. The name is used to distinguish targets in a json file.

public override string name()

runtimeID()

Gets the target id. target id is integer data created at runtime and is valid (non-zero) only after successful configuration. This id is non-zero and globally incremental.

public override int runtimeID()

save(string)

Saves as an etd file.

public virtual bool save(string path)

Parameters

path

scale()

Scale ratio of the image. Its value is the ratio between the physical width of the image and 1 meter. The default value is 1.

public virtual float scale()

setMeta(string)

Sets meta data. This operation overrides the previous setting or data returned by the server.

public override void setMeta(string data)

Parameters

data

setName(string)

Sets the target name. This operation overrides the previous setting or data returned by the server.

public override void setName(string name)

Parameters

name

setScale(float)

Sets the scale ratio of the image. After it is set, it overrides the default value and the value set in the json file. Its value is the ratio between the physical width of the image and 1 meter. The default value is 1. This model scale also needs to be set separately in the rendering engine.

public virtual bool setScale(float scale)

Parameters

scale

uid()

Gets the target uid. The uid of ImageTarget is used in the cloud recognition algorithm. When cloud recognition is not integrated, you can set this uid in json configuration and use it in your own code as another way to distinguish targets.

public override string uid()