Draw XXL documentation


Draw Measurements.DistanceThresholds(...);

This displays a line with different color or style depending on if the length of the line is below or above fixed thresholds. It is similar to DistanceThreshold(), but it has two instead of one fixed threshold distances, so you can not only get visually notified if two Gameobjects are "near" or "far", but also if they have a "middle distance".

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


static void DrawMeasurements.DistanceThresholds(...);

Code snippet names: drawDistanceThresholds and drawDistanceThresholds_func.

Parameters:
Type Parameter Name Description
Vector3 startPos The start position of the line that gets styled depending on the line lenght.
Vector3 endPos The end position of the line that gets styled depending on the line lenght.
float smallerThresholdDistance The line style changes depending on if the line is shorter or longer than this threshold.
float biggerThresholdDistance The line style changes depending on if the line is shorter or longer than this threshold.
string text
bool displayDistanceAlsoAsText
float lineWidth
bool exactlyThresholdLength_countsAsShorter
float endPlates_size The line can optinally have end position markers which are called "end plates" here. The styling of the end plates depends on the aforementioned "flattenThickRoundLineIntoAmplitudePlane" parameter. The size that is specified here is interpreted as relative to the line lenght or in absolute units according to the global end plates size interpretation setting. The global settings DrawBasics.disableEndPlates_atLineStart and DrawBasics.disableEndPlates_atLineEnd can be used to draw the plate only at one specific line end and leave the other end without plate.
LineStyle overwriteStyle_forNear
LineStyle overwriteStyle_forMiddle
LineStyle overwriteStyle_forFar
Color overwriteColor_forNear
Color overwriteColor_forMiddle
Color overwriteColor_forFar
Vector3 customAmplitudeAndTextDir The default behaviour is that a global setting takes care of this, but for custom cases it can be explicitly set by this parameter.
float enlargeSmallTextToThisMinTextSize This only has effect if the "text" parameter is used. The normal behaviour of text is that it scales with the line lenght. Though depending on the situation the line may get very small, up until the text is not readable anymore. This parameter sets a limit for the minimum text size. The text carrying line may get shorter and shorter but the text can stay visible.
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.