Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > MagicLeapImageTracker > UMagicLeapImageTrackerComponent

Light Theme

Dark Theme

UMagicLeapImageTrackerComponent

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

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UActorComponent

USceneComponent

UMagicLeapImageTrackerComponent

References

Module	MagicLeapImageTracker
Header	/Engine/Plugins/Lumin/MagicLeap/Source/MagicLeapImageTracker/Public/MagicLeapImageTrackerComponent.h
Include	#include "MagicLeapImageTrackerComponent.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(ClassGroup=MagicLeap, BlueprintType, Blueprintable, EditInlineNew,
Meta=(BlueprintSpawnableComponent))
class UMagicLeapImageTrackerComponent : public USceneComponent

Remarks

The MLImageTrackerComponent will keep track of whether the image that it has been provided is currently visible to the headset camera. @note Currently only R8G8B8A8 and B8G8R8A8 textures are supported.

Variables

	Name	Description
EMagicLeapImage...	AxisOrientation
bool	bIsStationary	Set this to true to improve detection for stationary targets.
bool	bUseUnreliablePose	If false, the pose will not be updated when tracking is unreliable.
float	LongerDimension	LongerDimension refers to the size of the longer dimension (width or height) of the physical image target in Unreal units.
FString	Name	The name of the target.
FMagicLeapImage...	OnImageTargetFound	Activated when the target image becomes visible to the camera
FMagicLeapImage...	OnImageTargetLost	Activated the target image becomes invisible to the camera
FMagicLeapImage...	OnImageTargetUnreliableTracking	Activated when the target image is tracked with low confidence.
FMagicLeapSetIm...	OnSetImageTargetFailed	Activated when the target image fails to be set.
FMagicLeapSetIm...	OnSetImageTargetSucceeded	Private:
UTexture2D *...	TargetImageTexture	The texture that will be tracked by this image tracker instance.

Constructors

	Name	Description
	UMagicLeapImageTrackerComponent()

Functions

		Name	Description
	bool	RemoveTargetAsync()	Attempts to remove the currently tracked target. Initiates an asynchronous call on a worker thread.
	bool	SetTargetAsync ( UTexture2D* ImageTarget )	Attempts to change the currently tracked target.

Overridden from UActorComponent

		Name	Description
	void	EndPlay ( const EEndPlayReason::Type EndPlayR... )	Initiates the setting of the image target (if TargetImageTexture is not null).
	void	TickComponent ( float DeltaTime, enum ELevelTick TickType, FActorComponentTickFunction* T... )	Attempts to retrieve and set the relative pose of the tracked image.

Overridden from UObject

		Name	Description
	void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
	void	PreEditChange ( FProperty* PropertyAboutToChan... )	This is called when a property is about to be modified externally

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

Take our survey

Dismiss