Auki::ConjureKit::Manna::Lighthouse

Represents a Lighthouse - object recognized through computer vision that can be used to calculate a relative Pose.

Public Types

	Name
enum class	LighthouseType { Static = 1, Dynamic = 2} Lighthouse enumerated type.

Public Functions

	Name
	Lighthouse(string sessionId, uint participantId) Constructor for dynamic Lighthouses.
	Lighthouse(string staticLighthouseId) Constructor for static Lighthouses.
void	Dispose() Frees up allocated resources.
bool	HasPoseData() Checks if this lighthouse has pose data associated with it.
void	Update() Manually refreshes the lighthouse state and texture.
bool	IsDifferent(Lighthouse lighthouse, string content) Use to compare a Lighthouse with a given content string.
bool	IsDifferent(Lighthouse lighthouse, string sessionId, UInt32 participantId) Use to compare a Lighthouse with given Session and Participant ids.
bool	IsQRCodeValid(string qrData) Checks if a given QR code is a valid Lighthouse.
Lighthouse	FromQRData(string qrData, float physicalSize =0.0254f) Creates a Lighthouse from a QR code string.

Public Properties

	Name
Texture2D	Texture Texture containing the generated QR code for the Lighthouse.
string	Id Gets Lighthouse id.

Public Attributes

	Name
readonly LighthouseType	Type Lighthouse type.
readonly string	StaticId Static Lighthouse id.
readonly string	SessionId Session id (for dynamic Lighthouses).
readonly uint	ParticipantId Participant id (for dynamic Lighthouses).
float	PhysicalSize Physical size of the Lighthouse (in meters).

Public Types Documentation

enum LighthouseType

Enumerator	Value	Description
Static	1	Static Lighthouse type - bearing a fixed spatial relationship to its environment.
Dynamic	2	Dynamic Lighthouse type - displayed on a handheld or a moving device screen.

Lighthouse enumerated type.

Public Functions Documentation

function Lighthouse

Lighthouse(
    string sessionId,
    uint participantId
)

Constructor for dynamic Lighthouses.

Parameters:

• sessionId Session id
• participantId Participant id

function Lighthouse

Lighthouse(
    string staticLighthouseId
)

Constructor for static Lighthouses.

Parameters:

• staticLighthouseId Id

function Dispose

void Dispose()

Frees up allocated resources.

function HasPoseData

bool HasPoseData()

Checks if this lighthouse has pose data associated with it.

Return: True if it has pose data.

function Update

void Update()

Manually refreshes the lighthouse state and texture.

function IsDifferent

static bool IsDifferent(
    Lighthouse lighthouse,
    string content
)

Use to compare a Lighthouse with a given content string.

Parameters:

• lighthouse Lighthouse we want to compare
• content Content string we want to compare

Return: true if different, false if equal

function IsDifferent

static bool IsDifferent(
    Lighthouse lighthouse,
    string sessionId,
    UInt32 participantId
)

Use to compare a Lighthouse with given Session and Participant ids.

Parameters:

• lighthouse Lighthouse we want to compare
• sessionId Session id
• participantId Participant id

Return: true if different, false if equal

function IsQRCodeValid

static bool IsQRCodeValid(
    string qrData
)

Checks if a given QR code is a valid Lighthouse.

Parameters:

• qrData QR string that is going to be verified

Return: true if valid, false if invalid

function FromQRData

static Lighthouse FromQRData(
    string qrData,
    float physicalSize =0.0254f
)

Creates a Lighthouse from a QR code string.

Parameters:

• qrData QR code string
• physicalSize Physical size of Lighthouse (in meters)

Return: A Lighthouse object created from given data

Public Property Documentation

property Texture

Texture2D Texture;

Texture containing the generated QR code for the Lighthouse.

property Id

string Id;

Gets Lighthouse id.

Public Attributes Documentation

variable Type

readonly LighthouseType Type;

Lighthouse type.

variable StaticId

readonly string StaticId;

Static Lighthouse id.

variable SessionId

readonly string SessionId;

Session id (for dynamic Lighthouses).

variable ParticipantId

readonly uint ParticipantId;

Participant id (for dynamic Lighthouses).

variable PhysicalSize

float PhysicalSize;

Physical size of the Lighthouse (in meters).