API reference
API reference
Select your platform
No SDKs available
No versions available

DebugGizmos Class

Extends MonoBehaviour
This is a MonoBehaviour responsible for drawing debug gizmos for Immersive Debugger.
It contains methods and configuration options for drawing builtin types within the class. For more info about Immersive Debugger, check out the official doc

Object Data for protected-static-attrib

static DebugGizmos _root[Get]

Properties

static DebugGizmos Root[Get]
PolylineRenderer Renderer[Get]
Indicate whether using single pass rendering, can be updated within runtime dynamically.
If using single pass rendering, duplicate buffer data for the PolylineRenderer

Public Statics

The color (of Unity Color type) used to draw the segments, by default to Black.
Can be adjusted dynamically in runtime.
Float indicating the width of the segments that's used for drawing the gizmos, by default to 0.1f.
Can be adjusted dynamically in runtime.

Protected Functions

virtual void OnEnable ( )
virtual void OnDisable ( )
void ClearSegments ( )
void RenderSegments ( )
virtual void LateUpdate ( )
void AddSegment
( Vector3 p0,
Vector3 p1,
float width,
Color color0,
Color color1 )

Static Member Functions

Draw a point gizmo using PolylineRenderer segments.
Parameters
p0
Vector3 indicating the position of the point
t
Optional Transform applied on top of the gizmo
Draw a line gizmo using PolylineRenderer segments.
Parameters
p0
Vector3 indicating the starting point of the line
p1
Vector3 indicating the ending point of the line
t
Optional Transform applied on top of the gizmo
Draw a wired cube gizmo using PolylineRenderer segments.
Parameters
center
Vector3 indicating the center of the cube
size
Float indicating the size of the cube
t
Optional Transform applied on top of the gizmo
Draw an Axis gizmo using PolylineRenderer segments.
Parameters
pose
Pose indicating the position/rotation of the Axis
size
Float indicating the length of each Axis line
Draw an Axis gizmo using PolylineRenderer segments.
Parameters
t
Transform indicating the position/rotation of the Axis
size
Float indicating the length of each Axis line
Draw a plane gizmo using PolylineRenderer segments.
Parameters
pose
Pose indicating the origin position and normal of the plane (the center point)
width
Float indicating the width of the plane
height
Float indicating the height of the plane
Draw a box gizmo using PolylineRenderer segments.
Parameters
pose
Pose indicating the origin position and normal of the box (pivot depending on isPivotTopSurface)
width
Float indicating the width of the box
height
Float indicating the height of the box
depth
Float indicating the depth of the box
isPivotTopSurface
Boolean specifying the pivot's Pose is from the middle center of the box or top surface's center, it's usually used as true for Scene anchors
Did you find this page helpful?
Thumbs up icon
Thumbs down icon