Wikitude SDK API Reference

API Docs for: 8.2.0
Show:

TargetCollectionResource Class

Extends ARchitectObject
Module: AR

A TargetCollectionResource represents a Target Collection which is created with the Wikitude Studio Manager.
It needs to include the binary .wtc targets describing the targets and needs to be referenced via a URI.

Constructor

TargetCollectionResource

(
  • uri
  • options
)

Parameters:

  • uri String

    The URI to the target collection.

  • options Object optional

    Setup-Parameters to customize additional object properties.

    Accepted options-properties are

Item Index

Methods

Properties

Events

Methods

cancel

()

Cancels the loading of the TargetCollectionResource data.

destroy

()

Inherited from ARchitectObject

Destroys the object.

Properties

destroyed

Boolean

Inherited from ARchitectObject

Indicates if the object has already been destroyed.

loading

Boolean

If the TargetCollectionResource is loading. The property is read-only.

URL

String

The URL pointing to the referenced target collection. The property is read-only and can only be set on creation.

Events

onError

The trigger fires when the resource could not be loaded. Causes for this might include bad network connection or a corrupt target collection.

The trigger is null by default, and will thus result in no action executed when the trigger fires. A developer can add custom functionality by assigning a custom function to onError.

onLoaded

The trigger fires when the resource was successfully loaded.

The trigger is null by default, and will thus result in no action executed when the trigger fires. A developer can add custom functionality by assigning a custom function to onLoaded.