ULuminARImageTrackingFunctionLibrary::AddLuminRuntimeCandidateImage

Create a LuminARCandidateImage object and add it to the ARCandidateImageList of the given `[UARSessionConfig](API\Runtime\AugmentedReality\UARSessionConfig)_ object.

Windows
MacOS
Linux

References

Module

MagicLeapAR

Header

/Engine/Plugins/Lumin/MagicLeap/Source/MagicLeapAR/Public/LuminARFunctionLibrary.h

Include

#include "LuminARFunctionLibrary.h"

Source

/Engine/Plugins/Lumin/MagicLeap/Source/MagicLeapAR/Private/LuminARFunctionLibrary.cpp

Syntax

[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="LuminAR|Image Tracking",
          Meta=(Keywords="lumin ar augmentedreality augmented reality candidate image"))
static ULuminARCandidateImage * AddLuminRuntimeCandidateImage
(
    UARSessionConfig * SessionConfig,
    UTexture2D * CandidateTexture,
    FString FriendlyName,
    float PhysicalWidth,
    bool bUseUnreliablePose,
    bool bImageIsStationary
)

Remarks

Create a LuminARCandidateImage object and add it to the ARCandidateImageList of the given `UARSessionConfig_ object.

Note that you need to restart the AR session with the `UARSessionConfig_ you are adding to to make the change take effect.

On ARCore platform, you can leave the PhysicalWidth to 0 if you don't know the physical size of the image or the physical size is dynamic. And this function takes time to perform non-trivial image processing (20ms - 30ms), and should be run on a background thread.

Returns

A `ULuminARCandidateImage_ Object pointer if the underlying ARPlatform added the candidate image at runtime successfully. Return nullptr otherwise.

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