Utility class for drawing gizmos. More...

Static Public Member Functions
static Color	Alpha (this Color color, Single a)
	Adjusts the alpha channel of the color. More...

static Color	Brightness (this Color color, float brightness)
	Adjusts the brightness of a color. More...

static void	DrawGizmoArc (Vector3 position, Vector3 normal, Vector3 from, float angle, float radius, Color color, float alphaRatio=1.0f, QuantumGizmoStyle style=default)
	Draws a gizmo arc in the Unity editor. More...

static void	DrawGizmoDiamond (Vector3 center, Vector2 size)
	Draws a diamond gizmo with the given center and size. More...

static void	DrawGizmoDisc (Vector3 position, Vector3 normal, float radius, Color color, float alphaRatio=1.0f, QuantumGizmoStyle style=default)
	Draws a gizmo disc at the specified position and orientation. More...

static void	DrawGizmoGrid (FPVector2 bottomLeft, Int32 width, Int32 height, Int32 nodeSize, Color color)
	Draws a grid of gizmos in the Unity editor. More...

static void	DrawGizmoGrid (Vector3 bottomLeft, Int32 width, Int32 height, float nodeWidth, float nodeHeight, Color color)
	Draws a grid of gizmos in the scene. More...

static void	DrawGizmoGrid (Vector3 bottomLeft, Int32 width, Int32 height, Int32 nodeSize, Color color)
	Draw a grid of gizmos starting from a bottom-left position. More...

static void	DrawGizmoPolygon2D (Matrix4x4 matrix, FPVector2[] vertices, Single height, bool drawNormals, Color color, QuantumGizmoStyle style=default)

static void	DrawGizmoPolygon2D (Transform transform, FPVector2[] vertices, Single height, bool drawNormals, Color color, QuantumGizmoStyle style=default)
	Draws a 2D polygon gizmo with the given parameters. More...

static void	DrawGizmoPolygon2D (Vector3 position, Quaternion rotation, FPVector2[] vertices, Single height, bool drawNormals, Color color, QuantumGizmoStyle style=default)
	Draws a 2D polygon gizmo in the scene. More...

static void	DrawGizmoPolygon2D (Vector3 position, Quaternion rotation, FPVector2[] vertices, Single height, Color color, QuantumGizmoStyle style=default)
	Draws a 2D polygon gizmo in the scene. More...

static void	DrawGizmosBox (Matrix4x4 matrix, Vector3 size, Color color, QuantumGizmoStyle style=default)
	Draws a box gizmo in the scene using the specified parameters. More...

static void	DrawGizmosBox (Transform transform, Vector3 size, Color color, Vector3 offset=default, QuantumGizmoStyle style=default)
	Draws a gizmo box in the scene using the specified parameters. More...

static void	DrawGizmosBox (Vector3 center, Vector3 size, Color color, Quaternion? rotation=null, QuantumGizmoStyle style=default)
	Draws a box gizmo with the given center, size, color, rotation, and style. More...

static void	DrawGizmosCapsule (Matrix4x4 matrix, float radius, float extent, Color color, QuantumGizmoStyle style=default)
	Draws a capsule gizmo in the Scene view using Handles. More...

static void	DrawGizmosCapsule (Vector3 center, float radius, float extent, Color color, Quaternion? rotation=null, QuantumGizmoStyle style=default)
	Draws a capsule Gizmo in 3D space. More...

static void	DrawGizmosCapsule2D (Vector3 center, float radius, float height, float tHeight, Color color, Quaternion? rotation=null, QuantumGizmoStyle style=default)
	Draws a 2D capsule gizmo. More...

static void	DrawGizmosCircle (Vector3 position, Single radius, Color color, Single height=0.0f, QuantumGizmoStyle style=default)
	Draws a gizmo circle at the specified position with the given radius and color. More...

static void	DrawGizmosEdge (Vector3 start, Vector3 end, float height, Color color, QuantumGizmoStyle style=default)
	Draws a gizmo edge from the specified start point to the end point. More...

static void	DrawGizmosSphere (Vector3 position, Single radius, Color color, QuantumGizmoStyle style=default)
	Draws a sphere gizmo in the scene. More...

static void	DrawGizmosTriangle (Vector3 A, Vector3 B, Vector3 C, Color color)
	Draws a triangle gizmo using the given vertices and color. More...

static void	DrawGizmoVector (Vector3 start, Vector3 end, float arrowHeadLength, float arrowHeadAngle, out Vector3 direction)
	Draws a vector gizmo from the specified start point to the specified end point. More...

static void	DrawGizmoVector (Vector3 start, Vector3 end, float arrowHeadLength=DefaultArrowHeadLength, float arrowHeadAngle=DefaultArrowHeadAngle)
	Draws a vector gizmo from the specified start point to the specified end point. More...

static void	DrawGizmoVector3D (Vector3 start, Vector3 end, float arrowHeadLength=0.25f, float arrowHeadAngle=25.0f)
	Draws a 3D vector gizmo with an arrowhead from the specified start to end points. More...

Static Public Attributes
const float	DefaultArrowHeadAngle = 25.0f
	The default arrow head angle. More...

const float	DefaultArrowHeadLength = 0.25f
	The default arrow head length. More...

Detailed Description

Utility class for drawing gizmos.

Member Function Documentation

◆ Alpha()

static Color Quantum.GizmoUtils.Alpha	(	this Color	color,
		Single	a
	)

inlinestatic

Adjusts the alpha channel of the color.

Parameters

color	The color to adjust.
a	The new alpha value.

Returns: The color with the alpha value adjusted.

◆ Brightness()

static Color Quantum.GizmoUtils.Brightness	(	this Color	color,
		float	brightness
	)

inlinestatic

Adjusts the brightness of a color.

Parameters

color	The color to adjust.
brightness	The brightness value. Values greater than 1 will increase brightness, while values less than 1 will decrease brightness.

Returns: The adjusted color with the specified brightness.

◆ DrawGizmosBox() [1/3]

static void Quantum.GizmoUtils.DrawGizmosBox	(	Transform	transform,
		Vector3	size,
		Color	color,
		Vector3	offset = `default`,
		QuantumGizmoStyle	style = `default`
	)

inlinestatic

Draws a gizmo box in the scene using the specified parameters.

Parameters

transform	The transform of the gizmo box.
size	The size of the gizmo box.
color	The color of the gizmo box.
offset	The offset position for the gizmo box (default: Vector3.zero).
style	The gizmo style to apply (default: QuantumGizmoStyle default value).

◆ DrawGizmosBox() [2/3]

static void Quantum.GizmoUtils.DrawGizmosBox	(	Vector3	center,
		Vector3	size,
		Color	color,
		Quaternion?	rotation = `null`,
		QuantumGizmoStyle	style = `default`
	)

inlinestatic

Draws a box gizmo with the given center, size, color, rotation, and style.

Parameters

center	The center position of the box.
size	The size of the box.
color	The color of the box.
rotation	The rotation of the box. Defaults to identity rotation if not provided.
style	The style of the gizmo. Defaults to default style if not provided.

◆ DrawGizmosCapsule2D()

static void Quantum.GizmoUtils.DrawGizmosCapsule2D	(	Vector3	center,
		float	radius,
		float	height,
		float	tHeight,
		Color	color,
		Quaternion?	rotation = `null`,
		QuantumGizmoStyle	style = `default`
	)

inlinestatic

Draws a 2D capsule gizmo.

Parameters

center	The center of the capsule.
radius	The radius of the capsule.
height	The height of the capsule.
tHeight	The height of the vertical transform
color	The color of the gizmo.
rotation	The rotation of the capsule. If null, identity rotation is used.
style	The style of the gizmo. If not provided, default style is used.

◆ DrawGizmosBox() [3/3]

static void Quantum.GizmoUtils.DrawGizmosBox	(	Matrix4x4	matrix,
		Vector3	size,
		Color	color,
		QuantumGizmoStyle	style = `default`
	)

inlinestatic

Draws a box gizmo in the scene using the specified parameters.

Parameters

matrix	The matrix of the gizmo box.
size	The size of the box.
color	The color of the box.
style	The style of the gizmo. (Optional)

◆ DrawGizmosCircle()

static void Quantum.GizmoUtils.DrawGizmosCircle	(	Vector3	position,
		Single	radius,
		Color	color,
		Single	height = `0.0f`,
		QuantumGizmoStyle	style = `default`
	)

inlinestatic

Draws a gizmo circle at the specified position with the given radius and color.

Parameters

position	The position of the circle.
radius	The radius of the circle.
color	The color of the circle.
height	The height of the circle. Default is 0.0.
style	The style of the gizmo. Default is QuantumGizmoStyle's default value.

◆ DrawGizmosSphere()

static void Quantum.GizmoUtils.DrawGizmosSphere	(	Vector3	position,
		Single	radius,
		Color	color,
		QuantumGizmoStyle	style = `default`
	)

inlinestatic

Draws a sphere gizmo in the scene.

Parameters

position	The position of the sphere.
radius	The radius of the sphere.
color	The color of the sphere.
style	The style of the gizmo.

◆ DrawGizmosTriangle()

static void Quantum.GizmoUtils.DrawGizmosTriangle	(	Vector3	A,
		Vector3	B,
		Vector3	C,
		Color	color
	)

inlinestatic

Draws a triangle gizmo using the given vertices and color.

Parameters

A	The first vertex of the triangle.
B	The second vertex of the triangle.
C	The third vertex of the triangle.
color	The color of the triangle.

◆ DrawGizmoGrid() [1/3]

static void Quantum.GizmoUtils.DrawGizmoGrid	(	FPVector2	bottomLeft,
		Int32	width,
		Int32	height,
		Int32	nodeSize,
		Color	color
	)

inlinestatic

Draws a grid of gizmos in the Unity editor.

Parameters

bottomLeft	The bottom-left corner of the grid.
width	The number of horizontal nodes in the grid.
height	The number of vertical nodes in the grid.
nodeSize	The size of each grid node.
color	The color of the grid gizmos.

◆ DrawGizmoGrid() [2/3]

static void Quantum.GizmoUtils.DrawGizmoGrid	(	Vector3	bottomLeft,
		Int32	width,
		Int32	height,
		Int32	nodeSize,
		Color	color
	)

inlinestatic

Draw a grid of gizmos starting from a bottom-left position.

Parameters

bottomLeft	The bottom-left position of the grid.
width	The width of the grid in number of nodes.
height	The height of the grid in number of nodes.
nodeSize	The size of each individual node in the grid.
color	The color of the grid gizmos.

◆ DrawGizmoGrid() [3/3]

static void Quantum.GizmoUtils.DrawGizmoGrid	(	Vector3	bottomLeft,
		Int32	width,
		Int32	height,
		float	nodeWidth,
		float	nodeHeight,
		Color	color
	)

inlinestatic

Draws a grid of gizmos in the scene.

Parameters

bottomLeft	The bottom left corner of the grid.
width	The number of columns in the grid.
height	The number of rows in the grid.
nodeWidth	The width of each grid node.
nodeHeight	The height of each grid node.
color	The color of the grid lines.

◆ DrawGizmoPolygon2D() [1/3]

static void Quantum.GizmoUtils.DrawGizmoPolygon2D	(	Vector3	position,
		Quaternion	rotation,
		FPVector2[]	vertices,
		Single	height,
		Color	color,
		QuantumGizmoStyle	style = `default`
	)

inlinestatic

Draws a 2D polygon gizmo in the scene.

Parameters

position	The position of the polygon.
rotation	The rotation of the polygon.
vertices	The vertices of the polygon.
height	The height of the polygon.
color	The color of the polygon.
style	The style of the gizmo.

◆ DrawGizmoPolygon2D() [2/3]

static void Quantum.GizmoUtils.DrawGizmoPolygon2D	(	Vector3	position,
		Quaternion	rotation,
		FPVector2[]	vertices,
		Single	height,
		bool	drawNormals,
		Color	color,
		QuantumGizmoStyle	style = `default`
	)

inlinestatic

Draws a 2D polygon gizmo in the scene.

Parameters

position	The position of the polygon.
rotation	The rotation of the polygon.
vertices	The array of vertices that define the polygon shape.
height	The height of the polygon.
drawNormals	Whether to draw normals for the polygon.
color	The color of the polygon.
style	The style of the gizmo.

◆ DrawGizmoPolygon2D() [3/3]

static void Quantum.GizmoUtils.DrawGizmoPolygon2D	(	Transform	transform,
		FPVector2[]	vertices,
		Single	height,
		bool	drawNormals,
		Color	color,
		QuantumGizmoStyle	style = `default`
	)

inlinestatic

Draws a 2D polygon gizmo with the given parameters.

Parameters

transform	The transform of the polygon.
vertices	The vertices of the polygon.
height	The height of the polygon.
drawNormals	Whether to draw the polygon normal.
color	The color of the polygon.
style	The style of the gizmo.

◆ DrawGizmoDiamond()

static void Quantum.GizmoUtils.DrawGizmoDiamond	(	Vector3	center,
		Vector2	size
	)

inlinestatic

Draws a diamond gizmo with the given center and size.

Parameters

center	The center position of the diamond.
size	The size of the diamond.

◆ DrawGizmoVector3D()

static void Quantum.GizmoUtils.DrawGizmoVector3D	(	Vector3	start,
		Vector3	end,
		float	arrowHeadLength = `0.25f`,
		float	arrowHeadAngle = `25.0f`
	)

inlinestatic

Draws a 3D vector gizmo with an arrowhead from the specified start to end points.

Parameters

start	The starting point of the vector.
end	The ending point of the vector.
arrowHeadLength	The length of the arrowhead.
arrowHeadAngle	The angle of the arrowhead.

◆ DrawGizmoVector() [1/2]

static void Quantum.GizmoUtils.DrawGizmoVector	(	Vector3	start,
		Vector3	end,
		float	arrowHeadLength = `DefaultArrowHeadLength`,
		float	arrowHeadAngle = `DefaultArrowHeadAngle`
	)

inlinestatic

Draws a vector gizmo from the specified start point to the specified end point.

Parameters

start	The starting point of the vector.
end	The ending point of the vector.
arrowHeadLength	The length of the arrow head (default is DefaultArrowHeadLength).
arrowHeadAngle	The angle of the arrow head (default is DefaultArrowHeadAngle).

◆ DrawGizmoVector() [2/2]

static void Quantum.GizmoUtils.DrawGizmoVector	(	Vector3	start,
		Vector3	end,
		float	arrowHeadLength,
		float	arrowHeadAngle,
		out Vector3	direction
	)

inlinestatic

Draws a vector gizmo from the specified start point to the specified end point.

Parameters

start	The starting point of the vector.
end	The ending point of the vector.
arrowHeadLength	The length of the arrow head.
arrowHeadAngle	The angle of the arrow head.
direction	The calculated direction vector.

◆ DrawGizmoArc()

static void Quantum.GizmoUtils.DrawGizmoArc	(	Vector3	position,
		Vector3	normal,
		Vector3	from,
		float	angle,
		float	radius,
		Color	color,
		float	alphaRatio = `1.0f`,
		QuantumGizmoStyle	style = `default`
	)

inlinestatic

Draws a gizmo arc in the Unity editor.

Parameters

position	The position of the arc.
normal	The normal vector of the arc.
from	The starting direction vector of the arc.
angle	The angle of the arc.
radius	The radius of the arc.
color	The color of the arc.
alphaRatio	The alpha ratio of the arc.
style	The style of the arc.

◆ DrawGizmoDisc()

static void Quantum.GizmoUtils.DrawGizmoDisc	(	Vector3	position,
		Vector3	normal,
		float	radius,
		Color	color,
		float	alphaRatio = `1.0f`,
		QuantumGizmoStyle	style = `default`
	)

inlinestatic

Draws a gizmo disc at the specified position and orientation.

Parameters

position	The position of the disc.
normal	The orientation of the disc.
radius	The radius of the disc.
color	The color of the disc.
alphaRatio	The alpha ratio for the disc's color.
style	The style of the gizmo.

◆ DrawGizmosEdge()

static void Quantum.GizmoUtils.DrawGizmosEdge	(	Vector3	start,
		Vector3	end,
		float	height,
		Color	color,
		QuantumGizmoStyle	style = `default`
	)

inlinestatic

Draws a gizmo edge from the specified start point to the end point.

Parameters

start	The starting point of the edge.
end	The ending point of the edge.
height	The height of the edge.
color	The color of the edge.
style	The gizmo style to use.

◆ DrawGizmosCapsule() [1/2]

static void Quantum.GizmoUtils.DrawGizmosCapsule	(	Vector3	center,
		float	radius,
		float	extent,
		Color	color,
		Quaternion?	rotation = `null`,
		QuantumGizmoStyle	style = `default`
	)

inlinestatic

Draws a capsule Gizmo in 3D space.

Parameters

center	The center position of the capsule.
radius	The radius of the capsule.
extent	The extent (length) of the capsule.
color	The color of the capsule.
rotation	The rotation of the capsule. If null, no rotation is applied.
style	The style of the Gizmo. Defaults to QuantumGizmoStyle.

◆ DrawGizmosCapsule() [2/2]

static void Quantum.GizmoUtils.DrawGizmosCapsule	(	Matrix4x4	matrix,
		float	radius,
		float	extent,
		Color	color,
		QuantumGizmoStyle	style = `default`
	)

inlinestatic

Draws a capsule gizmo in the Scene view using Handles.

Parameters

matrix	The matrix of the capsule.
radius	The radius of the capsule.
extent	The height extent of the capsule.
color	The color of the capsule.
style	Optional gizmo style.

Member Data Documentation

◆ DefaultArrowHeadLength

const float Quantum.GizmoUtils.DefaultArrowHeadLength = 0.25f

static

The default arrow head length.

◆ DefaultArrowHeadAngle

const float Quantum.GizmoUtils.DefaultArrowHeadAngle = 25.0f

static

The default arrow head angle.

Quantum 3 3.0.9

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

◆ Alpha()

◆ Brightness()

◆ DrawGizmosBox() [1/3]

◆ DrawGizmosBox() [2/3]

◆ DrawGizmosCapsule2D()

◆ DrawGizmosBox() [3/3]

◆ DrawGizmosCircle()

◆ DrawGizmosSphere()

◆ DrawGizmosTriangle()

◆ DrawGizmoGrid() [1/3]

◆ DrawGizmoGrid() [2/3]

◆ DrawGizmoGrid() [3/3]

◆ DrawGizmoPolygon2D() [1/3]

◆ DrawGizmoPolygon2D() [2/3]

◆ DrawGizmoPolygon2D() [3/3]

◆ DrawGizmoDiamond()

◆ DrawGizmoVector3D()

◆ DrawGizmoVector() [1/2]

◆ DrawGizmoVector() [2/2]

◆ DrawGizmoArc()

◆ DrawGizmoDisc()

◆ DrawGizmosEdge()

◆ DrawGizmosCapsule() [1/2]

◆ DrawGizmosCapsule() [2/2]

Member Data Documentation

◆ DefaultArrowHeadLength

◆ DefaultArrowHeadAngle