Class PublisherASA

Implementation of IPublisher using ASA to push anchors to and retrieve them from the cloud.

Inheritance
Object
PublisherASA
Implements
Namespace: Microsoft.MixedReality.WorldLocking.ASA
Assembly: cs.temp.dll.dll
Syntax
public class PublisherASA : MonoBehaviour, IPublisher
Remarks

PublisherASA is a Monobehaviour to allow exposing properties in the inspector.

Properties

AnchorsParent

Transform to attach created anchors to. Should have identity global pose.

Declaration
public Transform AnchorsParent { get; set; }
Property Value
Type Description
Transform

AnchorsPrefab

Object to instantiate wherever native anchors are created to visualize their placement.

Declaration
public GameObject AnchorsPrefab { get; set; }
Property Value
Type Description
GameObject
Remarks

These are intended for debugging and development.

BeaconUuids

Beacon ids to use in coarse reloctaion.

Declaration
public List<string> BeaconUuids { get; }
Property Value
Type Description
List<String>

CoarseRelocationEnabled

Enable coarse relocation.

Declaration
public bool CoarseRelocationEnabled { get; set; }
Property Value
Type Description
Boolean
Remarks

This must be set before calling Setup to have any effect.

CoarseRelocPublishEnabled

Whether relocation data will be included in published cloud anchors.

Declaration
public bool CoarseRelocPublishEnabled { get; set; }
Property Value
Type Description
Boolean
Remarks

With this enabled, extra initialization will be done, and the readiness state will be less reliable. If cloud anchor ids will be explicitly shared via file or network communications, this should be disabled.

CoarseRelocUseBluetooth

Whether use of bluetooth beacons is to be used in coarse relocation.

Declaration
public bool CoarseRelocUseBluetooth { get; }
Property Value
Type Description
Boolean
Remarks

To enable use of bluetooth beacons, add some beacon uuids to BeaconUuids.

CoarseRelocUseGPS

Augment cloud anchors with GPS data to allow them to be found via course relocation.

Declaration
public bool CoarseRelocUseGPS { get; set; }
Property Value
Type Description
Boolean

CoarseRelocUseWifi

Augment cloud anchors with wifi data to allow them to be found via course relocation.

Declaration
public bool CoarseRelocUseWifi { get; set; }
Property Value
Type Description
Boolean

MaxSearchSeconds

Maximum number of seconds to search without finding any anchors before giving up.

Declaration
public float MaxSearchSeconds { get; set; }
Property Value
Type Description
Single

MaxWaitForMoreAnchorsSeconds

Max number seconds to wait for more anchors, after having found some.

Declaration
public float MaxWaitForMoreAnchorsSeconds { get; set; }
Property Value
Type Description
Single

MinRecommendedForCreateProgress

The minimum value of the recommended-for-create-progress float before allowing creation of cloud anchors.

Declaration
public float MinRecommendedForCreateProgress { get; set; }
Property Value
Type Description
Single

Status

Declaration
public ReadinessStatus Status { get; }
Property Value
Type Description
ReadinessStatus

Methods

Create(LocalPegAndProperties)

Declaration
public async Task<string> Create(LocalPegAndProperties pegAndProps)
Parameters
Type Name Description
LocalPegAndProperties pegAndProps
Returns
Type Description
Task<String>

CreateLocalPeg(String, Pose)

Declaration
public async Task<ILocalPeg> CreateLocalPeg(string id, Pose lockedPose)
Parameters
Type Name Description
String id
Pose lockedPose
Returns
Type Description
Task<ILocalPeg>

Delete(String)

Declaration
public async Task Delete(string cloudAnchorId)
Parameters
Type Name Description
String cloudAnchorId
Returns
Type Description
Task

Find(Single)

Declaration
public async Task<Dictionary<string, LocalPegAndProperties>> Find(float radiusFromDevice)
Parameters
Type Name Description
Single radiusFromDevice
Returns
Type Description
Task<Dictionary<String, LocalPegAndProperties>>

Modify(String, LocalPegAndProperties)

Declaration
public async Task<string> Modify(string cloudAnchorId, LocalPegAndProperties peg)
Parameters
Type Name Description
String cloudAnchorId
LocalPegAndProperties peg
Returns
Type Description
Task<String>

PurgeArea(Single)

Declaration
public async Task PurgeArea(float radius)
Parameters
Type Name Description
Single radius
Returns
Type Description
Task

Read(IReadOnlyCollection<String>)

Declaration
public async Task<Dictionary<string, LocalPegAndProperties>> Read(IReadOnlyCollection<string> cloudAnchorIds)
Parameters
Type Name Description
IReadOnlyCollection<String> cloudAnchorIds
Returns
Type Description
Task<Dictionary<String, LocalPegAndProperties>>

Read(String)

Declaration
public async Task<LocalPegAndProperties> Read(string cloudAnchorId)
Parameters
Type Name Description
String cloudAnchorId
Returns
Type Description
Task<LocalPegAndProperties>

ReleaseLocalPeg(ILocalPeg)

Declaration
public void ReleaseLocalPeg(ILocalPeg peg)
Parameters
Type Name Description
ILocalPeg peg

Setup()

Initialization.

Declaration
public async void Setup()
Remarks

Note that this is asynchronous. Status.readiness will be Readiness.Ready when setup is complete.

Implements