Class ImageTarget

Namespace

easyar

ImageTarget represents a target for planar images, which can be tracked by ImageTracker. The values inside ImageTarget need to be filled through methods like create... before they can be read. Then, after successfully loading via loadTarget, it can be detected and tracked by ImageTracker.

Inheritance

Target

ImageTarget

Constructors

ImageTarget

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

void easyar_ImageTarget__ctor(easyar_ImageTarget * * Return)

ImageTarget()

public ImageTarget()

constructor()

+ (easyar_ImageTarget *) create

public convenience init()

public ImageTarget()

Methods

createFromParameters

Create from parameters.

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

void easyar_ImageTarget_createFromParameters(easyar_ImageTargetParameters * parameters, easyar_OptionalOfImageTarget * Return)

static std::optional<std::shared_ptr<ImageTarget>> createFromParameters(std::shared_ptr<ImageTargetParameters> parameters)

public static @Nullable ImageTarget createFromParameters(@Nonnull ImageTargetParameters parameters)

companion object fun createFromParameters(parameters: ImageTargetParameters): ImageTarget?

+ (easyar_ImageTarget *)createFromParameters:(easyar_ImageTargetParameters *)parameters

public static func createFromParameters(_ parameters: ImageTargetParameters) -> ImageTarget?

public static Optional<ImageTarget> createFromParameters(ImageTargetParameters parameters)

Parameters

Name	Type	Description
parameters	ImageTargetParameters

Returns

Type	Description
Optional<ImageTarget>

createFromTargetFile

Create from etd file.

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

void easyar_ImageTarget_createFromTargetFile(easyar_String * path, easyar_StorageType storageType, easyar_OptionalOfImageTarget * Return)

static std::optional<std::shared_ptr<ImageTarget>> createFromTargetFile(std::string path, StorageType storageType)

public static @Nullable ImageTarget createFromTargetFile(java.lang.@Nonnull String path, int storageType)

companion object fun createFromTargetFile(path: String, storageType: Int): ImageTarget?

+ (easyar_ImageTarget *)createFromTargetFile:(NSString *)path storageType:(easyar_StorageType)storageType

public static func createFromTargetFile(_ path: String, _ storageType: StorageType) -> ImageTarget?

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

Parameters

Name	Type	Description
path	String
storageType	StorageType

Returns

Type	Description
Optional<ImageTarget>

createFromTargetData

Create from etd data cache.

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

void easyar_ImageTarget_createFromTargetData(easyar_Buffer * buffer, easyar_OptionalOfImageTarget * Return)

static std::optional<std::shared_ptr<ImageTarget>> createFromTargetData(std::shared_ptr<Buffer> buffer)

public static @Nullable ImageTarget createFromTargetData(@Nonnull Buffer buffer)

companion object fun createFromTargetData(buffer: Buffer): ImageTarget?

+ (easyar_ImageTarget *)createFromTargetData:(easyar_Buffer *)buffer

public static func createFromTargetData(_ buffer: Buffer) -> ImageTarget?

public static Optional<ImageTarget> createFromTargetData(Buffer buffer)

Parameters

Name	Type	Description
buffer	Buffer

Returns

Type	Description
Optional<ImageTarget>

save

Save as etd file.

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

bool easyar_ImageTarget_save(easyar_ImageTarget * This, easyar_String * path)

bool save(std::string path)

public boolean save(java.lang.@Nonnull String path)

fun save(path: String): Boolean

- (bool)save:(NSString *)path

public func save(_ path: String) -> Bool

public virtual bool save(string path)

Parameters

Name	Type	Description
path	String

Returns

Type	Description
Boolean

createFromImageFile

Create from image. If not needed, name, uid, meta can be passed as empty strings, scale can be passed as default value 1. Supports jpeg or png files.

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

void easyar_ImageTarget_createFromImageFile(easyar_String * path, easyar_StorageType storageType, easyar_String * name, easyar_String * uid, easyar_String * meta, float scale, easyar_OptionalOfImageTarget * Return)

static std::optional<std::shared_ptr<ImageTarget>> createFromImageFile(std::string path, StorageType storageType, std::string name, std::string uid, std::string meta, float scale)

public static @Nullable ImageTarget createFromImageFile(java.lang.@Nonnull String path, int storageType, java.lang.@Nonnull String name, java.lang.@Nonnull String uid, java.lang.@Nonnull String meta, float scale)

companion object fun createFromImageFile(path: String, storageType: Int, name: String, uid: String, meta: String, scale: Float): ImageTarget?

+ (easyar_ImageTarget *)createFromImageFile:(NSString *)path storageType:(easyar_StorageType)storageType name:(NSString *)name uid:(NSString *)uid meta:(NSString *)meta scale:(float)scale

public static func createFromImageFile(_ path: String, _ storageType: StorageType, _ name: String, _ uid: String, _ meta: String, _ scale: Float) -> ImageTarget?

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

Parameters

Name	Type	Description
path	String
storageType	StorageType
name	String
uid	String
meta	String
scale	Single

Returns

Type	Description
Optional<ImageTarget>

scale

The scaling ratio of the image. Its value is the ratio of the physical size of the image width to 1 meter, default is 1.

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

float easyar_ImageTarget_scale(const easyar_ImageTarget * This)

float scale()

public float scale()

fun scale(): Float

- (float)scale

public func scale() -> Float

public virtual float scale()

Returns

Type	Description
Single

aspectRatio

The aspect ratio of the image.

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

float easyar_ImageTarget_aspectRatio(const easyar_ImageTarget * This)

float aspectRatio()

public float aspectRatio()

fun aspectRatio(): Float

- (float)aspectRatio

public func aspectRatio() -> Float

public virtual float aspectRatio()

Returns

Type	Description
Single

setScale

Set the scaling ratio of the image. After setting, it will override the default value and the value set in the json file. Its value is the ratio of the physical size of the image width to 1 meter, default is 1. Also need to set this model scaling separately in the rendering engine.

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

bool easyar_ImageTarget_setScale(easyar_ImageTarget * This, float scale)

bool setScale(float scale)

public boolean setScale(float scale)

fun setScale(scale: Float): Boolean

- (bool)setScale:(float)scale

public func setScale(_ scale: Float) -> Bool

public virtual bool setScale(float scale)

Parameters

Name	Type	Description
scale	Single

Returns

Type	Description
Boolean

images

Get the list of images stored in the target. Usually, this method is used to get the recognition image data of the target returned from the cloud.

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

void easyar_ImageTarget_images(easyar_ImageTarget * This, easyar_ListOfImage * * Return)

std::vector<std::shared_ptr<Image>> images()

public java.util.@Nonnull ArrayList<@Nonnull Image> images()

fun images(): ArrayList<Image>

- (NSArray<easyar_Image *> *)images

public func images() -> [Image]

public virtual List<Image> images()

Returns

Type	Description
List<Image>

runtimeID

Get the target id. The target id is an integer created at runtime, and it is only valid (non-zero) after successful configuration. This id is non-zero and globally incrementing.

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

int easyar_ImageTarget_runtimeID(const easyar_ImageTarget * This)

int runtimeID()

public int runtimeID()

fun runtimeID(): Int

- (int)runtimeID

public override func runtimeID() -> Int32

public override int runtimeID()

Returns

Type	Description
Int32

uid

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

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

void easyar_ImageTarget_uid(const easyar_ImageTarget * This, easyar_String * * Return)

std::string uid()

public java.lang.@Nonnull String uid()

fun uid(): String

- (NSString *)uid

public override func uid() -> String

public override string uid()

Returns

Type	Description
String

name

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

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

void easyar_ImageTarget_name(const easyar_ImageTarget * This, easyar_String * * Return)

std::string name()

public java.lang.@Nonnull String name()

fun name(): String

- (NSString *)name

public override func name() -> String

public override string name()

Returns

Type	Description
String

setName

Set the target name. This operation will override the previous setting or data returned from the server.

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

void easyar_ImageTarget_setName(easyar_ImageTarget * This, easyar_String * name)

void setName(std::string name)

public void setName(java.lang.@Nonnull String name)

fun setName(name: String): Unit

- (void)setName:(NSString *)name

public override func setName(_ name: String) -> Void

public override void setName(string name)

Parameters

Name	Type	Description
name	String

Returns

Type	Description
Void

meta

Get the meta data set by setMetaData. Or, in targets returned from cloud recognition, get the meta data set by the server.

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

void easyar_ImageTarget_meta(const easyar_ImageTarget * This, easyar_String * * Return)

std::string meta()

public java.lang.@Nonnull String meta()

fun meta(): String

- (NSString *)meta

public override func meta() -> String

public override string meta()

Returns

Type	Description
String

setMeta

Set meta data. This operation will override the previous setting or data returned from the server.

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

void easyar_ImageTarget_setMeta(easyar_ImageTarget * This, easyar_String * data)

void setMeta(std::string data)

public void setMeta(java.lang.@Nonnull String data)

fun setMeta(data: String): Unit

- (void)setMeta:(NSString *)data

public override func setMeta(_ data: String) -> Void

public override void setMeta(string data)

Parameters

Name	Type	Description
data	String

Returns

Type	Description
Void