Skip to main content

struct ARObjectDetectionModelEventArgs

(Niantic.Lightship.AR.ObjectDetection.ARObjectDetectionModelEventArgs)

Overview​

A structure for information about the object detection model that's become ready. This is used to communicate information in the ARObjectDetectionManager.MetadataInitialized event.

    struct ARObjectDetectionModelEventArgs: IEquatable< ARObjectDetectionModelEventArgs > {
        // properties
    
        IReadOnlyList<string> CategoryNames;

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

Detailed Documentation​

A structure for information about the object detection model that's become ready. This is used to communicate information in the ARObjectDetectionManager.MetadataInitialized event.

This is an experimental API. Experimental features are subject to breaking changes, not officially supported, and may be deprecated without notice.

Properties​

CategoryNames​

IReadOnlyList<string> CategoryNames

The names of all the categories that the currently active object detection model is able to detect.

This is an experimental API. Experimental features are subject to breaking changes, not officially supported, and may be deprecated without notice.

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 ARObjectDetectionModelEventArgs and Equals(ARObjectDetectionModelEventArgs) also returns true; otherwise false.

Equals​

bool Equals(ARObjectDetectionModelEventArgs other)

Tests for equality.

    Parameters:

    other - The other ARObjectDetectionModelEventArgs to compare against.

    Returns:

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

operator==​

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

Tests for equality. Same as Equals(ARObjectDetectionModelEventArgs).

    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 != (
        ARObjectDetectionModelEventArgs lhs,
        ARObjectDetectionModelEventArgs rhs
    )

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

    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.