docs.unity3d.com
    Show / Hide Table of Contents

    Class PerceptionScenario<T>

    Derive this class to configure perception data capture while coordinating a scenario

    Inheritance
    Object
    ScenarioBase
    Scenario<T>
    PerceptionScenario<T>
    FixedLengthScenario
    Inherited Members
    Scenario<T>.constants
    Scenario<T>.genericConstants
    ScenarioBase.activeScenario
    ScenarioBase.state
    ScenarioBase.configuration
    ScenarioBase.activeRandomizers
    ScenarioBase.randomizers
    ScenarioBase.currentIterationFrame
    ScenarioBase.framesSinceInitialization
    ScenarioBase.currentIteration
    ScenarioBase.isIterationComplete
    ScenarioBase.isScenarioComplete
    ScenarioBase.IncrementIteration()
    ScenarioBase.SerializeToJson()
    ScenarioBase.SerializeToFile(String)
    ScenarioBase.LoadConfigurationFromFile(String)
    ScenarioBase.LoadConfigurationFromCommandLine(String)
    ScenarioBase.LoadConfigurationAsset()
    ScenarioBase.DeserializeConfiguration()
    ScenarioBase.ResetRandomStateOnIteration()
    ScenarioBase.OnAwake()
    ScenarioBase.OnIterationEnd()
    ScenarioBase.OnUpdate()
    ScenarioBase.OnIdle()
    ScenarioBase.Restart()
    ScenarioBase.Quit()
    ScenarioBase.OnEnable()
    ScenarioBase.OnDisable()
    ScenarioBase.AddRandomizer(Randomizer)
    ScenarioBase.InsertRandomizer(Int32, Randomizer)
    ScenarioBase.RemoveRandomizerAt(Int32)
    ScenarioBase.GetRandomizer(Int32)
    ScenarioBase.GetRandomizer<T>()
    ScenarioBase.RestartIteration()
    ScenarioBase.DelayIteration()
    Namespace: UnityEngine.Perception.Randomization.Scenarios
    Syntax
    public abstract class PerceptionScenario<T> : Scenario<T> where T : ScenarioConstants, new()
    Type Parameters
    Name Description
    T

    The type of scenario constants to serialize

    Properties

    isScenarioReadyToStart

    The scenario will begin on the frame this property first returns true

    Declaration
    protected override bool isScenarioReadyToStart { get; }
    Property Value
    Type Description
    Boolean

    Whether the scenario should start this frame

    Overrides
    ScenarioBase.isScenarioReadyToStart

    Methods

    OnComplete()

    OnComplete is called when this scenario's isScenarioComplete property returns true during its main update loop

    Declaration
    protected override void OnComplete()
    Overrides
    ScenarioBase.OnComplete()

    OnIterationStart()

    OnIterationStart is called before a new iteration begins

    Declaration
    protected override void OnIterationStart()
    Overrides
    ScenarioBase.OnIterationStart()

    OnStart()

    OnStart is called when the scenario first begins playing

    Declaration
    protected override void OnStart()
    Overrides
    ScenarioBase.OnStart()
    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