AugmentedReality

Windows
MacOS
Linux

Classes

Name

Description

Public class

AARActor

Public class

AAROriginActor

Simple actor that is spawned at the origin for AR systems that want to hang components on an actor Spawned as a custom class for easier TObjectIterator use

Public class

AARSharedWorldGameMode

Public class

AARSharedWorldGameState

Public class

AARSharedWorldPlayerController

Public class

AARSkyLight

This sky light class forces a refresh of the cube map data when an AR environment probe changes

Public struct

FAccumulatedNormal

Public class

FARAsyncTask

Base class for async AR requests

Public struct

FARCameraIntrinsics

AR camera intrinsics

Public struct

FAREnvironmentProbeUpdatePayload

Public class

FARErrorGetCandidateObjectAsyncTask

Public class

FARErrorSaveWorldAsyncTask

Public struct

FARFaceUpdatePayload

Public struct

FARGeoAnchorUpdatePayload

Public class

FARGetCandidateObjectAsyncTask

Async task that builds a candidate object used for detection from the ar session

Public class

FARGetCandidateObjectPin

Public struct

FARImageUpdatePayload

Public struct

FARMeshUpdatePayload

Public struct

FARObjectUpdatePayload

Public struct

FARPlaneUpdatePayload

Public struct

FARPointUpdatePayload

Public struct

FARPose2D

Represents a human pose tracked in the 2D space

Public struct

FARPose3D

Represents a human pose tracked in the 3D space

Public struct

FARPoseUpdatePayload

Public struct

FARQRCodeUpdatePayload

Public class

FARSaveWorldAsyncTask

Async task that saves the world data into a buffer

Public class

FARSaveWorldPin

Public struct

FARSessionPayload

Public struct

FARSessionStatus

The current state of the AR subsystem including an optional explanation string.

Public struct

FARSharedWorldReplicationState

Per player information about what data has been sent to them

Public struct

FARSkeletonDefinition

Represents a hierarchy of a human pose skeleton tracked by the AR system

Public class

FARSupportInterface

Composition Components for tracking system features

Public class

FARSystemSupportBase

Public struct

FARTraceResult

A result of an intersection found during a hit-test.

Public struct

FARVideoFormat

A specific AR video format

Public class

FCheckGeoTrackingAvailabilityAsyncTask

Async task to check Geo tracking availability.

Public class

FGetGeoLocationAsyncTask

Async task to convert Geo location.

Public class

FOnARTrackingStateChanged

Public class

FOnARTransformUpdated

Public class

FTrackableDelegate

Public class

FTrackableEnvProbeDelegate

Public class

FTrackableFaceDelegate

Public class

FTrackableImageDelegate

Public class

FTrackableObjectDelegate

Public class

FTrackablePlaneDelegate

Public class

FTrackablePointDelegate

Public struct

FTrackedGeometryGroup

Public class

IARRef

A reference to a system-level AR object

Public class

IARSessionConfigCookSupport

Public class

IARSystemSupport

Implement IARSystemSupport for any platform that wants to be an Unreal Augmented Reality System.

Public class

UARBaseAsyncTaskBlueprintProxy

Public class

UARBasicLightEstimate

Public class

UARBlueprintLibrary

Public class

UARCandidateImage

An asset that points to an image to be detected in a scene and provides the size of the object in real life

Public class

UARCandidateObject

An asset that points to an object to be detected in a scene

Public class

UARComponent

ARComponent handles replication and visualization update for AR tracked geometries ARComponent is created in either multiplayer or local only environment

Public class

UARDependencyHandler

Helper class that allows the user to explicitly request AR service installation and permission granting.

Public class

UAREnvironmentCaptureProbe

A tracked environment texture probe that gives you a cube map for reflections

Public class

UAREnvironmentCaptureProbeTexture

Base class for all AR textures that represent the environment for lighting and reflection

Public class

UAREnvironmentProbeComponent

Public class

UARFaceComponent

Public class

UARFaceGeometry

Public class

UARGeoAnchor

Public class

UARGeoAnchorComponent

Public class

UARGeoTrackingSupport

Interface class for Geo tracking related features.

Public class

UARGetCandidateObjectAsyncTaskBlueprintProxy

Public class

UARImageComponent

Public class

UARLifeCycleComponent

Public class

UARLightEstimate

Public class

UARMeshComponent

Public class

UARMeshGeometry

Public class

UARObjectComponent

Public class

UARPin

Public class

UARPlaneComponent

Public class

UARPlaneGeometry

Public class

UARPointComponent

Public class

UARPoseComponent

Public class

UARQRCodeComponent

Public class

UARSaveWorldAsyncTaskBlueprintProxy

Public class

UARSessionConfig

Public class

UARTexture

Base class for all AR texture types.

Public class

UARTextureCameraDepth

Base class for all AR textures that represent the camera depth data

Public class

UARTextureCameraImage

Base class for all AR textures that represent the camera image data

Public class

UARTraceResultDummy

Public class

UARTraceResultLibrary

Public class

UARTrackableNotifyComponent

Component used to listen to ar trackable object changes

Public class

UARTrackedGeometry

Public class

UARTrackedImage

Public class

UARTrackedObject

Public class

UARTrackedPoint

Public class

UARTrackedPose

Public class

UARTrackedQRCode

Public class

UARTypesDummyClass

Public class

UCheckGeoTrackingAvailabilityAsyncTaskBlueprintProxy

Blueprint async task to check Geo tracking availability.

Public class

UGetGeoLocationAsyncTaskBlueprintProxy

Blueprint async task to convert Geo location.

Typedefs

Enums

Name

Description

Public enum

EARAltitudeSource

Public enum

EARCandidateImageOrientation

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

Public enum

EARCaptureType

Public enum

EARDepthAccuracy

Public enum

EARDepthQuality

Public enum

EAREnvironmentCaptureProbeType

Tells the AR system what type of environmental texture capturing to perform

Public enum

EAREye

Public enum

EARFaceBlendShape

Public enum

EARFaceTrackingDirection

Public enum

EARFaceTrackingUpdate

Tells the AR system how much of the face work to perform

Public enum

EARFaceTransformMixing

Public enum

EARFrameSyncMode

Public enum

EARGeoTrackingAccuracy

Public enum

EARGeoTrackingState

Public enum

EARGeoTrackingStateReason

Public enum

EARJointTransformSpace

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

Public enum

EARLightEstimationMode

Public enum

EARLineTraceChannels

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

Public enum

EARObjectClassification

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

Public enum

EARPlaneDetectionMode

Public enum

EARPlaneOrientation

Describes the tracked plane orientation

Public enum

EARSceneReconstruction

Possible scene reconstruction methods

Public enum

EARServiceAvailability

Public enum

EARServiceInstallRequestResult

Public enum

EARServicePermissionRequestResult

Public enum

EARSessionConfigFlags

Public enum

EARSessionStatus

Describes the current status of the AR session.

Public enum

EARSessionTrackingFeature

Additional tracking features to be enabled if the device supports it

Public enum

EARSessionType

Public enum

EARTextureType

Public enum

EARTrackingQuality

Public enum

EARTrackingQualityReason

Public enum

EARTrackingState

Public enum

EARWorldAlignment

Public enum

EARWorldMappingState

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

Public enum

EFaceComponentDebugMode

Public enum

EGeoAnchorComponentDebugMode

Public enum

EImageComponentDebugMode

Public enum

EPlaneComponentDebugMode

Public enum

EPoseComponentDebugMode

Public enum

EQRCodeComponentDebugMode

Functions

Name Description

Public function

constexpr bo ...

 

operator!

(
    EARPlaneDetectionMode E
)

Public function

constexpr bo ...

 

operator!

(
    EARLineTraceChannels E
)

Public function

constexpr EA ...

 

operator&

(
    EARPlaneDetectionMode Lhs,
    EARPlaneDetectionMode Rhs
)

Public function

constexpr EA ...

 

operator&

(
    EARLineTraceChannels Lhs,
    EARLineTraceChannels Rhs
)

Public function

EARPlaneDete ...

 

operator&=

(
    EARPlaneDetectionMode & Lhs,
    EARPlaneDetectionMode Rhs
)

Public function

EARLineTrace ...

 

operator&=

(
    EARLineTraceChannels & Lhs,
    EARLineTraceChannels Rhs
)

Public function

constexpr EA ...

 

operator^

(
    EARPlaneDetectionMode Lhs,
    EARPlaneDetectionMode Rhs
)

Public function

constexpr EA ...

 

operator^

(
    EARLineTraceChannels Lhs,
    EARLineTraceChannels Rhs
)

Public function

EARPlaneDete ...

 

operator^=

(
    EARPlaneDetectionMode & Lhs,
    EARPlaneDetectionMode Rhs
)

Public function

EARLineTrace ...

 

operator^=

(
    EARLineTraceChannels & Lhs,
    EARLineTraceChannels Rhs
)

Public function

constexpr EA ...

 

operator|

(
    EARPlaneDetectionMode Lhs,
    EARPlaneDetectionMode Rhs
)

Public function

constexpr EA ...

 

operator|

(
    EARLineTraceChannels Lhs,
    EARLineTraceChannels Rhs
)

Public function

EARPlaneDete ...

 

operator|=

(
    EARPlaneDetectionMode & Lhs,
    EARPlaneDetectionMode Rhs
)

Public function

EARLineTrace ...

 

operator|=

(
    EARLineTraceChannels & Lhs,
    EARLineTraceChannels Rhs
)

Public function

constexpr EA ...

 

operator~

(
    EARPlaneDetectionMode E
)

Public function

constexpr EA ...

 

operator~

(
    EARLineTraceChannels E
)

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback