docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class KeyPointLabeler

    Produces keypoint annotations for a humanoid model. This labeler supports generic KeyPointTemplate. Template values are mapped to rigged Animator Avatar. Custom joints can be created by applying JointLabel to empty game objects at a body part's location.

    Inheritance
    object
    CameraLabeler
    KeyPointLabeler
    Inherited Members
    CameraLabeler.enabled
    CameraLabeler.hudPanel
    CameraLabeler.overlayPanel
    object.ToString()
    object.Equals(object)
    object.Equals(object, object)
    object.ReferenceEquals(object, object)
    object.GetHashCode()
    object.GetType()
    Namespace: UnityEngine.Perception.GroundTruth
    Assembly: solution.dll
    Syntax
    [Serializable]
    public sealed class KeyPointLabeler : CameraLabeler

    Constructors

    Name Description
    KeyPointLabeler()

    Creates a new key point labeler. This constructor creates a labeler that is not valid until a IdLabelConfig and KeyPointTemplate are assigned.

    KeyPointLabeler(IdLabelConfig, KeyPointTemplate)

    Creates a new key point labeler.

    Fields

    Name Description
    activeTemplate

    The active keypoint template. Required to annotate keypoint data.

    animationPoseConfigs

    Array of animation pose labels which map animation clip times to ground truth pose labels.

    annotationId

    The GUID id to associate with the annotations produced by this labeler.

    idLabelConfig

    The IdLabelConfig which associates objects with labels.

    Properties

    Name Description
    description

    A human-readable description of the labeler

    supportsVisualization

    Labelers should set this in their setup to define if they support realtime visualization of their data.

    Methods

    Name Description
    OnBeginRendering()

    Called just before the camera renders each frame the the labeler is enabled and ShouldCaptureThisFrame is true.

    OnVisualize()

    Labeling pass to display labeler's visualization components, if applicable. Important note, all labeler's visualizations need to use Unity's Immediate Mode GUI (IMGUI) https://docs.unity3d.com/Manual/GUIScriptingGuide.html system. This called is triggered from perceptionCamera.OnGUI call. This call happens immediately before OnVisualizeAdditionalUI() so that the visualization components are drawn below the UI elements.

    Setup()

    Called just before the first call to OnUpdate() or OnBeginRendering(). Implement this to initialize state.

    Events

    Name Description
    KeyPointsComputed

    Action that gets triggered when a new frame of key points are computed.

    In This Article
    Back to top
    Copyright © 2024 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)