MR Utility Kit v69 Reference Guide
MR Utility Kit v69 Reference Guide
Unity
Select your SDK
SceneNavigation Class
Extends MonoBehaviour
Manages the creation and updating of a navigation mesh (NavMesh) for scene navigation.
This class handles dynamic NavMesh generation based on scene data, including rooms and anchors, and responds to changes in the scene.
Fields
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]
Properties
UnityEvent OnNavMeshInitialized[Get]
Event triggered when the navigation mesh has been initialized.
Dictionary< MRUKAnchor, GameObject > Obstacles[Get]
Gets a dictionary mapping MRUKAnchor objects to their corresponding GameObjects that represent obstacles in the environment.
Dictionary< MRUKAnchor, GameObject > Surfaces[Get]
Gets a dictionary mapping MRUKAnchor objects to their corresponding GameObjects that represent surfaces in the environment.
Member Functions
void 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
agentTypeID
The agent type ID to use for creating the scene nav mesh, if not specified, a new agent will be created.
void BuildSceneNavMesh ( )
Creates a navigation mesh for the entire scene.
void BuildSceneNavMeshForRoom
( MRUKRoom room )
Creates a navigation mesh for the scene.
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.
Parameters
room
Optional parameter for the MRUKRoom to create the NavMesh for. If not provided, obstacles will be created for all rooms.
void 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 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.
agentHeight
How much vertical clearance space must exist.
agentMaxSlope
Maximum slope the agent can walk up.
agentClimb
The 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 CreateNavMeshSurface ( )
Creates a NavMeshSurface component and sets its properties.
void RemoveNavMeshData ( )
Removes the NavMeshData from the NavMeshSurface component.
Bounds ResizeNavMeshFromRoomBounds
( ref NavMeshSurface surface,
MRUKRoom room )
Resizes the NavMeshSurface to fit the room bounds.
Parameters
surface
The NavMeshSurface to resize.
room
The room bounds to use. Default is the current room.
Returns
The bounds of the resized NavMeshSurface.
void 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 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.
shouldCarve
Optional parameter that determines whether the obstacle should carve the NavMesh. Default is true.
carveOnlyStationary
Optional parameter that determines whether the obstacle should only carve the NavMesh when stationary. Default is true.
carvingTimeToStationary
Optional parameter that sets the time in seconds an obstacle must be stationary before it starts carving the NavMesh. Default is 0.2f.
carvingMoveThreshold
Optional parameter that sets the minimum world space distance the obstacle must move before it is considered moving. Default is 0.2f.
void CreateNavigableSurfaces
( MRUKRoom room )
Creates navigable surfaces for the given MRUKRoom or all rooms if no room is specified.
Creating surfaces will not automatically build a new NavMesh. When changing surfaces at run time, always use BuildSceneNavMesh method
Parameters
room
Optional parameter for the MRUKRoom to create the navigable surfaces for. If not provided, navigable surfaces will be created for all rooms.
void 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 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 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 Member Functions
static int 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 ValidateBuildSettings
( NavMeshBuildSettings navMeshBuildSettings,
Bounds navMeshBounds )
Validates the provided NavMeshBuildSettings against the provided NavMeshBounds.
Parameters
navMeshBuildSettings
The NavMeshBuildSettings to validate.
navMeshBounds
The Bounds to validate the NavMeshBuildSettings against.
Returns
Returns true if the NavMeshBuildSettings are valid, false otherwise.
Did you find this page helpful?
Build with Meta
Virtual reality / Meta Horizon
Support and legal
Build with Meta
Virtual reality / Meta Horizon
Support and legal
Build with Meta
Virtual reality / Meta Horizon
Support and legal
English (US)
©2024 Meta