CraftAR Unity Pro SDK  1.0
Public Member Functions | Public Attributes | Properties | List of all members
CraftARItemAR Class Reference

The CraftARItem class encapsulates an Image Recognition Item from the CraftAR service. There are two types of CraftAR Items: More...

Inheritance diagram for CraftARItemAR:
CraftARItem

Public Member Functions

 CraftARItemAR (CraftARItemImplementation item)
 
void Update ()
 
override string ToString ()
 
bool IsUpdatingWithTracking ()
 Determines whether this instance is updating with tracking. More...
 
void SetUpdateWithTracking (bool state)
 Define whether we want the ARItem to update its content instance GameObject position when its reference image is being tracked. More...
 
void setContentEnabled (bool enabled)
 Enable/disable the content on the scene. More...
 
bool isContentEnabled ()
 Determines whether the content is enabled. More...
 
- Public Member Functions inherited from CraftARItem
 CraftARItem (CraftARItemImplementation item)
 
override string ToString ()
 

Public Attributes

string contentBundleURL
 The content bundle URL, points to where the content is hosted for the "unity_content" for this item. More...
 
GameObject content
 GameObject Associated to the item (AR items only) More...
 
GameObject contentInstance
 The content GameObject instance, this is the actual content that will be displayed on top of the reference Image. More...
 
float lastSeen = 0
 
- Public Attributes inherited from CraftARItem
string uuid
 The item's UUID. More...
 
string itemName
 The name of the item. More...
 
string itemUrl
 The item URL. More...
 
string custom
 The custom field, if present. More...
 

Properties

Quaternion ItemRotation [get]
 
Vector3 ItemTranslation [get]
 
Vector2 ReferenceImageSize [get]
 
bool IsTracked [get]
 
- Properties inherited from CraftARItem
CraftARItemType ItemType [get]
 Gets the type of the item. More...
 
CraftARItemImplementation ItemImplementation [get]
 

Additional Inherited Members

- Public Types inherited from CraftARItem
enum  CraftARItemType {
  CraftARItemType.IMAGE_RECOGNITION_ITEM,
  CraftARItemType.AUGMENTED_REALITY_ITEM
}
 
- Protected Attributes inherited from CraftARItem
CraftARItemType itemType
 GameObject Associated to the item (AR items only) More...
 
CraftARItemImplementation itemImplementation
 

Detailed Description

The CraftARItem class encapsulates an Image Recognition Item from the CraftAR service. There are two types of CraftAR Items:

Member Function Documentation

◆ isContentEnabled()

bool CraftARItemAR.isContentEnabled ( )
inline

Determines whether the content is enabled.

Returns
true if this instance's content is enabled; otherwise, false.

◆ IsUpdatingWithTracking()

bool CraftARItemAR.IsUpdatingWithTracking ( )
inline

Determines whether this instance is updating with tracking.

Returns
true if this instance is updating with tracking; otherwise, false.

◆ setContentEnabled()

void CraftARItemAR.setContentEnabled ( bool  enabled)
inline

Enable/disable the content on the scene.

Parameters
enabledIf set to true the content will be rendered on the scene.

◆ SetUpdateWithTracking()

void CraftARItemAR.SetUpdateWithTracking ( bool  state)
inline

Define whether we want the ARItem to update its content instance GameObject position when its reference image is being tracked.

Parameters
stateIf set to true the item will update its content instance position with the ARItem position when tracked.

Member Data Documentation

◆ content

GameObject CraftARItemAR.content

GameObject Associated to the item (AR items only)

◆ contentBundleURL

string CraftARItemAR.contentBundleURL

The content bundle URL, points to where the content is hosted for the "unity_content" for this item.

◆ contentInstance

GameObject CraftARItemAR.contentInstance

The content GameObject instance, this is the actual content that will be displayed on top of the reference Image.


The documentation for this class was generated from the following file: