UARCandidateImage

An asset that points to an image to be detected in a scene and provides the size of the object in real life

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

AugmentedReality

Header

/Engine/Source/Runtime/AugmentedReality/Public/ARTypes.h

Include

#include "ARTypes.h"

Syntax

class UARCandidateImage : public UDataAsset

Remarks

An asset that points to an image to be detected in a scene and provides the size of the object in real life

Variables

Name Description

Protected variable

UTexture2D *...

 

CandidateTexture

The image to detect in scenes

Protected variable

FString

 

FriendlyName

The friendly name to report back when the image is detected in scenes

Protected variable

float

 

Height

The physical height in centimeters of the object that this candidate image represents.

Protected variable

EARCandidateIma ...

 

Orientation

The orientation to treat the candidate image as. Ignored in ARCore

Protected variable

float

 

Width

The physical width in centimeters of the object that this candidate image represents

Functions

Name Description

Public function Static

UARCandidate ...

 

CreateNewARCandidateImage

(
    UTexture2D * InCandidateTexture,
    FString InFriendlyName,
    float InPhysicalWidth,
    float InPhysicalHeight,
    EARCandidateImageOrientation InOrie...
)

Public function Const

UTexture2D &...

 

GetCandidateTexture()

Public function Const

const FStrin ...

 

GetFriendlyName()

Public function Const

EARCandidate ...

 

GetOrientation()

Public function Const

float

 

GetPhysicalHeight()

Public function Const

float

 

GetPhysicalWidth()

Overridden from UObject

Name Description

Protected function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent & PropertyCha...
)

Used to enforce physical sizes matching the aspect ratio of the images

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