Class ImageTarget

命名空间

easyar

ImageTarget表示平面图像的target，它可以被 ImageTracker 所跟踪。 ImageTarget内的数值在可以被读取之前需要首先通过create...等方法填入。然后再通过 loadTarget 成功载入 ImageTracker 之后可以被 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

图像的缩放比例。其值为图像宽度的物理大小与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

设置图像的缩放比例，设置之后会覆盖默认值以及在json文件中设的数值。其值为图像宽度的物理大小与1米的比值，默认值为1。 还需要在渲染引擎中单独设置此模型缩放。

• 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是运行时创建的整型数据，只有在成功的配置之后才是有效（非0）的。这个id是非0且全局递增的。

• 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。ImageTarget的uid在云识别算法中使用。在没有接入云识别的时候，你可以在json配置中设置这个uid，在自己的代码中作为另一种区分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名字。名字用来在json文件中区分target。

• 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名字。这个操作会覆盖上一次的设置或是服务器返回的数据。

• 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

获取setMetaData所设置的meta data。或者在云识别返回的target中，获得服务器所设置的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