UImageTrackerComponent

The ImageTrackerComponent will keep track of whether the image that it has been provided is currently visible to the headset camera.

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

MagicLeap

Header

/Engine/Plugins/Lumin/MagicLeap/Source/MagicLeap/Classes/ImageTrackerComponent.h

Include

#include "ImageTrackerComponent.h"

Syntax

UCLASS(ClassGroup=MagicLeap, BlueprintType, Blueprintable, EditInlineNew,
       Meta=(BlueprintSpawnableComponent))
class UImageTrackerComponent : public USceneComponent

Remarks

The ImageTrackerComponent will keep track of whether the image that it has been provided is currently visible to the headset camera.

Currently only R8G8B8A8 and B8G8R8A8 textures are supported.

Variables

Name Description

Public variable UProperty Category, EditAnywhere BlueprintReadWrite

bool

 

bIsStationary

Set this to true to improve detection for stationary targets.

Public variable UProperty Category, EditAnywhere BlueprintReadWrite

bool

 

bUseUnreliablePose

If false, the pose will not be updated when tracking is unreliable.

Public variable UProperty Category, EditAnywhere BlueprintReadWrite

float

 

LongerDimension

LongerDimension refers to the size of the longer dimension (width or height) of the physical image target in Unreal units.

Public variable UProperty Category, EditAnywhere BlueprintReadWrite

FString

 

Name

The name of the target.

Public variable UProperty BlueprintAssignable

FImageTargetFou...

 

OnImageTargetFound

Activated when the target image becomes visible to the camera

Public variable UProperty BlueprintAssignable

FImageTargetLos...

 

OnImageTargetLost

Activated the target image becomes invisible to the camera

Public variable UProperty BlueprintAssignable

FImageTargetUnr...

 

OnImageTargetUnreliableTracking

Activated when the target image is tracked with low confidence.

Public variable UProperty BlueprintAssignable

FSetImageTarget...

 

OnSetImageTargetFailed

Activated when the target image fails to be set.

Public variable UProperty BlueprintAssignable

FSetImageTarget...

 

OnSetImageTargetSucceeded

Activated when the target image is successfully set.

Public variable UProperty Category, EditAnywhere BlueprintReadWrite

UTexture2D *...

 

TargetImageTexture

The texture that will be tracked by this image tracker instance.

Constructors

Name Description

Public function

UImageTrackerComponent()

Creates the FImageTrackerImpl instance.

Destructors

Name Description

Public function Virtual

~UImageTrackerComponent()

Destroys the FImageTrackerImpl instance.

Functions

Name Description

Public function UFunction BlueprintCallable, Category

bool

 

SetTargetAsync

(
    UTexture2D* ImageTarget
)

Attempts to change the currently tracked target.

Overridden from UActorComponent

Name Description

Public function Virtual

void

 

TickComponent

(
    float DeltaTime,
    enum ELevelTick TickType,
    FActorComponentTickFunction* T...
)

Polls for and handles incoming messages from the asynchronous image tracking system.

Overridden from UObject

Name Description

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...
)

Called when a property on this object has been modified externally

Public function Virtual

void

 

PreEditChange

(
    UProperty* PropertyAboutToChan...
)

This is called when a property is about to be modified externally

Classes

Name

Description

Public class

FImageTargetFound

Delegate used to notify the instigating blueprint that the target image is currently visible to the camera

Public class

FImageTargetLost

Delegate used to notify the instigating blueprint that the target image just became invisible to the camera

Public class

FImageTargetUnreliableTracking

Delegate used to notify the instigating blueprint that the target image's location has become unrealiable

Public class

FSetImageTargetFailed

Delegate used to notify the instigating blueprint that the target image failed to be set.

Public class

FSetImageTargetSucceeded

Delegate used to notify the instigating blueprint that the target image was successfully set.

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