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

Classes

struct  VuMeshAreaTargetCaptureConfig
 Configuration for creating a Mesh observer using an Area Target Capture instance. More...
 
struct  VuMeshAreaTargetConfig
 Configuration for creating a Mesh observer associated with an Area Target observer. More...
 
struct  VuMeshObservationBlock
 The Mesh observation block represents a single self-contained mesh. More...
 
struct  VuMeshObservationInfo
 Mesh observation info. More...
 
struct  VuMeshModelTargetConfig
 Configuration for creating a Mesh observer associated with a Model Target observer. More...
 

Typedefs

typedef struct VuMeshObservationBlockList_ VuMeshObservationBlockList
 List of Mesh observation blocks.
 

Enumerations

enum  VuMeshAreaTargetCaptureCreationError : int32_t {
  VU_MESH_AREA_TARGET_CAPTURE_CREATION_ERROR_NONE = 0x0 ,
  VU_MESH_AREA_TARGET_CAPTURE_CREATION_ERROR_INTERNAL = 0x1 ,
  VU_MESH_AREA_TARGET_CAPTURE_CREATION_ERROR_AUTOACTIVATION_FAILED = 0x2 ,
  VU_MESH_AREA_TARGET_CAPTURE_CREATION_ERROR_FEATURE_NOT_SUPPORTED = 0x3 ,
  VU_MESH_AREA_TARGET_CAPTURE_CREATION_ERROR_INVALID_CAPTURE = 0x4 ,
  VU_MESH_AREA_TARGET_CAPTURE_CREATION_ERROR_SAME_SOURCE_NOT_SUPPORTED
}
 Configuration error for Mesh observer creation with Area Target Capture. More...
 
enum  VuMeshAreaTargetCreationError : int32_t {
  VU_MESH_AREA_TARGET_CREATION_ERROR_NONE = 0x00 ,
  VU_MESH_AREA_TARGET_CREATION_ERROR_INTERNAL = 0x01 ,
  VU_MESH_AREA_TARGET_CREATION_ERROR_AUTOACTIVATION_FAILED = 0x02 ,
  VU_MESH_AREA_TARGET_CREATION_ERROR_INVALID_OBSERVER = 0x03 ,
  VU_MESH_AREA_TARGET_CREATION_ERROR_MESH_FILE_LOAD_ERROR ,
  VU_MESH_AREA_TARGET_CREATION_ERROR_MESH_LOAD_ERROR = 0x04 ,
  VU_MESH_AREA_TARGET_CREATION_ERROR_SAME_SOURCE_NOT_SUPPORTED = 0x05
}
 Configuration error for Mesh observer creation with Area Target observer. More...
 
enum  { VU_OBSERVER_MESH_TYPE = 0xF }
 
enum  { VU_OBSERVATION_MESH_TYPE = 0xF }
 
enum  VuMeshObservationStatus : int32_t {
  VU_MESH_OBSERVATION_STATUS_NORMAL = 0x1 ,
  VU_MESH_OBSERVATION_STATUS_LIMITED
}
 Status information on the mesh data in the observation. More...
 
enum  VuMeshObservationStatusInfo : int32_t {
  VU_MESH_OBSERVATION_STATUS_INFO_NORMAL ,
  VU_MESH_OBSERVATION_STATUS_INFO_NOT_OBSERVED = 0x2 ,
  VU_MESH_OBSERVATION_STATUS_INFO_RELOCALIZING ,
  VU_MESH_OBSERVATION_STATUS_INFO_MISSING_DATA = 0x4 ,
  VU_MESH_OBSERVATION_STATUS_INFO_WRONG_SCALE
}
 Status info for the pose of Mesh observations. More...
 
enum  VuMeshModelTargetCreationError : int32_t {
  VU_MESH_MODEL_TARGET_CREATION_ERROR_NONE = 0x00 ,
  VU_MESH_MODEL_TARGET_CREATION_ERROR_INTERNAL = 0x01 ,
  VU_MESH_MODEL_TARGET_CREATION_ERROR_AUTOACTIVATION_FAILED = 0x02 ,
  VU_MESH_MODEL_TARGET_CREATION_ERROR_INVALID_OBSERVER = 0x03 ,
  VU_MESH_MODEL_TARGET_CREATION_ERROR_SAME_SOURCE_NOT_SUPPORTED
}
 Configuration error for Mesh observer creation with Model Target observer. More...
 

Functions

VuMeshAreaTargetCaptureConfig vuMeshAreaTargetCaptureConfigDefault ()
 Default Mesh observer configuration with Area Target Capture source.
 
VuResult vuEngineCreateMeshObserverFromAreaTargetCaptureConfig (VuEngine *engine, VuObserver **observer, const VuMeshAreaTargetCaptureConfig *config, VuMeshAreaTargetCaptureCreationError *errorCode)
 Create a Mesh observer with an Area Target Capture instance as source.
 
VuMeshAreaTargetConfig vuMeshAreaTargetConfigDefault ()
 Default Mesh observer configuration with Area Target observer.
 
VuResult vuEngineCreateMeshObserverFromAreaTargetConfig (VuEngine *engine, VuObserver **observer, const VuMeshAreaTargetConfig *config, VuMeshAreaTargetCreationError *errorCode)
 Create a Mesh observer with an Area Target observer as source.
 
VuResult vuEngineGetMeshObservers (const VuEngine *engine, VuObserverList *observerList)
 Get all Mesh observers.
 
VuResult vuStateGetMeshObservations (const VuState *state, VuObservationList *list)
 Get all Mesh observations from the Vuforia state.
 
VuResult vuMeshObservationBlockListGetSize (const VuMeshObservationBlockList *list, int32_t *listSize)
 Get number of elements in a Mesh observation block list.
 
VuResult vuMeshObservationBlockListGetElement (const VuMeshObservationBlockList *list, int32_t element, VuMeshObservationBlock *block)
 Get an element in a Mesh observation block list.
 
VuResult vuMeshObservationGetInfo (const VuObservation *observation, VuMeshObservationInfo *info)
 Get observation info associated with a Mesh observation.
 
VuResult vuMeshObservationGetStatusInfo (const VuObservation *observation, VuMeshObservationStatusInfo *statusInfo)
 Get status info associated to the pose status of a Mesh observation.
 
VuMeshModelTargetConfig vuMeshModelTargetConfigDefault ()
 Default Mesh observer configuration with a Model Target.
 
VuResult vuEngineCreateMeshObserverFromModelTargetConfig (VuEngine *engine, VuObserver **observer, const VuMeshModelTargetConfig *config, VuMeshModelTargetCreationError *errorCode)
 Create a Mesh observer with a Model Target as source.
 

Detailed Description

The Mesh Observer enables the retrieval of meshes provided by a specific source, such as an Area Target Capture instance.

Enumeration Type Documentation

◆ VuMeshAreaTargetCaptureCreationError

Configuration error for Mesh observer creation with Area Target Capture.

Enumerator
VU_MESH_AREA_TARGET_CAPTURE_CREATION_ERROR_NONE 

No error.

VU_MESH_AREA_TARGET_CAPTURE_CREATION_ERROR_INTERNAL 

An internal error occurred while creating the observer.

VU_MESH_AREA_TARGET_CAPTURE_CREATION_ERROR_AUTOACTIVATION_FAILED 

An error occurred while auto-activating the observer.

VU_MESH_AREA_TARGET_CAPTURE_CREATION_ERROR_FEATURE_NOT_SUPPORTED 

Mesh functionality is not supported on the current device.

VU_MESH_AREA_TARGET_CAPTURE_CREATION_ERROR_INVALID_CAPTURE 

The provided capture is NULL or invalid.

VU_MESH_AREA_TARGET_CAPTURE_CREATION_ERROR_SAME_SOURCE_NOT_SUPPORTED 

A mesh observer is already attached to the Area Target Capture instance.

◆ VuMeshAreaTargetCreationError

Configuration error for Mesh observer creation with Area Target observer.

Enumerator
VU_MESH_AREA_TARGET_CREATION_ERROR_NONE 

No error.

VU_MESH_AREA_TARGET_CREATION_ERROR_INTERNAL 

An internal error occurred while creating the observer.

VU_MESH_AREA_TARGET_CREATION_ERROR_AUTOACTIVATION_FAILED 

An error occurred while auto-activating the observer.

VU_MESH_AREA_TARGET_CREATION_ERROR_INVALID_OBSERVER 

Area Target observer is NULL or invalid.

VU_MESH_AREA_TARGET_CREATION_ERROR_MESH_FILE_LOAD_ERROR 

External occlusion mesh file not found or an error occurred when reading data from it (potentially unknown or corrupted file).

Deprecated
This error is DEPRECATED, use VU_MESH_AREA_TARGET_CREATION_ERROR_MESH_LOAD_ERROR.
VU_MESH_AREA_TARGET_CREATION_ERROR_MESH_LOAD_ERROR 

Failed to load mesh data.

VU_MESH_AREA_TARGET_CREATION_ERROR_SAME_SOURCE_NOT_SUPPORTED 

A mesh observer is already attached to the Area Target observer.

◆ anonymous enum

anonymous enum
Enumerator
VU_OBSERVER_MESH_TYPE 

Type identifier for Mesh observers.

◆ anonymous enum

anonymous enum
Enumerator
VU_OBSERVATION_MESH_TYPE 

Type identifier for Mesh observations.

◆ VuMeshObservationStatus

enum VuMeshObservationStatus : int32_t

Status information on the mesh data in the observation.

Enumerator
VU_MESH_OBSERVATION_STATUS_NORMAL 

Mesh is normal.

VU_MESH_OBSERVATION_STATUS_LIMITED 

Mesh data is limited. The mesh might contain less detail or pieces of the mesh might be missing.

◆ VuMeshObservationStatusInfo

Status info for the pose of Mesh observations.

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

Note
All enum values defined by VuObservationPoseStatus may be reported as part of a Mesh observation, except VU_OBSERVATION_POSE_STATUS_TRACKED.
See also
VuPoseInfo
VuObservationPoseStatus
vuObservationHasPoseInfo
vuObservationGetPoseInfo
vuStateGetObservationsWithPoseInfo
vuMeshObservationGetStatusInfo
Enumerator
VU_MESH_OBSERVATION_STATUS_INFO_NORMAL 

Tracking working normally. Reported for VU_OBSERVATION_POSE_STATUS_EXTENDED_TRACKED.

VU_MESH_OBSERVATION_STATUS_INFO_NOT_OBSERVED 

Mesh is not observed. Reported for VU_OBSERVATION_POSE_STATUS_NO_POSE.

VU_MESH_OBSERVATION_STATUS_INFO_RELOCALIZING 

The tracking system is currently relocalizing. Reported for VU_OBSERVATION_POSE_STATUS_LIMITED.

VU_MESH_OBSERVATION_STATUS_INFO_MISSING_DATA 

Asynchronous loading failed. The Mesh pose is based on incomplete data. Tracking quality might decrease or the tracking might be lost. Reported for VU_OBSERVATION_POSE_STATUS_LIMITED.

VU_MESH_OBSERVATION_STATUS_INFO_WRONG_SCALE 

The scale of the source observer does not match the physical scale of the target. Reported for VU_OBSERVATION_POSE_STATUS_TRACKED, VU_OBSERVATION_POSE_STATUS_EXTENDED_TRACKED or VU_OBSERVATION_POSE_STATUS_LIMITED.

◆ VuMeshModelTargetCreationError

Configuration error for Mesh observer creation with Model Target observer.

Enumerator
VU_MESH_MODEL_TARGET_CREATION_ERROR_NONE 

No error.

VU_MESH_MODEL_TARGET_CREATION_ERROR_INTERNAL 

An internal error occurred while creating the observer.

VU_MESH_MODEL_TARGET_CREATION_ERROR_AUTOACTIVATION_FAILED 

An error occurred while auto-activating the observer.

VU_MESH_MODEL_TARGET_CREATION_ERROR_INVALID_OBSERVER 

Model Target observer is NULL or invalid.

VU_MESH_MODEL_TARGET_CREATION_ERROR_SAME_SOURCE_NOT_SUPPORTED 

A mesh observer is already attached to the Model Target observer.

Function Documentation

◆ vuMeshAreaTargetCaptureConfigDefault()

VuMeshAreaTargetCaptureConfig vuMeshAreaTargetCaptureConfigDefault ( )

Default Mesh observer configuration with Area Target Capture source.

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

◆ vuEngineCreateMeshObserverFromAreaTargetCaptureConfig()

VuResult vuEngineCreateMeshObserverFromAreaTargetCaptureConfig ( VuEngine * engine,
VuObserver ** observer,
const VuMeshAreaTargetCaptureConfig * config,
VuMeshAreaTargetCaptureCreationError * errorCode )

Create a Mesh observer with an Area Target Capture instance as source.

The Mesh observer will deliver Mesh observations that represent a mesh reconstruction of the environment as provided by the specified Area Target Capture instance. Because the Mesh observer is dependent on the existence of the Area Target Capture instance, one has to make sure to destroy the Mesh observer before the Area Target Capture instance is destroyed.

◆ vuMeshAreaTargetConfigDefault()

VuMeshAreaTargetConfig vuMeshAreaTargetConfigDefault ( )

Default Mesh observer configuration with Area Target observer.

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

◆ vuEngineCreateMeshObserverFromAreaTargetConfig()

VuResult vuEngineCreateMeshObserverFromAreaTargetConfig ( VuEngine * engine,
VuObserver ** observer,
const VuMeshAreaTargetConfig * config,
VuMeshAreaTargetCreationError * errorCode )

Create a Mesh observer with an Area Target observer as source.

The Mesh observer will deliver Mesh observations that represent a mesh reconstruction of the target tracked by the Area Target observer. Because the Mesh observer is dependent on the existence of the Area Target observer, one has to make sure to destroy the Mesh observer before the associated Area Target observer is destroyed.

◆ vuMeshObservationGetStatusInfo()

VuResult vuMeshObservationGetStatusInfo ( const VuObservation * observation,
VuMeshObservationStatusInfo * statusInfo )

Get status info associated to the pose status of a Mesh observation.

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

◆ vuMeshModelTargetConfigDefault()

VuMeshModelTargetConfig vuMeshModelTargetConfigDefault ( )

Default Mesh observer configuration with a Model Target.

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

◆ vuEngineCreateMeshObserverFromModelTargetConfig()

VuResult vuEngineCreateMeshObserverFromModelTargetConfig ( VuEngine * engine,
VuObserver ** observer,
const VuMeshModelTargetConfig * config,
VuMeshModelTargetCreationError * errorCode )

Create a Mesh observer with a Model Target as source.

The observed mesh is the 3D representation of the Model Target currently observed by the associated source observer. In case the associated source observer has not observed the Model Target, the mesh observer will publish the last known mesh but with an identity pose and pose status VU_OBSERVATION_POSE_STATUS_NO_POSE. Because the Mesh observer is dependent on the existence of the Model Target observer, one has to make sure to destroy the Mesh observer before the associated Model Target observer is destroyed.