docs.unity3d.com
    Show / Hide Table of Contents

    Class Labeling

    Defines a set of labels associated with the object and its descendants. A Labeling component will override any Labeling components on the object's ancestors.

    Inheritance
    Object
    Labeling
    Namespace: UnityEngine.Perception.GroundTruth
    Syntax
    public class Labeling : MonoBehaviour

    Fields

    autoLabelingSchemeType

    The specific subtype of AssetLabelingScheme that this component is using, if useAutoLabeling is enabled.

    Declaration
    public string autoLabelingSchemeType
    Field Value
    Type Description
    String

    labels

    The label names to associate with the GameObject. Modifications to this list after the Update() step of the frame the object is created in are not guaranteed to be reflected by labelers.

    Declaration
    public List<string> labels
    Field Value
    Type Description
    List<String>

    useAutoLabeling

    Whether this labeling component is currently using an automatic labeling scheme. When this is enabled, the asset can have only one label (the automatic one) and the user cannot add more labels.

    Declaration
    public bool useAutoLabeling
    Field Value
    Type Description
    Boolean

    Properties

    instanceId

    The unique id of this labeling component instance

    Declaration
    public uint instanceId { get; }
    Property Value
    Type Description
    UInt32

    Methods

    RefreshLabeling()

    Refresh ground truth generation for the labeling of the attached GameObject. This is necessary when the list of labels changes or when renderers or materials change on objects in the hierarchy.

    Declaration
    public void RefreshLabeling()
    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