Skip to main content
Version: 3.0

interface ISharedSpaceTrackingOptions

(Niantic.Lightship.SharedAR.Colocalization.ISharedSpaceTrackingOptions)

Overview​

Tracking settings to use in Shared Space

interface ISharedSpaceTrackingOptions {
		// methods
	
		static ISharedSpaceTrackingOptions CreateVpsTrackingOptions(string payload);
		static ISharedSpaceTrackingOptions CreateVpsTrackingOptions(ARLocation location);
	
		static ISharedSpaceTrackingOptions CreateImageTrackingOptions(
			Texture2D targetImage,
			float widthInMeters
		);
	
		static ISharedSpaceTrackingOptions CreateMockTrackingOptions();
	};

Detailed Documentation​

Tracking settings to use in Shared Space

Methods​

CreateVpsTrackingOptions​

static ISharedSpaceTrackingOptions CreateVpsTrackingOptions(string payload)

Vps tracking settings with Wayspot anchor payload string

    Parameters:

    payload - Wayspot anchor payload

    Returns:

    ISharedSpaceTrackingOptions object using VPS

CreateVpsTrackingOptions​

static ISharedSpaceTrackingOptions CreateVpsTrackingOptions(ARLocation location)

Vps tracking settings with ARLocation

    Parameters:

    location - The target ARLocation object to track

    Returns:

    ISharedSpaceTrackingOptions object using VPS

CreateImageTrackingOptions​

static ISharedSpaceTrackingOptions CreateImageTrackingOptions(
		Texture2D targetImage,
		float widthInMeters
	)

Image tracking settings

    Parameters:

    targetImage - Target image to track as Texture2D

    widthInMeters - Physical width of the target image in meters

    Returns:

    ISharedSpaceTrackingOptions object using image tracking

CreateMockTrackingOptions​

static ISharedSpaceTrackingOptions CreateMockTrackingOptions()

Use mock tracking, which the tracking event happens immediately when calling StartSharedSpace()

    Returns:

    ISharedSpaceTrackingOptions object with mock tracking