Skip to main content

Auki::AukiRigHelper

A class that contains helper methods for instantiating ConjureKit scene objects.

Public Functions​

Name
GameObjectInstantiateGameObjectFromResourcePath(string path)
Returns a loaded from Resources and instantiated as a GameObject prefab from provided path.
SceneRigMakeSceneRigFromRig(GameObject rig, string imageTrackingReferenceImageLibraryPath, string trackedImagePrefabPath, string planeManagerPlanePrefabPath)
Creates and returns a SceneRig object.
AukiUnityBridgeMakeAukiUnityBridgeFromRig(GameObject rig, Action onGUI, Action< bool > onApplicationPause, Action onDestroy, Action onUpdate)
Creates and returns an AukiUnityBridge component with given parameters attached.

Public Functions Documentation​

function InstantiateGameObjectFromResourcePath​

static GameObject InstantiateGameObjectFromResourcePath(
    string path
)

Returns a loaded from Resources and instantiated as a GameObject prefab from provided path.

Parameters:

  • path Path relative to Resources folder

Return: GameObject of instantiated prefab

function MakeSceneRigFromRig​

static SceneRig MakeSceneRigFromRig(
    GameObject rig,
    string imageTrackingReferenceImageLibraryPath,
    string trackedImagePrefabPath,
    string planeManagerPlanePrefabPath
)

Creates and returns a SceneRig object.

Parameters:

  • rig GameObject that will have the SceneRig's components attached
  • imageTrackingReferenceImageLibraryPath Path to Image tracking reference image library prefab relative to a Resources folder
  • trackedImagePrefabPath Path to tracked image prefab relative to a Resources folder
  • planeManagerPlanePrefabPath Path to a detected plane prefab relative to a Resources folder

Return: SceneRig object

function MakeAukiUnityBridgeFromRig​

static AukiUnityBridge MakeAukiUnityBridgeFromRig(
    GameObject rig,
    Action onGUI,
    Action< bool > onApplicationPause,
    Action onDestroy,
    Action onUpdate
)

Creates and returns an AukiUnityBridge component with given parameters attached.

Parameters:

  • rig GameObject to which the AukiUnityBridge will be attached to
  • onGUI Callback that will prompt rendering & handling of GUI events
  • onApplicationPause Callback for pausing or resuming application events
  • onDestroy Callback for destructor
  • onUpdate Callback for game loop

Return: AukiUnityBridge object