Class ImageTarget

Пространство имен

easyar

ImageTarget представляет target для плоского изображения, который может отслеживаться ImageTracker. Значения внутри ImageTarget перед чтением должны быть сначала заполнены методами вроде create... После успешной загрузки в ImageTracker через loadTarget он может обнаруживаться и отслеживаться ImageTracker.

Наследование

Target

ImageTarget

Конструкторы

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()

Методы

createFromParameters

Создает из параметров.

• 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	ImageTargetParameters

Возвращаемое значение

Тип	Описание
Optional<ImageTarget>

createFromTargetFile

Создает из etd-файла.

• 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)

Параметры

Имя	Тип	Описание
path	String
storageType	StorageType

Возвращаемое значение

Тип	Описание
Optional<ImageTarget>

createFromTargetData

Создает из буфера данных etd.

• 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)

Параметры

Имя	Тип	Описание
buffer	Buffer

Возвращаемое значение

Тип	Описание
Optional<ImageTarget>

save

Сохраняет как etd-файл.

• 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)

Параметры

Имя	Тип	Описание
path	String

Возвращаемое значение

Тип	Описание
Boolean

createFromImageFile

Создает из изображения. Если не требуется, name, uid и meta могут быть пустыми строками, а scale может использовать значение по умолчанию 1. Поддерживаются файлы jpeg или png.

• 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)

Параметры

Имя	Тип	Описание
path	String
storageType	StorageType
name	String
uid	String
meta	String
scale	Single

Возвращаемое значение

Тип	Описание
Optional<ImageTarget>

scale

Коэффициент scale изображения. Его значение является отношением физического размера ширины изображения к 1 метру. Значение по умолчанию равно 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()

Возвращаемое значение

Тип	Описание
Single

aspectRatio

Соотношение сторон изображения.

• 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()

Возвращаемое значение

Тип	Описание
Single

setScale

Устанавливает коэффициент scale изображения. После установки он переопределяет значение по умолчанию и значение, заданное в json-файле. Его значение является отношением физического размера ширины изображения к 1 метру. Значение по умолчанию равно 1. Этот scale модели также нужно отдельно установить в 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)

Параметры

Имя	Тип	Описание
scale	Single

Возвращаемое значение

Тип	Описание
Boolean

images

Получает список изображений, сохраненных в target. Обычно этот метод используется для получения изображений распознавания target, возвращенного из облака.

• 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()

Возвращаемое значение

Тип	Описание
List<Image>

runtimeID

Получает target id. target id — целочисленные данные, созданные во время runtime, и он действителен (non-zero) только после успешной конфигурации. Этот id non-zero и глобально увеличивается.

• 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()

Возвращаемое значение

Тип	Описание
Int32

uid

Получает target uid. uid у ImageTarget используется в алгоритме cloud recognition. Если cloud recognition не подключено, вы можете задать этот uid в json-конфигурации и использовать его в своем коде как другой способ различать target.

• 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()

Возвращаемое значение

Тип	Описание
String

name

Получает target name. name используется для различения target в json-файле.

• 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()

Возвращаемое значение

Тип	Описание
String

setName

Устанавливает target name. Эта операция переопределяет предыдущую настройку или данные, возвращенные сервером.

• 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)

Параметры

Имя	Тип	Описание
name	String

Возвращаемое значение

Тип	Описание
Void

meta

Получает meta data, заданные setMetaData. Или, в target, возвращенном cloud recognition, получает meta data, заданные сервером.

• 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()

Возвращаемое значение

Тип	Описание
String

setMeta

Устанавливает meta data. Эта операция переопределяет предыдущую настройку или данные, возвращенные сервером.

• 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)

Параметры

Имя	Тип	Описание
data	String

Возвращаемое значение

Тип	Описание
Void