MRUK.RoomFilter | BuildOnSceneLoaded[Get] |
NavMeshCollectGeometry | CollectGeometry[Get] |
CollectObjects | CollectObjects[Get] |
float | AgentRadius[Get] |
float | AgentHeight[Get] |
float | AgentClimb[Get] |
float | AgentMaxSlope[Get] |
List< NavMeshAgent > | Agents[Get] |
MRUKAnchor.SceneLabels | NavigableSurfaces[Get] |
MRUKAnchor.SceneLabels | SceneObstacles[Get] |
LayerMask | Layers[Get] |
UnityEvent | OnNavMeshInitialized[Get] |
Dictionary< MRUKAnchor, GameObject > | Obstacles[Get] |
Dictionary< MRUKAnchor, GameObject > | Surfaces[Get] |
void | Toggles the use of global mesh for navigation. |
void | Creates a navigation mesh for the entire scene. |
void | BuildSceneNavMeshForRoom ( MRUKRoom room ) Creates a navigation mesh for the scene. |
void | BuildSceneNavMeshFromExistingAgent ( int agentIndex ) Creates a navigation mesh from an existing NavMeshAgent. |
NavMeshBuildSettings | CreateNavMeshBuildSettings ( float agentRadius, float agentHeight, float agentMaxSlope, float agentClimb ) Creates a new NavMeshBuildSettings object with the specified agent properties. |
void | Creates a NavMeshSurface component and sets its properties. |
void | Removes the NavMeshData from the NavMeshSurface component. |
Bounds | Resizes the NavMeshSurface to fit the room bounds. |
void | CreateObstacles ( MRUKRoom room ) Creates obstacles for the given MRUKRoom or all rooms if no room is specified. |
void | CreateObstacle ( MRUKAnchor anchor, bool shouldCarve, bool carveOnlyStationary, float carvingTimeToStationary, float carvingMoveThreshold ) Creates a NavMeshObstacle for the given MRUKAnchor. |
void | CreateNavigableSurfaces ( MRUKRoom room ) Creates navigable surfaces for the given MRUKRoom or all rooms if no room is specified. |
void | ClearObstacles ( MRUKRoom room ) Clears all obstacles from the Obstacles dictionary associated with the given MRUKRoom. |
void | ClearObstacle ( MRUKAnchor anchor ) Clears the obstacle associated with the given MRUKAnchor from the Obstacles dictionary. |
void | ClearSurface ( MRUKAnchor anchor ) Clears the surface associated with the given MRUKAnchor from the Obstacles dictionary. |
static int | GetFirstLayerFromLayerMask ( LayerMask layerMask ) Gets the first layer included in the given LayerMask. |
static bool | Validates the provided NavMeshBuildSettings against the provided NavMeshBounds. |
MRUK.RoomFilter Meta.XR.MRUtilityKit.SceneNavigation.BuildOnSceneLoaded |
---|
No description available.
|
NavMeshCollectGeometry Meta.XR.MRUtilityKit.SceneNavigation.CollectGeometry |
---|
No description available.
|
CollectObjects Meta.XR.MRUtilityKit.SceneNavigation.CollectObjects |
---|
No description available.
|
float Meta.XR.MRUtilityKit.SceneNavigation.AgentRadius |
---|
No description available.
|
float Meta.XR.MRUtilityKit.SceneNavigation.AgentHeight |
---|
No description available.
|
float Meta.XR.MRUtilityKit.SceneNavigation.AgentClimb |
---|
No description available.
|
float Meta.XR.MRUtilityKit.SceneNavigation.AgentMaxSlope |
---|
No description available.
|
List<NavMeshAgent> Meta.XR.MRUtilityKit.SceneNavigation.Agents |
---|
No description available.
|
MRUKAnchor.SceneLabels Meta.XR.MRUtilityKit.SceneNavigation.NavigableSurfaces |
---|
No description available.
|
MRUKAnchor.SceneLabels Meta.XR.MRUtilityKit.SceneNavigation.SceneObstacles |
---|
No description available.
|
LayerMask Meta.XR.MRUtilityKit.SceneNavigation.Layers |
---|
No description available.
|
UnityEvent Meta.XR.MRUtilityKit.SceneNavigation.OnNavMeshInitialized |
---|
No description available.
|
Dictionary<MRUKAnchor, GameObject> Meta.XR.MRUtilityKit.SceneNavigation.Obstacles |
---|
No description available.
|
Dictionary<MRUKAnchor, GameObject> Meta.XR.MRUtilityKit.SceneNavigation.Surfaces |
---|
No description available.
|
void Meta.XR.MRUtilityKit.SceneNavigation.ToggleGlobalMeshNavigation ( bool useGlobalMesh, int agentTypeID ) |
---|
Toggles the use of global mesh for navigation. Parameters useGlobalMesh Whether to use the global mesh to build the NavMesh agentTypeIDThe agent type ID to use for creating the scene nav mesh, if not specified, a new agent will be created. |
void Meta.XR.MRUtilityKit.SceneNavigation.BuildSceneNavMesh ( ) |
---|
Creates a navigation mesh for the entire scene. |
void Meta.XR.MRUtilityKit.SceneNavigation.BuildSceneNavMeshForRoom ( MRUKRoom room ) |
---|
Creates a navigation mesh for the scene. Parameters room Optional parameter for the MRUKRoom to create the NavMesh for. If not provided, obstacles will be created for all rooms. This method creates a navigation mesh by collecting geometry from the scene, building the navigation mesh data, and adding it to the NavMesh. Currently Unity does not allow the creation of custom NavMeshAgents at runtime. It also assigns the created navigation mesh to all NavMeshAgents in the scene. |
void Meta.XR.MRUtilityKit.SceneNavigation.BuildSceneNavMeshFromExistingAgent ( int agentIndex ) |
---|
Creates a navigation mesh from an existing NavMeshAgent. Parameters agentIndex The index of the NavMeshAgent to create the navigation mesh from. |
NavMeshBuildSettings Meta.XR.MRUtilityKit.SceneNavigation.CreateNavMeshBuildSettings ( float agentRadius, float agentHeight, float agentMaxSlope, float agentClimb ) |
---|
Creates a new NavMeshBuildSettings object with the specified agent properties. Parameters agentRadius The minimum distance to the walls where the navigation mesh can exist. agentHeightHow much vertical clearance space must exist. agentMaxSlopeMaximum slope the agent can walk up. agentClimbThe height of discontinuities in the level the agent can climb over (i.e. steps and stairs). Returns A new NavMeshBuildSettings object with the specified agent properties. |
void Meta.XR.MRUtilityKit.SceneNavigation.CreateNavMeshSurface ( ) |
---|
Creates a NavMeshSurface component and sets its properties. |
void Meta.XR.MRUtilityKit.SceneNavigation.RemoveNavMeshData ( ) |
---|
Removes the NavMeshData from the NavMeshSurface component. |
Bounds Meta.XR.MRUtilityKit.SceneNavigation.ResizeNavMeshFromRoomBounds ( ref NavMeshSurface surface, MRUKRoom room ) |
---|
Resizes the NavMeshSurface to fit the room bounds. Parameters surface The NavMeshSurface to resize. roomThe room bounds to use. Default is the current room. Returns The bounds of the resized NavMeshSurface. |
void Meta.XR.MRUtilityKit.SceneNavigation.CreateObstacles ( MRUKRoom room ) |
---|
Creates obstacles for the given MRUKRoom or all rooms if no room is specified. Parameters room Optional parameter for the MRUKRoom to create the obstacles for. If not provided, obstacles will be created for all rooms. |
void Meta.XR.MRUtilityKit.SceneNavigation.CreateObstacle ( MRUKAnchor anchor, bool shouldCarve, bool carveOnlyStationary, float carvingTimeToStationary, float carvingMoveThreshold ) |
---|
Creates a NavMeshObstacle for the given MRUKAnchor. Parameters anchor The MRUKAnchor to create the obstacle for. shouldCarveOptional parameter that determines whether the obstacle should carve the NavMesh. Default is true. carveOnlyStationaryOptional parameter that determines whether the obstacle should only carve the NavMesh when stationary. Default is true. carvingTimeToStationaryOptional parameter that sets the time in seconds an obstacle must be stationary before it starts carving the NavMesh. Default is 0.2f. carvingMoveThresholdOptional parameter that sets the minimum world space distance the obstacle must move before it is considered moving. Default is 0.2f. |
void Meta.XR.MRUtilityKit.SceneNavigation.CreateNavigableSurfaces ( MRUKRoom room ) |
---|
Creates navigable surfaces for the given MRUKRoom or all rooms if no room is specified. Parameters room Optional parameter for the MRUKRoom to create the navigable surfaces for. If not provided, navigable surfaces will be created for all rooms. Creating surfaces will not automatically build a new NavMesh. When changing surfaces at run time, always use BuildSceneNavMesh method |
void Meta.XR.MRUtilityKit.SceneNavigation.ClearObstacles ( MRUKRoom room ) |
---|
Clears all obstacles from the Obstacles dictionary associated with the given MRUKRoom. If no room is specified, all obstacles are cleared. Parameters room Optional parameter for the MRUKRoom to clear the obstacles for. If not provided, all obstacles will be cleared. |
void Meta.XR.MRUtilityKit.SceneNavigation.ClearObstacle ( MRUKAnchor anchor ) |
---|
Clears the obstacle associated with the given MRUKAnchor from the Obstacles dictionary. Parameters anchor The MRUKAnchor whose associated obstacle should be cleared. |
void Meta.XR.MRUtilityKit.SceneNavigation.ClearSurface ( MRUKAnchor anchor ) |
---|
Clears the surface associated with the given MRUKAnchor from the Obstacles dictionary. Parameters anchor The MRUKAnchor whose associated obstacle should be cleared. |
static int Meta.XR.MRUtilityKit.SceneNavigation.GetFirstLayerFromLayerMask ( LayerMask layerMask ) |
---|
Gets the first layer included in the given LayerMask. Parameters layerMask The LayerMask to get the first layer from. Returns Returns the first layer included in the LayerMask. |
static bool Meta.XR.MRUtilityKit.SceneNavigation.ValidateBuildSettings ( NavMeshBuildSettings navMeshBuildSettings, Bounds navMeshBounds ) |
---|
Validates the provided NavMeshBuildSettings against the provided NavMeshBounds. Parameters navMeshBuildSettings The NavMeshBuildSettings to validate. navMeshBoundsThe Bounds to validate the NavMeshBuildSettings against. Returns Returns true if the NavMeshBuildSettings are valid, false otherwise. |