UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UARBlueprintLibrary Class Reference

#include <ARBlueprintLibrary.h>

+ Inheritance diagram for UARBlueprintLibrary:

Static Public Member Functions

static UE_API bool IsARSupported ()
 
static UE_API void StartARSession (UARSessionConfig *SessionConfig)
 
static UE_API void PauseARSession ()
 
static UE_API void StopARSession ()
 
static UE_API FARSessionStatus GetARSessionStatus ()
 
static UE_API UARSessionConfigGetSessionConfig ()
 
static UE_API bool ToggleARCapture (const bool bOnOff, const EARCaptureType CaptureType)
 
static UE_API void SetEnabledXRCamera (bool bOnOff)
 
static UE_API FIntPoint ResizeXRCamera (const FIntPoint &InSize)
 
static UE_API void SetAlignmentTransform (const FTransform &InAlignmentTransform)
 
static UE_API TArray< FARTraceResultLineTraceTrackedObjects (const FVector2D ScreenCoord, bool bTestFeaturePoints=true, bool bTestGroundPlane=true, bool bTestPlaneExtents=true, bool bTestPlaneBoundaryPolygon=true)
 
static UE_API TArray< FARTraceResultLineTraceTrackedObjects3D (const FVector Start, const FVector End, bool bTestFeaturePoints=true, bool bTestGroundPlane=true, bool bTestPlaneExtents=true, bool bTestPlaneBoundaryPolygon=true)
 
static UE_API EARTrackingQuality GetTrackingQuality ()
 
static UE_API EARTrackingQualityReason GetTrackingQualityReason ()
 
static UE_API TArray< UARTrackedGeometry * > GetAllGeometries ()
 
static UE_API TArray< UARTrackedGeometry * > GetAllGeometriesByClass (TSubclassOf< UARTrackedGeometry > GeometryClass)
 
static UE_API UARTextureGetARTexture (EARTextureType TextureType)
 
static UE_API bool IsSessionTypeSupported (EARSessionType SessionType)
 
static UE_API void DebugDrawTrackedGeometry (UARTrackedGeometry *TrackedGeometry, UObject *WorldContextObject, FLinearColor Color=FLinearColor(1.0f, 1.0f, 0.0f, 0.75f), float OutlineThickness=5.0f, float PersistForSeconds=0.0f)
 
static UE_API void DebugDrawPin (UARPin *ARPin, UObject *WorldContextObject, FLinearColor Color=FLinearColor(1.0f, 1.0f, 0.0f, 0.75f), float Scale=5.0f, float PersistForSeconds=0.0f)
 
static UE_API UARLightEstimateGetCurrentLightEstimate ()
 
static UE_API UARPinPinComponent (USceneComponent *ComponentToPin, const FTransform &PinToWorldTransform, UARTrackedGeometry *TrackedGeometry=nullptr, const FName DebugName=NAME_None)
 
static UE_API UARPinPinComponentToTraceResult (USceneComponent *ComponentToPin, const FARTraceResult &TraceResult, const FName DebugName=NAME_None)
 
static UE_API bool PinComponentToARPin (USceneComponent *ComponentToPin, UARPin *Pin)
 
static UE_API void UnpinComponent (USceneComponent *ComponentToUnpin)
 
static UE_API void RemovePin (UARPin *PinToRemove)
 
static UE_API TArray< UARPin * > GetAllPins ()
 
static UE_API bool IsARPinLocalStoreSupported ()
 
static UE_API bool IsARPinLocalStoreReady ()
 
static UE_API TMap< FName, UARPin * > LoadARPinsFromLocalStore ()
 
static UE_API bool SaveARPinToLocalStore (FName InSaveName, UARPin *InPin)
 
static UE_API void RemoveARPinFromLocalStore (FName InSaveName)
 
static UE_API void RemoveAllARPinsFromLocalStore ()
 
static UE_API bool AddManualEnvironmentCaptureProbe (FVector Location, FVector Extent)
 
static UE_API EARWorldMappingState GetWorldMappingStatus ()
 
static UE_API TArray< FVectorGetPointCloud ()
 
static UE_API TArray< FARVideoFormatGetSupportedVideoFormats (EARSessionType SessionType)
 
static UE_API TSharedPtr< FARSaveWorldAsyncTask, ESPMode::ThreadSafeSaveWorld ()
 
static UE_API TSharedPtr< FARGetCandidateObjectAsyncTask, ESPMode::ThreadSafeGetCandidateObject (FVector Location, FVector Extent)
 
static UE_API UARCandidateImageAddRuntimeCandidateImage (UARSessionConfig *SessionConfig, UTexture2D *CandidateTexture, FString FriendlyName, float PhysicalWidth)
 
static UE_API bool IsSessionTrackingFeatureSupported (EARSessionType SessionType, EARSessionTrackingFeature SessionTrackingFeature)
 
static UE_API bool IsSceneReconstructionSupported (EARSessionType SessionType, EARSceneReconstruction SceneReconstructionMethod)
 
static UE_API TArray< FARPose2DGetAllTracked2DPoses ()
 
static UE_API bool GetObjectClassificationAtLocation (const FVector &InWorldLocation, EARObjectClassification &OutClassification, FVector &OutClassificationLocation, float MaxLocationDiff=10.f)
 
static UE_API void SetARWorldOriginLocationAndRotation (FVector OriginLocation, FRotator OriginRotation, bool bIsTransformInWorldSpace=true, bool bMaintainUpDirection=true)
 
static UE_API void SetARWorldScale (float InWorldScale)
 
static UE_API float GetARWorldScale ()
 
static UE_API FTransform GetAlignmentTransform ()
 
static UE_API bool AddTrackedPointWithName (const FTransform &WorldTransform, const FString &PointName, bool bDeletePointsWithSameName=true)
 
static UE_API TArray< UARTrackedPoint * > FindTrackedPointsByName (const FString &PointName)
 
static UE_API void CalculateClosestIntersection (const TArray< FVector > &StartPoints, const TArray< FVector > &EndPoints, FVector &ClosestIntersection)
 
static UE_API void CalculateAlignmentTransform (const FTransform &TransformInFirstCoordinateSystem, const FTransform &TransformInSecondCoordinateSystem, FTransform &AlignmentTransform)
 
static UE_API int32 GetNumberOfTrackedFacesSupported ()
 
static UE_API bool GetCameraIntrinsics (FARCameraIntrinsics &OutCameraIntrinsics)
 
template<class T >
static TArray< T * > GetAllGeometriesByClass ()
 
static UE_API void RegisterAsARSystem (const TSharedRef< FARSupportInterface, ESPMode::ThreadSafe > &NewArSystem)
 
- Static Public Member Functions inherited from UObject
static COREUOBJECT_API void UpdateClassesExcludedFromDedicatedServer (const TArray< FString > &InClassNames, const TArray< FString > &InModulesNames)
 
static COREUOBJECT_API void UpdateClassesExcludedFromDedicatedClient (const TArray< FString > &InClassNames, const TArray< FString > &InModulesNames)
 
static COREUOBJECT_API bool CanCreateInCurrentContext (UObject *Template)
 
static COREUOBJECT_API void AddReferencedObjects (UObject *InThis, FReferenceCollector &Collector)
 
static COREUOBJECT_API const FNameSourceFileTagName ()
 
static COREUOBJECT_API UObjectGetArchetypeFromRequiredInfo (const UClass *Class, const UObject *Outer, FName Name, EObjectFlags ObjectFlags)
 
- Static Public Member Functions inherited from UObjectBaseUtility
static bool IsGarbageEliminationEnabled ()
 
static bool IsPendingKillEnabled ()
 
static void SetGarbageEliminationEnabled (bool bEnabled)
 
static COREUOBJECT_API void ReloadObjectsFromModifiedConfigSections (const class FConfigModificationTracker *ChangeTracker)
 
- Static Public Member Functions inherited from UObjectBase
static COREUOBJECT_API FString RemoveClassPrefix (const TCHAR *ClassName)
 
static void PrefetchClass (UObject *Object)
 
static void PrefetchOuter (UObject *Object)
 

Additional Inherited Members

- Public Types inherited from UObject
enum class  ENetFields_Private { NETFIELD_REP_START = 0 , NETFIELD_REP_END = -1 }
 
typedef UObject WithinClass
 
- Public Member Functions inherited from UObject
COREUOBJECT_API UObject ()
 
COREUOBJECT_API UObject (const FObjectInitializer &ObjectInitializer)
 
COREUOBJECT_API UObject (EStaticConstructor, EObjectFlags InFlags)
 
COREUOBJECT_API UObject (FVTableHelper &Helper)
 
COREUOBJECT_API UObjectCreateDefaultSubobject (FName SubobjectFName, UClass *ReturnType, UClass *ClassToCreateByDefault, bool bIsRequired, bool bIsTransient)
 
template<class TReturnType >
TReturnTypeCreateEditorOnlyDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType >
TReturnTypeCreateDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType , class TClassToConstructByDefault >
TReturnTypeCreateDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType >
TReturnTypeCreateOptionalDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType , class TClassToConstructByDefault >
TReturnTypeCreateOptionalDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
COREUOBJECT_API void GetDefaultSubobjects (TArray< UObject * > &OutDefaultSubobjects)
 
COREUOBJECT_API UObjectGetDefaultSubobjectByName (FName ToFind)
 
virtual COREUOBJECT_API void PostInitProperties ()
 
virtual COREUOBJECT_API void PostReinitProperties ()
 
virtual void PostCDOContruct ()
 
virtual COREUOBJECT_API void PreSaveRoot (FObjectPreSaveRootContext ObjectSaveContext)
 
virtual COREUOBJECT_API void PostSaveRoot (FObjectPostSaveRootContext ObjectSaveContext)
 
virtual COREUOBJECT_API void PreSave (FObjectPreSaveContext SaveContext)
 
virtual COREUOBJECT_API void CollectSaveOverrides (FObjectCollectSaveOverridesContext SaveContext)
 
UE_FORCEINLINE_HINT bool Modify (bool bAlwaysMarkDirty=true)
 
UE_FORCEINLINE_HINT bool IsCapturingAsRootObjectForTransaction () const
 
virtual bool ResolveSubobject (const TCHAR *SubObjectPath, UObject *&OutObject, bool bLoadIfExists)
 
virtual bool IsReadyForAsyncPostLoad () const
 
virtual COREUOBJECT_API void PostLoad ()
 
virtual COREUOBJECT_API void PostLoadSubobjects (FObjectInstancingGraph *OuterInstanceGraph)
 
virtual COREUOBJECT_API void BeginDestroy ()
 
virtual bool IsReadyForFinishDestroy ()
 
virtual COREUOBJECT_API void FinishDestroy ()
 
virtual COREUOBJECT_API void Serialize (FArchive &Ar)
 
virtual COREUOBJECT_API void Serialize (FStructuredArchive::FRecord Record)
 
virtual void ShutdownAfterError ()
 
virtual void PostInterpChange (FProperty *PropertyThatChanged)
 
virtual COREUOBJECT_API void PostRename (UObject *OldOuter, const FName OldName)
 
virtual void PreDuplicate (FObjectDuplicationParameters &DupParams)
 
virtual void PostDuplicate (bool bDuplicateForPIE)
 
virtual void PostDuplicate (EDuplicateMode::Type DuplicateMode)
 
virtual COREUOBJECT_API bool NeedsLoadForClient () const
 
virtual COREUOBJECT_API bool NeedsLoadForServer () const
 
virtual COREUOBJECT_API bool NeedsLoadForTargetPlatform (const class ITargetPlatform *TargetPlatform) const
 
virtual bool NeedsLoadForEditorGame () const
 
virtual bool IsEditorOnly () const
 
virtual bool HasNonEditorOnlyReferences () const
 
virtual bool IsPostLoadThreadSafe () const
 
virtual COREUOBJECT_API bool IsDestructionThreadSafe () const
 
virtual COREUOBJECT_API void GetPreloadDependencies (TArray< UObject * > &OutDeps)
 
virtual void GetPrestreamPackages (TArray< UObject * > &OutPrestream)
 
virtual void ExportCustomProperties (FOutputDevice &Out, uint32 Indent)
 
virtual void ImportCustomProperties (const TCHAR *SourceText, FFeedbackContext *Warn)
 
virtual void PostEditImport ()
 
virtual void PostReloadConfig (class FProperty *PropertyThatWasLoaded)
 
virtual COREUOBJECT_API bool Rename (const TCHAR *NewName=nullptr, UObject *NewOuter=nullptr, ERenameFlags Flags=REN_None)
 
virtual FString GetDesc ()
 
COREUOBJECT_API UScriptStructGetSparseClassDataStruct () const
 
virtual bool GetNativePropertyValues (TMap< FString, FString > &out_PropertyValues, uint32 ExportFlags=0) const
 
virtual COREUOBJECT_API void GetResourceSizeEx (FResourceSizeEx &CumulativeResourceSize)
 
SIZE_T GetResourceSizeBytes (EResourceSizeMode::Type Mode)
 
virtual FName GetExporterName (void)
 
COREUOBJECT_API void CallAddReferencedObjects (FReferenceCollector &Collector)
 
virtual FRestoreForUObjectOverwriteGetRestoreForUObjectOverwrite ()
 
virtual bool AreNativePropertiesIdenticalTo (UObject *Other) const
 
virtual COREUOBJECT_API void GetAssetRegistryTags (FAssetRegistryTagsContext Context) const
 
virtual COREUOBJECT_API void GetAssetRegistryTags (TArray< FAssetRegistryTag > &OutTags) const
 
COREUOBJECT_API void GetAssetRegistryTags (FAssetData &Out) const
 
COREUOBJECT_API void GetAssetRegistryTags (FAssetRegistryTagsContext Context, FAssetData &Out) const
 
virtual COREUOBJECT_API bool IsAsset () const
 
virtual COREUOBJECT_API FPrimaryAssetId GetPrimaryAssetId () const
 
virtual COREUOBJECT_API bool IsLocalizedResource () const
 
virtual COREUOBJECT_API bool IsSafeForRootSet () const
 
virtual COREUOBJECT_API void TagSubobjects (EObjectFlags NewFlags)
 
virtual COREUOBJECT_API void GetLifetimeReplicatedProps (TArray< class FLifetimeProperty > &OutLifetimeProps) const
 
virtual COREUOBJECT_API void GetReplicatedCustomConditionState (FCustomPropertyConditionState &OutActiveState) const
 
virtual COREUOBJECT_API void RegisterReplicationFragments (UE::Net::FFragmentRegistrationContext &Context, UE::Net::EFragmentRegistrationFlags RegistrationFlags)
 
virtual COREUOBJECT_API bool IsNameStableForNetworking () const
 
virtual COREUOBJECT_API bool IsFullNameStableForNetworking () const
 
virtual COREUOBJECT_API bool IsSupportedForNetworking () const
 
virtual void GetSubobjectsWithStableNamesForNetworking (TArray< UObject * > &ObjList)
 
virtual COREUOBJECT_API void PreNetReceive ()
 
virtual COREUOBJECT_API void PostNetReceive ()
 
virtual void PostRepNotifies ()
 
virtual COREUOBJECT_API void PreDestroyFromReplication ()
 
COREUOBJECT_API bool IsSelected () const
 
COREUOBJECT_API void SerializeScriptProperties (FArchive &Ar) const
 
COREUOBJECT_API void SerializeScriptProperties (FStructuredArchive::FSlot Slot) const
 
COREUOBJECT_API void ReinitializeProperties (UObject *SourceObject=NULL, struct FObjectInstancingGraph *InstanceGraph=NULL)
 
COREUOBJECT_API FString GetDetailedInfo () const
 
COREUOBJECT_API bool ConditionalBeginDestroy ()
 
COREUOBJECT_API bool ConditionalFinishDestroy ()
 
COREUOBJECT_API void ConditionalPostLoad ()
 
COREUOBJECT_API void ConditionalPreload ()
 
COREUOBJECT_API void ConditionalPostLoadSubobjects (struct FObjectInstancingGraph *OuterInstanceGraph=NULL)
 
bool IsBasedOnArchetype (const UObject *const SomeObject) const
 
COREUOBJECT_API UFunctionFindFunction (FName InName) const
 
COREUOBJECT_API UFunctionFindFunctionChecked (FName InName) const
 
virtual COREUOBJECT_API void BuildSubobjectMapping (UObject *OtherObject, TMap< UObject *, UObject * > &ObjectMapping) const
 
COREUOBJECT_API void CollectDefaultSubobjects (TArray< UObject * > &OutDefaultSubobjects, bool bIncludeNestedSubobjects=false) const
 
COREUOBJECT_API bool CheckDefaultSubobjects (bool bForceCheck=false) const
 
COREUOBJECT_API void SaveConfig (uint64 RequiredPropertyFlags=CPF_Config, const TCHAR *Filename=nullptr, FConfigCacheIni *Config=GConfig, bool bAllowCopyToDefaultObject=true)
 
COREUOBJECT_API void SaveConfig (const FSaveConfigContext &Context)
 
COREUOBJECT_API void UpdateDefaultConfigFile (const FString &SpecificFileLocation="")
 
COREUOBJECT_API bool TryUpdateDefaultConfigFile (const FString &SpecificFileLocation="", bool bWarnIfFail=true)
 
COREUOBJECT_API void UpdateGlobalUserConfigFile ()
 
COREUOBJECT_API void UpdateProjectUserConfigFile ()
 
COREUOBJECT_API void UpdateSinglePropertyInConfigFile (const FProperty *InProperty, const FString &InConfigIniName)
 
COREUOBJECT_API FString GetDefaultConfigFilename () const
 
COREUOBJECT_API FString GetGlobalUserConfigFilename () const
 
COREUOBJECT_API FString GetProjectUserConfigFilename () const
 
virtual const TCHARGetConfigOverridePlatform () const
 
virtual void OverrideConfigSection (FString &SectionName)
 
virtual void OverridePerObjectConfigSection (FString &SectionName)
 
COREUOBJECT_API void LoadConfig (UClass *ConfigClass=nullptr, const TCHAR *Filename=nullptr, uint32 PropagationFlags=UE::LCPF_None, class FProperty *PropertyToLoad=nullptr, TArray< UE::ConfigAccessTracking::FConfigAccessData > *OutAccessedKeys=nullptr)
 
COREUOBJECT_API void ReloadConfig (UClass *ConfigClass=NULL, const TCHAR *Filename=NULL, uint32 PropagationFlags=UE::LCPF_None, class FProperty *PropertyToLoad=NULL)
 
COREUOBJECT_API void ParseParms (const TCHAR *Parms)
 
COREUOBJECT_API void OutputReferencers (FOutputDevice &Ar, FReferencerInformationList *Referencers=NULL)
 
COREUOBJECT_API void RetrieveReferencers (TArray< FReferencerInformation > *OutInternalReferencers, TArray< FReferencerInformation > *OutExternalReferencers)
 
COREUOBJECT_API void SetLinker (FLinkerLoad *LinkerLoad, int32 LinkerIndex, bool bShouldDetachExisting=true, bool bSilenceLogs=false)
 
COREUOBJECT_API UObjectGetArchetype () const
 
COREUOBJECT_API void GetArchetypeInstances (TArray< UObject * > &Instances)
 
COREUOBJECT_API void InstanceSubobjectTemplates (struct FObjectInstancingGraph *InstanceGraph=NULL)
 
template<class T >
bool Implements () const
 
virtual COREUOBJECT_API void ProcessEvent (UFunction *Function, void *Parms)
 
virtual bool CallRemoteFunction (UFunction *Function, void *Parms, struct FOutParmRec *OutParms, FFrame *Stack)
 
COREUOBJECT_API bool CallFunctionByNameWithArguments (const TCHAR *Cmd, FOutputDevice &Ar, UObject *Executor, bool bForceCallWithNonExec=false)
 
COREUOBJECT_API void CallFunction (FFrame &Stack, RESULT_DECL, UFunction *Function)
 
 DECLARE_FUNCTION (ProcessInternal)
 
virtual bool ProcessConsoleExec (const TCHAR *Cmd, FOutputDevice &Ar, UObject *Executor)
 
COREUOBJECT_API void SkipFunction (FFrame &Stack, RESULT_DECL, UFunction *Function)
 
virtual UClassRegenerateClass (UClass *ClassToRegenerate, UObject *PreviousCDO)
 
COREUOBJECT_API bool IsInBlueprint () const
 
COREUOBJECT_API void DestroyNonNativeProperties ()
 
virtual void MarkAsEditorOnlySubobject ()
 
COREUOBJECT_API void AbortInsideMemberFunction () const
 
 DECLARE_FUNCTION (execUndefined)
 
 DECLARE_FUNCTION (execLocalVariable)
 
 DECLARE_FUNCTION (execInstanceVariable)
 
 DECLARE_FUNCTION (execDefaultVariable)
 
 DECLARE_FUNCTION (execLocalOutVariable)
 
 DECLARE_FUNCTION (execInterfaceVariable)
 
 DECLARE_FUNCTION (execClassSparseDataVariable)
 
 DECLARE_FUNCTION (execInterfaceContext)
 
 DECLARE_FUNCTION (execArrayElement)
 
 DECLARE_FUNCTION (execBoolVariable)
 
 DECLARE_FUNCTION (execClassDefaultVariable)
 
 DECLARE_FUNCTION (execEndFunctionParms)
 
 DECLARE_FUNCTION (execNothing)
 
 DECLARE_FUNCTION (execNothingInt32)
 
 DECLARE_FUNCTION (execNothingOp4a)
 
 DECLARE_FUNCTION (execBreakpoint)
 
 DECLARE_FUNCTION (execTracepoint)
 
 DECLARE_FUNCTION (execWireTracepoint)
 
 DECLARE_FUNCTION (execInstrumentation)
 
 DECLARE_FUNCTION (execEndOfScript)
 
 DECLARE_FUNCTION (execReturnNothing)
 
 DECLARE_FUNCTION (execEmptyParmValue)
 
 DECLARE_FUNCTION (execJump)
 
 DECLARE_FUNCTION (execJumpIfNot)
 
 DECLARE_FUNCTION (execAssert)
 
 DECLARE_FUNCTION (execPushExecutionFlow)
 
 DECLARE_FUNCTION (execPopExecutionFlow)
 
 DECLARE_FUNCTION (execComputedJump)
 
 DECLARE_FUNCTION (execPopExecutionFlowIfNot)
 
 DECLARE_FUNCTION (execLet)
 
 DECLARE_FUNCTION (execLetObj)
 
 DECLARE_FUNCTION (execLetWeakObjPtr)
 
 DECLARE_FUNCTION (execLetBool)
 
 DECLARE_FUNCTION (execLetDelegate)
 
 DECLARE_FUNCTION (execLetMulticastDelegate)
 
 DECLARE_FUNCTION (execAddMulticastDelegate)
 
 DECLARE_FUNCTION (execClearMulticastDelegate)
 
 DECLARE_FUNCTION (execEatReturnValue)
 
 DECLARE_FUNCTION (execRemoveMulticastDelegate)
 
 DECLARE_FUNCTION (execSelf)
 
 DECLARE_FUNCTION (execContext)
 
 DECLARE_FUNCTION (execContext_FailSilent)
 
 DECLARE_FUNCTION (execStructMemberContext)
 
 DECLARE_FUNCTION (execVirtualFunction)
 
 DECLARE_FUNCTION (execFinalFunction)
 
 DECLARE_FUNCTION (execLocalVirtualFunction)
 
 DECLARE_FUNCTION (execLocalFinalFunction)
 
 DECLARE_FUNCTION (execStructCmpEq)
 
 DECLARE_FUNCTION (execStructCmpNe)
 
 DECLARE_FUNCTION (execStructMember)
 
 DECLARE_FUNCTION (execEqualEqual_DelegateDelegate)
 
 DECLARE_FUNCTION (execNotEqual_DelegateDelegate)
 
 DECLARE_FUNCTION (execEqualEqual_DelegateFunction)
 
 DECLARE_FUNCTION (execNotEqual_DelegateFunction)
 
 DECLARE_FUNCTION (execIntConst)
 
 DECLARE_FUNCTION (execInt64Const)
 
 DECLARE_FUNCTION (execUInt64Const)
 
 DECLARE_FUNCTION (execSkipOffsetConst)
 
 DECLARE_FUNCTION (execFloatConst)
 
 DECLARE_FUNCTION (execDoubleConst)
 
 DECLARE_FUNCTION (execStringConst)
 
 DECLARE_FUNCTION (execUnicodeStringConst)
 
 DECLARE_FUNCTION (execTextConst)
 
 DECLARE_FUNCTION (execPropertyConst)
 
 DECLARE_FUNCTION (execObjectConst)
 
 DECLARE_FUNCTION (execSoftObjectConst)
 
 DECLARE_FUNCTION (execFieldPathConst)
 
 DECLARE_FUNCTION (execInstanceDelegate)
 
 DECLARE_FUNCTION (execNameConst)
 
 DECLARE_FUNCTION (execByteConst)
 
 DECLARE_FUNCTION (execIntZero)
 
 DECLARE_FUNCTION (execIntOne)
 
 DECLARE_FUNCTION (execTrue)
 
 DECLARE_FUNCTION (execFalse)
 
 DECLARE_FUNCTION (execNoObject)
 
 DECLARE_FUNCTION (execNullInterface)
 
 DECLARE_FUNCTION (execIntConstByte)
 
 DECLARE_FUNCTION (execRotationConst)
 
 DECLARE_FUNCTION (execVectorConst)
 
 DECLARE_FUNCTION (execVector3fConst)
 
 DECLARE_FUNCTION (execTransformConst)
 
 DECLARE_FUNCTION (execStructConst)
 
 DECLARE_FUNCTION (execSetArray)
 
 DECLARE_FUNCTION (execSetSet)
 
 DECLARE_FUNCTION (execSetMap)
 
 DECLARE_FUNCTION (execArrayConst)
 
 DECLARE_FUNCTION (execSetConst)
 
 DECLARE_FUNCTION (execMapConst)
 
 DECLARE_FUNCTION (execBitFieldConst)
 
 DECLARE_FUNCTION (execNew)
 
 DECLARE_FUNCTION (execClassContext)
 
 DECLARE_FUNCTION (execNativeParm)
 
 DECLARE_FUNCTION (execCast)
 
 DECLARE_FUNCTION (execDynamicCast)
 
 DECLARE_FUNCTION (execMetaCast)
 
 DECLARE_FUNCTION (execInterfaceCast)
 
 DECLARE_FUNCTION (execDoubleToFloatCast)
 
 DECLARE_FUNCTION (execFloatToDoubleCast)
 
 DECLARE_FUNCTION (execObjectToBool)
 
 DECLARE_FUNCTION (execInterfaceToBool)
 
 DECLARE_FUNCTION (execObjectToInterface)
 
 DECLARE_FUNCTION (execInterfaceToInterface)
 
 DECLARE_FUNCTION (execInterfaceToObject)
 
 DECLARE_FUNCTION (execGetDynArrayElement)
 
 DECLARE_FUNCTION (execSetDynArrayElement)
 
 DECLARE_FUNCTION (execGetDynArrayLength)
 
 DECLARE_FUNCTION (execSetDynArrayLength)
 
 DECLARE_FUNCTION (execDynArrayInsert)
 
 DECLARE_FUNCTION (execDynArrayRemove)
 
 DECLARE_FUNCTION (execDynArrayFind)
 
 DECLARE_FUNCTION (execDynArrayFindStruct)
 
 DECLARE_FUNCTION (execDynArrayAdd)
 
 DECLARE_FUNCTION (execDynArrayAddItem)
 
 DECLARE_FUNCTION (execDynArrayInsertItem)
 
 DECLARE_FUNCTION (execDynArrayRemoveItem)
 
 DECLARE_FUNCTION (execDynArraySort)
 
 DECLARE_FUNCTION (execBindDelegate)
 
 DECLARE_FUNCTION (execCallMulticastDelegate)
 
 DECLARE_FUNCTION (execLetValueOnPersistentFrame)
 
 DECLARE_FUNCTION (execCallMathFunction)
 
 DECLARE_FUNCTION (execSwitchValue)
 
 DECLARE_FUNCTION (execArrayGetByRef)
 
 DECLARE_FUNCTION (execAutoRtfmTransact)
 
 DECLARE_FUNCTION (execAutoRtfmStopTransact)
 
 DECLARE_FUNCTION (execAutoRtfmAbortIfNot)
 
void ExecuteUbergraph (int32 EntryPoint)
 
virtual void ValidateGeneratedRepEnums (const TArray< struct FRepRecord > &ClassReps) const
 
virtual uint64 GetNetPushIdDynamic () const
 
- Public Member Functions inherited from UObjectBaseUtility
 UObjectBaseUtility ()
 
 UObjectBaseUtility (EObjectFlags InFlags)
 
void SetFlags (EObjectFlags NewFlags)
 
void ClearFlags (EObjectFlags FlagsToClear)
 
bool HasAnyFlags (EObjectFlags FlagsToCheck) const
 
bool HasAllFlags (EObjectFlags FlagsToCheck) const
 
UE_FORCEINLINE_HINT EObjectFlags GetMaskedFlags (EObjectFlags Mask=RF_AllFlags) const
 
UE_FORCEINLINE_HINT void Mark (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT void UnMark (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT bool HasAnyMarks (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT bool HasAllMarks (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT EObjectMark GetAllMarks () const
 
void MarkAsGarbage ()
 
void ClearGarbage ()
 
UE_FORCEINLINE_HINT void AddToRoot ()
 
UE_FORCEINLINE_HINT void RemoveFromRoot ()
 
UE_FORCEINLINE_HINT bool IsRooted () const
 
UE_FORCEINLINE_HINT int32 GetRefCount () const
 
bool ThisThreadAtomicallyClearedRFUnreachable ()
 
UE_FORCEINLINE_HINT bool IsUnreachable () const
 
UE_FORCEINLINE_HINT bool IsNative () const
 
void SetInternalFlags (EInternalObjectFlags FlagsToSet) const
 
UE_FORCEINLINE_HINT EInternalObjectFlags GetInternalFlags () const
 
UE_FORCEINLINE_HINT bool HasAnyInternalFlags (EInternalObjectFlags FlagsToCheck) const
 
void ClearInternalFlags (EInternalObjectFlags FlagsToClear) const
 
bool AtomicallyClearInternalFlags (EInternalObjectFlags FlagsToClear) const
 
COREUOBJECT_API FString GetFullName (const UObject *StopOuter=NULL, EObjectFullNameFlags Flags=EObjectFullNameFlags::None) const
 
COREUOBJECT_API void GetFullName (const UObject *StopOuter, FString &ResultString, EObjectFullNameFlags Flags=EObjectFullNameFlags::None) const
 
COREUOBJECT_API void GetFullName (FStringBuilderBase &ResultString, const UObject *StopOuter=NULL, EObjectFullNameFlags Flags=EObjectFullNameFlags::None) const
 
COREUOBJECT_API FString GetPathName (const UObject *StopOuter=NULL) const
 
COREUOBJECT_API void GetPathName (const UObject *StopOuter, FString &ResultString) const
 
COREUOBJECT_API void GetPathName (const UObject *StopOuter, FStringBuilderBase &ResultString) const
 
virtual bool CanBeClusterRoot () const
 
virtual COREUOBJECT_API bool CanBeInCluster () const
 
virtual COREUOBJECT_API void CreateCluster ()
 
virtual void OnClusterMarkedAsPendingKill ()
 
COREUOBJECT_API void AddToCluster (UObjectBaseUtility *ClusterRootOrObjectFromCluster, bool bAddAsMutableObject=false)
 
COREUOBJECT_API FString GetFullGroupName (bool bStartWithOuter) const
 
UE_FORCEINLINE_HINT FString GetName () const
 
UE_FORCEINLINE_HINT void GetName (FString &ResultString) const
 
UE_FORCEINLINE_HINT void AppendName (FString &ResultString) const
 
COREUOBJECT_API bool IsPackageExternal () const
 
COREUOBJECT_API void DetachExternalPackage ()
 
COREUOBJECT_API void ReattachExternalPackage ()
 
COREUOBJECT_API UObjectGetOutermostObject () const
 
COREUOBJECT_API UPackageGetPackage () const
 
UE_INTERNAL virtual COREUOBJECT_API UE::Core::FVersePath GetVersePath () const
 
COREUOBJECT_API UPackageGetOutermost () const
 
COREUOBJECT_API bool MarkPackageDirty () const
 
COREUOBJECT_API bool IsTemplate (EObjectFlags TemplateTypes=RF_ArchetypeObject|RF_ClassDefaultObject) const
 
COREUOBJECT_API UObjectGetTypedOuter (UClass *Target) const
 
template<typename T >
T * GetTypedOuter () const
 
template<typename InterfaceClassType >
InterfaceClassTypeGetImplementingOuter () const
 
COREUOBJECT_API UObjectBaseUtilityGetImplementingOuterObject (const UClass *InInterfaceClass) const
 
COREUOBJECT_API bool IsIn (const UObject *SomeOuter) const
 
COREUOBJECT_API bool IsIn (const UPackage *SomePackage) const
 
COREUOBJECT_API bool IsInOuter (const UObject *SomeOuter) const
 
COREUOBJECT_API bool IsInPackage (const UPackage *SomePackage) const
 
COREUOBJECT_API bool IsInA (const UClass *SomeBaseClass) const
 
COREUOBJECT_API bool RootPackageHasAnyFlags (uint32 CheckFlagMask) const
 
template<typename OtherClassType >
bool IsA (OtherClassType SomeBase) const
 
template<class T >
bool IsA () const
 
COREUOBJECT_API const UClassFindNearestCommonBaseClass (const UClass *TestClass) const
 
COREUOBJECT_API voidGetInterfaceAddress (UClass *InterfaceClass)
 
COREUOBJECT_API voidGetNativeInterfaceAddress (UClass *InterfaceClass)
 
const voidGetNativeInterfaceAddress (UClass *InterfaceClass) const
 
COREUOBJECT_API bool IsTemplateForSubobjects (EObjectFlags TemplateTypes=RF_ClassDefaultObject|RF_DefaultSubObject|RF_InheritableComponentTemplate) const
 
COREUOBJECT_API bool IsDefaultSubobject () const
 
COREUOBJECT_API class FLinkerLoadGetLinker () const
 
COREUOBJECT_API int32 GetLinkerIndex () const
 
COREUOBJECT_API FPackageFileVersion GetLinkerUEVersion () const
 
int32 GetLinkerUE4Version () const
 
COREUOBJECT_API int32 GetLinkerLicenseeUEVersion () const
 
int32 GetLinkerLicenseeUE4Version () const
 
COREUOBJECT_API int32 GetLinkerCustomVersion (FGuid CustomVersionKey) const
 
UE_FORCEINLINE_HINT bool operator< (const UObjectBaseUtility &Other) const
 
TStatId GetStatID (bool bForDeferredUse=false) const
 
- Public Member Functions inherited from UObjectBase
COREUOBJECT_API UObjectBase (UClass *InClass, EObjectFlags InFlags, EInternalObjectFlags InInternalFlags, UObject *InOuter, FName InName, int32 InInternalIndex=-1, int32 InSerialNumber=0, FRemoteObjectId InRemoteId=FRemoteObjectId())
 
virtual COREUOBJECT_API ~UObjectBase ()
 
COREUOBJECT_API bool IsValidLowLevel () const
 
COREUOBJECT_API bool IsValidLowLevelFast (bool bRecursive=true) const
 
FORCEINLINE uint32 GetUniqueID () const
 
FORCEINLINE UClassGetClass () const
 
FORCEINLINE UObjectGetOuter () const
 
FORCEINLINE FName GetFName () const
 
virtual COREUOBJECT_API FName GetFNameForStatID () const
 
COREUOBJECT_API UPackageGetExternalPackage () const
 
COREUOBJECT_API void SetExternalPackage (UPackage *InPackage)
 
COREUOBJECT_API UPackageGetExternalPackageInternal () const
 
COREUOBJECT_API void MarkAsReachable () const
 
COREUOBJECT_API void AddRef () const
 
COREUOBJECT_API void ReleaseRef () const
 
FORCEINLINE EObjectFlags GetFlags () const
 
FORCENOINLINE void AtomicallySetFlags (EObjectFlags FlagsToAdd)
 
FORCENOINLINE void AtomicallyClearFlags (EObjectFlags FlagsToClear)
 
- Protected Member Functions inherited from UObject
virtual FString GetDetailedInfoInternal () const
 
COREUOBJECT_API bool CanCheckDefaultSubObjects (bool bForceCheck, bool &bResult) const
 
virtual COREUOBJECT_API bool CheckDefaultSubobjectsInternal () const
 
- Protected Member Functions inherited from UObjectBase
 UObjectBase ()
 
COREUOBJECT_API UObjectBase (EObjectFlags InFlags)
 
COREUOBJECT_API void LowLevelRename (FName NewName, UObject *NewOuter=NULL)
 
virtual void RegisterDependencies ()
 
COREUOBJECT_API void Register (class UClass *(*StaticClassFn)(), const TCHAR *PackageName, const TCHAR *Name)
 
COREUOBJECT_API void Register (const TCHAR *PackageName, const TCHAR *Name)
 
virtual COREUOBJECT_API void DeferredRegister (UClass *UClassStaticClass, const TCHAR *PackageName, const TCHAR *Name)
 
FORCEINLINE void SetFlagsTo (EObjectFlags NewFlags)
 

Member Function Documentation

◆ AddManualEnvironmentCaptureProbe()

bool UARBlueprintLibrary::AddManualEnvironmentCaptureProbe ( FVector  Location,
FVector  Extent 
)
static

Adds an environment capture probe to the ar world

◆ AddRuntimeCandidateImage()

UARCandidateImage * UARBlueprintLibrary::AddRuntimeCandidateImage ( UARSessionConfig SessionConfig,
UTexture2D CandidateTexture,
FString  FriendlyName,
float  PhysicalWidth 
)
static

Create an ARCandidateImage 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 UARCandidateImage Object pointer if the underlying ARPlatform added the candidate image at runtime successfully. Return nullptr otherwise.

◆ AddTrackedPointWithName()

bool UARBlueprintLibrary::AddTrackedPointWithName ( const FTransform WorldTransform,
const FString &  PointName,
bool  bDeletePointsWithSameName = true 
)
static

Manually add a tracked point with name and world transform. @WorldTransform: transform in the world space where the point should be created. @PointName: the name of the created point, must be non-empty. @bDeletePointsWithSameName: if existing points with the same name should be deleted.

Returns
if the operation succeeds. Note that this is an async operation - the added point won't be available until a few frames later.

◆ CalculateAlignmentTransform()

void UARBlueprintLibrary::CalculateAlignmentTransform ( const FTransform TransformInFirstCoordinateSystem,
const FTransform TransformInSecondCoordinateSystem,
FTransform AlignmentTransform 
)
static

◆ CalculateClosestIntersection()

void UARBlueprintLibrary::CalculateClosestIntersection ( const TArray< FVector > &  StartPoints,
const TArray< FVector > &  EndPoints,
FVector ClosestIntersection 
)
static

◆ DebugDrawPin()

void UARBlueprintLibrary::DebugDrawPin ( UARPin ARPin,
UObject WorldContextObject,
FLinearColor  Color = FLinearColor(1.0f, 1.0f, 0.0f, 0.75f),
float  Scale = 5.0f,
float  PersistForSeconds = 0.0f 
)
static

Given a UARPin, draw it for debugging purposes.

◆ DebugDrawTrackedGeometry()

void UARBlueprintLibrary::DebugDrawTrackedGeometry ( UARTrackedGeometry TrackedGeometry,
UObject WorldContextObject,
FLinearColor  Color = FLinearColor(1.0f, 1.0f, 0.0f, 0.75f),
float  OutlineThickness = 5.0f,
float  PersistForSeconds = 0.0f 
)
static

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

◆ FindTrackedPointsByName()

TArray< UARTrackedPoint * > UARBlueprintLibrary::FindTrackedPointsByName ( const FString &  PointName)
static
Returns
a list of the tracked points with the given name

◆ GetAlignmentTransform()

FTransform UARBlueprintLibrary::GetAlignmentTransform ( )
static
Returns
the alignment transform, see "SetAlignmentTransform"

◆ GetAllGeometries()

TArray< UARTrackedGeometry * > UARBlueprintLibrary::GetAllGeometries ( )
static
Returns
a list of all the real-world geometry as currently seen by the Augmented Reality system

◆ GetAllGeometriesByClass() [1/2]

template<class T >
static TArray< T * > UARBlueprintLibrary::GetAllGeometriesByClass ( )
inlinestatic
Returns
a list of all the real-world geometry of the specified class as currently seen by the Augmented Reality system

◆ GetAllGeometriesByClass() [2/2]

TArray< UARTrackedGeometry * > UARBlueprintLibrary::GetAllGeometriesByClass ( TSubclassOf< UARTrackedGeometry GeometryClass)
static
Returns
a list of all the real-world geometry of the specified class as currently seen by the Augmented Reality system

◆ GetAllPins()

TArray< UARPin * > UARBlueprintLibrary::GetAllPins ( )
static

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.

◆ GetAllTracked2DPoses()

TArray< FARPose2D > UARBlueprintLibrary::GetAllTracked2DPoses ( )
static
Returns
all the 2D poses tracked by the AR system

◆ GetARSessionStatus()

FARSessionStatus UARBlueprintLibrary::GetARSessionStatus ( )
static

It is intended that you check the status of the Augmented Reality session on every frame and take action accordingly. e.g. if the session stopped for an unexpected reason, you might give the user a prompt to re-start the session

Returns
The status of a current Augmented Reality session: e.g. Running or Not running for a specific reason.

◆ GetARTexture()

UARTexture * UARBlueprintLibrary::GetARTexture ( EARTextureType  TextureType)
static
Returns
the AR texture for the specified type

◆ GetARWorldScale()

float UARBlueprintLibrary::GetARWorldScale ( )
static
Returns
the AR world scale, see "SetARWorldScale"

◆ GetCameraIntrinsics()

bool UARBlueprintLibrary::GetCameraIntrinsics ( FARCameraIntrinsics OutCameraIntrinsics)
static
Returns
the intrinsics of the AR camera.

◆ GetCandidateObject()

TSharedPtr< FARGetCandidateObjectAsyncTask, ESPMode::ThreadSafe > UARBlueprintLibrary::GetCandidateObject ( FVector  Location,
FVector  Extent 
)
static

◆ GetCurrentLightEstimate()

UARLightEstimate * UARBlueprintLibrary::GetCurrentLightEstimate ( )
static

An AugmentedReality session can be configured to provide light estimates. The specific approach to light estimation can be configured by the UARSessionConfig specified during StartARSession(). This function assumes that you will cast the returned UARLightEstimate to a derived type corresponding to your session config.

Returns
a UARLighEstimate that can be cast to a derived class.

◆ GetNumberOfTrackedFacesSupported()

int32 UARBlueprintLibrary::GetNumberOfTrackedFacesSupported ( )
static
Returns
the max number of faces can be tracked at the same time

◆ GetObjectClassificationAtLocation()

bool UARBlueprintLibrary::GetObjectClassificationAtLocation ( const FVector InWorldLocation,
EARObjectClassification OutClassification,
FVector OutClassificationLocation,
float  MaxLocationDiff = 10.f 
)
static

Try to determine the classification of the object at a world space location @InWorldLocation: the world location where the classification is needed @OutClassification: the classification result @OutClassificationLocation: the world location at where the classification is calculated @MaxLocationDiff: the max distance between the specified world location and the classification location

Returns
: whether a valid classification result is calculated

◆ GetPointCloud()

TArray< FVector > UARBlueprintLibrary::GetPointCloud ( )
static
Returns
the raw point cloud view of the AR scene

◆ GetSessionConfig()

UARSessionConfig * UARBlueprintLibrary::GetSessionConfig ( )
static
Returns
the configuration that the current session was started with.

◆ GetSupportedVideoFormats()

TArray< FARVideoFormat > UARBlueprintLibrary::GetSupportedVideoFormats ( EARSessionType  SessionType)
static
Returns
The list of supported video formats for this device

◆ GetTrackingQuality()

EARTrackingQuality UARBlueprintLibrary::GetTrackingQuality ( )
static
Returns
how well the tracking system is performing at the moment

◆ GetTrackingQualityReason()

EARTrackingQualityReason UARBlueprintLibrary::GetTrackingQualityReason ( )
static
Returns
The reason for the current limited tracking state

◆ GetWorldMappingStatus()

EARWorldMappingState UARBlueprintLibrary::GetWorldMappingStatus ( )
static
Returns
the current world mapping status for the AR world

◆ IsARPinLocalStoreReady()

bool UARBlueprintLibrary::IsARPinLocalStoreReady ( )
static

Is ARPin Local Store Ready

Returns
True if local store is ready for use.

◆ IsARPinLocalStoreSupported()

bool UARBlueprintLibrary::IsARPinLocalStoreSupported ( )
static

Is ARPin Local Store Supported

Returns
True if Local Pin saving is supported by the device/platform.

◆ IsARSupported()

bool UARBlueprintLibrary::IsARSupported ( void  )
static

Checks if the current device can support AR

◆ IsSceneReconstructionSupported()

bool UARBlueprintLibrary::IsSceneReconstructionSupported ( EARSessionType  SessionType,
EARSceneReconstruction  SceneReconstructionMethod 
)
static
Returns
if a particular scene reconstruction method is supported with the specified session type on the current platform

◆ IsSessionTrackingFeatureSupported()

bool UARBlueprintLibrary::IsSessionTrackingFeatureSupported ( EARSessionType  SessionType,
EARSessionTrackingFeature  SessionTrackingFeature 
)
static
Returns
if a particular session feature is supported with the specified session type on the current platform

◆ IsSessionTypeSupported()

bool UARBlueprintLibrary::IsSessionTypeSupported ( EARSessionType  SessionType)
static

Test whether this type of session is supported by the current Augmented Reality platform. e.g. is your device capable of doing positional tracking or orientation only?

◆ LineTraceTrackedObjects()

TArray< FARTraceResult > UARBlueprintLibrary::LineTraceTrackedObjects ( const FVector2D  ScreenCoord,
bool  bTestFeaturePoints = true,
bool  bTestGroundPlane = true,
bool  bTestPlaneExtents = true,
bool  bTestPlaneBoundaryPolygon = true 
)
static

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

Parameters
ScreenCoordCoordinate of the point on the screen from which to cast a ray into the tracking space.
Returns
a list of FARTraceResult sorted by distance from camera.

◆ LineTraceTrackedObjects3D()

TArray< FARTraceResult > UARBlueprintLibrary::LineTraceTrackedObjects3D ( const FVector  Start,
const FVector  End,
bool  bTestFeaturePoints = true,
bool  bTestGroundPlane = true,
bool  bTestPlaneExtents = true,
bool  bTestPlaneBoundaryPolygon = true 
)
static

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

Parameters
StartStart point of the trace, in world space.
EndEnd point of the trace, in world space.
Returns
a list of FARTraceResult sorted by distance from camera.

◆ LoadARPinsFromLocalStore()

TMap< FName, UARPin * > UARBlueprintLibrary::LoadARPinsFromLocalStore ( )
static

Load all ARPins from local save Note: Multiple loads of a saved pin may result in duplicate pins OR overwritten pins. It is reccomended to only load once.

Returns
Map of SaveName:ARPin.

◆ PauseARSession()

void UARBlueprintLibrary::PauseARSession ( )
static

Pause a running Augmented Reality session without clearing existing state.

◆ PinComponent()

UARPin * UARBlueprintLibrary::PinComponent ( USceneComponent *  ComponentToPin,
const FTransform PinToWorldTransform,
UARTrackedGeometry TrackedGeometry = nullptr,
const FName  DebugName = NAME_None 
)
static

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

Parameters
ComponentToPinThe component that should be pinned.
PinToWorldTransformA transform (in Unreal World Space) that corresponds to a physical location where the component should be pinned.
TrackedGeometryAn optional, real-world geometry that is recognized by the AR system; any correction to the position of this geometry will be applied to the pinned component.
DebugNameAn optional name that will be displayed when this pin is being drawn for debugging purposes.
Returns
an object representing the pin that connects ComponentToPin component to a real-world location and optionally to the TrackedGeometry.

◆ PinComponentToARPin()

bool UARBlueprintLibrary::PinComponentToARPin ( USceneComponent *  ComponentToPin,
UARPin Pin 
)
static

Associate a component with an ARPin, so that its transform will be updated by the pin. Any previously associated component will be detached.

Parameters
ComponentToPinThe Component which will be updated by the Pin.
PinThe Pin which the component will be updated by.
Returns
True if the operation was successful.

◆ PinComponentToTraceResult()

UARPin * UARBlueprintLibrary::PinComponentToTraceResult ( USceneComponent *  ComponentToPin,
const FARTraceResult TraceResult,
const FName  DebugName = NAME_None 
)
static

A convenient version of PinComponent() that can be used in conjunction with a result of a LineTraceTrackedObjects call.

◆ RegisterAsARSystem()

void UARBlueprintLibrary::RegisterAsARSystem ( const TSharedRef< FARSupportInterface, ESPMode::ThreadSafe > &  NewArSystem)
static

◆ RemoveAllARPinsFromLocalStore()

void UARBlueprintLibrary::RemoveAllARPinsFromLocalStore ( )
static

Remove all ARPins from the local store

◆ RemoveARPinFromLocalStore()

void UARBlueprintLibrary::RemoveARPinFromLocalStore ( FName  InSaveName)
static

Remove an ARPin from the local store

Parameters
InNameThe save name to remove.

◆ RemovePin()

void UARBlueprintLibrary::RemovePin ( UARPin PinToRemove)
static

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

◆ ResizeXRCamera()

FIntPoint UARBlueprintLibrary::ResizeXRCamera ( const FIntPoint InSize)
static

Change screen size of Mixed Reality Capture camera.

◆ SaveARPinToLocalStore()

bool UARBlueprintLibrary::SaveARPinToLocalStore ( FName  InSaveName,
UARPin InPin 
)
static

Save an ARPin to local store

Parameters
InNameThe save name for the pin.
InPinThe ARPin which will be saved to the local store.
Returns
True if saved successfully.

◆ SaveWorld()

TSharedPtr< FARSaveWorldAsyncTask, ESPMode::ThreadSafe > UARBlueprintLibrary::SaveWorld ( )
static

◆ SetAlignmentTransform()

void UARBlueprintLibrary::SetAlignmentTransform ( const FTransform InAlignmentTransform)
static

Set a transform that will be applied to the tracking space. This effectively moves any camera possessed by the Augmented Reality system such that it is pointing at a different spot in Unreal's World Space. This is often done to support AR scenarios that rely on static geometry and/or lighting.

Note: any movable components that are pinned will appear to stay in place, while anything not pinned or is not movable (static or stationary) will appear to move.

See also
PinComponent
PinComponentToTraceResult

◆ SetARWorldOriginLocationAndRotation()

void UARBlueprintLibrary::SetARWorldOriginLocationAndRotation ( FVector  OriginLocation,
FRotator  OriginRotation,
bool  bIsTransformInWorldSpace = true,
bool  bMaintainUpDirection = true 
)
static

For a point P in the AR local space, whose location and rotation are "OriginLocation" and "OriginRotation" in the world space modify the alignment transform so that the same point P will be transformed to the origin in the world space. @bIsTransformInWorldSpace: whether "OriginLocation" and "OriginRotation" are specified in UE4's world space or AR system's local space. @bMaintainUpDirection: if set, only the yaw roation of the alignment transform will be modified, pitch and roll will be zeroed out.

◆ SetARWorldScale()

void UARBlueprintLibrary::SetARWorldScale ( float  InWorldScale)
static

Helper function that modifies the alignment transform scale so that virtual content in the world space appears to be "scaled". Note that ultimately the scaling effect is achieved through modifying the translation of the camera: moving the camera further away from the origin makes objects appear to be smaller, and vice versa.

◆ SetEnabledXRCamera()

void UARBlueprintLibrary::SetEnabledXRCamera ( bool  bOnOff)
static

Enable or disable Mixed Reality Capture camera.

◆ StartARSession()

void UARBlueprintLibrary::StartARSession ( UARSessionConfig SessionConfig)
static

Begin a new Augmented Reality session. Subsequently, use the GetARSessionStatus() function to figure out the status of the session.

Parameters
SessionConfigDescribes the tracking method to use, what kind of geometry to detect in the world, etc.

(UE_BUILD_SHIPPING || UE_BUILD_TEST)

(UE_BUILD_SHIPPING || UE_BUILD_TEST)

◆ StopARSession()

void UARBlueprintLibrary::StopARSession ( )
static

Stop a running Augmented Reality session and clear any state.

◆ ToggleARCapture()

bool UARBlueprintLibrary::ToggleARCapture ( const bool  bOnOff,
const EARCaptureType  CaptureType 
)
static

Starts or stops a battery intensive service on device.

◆ UnpinComponent()

void UARBlueprintLibrary::UnpinComponent ( USceneComponent *  ComponentToUnpin)
static

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


The documentation for this class was generated from the following files: