UGoogleARCoreFrameFunctionLibrary

#include <GoogleARCoreFunctionLibrary.h>

A function library that provides static/Blueprint functions associated with most recent GoogleARCore tracking frame.

Summary

Inheritance

Inherits from: UBlueprintFunctionLibrary

Public attributes

meta = (Keywords = "googlear arcore session")) static EGoogleARCoreTrackingState GetTrackingState()
Returns the current ARCore session status.

Public static functions

GetUpdatedTrackable(TArray< T * > & OutTrackableList)
void
Template function to get the updated trackables in this frame a given trackable type.

Public attributes

meta

 meta = (Keywords = "googlear arcore session"))
  static EGoogleARCoreTrackingState GetTrackingState()

Returns the current ARCore session status.

Acquire a CPU-accessible camera image.

Acquires latest point cloud.

Gets the latest point cloud that will be only available for this frame.

Gets the latest light estimation.

Gets a list of UARTrackedPoint objects that were changed in this frame.

Gets a list of UARPlaneGeometry objects that were changed in this frame.

Gets a list of UARPin objects that were changed in this frame.

Traces a ray from the user's device in the direction of the given location in the camera view.

Gets the latest tracking pose in Unreal world space of the ARCore device.

Note that ARCore motion tracking has already integrated with HMD and the motion controller interface. Use this function only if you need to implement your own tracking component.

Details
Returns
A EARSessionStatus enum that describes the session status.

Intersections with detected scene geometry are returned, sorted by distance from the device; the nearest intersection is returned first.

Details
Parameters
OutPose
The latest device pose.
Returns
True if the pose is updated successfully for this frame.

If you want to keep the point cloud data, you can either copy it to your own struct or call AcquireLatestPointCloud() to avoid the copy.

Details
Parameters
WorldContextObject
The world context.
ScreenPosition
The position on the screen to cast the ray from.
ARObjectType
A set of EGoogleARCoreLineTraceChannel indicate which type of line trace it should perform.
OutHitResults
The list of hit results sorted by distance.
Parameters
OutAnchorList
An array that contains the updated UARPin.
OutARCorePlaneList
An array that contains the updated UARPlaneGeometry.
OutARCorePlaneList
An array that contains the updated UARTrackedPoint.
OutLightEstimate
The struct that describes the latest light estimation.
Returns
True if there is a hit detected.

This will make the point cloud remain valid unless you call UGoogleARCrePointCloud::ReleasePointCloud(). Be aware that this function could fail if the maximal number of point cloud has been acquired.

Details
Parameters
OutLatestPointCloud
A pointer point to the latest point cloud.
Returns
An EGoogleARCoreFunctionStatus. Possible value: Success, SessionPaused, ResourceExhausted.

Details
Parameters
OutLatestPointCloud
A pointer point to the latest point cloud.
Parameters
OutLatestCameraImage
A place to store the pointer to a new UGoogleARCoreCameraImage instance.
Returns
An EGoogleARCoreFunctionStatus. Possible value: Success, SessionPaused, ResourceExhausted.
Returns
An EGoogleARCoreFunctionStatus. Possible value: Success, ResourceExhausted, NotAvailable.

Public static functions

GetUpdatedTrackable

void GetUpdatedTrackable(
  TArray< T * > & OutTrackableList
)

Template function to get the updated trackables in this frame a given trackable type.

Send feedback about...