Class SimulationEnvironmentModeSettings
Base class for how an environment is loaded and displayed in MARS with the MARSEnvironmentManager
Inherited Members
Namespace: UnityEditor.MARS.Simulation
Assembly: Unity.MARS.Editor.dll
Syntax
[MovedFrom("Unity.MARS.Simulation")]
public abstract class SimulationEnvironmentModeSettings : ScriptableObject
Fields
NoEnvironmentSwitchingContents
GUI contents to as EnvironmentSwitchingContents
when environment switching is not supported
Declaration
public static readonly GUIContent[] NoEnvironmentSwitchingContents
Field Value
Type | Description |
---|---|
GUIContent[] |
Properties
ActiveEnvironmentIndex
The index of the active environment, this is also the index of the environment in EnvironmentSwitchingContents
Declaration
public abstract int ActiveEnvironmentIndex { get; }
Property Value
Type | Description |
---|---|
int |
DefaultSimulationMode
Default simulation mode preference when switching to this mode settings
Declaration
public abstract SimulationModeSelection DefaultSimulationMode { get; }
Property Value
Type | Description |
---|---|
SimulationModeSelection |
EnvironmentModeName
Name of the environment Mode
Declaration
public abstract string EnvironmentModeName { get; }
Property Value
Type | Description |
---|---|
string |
EnvironmentSwitchingContents
List of all the environments available in this mode
Declaration
public abstract GUIContent[] EnvironmentSwitchingContents { get; }
Property Value
Type | Description |
---|---|
GUIContent[] |
HasEnvironmentSwitching
Is there environment switching in this mode
Declaration
public abstract bool HasEnvironmentSwitching { get; }
Property Value
Type | Description |
---|---|
bool |
IsFramingEnabled
Is framing enabled in this mode from the simulation view
Declaration
public abstract bool IsFramingEnabled { get; }
Property Value
Type | Description |
---|---|
bool |
IsMovementEnabled
Is movement enabled in this mode from the device view
Declaration
public abstract bool IsMovementEnabled { get; }
Property Value
Type | Description |
---|---|
bool |
Methods
FindEnvironmentCandidates()
Used to generate an array of environments for environment switching
Declaration
public abstract void FindEnvironmentCandidates()
OpenSimulationEnvironment()
Used to open a simulation environment in this mode
Declaration
public abstract void OpenSimulationEnvironment()
SetActiveEnvironment(int)
Set the active environment to an index
Declaration
public abstract void SetActiveEnvironment(int index)
Parameters
Type | Name | Description |
---|---|---|
int | index |