docs.unity3d.com
    Show / Hide Table of Contents

    Class UnitySimulationScenario<T>

    A scenario must derive from this class to be compatible with the Run in Unity Simulation window. The iterations of this scenario will be executed in parallel across a user specified number of worker instances when run in Unity Simulation.

    Inheritance
    Object
    ScenarioBase
    Scenario<T>
    PerceptionScenario<T>
    UnitySimulationScenario<T>
    FixedLengthScenario
    Inherited Members
    PerceptionScenario<T>.isScenarioReadyToStart
    PerceptionScenario<T>.OnAwake()
    PerceptionScenario<T>.OnStart()
    PerceptionScenario<T>.OnIterationStart()
    PerceptionScenario<T>.OnComplete()
    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.SerializeToJson()
    ScenarioBase.SerializeToFile(String)
    ScenarioBase.LoadConfigurationFromFile(String)
    ScenarioBase.LoadConfigurationFromCommandLine(String)
    ScenarioBase.ResetRandomStateOnIteration()
    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 UnitySimulationScenario<T> : PerceptionScenario<T> where T : UnitySimulationScenarioConstants, new()
    Type Parameters
    Name Description
    T

    The type of scenario constants to serialize

    Properties

    isScenarioComplete

    Returns whether the scenario has completed

    Declaration
    protected override sealed bool isScenarioComplete { get; }
    Property Value
    Type Description
    Boolean
    Overrides
    ScenarioBase.isScenarioComplete

    Methods

    DeserializeConfiguration()

    Overwrites this scenario's randomizer settings and scenario constants from a JSON serialized configuration

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

    IncrementIteration()

    This method selects what the next iteration index will be. By default, the scenario will simply progress to the next iteration, but this behaviour can be overriden.

    Declaration
    protected override sealed void IncrementIteration()
    Overrides
    ScenarioBase.IncrementIteration()

    LoadConfigurationAsset()

    Loads and stores a JSON scenario settings configuration file before the scenario starts

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