docs.unity3d.com
    Show / Hide Table of Contents

    Class NoOutputEndpoint

    Inheritance
    Object
    NoOutputEndpoint
    Namespace: UnityEngine.Perception.GroundTruth.Consumers
    Syntax
    public class NoOutputEndpoint : object, IConsumerEndpoint, ICloneable

    Properties

    description

    The human readable description of the endpoint

    Declaration
    public string description { get; }
    Property Value
    Type Description
    String
    Implements
    IConsumerEndpoint.description

    Methods

    AnnotationRegistered(AnnotationDefinition)

    Called when an annotation is registered with the perception engine.

    Declaration
    public void AnnotationRegistered(AnnotationDefinition annotationDefinition)
    Parameters
    Type Name Description
    AnnotationDefinition annotationDefinition

    The registered annotation definition

    Implements
    IConsumerEndpoint.AnnotationRegistered(AnnotationDefinition)

    Clone()

    Declaration
    public object Clone()
    Returns
    Type Description
    Object

    FrameGenerated(Frame)

    Called at the end of each frame. Contains all of the generated data for the frame. This method is called after the frame has entirely finished processing.

    Declaration
    public void FrameGenerated(Frame frame)
    Parameters
    Type Name Description
    Frame frame

    The frame data.

    Implements
    IConsumerEndpoint.FrameGenerated(Frame)

    MetricRegistered(MetricDefinition)

    Called when a metric is registered with the perception engine.

    Declaration
    public void MetricRegistered(MetricDefinition metricDefinition)
    Parameters
    Type Name Description
    MetricDefinition metricDefinition

    The registered metric definition

    Implements
    IConsumerEndpoint.MetricRegistered(MetricDefinition)

    SensorRegistered(SensorDefinition)

    Called when a sensor is registered with the perception engine.

    Declaration
    public void SensorRegistered(SensorDefinition sensor)
    Parameters
    Type Name Description
    SensorDefinition sensor

    The registered sensor definition

    Implements
    IConsumerEndpoint.SensorRegistered(SensorDefinition)

    SimulationCompleted(SimulationMetadata)

    Called at the end of the simulation. Contains metadata describing the entire simulation process.

    Declaration
    public void SimulationCompleted(SimulationMetadata metadata)
    Parameters
    Type Name Description
    SimulationMetadata metadata

    Metadata describing the entire simulation process

    Implements
    IConsumerEndpoint.SimulationCompleted(SimulationMetadata)

    SimulationStarted(SimulationMetadata)

    Called when the simulation begins. Provides simulation wide metadata to the consumer.

    Declaration
    public void SimulationStarted(SimulationMetadata metadata)
    Parameters
    Type Name Description
    SimulationMetadata metadata

    Metadata describing the active simulation

    Implements
    IConsumerEndpoint.SimulationStarted(SimulationMetadata)
    Back to top
    Terms of use
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023