API reference

SceneDebugger Class

Extends MonoBehaviour
Provides debugging tools for visualizing and interacting with the scene data.

Fields

exportGlobalMeshJSONDropdown : TMP_Dropdown
Signature 
TMP_Dropdown exportGlobalMeshJSONDropdown
GazePointer : OVRGazePointer
Signature 
OVRGazePointer GazePointer
InputModule : OVRInputModule
Signature 
OVRInputModule InputModule
logs : TextMeshProUGUI
Signature 
TextMeshProUGUI logs
Menus : List< CanvasGroup >
Signature 
List<CanvasGroup> Menus
MoveCanvasInFrontOfCamera : bool
Signature 
bool MoveCanvasInFrontOfCamera
positioningMethodDropdown : TMP_Dropdown
Signature 
TMP_Dropdown positioningMethodDropdown
Raycaster : OVRRaycaster
Signature 
OVRRaycaster Raycaster
RayHelper : OVRRayHelper
Signature 
OVRRayHelper RayHelper
RoomDetails : TextMeshProUGUI
Signature 
TextMeshProUGUI RoomDetails
SetupInteractions : bool
Signature 
bool SetupInteractions
ShowDebugAnchors : bool
Signature 
bool ShowDebugAnchors
surfaceTypeDropdown : TMP_Dropdown
Signature 
TMP_Dropdown surfaceTypeDropdown
Tabs : List< Image >
Signature 
List<Image> Tabs
visualHelperMaterial : Material
Signature 
Material visualHelperMaterial

Methods

ActivateMenu ( menuToActivate )
Activates the specified menu by enabling its canvas group and disables all other menus.
Signature 
void ActivateMenu(CanvasGroup menuToActivate)
Parameters
menuToActivate: CanvasGroup  The canvas group of the menu to activate.
Returns
void
ActivateTab ( selectedTab )
Activates the selected tab by changing its color and sets all other tabs to the background color.
Signature 
void ActivateTab(Image selectedTab)
Parameters
selectedTab: Image  The tab image to activate.
Returns
void
DisplayGlobalMesh ( isOn )
Displays the global mesh anchor if one is found in the scene.
Signature 
void DisplayGlobalMesh(bool isOn)
Parameters
isOn: bool  If set to true, the global mesh will be displayed.
Returns
void
DisplayNavMesh ( isOn )
Displays the nav mesh, if present.
Signature 
void DisplayNavMesh(bool isOn)
Parameters
isOn: bool  If set to true, the navigation mesh will be displayed, if present
Returns
void
DisplaySpaceMap ( isOn )
Displays a texture in the right info panel about your spacemap.
Signature 
void DisplaySpaceMap(bool isOn)
Parameters
isOn: bool  No action needed as the SpaceMap does not need additional logic
Returns
void
ExportJSON ( isOn )
Exports the current scene data to a JSON file if the specified condition is met.
Signature 
void ExportJSON(bool isOn)
Parameters
isOn: bool  If set to true, the scene data will be exported to JSON.
Returns
void
GetBestPoseFromRaycastDebugger ( isOn )
Highlights the best suggested transform to place a widget on a surface.
Signature 
void GetBestPoseFromRaycastDebugger(bool isOn)
Parameters
isOn: bool  If set to true, the best pose from raycast will be highlighted.
Returns
void
GetClosestSeatPoseDebugger ( isOn )
Highlights the best-suggested seat, for something like remote caller placement.
Signature 
void GetClosestSeatPoseDebugger(bool isOn)
Parameters
isOn: bool  If set to true, the closest seat pose will be highlighted.
Returns
void
GetClosestSurfacePositionDebugger ( isOn )
Highlights the closest position on a SceneAPI surface.
Signature 
void GetClosestSurfacePositionDebugger(bool isOn)
Parameters
isOn: bool  If set to true, the closest surface position will be highlighted.
Returns
void
GetKeyWallDebugger ( isOn )
Highlights the room's key wall, defined as the longest wall in the room which has no other room points behind it.
Signature 
void GetKeyWallDebugger(bool isOn)
Parameters
isOn: bool  If set to true, the key wall will be highlighted.
Returns
void
GetLargestSurfaceDebugger ( isOn )
Highlights the anchor with the largest available surface area.
Signature 
void GetLargestSurfaceDebugger(bool isOn)
Parameters
isOn: bool  If set to true, the largest surface will be highlighted.
Returns
void
IsPositionInRoomDebugger ( isOn )
Moves the debug sphere to the controller position and colors it in green if its position is in the room, red otherwise.
Signature 
void IsPositionInRoomDebugger(bool isOn)
Parameters
isOn: bool  If set to true, the position of the debug sphere will be checked.
Returns
void
RayCastDebugger ( isOn )
Casts a ray cast forward from the right controller position and draws the normal of the first Scene API object hit.
Signature 
void RayCastDebugger(bool isOn)
Parameters
isOn: bool  If set to true, the raycast hits with scene objects will be visualized.
Returns
void
ShowDebugAnchorsDebugger ( isOn )
Shows the debug anchor visualization mode for the anchor being pointed at.
Signature 
void ShowDebugAnchorsDebugger(bool isOn)
Parameters
isOn: bool  If set to true, debug anchors will be visualized.
Returns
void
ShowRoomDetailsDebugger ( isOn )
Shows information about the rooms loaded.
Signature 
void ShowRoomDetailsDebugger(bool isOn)
Parameters
isOn: bool  If set to true, room details will be shown.
Returns
void
ToggleGlobalMeshCollisions ( isOn )
Toggles the global mesh anchor's collision.
Signature 
void ToggleGlobalMeshCollisions(bool isOn)
Parameters
isOn: bool  If set to true, collisions for the global mesh anchor will be enabled
Returns
void

Static Methods

DebugDestructibleMeshComponent ( destructibleMeshComponent )
Debugging method to color each segment with a unique color.
Signature 
static void DebugDestructibleMeshComponent(DestructibleMeshComponent destructibleMeshComponent)
Parameters
destructibleMeshComponent: DestructibleMeshComponent  The DestructibleMeshComponent to be debugged.
Returns
void
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2026 Meta