Draw XXL documentation


Draw Basics 2D.LineStringColorFade(...);

Draw a string of straight lines defined by a set of Vector2 positions as mounting points. The line colors change from the start of the string to end of the string.

Green parameters are required. Yellow parameters are optional, but have to be supplied in order.


static void DrawBasics2D.LineStringColorFade(...);

Code snippet names: drawLineStringColFade2D_array and drawLineStringColFade2D_array_func.

Parameters:
Type Parameter Name Description
Vector2[] points An array of Vector2 positions that define the mounting points of the line string.
Color startColor The color of the first line.
Color endColor The color of the last line.
bool closeGapBetweenLastAndFirstPoint Add a final line at the end, that connects the line string end back to the line string start, effectively forming a ring of lines.
float width The line width for each line in world space units.
string text A text tag to display alongside the line string. The display orientation of the text follows DrawText.automaticTextOrientation. The text size scales relative to the extent of the drawn line string. If you want a constant text size, you can use DrawShapes.forcedConstantScreenspaceTextSize_relToScreenHeight_forTextAtShapes or DrawShapes.forcedConstantWorldspaceTextSize_forTextAtShapes.
LineStyle style A style for the lines. The default is "solid", but it can also be "dashed" or "zigzag".
float custom_zPos The z position of the XY-plane inside which the lines are drawn. The default value is "infinity", which falls back to DrawBasic2D.Default_zPos_forDrawing.
float stylePatternScaleFactor Scales the pattern of custom line styles.
bool textBlockAboveLine This has only effect if the text parameter is used. The text block can be above or below the lines.
float durationInSec The duration in seconds how long the drawn thing stays visible. The default value of 0 means that it stays only during the current Update frame. Instead of using this parameter you can also overwrite him with a global setting so you don't always have to supply all other preceding function parameters till you reach this late parameter.
bool hiddenByNearerObjects This specifies if the drawn thing will get hidden if other geometry is in front of it or if it shines through. It is the same as the depthTest parameter of Unitys Debug.DrawLine(). Not all drawing methods support toggling this in the same way. For some methods the lines are fully hidden, for others the hidden lines shimmer through. Instead of using this parameter you can also overwrite him with a global setting so you don't always have to supply all other preceding function parameters till you reach this late parameter.


static void DrawBasics2D.LineStringColorFade(...);

Code snippet names: drawLineStringColFade2D_list and drawLineStringColFade2D_list_func.

Parameters:
Type Parameter Name Description
List points This overload takes a list of Vector2 points instead of an array. All other things are the same.
Color startColor The color of the first line.
Color endColor The color of the last line.
bool closeGapBetweenLastAndFirstPoint Same as in first overload. See there.
float width Same as in first overload. See there.
string text Same as in first overload. See there.
LineStyle style Same as in first overload. See there.
float custom_zPos Same as in first overload. See there.
float stylePatternScaleFactor Same as in first overload. See there.
bool textBlockAboveLine Same as in first overload. See there.
float durationInSec Same as in first overload. See there.
bool hiddenByNearerObjects Same as in first overload. See there.