Skip to main content

Auki::ConjureKit::Manna::Manna

Functionalities of the Manna module are enabled by instantiating a [Manna](/#) object while passing your instance of ConjureKit

Inherits from ConjureKitModule

Public Functions​

Name
Manna(IConjureKit conjureKit, float distanceToSizeRatio =10f)
Constructor - initializes and registers Manna as a ConjureKit module.
voidSetOnBeforeCalibration(Action< Lighthouse, Action< bool >> onBeforeCalibration)
Set a callback that is called after a calibration frame has been decided and allows for the developer to do some logic before the calibration and decide if it should continue. If the action is called with true, the calibration will continue, else it will not.
voidSetStaticLighthousePoseSelector(Action< LighthousePose[], Action< LighthousePose >> poseSelector)
Set a callback that is called when a static lighthouse has been scanned. The callback should invoke the provided Action with a chosen LighthousePose from the array.
voidSetLighthouseVisible(bool visible)
Display/hide the on-screen instant calibration QR code.
voidLeftMultiplyTransformByMatrix(Transform transform, Matrix4x4 matrix)
Utility function. See usage notes in the Manna class overview.
voidLeftMultiplyTransformByMatrix(GameObject gameObject, Matrix4x4 matrix)
Utility function. See usage notes in the Manna class overview.

Public Properties​

Name
Action< Lighthouse, Pose, bool >OnLighthouseTracked
Called when a lighthouse is being tracked even if its not close enough the boolean passed indicates weather its deemed to be close enough or not.
Action< Matrix4x4 >OnCalibrationSuccess
This callback is called at the same frame that the pose of the ARSessionOrigin is adjusted to accommodate for joining a pre-existing session via QR code calibration. See the detailed usage notes above in the Manna class overview.
Action< Lighthouse >OnCalibrationFailed
Called if calibration fails at the image tracker level. (Lost lighthouse.)

Detailed Description​

class Auki::ConjureKit::Manna::Manna;

Functionalities of the Manna module are enabled by instantiating a [Manna](/#) object while passing your instance of ConjureKit

Use the SetLighthouseVisible method of the Manna class to hide and show the calibrating QR code.

The on-screen position and appearance of the QR code is not adjustable in this release of the Manna module.

When a participant running an application with the same app_key scans a code, that participant is automatically taken out of their current session and brought into the session of the participant displaying the code. This triggers ConjureKit.

By examining the pose of the displayed QR code relative to itself the joining device also computes a 4x4 matrix M mapping its current world coordinates to the world coordinates of the new session. This matrix is applied to its ARSessionOrigin transform, effectively changing the (physical) pose of the joining participant's Unity scene origin to match the (physical) pose of the scene origin in the session being joined. Note that any visible assets will change (physical) position alongside the Unity scene origin during this step unless corrective action is taken.

Visible assets can be kept in place during the coordinate change by setting Manna's .OnCalibrationSuccess callback. This callback takes the afore-mentioned matrix M as argument. One should left-multiply the transforms of any first-level game objects that belong to the old coordinate system to keep them in physical place. The Manna class provides a convenience static method for this, LeftMultiplyTransformByMatrix. E.g.: 

using Auki.ConjureKit;
using Auki.ConjureKit.Manna;

public class Main : MonoBehaviour
{
    _gameObject1 = ...;
    _gameObject2 = ...;
    _conjureKit = new ConjureKit(app_key, app_secret);
    _manna = new Manna(_conjureKit);
    _manna.OnCalibrationSuccess += (matrix) =>
    {
        Manna.LeftMultiplyTransformByMatrix(_gameObject1.transform, matrix);
        Manna.LeftMultiplyTransformByMatrix(_gameObject2.transform, matrix);
    }
}

LeftMultiplyTransformByMatrix is overloaded to directly accept GameObjects for its first argument, as well.

Note that in the above example, any possible children of _gameObject1 or _gameObject2 need not have their transforms left-multiplied by matrix since the transform has already been applied at the parent level. (Indeed, applications may wish to group all of their visible assets inside of a single subtree of the scene, such as to apply Manna.LeftMultiplyTransformByMatrix(..., matrix); only once, at the root of that subtree. See also the next note, however.)

Note that there is a window of time between when ConjureKit. Children of ARSessionOrigin should not be left-multiplied, either.

Public Functions Documentation​

function Manna​

Manna(
    IConjureKit conjureKit,
    float distanceToSizeRatio =10f
)

Constructor - initializes and registers Manna as a ConjureKit module.

Parameters:

  • conjureKit ConjureKit instance
  • distanceToSizeRatio (internal) optional max calibration distance to QR code size ratio

function SetOnBeforeCalibration​

void SetOnBeforeCalibration(
    Action< Lighthouse, Action< bool >> onBeforeCalibration
)

Set a callback that is called after a calibration frame has been decided and allows for the developer to do some logic before the calibration and decide if it should continue. If the action is called with true, the calibration will continue, else it will not.

Parameters:

  • onBeforeCalibration Callback to invoke with true (calibrate) or false (don't calibrate)

function SetStaticLighthousePoseSelector​

void SetStaticLighthousePoseSelector(
    Action< LighthousePose[], Action< LighthousePose >> poseSelector
)

Set a callback that is called when a static lighthouse has been scanned. The callback should invoke the provided Action with a chosen LighthousePose from the array.

Parameters:

  • poseSelector Callback when a static lighthouse has been scanned

function SetLighthouseVisible​

void SetLighthouseVisible(
    bool visible
)

Display/hide the on-screen instant calibration QR code.

Parameters:

  • visible true to display the QR code, false to hide it

function LeftMultiplyTransformByMatrix​

static void LeftMultiplyTransformByMatrix(
    Transform transform,
    Matrix4x4 matrix
)

Utility function. See usage notes in the Manna class overview.

Parameters:

  • transform A Unity Transform object
  • matrix A Unity Matrix4x4 object

function LeftMultiplyTransformByMatrix​

static void LeftMultiplyTransformByMatrix(
    GameObject gameObject,
    Matrix4x4 matrix
)

Utility function. See usage notes in the Manna class overview.

Parameters:

  • gameObject A Unity GameObject
  • matrix A Unity Matrix4x4 object

Public Property Documentation​

property OnLighthouseTracked​

Action< Lighthouse, Pose, bool > OnLighthouseTracked;

Called when a lighthouse is being tracked even if its not close enough the boolean passed indicates weather its deemed to be close enough or not.

property OnCalibrationSuccess​

Action< Matrix4x4 > OnCalibrationSuccess;

This callback is called at the same frame that the pose of the ARSessionOrigin is adjusted to accommodate for joining a pre-existing session via QR code calibration. See the detailed usage notes above in the Manna class overview.

Return: Unity Matrix4x4 specifying the change of coordinates from old to new world coordinates

property OnCalibrationFailed​

Action< Lighthouse > OnCalibrationFailed;

Called if calibration fails at the image tracker level. (Lost lighthouse.)