Skip to main content Link Menu Expand (external link) Document Search Copy Copied

GizmoExtensions Public class

Description

This utility class provides extension methods for drawing various geometrical shapes as gizmos.

Diagram 

  flowchart LR
  classDef interfaceStyle stroke-dasharray: 5 5;
  classDef abstractStyle stroke-width:4px
  subgraph Rhinox.XR.Grapple.It
  Rhinox.XR.Grapple.It.GizmoExtensions[[GizmoExtensions]]
  end

Members

Methods

Public Static methods

Returns Name
void DrawSolidAnnulus(Vector3 center, Vector3 direction, Vector3 forwardVec, float innerR, float outerR, bool force2Sided, int segments)
Draws a solid annulus arc (a solid ring segment) using Gizmos in the scene view.
void DrawSolidAnnulusArc(Vector3 center, Vector3 direction, Vector3 forwardVec, float innerR, float outerR, float angle, bool force2Sided, int segments)
Draws a filled Annulus (2D flat donut) arc in 3D space.
void DrawSolidAnnulusWidth(Vector3 center, Vector3 direction, Vector3 forwardVec, float centerR, float halfWidth, bool force2Sided, int segments)
Draws a filled Annulus (2D flat donut) in 3D space.
void DrawSolidArc(Vector3 arcCenter, Vector3 direction, Vector3 arcNormal, float arcRadius, float arcAngle, bool force2Sided, int segments)
Draws a solid arc using Gizmos in the scene view.
void DrawSolidCircle(Vector3 circleCenter, Vector3 direction, Vector3 circleNormal, float circleRadius, bool force2Sided, int segments)
Draw a filled circle gizmo in 3D space.
void DrawSolidTorus(Vector3 center, Vector3 direction, Vector3 forwardVec, float innerR, float outerR, int segmentsInner, int segmentsOuter)
Draws a solid torus using Gizmos in the scene view.
void DrawWireArc(Vector3 arcCenter, Vector3 direction, Vector3 arcNormal, float arcRadius, float arcAngle, int segments)
This method draws a wireframe arc using Gizmos in the scene view
void DrawWireCircle(Vector3 circleCenter, Vector3 direction, Vector3 circleNormal, float circleRadius, int segments)
Draws a wireframe circle using Gizmos in the scene view.
void DrawWireTorus(Vector3 center, Vector3 direction, Vector3 forwardVec, float innerR, float outerR, int segmentsInner, int segmentsOuter)
Draws a wire torus using Gizmos in the scene view.

Details

Summary

This utility class provides extension methods for drawing various geometrical shapes as gizmos.

Methods

DrawWireArc 

public static void DrawWireArc(Vector3 arcCenter, Vector3 direction, Vector3 arcNormal, float arcRadius, float arcAngle, int segments)
Arguments
Type Name Description
Vector3 arcCenter The center point of the arc
Vector3 direction The initial direction in which the arc will be drawn.
Vector3 arcNormal A perpendicular vector to the plane in which the arc lies.
float arcRadius The radius of the arc.
float arcAngle Specifies the angle, in degrees, that the arc spans.
int segments Specifies the number of line segments used to draw the arc (default is 10).
Summary

This method draws a wireframe arc using Gizmos in the scene view

Remarks

The direction and arcNormal should be normalized otherwise the circle will be drawn incorrectly.

DrawSolidArc 

public static void DrawSolidArc(Vector3 arcCenter, Vector3 direction, Vector3 arcNormal, float arcRadius, float arcAngle, bool force2Sided, int segments)
Arguments
Type Name Description
Vector3 arcCenter The center point of the arc
Vector3 direction The initial direction in which the arc will be drawn.
Vector3 arcNormal A perpendicular vector to the plane in which the arc lies.
float arcRadius The radius of the arc.
float arcAngle Specifies the angle, in degrees, that the arc spans.
bool force2Sided Optional parameter specifying if the arc will be visible from both sides of the normal (basically no culling).
int segments Specifies the number of line segments used to draw the arc (default is 10).
Summary

Draws a solid arc using Gizmos in the scene view.

Remarks

The direction and arcNormal should be normalized otherwise the circle will be drawn incorrectly.

DrawWireCircle 

public static void DrawWireCircle(Vector3 circleCenter, Vector3 direction, Vector3 circleNormal, float circleRadius, int segments)
Arguments
Type Name Description
Vector3 circleCenter The center point of the circle in world space.
Vector3 direction Specifies the initial direction in which the circle is drawn.
Vector3 circleNormal A perpendicular vector to the plane in which the circle lies.
float circleRadius The radius of the circle.
int segments Specifies the number of line segments used to draw the arc (default is 10).
Summary

Draws a wireframe circle using Gizmos in the scene view.

Remarks

The direction and circleNormal should be normalized otherwise the circle will be drawn incorrectly.

DrawSolidCircle 

public static void DrawSolidCircle(Vector3 circleCenter, Vector3 direction, Vector3 circleNormal, float circleRadius, bool force2Sided, int segments)
Arguments
Type Name Description
Vector3 circleCenter The center point of the circle in world space.
Vector3 direction Specifies the initial direction in which the circle is drawn.
Vector3 circleNormal A perpendicular vector to the plane in which the circle lies.
float circleRadius The radius of the circle.
bool force2Sided Optional parameter specifying if the circle will be visible from both sides of the normal (basically no culling).
int segments Specifies the number of line segments used to draw the arc (default is 10).
Summary

Draw a filled circle gizmo in 3D space.

Remarks

The direction and circleNormal should be normalized otherwise the circle will be drawn incorrectly.

DrawSolidAnnulusArc 

public static void DrawSolidAnnulusArc(Vector3 center, Vector3 direction, Vector3 forwardVec, float innerR, float outerR, float angle, bool force2Sided, int segments)
Arguments
Type Name Description
Vector3 center The center point of the annulus arc in world space.
Vector3 direction The direction of where the annulus arc start point is.
Vector3 forwardVec The normal of the plane the annulus is on.
float innerR The radius of the annulus’s inner border.
float outerR The radius of the annulus’s outer border.
float angle The angle of the annulus arc in degrees.
bool force2Sided Optional parameter specifying if the annulus will be visible from both sides of the normal (basically no culling).
int segments Specifies the number of line segments used to draw the arc (default is 12).
Summary

Draws a filled Annulus (2D flat donut) arc in 3D space.

Remarks

DOES NOT DO ARC, STILL CLOSES The direction and forwardVec should be normalized otherwise the circle will be drawn incorrectly. segments cannot go below 3, as 3 is the minimum to make a triangle.

DrawSolidAnnulus 

public static void DrawSolidAnnulus(Vector3 center, Vector3 direction, Vector3 forwardVec, float innerR, float outerR, bool force2Sided, int segments)
Arguments
Type Name Description
Vector3 center The center point of the annulus in world space.
Vector3 direction The initial direction in which the annulus is drawn.
Vector3 forwardVec A vector that defines the plane in which the annulus lies.
float innerR The radius of the annulus’s inner border.
float outerR The radius of the annulus’s outer border.
bool force2Sided Optional parameter specifying if the annulus will be visible from both sides of the normal (basically no culling).
int segments Specifies the number of line segments used to draw the arc (default is 12).
Summary

Draws a solid annulus arc (a solid ring segment) using Gizmos in the scene view.

Remarks

The direction and forwardVec should be normalized otherwise the circle will be drawn incorrectly.

DrawSolidAnnulusWidth 

public static void DrawSolidAnnulusWidth(Vector3 center, Vector3 direction, Vector3 forwardVec, float centerR, float halfWidth, bool force2Sided, int segments)
Arguments
Type Name Description
Vector3 center The center point of the annulus in worldspace.
Vector3 direction The initial direction in which the annulus is drawn.
Vector3 forwardVec A vector that defines the plane in which the annulus lies.
float centerR The radius of the annulus’s.
float halfWidth The half width of the filled part of annulus.
bool force2Sided Optional parameter specifying if the annulus will be visible from both sides of the normal (basically no culling).
int segments Specifies the number of line segments used to draw the arc (default is 12).
Summary

Draws a filled Annulus (2D flat donut) in 3D space.

Remarks

The direction and forwardVec should be normalized otherwise the circle will be drawn incorrectly.

DrawSolidTorus 

public static void DrawSolidTorus(Vector3 center, Vector3 direction, Vector3 forwardVec, float innerR, float outerR, int segmentsInner, int segmentsOuter)
Arguments
Type Name Description
Vector3 center The center point of the torus in worlds pace.
Vector3 direction The direction of where the torus start point is.
Vector3 forwardVec The normal of the plane the torus is on.
float innerR The radius of the annulus’s inner border.
float outerR The radius of the annulus’s outer border.
int segmentsInner Optional parameter specifying the number of line segments that will be used to draw
the loop around the given normal.
int segmentsOuter Optional parameter specifying the number of line segments that will be used to draw
the loop of each segment.
Summary

Draws a solid torus using Gizmos in the scene view.

Remarks

The direction and forwardVec should be normalized otherwise the circle will be drawn incorrectly. segmentsInner and segmentsOuter cannot go below 3, as 3 is the minimum to make a triangle.

DrawWireTorus 

public static void DrawWireTorus(Vector3 center, Vector3 direction, Vector3 forwardVec, float innerR, float outerR, int segmentsInner, int segmentsOuter)
Arguments
Type Name Description
Vector3 center The center point of the torus in worlds pace.
Vector3 direction The direction of where the torus start point is.
Vector3 forwardVec The normal of the plane the torus is on.
float innerR The radius of the annulus’s inner border.
float outerR The radius of the annulus’s outer border.
int segmentsInner Optional parameter specifying the number of line segments that will be used to draw
the loop around the given normal.
int segmentsOuter Optional parameter specifying the number of line segments that will be used to draw
the loop of each segment.
Summary

Draws a wire torus using Gizmos in the scene view.

Remarks

The direction and forwardVec should be normalized otherwise the circle will be drawn incorrectly. segmentsInner and segmentsOuter cannot go below 3, as 3 is the minimum to make a triangle.

Generated with ModularDoc