UARBlueprintLibrary

Windows
MacOS
Linux

Inheritance Hierarchy

Syntax

class UARBlueprintLibrary : public UBlueprintFunctionLibrary

Functions

Name Description

Public function Static

bool

 

AddManualEnvironmentCaptureProbe

(
    FVector Location,
    FVector Extent
)

Adds an environment capture probe to the ar world

Public function Static

UARCandidate...

 

AddRuntimeCandidateImage

(
    UARSessionConfig* SessionConfi...,
    UTexture2D* CandidateTexture,
    FString FriendlyName,
    float PhysicalWidth
)

Create an ARCandidateImage object and add it to the ARCandidateImageList of the given `UARSessionConfig_ object.

Public function Static

void

 

DebugDrawPin

(
    UARPin* ARPin,
    UObject* WorldContextObject,
    FLinearColor Color,
    float Scale,
    float PersistForSeconds
)

Given a `UARPin_, draw it for debugging purposes.

Public function Static

void

 

DebugDrawTrackedGeometry

(
    UARTrackedGeometry* TrackedGeo...,
    UObject* WorldContextObject,
    FLinearColor Color,
    float OutlineThickness,
    float PersistForSeconds
)

Given some real-world geometry being tracked by the Augmented Reality system, draw it on the screen for debugging purposes (rudimentary)

Public function Static

TArray< UART...

 

GetAllGeometries()

Public function Static

TArray< UARP...

 

GetAllPins()

Get a list of all the `UARPin_ objects that the Augmented Reality session is currently using to connect virtual objects to real-world, tracked locations.

Public function Static

TArray< UARE...

 

GetAllTrackedEnvironmentCaptureProbes()

Public function Static

TArray< UART...

 

GetAllTrackedImages()

Public function Static

TArray< UARP...

 

GetAllTrackedPlanes()

Public function Static

TArray< UART...

 

GetAllTrackedPoints()

Public function Static

FARSessionSt...

 

GetARSessionStatus()

It is intended that you check the status of the Augmented Reality session on every frame and take action accordingly.

Public function Static

UARTextureCa...

 

GetCameraDepth()

Public function Static

UARTextureCa...

 

GetCameraImage()

Public function Static

TSharedPtr< ...

 

GetCandidateObject

(
    FVector Location,
    FVector Extent
)

Public function Static

UARLightEsti...

 

GetCurrentLightEstimate()

An AugmentedReality session can be configured to provide light estimates.

Public function Static

TArray< FVec...

 

GetPointCloud()

Public function Static

UARSessionCo...

 

GetSessionConfig()

Public function Static

TArray< FARV...

 

GetSupportedVideoFormats

(
    EARSessionType SessionType
)

Public function Static

EARTrackingQ...

 

GetTrackingQuality()

Public function Static

EARWorldMapp...

 

GetWorldMappingStatus()

Public function Static

bool

 

IsSessionTypeSupported

(
    EARSessionType SessionType
)

Test whether this type of session is supported by the current Augmented Reality platform.

Public function Static

TArray< FART...

 

LineTraceTrackedObjects

(
    const FVector2D ScreenCoord,
    bool bTestFeaturePoints,
    bool bTestGroundPlane,
    bool bTestPlaneExtents,
    bool bTestPlaneBoundaryPolygon
)

Perform a line trace against any real-world geometry as tracked by the AR system.

Public function Static

TArray< FART...

 

LineTraceTrackedObjects3D

(
    const FVector Start,
    const FVector End,
    bool bTestFeaturePoints,
    bool bTestGroundPlane,
    bool bTestPlaneExtents,
    bool bTestPlaneBoundaryPolygon
)

Perform a line trace against any real-world geometry as tracked by the AR system.

Public function Static

void

 

PauseARSession()

Pause a running Augmented Reality session without clearing existing state.

Public function Static

UARPin *

 

PinComponent

(
    USceneComponent* ComponentToPi...,
    const FTransform& PinToWorldTransf...,
    UARTrackedGeometry* TrackedGeo...,
    const FName DebugName
)

Pin an Unreal Component to a location in tracking spce (i.e. the real world).

Public function Static

UARPin *

 

PinComponentToTraceResult

(
    USceneComponent* ComponentToPi...,
    const FARTraceResult& TraceResult,
    const FName DebugName
)

A convenient version of [PinComponent()](API\Runtime\AugmentedReality\UARBlueprintLibrary\PinComponent)_ that can be used in conjunction with a result of aLineTraceTrackedObjects_ call.

Public function Static

void

 

RegisterAsARSystem

(
    const TSharedRef< FARSupportInterfa...
)

Public function Static

void

 

RemovePin

(
    UARPin* PinToRemove
)

Remove a pin such that it no longer updates the associated component.

Public function Static

TSharedPtr< ...

 

SaveWorld()

Public function Static

void

 

SetAlignmentTransform

(
    const FTransform& InAlignmentTrans...
)

Set a transform that will be applied to the tracking space.

Public function Static

void

 

StartARSession

(
    UARSessionConfig* SessionConfi...
)

Begin a new Augmented Reality session.

Public function Static

void

 

StopARSession()

Stop a running Augmented Reality session and clear any state.

Public function Static

void

 

UnpinComponent

(
    USceneComponent* ComponentToUn...
)

Given a pinned `ComponentToUnpin_, remove its attachment to the real world.

Constants

Name

Description

RegisteredARSystem

References

Module

AugmentedReality

Header

Runtime/AugmentedReality/Public/ARBlueprintLibrary.h

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