Skip to main content
Version: 3.5

struct ARSemanticSegmentationModelEventArgs

(Niantic.Lightship.AR.Semantics.ARSemanticSegmentationModelEventArgs)

Overview​

A structure for information about the semantic segmentation model that's become ready. This is used to communicate information in the ARSemanticSegmentationManager.MetadataInitialized event.

	struct ARSemanticSegmentationModelEventArgs: IEquatable< ARSemanticSegmentationModelEventArgs > {
		// properties
	
		IReadOnlyList<string> ChannelNames;
		IReadOnlyDictionary<string, int> ChannelIndices;

		// methods
	
		override int GetHashCode();
		override bool Equals(object obj);
		bool Equals(ARSemanticSegmentationModelEventArgs other);
	
		static bool operator == (
			ARSemanticSegmentationModelEventArgs lhs,
			ARSemanticSegmentationModelEventArgs rhs
		);
	
		static bool operator != (
			ARSemanticSegmentationModelEventArgs lhs,
			ARSemanticSegmentationModelEventArgs rhs
		);
	};

Detailed Documentation​

A structure for information about the semantic segmentation model that's become ready. This is used to communicate information in the ARSemanticSegmentationManager.MetadataInitialized event.

Properties​

ChannelNames​

IReadOnlyList<string> ChannelNames

The semantic channels detected by the semantic segmentation model.

ChannelIndices​

IReadOnlyDictionary<string, int> ChannelIndices

The indices of the semantic channels detected by the semantic segmentation model.

Methods​

GetHashCode​

override int GetHashCode()

Generates a hash suitable for use with containers like HashSet and Dictionary.

    Returns:

    A hash code generated from this object's fields.

Equals​

override bool Equals(object obj)

Tests for equality.

    Parameters:

    obj - The object to compare against.

    Returns:

    True if obj is of type ARSemanticSegmentationModelEventArgs and Equals(ARSemanticSegmentationModelEventArgs) also returns true; otherwise false.

Equals​

bool Equals(ARSemanticSegmentationModelEventArgs other)

Tests for equality.

    Parameters:

    other - The other ARSemanticSegmentationModelEventArgs to compare against.

    Returns:

    True if every field in other is equal to this ARSemanticSegmentationModelEventArgs, otherwise false.

operator==​

static bool operator == (
		ARSemanticSegmentationModelEventArgs lhs,
		ARSemanticSegmentationModelEventArgs rhs
	)

Tests for equality. Same as Equals(ARSemanticSegmentationModelEventArgs).

    Parameters:

    lhs - The left-hand side of the comparison.

    rhs - The right-hand side of the comparison.

    Returns:

    True if lhs is equal to rhs, otherwise false.

operator!=​

static bool operator != (
		ARSemanticSegmentationModelEventArgs lhs,
		ARSemanticSegmentationModelEventArgs rhs
	)

Tests for inequality. Same as ! Equals(ARSemanticSegmentationModelEventArgs).

    Parameters:

    lhs - The left-hand side of the comparison.

    rhs - The right-hand side of the comparison.

    Returns:

    True if lhs is not equal to rhs, otherwise false.