UARSessionConfig

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

Variables

Name Description

Protected variable

bool

 

bEnableAutoFocus

Whether the camera should use autofocus or not (can cause subtle shifts in position for small objects at macro camera distance)

Protected variable

bool

 

bEnableAutomaticCameraOverlay

Whether the AR camera feed should be drawn as an overlay or not. Defaults to true.

Protected variable

bool

 

bEnableAutomaticCameraTracking

Whether the game camera should track the device movement or not. Defaults to true.

Public variable

bool

 

bGenerateCollisionForMeshData

Whether the AR system should generate collision data from the mesh data or not

Public variable

bool

 

bGenerateMeshDataFromTrackedGeometry

Whether the AR system should generate mesh data that can be rendered, collided against, nav mesh generated on, etc.

Public variable

bool

 

bGenerateNavMeshForMeshData

Whether the AR system should generate navigation mesh data from the mesh data or not

Protected variable

bool

 

bHorizontalPlaneDetection

Should we detect flat horizontal surfaces: e.g. table tops, windows sills

Public variable

bool

 

bRenderMeshDataInWireframe

Whether the AR system should render the mesh data in wireframe or not

Protected variable

bool

 

bResetCameraTracking

Whether the AR system should reset camera tracking (origin, transform) or not. Defaults to true.

Protected variable

bool

 

bResetTrackedObjects

Whether the AR system should remove any tracked objects or not. Defaults to true.

Public variable

bool

 

bTrackSceneObjects

Whether the AR system should report scene objects (

Public variable

bool

 

bUseMeshDataForOcclusion

Whether the AR system render the mesh data as occlusion meshes or not

Protected variable

bool

 

bVerticalPlaneDetection

Should we detect flat vertical surfaces: e.g. paintings, monitors, book cases

Protected variable

TArray< UARCand...

 

CandidateImages

The list of candidate images to detect within the AR camera view

Protected variable

TArray< UARCand...

 

CandidateObjects

A list of candidate objects to search for in the scene

Protected variable

FARVideoFormat

 

DesiredVideoFormat

The desired video format (or the default if not supported) that this session should use if the camera is enabled Note: Call GetSupportedVideoFormats to get a list of device supported formats

Protected variable

EAREnvironmentC...

 

EnvironmentCaptureProbeType

How the AR system should handle texture probe capturing

Protected variable

EARFaceTracking...

 

FaceTrackingDirection

Whether to track the face as if you are looking out of the device or as a mirror

Protected variable

EARFaceTracking...

 

FaceTrackingUpdate

Whether to track the face as if you are looking out of the device or as a mirror

Protected variable

EARFrameSyncMod...

 

FrameSyncMode

Protected variable

EARLightEstimat...

 

LightEstimationMode

Protected variable

int32

 

MaxNumSimultaneousImagesTracked

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

Protected variable

TArray< uint8 >

 

SerializedARCandidateImageDatabase

Data array for storing the cooked image database

Protected variable

EARSessionType

 

SessionType

Protected variable

EARWorldAlignme...

 

WorldAlignment

Protected variable

TArray< uint8 >

 

WorldMapData

A previously saved world that is to be loaded when the session starts

Constructors

Name Description

Public function

UARSessionConfig()

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

FARVideoForm...

 

GetDesiredVideoFormat()

Public function Const

EAREnvironme...

 

GetEnvironmentCaptureProbeType()

Public function Const

EARFaceTrack...

 

GetFaceTrackingDirection()

Public function Const

EARFaceTrack...

 

GetFaceTrackingUpdate()

Public function Const

EARFrameSync...

 

GetFrameSyncMode()

Public function Const

EARLightEsti...

 

GetLightEstimationMode()

Public function Const

int32

 

GetMaxNumSimultaneousImagesTracked()

Public function Const

EARPlaneDete...

 

GetPlaneDetectionMode()

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

 

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()

Deprecated Variables

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