Class Draw

void Arrow (

float3	from	Base of the arrow.
float3	to	Head of the arrow.

)

Draws an arrow between two points.

The size of the head defaults to 20% of the length of the arrow.

void Arrow (

float3	from	Base of the arrow.
float3	to	Head of the arrow.
Color	color

)

Draws an arrow between two points.

The size of the head defaults to 20% of the length of the arrow.

void Arrow (

float3	from	Base of the arrow.
float3	to	Head of the arrow.
float3	up	Up direction of the world, the arrowhead plane will be as perpendicular as possible to this direction. Defaults to Vector3.up.
float	headSize	The size of the arrowhead in world units.

)

Draws an arrow between two points.

void Arrow (

float3	from	Base of the arrow.
float3	to	Head of the arrow.
float3	up	Up direction of the world, the arrowhead plane will be as perpendicular as possible to this direction. Defaults to Vector3.up.
float	headSize	The size of the arrowhead in world units.
Color	color

)

Draws an arrow between two points.

void Arrowhead (

float3	center	Center of the arrowhead.
float3	direction	Direction the arrow is pointing.
float	radius	Distance from the center to each corner of the arrowhead.

)

Draws an arrowhead at a point.

void Arrowhead (

float3	center	Center of the arrowhead.
float3	direction	Direction the arrow is pointing.
float	radius	Distance from the center to each corner of the arrowhead.
Color	color

)

Draws an arrowhead at a point.

void Arrowhead (

float3	center	Center of the arrowhead.
float3	direction	Direction the arrow is pointing.
float3	up	Up direction of the world, the arrowhead plane will be as perpendicular as possible to this direction. Defaults to Vector3.up.
float	radius	Distance from the center to each corner of the arrowhead.

)

Draws an arrowhead at a point.

void Arrowhead (

float3	center	Center of the arrowhead.
float3	direction	Direction the arrow is pointing.
float3	up	Up direction of the world, the arrowhead plane will be as perpendicular as possible to this direction. Defaults to Vector3.up.
float	radius	Distance from the center to each corner of the arrowhead.
Color	color

)

Draws an arrowhead at a point.

void ArrowheadArc (

float3	origin	Point around which the arc is centered
float3	direction	Direction the arrow is pointing
float	offset	Distance from origin that the arrow starts.
Color	color

)

Draws an arrowhead centered around a circle.

This can be used to for example show the direction a character is moving in.

void ArrowheadArc (

float3	origin	Point around which the arc is centered
float3	direction	Direction the arrow is pointing
float	offset	Distance from origin that the arrow starts.
float	width=60	Width of the arrowhead in degrees (defaults to 60). Should be between 0 and 90.

)

Draws an arrowhead centered around a circle.

This can be used to for example show the direction a character is moving in.

void ArrowheadArc (

float3	origin	Point around which the arc is centered
float3	direction	Direction the arrow is pointing
float	offset	Distance from origin that the arrow starts.
float	width	Width of the arrowhead in degrees (defaults to 60). Should be between 0 and 90.
Color	color

)

Draws an arrowhead centered around a circle.

This can be used to for example show the direction a character is moving in.

void ArrowRelativeSizeHead (

float3	from	Base of the arrow.
float3	to	Head of the arrow.
float3	up	Up direction of the world, the arrowhead plane will be as perpendicular as possible to this direction. Defaults to Vector3.up.
float	headFraction	The length of the arrowhead is the distance between from and to multiplied by this fraction. Should be between 0 and 1.

)

Draws an arrow between two points with a head that varies with the length of the arrow.

void ArrowRelativeSizeHead (

float3	from	Base of the arrow.
float3	to	Head of the arrow.
float3	up	Up direction of the world, the arrowhead plane will be as perpendicular as possible to this direction. Defaults to Vector3.up.
float	headFraction	The length of the arrowhead is the distance between from and to multiplied by this fraction. Should be between 0 and 1.
Color	color

)

Draws an arrow between two points with a head that varies with the length of the arrow.

void Bezier (

float3	p0	Start point
float3	p1	First control point
float3	p2	Second control point
float3	p3	End point

)

Draws a cubic bezier curve.

void Bezier (

float3	p0	Start point
float3	p1	First control point
float3	p2	Second control point
float3	p3	End point
Color	color

)

Draws a cubic bezier curve.

void CatmullRom (

List<Vector3>

points

The curve will smoothly pass through each point in the list in order.

)

Draws a smooth curve through a list of points.

A catmull-rom spline is equivalent to a bezier curve with control points determined by an algorithm. In fact, this package displays catmull-rom splines by first converting them to bezier curves.

void CatmullRom (

List<Vector3>	points	The curve will smoothly pass through each point in the list in order.
Color	color

)

Draws a smooth curve through a list of points.

A catmull-rom spline is equivalent to a bezier curve with control points determined by an algorithm. In fact, this package displays catmull-rom splines by first converting them to bezier curves.

void CatmullRom (

float3	p0	First control point
float3	p1	Second control point. Start of the curve.
float3	p2	Third control point. End of the curve.
float3	p3	Fourth control point.

)

Draws a centripetal catmull rom spline.

The curve starts at p1 and ends at p2.

void CatmullRom (

float3	p0	First control point
float3	p1	Second control point. Start of the curve.
float3	p2	Third control point. End of the curve.
float3	p3	Fourth control point.
Color	color

)

Draws a centripetal catmull rom spline.

The curve starts at p1 and ends at p2.

void Circle (

float3	center
float3	normal
float	radius

)

Draws a circle.

void Circle (

float3	center
float3	normal
float	radius
Color	color

)

Draws a circle.

void CircleXY (

float3	center	Center of the circle or arc.
float	radius	Radius of the circle or arc.
Color	color

)

Draws a circle in the XY plane.

You can draw an arc by supplying the startAngle and endAngle parameters.

void CircleXY (

float3	center	Center of the circle or arc.
float	radius	Radius of the circle or arc.
float	startAngle=0f	Starting angle in radians. 0 corrsponds to the positive X axis.
float	endAngle=2 *Mathf.PI	End angle in radians.

)

Draws a circle in the XY plane.

You can draw an arc by supplying the startAngle and endAngle parameters.

void CircleXY (

float3	center	Center of the circle or arc.
float	radius	Radius of the circle or arc.
float	startAngle	Starting angle in radians. 0 corrsponds to the positive X axis.
float	endAngle	End angle in radians.
Color	color

)

Draws a circle in the XY plane.

You can draw an arc by supplying the startAngle and endAngle parameters.

void CircleXZ (

float3	center	Center of the circle or arc.
float	radius	Radius of the circle or arc.
Color	color

)

Draws a circle in the XZ plane.

You can draw an arc by supplying the startAngle and endAngle parameters.

void CircleXZ (

float3	center	Center of the circle or arc.
float	radius	Radius of the circle or arc.
float	startAngle=0f	Starting angle in radians. 0 corrsponds to the positive X axis.
float	endAngle=2 *Mathf.PI	End angle in radians.

)

Draws a circle in the XZ plane.

You can draw an arc by supplying the startAngle and endAngle parameters.

void CircleXZ (

float3	center	Center of the circle or arc.
float	radius	Radius of the circle or arc.
float	startAngle	Starting angle in radians. 0 corrsponds to the positive X axis.
float	endAngle	End angle in radians.
Color	color

)

Draws a circle in the XZ plane.

You can draw an arc by supplying the startAngle and endAngle parameters.

void Cross (

float3	position
float	size=1

)

Draws a cross.

void Cross (

float3	position
Color	color

)

Draws a cross.

void Cross (

float3	position
float	size
Color	color

)

Draws a cross.

void CrossXY (

float3	position
Color	color

)

Draws a cross in the XY plane.

void CrossXY (

float3	position
float	size=1

)

Draws a cross in the XY plane.

void CrossXY (

float3	position
float	size
Color	color

)

Draws a cross in the XY plane.

void CrossXZ (

float3	position
float	size=1

)

Draws a cross in the XZ plane.

void CrossXZ (

float3	position
Color	color

)

Draws a cross in the XZ plane.

void CrossXZ (

float3	position
float	size
Color	color

)

Draws a cross in the XZ plane.

CommandBuilder.ScopeMatrix InLocalSpace (

Transform

transform

)

Scope to draw multiple things relative to a transform object.

All coordinates for items drawn inside the scope will be multiplied by the transform's localToWorldMatrix.

CommandBuilder.ScopeMatrix InScreenSpace (

Camera

camera

)

Scope to draw multiple things in screen space of a camera.

If you draw 2D coordinates (i.e. (x,y,0)) they will be projected onto a plane (2*near clip plane of the camera) world units in front of the camera.

The lower left corner of the camera is (0,0,0) and the upper right is (camera.pixelWidth, camera.pixelHeight, 0)

void Label2D (

float3	position	Position in 3D space.
string	text	Text to display.
float	sizeInPixels=14	Size of the text in screen pixels. For large sizes an SDF (signed distance field) font is used and for small sizes a normal font texture is used.

)

Draws a label in 3D space aligned with the camera.

The default alignment is LabelAlignment.MiddleLeft.

void Label2D (

float3	position	Position in 3D space.
string	text	Text to display.
Color	color

)

Draws a label in 3D space aligned with the camera.

The default alignment is LabelAlignment.MiddleLeft.

void Label2D (

float3	position	Position in 3D space.
string	text	Text to display.
float	sizeInPixels	Size of the text in screen pixels. For large sizes an SDF (signed distance field) font is used and for small sizes a normal font texture is used.
Color	color

)

Draws a label in 3D space aligned with the camera.

The default alignment is LabelAlignment.MiddleLeft.

void Label2D (

float3	position	Position in 3D space.
string	text	Text to display.
float	sizeInPixels	Size of the text in screen pixels. For large sizes an SDF (signed distance field) font is used and for small sizes a normal font texture is used.
LabelAlignment	alignment	How to align the text relative to the given position.

)

Draws a label in 3D space aligned with the camera.

void Label2D (

float3	position	Position in 3D space.
string	text	Text to display.
float	sizeInPixels	Size of the text in screen pixels. For large sizes an SDF (signed distance field) font is used and for small sizes a normal font texture is used.
LabelAlignment	alignment	How to align the text relative to the given position.
Color	color

)

Draws a label in 3D space aligned with the camera.

void Line (

float3	a
float3	b

)

Draws a line between two points.

void Line (

Vector3	a
Vector3	b

)

Draws a line between two points.

void Line (

float3	a
float3	b
Color	color

)

Draws a line between two points.

void Line (

Vector3	a
Vector3	b
Color	color

)

Draws a line between two points.

void Polyline (

Vector3 []	points
Color	color

)

void Polyline (

Vector3 []	points
bool	cycle=false

)

void Polyline (

List<Vector3>	points	Seq u ence of points to draw lines through
bool	cycle=false	If true a line will be drawn from the last point in the sequence back to the first point.

)

Draws lines through a sequence of points.

void Polyline (

float3 []	points
Color	color

)

void Polyline (

float3 []	points
bool	cycle=false

)

void Polyline (

NativeArray<float3>	points	Sequence of points to draw lines through
bool	cycle=false	If true a line will be drawn from the last point in the sequence back to the first point.

)

Draws lines through a sequence of points.

void Polyline (

NativeArray<float3>	points	Sequence of points to draw lines through
Color	color

)

Draws lines through a sequence of points.

void Polyline (

List<Vector3>	points	Seq u ence of points to draw lines through
Color	color

)

Draws lines through a sequence of points.

void Polyline (

List<Vector3>	points	Seq u ence of points to draw lines through
bool	cycle	If true a line will be drawn from the last point in the sequence back to the first point.
Color	color

)

Draws lines through a sequence of points.

void Polyline (

Vector3 []	points
bool	cycle
Color	color

)

void Polyline (

NativeArray<float3>	points	Sequence of points to draw lines through
bool	cycle	If true a line will be drawn from the last point in the sequence back to the first point.
Color	color

)

Draws lines through a sequence of points.

void Polyline (

float3 []	points
bool	cycle
Color	color

)

void PopColor ()

Pops a color from the stack.

void PopMatrix ()

Pops a matrix from the stack.

void PopPersist ()

Pops a persist scope from the stack.

void PushColor (

Color

color

)

Draws everything until the next PopColor with the given color.

Any command that is passed an explicit color parameter will override this color. If another color scope is nested inside this one then that scope will override this color.

void PushMatrix (

Matrix4x4

matrix

)

Multiply all coordinates until the next PopMatrix with the given matrix.

This differs from PushSetMatrix in that this stacks with all previously pushed matrices while PushSetMatrix does not.

void PushPersist (

float

duration

)

Draws everything until the next PopPersist for a number of seconds.

void PushSetMatrix (

Matrix4x4

matrix

)

Multiply all coordinates until the next PopMatrix with the given matrix.

This differs from PushMatrix in that this sets the current matrix directly while PushMatrix stacks with all previously pushed matrices.

void Ray (

float3	origin
float3	direction

)

Draws a ray starting at a point and going in the given direction.

The ray will end at origin + direction.

void Ray (

Ray	ray
float	length

)

Draws a ray with a given length.

void Ray (

Ray	ray
float	length
Color	color

)

Draws a ray with a given length.

void Ray (

float3	origin
float3	direction
Color	color

)

Draws a ray starting at a point and going in the given direction.

The ray will end at origin + direction.

void SolidBox (

Bounds

bounds

Bounding box of the box

)

Draws a solid box.

void SolidBox (

Bounds	bounds	Bounding box of the box
Color	color

)

Draws a solid box.

void SolidBox (

float3	center	Center of the box
float3	size	Width of the box along all dimensions

)

Draws a solid box.

void SolidBox (

float3	center	Center of the box
float3	size	Width of the box along all dimensions
Color	color

)

Draws a solid box.

void SolidBox (

float3	center	Center of the box
Quaternion	rotation	Rotation of the box
float3	size	Width of the box along all dimensions

)

Draws a solid box.

void SolidBox (

float3	center	Center of the box
Quaternion	rotation	Rotation of the box
float3	size	Width of the box along all dimensions
Color	color

)

Draws a solid box.

void SolidMesh (

List<Vector3>	vertices
List<int>	triangles
List<Color>	colors

)

Draws a solid mesh with the given vertices.

void SolidMesh (

Vector3 []	vertices
int []	triangles
Color []	colors
int	vertexCount
int	indexCount

)

void WireBox (

Bounds

bounds

)

Draws the outline of a box.

void WireBox (

Bounds	bounds
Color	color

)

Draws the outline of a box.

void WireBox (

float3	center	Center of the box
float3	size	Width of the box along all dimensions

)

Draws the outline of an axis aligned box.

void WireBox (

float3	center	Center of the box
float3	size	Width of the box along all dimensions
Color	color

)

Draws the outline of an axis aligned box.

void WireBox (

float3	center	Center of the box
Quaternion	rotation	Rotation of the box
float3	size	Width of the box along all dimensions

)

Draws the outline of a box.

void WireBox (

float3	center	Center of the box
Quaternion	rotation	Rotation of the box
float3	size	Width of the box along all dimensions
Color	color

)

Draws the outline of a box.

void WireCapsule (

float3	bottom
float3	top
float	radius

)

Draws a capsule.

The capsule's lower circle will be centered at the bottom parameter and similarly for the upper circle.

void WireCapsule (

float3	position	Lowest point of the capsule.
float3	up	Up direction of the capsule.
float	height	Distance between the lowest and highest points of the capsule. The height will be clamped to be at least 2*radius.
float	radius	The radius of the capsule.

)

Draws a capsule.

void WireCapsule (

float3	bottom
float3	top
float	radius
Color	color

)

Draws a capsule.

The capsule's lower circle will be centered at the bottom parameter and similarly for the upper circle.

void WireCapsule (

float3	position	Lowest point of the capsule.
float3	up	Up direction of the capsule.
float	height	Distance between the lowest and highest points of the capsule. The height will be clamped to be at least 2*radius.
float	radius	The radius of the capsule.
Color	color

)

Draws a capsule.

void WireCylinder (

float3	bottom
float3	top
float	radius

)

Draws a cylinder.

The cylinder's bottom circle will be centered at the bottom parameter and similarly for the top circle.

void WireCylinder (

float3	bottom
float3	top
float	radius
Color	color

)

Draws a cylinder.

The cylinder's bottom circle will be centered at the bottom parameter and similarly for the top circle.

void WireCylinder (

float3	position
float3	up
float	height
float	radius

)

Draws a cylinder.

The cylinder's bottom circle will be centered at the position parameter. The cylinder's orientation will be determined by the up and height parameters.

void WireCylinder (

float3	position
float3	up
float	height
float	radius
Color	color

)

Draws a cylinder.

The cylinder's bottom circle will be centered at the position parameter. The cylinder's orientation will be determined by the up and height parameters.

void WireGrid (

float3	center	Center of the grid
Quaternion	rotation	Rotation of the grid. The grid will be aligned to the X and Z axes of the rotation.
int2	cells	Number of cells of the grid. Should be greater than 0.
float2	totalSize	Total size of the grid along the X and Z axes.

)

Draws a grid of lines.

void WireGrid (

float3	center	Center of the grid
Quaternion	rotation	Rotation of the grid. The grid will be aligned to the X and Z axes of the rotation.
int2	cells	Number of cells of the grid. Should be greater than 0.
float2	totalSize	Total size of the grid along the X and Z axes.
Color	color

)

Draws a grid of lines.

void WireHexagon (

float3	center	Center of the polygon.
Quaternion	rotation	Rotation of the polygon. The first vertex will be radius units in front of center as seen from the rotation's point of view.
float	radius	Distance from the center to each vertex.

)

Draws a hexagon outline.

void WireHexagon (

float3	center	Center of the polygon.
Quaternion	rotation	Rotation of the polygon. The first vertex will be radius units in front of center as seen from the rotation's point of view.
float	radius	Distance from the center to each vertex.
Color	color

)

Draws a hexagon outline.

void WirePentagon (

float3	center	Center of the polygon.
Quaternion	rotation	Rotation of the polygon. The first vertex will be radius units in front of center as seen from the rotation's point of view.
float	radius	Distance from the center to each vertex.

)

Draws a pentagon outline.

void WirePentagon (

float3	center	Center of the polygon.
Quaternion	rotation	Rotation of the polygon. The first vertex will be radius units in front of center as seen from the rotation's point of view.
float	radius	Distance from the center to each vertex.
Color	color

)

Draws a pentagon outline.

void WirePolygon (

float3	center	Center of the polygon.
int	vertices	Number of corners (and sides) of the polygon.
Quaternion	rotation	Rotation of the polygon. The first vertex will be radius units in front of center as seen from the rotation's point of view.
float	radius	Distance from the center to each vertex.

)

Draws a regular polygon outline.

void WirePolygon (

float3	center	Center of the polygon.
int	vertices	Number of corners (and sides) of the polygon.
Quaternion	rotation	Rotation of the polygon. The first vertex will be radius units in front of center as seen from the rotation's point of view.
float	radius	Distance from the center to each vertex.
Color	color

)

Draws a regular polygon outline.

void WireRectangle (

Rect

rect

)

Draws a rectangle outline.

The rectangle corners are assumed to be in XY space. This is particularly useful when combined with InScreenSpace.

void WireRectangle (

Rect	rect
Color	color

)

Draws a rectangle outline.

The rectangle corners are assumed to be in XY space. This is particularly useful when combined with InScreenSpace.

void WireRectangle (

float3	center
Quaternion	rotation
float3	size

)

Draws a rectangle outline.

The rectangle will be oriented along the rotation's X and Z axes.

void WireRectangle (

float3	center
Quaternion	rotation
float3	size
Color	color

)

Draws a rectangle outline.

The rectangle will be oriented along the rotation's X and Z axes.

void WireRectangleXZ (

float3	center
float3	size

)

Draws a rectangle outline.

The rectangle will be aligned to the X and Z axes.

void WireRectangleXZ (

float3	center
float3	size
Color	color

)

Draws a rectangle outline.

The rectangle will be aligned to the X and Z axes.

void WireSphere (

float3	position
float	radius

)

Draws a wire sphere.

void WireSphere (

float3	position
float	radius
Color	color

)

Draws a wire sphere.

void WireTriangle (

float3	center	Center of the triangle.
Quaternion	rotation	Rotation of the triangle. The first vertex will be radius units in front of center as seen from the rotation's point of view.
float	radius	Distance from the center to each vertex.

)

Draws a triangle outline.

void WireTriangle (

float3	a	First corner of the triangle
float3	b	Second corner of the triangle
float3	c	Third corner of the triangle

)

Draws a triangle outline.

void WireTriangle (

float3	center	Center of the triangle.
Quaternion	rotation	Rotation of the triangle. The first vertex will be radius units in front of center as seen from the rotation's point of view.
float	radius	Distance from the center to each vertex.
Color	color

)

Draws a triangle outline.

void WireTriangle (

float3	a	First corner of the triangle
float3	b	Second corner of the triangle
float3	c	Third corner of the triangle
Color	color

)

Draws a triangle outline.

CommandBuilder.ScopeColor WithColor (

Color

color

)

Scope to draw multiple things with the same color.

Any command that is passed an explicit color parameter will override this color. If another color scope is nested inside this one then that scope will override this color.

CommandBuilder.ScopePersist WithDuration (

float

duration

How long the drawn items should persist in seconds.

)

Scope to draw multiple things for a longer period of time.

Normally drawn items will only be rendered for a single frame. Using a persist scope you can make the items be drawn for any amount of time.

CommandBuilder.ScopeMatrix WithMatrix (

Matrix4x4

matrix

)

Scope to draw multiple things with an implicit matrix transformation.

All coordinates for items drawn inside the scope will be multiplied by the matrix. If WithMatrix scopes are nested then coordinates are multiplied by all nested matrices in order.

refCommandBuilder editor

Draws items in the editor if gizmos are enabled.

All drawing methods on the static Draw class are forwarded to this command builder.

refCommandBuilder ingame

Draws items in the editor and in standalone games, even if gizmos are disabled.

CommandBuilder builder

CommandBuilder ingame_builder