UARSessionConfig

An Unreal Data Asset that defines what features are used in the AR session.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

AugmentedReality

Header

/Engine/Source/Runtime/AugmentedReality/Public/ARSessionConfig.h

Include

#include "ARSessionConfig.h"

Syntax

class UARSessionConfig : public UDataAsset

Remarks

An Unreal Data Asset that defines what features are used in the AR session.

Variables

Name Description

Protected variable

bool

 

bEnableAutoFocus

Boolean to determine whether the camera should autofocus.

Protected variable

bool

 

bEnableAutomaticCameraOverlay

Boolean to determine whether the AR camera feed should be drawn as an overlay.

Protected variable

bool

 

bEnableAutomaticCameraTracking

Boolean to determine whether the virtual camera should track the device movement.

Public variable

bool

 

bGenerateCollisionForMeshData

Boolean to determine whether the AR system should generate collision data from the mesh data.

Public variable

bool

 

bGenerateMeshDataFromTrackedGeometry

Boolean to determine whether the AR system should generate mesh data that can be used for rendering, collision, NavMesh, and more.

Public variable

bool

 

bGenerateNavMeshForMeshData

Boolean to determine whether the AR system should generate collision data from the mesh data.

Protected variable

bool

 

bHorizontalPlaneDetection

Boolean to determine whether flat, horizontal surfaces are detected.

Public variable

bool

 

bRenderMeshDataInWireframe

Boolean to determine whether the AR system should render the mesh data as wireframe.

Protected variable

bool

 

bResetCameraTracking

Boolean to determine whether the AR system should reset camera tracking, such as its origin and transforms, when a new AR session starts.

Protected variable

bool

 

bResetTrackedObjects

Boolean to determine whether the AR system should remove any tracked objects when a new AR session starts.

Public variable

bool

 

bTrackSceneObjects

Boolean to determine whether the AR system should track scene objects:

Public variable

bool

 

bUseAutomaticImageScaleEstimation

Boolean to determine whether to automatically estimate and set the scale of a detected, or tracked, image.

Public variable

bool

 

bUseMeshDataForOcclusion

Boolean to determine whether the AR system should render the mesh data as occlusion meshes.

Protected variable

bool

 

bUseOptimalVideoFormat

Boolean to determine whether to automatically pick the video format that best matches the device screen size

Public variable

bool

 

bUsePersonSegmentationForOcclusion

Boolean to determine whether to use the person segmentation results for occluding virtual content.

Public variable

bool

 

bUseSceneDepthForOcclusion

Boolean to determine whether to use the scene depth information for occluding virtual content.

Public variable

bool

 

bUseStandardOnboardingUX

Boolean to determine whether to use the standard onboarding UX, if the system supports it.

Protected variable

bool

 

bVerticalPlaneDetection

Boolean to determine whether flat, vertical surfaces are detected.

Protected variable

TArray< TObject...

 

CandidateImages

The list of candidate images to detect within the AR camera view. This feature is used by ARKit.

Protected variable

TArray< TObject...

 

CandidateObjects

The list of candidate objects to search for in the scene. This feature is used by ARKit.

Protected variable

TObjectPtr< UMa...

 

DefaultMeshMaterial

The default mesh material used by the generated mesh component.

Protected variable

TObjectPtr< UMa...

 

DefaultWireframeMeshMaterial

The default mesh material used by the wireframe setting of the generated mesh component.

Protected variable

FARVideoFormat

 

DesiredVideoFormat

The desired video format (or the default, if not supported) that this session should use if the camera is enabled.

Protected variable

EARSessionTrack...

 

EnabledSessionTrackingFeature

Protected variable

EAREnvironmentC...

 

EnvironmentCaptureProbeType

Protected variable

TSubclassOf< UA...

 

EnvironmentProbeComponentClass

Protected variable

TSubclassOf< UA...

 

FaceComponentClass

Protected variable

EARFaceTracking...

 

FaceTrackingDirection

Protected variable

EARFaceTracking...

 

FaceTrackingUpdate

Protected variable

EARFrameSyncMod...

 

FrameSyncMode

Protected variable

TSubclassOf< UA...

 

GeoAnchorComponentClass

Protected variable

TSubclassOf< UA...

 

ImageComponentClass

Protected variable

EARLightEstimat...

 

LightEstimationMode

Protected variable

int32

 

MaxNumberOfTrackedFaces

The maximum number of faces to track simultaneously. This feature is used by ARKit.

Protected variable

int32

 

MaxNumSimultaneousImagesTracked

The maximum number of images to track at the same time.

Protected variable

TSubclassOf< UA...

 

MeshComponentClass

Protected variable

TSubclassOf< UA...

 

ObjectComponentClass

Protected variable

TSubclassOf< UA...

 

PlaneComponentClass

Protected variable

TSubclassOf< UA...

 

PointComponentClass

Protected variable

TSubclassOf< UA...

 

PoseComponentClass

Protected variable

TSubclassOf< UA...

 

QRCodeComponentClass

Protected variable

EARSceneReconst...

 

SceneReconstructionMethod

Protected variable

TArray< uint8 >

 

SerializedARCandidateImageDatabase

Data array for storing the cooked image database. This feature is used by ARCore.

Protected variable

EARSessionType

 

SessionType

Protected variable

EARWorldAlignme...

 

WorldAlignment

Protected variable

TArray< uint8 >

 

WorldMapData

A previously saved world that will be loaded when the session starts.

Constructors

Name Description

Public function

UARSessionConfig()

The constructor for the AR Session Config Data Asset.

Functions

Name Description

Public function

void

 

AddCandidateImage

(
    UARCandidateImage* NewCandidat...
)

Add a new CandidateImage to the ARSessionConfig.

Public function

void

 

AddCandidateObject

(
    UARCandidateObject* CandidateO...
)

Public function Const

const TArray...

 

GetCandidateImageList()

Public function Const

const TArray...

 

GetCandidateObjectList()

Public function Const

UMaterialInt...

 

GetDefaultMeshMaterial()

Public function Const

UMaterialInt...

 

GetDefaultWireframeMeshMaterial()

Public function Const

FARVideoForm...

 

GetDesiredVideoFormat()

Public function Const

EARSessionTr...

 

GetEnabledSessionTrackingFeature()

Public function Const

EAREnvironme...

 

GetEnvironmentCaptureProbeType()

Public function Const

UClass *

 

GetEnvironmentProbeComponentClass()

Public function Const

UClass *

 

GetFaceComponentClass()

Public function Const

EARFaceTrack...

 

GetFaceTrackingDirection()

Public function Const

EARFaceTrack...

 

GetFaceTrackingUpdate()

Public function Const

EARFrameSync...

 

GetFrameSyncMode()

Public function Const

UClass *

 

GetGeoAnchorComponentClass()

Public function Const

UClass *

 

GetImageComponentClass()

Public function Const

EARLightEsti...

 

GetLightEstimationMode()

Public function Const

int32

 

GetMaxNumberOfTrackedFaces()

Public function Const

int32

 

GetMaxNumSimultaneousImagesTracked()

Public function Const

UClass *

 

GetMeshComponentClass()

Public function Const

UClass *

 

GetObjectComponentClass()

Public function Const

UClass *

 

GetPlaneComponentClass()

Public function Const

EARPlaneDete...

 

GetPlaneDetectionMode()

Public function Const

UClass *

 

GetPointComponentClass()

Public function Const

UClass *

 

GetPoseComponentClass()

Public function Const

UClass *

 

GetQRCodeComponentClass()

Public function Const

EARSceneReco...

 

GetSceneReconstructionMethod()

Public function Const

const TArray...

 

GetSerializedARCandidateImageDatabase()

Public function Const

EARSessionTy...

 

GetSessionType()

Public function Const

EARWorldAlig...

 

GetWorldAlignment()

Public function Const

const TArray...

 

GetWorldMapData()

Public function

void

 

SetCandidateObjectList

(
    const TArray< UARCandidateObject&#...
)

Public function

void

 

SetDesiredVideoFormat

(
    FARVideoFormat NewFormat
)

Public function

void

 

SetEnableAutoFocus

(
    bool bNewValue
)

Public function

void

 

SetFaceTrackingDirection

(
    EARFaceTrackingDirection InDirectio...
)

Public function

void

 

SetFaceTrackingUpdate

(
    EARFaceTrackingUpdate InUpdate
)

Public function

void

 

SetResetCameraTracking

(
    bool bNewValue
)

Public function

void

 

SetResetTrackedObjects

(
    bool bNewValue
)

Public function

void

 

SetSceneReconstructionMethod

(
    EARSceneReconstruction InSceneRecon...
)

Public function

void

 

SetSessionTrackingFeatureToEnable

(
    EARSessionTrackingFeature InSession...
)

Public function

void

 

SetWorldMapData

(
    TArray< uint8 > WorldMapData
)

Public function Const

bool

 

ShouldDoHorizontalPlaneDetection()

Public function Const

bool

 

ShouldDoVerticalPlaneDetection()

Public function Const

bool

 

ShouldEnableAutoFocus()

Public function Const

bool

 

ShouldEnableCameraTracking()

Public function Const

bool

 

ShouldRenderCameraOverlay()

Public function Const

bool

 

ShouldResetCameraTracking()

Public function Const

bool

 

ShouldResetTrackedObjects()

Public function Const

bool

 

ShouldUseOptimalVideoFormat()

Deprecated Variables