ImageTarget Class

Inherits: Target

Description

ImageTarget表示平面图像的target,它可以被 ImageTracker 所跟踪。

ImageTarget的大小可以在json文件里设置并通过Load/LoadImage/LoadJsonFile/LoadJsonString方法加载,或者如果没有在接口中提供,将会从图像分辨率计算。

ImageTarget内的数值在可以被读取之前需要首先通过Load/LoadImage/LoadJsonFile/LoadJsonString方法载入。然后再通过 ImageTracker.LoadTarget or ImageTracker.LoadTargetBlocked 成功载入 ImageTracker 之后可以被 ImageTracker 检测和跟踪。

Public Properties

Vector2 Size

Public Functions

ImageTarget()
bool LoadImage(string path, StorageType storageType, string targetname, Vector2 size)
bool LoadJsonFile(string path, StorageType storageType, string targetname)
bool LoadJsonString(string json, StorageType storageType, string targetname)
static List<Target> LoadListFromJsonFile(string path, StorageType storageType) (since 1.3.0)
static List<Target> LoadListFromJsonString(string json, StorageType storageType) (since 1.3.0)

Protected Functions

bool Load(string path, int storageType, string name)
static List<Target> LoadList(string path, int storageType) (since 1.3.0)

ImageTarget()

创建ImageTarget实例。

Vector2 Size

image target的大小。这个大小只有在使用 ImageTracker.LoadTargetImageTracker.LoadTargetBlocked 成功加载入 ImageTracker ,或是通过这个属性手动设置之后才是有效(非0)的。

如果size没有set过,将会返回通过图像分辨率进行计算得出的默认大小。

设置size之后会覆盖默认值以及在json文件中设的数值。

size将会在 ImageTracker.LoadTargetImageTracker.LoadTargetBlocked 调用之 后通过图像分辨率重新计算。在计算之后,size的最大值将被保持不变,仍为最大值,另一个维度则通过分辨率计算更新。需要在target成功加载之 后获取实际使用的size数值。

如果size长宽比例在设置的时候就保证和图像分辨率一致,则在计算之后size不会发生变化。

bool LoadImage(string path, StorageType storageType, string targetname, Vector2 size)

加载一张图片。这个方法只会解析图片配置。

从类型为 storageType 的 path 加载一张图片,并设置target名字为 targetname ,大小为 size 。

storageType应该设成 StorageType.AppStorageType.AssetsStorageType.Absolute ,表示路径的类型。

关于StorageType的详细描述参见 StorageType

bool LoadJsonFile(string path, StorageType storageType, string targetname)

加载一个json文件或。这个方法只会解析json文件或字符串。

如果name非空则加载名字为name的target,否则加载第一个target。

storageType应该设成 StorageType.AppStorageType.AssetsStorageType.Absolute ,表示路径的类型。json文件内部的路径应该是绝对路径或相对于json文件的相对路径。

关于StorageType的详细描述参见 StorageType

bool LoadJsonString(string json, StorageType storageType, string targetname)

加载一个json字符串。这个方法只会解析json文件或字符串。

如果name非空则加载名字为name的target,否则加载第一个target。

storageType应该设成 StorageType.AppStorageType.AssetsStorageType. Absolute ,表示路径的类型。json字符串内部的路径应该是绝对路径或相对于storageType所指向的根目录的相对路径。

关于StorageType的详细描述参见 StorageType

bool Load(string path, int storageType, string name)

加载一个json文件或json字符串。这个方法只会解析json文件或字符串。

如果name非空则加载名字为name的target,否则加载第一个target。

如果 path 是json文件的路径,storageType应该设成 StorageType.AppStorageType.AssetsStorageType.Absolute ,表示路径的类型。json文件内部的路径应该是绝对路径或相对于json文件的相对路径。

如果 path 是json字符串, storageType应该设成 (StorageType.App | StorageType.Json)(StorageType.Assets | StorageType.Json)( StorageType.Absolute | StorageType.Json) 。json字符串里的路径应该是绝对路径或相对于storageType所指向的根目录的相对路径。

关于StorageType的详细描述参见 StorageType

static List<Target> LoadListFromJsonFile(string path, StorageType storageType) (since 1.3.0)

从类型 storageType 为的 path 中加载json文件里列出的所有target。关于storageType和json文件的描述参见Load和 StorageType

static List<Target> LoadListFromJsonString(string json, StorageType storageType) (since 1.3.0)

从类型 storageType 为的 path 中加载json字符串里列出的所有target。关于storageType和json文件的描述参见Load和 StorageType

static List<Target> LoadList(string path, int storageType) (since 1.3.0)

从类型 storageType 为的 path 中加载json文件或json字符串里列出的所有target。关于storageType和js on文件的描述参见Load和 StorageType