docs.unity3d.com
    Show / Hide Table of Contents

    Interface IDataProduced

    Interface for consuming data. Consumers must implement this, and return true from Initialize if the consumer is able/desired to operate.

    Namespace: Unity.Simulation
    Syntax
    public interface IDataProduced

    Methods

    Consume(Object, Boolean, Boolean)

    Called when data is availabl for consumption. All consumers are notified.

    Declaration
    void Consume(object data, bool synchronous = false, bool isArtifact = true)
    Parameters
    Type Name Description
    Object data

    Typically this is a string path to a file.

    Boolean synchronous

    When true, the comsumption completes before the call returns.

    Boolean isArtifact

    A flag indicating if the data being consumed is an artifact or not.

    ConsumptionStillInProgress()

    Called on Shutdown to ask the consumer if any asynchronous requests are still being handled.

    Declaration
    bool ConsumptionStillInProgress()
    Returns
    Type Description
    Boolean

    Initialize()

    Gives the consumer the opportunity to check if it can operate, and return status accordingly. Consumers that return false are not notified of data that is produced by the SDK.

    Declaration
    bool Initialize()
    Returns
    Type Description
    Boolean
    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