Public Attributes
VuObserver *	devicePoseObserver
	Pointer to a device pose observer.

const char *	path
	Path to the image file. The image stored in the file needs to contain an alpha channel, e.g., specify RGBA pixel data.

const char *	label
	Label for the image.

const char *	validationAreaName
	Validation Area name.

VuBool	activate
	Observer activation.

VuMatrix44F	poseOffset
	Offset from the origin of the Validation Area to the pose reported by an observation, relative to the area's frame of reference.

Detailed Description

Configuration for creating a Validation Area observer using an image file.

The Validation Area is defined by an opaque mask stored in the alpha channel of the image file.

Member Data Documentation

◆ devicePoseObserver

VuObserver* devicePoseObserver

Pointer to a device pose observer.

The Validation Area observer will only report observations with pose to the state while there is an active device pose observer. Set devicePoseObserver to nullptr if poses are not required. Pose status will then constantly be reported as VU_OBSERVATION_POSE_STATUS_NO_POSE.

Note: On platforms other than iOS, pose status is constantly reported as VU_OBSERVATION_POSE_STATUS_NO_POSE, no matter if devicePoseObserver is set to an active device pose observer or not.

◆ path

const char* path

Path to the image file. The image stored in the file needs to contain an alpha channel, e.g., specify RGBA pixel data.

Supported file extensions are "png", "webp" and "avif".

Note: "avif" files are only supported on iOS platform.

◆ activate

VuBool activate

Observer activation.

Note: The default value is VU_TRUE.

◆ poseOffset

VuMatrix44F poseOffset

Offset from the origin of the Validation Area to the pose reported by an observation, relative to the area's frame of reference.