C++ Java Unity
Unity Reference
IUnityARFoundationFacade Interface Reference

Provides access to AR Foundation functionality More...

Public Member Functions

string AddAnchor (Pose pose)
 Performs create anchor on AR Foundation anchor manager More...
 
IEnumerator CheckAvailability ()
 Queries AR Session for availability. More...
 
void ClearAnchors ()
 Removes the anchors created by Vuforia More...
 
void Deinit ()
 Performs clean up More...
 
void FindDependencies ()
 Searches for required AR Foundation objects in the scene More...
 
Transform GetCameraTransform ()
 Gets the transform of AR Pose Driver object. Device pose is applied to that object by AR Foundation. More...
 
List< CameraModeGetProfiles ()
 Queries AR Camera Manager for available camera profiles. More...
 
bool HitTest (Vector2 screenPoint, out List< Pose > hitPoses)
 Casts a ray from screen point to AR Foundation planes More...
 
void Init ()
 Performs steps required to make Vuforia work with AR Foundations. More...
 
bool IsARFoundationReady ()
 Queries AR Session for state. More...
 
bool IsARFoundationScene ()
 Checks if AR Session object exists in the scene. More...
 
bool RemoveAnchor (string uuid)
 Performs remove on AR Foundation anchor manager More...
 
bool SelectProfile (CameraMode profile)
 Selects the requested camera profiles. More...
 
IEnumerator WaitCameraForReady ()
 Waits until AR Foundation camera subsystem is working and ready to track. More...
 

Events

Action< List<(string, Transform)>, List<(string, Transform)> > AnchorsChangedEvent
 
Action< ARFoundationImageARFoundationImageEvent
 
Action< Transform, long > ARFoundationPoseEvent
 

Detailed Description

Provides access to AR Foundation functionality

Member Function Documentation

string AddAnchor ( Pose  pose)

Performs create anchor on AR Foundation anchor manager

Parameters
posePose in Unity space
Returns
IEnumerator CheckAvailability ( )

Queries AR Session for availability.

Returns
void ClearAnchors ( )

Removes the anchors created by Vuforia

void Deinit ( )

Performs clean up

void FindDependencies ( )

Searches for required AR Foundation objects in the scene

Transform GetCameraTransform ( )

Gets the transform of AR Pose Driver object. Device pose is applied to that object by AR Foundation.

Returns
Device pose
List<CameraMode> GetProfiles ( )

Queries AR Camera Manager for available camera profiles.

Returns
bool HitTest ( Vector2  screenPoint,
out List< Pose >  hitPoses 
)

Casts a ray from screen point to AR Foundation planes

Parameters
screenPoint
hitPoses
Returns
void Init ( )

Performs steps required to make Vuforia work with AR Foundations.

bool IsARFoundationReady ( )

Queries AR Session for state.

Returns
bool IsARFoundationScene ( )

Checks if AR Session object exists in the scene.

Returns
bool RemoveAnchor ( string  uuid)

Performs remove on AR Foundation anchor manager

Parameters
uuidAnchor to remove. Currently TrackableId of the the anchor
Returns
bool SelectProfile ( CameraMode  profile)

Selects the requested camera profiles.

Parameters
profileMust be a profile from the available camera profiles
IEnumerator WaitCameraForReady ( )

Waits until AR Foundation camera subsystem is working and ready to track.

Returns

Event Documentation

Action<List<(string, Transform)>, List<(string, Transform)> > AnchorsChangedEvent
Action<ARFoundationImage> ARFoundationImageEvent
Action<Transform, long> ARFoundationPoseEvent