Skip to main content

Auki::Manna::Manna

Functionalities of the Manna module are enabled by instantiating the Manna class while providing the constructor with the application's instance of ConjureKit. More...

Inherits from AukiModule

Public Functions​

Name
Manna(IConjureKit conjureKit, Vikja.Vikja vikja, Func< LighthousePose[], LighthousePose > staticLighthousePoseSelector =null, float distanceToSizeRatio =10f, Action< Lighthouse, Pose, bool > onLighthouseTracked =null)
Constructor - initializes and registers Manna as a ConjureKit module.
voidSetLighthouseVisible(bool visible)
Display/hide the on-screen instant calibration QRcode.

Detailed Description​

class Auki::Manna::Manna;

Functionalities of the Manna module are enabled by instantiating the Manna class while providing the constructor with the application's instance of ConjureKit.

Applications can decide via their own UI logic when to hide or show the calibrating QRcode using the SetLighthouseVisible method of the Manna class. The on-screen position and appearance of the QRcode is not adjustable in this release of the Manna module.

When a participant running an application with the same app_key scans a QRcode displayed by Manna that participant is automatically taken out of their current session and brought into the session of the participant displaying the QRcode. The spatial calibration of a joining participant is automatically handled. Other application-specific logic related to session leaving and session joining should be handled by ConjureKit's .OnLeft and .OnJoined callbacks, respectively.

Also note that the ConjureKit.OnLeft and ConjureKit.OnJoined callbacks can be used to handle generic application-specific logic related to session-leaving and session-joining. the ConjureKit.OnLeft and ConjureKit.OnJoined callbacks, respectively.

Public Functions Documentation​

function Manna​

Manna(
    IConjureKit conjureKit,
    Vikja.Vikja vikja,
    Func< LighthousePose[], LighthousePose > staticLighthousePoseSelector =null,
    float distanceToSizeRatio =10f,
    Action< Lighthouse, Pose, bool > onLighthouseTracked =null
)

Constructor - initializes and registers Manna as a ConjureKit module.

Parameters:

  • conjureKit ConjureKit instance
  • vikja Vikja instance
  • staticLighthousePoseSelector (internal) optional pose selector function
  • distanceToSizeRatio (internal) optional max calibration distance to QRcode size ratio
  • onLighthouseTracked (internal) optional callback when a QRcode is tracked

function SetLighthouseVisible​

void SetLighthouseVisible(
    bool visible
)

Display/hide the on-screen instant calibration QRcode.

Parameters:

  • visible true to display the QRcode, false to hide it