Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > AugmentedReality > UARSessionConfig

Light Theme

Dark Theme

UARSessionConfig

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

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UDataAsset

UARSessionConfig

	UGoogleARCoreSessionConfig
	ULuminARSessionConfig

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
bool	bEnableAutoFocus	Boolean to determine whether the camera should autofocus.
bool	bEnableAutomaticCameraOverlay	Boolean to determine whether the AR camera feed should be drawn as an overlay.
bool	bEnableAutomaticCameraTracking	Boolean to determine whether the virtual camera should track the device movement.
bool	bGenerateCollisionForMeshData	Boolean to determine whether the AR system should generate collision data from the mesh data.
bool	bGenerateMeshDataFromTrackedGeometry	Boolean to determine whether the AR system should generate mesh data that can be used for rendering, collision, NavMesh, and more.
bool	bGenerateNavMeshForMeshData	Boolean to determine whether the AR system should generate collision data from the mesh data.
bool	bHorizontalPlaneDetection	Boolean to determine whether flat, horizontal surfaces are detected.
bool	bRenderMeshDataInWireframe	Boolean to determine whether the AR system should render the mesh data as wireframe.
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.
bool	bResetTrackedObjects	Boolean to determine whether the AR system should remove any tracked objects when a new AR session starts.
bool	bTrackSceneObjects	Boolean to determine whether the AR system should track scene objects:
bool	bUseAutomaticImageScaleEstimation	Boolean to determine whether to automatically estimate and set the scale of a detected, or tracked, image.
bool	bUseMeshDataForOcclusion	Boolean to determine whether the AR system should render the mesh data as occlusion meshes.
bool	bUseOptimalVideoFormat	Boolean to determine whether to automatically pick the video format that best matches the device screen size
bool	bUsePersonSegmentationForOcclusion	Boolean to determine whether to use the person segmentation results for occluding virtual content.
bool	bUseSceneDepthForOcclusion	Boolean to determine whether to use the scene depth information for occluding virtual content.
bool	bUseStandardOnboardingUX	Boolean to determine whether to use the standard onboarding UX, if the system supports it.
bool	bVerticalPlaneDetection	Boolean to determine whether flat, vertical surfaces are detected.
TArray< UARCand...	CandidateImages	The list of candidate images to detect within the AR camera view. This feature is used by ARKit.
TArray< UARCand...	CandidateObjects	The list of candidate objects to search for in the scene. This feature is used by ARKit.
UMaterialInterf...	DefaultMeshMaterial	The default mesh material used by the generated mesh component.
UMaterialInterf...	DefaultWireframeMeshMaterial	The default mesh material used by the wireframe setting of the generated mesh component.
FARVideoFormat	DesiredVideoFormat	The desired video format (or the default, if not supported) that this session should use if the camera is enabled.
EARSessionTrack...	EnabledSessionTrackingFeature
EAREnvironmentC...	EnvironmentCaptureProbeType
TSubclassOf< UA...	EnvironmentProbeComponentClass
TSubclassOf< UA...	FaceComponentClass
EARFaceTracking...	FaceTrackingDirection
EARFaceTracking...	FaceTrackingUpdate
EARFrameSyncMod...	FrameSyncMode
TSubclassOf< UA...	GeoAnchorComponentClass
TSubclassOf< UA...	ImageComponentClass
EARLightEstimat...	LightEstimationMode
int32	MaxNumberOfTrackedFaces	The maximum number of faces to track simultaneously. This feature is used by ARKit.
int32	MaxNumSimultaneousImagesTracked	The maximum number of images to track at the same time.
TSubclassOf< UA...	MeshComponentClass
TSubclassOf< UA...	ObjectComponentClass
TSubclassOf< UA...	PlaneComponentClass
TSubclassOf< UA...	PointComponentClass
TSubclassOf< UA...	PoseComponentClass
TSubclassOf< UA...	QRCodeComponentClass
EARSceneReconst...	SceneReconstructionMethod
TArray< uint8 >	SerializedARCandidateImageDatabase	Data array for storing the cooked image database. This feature is used by ARCore.
EARSessionType	SessionType
EARWorldAlignme...	WorldAlignment
TArray< uint8 >	WorldMapData	A previously saved world that will be loaded when the session starts.

Constructors

	Name	Description
	UARSessionConfig()	The constructor for the AR Session Config Data Asset.

Functions

	Name	Description
void	AddCandidateImage ( UARCandidateImage* NewCandidat... )	Add a new CandidateImage to the ARSessionConfig.
void	AddCandidateObject ( UARCandidateObject* CandidateO... )
const TArray...	GetCandidateImageList()
const TArray...	GetCandidateObjectList()
UMaterialInt...	GetDefaultMeshMaterial()
UMaterialInt...	GetDefaultWireframeMeshMaterial()
FARVideoForm...	GetDesiredVideoFormat()
EARSessionTr...	GetEnabledSessionTrackingFeature()
EAREnvironme...	GetEnvironmentCaptureProbeType()
UClass *	GetEnvironmentProbeComponentClass()
UClass *	GetFaceComponentClass()
EARFaceTrack...	GetFaceTrackingDirection()
EARFaceTrack...	GetFaceTrackingUpdate()
EARFrameSync...	GetFrameSyncMode()
UClass *	GetGeoAnchorComponentClass()
UClass *	GetImageComponentClass()
EARLightEsti...	GetLightEstimationMode()
int32	GetMaxNumberOfTrackedFaces()
int32	GetMaxNumSimultaneousImagesTracked()
UClass *	GetMeshComponentClass()
UClass *	GetObjectComponentClass()
UClass *	GetPlaneComponentClass()
EARPlaneDete...	GetPlaneDetectionMode()
UClass *	GetPointComponentClass()
UClass *	GetPoseComponentClass()
UClass *	GetQRCodeComponentClass()
EARSceneReco...	GetSceneReconstructionMethod()
const TArray...	GetSerializedARCandidateImageDatabase()
EARSessionTy...	GetSessionType()
EARWorldAlig...	GetWorldAlignment()
const TArray...	GetWorldMapData()
void	SetCandidateObjectList ( const TArray< UARCandidateObject&#... )
void	SetDesiredVideoFormat ( FARVideoFormat NewFormat )
void	SetEnableAutoFocus ( bool bNewValue )
void	SetFaceTrackingDirection ( EARFaceTrackingDirection InDirectio... )
void	SetFaceTrackingUpdate ( EARFaceTrackingUpdate InUpdate )
void	SetResetCameraTracking ( bool bNewValue )
void	SetResetTrackedObjects ( bool bNewValue )
void	SetSceneReconstructionMethod ( EARSceneReconstruction InSceneRecon... )
void	SetSessionTrackingFeatureToEnable ( EARSessionTrackingFeature InSession... )
void	SetWorldMapData ( TArray< uint8 > WorldMapData )
bool	ShouldDoHorizontalPlaneDetection()
bool	ShouldDoVerticalPlaneDetection()
bool	ShouldEnableAutoFocus()
bool	ShouldEnableCameraTracking()
bool	ShouldRenderCameraOverlay()
bool	ShouldResetCameraTracking()
bool	ShouldResetTrackedObjects()
bool	ShouldUseOptimalVideoFormat()

Deprecated Variables

		Name	Description
	EARPlaneDetecti...	PlaneDetectionMode_DEPRECATED

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss