1. Epic GamesDeveloper
  3. UARSessionConfig

UARSessionConfig

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

API > API/Runtime > API/Runtime/AugmentedReality

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

  Type 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< TObjectPtr< UARCandidateImage > > CandidateImages The list of candidate images to detect within the AR camera view. This feature is used by ARKit.
Protected variable TArray< TObjectPtr< UARCandidateObject > > CandidateObjects The list of candidate objects to search for in the scene. This feature is used by ARKit.
Protected variable TObjectPtr< UMaterialInterface > DefaultMeshMaterial The default mesh material used by the generated mesh component.
Protected variable TObjectPtr< UMaterialInterface > 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 EARSessionTrackingFeature EnabledSessionTrackingFeature  
Protected variable EAREnvironmentCaptureProbeType EnvironmentCaptureProbeType  
Protected variable TSubclassOf< UAREnvironmentProbeComponent > EnvironmentProbeComponentClass  
Protected variable TSubclassOf< UARFaceComponent > FaceComponentClass  
Protected variable EARFaceTrackingDirection FaceTrackingDirection  
Protected variable EARFaceTrackingUpdate FaceTrackingUpdate  
Protected variable EARFrameSyncMode FrameSyncMode  
Protected variable TSubclassOf< UARGeoAnchorComponent > GeoAnchorComponentClass  
Protected variable TSubclassOf< UARImageComponent > ImageComponentClass  
Protected variable EARLightEstimationMode 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< UARMeshComponent > MeshComponentClass  
Protected variable TSubclassOf< UARObjectComponent > ObjectComponentClass  
Protected variable TSubclassOf< UARPlaneComponent > PlaneComponentClass  
Protected variable TSubclassOf< UARPointComponent > PointComponentClass  
Protected variable TSubclassOf< UARPoseComponent > PoseComponentClass  
Protected variable TSubclassOf< UARQRCodeComponent > QRCodeComponentClass  
Protected variable EARSceneReconstruction 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 EARWorldAlignment WorldAlignment  
Protected variable TArray< uint8 > WorldMapData A previously saved world that will be loaded when the session starts.

Constructors

  Type Name Description
Public function   The constructor for the AR Session Config Data Asset.

Functions

  Type Name Description
Public function void

AddCandidateImage ( UARCandidateImage* NewCandidateImage
)

 Add a new CandidateImage to the ARSessionConfig.
Public function void

AddCandidateObject ( UARCandidateObject* CandidateObject
)

  
Public function void Remove all candidate images from the ARSessionConfig.
Public function Const const TArray< UARCandidateImage * > &  
Public function Const const TArray< UARCandidateObject * > &  
Public function Const UMaterialInterface *  
Public function Const UMaterialInterface *  
Public function Const FARVideoFormat  
Public function Const EARSessionTrackingFeature  
Public function Const EAREnvironmentCaptureProbeType  
Public function Const UClass *  
Public function Const UClass *  
Public function Const EARFaceTrackingDirection  
Public function Const EARFaceTrackingUpdate  
Public function Const EARFrameSyncMode  
Public function Const UClass *  
Public function Const UClass *  
Public function Const EARLightEstimationMode  
Public function Const int32  
Public function Const int32  
Public function Const UClass *  
Public function Const UClass *  
Public function Const UClass *  
Public function Const EARPlaneDetectionMode  
Public function Const UClass *  
Public function Const UClass *  
Public function Const UClass *  
Public function Const EARSceneReconstruction  
Public function Const const TArray< uint8 > &  
Public function Const EARSessionType  
Public function Const EARWorldAlignment  
Public function Const const TArray< uint8 > &  
Public function void Remove a candidate image from the ARSessionConfig, by pointer, note the image object must match, not the content of the image.
Public function void Remove a candidate image from the ARSessionConfig, by index.
Public function void

SetCandidateObjectList ( const TArray< UARCandidateObject* >& InCandidateObjects
)

  
Public function void  
Public function void

SetEnableAutoFocus ( bool bNewValue
)

  
Public function void

SetFaceTrackingDirection ( EARFaceTrackingDirection InDirection
)

  
Public function void

SetFaceTrackingUpdate ( EARFaceTrackingUpdate InUpdate
)

  
Public function void

SetResetCameraTracking ( bool bNewValue
)

  
Public function void

SetResetTrackedObjects ( bool bNewValue
)

  
Public function void

SetSceneReconstructionMethod ( EARSceneReconstruction InSceneReconstructionMethod
)

  
Public function void

SetSessionTrackingFeatureToEnable ( EARSessionTrackingFeature InSessionTrackingFeature
)

  
Public function void

SetWorldMapData ( TArray< uint8 > WorldMapData
)

  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  

Deprecated Variables

  Type Name Description
Protected variable EARPlaneDetectionMode PlaneDetectionMode_DEPRECATED  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page