Class IUsesMarsSceneEvaluationExtensionMethods
Extension methods for IUsesMarsSceneEvaluation interface
Namespace: Unity.MARS.Query
Syntax
public static class IUsesMarsSceneEvaluationExtensionMethodsMethods
GetEvaluationInterval(IUsesMarsSceneEvaluation)
Get the scene evaluation interval in seconds
Declaration
public static float GetEvaluationInterval(this IUsesMarsSceneEvaluation caller)Parameters
| Type | Name | Description |
|---|---|---|
| IUsesMarsSceneEvaluation | caller | The object that is making a request of the query scene |
Returns
| Type | Description |
|---|---|
| Single |
RequestSceneEvaluation(IUsesMarsSceneEvaluation, Action)
Request that the results of all active queries be recalculated.
Declaration
public static MarsSceneEvaluationRequestResponse RequestSceneEvaluation(this IUsesMarsSceneEvaluation caller, Action onEvaluationComplete = null)Parameters
| Type | Name | Description |
|---|---|---|
| IUsesMarsSceneEvaluation | caller | The object that is making a request of the query scene |
| Action | onEvaluationComplete | A callback executed when the evaluation triggered by the request has completed |
Returns
| Type | Description |
|---|---|
| MarsSceneEvaluationRequestResponse | An enum describing the system response to the request |
SetEvaluationInterval(IUsesMarsSceneEvaluation, Single)
Set the scene evaluation interval. Will still set the interval even if not using Interval mode, but not change the mode.
Declaration
public static void SetEvaluationInterval(this IUsesMarsSceneEvaluation caller, float interval)Parameters
| Type | Name | Description |
|---|---|---|
| IUsesMarsSceneEvaluation | caller | The object that is making a request of the query scene |
| Single | interval | The evaluation interval in seconds |
SetEvaluationMode(IUsesMarsSceneEvaluation, MarsSceneEvaluationMode)
Set the scheduling mode for evaluating the MARS scene. Changing the mode to EvaluateOnInterval will queue an evaluation.
Declaration
public static void SetEvaluationMode(this IUsesMarsSceneEvaluation caller, MarsSceneEvaluationMode mode)Parameters
| Type | Name | Description |
|---|---|---|
| IUsesMarsSceneEvaluation | caller | The object that is making a request of the query scene |
| MarsSceneEvaluationMode | mode | The mode to set |