Class MarsRuntimeUtils
Utility methods for the MARS Runtime
Namespace: Unity.MARS.MARSUtils
Syntax
[MovedFrom("Unity.MARS")]
public static class MarsRuntimeUtilsMethods
GetActiveCamera(Boolean)
If simulating in edit mode, returns the simulated camera else returns the camera associated to the MarsSession through the MarsCamera camera reference.
Declaration
public static Camera GetActiveCamera(bool findFallbackCamera = false)Parameters
| Type | Name | Description |
|---|---|---|
| Boolean | findFallbackCamera | If the active session camera is null, then it will try and return the main camera and if that is null will find a Camera object. |
Returns
| Type | Description |
|---|---|
| Camera | The active mars camera. |
GetMarsSessionInActiveScene()
Returns the first MarsSession found in the active scene
Declaration
public static MARSSession GetMarsSessionInActiveScene()Returns
| Type | Description |
|---|---|
| MARSSession | The first MarsSession found in the active scene, or null if none exists |
GetMarsSessionInScene(Scene)
Returns the first MarsSession found in the given scene
Declaration
public static MARSSession GetMarsSessionInScene(Scene scene)Parameters
| Type | Name | Description |
|---|---|---|
| Scene | scene | The scene to search |
Returns
| Type | Description |
|---|---|
| MARSSession | The first MarsSession found in the given scene, or null if none exists |
GetSessionAssociatedCamera(Boolean)
Returns the camera associated to the MARS Session through the MarsCamera camera reference.
Declaration
public static Camera GetSessionAssociatedCamera(bool findFallbackCamera = false)Parameters
| Type | Name | Description |
|---|---|---|
| Boolean | findFallbackCamera | If the active session camera is null, then it will try and return the main camera and if that is null will find a Camera object. |
Returns
| Type | Description |
|---|---|
| Camera | The camera associated with the MARS Session |
HasMarsBehaviors(Scene)
Checks if the given scene contains any MARS behaviors
Declaration
public static bool HasMarsBehaviors(Scene scene)Parameters
| Type | Name | Description |
|---|---|---|
| Scene | scene | The scene to check |
Returns
| Type | Description |
|---|---|
| Boolean | True if the scene has any MARS behaviors, false otherwise |