Class ObjectTarget

Namespace

easyar

ObjectTarget represents a 3D-object target, which can be tracked by ObjectTracker. The size of ObjectTarget is determined by the obj file. You can modify the size by changing the scale. The default scale is 1. After ObjectTarget is successfully loaded into ObjectTracker via loadTarget, it can be detected and tracked by ObjectTracker.

Inheritance

Target

ObjectTarget

Constructors

ObjectTarget

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

void easyar_ObjectTarget__ctor(easyar_ObjectTarget * * Return)

ObjectTarget()

public ObjectTarget()

constructor()

+ (easyar_ObjectTarget *) create

public convenience init()

public ObjectTarget()

Methods

createFromParameters

Created from parameters.

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

void easyar_ObjectTarget_createFromParameters(easyar_ObjectTargetParameters * parameters, easyar_OptionalOfObjectTarget * Return)

static std::optional<std::shared_ptr<ObjectTarget>> createFromParameters(std::shared_ptr<ObjectTargetParameters> parameters)

public static @Nullable ObjectTarget createFromParameters(@Nonnull ObjectTargetParameters parameters)

companion object fun createFromParameters(parameters: ObjectTargetParameters): ObjectTarget?

+ (easyar_ObjectTarget *)createFromParameters:(easyar_ObjectTargetParameters *)parameters

public static func createFromParameters(_ parameters: ObjectTargetParameters) -> ObjectTarget?

public static Optional<ObjectTarget> createFromParameters(ObjectTargetParameters parameters)

Parameters

Name	Type	Description
parameters	ObjectTargetParameters

Returns

Type	Description
Optional<ObjectTarget>

createFromObjectFile

Created from obj, mtl, and jpg/png files.

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

void easyar_ObjectTarget_createFromObjectFile(easyar_String * path, easyar_StorageType storageType, easyar_String * name, easyar_String * uid, easyar_String * meta, float scale, easyar_OptionalOfObjectTarget * Return)

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

public static @Nullable ObjectTarget createFromObjectFile(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 createFromObjectFile(path: String, storageType: Int, name: String, uid: String, meta: String, scale: Float): ObjectTarget?

+ (easyar_ObjectTarget *)createFromObjectFile:(NSString *)path storageType:(easyar_StorageType)storageType name:(NSString *)name uid:(NSString *)uid meta:(NSString *)meta scale:(float)scale

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

public static Optional<ObjectTarget> createFromObjectFile(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<ObjectTarget>

scale

The scaling factor of the model. Its value is the ratio of the physical size of the model in space to its size in the model coordinate system, with a default value of 1. (Assuming the unit of measurement in the model coordinate system is meters.)

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

float easyar_ObjectTarget_scale(const easyar_ObjectTarget * This)

float scale()

public float scale()

fun scale(): Float

- (float)scale

public func scale() -> Float

public virtual float scale()

Returns

Type	Description
Single

boundingBox

The bounding box of the object, including the 8 vertices of the box. Vertex indices are defined as follows:

  4-----7
 /|    /|
5-----6 |    z
| |   | |    |
| 0---|-3    o---y
|/    |/    /
1-----2    x

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

void easyar_ObjectTarget_boundingBox(easyar_ObjectTarget * This, easyar_ListOfVec3F * * Return)

std::vector<Vec3F> boundingBox()

public java.util.@Nonnull ArrayList<@Nonnull Vec3F> boundingBox()

fun boundingBox(): ArrayList<Vec3F>

- (NSArray<easyar_Vec3F *> *)boundingBox

public func boundingBox() -> [Vec3F]

public virtual List<Vec3F> boundingBox()

Returns

Type	Description
List<Vec3F>

setScale

Set the scaling factor of the model. 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 model in space to its size in the model coordinate system, with a default value of 1. (Assuming the unit of measurement in the model coordinate system is meters.) Additionally, you need to set this model scaling separately in the rendering engine. Note that this setting must be done before loading into ObjectTracker via loadTarget.

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

bool easyar_ObjectTarget_setScale(easyar_ObjectTarget * 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

runtimeID

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

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

int easyar_ObjectTarget_runtimeID(const easyar_ObjectTarget * 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_ObjectTarget_uid(const easyar_ObjectTarget * 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_ObjectTarget_name(const easyar_ObjectTarget * 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_ObjectTarget_setName(easyar_ObjectTarget * 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 by cloud-recognition, get the meta data set by the server.

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

void easyar_ObjectTarget_meta(const easyar_ObjectTarget * 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_ObjectTarget_setMeta(easyar_ObjectTarget * 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