Class ScenarioBase
Derive ScenarioBase to implement a custom scenario
Inherited Members
Namespace: UnityEngine.Experimental.Perception.Randomization.Scenarios
Assembly: solution.dll
Syntax
[DefaultExecutionOrder(-1)]
public abstract class ScenarioBase : MonoBehaviour
Fields
| Name | Description |
|---|---|
| quitOnComplete | If true, this scenario will quit the Unity application when it's finished executing |
| serializedConstantsFileName | The name of the Json file this scenario's constants are serialized to/from. |
Properties
| Name | Description |
|---|---|
| activeScenario | Returns the active parameter scenario in the scene |
| currentIteration | The current iteration index of the scenario |
| currentIterationFrame | The number of frames that have elapsed since the current scenario iteration was Setup |
| framesSinceInitialization | The number of frames that have elapsed since the scenario was initialized |
| genericConstants | Returns this scenario's non-typed serialized constants |
| isIterationComplete | Returns whether the current scenario iteration has completed |
| isScenarioComplete | Returns whether the entire scenario has completed |
| randomizers | Return the list of randomizers attached to this scenario |
| serializedConstantsFilePath | Returns the file location of the JSON serialized constants |
| tagManager | The RandomizerTagManager attached to this scenario |
Methods
| Name | Description |
|---|---|
| CreateRandomizer<T>() | Creates a new randomizer and adds it to this scenario |
| Deserialize() | Deserializes constants saved in a JSON file located at serializedConstantsFilePath |
| GenerateRandomSeed(uint) | Generates a random seed by hashing the current scenario iteration with a given base random seed |
| GenerateRandomSeedFromIndex(int, uint) | Generates a random seed by hashing three values together: an arbitrary index value, the current scenario iteration, and a base random seed. This method is useful for deterministically generating random seeds from within a for-loop. |
| GetRandomizerIndex<T>() | Returns the execution order index of a randomizer of the given type |
| GetRandomizer<T>() | Finds and returns a randomizer attached to this scenario of the specified Randomizer type |
| IncrementIteration() | Progresses the current scenario iteration |
| OnAwake() | This method executed directly after this scenario has been registered and initialized |
| RemoveRandomizer<T>() | Removes a randomizer of the specified type from this scenario |
| ReorderRandomizer(int, int) | Moves a randomizer from one index to another |
| Serialize() | Serializes the scenario's constants to a JSON file located at serializedConstantsFilePath |