UAndroidXRTrackablesCoreBlueprintFunctionLibrary

#include <AndroidXRTrackablesCoreBlueprintFunctionLibrary.h>

Summary

Inheritance

Inherits from: UBlueprintFunctionLibrary

Public static functions

CreateAnchorSpace(const FTransform & Transform, const FAndroidXRTrackable & Trackable, FAndroidXRSpace & AnchorSpace)
bool
Creates an anchor space.
CreateTrackableTracker(EAndroidXRTrackableType TrackableType, FAndroidXRTrackableTracker & TrackableTracker)
bool
Creates a trackable tracker for the specified trackable type.
DestroyTrackableTracker(FAndroidXRTrackableTracker & TrackableTracker)
bool
Destroys a trackable tracker.
EnumerateRaycastSupportedTrackableTypes(TArray< EAndroidXRTrackableType > & TrackableTypes)
bool
Enumerates the trackable types supported by the Raycast API.
EnumerateSupportedAnchorTrackableTypes(TArray< EAndroidXRTrackableType > & TrackableTypes)
bool
Enumerates the anchor trackable types supported by the Trackables API.
EnumerateSupportedTrackableTypes(TArray< EAndroidXRTrackableType > & TrackableTypes)
bool
Enumerates the trackable types supported by the Trackables API.
GetAllTrackables(const FAndroidXRTrackableTracker & TrackableTracker, TArray< FAndroidXRTrackable > & Trackables)
bool
Gets all trackables of the specified trackable tracker type.
GetTrackablePlane(const FAndroidXRTrackableTracker & TrackableTracker, const FAndroidXRTrackable & Trackable, FAndroidXRTrackablePlane & TrackablePlane)
bool
GetTrackableProperties(int32 & MaxAnchors)
bool
Returns whether or not anchors are supported and provides the maximum number of anchors.
IsValidTrackable(const FAndroidXRTrackable & Trackable)
bool
Determines whether or not an FAndroidXRTrackable is valid.
IsValidTrackableTracker(const FAndroidXRTrackableTracker & TrackableTracker)
bool
Determines whether or not a FAndroidXRTrackableTracker is valid.
Raycast(const FVector & Origin, const FVector & Direction, const TArray< FAndroidXRTrackableTracker > & TrackableTrackers, int32 MaxResults, TArray< FAndroidXRRaycastHit > & HitResults)
bool
Performs a raycast against the specified trackable trackers.

Public static functions

CreateAnchorSpace

bool CreateAnchorSpace(
  const FTransform & Transform,
  const FAndroidXRTrackable & Trackable,
  FAndroidXRSpace & AnchorSpace
)

Creates an anchor space.

Details
Parameters
Transform
Anchor transform.
Trackable
Optional trackable to attach the anchor to.
AnchorSpace
Created anchor space.
Returns
True if the underlying API call was successful.

CreateTrackableTracker

bool CreateTrackableTracker(
  EAndroidXRTrackableType TrackableType,
  FAndroidXRTrackableTracker & TrackableTracker
)

Creates a trackable tracker for the specified trackable type.

Details
Parameters
TrackableType
Type of trackable tracker to be created.
TrackableTracker
Created trackable tracker.
Returns
True if the underlying API call was successful.

DestroyTrackableTracker

bool DestroyTrackableTracker(
  FAndroidXRTrackableTracker & TrackableTracker
)

Destroys a trackable tracker.

Details
Parameters
TrackableTracker
Trackable tracker to be destroyed.
Returns
True if the underlying API call was successful.

EnumerateRaycastSupportedTrackableTypes

bool EnumerateRaycastSupportedTrackableTypes(
  TArray< EAndroidXRTrackableType > & TrackableTypes
)

Enumerates the trackable types supported by the Raycast API.

Details
Parameters
TrackableTypes
Array to be filled with supported trackable types.
Returns
True if the underlying API call was successful.

EnumerateSupportedAnchorTrackableTypes

bool EnumerateSupportedAnchorTrackableTypes(
  TArray< EAndroidXRTrackableType > & TrackableTypes
)

Enumerates the anchor trackable types supported by the Trackables API.

Details
Parameters
TrackableTypes
Array to be filled with supported anchor trackable types.
Returns
True if the underlying API call was successful.

EnumerateSupportedTrackableTypes

bool EnumerateSupportedTrackableTypes(
  TArray< EAndroidXRTrackableType > & TrackableTypes
)

Enumerates the trackable types supported by the Trackables API.

Details
Parameters
TrackableTypes
Array to be filled with supported trackable types.
Returns
True if the underlying API call was successful.

GetAllTrackables

bool GetAllTrackables(
  const FAndroidXRTrackableTracker & TrackableTracker,
  TArray< FAndroidXRTrackable > & Trackables
)

Gets all trackables of the specified trackable tracker type.

Details
Parameters
TrackableTracker
Previously created tracker specifying what type of trackables to get.
Trackables
Array to be filled with trackables.
Returns
True if the underlying API call was successful.

GetTrackablePlane

bool GetTrackablePlane(
  const FAndroidXRTrackableTracker & TrackableTracker,
  const FAndroidXRTrackable & Trackable,
  FAndroidXRTrackablePlane & TrackablePlane
)

Gets an FAndroidXRTrackablePlane from an FAndroidXRTrackable.

Details
Parameters
TrackableTracker
Previously created plane tracker.
Trackable
Previously obtained trackable.
TrackablePlane
Trackable plane.
Returns
True if the underlying API call was successful.

GetTrackableProperties

bool GetTrackableProperties(
  int32 & MaxAnchors
)

Returns whether or not anchors are supported and provides the maximum number of anchors.

Details
Parameters
MaxAnchors
The maximum number of anchors supported (if 0, indicates anchors are not supported).
Returns
True if the underlying API call was successful.

IsValidTrackable

bool IsValidTrackable(
  const FAndroidXRTrackable & Trackable
)

Determines whether or not an FAndroidXRTrackable is valid.

Details
Parameters
Trackable
Trackable to be verified.
Returns
True if the trackable is valid.

IsValidTrackableTracker

bool IsValidTrackableTracker(
  const FAndroidXRTrackableTracker & TrackableTracker
)

Determines whether or not a FAndroidXRTrackableTracker is valid.

Details
Parameters
TrackableTracker
TrackableTracker to be verified.
Returns
True if the trackable tracker is valid.

Raycast

bool Raycast(
  const FVector & Origin,
  const FVector & Direction,
  const TArray< FAndroidXRTrackableTracker > & TrackableTrackers,
  int32 MaxResults,
  TArray< FAndroidXRRaycastHit > & HitResults
)

Performs a raycast against the specified trackable trackers.

Details
Parameters
Origin
Starting location of the ray.
Direction
Direction of the ray.
TrackableTrackers
Array of trackers to be raycast against.
MaxResults
The maximum number of results.
HitResults
Array to be filled with hit results.
Returns
True if the underlying API call was successful.