ARTypes.h File Reference

#include "Engine/DataAsset.h"
#include "HAL/ThreadSafeBool.h"
#include "ARTypes.generated.h"

Go to the source code of this file.

Classes
struct	FARSessionStatus
class	UARTypesDummyClass
class	IARRef
class	UARCandidateImage
class	UARCandidateObject
class	FARAsyncTask
class	FARSaveWorldAsyncTask
class	FARGetCandidateObjectAsyncTask
class	FARErrorGetCandidateObjectAsyncTask
class	FARErrorSaveWorldAsyncTask
struct	FARVideoFormat
struct	FARSkeletonDefinition
struct	FARPose2D
struct	FARPose3D
struct	FARCameraIntrinsics

Macros
#define	UE_API   AUGMENTEDREALITY_API

Typedefs
typedef FOnTrackableAdded::FDelegate	FOnTrackableAddedDelegate
typedef FOnTrackableUpdated::FDelegate	FOnTrackableUpdatedDelegate
typedef FOnTrackableRemoved::FDelegate	FOnTrackableRemovedDelegate

Enumerations
enum class	EARTrackingState : uint8 { Unknown , Tracking , NotTracking , StoppedTracking }
enum class	EARCaptureType : uint8 {   Camera , QRCode , SpatialMapping , SceneUnderstanding ,   HandMesh }
enum class	EARLineTraceChannels : uint8 {   None = 0 , FeaturePoint = 1 , GroundPlane = 2 , PlaneUsingExtent = 4 ,   PlaneUsingBoundaryPolygon = 8 }
enum class	EARTrackingQuality : uint8 { NotTracking , OrientationOnly , OrientationAndPosition }
enum class	EARTrackingQualityReason : uint8 {   None , Initializing , Relocalizing , ExcessiveMotion ,   InsufficientFeatures , InsufficientLight , BadState }
enum class	EARSessionStatus : uint8 {   NotStarted , Running , NotSupported , FatalError ,   PermissionNotGranted , UnsupportedConfiguration , Other }
enum class	EARWorldMappingState : uint8 { NotAvailable , StillMappingNotRelocalizable , StillMappingRelocalizable , Mapped }
enum class	EARPlaneOrientation : uint8 { Horizontal , Vertical , Diagonal }
enum class	EARObjectClassification : uint8 {   NotApplicable , Unknown , Wall , Ceiling ,   Floor , Table , Seat , Face ,   Image , World , SceneObject , HandMesh ,   Door , Window }
enum class	EARSpatialMeshUsageFlags : uint8 { NotApplicable = 0 , Visible = 1 << 0 , Collision = 1 << 1 }
enum class	EARJointTransformSpace : uint8 { Model , ParentJoint }
enum class	EARAltitudeSource : uint8 { Precise , Coarse , UserDefined , Unknown }
enum class	EARCandidateImageOrientation : uint8 { Landscape , Portrait }

Functions
	DECLARE_MULTICAST_DELEGATE_OneParam (FOnTrackableAdded, UARTrackedGeometry *)
	DECLARE_MULTICAST_DELEGATE_OneParam (FOnTrackableUpdated, UARTrackedGeometry *)
	DECLARE_MULTICAST_DELEGATE_OneParam (FOnTrackableRemoved, UARTrackedGeometry *)
	ENUM_CLASS_FLAGS (EARLineTraceChannels)
	DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam (FOnARTrackingStateChanged, EARTrackingState, NewTrackingState)
	DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam (FOnARTransformUpdated, const FTransform &, OldToNewTransform)

Macro Definition Documentation

UE_API

#define UE_API   AUGMENTEDREALITY_API

Typedef Documentation

FOnTrackableAddedDelegate

typedef FOnTrackableAdded::FDelegate FOnTrackableAddedDelegate

FOnTrackableRemovedDelegate

typedef FOnTrackableRemoved::FDelegate FOnTrackableRemovedDelegate

FOnTrackableUpdatedDelegate

typedef FOnTrackableUpdated::FDelegate FOnTrackableUpdatedDelegate

Enumeration Type Documentation

EARAltitudeSource

enum class EARAltitudeSource : uint8

strong

Enumerator
Precise
Coarse
UserDefined
Unknown

EARCandidateImageOrientation

enum class EARCandidateImageOrientation : uint8

strong

Tells the image detection code how to assume the image is oriented

Enumerator
Landscape
Portrait

EARCaptureType

enum class EARCaptureType : uint8

strong

Enumerator
Camera	Camera Capture
QRCode	QR Code Capture.
SpatialMapping	Spatial mapping so the app can selectively turn off discovering surfaces
SceneUnderstanding	Capture detailed information about the scene with all surfaces like walls, floors and so on
HandMesh	Capture a mesh around the player's hands

EARJointTransformSpace

enum class EARJointTransformSpace : uint8

strong

Describes the potential spaces in which the join transform can be defined with AR pose tracking

Enumerator
Model	Joint transform is relative to the origin of the model space which is usually attached to a particular joint such as the hip
ParentJoint	Joint transform is relative to its parent

EARLineTraceChannels

enum class EARLineTraceChannels : uint8

strong

Channels that let users select which kind of tracked geometry to trace against.

Enumerator
None
FeaturePoint	Trace against points that the AR system considers significant .
GroundPlane	Trace against estimated plane that does not have an associated tracked geometry.
PlaneUsingExtent	Trace against any plane tracked geometries using Center and Extent.
PlaneUsingBoundaryPolygon	Trace against any plane tracked geometries using the boundary polygon.

EARObjectClassification

enum class EARObjectClassification : uint8

strong

Indicates what type of object the scene understanding system thinks it is

Enumerator
NotApplicable	Not applicable to scene understanding
Unknown	Scene understanding doesn't know what this is
Wall	A vertical plane that is a wall
Ceiling	A horizontal plane that is the ceiling
Floor	A horizontal plane that is the floor
Table	A horizontal plane that is a table
Seat	A horizontal plane that is a seat
Face	A human face
Image	A recognized image in the scene
World	A chunk of mesh that does not map to a specific object type but is seen by the AR system
SceneObject	A closed mesh that was identified in the scene
HandMesh	A user's hand
Door	A door
Window	A window

EARPlaneOrientation

enum class EARPlaneOrientation : uint8

strong

Describes the tracked plane orientation

Enumerator
Horizontal
Vertical
Diagonal	For AR systems that can match planes to slopes

EARSessionStatus

enum class EARSessionStatus : uint8

strong

Describes the current status of the AR session.

Enumerator
NotStarted	Unreal AR session has not started yet.
Running	Unreal AR session is running.
NotSupported	Unreal AR session failed to start due to the AR subsystem not being supported by the device.
FatalError	The AR session encountered fatal error; the developer should call StartARSession() to re-start the AR subsystem.
PermissionNotGranted	AR session failed to start because it lacks the necessary permission (likely access to the camera or the gyroscope).
UnsupportedConfiguration	AR session failed to start because the configuration isn't supported.
Other	Session isn't running due to unknown reason; See also FARSessionStatus::AdditionalInfo for more information

EARSpatialMeshUsageFlags

enum class EARSpatialMeshUsageFlags : uint8

strong

Indicates how the spatial mesh should be visualized

Enumerator
NotApplicable	Not applicable to scene understanding.
Visible	This mesh should have a visible material applied to it.
Collision	This mesh should be used when placing objects on real world surfaces. This must be set to use physics with this mesh.

EARTrackingQuality

enum class EARTrackingQuality : uint8

strong

Enumerator
NotTracking	The tracking quality is not available.
OrientationOnly	The tracking quality is limited, relying only on the device's motion.
OrientationAndPosition	The tracking quality is good.

EARTrackingQualityReason

enum class EARTrackingQualityReason : uint8

strong

Enumerator
None	Current Tracking is not limited
Initializing	The AR session has not yet gathered enough camera or motion data to provide tracking information.
Relocalizing	The AR session is attempting to resume after an interruption.
ExcessiveMotion	The device is moving too fast for accurate image-based position tracking.
InsufficientFeatures	The scene visible to the camera does not contain enough distinguishable features for image-based position tracking.
InsufficientLight	Tracking lost due to poor lighting conditions. Please move to a more brightly lit area
BadState	Tracking lost due to bad internal state. Please try restarting the AR experience.

EARTrackingState

enum class EARTrackingState : uint8

strong

Enumerator
Unknown	Unknown tracking state
Tracking	Currently tracking.
NotTracking	Currently not tracking, but may resume tracking later.
StoppedTracking	Stopped tracking forever.

EARWorldMappingState

enum class EARWorldMappingState : uint8

strong

Gives feedback as to whether the AR data can be saved and relocalized or not

Enumerator
NotAvailable	World mapping is not available
StillMappingNotRelocalizable	World mapping is still in progress but without enough data for relocalization
StillMappingRelocalizable	World mapping is still in progress but there is enough data captured for relocalization
Mapped	World mapping has mapped the area and is fully relocalizable

Function Documentation

DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam() [1/2]

DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam	(	FOnARTrackingStateChanged	,
		EARTrackingState	,
		NewTrackingState
	)

DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam() [2/2]

DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam	(	FOnARTransformUpdated	,
		const FTransform &	,
		OldToNewTransform
	)

DECLARE_MULTICAST_DELEGATE_OneParam() [1/3]

DECLARE_MULTICAST_DELEGATE_OneParam	(	FOnTrackableAdded	,
		UARTrackedGeometry *
	)

DECLARE_MULTICAST_DELEGATE_OneParam() [2/3]

DECLARE_MULTICAST_DELEGATE_OneParam	(	FOnTrackableRemoved	,
		UARTrackedGeometry *
	)

DECLARE_MULTICAST_DELEGATE_OneParam() [3/3]

DECLARE_MULTICAST_DELEGATE_OneParam	(	FOnTrackableUpdated	,
		UARTrackedGeometry *
	)

ENUM_CLASS_FLAGS()

ENUM_CLASS_FLAGS

(

EARLineTraceChannels

)