UARSessionConfig | Unreal Engine 5.7 Documentation

API > API/Runtime > API/Runtime/AugmentedReality

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


Name	UARSessionConfig
Type	class
Header File	/Engine/Source/Runtime/AugmentedReality/Public/ARSessionConfig.h
Include Path	#include "ARSessionConfig.h"

Syntax

UCLASS (MinimalAPI, BlueprintType, Category="AR Settings")  
class UARSessionConfig : public UDataAsset

Inheritance Hierarchy

UObjectBase → UObjectBaseUtility → UObject → UDataAsset → UARSessionConfig

Derived Classes

UGoogleARCoreSessionConfig

Constructors

Name	Remarks	Include Path	Unreal Specifiers
UARSessionConfig()	The constructor for the AR Session Config Data Asset.	ARSessionConfig.h

Variables

Public

Name	Type	Remarks	Include Path	Unreal Specifiers
bGenerateCollisionForMeshData	bool	Boolean to determine whether the AR system should generate collision data from the mesh data.	ARSessionConfig.h	EditAnywhere Category="AR Settings \| World Mapping"
bGenerateMeshDataFromTrackedGeometry	bool	Boolean to determine whether the AR system should generate mesh data that can be used for rendering, collision, NavMesh, and more.	ARSessionConfig.h	EditAnywhere Category="AR Settings \| World Mapping"
bGenerateNavMeshForMeshData	bool	Boolean to determine whether the AR system should generate collision data from the mesh data.	ARSessionConfig.h	EditAnywhere Category="AR Settings \| World Mapping"
bRenderMeshDataInWireframe	bool	Boolean to determine whether the AR system should render the mesh data as wireframe.	ARSessionConfig.h	EditAnywhere Category="AR Settings \| World Mapping"
bTrackSceneObjects	bool	Boolean to determine whether the AR system should track scene objects:	ARSessionConfig.h	EditAnywhere Category="AR Settings \| World Mapping"
bUseAutomaticImageScaleEstimation	bool	Boolean to determine whether to automatically estimate and set the scale of a detected, or tracked, image.	ARSessionConfig.h	EditAnywhere Category="AR Settings \| Image Tracking"
bUseMeshDataForOcclusion	bool	Boolean to determine whether the AR system should render the mesh data as occlusion meshes.	ARSessionConfig.h	EditAnywhere Category="AR Settings \| World Mapping"
bUsePersonSegmentationForOcclusion	bool	Boolean to determine whether to use the person segmentation results for occluding virtual content.	ARSessionConfig.h	EditAnywhere Category="AR Settings \| Occlusion"
bUseSceneDepthForOcclusion	bool	Boolean to determine whether to use the scene depth information for occluding virtual content.	ARSessionConfig.h	EditAnywhere Category="AR Settings \| Occlusion"
bUseStandardOnboardingUX	bool	Boolean to determine whether to use the standard onboarding UX, if the system supports it.	ARSessionConfig.h	EditAnywhere Category="AR Settings"

Functions

Public

Name	Remarks	Include Path	Unreal Specifiers
void AddCandidateImage ( UARCandidateImage* NewCandidateImage )	Add a new CandidateImage to the ARSessionConfig.	ARSessionConfig.h	BlueprintCallable Category="AR Settings"
void AddCandidateObject ( UARCandidateObject* CandidateObject )		ARSessionConfig.h	BlueprintCallable Category="AR Settings"
void ClearCandidateImages()	Remove all candidate images from the ARSessionConfig.	ARSessionConfig.h	BlueprintCallable Category="AR Settings"
const TArray< UARCandidateImage * > & GetCandidateImageList ()		ARSessionConfig.h	BlueprintCallable Category="AR Settings"
const TArray< UARCandidateObject * > & GetCandidateObjectList ()		ARSessionConfig.h	BlueprintCallable Category="AR Settings"
UMaterialInterface * GetDefaultMeshMaterial ()		ARSessionConfig.h
UMaterialInterface * GetDefaultWireframeMeshMaterial ()		ARSessionConfig.h
FARVideoFormat GetDesiredVideoFormat ()		ARSessionConfig.h	BlueprintCallable Category="AR Settings"
EARSessionTrackingFeature GetEnabledSessionTrackingFeature ()		ARSessionConfig.h	BlueprintCallable Category="AR Settings"
EAREnvironmentCaptureProbeType GetEnvironmentCaptureProbeType ()		ARSessionConfig.h	BlueprintCallable Category="AR Settings"
UClass * GetEnvironmentProbeComponentClass ()		ARSessionConfig.h
UClass * GetFaceComponentClass ()		ARSessionConfig.h
EARFaceTrackingDirection GetFaceTrackingDirection ()		ARSessionConfig.h	BlueprintCallable Category="AR Settings"
EARFaceTrackingUpdate GetFaceTrackingUpdate ()		ARSessionConfig.h	BlueprintCallable Category="AR Settings"
EARFrameSyncMode GetFrameSyncMode ()		ARSessionConfig.h	BlueprintCallable Category="AR Settings"
UClass * GetGeoAnchorComponentClass ()		ARSessionConfig.h
UClass * GetImageComponentClass ()		ARSessionConfig.h
EARLightEstimationMode GetLightEstimationMode ()		ARSessionConfig.h	BlueprintCallable Category="AR Settings"
int32 GetMaxNumberOfTrackedFaces ()		ARSessionConfig.h
int32 GetMaxNumSimultaneousImagesTracked ()		ARSessionConfig.h	BlueprintCallable Category="AR Settings"
UClass * GetMeshComponentClass ()		ARSessionConfig.h
UClass * GetObjectComponentClass ()		ARSessionConfig.h
UClass * GetPlaneComponentClass ()		ARSessionConfig.h
EARPlaneDetectionMode GetPlaneDetectionMode ()		ARSessionConfig.h	BlueprintCallable Category="AR Settings"
UClass * GetPointComponentClass ()		ARSessionConfig.h
UClass * GetPoseComponentClass ()		ARSessionConfig.h
UClass * GetQRCodeComponentClass ()		ARSessionConfig.h
EARSceneReconstruction GetSceneReconstructionMethod ()		ARSessionConfig.h	BlueprintCallable Category="AR Settings"
const TArray< uint8 > & GetSerializedARCandidateImageDatabase ()		ARSessionConfig.h
EARSessionType GetSessionType ()		ARSessionConfig.h	BlueprintCallable Category="AR Settings"
EARWorldAlignment GetWorldAlignment ()		ARSessionConfig.h	BlueprintCallable Category="AR Settings"
const TArray< uint8 > & GetWorldMapData ()		ARSessionConfig.h	BlueprintCallable Category="AR Settings"
void RemoveCandidateImage ( UARCandidateImage* CandidateImage )	Remove a candidate image from the ARSessionConfig, by pointer, note the image object must match, not the content of the image.	ARSessionConfig.h	BlueprintCallable Category="AR Settings"
void RemoveCandidateImageAtIndex ( int Index )	Remove a candidate image from the ARSessionConfig, by index.	ARSessionConfig.h	BlueprintCallable Category="AR Settings"
void SetCandidateObjectList ( const TArray< UARCandidateObject* >& InCandidateObjects )		ARSessionConfig.h	BlueprintCallable Category="AR Settings"
void SetDesiredVideoFormat ( FARVideoFormat NewFormat )		ARSessionConfig.h	BlueprintCallable Category="AR Settings"
void SetEnableAutoFocus ( bool bNewValue )		ARSessionConfig.h	BlueprintCallable Category="AR Settings"
void SetFaceTrackingDirection ( EARFaceTrackingDirection InDirection )		ARSessionConfig.h	BlueprintCallable Category="AR Settings"
void SetFaceTrackingUpdate ( EARFaceTrackingUpdate InUpdate )		ARSessionConfig.h	BlueprintCallable Category="AR Settings"
void SetResetCameraTracking ( bool bNewValue )		ARSessionConfig.h	BlueprintCallable Category="AR Settings"
void SetResetTrackedObjects ( bool bNewValue )		ARSessionConfig.h	BlueprintCallable Category="AR Settings"
void SetSceneReconstructionMethod ( EARSceneReconstruction InSceneReconstructionMethod )		ARSessionConfig.h	BlueprintCallable Category="AR Settings"
void SetSessionTrackingFeatureToEnable ( EARSessionTrackingFeature InSessionTrackingFeature )		ARSessionConfig.h	BlueprintCallable Category="AR Settings"
void SetWorldMapData ( TArray< uint8 > WorldMapData )		ARSessionConfig.h	BlueprintCallable Category="AR Settings"
bool ShouldDoHorizontalPlaneDetection ()		ARSessionConfig.h
bool ShouldDoVerticalPlaneDetection ()		ARSessionConfig.h
bool ShouldEnableAutoFocus ()		ARSessionConfig.h	BlueprintCallable Category="AR Settings"
bool ShouldEnableCameraTracking ()		ARSessionConfig.h	BlueprintCallable Category="AR Settings"
bool ShouldRenderCameraOverlay ()		ARSessionConfig.h	BlueprintCallable Category="AR Settings"
bool ShouldResetCameraTracking ()		ARSessionConfig.h	BlueprintCallable Category="AR Settings"
bool ShouldResetTrackedObjects ()		ARSessionConfig.h	BlueprintCallable Category="AR Settings"
bool ShouldUseOptimalVideoFormat ()		ARSessionConfig.h

Deprecated Variables

Name	Type	Remarks	Include Path	Unreal Specifiers
PlaneDetectionMode_DEPRECATED	EARPlaneDetectionMode		ARSessionConfig.h

Navigation

Syntax

Inheritance Hierarchy

Derived Classes

Constructors

Variables

Public

Functions

Public

Deprecated Variables