All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Loading...
Searching...
No Matches
Anchor Feature

Classes

struct  VuAnchorObserverConfig
 Configuration for creating an anchor observer. More...
 
struct  VuAnchorObservationInfo
 Info for an anchor observation. More...
 
struct  VuAnchorCreationConfig
 Configuration for creating an anchor with pose. More...
 
struct  VuAnchorCreationHitTestConfig
 Configuration for creatig an anchor with a hit-test result. More...
 
struct  VuHitTestConfig
 Configuration for performing a hit-test. More...
 

Typedefs

typedef struct VuAnchorList_ VuAnchorList
 Anchor list.
 
typedef struct VuHitTest_ VuHitTest
 Hit-test list.
 
typedef struct VuHitTestList_ VuHitTestList
 Hit-test list.
 

Enumerations

enum  VuAnchorCreationError : int32_t {
  VU_ANCHOR_CREATION_ERROR_NONE = 0x0 ,
  VU_ANCHOR_CREATION_ERROR_INTERNAL = 0x1 ,
  VU_ANCHOR_CREATION_ERROR_AUTOACTIVATION_FAILED = 0x2 ,
  VU_ANCHOR_CREATION_ERROR_INVALID_DEVICE_POSE_OBSERVER = 0x3
}
 Configuration error for anchor creation. More...
 
enum  VuAnchorObservationStatusInfo : int32_t {
  VU_ANCHOR_OBSERVATION_STATUS_INFO_NORMAL ,
  VU_ANCHOR_OBSERVATION_STATUS_INFO_NOT_OBSERVED = 0x2 ,
  VU_ANCHOR_OBSERVATION_STATUS_INFO_RELOCALIZING
}
 Status info for the pose of anchor observations. More...
 
enum  { VU_OBSERVER_ANCHOR_TYPE = 0x9 }
 
enum  { VU_OBSERVATION_ANCHOR_TYPE = 0x9 }
 
enum  VuHitTestHint : int32_t {
  VU_HIT_TEST_HINT_NONE = 0x1 ,
  VU_HIT_TEST_HINT_HORIZONTAL_PLANE = 0x2 ,
  VU_HIT_TEST_HINT_VERTICAL_PLANE = 0x3
}
 Hints for hit-tests. More...
 

Functions

VuAnchorObserverConfig vuAnchorObserverConfigDefault ()
 Default anchor observer configuration.
 
VuAnchorCreationConfig vuAnchorCreationConfigDefault ()
 Default anchor with pose creation configuration.
 
VuAnchorCreationHitTestConfig vuAnchorCreationHitTestConfigDefault ()
 Default anchor from hit test creation configuration.
 
VuHitTestConfig vuHitTestConfigDefault ()
 Default hit test configuration.
 
VuResult vuHitTestListCreate (VuHitTestList **list)
 Create a hit-test list.
 
VuResult vuHitTestListGetSize (const VuHitTestList *list, int32_t *listSize)
 Get number of elements in a hit-test list.
 
VuResult vuHitTestListGetElement (const VuHitTestList *list, int32_t element, VuHitTest **hitTest)
 Get an element in a hit-test list.
 
VuResult vuHitTestListDestroy (VuHitTestList *list)
 Destroy a hit-test list.
 
VuResult vuHitTestGetPose (const VuHitTest *hitTest, VuMatrix44F *pose)
 Get hit-test pose.
 
VuResult vuEngineCreateAnchorObserver (VuEngine *engine, VuObserver **observer, const VuAnchorObserverConfig *config, VuAnchorCreationError *errorCode)
 Create an anchor target observer.
 
VuResult vuEngineGetAnchorObservers (const VuEngine *engine, VuObserverList *observerList)
 Get all anchor target observers.
 
VuResult vuAnchorObserverHitTest (VuObserver *observer, const VuHitTestConfig *config, VuHitTestList *hittestList)
 Perform a hit-test with an anchor observer.
 
VuResult vuAnchorObserverCreateAnchor (VuObserver *observer, const VuAnchorCreationConfig *config, int32_t *anchorId)
 Create an anchor with an anchor observer.
 
VuResult vuAnchorObserverCreateAnchorWithHitTest (VuObserver *observer, const VuAnchorCreationHitTestConfig *config, int32_t *anchorId)
 Create an anchor from hit-test with an anchor observer.
 
VuResult vuAnchorObserverDestroyAnchor (VuObserver *observer, int32_t anchorId)
 Destroy an anchor with an anchor observer.
 
VuResult vuAnchorObserverDestroyAnchors (VuObserver *observer)
 Destroy all anchors with an anchor observer.
 
VuResult vuAnchorObserverGetAnchors (const VuObserver *observer, VuAnchorList *anchorList)
 Return list of all managed anchors from an anchor observer.
 
VuResult vuStateGetAnchorObservations (const VuState *state, VuObservationList *observationList)
 Get all anchor observations from the Vuforia State.
 
VuResult vuAnchorObservationGetStatusInfo (const VuObservation *observation, VuAnchorObservationStatusInfo *statusInfo)
 Get status info associated to the pose status of an anchor observation.
 
VuResult vuAnchorObservationGetInfo (const VuObservation *observation, VuAnchorObservationInfo *anchorInfo)
 Get info associated with an anchor observation.
 
VuResult vuAnchorListCreate (VuAnchorList **list)
 Create anchor list.
 
VuResult vuAnchorListGetSize (const VuAnchorList *list, int32_t *listSize)
 Get number of elements in an anchor list.
 
VuResult vuAnchorListGetElement (const VuAnchorList *list, int32_t element, int32_t *anchorId)
 Get an element in an anchor list.
 
VuResult vuAnchorListDestroy (VuAnchorList *list)
 Destroy an anchor list.
 

Detailed Description

Enumeration Type Documentation

◆ VuAnchorCreationError

enum VuAnchorCreationError : int32_t

Configuration error for anchor creation.

Enumerator
VU_ANCHOR_CREATION_ERROR_NONE 

No error.

VU_ANCHOR_CREATION_ERROR_INTERNAL 

An internal error occurred while creating the observer.

VU_ANCHOR_CREATION_ERROR_AUTOACTIVATION_FAILED 

Observer auto-activation failed.

VU_ANCHOR_CREATION_ERROR_INVALID_DEVICE_POSE_OBSERVER 

Device pose observer is null or invalid.

◆ VuAnchorObservationStatusInfo

Status info for the pose of anchor observations.

Provides further information on the pose status reported as part of VuPoseInfo. The status info is retrieved with vuAnchorObservationGetStatusInfo.

Note
All enum values defined by VuObservationPoseStatus may be reported as part of an Anchor observation, except VU_OBSERVATION_POSE_STATUS_TRACKED.
See also
VuPoseInfo
VuObservationPoseStatus
vuObservationHasPoseInfo
vuObservationGetPoseInfo
vuStateGetObservationsWithPoseInfo
vuAnchorObservationGetStatusInfo
Enumerator
VU_ANCHOR_OBSERVATION_STATUS_INFO_NORMAL 

Tracking is working normally. Reported for VU_OBSERVATION_POSE_STATUS_EXTENDED_TRACKED.

VU_ANCHOR_OBSERVATION_STATUS_INFO_NOT_OBSERVED 

Anchor is not observed. Reported for VU_OBSERVATION_POSE_STATUS_NO_POSE.

VU_ANCHOR_OBSERVATION_STATUS_INFO_RELOCALIZING 

The tracking system is currently relocalizing. Reported for VU_OBSERVATION_POSE_STATUS_LIMITED.

◆ anonymous enum

anonymous enum
Enumerator
VU_OBSERVER_ANCHOR_TYPE 

Type identifier for anchor observers.

◆ anonymous enum

anonymous enum
Enumerator
VU_OBSERVATION_ANCHOR_TYPE 

Type identifier for anchor observations.

◆ VuHitTestHint

enum VuHitTestHint : int32_t

Hints for hit-tests.

Enumerator
VU_HIT_TEST_HINT_NONE 

No hint.

VU_HIT_TEST_HINT_HORIZONTAL_PLANE 

Hit-test is performed on a horizontal plane.

VU_HIT_TEST_HINT_VERTICAL_PLANE 

Hit-test is performed on a vertical plane (not supported yet)

Function Documentation

◆ vuAnchorObserverConfigDefault()

VuAnchorObserverConfig vuAnchorObserverConfigDefault ( )

Default anchor observer configuration.

Note
Use this function to initialize the VuAnchorObserverConfig data structure with default values.

◆ vuAnchorCreationConfigDefault()

VuAnchorCreationConfig vuAnchorCreationConfigDefault ( )

Default anchor with pose creation configuration.

Note
Use this function to initialize the VuAnchorCreationConfig data structure with default values.

◆ vuAnchorCreationHitTestConfigDefault()

VuAnchorCreationHitTestConfig vuAnchorCreationHitTestConfigDefault ( )

Default anchor from hit test creation configuration.

Note
Use this function to initialize the VuAnchorCreationHitTestConfig data structure with default values.

◆ vuHitTestConfigDefault()

VuHitTestConfig vuHitTestConfigDefault ( )

Default hit test configuration.

Note
Use this function to initialize the VuHitTestConfig data structure with default values.

◆ vuHitTestGetPose()

VuResult vuHitTestGetPose ( const VuHitTest * hitTest,
VuMatrix44F * pose )

Get hit-test pose.

Note
The pose is represented as a pose matrix using the OpenGL convention.

◆ vuAnchorObserverHitTest()

VuResult vuAnchorObserverHitTest ( VuObserver * observer,
const VuHitTestConfig * config,
VuHitTestList * hittestList )

Perform a hit-test with an anchor observer.

Note
Hit-test is not supported on Hololens
The obtained VuHitTest results will only be valid until the next call to vuAnchorObserverHitTest()

◆ vuAnchorObservationGetStatusInfo()

VuResult vuAnchorObservationGetStatusInfo ( const VuObservation * observation,
VuAnchorObservationStatusInfo * statusInfo )

Get status info associated to the pose status of an anchor observation.

The status info is intended to be used in combination with VuObservationPoseStatus retrieved via vuObservationGetPoseInfo.